README.md

   1 # Miri [![Build Status](https://travis-ci.org/solson/miri.svg?branch=master)](https://travis-ci.org/solson/miri) [![Windows build status](https://ci.appveyor.com/api/projects/status/github/solson/miri?svg=true)](https://ci.appveyor.com/project/solson63299/miri)
   2
   3
   4 An experimental interpreter for [Rust][rust]'s
   5 [mid-level intermediate representation][mir] (MIR).  It can run binaries and
   6 test suites of cargo projects and detect certain classes of undefined behavior,
   7 for example:
   8
   9 * Out-of-bounds memory accesses and use-after-free
  10 * Invalid use of uninitialized data
  11 * Violation of intrinsic preconditions (an [`unreachable_unchecked`] being
  12   reached, calling [`copy_nonoverlapping`] with overlapping ranges, ...)
  13 * Not sufficiently aligned memory accesses and references
  14 * Violation of basic type invariants (a `bool` that is not 0 or 1, for example,
  15   or an invalid enum discriminant)
  16 * WIP: Violations of the rules governing aliasing for reference types
  17
  18 [rust]: https://www.rust-lang.org/
  19 [mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md
  20 [`unreachable_unchecked`]: https://doc.rust-lang.org/stable/std/hint/fn.unreachable_unchecked.html
  21 [`copy_nonoverlapping`]: https://doc.rust-lang.org/stable/std/ptr/fn.copy_nonoverlapping.html
  22
  23
  24 ## Running Miri on your own project('s test suite)
  25
  26 Install Miri as a cargo subcommand:
  27
  28 ```sh
  29 cargo +nightly install --git https://github.com/solson/miri/ miri
  30 ```
  31
  32 If this does not work, try using the nightly version given in
  33 [this file](https://raw.githubusercontent.com/solson/miri/master/rust-version). CI
  34 should ensure that this nightly always works.
  35
  36 You have to use a consistent Rust version for building miri and your project, so
  37 remember to either always specify the nightly version manually (like in the
  38 example above), overriding it in your project directory as well, or use `rustup
  39 default nightly` (or `rustup default nightly-YYYY-MM-DD`) to globally make
  40 `nightly` the default toolchain.
  41
  42 Now you can run your project in miri:
  43
  44 1. Run `cargo clean` to eliminate any cached dependencies.  Miri needs your
  45    dependencies to be compiled the right way, that would not happen if they have
  46    previously already been compiled.
  47 2. To run all tests in your project through Miri, use `cargo +nightly miri test`.
  48    **NOTE**: This is currently broken, see the discussion in
  49    [#479](https://github.com/solson/miri/issues/479).
  50 3. If you have a binary project, you can run it through Miri using `cargo
  51    +nightly miri run`.
  52
  53 ### Common Problems
  54
  55 When using the above instructions, you may encounter a number of confusing compiler
  56 errors.
  57
  58 #### "found possibly newer version of crate `std` which `<dependency>` depends on"
  59
  60 Your build directory may contain artifacts from an earlier build that have/have
  61 not been built for Miri. Run `cargo clean` before switching from non-Miri to
  62 Miri builds and vice-versa.
  63
  64 #### "found crate `std` compiled by an incompatible version of rustc"
  65
  66 You may be running `cargo miri` with a different compiler version than the one
  67 used to build the custom libstd that Miri uses, and Miri failed to detect that.
  68 Try deleting `~/.cache/miri`.
  69
  70 ## Development and Debugging
  71
  72 If you want to hack on miri yourself, great!  Here are some resources you might
  73 find useful.
  74
  75 ### Using a nightly rustc
  76
  77 miri heavily relies on internal rustc interfaces to execute MIR.  Still, some
  78 things (like adding support for a new intrinsic) can be done by working just on
  79 the miri side.
  80
  81 To prepare, make sure you are using a nightly Rust compiler.  You also need to
  82 set up a libstd that enables execution with miri:
  83
  84 ```sh
  85 rustup override set nightly # or the nightly in `rust-version`
  86 cargo run --bin cargo-miri -- miri setup
  87 ```
  88
  89 The last command should end in printing the directory where the libstd was
  90 built.  Set that as your MIRI_SYSROOT environment variable:
  91
  92 ```sh
  93 export MIRI_SYSROOT=~/.cache/miri/HOST # or whatever the previous command said
  94 ```
  95
  96 ### Testing Miri
  97
  98 Now you can run Miri directly, without going through `cargo miri`:
  99
 100 ```sh
 101 cargo run tests/run-pass-fullmir/format.rs # or whatever test you like
 102 ```
 103
 104 You can also run the test suite with `cargo test --release`.  `cargo test
 105 --release FILTER` only runs those tests that contain `FILTER` in their filename
 106 (including the base directory, e.g. `cargo test --release fail` will run all
 107 compile-fail tests).  We recommend using `--release` to make test running take
 108 less time.
 109
 110 Now you are set up!  You can write a failing test case, and tweak miri until it
 111 fails no more.
 112
 113 ### Using a locally built rustc
 114
 115 Since the heart of Miri (the main interpreter engine) lives in rustc, working on
 116 Miri will often require using a locally built rustc.  The bug you want to fix
 117 may actually be on the rustc side, or you just need to get more detailed trace
 118 of the execution -- in both cases, you should develop miri against a rustc you
 119 compiled yourself, with debug assertions (and hence tracing) enabled.
 120
 121 The setup for a local rustc works as follows:
 122 ```sh
 123 git clone https://github.com/rust-lang/rust/ rustc
 124 cd rustc
 125 cp config.toml.example config.toml
 126 # Now edit `config.toml` and set `debug-assertions = true` and `test-miri = true`.
 127 # The latter is important to build libstd with the right flags for miri.
 128 # This step can take 30 minutes and more.
 129 ./x.py build src/rustc
 130 # If you change something, you can get a faster rebuild by doing
 131 ./x.py --keep-stage 0 build src/rustc
 132 # You may have to change the architecture in the next command
 133 rustup toolchain link custom build/x86_64-unknown-linux-gnu/stage2
 134 # Now cd to your Miri directory, then configure rustup
 135 rustup override set custom
 136 ```
 137
 138 With this, you should now have a working development setup!  See
 139 ["Testing Miri"](#testing-miri) above for how to proceed.
 140
 141 Moreover, you can now run Miri with a trace of all execution steps:
 142 ```sh
 143 MIRI_LOG=debug cargo run tests/run-pass/vecs.rs
 144 ```
 145
 146 Setting `MIRI_LOG` like this will configure logging for miri itself as well as
 147 the `rustc::mir::interpret` and `rustc_mir::interpret` modules in rustc.  You
 148 can also do more targeted configuration, e.g. to debug the stacked borrows
 149 implementation:
 150 ```sh
 151 MIRI_LOG=rustc_mir::interpret=debug,miri::stacked_borrows cargo run tests/run-pass/vecs.rs
 152 ```
 153
 154 In addition, you can set `MIRI_BACKTRACE=1` to get a backtrace of where an
 155 evaluation error was originally created.
 156
 157 ### Miri `-Z` flags and environment variables
 158
 159 Several `-Z` flags are relevant for Miri:
 160
 161 * `-Zmir-opt-level` controls how many MIR optimizations are performed.  miri
 162   overrides the default to be `0`; be advised that using any higher level can
 163   make miri miss bugs in your program because they got optimized away.
 164 * `-Zalways-encode-mir` makes rustc dump MIR even for completely monomorphic
 165   functions.  This is needed so that miri can execute such functions, so miri
 166   sets this flag per default.
 167 * `-Zmiri-disable-validation` is a custom `-Z` flag added by miri.  It disables
 168   enforcing the validity invariant, which is enforced by default.  This is
 169   mostly useful for debugging; it means miri will miss bugs in your program.
 170
 171 Moreover, Miri recognizes some environment variables:
 172
 173 * `MIRI_SYSROOT` (recognized by `miri`, `cargo miri` and the test suite)
 174   indicates the sysroot to use.
 175 * `MIRI_TARGET` (recognized by the test suite) indicates which target
 176   architecture to test against.  `miri` and `cargo miri` accept the `--target`
 177   flag for the same purpose.
 178
 179 ## Contributing and getting help
 180
 181 Check out the issues on this GitHub repository for some ideas. There's lots that
 182 needs to be done that I haven't documented in the issues yet, however. For more
 183 ideas or help with running or hacking on Miri, you can open an issue here on
 184 GitHub or contact us (`oli-obk` and `RalfJ`) on the [Rust Zulip].
 185
 186 [Rust Zulip]: https://rust-lang.zulipchat.com
 187
 188 ## History
 189
 190 This project began as part of an undergraduate research course in 2015 by
 191 @solson at the [University of Saskatchewan][usask].  There are [slides] and a
 192 [report] available from that project.  In 2016, @oli-obk joined to prepare miri
 193 for eventually being used as const evaluator in the Rust compiler itself
 194 (basically, for `const` and `static` stuff), replacing the old evaluator that
 195 worked directly on the AST.  In 2017, @RalfJung did an internship with Mozilla
 196 and began developing miri towards a tool for detecting undefined behavior, and
 197 also using miri as a way to explore the consequences of various possible
 198 definitions for undefined behavior in Rust.  @oli-obk's move of the miri engine
 199 into the compiler finally came to completion in early 2018.  Meanwhile, later
 200 that year, @RalfJung did a second internship, developing miri further with
 201 support for checking basic type invariants and verifying that references are
 202 used according to their aliasing restrictions.
 203
 204 [usask]: https://www.usask.ca/
 205 [slides]: https://solson.me/miri-slides.pdf
 206 [report]: https://solson.me/miri-report.pdf
 207
 208 ## License
 209
 210 Licensed under either of
 211   * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
 212     http://www.apache.org/licenses/LICENSE-2.0)
 213   * MIT license ([LICENSE-MIT](LICENSE-MIT) or
 214     http://opensource.org/licenses/MIT) at your option.
 215
 216 ### Contribution
 217
 218 Unless you explicitly state otherwise, any contribution intentionally submitted
 219 for inclusion in the work by you shall be dual licensed as above, without any
 220 additional terms or conditions.