src/intptrcast.rs

   1 use std::cell::RefCell;
   2 use std::cmp::max;
   3 use std::collections::hash_map::Entry;
   4
   5 use log::trace;
   6 use rand::Rng;
   7
   8 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
   9 use rustc_span::Span;
  10 use rustc_target::abi::{HasDataLayout, Size};
  11
  12 use crate::*;
  13
  14 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
  15 pub enum ProvenanceMode {
  16     /// We support `expose_addr`/`from_exposed_addr` via "wildcard" provenance.
  17     /// However, we want on `from_exposed_addr` to alert the user of the precision loss.
  18     Default,
  19     /// Like `Default`, but without the warning.
  20     Permissive,
  21     /// We error on `from_exposed_addr`, ensuring no precision loss.
  22     Strict,
  23 }
  24
  25 pub type GlobalState = RefCell<GlobalStateInner>;
  26
  27 #[derive(Clone, Debug)]
  28 pub struct GlobalStateInner {
  29     /// This is used as a map between the address of each allocation and its `AllocId`.
  30     /// It is always sorted
  31     int_to_ptr_map: Vec<(u64, AllocId)>,
  32     /// The base address for each allocation.  We cannot put that into
  33     /// `AllocExtra` because function pointers also have a base address, and
  34     /// they do not have an `AllocExtra`.
  35     /// This is the inverse of `int_to_ptr_map`.
  36     base_addr: FxHashMap<AllocId, u64>,
  37     /// Whether an allocation has been exposed or not. This cannot be put
  38     /// into `AllocExtra` for the same reason as `base_addr`.
  39     exposed: FxHashSet<AllocId>,
  40     /// This is used as a memory address when a new pointer is casted to an integer. It
  41     /// is always larger than any address that was previously made part of a block.
  42     next_base_addr: u64,
  43     /// The provenance to use for int2ptr casts
  44     provenance_mode: ProvenanceMode,
  45 }
  46
  47 impl GlobalStateInner {
  48     pub fn new(config: &MiriConfig) -> Self {
  49         GlobalStateInner {
  50             int_to_ptr_map: Vec::default(),
  51             base_addr: FxHashMap::default(),
  52             exposed: FxHashSet::default(),
  53             next_base_addr: STACK_ADDR,
  54             provenance_mode: config.provenance_mode,
  55         }
  56     }
  57 }
  58
  59 impl<'mir, 'tcx> GlobalStateInner {
  60     // Returns the exposed `AllocId` that corresponds to the specified addr,
  61     // or `None` if the addr is out of bounds
  62     fn alloc_id_from_addr(ecx: &MiriEvalContext<'mir, 'tcx>, addr: u64) -> Option<AllocId> {
  63         let global_state = ecx.machine.intptrcast.borrow();
  64         assert!(global_state.provenance_mode != ProvenanceMode::Strict);
  65
  66         let pos = global_state.int_to_ptr_map.binary_search_by_key(&addr, |(addr, _)| *addr);
  67
  68         // Determine the in-bounds provenance for this pointer.
  69         // (This is only called on an actual access, so in-bounds is the only possible kind of provenance.)
  70         let alloc_id = match pos {
  71             Ok(pos) => Some(global_state.int_to_ptr_map[pos].1),
  72             Err(0) => None,
  73             Err(pos) => {
  74                 // This is the largest of the adresses smaller than `int`,
  75                 // i.e. the greatest lower bound (glb)
  76                 let (glb, alloc_id) = global_state.int_to_ptr_map[pos - 1];
  77                 // This never overflows because `addr >= glb`
  78                 let offset = addr - glb;
  79                 // If the offset exceeds the size of the allocation, don't use this `alloc_id`.
  80                 let size = ecx.get_alloc_info(alloc_id).0;
  81                 if offset <= size.bytes() { Some(alloc_id) } else { None }
  82             }
  83         }?;
  84
  85         // We only use this provenance if it has been exposed, *and* is still live.
  86         if global_state.exposed.contains(&alloc_id) {
  87             let (_size, _align, kind) = ecx.get_alloc_info(alloc_id);
  88             match kind {
  89                 AllocKind::LiveData | AllocKind::Function | AllocKind::VTable => {
  90                     return Some(alloc_id);
  91                 }
  92                 AllocKind::Dead => {}
  93             }
  94         }
  95
  96         None
  97     }
  98
  99     pub fn expose_ptr(
 100         ecx: &mut MiriEvalContext<'mir, 'tcx>,
 101         alloc_id: AllocId,
 102         sb: SbTag,
 103     ) -> InterpResult<'tcx> {
 104         let global_state = ecx.machine.intptrcast.get_mut();
 105         // In strict mode, we don't need this, so we can save some cycles by not tracking it.
 106         if global_state.provenance_mode != ProvenanceMode::Strict {
 107             trace!("Exposing allocation id {alloc_id:?}");
 108             global_state.exposed.insert(alloc_id);
 109             if ecx.machine.stacked_borrows.is_some() {
 110                 ecx.expose_tag(alloc_id, sb)?;
 111             }
 112         }
 113         Ok(())
 114     }
 115
 116     pub fn ptr_from_addr_transmute(
 117         _ecx: &MiriEvalContext<'mir, 'tcx>,
 118         addr: u64,
 119     ) -> Pointer<Option<Provenance>> {
 120         trace!("Transmuting {:#x} to a pointer", addr);
 121
 122         // We consider transmuted pointers to be "invalid" (`None` provenance).
 123         Pointer::new(None, Size::from_bytes(addr))
 124     }
 125
 126     pub fn ptr_from_addr_cast(
 127         ecx: &MiriEvalContext<'mir, 'tcx>,
 128         addr: u64,
 129     ) -> InterpResult<'tcx, Pointer<Option<Provenance>>> {
 130         trace!("Casting {:#x} to a pointer", addr);
 131
 132         let global_state = ecx.machine.intptrcast.borrow();
 133
 134         match global_state.provenance_mode {
 135             ProvenanceMode::Default => {
 136                 // The first time this happens at a particular location, print a warning.
 137                 thread_local! {
 138                     // `Span` is non-`Send`, so we use a thread-local instead.
 139                     static PAST_WARNINGS: RefCell<FxHashSet<Span>> = RefCell::default();
 140                 }
 141                 PAST_WARNINGS.with_borrow_mut(|past_warnings| {
 142                     let first = past_warnings.is_empty();
 143                     if past_warnings.insert(ecx.cur_span()) {
 144                         // Newly inserted, so first time we see this span.
 145                         register_diagnostic(NonHaltingDiagnostic::Int2Ptr { details: first });
 146                     }
 147                 });
 148             }
 149             ProvenanceMode::Strict => {
 150                 throw_machine_stop!(TerminationInfo::Int2PtrWithStrictProvenance);
 151             }
 152             ProvenanceMode::Permissive => {}
 153         }
 154
 155         // This is how wildcard pointers are born.
 156         Ok(Pointer::new(Some(Provenance::Wildcard), Size::from_bytes(addr)))
 157     }
 158
 159     fn alloc_base_addr(ecx: &MiriEvalContext<'mir, 'tcx>, alloc_id: AllocId) -> u64 {
 160         let mut global_state = ecx.machine.intptrcast.borrow_mut();
 161         let global_state = &mut *global_state;
 162
 163         match global_state.base_addr.entry(alloc_id) {
 164             Entry::Occupied(entry) => *entry.get(),
 165             Entry::Vacant(entry) => {
 166                 // There is nothing wrong with a raw pointer being cast to an integer only after
 167                 // it became dangling.  Hence we allow dead allocations.
 168                 let (size, align, _kind) = ecx.get_alloc_info(alloc_id);
 169
 170                 // This allocation does not have a base address yet, pick one.
 171                 // Leave some space to the previous allocation, to give it some chance to be less aligned.
 172                 let slack = {
 173                     let mut rng = ecx.machine.rng.borrow_mut();
 174                     // This means that `(global_state.next_base_addr + slack) % 16` is uniformly distributed.
 175                     rng.gen_range(0..16)
 176                 };
 177                 // From next_base_addr + slack, round up to adjust for alignment.
 178                 let base_addr = global_state.next_base_addr.checked_add(slack).unwrap();
 179                 let base_addr = Self::align_addr(base_addr, align.bytes());
 180                 entry.insert(base_addr);
 181                 trace!(
 182                     "Assigning base address {:#x} to allocation {:?} (size: {}, align: {}, slack: {})",
 183                     base_addr,
 184                     alloc_id,
 185                     size.bytes(),
 186                     align.bytes(),
 187                     slack,
 188                 );
 189
 190                 // Remember next base address.  If this allocation is zero-sized, leave a gap
 191                 // of at least 1 to avoid two allocations having the same base address.
 192                 // (The logic in `alloc_id_from_addr` assumes unique addresses, and different
 193                 // function/vtable pointers need to be distinguishable!)
 194                 global_state.next_base_addr = base_addr.checked_add(max(size.bytes(), 1)).unwrap();
 195                 // Given that `next_base_addr` increases in each allocation, pushing the
 196                 // corresponding tuple keeps `int_to_ptr_map` sorted
 197                 global_state.int_to_ptr_map.push((base_addr, alloc_id));
 198
 199                 base_addr
 200             }
 201         }
 202     }
 203
 204     /// Convert a relative (tcx) pointer to an absolute address.
 205     pub fn rel_ptr_to_addr(ecx: &MiriEvalContext<'mir, 'tcx>, ptr: Pointer<AllocId>) -> u64 {
 206         let (alloc_id, offset) = ptr.into_parts(); // offset is relative (AllocId provenance)
 207         let base_addr = GlobalStateInner::alloc_base_addr(ecx, alloc_id);
 208
 209         // Add offset with the right kind of pointer-overflowing arithmetic.
 210         let dl = ecx.data_layout();
 211         dl.overflowing_offset(base_addr, offset.bytes()).0
 212     }
 213
 214     /// When a pointer is used for a memory access, this computes where in which allocation the
 215     /// access is going.
 216     pub fn abs_ptr_to_rel(
 217         ecx: &MiriEvalContext<'mir, 'tcx>,
 218         ptr: Pointer<Provenance>,
 219     ) -> Option<(AllocId, Size)> {
 220         let (tag, addr) = ptr.into_parts(); // addr is absolute (Tag provenance)
 221
 222         let alloc_id = if let Provenance::Concrete { alloc_id, .. } = tag {
 223             alloc_id
 224         } else {
 225             // A wildcard pointer.
 226             GlobalStateInner::alloc_id_from_addr(ecx, addr.bytes())?
 227         };
 228
 229         let base_addr = GlobalStateInner::alloc_base_addr(ecx, alloc_id);
 230
 231         // Wrapping "addr - base_addr"
 232         let dl = ecx.data_layout();
 233         #[allow(clippy::cast_possible_wrap)] // we want to wrap here
 234         let neg_base_addr = (base_addr as i64).wrapping_neg();
 235         Some((
 236             alloc_id,
 237             Size::from_bytes(dl.overflowing_signed_offset(addr.bytes(), neg_base_addr).0),
 238         ))
 239     }
 240
 241     /// Shifts `addr` to make it aligned with `align` by rounding `addr` to the smallest multiple
 242     /// of `align` that is larger or equal to `addr`
 243     fn align_addr(addr: u64, align: u64) -> u64 {
 244         match addr % align {
 245             0 => addr,
 246             rem => addr.checked_add(align).unwrap() - rem,
 247         }
 248     }
 249 }
 250
 251 #[cfg(test)]
 252 mod tests {
 253     use super::*;
 254
 255     #[test]
 256     fn test_align_addr() {
 257         assert_eq!(GlobalStateInner::align_addr(37, 4), 40);
 258         assert_eq!(GlobalStateInner::align_addr(44, 4), 44);
 259     }
 260 }