]> git.lizzy.rs Git - rust.git/blobdiff - src/eval.rs
Auto merge of #2426 - saethlin:unix-exec, r=RalfJung
[rust.git] / src / eval.rs
index badda8f3bc3938910a652087d0970a1c2be100cf..53264bd465914e943ba5bf4b405dcf73085d5117 100644 (file)
@@ -1,7 +1,10 @@
 //! Main evaluator loop and setting up the initial stack frame.
 
+use std::collections::HashSet;
 use std::ffi::OsStr;
 use std::iter;
+use std::panic::{self, AssertUnwindSafe};
+use std::thread;
 
 use log::info;
 
@@ -15,8 +18,6 @@
 
 use rustc_session::config::EntryFnType;
 
-use std::collections::HashSet;
-
 use crate::*;
 
 #[derive(Copy, Clone, Debug, PartialEq)]
@@ -77,8 +78,6 @@ pub struct MiriConfig {
     pub stacked_borrows: bool,
     /// Controls alignment checking.
     pub check_alignment: AlignmentCheck,
-    /// Controls integer and float validity (e.g., initialization) checking.
-    pub check_number_validity: bool,
     /// Controls function [ABI](Abi) checking.
     pub check_abi: bool,
     /// Action for an op requiring communication with the host.
@@ -94,15 +93,17 @@ pub struct MiriConfig {
     /// The seed to use when non-determinism or randomness are required (e.g. ptr-to-int cast, `getrandom()`).
     pub seed: Option<u64>,
     /// The stacked borrows pointer ids to report about
-    pub tracked_pointer_tags: HashSet<PtrId>,
+    pub tracked_pointer_tags: HashSet<SbTag>,
     /// The stacked borrows call IDs to report about
     pub tracked_call_ids: HashSet<CallId>,
     /// The allocation ids to report about.
     pub tracked_alloc_ids: HashSet<AllocId>,
-    /// Whether to track raw pointers in stacked borrows.
-    pub tag_raw: bool,
     /// Determine if data race detection should be enabled
     pub data_race_detector: bool,
+    /// Determine if weak memory emulation should be enabled. Requires data race detection to be enabled
+    pub weak_memory_emulation: bool,
+    /// Track when an outdated (weak memory) load happens.
+    pub track_outdated_loads: bool,
     /// Rate of spurious failures for compare_exchange_weak atomic operations,
     /// between 0.0 and 1.0, defaulting to 0.8 (80% chance of failure).
     pub cmpxchg_weak_failure_rate: f64,
@@ -118,6 +119,12 @@ pub struct MiriConfig {
     /// Whether to ignore any output by the program. This is helpful when debugging miri
     /// as its messages don't get intermingled with the program messages.
     pub mute_stdout_stderr: bool,
+    /// The probability of the active thread being preempted at the end of each basic block.
+    pub preemption_rate: f64,
+    /// Report the current instruction being executed every N basic blocks.
+    pub report_progress: Option<u32>,
+    /// Whether Stacked Borrows retagging should recurse into fields of datatypes.
+    pub retag_fields: bool,
 }
 
 impl Default for MiriConfig {
@@ -126,7 +133,6 @@ fn default() -> MiriConfig {
             validate: true,
             stacked_borrows: true,
             check_alignment: AlignmentCheck::Int,
-            check_number_validity: false,
             check_abi: true,
             isolated_op: IsolatedOp::Reject(RejectOpWith::Abort),
             ignore_leaks: false,
@@ -137,14 +143,18 @@ fn default() -> MiriConfig {
             tracked_pointer_tags: HashSet::default(),
             tracked_call_ids: HashSet::default(),
             tracked_alloc_ids: HashSet::default(),
-            tag_raw: false,
             data_race_detector: true,
-            cmpxchg_weak_failure_rate: 0.8,
+            weak_memory_emulation: true,
+            track_outdated_loads: false,
+            cmpxchg_weak_failure_rate: 0.8, // 80%
             measureme_out: None,
             panic_on_unsupported: false,
             backtrace_style: BacktraceStyle::Short,
-            provenance_mode: ProvenanceMode::Legacy,
+            provenance_mode: ProvenanceMode::Default,
             mute_stdout_stderr: false,
+            preemption_rate: 0.01, // 1%
+            report_progress: None,
+            retag_fields: false,
         }
     }
 }
@@ -158,7 +168,7 @@ pub fn create_ecx<'mir, 'tcx: 'mir>(
     entry_id: DefId,
     entry_type: EntryFnType,
     config: &MiriConfig,
-) -> InterpResult<'tcx, (InterpCx<'mir, 'tcx, Evaluator<'mir, 'tcx>>, MPlaceTy<'tcx, Tag>)> {
+) -> InterpResult<'tcx, (InterpCx<'mir, 'tcx, Evaluator<'mir, 'tcx>>, MPlaceTy<'tcx, Provenance>)> {
     let param_env = ty::ParamEnv::reveal_all();
     let layout_cx = LayoutCx { tcx, param_env };
     let mut ecx = InterpCx::new(
@@ -195,7 +205,7 @@ pub fn create_ecx<'mir, 'tcx: 'mir>(
     // Third argument (`argv`): created from `config.args`.
     let argv = {
         // Put each argument in memory, collect pointers.
-        let mut argvs = Vec::<Immediate<Tag>>::new();
+        let mut argvs = Vec::<Immediate<Provenance>>::new();
         for arg in config.args.iter() {
             // Make space for `0` terminator.
             let size = u64::try_from(arg.len()).unwrap().checked_add(1).unwrap();
@@ -203,7 +213,7 @@ pub fn create_ecx<'mir, 'tcx: 'mir>(
             let arg_place =
                 ecx.allocate(ecx.layout_of(arg_type)?, MiriMemoryKind::Machine.into())?;
             ecx.write_os_str_to_c_str(OsStr::new(arg), arg_place.ptr, size)?;
-            ecx.mark_immutable(&*arg_place);
+            ecx.mark_immutable(&arg_place);
             argvs.push(arg_place.to_ref(&ecx));
         }
         // Make an array with all these pointers, in the Miri memory.
@@ -215,7 +225,7 @@ pub fn create_ecx<'mir, 'tcx: 'mir>(
             let place = ecx.mplace_field(&argvs_place, idx)?;
             ecx.write_immediate(arg, &place.into())?;
         }
-        ecx.mark_immutable(&*argvs_place);
+        ecx.mark_immutable(&argvs_place);
         // A pointer to that place is the 3rd argument for main.
         let argv = argvs_place.to_ref(&ecx);
         // Store `argc` and `argv` for macOS `_NSGetArg{c,v}`.
@@ -223,7 +233,7 @@ pub fn create_ecx<'mir, 'tcx: 'mir>(
             let argc_place =
                 ecx.allocate(ecx.machine.layouts.isize, MiriMemoryKind::Machine.into())?;
             ecx.write_scalar(argc, &argc_place.into())?;
-            ecx.mark_immutable(&*argc_place);
+            ecx.mark_immutable(&argc_place);
             ecx.machine.argc = Some(*argc_place);
 
             let argv_place = ecx.allocate(
@@ -231,7 +241,7 @@ pub fn create_ecx<'mir, 'tcx: 'mir>(
                 MiriMemoryKind::Machine.into(),
             )?;
             ecx.write_immediate(argv, &argv_place.into())?;
-            ecx.mark_immutable(&*argv_place);
+            ecx.mark_immutable(&argv_place);
             ecx.machine.argv = Some(*argv_place);
         }
         // Store command line as UTF-16 for Windows `GetCommandLineW`.
@@ -248,7 +258,7 @@ pub fn create_ecx<'mir, 'tcx: 'mir>(
                 let place = ecx.mplace_field(&cmd_place, idx)?;
                 ecx.write_scalar(Scalar::from_u16(c), &place.into())?;
             }
