一篇文章搞懂 C++ 20 协程 Coroutine
C++20 协程
C++ 20有一个新玩意,协程。这玩意对C++的未来可能是重要一环,也会是让C++成为服务器编程有力工具。
对C++20的协程,最简单的理解协程是可以重入的特殊函数。就是这个函数在执行的过程,可以(通过co_await
,或者co_yield
)挂起,然后在外部(通过coroutine_handle
)恢复运行。
测试代码: Visual studio 2022,
GCC 10.0
也已经支持。
协程是特殊的函数
首先再次强调,C++ 20的协程是一个特殊函数。只是这个函数具有挂起和恢复的能力,可以被挂起(挂起后调用代码继续向后执行),而后可以继续恢复其执行。如下图:
如图所示,协程并没有一次执行完成,可以被反复挂起,挂起后可以恢复到挂起的点继续运行。
C++ 20协程的特点
那我们来看看C++ 20 协程的一些特点和用途。
首先,C++ 20 协程是一个无栈(stackless)的协程。同时,C++ 20 协程是非对称的协程,和Linux传统的Context Switch有区别。更像Windows的纤程。和C#的协程也比较相像,毕竟是微软的提案。
传统的Context Switch是有栈协程,你可以认为Context 协程都是运行在栈上,Context 协程的切换就是切换栈。同时因为其是有栈协程。切换是对称的,都是栈切换。你可以从主线程上切换为另外一个Context 协程栈,也可以从一个Context 协程切换为主线程,也可以Context 协程之间切换。Context 协程的状态也就是保存在栈上。
C++ 20的协程可以用来干啥呢?和大部分协程用途类似,就是异步编程用的。看图1就可以明白,每次一次协程的挂起都可以视为协程进入一个等待状态,比如请求一个网络,需要HTTP get一个文件,然后对文件进行分析。那么就可以用协程来包装整个处理,在发起HTTP请求后,挂起协程(处理其他事情),等待应答或者超时后,再恢复协程的运行。
但不足的是目前C++ 20的协程才是一个开始,说实话,目前的协程只提供基本框架,写起来并不舒服。C++目前在IO方面,特别是网络IO方面还不完善。需要一个大量异步IO库,才能用好C++ 20协程。
如果C++ 20的协程周边更加完整,也许C++又能在服务器编程这块能重新面对Go这类语言的威胁。
C++协程的是三个关键字
C++的协程(协程函数)内部可以用co_await , co_yield.两个关键字挂起协程,co_return,关键字进行返回。
co_await
co_await
调用一个awaiter对象(可以认为是一个接口),根据其内部定义决定其操作是挂起,还是继续,以及挂起,恢复时的行为。其呈现形式为
cw_ret = co_await awaiter;
cw_ret 记录调用的返回值,其是awaiter的await_resume 接口返回值。
co_await
相对比较复杂,后面开一章详细讲。
co_yield
挂起协程。其出现形式是
co_yield cy_ret;
cy_ret会保存在promise承诺对象中(通过yield_value
函数)。在协程外部可以通过promise得到。
co_return
协程返回。其出现形式是
co_return cr_ret;
cr_ret会保存在promise承诺对象中(通过return_value
函数)。在协程外部可以通过promise得到。要注意,cr_ret并不是协程的返回值。这个是有区别的。
C++协程的重要概念
C++ 的编译器如何识别协程函数呢?是通过函数返回值。C++ 协程函数的返回类型有要求,返回类型是result
,而result
里面必须有一个子类型承诺对象(promise),呈现为Result::promise_type。承诺对象(promise)是一个接口,里面实现get_return_object等接口。而通过std::coroutine_handle<promise_type>::from_promise( promise& p )这个静态函数,我们可以得到协程句柄(coroutine handle)。而协程的运行状态 ,协程函数的形参,内部变量,临时变量,挂起暂停在什么点,被保存在协程状态 (coroutine state)中。
好了上面的描述,我们可以看出协程的几个重要概念。
- 协程状态 (
coroutine state
),记录协程状态,是分配于堆的内部对象: - 承诺对象
- 形参(协程函数的参数)
- 协程挂起的点
- 临时变量
- 承诺对象(
promise
),从协程内部操纵。协程通过此对象提交其结果或异常。 - 协程句柄(
coroutine handle
),协程的唯一标示。用于恢复协程执行或销毁协程帧。 - 等待体(
awaiter
),co_await 关键字调用的对象。
协程状态(coroutine state)
协程状态(coroutine state
)是协程启动开始时,new空间存放协程状态,协程状态记录协程函数的参数,协程的运行状态,变量。挂起时的断点。
注意,协程状态 (coroutine state
)并不是就是协程函数的返回值RET。虽然我们设计的RET一般里面也有promise
和coroutine handle
,大家一般也是通过RET去操作协程的恢复,获取返回值。但coroutine state
理论上还应该包含协程运行参数,断点等信息。而协程状态 (coroutine state
)应该是协程句柄(coroutine handle
)对应的一个数据,而由系统管理的。
承诺对象(promise)
承诺对象的表现形式必须是result::promise_type
,result
为协程函数的返回值。
承诺对象是一个实现若干接口,用于辅助协程,构造协程函数返回值;提交传递co_yield
,co_return
的返回值。明确协程启动阶段是否立即挂起;以及协程内部发生异常时的处理方式。其接口包括:
auto get_return_object()
:用于生成协程函数的返回对象。auto initial_suspend()
:用于明确初始化后,协程函数的执行行为,返回值为等待体(awaiter
),用co_wait
调用其返回值。返回值为std::suspend_always
表示协程启动后立即挂起(不执行第一行协程函数的代码),返回std::suspend_never
表示协程启动后不立即挂起。(当然既然是返回等待体,你可以自己在这儿选择进行什么等待操作)void return_value(T v)
:调用co_return v
后会调用这个函数,可以保存co_return
的结果auto yield_value(T v)
:调用co_yield
后会调用这个函数,可以保存co_yield
的结果,其返回其返回值为std::suspend_always
表示协程会挂起,如果返回std::suspend_never
表示不挂起。auto final_suspend() noexcept
:在协程退出是调用的接口,返回std::suspend_never
,自动销毁 coroutine state 对象。若final_suspend
返回std::suspend_always
则需要用户自行调用handle.destroy()
进行销毁。但值得注意的是返回std::suspend_always并不会挂起协程。
前面我们提到在协程创建的时候,会new协程状态(coroutine state
)。你可以通过可以在 promise_type
中重载 operator new
和 operator delete
,使用自己的内存分配接口。
协程句柄(coroutine handle)
协程句柄(coroutine handle
)是一个协程的标示,用于操作协程恢复,销毁的句柄。
协程句柄的表现形式是std::coroutine_handle<promise_type>
,其模板参数为承诺对象(promise
)类型。句柄有几个重要函数:
resume()
函数可以恢复协程。done()
函数可以判断协程是否已经完成。返回false标示协程还没有完成,还在挂起。
协程句柄和承诺对象之间是可以相互转化的。
std::coroutine_handle<promise_type>::from_promise
: 这是一个静态函数,可以从承诺对象(promise)得到相应句柄。std::coroutine_handle<promise_type>::promise()
函数可以从协程句柄coroutine handle
得到对应的承诺对象(promise
)
等待体(awaiter)
co_wait 关键字会调用一个等待体对象(awaiter
)。这个对象内部也有3个接口。根据接口co_wait 决定进行什么操作。
bool await_ready()
:等待体是否准备好了,返回 false ,表示协程没有准备好,立即调用await_suspend。返回true,表示已经准备好了。auto await_suspend(std::coroutine_handle<> handle)
如果要挂起,调用的接口。其中handle参数就是调用等待体的协程,其返回值有3种可能- void 同返回true
- bool 返回true 立即挂起,返回false 不挂起。
- 返回某个协程句柄(
coroutine handle
),立即恢复对应句柄的运行。 auto await_resume()
:协程挂起后恢复时,调用的接口。返回值作为co_wait 操作的返回值。
等待体(awaiter)值得用更加详细的笔墨书写一章,我们就放一下,先了解其有2个特化类型。
std::suspend_never
类,不挂起的的特化等待体类型。std::suspend_always
类,挂起的特化等待体类型。
前面不少接口已经用了这2个特化的类,同时也可以明白其实协程内部不少地方其实也在使用co_wait
关键字。
例子,“七进七出”的协程。
所有概念我们介绍基本完成了。先来段代码吧。
这个例子主要展现的是协程函数和主线程之间的切换。协程反复中断,然后在main函数内部又恢复其运行。直至最后co_return。
这个例子虽然简单,但如果你对异步编程有所了解也能明白如何利用C++20完成一段异步编程了。
下面例子中:
coro_ret<int> coroutine_7in7out()
就是协程函数。coro_ret<int> c_r
就是协程的返回值。在后续,都是通过c_r和协程进行交互。coro_ret<int>::promise_type
就是承诺对象std::coroutine_handle<promise_type>
就是句柄。
#include <coroutine>
#include <iostream>
#include <stdexcept>
#include <thread>
//!coro_ret 协程函数的返回值,内部定义promise_type,承诺对象
template <typename T>
struct coro_ret
{
struct promise_type;
using handle_type = std::coroutine_handle<promise_type>;
//! 协程句柄
handle_type coro_handle_;
coro_ret(handle_type h)
: coro_handle_(h)
{
}
coro_ret(const coro_ret&) = delete;
coro_ret(coro_ret&& s)
: coro_handle_(s.coro_)
{
s.coro_handle_ = nullptr;
}
~coro_ret()
{
//!自行销毁
if (coro_handle_)
coro_handle_.destroy();
}
coro_ret& operator=(const coro_ret&) = delete;
coro_ret& operator=(coro_ret&& s)
{
coro_handle_ = s.coro_handle_;
s.coro_handle_ = nullptr;
return *this;
}
//!恢复协程,返回是否结束
bool move_next()
{
coro_handle_.resume();
return coro_handle_.done();
}
//!通过promise获取数据,返回值
T get()
{
return coro_handle_.promise().return_data_;
}
//!promise_type就是承诺对象,承诺对象用于协程内外交流
struct promise_type
{
promise_type() = default;
~promise_type() = default;
//!生成协程返回值
auto get_return_object()
{
return coro_ret<T>{handle_type::from_promise(*this)};
}
//! 注意这个函数,返回的就是awaiter
//! 如果返回std::suspend_never{},就不挂起,
//! 返回std::suspend_always{} 挂起
//! 当然你也可以返回其他awaiter
auto initial_suspend()
{
//return std::suspend_never{};
return std::suspend_always{};
}
//!co_return 后这个函数会被调用
void return_value(T v)
{
return_data_ = v;
return;
}
//!
auto yield_value