5a7f4412ee
In order to implement infinite loop detection while executing MIR, both the implementor of `Machine` (`Evaluator`) and its associated type (`MemoryData`), must implement `Eq` and `Hash`. This PR adds the required trait implementations. It's possible that the `Hash` implementations need to be improved; only the `env_vars` field of `Evaluator` and the `thread_local` field of `MemoryData` are actually being hashed. Omitting fields from a `Hash` implementation is not incorrect, but could lead to collisions if the ignored fields are changing constantly. Perhaps I should instead derive `Hash` on a few more fields related to MIR validation? |
||
|---|---|---|
| benches | ||
| cargo-miri-test | ||
| rustc_tests | ||
| src | ||
| tests | ||
| tex | ||
| xargo | ||
| .editorconfig | ||
| .gitignore | ||
| .travis.yml | ||
| appveyor.yml | ||
| build.rs | ||
| Cargo.toml | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
| rust-toolchain | ||
Miri [slides] [report] 
An experimental interpreter for Rust's mid-level intermediate representation (MIR). This project began as part of my work for the undergraduate research course at the University of Saskatchewan.
Installing Rust
I recommend that you install rustup and then use it to install the current Rust nightly version:
rustup update nightly
You should also make nightly the default version for your Miri directory by
running the following command while you're in it. If you don't do this, you can
run the later cargo commands by using cargo +nightly instead.
rustup override add nightly
Building Miri
cargo build
If Miri fails to build, it's likely because a change in the latest nightly
compiler broke it. You could try an older nightly with rustup update nightly-<date> where <date> is a few days or weeks ago, e.g. 2016-05-20 for
May 20th. Otherwise, you could notify me in an issue or on IRC. Or, if you know
how to fix it, you could send a PR. 😄
Running tests
cargo run --bin miri tests/run-pass-fullmir/vecs.rs # Or whatever test you like.
Debugging
You can get detailed, statement-by-statement traces by setting the MIRI_LOG
environment variable to trace. These traces are indented based on call stack
depth. You can get a much less verbose set of information with other logging
levels such as warn.
Running miri on your own project('s test suite)
Install miri as a cargo subcommand with cargo install --debug.
Then, inside your own project, use cargo +nightly miri to run your project, if it is
a bin project, or run cargo +nightly miri test to run all tests in your project
through miri.
Running miri with full libstd
Per default libstd does not contain the MIR of non-polymorphic functions. When miri hits a call to such a function, execution terminates. To fix this, it is possible to compile libstd with full MIR:
rustup component add rust-src
cargo install xargo
cd xargo/
RUSTFLAGS='-Zalways-encode-mir' xargo build
Now you can run miri against the libstd compiled by xargo:
MIRI_SYSROOT=~/.xargo/HOST cargo run --bin miri tests/run-pass-fullmir/vecs.rs
Notice that you will have to re-run the last step of the preparations above when your toolchain changes (e.g., when you update the nightly).
Contributing and getting help
Check out the issues on this GitHub repository for some ideas. There's lots that
needs to be done that I haven't documented in the issues yet, however. For more
ideas or help with running or hacking on Miri, you can contact me (scott) on
Mozilla IRC in any of the Rust IRC channels (#rust, #rust-offtopic, etc).
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT) 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.