src/eval.rs

   1 //! Main evaluator loop and setting up the initial stack frame.
   2
   3 use rand::rngs::StdRng;
   4 use rand::SeedableRng;
   5
   6 use syntax::source_map::DUMMY_SP;
   7 use rustc::ty::{self, TyCtxt};
   8 use rustc::ty::layout::{LayoutOf, Size, Align};
   9 use rustc::hir::def_id::DefId;
  10
  11 use crate::{
  12     InterpResult, InterpError, InterpCx, StackPopCleanup, struct_error,
  13     Scalar, Tag, Pointer, FnVal,
  14     MemoryExtra, MiriMemoryKind, Evaluator, TlsEvalContextExt, HelpersEvalContextExt,
  15 };
  16 use crate::shims::env::alloc_env_value;
  17
  18 /// Configuration needed to spawn a Miri instance.
  19 #[derive(Clone)]
  20 pub struct MiriConfig {
  21     pub validate: bool,
  22     /// Determines if communication with the host environment is enabled.
  23     pub communicate: bool,
  24     pub args: Vec<String>,
  25
  26     /// The seed to use when non-determinism is required (e.g. getrandom())
  27     pub seed: Option<u64>,
  28 }
  29
  30 // Used by priroda.
  31 pub fn create_ecx<'mir, 'tcx: 'mir>(
  32     tcx: TyCtxt<'tcx>,
  33     main_id: DefId,
  34     config: MiriConfig,
  35 ) -> InterpResult<'tcx, InterpCx<'mir, 'tcx, Evaluator<'tcx>>> {
  36     let mut ecx = InterpCx::new(
  37         tcx.at(syntax::source_map::DUMMY_SP),
  38         ty::ParamEnv::reveal_all(),
  39         Evaluator::new(config.communicate),
  40         MemoryExtra::new(StdRng::seed_from_u64(config.seed.unwrap_or(0)), config.validate),
  41     );
  42
  43     let main_instance = ty::Instance::mono(ecx.tcx.tcx, main_id);
  44     let main_mir = ecx.load_mir(main_instance.def)?;
  45
  46     if !main_mir.return_ty().is_unit() || main_mir.arg_count != 0 {
  47         throw_unsup_format!(
  48             "miri does not support main functions without `fn()` type signatures"
  49         );
  50     }
  51
  52     let start_id = tcx.lang_items().start_fn().unwrap();
  53     let main_ret_ty = tcx.fn_sig(main_id).output();
  54     let main_ret_ty = main_ret_ty.no_bound_vars().unwrap();
  55     let start_instance = ty::Instance::resolve(
  56         ecx.tcx.tcx,
  57         ty::ParamEnv::reveal_all(),
  58         start_id,
  59         ecx.tcx.mk_substs(
  60             ::std::iter::once(ty::subst::Kind::from(main_ret_ty)))
  61         ).unwrap();
  62     let start_mir = ecx.load_mir(start_instance.def)?;
  63
  64     if start_mir.arg_count != 3 {
  65         bug!(
  66             "'start' lang item should have three arguments, but has {}",
  67             start_mir.arg_count
  68         );
  69     }
  70
  71     // Return value (in static memory so that it does not count as leak).
  72     let ret = ecx.layout_of(start_mir.return_ty())?;
  73     let ret_ptr = ecx.allocate(ret, MiriMemoryKind::Static.into());
  74
  75     // Push our stack frame.
  76     ecx.push_stack_frame(
  77         start_instance,
  78         // There is no call site.
  79         DUMMY_SP,
  80         start_mir,
  81         Some(ret_ptr.into()),
  82         StackPopCleanup::None { cleanup: true },
  83     )?;
  84
  85     let mut args = ecx.frame().body.args_iter();
  86
  87     // First argument: pointer to `main()`.
  88     let main_ptr = ecx.memory_mut().create_fn_alloc(FnVal::Instance(main_instance));
  89     let dest = ecx.local_place(args.next().unwrap())?;
  90     ecx.write_scalar(Scalar::Ptr(main_ptr), dest)?;
  91
  92     // Second argument (argc): `1`.
  93     let dest = ecx.local_place(args.next().unwrap())?;
  94     let argc = Scalar::from_uint(config.args.len() as u128, dest.layout.size);
  95     ecx.write_scalar(argc, dest)?;
  96     // Store argc for macOS's `_NSGetArgc`.
  97     {
  98         let argc_place = ecx.allocate(dest.layout, MiriMemoryKind::Env.into());
  99         ecx.write_scalar(argc, argc_place.into())?;
 100         ecx.machine.argc = Some(argc_place.ptr.to_ptr()?);
 101     }
 102
 103     // Third argument (`argv`): created from `config.args`.
 104     let dest = ecx.local_place(args.next().unwrap())?;
 105     // For Windows, construct a command string with all the aguments.
 106     let mut cmd = String::new();
 107     for arg in config.args.iter() {
 108         if !cmd.is_empty() {
 109             cmd.push(' ');
 110         }
 111         cmd.push_str(&*shell_escape::windows::escape(arg.as_str().into()));
 112     }
 113     // Don't forget `0` terminator.
 114     cmd.push(std::char::from_u32(0).unwrap());
 115     // Collect the pointers to the individual strings.
 116     let mut argvs = Vec::<Pointer<Tag>>::new();
 117     for arg in config.args {
 118         // Add `0` terminator.
 119         let mut arg = arg.into_bytes();
 120         arg.push(0);
 121         argvs.push(ecx.memory_mut().allocate_static_bytes(arg.as_slice(), MiriMemoryKind::Static.into()));
 122     }
 123     // Make an array with all these pointers, in the Miri memory.
 124     let argvs_layout = ecx.layout_of(ecx.tcx.mk_array(ecx.tcx.mk_imm_ptr(ecx.tcx.types.u8), argvs.len() as u64))?;
 125     let argvs_place = ecx.allocate(argvs_layout, MiriMemoryKind::Env.into());
 126     for (idx, arg) in argvs.into_iter().enumerate() {
 127         let place = ecx.mplace_field(argvs_place, idx as u64)?;
 128         ecx.write_scalar(Scalar::Ptr(arg), place.into())?;
 129     }
 130     ecx.memory_mut().mark_immutable(argvs_place.ptr.assert_ptr().alloc_id)?;
 131     // Write a pointer to that place as the argument.
 132     let argv = argvs_place.ptr;
 133     ecx.write_scalar(argv, dest)?;
 134     // Store `argv` for macOS `_NSGetArgv`.
 135     {
 136         let argv_place = ecx.allocate(dest.layout, MiriMemoryKind::Env.into());
 137         ecx.write_scalar(argv, argv_place.into())?;
 138         ecx.machine.argv = Some(argv_place.ptr.to_ptr()?);
 139     }
 140     // Store command line as UTF-16 for Windows `GetCommandLineW`.
 141     {
 142         let tcx = &{ecx.tcx.tcx};
 143         let cmd_utf16: Vec<u16> = cmd.encode_utf16().collect();
 144         let cmd_ptr = ecx.memory_mut().allocate(
 145             Size::from_bytes(cmd_utf16.len() as u64 * 2),
 146             Align::from_bytes(2).unwrap(),
 147             MiriMemoryKind::Env.into(),
 148         );
 149         ecx.machine.cmd_line = Some(cmd_ptr);
 150         // Store the UTF-16 string.
 151         let char_size = Size::from_bytes(2);
 152         let cmd_alloc = ecx.memory_mut().get_mut(cmd_ptr.alloc_id)?;
 153         let mut cur_ptr = cmd_ptr;
 154         for &c in cmd_utf16.iter() {
 155             cmd_alloc.write_scalar(
 156                 tcx,
 157                 cur_ptr,
 158                 Scalar::from_uint(c, char_size).into(),
 159                 char_size,
 160             )?;
 161             cur_ptr = cur_ptr.offset(char_size, tcx)?;
 162         }
 163     }
 164
 165     assert!(args.next().is_none(), "start lang item has more arguments than expected");
 166
 167     if config.communicate {
 168         for (name, value) in std::env::vars() {
 169             let value = alloc_env_value(value.as_bytes(), ecx.memory_mut(), &tcx);
 170             ecx.machine.env_vars.insert(name.into_bytes(), value);
 171         }
 172     }
 173
 174     Ok(ecx)
 175 }
 176
 177 pub fn eval_main<'tcx>(
 178     tcx: TyCtxt<'tcx>,
 179     main_id: DefId,
 180     config: MiriConfig,
 181 ) {
 182     let mut ecx = match create_ecx(tcx, main_id, config) {
 183         Ok(ecx) => ecx,
 184         Err(mut err) => {
 185             err.print_backtrace();
 186             panic!("Miri initialziation error: {}", err.kind)
 187         }
 188     };
 189
 190     // Perform the main execution.
 191     let res: InterpResult<'_> = (|| {
 192         ecx.run()?;
 193         ecx.run_tls_dtors()
 194     })();
 195
 196     // Process the result.
 197     match res {
 198         Ok(()) => {
 199             let leaks = ecx.memory().leak_report();
 200             // Disable the leak test on some platforms where we do not
 201             // correctly implement TLS destructors.
 202             let target_os = ecx.tcx.tcx.sess.target.target.target_os.to_lowercase();
 203             let ignore_leaks = target_os == "windows" || target_os == "macos";
 204             if !ignore_leaks && leaks != 0 {
 205                 tcx.sess.err("the evaluated program leaked memory");
 206             }
 207         }
 208         Err(mut e) => {
 209             // Special treatment for some error kinds
 210             let msg = match e.kind {
 211                 InterpError::Exit(code) => std::process::exit(code),
 212                 err_unsup!(NoMirFor(..)) =>
 213                     format!("{}. Did you set `MIRI_SYSROOT` to a Miri-enabled sysroot? You can prepare one with `cargo miri setup`.", e),
 214                 _ => e.to_string()
 215             };
 216             e.print_backtrace();
 217             if let Some(frame) = ecx.stack().last() {
 218                 let block = &frame.body.basic_blocks()[frame.block];
 219                 let span = if frame.stmt < block.statements.len() {
 220                     block.statements[frame.stmt].source_info.span
 221                 } else {
 222                     block.terminator().source_info.span
 223                 };
 224
 225                 let msg = format!("Miri evaluation error: {}", msg);
 226                 let mut err = struct_error(ecx.tcx.tcx.at(span), msg.as_str());
 227                 let frames = ecx.generate_stacktrace(None);
 228                 err.span_label(span, msg);
 229                 // We iterate with indices because we need to look at the next frame (the caller).
 230                 for idx in 0..frames.len() {
 231                     let frame_info = &frames[idx];
 232                     let call_site_is_local = frames.get(idx+1).map_or(false,
 233                         |caller_info| caller_info.instance.def_id().is_local());
 234                     if call_site_is_local {
 235                         err.span_note(frame_info.call_site, &frame_info.to_string());
 236                     } else {
 237                         err.note(&frame_info.to_string());
 238                     }
 239                 }
 240                 err.emit();
 241             } else {
 242                 ecx.tcx.sess.err(&msg);
 243             }
 244
 245             for (i, frame) in ecx.stack().iter().enumerate() {
 246                 trace!("-------------------");
 247                 trace!("Frame {}", i);
 248                 trace!("    return: {:?}", frame.return_place.map(|p| *p));
 249                 for (i, local) in frame.locals.iter().enumerate() {
 250                     trace!("    local {}: {:?}", i, local.value);
 251                 }
 252             }
 253         }
 254     }
 255 }