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::num::NonZeroU64;
   7 use std::rc::Rc;
   8
   9 use rand::rngs::StdRng;
  10
  11 use rustc_data_structures::fx::FxHashMap;
  12 use rustc::mir;
  13 use rustc::ty::{
  14     self,
  15     layout::{LayoutOf, Size},
  16     Ty,
  17 };
  18 use rustc_ast::attr;
  19 use rustc_span::{source_map::Span, symbol::{sym, Symbol}};
  20
  21 use crate::*;
  22
  23 // Some global facts about the emulated machine.
  24 pub const PAGE_SIZE: u64 = 4 * 1024; // FIXME: adjust to target architecture
  25 pub const STACK_ADDR: u64 = 32 * PAGE_SIZE; // not really about the "stack", but where we start assigning integer addresses to allocations
  26 pub const STACK_SIZE: u64 = 16 * PAGE_SIZE; // whatever
  27 pub const NUM_CPUS: u64 = 1;
  28
  29 /// Extra data stored with each stack frame
  30 #[derive(Debug)]
  31 pub struct FrameData<'tcx> {
  32     /// Extra data for Stacked Borrows.
  33     pub call_id: stacked_borrows::CallId,
  34
  35     /// If this is Some(), then this is a special "catch unwind" frame (the frame of the closure
  36     /// called by `__rustc_maybe_catch_panic`). When this frame is popped during unwinding a panic,
  37     /// we stop unwinding, use the `CatchUnwindData` to
  38     /// store the panic payload, and continue execution in the parent frame.
  39     pub catch_panic: Option<CatchUnwindData<'tcx>>,
  40 }
  41
  42 /// Extra memory kinds
  43 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
  44 pub enum MiriMemoryKind {
  45     /// `__rust_alloc` memory.
  46     Rust,
  47     /// `malloc` memory.
  48     C,
  49     /// Windows `HeapAlloc` memory.
  50     WinHeap,
  51     /// Memory for env vars and args, errno, extern statics and other parts of the machine-managed environment.
  52     Machine,
  53     /// Rust statics.
  54     Static,
  55 }
  56
  57 impl Into<MemoryKind<MiriMemoryKind>> for MiriMemoryKind {
  58     #[inline(always)]
  59     fn into(self) -> MemoryKind<MiriMemoryKind> {
  60         MemoryKind::Machine(self)
  61     }
  62 }
  63
  64 /// Extra per-allocation data
  65 #[derive(Debug, Clone)]
  66 pub struct AllocExtra {
  67     /// Stacked Borrows state is only added if it is enabled.
  68     pub stacked_borrows: Option<stacked_borrows::AllocExtra>,
  69 }
  70
  71 /// Extra global memory data
  72 #[derive(Clone, Debug)]
  73 pub struct MemoryExtra {
  74     pub stacked_borrows: Option<stacked_borrows::MemoryExtra>,
  75     pub intptrcast: intptrcast::MemoryExtra,
  76
  77     /// Mapping extern static names to their canonical allocation.
  78     extern_statics: FxHashMap<Symbol, AllocId>,
  79
  80     /// The random number generator used for resolving non-determinism.
  81     /// Needs to be queried by ptr_to_int, hence needs interior mutability.
  82     pub(crate) rng: RefCell<StdRng>,
  83
  84     /// An allocation ID to report when it is being allocated
  85     /// (helps for debugging memory leaks).
  86     tracked_alloc_id: Option<AllocId>,
  87 }
  88
  89 impl MemoryExtra {
  90     pub fn new(rng: StdRng, stacked_borrows: bool, tracked_pointer_tag: Option<PtrId>, tracked_alloc_id: Option<AllocId>) -> Self {
  91         let stacked_borrows = if stacked_borrows {
  92             Some(Rc::new(RefCell::new(stacked_borrows::GlobalState::new(tracked_pointer_tag))))
  93         } else {
  94             None
  95         };
  96         MemoryExtra {
  97             stacked_borrows,
  98             intptrcast: Default::default(),
  99             extern_statics: FxHashMap::default(),
 100             rng: RefCell::new(rng),
 101             tracked_alloc_id,
 102         }
 103     }
 104
 105     /// Sets up the "extern statics" for this machine.
 106     pub fn init_extern_statics<'tcx, 'mir>(
 107         this: &mut MiriEvalContext<'mir, 'tcx>,
 108     ) -> InterpResult<'tcx> {
 109         let target_os = this.tcx.sess.target.target.target_os.as_str();
 110         match target_os {
 111             "linux" => {
 112                 // "__cxa_thread_atexit_impl"
 113                 // This should be all-zero, pointer-sized.
 114                 let layout = this.layout_of(this.tcx.types.usize)?;
 115                 let place = this.allocate(layout, MiriMemoryKind::Machine.into());
 116                 this.write_scalar(Scalar::from_machine_usize(0, &*this.tcx), place.into())?;
 117                 this.memory
 118                     .extra
 119                     .extern_statics
 120                     .insert(Symbol::intern("__cxa_thread_atexit_impl"), place.ptr.assert_ptr().alloc_id)
 121                     .unwrap_none();
 122                 // "environ"
 123                 this.memory
 124                     .extra
 125                     .extern_statics
 126                     .insert(Symbol::intern("environ"), this.machine.env_vars.environ.unwrap().ptr.assert_ptr().alloc_id)
 127                     .unwrap_none();
 128             }
 129             _ => {} // No "extern statics" supported on this platform
 130         }
 131         Ok(())
 132     }
 133 }
 134
 135 /// The machine itself.
 136 pub struct Evaluator<'tcx> {
 137     /// Environment variables set by `setenv`.
 138     /// Miri does not expose env vars from the host to the emulated program.
 139     pub(crate) env_vars: EnvVars<'tcx>,
 140
 141     /// Program arguments (`Option` because we can only initialize them after creating the ecx).
 142     /// These are *pointers* to argc/argv because macOS.
 143     /// We also need the full command line as one string because of Windows.
 144     pub(crate) argc: Option<Scalar<Tag>>,
 145     pub(crate) argv: Option<Scalar<Tag>>,
 146     pub(crate) cmd_line: Option<Scalar<Tag>>,
 147
 148     /// Last OS error location in memory. It is a 32-bit integer.
 149     pub(crate) last_error: Option<MPlaceTy<'tcx, Tag>>,
 150
 151     /// TLS state.
 152     pub(crate) tls: TlsData<'tcx>,
 153
 154     /// If enabled, the `env_vars` field is populated with the host env vars during initialization
 155     /// and random number generation is delegated to the host.
 156     pub(crate) communicate: bool,
 157
 158     /// Whether to enforce the validity invariant.
 159     pub(crate) validate: bool,
 160
 161     pub(crate) file_handler: FileHandler,
 162     pub(crate) dir_handler: DirHandler,
 163
 164     /// The temporary used for storing the argument of
 165     /// the call to `miri_start_panic` (the panic payload) when unwinding.
 166     pub(crate) panic_payload: Option<ImmTy<'tcx, Tag>>,
 167 }
 168
 169 impl<'tcx> Evaluator<'tcx> {
 170     pub(crate) fn new(communicate: bool, validate: bool) -> Self {
 171         Evaluator {
 172             // `env_vars` could be initialized properly here if `Memory` were available before
 173             // calling this method.
 174             env_vars: EnvVars::default(),
 175             argc: None,
 176             argv: None,
 177             cmd_line: None,
 178             last_error: None,
 179             tls: TlsData::default(),
 180             communicate,
 181             validate,
 182             file_handler: Default::default(),
 183             dir_handler: Default::default(),
 184             panic_payload: None,
 185         }
 186     }
 187 }
 188
 189 /// A rustc InterpCx for Miri.
 190 pub type MiriEvalContext<'mir, 'tcx> = InterpCx<'mir, 'tcx, Evaluator<'tcx>>;
 191
 192 /// A little trait that's useful to be inherited by extension traits.
 193 pub trait MiriEvalContextExt<'mir, 'tcx> {
 194     fn eval_context_ref<'a>(&'a self) -> &'a MiriEvalContext<'mir, 'tcx>;
 195     fn eval_context_mut<'a>(&'a mut self) -> &'a mut MiriEvalContext<'mir, 'tcx>;
 196 }
 197 impl<'mir, 'tcx> MiriEvalContextExt<'mir, 'tcx> for MiriEvalContext<'mir, 'tcx> {
 198     #[inline(always)]
 199     fn eval_context_ref(&self) -> &MiriEvalContext<'mir, 'tcx> {
 200         self
 201     }
 202     #[inline(always)]
 203     fn eval_context_mut(&mut self) -> &mut MiriEvalContext<'mir, 'tcx> {
 204         self
 205     }
 206 }
 207
 208 /// Machine hook implementations.
 209 impl<'mir, 'tcx> Machine<'mir, 'tcx> for Evaluator<'tcx> {
 210     type MemoryKinds = MiriMemoryKind;
 211
 212     type FrameExtra = FrameData<'tcx>;
 213     type MemoryExtra = MemoryExtra;
 214     type AllocExtra = AllocExtra;
 215     type PointerTag = Tag;
 216     type ExtraFnVal = Dlsym;
 217
 218     type MemoryMap =
 219         MonoHashMap<AllocId, (MemoryKind<MiriMemoryKind>, Allocation<Tag, Self::AllocExtra>)>;
 220
 221     const STATIC_KIND: Option<MiriMemoryKind> = Some(MiriMemoryKind::Static);
 222
 223     const CHECK_ALIGN: bool = true;
 224
 225     #[inline(always)]
 226     fn enforce_validity(ecx: &InterpCx<'mir, 'tcx, Self>) -> bool {
 227         ecx.machine.validate
 228     }
 229
 230     #[inline(always)]
 231     fn find_mir_or_eval_fn(
 232         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 233         _span: Span,
 234         instance: ty::Instance<'tcx>,
 235         args: &[OpTy<'tcx, Tag>],
 236         ret: Option<(PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
 237         unwind: Option<mir::BasicBlock>,
 238     ) -> InterpResult<'tcx, Option<&'mir mir::Body<'tcx>>> {
 239         ecx.find_mir_or_eval_fn(instance, args, ret, unwind)
 240     }
 241
 242     #[inline(always)]
 243     fn call_extra_fn(
 244         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 245         fn_val: Dlsym,
 246         args: &[OpTy<'tcx, Tag>],
 247         ret: Option<(PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
 248         _unwind: Option<mir::BasicBlock>,
 249     ) -> InterpResult<'tcx> {
 250         ecx.call_dlsym(fn_val, args, ret)
 251     }
 252
 253     #[inline(always)]
 254     fn call_intrinsic(
 255         ecx: &mut rustc_mir::interpret::InterpCx<'mir, 'tcx, Self>,
 256         span: Span,
 257         instance: ty::Instance<'tcx>,
 258         args: &[OpTy<'tcx, Tag>],
 259         ret: Option<(PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
 260         unwind: Option<mir::BasicBlock>,
 261     ) -> InterpResult<'tcx> {
 262         ecx.call_intrinsic(span, instance, args, ret, unwind)
 263     }
 264
 265     #[inline(always)]
 266     fn assert_panic(
 267         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 268         msg: &mir::AssertMessage<'tcx>,
 269         unwind: Option<mir::BasicBlock>,
 270     ) -> InterpResult<'tcx> {
 271         ecx.assert_panic(msg, unwind)
 272     }
 273
 274     #[inline(always)]
 275     fn binary_ptr_op(
 276         ecx: &rustc_mir::interpret::InterpCx<'mir, 'tcx, Self>,
 277         bin_op: mir::BinOp,
 278         left: ImmTy<'tcx, Tag>,
 279         right: ImmTy<'tcx, Tag>,
 280     ) -> InterpResult<'tcx, (Scalar<Tag>, bool, Ty<'tcx>)> {
 281         ecx.binary_ptr_op(bin_op, left, right)
 282     }
 283
 284     fn box_alloc(
 285         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 286         dest: PlaceTy<'tcx, Tag>,
 287     ) -> InterpResult<'tcx> {
 288         trace!("box_alloc for {:?}", dest.layout.ty);
 289         let layout = ecx.layout_of(dest.layout.ty.builtin_deref(false).unwrap().ty)?;
 290         // First argument: `size`.
 291         // (`0` is allowed here -- this is expected to be handled by the lang item).
 292         let size = Scalar::from_uint(layout.size.bytes(), ecx.pointer_size());
 293
 294         // Second argument: `align`.
 295         let align = Scalar::from_uint(layout.align.abi.bytes(), ecx.pointer_size());
 296
 297         // Call the `exchange_malloc` lang item.
 298         let malloc = ecx.tcx.lang_items().exchange_malloc_fn().unwrap();
 299         let malloc = ty::Instance::mono(ecx.tcx.tcx, malloc);
 300         ecx.call_function(
 301             malloc,
 302             &[size.into(), align.into()],
 303             Some(dest),
 304             // Don't do anything when we are done. The `statement()` function will increment
 305             // the old stack frame's stmt counter to the next statement, which means that when
 306             // `exchange_malloc` returns, we go on evaluating exactly where we want to be.
 307             StackPopCleanup::None { cleanup: true },
 308         )?;
 309         Ok(())
 310     }
 311
 312     fn canonical_alloc_id(mem: &Memory<'mir, 'tcx, Self>, id: AllocId) -> AllocId {
 313         let tcx = mem.tcx;
 314         // Figure out if this is an extern static, and if yes, which one.
 315         let def_id = match tcx.alloc_map.lock().get(id) {
 316             Some(GlobalAlloc::Static(def_id)) if tcx.is_foreign_item(def_id) => def_id,
 317             _ => {
 318                 // No need to canonicalize anything.
 319                 return id;
 320             }
 321         };
 322         let attrs = tcx.get_attrs(def_id);
 323         let link_name = match attr::first_attr_value_str_by_name(&attrs, sym::link_name) {
 324             Some(name) => name,
 325             None => tcx.item_name(def_id),
 326         };
 327         // Check if we know this one.
 328         if let Some(canonical_id) = mem.extra.extern_statics.get(&link_name) {
 329             trace!("canonical_alloc_id: {:?} ({}) -> {:?}", id, link_name, canonical_id);
 330             *canonical_id
 331         } else {
 332             // Return original id; `Memory::get_static_alloc` will throw an error.
 333             id
 334         }
 335     }
 336
 337     fn init_allocation_extra<'b>(
 338         memory_extra: &MemoryExtra,
 339         id: AllocId,
 340         alloc: Cow<'b, Allocation>,
 341         kind: Option<MemoryKind<Self::MemoryKinds>>,
 342     ) -> (Cow<'b, Allocation<Self::PointerTag, Self::AllocExtra>>, Self::PointerTag) {
 343         if Some(id) == memory_extra.tracked_alloc_id {
 344             register_diagnostic(NonHaltingDiagnostic::CreatedAlloc(id));
 345         }
 346
 347         let kind = kind.expect("we set our STATIC_KIND so this cannot be None");
 348         let alloc = alloc.into_owned();
 349         let (stacks, base_tag) =
 350             if let Some(stacked_borrows) = memory_extra.stacked_borrows.as_ref() {
 351                 let (stacks, base_tag) =
 352                     Stacks::new_allocation(id, alloc.size, Rc::clone(stacked_borrows), kind);
 353                 (Some(stacks), base_tag)
 354             } else {
 355                 // No stacks, no tag.
 356                 (None, Tag::Untagged)
 357             };
 358         let mut stacked_borrows = memory_extra.stacked_borrows.as_ref().map(|sb| sb.borrow_mut());
 359         let alloc: Allocation<Tag, Self::AllocExtra> = alloc.with_tags_and_extra(
 360             |alloc| {
 361                 if let Some(stacked_borrows) = stacked_borrows.as_mut() {
 362                     // Only statics may already contain pointers at this point
 363                     assert_eq!(kind, MiriMemoryKind::Static.into());
 364                     stacked_borrows.static_base_ptr(alloc)
 365                 } else {
 366                     Tag::Untagged
 367                 }
 368             },
 369             AllocExtra { stacked_borrows: stacks },
 370         );
 371         (Cow::Owned(alloc), base_tag)
 372     }
 373
 374     #[inline(always)]
 375     fn tag_static_base_pointer(memory_extra: &MemoryExtra, id: AllocId) -> Self::PointerTag {
 376         if let Some(stacked_borrows) = memory_extra.stacked_borrows.as_ref() {
 377             stacked_borrows.borrow_mut().static_base_ptr(id)
 378         } else {
 379             Tag::Untagged
 380         }
 381     }
 382
 383     #[inline(always)]
 384     fn retag(
 385         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 386         kind: mir::RetagKind,
 387         place: PlaceTy<'tcx, Tag>,
 388     ) -> InterpResult<'tcx> {
 389         if ecx.memory.extra.stacked_borrows.is_none() {
 390             // No tracking.
 391             Ok(())
 392         } else {
 393             ecx.retag(kind, place)
 394         }
 395     }
 396
 397     #[inline(always)]
 398     fn stack_push(ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx, FrameData<'tcx>> {
 399         let stacked_borrows = ecx.memory.extra.stacked_borrows.as_ref();
 400         let call_id = stacked_borrows.map_or(NonZeroU64::new(1).unwrap(), |stacked_borrows| {
 401             stacked_borrows.borrow_mut().new_call()
 402         });
 403         Ok(FrameData { call_id, catch_panic: None })
 404     }
 405
 406     #[inline(always)]
 407     fn stack_pop(
 408         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 409         extra: FrameData<'tcx>,
 410         unwinding: bool,
 411     ) -> InterpResult<'tcx, StackPopInfo> {
 412         ecx.handle_stack_pop(extra, unwinding)
 413     }
 414
 415     #[inline(always)]
 416     fn int_to_ptr(
 417         memory: &Memory<'mir, 'tcx, Self>,
 418         int: u64,
 419     ) -> InterpResult<'tcx, Pointer<Self::PointerTag>> {
 420         intptrcast::GlobalState::int_to_ptr(int, memory)
 421     }
 422
 423     #[inline(always)]
 424     fn ptr_to_int(
 425         memory: &Memory<'mir, 'tcx, Self>,
 426         ptr: Pointer<Self::PointerTag>,
 427     ) -> InterpResult<'tcx, u64> {
 428         intptrcast::GlobalState::ptr_to_int(ptr, memory)
 429     }
 430 }
 431
 432 impl AllocationExtra<Tag> for AllocExtra {
 433     #[inline(always)]
 434     fn memory_read<'tcx>(
 435         alloc: &Allocation<Tag, AllocExtra>,
 436         ptr: Pointer<Tag>,
 437         size: Size,
 438     ) -> InterpResult<'tcx> {
 439         if let Some(ref stacked_borrows) = alloc.extra.stacked_borrows {
 440             stacked_borrows.memory_read(ptr, size)
 441         } else {
 442             Ok(())
 443         }
 444     }
 445
 446     #[inline(always)]
 447     fn memory_written<'tcx>(
 448         alloc: &mut Allocation<Tag, AllocExtra>,
 449         ptr: Pointer<Tag>,
 450         size: Size,
 451     ) -> InterpResult<'tcx> {
 452         if let Some(ref mut stacked_borrows) = alloc.extra.stacked_borrows {
 453             stacked_borrows.memory_written(ptr, size)
 454         } else {
 455             Ok(())
 456         }
 457     }
 458
 459     #[inline(always)]
 460     fn memory_deallocated<'tcx>(
 461         alloc: &mut Allocation<Tag, AllocExtra>,
 462         ptr: Pointer<Tag>,
 463         size: Size,
 464     ) -> InterpResult<'tcx> {
 465         if let Some(ref mut stacked_borrows) = alloc.extra.stacked_borrows {
 466             stacked_borrows.memory_deallocated(ptr, size)
 467         } else {
 468             Ok(())
 469         }
 470     }
 471 }
 472
 473 impl MayLeak for MiriMemoryKind {
 474     #[inline(always)]
 475     fn may_leak(self) -> bool {
 476         use self::MiriMemoryKind::*;
 477         match self {
 478             Rust | C | WinHeap => false,
 479             Machine | Static => true,
 480         }
 481     }
 482 }