Track async causal stack traces

runtime/vm/flow_graph_builder.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/flow_graph_builder.h"
 
 #include "lib/invocation_mirror.h"
 #include "vm/ast_printer.h"
 #include "vm/bit_vector.h"
 #include "vm/compiler.h"
@@ skipping 1113 matching lines @@
     // However, factories may create an instance of the wrong type.
     if (!is_implicit_dynamic_getter && !function.IsGenerativeConstructor()) {
       const AbstractType& dst_type =
           AbstractType::ZoneHandle(Z, function.result_type());
       return_value =
           BuildAssignableValue(node->value()->token_pos(), return_value,
                                dst_type, Symbols::FunctionResult());
     }
   }
 
+  if (function.IsAsyncClosure() || function.IsAsyncGenClosure()) {

[rmacnak, 2017/01/26 18:05:57]

&& FLAG_sane_async_stacks

[Cutch, 2017/01/31 23:45:31]

Done.

+    // We are returning from an asynchronous closure. Before we do that, be
+    // sure to clear the thread's asynchronous stack trace.
+    const Library& async_lib = Library::Handle(Library::AsyncLibrary());
+    ASSERT(!async_lib.IsNull());
+    const String& private_name = String::ZoneHandle(
+        async_lib.PrivateName(Symbols::ClearAsyncThreadStackTrace()));
+    ASSERT(!private_name.IsNull());
+    const Function& async_clear_thread_stack_trace = Function::ZoneHandle(
+        Z,
+        Resolver::ResolveStatic(async_lib, String::ZoneHandle(String::null()),

[rmacnak, 2017/01/26 18:05:57]

It might be worth caching the three helper functions in
ObjectStore::InitKnownObjects.

[Cutch, 2017/01/31 23:45:31]

Done.

+                                private_name, 0, Object::null_array()));
+    ASSERT(!async_clear_thread_stack_trace.IsNull());
+    // Mark that this function is not debuggable.
+    async_clear_thread_stack_trace.set_is_debuggable(false);

[rmacnak, 2017/01/26 18:05:57]

I thought we can't step into native functions anyway.

[Cutch, 2017/01/31 23:45:30]

Acknowledged.

+    ZoneGrowableArray<PushArgumentInstr*>* no_arguments =
+        new (Z) ZoneGrowableArray<PushArgumentInstr*>(0);
+    StaticCallInstr* call_async_clear_thread_stack_trace = new (Z)
+        StaticCallInstr(node->token_pos().ToSynthetic(),
+                        async_clear_thread_stack_trace, Object::null_array(),
+                        no_arguments, owner()->ic_data_array());
+    Do(call_async_clear_thread_stack_trace);
+  }
+
   // Async functions contain two types of return statements:
   // 1) Returns that should complete the completer once all finally blocks have
   //    been inlined (call: :async_completer.complete(return_value)). These
   //    returns end up returning null in the end.
   // 2) "Continuation" returns that should not complete the completer but return
   //    the value.
   //
   // We distinguish those kinds of nodes via is_regular_return().
   //
   if (function.IsAsyncClosure() &&
@@ skipping 2636 matching lines @@
           // the function.
           Value* null_constant = Bind(
               new (Z) ConstantInstr(Object::ZoneHandle(Z, Object::null())));
           Do(BuildStoreLocal(*temp_local, null_constant,
                              ST(node->token_pos())));
         }
       }
     }
   }
 
+  if (is_top_level_sequence &&
+      (function.IsAsyncClosure() || function.IsAsyncGenClosure())) {

[rmacnak, 2017/01/26 18:05:57]

&& FLAG_sane_async_stacks

[Cutch, 2017/01/31 23:45:30]

Done.

+    LocalScope* top_scope = node->scope();
+    // Fetch the :async_stack_trace variable and store it into the thread.
+    LocalVariable* async_stack_trace_var =
+        top_scope->LookupVariable(Symbols::AsyncStackTraceVar(), false);
+    ASSERT((async_stack_trace_var != NULL) &&
+           async_stack_trace_var->is_captured());
+    // Load :async_stack_trace
+    Value* async_stack_trace_value = Bind(BuildLoadLocal(
+        *async_stack_trace_var, node->token_pos().ToSynthetic()));
+    // Setup arguments for _asyncSetThreadStackTrace.
+    ZoneGrowableArray<PushArgumentInstr*>* arguments =
+        new (Z) ZoneGrowableArray<PushArgumentInstr*>(1);
+    arguments->Add(PushArgument(async_stack_trace_value));
+
+    // Lookup _asyncSetThreadStackTrace
+    const Library& async_lib = Library::Handle(Library::AsyncLibrary());
+    ASSERT(!async_lib.IsNull());
+    const String& private_name = String::ZoneHandle(
+        async_lib.PrivateName(Symbols::SetAsyncThreadStackTrace()));
+    ASSERT(!private_name.IsNull());
+    const Function& async_set_thread_stack_trace = Function::ZoneHandle(
+        Z,
+        Resolver::ResolveStatic(async_lib, String::ZoneHandle(String::null()),
+                                private_name, 1, Object::null_array()));

[siva, 2017/01/26 19:26:23]

Agree with Ryan might be worth caching these functions.

[Cutch, 2017/01/31 23:45:30]

Done.

+    ASSERT(!async_set_thread_stack_trace.IsNull());
+    // Mark that this function is not debuggable.
+    async_set_thread_stack_trace.set_is_debuggable(false);
+    // Call _asyncSetThreadStackTrace
+    StaticCallInstr* call_async_set_thread_stack_trace = new (Z)
+        StaticCallInstr(node->token_pos().ToSynthetic(),
+                        async_set_thread_stack_trace, Object::null_array(),
+                        arguments, owner()->ic_data_array());
+    Do(call_async_set_thread_stack_trace);
+  }
+
+
   if (FLAG_support_debugger && is_top_level_sequence &&
       function.is_debuggable()) {
     // Place a debug check at method entry 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 = function.NumParameters();
     TokenPosition check_pos = TokenPosition::kNoSource;
     if (num_params > 0) {
       const LocalVariable& parameter = *scope->VariableAt(num_params - 1);
@@ skipping 533 matching lines @@
       graph_entry_->PruneUnreachable(graph_entry_, NULL, osr_id_, block_marks);
   ASSERT(found);
 }
 
 
 void FlowGraphBuilder::Bailout(const char* reason) const {
   parsed_function_.Bailout("FlowGraphBuilder", reason);
 }
 
 }  // namespace dart