]> git.lizzy.rs Git - rust.git/blobdiff - src/machine.rs
env shim: make sure we clean up all the memory we allocate
[rust.git] / src / machine.rs
index d15e290cbfdc9982be5fc995fdd5467686cdc72e..a530ef66d384e16948781e3b76ac37cd602a02e2 100644 (file)
@@ -5,6 +5,7 @@
 use std::cell::RefCell;
 use std::num::NonZeroU64;
 use std::rc::Rc;
+use std::time::Instant;
 
 use rand::rngs::StdRng;
 
@@ -32,11 +33,10 @@ pub struct FrameData<'tcx> {
     /// Extra data for Stacked Borrows.
     pub call_id: stacked_borrows::CallId,
 
-    /// If this is Some(), then this is a special "catch unwind" frame (the frame of the closure
-    /// called by `__rustc_maybe_catch_panic`). When this frame is popped during unwinding a panic,
-    /// we stop unwinding, use the `CatchUnwindData` to
-    /// store the panic payload, and continue execution in the parent frame.
-    pub catch_panic: Option<CatchUnwindData<'tcx>>,
+    /// If this is Some(), then this is a special "catch unwind" frame (the frame of `try_fn`
+    /// called by `try`). When this frame is popped during unwinding a panic,
+    /// we stop unwinding, use the `CatchUnwindData` to handle catching.
+    pub catch_unwind: Option<CatchUnwindData<'tcx>>,
 }
 
 /// Extra memory kinds
@@ -48,10 +48,14 @@ pub enum MiriMemoryKind {
     C,
     /// Windows `HeapAlloc` memory.
     WinHeap,
-    /// Memory for env vars and args, errno, extern statics and other parts of the machine-managed environment.
+    /// Memory for args, errno, extern statics and other parts of the machine-managed environment.
+    /// This memory may leak.
     Machine,
-    /// Rust statics.
-    Static,
+    /// Memory for env vars. Separate from `Machine` because we clean it up and leak-check it.
+    Env,
+    /// Globals copied from `tcx`.
+    /// This memory may leak.
+    Global,
 }
 
 impl Into<MemoryKind<MiriMemoryKind>> for MiriMemoryKind {
@@ -103,7 +107,7 @@ pub fn new(rng: StdRng, stacked_borrows: bool, tracked_pointer_tag: Option<PtrId
     }
 
     /// Sets up the "extern statics" for this machine.
-    pub fn init_extern_statics<'mir, 'tcx>(
+    pub fn init_extern_statics<'tcx, 'mir>(
         this: &mut MiriEvalContext<'mir, 'tcx>,
     ) -> InterpResult<'tcx> {
         match this.tcx.sess.target.target.target_os.as_str() {
@@ -118,8 +122,14 @@ pub fn init_extern_statics<'mir, 'tcx>(
                     .extern_statics
                     .insert(Symbol::intern("__cxa_thread_atexit_impl"), place.ptr.assert_ptr().alloc_id)
                     .unwrap_none();
+                // "environ"
+                this.memory
+                    .extra
+                    .extern_statics
+                    .insert(Symbol::intern("environ"), this.machine.env_vars.environ.unwrap().ptr.assert_ptr().alloc_id)
+                    .unwrap_none();
             }
-            _ => {} // No "extern statics" supported on this platform
+            _ => {} // No "extern statics" supported on this target
         }
         Ok(())
     }
@@ -129,7 +139,7 @@ pub fn init_extern_statics<'mir, 'tcx>(
 pub struct Evaluator<'tcx> {
     /// Environment variables set by `setenv`.
     /// Miri does not expose env vars from the host to the emulated program.
-    pub(crate) env_vars: EnvVars,
+    pub(crate) env_vars: EnvVars<'tcx>,
 
     /// Program arguments (`Option` because we can only initialize them after creating the ecx).
     /// These are *pointers* to argc/argv because macOS.
@@ -156,7 +166,11 @@ pub struct Evaluator<'tcx> {
 
     /// The temporary used for storing the argument of
     /// the call to `miri_start_panic` (the panic payload) when unwinding.
-    pub(crate) panic_payload: Option<ImmTy<'tcx, Tag>>,
+    /// This is pointer-sized, and matches the `Payload` type in `src/libpanic_unwind/miri.rs`.
+    pub(crate) panic_payload: Option<Scalar<Tag>>,
+
+    /// The "time anchor" for this machine's monotone clock (for `Instant` simulation).
+    pub(crate) time_anchor: Instant,
 }
 
 impl<'tcx> Evaluator<'tcx> {
@@ -175,6 +189,7 @@ pub(crate) fn new(communicate: bool, validate: bool) -> Self {
             file_handler: Default::default(),
             dir_handler: Default::default(),
             panic_payload: None,
+            time_anchor: Instant::now(),
         }
     }
 }
