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 => return Some(alloc_id),
  90                 AllocKind::Dead => {}
  91             }
  92         }
  93
  94         None
  95     }
  96
  97     pub fn expose_ptr(ecx: &mut MiriEvalContext<'mir, 'tcx>, alloc_id: AllocId, sb: SbTag) {
  98         let global_state = ecx.machine.intptrcast.get_mut();
  99         // In strict mode, we don't need this, so we can save some cycles by not tracking it.
 100         if global_state.provenance_mode != ProvenanceMode::Strict {
 101             trace!("Exposing allocation id {alloc_id:?}");
 102             global_state.exposed.insert(alloc_id);
 103             if ecx.machine.stacked_borrows.is_some() {
 104                 ecx.expose_tag(alloc_id, sb);
 105             }
 106         }
 107     }
 108
 109     pub fn ptr_from_addr_transmute(
 110         ecx: &MiriEvalContext<'mir, 'tcx>,
 111         addr: u64,
 112     ) -> Pointer<Option<Tag>> {
 113         trace!("Transmuting 0x{:x} to a pointer", addr);
 114
 115         let provenance = if ecx.machine.allow_ptr_int_transmute {
 116             // When we allow transmutes, treat them like casts: generating a wildcard pointer.
 117             Some(Tag::Wildcard)
 118         } else {
 119             // Usually, we consider transmuted pointers to be "invalid" (`None` provenance).
 120             None
 121         };
 122         Pointer::new(provenance, Size::from_bytes(addr))
 123     }
 124
 125     pub fn ptr_from_addr_cast(
 126         ecx: &MiriEvalContext<'mir, 'tcx>,
 127         addr: u64,
 128     ) -> InterpResult<'tcx, Pointer<Option<Tag>>> {
 129         trace!("Casting 0x{:x} to a pointer", addr);
 130
 131         let global_state = ecx.machine.intptrcast.borrow();
 132
 133         match global_state.provenance_mode {
 134             ProvenanceMode::Default => {
 135                 // The first time this happens at a particular location, print a warning.
 136                 thread_local! {
 137                     // `Span` is non-`Send`, so we use a thread-local instead.
 138                     static PAST_WARNINGS: RefCell<FxHashSet<Span>> = RefCell::default();
 139                 }
 140                 PAST_WARNINGS.with_borrow_mut(|past_warnings| {
 141                     let first = past_warnings.is_empty();
 142                     if past_warnings.insert(ecx.cur_span()) {
 143                         // Newly inserted, so first time we see this span.
 144                         register_diagnostic(NonHaltingDiagnostic::Int2Ptr { details: first });
 145                     }
 146                 });
 147             }
 148             ProvenanceMode::Strict => {
 149                 throw_machine_stop!(TerminationInfo::Int2PtrWithStrictProvenance);
 150             }
 151             ProvenanceMode::Permissive => {}
 152         }
 153
 154         // This is how wildcard pointers are born.
 155         Ok(Pointer::new(Some(Tag::Wildcard), Size::from_bytes(addr)))
 156     }
 157
 158     fn alloc_base_addr(ecx: &MiriEvalContext<'mir, 'tcx>, alloc_id: AllocId) -> u64 {
 159         let mut global_state = ecx.machine.intptrcast.borrow_mut();
 160         let global_state = &mut *global_state;
 161
 162         match global_state.base_addr.entry(alloc_id) {
 163             Entry::Occupied(entry) => *entry.get(),
 164             Entry::Vacant(entry) => {
 165                 // There is nothing wrong with a raw pointer being cast to an integer only after
 166                 // it became dangling.  Hence we allow dead allocations.
 167                 let (size, align, _kind) = ecx.get_alloc_info(alloc_id);
 168
 169                 // This allocation does not have a base address yet, pick one.
 170                 // Leave some space to the previous allocation, to give it some chance to be less aligned.
 171                 let slack = {
 172                     let mut rng = ecx.machine.rng.borrow_mut();
 173                     // This means that `(global_state.next_base_addr + slack) % 16` is uniformly distributed.
 174                     rng.gen_range(0..16)
 175                 };
 176                 // From next_base_addr + slack, round up to adjust for alignment.
 177                 let base_addr = global_state.next_base_addr.checked_add(slack).unwrap();
 178                 let base_addr = Self::align_addr(base_addr, align.bytes());
 179                 entry.insert(base_addr);
 180                 trace!(
 181                     "Assigning base address {:#x} to allocation {:?} (size: {}, align: {}, slack: {})",
 182                     base_addr,
 183                     alloc_id,
 184                     size.bytes(),
 185                     align.bytes(),
 186                     slack,
 187                 );
 188
 189                 // Remember next base address.  If this allocation is zero-sized, leave a gap
 190                 // of at least 1 to avoid two allocations having the same base address.
 191                 // (The logic in `alloc_id_from_addr` assumes unique addresses, and function
 192                 // pointers to different functions need to be distinguishable!)
 193                 global_state.next_base_addr = base_addr.checked_add(max(size.bytes(), 1)).unwrap();
 194                 // Given that `next_base_addr` increases in each allocation, pushing the
 195                 // corresponding tuple keeps `int_to_ptr_map` sorted
 196                 global_state.int_to_ptr_map.push((base_addr, alloc_id));
 197
 198                 base_addr
 199             }
 200         }
 201     }
 202
 203     /// Convert a relative (tcx) pointer to an absolute address.
 204     pub fn rel_ptr_to_addr(ecx: &MiriEvalContext<'mir, 'tcx>, ptr: Pointer<AllocId>) -> u64 {
 205         let (alloc_id, offset) = ptr.into_parts(); // offset is relative (AllocId provenance)
 206         let base_addr = GlobalStateInner::alloc_base_addr(ecx, alloc_id);
 207
 208         // Add offset with the right kind of pointer-overflowing arithmetic.
 209         let dl = ecx.data_layout();
 210         dl.overflowing_offset(base_addr, offset.bytes()).0
 211     }
 212
 213     /// When a pointer is used for a memory access, this computes where in which allocation the
 214     /// access is going.
 215     pub fn abs_ptr_to_rel(
 216         ecx: &MiriEvalContext<'mir, 'tcx>,
 217         ptr: Pointer<Tag>,
 218     ) -> Option<(AllocId, Size)> {
 219         let (tag, addr) = ptr.into_parts(); // addr is absolute (Tag provenance)
 220
 221         let alloc_id = if let Tag::Concrete { alloc_id, .. } = tag {
 222             alloc_id
 223         } else {
 224             // A wildcard pointer.
 225             GlobalStateInner::alloc_id_from_addr(ecx, addr.bytes())?
 226         };
 227
 228         let base_addr = GlobalStateInner::alloc_base_addr(ecx, alloc_id);
 229
 230         // Wrapping "addr - base_addr"
 231         let dl = ecx.data_layout();
 232         let neg_base_addr = (base_addr as i64).wrapping_neg();
 233         Some((
 234             alloc_id,
 235             Size::from_bytes(dl.overflowing_signed_offset(addr.bytes(), neg_base_addr).0),
 236         ))
 237     }
 238
 239     /// Shifts `addr` to make it aligned with `align` by rounding `addr` to the smallest multiple
 240     /// of `align` that is larger or equal to `addr`
 241     fn align_addr(addr: u64, align: u64) -> u64 {
 242         match addr % align {
 243             0 => addr,
 244             rem => addr.checked_add(align).unwrap() - rem,
 245         }
 246     }
 247 }
 248
 249 #[cfg(test)]
 250 mod tests {
 251     use super::*;
 252
 253     #[test]
 254     fn test_align_addr() {
 255         assert_eq!(GlobalStateInner::align_addr(37, 4), 40);
 256         assert_eq!(GlobalStateInner::align_addr(44, 4), 44);
 257     }
 258 }