Reapply "[vm] Don't enable the profiler by default. Enable the profiler at startup with --observe, …

runtime/vm/profiler_test.cc

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #include "platform/assert.h"
 
 #include "vm/dart_api_impl.h"
 #include "vm/dart_api_state.h"
 #include "vm/globals.h"
 #include "vm/profiler.h"
@@ skipping 171 matching lines @@
     return sample->is_allocation_sample() && (sample->allocation_cid() == cid_);
   }
 
   void set_enable_vm_ticks(bool enable) { enable_vm_ticks_ = enable; }
 
  private:
   intptr_t cid_;
   bool enable_vm_ticks_;
 };
 
+static void EnableProfiler() {
+  if (!FLAG_profiler) {
+    FLAG_profiler = true;
+    Profiler::InitOnce();
+  }
+}
+
 TEST_CASE(Profiler_TrivialRecordAllocation) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   const char* kScript =
       "class A {\n"
       "  var a;\n"
       "  var b;\n"
       "}\n"
       "class B {\n"
       "  static boo() {\n"
       "    return new A();\n"
       "  }\n"
@@ skipping 104 matching lines @@
 
 #if defined(DART_USE_TCMALLOC) && defined(HOST_OS_LINUX) && defined(DEBUG) &&  \
     defined(HOST_ARCH_x64)
 
 DART_NOINLINE static void NativeAllocationSampleHelper(char** result) {
   ASSERT(result != NULL);
   *result = static_cast<char*>(malloc(sizeof(char) * 1024));
 }
 
 ISOLATE_UNIT_TEST_CASE(Profiler_NativeAllocation) {
+  EnableProfiler();
+
   bool enable_malloc_hooks_saved = FLAG_profiler_native_memory;
   FLAG_profiler_native_memory = true;
 
   MallocHooks::InitOnce();
   MallocHooks::ResetStats();
   bool stack_trace_collection_enabled =
       MallocHooks::stack_trace_collection_enabled();
   MallocHooks::set_stack_trace_collection_enabled(true);
 
   char* result = NULL;
@@ skipping 182 matching lines @@
 
   MallocHooks::set_stack_trace_collection_enabled(
       stack_trace_collection_enabled);
   MallocHooks::TearDown();
   FLAG_profiler_native_memory = enable_malloc_hooks_saved;
 }
 #endif  // defined(DART_USE_TCMALLOC) && !defined(PRODUCT) &&
         // !defined(TARGET_ARCH_DBC) && !defined(HOST_OS_FUCHSIA)
 
 TEST_CASE(Profiler_ToggleRecordAllocation) {
+  EnableProfiler();
+
   DisableNativeProfileScope dnps;
   const char* kScript =
       "class A {\n"
       "  var a;\n"
       "  var b;\n"
       "}\n"
       "class B {\n"
       "  static boo() {\n"
       "    return new A();\n"
       "  }\n"
@@ skipping 109 matching lines @@
     HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate->main_port(), class_a.id());
     profile.Build(thread, &filter, Profiler::sample_buffer(), Profile::kNoTags);
     // We should still only have one allocation sample.
     EXPECT_EQ(1, profile.sample_count());
   }
 }
 
 TEST_CASE(Profiler_CodeTicks) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   const char* kScript =
       "class A {\n"
       "  var a;\n"
       "  var b;\n"
       "}\n"
       "class B {\n"
       "  static boo() {\n"
       "    return new A();\n"
       "  }\n"
@@ skipping 82 matching lines @@
     EXPECT(walker.Down());
     EXPECT_STREQ("[Stub] Allocate A", walker.CurrentName());
     EXPECT_EQ(3, walker.CurrentExclusiveTicks());
     EXPECT(walker.Down());
     EXPECT_STREQ("DRT_AllocateObject", walker.CurrentName());
     EXPECT(!walker.Down());
   }
 }
 
 TEST_CASE(Profiler_FunctionTicks) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   const char* kScript =
       "class A {\n"
       "  var a;\n"
       "  var b;\n"
       "}\n"
       "class B {\n"
       "  static boo() {\n"
       "    return new A();\n"
       "  }\n"
@@ skipping 82 matching lines @@
     EXPECT(walker.Down());
     EXPECT_STREQ("[Stub] Allocate A", walker.CurrentName());
     EXPECT_EQ(3, walker.CurrentExclusiveTicks());
     EXPECT(walker.Down());
     EXPECT_STREQ("DRT_AllocateObject", walker.CurrentName());
     EXPECT(!walker.Down());
   }
 }
 
 TEST_CASE(Profiler_IntrinsicAllocation) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   const char* kScript = "double foo(double a, double b) => a + b;";
   Dart_Handle lib = TestCase::LoadTestScript(kScript, NULL);
   EXPECT_VALID(lib);
   Library& root_library = Library::Handle();
   root_library ^= Api::UnwrapHandle(lib);
   Isolate* isolate = thread->isolate();
 
   const Class& double_class =
       Class::Handle(isolate->object_store()->double_class());
