fork/rust

git clone https://git.julia.blue/fork/rust

borsAuto merge of #103046 - JanBeh:PR_clarify_cmp_terminology, r=workingjubilee3bcad65fbf6

master
8 folders16 files

files

.github/workflows/
bench-cargo-miri/
cargo-miri/
miri-script/
src/
test-cargo-miri/
test_dependencies/
tests/
.editorconfig415 B
.gitattributes133 B
.gitignore141 B
.gitpod.yml205 B
CONTRIBUTING.md10.5 KiB
Cargo.lock29.8 KiB
Cargo.toml1.5 KiB
LICENSE-APACHE9.5 KiB
LICENSE-MIT1023 B
README.md36.8 KiB
build.rs298 B
ci.sh4.4 KiB
miri387 B
rust-version41 B
rustfmt.toml137 B
triagebot.toml296 B

Miri

An experimental interpreter for Rust's mid-level intermediate representation (MIR). It can run binaries and test suites of cargo projects and detect certain classes of undefined behavior, for example:

On top of that, Miri will also tell you about memory leaks: when there is memory still allocated at the end of the execution, and that memory is not reachable from a global static, Miri will raise an error.

Miri supports almost all Rust language features; in particular, unwinding and concurrency are properly supported (including some experimental emulation of weak memory effects, i.e., reads can return outdated values).

You can use Miri to emulate programs on other targets, e.g. to ensure that byte-level data manipulation works correctly both on little-endian and big-endian systems. See cross-interpretation below.

Miri has already discovered some real-world bugs. If you found a bug with Miri, we'd appreciate if you tell us and we'll add it to the list!

By default, Miri ensures a fully deterministic execution and isolates the program from the host system. Some APIs that would usually access the host, such as gathering entropy for random number generators, environment variables, and clocks, are replaced by deterministic "fake" implementations. Set MIRIFLAGS="-Zmiri-disable-isolation" to access the real system APIs instead. (In particular, the "fake" system RNG APIs make Miri not suited for cryptographic use! Do not generate keys using Miri.)

All that said, be aware that Miri will not catch all cases of undefined behavior in your program, and cannot run all programs:

Moreover, Miri fundamentally cannot tell you whether your code is sound. Soundness is the property of never causing undefined behavior when invoked from arbitrary safe code, even in combination with other sound code. In contrast, Miri can just tell you if a particular way of interacting with your code (e.g., a test suite) causes any undefined behavior. It is up to you to ensure sufficient coverage.

Using Miri

Install Miri on Rust nightly via rustup:

rustup +nightly component add miri

If rustup says the miri component is unavailable, that's because not all nightly releases come with all tools. Check out this website to determine a nightly version that comes with Miri and install that using rustup toolchain install nightly-YYYY-MM-DD. Either way, all of the following commands assume the right toolchain is pinned via rustup override set nightly or rustup override set nightly-YYYY-MM-DD. (Alternatively, use cargo +nightly/cargo +nightly-YYYY-MM-DD for each of the following commands.)

Now you can run your project in Miri:

  1. Run cargo clean to eliminate any cached dependencies. Miri needs your dependencies to be compiled the right way, that would not happen if they have previously already been compiled.
  2. To run all tests in your project through Miri, use cargo miri test.
  3. If you have a binary project, you can run it through Miri using cargo miri run.

The first time you run Miri, it will perform some extra setup and install some dependencies. It will ask you for confirmation before installing anything.

cargo miri run/test supports the exact same flags as cargo run/test. For example, cargo miri test filter only runs the tests containing filter in their name.

You can pass arguments to Miri via MIRIFLAGS. For example, MIRIFLAGS="-Zmiri-disable-stacked-borrows" cargo miri run runs the program without checking the aliasing of references.

When compiling code via cargo miri, the cfg(miri) config flag is set for code that will be interpret under Miri. You can use this to ignore test cases that fail under Miri because they do things Miri does not support:

#[test]
#[cfg_attr(miri, ignore)]
fn does_not_work_on_miri() {
    tokio::run(futures::future::ok::<_, ()>(()));
}

There is no way to list all the infinite things Miri cannot do, but the interpreter will explicitly tell you when it finds something unsupported:

error: unsupported operation: can't call foreign function: bind
    ...
    = help: this is likely not a bug in the program; it indicates that the program \
            performed an operation that the interpreter does not support

Cross-interpretation: running for different targets

Miri can not only run a binary or test suite for your host target, it can also perform cross-interpretation for arbitrary foreign targets: cargo miri run --target x86_64-unknown-linux-gnu will run your program as if it was a Linux program, no matter your host OS. This is particularly useful if you are using Windows, as the Linux target is much better supported than Windows targets.

You can also use this to test platforms with different properties than your host platform. For example cargo miri test --target s390x-unknown-linux-gnu will run your test suite on a big-endian target, which is useful for testing endian-sensitive code.

Running Miri on CI

To run Miri on CI, make sure that you handle the case where the latest nightly does not ship the Miri component because it currently does not build. rustup toolchain install --component knows how to handle this situation, so the following snippet should always work:

rustup toolchain install nightly --component miri
rustup override set nightly

cargo miri test

