use log::trace;
use rand::Rng;
-use rustc_data_structures::fx::FxHashMap;
-use rustc_middle::ty::layout::HasDataLayout;
-use rustc_mir::interpret::{AllocCheck, AllocId, InterpResult, Memory, Machine, Pointer, PointerArithmetic};
-use rustc_target::abi::Size;
+use rustc_data_structures::fx::{FxHashMap, FxHashSet};
+use rustc_span::Span;
+use rustc_target::abi::{HasDataLayout, Size};
-use crate::{Evaluator, Tag, STACK_ADDR};
+use crate::*;
-pub type MemoryExtra = RefCell<GlobalState>;
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+pub enum ProvenanceMode {
+ /// We support `expose_addr`/`from_exposed_addr` via "wildcard" provenance.
+ /// However, we want on `from_exposed_addr` to alert the user of the precision loss.
+ Default,
+ /// Like `Default`, but without the warning.
+ Permissive,
+ /// We error on `from_exposed_addr`, ensuring no precision loss.
+ Strict,
+}
+
+pub type GlobalState = RefCell<GlobalStateInner>;
#[derive(Clone, Debug)]
-pub struct GlobalState {
+pub struct GlobalStateInner {
/// This is used as a map between the address of each allocation and its `AllocId`.
/// It is always sorted
- pub int_to_ptr_map: Vec<(u64, AllocId)>,
+ int_to_ptr_map: Vec<(u64, AllocId)>,
/// The base address for each allocation. We cannot put that into
/// `AllocExtra` because function pointers also have a base address, and
/// they do not have an `AllocExtra`.
/// This is the inverse of `int_to_ptr_map`.
- pub base_addr: FxHashMap<AllocId, u64>,
+ base_addr: FxHashMap<AllocId, u64>,
+ /// Whether an allocation has been exposed or not. This cannot be put
+ /// into `AllocExtra` for the same reason as `base_addr`.
+ exposed: FxHashSet<AllocId>,
/// This is used as a memory address when a new pointer is casted to an integer. It
/// is always larger than any address that was previously made part of a block.
- pub next_base_addr: u64,
+ next_base_addr: u64,
+ /// The provenance to use for int2ptr casts
+ provenance_mode: ProvenanceMode,
}
-impl Default for GlobalState {
- fn default() -> Self {
- GlobalState {
+impl GlobalStateInner {
+ pub fn new(config: &MiriConfig) -> Self {
+ GlobalStateInner {
int_to_ptr_map: Vec::default(),
base_addr: FxHashMap::default(),
+ exposed: FxHashSet::default(),
next_base_addr: STACK_ADDR,
+ provenance_mode: config.provenance_mode,
}
}
}
-impl<'mir, 'tcx> GlobalState {
- pub fn int_to_ptr(
- int: u64,
- memory: &Memory<'mir, 'tcx, Evaluator<'tcx>>,
- ) -> InterpResult<'tcx, Pointer<Tag>> {
- let global_state = memory.extra.intptrcast.borrow();
- let pos = global_state.int_to_ptr_map.binary_search_by_key(&int, |(addr, _)| *addr);
-
- Ok(match pos {
- Ok(pos) => {
- let (_, alloc_id) = global_state.int_to_ptr_map[pos];
- // `int` is equal to the starting address for an allocation, the offset should be
- // zero. The pointer is untagged because it was created from a cast
- Pointer::new_with_tag(alloc_id, Size::from_bytes(0), Tag::Untagged)
- }
- Err(0) => throw_ub!(InvalidIntPointerUsage(int)),
+impl<'mir, 'tcx> GlobalStateInner {
+ // Returns the exposed `AllocId` that corresponds to the specified addr,
+ // or `None` if the addr is out of bounds
+ fn alloc_id_from_addr(ecx: &MiriEvalContext<'mir, 'tcx>, addr: u64) -> Option<AllocId> {
+ let global_state = ecx.machine.intptrcast.borrow();
+ assert!(global_state.provenance_mode != ProvenanceMode::Strict);
+
+ let pos = global_state.int_to_ptr_map.binary_search_by_key(&addr, |(addr, _)| *addr);
+
+ // Determine the in-bounds provenance for this pointer.
+ // (This is only called on an actual access, so in-bounds is the only possible kind of provenance.)
+ let alloc_id = match pos {
+ Ok(pos) => Some(global_state.int_to_ptr_map[pos].1),
+ Err(0) => None,
Err(pos) => {
// This is the largest of the adresses smaller than `int`,
// i.e. the greatest lower bound (glb)
let (glb, alloc_id) = global_state.int_to_ptr_map[pos - 1];
- // This never overflows because `int >= glb`
- let offset = int - glb;
- // If the offset exceeds the size of the allocation, this access is illegal
- if offset <= memory.get_size_and_align(alloc_id, AllocCheck::MaybeDead)?.0.bytes() {
- // This pointer is untagged because it was created from a cast
- Pointer::new_with_tag(alloc_id, Size::from_bytes(offset), Tag::Untagged)
- } else {
- throw_ub!(InvalidIntPointerUsage(int))
+ // This never overflows because `addr >= glb`
+ let offset = addr - glb;
+ // If the offset exceeds the size of the allocation, don't use this `alloc_id`.
+ let size = ecx.get_alloc_info(alloc_id).0;
+ if offset <= size.bytes() { Some(alloc_id) } else { None }
+ }
+ }?;
+
+ // We only use this provenance if it has been exposed, *and* is still live.
+ if global_state.exposed.contains(&alloc_id) {
+ let (_size, _align, kind) = ecx.get_alloc_info(alloc_id);
+ match kind {
+ AllocKind::LiveData | AllocKind::Function => return Some(alloc_id),
+ AllocKind::Dead => {}
+ }
+ }
+
+ None
+ }
+
+ pub fn expose_ptr(ecx: &mut MiriEvalContext<'mir, 'tcx>, alloc_id: AllocId, sb: SbTag) {
+ let global_state = ecx.machine.intptrcast.get_mut();
+ // In strict mode, we don't need this, so we can save some cycles by not tracking it.
+ if global_state.provenance_mode != ProvenanceMode::Strict {
+ trace!("Exposing allocation id {alloc_id:?}");
+ global_state.exposed.insert(alloc_id);
+ if ecx.machine.stacked_borrows.is_some() {
+ ecx.expose_tag(alloc_id, sb);
+ }
+ }
+ }
+
+ pub fn ptr_from_addr_transmute(
+ ecx: &MiriEvalContext<'mir, 'tcx>,
+ addr: u64,
+ ) -> Pointer<Option<Tag>> {
+ trace!("Transmuting 0x{:x} to a pointer", addr);
+
+ let provenance = if ecx.machine.allow_ptr_int_transmute {
+ // When we allow transmutes, treat them like casts: generating a wildcard pointer.
+ Some(Tag::Wildcard)
+ } else {
+ // Usually, we consider transmuted pointers to be "invalid" (`None` provenance).
+ None
+ };
+ Pointer::new(provenance, Size::from_bytes(addr))
+ }
+
+ pub fn ptr_from_addr_cast(
+ ecx: &MiriEvalContext<'mir, 'tcx>,
+ addr: u64,
+ ) -> InterpResult<'tcx, Pointer<Option<Tag>>> {
+ trace!("Casting 0x{:x} to a pointer", addr);
+
+ let global_state = ecx.machine.intptrcast.borrow();
+
+ match global_state.provenance_mode {
+ ProvenanceMode::Default => {
+ // The first time this happens at a particular location, print a warning.
+ thread_local! {
+ // `Span` is non-`Send`, so we use a thread-local instead.
+ static PAST_WARNINGS: RefCell<FxHashSet<Span>> = RefCell::default();
}
+ PAST_WARNINGS.with_borrow_mut(|past_warnings| {
+ let first = past_warnings.is_empty();
+ if past_warnings.insert(ecx.cur_span()) {
+ // Newly inserted, so first time we see this span.
+ register_diagnostic(NonHaltingDiagnostic::Int2Ptr { details: first });
+ }
+ });
+ }
+ ProvenanceMode::Strict => {
+ throw_machine_stop!(TerminationInfo::Int2PtrWithStrictProvenance);
}
- })
+ ProvenanceMode::Permissive => {}
+ }
+
+ // This is how wildcard pointers are born.
+ Ok(Pointer::new(Some(Tag::Wildcard), Size::from_bytes(addr)))
}
- pub fn ptr_to_int(
- ptr: Pointer<Tag>,
- memory: &Memory<'mir, 'tcx, Evaluator<'tcx>>,
- ) -> InterpResult<'tcx, u64> {
- let mut global_state = memory.extra.intptrcast.borrow_mut();
+ fn alloc_base_addr(ecx: &MiriEvalContext<'mir, 'tcx>, alloc_id: AllocId) -> u64 {
+ let mut global_state = ecx.machine.intptrcast.borrow_mut();
let global_state = &mut *global_state;
- let id = Evaluator::canonical_alloc_id(memory, ptr.alloc_id);
- // There is nothing wrong with a raw pointer being cast to an integer only after
- // it became dangling. Hence `MaybeDead`.
- let (size, align) = memory.get_size_and_align(id, AllocCheck::MaybeDead)?;
-
- let base_addr = match global_state.base_addr.entry(id) {
+ match global_state.base_addr.entry(alloc_id) {
Entry::Occupied(entry) => *entry.get(),
Entry::Vacant(entry) => {
+ // There is nothing wrong with a raw pointer being cast to an integer only after
+ // it became dangling. Hence we allow dead allocations.
+ let (size, align, _kind) = ecx.get_alloc_info(alloc_id);
+
// This allocation does not have a base address yet, pick one.
// Leave some space to the previous allocation, to give it some chance to be less aligned.
let slack = {
- let mut rng = memory.extra.rng.borrow_mut();
+ let mut rng = ecx.machine.rng.borrow_mut();
// This means that `(global_state.next_base_addr + slack) % 16` is uniformly distributed.
- rng.gen_range(0, 16)
+ rng.gen_range(0..16)
};
// From next_base_addr + slack, round up to adjust for alignment.
let base_addr = global_state.next_base_addr.checked_add(slack).unwrap();
let base_addr = Self::align_addr(base_addr, align.bytes());
entry.insert(base_addr);
trace!(
- "Assigning base address {:#x} to allocation {:?} (slack: {}, align: {})",
+ "Assigning base address {:#x} to allocation {:?} (size: {}, align: {}, slack: {})",
base_addr,
- id,
- slack,
+ alloc_id,
+ size.bytes(),
align.bytes(),
+ slack,
);
// Remember next base address. If this allocation is zero-sized, leave a gap
// of at least 1 to avoid two allocations having the same base address.
+ // (The logic in `alloc_id_from_addr` assumes unique addresses, and function
+ // pointers to different functions need to be distinguishable!)
global_state.next_base_addr = base_addr.checked_add(max(size.bytes(), 1)).unwrap();
// Given that `next_base_addr` increases in each allocation, pushing the
// corresponding tuple keeps `int_to_ptr_map` sorted
- global_state.int_to_ptr_map.push((base_addr, id));
+ global_state.int_to_ptr_map.push((base_addr, alloc_id));
base_addr
}
- };
+ }
+ }
+
+ /// Convert a relative (tcx) pointer to an absolute address.
+ pub fn rel_ptr_to_addr(ecx: &MiriEvalContext<'mir, 'tcx>, ptr: Pointer<AllocId>) -> u64 {
+ let (alloc_id, offset) = ptr.into_parts(); // offset is relative (AllocId provenance)
+ let base_addr = GlobalStateInner::alloc_base_addr(ecx, alloc_id);
- // Sanity check that the base address is aligned.
- debug_assert_eq!(base_addr % align.bytes(), 0);
// Add offset with the right kind of pointer-overflowing arithmetic.
- let dl = memory.data_layout();
- Ok(dl.overflowing_offset(base_addr, ptr.offset.bytes()).0)
+ let dl = ecx.data_layout();
+ dl.overflowing_offset(base_addr, offset.bytes()).0
+ }
+
+ /// When a pointer is used for a memory access, this computes where in which allocation the
+ /// access is going.
+ pub fn abs_ptr_to_rel(
+ ecx: &MiriEvalContext<'mir, 'tcx>,
+ ptr: Pointer<Tag>,
+ ) -> Option<(AllocId, Size)> {
+ let (tag, addr) = ptr.into_parts(); // addr is absolute (Tag provenance)
+
+ let alloc_id = if let Tag::Concrete { alloc_id, .. } = tag {
+ alloc_id
+ } else {
+ // A wildcard pointer.
+ GlobalStateInner::alloc_id_from_addr(ecx, addr.bytes())?
+ };
+
+ let base_addr = GlobalStateInner::alloc_base_addr(ecx, alloc_id);
+
+ // Wrapping "addr - base_addr"
+ let dl = ecx.data_layout();
+ let neg_base_addr = (base_addr as i64).wrapping_neg();
+ Some((
+ alloc_id,
+ Size::from_bytes(dl.overflowing_signed_offset(addr.bytes(), neg_base_addr).0),
+ ))
}
/// Shifts `addr` to make it aligned with `align` by rounding `addr` to the smallest multiple
#[test]
fn test_align_addr() {
- assert_eq!(GlobalState::align_addr(37, 4), 40);
- assert_eq!(GlobalState::align_addr(44, 4), 44);
+ assert_eq!(GlobalStateInner::align_addr(37, 4), 40);
+ assert_eq!(GlobalStateInner::align_addr(44, 4), 44);
}
}
projects / rust.git / blobdiff