@@ skipping 51 matching lines @@
     HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate->main_port(), double_class.id());
     profile.Build(thread, &filter, Profiler::sample_buffer(), Profile::kNoTags);
     // We should still only have one allocation sample.
     EXPECT_EQ(1, profile.sample_count());
   }
 }
 
 TEST_CASE(Profiler_ArrayAllocation) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   const char* kScript =
       "List foo() => new List(4);\n"
       "List bar() => new List();\n";
   Dart_Handle lib = TestCase::LoadTestScript(kScript, NULL);
   EXPECT_VALID(lib);
   Library& root_library = Library::Handle();
   root_library ^= Api::UnwrapHandle(lib);
   Isolate* isolate = thread->isolate();
 
@@ skipping 76 matching lines @@
     Profile profile(isolate);
     AllocationFilter filter(isolate->main_port(), array_class.id());
     profile.Build(thread, &filter, Profiler::sample_buffer(), Profile::kNoTags);
     // We should have no allocation samples, since empty
     // growable lists use a shared backing.
     EXPECT_EQ(0, profile.sample_count());
   }
 }
 
 TEST_CASE(Profiler_ContextAllocation) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   const char* kScript =
       "var msg1 = 'a';\n"
       "foo() {\n"
       "  var msg = msg1 + msg1;\n"
       "  return (x) { return '$msg + $msg'; }(msg);\n"
       "}\n";
   Dart_Handle lib = TestCase::LoadTestScript(kScript, NULL);
   EXPECT_VALID(lib);
   Library& root_library = Library::Handle();
@@ skipping 49 matching lines @@
     HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate->main_port(), context_class.id());
     profile.Build(thread, &filter, Profiler::sample_buffer(), Profile::kNoTags);
     // We should still only have one allocation sample.
     EXPECT_EQ(1, profile.sample_count());
   }
 }
 
 TEST_CASE(Profiler_ClosureAllocation) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   const char* kScript =
       "var msg1 = 'a';\n"
       "\n"
       "foo() {\n"
       "  var msg = msg1 + msg1;\n"
       "  var msg2 = msg + msg;\n"
       "  return (x, y, z, w) { return '$x + $y + $z'; }(msg, msg2, msg, msg);\n"
       "}\n"
       "bar() {\n"
@@ skipping 51 matching lines @@
     Profile profile(isolate);
     AllocationFilter filter(isolate->main_port(), closure_class.id());
     filter.set_enable_vm_ticks(true);
     profile.Build(thread, &filter, Profiler::sample_buffer(), Profile::kNoTags);
     // We should still only have one allocation sample.
     EXPECT_EQ(1, profile.sample_count());
   }
 }
 
 TEST_CASE(Profiler_TypedArrayAllocation) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   const char* kScript =
       "import 'dart:typed_data';\n"
       "List foo() => new Float32List(4);\n";
   Dart_Handle lib = TestCase::LoadTestScript(kScript, NULL);
   EXPECT_VALID(lib);
   Library& root_library = Library::Handle();
   root_library ^= Api::UnwrapHandle(lib);
   Isolate* isolate = thread->isolate();
 
@@ skipping 64 matching lines @@
     HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate->main_port(), float32_list_class.id());
     profile.Build(thread, &filter, Profiler::sample_buffer(), Profile::kNoTags);
     // We should now have two allocation samples.
     EXPECT_EQ(2, profile.sample_count());
   }
 }
 
 TEST_CASE(Profiler_StringAllocation) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   const char* kScript = "String foo(String a, String b) => a + b;";
   Dart_Handle lib = TestCase::LoadTestScript(kScript, NULL);
   EXPECT_VALID(lib);
   Library& root_library = Library::Handle();
   root_library ^= Api::UnwrapHandle(lib);
   Isolate* isolate = thread->isolate();
 
   const Class& one_byte_string_class =
       Class::Handle(isolate->object_store()->one_byte_string_class());
