Fix returning from async functions.

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/class_finalizer.h"
@@ skipping 1028 matching lines @@
 
   intptr_t current_context_level = owner()->context_level();
   ASSERT(current_context_level >= 0);
   if (owner()->parsed_function()->saved_entry_context_var() != NULL) {
     // CTX on entry was saved, but not linked as context parent.
     BuildRestoreContext(*owner()->parsed_function()->saved_entry_context_var());
   } else {
     UnchainContexts(current_context_level);
   }
 
+  // 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.
+  //
+  // We distinguish those types by whether a scope() has been set or not.

[hausner, 2014/08/12 20:51:26]

Is it possible to have a return without a sequence node? As soon as you insert a
ReturnNode into a SequenceNode, it will have a scope...

[Michael Lippautz (Google), 2014/08/12 21:13:57]

True. I added a flag for this that is always true for now. Once we add the
"continuation" returns this flag will differentiate those kinds of returns. 

+  //
+  if (function.is_async_closure() && node->scope() != NULL) {
+    // Temporary store the computed return value.
+    Do(BuildStoreExprTemp(return_value));
+
+    LocalVariable* rcv_var = node->scope()->LookupVariable(
+        Symbols::AsyncCompleter(), false);
+    ASSERT(rcv_var != NULL && rcv_var->is_captured());
+    Value* rcv_value = Bind(BuildLoadLocal(*rcv_var));
+    Value* returned_value = Bind(BuildLoadExprTemp());
+    ZoneGrowableArray<PushArgumentInstr*>* arguments =
+        new(I) ZoneGrowableArray<PushArgumentInstr*>(2);
+    arguments->Add(PushArgument(rcv_value));
+    arguments->Add(PushArgument(returned_value));
+    InstanceCallInstr* call = new(I) InstanceCallInstr(
+        Scanner::kNoSourcePos,
+        Symbols::CompleterComplete(),
+        Token::kILLEGAL,
+        arguments,
+        Object::null_array(),
+        1,
+        owner()->ic_data_array());
+    Do(call);
+
+    // Rebind the return value for the actual return call to be null.
+    return_value = BuildNullValue();
+  }
+
   AddReturnExit(node->token_pos(), return_value);
 }
 
 
 // <Expression> ::= Literal { literal: Instance }
 void EffectGraphVisitor::VisitLiteralNode(LiteralNode* node) {
   ReturnDefinition(new(I) ConstantInstr(node->literal()));
 }
 
 
@@ skipping 2897 matching lines @@
   Report::MessageF(Report::kBailout,
                    Script::Handle(function.script()),
                    function.token_pos(),
                    "FlowGraphBuilder Bailout: %s %s",
                    String::Handle(function.name()).ToCString(),
                    reason);
   UNREACHABLE();
 }
 
 }  // namespace dart