compiler/rustc_codegen_gcc/Readme.md

   1 # WIP libgccjit codegen backend for rust
   2
   3 This is a GCC codegen for rustc, which means it can be loaded by the existing rustc frontend, but benefits from GCC: more architectures are supported and GCC's optimizations are used.
   4
   5 **Despite its name, libgccjit can be used for ahead-of-time compilation, as is used here.**
   6
   7 ## Motivation
   8
   9 The primary goal of this project is to be able to compile Rust code on platforms unsupported by LLVM.
  10 A secondary goal is to check if using the gcc backend will provide any run-time speed improvement for the programs compiled using rustc.
  11
  12 ## Building
  13
  14 **This requires a patched libgccjit in order to work.
  15 The patches in [this repostory](https://github.com/antoyo/libgccjit-patches) need to be applied.
  16 (Those patches should work when applied on master, but in case it doesn't work, they are known to work when applied on 079c23cfe079f203d5df83fea8e92a60c7d7e878.)
  17 You can also use my [fork of gcc](https://github.com/antoyo/gcc) which already includes these patches.**
  18
  19 **Put the path to your custom build of libgccjit in the file `gcc_path`.**
  20
  21 ```bash
  22 $ git clone https://github.com/rust-lang/rustc_codegen_gcc.git
  23 $ cd rustc_codegen_gcc
  24 $ ./prepare_build.sh # download and patch sysroot src
  25 $ ./build.sh --release
  26 ```
  27
  28 To run the tests:
  29
  30 ```bash
  31 $ ./prepare.sh # download and patch sysroot src and install hyperfine for benchmarking
  32 $ ./test.sh --release
  33 ```
  34
  35 ## Usage
  36
  37 `$cg_gccjit_dir` is the directory you cloned this repo into in the following instructions.
  38
  39 ### Cargo
  40
  41 ```bash
  42 $ CHANNEL="release" $cg_gccjit_dir/cargo.sh run
  43 ```
  44
  45 If you compiled cg_gccjit in debug mode (aka you didn't pass `--release` to `./test.sh`) you should use `CHANNEL="debug"` instead or omit `CHANNEL="release"` completely.
  46
  47 ### Rustc
  48
  49 > You should prefer using the Cargo method.
  50
  51 ```bash
  52 $ rustc +$(cat $cg_gccjit_dir/rust-toolchain) -Cpanic=abort -Zcodegen-backend=$cg_gccjit_dir/target/release/librustc_codegen_gcc.so --sysroot $cg_gccjit_dir/build_sysroot/sysroot my_crate.rs
  53 ```
  54
  55 ## Env vars
  56
  57 <dl>
  58     <dt>CG_GCCJIT_INCR_CACHE_DISABLED</dt>
  59     <dd>Don't cache object files in the incremental cache. Useful during development of cg_gccjit
  60     to make it possible to use incremental mode for all analyses performed by rustc without caching
  61     object files when their content should have been changed by a change to cg_gccjit.</dd>
  62     <dt>CG_GCCJIT_DISPLAY_CG_TIME</dt>
  63     <dd>Display the time it took to perform codegen for a crate</dd>
  64 </dl>
  65
  66 ## Debugging
  67
  68 Sometimes, libgccjit will crash and output an error like this:
  69
  70 ```
  71 during RTL pass: expand
  72 libgccjit.so: error: in expmed_mode_index, at expmed.h:249
  73 0x7f0da2e61a35 expmed_mode_index
  74         ../../../gcc/gcc/expmed.h:249
  75 0x7f0da2e61aa4 expmed_op_cost_ptr
  76         ../../../gcc/gcc/expmed.h:271
  77 0x7f0da2e620dc sdiv_cost_ptr
  78         ../../../gcc/gcc/expmed.h:540
  79 0x7f0da2e62129 sdiv_cost
  80         ../../../gcc/gcc/expmed.h:558
  81 0x7f0da2e73c12 expand_divmod(int, tree_code, machine_mode, rtx_def*, rtx_def*, rtx_def*, int)
  82         ../../../gcc/gcc/expmed.c:4335
  83 0x7f0da2ea1423 expand_expr_real_2(separate_ops*, rtx_def*, machine_mode, expand_modifier)
  84         ../../../gcc/gcc/expr.c:9240
  85 0x7f0da2cd1a1e expand_gimple_stmt_1
  86         ../../../gcc/gcc/cfgexpand.c:3796
  87 0x7f0da2cd1c30 expand_gimple_stmt
  88         ../../../gcc/gcc/cfgexpand.c:3857
  89 0x7f0da2cd90a9 expand_gimple_basic_block
  90         ../../../gcc/gcc/cfgexpand.c:5898
  91 0x7f0da2cdade8 execute
  92         ../../../gcc/gcc/cfgexpand.c:6582
  93 ```
  94
  95 To see the code which causes this error, call the following function:
  96
  97 ```c
  98 gcc_jit_context_dump_to_file(ctxt, "/tmp/output.c", 1 /* update_locations */)
  99 ```
 100
 101 This will create a C-like file and add the locations into the IR pointing to this C file.
 102 Then, rerun the program and it will output the location in the second line:
 103
 104 ```
 105 libgccjit.so: /tmp/something.c:61322:0: error: in expmed_mode_index, at expmed.h:249
 106 ```
 107
 108 Or add a breakpoint to `add_error` in gdb and print the line number using:
 109
 110 ```
 111 p loc->m_line
 112 ```
 113
 114 To get the `rustc` command to run in `gdb`, add the `--verbose` flag to `cargo build`.
 115
 116 ### How to use a custom-build rustc
 117
 118  * Build the stage2 compiler (`rustup toolchain link debug-current build/x86_64-unknown-linux-gnu/stage2`).
 119  * Clean and rebuild the codegen with `debug-current` in the file `rust-toolchain`.
 120
 121 ### How to build a cross-compiling libgccjit
 122
 123 #### Building libgccjit
 124
 125  * Follow these instructions: https://preshing.com/20141119/how-to-build-a-gcc-cross-compiler/ with the following changes:
 126  * Configure gcc with `../gcc/configure --enable-host-shared --disable-multilib --enable-languages=c,jit,c++ --disable-bootstrap --enable-checking=release --prefix=/opt/m68k-gcc/ --target=m68k-linux --without-headers`.
 127  * Some shells, like fish, don't define the environment variable `$MACHTYPE`.
 128  * Add `CFLAGS="-Wno-error=attributes -g -O2"` at the end of the configure command for building glibc (`CFLAGS="-Wno-error=attributes -Wno-error=array-parameter -Wno-error=stringop-overflow -Wno-error=array-bounds -g -O2"` for glibc 2.31, which is useful for Debian).
 129
 130 #### Configuring rustc_codegen_gcc
 131
 132  * Set `TARGET_TRIPLE="m68k-unknown-linux-gnu"` in config.sh.
 133  * Since rustc doesn't support this architecture yet, set it back to `TARGET_TRIPLE="mips-unknown-linux-gnu"` (or another target having the same attributes). Alternatively, create a [target specification file](https://book.avr-rust.com/005.1-the-target-specification-json-file.html) (note that the `arch` specified in this file must be supported by the rust compiler).
 134  * Set `linker='-Clinker=m68k-linux-gcc'`.
 135  * Set the path to the cross-compiling libgccjit in `gcc_path`.
 136  * Disable the 128-bit integer types if the target doesn't support them by using `let i128_type = context.new_type::<i64>();` in `context.rs` (same for u128_type).
 137  * (might not be necessary) Disable the compilation of libstd.so (and possibly libcore.so?).