squash! inspector: split --cpu-prof-path to --prof-dir and --cpu-prof-name

Author: joyeecheung

doc/api/cli.md

@@ -85,8 +85,8 @@ added: REPLACEME
 Starts the V8 CPU profiler on start up, and writes the CPU profile to disk
 before exit.
 
-If `--prof-dir` is not specified, the generated profile will be placed in the
-current working directory.
+If `--node-prof-dir` is not specified, the generated profile will be placed
+in the current working directory.
 
 If `--cpu-prof-name` is not specified, the generated profile will be
 named `CPU.${yyyymmdd}.${hhmmss}.${pid}.${tid}.${seq}.cpuprofile`.
@@ -360,6 +360,19 @@ added: v7.10.0
 
 This option is a no-op. It is kept for compatibility.
 
+### `--node-prof-dir`
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 1 - Experimental
+
+Specify the directory where the CPU profiles generated by `--cpu-prof` will
+be placed.
+
+This does not apply to `--prof` whose output is handled by V8 instead of
+Node.js.
+
 ### `--no-deprecation`
 <!-- YAML
 added: v0.8.0
@@ -475,19 +488,6 @@ added: v2.0.0
 
 Generate V8 profiler output.
 
-### `--prof-dir`
-<!-- YAML
-added: REPLACEME
--->
-
-> Stability: 1 - Experimental
-
-Specify the directory where the CPU profiles generated by `--cpu-prof` will
-be placed.
-
-This does not apply to `--prof` whose output is handled by V8 instead of
-Node.js.
-
 ### `--prof-process`
 <!-- YAML
 added: v5.2.0

doc/node.1

@@ -81,7 +81,7 @@ Print source-able bash completion script for Node.js.
 .It Fl -cpu-prof
 Start the V8 CPU profiler on start up, and write the CPU profile to disk
 before exit. If
-.Fl -prof-dir
+.Fl -node-prof-dir
 is not specified, the profile will be written to the current working directory
 with a generated file name.
 .
@@ -213,6 +213,13 @@ Specify the maximum size of HTTP headers in bytes. Defaults to 8KB.
 This option is a no-op.
 It is kept for compatibility.
 .
+.It Fl -node-prof-dir
+The directory where the CPU profiles generated by
+.Fl -cpu-prof
+will be placed. Note that this does not apply to
+.Fl -prof
+whose output is handled by V8, not Node.js.
+.
 .It Fl -no-deprecation
 Silence deprecation warnings.
 .
@@ -240,13 +247,6 @@ Instructs the module loader to preserve symbolic links when resolving and cachin
 .It Fl -prof
 Generate V8 profiler output.
 .
-.It Fl -prof-dir
-The directory where the CPU profiles generated by
-.Fl -cpu-prof
-will be placed. Note that this does not apply to
-.Fl -prof
-whose output is handled by V8, not Node.js.
-.
 .It Fl -prof-process
 Process V8 profiler output generated using the V8 option
 .Fl -prof .

src/env-inl.h

@@ -687,26 +687,12 @@ inline const std::string& Environment::cpu_profile_path() const {
   return cpu_profile_path_;
 }
 
