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