-use std::convert::{TryFrom, TryInto};
+pub mod convert;
+
use std::mem;
use std::num::NonZeroUsize;
use std::time::Duration;
layout::{LayoutOf, TyAndLayout},
List, TyCtxt,
};
-use rustc_span::Symbol;
+use rustc_span::{def_id::CrateNum, sym, Span, Symbol};
use rustc_target::abi::{Align, FieldsShape, Size, Variants};
use rustc_target::spec::abi::Abi;
impl<'mir, 'tcx: 'mir> EvalContextExt<'mir, 'tcx> for crate::MiriEvalContext<'mir, 'tcx> {}
+const UNIX_IO_ERROR_TABLE: &[(std::io::ErrorKind, &str)] = {
+ use std::io::ErrorKind::*;
+ &[
+ (ConnectionRefused, "ECONNREFUSED"),
+ (ConnectionReset, "ECONNRESET"),
+ (PermissionDenied, "EPERM"),
+ (BrokenPipe, "EPIPE"),
+ (NotConnected, "ENOTCONN"),
+ (ConnectionAborted, "ECONNABORTED"),
+ (AddrNotAvailable, "EADDRNOTAVAIL"),
+ (AddrInUse, "EADDRINUSE"),
+ (NotFound, "ENOENT"),
+ (Interrupted, "EINTR"),
+ (InvalidInput, "EINVAL"),
+ (TimedOut, "ETIMEDOUT"),
+ (AlreadyExists, "EEXIST"),
+ (WouldBlock, "EWOULDBLOCK"),
+ (DirectoryNotEmpty, "ENOTEMPTY"),
+ ]
+};
+
/// Gets an instance for a path.
-fn try_resolve_did<'mir, 'tcx>(tcx: TyCtxt<'tcx>, path: &[&str]) -> Option<DefId> {
+fn try_resolve_did<'tcx>(tcx: TyCtxt<'tcx>, path: &[&str]) -> Option<DefId> {
tcx.crates(()).iter().find(|&&krate| tcx.crate_name(krate).as_str() == path[0]).and_then(
|krate| {
let krate = DefId { krate: *krate, index: CRATE_DEF_INDEX };
let mut path_it = path.iter().skip(1).peekable();
while let Some(segment) = path_it.next() {
- for item in mem::replace(&mut items, Default::default()).iter() {
+ for item in mem::take(&mut items).iter() {
if item.ident.name.as_str() == *segment {
if path_it.peek().is_none() {
return Some(item.res.def_id());
}
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)
let cid = GlobalId { instance, promoted: None };
let const_val = this.eval_to_allocation(cid)?;
let const_val = this.read_scalar(&const_val.into())?;
- return Ok(const_val.check_init()?);
+ const_val.check_init()
}
/// Helper function to get a `libc` constant as a `Scalar`.
/// Get the `Place` for a local
fn local_place(&mut self, local: mir::Local) -> InterpResult<'tcx, PlaceTy<'tcx, Tag>> {
let this = self.eval_context_mut();
- let place = mir::Place { local: local, projection: List::empty() };
+ let place = mir::Place { local, projection: List::empty() };
this.eval_place(place)
}
getrandom::getrandom(&mut data)
.map_err(|err| err_unsup_format!("host getrandom failed: {}", err))?;
} else {
- let rng = this.memory.extra.rng.get_mut();
+ let rng = this.machine.rng.get_mut();
rng.fill_bytes(&mut data);
}
- this.memory.write_bytes(ptr, data.iter().copied())
+ this.write_bytes_ptr(ptr, data.iter().copied())
}
/// Call a function: Push the stack frame and pass the arguments.
f: ty::Instance<'tcx>,
caller_abi: Abi,
args: &[Immediate<Tag>],
- dest: Option<&PlaceTy<'tcx, Tag>>,
+ dest: &PlaceTy<'tcx, Tag>,
stack_pop: StackPopCleanup,
) -> InterpResult<'tcx> {
let this = self.eval_context_mut();
}
// Push frame.
- let mir = &*this.load_mir(f.def, None)?;
+ let mir = this.load_mir(f.def, None)?;
this.push_stack_frame(f, mir, dest, stack_pop)?;
// Initialize arguments.
/// Visits the memory covered by `place`, sensitive to freezing: the 2nd parameter
/// of `action` will be true if this is frozen, false if this is in an `UnsafeCell`.
/// The range is relative to `place`.
- ///
- /// Assumes that the `place` has a proper pointer in it.
fn visit_freeze_sensitive(
&self,
place: &MPlaceTy<'tcx, Tag>,
// Store how far we proceeded into the place so far. Everything to the left of
// this offset has already been handled, in the sense that the frozen parts
// have had `action` called on them.
- let ptr = place.ptr.into_pointer_or_addr().unwrap();
- let start_offset = ptr.into_parts().1 as Size; // we just compare offsets, the abs. value never matters
- let mut cur_offset = start_offset;
+ let start_addr = place.ptr.addr();
+ 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<Tag>>,
unsafe_cell_size: Size| {
- let unsafe_cell_ptr = unsafe_cell_ptr.into_pointer_or_addr().unwrap();
- debug_assert_eq!(unsafe_cell_ptr.provenance, ptr.provenance);
// We assume that we are given the fields in increasing offset order,
// and nothing else changes.
- let unsafe_cell_offset = unsafe_cell_ptr.into_parts().1 as Size; // we just compare offsets, the abs. value never matters
- assert!(unsafe_cell_offset >= cur_offset);
- let frozen_size = unsafe_cell_offset - cur_offset;
+ let unsafe_cell_addr = unsafe_cell_ptr.addr();
+ assert!(unsafe_cell_addr >= cur_addr);
+ let frozen_size = unsafe_cell_addr - cur_addr;
// Everything between the cur_ptr and this `UnsafeCell` is frozen.
if frozen_size != Size::ZERO {
- action(alloc_range(cur_offset - start_offset, frozen_size), /*frozen*/ true)?;
+ action(alloc_range(cur_addr - start_addr, frozen_size), /*frozen*/ true)?;
}
- cur_offset += frozen_size;
+ cur_addr += frozen_size;
// This `UnsafeCell` is NOT frozen.
if unsafe_cell_size != Size::ZERO {
action(
- alloc_range(cur_offset - start_offset, unsafe_cell_size),
+ alloc_range(cur_addr - start_addr, unsafe_cell_size),
/*frozen*/ false,
)?;
}
- cur_offset += unsafe_cell_size;
+ cur_addr += unsafe_cell_size;
// Done
Ok(())
};
trace!("unsafe_cell_action on {:?}", place.ptr);
// We need a size to go on.
let unsafe_cell_size = this
- .size_and_align_of_mplace(&place)?
+ .size_and_align_of_mplace(place)?
.map(|(size, _)| size)
// for extern types, just cover what we can
.unwrap_or_else(|| place.layout.size);
// Now handle this `UnsafeCell`, unless it is empty.
if unsafe_cell_size != Size::ZERO {
- unsafe_cell_action(place.ptr, unsafe_cell_size)
+ unsafe_cell_action(&place.ptr, unsafe_cell_size)
} else {
Ok(())
}
}
// The part between the end_ptr and the end of the place is also frozen.
// So pretend there is a 0-sized `UnsafeCell` at the end.
- unsafe_cell_action(place.ptr.wrapping_offset(size, this), Size::ZERO)?;
+ unsafe_cell_action(&place.ptr.offset(size, this)?, Size::ZERO)?;
// Done!
return Ok(());
#[inline(always)]
fn ecx(&self) -> &MiriEvalContext<'mir, 'tcx> {
- &self.ecx
+ self.ecx
}
// Hook to detect `UnsafeCell`.
let mut places =
fields.collect::<InterpResult<'tcx, Vec<MPlaceTy<'tcx, Tag>>>>()?;
// we just compare offsets, the abs. value never matters
- places.sort_by_key(|place| {
- place.ptr.into_pointer_or_addr().unwrap().into_parts().1 as Size
- });
+ places.sort_by_key(|place| place.ptr.addr());
self.walk_aggregate(place, places.into_iter().map(Ok))
}
FieldsShape::Union { .. } | FieldsShape::Primitive => {
)
}
+ /// 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>> {
this.read_scalar(&errno_place.into())?.check_init()
}
- /// Sets the last OS error using a `std::io::ErrorKind`. This function tries to produce the most
- /// similar OS error from the `std::io::ErrorKind` and sets it as the last OS error.
- fn set_last_error_from_io_error(&mut self, err_kind: std::io::ErrorKind) -> InterpResult<'tcx> {
- use std::io::ErrorKind::*;
- let this = self.eval_context_mut();
+ /// 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>> {
+ let this = self.eval_context_ref();
let target = &this.tcx.sess.target;
- let target_os = &target.os;
- let last_error = if target.families.contains(&"unix".to_owned()) {
- this.eval_libc(match err_kind {
- ConnectionRefused => "ECONNREFUSED",
- ConnectionReset => "ECONNRESET",
- PermissionDenied => "EPERM",
- BrokenPipe => "EPIPE",
- NotConnected => "ENOTCONN",
- ConnectionAborted => "ECONNABORTED",
- AddrNotAvailable => "EADDRNOTAVAIL",
- AddrInUse => "EADDRINUSE",
- NotFound => "ENOENT",
- Interrupted => "EINTR",
- InvalidInput => "EINVAL",
- TimedOut => "ETIMEDOUT",
- AlreadyExists => "EEXIST",
- WouldBlock => "EWOULDBLOCK",
- DirectoryNotEmpty => "ENOTEMPTY",
- _ => {
- throw_unsup_format!(
- "io error {:?} cannot be translated into a raw os error",
- err_kind
- )
+ if target.families.iter().any(|f| f == "unix") {
+ for &(kind, name) in UNIX_IO_ERROR_TABLE {
+ if err_kind == kind {
+ return this.eval_libc(name);
}
- })?
- } else if target.families.contains(&"windows".to_owned()) {
+ }
+ throw_unsup_format!("io error {:?} cannot be translated into a raw os error", err_kind)
+ } else if target.families.iter().any(|f| f == "windows") {
// FIXME: we have to finish implementing the Windows equivalent of this.
+ use std::io::ErrorKind::*;
this.eval_windows(
"c",
match err_kind {
err_kind
),
},
- )?
+ )
} else {
throw_unsup_format!(
- "setting the last OS error from an io::Error is unsupported for {}.",
- target_os
+ "converting io::Error into errnum is unsupported for OS {}",
+ target.os
)
- };
- this.set_last_error(last_error)
+ }
+ }
+
+ /// The inverse of `io_error_to_errnum`.
+ fn errnum_to_io_error(&self, errnum: Scalar<Tag>) -> 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") {
+ let errnum = errnum.to_i32()?;
+ for &(kind, name) in UNIX_IO_ERROR_TABLE {
+ if errnum == this.eval_libc_i32(name)? {
+ return Ok(kind);
+ }
+ }
+ throw_unsup_format!("raw errnum {:?} cannot be translated into io::Error", errnum)
+ } else {
+ throw_unsup_format!(
+ "converting errnum into io::Error is unsupported for OS {}",
+ target.os
+ )
+ }
+ }
+
+ /// Sets the last OS error using a `std::io::ErrorKind`.
+ fn set_last_error_from_io_error(&mut self, err_kind: std::io::ErrorKind) -> InterpResult<'tcx> {
+ self.set_last_error(self.io_error_to_errnum(err_kind)?)
}
/// Helper function that consumes an `std::io::Result<T>` and returns an
}
}
- 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>,
offset: u64,
layout: TyAndLayout<'tcx>,
- ) -> InterpResult<'tcx, ScalarMaybeUninit<Tag>> {
+ ) -> InterpResult<'tcx, MPlaceTy<'tcx, Tag>> {
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)?;
+ Ok(value_place)
+ }
+
+ fn read_scalar_at_offset(
+ &self,
+ op: &OpTy<'tcx, Tag>,
+ offset: u64,
+ layout: TyAndLayout<'tcx>,
+ ) -> InterpResult<'tcx, ScalarMaybeUninit<Tag>> {
+ let this = self.eval_context_ref();
+ let value_place = this.deref_operand_and_offset(op, offset, layout)?;
this.read_scalar(&value_place.into())
}
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())
}
/// `EINVAL` in this case.
fn read_timespec(&mut self, tp: &MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx, Option<Duration>> {
let this = self.eval_context_mut();
- let seconds_place = this.mplace_field(&tp, 0)?;
+ let seconds_place = this.mplace_field(tp, 0)?;
let seconds_scalar = this.read_scalar(&seconds_place.into())?;
let seconds = seconds_scalar.to_machine_isize(this)?;
- let nanoseconds_place = this.mplace_field(&tp, 1)?;
+ let nanoseconds_place = this.mplace_field(tp, 1)?;
let nanoseconds_scalar = this.read_scalar(&nanoseconds_place.into())?;
let nanoseconds = nanoseconds_scalar.to_machine_isize(this)?;
loop {
// 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.memory.get(ptr.offset(len, this)?.into(), 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 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_integer(Size::ZERO, size1)?.to_u8()?;
if byte == 0 {
break;
} else {
- len = len + size1;
+ len += size1;
}
}
// Step 2: get the bytes.
- this.memory.read_bytes(ptr.into(), len)
+ this.read_bytes_ptr(ptr, len)
}
fn read_wide_str(&self, mut ptr: Pointer<Option<Tag>>) -> InterpResult<'tcx, Vec<u16>> {
loop {
// 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.memory.get(ptr.into(), 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 alloc = this.get_ptr_alloc(ptr, size2, align2)?.unwrap(); // not a ZST, so we will get a result
+ let wchar = alloc.read_integer(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.
// message is slightly different here to make automated analysis easier
let error_msg = format!("unsupported Miri functionality: {}", error_msg.as_ref());
this.start_panic(error_msg.as_ref(), StackPopUnwind::Skip)?;
- return Ok(());
+ Ok(())
} else {
throw_unsup_format!("{}", error_msg.as_ref());
}
/// Mark a machine allocation that was just created as immutable.
fn mark_immutable(&mut self, mplace: &MemPlace<Tag>) {
let this = self.eval_context_mut();
- this.memory
- .mark_immutable(mplace.ptr.into_pointer_or_addr().unwrap().provenance.alloc_id)
- .unwrap();
+ // This got just allocated, so there definitely is a pointer here.
+ 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 {
+ let tcx = self.eval_context_ref().tcx;
+ match tcx.get_attrs(def_id, sym::link_name).filter_map(|a| a.value_str()).next() {
+ Some(name) => name,
+ None => tcx.item_name(def_id),
+ }
+ }
+}
+
+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)
}
}
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,
)))
}
-pub fn bool_to_simd_element(b: bool, size: Size) -> Scalar<Tag> {
- // SIMD uses all-1 as pattern for "true"
- let val = if b { -1 } else { 0 };
- Scalar::from_int(val, size)
+/// 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> {
+ // 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")
+ .map(|crates| crates.split(',').map(|krate| krate.to_string()).collect::<Vec<_>>())
+ .unwrap_or_default();
+ let mut local_crates = Vec::new();
+ for &crate_num in tcx.crates(()) {
+ let name = tcx.crate_name(crate_num);
+ let name = name.as_str();
+ if local_crate_names.iter().any(|local_name| local_name == name) {
+ local_crates.push(crate_num);
+ }
+ }
+ local_crates
+}
+
+/// Formats an AllocRange like [0x1..0x3], for use in diagnostics.
+pub struct HexRange(pub AllocRange);
+
+impl std::fmt::Display for HexRange {
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+ write!(f, "[{:#x}..{:#x}]", self.0.start.bytes(), self.0.end().bytes())
+ }
}
-pub fn simd_element_to_bool<'tcx>(elem: ImmTy<'tcx, Tag>) -> InterpResult<'tcx, bool> {
- let val = elem.to_scalar()?.to_int(elem.layout.size)?;
- Ok(match val {
- 0 => false,
- -1 => true,
- _ => throw_ub_format!("each element of a SIMD mask must be all-0-bits or all-1-bits"),
- })
+/// 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")
}
projects / rust.git / blobdiff