GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: base_object.cc Lines: 84 86 97.7 %
Date: 2022-11-09 04:21:35 Branches: 51 62 82.3 %

Line Branch Exec Source
1
#include "base_object.h"
2
#include "env-inl.h"
3
#include "node_realm-inl.h"
4
5
namespace node {
6
7
using v8::FunctionCallbackInfo;
8
using v8::FunctionTemplate;
9
using v8::HandleScope;
10
using v8::Local;
11
using v8::Object;
12
using v8::Value;
13
using v8::WeakCallbackInfo;
14
using v8::WeakCallbackType;
15
16
1465763
BaseObject::BaseObject(Realm* realm, Local<Object> object)
17
2931526
    : persistent_handle_(realm->isolate(), object), realm_(realm) {
18
1465763
  CHECK_EQ(false, object.IsEmpty());
19
1465763
  CHECK_GE(object->InternalFieldCount(), BaseObject::kInternalFieldCount);
20
1465763
  SetInternalFields(object, static_cast<void*>(this));
21
1465763
  realm->AddCleanupHook(DeleteMe, static_cast<void*>(this));
22
1465763
  realm->modify_base_object_count(1);
23
1465763
}
24
25

7959342
BaseObject::~BaseObject() {
26
2899272
  realm()->modify_base_object_count(-1);
27
2899272
  realm()->RemoveCleanupHook(DeleteMe, static_cast<void*>(this));
28
29
2899272
  if (UNLIKELY(has_pointer_data())) {
30
396000
    PointerData* metadata = pointer_data();
31
396000
    CHECK_EQ(metadata->strong_ptr_count, 0);
32
396000
    metadata->self = nullptr;
33
396000
    if (metadata->weak_ptr_count == 0) delete metadata;
34
  }
35
36
2899272
  if (persistent_handle_.IsEmpty()) {
37
    // This most likely happened because the weak callback below cleared it.
38
2160798
    return;
39
  }
40
41
  {
42
738474
    HandleScope handle_scope(realm()->isolate());
43
1476948
    object()->SetAlignedPointerInInternalField(BaseObject::kSlot, nullptr);
44
  }
45
}
46
47
1330086
void BaseObject::MakeWeak() {
48
1330086
  if (has_pointer_data()) {
49
44653
    pointer_data()->wants_weak_jsobj = true;
50
44653
    if (pointer_data()->strong_ptr_count > 0) return;
51
  }
52
53
2658922
  persistent_handle_.SetWeak(
54
      this,
55
1080398
      [](const WeakCallbackInfo<BaseObject>& data) {
56
1080398
        BaseObject* obj = data.GetParameter();
57
        // Clear the persistent handle so that ~BaseObject() doesn't attempt
58
        // to mess with internal fields, since the JS object may have
59
        // transitioned into an invalid state.
60
        // Refs: https://github.com/nodejs/node/issues/18897
61
1080398
        obj->persistent_handle_.Reset();
62

1080398
        CHECK_IMPLIES(obj->has_pointer_data(),
63
                      obj->pointer_data()->strong_ptr_count == 0);
64
1080398
        obj->OnGCCollect();
65
1080398
      },
66
      WeakCallbackType::kParameter);
67
}
68
69
// This just has to be different from the Chromium ones:
70
// https://source.chromium.org/chromium/chromium/src/+/main:gin/public/gin_embedders.h;l=18-23;drc=5a758a97032f0b656c3c36a3497560762495501a
71
// Otherwise, when Node is loaded in an isolate which uses cppgc, cppgc will
72
// misinterpret the data stored in the embedder fields and try to garbage
73
// collect them.
74
uint16_t kNodeEmbedderId = 0x90de;
75
76
23740
void BaseObject::LazilyInitializedJSTemplateConstructor(
77
    const FunctionCallbackInfo<Value>& args) {
78
  DCHECK(args.IsConstructCall());
79
23740
  CHECK_GE(args.This()->InternalFieldCount(), BaseObject::kInternalFieldCount);
80
23740
  SetInternalFields(args.This(), nullptr);
81
23740
}
82
83
22081
Local<FunctionTemplate> BaseObject::MakeLazilyInitializedJSTemplate(
84
    Environment* env) {
85
22081
  return MakeLazilyInitializedJSTemplate(env->isolate_data());
86
}
87
88
22880
Local<FunctionTemplate> BaseObject::MakeLazilyInitializedJSTemplate(
89
    IsolateData* isolate_data) {
90
  Local<FunctionTemplate> t = NewFunctionTemplate(
91
22880
      isolate_data->isolate(), LazilyInitializedJSTemplateConstructor);
92
22880
  t->Inherit(BaseObject::GetConstructorTemplate(isolate_data));
93
45760
  t->InstanceTemplate()->SetInternalFieldCount(BaseObject::kInternalFieldCount);
94
22880
  return t;
95
}
96
97
3414464
BaseObject::PointerData* BaseObject::pointer_data() {
98
3414464
  if (!has_pointer_data()) {
99
201022
    PointerData* metadata = new PointerData();
100
201022
    metadata->wants_weak_jsobj = persistent_handle_.IsWeak();
101
201022
    metadata->self = this;
102
201022
    pointer_data_ = metadata;
103
  }
104
3414464
  CHECK(has_pointer_data());
105
3414464
  return pointer_data_;
106
}
107
108
852866
void BaseObject::decrease_refcount() {
109
852866
  CHECK(has_pointer_data());
110
852866
  PointerData* metadata = pointer_data();
111
852866
  CHECK_GT(metadata->strong_ptr_count, 0);
112
852866
  unsigned int new_refcount = --metadata->strong_ptr_count;
113
852866
  if (new_refcount == 0) {
114
266107
    if (metadata->is_detached) {
115
191498
      OnGCCollect();
116

74609
    } else if (metadata->wants_weak_jsobj && !persistent_handle_.IsEmpty()) {
117
44028
      MakeWeak();
118
    }
119
  }
120
852866
}
121
122
855926
void BaseObject::increase_refcount() {
123
855926
  unsigned int prev_refcount = pointer_data()->strong_ptr_count++;
124

855926
  if (prev_refcount == 0 && !persistent_handle_.IsEmpty())
125
269002
    persistent_handle_.ClearWeak();
126
855926
}
127
128
168557
void BaseObject::DeleteMe(void* data) {
129
168557
  BaseObject* self = static_cast<BaseObject*>(data);
130

168557
  if (self->has_pointer_data() && self->pointer_data()->strong_ptr_count > 0) {
131
893
    return self->Detach();
132
  }
133
167664
  delete self;
134
}
135
136
1786
bool BaseObject::IsDoneInitializing() const {
137
1786
  return true;
138
}
139
140
976
Local<Object> BaseObject::WrappedObject() const {
141
976
  return object();
142
}
143
144
1767
bool BaseObject::IsRootNode() const {
145
3534
  return !persistent_handle_.IsWeak();
146
}
147
148
57778
Local<FunctionTemplate> BaseObject::GetConstructorTemplate(
149
    IsolateData* isolate_data) {
150
57778
  Local<FunctionTemplate> tmpl = isolate_data->base_object_ctor_template();
151
57778
  if (tmpl.IsEmpty()) {
152
799
    tmpl = NewFunctionTemplate(isolate_data->isolate(), nullptr);
153
799
    tmpl->SetClassName(
154
        FIXED_ONE_BYTE_STRING(isolate_data->isolate(), "BaseObject"));
155
799
    isolate_data->set_base_object_ctor_template(tmpl);
156
  }
157
57778
  return tmpl;
158
}
159
160
bool BaseObject::IsNotIndicativeOfMemoryLeakAtExit() const {
161
  return IsWeakOrDetached();
162
}
163
164
}  // namespace node