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                 err_unsup!(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         ptr: Scalar<Tag>,
  82         len: usize,
  83     ) -> InterpResult<'tcx>  {
  84         // Some programs pass in a null pointer and a length of 0
  85         // to their platform's random-generation function (e.g. getrandom())
  86         // on Linux. For compatibility with these programs, we don't perform
  87         // any additional checks - it's okay if the pointer is invalid,
  88         // since we wouldn't actually be writing to it.
  89         if len == 0 {
  90             return Ok(());
  91         }
  92         let this = self.eval_context_mut();
  93
  94         let ptr = this.memory().check_ptr_access(
  95             ptr,
  96             Size::from_bytes(len as u64),
  97             Align::from_bytes(1).unwrap()
  98         )?.expect("we already checked for size 0");
  99
 100         let rng = this.memory_mut().extra.rng.get_mut();
 101         let mut data = vec![0; len];
 102         rng.fill_bytes(&mut data);
 103
 104         let tcx = &{this.tcx.tcx};
 105         this.memory_mut().get_mut(ptr.alloc_id)?.write_bytes(tcx, ptr, &data)
 106     }
 107
 108     /// Visits the memory covered by `place`, sensitive to freezing: the 3rd parameter
 109     /// will be true if this is frozen, false if this is in an `UnsafeCell`.
 110     fn visit_freeze_sensitive(
 111         &self,
 112         place: MPlaceTy<'tcx, Tag>,
 113         size: Size,
 114         mut action: impl FnMut(Pointer<Tag>, Size, bool) -> InterpResult<'tcx>,
 115     ) -> InterpResult<'tcx> {
 116         let this = self.eval_context_ref();
 117         trace!("visit_frozen(place={:?}, size={:?})", *place, size);
 118         debug_assert_eq!(size,
 119             this.size_and_align_of_mplace(place)?
 120             .map(|(size, _)| size)
 121             .unwrap_or_else(|| place.layout.size)
 122         );
 123         // Store how far we proceeded into the place so far. Everything to the left of
 124         // this offset has already been handled, in the sense that the frozen parts
 125         // have had `action` called on them.
 126         let mut end_ptr = place.ptr.assert_ptr();
 127         // Called when we detected an `UnsafeCell` at the given offset and size.
 128         // Calls `action` and advances `end_ptr`.
 129         let mut unsafe_cell_action = |unsafe_cell_ptr: Scalar<Tag>, unsafe_cell_size: Size| {
 130             let unsafe_cell_ptr = unsafe_cell_ptr.assert_ptr();
 131             debug_assert_eq!(unsafe_cell_ptr.alloc_id, end_ptr.alloc_id);
 132             debug_assert_eq!(unsafe_cell_ptr.tag, end_ptr.tag);
 133             // We assume that we are given the fields in increasing offset order,
 134             // and nothing else changes.
 135             let unsafe_cell_offset = unsafe_cell_ptr.offset;
 136             let end_offset = end_ptr.offset;
 137             assert!(unsafe_cell_offset >= end_offset);
 138             let frozen_size = unsafe_cell_offset - end_offset;
 139             // Everything between the end_ptr and this `UnsafeCell` is frozen.
 140             if frozen_size != Size::ZERO {
 141                 action(end_ptr, frozen_size, /*frozen*/true)?;
 142             }
 143             // This `UnsafeCell` is NOT frozen.
 144             if unsafe_cell_size != Size::ZERO {
 145                 action(unsafe_cell_ptr, unsafe_cell_size, /*frozen*/false)?;
 146             }
 147             // Update end end_ptr.
 148             end_ptr = unsafe_cell_ptr.wrapping_offset(unsafe_cell_size, this);
 149             // Done
 150             Ok(())
 151         };
 152         // Run a visitor
 153         {
 154             let mut visitor = UnsafeCellVisitor {
 155                 ecx: this,
 156                 unsafe_cell_action: |place| {
 157                     trace!("unsafe_cell_action on {:?}", place.ptr);
 158                     // We need a size to go on.
 159                     let unsafe_cell_size = this.size_and_align_of_mplace(place)?
 160                         .map(|(size, _)| size)
 161                         // for extern types, just cover what we can
 162                         .unwrap_or_else(|| place.layout.size);
 163                     // Now handle this `UnsafeCell`, unless it is empty.
 164                     if unsafe_cell_size != Size::ZERO {
 165                         unsafe_cell_action(place.ptr, unsafe_cell_size)
 166                     } else {
 167                         Ok(())
 168                     }
 169                 },
 170             };
 171             visitor.visit_value(place)?;
 172         }
 173         // The part between the end_ptr and the end of the place is also frozen.
 174         // So pretend there is a 0-sized `UnsafeCell` at the end.
 175         unsafe_cell_action(place.ptr.ptr_wrapping_offset(size, this), Size::ZERO)?;
 176         // Done!
 177         return Ok(());
 178
 179         /// Visiting the memory covered by a `MemPlace`, being aware of
 180         /// whether we are inside an `UnsafeCell` or not.
 181         struct UnsafeCellVisitor<'ecx, 'mir, 'tcx, F>
 182             where F: FnMut(MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>
 183         {
 184             ecx: &'ecx MiriEvalContext<'mir, 'tcx>,
 185             unsafe_cell_action: F,
 186         }
 187
 188         impl<'ecx, 'mir, 'tcx, F>
 189             ValueVisitor<'mir, 'tcx, Evaluator<'tcx>>
 190         for
 191             UnsafeCellVisitor<'ecx, 'mir, 'tcx, F>
 192         where
 193             F: FnMut(MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>
 194         {
 195             type V = MPlaceTy<'tcx, Tag>;
 196
 197             #[inline(always)]
 198             fn ecx(&self) -> &MiriEvalContext<'mir, 'tcx> {
 199                 &self.ecx
 200             }
 201
 202             // Hook to detect `UnsafeCell`.
 203             fn visit_value(&mut self, v: MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>
 204             {
 205                 trace!("UnsafeCellVisitor: {:?} {:?}", *v, v.layout.ty);
 206                 let is_unsafe_cell = match v.layout.ty.sty {
 207                     ty::Adt(adt, _) => Some(adt.did) == self.ecx.tcx.lang_items().unsafe_cell_type(),
 208                     _ => false,
 209                 };
 210                 if is_unsafe_cell {
 211                     // We do not have to recurse further, this is an `UnsafeCell`.
 212                     (self.unsafe_cell_action)(v)
 213                 } else if self.ecx.type_is_freeze(v.layout.ty) {
 214                     // This is `Freeze`, there cannot be an `UnsafeCell`
 215                     Ok(())
 216                 } else {
 217                     // Proceed further
 218                     self.walk_value(v)
 219                 }
 220             }
 221
 222             // Make sure we visit aggregrates in increasing offset order.
 223             fn visit_aggregate(
 224                 &mut self,
 225                 place: MPlaceTy<'tcx, Tag>,
 226                 fields: impl Iterator<Item=InterpResult<'tcx, MPlaceTy<'tcx, Tag>>>,
 227             ) -> InterpResult<'tcx> {
 228                 match place.layout.fields {
 229                     layout::FieldPlacement::Array { .. } => {
 230                         // For the array layout, we know the iterator will yield sorted elements so
 231                         // we can avoid the allocation.
 232                         self.walk_aggregate(place, fields)
 233                     }
 234                     layout::FieldPlacement::Arbitrary { .. } => {
 235                         // Gather the subplaces and sort them before visiting.
 236                         let mut places = fields.collect::<InterpResult<'tcx, Vec<MPlaceTy<'tcx, Tag>>>>()?;
 237                         places.sort_by_key(|place| place.ptr.assert_ptr().offset);
 238                         self.walk_aggregate(place, places.into_iter().map(Ok))
 239                     }
 240                     layout::FieldPlacement::Union { .. } => {
 241                         // Uh, what?
 242                         bug!("a union is not an aggregate we should ever visit")
 243                     }
 244                 }
 245             }
 246
 247             // We have to do *something* for unions.
 248             fn visit_union(&mut self, v: MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>
 249             {
 250                 // With unions, we fall back to whatever the type says, to hopefully be consistent
 251                 // with LLVM IR.
 252                 // FIXME: are we consistent, and is this really the behavior we want?
 253                 let frozen = self.ecx.type_is_freeze(v.layout.ty);
 254                 if frozen {
 255                     Ok(())
 256                 } else {
 257                     (self.unsafe_cell_action)(v)
 258                 }
 259             }
 260
 261             // We should never get to a primitive, but always short-circuit somewhere above.
 262             fn visit_primitive(&mut self, _v: MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>
 263             {
 264                 bug!("we should always short-circuit before coming to a primitive")
 265             }
 266         }
 267     }
 268 }