cogo
Cogo 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].
Initial code frok from May and we add Many improvements(Inspired by
Golang
and crossbeam) and hyper and more...
Performance
- platform(16CPU/32 thread AMD Ryzen 9 5950X,32GB mem,Os:Unbutu-20.04)
- TechEmpowerBench fork project
cogo crates
Cogo STD standard library
cogo/std/http/server
An HTTP server is available(Body parsing upcoming)cogo/std/http/client
An HTTP Client(TODO) upcomingcogo/std/queue
Basic queue data structurescogo/std/sync
IncludesMutex/RwLock/WaitGroup/Semphore/channel(Bounded, unbounded, chan!())
...and more..cogo/std/defer
Defers evaluation of a block of code until the end of the scope.
Crates based on cogo implementation
- cdbc Database Drivers include mysql, Postgres, AND SQLite
- fast_log High-performance log impl
- cogo-redis TODO: an redis client.
- cogo-grpc TODO: an grpc server/client.
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 Mac, aarch64 Linux OS are supported.
-
Support High performance channel(2 times better performance, Support the buffer);
-
Support WaitGroup Support
-
Support defer!()
Usage
A naive echo server implemented with Cogo:
extern crate cogo;
use TcpListener;
use ;
More examples
The I/O heavy bound examples
Caveat
There is a detailed [document][caveat] that describes Cogo'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:
set_tls; // Or another coroutine API that would cause scheduling: 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
.set_stack_size;//default is 4k=4*1024,Multiple of 4kb is recommended
config