Here is an example job for GitHub Actions:

  miri:
    name: "Miri"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install Miri
        run: |
          rustup toolchain install nightly --component miri
          rustup override set nightly
          cargo miri setup
      - name: Test with Miri
        run: cargo miri test

The explicit cargo miri setup helps to keep the output of the actual test step clean.

Testing for alignment issues

Miri can sometimes miss misaligned accesses since allocations can "happen to be" aligned just right. You can use -Zmiri-symbolic-alignment-check to definitely catch all such issues, but that flag will also cause false positives when code does manual pointer arithmetic to account for alignment. Another alternative is to call Miri with various values for -Zmiri-seed; that will alter the randomness that is used to determine allocation base addresses. The following snippet calls Miri in a loop with different values for the seed:

for SEED in $(seq 0 255); do
  echo "Trying seed: $SEED"
  MIRIFLAGS=-Zmiri-seed=$SEED cargo miri test || { echo "Failing seed: $SEED"; break; };
done

Supported targets

Miri does not support all targets supported by Rust. The good news, however, is that no matter your host OS/platform, it is easy to run code for any target using --target!

The following targets are tested on CI and thus should always work (to the degree documented below):

However, even for targets that we do support, the degree of support for accessing platform APIs (such as the file system) differs between targets: generally, Linux targets have the best support, and macOS targets are usually on par. Windows is supported less well.

Running tests in parallel

Though it implements Rust threading, Miri itself is a single-threaded interpreter. This means that when running cargo miri test, you will probably see a dramatic increase in the amount of time it takes to run your whole test suite due to the inherent interpreter slowdown and a loss of parallelism.

You can get your test suite's parallelism back by running cargo miri nextest run -jN (note that you will need cargo-nextest installed). This works because cargo-nextest collects a list of all tests then launches a separate cargo miri run for each test. You will need to specify a -j or --test-threads; by default cargo miri nextest run runs one test at a time. For more details, see the cargo-nextest Miri documentation.

Note: This one-test-per-process model means that cargo miri test is able to detect data races where two tests race on a shared resource, but cargo miri nextest run will not detect such races.

Note: cargo-nextest does not support doctests, see https://github.com/nextest-rs/nextest/issues/16

Common Problems

When using the above instructions, you may encounter a number of confusing compiler errors.

"note: run with RUST_BACKTRACE=1 environment variable to display a backtrace"

You may see this when trying to get Miri to display a backtrace. By default, Miri doesn't expose any environment to the program, so running RUST_BACKTRACE=1 cargo miri test will not do what you expect.

To get a backtrace, you need to disable isolation using -Zmiri-disable-isolation:

RUST_BACKTRACE=1 MIRIFLAGS="-Zmiri-disable-isolation" cargo miri test

"found possibly newer version of crate std which <dependency> depends on"

Your build directory may contain artifacts from an earlier build that have/have not been built for Miri. Run cargo clean before switching from non-Miri to Miri builds and vice-versa.

"found crate std compiled by an incompatible version of rustc"

You may be running cargo miri with a different compiler version than the one used to build the custom libstd that Miri uses, and Miri failed to detect that. Try deleting ~/.cache/miri.

"no mir for std::rt::lang_start_internal"

This means the sysroot you are using was not compiled with Miri in mind. This should never happen when you use cargo miri because that takes care of setting up the sysroot. If you are using miri (the Miri driver) directly, see the contributors' guide for how to use ./miri to best do that.

Miri -Z flags and environment variables

Miri adds its own set of -Z flags, which are usually set via the MIRIFLAGS environment variable. We first document the most relevant and most commonly used flags:

The remaining flags are for advanced use only, and more likely to change or be removed. Some of these are unsound, which means they can lead to Miri failing to detect cases of undefined behavior in a program.

Some native rustc -Z flags are also very relevant for Miri:

Moreover, Miri recognizes some environment variables:

The following environment variables are internal and must not be used by anyone but Miri itself. They are used to communicate between different Miri binaries, and as such worth documenting:

Miri extern functions

Miri provides some extern functions that programs can import to access Miri-specific functionality. They are declared in /tests/utils/miri_extern.rs.

Contributing and getting help

If you want to contribute to Miri, great! Please check out our contribution guide.

For help with running Miri, you can open an issue here on GitHub or use the Miri stream on the Rust Zulip.

History

This project began as part of an undergraduate research course in 2015 by @solson at the University of Saskatchewan. There are slides and a report available from that project. In 2016, @oli-obk joined to prepare Miri for eventually being used as const evaluator in the Rust compiler itself (basically, for const and static stuff), replacing the old evaluator that worked directly on the AST. In 2017, @RalfJung did an internship with Mozilla and began developing Miri towards a tool for detecting undefined behavior, and also using Miri as a way to explore the consequences of various possible definitions for undefined behavior in Rust. @oli-obk's move of the Miri engine into the compiler finally came to completion in early 2018. Meanwhile, later that year, @RalfJung did a second internship, developing Miri further with support for checking basic type invariants and verifying that references are used according to their aliasing restrictions.

Bugs found by Miri

Miri has already found a number of bugs in the Rust standard library and beyond, which we collect here.

Definite bugs found:

Violations of Stacked Borrows found that are likely bugs (but Stacked Borrows is currently just an experiment):

Scientific papers employing Miri

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above, without any additional terms or conditions.