Chain samples together to collect long stack traces in profiler

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"
 #include "vm/profiler_service.h"
 #include "vm/unit_test.h"
 
 namespace dart {
 
 DECLARE_FLAG(bool, profile_vm);
+DECLARE_FLAG(int, max_profile_depth);
 
 // Some tests are written assuming native stack trace profiling is disabled.
-class DisableNativeProfileScope {
+class DisableNativeProfileScope : public ValueObject {
  public:
   DisableNativeProfileScope()
       : FLAG_profile_vm_(FLAG_profile_vm) {
     FLAG_profile_vm = false;
   }
 
   ~DisableNativeProfileScope() {
     FLAG_profile_vm = FLAG_profile_vm_;
   }
 
  private:
   const bool FLAG_profile_vm_;
 };
 
 
+// Temporarily adjust the maximum profile depth.
+class MaxProfileDepthScope : public ValueObject {
+ public:
+  explicit MaxProfileDepthScope(intptr_t new_max_depth)
+      : FLAG_max_profile_depth_(FLAG_max_profile_depth) {
+    Profiler::SetSampleDepth(new_max_depth);
+  }
+
+  ~MaxProfileDepthScope() {
+    Profiler::SetSampleDepth(FLAG_max_profile_depth_);
+  }
+
+ private:
+  const intptr_t FLAG_max_profile_depth_;
+};
+
+
 class ProfileSampleBufferTestHelper {
  public:
   static intptr_t IterateCount(const Isolate* isolate,
                                const SampleBuffer& sample_buffer) {
     intptr_t c = 0;
     for (intptr_t i = 0; i < sample_buffer.capacity(); i++) {
       Sample* sample = sample_buffer.At(i);
       if (sample->isolate() != isolate) {
         continue;
       }
@@ skipping 134 matching lines @@
 
   const Class& class_a = Class::Handle(GetClass(root_library, "A"));
   EXPECT(!class_a.IsNull());
   class_a.SetTraceAllocation(true);
 
   Dart_Handle result = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(result);
 
 
   {
-    Isolate* isolate = Isolate::Current();
-    StackZone zone(isolate);
-    HANDLESCOPE(isolate);
+    Thread* thread = Thread::Current();
+    Isolate* isolate = thread->isolate();
+    StackZone zone(thread);
+    HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate, class_a.id());
     profile.Build(&filter, Profile::kNoTags);
     // We should have 1 allocation sample.
     EXPECT_EQ(1, profile.sample_count());
     ProfileTrieWalker walker(&profile);
 
     // Exclusive code: B.boo -> main.
     walker.Reset(Profile::kExclusiveCode);
     // Move down from the root.
@@ skipping 55 matching lines @@
   root_library ^= Api::UnwrapHandle(lib);
 
   const Class& class_a = Class::Handle(GetClass(root_library, "A"));
   EXPECT(!class_a.IsNull());
 
   Dart_Handle result = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(result);
 
 
   {
-    Isolate* isolate = Isolate::Current();
-    StackZone zone(isolate);
-    HANDLESCOPE(isolate);
+    Thread* thread = Thread::Current();
+    Isolate* isolate = thread->isolate();
+    StackZone zone(thread);
+    HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate, class_a.id());
     profile.Build(&filter, Profile::kNoTags);
     // We should have no allocation samples.
     EXPECT_EQ(0, profile.sample_count());
   }
 
   // Turn on allocation tracing for A.
   class_a.SetTraceAllocation(true);
 
   result = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(result);
 
   {
-    Isolate* isolate = Isolate::Current();
-    StackZone zone(isolate);
-    HANDLESCOPE(isolate);
+    Thread* thread = Thread::Current();
+    Isolate* isolate = thread->isolate();
+    StackZone zone(thread);
+    HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate, class_a.id());
     profile.Build(&filter, Profile::kNoTags);
     // We should have one allocation sample.
     EXPECT_EQ(1, profile.sample_count());
     ProfileTrieWalker walker(&profile);
 
     // Exclusive code: B.boo -> main.
     walker.Reset(Profile::kExclusiveCode);
     // Move down from the root.
@@ skipping 31 matching lines @@
     EXPECT(!walker.Down());
   }
 
   // Turn off allocation tracing for A.
   class_a.SetTraceAllocation(false);
 
   result = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(result);
 
   {
-    Isolate* isolate = Isolate::Current();
-    StackZone zone(isolate);
-    HANDLESCOPE(isolate);
+    Thread* thread = Thread::Current();
+    Isolate* isolate = thread->isolate();
+    StackZone zone(thread);
+    HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate, class_a.id());
     profile.Build(&filter, Profile::kNoTags);
     // We should still only have one allocation sample.
     EXPECT_EQ(1, profile.sample_count());
   }
 }
 
 
 TEST_CASE(Profiler_CodeTicks) {
@@ skipping 17 matching lines @@
   Library& root_library = Library::Handle();
   root_library ^= Api::UnwrapHandle(lib);
 
   const Class& class_a = Class::Handle(GetClass(root_library, "A"));
   EXPECT(!class_a.IsNull());
 
   Dart_Handle result = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(result);
 
   {
-    Isolate* isolate = Isolate::Current();
-    StackZone zone(isolate);
-    HANDLESCOPE(isolate);
+    Thread* thread = Thread::Current();
+    Isolate* isolate = thread->isolate();
+    StackZone zone(thread);
+    HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate, class_a.id());
     profile.Build(&filter, Profile::kNoTags);
     // We should have no allocation samples.
     EXPECT_EQ(0, profile.sample_count());
   }
 
   // Turn on allocation tracing for A.
   class_a.SetTraceAllocation(true);
 
   // Allocate three times.
   result = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(result);
   result = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(result);
   result = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(result);
 
   {
-    Isolate* isolate = Isolate::Current();
-    StackZone zone(isolate);
-    HANDLESCOPE(isolate);
+    Thread* thread = Thread::Current();
+    Isolate* isolate = thread->isolate();
+    StackZone zone(thread);
+    HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate, class_a.id());
     profile.Build(&filter, Profile::kNoTags);
     // We should have three allocation samples.
     EXPECT_EQ(3, profile.sample_count());
     ProfileTrieWalker walker(&profile);
 
     // Exclusive code: B.boo -> main.
     walker.Reset(Profile::kExclusiveCode);
     // Move down from the root.
@@ skipping 48 matching lines @@
   Library& root_library = Library::Handle();
   root_library ^= Api::UnwrapHandle(lib);
 
   const Class& class_a = Class::Handle(GetClass(root_library, "A"));
   EXPECT(!class_a.IsNull());
 
   Dart_Handle result = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(result);
 
   {
-    Isolate* isolate = Isolate::Current();
-    StackZone zone(isolate);
-    HANDLESCOPE(isolate);
+    Thread* thread = Thread::Current();
+    Isolate* isolate = thread->isolate();
+    StackZone zone(thread);
+    HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate, class_a.id());
     profile.Build(&filter, Profile::kNoTags);
     // We should have no allocation samples.
     EXPECT_EQ(0, profile.sample_count());
   }
 
   // Turn on allocation tracing for A.
   class_a.SetTraceAllocation(true);
 
   // Allocate three times.
   result = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(result);
   result = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(result);
   result = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(result);
 
   {
-    Isolate* isolate = Isolate::Current();
-    StackZone zone(isolate);
-    HANDLESCOPE(isolate);
+    Thread* thread = Thread::Current();
+    Isolate* isolate = thread->isolate();
+    StackZone zone(thread);
+    HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate, class_a.id());
     profile.Build(&filter, Profile::kNoTags);
     // We should have three allocation samples.
     EXPECT_EQ(3, profile.sample_count());
     ProfileTrieWalker walker(&profile);
 
     // Exclusive function: B.boo -> main.
     walker.Reset(Profile::kExclusiveFunction);
     // Move down from the root.
