rust/README.md

82 lines
2.8 KiB
Markdown
Raw Normal View History

2016-06-19 01:08:43 -05:00
# Miri [[slides](https://solson.me/miri-slides.pdf)] [[report](https://solson.me/miri-report.pdf)] [![Build Status](https://travis-ci.org/solson/miri.svg?branch=master)](https://travis-ci.org/solson/miri)
2016-02-02 04:47:28 -06:00
An experimental interpreter for [Rust][rust]'s [mid-level intermediate
2016-04-13 19:47:03 -05:00
representation][mir] (MIR). This project began as part of my work for the
undergraduate research course at the [University of Saskatchewan][usask].
2016-02-02 04:47:28 -06:00
## Installing Rust
I recommend that you install [rustup][rustup] and then use it to install the
current Rust nightly version:
```sh
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.
```sh
rustup override add nightly
```
## Building Miri
```sh
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
2016-05-09 19:36:40 -05:00
how to fix it, you could send a PR. :smile:
## Running tests
```sh
2017-05-23 12:31:47 -05:00
cargo run --bin miri 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`.
2017-02-02 05:59:41 -06:00
## 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
2016-06-19 01:15:03 -05:00
Mozilla IRC in any of the Rust IRC channels (`#rust`, `#rust-offtopic`, etc).
2016-02-02 04:47:28 -06:00
## License
Licensed under either of
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](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.
[rust]: https://www.rust-lang.org/
[mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md
[usask]: https://www.usask.ca/
2016-04-15 09:50:47 -05:00
[rustup]: https://www.rustup.rs