Introduce v8::CpuProfiler::New and v8::CpuProfiler::Dispose API.

a1ph · Commit bot · commit 120b753f71af · 2016-07-08T15:01:10.000Z
Isolate is not going to retain a CPU profiler. The client will be creating an instance of profiler when needed. Deprectate v8::Isolate::GetCpuProfiler() BUG=v8:4789 Review-Url: https://codereview.chromium.org/2117343006 Cr-Commit-Position: refs/heads/master@{#37613}
diff --git a/include/v8-profiler.h b/include/v8-profiler.h
@@ -207,13 +207,24 @@ class V8_EXPORT CpuProfile {
   void Delete();
 };
 
-
 /**
  * Interface for controlling CPU profiling. Instance of the
- * profiler can be retrieved using v8::Isolate::GetCpuProfiler.
+ * profiler can be created using v8::CpuProfiler::New method.
  */
 class V8_EXPORT CpuProfiler {
  public:
+  /**
+   * Creates a new CPU profiler for the |isolate|. The isolate must be
+   * initialized. The profiler object must be disposed after use by calling
+   * |Dispose| method.
+   */
+  static CpuProfiler* New(Isolate* isolate);
+
+  /**
+   * Disposes the CPU profiler object.
+   */
+  void Dispose();
+
   /**
    * Changes default CPU profiler sampling interval to the specified number
    * of microseconds. Default interval is 1000us. This method must be called
diff --git a/include/v8.h b/include/v8.h
@@ -5932,7 +5932,8 @@ class V8_EXPORT Isolate {
    * is initialized. It is the embedder's responsibility to stop all CPU
    * profiling activities if it has started any.
    */
-  CpuProfiler* GetCpuProfiler();
+  V8_DEPRECATE_SOON("CpuProfiler should be created with CpuProfiler::New call.",
+                    CpuProfiler* GetCpuProfiler());
 
   /** Returns true if this isolate has a current context. */
   bool InContext();
diff --git a/src/api.cc b/src/api.cc
@@ -8496,6 +8496,12 @@ int CpuProfile::GetSamplesCount() const {
   return reinterpret_cast<const i::CpuProfile*>(this)->samples_count();
 }
 
+CpuProfiler* CpuProfiler::New(Isolate* isolate) {
+  return reinterpret_cast<CpuProfiler*>(
+      new i::CpuProfiler(reinterpret_cast<i::Isolate*>(isolate)));
+}
+
+void CpuProfiler::Dispose() { delete reinterpret_cast<i::CpuProfiler*>(this); }
 
 void CpuProfiler::SetSamplingInterval(int us) {
   DCHECK_GE(us, 0);
diff --git a/src/isolate.h b/src/isolate.h
@@ -921,7 +921,6 @@ class Isolate {
   CodeEventDispatcher* code_event_dispatcher() const {
     return code_event_dispatcher_.get();
   }
-  CpuProfiler* cpu_profiler() const { return cpu_profiler_; }
   HeapProfiler* heap_profiler() const { return heap_profiler_; }
 
 #ifdef DEBUG
@@ -1264,6 +1263,10 @@ class Isolate {
     return "";
   }
 
+  // TODO(alph): Remove along with the deprecated GetCpuProfiler().
+  friend v8::CpuProfiler* v8::Isolate::GetCpuProfiler();
+  CpuProfiler* cpu_profiler() const { return cpu_profiler_; }
+
   base::Atomic32 id_;
   EntryStackItem* entry_stack_;
   int stack_trace_nesting_level_;
diff --git a/test/cctest/profiler-extension.cc b/test/cctest/profiler-extension.cc
@@ -33,7 +33,8 @@
 namespace v8 {
 namespace internal {
 
-v8::CpuProfile* ProfilerExtension::last_profile = NULL;
+v8::CpuProfiler* ProfilerExtension::profiler_ = nullptr;
+v8::CpuProfile* ProfilerExtension::last_profile = nullptr;
 const char* ProfilerExtension::kSource =
     "native function startProfiling();"
     "native function stopProfiling();"
@@ -58,24 +59,22 @@ v8::Local<v8::FunctionTemplate> ProfilerExtension::GetNativeFunctionTemplate(
 
 void ProfilerExtension::StartProfiling(
     const v8::FunctionCallbackInfo<v8::Value>& args) {
-  last_profile = NULL;
-  v8::CpuProfiler* cpu_profiler = args.GetIsolate()->GetCpuProfiler();
-  cpu_profiler->StartProfiling((args.Length() > 0)
-      ? args[0].As<v8::String>()
-      : v8::String::Empty(args.GetIsolate()));
+  last_profile = nullptr;
+  profiler_->StartProfiling(args.Length() > 0
+                                ? args[0].As<v8::String>()
+                                : v8::String::Empty(args.GetIsolate()));
 }
 
 void ProfilerExtension::StopProfiling(
     const v8::FunctionCallbackInfo<v8::Value>& args) {
-  v8::CpuProfiler* cpu_profiler = args.GetIsolate()->GetCpuProfiler();
-  last_profile = cpu_profiler->StopProfiling((args.Length() > 0)
-      ? args[0].As<v8::String>()
-      : v8::String::Empty(args.GetIsolate()));
+  last_profile = profiler_->StopProfiling(
+      args.Length() > 0 ? args[0].As<v8::String>()
+                        : v8::String::Empty(args.GetIsolate()));
 }
 
 void ProfilerExtension::CollectSample(
     const v8::FunctionCallbackInfo<v8::Value>& args) {
-  args.GetIsolate()->GetCpuProfiler()->CollectSample();
+  profiler_->CollectSample();
 }
 
 }  // namespace internal
diff --git a/test/cctest/profiler-extension.h b/test/cctest/profiler-extension.h
@@ -35,18 +35,28 @@
 namespace v8 {
 namespace internal {
 
+class CpuProfiler;
+
 class ProfilerExtension : public v8::Extension {
  public:
   ProfilerExtension() : v8::Extension("v8/profiler", kSource) { }
+
   virtual v8::Local<v8::FunctionTemplate> GetNativeFunctionTemplate(
       v8::Isolate* isolate, v8::Local<v8::String> name);
+
+  static void set_profiler(v8::CpuProfiler* profiler) { profiler_ = profiler; }
+  static void set_profiler(CpuProfiler* profiler) {
+    profiler_ = reinterpret_cast<v8::CpuProfiler*>(profiler);
+  }
+  static v8::CpuProfiler* profiler() { return profiler_; }
   static v8::CpuProfile* last_profile;
 
  private:
   static void StartProfiling(const v8::FunctionCallbackInfo<v8::Value>& args);
   static void StopProfiling(const v8::FunctionCallbackInfo<v8::Value>& args);
   static void CollectSample(const v8::FunctionCallbackInfo<v8::Value>& args);
 
+  static v8::CpuProfiler* profiler_;
   static const char* kSource;
 };
 
diff --git a/test/cctest/test-api.cc b/test/cctest/test-api.cc
@@ -96,11 +96,11 @@ void RunWithProfiler(void (*test)()) {
   LocalContext env;
   v8::HandleScope scope(env->GetIsolate());
   v8::Local<v8::String> profile_name = v8_str("my_profile1");
-  v8::CpuProfiler* cpu_profiler = env->GetIsolate()->GetCpuProfiler();
-
+  v8::CpuProfiler* cpu_profiler = v8::CpuProfiler::New(env->GetIsolate());
   cpu_profiler->StartProfiling(profile_name);
   (*test)();
   reinterpret_cast<i::CpuProfiler*>(cpu_profiler)->DeleteAllProfiles();
+  cpu_profiler->Dispose();
 }
 
 
diff --git a/test/cctest/test-cpu-profiler.cc b/test/cctest/test-cpu-profiler.cc
diff --git a/test/cctest/test-profile-generator.cc b/test/cctest/test-profile-generator.cc
