Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	inspector_profiler.cc	Lines:	252	284	88.7 %
Date:	2022-09-19 04:21:54	Branches:	74	112	66.1 %


#include "inspector_profiler.h"
#include "base_object-inl.h"
#include "debug_utils-inl.h"
#include "diagnosticfilename-inl.h"
#include "memory_tracker-inl.h"
#include "node_errors.h"
#include "node_external_reference.h"
#include "node_file.h"
#include "node_internals.h"
#include "util-inl.h"
#include "v8-inspector.h"

#include <cinttypes>
#include <sstream>

namespace node {
namespace profiler {

using errors::TryCatchScope;
using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::HandleScope;
using v8::Isolate;
using v8::Local;
using v8::MaybeLocal;
using v8::NewStringType;
using v8::Object;
using v8::String;
using v8::Value;

using v8_inspector::StringView;

V8ProfilerConnection::V8ProfilerConnection(Environment* env)
    : session_(env->inspector_agent()->Connect(
          std::make_unique<V8ProfilerConnection::V8ProfilerSessionDelegate>(
              this),
          false)),
      env_(env) {}

uint32_t V8ProfilerConnection::DispatchMessage(const char* method,
                                               const char* params,
                                               bool is_profile_request) {
  std::stringstream ss;
  uint32_t id = next_id();
  ss << R"({ "id": )" << id;
  DCHECK(method != nullptr);
  ss << R"(, "method": ")" << method << '"';
  if (params != nullptr) {
    ss << R"(, "params": )" << params;
  }
  ss << " }";
  std::string message = ss.str();
  const uint8_t* message_data =
      reinterpret_cast<const uint8_t*>(message.c_str());
  // Save the id of the profile request to identify its response.
  if (is_profile_request) {
    profile_ids_.insert(id);
  }
  Debug(env(),
        DebugCategory::INSPECTOR_PROFILER,
        "Dispatching message %s\n",
        message.c_str());
  session_->Dispatch(StringView(message_data, message.length()));
  return id;
}

static void WriteResult(Environment* env,
                        const char* path,
                        Local<String> result) {
  int ret = WriteFileSync(env->isolate(), path, result);
  if (ret != 0) {
    char err_buf[128];
    uv_err_name_r(ret, err_buf, sizeof(err_buf));
    fprintf(stderr, "%s: Failed to write file %s\n", err_buf, path);
    return;
  }
  Debug(env, DebugCategory::INSPECTOR_PROFILER, "Written result to %s\n", path);
}

void V8ProfilerConnection::V8ProfilerSessionDelegate::SendMessageToFrontend(
    const v8_inspector::StringView& message) {
  Environment* env = connection_->env();
  Isolate* isolate = env->isolate();
  HandleScope handle_scope(isolate);
  Local<Context> context = env->context();
  Context::Scope context_scope(context);

  const char* type = connection_->type();
  // Convert StringView to a Local<String>.
  Local<String> message_str;
  if (!String::NewFromTwoByte(isolate,
                              message.characters16(),
                              NewStringType::kNormal,
                              message.length())
           .ToLocal(&message_str)) {
    fprintf(
        stderr, "Failed to convert %s profile message to V8 string\n", type);
    return;
  }

  Debug(env,
        DebugCategory::INSPECTOR_PROFILER,
        "Receive %s profile message\n",
        type);

  Local<Value> parsed;
  if (!v8::JSON::Parse(context, message_str).ToLocal(&parsed) ||
      !parsed->IsObject()) {
    fprintf(stderr, "Failed to parse %s profile result as JSON object\n", type);
    return;
  }

  Local<Object> response = parsed.As<Object>();
  Local<Value> id_v;
  if (!response->Get(context, FIXED_ONE_BYTE_STRING(isolate, "id"))
           .ToLocal(&id_v) ||
      !id_v->IsUint32()) {
    Utf8Value str(isolate, message_str);
    fprintf(
        stderr, "Cannot retrieve id from the response message:\n%s\n", *str);
    return;
  }
  uint32_t id = id_v.As<v8::Uint32>()->Value();

  if (!connection_->HasProfileId(id)) {
    Utf8Value str(isolate, message_str);
    Debug(env, DebugCategory::INSPECTOR_PROFILER, "%s\n", *str);
    return;
  } else {
    Debug(env,
          DebugCategory::INSPECTOR_PROFILER,
          "Writing profile response (id = %" PRIu64 ")\n",
          static_cast<uint64_t>(id));
  }

  // Get message.result from the response.
  Local<Value> result_v;
  if (!response->Get(context, FIXED_ONE_BYTE_STRING(isolate, "result"))
           .ToLocal(&result_v)) {
    fprintf(stderr, "Failed to get 'result' from %s profile response\n", type);
    return;
  }

  if (!result_v->IsObject()) {
    fprintf(
        stderr, "'result' from %s profile response is not an object\n", type);
    return;
  }

  connection_->WriteProfile(result_v.As<Object>());
  connection_->RemoveProfileId(id);
}

static bool EnsureDirectory(const std::string& directory, const char* type) {
  fs::FSReqWrapSync req_wrap_sync;
  int ret = fs::MKDirpSync(nullptr, &req_wrap_sync.req, directory, 0777,
                           nullptr);
  if (ret < 0 && ret != UV_EEXIST) {
    char err_buf[128];
    uv_err_name_r(ret, err_buf, sizeof(err_buf));
    fprintf(stderr,
            "%s: Failed to create %s profile directory %s\n",
            err_buf,
            type,
            directory.c_str());
    return false;
  }
  return true;
}

std::string V8CoverageConnection::GetFilename() const {
  uint64_t timestamp =
      static_cast<uint64_t>(GetCurrentTimeInMicroseconds() / 1000);
  return SPrintF("coverage-%s-%s-%s.json",
      uv_os_getpid(),
      timestamp,
      env()->thread_id());
}

void V8ProfilerConnection::WriteProfile(Local<Object> result) {
  Local<Context> context = env_->context();

  // Generate the profile output from the subclass.
  Local<Object> profile;
  if (!GetProfile(result).ToLocal(&profile)) {
    return;
  }

  Local<String> result_s;
  if (!v8::JSON::Stringify(context, profile).ToLocal(&result_s)) {
    fprintf(stderr, "Failed to stringify %s profile result\n", type());
    return;
  }

  // Create the directory if necessary.
  std::string directory = GetDirectory();
  DCHECK(!directory.empty());
  if (!EnsureDirectory(directory, type())) {
    return;
  }

  std::string filename = GetFilename();
  DCHECK(!filename.empty());
  std::string path = directory + kPathSeparator + filename;

  WriteResult(env_, path.c_str(), result_s);
}

void V8CoverageConnection::WriteProfile(Local<Object> result) {
  Isolate* isolate = env_->isolate();
  Local<Context> context = env_->context();
  HandleScope handle_scope(isolate);
  Context::Scope context_scope(context);

  // This is only set up during pre-execution (when the environment variables
  // becomes available in the JS land). If it's empty, we don't have coverage
  // directory path (which is resolved in JS land at the moment) either, so
  // the best we could to is to just discard the profile and do nothing.
  // This should only happen in half-baked Environments created using the
  // embedder API.
  if (env_->source_map_cache_getter().IsEmpty()) {
    return;
  }

  // Generate the profile output from the subclass.
  Local<Object> profile;
  if (!GetProfile(result).ToLocal(&profile)) {
    return;
  }

  // append source-map cache information to coverage object:
  Local<Value> source_map_cache_v;
  {
    TryCatchScope try_catch(env());
    {
      Isolate::AllowJavascriptExecutionScope allow_js_here(isolate);
      Local<Function> source_map_cache_getter = env_->source_map_cache_getter();
      if (!source_map_cache_getter->Call(
              context, Undefined(isolate), 0, nullptr)
              .ToLocal(&source_map_cache_v)) {
        return;
      }
    }
    if (try_catch.HasCaught() && !try_catch.HasTerminated()) {
      PrintCaughtException(isolate, context, try_catch);
    }
  }
  // Avoid writing to disk if no source-map data:
  if (!source_map_cache_v->IsUndefined()) {
    profile->Set(context, FIXED_ONE_BYTE_STRING(isolate, "source-map-cache"),
                source_map_cache_v).ToChecked();
  }

  Local<String> result_s;
  if (!v8::JSON::Stringify(context, profile).ToLocal(&result_s)) {
    fprintf(stderr, "Failed to stringify %s profile result\n", type());
    return;
  }

  // Create the directory if necessary.
  std::string directory = GetDirectory();
  DCHECK(!directory.empty());
  if (!EnsureDirectory(directory, type())) {
    return;
  }

  std::string filename = GetFilename();
  DCHECK(!filename.empty());
  std::string path = directory + kPathSeparator + filename;

  WriteResult(env_, path.c_str(), result_s);
}

MaybeLocal<Object> V8CoverageConnection::GetProfile(Local<Object> result) {
  return result;
}

std::string V8CoverageConnection::GetDirectory() const {
  return env()->coverage_directory();
}

void V8CoverageConnection::Start() {
  DispatchMessage("Profiler.enable");
  DispatchMessage("Profiler.startPreciseCoverage",
                  R"({ "callCount": true, "detailed": true })");
}

void V8CoverageConnection::TakeCoverage() {
  DispatchMessage("Profiler.takePreciseCoverage", nullptr, true);
}

void V8CoverageConnection::StopCoverage() {
  DispatchMessage("Profiler.stopPreciseCoverage");
}

void V8CoverageConnection::End() {
  Debug(env_,
      DebugCategory::INSPECTOR_PROFILER,
      "V8CoverageConnection::End(), ending = %d\n", ending_);
  if (ending_) {
    return;
  }
  ending_ = true;
  TakeCoverage();
}

std::string V8CpuProfilerConnection::GetDirectory() const {
  return env()->cpu_prof_dir();
}

std::string V8CpuProfilerConnection::GetFilename() const {
  return env()->cpu_prof_name();
}

MaybeLocal<Object> V8CpuProfilerConnection::GetProfile(Local<Object> result) {
  Local<Value> profile_v;
  if (!result
           ->Get(env()->context(),
                 FIXED_ONE_BYTE_STRING(env()->isolate(), "profile"))
           .ToLocal(&profile_v)) {
    fprintf(stderr, "'profile' from CPU profile result is undefined\n");
    return MaybeLocal<Object>();
  }
  if (!profile_v->IsObject()) {
    fprintf(stderr, "'profile' from CPU profile result is not an Object\n");
    return MaybeLocal<Object>();
  }
  return profile_v.As<Object>();
}

void V8CpuProfilerConnection::Start() {
  DispatchMessage("Profiler.enable");
  std::string params = R"({ "interval": )";
  params += std::to_string(env()->cpu_prof_interval());
  params += " }";
  DispatchMessage("Profiler.setSamplingInterval", params.c_str());
  DispatchMessage("Profiler.start");
}

void V8CpuProfilerConnection::End() {
  Debug(env_,
      DebugCategory::INSPECTOR_PROFILER,
      "V8CpuProfilerConnection::End(), ending = %d\n", ending_);
  if (ending_) {
    return;
  }
  ending_ = true;
  DispatchMessage("Profiler.stop", nullptr, true);
}

std::string V8HeapProfilerConnection::GetDirectory() const {
  return env()->heap_prof_dir();
}

std::string V8HeapProfilerConnection::GetFilename() const {
  return env()->heap_prof_name();
}

MaybeLocal<Object> V8HeapProfilerConnection::GetProfile(Local<Object> result) {
  Local<Value> profile_v;
  if (!result
           ->Get(env()->context(),
                 FIXED_ONE_BYTE_STRING(env()->isolate(), "profile"))
           .ToLocal(&profile_v)) {
    fprintf(stderr, "'profile' from heap profile result is undefined\n");
    return MaybeLocal<Object>();
  }
  if (!profile_v->IsObject()) {
    fprintf(stderr, "'profile' from heap profile result is not an Object\n");
    return MaybeLocal<Object>();
  }
  return profile_v.As<Object>();
}

void V8HeapProfilerConnection::Start() {
  DispatchMessage("HeapProfiler.enable");
  std::string params = R"({ "samplingInterval": )";
  params += std::to_string(env()->heap_prof_interval());
  params += " }";
  DispatchMessage("HeapProfiler.startSampling", params.c_str());
}

void V8HeapProfilerConnection::End() {
  Debug(env_,
      DebugCategory::INSPECTOR_PROFILER,
      "V8HeapProfilerConnection::End(), ending = %d\n", ending_);
  if (ending_) {
    return;
  }
  ending_ = true;
  DispatchMessage("HeapProfiler.stopSampling", nullptr, true);
}

// For now, we only support coverage profiling, but we may add more
// in the future.
static void EndStartedProfilers(Environment* env) {
  // TODO(joyeechueng): merge these connections and use one session per env.
  Debug(env, DebugCategory::INSPECTOR_PROFILER, "EndStartedProfilers\n");
  V8ProfilerConnection* connection = env->cpu_profiler_connection();
  if (connection != nullptr) {
    connection->End();
  }

  connection = env->heap_profiler_connection();
  if (connection != nullptr) {
    connection->End();
  }

  connection = env->coverage_connection();
  if (connection != nullptr) {
    connection->End();
  }
}

void StartProfilers(Environment* env) {
  AtExit(env, [](void* env) {
    EndStartedProfilers(static_cast<Environment*>(env));
  }, env);

  Isolate* isolate = env->isolate();
  Local<String> coverage_str = env->env_vars()->Get(
      isolate, FIXED_ONE_BYTE_STRING(isolate, "NODE_V8_COVERAGE"))
      .FromMaybe(Local<String>());
  if (!coverage_str.IsEmpty() && coverage_str->Length() > 0) {
    CHECK_NULL(env->coverage_connection());
    env->set_coverage_connection(std::make_unique<V8CoverageConnection>(env));
    env->coverage_connection()->Start();
  }
  if (env->options()->cpu_prof) {
    const std::string& dir = env->options()->cpu_prof_dir;
    env->set_cpu_prof_interval(env->options()->cpu_prof_interval);
    env->set_cpu_prof_dir(dir.empty() ? env->GetCwd() : dir);
    if (env->options()->cpu_prof_name.empty()) {
      DiagnosticFilename filename(env, "CPU", "cpuprofile");
      env->set_cpu_prof_name(*filename);
    } else {
      env->set_cpu_prof_name(env->options()->cpu_prof_name);
    }
    CHECK_NULL(env->cpu_profiler_connection());
    env->set_cpu_profiler_connection(
        std::make_unique<V8CpuProfilerConnection>(env));
    env->cpu_profiler_connection()->Start();
  }
  if (env->options()->heap_prof) {
    const std::string& dir = env->options()->heap_prof_dir;
    env->set_heap_prof_interval(env->options()->heap_prof_interval);
    env->set_heap_prof_dir(dir.empty() ? env->GetCwd() : dir);
    if (env->options()->heap_prof_name.empty()) {
      DiagnosticFilename filename(env, "Heap", "heapprofile");
      env->set_heap_prof_name(*filename);
    } else {
      env->set_heap_prof_name(env->options()->heap_prof_name);
    }
    env->set_heap_profiler_connection(
        std::make_unique<profiler::V8HeapProfilerConnection>(env));
    env->heap_profiler_connection()->Start();
  }
}

static void SetCoverageDirectory(const FunctionCallbackInfo<Value>& args) {
  CHECK(args[0]->IsString());
  Environment* env = Environment::GetCurrent(args);
  node::Utf8Value directory(env->isolate(), args[0].As<String>());
  env->set_coverage_directory(*directory);
}


static void SetSourceMapCacheGetter(const FunctionCallbackInfo<Value>& args) {
  CHECK(args[0]->IsFunction());
  Environment* env = Environment::GetCurrent(args);
  env->set_source_map_cache_getter(args[0].As<Function>());
}

static void TakeCoverage(const FunctionCallbackInfo<Value>& args) {
  Environment* env = Environment::GetCurrent(args);
  V8CoverageConnection* connection = env->coverage_connection();

  Debug(
    env,
    DebugCategory::INSPECTOR_PROFILER,
    "TakeCoverage, connection %s nullptr\n",
    connection == nullptr ? "==" : "!=");

  if (connection != nullptr) {
    Debug(env, DebugCategory::INSPECTOR_PROFILER, "taking coverage\n");
    connection->TakeCoverage();
  }
}

static void StopCoverage(const FunctionCallbackInfo<Value>& args) {
  Environment* env = Environment::GetCurrent(args);
  V8CoverageConnection* connection = env->coverage_connection();

  Debug(env,
        DebugCategory::INSPECTOR_PROFILER,
        "StopCoverage, connection %s nullptr\n",
        connection == nullptr ? "==" : "!=");

  if (connection != nullptr) {
    Debug(env, DebugCategory::INSPECTOR_PROFILER, "Stopping coverage\n");
    connection->StopCoverage();
  }
}

static void Initialize(Local<Object> target,
                       Local<Value> unused,
                       Local<Context> context,
                       void* priv) {
  SetMethod(context, target, "setCoverageDirectory", SetCoverageDirectory);
  SetMethod(
      context, target, "setSourceMapCacheGetter", SetSourceMapCacheGetter);
  SetMethod(context, target, "takeCoverage", TakeCoverage);
  SetMethod(context, target, "stopCoverage", StopCoverage);
}

void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
  registry->Register(SetCoverageDirectory);
  registry->Register(SetSourceMapCacheGetter);
  registry->Register(TakeCoverage);
  registry->Register(StopCoverage);
}

}  // namespace profiler
}  // namespace node

