GCC Code Coverage Report
Directory: ../ Exec Total Coverage
File: /home/iojs/build/workspace/node-test-commit-linux-coverage-daily/nodes/benchmark/out/../src/base_object-inl.h Lines: 156 174 89.7 %
Date: 2021-02-19 04:08:54 Branches: 79 174 45.4 %

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
48090
BaseObject::BaseObject(Environment* env, v8::Local<v8::Object> object)
36
96180
    : persistent_handle_(env->isolate(), object), env_(env) {
37
48090
  CHECK_EQ(false, object.IsEmpty());
38
48090
  CHECK_GT(object->InternalFieldCount(), 0);
39
48090
  object->SetAlignedPointerInInternalField(
40
      BaseObject::kSlot,
41
48090
      static_cast<void*>(this));
42
48090
  env->AddCleanupHook(DeleteMe, static_cast<void*>(this));
43
48090
  env->modify_base_object_count(1);
44
48090
}
45
46

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

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

163
    } else if (metadata->wants_weak_jsobj && !persistent_handle_.IsEmpty()) {
205
81
      MakeWeak();
206
    }
207
  }
208
39839
}
209
210
39875
void BaseObject::increase_refcount() {
211
39875
  unsigned int prev_refcount = pointer_data()->strong_ptr_count++;
212

58551
  if (prev_refcount == 0 && !persistent_handle_.IsEmpty())
213
18676
    persistent_handle_.ClearWeak();
214
39875
}
215
216
template <typename T, bool kIsWeak>
217
BaseObject::PointerData*
218
39919
BaseObjectPtrImpl<T, kIsWeak>::pointer_data() const {
219
  if (kIsWeak) {
220
44
    return data_.pointer_data;
221
  }
222



39875
  if (get_base_object() == nullptr) {
223
    return nullptr;
224
  }
225
39875
  return get_base_object()->pointer_data();
226
}
227
228
template <typename T, bool kIsWeak>
229
529193
BaseObject* BaseObjectPtrImpl<T, kIsWeak>::get_base_object() const {
230
  if (kIsWeak) {
231
13
    if (pointer_data() == nullptr) {
232
3
      return nullptr;
233
    }
234
10
    return pointer_data()->self;
235
  }
236
529180
  return data_.target;
237
}
238
239
template <typename T, bool kIsWeak>
240
74758
BaseObjectPtrImpl<T, kIsWeak>::~BaseObjectPtrImpl() {
241
  if (kIsWeak) {
242

18
    if (pointer_data() != nullptr &&
243

12
        --pointer_data()->weak_ptr_count == 0 &&
244
3
        pointer_data()->self == nullptr) {
245
3
      delete pointer_data();
246
    }
247



74752
  } else if (get() != nullptr) {
248
39839
    get()->decrease_refcount();
249
  }
250
74758
}
251
252
template <typename T, bool kIsWeak>
253
57614
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl() {
254
57614
  data_.target = nullptr;
255
57614
}
256
257
template <typename T, bool kIsWeak>
258
56824
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(T* target)
259
56824
  : BaseObjectPtrImpl() {
260




56824
  if (target == nullptr) return;
261
  if (kIsWeak) {
262
3
    data_.pointer_data = target->pointer_data();
263
3
    CHECK_NOT_NULL(pointer_data());
264
3
    pointer_data()->weak_ptr_count++;
265
  } else {
266
39875
    data_.target = target;
267



39875
    CHECK_NOT_NULL(pointer_data());
268
39875
    get()->increase_refcount();
269
  }
270
}
271
272
template <typename T, bool kIsWeak>
273
template <typename U, bool kW>
274
127
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(
275
    const BaseObjectPtrImpl<U, kW>& other)
276
127
  : BaseObjectPtrImpl(other.get()) {}
277
278
template <typename T, bool kIsWeak>
279
3939
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(const BaseObjectPtrImpl& other)
280
3939
  : BaseObjectPtrImpl(other.get()) {}
281
282
template <typename T, bool kIsWeak>
283
template <typename U, bool kW>
284
4
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
285
    const BaseObjectPtrImpl<U, kW>& other) {
286

4
  if (other.get() == get()) return *this;
287
4
  this->~BaseObjectPtrImpl();
288

4
  return *new (this) BaseObjectPtrImpl(other);
289
}
290
291
template <typename T, bool kIsWeak>
292
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
293
    const BaseObjectPtrImpl& other) {
294
  if (other.get() == get()) return *this;
295
  this->~BaseObjectPtrImpl();
296
  return *new (this) BaseObjectPtrImpl(other);
297
}
298
299
template <typename T, bool kIsWeak>
300
17219
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(BaseObjectPtrImpl&& other)
301
17219
  : data_(other.data_) {
302
  if (kIsWeak)
303
1
    other.data_.target = nullptr;
304
  else
305
17218
    other.data_.pointer_data = nullptr;
306
17219
}
307
308
template <typename T, bool kIsWeak>
309
17010
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
310
    BaseObjectPtrImpl&& other) {
311



17010
  if (&other == this) return *this;
312
17010
  this->~BaseObjectPtrImpl();
313



17010
  return *new (this) BaseObjectPtrImpl(std::move(other));
314
}
315
316
template <typename T, bool kIsWeak>
317
17010
void BaseObjectPtrImpl<T, kIsWeak>::reset(T* ptr) {
318
17010
  *this = BaseObjectPtrImpl(ptr);
319
17010
}
320
321
template <typename T, bool kIsWeak>
322
449443
T* BaseObjectPtrImpl<T, kIsWeak>::get() const {
323
449443
  return static_cast<T*>(get_base_object());
324
}
325
326
template <typename T, bool kIsWeak>
327
T& BaseObjectPtrImpl<T, kIsWeak>::operator*() const {
328
  return *get();
329
}
330
331
template <typename T, bool kIsWeak>
332
79252
T* BaseObjectPtrImpl<T, kIsWeak>::operator->() const {
333
79252
  return get();
334
}
335
336
template <typename T, bool kIsWeak>
337
21264
BaseObjectPtrImpl<T, kIsWeak>::operator bool() const {
338
21264
  return get() != nullptr;
339
}
340
341
template <typename T, bool kIsWeak>
342
template <typename U, bool kW>
343
bool BaseObjectPtrImpl<T, kIsWeak>::operator ==(
344
    const BaseObjectPtrImpl<U, kW>& other) const {
345
  return get() == other.get();
346
}
347
348
template <typename T, bool kIsWeak>
349
template <typename U, bool kW>
350
bool BaseObjectPtrImpl<T, kIsWeak>::operator !=(
351
    const BaseObjectPtrImpl<U, kW>& other) const {
352
  return get() != other.get();
353
}
354
355
template <typename T, typename... Args>
356
130
BaseObjectPtr<T> MakeBaseObject(Args&&... args) {
357
130
  return BaseObjectPtr<T>(new T(std::forward<Args>(args)...));
358
}
359
360
template <typename T, typename... Args>
361
127
BaseObjectPtr<T> MakeDetachedBaseObject(Args&&... args) {
362
127
  BaseObjectPtr<T> target = MakeBaseObject<T>(std::forward<Args>(args)...);
363
127
  target->Detach();
364
127
  return target;
365
}
366
367
}  // namespace node
368
369
#endif  // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
370
371
#endif  // SRC_BASE_OBJECT_INL_H_