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.
13 using System.Collections.Generic;
15 using System.Collections;
18 using IKVM.Reflection.Emit;
20 using System.Reflection.Emit;
25 class Await : ExpressionStatement
30 public Await (Expression expr, Location loc)
36 protected override void CloneTo (CloneContext clonectx, Expression target)
38 var t = (Await) target;
40 t.expr = expr.Clone (clonectx);
43 public override Expression CreateExpressionTree (ResolveContext ec)
45 throw new NotImplementedException ("ET");
48 public override bool ContainsEmitWithAwait ()
53 protected override Expression DoResolve (ResolveContext rc)
55 if (rc.HasSet (ResolveContext.Options.FinallyScope)) {
56 rc.Report.Error (1984, loc,
57 "The `await' operator cannot be used in the body of a finally clause");
60 if (rc.HasSet (ResolveContext.Options.CatchScope)) {
61 rc.Report.Error (1985, loc,
62 "The `await' operator cannot be used in the body of a catch clause");
65 if (rc.HasSet (ResolveContext.Options.LockScope)) {
66 rc.Report.Error (1996, loc,
67 "The `await' operator cannot be used in the body of a lock statement");
70 if (rc.HasSet (ResolveContext.Options.ExpressionTreeConversion)) {
71 rc.Report.Error (1989, loc, "An expression tree cannot contain an await operator");
76 // TODO: New error code
77 rc.Report.Error (-1900, loc,
78 "The `await' operator cannot be used in an unsafe context");
81 var bc = (BlockContext) rc;
83 if (!bc.CurrentBlock.ParametersBlock.IsAsync) {
84 // TODO: Should check for existence of await type but
88 stmt = new AwaitStatement (expr, loc);
89 if (!stmt.Resolve (bc))
92 type = stmt.ResultType;
93 eclass = ExprClass.Variable;
97 public override void Emit (EmitContext ec)
99 stmt.EmitPrologue (ec);
103 public override Expression EmitToField (EmitContext ec)
105 stmt.EmitPrologue (ec);
106 return stmt.GetResultExpression (ec);
109 public void EmitAssign (EmitContext ec, FieldExpr field)
111 stmt.EmitPrologue (ec);
112 field.InstanceExpression.Emit (ec);
116 public override void EmitStatement (EmitContext ec)
118 stmt.EmitStatement (ec);
122 class AwaitStatement : YieldStatement<AsyncInitializer>
124 sealed class AwaitableMemberAccess : MemberAccess
126 public AwaitableMemberAccess (Expression expr)
127 : base (expr, "GetAwaiter")
131 protected override void Error_TypeDoesNotContainDefinition (ResolveContext rc, TypeSpec type, string name)
133 Error_WrongGetAwaiter (rc, loc, type);
136 protected override void Error_OperatorCannotBeApplied (ResolveContext rc, TypeSpec type)
138 rc.Report.Error (1991, loc, "Cannot await `{0}' expression", type.GetSignatureForError ());
142 sealed class GetResultInvocation : Invocation
144 public GetResultInvocation (MethodGroupExpr mge, Arguments arguments)
145 : base (null, arguments)
148 type = mg.BestCandidateReturnType;
151 public override Expression EmitToField (EmitContext ec)
158 PropertyExpr is_completed;
159 MethodSpec on_completed;
160 MethodSpec get_result;
163 public AwaitStatement (Expression expr, Location loc)
170 public TypeSpec Type {
176 public TypeSpec ResultType {
178 return get_result.ReturnType;
184 protected override void DoEmit (EmitContext ec)
186 GetResultExpression (ec).Emit (ec);
189 public Invocation GetResultExpression (EmitContext ec)
191 var fe_awaiter = new FieldExpr (awaiter, loc);
192 fe_awaiter.InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, loc);
195 // result = awaiter.GetResult ();
197 var mg_result = MethodGroupExpr.CreatePredefined (get_result, fe_awaiter.Type, loc);
198 mg_result.InstanceExpression = fe_awaiter;
200 return new GetResultInvocation (mg_result, new Arguments (0));
203 public void EmitPrologue (EmitContext ec)
205 var fe_awaiter = new FieldExpr (awaiter, loc);
206 fe_awaiter.InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, loc);
209 // awaiter = expr.GetAwaiter ();
211 fe_awaiter.EmitAssign (ec, expr, false, false);
213 Label skip_continuation = ec.DefineLabel ();
215 is_completed.InstanceExpression = fe_awaiter;
216 is_completed.EmitBranchable (ec, skip_continuation, true);
220 FieldSpec[] stack_fields = null;
221 TypeSpec[] stack = null;
224 // The stack has to be empty before calling await continuation. We handle this
225 // by lifting values which would be left on stack into class fields. The process
226 // is quite complicated and quite hard to test because any expression can possibly
227 // leave a value on the stack.
229 // Following assert fails when some of expression called before is missing EmitToField
230 // or parent expression fails to find await in children expressions
232 ec.AssertEmptyStack ();
234 var mg_completed = MethodGroupExpr.CreatePredefined (on_completed, fe_awaiter.Type, loc);
235 mg_completed.InstanceExpression = fe_awaiter;
237 var args = new Arguments (1);
238 var storey = (AsyncTaskStorey) machine_initializer.Storey;
239 var fe_cont = new FieldExpr (storey.Continuation, loc);
240 fe_cont.InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, loc);
242 args.Add (new Argument (fe_cont));
245 // awaiter.OnCompleted (continuation);
247 mg_completed.EmitCall (ec, args);
250 machine_initializer.EmitLeave (ec, unwind_protect);
252 ec.MarkLabel (resume_point);
254 if (stack_fields != null) {
255 for (int i = 0; i < stack_fields.Length; ++i) {
258 var field = stack_fields[i];
261 // We don't store `this' because it can be easily re-created
266 if (stack[i] is ReferenceContainer)
267 ec.Emit (OpCodes.Ldflda, field);
269 ec.Emit (OpCodes.Ldfld, field);
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))
312 // The task result is of dynamic type
314 if (expr.Type.BuiltinType == BuiltinTypeSpec.Type.Dynamic)
315 throw new NotImplementedException ("dynamic await");
318 // Check whether the expression is awaitable
320 Expression ama = new AwaitableMemberAccess (expr).Resolve (bc);
324 Arguments args = new Arguments (0);
326 var errors_printer = new SessionReportPrinter ();
327 var old = bc.Report.SetPrinter (errors_printer);
328 ama = new Invocation (ama, args).Resolve (bc);
330 if (errors_printer.ErrorsCount > 0 || !MemberAccess.IsValidDotExpression (ama.Type)) {
331 bc.Report.SetPrinter (old);
332 Error_WrongGetAwaiter (bc, loc, expr.Type);
336 var awaiter_type = ama.Type;
337 awaiter = ((AsyncTaskStorey) machine_initializer.Storey).AddAwaiter (awaiter_type, loc);
341 // Predefined: bool IsCompleted { get; }
343 var is_completed_ma = new MemberAccess (expr, "IsCompleted").Resolve (bc);
344 if (is_completed_ma != null) {
345 is_completed = is_completed_ma as PropertyExpr;
346 if (is_completed != null && is_completed.Type.BuiltinType == BuiltinTypeSpec.Type.Bool && is_completed.IsInstance && is_completed.Getter != null) {
349 bc.Report.SetPrinter (old);
350 Error_WrongAwaiterPattern (bc, awaiter_type);
355 bc.Report.SetPrinter (old);
357 if (errors_printer.ErrorsCount > 0) {
358 Error_WrongAwaiterPattern (bc, awaiter_type);
363 // Predefined: OnCompleted (Action)
365 if (bc.Module.PredefinedTypes.Action.Define ()) {
366 on_completed = MemberCache.FindMember (awaiter_type, MemberFilter.Method ("OnCompleted", 0,
367 ParametersCompiled.CreateFullyResolved (bc.Module.PredefinedTypes.Action.TypeSpec), bc.Module.Compiler.BuiltinTypes.Void),
368 BindingRestriction.InstanceOnly) as MethodSpec;
370 if (on_completed == null) {
371 Error_WrongAwaiterPattern (bc, awaiter_type);
377 // Predefined: GetResult ()
379 // The method return type is also result type of await expression
381 get_result = MemberCache.FindMember (awaiter_type, MemberFilter.Method ("GetResult", 0,
382 ParametersCompiled.EmptyReadOnlyParameters, null),
383 BindingRestriction.InstanceOnly) as MethodSpec;
385 if (get_result == null) {
386 Error_WrongAwaiterPattern (bc, awaiter_type);
394 public class AsyncInitializer : StateMachineInitializer
396 TypeInferenceContext return_inference;
398 public AsyncInitializer (ParametersBlock block, TypeContainer host, TypeSpec returnType)
399 : base (block, host, returnType)
405 public override string ContainerType {
407 return "async state machine block";
411 public override bool IsIterator {
417 public Block OriginalBlock {
423 public TypeInferenceContext ReturnTypeInference {
425 return return_inference;
431 public static void Create (IMemberContext context, ParametersBlock block, ParametersCompiled parameters, TypeContainer host, TypeSpec returnType, Location loc)
433 if (returnType != null && returnType.Kind != MemberKind.Void &&
434 returnType != host.Module.PredefinedTypes.Task.TypeSpec &&
435 !returnType.IsGenericTask) {
436 host.Compiler.Report.Error (1983, loc, "The return type of an async method must be void, Task, or Task<T>");
439 for (int i = 0; i < parameters.Count; i++) {
440 Parameter p = parameters[i];
441 Parameter.Modifier mod = p.ModFlags;
442 if ((mod & Parameter.Modifier.ISBYREF) != 0) {
443 host.Compiler.Report.Error (1988, p.Location,
444 "Async methods cannot have ref or out parameters");
449 if (p is ArglistParameter) {
450 host.Compiler.Report.Error (1636, p.Location,
451 "__arglist is not allowed in parameter list of iterators");
456 if (parameters.Types[i].IsPointer) {
457 host.Compiler.Report.Error (1637, p.Location,
458 "Iterators cannot have unsafe parameters or yield types");
464 //if (!block.HasAwait) {
467 block.WrapIntoAsyncTask (context, host, returnType);
470 protected override BlockContext CreateBlockContext (ResolveContext rc)
472 var ctx = base.CreateBlockContext (rc);
473 var lambda = rc.CurrentAnonymousMethod as LambdaMethod;
475 return_inference = lambda.ReturnTypeInference;
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;
576 LocalVariable hoisted_return;
579 public AsyncTaskStorey (IMemberContext context, AsyncInitializer initializer, TypeSpec type)
580 : base (initializer.OriginalBlock, initializer.Host,context.CurrentMemberDefinition as MemberBase, context.CurrentTypeParameters, "async")
587 public Field Builder {
593 public Field Continuation {
599 public LocalVariable HoistedReturn {
601 return hoisted_return;
605 public TypeSpec ReturnType {
611 public PropertySpec Task {
619 public Field AddAwaiter (TypeSpec type, Location loc)
621 return AddCompilerGeneratedField ("$awaiter" + awaiters++.ToString ("X"), new TypeExpression (type, loc));
624 public Field AddCapturedLocalVariable (TypeSpec type)
627 type = mutator.Mutate (type);
629 var field = AddCompilerGeneratedField ("<s>$" + locals_captured++.ToString ("X"), new TypeExpression (type, Location));
635 protected override bool DoDefineMembers ()
637 var action = Module.PredefinedTypes.Action.Resolve ();
638 if (action != null) {
639 continuation = AddCompilerGeneratedField ("$continuation", new TypeExpression (action, Location));
640 continuation.ModFlags |= Modifiers.READONLY;
643 PredefinedType builder_type;
644 PredefinedMember<MethodSpec> bf;
645 PredefinedMember<MethodSpec> sr;
646 bool has_task_return_type = false;
647 var pred_members = Module.PredefinedMembers;
649 if (return_type.Kind == MemberKind.Void) {
650 builder_type = Module.PredefinedTypes.AsyncVoidMethodBuilder;
651 bf = pred_members.AsyncVoidMethodBuilderCreate;
652 sr = pred_members.AsyncVoidMethodBuilderSetResult;
653 } else if (return_type == Module.PredefinedTypes.Task.TypeSpec) {
654 builder_type = Module.PredefinedTypes.AsyncTaskMethodBuilder;
655 bf = pred_members.AsyncTaskMethodBuilderCreate;
656 sr = pred_members.AsyncTaskMethodBuilderSetResult;
657 task = pred_members.AsyncTaskMethodBuilderTask.Resolve (Location);
659 builder_type = Module.PredefinedTypes.AsyncTaskMethodBuilderGeneric;
660 bf = pred_members.AsyncTaskMethodBuilderGenericCreate;
661 sr = pred_members.AsyncTaskMethodBuilderGenericSetResult;
662 task = pred_members.AsyncTaskMethodBuilderGenericTask.Resolve (Location);
663 has_task_return_type = true;
666 set_result = sr.Resolve (Location);
667 var builder_factory = bf.Resolve (Location);
668 var bt = builder_type.Resolve ();
669 if (bt == null || set_result == null || builder_factory == null)
673 // Inflate generic Task types
675 if (has_task_return_type) {
676 var task_return_type = return_type.TypeArguments;
678 task_return_type = mutator.Mutate (task_return_type);
680 bt = bt.MakeGenericType (Module, task_return_type);
681 builder_factory = MemberCache.GetMember<MethodSpec> (bt, builder_factory);
682 set_result = MemberCache.GetMember<MethodSpec> (bt, set_result);
685 task = MemberCache.GetMember<PropertySpec> (bt, task);
688 builder = AddCompilerGeneratedField ("$builder", new TypeExpression (bt, Location));
689 builder.ModFlags |= Modifiers.READONLY;
691 if (!base.DoDefineMembers ())
695 var block = instance_constructors[0].Block;
698 // Initialize continuation with state machine method
700 if (continuation != null) {
701 var args = new Arguments (1);
702 mg = MethodGroupExpr.CreatePredefined (StateMachineMethod.Spec, spec, Location);
703 args.Add (new Argument (mg));
706 new StatementExpression (new SimpleAssign (
707 new FieldExpr (continuation, Location),
708 new NewDelegate (action, args, Location),
713 mg = MethodGroupExpr.CreatePredefined (builder_factory, bt, Location);
715 new StatementExpression (new SimpleAssign (
716 new FieldExpr (builder, Location),
717 new Invocation (mg, new Arguments (0)),
720 if (has_task_return_type) {
721 hoisted_return = LocalVariable.CreateCompilerGenerated (bt.TypeArguments[0], block, Location);
727 public void EmitSetResult (EmitContext ec)
730 // $builder.SetResult ();
731 // $builder.SetResult<return-type> (value);
733 var mg = MethodGroupExpr.CreatePredefined (set_result, set_result.DeclaringType, Location);
734 mg.InstanceExpression = new FieldExpr (Builder, Location) {
735 InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, Location)
739 if (hoisted_return == null) {
740 args = new Arguments (0);
742 args = new Arguments (1);
743 args.Add (new Argument (new LocalVariableReference (hoisted_return, Location)));
746 mg.EmitCall (ec, args);