#feat: Update to v1.2

Author: sakurs2

.github/workflows/ci-ubuntu.yml

@@ -0,0 +1,85 @@
+# This starter workflow is for a CMake project running on a single platform. There is a different starter workflow if you need cross-platform coverage.
+# See: https://github.com/actions/starter-workflows/blob/main/ci/cmake-multi-platform.yml
+name: CMake on ubuntu
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+env:
+  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
+  BUILD_TYPE: Release
+
+jobs:
+  build:
+    # The CMake configure and build commands are platform agnostic and should work equally well on Windows or Mac.
+    # You can convert this to a matrix build if you need cross-platform coverage.
+    # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Setup Python
+      uses: actions/setup-python@v5.6.0
+      with:
+        # Version range or exact version of Python or PyPy to use, using SemVer's version range syntax. Reads from .python-version if unset.
+        python-version: 3.12.10
+        # File containing the Python version to use. Example: .python-version
+        # python-version-file: # optional
+        # Used to specify a package manager for caching in the default directory. Supported values: pip, pipenv, poetry.
+        # cache: # optional
+        # The target architecture (x86, x64, arm64) of the Python or PyPy interpreter.
+        architecture: x64
+        # Set this option if you want the action to check for the latest available version that satisfies the version spec.
+        # check-latest: # optional
+        # The token used to authenticate when fetching Python distributions from https://github.com/actions/python-versions. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting.
+        # token: # optional, default is ${{ github.server_url == 'https://github.com' && github.token || '' }}
+        # Used to specify the path to dependency files. Supports wildcards or a list of file names for caching multiple dependencies.
+        # cache-dependency-path: # optional
+        # Set this option if you want the action to update environment variables.
+        # update-environment: # optional, default is true
+        # When 'true', a version range passed to 'python-version' input will match prerelease versions if no GA versions are found. Only 'x.y' version range is supported for CPython.
+        # allow-prereleases: # optional
+        # When 'true', use the freethreaded version of Python.
+        # freethreaded: # optional
+
+    - name: Python deps install
+      run: pip install pyyaml
+    
+    - name: Submodule init
+      uses: actions/checkout@v4
+      with:
+          submodules: true
+
+    - name: Install Liburing
+      run: |
+        mkdir temp
+        cd temp 
+        git clone https://github.com/axboe/liburing.git
+        cd liburing
+        ./configure --cc=gcc --cxx=g++
+        make -j$(nproc)
+        make liburing.pc
+        sudo make install
+
+    - name: Configure CMake
+      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
+      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
+      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+
+    - name: Build
+      # Build your program with the given configuration
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+    - name: Test
+      working-directory: ${{github.workspace}}/build
+      # Execute tests defined by the CMake configuration.
+      # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
+      run: |
+        cp ${{github.workspace}}/scripts/CITests.py ${{github.workspace}}/build/CITests.py 
+        cp ${{github.workspace}}/scripts/CITests.yml ${{github.workspace}}/build/CITests.yml
+        python CITests.py
+

README.MD

@@ -4,10 +4,10 @@
 
 -----------------
 
