cpp-d05-C++20协程初探

0x00 杂记

看了几天，云里雾里。先做点笔记.

写在最前面，协程不会带来性能提升，相反，在drogon项目中实测，接口性能有所下降。（当然，有可能是写法问题
同时，协程和调用方，是在同一个线程中。所以省去了线程切换成本。
好处，是为了简化异步回调编程。想起在Rust中，使用 await / async 写异步还是很简单的。
但是在C++20这边，想实现相同的目标，门槛有点高的。

协程：

包含下列之一关键字的函数。

• co_await // 调用并等待协程执行结果
• co_return // 协程函数返回结果时使用
• co_yield // 还没用过
  要注意的是，上面的关键字不能城main函数中使用。

Awaitable对象:

实现下面几个接口，就可以当成一个协程中交互对象来使用

• await_ready
• await_suspend
• await_resume

在协程中：
调用 await a; 相当于：a.await_ready() --> a.await_suspend();-> 协程挂起
在调用者代码中执行：p.resume(), 相当于：a.await_resume(); -> 继续执行协程

0x01 co_await

在 co_await 后面可以放置任何类型的表达式，只要这个表达式能够被转换为一个 awaitable 对象，即实现了 await_ready、await_suspend 和 await_resume 函数，就可以在协程中使用。

例：

struct MyWaiter {
  std::coroutine_handle<> *hp_;
  constexpr bool await_ready() const noexcept { return false; }
  void await_suspend(std::coroutine_handle<> h) {
    std::cout << "co_await is called" << std::endl;
    *hp_ = h;
  }
  constexpr void await_resume() const noexcept {}
};

0x02 std::coroutine_handle

协程句柄可以被用来创建、启动、暂停和销毁协程。它包含了协程的状态和控制信息，可以通过协程句柄对协程进行操作，例如暂停协程、恢复协程、获取协程的状态等。

std::coroutine_handle 有两个主要的构造函数：

默认构造函数：创建一个空的协程句柄对象。
构造函数接收一个指向协程的指针：用于创建一个新的协程句柄对象，指向指定的协程。

std::coroutine_handle 提供了一些成员函数，包括但不限于以下几个：

• resume()：恢复协程的执行，从协程上一次暂停的位置继续执行。
• destroy()：销毁协程对象，释放资源并将协程状态设置为无效。
• done()：检查协程是否已经完成。
• promise()：返回与协程关联的 promise 对象。

需要注意的是，std::coroutine_handle 不负责协程的内存分配和释放，需要使用者手动管理协程的内存。同时，使用协程句柄时需要保证协程对象的有效性，否则可能会导致程序崩溃或行为不可预测。

0x03 看个例子

#include <coroutine>
#include <iostream>

struct Task {
  struct promise_type {
    Task get_return_object() { return {}; }
    std::suspend_never initial_suspend() { return {}; }
    std::suspend_never final_suspend() noexcept { return {}; }
    void unhandled_exception() {}
  };
};

struct MyWaiter {
  std::coroutine_handle<> *hp_;
  // 协程刚创建时会执行判断: true:直接执行await_resume,  false: 执行 await_suspend
  bool await_ready() const noexcept {
    std::cout << "await_ready()" << std::endl;
    return false;
  }
  void await_suspend(std::coroutine_handle<> h) {
    std::cout << "co_await is called : await_suspend()" << std::endl;
    *hp_ = h;
  }
  // 协程恢复时执行
  void await_resume() const noexcept {
    std::cout << "await_resume()" << std::endl;
  }
};

// 这个函数就是传说中的“协程”了
Task counter(std::coroutine_handle<> *continuation_out) {
  MyWaiter a{continuation_out}; // 对象是创建了，可是没有开始对象执行。
  for (unsigned i = 0;; ++i) {
    co_await a; // 进入协程执行阶段：.await_ready() -> await_suspend(),　这里完成后，直接回到调用者执行处：main方法那边
    std::cout << "counter: " << i << std::endl; // 这里需要执行 .resume() 后，才能继续执行： await_resume()
  }
}

int main() {
  std::coroutine_handle<> h; // 创建协程句柄(handler)
  counter(&h); // 创建协程并执行，上面 co_wait a 执行完成后，直接到这里继续执行。
  for (int i = 0; i < 3; ++i) {
    std::cout << "In main1 function\n";
    getchar(); 
    h.resume(); // 通过handler 返回协程处理：co_wait a 下面那行。
    getchar();
  }
  h.destroy();
}

执行结果：

await_ready()
co_await is called : await_suspend()
In main1 function
await_resume()
counter: 0
await_ready()
co_await is called : await_suspend()
In main1 function
await_resume()
counter: 1
await_ready()
co_await is called : await_suspend()
In main1 function
await_resume()
counter: 2
await_ready()
co_await is called : await_suspend()