src/helpers.rs

   1 use std::mem;
   2
   3 use rustc::ty::{self, layout::{self, Size, Align}};
   4 use rustc::hir::def_id::{DefId, CRATE_DEF_INDEX};
   5 use rustc::mir;
   6
   7 use rand::RngCore;
   8
   9 use crate::*;
  10
  11 impl<'mir, 'tcx> EvalContextExt<'mir, 'tcx> for crate::MiriEvalContext<'mir, 'tcx> {}
  12
  13 pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
  14     /// Gets an instance for a path.
  15     fn resolve_path(&self, path: &[&str]) -> InterpResult<'tcx, ty::Instance<'tcx>> {
  16         let this = self.eval_context_ref();
  17         this.tcx
  18             .crates()
  19             .iter()
  20             .find(|&&krate| this.tcx.original_crate_name(krate).as_str() == path[0])
  21             .and_then(|krate| {
  22                 let krate = DefId {
  23                     krate: *krate,
  24                     index: CRATE_DEF_INDEX,
  25                 };
  26                 let mut items = this.tcx.item_children(krate);
  27                 let mut path_it = path.iter().skip(1).peekable();
  28
  29                 while let Some(segment) = path_it.next() {
  30                     for item in mem::replace(&mut items, Default::default()).iter() {
  31                         if item.ident.name.as_str() == *segment {
  32                             if path_it.peek().is_none() {
  33                                 return Some(ty::Instance::mono(this.tcx.tcx, item.res.def_id()));
  34                             }
  35
  36                             items = this.tcx.item_children(item.res.def_id());
  37                             break;
  38                         }
  39                     }
  40                 }
  41                 None
  42             })
  43             .ok_or_else(|| {
  44                 let path = path.iter().map(|&s| s.to_owned()).collect();
  45                 InterpError::PathNotFound(path).into()
  46             })
  47     }
  48
  49     /// Write a 0 of the appropriate size to `dest`.
  50     fn write_null(&mut self, dest: PlaceTy<'tcx, Tag>) -> InterpResult<'tcx> {
  51         self.eval_context_mut().write_scalar(Scalar::from_int(0, dest.layout.size), dest)
  52     }
  53
  54     /// Test if this immediate equals 0.
  55     fn is_null(&self, val: Scalar<Tag>) -> InterpResult<'tcx, bool> {
  56         let this = self.eval_context_ref();
  57         let null = Scalar::from_int(0, this.memory().pointer_size());
  58         this.ptr_eq(val, null)
  59     }
  60
  61     /// Turn a Scalar into an Option<NonNullScalar>
  62     fn test_null(&self, val: Scalar<Tag>) -> InterpResult<'tcx, Option<Scalar<Tag>>> {
  63         let this = self.eval_context_ref();
  64         Ok(if this.is_null(val)? {
  65             None
  66         } else {
  67             Some(val)
  68         })
  69     }
  70
  71     /// Get the `Place` for a local
  72     fn local_place(&mut self, local: mir::Local) -> InterpResult<'tcx, PlaceTy<'tcx, Tag>> {
  73         let this = self.eval_context_mut();
  74         let place = mir::Place { base: mir::PlaceBase::Local(local), projection: None };
  75         this.eval_place(&place)
  76     }
  77
  78     /// Generate some random bytes, and write them to `dest`.
  79     fn gen_random(
  80         &mut self,
  81         len: usize,
  82         ptr: Scalar<Tag>,
  83     ) -> InterpResult<'tcx>  {
  84         let this = self.eval_context_mut();
  85
  86         let ptr = match this.memory().check_ptr_access(ptr, Size::from_bytes(len as u64), Align::from_bytes(1).unwrap())? {
  87             Some(ptr) => ptr,
  88             None => return Ok(()), // zero-sized access
  89         };
  90
  91         let rng = this.memory_mut().extra.rng.get_mut();
  92         let mut data = vec![0; len];
  93         rng.fill_bytes(&mut data);
  94
  95         let tcx = &{this.tcx.tcx};
  96         this.memory_mut().get_mut(ptr.alloc_id)?.write_bytes(tcx, ptr, &data)
  97     }
  98
  99     /// Visits the memory covered by `place`, sensitive to freezing: the 3rd parameter
 100     /// will be true if this is frozen, false if this is in an `UnsafeCell`.
 101     fn visit_freeze_sensitive(
 102         &self,
 103         place: MPlaceTy<'tcx, Tag>,
 104         size: Size,
 105         mut action: impl FnMut(Pointer<Tag>, Size, bool) -> InterpResult<'tcx>,
 106     ) -> InterpResult<'tcx> {
 107         let this = self.eval_context_ref();
 108         trace!("visit_frozen(place={:?}, size={:?})", *place, size);
 109         debug_assert_eq!(size,
 110             this.size_and_align_of_mplace(place)?
 111             .map(|(size, _)| size)
 112             .unwrap_or_else(|| place.layout.size)
 113         );
 114         // Store how far we proceeded into the place so far. Everything to the left of
 115         // this offset has already been handled, in the sense that the frozen parts
 116         // have had `action` called on them.
 117         let mut end_ptr = place.ptr.assert_ptr();
 118         // Called when we detected an `UnsafeCell` at the given offset and size.
 119         // Calls `action` and advances `end_ptr`.
 120         let mut unsafe_cell_action = |unsafe_cell_ptr: Scalar<Tag>, unsafe_cell_size: Size| {
 121             let unsafe_cell_ptr = unsafe_cell_ptr.assert_ptr();
 122             debug_assert_eq!(unsafe_cell_ptr.alloc_id, end_ptr.alloc_id);
 123             debug_assert_eq!(unsafe_cell_ptr.tag, end_ptr.tag);
 124             // We assume that we are given the fields in increasing offset order,
 125             // and nothing else changes.
 126             let unsafe_cell_offset = unsafe_cell_ptr.offset;
 127             let end_offset = end_ptr.offset;
 128             assert!(unsafe_cell_offset >= end_offset);
 129             let frozen_size = unsafe_cell_offset - end_offset;
 130             // Everything between the end_ptr and this `UnsafeCell` is frozen.
 131             if frozen_size != Size::ZERO {
 132                 action(end_ptr, frozen_size, /*frozen*/true)?;
 133             }
 134             // This `UnsafeCell` is NOT frozen.
 135             if unsafe_cell_size != Size::ZERO {
 136                 action(unsafe_cell_ptr, unsafe_cell_size, /*frozen*/false)?;
 137             }
 138             // Update end end_ptr.
 139             end_ptr = unsafe_cell_ptr.wrapping_offset(unsafe_cell_size, this);
 140             // Done
 141             Ok(())
 142         };
 143         // Run a visitor
 144         {
 145             let mut visitor = UnsafeCellVisitor {
 146                 ecx: this,
 147                 unsafe_cell_action: |place| {
 148                     trace!("unsafe_cell_action on {:?}", place.ptr);
 149                     // We need a size to go on.
 150                     let unsafe_cell_size = this.size_and_align_of_mplace(place)?
 151                         .map(|(size, _)| size)
 152                         // for extern types, just cover what we can
 153                         .unwrap_or_else(|| place.layout.size);
 154                     // Now handle this `UnsafeCell`, unless it is empty.
 155                     if unsafe_cell_size != Size::ZERO {
 156                         unsafe_cell_action(place.ptr, unsafe_cell_size)
 157                     } else {
 158                         Ok(())
 159                     }
 160                 },
 161             };
 162             visitor.visit_value(place)?;
 163         }
 164         // The part between the end_ptr and the end of the place is also frozen.
 165         // So pretend there is a 0-sized `UnsafeCell` at the end.
 166         unsafe_cell_action(place.ptr.ptr_wrapping_offset(size, this), Size::ZERO)?;
 167         // Done!
 168         return Ok(());
 169
 170         /// Visiting the memory covered by a `MemPlace`, being aware of
 171         /// whether we are inside an `UnsafeCell` or not.
 172         struct UnsafeCellVisitor<'ecx, 'mir, 'tcx, F>
 173             where F: FnMut(MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>
 174         {
 175             ecx: &'ecx MiriEvalContext<'mir, 'tcx>,
 176             unsafe_cell_action: F,
 177         }
 178
 179         impl<'ecx, 'mir, 'tcx, F>
 180             ValueVisitor<'mir, 'tcx, Evaluator<'tcx>>
 181         for
 182             UnsafeCellVisitor<'ecx, 'mir, 'tcx, F>
 183         where
 184             F: FnMut(MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>
 185         {
 186             type V = MPlaceTy<'tcx, Tag>;
 187
 188             #[inline(always)]
 189             fn ecx(&self) -> &MiriEvalContext<'mir, 'tcx> {
 190                 &self.ecx
 191             }
 192
 193             // Hook to detect `UnsafeCell`.
 194             fn visit_value(&mut self, v: MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>
 195             {
 196                 trace!("UnsafeCellVisitor: {:?} {:?}", *v, v.layout.ty);
 197                 let is_unsafe_cell = match v.layout.ty.sty {
 198                     ty::Adt(adt, _) => Some(adt.did) == self.ecx.tcx.lang_items().unsafe_cell_type(),
 199                     _ => false,
 200                 };
 201                 if is_unsafe_cell {
 202                     // We do not have to recurse further, this is an `UnsafeCell`.
 203                     (self.unsafe_cell_action)(v)
 204                 } else if self.ecx.type_is_freeze(v.layout.ty) {
 205                     // This is `Freeze`, there cannot be an `UnsafeCell`
 206                     Ok(())
 207                 } else {
 208                     // Proceed further
 209                     self.walk_value(v)
 210                 }
 211             }
 212
 213             // Make sure we visit aggregrates in increasing offset order.
 214             fn visit_aggregate(
 215                 &mut self,
 216                 place: MPlaceTy<'tcx, Tag>,
 217                 fields: impl Iterator<Item=InterpResult<'tcx, MPlaceTy<'tcx, Tag>>>,
 218             ) -> InterpResult<'tcx> {
 219                 match place.layout.fields {
 220                     layout::FieldPlacement::Array { .. } => {
 221                         // For the array layout, we know the iterator will yield sorted elements so
 222                         // we can avoid the allocation.
 223                         self.walk_aggregate(place, fields)
 224                     }
 225                     layout::FieldPlacement::Arbitrary { .. } => {
 226                         // Gather the subplaces and sort them before visiting.
 227                         let mut places = fields.collect::<InterpResult<'tcx, Vec<MPlaceTy<'tcx, Tag>>>>()?;
 228                         places.sort_by_key(|place| place.ptr.assert_ptr().offset);
 229                         self.walk_aggregate(place, places.into_iter().map(Ok))
 230                     }
 231                     layout::FieldPlacement::Union { .. } => {
 232                         // Uh, what?
 233                         bug!("a union is not an aggregate we should ever visit")
 234                     }
 235                 }
 236             }
 237
 238             // We have to do *something* for unions.
 239             fn visit_union(&mut self, v: MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>
 240             {
 241                 // With unions, we fall back to whatever the type says, to hopefully be consistent
 242                 // with LLVM IR.
 243                 // FIXME: are we consistent, and is this really the behavior we want?
 244                 let frozen = self.ecx.type_is_freeze(v.layout.ty);
 245                 if frozen {
 246                     Ok(())
 247                 } else {
 248                     (self.unsafe_cell_action)(v)
 249                 }
 250             }
 251
 252             // We should never get to a primitive, but always short-circuit somewhere above.
 253             fn visit_primitive(&mut self, _v: MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>
 254             {
 255                 bug!("we should always short-circuit before coming to a primitive")
 256             }
 257         }
 258     }
 259 }