2019-09-20 02:54:23 -05:00
# WIP Cranelift codegen backend for rust
2018-07-18 04:55:32 -05:00
2019-09-20 02:54:23 -05:00
> ⚠⚠⚠ Threads and certain kinds of FFI don't work yet. ⚠⚠⚠
2018-07-18 04:55:32 -05:00
## Building
```bash
2018-07-18 06:35:03 -05:00
$ git clone https://github.com/bjorn3/rustc_codegen_cranelift.git
2018-07-18 04:55:32 -05:00
$ cd rustc_codegen_cranelift
2019-04-14 03:49:07 -05:00
$ ./prepare.sh # download and patch sysroot src and install hyperfine for benchmarking
2020-01-15 04:53:24 -06:00
$ ./test.sh --release
2018-07-18 04:55:32 -05:00
```
## Usage
2019-01-26 10:03:35 -06:00
`$cg_clif_dir` is the directory you cloned this repo into in the following instruction.
2019-09-12 13:27:10 -05:00
### Cargo
2019-01-26 10:03:35 -06:00
2018-07-18 04:55:32 -05:00
```bash
2020-01-15 04:53:24 -06:00
$ CHANNEL="release" $cg_clif_dir/cargo.sh run
2018-07-18 04:55:32 -05:00
```
2020-01-15 04:53:24 -06:00
If you compiled cg_clif in debug mode you should use `CHANNEL="debug"` instead or omit `CHANNEL="release"` completely.
2019-09-12 13:27:10 -05:00
### Rustc
2018-07-18 06:35:03 -05:00
```bash
2020-01-15 04:53:24 -06:00
$ rustc -Cpanic=abort -Zcodegen-backend=$cg_clif_dir/target/release/librustc_codegen_cranelift.so --sysroot $cg_clif_dir/build_sysroot/sysroot my_crate.rs
2018-07-18 06:35:03 -05:00
```
2019-09-12 13:27:10 -05:00
2018-07-18 04:55:32 -05:00
## Not yet supported
2019-09-12 13:27:10 -05:00
* Good non-rust abi support ([several problems](https://github.com/bjorn3/rustc_codegen_cranelift/issues/10))
2018-11-16 10:05:59 -06:00
* Checked binops ([some missing instructions in cranelift](https://github.com/CraneStation/cranelift/issues/460))
2019-09-12 13:27:10 -05:00
* Inline assembly ([no cranelift support](https://github.com/CraneStation/cranelift/issues/444), not coming soon)
2019-07-30 07:51:05 -05:00
* SIMD ([tracked here](https://github.com/bjorn3/rustc_codegen_cranelift/issues/171), some basic things work)
2018-11-17 05:24:35 -06:00
## Troubleshooting
### Can't compile
Try updating your nightly compiler. You can try to use an nightly a day or two older if updating rustc doesn't fix it. If you still can't compile it, please fill an issue.
