src: make `CompiledFnEntry` a `BaseObject` · nodejs/node@c0f24be · GitHub
Skip to content

Commit c0f24be

Browse files
addaleaxtargos
addaleax
authored and
targos
committed
src: make CompiledFnEntry a BaseObject
In particular: - Move the class definition to the relevant header file, i.e. `node_contextify.h`. - Make sure that class instances are destroyed on `Environment` teardown. - Make instances of the key object traceable in heap dumps. This is particularly relevant here because our C++ script → map key mapping could introduce memory leaks when the import function metadata refers back to the script in some way. Refs: #28671 PR-URL: #28782 Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Rich Trott <rtrott@gmail.com>
1 parent 7b4638c commit c0f24be

5 files changed

Lines changed: 60 additions & 34 deletions

File tree

‎src/env.cc‎

Lines changed: 0 additions & 20 deletions

‎src/env.h‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ namespace node {
5555

5656
namespace contextify {
5757
class ContextifyScript;
58+
class CompiledFnEntry;
5859
}
5960

6061
namespace fs {
@@ -355,6 +356,7 @@ constexpr size_t kFsStatsBufferLength = kFsStatsFieldsNumber * 2;
355356
V(as_callback_data_template, v8::FunctionTemplate) \
356357
V(async_wrap_ctor_template, v8::FunctionTemplate) \
357358
V(async_wrap_object_ctor_template, v8::FunctionTemplate) \
359+
V(compiled_fn_entry_template, v8::ObjectTemplate) \
358360
V(fd_constructor_template, v8::ObjectTemplate) \
359361
V(fdclose_constructor_template, v8::ObjectTemplate) \
360362
V(filehandlereadwrap_template, v8::ObjectTemplate) \
@@ -501,16 +503,6 @@ struct ContextInfo {
501503
bool is_default = false;
502504
};
503505

504-
struct CompiledFnEntry {
505-
Environment* env;
506-
uint32_t id;
507-
v8::Global<v8::Object> cache_key;
508-
v8::Global<v8::ScriptOrModule> script;
509-
CompiledFnEntry(Environment* env,
510-
uint32_t id,
511-
v8::Local<v8::ScriptOrModule> script);
512-
};
513-
514506
// Listing the AsyncWrap provider types first enables us to cast directly
515507
// from a provider type to a debug category.
516508
#define DEBUG_CATEGORY_NAMES(V) \
@@ -995,7 +987,7 @@ class Environment : public MemoryRetainer {
995987
std::unordered_map<uint32_t, loader::ModuleWrap*> id_to_module_map;
996988
std::unordered_map<uint32_t, contextify::ContextifyScript*>
997989
id_to_script_map;
998-
std::unordered_map<uint32_t, CompiledFnEntry*> id_to_function_map;
990+
std::unordered_map<uint32_t, contextify::CompiledFnEntry*> id_to_function_map;
999991

1000992
inline uint32_t get_next_module_id();
1001993
inline uint32_t get_next_script_id();

‎src/module_wrap.cc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1041,7 +1041,9 @@ static MaybeLocal<Promise> ImportModuleDynamically(
10411041
ModuleWrap* wrap = ModuleWrap::GetFromID(env, id);
10421042
object = wrap->object();
10431043
} else if (type == ScriptType::kFunction) {
1044-
object = env->id_to_function_map.find(id)->second->cache_key.Get(iso);
1044+
auto it = env->id_to_function_map.find(id);
1045+
CHECK_NE(it, env->id_to_function_map.end());
1046+
object = it->second->object();
10451047
} else {
10461048
UNREACHABLE();
10471049
}

‎src/node_contextify.cc‎

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1124,9 +1124,13 @@ void ContextifyContext::CompileFunction(
11241124
}
11251125
Local<Function> fn = maybe_fn.ToLocalChecked();
11261126

1127-
CompiledFnEntry* entry = new CompiledFnEntry(env, id, script);
1127+
Local<Object> cache_key;
1128+
if (!env->compiled_fn_entry_template()->NewInstance(
1129+
context).ToLocal(&cache_key)) {
1130+
return;
1131+
}
1132+
CompiledFnEntry* entry = new CompiledFnEntry(env, cache_key, id, script);
11281133
env->id_to_function_map.emplace(id, entry);
1129-
Local<Object> cache_key = entry->cache_key.Get(isolate);
11301134

11311135
Local<Object> result = Object::New(isolate);
11321136
if (result->Set(parsing_context, env->function_string(), fn).IsNothing())
@@ -1162,6 +1166,27 @@ void ContextifyContext::CompileFunction(
11621166
args.GetReturnValue().Set(result);
11631167
}
11641168

1169+
void CompiledFnEntry::WeakCallback(
1170+
const WeakCallbackInfo<CompiledFnEntry>& data) {
1171+
CompiledFnEntry* entry = data.GetParameter();
1172+
delete entry;
1173+
}
1174+
1175+
CompiledFnEntry::CompiledFnEntry(Environment* env,
1176+
Local<Object> object,
1177+
uint32_t id,
1178+
Local<ScriptOrModule> script)
1179+
: BaseObject(env, object),
1180+
id_(id),
1181+
script_(env->isolate(), script) {
1182+
script_.SetWeak(this, WeakCallback, v8::WeakCallbackType::kParameter);
1183+
}
1184+
1185+
CompiledFnEntry::~CompiledFnEntry() {
1186+
env()->id_to_function_map.erase(id_);
1187+
script_.ClearWeak();
1188+
}
1189+
11651190
static void StartSigintWatchdog(const FunctionCallbackInfo<Value>& args) {
11661191
int ret = SigintWatchdogHelper::GetInstance()->Start();
11671192
args.GetReturnValue().Set(ret == 0);
@@ -1190,6 +1215,14 @@ void Initialize(Local<Object> target,
11901215
// Used in tests.
11911216
env->SetMethodNoSideEffect(
11921217
target, "watchdogHasPendingSigint", WatchdogHasPendingSigint);
1218+
1219+
{
1220+
Local<FunctionTemplate> tpl = FunctionTemplate::New(env->isolate());
1221+
tpl->SetClassName(FIXED_ONE_BYTE_STRING(env->isolate(), "CompiledFnEntry"));
1222+
tpl->InstanceTemplate()->SetInternalFieldCount(1);
1223+
1224+
env->set_compiled_fn_entry_template(tpl->InstanceTemplate());
1225+
}
11931226
}
11941227

11951228
} // namespace contextify

‎src/node_contextify.h‎

Lines changed: 19 additions & 0 deletions

0 commit comments

Comments
 (0)