C++20 协程幕后：Promise、Awaitable与编译器魔法

C++20 引入的协程（Coroutines）无疑是现代 C++ 的一个重要里程碑。它允许我们以同步的方式编写异步代码，极大地提高了代码的可读性和可维护性。但你是否好奇过，co_await 背后到底发生了什么？编译器是如何将看似顺序的代码转换成状态机的？本文将深入探讨 C++20 协程的底层实现原理，包括 Promise 对象、Awaitable 对象、Coroutine Handle，以及编译器如何生成协程代码，并揭示协程的调度机制。准备好了吗？让我们一起解开 C++20 协程的神秘面纱。

1. 协程的基本概念

在深入底层实现之前，我们先来回顾一下协程的一些基本概念：

• 协程（Coroutine）：一种可以暂停执行并在稍后恢复执行的函数。与线程不同，协程的切换发生在用户态，因此开销更小。
• co_return：用于从协程返回值，并标志着协程的完成。
• co_yield：用于从协程生成一个值，并将协程暂停，直到下次被恢复。
• co_await：用于暂停协程的执行，等待一个 Awaitable 对象完成。

2. Promise 对象：协程的管家

每个协程都关联着一个 Promise 对象，它扮演着协程的“管家”角色，负责管理协程的状态、返回值和异常。

当一个函数被声明为协程时，编译器会自动生成一个 Promise 类型。这个 Promise 类型必须满足一些特定的要求，例如提供 get_return_object()、initial_suspend()、final_suspend() 等方法。

下面是一个简单的 Promise 类型的示例：

struct MyCoroutine {
    struct promise_type {
        int value;

        MyCoroutine get_return_object() {
            return MyCoroutine{std::coroutine_handle<promise_type>::from_promise(*this)};
        }

        std::suspend_never initial_suspend() noexcept { return {}; }
        std::suspend_always final_suspend() noexcept { return {}; }

        void return_value(int v) { value = v; }
        void unhandled_exception() { /* 处理异常 */ }
    };

    std::coroutine_handle<promise_type> handle;
};

让我们逐一分析 Promise 类型中的关键方法：

• get_return_object()：这个方法在协程创建时被调用，用于返回一个代表协程的对象。通常，这个对象会包含一个 std::coroutine_handle，用于控制协程的执行。
• initial_suspend()：这个方法在协程开始执行时被调用，用于决定协程是否立即暂停。它可以返回 std::suspend_never 或 std::suspend_always。
• final_suspend()：这个方法在协程结束时被调用，用于决定协程是否保持暂停状态，直到被显式销毁。同样，它可以返回 std::suspend_never 或 std::suspend_always。
• return_value(int v)：这个方法在协程使用 co_return 返回值时被调用，用于存储返回值。
• unhandled_exception()：这个方法在协程抛出未处理的异常时被调用，用于处理异常。

3. Awaitable 对象：异步的桥梁

Awaitable 对象是连接同步代码和异步操作的桥梁。当协程遇到 co_await 表达式时，它会暂停执行，直到 Awaitable 对象完成。

一个类型要成为 Awaitable，必须提供以下三个方法：

• await_ready()：这个方法用于检查异步操作是否已经完成。如果已经完成，它应该返回 true，否则返回 false。
• await_suspend(std::coroutine_handle<> handle)：这个方法用于暂停协程的执行，并安排在异步操作完成后恢复协程的执行。它接受一个 std::coroutine_handle 参数，用于恢复协程。
• await_resume()：这个方法在异步操作完成后被调用，用于获取异步操作的结果。

下面是一个简单的 Awaitable 类型的示例：

struct MyAwaitable {
    bool ready;
    int result;

    bool await_ready() { return ready; }

    void await_suspend(std::coroutine_handle<> handle) {
        // 模拟异步操作
        std::thread([handle, this]() {
            std::this_thread::sleep_for(std::chrono::seconds(1));
            result = 42;
            ready = true;
            handle.resume(); // 恢复协程的执行
        }).detach();
    }

    int await_resume() { return result; }
};

在这个例子中，await_suspend() 方法启动一个新的线程来模拟一个耗时的异步操作。当异步操作完成后，它会调用 handle.resume() 来恢复协程的执行。

4. Coroutine Handle：协程的遥控器

std::coroutine_handle 是一个指向协程帧的指针，它可以用来控制协程的执行，例如恢复协程的执行、销毁协程等。

std::coroutine_handle 提供以下几个重要方法：

• resume()：恢复协程的执行。
• destroy()：销毁协程，释放协程帧占用的内存。
• done()：检查协程是否已经完成。

5. 编译器如何生成协程代码

编译器在遇到协程时，会将它转换成一个状态机。状态机的每个状态对应协程中的一个暂停点。

下面是一个简单的协程示例：

