2 // async.cs: Asynchronous functions
5 // Marek Safar (marek.safar@gmail.com)
7 // Dual licensed under the terms of the MIT X11 or GNU GPL
9 // Copyright 2011 Novell, Inc.
10 // Copyright 2011 Xamarin Inc.
14 using System.Collections.Generic;
16 using System.Collections;
19 using IKVM.Reflection.Emit;
21 using System.Reflection.Emit;
26 class Await : ExpressionStatement
31 public Await (Expression expr, Location loc)
37 protected override void CloneTo (CloneContext clonectx, Expression target)
39 var t = (Await) target;
41 t.expr = expr.Clone (clonectx);
44 public override Expression CreateExpressionTree (ResolveContext ec)
46 throw new NotImplementedException ("ET");
49 public override bool ContainsEmitWithAwait ()
54 protected override Expression DoResolve (ResolveContext rc)
56 if (rc.HasSet (ResolveContext.Options.LockScope)) {
57 rc.Report.Error (1996, loc,
58 "The `await' operator cannot be used in the body of a lock statement");
61 if (rc.HasSet (ResolveContext.Options.ExpressionTreeConversion)) {
62 rc.Report.Error (1989, loc, "An expression tree cannot contain an await operator");
67 rc.Report.Error (4004, loc,
68 "The `await' operator cannot be used in an unsafe context");
71 var bc = (BlockContext) rc;
73 stmt = new AwaitStatement (expr, loc);
74 if (!stmt.Resolve (bc))
77 type = stmt.ResultType;
78 eclass = ExprClass.Variable;
82 public override void Emit (EmitContext ec)
84 stmt.EmitPrologue (ec);
88 public override Expression EmitToField (EmitContext ec)
90 stmt.EmitPrologue (ec);
91 return stmt.GetResultExpression (ec);
94 public void EmitAssign (EmitContext ec, FieldExpr field)
96 stmt.EmitPrologue (ec);
97 field.InstanceExpression.Emit (ec);
101 public override void EmitStatement (EmitContext ec)
103 stmt.EmitStatement (ec);
107 class AwaitStatement : YieldStatement<AsyncInitializer>
109 sealed class AwaitableMemberAccess : MemberAccess
111 public AwaitableMemberAccess (Expression expr)
112 : base (expr, "GetAwaiter")
116 protected override void Error_TypeDoesNotContainDefinition (ResolveContext rc, TypeSpec type, string name)
118 Error_OperatorCannotBeApplied (rc, type);
121 protected override void Error_OperatorCannotBeApplied (ResolveContext rc, TypeSpec type)
123 rc.Report.Error (4001, loc, "Cannot await `{0}' expression", type.GetSignatureForError ());
127 sealed class GetResultInvocation : Invocation
129 public GetResultInvocation (MethodGroupExpr mge, Arguments arguments)
130 : base (null, arguments)
133 type = mg.BestCandidateReturnType;
136 public override Expression EmitToField (EmitContext ec)
143 PropertySpec is_completed;
144 MethodSpec on_completed;
145 MethodSpec get_result;
147 TypeSpec result_type;
149 public AwaitStatement (Expression expr, Location loc)
158 return is_completed == null;
162 public TypeSpec Type {
168 public TypeSpec ResultType {
176 protected override void DoEmit (EmitContext ec)
178 GetResultExpression (ec).Emit (ec);
181 public Expression GetResultExpression (EmitContext ec)
183 var fe_awaiter = new FieldExpr (awaiter, loc);
184 fe_awaiter.InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, loc);
187 // result = awaiter.GetResult ();
190 var rc = new ResolveContext (ec.MemberContext);
191 return new Invocation (new MemberAccess (fe_awaiter, "GetResult"), new Arguments (0)).Resolve (rc);
193 var mg_result = MethodGroupExpr.CreatePredefined (get_result, fe_awaiter.Type, loc);
194 mg_result.InstanceExpression = fe_awaiter;
196 return new GetResultInvocation (mg_result, new Arguments (0));
200 public void EmitPrologue (EmitContext ec)
202 var fe_awaiter = new FieldExpr (awaiter, loc);
203 fe_awaiter.InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, loc);
206 // awaiter = expr.GetAwaiter ();
208 fe_awaiter.EmitAssign (ec, expr, false, false);
210 Label skip_continuation = ec.DefineLabel ();
212 Expression completed_expr;
214 var rc = new ResolveContext (ec.MemberContext);
216 Arguments dargs = new Arguments (1);
217 dargs.Add (new Argument (fe_awaiter));
218 completed_expr = new DynamicMemberBinder ("IsCompleted", dargs, loc).Resolve (rc);
220 var pe = PropertyExpr.CreatePredefined (is_completed, loc);
221 pe.InstanceExpression = fe_awaiter;
225 completed_expr.EmitBranchable (ec, skip_continuation, true);
230 // The stack has to be empty before calling await continuation. We handle this
231 // by lifting values which would be left on stack into class fields. The process
232 // is quite complicated and quite hard to test because any expression can possibly
233 // leave a value on the stack.
235 // Following assert fails when some of expression called before is missing EmitToField
236 // or parent expression fails to find await in children expressions
238 ec.AssertEmptyStack ();
240 var storey = (AsyncTaskStorey) machine_initializer.Storey;
241 var cont_field = storey.EmitContinuationInitialization (ec);
243 var args = new Arguments (1);
244 args.Add (new Argument (cont_field));
247 var rc = new ResolveContext (ec.MemberContext);
248 var mg_expr = new Invocation (new MemberAccess (fe_awaiter, "OnCompleted"), args).Resolve (rc);
250 ExpressionStatement es = (ExpressionStatement) mg_expr;
251 es.EmitStatement (ec);
253 var mg_completed = MethodGroupExpr.CreatePredefined (on_completed, fe_awaiter.Type, loc);
254 mg_completed.InstanceExpression = fe_awaiter;
257 // awaiter.OnCompleted (continuation);
259 mg_completed.EmitCall (ec, args);
263 machine_initializer.EmitLeave (ec, unwind_protect);
265 ec.MarkLabel (resume_point);
266 ec.MarkLabel (skip_continuation);
269 public void EmitStatement (EmitContext ec)
274 if (ResultType.Kind != MemberKind.Void) {
275 var storey = (AsyncTaskStorey) machine_initializer.Storey;
277 if (storey.HoistedReturn != null)
278 storey.HoistedReturn.EmitAssign (ec);
280 ec.Emit (OpCodes.Pop);
284 void Error_WrongAwaiterPattern (ResolveContext rc, TypeSpec awaiter)
286 rc.Report.Error (4011, loc, "The awaiter type `{0}' must have suitable IsCompleted, OnCompleted, and GetResult members",
287 awaiter.GetSignatureForError ());
290 public override bool Resolve (BlockContext bc)
292 if (!base.Resolve (bc))
295 Arguments args = new Arguments (0);
300 // The await expression is of dynamic type
302 if (type.BuiltinType == BuiltinTypeSpec.Type.Dynamic) {
305 awaiter = ((AsyncTaskStorey) machine_initializer.Storey).AddAwaiter (type, loc);
307 expr = new Invocation (new MemberAccess (expr, "GetAwaiter"), args).Resolve (bc);
312 // Check whether the expression is awaitable
314 Expression ama = new AwaitableMemberAccess (expr).Resolve (bc);
318 var errors_printer = new SessionReportPrinter ();
319 var old = bc.Report.SetPrinter (errors_printer);
320 ama = new Invocation (ama, args).Resolve (bc);
321 bc.Report.SetPrinter (old);
323 if (errors_printer.ErrorsCount > 0 || !MemberAccess.IsValidDotExpression (ama.Type)) {
324 bc.Report.Error (1986, expr.Location,
325 "The `await' operand type `{0}' must have suitable GetAwaiter method",
326 expr.Type.GetSignatureForError ());
331 var awaiter_type = ama.Type;
332 awaiter = ((AsyncTaskStorey) machine_initializer.Storey).AddAwaiter (awaiter_type, loc);
337 // Predefined: bool IsCompleted { get; }
339 is_completed = MemberCache.FindMember (awaiter_type, MemberFilter.Property ("IsCompleted", bc.Module.Compiler.BuiltinTypes.Bool),
340 BindingRestriction.InstanceOnly) as PropertySpec;
342 if (is_completed == null || !is_completed.HasGet) {
343 Error_WrongAwaiterPattern (bc, awaiter_type);
348 // Predefined: OnCompleted (Action)
350 if (bc.Module.PredefinedTypes.Action.Define ()) {
351 on_completed = MemberCache.FindMember (awaiter_type, MemberFilter.Method ("OnCompleted", 0,
352 ParametersCompiled.CreateFullyResolved (bc.Module.PredefinedTypes.Action.TypeSpec), bc.Module.Compiler.BuiltinTypes.Void),
353 BindingRestriction.InstanceOnly) as MethodSpec;
355 if (on_completed == null) {
356 Error_WrongAwaiterPattern (bc, awaiter_type);
362 // Predefined: GetResult ()
364 // The method return type is also result type of await expression
366 get_result = MemberCache.FindMember (awaiter_type, MemberFilter.Method ("GetResult", 0,
367 ParametersCompiled.EmptyReadOnlyParameters, null),
368 BindingRestriction.InstanceOnly) as MethodSpec;
370 if (get_result == null) {
371 Error_WrongAwaiterPattern (bc, awaiter_type);
375 result_type = get_result.ReturnType;
381 public class AsyncInitializer : StateMachineInitializer
383 TypeInferenceContext return_inference;
385 public AsyncInitializer (ParametersBlock block, TypeContainer host, TypeSpec returnType)
386 : base (block, host, returnType)
392 public override string ContainerType {
394 return "async state machine block";
398 public override bool IsIterator {
404 public Block OriginalBlock {
410 public TypeInferenceContext ReturnTypeInference {
412 return return_inference;
418 public static void Create (IMemberContext context, ParametersBlock block, ParametersCompiled parameters, TypeContainer host, TypeSpec returnType, Location loc)
420 for (int i = 0; i < parameters.Count; i++) {
421 Parameter p = parameters[i];
422 Parameter.Modifier mod = p.ModFlags;
423 if ((mod & Parameter.Modifier.ISBYREF) != 0) {
424 host.Compiler.Report.Error (1988, p.Location,
425 "Async methods cannot have ref or out parameters");
429 if (p is ArglistParameter) {
430 host.Compiler.Report.Error (4006, p.Location,
431 "__arglist is not allowed in parameter list of async methods");
435 if (parameters.Types[i].IsPointer) {
436 host.Compiler.Report.Error (4005, p.Location,
437 "Async methods cannot have unsafe parameters");
442 if (!block.HasAwait) {
443 host.Compiler.Report.Warning (1998, 1, loc,
444 "Async block lacks `await' operator and will run synchronously");
447 block.WrapIntoAsyncTask (context, host, returnType);
450 protected override BlockContext CreateBlockContext (ResolveContext rc)
452 var ctx = base.CreateBlockContext (rc);
453 var lambda = rc.CurrentAnonymousMethod as LambdaMethod;
455 return_inference = lambda.ReturnTypeInference;
457 ctx.StartFlowBranching (this, rc.CurrentBranching);
461 public override Expression CreateExpressionTree (ResolveContext ec)
463 return base.CreateExpressionTree (ec);
466 public override void Emit (EmitContext ec)
468 throw new NotImplementedException ();
471 protected override void EmitMoveNextEpilogue (EmitContext ec)
473 var storey = (AsyncTaskStorey) Storey;
474 storey.EmitSetResult (ec);
477 public override void EmitStatement (EmitContext ec)
479 var storey = (AsyncTaskStorey) Storey;
480 storey.Instance.Emit (ec);
482 var move_next_entry = storey.StateMachineMethod.Spec;
483 if (storey.MemberName.Arity > 0) {
484 move_next_entry = MemberCache.GetMember (storey.Instance.Type, move_next_entry);
487 ec.Emit (OpCodes.Call, move_next_entry);
490 // Emits return <async-storey-instance>.$builder.Task;
492 if (storey.Task != null) {
493 var builder_field = storey.Builder.Spec;
494 var task_get = storey.Task.Get;
496 if (storey.MemberName.Arity > 0) {
497 builder_field = MemberCache.GetMember (storey.Instance.Type, builder_field);
498 task_get = MemberCache.GetMember (builder_field.MemberType, task_get);
501 var pe_task = new PropertyExpr (storey.Task, loc) {
502 InstanceExpression = new FieldExpr (builder_field, loc) {
503 InstanceExpression = storey.Instance
511 ec.Emit (OpCodes.Ret);
515 class AsyncTaskStorey : StateMachine
518 Field builder, continuation;
519 readonly TypeSpec return_type;
520 MethodSpec set_result;
521 MethodSpec set_exception;
523 LocalVariable hoisted_return;
525 Dictionary<TypeSpec, List<StackField>> stack_fields;
528 public AsyncTaskStorey (IMemberContext context, AsyncInitializer initializer, TypeSpec type)
529 : base (initializer.OriginalBlock, initializer.Host,context.CurrentMemberDefinition as MemberBase, context.CurrentTypeParameters, "async")
536 public Field Builder {
542 public LocalVariable HoistedReturn {
544 return hoisted_return;
548 public TypeSpec ReturnType {
554 public PropertySpec Task {
562 public Field AddAwaiter (TypeSpec type, Location loc)
564 return AddCapturedVariable ("$awaiter" + awaiters++.ToString ("X"), type);
567 public StackField AddCapturedLocalVariable (TypeSpec type)
570 type = mutator.Mutate (type);
572 List<StackField> existing_fields = null;
573 if (stack_fields == null) {
574 stack_fields = new Dictionary<TypeSpec, List<StackField>> ();
575 } else if (stack_fields.TryGetValue (type, out existing_fields)) {
576 foreach (var f in existing_fields) {
578 f.CanBeReused = false;
584 const Modifiers mod = Modifiers.COMPILER_GENERATED | Modifiers.PRIVATE;
585 var field = new StackField (this, new TypeExpression (type, Location), mod, new MemberName ("<s>$" + locals_captured++.ToString ("X"), Location));
590 if (existing_fields == null) {
591 existing_fields = new List<StackField> ();
592 stack_fields.Add (type, existing_fields);
595 existing_fields.Add (field);
600 protected override bool DoDefineMembers ()
602 action = Module.PredefinedTypes.Action.Resolve ();
604 PredefinedType builder_type;
605 PredefinedMember<MethodSpec> bf;
606 PredefinedMember<MethodSpec> sr;
607 PredefinedMember<MethodSpec> se;
608 bool has_task_return_type = false;
609 var pred_members = Module.PredefinedMembers;
611 if (return_type.Kind == MemberKind.Void) {
612 builder_type = Module.PredefinedTypes.AsyncVoidMethodBuilder;
613 bf = pred_members.AsyncVoidMethodBuilderCreate;
614 sr = pred_members.AsyncVoidMethodBuilderSetResult;
615 se = pred_members.AsyncVoidMethodBuilderSetException;
616 } else if (return_type == Module.PredefinedTypes.Task.TypeSpec) {
617 builder_type = Module.PredefinedTypes.AsyncTaskMethodBuilder;
618 bf = pred_members.AsyncTaskMethodBuilderCreate;
619 sr = pred_members.AsyncTaskMethodBuilderSetResult;
620 se = pred_members.AsyncTaskMethodBuilderSetException;
621 task = pred_members.AsyncTaskMethodBuilderTask.Get ();
623 builder_type = Module.PredefinedTypes.AsyncTaskMethodBuilderGeneric;
624 bf = pred_members.AsyncTaskMethodBuilderGenericCreate;
625 sr = pred_members.AsyncTaskMethodBuilderGenericSetResult;
626 se = pred_members.AsyncTaskMethodBuilderGenericSetException;
627 task = pred_members.AsyncTaskMethodBuilderGenericTask.Get ();
628 has_task_return_type = true;
631 set_result = sr.Get ();
632 set_exception = se.Get ();
633 var builder_factory = bf.Get ();
634 if (!builder_type.Define () || set_result == null || builder_factory == null || set_exception == null) {
635 Report.Error (1993, Location,
636 "Cannot find compiler required types for asynchronous functions support. Are you targeting the wrong framework version?");
637 return base.DoDefineMembers ();
640 var bt = builder_type.TypeSpec;
643 // Inflate generic Task types
645 if (has_task_return_type) {
646 var task_return_type = return_type.TypeArguments;
648 task_return_type = mutator.Mutate (task_return_type);
650 bt = bt.MakeGenericType (Module, task_return_type);
651 builder_factory = MemberCache.GetMember<MethodSpec> (bt, builder_factory);
652 set_result = MemberCache.GetMember<MethodSpec> (bt, set_result);
653 set_exception = MemberCache.GetMember<MethodSpec> (bt, set_exception);
656 task = MemberCache.GetMember<PropertySpec> (bt, task);
659 builder = AddCompilerGeneratedField ("$builder", new TypeExpression (bt, Location));
661 if (!base.DoDefineMembers ())
664 var block = instance_constructors[0].Block;
666 var mg = MethodGroupExpr.CreatePredefined (builder_factory, bt, Location);
668 new StatementExpression (new SimpleAssign (
669 new FieldExpr (builder, Location),
670 new Invocation (mg, new Arguments (0)),
673 if (has_task_return_type) {
674 hoisted_return = LocalVariable.CreateCompilerGenerated (bt.TypeArguments[0], block, Location);
680 public Expression EmitContinuationInitialization (EmitContext ec)
683 // When more than 1 awaiter has been used in the block we
684 // introduce class scope field to cache continuation delegate
687 if (continuation == null) {
688 continuation = AddCompilerGeneratedField ("$continuation", new TypeExpression (action, Location), true);
689 continuation.Define ();
692 var fexpr = new FieldExpr (continuation, Location);
693 fexpr.InstanceExpression = new CompilerGeneratedThis (CurrentType, Location);
696 // if ($continuation == null)
697 // $continuation = new Action (MoveNext);
701 var skip_cont_init = ec.DefineLabel ();
702 ec.Emit (OpCodes.Brtrue_S, skip_cont_init);
706 ec.Emit (OpCodes.Stfld, continuation.Spec);
707 ec.MarkLabel (skip_cont_init);
713 // Otherwise simply use temporary local variable
715 var field = LocalVariable.CreateCompilerGenerated (action, OriginalSourceBlock, Location);
717 field.EmitAssign (ec);
718 return new LocalVariableReference (field, Location);
721 void EmitActionLoad (EmitContext ec)
724 ec.Emit (OpCodes.Ldftn, StateMachineMethod.Spec);
725 ec.Emit (OpCodes.Newobj, (MethodSpec) MemberCache.FindMember (action, MemberFilter.Constructor (null), BindingRestriction.DeclaredOnly));
728 public void EmitSetException (EmitContext ec, LocalVariableReference exceptionVariable)
731 // $builder.SetException (Exception)
733 var mg = MethodGroupExpr.CreatePredefined (set_exception, set_exception.DeclaringType, Location);
734 mg.InstanceExpression = new FieldExpr (Builder, Location) {
735 InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, Location)
738 Arguments args = new Arguments (1);
739 args.Add (new Argument (exceptionVariable));
741 mg.EmitCall (ec, args);
744 public void EmitSetResult (EmitContext ec)
747 // $builder.SetResult ();
748 // $builder.SetResult<return-type> (value);
750 var mg = MethodGroupExpr.CreatePredefined (set_result, set_result.DeclaringType, Location);
751 mg.InstanceExpression = new FieldExpr (Builder, Location) {
752 InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, Location)
756 if (hoisted_return == null) {
757 args = new Arguments (0);
759 args = new Arguments (1);
760 args.Add (new Argument (new LocalVariableReference (hoisted_return, Location)));
763 mg.EmitCall (ec, args);
767 class StackField : Field
769 public StackField (DeclSpace parent, FullNamedExpression type, Modifiers mod, MemberName name)
770 : base (parent, type, mod, name, null)
774 public bool CanBeReused { get; set; }
777 class StackFieldExpr : FieldExpr
779 public StackFieldExpr (Field field)
780 : base (field, Location.Null)
784 public override void Emit (EmitContext ec)
788 var field = (StackField) spec.MemberDefinition;
789 field.CanBeReused = true;