Readme.md

   1 # Cranelift codegen backend for rust
   2
   3 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).
   4 This has the potential to improve compilation times in debug mode.
   5 If your project doesn't use any of the things listed under "Not yet supported", it should work fine.
   6 If not please open an issue.
   7
   8 ## Building and testing
   9
  10 ```bash
  11 $ git clone https://github.com/bjorn3/rustc_codegen_cranelift
  12 $ cd rustc_codegen_cranelift
  13 $ ./y.rs prepare
  14 $ ./y.rs build
  15 ```
  16
  17 To run the test suite replace the last command with:
  18
  19 ```bash
  20 $ ./test.sh
  21 ```
  22
  23 For more docs on how to build and test see [build_system/usage.txt](build_system/usage.txt) or the help message of `./y.rs`.
  24
  25 Alternatively you can download a pre built version from [Github Actions]. It is listed in the artifacts section
  26 of workflow runs. Unfortunately due to GHA restrictions you need to be logged in to access it.
  27
  28 [Github Actions]: https://github.com/bjorn3/rustc_codegen_cranelift/actions?query=branch%3Amaster+event%3Apush+is%3Asuccess
  29
  30 ## Usage
  31
  32 rustc_codegen_cranelift can be used as a near-drop-in replacement for `cargo build` or `cargo run` for existing projects.
  33
  34 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`).
  35
  36 In the directory with your project (where you can do the usual `cargo build`), run:
  37
  38 ```bash
  39 $ $cg_clif_dir/dist/cargo-clif build
  40 ```
  41
  42 This will build your project with rustc_codegen_cranelift instead of the usual LLVM backend.
  43
  44 For additional ways to use rustc_codegen_cranelift like the JIT mode see [usage.md](docs/usage.md).
  45
  46 ## Configuration
  47
  48 See the documentation on the `BackendConfig` struct in [config.rs](src/config.rs) for all
  49 configuration options.
  50
  51 ## Not yet supported
  52
  53 * Inline assembly ([no cranelift support](https://github.com/bytecodealliance/wasmtime/issues/1041))
  54     * On UNIX there is support for invoking an external assembler for `global_asm!` and `asm!`.
  55 * SIMD ([tracked here](https://github.com/bjorn3/rustc_codegen_cranelift/issues/171), `std::simd` fully works, `std::arch` is partially supported)
  56 * Unwinding on panics ([no cranelift support](https://github.com/bytecodealliance/wasmtime/issues/1677), `-Cpanic=abort` is enabled by default)
  57
  58 ## License
  59
  60 Licensed under either of
  61
  62   * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
  63     http://www.apache.org/licenses/LICENSE-2.0)
  64   * MIT license ([LICENSE-MIT](LICENSE-MIT) or
  65     http://opensource.org/licenses/MIT)
  66
  67 at your option.
  68
  69 ### Contribution
  70
  71 Unless you explicitly state otherwise, any contribution intentionally submitted
  72 for inclusion in the work by you shall be dual licensed as above, without any
  73 additional terms or conditions.