NODE_MODULE_CONTEXT_AWARE_INTERNAL(profiler, node::profiler::Initialize)
NODE_MODULE_EXTERNAL_REFERENCE(profiler,
                               node::profiler::RegisterExternalReferences)


Generated by: GCOVR (Version 4.2)

Line	Branch	Exec	Source
1			#include "inspector_profiler.h"
2			#include "base_object-inl.h"
3			#include "debug_utils-inl.h"
4			#include "diagnosticfilename-inl.h"
5			#include "memory_tracker-inl.h"
6			#include "node_errors.h"
7			#include "node_external_reference.h"
8			#include "node_file.h"
9			#include "node_internals.h"
10			#include "util-inl.h"
11			#include "v8-inspector.h"
12
13			#include <cinttypes>
14			#include <sstream>
15
16			namespace node {
17			namespace profiler {
18
19			using errors::TryCatchScope;
20			using v8::Context;
21			using v8::Function;
22			using v8::FunctionCallbackInfo;
23			using v8::HandleScope;
24			using v8::Isolate;
25			using v8::Local;
26			using v8::MaybeLocal;
27			using v8::NewStringType;
28			using v8::Object;
29			using v8::String;
30			using v8::Value;
31
32			using v8_inspector::StringView;
33
34		6318	V8ProfilerConnection::V8ProfilerConnection(Environment* env)
35			: session_(env->inspector_agent()->Connect(
36		6318	std::make_unique<V8ProfilerConnection::V8ProfilerSessionDelegate>(
37			this),
38			false)),
39		12636	env_(env) {}
40
41		18959	uint32_t V8ProfilerConnection::DispatchMessage(const char* method,
42			const char* params,
43			bool is_profile_request) {
44		37918	std::stringstream ss;
45		18959	uint32_t id = next_id();
46		18959	ss << R"({ "id": )" << id;
47			DCHECK(method != nullptr);
48		18959	ss << R"(, "method": ")" << method << '"';
49	✓✓	18959	if (params != nullptr) {
50		6318	ss << R"(, "params": )" << params;
51			}
52		18959	ss << " }";
53		18959	std::string message = ss.str();
54			const uint8_t* message_data =
55		18959	reinterpret_cast<const uint8_t*>(message.c_str());
56			// Save the id of the profile request to identify its response.
57	✓✓	18959	if (is_profile_request) {
58		6310	profile_ids_.insert(id);
59			}
60		18959	Debug(env(),
61			DebugCategory::INSPECTOR_PROFILER,
62			"Dispatching message %s\n",
63		18959	message.c_str());
64		18959	session_->Dispatch(StringView(message_data, message.length()));
65		18959	return id;
66			}
67
68		6275	static void WriteResult(Environment* env,
69			const char* path,
70			Local<String> result) {
71		6275	int ret = WriteFileSync(env->isolate(), path, result);
72	✓✓	6275	if (ret != 0) {
73			char err_buf[128];
74		9	uv_err_name_r(ret, err_buf, sizeof(err_buf));
75		9	fprintf(stderr, "%s: Failed to write file %s\n", err_buf, path);
76		9	return;
77			}
78			Debug(env, DebugCategory::INSPECTOR_PROFILER, "Written result to %s\n", path);
79			}
80
81		18959	void V8ProfilerConnection::V8ProfilerSessionDelegate::SendMessageToFrontend(
82			const v8_inspector::StringView& message) {
83		18959	Environment* env = connection_->env();
84		18959	Isolate* isolate = env->isolate();
85		18959	HandleScope handle_scope(isolate);
86		18959	Local<Context> context = env->context();
87		18959	Context::Scope context_scope(context);
88
89		18959	const char* type = connection_->type();
90			// Convert StringView to a Local<String>.
91			Local<String> message_str;
92		18959	if (!String::NewFromTwoByte(isolate,
93			message.characters16(),
94			NewStringType::kNormal,
95		18959	message.length())
96	✗✓	18959	.ToLocal(&message_str)) {
97			fprintf(
98			stderr, "Failed to convert %s profile message to V8 string\n", type);
99			return;
100			}
101
102			Debug(env,
103			DebugCategory::INSPECTOR_PROFILER,
104			"Receive %s profile message\n",
105			type);
106
107			Local<Value> parsed;
108	✓✗✗✓	56877	if (!v8::JSON::Parse(context, message_str).ToLocal(&parsed) \|\|
109	✗✓	18959	!parsed->IsObject()) {
110			fprintf(stderr, "Failed to parse %s profile result as JSON object\n", type);
111			return;
112			}
113
114		18959	Local<Object> response = parsed.As<Object>();
115			Local<Value> id_v;
116		37918	if (!response->Get(context, FIXED_ONE_BYTE_STRING(isolate, "id"))
117	✓✗✗✓	37918	.ToLocal(&id_v) \|\|
118	✗✓	18959	!id_v->IsUint32()) {
119			Utf8Value str(isolate, message_str);
120			fprintf(
121			stderr, "Cannot retrieve id from the response message:\n%s\n", *str);
122			return;
123			}
124		18959	uint32_t id = id_v.As<v8::Uint32>()->Value();
125
126	✓✓	18959	if (!connection_->HasProfileId(id)) {
127		12649	Utf8Value str(isolate, message_str);
128		12649	Debug(env, DebugCategory::INSPECTOR_PROFILER, "%s\n", *str);
129		12649	return;
130			} else {
131			Debug(env,
132			DebugCategory::INSPECTOR_PROFILER,
133			"Writing profile response (id = %" PRIu64 ")\n",
134		12620	static_cast<uint64_t>(id));
135			}
136
137			// Get message.result from the response.
138			Local<Value> result_v;
139		12620	if (!response->Get(context, FIXED_ONE_BYTE_STRING(isolate, "result"))
140	✗✓	6310	.ToLocal(&result_v)) {
141			fprintf(stderr, "Failed to get 'result' from %s profile response\n", type);
142			return;
143			}
144
145	✓✓	6310	if (!result_v->IsObject()) {
146		3	fprintf(
147			stderr, "'result' from %s profile response is not an object\n", type);
148		3	return;
149			}
150
151		12614	connection_->WriteProfile(result_v.As<Object>());
152		6307	connection_->RemoveProfileId(id);
153			}
154
155		6275	static bool EnsureDirectory(const std::string& directory, const char* type) {
156		12550	fs::FSReqWrapSync req_wrap_sync;
157		6275	int ret = fs::MKDirpSync(nullptr, &req_wrap_sync.req, directory, 0777,
158			nullptr);
159	✗✓✗✗	6275	if (ret < 0 && ret != UV_EEXIST) {
160			char err_buf[128];
161			uv_err_name_r(ret, err_buf, sizeof(err_buf));
162			fprintf(stderr,
163			"%s: Failed to create %s profile directory %s\n",
164			err_buf,
165			type,
166			directory.c_str());
167			return false;
168			}
169		6275	return true;
170			}
171
172		6251	std::string V8CoverageConnection::GetFilename() const {
173			uint64_t timestamp =
174		6251	static_cast<uint64_t>(GetCurrentTimeInMicroseconds() / 1000);
175			return SPrintF("coverage-%s-%s-%s.json",
176		18753	uv_os_getpid(),
177			timestamp,
178		6251	env()->thread_id());
179			}
180
181		24	void V8ProfilerConnection::WriteProfile(Local<Object> result) {
182		24	Local<Context> context = env_->context();
183
184			// Generate the profile output from the subclass.
185			Local<Object> profile;
186	✗✓	48	if (!GetProfile(result).ToLocal(&profile)) {
187			return;
188			}
189
190			Local<String> result_s;
191	✗✓	48	if (!v8::JSON::Stringify(context, profile).ToLocal(&result_s)) {
192			fprintf(stderr, "Failed to stringify %s profile result\n", type());
193			return;
194			}
195
196			// Create the directory if necessary.
197		24	std::string directory = GetDirectory();
198			DCHECK(!directory.empty());
199	✗✓	24	if (!EnsureDirectory(directory, type())) {
200			return;
201			}
202
203		48	std::string filename = GetFilename();
204			DCHECK(!filename.empty());
205		48	std::string path = directory + kPathSeparator + filename;
206
207		24	WriteResult(env_, path.c_str(), result_s);
208			}
209
210		6283	void V8CoverageConnection::WriteProfile(Local<Object> result) {
211		6283	Isolate* isolate = env_->isolate();
212		6283	Local<Context> context = env_->context();
213		6283	HandleScope handle_scope(isolate);
214		6283	Context::Scope context_scope(context);
215
216			// This is only set up during pre-execution (when the environment variables
217			// becomes available in the JS land). If it's empty, we don't have coverage
218			// directory path (which is resolved in JS land at the moment) either, so
219			// the best we could to is to just discard the profile and do nothing.
220			// This should only happen in half-baked Environments created using the
221			// embedder API.
222	✓✓	12566	if (env_->source_map_cache_getter().IsEmpty()) {
223		30	return;
224			}
225
226			// Generate the profile output from the subclass.
227			Local<Object> profile;
228	✗✓	12506	if (!GetProfile(result).ToLocal(&profile)) {
229			return;
230			}
231
232			// append source-map cache information to coverage object:
233			Local<Value> source_map_cache_v;
234			{
235		6253	TryCatchScope try_catch(env());
236			{
237		6253	Isolate::AllowJavascriptExecutionScope allow_js_here(isolate);
238		6253	Local<Function> source_map_cache_getter = env_->source_map_cache_getter();
239		12506	if (!source_map_cache_getter->Call(
240		12506	context, Undefined(isolate), 0, nullptr)
241	✓✓	6253	.ToLocal(&source_map_cache_v)) {
242		2	return;
243			}
244			}
245	✗✓✗✗ ✗✓	6251	if (try_catch.HasCaught() && !try_catch.HasTerminated()) {
246			PrintCaughtException(isolate, context, try_catch);
247			}
248			}
249			// Avoid writing to disk if no source-map data:
250	✓✓	12502	if (!source_map_cache_v->IsUndefined()) {
251		53	profile->Set(context, FIXED_ONE_BYTE_STRING(isolate, "source-map-cache"),
252		159	source_map_cache_v).ToChecked();
253			}
254
255			Local<String> result_s;
256	✗✓	12502	if (!v8::JSON::Stringify(context, profile).ToLocal(&result_s)) {
257			fprintf(stderr, "Failed to stringify %s profile result\n", type());
258			return;
259			}
260
261			// Create the directory if necessary.
262		6251	std::string directory = GetDirectory();
263			DCHECK(!directory.empty());
264	✗✓	6251	if (!EnsureDirectory(directory, type())) {
265			return;
266			}
267
268		12502	std::string filename = GetFilename();
269			DCHECK(!filename.empty());
270		12502	std::string path = directory + kPathSeparator + filename;
271
272		6251	WriteResult(env_, path.c_str(), result_s);
273			}
274
275		6253	MaybeLocal<Object> V8CoverageConnection::GetProfile(Local<Object> result) {
276		6253	return result;
277			}
278
279		6251	std::string V8CoverageConnection::GetDirectory() const {
280		6251	return env()->coverage_directory();
281			}
282
283		6294	void V8CoverageConnection::Start() {
284		6294	DispatchMessage("Profiler.enable");
285		6294	DispatchMessage("Profiler.startPreciseCoverage",
286			R"({ "callCount": true, "detailed": true })");
287		6294	}
288
289		6286	void V8CoverageConnection::TakeCoverage() {
290		6286	DispatchMessage("Profiler.takePreciseCoverage", nullptr, true);
291		6286	}
292
293		1	void V8CoverageConnection::StopCoverage() {
294		1	DispatchMessage("Profiler.stopPreciseCoverage");
295		1	}
296
297		6280	void V8CoverageConnection::End() {
298		6280	Debug(env_,
299			DebugCategory::INSPECTOR_PROFILER,
300		6280	"V8CoverageConnection::End(), ending = %d\n", ending_);
301	✗✓	6280	if (ending_) {
302			return;
303			}
304		6280	ending_ = true;
305		6280	TakeCoverage();
306			}
307
308		12	std::string V8CpuProfilerConnection::GetDirectory() const {
309		12	return env()->cpu_prof_dir();
310			}
311
312		12	std::string V8CpuProfilerConnection::GetFilename() const {
313		12	return env()->cpu_prof_name();
314			}
315
316		12	MaybeLocal<Object> V8CpuProfilerConnection::GetProfile(Local<Object> result) {
317			Local<Value> profile_v;
318		24	if (!result
319		12	->Get(env()->context(),
320		24	FIXED_ONE_BYTE_STRING(env()->isolate(), "profile"))
321	✗✓	12	.ToLocal(&profile_v)) {
322			fprintf(stderr, "'profile' from CPU profile result is undefined\n");
323			return MaybeLocal<Object>();
324			}
325	✗✓	12	if (!profile_v->IsObject()) {
326			fprintf(stderr, "'profile' from CPU profile result is not an Object\n");
327			return MaybeLocal<Object>();
328			}
329		12	return profile_v.As<Object>();
330			}
331
332		12	void V8CpuProfilerConnection::Start() {
333		12	DispatchMessage("Profiler.enable");
334		24	std::string params = R"({ "interval": )";
335		12	params += std::to_string(env()->cpu_prof_interval());
336		12	params += " }";
337		12	DispatchMessage("Profiler.setSamplingInterval", params.c_str());
338		12	DispatchMessage("Profiler.start");
339		12	}
340
341		12	void V8CpuProfilerConnection::End() {
342		12	Debug(env_,
343			DebugCategory::INSPECTOR_PROFILER,
344		12	"V8CpuProfilerConnection::End(), ending = %d\n", ending_);
345	✗✓	12	if (ending_) {
346			return;
347			}
348		12	ending_ = true;
349		12	DispatchMessage("Profiler.stop", nullptr, true);
350			}
351
352		12	std::string V8HeapProfilerConnection::GetDirectory() const {
353		12	return env()->heap_prof_dir();
354			}
355
356		12	std::string V8HeapProfilerConnection::GetFilename() const {
357		12	return env()->heap_prof_name();
358			}
359
360		12	MaybeLocal<Object> V8HeapProfilerConnection::GetProfile(Local<Object> result) {
361			Local<Value> profile_v;
362		24	if (!result
363		12	->Get(env()->context(),
364		24	FIXED_ONE_BYTE_STRING(env()->isolate(), "profile"))
365	✗✓	12	.ToLocal(&profile_v)) {
366			fprintf(stderr, "'profile' from heap profile result is undefined\n");
367			return MaybeLocal<Object>();
368			}
369	✗✓	12	if (!profile_v->IsObject()) {
370			fprintf(stderr, "'profile' from heap profile result is not an Object\n");
371			return MaybeLocal<Object>();
372			}
373		12	return profile_v.As<Object>();
374			}
375
376		12	void V8HeapProfilerConnection::Start() {
377		12	DispatchMessage("HeapProfiler.enable");
378		24	std::string params = R"({ "samplingInterval": )";
379		12	params += std::to_string(env()->heap_prof_interval());
380		12	params += " }";
381		12	DispatchMessage("HeapProfiler.startSampling", params.c_str());
382		12	}
383
384		12	void V8HeapProfilerConnection::End() {
385		12	Debug(env_,
386			DebugCategory::INSPECTOR_PROFILER,
387		12	"V8HeapProfilerConnection::End(), ending = %d\n", ending_);
388	✗✓	12	if (ending_) {
389			return;
390			}
391		12	ending_ = true;
392		12	DispatchMessage("HeapProfiler.stopSampling", nullptr, true);
393			}
394
395			// For now, we only support coverage profiling, but we may add more
396			// in the future.
397		6284	static void EndStartedProfilers(Environment* env) {
398			// TODO(joyeechueng): merge these connections and use one session per env.
399			Debug(env, DebugCategory::INSPECTOR_PROFILER, "EndStartedProfilers\n");
400		6284	V8ProfilerConnection* connection = env->cpu_profiler_connection();
401	✓✓	6284	if (connection != nullptr) {
402		12	connection->End();
403			}
404
405		6284	connection = env->heap_profiler_connection();
406	✓✓	6284	if (connection != nullptr) {
407		12	connection->End();
408			}
409
410		6284	connection = env->coverage_connection();
411	✓✓	6284	if (connection != nullptr) {
412		6280	connection->End();
413			}
414		6284	}
415
416		6298	void StartProfilers(Environment* env) {
417		6298	AtExit(env, [](void* env) {
418		6284	EndStartedProfilers(static_cast<Environment*>(env));
419		6284	}, env);
420
421		6298	Isolate* isolate = env->isolate();
422		12596	Local<String> coverage_str = env->env_vars()->Get(
423		6298	isolate, FIXED_ONE_BYTE_STRING(isolate, "NODE_V8_COVERAGE"))
424		6298	.FromMaybe(Local<String>());
425	✓✓✓✓ ✓✓	12595	if (!coverage_str.IsEmpty() && coverage_str->Length() > 0) {
426	✗✓	6294	CHECK_NULL(env->coverage_connection());
427		6294	env->set_coverage_connection(std::make_unique<V8CoverageConnection>(env));
428		6294	env->coverage_connection()->Start();
429			}
430	✓✓	6298	if (env->options()->cpu_prof) {
431		12	const std::string& dir = env->options()->cpu_prof_dir;
432		12	env->set_cpu_prof_interval(env->options()->cpu_prof_interval);
433	✓✓	12	env->set_cpu_prof_dir(dir.empty() ? env->GetCwd() : dir);
434	✓✓	12	if (env->options()->cpu_prof_name.empty()) {
435		10	DiagnosticFilename filename(env, "CPU", "cpuprofile");
436		10	env->set_cpu_prof_name(*filename);
437			} else {
438		2	env->set_cpu_prof_name(env->options()->cpu_prof_name);
439			}
440	✗✓	12	CHECK_NULL(env->cpu_profiler_connection());
441		12	env->set_cpu_profiler_connection(
442		24	std::make_unique<V8CpuProfilerConnection>(env));
443		12	env->cpu_profiler_connection()->Start();
444			}
445	✓✓	6298	if (env->options()->heap_prof) {
446		12	const std::string& dir = env->options()->heap_prof_dir;
447		12	env->set_heap_prof_interval(env->options()->heap_prof_interval);
448	✓✓	12	env->set_heap_prof_dir(dir.empty() ? env->GetCwd() : dir);
449	✓✓	12	if (env->options()->heap_prof_name.empty()) {
450		10	DiagnosticFilename filename(env, "Heap", "heapprofile");
451		10	env->set_heap_prof_name(*filename);
452			} else {
453		2	env->set_heap_prof_name(env->options()->heap_prof_name);
454			}
455		12	env->set_heap_profiler_connection(
456		24	std::make_unique<profiler::V8HeapProfilerConnection>(env));
457		12	env->heap_profiler_connection()->Start();
458			}
459		6298	}
460
461	✓✗	6269	static void SetCoverageDirectory(const FunctionCallbackInfo<Value>& args) {
462	✗✓	12538	CHECK(args[0]->IsString());
463		6269	Environment* env = Environment::GetCurrent(args);
464		18807	node::Utf8Value directory(env->isolate(), args[0].As<String>());
465		6269	env->set_coverage_directory(*directory);
466		6269	}
467
468
469	✓✗	6269	static void SetSourceMapCacheGetter(const FunctionCallbackInfo<Value>& args) {
470	✗✓	6269	CHECK(args[0]->IsFunction());
471		6269	Environment* env = Environment::GetCurrent(args);
472		12538	env->set_source_map_cache_getter(args[0].As<Function>());
473		6269	}
474
475		6	static void TakeCoverage(const FunctionCallbackInfo<Value>& args) {
476		6	Environment* env = Environment::GetCurrent(args);
477		6	V8CoverageConnection* connection = env->coverage_connection();
478
479	✗✓	6	Debug(
480			env,
481			DebugCategory::INSPECTOR_PROFILER,
482			"TakeCoverage, connection %s nullptr\n",
483			connection == nullptr ? "==" : "!=");
484
485	✓✗	6	if (connection != nullptr) {
486			Debug(env, DebugCategory::INSPECTOR_PROFILER, "taking coverage\n");
487		6	connection->TakeCoverage();
488			}
489		6	}
490
491		1	static void StopCoverage(const FunctionCallbackInfo<Value>& args) {
492		1	Environment* env = Environment::GetCurrent(args);
493		1	V8CoverageConnection* connection = env->coverage_connection();
494
495	✗✓	1	Debug(env,
496			DebugCategory::INSPECTOR_PROFILER,
497			"StopCoverage, connection %s nullptr\n",
498			connection == nullptr ? "==" : "!=");
499
500	✓✗	1	if (connection != nullptr) {
501			Debug(env, DebugCategory::INSPECTOR_PROFILER, "Stopping coverage\n");
502		1	connection->StopCoverage();
503			}
504		1	}
505
506		788	static void Initialize(Local<Object> target,
507			Local<Value> unused,
508			Local<Context> context,
509			void* priv) {
510		788	SetMethod(context, target, "setCoverageDirectory", SetCoverageDirectory);
511		788	SetMethod(
512			context, target, "setSourceMapCacheGetter", SetSourceMapCacheGetter);
513		788	SetMethod(context, target, "takeCoverage", TakeCoverage);
514		788	SetMethod(context, target, "stopCoverage", StopCoverage);
515		788	}
516
517		5528	void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
518		5528	registry->Register(SetCoverageDirectory);
519		5528	registry->Register(SetSourceMapCacheGetter);
520		5528	registry->Register(TakeCoverage);
521		5528	registry->Register(StopCoverage);
522		5528	}
523
524			} // namespace profiler
525			} // namespace node
526
527		5598	NODE_MODULE_CONTEXT_AWARE_INTERNAL(profiler, node::profiler::Initialize)
528		5528	NODE_MODULE_EXTERNAL_REFERENCE(profiler,
529			node::profiler::RegisterExternalReferences)