compiler/rustc_codegen_cranelift/docs/usage.md

   1 # Usage
   2
   3 rustc_codegen_cranelift can be used as a near-drop-in replacement for `cargo build` or `cargo run` for existing projects.
   4
   5 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`).
   6
   7 ## Cargo
   8
   9 In the directory with your project (where you can do the usual `cargo build`), run:
  10
  11 ```bash
  12 $ $cg_clif_dir/build/cargo build
  13 ```
  14
  15 This will build your project with rustc_codegen_cranelift instead of the usual LLVM backend.
  16
  17 ## Rustc
  18
  19 > You should prefer using the Cargo method.
  20
  21 ```bash
  22 $ $cg_clif_dir/build/bin/cg_clif my_crate.rs
  23 ```
  24
  25 ## Jit mode
  26
  27 In jit mode cg_clif will immediately execute your code without creating an executable file.
  28
  29 > This requires all dependencies to be available as dynamic library.
  30 > The jit mode will probably need cargo integration to make this possible.
  31
  32 ```bash
  33 $ $cg_clif_dir/build/cargo jit
  34 ```
  35
  36 or
  37
  38 ```bash
  39 $ $cg_clif_dir/build/bin/cg_clif -Zunstable-features -Cllvm-args=mode=jit -Cprefer-dynamic my_crate.rs
  40 ```
  41
  42 There is also an experimental lazy jit mode. In this mode functions are only compiled once they are
  43 first called.
  44
  45 ```bash
  46 $ $cg_clif_dir/build/cargo lazy-jit
  47 ```
  48
  49 ## Shell
  50
  51 These are a few functions that allow you to easily run rust code from the shell using cg_clif as jit.
  52
  53 ```bash
  54 function jit_naked() {
  55     echo "$@" | $cg_clif_dir/build/bin/cg_clif - -Zunstable-features -Cllvm-args=mode=jit -Cprefer-dynamic
  56 }
  57
  58 function jit() {
  59     jit_naked "fn main() { $@ }"
  60 }
  61
  62 function jit_calc() {
  63     jit 'println!("0x{:x}", ' $@ ');';
  64 }
  65 ```