-# WIP Cranelift codegen backend for rust
+# Cranelift codegen backend for rust
-> ⚠⚠⚠ Certain kinds of FFI don't work yet. ⚠⚠⚠
+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).
+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.
-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.
-
-## Building
+## Building and testing
```bash
$ git clone https://github.com/bjorn3/rustc_codegen_cranelift.git
$ cd rustc_codegen_cranelift
-$ ./prepare.sh # download and patch sysroot src and install hyperfine for benchmarking
-$ ./test.sh --release
+$ ./y.rs prepare # download and patch sysroot src and install hyperfine for benchmarking
+$ ./y.rs build
```
-## 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 (`prepare.sh` and `test.sh`).
-
-### Cargo
-
-In the directory with your project (where you can do the usual `cargo build`), run:
+To run the test suite replace the last command with:
```bash
-$ $cg_clif_dir/cargo.sh run
+$ ./test.sh
```
-This should build and run your project with rustc_codegen_cranelift instead of the usual LLVM backend.
-
-If you compiled cg_clif in debug mode (aka you didn't pass `--release` to `./test.sh`) you should set `CHANNEL="debug"`.
+This will implicitly build cg_clif too. Both `y.rs build` and `test.sh` accept a `--debug` argument to
+build in debug mode.
-### Rustc
+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.
-> You should prefer using the Cargo method.
+[GHA]: https://github.com/bjorn3/rustc_codegen_cranelift/actions?query=branch%3Amaster+event%3Apush+is%3Asuccess
-```bash
-$ $cg_clif_dir/target/release/cg_clif my_crate.rs
-```
+## Usage
-### Jit mode
+rustc_codegen_cranelift can be used as a near-drop-in replacement for `cargo build` or `cargo run` for existing projects.
-In jit mode cg_clif will immediately execute your code without creating an executable file.
+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`).
-> This requires all dependencies to be available as dynamic library.
-> The jit mode will probably need cargo integration to make this possible.
+In the directory with your project (where you can do the usual `cargo build`), run:
```bash
-$ $cg_clif_dir/cargo.sh jit
+$ $cg_clif_dir/build/cargo-clif build
```
-or
+This will build your project with rustc_codegen_cranelift instead of the usual LLVM backend.
-```bash
-$ $cg_clif_dir/target/release/cg_clif --jit my_crate.rs
-```
+For additional ways to use rustc_codegen_cranelift like the JIT mode see [usage.md](docs/usage.md).
-### Shell
+## Configuration
-These are a few functions that allow you to easily run rust code from the shell using cg_clif as jit.
+See the documentation on the `BackendConfig` struct in [config.rs](src/config.rs) for all
+configuration options.
-```bash
-function jit_naked() {
- echo "$@" | $cg_clif_dir/target/release/cg_clif - --jit
-}
+## Not yet supported
-function jit() {
- jit_naked "fn main() { $@ }"
-}
+* Inline assembly ([no cranelift support](https://github.com/bytecodealliance/wasmtime/issues/1041))
+ * On UNIX there is support for invoking an external assembler for `global_asm!` and `asm!`.
+* SIMD ([tracked here](https://github.com/bjorn3/rustc_codegen_cranelift/issues/171), some basic things work)
-function jit_calc() {
- jit 'println!("0x{:x}", ' $@ ');';
-}
-```
+## License
-## Env vars
+Licensed under either of
-[see env_vars.md](docs/env_vars.md)
+ * 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)
-## Not yet supported
+at your option.
-* Good non-rust abi support ([several problems](https://github.com/bjorn3/rustc_codegen_cranelift/issues/10))
-* 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.
-* SIMD ([tracked here](https://github.com/bjorn3/rustc_codegen_cranelift/issues/171), some basic things work)
+### 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.
projects / rust.git / blobdiff