FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

src: per-realm binding data · nodejs/node@05f5c79 · GitHub

/ node Public

Commit 05f5c79

Browse files
legendecas
authored and
RafaelGSS
committed
src: per-realm binding data
Binding data is inherited from BaseObject and created in a specific realm. They need to be tracked on a per-realm basis so that they can be released properly when a realm is disposed. PR-URL: #46556 Backport-PR-URL: #47174 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> # Conflicts: # src/dataqueue/queue.cc
1 parent 9ca3cc0 commit 05f5c79

26 files changed

Lines changed: 205 additions & 197 deletions

‎src/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ Which explains that the unregistered external reference is
482482

483483
Some internal bindings, such as the HTTP parser, maintain internal state that
484484
only affects that particular binding. In that case, one common way to store
485-
that state is through the use of `Environment::AddBindingData`, which gives
485+
that state is through the use of `Realm::AddBindingData`, which gives
486486
binding functions access to an object for storing such state.
487487
That object is always a [`BaseObject`][].
488488

@@ -507,7 +507,7 @@ class BindingData : public BaseObject {
507507

508508
// Available for binding functions, e.g. the HTTP Parser constructor:
509509
static void New(const FunctionCallbackInfo<Value>& args) {
510-
BindingData* binding_data = Environment::GetBindingData<BindingData>(args);
510+
BindingData* binding_data = Realm::GetBindingData<BindingData>(args);
511511
new Parser(binding_data, args.This());
512512
}
513513

@@ -517,12 +517,12 @@ void InitializeHttpParser(Local<Object> target,
517517
Local<Value> unused,
518518
Local<Context> context,
519519
void* priv) {
520-
Environment* env = Environment::GetCurrent(context);
520+
Realm* realm = Realm::GetCurrent(context);
521521
BindingData* const binding_data =
522-
env->AddBindingData<BindingData>(context, target);
522+
realm->AddBindingData<BindingData>(context, target);
523523
if (binding_data == nullptr) return;
524524

525-
Local<FunctionTemplate> t = env->NewFunctionTemplate(Parser::New);
525+
Local<FunctionTemplate> t = NewFunctionTemplate(realm->isolate(), Parser::New);
526526
...
527527
}
528528
```

‎src/base_object-inl.h‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,10 @@
3333
namespace node {
3434

3535
BaseObject::BaseObject(Environment* env, v8::Local<v8::Object> object)
36-
: BaseObject(env->principal_realm(), object) {}
36+
: BaseObject(env->principal_realm(), object) {
37+
// TODO(legendecas): Check the shorthand is only used in the principal realm
38+
// while allowing to create a BaseObject in a vm context.
39+
}
3740

3841
// static
3942
v8::Local<v8::FunctionTemplate> BaseObject::GetConstructorTemplate(

‎src/env-inl.h‎

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -197,48 +197,6 @@ inline Environment* Environment::GetCurrent(
197197
return GetCurrent(info.GetIsolate()->GetCurrentContext());
198198
}
199199

200-
template <typename T, typename U>
201-
inline T* Environment::GetBindingData(const v8::PropertyCallbackInfo<U>& info) {
202-
return GetBindingData<T>(info.GetIsolate()->GetCurrentContext());
203-
}
204-
205-
template <typename T>
206-
inline T* Environment::GetBindingData(
207-
const v8::FunctionCallbackInfo<v8::Value>& info) {
208-
return GetBindingData<T>(info.GetIsolate()->GetCurrentContext());
209-
}
210-
211-
template <typename T>
212-
inline T* Environment::GetBindingData(v8::Local<v8::Context> context) {
213-
BindingDataStore* map = static_cast<BindingDataStore*>(
214-
context->GetAlignedPointerFromEmbedderData(
215-
ContextEmbedderIndex::kBindingListIndex));
216-
DCHECK_NOT_NULL(map);
217-
auto it = map->find(T::type_name);
218-
if (UNLIKELY(it == map->end())) return nullptr;
219-
T* result = static_cast<T*>(it->second.get());
220-
DCHECK_NOT_NULL(result);
221-
DCHECK_EQ(result->env(), GetCurrent(context));
222-
return result;
223-
}
224-
225-
template <typename T>
226-
inline T* Environment::AddBindingData(
227-
v8::Local<v8::Context> context,
228-
v8::Local<v8::Object> target) {
229-
DCHECK_EQ(GetCurrent(context), this);
230-
// This won't compile if T is not a BaseObject subclass.
231-
BaseObjectPtr<T> item = MakeDetachedBaseObject<T>(this, target);
232-
BindingDataStore* map = static_cast<BindingDataStore*>(
233-
context->GetAlignedPointerFromEmbedderData(
234-
ContextEmbedderIndex::kBindingListIndex));
235-
DCHECK_NOT_NULL(map);
236-
auto result = map->emplace(T::type_name, item);
237-
CHECK(result.second);
238-
DCHECK_EQ(GetBindingData<T>(context), item.get());
239-
return item.get();
240-
}
241-
242200
inline v8::Isolate* Environment::isolate() const {
243201
return isolate_;
244202
}

‎src/env.cc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -539,7 +539,8 @@ void Environment::AssignToContext(Local<v8::Context> context,
539539
context->SetAlignedPointerInEmbedderData(ContextEmbedderIndex::kRealm, realm);
540540
// Used to retrieve bindings
541541
context->SetAlignedPointerInEmbedderData(
542-
ContextEmbedderIndex::kBindingListIndex, &(this->bindings_));
542+
ContextEmbedderIndex::kBindingDataStoreIndex,
543+
realm->binding_data_store());
543544

544545
// ContextifyContexts will update this to a pointer to the native object.
545546
context->SetAlignedPointerInEmbedderData(
@@ -1010,7 +1011,6 @@ MaybeLocal<Value> Environment::RunSnapshotDeserializeMain() const {
10101011
void Environment::RunCleanup() {
10111012
started_cleanup_ = true;
10121013
TRACE_EVENT0(TRACING_CATEGORY_NODE1(environment), "RunCleanup");
1013-
bindings_.clear();
10141014
// Only BaseObject's cleanups are registered as per-realm cleanup hooks now.
10151015
// Defer the BaseObject cleanup after handles are cleaned up.
10161016
CleanupHandles();

‎src/env.h‎

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -571,25 +571,6 @@ class Environment : public MemoryRetainer {
571571
static inline Environment* GetCurrent(
572572
const v8::PropertyCallbackInfo<T>& info);
573573

574-
// Methods created using SetMethod(), SetPrototypeMethod(), etc. inside
575-
// this scope can access the created T* object using
576-
// GetBindingData<T>(args) later.
577-
template <typename T>
578-
T* AddBindingData(v8::Local<v8::Context> context,
579-
v8::Local<v8::Object> target);
580-
template <typename T, typename U>
581-
static inline T* GetBindingData(const v8::PropertyCallbackInfo<U>& info);
582-
template <typename T>
583-
static inline T* GetBindingData(
584-
const v8::FunctionCallbackInfo<v8::Value>& info);
585-
template <typename T>
586-
static inline T* GetBindingData(v8::Local<v8::Context> context);
587-
588-
typedef std::unordered_map<
589-
FastStringKey,
590-
BaseObjectPtr<BaseObject>,
591-
FastStringKey::Hash> BindingDataStore;
592-
593574
// Create an Environment without initializing a main Context. Use
594575
// InitializeMainContext() to initialize a main context for it.
595576
Environment(IsolateData* isolate_data,
@@ -1108,8 +1089,6 @@ class Environment : public MemoryRetainer {
11081089
void RequestInterruptFromV8();
11091090
static void CheckImmediate(uv_check_t* handle);
11101091

1111-
BindingDataStore bindings_;
1112-
11131092
CleanupQueue cleanup_queue_;
11141093
bool started_cleanup_ = false;
11151094

‎src/node_blob.cc‎

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,17 @@ void Blob::Initialize(
3737
Local<Value> unused,
3838
Local<Context> context,
3939
void* priv) {
40-
Environment* env = Environment::GetCurrent(context);
40+
Realm* realm = Realm::GetCurrent(context);
4141

4242
BlobBindingData* const binding_data =
43-
env->AddBindingData<BlobBindingData>(context, target);
43+
realm->AddBindingData<BlobBindingData>(context, target);
4444
if (binding_data == nullptr) return;
4545

4646
SetMethod(context, target, "createBlob", New);
4747
SetMethod(context, target, "storeDataObject", StoreDataObject);
4848
SetMethod(context, target, "getDataObject", GetDataObject);
4949
SetMethod(context, target, "revokeDataObject", RevokeDataObject);
50-
FixedSizeBlobCopyJob::Initialize(env, target);
50+
FixedSizeBlobCopyJob::Initialize(realm->env(), target);
5151
}
5252

5353
Local<FunctionTemplate> Blob::GetConstructorTemplate(Environment* env) {
@@ -236,8 +236,7 @@ std::unique_ptr<worker::TransferData> Blob::CloneForMessaging() const {
236236

237237
void Blob::StoreDataObject(const v8::FunctionCallbackInfo<v8::Value>& args) {
238238
Environment* env = Environment::GetCurrent(args);
239-
BlobBindingData* binding_data =
240-
Environment::GetBindingData<BlobBindingData>(args);
239+
BlobBindingData* binding_data = Realm::GetBindingData<BlobBindingData>(args);
241240

242241
CHECK(args[0]->IsString()); // ID key
243242
CHECK(Blob::HasInstance(env, args[1])); // Blob
@@ -260,8 +259,7 @@ void Blob::StoreDataObject(const v8::FunctionCallbackInfo<v8::Value>& args) {
260259
}
261260

262261
void Blob::RevokeDataObject(const v8::FunctionCallbackInfo<v8::Value>& args) {
263-
BlobBindingData* binding_data =
264-
Environment::GetBindingData<BlobBindingData>(args);
262+
BlobBindingData* binding_data = Realm::GetBindingData<BlobBindingData>(args);
265263

266264
Environment* env = Environment::GetCurrent(args);
267265
CHECK(args[0]->IsString()); // ID key
@@ -272,8 +270,7 @@ void Blob::RevokeDataObject(const v8::FunctionCallbackInfo<v8::Value>& args) {
272270
}
273271

274272
void Blob::GetDataObject(const v8::FunctionCallbackInfo<v8::Value>& args) {
275-
BlobBindingData* binding_data =
276-
Environment::GetBindingData<BlobBindingData>(args);
273+
BlobBindingData* binding_data = Realm::GetBindingData<BlobBindingData>(args);
277274

278275
Environment* env = Environment::GetCurrent(args);
279276
CHECK(args[0]->IsString());
@@ -428,8 +425,8 @@ BlobBindingData::StoredDataObject::StoredDataObject(
428425
length(length_),
429426
type(type_) {}
430427

431-
BlobBindingData::BlobBindingData(Environment* env, Local<Object> wrap)
432-
: SnapshotableObject(env, wrap, type_int) {
428+
BlobBindingData::BlobBindingData(Realm* realm, Local<Object> wrap)
429+
: SnapshotableObject(realm, wrap, type_int) {
433430
MakeWeak();
434431
}
435432

@@ -465,9 +462,9 @@ void BlobBindingData::Deserialize(Local<Context> context,
465462
InternalFieldInfoBase* info) {
466463
DCHECK_EQ(index, BaseObject::kEmbedderType);
467464
HandleScope scope(context->GetIsolate());
468-
Environment* env = Environment::GetCurrent(context);
465+
Realm* realm = Realm::GetCurrent(context);
469466
BlobBindingData* binding =
470-
env->AddBindingData<BlobBindingData>(context, holder);
467+
realm->AddBindingData<BlobBindingData>(context, holder);
471468
CHECK_NOT_NULL(binding);
472469
}
473470

‎src/node_blob.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ class FixedSizeBlobCopyJob : public AsyncWrap, public ThreadPoolWork {
141141

142142
class BlobBindingData : public SnapshotableObject {
143143
public:
144-
explicit BlobBindingData(Environment* env, v8::Local<v8::Object> wrap);
144+
explicit BlobBindingData(Realm* realm, v8::Local<v8::Object> wrap);
145145

146146
using InternalFieldInfo = InternalFieldInfoBase;
147147

‎src/node_context_data.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ namespace node {
2424
#define NODE_CONTEXT_ALLOW_WASM_CODE_GENERATION_INDEX 34
2525
#endif
2626

27-
#ifndef NODE_BINDING_LIST
28-
#define NODE_BINDING_LIST_INDEX 35
27+
#ifndef NODE_BINDING_DATA_STORE_INDEX
28+
#define NODE_BINDING_DATA_STORE_INDEX 35
2929
#endif
3030

3131
#ifndef NODE_CONTEXT_ALLOW_CODE_GENERATION_FROM_STRINGS_INDEX
@@ -51,7 +51,7 @@ enum ContextEmbedderIndex {
5151
kEnvironment = NODE_CONTEXT_EMBEDDER_DATA_INDEX,
5252
kSandboxObject = NODE_CONTEXT_SANDBOX_OBJECT_INDEX,
5353
kAllowWasmCodeGeneration = NODE_CONTEXT_ALLOW_WASM_CODE_GENERATION_INDEX,
54-
kBindingListIndex = NODE_BINDING_LIST_INDEX,
54+
kBindingDataStoreIndex = NODE_BINDING_DATA_STORE_INDEX,
5555
kAllowCodeGenerationFromStrings =
5656
NODE_CONTEXT_ALLOW_CODE_GENERATION_FROM_STRINGS_INDEX,
5757
kContextifyContext = NODE_CONTEXT_CONTEXTIFY_CONTEXT_INDEX,

‎src/node_file-inl.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ FSReqBase* GetReqWrap(const v8::FunctionCallbackInfo<v8::Value>& args,
277277
return Unwrap<FSReqBase>(value.As<v8::Object>());
278278
}
279279

280-
BindingData* binding_data = Environment::GetBindingData<BindingData>(args);
280+
BindingData* binding_data = Realm::GetBindingData<BindingData>(args);
281281
Environment* env = binding_data->env();
282282
if (value->StrictEquals(env->fs_use_promises_symbol())) {
283283
if (use_bigint) {

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL