]> git.lizzy.rs Git - rust.git/blob - README.md
enable track-raw-ptr tests on Windows
[rust.git] / README.md
1 # Miri
2
3 [![Actions build status][actions-badge]][actions-url]
4
5 [actions-badge]: https://github.com/rust-lang/miri/workflows/CI/badge.svg?branch=master
6 [actions-url]: https://github.com/rust-lang/miri/actions
7
8 An experimental interpreter for [Rust][rust]'s
9 [mid-level intermediate representation][mir] (MIR).  It can run binaries and
10 test suites of cargo projects and detect certain classes of
11 [undefined behavior](https://doc.rust-lang.org/reference/behavior-considered-undefined.html),
12 for example:
13
14 * Out-of-bounds memory accesses and use-after-free
15 * Invalid use of uninitialized data
16 * Violation of intrinsic preconditions (an [`unreachable_unchecked`] being
17   reached, calling [`copy_nonoverlapping`] with overlapping ranges, ...)
18 * Not sufficiently aligned memory accesses and references
19 * Violation of *some* basic type invariants (a `bool` that is not 0 or 1, for example,
20   or an invalid enum discriminant)
21 * **Experimental**: Violations of the [Stacked Borrows] rules governing aliasing
22   for reference types
23 * **Experimental**: Data races (but no weak memory effects)
24
25 On top of that, Miri will also tell you about memory leaks: when there is memory
26 still allocated at the end of the execution, and that memory is not reachable
27 from a global `static`, Miri will raise an error.
28
29 You can use Miri to emulate programs on other targets, e.g. to ensure that
30 byte-level data manipulation works correctly both on little-endian and
31 big-endian systems. See
32 [cross-interpretation](#cross-interpretation-running-for-different-targets)
33 below.
34
35 Miri has already discovered some [real-world bugs](#bugs-found-by-miri).  If you
36 found a bug with Miri, we'd appreciate if you tell us and we'll add it to the
37 list!
38
39 However, be aware that Miri will **not catch all cases of undefined behavior**
40 in your program, and cannot run all programs:
41
42 * There are still plenty of open questions around the basic invariants for some
43   types and when these invariants even have to hold. Miri tries to avoid false
44   positives here, so if you program runs fine in Miri right now that is by no
45   means a guarantee that it is UB-free when these questions get answered.
46
47     In particular, Miri does currently not check that integers/floats are
48   initialized or that references point to valid data.
49 * If the program relies on unspecified details of how data is laid out, it will
50   still run fine in Miri -- but might break (including causing UB) on different
51   compiler versions or different platforms.
52 * Program execution is non-deterministic when it depends, for example, on where
53   exactly in memory allocations end up, or on the exact interleaving of
54   concurrent threads. Miri tests one of many possible executions of your
55   program. You can alleviate this to some extent by running Miri with different
56   values for `-Zmiri-seed`, but that will still by far not explore all possible
57   executions.
58 * Miri runs the program as a platform-independent interpreter, so the program
59   has no access to most platform-specific APIs or FFI. A few APIs have been
60   implemented (such as printing to stdout) but most have not: for example, Miri
61   currently does not support SIMD or networking.
62
63 [rust]: https://www.rust-lang.org/
64 [mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md
65 [`unreachable_unchecked`]: https://doc.rust-lang.org/stable/std/hint/fn.unreachable_unchecked.html
66 [`copy_nonoverlapping`]: https://doc.rust-lang.org/stable/std/ptr/fn.copy_nonoverlapping.html
67 [Stacked Borrows]: https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md
68
69
70 ## Using Miri
71
72 Install Miri on Rust nightly via `rustup`:
73
74 ```sh
75 rustup +nightly component add miri
76 ```
77
78 If `rustup` says the `miri` component is unavailable, that's because not all
79 nightly releases come with all tools. Check out
80 [this website](https://rust-lang.github.io/rustup-components-history) to
81 determine a nightly version that comes with Miri and install that using
82 `rustup toolchain install nightly-YYYY-MM-DD`.
83
84 Now you can run your project in Miri:
85
86 1. Run `cargo clean` to eliminate any cached dependencies.  Miri needs your
87    dependencies to be compiled the right way, that would not happen if they have
88    previously already been compiled.
89 2. To run all tests in your project through Miri, use `cargo miri test`.
90 3. If you have a binary project, you can run it through Miri using `cargo miri run`.
91
92 The first time you run Miri, it will perform some extra setup and install some
93 dependencies.  It will ask you for confirmation before installing anything.
94
95 `cargo miri run/test` supports the exact same flags as `cargo run/test`.  You
96 can pass arguments to Miri via `MIRIFLAGS`. For example,
97 `MIRIFLAGS="-Zmiri-disable-stacked-borrows" cargo miri run` runs the program
98 without checking the aliasing of references.
99
100 When compiling code via `cargo miri`, the `cfg(miri)` config flag is set.  You
101 can use this to ignore test cases that fail under Miri because they do things
102 Miri does not support:
103
104 ```rust
105 #[test]
106 #[cfg_attr(miri, ignore)]
107 fn does_not_work_on_miri() {
108     std::thread::spawn(|| println!("Hello Thread!"))
109         .join()
110         .unwrap();
111 }
112 ```
113
114 There is no way to list all the infinite things Miri cannot do, but the
115 interpreter will explicitly tell you when it finds something unsupported:
116
117 ```
118 error: unsupported operation: can't call foreign function: bind
119     ...
120     = help: this is likely not a bug in the program; it indicates that the program \
121             performed an operation that the interpreter does not support
122 ```
123
124 ### Cross-interpretation: running for different targets
125
126 Miri can not only run a binary or test suite for your host target, it can also
127 perform cross-interpretation for arbitrary foreign targets: `cargo miri run
128 --target x86_64-unknown-linux-gnu` will run your program as if it was a Linux
129 program, no matter your host OS.  This is particularly useful if you are using
130 Windows, as the Linux target is much better supported than Windows targets.
131
132 You can also use this to test platforms with different properties than your host
133 platform.  For example `cargo miri test --target mips64-unknown-linux-gnuabi64`
134 will run your test suite on a big-endian target, which is useful for testing
135 endian-sensitive code.
136
137 ### Running Miri on CI
138
139 To run Miri on CI, make sure that you handle the case where the latest nightly
140 does not ship the Miri component because it currently does not build.  For
141 example, you can use the following snippet to always test with the latest
142 nightly that *does* come with Miri:
143
144 ```sh
145 MIRI_NIGHTLY=nightly-$(curl -s https://rust-lang.github.io/rustup-components-history/x86_64-unknown-linux-gnu/miri)
146 echo "Installing latest nightly with Miri: $MIRI_NIGHTLY"
147 rustup set profile minimal
148 rustup default "$MIRI_NIGHTLY"
149 rustup component add miri
150
151 cargo miri test
152 ```
153
154 ### Common Problems
155
156 When using the above instructions, you may encounter a number of confusing compiler
157 errors.
158
159 ### "note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace"
160
161 You may see this when trying to get Miri to display a backtrace. By default, Miri
162 doesn't expose any environment to the program, so running
163 `RUST_BACKTRACE=1 cargo miri test` will not do what you expect.
164
165 To get a backtrace, you need to disable isolation
166 [using `-Zmiri-disable-isolation`](#miri-flags):
167
168 ```sh
169 RUST_BACKTRACE=1 MIRIFLAGS="-Zmiri-disable-isolation" cargo miri test
170 ```
171
172 #### "found possibly newer version of crate `std` which `<dependency>` depends on"
173
174 Your build directory may contain artifacts from an earlier build that have/have
175 not been built for Miri. Run `cargo clean` before switching from non-Miri to
176 Miri builds and vice-versa.
177
178 #### "found crate `std` compiled by an incompatible version of rustc"
179
180 You may be running `cargo miri` with a different compiler version than the one
181 used to build the custom libstd that Miri uses, and Miri failed to detect that.
182 Try deleting `~/.cache/miri`.
183
184 #### "no mir for `std::rt::lang_start_internal`"
185
186 This means the sysroot you are using was not compiled with Miri in mind.  This
187 should never happen when you use `cargo miri` because that takes care of setting
188 up the sysroot.  If you are using `miri` (the Miri driver) directly, see the
189 [contributors' guide](CONTRIBUTING.md) for how to use `./miri` to best do that.
190
191
192 ## Miri `-Z` flags and environment variables
193 [miri-flags]: #miri--z-flags-and-environment-variables
194
195 Miri adds its own set of `-Z` flags, which are usually set via the `MIRIFLAGS`
196 environment variable:
197
198 * `-Zmiri-disable-alignment-check` disables checking pointer alignment, so you
199   can focus on other failures, but it means Miri can miss bugs in your program.
200   Using this flag is **unsound**.
201 * `-Zmiri-disable-stacked-borrows` disables checking the experimental
202   [Stacked Borrows] aliasing rules.  This can make Miri run faster, but it also
203   means no aliasing violations will be detected.  Using this flag is **unsound**
204   (but the affected soundness rules are experimental).
205 * `-Zmiri-disable-validation` disables enforcing validity invariants, which are
206   enforced by default.  This is mostly useful to focus on other failures (such
207   as out-of-bounds accesses) first.  Setting this flag means Miri can miss bugs
208   in your program.  However, this can also help to make Miri run faster.  Using
209   this flag is **unsound**.
210 * `-Zmiri-disable-isolation` disables host isolation.  As a consequence,
211   the program has access to host resources such as environment variables, file
212   systems, and randomness.
213 * `-Zmiri-env-exclude=<var>` keeps the `var` environment variable isolated from
214   the host so that it cannot be accessed by the program.  Can be used multiple
215   times to exclude several variables.  On Windows, the `TERM` environment
216   variable is excluded by default.
217 * `-Zmiri-ignore-leaks` disables the memory leak checker.
218 * `-Zmiri-seed=<hex>` configures the seed of the RNG that Miri uses to resolve
219   non-determinism.  This RNG is used to pick base addresses for allocations.
220   When isolation is enabled (the default), this is also used to emulate system
221   entropy.  The default seed is 0.  **NOTE**: This entropy is not good enough
222   for cryptographic use!  Do not generate secret keys in Miri or perform other
223   kinds of cryptographic operations that rely on proper random numbers.
224 * `-Zmiri-symbolic-alignment-check` makes the alignment check more strict.  By
225   default, alignment is checked by casting the pointer to an integer, and making
226   sure that is a multiple of the alignment.  This can lead to cases where a
227   program passes the alignment check by pure chance, because things "happened to
228   be" sufficiently aligned -- there is no UB in this execution but there would
229   be UB in others.  To avoid such cases, the symbolic alignment check only takes
230   into account the requested alignment of the relevant allocation, and the
231   offset into that allocation.  This avoids missing such bugs, but it also
232   incurs some false positives when the code does manual integer arithmetic to
233   ensure alignment.  (The standard library `align_to` method works fine in both
234   modes; under symbolic alignment it only fills the middle slice when the
235   allocation guarantees sufficient alignment.)
236 * `-Zmiri-track-alloc-id=<id>` shows a backtrace when the given allocation is
237   being allocated or freed.  This helps in debugging memory leaks and
238   use after free bugs.
239 * `-Zmiri-track-call-id=<id>` shows a backtrace when the given call id is
240   assigned to a stack frame.  This helps in debugging UB related to Stacked
241   Borrows "protectors".
242 * `-Zmiri-track-pointer-tag=<tag>` shows a backtrace when the given pointer tag
243   is popped from a borrow stack (which is where the tag becomes invalid and any
244   future use of it will error).  This helps you in finding out why UB is
245   happening and where in your code would be a good place to look for it.
246 * `-Zmiri-track-raw-pointers` makes Stacked Borrows track a pointer tag even for
247   raw pointers. This can make valid code fail to pass the checks, but also can
248   help identify latent aliasing issues in code that Miri accepts by default. You
249   can recognize false positives by "<untagged>" occurring in the message -- this
250   indicates a pointer that was cast from an integer, so Miri was unable to track
251   this pointer.
252
253 Some native rustc `-Z` flags are also very relevant for Miri:
254
255 * `-Zmir-opt-level` controls how many MIR optimizations are performed.  Miri
256   overrides the default to be `0`; be advised that using any higher level can
257   make Miri miss bugs in your program because they got optimized away.
258 * `-Zalways-encode-mir` makes rustc dump MIR even for completely monomorphic
259   functions.  This is needed so that Miri can execute such functions, so Miri
260   sets this flag per default.
261 * `-Zmir-emit-retag` controls whether `Retag` statements are emitted. Miri
262   enables this per default because it is needed for [Stacked Borrows].
263
264 Moreover, Miri recognizes some environment variables:
265
266 * `MIRI_LOG`, `MIRI_BACKTRACE` control logging and backtrace printing during
267   Miri executions, also [see "Testing the Miri driver" in `CONTRIBUTING.md`][testing-miri].
268 * `MIRIFLAGS` (recognized by `cargo miri` and the test suite) defines extra
269   flags to be passed to Miri.
270 * `MIRI_SYSROOT` (recognized by `cargo miri` and the test suite)
271   indicates the sysroot to use.  To do the same thing with `miri`
272   directly, use the `--sysroot` flag.
273 * `MIRI_TEST_TARGET` (recognized by the test suite) indicates which target
274   architecture to test against.  `miri` and `cargo miri` accept the `--target`
275   flag for the same purpose.
276
277 The following environment variables are internal, but used to communicate between
278 different Miri binaries, and as such worth documenting:
279
280 * `MIRI_BE_RUSTC` when set to any value tells the Miri driver to actually not
281   interpret the code but compile it like rustc would. This is useful to be sure
282   that the compiled `rlib`s are compatible with Miri.
283   When set while running `cargo-miri`, it indicates that we are part of a sysroot
284   build (for which some crates need special treatment).
285 * `MIRI_CWD` when set to any value tells the Miri driver to change to the given
286   directory after loading all the source files, but before commencing
287   interpretation. This is useful if the interpreted program wants a different
288   working directory at run-time than at build-time.
289   
290 [testing-miri]: CONTRIBUTING.md#testing-the-miri-driver
291
292 ## Miri `extern` functions
293
294 Miri provides some `extern` functions that programs can import to access
295 Miri-specific functionality:
296
297 ```rust
298 #[cfg(miri)]
299 extern "Rust" {
300     /// Miri-provided extern function to mark the block `ptr` points to as a "root"
301     /// for some static memory. This memory and everything reachable by it is not
302     /// considered leaking even if it still exists when the program terminates.
303     ///
304     /// `ptr` has to point to the beginning of an allocated block.
305     fn miri_static_root(ptr: *const u8);
306
307     /// Miri-provided extern function to obtain a backtrace of the current call stack.
308     /// This returns a boxed slice of pointers - each pointer is an opaque value
309     /// that is only useful when passed to `miri_resolve_frame`
310     /// The `flags` argument must be `0`.
311     fn miri_get_backtrace(flags: u64) -> Box<[*mut ()]>;
312
313     /// Miri-provided extern function to resolve a frame pointer obtained
314     /// from `miri_get_backtrace`. The `flags` argument must be `0`,
315     /// and `MiriFrame` should be declared as follows:
316     ///
317     /// ```rust
318     /// #[repr(C)]
319     /// struct MiriFrame {
320     ///     // The name of the function being executed, encoded in UTF-8
321     ///     name: Box<[u8]>,
322     ///     // The filename of the function being executed, encoded in UTF-8
323     ///     filename: Box<[u8]>,
324     ///     // The line number currently being executed in `filename`, starting from '1'.
325     ///     lineno: u32,
326     ///     // The column number currently being executed in `filename`, starting from '1'.
327     ///     colno: u32,
328     ///     // The function pointer to the function currently being executed.
329     ///     // This can be compared against function pointers obtained by
330     ///     // casting a function (e.g. `my_fn as *mut ()`)
331     ///     fn_ptr: *mut ()
332     /// }
333     /// ```
334     ///
335     /// The fields must be declared in exactly the same order as they appear in `MiriFrame` above.
336     /// This function can be called on any thread (not just the one which obtained `frame`).
337     fn miri_resolve_frame(frame: *mut (), flags: u64) -> MiriFrame;
338
339     /// Miri-provided extern function to begin unwinding with the given payload.
340     ///
341     /// This is internal and unstable and should not be used; we give it here
342     /// just to be complete.
343     fn miri_start_panic(payload: *mut u8) -> !;
344 }
345 ```
346
347 ## Contributing and getting help
348
349 If you want to contribute to Miri, great!  Please check out our
350 [contribution guide](CONTRIBUTING.md).
351
352 For help with running Miri, you can open an issue here on
353 GitHub or contact us (`oli-obk` and `RalfJ`) on the [Rust Zulip].
354
355 [Rust Zulip]: https://rust-lang.zulipchat.com
356
357 ## History
358
359 This project began as part of an undergraduate research course in 2015 by
360 @solson at the [University of Saskatchewan][usask].  There are [slides] and a
361 [report] available from that project.  In 2016, @oli-obk joined to prepare miri
362 for eventually being used as const evaluator in the Rust compiler itself
363 (basically, for `const` and `static` stuff), replacing the old evaluator that
364 worked directly on the AST.  In 2017, @RalfJung did an internship with Mozilla
365 and began developing miri towards a tool for detecting undefined behavior, and
366 also using miri as a way to explore the consequences of various possible
367 definitions for undefined behavior in Rust.  @oli-obk's move of the miri engine
368 into the compiler finally came to completion in early 2018.  Meanwhile, later
369 that year, @RalfJung did a second internship, developing miri further with
370 support for checking basic type invariants and verifying that references are
371 used according to their aliasing restrictions.
372
373 [usask]: https://www.usask.ca/
374 [slides]: https://solson.me/miri-slides.pdf
375 [report]: https://solson.me/miri-report.pdf
376
377 ## Bugs found by Miri
378
379 Miri has already found a number of bugs in the Rust standard library and beyond, which we collect here.
380
381 Definite bugs found:
382
383 * [`Debug for vec_deque::Iter` accessing uninitialized memory](https://github.com/rust-lang/rust/issues/53566)
384 * [`Vec::into_iter` doing an unaligned ZST read](https://github.com/rust-lang/rust/pull/53804)
385 * [`From<&[T]> for Rc` creating a not sufficiently aligned reference](https://github.com/rust-lang/rust/issues/54908)
386 * [`BTreeMap` creating a shared reference pointing to a too small allocation](https://github.com/rust-lang/rust/issues/54957)
387 * [`Vec::append` creating a dangling reference](https://github.com/rust-lang/rust/pull/61082)
388 * [Futures turning a shared reference into a mutable one](https://github.com/rust-lang/rust/pull/56319)
389 * [`str` turning a shared reference into a mutable one](https://github.com/rust-lang/rust/pull/58200)
390 * [`rand` performing unaligned reads](https://github.com/rust-random/rand/issues/779)
391 * [The Unix allocator calling `posix_memalign` in an invalid way](https://github.com/rust-lang/rust/issues/62251)
392 * [`getrandom` calling the `getrandom` syscall in an invalid way](https://github.com/rust-random/getrandom/pull/73)
393 * [`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
394 * [`beef` leaking memory](https://github.com/maciejhirsz/beef/issues/12)
395 * [`EbrCell` using uninitialized memory incorrectly](https://github.com/Firstyear/concread/commit/b15be53b6ec076acb295a5c0483cdb4bf9be838f#diff-6282b2fc8e98bd089a1f0c86f648157cR229)
396 * [TiKV performing an unaligned pointer access](https://github.com/tikv/tikv/issues/7613)
397 * [`servo_arc` creating a dangling shared reference](https://github.com/servo/servo/issues/26357)
398 * [TiKV constructing out-of-bounds pointers (and overlapping mutable references)](https://github.com/tikv/tikv/pull/7751)
399 * [`encoding_rs` doing out-of-bounds pointer arithmetic](https://github.com/hsivonen/encoding_rs/pull/53)
400 * [TiKV using `Vec::from_raw_parts` incorrectly](https://github.com/tikv/agatedb/pull/24)
401
402 Violations of [Stacked Borrows] found that are likely bugs (but Stacked Borrows is currently just an experiment):
403
404 * [`VecDeque::drain` creating overlapping mutable references](https://github.com/rust-lang/rust/pull/56161)
405 * Various `BTreeMap` problems
406     * [`BTreeMap` iterators creating mutable references that overlap with shared references](https://github.com/rust-lang/rust/pull/58431)
407     * [`BTreeMap::iter_mut` creating overlapping mutable references](https://github.com/rust-lang/rust/issues/73915)
408     * [`BTreeMap` node insertion using raw pointers outside their valid memory area](https://github.com/rust-lang/rust/issues/78477)
409 * [`LinkedList` cursor insertion creating overlapping mutable references](https://github.com/rust-lang/rust/pull/60072)
410 * [`Vec::push` invalidating existing references into the vector](https://github.com/rust-lang/rust/issues/60847)
411 * [`align_to_mut` violating uniqueness of mutable references](https://github.com/rust-lang/rust/issues/68549)
412 * [`sized-chunks` creating aliasing mutable references](https://github.com/bodil/sized-chunks/issues/8)
413 * [`String::push_str` invalidating existing references into the string](https://github.com/rust-lang/rust/issues/70301)
414 * [`ryu` using raw pointers outside their valid memory area](https://github.com/dtolnay/ryu/issues/24)
415 * [ink! creating overlapping mutable references](https://github.com/rust-lang/miri/issues/1364)
416 * [TiKV creating overlapping mutable reference and raw pointer](https://github.com/tikv/tikv/pull/7709)
417 * [Windows `Env` iterator using a raw pointer outside its valid memory area](https://github.com/rust-lang/rust/pull/70479)
418 * [`VecDeque::iter_mut` creating overlapping mutable references](https://github.com/rust-lang/rust/issues/74029)
419 * [Various standard library aliasing issues involving raw pointers](https://github.com/rust-lang/rust/pull/78602)
420
421 ## License
422
423 Licensed under either of
424
425   * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
426     http://www.apache.org/licenses/LICENSE-2.0)
427   * MIT license ([LICENSE-MIT](LICENSE-MIT) or
428     http://opensource.org/licenses/MIT)
429
430 at your option.
431
432 ### Contribution
433
434 Unless you explicitly state otherwise, any contribution intentionally submitted
435 for inclusion in the work by you shall be dual licensed as above, without any
436 additional terms or conditions.