-# tinyCoroLab Course
+# 🚀tinyCoroLab Course
 
 [![C++20](https://img.shields.io/badge/dialect-C%2B%2B20-blue)](https://en.cppreference.com/w/cpp/20)[![MIT license](https://img.shields.io/github/license/max0x7ba/atomic_queue)](https://github.com/sakurs2/tinyCoro/blob/master/LICENSE)![platform Linux x86_64](https://img.shields.io/badge/platform-Linux%20x86_64--bit-yellow)
-![Version Badge](https://img.shields.io/badge/version-v1%2E1-red)
+![Version Badge](https://img.shields.io/badge/version-v1%2E2-red)
 <!-- support below -->
 <!-- [![Build Status](link/actions/workflows/cmake.yml/badge.svg)](link/actions/workflows/cmake.yml) -->
 <!-- [![CI](https://github.com/jbaldwin/libcoro/actions/workflows/ci-coverage.yml/badge.svg)](https://github.com/jbaldwin/libcoro/actions/workflows/ci-coverage.yml)
@@ -197,6 +197,12 @@ $ tree -d -A -I third_party -I build -I .vscode -I resource -I temp
 
 这四个文件夹存储了[tinyCoroLab](https://github.com/sakurs2/tinyCoroLab)用于执行功能测试、内存安全测试、性能测试和实验辅助脚本的文件，具体使用方法后续会详细介绍。
 
+### CI流水线
+
+tinyCoroLab默认配置了一条基于ubuntu系统的CI流水线，主要执行编译构建以及各项测试的流程，具体文件可见[.github/workflows/ci-ubuntu.yml](https://github.com/sakurs2/tinyCoroLab/tree/master/.github/workflows/ci-ubuntu.yml)。
+
+该CI流水线强制执行编译构建过程，对于各项测试根据用户配置文件选择性执行，用户可编辑[scripts/CITests.yml](https://github.com/sakurs2/tinyCoroLab/tree/master/scripts/CITests.yml)来控制某项测试是否被执行。
+
 ### tinyCoroLab实验小技巧
 
 在了解[tinyCoroLab](https://github.com/sakurs2/tinyCoroLab)各个模块后，本节将会告诉大家如何正确的使用本实验精心构建并提供给实验者的各个技巧。注意本节提到的所有指令必须在构建目录下运行。

benchmark/tinycoro_model/tinycoro_128_bench.cpp

@@ -9,7 +9,7 @@ using namespace coro;
 task<> session(int fd)
 {
     char buf[BUFFLEN] = {0};
-    auto conn         = net::tcp_connector(fd);
+    auto conn         = io::net::tcp::tcp_connector(fd);
     int  ret          = 0;
 
     while ((ret = co_await conn.read(buf, BUFFLEN)) > 0)
@@ -26,7 +26,7 @@ task<> session(int fd)
 
 task<> server(int port)
 {
-    auto server = net::tcp_server(port);
+    auto server = io::net::tcp::tcp_server(port);
     log::info("server start in {}", port);
     int client_fd;
     while ((client_fd = co_await server.accept()) > 0)

benchmark/tinycoro_model/tinycoro_16k_bench.cpp

@@ -7,7 +7,7 @@ using namespace coro;
 task<> session(int fd)
 {
     char buf[BUFFLEN] = {0};
-    auto conn         = net::tcp_connector(fd);
+    auto conn         = io::net::tcp::tcp_connector(fd);
     int  ret          = 0;
 
     while ((ret = co_await conn.read(buf, BUFFLEN)) > 0)
@@ -25,7 +25,7 @@ task<> session(int fd)
 
 task<> server(int port)
 {
-    auto server = net::tcp_server(port);
+    auto server = io::net::tcp::tcp_server(port);
     log::info("server start in {}", port);
     int client_fd;
     while ((client_fd = co_await server.accept()) > 0)

benchmark/tinycoro_model/tinycoro_1k_bench.cpp

@@ -7,7 +7,7 @@ using namespace coro;
 task<> session(int fd)
 {
     char buf[BUFFLEN] = {0};
-    auto conn         = net::tcp_connector(fd);
+    auto conn         = io::net::tcp::tcp_connector(fd);
     int  ret          = 0;
 
     while ((ret = co_await conn.read(buf, BUFFLEN)) > 0)
@@ -25,7 +25,7 @@ task<> session(int fd)
 
 task<> server(int port)
 {
-    auto server = net::tcp_server(port);
+    auto server = io::net::tcp::tcp_server(port);
     log::info("server start in {}", port);
     int client_fd;
     while ((client_fd = co_await server.accept()) > 0)

config/config.h.in

@@ -20,6 +20,8 @@
 
 #include "stddef.h"
 #include "stdint.h"
+#include "time.h"
+#include <limits>
 
 #include "coro/detail/types.hpp"
 
@@ -53,6 +55,13 @@ constexpr int64_t kFlushDura = 3; // seconds
 // use alignas(config::kCacheLineSize) to reduce cache invalidation
 constexpr size_t kCacheLineSize = 64;
 
+// ====================== memory allocator configuration ====================
+// only ENABLE_MEMORY_ALLOC is defined, the memory allocator strategy will be enabled
+#define ENABLE_MEMORY_ALLOC
+
+// memory allocator is used to allocate memory for coroutine
+constexpr coro::detail::memory_allocator kMemoryAllocator = coro::detail::memory_allocator::std_allocator;
+
 // ========================== uring configuration ===========================
 // io_uring queue length
 constexpr unsigned int kEntryLength = 10240;
@@ -86,6 +95,11 @@ constexpr size_t kQueCap = 16384;
 // scheduler dispacher strategy
 constexpr coro::detail::dispatch_strategy kDispatchStrategy = coro::detail::dispatch_strategy::round_robin;
 
+// If one thread submit task to another thread or itself which owns a full task queue,
+// the submit func will be blocked, so execuate this task directly instead of submitting task,
+// but this will cause recursive call, so use this parameter to constrain the recursive depth
+constexpr size_t kMaxRecursiveDepth = 4096;
+
 /**
  * @warning kLongRunMode is deprecated
  *
@@ -104,10 +118,40 @@ constexpr coro::detail::dispatch_strategy kDispatchStrategy = coro::detail::disp
  */
 inline bool kLongRunMode = true;
 
-// =========================== net configuration ============================
+// =========================== tcp configuration ============================
 constexpr int kDefaultPort = 8000;
 constexpr int kBacklog     = 5;
 
+// ========================== http configuration ============================
+
+// server config
+// constexpr size_t kHttpRedirectMaxCount          = 20;
+// constexpr size_t kHttpKeepAliveMaxCount         = 100;
+// constexpr time_t kHttpKeepAliveTimeoutSecond    = 5;
+// constexpr time_t kHttpServerReadTimeoutSecond   = 5;
+// constexpr time_t kHttpServerReadTimeoutUSecond  = 0;
+// constexpr time_t kHttpServerWriteTimeoutSecond  = 5;
+// constexpr time_t kHttpServerWriteTimeoutUSecond = 0;
+// constexpr time_t kHttpIdleIntervalSecond        = 0;
+// constexpr time_t kHttpIdleIntervalUSecond       = 0;
+// constexpr time_t kHttpPayloadMaxLength          = ((std::numeric_limits<size_t>::max)());
+
+// // client config
+// constexpr time_t kHttpConnectionTimeoutSecond   = 300;
+// constexpr time_t kHttpConnectionTimeoutUSecond  = 0;
+// constexpr time_t kHttpClientReadTimeoutSecond   = 300;
+// constexpr time_t kHttpClientReadTimeoutUSecond  = 0;
+// constexpr time_t kHttpClientWriteTimeoutSecond  = 5;
+// constexpr time_t kHttpClientWriteTimeoutUSecond = 0;
+// constexpr time_t kHttpClientMaxTimeoutMSecond   = 0;
+
+// constexpr size_t kHttpHeaderMaxLength     = 8192;
+// constexpr size_t kHttpRequestUriMaxLength = 8192;
+// constexpr bool   kHttpTcpNodeLay          = false;
+// constexpr bool   kHttpIpv6Only            = false;
+// constexpr size_t kHttpRangeMaxCount       = 1024;
+// constexpr int    kHttpListenBacklog       = 5;
+
 // ========================== test configuration ============================
 /**
  * @brief kMaxTestTaskNum represents the maximum value in the test case

examples/parallel_calc.cpp

@@ -1,34 +1,39 @@
-#include <vector>
-
 #include "coro/coro.hpp"
 
 using namespace coro;
 
-#define TASK_NUM 5
-
-std::vector<int> vec{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15};
+task<int> square(int i)
+{
+    co_return i* i;
+}
 
-task<> calc(int id, int lef, int rig, std::vector<int>& v)
+task<> parallel_compute()
 {
-    int sum = 0;
-    for (int i = lef; i < rig; i++)
+    std::vector<task<int>> vec;
+    for (int i = 1; i <= 5; i++)
     {
-        sum += v[i];
+        vec.push_back(square(i));
     }
-    log::info("task {} calc result: {}", id, sum);
-    co_return;
+    auto answer = co_await parallel::parallel_func(
+        vec,
+        parallel::make_parallel_reduce_func(
+            [](std::vector<int>& vec)
+            {
+                int sum = 0;
+                for (auto it : vec)
+                {
+                    sum += it;
+                }
+                return sum;
+            }));
+    log::info("final answer: {}", answer);
 }
 
 int main(int argc, char const* argv[])
 {
     /* code */
     scheduler::init();
-
-    for (int i = 0; i < TASK_NUM; i++)
-    {
-        submit_to_scheduler(calc(i, i * 3, (i + 1) * 3, vec));
-    }
-
+    submit_to_scheduler(parallel_compute());
     scheduler::loop();
     return 0;
 }

examples/stdin_client.cpp

@@ -8,28 +8,34 @@ task<> echo(int sockfd)
 {
     char buf[BUFFLEN] = {0};
     int  ret          = 0;
-    auto conn         = net::tcp_connector(sockfd);
+    auto conn         = io::net::tcp::tcp_connector(sockfd);
 
     while (true)
     {
-        ret = co_await net::stdin_awaiter(buf, BUFFLEN, 0);
+        ret = co_await io::stdin_awaiter(buf, BUFFLEN, 0);
         log::info("receive data from stdin: {}", buf);
         ret = co_await conn.write(buf, ret);
     }
 }
 
 task<> client(const char* addr, int port)
 {
-    auto client = net::tcp_client(addr, port);
+    auto client = io::net::tcp::tcp_client(addr, port);
     int  ret    = 0;
     int  sockfd = 0;
     sockfd      = co_await client.connect();
     assert(sockfd > 0 && "connect error");
 
+    if (sockfd <= 0)
+    {
+        log::error("connect error");
+        co_return;
+    }
+
     submit_to_scheduler(echo(sockfd));
 
     char buf[BUFFLEN] = {0};
-    auto conn         = net::tcp_connector(sockfd);
+    auto conn         = io::net::tcp::tcp_connector(sockfd);
     while ((ret = co_await conn.read(buf, BUFFLEN)) > 0)
     {
         log::info("receive data from net: {}", buf);

examples/tcp_echo_client.cpp

@@ -7,15 +7,15 @@ using namespace coro;
 task<> client(const char* addr, int port)
 {
     log::info("client ready to start");
-    auto client = net::tcp_client(addr, port);
+    auto client = io::net::tcp::tcp_client(addr, port);
     int  ret    = 0;
     int  sockfd = 0;
     sockfd      = co_await client.connect();
     assert(sockfd > 0 && "connect error");
     log::info("connect success");
 
     char buf[BUFFLEN] = {0};
-    auto conn         = net::tcp_connector(sockfd);
+    auto conn         = io::net::tcp::tcp_connector(sockfd);
     while ((ret = co_await conn.read(buf, BUFFLEN)) > 0)
     {
         log::info("client {} receive data: {}", sockfd, buf);

examples/tcp_echo_server.cpp

@@ -7,7 +7,7 @@ using namespace coro;
 task<> session(int fd)
 {
     char buf[BUFFLEN] = {0};
-    auto conn         = net::tcp_connector(fd);
+    auto conn         = io::net::tcp::tcp_connector(fd);
     int  ret          = 0;
     while ((ret = co_await conn.read(buf, BUFFLEN)) > 0)
     {
@@ -23,7 +23,7 @@ task<> session(int fd)
 task<> server(int port)
 {
     log::info("server start in {}", port);
-    auto server = net::tcp_server(port);
+    auto server = io::net::tcp::tcp_server(port);
     int  client_fd;
     while ((client_fd = co_await server.accept()) > 0)
     {