ClickHouse/silk

来源：https://github.com/ClickHouse/silk

Silk

一个面向 Linux 的协作式纤程调度器，具有每 CPU 调度线程、io_uring 集成和拓扑感知的任务窃取能力。纤程是轻量级的有栈协程，它们挂起而非阻塞其所属的 OS 线程，从而以较低开销实现高并发。

文档

• docs/scheduler.md — 调度循环、上下文切换、挂起模式、异步 IO、睡眠取消、任务窃取设计及性能基准
• docs/sync.md — 同步原语：FiberFuture、FiberFutex、FiberMutex、FiberSequencer、FiberEvent、FairFiberMutex
• docs/util.md — 工具库：无锁数据结构、TSC 计时、内存池、CPU 拓扑、日志、断言
• docs/perf.md — net-perf 和 file-perf 基准测试结果及 fio 对比
• docs/coroutines.md — 无栈协程与有栈纤程：设计差异与性能数据
• src/fibers/tests/ — 使用示例：纤程生命周期、future、同步原语、异步 IO
• src/gdb/fiber.py — GDB 扩展；通过 source src/gdb/fiber.py 加载，然后使用 fiber-list、fiber-savecontext、fiber-restorecontext、fiber-switchcontext

依赖

• CMake >= 3.28
• Ninja
• Clang 21
• ccache（可选）
• Boost 头文件（libboost-dev）
• libelf（libelf-dev）—— 可选，仅 src/profiler 需要；若缺失则静默跳过 profiler。
  GTest、Google Benchmark、libbacktrace、liburing、librseq、libbpf、bpftool 和 cxxopts 以子模块形式捆绑在 contrib/ 下，无需单独安装。用于纤程切换的两个 Boost.Context 汇编源文件放入 contrib/fcontext/ 中，systemtap 的 USDT 头文件（和）放入 contrib/systemtap-sdt/ 中（均为直接放入，非子模块）。Poco、AWS SDK 和 jemalloc 可通过向 configure 传递 --build-poco、--build-aws 和 --build-jemalloc 来按需构建。可选基准测试的运行时依赖：nginx（仅 http-perf --nginx 需要；默认使用 http-perf 二进制内置的基于 Poco 的内部服务器）、fio（用于 fio-perf）和 MinIO（用于 s3-perf）。如果未在 PATH 中找到 MinIO，会自动下载到 .tools/ 目录；其余依赖需单独安装。

构建

./bb [选项] [命令]

全局选项

命令

configure [--build-poco] [--build-aws] [--build-jemalloc]

配置（或重新配置）CMake 构建目录。可选标志启用默认关闭的组件：--build-poco 启用 http-perf（需要 Poco），--build-aws 启用 s3-perf（需要 AWS SDK），--build-jemalloc 启用 jemalloc（由 http-perf 和 s3-perf 使用以提升分配器性能）。
./bb configure ./bb configure --build-poco --build-aws ./bb -b release configure

fmt [--check]

使用 clang-format-21 格式化所有源文件。传递 --check 在不修改文件的情况下检查格式（若有文件将被更改则退出非零）。
./bb fmt ./bb fmt --check

clean

删除整个 build/ 目录。
./bb clean

build [目标]

构建项目。如果构建目录不存在则自动配置。当未指定命令时，build 是默认命令。
./bb # debug 构建 ./bb -b release # release 构建 ./bb -s thread # 带 TSan 的 debug 构建 ./bb -b release -s address # 带 ASan 的 release 构建 ./bb build fibers-test # 构建特定目标

test [-R 模式] [-N] [ctest 标志...]

构建并运行测试。使用所有可用 CPU 并行运行。任何额外标志直接传递给 ctest。

bench [-R 模式] [-N] [gbench 标志...]

构建并运行基准测试。

性能命令

每个 perf 命令构建相关二进制并运行基准测试，以 Markdown 表格形式输出结果。持续时间、预热和延迟选项可接受单位后缀（ns、us、ms、s、m）；裸数字被视为秒。所有 perf 命令均接受 --timeout SECONDS（每次运行的超时时间；默认 180，0 表示无限制）。

file-perf

使用 io_uring 的异步文件 I/O 基准测试。

fio-perf

使用 io_uring 引擎的 fio 对比。选项与 file-perf 相同（除 --flamegraph 和 --print-counters）。不构建任何东西。
./bb fio-perf ./bb fio-perf --bs 64k ./bb fio-perf --numjobs 1 16 --iodepth 1 16

net-perf

TCP 回显基准测试。启动本地服务器并运行客户端。当 --host 指向远程主机时，不在本地启动服务器。

net-perf-asio

使用 Boost.Asio C++20 协程的 TCP 回显基准测试。选项与 net-perf 相同。
./bb -b release net-perf-asio ./bb -b release net-perf-asio --connections 1 64 256 1024 ./bb -b release net-perf-asio --delay 1ms ./bb -b release net-perf-asio --flamegraph

http-perf

HTTP/1.1 GET 基准测试。默认使用 silk 的内部 HTTP 服务器（基于 FiberSocketImpl 的 Poco HTTPServerConnection，每个连接一个纤程）；传递 --nginx 则针对 nginx 运行。

s3-perf

S3 对象存储基准测试。启动本地 MinIO 服务器（如果未在 PATH 中找到，会自动下载到 .tools/ 目录）并运行客户端。

perf

一次运行多个 perf 基准测试。目标为位置值，列在选项之后。