README_ZH.md

open-coroutine

open-coroutine是一个简单、高效、通用的有栈协程库。

English | 中文

🚀 当前特性

• 抢占调度(不支持windows): 即使协程进入死循环，它仍能被抢占，查看例子;
• Hook: 您可以在协程中自由使用大多数慢系统调用;
• 可伸缩栈: 协程栈的大小支持无限制扩容而没有复制堆栈的开销，查看例子;
• io_uring(只支持linux): 在本地文件IO和网络IO方面支持并兼容io_uring。如果您的系统不支持，它将回退到NIO;
• 优先级: 支持自定义任务和协程的优先级;
• 任务窃取: 内部使用无锁任务窃取队列;
• 兼容性: open-coroutine的实现是No async的，但它与async兼容，这意味着您可以在tokio/sync-std/smol/...中使用这个crate;
• 跨平台: 支持Linux、macOS和Windows;

🕊 未来计划

• 支持#[open_coroutine::all_join]和#[open_coroutine::any_join]宏;
• 增加并发工具包;
• 支持AF_XDP套接字;

📖 快速接入

step1: 在你的Cargo.toml中添加依赖

[dependencies]
# check https://crates.io/crates/open-coroutine
open-coroutine = "x.y.z"

step2: 添加宏

#[open_coroutine::main]
fn main() {
    //......
}

step3: 创建任务

#[open_coroutine::main]
fn main() {
    let task = open_coroutine::task!(|param| {
        assert_eq!(param, 1);
    }, 1);
    task.timeout_join(std::time::Duration::from_secs(1)).expect("timeout");
}

step4: 扩容栈(可选)

#[open_coroutine::main]
fn main() {
    _ = open_coroutine::task!(|_| {
        fn recurse(i: u32, p: &mut [u8; 10240]) {
            open_coroutine::maybe_grow!(|| {
                // Ensure the stack allocation isn't optimized away.
                unsafe { _ = std::ptr::read_volatile(&p) };
                if i > 0 {
                    recurse(i - 1, &mut [0; 10240]);
                }
            })
            .expect("allocate stack failed")
        }
        println!("[task] launched");
        // Use ~500KB of stack.
        recurse(50, &mut [0; 10240]);
    }, ());
}

⚓ 学习更多

我有故事,你有酒吗?