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 169 95.3 %
Date: 2020-09-03 22:13:26 Branches: 105 162 64.8 %

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
#if (__GNUC__ >= 8) && !defined(__clang__)
32
#pragma GCC diagnostic push
33
#pragma GCC diagnostic ignored "-Wcast-function-type"
34
#endif
35
#include "v8.h"
36
#if (__GNUC__ >= 8) && !defined(__clang__)
37
#pragma GCC diagnostic pop
38
#endif
39
40
namespace node {
41
42
648731
BaseObject::BaseObject(Environment* env, v8::Local<v8::Object> object)
43
1297462
    : persistent_handle_(env->isolate(), object), env_(env) {
44
648731
  CHECK_EQ(false, object.IsEmpty());
45
648731
  CHECK_GT(object->InternalFieldCount(), 0);
46
648731
  object->SetAlignedPointerInInternalField(
47
      BaseObject::kSlot,
48
648731
      static_cast<void*>(this));
49
648731
  env->AddCleanupHook(DeleteMe, static_cast<void*>(this));
50
648731
  env->modify_base_object_count(1);
51
648730
}
52
53

1924776
BaseObject::~BaseObject() {
54
641587
  env()->modify_base_object_count(-1);
55
641591
  env()->RemoveCleanupHook(DeleteMe, static_cast<void*>(this));
56
57
641596
  if (UNLIKELY(has_pointer_data())) {
58
151641
    PointerData* metadata = pointer_data();
59
151642
    CHECK_EQ(metadata->strong_ptr_count, 0);
60
151642
    metadata->self = nullptr;
61
151642
    if (metadata->weak_ptr_count == 0)
62
151629
      delete metadata;
63
  }
64
65
1283196
  if (persistent_handle_.IsEmpty()) {
66
    // This most likely happened because the weak callback below cleared it.
67
387784
    return;
68
  }
69
70
  {
71
507628
    v8::HandleScope handle_scope(env()->isolate());
72
507627
    object()->SetAlignedPointerInInternalField(BaseObject::kSlot, nullptr);
73
  }
74
641593
}
75
76
149715
void BaseObject::Detach() {
77
149715
  CHECK_GT(pointer_data()->strong_ptr_count, 0);
78
149715
  pointer_data()->is_detached = true;
79
149719
}
80
81
696757
v8::Global<v8::Object>& BaseObject::persistent() {
82
696757
  return persistent_handle_;
83
}
84
85
86
2781095
v8::Local<v8::Object> BaseObject::object() const {
87
2781095
  return PersistentToLocal::Default(env()->isolate(), persistent_handle_);
88
}
89
90
96465
v8::Local<v8::Object> BaseObject::object(v8::Isolate* isolate) const {
91
96465
  v8::Local<v8::Object> handle = object();
92
93
  DCHECK_EQ(handle->CreationContext()->GetIsolate(), isolate);
94
  DCHECK_EQ(env()->isolate(), isolate);
95
96
96465
  return handle;
97
}
98
99
12747427
Environment* BaseObject::env() const {
100
12747427
  return env_;
101
}
102
103
5082377
BaseObject* BaseObject::FromJSObject(v8::Local<v8::Value> value) {
104
5082377
  v8::Local<v8::Object> obj = value.As<v8::Object>();
105
  DCHECK_GE(obj->InternalFieldCount(), BaseObject::kSlot);
106
  return static_cast<BaseObject*>(
107
10164757
      obj->GetAlignedPointerFromInternalField(BaseObject::kSlot));
108
}
109
110
111
template <typename T>
112
1048539
T* BaseObject::FromJSObject(v8::Local<v8::Value> object) {
113
1048539
  return static_cast<T*>(FromJSObject(object));
114
}
115
116
117
490650
void BaseObject::MakeWeak() {
118
490650
  if (has_pointer_data()) {
119
38096
    pointer_data()->wants_weak_jsobj = true;
120
38096
    if (pointer_data()->strong_ptr_count > 0) return;
121
  }
122
123
981298
  persistent_handle_.SetWeak(
124
      this,
125
1266211
      [](const v8::WeakCallbackInfo<BaseObject>& data) {
126
387781
        BaseObject* obj = data.GetParameter();
127
        // Clear the persistent handle so that ~BaseObject() doesn't attempt
128
        // to mess with internal fields, since the JS object may have
129
        // transitioned into an invalid state.
130
        // Refs: https://github.com/nodejs/node/issues/18897
131
387781
        obj->persistent_handle_.Reset();
132

387781
        CHECK_IMPLIES(obj->has_pointer_data(),
133
                      obj->pointer_data()->strong_ptr_count == 0);
134
387781
        obj->OnGCCollect();
135
1266211
      }, v8::WeakCallbackType::kParameter);
136
}
137
138
387779
void BaseObject::OnGCCollect() {
139
387779
  delete this;
140
387779
}
141
142
2480
void BaseObject::ClearWeak() {
143
2480
  if (has_pointer_data())
144
    pointer_data()->wants_weak_jsobj = false;
145
146
2480
  persistent_handle_.ClearWeak();
147
2480
}
148
149
150
v8::Local<v8::FunctionTemplate>
151
16261
BaseObject::MakeLazilyInitializedJSTemplate(Environment* env) {
152
61135
  auto constructor = [](const v8::FunctionCallbackInfo<v8::Value>& args) {
153
    DCHECK(args.IsConstructCall());
154
    DCHECK_GT(args.This()->InternalFieldCount(), 0);
155
44874
    args.This()->SetAlignedPointerInInternalField(BaseObject::kSlot, nullptr);
156
61135
  };
157
158
16261
  v8::Local<v8::FunctionTemplate> t = env->NewFunctionTemplate(constructor);
159
32522
  t->Inherit(BaseObject::GetConstructorTemplate(env));
160
48783
  t->InstanceTemplate()->SetInternalFieldCount(
161
16261
      BaseObject::kInternalFieldCount);
162
16261
  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
95272
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
95272
  CHECK(((*value)->*typecheck)());
178
190544
  info.This()->SetInternalField(Field, value);
179
95272
}
180
181
7190619
bool BaseObject::has_pointer_data() const {
182
7190619
  return pointer_data_ != nullptr;
183
}
184
185
2468365
BaseObject::PointerData* BaseObject::pointer_data() {
186
2468365
  if (!has_pointer_data()) {
187
152271
    PointerData* metadata = new PointerData();
188
304542
    metadata->wants_weak_jsobj = persistent_handle_.IsWeak();
189
152271
    metadata->self = this;
190
152271
    pointer_data_ = metadata;
191
  }
192
2468397
  CHECK(has_pointer_data());
193
2468413
  return pointer_data_;
194
}
195
196
637588
void BaseObject::decrease_refcount() {
197
637588
  CHECK(has_pointer_data());
198
637597
  PointerData* metadata = pointer_data();
199
637598
  CHECK_GT(metadata->strong_ptr_count, 0);
200
637598
  unsigned int new_refcount = --metadata->strong_ptr_count;
201
637598
  if (new_refcount == 0) {
202
208458
    if (metadata->is_detached) {
203
149016
      delete this;
204

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

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



638258
  if (get_base_object() == nullptr) {
223
    return nullptr;
224
  }
225
638262
  return get_base_object()->pointer_data();
226
}
227
228
template <typename T, bool kIsWeak>
229
7548524
BaseObject* BaseObjectPtrImpl<T, kIsWeak>::get_base_object() const {
230
  if (kIsWeak) {
231
517635
    if (pointer_data() == nullptr) {
232
4
      return nullptr;
233
    }
234
517631
    return pointer_data()->self;
235
  }
236
7030889
  return data_.target;
237
}
238
239
template <typename T, bool kIsWeak>
240
1142610
BaseObjectPtrImpl<T, kIsWeak>::~BaseObjectPtrImpl() {
241
  if (kIsWeak) {
242

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

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



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




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



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


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


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