CONTRIBUTING.md

   1 # Contribution Guide
   2
   3 If you want to hack on miri yourself, great!  Here are some resources you might
   4 find useful.
   5
   6 ## Getting started
   7
   8 Check out the issues on this GitHub repository for some ideas. There's lots that
   9 needs to be done that we haven't documented in the issues yet, however. For more
  10 ideas or help with hacking on Miri, you can contact us (`oli-obk` and `RalfJ`)
  11 on the [Rust Zulip].
  12
  13 [Rust Zulip]: https://rust-lang.zulipchat.com
  14
  15 ## Building Miri with a pre-built rustc
  16
  17 Miri heavily relies on internal rustc interfaces to execute MIR.  Still, some
  18 things (like adding support for a new intrinsic or a shim for an external
  19 function being called) can be done by working just on the Miri side.
  20
  21 The `rust-version` file contains the commit hash of rustc that Miri is currently
  22 tested against. Other versions will likely not work. After installing
  23 [`rustup-toolchain-install-master`], you can run the following command to
  24 install that exact version of rustc as a toolchain:
  25 ```
  26 ./toolchain
  27 ```
  28
  29 [`rustup-toolchain-install-master`]: https://github.com/kennytm/rustup-toolchain-install-master
  30
  31 ### Fixing Miri when rustc changes
  32
  33 Miri is heavily tied to rustc internals, so it is very common that rustc changes
  34 break Miri.  Fixing those is a good way to get starting working on Miri.
  35 Usually, Miri will require changes similar to the other consumers of the changed
  36 rustc API, so reading the rustc PR diff is a good way to get an idea for what is
  37 needed.
  38
  39 To update the `rustc-version` file and install the latest rustc, you can run:
  40 ```
  41 ./toolchain HEAD
  42 ```
  43
  44 Now try `./miri test`, and submit a PR once that works again.
  45
  46 ## Testing the Miri driver
  47 [testing-miri]: #testing-the-miri-driver
  48
  49 The Miri driver in the `miri` binary is the "heart" of Miri: it is basically a
  50 version of `rustc` that, instead of compiling your code, runs it.  It accepts
  51 all the same flags as `rustc` (though the ones only affecting code generation
  52 and linking obviously will have no effect) [and more][miri-flags].
  53
  54 Running the Miri driver requires some fiddling with environment variables, so
  55 the `miri` script helps you do that.  For example, you can run the driver on a
  56 particular file by doing
  57
  58 ```sh
  59 ./miri run tests/run-pass/format.rs
  60 ./miri run tests/run-pass/hello.rs --target i686-unknown-linux-gnu
  61 ```
  62
  63 and you can run the test suite using:
  64
  65 ```
  66 ./miri test
  67 ```
  68
  69 `./miri test FILTER` only runs those tests that contain `FILTER` in their
  70 filename (including the base directory, e.g. `./miri test fail` will run all
  71 compile-fail tests).
  72
  73 You can get a trace of which MIR statements are being executed by setting the
  74 `MIRI_LOG` environment variable.  For example:
  75
  76 ```sh
  77 MIRI_LOG=info ./miri run tests/run-pass/vecs.rs
  78 ```
  79
  80 Setting `MIRI_LOG` like this will configure logging for Miri itself as well as
  81 the `rustc::mir::interpret` and `rustc_mir::interpret` modules in rustc.  You
  82 can also do more targeted configuration, e.g. the following helps debug the
  83 stacked borrows implementation:
  84
  85 ```sh
  86 MIRI_LOG=rustc_mir::interpret=info,miri::stacked_borrows ./miri run tests/run-pass/vecs.rs
  87 ```
  88
  89 In addition, you can set `MIRI_BACKTRACE=1` to get a backtrace of where an
  90 evaluation error was originally raised.
  91
  92 ## Testing `cargo miri`
  93
  94 Working with the driver directly gives you full control, but you also lose all
  95 the convenience provided by cargo.  Once your test case depends on a crate, it
  96 is probably easier to test it with the cargo wrapper.  You can install your
  97 development version of Miri using
  98
  99 ```
 100 ./miri install
 101 ```
 102
 103 and then you can use it as if it was installed by `rustup`.  Make sure you use
 104 the same toolchain when calling `cargo miri` that you used when installing Miri!
 105
 106 There's a test for the cargo wrapper in the `test-cargo-miri` directory; run
 107 `./run-test.py` in there to execute it.
 108
 109 ## Building Miri with a locally built rustc
 110
 111 A big part of the Miri driver lives in rustc, so working on Miri will sometimes
 112 require using a locally built rustc.  The bug you want to fix may actually be on
 113 the rustc side, or you just need to get more detailed trace of the execution
 114 than what is possible with release builds -- in both cases, you should develop
 115 miri against a rustc you compiled yourself, with debug assertions (and hence
 116 tracing) enabled.
 117
 118 The setup for a local rustc works as follows:
 119 ```sh
 120 git clone https://github.com/rust-lang/rust/ rustc
 121 cd rustc
 122 cp config.toml.example config.toml
 123 # Now edit `config.toml` and set `debug-assertions = true`.
 124 # This step can take 30 minutes and more.
 125 ./x.py build src/rustc
 126 # If you change something, you can get a faster rebuild by doing
 127 ./x.py --keep-stage 0 build src/rustc
 128 # You may have to change the architecture in the next command
 129 rustup toolchain link custom build/x86_64-unknown-linux-gnu/stage2
 130 # Now cd to your Miri directory, then configure rustup
 131 rustup override set custom
 132 ```
 133
 134 With this, you should now have a working development setup!  See
 135 [above][testing-miri] for how to proceed working with the Miri driver.