The goal of this project is to create an alternative codegen backend for the rust compiler based on Cranelift. This has the potential to improve compilation times in debug mode. If your project doesn’t use any of the things listed under “Not yet supported”, it should work fine. If not please open an issue.
$ git clone https://github.com/bjorn3/rustc_codegen_cranelift $ cd rustc_codegen_cranelift $ ./y.sh prepare $ ./y.sh build
To run the test suite replace the last command with:
For more docs on how to build and test see build_system/usage.txt or the help
Alternatively you can download a pre built version from the releases
page. Extract the
dist directory in the archive anywhere
you want. If you want to use
cargo clif build instead of
having to specify the full path to the
executable, you can add the
bin subdirectory of the
dist directory to your
Windows, and for
rustc_codegen_cranelift can be used as a near-drop-in replacement for
cargo build or
cargo run for existing
$cg_clif_dir is the directory you cloned this
repo into and you followed the instructions (
y.sh build or
In the directory with your project (where you can do the usual
cargo build), run:
$ $cg_clif_dir/dist/cargo-clif build
This will build your project with rustc_codegen_cranelift instead of the usual LLVM backend.
For additional ways to use rustc_codegen_cranelift like the JIT mode see usage.md.
This is useful when changing code in
rustc_codegen_cranelift as part of changing main Rust repository. This
can happen, for example, when you are implementing a new compiler
Instruction below uses
$RustCheckoutDir as substitute
for any folder where you cloned Rust repository.
You need to do this steps to successfully compile and use the cranelift backend with your changes in rustc code:
python x.py setupand choose option for compiler (
python x.py build --stage=2 compiler library/std src/tools/rustdoc src/tools/rustfmt
src/tools/cargoto previous command.
./build/host/stage2-tools/<your hostname triple>/releaseto
./build/host/stage2/bin/. Note that you would need to do this every time you rebuilt
cp $(rustup which cargo) .build/<your hostname triple>/stage2/bin/cargo
rustup toolchain link stage2 ./build/host/stage2/.
rustc +stage2 -O y.rs.
yif you built
y.rs) command by
rustup run stage2to make cg_clif use your local changes in rustc.
rustup run stage2 ./y.rs prepare
rustup run stage2 ./y.rs build
rustup run stage2 ./y.rs test
$RustCheckoutDir/compiler/rustc_codegen_cranelift/dist/cargo-clif build --release.
See the documentation on the
BackendConfig struct in config.rs for all configuration options.
std::archis partially supported)
-Cpanic=abortis enabled by default)
Licensed under either of
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above, without any additional terms or conditions.