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 // TODO: New error code
68 rc.Report.Error (-1900, loc,
69 "The `await' operator cannot be used in an unsafe context");
72 var bc = (BlockContext) rc;
74 if (!bc.CurrentBlock.ParametersBlock.IsAsync) {
75 // TODO: Should check for existence of await type but
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);
113 class AwaitStatement : YieldStatement<AsyncInitializer>
115 sealed class AwaitableMemberAccess : MemberAccess
117 public AwaitableMemberAccess (Expression expr)
118 : base (expr, "GetAwaiter")
122 protected override void Error_TypeDoesNotContainDefinition (ResolveContext rc, TypeSpec type, string name)
124 Error_WrongGetAwaiter (rc, loc, type);
127 protected override void Error_OperatorCannotBeApplied (ResolveContext rc, TypeSpec type)
129 rc.Report.Error (1991, loc, "Cannot await `{0}' expression", type.GetSignatureForError ());
133 sealed class GetResultInvocation : Invocation
135 public GetResultInvocation (MethodGroupExpr mge, Arguments arguments)
136 : base (null, arguments)
139 type = mg.BestCandidateReturnType;
142 public override Expression EmitToField (EmitContext ec)
149 PropertySpec is_completed;
150 MethodSpec on_completed;
151 MethodSpec get_result;
153 TypeSpec result_type;
155 public AwaitStatement (Expression expr, Location loc)
164 return is_completed == null;
168 public TypeSpec Type {
174 public TypeSpec ResultType {
182 protected override void DoEmit (EmitContext ec)
184 GetResultExpression (ec).Emit (ec);
187 public Expression GetResultExpression (EmitContext ec)
189 var fe_awaiter = new FieldExpr (awaiter, loc);
190 fe_awaiter.InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, loc);
193 // result = awaiter.GetResult ();
196 var rc = new ResolveContext (ec.MemberContext);
197 return new Invocation (new MemberAccess (fe_awaiter, "GetResult"), new Arguments (0)).Resolve (rc);
199 var mg_result = MethodGroupExpr.CreatePredefined (get_result, fe_awaiter.Type, loc);
200 mg_result.InstanceExpression = fe_awaiter;
202 return new GetResultInvocation (mg_result, new Arguments (0));
206 public void EmitPrologue (EmitContext ec)
208 var fe_awaiter = new FieldExpr (awaiter, loc);
209 fe_awaiter.InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, loc);
212 // awaiter = expr.GetAwaiter ();
214 fe_awaiter.EmitAssign (ec, expr, false, false);
216 Label skip_continuation = ec.DefineLabel ();
218 Expression completed_expr;
220 var rc = new ResolveContext (ec.MemberContext);
222 Arguments dargs = new Arguments (1);
223 dargs.Add (new Argument (fe_awaiter));
224 completed_expr = new DynamicMemberBinder ("IsCompleted", dargs, loc).Resolve (rc);
226 var pe = PropertyExpr.CreatePredefined (is_completed, loc);
227 pe.InstanceExpression = fe_awaiter;
231 completed_expr.EmitBranchable (ec, skip_continuation, true);
236 // The stack has to be empty before calling await continuation. We handle this
237 // by lifting values which would be left on stack into class fields. The process
238 // is quite complicated and quite hard to test because any expression can possibly
239 // leave a value on the stack.
241 // Following assert fails when some of expression called before is missing EmitToField
242 // or parent expression fails to find await in children expressions
244 ec.AssertEmptyStack ();
246 var args = new Arguments (1);
247 var storey = (AsyncTaskStorey) machine_initializer.Storey;
248 var fe_cont = new FieldExpr (storey.Continuation, loc);
249 fe_cont.InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, loc);
251 args.Add (new Argument (fe_cont));
254 var rc = new ResolveContext (ec.MemberContext);
255 var mg_expr = new Invocation (new MemberAccess (fe_awaiter, "OnCompleted"), args).Resolve (rc);
257 ExpressionStatement es = (ExpressionStatement) mg_expr;
258 es.EmitStatement (ec);
260 var mg_completed = MethodGroupExpr.CreatePredefined (on_completed, fe_awaiter.Type, loc);
261 mg_completed.InstanceExpression = fe_awaiter;
264 // awaiter.OnCompleted (continuation);
266 mg_completed.EmitCall (ec, args);
270 machine_initializer.EmitLeave (ec, unwind_protect);
272 ec.MarkLabel (resume_point);
273 ec.MarkLabel (skip_continuation);
276 public void EmitStatement (EmitContext ec)
281 if (ResultType.Kind != MemberKind.Void) {
282 var storey = (AsyncTaskStorey) machine_initializer.Storey;
284 if (storey.HoistedReturn != null)
285 storey.HoistedReturn.EmitAssign (ec);
287 ec.Emit (OpCodes.Pop);
291 static void Error_WrongGetAwaiter (ResolveContext rc, Location loc, TypeSpec type)
293 rc.Report.Error (1986, loc,
294 "The `await' operand type `{0}' must have suitable GetAwaiter method",
295 type.GetSignatureForError ());
298 void Error_WrongAwaiterPattern (ResolveContext rc, TypeSpec awaiter)
300 rc.Report.Error (1999, loc, "The awaiter type `{0}' must have suitable IsCompleted, OnCompleted, and GetResult members",
301 awaiter.GetSignatureForError ());
304 public override bool Resolve (BlockContext bc)
306 if (!base.Resolve (bc))
309 Arguments args = new Arguments (0);
314 // The await expression is of dynamic type
316 if (type.BuiltinType == BuiltinTypeSpec.Type.Dynamic) {
319 awaiter = ((AsyncTaskStorey) machine_initializer.Storey).AddAwaiter (type, loc);
321 expr = new Invocation (new MemberAccess (expr, "GetAwaiter"), args).Resolve (bc);
326 // Check whether the expression is awaitable
328 Expression ama = new AwaitableMemberAccess (expr).Resolve (bc);
332 var errors_printer = new SessionReportPrinter ();
333 var old = bc.Report.SetPrinter (errors_printer);
334 ama = new Invocation (ama, args).Resolve (bc);
335 bc.Report.SetPrinter (old);
337 if (errors_printer.ErrorsCount > 0 || !MemberAccess.IsValidDotExpression (ama.Type)) {
338 Error_WrongGetAwaiter (bc, expr.Location, expr.Type);
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, TypeContainer 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, TypeContainer host, TypeSpec returnType, Location loc)
431 if (returnType != null && returnType.Kind != MemberKind.Void &&
432 returnType != host.Module.PredefinedTypes.Task.TypeSpec &&
433 !returnType.IsGenericTask) {
434 host.Compiler.Report.Error (1983, loc, "The return type of an async method must be void, Task, or Task<T>");
437 for (int i = 0; i < parameters.Count; i++) {
438 Parameter p = parameters[i];
439 Parameter.Modifier mod = p.ModFlags;
440 if ((mod & Parameter.Modifier.ISBYREF) != 0) {
441 host.Compiler.Report.Error (1988, p.Location,
442 "Async methods cannot have ref or out parameters");
447 if (p is ArglistParameter) {
448 host.Compiler.Report.Error (1636, p.Location,
449 "__arglist is not allowed in parameter list of iterators");
454 if (parameters.Types[i].IsPointer) {
455 host.Compiler.Report.Error (1637, p.Location,
456 "Iterators cannot have unsafe parameters or yield types");
461 if (!block.IsAsync) {
462 host.Compiler.Report.Warning (1998, 1, loc,
463 "Async block lacks `await' operator and will run synchronously");
466 block.WrapIntoAsyncTask (context, host, returnType);
469 protected override BlockContext CreateBlockContext (ResolveContext rc)
471 var ctx = base.CreateBlockContext (rc);
472 var lambda = rc.CurrentAnonymousMethod as LambdaMethod;
474 return_inference = lambda.ReturnTypeInference;
476 ctx.StartFlowBranching (this, rc.CurrentBranching);
480 public override Expression CreateExpressionTree (ResolveContext ec)
482 return base.CreateExpressionTree (ec);
485 public override void Emit (EmitContext ec)
487 throw new NotImplementedException ();
490 protected override void EmitMoveNextEpilogue (EmitContext ec)
492 var storey = (AsyncTaskStorey) Storey;
493 storey.EmitSetResult (ec);
496 public override void EmitStatement (EmitContext ec)
498 var storey = (AsyncTaskStorey) Storey;
499 storey.Instance.Emit (ec);
501 var move_next_entry = storey.StateMachineMethod.Spec;
502 if (storey.MemberName.Arity > 0) {
503 move_next_entry = MemberCache.GetMember (storey.Instance.Type, move_next_entry);
506 ec.Emit (OpCodes.Call, move_next_entry);
509 // Emits return <async-storey-instance>.$builder.Task;
511 if (storey.Task != null) {
512 var builder_field = storey.Builder.Spec;
513 var task_get = storey.Task.Get;
515 if (storey.MemberName.Arity > 0) {
516 builder_field = MemberCache.GetMember (storey.Instance.Type, builder_field);
517 task_get = MemberCache.GetMember (builder_field.MemberType, task_get);
520 var pe_task = new PropertyExpr (storey.Task, loc) {
521 InstanceExpression = new FieldExpr (builder_field, loc) {
522 InstanceExpression = storey.Instance
530 ec.Emit (OpCodes.Ret);
534 class AsyncTaskStorey : StateMachine
536 sealed class ParametersLoadStatement : Statement
538 readonly FieldSpec[] fields;
539 readonly TypeSpec[] parametersTypes;
540 readonly int thisParameterIndex;
542 public ParametersLoadStatement (FieldSpec[] fields, TypeSpec[] parametersTypes, int thisParameterIndex)
544 this.fields = fields;
545 this.parametersTypes = parametersTypes;
546 this.thisParameterIndex = thisParameterIndex;
549 protected override void CloneTo (CloneContext clonectx, Statement target)
551 throw new NotImplementedException ();
554 protected override void DoEmit (EmitContext ec)
556 for (int i = 0; i < fields.Length; ++i) {
557 var field = fields[i];
561 ec.EmitArgumentLoad (thisParameterIndex);
562 ec.EmitArgumentLoad (i);
563 if (parametersTypes[i] is ReferenceContainer)
564 ec.EmitLoadFromPtr (field.MemberType);
566 ec.Emit (OpCodes.Stfld, field);
572 Field builder, continuation;
573 readonly TypeSpec return_type;
574 MethodSpec set_result;
575 MethodSpec set_exception;
577 LocalVariable hoisted_return;
580 public AsyncTaskStorey (IMemberContext context, AsyncInitializer initializer, TypeSpec type)
581 : base (initializer.OriginalBlock, initializer.Host,context.CurrentMemberDefinition as MemberBase, context.CurrentTypeParameters, "async")
588 public Field Builder {
594 public Field Continuation {
600 public LocalVariable HoistedReturn {
602 return hoisted_return;
606 public TypeSpec ReturnType {
612 public PropertySpec Task {
620 public Field AddAwaiter (TypeSpec type, Location loc)
622 return AddCompilerGeneratedField ("$awaiter" + awaiters++.ToString ("X"), new TypeExpression (type, loc), true);
625 public Field AddCapturedLocalVariable (TypeSpec type)
628 type = mutator.Mutate (type);
630 var field = AddCompilerGeneratedField ("<s>$" + locals_captured++.ToString ("X"), new TypeExpression (type, Location), true);
636 protected override bool DoDefineMembers ()
638 var action = Module.PredefinedTypes.Action.Resolve ();
639 if (action != null) {
640 continuation = AddCompilerGeneratedField ("$continuation", new TypeExpression (action, Location), true);
641 continuation.ModFlags |= Modifiers.READONLY;
644 PredefinedType builder_type;
645 PredefinedMember<MethodSpec> bf;
646 PredefinedMember<MethodSpec> sr;
647 PredefinedMember<MethodSpec> se;
648 bool has_task_return_type = false;
649 var pred_members = Module.PredefinedMembers;
651 if (return_type.Kind == MemberKind.Void) {
652 builder_type = Module.PredefinedTypes.AsyncVoidMethodBuilder;
653 bf = pred_members.AsyncVoidMethodBuilderCreate;
654 sr = pred_members.AsyncVoidMethodBuilderSetResult;
655 se = pred_members.AsyncVoidMethodBuilderSetException;
656 } else if (return_type == Module.PredefinedTypes.Task.TypeSpec) {
657 builder_type = Module.PredefinedTypes.AsyncTaskMethodBuilder;
658 bf = pred_members.AsyncTaskMethodBuilderCreate;
659 sr = pred_members.AsyncTaskMethodBuilderSetResult;
660 se = pred_members.AsyncTaskMethodBuilderSetException;
661 task = pred_members.AsyncTaskMethodBuilderTask.Resolve (Location);
663 builder_type = Module.PredefinedTypes.AsyncTaskMethodBuilderGeneric;
664 bf = pred_members.AsyncTaskMethodBuilderGenericCreate;
665 sr = pred_members.AsyncTaskMethodBuilderGenericSetResult;
666 se = pred_members.AsyncTaskMethodBuilderGenericSetException;
667 task = pred_members.AsyncTaskMethodBuilderGenericTask.Resolve (Location);
668 has_task_return_type = true;
671 set_result = sr.Resolve (Location);
672 set_exception = se.Resolve (Location);
673 var builder_factory = bf.Resolve (Location);
674 var bt = builder_type.Resolve ();
675 if (bt == null || set_result == null || builder_factory == null || set_exception == null)
679 // Inflate generic Task types
681 if (has_task_return_type) {
682 var task_return_type = return_type.TypeArguments;
684 task_return_type = mutator.Mutate (task_return_type);
686 bt = bt.MakeGenericType (Module, task_return_type);
687 builder_factory = MemberCache.GetMember<MethodSpec> (bt, builder_factory);
688 set_result = MemberCache.GetMember<MethodSpec> (bt, set_result);
689 set_exception = MemberCache.GetMember<MethodSpec> (bt, set_exception);
692 task = MemberCache.GetMember<PropertySpec> (bt, task);
695 builder = AddCompilerGeneratedField ("$builder", new TypeExpression (bt, Location));
696 builder.ModFlags |= Modifiers.READONLY;
698 if (!base.DoDefineMembers ())
702 var block = instance_constructors[0].Block;
705 // Initialize continuation with state machine method
707 if (continuation != null) {
708 var args = new Arguments (1);
709 mg = MethodGroupExpr.CreatePredefined (StateMachineMethod.Spec, spec, Location);
710 args.Add (new Argument (mg));
713 new StatementExpression (new SimpleAssign (
714 new FieldExpr (continuation, Location),
715 new NewDelegate (action, args, Location),
720 mg = MethodGroupExpr.CreatePredefined (builder_factory, bt, Location);
722 new StatementExpression (new SimpleAssign (
723 new FieldExpr (builder, Location),
724 new Invocation (mg, new Arguments (0)),
727 if (has_task_return_type) {
728 hoisted_return = LocalVariable.CreateCompilerGenerated (bt.TypeArguments[0], block, Location);
734 public void EmitSetException (EmitContext ec, LocalVariableReference exceptionVariable)
737 // $builder.SetException (Exception)
739 var mg = MethodGroupExpr.CreatePredefined (set_exception, set_exception.DeclaringType, Location);
740 mg.InstanceExpression = new FieldExpr (Builder, Location) {
741 InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, Location)
744 Arguments args = new Arguments (1);
745 args.Add (new Argument (exceptionVariable));
747 mg.EmitCall (ec, args);
750 public void EmitSetResult (EmitContext ec)
753 // $builder.SetResult ();
754 // $builder.SetResult<return-type> (value);
756 var mg = MethodGroupExpr.CreatePredefined (set_result, set_result.DeclaringType, Location);
757 mg.InstanceExpression = new FieldExpr (Builder, Location) {
758 InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, Location)
762 if (hoisted_return == null) {
763 args = new Arguments (0);
765 args = new Arguments (1);
766 args.Add (new Argument (new LocalVariableReference (hoisted_return, Location)));
769 mg.EmitCall (ec, args);