base on rust stackful coroutine library <div align="center"> <h1>May</h1> <a href="https://github.com/Xudong-Huang/may/actions?query=workflow%3ACI+branch%3Amaster"> <img src="https://github.com/Xudong-Huang/may/workflows/CI/badge.svg"> </a> <a href="https://crates.io/crates/may"> <img src="https://img.shields.io/crates/v/may.svg"> </a> <a href="https://docs.rs/may"> <img src="https://img.shields.io/badge/doc-may-green.svg"> </a> May is a high-performance library for programming stackful coroutines with which you can easily develop and maintain massive concurrent programs. It can be thought as the Rust version of the popular [Goroutine][go]. </div> ---------- ## Table of contents * [Features](#features) * [Usage](#usage) * [More examples](#more-examples) * [The CPU heavy load examples](#the-cpu-heavy-load-examples) * [The I/O heavy bound examples](#the-io-heavy-bound-examples) * [Performance](#performance) * [Caveat](#caveat) * [How to tune a stack size](#how-to-tune-a-stack-size) * [License](#license) ---------- ## Features * The stackful coroutine implementation is based on [generator][generator]; * Support schedule on a configurable number of threads for multi-core systems; * Support coroutine version of a local storage ([CLS][cls]); * Support efficient asynchronous network I/O; * Support efficient timer management; * Support standard synchronization primitives, a semaphore, an MPMC channel, etc; * Support cancellation of coroutines; * Support graceful panic handling that will not affect other coroutines; * Support scoped coroutine creation; * Support general selection for all the coroutine API; * All the coroutine API are compatible with the standard library semantics; * All the coroutine API can be safely called in multi-threaded context; * Both stable, beta, and nightly channels are supported; * x86_64 GNU/Linux, x86_64 Windows, x86_64 macOS, AArch64 GNU/Linux, and AArch64 macOS are supported. ---------- ## Usage A naive echo server implemented with May: ```rust #[macro_use] extern crate may; use may::net::TcpListener; use std::io::{Read, Write}; fn main() { let listener = TcpListener::bind("127.0.0.1:8000").unwrap(); while let Ok((mut stream, _)) = listener.accept() { go!(move || { let mut buf = vec![0; 1024 * 16]; // alloc in heap! while let Ok(n) = stream.read(&mut buf) { if n == 0 { break; } stream.write_all(&buf[0..n]).unwrap(); } }); } } ``` ---------- ## More examples ### The CPU heavy load examples * [The "Quick Sort" algorithm][sort] * [A prime number generator][prime] ### The I/O heavy bound examples * [An echo server][echo_server] * [An echo client][echo_client] * [A simple HTTP][http_sever] * [A simple HTTPS][https_sever] * [WebSockets][websocket] ---------- ## Performance You can refer to https://tfb-status.techempower.com/ to get the latest [may_minihttp][may_minihttp] comparisons with other most popular frameworks. ---------- ## Caveat There is a detailed [document][caveat] that describes May's main restrictions. In general, there are four things you should follow when writing programs that use coroutines: * Don't call thread-blocking API (It will hurt the performance); * Carefully use Thread Local Storage (access TLS in coroutine might trigger undefined behavior). > It's considered **unsafe** with the following pattern: > ```rust > set_tls(); > // Or another coroutine API that would cause scheduling: > coroutine::yield_now(); > use_tls(); > ``` > but it's **safe** if your code is not sensitive about the previous state of TLS. Or there is no coroutines scheduling between **set** TLS and **use** TLS. * Don't run CPU bound tasks for long time, but it's ok if you don't care about fairness; * Don't exceed the coroutine stack. There is a guard page for each coroutine stack. When stack overflow occurs, it will trigger segment fault error. **Note:** > The first three rules are common when using cooperative asynchronous libraries in Rust. Even using a futures-based system also have these limitations. So what you should really focus on is a coroutine stack size, make sure it's big enough for your applications. ---------- ## How to tune a stack size If you want to tune your coroutine stack size, please check out [this document][stack]. ---------- ## License May is licensed under either of the following, at your option: * The Apache License v2.0.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0); * The MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT). <!-- refs --> [generator]:https://github.com/Xudong-Huang/generator-rs [sort]:https://github.com/Xudong-Huang/quick_sort [prime]:https://github.com/Xudong-Huang/prime [echo_server]:examples/echo.rs [echo_client]:examples/echo_client.rs [http_sever]:examples/http.rs [https_sever]:examples/https.rs [websocket]:examples/websocket.rs [cls]:docs/CLS_instead_of_TLS.md [go]:https://tour.golang.org/concurrency/1 [tokio]:https://github.com/tokio-rs/tokio/blob/master/examples/echo.rs [caveat]:docs/may_caveat.md [stack]:docs/tune_stack_size.md [may_minihttp]:https://github.com/Xudong-Huang/may_minihttp ", Assign "at most 3 tags" to the expected json: {"id":"10554","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"