Replace functions taking or returning u128 or i128 with a trap

[rust.git] / Readme.md

diff --git a/Readme.md b/Readme.md
index 835b0e813b573fdda4b3c223e1c1a8dd0870a19c..e6b6f68bfac1bcaec72f1d00728bffd4b3191891 100644 (file)
--- a/Readme.md
+++ b/Readme.md
@@ -1,56 +1,42 @@
 # Work in progress cranelift codegen backend for rust
 
-> ⚠⚠⚠ This doesn't do anything useful yet ⚠⚠⚠
+> ⚠⚠⚠ This doesn't do much useful yet ⚠⚠⚠
 
 ## Building
 
 ```bash
 $ git clone https://github.com/bjorn3/rustc_codegen_cranelift.git
 $ cd rustc_codegen_cranelift
-$ git submodule update --init
-$ cargo build
+$ ./prepare.sh # downloads and patches sysroot src and installs hyperfine for benchmarking
+$ ./test.sh
 ```
 
 ## Usage
 
+`$cg_clif_dir` is the directory you cloned this repo into in the following instruction.
+
+### Rustc
+
 ```bash
-$ rustc -Zcodegen-backend=$(pwd)/target/debug/librustc_codegen_cranelift.so my_crate.rs --crate-type lib -Og
+$ rustc -Cpanic=abort -Zcodegen-backend=$cg_clif_dir/target/debug/librustc_codegen_cranelift.so my_crate.rs
 ```
 
-> You must compile with `-Og`, because checked binops are not yet supported.
-
-## Building libcore
+### Cargo
 
 ```bash
-$ git clone https://github.com/rust-lang/rust.git
-$ cd rust
-$ git apply ../0001-Disable-stdsimd-in-libcore.patch
-$ git apply ../0002-Disable-u128-and-i128-in-libcore.patch
-$ cd ../
-$ ./build.sh
+$ RUSTFLAGS="-Cpanic=abort -Zcodegen-backend=$cg_clif_dir/target/debug/librustc_codegen_cranelift.dylib --sysroot $cg_clif_dir/build_sysroot/sysroot" cargo run
 ```
 
-> ⚠⚠⚠ You will get a panic because of unimplemented stuff ⚠⚠⚠
-
 ## Not yet supported
 
-* [ ] Checked binops
-* [ ] Statics
-* [ ] Drop glue
-
-* [ ] Building libraries
-* [ ] Other call abi's
-* [ ] Unsized types
-* [ ] Slice indexing
-* [ ] Sub slice
-* [ ] Closures
-* [ ] Some rvalue's
+* Good non-rust abi support ([scalar pair and vector are passed by-ref](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))
+* u128 and i128 ([no cranelift support](https://github.com/CraneStation/cranelift/issues/354))
+* SIMD ([tracked here](https://github.com/bjorn3/rustc_codegen_cranelift/issues/171))
 
-* [ ] Inline assembly
-* [ ] Custom sections
+## Troubleshooting
 
-## Known errors
+### Can't compile
 
-* [ ] cranelift-module api seems to be used wrong, thus causing panic for some consts
-* [ ] cranelift-codegen doesn't have encodings for some instructions for types smaller than I32
-* [ ] `thread 'main' panicked at 'assertion failed: !value.has_escaping_regions()', librustc/ty/sty.rs:754:9` in cton_sig_from_mono_fn_sig
\ No newline at end of file
+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.