Add Function based profile tree

runtime/vm/profiler.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/address_sanitizer.h"
 #include "platform/memory_sanitizer.h"
 #include "platform/utils.h"
 
 #include "vm/allocation.h"
 #include "vm/atomic.h"
 #include "vm/code_patcher.h"
+#include "vm/instructions.h"
 #include "vm/isolate.h"
 #include "vm/json_stream.h"
 #include "vm/lockers.h"
 #include "vm/native_symbol.h"
 #include "vm/object.h"
 #include "vm/os.h"
 #include "vm/profiler.h"
 #include "vm/reusable_handles.h"
 #include "vm/signal_handler.h"
 #include "vm/simulator.h"
 #include "vm/stack_frame.h"
 
 namespace dart {
 
 
 #if defined(TARGET_OS_ANDROID) || defined(HOST_ARCH_ARM64)
   DEFINE_FLAG(bool, profile, false, "Enable Sampling Profiler");
 #else
   DEFINE_FLAG(bool, profile, true, "Enable Sampling Profiler");
 #endif
 DEFINE_FLAG(bool, trace_profiled_isolates, false, "Trace profiled isolates.");
-DEFINE_FLAG(bool, trace_profiler, false, "Trace profiler.");
 DEFINE_FLAG(int, profile_period, 1000,
             "Time between profiler samples in microseconds. Minimum 50.");
 DEFINE_FLAG(int, profile_depth, 8,
             "Maximum number stack frames walked. Minimum 1. Maximum 255.");
 #if defined(PROFILE_NATIVE_CODE) || defined(USING_SIMULATOR)
 DEFINE_FLAG(bool, profile_vm, true,
             "Always collect native stack traces.");
 #else
 DEFINE_FLAG(bool, profile_vm, false,
             "Always collect native stack traces.");
@@ skipping 202 matching lines @@
 
 Sample* SampleBuffer::ReserveSample() {
   ASSERT(samples_ != NULL);
   uintptr_t cursor = AtomicOperations::FetchAndIncrement(&cursor_);
   // Map back into sample buffer range.
   cursor = cursor % capacity_;
   return At(cursor);
 }
 
 
-static void SetPCMarkerIfSafe(Sample* sample) {
-  ASSERT(sample != NULL);
-
-  uword* fp = reinterpret_cast<uword*>(sample->fp());
-  uword* sp = reinterpret_cast<uword*>(sample->sp());
-
-  // If FP == SP, the pc marker hasn't been pushed.
-  if (fp > sp) {
-#if defined(TARGET_OS_WINDOWS)
-    // If the fp is at the beginning of a page, it may be unsafe to access
-    // the pc marker, because we are reading it from a different thread on
-    // Windows. The marker is below fp and the previous page may be a guard
-    // page.
-    const intptr_t kPageMask = VirtualMemory::PageSize() - 1;
-    if ((sample->fp() & kPageMask) == 0) {
+// Used to locate the stack slot in Dart code that contains the return address.
+// NOTE: Only handles the prologue.
+// NOTE: Architecture specific implementations below.
+class ReturnAddressLocator : public ValueObject {
+ public:
+  ReturnAddressLocator(uword pc, const Code& code)
+      : pc_(pc),
+        code_(Code::ZoneHandle(code.raw())),
+        is_optimized_(code.is_optimized()) {
+    ASSERT(!code_.IsNull());
+    ASSERT(code_.ContainsInstructionAt(pc_));
+  }
+
+  bool is_code_optimized() {
+    return is_optimized_;
+  }
+
+  // Returns -1 on failure.
+  intptr_t ReturnAddressRelativeToSP();
+
+  // Returns offset into code object.
+  uword RelativePC() {
+    return pc_ - code_.EntryPoint();
+  }
+
+  uint8_t* CodePointer(uword offset) {
+    const uword size = code_.Size();
+    ASSERT(offset < size);
+    uint8_t* code_pointer = reinterpret_cast<uint8_t*>(code_.EntryPoint());
+    code_pointer += offset;
+    return code_pointer;
+  }
+
+ private:
+  const uword pc_;
+  const Code& code_;
+  const bool is_optimized_;
+};
+
+
+#if defined(TARGET_ARCH_IA32)
+intptr_t ReturnAddressLocator::ReturnAddressRelativeToSP() {
+  const uword offset = RelativePC();
+  const uword size = code_.Size();
+  if (is_optimized_) {
+    // 0: push ebp
+    // 1: mov ebp, esp
+    // 3: ...
+    if (offset == 0x0) {
+      // Stack layout:
+      // 0 RETURN ADDRESS.
+      return 0;
+    }
+    if (offset == 0x1) {
+      // Stack layout:
+      // 0 CALLER FRAME POINTER
+      // 1 RETURN ADDRESS
+      return 1;
+    }
+    return -1;
+  } else {
+    // 0x00: mov edi, function
+    // 0x05: incl (inc usage count)   <-- this is optional.
+    // 0x08: cmpl (compare usage count)
+    // 0x0f: jump to optimize function
+    // 0x15: push ebp
+    // 0x16: mov ebp, esp
+    // 0x18: ...
+    ASSERT(size >= 0x08);
+    const uword incl_offset = 0x05;
+    const uword incl_length = 0x03;
+    const uint8_t incl_op_code = 0xFF;
+    const bool has_incl = (*CodePointer(incl_offset) == incl_op_code);
+    const uword push_fp_offset = has_incl ? 0x15 : 0x15 - incl_length;
+    if (offset <= push_fp_offset) {
+      // Stack layout:
+      // 0 RETURN ADDRESS.
+      return 0;
+    }
+    if (offset == (push_fp_offset + 1)) {
+      // Stack layout:
+      // 0 CALLER FRAME POINTER
+      // 1 RETURN ADDRESS
+      return 1;
+    }
+    return -1;
+  }
+  UNREACHABLE();
+  return -1;
+}
+#elif defined(TARGET_ARCH_X64)
+intptr_t ReturnAddressLocator::ReturnAddressRelativeToSP() {
+  const uword offset = RelativePC();
+  const uword size = code_.Size();
+  if (is_optimized_) {
+    // 0x00: leaq (load pc marker)
+    // 0x07: movq (load pool pointer)
+    // 0x0c: push rpb
+    // 0x0d: movq rbp, rsp
+    // 0x10: ...
+    const uword push_fp_offset = 0x0c;
+    if (offset <= push_fp_offset) {
+      // Stack layout:
+      // 0 RETURN ADDRESS.
+      return 0;
+    }
+    if (offset == (push_fp_offset + 1)) {
+      // Stack layout:
+      // 0 CALLER FRAME POINTER
+      // 1 RETURN ADDRESS
+      return 1;
+    }
+    return -1;
+  } else {
+    // 0x00: leaq (load pc marker)
+    // 0x07: movq (load pool pointer)
+    // 0x0c: movq (load function)
+    // 0x13: incl (inc usage count)   <-- this is optional.
+    // 0x16: cmpl (compare usage count)
+    // 0x1d: jl + 0x
+    // 0x23: jmp [pool pointer]
+    // 0x27: push rbp
+    // 0x28: movq rbp, rsp
+    // 0x2b: ...
+    ASSERT(size >= 0x16);
+    const uword incl_offset = 0x13;
+    const uword incl_length = 0x03;
+    const uint8_t incl_op_code = 0xFF;
+    const bool has_incl = (*CodePointer(incl_offset) == incl_op_code);
+    const uword push_fp_offset = has_incl ? 0x27 : 0x27 - incl_length;
+    if (offset <= push_fp_offset) {
+      // Stack layout:
+      // 0 RETURN ADDRESS.
+      return 0;
+    }
+    if (offset == (push_fp_offset + 1)) {
+      // Stack layout:
+      // 0 CALLER FRAME POINTER
+      // 1 RETURN ADDRESS
+      return 1;
+    }
+    return -1;
+  }
+  UNREACHABLE();
+  return -1;
+}
+#elif defined(TARGET_ARCH_ARM)
+intptr_t ReturnAddressLocator::ReturnAddressRelativeToSP() {
+  return -1;
+}
+#elif defined(TARGET_ARCH_ARM64)
+intptr_t ReturnAddressLocator::ReturnAddressRelativeToSP() {
+  return -1;
+}
+#elif defined(TARGET_ARCH_MIPS)
+intptr_t ReturnAddressLocator::ReturnAddressRelativeToSP() {
+  return -1;
+}
+#else
+#error ReturnAddressLocator implementation missing for this architecture.
+#endif
+
+
+FixTopFrameVisitor::FixTopFrameVisitor(Isolate* isolate)
+    : SampleVisitor(isolate),
+      vm_isolate_(Dart::vm_isolate()) {
+}
+
+
+void FixTopFrameVisitor::VisitSample(Sample* sample) {
+  if (sample->processed()) {
+    // Already processed.
+    return;
+  }
+  REUSABLE_CODE_HANDLESCOPE(isolate());
+  // Mark that we've processed this sample.
+  sample->set_processed(true);
+  // Lookup code object for leaf frame.
+  Code& code = reused_code_handle.Handle();
+  code = FindCodeForPC(sample->At(0));
+  sample->set_leaf_frame_is_dart(!code.IsNull());
+  if (!code.IsNull() && (code.compile_timestamp() > sample->timestamp())) {
+    // Code compiled after sample. Ignore.
+    return;
+  }
+  if (sample->leaf_frame_is_dart()) {
+    CheckForMissingDartFrame(code, sample);
+  }
+}
+
+
+void FixTopFrameVisitor::CheckForMissingDartFrame(const Code& code,
+                                                  Sample* sample) const {
+  // Some stubs (and intrinsics) do not push a frame onto the stack leaving
+  // the frame pointer in the caller.
+  //
+  // PC -> STUB
+  // FP -> DART3  <-+
+  //       DART2  <-|  <- TOP FRAME RETURN ADDRESS.
+  //       DART1  <-|
+  //       .....
+  //
+  // In this case, traversing the linked stack frames will not collect a PC
+  // inside DART3. The stack will incorrectly be: STUB, DART2, DART1.
+  // In Dart code, after pushing the FP onto the stack, an IP in the current
+  // function is pushed onto the stack as well. This stack slot is called
+  // the PC marker. We can use the PC marker to insert DART3 into the stack
+  // so that it will correctly be: STUB, DART3, DART2, DART1. Note the
+  // inserted PC may not accurately reflect the true return address into DART3.
+  ASSERT(!code.IsNull());
+
+  // The pc marker is our current best guess of a return address.
+  uword return_address = sample->pc_marker();
+
+  // Attempt to find a better return address.
+  ReturnAddressLocator ral(sample->At(0), code);
+  ReturnPattern rp(sample->At(0));
+
+  intptr_t return_address_slot = ral.ReturnAddressRelativeToSP();
+  if (return_address_slot != -1) {
+    // In prologue, located the return address.
+    ASSERT(return_address_slot >= 0);
+    ASSERT(return_address_slot < Sample::kStackBufferSizeInWords);
+    return_address = sample->GetStackBuffer()[return_address_slot];
+  } else if (rp.IsValid()) {
+    // In epilogue, located the return address.
+    return_address = sample->possible_return_address();
+  } else {
+    // Could not find a better return address than the pc_marker.
+    if (code.ContainsInstructionAt(return_address)) {
+      // PC marker is in the same code as pc, no missing frame.
       return;
     }
-#endif
-    uword* pc_marker_ptr = fp + kPcMarkerSlotFromFp;
-    // MSan/ASan are unaware of frames initialized by generated code.
-    MSAN_UNPOISON(pc_marker_ptr, kWordSize);
-    ASAN_UNPOISON(pc_marker_ptr, kWordSize);
-    sample->set_pc_marker(*pc_marker_ptr);
-  }
+  }
+
+  if (return_address != 0) {
+    sample->InsertCallerForTopFrame(return_address);
+  }
+}
+
+
+bool FixTopFrameVisitor::ContainedInDartCodeHeaps(uword pc) const {
+  return isolate()->heap()->CodeContains(pc) ||
+         vm_isolate()->heap()->CodeContains(pc);
+}
+
+
+RawCode* FixTopFrameVisitor::FindCodeForPC(uword pc) const {
+  // Check current isolate for pc.
+  if (isolate()->heap()->CodeContains(pc)) {
+    return Code::LookupCode(pc);
+  }
+  // Check VM isolate for pc.
+  if (vm_isolate()->heap()->CodeContains(pc)) {
+    return Code::LookupCodeInVmIsolate(pc);
+  }
+  return Code::null();
 }
 
 
 // Given an exit frame, walk the Dart stack.
 class ProfilerDartExitStackWalker : public ValueObject {
  public:
   ProfilerDartExitStackWalker(Isolate* isolate, Sample* sample)
       : sample_(sample),
         frame_iterator_(isolate) {
     ASSERT(sample_ != NULL);
@@ skipping 278 matching lines @@
 
   Sample* sample_;
   const uword stack_upper_;
   const uword original_pc_;
   const uword original_fp_;
   const uword original_sp_;
   uword lower_bound_;
 };
 
 
+static void SetPCMarkerIfSafe(Sample* sample) {
+  ASSERT(sample != NULL);
+
+  uword* fp = reinterpret_cast<uword*>(sample->fp());
+  uword* sp = reinterpret_cast<uword*>(sample->sp());
+
+  // If FP == SP, the pc marker hasn't been pushed.
+  if (fp > sp) {
+#if defined(TARGET_OS_WINDOWS)
+    // If the fp is at the beginning of a page, it may be unsafe to access
+    // the pc marker, because we are reading it from a different thread on
+    // Windows. The marker is below fp and the previous page may be a guard
+    // page.
+    const intptr_t kPageMask = VirtualMemory::PageSize() - 1;
+    if ((sample->fp() & kPageMask) == 0) {
+      return;
+    }
+#endif
+    uword* pc_marker_ptr = fp + kPcMarkerSlotFromFp;
+    // MSan/ASan are unaware of frames initialized by generated code.
+    MSAN_UNPOISON(pc_marker_ptr, kWordSize);
+    ASAN_UNPOISON(pc_marker_ptr, kWordSize);
+    sample->set_pc_marker(*pc_marker_ptr);
+  }
+}
+
+
+static void GrabPossibleReturnValue(Sample* sample) {
+  ASSERT(sample != NULL);
+  // On other architectures possible_return_address is filled in from a
+  // register that was captured by the signal handler.
+#if defined(TARGET_ARCH_X64) || defined(TARGET_ARCH_IA32) || \
+    defined(USING_SIMULATOR)
+  uword* sp = reinterpret_cast<uword*>(sample->sp());
+  if (sp != NULL) {
+    sample->set_possible_return_address(*sp);
+  }
+#endif
+}
+
+
+static void FillStackBuffer(Sample* sample) {
+  ASSERT(sample != NULL);
+  uword* sp = reinterpret_cast<uword*>(sample->sp());
+  uword* stack_buffer = sample->GetStackBuffer();
+  if (sp != NULL) {
+    for (intptr_t i = 0; i < Sample::kStackBufferSizeInWords; i++) {
+      stack_buffer[i] = *sp;
+      sp++;
+    }
+  }
+}
+
+
 void Profiler::RecordSampleInterruptCallback(
     const InterruptedThreadState& state,
     void* data) {
   Isolate* isolate = reinterpret_cast<Isolate*>(data);
   if ((isolate == NULL) || (Dart::vm_isolate() == NULL)) {
     // No isolate.
     return;
   }
 
   ASSERT(isolate != Dart::vm_isolate());
@@ skipping 84 matching lines @@
   }
 #endif
   // Increment counter for vm tag.
   VMTagCounters* counters = isolate->vm_tag_counters();
   ASSERT(counters != NULL);
   counters->Increment(vm_tag);
   sample->set_vm_tag(vm_tag);
   sample->set_user_tag(isolate->user_tag());
   sample->set_sp(sp);
   sample->set_fp(state.fp);
+  sample->set_possible_return_address(state.ra);
+  GrabPossibleReturnValue(sample);
+  FillStackBuffer(sample);
 #if !(defined(TARGET_OS_WINDOWS) && defined(TARGET_ARCH_X64))
   // It is never safe to read other thread's stack unless on Win64
   // other thread is inside Dart code.
   SetPCMarkerIfSafe(sample);
 #endif
 
   // Walk the call stack.
   if (FLAG_profile_vm) {
     // Always walk the native stack collecting both native and Dart frames.
     ProfilerNativeStackWalker stackWalker(sample,
@@ skipping 37 matching lines @@
                                             state.pc,
                                             state.fp,
                                             sp);
       stackWalker.walk();
 #endif
     }
   }
 }
 
 }  // namespace dart