Choir

Crates.io Docs.rs Build Status MSRV codecov.io

Choir is a task orchestration framework. It helps you to organize all the CPU workflow in terms of tasks.

Example:

rust let choir = choir::Choir::new(); let _worker = choir.add_worker("worker"); let task1 = choir.run_task(|| { println!("foo"); }); let task2 = choir.idle_task(|| { println!("bar"); }); task2.depend_on(&task1); task2.run();

Selling Pitch

What makes Choir elegant? Generally when we need to encode the semantics of "wait for dependencies", we think of some sort of a counter. Maybe an atomic, for the dependency number. When it reaches zero (or one), we schedule a task for execution. In Choir, the internal data for a task (i.e. the functor itself!) is placed in an Arc. Whenever we are able to extract it from the Arc (which means there are no other dependencies), we move it to a scheduling queue. I think Rust type system shows its best here.

You can add or remove workers at any time to balance the system load that may be running other applications at the same time.

API

General workflow is about creating tasks and setting up dependencies between them. If a task doesn't have any dependencies, it can be created and ran with choir.run_task(). Otherwise, it should be created as choir.idle_task() and then scheduled for execution by idle_task.run().

Simple tasks are executed once and represented as FnOnce(). In addition, Choir supports multi-tasks, which execute the selected number of times. They are represented as Fn(SubIndex), and can be created as idle_multi_task/run_multi_task. Note that multi-tasks are going to be pre-empted by other tasks naturally due to the implementation.

TODO:

Rough numbers

Machine: MBP 2016, 3.3 GHz Dual-Core Intel Core i7

Executing 100k empty tasks: - individually: 28ms - as a multi-task: 6ms