3 [![Actions build status][actions-badge]][actions-url]
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
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),
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
23 * **Experimental**: Data races (but no weak memory effects)
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.
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)
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
39 However, be aware that Miri will **not catch all cases of undefined behavior**
40 in your program, and cannot run all programs:
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 your 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.
47 In particular, Miri does currently not check that references point to valid data.
48 * If the program relies on unspecified details of how data is laid out, it will
49 still run fine in Miri -- but might break (including causing UB) on different
50 compiler versions or different platforms.
51 * Program execution is non-deterministic when it depends, for example, on where
52 exactly in memory allocations end up, or on the exact interleaving of
53 concurrent threads. Miri tests one of many possible executions of your
54 program. You can alleviate this to some extent by running Miri with different
55 values for `-Zmiri-seed`, but that will still by far not explore all possible
57 * Miri runs the program as a platform-independent interpreter, so the program
58 has no access to most platform-specific APIs or FFI. A few APIs have been
59 implemented (such as printing to stdout, accessing environment variables, and
60 basic file system access) but most have not: for example, Miri currently does
61 not support networking. System API support varies between targets; if you run
62 on Windows it is a good idea to use `--target x86_64-unknown-linux-gnu` to get
64 * Threading support is not finished yet. E.g., weak memory effects are not
65 emulated and spin loops (without syscalls) just loop forever. There is no
66 threading support on Windows.
68 [rust]: https://www.rust-lang.org/
69 [mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md
70 [`unreachable_unchecked`]: https://doc.rust-lang.org/stable/std/hint/fn.unreachable_unchecked.html
71 [`copy_nonoverlapping`]: https://doc.rust-lang.org/stable/std/ptr/fn.copy_nonoverlapping.html
72 [Stacked Borrows]: https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md
77 Install Miri on Rust nightly via `rustup`:
80 rustup +nightly component add miri
83 If `rustup` says the `miri` component is unavailable, that's because not all
84 nightly releases come with all tools. Check out
85 [this website](https://rust-lang.github.io/rustup-components-history) to
86 determine a nightly version that comes with Miri and install that using `rustup
87 toolchain install nightly-YYYY-MM-DD`. Either way, all of the following commands
88 assume the right toolchain is pinned via `rustup override set nightly` or
89 `rustup override set nightly-YYYY-MM-DD`. (Alternatively, use `cargo
90 +nightly`/`cargo +nightly-YYYY-MM-DD` for each of the following commands.)
92 Now you can run your project in Miri:
94 1. Run `cargo clean` to eliminate any cached dependencies. Miri needs your
95 dependencies to be compiled the right way, that would not happen if they have
96 previously already been compiled.
97 2. To run all tests in your project through Miri, use `cargo miri test`.
98 3. If you have a binary project, you can run it through Miri using `cargo miri run`.
100 The first time you run Miri, it will perform some extra setup and install some
101 dependencies. It will ask you for confirmation before installing anything.
103 `cargo miri run/test` supports the exact same flags as `cargo run/test`. For
104 example, `cargo miri test filter` only runs the tests containing `filter` in
107 You can pass arguments to Miri via `MIRIFLAGS`. For example,
108 `MIRIFLAGS="-Zmiri-disable-stacked-borrows" cargo miri run` runs the program
109 without checking the aliasing of references.
111 When compiling code via `cargo miri`, the `cfg(miri)` config flag is set for code
112 that will be interpret under Miri. You can use this to ignore test cases that fail
113 under Miri because they do things Miri does not support:
117 #[cfg_attr(miri, ignore)]
118 fn does_not_work_on_miri() {
119 tokio::run(futures::future::ok::<_, ()>(()));
123 There is no way to list all the infinite things Miri cannot do, but the
124 interpreter will explicitly tell you when it finds something unsupported:
127 error: unsupported operation: can't call foreign function: bind
129 = help: this is likely not a bug in the program; it indicates that the program \
130 performed an operation that the interpreter does not support
133 ### Cross-interpretation: running for different targets
135 Miri can not only run a binary or test suite for your host target, it can also
136 perform cross-interpretation for arbitrary foreign targets: `cargo miri run
137 --target x86_64-unknown-linux-gnu` will run your program as if it was a Linux
138 program, no matter your host OS. This is particularly useful if you are using
139 Windows, as the Linux target is much better supported than Windows targets.
141 You can also use this to test platforms with different properties than your host
142 platform. For example `cargo miri test --target mips64-unknown-linux-gnuabi64`
143 will run your test suite on a big-endian target, which is useful for testing
144 endian-sensitive code.
146 ### Running Miri on CI
148 To run Miri on CI, make sure that you handle the case where the latest nightly
149 does not ship the Miri component because it currently does not build. `rustup
150 toolchain install --component` knows how to handle this situation, so the
151 following snippet should always work:
154 rustup toolchain install nightly --component miri
155 rustup override set nightly
160 Here is an example job for GitHub Actions:
165 runs-on: ubuntu-latest
167 - uses: actions/checkout@v3
170 rustup toolchain install nightly --component miri
171 rustup override set nightly
173 - name: Test with Miri
177 The explicit `cargo miri setup` helps to keep the output of the actual test step
180 ### Testing for alignment issues
182 Miri can sometimes miss misaligned accesses since allocations can "happen to be"
183 aligned just right. You can use `-Zmiri-symbolic-alignment-check` to definitely
184 catch all such issues, but that flag will also cause false positives when code
185 does manual pointer arithmetic to account for alignment. Another alternative is
186 to call Miri with various values for `-Zmiri-seed`; that will alter the
187 randomness that is used to determine allocation base addresses. The following
188 snippet calls Miri in a loop with different values for the seed:
191 for seed in $({ echo obase=16; seq 255; } | bc); do
192 MIRIFLAGS=-Zmiri-seed=$seed cargo miri test || { echo "Last seed: $seed"; break; };
196 ### Supported targets
198 Miri does not support all targets supported by Rust. The good news, however, is
199 that no matter your host OS/platform, it is easy to run code for *any* target
202 The following targets are tested on CI and thus should always work (to the
203 degree documented below):
205 - The best-supported target is `x86_64-unknown-linux-gnu`. Miri releases are
206 blocked on things working with this target. Most other Linux targets should
207 also work well; we do run the test suite on `i686-unknown-linux-gnu` as a
208 32bit target and `mips64-unknown-linux-gnuabi64` as a big-endian target.
209 - `x86_64-apple-darwin` should work basically as well as Linux. We also test
210 `aarch64-apple-darwin`. However, we might ship Miri with a nightly even when
211 some features on these targets regress.
212 - `x86_64-pc-windows-msvc` works, but supports fewer features than the Linux and
213 Apple targets. For example, file system access and concurrency are not
214 supported on Windows. We also test `i686-pc-windows-msvc`, with the same
215 reduced feature set. We might ship Miri with a nightly even when some features
216 on these targets regress.
220 When using the above instructions, you may encounter a number of confusing compiler
223 #### "note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace"
225 You may see this when trying to get Miri to display a backtrace. By default, Miri
226 doesn't expose any environment to the program, so running
227 `RUST_BACKTRACE=1 cargo miri test` will not do what you expect.
229 To get a backtrace, you need to disable isolation
230 [using `-Zmiri-disable-isolation`][miri-flags]:
233 RUST_BACKTRACE=1 MIRIFLAGS="-Zmiri-disable-isolation" cargo miri test
236 #### "found possibly newer version of crate `std` which `<dependency>` depends on"
238 Your build directory may contain artifacts from an earlier build that have/have
239 not been built for Miri. Run `cargo clean` before switching from non-Miri to
240 Miri builds and vice-versa.
242 #### "found crate `std` compiled by an incompatible version of rustc"
244 You may be running `cargo miri` with a different compiler version than the one
245 used to build the custom libstd that Miri uses, and Miri failed to detect that.
246 Try deleting `~/.cache/miri`.
248 #### "no mir for `std::rt::lang_start_internal`"
250 This means the sysroot you are using was not compiled with Miri in mind. This
251 should never happen when you use `cargo miri` because that takes care of setting
252 up the sysroot. If you are using `miri` (the Miri driver) directly, see the
253 [contributors' guide](CONTRIBUTING.md) for how to use `./miri` to best do that.
256 ## Miri `-Z` flags and environment variables
257 [miri-flags]: #miri--z-flags-and-environment-variables
259 Miri adds its own set of `-Z` flags, which are usually set via the `MIRIFLAGS`
260 environment variable. We first document the most relevant and most commonly used flags:
262 * `-Zmiri-compare-exchange-weak-failure-rate=<rate>` changes the failure rate of
263 `compare_exchange_weak` operations. The default is `0.8` (so 4 out of 5 weak ops will fail).
264 You can change it to any value between `0.0` and `1.0`, where `1.0` means it
265 will always fail and `0.0` means it will never fail.
266 * `-Zmiri-disable-isolation` disables host isolation. As a consequence,
267 the program has access to host resources such as environment variables, file
268 systems, and randomness.
269 * `-Zmiri-isolation-error=<action>` configures Miri's response to operations
270 requiring host access while isolation is enabled. `abort`, `hide`, `warn`,
271 and `warn-nobacktrace` are the supported actions. The default is to `abort`,
272 which halts the machine. Some (but not all) operations also support continuing
273 execution with a "permission denied" error being returned to the program.
274 `warn` prints a full backtrace when that happen; `warn-nobacktrace` is less
275 verbose. `hide` hides the warning entirely.
276 * `-Zmiri-env-exclude=<var>` keeps the `var` environment variable isolated from the host so that it
277 cannot be accessed by the program. Can be used multiple times to exclude several variables. The
278 `TERM` environment variable is excluded by default to [speed up the test
279 harness](https://github.com/rust-lang/miri/issues/1702). This has no effect unless
280 `-Zmiri-disable-isolation` is also set.
281 * `-Zmiri-env-forward=<var>` forwards the `var` environment variable to the interpreted program. Can
282 be used multiple times to forward several variables. This has no effect if
283 `-Zmiri-disable-isolation` is set.
284 * `-Zmiri-ignore-leaks` disables the memory leak checker, and also allows some
285 remaining threads to exist when the main thread exits.
286 * `-Zmiri-seed=<hex>` configures the seed of the RNG that Miri uses to resolve
287 non-determinism. This RNG is used to pick base addresses for allocations. When
288 isolation is enabled (the default), this is also used to emulate system
289 entropy. The default seed is 0. You can increase test coverage by running Miri
290 multiple times with different seeds.
291 **NOTE**: This entropy is not good enough for cryptographic use! Do not
292 generate secret keys in Miri or perform other kinds of cryptographic
293 operations that rely on proper random numbers.
294 * `-Zmiri-strict-provenance` enables [strict
295 provenance](https://github.com/rust-lang/rust/issues/95228) checking in Miri. This means that
296 casting an integer to a pointer yields a result with 'invalid' provenance, i.e., with provenance
297 that cannot be used for any memory access. Also implies `-Zmiri-tag-raw-pointers` and
298 `-Zmiri-check-number-validity`.
300 The remaining flags are for advanced use only, and more likely to change or be removed.
301 Some of these are **unsound**, which means they can lead
302 to Miri failing to detect cases of undefined behavior in a program.
304 * `-Zmiri-allow-uninit-numbers` disables the check to ensure that number types (integer and float
305 types) always hold initialized data. (They must still be initialized when any actual operation,
306 such as arithmetic, is performed.) Using this flag is **unsound**. This has no effect when
307 `-Zmiri-disable-validation` is present.
308 * `-Zmiri-allow-ptr-int-transmute` makes Miri more accepting of transmutation between pointers and
309 integers via `mem::transmute` or union/pointer type punning. This has two effects: it disables the
310 check against integers storing a pointer (i.e., data with provenance), thus allowing
311 pointer-to-integer transmutation, and it treats integer-to-pointer transmutation as equivalent to
312 a cast. Using this flag is **unsound**.
313 * `-Zmiri-disable-abi-check` disables checking [function ABI]. Using this flag
315 * `-Zmiri-disable-alignment-check` disables checking pointer alignment, so you
316 can focus on other failures, but it means Miri can miss bugs in your program.
317 Using this flag is **unsound**.
318 * `-Zmiri-disable-data-race-detector` disables checking for data races. Using
319 this flag is **unsound**.
320 * `-Zmiri-disable-stacked-borrows` disables checking the experimental
321 [Stacked Borrows] aliasing rules. This can make Miri run faster, but it also
322 means no aliasing violations will be detected. Using this flag is **unsound**
323 (but the affected soundness rules are experimental).
324 * `-Zmiri-disable-validation` disables enforcing validity invariants, which are
325 enforced by default. This is mostly useful to focus on other failures (such
326 as out-of-bounds accesses) first. Setting this flag means Miri can miss bugs
327 in your program. However, this can also help to make Miri run faster. Using
328 this flag is **unsound**.
329 * `-Zmiri-measureme=<name>` enables `measureme` profiling for the interpreted program.
330 This can be used to find which parts of your program are executing slowly under Miri.
331 The profile is written out to a file with the prefix `<name>`, and can be processed
332 using the tools in the repository https://github.com/rust-lang/measureme.
333 * `-Zmiri-mute-stdout-stderr` silently ignores all writes to stdout and stderr,
334 but reports to the program that it did actually write. This is useful when you
335 are not interested in the actual program's output, but only want to see Miri's
337 * `-Zmiri-panic-on-unsupported` will makes some forms of unsupported functionality,
338 such as FFI and unsupported syscalls, panic within the context of the emulated
339 application instead of raising an error within the context of Miri (and halting
340 execution). Note that code might not expect these operations to ever panic, so
341 this flag can lead to strange (mis)behavior.
342 * `-Zmiri-permissive-provenance` is **experimental**. This will make Miri do a
343 best-effort attempt to implement the semantics of
344 [`expose_addr`](https://doc.rust-lang.org/nightly/std/primitive.pointer.html#method.expose_addr)
346 [`ptr::from_exposed_addr`](https://doc.rust-lang.org/nightly/std/ptr/fn.from_exposed_addr.html)
347 for pointer-to-int and int-to-pointer casts, respectively. This will
348 necessarily miss some bugs as those semantics are not efficiently
349 implementable in a sanitizer, but it will only miss bugs that concerns
350 memory/pointers which is subject to these operations. Also note that this flag
351 is currently incompatible with Stacked Borrows, so you will have to also pass
352 `-Zmiri-disable-stacked-borrows` to use this.
353 * `-Zmiri-symbolic-alignment-check` makes the alignment check more strict. By
354 default, alignment is checked by casting the pointer to an integer, and making
355 sure that is a multiple of the alignment. This can lead to cases where a
356 program passes the alignment check by pure chance, because things "happened to
357 be" sufficiently aligned -- there is no UB in this execution but there would
358 be UB in others. To avoid such cases, the symbolic alignment check only takes
359 into account the requested alignment of the relevant allocation, and the
360 offset into that allocation. This avoids missing such bugs, but it also
361 incurs some false positives when the code does manual integer arithmetic to
362 ensure alignment. (The standard library `align_to` method works fine in both
363 modes; under symbolic alignment it only fills the middle slice when the
364 allocation guarantees sufficient alignment.)
365 * `-Zmiri-track-alloc-id=<id1>,<id2>,...` shows a backtrace when the given allocations are
366 being allocated or freed. This helps in debugging memory leaks and
367 use after free bugs. Specifying this argument multiple times does not overwrite the previous
368 values, instead it appends its values to the list. Listing an id multiple times has no effect.
369 * `-Zmiri-track-call-id=<id1>,<id2>,...` shows a backtrace when the given call ids are
370 assigned to a stack frame. This helps in debugging UB related to Stacked
371 Borrows "protectors". Specifying this argument multiple times does not overwrite the previous
372 values, instead it appends its values to the list. Listing an id multiple times has no effect.
373 * `-Zmiri-track-pointer-tag=<tag1>,<tag2>,...` shows a backtrace when a given pointer tag
374 is popped from a borrow stack (which is where the tag becomes invalid and any
375 future use of it will error). This helps you in finding out why UB is
376 happening and where in your code would be a good place to look for it.
377 Specifying this argument multiple times does not overwrite the previous
378 values, instead it appends its values to the list. Listing a tag multiple times has no effect.
379 * `-Zmiri-tag-raw-pointers` makes Stacked Borrows assign proper tags even for raw pointers. This can
380 make valid code using int-to-ptr casts fail to pass the checks, but also can help identify latent
381 aliasing issues in code that Miri accepts by default. You can recognize false positives by
382 `<untagged>` occurring in the message -- this indicates a pointer that was cast from an integer,
383 so Miri was unable to track this pointer. Note that it is not currently guaranteed that code that
384 works with `-Zmiri-tag-raw-pointers` also works without `-Zmiri-tag-raw-pointers`, but for the
385 vast majority of code, this will be the case.
387 [function ABI]: https://doc.rust-lang.org/reference/items/functions.html#extern-function-qualifier
389 Some native rustc `-Z` flags are also very relevant for Miri:
391 * `-Zmir-opt-level` controls how many MIR optimizations are performed. Miri
392 overrides the default to be `0`; be advised that using any higher level can
393 make Miri miss bugs in your program because they got optimized away.
394 * `-Zalways-encode-mir` makes rustc dump MIR even for completely monomorphic
395 functions. This is needed so that Miri can execute such functions, so Miri
396 sets this flag per default.
397 * `-Zmir-emit-retag` controls whether `Retag` statements are emitted. Miri
398 enables this per default because it is needed for [Stacked Borrows].
400 Moreover, Miri recognizes some environment variables:
402 * `MIRI_LOG`, `MIRI_BACKTRACE` control logging and backtrace printing during
403 Miri executions, also [see "Testing the Miri driver" in `CONTRIBUTING.md`][testing-miri].
404 * `MIRIFLAGS` (recognized by `cargo miri` and the test suite) defines extra
405 flags to be passed to Miri.
406 * `MIRI_LIB_SRC` defines the directory where Miri expects the sources of the
407 standard library that it will build and use for interpretation. This directory
408 must point to the `library` subdirectory of a `rust-lang/rust` repository
409 checkout. Note that changing files in that directory does not automatically
410 trigger a re-build of the standard library; you have to clear the Miri build
411 cache manually (on Linux, `rm -rf ~/.cache/miri`).
412 * `MIRI_SYSROOT` (recognized by `cargo miri` and the test suite) indicates the
413 sysroot to use. Only set this if you do not want to use the automatically
414 created sysroot. (The `miri` driver sysroot is controlled via the `--sysroot`
416 * `MIRI_TEST_TARGET` (recognized by the test suite) indicates which target
417 architecture to test against. `miri` and `cargo miri` accept the `--target`
418 flag for the same purpose.
419 * `MIRI_BLESS` (recognized by the test suite) overwrite all `stderr` and `stdout` files
420 instead of checking whether the output matches.
421 * `MIRI_SKIP_UI_CHECKS` (recognized by the test suite) don't check whether the
422 `stderr` or `stdout` files match the actual output. Useful for the rustc test suite
423 which has subtle differences that we don't care about.
425 The following environment variables are *internal* and must not be used by
426 anyone but Miri itself. They are used to communicate between different Miri
427 binaries, and as such worth documenting:
429 * `MIRI_BE_RUSTC` can be set to `host` or `target`. It tells the Miri driver to
430 actually not interpret the code but compile it like rustc would. With `target`, Miri sets
431 some compiler flags to prepare the code for interpretation; with `host`, this is not done.
432 This environment variable is useful to be sure that the compiled `rlib`s are compatible
434 * `MIRI_CALLED_FROM_XARGO` is set during the Miri-induced `xargo` sysroot build,
435 which will re-invoke `cargo-miri` as the `rustc` to use for this build.
436 * `MIRI_CALLED_FROM_RUSTDOC` when set to any value tells `cargo-miri` that it is
437 running as a child process of `rustdoc`, which invokes it twice for each doc-test
438 and requires special treatment, most notably a check-only build before interpretation.
439 This is set by `cargo-miri` itself when running as a `rustdoc`-wrapper.
440 * `MIRI_CWD` when set to any value tells the Miri driver to change to the given
441 directory after loading all the source files, but before commencing
442 interpretation. This is useful if the interpreted program wants a different
443 working directory at run-time than at build-time.
444 * `MIRI_LOCAL_CRATES` is set by `cargo-miri` to tell the Miri driver which
445 crates should be given special treatment in diagnostics, in addition to the
446 crate currently being compiled.
447 * `MIRI_VERBOSE` when set to any value tells the various `cargo-miri` phases to
448 perform verbose logging.
450 [testing-miri]: CONTRIBUTING.md#testing-the-miri-driver
452 ## Miri `extern` functions
454 Miri provides some `extern` functions that programs can import to access
455 Miri-specific functionality:
460 /// Miri-provided extern function to mark the block `ptr` points to as a "root"
461 /// for some static memory. This memory and everything reachable by it is not
462 /// considered leaking even if it still exists when the program terminates.
464 /// `ptr` has to point to the beginning of an allocated block.
465 fn miri_static_root(ptr: *const u8);
467 // Miri-provided extern function to get the amount of frames in the current backtrace.
468 // The `flags` argument must be `0`.
469 fn miri_backtrace_size(flags: u64) -> usize;
471 /// Miri-provided extern function to obtain a backtrace of the current call stack.
472 /// This writes a slice of pointers into `buf` - each pointer is an opaque value
473 /// that is only useful when passed to `miri_resolve_frame`.
474 /// `buf` must have `miri_backtrace_size(0) * pointer_size` bytes of space.
475 /// The `flags` argument must be `1`.
476 fn miri_get_backtrace(flags: u64, buf: *mut *mut ());
478 /// Miri-provided extern function to resolve a frame pointer obtained
479 /// from `miri_get_backtrace`. The `flags` argument must be `1`,
480 /// and `MiriFrame` should be declared as follows:
484 /// struct MiriFrame {
485 /// // The size of the name of the function being executed, encoded in UTF-8
487 /// // The size of filename of the function being executed, encoded in UTF-8
488 /// filename_len: usize,
489 /// // The line number currently being executed in `filename`, starting from '1'.
491 /// // The column number currently being executed in `filename`, starting from '1'.
493 /// // The function pointer to the function currently being executed.
494 /// // This can be compared against function pointers obtained by
495 /// // casting a function (e.g. `my_fn as *mut ()`)
500 /// The fields must be declared in exactly the same order as they appear in `MiriFrame` above.
501 /// This function can be called on any thread (not just the one which obtained `frame`).
502 fn miri_resolve_frame(frame: *mut (), flags: u64) -> MiriFrame;
504 /// Miri-provided extern function to get the name and filename of the frame provided by `miri_resolve_frame`.
505 /// `name_buf` and `filename_buf` should be allocated with the `name_len` and `filename_len` fields of `MiriFrame`.
506 /// The flags argument must be `0`.
507 fn miri_resolve_frame_names(ptr: *mut (), flags: u64, name_buf: *mut u8, filename_buf: *mut u8);
509 /// Miri-provided extern function to begin unwinding with the given payload.
511 /// This is internal and unstable and should not be used; we give it here
512 /// just to be complete.
513 fn miri_start_panic(payload: *mut u8) -> !;
517 ## Contributing and getting help
519 If you want to contribute to Miri, great! Please check out our
520 [contribution guide](CONTRIBUTING.md).
522 For help with running Miri, you can open an issue here on
523 GitHub or use the [Miri stream on the Rust Zulip][zulip].
525 [zulip]: https://rust-lang.zulipchat.com/#narrow/stream/269128-miri
529 This project began as part of an undergraduate research course in 2015 by
530 @solson at the [University of Saskatchewan][usask]. There are [slides] and a
531 [report] available from that project. In 2016, @oli-obk joined to prepare Miri
532 for eventually being used as const evaluator in the Rust compiler itself
533 (basically, for `const` and `static` stuff), replacing the old evaluator that
534 worked directly on the AST. In 2017, @RalfJung did an internship with Mozilla
535 and began developing Miri towards a tool for detecting undefined behavior, and
536 also using Miri as a way to explore the consequences of various possible
537 definitions for undefined behavior in Rust. @oli-obk's move of the Miri engine
538 into the compiler finally came to completion in early 2018. Meanwhile, later
539 that year, @RalfJung did a second internship, developing Miri further with
540 support for checking basic type invariants and verifying that references are
541 used according to their aliasing restrictions.
543 [usask]: https://www.usask.ca/
544 [slides]: https://solson.me/miri-slides.pdf
545 [report]: https://solson.me/miri-report.pdf
547 ## Bugs found by Miri
549 Miri has already found a number of bugs in the Rust standard library and beyond, which we collect here.
553 * [`Debug for vec_deque::Iter` accessing uninitialized memory](https://github.com/rust-lang/rust/issues/53566)
554 * [`Vec::into_iter` doing an unaligned ZST read](https://github.com/rust-lang/rust/pull/53804)
555 * [`From<&[T]> for Rc` creating a not sufficiently aligned reference](https://github.com/rust-lang/rust/issues/54908)
556 * [`BTreeMap` creating a shared reference pointing to a too small allocation](https://github.com/rust-lang/rust/issues/54957)
557 * [`Vec::append` creating a dangling reference](https://github.com/rust-lang/rust/pull/61082)
558 * [Futures turning a shared reference into a mutable one](https://github.com/rust-lang/rust/pull/56319)
559 * [`str` turning a shared reference into a mutable one](https://github.com/rust-lang/rust/pull/58200)
560 * [`rand` performing unaligned reads](https://github.com/rust-random/rand/issues/779)
561 * [The Unix allocator calling `posix_memalign` in an invalid way](https://github.com/rust-lang/rust/issues/62251)
562 * [`getrandom` calling the `getrandom` syscall in an invalid way](https://github.com/rust-random/getrandom/pull/73)
563 * [`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
564 * [`beef` leaking memory](https://github.com/maciejhirsz/beef/issues/12)
565 * [`EbrCell` using uninitialized memory incorrectly](https://github.com/Firstyear/concread/commit/b15be53b6ec076acb295a5c0483cdb4bf9be838f#diff-6282b2fc8e98bd089a1f0c86f648157cR229)
566 * [TiKV performing an unaligned pointer access](https://github.com/tikv/tikv/issues/7613)
567 * [`servo_arc` creating a dangling shared reference](https://github.com/servo/servo/issues/26357)
568 * [TiKV constructing out-of-bounds pointers (and overlapping mutable references)](https://github.com/tikv/tikv/pull/7751)
569 * [`encoding_rs` doing out-of-bounds pointer arithmetic](https://github.com/hsivonen/encoding_rs/pull/53)
570 * [TiKV using `Vec::from_raw_parts` incorrectly](https://github.com/tikv/agatedb/pull/24)
571 * Incorrect doctests for [`AtomicPtr`](https://github.com/rust-lang/rust/pull/84052) and [`Box::from_raw_in`](https://github.com/rust-lang/rust/pull/84053)
572 * [Insufficient alignment in `ThinVec`](https://github.com/Gankra/thin-vec/pull/27)
573 * [`crossbeam-epoch` calling `assume_init` on a partly-initialized `MaybeUninit`](https://github.com/crossbeam-rs/crossbeam/pull/779)
574 * [`integer-encoding` dereferencing a misaligned pointer](https://github.com/dermesser/integer-encoding-rs/pull/23)
575 * [`rkyv` constructing a `Box<[u8]>` from an overaligned allocation](https://github.com/rkyv/rkyv/commit/a9417193a34757e12e24263178be8b2eebb72456)
577 Violations of [Stacked Borrows] found that are likely bugs (but Stacked Borrows is currently just an experiment):
579 * [`VecDeque::drain` creating overlapping mutable references](https://github.com/rust-lang/rust/pull/56161)
580 * Various `BTreeMap` problems
581 * [`BTreeMap` iterators creating mutable references that overlap with shared references](https://github.com/rust-lang/rust/pull/58431)
582 * [`BTreeMap::iter_mut` creating overlapping mutable references](https://github.com/rust-lang/rust/issues/73915)
583 * [`BTreeMap` node insertion using raw pointers outside their valid memory area](https://github.com/rust-lang/rust/issues/78477)
584 * [`LinkedList` cursor insertion creating overlapping mutable references](https://github.com/rust-lang/rust/pull/60072)
585 * [`Vec::push` invalidating existing references into the vector](https://github.com/rust-lang/rust/issues/60847)
586 * [`align_to_mut` violating uniqueness of mutable references](https://github.com/rust-lang/rust/issues/68549)
587 * [`sized-chunks` creating aliasing mutable references](https://github.com/bodil/sized-chunks/issues/8)
588 * [`String::push_str` invalidating existing references into the string](https://github.com/rust-lang/rust/issues/70301)
589 * [`ryu` using raw pointers outside their valid memory area](https://github.com/dtolnay/ryu/issues/24)
590 * [ink! creating overlapping mutable references](https://github.com/rust-lang/miri/issues/1364)
591 * [TiKV creating overlapping mutable reference and raw pointer](https://github.com/tikv/tikv/pull/7709)
592 * [Windows `Env` iterator using a raw pointer outside its valid memory area](https://github.com/rust-lang/rust/pull/70479)
593 * [`VecDeque::iter_mut` creating overlapping mutable references](https://github.com/rust-lang/rust/issues/74029)
594 * [Various standard library aliasing issues involving raw pointers](https://github.com/rust-lang/rust/pull/78602)
595 * [`<[T]>::copy_within` using a loan after invalidating it](https://github.com/rust-lang/rust/pull/85610)
597 ## Scientific papers employing Miri
599 * [Stacked Borrows: An Aliasing Model for Rust](https://plv.mpi-sws.org/rustbelt/stacked-borrows/)
600 * [Using Lightweight Formal Methods to Validate a Key-Value Storage Node in Amazon S3](https://www.amazon.science/publications/using-lightweight-formal-methods-to-validate-a-key-value-storage-node-in-amazon-s3)
601 * [SyRust: Automatic Testing of Rust Libraries with Semantic-Aware Program Synthesis](https://dl.acm.org/doi/10.1145/3453483.3454084)
605 Licensed under either of
607 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
608 http://www.apache.org/licenses/LICENSE-2.0)
609 * MIT license ([LICENSE-MIT](LICENSE-MIT) or
610 http://opensource.org/licenses/MIT)
616 Unless you explicitly state otherwise, any contribution intentionally submitted
617 for inclusion in the work by you shall be dual licensed as above, without any
618 additional terms or conditions.