Go to file
bjorn3 eed1f75415 Don't store vector types in ssa variables
They have been causing a lot of trouble. For example current MIR
building thinks that it is fine to dynamically index into them. And
there are different paths depending on if the repr(simd) struct uses
fields or a single array as interior. There is also trouble with moving
the inner array of a repr(simd) type that is an array wrapper.

If performance becomes a concern, I will implement this in a more
principled way.
2023-03-25 14:30:12 +00:00
.github/workflows Format all tests in example/ 2023-03-18 14:27:50 +00:00
.vscode Enable VSCode formatOnSave 2023-01-13 16:13:26 +00:00
build_sysroot Rustup to rustc 1.70.0-nightly (1459b3128 2023-03-23) 2023-03-24 08:38:14 +00:00
build_system Update regex to fix FreeBSD tests 2023-03-21 14:52:03 +00:00
docs Rename the build/ directory to dist/ 2022-11-28 13:01:49 +00:00
example Format all tests in example/ 2023-03-18 14:27:50 +00:00
patches Update test repo versions 2023-02-26 14:34:28 +00:00
scripts Don't store vector types in ssa variables 2023-03-25 14:30:12 +00:00
src Don't store vector types in ssa variables 2023-03-25 14:30:12 +00:00
.cirrus.yml Update FreeBSD to 13.1 2023-01-13 18:36:22 +00:00
.gitattributes Set diff=rust git attribute for rust files 2020-11-08 16:36:52 +01:00
.gitignore Use patched git-subtree from bjorn3/git@tqc-subtree-portable 2023-03-15 14:20:18 +00:00
Cargo.lock Update to Cranelift 0.94 2023-03-21 10:23:42 +00:00
Cargo.toml Update to Cranelift 0.94 2023-03-21 10:23:42 +00:00
clean_all.sh Remove debuginfo files for compiled y.rs in clean_all.sh 2023-01-05 18:14:55 +00:00
config.txt Don't download abi-cafe and simple-raytracer in ./y.rs prepare 2023-01-27 18:44:19 +00:00
LICENSE-APACHE
LICENSE-MIT
Readme.md Improve readme and build system help message 2023-01-13 16:34:43 +00:00
rust-toolchain Rustup to rustc 1.70.0-nightly (1459b3128 2023-03-23) 2023-03-24 08:38:14 +00:00
rustfmt.toml Ignore rustfmt for y.rs 2022-10-28 13:21:27 +00:00
test.sh Allow specifying where build artifacts should be written to 2022-12-01 19:00:32 +00:00
y.rs Set panic=abort for the build system 2023-01-13 16:13:26 +00: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
$ cd rustc_codegen_cranelift
$ ./y.rs prepare
$ ./y.rs build

To run the test suite replace the last command with:

$ ./test.sh

For more docs on how to build and test see build_system/usage.txt or the help message of ./y.rs.

Alternatively you can download a pre built version from Github Actions. 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/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.

Configuration

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

Not yet supported

  • Inline assembly (no cranelift support)
    • On UNIX there is support for invoking an external assembler for global_asm! and asm!.
  • SIMD (tracked here, std::simd fully works, std::arch is partially supported)
  • Unwinding on panics (no cranelift support, -Cpanic=abort is enabled by default)

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.