2021-01-31 02:38:57 +08:00
# Cranelift codegen backend for rust
2018-07-18 17:55:32 +08:00
2020-12-13 17:58:47 +08:00
The goal of this project is to create an alternative codegen backend for the rust compiler based on [Cranelift ](https://github.com/bytecodealliance/wasmtime/blob/main/cranelift ).
2020-11-03 01:16:57 +08:00
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.
2020-06-26 00:01:55 +08:00
2020-11-02 02:51:35 +08:00
## Building and testing
2018-07-18 17:55:32 +08:00
```bash
2018-07-18 19:35:03 +08:00
$ git clone https://github.com/bjorn3/rustc_codegen_cranelift.git
2018-07-18 17:55:32 +08:00
$ cd rustc_codegen_cranelift
2019-04-14 16:49:07 +08:00
$ ./prepare.sh # download and patch sysroot src and install hyperfine for benchmarking
2020-11-03 01:16:57 +08:00
$ ./build.sh
2018-07-18 17:55:32 +08:00
```
2020-11-03 01:16:57 +08:00
To run the test suite replace the last command with:
2020-11-02 02:51:35 +08:00
```bash
2020-11-03 01:16:57 +08:00
$ ./test.sh
2020-11-02 02:51:35 +08:00
```
2020-11-03 01:16:57 +08:00
This will implicitly build cg_clif too. Both `build.sh` and `test.sh` accept a `--debug` argument to
build in debug mode.
2020-11-03 01:24:21 +08:00
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.
[GHA]: https://github.com/bjorn3/rustc_codegen_cranelift/actions?query=branch%3Amaster+event%3Apush+is%3Asuccess
2018-07-18 17:55:32 +08:00
## Usage
2020-06-25 23:59:46 +08:00
rustc_codegen_cranelift can be used as a near-drop-in replacement for `cargo build` or `cargo run` for existing projects.
2020-11-03 01:16:57 +08:00
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` ).
2019-01-27 00:03:35 +08:00
2020-06-25 23:59:46 +08:00
In the directory with your project (where you can do the usual `cargo build` ), run:
2018-07-18 17:55:32 +08:00
```bash
2021-03-07 02:19:29 +08:00
$ $cg_clif_dir/build/cargo.sh build
2020-09-30 00:41:59 +08:00
```
2021-03-07 02:19:29 +08:00
This will build your project with rustc_codegen_cranelift instead of the usual LLVM backend.
2020-09-30 00:41:59 +08:00
2021-03-07 02:22:36 +08:00
For additional ways to use rustc_codegen_cranelift like the JIT mode see [usage.md ](docs/usage.md ).
2020-05-05 18:06:15 +08:00
2021-04-07 17:52:11 +08:00
## Configuration
2020-03-12 18:17:19 +08:00
2021-04-07 17:52:11 +08:00
See the documentation on the `BackendConfig` struct in [config.rs ](src/config.rs ) for all
configuration options.
2019-09-13 02:27:10 +08:00
2018-07-18 17:55:32 +08:00
## Not yet supported
2021-01-31 21:15:50 +08:00
* Inline assembly ([no cranelift support](https://github.com/bytecodealliance/wasmtime/issues/1041))
2020-07-10 20:45:45 +08:00
* 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.
2019-07-30 20:51:05 +08:00
* SIMD ([tracked here](https://github.com/bjorn3/rustc_codegen_cranelift/issues/171), some basic things work)
2021-03-07 02:26:11 +08:00
## License
Licensed under either of
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
http://opensource.org/licenses/MIT)
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.
