Readme.md

   1 # Work in progress cranelift codegen backend for rust
   2
   3 > ⚠⚠⚠ This doesn't do much useful yet ⚠⚠⚠
   4
   5 ## Building
   6
   7 ```bash
   8 $ git clone https://github.com/bjorn3/rustc_codegen_cranelift.git
   9 $ cd rustc_codegen_cranelift
  10 $ rustup override set nightly # This uses unstable api's which will never be stabilized
  11 $ cargo install xargo         # Used for building the sysroot
  12 $ cargo install hyperfine     # Used for benchmarking in build.sh
  13 $ cargo build
  14 ```
  15
  16 ## Usage
  17
  18 ```bash
  19 $ rustc -Zcodegen-backend=$(pwd)/target/debug/librustc_codegen_cranelift.so my_crate.rs
  20 ```
  21
  22 ## Build sysroot and test
  23
  24 ```bash
  25 $ rustup component add rust-src # Make sure the sysroot source is available
  26 $ ./prepare_libcore.sh          # Patch the sysroot source for some not yet supported things
  27 $ ./build.sh
  28 ```
  29
  30 ## Not yet supported
  31
  32 * Good non-rust abi support ([non scalars are not yet supported for the "C" abi](https://github.com/bjorn3/rustc_codegen_cranelift/issues/10))
  33 * Checked binops ([some missing instructions in cranelift](https://github.com/CraneStation/cranelift/issues/460))
  34 * Inline assembly ([no cranelift support](https://github.com/CraneStation/cranelift/issues/444))
  35 * Varargs ([no cranelift support](https://github.com/CraneStation/cranelift/issues/212))
  36 * libstd (needs varargs and some other stuff) ([tracked here](https://github.com/bjorn3/rustc_codegen_cranelift/issues/146))
  37 * u128 and i128 ([no cranelift support](https://github.com/CraneStation/cranelift/issues/354))
  38 * SIMD ([tracked here](https://github.com/bjorn3/rustc_codegen_cranelift/issues/171))
  39
  40 ## Troubleshooting
  41
  42 ### Can't compile
  43
  44 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.
  45
  46 ### error[E0463]: can't find crate for `std` while compiling a no_std crate
  47
  48 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. :(