基于 C++20 协程的高并发异步 I/O 库(小彭老师教学用)
- 100% 协程
- HTTP & HTTPS 协议实现
- 服务端和客户端均有支持
- 也支持原始套接字
- 百万级并发
- 纳秒级定时器
- 支持 WebSocket
- 也支持流式返回(SSE)
- 支持I/O 超时
- 支持任务取消
- 创建进程并读写管道
- 支持用户态管道
- 线程池执行阻塞任务
- 条件变量
- 异步队列
- 支持inotify
- 支持futex
- 支持多线程
- 可实现 HTTP 转发
- 自动识别
http(s)_proxy
代理 - 文件服务器
- 异步读写文件
- Expected 语义
- 更多新特性还在赶来中...
- 第一集:C++20 协程概念初上手
- 第二集:封装 epoll 实现 HTTP 客户端
- 第三集:io uring 实现 HTTP 服务器
- 第四集:进一步完善 HTTP 路由,实现线程池(施工中,稍后上传)
steps 目录 是本库代码逐渐成形的过程,可以配合教学视频自己动手尝试。
#include <co_async/co_async.hpp>
using namespace co_async;
using namespace std::literals;
Task<Expected<>> amain() {
// 第一下 co_await 等待 bind 操作完成,返回一个 Expected<T> 对象。
// Expected<T> 有两种状态:1. 正常返回 T 值;2. 返回错误码 std::error_code
// 第二下 co_await 可以将 Expected<T> 的错误转化为当前函数的错误(没有错误则照常返回 T):
auto listener = co_await co_await listener_bind({"127.0.0.1", 8080});
HTTPServer server;
server.route("GET", "/", [](HTTPServer::IO &io) -> Task<Expected<>> {
HTTPResponse res = {
.status = 200,
.headers = {
{"content-type", "text/html;charset=utf-8"},
},
};
std::string_view body = "<h1>It works!</h1>";
co_await io.response(res, body);
co_return {};
});
while (true) {
if (auto income = co_await listener_accept(listener)) {
// 如果成功 accept 到输入连接,则开始处理 HTTP 请求
co_spawn(server.handle_http(std::move(*income)));
}
}
}
int main() {
co_main(amain());
return 0;
}
examples 目录 中有更多案例。多线程版本详见 examples/server_mt.cpp
- Linux 内核 >= 5.19
- GCC >= 10
- Clang >= 16
小彭老师推荐使用 Arch Linux 系统作为开发平台:
cmake -B build
cmake --build build --parallel 8
build/server # 对应于 examples/server.cpp
如果是 Ubuntu 20.04 的话需要手动升级一下 gcc 版本(默认的 g++-9 不支持协程):
sudo apt install -y g++-10 libstdc++-10-dev
export CXX=g++-10
rm -rf build
cmake -B build -DCO_ASYNC_DEBUG=ON
cmake --build build --parallel 8
build/server # 对应于 examples/server.cpp
此处开启的
-DCO_ASYNC_DEBUG=ON
选项可以检测潜在的漏洞。
如果你的 Linux 内核版本是 5.x,可能还需要开启这个选项:
cmake -B build -DCO_ASYNC_DEBUG=ON -DCO_ASYNC_INVALFIX=ON
Linux 6.x 内核则无需开启,你可以通过
uname -r
查询内核版本。
如果你的 Ubuntu 标准库版本太老,无法编译,可以试试看小彭老师提供的 Docker 环境:
docker build -t my_archlinux_image . # 构建 Docker 镜像
docker run -it -p 8080:8080 my_archlinux_image # 运行并进入 Docker 镜像,映射端口 8080 到本机
在 Docker 容器中,构建本项目:
cmake -B build
cmake --build build --parallel 8
build/server # 对应于 examples/server.cpp
Docker 继承宿主机的 Linux 内核版本,因此 Docker 无法解决 Linux 内核版本过低的问题。
同样地,不建议使用 WSL,因为 WSL 的 Linux 内核版本是固定的,无法升级,而且非常老,常常是 4.x。
- Windows >= 10(施工中,稍后支持)
- Visual Studio >= 2022(施工中,稍后支持)
将本项目下载到你的项目中作为子文件夹,引入并链接:
add_subdirectory(co_async)
target_link_libraries(你的名字 PRIVATE co_async)
在你的代码中导入主头文件即可:
#include <co_async/co_async.hpp>
下载 scripts/single_co_async.hpp,然后:
#define CO_ASYNC_IMPLEMENTATION // 在其中一个 cpp 文件中定义该宏
#include <single_co_async.hpp>
Linux 编译选项:-std=c++20 -I 本项目根目录 -luring -lbearssl
- liburing >= 2.6
- bearssl >= 0.6
cmake -B build -DCO_ASYNC_DEBUG=ON # 启用调试与安全性检测
cmake -B build -DCO_ASYNC_EXCEPT=ON # 启用异常(会影响协程函数性能)
cmake -B build -DCO_ASYNC_PERF=ON # 启用性能测试(程序结束时自动打印测时结果)
cmake -B build -DCO_ASYNC_ZLIB=ON # 启用压缩支持(需要链接 /usr/lib/libz.so)
cmake -B build -DCO_ASYNC_STEAL=ON # 启用多线程任务窃取(类似于 TBB)
cmake -B build -DCO_ASYNC_ALLOC=ON # 启用自定义分配器(基于 C++17 PMR)
cmake -B build -DCO_ASYNC_DIRECT=ON # 启用直接 IO 轮询(仅限数据库应用场景)
cmake -B build -DCO_ASYNC_INVALFIX=ON # 尝试修复低 Linux 内核版本的错误
cmake -B build -DCO_ASYNC_NATIVE=ON # 启用本机指令集(-march=native)
cmake -B build -DCO_ASYNC_WARN=ON # 启用警告(-Wall -Wextra -Werror)
cmake -B build -DCO_ASYNC_JEMALLOC=ON # 启用 Jemalloc 分配器
测试平台:
- AMD Ryzen 7 7800X3D(8 核心 16 线程 4.5 GHz)
- Linux 内核:6.8.2
- GCC 编译器:13.2.1
- 内存:2 x 16 GB(DDR5 4800 MHz)
测试结果:
- 普通函数调用 25ns
- 协程函数调用 80ns
- 协程函数调用(启用异常)150ns
- I/O 基础延迟 0.8µs
- 打开文件 7µs
- 查询文件信息 11µs
- 读写 ~1MB 文件 80µs
百万并发 HTTP 压力测试 examples/server_mt.cpp:
$ wrk -t16 -c1000 -d20s http://127.0.0.1:8080/
Running 20s test @ http://127.0.0.1:8080/
16 threads and 1000 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 1.58ms 6.07ms 222.19ms 98.78%
Req/Sec 79.18k 9.15k 154.00k 94.73%
25281650 requests in 20.09s, 2.83GB read
Requests/sec: 1258548.22
Transfer/sec: 144.03MB