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::fmt;
   7 use std::num::NonZeroU64;
   8 use std::time::Instant;
   9
  10 use log::trace;
  11 use rand::rngs::StdRng;
  12 use rand::SeedableRng;
  13
  14 use rustc_data_structures::fx::FxHashMap;
  15 use rustc_middle::{
  16     mir,
  17     ty::{
  18         self,
  19         layout::{LayoutCx, LayoutError, TyAndLayout},
  20         Instance, TyCtxt,
  21     },
  22 };
  23 use rustc_span::def_id::DefId;
  24 use rustc_span::symbol::{sym, Symbol};
  25 use rustc_target::abi::{LayoutOf, Size};
  26 use rustc_target::spec::abi::Abi;
  27
  28 use crate::*;
  29
  30 // Some global facts about the emulated machine.
  31 pub const PAGE_SIZE: u64 = 4 * 1024; // FIXME: adjust to target architecture
  32 pub const STACK_ADDR: u64 = 32 * PAGE_SIZE; // not really about the "stack", but where we start assigning integer addresses to allocations
  33 pub const STACK_SIZE: u64 = 16 * PAGE_SIZE; // whatever
  34 pub const NUM_CPUS: u64 = 1;
  35
  36 /// Extra data stored with each stack frame
  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     /// If `measureme` profiling is enabled, holds timing information
  47     /// for the start of this frame. When we finish executing this frame,
  48     /// we use this to register a completed event with `measureme`.
  49     pub timing: Option<measureme::DetachedTiming>,
  50 }
  51
  52 impl<'tcx> std::fmt::Debug for FrameData<'tcx> {
  53     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
  54         // Omitting `timing`, it does not support `Debug`.
  55         f.debug_struct("FrameData")
  56             .field("call_id", &self.call_id)
  57             .field("catch_unwind", &self.catch_unwind)
  58             .finish()
  59     }
  60 }
  61
  62 /// Extra memory kinds
  63 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
  64 pub enum MiriMemoryKind {
  65     /// `__rust_alloc` memory.
  66     Rust,
  67     /// `malloc` memory.
  68     C,
  69     /// Windows `HeapAlloc` memory.
  70     WinHeap,
  71     /// Memory for args, errno, and other parts of the machine-managed environment.
  72     /// This memory may leak.
  73     Machine,
  74     /// Memory for env vars. Separate from `Machine` because we clean it up and leak-check it.
  75     Env,
  76     /// Globals copied from `tcx`.
  77     /// This memory may leak.
  78     Global,
  79     /// Memory for extern statics.
  80     /// This memory may leak.
  81     ExternStatic,
  82     /// Memory for thread-local statics.
  83     /// This memory may leak.
  84     Tls,
  85 }
  86
  87 impl Into<MemoryKind<MiriMemoryKind>> for MiriMemoryKind {
  88     #[inline(always)]
  89     fn into(self) -> MemoryKind<MiriMemoryKind> {
  90         MemoryKind::Machine(self)
  91     }
  92 }
  93
  94 impl MayLeak for MiriMemoryKind {
  95     #[inline(always)]
  96     fn may_leak(self) -> bool {
  97         use self::MiriMemoryKind::*;
  98         match self {
  99             Rust | C | WinHeap | Env => false,
 100             Machine | Global | ExternStatic | Tls => true,
 101         }
 102     }
 103 }
 104
 105 impl fmt::Display for MiriMemoryKind {
 106     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 107         use self::MiriMemoryKind::*;
 108         match self {
 109             Rust => write!(f, "Rust heap"),
 110             C => write!(f, "C heap"),
 111             WinHeap => write!(f, "Windows heap"),
 112             Machine => write!(f, "machine-managed memory"),
 113             Env => write!(f, "environment variable"),
 114             Global => write!(f, "global (static or const)"),
 115             ExternStatic => write!(f, "extern static"),
 116             Tls => write!(f, "thread-local static"),
 117         }
 118     }
 119 }
 120
 121 /// Extra per-allocation data
 122 #[derive(Debug, Clone)]
 123 pub struct AllocExtra {
 124     /// Stacked Borrows state is only added if it is enabled.
 125     pub stacked_borrows: Option<stacked_borrows::AllocExtra>,
 126     /// Data race detection via the use of a vector-clock,
 127     ///  this is only added if it is enabled.
 128     pub data_race: Option<data_race::AllocExtra>,
 129 }
 130
 131 /// Extra global memory data
 132 #[derive(Debug)]
 133 pub struct MemoryExtra {
 134     pub stacked_borrows: Option<stacked_borrows::MemoryExtra>,
 135     pub data_race: Option<data_race::MemoryExtra>,
 136     pub intptrcast: intptrcast::MemoryExtra,
 137
 138     /// Mapping extern static names to their canonical allocation.
 139     extern_statics: FxHashMap<Symbol, AllocId>,
 140
 141     /// The random number generator used for resolving non-determinism.
 142     /// Needs to be queried by ptr_to_int, hence needs interior mutability.
 143     pub(crate) rng: RefCell<StdRng>,
 144
 145     /// An allocation ID to report when it is being allocated
 146     /// (helps for debugging memory leaks and use after free bugs).
 147     tracked_alloc_id: Option<AllocId>,
 148
 149     /// Controls whether alignment of memory accesses is being checked.
 150     pub(crate) check_alignment: AlignmentCheck,
 151
 152     /// Failure rate of compare_exchange_weak, between 0.0 and 1.0
 153     pub(crate) cmpxchg_weak_failure_rate: f64,
 154 }
 155
 156 impl MemoryExtra {
 157     pub fn new(config: &MiriConfig) -> Self {
 158         let rng = StdRng::seed_from_u64(config.seed.unwrap_or(0));
 159         let stacked_borrows = if config.stacked_borrows {
 160             Some(RefCell::new(stacked_borrows::GlobalState::new(
 161                 config.tracked_pointer_tag,
 162                 config.tracked_call_id,
 163                 config.track_raw,
 164             )))
 165         } else {
 166             None
 167         };
 168         let data_race =
 169             if config.data_race_detector { Some(data_race::GlobalState::new()) } else { None };
 170         MemoryExtra {
 171             stacked_borrows,
 172             data_race,
 173             intptrcast: Default::default(),
 174             extern_statics: FxHashMap::default(),
 175             rng: RefCell::new(rng),
 176             tracked_alloc_id: config.tracked_alloc_id,
 177             check_alignment: config.check_alignment,
 178             cmpxchg_weak_failure_rate: config.cmpxchg_weak_failure_rate,
 179         }
 180     }
 181
 182     fn add_extern_static<'tcx, 'mir>(
 183         this: &mut MiriEvalContext<'mir, 'tcx>,
 184         name: &str,
 185         ptr: Scalar<Tag>,
 186     ) {
 187         let ptr = ptr.assert_ptr();
 188         assert_eq!(ptr.offset, Size::ZERO);
 189         this.memory.extra.extern_statics.try_insert(Symbol::intern(name), ptr.alloc_id).unwrap();
 190     }
 191
 192     /// Sets up the "extern statics" for this machine.
 193     pub fn init_extern_statics<'tcx, 'mir>(
 194         this: &mut MiriEvalContext<'mir, 'tcx>,
 195     ) -> InterpResult<'tcx> {
 196         match this.tcx.sess.target.os.as_str() {
 197             "linux" => {
 198                 // "__cxa_thread_atexit_impl"
 199                 // This should be all-zero, pointer-sized.
 200                 let layout = this.machine.layouts.usize;
 201                 let place = this.allocate(layout, MiriMemoryKind::ExternStatic.into());
 202                 this.write_scalar(Scalar::from_machine_usize(0, this), &place.into())?;
 203                 Self::add_extern_static(this, "__cxa_thread_atexit_impl", place.ptr);
 204                 // "environ"
 205                 Self::add_extern_static(
 206                     this,
 207                     "environ",
 208                     this.machine.env_vars.environ.unwrap().ptr,
 209                 );
 210             }
 211             "windows" => {
 212                 // "_tls_used"
 213                 // This is some obscure hack that is part of the Windows TLS story. It's a `u8`.
 214                 let layout = this.machine.layouts.u8;
 215                 let place = this.allocate(layout, MiriMemoryKind::ExternStatic.into());
 216                 this.write_scalar(Scalar::from_u8(0), &place.into())?;
 217                 Self::add_extern_static(this, "_tls_used", place.ptr);
 218             }
 219             _ => {} // No "extern statics" supported on this target
 220         }
 221         Ok(())
 222     }
 223 }
 224
 225 /// Precomputed layouts of primitive types
 226 pub struct PrimitiveLayouts<'tcx> {
 227     pub unit: TyAndLayout<'tcx>,
 228     pub i8: TyAndLayout<'tcx>,
 229     pub i32: TyAndLayout<'tcx>,
 230     pub isize: TyAndLayout<'tcx>,
 231     pub u8: TyAndLayout<'tcx>,
 232     pub u32: TyAndLayout<'tcx>,
 233     pub usize: TyAndLayout<'tcx>,
 234 }
 235
 236 impl<'mir, 'tcx: 'mir> PrimitiveLayouts<'tcx> {
 237     fn new(layout_cx: LayoutCx<'tcx, TyCtxt<'tcx>>) -> Result<Self, LayoutError<'tcx>> {
 238         Ok(Self {
 239             unit: layout_cx.layout_of(layout_cx.tcx.mk_unit())?,
 240             i8: layout_cx.layout_of(layout_cx.tcx.types.i8)?,
 241             i32: layout_cx.layout_of(layout_cx.tcx.types.i32)?,
 242             isize: layout_cx.layout_of(layout_cx.tcx.types.isize)?,
 243             u8: layout_cx.layout_of(layout_cx.tcx.types.u8)?,
 244             u32: layout_cx.layout_of(layout_cx.tcx.types.u32)?,
 245             usize: layout_cx.layout_of(layout_cx.tcx.types.usize)?,
 246         })
 247     }
 248 }
 249
 250 /// The machine itself.
 251 pub struct Evaluator<'mir, 'tcx> {
 252     /// Environment variables set by `setenv`.
 253     /// Miri does not expose env vars from the host to the emulated program.
 254     pub(crate) env_vars: EnvVars<'tcx>,
 255
 256     /// Program arguments (`Option` because we can only initialize them after creating the ecx).
 257     /// These are *pointers* to argc/argv because macOS.
 258     /// We also need the full command line as one string because of Windows.
 259     pub(crate) argc: Option<Scalar<Tag>>,
 260     pub(crate) argv: Option<Scalar<Tag>>,
 261     pub(crate) cmd_line: Option<Scalar<Tag>>,
 262
 263     /// TLS state.
 264     pub(crate) tls: TlsData<'tcx>,
 265
 266     /// If enabled, the `env_vars` field is populated with the host env vars during initialization
 267     /// and random number generation is delegated to the host.
 268     pub(crate) communicate: bool,
 269
 270     /// Whether to enforce the validity invariant.
 271     pub(crate) validate: bool,
 272
 273     /// Whether to enforce [ABI](Abi) of function calls.
 274     pub(crate) enforce_abi: bool,
 275
 276     pub(crate) file_handler: shims::posix::FileHandler,
 277     pub(crate) dir_handler: shims::posix::DirHandler,
 278
 279     /// The "time anchor" for this machine's monotone clock (for `Instant` simulation).
 280     pub(crate) time_anchor: Instant,
 281
 282     /// The set of threads.
 283     pub(crate) threads: ThreadManager<'mir, 'tcx>,
 284
 285     /// Precomputed `TyLayout`s for primitive data types that are commonly used inside Miri.
 286     pub(crate) layouts: PrimitiveLayouts<'tcx>,
 287
 288     /// Allocations that are considered roots of static memory (that may leak).
 289     pub(crate) static_roots: Vec<AllocId>,
 290
 291     /// The `measureme` profiler used to record timing information about
 292     /// the emulated program.
 293     profiler: Option<measureme::Profiler>,
 294     /// Used with `profiler` to cache the `StringId`s for event names
 295     /// uesd with `measureme`.
 296     string_cache: FxHashMap<String, measureme::StringId>,
 297
 298     /// Cache of `Instance` exported under the given `Symbol` name.
 299     pub(crate) exported_symbols_cache: FxHashMap<Symbol, Instance<'tcx>>,
 300
 301     /// Whether to raise a panic in the context of the evaluated process when unsupported
 302     /// functionality is encountered. If `false`, an error is propagated in the Miri application context
 303     /// instead (default behavior)
 304     pub(crate) panic_on_unsupported: bool,
 305 }
 306
 307 impl<'mir, 'tcx> Evaluator<'mir, 'tcx> {
 308     pub(crate) fn new(config: &MiriConfig, layout_cx: LayoutCx<'tcx, TyCtxt<'tcx>>) -> Self {
 309         let layouts =
 310             PrimitiveLayouts::new(layout_cx).expect("Couldn't get layouts of primitive types");
 311         let profiler = config.measureme_out.as_ref().map(|out| {
 312             measureme::Profiler::new(out).expect("Couldn't create `measureme` profiler")
 313         });
 314         Evaluator {
 315             // `env_vars` could be initialized properly here if `Memory` were available before
 316             // calling this method.
 317             env_vars: EnvVars::default(),
 318             argc: None,
 319             argv: None,
 320             cmd_line: None,
 321             tls: TlsData::default(),
 322             communicate: config.communicate,
 323             validate: config.validate,
 324             enforce_abi: config.check_abi,
 325             file_handler: Default::default(),
 326             dir_handler: Default::default(),
 327             time_anchor: Instant::now(),
 328             layouts,
 329             threads: ThreadManager::default(),
 330             static_roots: Vec::new(),
 331             profiler,
 332             string_cache: Default::default(),
 333             exported_symbols_cache: FxHashMap::default(),
 334             panic_on_unsupported: config.panic_on_unsupported,
 335         }
 336     }
 337 }
 338
 339 /// A rustc InterpCx for Miri.
 340 pub type MiriEvalContext<'mir, 'tcx> = InterpCx<'mir, 'tcx, Evaluator<'mir, 'tcx>>;
 341
 342 /// A little trait that's useful to be inherited by extension traits.
 343 pub trait MiriEvalContextExt<'mir, 'tcx> {
 344     fn eval_context_ref<'a>(&'a self) -> &'a MiriEvalContext<'mir, 'tcx>;
 345     fn eval_context_mut<'a>(&'a mut self) -> &'a mut MiriEvalContext<'mir, 'tcx>;
 346 }
 347 impl<'mir, 'tcx> MiriEvalContextExt<'mir, 'tcx> for MiriEvalContext<'mir, 'tcx> {
 348     #[inline(always)]
 349     fn eval_context_ref(&self) -> &MiriEvalContext<'mir, 'tcx> {
 350         self
 351     }
 352     #[inline(always)]
 353     fn eval_context_mut(&mut self) -> &mut MiriEvalContext<'mir, 'tcx> {
 354         self
 355     }
 356 }
 357
 358 /// Machine hook implementations.
 359 impl<'mir, 'tcx> Machine<'mir, 'tcx> for Evaluator<'mir, 'tcx> {
 360     type MemoryKind = MiriMemoryKind;
 361
 362     type FrameExtra = FrameData<'tcx>;
 363     type MemoryExtra = MemoryExtra;
 364     type AllocExtra = AllocExtra;
 365     type PointerTag = Tag;
 366     type ExtraFnVal = Dlsym;
 367
 368     type MemoryMap =
 369         MonoHashMap<AllocId, (MemoryKind<MiriMemoryKind>, Allocation<Tag, Self::AllocExtra>)>;
 370
 371     const GLOBAL_KIND: Option<MiriMemoryKind> = Some(MiriMemoryKind::Global);
 372
 373     #[inline(always)]
 374     fn enforce_alignment(memory_extra: &MemoryExtra) -> bool {
 375         memory_extra.check_alignment != AlignmentCheck::None
 376     }
 377
 378     #[inline(always)]
 379     fn force_int_for_alignment_check(memory_extra: &Self::MemoryExtra) -> bool {
 380         memory_extra.check_alignment == AlignmentCheck::Int
 381     }
 382
 383     #[inline(always)]
 384     fn enforce_validity(ecx: &InterpCx<'mir, 'tcx, Self>) -> bool {
 385         ecx.machine.validate
 386     }
 387
 388     #[inline(always)]
 389     fn enforce_abi(ecx: &InterpCx<'mir, 'tcx, Self>) -> bool {
 390         ecx.machine.enforce_abi
 391     }
 392
 393     #[inline(always)]
 394     fn find_mir_or_eval_fn(
 395         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 396         instance: ty::Instance<'tcx>,
 397         abi: Abi,
 398         args: &[OpTy<'tcx, Tag>],
 399         ret: Option<(&PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
 400         unwind: StackPopUnwind,
 401     ) -> InterpResult<'tcx, Option<&'mir mir::Body<'tcx>>> {
 402         ecx.find_mir_or_eval_fn(instance, abi, args, ret, unwind)
 403     }
 404
 405     #[inline(always)]
 406     fn call_extra_fn(
 407         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 408         fn_val: Dlsym,
 409         abi: Abi,
 410         args: &[OpTy<'tcx, Tag>],
 411         ret: Option<(&PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
 412         _unwind: StackPopUnwind,
 413     ) -> InterpResult<'tcx> {
 414         ecx.call_dlsym(fn_val, abi, args, ret)
 415     }
 416
 417     #[inline(always)]
 418     fn call_intrinsic(
 419         ecx: &mut rustc_mir::interpret::InterpCx<'mir, 'tcx, Self>,
 420         instance: ty::Instance<'tcx>,
 421         args: &[OpTy<'tcx, Tag>],
 422         ret: Option<(&PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
 423         unwind: StackPopUnwind,
 424     ) -> InterpResult<'tcx> {
 425         ecx.call_intrinsic(instance, args, ret, unwind)
 426     }
 427
 428     #[inline(always)]
 429     fn assert_panic(
 430         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 431         msg: &mir::AssertMessage<'tcx>,
 432         unwind: Option<mir::BasicBlock>,
 433     ) -> InterpResult<'tcx> {
 434         ecx.assert_panic(msg, unwind)
 435     }
 436
 437     #[inline(always)]
 438     fn abort(_ecx: &mut InterpCx<'mir, 'tcx, Self>, msg: String) -> InterpResult<'tcx, !> {
 439         throw_machine_stop!(TerminationInfo::Abort(msg))
 440     }
 441
 442     #[inline(always)]
 443     fn binary_ptr_op(
 444         ecx: &rustc_mir::interpret::InterpCx<'mir, 'tcx, Self>,
 445         bin_op: mir::BinOp,
 446         left: &ImmTy<'tcx, Tag>,
 447         right: &ImmTy<'tcx, Tag>,
 448     ) -> InterpResult<'tcx, (Scalar<Tag>, bool, ty::Ty<'tcx>)> {
 449         ecx.binary_ptr_op(bin_op, left, right)
 450     }
 451
 452     fn box_alloc(
 453         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 454         dest: &PlaceTy<'tcx, Tag>,
 455     ) -> InterpResult<'tcx> {
 456         trace!("box_alloc for {:?}", dest.layout.ty);
 457         let layout = ecx.layout_of(dest.layout.ty.builtin_deref(false).unwrap().ty)?;
 458         // First argument: `size`.
 459         // (`0` is allowed here -- this is expected to be handled by the lang item).
 460         let size = Scalar::from_machine_usize(layout.size.bytes(), ecx);
 461
 462         // Second argument: `align`.
 463         let align = Scalar::from_machine_usize(layout.align.abi.bytes(), ecx);
 464
 465         // Call the `exchange_malloc` lang item.
 466         let malloc = ecx.tcx.lang_items().exchange_malloc_fn().unwrap();
 467         let malloc = ty::Instance::mono(ecx.tcx.tcx, malloc);
 468         ecx.call_function(
 469             malloc,
 470             Abi::Rust,
 471             &[size.into(), align.into()],
 472             Some(dest),
 473             // Don't do anything when we are done. The `statement()` function will increment
 474             // the old stack frame's stmt counter to the next statement, which means that when
 475             // `exchange_malloc` returns, we go on evaluating exactly where we want to be.
 476             StackPopCleanup::None { cleanup: true },
 477         )?;
 478         Ok(())
 479     }
 480
 481     fn thread_local_static_alloc_id(
 482         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 483         def_id: DefId,
 484     ) -> InterpResult<'tcx, AllocId> {
 485         ecx.get_or_create_thread_local_alloc_id(def_id)
 486     }
 487
 488     fn extern_static_alloc_id(
 489         memory: &Memory<'mir, 'tcx, Self>,
 490         def_id: DefId,
 491     ) -> InterpResult<'tcx, AllocId> {
 492         let attrs = memory.tcx.get_attrs(def_id);
 493         let link_name = match memory.tcx.sess.first_attr_value_str_by_name(&attrs, sym::link_name) {
 494             Some(name) => name,
 495             None => memory.tcx.item_name(def_id),
 496         };
 497         if let Some(&id) = memory.extra.extern_statics.get(&link_name) {
 498             Ok(id)
 499         } else {
 500             throw_unsup_format!("`extern` static {:?} is not supported by Miri", def_id)
 501         }
 502     }
 503
 504     fn init_allocation_extra<'b>(
 505         memory_extra: &MemoryExtra,
 506         id: AllocId,
 507         alloc: Cow<'b, Allocation>,
 508         kind: Option<MemoryKind<Self::MemoryKind>>,
 509     ) -> (Cow<'b, Allocation<Self::PointerTag, Self::AllocExtra>>, Self::PointerTag) {
 510         if Some(id) == memory_extra.tracked_alloc_id {
 511             register_diagnostic(NonHaltingDiagnostic::CreatedAlloc(id));
 512         }
 513
 514         let kind = kind.expect("we set our STATIC_KIND so this cannot be None");
 515         let alloc = alloc.into_owned();
 516         let (stacks, base_tag) = if let Some(stacked_borrows) = &memory_extra.stacked_borrows {
 517             let (stacks, base_tag) =
 518                 Stacks::new_allocation(id, alloc.size(), stacked_borrows, kind);
 519             (Some(stacks), base_tag)
 520         } else {
 521             // No stacks, no tag.
 522             (None, Tag::Untagged)
 523         };
 524         let race_alloc = if let Some(data_race) = &memory_extra.data_race {
 525             Some(data_race::AllocExtra::new_allocation(&data_race, alloc.size(), kind))
 526         } else {
 527             None
 528         };
 529         let mut stacked_borrows = memory_extra.stacked_borrows.as_ref().map(|sb| sb.borrow_mut());
 530         let alloc: Allocation<Tag, Self::AllocExtra> = alloc.with_tags_and_extra(
 531             |alloc| {
 532                 if let Some(stacked_borrows) = &mut stacked_borrows {
 533                     // Only globals may already contain pointers at this point
 534                     assert_eq!(kind, MiriMemoryKind::Global.into());
 535                     stacked_borrows.global_base_ptr(alloc)
 536                 } else {
 537                     Tag::Untagged
 538                 }
 539             },
 540             AllocExtra { stacked_borrows: stacks, data_race: race_alloc },
 541         );
 542         (Cow::Owned(alloc), base_tag)
 543     }
 544
 545     #[inline(always)]
 546     fn memory_read(
 547         memory_extra: &Self::MemoryExtra,
 548         alloc_extra: &AllocExtra,
 549         ptr: Pointer<Tag>,
 550         size: Size,
 551     ) -> InterpResult<'tcx> {
 552         if let Some(data_race) = &alloc_extra.data_race {
 553             data_race.read(ptr, size, memory_extra.data_race.as_ref().unwrap())?;
 554         }
 555         if let Some(stacked_borrows) = &alloc_extra.stacked_borrows {
 556             stacked_borrows.memory_read(ptr, size, memory_extra.stacked_borrows.as_ref().unwrap())
 557         } else {
 558             Ok(())
 559         }
 560     }
 561
 562     #[inline(always)]
 563     fn memory_written(
 564         memory_extra: &mut Self::MemoryExtra,
 565         alloc_extra: &mut AllocExtra,
 566         ptr: Pointer<Tag>,
 567         size: Size,
 568     ) -> InterpResult<'tcx> {
 569         if let Some(data_race) = &mut alloc_extra.data_race {
 570             data_race.write(ptr, size, memory_extra.data_race.as_mut().unwrap())?;
 571         }
 572         if let Some(stacked_borrows) = &mut alloc_extra.stacked_borrows {
 573             stacked_borrows.memory_written(
 574                 ptr,
 575                 size,
 576                 memory_extra.stacked_borrows.as_mut().unwrap(),
 577             )
 578         } else {
 579             Ok(())
 580         }
 581     }
 582
 583     #[inline(always)]
 584     fn memory_deallocated(
 585         memory_extra: &mut Self::MemoryExtra,
 586         alloc_extra: &mut AllocExtra,
 587         ptr: Pointer<Tag>,
 588         size: Size,
 589     ) -> InterpResult<'tcx> {
 590         if Some(ptr.alloc_id) == memory_extra.tracked_alloc_id {
 591             register_diagnostic(NonHaltingDiagnostic::FreedAlloc(ptr.alloc_id));
 592         }
 593         if let Some(data_race) = &mut alloc_extra.data_race {
 594             data_race.deallocate(ptr, size, memory_extra.data_race.as_mut().unwrap())?;
 595         }
 596         if let Some(stacked_borrows) = &mut alloc_extra.stacked_borrows {
 597             stacked_borrows.memory_deallocated(
 598                 ptr,
 599                 size,
 600                 memory_extra.stacked_borrows.as_mut().unwrap(),
 601             )
 602         } else {
 603             Ok(())
 604         }
 605     }
 606
 607     fn after_static_mem_initialized(
 608         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 609         ptr: Pointer<Self::PointerTag>,
 610         size: Size,
 611     ) -> InterpResult<'tcx> {
 612         if ecx.memory.extra.data_race.is_some() {
 613             ecx.reset_vector_clocks(ptr, size)?;
 614         }
 615         Ok(())
 616     }
 617
 618     #[inline(always)]
 619     fn tag_global_base_pointer(memory_extra: &MemoryExtra, id: AllocId) -> Self::PointerTag {
 620         if let Some(stacked_borrows) = &memory_extra.stacked_borrows {
 621             stacked_borrows.borrow_mut().global_base_ptr(id)
 622         } else {
 623             Tag::Untagged
 624         }
 625     }
 626
 627     #[inline(always)]
 628     fn retag(
 629         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 630         kind: mir::RetagKind,
 631         place: &PlaceTy<'tcx, Tag>,
 632     ) -> InterpResult<'tcx> {
 633         if ecx.memory.extra.stacked_borrows.is_some() { ecx.retag(kind, place) } else { Ok(()) }
 634     }
 635
 636     #[inline(always)]
 637     fn init_frame_extra(
 638         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 639         frame: Frame<'mir, 'tcx, Tag>,
 640     ) -> InterpResult<'tcx, Frame<'mir, 'tcx, Tag, FrameData<'tcx>>> {
 641         // Start recording our event before doing anything else
 642         let timing = if let Some(profiler) = ecx.machine.profiler.as_ref() {
 643             let fn_name = frame.instance.to_string();
 644             let entry = ecx.machine.string_cache.entry(fn_name.clone());
 645             let name = entry.or_insert_with(|| profiler.alloc_string(&*fn_name));
 646
 647             Some(profiler.start_recording_interval_event_detached(
 648                 *name,
 649                 measureme::EventId::from_label(*name),
 650                 ecx.get_active_thread().to_u32(),
 651             ))
 652         } else {
 653             None
 654         };
 655
 656         let stacked_borrows = ecx.memory.extra.stacked_borrows.as_ref();
 657         let call_id = stacked_borrows.map_or(NonZeroU64::new(1).unwrap(), |stacked_borrows| {
 658             stacked_borrows.borrow_mut().new_call()
 659         });
 660
 661         let extra = FrameData { call_id, catch_unwind: None, timing };
 662         Ok(frame.with_extra(extra))
 663     }
 664
 665     fn stack<'a>(
 666         ecx: &'a InterpCx<'mir, 'tcx, Self>,
 667     ) -> &'a [Frame<'mir, 'tcx, Self::PointerTag, Self::FrameExtra>] {
 668         ecx.active_thread_stack()
 669     }
 670
 671     fn stack_mut<'a>(
 672         ecx: &'a mut InterpCx<'mir, 'tcx, Self>,
 673     ) -> &'a mut Vec<Frame<'mir, 'tcx, Self::PointerTag, Self::FrameExtra>> {
 674         ecx.active_thread_stack_mut()
 675     }
 676
 677     #[inline(always)]
 678     fn after_stack_push(ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx> {
 679         if ecx.memory.extra.stacked_borrows.is_some() { ecx.retag_return_place() } else { Ok(()) }
 680     }
 681
 682     #[inline(always)]
 683     fn after_stack_pop(
 684         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 685         mut frame: Frame<'mir, 'tcx, Tag, FrameData<'tcx>>,
 686         unwinding: bool,
 687     ) -> InterpResult<'tcx, StackPopJump> {
 688         let timing = frame.extra.timing.take();
 689         let res = ecx.handle_stack_pop(frame.extra, unwinding);
 690         if let Some(profiler) = ecx.machine.profiler.as_ref() {
 691             profiler.finish_recording_interval_event(timing.unwrap());
 692         }
 693         res
 694     }
 695
 696     #[inline(always)]
 697     fn int_to_ptr(
 698         memory: &Memory<'mir, 'tcx, Self>,
 699         int: u64,
 700     ) -> InterpResult<'tcx, Pointer<Self::PointerTag>> {
 701         intptrcast::GlobalState::int_to_ptr(int, memory)
 702     }
 703
 704     #[inline(always)]
 705     fn ptr_to_int(
 706         memory: &Memory<'mir, 'tcx, Self>,
 707         ptr: Pointer<Self::PointerTag>,
 708     ) -> InterpResult<'tcx, u64> {
 709         intptrcast::GlobalState::ptr_to_int(ptr, memory)
 710     }
 711 }