MyCoroutine my_coroutine() {
    std::cout << "Before co_await" << std::endl;
    int result = co_await MyAwaitable{};
    std::cout << "After co_await: " << result << std::endl;
    co_return result;
}

编译器会将这个协程转换成类似下面的代码：

struct my_coroutine_frame {
    MyAwaitable awaitable;
    int result;
    std::coroutine_handle<my_coroutine_frame> handle;
    promise_type promise;
    int state = 0; // 状态机状态

    my_coroutine_frame() : handle(std::coroutine_handle<my_coroutine_frame>::from_promise(promise)) {}
};

MyCoroutine my_coroutine() {
    my_coroutine_frame* frame = new my_coroutine_frame{};
    // ... (初始化 promise 等)

    switch (frame->state) {
        case 0:
            std::cout << "Before co_await" << std::endl;
            frame->awaitable = MyAwaitable{};
            if (!frame->awaitable.await_ready()) {
                frame->state = 1; // 暂停状态
                frame->awaitable.await_suspend(frame->handle);
                return frame->promise.get_return_object(); // 返回，等待恢复
            }
            goto case 1; // awaitable 已经 ready，直接跳到下一个状态
        case 1:
            frame->result = frame->awaitable.await_resume();
            std::cout << "After co_await: " << frame->result << std::endl;
            frame->promise.return_value(frame->result);
            frame->state = 2; // 协程完成
            goto end;
    }

end:
    // ... (清理工作)
    return frame->promise.get_return_object();
}

可以看到，编译器将协程转换成了一个状态机，使用 switch 语句来控制协程的执行流程。当遇到 co_await 表达式时，协程会暂停执行，并将状态设置为暂停状态。当 Awaitable 对象完成后，协程会被恢复执行，并从暂停点继续执行。

6. 协程的调度机制

C++20 协程本身并不提供调度器。这意味着，你需要自己或者使用第三方库来实现协程的调度。

一个简单的协程调度器可以使用一个队列来存储待执行的协程。当一个协程暂停时，它可以将自己添加到队列中。当有空闲的线程时，调度器可以从队列中取出一个协程，并恢复它的执行。

下面是一个简单的协程调度器的示例：

#include <queue>
#include <mutex>
#include <condition_variable>

class Scheduler {
public:
    void schedule(std::coroutine_handle<> handle) {
        {
            std::lock_guard<std::mutex> lock(mutex_);
            queue_.push(handle);
        }
        cv_.notify_one();
    }

    void run() {
        while (true) {
            std::coroutine_handle<> handle;
            {
                std::unique_lock<std::mutex> lock(mutex_);
                cv_.wait(lock, [this] { return !queue_.empty(); });
                handle = queue_.front();
                queue_.pop();
            }

            if (handle) {
                handle.resume();
            } else {
                break; // 调度器停止
            }
        }
    }

    void stop() {
        {
            std::lock_guard<std::mutex> lock(mutex_);
            queue_.push(nullptr); // 插入一个空 handle，用于停止调度器
        }
        cv_.notify_one();
    }

private:
    std::queue<std::coroutine_handle<>> queue_;
    std::mutex mutex_;
    std::condition_variable cv_;
};

在这个例子中，schedule() 方法用于将协程添加到调度器的队列中。run() 方法在一个循环中不断地从队列中取出协程，并恢复它的执行。stop() 方法用于停止调度器。

7. 总结

C++20 协程是一个强大的工具，可以帮助我们编写更简洁、更高效的异步代码。理解协程的底层实现原理，可以帮助我们更好地利用协程，并避免一些潜在的陷阱。

希望本文能够帮助你深入了解 C++20 协程的幕后工作原理。记住，Promise 对象是协程的管家，Awaitable 对象是异步的桥梁，Coroutine Handle 是协程的遥控器，而编译器则负责将协程转换成状态机。

现在，你已经掌握了 C++20 协程的底层秘密，可以开始在你的项目中使用它了！祝你编程愉快！

一些额外的思考：

• 协程与线程的区别？ 协程是用户态的轻量级线程，切换开销远小于内核态线程。协程的调度由用户控制，避免了线程切换时的上下文切换开销。
• 协程的适用场景？ 协程特别适合于 I/O 密集型应用，例如网络编程、并发处理等。通过使用协程，可以避免阻塞，提高程序的并发能力。
• 如何选择协程库？ 目前有很多优秀的 C++ 协程库，例如 Boost.Asio、cppcoro 等。选择协程库时，需要考虑其性能、易用性、以及是否满足你的特定需求。
• 协程的调试技巧？ 协程的调试相对复杂，因为协程的执行流程不是线性的。可以使用调试器来跟踪协程的执行流程，或者使用日志来记录协程的状态。

掌握了这些，相信你已经对 C++20 协程有了更深入的理解。 赶紧去实践一下吧！