Commit f04f249fe57 for nodejs
commit f04f249fe57183fd34f6ae987ab55f52b5ae3502
Author: James M Snell <jasnell@gmail.com>
Date: Sun Nov 15 19:20:35 2026 +0000
src: share snapshot Serialize()/Deserialize() logic for binding data
Eleven snapshotable binding data classes implemented Deserialize() with
the same sequence of opening a handle scope, looking up the Realm, and
recreating the binding data on the holder, and six of them implemented
Serialize() by handing over the InternalFieldInfo allocated in
PrepareForSerialization(). Add Realm::DeserializeBindingData() and
TakeInternalFieldInfo() helpers and use them.
Assisted-by: Claude
Signed-off-by: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/67497
Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
diff --git a/src/encoding_binding.cc b/src/encoding_binding.cc
index 8a445088b54..5b8f8f0bcdc 100644
--- a/src/encoding_binding.cc
+++ b/src/encoding_binding.cc
@@ -20,7 +20,6 @@ using v8::BackingStoreInitializationMode;
using v8::BackingStoreOnFailureMode;
using v8::Context;
using v8::FunctionCallbackInfo;
-using v8::HandleScope;
using v8::Isolate;
using v8::Local;
using v8::Object;
@@ -67,10 +66,7 @@ bool BindingData::PrepareForSerialization(Local<Context> context,
}
InternalFieldInfoBase* BindingData::Serialize(int index) {
- DCHECK_IS_SNAPSHOT_SLOT(index);
- InternalFieldInfo* info = internal_field_info_;
- internal_field_info_ = nullptr;
- return info;
+ return TakeInternalFieldInfo(index, &internal_field_info_);
}
// The following code is adapted from Cloudflare workers.
@@ -185,13 +181,8 @@ void BindingData::Deserialize(Local<Context> context,
int index,
InternalFieldInfoBase* info) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- HandleScope scope(Isolate::GetCurrent());
- Realm* realm = Realm::GetCurrent(context);
- // Recreate the buffer in the constructor.
- InternalFieldInfo* casted_info = static_cast<InternalFieldInfo*>(info);
- BindingData* binding =
- realm->AddBindingData<BindingData>(holder, casted_info);
- CHECK_NOT_NULL(binding);
+ Realm::DeserializeBindingData<BindingData>(
+ context, holder, static_cast<InternalFieldInfo*>(info));
}
void BindingData::EncodeInto(const FunctionCallbackInfo<Value>& args) {
diff --git a/src/glob/node_glob.cc b/src/glob/node_glob.cc
index 0e8b1e86ea6..74fadb417c1 100644
--- a/src/glob/node_glob.cc
+++ b/src/glob/node_glob.cc
@@ -178,10 +178,7 @@ void BindingData::Deserialize(Local<Context> context,
int index,
InternalFieldInfoBase* info) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- Realm* realm = Realm::GetCurrent(context);
- HandleScope scope(realm->isolate());
- BindingData* binding = realm->AddBindingData<BindingData>(holder, info);
- CHECK_NOT_NULL(binding);
+ Realm::DeserializeBindingData<BindingData>(context, holder, info);
}
void BindingData::MemoryInfo(MemoryTracker* tracker) const {
diff --git a/src/node_blob.cc b/src/node_blob.cc
index ab4267fb81f..bdc10ab2ad7 100644
--- a/src/node_blob.cc
+++ b/src/node_blob.cc
@@ -584,10 +584,7 @@ void BlobBindingData::Deserialize(Local<Context> context,
int index,
InternalFieldInfoBase* info) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- HandleScope scope(Isolate::GetCurrent());
- Realm* realm = Realm::GetCurrent(context);
- BlobBindingData* binding = realm->AddBindingData<BlobBindingData>(holder);
- CHECK_NOT_NULL(binding);
+ Realm::DeserializeBindingData<BlobBindingData>(context, holder);
}
bool BlobBindingData::PrepareForSerialization(Local<Context> context,
@@ -600,9 +597,7 @@ bool BlobBindingData::PrepareForSerialization(Local<Context> context,
InternalFieldInfoBase* BlobBindingData::Serialize(int index) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- InternalFieldInfo* info =
- InternalFieldInfoBase::New<InternalFieldInfo>(type());
- return info;
+ return InternalFieldInfoBase::New<InternalFieldInfo>(type());
}
void Blob::RegisterExternalReferences(ExternalReferenceRegistry* registry) {
diff --git a/src/node_diagnostics_channel.cc b/src/node_diagnostics_channel.cc
index c9d8a6de062..b569214571b 100644
--- a/src/node_diagnostics_channel.cc
+++ b/src/node_diagnostics_channel.cc
@@ -128,10 +128,7 @@ bool BindingData::PrepareForSerialization(Local<Context> context,
}
InternalFieldInfoBase* BindingData::Serialize(int index) {
- DCHECK_IS_SNAPSHOT_SLOT(index);
- InternalFieldInfo* info = internal_field_info_;
- internal_field_info_ = nullptr;
- return info;
+ return TakeInternalFieldInfo(index, &internal_field_info_);
}
void BindingData::Deserialize(Local<Context> context,
@@ -139,11 +136,8 @@ void BindingData::Deserialize(Local<Context> context,
int index,
InternalFieldInfoBase* info) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- HandleScope scope(Isolate::GetCurrent());
- Realm* realm = Realm::GetCurrent(context);
- BindingData* binding = realm->AddBindingData<BindingData>(
- holder, static_cast<InternalFieldInfo*>(info));
- CHECK_NOT_NULL(binding);
+ Realm::DeserializeBindingData<BindingData>(
+ context, holder, static_cast<InternalFieldInfo*>(info));
}
void BindingData::SetChannelStatusCallback(uint32_t index,
diff --git a/src/node_file.cc b/src/node_file.cc
index 795d796e2bc..20d82547c81 100644
--- a/src/node_file.cc
+++ b/src/node_file.cc
@@ -5632,12 +5632,8 @@ void BindingData::Deserialize(Local<Context> context,
int index,
InternalFieldInfoBase* info) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- HandleScope scope(Isolate::GetCurrent());
- Realm* realm = Realm::GetCurrent(context);
- InternalFieldInfo* casted_info = static_cast<InternalFieldInfo*>(info);
- BindingData* binding =
- realm->AddBindingData<BindingData>(holder, casted_info);
- CHECK_NOT_NULL(binding);
+ Realm::DeserializeBindingData<BindingData>(
+ context, holder, static_cast<InternalFieldInfo*>(info));
}
bool BindingData::PrepareForSerialization(Local<Context> context,
@@ -5659,10 +5655,7 @@ bool BindingData::PrepareForSerialization(Local<Context> context,
}
InternalFieldInfoBase* BindingData::Serialize(int index) {
- DCHECK_IS_SNAPSHOT_SLOT(index);
- InternalFieldInfo* info = internal_field_info_;
- internal_field_info_ = nullptr;
- return info;
+ return TakeInternalFieldInfo(index, &internal_field_info_);
}
#ifdef _WIN32
diff --git a/src/node_modules.cc b/src/node_modules.cc
index ee9be4557ac..f32abb90d9d 100644
--- a/src/node_modules.cc
+++ b/src/node_modules.cc
@@ -67,9 +67,7 @@ bool BindingData::PrepareForSerialization(v8::Local<v8::Context> context,
InternalFieldInfoBase* BindingData::Serialize(int index) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- InternalFieldInfo* info =
- InternalFieldInfoBase::New<InternalFieldInfo>(type());
- return info;
+ return InternalFieldInfoBase::New<InternalFieldInfo>(type());
}
void BindingData::Deserialize(v8::Local<v8::Context> context,
@@ -77,10 +75,7 @@ void BindingData::Deserialize(v8::Local<v8::Context> context,
int index,
InternalFieldInfoBase* info) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- HandleScope scope(Isolate::GetCurrent());
- Realm* realm = Realm::GetCurrent(context);
- BindingData* binding = realm->AddBindingData<BindingData>(holder);
- CHECK_NOT_NULL(binding);
+ Realm::DeserializeBindingData<BindingData>(context, holder);
}
Local<Array> BindingData::PackageConfig::Serialize(Realm* realm) const {
diff --git a/src/node_process_methods.cc b/src/node_process_methods.cc
index 6a35e5c5e4c..2db5e3678b5 100644
--- a/src/node_process_methods.cc
+++ b/src/node_process_methods.cc
@@ -752,10 +752,7 @@ bool BindingData::PrepareForSerialization(Local<Context> context,
}
InternalFieldInfoBase* BindingData::Serialize(int index) {
- DCHECK_IS_SNAPSHOT_SLOT(index);
- InternalFieldInfo* info = internal_field_info_;
- internal_field_info_ = nullptr;
- return info;
+ return TakeInternalFieldInfo(index, &internal_field_info_);
}
void BindingData::Deserialize(Local<Context> context,
@@ -763,13 +760,8 @@ void BindingData::Deserialize(Local<Context> context,
int index,
InternalFieldInfoBase* info) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- v8::HandleScope scope(Isolate::GetCurrent());
- Realm* realm = Realm::GetCurrent(context);
- // Recreate the buffer in the constructor.
- InternalFieldInfo* casted_info = static_cast<InternalFieldInfo*>(info);
- BindingData* binding =
- realm->AddBindingData<BindingData>(holder, casted_info);
- CHECK_NOT_NULL(binding);
+ Realm::DeserializeBindingData<BindingData>(
+ context, holder, static_cast<InternalFieldInfo*>(info));
}
static void SetEmitWarningSync(const FunctionCallbackInfo<Value>& args) {
diff --git a/src/node_realm-inl.h b/src/node_realm-inl.h
index 62f77384a38..61a09b6ee2c 100644
--- a/src/node_realm-inl.h
+++ b/src/node_realm-inl.h
@@ -108,6 +108,15 @@ inline T* Realm::AddBindingData(v8::Local<v8::Object> target, Args&&... args) {
return item.get();
}
+template <std::derived_from<BaseObject> T, typename... Args>
+void Realm::DeserializeBindingData(v8::Local<v8::Context> context,
+ v8::Local<v8::Object> holder,
+ Args&&... args) {
+ v8::HandleScope scope(v8::Isolate::GetCurrent());
+ Realm* realm = Realm::GetCurrent(context);
+ CHECK_NOT_NULL(realm->AddBindingData<T>(holder, std::forward<Args>(args)...));
+}
+
inline BindingDataStore* Realm::binding_data_store() {
return &binding_data_store_;
}
diff --git a/src/node_realm.h b/src/node_realm.h
index 8bba26f50a9..810d48c8e3e 100644
--- a/src/node_realm.h
+++ b/src/node_realm.h
@@ -128,6 +128,13 @@ class Realm : public MemoryRetainer {
// GetBindingData<T>(args) later.
template <std::derived_from<BaseObject> T, typename... Args>
T* AddBindingData(v8::Local<v8::Object> target, Args&&... args);
+ // Recreates binding data of type T on `holder` in the realm of `context`
+ // when deserializing a snapshot. Used to implement the static Deserialize()
+ // method of snapshotable binding data.
+ template <std::derived_from<BaseObject> T, typename... Args>
+ static void DeserializeBindingData(v8::Local<v8::Context> context,
+ v8::Local<v8::Object> holder,
+ Args&&... args);
template <typename T, typename U>
static inline T* GetBindingData(const v8::PropertyCallbackInfo<U>& info);
template <typename T>
diff --git a/src/node_snapshotable.cc b/src/node_snapshotable.cc
index faf95133bf4..c2ac34e662c 100644
--- a/src/node_snapshotable.cc
+++ b/src/node_snapshotable.cc
@@ -1701,10 +1701,7 @@ bool BindingData::PrepareForSerialization(Local<Context> context,
}
InternalFieldInfoBase* BindingData::Serialize(int index) {
- DCHECK_IS_SNAPSHOT_SLOT(index);
- InternalFieldInfo* info = internal_field_info_;
- internal_field_info_ = nullptr;
- return info;
+ return TakeInternalFieldInfo(index, &internal_field_info_);
}
void BindingData::Deserialize(Local<Context> context,
@@ -1712,13 +1709,8 @@ void BindingData::Deserialize(Local<Context> context,
int index,
InternalFieldInfoBase* info) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- v8::HandleScope scope(Isolate::GetCurrent());
- Realm* realm = Realm::GetCurrent(context);
- // Recreate the buffer in the constructor.
- InternalFieldInfo* casted_info = static_cast<InternalFieldInfo*>(info);
- BindingData* binding =
- realm->AddBindingData<BindingData>(holder, casted_info);
- CHECK_NOT_NULL(binding);
+ Realm::DeserializeBindingData<BindingData>(
+ context, holder, static_cast<InternalFieldInfo*>(info));
}
void BindingData::MemoryInfo(MemoryTracker* tracker) const {
diff --git a/src/node_snapshotable.h b/src/node_snapshotable.h
index a9050877a04..95efa51b527 100644
--- a/src/node_snapshotable.h
+++ b/src/node_snapshotable.h
@@ -8,6 +8,8 @@
#include "base_object.h"
#include "util.h"
+#include <utility>
+
namespace node {
class Environment;
@@ -140,6 +142,15 @@ void SerializeSnapshotableObjects(Realm* realm,
#define DCHECK_IS_SNAPSHOT_SLOT(index) DCHECK_EQ(index, BaseObject::kSlot)
+// Implements SnapshotableObject::Serialize() for objects that allocate their
+// InternalFieldInfo in PrepareForSerialization(): ownership of `*info` is
+// handed over to the caller and the field is reset.
+template <typename Info>
+InternalFieldInfoBase* TakeInternalFieldInfo(int index, Info** info) {
+ DCHECK_IS_SNAPSHOT_SLOT(index);
+ return std::exchange(*info, nullptr);
+}
+
namespace mksnapshot {
class BindingData : public SnapshotableObject {
public:
diff --git a/src/node_url.cc b/src/node_url.cc
index 0c5c9e65136..d8a710b7427 100644
--- a/src/node_url.cc
+++ b/src/node_url.cc
@@ -97,9 +97,7 @@ bool BindingData::PrepareForSerialization(Local<Context> context,
InternalFieldInfoBase* BindingData::Serialize(int index) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- InternalFieldInfo* info =
- InternalFieldInfoBase::New<InternalFieldInfo>(type());
- return info;
+ return InternalFieldInfoBase::New<InternalFieldInfo>(type());
}
void BindingData::Deserialize(Local<Context> context,
@@ -107,10 +105,7 @@ void BindingData::Deserialize(Local<Context> context,
int index,
InternalFieldInfoBase* info) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- HandleScope scope(Isolate::GetCurrent());
- Realm* realm = Realm::GetCurrent(context);
- BindingData* binding = realm->AddBindingData<BindingData>(holder);
- CHECK_NOT_NULL(binding);
+ Realm::DeserializeBindingData<BindingData>(context, holder);
}
#ifndef LARGEST_ASCII_CHAR_CODE_TO_ENCODE
diff --git a/src/node_v8.cc b/src/node_v8.cc
index 40845e1d79d..df916deae98 100644
--- a/src/node_v8.cc
+++ b/src/node_v8.cc
@@ -166,20 +166,12 @@ void BindingData::Deserialize(Local<Context> context,
int index,
InternalFieldInfoBase* info) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- HandleScope scope(Isolate::GetCurrent());
- Realm* realm = Realm::GetCurrent(context);
- // Recreate the buffer in the constructor.
- InternalFieldInfo* casted_info = static_cast<InternalFieldInfo*>(info);
- BindingData* binding =
- realm->AddBindingData<BindingData>(holder, casted_info);
- CHECK_NOT_NULL(binding);
+ Realm::DeserializeBindingData<BindingData>(
+ context, holder, static_cast<InternalFieldInfo*>(info));
}
InternalFieldInfoBase* BindingData::Serialize(int index) {
- DCHECK_IS_SNAPSHOT_SLOT(index);
- InternalFieldInfo* info = internal_field_info_;
- internal_field_info_ = nullptr;
- return info;
+ return TakeInternalFieldInfo(index, &internal_field_info_);
}
void BindingData::MemoryInfo(MemoryTracker* tracker) const {
diff --git a/src/timers.cc b/src/timers.cc
index 03f0910926f..055597ecb9e 100644
--- a/src/timers.cc
+++ b/src/timers.cc
@@ -104,9 +104,7 @@ bool BindingData::PrepareForSerialization(Local<Context> context,
InternalFieldInfoBase* BindingData::Serialize(int index) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- InternalFieldInfo* info =
- InternalFieldInfoBase::New<InternalFieldInfo>(type());
- return info;
+ return InternalFieldInfoBase::New<InternalFieldInfo>(type());
}
void BindingData::Deserialize(Local<Context> context,
@@ -114,11 +112,7 @@ void BindingData::Deserialize(Local<Context> context,
int index,
InternalFieldInfoBase* info) {
DCHECK_IS_SNAPSHOT_SLOT(index);
- v8::HandleScope scope(Isolate::GetCurrent());
- Realm* realm = Realm::GetCurrent(context);
- // Recreate the buffer in the constructor.
- BindingData* binding = realm->AddBindingData<BindingData>(holder);
- CHECK_NOT_NULL(binding);
+ Realm::DeserializeBindingData<BindingData>(context, holder);
}
v8::CFunction BindingData::fast_get_libuv_now_(