File tree 1 file changed +4
-1
lines changed
1 file changed +4
-1
lines changed Original file line number Diff line number Diff line change @@ -538,7 +538,9 @@ extern "Rust" {
538
538
fn miri_start_panic(payload : *mut u8) -> !;
539
539
540
540
/// Miri-provided extern function to get the internal unique identifier for the allocation that a pointer
541
- /// points to. This is only useful as an input to `miri_print_borrow_stacks`, and it is a separate call because
541
+ /// points to. If this pointer is invalid (not pointing to an allocation), interpretation will abort.
542
+ ///
543
+ /// This is only useful as an input to `miri_print_borrow_stacks`, and it is a separate call because
542
544
/// getting a pointer to an allocation at runtime can change the borrow stacks in the allocation.
543
545
/// This function should be considered unstable. It exists only to support `miri_print_borrow_stacks` and so
544
546
/// inherits all of its instability.
@@ -549,6 +551,7 @@ extern "Rust" {
549
551
/// The format of what this emits is unstable and may change at any time. In particular, users should be
550
552
/// aware that Miri will periodically attempt to garbage collect the contents of all stacks. Callers of
551
553
/// this function may wish to pass `-Zmiri-tag-gc=0` to disable the GC.
554
+ ///
552
555
/// This function is extremely unstable. At any time the format of its output may change, its signature may
553
556
/// change, or it may be removed entirely.
554
557
fn miri_print_borrow_stacks(alloc_id : u64);
You can’t perform that action at this time.
0 commit comments