Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit 2baabf7

Browse files
committed
Auto merge of rust-lang#2240 - RalfJung:readme, r=RalfJung
readme Emulation of weak memory effects is not a kind of UB, so put it into a separate paragraph. Also remove the note about incomplete threading support. :)
2 parents c4dd3f4 + 3f94145 commit 2baabf7

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,15 @@ for example:
2121
* **Experimental**: Violations of the [Stacked Borrows] rules governing aliasing
2222
for reference types
2323
* **Experimental**: Data races
24-
* **Experimental**: Emulation of weak memory effects (i.e., reads can return outdated values)
2524

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

29+
Miri supports almost all Rust language features; in particular, unwinding and
30+
concurrency are properly supported (including some experimental emulation of
31+
weak memory effects, i.e., reads can return outdated values).
32+
3033
You can use Miri to emulate programs on other targets, e.g. to ensure that
3134
byte-level data manipulation works correctly both on little-endian and
3235
big-endian systems. See
@@ -62,8 +65,6 @@ in your program, and cannot run all programs:
6265
not support networking. System API support varies between targets; if you run
6366
on Windows it is a good idea to use `--target x86_64-unknown-linux-gnu` to get
6467
better support.
65-
* Threading support is not finished yet. E.g. spin loops (without syscalls) just
66-
loop forever. There is no threading support on Windows.
6768
* Weak memory emulation may produce weak behaivours unobservable by compiled
6869
programs running on real hardware when `SeqCst` fences are used, and it cannot
6970
produce all behaviors possibly observable on real hardware.

0 commit comments

Comments
 (0)