Empowering everyone to build reliable and efficient software.
Go to file
2022-03-18 15:38:58 +01:00
.github/workflows Only deny warnings for cg_clif build itself 2021-12-30 12:40:23 +01:00
.vscode Enable unstable-features feature of cg_clif for rust-analyzer 2021-11-26 15:33:56 +01:00
build_sysroot Rustup to rustc 1.61.0-nightly (285fa7ecd 2022-03-14) 2022-03-15 11:21:42 +01:00
build_system Download tarballs from github instead of cloning full repos 2022-03-15 12:44:06 +01:00
docs Rename cargo executable to cargo-clif 2021-12-30 11:39:30 +01:00
example Trim down alloc_system.rs 2022-03-15 19:25:42 +01:00
patches Rustup to rustc 1.61.0-nightly (03918badd 2022-03-07) 2022-03-08 11:29:17 +01:00
scripts Run tests with warnings 2022-03-18 15:38:58 +01:00
src Fix and re-enable some rustc tests 2022-03-17 20:59:39 +01:00
.cirrus.yml Rewrite prepare.sh in rust 2021-06-19 13:54:25 +02:00
.gitattributes Set diff=rust git attribute for rust files 2020-11-08 16:36:52 +01:00
.gitignore Add y.bin.dSYM to .gitignore 2021-12-28 16:16:49 +01:00
Cargo.lock Remove almost all remaining feature gates 2022-03-13 17:55:55 +01:00
Cargo.toml Avoid once_cell unstable feature in cg_clif.rs 2022-03-15 19:25:33 +01:00
clean_all.sh Add y.bin to clean_all.sh 2022-01-10 12:26:23 +01:00
config.txt Refactor cg_clif building 2021-07-04 18:15:13 +02:00
LICENSE-APACHE Create LICENSE-APACHE 2018-06-22 19:33:35 +02:00
LICENSE-MIT Add LICENSE-MIT 2018-06-22 19:34:27 +02:00
Readme.md Rename cargo executable to cargo-clif 2021-12-30 11:39:30 +01:00
rust-toolchain Rustup to rustc 1.61.0-nightly (285fa7ecd 2022-03-14) 2022-03-15 11:21:42 +01:00
rustfmt.toml Rustfmt 2021-03-05 11:21:44 +01:00
test.sh Rewrite build.sh in rust 2021-06-19 13:54:25 +02:00
y.rs Slightly speed up building of y.rs 2022-03-16 19:21:24 +01:00

Cranelift codegen backend for rust

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.

Building and testing

$ git clone https://github.com/bjorn3/rustc_codegen_cranelift.git
$ cd rustc_codegen_cranelift
$ ./y.rs prepare # download and patch sysroot src and install hyperfine for benchmarking
$ ./y.rs build

To run the test suite replace the last command with:

$ ./test.sh

This will implicitly build cg_clif too. Both y.rs build and test.sh accept a --debug argument to build in debug mode.

Alternatively you can download a pre built version from GHA. It is listed in the artifacts section of workflow runs. Unfortunately due to GHA restrictions you need to be logged in to access it.

Usage

rustc_codegen_cranelift can be used as a near-drop-in replacement for cargo build or cargo run for existing projects.

Assuming $cg_clif_dir is the directory you cloned this repo into and you followed the instructions (y.rs prepare and y.rs build or test.sh).

In the directory with your project (where you can do the usual cargo build), run:

$ $cg_clif_dir/build/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.

Configuration

See the documentation on the BackendConfig struct in config.rs for all configuration options.

Not yet supported

  • Inline assembly (no cranelift support)
    • On Linux there is support for invoking an external assembler for global_asm! and asm!. llvm_asm! will remain unimplemented forever. asm! doesn't yet support reg classes. You have to specify specific registers instead.
  • SIMD (tracked here, some basic things work)

License

Licensed under either of

at your option.

Contribution

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.