C++ Coroutine簡明教程

在C++裏，一個函數若是其函數體實現中包含co_await、co_yield、co_return中任何一個關鍵字，那麼這個函數就是一個coroutine。其中：

1. co_await：掛起當前的coroutine
2. co_return：從當前coroutine返回一個結果
3. co_yield：返回一個結果而且掛起當前的coroutine

一個coroutine要能被編譯期識別並經過編譯，在某些狀況下要本身去特化coroutine_traits。下面就一個簡單的coroutine來講一說C++編譯器是如何修改這個coroutine的。

1 // 咱們假定這個模板函數是一個coroutine
2 template <typename TRet, typename … TArgs>
3 TRet func(TArgs args…)
4 {
5     body; // body裏至少包含了co_await、co_yield、co_return三者之一。
6 }

那麼這個函數會被編譯器改爲以下形式：

 1 // 它會被編譯期展開成以下形式
 2 template <typename TRet, typename ... TArgs>
 3 TRet func(TArgs args...)
 4 {
 5     using promise_t = typename coroutine_traits<TRet, TArgs...>::promise_type;
 6 
 7     promise_t promise;
 8     auto __return__ = promise.get_return_object();    // 這個__return__會被編譯器特殊處理
 9 
10  co_await promise.initial_suspend();
11 
12     try
13     {            // co_return expr; => promise.return_value(expr); goto final_suspend;
14         body;    // co_return;      => promise.return_void(); goto final_suspend;
15     }            // co_yield expr;  => co_await promise.yield_value(expr);
16     catch (...)
17     {
18         promise.set_exception(std::current_exception());
19     }
20 
21 final_suspend:
22  co_await promise.final_suspend();
23 }

以上是一個coroutine的基本形式。事實上看完以後會發現，一個coroutine的關鍵主要仍是和其關聯的promise。
和coroutine promise關聯的另一個概念，叫awaitable。Awaitable能夠稱爲一個可等待對象。一個awaitable對象須要實現3個相關函數：

1. await_ready：awaitable實例是否已經ready
2. await_suspend：掛起awaitable。該函數會傳入一個coroutine_handle類型的參數。這是一個由編譯器生成的變量。suspend過程能夠指定該coroutine什麼時候何地以何種方式被resume。比方說實現suspend函數時，將coroutine_handle放到threadpool中。那麼當前的coroutine接下來就運行在線程池指派的後臺線程中運行了。
3. await_resume：當coroutine從新運行時，會調用該函數。

因此要讓一個類型可以awaitable，有三種手段：

1. 該類型相關代碼沒法修改時，須要實現：
   • bool await_ready(T &);
   • void await_suspend(T &, coroutine_handle<promise_type>);
   • auto await_resume(T &);  auto視具體狀況而定
2. 該類型相關代碼能夠修改時，須要增長3個成員函數：
   • bool await_ready();
   • void await_suspend(coroutine_handle<promise_type> ch);
   • auto await_resume();
3. 實現operator co_await操做符，返回一個可等待的代理類型，而且實現了上述三個函數。

--完

N4663