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