@@ skipping 65 matching lines @@
     HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate->main_port(), one_byte_string_class.id());
     profile.Build(thread, &filter, Profiler::sample_buffer(), Profile::kNoTags);
     // We should now have two allocation samples.
     EXPECT_EQ(2, profile.sample_count());
   }
 }
 
 TEST_CASE(Profiler_StringInterpolation) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   DisableBackgroundCompilationScope dbcs;
   const char* kScript = "String foo(String a, String b) => '$a | $b';";
   Dart_Handle lib = TestCase::LoadTestScript(kScript, NULL);
   EXPECT_VALID(lib);
   Library& root_library = Library::Handle();
   root_library ^= Api::UnwrapHandle(lib);
   Isolate* isolate = thread->isolate();
 
   const Class& one_byte_string_class =
@@ skipping 68 matching lines @@
     HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate->main_port(), one_byte_string_class.id());
     profile.Build(thread, &filter, Profiler::sample_buffer(), Profile::kNoTags);
     // We should now have two allocation samples.
     EXPECT_EQ(2, profile.sample_count());
   }
 }
 
 TEST_CASE(Profiler_FunctionInline) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   DisableBackgroundCompilationScope dbcs;
 
   const char* kScript =
       "class A {\n"
       "  var a;\n"
       "  var b;\n"
       "}\n"
       "class B {\n"
       "  static choo(bool alloc) {\n"
@@ skipping 269 matching lines @@
     EXPECT(!walker.Down());
   }
 }
 
 TEST_CASE(Profiler_InliningIntervalBoundry) {
   // The PC of frames below the top frame is a call's return address,
   // which can belong to a different inlining interval than the call.
   // This test checks the profiler service takes this into account; see
   // ProfileBuilder::ProcessFrame.
 
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   DisableBackgroundCompilationScope dbcs;
   const char* kScript =
       "class A {\n"
       "}\n"
       "bool alloc = false;"
       "maybeAlloc() {\n"
       "  try {\n"
       "    if (alloc) new A();\n"
       "  } catch (e) {\n"
@@ skipping 111 matching lines @@
     EXPECT_STREQ("maybeAlloc", walker.CurrentName());
     EXPECT(walker.Down());
     EXPECT_STREQ("[Stub] Allocate A", walker.CurrentName());
     EXPECT(walker.Down());
     EXPECT_STREQ("DRT_AllocateObject", walker.CurrentName());
     EXPECT(!walker.Down());
   }
 }
 
 TEST_CASE(Profiler_ChainedSamples) {
+  EnableProfiler();
   MaxProfileDepthScope mpds(32);
   DisableNativeProfileScope dnps;
 
   // Each sample holds 8 stack frames.
   // This chain is 20 stack frames deep.
   const char* kScript =
       "class A {\n"
       "  var a;\n"
       "  var b;\n"
       "}\n"
@@ skipping 92 matching lines @@
     EXPECT_STREQ("init", walker.CurrentName());
     EXPECT(walker.Down());
     EXPECT_STREQ("go", walker.CurrentName());
     EXPECT(walker.Down());
     EXPECT_STREQ("main", walker.CurrentName());
     EXPECT(!walker.Down());
   }
 }
 
 TEST_CASE(Profiler_BasicSourcePosition) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   DisableBackgroundCompilationScope dbcs;
   const char* kScript =
       "const AlwaysInline = 'AlwaysInline';\n"
       "const NeverInline = 'NeverInline';\n"
       "class A {\n"
       "  var a;\n"
       "  var b;\n"
       "  @NeverInline A() { }\n"
       "}\n"
@@ skipping 54 matching lines @@
     EXPECT_STREQ("main", walker.CurrentName());
     EXPECT_EQ(1, walker.CurrentNodeTickCount());
     EXPECT_EQ(1, walker.CurrentInclusiveTicks());
     EXPECT_EQ(0, walker.CurrentExclusiveTicks());
     EXPECT_STREQ("boo", walker.CurrentToken());
     EXPECT(!walker.Down());
   }
 }
 
 TEST_CASE(Profiler_BasicSourcePositionOptimized) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   DisableBackgroundCompilationScope dbcs;
   // We use the AlwaysInline and NeverInline annotations in this test.
   SetFlagScope<bool> sfs(&FLAG_enable_inlining_annotations, true);
   // Optimize quickly.
   SetFlagScope<int> sfs2(&FLAG_optimization_counter_threshold, 5);
   const char* kScript =
       "const AlwaysInline = 'AlwaysInline';\n"
       "const NeverInline = 'NeverInline';\n"
       "class A {\n"
