ask people to reach out if we declare too much UB

Author: RalfJung

src/diagnostics.rs

@@ -224,11 +224,11 @@ pub fn report_error<'tcx, 'mir>(
                     (None, format!("or pass `-Zmiri-isolation-error=warn` to configure Miri to return an error code from isolated operations (if supported for that operation) and continue with a warning")),
                 ],
             StackedBorrowsUb { help, history, .. } => {
-                let url = "https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md";
                 msg.extend(help.clone());
                 let mut helps = vec![
                     (None, format!("this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental")),
-                    (None, format!("see {url} for further information")),
+                    (None, format!("see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information")),
+                    (None, format!("please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling")),
                 ];
                 if let Some(TagHistory {created, invalidated, protected}) = history.clone() {
                     helps.push((Some(created.1), created.0));

tests/fail/both_borrows/alias_through_mutation.stack.stderr

@@ -9,6 +9,7 @@ LL |     let _val = *target_alias;
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x0..0x4]
   --> $DIR/alias_through_mutation.rs:LL:CC
    |

tests/fail/both_borrows/aliasing_mut1.stack.stderr

@@ -6,6 +6,7 @@ LL | pub fn safe(x: &mut i32, y: &mut i32) {
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a Unique retag at offsets [0x0..0x4]
   --> $DIR/aliasing_mut1.rs:LL:CC
    |

tests/fail/both_borrows/aliasing_mut2.stack.stderr

@@ -6,6 +6,7 @@ LL | pub fn safe(x: &i32, y: &mut i32) {
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a Unique retag at offsets [0x0..0x4]
   --> $DIR/aliasing_mut2.rs:LL:CC
    |

tests/fail/both_borrows/aliasing_mut3.stack.stderr

@@ -9,6 +9,7 @@ LL | pub fn safe(x: &mut i32, y: &i32) {
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x0..0x4]
   --> $DIR/aliasing_mut3.rs:LL:CC
    |

tests/fail/both_borrows/aliasing_mut4.stack.stderr

@@ -6,6 +6,7 @@ LL | pub fn safe(x: &i32, y: &mut Cell<i32>) {
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a Unique retag at offsets [0x0..0x4]
   --> $DIR/aliasing_mut4.rs:LL:CC
    |

tests/fail/both_borrows/box_exclusive_violation1.stack.stderr

@@ -9,6 +9,7 @@ LL |         *LEAK = 7;
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x0..0x4]
   --> $DIR/box_exclusive_violation1.rs:LL:CC
    |

tests/fail/both_borrows/box_noalias_violation.stack.stderr

@@ -6,6 +6,7 @@ LL |     *y
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadWrite retag at offsets [0x0..0x4]
   --> $DIR/box_noalias_violation.rs:LL:CC
    |

tests/fail/both_borrows/buggy_as_mut_slice.stack.stderr

@@ -9,6 +9,7 @@ LL |     v1[1] = 5;
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a Unique retag at offsets [0x0..0xc]
   --> $DIR/buggy_as_mut_slice.rs:LL:CC
    |

tests/fail/both_borrows/buggy_split_at_mut.stack.stderr

@@ -12,6 +12,7 @@ LL | |             )
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a Unique retag at offsets [0x0..0x10]
   --> $DIR/buggy_split_at_mut.rs:LL:CC
    |

tests/fail/both_borrows/illegal_write1.stack.stderr

@@ -9,6 +9,7 @@ LL |         unsafe { *x = 42 };
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x0..0x4]
   --> $DIR/illegal_write1.rs:LL:CC
    |

tests/fail/both_borrows/illegal_write5.stack.stderr

@@ -9,6 +9,7 @@ LL |     let _val = *xref;
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a Unique retag at offsets [0x0..0x4]
   --> $DIR/illegal_write5.rs:LL:CC
    |

tests/fail/both_borrows/illegal_write6.stack.stderr

@@ -6,6 +6,7 @@ LL |     unsafe { *y = 2 };
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadWrite retag at offsets [0x0..0x4]
   --> $DIR/illegal_write6.rs:LL:CC
    |

tests/fail/both_borrows/invalidate_against_protector2.stack.stderr

@@ -6,6 +6,7 @@ LL |     unsafe { *x = 0 };
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadWrite retag at offsets [0x0..0x4]
   --> $DIR/invalidate_against_protector2.rs:LL:CC
    |

tests/fail/both_borrows/invalidate_against_protector3.stack.stderr

@@ -6,6 +6,7 @@ LL |     unsafe { *x = 0 };
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created here, as the base tag for ALLOC
   --> $DIR/invalidate_against_protector3.rs:LL:CC
    |

tests/fail/both_borrows/load_invalid_shr.stack.stderr

@@ -9,6 +9,7 @@ LL |     let _val = *xref_in_mem;
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x0..0x4]
   --> $DIR/load_invalid_shr.rs:LL:CC
    |

