2019-09-20 15:54:23 +08:00
# WIP Cranelift codegen backend for rust
2018-07-18 17:55:32 +08:00
2020-03-12 18:20:36 +08:00
> ⚠⚠⚠ Certain kinds of FFI don't work yet. ⚠⚠⚠
2018-07-18 17:55:32 +08:00
2020-09-23 22:44:02 +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/master/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.
2020-06-26 00:01:55 +08:00
2018-07-18 17:55:32 +08:00
## Building
```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-01-15 18:53:24 +08:00
$ ./test.sh --release
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.
Assuming `$cg_clif_dir` is the directory you cloned this repo into and you followed the instructions (`prepare.sh` and `test.sh` ).
2019-01-27 00:03:35 +08:00
2019-09-13 02:27:10 +08:00
### Cargo
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
2020-07-24 20:21:31 +08:00
$ $cg_clif_dir/cargo.sh run
2018-07-18 17:55:32 +08:00
```
2020-06-25 23:59:46 +08:00
This should build and run your project with rustc_codegen_cranelift instead of the usual LLVM backend.
2020-07-24 20:21:31 +08:00
If you compiled cg_clif in debug mode (aka you didn't pass `--release` to `./test.sh` ) you should set `CHANNEL="debug"` .
2020-01-15 18:53:24 +08:00
2019-09-13 02:27:10 +08:00
### Rustc
2018-07-18 19:35:03 +08:00
2020-04-08 18:32:00 +08:00
> You should prefer using the Cargo method.
2018-07-18 19:35:03 +08:00
```bash
2020-09-30 00:41:59 +08:00
$ $cg_clif_dir/target/release/cg_clif my_crate.rs
```
### Jit mode
In jit mode cg_clif will immediately execute your code without creating an executable file.
2020-09-30 01:50:03 +08:00
> This requires all dependencies to be available as dynamic library.
> The jit mode will probably need cargo integration to make this possible.
2020-09-30 00:41:59 +08:00
```bash
$ $cg_clif_dir/cargo.sh jit
```
or
```bash
$ $cg_clif_dir/target/release/cg_clif --jit my_crate.rs
2018-07-18 19:35:03 +08:00
```
2020-05-05 18:06:15 +08:00
### Shell
These are a few functions that allow you to easily run rust code from the shell using cg_clif as jit.
```bash
function jit_naked() {
2020-09-30 00:41:59 +08:00
echo "$@" | $cg_clif_dir/target/release/cg_clif - --jit
2020-05-05 18:06:15 +08:00
}
function jit() {
jit_naked "fn main() { $@ }"
}
function jit_calc() {
jit 'println!("0x{:x}", ' $@ ');';
}
```
2020-03-12 18:17:19 +08:00
## Env vars
2020-09-23 22:44:02 +08:00
[see env_vars.md ](docs/env_vars.md )
2019-09-13 02:27:10 +08:00
2018-07-18 17:55:32 +08:00
## Not yet supported
2019-09-13 02:27:10 +08:00
* Good non-rust abi support ([several problems](https://github.com/bjorn3/rustc_codegen_cranelift/issues/10))
2020-07-10 20:45:45 +08:00
* Inline assembly ([no cranelift support](https://github.com/bytecodealliance/wasmtime/issues/1041)
* 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)
