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: 161 174 92.5 %
Date: 2020-12-12 04:11:07 Branches: 106 170 62.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
316403
BaseObject::BaseObject(Environment* env, v8::Local<v8::Object> object)
36
632806
    : persistent_handle_(env->isolate(), object), env_(env) {
37
316403
  CHECK_EQ(false, object.IsEmpty());
38
316403
  CHECK_GT(object->InternalFieldCount(), 0);
39
316403
  object->SetAlignedPointerInInternalField(
40
      BaseObject::kSlot,
41
316403
      static_cast<void*>(this));
42
316403
  env->AddCleanupHook(DeleteMe, static_cast<void*>(this));
43
316404
  env->modify_base_object_count(1);
44
316404
}
45
46

928748
BaseObject::~BaseObject() {
47
309582
  env()->modify_base_object_count(-1);
48
309584
  env()->RemoveCleanupHook(DeleteMe, static_cast<void*>(this));
49
50
309583
  if (UNLIKELY(has_pointer_data())) {
51
156050
    PointerData* metadata = pointer_data();
52
156048
    CHECK_EQ(metadata->strong_ptr_count, 0);
53
156048
    metadata->self = nullptr;
54
156048
    if (metadata->weak_ptr_count == 0)
55
156035
      delete metadata;
56
  }
57
58
619166
  if (persistent_handle_.IsEmpty()) {
59
    // This most likely happened because the weak callback below cleared it.
60
35506
    return;
61
  }
62
63
  {
64
548152
    v8::HandleScope handle_scope(env()->isolate());
65
548147
    object()->SetAlignedPointerInInternalField(BaseObject::kSlot, nullptr);
66
  }
67
309581
}
68
69
151598
void BaseObject::Detach() {
70
151598
  CHECK_GT(pointer_data()->strong_ptr_count, 0);
71
151598
  pointer_data()->is_detached = true;
72
151598
}
73
74
702229
v8::Global<v8::Object>& BaseObject::persistent() {
75
702229
  return persistent_handle_;
76
}
77
78
79
2856809
v8::Local<v8::Object> BaseObject::object() const {
80
2856809
  return PersistentToLocal::Default(env()->isolate(), persistent_handle_);
81
}
82
83
87754
v8::Local<v8::Object> BaseObject::object(v8::Isolate* isolate) const {
84
87754
  v8::Local<v8::Object> handle = object();
85
86
  DCHECK_EQ(handle->CreationContext()->GetIsolate(), isolate);
87
  DCHECK_EQ(env()->isolate(), isolate);
88
89
87692
  return handle;
90
}
91
92
12323381
Environment* BaseObject::env() const {
93
12323381
  return env_;
94
}
95
96
4324397
BaseObject* BaseObject::FromJSObject(v8::Local<v8::Value> value) {
97
4324397
  v8::Local<v8::Object> obj = value.As<v8::Object>();
98
  DCHECK_GE(obj->InternalFieldCount(), BaseObject::kSlot);
99
  return static_cast<BaseObject*>(
100
8648793
      obj->GetAlignedPointerFromInternalField(BaseObject::kSlot));
101
}
102
103
104
template <typename T>
105
799181
T* BaseObject::FromJSObject(v8::Local<v8::Value> object) {
106
799181
  return static_cast<T*>(FromJSObject(object));
107
}
108
109
110
155274
void BaseObject::MakeWeak() {
111
155274
  if (has_pointer_data()) {
112
40824
    pointer_data()->wants_weak_jsobj = true;
113
40824
    if (pointer_data()->strong_ptr_count > 0) return;
114
  }
115
116
310543
  persistent_handle_.SetWeak(
117
      this,
118
226278
      [](const v8::WeakCallbackInfo<BaseObject>& data) {
119
35503
        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
35503
        obj->persistent_handle_.Reset();
125

35503
        CHECK_IMPLIES(obj->has_pointer_data(),
126
                      obj->pointer_data()->strong_ptr_count == 0);
127
35503
        obj->OnGCCollect();
128
226278
      }, v8::WeakCallbackType::kParameter);
129
}
130
131
35501
void BaseObject::OnGCCollect() {
132
35501
  delete this;
133
35501
}
134
135
2491
void BaseObject::ClearWeak() {
136
2491
  if (has_pointer_data())
137
    pointer_data()->wants_weak_jsobj = false;
138
139
2491
  persistent_handle_.ClearWeak();
140
2491
}
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
16979
BaseObject::MakeLazilyInitializedJSTemplate(Environment* env) {
152
63095
  auto constructor = [](const v8::FunctionCallbackInfo<v8::Value>& args) {
153
    DCHECK(args.IsConstructCall());
154
    DCHECK_GT(args.This()->InternalFieldCount(), 0);
155
46116
    args.This()->SetAlignedPointerInInternalField(BaseObject::kSlot, nullptr);
156
63095
  };
157
158
16979
  v8::Local<v8::FunctionTemplate> t = env->NewFunctionTemplate(constructor);
159
33958
  t->Inherit(BaseObject::GetConstructorTemplate(env));
160
50937
  t->InstanceTemplate()->SetInternalFieldCount(
161
16979
      BaseObject::kInternalFieldCount);
162
16979
  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
96964
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
96964
  CHECK(((*value)->*typecheck)());
178
193928
  info.This()->SetInternalField(Field, value);
179
96964
}
180
181
6437458
bool BaseObject::has_pointer_data() const {
182
6437458
  return pointer_data_ != nullptr;
183
}
184
185
2579068
BaseObject::PointerData* BaseObject::pointer_data() {
186
2579068
  if (!has_pointer_data()) {
187
156687
    PointerData* metadata = new PointerData();
188
313400
    metadata->wants_weak_jsobj = persistent_handle_.IsWeak();
189
156700
    metadata->self = this;
190
156700
    pointer_data_ = metadata;
191
  }
192
2579011
  CHECK(has_pointer_data());
193
2578995
  return pointer_data_;
194
}
195
196
669506
void BaseObject::decrease_refcount() {
197
669506
  CHECK(has_pointer_data());
198
669497
  PointerData* metadata = pointer_data();
199
669465
  CHECK_GT(metadata->strong_ptr_count, 0);
200
669465
  unsigned int new_refcount = --metadata->strong_ptr_count;
201
669465
  if (new_refcount == 0) {
202
213509
    if (metadata->is_detached) {
203
150871
      delete this;
204

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

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



670253
  if (get_base_object() == nullptr) {
223
    return nullptr;
224
  }
225
670252
  return get_base_object()->pointer_data();
226
}
227
228
template <typename T, bool kIsWeak>
229
8744312
BaseObject* BaseObjectPtrImpl<T, kIsWeak>::get_base_object() const {
230
  if (kIsWeak) {
231
517976
    if (pointer_data() == nullptr) {
232
4
      return nullptr;
233
    }
234
517972
    return pointer_data()->self;
235
  }
236
8226336
  return data_.target;
237
}
238
239
template <typename T, bool kIsWeak>
240
1635988
BaseObjectPtrImpl<T, kIsWeak>::~BaseObjectPtrImpl() {
241
  if (kIsWeak) {
242

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

60721
        --pointer_data()->weak_ptr_count == 0 &&
244
11786
        pointer_data()->self == nullptr) {
245
13
      delete pointer_data();
246
    }
247



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




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



670251
    CHECK_NOT_NULL(pointer_data());
268
670251
    get()->increase_refcount();
269
  }
270
}
271
272
template <typename T, bool kIsWeak>
273
template <typename U, bool kW>
274
17049
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(
275
    const BaseObjectPtrImpl<U, kW>& other)
276
17049
  : BaseObjectPtrImpl(other.get()) {}
277
278
template <typename T, bool kIsWeak>
279
438414
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(const BaseObjectPtrImpl& other)
280
438414
  : 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
436224
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(BaseObjectPtrImpl&& other)
301
436224
  : data_(other.data_) {
302
  if (kIsWeak)
303
2
    other.data_.target = nullptr;
304
  else
305
436222
    other.data_.pointer_data = nullptr;
306
436224
}
307
308
template <typename T, bool kIsWeak>
309
205109
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
310
    BaseObjectPtrImpl&& other) {
311


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


205109
  return *new (this) BaseObjectPtrImpl(std::move(other));
314
}
315
316
template <typename T, bool kIsWeak>
317
146274
void BaseObjectPtrImpl<T, kIsWeak>::reset(T* ptr) {
318
146274
  *this = BaseObjectPtrImpl(ptr);
319
146274
}
320
321
template <typename T, bool kIsWeak>
322
7403855
T* BaseObjectPtrImpl<T, kIsWeak>::get() const {
323
7403855
  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
2380367
T* BaseObjectPtrImpl<T, kIsWeak>::operator->() const {
333
2380367
  return get();
334
}
335
336
template <typename T, bool kIsWeak>
337
729082
BaseObjectPtrImpl<T, kIsWeak>::operator bool() const {
338
729082
  return get() != nullptr;
339
}
340
341
template <typename T, bool kIsWeak>
342
template <typename U, bool kW>
343
10696
bool BaseObjectPtrImpl<T, kIsWeak>::operator ==(
344
    const BaseObjectPtrImpl<U, kW>& other) const {
345
10696
  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
7353
BaseObjectPtr<T> MakeBaseObject(Args&&... args) {
357
7353
  return BaseObjectPtr<T>(new T(std::forward<Args>(args)...));
358
}
359
360
template <typename T, typename... Args>
361
7336
BaseObjectPtr<T> MakeDetachedBaseObject(Args&&... args) {
362
7336
  BaseObjectPtr<T> target = MakeBaseObject<T>(std::forward<Args>(args)...);
363
7336
  target->Detach();
364
7336
  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_