This project hosts the high-level wrappers of the MCL rust bindings.
This crate provides high-level, rust-friendly bindings for MCL. The purpose of these bindings are to expose a user-friendlier (and safer) API to what the low-level libmcl-sys API offers. It provides wrappers for most mcl public functions and tries to provide safety at compilation type, however, because of the nature of the library counting on a C project there are cases that it's only possible to catch errors at runtime, as well as a few APIS that currently cannot be checked at all and are thus marked unsafe (but are protected by a feature flag).
cargo install mcl_sched)mcl-rs depends on the crate libmcl-sys which provides the low-level bindings between the C library of MCL and these higher bindings.
libmcl-sys makes use of clang to generate the low-level rust binding from the MCL header file, so if clang is not available it must be installed to the system.
Once all dependencies have been taken care of, we can build mcl-rs.
cargo build --releaseThe MCL scheduler can easily be installed via:
bash
cargo install mcl_sched
Note, if you have manually built MCL from the C source code, you will already have the mcl_sched binary in the MCL install directory.
You are free to use either your manually built mcl_sched or the one installed via cargo
We re expose three feauture flags (from libmcl-rs), losely corresponding to configuration options of the underlying MCL c-library 1. mcldebug - enables debug logging output from the underlying MCL c-libary 2. sharedmem - enables interprocess host shared memory buffers -- this enables a few unsafe APIs 3. pocl_extensions - enables interprocess device based shared memory buffers, requires a patched version of POCL 1.8 to have been succesfully installed (please see https://github.com/pnnl/mcl/tree/dev#using-custom-pocl-extensions for more information) -- this enables a few unsafe APIs
mcl-rs comes with a set of unit tests that can be executed with:
cargo test <test_name>
Reminder: The MCL scheduler should be running when executing the tests.
if you installed mclsched via cargo then you should be able to invoke directly:
bash
mcl_sched
If you built mcl manually you may need to specify the path to the mclsched binary
Removing the test-name would cause cargo to run all available tests, however, this could create issues since tests would run in parallel causing multiple threads to try to acquire access to the mcl_scheduler shmem object at the same time which might lead to failure.
Use cargo doc --open to build and open the documentation of this crate.
MCL, libmcl-sys, and mcl-rs are research prototypes and still under development, thus not all intended features are yet implemented.
Please, contact Roberto Gioiosa at PNNL (roberto.gioiosa@pnnl.gov) if you have any MCL questions. For Rust related questions please contact Ryan Friese at PNNL (ryan.friese@pnnl.gov)
Roberto Gioiosa
Ryan Friese
Polykarpos Thomadakis
This project is licensed under the BSD License - see the LICENSE file for details.
IF you wish to cite MCL, please, use the following reference:
Other work that leverage or describe additional MCL features: