2018-07-18 04:55:32 -05:00
# Work in progress cranelift codegen backend for rust
2018-10-10 12:12:41 -05:00
> ⚠⚠⚠ This doesn't do much useful 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
2018-11-16 10:05:59 -06:00
$ rustup override set nightly # This uses unstable api's which will never be stabilized
$ cargo install xargo # Used for building the sysroot
$ cargo install hyperfine # Used for benchmarking in build.sh
2018-07-18 04:55:32 -05:00
$ cargo build
```
## Usage
```bash
2018-11-16 10:05:59 -06:00
$ rustc -Zcodegen-backend=$(pwd)/target/debug/librustc_codegen_cranelift.so my_crate.rs
2018-07-18 04:55:32 -05:00
```
2018-11-16 10:05:59 -06:00
## Build sysroot and test
2018-07-18 06:35:03 -05:00
```bash
2018-11-17 05:24:35 -06:00
$ rustup component add rust-src # Make sure the sysroot source is available
2018-11-16 10:05:59 -06:00
$ ./prepare_libcore.sh # Patch the sysroot source for some not yet supported things
2018-07-18 06:35:03 -05:00
$ ./build.sh
```
2018-07-18 04:55:32 -05:00
## Not yet supported
2018-11-16 10:05:59 -06:00
* Good non-rust abi support ([non scalars are not yet supported for the "C" abi](https://github.com/bjorn3/rustc_codegen_cranelift/issues/10))
* Checked binops ([some missing instructions in cranelift](https://github.com/CraneStation/cranelift/issues/460))
* Inline assembly ([no cranelift support](https://github.com/CraneStation/cranelift/issues/444))
* Varargs ([no cranelift support](https://github.com/CraneStation/cranelift/issues/212))
* libstd (needs varargs and some other stuff) ([tracked here](https://github.com/bjorn3/rustc_codegen_cranelift/issues/146))
* u128 and i128 ([no cranelift support](https://github.com/CraneStation/cranelift/issues/354))
* SIMD (huge amount of work to get all intrinsics implemented, so may never be supported)
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.
### error[E0463]: can't find crate for `std` while compiling a no_std crate
If you use `RUSTFLAGS` to pass `-Zcodegen-backend` to rustc, cargo will compile `build-dependencies` with those flags too. Because this project doesn't support libstd yet, that will result in an error. I don't know of any way to fix this. :(
