GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: base_object-inl.h Lines: 165 172 95.9 %
Date: 2021-08-24 04:12:49 Branches: 65 92 70.7 %

Line Branch Exec Source
1
// Copyright Joyent, Inc. and other Node contributors.
2
//
3
// Permission is hereby granted, free of charge, to any person obtaining a
4
// copy of this software and associated documentation files (the
5
// "Software"), to deal in the Software without restriction, including
6
// without limitation the rights to use, copy, modify, merge, publish,
7
// distribute, sublicense, and/or sell copies of the Software, and to permit
8
// persons to whom the Software is furnished to do so, subject to the
9
// following conditions:
10
//
11
// The above copyright notice and this permission notice shall be included
12
// in all copies or substantial portions of the Software.
13
//
14
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
17
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
19
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20
// USE OR OTHER DEALINGS IN THE SOFTWARE.
21
22
#ifndef SRC_BASE_OBJECT_INL_H_
23
#define SRC_BASE_OBJECT_INL_H_
24
25
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
26
27
#include "base_object.h"
28
#include "env-inl.h"
29
#include "util.h"
30
31
#include "v8.h"
32
33
namespace node {
34
35
331111
BaseObject::BaseObject(Environment* env, v8::Local<v8::Object> object)
36
662222
    : persistent_handle_(env->isolate(), object), env_(env) {
37
331111
  CHECK_EQ(false, object.IsEmpty());
38
331111
  CHECK_GT(object->InternalFieldCount(), 0);
39
331111
  object->SetAlignedPointerInInternalField(
40
      BaseObject::kSlot,
41
      static_cast<void*>(this));
42
331111
  env->AddCleanupHook(DeleteMe, static_cast<void*>(this));
43
331111
  env->modify_base_object_count(1);
44
331111
}
45
46

1370552
BaseObject::~BaseObject() {
47
647214
  env()->modify_base_object_count(-1);
48
647214
  env()->RemoveCleanupHook(DeleteMe, static_cast<void*>(this));
49
50
647214
  if (UNLIKELY(has_pointer_data())) {
51
338196
    PointerData* metadata = pointer_data();
52
338196
    CHECK_EQ(metadata->strong_ptr_count, 0);
53
338196
    metadata->self = nullptr;
54
338196
    if (metadata->weak_ptr_count == 0)
55
338160
      delete metadata;
56
  }
57
58
647214
  if (persistent_handle_.IsEmpty()) {
59
    // This most likely happened because the weak callback below cleared it.
60
76124
    return;
61
  }
62
63
  {
64
571090
    v8::HandleScope handle_scope(env()->isolate());
65
1142180
    object()->SetAlignedPointerInInternalField(BaseObject::kSlot, nullptr);
66
  }
67
}
68
69
165210
void BaseObject::Detach() {
70
165210
  CHECK_GT(pointer_data()->strong_ptr_count, 0);
71
165210
  pointer_data()->is_detached = true;
72
165210
}
73
74
449011
v8::Global<v8::Object>& BaseObject::persistent() {
75
449011
  return persistent_handle_;
76
}
77
78
79
2267844
v8::Local<v8::Object> BaseObject::object() const {
80
2267844
  return PersistentToLocal::Default(env()->isolate(), persistent_handle_);
81
}
82
83
105698
v8::Local<v8::Object> BaseObject::object(v8::Isolate* isolate) const {
84
105698
  v8::Local<v8::Object> handle = object();
85
86
  DCHECK_EQ(handle->GetCreationContext().ToLocalChecked()->GetIsolate(),
87
            isolate);
88
  DCHECK_EQ(env()->isolate(), isolate);
89
90
105698
  return handle;
91
}
92
93
10573249
Environment* BaseObject::env() const {
94
10573249
  return env_;
95
}
96
97
5134472
BaseObject* BaseObject::FromJSObject(v8::Local<v8::Value> value) {
98
5134472
  v8::Local<v8::Object> obj = value.As<v8::Object>();
99
  DCHECK_GE(obj->InternalFieldCount(), BaseObject::kSlot);
100
  return static_cast<BaseObject*>(
101
10268944
      obj->GetAlignedPointerFromInternalField(BaseObject::kSlot));
102
}
103
104
105
template <typename T>
106
724036
T* BaseObject::FromJSObject(v8::Local<v8::Value> object) {
107
724036
  return static_cast<T*>(FromJSObject(object));
108
}
109
110
111
147962
void BaseObject::MakeWeak() {
112
147962
  if (has_pointer_data()) {
113
41435
    pointer_data()->wants_weak_jsobj = true;
114
41435
    if (pointer_data()->strong_ptr_count > 0) return;
115
  }
116
117
295922
  persistent_handle_.SetWeak(
118
      this,
119
38061
      [](const v8::WeakCallbackInfo<BaseObject>& data) {
120
38061
        BaseObject* obj = data.GetParameter();
121
        // Clear the persistent handle so that ~BaseObject() doesn't attempt
122
        // to mess with internal fields, since the JS object may have
123
        // transitioned into an invalid state.
124
        // Refs: https://github.com/nodejs/node/issues/18897
125
38061
        obj->persistent_handle_.Reset();
126

38061
        CHECK_IMPLIES(obj->has_pointer_data(),
127
                      obj->pointer_data()->strong_ptr_count == 0);
128
38061
        obj->OnGCCollect();
129
38061
      }, v8::WeakCallbackType::kParameter);
130
}
131
132
201640
void BaseObject::OnGCCollect() {
133
201640
  delete this;
134
201640
}
135
136
2650
void BaseObject::ClearWeak() {
137
2650
  if (has_pointer_data())
138
    pointer_data()->wants_weak_jsobj = false;
139
140
2650
  persistent_handle_.ClearWeak();
141
2650
}
142
143
bool BaseObject::IsWeakOrDetached() const {
144
  if (persistent_handle_.IsWeak()) return true;
145
146
  if (!has_pointer_data()) return false;
147
  const PointerData* pd = const_cast<BaseObject*>(this)->pointer_data();
148
  return pd->wants_weak_jsobj || pd->is_detached;
149
}
150
151
v8::Local<v8::FunctionTemplate>
152
17740
BaseObject::MakeLazilyInitializedJSTemplate(Environment* env) {
153
23871
  auto constructor = [](const v8::FunctionCallbackInfo<v8::Value>& args) {
154
    DCHECK(args.IsConstructCall());
155
    DCHECK_GT(args.This()->InternalFieldCount(), 0);
156
23871
    args.This()->SetAlignedPointerInInternalField(BaseObject::kSlot, nullptr);
157
23871
  };
158
159
17740
  v8::Local<v8::FunctionTemplate> t = env->NewFunctionTemplate(constructor);
160
17740
  t->Inherit(BaseObject::GetConstructorTemplate(env));
161
35480
  t->InstanceTemplate()->SetInternalFieldCount(
162
      BaseObject::kInternalFieldCount);
163
17740
  return t;
164
}
165
166
template <int Field>
167
6
void BaseObject::InternalFieldGet(
168
    v8::Local<v8::String> property,
169
    const v8::PropertyCallbackInfo<v8::Value>& info) {
170
6
  info.GetReturnValue().Set(info.This()->GetInternalField(Field));
171
6
}
172
173
template <int Field, bool (v8::Value::* typecheck)() const>
174
98885
void BaseObject::InternalFieldSet(v8::Local<v8::String> property,
175
                                  v8::Local<v8::Value> value,
176
                                  const v8::PropertyCallbackInfo<void>& info) {
177
  // This could be e.g. value->IsFunction().
178
98885
  CHECK(((*value)->*typecheck)());
179
98885
  info.This()->SetInternalField(Field, value);
180
98885
}
181
182
6817423
bool BaseObject::has_pointer_data() const {
183
6817423
  return pointer_data_ != nullptr;
184
}
185
186
2745237
BaseObject::PointerData* BaseObject::pointer_data() {
187
2745237
  if (!has_pointer_data()) {
188
170624
    PointerData* metadata = new PointerData();
189
170624
    metadata->wants_weak_jsobj = persistent_handle_.IsWeak();
190
170624
    metadata->self = this;
191
170624
    pointer_data_ = metadata;
192
  }
193
2745237
  CHECK(has_pointer_data());
194
2745237
  return pointer_data_;
195
}
196
197
710119
void BaseObject::decrease_refcount() {
198
710119
  CHECK(has_pointer_data());
199
710119
  PointerData* metadata = pointer_data();
200
710119
  CHECK_GT(metadata->strong_ptr_count, 0);
201
710119
  unsigned int new_refcount = --metadata->strong_ptr_count;
202
710119
  if (new_refcount == 0) {
203
237168
    if (metadata->is_detached) {
204
163581
      OnGCCollect();
205

73587
    } else if (metadata->wants_weak_jsobj && !persistent_handle_.IsEmpty()) {
206
41434
      MakeWeak();
207
    }
208
  }
209
710119
}
210
211
711718
void BaseObject::increase_refcount() {
212
711718
  unsigned int prev_refcount = pointer_data()->strong_ptr_count++;
213

711718
  if (prev_refcount == 0 && !persistent_handle_.IsEmpty())
214
238680
    persistent_handle_.ClearWeak();
215
711718
}
216
217
template <typename T, bool kIsWeak>
218
BaseObject::PointerData*
219
3658277
BaseObjectPtrImpl<T, kIsWeak>::pointer_data() const {
220
  if (kIsWeak) {
221
2288792
    return data_.pointer_data;
222
  }
223
1369485
  if (get_base_object() == nullptr) {
224
    return nullptr;
225
  }
226
1369485
  return get_base_object()->pointer_data();
227
}
228
229
template <typename T, bool kIsWeak>
230
16273676
BaseObject* BaseObjectPtrImpl<T, kIsWeak>::get_base_object() const {
231
  if (kIsWeak) {
232
1034788
    if (pointer_data() == nullptr) {
233
8
      return nullptr;
234
    }
235
1034780
    return pointer_data()->self;
236
  }
237
15238888
  return data_.target;
238
}
239
240
template <typename T, bool kIsWeak>
241
3357937
BaseObjectPtrImpl<T, kIsWeak>::~BaseObjectPtrImpl() {
242
3357937
  if (kIsWeak) {
243
48892
    if (pointer_data() != nullptr &&
244

72542
        --pointer_data()->weak_ptr_count == 0 &&
245
23650
        pointer_data()->self == nullptr) {
246
36
      delete pointer_data();
247
    }
248
3309045
  } else if (get() != nullptr) {
249
1239854
    get()->decrease_refcount();
250
  }
251
3357937
}
252
253
template <typename T, bool kIsWeak>
254
2731100
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl() {
255
2731100
  data_.target = nullptr;
256
2731100
}
257
258
template <typename T, bool kIsWeak>
259
2074829
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(T* target)
260
2074829
  : BaseObjectPtrImpl() {
261
2074829
  if (target == nullptr) return;
262
  if (kIsWeak) {
263
48882
    data_.pointer_data = target->pointer_data();
264
48882
    CHECK_NOT_NULL(pointer_data());
265
48882
    pointer_data()->weak_ptr_count++;
266
  } else {
267
1369485
    data_.target = target;
268
1369485
    CHECK_NOT_NULL(pointer_data());
269
1369485
    get()->increase_refcount();
270
  }
271
}
272
273
template <typename T, bool kIsWeak>
274
template <typename U, bool kW>
275
33426
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(
276
    const BaseObjectPtrImpl<U, kW>& other)
277
33426
  : BaseObjectPtrImpl(other.get()) {}
278
279
template <typename T, bool kIsWeak>
280
854200
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(const BaseObjectPtrImpl& other)
281
854200
  : BaseObjectPtrImpl(other.get()) {}
282
283
template <typename T, bool kIsWeak>
284
template <typename U, bool kW>
285
8
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
286
    const BaseObjectPtrImpl<U, kW>& other) {
287
8
  if (other.get() == get()) return *this;
288
8
  this->~BaseObjectPtrImpl();
289
8
  return *new (this) BaseObjectPtrImpl(other);
290
}
291
292
template <typename T, bool kIsWeak>
293
2
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
294
    const BaseObjectPtrImpl& other) {
295
2
  if (other.get() == get()) return *this;
296
2
  this->~BaseObjectPtrImpl();
297
2
  return *new (this) BaseObjectPtrImpl(other);
298
}
299
300
template <typename T, bool kIsWeak>
301
871396
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(BaseObjectPtrImpl&& other)
302
871396
  : data_(other.data_) {
303
871396
  if (kIsWeak)
304
    other.data_.target = nullptr;
305
  else
306
    other.data_.pointer_data = nullptr;
307
871396
}
308
309
template <typename T, bool kIsWeak>
310
416142
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
311
    BaseObjectPtrImpl&& other) {
312
416142
  if (&other == this) return *this;
313
416142
  this->~BaseObjectPtrImpl();
314
416142
  return *new (this) BaseObjectPtrImpl(std::move(other));
315
}
316
317
template <typename T, bool kIsWeak>
318
256744
void BaseObjectPtrImpl<T, kIsWeak>::reset(T* ptr) {
319
256744
  *this = BaseObjectPtrImpl(ptr);
320
256744
}
321
322
template <typename T, bool kIsWeak>
323
13701850
T* BaseObjectPtrImpl<T, kIsWeak>::get() const {
324
13701850
  return static_cast<T*>(get_base_object());
325
}
326
327
template <typename T, bool kIsWeak>
328
T& BaseObjectPtrImpl<T, kIsWeak>::operator*() const {
329
  return *get();
330
}
331
332
template <typename T, bool kIsWeak>
333
4006286
T* BaseObjectPtrImpl<T, kIsWeak>::operator->() const {
334
4006286
  return get();
335
}
336
337
template <typename T, bool kIsWeak>
338
1270895
BaseObjectPtrImpl<T, kIsWeak>::operator bool() const {
339
1270895
  return get() != nullptr;
340
}
341
342
template <typename T, bool kIsWeak>
343
template <typename U, bool kW>
344
10963
bool BaseObjectPtrImpl<T, kIsWeak>::operator ==(
345
    const BaseObjectPtrImpl<U, kW>& other) const {
346
10963
  return get() == other.get();
347
}
348
349
template <typename T, bool kIsWeak>
350
template <typename U, bool kW>
351
bool BaseObjectPtrImpl<T, kIsWeak>::operator !=(
352
    const BaseObjectPtrImpl<U, kW>& other) const {
353
  return get() != other.get();
354
}
355
356
template <typename T, typename... Args>
357
30084
BaseObjectPtr<T> MakeBaseObject(Args&&... args) {
358
30084
  return BaseObjectPtr<T>(new T(std::forward<Args>(args)...));
359
}
360
361
template <typename T, typename... Args>
362
18087
BaseObjectPtr<T> MakeDetachedBaseObject(Args&&... args) {
363
18087
  BaseObjectPtr<T> target = MakeBaseObject<T>(std::forward<Args>(args)...);
364
18087
  target->Detach();
365
18087
  return target;
366
}
367
368
}  // namespace node
369
370
#endif  // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
371
372
#endif  // SRC_BASE_OBJECT_INL_H_