| commit | 9aa5fbf79c39867f144e5a38c53a8edd2e2069ba | [log] [tgz] |
|---|---|---|
| author | bjorn3 <17426603+bjorn3@users.noreply.github.com> | Fri Aug 18 13:15:36 2023 +0200 |
| committer | bjorn3 <17426603+bjorn3@users.noreply.github.com> | Fri Aug 18 13:15:36 2023 +0200 |
| tree | 51d53a236648d44782d703b18ebde413c9ab6a30 | |
| parent | 06ed138247fbe1eb56e372898559def54834887d [diff] |
Fix shell helpers in usage docs
The goal of this project is to create an alternative codegen backend for the rust compiler based on 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.
$ git clone https://github.com/bjorn3/rustc_codegen_cranelift $ cd rustc_codegen_cranelift $ ./y.sh prepare $ ./y.sh build
To run the test suite replace the last command with:
$ ./test.sh
For more docs on how to build and test see build_system/usage.txt or the help message of ./y.sh.
Alternatively you can download a pre built version from the releases page. Extract the dist directory in the archive anywhere you want. If you want to use cargo clif build instead of having to specify the full path to the cargo-clif executable, you can add the bin subdirectory of the extracted dist directory to your PATH. (tutorial for Windows, and for Linux/MacOS).
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 (y.sh prepare and y.sh build or test.sh).
In the directory with your project (where you can do the usual cargo build), run:
$ $cg_clif_dir/dist/cargo-clif build
This will build your project with rustc_codegen_cranelift instead of the usual LLVM backend.
For additional ways to use rustc_codegen_cranelift like the JIT mode see usage.md.
This is useful when changing code in rustc_codegen_cranelift as part of changing main Rust repository. This can happen, for example, when you are implementing a new compiler intrinsic.
Instruction below uses $RustCheckoutDir as substitute for any folder where you cloned Rust repository.
You need to do this steps to successfully compile and use the cranelift backend with your changes in rustc code:
cd $RustCheckoutDirpython x.py setup and choose option for compiler (b).python x.py build --stage=2 compiler library/std src/tools/rustdoc src/tools/rustfmtsrc/tools/cargo to previous command../build/host/stage2-tools/<your hostname triple>/release to ./build/host/stage2/bin/. Note that you would need to do this every time you rebuilt rust repository.cp $(rustup which cargo) .build/<your hostname triple>/stage2/bin/cargorustc to toolchain: rustup toolchain link stage2 ./build/host/stage2/.rustc +stage2 -O build_system/main.rs -o y.exe../y.sh (or y if you built build_system/main.rs as y) command by rustup run stage2 to make cg_clif use your local changes in rustc.rustup run stage2 ./y.sh preparerustup run stage2 ./y.sh buildrustup run stage2 ./y.sh test$RustCheckoutDir/compiler/rustc_codegen_cranelift/dist/cargo-clif build --release.See the documentation on the BackendConfig struct in config.rs for all configuration options.
global_asm! and asm!.std::simd fully works, std::arch is partially supported)-Cpanic=abort is enabled by default)Licensed under either of
at your option.
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.