Now the
async / await keywords are in C#. Just like the
async and ! in F#, this new C# feature provides great convenience. There are many nice documents talking about how to use
async / await in specific scenarios, like using
async methods in ASP.
NET 4.5 and in ASP.
NET MVC 4, etc. In this article we will look at the real code working behind the syntax sugar. According to MSDN: The
async modifier indicates that the method, lambda expression, or anonymous method that it modifies is asynchronous. Since lambda expression / anonymous method will be compiled to normal method, we will focus on normal
async method. Preparation First of all, Some helper methods need to make up. internal class HelperMethods
{
internal static int Method(int arg0, int arg1)
{
// Do some IO.
WebClient client = new WebClient();
Enumerable.Repeat("http://weblogs.asp.net/dixin", 10)
.Select(client.DownloadString).ToArray();
int result = arg0 + arg1;
return result;
}
internal static Task<int> MethodTask(int arg0, int arg1)
{
Task<int> task = new Task<int>(() => Method(arg0, arg1));
task.Start(); // Hot task (started task) should always be returned.
return task;
}
internal static void Before()
{
}
internal static void Continuation1(int arg)
{
}
internal static void Continuation2(int arg)
{
}
}
Here Method() is a long running method doing some IO. Then MethodTask() wraps it into a Task and return that Task. Nothing special here.
Await something in
async method
Since MethodTask() returns Task, let’s try to await it:
internal class AsyncMethods
{
internal static
async Task<int> MethodAsync(int arg0, int arg1)
{
int result = await HelperMethods.MethodTask(arg0, arg1);
return result;
}
}
Because we used await in the method,
async must be put on the method. Now we get the first
async method. According to the naming convenience, it is named MethodAsync. Of course a
async method can be awaited. So we have a CallMethodAsync() to call MethodAsync():
internal class AsyncMethods
{
internal static
async Task<int> CallMethodAsync(int arg0, int arg1)
{
int result = await MethodAsync(arg0, arg1);
return result;
}
}
After compilation, MethodAsync() and CallMethodAsync() becomes the same logic. This is the code of MethodAsyc():
internal class CompiledAsyncMethods
{
[DebuggerStepThrough]
[AsyncStateMachine(typeof(MethodAsyncStateMachine))] //
async
internal static /*async*/ Task<int> MethodAsync(int arg0, int arg1)
{
MethodAsyncStateMachine methodAsyncStateMachine = new MethodAsyncStateMachine()
{
Arg0 = arg0,
Arg1 = arg1,
Builder = AsyncTaskMethodBuilder<int>.Create(),
State = -1
};
methodAsyncStateMachine.Builder.Start(ref methodAsyncStateMachine);
return methodAsyncStateMachine.Builder.Task;
}
}
It just creates and starts a state machine, MethodAsyncStateMachine:
[CompilerGenerated]
[StructLayout(LayoutKind.Auto)]
internal struct MethodAsyncStateMachine : IAsyncStateMachine
{
public int State;
public AsyncTaskMethodBuilder<int> Builder;
public int Arg0;
public int Arg1;
public int Result;
private TaskAwaiter<int> awaitor;
void IAsyncStateMachine.MoveNext()
{
try
{
if (this.State != 0)
{
this.awaitor = HelperMethods.MethodTask(this.Arg0, this.Arg1).GetAwaiter();
if (!this.awaitor.IsCompleted)
{
this.State = 0;
this.Builder.AwaitUnsafeOnCompleted(ref this.awaitor, ref this);
return;
}
}
else
{
this.State = -1;
}
this.Result = this.awaitor.GetResult();
}
catch (Exception exception)
{
this.State = -2;
this.Builder.SetException(exception);
return;
}
this.State = -2;
this.Builder.SetResult(this.Result);
}
[DebuggerHidden]
void IAsyncStateMachine.SetStateMachine(IAsyncStateMachine param0)
{
this.Builder.SetStateMachine(param0);
}
}
The generated code has been refactored, so it is readable and can be compiled. Several things can be observed here:
The
async modifier is gone, which shows, unlike other modifiers (e.g. static), there is no such IL/CLR level “async” stuff. It becomes a AsyncStateMachineAttribute. This is similar to the compilation of extension method.
The generated state machine is very similar to the state machine of C# yield syntax sugar.
The local variables (arg0, arg1, result) are compiled to fields of the state machine.
The real code (await HelperMethods.MethodTask(arg0, arg1)) is compiled into MoveNext(): HelperMethods.MethodTask(this.Arg0, this.Arg1).GetAwaiter().
CallMethodAsync() will create and start its own state machine CallMethodAsyncStateMachine:
internal class CompiledAsyncMethods
{
[DebuggerStepThrough]
[AsyncStateMachine(typeof(CallMethodAsyncStateMachine))] //
async
internal static /*async*/ Task<int> CallMethodAsync(int arg0, int arg1)
{
CallMethodAsyncStateMachine callMethodAsyncStateMachine = new CallMethodAsyncStateMachine()
{
Arg0 = arg0,
Arg1 = arg1,
Builder = AsyncTaskMethodBuilder<int>.Create(),
State = -1
};
callMethodAsyncStateMachine.Builder.Start(ref callMethodAsyncStateMachine);
return callMethodAsyncStateMachine.Builder.Task;
}
}
CallMethodAsyncStateMachine has the same logic as MethodAsyncStateMachine above. The detail of the state machine will be discussed soon. Now it is clear that:
async /await is a C# language level syntax sugar.
There is no difference to await a
async method or a normal method. As long as a method returns Task, it is awaitable.
State machine and continuation
To demonstrate more details in the state machine, a more complex method is created:
internal class AsyncMethods
{
internal static
async Task<int> MultiCallMethodAsync(int arg0, int arg1, int arg2, int arg3)
{
HelperMethods.Before();
int resultOfAwait1 = await MethodAsync(arg0, arg1);
HelperMethods.Continuation1(resultOfAwait1);
int resultOfAwait2 = await MethodAsync(arg2, arg3);
HelperMethods.Continuation2(resultOfAwait2);
int resultToReturn = resultOfAwait1 + resultOfAwait2;
return resultToReturn;
}
}
In this method:
There are multiple awaits.
There are code before the awaits, and continuation code after each await
After compilation, this multi-await method becomes the same as above single-await methods:
internal class CompiledAsyncMethods
{
[DebuggerStepThrough]
[AsyncStateMachine(typeof(MultiCallMethodAsyncStateMachine))] //
async
internal static /*async*/ Task<int> MultiCallMethodAsync(int arg0, int arg1, int arg2, int arg3)
{
MultiCallMethodAsyncStateMachine multiCallMethodAsyncStateMachine = new MultiCallMethodAsyncStateMachine()
{
Arg0 = arg0,
Arg1 = arg1,
Arg2 = arg2,
Arg3 = arg3,
Builder = AsyncTaskMethodBuilder<int>.Create(),
State = -1
};
multiCallMethodAsyncStateMachine.Builder.Start(ref multiCallMethodAsyncStateMachine);
return multiCallMethodAsyncStateMachine.Builder.Task;
}
}
It creates and starts one single state machine, MultiCallMethodAsyncStateMachine:
[CompilerGenerated]
[StructLayout(LayoutKind.Auto)]
internal struct MultiCallMethodAsyncStateMachine : IAsyncStateMachine
{
public int State;
public AsyncTaskMethodBuilder<int> Builder;
public int Arg0;
public int Arg1;
public int Arg2;
public int Arg3;
public int ResultOfAwait1;
public int ResultOfAwait2;
public int ResultToReturn;
private TaskAwaiter<int> awaiter;
void IAsyncStateMachine.MoveNext()
{
try
{
switch (this.State)
{
case -1:
HelperMethods.Before();
this.awaiter = AsyncMethods.MethodAsync(this.Arg0, this.Arg1).GetAwaiter();
if (!this.awaiter.IsCompleted)
{
this.State = 0;
this.Builder.AwaitUnsafeOnCompleted(ref this.awaiter, ref this);
}
break;
case 0:
this.ResultOfAwait1 = this.awaiter.GetResult();
HelperMethods.Continuation1(this.ResultOfAwait1);
this.awaiter = AsyncMethods.MethodAsync(this.Arg2, this.Arg3).GetAwaiter();
if (!this.awaiter.IsCompleted)
{
this.State = 1;
this.Builder.AwaitUnsafeOnCompleted(ref this.awaiter, ref this);
}
break;
case 1:
this.ResultOfAwait2 = this.awaiter.GetResult();
HelperMethods.Continuation2(this.ResultOfAwait2);
this.ResultToReturn = this.ResultOfAwait1 + this.ResultOfAwait2;
this.State = -2;
this.Builder.SetResult(this.ResultToReturn);
break;
}
}
catch (Exception exception)
{
this.State = -2;
this.Builder.SetException(exception);
}
}
[DebuggerHidden]
void IAsyncStateMachine.SetStateMachine(IAsyncStateMachine stateMachine)
{
this.Builder.SetStateMachine(stateMachine);
}
}
Once again, the above state machine code is already refactored, but it still has a lot of things. More clean up can be done if we only keep the core logic, and the state machine can become very simple:
[CompilerGenerated]
[StructLayout(LayoutKind.Auto)]
internal struct MultiCallMethodAsyncStateMachine : IAsyncStateMachine
{
// State:
// -1: Begin
// 0: 1st await is done
// 1: 2nd await is done
// ...
// -2: End
public int State;
public TaskCompletionSource<int> ResultToReturn; // int resultToReturn ...
public int Arg0; // int Arg0
public int Arg1; // int arg1
public int Arg2; // int arg2
public int Arg3; // int arg3
public int ResultOfAwait1; // int resultOfAwait1 ...
public int ResultOfAwait2; // int resultOfAwait2 ...
private Task<int> currentTaskToAwait;
/// <summary>
/// Moves the state machine to its next state.
/// </summary>
public void MoveNext() // IAsyncStateMachine member.
{
try
{
switch (this.State)
{
// Original code is split by "await"s into "case"s:
// case -1:
// HelperMethods.Before();
// MethodAsync(Arg0, arg1);
// case 0:
// int resultOfAwait1 = await ...
// HelperMethods.Continuation1(resultOfAwait1);
// MethodAsync(arg2, arg3);
// case 1:
// int resultOfAwait2 = await ...
// HelperMethods.Continuation2(resultOfAwait2);
// int resultToReturn = resultOfAwait1 + resultOfAwait2;
// return resultToReturn;
case -1: // -1 is begin.
HelperMethods.Before(); // Code before 1st await.
this.currentTaskToAwait = AsyncMethods.MethodAsync(this.Arg0, this.Arg1); // 1st task to await
// When this.currentTaskToAwait is done, run this.MoveNext() and go to case 0.
this.State = 0;
MultiCallMethodAsyncStateMachine that1 = this; // Cannot use "this" in lambda so create a local variable.
this.currentTaskToAwait.ContinueWith(_ => that1.MoveNext());
break;
case 0: // Now 1st await is done.
this.ResultOfAwait1 = this.currentTaskToAwait.Result; // Get 1st await's result.
HelperMethods.Continuation1(this.ResultOfAwait1); // Code after 1st await and before 2nd await.
this.currentTaskToAwait = AsyncMethods.MethodAsync(this.Arg2, this.Arg3); // 2nd task to await
// When this.currentTaskToAwait is done, run this.MoveNext() and go to case 1.
this.State = 1;
MultiCallMethodAsyncStateMachine that2 = this;
this.currentTaskToAwait.ContinueWith(_ => that2.MoveNext());
break;
case 1: // Now 2nd await is done.
this.ResultOfAwait2 = this.currentTaskToAwait.Result; // Get 2nd await's result.
HelperMethods.Continuation2(this.ResultOfAwait2); // Code after 2nd await.
int resultToReturn = this.ResultOfAwait1 + this.ResultOfAwait2; // Code after 2nd await.
// End with resultToReturn.
this.State = -2; // -2 is end.
this.ResultToReturn.SetResult(resultToReturn);
break;
}
}
catch (Exception exception)
{
// End with exception.
this.State = -2; // -2 is end.
this.ResultToReturn.SetException(exception);
}
}
/// <summary>
/// Configures the state machine with a heap-allocated replica.
/// </summary>
/// <param name="stateMachine">The heap-allocated replica.</param>
[DebuggerHidden]
public void SetStateMachine(IAsyncStateMachine stateMachine) // IAsyncStateMachine member.
{
// No core logic.
}
}
Only Task and TaskCompletionSource are involved in this version. And MultiCallMethodAsync() can be simplified to:
[DebuggerStepThrough]
[AsyncStateMachine(typeof(MultiCallMethodAsyncStateMachine))] //
async
internal static /*async*/ Task<int> MultiCallMethodAsync(int arg0, int arg1, int arg2, int arg3)
{
MultiCallMethodAsyncStateMachine multiCallMethodAsyncStateMachine = new MultiCallMethodAsyncStateMachine()
{
Arg0 = arg0,
Arg1 = arg1,
Arg2 = arg2,
Arg3 = arg3,
ResultToReturn = new TaskCompletionSource<int>(),
// -1: Begin
// 0: 1st await is done
// 1: 2nd await is done
// ...
// -2: End
State = -1
};
multiCallMethodAsyncStateMachine.MoveNext(); // Original code are moved into this method.
return multiCallMethodAsyncStateMachine.ResultToReturn.Task;
}
Now the whole state machine becomes very clean - it is about callback:
Original code are split into pieces by “await”s, and each piece is put into each “case” in the state machine. Here the 2 awaits split the code into 3 pieces, so there are 3 “case”s.
The “piece”s are chained by callback, that is done by Builder.AwaitUnsafeOnCompleted(callback), or currentTaskToAwait.ContinueWith(callback) in the simplified code.
A previous “piece” will end with a Task (which is to be awaited), when the task is done, it will callback the next “piece”.
The state machine’s state works with the “case”s to ensure the code “piece”s executes one after another.
Callback
If we focus on the point of callback, the simplification can go even further – the entire state machine can be completely purged, and we can just keep the code inside MoveNext(). Now MultiCallMethodAsync() becomes:
internal static Task<int> MultiCallMethodAsync(int arg0, int arg1, int arg2, int arg3)
{
TaskCompletionSource<int> taskCompletionSource = new TaskCompletionSource<int>();
try
{
// Oringinal code begins.
HelperMethods.Before();
MethodAsync(arg0, arg1).ContinueWith(await1 => { int resultOfAwait1 = await1.Result;
HelperMethods.Continuation1(resultOfAwait1);
MethodAsync(arg2, arg3).ContinueWith(await2 => { int resultOfAwait2 = await2.Result;
HelperMethods.Continuation2(resultOfAwait2);
int resultToReturn = resultOfAwait1 + resultOfAwait2;
// Oringinal code ends.
taskCompletionSource.SetResult(resultToReturn);
});
});
}
catch (Exception exception)
{
taskCompletionSource.SetException(exception);
}
return taskCompletionSource.Task;
}
Please compare with the original
async / await code:
HelperMethods.Before();
int resultOfAwait1 = await MethodAsync(arg0, arg1);
HelperMethods.Continuation1(resultOfAwait1);
int resultOfAwait2 = await MethodAsync(arg2, arg3);
HelperMethods.Continuation2(resultOfAwait2);
int resultToReturn = resultOfAwait1 + resultOfAwait2;
return resultToReturn;
Yeah that is the magic of C#
async / await:
Await is not to wait. In a await expression, a Task object will be return immediately so that execution is not blocked. The continuation code is compiled as that Task’s callback code.
When that task is done, continuation code will execute.
Please notice that many details inside the state machine are omitted for simplicity, like context caring, etc. If you want to have a detailed picture, please do check out the source code of AsyncTaskMethodBuilder and TaskAwaiter.
