Enable causal stacktrace in kernel

runtime/vm/kernel_to_il.cc

 // Copyright (c) 2016, 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 <map>
 #include <set>
 #include <string>
 
 #include "vm/kernel_to_il.h"
 
@@ skipping 702 matching lines @@
           (depth_.function_ == 0) ? &result_->yield_context_variable : &temp,
           Symbols::AwaitContextVar());
     }
     {
       LocalVariable* temp =
           scope_->LookupVariable(Symbols::AsyncOperation(), true);
       if (temp != NULL) {
         scope_->CaptureVariable(temp);
       }
     }
+    if (FLAG_causal_async_stacks) {
+      LocalVariable* temp =
+          scope_->LookupVariable(Symbols::AsyncStackTraceVar(), true);
+      if (temp != NULL) {
+        scope_->CaptureVariable(temp);
+      }
+    }
   }
 }
 
 
 void ScopeBuilder::VisitYieldStatement(YieldStatement* node) {
   ASSERT(node->is_native());
   if (depth_.function_ == 0) {
     AddSwitchVariable();
     // Promote all currently visible local variables into the context.
     // TODO(27590) CaptureLocalVariables promotes to many variables into
@@ skipping 1815 matching lines @@
   Value* value = Pop();
   ASSERT(stack_ == NULL);
 
   const Function& function = parsed_function_->function();
   if (FLAG_support_debugger && position.IsDebugPause() &&
       !function.is_native()) {
     instructions <<=
         new (Z) DebugStepCheckInstr(position, RawPcDescriptors::kRuntimeCall);
   }
 
+  if (FLAG_causal_async_stacks &&
+      function.name() == Symbols::AsyncOperation().raw()) {
+    // We are returning from an asynchronous closure. Before we do that, be
+    // sure to clear the thread's asynchronous stack trace.
+    const Function& async_clear_thread_stack_trace = Function::ZoneHandle(
+        Z, I->object_store()->async_clear_thread_stack_trace());
+    ZoneGrowableArray<PushArgumentInstr*>* no_arguments =
+        new (Z) ZoneGrowableArray<PushArgumentInstr*>(0);
+    StaticCallInstr* call_async_clear_thread_stack_trace = new (Z)
+        StaticCallInstr(TokenPosition::kNoSource,
+                        async_clear_thread_stack_trace, Object::null_array(),
+                        no_arguments, ic_data_array_);
+    instructions <<= call_async_clear_thread_stack_trace;

[kustermann, 2017/02/14 14:45:53]

Could you rewrite this using our helper functions, something like this:

  // We are returning from an asynchronous closure. Before we do that, be
  // sure to clear the thread's asynchronous stack trace.
  const Function& target = Function::ZoneHandle(
      Z, I->object_store()->async_clear_thread_stack_trace());
  instructions += StaticCall(TokenPosition::kNoSource, target, 0);

?

[jensj, 2017/02/15 11:29:53]

Done.

+  }
+
   ReturnInstr* return_instr = new (Z) ReturnInstr(position, value);
   if (exit_collector_ != NULL) exit_collector_->AddExit(return_instr);
 
   instructions <<= return_instr;
 
   return instructions.closed();
 }
 
 
 Fragment FlowGraphBuilder::StaticCall(TokenPosition position,
@@ skipping 662 matching lines @@
 
       // False branch will contain the next comparison.
       dispatch = Fragment(dispatch.entry, otherwise);
       block = otherwise;
     }
     body = dispatch;
 
     context_depth_ = current_context_depth;
   }
 
+  if (FLAG_causal_async_stacks &&
+      dart_function.name() == Symbols::AsyncOperation().raw()) {
+    // The code we are building will be executed right after we enter
+    // the function and before any nested contexts are allocated.
+    // Reset current context_depth_ to match this.
+    intptr_t current_context_depth = context_depth_;

[kustermann, 2017/02/14 14:45:53]

nit: const (maybe also from the code you copied it from)

[jensj, 2017/02/15 11:29:53]

Done.

+    context_depth_ = scopes_->yield_jump_variable->owner()->context_level();
+
+    Fragment instructions;
+    LocalScope* scope = parsed_function_->node_sequence()->scope();
+    // Fetch the :async_stack_trace variable and store it into the thread.

[kustermann, 2017/02/14 14:45:53]

Could you add empty lines before comments like this, would make it much easier
to read. (also below)

[jensj, 2017/02/15 11:29:53]

Done.

+    LocalVariable* async_stack_trace_var =
+        scope->LookupVariable(Symbols::AsyncStackTraceVar(), false);
+    ASSERT((async_stack_trace_var != NULL) &&
+           async_stack_trace_var->is_captured());
+    // Load :async_stack_trace
+    instructions += LoadLocal(async_stack_trace_var);
+    instructions += PushArgument();
+    // Setup arguments for _asyncSetThreadStackTrace.
+    ArgumentArray arguments = GetArguments(1);
+
+    const Function& async_set_thread_stack_trace = Function::ZoneHandle(
+        Z, I->object_store()->async_set_thread_stack_trace());
+    ASSERT(!async_set_thread_stack_trace.IsNull());
+    // Call _asyncSetThreadStackTrace
+    StaticCallInstr* call_async_set_thread_stack_trace = new (Z)
+        StaticCallInstr(TokenPosition::kNoSource, async_set_thread_stack_trace,
+                        Object::null_array(), arguments, ic_data_array_);
+    instructions <<= call_async_set_thread_stack_trace;
+    body = instructions + body;

[kustermann, 2017/02/14 14:45:53]

Could you also use StaticCall here

i.e. replace most of this with 

  const Function& target = Function::ZoneHandle(Z, 
      I->object_store()->async_set_thread_stack_trace());

  LocalVariable* async_stack_trace_var =
      scope->LookupVariable(Symbols::AsyncStackTraceVar(), false);

  instructions += LoadLocal(async_stack_trace_var);
  instructions += PushArgument();
  instructions += StaticCall(TokenPosition::kNoSource, target, 1);
?

[jensj, 2017/02/15 11:29:53]

Done.

+    context_depth_ = current_context_depth;
+  }
+
   if (FLAG_support_debugger && function->position().IsDebugPause() &&
       !dart_function.is_native() && dart_function.is_debuggable()) {
     // If a switch was added above: Start the switch by injecting a debugable
     // safepoint so stepping over an await works.
     // If not, still start the body with a debugable safepoint to ensure
     // breaking on a method always happens, even if there are no
     // assignments/calls/runtimecalls in the first basic block.
     // Place this check at the last parameter to ensure parameters
     // are in scope in the debugger at method entry.
     const int num_params = dart_function.NumParameters();
@@ skipping 3030 matching lines @@
     thread->clear_sticky_error();
     return error.raw();
   }
 }
 
 
 }  // namespace kernel
 }  // namespace dart
 
 #endif  // !defined(DART_PRECOMPILED_RUNTIME)