Go to file
bjorn3 8794d07081 Avoid trailing / in git path for Wasmtime
Git seems to not be able to handle it in some cases. Thanks to @vramana
for reporting this on Zulip.
2021-05-07 12:58:54 +02:00
.github/workflows Upload artifacts for cross compiling to MinGW 2021-04-16 14:39:46 +02:00
.vscode Enable and disable some rust-analyzer diagnostics 2021-04-14 14:20:42 +02:00
build_sysroot Add missing change 2021-05-04 14:01:22 +02:00
crate_patches Rustup to rustc 1.53.0-nightly (132b4e5d1 2021-04-13) 2021-04-16 11:59:20 +02:00
docs Centralize all configuration into config.rs 2021-04-07 11:52:11 +02:00
example Fix test 2021-04-18 10:32:38 +02:00
patches Rustup to rustc 1.52.0-nightly (45b3c2851 2021-03-04) 2021-03-05 10:58:30 +01:00
scripts Force deprecation warning that was promoted to an error back to a warning 2021-05-04 14:16:59 +02:00
src Update Cranelift 2021-05-04 18:54:22 +02:00
.cirrus.yml Test FreeBSD on Cirrus CI 2021-02-14 18:13:06 +01:00
.gitattributes Set diff=rust git attribute for rust files 2020-11-08 16:36:52 +01:00
.gitignore Add missing dir to .gitignore 2021-01-30 18:27:28 +01:00
Cargo.lock Avoid trailing / in git path for Wasmtime 2021-05-07 12:58:54 +02:00
Cargo.toml Avoid trailing / in git path for Wasmtime 2021-05-07 12:58:54 +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 Centralize all configuration into config.rs 2021-04-07 11:52:11 +02:00
build.sh Build all tests when cross-compiling 2021-03-05 21:32:49 +01:00
clean_all.sh Use #!/usr/bin/env bash 2021-02-14 18:12:51 +01:00
prepare.sh Use the new component dependency option of the rust-toolchain file (take 2) 2021-03-07 17:47:56 +01:00
rust-toolchain Rustup to rustc 1.54.0-nightly (716394d65 2021-05-03) 2021-05-04 13:55:04 +02:00
rustfmt.toml Rustfmt 2021-03-05 11:21:44 +01:00
test.sh Use #!/usr/bin/env bash 2021-02-14 18:12:51 +01:00

Readme.md

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
$ ./prepare.sh # download and patch sysroot src and install hyperfine for benchmarking
$ ./build.sh

To run the test suite replace the last command with:

$ ./test.sh

This will implicitly build cg_clif too. Both build.sh 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 (prepare.sh and build.sh or test.sh).

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

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