Go to file
2017-02-14 10:19:18 +01:00
benches fix benchmarks and add benchmarks for repeat expressions 2016-11-18 10:38:07 +01:00
cargo-miri-test add tests for cargo miri and run them on travis 2017-01-28 11:57:53 +01:00
src fast path for zsts 2017-02-14 10:19:18 +01:00
tests Add test for closure drop. 2017-02-10 15:05:29 -08:00
tex fix tuple example in slides 2016-05-14 15:13:06 +10:00
.editorconfig Add EditorConfig 2016-04-14 14:54:59 +02:00
.gitignore add tests for cargo miri and run them on travis 2017-01-28 11:57:53 +01:00
.travis.yml travis cargo doesn't support custom subcommands 2017-01-28 16:14:32 +01:00
Cargo.lock get rid of serde rc3 dependencies through cargo update 2017-01-30 09:45:21 +01:00
Cargo.toml add cargo-miri subcommand to directly interpret the main binary of a crate 2017-01-28 11:57:52 +01:00
LICENSE-APACHE Add licenses and readme. 2016-02-02 04:47:28 -06:00
LICENSE-MIT Add licenses and readme. 2016-02-02 04:47:28 -06:00
README.md add docs for cargo miri 2017-02-02 12:59:41 +01:00

Miri [slides] [report] Build Status

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 prefixing them with rustup run nightly.

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 tests/run-pass/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.

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

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.