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
 302 impl<'mir, 'tcx> Evaluator<'mir, 'tcx> {
 303     pub(crate) fn new(config: &MiriConfig, layout_cx: LayoutCx<'tcx, TyCtxt<'tcx>>) -> Self {
 304         let layouts =
 305             PrimitiveLayouts::new(layout_cx).expect("Couldn't get layouts of primitive types");
 306         let profiler = config.measureme_out.as_ref().map(|out| {
 307             measureme::Profiler::new(out).expect("Couldn't create `measureme` profiler")
 308         });
 309         Evaluator {
 310             // `env_vars` could be initialized properly here if `Memory` were available before
 311             // calling this method.
 312             env_vars: EnvVars::default(),
 313             argc: None,
 314             argv: None,
 315             cmd_line: None,
 316             tls: TlsData::default(),
 317             communicate: config.communicate,
 318             validate: config.validate,
 319             enforce_abi: config.check_abi,
 320             file_handler: Default::default(),
 321             dir_handler: Default::default(),
 322             time_anchor: Instant::now(),
 323             layouts,
 324             threads: ThreadManager::default(),
 325             static_roots: Vec::new(),
 326             profiler,
 327             string_cache: Default::default(),
 328             exported_symbols_cache: FxHashMap::default(),
 329         }
 330     }
 331 }
 332
 333 /// A rustc InterpCx for Miri.
 334 pub type MiriEvalContext<'mir, 'tcx> = InterpCx<'mir, 'tcx, Evaluator<'mir, 'tcx>>;
 335
 336 /// A little trait that's useful to be inherited by extension traits.
 337 pub trait MiriEvalContextExt<'mir, 'tcx> {
 338     fn eval_context_ref<'a>(&'a self) -> &'a MiriEvalContext<'mir, 'tcx>;
 339     fn eval_context_mut<'a>(&'a mut self) -> &'a mut MiriEvalContext<'mir, 'tcx>;
 340 }
 341 impl<'mir, 'tcx> MiriEvalContextExt<'mir, 'tcx> for MiriEvalContext<'mir, 'tcx> {
 342     #[inline(always)]
 343     fn eval_context_ref(&self) -> &MiriEvalContext<'mir, 'tcx> {
 344         self
 345     }
 346     #[inline(always)]
 347     fn eval_context_mut(&mut self) -> &mut MiriEvalContext<'mir, 'tcx> {
 348         self
 349     }
 350 }
 351
 352 /// Machine hook implementations.
 353 impl<'mir, 'tcx> Machine<'mir, 'tcx> for Evaluator<'mir, 'tcx> {
 354     type MemoryKind = MiriMemoryKind;
 355
 356     type FrameExtra = FrameData<'tcx>;
 357     type MemoryExtra = MemoryExtra;
 358     type AllocExtra = AllocExtra;
 359     type PointerTag = Tag;
 360     type ExtraFnVal = Dlsym;
 361
 362     type MemoryMap =
 363         MonoHashMap<AllocId, (MemoryKind<MiriMemoryKind>, Allocation<Tag, Self::AllocExtra>)>;
 364
 365     const GLOBAL_KIND: Option<MiriMemoryKind> = Some(MiriMemoryKind::Global);
 366
 367     #[inline(always)]
 368     fn enforce_alignment(memory_extra: &MemoryExtra) -> bool {
 369         memory_extra.check_alignment != AlignmentCheck::None
 370     }
 371
 372     #[inline(always)]
 373     fn force_int_for_alignment_check(memory_extra: &Self::MemoryExtra) -> bool {
 374         memory_extra.check_alignment == AlignmentCheck::Int
 375     }
 376
 377     #[inline(always)]
 378     fn enforce_validity(ecx: &InterpCx<'mir, 'tcx, Self>) -> bool {
 379         ecx.machine.validate
 380     }
 381
 382     #[inline(always)]
 383     fn enforce_abi(ecx: &InterpCx<'mir, 'tcx, Self>) -> bool {
 384         ecx.machine.enforce_abi
 385     }
 386
 387     #[inline(always)]
 388     fn find_mir_or_eval_fn(
 389         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 390         instance: ty::Instance<'tcx>,
 391         abi: Abi,
 392         args: &[OpTy<'tcx, Tag>],
 393         ret: Option<(&PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
 394         unwind: StackPopUnwind,
 395     ) -> InterpResult<'tcx, Option<&'mir mir::Body<'tcx>>> {
 396         ecx.find_mir_or_eval_fn(instance, abi, args, ret, unwind)
 397     }
 398
 399     #[inline(always)]
 400     fn call_extra_fn(
 401         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 402         fn_val: Dlsym,
 403         abi: Abi,
 404         args: &[OpTy<'tcx, Tag>],
 405         ret: Option<(&PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
 406         _unwind: StackPopUnwind,
 407     ) -> InterpResult<'tcx> {
 408         ecx.call_dlsym(fn_val, abi, args, ret)
 409     }
 410
 411     #[inline(always)]
 412     fn call_intrinsic(
 413         ecx: &mut rustc_mir::interpret::InterpCx<'mir, 'tcx, Self>,
 414         instance: ty::Instance<'tcx>,
 415         args: &[OpTy<'tcx, Tag>],
 416         ret: Option<(&PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
 417         unwind: StackPopUnwind,
 418     ) -> InterpResult<'tcx> {
 419         ecx.call_intrinsic(instance, args, ret, unwind)
 420     }
 421
 422     #[inline(always)]
 423     fn assert_panic(
 424         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 425         msg: &mir::AssertMessage<'tcx>,
 426         unwind: Option<mir::BasicBlock>,
 427     ) -> InterpResult<'tcx> {
 428         ecx.assert_panic(msg, unwind)
 429     }
 430
 431     #[inline(always)]
 432     fn abort(_ecx: &mut InterpCx<'mir, 'tcx, Self>, msg: String) -> InterpResult<'tcx, !> {
 433         throw_machine_stop!(TerminationInfo::Abort(msg))
 434     }
 435
 436     #[inline(always)]
 437     fn binary_ptr_op(
 438         ecx: &rustc_mir::interpret::InterpCx<'mir, 'tcx, Self>,
 439         bin_op: mir::BinOp,
 440         left: &ImmTy<'tcx, Tag>,
 441         right: &ImmTy<'tcx, Tag>,
 442     ) -> InterpResult<'tcx, (Scalar<Tag>, bool, ty::Ty<'tcx>)> {
 443         ecx.binary_ptr_op(bin_op, left, right)
 444     }
 445
 446     fn box_alloc(
 447         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 448         dest: &PlaceTy<'tcx, Tag>,
 449     ) -> InterpResult<'tcx> {
 450         trace!("box_alloc for {:?}", dest.layout.ty);
 451         let layout = ecx.layout_of(dest.layout.ty.builtin_deref(false).unwrap().ty)?;
 452         // First argument: `size`.
 453         // (`0` is allowed here -- this is expected to be handled by the lang item).
 454         let size = Scalar::from_machine_usize(layout.size.bytes(), ecx);
 455
 456         // Second argument: `align`.
 457         let align = Scalar::from_machine_usize(layout.align.abi.bytes(), ecx);
 458
 459         // Call the `exchange_malloc` lang item.
 460         let malloc = ecx.tcx.lang_items().exchange_malloc_fn().unwrap();
 461         let malloc = ty::Instance::mono(ecx.tcx.tcx, malloc);
 462         ecx.call_function(
 463             malloc,
 464             Abi::Rust,
 465             &[size.into(), align.into()],
 466             Some(dest),
 467             // Don't do anything when we are done. The `statement()` function will increment
 468             // the old stack frame's stmt counter to the next statement, which means that when
 469             // `exchange_malloc` returns, we go on evaluating exactly where we want to be.
 470             StackPopCleanup::None { cleanup: true },
 471         )?;
 472         Ok(())
 473     }
 474
 475     fn thread_local_static_alloc_id(
 476         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 477         def_id: DefId,
 478     ) -> InterpResult<'tcx, AllocId> {
 479         ecx.get_or_create_thread_local_alloc_id(def_id)
 480     }
 481
 482     fn extern_static_alloc_id(
 483         memory: &Memory<'mir, 'tcx, Self>,
 484         def_id: DefId,
 485     ) -> InterpResult<'tcx, AllocId> {
 486         let attrs = memory.tcx.get_attrs(def_id);
 487         let link_name = match memory.tcx.sess.first_attr_value_str_by_name(&attrs, sym::link_name) {
 488             Some(name) => name,
 489             None => memory.tcx.item_name(def_id),
 490         };
 491         if let Some(&id) = memory.extra.extern_statics.get(&link_name) {
 492             Ok(id)
 493         } else {
 494             throw_unsup_format!("`extern` static {:?} is not supported by Miri", def_id)
 495         }
 496     }
 497
 498     fn init_allocation_extra<'b>(
 499         memory_extra: &MemoryExtra,
 500         id: AllocId,
 501         alloc: Cow<'b, Allocation>,
 502         kind: Option<MemoryKind<Self::MemoryKind>>,
 503     ) -> (Cow<'b, Allocation<Self::PointerTag, Self::AllocExtra>>, Self::PointerTag) {
 504         if Some(id) == memory_extra.tracked_alloc_id {
 505             register_diagnostic(NonHaltingDiagnostic::CreatedAlloc(id));
 506         }
 507
 508         let kind = kind.expect("we set our STATIC_KIND so this cannot be None");
 509         let alloc = alloc.into_owned();
 510         let (stacks, base_tag) = if let Some(stacked_borrows) = &memory_extra.stacked_borrows {
 511             let (stacks, base_tag) =
 512                 Stacks::new_allocation(id, alloc.size(), stacked_borrows, kind);
 513             (Some(stacks), base_tag)
 514         } else {
 515             // No stacks, no tag.
 516             (None, Tag::Untagged)
 517         };
 518         let race_alloc = if let Some(data_race) = &memory_extra.data_race {
 519             Some(data_race::AllocExtra::new_allocation(&data_race, alloc.size(), kind))
 520         } else {
 521             None
 522         };
 523         let mut stacked_borrows = memory_extra.stacked_borrows.as_ref().map(|sb| sb.borrow_mut());
 524         let alloc: Allocation<Tag, Self::AllocExtra> = alloc.with_tags_and_extra(
 525             |alloc| {
 526                 if let Some(stacked_borrows) = &mut stacked_borrows {
 527                     // Only globals may already contain pointers at this point
 528                     assert_eq!(kind, MiriMemoryKind::Global.into());
 529                     stacked_borrows.global_base_ptr(alloc)
 530                 } else {
 531                     Tag::Untagged
 532                 }
 533             },
 534             AllocExtra { stacked_borrows: stacks, data_race: race_alloc },
 535         );
 536         (Cow::Owned(alloc), base_tag)
 537     }
 538
 539     #[inline(always)]
 540     fn memory_read(
 541         memory_extra: &Self::MemoryExtra,
 542         alloc_extra: &AllocExtra,
 543         ptr: Pointer<Tag>,
 544         size: Size,
 545     ) -> InterpResult<'tcx> {
 546         if let Some(data_race) = &alloc_extra.data_race {
 547             data_race.read(ptr, size, memory_extra.data_race.as_ref().unwrap())?;
 548         }
 549         if let Some(stacked_borrows) = &alloc_extra.stacked_borrows {
 550             stacked_borrows.memory_read(ptr, size, memory_extra.stacked_borrows.as_ref().unwrap())
 551         } else {
 552             Ok(())
 553         }
 554     }
 555
 556     #[inline(always)]
 557     fn memory_written(
 558         memory_extra: &mut Self::MemoryExtra,
 559         alloc_extra: &mut AllocExtra,
 560         ptr: Pointer<Tag>,
 561         size: Size,
 562     ) -> InterpResult<'tcx> {
 563         if let Some(data_race) = &mut alloc_extra.data_race {
 564             data_race.write(ptr, size, memory_extra.data_race.as_mut().unwrap())?;
 565         }
 566         if let Some(stacked_borrows) = &mut alloc_extra.stacked_borrows {
 567             stacked_borrows.memory_written(
 568                 ptr,
 569                 size,
 570                 memory_extra.stacked_borrows.as_mut().unwrap(),
 571             )
 572         } else {
 573             Ok(())
 574         }
 575     }
 576
 577     #[inline(always)]
 578     fn memory_deallocated(
 579         memory_extra: &mut Self::MemoryExtra,
 580         alloc_extra: &mut AllocExtra,
 581         ptr: Pointer<Tag>,
 582         size: Size,
 583     ) -> InterpResult<'tcx> {
 584         if Some(ptr.alloc_id) == memory_extra.tracked_alloc_id {
 585             register_diagnostic(NonHaltingDiagnostic::FreedAlloc(ptr.alloc_id));
 586         }
 587         if let Some(data_race) = &mut alloc_extra.data_race {
 588             data_race.deallocate(ptr, size, memory_extra.data_race.as_mut().unwrap())?;
 589         }
 590         if let Some(stacked_borrows) = &mut alloc_extra.stacked_borrows {
 591             stacked_borrows.memory_deallocated(
 592                 ptr,
 593                 size,
 594                 memory_extra.stacked_borrows.as_mut().unwrap(),
 595             )
 596         } else {
 597             Ok(())
 598         }
 599     }
 600
 601     fn after_static_mem_initialized(
 602         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 603         ptr: Pointer<Self::PointerTag>,
 604         size: Size,
 605     ) -> InterpResult<'tcx> {
 606         if ecx.memory.extra.data_race.is_some() {
 607             ecx.reset_vector_clocks(ptr, size)?;
 608         }
 609         Ok(())
 610     }
 611
 612     #[inline(always)]
 613     fn tag_global_base_pointer(memory_extra: &MemoryExtra, id: AllocId) -> Self::PointerTag {
 614         if let Some(stacked_borrows) = &memory_extra.stacked_borrows {
 615             stacked_borrows.borrow_mut().global_base_ptr(id)
 616         } else {
 617             Tag::Untagged
 618         }
 619     }
 620
 621     #[inline(always)]
 622     fn retag(
 623         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 624         kind: mir::RetagKind,
 625         place: &PlaceTy<'tcx, Tag>,
 626     ) -> InterpResult<'tcx> {
 627         if ecx.memory.extra.stacked_borrows.is_some() { ecx.retag(kind, place) } else { Ok(()) }
 628     }
 629
 630     #[inline(always)]
 631     fn init_frame_extra(
 632         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 633         frame: Frame<'mir, 'tcx, Tag>,
 634     ) -> InterpResult<'tcx, Frame<'mir, 'tcx, Tag, FrameData<'tcx>>> {
 635         // Start recording our event before doing anything else
 636         let timing = if let Some(profiler) = ecx.machine.profiler.as_ref() {
 637             let fn_name = frame.instance.to_string();
 638             let entry = ecx.machine.string_cache.entry(fn_name.clone());
 639             let name = entry.or_insert_with(|| profiler.alloc_string(&*fn_name));
 640
 641             Some(profiler.start_recording_interval_event_detached(
 642                 *name,
 643                 measureme::EventId::from_label(*name),
 644                 ecx.get_active_thread().to_u32(),
 645             ))
 646         } else {
 647             None
 648         };
 649
 650         let stacked_borrows = ecx.memory.extra.stacked_borrows.as_ref();
 651         let call_id = stacked_borrows.map_or(NonZeroU64::new(1).unwrap(), |stacked_borrows| {
 652             stacked_borrows.borrow_mut().new_call()
 653         });
 654
 655         let extra = FrameData { call_id, catch_unwind: None, timing };
 656         Ok(frame.with_extra(extra))
 657     }
 658
 659     fn stack<'a>(
 660         ecx: &'a InterpCx<'mir, 'tcx, Self>,
 661     ) -> &'a [Frame<'mir, 'tcx, Self::PointerTag, Self::FrameExtra>] {
 662         ecx.active_thread_stack()
 663     }
 664
 665     fn stack_mut<'a>(
 666         ecx: &'a mut InterpCx<'mir, 'tcx, Self>,
 667     ) -> &'a mut Vec<Frame<'mir, 'tcx, Self::PointerTag, Self::FrameExtra>> {
 668         ecx.active_thread_stack_mut()
 669     }
 670
 671     #[inline(always)]
 672     fn after_stack_push(ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx> {
 673         if ecx.memory.extra.stacked_borrows.is_some() { ecx.retag_return_place() } else { Ok(()) }
 674     }
 675
 676     #[inline(always)]
 677     fn after_stack_pop(
 678         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 679         mut frame: Frame<'mir, 'tcx, Tag, FrameData<'tcx>>,
 680         unwinding: bool,
 681     ) -> InterpResult<'tcx, StackPopJump> {
 682         let timing = frame.extra.timing.take();
 683         let res = ecx.handle_stack_pop(frame.extra, unwinding);
 684         if let Some(profiler) = ecx.machine.profiler.as_ref() {
 685             profiler.finish_recording_interval_event(timing.unwrap());
 686         }
 687         res
 688     }
 689
 690     #[inline(always)]
 691     fn int_to_ptr(
 692         memory: &Memory<'mir, 'tcx, Self>,
 693         int: u64,
 694     ) -> InterpResult<'tcx, Pointer<Self::PointerTag>> {
 695         intptrcast::GlobalState::int_to_ptr(int, memory)
 696     }
 697
 698     #[inline(always)]
 699     fn ptr_to_int(
 700         memory: &Memory<'mir, 'tcx, Self>,
 701         ptr: Pointer<Self::PointerTag>,
 702     ) -> InterpResult<'tcx, u64> {
 703         intptrcast::GlobalState::ptr_to_int(ptr, memory)
 704     }
 705 }