Skip to content

Commit 3d83f53

Browse files
committed
Add docs
1 parent ab8d298 commit 3d83f53

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -531,6 +531,17 @@ extern "Rust" {
531531
/// This is internal and unstable and should not be used; we give it here
532532
/// just to be complete.
533533
fn miri_start_panic(payload: *mut u8) -> !;
534+
535+
/// Miri-provided extern function to get the internal unique identifier for the allocation that a pointer
536+
/// points to. This is only useful as an input to `miri_print_stacks`, and it is a separate call because
537+
/// getting a pointer to an allocation at runtime can change the borrow stacks in the allocation.
538+
fn miri_get_alloc_id(ptr: *const ()) -> u64;
539+
540+
/// Miri-provided extern function to print (from the interpreter, not the program) the contents of all
541+
/// borrow stacks in an allocation. The format of what this emits is unstable and may change at any time.
542+
/// In particular, users should be aware that Miri will periodically attempt to garbage collect the
543+
/// contents of all stacks. Callers of this function may wish to pass `-Zmiri-tag-gc=0` to disable the GC.
544+
fn miri_print_stacks(alloc_id: u64);
534545
}
535546
```
536547

0 commit comments

Comments
 (0)