README.md

   1 # Miri [![Build Status](https://travis-ci.com/rust-lang/miri.svg?branch=master)](https://travis-ci.com/rust-lang/miri) [![Windows build status](https://ci.appveyor.com/api/projects/status/github/rust-lang/miri?svg=true)](https://ci.appveyor.com/project/rust-lang-libs/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
   7 [undefined behavior](https://doc.rust-lang.org/reference/behavior-considered-undefined.html),
   8 for example:
   9
  10 * Out-of-bounds memory accesses and use-after-free
  11 * Invalid use of uninitialized data
  12 * Violation of intrinsic preconditions (an [`unreachable_unchecked`] being
  13   reached, calling [`copy_nonoverlapping`] with overlapping ranges, ...)
  14 * Not sufficiently aligned memory accesses and references
  15 * Violation of *some* basic type invariants (a `bool` that is not 0 or 1, for example,
  16   or an invalid enum discriminant)
  17 * **Experimental**: Violations of the [Stacked Borrows] rules governing aliasing
  18   for reference types
  19
  20 On top of that, Miri will also tell you about memory leaks: when there is memory
  21 still allocated at the end of the execution, and that memory is not reachable
  22 from a global `static`, Miri will raise an error. Note however that
  23 [leak checking is currently disabled on Windows targets](https://github.com/rust-lang/miri/issues/1302).
  24
  25 Miri has already discovered some [real-world bugs](#bugs-found-by-miri).  If you
  26 found a bug with Miri, we'd appreciate if you tell us and we'll add it to the
  27 list!
  28
  29 However, be aware that Miri will **not catch all cases of undefined behavior**
  30 in your program, and cannot run all programs:
  31
  32 * There are still plenty of open questions around the basic invariants for some
  33   types and when these invariants even have to hold. Miri tries to avoid false
  34   positives here, so if you program runs fine in Miri right now that is by no
  35   means a guarantee that it is UB-free when these questions get answered.
  36
  37     In particular, Miri does currently not check that integers/floats are
  38   initialized or that references point to valid data.
  39 * If the program relies on unspecified details of how data is laid out, it will
  40   still run fine in Miri -- but might break (including causing UB) on different
  41   compiler versions or different platforms.
  42 * Program execution is non-deterministic when it depends, for example, on where
  43   exactly in memory allocations end up. Miri tests one of many possible
  44   executions of your program. If your code is sensitive to allocation base
  45   addresses or other non-deterministic data, try running Miri with different
  46   values for `-Zmiri-seed` to test different executions.
  47 * Miri runs the program as a platform-independent interpreter, so the program
  48   has no access to most platform-specific APIs or FFI. A few APIs have been
  49   implemented (such as printing to stdout) but most have not: for example, Miri
  50   currently does not support SIMD or networking.
  51 * Miri currently does not check for data-races and most other concurrency-related
  52   issues.
  53
  54 [rust]: https://www.rust-lang.org/
  55 [mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md
  56 [`unreachable_unchecked`]: https://doc.rust-lang.org/stable/std/hint/fn.unreachable_unchecked.html
  57 [`copy_nonoverlapping`]: https://doc.rust-lang.org/stable/std/ptr/fn.copy_nonoverlapping.html
  58 [Stacked Borrows]: https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md
  59
  60
  61 ## Using Miri
  62
  63 Install Miri on Rust nightly via `rustup`:
  64
  65 ```sh
  66 rustup +nightly component add miri
  67 ```
  68
  69 If `rustup` says the `miri` component is unavailable, that's because not all
  70 nightly releases come with all tools. Check out
  71 [this website](https://rust-lang.github.io/rustup-components-history) to
  72 determine a nightly version that comes with Miri and install that using
  73 `rustup toolchain install nightly-YYYY-MM-DD`.
  74
  75 Now you can run your project in Miri:
  76
  77 1. Run `cargo clean` to eliminate any cached dependencies.  Miri needs your
  78    dependencies to be compiled the right way, that would not happen if they have
  79    previously already been compiled.
  80 2. To run all tests in your project through Miri, use `cargo miri test`.
  81 3. If you have a binary project, you can run it through Miri using `cargo miri run`.
  82
  83 The first time you run Miri, it will perform some extra setup and install some
  84 dependencies.  It will ask you for confirmation before installing anything.
  85
  86 You can pass arguments to Miri after the first `--`, and pass arguments to the
  87 interpreted program or test suite after the second `--`.  For example, `cargo
  88 miri run -- -Zmiri-disable-stacked-borrows` runs the program without checking
  89 the aliasing of references.  To filter the tests being run, use `cargo miri test
  90 -- -- filter`.
  91
  92 Miri supports cross-execution: if you want to run the program as if it was a
  93 Linux program, you can do `cargo miri run --target x86_64-unknown-linux-gnu`.
  94 This is particularly useful if you are using Windows, as the Linux target is
  95 much better supported than Windows targets.
  96
  97 When compiling code via `cargo miri`, the `miri` config flag is set.  You can
  98 use this to ignore test cases that fail under Miri because they do things Miri
  99 does not support:
 100
 101 ```rust
 102 #[test]
 103 #[cfg_attr(miri, ignore)]
 104 fn does_not_work_on_miri() {
 105     std::thread::spawn(|| println!("Hello Thread!"))
 106         .join()
 107         .unwrap();
 108 }
 109 ```
 110
 111 There is no way to list all the infinite things Miri cannot do, but the
 112 interpreter will explicitly tell you when it finds something unsupported:
 113
 114 ```
 115 error: unsupported operation: Miri does not support threading
 116     ...
 117     = help: this is likely not a bug in the program; it indicates that the program \
 118             performed an operation that the interpreter does not support
 119 ```
 120
 121 ### Running Miri on CI
 122
 123 To run Miri on CI, make sure that you handle the case where the latest nightly
 124 does not ship the Miri component because it currently does not build.  For
 125 example, you can use the following snippet to always test with the latest
 126 nightly that *does* come with Miri:
 127
 128 ```sh
 129 MIRI_NIGHTLY=nightly-$(curl -s https://rust-lang.github.io/rustup-components-history/x86_64-unknown-linux-gnu/miri)
 130 echo "Installing latest nightly with Miri: $MIRI_NIGHTLY"
 131 rustup set profile minimal
 132 rustup default "$MIRI_NIGHTLY"
 133 rustup component add miri
 134
 135 cargo miri test
 136 ```
 137
 138 ### Common Problems
 139
 140 When using the above instructions, you may encounter a number of confusing compiler
 141 errors.
 142
 143 #### "found possibly newer version of crate `std` which `<dependency>` depends on"
 144
 145 Your build directory may contain artifacts from an earlier build that have/have
 146 not been built for Miri. Run `cargo clean` before switching from non-Miri to
 147 Miri builds and vice-versa.
 148
 149 #### "found crate `std` compiled by an incompatible version of rustc"
 150
 151 You may be running `cargo miri` with a different compiler version than the one
 152 used to build the custom libstd that Miri uses, and Miri failed to detect that.
 153 Try deleting `~/.cache/miri`.
 154
 155 #### "no mir for `std::rt::lang_start_internal`"
 156
 157 This means the sysroot you are using was not compiled with Miri in mind.  This
 158 should never happen when you use `cargo miri` because that takes care of setting
 159 up the sysroot.  If you are using `miri` (the Miri driver) directly, see the
 160 [contributors' guide](CONTRIBUTING.md) for how to use `./miri` to best do that.
 161
 162
 163 ## Miri `-Z` flags and environment variables
 164 [miri-flags]: #miri--z-flags-and-environment-variables
 165
 166 Miri adds its own set of `-Z` flags:
 167
 168 * `-Zmiri-disable-alignment-check` disables checking pointer alignment. This is
 169   useful to avoid [false positives][alignment-false-positives]. However, setting
 170   this flag means Miri could miss bugs in your program.
 171 * `-Zmiri-disable-stacked-borrows` disables checking the experimental
 172   [Stacked Borrows] aliasing rules.  This can make Miri run faster, but it also
 173   means no aliasing violations will be detected.
 174 * `-Zmiri-disable-validation` disables enforcing validity invariants, which are
 175   enforced by default.  This is mostly useful to focus on other failures (such
 176   as out-of-bounds accesses) first.  Setting this flag means Miri will miss bugs
 177   in your program.  However, this can also help to make Miri run faster.
 178 * `-Zmiri-disable-isolation` disables host isolation.  As a consequence,
 179   the program has access to host resources such as environment variables, file
 180   systems, and randomness.
 181 * `-Zmiri-env-exclude=<var>` keeps the `var` environment variable isolated from
 182   the host so that it cannot be accessed by the program.  Can be used multiple
 183   times to exclude several variables.  On Windows, the `TERM` environment
 184   variable is excluded by default.
 185 * `-Zmiri-ignore-leaks` disables the memory leak checker.
 186 * `-Zmiri-seed=<hex>` configures the seed of the RNG that Miri uses to resolve
 187   non-determinism.  This RNG is used to pick base addresses for allocations.
 188   When isolation is enabled (the default), this is also used to emulate system
 189   entropy.  The default seed is 0.  **NOTE**: This entropy is not good enough
 190   for cryptographic use!  Do not generate secret keys in Miri or perform other
 191   kinds of cryptographic operations that rely on proper random numbers.
 192 * `-Zmiri-track-alloc-id=<id>` shows a backtrace when the given allocation is
 193   being allocated or freed.  This helps in debugging memory leaks and
 194   use after free bugs.
 195 * `-Zmiri-track-pointer-tag=<tag>` shows a backtrace when the given pointer tag
 196   is popped from a borrow stack (which is where the tag becomes invalid and any
 197   future use of it will error).  This helps you in finding out why UB is
 198   happening and where in your code would be a good place to look for it.
 199
 200 [alignment-false-positives]: https://github.com/rust-lang/miri/issues/1074
 201
 202 Some native rustc `-Z` flags are also very relevant for Miri:
 203
 204 * `-Zmir-opt-level` controls how many MIR optimizations are performed.  Miri
 205   overrides the default to be `0`; be advised that using any higher level can
 206   make Miri miss bugs in your program because they got optimized away.
 207 * `-Zalways-encode-mir` makes rustc dump MIR even for completely monomorphic
 208   functions.  This is needed so that Miri can execute such functions, so Miri
 209   sets this flag per default.
 210 * `-Zmir-emit-retag` controls whether `Retag` statements are emitted. Miri
 211   enables this per default because it is needed for [Stacked Borrows].
 212
 213 Moreover, Miri recognizes some environment variables:
 214
 215 * `MIRI_LOG`, `MIRI_BACKTRACE` control logging and backtrace printing during
 216   Miri executions, also [see above][testing-miri].
 217 * `MIRI_SYSROOT` (recognized by `cargo miri` and the test suite)
 218   indicates the sysroot to use.  To do the same thing with `miri`
 219   directly, use the `--sysroot` flag.
 220 * `MIRI_TEST_TARGET` (recognized by the test suite) indicates which target
 221   architecture to test against.  `miri` and `cargo miri` accept the `--target`
 222   flag for the same purpose.
 223 * `MIRI_TEST_FLAGS` (recognized by the test suite) defines extra flags to be
 224   passed to Miri.
 225
 226 The following environment variables are internal, but used to communicate between
 227 different Miri binaries, and as such worth documenting:
 228
 229 * `MIRI_BE_RUSTC` when set to any value tells the Miri driver to actually not
 230   interpret the code but compile it like rustc would. This is useful to be sure
 231   that the compiled `rlib`s are compatible with Miri.
 232
 233 ## Contributing and getting help
 234
 235 If you want to contribute to Miri, great!  Please check out our
 236 [contribution guide](CONTRIBUTING.md).
 237
 238 For help with running Miri, you can open an issue here on
 239 GitHub or contact us (`oli-obk` and `RalfJ`) on the [Rust Zulip].
 240
 241 [Rust Zulip]: https://rust-lang.zulipchat.com
 242
 243 ## History
 244
 245 This project began as part of an undergraduate research course in 2015 by
 246 @solson at the [University of Saskatchewan][usask].  There are [slides] and a
 247 [report] available from that project.  In 2016, @oli-obk joined to prepare miri
 248 for eventually being used as const evaluator in the Rust compiler itself
 249 (basically, for `const` and `static` stuff), replacing the old evaluator that
 250 worked directly on the AST.  In 2017, @RalfJung did an internship with Mozilla
 251 and began developing miri towards a tool for detecting undefined behavior, and
 252 also using miri as a way to explore the consequences of various possible
 253 definitions for undefined behavior in Rust.  @oli-obk's move of the miri engine
 254 into the compiler finally came to completion in early 2018.  Meanwhile, later
 255 that year, @RalfJung did a second internship, developing miri further with
 256 support for checking basic type invariants and verifying that references are
 257 used according to their aliasing restrictions.
 258
 259 [usask]: https://www.usask.ca/
 260 [slides]: https://solson.me/miri-slides.pdf
 261 [report]: https://solson.me/miri-report.pdf
 262
 263 ## Bugs found by Miri
 264
 265 Miri has already found a number of bugs in the Rust standard library and beyond, which we collect here.
 266
 267 Definite bugs found:
 268
 269 * [`Debug for vec_deque::Iter` accessing uninitialized memory](https://github.com/rust-lang/rust/issues/53566)
 270 * [`Vec::into_iter` doing an unaligned ZST read](https://github.com/rust-lang/rust/pull/53804)
 271 * [`From<&[T]> for Rc` creating a not sufficiently aligned reference](https://github.com/rust-lang/rust/issues/54908)
 272 * [`BTreeMap` creating a shared reference pointing to a too small allocation](https://github.com/rust-lang/rust/issues/54957)
 273 * [`Vec::append` creating a dangling reference](https://github.com/rust-lang/rust/pull/61082)
 274 * [Futures turning a shared reference into a mutable one](https://github.com/rust-lang/rust/pull/56319)
 275 * [`str` turning a shared reference into a mutable one](https://github.com/rust-lang/rust/pull/58200)
 276 * [`rand` performing unaligned reads](https://github.com/rust-random/rand/issues/779)
 277 * [The Unix allocator calling `posix_memalign` in an invalid way](https://github.com/rust-lang/rust/issues/62251)
 278 * [`getrandom` calling the `getrandom` syscall in an invalid way](https://github.com/rust-random/getrandom/pull/73)
 279 * [`Vec`](https://github.com/rust-lang/rust/issues/69770) and [`BTreeMap`](https://github.com/rust-lang/rust/issues/69769) leaking memory under some (panicky) conditions
 280 * [`beef` leaking memory](https://github.com/maciejhirsz/beef/issues/12)
 281 * [`EbrCell` using uninitialized memory incorrectly](https://github.com/Firstyear/concread/commit/b15be53b6ec076acb295a5c0483cdb4bf9be838f#diff-6282b2fc8e98bd089a1f0c86f648157cR229)
 282 * [TiKV performing an unaligned pointer access](https://github.com/tikv/tikv/issues/7613)
 283 * [`servo_arc` creating a dangling shared reference](https://github.com/servo/servo/issues/26357)
 284 * [TiKV constructing out-of-bounds pointers (and overlapping mutable references)](https://github.com/tikv/tikv/pull/7751)
 285
 286 Violations of [Stacked Borrows] found that are likely bugs (but Stacked Borrows is currently just an experiment):
 287
 288 * [`VecDeque` creating overlapping mutable references](https://github.com/rust-lang/rust/pull/56161)
 289 * [`BTreeMap` creating mutable references that overlap with shared references](https://github.com/rust-lang/rust/pull/58431)
 290 * [`LinkedList` creating overlapping mutable references](https://github.com/rust-lang/rust/pull/60072)
 291 * [`Vec::push` invalidating existing references into the vector](https://github.com/rust-lang/rust/issues/60847)
 292 * [`align_to_mut` violating uniqueness of mutable references](https://github.com/rust-lang/rust/issues/68549)
 293 * [`sized-chunks` creating aliasing mutable references](https://github.com/bodil/sized-chunks/issues/8)
 294 * [`String::push_str` invalidating existing references into the string](https://github.com/rust-lang/rust/issues/70301)
 295 * [`ryu` using raw pointers outside their valid memory area](https://github.com/dtolnay/ryu/issues/24)
 296 * [ink! creating overlapping mutable references](https://github.com/rust-lang/miri/issues/1364)
 297 * [TiKV creating overlapping mutable reference and raw pointer](https://github.com/tikv/tikv/pull/7709)
 298
 299 ## License
 300
 301 Licensed under either of
 302   * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
 303     http://www.apache.org/licenses/LICENSE-2.0)
 304   * MIT license ([LICENSE-MIT](LICENSE-MIT) or
 305     http://opensource.org/licenses/MIT) at your option.
 306
 307 ### Contribution
 308
 309 Unless you explicitly state otherwise, any contribution intentionally submitted
 310 for inclusion in the work by you shall be dual licensed as above, without any
 311 additional terms or conditions.