-            ecx.mark_immutable(&*cmd_place);
+            ecx.mark_immutable(&cmd_place);
         }
         argv
     };
@@ -277,7 +287,7 @@ pub fn create_ecx<'mir, 'tcx: 'mir>(
                 start_instance,
                 Abi::Rust,
                 &[Scalar::from_pointer(main_ptr, &ecx).into(), argc.into(), argv],
-                &ret_place.into(),
+                Some(&ret_place.into()),
                 StackPopCleanup::Root { cleanup: true },
             )?;
         }
@@ -286,7 +296,7 @@ pub fn create_ecx<'mir, 'tcx: 'mir>(
                 entry_instance,
                 Abi::Rust,
                 &[argc.into(), argv],
-                &ret_place.into(),
+                Some(&ret_place.into()),
                 StackPopCleanup::Root { cleanup: true },
             )?;
         }
@@ -320,7 +330,7 @@ pub fn eval_entry<'tcx>(
     };
 
     // Perform the main execution.
-    let res: InterpResult<'_, i64> = (|| {
+    let res: thread::Result<InterpResult<'_, i64>> = panic::catch_unwind(AssertUnwindSafe(|| {
         // Main loop.
         loop {
             let info = ecx.preprocess_diagnostics();
@@ -350,15 +360,18 @@ pub fn eval_entry<'tcx>(
         }
         let return_code = ecx.read_scalar(&ret_place.into())?.to_machine_isize(&ecx)?;
         Ok(return_code)
-    })();
-
-    // Machine cleanup.
-    // Execution of the program has halted so any memory access we do here
-    // cannot produce a real data race. If we do not do something to disable
-    // data race detection here, some uncommon combination of errors will
-    // cause a data race to be detected:
-    // https://github.com/rust-lang/miri/issues/2020
-    ecx.allow_data_races_mut(|ecx| EnvVars::cleanup(ecx).unwrap());
+    }));
+    let res = res.unwrap_or_else(|panic_payload| {
+        ecx.handle_ice();
+        panic::resume_unwind(panic_payload)
+    });
+
+    // Machine cleanup. Only do this if all threads have terminated; threads that are still running
+    // might cause data races (https://github.com/rust-lang/miri/issues/2020) or Stacked Borrows
+    // errors (https://github.com/rust-lang/miri/issues/2396) if we deallocate here.
+    if ecx.have_all_terminated() {
+        EnvVars::cleanup(&mut ecx).unwrap();
+    }
 
     // Process the result.
     match res {
@@ -394,7 +407,7 @@ pub fn eval_entry<'tcx>(
 /// The string will be UTF-16 encoded and NUL terminated.
 ///
 /// Panics if the zeroth argument contains the `"` character because doublequotes
-/// in argv[0] cannot be encoded using the standard command line parsing rules.
+/// in `argv[0]` cannot be encoded using the standard command line parsing rules.
 ///
 /// Further reading:
 /// * [Parsing C++ command-line arguments](https://docs.microsoft.com/en-us/cpp/cpp/main-function-command-line-args?view=msvc-160#parsing-c-command-line-arguments)
@@ -488,6 +501,6 @@ fn windows_argv0_no_escape() {
         let cmd = String::from_utf16_lossy(&args_to_utf16_command_string(
             [r"C:\Program Files\", "arg1", "arg 2", "arg \" 3"].iter(),
         ));
-        assert_eq!(cmd.trim_end_matches("\0"), r#""C:\Program Files\" arg1 "arg 2" "arg \" 3""#);
+        assert_eq!(cmd.trim_end_matches('\0'), r#""C:\Program Files\" arg1 "arg 2" "arg \" 3""#);
     }
 }