@@ -200,7 +215,7 @@ fn eval_context_mut(&mut self) -> &mut MiriEvalContext<'mir, 'tcx> {
 
 /// Machine hook implementations.
 impl<'mir, 'tcx> Machine<'mir, 'tcx> for Evaluator<'tcx> {
-    type MemoryKinds = MiriMemoryKind;
+    type MemoryKind = MiriMemoryKind;
 
     type FrameExtra = FrameData<'tcx>;
     type MemoryExtra = MemoryExtra;
@@ -211,7 +226,7 @@ impl<'mir, 'tcx> Machine<'mir, 'tcx> for Evaluator<'tcx> {
     type MemoryMap =
         MonoHashMap<AllocId, (MemoryKind<MiriMemoryKind>, Allocation<Tag, Self::AllocExtra>)>;
 
-    const STATIC_KIND: Option<MiriMemoryKind> = Some(MiriMemoryKind::Static);
+    const GLOBAL_KIND: Option<MiriMemoryKind> = Some(MiriMemoryKind::Global);
 
     const CHECK_ALIGN: bool = true;
 
@@ -258,11 +273,15 @@ fn call_intrinsic(
     #[inline(always)]
     fn assert_panic(
         ecx: &mut InterpCx<'mir, 'tcx, Self>,
-        span: Span,
         msg: &mir::AssertMessage<'tcx>,
         unwind: Option<mir::BasicBlock>,
     ) -> InterpResult<'tcx> {
-        ecx.assert_panic(span, msg, unwind)
+        ecx.assert_panic(msg, unwind)
+    }
+
+    #[inline(always)]
+    fn abort(_ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx, !> {
+        throw_machine_stop!(TerminationInfo::Abort(None))
     }
 
     #[inline(always)]
@@ -332,7 +351,7 @@ fn init_allocation_extra<'b>(
         memory_extra: &MemoryExtra,
         id: AllocId,
         alloc: Cow<'b, Allocation>,
-        kind: Option<MemoryKind<Self::MemoryKinds>>,
+        kind: Option<MemoryKind<Self::MemoryKind>>,
     ) -> (Cow<'b, Allocation<Self::PointerTag, Self::AllocExtra>>, Self::PointerTag) {
         if Some(id) == memory_extra.tracked_alloc_id {
             register_diagnostic(NonHaltingDiagnostic::CreatedAlloc(id));
@@ -353,9 +372,9 @@ fn init_allocation_extra<'b>(
         let alloc: Allocation<Tag, Self::AllocExtra> = alloc.with_tags_and_extra(
             |alloc| {
                 if let Some(stacked_borrows) = stacked_borrows.as_mut() {
-                    // Only statics may already contain pointers at this point
-                    assert_eq!(kind, MiriMemoryKind::Static.into());
-                    stacked_borrows.static_base_ptr(alloc)
+                    // Only globals may already contain pointers at this point
+                    assert_eq!(kind, MiriMemoryKind::Global.into());
+                    stacked_borrows.global_base_ptr(alloc)
                 } else {
                     Tag::Untagged
                 }
@@ -366,9 +385,9 @@ fn init_allocation_extra<'b>(
     }
 
     #[inline(always)]
-    fn tag_static_base_pointer(memory_extra: &MemoryExtra, id: AllocId) -> Self::PointerTag {
+    fn tag_global_base_pointer(memory_extra: &MemoryExtra, id: AllocId) -> Self::PointerTag {
         if let Some(stacked_borrows) = memory_extra.stacked_borrows.as_ref() {
-            stacked_borrows.borrow_mut().static_base_ptr(id)
+            stacked_borrows.borrow_mut().global_base_ptr(id)
         } else {
             Tag::Untagged
         }
@@ -394,7 +413,7 @@ fn stack_push(ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx, FrameD
         let call_id = stacked_borrows.map_or(NonZeroU64::new(1).unwrap(), |stacked_borrows| {
             stacked_borrows.borrow_mut().new_call()
         });
-        Ok(FrameData { call_id, catch_panic: None })
+        Ok(FrameData { call_id, catch_unwind: None })
     }
 
     #[inline(always)]
@@ -402,7 +421,7 @@ fn stack_pop(
         ecx: &mut InterpCx<'mir, 'tcx, Self>,
         extra: FrameData<'tcx>,
         unwinding: bool,
-    ) -> InterpResult<'tcx, StackPopInfo> {
+    ) -> InterpResult<'tcx, StackPopJump> {
         ecx.handle_stack_pop(extra, unwinding)
     }
 
@@ -469,8 +488,8 @@ impl MayLeak for MiriMemoryKind {
     fn may_leak(self) -> bool {
         use self::MiriMemoryKind::*;
         match self {
-            Rust | C | WinHeap => false,
-            Machine | Static => true,
+            Rust | C | WinHeap | Env => false,
+            Machine | Global => true,
         }
     }
 }