src/machine.rs

   1 //! Global machine state as well as implementation of the interpreter engine
   2 //! `Machine` trait.
   3
   4 use std::borrow::Cow;
   5 use std::cell::RefCell;
   6 use std::num::NonZeroU64;
   7 use std::rc::Rc;
   8 use std::time::Instant;
   9 use std::fmt;
  10
  11 use log::trace;
  12 use rand::rngs::StdRng;
  13
  14 use rustc_ast::attr;
  15 use rustc_data_structures::fx::FxHashMap;
  16 use rustc_middle::{
  17     mir,
  18     ty::{
  19         self,
  20         layout::{LayoutCx, LayoutError, TyAndLayout},
  21         TyCtxt,
  22     },
  23 };
  24 use rustc_span::symbol::{sym, Symbol};
  25 use rustc_target::abi::{LayoutOf, Size};
  26
  27 use crate::*;
  28
  29 // Some global facts about the emulated machine.
  30 pub const PAGE_SIZE: u64 = 4 * 1024; // FIXME: adjust to target architecture
  31 pub const STACK_ADDR: u64 = 32 * PAGE_SIZE; // not really about the "stack", but where we start assigning integer addresses to allocations
  32 pub const STACK_SIZE: u64 = 16 * PAGE_SIZE; // whatever
  33 pub const NUM_CPUS: u64 = 1;
  34
  35 /// Extra data stored with each stack frame
  36 #[derive(Debug)]
  37 pub struct FrameData<'tcx> {
  38     /// Extra data for Stacked Borrows.
  39     pub call_id: stacked_borrows::CallId,
  40
  41     /// If this is Some(), then this is a special "catch unwind" frame (the frame of `try_fn`
  42     /// called by `try`). When this frame is popped during unwinding a panic,
  43     /// we stop unwinding, use the `CatchUnwindData` to handle catching.
  44     pub catch_unwind: Option<CatchUnwindData<'tcx>>,
  45 }
  46
  47 /// Extra memory kinds
  48 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
  49 pub enum MiriMemoryKind {
  50     /// `__rust_alloc` memory.
  51     Rust,
  52     /// `malloc` memory.
  53     C,
  54     /// Windows `HeapAlloc` memory.
  55     WinHeap,
  56     /// Memory for args, errno, extern statics and other parts of the machine-managed environment.
  57     /// This memory may leak.
  58     Machine,
  59     /// Memory for env vars. Separate from `Machine` because we clean it up and leak-check it.
  60     Env,
  61     /// Globals copied from `tcx`.
  62     /// This memory may leak.
  63     Global,
  64 }
  65
  66 impl Into<MemoryKind<MiriMemoryKind>> for MiriMemoryKind {
  67     #[inline(always)]
  68     fn into(self) -> MemoryKind<MiriMemoryKind> {
  69         MemoryKind::Machine(self)
  70     }
  71 }
  72
  73 impl MayLeak for MiriMemoryKind {
  74     #[inline(always)]
  75     fn may_leak(self) -> bool {
  76         use self::MiriMemoryKind::*;
  77         match self {
  78             Rust | C | WinHeap | Env => false,
  79             Machine | Global => true,
  80         }
  81     }
  82 }
  83
  84 impl fmt::Display for MiriMemoryKind {
  85     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  86         use self::MiriMemoryKind::*;
  87         match self {
  88             Rust => write!(f, "Rust heap"),
  89             C => write!(f, "C heap"),
  90             WinHeap => write!(f, "Windows heap"),
  91             Machine => write!(f, "machine-managed memory"),
  92             Env => write!(f, "environment variable"),
  93             Global => write!(f, "global"),
  94         }
  95     }
  96 }
  97
  98 /// Extra per-allocation data
  99 #[derive(Debug, Clone)]
 100 pub struct AllocExtra {
 101     /// Stacked Borrows state is only added if it is enabled.
 102     pub stacked_borrows: Option<stacked_borrows::AllocExtra>,
 103 }
 104
 105 /// Extra global memory data
 106 #[derive(Clone, Debug)]
 107 pub struct MemoryExtra {
 108     pub stacked_borrows: Option<stacked_borrows::MemoryExtra>,
 109     pub intptrcast: intptrcast::MemoryExtra,
 110
 111     /// Mapping extern static names to their canonical allocation.
 112     extern_statics: FxHashMap<Symbol, AllocId>,
 113
 114     /// The random number generator used for resolving non-determinism.
 115     /// Needs to be queried by ptr_to_int, hence needs interior mutability.
 116     pub(crate) rng: RefCell<StdRng>,
 117
 118     /// An allocation ID to report when it is being allocated
 119     /// (helps for debugging memory leaks and use after free bugs).
 120     tracked_alloc_id: Option<AllocId>,
 121
 122     /// Controls whether alignment of memory accesses is being checked.
 123     check_alignment: bool,
 124 }
 125
 126 impl MemoryExtra {
 127     pub fn new(
 128         rng: StdRng,
 129         stacked_borrows: bool,
 130         tracked_pointer_tag: Option<PtrId>,
 131         tracked_alloc_id: Option<AllocId>,
 132         check_alignment: bool,
 133     ) -> Self {
 134         let stacked_borrows = if stacked_borrows {
 135             Some(Rc::new(RefCell::new(stacked_borrows::GlobalState::new(tracked_pointer_tag))))
 136         } else {
 137             None
 138         };
 139         MemoryExtra {
 140             stacked_borrows,
 141             intptrcast: Default::default(),
 142             extern_statics: FxHashMap::default(),
 143             rng: RefCell::new(rng),
 144             tracked_alloc_id,
 145             check_alignment,
 146         }
 147     }
 148
 149     fn add_extern_static<'tcx, 'mir>(
 150         this: &mut MiriEvalContext<'mir, 'tcx>,
 151         name: &str,
 152         ptr: Scalar<Tag>,
 153     ) {
 154         let ptr = ptr.assert_ptr();
 155         assert_eq!(ptr.offset, Size::ZERO);
 156         this.memory
 157             .extra
 158             .extern_statics
 159             .insert(Symbol::intern(name), ptr.alloc_id)
 160             .unwrap_none();
 161     }
 162
 163     /// Sets up the "extern statics" for this machine.
 164     pub fn init_extern_statics<'tcx, 'mir>(
 165         this: &mut MiriEvalContext<'mir, 'tcx>,
 166     ) -> InterpResult<'tcx> {
 167         match this.tcx.sess.target.target.target_os.as_str() {
 168             "linux" => {
 169                 // "__cxa_thread_atexit_impl"
 170                 // This should be all-zero, pointer-sized.
 171                 let layout = this.machine.layouts.usize;
 172                 let place = this.allocate(layout, MiriMemoryKind::Machine.into());
 173                 this.write_scalar(Scalar::from_machine_usize(0, this), place.into())?;
 174                 Self::add_extern_static(this, "__cxa_thread_atexit_impl", place.ptr);
 175                 // "environ"
 176                 Self::add_extern_static(this, "environ", this.machine.env_vars.environ.unwrap().ptr);
 177             }
 178             "windows" => {
 179                 // "_tls_used"
 180                 // This is some obscure hack that is part of the Windows TLS story. It's a `u8`.
 181                 let layout = this.machine.layouts.u8;
 182                 let place = this.allocate(layout, MiriMemoryKind::Machine.into());
 183                 this.write_scalar(Scalar::from_u8(0), place.into())?;
 184                 Self::add_extern_static(this, "_tls_used", place.ptr);
 185             }
 186             _ => {} // No "extern statics" supported on this target
 187         }
 188         Ok(())
 189     }
 190 }
 191
 192 /// Precomputed layouts of primitive types
 193 pub struct PrimitiveLayouts<'tcx> {
 194     pub unit: TyAndLayout<'tcx>,
 195     pub i8: TyAndLayout<'tcx>,
 196     pub i32: TyAndLayout<'tcx>,
 197     pub isize: TyAndLayout<'tcx>,
 198     pub u8: TyAndLayout<'tcx>,
 199     pub u32: TyAndLayout<'tcx>,
 200     pub usize: TyAndLayout<'tcx>,
 201 }
 202
 203 impl<'mir, 'tcx: 'mir> PrimitiveLayouts<'tcx> {
 204     fn new(layout_cx: LayoutCx<'tcx, TyCtxt<'tcx>>) -> Result<Self, LayoutError<'tcx>> {
 205         Ok(Self {
 206             unit: layout_cx.layout_of(layout_cx.tcx.mk_unit())?,
 207             i8: layout_cx.layout_of(layout_cx.tcx.types.i8)?,
 208             i32: layout_cx.layout_of(layout_cx.tcx.types.i32)?,
 209             isize: layout_cx.layout_of(layout_cx.tcx.types.isize)?,
 210             u8: layout_cx.layout_of(layout_cx.tcx.types.u8)?,
 211             u32: layout_cx.layout_of(layout_cx.tcx.types.u32)?,
 212             usize: layout_cx.layout_of(layout_cx.tcx.types.usize)?,
 213         })
 214     }
 215 }
 216
 217 /// The machine itself.
 218 pub struct Evaluator<'tcx> {
 219     /// Environment variables set by `setenv`.
 220     /// Miri does not expose env vars from the host to the emulated program.
 221     pub(crate) env_vars: EnvVars<'tcx>,
 222
 223     /// Program arguments (`Option` because we can only initialize them after creating the ecx).
 224     /// These are *pointers* to argc/argv because macOS.
 225     /// We also need the full command line as one string because of Windows.
 226     pub(crate) argc: Option<Scalar<Tag>>,
 227     pub(crate) argv: Option<Scalar<Tag>>,
 228     pub(crate) cmd_line: Option<Scalar<Tag>>,
 229
 230     /// Last OS error location in memory. It is a 32-bit integer.
 231     pub(crate) last_error: Option<MPlaceTy<'tcx, Tag>>,
 232
 233     /// TLS state.
 234     pub(crate) tls: TlsData<'tcx>,
 235
 236     /// If enabled, the `env_vars` field is populated with the host env vars during initialization
 237     /// and random number generation is delegated to the host.
 238     pub(crate) communicate: bool,
 239
 240     /// Whether to enforce the validity invariant.
 241     pub(crate) validate: bool,
 242
 243     pub(crate) file_handler: FileHandler,
 244     pub(crate) dir_handler: DirHandler,
 245
 246     /// The temporary used for storing the argument of
 247     /// the call to `miri_start_panic` (the panic payload) when unwinding.
 248     /// This is pointer-sized, and matches the `Payload` type in `src/libpanic_unwind/miri.rs`.
 249     pub(crate) panic_payload: Option<Scalar<Tag>>,
 250
 251     /// The "time anchor" for this machine's monotone clock (for `Instant` simulation).
 252     pub(crate) time_anchor: Instant,
 253
 254     /// Precomputed `TyLayout`s for primitive data types that are commonly used inside Miri.
 255     pub(crate) layouts: PrimitiveLayouts<'tcx>,
 256 }
 257
 258 impl<'tcx> Evaluator<'tcx> {
 259     pub(crate) fn new(
 260         communicate: bool,
 261         validate: bool,
 262         layout_cx: LayoutCx<'tcx, TyCtxt<'tcx>>,
 263     ) -> Self {
 264         let layouts = PrimitiveLayouts::new(layout_cx)
 265             .expect("Couldn't get layouts of primitive types");
 266         Evaluator {
 267             // `env_vars` could be initialized properly here if `Memory` were available before
 268             // calling this method.
 269             env_vars: EnvVars::default(),
 270             argc: None,
 271             argv: None,
 272             cmd_line: None,
 273             last_error: None,
 274             tls: TlsData::default(),
 275             communicate,
 276             validate,
 277             file_handler: Default::default(),
 278             dir_handler: Default::default(),
 279             panic_payload: None,
 280             time_anchor: Instant::now(),
 281             layouts,
 282         }
 283     }
 284 }
 285
 286 /// A rustc InterpCx for Miri.
 287 pub type MiriEvalContext<'mir, 'tcx> = InterpCx<'mir, 'tcx, Evaluator<'tcx>>;
 288
 289 /// A little trait that's useful to be inherited by extension traits.
 290 pub trait MiriEvalContextExt<'mir, 'tcx> {
 291     fn eval_context_ref<'a>(&'a self) -> &'a MiriEvalContext<'mir, 'tcx>;
 292     fn eval_context_mut<'a>(&'a mut self) -> &'a mut MiriEvalContext<'mir, 'tcx>;
 293 }
 294 impl<'mir, 'tcx> MiriEvalContextExt<'mir, 'tcx> for MiriEvalContext<'mir, 'tcx> {
 295     #[inline(always)]
 296     fn eval_context_ref(&self) -> &MiriEvalContext<'mir, 'tcx> {
 297         self
 298     }
 299     #[inline(always)]
 300     fn eval_context_mut(&mut self) -> &mut MiriEvalContext<'mir, 'tcx> {
 301         self
 302     }
 303 }
 304
 305 /// Machine hook implementations.
 306 impl<'mir, 'tcx> Machine<'mir, 'tcx> for Evaluator<'tcx> {
 307     type MemoryKind = MiriMemoryKind;
 308
 309     type FrameExtra = FrameData<'tcx>;
 310     type MemoryExtra = MemoryExtra;
 311     type AllocExtra = AllocExtra;
 312     type PointerTag = Tag;
 313     type ExtraFnVal = Dlsym;
 314
 315     type MemoryMap =
 316         MonoHashMap<AllocId, (MemoryKind<MiriMemoryKind>, Allocation<Tag, Self::AllocExtra>)>;
 317
 318     const GLOBAL_KIND: Option<MiriMemoryKind> = Some(MiriMemoryKind::Global);
 319
 320     #[inline(always)]
 321     fn enforce_alignment(memory_extra: &MemoryExtra) -> bool {
 322         memory_extra.check_alignment
 323     }
 324
 325     #[inline(always)]
 326     fn enforce_validity(ecx: &InterpCx<'mir, 'tcx, Self>) -> bool {
 327         ecx.machine.validate
 328     }
 329
 330     #[inline(always)]
 331     fn find_mir_or_eval_fn(
 332         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 333         instance: ty::Instance<'tcx>,
 334         args: &[OpTy<'tcx, Tag>],
 335         ret: Option<(PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
 336         unwind: Option<mir::BasicBlock>,
 337     ) -> InterpResult<'tcx, Option<&'mir mir::Body<'tcx>>> {
 338         ecx.find_mir_or_eval_fn(instance, args, ret, unwind)
 339     }
 340
 341     #[inline(always)]
 342     fn call_extra_fn(
 343         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 344         fn_val: Dlsym,
 345         args: &[OpTy<'tcx, Tag>],
 346         ret: Option<(PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
 347         _unwind: Option<mir::BasicBlock>,
 348     ) -> InterpResult<'tcx> {
 349         ecx.call_dlsym(fn_val, args, ret)
 350     }
 351
 352     #[inline(always)]
 353     fn call_intrinsic(
 354         ecx: &mut rustc_mir::interpret::InterpCx<'mir, 'tcx, Self>,
 355         instance: ty::Instance<'tcx>,
 356         args: &[OpTy<'tcx, Tag>],
 357         ret: Option<(PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
 358         unwind: Option<mir::BasicBlock>,
 359     ) -> InterpResult<'tcx> {
 360         ecx.call_intrinsic(instance, args, ret, unwind)
 361     }
 362
 363     #[inline(always)]
 364     fn assert_panic(
 365         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 366         msg: &mir::AssertMessage<'tcx>,
 367         unwind: Option<mir::BasicBlock>,
 368     ) -> InterpResult<'tcx> {
 369         ecx.assert_panic(msg, unwind)
 370     }
 371
 372     #[inline(always)]
 373     fn abort(_ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx, !> {
 374         throw_machine_stop!(TerminationInfo::Abort(None))
 375     }
 376
 377     #[inline(always)]
 378     fn binary_ptr_op(
 379         ecx: &rustc_mir::interpret::InterpCx<'mir, 'tcx, Self>,
 380         bin_op: mir::BinOp,
 381         left: ImmTy<'tcx, Tag>,
 382         right: ImmTy<'tcx, Tag>,
 383     ) -> InterpResult<'tcx, (Scalar<Tag>, bool, ty::Ty<'tcx>)> {
 384         ecx.binary_ptr_op(bin_op, left, right)
 385     }
 386
 387     fn box_alloc(
 388         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 389         dest: PlaceTy<'tcx, Tag>,
 390     ) -> InterpResult<'tcx> {
 391         trace!("box_alloc for {:?}", dest.layout.ty);
 392         let layout = ecx.layout_of(dest.layout.ty.builtin_deref(false).unwrap().ty)?;
 393         // First argument: `size`.
 394         // (`0` is allowed here -- this is expected to be handled by the lang item).
 395         let size = Scalar::from_machine_usize(layout.size.bytes(), ecx);
 396
 397         // Second argument: `align`.
 398         let align = Scalar::from_machine_usize(layout.align.abi.bytes(), ecx);
 399
 400         // Call the `exchange_malloc` lang item.
 401         let malloc = ecx.tcx.lang_items().exchange_malloc_fn().unwrap();
 402         let malloc = ty::Instance::mono(ecx.tcx.tcx, malloc);
 403         ecx.call_function(
 404             malloc,
 405             &[size.into(), align.into()],
 406             Some(dest),
 407             // Don't do anything when we are done. The `statement()` function will increment
 408             // the old stack frame's stmt counter to the next statement, which means that when
 409             // `exchange_malloc` returns, we go on evaluating exactly where we want to be.
 410             StackPopCleanup::None { cleanup: true },
 411         )?;
 412         Ok(())
 413     }
 414
 415     fn canonical_alloc_id(mem: &Memory<'mir, 'tcx, Self>, id: AllocId) -> AllocId {
 416         let tcx = mem.tcx;
 417         // Figure out if this is an extern static, and if yes, which one.
 418         let def_id = match tcx.alloc_map.lock().get(id) {
 419             Some(GlobalAlloc::Static(def_id)) if tcx.is_foreign_item(def_id) => def_id,
 420             _ => {
 421                 // No need to canonicalize anything.
 422                 return id;
 423             }
 424         };
 425         let attrs = tcx.get_attrs(def_id);
 426         let link_name = match attr::first_attr_value_str_by_name(&attrs, sym::link_name) {
 427             Some(name) => name,
 428             None => tcx.item_name(def_id),
 429         };
 430         // Check if we know this one.
 431         if let Some(canonical_id) = mem.extra.extern_statics.get(&link_name) {
 432             trace!("canonical_alloc_id: {:?} ({}) -> {:?}", id, link_name, canonical_id);
 433             *canonical_id
 434         } else {
 435             // Return original id; `Memory::get_static_alloc` will throw an error.
 436             id
 437         }
 438     }
 439
 440     fn init_allocation_extra<'b>(
 441         memory_extra: &MemoryExtra,
 442         id: AllocId,
 443         alloc: Cow<'b, Allocation>,
 444         kind: Option<MemoryKind<Self::MemoryKind>>,
 445     ) -> (Cow<'b, Allocation<Self::PointerTag, Self::AllocExtra>>, Self::PointerTag) {
 446         if Some(id) == memory_extra.tracked_alloc_id {
 447             register_diagnostic(NonHaltingDiagnostic::CreatedAlloc(id));
 448         }
 449
 450         let kind = kind.expect("we set our STATIC_KIND so this cannot be None");
 451         let alloc = alloc.into_owned();
 452         let (stacks, base_tag) =
 453             if let Some(stacked_borrows) = &memory_extra.stacked_borrows {
 454                 let (stacks, base_tag) =
 455                     Stacks::new_allocation(id, alloc.size, Rc::clone(stacked_borrows), kind);
 456                 (Some(stacks), base_tag)
 457             } else {
 458                 // No stacks, no tag.
 459                 (None, Tag::Untagged)
 460             };
 461         let mut stacked_borrows = memory_extra.stacked_borrows.as_ref().map(|sb| sb.borrow_mut());
 462         let alloc: Allocation<Tag, Self::AllocExtra> = alloc.with_tags_and_extra(
 463             |alloc| {
 464                 if let Some(stacked_borrows) = &mut stacked_borrows {
 465                     // Only globals may already contain pointers at this point
 466                     assert_eq!(kind, MiriMemoryKind::Global.into());
 467                     stacked_borrows.global_base_ptr(alloc)
 468                 } else {
 469                     Tag::Untagged
 470                 }
 471             },
 472             AllocExtra { stacked_borrows: stacks },
 473         );
 474         (Cow::Owned(alloc), base_tag)
 475     }
 476
 477     #[inline(always)]
 478     fn before_deallocation(
 479         memory_extra: &mut Self::MemoryExtra,
 480         id: AllocId,
 481     ) -> InterpResult<'tcx> {
 482         if Some(id) == memory_extra.tracked_alloc_id {
 483             register_diagnostic(NonHaltingDiagnostic::FreedAlloc(id));
 484         }
 485
 486         Ok(())
 487     }
 488
 489     #[inline(always)]
 490     fn tag_global_base_pointer(memory_extra: &MemoryExtra, id: AllocId) -> Self::PointerTag {
 491         if let Some(stacked_borrows) = &memory_extra.stacked_borrows {
 492             stacked_borrows.borrow_mut().global_base_ptr(id)
 493         } else {
 494             Tag::Untagged
 495         }
 496     }
 497
 498     #[inline(always)]
 499     fn retag(
 500         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 501         kind: mir::RetagKind,
 502         place: PlaceTy<'tcx, Tag>,
 503     ) -> InterpResult<'tcx> {
 504         if ecx.memory.extra.stacked_borrows.is_some() {
 505             ecx.retag(kind, place)
 506         } else {
 507             Ok(())
 508         }
 509     }
 510
 511     #[inline(always)]
 512     fn init_frame_extra(
 513         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 514         frame: Frame<'mir, 'tcx, Tag>,
 515     ) -> InterpResult<'tcx, Frame<'mir, 'tcx, Tag, FrameData<'tcx>>> {
 516         let stacked_borrows = ecx.memory.extra.stacked_borrows.as_ref();
 517         let call_id = stacked_borrows.map_or(NonZeroU64::new(1).unwrap(), |stacked_borrows| {
 518             stacked_borrows.borrow_mut().new_call()
 519         });
 520         let extra = FrameData { call_id, catch_unwind: None };
 521         Ok(frame.with_extra(extra))
 522     }
 523
 524     #[inline(always)]
 525     fn after_stack_push(ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx> {
 526         if ecx.memory.extra.stacked_borrows.is_some() {
 527             ecx.retag_return_place()
 528         } else {
 529             Ok(())
 530         }
 531     }
 532
 533     #[inline(always)]
 534     fn after_stack_pop(
 535         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 536         frame: Frame<'mir, 'tcx, Tag, FrameData<'tcx>>,
 537         unwinding: bool,
 538     ) -> InterpResult<'tcx, StackPopJump> {
 539         ecx.handle_stack_pop(frame.extra, unwinding)
 540     }
 541
 542     #[inline(always)]
 543     fn int_to_ptr(
 544         memory: &Memory<'mir, 'tcx, Self>,
 545         int: u64,
 546     ) -> InterpResult<'tcx, Pointer<Self::PointerTag>> {
 547         intptrcast::GlobalState::int_to_ptr(int, memory)
 548     }
 549
 550     #[inline(always)]
 551     fn ptr_to_int(
 552         memory: &Memory<'mir, 'tcx, Self>,
 553         ptr: Pointer<Self::PointerTag>,
 554     ) -> InterpResult<'tcx, u64> {
 555         intptrcast::GlobalState::ptr_to_int(ptr, memory)
 556     }
 557 }
 558
 559 impl AllocationExtra<Tag> for AllocExtra {
 560     #[inline(always)]
 561     fn memory_read<'tcx>(
 562         alloc: &Allocation<Tag, AllocExtra>,
 563         ptr: Pointer<Tag>,
 564         size: Size,
 565     ) -> InterpResult<'tcx> {
 566         if let Some(stacked_borrows) = &alloc.extra.stacked_borrows {
 567             stacked_borrows.memory_read(ptr, size)
 568         } else {
 569             Ok(())
 570         }
 571     }
 572
 573     #[inline(always)]
 574     fn memory_written<'tcx>(
 575         alloc: &mut Allocation<Tag, AllocExtra>,
 576         ptr: Pointer<Tag>,
 577         size: Size,
 578     ) -> InterpResult<'tcx> {
 579         if let Some(stacked_borrows) = &mut alloc.extra.stacked_borrows {
 580             stacked_borrows.memory_written(ptr, size)
 581         } else {
 582             Ok(())
 583         }
 584     }
 585
 586     #[inline(always)]
 587     fn memory_deallocated<'tcx>(
 588         alloc: &mut Allocation<Tag, AllocExtra>,
 589         ptr: Pointer<Tag>,
 590         size: Size,
 591     ) -> InterpResult<'tcx> {
 592         if let Some(stacked_borrows) = &mut alloc.extra.stacked_borrows {
 593             stacked_borrows.memory_deallocated(ptr, size)
 594         } else {
 595             Ok(())
 596         }
 597     }
 598 }