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 public class Await : ExpressionStatement
31 public Await (Expression expr, Location loc)
37 public Expression Expr {
43 protected override void CloneTo (CloneContext clonectx, Expression target)
45 var t = (Await) target;
47 t.expr = expr.Clone (clonectx);
50 public override Expression CreateExpressionTree (ResolveContext ec)
52 throw new NotImplementedException ("ET");
55 public override bool ContainsEmitWithAwait ()
60 protected override Expression DoResolve (ResolveContext rc)
62 if (rc.HasSet (ResolveContext.Options.LockScope)) {
63 rc.Report.Error (1996, loc,
64 "The `await' operator cannot be used in the body of a lock statement");
67 if (rc.HasSet (ResolveContext.Options.ExpressionTreeConversion)) {
68 rc.Report.Error (1989, loc, "An expression tree cannot contain an await operator");
73 rc.Report.Error (4004, loc,
74 "The `await' operator cannot be used in an unsafe context");
77 var bc = (BlockContext) rc;
79 stmt = new AwaitStatement (expr, loc);
80 if (!stmt.Resolve (bc))
83 type = stmt.ResultType;
84 eclass = ExprClass.Variable;
88 public override void Emit (EmitContext ec)
90 stmt.EmitPrologue (ec);
94 public override Expression EmitToField (EmitContext ec)
96 stmt.EmitPrologue (ec);
97 return stmt.GetResultExpression (ec);
100 public void EmitAssign (EmitContext ec, FieldExpr field)
102 stmt.EmitPrologue (ec);
103 field.InstanceExpression.Emit (ec);
107 public override void EmitStatement (EmitContext ec)
109 stmt.EmitStatement (ec);
112 public override object Accept (StructuralVisitor visitor)
114 return visitor.Visit (this);
118 class AwaitStatement : YieldStatement<AsyncInitializer>
120 sealed class AwaitableMemberAccess : MemberAccess
122 public AwaitableMemberAccess (Expression expr)
123 : base (expr, "GetAwaiter")
127 protected override void Error_TypeDoesNotContainDefinition (ResolveContext rc, TypeSpec type, string name)
129 Error_OperatorCannotBeApplied (rc, type);
132 protected override void Error_OperatorCannotBeApplied (ResolveContext rc, TypeSpec type)
134 rc.Report.Error (4001, loc, "Cannot await `{0}' expression", type.GetSignatureForError ());
138 sealed class GetResultInvocation : Invocation
140 public GetResultInvocation (MethodGroupExpr mge, Arguments arguments)
141 : base (null, arguments)
144 type = mg.BestCandidateReturnType;
147 public override Expression EmitToField (EmitContext ec)
154 PropertySpec is_completed;
155 MethodSpec on_completed;
156 MethodSpec get_result;
158 TypeSpec result_type;
160 public AwaitStatement (Expression expr, Location loc)
169 return is_completed == null;
173 public TypeSpec Type {
179 public TypeSpec ResultType {
187 protected override void DoEmit (EmitContext ec)
189 GetResultExpression (ec).Emit (ec);
192 public Expression GetResultExpression (EmitContext ec)
194 var fe_awaiter = new FieldExpr (awaiter, loc);
195 fe_awaiter.InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, loc);
198 // result = awaiter.GetResult ();
201 var rc = new ResolveContext (ec.MemberContext);
202 return new Invocation (new MemberAccess (fe_awaiter, "GetResult"), new Arguments (0)).Resolve (rc);
204 var mg_result = MethodGroupExpr.CreatePredefined (get_result, fe_awaiter.Type, loc);
205 mg_result.InstanceExpression = fe_awaiter;
207 return new GetResultInvocation (mg_result, new Arguments (0));
211 public void EmitPrologue (EmitContext ec)
213 var fe_awaiter = new FieldExpr (awaiter, loc);
214 fe_awaiter.InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, loc);
217 // awaiter = expr.GetAwaiter ();
219 fe_awaiter.EmitAssign (ec, expr, false, false);
221 Label skip_continuation = ec.DefineLabel ();
223 Expression completed_expr;
225 var rc = new ResolveContext (ec.MemberContext);
227 Arguments dargs = new Arguments (1);
228 dargs.Add (new Argument (fe_awaiter));
229 completed_expr = new DynamicMemberBinder ("IsCompleted", dargs, loc).Resolve (rc);
231 var pe = PropertyExpr.CreatePredefined (is_completed, loc);
232 pe.InstanceExpression = fe_awaiter;
236 completed_expr.EmitBranchable (ec, skip_continuation, true);
241 // The stack has to be empty before calling await continuation. We handle this
242 // by lifting values which would be left on stack into class fields. The process
243 // is quite complicated and quite hard to test because any expression can possibly
244 // leave a value on the stack.
246 // Following assert fails when some of expression called before is missing EmitToField
247 // or parent expression fails to find await in children expressions
249 ec.AssertEmptyStack ();
251 var storey = (AsyncTaskStorey) machine_initializer.Storey;
252 var cont_field = storey.EmitContinuationInitialization (ec);
254 var args = new Arguments (1);
255 args.Add (new Argument (cont_field));
258 var rc = new ResolveContext (ec.MemberContext);
259 var mg_expr = new Invocation (new MemberAccess (fe_awaiter, "OnCompleted"), args).Resolve (rc);
261 ExpressionStatement es = (ExpressionStatement) mg_expr;
262 es.EmitStatement (ec);
264 var mg_completed = MethodGroupExpr.CreatePredefined (on_completed, fe_awaiter.Type, loc);
265 mg_completed.InstanceExpression = fe_awaiter;
268 // awaiter.OnCompleted (continuation);
270 mg_completed.EmitCall (ec, args);
274 machine_initializer.EmitLeave (ec, unwind_protect);
276 ec.MarkLabel (resume_point);
277 ec.MarkLabel (skip_continuation);
280 public void EmitStatement (EmitContext ec)
285 if (ResultType.Kind != MemberKind.Void) {
286 var storey = (AsyncTaskStorey) machine_initializer.Storey;
288 if (storey.HoistedReturn != null)
289 storey.HoistedReturn.EmitAssign (ec);
291 ec.Emit (OpCodes.Pop);
295 void Error_WrongAwaiterPattern (ResolveContext rc, TypeSpec awaiter)
297 rc.Report.Error (4011, loc, "The awaiter type `{0}' must have suitable IsCompleted, OnCompleted, and GetResult members",
298 awaiter.GetSignatureForError ());
301 public override bool Resolve (BlockContext bc)
303 if (!base.Resolve (bc))
306 Arguments args = new Arguments (0);
311 // The await expression is of dynamic type
313 if (type.BuiltinType == BuiltinTypeSpec.Type.Dynamic) {
316 awaiter = ((AsyncTaskStorey) machine_initializer.Storey).AddAwaiter (type, loc);
318 expr = new Invocation (new MemberAccess (expr, "GetAwaiter"), args).Resolve (bc);
323 // Check whether the expression is awaitable
325 Expression ama = new AwaitableMemberAccess (expr).Resolve (bc);
329 var errors_printer = new SessionReportPrinter ();
330 var old = bc.Report.SetPrinter (errors_printer);
331 ama = new Invocation (ama, args).Resolve (bc);
332 bc.Report.SetPrinter (old);
334 if (errors_printer.ErrorsCount > 0 || !MemberAccess.IsValidDotExpression (ama.Type)) {
335 bc.Report.Error (1986, expr.Location,
336 "The `await' operand type `{0}' must have suitable GetAwaiter method",
337 expr.Type.GetSignatureForError ());
342 var awaiter_type = ama.Type;
343 awaiter = ((AsyncTaskStorey) machine_initializer.Storey).AddAwaiter (awaiter_type, loc);
348 // Predefined: bool IsCompleted { get; }
350 is_completed = MemberCache.FindMember (awaiter_type, MemberFilter.Property ("IsCompleted", bc.Module.Compiler.BuiltinTypes.Bool),
351 BindingRestriction.InstanceOnly) as PropertySpec;
353 if (is_completed == null || !is_completed.HasGet) {
354 Error_WrongAwaiterPattern (bc, awaiter_type);
359 // Predefined: OnCompleted (Action)
361 if (bc.Module.PredefinedTypes.Action.Define ()) {
362 on_completed = MemberCache.FindMember (awaiter_type, MemberFilter.Method ("OnCompleted", 0,
363 ParametersCompiled.CreateFullyResolved (bc.Module.PredefinedTypes.Action.TypeSpec), bc.Module.Compiler.BuiltinTypes.Void),
364 BindingRestriction.InstanceOnly) as MethodSpec;
366 if (on_completed == null) {
367 Error_WrongAwaiterPattern (bc, awaiter_type);
373 // Predefined: GetResult ()
375 // The method return type is also result type of await expression
377 get_result = MemberCache.FindMember (awaiter_type, MemberFilter.Method ("GetResult", 0,
378 ParametersCompiled.EmptyReadOnlyParameters, null),
379 BindingRestriction.InstanceOnly) as MethodSpec;
381 if (get_result == null) {
382 Error_WrongAwaiterPattern (bc, awaiter_type);
386 result_type = get_result.ReturnType;
392 public class AsyncInitializer : StateMachineInitializer
394 TypeInferenceContext return_inference;
396 public AsyncInitializer (ParametersBlock block, TypeDefinition host, TypeSpec returnType)
397 : base (block, host, returnType)
403 public override string ContainerType {
405 return "async state machine block";
409 public override bool IsIterator {
415 public Block OriginalBlock {
421 public TypeInferenceContext ReturnTypeInference {
423 return return_inference;
429 public static void Create (IMemberContext context, ParametersBlock block, ParametersCompiled parameters, TypeDefinition host, TypeSpec returnType, Location loc)
431 for (int i = 0; i < parameters.Count; i++) {
432 Parameter p = parameters[i];
433 Parameter.Modifier mod = p.ModFlags;
434 if ((mod & Parameter.Modifier.ISBYREF) != 0) {
435 host.Compiler.Report.Error (1988, p.Location,
436 "Async methods cannot have ref or out parameters");
440 if (p is ArglistParameter) {
441 host.Compiler.Report.Error (4006, p.Location,
442 "__arglist is not allowed in parameter list of async methods");
446 if (parameters.Types[i].IsPointer) {
447 host.Compiler.Report.Error (4005, p.Location,
448 "Async methods cannot have unsafe parameters");
453 if (!block.HasAwait) {
454 host.Compiler.Report.Warning (1998, 1, loc,
455 "Async block lacks `await' operator and will run synchronously");
458 block.WrapIntoAsyncTask (context, host, returnType);
461 protected override BlockContext CreateBlockContext (ResolveContext rc)
463 var ctx = base.CreateBlockContext (rc);
464 var lambda = rc.CurrentAnonymousMethod as LambdaMethod;
466 return_inference = lambda.ReturnTypeInference;
468 ctx.StartFlowBranching (this, rc.CurrentBranching);
472 public override Expression CreateExpressionTree (ResolveContext ec)
474 return base.CreateExpressionTree (ec);
477 public override void Emit (EmitContext ec)
479 throw new NotImplementedException ();
482 protected override void EmitMoveNextEpilogue (EmitContext ec)
484 var storey = (AsyncTaskStorey) Storey;
485 storey.EmitSetResult (ec);
488 public override void EmitStatement (EmitContext ec)
490 var storey = (AsyncTaskStorey) Storey;
491 storey.Instance.Emit (ec);
493 var move_next_entry = storey.StateMachineMethod.Spec;
494 if (storey.MemberName.Arity > 0) {
495 move_next_entry = MemberCache.GetMember (storey.Instance.Type, move_next_entry);
498 ec.Emit (OpCodes.Call, move_next_entry);
501 // Emits return <async-storey-instance>.$builder.Task;
503 if (storey.Task != null) {
504 var builder_field = storey.Builder.Spec;
505 var task_get = storey.Task.Get;
507 if (storey.MemberName.Arity > 0) {
508 builder_field = MemberCache.GetMember (storey.Instance.Type, builder_field);
509 task_get = MemberCache.GetMember (builder_field.MemberType, task_get);
512 var pe_task = new PropertyExpr (storey.Task, loc) {
513 InstanceExpression = new FieldExpr (builder_field, loc) {
514 InstanceExpression = storey.Instance
522 ec.Emit (OpCodes.Ret);
526 class AsyncTaskStorey : StateMachine
529 Field builder, continuation;
530 readonly TypeSpec return_type;
531 MethodSpec set_result;
532 MethodSpec set_exception;
534 LocalVariable hoisted_return;
536 Dictionary<TypeSpec, List<StackField>> stack_fields;
539 public AsyncTaskStorey (IMemberContext context, AsyncInitializer initializer, TypeSpec type)
540 : base (initializer.OriginalBlock, initializer.Host, context.CurrentMemberDefinition as MemberBase, context.CurrentTypeParameters, "async")
547 public Field Builder {
553 public LocalVariable HoistedReturn {
555 return hoisted_return;
559 public TypeSpec ReturnType {
565 public PropertySpec Task {
573 public Field AddAwaiter (TypeSpec type, Location loc)
575 return AddCapturedVariable ("$awaiter" + awaiters++.ToString ("X"), type);
578 public StackField AddCapturedLocalVariable (TypeSpec type)
581 type = mutator.Mutate (type);
583 List<StackField> existing_fields = null;
584 if (stack_fields == null) {
585 stack_fields = new Dictionary<TypeSpec, List<StackField>> ();
586 } else if (stack_fields.TryGetValue (type, out existing_fields)) {
587 foreach (var f in existing_fields) {
589 f.CanBeReused = false;
595 const Modifiers mod = Modifiers.COMPILER_GENERATED | Modifiers.PRIVATE;
596 var field = new StackField (this, new TypeExpression (type, Location), mod, new MemberName ("<s>$" + locals_captured++.ToString ("X"), Location));
601 if (existing_fields == null) {
602 existing_fields = new List<StackField> ();
603 stack_fields.Add (type, existing_fields);
606 existing_fields.Add (field);
611 protected override bool DoDefineMembers ()
613 action = Module.PredefinedTypes.Action.Resolve ();
615 PredefinedType builder_type;
616 PredefinedMember<MethodSpec> bf;
617 PredefinedMember<MethodSpec> sr;
618 PredefinedMember<MethodSpec> se;
619 bool has_task_return_type = false;
620 var pred_members = Module.PredefinedMembers;
622 if (return_type.Kind == MemberKind.Void) {
623 builder_type = Module.PredefinedTypes.AsyncVoidMethodBuilder;
624 bf = pred_members.AsyncVoidMethodBuilderCreate;
625 sr = pred_members.AsyncVoidMethodBuilderSetResult;
626 se = pred_members.AsyncVoidMethodBuilderSetException;
627 } else if (return_type == Module.PredefinedTypes.Task.TypeSpec) {
628 builder_type = Module.PredefinedTypes.AsyncTaskMethodBuilder;
629 bf = pred_members.AsyncTaskMethodBuilderCreate;
630 sr = pred_members.AsyncTaskMethodBuilderSetResult;
631 se = pred_members.AsyncTaskMethodBuilderSetException;
632 task = pred_members.AsyncTaskMethodBuilderTask.Get ();
634 builder_type = Module.PredefinedTypes.AsyncTaskMethodBuilderGeneric;
635 bf = pred_members.AsyncTaskMethodBuilderGenericCreate;
636 sr = pred_members.AsyncTaskMethodBuilderGenericSetResult;
637 se = pred_members.AsyncTaskMethodBuilderGenericSetException;
638 task = pred_members.AsyncTaskMethodBuilderGenericTask.Get ();
639 has_task_return_type = true;
642 set_result = sr.Get ();
643 set_exception = se.Get ();
644 var builder_factory = bf.Get ();
645 if (!builder_type.Define () || set_result == null || builder_factory == null || set_exception == null) {
646 Report.Error (1993, Location,
647 "Cannot find compiler required types for asynchronous functions support. Are you targeting the wrong framework version?");
648 return base.DoDefineMembers ();
651 var bt = builder_type.TypeSpec;
654 // Inflate generic Task types
656 if (has_task_return_type) {
657 var task_return_type = return_type.TypeArguments;
659 task_return_type = mutator.Mutate (task_return_type);
661 bt = bt.MakeGenericType (Module, task_return_type);
662 builder_factory = MemberCache.GetMember<MethodSpec> (bt, builder_factory);
663 set_result = MemberCache.GetMember<MethodSpec> (bt, set_result);
664 set_exception = MemberCache.GetMember<MethodSpec> (bt, set_exception);
667 task = MemberCache.GetMember<PropertySpec> (bt, task);
670 builder = AddCompilerGeneratedField ("$builder", new TypeExpression (bt, Location));
672 var ctor = DefineDefaultConstructor (false);
674 if (!base.DoDefineMembers ())
677 Block block = ctor.Block;
679 var mg = MethodGroupExpr.CreatePredefined (builder_factory, bt, Location);
681 new StatementExpression (new SimpleAssign (
682 new FieldExpr (builder, Location),
683 new Invocation (mg, new Arguments (0)),
686 if (has_task_return_type) {
687 hoisted_return = LocalVariable.CreateCompilerGenerated (bt.TypeArguments[0], block, Location);
693 public Expression EmitContinuationInitialization (EmitContext ec)
696 // When more than 1 awaiter has been used in the block we
697 // introduce class scope field to cache continuation delegate
700 if (continuation == null) {
701 continuation = AddCompilerGeneratedField ("$continuation", new TypeExpression (action, Location), true);
702 continuation.Define ();
705 var fexpr = new FieldExpr (continuation, Location);
706 fexpr.InstanceExpression = new CompilerGeneratedThis (CurrentType, Location);
709 // if ($continuation == null)
710 // $continuation = new Action (MoveNext);
714 var skip_cont_init = ec.DefineLabel ();
715 ec.Emit (OpCodes.Brtrue_S, skip_cont_init);
719 ec.Emit (OpCodes.Stfld, continuation.Spec);
720 ec.MarkLabel (skip_cont_init);
726 // Otherwise simply use temporary local variable
728 var field = LocalVariable.CreateCompilerGenerated (action, OriginalSourceBlock, Location);
730 field.EmitAssign (ec);
731 return new LocalVariableReference (field, Location);
734 void EmitActionLoad (EmitContext ec)
737 ec.Emit (OpCodes.Ldftn, StateMachineMethod.Spec);
738 ec.Emit (OpCodes.Newobj, (MethodSpec) MemberCache.FindMember (action, MemberFilter.Constructor (null), BindingRestriction.DeclaredOnly));
741 public void EmitSetException (EmitContext ec, LocalVariableReference exceptionVariable)
744 // $builder.SetException (Exception)
746 var mg = MethodGroupExpr.CreatePredefined (set_exception, set_exception.DeclaringType, Location);
747 mg.InstanceExpression = new FieldExpr (Builder, Location) {
748 InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, Location)
751 Arguments args = new Arguments (1);
752 args.Add (new Argument (exceptionVariable));
754 mg.EmitCall (ec, args);
757 public void EmitSetResult (EmitContext ec)
760 // $builder.SetResult ();
761 // $builder.SetResult<return-type> (value);
763 var mg = MethodGroupExpr.CreatePredefined (set_result, set_result.DeclaringType, Location);
764 mg.InstanceExpression = new FieldExpr (Builder, Location) {
765 InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, Location)
769 if (hoisted_return == null) {
770 args = new Arguments (0);
772 args = new Arguments (1);
773 args.Add (new Argument (new LocalVariableReference (hoisted_return, Location)));
776 mg.EmitCall (ec, args);
780 class StackField : Field
782 public StackField (TypeDefinition parent, FullNamedExpression type, Modifiers mod, MemberName name)
783 : base (parent, type, mod, name, null)
787 public bool CanBeReused { get; set; }
790 class StackFieldExpr : FieldExpr
792 public StackFieldExpr (Field field)
793 : base (field, Location.Null)
797 public override void Emit (EmitContext ec)
801 var field = (StackField) spec.MemberDefinition;
802 field.CanBeReused = true;