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)
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,
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
18 Miri has already discovered some [real-world bugs](#bugs-found-by-miri). If you
19 found a bug with Miri, we'd appreciate if you tell us and we'll add it to the
22 Be aware that Miri will not catch all possible errors in your program, and
23 cannot run all programs:
25 * There are still plenty of open questions around the basic invariants for some
26 types and when these invariants even have to hold, so if you program runs fine
27 in Miri right now that is by no means a guarantee that it is UB-free when
28 these questions get answered.
29 * If the program relies on unspecified details of how data is laid out, it will
30 still run fine in Miri -- but might break (including causing UB) on different
31 compiler versions or different platforms.
32 * Miri is fully deterministic and does not actually pick a base address in
33 virtual memory for the program's allocations. If program behavior depends on
34 the base address of an allocation, Miri will stop execution (with a few
35 exceptions to make some common pointer comparisons work).
36 * Miri runs the program as a platform-independent interpreter, so the program
37 has no access to any platform-specific APIs or FFI. A few APIs have been
38 implemented (such as printing to stdout) but most have not: for example, Miri
39 currently does not support concurrency, or networking, or file system access,
40 or gathering entropy from the system.
42 [rust]: https://www.rust-lang.org/
43 [mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md
44 [`unreachable_unchecked`]: https://doc.rust-lang.org/stable/std/hint/fn.unreachable_unchecked.html
45 [`copy_nonoverlapping`]: https://doc.rust-lang.org/stable/std/ptr/fn.copy_nonoverlapping.html
48 ## Running Miri on your own project (and its test suite)
50 Install Miri via `rustup`:
53 rustup component add miri
56 If `rustup` says the `miri` component is unavailable, that's because not all nightly releases come with all tools. Check out [this website](https://rust-lang.github.io/rustup-components-history) to determine a nightly version that comes with Miri and install that, e.g. using `rustup install nightly-2019-03-28`.
58 Now you can run your project in Miri:
60 1. Run `cargo clean` to eliminate any cached dependencies. Miri needs your
61 dependencies to be compiled the right way, that would not happen if they have
62 previously already been compiled.
63 2. To run all tests in your project through Miri, use `cargo miri test`.
64 3. If you have a binary project, you can run it through Miri using `cargo miri run`.
66 The first time you run Miri, it will perform some extra setup and install some
67 dependencies. It will ask you for confirmation before installing anything. If
68 you run Miri on CI, run `cargo miri setup` to avoid getting interactive
71 You can pass arguments to Miri after the first `--`, and pass arguments to the
72 interpreted program or test suite after the second `--`. For example, `cargo
73 miri run -- -Zmiri-disable-validation` runs the program without validation of
74 basic type invariants and references. `cargo miri test -- -- -Zunstable-options
75 --exclude-should-panic` skips `#[should_panic]` tests, which is a good idea
76 because Miri does not support unwinding or catching panics.
78 When running code via `cargo miri`, the `miri` config flag is set. You can
79 use this to exclude test cases that will fail under Miri because they do things
80 Miri does not support:
85 fn does_not_work_on_miri() {
87 assert!(&x as *const _ as usize % 4 < 4);
93 When using the above instructions, you may encounter a number of confusing compiler
96 #### "found possibly newer version of crate `std` which `<dependency>` depends on"
98 Your build directory may contain artifacts from an earlier build that have/have
99 not been built for Miri. Run `cargo clean` before switching from non-Miri to
100 Miri builds and vice-versa.
102 #### "found crate `std` compiled by an incompatible version of rustc"
104 You may be running `cargo miri` with a different compiler version than the one
105 used to build the custom libstd that Miri uses, and Miri failed to detect that.
106 Try deleting `~/.cache/miri`.
108 ## Development and Debugging
110 If you want to hack on miri yourself, great! Here are some resources you might
113 ### Using a nightly rustc
115 Miri heavily relies on internal rustc interfaces to execute MIR. Still, some
116 things (like adding support for a new intrinsic) can be done by working just on
119 To prepare, make sure you are using a nightly Rust compiler. The most
120 convenient way is to install Miri using cargo, then you can easily run it on
124 rustup component remove miri # avoid having Miri installed twice
125 cargo +nightly install --path "$DIR" --force
126 cargo +nightly miri setup
129 (We are giving `+nightly` explicitly here all the time because it is important
130 that all of these commands get executed with the same toolchain.)
132 In case this fails, your nightly might be incompatible with Miri master. The
133 `rust-version` file contains the commit hash of rustc that Miri is currently
134 tested against; you can use that to find a nightly that works or you might have
135 to wait for the next nightly to get released.
137 If you want to use a different libstd (not the one that comes with the
138 nightly), you can do that by running
141 XARGO_RUST_SRC=~/src/rust/rustc/src/ cargo +nightly miri setup
144 Either way, you can now do `cargo +nightly miri run` to run Miri with your
145 local changes on whatever project you are debugging.
147 `cargo miri setup` should end in printing the directory where the libstd was
148 built. For the next step to work, set that as your `MIRI_SYSROOT` environment
152 export MIRI_SYSROOT=~/.cache/miri/HOST # or whatever the previous command said
157 Instead of running an entire project using `cargo miri`, you can also use the
158 Miri "driver" directly to run just a single file. That can be easier during
162 cargo run tests/run-pass/format.rs # or whatever test you like
165 You can also run the test suite with `cargo test --release`. `cargo test
166 --release FILTER` only runs those tests that contain `FILTER` in their filename
167 (including the base directory, e.g. `cargo test --release fail` will run all
168 compile-fail tests). We recommend using `--release` to make test running take
171 Now you are set up! You can write a failing test case, and tweak miri until it
173 You can get a trace of which MIR statements are being executed by setting the
174 `MIRI_LOG` environment variable. For example:
177 MIRI_LOG=info cargo run tests/run-pass/vecs.rs
180 Setting `MIRI_LOG` like this will configure logging for miri itself as well as
181 the `rustc::mir::interpret` and `rustc_mir::interpret` modules in rustc. You
182 can also do more targeted configuration, e.g. to debug the stacked borrows
185 MIRI_LOG=rustc_mir::interpret=info,miri::stacked_borrows cargo run tests/run-pass/vecs.rs
188 In addition, you can set `MIRI_BACKTRACE=1` to get a backtrace of where an
189 evaluation error was originally created.
192 ### Using a locally built rustc
194 Since the heart of Miri (the main interpreter engine) lives in rustc, working on
195 Miri will often require using a locally built rustc. The bug you want to fix
196 may actually be on the rustc side, or you just need to get more detailed trace
197 of the execution than what is possible with release builds -- in both cases, you
198 should develop miri against a rustc you compiled yourself, with debug assertions
199 (and hence tracing) enabled.
201 The setup for a local rustc works as follows:
203 git clone https://github.com/rust-lang/rust/ rustc
205 cp config.toml.example config.toml
206 # Now edit `config.toml` and set `debug-assertions = true` and `test-miri = true`.
207 # The latter is important to build libstd with the right flags for miri.
208 # This step can take 30 minutes and more.
209 ./x.py build src/rustc
210 # If you change something, you can get a faster rebuild by doing
211 ./x.py --keep-stage 0 build src/rustc
212 # You may have to change the architecture in the next command
213 rustup toolchain link custom build/x86_64-unknown-linux-gnu/stage2
214 # Now cd to your Miri directory, then configure rustup
215 rustup override set custom
218 With this, you should now have a working development setup! See
219 ["Testing Miri"](#testing-miri) above for how to proceed.
221 Running `cargo miri` in this setup is a bit more complicated, because the Miri
222 binary you just created does not actually run without some environment variables.
223 But you can contort cargo into calling `cargo miri` the right way for you:
226 # in some other project's directory, to run `cargo miri test`:
227 MIRI_SYSROOT=$(rustc +custom --print sysroot) cargo +custom run --manifest-path /path/to/miri/Cargo.toml --bin cargo-miri --release -- miri test
230 ### Miri `-Z` flags and environment variables
232 Several `-Z` flags are relevant for Miri:
234 * `-Zmiri-seed=<hex>` is a custom `-Z` flag added by Miri. It enables the
235 interpreted program to seed an RNG with system entropy. Miri will keep an RNG
236 on its own that is seeded with the given seed, and use that to generate the
237 "system entropy" that seeds the RNG(s) in the interpreted program.
238 **NOTE**: This entropy is not good enough for cryptographic use! Do not
239 generate secret keys in Miri or perform other kinds of cryptographic
240 operations that rely on proper random numbers.
241 * `-Zmiri-disable-validation` disables enforcing the validity invariant, which
242 is enforced by default. This is mostly useful for debugging; it means Miri
243 will miss bugs in your program. However, this can also help to make Miri run
245 * `-Zmir-opt-level` controls how many MIR optimizations are performed. Miri
246 overrides the default to be `0`; be advised that using any higher level can
247 make Miri miss bugs in your program because they got optimized away.
248 * `-Zalways-encode-mir` makes rustc dump MIR even for completely monomorphic
249 functions. This is needed so that Miri can execute such functions, so Miri
250 sets this flag per default.
252 Moreover, Miri recognizes some environment variables:
254 * `MIRI_SYSROOT` (recognized by `miri`, `cargo miri` and the test suite)
255 indicates the sysroot to use.
256 * `MIRI_TARGET` (recognized by the test suite) indicates which target
257 architecture to test against. `miri` and `cargo miri` accept the `--target`
258 flag for the same purpose.
260 ## Contributing and getting help
262 Check out the issues on this GitHub repository for some ideas. There's lots that
263 needs to be done that I haven't documented in the issues yet, however. For more
264 ideas or help with running or hacking on Miri, you can open an issue here on
265 GitHub or contact us (`oli-obk` and `RalfJ`) on the [Rust Zulip].
267 [Rust Zulip]: https://rust-lang.zulipchat.com
271 This project began as part of an undergraduate research course in 2015 by
272 @solson at the [University of Saskatchewan][usask]. There are [slides] and a
273 [report] available from that project. In 2016, @oli-obk joined to prepare miri
274 for eventually being used as const evaluator in the Rust compiler itself
275 (basically, for `const` and `static` stuff), replacing the old evaluator that
276 worked directly on the AST. In 2017, @RalfJung did an internship with Mozilla
277 and began developing miri towards a tool for detecting undefined behavior, and
278 also using miri as a way to explore the consequences of various possible
279 definitions for undefined behavior in Rust. @oli-obk's move of the miri engine
280 into the compiler finally came to completion in early 2018. Meanwhile, later
281 that year, @RalfJung did a second internship, developing miri further with
282 support for checking basic type invariants and verifying that references are
283 used according to their aliasing restrictions.
285 [usask]: https://www.usask.ca/
286 [slides]: https://solson.me/miri-slides.pdf
287 [report]: https://solson.me/miri-report.pdf
289 ## Bugs found by Miri
291 Miri has already found a number of bugs in the Rust standard library, which we collect here.
293 * [`Debug for vec_deque::Iter` accessing uninitialized memory](https://github.com/rust-lang/rust/issues/53566)
294 * [`From<&[T]> for Rc` creating a not sufficiently aligned reference](https://github.com/rust-lang/rust/issues/54908)
295 * [`BTreeMap` creating a shared reference pointing to a too small allocation](https://github.com/rust-lang/rust/issues/54957)
296 * [`VecDeque` creating overlapping mutable references](https://github.com/rust-lang/rust/pull/56161)
297 * [Futures turning a shared reference into a mutable one](https://github.com/rust-lang/rust/pull/56319)
298 * [`str` turning a shared reference into a mutable one](https://github.com/rust-lang/rust/pull/58200)
299 * [`BTreeMap` creating mutable references that overlap with shared references](https://github.com/rust-lang/rust/pull/58431)
303 Licensed under either of
304 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
305 http://www.apache.org/licenses/LICENSE-2.0)
306 * MIT license ([LICENSE-MIT](LICENSE-MIT) or
307 http://opensource.org/licenses/MIT) at your option.
311 Unless you explicitly state otherwise, any contribution intentionally submitted
312 for inclusion in the work by you shall be dual licensed as above, without any
313 additional terms or conditions.