Skip to content

Commit

Permalink
Auto merge of #1635 - RalfJung:readme, r=oli-obk
Browse files Browse the repository at this point in the history
update README

Data races are detected now, but also the amount of non-determinism went way up so reword that point.
  • Loading branch information
bors committed Nov 30, 2020
2 parents d473242 + d697de7 commit c53d451
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,15 @@ in your program, and cannot run all programs:
still run fine in Miri -- but might break (including causing UB) on different
compiler versions or different platforms.
* Program execution is non-deterministic when it depends, for example, on where
exactly in memory allocations end up. Miri tests one of many possible
executions of your program. If your code is sensitive to allocation base
addresses or other non-deterministic data, try running Miri with different
values for `-Zmiri-seed` to test different executions.
exactly in memory allocations end up, or on the exact interleaving of
concurrent threads. Miri tests one of many possible executions of your
program. You can alleviate this to some extend by running Miri with different
values for `-Zmiri-seed`, but that will still by far not explore all possible
executions.
* Miri runs the program as a platform-independent interpreter, so the program
has no access to most platform-specific APIs or FFI. A few APIs have been
implemented (such as printing to stdout) but most have not: for example, Miri
currently does not support SIMD or networking.
* Miri currently does not check for data-races and most other concurrency-related
issues.

[rust]: https://www.rust-lang.org/
[mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md
Expand Down

0 comments on commit c53d451

Please sign in to comment.