compiler/rustc_mir/src/interpret/step.rs

   1 //! This module contains the `InterpCx` methods for executing a single step of the interpreter.
   2 //!
   3 //! The main entry point is the `step` method.
   4
   5 use rustc_middle::mir;
   6 use rustc_middle::mir::interpret::{InterpResult, Scalar};
   7 use rustc_target::abi::LayoutOf;
   8
   9 use super::{InterpCx, Machine};
  10
  11 /// Classify whether an operator is "left-homogeneous", i.e., the LHS has the
  12 /// same type as the result.
  13 #[inline]
  14 fn binop_left_homogeneous(op: mir::BinOp) -> bool {
  15     use rustc_middle::mir::BinOp::*;
  16     match op {
  17         Add | Sub | Mul | Div | Rem | BitXor | BitAnd | BitOr | Offset | Shl | Shr => true,
  18         Eq | Ne | Lt | Le | Gt | Ge => false,
  19     }
  20 }
  21 /// Classify whether an operator is "right-homogeneous", i.e., the RHS has the
  22 /// same type as the LHS.
  23 #[inline]
  24 fn binop_right_homogeneous(op: mir::BinOp) -> bool {
  25     use rustc_middle::mir::BinOp::*;
  26     match op {
  27         Add | Sub | Mul | Div | Rem | BitXor | BitAnd | BitOr | Eq | Ne | Lt | Le | Gt | Ge => true,
  28         Offset | Shl | Shr => false,
  29     }
  30 }
  31
  32 impl<'mir, 'tcx: 'mir, M: Machine<'mir, 'tcx>> InterpCx<'mir, 'tcx, M> {
  33     pub fn run(&mut self) -> InterpResult<'tcx> {
  34         while self.step()? {}
  35         Ok(())
  36     }
  37
  38     /// Returns `true` as long as there are more things to do.
  39     ///
  40     /// This is used by [priroda](https://github.com/oli-obk/priroda)
  41     ///
  42     /// This is marked `#inline(always)` to work around adverserial codegen when `opt-level = 3`
  43     #[inline(always)]
  44     pub fn step(&mut self) -> InterpResult<'tcx, bool> {
  45         if self.stack().is_empty() {
  46             return Ok(false);
  47         }
  48
  49         let loc = match self.frame().loc {
  50             Ok(loc) => loc,
  51             Err(_) => {
  52                 // We are unwinding and this fn has no cleanup code.
  53                 // Just go on unwinding.
  54                 trace!("unwinding: skipping frame");
  55                 self.pop_stack_frame(/* unwinding */ true)?;
  56                 return Ok(true);
  57             }
  58         };
  59         let basic_block = &self.body().basic_blocks()[loc.block];
  60
  61         let old_frames = self.frame_idx();
  62
  63         if let Some(stmt) = basic_block.statements.get(loc.statement_index) {
  64             assert_eq!(old_frames, self.frame_idx());
  65             self.statement(stmt)?;
  66             return Ok(true);
  67         }
  68
  69         M::before_terminator(self)?;
  70
  71         let terminator = basic_block.terminator();
  72         assert_eq!(old_frames, self.frame_idx());
  73         self.terminator(terminator)?;
  74         Ok(true)
  75     }
  76
  77     /// Runs the interpretation logic for the given `mir::Statement` at the current frame and
  78     /// statement counter. This also moves the statement counter forward.
  79     crate fn statement(&mut self, stmt: &mir::Statement<'tcx>) -> InterpResult<'tcx> {
  80         info!("{:?}", stmt);
  81
  82         use rustc_middle::mir::StatementKind::*;
  83
  84         // Some statements (e.g., box) push new stack frames.
  85         // We have to record the stack frame number *before* executing the statement.
  86         let frame_idx = self.frame_idx();
  87
  88         match &stmt.kind {
  89             Assign(box (place, rvalue)) => self.eval_rvalue_into_place(rvalue, *place)?,
  90
  91             SetDiscriminant { place, variant_index } => {
  92                 let dest = self.eval_place(**place)?;
  93                 self.write_discriminant(*variant_index, &dest)?;
  94             }
  95
  96             // Mark locals as alive
  97             StorageLive(local) => {
  98                 self.storage_live(*local)?;
  99             }
 100
 101             // Mark locals as dead
 102             StorageDead(local) => {
 103                 self.storage_dead(*local)?;
 104             }
 105
 106             // No dynamic semantics attached to `FakeRead`; MIR
 107             // interpreter is solely intended for borrowck'ed code.
 108             FakeRead(..) => {}
 109
 110             // Stacked Borrows.
 111             Retag(kind, place) => {
 112                 let dest = self.eval_place(**place)?;
 113                 M::retag(self, *kind, &dest)?;
 114             }
 115
 116             // Call CopyNonOverlapping
 117             CopyNonOverlapping(box rustc_middle::mir::CopyNonOverlapping { src, dst, count }) => {
 118                 let src = self.eval_operand(src, None)?;
 119                 let dst = self.eval_operand(dst, None)?;
 120                 let count = self.eval_operand(count, None)?;
 121                 self.copy_intrinsic(&src, &dst, &count, /* nonoverlapping */ true)?;
 122             }
 123
 124             // Statements we do not track.
 125             AscribeUserType(..) => {}
 126
 127             // Currently, Miri discards Coverage statements. Coverage statements are only injected
 128             // via an optional compile time MIR pass and have no side effects. Since Coverage
 129             // statements don't exist at the source level, it is safe for Miri to ignore them, even
 130             // for undefined behavior (UB) checks.
 131             //
 132             // A coverage counter inside a const expression (for example, a counter injected in a
 133             // const function) is discarded when the const is evaluated at compile time. Whether
 134             // this should change, and/or how to implement a const eval counter, is a subject of the
 135             // following issue:
 136             //
 137             // FIXME(#73156): Handle source code coverage in const eval
 138             Coverage(..) => {}
 139
 140             // Defined to do nothing. These are added by optimization passes, to avoid changing the
 141             // size of MIR constantly.
 142             Nop => {}
 143
 144             LlvmInlineAsm { .. } => throw_unsup_format!("inline assembly is not supported"),
 145         }
 146
 147         self.stack_mut()[frame_idx].loc.as_mut().unwrap().statement_index += 1;
 148         Ok(())
 149     }
 150
 151     /// Evaluate an assignment statement.
 152     ///
 153     /// There is no separate `eval_rvalue` function. Instead, the code for handling each rvalue
 154     /// type writes its results directly into the memory specified by the place.
 155     pub fn eval_rvalue_into_place(
 156         &mut self,
 157         rvalue: &mir::Rvalue<'tcx>,
 158         place: mir::Place<'tcx>,
 159     ) -> InterpResult<'tcx> {
 160         let dest = self.eval_place(place)?;
 161
 162         use rustc_middle::mir::Rvalue::*;
 163         match *rvalue {
 164             ThreadLocalRef(did) => {
 165                 let id = M::thread_local_static_alloc_id(self, did)?;
 166                 let val = self.global_base_pointer(id.into())?;
 167                 self.write_scalar(val, &dest)?;
 168             }
 169
 170             Use(ref operand) => {
 171                 // Avoid recomputing the layout
 172                 let op = self.eval_operand(operand, Some(dest.layout))?;
 173                 self.copy_op(&op, &dest)?;
 174             }
 175
 176             BinaryOp(bin_op, box (ref left, ref right)) => {
 177                 let layout = binop_left_homogeneous(bin_op).then_some(dest.layout);
 178                 let left = self.read_immediate(&self.eval_operand(left, layout)?)?;
 179                 let layout = binop_right_homogeneous(bin_op).then_some(left.layout);
 180                 let right = self.read_immediate(&self.eval_operand(right, layout)?)?;
 181                 self.binop_ignore_overflow(bin_op, &left, &right, &dest)?;
 182             }
 183
 184             CheckedBinaryOp(bin_op, box (ref left, ref right)) => {
 185                 // Due to the extra boolean in the result, we can never reuse the `dest.layout`.
 186                 let left = self.read_immediate(&self.eval_operand(left, None)?)?;
 187                 let layout = binop_right_homogeneous(bin_op).then_some(left.layout);
 188                 let right = self.read_immediate(&self.eval_operand(right, layout)?)?;
 189                 self.binop_with_overflow(bin_op, &left, &right, &dest)?;
 190             }
 191
 192             UnaryOp(un_op, ref operand) => {
 193                 // The operand always has the same type as the result.
 194                 let val = self.read_immediate(&self.eval_operand(operand, Some(dest.layout))?)?;
 195                 let val = self.unary_op(un_op, &val)?;
 196                 assert_eq!(val.layout, dest.layout, "layout mismatch for result of {:?}", un_op);
 197                 self.write_immediate(*val, &dest)?;
 198             }
 199
 200             Aggregate(ref kind, ref operands) => {
 201                 let (dest, active_field_index) = match **kind {
 202                     mir::AggregateKind::Adt(adt_def, variant_index, _, _, active_field_index) => {
 203                         self.write_discriminant(variant_index, &dest)?;
 204                         if adt_def.is_enum() {
 205                             (self.place_downcast(&dest, variant_index)?, active_field_index)
 206                         } else {
 207                             (dest, active_field_index)
 208                         }
 209                     }
 210                     _ => (dest, None),
 211                 };
 212
 213                 for (i, operand) in operands.iter().enumerate() {
 214                     let op = self.eval_operand(operand, None)?;
 215                     // Ignore zero-sized fields.
 216                     if !op.layout.is_zst() {
 217                         let field_index = active_field_index.unwrap_or(i);
 218                         let field_dest = self.place_field(&dest, field_index)?;
 219                         self.copy_op(&op, &field_dest)?;
 220                     }
 221                 }
 222             }
 223
 224             Repeat(ref operand, _) => {
 225                 let src = self.eval_operand(operand, None)?;
 226                 assert!(!src.layout.is_unsized());
 227                 let dest = self.force_allocation(&dest)?;
 228                 let length = dest.len(self)?;
 229
 230                 if length == 0 {
 231                     // Nothing to copy... but let's still make sure that `dest` as a place is valid.
 232                     self.get_alloc_mut(&dest)?;
 233                 } else {
 234                     // Write the src to the first element.
 235                     let first = self.mplace_field(&dest, 0)?;
 236                     self.copy_op(&src, &first.into())?;
 237
 238                     // This is performance-sensitive code for big static/const arrays! So we
 239                     // avoid writing each operand individually and instead just make many copies
 240                     // of the first element.
 241                     let elem_size = first.layout.size;
 242                     let first_ptr = first.ptr;
 243                     let rest_ptr = first_ptr.ptr_offset(elem_size, self)?;
 244                     self.memory.copy_repeatedly(
 245                         first_ptr,
 246                         first.align,
 247                         rest_ptr,
 248                         first.align,
 249                         elem_size,
 250                         length - 1,
 251                         /*nonoverlapping:*/ true,
 252                     )?;
 253                 }
 254             }
 255
 256             Len(place) => {
 257                 // FIXME(CTFE): don't allow computing the length of arrays in const eval
 258                 let src = self.eval_place(place)?;
 259                 let mplace = self.force_allocation(&src)?;
 260                 let len = mplace.len(self)?;
 261                 self.write_scalar(Scalar::from_machine_usize(len, self), &dest)?;
 262             }
 263
 264             AddressOf(_, place) | Ref(_, _, place) => {
 265                 let src = self.eval_place(place)?;
 266                 let place = self.force_allocation(&src)?;
 267                 if place.layout.size.bytes() > 0 {
 268                     // definitely not a ZST
 269                     assert!(place.ptr.is_ptr(), "non-ZST places should be normalized to `Pointer`");
 270                 }
 271                 self.write_immediate(place.to_ref(), &dest)?;
 272             }
 273
 274             NullaryOp(mir::NullOp::Box, _) => {
 275                 M::box_alloc(self, &dest)?;
 276             }
 277
 278             NullaryOp(mir::NullOp::SizeOf, ty) => {
 279                 let ty = self.subst_from_current_frame_and_normalize_erasing_regions(ty);
 280                 let layout = self.layout_of(ty)?;
 281                 if layout.is_unsized() {
 282                     // FIXME: This should be a span_bug (#80742)
 283                     self.tcx.sess.delay_span_bug(
 284                         self.frame().current_span(),
 285                         &format!("SizeOf nullary MIR operator called for unsized type {}", ty),
 286                     );
 287                     throw_inval!(SizeOfUnsizedType(ty));
 288                 }
 289                 self.write_scalar(Scalar::from_machine_usize(layout.size.bytes(), self), &dest)?;
 290             }
 291
 292             Cast(cast_kind, ref operand, cast_ty) => {
 293                 let src = self.eval_operand(operand, None)?;
 294                 let cast_ty = self.subst_from_current_frame_and_normalize_erasing_regions(cast_ty);
 295                 self.cast(&src, cast_kind, cast_ty, &dest)?;
 296             }
 297
 298             Discriminant(place) => {
 299                 let op = self.eval_place_to_op(place, None)?;
 300                 let discr_val = self.read_discriminant(&op)?.0;
 301                 self.write_scalar(discr_val, &dest)?;
 302             }
 303         }
 304
 305         trace!("{:?}", self.dump_place(*dest));
 306
 307         Ok(())
 308     }
 309
 310     fn terminator(&mut self, terminator: &mir::Terminator<'tcx>) -> InterpResult<'tcx> {
 311         info!("{:?}", terminator.kind);
 312
 313         self.eval_terminator(terminator)?;
 314         if !self.stack().is_empty() {
 315             if let Ok(loc) = self.frame().loc {
 316                 info!("// executing {:?}", loc.block);
 317             }
 318         }
 319         Ok(())
 320     }
 321 }