mcs/mcs/async.cs

   1 //
   2 // async.cs: Asynchronous functions
   3 //
   4 // Author:
   5 //   Marek Safar (marek.safar@gmail.com)
   6 //
   7 // Dual licensed under the terms of the MIT X11 or GNU GPL
   8 //
   9 // Copyright 2011 Novell, Inc.
  10 // Copyright 2011-2012 Xamarin Inc.
  11 //
  12
  13 using System;
  14 using System.Collections.Generic;
  15 using System.Linq;
  16 using System.Collections;
  17
  18 #if STATIC
  19 using IKVM.Reflection;
  20 using IKVM.Reflection.Emit;
  21 #else
  22 using System.Reflection;
  23 using System.Reflection.Emit;
  24 #endif
  25
  26 namespace Mono.CSharp
  27 {
  28         public class Await : ExpressionStatement
  29         {
  30                 Expression expr;
  31                 AwaitStatement stmt;
  32
  33                 public Await (Expression expr, Location loc)
  34                 {
  35                         this.expr = expr;
  36                         this.loc = loc;
  37                 }
  38
  39                 public Expression Expr {
  40                         get {
  41                                 return expr;
  42                         }
  43                 }
  44
  45                 public AwaitStatement Statement {
  46                         get {
  47                                 return stmt;
  48                         }
  49                 }
  50
  51                 protected override void CloneTo (CloneContext clonectx, Expression target)
  52                 {
  53                         var t = (Await) target;
  54
  55                         t.expr = expr.Clone (clonectx);
  56                 }
  57
  58                 public override Expression CreateExpressionTree (ResolveContext ec)
  59                 {
  60                         throw new NotImplementedException ("ET");
  61                 }
  62
  63                 public override bool ContainsEmitWithAwait ()
  64                 {
  65                         return true;
  66                 }
  67
  68                 public override void FlowAnalysis (FlowAnalysisContext fc)
  69                 {
  70                         stmt.Expr.FlowAnalysis (fc);
  71
  72                         stmt.RegisterResumePoint ();
  73                 }
  74
  75                 protected override Expression DoResolve (ResolveContext rc)
  76                 {
  77                         if (rc.HasSet (ResolveContext.Options.LockScope)) {
  78                                 rc.Report.Error (1996, loc,
  79                                         "The `await' operator cannot be used in the body of a lock statement");
  80                         }
  81
  82                         if (rc.IsUnsafe) {
  83                                 rc.Report.Error (4004, loc,
  84                                         "The `await' operator cannot be used in an unsafe context");
  85                         }
  86
  87                         var bc = (BlockContext) rc;
  88
  89                         stmt = new AwaitStatement (expr, loc);
  90                         if (!stmt.Resolve (bc))
  91                                 return null;
  92
  93                         type = stmt.ResultType;
  94                         eclass = ExprClass.Variable;
  95                         return this;
  96                 }
  97
  98                 public override void Emit (EmitContext ec)
  99                 {
 100                         stmt.EmitPrologue (ec);
 101
 102                         using (ec.With (BuilderContext.Options.OmitDebugInfo, true)) {
 103                                 stmt.Emit (ec);
 104                         }
 105                 }
 106
 107                 public override Expression EmitToField (EmitContext ec)
 108                 {
 109                         stmt.EmitPrologue (ec);
 110                         return stmt.GetResultExpression (ec);
 111                 }
 112
 113                 public void EmitAssign (EmitContext ec, FieldExpr field)
 114                 {
 115                         stmt.EmitPrologue (ec);
 116                         field.InstanceExpression.Emit (ec);
 117                         stmt.Emit (ec);
 118                 }
 119
 120                 public override void EmitStatement (EmitContext ec)
 121                 {
 122                         stmt.EmitStatement (ec);
 123                 }
 124
 125                 public override void MarkReachable (Reachability rc)
 126                 {
 127                         base.MarkReachable (rc);
 128                         stmt.MarkReachable (rc);
 129                 }
 130
 131                 public override object Accept (StructuralVisitor visitor)
 132                 {
 133                         return visitor.Visit (this);
 134                 }
 135         }
 136
 137         public class AwaitStatement : YieldStatement<AsyncInitializer>
 138         {
 139                 public sealed class AwaitableMemberAccess : MemberAccess
 140                 {
 141                         public AwaitableMemberAccess (Expression expr)
 142                                 : base (expr, "GetAwaiter")
 143                         {
 144                         }
 145
 146                         public bool ProbingMode { get; set; }
 147
 148                         protected override void Error_TypeDoesNotContainDefinition (ResolveContext rc, TypeSpec type, string name)
 149                         {
 150                                 Error_OperatorCannotBeApplied (rc, type);
 151                         }
 152
 153                         protected override void Error_OperatorCannotBeApplied (ResolveContext rc, TypeSpec type)
 154                         {
 155                                 if (ProbingMode)
 156                                         return;
 157
 158                                 var invocation = LeftExpression as Invocation;
 159                                 if (invocation != null && invocation.MethodGroup != null && (invocation.MethodGroup.BestCandidate.Modifiers & Modifiers.ASYNC) != 0) {
 160                                         rc.Report.Error (4008, loc, "Cannot await void method `{0}'. Consider changing method return type to `Task'",
 161                                                 invocation.GetSignatureForError ());
 162                                 } else {
 163                                         rc.Report.Error (4001, loc, "Cannot await `{0}' expression", type.GetSignatureForError ());
 164                                 }
 165                         }
 166                 }
 167
 168                 sealed class GetResultInvocation : Invocation
 169                 {
 170                         public GetResultInvocation (MethodGroupExpr mge, Arguments arguments)
 171                                 : base (null, arguments)
 172                         {
 173                                 mg = mge;
 174                                 type = mg.BestCandidateReturnType;
 175                         }
 176
 177                         public override Expression EmitToField (EmitContext ec)
 178                         {
 179                                 return this;
 180                         }
 181                 }
 182
 183                 Field awaiter;
 184                 AwaiterDefinition awaiter_definition;
 185                 TypeSpec type;
 186                 TypeSpec result_type;
 187
 188                 public AwaitStatement (Expression expr, Location loc)
 189                         : base (expr, loc)
 190                 {
 191                         unwind_protect = true;
 192                 }
 193
 194                 #region Properties
 195
 196                 bool IsDynamic {
 197                         get {
 198                                 return awaiter_definition == null;
 199                         }
 200                 }
 201
 202                 public TypeSpec ResultType {
 203                         get {
 204                                 return result_type;
 205                         }
 206                 }
 207
 208                 #endregion
 209
 210                 protected override void DoEmit (EmitContext ec)
 211                 {
 212                         using (ec.With (BuilderContext.Options.OmitDebugInfo, true)) {
 213                                 GetResultExpression (ec).Emit (ec);
 214                         }
 215                 }
 216
 217                 public Expression GetResultExpression (EmitContext ec)
 218                 {
 219                         var fe_awaiter = new FieldExpr (awaiter, loc);
 220                         fe_awaiter.InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, loc);
 221
 222                         //
 223                         // result = awaiter.GetResult ();
 224                         //
 225                         if (IsDynamic) {
 226                                 var rc = new ResolveContext (ec.MemberContext);
 227                                 return new Invocation (new MemberAccess (fe_awaiter, "GetResult"), new Arguments (0)).Resolve (rc);
 228                         }
 229
 230                         var mg_result = MethodGroupExpr.CreatePredefined (awaiter_definition.GetResult, fe_awaiter.Type, loc);
 231                         mg_result.InstanceExpression = fe_awaiter;
 232
 233                         return new GetResultInvocation (mg_result, new Arguments (0));
 234                 }
 235
 236                 public void EmitPrologue (EmitContext ec)
 237                 {
 238                         awaiter = ((AsyncTaskStorey) machine_initializer.Storey).AddAwaiter (expr.Type);
 239
 240                         var fe_awaiter = new FieldExpr (awaiter, loc);
 241                         fe_awaiter.InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, loc);
 242
 243                         Label skip_continuation = ec.DefineLabel ();
 244
 245                         using (ec.With (BuilderContext.Options.OmitDebugInfo, true)) {
 246                                 //
 247                                 // awaiter = expr.GetAwaiter ();
 248                                 //
 249                                 fe_awaiter.EmitAssign (ec, expr, false, false);
 250
 251                                 Expression completed_expr;
 252                                 if (IsDynamic) {
 253                                         var rc = new ResolveContext (ec.MemberContext);
 254
 255                                         Arguments dargs = new Arguments (1);
 256                                         dargs.Add (new Argument (fe_awaiter));
 257                                         completed_expr = new DynamicMemberBinder ("IsCompleted", dargs, loc).Resolve (rc);
 258
 259                                         dargs = new Arguments (1);
 260                                         dargs.Add (new Argument (completed_expr));
 261                                         completed_expr = new DynamicConversion (ec.Module.Compiler.BuiltinTypes.Bool, 0, dargs, loc).Resolve (rc);
 262                                 } else {
 263                                         var pe = PropertyExpr.CreatePredefined (awaiter_definition.IsCompleted, loc);
 264                                         pe.InstanceExpression = fe_awaiter;
 265                                         completed_expr = pe;
 266                                 }
 267
 268                                 completed_expr.EmitBranchable (ec, skip_continuation, true);
 269                         }
 270
 271                         base.DoEmit (ec);
 272
 273                         //
 274                         // The stack has to be empty before calling await continuation. We handle this
 275                         // by lifting values which would be left on stack into class fields. The process
 276                         // is quite complicated and quite hard to test because any expression can possibly
 277                         // leave a value on the stack.
 278                         //
 279                         // Following assert fails when some of expression called before is missing EmitToField
 280                         // or parent expression fails to find await in children expressions
 281                         //
 282                         ec.AssertEmptyStack ();
 283
 284                         var storey = (AsyncTaskStorey) machine_initializer.Storey;
 285                         if (IsDynamic) {
 286                                 storey.EmitAwaitOnCompletedDynamic (ec, fe_awaiter);
 287                         } else {
 288                                 storey.EmitAwaitOnCompleted (ec, fe_awaiter);
 289                         }
 290
 291                         // Return ok
 292                         machine_initializer.EmitLeave (ec, unwind_protect);
 293
 294                         ec.MarkLabel (resume_point);
 295                         ec.MarkLabel (skip_continuation);
 296                 }
 297
 298                 public void EmitStatement (EmitContext ec)
 299                 {
 300                         EmitPrologue (ec);
 301                         DoEmit (ec);
 302
 303                         awaiter.IsAvailableForReuse = true;
 304
 305                         if (ResultType.Kind != MemberKind.Void)
 306                                 ec.Emit (OpCodes.Pop);
 307                 }
 308
 309                 void Error_WrongAwaiterPattern (ResolveContext rc, TypeSpec awaiter)
 310                 {
 311                         rc.Report.Error (4011, loc, "The awaiter type `{0}' must have suitable IsCompleted and GetResult members",
 312                                 awaiter.GetSignatureForError ());
 313                 }
 314
 315                 public override bool Resolve (BlockContext bc)
 316                 {
 317                         if (bc.CurrentBlock is Linq.QueryBlock) {
 318                                 bc.Report.Error (1995, loc,
 319                                         "The `await' operator may only be used in a query expression within the first collection expression of the initial `from' clause or within the collection expression of a `join' clause");
 320                                 return false;
 321                         }
 322
 323                         if (!base.Resolve (bc))
 324                                 return false;
 325
 326                         type = expr.Type;
 327                         Arguments args = new Arguments (0);
 328
 329                         //
 330                         // The await expression is of dynamic type
 331                         //
 332                         if (type.BuiltinType == BuiltinTypeSpec.Type.Dynamic) {
 333                                 result_type = type;
 334                                 expr = new Invocation (new MemberAccess (expr, "GetAwaiter"), args).Resolve (bc);
 335                                 return true;
 336                         }
 337
 338                         //
 339                         // Check whether the expression is awaitable
 340                         //
 341                         Expression ama = new AwaitableMemberAccess (expr).Resolve (bc);
 342                         if (ama == null)
 343                                 return false;
 344
 345                         var errors_printer = new SessionReportPrinter ();
 346                         var old = bc.Report.SetPrinter (errors_printer);
 347                         ama = new Invocation (ama, args).Resolve (bc);
 348                         bc.Report.SetPrinter (old);
 349
 350                         if (errors_printer.ErrorsCount > 0 || !MemberAccess.IsValidDotExpression (ama.Type)) {
 351                                 bc.Report.Error (1986, expr.Location,
 352                                         "The `await' operand type `{0}' must have suitable GetAwaiter method",
 353                                         expr.Type.GetSignatureForError ());
 354
 355                                 return false;
 356                         }
 357
 358                         var awaiter_type = ama.Type;
 359
 360                         awaiter_definition = bc.Module.GetAwaiter (awaiter_type);
 361
 362                         if (!awaiter_definition.IsValidPattern) {
 363                                 Error_WrongAwaiterPattern (bc, awaiter_type);
 364                                 return false;
 365                         }
 366
 367                         if (!awaiter_definition.INotifyCompletion) {
 368                                 bc.Report.Error (4027, loc, "The awaiter type `{0}' must implement interface `{1}'",
 369                                         awaiter_type.GetSignatureForError (), bc.Module.PredefinedTypes.INotifyCompletion.GetSignatureForError ());
 370                                 return false;
 371                         }
 372
 373                         expr = ama;
 374                         result_type = awaiter_definition.GetResult.ReturnType;
 375
 376                         return true;
 377                 }
 378         }
 379
 380         class AsyncInitializerStatement : StatementExpression
 381         {
 382                 public AsyncInitializerStatement (AsyncInitializer expr)
 383                         : base (expr)
 384                 {
 385                 }
 386
 387                 protected override bool DoFlowAnalysis (FlowAnalysisContext fc)
 388                 {
 389                         base.DoFlowAnalysis (fc);
 390
 391                         var init = (AsyncInitializer) Expr;
 392                         var res = !init.Block.HasReachableClosingBrace;
 393                         var storey = (AsyncTaskStorey) init.Storey;
 394
 395                         if (storey.ReturnType.IsGenericTask)
 396                                 return res;
 397
 398                         return true;
 399                 }
 400
 401                 public override Reachability MarkReachable (Reachability rc)
 402                 {
 403                         if (!rc.IsUnreachable)
 404                                 reachable = true;
 405
 406                         var init = (AsyncInitializer) Expr;
 407                         rc = init.Block.MarkReachable (rc);
 408
 409                         var storey = (AsyncTaskStorey) init.Storey;
 410
 411                         //
 412                         // Explicit return is required for Task<T> state machine
 413                         //
 414                         if (storey.ReturnType != null && storey.ReturnType.IsGenericTask)
 415                                 return rc;
 416
 417                     return Reachability.CreateUnreachable ();
 418                 }
 419         }
 420
 421         public class AsyncInitializer : StateMachineInitializer
 422         {
 423                 TypeInferenceContext return_inference;
 424
 425                 public AsyncInitializer (ParametersBlock block, TypeDefinition host, TypeSpec returnType)
 426                         : base (block, host, returnType)
 427                 {
 428                 }
 429
 430                 #region Properties
 431
 432                 public override string ContainerType {
 433                         get {
 434                                 return "async state machine block";
 435                         }
 436                 }
 437
 438                 public TypeSpec DelegateType {
 439                         get; set;
 440                 }
 441
 442                 public override bool IsIterator {
 443                         get {
 444                                 return false;
 445                         }
 446                 }
 447
 448                 public TypeInferenceContext ReturnTypeInference {
 449                         get {
 450                                 return return_inference;
 451                         }
 452                 }
 453
 454                 #endregion
 455
 456                 protected override BlockContext CreateBlockContext (BlockContext bc)
 457                 {
 458                         var ctx = base.CreateBlockContext (bc);
 459                         var am = bc.CurrentAnonymousMethod as AnonymousMethodBody;
 460                         if (am != null)
 461                                 return_inference = am.ReturnTypeInference;
 462
 463                         ctx.Set (ResolveContext.Options.TryScope);
 464
 465                         return ctx;
 466                 }
 467
 468                 public override void Emit (EmitContext ec)
 469                 {
 470                         throw new NotImplementedException ();
 471                 }
 472
 473                 protected override void EmitMoveNextEpilogue (EmitContext ec)
 474                 {
 475                         var storey = (AsyncTaskStorey) Storey;
 476                         storey.EmitSetResult (ec);
 477                 }
 478
 479                 public override void EmitStatement (EmitContext ec)
 480                 {
 481                         var storey = (AsyncTaskStorey) Storey;
 482                         storey.EmitInitializer (ec);
 483                         ec.Emit (OpCodes.Ret);
 484                 }
 485
 486                 public override void MarkReachable (Reachability rc)
 487                 {
 488                         //
 489                         // Reachability has been done in AsyncInitializerStatement
 490                         //
 491                 }
 492         }
 493
 494         class AsyncTaskStorey : StateMachine
 495         {
 496                 int awaiters;
 497                 Field builder;
 498                 readonly TypeSpec return_type;
 499                 MethodSpec set_result;
 500                 MethodSpec set_exception;
 501                 MethodSpec builder_factory;
 502                 MethodSpec builder_start;
 503                 PropertySpec task;
 504                 LocalVariable hoisted_return;
 505                 int locals_captured;
 506                 Dictionary<TypeSpec, List<Field>> stack_fields;
 507                 Dictionary<TypeSpec, List<Field>> awaiter_fields;
 508
 509                 public AsyncTaskStorey (ParametersBlock block, IMemberContext context, AsyncInitializer initializer, TypeSpec type)
 510                         : base (block, initializer.Host, context.CurrentMemberDefinition as MemberBase, context.CurrentTypeParameters, "async", MemberKind.Struct)
 511                 {
 512                         return_type = type;
 513                         awaiter_fields = new Dictionary<TypeSpec, List<Field>> ();
 514                 }
 515
 516                 #region Properties
 517
 518                 public LocalVariable HoistedReturn {
 519                         get {
 520                                 return hoisted_return;
 521                         }
 522                 }
 523
 524                 public TypeSpec ReturnType {
 525                         get {
 526                                 return return_type;
 527                         }
 528                 }
 529
 530                 public PropertySpec Task {
 531                         get {
 532                                 return task;
 533                         }
 534                 }
 535
 536                 protected override TypeAttributes TypeAttr {
 537                         get {
 538                                 return base.TypeAttr & ~TypeAttributes.SequentialLayout;
 539                         }
 540                 }
 541
 542                 #endregion
 543
 544                 public Field AddAwaiter (TypeSpec type)
 545                 {
 546                         if (mutator != null)
 547                                 type = mutator.Mutate (type);
 548
 549                         List<Field> existing_fields;
 550                         if (awaiter_fields.TryGetValue (type, out existing_fields)) {
 551                                 foreach (var f in existing_fields) {
 552                                         if (f.IsAvailableForReuse) {
 553                                                 f.IsAvailableForReuse = false;
 554                                                 return f;
 555                                         }
 556                                 }
 557                         }
 558
 559                         var field = AddCompilerGeneratedField ("$awaiter" + awaiters++.ToString ("X"), new TypeExpression (type, Location), true);
 560                         field.Define ();
 561
 562                         if (existing_fields == null) {
 563                                 existing_fields = new List<Field> ();
 564                                 awaiter_fields.Add (type, existing_fields);
 565                         }
 566
 567                         existing_fields.Add (field);
 568                         return field;
 569                 }
 570
 571                 public Field AddCapturedLocalVariable (TypeSpec type)
 572                 {
 573                         if (mutator != null)
 574                                 type = mutator.Mutate (type);
 575
 576                         List<Field> existing_fields = null;
 577                         if (stack_fields == null) {
 578                                 stack_fields = new Dictionary<TypeSpec, List<Field>> ();
 579                         } else if (stack_fields.TryGetValue (type, out existing_fields)) {
 580                                 foreach (var f in existing_fields) {
 581                                         if (f.IsAvailableForReuse) {
 582                                                 f.IsAvailableForReuse = false;
 583                                                 return f;
 584                                         }
 585                                 }
 586                         }
 587
 588                         var field = AddCompilerGeneratedField ("$stack" + locals_captured++.ToString ("X"), new TypeExpression (type, Location), true);
 589                         field.Define ();
 590
 591                         if (existing_fields == null) {
 592                                 existing_fields = new List<Field> ();
 593                                 stack_fields.Add (type, existing_fields);
 594                         }
 595
 596                         existing_fields.Add (field);
 597
 598                         return field;
 599                 }
 600
 601                 protected override bool DoDefineMembers ()
 602                 {
 603                         PredefinedType builder_type;
 604                         PredefinedMember<MethodSpec> bf;
 605                         PredefinedMember<MethodSpec> bs;
 606                         PredefinedMember<MethodSpec> sr;
 607                         PredefinedMember<MethodSpec> se;
 608                         PredefinedMember<MethodSpec> sm;
 609                         bool has_task_return_type = false;
 610                         var pred_members = Module.PredefinedMembers;
 611
 612                         if (return_type.Kind == MemberKind.Void) {
 613                                 builder_type = Module.PredefinedTypes.AsyncVoidMethodBuilder;
 614                                 bf = pred_members.AsyncVoidMethodBuilderCreate;
 615                                 bs = pred_members.AsyncVoidMethodBuilderStart;
 616                                 sr = pred_members.AsyncVoidMethodBuilderSetResult;
 617                                 se = pred_members.AsyncVoidMethodBuilderSetException;
 618                                 sm = pred_members.AsyncVoidMethodBuilderSetStateMachine;
 619                         } else if (return_type == Module.PredefinedTypes.Task.TypeSpec) {
 620                                 builder_type = Module.PredefinedTypes.AsyncTaskMethodBuilder;
 621                                 bf = pred_members.AsyncTaskMethodBuilderCreate;
 622                                 bs = pred_members.AsyncTaskMethodBuilderStart;
 623                                 sr = pred_members.AsyncTaskMethodBuilderSetResult;
 624                                 se = pred_members.AsyncTaskMethodBuilderSetException;
 625                                 sm = pred_members.AsyncTaskMethodBuilderSetStateMachine;
 626                                 task = pred_members.AsyncTaskMethodBuilderTask.Get ();
 627                         } else {
 628                                 builder_type = Module.PredefinedTypes.AsyncTaskMethodBuilderGeneric;
 629                                 bf = pred_members.AsyncTaskMethodBuilderGenericCreate;
 630                                 bs = pred_members.AsyncTaskMethodBuilderGenericStart;
 631                                 sr = pred_members.AsyncTaskMethodBuilderGenericSetResult;
 632                                 se = pred_members.AsyncTaskMethodBuilderGenericSetException;
 633                                 sm = pred_members.AsyncTaskMethodBuilderGenericSetStateMachine;
 634                                 task = pred_members.AsyncTaskMethodBuilderGenericTask.Get ();
 635                                 has_task_return_type = true;
 636                         }
 637
 638                         set_result = sr.Get ();
 639                         set_exception = se.Get ();
 640                         builder_factory = bf.Get ();
 641                         builder_start = bs.Get ();
 642
 643                         var istate_machine = Module.PredefinedTypes.IAsyncStateMachine;
 644                         var set_statemachine = sm.Get ();
 645
 646                         if (!builder_type.Define () || !istate_machine.Define () || set_result == null || builder_factory == null ||
 647                                 set_exception == null || set_statemachine == null || builder_start == null ||
 648                                 !Module.PredefinedTypes.INotifyCompletion.Define ()) {
 649                                 Report.Error (1993, Location,
 650                                         "Cannot find compiler required types for asynchronous functions support. Are you targeting the wrong framework version?");
 651                                 return base.DoDefineMembers ();
 652                         }
 653
 654                         var bt = builder_type.TypeSpec;
 655
 656                         //
 657                         // Inflate generic Task types
 658                         //
 659                         if (has_task_return_type) {
 660                                 var task_return_type = return_type.TypeArguments;
 661                                 if (mutator != null)
 662                                         task_return_type = mutator.Mutate (task_return_type);
 663
 664                                 bt = bt.MakeGenericType (Module, task_return_type);
 665                                 set_result = MemberCache.GetMember (bt, set_result);
 666                                 set_exception = MemberCache.GetMember (bt, set_exception);
 667                                 set_statemachine = MemberCache.GetMember (bt, set_statemachine);
 668
 669                                 if (task != null)
 670                                         task = MemberCache.GetMember (bt, task);
 671                         }
 672
 673                         builder = AddCompilerGeneratedField ("$builder", new TypeExpression (bt, Location));
 674
 675                         var set_state_machine = new Method (this, new TypeExpression (Compiler.BuiltinTypes.Void, Location),
 676                                 Modifiers.COMPILER_GENERATED | Modifiers.DEBUGGER_HIDDEN | Modifiers.PUBLIC,
 677                                 new MemberName ("SetStateMachine"),
 678                                 ParametersCompiled.CreateFullyResolved (
 679                                         new Parameter (new TypeExpression (istate_machine.TypeSpec, Location), "stateMachine", Parameter.Modifier.NONE, null, Location),
 680                                         istate_machine.TypeSpec),
 681                                 null);
 682
 683                         ToplevelBlock block = new ToplevelBlock (Compiler, set_state_machine.ParameterInfo, Location);
 684                         block.IsCompilerGenerated = true;
 685                         set_state_machine.Block = block;
 686
 687                         Members.Add (set_state_machine);
 688
 689                         if (!base.DoDefineMembers ())
 690                                 return false;
 691
 692                         //
 693                         // Fabricates SetStateMachine method
 694                         //
 695                         // public void SetStateMachine (IAsyncStateMachine stateMachine)
 696                         // {
 697                         //    $builder.SetStateMachine (stateMachine);
 698                         // }
 699                         //
 700                         var mg = MethodGroupExpr.CreatePredefined (set_statemachine, bt, Location);
 701                         mg.InstanceExpression = new FieldExpr (builder, Location);
 702
 703                         var param_reference = block.GetParameterReference (0, Location);
 704                         param_reference.Type = istate_machine.TypeSpec;
 705                         param_reference.eclass = ExprClass.Variable;
 706
 707                         var args = new Arguments (1);
 708                         args.Add (new Argument (param_reference));
 709                         set_state_machine.Block.AddStatement (new StatementExpression (new Invocation (mg, args)));
 710
 711                         if (has_task_return_type) {
 712                                 hoisted_return = LocalVariable.CreateCompilerGenerated (bt.TypeArguments[0], StateMachineMethod.Block, Location);
 713                         }
 714
 715                         return true;
 716                 }
 717
 718                 public void EmitAwaitOnCompletedDynamic (EmitContext ec, FieldExpr awaiter)
 719                 {
 720                         var critical = Module.PredefinedTypes.ICriticalNotifyCompletion;
 721                         if (!critical.Define ()) {
 722                                 throw new NotImplementedException ();
 723                         }
 724
 725                         var temp_critical = new LocalTemporary (critical.TypeSpec);
 726                         var label_critical = ec.DefineLabel ();
 727                         var label_end = ec.DefineLabel ();
 728
 729                         //
 730                         // Special path for dynamic awaiters
 731                         //
 732                         // var awaiter = this.$awaiter as ICriticalNotifyCompletion;
 733                         // if (awaiter == null) {
 734                         //    var completion = (INotifyCompletion) this.$awaiter;
 735                         //    this.$builder.AwaitOnCompleted (ref completion, ref this);
 736                         // } else {
 737                         //    this.$builder.AwaitUnsafeOnCompleted (ref awaiter, ref this);
 738                         // }
 739                         //
 740                         awaiter.Emit (ec);
 741                         ec.Emit (OpCodes.Isinst, critical.TypeSpec);
 742                         temp_critical.Store (ec);
 743                         temp_critical.Emit (ec);
 744                         ec.Emit (OpCodes.Brtrue_S, label_critical);
 745
 746                         var temp = new LocalTemporary (Module.PredefinedTypes.INotifyCompletion.TypeSpec);
 747                         awaiter.Emit (ec);
 748                         ec.Emit (OpCodes.Castclass, temp.Type);
 749                         temp.Store (ec);
 750                         EmitOnCompleted (ec, temp, false);
 751                         temp.Release (ec);
 752                         ec.Emit (OpCodes.Br_S, label_end);
 753
 754                         ec.MarkLabel (label_critical);
 755
 756                         EmitOnCompleted (ec, temp_critical, true);
 757
 758                         ec.MarkLabel (label_end);
 759
 760                         temp_critical.Release (ec);
 761                 }
 762
 763                 public void EmitAwaitOnCompleted (EmitContext ec, FieldExpr awaiter)
 764                 {
 765                         bool unsafe_version = false;
 766                         if (Module.PredefinedTypes.ICriticalNotifyCompletion.Define ()) {
 767                                 unsafe_version = awaiter.Type.ImplementsInterface (Module.PredefinedTypes.ICriticalNotifyCompletion.TypeSpec, false);
 768                         }
 769
 770                         EmitOnCompleted (ec, awaiter, unsafe_version);
 771                 }
 772
 773                 void EmitOnCompleted (EmitContext ec, Expression awaiter, bool unsafeVersion)
 774                 {
 775                         var pm = Module.PredefinedMembers;
 776                         PredefinedMember<MethodSpec> predefined;
 777                         bool has_task_return_type = false;
 778                         if (return_type.Kind == MemberKind.Void) {
 779                                 predefined = unsafeVersion ? pm.AsyncVoidMethodBuilderOnCompletedUnsafe : pm.AsyncVoidMethodBuilderOnCompleted;
 780                         } else if (return_type == Module.PredefinedTypes.Task.TypeSpec) {
 781                                 predefined = unsafeVersion ? pm.AsyncTaskMethodBuilderOnCompletedUnsafe : pm.AsyncTaskMethodBuilderOnCompleted;
 782                         } else {
 783                                 predefined = unsafeVersion ? pm.AsyncTaskMethodBuilderGenericOnCompletedUnsafe : pm.AsyncTaskMethodBuilderGenericOnCompleted;
 784                                 has_task_return_type = true;
 785                         }
 786
 787                         var on_completed = predefined.Resolve (Location);
 788                         if (on_completed == null)
 789                                 return;
 790
 791                         if (has_task_return_type)
 792                                 on_completed = MemberCache.GetMember<MethodSpec> (set_result.DeclaringType, on_completed);
 793
 794                         on_completed = on_completed.MakeGenericMethod (this, awaiter.Type, ec.CurrentType);
 795
 796                         var mg = MethodGroupExpr.CreatePredefined (on_completed, on_completed.DeclaringType, Location);
 797                         mg.InstanceExpression = new FieldExpr (builder, Location) {
 798                                 InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, Location)
 799                         };
 800
 801                         var args = new Arguments (2);
 802                         args.Add (new Argument (awaiter, Argument.AType.Ref));
 803                         args.Add (new Argument (new CompilerGeneratedThis (CurrentType, Location), Argument.AType.Ref));
 804                         using (ec.With (BuilderContext.Options.OmitDebugInfo, true)) {
 805                                 mg.EmitCall (ec, args);
 806                         }
 807                 }
 808
 809                 public void EmitInitializer (EmitContext ec)
 810                 {
 811                         //
 812                         // Some predefined types are missing
 813                         //
 814                         if (builder == null)
 815                                 return;
 816
 817                         var instance = (TemporaryVariableReference) Instance;
 818                         var builder_field = builder.Spec;
 819                         if (MemberName.Arity > 0) {
 820                                 builder_field = MemberCache.GetMember (instance.Type, builder_field);
 821                         }
 822
 823                         //
 824                         // Inflated factory method when task is of generic type
 825                         //
 826                         if (builder_factory.DeclaringType.IsGeneric) {
 827                                 var task_return_type = return_type.TypeArguments;
 828                                 var bt = builder_factory.DeclaringType.MakeGenericType (Module, task_return_type);
 829                                 builder_factory = MemberCache.GetMember (bt, builder_factory);
 830                                 builder_start = MemberCache.GetMember (bt, builder_start);
 831                         }
 832
 833                         //
 834                         // stateMachine.$builder = AsyncTaskMethodBuilder<{task-type}>.Create();
 835                         //
 836                         instance.AddressOf (ec, AddressOp.Store);
 837                         ec.Emit (OpCodes.Call, builder_factory);
 838                         ec.Emit (OpCodes.Stfld, builder_field);
 839
 840                         //
 841                         // stateMachine.$builder.Start<{storey-type}>(ref stateMachine);
 842                         //
 843                         instance.AddressOf (ec, AddressOp.Store);
 844                         ec.Emit (OpCodes.Ldflda, builder_field);
 845                         if (Task != null)
 846                                 ec.Emit (OpCodes.Dup);
 847                         instance.AddressOf (ec, AddressOp.Store);
 848                         ec.Emit (OpCodes.Call, builder_start.MakeGenericMethod (Module, instance.Type));
 849
 850                         //
 851                         // Emits return stateMachine.$builder.Task;
 852                         //
 853                         if (Task != null) {
 854                                 var task_get = Task.Get;
 855
 856                                 if (MemberName.Arity > 0) {
 857                                         task_get = MemberCache.GetMember (builder_field.MemberType, task_get);
 858                                 }
 859
 860                                 var pe_task = new PropertyExpr (Task, Location) {
 861                                         InstanceExpression = EmptyExpression.Null,      // Comes from the dup above
 862                                         Getter = task_get
 863                                 };
 864
 865                                 pe_task.Emit (ec);
 866                         }
 867                 }
 868
 869                 public void EmitSetException (EmitContext ec, LocalVariableReference exceptionVariable)
 870                 {
 871                         //
 872                         // $builder.SetException (Exception)
 873                         //
 874                         var mg = MethodGroupExpr.CreatePredefined (set_exception, set_exception.DeclaringType, Location);
 875                         mg.InstanceExpression = new FieldExpr (builder, Location) {
 876                                 InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, Location)
 877                         };
 878
 879                         Arguments args = new Arguments (1);
 880                         args.Add (new Argument (exceptionVariable));
 881
 882                         using (ec.With (BuilderContext.Options.OmitDebugInfo, true)) {
 883                                 mg.EmitCall (ec, args);
 884                         }
 885                 }
 886
 887                 public void EmitSetResult (EmitContext ec)
 888                 {
 889                         //
 890                         // $builder.SetResult ();
 891                         // $builder.SetResult<return-type> (value);
 892                         //
 893                         var mg = MethodGroupExpr.CreatePredefined (set_result, set_result.DeclaringType, Location);
 894                         mg.InstanceExpression = new FieldExpr (builder, Location) {
 895                                 InstanceExpression = new CompilerGeneratedThis (ec.CurrentType, Location)
 896                         };
 897
 898                         Arguments args;
 899                         if (hoisted_return == null) {
 900                                 args = new Arguments (0);
 901                         } else {
 902                                 args = new Arguments (1);
 903                                 args.Add (new Argument (new LocalVariableReference (hoisted_return, Location)));
 904                         }
 905
 906                         using (ec.With (BuilderContext.Options.OmitDebugInfo, true)) {
 907                                 mg.EmitCall (ec, args);
 908                         }
 909                 }
 910
 911                 protected override TypeSpec[] ResolveBaseTypes (out FullNamedExpression base_class)
 912                 {
 913                         base_type = Compiler.BuiltinTypes.ValueType;
 914                         base_class = null;
 915
 916                         var istate_machine = Module.PredefinedTypes.IAsyncStateMachine;
 917                         if (istate_machine.Define ()) {
 918                                 return new[] { istate_machine.TypeSpec };
 919                         }
 920
 921                         return null;
 922                 }
 923         }
 924
 925         public class StackFieldExpr : FieldExpr, IExpressionCleanup
 926         {
 927                 public StackFieldExpr (Field field)
 928                         : base (field, Location.Null)
 929                 {
 930                 }
 931
 932                 public bool IsAvailableForReuse {
 933                         get {
 934                                 var field = (Field) spec.MemberDefinition;
 935                                 return field.IsAvailableForReuse;
 936                         }
 937                         set {
 938                                 var field = (Field) spec.MemberDefinition;
 939                                 field.IsAvailableForReuse = value;
 940                         }
 941                 }
 942
 943                 public override void AddressOf (EmitContext ec, AddressOp mode)
 944                 {
 945                         base.AddressOf (ec, mode);
 946
 947                         if (mode == AddressOp.Load) {
 948                                 IsAvailableForReuse = true;
 949                         }
 950                 }
 951
 952                 public override void Emit (EmitContext ec)
 953                 {
 954                         base.Emit (ec);
 955
 956                         PrepareCleanup (ec);
 957                 }
 958
 959                 public void EmitLoad (EmitContext ec)
 960                 {
 961                         base.Emit (ec);
 962                 }
 963
 964                 public void PrepareCleanup (EmitContext ec)
 965                 {
 966                         IsAvailableForReuse = true;
 967
 968                         //
 969                         // Release any captured reference type stack variables
 970                         // to imitate real stack behavour and help GC stuff early
 971                         //
 972                         if (TypeSpec.IsReferenceType (type)) {
 973                                 ec.AddStatementEpilog (this);
 974                         }
 975                 }
 976
 977                 void IExpressionCleanup.EmitCleanup (EmitContext ec)
 978                 {
 979                         EmitAssign (ec, new NullConstant (type, loc), false, false);
 980                 }
 981         }
 982 }