GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: base_object.cc Lines: 84 86 97.7 %
Date: 2022-12-31 04:22:30 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
1409602
BaseObject::BaseObject(Realm* realm, Local<Object> object)
17
2819204
    : persistent_handle_(realm->isolate(), object), realm_(realm) {
18
1409602
  CHECK_EQ(false, object.IsEmpty());
19
1409602
  CHECK_GE(object->InternalFieldCount(), BaseObject::kInternalFieldCount);
20
1409602
  SetInternalFields(object, static_cast<void*>(this));
21
1409602
  realm->AddCleanupHook(DeleteMe, static_cast<void*>(this));
22
1409602
  realm->modify_base_object_count(1);
23
1409602
}
24
25

7688370
BaseObject::~BaseObject() {
26
2796180
  realm()->modify_base_object_count(-1);
27
2796180
  realm()->RemoveCleanupHook(DeleteMe, static_cast<void*>(this));
28
29
2796180
  if (UNLIKELY(has_pointer_data())) {
30
388638
    PointerData* metadata = pointer_data();
31
388638
    CHECK_EQ(metadata->strong_ptr_count, 0);
32
388638
    metadata->self = nullptr;
33
388638
    if (metadata->weak_ptr_count == 0) delete metadata;
34
  }
35
36
2796180
  if (persistent_handle_.IsEmpty()) {
37
    // This most likely happened because the weak callback below cleared it.
38
2096010
    return;
39
  }
40
41
  {
42
700170
    HandleScope handle_scope(realm()->isolate());
43
1400340
    object()->SetAlignedPointerInInternalField(BaseObject::kSlot, nullptr);
44
  }
45
}
46
47
1277437
void BaseObject::MakeWeak() {
48
1277437
  if (has_pointer_data()) {
49
45013
    pointer_data()->wants_weak_jsobj = true;
50
45013
    if (pointer_data()->strong_ptr_count > 0) return;
51
  }
52
53
2553526
  persistent_handle_.SetWeak(
54
      this,
55
1048004
      [](const WeakCallbackInfo<BaseObject>& data) {
56
1048004
        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
1048004
        obj->persistent_handle_.Reset();
62

1048004
        CHECK_IMPLIES(obj->has_pointer_data(),
63
                      obj->pointer_data()->strong_ptr_count == 0);
64
1048004
        obj->OnGCCollect();
65
1048004
      },
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
23816
void BaseObject::LazilyInitializedJSTemplateConstructor(
77
    const FunctionCallbackInfo<Value>& args) {
78
  DCHECK(args.IsConstructCall());
79
23816
  CHECK_GE(args.This()->InternalFieldCount(), BaseObject::kInternalFieldCount);
80
23816
  SetInternalFields(args.This(), nullptr);
81
23816
}
82
83
20879
Local<FunctionTemplate> BaseObject::MakeLazilyInitializedJSTemplate(
84
    Environment* env) {
85
20879
  return MakeLazilyInitializedJSTemplate(env->isolate_data());
86
}
87
88
21710
Local<FunctionTemplate> BaseObject::MakeLazilyInitializedJSTemplate(
89
    IsolateData* isolate_data) {
90
  Local<FunctionTemplate> t = NewFunctionTemplate(
91
21710
      isolate_data->isolate(), LazilyInitializedJSTemplateConstructor);
92
21710
  t->Inherit(BaseObject::GetConstructorTemplate(isolate_data));
93
43420
  t->InstanceTemplate()->SetInternalFieldCount(BaseObject::kInternalFieldCount);
94
21710
  return t;
95
}
96
97
3373447
BaseObject::PointerData* BaseObject::pointer_data() {
98
3373447
  if (!has_pointer_data()) {
99
196594
    PointerData* metadata = new PointerData();
100
196594
    metadata->wants_weak_jsobj = persistent_handle_.IsWeak();
101
196594
    metadata->self = this;
102
196594
    pointer_data_ = metadata;
103
  }
104
3373447
  CHECK(has_pointer_data());
105
3373447
  return pointer_data_;
106
}
107
108
843789
void BaseObject::decrease_refcount() {
109
843789
  CHECK(has_pointer_data());
110
843789
  PointerData* metadata = pointer_data();
111
843789
  CHECK_GT(metadata->strong_ptr_count, 0);
112
843789
  unsigned int new_refcount = --metadata->strong_ptr_count;
113
843789
  if (new_refcount == 0) {
114
262706
    if (metadata->is_detached) {
115
187644
      OnGCCollect();
116

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

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

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