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