@@ skipping 628 matching lines @@
 
   // Compile "main".
   Dart_Handle result = Dart_Invoke(lib, NewString("main"), 0, NULL);
   EXPECT_VALID(result);
   // Compile "mainA".
   result = Dart_Invoke(lib, NewString("mainA"), 0, NULL);
   EXPECT_VALID(result);
   // At this point B.boo should be optimized and inlined B.foo and B.choo.
 
   {
-    Isolate* isolate = Isolate::Current();
-    StackZone zone(isolate);
-    HANDLESCOPE(isolate);
+    Thread* thread = Thread::Current();
+    Isolate* isolate = thread->isolate();
+    StackZone zone(thread);
+    HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate, class_a.id());
     profile.Build(&filter, Profile::kNoTags);
     // We should have no allocation samples.
     EXPECT_EQ(0, profile.sample_count());
   }
 
   // Turn on allocation tracing for A.
   class_a.SetTraceAllocation(true);
 
   // Allocate 50,000 instances of A.
   result = Dart_Invoke(lib, NewString("mainA"), 0, NULL);
   EXPECT_VALID(result);
 
   {
-    Isolate* isolate = Isolate::Current();
-    StackZone zone(isolate);
-    HANDLESCOPE(isolate);
+    Thread* thread = Thread::Current();
+    Isolate* isolate = thread->isolate();
+    StackZone zone(thread);
+    HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate, class_a.id());
     profile.Build(&filter, Profile::kNoTags);
     // We should have 50,000 allocation samples.
     EXPECT_EQ(50000, profile.sample_count());
     ProfileTrieWalker walker(&profile);
     // We have two code objects: mainA and B.boo.
     walker.Reset(Profile::kExclusiveCode);
     EXPECT(walker.Down());
     EXPECT_STREQ("B.boo", walker.CurrentName());
