1 // Copyright 2018 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! This module contains the `EvalContext` methods for executing a single step of the interpreter.
13 //! The main entry point is the `step` method.
16 use rustc::ty::layout::LayoutOf;
17 use rustc::mir::interpret::{EvalResult, Scalar, PointerArithmetic};
19 use super::{EvalContext, Machine};
21 /// Classify whether an operator is "left-homogeneous", i.e. the LHS has the
22 /// same type as the result.
24 fn binop_left_homogeneous(op: mir::BinOp) -> bool {
25 use rustc::mir::BinOp::*;
27 Add | Sub | Mul | Div | Rem | BitXor | BitAnd | BitOr |
30 Eq | Ne | Lt | Le | Gt | Ge =>
34 /// Classify whether an operator is "right-homogeneous", i.e. the RHS has the
35 /// same type as the LHS.
37 fn binop_right_homogeneous(op: mir::BinOp) -> bool {
38 use rustc::mir::BinOp::*;
40 Add | Sub | Mul | Div | Rem | BitXor | BitAnd | BitOr |
41 Eq | Ne | Lt | Le | Gt | Ge =>
48 impl<'a, 'mir, 'tcx, M: Machine<'a, 'mir, 'tcx>> EvalContext<'a, 'mir, 'tcx, M> {
49 pub fn run(&mut self) -> EvalResult<'tcx> {
54 /// Returns true as long as there are more things to do.
56 /// This is used by [priroda](https://github.com/oli-obk/priroda)
57 pub fn step(&mut self) -> EvalResult<'tcx, bool> {
58 if self.stack.is_empty() {
62 let block = self.frame().block;
63 let stmt_id = self.frame().stmt;
65 let basic_block = &mir.basic_blocks()[block];
67 let old_frames = self.cur_frame();
69 if let Some(stmt) = basic_block.statements.get(stmt_id) {
70 assert_eq!(old_frames, self.cur_frame());
71 self.statement(stmt)?;
75 M::before_terminator(self)?;
77 let terminator = basic_block.terminator();
78 assert_eq!(old_frames, self.cur_frame());
79 self.terminator(terminator)?;
83 fn statement(&mut self, stmt: &mir::Statement<'tcx>) -> EvalResult<'tcx> {
86 use rustc::mir::StatementKind::*;
88 // Some statements (e.g. box) push new stack frames.
89 // We have to record the stack frame number *before* executing the statement.
90 let frame_idx = self.cur_frame();
91 self.tcx.span = stmt.source_info.span;
92 self.memory.tcx.span = stmt.source_info.span;
95 Assign(ref place, ref rvalue) => self.eval_rvalue_into_place(rvalue, place)?,
101 let dest = self.eval_place(place)?;
102 self.write_discriminant_index(variant_index, dest)?;
105 // Mark locals as alive
106 StorageLive(local) => {
107 let old_val = self.storage_live(local)?;
108 self.deallocate_local(old_val)?;
111 // Mark locals as dead
112 StorageDead(local) => {
113 let old_val = self.storage_dead(local);
114 self.deallocate_local(old_val)?;
117 // No dynamic semantics attached to `FakeRead`; MIR
118 // interpreter is solely intended for borrowck'ed code.
122 Validate(op, ref places) => {
123 for operand in places {
124 M::validation_op(self, op, operand)?;
129 AscribeUserType(..) => {}
131 // Defined to do nothing. These are added by optimization passes, to avoid changing the
132 // size of MIR constantly.
135 InlineAsm { .. } => return err!(InlineAsm),
138 self.stack[frame_idx].stmt += 1;
142 /// Evaluate an assignment statement.
144 /// There is no separate `eval_rvalue` function. Instead, the code for handling each rvalue
145 /// type writes its results directly into the memory specified by the place.
146 fn eval_rvalue_into_place(
148 rvalue: &mir::Rvalue<'tcx>,
149 place: &mir::Place<'tcx>,
150 ) -> EvalResult<'tcx> {
151 let dest = self.eval_place(place)?;
153 use rustc::mir::Rvalue::*;
155 Use(ref operand) => {
156 // Avoid recomputing the layout
157 let op = self.eval_operand(operand, Some(dest.layout))?;
158 self.copy_op(op, dest)?;
161 BinaryOp(bin_op, ref left, ref right) => {
162 let layout = if binop_left_homogeneous(bin_op) { Some(dest.layout) } else { None };
163 let left = self.read_value(self.eval_operand(left, layout)?)?;
164 let layout = if binop_right_homogeneous(bin_op) { Some(left.layout) } else { None };
165 let right = self.read_value(self.eval_operand(right, layout)?)?;
166 self.binop_ignore_overflow(
174 CheckedBinaryOp(bin_op, ref left, ref right) => {
175 // Due to the extra boolean in the result, we can never reuse the `dest.layout`.
176 let left = self.read_value(self.eval_operand(left, None)?)?;
177 let layout = if binop_right_homogeneous(bin_op) { Some(left.layout) } else { None };
178 let right = self.read_value(self.eval_operand(right, layout)?)?;
179 self.binop_with_overflow(
187 UnaryOp(un_op, ref operand) => {
188 // The operand always has the same type as the result.
189 let val = self.read_value(self.eval_operand(operand, Some(dest.layout))?)?;
190 let val = self.unary_op(un_op, val.to_scalar()?, dest.layout)?;
191 self.write_scalar(val, dest)?;
194 Aggregate(ref kind, ref operands) => {
195 let (dest, active_field_index) = match **kind {
196 mir::AggregateKind::Adt(adt_def, variant_index, _, _, active_field_index) => {
197 self.write_discriminant_index(variant_index, dest)?;
198 if adt_def.is_enum() {
199 (self.place_downcast(dest, variant_index)?, active_field_index)
201 (dest, active_field_index)
207 for (i, operand) in operands.iter().enumerate() {
208 let op = self.eval_operand(operand, None)?;
209 // Ignore zero-sized fields.
210 if !op.layout.is_zst() {
211 let field_index = active_field_index.unwrap_or(i);
212 let field_dest = self.place_field(dest, field_index as u64)?;
213 self.copy_op(op, field_dest)?;
218 Repeat(ref operand, _) => {
219 let op = self.eval_operand(operand, None)?;
220 let dest = self.force_allocation(dest)?;
221 let length = dest.len(&self)?;
225 let first = self.mplace_field(dest, 0)?;
226 self.copy_op(op, first.into())?;
230 let (dest, dest_align) = first.to_scalar_ptr_align();
231 let rest = dest.ptr_offset(first.layout.size, &self)?;
232 self.memory.copy_repeatedly(
233 dest, dest_align, rest, dest_align, first.layout.size, length - 1, true
240 // FIXME(CTFE): don't allow computing the length of arrays in const eval
241 let src = self.eval_place(place)?;
242 let mplace = self.force_allocation(src)?;
243 let len = mplace.len(&self)?;
244 let size = self.pointer_size();
246 Scalar::from_uint(len, size),
251 Ref(_, borrow_kind, ref place) => {
252 let src = self.eval_place(place)?;
253 let val = self.force_allocation(src)?;
254 let val = self.create_ref(val, Some(borrow_kind))?;
255 self.write_value(val, dest)?;
258 NullaryOp(mir::NullOp::Box, _) => {
259 M::box_alloc(self, dest)?;
262 NullaryOp(mir::NullOp::SizeOf, ty) => {
263 let ty = self.monomorphize(ty, self.substs());
264 let layout = self.layout_of(ty)?;
265 assert!(!layout.is_unsized(),
266 "SizeOf nullary MIR operator called for unsized type");
267 let size = self.pointer_size();
269 Scalar::from_uint(layout.size.bytes(), size),
274 Cast(kind, ref operand, cast_ty) => {
275 debug_assert_eq!(self.monomorphize(cast_ty, self.substs()), dest.layout.ty);
276 let src = self.eval_operand(operand, None)?;
277 self.cast(src, kind, dest)?;
280 Discriminant(ref place) => {
281 let place = self.eval_place(place)?;
282 let discr_val = self.read_discriminant(self.place_to_op(place)?)?.0;
283 let size = dest.layout.size;
284 self.write_scalar(Scalar::from_uint(discr_val, size), dest)?;
288 self.dump_place(*dest);
293 fn terminator(&mut self, terminator: &mir::Terminator<'tcx>) -> EvalResult<'tcx> {
294 debug!("{:?}", terminator.kind);
295 self.tcx.span = terminator.source_info.span;
296 self.memory.tcx.span = terminator.source_info.span;
298 let old_stack = self.cur_frame();
299 let old_bb = self.frame().block;
300 self.eval_terminator(terminator)?;
301 if !self.stack.is_empty() {
302 // This should change *something*
303 debug_assert!(self.cur_frame() != old_stack || self.frame().block != old_bb);
304 debug!("// {:?}", self.frame().block);