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

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM