src/stacked_borrows.rs

   1 //! Implements "Stacked Borrows".  See <https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md>
   2 //! for further information.
   3
   4 use std::cell::RefCell;
   5 use std::fmt;
   6 use std::num::NonZeroU64;
   7 use std::rc::Rc;
   8
   9 use log::trace;
  10
  11 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  12 use rustc_middle::mir::RetagKind;
  13 use rustc_middle::ty;
  14 use rustc_target::abi::{Align, LayoutOf, Size};
  15 use rustc_hir::Mutability;
  16
  17 use crate::*;
  18
  19 pub type PtrId = NonZeroU64;
  20 pub type CallId = NonZeroU64;
  21 pub type AllocExtra = Stacks;
  22
  23 /// Tracking pointer provenance
  24 #[derive(Copy, Clone, Hash, PartialEq, Eq)]
  25 pub enum Tag {
  26     Tagged(PtrId),
  27     Untagged,
  28 }
  29
  30 impl fmt::Debug for Tag {
  31     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  32         match self {
  33             Tag::Tagged(id) => write!(f, "<{}>", id),
  34             Tag::Untagged => write!(f, "<untagged>"),
  35         }
  36     }
  37 }
  38
  39 /// Indicates which permission is granted (by this item to some pointers)
  40 #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
  41 pub enum Permission {
  42     /// Grants unique mutable access.
  43     Unique,
  44     /// Grants shared mutable access.
  45     SharedReadWrite,
  46     /// Grants shared read-only access.
  47     SharedReadOnly,
  48     /// Grants no access, but separates two groups of SharedReadWrite so they are not
  49     /// all considered mutually compatible.
  50     Disabled,
  51 }
  52
  53 /// An item in the per-location borrow stack.
  54 #[derive(Copy, Clone, Hash, PartialEq, Eq)]
  55 pub struct Item {
  56     /// The permission this item grants.
  57     perm: Permission,
  58     /// The pointers the permission is granted to.
  59     tag: Tag,
  60     /// An optional protector, ensuring the item cannot get popped until `CallId` is over.
  61     protector: Option<CallId>,
  62 }
  63
  64 impl fmt::Debug for Item {
  65     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  66         write!(f, "[{:?} for {:?}", self.perm, self.tag)?;
  67         if let Some(call) = self.protector {
  68             write!(f, " (call {})", call)?;
  69         }
  70         write!(f, "]")?;
  71         Ok(())
  72     }
  73 }
  74
  75 /// Extra per-location state.
  76 #[derive(Clone, Debug, PartialEq, Eq)]
  77 pub struct Stack {
  78     /// Used *mostly* as a stack; never empty.
  79     /// Invariants:
  80     /// * Above a `SharedReadOnly` there can only be more `SharedReadOnly`.
  81     /// * Except for `Untagged`, no tag occurs in the stack more than once.
  82     borrows: Vec<Item>,
  83 }
  84
  85 /// Extra per-allocation state.
  86 #[derive(Clone, Debug)]
  87 pub struct Stacks {
  88     // Even reading memory can have effects on the stack, so we need a `RefCell` here.
  89     stacks: RefCell<RangeMap<Stack>>,
  90     // Pointer to global state
  91     global: MemoryExtra,
  92 }
  93
  94 /// Extra global state, available to the memory access hooks.
  95 #[derive(Debug)]
  96 pub struct GlobalState {
  97     /// Next unused pointer ID (tag).
  98     next_ptr_id: PtrId,
  99     /// Table storing the "base" tag for each allocation.
 100     /// The base tag is the one used for the initial pointer.
 101     /// We need this in a separate table to handle cyclic statics.
 102     base_ptr_ids: FxHashMap<AllocId, Tag>,
 103     /// Next unused call ID (for protectors).
 104     next_call_id: CallId,
 105     /// Those call IDs corresponding to functions that are still running.
 106     active_calls: FxHashSet<CallId>,
 107     /// The pointer id to trace
 108     tracked_pointer_tag: Option<PtrId>,
 109     /// The call id to trace
 110     tracked_call_id: Option<CallId>,
 111 }
 112 /// Memory extra state gives us interior mutable access to the global state.
 113 pub type MemoryExtra = Rc<RefCell<GlobalState>>;
 114
 115 /// Indicates which kind of access is being performed.
 116 #[derive(Copy, Clone, Hash, PartialEq, Eq)]
 117 pub enum AccessKind {
 118     Read,
 119     Write,
 120 }
 121
 122 impl fmt::Display for AccessKind {
 123     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 124         match self {
 125             AccessKind::Read => write!(f, "read access"),
 126             AccessKind::Write => write!(f, "write access"),
 127         }
 128     }
 129 }
 130
 131 /// Indicates which kind of reference is being created.
 132 /// Used by high-level `reborrow` to compute which permissions to grant to the
 133 /// new pointer.
 134 #[derive(Copy, Clone, Hash, PartialEq, Eq)]
 135 pub enum RefKind {
 136     /// `&mut` and `Box`.
 137     Unique { two_phase: bool },
 138     /// `&` with or without interior mutability.
 139     Shared,
 140     /// `*mut`/`*const` (raw pointers).
 141     Raw { mutable: bool },
 142 }
 143
 144 impl fmt::Display for RefKind {
 145     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 146         match self {
 147             RefKind::Unique { two_phase: false } => write!(f, "unique"),
 148             RefKind::Unique { two_phase: true } => write!(f, "unique (two-phase)"),
 149             RefKind::Shared => write!(f, "shared"),
 150             RefKind::Raw { mutable: true } => write!(f, "raw (mutable)"),
 151             RefKind::Raw { mutable: false } => write!(f, "raw (constant)"),
 152         }
 153     }
 154 }
 155
 156 /// Utilities for initialization and ID generation
 157 impl GlobalState {
 158     pub fn new(tracked_pointer_tag: Option<PtrId>, tracked_call_id: Option<CallId>) -> Self {
 159         GlobalState {
 160             next_ptr_id: NonZeroU64::new(1).unwrap(),
 161             base_ptr_ids: FxHashMap::default(),
 162             next_call_id: NonZeroU64::new(1).unwrap(),
 163             active_calls: FxHashSet::default(),
 164             tracked_pointer_tag,
 165             tracked_call_id,
 166         }
 167     }
 168
 169     fn new_ptr(&mut self) -> PtrId {
 170         let id = self.next_ptr_id;
 171         self.next_ptr_id = NonZeroU64::new(id.get() + 1).unwrap();
 172         id
 173     }
 174
 175     pub fn new_call(&mut self) -> CallId {
 176         let id = self.next_call_id;
 177         trace!("new_call: Assigning ID {}", id);
 178         if Some(id) == self.tracked_call_id {
 179             register_diagnostic(NonHaltingDiagnostic::CreatedCallId(id));
 180         }
 181         assert!(self.active_calls.insert(id));
 182         self.next_call_id = NonZeroU64::new(id.get() + 1).unwrap();
 183         id
 184     }
 185
 186     pub fn end_call(&mut self, id: CallId) {
 187         assert!(self.active_calls.remove(&id));
 188     }
 189
 190     fn is_active(&self, id: CallId) -> bool {
 191         self.active_calls.contains(&id)
 192     }
 193
 194     pub fn global_base_ptr(&mut self, id: AllocId) -> Tag {
 195         self.base_ptr_ids.get(&id).copied().unwrap_or_else(|| {
 196             let tag = Tag::Tagged(self.new_ptr());
 197             trace!("New allocation {:?} has base tag {:?}", id, tag);
 198             self.base_ptr_ids.insert(id, tag).unwrap_none();
 199             tag
 200         })
 201     }
 202 }
 203
 204 /// Error reporting
 205 fn err_sb_ub(msg: String) -> InterpError<'static> {
 206     err_machine_stop!(TerminationInfo::ExperimentalUb {
 207         msg,
 208         url: format!("https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md"),
 209     })
 210 }
 211
 212 // # Stacked Borrows Core Begin
 213
 214 /// We need to make at least the following things true:
 215 ///
 216 /// U1: After creating a `Uniq`, it is at the top.
 217 /// U2: If the top is `Uniq`, accesses must be through that `Uniq` or remove it it.
 218 /// U3: If an access happens with a `Uniq`, it requires the `Uniq` to be in the stack.
 219 ///
 220 /// F1: After creating a `&`, the parts outside `UnsafeCell` have our `SharedReadOnly` on top.
 221 /// F2: If a write access happens, it pops the `SharedReadOnly`.  This has three pieces:
 222 ///     F2a: If a write happens granted by an item below our `SharedReadOnly`, the `SharedReadOnly`
 223 ///          gets popped.
 224 ///     F2b: No `SharedReadWrite` or `Unique` will ever be added on top of our `SharedReadOnly`.
 225 /// F3: If an access happens with an `&` outside `UnsafeCell`,
 226 ///     it requires the `SharedReadOnly` to still be in the stack.
 227
 228 /// Core relation on `Permission` to define which accesses are allowed
 229 impl Permission {
 230     /// This defines for a given permission, whether it permits the given kind of access.
 231     fn grants(self, access: AccessKind) -> bool {
 232         // Disabled grants nothing. Otherwise, all items grant read access, and except for SharedReadOnly they grant write access.
 233         self != Permission::Disabled
 234             && (access == AccessKind::Read || self != Permission::SharedReadOnly)
 235     }
 236 }
 237
 238 /// Core per-location operations: access, dealloc, reborrow.
 239 impl<'tcx> Stack {
 240     /// Find the item granting the given kind of access to the given tag, and return where
 241     /// it is on the stack.
 242     fn find_granting(&self, access: AccessKind, tag: Tag) -> Option<usize> {
 243         self.borrows
 244             .iter()
 245             .enumerate() // we also need to know *where* in the stack
 246             .rev() // search top-to-bottom
 247             // Return permission of first item that grants access.
 248             // We require a permission with the right tag, ensuring U3 and F3.
 249             .find_map(
 250                 |(idx, item)| {
 251                     if tag == item.tag && item.perm.grants(access) { Some(idx) } else { None }
 252                 },
 253             )
 254     }
 255
 256     /// Find the first write-incompatible item above the given one --
 257     /// i.e, find the height to which the stack will be truncated when writing to `granting`.
 258     fn find_first_write_incompatible(&self, granting: usize) -> usize {
 259         let perm = self.borrows[granting].perm;
 260         match perm {
 261             Permission::SharedReadOnly => bug!("Cannot use SharedReadOnly for writing"),
 262             Permission::Disabled => bug!("Cannot use Disabled for anything"),
 263             // On a write, everything above us is incompatible.
 264             Permission::Unique => granting + 1,
 265             Permission::SharedReadWrite => {
 266                 // The SharedReadWrite *just* above us are compatible, to skip those.
 267                 let mut idx = granting + 1;
 268                 while let Some(item) = self.borrows.get(idx) {
 269                     if item.perm == Permission::SharedReadWrite {
 270                         // Go on.
 271                         idx += 1;
 272                     } else {
 273                         // Found first incompatible!
 274                         break;
 275                     }
 276                 }
 277                 idx
 278             }
 279         }
 280     }
 281
 282     /// Check if the given item is protected.
 283     fn check_protector(item: &Item, tag: Option<Tag>, global: &GlobalState) -> InterpResult<'tcx> {
 284         if let Tag::Tagged(id) = item.tag {
 285             if Some(id) == global.tracked_pointer_tag {
 286                 register_diagnostic(NonHaltingDiagnostic::PoppedPointerTag(item.clone()));
 287             }
 288         }
 289         if let Some(call) = item.protector {
 290             if global.is_active(call) {
 291                 if let Some(tag) = tag {
 292                     Err(err_sb_ub(format!(
 293                         "not granting access to tag {:?} because incompatible item is protected: {:?}",
 294                         tag, item
 295                     )))?
 296                 } else {
 297                     Err(err_sb_ub(format!(
 298                         "deallocating while item is protected: {:?}",
 299                         item
 300                     )))?
 301                 }
 302             }
 303         }
 304         Ok(())
 305     }
 306
 307     /// Test if a memory `access` using pointer tagged `tag` is granted.
 308     /// If yes, return the index of the item that granted it.
 309     fn access(&mut self, access: AccessKind, tag: Tag, global: &GlobalState) -> InterpResult<'tcx> {
 310         // Two main steps: Find granting item, remove incompatible items above.
 311
 312         // Step 1: Find granting item.
 313         let granting_idx = self.find_granting(access, tag).ok_or_else(|| {
 314             err_sb_ub(format!(
 315                 "no item granting {} to tag {:?} found in borrow stack.",
 316                 access, tag
 317             ))
 318         })?;
 319
 320         // Step 2: Remove incompatible items above them.  Make sure we do not remove protected
 321         // items.  Behavior differs for reads and writes.
 322         if access == AccessKind::Write {
 323             // Remove everything above the write-compatible items, like a proper stack. This makes sure read-only and unique
 324             // pointers become invalid on write accesses (ensures F2a, and ensures U2 for write accesses).
 325             let first_incompatible_idx = self.find_first_write_incompatible(granting_idx);
 326             for item in self.borrows.drain(first_incompatible_idx..).rev() {
 327                 trace!("access: popping item {:?}", item);
 328                 Stack::check_protector(&item, Some(tag), global)?;
 329             }
 330         } else {
 331             // On a read, *disable* all `Unique` above the granting item.  This ensures U2 for read accesses.
 332             // The reason this is not following the stack discipline (by removing the first Unique and
 333             // everything on top of it) is that in `let raw = &mut *x as *mut _; let _val = *x;`, the second statement
 334             // would pop the `Unique` from the reborrow of the first statement, and subsequently also pop the
 335             // `SharedReadWrite` for `raw`.
 336             // This pattern occurs a lot in the standard library: create a raw pointer, then also create a shared
 337             // reference and use that.
 338             // We *disable* instead of removing `Unique` to avoid "connecting" two neighbouring blocks of SRWs.
 339             for idx in ((granting_idx + 1)..self.borrows.len()).rev() {
 340                 let item = &mut self.borrows[idx];
 341                 if item.perm == Permission::Unique {
 342                     trace!("access: disabling item {:?}", item);
 343                     Stack::check_protector(item, Some(tag), global)?;
 344                     item.perm = Permission::Disabled;
 345                 }
 346             }
 347         }
 348
 349         // Done.
 350         Ok(())
 351     }
 352
 353     /// Deallocate a location: Like a write access, but also there must be no
 354     /// active protectors at all because we will remove all items.
 355     fn dealloc(&mut self, tag: Tag, global: &GlobalState) -> InterpResult<'tcx> {
 356         // Step 1: Find granting item.
 357         self.find_granting(AccessKind::Write, tag).ok_or_else(|| {
 358             err_sb_ub(format!(
 359                 "no item granting write access for deallocation to tag {:?} found in borrow stack",
 360                 tag,
 361             ))
 362         })?;
 363
 364         // Step 2: Remove all items.  Also checks for protectors.
 365         for item in self.borrows.drain(..).rev() {
 366             Stack::check_protector(&item, None, global)?;
 367         }
 368
 369         Ok(())
 370     }
 371
 372     /// Derived a new pointer from one with the given tag.
 373     /// `weak` controls whether this operation is weak or strong: weak granting does not act as
 374     /// an access, and they add the new item directly on top of the one it is derived
 375     /// from instead of all the way at the top of the stack.
 376     fn grant(&mut self, derived_from: Tag, new: Item, global: &GlobalState) -> InterpResult<'tcx> {
 377         // Figure out which access `perm` corresponds to.
 378         let access =
 379             if new.perm.grants(AccessKind::Write) { AccessKind::Write } else { AccessKind::Read };
 380         // Now we figure out which item grants our parent (`derived_from`) this kind of access.
 381         // We use that to determine where to put the new item.
 382         let granting_idx = self.find_granting(access, derived_from)
 383             .ok_or_else(|| err_sb_ub(format!(
 384                 "trying to reborrow for {:?}, but parent tag {:?} does not have an appropriate item in the borrow stack",
 385                 new.perm, derived_from,
 386             )))?;
 387
 388         // Compute where to put the new item.
 389         // Either way, we ensure that we insert the new item in a way such that between
 390         // `derived_from` and the new one, there are only items *compatible with* `derived_from`.
 391         let new_idx = if new.perm == Permission::SharedReadWrite {
 392             assert!(
 393                 access == AccessKind::Write,
 394                 "this case only makes sense for stack-like accesses"
 395             );
 396             // SharedReadWrite can coexist with "existing loans", meaning they don't act like a write
 397             // access.  Instead of popping the stack, we insert the item at the place the stack would
 398             // be popped to (i.e., we insert it above all the write-compatible items).
 399             // This ensures F2b by adding the new item below any potentially existing `SharedReadOnly`.
 400             self.find_first_write_incompatible(granting_idx)
 401         } else {
 402             // A "safe" reborrow for a pointer that actually expects some aliasing guarantees.
 403             // Here, creating a reference actually counts as an access.
 404             // This ensures F2b for `Unique`, by removing offending `SharedReadOnly`.
 405             self.access(access, derived_from, global)?;
 406
 407             // We insert "as far up as possible": We know only compatible items are remaining
 408             // on top of `derived_from`, and we want the new item at the top so that we
 409             // get the strongest possible guarantees.
 410             // This ensures U1 and F1.
 411             self.borrows.len()
 412         };
 413
 414         // Put the new item there. As an optimization, deduplicate if it is equal to one of its new neighbors.
 415         if self.borrows[new_idx - 1] == new || self.borrows.get(new_idx) == Some(&new) {
 416             // Optimization applies, done.
 417             trace!("reborrow: avoiding adding redundant item {:?}", new);
 418         } else {
 419             trace!("reborrow: adding item {:?}", new);
 420             self.borrows.insert(new_idx, new);
 421         }
 422
 423         Ok(())
 424     }
 425 }
 426 // # Stacked Borrows Core End
 427
 428 /// Map per-stack operations to higher-level per-location-range operations.
 429 impl<'tcx> Stacks {
 430     /// Creates new stack with initial tag.
 431     fn new(size: Size, perm: Permission, tag: Tag, extra: MemoryExtra) -> Self {
 432         let item = Item { perm, tag, protector: None };
 433         let stack = Stack { borrows: vec![item] };
 434
 435         Stacks { stacks: RefCell::new(RangeMap::new(size, stack)), global: extra }
 436     }
 437
 438     /// Call `f` on every stack in the range.
 439     fn for_each(
 440         &self,
 441         ptr: Pointer<Tag>,
 442         size: Size,
 443         f: impl Fn(&mut Stack, &GlobalState) -> InterpResult<'tcx>,
 444     ) -> InterpResult<'tcx> {
 445         let global = self.global.borrow();
 446         let mut stacks = self.stacks.borrow_mut();
 447         for stack in stacks.iter_mut(ptr.offset, size) {
 448             f(stack, &*global)?;
 449         }
 450         Ok(())
 451     }
 452 }
 453
 454 /// Glue code to connect with Miri Machine Hooks
 455 impl Stacks {
 456     pub fn new_allocation(
 457         id: AllocId,
 458         size: Size,
 459         extra: MemoryExtra,
 460         kind: MemoryKind<MiriMemoryKind>,
 461     ) -> (Self, Tag) {
 462         let (tag, perm) = match kind {
 463             // New unique borrow. This tag is not accessible by the program,
 464             // so it will only ever be used when using the local directly (i.e.,
 465             // not through a pointer). That is, whenever we directly write to a local, this will pop
 466             // everything else off the stack, invalidating all previous pointers,
 467             // and in particular, *all* raw pointers.
 468             MemoryKind::Stack => (Tag::Tagged(extra.borrow_mut().new_ptr()), Permission::Unique),
 469             // `Global` memory can be referenced by global pointers from `tcx`.
 470             // Thus we call `global_base_ptr` such that the global pointers get the same tag
 471             // as what we use here.
 472             // `ExternStatic` is used for extern statics, and thus must also be listed here.
 473             // `Env` we list because we can get away with precise tracking there.
 474             // The base pointer is not unique, so the base permission is `SharedReadWrite`.
 475             MemoryKind::Machine(MiriMemoryKind::Global | MiriMemoryKind::ExternStatic | MiriMemoryKind::Tls | MiriMemoryKind::Env) =>
 476                 (extra.borrow_mut().global_base_ptr(id), Permission::SharedReadWrite),
 477             // Everything else we handle entirely untagged for now.
 478             // FIXME: experiment with more precise tracking.
 479             _ => (Tag::Untagged, Permission::SharedReadWrite),
 480         };
 481         (Stacks::new(size, perm, tag, extra), tag)
 482     }
 483
 484     #[inline(always)]
 485     pub fn memory_read<'tcx>(&self, ptr: Pointer<Tag>, size: Size) -> InterpResult<'tcx> {
 486         trace!("read access with tag {:?}: {:?}, size {}", ptr.tag, ptr.erase_tag(), size.bytes());
 487         self.for_each(ptr, size, |stack, global| {
 488             stack.access(AccessKind::Read, ptr.tag, global)?;
 489             Ok(())
 490         })
 491     }
 492
 493     #[inline(always)]
 494     pub fn memory_written<'tcx>(&mut self, ptr: Pointer<Tag>, size: Size) -> InterpResult<'tcx> {
 495         trace!("write access with tag {:?}: {:?}, size {}", ptr.tag, ptr.erase_tag(), size.bytes());
 496         self.for_each(ptr, size, |stack, global| {
 497             stack.access(AccessKind::Write, ptr.tag, global)?;
 498             Ok(())
 499         })
 500     }
 501
 502     #[inline(always)]
 503     pub fn memory_deallocated<'tcx>(
 504         &mut self,
 505         ptr: Pointer<Tag>,
 506         size: Size,
 507     ) -> InterpResult<'tcx> {
 508         trace!("deallocation with tag {:?}: {:?}, size {}", ptr.tag, ptr.erase_tag(), size.bytes());
 509         self.for_each(ptr, size, |stack, global| stack.dealloc(ptr.tag, global))
 510     }
 511 }
 512
 513 /// Retagging/reborrowing.  There is some policy in here, such as which permissions
 514 /// to grant for which references, and when to add protectors.
 515 impl<'mir, 'tcx: 'mir> EvalContextPrivExt<'mir, 'tcx> for crate::MiriEvalContext<'mir, 'tcx> {}
 516 trait EvalContextPrivExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
 517     fn reborrow(
 518         &mut self,
 519         place: MPlaceTy<'tcx, Tag>,
 520         size: Size,
 521         kind: RefKind,
 522         new_tag: Tag,
 523         protect: bool,
 524     ) -> InterpResult<'tcx> {
 525         let this = self.eval_context_mut();
 526         let protector = if protect { Some(this.frame().extra.call_id) } else { None };
 527         let ptr = place.ptr.assert_ptr();
 528         trace!(
 529             "reborrow: {} reference {:?} derived from {:?} (pointee {}): {:?}, size {}",
 530             kind,
 531             new_tag,
 532             ptr.tag,
 533             place.layout.ty,
 534             ptr.erase_tag(),
 535             size.bytes()
 536         );
 537
 538         // Get the allocation. It might not be mutable, so we cannot use `get_mut`.
 539         let extra = &this.memory.get_raw(ptr.alloc_id)?.extra;
 540         let stacked_borrows =
 541             extra.stacked_borrows.as_ref().expect("we should have Stacked Borrows data");
 542         // Update the stacks.
 543         // Make sure that raw pointers and mutable shared references are reborrowed "weak":
 544         // There could be existing unique pointers reborrowed from them that should remain valid!
 545         let perm = match kind {
 546             RefKind::Unique { two_phase: false } => Permission::Unique,
 547             RefKind::Unique { two_phase: true } => Permission::SharedReadWrite,
 548             RefKind::Raw { mutable: true } => Permission::SharedReadWrite,
 549             RefKind::Shared | RefKind::Raw { mutable: false } => {
 550                 // Shared references and *const are a whole different kind of game, the
 551                 // permission is not uniform across the entire range!
 552                 // We need a frozen-sensitive reborrow.
 553                 return this.visit_freeze_sensitive(place, size, |cur_ptr, size, frozen| {
 554                     // We are only ever `SharedReadOnly` inside the frozen bits.
 555                     let perm = if frozen {
 556                         Permission::SharedReadOnly
 557                     } else {
 558                         Permission::SharedReadWrite
 559                     };
 560                     let item = Item { perm, tag: new_tag, protector };
 561                     stacked_borrows.for_each(cur_ptr, size, |stack, global| {
 562                         stack.grant(cur_ptr.tag, item, global)
 563                     })
 564                 });
 565             }
 566         };
 567         let item = Item { perm, tag: new_tag, protector };
 568         stacked_borrows.for_each(ptr, size, |stack, global| stack.grant(ptr.tag, item, global))
 569     }
 570
 571     /// Retags an indidual pointer, returning the retagged version.
 572     /// `mutbl` can be `None` to make this a raw pointer.
 573     fn retag_reference(
 574         &mut self,
 575         val: ImmTy<'tcx, Tag>,
 576         kind: RefKind,
 577         protect: bool,
 578     ) -> InterpResult<'tcx, ImmTy<'tcx, Tag>> {
 579         let this = self.eval_context_mut();
 580         // We want a place for where the ptr *points to*, so we get one.
 581         let place = this.ref_to_mplace(val)?;
 582         let size = this
 583             .size_and_align_of_mplace(place)?
 584             .map(|(size, _)| size)
 585             .unwrap_or_else(|| place.layout.size);
 586         // `reborrow` relies on getting a `Pointer` and everything being in-bounds,
 587         // so let's ensure that. However, we do not care about alignment.
 588         // We can see dangling ptrs in here e.g. after a Box's `Unique` was
 589         // updated using "self.0 = ..." (can happen in Box::from_raw) so we cannot ICE; see miri#1050.
 590         let place = this.mplace_access_checked(place, Some(Align::from_bytes(1).unwrap()))?;
 591         // Nothing to do for ZSTs.
 592         if size == Size::ZERO {
 593             return Ok(val);
 594         }
 595
 596         // Compute new borrow.
 597         let new_tag = match kind {
 598             // Give up tracking for raw pointers.
 599             // FIXME: Experiment with more precise tracking. Blocked on `&raw`
 600             // because `Rc::into_raw` currently creates intermediate references,
 601             // breaking `Rc::from_raw`.
 602             RefKind::Raw { .. } => Tag::Untagged,
 603             // All other pointesr are properly tracked.
 604             _ => Tag::Tagged(
 605                 this.memory.extra.stacked_borrows.as_ref().unwrap().borrow_mut().new_ptr(),
 606             ),
 607         };
 608
 609         // Reborrow.
 610         this.reborrow(place, size, kind, new_tag, protect)?;
 611         let new_place = place.replace_tag(new_tag);
 612
 613         // Return new pointer.
 614         Ok(ImmTy::from_immediate(new_place.to_ref(), val.layout))
 615     }
 616 }
 617
 618 impl<'mir, 'tcx: 'mir> EvalContextExt<'mir, 'tcx> for crate::MiriEvalContext<'mir, 'tcx> {}
 619 pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
 620     fn retag(&mut self, kind: RetagKind, place: PlaceTy<'tcx, Tag>) -> InterpResult<'tcx> {
 621         let this = self.eval_context_mut();
 622         // Determine mutability and whether to add a protector.
 623         // Cannot use `builtin_deref` because that reports *immutable* for `Box`,
 624         // making it useless.
 625         fn qualify(ty: ty::Ty<'_>, kind: RetagKind) -> Option<(RefKind, bool)> {
 626             match ty.kind {
 627                 // References are simple.
 628                 ty::Ref(_, _, Mutability::Mut) => Some((
 629                     RefKind::Unique { two_phase: kind == RetagKind::TwoPhase },
 630                     kind == RetagKind::FnEntry,
 631                 )),
 632                 ty::Ref(_, _, Mutability::Not) =>
 633                     Some((RefKind::Shared, kind == RetagKind::FnEntry)),
 634                 // Raw pointers need to be enabled.
 635                 ty::RawPtr(tym) if kind == RetagKind::Raw =>
 636                     Some((RefKind::Raw { mutable: tym.mutbl == Mutability::Mut }, false)),
 637                 // Boxes do not get a protector: protectors reflect that references outlive the call
 638                 // they were passed in to; that's just not the case for boxes.
 639                 ty::Adt(..) if ty.is_box() => Some((RefKind::Unique { two_phase: false }, false)),
 640                 _ => None,
 641             }
 642         }
 643
 644         // We only reborrow "bare" references/boxes.
 645         // Not traversing into fields helps with <https://github.com/rust-lang/unsafe-code-guidelines/issues/125>,
 646         // but might also cost us optimization and analyses. We will have to experiment more with this.
 647         if let Some((mutbl, protector)) = qualify(place.layout.ty, kind) {
 648             // Fast path.
 649             let val = this.read_immediate(this.place_to_op(place)?)?;
 650             let val = this.retag_reference(val, mutbl, protector)?;
 651             this.write_immediate(*val, place)?;
 652         }
 653
 654         Ok(())
 655     }
 656
 657     /// After a stack frame got pushed, retag the return place so that we are sure
 658     /// it does not alias with anything.
 659     ///
 660     /// This is a HACK because there is nothing in MIR that would make the retag
 661     /// explicit. Also see https://github.com/rust-lang/rust/issues/71117.
 662     fn retag_return_place(&mut self) -> InterpResult<'tcx> {
 663         let this = self.eval_context_mut();
 664         let return_place = if let Some(return_place) = this.frame_mut().return_place {
 665             return_place
 666         } else {
 667             // No return place, nothing to do.
 668             return Ok(());
 669         };
 670         if return_place.layout.is_zst() {
 671             // There may not be any memory here, nothing to do.
 672             return Ok(());
 673         }
 674         // We need this to be in-memory to use tagged pointers.
 675         let return_place = this.force_allocation(return_place)?;
 676
 677         // We have to turn the place into a pointer to use the existing code.
 678         // (The pointer type does not matter, so we use a raw pointer.)
 679         let ptr_layout = this.layout_of(this.tcx.mk_mut_ptr(return_place.layout.ty))?;
 680         let val = ImmTy::from_immediate(return_place.to_ref(), ptr_layout);
 681         // Reborrow it.
 682         let val = this.retag_reference(val, RefKind::Unique { two_phase: false }, /*protector*/ true)?;
 683         // And use reborrowed pointer for return place.
 684         let return_place = this.ref_to_mplace(val)?;
 685         this.frame_mut().return_place = Some(return_place.into());
 686
 687         Ok(())
 688     }
 689 }