<p align="center"> <img src="./resource/tinycoro_intro.jpg" alt="tinycoro Logo"> </p>

---

🚀tinyCoroLab Course

<!-- support below --> <!-- [](link/actions/workflows/cmake.yml) --> <!-- [](https://github.com/jbaldwin/libcoro/actions/workflows/ci-coverage.yml) [](https://coveralls.io/github/jbaldwin/libcoro?branch=main) [](https://www.codacy.com/gh/jbaldwin/libcoro/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=jbaldwin/libcoro&amp;utm_campaign=Badge_Grade) -->

⚠️查看旧版本请切换分支 ⭐项目制作不易，请点击star支持一下❤️

🔥tinyCoroLab的更新会持续进行，并致力于打造对标工业标准的代码质量和性能，欢迎您与我共同建设tinyCoroLab💪

tinyCoro介绍

tinyCoroLab是一门以tinyCoro为基础的实验课程，而tinyCoro是一个linux系统环境下的以C++20协程技术和linux io_uring技术相结合的高性能异步协程库。高效且全能的io_uring和C++20无栈协程的轻量级切换相组合使得tinyCoro可以轻松应对I/O密集型负载，而C++20协程的特性使得用户可以以同步的方式编写异步执行的代码，大大降低了后期维护的工作量，且代码逻辑非常简单且清晰，除此外tinyCoro还提供了协程安全组件，以协程suspend代替线程阻塞便于用户构建协程安全且高效的代码。

经过测试由tinyCoro实现的echo server在1kbyte负载和100个并发连接下可达到100wQPS，关于tinyCoro更详细的信息请访问github主页。

tinyCoroLab介绍

tinyCoroLab的设计灵感来自于广为人知的CMU15445数据库内核实验和MIT6.824分布式实验，它们通过让学生编写指定接口的实现并通过大量的测试验证正确性来使得学生提高代码能力的同时学习到特定的领域知识，高难度的实验带来的是巨大的代码级和知识级的能力提升，这也使得这两门实验课程广受学生好评。而tinyCoroLab沿袭这种设计思路，通过将tinyCoro的实现拆分成多个子部分来构成5节实验课程，包括：

• lab1: 构建协程任务封装，包括lab1一个子实验
• lab2: 构建任务执行引擎，包括lab2a和lab2b两个子实验
• lab3: 封装异步I/O执行模块，包括lab3一个子实验
• lab4: 构建基础协程同步组件，包括lab4a，lab4b，lab4c，lab4d四个子实验
• lab5: 构建进阶协程同步组件，包括lab5a，lab5b，lab5c三个子实验

在上述实验的基础上tinyCoroLab提供了200+项功能测试和内存安全测试来考察用户实现的功能逻辑正确性和内存安全性，并且lab4和lab5额外新增了性能测试通过googlebenchmark将基线模型与用户实现做对比来衡量用户实现的性能。除此之外tinyCoroLab在cmake中定义了大量的指令来简化实验流程并提供一键生成perf性能分析火焰图的脚本，使得实验者可以专心于实现实验内容。

tinyCoroLab并不像CMU15445和mit6.824课程那样涉及特定领域复杂的知识，因此难度稍弱，但其本身涉及到多线程下的高并发因此仍旧对实验者的代码能力仍有较强考验。tinyCoroLab核心功能代码共计约2000行，测试加样例共计约4000行，而作为tinyCoroLab的开源实现版本tinyCoro在实验的基础上添加了约700行功能代码，因此实验者代码量预计在700行以下，耗时预计一个星期左右。

通过完成该实验，你将收获：

• 简历新增一个新颖、有技术含量且被深度量化过的项目。
• 更加熟练的C++编程技巧，以及对C++新标准的应用。
• 对强大的io_uring异步I/O技术的掌握。
• 对多线程编程有更深入的理解。

本实验学习了github开源且高star的C++项目的项目组织方式，如果你愿意研究该部分内容，你还将收获：

• 一个标准的通过cmake构建C++项目的方式。
• 在项目中熟练运用单元测试、性能测试以及性能分析工具。

免费开源文档

扫描下方二维码加入tinyCoroLab免费课程交流qq群，任何问题都可向作者本人直接提问哦！

<!-- {height=400px} --> <img src="./resource/tinycoro_qq.JPG" height="400">

当然，你也可以通过我的邮箱393814041@qq.com直接与我联系！

点击免费的在线文档链接tinycorolab-docs来开启属于你的tinyCoroLab之旅吧！

原有的付费文档已全部开源免费！！！即实验+预备知识讲解+全套实验图文解析+完整面试实战+持续更新的番外知识，你可以收获到：

• 对于开启tinyCoroLab的前置知识C++协程和liburing的讲解，因为知识点很庞大，所以我按照自己的理解精心制作了多篇文档来帮助大家理解
• 对于tinyCoroLab的每一项实验我都会根据tinyCoro的代码为大家讲解如何实现，并突出强调重点知识点
• 由我个人根据30+大厂面试经验（95%通过率）整理的完整的tinyCoro实战面试经历
• 在番外杂谈部分我会持续分享一些我在工作中遇到一些有趣的知识点

tinyCoroLab实验必读

实验依赖工具安装

• python version >= 3.7: 部分测试脚本需要依赖 python 执行，请确保本地命令行运行 python 或者 python3 不会报错
• valgrind version >= 3.18.1: 部分读者反映内存测试出错是因为 valgrind 版本过旧，3.18.1 为作者测试的一个可以正常运行的版本，如果读者本地内存测试出错可以尝试更新到该版本

tinyCoroLab实验环境搭建

由于tinyCoroLab使用了只在linux下支持的liburing，因此用户需要准备linux系统环境并使用尽量新的内核，wsl以及虚拟机均可，并预先安装好cmake以及支持C++20标准的gcc编译器。

首先实验者需要克隆tinyCoroLab到本地：

git clone https://github.com/sakurs2/tinyCoroLab.git

初始化所有子模块：

cd tinyCoroLab
git submodule update --init --recursive

按下列步骤安装liburing：

⚠️最好不要使用系统包管理器来安装liburing，因为包管理器通常是旧版本，可能会出现功能bug，同时也请确保tinyCoroLab的cmake搜索到的liburing是最新版

cd third_party/liburing/
./configure --cc=gcc --cxx=g++;
make -j$(nproc);
make liburing.pc
sudo make install;

上述步骤结束后回到tinyCoroLab主目录，按下列步骤构建tinyCoroLab：

mkdir build
cd build
cmake ..
make -j$(nproc)

编译成功后即表示tinyCoroLab的环境正式搭建完毕。

tinyCoroLab各模块介绍

$ tree -d -A -I third_party -I build -I .vscode -I resource -I temp
.
├── benchmark # 压测文件存放目录
│   ├── base_model # 基线模型（暂时废弃）
│   └── tinycoro_model # tinyCoro压测模型
├── benchtests # lab4和lab5的googlebenchmark测试文件存放目录 
├── config # 配置文件存放目录
├── examples # 使用tinyCoro构建的样例程序存放目录
├── include # tinyCoroLab核心头文件目录
│   └── coro
│       ├── comp # 协程同步组件存放目录
│       ├── concepts # C++ concepts文件存放目录
│       ├── detail # 辅助文件如类型定义和基础数据结构存放目录
│       └── net # 网络编程实现文件存放目录
├── scripts # 实验脚本文件存放目录
├── src # tinyCoroLab核心源文件目录
│   ├── comp
│   └── net
└── tests # 功能测试代码文件存放目录

上面的目录树展示了tinyCoroLab的核心目录结构并用注释表明了各个目录的用途，下面我们针对各个模块的核心文件并讲解用途。

config/config.h.in

该文件存放了tinyCoroLab的配置项，由于项目使用了cmake传递的变量所以配置文件是.h.in的文件格式并由cmake指令生成项目真正使用的配置文件config.h，因此实验者对配置的任何修改必须在config.h.in文件里，而对于config.h文件的修改会在重新执行cmake构建指令后被覆盖掉。

关于各个配置项的内容文件内均添加了注释，实验者保持默认设置参数即可。

1.1版本之前存在运行模式这一概念，在短期运行模式下没有任何待执行的任务的context会立刻退出，那么scheduler便无法派发任务至该context，这是不合理的。

在1.1版本kLongRunMode=true参数已废弃，含糊不清的运行模式概念已被删除，现在scheduler会在全部context完成执行后统一发送退出信号，这样协程在运行过程中就可以自由的向scheduler派发任务了，具体示意图如下：

<!-- 但关于[tinyCoroLab](https://github.com/sakurs2/tinyCoroLab)运行模式的配置项kLongRunMode务必重点说明一下，首先实验者需要理解[tinyCoroLab](https://github.com/sakurs2/tinyCoroLab)的核心设计是一个scheduler掌管多个context，而一个context即一个工作线程。 对于`kLongRunMode=true`即开启长期运行模式，此时所有的context永远都不会停止，且均有可能收到scheduler派发的任务，如果context在运行过程中产生新任务会交给scheduler来决定调度逻辑，这通过调用`submit_to_scheduler`函数实现。该模式适用于利用tinyCoro搭建长期运行的服务比如web服务器。 而对于`kLongRunMode=false`即短期运行模式，在context启动后会立刻收到scheduler发送的停止信号，如果此时context没有待执行的任务即会立刻停止，有待执行的任务会等任务执行完毕立刻停止，如果停止的context再接收到新的任务那么该任务将无法执行，因此在该模式下任务需要在context启动前提前由scheduler派发任务到各个context，而在运行过程中context产生的新任务也将交由自身执行来避免scheduler将任务派发到停止的context。该模式适用于一些短期计算任务，且实验中的测试均基于该模式运行。 具体的示意图如下：  不过具体运行逻辑受到多个参数影响，后续会详细介绍，实验者将`kLongRunMode`保持为默认true就可以。 -->

include/coro

作为项目头文件存放目录，涉及到tinyCoroLab的核心功能，下面给出各个子模块的详细作用：

• comp: 用于存放协程同步组件的文件，即lab4和lab5的实验内容。
• concepts: C++20提供了一种新的编译检查机制即concepts。通过使用Concepts，开发者可以明确指定模板参数必须满足的条件，从而提高代码的可读性和可维护性，同时编译器可以在编译时检查这些条件是否满足，避免在实例化模板时出现意外的错误?。而该目录存放了tinyCoroLab涉及到的concepts的定义。
• detail/container.hpp: 该文件定义了一种数据存储容器，在实际开发中可能面临一种场景需要将数据暂存并延迟返回，而C++协程在返回值的时候也是需要先将返回值存储到promise对象再利用awaiter返回值，读者可能会疑惑额外定义一个变量存储不就行了，但C++是存在左值和右值以及移动和拷贝等概念的，如果值可被移动但你定义的容器仍然选择拷贝构造那么很容易造成性能损失，当然实际的情况可能更加复杂，所以定义该容器的目的就是为了对高效暂存数据提供一个统一的解决方案。原本该容器是libcoro中task的一部分，但在tinyCoroLab中有多个组件需要需要临时存储变量，所以将该逻辑从task中剥离单独作为一个模块，实验者在实验过程中也可根据需要使用该容器。
• net: 这是tinyCoroLab的网络模块，目前只实现了简易的tcp支持，在实验者完成lab1和lab2之后就可以利用该模块实现针对tcp的网络I/O编程了。
• atomic_que.hpp: 这里对第三方库AtomicQueue提供的高性能无锁环形队列进行了封装。
• log.hpp: tinyCoroLab借助第三方库spdlog提供的线程安全日志功能，引入该头文件后使用log::info("hello {}","tinyCoro")这种形式即可打印日志到终端，通过更改配置文件可实现额外打印到文件以及更改日志级别的功能。
• meta_info.hpp: 存储全局共享以及线程局部变量的定义，有利于协程运行时获取上下文信息。
• spinlock.hpp: 利用原子变量实现的一种自旋锁。
• uring_proxy.hpp: 该文件对liburing进行了简单的二次封装，实验者可以在此基础上封装更多的功能。
• utils.hpp: 存放工具函数。
• task.hpp: 协程支持模块，所有任务的基本单元即一个task，实验者将在lab1中完善该模块。
• engine.hpp: engine作为tinyCoroLab的心脏，即核心执行引擎，负责执行所有接收到的任务，包括异步执行I/O任务，实验者将在lab2a