C# Under the Hood: async/await (Marko Papic)
https://www.markopapic.com/csharp-under-the-hood-async-await/
Async and await keywords came with C# 5 as a cool new feature for handling asynchronous tasks.
They allow us to specify tasks to be executed asynchronously in an easy and straightforward fashion.
However, some people are mystified by asynchronous programming and are not sure how it actually works.
I will try to give you an insight of the magic that happens under the hood when async and await are used.
Awaiter Pattern
C# language compiles some of the features as a syntactic sugar, which means that certain language features are just conveniences that translate into existing language features.
A lot of those syntactic sugar features expand into patterns.Those patterns are based on method calls, property lookups or interface implementations.
await
expression is one of those syntactic sugar features. It leverages a pattern based on a few method calls. In order for a type to be awaitable, it has to meet the following requirements:
- It has to have the following method:
INotifyCompletion GetAwaiter()
- Besides implementing the INotifyCompletion interface, the return type of the
GetAwaiter
method has to have the following:IsCompleted
property of typebool
GetResult()
method which returnsvoid
If you take a look at Task class, you will see that it meets all the above requirements.
1.被Await的class需要有一个GetAwaiter的方法
2.并且GetAwaiter方法的返回类型,还有3个要求
2.1 必须实现INotifyCompletion接口
2.2 必须有一个IsCompleted属性,类型是bool
2.3 必须有一个GetResult方法,返回值类型是void
So, a type doesn’t even need to implement some specific interface in order to be awaitable.
It just has to have a method with a specific signature. It is similar to duck typing.
If it walks like a duck and it quacks like a duck, then it must be a duck.
In this case it is
If it has certain methods with certain signatures, then it has to be awaitable.
To give you an illustrative example of this, I will create some custom class and make it awaitable.
So, here is my class:
public class MyAwaitableClass
{
}
When I try to await an object of MyAwaitableClass
type, I get the following error:
static async Task AwaitMyAwaitable()
{
MyAwaitableClass class1 = new MyAwaitableClass();
await class1; }
Severity Code Description Project File Line Suppression State
Error CS1061 'MyAwaitableClass' does not contain a definition for 'GetAwaiter' and no accessible extension method 'GetAwaiter' accepting a first argument of type 'MyAwaitableClass' could be found (are you missing a using directive or an assembly reference?) async-await-test C:\repository\GitHub\ChuckLu\Test\async-await-test\async-await-test\MainTest.cs 22 Active
Let’s add GetAwaiter
method to our class:
public class MyAwaitableClass
{
public MyAwaiter GetAwaiter()
{
return new MyAwaiter();
}
} public class MyAwaiter
{
public bool IsCompleted
{
get { return false; }
}
}
We can see that the compiler error changed:
Severity Code Description Project File Line Suppression State
Error CS0535 'MyAwaiter' does not implement interface member 'INotifyCompletion.OnCompleted(Action)' async-await-test C:\repository\GitHub\ChuckLu\Test\async-await-test\async-await-test\MyAwaitableClass.cs 6 Active
Ok, let’s create implement the INotifyCompletion
interface in MyAwaiter
:
public class MyAwaiter : INotifyCompletion
{
public bool IsCompleted
{
get { return false; }
} public void OnCompleted(Action continuation)
{
}
}
and see what the compiler error looks like now:
Severity Code Description Project File Line Suppression State
Error CS0117 'MyAwaiter' does not contain a definition for 'GetResult' async-await-test C:\repository\GitHub\ChuckLu\Test\async-await-test\async-await-test\MainTest.cs 18 Active
So, we add a GetResult
method and now we have the following:
public class MyAwaitableClass
{
public MyAwaiter GetAwaiter()
{
return new MyAwaiter();
}
} public class MyAwaiter : INotifyCompletion
{
public void GetResult()
{
} public bool IsCompleted
{
get { return false; }
} //From INotifyCompletion
public void OnCompleted(Action continuation)
{
}
}
And we can also see that there are no compiler errors,
which means we have made an awaitable type.
Now that we know which pattern does the await
expression leverage, we can take a look under the hood to see what actually happens when we use async
and await
.
Async
For every async method a state machine is generated.
This state machine is a struct that implements IAsyncStateMachine interface from System.Runtime.CompilerServices
namespace. This interface is intended for compiler use only and has the following methods:
MoveNext()
- Moves the state machine to its next state.SetStateMachine(IAsyncStateMachine)
- Configures the state machine with a heap-allocated replica.
Now let’s take a look at the following code:
class Program
{
static void Main(string[] args)
{
} static async Task FooAsync()
{
Console.WriteLine("Async method that doesn't have await");
}
}
We have an async method named FooAsync
. You may notice that it lacks await operator, but I left it out for now for the sake of simplicity.
Now let’s take a look at the compiler generated code for this method. I am using dotPeek to decompile the containing .dll file. To see what is going on behind the scenes, you need to enable Show Compiler-generated Code option in dotPeek.
Compiler generated classes usually contain < and > in their names
which are not valid C# identifiers so they don’t conflict with
user-created artifacts.
也可以用dnSpy查看反编译的代码
Let’s take a look what compiler generated for our FooAsync
method:
用ILSpy查看,在选项里面,去掉反编译async methods,确保看到状态机的代码
Our Program
class contains Main
and FooAsync
methods as expected, but we can also see that compiler generated a struct called Program.<FooAsync>d__1
.
That struct is a state machine that implements the IAsyncStateMachine
interface. Besides the IAsyncStateMachine
interface methods, this struct also has the following fields:
<>1__state
which indicates the current state of the state machine<>t__builder
of typeAsyncTaskMethodBuilder
which is used for creation of asynchronous methods and returning the resulting task. TheAsyncTaskMethodBuilder
struct is also intended for use by the compiler.
We will see the code of this struct in more detail, but first let’s take a look at what compiler-generated FooAsync method looks like after we decompiled it:
[AsyncStateMachine(typeof(<FooAsync>d__1))]
[DebuggerStepThrough]
private static Task FooAsync()
{
<FooAsync>d__1 stateMachine = new <FooAsync>d__1();
stateMachine.<>t__builder = AsyncTaskMethodBuilder.Create();
stateMachine.<>1__state = -;
AsyncTaskMethodBuilder <>t__builder = stateMachine.<>t__builder;
<>t__builder.Start(ref stateMachine);
return stateMachine.<>t__builder.Task;
}
This is what compiler transforms async methods to. The code inside the method does the following:
- Instantiate the method’s state machine
- Create new
AsyncTaskMethodBuilder
and set it as state machine’s builder - Set the state machine to a starting state
- Start the builder with the method’s state machine by calling the Start method.
- Return the Task
As you can notice, compiler-generated FooAsync
method doesn’t contain any of the code our original FooAsync
method had. That code represented the functionality of the method. So where is that code?
That code is moved to state machine’s MoveNext
method.
Let’s take a look at Program.<FooAsync>d_1
struct now:
[CompilerGenerated]
private sealed class <FooAsync>d__1 : IAsyncStateMachine
{
public int <>1__state; public AsyncTaskMethodBuilder <>t__builder; private void MoveNext()
{
int num = <>1__state;
try
{
Console.WriteLine("Async method that doesn't have await");
}
catch (Exception exception)
{
<>1__state = -;
<>t__builder.SetException(exception);
return;
}
<>1__state = -;
<>t__builder.SetResult();
} void IAsyncStateMachine.MoveNext()
{
//ILSpy generated this explicit interface implementation from .override directive in MoveNext
this.MoveNext();
} [DebuggerHidden]
private void SetStateMachine(IAsyncStateMachine stateMachine)
{
} void IAsyncStateMachine.SetStateMachine(IAsyncStateMachine stateMachine)
{
//ILSpy generated this explicit interface implementation from .override directive in SetStateMachine
this.SetStateMachine(stateMachine);
}
}
The MoveNext
method contains method’s code inside of a try
block.
If some exception occurs in our code, it will be given to the method builder which propagates it all the way to the task.
After that, it uses method builder’s SetResult method to indicate that the task is completed.
Now we saw how async methods look under the hood.
For the sake of simplicity, I didn’t put any await
inside of the FooAsync
method, so our state machine didn’t have a lot of state transitions.
It just executed our method and went to a completed state, i.e. our method executed synchronously.
Now it is time to see how MoveNext
method looks like when a method awaits some task inside of its body.
Await
Let’s take a look at the following method:
static async Task BarAsync()
{
Console.WriteLine("This happens before await"); int i = await QuxAsync(); Console.WriteLine("This happens after await. The result of await is " + i);
}
static async Task BarAsync()
{
Console.WriteLine("This happens before await"); HttpClient httpClient = new HttpClient();
Uri uri = new Uri("https://www.cnblogs.com/chucklu/");
var result = await httpClient.GetAsync(uri);
var statusCode = result.StatusCode;
Console.WriteLine($"This happens after await. The result of await is {statusCode}");
}
It awaits some QuxAsync method and uses its task result.
If we decompile it using dotPeek, we will notice that the compiler generated method has the same structure as FooAsync
even if the original methods are different:
[AsyncStateMachine(typeof(<BarAsync>d__2))]
[DebuggerStepThrough]
private static Task BarAsync()
{
<BarAsync>d__2 stateMachine = new <BarAsync>d__2();
stateMachine.<>t__builder = AsyncTaskMethodBuilder.Create();
stateMachine.<>1__state = -;
AsyncTaskMethodBuilder <>t__builder = stateMachine.<>t__builder;
<>t__builder.Start(ref stateMachine);
return stateMachine.<>t__builder.Task;
}
What makes the difference is the state machine’s MoveNext
method.
Now that we have an await
expression inside of our method, the state machine loks like this:
[CompilerGenerated]
private sealed class <BarAsync>d__2 : IAsyncStateMachine
{
public int <>1__state; public AsyncTaskMethodBuilder <>t__builder; private HttpClient <httpClient>5__1; private Uri <uri>5__2; private HttpResponseMessage <result>5__3; private HttpStatusCode <statusCode>5__4; private HttpResponseMessage <>s__5; private TaskAwaiter<HttpResponseMessage> <>u__1; private void MoveNext()
{
int num = <>1__state; //num variable holds the state
try
{
TaskAwaiter<HttpResponseMessage> awaiter;
if (num != )// The first state is -1(BarAsync method sets it to that value before starting the builder), so it will pass this check in the first pass
{
Console.WriteLine("This happens before await");
<httpClient>5__1 = new HttpClient();
<uri>5__2 = new Uri("https://www.cnblogs.com/chucklu/");
awaiter = <httpClient>5__1.GetAsync(<uri>5__2).GetAwaiter();
if (!awaiter.IsCompleted) //check if the asynchronous operation has already completed synchronously by the time we awaited
{
//in case the method has not yet completed, do the following:
//1. set the state to 0(so next time it will not pass the check and go to else block below)
//2. register a callback using AwaitUnsafeOnCompleted, which eventually call the MoveNext method when the task completes
//3. return to prevent further execution
num = (<>1__state = );
<>u__1 = awaiter;
<BarAsync>d__2 stateMachine = this;
<>t__builder.AwaitUnsafeOnCompleted(ref awaiter, ref stateMachine);
return;
}
}
else
{
awaiter = <>u__1;
<>u__1 = default(TaskAwaiter<HttpResponseMessage>);
num = (<>1__state = -);
}
<>s__5 = awaiter.GetResult();
<result>5__3 = <>s__5;
<>s__5 = null;
<statusCode>5__4 = <result>5__3.StatusCode;
//The following line gets to be executed in the following case:
//1. The asynchronous operation has already completed by the time !task.Completed check happened
//2. The asynchronous operation has completed and MoveNext method is invoked as a callback. In this case state is 0, num!=0 check returns false
//It gets the task result and executes the rest of the method
Console.WriteLine($"This happens after await. The result of await is {<statusCode>5__4}");
}
catch (Exception exception)
{
<>1__state = -;
<>t__builder.SetException(exception);
return;
}
<>1__state = -;
<>t__builder.SetResult();
} void IAsyncStateMachine.MoveNext()
{
//ILSpy generated this explicit interface implementation from .override directive in MoveNext
this.MoveNext();
} [DebuggerHidden]
private void SetStateMachine(IAsyncStateMachine stateMachine)
{
} void IAsyncStateMachine.SetStateMachine(IAsyncStateMachine stateMachine)
{
//ILSpy generated this explicit interface implementation from .override directive in SetStateMachine
this.SetStateMachine(stateMachine);
}
}
The above red word contains an explanation of the above state machine:
So, what await
actually does is the following:
下面的num==0判断是No的话,意味着第一次进入MoveNext
Summary
Every time you create an async method, the compiler generates a state machine for it. Then for each await
inside of that method, it does the following:
- Executes the method to the
await
expression - Checks if the method being awaited has already completed
- If yes, executes the rest of the method
- If no, uses callback to execute the rest of the method when the method being awaited completes
C# Under the Hood: async/await (Marko Papic)的更多相关文章
- C# async await and state machine
Async Await and the Generated StateMachine https://www.codeproject.com/Articles/535635/Async-Await-a ...
- C# async await 死锁问题总结
可能发生死锁的程序类型 1.WPF/WinForm程序 2.asp.net (不包括asp.net mvc)程序 死锁的产生原理 对异步方法返回的Task调用Wait()或访问Result属性时,可能 ...
- async/await 内幕【译文】
C# Under the Hood: async/await 原文地址:https://www.markopapic.com/csharp-under-the-hood-async-await/ 前言 ...
- async & await 的前世今生(Updated)
async 和 await 出现在C# 5.0之后,给并行编程带来了不少的方便,特别是当在MVC中的Action也变成async之后,有点开始什么都是async的味道了.但是这也给我们编程埋下了一些隐 ...
- [.NET] 利用 async & await 的异步编程
利用 async & await 的异步编程 [博主]反骨仔 [出处]http://www.cnblogs.com/liqingwen/p/5922573.html 目录 异步编程的简介 异 ...
- [.NET] 怎样使用 async & await 一步步将同步代码转换为异步编程
怎样使用 async & await 一步步将同步代码转换为异步编程 [博主]反骨仔 [出处]http://www.cnblogs.com/liqingwen/p/6079707.html ...
- [.NET] 利用 async & await 进行异步 IO 操作
利用 async & await 进行异步 IO 操作 [博主]反骨仔 [出处]http://www.cnblogs.com/liqingwen/p/6082673.html 序 上次,博主 ...
- [C#] 走进异步编程的世界 - 开始接触 async/await
走进异步编程的世界 - 开始接触 async/await 序 这是学习异步编程的入门篇. 涉及 C# 5.0 引入的 async/await,但在控制台输出示例时经常会采用 C# 6.0 的 $&qu ...
- ASP.NET 中的 Async/Await 简介
本文转载自MSDN 作者:Stephen Cleary 原文地址:https://msdn.microsoft.com/en-us/magazine/dn802603.aspx 大多数有关 async ...
随机推荐
- string+DP leetcode-4.最长回文子串
5. Longest Palindromic Substring 题面 Given a string s, find the longest palindromic substring in s. Y ...
- Ubuntu 其他命令
其他命令 目标 查找文件 find 软链接 ln 打包和压缩 tar 软件安装 apt-get 01. 查找文件 find 命令功能非常强大,通常用来在 特定的目录下 搜索 符合条件的文件 序号 命令 ...
- ARP、Proxy ARP、Gratuitous ARP
Proxy ARP 什么是Proxy ARP? 一个主机A(通常是路由器)有意应答另一个主机B的ARP请求(ARP requests).主机A通过伪装其身份,承担起将分组路由到真实目的地的责任.代理A ...
- 【2017-11-26】Linq表连接查询
class Program { static void Main(string[] args) { //Linq创建的数据库上下文对象db DataClasses2DataContext db = n ...
- tensorflow实战笔记(19)----使用freeze_graph.py将ckpt转为pb文件
一.作用: https://blog.csdn.net/yjl9122/article/details/78341689 这节是关于tensorflow的Freezing,字面意思是冷冻,可理解为整合 ...
- 0006SpringBoot中@Configuration与@Bean联合使用
需求:将某个普通类做为组件注册到容器中,可通过如下办法 1.定义HelloService类 package springboot_test.springboot_test.service; publi ...
- Spring-使用JAVA的方式配置Spring-代理模式
9.使用Java的方式配置Spring 我们现在要完全不使用Spring的xml配置了,全权交给Java来做! JavaConfig是Spring的一个子项目,在Spring4之后,它成为了一个核心功 ...
- Lua 学习之基础篇九<Lua 协同程序(Coroutine)>
引言 讲到协程,首先来介绍一下线程和协程的区别 lua协程和多线程 相同之处:拥有自己独立的桟.局部变量和PC计数器,同时又与其他协程共享全局变量和其他大部分东西 不同之处:一个多线程程序可以同时运行 ...
- Codeforces Round #596 (Div. 2, based on Technocup 2020 Elimination Round 2) B2. TV Subscriptions (Hard Version)
链接: https://codeforces.com/contest/1247/problem/B2 题意: The only difference between easy and hard ver ...
- CKEditor5 输入文字时拼音和汉字同时输入问题
在使用 CKEditor5 + vue 时,出现输入文字时,拼音和文字一起输入到编辑器到问题.与之前项目中使用 ckeditor 的区别是,这次项目是在 python 架构下局部引入 ckeditor ...