Marl
Marl is a hybrid thread / fiber task scheduler written in C++ 11.
About
Marl is a C++ 11 library that provides a fluent interface for running tasks across a number of threads.
Marl uses a combination of fibers and threads to allow efficient execution of tasks that can block, while keeping a fixed number of hardware threads.
Marl supports Windows, macOS, Linux, FreeBSD, Fuchsia, Android and iOS (arm, aarch64, mips64, ppc64, x86 and x64).
Marl has no dependencies on other libraries (with an exception on googletest for building the optional unit tests).
Example:
#include "marl/defer.h"
#include "marl/event.h"
#include "marl/scheduler.h"
#include "marl/waitgroup.h"
#include <cstdio>
int main() {
// Create a marl scheduler using all the logical processors available to the process.
// Bind this scheduler to the main thread so we can call marl::schedule()
marl::Scheduler scheduler(marl::Scheduler::Config::allCores());
scheduler.bind();
defer(scheduler.unbind()); // Automatically unbind before returning.
constexpr int numTasks = 10;
// Create an event that is manually reset.
marl::Event sayHello(marl::Event::Mode::Manual);
// Create a WaitGroup with an initial count of numTasks.
marl::WaitGroup saidHello(numTasks);
// Schedule some tasks to run asynchronously.
for (int i = 0; i < numTasks; i++) {
// Each task will run on one of the 4 worker threads.
marl::schedule([=] { // All marl primitives are capture-by-value.
// Decrement the WaitGroup counter when the task has finished.
defer(saidHello.done());
printf("Task %d waiting to say hello...\n", i);
// Blocking in a task?
// The scheduler will find something else for this thread to do.
sayHello.wait();
printf("Hello from task %d!\n", i);
});
}
sayHello.signal(); // Unblock all the tasks.
saidHello.wait(); // Wait for all tasks to complete.
printf("All tasks said hello.\n");
// All tasks are guaranteed to complete before the scheduler is destructed.
}
Benchmarks
Graphs of several microbenchmarks can be found here.
Building
Marl contains many unit tests and examples that can be built using CMake.
Unit tests require fetching the googletest external project, which can be done by typing the following in your terminal:
cd <path-to-marl>
git submodule update --init
Linux and macOS
To build the unit tests and examples, type the following in your terminal:
cd <path-to-marl>
mkdir build
cd build
cmake .. -DMARL_BUILD_EXAMPLES=1 -DMARL_BUILD_TESTS=1
make
The resulting binaries will be found in <path-to-marl>/build
Windows
Marl can be built using Visual Studio 2019's CMake integration.
Using Marl in your CMake project
You can build and link Marl using add_subdirectory() in your project's CMakeLists.txt file:
set(MARL_DIR <path-to-marl>) # example <path-to-marl>: "${CMAKE_CURRENT_SOURCE_DIR}/third_party/marl"
add_subdirectory(${MARL_DIR})
This will define the marl library target, which you can pass to target_link_libraries():
target_link_libraries(<target> marl) # replace <target> with the name of your project's target
You may also wish to specify your own paths to the third party libraries used by marl. You can do this by setting any of the following variables before the call to add_subdirectory():
set(MARL_THIRD_PARTY_DIR <third-party-root-directory>) # defaults to ${MARL_DIR}/third_party
set(MARL_GOOGLETEST_DIR <path-to-googletest>) # defaults to ${MARL_THIRD_PARTY_DIR}/googletest
add_subdirectory(${MARL_DIR})
Usage Recommendations
Capture marl synchronization primitves by value
All marl synchronization primitves aside from marl::ConditionVariable should be lambda-captured by value:
marl::Event event;
marl::schedule([=]{ // [=] Good, [&] Bad.
event.signal();
})
Internally, these primitives hold a shared pointer to the primitive state. By capturing by value we avoid common issues where the primitive may be destructed before the last reference is used.
Create one instance of marl::Scheduler, use it for the lifetime of the process
The marl::Scheduler constructor can be expensive as it may spawn a number of hardware threads.
Destructing the marl::Scheduler requires waiting on all tasks to complete.
Multiple marl::Schedulers may fight each other for hardware thread utilization.
For these reasons, it is recommended to create a single marl::Scheduler for the lifetime of your process.
For example:
int main() {
marl::Scheduler scheduler(marl::Scheduler::Config::allCores());
scheduler.bind();
defer(scheduler.unbind());
return do_program_stuff();
}
Bind the scheduler to externally created threads
In order to call marl::schedule() the scheduler must be bound to the calling thread. Failure to bind the scheduler to the thread before calling marl::schedule() will result in undefined behavior.
marl::Scheduler may be simultaneously bound to any number of threads, and the scheduler can be retrieved from a bound thread with marl::Scheduler::get().
A typical way to pass the scheduler from one thread to another would be:
std::thread spawn_new_thread() {
// Grab the scheduler from the currently running thread.
marl::Scheduler* scheduler = marl::Scheduler::get();
// Spawn the new thread.
return std::thread([=] {
// Bind the scheduler to the new thread.
scheduler->bind();
defer(scheduler->unbind());
// You can now safely call `marl::schedule()`
run_thread_logic();
});
}
Always remember to unbind the scheduler before terminating the thread. Forgetting to unbind will result in the marl::Scheduler destructor blocking indefinitely.
Don't use externally blocking calls in marl tasks
The marl::Scheduler internally holds a number of worker threads which will execute the scheduled tasks. If a marl task becomes blocked on a marl synchronization primitive, marl can yield from the blocked task and continue execution of other scheduled tasks.
Calling a non-marl blocking function on a marl worker thread will prevent that worker thread from being able to switch to execute other tasks until the blocking function has returned. Examples of these non-marl blocking functions include: std::mutex::lock(), std::condition_variable::wait(), accept().
Short blocking calls are acceptable, such as a mutex lock to access a data structure. However be careful that you do not use a marl blocking call with a std::mutex lock held - the marl task may yield with the lock held, and block other tasks from re-locking the mutex. This sort of situation may end up with a deadlock.
If you need to make a blocking call from a marl worker thread, you may wish to use marl::blocking_call(), which will spawn a new thread for performing the call, allowing the marl worker to continue processing other scheduled tasks.
Note: This is not an officially supported Google product
Would it be more efficient to queue up all of these using tickets (so Bn waits for A, C waits for Bn (waitgroup, etc), etc) ahead of time or better instead to have each queue up the following ones (so A only, then A runs and enqueues Bn, etc)?
![[Question] Fiber yield behavior](https://avatars.githubusercontent.com/u/9445488?v=4)
12 Jun 4, 2022
1.4k Dec 27, 2022
796 Dec 30, 2022
80 Dec 21, 2022
35 Jan 9, 2022
390 Dec 20, 2022
77 Dec 30, 2022
655 Dec 27, 2022
542 Dec 17, 2022
10 Sep 7, 2022
47 Nov 25, 2022
129 Dec 31, 2022
81 Dec 30, 2022
232 Dec 21, 2022
7.6k Dec 31, 2022
424 Jan 3, 2023
592 Dec 19, 2022
31 Dec 7, 2022