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