Skip to content

fix!: re-create CPU profiler each time a CPU profile is collected to work around V8 CPU profiler memory leak. #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nolanmar511 merged 2 commits into from
Oct 29, 2020
+33 −2
Merged

fix!: re-create CPU profiler each time a CPU profile is collected to work around V8 CPU profiler memory leak. #142

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c345c2
work around V8 memory leak
nolanmar511 Oct 22, 2020
9612cc8
address comments
nolanmar511 Oct 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 33 additions & 2 deletions bindings/profiler.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,14 @@ NAN_METHOD(GetAllocationProfile) {
}

// Time profiler

#if NODE_MODULE_VERSION > NODE_8_0_MODULE_VERSION
#if NODE_MODULE_VERSION >= NODE_12_0_MODULE_VERSION
// For Node 12 and Node 14, a new CPU profiler object will be created each
// time profiling is started to work around
// https://bugs.chromium.org/p/v8/issues/detail?id=11051.
CpuProfiler* cpuProfiler;
// Default sampling interval is 1000us.
int samplingIntervalUS = 1000;
#elif NODE_MODULE_VERSION > NODE_8_0_MODULE_VERSION
// This profiler exists for the lifetime of the program. Not calling
// CpuProfiler::Dispose() is intentional.
CpuProfiler* cpuProfiler = CpuProfiler::New(v8::Isolate::GetCurrent());
Expand Down Expand Up @@ -264,6 +270,17 @@ NAN_METHOD(StartProfiling) {
return Nan::ThrowTypeError("Second argument must be a boolean.");
}

#if NODE_MODULE_VERSION >= NODE_12_0_MODULE_VERSION
// Since the CPU profiler is created and destroyed each time a CPU
// profile is collected, there cannot be multiple CPU profiling requests
// inflight in parallel.
if (cpuProfiler) {
return Nan::ThrowError("CPU profiler is already started.");
}
cpuProfiler = CpuProfiler::New(v8::Isolate::GetCurrent());
cpuProfiler->SetSamplingInterval(samplingIntervalUS);
#endif

Local<String> name =
Nan::MaybeLocal<String>(info[0].As<String>()).ToLocalChecked();

Expand All @@ -289,6 +306,11 @@ NAN_METHOD(StartProfiling) {
// Signature:
// stopProfiling(runName: string, includeLineInfo: boolean): TimeProfile
NAN_METHOD(StopProfiling) {
#if NODE_MODULE_VERSION >= NODE_12_0_MODULE_VERSION
if (!cpuProfiler) {
return Nan::ThrowError("StopProfiling called without an active CPU profiler.");
}
#endif
if (info.Length() != 2) {
return Nan::ThrowTypeError("StopProfling must have two arguments.");
}
Expand All @@ -307,6 +329,11 @@ NAN_METHOD(StopProfiling) {
Local<Value> translated_profile =
TranslateTimeProfile(profile, includeLineInfo);
profile->Delete();
#if NODE_MODULE_VERSION >= NODE_12_0_MODULE_VERSION
// Dispose of CPU profiler to work around memory leak.
cpuProfiler->Dispose();
cpuProfiler = NULL;
#endif
info.GetReturnValue().Set(translated_profile);
}

Expand All @@ -318,7 +345,11 @@ NAN_METHOD(SetSamplingInterval) {
#else
int us = info[0].As<Integer>()->IntegerValue();
#endif
#if NODE_MODULE_VERSION >= NODE_12_0_MODULE_VERSION
samplingIntervalUS = us;
#else
cpuProfiler->SetSamplingInterval(us);
#endif
}

NAN_MODULE_INIT(InitAll) {
Expand Down