-inline void Environment::set_prof_dir(const std::string& path) {
-  prof_dir_ = path;
+inline void Environment::set_node_prof_dir(const std::string& path) {
+  node_prof_dir_ = path;
 }
 
-inline const std::string& Environment::prof_dir() const {
-  return prof_dir_;
-}
-
-inline void Environment::InitializeProfDir(const std::string& dir) {
-  if (!dir.empty()) {
-    prof_dir_ = dir;
-    return;
-  }
-  char cwd[CWD_BUFSIZE];
-  size_t size = CWD_BUFSIZE;
-  int err = uv_cwd(cwd, &size);
-  // TODO(joyeecheung): fallback to exec path / argv[0]
-  CHECK_EQ(err, 0);
-  CHECK_GT(size, 0);
-  prof_dir_ = cwd;
+inline const std::string& Environment::node_prof_dir() const {
+  return node_prof_dir_;
 }
 
 #endif  // HAVE_INSPECTOR

src/env.cc

@@ -845,6 +845,24 @@ void Environment::stop_sub_worker_contexts() {
   }
 }
 
+#if HAVE_INSPECTOR
+
+void Environment::InitializeNodeProfDir(const std::string& dir) {
+  if (!dir.empty()) {
+    node_prof_dir_ = dir;
+    return;
+  }
+  char cwd[CWD_BUFSIZE];
+  size_t size = CWD_BUFSIZE;
+  int err = uv_cwd(cwd, &size);
+  // TODO(joyeecheung): fallback to exec path / argv[0]
+  CHECK_EQ(err, 0);
+  CHECK_GT(size, 0);
+  node_prof_dir_ = cwd;
+}
+
+#endif  // HAVE_INSPECTOR
+
 void MemoryTracker::TrackField(const char* edge_name,
                                const CleanupHookCallback& value,
                                const char* node_name) {

src/env.h

@@ -1138,10 +1138,10 @@ class Environment : public MemoryRetainer {
   inline void set_cpu_profile_path(const std::string& path);
   inline const std::string& cpu_profile_path() const;
 
-  inline void set_prof_dir(const std::string& path);
-  inline const std::string& prof_dir() const;
+  inline void set_node_prof_dir(const std::string& path);
+  inline const std::string& node_prof_dir() const;
 
-  inline void InitializeProfDir(const std::string& dir);
+  void InitializeNodeProfDir(const std::string& dir);
 #endif  // HAVE_INSPECTOR
 
  private:
@@ -1178,7 +1178,7 @@ class Environment : public MemoryRetainer {
   std::unique_ptr<profiler::V8CoverageConnection> coverage_connection_;
   std::unique_ptr<profiler::V8CpuProfilerConnection> cpu_profiler_connection_;
   std::string coverage_directory_;
-  std::string prof_dir_;
+  std::string node_prof_dir_;
   std::string cpu_profile_path_;
 #endif  // HAVE_INSPECTOR
 

src/inspector_profiler.cc

@@ -319,7 +319,7 @@ void StartCoverageCollection(Environment* env) {
 }
 
 void StartCpuProfiling(Environment* env, const std::string& profile_name) {
-  std::string path = env->prof_dir() + std::string(kPathSeparator);
+  std::string path = env->node_prof_dir() + std::string(kPathSeparator);
   if (profile_name.empty()) {
     DiagnosticFilename filename(env, "CPU", "cpuprofile");
     path += *filename;

src/node.cc

@@ -239,7 +239,7 @@ MaybeLocal<Value> RunBootstrapping(Environment* env) {
 
 #if HAVE_INSPECTOR
   if (env->options()->cpu_prof) {
-    env->InitializeProfDir(env->options()->prof_dir);
+    env->InitializeNodeProfDir(env->options()->node_prof_dir);
     profiler::StartCpuProfiling(env, env->options()->cpu_prof_name);
   }
 #endif  // HAVE_INSPECTOR

src/node_options.cc

@@ -154,8 +154,8 @@ void EnvironmentOptions::CheckOptions(std::vector<std::string>* errors) {
   }
 
   // We may add support for other profiles in the future.
-  if (!prof_dir.empty() && !cpu_prof) {
-    errors->push_back("--prof-dir must be used with --cpu-prof");
+  if (!node_prof_dir.empty() && !cpu_prof) {
+    errors->push_back("--node-prof-dir must be used with --cpu-prof");
   }
 
   debug_options_.CheckOptions(errors);
@@ -351,10 +351,10 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
             "specified file name of the V8 CPU profile generated with "
             "--cpu-prof",
             &EnvironmentOptions::cpu_prof_name);
-  AddOption("--prof-dir",
+  AddOption("--node-prof-dir",
             "Directory where the V8 profiles generated by --cpu-prof will be "
             "placed. Does not affect --prof.",
-            &EnvironmentOptions::prof_dir);
+            &EnvironmentOptions::node_prof_dir);
 #endif  // HAVE_INSPECTOR
   AddOption("--redirect-warnings",
             "write warnings to file instead of stderr",

src/node_options.h

@@ -110,7 +110,7 @@ class EnvironmentOptions : public Options {
   bool preserve_symlinks_main = false;
   bool prof_process = false;
 #if HAVE_INSPECTOR
-  std::string prof_dir;
+  std::string node_prof_dir;
   std::string cpu_prof_name;
   bool cpu_prof = false;
 #endif  // HAVE_INSPECTOR

test/sequential/test-cpu-prof.js

@@ -1,6 +1,6 @@
 'use strict';
 
-// This tests that --cpu-prof, --prof-dir and --cpu-prof-name works.
+// This tests that --cpu-prof, --node-prof-dir and --cpu-prof-name works.
 
 const common = require('../common');
 if (process.features.debug &&
@@ -162,11 +162,11 @@ const env = {
     `${process.execPath}: --cpu-prof-name must be used with --cpu-prof`);
 }
 
-// --prof-dir without --cpu-prof
+// --node-prof-dir without --cpu-prof
 {
   tmpdir.refresh();
   const output = spawnSync(process.execPath, [
-    '--prof-dir',
+    '--node-prof-dir',
     'prof',
     fixtures.path('workload', 'fibonacci.js'),
   ], {
@@ -180,7 +180,7 @@ const env = {
   assert.strictEqual(output.status, 9);
   assert.strictEqual(
     stderr,
-    `${process.execPath}: --prof-dir must be used with --cpu-prof`);
+    `${process.execPath}: --node-prof-dir must be used with --cpu-prof`);
 }
 
 // --cpu-prof-name
@@ -205,12 +205,12 @@ const env = {
   verifyFrames(output, file, 'fibonacci.js');
 }
 
-// relative --prof-dir
+// relative --node-prof-dir
 {
   tmpdir.refresh();
   const output = spawnSync(process.execPath, [
     '--cpu-prof',
-    '--prof-dir',
+    '--node-prof-dir',
     'prof',
     fixtures.path('workload', 'fibonacci.js'),
   ], {
@@ -228,13 +228,13 @@ const env = {
   verifyFrames(output, profiles[0], 'fibonacci.js');
 }
 
-// absolute --prof-dir
+// absolute --node-prof-dir
 {
   tmpdir.refresh();
   const dir = path.join(tmpdir.path, 'prof');
   const output = spawnSync(process.execPath, [
     '--cpu-prof',
-    '--prof-dir',
+    '--node-prof-dir',
     dir,
     fixtures.path('workload', 'fibonacci.js'),
   ], {
@@ -251,7 +251,7 @@ const env = {
   verifyFrames(output, profiles[0], 'fibonacci.js');
 }
 
-// --prof-dir and --cpu-prof-name
+// --node-prof-dir and --cpu-prof-name
 {
   tmpdir.refresh();
   const dir = path.join(tmpdir.path, 'prof');
@@ -260,7 +260,7 @@ const env = {
     '--cpu-prof',
     '--cpu-prof-name',
     'test.cpuprofile',
-    '--prof-dir',
+    '--node-prof-dir',
     dir,
     fixtures.path('workload', 'fibonacci.js'),
   ], {
@@ -277,11 +277,11 @@ const env = {
   verifyFrames(output, file, 'fibonacci.js');
 }
 
-// --prof-dir with worker
+// --node-prof-dir with worker
 {
   tmpdir.refresh();
   const output = spawnSync(process.execPath, [
-    '--prof-dir',
+    '--node-prof-dir',
     'prof',
     '--cpu-prof',
     fixtures.path('workload', 'fibonacci-worker.js'),