layout::{LayoutOf, TyAndLayout},
List, TyCtxt,
};
-use rustc_span::{def_id::CrateNum, sym, Symbol};
+use rustc_span::{def_id::CrateNum, sym, Span, Symbol};
use rustc_target::abi::{Align, FieldsShape, Size, Variants};
use rustc_target::spec::abi::Abi;
}
pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
+ /// Gets an instance for a path; fails gracefully if the path does not exist.
+ fn try_resolve_path(&self, path: &[&str]) -> Option<ty::Instance<'tcx>> {
+ let did = try_resolve_did(self.eval_context_ref().tcx.tcx, path)?;
+ Some(ty::Instance::mono(self.eval_context_ref().tcx.tcx, did))
+ }
+
/// Gets an instance for a path.
fn resolve_path(&self, path: &[&str]) -> ty::Instance<'tcx> {
- let did = try_resolve_did(self.eval_context_ref().tcx.tcx, path)
- .unwrap_or_else(|| panic!("failed to find required Rust item: {:?}", path));
- ty::Instance::mono(self.eval_context_ref().tcx.tcx, did)
+ self.try_resolve_path(path)
+ .unwrap_or_else(|| panic!("failed to find required Rust item: {:?}", path))
}
/// Evaluates the scalar at the specified path. Returns Some(val)
/// if the path could be resolved, and None otherwise
- fn eval_path_scalar(&self, path: &[&str]) -> InterpResult<'tcx, Scalar<Tag>> {
+ fn eval_path_scalar(&self, path: &[&str]) -> InterpResult<'tcx, Scalar<Provenance>> {
let this = self.eval_context_ref();
let instance = this.resolve_path(path);
let cid = GlobalId { instance, promoted: None };
}
/// Helper function to get a `libc` constant as a `Scalar`.
- fn eval_libc(&self, name: &str) -> InterpResult<'tcx, Scalar<Tag>> {
+ fn eval_libc(&self, name: &str) -> InterpResult<'tcx, Scalar<Provenance>> {
self.eval_path_scalar(&["libc", name])
}
}
/// Helper function to get a `windows` constant as a `Scalar`.
- fn eval_windows(&self, module: &str, name: &str) -> InterpResult<'tcx, Scalar<Tag>> {
+ fn eval_windows(&self, module: &str, name: &str) -> InterpResult<'tcx, Scalar<Provenance>> {
self.eval_context_ref().eval_path_scalar(&["std", "sys", "windows", module, name])
}
/// Project to the given *named* field of the mplace (which must be a struct or union type).
fn mplace_field_named(
&self,
- mplace: &MPlaceTy<'tcx, Tag>,
+ mplace: &MPlaceTy<'tcx, Provenance>,
name: &str,
- ) -> InterpResult<'tcx, MPlaceTy<'tcx, Tag>> {
+ ) -> InterpResult<'tcx, MPlaceTy<'tcx, Provenance>> {
let this = self.eval_context_ref();
let adt = mplace.layout.ty.ty_adt_def().unwrap();
for (idx, field) in adt.non_enum_variant().fields.iter().enumerate() {
/// Write an int of the appropriate size to `dest`. The target type may be signed or unsigned,
/// we try to do the right thing anyway. `i128` can fit all integer types except for `u128` so
/// this method is fine for almost all integer types.
- fn write_int(&mut self, i: impl Into<i128>, dest: &PlaceTy<'tcx, Tag>) -> InterpResult<'tcx> {
+ fn write_int(
+ &mut self,
+ i: impl Into<i128>,
+ dest: &PlaceTy<'tcx, Provenance>,
+ ) -> InterpResult<'tcx> {
assert!(dest.layout.abi.is_scalar(), "write_int on non-scalar type {}", dest.layout.ty);
let val = if dest.layout.abi.is_signed() {
Scalar::from_int(i, dest.layout.size)
fn write_int_fields(
&mut self,
values: &[i128],
- dest: &MPlaceTy<'tcx, Tag>,
+ dest: &MPlaceTy<'tcx, Provenance>,
) -> InterpResult<'tcx> {
let this = self.eval_context_mut();
for (idx, &val) in values.iter().enumerate() {
fn write_int_fields_named(
&mut self,
values: &[(&str, i128)],
- dest: &MPlaceTy<'tcx, Tag>,
+ dest: &MPlaceTy<'tcx, Provenance>,
) -> InterpResult<'tcx> {
let this = self.eval_context_mut();
for &(name, val) in values.iter() {
}
/// Write a 0 of the appropriate size to `dest`.
- fn write_null(&mut self, dest: &PlaceTy<'tcx, Tag>) -> InterpResult<'tcx> {
+ fn write_null(&mut self, dest: &PlaceTy<'tcx, Provenance>) -> InterpResult<'tcx> {
self.write_int(0, dest)
}
/// Test if this pointer equals 0.
- fn ptr_is_null(&self, ptr: Pointer<Option<Tag>>) -> InterpResult<'tcx, bool> {
- let this = self.eval_context_ref();
- let null = Scalar::null_ptr(this);
- this.ptr_eq(Scalar::from_maybe_pointer(ptr, this), null)
+ fn ptr_is_null(&self, ptr: Pointer<Option<Provenance>>) -> InterpResult<'tcx, bool> {
+ Ok(ptr.addr().bytes() == 0)
}
/// Get the `Place` for a local
- fn local_place(&mut self, local: mir::Local) -> InterpResult<'tcx, PlaceTy<'tcx, Tag>> {
+ fn local_place(&mut self, local: mir::Local) -> InterpResult<'tcx, PlaceTy<'tcx, Provenance>> {
let this = self.eval_context_mut();
let place = mir::Place { local, projection: List::empty() };
this.eval_place(place)
}
/// Generate some random bytes, and write them to `dest`.
- fn gen_random(&mut self, ptr: Pointer<Option<Tag>>, len: u64) -> InterpResult<'tcx> {
+ fn gen_random(&mut self, ptr: Pointer<Option<Provenance>>, len: u64) -> InterpResult<'tcx> {
// Some programs pass in a null pointer and a length of 0
// to their platform's random-generation function (e.g. getrandom())
// on Linux. For compatibility with these programs, we don't perform
/// Call a function: Push the stack frame and pass the arguments.
/// For now, arguments must be scalars (so that the caller does not have to know the layout).
+ ///
+ /// If you do not provie a return place, a dangling zero-sized place will be created
+ /// for your convenience.
fn call_function(
&mut self,
f: ty::Instance<'tcx>,
caller_abi: Abi,
- args: &[Immediate<Tag>],
- dest: Option<&PlaceTy<'tcx, Tag>>,
+ args: &[Immediate<Provenance>],
+ dest: Option<&PlaceTy<'tcx, Provenance>>,
stack_pop: StackPopCleanup,
) -> InterpResult<'tcx> {
let this = self.eval_context_mut();
}
// Push frame.
- let mir = &*this.load_mir(f.def, None)?;
- this.push_stack_frame(f, mir, dest, stack_pop)?;
+ let mir = this.load_mir(f.def, None)?;
+ let dest = match dest {
+ Some(dest) => dest.clone(),
+ None => MPlaceTy::fake_alloc_zst(this.layout_of(mir.return_ty())?).into(),
+ };
+ this.push_stack_frame(f, mir, &dest, stack_pop)?;
// Initialize arguments.
let mut callee_args = this.frame().body.args_iter();
/// The range is relative to `place`.
fn visit_freeze_sensitive(
&self,
- place: &MPlaceTy<'tcx, Tag>,
+ place: &MPlaceTy<'tcx, Provenance>,
size: Size,
mut action: impl FnMut(AllocRange, bool) -> InterpResult<'tcx>,
) -> InterpResult<'tcx> {
let mut cur_addr = start_addr;
// Called when we detected an `UnsafeCell` at the given offset and size.
// Calls `action` and advances `cur_ptr`.
- let mut unsafe_cell_action = |unsafe_cell_ptr: &Pointer<Option<Tag>>,
+ let mut unsafe_cell_action = |unsafe_cell_ptr: &Pointer<Option<Provenance>>,
unsafe_cell_size: Size| {
// We assume that we are given the fields in increasing offset order,
// and nothing else changes.
/// whether we are inside an `UnsafeCell` or not.
struct UnsafeCellVisitor<'ecx, 'mir, 'tcx, F>
where
- F: FnMut(&MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>,
+ F: FnMut(&MPlaceTy<'tcx, Provenance>) -> InterpResult<'tcx>,
{
ecx: &'ecx MiriEvalContext<'mir, 'tcx>,
unsafe_cell_action: F,
impl<'ecx, 'mir, 'tcx: 'mir, F> ValueVisitor<'mir, 'tcx, Evaluator<'mir, 'tcx>>
for UnsafeCellVisitor<'ecx, 'mir, 'tcx, F>
where
- F: FnMut(&MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>,
+ F: FnMut(&MPlaceTy<'tcx, Provenance>) -> InterpResult<'tcx>,
{
- type V = MPlaceTy<'tcx, Tag>;
+ type V = MPlaceTy<'tcx, Provenance>;
#[inline(always)]
fn ecx(&self) -> &MiriEvalContext<'mir, 'tcx> {
}
// Hook to detect `UnsafeCell`.
- fn visit_value(&mut self, v: &MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx> {
+ fn visit_value(&mut self, v: &MPlaceTy<'tcx, Provenance>) -> InterpResult<'tcx> {
trace!("UnsafeCellVisitor: {:?} {:?}", *v, v.layout.ty);
let is_unsafe_cell = match v.layout.ty.kind() {
ty::Adt(adt, _) =>
// Make sure we visit aggregrates in increasing offset order.
fn visit_aggregate(
&mut self,
- place: &MPlaceTy<'tcx, Tag>,
- fields: impl Iterator<Item = InterpResult<'tcx, MPlaceTy<'tcx, Tag>>>,
+ place: &MPlaceTy<'tcx, Provenance>,
+ fields: impl Iterator<Item = InterpResult<'tcx, MPlaceTy<'tcx, Provenance>>>,
) -> InterpResult<'tcx> {
match place.layout.fields {
FieldsShape::Array { .. } => {
}
FieldsShape::Arbitrary { .. } => {
// Gather the subplaces and sort them before visiting.
- let mut places =
- fields.collect::<InterpResult<'tcx, Vec<MPlaceTy<'tcx, Tag>>>>()?;
+ let mut places = fields
+ .collect::<InterpResult<'tcx, Vec<MPlaceTy<'tcx, Provenance>>>>()?;
// we just compare offsets, the abs. value never matters
places.sort_by_key(|place| place.ptr.addr());
self.walk_aggregate(place, places.into_iter().map(Ok))
fn visit_union(
&mut self,
- _v: &MPlaceTy<'tcx, Tag>,
+ _v: &MPlaceTy<'tcx, Provenance>,
_fields: NonZeroUsize,
) -> InterpResult<'tcx> {
bug!("we should have already handled unions in `visit_value`")
)
}
+ /// Helper function used inside the shims of foreign functions to assert that the target OS
+ /// is part of the UNIX family. It panics showing a message with the `name` of the foreign function
+ /// if this is not the case.
+ fn assert_target_os_is_unix(&self, name: &str) {
+ assert!(
+ target_os_is_unix(self.eval_context_ref().tcx.sess.target.os.as_ref()),
+ "`{}` is only available for supported UNIX family targets",
+ name,
+ );
+ }
+
/// Get last error variable as a place, lazily allocating thread-local storage for it if
/// necessary.
- fn last_error_place(&mut self) -> InterpResult<'tcx, MPlaceTy<'tcx, Tag>> {
+ fn last_error_place(&mut self) -> InterpResult<'tcx, MPlaceTy<'tcx, Provenance>> {
let this = self.eval_context_mut();
if let Some(errno_place) = this.active_thread_ref().last_error {
Ok(errno_place)
}
/// Sets the last error variable.
- fn set_last_error(&mut self, scalar: Scalar<Tag>) -> InterpResult<'tcx> {
+ fn set_last_error(&mut self, scalar: Scalar<Provenance>) -> InterpResult<'tcx> {
let this = self.eval_context_mut();
let errno_place = this.last_error_place()?;
this.write_scalar(scalar, &errno_place.into())
}
/// Gets the last error variable.
- fn get_last_error(&mut self) -> InterpResult<'tcx, Scalar<Tag>> {
+ fn get_last_error(&mut self) -> InterpResult<'tcx, Scalar<Provenance>> {
let this = self.eval_context_mut();
let errno_place = this.last_error_place()?;
this.read_scalar(&errno_place.into())?.check_init()
/// This function tries to produce the most similar OS error from the `std::io::ErrorKind`
/// as a platform-specific errnum.
- fn io_error_to_errnum(&self, err_kind: std::io::ErrorKind) -> InterpResult<'tcx, Scalar<Tag>> {
+ fn io_error_to_errnum(
+ &self,
+ err_kind: std::io::ErrorKind,
+ ) -> InterpResult<'tcx, Scalar<Provenance>> {
let this = self.eval_context_ref();
let target = &this.tcx.sess.target;
if target.families.iter().any(|f| f == "unix") {
}
/// The inverse of `io_error_to_errnum`.
- fn errnum_to_io_error(&self, errnum: Scalar<Tag>) -> InterpResult<'tcx, std::io::ErrorKind> {
+ fn errnum_to_io_error(
+ &self,
+ errnum: Scalar<Provenance>,
+ ) -> InterpResult<'tcx, std::io::ErrorKind> {
let this = self.eval_context_ref();
let target = &this.tcx.sess.target;
if target.families.iter().any(|f| f == "unix") {
}
}
- fn read_scalar_at_offset(
+ /// Calculates the MPlaceTy given the offset and layout of an access on an operand
+ fn deref_operand_and_offset(
&self,
- op: &OpTy<'tcx, Tag>,
+ op: &OpTy<'tcx, Provenance>,
offset: u64,
layout: TyAndLayout<'tcx>,
- ) -> InterpResult<'tcx, ScalarMaybeUninit<Tag>> {
+ ) -> InterpResult<'tcx, MPlaceTy<'tcx, Provenance>> {
let this = self.eval_context_ref();
let op_place = this.deref_operand(op)?;
let offset = Size::from_bytes(offset);
- // Ensure that the following read at an offset is within bounds
+
+ // Ensure that the access is within bounds.
assert!(op_place.layout.size >= offset + layout.size);
- let value_place = op_place.offset(offset, MemPlaceMeta::None, layout, this)?;
+ let value_place = op_place.offset(offset, layout, this)?;
+ Ok(value_place)
+ }
+
+ fn read_scalar_at_offset(
+ &self,
+ op: &OpTy<'tcx, Provenance>,
+ offset: u64,
+ layout: TyAndLayout<'tcx>,
+ ) -> InterpResult<'tcx, ScalarMaybeUninit<Provenance>> {
+ let this = self.eval_context_ref();
+ let value_place = this.deref_operand_and_offset(op, offset, layout)?;
this.read_scalar(&value_place.into())
}
fn write_scalar_at_offset(
&mut self,
- op: &OpTy<'tcx, Tag>,
+ op: &OpTy<'tcx, Provenance>,
offset: u64,
- value: impl Into<ScalarMaybeUninit<Tag>>,
+ value: impl Into<ScalarMaybeUninit<Provenance>>,
layout: TyAndLayout<'tcx>,
) -> InterpResult<'tcx, ()> {
let this = self.eval_context_mut();
- let op_place = this.deref_operand(op)?;
- let offset = Size::from_bytes(offset);
- // Ensure that the following read at an offset is within bounds
- assert!(op_place.layout.size >= offset + layout.size);
- let value_place = op_place.offset(offset, MemPlaceMeta::None, layout, this)?;
+ let value_place = this.deref_operand_and_offset(op, offset, layout)?;
this.write_scalar(value, &value_place.into())
}
/// Parse a `timespec` struct and return it as a `std::time::Duration`. It returns `None`
/// if the value in the `timespec` struct is invalid. Some libc functions will return
/// `EINVAL` in this case.
- fn read_timespec(&mut self, tp: &MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx, Option<Duration>> {
+ fn read_timespec(
+ &mut self,
+ tp: &MPlaceTy<'tcx, Provenance>,
+ ) -> InterpResult<'tcx, Option<Duration>> {
let this = self.eval_context_mut();
let seconds_place = this.mplace_field(tp, 0)?;
let seconds_scalar = this.read_scalar(&seconds_place.into())?;
})
}
- fn read_c_str<'a>(&'a self, ptr: Pointer<Option<Tag>>) -> InterpResult<'tcx, &'a [u8]>
+ fn read_c_str<'a>(&'a self, ptr: Pointer<Option<Provenance>>) -> InterpResult<'tcx, &'a [u8]>
where
'tcx: 'a,
'mir: 'a,
// FIXME: We are re-getting the allocation each time around the loop.
// Would be nice if we could somehow "extend" an existing AllocRange.
let alloc = this.get_ptr_alloc(ptr.offset(len, this)?, size1, Align::ONE)?.unwrap(); // not a ZST, so we will get a result
- let byte = alloc.read_scalar(alloc_range(Size::ZERO, size1))?.to_u8()?;
+ let byte = alloc.read_integer(alloc_range(Size::ZERO, size1))?.to_u8()?;
if byte == 0 {
break;
} else {
this.read_bytes_ptr(ptr, len)
}
- fn read_wide_str(&self, mut ptr: Pointer<Option<Tag>>) -> InterpResult<'tcx, Vec<u16>> {
+ fn read_wide_str(&self, mut ptr: Pointer<Option<Provenance>>) -> InterpResult<'tcx, Vec<u16>> {
let this = self.eval_context_ref();
let size2 = Size::from_bytes(2);
let align2 = Align::from_bytes(2).unwrap();
// FIXME: We are re-getting the allocation each time around the loop.
// Would be nice if we could somehow "extend" an existing AllocRange.
let alloc = this.get_ptr_alloc(ptr, size2, align2)?.unwrap(); // not a ZST, so we will get a result
- let wchar = alloc.read_scalar(alloc_range(Size::ZERO, size2))?.to_u16()?;
+ let wchar = alloc.read_integer(alloc_range(Size::ZERO, size2))?.to_u16()?;
if wchar == 0 {
break;
} else {
fn frame_in_std(&self) -> bool {
let this = self.eval_context_ref();
- this.tcx.lang_items().start_fn().map_or(false, |start_fn| {
- this.tcx.def_path(this.frame().instance.def_id()).krate
- == this.tcx.def_path(start_fn).krate
- })
+ let Some(start_fn) = this.tcx.lang_items().start_fn() else {
+ // no_std situations
+ return false;
+ };
+ let frame = this.frame();
+ // Make an attempt to get at the instance of the function this is inlined from.
+ let instance: Option<_> = try {
+ let scope = frame.current_source_info()?.scope;
+ let inlined_parent = frame.body.source_scopes[scope].inlined_parent_scope?;
+ let source = &frame.body.source_scopes[inlined_parent];
+ source.inlined.expect("inlined_parent_scope points to scope without inline info").0
+ };
+ // Fall back to the instance of the function itself.
+ let instance = instance.unwrap_or(frame.instance);
+ // Now check if this is in the same crate as start_fn.
+ this.tcx.def_path(instance.def_id()).krate == this.tcx.def_path(start_fn).krate
}
/// Handler that should be called when unsupported functionality is encountered.
abi: Abi,
exp_abi: Abi,
link_name: Symbol,
- args: &'a [OpTy<'tcx, Tag>],
- ) -> InterpResult<'tcx, &'a [OpTy<'tcx, Tag>; N]>
+ args: &'a [OpTy<'tcx, Provenance>],
+ ) -> InterpResult<'tcx, &'a [OpTy<'tcx, Provenance>; N]>
where
- &'a [OpTy<'tcx, Tag>; N]: TryFrom<&'a [OpTy<'tcx, Tag>]>,
+ &'a [OpTy<'tcx, Provenance>; N]: TryFrom<&'a [OpTy<'tcx, Provenance>]>,
{
self.check_abi_and_shim_symbol_clash(abi, exp_abi, link_name)?;
check_arg_count(args)
}
/// Mark a machine allocation that was just created as immutable.
- fn mark_immutable(&mut self, mplace: &MemPlace<Tag>) {
+ fn mark_immutable(&mut self, mplace: &MemPlace<Provenance>) {
let this = self.eval_context_mut();
// This got just allocated, so there definitely is a pointer here.
- this.alloc_mark_immutable(mplace.ptr.into_pointer_or_addr().unwrap().provenance.alloc_id)
- .unwrap();
+ let provenance = mplace.ptr.into_pointer_or_addr().unwrap().provenance;
+ this.alloc_mark_immutable(provenance.get_alloc_id().unwrap()).unwrap();
}
fn item_link_name(&self, def_id: DefId) -> Symbol {
}
}
+impl<'mir, 'tcx> Evaluator<'mir, 'tcx> {
+ pub fn current_span(&self) -> CurrentSpan<'_, 'mir, 'tcx> {
+ CurrentSpan { span: None, machine: self }
+ }
+}
+
+/// A `CurrentSpan` should be created infrequently (ideally once) per interpreter step. It does
+/// nothing on creation, but when `CurrentSpan::get` is called, searches the current stack for the
+/// topmost frame which corresponds to a local crate, and returns the current span in that frame.
+/// The result of that search is cached so that later calls are approximately free.
+#[derive(Clone)]
+pub struct CurrentSpan<'a, 'mir, 'tcx> {
+ span: Option<Span>,
+ machine: &'a Evaluator<'mir, 'tcx>,
+}
+
+impl<'a, 'mir, 'tcx> CurrentSpan<'a, 'mir, 'tcx> {
+ pub fn get(&mut self) -> Span {
+ *self.span.get_or_insert_with(|| Self::current_span(self.machine))
+ }
+
+ #[inline(never)]
+ fn current_span(machine: &Evaluator<'_, '_>) -> Span {
+ machine
+ .threads
+ .active_thread_stack()
+ .iter()
+ .rev()
+ .find(|frame| {
+ let def_id = frame.instance.def_id();
+ def_id.is_local() || machine.local_crates.contains(&def_id.krate)
+ })
+ .map(|frame| frame.current_span())
+ .unwrap_or(rustc_span::DUMMY_SP)
+ }
+}
+
/// Check that the number of args is what we expect.
pub fn check_arg_count<'a, 'tcx, const N: usize>(
- args: &'a [OpTy<'tcx, Tag>],
-) -> InterpResult<'tcx, &'a [OpTy<'tcx, Tag>; N]>
+ args: &'a [OpTy<'tcx, Provenance>],
+) -> InterpResult<'tcx, &'a [OpTy<'tcx, Provenance>; N]>
where
- &'a [OpTy<'tcx, Tag>; N]: TryFrom<&'a [OpTy<'tcx, Tag>]>,
+ &'a [OpTy<'tcx, Provenance>; N]: TryFrom<&'a [OpTy<'tcx, Provenance>]>,
{
if let Ok(ops) = args.try_into() {
return Ok(ops);
throw_ub_format!("incorrect number of arguments: got {}, expected {}", args.len(), N)
}
-pub fn isolation_abort_error(name: &str) -> InterpResult<'static> {
+pub fn isolation_abort_error<'tcx>(name: &str) -> InterpResult<'tcx> {
throw_machine_stop!(TerminationInfo::UnsupportedInIsolation(format!(
"{} not available when isolation is enabled",
name,
/// Retrieve the list of local crates that should have been passed by cargo-miri in
/// MIRI_LOCAL_CRATES and turn them into `CrateNum`s.
-pub fn get_local_crates(tcx: &TyCtxt<'_>) -> Vec<CrateNum> {
+pub fn get_local_crates(tcx: TyCtxt<'_>) -> Vec<CrateNum> {
// Convert the local crate names from the passed-in config into CrateNums so that they can
// be looked up quickly during execution
let local_crate_names = std::env::var("MIRI_LOCAL_CRATES")
}
local_crates
}
+
+/// Helper function used inside the shims of foreign functions to check that
+/// `target_os` is a supported UNIX OS.
+pub fn target_os_is_unix(target_os: &str) -> bool {
+ matches!(target_os, "linux" | "macos" | "freebsd")
+}
projects / rust.git / blobdiff