@@ skipping 73 matching lines @@
     EXPECT_STREQ("main", walker.CurrentName());
     EXPECT_EQ(1, walker.CurrentNodeTickCount());
     EXPECT_EQ(1, walker.CurrentInclusiveTicks());
     EXPECT_EQ(0, walker.CurrentExclusiveTicks());
     EXPECT_STREQ("boo", walker.CurrentToken());
     EXPECT(!walker.Down());
   }
 }
 
 TEST_CASE(Profiler_SourcePosition) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   DisableBackgroundCompilationScope dbcs;
   const char* kScript =
       "const AlwaysInline = 'AlwaysInline';\n"
       "const NeverInline = 'NeverInline';\n"
       "class A {\n"
       "  var a;\n"
       "  var b;\n"
       "  @NeverInline A() { }\n"
       "}\n"
@@ skipping 84 matching lines @@
     EXPECT_STREQ("main", walker.CurrentName());
     EXPECT_EQ(1, walker.CurrentNodeTickCount());
     EXPECT_EQ(1, walker.CurrentInclusiveTicks());
     EXPECT_EQ(0, walker.CurrentExclusiveTicks());
     EXPECT_STREQ("bacon", walker.CurrentToken());
     EXPECT(!walker.Down());
   }
 }
 
 TEST_CASE(Profiler_SourcePositionOptimized) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   DisableBackgroundCompilationScope dbcs;
   // We use the AlwaysInline and NeverInline annotations in this test.
   SetFlagScope<bool> sfs(&FLAG_enable_inlining_annotations, true);
   // Optimize quickly.
   SetFlagScope<int> sfs2(&FLAG_optimization_counter_threshold, 5);
 
   const char* kScript =
       "const AlwaysInline = 'AlwaysInline';\n"
       "const NeverInline = 'NeverInline';\n"
@@ skipping 104 matching lines @@
     EXPECT_STREQ("main", walker.CurrentName());
     EXPECT_EQ(1, walker.CurrentNodeTickCount());
     EXPECT_EQ(1, walker.CurrentInclusiveTicks());
     EXPECT_EQ(0, walker.CurrentExclusiveTicks());
     EXPECT_STREQ("bacon", walker.CurrentToken());
     EXPECT(!walker.Down());
   }
 }
 
 TEST_CASE(Profiler_BinaryOperatorSourcePosition) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   DisableBackgroundCompilationScope dbcs;
   const char* kScript =
       "const AlwaysInline = 'AlwaysInline';\n"
       "const NeverInline = 'NeverInline';\n"
       "class A {\n"
       "  var a;\n"
       "  var b;\n"
       "  @NeverInline A() { }\n"
       "}\n"
@@ skipping 93 matching lines @@
     EXPECT_STREQ("main", walker.CurrentName());
     EXPECT_EQ(1, walker.CurrentNodeTickCount());
     EXPECT_EQ(1, walker.CurrentInclusiveTicks());
     EXPECT_EQ(0, walker.CurrentExclusiveTicks());
     EXPECT_STREQ("bacon", walker.CurrentToken());
     EXPECT(!walker.Down());
   }
 }
 
 TEST_CASE(Profiler_BinaryOperatorSourcePositionOptimized) {
+  EnableProfiler();
   DisableNativeProfileScope dnps;
   DisableBackgroundCompilationScope dbcs;
   // We use the AlwaysInline and NeverInline annotations in this test.
   SetFlagScope<bool> sfs(&FLAG_enable_inlining_annotations, true);
   // Optimize quickly.
   SetFlagScope<int> sfs2(&FLAG_optimization_counter_threshold, 5);
 
   const char* kScript =
       "const AlwaysInline = 'AlwaysInline';\n"
       "const NeverInline = 'NeverInline';\n"
@@ skipping 152 matching lines @@
                                           &token_positions);
     if (token_positions[0] == tp) {
       return code.PayloadStart() + pc_offset;
     }
   }
 
   return 0;
 }
 
 TEST_CASE(Profiler_GetSourceReport) {
+  EnableProfiler();
   const char* kScript =
       "doWork(i) => i * i;\n"
       "main() {\n"
       "  var sum = 0;\n"
       "  for (var i = 0; i < 100; i++) {\n"
       "     sum += doWork(i);\n"
       "  }\n"
       "  return sum;\n"
       "}\n";
 
@@ skipping 220 matching lines @@
   EXPECT_EQ(table->FindCodeForPC(45), code1);  // Merged right.
   EXPECT_EQ(table->FindCodeForPC(54), code1);  // Merged right.
   EXPECT_EQ(table->FindCodeForPC(20), code2);  // Merged left.
   EXPECT_EQ(table->FindCodeForPC(49), code1);  // Truncated.
   EXPECT_EQ(table->FindCodeForPC(50), code1);
 }
 
 #endif  // !PRODUCT
 
 }  // namespace dart