tests/fail/both_borrows/mut_exclusive_violation1.stack.stderr

@@ -9,6 +9,7 @@ LL |         *LEAK = 7;
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x0..0x4]
   --> $DIR/mut_exclusive_violation1.rs:LL:CC
    |

tests/fail/both_borrows/mut_exclusive_violation2.stack.stderr

@@ -9,6 +9,7 @@ LL |         let _val = *raw1;
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a Unique retag at offsets [0x0..0x4]
   --> $DIR/mut_exclusive_violation2.rs:LL:CC
    |

tests/fail/both_borrows/newtype_pair_retagging.stack.stderr

@@ -6,6 +6,7 @@ LL |         Box(unsafe { Unique::new_unchecked(raw) }, alloc)
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadWrite retag at offsets [0x0..0x4]
   --> $DIR/newtype_pair_retagging.rs:LL:CC
    |

tests/fail/both_borrows/newtype_retagging.stack.stderr

@@ -6,6 +6,7 @@ LL |         Box(unsafe { Unique::new_unchecked(raw) }, alloc)
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadWrite retag at offsets [0x0..0x4]
   --> $DIR/newtype_retagging.rs:LL:CC
    |

tests/fail/both_borrows/outdated_local.stack.stderr

@@ -9,6 +9,7 @@ LL |     assert_eq!(unsafe { *y }, 1);
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x0..0x4]
   --> $DIR/outdated_local.rs:LL:CC
    |

tests/fail/both_borrows/pass_invalid_shr.stack.stderr

@@ -9,6 +9,7 @@ LL |     foo(xref);
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x0..0x4]
   --> $DIR/pass_invalid_shr.rs:LL:CC
    |

tests/fail/both_borrows/pass_invalid_shr_option.stack.stderr

@@ -9,6 +9,7 @@ LL |     foo(some_xref);
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x0..0x4]
   --> $DIR/pass_invalid_shr_option.rs:LL:CC
    |

tests/fail/both_borrows/pass_invalid_shr_tuple.stack.stderr

@@ -9,6 +9,7 @@ LL |     foo(pair_xref);
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x0..0x4]
   --> $DIR/pass_invalid_shr_tuple.rs:LL:CC
    |

tests/fail/both_borrows/return_invalid_shr.stack.stderr

@@ -9,6 +9,7 @@ LL |     ret
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x4..0x8]
   --> $DIR/return_invalid_shr.rs:LL:CC
    |

tests/fail/both_borrows/return_invalid_shr_option.stack.stderr

@@ -9,6 +9,7 @@ LL |     ret
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x4..0x8]
   --> $DIR/return_invalid_shr_option.rs:LL:CC
    |

tests/fail/both_borrows/return_invalid_shr_tuple.stack.stderr

@@ -9,6 +9,7 @@ LL |     ret
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x4..0x8]
   --> $DIR/return_invalid_shr_tuple.rs:LL:CC
    |

tests/fail/both_borrows/shr_frozen_violation1.stack.stderr

@@ -9,6 +9,7 @@ LL |         *(x as *const i32 as *mut i32) = 7;
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x0..0x4]
   --> $DIR/shr_frozen_violation1.rs:LL:CC
    |

tests/fail/both_borrows/shr_frozen_violation2.stack.stderr

@@ -9,6 +9,7 @@ LL |         let _val = *frozen;
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadOnly retag at offsets [0x0..0x4]
   --> $DIR/shr_frozen_violation2.rs:LL:CC
    |

tests/fail/box-cell-alias.stderr

@@ -9,6 +9,7 @@ LL |     unsafe { (*ptr).set(20) };
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadWrite retag at offsets [0x0..0x1]
   --> $DIR/box-cell-alias.rs:LL:CC
    |

tests/fail/function_calls/arg_inplace_mutate.stack.stderr

@@ -6,6 +6,7 @@ LL |     unsafe { ptr.write(S(0)) };
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadWrite retag at offsets [0x0..0x4]
   --> $DIR/arg_inplace_mutate.rs:LL:CC
    |

tests/fail/function_calls/arg_inplace_observe_during.stack.stderr

@@ -6,6 +6,7 @@ LL |     unsafe { ptr.read() };
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadWrite retag at offsets [0x0..0x4]
   --> $DIR/arg_inplace_observe_during.rs:LL:CC
    |

tests/fail/function_calls/return_pointer_aliasing.stack.stderr

@@ -6,6 +6,7 @@ LL |     unsafe { ptr.read() };
    |
    = help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
    = help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
+   = help: please reach out to us (e.g. at <https://rust-lang.zulipchat.com/#narrow/stream/269128-miri>) if you find this troubling
 help: <TAG> was created by a SharedReadWrite retag at offsets [0x0..0x4]
   --> $DIR/return_pointer_aliasing.rs:LL:CC
    |