src/operator.rs

   1 use rustc::ty::{Ty, layout::TyLayout};
   2 use rustc::mir;
   3
   4 use super::*;
   5
   6 pub trait EvalContextExt<'tcx> {
   7     fn ptr_op(
   8         &self,
   9         bin_op: mir::BinOp,
  10         left: Scalar<Borrow>,
  11         left_layout: TyLayout<'tcx>,
  12         right: Scalar<Borrow>,
  13         right_layout: TyLayout<'tcx>,
  14     ) -> EvalResult<'tcx, (Scalar<Borrow>, bool)>;
  15
  16     fn ptr_int_arithmetic(
  17         &self,
  18         bin_op: mir::BinOp,
  19         left: Pointer<Borrow>,
  20         right: u128,
  21         signed: bool,
  22     ) -> EvalResult<'tcx, (Scalar<Borrow>, bool)>;
  23
  24     fn ptr_eq(
  25         &self,
  26         left: Scalar<Borrow>,
  27         right: Scalar<Borrow>,
  28         size: Size,
  29     ) -> EvalResult<'tcx, bool>;
  30
  31     fn pointer_offset_inbounds(
  32         &self,
  33         ptr: Scalar<Borrow>,
  34         pointee_ty: Ty<'tcx>,
  35         offset: i64,
  36     ) -> EvalResult<'tcx, Scalar<Borrow>>;
  37 }
  38
  39 impl<'a, 'mir, 'tcx> EvalContextExt<'tcx> for super::MiriEvalContext<'a, 'mir, 'tcx> {
  40     fn ptr_op(
  41         &self,
  42         bin_op: mir::BinOp,
  43         left: Scalar<Borrow>,
  44         left_layout: TyLayout<'tcx>,
  45         right: Scalar<Borrow>,
  46         right_layout: TyLayout<'tcx>,
  47     ) -> EvalResult<'tcx, (Scalar<Borrow>, bool)> {
  48         use rustc::mir::BinOp::*;
  49
  50         trace!("ptr_op: {:?} {:?} {:?}", left, bin_op, right);
  51         debug_assert!(left.is_ptr() || right.is_ptr() || bin_op == Offset);
  52
  53         match bin_op {
  54             Offset => {
  55                 let pointee_ty = left_layout.ty
  56                     .builtin_deref(true)
  57                     .expect("Offset called on non-ptr type")
  58                     .ty;
  59                 let ptr = self.pointer_offset_inbounds(
  60                     left,
  61                     pointee_ty,
  62                     right.to_isize(self)?,
  63                 )?;
  64                 Ok((ptr, false))
  65             }
  66             // These work on anything
  67             Eq =>
  68                 Ok((Scalar::from_bool(self.ptr_eq(left, right, left_layout.size)?), false)),
  69             Ne =>
  70                 Ok((Scalar::from_bool(!self.ptr_eq(left, right, left_layout.size)?), false)),
  71             // These need both to be pointer, and fail if they are not in the same location
  72             Lt | Le | Gt | Ge | Sub if left.is_ptr() && right.is_ptr() => {
  73                 let left = left.to_ptr().expect("we checked is_ptr");
  74                 let right = right.to_ptr().expect("we checked is_ptr");
  75                 if left.alloc_id == right.alloc_id {
  76                     let res = match bin_op {
  77                         Lt => left.offset < right.offset,
  78                         Le => left.offset <= right.offset,
  79                         Gt => left.offset > right.offset,
  80                         Ge => left.offset >= right.offset,
  81                         Sub => {
  82                             // subtract the offsets
  83                             let left_offset = Scalar::from_uint(left.offset.bytes(), self.memory.pointer_size());
  84                             let right_offset = Scalar::from_uint(right.offset.bytes(), self.memory.pointer_size());
  85                             let layout = self.layout_of(self.tcx.types.usize)?;
  86                             return self.binary_op(
  87                                 Sub,
  88                                 left_offset, layout,
  89                                 right_offset, layout,
  90                             )
  91                         }
  92                         _ => bug!("We already established it has to be one of these operators."),
  93                     };
  94                     Ok((Scalar::from_bool(res), false))
  95                 } else {
  96                     // Both are pointers, but from different allocations.
  97                     err!(InvalidPointerMath)
  98                 }
  99             }
 100             // These work if the left operand is a pointer, and the right an integer
 101             Add | BitAnd | Sub | Rem if left.is_ptr() && right.is_bits() => {
 102                 // Cast to i128 is fine as we checked the kind to be ptr-sized
 103                 self.ptr_int_arithmetic(
 104                     bin_op,
 105                     left.to_ptr().expect("we checked is_ptr"),
 106                     right.to_bits(self.memory.pointer_size()).expect("we checked is_bits"),
 107                     right_layout.abi.is_signed(),
 108                 )
 109             }
 110             // Commutative operators also work if the integer is on the left
 111             Add | BitAnd if left.is_bits() && right.is_ptr() => {
 112                 // This is a commutative operation, just swap the operands
 113                 self.ptr_int_arithmetic(
 114                     bin_op,
 115                     right.to_ptr().expect("we checked is_ptr"),
 116                     left.to_bits(self.memory.pointer_size()).expect("we checked is_bits"),
 117                     left_layout.abi.is_signed(),
 118                 )
 119             }
 120             // Nothing else works
 121             _ => err!(InvalidPointerMath),
 122         }
 123     }
 124
 125     fn ptr_eq(
 126         &self,
 127         left: Scalar<Borrow>,
 128         right: Scalar<Borrow>,
 129         size: Size,
 130     ) -> EvalResult<'tcx, bool> {
 131         Ok(match (left, right) {
 132             (Scalar::Bits { .. }, Scalar::Bits { .. }) =>
 133                 left.to_bits(size)? == right.to_bits(size)?,
 134             (Scalar::Ptr(left), Scalar::Ptr(right)) => {
 135                 // Comparison illegal if one of them is out-of-bounds, *unless* they
 136                 // are in the same allocation.
 137                 if left.alloc_id == right.alloc_id {
 138                     left.offset == right.offset
 139                 } else {
 140                     // This accepts one-past-the end.  So technically there is still
 141                     // some non-determinism that we do not fully rule out when two
 142                     // allocations sit right next to each other.  The C/C++ standards are
 143                     // somewhat fuzzy about this case, so I think for now this check is
 144                     // "good enough".
 145                     self.memory.check_bounds_ptr(left, false)?;
 146                     self.memory.check_bounds_ptr(right, false)?;
 147                     // Two live in-bounds pointers, we can compare across allocations
 148                     left == right
 149                 }
 150             }
 151             // Comparing ptr and integer
 152             (Scalar::Ptr(ptr), Scalar::Bits { bits, size }) |
 153             (Scalar::Bits { bits, size }, Scalar::Ptr(ptr)) => {
 154                 assert_eq!(size as u64, self.pointer_size().bytes());
 155                 let bits = bits as u64;
 156                 let (alloc_size, alloc_align) = self.memory.get_size_and_align(ptr.alloc_id);
 157
 158                 // Case I: Comparing with NULL
 159                 if bits == 0 {
 160                     // Test if the ptr is in-bounds. Then it cannot be NULL.
 161                     if ptr.offset <= alloc_size {
 162                         return Ok(false);
 163                     }
 164                 }
 165                 // Case II: Alignment gives it away
 166                 if ptr.offset.bytes() % alloc_align.abi() == 0 {
 167                     // The offset maintains the allocation alignment, so we know `base+offset`
 168                     // is aligned by `alloc_align`.
 169                     // FIXME: We could be even more general, e.g. offset 2 into a 4-aligned
 170                     // allocation cannot equal 3.
 171                     if bits % alloc_align.abi() != 0 {
 172                         // The integer is *not* aligned. So they cannot be equal.
 173                         return Ok(false);
 174                     }
 175                 }
 176                 // Case III: The integer is too big, and the allocation goes on a bit
 177                 // without wrapping around the address space.
 178                 {
 179                     // Compute the highest address at which this allocation could live.
 180                     // Substract one more, because it must be possible to add the size
 181                     // to the base address without overflowing -- IOW, the very last address
 182                     // of the address space is never dereferencable (but it can be in-bounds, i.e.,
 183                     // one-past-the-end).
 184                     let max_base_addr =
 185                         ((1u128 << self.pointer_size().bits())
 186                          - u128::from(alloc_size.bytes())
 187                          - 1
 188                         ) as u64;
 189                     if let Some(max_addr) = max_base_addr.checked_add(ptr.offset.bytes()) {
 190                         if bits > max_addr {
 191                             // The integer is too big, this cannot possibly be equal
 192                             return Ok(false)
 193                         }
 194                     }
 195                 }
 196
 197                 // None of the supported cases.
 198                 return err!(InvalidPointerMath);
 199             }
 200         })
 201     }
 202
 203     fn ptr_int_arithmetic(
 204         &self,
 205         bin_op: mir::BinOp,
 206         left: Pointer<Borrow>,
 207         right: u128,
 208         signed: bool,
 209     ) -> EvalResult<'tcx, (Scalar<Borrow>, bool)> {
 210         use rustc::mir::BinOp::*;
 211
 212         fn map_to_primval((res, over): (Pointer<Borrow>, bool)) -> (Scalar<Borrow>, bool) {
 213             (Scalar::Ptr(res), over)
 214         }
 215
 216         Ok(match bin_op {
 217             Sub =>
 218                 // The only way this can overflow is by underflowing, so signdeness of the right operands does not matter
 219                 map_to_primval(left.overflowing_signed_offset(-(right as i128), self)),
 220             Add if signed =>
 221                 map_to_primval(left.overflowing_signed_offset(right as i128, self)),
 222             Add if !signed =>
 223                 map_to_primval(left.overflowing_offset(Size::from_bytes(right as u64), self)),
 224
 225             BitAnd if !signed => {
 226                 let ptr_base_align = self.memory.get(left.alloc_id)?.align.abi();
 227                 let base_mask = {
 228                     // FIXME: Use interpret::truncate, once that takes a Size instead of a Layout
 229                     let shift = 128 - self.memory.pointer_size().bits();
 230                     let value = !(ptr_base_align as u128 - 1);
 231                     // truncate (shift left to drop out leftover values, shift right to fill with zeroes)
 232                     (value << shift) >> shift
 233                 };
 234                 let ptr_size = self.memory.pointer_size().bytes() as u8;
 235                 trace!("Ptr BitAnd, align {}, operand {:#010x}, base_mask {:#010x}",
 236                     ptr_base_align, right, base_mask);
 237                 if right & base_mask == base_mask {
 238                     // Case 1: The base address bits are all preserved, i.e., right is all-1 there
 239                     let offset = (left.offset.bytes() as u128 & right) as u64;
 240                     (
 241                         Scalar::Ptr(Pointer::new_with_tag(
 242                             left.alloc_id,
 243                             Size::from_bytes(offset),
 244                             left.tag,
 245                         )),
 246                         false,
 247                     )
 248                 } else if right & base_mask == 0 {
 249                     // Case 2: The base address bits are all taken away, i.e., right is all-0 there
 250                     (Scalar::Bits { bits: (left.offset.bytes() as u128) & right, size: ptr_size }, false)
 251                 } else {
 252                     return err!(ReadPointerAsBytes);
 253                 }
 254             }
 255
 256             Rem if !signed => {
 257                 // Doing modulo a divisor of the alignment is allowed.
 258                 // (Intuition: Modulo a divisor leaks less information.)
 259                 let ptr_base_align = self.memory.get(left.alloc_id)?.align.abi();
 260                 let right = right as u64;
 261                 let ptr_size = self.memory.pointer_size().bytes() as u8;
 262                 if right == 1 {
 263                     // modulo 1 is always 0
 264                     (Scalar::Bits { bits: 0, size: ptr_size }, false)
 265                 } else if ptr_base_align % right == 0 {
 266                     // the base address would be cancelled out by the modulo operation, so we can
 267                     // just take the modulo of the offset
 268                     (Scalar::Bits { bits: (left.offset.bytes() % right) as u128, size: ptr_size }, false)
 269                 } else {
 270                     return err!(ReadPointerAsBytes);
 271                 }
 272             }
 273
 274             _ => {
 275                 let msg = format!("unimplemented binary op on pointer {:?}: {:?}, {:?} ({})", bin_op, left, right, if signed { "signed" } else { "unsigned" });
 276                 return err!(Unimplemented(msg));
 277             }
 278         })
 279     }
 280
 281     /// This function raises an error if the offset moves the pointer outside of its allocation.  We consider
 282     /// ZSTs their own huge allocation that doesn't overlap with anything (and nothing moves in there because the size is 0).
 283     /// We also consider the NULL pointer its own separate allocation, and all the remaining integers pointers their own
 284     /// allocation.
 285     fn pointer_offset_inbounds(
 286         &self,
 287         ptr: Scalar<Borrow>,
 288         pointee_ty: Ty<'tcx>,
 289         offset: i64,
 290     ) -> EvalResult<'tcx, Scalar<Borrow>> {
 291         // FIXME: assuming here that type size is < i64::max_value()
 292         let pointee_size = self.layout_of(pointee_ty)?.size.bytes() as i64;
 293         let offset = offset.checked_mul(pointee_size).ok_or_else(|| EvalErrorKind::Overflow(mir::BinOp::Mul))?;
 294         // Now let's see what kind of pointer this is
 295         if let Scalar::Ptr(ptr) = ptr {
 296             // Both old and new pointer must be in-bounds.
 297             // (Of the same allocation, but that part is trivial with our representation.)
 298             self.memory.check_bounds_ptr(ptr, false)?;
 299             let ptr = ptr.signed_offset(offset, self)?;
 300             self.memory.check_bounds_ptr(ptr, false)?;
 301             Ok(Scalar::Ptr(ptr))
 302         } else {
 303             // An integer pointer. They can only be offset by 0, and we pretend there
 304             // is a little zero-sized allocation here.
 305             if offset == 0 {
 306                 Ok(ptr)
 307             } else {
 308                 err!(InvalidPointerMath)
 309             }
 310         }
 311     }
 312 }