Add `measureme` integration for profiling the interpreted program

[rust.git] / README.md

diff --git a/README.md b/README.md
index e0fbd9fafbb2901473d8e9f2eb1421c8df241917..87f6b87c6626949b82d57e7ca2a471a69bd9ac62 100644 (file)
--- a/README.md
+++ b/README.md
@@ -164,7 +164,7 @@ doesn't expose any environment to the program, so running
 `RUST_BACKTRACE=1 cargo miri test` will not do what you expect.
 
 To get a backtrace, you need to disable isolation
-[using `-Zmiri-disable-isolation`](#miri-flags):
+[using `-Zmiri-disable-isolation`][miri-flags]:
 
 ```sh
 RUST_BACKTRACE=1 MIRIFLAGS="-Zmiri-disable-isolation" cargo miri test
@@ -258,6 +258,10 @@ environment variable:
   this pointer. Note that it is not currently guaranteed that code that works
   with `-Zmiri-track-raw-pointers` also works without
   `-Zmiri-track-raw-pointers`, but for the vast majority of code, this will be the case.
+* `-Zmiri-measureme=<name>` enables `measureme` profiling for the interpreted program.
+   This can be used to find which parts of your program are executing slowly under Miri.
+   The profile is written out to a file with the prefix `<name>`, and can be processed
+   using the tools in the repository https://github.com/rust-lang/measureme
 
 Some native rustc `-Z` flags are also very relevant for Miri:
 
@@ -436,6 +440,7 @@ Violations of [Stacked Borrows] found that are likely bugs (but Stacked Borrows
 * [Windows `Env` iterator using a raw pointer outside its valid memory area](https://github.com/rust-lang/rust/pull/70479)
 * [`VecDeque::iter_mut` creating overlapping mutable references](https://github.com/rust-lang/rust/issues/74029)
 * [Various standard library aliasing issues involving raw pointers](https://github.com/rust-lang/rust/pull/78602)
+* [`<[T]>::copy_within` using a loan after invalidating it](https://github.com/rust-lang/rust/pull/85610)
 
 ## License