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