rust/src/eval.rs

249 lines
9.5 KiB
Rust
Raw Normal View History

2019-06-29 07:15:05 -05:00
//! Main evaluator loop and setting up the initial stack frame.
use std::convert::TryFrom;
2020-04-05 16:03:44 -05:00
use std::ffi::OsStr;
use rand::rngs::StdRng;
use rand::SeedableRng;
2020-03-01 03:26:24 -06:00
use rustc_hir::def_id::DefId;
2020-04-05 16:03:44 -05:00
use rustc_middle::ty::{self, layout::LayoutCx, TyCtxt};
use rustc_target::abi::LayoutOf;
use crate::*;
/// Configuration needed to spawn a Miri instance.
#[derive(Clone)]
pub struct MiriConfig {
/// Determine if validity checking is enabled.
pub validate: bool,
/// Determines if Stacked Borrows is enabled.
pub stacked_borrows: bool,
2020-04-13 10:51:22 -05:00
/// Determines if alignment checking is enabled.
pub check_alignment: bool,
/// Determines if communication with the host environment is enabled.
2019-08-06 10:28:50 -05:00
pub communicate: bool,
2019-12-07 06:44:48 -06:00
/// Determines if memory leaks should be ignored.
pub ignore_leaks: bool,
2019-08-28 17:20:50 -05:00
/// Environment variables that should always be isolated from the host.
pub excluded_env_vars: Vec<String>,
/// Command-line arguments passed to the interpreted program.
pub args: Vec<String>,
/// The seed to use when non-determinism or randomness are required (e.g. ptr-to-int cast, `getrandom()`).
2019-08-06 10:28:50 -05:00
pub seed: Option<u64>,
/// The stacked borrow id to report about
2019-11-30 17:02:58 -06:00
pub tracked_pointer_tag: Option<PtrId>,
/// The allocation id to report about.
pub tracked_alloc_id: Option<AllocId>,
}
impl Default for MiriConfig {
fn default() -> MiriConfig {
MiriConfig {
validate: true,
stacked_borrows: true,
2020-04-13 10:51:22 -05:00
check_alignment: true,
communicate: false,
ignore_leaks: false,
excluded_env_vars: vec![],
args: vec![],
seed: None,
tracked_pointer_tag: None,
tracked_alloc_id: None,
}
}
}
/// Returns a freshly created `InterpCx`, along with an `MPlaceTy` representing
/// the location where the return value of the `start` lang item will be
/// written to.
/// Public because this is also used by `priroda`.
pub fn create_ecx<'mir, 'tcx: 'mir>(
tcx: TyCtxt<'tcx>,
main_id: DefId,
config: MiriConfig,
) -> InterpResult<'tcx, (InterpCx<'mir, 'tcx, Evaluator<'mir, 'tcx>>, MPlaceTy<'tcx, Tag>)> {
2020-04-05 16:03:44 -05:00
let tcx_at = tcx.at(rustc_span::source_map::DUMMY_SP);
let param_env = ty::ParamEnv::reveal_all();
let layout_cx = LayoutCx { tcx, param_env };
let mut ecx = InterpCx::new(
2020-04-05 16:03:44 -05:00
tcx_at,
param_env,
Evaluator::new(config.communicate, config.validate, layout_cx),
2019-12-23 05:56:23 -06:00
MemoryExtra::new(
StdRng::seed_from_u64(config.seed.unwrap_or(0)),
config.stacked_borrows,
2019-12-23 05:56:23 -06:00
config.tracked_pointer_tag,
config.tracked_alloc_id,
2020-04-13 10:51:22 -05:00
config.check_alignment,
2019-12-23 05:56:23 -06:00
),
);
2019-08-14 10:24:35 -05:00
// Complete initialization.
2020-03-07 10:35:00 -06:00
EnvVars::init(&mut ecx, config.excluded_env_vars)?;
2020-03-07 14:33:27 -06:00
MemoryExtra::init_extern_statics(&mut ecx)?;
2019-08-14 10:24:35 -05:00
// Setup first stack-frame
let main_instance = ty::Instance::mono(tcx, main_id);
2019-08-27 01:32:31 -05:00
let main_mir = ecx.load_mir(main_instance.def, None)?;
if main_mir.arg_count != 0 {
bug!("main function must not take any arguments");
}
let start_id = tcx.lang_items().start_fn().unwrap();
let main_ret_ty = tcx.fn_sig(main_id).output();
let main_ret_ty = main_ret_ty.no_bound_vars().unwrap();
let start_instance = ty::Instance::resolve(
tcx,
ty::ParamEnv::reveal_all(),
start_id,
tcx.mk_substs(::std::iter::once(ty::subst::GenericArg::from(main_ret_ty))),
2019-10-07 08:39:59 -05:00
)
2020-04-22 16:32:28 -05:00
.unwrap()
2019-10-07 08:39:59 -05:00
.unwrap();
// First argument: pointer to `main()`.
2019-12-23 05:56:23 -06:00
let main_ptr = ecx.memory.create_fn_alloc(FnVal::Instance(main_instance));
2019-11-29 04:08:27 -06:00
// Second argument (argc): length of `config.args`.
let argc = Scalar::from_machine_usize(u64::try_from(config.args.len()).unwrap(), &ecx);
// Third argument (`argv`): created from `config.args`.
let argv = {
// Put each argument in memory, collect pointers.
let mut argvs = Vec::<Scalar<Tag>>::new();
for arg in config.args.iter() {
// Make space for `0` terminator.
let size = u64::try_from(arg.len()).unwrap().checked_add(1).unwrap();
let arg_type = tcx.mk_array(tcx.types.u8, size);
2020-02-23 14:55:02 -06:00
let arg_place = ecx.allocate(ecx.layout_of(arg_type)?, MiriMemoryKind::Machine.into());
2019-12-04 03:43:36 -06:00
ecx.write_os_str_to_c_str(OsStr::new(arg), arg_place.ptr, size)?;
argvs.push(arg_place.ptr);
}
// Make an array with all these pointers, in the Miri memory.
2019-12-23 05:56:23 -06:00
let argvs_layout =
ecx.layout_of(tcx.mk_array(tcx.mk_imm_ptr(tcx.types.u8), u64::try_from(argvs.len()).unwrap()))?;
2020-02-23 14:55:02 -06:00
let argvs_place = ecx.allocate(argvs_layout, MiriMemoryKind::Machine.into());
for (idx, arg) in argvs.into_iter().enumerate() {
let place = ecx.mplace_field(argvs_place, idx)?;
ecx.write_scalar(arg, place.into())?;
}
2019-12-23 05:56:23 -06:00
ecx.memory.mark_immutable(argvs_place.ptr.assert_ptr().alloc_id)?;
// A pointer to that place is the 3rd argument for main.
let argv = argvs_place.ptr;
// Store `argc` and `argv` for macOS `_NSGetArg{c,v}`.
{
2019-12-23 05:56:23 -06:00
let argc_place =
2020-04-18 10:53:54 -05:00
ecx.allocate(ecx.machine.layouts.isize, MiriMemoryKind::Machine.into());
ecx.write_scalar(argc, argc_place.into())?;
ecx.machine.argc = Some(argc_place.ptr);
let argv_place = ecx.allocate(
ecx.layout_of(tcx.mk_imm_ptr(tcx.types.unit))?,
2020-02-23 14:55:02 -06:00
MiriMemoryKind::Machine.into(),
);
ecx.write_scalar(argv, argv_place.into())?;
ecx.machine.argv = Some(argv_place.ptr);
}
// Store command line as UTF-16 for Windows `GetCommandLineW`.
{
// Construct a command string with all the aguments.
let mut cmd = String::new();
for arg in config.args.iter() {
if !cmd.is_empty() {
cmd.push(' ');
}
cmd.push_str(&*shell_escape::windows::escape(arg.as_str().into()));
}
// Don't forget `0` terminator.
cmd.push(std::char::from_u32(0).unwrap());
let cmd_utf16: Vec<u16> = cmd.encode_utf16().collect();
let cmd_type = tcx.mk_array(tcx.types.u16, u64::try_from(cmd_utf16.len()).unwrap());
2020-02-23 14:55:02 -06:00
let cmd_place = ecx.allocate(ecx.layout_of(cmd_type)?, MiriMemoryKind::Machine.into());
ecx.machine.cmd_line = Some(cmd_place.ptr);
// Store the UTF-16 string. We just allocated so we know the bounds are fine.
for (idx, &c) in cmd_utf16.iter().enumerate() {
let place = ecx.mplace_field(cmd_place, idx)?;
ecx.write_scalar(Scalar::from_u16(c), place.into())?;
}
}
argv
};
2019-08-06 10:28:50 -05:00
// Return place (in static memory so that it does not count as leak).
2020-04-18 10:53:54 -05:00
let ret_place = ecx.allocate(ecx.machine.layouts.isize, MiriMemoryKind::Machine.into());
// Call start function.
ecx.call_function(
start_instance,
&[main_ptr.into(), argc.into(), argv.into()],
Some(ret_place.into()),
StackPopCleanup::None { cleanup: true },
)?;
2019-10-03 10:21:55 -05:00
// Set the last_error to 0
2020-04-18 10:53:54 -05:00
let errno_layout = ecx.machine.layouts.u32;
2020-02-23 14:55:02 -06:00
let errno_place = ecx.allocate(errno_layout, MiriMemoryKind::Machine.into());
2019-10-03 10:21:55 -05:00
ecx.write_scalar(Scalar::from_u32(0), errno_place.into())?;
2019-10-12 20:58:02 -05:00
ecx.machine.last_error = Some(errno_place);
2019-10-03 10:21:55 -05:00
Ok((ecx, ret_place))
}
/// Evaluates the main function specified by `main_id`.
/// Returns `Some(return_code)` if program executed completed.
/// Returns `None` if an evaluation error occured.
pub fn eval_main<'tcx>(tcx: TyCtxt<'tcx>, main_id: DefId, config: MiriConfig) -> Option<i64> {
2020-04-05 02:42:39 -05:00
// FIXME: on Windows, we ignore leaks (https://github.com/rust-lang/miri/issues/1302).
2020-03-28 04:07:23 -05:00
let ignore_leaks = config.ignore_leaks || tcx.sess.target.target.target_os == "windows";
2019-12-07 06:44:48 -06:00
let (mut ecx, ret_place) = match create_ecx(tcx, main_id, config) {
Ok(v) => v,
2020-05-03 05:10:24 -05:00
Err(err) => {
err.print_backtrace();
panic!("Miri initialization error: {}", err.kind)
}
};
// Perform the main execution.
let res: InterpResult<'_, i64> = (|| {
// Main loop.
2020-04-16 21:40:02 -05:00
loop {
match ecx.schedule()? {
SchedulingAction::ExecuteStep => {
assert!(ecx.step()?, "a terminated thread was scheduled for execution");
}
SchedulingAction::ExecuteDtors => {
2020-04-29 15:16:22 -05:00
// This will either enable the thread again (so we go back
// to `ExecuteStep`), or determine that this thread is done
// for good.
2020-04-26 22:49:53 -05:00
ecx.schedule_next_tls_dtor_for_active_thread()?;
2020-04-16 21:40:02 -05:00
}
SchedulingAction::Stop => {
break;
}
}
ecx.process_diagnostics();
2020-01-08 05:49:46 -06:00
}
let return_code = ecx.read_scalar(ret_place.into())?.not_undef()?.to_machine_isize(&ecx)?;
Ok(return_code)
})();
// Machine cleanup.
EnvVars::cleanup(&mut ecx).unwrap();
// Process the result.
match res {
Ok(return_code) => {
2019-11-27 02:13:37 -06:00
if !ignore_leaks {
let leaks = ecx.memory.leak_report();
if leaks != 0 {
tcx.sess.err("the evaluated program leaked memory");
// Ignore the provided return code - let the reported error
// determine the return code.
return None;
}
}
2019-12-23 17:08:47 -06:00
Some(return_code)
}
Err(e) => report_error(&ecx, e),
}
}