1 //! Global machine state as well as implementation of the interpreter engine
5 use std::cell::RefCell;
6 use std::num::NonZeroU64;
8 use std::time::Instant;
12 use rand::rngs::StdRng;
13 use rand::SeedableRng;
15 use rustc_data_structures::fx::FxHashMap;
20 layout::{LayoutCx, LayoutError, TyAndLayout},
24 use rustc_span::symbol::{sym, Symbol};
25 use rustc_span::def_id::DefId;
26 use rustc_target::abi::{LayoutOf, Size};
30 // Some global facts about the emulated machine.
31 pub const PAGE_SIZE: u64 = 4 * 1024; // FIXME: adjust to target architecture
32 pub const STACK_ADDR: u64 = 32 * PAGE_SIZE; // not really about the "stack", but where we start assigning integer addresses to allocations
33 pub const STACK_SIZE: u64 = 16 * PAGE_SIZE; // whatever
34 pub const NUM_CPUS: u64 = 1;
36 /// Extra data stored with each stack frame
38 pub struct FrameData<'tcx> {
39 /// Extra data for Stacked Borrows.
40 pub call_id: stacked_borrows::CallId,
42 /// If this is Some(), then this is a special "catch unwind" frame (the frame of `try_fn`
43 /// called by `try`). When this frame is popped during unwinding a panic,
44 /// we stop unwinding, use the `CatchUnwindData` to handle catching.
45 pub catch_unwind: Option<CatchUnwindData<'tcx>>,
48 /// Extra memory kinds
49 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
50 pub enum MiriMemoryKind {
51 /// `__rust_alloc` memory.
55 /// Windows `HeapAlloc` memory.
57 /// Memory for args, errno, and other parts of the machine-managed environment.
58 /// This memory may leak.
60 /// Memory for env vars. Separate from `Machine` because we clean it up and leak-check it.
62 /// Globals copied from `tcx`.
63 /// This memory may leak.
65 /// Memory for extern statics.
66 /// This memory may leak.
68 /// Memory for thread-local statics.
69 /// This memory may leak.
73 impl Into<MemoryKind<MiriMemoryKind>> for MiriMemoryKind {
75 fn into(self) -> MemoryKind<MiriMemoryKind> {
76 MemoryKind::Machine(self)
80 impl MayLeak for MiriMemoryKind {
82 fn may_leak(self) -> bool {
83 use self::MiriMemoryKind::*;
85 Rust | C | WinHeap | Env => false,
86 Machine | Global | ExternStatic | Tls => true,
91 impl fmt::Display for MiriMemoryKind {
92 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
93 use self::MiriMemoryKind::*;
95 Rust => write!(f, "Rust heap"),
96 C => write!(f, "C heap"),
97 WinHeap => write!(f, "Windows heap"),
98 Machine => write!(f, "machine-managed memory"),
99 Env => write!(f, "environment variable"),
100 Global => write!(f, "global (static or const)"),
101 ExternStatic => write!(f, "extern static"),
102 Tls => write!(f, "thread-local static"),
107 /// Extra per-allocation data
108 #[derive(Debug, Clone)]
109 pub struct AllocExtra {
110 /// Stacked Borrows state is only added if it is enabled.
111 pub stacked_borrows: Option<stacked_borrows::AllocExtra>,
112 /// Data race detection via the use of a vector-clock,
113 /// this is only added if it is enabled.
114 pub data_race: Option<data_race::AllocExtra>,
117 /// Extra global memory data
118 #[derive(Clone, Debug)]
119 pub struct MemoryExtra {
120 pub stacked_borrows: Option<stacked_borrows::MemoryExtra>,
121 pub data_race: Option<data_race::MemoryExtra>,
122 pub intptrcast: intptrcast::MemoryExtra,
124 /// Mapping extern static names to their canonical allocation.
125 extern_statics: FxHashMap<Symbol, AllocId>,
127 /// The random number generator used for resolving non-determinism.
128 /// Needs to be queried by ptr_to_int, hence needs interior mutability.
129 pub(crate) rng: RefCell<StdRng>,
131 /// An allocation ID to report when it is being allocated
132 /// (helps for debugging memory leaks and use after free bugs).
133 tracked_alloc_id: Option<AllocId>,
135 /// Controls whether alignment of memory accesses is being checked.
136 pub(crate) check_alignment: AlignmentCheck,
140 pub fn new(config: &MiriConfig) -> Self {
141 let rng = StdRng::seed_from_u64(config.seed.unwrap_or(0));
142 let stacked_borrows = if config.stacked_borrows {
143 Some(Rc::new(RefCell::new(stacked_borrows::GlobalState::new(
144 config.tracked_pointer_tag,
145 config.tracked_call_id,
151 let data_race = if config.data_race_detector {
152 Some(Rc::new(data_race::GlobalState::new()))
159 intptrcast: Default::default(),
160 extern_statics: FxHashMap::default(),
161 rng: RefCell::new(rng),
162 tracked_alloc_id: config.tracked_alloc_id,
163 check_alignment: config.check_alignment,
167 fn add_extern_static<'tcx, 'mir>(
168 this: &mut MiriEvalContext<'mir, 'tcx>,
172 let ptr = ptr.assert_ptr();
173 assert_eq!(ptr.offset, Size::ZERO);
177 .insert(Symbol::intern(name), ptr.alloc_id)
181 /// Sets up the "extern statics" for this machine.
182 pub fn init_extern_statics<'tcx, 'mir>(
183 this: &mut MiriEvalContext<'mir, 'tcx>,
184 ) -> InterpResult<'tcx> {
185 match this.tcx.sess.target.os.as_str() {
187 // "__cxa_thread_atexit_impl"
188 // This should be all-zero, pointer-sized.
189 let layout = this.machine.layouts.usize;
190 let place = this.allocate(layout, MiriMemoryKind::ExternStatic.into());
191 this.write_scalar(Scalar::from_machine_usize(0, this), place.into())?;
192 Self::add_extern_static(this, "__cxa_thread_atexit_impl", place.ptr);
194 Self::add_extern_static(this, "environ", this.machine.env_vars.environ.unwrap().ptr);
198 // This is some obscure hack that is part of the Windows TLS story. It's a `u8`.
199 let layout = this.machine.layouts.u8;
200 let place = this.allocate(layout, MiriMemoryKind::ExternStatic.into());
201 this.write_scalar(Scalar::from_u8(0), place.into())?;
202 Self::add_extern_static(this, "_tls_used", place.ptr);
204 _ => {} // No "extern statics" supported on this target
210 /// Precomputed layouts of primitive types
211 pub struct PrimitiveLayouts<'tcx> {
212 pub unit: TyAndLayout<'tcx>,
213 pub i8: TyAndLayout<'tcx>,
214 pub i32: TyAndLayout<'tcx>,
215 pub isize: TyAndLayout<'tcx>,
216 pub u8: TyAndLayout<'tcx>,
217 pub u32: TyAndLayout<'tcx>,
218 pub usize: TyAndLayout<'tcx>,
221 impl<'mir, 'tcx: 'mir> PrimitiveLayouts<'tcx> {
222 fn new(layout_cx: LayoutCx<'tcx, TyCtxt<'tcx>>) -> Result<Self, LayoutError<'tcx>> {
224 unit: layout_cx.layout_of(layout_cx.tcx.mk_unit())?,
225 i8: layout_cx.layout_of(layout_cx.tcx.types.i8)?,
226 i32: layout_cx.layout_of(layout_cx.tcx.types.i32)?,
227 isize: layout_cx.layout_of(layout_cx.tcx.types.isize)?,
228 u8: layout_cx.layout_of(layout_cx.tcx.types.u8)?,
229 u32: layout_cx.layout_of(layout_cx.tcx.types.u32)?,
230 usize: layout_cx.layout_of(layout_cx.tcx.types.usize)?,
235 /// The machine itself.
236 pub struct Evaluator<'mir, 'tcx> {
237 /// Environment variables set by `setenv`.
238 /// Miri does not expose env vars from the host to the emulated program.
239 pub(crate) env_vars: EnvVars<'tcx>,
241 /// Program arguments (`Option` because we can only initialize them after creating the ecx).
242 /// These are *pointers* to argc/argv because macOS.
243 /// We also need the full command line as one string because of Windows.
244 pub(crate) argc: Option<Scalar<Tag>>,
245 pub(crate) argv: Option<Scalar<Tag>>,
246 pub(crate) cmd_line: Option<Scalar<Tag>>,
249 pub(crate) tls: TlsData<'tcx>,
251 /// If enabled, the `env_vars` field is populated with the host env vars during initialization
252 /// and random number generation is delegated to the host.
253 pub(crate) communicate: bool,
255 /// Whether to enforce the validity invariant.
256 pub(crate) validate: bool,
258 pub(crate) file_handler: shims::posix::FileHandler,
259 pub(crate) dir_handler: shims::posix::DirHandler,
261 /// The "time anchor" for this machine's monotone clock (for `Instant` simulation).
262 pub(crate) time_anchor: Instant,
264 /// The set of threads.
265 pub(crate) threads: ThreadManager<'mir, 'tcx>,
267 /// Precomputed `TyLayout`s for primitive data types that are commonly used inside Miri.
268 pub(crate) layouts: PrimitiveLayouts<'tcx>,
270 /// Allocations that are considered roots of static memory (that may leak).
271 pub(crate) static_roots: Vec<AllocId>,
274 impl<'mir, 'tcx> Evaluator<'mir, 'tcx> {
278 layout_cx: LayoutCx<'tcx, TyCtxt<'tcx>>,
280 let layouts = PrimitiveLayouts::new(layout_cx)
281 .expect("Couldn't get layouts of primitive types");
283 // `env_vars` could be initialized properly here if `Memory` were available before
284 // calling this method.
285 env_vars: EnvVars::default(),
289 tls: TlsData::default(),
292 file_handler: Default::default(),
293 dir_handler: Default::default(),
294 time_anchor: Instant::now(),
296 threads: ThreadManager::default(),
297 static_roots: Vec::new(),
302 /// A rustc InterpCx for Miri.
303 pub type MiriEvalContext<'mir, 'tcx> = InterpCx<'mir, 'tcx, Evaluator<'mir, 'tcx>>;
305 /// A little trait that's useful to be inherited by extension traits.
306 pub trait MiriEvalContextExt<'mir, 'tcx> {
307 fn eval_context_ref<'a>(&'a self) -> &'a MiriEvalContext<'mir, 'tcx>;
308 fn eval_context_mut<'a>(&'a mut self) -> &'a mut MiriEvalContext<'mir, 'tcx>;
310 impl<'mir, 'tcx> MiriEvalContextExt<'mir, 'tcx> for MiriEvalContext<'mir, 'tcx> {
312 fn eval_context_ref(&self) -> &MiriEvalContext<'mir, 'tcx> {
316 fn eval_context_mut(&mut self) -> &mut MiriEvalContext<'mir, 'tcx> {
321 /// Machine hook implementations.
322 impl<'mir, 'tcx> Machine<'mir, 'tcx> for Evaluator<'mir, 'tcx> {
323 type MemoryKind = MiriMemoryKind;
325 type FrameExtra = FrameData<'tcx>;
326 type MemoryExtra = MemoryExtra;
327 type AllocExtra = AllocExtra;
328 type PointerTag = Tag;
329 type ExtraFnVal = Dlsym;
332 MonoHashMap<AllocId, (MemoryKind<MiriMemoryKind>, Allocation<Tag, Self::AllocExtra>)>;
334 const GLOBAL_KIND: Option<MiriMemoryKind> = Some(MiriMemoryKind::Global);
337 fn enforce_alignment(memory_extra: &MemoryExtra) -> bool {
338 memory_extra.check_alignment != AlignmentCheck::None
342 fn force_int_for_alignment_check(memory_extra: &Self::MemoryExtra) -> bool {
343 memory_extra.check_alignment == AlignmentCheck::Int
347 fn enforce_validity(ecx: &InterpCx<'mir, 'tcx, Self>) -> bool {
352 fn find_mir_or_eval_fn(
353 ecx: &mut InterpCx<'mir, 'tcx, Self>,
354 instance: ty::Instance<'tcx>,
355 args: &[OpTy<'tcx, Tag>],
356 ret: Option<(PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
357 unwind: Option<mir::BasicBlock>,
358 ) -> InterpResult<'tcx, Option<&'mir mir::Body<'tcx>>> {
359 ecx.find_mir_or_eval_fn(instance, args, ret, unwind)
364 ecx: &mut InterpCx<'mir, 'tcx, Self>,
366 args: &[OpTy<'tcx, Tag>],
367 ret: Option<(PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
368 _unwind: Option<mir::BasicBlock>,
369 ) -> InterpResult<'tcx> {
370 ecx.call_dlsym(fn_val, args, ret)
375 ecx: &mut rustc_mir::interpret::InterpCx<'mir, 'tcx, Self>,
376 instance: ty::Instance<'tcx>,
377 args: &[OpTy<'tcx, Tag>],
378 ret: Option<(PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
379 unwind: Option<mir::BasicBlock>,
380 ) -> InterpResult<'tcx> {
381 ecx.call_intrinsic(instance, args, ret, unwind)
386 ecx: &mut InterpCx<'mir, 'tcx, Self>,
387 msg: &mir::AssertMessage<'tcx>,
388 unwind: Option<mir::BasicBlock>,
389 ) -> InterpResult<'tcx> {
390 ecx.assert_panic(msg, unwind)
394 fn abort(_ecx: &mut InterpCx<'mir, 'tcx, Self>, msg: String) -> InterpResult<'tcx, !> {
395 throw_machine_stop!(TerminationInfo::Abort(msg))
400 ecx: &rustc_mir::interpret::InterpCx<'mir, 'tcx, Self>,
402 left: ImmTy<'tcx, Tag>,
403 right: ImmTy<'tcx, Tag>,
404 ) -> InterpResult<'tcx, (Scalar<Tag>, bool, ty::Ty<'tcx>)> {
405 ecx.binary_ptr_op(bin_op, left, right)
409 ecx: &mut InterpCx<'mir, 'tcx, Self>,
410 dest: PlaceTy<'tcx, Tag>,
411 ) -> InterpResult<'tcx> {
412 trace!("box_alloc for {:?}", dest.layout.ty);
413 let layout = ecx.layout_of(dest.layout.ty.builtin_deref(false).unwrap().ty)?;
414 // First argument: `size`.
415 // (`0` is allowed here -- this is expected to be handled by the lang item).
416 let size = Scalar::from_machine_usize(layout.size.bytes(), ecx);
418 // Second argument: `align`.
419 let align = Scalar::from_machine_usize(layout.align.abi.bytes(), ecx);
421 // Call the `exchange_malloc` lang item.
422 let malloc = ecx.tcx.lang_items().exchange_malloc_fn().unwrap();
423 let malloc = ty::Instance::mono(ecx.tcx.tcx, malloc);
426 &[size.into(), align.into()],
428 // Don't do anything when we are done. The `statement()` function will increment
429 // the old stack frame's stmt counter to the next statement, which means that when
430 // `exchange_malloc` returns, we go on evaluating exactly where we want to be.
431 StackPopCleanup::None { cleanup: true },
436 fn thread_local_static_alloc_id(
437 ecx: &mut InterpCx<'mir, 'tcx, Self>,
439 ) -> InterpResult<'tcx, AllocId> {
440 ecx.get_or_create_thread_local_alloc_id(def_id)
443 fn extern_static_alloc_id(
444 memory: &Memory<'mir, 'tcx, Self>,
446 ) -> InterpResult<'tcx, AllocId> {
447 let attrs = memory.tcx.get_attrs(def_id);
448 let link_name = match memory.tcx.sess.first_attr_value_str_by_name(&attrs, sym::link_name) {
450 None => memory.tcx.item_name(def_id),
452 if let Some(&id) = memory.extra.extern_statics.get(&link_name) {
455 throw_unsup_format!("`extern` static {:?} is not supported by Miri", def_id)
459 fn init_allocation_extra<'b>(
460 memory_extra: &MemoryExtra,
462 alloc: Cow<'b, Allocation>,
463 kind: Option<MemoryKind<Self::MemoryKind>>,
464 ) -> (Cow<'b, Allocation<Self::PointerTag, Self::AllocExtra>>, Self::PointerTag) {
465 if Some(id) == memory_extra.tracked_alloc_id {
466 register_diagnostic(NonHaltingDiagnostic::CreatedAlloc(id));
469 let kind = kind.expect("we set our STATIC_KIND so this cannot be None");
470 let alloc = alloc.into_owned();
471 let (stacks, base_tag) =
472 if let Some(stacked_borrows) = &memory_extra.stacked_borrows {
473 let (stacks, base_tag) =
474 Stacks::new_allocation(id, alloc.size, Rc::clone(stacked_borrows), kind);
475 (Some(stacks), base_tag)
477 // No stacks, no tag.
478 (None, Tag::Untagged)
480 let race_alloc = if let Some(data_race) = &memory_extra.data_race {
481 Some(data_race::AllocExtra::new_allocation(&data_race, alloc.size, kind))
485 let mut stacked_borrows = memory_extra.stacked_borrows.as_ref().map(|sb| sb.borrow_mut());
486 let alloc: Allocation<Tag, Self::AllocExtra> = alloc.with_tags_and_extra(
488 if let Some(stacked_borrows) = &mut stacked_borrows {
489 // Only globals may already contain pointers at this point
490 assert_eq!(kind, MiriMemoryKind::Global.into());
491 stacked_borrows.global_base_ptr(alloc)
496 AllocExtra { stacked_borrows: stacks, data_race: race_alloc },
498 (Cow::Owned(alloc), base_tag)
502 fn before_deallocation(
503 memory_extra: &mut Self::MemoryExtra,
505 ) -> InterpResult<'tcx> {
506 if Some(id) == memory_extra.tracked_alloc_id {
507 register_diagnostic(NonHaltingDiagnostic::FreedAlloc(id));
514 fn after_static_mem_initialized(
515 ecx: &mut InterpCx<'mir, 'tcx, Self>,
516 ptr: Pointer<Self::PointerTag>,
518 ) -> InterpResult<'tcx> {
519 if ecx.memory.extra.data_race.is_some() {
520 ecx.reset_vector_clocks(ptr, size)?;
526 fn tag_global_base_pointer(memory_extra: &MemoryExtra, id: AllocId) -> Self::PointerTag {
527 if let Some(stacked_borrows) = &memory_extra.stacked_borrows {
528 stacked_borrows.borrow_mut().global_base_ptr(id)
536 ecx: &mut InterpCx<'mir, 'tcx, Self>,
537 kind: mir::RetagKind,
538 place: PlaceTy<'tcx, Tag>,
539 ) -> InterpResult<'tcx> {
540 if ecx.memory.extra.stacked_borrows.is_some() {
541 ecx.retag(kind, place)
549 ecx: &mut InterpCx<'mir, 'tcx, Self>,
550 frame: Frame<'mir, 'tcx, Tag>,
551 ) -> InterpResult<'tcx, Frame<'mir, 'tcx, Tag, FrameData<'tcx>>> {
552 let stacked_borrows = ecx.memory.extra.stacked_borrows.as_ref();
553 let call_id = stacked_borrows.map_or(NonZeroU64::new(1).unwrap(), |stacked_borrows| {
554 stacked_borrows.borrow_mut().new_call()
556 let extra = FrameData { call_id, catch_unwind: None };
557 Ok(frame.with_extra(extra))
561 ecx: &'a InterpCx<'mir, 'tcx, Self>
562 ) -> &'a [Frame<'mir, 'tcx, Self::PointerTag, Self::FrameExtra>] {
563 ecx.active_thread_stack()
567 ecx: &'a mut InterpCx<'mir, 'tcx, Self>
568 ) -> &'a mut Vec<Frame<'mir, 'tcx, Self::PointerTag, Self::FrameExtra>> {
569 ecx.active_thread_stack_mut()
573 fn after_stack_push(ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx> {
574 if ecx.memory.extra.stacked_borrows.is_some() {
575 ecx.retag_return_place()
583 ecx: &mut InterpCx<'mir, 'tcx, Self>,
584 frame: Frame<'mir, 'tcx, Tag, FrameData<'tcx>>,
586 ) -> InterpResult<'tcx, StackPopJump> {
587 ecx.handle_stack_pop(frame.extra, unwinding)
592 memory: &Memory<'mir, 'tcx, Self>,
594 ) -> InterpResult<'tcx, Pointer<Self::PointerTag>> {
595 intptrcast::GlobalState::int_to_ptr(int, memory)
600 memory: &Memory<'mir, 'tcx, Self>,
601 ptr: Pointer<Self::PointerTag>,
602 ) -> InterpResult<'tcx, u64> {
603 intptrcast::GlobalState::ptr_to_int(ptr, memory)
607 impl AllocationExtra<Tag> for AllocExtra {
609 fn memory_read<'tcx>(
610 alloc: &Allocation<Tag, AllocExtra>,
613 ) -> InterpResult<'tcx> {
614 if let Some(data_race) = &alloc.extra.data_race {
615 data_race.read(ptr, size)?;
617 if let Some(stacked_borrows) = &alloc.extra.stacked_borrows {
618 stacked_borrows.memory_read(ptr, size)
625 fn memory_written<'tcx>(
626 alloc: &mut Allocation<Tag, AllocExtra>,
629 ) -> InterpResult<'tcx> {
630 if let Some(data_race) = &mut alloc.extra.data_race {
631 data_race.write(ptr, size)?;
633 if let Some(stacked_borrows) = &mut alloc.extra.stacked_borrows {
634 stacked_borrows.memory_written(ptr, size)
641 fn memory_deallocated<'tcx>(
642 alloc: &mut Allocation<Tag, AllocExtra>,
645 ) -> InterpResult<'tcx> {
646 if let Some(data_race) = &mut alloc.extra.data_race {
647 data_race.deallocate(ptr, size)?;
649 if let Some(stacked_borrows) = &mut alloc.extra.stacked_borrows {
650 stacked_borrows.memory_deallocated(ptr, size)