Go to file
bjorn3 7762c7a75e
Fix schedule time
Run at 01:17 UTC instead of 17:01
2021-12-26 11:55:12 +01:00
.github/workflows Fix schedule time 2021-12-26 11:55:12 +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.59.0-nightly (c5ecc1570 2021-12-15) 2021-12-16 14:11:04 +01:00
build_system Rustup to rustc 1.59.0-nightly (c5ecc1570 2021-12-15) 2021-12-16 14:11:04 +01:00
docs Add warning to the jit mode section of the usage docs 2021-08-09 12:30:40 +02:00
example Fix taking address of truly unsized type field of unsized adt 2021-12-20 18:49:43 +01:00
patches Rustup to rustc 1.59.0-nightly (0fb1c371d 2021-12-06) 2021-12-07 18:22:44 +01:00
scripts Fix taking address of truly unsized type field of unsized adt 2021-12-20 18:49:43 +01:00
src Fix taking address of truly unsized type field of unsized adt 2021-12-20 18:49:43 +01:00
.cirrus.yml Rewrite prepare.sh in rust 2021-06-19 13:54:25 +02:00
.gitattributes
.gitignore Add portable-simd to .gitignore 2021-09-07 20:45:58 +02:00
Cargo.lock Revert "Update Cranelift to 0.79.0" 2021-12-17 23:23:17 +01:00
Cargo.toml Revert "Update Cranelift to 0.79.0" 2021-12-17 23:23:17 +01:00
clean_all.sh Update clean_all.sh for the rename of stdsimd to portable-simd 2021-09-01 17:21:50 +02:00
config.txt Refactor cg_clif building 2021-07-04 18:15:13 +02:00
LICENSE-APACHE
LICENSE-MIT
Readme.md Rewrite cargo.sh in rust 2021-06-20 12:56:47 +02:00
rust-toolchain Rustup to rustc 1.59.0-nightly (e95e084a1 2021-12-19) 2021-12-20 18:21:55 +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 Test on CI with unstable cg_clif features disabled 2021-12-03 13:16:34 +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 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.