src/tools/miri/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
   8 use rand::rngs::StdRng;
   9 use rand::SeedableRng;
  10
  11 use rustc_ast::ast::Mutability;
  12 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  13 #[allow(unused)]
  14 use rustc_data_structures::static_assert_size;
  15 use rustc_middle::{
  16     mir,
  17     ty::{
  18         self,
  19         layout::{LayoutCx, LayoutError, LayoutOf, TyAndLayout},
  20         Instance, Ty, TyCtxt, TypeAndMut,
  21     },
  22 };
  23 use rustc_span::def_id::{CrateNum, DefId};
  24 use rustc_span::Symbol;
  25 use rustc_target::abi::Size;
  26 use rustc_target::spec::abi::Abi;
  27
  28 use crate::{
  29     concurrency::{data_race, weak_memory},
  30     shims::unix::FileHandler,
  31     *,
  32 };
  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
  39 /// Extra data stored with each stack frame
  40 pub struct FrameExtra<'tcx> {
  41     /// Extra data for Stacked Borrows.
  42     pub borrow_tracker: Option<borrow_tracker::FrameState>,
  43
  44     /// If this is Some(), then this is a special "catch unwind" frame (the frame of `try_fn`
  45     /// called by `try`). When this frame is popped during unwinding a panic,
  46     /// we stop unwinding, use the `CatchUnwindData` to handle catching.
  47     pub catch_unwind: Option<CatchUnwindData<'tcx>>,
  48
  49     /// If `measureme` profiling is enabled, holds timing information
  50     /// for the start of this frame. When we finish executing this frame,
  51     /// we use this to register a completed event with `measureme`.
  52     pub timing: Option<measureme::DetachedTiming>,
  53
  54     /// Indicates whether a `Frame` is part of a workspace-local crate and is also not
  55     /// `#[track_caller]`. We compute this once on creation and store the result, as an
  56     /// optimization.
  57     /// This is used by `MiriMachine::current_span` and `MiriMachine::caller_span`
  58     pub is_user_relevant: bool,
  59 }
  60
  61 impl<'tcx> std::fmt::Debug for FrameExtra<'tcx> {
  62     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
  63         // Omitting `timing`, it does not support `Debug`.
  64         let FrameExtra { borrow_tracker, catch_unwind, timing: _, is_user_relevant: _ } = self;
  65         f.debug_struct("FrameData")
  66             .field("borrow_tracker", borrow_tracker)
  67             .field("catch_unwind", catch_unwind)
  68             .finish()
  69     }
  70 }
  71
  72 impl VisitTags for FrameExtra<'_> {
  73     fn visit_tags(&self, visit: &mut dyn FnMut(BorTag)) {
  74         let FrameExtra { catch_unwind, borrow_tracker, timing: _, is_user_relevant: _ } = self;
  75
  76         catch_unwind.visit_tags(visit);
  77         borrow_tracker.visit_tags(visit);
  78     }
  79 }
  80
  81 /// Extra memory kinds
  82 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
  83 pub enum MiriMemoryKind {
  84     /// `__rust_alloc` memory.
  85     Rust,
  86     /// `miri_alloc` memory.
  87     Miri,
  88     /// `malloc` memory.
  89     C,
  90     /// Windows `HeapAlloc` memory.
  91     WinHeap,
  92     /// Memory for args, errno, and other parts of the machine-managed environment.
  93     /// This memory may leak.
  94     Machine,
  95     /// Memory allocated by the runtime (e.g. env vars). Separate from `Machine`
  96     /// because we clean it up and leak-check it.
  97     Runtime,
  98     /// Globals copied from `tcx`.
  99     /// This memory may leak.
 100     Global,
 101     /// Memory for extern statics.
 102     /// This memory may leak.
 103     ExternStatic,
 104     /// Memory for thread-local statics.
 105     /// This memory may leak.
 106     Tls,
 107 }
 108
 109 impl From<MiriMemoryKind> for MemoryKind<MiriMemoryKind> {
 110     #[inline(always)]
 111     fn from(kind: MiriMemoryKind) -> MemoryKind<MiriMemoryKind> {
 112         MemoryKind::Machine(kind)
 113     }
 114 }
 115
 116 impl MayLeak for MiriMemoryKind {
 117     #[inline(always)]
 118     fn may_leak(self) -> bool {
 119         use self::MiriMemoryKind::*;
 120         match self {
 121             Rust | Miri | C | WinHeap | Runtime => false,
 122             Machine | Global | ExternStatic | Tls => true,
 123         }
 124     }
 125 }
 126
 127 impl fmt::Display for MiriMemoryKind {
 128     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 129         use self::MiriMemoryKind::*;
 130         match self {
 131             Rust => write!(f, "Rust heap"),
 132             Miri => write!(f, "Miri bare-metal heap"),
 133             C => write!(f, "C heap"),
 134             WinHeap => write!(f, "Windows heap"),
 135             Machine => write!(f, "machine-managed memory"),
 136             Runtime => write!(f, "language runtime memory"),
 137             Global => write!(f, "global (static or const)"),
 138             ExternStatic => write!(f, "extern static"),
 139             Tls => write!(f, "thread-local static"),
 140         }
 141     }
 142 }
 143
 144 /// Pointer provenance.
 145 #[derive(Clone, Copy)]
 146 pub enum Provenance {
 147     Concrete {
 148         alloc_id: AllocId,
 149         /// Stacked Borrows tag.
 150         tag: BorTag,
 151     },
 152     Wildcard,
 153 }
 154
 155 // This needs to be `Eq`+`Hash` because the `Machine` trait needs that because validity checking
 156 // *might* be recursive and then it has to track which places have already been visited.
 157 // However, comparing provenance is meaningless, since `Wildcard` might be any provenance -- and of
 158 // course we don't actually do recursive checking.
 159 // We could change `RefTracking` to strip provenance for its `seen` set but that type is generic so that is quite annoying.
 160 // Instead owe add the required instances but make them panic.
 161 impl PartialEq for Provenance {
 162     fn eq(&self, _other: &Self) -> bool {
 163         panic!("Provenance must not be compared")
 164     }
 165 }
 166 impl Eq for Provenance {}
 167 impl std::hash::Hash for Provenance {
 168     fn hash<H: std::hash::Hasher>(&self, _state: &mut H) {
 169         panic!("Provenance must not be hashed")
 170     }
 171 }
 172
 173 /// The "extra" information a pointer has over a regular AllocId.
 174 #[derive(Copy, Clone, PartialEq)]
 175 pub enum ProvenanceExtra {
 176     Concrete(BorTag),
 177     Wildcard,
 178 }
 179
 180 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
 181 static_assert_size!(Pointer<Provenance>, 24);
 182 // FIXME: this would with in 24bytes but layout optimizations are not smart enough
 183 // #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
 184 //static_assert_size!(Pointer<Option<Provenance>>, 24);
 185 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
 186 static_assert_size!(Scalar<Provenance>, 32);
 187
 188 impl fmt::Debug for Provenance {
 189     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 190         match self {
 191             Provenance::Concrete { alloc_id, tag } => {
 192                 // Forward `alternate` flag to `alloc_id` printing.
 193                 if f.alternate() {
 194                     write!(f, "[{alloc_id:#?}]")?;
 195                 } else {
 196                     write!(f, "[{alloc_id:?}]")?;
 197                 }
 198                 // Print Stacked Borrows tag.
 199                 write!(f, "{tag:?}")?;
 200             }
 201             Provenance::Wildcard => {
 202                 write!(f, "[wildcard]")?;
 203             }
 204         }
 205         Ok(())
 206     }
 207 }
 208
 209 impl interpret::Provenance for Provenance {
 210     /// We use absolute addresses in the `offset` of a `Pointer<Provenance>`.
 211     const OFFSET_IS_ADDR: bool = true;
 212
 213     fn get_alloc_id(self) -> Option<AllocId> {
 214         match self {
 215             Provenance::Concrete { alloc_id, .. } => Some(alloc_id),
 216             Provenance::Wildcard => None,
 217         }
 218     }
 219
 220     fn join(left: Option<Self>, right: Option<Self>) -> Option<Self> {
 221         match (left, right) {
 222             // If both are the *same* concrete tag, that is the result.
 223             (
 224                 Some(Provenance::Concrete { alloc_id: left_alloc, tag: left_tag }),
 225                 Some(Provenance::Concrete { alloc_id: right_alloc, tag: right_tag }),
 226             ) if left_alloc == right_alloc && left_tag == right_tag => left,
 227             // If one side is a wildcard, the best possible outcome is that it is equal to the other
 228             // one, and we use that.
 229             (Some(Provenance::Wildcard), o) | (o, Some(Provenance::Wildcard)) => o,
 230             // Otherwise, fall back to `None`.
 231             _ => None,
 232         }
 233     }
 234 }
 235
 236 impl fmt::Debug for ProvenanceExtra {
 237     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 238         match self {
 239             ProvenanceExtra::Concrete(pid) => write!(f, "{pid:?}"),
 240             ProvenanceExtra::Wildcard => write!(f, "<wildcard>"),
 241         }
 242     }
 243 }
 244
 245 impl ProvenanceExtra {
 246     pub fn and_then<T>(self, f: impl FnOnce(BorTag) -> Option<T>) -> Option<T> {
 247         match self {
 248             ProvenanceExtra::Concrete(pid) => f(pid),
 249             ProvenanceExtra::Wildcard => None,
 250         }
 251     }
 252 }
 253
 254 /// Extra per-allocation data
 255 #[derive(Debug, Clone)]
 256 pub struct AllocExtra {
 257     /// Global state of the borrow tracker, if enabled.
 258     pub borrow_tracker: Option<borrow_tracker::AllocState>,
 259     /// Data race detection via the use of a vector-clock,
 260     ///  this is only added if it is enabled.
 261     pub data_race: Option<data_race::AllocState>,
 262     /// Weak memory emulation via the use of store buffers,
 263     ///  this is only added if it is enabled.
 264     pub weak_memory: Option<weak_memory::AllocState>,
 265 }
 266
 267 impl VisitTags for AllocExtra {
 268     fn visit_tags(&self, visit: &mut dyn FnMut(BorTag)) {
 269         let AllocExtra { borrow_tracker, data_race, weak_memory } = self;
 270
 271         borrow_tracker.visit_tags(visit);
 272         data_race.visit_tags(visit);
 273         weak_memory.visit_tags(visit);
 274     }
 275 }
 276
 277 /// Precomputed layouts of primitive types
 278 pub struct PrimitiveLayouts<'tcx> {
 279     pub unit: TyAndLayout<'tcx>,
 280     pub i8: TyAndLayout<'tcx>,
 281     pub i16: TyAndLayout<'tcx>,
 282     pub i32: TyAndLayout<'tcx>,
 283     pub i64: TyAndLayout<'tcx>,
 284     pub i128: TyAndLayout<'tcx>,
 285     pub isize: TyAndLayout<'tcx>,
 286     pub u8: TyAndLayout<'tcx>,
 287     pub u16: TyAndLayout<'tcx>,
 288     pub u32: TyAndLayout<'tcx>,
 289     pub u64: TyAndLayout<'tcx>,
 290     pub u128: TyAndLayout<'tcx>,
 291     pub usize: TyAndLayout<'tcx>,
 292     pub bool: TyAndLayout<'tcx>,
 293     pub mut_raw_ptr: TyAndLayout<'tcx>,   // *mut ()
 294     pub const_raw_ptr: TyAndLayout<'tcx>, // *const ()
 295 }
 296
 297 impl<'mir, 'tcx: 'mir> PrimitiveLayouts<'tcx> {
 298     fn new(layout_cx: LayoutCx<'tcx, TyCtxt<'tcx>>) -> Result<Self, LayoutError<'tcx>> {
 299         let tcx = layout_cx.tcx;
 300         let mut_raw_ptr = tcx.mk_ptr(TypeAndMut { ty: tcx.types.unit, mutbl: Mutability::Mut });
 301         let const_raw_ptr = tcx.mk_ptr(TypeAndMut { ty: tcx.types.unit, mutbl: Mutability::Not });
 302         Ok(Self {
 303             unit: layout_cx.layout_of(tcx.mk_unit())?,
 304             i8: layout_cx.layout_of(tcx.types.i8)?,
 305             i16: layout_cx.layout_of(tcx.types.i16)?,
 306             i32: layout_cx.layout_of(tcx.types.i32)?,
 307             i64: layout_cx.layout_of(tcx.types.i64)?,
 308             i128: layout_cx.layout_of(tcx.types.i128)?,
 309             isize: layout_cx.layout_of(tcx.types.isize)?,
 310             u8: layout_cx.layout_of(tcx.types.u8)?,
 311             u16: layout_cx.layout_of(tcx.types.u16)?,
 312             u32: layout_cx.layout_of(tcx.types.u32)?,
 313             u64: layout_cx.layout_of(tcx.types.u64)?,
 314             u128: layout_cx.layout_of(tcx.types.u128)?,
 315             usize: layout_cx.layout_of(tcx.types.usize)?,
 316             bool: layout_cx.layout_of(tcx.types.bool)?,
 317             mut_raw_ptr: layout_cx.layout_of(mut_raw_ptr)?,
 318             const_raw_ptr: layout_cx.layout_of(const_raw_ptr)?,
 319         })
 320     }
 321
 322     pub fn uint(&self, size: Size) -> Option<TyAndLayout<'tcx>> {
 323         match size.bits() {
 324             8 => Some(self.u8),
 325             16 => Some(self.u16),
 326             32 => Some(self.u32),
 327             64 => Some(self.u64),
 328             128 => Some(self.u128),
 329             _ => None,
 330         }
 331     }
 332
 333     pub fn int(&self, size: Size) -> Option<TyAndLayout<'tcx>> {
 334         match size.bits() {
 335             8 => Some(self.i8),
 336             16 => Some(self.i16),
 337             32 => Some(self.i32),
 338             64 => Some(self.i64),
 339             128 => Some(self.i128),
 340             _ => None,
 341         }
 342     }
 343 }
 344
 345 /// The machine itself.
 346 ///
 347 /// If you add anything here that stores machine values, remember to update
 348 /// `visit_all_machine_values`!
 349 pub struct MiriMachine<'mir, 'tcx> {
 350     // We carry a copy of the global `TyCtxt` for convenience, so methods taking just `&Evaluator` have `tcx` access.
 351     pub tcx: TyCtxt<'tcx>,
 352
 353     /// Global data for borrow tracking.
 354     pub borrow_tracker: Option<borrow_tracker::GlobalState>,
 355
 356     /// Data race detector global data.
 357     pub data_race: Option<data_race::GlobalState>,
 358
 359     /// Ptr-int-cast module global data.
 360     pub intptrcast: intptrcast::GlobalState,
 361
 362     /// Environment variables set by `setenv`.
 363     /// Miri does not expose env vars from the host to the emulated program.
 364     pub(crate) env_vars: EnvVars<'tcx>,
 365
 366     /// Return place of the main function.
 367     pub(crate) main_fn_ret_place: Option<MemPlace<Provenance>>,
 368
 369     /// Program arguments (`Option` because we can only initialize them after creating the ecx).
 370     /// These are *pointers* to argc/argv because macOS.
 371     /// We also need the full command line as one string because of Windows.
 372     pub(crate) argc: Option<MemPlace<Provenance>>,
 373     pub(crate) argv: Option<MemPlace<Provenance>>,
 374     pub(crate) cmd_line: Option<MemPlace<Provenance>>,
 375
 376     /// TLS state.
 377     pub(crate) tls: TlsData<'tcx>,
 378
 379     /// What should Miri do when an op requires communicating with the host,
 380     /// such as accessing host env vars, random number generation, and
 381     /// file system access.
 382     pub(crate) isolated_op: IsolatedOp,
 383
 384     /// Whether to enforce the validity invariant.
 385     pub(crate) validate: bool,
 386
 387     /// Whether to enforce [ABI](Abi) of function calls.
 388     pub(crate) enforce_abi: bool,
 389
 390     /// The table of file descriptors.
 391     pub(crate) file_handler: shims::unix::FileHandler,
 392     /// The table of directory descriptors.
 393     pub(crate) dir_handler: shims::unix::DirHandler,
 394
 395     /// This machine's monotone clock.
 396     pub(crate) clock: Clock,
 397
 398     /// The set of threads.
 399     pub(crate) threads: ThreadManager<'mir, 'tcx>,
 400
 401     /// Precomputed `TyLayout`s for primitive data types that are commonly used inside Miri.
 402     pub(crate) layouts: PrimitiveLayouts<'tcx>,
 403
 404     /// Allocations that are considered roots of static memory (that may leak).
 405     pub(crate) static_roots: Vec<AllocId>,
 406
 407     /// The `measureme` profiler used to record timing information about
 408     /// the emulated program.
 409     profiler: Option<measureme::Profiler>,
 410     /// Used with `profiler` to cache the `StringId`s for event names
 411     /// uesd with `measureme`.
 412     string_cache: FxHashMap<String, measureme::StringId>,
 413
 414     /// Cache of `Instance` exported under the given `Symbol` name.
 415     /// `None` means no `Instance` exported under the given name is found.
 416     pub(crate) exported_symbols_cache: FxHashMap<Symbol, Option<Instance<'tcx>>>,
 417
 418     /// Whether to raise a panic in the context of the evaluated process when unsupported
 419     /// functionality is encountered. If `false`, an error is propagated in the Miri application context
 420     /// instead (default behavior)
 421     pub(crate) panic_on_unsupported: bool,
 422
 423     /// Equivalent setting as RUST_BACKTRACE on encountering an error.
 424     pub(crate) backtrace_style: BacktraceStyle,
 425
 426     /// Crates which are considered local for the purposes of error reporting.
 427     pub(crate) local_crates: Vec<CrateNum>,
 428
 429     /// Mapping extern static names to their base pointer.
 430     extern_statics: FxHashMap<Symbol, Pointer<Provenance>>,
 431
 432     /// The random number generator used for resolving non-determinism.
 433     /// Needs to be queried by ptr_to_int, hence needs interior mutability.
 434     pub(crate) rng: RefCell<StdRng>,
 435
 436     /// The allocation IDs to report when they are being allocated
 437     /// (helps for debugging memory leaks and use after free bugs).
 438     tracked_alloc_ids: FxHashSet<AllocId>,
 439
 440     /// Controls whether alignment of memory accesses is being checked.
 441     pub(crate) check_alignment: AlignmentCheck,
 442
 443     /// Failure rate of compare_exchange_weak, between 0.0 and 1.0
 444     pub(crate) cmpxchg_weak_failure_rate: f64,
 445
 446     /// Corresponds to -Zmiri-mute-stdout-stderr and doesn't write the output but acts as if it succeeded.
 447     pub(crate) mute_stdout_stderr: bool,
 448
 449     /// Whether weak memory emulation is enabled
 450     pub(crate) weak_memory: bool,
 451
 452     /// The probability of the active thread being preempted at the end of each basic block.
 453     pub(crate) preemption_rate: f64,
 454
 455     /// If `Some`, we will report the current stack every N basic blocks.
 456     pub(crate) report_progress: Option<u32>,
 457     // The total number of blocks that have been executed.
 458     pub(crate) basic_block_count: u64,
 459
 460     /// Handle of the optional shared object file for external functions.
 461     #[cfg(target_os = "linux")]
 462     pub external_so_lib: Option<(libloading::Library, std::path::PathBuf)>,
 463     #[cfg(not(target_os = "linux"))]
 464     pub external_so_lib: Option<!>,
 465
 466     /// Run a garbage collector for BorTags every N basic blocks.
 467     pub(crate) gc_interval: u32,
 468     /// The number of blocks that passed since the last BorTag GC pass.
 469     pub(crate) since_gc: u32,
 470     /// The number of CPUs to be reported by miri.
 471     pub(crate) num_cpus: u32,
 472 }
 473
 474 impl<'mir, 'tcx> MiriMachine<'mir, 'tcx> {
 475     pub(crate) fn new(config: &MiriConfig, layout_cx: LayoutCx<'tcx, TyCtxt<'tcx>>) -> Self {
 476         let local_crates = helpers::get_local_crates(layout_cx.tcx);
 477         let layouts =
 478             PrimitiveLayouts::new(layout_cx).expect("Couldn't get layouts of primitive types");
 479         let profiler = config.measureme_out.as_ref().map(|out| {
 480             measureme::Profiler::new(out).expect("Couldn't create `measureme` profiler")
 481         });
 482         let rng = StdRng::seed_from_u64(config.seed.unwrap_or(0));
 483         let borrow_tracker = config.borrow_tracker.map(|bt| bt.instanciate_global_state(config));
 484         let data_race = config.data_race_detector.then(|| data_race::GlobalState::new(config));
 485         MiriMachine {
 486             tcx: layout_cx.tcx,
 487             borrow_tracker,
 488             data_race,
 489             intptrcast: RefCell::new(intptrcast::GlobalStateInner::new(config)),
 490             // `env_vars` depends on a full interpreter so we cannot properly initialize it yet.
 491             env_vars: EnvVars::default(),
 492             main_fn_ret_place: None,
 493             argc: None,
 494             argv: None,
 495             cmd_line: None,
 496             tls: TlsData::default(),
 497             isolated_op: config.isolated_op,
 498             validate: config.validate,
 499             enforce_abi: config.check_abi,
 500             file_handler: FileHandler::new(config.mute_stdout_stderr),
 501             dir_handler: Default::default(),
 502             layouts,
 503             threads: ThreadManager::default(),
 504             static_roots: Vec::new(),
 505             profiler,
 506             string_cache: Default::default(),
 507             exported_symbols_cache: FxHashMap::default(),
 508             panic_on_unsupported: config.panic_on_unsupported,
 509             backtrace_style: config.backtrace_style,
 510             local_crates,
 511             extern_statics: FxHashMap::default(),
 512             rng: RefCell::new(rng),
 513             tracked_alloc_ids: config.tracked_alloc_ids.clone(),
 514             check_alignment: config.check_alignment,
 515             cmpxchg_weak_failure_rate: config.cmpxchg_weak_failure_rate,
 516             mute_stdout_stderr: config.mute_stdout_stderr,
 517             weak_memory: config.weak_memory_emulation,
 518             preemption_rate: config.preemption_rate,
 519             report_progress: config.report_progress,
 520             basic_block_count: 0,
 521             clock: Clock::new(config.isolated_op == IsolatedOp::Allow),
 522             #[cfg(target_os = "linux")]
 523             external_so_lib: config.external_so_file.as_ref().map(|lib_file_path| {
 524                 let target_triple = layout_cx.tcx.sess.opts.target_triple.triple();
 525                 // Check if host target == the session target.
 526                 if env!("TARGET") != target_triple {
 527                     panic!(
 528                         "calling external C functions in linked .so file requires host and target to be the same: host={}, target={}",
 529                         env!("TARGET"),
 530                         target_triple,
 531                     );
 532                 }
 533                 // Note: it is the user's responsibility to provide a correct SO file.
 534                 // WATCH OUT: If an invalid/incorrect SO file is specified, this can cause
 535                 // undefined behaviour in Miri itself!
 536                 (
 537                     unsafe {
 538                         libloading::Library::new(lib_file_path)
 539                             .expect("failed to read specified extern shared object file")
 540                     },
 541                     lib_file_path.clone(),
 542                 )
 543             }),
 544             #[cfg(not(target_os = "linux"))]
 545             external_so_lib: config.external_so_file.as_ref().map(|_| {
 546                 panic!("loading external .so files is only supported on Linux")
 547             }),
 548             gc_interval: config.gc_interval,
 549             since_gc: 0,
 550             num_cpus: config.num_cpus,
 551         }
 552     }
 553
 554     pub(crate) fn late_init(
 555         this: &mut MiriInterpCx<'mir, 'tcx>,
 556         config: &MiriConfig,
 557         on_main_stack_empty: StackEmptyCallback<'mir, 'tcx>,
 558     ) -> InterpResult<'tcx> {
 559         EnvVars::init(this, config)?;
 560         MiriMachine::init_extern_statics(this)?;
 561         ThreadManager::init(this, on_main_stack_empty);
 562         Ok(())
 563     }
 564
 565     fn add_extern_static(
 566         this: &mut MiriInterpCx<'mir, 'tcx>,
 567         name: &str,
 568         ptr: Pointer<Option<Provenance>>,
 569     ) {
 570         // This got just allocated, so there definitely is a pointer here.
 571         let ptr = ptr.into_pointer_or_addr().unwrap();
 572         this.machine.extern_statics.try_insert(Symbol::intern(name), ptr).unwrap();
 573     }
 574
 575     fn alloc_extern_static(
 576         this: &mut MiriInterpCx<'mir, 'tcx>,
 577         name: &str,
 578         val: ImmTy<'tcx, Provenance>,
 579     ) -> InterpResult<'tcx> {
 580         let place = this.allocate(val.layout, MiriMemoryKind::ExternStatic.into())?;
 581         this.write_immediate(*val, &place.into())?;
 582         Self::add_extern_static(this, name, place.ptr);
 583         Ok(())
 584     }
 585
 586     /// Sets up the "extern statics" for this machine.
 587     fn init_extern_statics(this: &mut MiriInterpCx<'mir, 'tcx>) -> InterpResult<'tcx> {
 588         match this.tcx.sess.target.os.as_ref() {
 589             "linux" => {
 590                 // "environ"
 591                 Self::add_extern_static(
 592                     this,
 593                     "environ",
 594                     this.machine.env_vars.environ.unwrap().ptr,
 595                 );
 596                 // A couple zero-initialized pointer-sized extern statics.
 597                 // Most of them are for weak symbols, which we all set to null (indicating that the
 598                 // symbol is not supported, and triggering fallback code which ends up calling a
 599                 // syscall that we do support).
 600                 for name in &["__cxa_thread_atexit_impl", "getrandom", "statx", "__clock_gettime64"]
 601                 {
 602                     let val = ImmTy::from_int(0, this.machine.layouts.usize);
 603                     Self::alloc_extern_static(this, name, val)?;
 604                 }
 605             }
 606             "freebsd" => {
 607                 // "environ"
 608                 Self::add_extern_static(
 609                     this,
 610                     "environ",
 611                     this.machine.env_vars.environ.unwrap().ptr,
 612                 );
 613             }
 614             "android" => {
 615                 // "signal"
 616                 let layout = this.machine.layouts.const_raw_ptr;
 617                 let dlsym = Dlsym::from_str("signal".as_bytes(), &this.tcx.sess.target.os)?
 618                     .expect("`signal` must be an actual dlsym on android");
 619                 let ptr = this.create_fn_alloc_ptr(FnVal::Other(dlsym));
 620                 let val = ImmTy::from_scalar(Scalar::from_pointer(ptr, this), layout);
 621                 Self::alloc_extern_static(this, "signal", val)?;
 622                 // A couple zero-initialized pointer-sized extern statics.
 623                 // Most of them are for weak symbols, which we all set to null (indicating that the
 624                 // symbol is not supported, and triggering fallback code.)
 625                 for name in &["bsd_signal"] {
 626                     let val = ImmTy::from_int(0, this.machine.layouts.usize);
 627                     Self::alloc_extern_static(this, name, val)?;
 628                 }
 629             }
 630             "windows" => {
 631                 // "_tls_used"
 632                 // This is some obscure hack that is part of the Windows TLS story. It's a `u8`.
 633                 let val = ImmTy::from_int(0, this.machine.layouts.u8);
 634                 Self::alloc_extern_static(this, "_tls_used", val)?;
 635             }
 636             _ => {} // No "extern statics" supported on this target
 637         }
 638         Ok(())
 639     }
 640
 641     pub(crate) fn communicate(&self) -> bool {
 642         self.isolated_op == IsolatedOp::Allow
 643     }
 644
 645     /// Check whether the stack frame that this `FrameInfo` refers to is part of a local crate.
 646     pub(crate) fn is_local(&self, frame: &FrameInfo<'_>) -> bool {
 647         let def_id = frame.instance.def_id();
 648         def_id.is_local() || self.local_crates.contains(&def_id.krate)
 649     }
 650 }
 651
 652 impl VisitTags for MiriMachine<'_, '_> {
 653     fn visit_tags(&self, visit: &mut dyn FnMut(BorTag)) {
 654         #[rustfmt::skip]
 655         let MiriMachine {
 656             threads,
 657             tls,
 658             env_vars,
 659             main_fn_ret_place,
 660             argc,
 661             argv,
 662             cmd_line,
 663             extern_statics,
 664             dir_handler,
 665             borrow_tracker,
 666             data_race,
 667             intptrcast,
 668             file_handler,
 669             tcx: _,
 670             isolated_op: _,
 671             validate: _,
 672             enforce_abi: _,
 673             clock: _,
 674             layouts: _,
 675             static_roots: _,
 676             profiler: _,
 677             string_cache: _,
 678             exported_symbols_cache: _,
 679             panic_on_unsupported: _,
 680             backtrace_style: _,
 681             local_crates: _,
 682             rng: _,
 683             tracked_alloc_ids: _,
 684             check_alignment: _,
 685             cmpxchg_weak_failure_rate: _,
 686             mute_stdout_stderr: _,
 687             weak_memory: _,
 688             preemption_rate: _,
 689             report_progress: _,
 690             basic_block_count: _,
 691             external_so_lib: _,
 692             gc_interval: _,
 693             since_gc: _,
 694             num_cpus: _,
 695         } = self;
 696
 697         threads.visit_tags(visit);
 698         tls.visit_tags(visit);
 699         env_vars.visit_tags(visit);
 700         dir_handler.visit_tags(visit);
 701         file_handler.visit_tags(visit);
 702         data_race.visit_tags(visit);
 703         borrow_tracker.visit_tags(visit);
 704         intptrcast.visit_tags(visit);
 705         main_fn_ret_place.visit_tags(visit);
 706         argc.visit_tags(visit);
 707         argv.visit_tags(visit);
 708         cmd_line.visit_tags(visit);
 709         for ptr in extern_statics.values() {
 710             ptr.visit_tags(visit);
 711         }
 712     }
 713 }
 714
 715 /// A rustc InterpCx for Miri.
 716 pub type MiriInterpCx<'mir, 'tcx> = InterpCx<'mir, 'tcx, MiriMachine<'mir, 'tcx>>;
 717
 718 /// A little trait that's useful to be inherited by extension traits.
 719 pub trait MiriInterpCxExt<'mir, 'tcx> {
 720     fn eval_context_ref<'a>(&'a self) -> &'a MiriInterpCx<'mir, 'tcx>;
 721     fn eval_context_mut<'a>(&'a mut self) -> &'a mut MiriInterpCx<'mir, 'tcx>;
 722 }
 723 impl<'mir, 'tcx> MiriInterpCxExt<'mir, 'tcx> for MiriInterpCx<'mir, 'tcx> {
 724     #[inline(always)]
 725     fn eval_context_ref(&self) -> &MiriInterpCx<'mir, 'tcx> {
 726         self
 727     }
 728     #[inline(always)]
 729     fn eval_context_mut(&mut self) -> &mut MiriInterpCx<'mir, 'tcx> {
 730         self
 731     }
 732 }
 733
 734 /// Machine hook implementations.
 735 impl<'mir, 'tcx> Machine<'mir, 'tcx> for MiriMachine<'mir, 'tcx> {
 736     type MemoryKind = MiriMemoryKind;
 737     type ExtraFnVal = Dlsym;
 738
 739     type FrameExtra = FrameExtra<'tcx>;
 740     type AllocExtra = AllocExtra;
 741
 742     type Provenance = Provenance;
 743     type ProvenanceExtra = ProvenanceExtra;
 744
 745     type MemoryMap = MonoHashMap<
 746         AllocId,
 747         (MemoryKind<MiriMemoryKind>, Allocation<Provenance, Self::AllocExtra>),
 748     >;
 749
 750     const GLOBAL_KIND: Option<MiriMemoryKind> = Some(MiriMemoryKind::Global);
 751
 752     const PANIC_ON_ALLOC_FAIL: bool = false;
 753
 754     #[inline(always)]
 755     fn enforce_alignment(ecx: &MiriInterpCx<'mir, 'tcx>) -> bool {
 756         ecx.machine.check_alignment != AlignmentCheck::None
 757     }
 758
 759     #[inline(always)]
 760     fn use_addr_for_alignment_check(ecx: &MiriInterpCx<'mir, 'tcx>) -> bool {
 761         ecx.machine.check_alignment == AlignmentCheck::Int
 762     }
 763
 764     #[inline(always)]
 765     fn enforce_validity(ecx: &MiriInterpCx<'mir, 'tcx>) -> bool {
 766         ecx.machine.validate
 767     }
 768
 769     #[inline(always)]
 770     fn enforce_abi(ecx: &MiriInterpCx<'mir, 'tcx>) -> bool {
 771         ecx.machine.enforce_abi
 772     }
 773
 774     #[inline(always)]
 775     fn checked_binop_checks_overflow(ecx: &MiriInterpCx<'mir, 'tcx>) -> bool {
 776         ecx.tcx.sess.overflow_checks()
 777     }
 778
 779     #[inline(always)]
 780     fn find_mir_or_eval_fn(
 781         ecx: &mut MiriInterpCx<'mir, 'tcx>,
 782         instance: ty::Instance<'tcx>,
 783         abi: Abi,
 784         args: &[OpTy<'tcx, Provenance>],
 785         dest: &PlaceTy<'tcx, Provenance>,
 786         ret: Option<mir::BasicBlock>,
 787         unwind: StackPopUnwind,
 788     ) -> InterpResult<'tcx, Option<(&'mir mir::Body<'tcx>, ty::Instance<'tcx>)>> {
 789         ecx.find_mir_or_eval_fn(instance, abi, args, dest, ret, unwind)
 790     }
 791
 792     #[inline(always)]
 793     fn call_extra_fn(
 794         ecx: &mut MiriInterpCx<'mir, 'tcx>,
 795         fn_val: Dlsym,
 796         abi: Abi,
 797         args: &[OpTy<'tcx, Provenance>],
 798         dest: &PlaceTy<'tcx, Provenance>,
 799         ret: Option<mir::BasicBlock>,
 800         _unwind: StackPopUnwind,
 801     ) -> InterpResult<'tcx> {
 802         ecx.call_dlsym(fn_val, abi, args, dest, ret)
 803     }
 804
 805     #[inline(always)]
 806     fn call_intrinsic(
 807         ecx: &mut MiriInterpCx<'mir, 'tcx>,
 808         instance: ty::Instance<'tcx>,
 809         args: &[OpTy<'tcx, Provenance>],
 810         dest: &PlaceTy<'tcx, Provenance>,
 811         ret: Option<mir::BasicBlock>,
 812         unwind: StackPopUnwind,
 813     ) -> InterpResult<'tcx> {
 814         ecx.call_intrinsic(instance, args, dest, ret, unwind)
 815     }
 816
 817     #[inline(always)]
 818     fn assert_panic(
 819         ecx: &mut MiriInterpCx<'mir, 'tcx>,
 820         msg: &mir::AssertMessage<'tcx>,
 821         unwind: Option<mir::BasicBlock>,
 822     ) -> InterpResult<'tcx> {
 823         ecx.assert_panic(msg, unwind)
 824     }
 825
 826     #[inline(always)]
 827     fn abort(_ecx: &mut MiriInterpCx<'mir, 'tcx>, msg: String) -> InterpResult<'tcx, !> {
 828         throw_machine_stop!(TerminationInfo::Abort(msg))
 829     }
 830
 831     #[inline(always)]
 832     fn binary_ptr_op(
 833         ecx: &MiriInterpCx<'mir, 'tcx>,
 834         bin_op: mir::BinOp,
 835         left: &ImmTy<'tcx, Provenance>,
 836         right: &ImmTy<'tcx, Provenance>,
 837     ) -> InterpResult<'tcx, (Scalar<Provenance>, bool, Ty<'tcx>)> {
 838         ecx.binary_ptr_op(bin_op, left, right)
 839     }
 840
 841     fn thread_local_static_base_pointer(
 842         ecx: &mut MiriInterpCx<'mir, 'tcx>,
 843         def_id: DefId,
 844     ) -> InterpResult<'tcx, Pointer<Provenance>> {
 845         ecx.get_or_create_thread_local_alloc(def_id)
 846     }
 847
 848     fn extern_static_base_pointer(
 849         ecx: &MiriInterpCx<'mir, 'tcx>,
 850         def_id: DefId,
 851     ) -> InterpResult<'tcx, Pointer<Provenance>> {
 852         let link_name = ecx.item_link_name(def_id);
 853         if let Some(&ptr) = ecx.machine.extern_statics.get(&link_name) {
 854             // Various parts of the engine rely on `get_alloc_info` for size and alignment
 855             // information. That uses the type information of this static.
 856             // Make sure it matches the Miri allocation for this.
 857             let Provenance::Concrete { alloc_id, .. } = ptr.provenance else {
 858                 panic!("extern_statics cannot contain wildcards")
 859             };
 860             let (shim_size, shim_align, _kind) = ecx.get_alloc_info(alloc_id);
 861             let extern_decl_layout =
 862                 ecx.tcx.layout_of(ty::ParamEnv::empty().and(ecx.tcx.type_of(def_id))).unwrap();
 863             if extern_decl_layout.size != shim_size || extern_decl_layout.align.abi != shim_align {
 864                 throw_unsup_format!(
 865                     "`extern` static `{name}` from crate `{krate}` has been declared \
 866                     with a size of {decl_size} bytes and alignment of {decl_align} bytes, \
 867                     but Miri emulates it via an extern static shim \
 868                     with a size of {shim_size} bytes and alignment of {shim_align} bytes",
 869                     name = ecx.tcx.def_path_str(def_id),
 870                     krate = ecx.tcx.crate_name(def_id.krate),
 871                     decl_size = extern_decl_layout.size.bytes(),
 872                     decl_align = extern_decl_layout.align.abi.bytes(),
 873                     shim_size = shim_size.bytes(),
 874                     shim_align = shim_align.bytes(),
 875                 )
 876             }
 877             Ok(ptr)
 878         } else {
 879             throw_unsup_format!(
 880                 "`extern` static `{name}` from crate `{krate}` is not supported by Miri",
 881                 name = ecx.tcx.def_path_str(def_id),
 882                 krate = ecx.tcx.crate_name(def_id.krate),
 883             )
 884         }
 885     }
 886
 887     fn adjust_allocation<'b>(
 888         ecx: &MiriInterpCx<'mir, 'tcx>,
 889         id: AllocId,
 890         alloc: Cow<'b, Allocation>,
 891         kind: Option<MemoryKind<Self::MemoryKind>>,
 892     ) -> InterpResult<'tcx, Cow<'b, Allocation<Self::Provenance, Self::AllocExtra>>> {
 893         let kind = kind.expect("we set our STATIC_KIND so this cannot be None");
 894         if ecx.machine.tracked_alloc_ids.contains(&id) {
 895             ecx.emit_diagnostic(NonHaltingDiagnostic::CreatedAlloc(
 896                 id,
 897                 alloc.size(),
 898                 alloc.align,
 899                 kind,
 900             ));
 901         }
 902
 903         let alloc = alloc.into_owned();
 904         let borrow_tracker = ecx
 905             .machine
 906             .borrow_tracker
 907             .as_ref()
 908             .map(|bt| bt.borrow_mut().new_allocation(id, alloc.size(), kind, &ecx.machine));
 909
 910         let race_alloc = ecx.machine.data_race.as_ref().map(|data_race| {
 911             data_race::AllocState::new_allocation(
 912                 data_race,
 913                 &ecx.machine.threads,
 914                 alloc.size(),
 915                 kind,
 916             )
 917         });
 918         let buffer_alloc = ecx.machine.weak_memory.then(weak_memory::AllocState::new_allocation);
 919         let alloc: Allocation<Provenance, Self::AllocExtra> = alloc.adjust_from_tcx(
 920             &ecx.tcx,
 921             AllocExtra { borrow_tracker, data_race: race_alloc, weak_memory: buffer_alloc },
 922             |ptr| ecx.global_base_pointer(ptr),
 923         )?;
 924         Ok(Cow::Owned(alloc))
 925     }
 926
 927     fn adjust_alloc_base_pointer(
 928         ecx: &MiriInterpCx<'mir, 'tcx>,
 929         ptr: Pointer<AllocId>,
 930     ) -> Pointer<Provenance> {
 931         if cfg!(debug_assertions) {
 932             // The machine promises to never call us on thread-local or extern statics.
 933             let alloc_id = ptr.provenance;
 934             match ecx.tcx.try_get_global_alloc(alloc_id) {
 935                 Some(GlobalAlloc::Static(def_id)) if ecx.tcx.is_thread_local_static(def_id) => {
 936                     panic!("adjust_alloc_base_pointer called on thread-local static")
 937                 }
 938                 Some(GlobalAlloc::Static(def_id)) if ecx.tcx.is_foreign_item(def_id) => {
 939                     panic!("adjust_alloc_base_pointer called on extern static")
 940                 }
 941                 _ => {}
 942             }
 943         }
 944         let absolute_addr = intptrcast::GlobalStateInner::rel_ptr_to_addr(ecx, ptr);
 945         let tag = if let Some(borrow_tracker) = &ecx.machine.borrow_tracker {
 946             borrow_tracker.borrow_mut().base_ptr_tag(ptr.provenance, &ecx.machine)
 947         } else {
 948             // Value does not matter, SB is disabled
 949             BorTag::default()
 950         };
 951         Pointer::new(
 952             Provenance::Concrete { alloc_id: ptr.provenance, tag },
 953             Size::from_bytes(absolute_addr),
 954         )
 955     }
 956
 957     #[inline(always)]
 958     fn ptr_from_addr_cast(
 959         ecx: &MiriInterpCx<'mir, 'tcx>,
 960         addr: u64,
 961     ) -> InterpResult<'tcx, Pointer<Option<Self::Provenance>>> {
 962         intptrcast::GlobalStateInner::ptr_from_addr_cast(ecx, addr)
 963     }
 964
 965     fn expose_ptr(
 966         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 967         ptr: Pointer<Self::Provenance>,
 968     ) -> InterpResult<'tcx> {
 969         match ptr.provenance {
 970             Provenance::Concrete { alloc_id, tag } => {
 971                 intptrcast::GlobalStateInner::expose_ptr(ecx, alloc_id, tag)
 972             }
 973             Provenance::Wildcard => {
 974                 // No need to do anything for wildcard pointers as
 975                 // their provenances have already been previously exposed.
 976                 Ok(())
 977             }
 978         }
 979     }
 980
 981     /// Convert a pointer with provenance into an allocation-offset pair,
 982     /// or a `None` with an absolute address if that conversion is not possible.
 983     fn ptr_get_alloc(
 984         ecx: &MiriInterpCx<'mir, 'tcx>,
 985         ptr: Pointer<Self::Provenance>,
 986     ) -> Option<(AllocId, Size, Self::ProvenanceExtra)> {
 987         let rel = intptrcast::GlobalStateInner::abs_ptr_to_rel(ecx, ptr);
 988
 989         rel.map(|(alloc_id, size)| {
 990             let tag = match ptr.provenance {
 991                 Provenance::Concrete { tag, .. } => ProvenanceExtra::Concrete(tag),
 992                 Provenance::Wildcard => ProvenanceExtra::Wildcard,
 993             };
 994             (alloc_id, size, tag)
 995         })
 996     }
 997
 998     #[inline(always)]
 999     fn before_memory_read(
1000         _tcx: TyCtxt<'tcx>,
1001         machine: &Self,
1002         alloc_extra: &AllocExtra,
1003         (alloc_id, prov_extra): (AllocId, Self::ProvenanceExtra),
1004         range: AllocRange,
1005     ) -> InterpResult<'tcx> {
1006         if let Some(data_race) = &alloc_extra.data_race {
1007             data_race.read(alloc_id, range, machine)?;
1008         }
1009         if let Some(borrow_tracker) = &alloc_extra.borrow_tracker {
1010             borrow_tracker.before_memory_read(alloc_id, prov_extra, range, machine)?;
1011         }
1012         if let Some(weak_memory) = &alloc_extra.weak_memory {
1013             weak_memory.memory_accessed(range, machine.data_race.as_ref().unwrap());
1014         }
1015         Ok(())
1016     }
1017
1018     #[inline(always)]
1019     fn before_memory_write(
1020         _tcx: TyCtxt<'tcx>,
1021         machine: &mut Self,
1022         alloc_extra: &mut AllocExtra,
1023         (alloc_id, prov_extra): (AllocId, Self::ProvenanceExtra),
1024         range: AllocRange,
1025     ) -> InterpResult<'tcx> {
1026         if let Some(data_race) = &mut alloc_extra.data_race {
1027             data_race.write(alloc_id, range, machine)?;
1028         }
1029         if let Some(borrow_tracker) = &mut alloc_extra.borrow_tracker {
1030             borrow_tracker.before_memory_write(alloc_id, prov_extra, range, machine)?;
1031         }
1032         if let Some(weak_memory) = &alloc_extra.weak_memory {
1033             weak_memory.memory_accessed(range, machine.data_race.as_ref().unwrap());
1034         }
1035         Ok(())
1036     }
1037
1038     #[inline(always)]
1039     fn before_memory_deallocation(
1040         _tcx: TyCtxt<'tcx>,
1041         machine: &mut Self,
1042         alloc_extra: &mut AllocExtra,
1043         (alloc_id, prove_extra): (AllocId, Self::ProvenanceExtra),
1044         range: AllocRange,
1045     ) -> InterpResult<'tcx> {
1046         if machine.tracked_alloc_ids.contains(&alloc_id) {
1047             machine.emit_diagnostic(NonHaltingDiagnostic::FreedAlloc(alloc_id));
1048         }
1049         if let Some(data_race) = &mut alloc_extra.data_race {
1050             data_race.deallocate(alloc_id, range, machine)?;
1051         }
1052         if let Some(borrow_tracker) = &mut alloc_extra.borrow_tracker {
1053             borrow_tracker.before_memory_deallocation(alloc_id, prove_extra, range, machine)?;
1054         }
1055         Ok(())
1056     }
1057
1058     #[inline(always)]
1059     fn retag_ptr_value(
1060         ecx: &mut InterpCx<'mir, 'tcx, Self>,
1061         kind: mir::RetagKind,
1062         val: &ImmTy<'tcx, Provenance>,
1063     ) -> InterpResult<'tcx, ImmTy<'tcx, Provenance>> {
1064         if ecx.machine.borrow_tracker.is_some() {
1065             ecx.retag_ptr_value(kind, val)
1066         } else {
1067             Ok(val.clone())
1068         }
1069     }
1070
1071     #[inline(always)]
1072     fn retag_place_contents(
1073         ecx: &mut InterpCx<'mir, 'tcx, Self>,
1074         kind: mir::RetagKind,
1075         place: &PlaceTy<'tcx, Provenance>,
1076     ) -> InterpResult<'tcx> {
1077         if ecx.machine.borrow_tracker.is_some() {
1078             ecx.retag_place_contents(kind, place)?;
1079         }
1080         Ok(())
1081     }
1082
1083     #[inline(always)]
1084     fn init_frame_extra(
1085         ecx: &mut InterpCx<'mir, 'tcx, Self>,
1086         frame: Frame<'mir, 'tcx, Provenance>,
1087     ) -> InterpResult<'tcx, Frame<'mir, 'tcx, Provenance, FrameExtra<'tcx>>> {
1088         // Start recording our event before doing anything else
1089         let timing = if let Some(profiler) = ecx.machine.profiler.as_ref() {
1090             let fn_name = frame.instance.to_string();
1091             let entry = ecx.machine.string_cache.entry(fn_name.clone());
1092             let name = entry.or_insert_with(|| profiler.alloc_string(&*fn_name));
1093
1094             Some(profiler.start_recording_interval_event_detached(
1095                 *name,
1096                 measureme::EventId::from_label(*name),
1097                 ecx.get_active_thread().to_u32(),
1098             ))
1099         } else {
1100             None
1101         };
1102
1103         let borrow_tracker = ecx.machine.borrow_tracker.as_ref();
1104
1105         let extra = FrameExtra {
1106             borrow_tracker: borrow_tracker.map(|bt| bt.borrow_mut().new_frame(&ecx.machine)),
1107             catch_unwind: None,
1108             timing,
1109             is_user_relevant: ecx.machine.is_user_relevant(&frame),
1110         };
1111
1112         Ok(frame.with_extra(extra))
1113     }
1114
1115     fn stack<'a>(
1116         ecx: &'a InterpCx<'mir, 'tcx, Self>,
1117     ) -> &'a [Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>] {
1118         ecx.active_thread_stack()
1119     }
1120
1121     fn stack_mut<'a>(
1122         ecx: &'a mut InterpCx<'mir, 'tcx, Self>,
1123     ) -> &'a mut Vec<Frame<'mir, 'tcx, Self::Provenance, Self::FrameExtra>> {
1124         ecx.active_thread_stack_mut()
1125     }
1126
1127     fn before_terminator(ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx> {
1128         ecx.machine.basic_block_count += 1u64; // a u64 that is only incremented by 1 will "never" overflow
1129         ecx.machine.since_gc += 1;
1130         // Possibly report our progress.
1131         if let Some(report_progress) = ecx.machine.report_progress {
1132             if ecx.machine.basic_block_count % u64::from(report_progress) == 0 {
1133                 ecx.emit_diagnostic(NonHaltingDiagnostic::ProgressReport {
1134                     block_count: ecx.machine.basic_block_count,
1135                 });
1136             }
1137         }
1138
1139         // Search for BorTags to find all live pointers, then remove all other tags from borrow
1140         // stacks.
1141         // When debug assertions are enabled, run the GC as often as possible so that any cases
1142         // where it mistakenly removes an important tag become visible.
1143         if ecx.machine.gc_interval > 0 && ecx.machine.since_gc >= ecx.machine.gc_interval {
1144             ecx.machine.since_gc = 0;
1145             ecx.garbage_collect_tags()?;
1146         }
1147
1148         // These are our preemption points.
1149         ecx.maybe_preempt_active_thread();
1150
1151         // Make sure some time passes.
1152         ecx.machine.clock.tick();
1153
1154         Ok(())
1155     }
1156
1157     #[inline(always)]
1158     fn after_stack_push(ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx> {
1159         if ecx.frame().extra.is_user_relevant {
1160             // We just pushed a local frame, so we know that the topmost local frame is the topmost
1161             // frame. If we push a non-local frame, there's no need to do anything.
1162             let stack_len = ecx.active_thread_stack().len();
1163             ecx.active_thread_mut().set_top_user_relevant_frame(stack_len - 1);
1164         }
1165         if ecx.machine.borrow_tracker.is_some() {
1166             ecx.retag_return_place()?;
1167         }
1168         Ok(())
1169     }
1170
1171     #[inline(always)]
1172     fn after_stack_pop(
1173         ecx: &mut InterpCx<'mir, 'tcx, Self>,
1174         mut frame: Frame<'mir, 'tcx, Provenance, FrameExtra<'tcx>>,
1175         unwinding: bool,
1176     ) -> InterpResult<'tcx, StackPopJump> {
1177         if frame.extra.is_user_relevant {
1178             // All that we store is whether or not the frame we just removed is local, so now we
1179             // have no idea where the next topmost local frame is. So we recompute it.
1180             // (If this ever becomes a bottleneck, we could have `push` store the previous
1181             // user-relevant frame and restore that here.)
1182             ecx.active_thread_mut().recompute_top_user_relevant_frame();
1183         }
1184         let timing = frame.extra.timing.take();
1185         if let Some(borrow_tracker) = &ecx.machine.borrow_tracker {
1186             borrow_tracker.borrow_mut().end_call(&frame.extra);
1187         }
1188         let res = ecx.handle_stack_pop_unwind(frame.extra, unwinding);
1189         if let Some(profiler) = ecx.machine.profiler.as_ref() {
1190             profiler.finish_recording_interval_event(timing.unwrap());
1191         }
1192         res
1193     }
1194 }