@@ skipping 78 matching lines @@
     EXPECT_STREQ("B.choo", walker.CurrentName());
     EXPECT_EQ(1, walker.SiblingCount());
     EXPECT_EQ(50000, walker.CurrentNodeTickCount());
     EXPECT_EQ(50000, walker.CurrentInclusiveTicks());
     EXPECT_EQ(50000, walker.CurrentExclusiveTicks());
     EXPECT(!walker.Down());
   }
 
   // Test code transition tags.
   {
-    Isolate* isolate = Isolate::Current();
-    StackZone zone(isolate);
-    HANDLESCOPE(isolate);
+    Thread* thread = Thread::Current();
+    Isolate* isolate = thread->isolate();
+    StackZone zone(thread);
+    HANDLESCOPE(thread);
     Profile profile(isolate);
     AllocationFilter filter(isolate, class_a.id());
     profile.Build(&filter,
                   Profile::kNoTags,
                   ProfilerService::kCodeTransitionTagsBit);
     // We should have 50,000 allocation samples.
     EXPECT_EQ(50000, profile.sample_count());
     ProfileTrieWalker walker(&profile);
     // We have two code objects: mainA and B.boo.
     walker.Reset(Profile::kExclusiveCode);
@@ skipping 55 matching lines @@
     EXPECT(walker.Down());
     EXPECT_STREQ("B.foo", walker.CurrentName());
     EXPECT(walker.Down());
     EXPECT_STREQ("B.choo", walker.CurrentName());
     EXPECT(walker.Down());
     EXPECT_STREQ("[Inline End]", walker.CurrentName());
     EXPECT(!walker.Down());
   }
 }
 
+
+TEST_CASE(Profiler_ChainedSamples) {
+  MaxProfileDepthScope mpds(32);
+  // 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"
+      "class B {\n"
+      "  static boo() {\n"
+      "    return new A();\n"
+      "  }\n"
+      "}\n"
+      "go() => init();\n"
+      "init() => secondInit();\n"
+      "secondInit() => apple();\n"
+      "apple() => banana();\n"
+      "banana() => cantaloupe();\n"
+      "cantaloupe() => dog();\n"
+      "dog() => elephant();\n"
+      "elephant() => fred();\n"
+      "fred() => granola();\n"
+      "granola() => haystack();\n"
+      "haystack() => ice();\n"
+      "ice() => jeep();\n"
+      "jeep() => kindle();\n"
+      "kindle() => lemon();\n"
+      "lemon() => mayo();\n"
+      "mayo() => napkin();\n"
+      "napkin() => orange();\n"
+      "orange() => B.boo();\n"
+      "main() {\n"
+      "  return go();\n"
+      "}\n";
+
+  Dart_Handle lib = TestCase::LoadTestScript(kScript, NULL);
+  EXPECT_VALID(lib);
+  Library& root_library = Library::Handle();
+  root_library ^= Api::UnwrapHandle(lib);
+
+  const Class& class_a = Class::Handle(GetClass(root_library, "A"));
+  EXPECT(!class_a.IsNull());
+  class_a.SetTraceAllocation(true);
+
+  Dart_Handle result = Dart_Invoke(lib, NewString("main"), 0, NULL);
+  EXPECT_VALID(result);
+
+
+  {
+    Thread* thread = Thread::Current();
+    Isolate* isolate = thread->isolate();
+    StackZone zone(thread);
+    HANDLESCOPE(thread);
+    Profile profile(isolate);
+    AllocationFilter filter(isolate, class_a.id());
+    profile.Build(&filter, Profile::kNoTags);
+    // We should have 1 allocation sample.
+    EXPECT_EQ(1, profile.sample_count());
+    ProfileTrieWalker walker(&profile);
+
+    walker.Reset(Profile::kExclusiveCode);
+    // Move down from the root.
+    EXPECT(walker.Down());
+    EXPECT_STREQ("B.boo", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("orange", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("napkin", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("mayo", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("lemon", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("kindle", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("jeep", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("ice", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("haystack", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("granola", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("fred", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("elephant", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("dog", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("cantaloupe", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("banana", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("apple", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("secondInit", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("init", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("go", walker.CurrentName());
+    EXPECT(walker.Down());
+    EXPECT_STREQ("main", walker.CurrentName());
+    EXPECT(!walker.Down());
+  }
+}
+
 }  // namespace dart