探究C++20协程(6)——实现协程之间消息传递

2024-04-25 18:44
文章标签 c++ 实现 之间 20 探究 协程 消息传递

本文主要是介绍探究C++20协程(6)——实现协程之间消息传递，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

之前主要关注的是协程与外部调用者的交互，这次也关注一下对等的协程之间的通信。

实现目标

在C++中实现协程的Channel相对复杂，因为C++标准库中并没有内置的协程间通信机制。C++20引入了协程支持，但主要提供了底层的协程操作，如协程的启动和暂停（通过co_await, co_return, 和 co_yield），并未直接提供Channel或其他高级并发原语。因此，实现一个C++的协程Channel需要依赖C++20的协程功能，结合额外的同步机制，如条件变量、互斥锁和原子操作等。

最终的 Channel 的用例如下：

Task<void, LooperExecutor> Producer(Channel<int> &channel) {int i = 0;while (i < 10) {// 写入时调用 write 函数co_await channel.write(i++);// 或者使用 << 运算符co_await (channel << i++);}// 支持关闭channel.close();
}Task<void, LooperExecutor> Consumer(Channel<int> &channel) {while (channel.is_active()) {try {// 读取时使用 read 函数，表达式的值就是读取的值auto received = co_await channel.read();int received;// 或者使用 >> 运算符将读取的值写入变量当中co_await (channel >> received);} catch (std::exception &e) {// 捕获 Channel 关闭时抛出的异常}}
}

co_await 表达式的支持

想要支持 co_await 表达式，只需要为 Channel 读写函数返回的 Awaiter 类型添加相应的 await_transform 函数。假定Channel的read 和 write 两个函数的返回值类型 ReaderAwaiter 和 WriterAwaiter，接下来就添加一个非常简单的 await_transform 的支持：

template<typename ResultType, typename Executor>
struct TaskPromise {template<typename _ValueType>auto await_transform(ReaderAwaiter<_ValueType> reader_awaiter) {reader_awaiter.executor = &executor;return reader_awaiter;}template<typename _ValueType>auto await_transform(WriterAwaiter<_ValueType> writer_awaiter) {writer_awaiter.executor = &executor;return writer_awaiter;}
}

由于 Channel 的 buffer 和对 Channel 的读写本身会决定协程是否挂起或恢复，因此这些逻辑都将在 Channel 当中给出，TaskPromise 能做的就是把调度器传过去，当协程恢复时使用。

Awaiter 的实现

Awaiter 负责在挂起时将自己存入 Channel，并且在需要时恢复协程。因此除了前面看到需要在恢复执行协程时的调度器之外，Awaiter 还需要持有 Channel、需要读写的值。

WriterAwaiter

template<typename ValueType>
struct WriterAwaiter {Channel<ValueType> *channel;// 调度器不是必须的，如果没有，则直接在当前线程执行（等价于 NoopExecutor）AbstractExecutor *executor = nullptr;// 写入 Channel 的值ValueType _value;std::coroutine_handle<> handle;WriterAwaiter(Channel<ValueType> *channel, ValueType value): channel(channel), _value(value) {}bool await_ready() {return false;}auto await_suspend(std::coroutine_handle<> coroutine_handle) {// 记录协程 handle，恢复时用this->handle = coroutine_handle;// 将自身传给 Channel，Channel 内部会根据自身状态处理是否立即恢复或者挂起channel->try_push_writer(this);}void await_resume() {// Channel 关闭时也会将挂起的读写协程恢复// 要检查是否是关闭引起的恢复，如果是，check_closed 会抛出 Channel 关闭异常channel->check_closed();}// Channel 当中恢复该协程时调用 resume 函数void resume() {// 我们将调度器调度的逻辑封装在这里if (executor) {executor->execute([this]() { handle.resume(); });} else {handle.resume();}}
};

ReaderAwaiter

template<typename ValueType>
struct ReaderAwaiter {Channel<ValueType> *channel;AbstractExecutor *executor = nullptr;ValueType _value;// 用于 channel >> received; 这种情况// 需要将变量的地址传入，协程恢复时写入变量内存ValueType* p_value = nullptr;std::coroutine_handle<> handle;explicit ReaderAwaiter(Channel<ValueType> *channel) : channel(channel) {}bool await_ready() { return false; }auto await_suspend(std::coroutine_handle<> coroutine_handle) {this->handle = coroutine_handle;// 将自身传给 Channel，Channel 内部会根据自身状态处理是否立即恢复或者挂起channel->try_push_reader(this);}int await_resume() {// Channel 关闭时也会将挂起的读写协程恢复// 要检查是否是关闭引起的恢复，如果是，check_closed 会抛出 Channel 关闭异常channel->check_closed();return _value;}// Channel 当中正常恢复读协程时调用 resume 函数void resume(ValueType value) {this->_value = value;if (p_value) {*p_value = value;}resume();}// Channel 关闭时调用 resume() 函数来恢复该协程// 在 await_resume 当中，如果 Channel 关闭，会抛出 Channel 关闭异常void resume() {if (executor) {executor->execute([this]() { handle.resume(); });} else {handle.resume();}}
};

Awaiter 的功能就是：负责用协程的调度器在需要时恢复协程，处理读写的值的传递（通过Channel）。

Channel 的实现

接下来给出 Channel 当中根据 buffer 的情况来处理读写两端的挂起和恢复的逻辑。

基本结构

template<typename ValueType>
struct Channel {... struct ChannelClosedException : std::exception {const char *what() const noexcept override {return "Channel is closed.";}};void check_closed() {// 如果已经关闭，则抛出异常if (!_is_active.load(std::memory_order_relaxed)) {throw ChannelClosedException();}}explicit Channel(int capacity = 0) : buffer_capacity(capacity) {_is_active.store(true, std::memory_order_relaxed);}// true 表示 Channel 尚未关闭bool is_active() {return _is_active.load(std::memory_order_relaxed);}// 关闭 Channelvoid close() {bool expect = true;// 判断如果已经关闭，则不再重复操作// 比较 _is_active 为 true 时才会完成设置操作，并且返回 trueif(_is_active.compare_exchange_strong(expect, false, std::memory_order_relaxed)) {// 清理资源clean_up();}}// 不希望 Channel 被移动或者复制Channel(Channel &&channel) = delete;Channel(Channel &) = delete;Channel &operator=(Channel &) = delete;// 销毁时关闭~Channel() {close();}private:// buffer 的容量int buffer_capacity;std::queue<ValueType> buffer;// buffer 已满时，新来的写入者需要挂起保存在这里等待恢复std::list<WriterAwaiter<ValueType> *> writer_list;// buffer 为空时，新来的读取者需要挂起保存在这里等待恢复std::list<ReaderAwaiter<ValueType> *> reader_list;// Channel 的状态标识std::atomic<bool> _is_active;std::mutex channel_lock;std::condition_variable channel_condition;void clean_up() {std::lock_guard lock(channel_lock);// 需要对已经挂起等待的协程予以恢复执行for (auto writer : writer_list) {writer->resume();}writer_list.clear();for (auto reader : reader_list) {reader->resume();}reader_list.clear();// 清空 bufferdecltype(buffer) empty_buffer;std::swap(buffer, empty_buffer);}
};

初始化和运行时:

  • 通道在创建时是开放的，可以进行数据的读写操作。
  • 当数据写入满足或读取可进行时，可能有等待的读写者被恢复执行。

关闭和清理：通道的关闭操作会触发资源的清理，包括清空缓冲区和恢复所有挂起的操作，确保没有线程或协程因通道关闭而无限期等待。

read 和 write

template<typename ValueType>
struct Channel {auto write(ValueType value) {check_closed();return WriterAwaiter<ValueType>(this, value);}auto operator<<(ValueType value) {return write(value);}auto read() {check_closed();return ReaderAwaiter<ValueType>(this);}auto operator>>(ValueType &value_ref) {auto awaiter =  read();// 保存待赋值的变量的地址，方便后续写入awaiter.p_value = &value_ref;return awaiter;}
}

write 方法:

  • 这个方法首先调用 check_closed() 检查通道是否已关闭。如果通道关闭，则会抛出 ChannelClosedException。
  • 若通道未关闭，方法将创建一个 WriterAwaiter 对象，这个对象负责管理写操作的挂起和恢复。WriterAwaiter 构造时接收通道自身的指针和要写入的值。

read 方法:

  • 类似于 write，read 方法首先检查通道是否已关闭，如果关闭，则抛出异常。
  • 如果通道开启，则创建并返回一个 ReaderAwaiter 对象，这个对象负责管理读操作的挂起和恢复。

这些对象会在协程尝试进行不可能立即完成的操作（如写入一个满的缓冲区或从空的缓冲区读取）时挂起协程。当操作变得可行时（如缓冲区有空间可写或有数据可读），相关的 Awaiter 会恢复协程的执行。

try_push_writer 和 try_push_reader

try_push_writer 调用时，意味着有一个新的写入者挂起准备写入值到 Channel 当中，这时候有以下几种情况：

  • Channel 当中有挂起的读取者，写入者直接将要写入的值传给读取者，恢复读取者，恢复写入者。
  • Channel 的 buffer 没满，写入者把值写入 buffer，然后立即恢复执行。
  • Channel 的 buffer 已满，则写入者被存入挂起列表（writer_list）等待新的读取者读取时再恢复。
void try_push_writer(WriterAwaiter<ValueType> *writer_awaiter) {std::unique_lock lock(channel_lock);check_closed();// 检查有没有挂起的读取者，对应情况 1if (!reader_list.empty()) {auto reader = reader_list.front();reader_list.pop_front();lock.unlock();reader->resume(writer_awaiter->_value);writer_awaiter->resume();return;}// buffer 未满，对应情况 2if (buffer.size() < buffer_capacity) {buffer.push(writer_awaiter->_value);lock.unlock();writer_awaiter->resume();return;}// buffer 已满，对应情况 3writer_list.push_back(writer_awaiter);
}

相对应的，try_push_reader 调用时，意味着有一个新的读取者挂起准备从 Channel 当中读取值，这时候有以下几种情况：

  • Channel 的 buffer 非空，读取者从 buffer 当中读取值，如果此时有挂起的写入者，需要去队头的写入者将值写入 buffer，然后立即恢复该写入者和当次的读取者。
  • Channel 当中有挂起的写入者，写入者直接将要写入的值传给读取者，恢复读取者，恢复写入者
  • Channel 的 buffer 为空，则读取者被存入挂起列表（reader_list）等待新的写入者写入时再恢复。
void try_push_reader(ReaderAwaiter<ValueType> *reader_awaiter) {std::unique_lock lock(channel_lock);check_closed();// buffer 非空，对应情况 1if (!buffer.empty()) {auto value = buffer.front();buffer.pop();if (!writer_list.empty()) {// 有挂起的写入者要及时将其写入 buffer 并恢复执行auto writer = writer_list.front();writer_list.pop_front();buffer.push(writer->_value);lock.unlock();writer->resume();} else {lock.unlock();}reader_awaiter->resume(value);return;}// 有写入者挂起，对应情况 2if (!writer_list.empty()) {auto writer = writer_list.front();writer_list.pop_front();lock.unlock();reader_awaiter->resume(writer->_value);writer->resume();return;}// buffer 为空，对应情况 3reader_list.push_back(reader_awaiter);
}

监听协程的提前销毁

观察上述代码，Channel 对象必须在持有 Channel 实例的协程退出之前关闭。在 Channel 当中持有了已经挂起的读写协程的 Awaiter 的指针，一旦协程销毁，这些 Awaiter 也会被销毁，Channel 在关闭时试图恢复这些读写协程时就会出现程序崩溃（访问了野指针）。

为了解决这个问题，需要在 Awaiter 销毁时主动将自己的指针从 Channel 当中移除。

template<typename ValueType>
struct ReaderAwaiter {ReaderAwaiter(ReaderAwaiter&& other) noexcept: channel(std::exchange(other.channel, nullptr)),executor(std::exchange(other.executor, nullptr)),_value(other._value),p_value(std::exchange(other.p_value, nullptr)),handle(other.handle) {}int await_resume() {auto channel = this->channel;this->channel = nullptr;channel->check_closed();return _value;}~ReaderAwaiter() {if (channel) channel->remove_reader(this);}
}

实现了移动构造函数，ReaderAwaiter在被移动后会将原对象的channel指针置为nullptr。原来的Awaiter对象不再与任何Channel关联，从而防止在原Awaiter对象被销毁时误操作已移走的资源。

协程恢复时将自身持有的channel指针置空。这是因为当协程由于await表达式被挂起后恢复执行时，await_resume()被调用以继续执行协程。将channel设置为nullptr之后，如果在后续的执行中再次错误地或意外地引用了channel，这将直接导致访问空指针错误而非进行无效或危险的操作。

在ReaderAwaiter的析构函数中，如果其channel成员变量仍然非空，表明该Awaiter可能在协程尚未恢复执行前被销毁（例如协程的异常退出或提前结束）。在这种情况下，Awaiter负责通知Channel从其等待列表中移除自己，确保Channel不会在未来尝试访问已经销毁的Awaiter。

对应的，Channel 当中也需要增加 remove_reader 函数：

template<typename ValueType>
struct Channel {void remove_reader(ReaderAwaiter<ValueType> *reader_awaiter) {// 并发环境，修改 reader_list 的操作都需要加锁std::lock_guard lock(channel_lock);reader_list.remove(reader_awaiter);}
}

WriterAwaiter 的修改类似，之后即使把正在等待读写 Channel 的协程提前结束销毁，也不会影响 Channel 的继续使用以及后续的正常关闭了。

结果展示

测试代码如下所示

Task<void, LooperExecutor> Producer(Channel<int>& channel) {int i = 0;while (i < 10) {debug("send: ", i);co_await(channel << i++);co_await 50ms;}co_await 5s;channel.close();debug("close channel, exit.");
}Task<void, LooperExecutor> Consumer(Channel<int>& channel) {while (channel.is_active()) {try {int received;co_await(channel >> received);debug("receive: ", received);co_await 500ms;}catch (std::exception& e) {//}}debug("exit.");
}Task<void, LooperExecutor> Consumer2(Channel<int>& channel) {while (channel.is_active()) {try {auto received = co_await channel.read();debug("receive2: ", received);co_await 300ms;}catch (std::exception& e) {//}}debug("exit.");
}
// co_wait 时间也会有run_loop exit.
void test_channel() {debug("test_channel()");auto channel = Channel<int>(5);auto producer = Producer(channel);auto consumer = Consumer(channel);auto consumer2 = Consumer2(channel);std::this_thread::sleep_for(10s);
}int main() {test_channel();return 0;
}

完整代码见个人github的Coroutines项目。

Current time: 19:47.300 18784 send:  0
Current time: 19:47.300 26408 receive2:  0
Current time: 19:47.356 18784 send:  1
Current time: 19:47.357 38656 receive:  1
Current time: 19:47.419 18784 send:  2
Current time: 19:47.482 18784 send:  3
Current time: 19:47.545 18784 send:  4
Current time: 19:47.607 18784 send:  5
Current time: 19:47.607 26408 receive2:  2
Current time: 19:47.669 18784 send:  6
Current time: 19:47.731 18784 send:  7
Current time: 19:47.791 18784 send:  8
Current time: 19:47.869 38656 receive:  3
Current time: 19:47.915 26408 receive2:  4
Current time: 19:47.931 18784 send:  9
Current time: 19:48.224 26408 receive2:  5
Current time: 19:48.379 38656 receive:  6
Current time: 19:48.532 26408 receive2:  7
Current time: 19:48.839 26408 receive2:  8
Current time: 19:48.886 38656 receive:  9

基本符合其中的等待时间和处理逻辑。

这篇关于探究C++20协程(6)——实现协程之间消息传递的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/935485。

相关文章

关于C++中的虚拟继承的一些总结（虚拟继承，覆盖，派生，隐藏）

关于C++中的虚拟继承的一些总结（虚拟继承，覆盖，派生，隐藏）

1.为什么要引入虚拟继承 虚拟继承是多重继承中特有的概念。虚拟基类是为解决多重继承而出现的。如:类D继承自类B1、B2，而类B1、B2都继承自类A，因此在类D中两次出现类A中的变量和函数。为了节省内存空间，可以将B1、B2对A的继承定义为虚拟继承，而A就成了虚拟基类。实现的代码如下： class A class B1:public virtual A; class B2:pu
阅读更多...
C++对象布局及多态实现探索之内存布局（整理的很多链接）

C++对象布局及多态实现探索之内存布局（整理的很多链接）

本文通过观察对象的内存布局，跟踪函数调用的汇编代码。分析了C++对象内存的布局情况，虚函数的执行方式，以及虚继承，等等 文章链接：http://dev.yesky.com/254/2191254.shtml      论C/C++函数间动态内存的传递 (2005-07-30)   当你涉及到C/C++的核心编程的时候，你会无止境地与内存管理打交道。 文章链接：http://dev.yesky
阅读更多...
C++的模板(八)：子系统

C++的模板(八)：子系统

平常所见的大部分模板代码，模板所传的参数类型，到了模板里面，或实例化为对象，或嵌入模板内部结构中，或在模板内又派生了子类。不管怎样，最终他们在模板内，直接或间接，都实例化成对象了。 但这不是唯一的用法。试想一下。如果在模板内限制调用参数类型的构造函数会发生什么?参数类的对象在模板内无法构造。他们只能从模板的成员函数传入。模板不保存这些对象或者只保存他们的指针。因为构造函数被分离，这些指针在模板外
阅读更多...
C++工程编译链接错误汇总VisualStudio

C++工程编译链接错误汇总VisualStudio

目录 一些小的知识点 make工具 可以使用windows下的事件查看器崩溃的地方 dumpbin工具查看dll是32位还是64位的 _MSC_VER .cc 和.cpp 【VC++目录中的包含目录】 vs 【C/C++常规中的附加包含目录】——头文件所在目录如何怎么添加，添加了以后搜索头文件就会到这些个路径下搜索了 include<> 和 include"" WinMain 和
阅读更多...
C/C++的编译和链接过程

C/C++的编译和链接过程

目录 从源文件生成可执行文件（书中第2章） 1.Preprocessing预处理——预处理器cpp 2.Compilation编译——编译器cll ps：vs中优化选项设置 3.Assembly汇编——汇编器as ps：vs中汇编输出文件设置 4.Linking链接——链接器ld 符号 模块，库 链接过程——链接器 链接过程 1.简单链接的例子 2.链接过程 3.地址和
阅读更多...
C++必修：模版的入门到实践

C++必修：模版的入门到实践

✨✨ 欢迎大家来到贝蒂大讲堂✨✨ 🎈🎈养成好习惯，先赞后看哦~🎈🎈 所属专栏：C++学习 贝蒂的主页：Betty’s blog 1. 泛型编程 首先让我们来思考一个问题，如何实现一个交换函数？ void swap(int& x, int& y){int tmp = x;x = y;y = tmp;} 相信大家很快就能写出上面这段代码，但是如果要求这个交换函数支持字符型
阅读更多...
20.Spring5注解介绍

20.Spring5注解介绍

1.配置组件 Configure Components 注解名称说明@Configuration把一个类作为一个loC容 器 ，它的某个方法头上如果注册7@Bean , 就会作为这个Spring容器中的Bean@ComponentScan在配置类上添加@ComponentScan注解。该注解默认会扫描该类所在的包下所有的配置类，相当于之前的 <context:component-scan>@Sc
阅读更多...
通过SSH隧道实现通过远程服务器上外网

通过SSH隧道实现通过远程服务器上外网

搭建隧道 autossh -M 0 -f -D 1080 -C -N user1@remotehost##验证隧道是否生效，查看1080端口是否启动netstat -tuln | grep 1080## 测试ssh 隧道是否生效curl -x socks5h://127.0.0.1:1080 -I http://www.github.com 将autossh 设置为服务，隧道开机启动
阅读更多...
时序预测 | MATLAB实现LSTM时间序列未来多步预测-递归预测

时序预测 | MATLAB实现LSTM时间序列未来多步预测-递归预测

时序预测 | MATLAB实现LSTM时间序列未来多步预测-递归预测 目录 时序预测 | MATLAB实现LSTM时间序列未来多步预测-递归预测基本介绍程序设计参考资料 基本介绍 MATLAB实现LSTM时间序列未来多步预测-递归预测。LSTM是一种含有LSTM区块（blocks）或其他的一种类神经网络，文献或其他资料中LSTM区块可能被描述成智能网络单元，因为
阅读更多...
C++入门01

C++入门01

1、.h和.cpp 源文件 (.cpp)源文件是C++程序的实际实现代码文件，其中包含了具体的函数和类的定义、实现以及其他相关的代码。主要特点如下：实现代码: 源文件中包含了函数、类的具体实现代码，用于实现程序的功能。编译单元: 源文件通常是一个编译单元，即单独编译的基本单位。每个源文件都会经过编译器的处理，生成对应的目标文件。包含头文件: 源文件可以通过#include指令引入头文件，以使
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2