Allow StackFrameIterator to be used on a different thread than the isolate whose stack frames are b…

runtime/vm/stack_frame.cc

 // Copyright (c) 2012, 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 "vm/stack_frame.h"
 
 #include "vm/assembler.h"
 #include "vm/deopt_instructions.h"
 #include "vm/isolate.h"
 #include "vm/object.h"
@@ skipping 10 matching lines @@
 
 bool StackFrame::IsStubFrame() const {
   ASSERT(!(IsEntryFrame() || IsExitFrame()));
   uword saved_pc =
       *(reinterpret_cast<uword*>(fp() + (kPcMarkerSlotFromFp * kWordSize)));
   return (saved_pc == 0);
 }
 
 
 const char* StackFrame::ToCString() const {
+  ASSERT(isolate_ == Isolate::Current());
   Zone* zone = Isolate::Current()->current_zone();
   if (IsDartFrame()) {
     const Code& code = Code::Handle(LookupDartCode());
     ASSERT(!code.IsNull());
     const Object& owner = Object::Handle(code.owner());
     ASSERT(!owner.IsNull());
     if (owner.IsFunction()) {
       const Function& function = Function::Cast(owner);
       return zone->PrintToString(
           "[%-8s : sp(%#" Px ") fp(%#" Px ") pc(%#" Px ") %s ]",
@@ skipping 18 matching lines @@
 }
 
 
 RawContext* EntryFrame::SavedContext() const {
   return *(reinterpret_cast<RawContext**>(
       fp() + (kSavedContextSlotFromEntryFp * kWordSize)));
 }
 
 
 void EntryFrame::VisitObjectPointers(ObjectPointerVisitor* visitor) {
+  ASSERT(isolate() == Isolate::Current());
   // Visit objects between SP and (FP - callee_save_area).
   ASSERT(visitor != NULL);
   RawObject** first = reinterpret_cast<RawObject**>(sp());
   RawObject** last = reinterpret_cast<RawObject**>(
       fp() + (kExitLinkSlotFromEntryFp - 1) * kWordSize);
   visitor->VisitPointers(first, last);
 }
 
 
 void StackFrame::VisitObjectPointers(ObjectPointerVisitor* visitor) {
   // NOTE: This code runs while GC is in progress and runs within
   // a NoHandleScope block. Hence it is not ok to use regular Zone or
   // Scope handles. We use direct stack handles, the raw pointers in
   // these handles are not traversed. The use of handles is mainly to
   // be able to reuse the handle based code and avoid having to add
   // helper functions to the raw object interface.
+  ASSERT(isolate_ == Isolate::Current());
   ASSERT(visitor != NULL);
   NoGCScope no_gc;
   Code code;
   code = LookupDartCode();
   if (!code.IsNull()) {
     // Visit the code object.
     RawObject* raw_code = code.raw();
     visitor->VisitPointer(&raw_code);
 
     // Optimized frames have a stack map. We need to visit the frame based
@@ skipping 57 matching lines @@
   // For normal unoptimized Dart frames and Stub frames each slot
   // between the first and last included are tagged objects.
   RawObject** first = reinterpret_cast<RawObject**>(sp());
   RawObject** last = reinterpret_cast<RawObject**>(
       fp() + (kFirstObjectSlotFromFp * kWordSize));
   visitor->VisitPointers(first, last);
 }
 
 
 RawFunction* StackFrame::LookupDartFunction() const {
+  ASSERT(isolate_ == Isolate::Current());
   const Code& code = Code::Handle(LookupDartCode());
   if (!code.IsNull()) {
     return code.function();
   }
   return Function::null();
 }
 
 
 RawCode* StackFrame::LookupDartCode() const {
+  ASSERT(isolate_ == Isolate::Current());
   // We add a no gc scope to ensure that the code below does not trigger
   // a GC as we are handling raw object references here. It is possible
   // that the code is called while a GC is in progress, that is ok.
   NoGCScope no_gc;
   RawCode* code = GetCodeObject();
   ASSERT(code == Code::null() || code->ptr()->owner_ != Function::null());
   return code;
 }
 
 
@@ skipping 90 matching lines @@
 
 void StackFrameIterator::SetupNextExitFrameData() {
   uword exit_address = entry_.fp() + (kExitLinkSlotFromEntryFp * kWordSize);
   uword exit_marker = *reinterpret_cast<uword*>(exit_address);
   frames_.fp_ = exit_marker;
   frames_.sp_ = 0;
   frames_.pc_ = 0;
 }
 
 
-StackFrameIterator::StackFrameIterator(bool validate)
-    : validate_(validate), entry_(), exit_(), current_frame_(NULL) {
+StackFrameIterator::StackFrameIterator(bool validate, Isolate* isolate)
+    : validate_(validate),
+      entry_(isolate),
+      exit_(isolate),
+      frames_(isolate),
+      current_frame_(NULL),
+      isolate_(isolate) {
+#if !defined(TARGET_OS_WINDOWS)
+  // On Windows, the call to InInvocationStub may be called from the thread
+  // suspender.

[siva, 2014/06/30 23:26:44]

This comment I feel should be more detailed explaining the use
case where the StackFrameIterator object can be constructed by
a thread whose current isolate is not the passed in isolate parameter.

[Cutch, 2014/07/01 14:26:09]

Done.

+  ASSERT(isolate_ == Isolate::Current());
+#endif

[siva, 2014/06/30 23:26:44]

The #ifdef looks weird here, maybe you could code the assert as

ASSERT((isolate_ == Isolate::Current()) ||
OS::AllowStackIterationFromAnotherThread());

which returns true in os_win.cc

[Cutch, 2014/07/01 14:26:09]

Done.

   SetupLastExitFrameData();  // Setup data for last exit frame.
 }
 
 
-StackFrameIterator::StackFrameIterator(uword last_fp, bool validate)
-    : validate_(validate), entry_(), exit_(), current_frame_(NULL) {
+StackFrameIterator::StackFrameIterator(uword last_fp, bool validate,
+                                       Isolate* isolate)
+    : validate_(validate),
+      entry_(isolate),
+      exit_(isolate),
+      frames_(isolate),
+      current_frame_(NULL),
+      isolate_(isolate) {
+#if !defined(TARGET_OS_WINDOWS)
+  // On Windows, the call to InInvocationStub may be called from the thread
+  // suspender.
+  ASSERT(isolate_ == Isolate::Current());
+#endif
   frames_.fp_ = last_fp;
   frames_.sp_ = 0;
   frames_.pc_ = 0;
 }
 
 
 StackFrameIterator::StackFrameIterator(uword fp, uword sp, uword pc,
-                                       bool validate)
-    : validate_(validate), entry_(), exit_(), current_frame_(NULL) {
+                                       bool validate, Isolate* isolate)
+    : validate_(validate),
+      entry_(isolate),
+      exit_(isolate),
+      frames_(isolate),
+      current_frame_(NULL),
+      isolate_(isolate) {
+#if !defined(TARGET_OS_WINDOWS)
+  // On Windows, the call to InInvocationStub may be called from the thread
+  // suspender.
+  ASSERT(isolate_ == Isolate::Current());
+#endif
   frames_.fp_ = fp;
   frames_.sp_ = sp;
   frames_.pc_ = pc;
 }
 
 
 StackFrame* StackFrameIterator::NextFrame() {
   // When we are at the start of iteration after having created an
   // iterator object, current_frame_ will be NULL as we haven't seen
   // any frames yet (unless we start iterating in the simulator from a given
@@ skipping 148 matching lines @@
     if (deopt_instr->kind() == DeoptInstr::kCallerFp) {
       return (index - num_materializations_);
     }
   }
   UNREACHABLE();
   return 0;
 }
 
 
 }  // namespace dart