1 //! Functions concerning immediate values and operands, and reading from operands.
2 //! All high-level functions to read from memory work on operands as sources.
4 use std::convert::{TryInto, TryFrom};
7 use rustc::ty::layout::{
8 self, Size, LayoutOf, TyLayout, HasDataLayout, IntegerExt, PrimitiveExt, VariantIdx,
11 use rustc::mir::interpret::{
13 ConstValue, Pointer, Scalar,
14 InterpResult, sign_extend, truncate,
18 MemPlace, MPlaceTy, PlaceTy, Place,
20 pub use rustc::mir::interpret::ScalarMaybeUndef;
22 /// A `Value` represents a single immediate self-contained Rust value.
24 /// For optimization of a few very common cases, there is also a representation for a pair of
25 /// primitive values (`ScalarPair`). It allows Miri to avoid making allocations for checked binary
26 /// operations and fat pointers. This idea was taken from rustc's codegen.
27 /// In particular, thanks to `ScalarPair`, arithmetic operations and casts can be entirely
28 /// defined on `Immediate`, and do not have to work with a `Place`.
29 #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
30 pub enum Immediate<Tag=(), Id=AllocId> {
31 Scalar(ScalarMaybeUndef<Tag, Id>),
32 ScalarPair(ScalarMaybeUndef<Tag, Id>, ScalarMaybeUndef<Tag, Id>),
35 impl<Tag> From<ScalarMaybeUndef<Tag>> for Immediate<Tag> {
37 fn from(val: ScalarMaybeUndef<Tag>) -> Self {
38 Immediate::Scalar(val)
42 impl<Tag> From<Scalar<Tag>> for Immediate<Tag> {
44 fn from(val: Scalar<Tag>) -> Self {
45 Immediate::Scalar(val.into())
49 impl<'tcx, Tag> Immediate<Tag> {
53 cx: &impl HasDataLayout
55 Immediate::ScalarPair(
57 Scalar::from_uint(len, cx.data_layout().pointer_size).into(),
61 pub fn new_dyn_trait(val: Scalar<Tag>, vtable: Pointer<Tag>) -> Self {
62 Immediate::ScalarPair(val.into(), Scalar::Ptr(vtable).into())
66 pub fn to_scalar_or_undef(self) -> ScalarMaybeUndef<Tag> {
68 Immediate::Scalar(val) => val,
69 Immediate::ScalarPair(..) => bug!("Got a fat pointer where a scalar was expected"),
74 pub fn to_scalar(self) -> InterpResult<'tcx, Scalar<Tag>> {
75 self.to_scalar_or_undef().not_undef()
79 pub fn to_scalar_pair(self) -> InterpResult<'tcx, (Scalar<Tag>, Scalar<Tag>)> {
81 Immediate::Scalar(..) => bug!("Got a thin pointer where a scalar pair was expected"),
82 Immediate::ScalarPair(a, b) => Ok((a.not_undef()?, b.not_undef()?))
86 /// Converts the immediate into a pointer (or a pointer-sized integer).
87 /// Throws away the second half of a ScalarPair!
89 pub fn to_scalar_ptr(self) -> InterpResult<'tcx, Scalar<Tag>> {
91 Immediate::Scalar(ptr) |
92 Immediate::ScalarPair(ptr, _) => ptr.not_undef(),
96 /// Converts the value into its metadata.
97 /// Throws away the first half of a ScalarPair!
99 pub fn to_meta(self) -> InterpResult<'tcx, Option<Scalar<Tag>>> {
101 Immediate::Scalar(_) => None,
102 Immediate::ScalarPair(_, meta) => Some(meta.not_undef()?),
107 // ScalarPair needs a type to interpret, so we often have an immediate and a type together
108 // as input for binary and cast operations.
109 #[derive(Copy, Clone, Debug)]
110 pub struct ImmTy<'tcx, Tag=()> {
111 pub(crate) imm: Immediate<Tag>,
112 pub layout: TyLayout<'tcx>,
115 impl<'tcx, Tag> ::std::ops::Deref for ImmTy<'tcx, Tag> {
116 type Target = Immediate<Tag>;
118 fn deref(&self) -> &Immediate<Tag> {
123 /// An `Operand` is the result of computing a `mir::Operand`. It can be immediate,
124 /// or still in memory. The latter is an optimization, to delay reading that chunk of
125 /// memory and to avoid having to store arbitrary-sized data here.
126 #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
127 pub enum Operand<Tag=(), Id=AllocId> {
128 Immediate(Immediate<Tag, Id>),
129 Indirect(MemPlace<Tag, Id>),
132 impl<Tag> Operand<Tag> {
134 pub fn assert_mem_place(self) -> MemPlace<Tag>
135 where Tag: ::std::fmt::Debug
138 Operand::Indirect(mplace) => mplace,
139 _ => bug!("assert_mem_place: expected Operand::Indirect, got {:?}", self),
145 pub fn assert_immediate(self) -> Immediate<Tag>
146 where Tag: ::std::fmt::Debug
149 Operand::Immediate(imm) => imm,
150 _ => bug!("assert_immediate: expected Operand::Immediate, got {:?}", self),
156 #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
157 pub struct OpTy<'tcx, Tag=()> {
158 op: Operand<Tag>, // Keep this private, it helps enforce invariants
159 pub layout: TyLayout<'tcx>,
162 impl<'tcx, Tag> ::std::ops::Deref for OpTy<'tcx, Tag> {
163 type Target = Operand<Tag>;
165 fn deref(&self) -> &Operand<Tag> {
170 impl<'tcx, Tag: Copy> From<MPlaceTy<'tcx, Tag>> for OpTy<'tcx, Tag> {
172 fn from(mplace: MPlaceTy<'tcx, Tag>) -> Self {
174 op: Operand::Indirect(*mplace),
175 layout: mplace.layout
180 impl<'tcx, Tag> From<ImmTy<'tcx, Tag>> for OpTy<'tcx, Tag> {
182 fn from(val: ImmTy<'tcx, Tag>) -> Self {
184 op: Operand::Immediate(val.imm),
190 impl<'tcx, Tag: Copy> ImmTy<'tcx, Tag> {
192 pub fn from_scalar(val: Scalar<Tag>, layout: TyLayout<'tcx>) -> Self {
193 ImmTy { imm: val.into(), layout }
197 pub fn from_uint(i: impl Into<u128>, layout: TyLayout<'tcx>) -> Self {
198 Self::from_scalar(Scalar::from_uint(i, layout.size), layout)
202 pub fn from_int(i: impl Into<i128>, layout: TyLayout<'tcx>) -> Self {
203 Self::from_scalar(Scalar::from_int(i, layout.size), layout)
207 pub fn to_bits(self) -> InterpResult<'tcx, u128> {
208 self.to_scalar()?.to_bits(self.layout.size)
212 // Use the existing layout if given (but sanity check in debug mode),
213 // or compute the layout.
215 pub(super) fn from_known_layout<'tcx>(
216 layout: Option<TyLayout<'tcx>>,
217 compute: impl FnOnce() -> InterpResult<'tcx, TyLayout<'tcx>>
218 ) -> InterpResult<'tcx, TyLayout<'tcx>> {
222 if cfg!(debug_assertions) {
223 let layout2 = compute()?;
224 assert_eq!(layout.details, layout2.details,
225 "Mismatch in layout of supposedly equal-layout types {:?} and {:?}",
226 layout.ty, layout2.ty);
233 impl<'mir, 'tcx, M: Machine<'mir, 'tcx>> InterpCx<'mir, 'tcx, M> {
234 /// Normalice `place.ptr` to a `Pointer` if this is a place and not a ZST.
235 /// Can be helpful to avoid lots of `force_ptr` calls later, if this place is used a lot.
239 op: OpTy<'tcx, M::PointerTag>,
240 ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
241 match op.try_as_mplace() {
242 Ok(mplace) => Ok(self.force_mplace_ptr(mplace)?.into()),
243 Err(imm) => Ok(imm.into()), // Nothing to cast/force
247 /// Try reading an immediate in memory; this is interesting particularly for `ScalarPair`.
248 /// Returns `None` if the layout does not permit loading this as a value.
249 fn try_read_immediate_from_mplace(
251 mplace: MPlaceTy<'tcx, M::PointerTag>,
252 ) -> InterpResult<'tcx, Option<ImmTy<'tcx, M::PointerTag>>> {
253 if mplace.layout.is_unsized() {
254 // Don't touch unsized
258 let ptr = match self.check_mplace_access(mplace, None)
259 .expect("places should be checked on creation")
262 None => return Ok(Some(ImmTy { // zero-sized type
263 imm: Scalar::zst().into(),
264 layout: mplace.layout,
268 match mplace.layout.abi {
269 layout::Abi::Scalar(..) => {
270 let scalar = self.memory
272 .read_scalar(self, ptr, mplace.layout.size)?;
275 layout: mplace.layout,
278 layout::Abi::ScalarPair(ref a, ref b) => {
279 // We checked `ptr_align` above, so all fields will have the alignment they need.
280 // We would anyway check against `ptr_align.restrict_for_offset(b_offset)`,
281 // which `ptr.offset(b_offset)` cannot possibly fail to satisfy.
282 let (a, b) = (&a.value, &b.value);
283 let (a_size, b_size) = (a.size(self), b.size(self));
285 let b_offset = a_size.align_to(b.align(self).abi);
286 assert!(b_offset.bytes() > 0); // we later use the offset to tell apart the fields
287 let b_ptr = ptr.offset(b_offset, self)?;
288 let a_val = self.memory
290 .read_scalar(self, a_ptr, a_size)?;
291 let b_val = self.memory
293 .read_scalar(self, b_ptr, b_size)?;
295 imm: Immediate::ScalarPair(a_val, b_val),
296 layout: mplace.layout,
303 /// Try returning an immediate for the operand.
304 /// If the layout does not permit loading this as an immediate, return where in memory
305 /// we can find the data.
306 /// Note that for a given layout, this operation will either always fail or always
307 /// succeed! Whether it succeeds depends on whether the layout can be represented
308 /// in a `Immediate`, not on which data is stored there currently.
309 pub(crate) fn try_read_immediate(
311 src: OpTy<'tcx, M::PointerTag>,
312 ) -> InterpResult<'tcx, Result<ImmTy<'tcx, M::PointerTag>, MPlaceTy<'tcx, M::PointerTag>>> {
313 Ok(match src.try_as_mplace() {
315 if let Some(val) = self.try_read_immediate_from_mplace(mplace)? {
325 /// Read an immediate from a place, asserting that that is possible with the given layout.
327 pub fn read_immediate(
329 op: OpTy<'tcx, M::PointerTag>
330 ) -> InterpResult<'tcx, ImmTy<'tcx, M::PointerTag>> {
331 if let Ok(imm) = self.try_read_immediate(op)? {
334 bug!("primitive read failed for type: {:?}", op.layout.ty);
338 /// Read vector length and element type
339 pub fn read_vector_ty(
340 &self, op: OpTy<'tcx, M::PointerTag>
341 ) -> (u64, &rustc::ty::TyS<'tcx>) {
342 if let layout::Abi::Vector { .. } = op.layout.abi {
343 (op.layout.ty.simd_size(*self.tcx) as _, op.layout.ty.simd_type(*self.tcx))
345 bug!("Type `{}` is not a SIMD vector type", op.layout.ty)
349 /// Read a scalar from a place
352 op: OpTy<'tcx, M::PointerTag>
353 ) -> InterpResult<'tcx, ScalarMaybeUndef<M::PointerTag>> {
354 Ok(self.read_immediate(op)?.to_scalar_or_undef())
357 // Turn the MPlace into a string (must already be dereferenced!)
360 mplace: MPlaceTy<'tcx, M::PointerTag>,
361 ) -> InterpResult<'tcx, &str> {
362 let len = mplace.len(self)?;
363 let bytes = self.memory.read_bytes(mplace.ptr, Size::from_bytes(len as u64))?;
364 let str = ::std::str::from_utf8(bytes).map_err(|err| {
365 err_unsup!(ValidationFailure(err.to_string()))
370 /// Projection functions
371 pub fn operand_field(
373 op: OpTy<'tcx, M::PointerTag>,
375 ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
376 let base = match op.try_as_mplace() {
379 let field = self.mplace_field(mplace, field)?;
380 return Ok(field.into());
385 let field = field.try_into().unwrap();
386 let field_layout = op.layout.field(self, field)?;
387 if field_layout.is_zst() {
388 let immediate = Scalar::zst().into();
389 return Ok(OpTy { op: Operand::Immediate(immediate), layout: field_layout });
391 let offset = op.layout.fields.offset(field);
392 let immediate = match *base {
393 // the field covers the entire type
394 _ if offset.bytes() == 0 && field_layout.size == op.layout.size => *base,
395 // extract fields from types with `ScalarPair` ABI
396 Immediate::ScalarPair(a, b) => {
397 let val = if offset.bytes() == 0 { a } else { b };
400 Immediate::Scalar(val) =>
401 bug!("field access on non aggregate {:#?}, {:#?}", val, op.layout),
403 Ok(OpTy { op: Operand::Immediate(immediate), layout: field_layout })
406 pub fn operand_downcast(
408 op: OpTy<'tcx, M::PointerTag>,
410 ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
411 // Downcasts only change the layout
412 Ok(match op.try_as_mplace() {
414 self.mplace_downcast(mplace, variant)?.into()
417 let layout = op.layout.for_variant(self, variant);
418 OpTy { layout, ..op }
423 pub fn operand_projection(
425 base: OpTy<'tcx, M::PointerTag>,
426 proj_elem: &mir::PlaceElem<'tcx>,
427 ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
428 use rustc::mir::ProjectionElem::*;
429 Ok(match *proj_elem {
430 Field(field, _) => self.operand_field(base, field.index() as u64)?,
431 Downcast(_, variant) => self.operand_downcast(base, variant)?,
432 Deref => self.deref_operand(base)?.into(),
433 Subslice { .. } | ConstantIndex { .. } | Index(_) => if base.layout.is_zst() {
435 op: Operand::Immediate(Scalar::zst().into()),
436 // the actual index doesn't matter, so we just pick a convenient one like 0
437 layout: base.layout.field(self, 0)?,
440 // The rest should only occur as mplace, we do not use Immediates for types
441 // allowing such operations. This matches place_projection forcing an allocation.
442 let mplace = base.assert_mem_place();
443 self.mplace_projection(mplace, proj_elem)?.into()
448 /// This is used by [priroda](https://github.com/oli-obk/priroda) to get an OpTy from a local
451 frame: &super::Frame<'mir, 'tcx, M::PointerTag, M::FrameExtra>,
453 layout: Option<TyLayout<'tcx>>,
454 ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
455 assert_ne!(local, mir::RETURN_PLACE);
456 let layout = self.layout_of_local(frame, local, layout)?;
457 let op = if layout.is_zst() {
458 // Do not read from ZST, they might not be initialized
459 Operand::Immediate(Scalar::zst().into())
461 frame.locals[local].access()?
463 Ok(OpTy { op, layout })
466 /// Every place can be read from, so we can turn them into an operand
470 place: PlaceTy<'tcx, M::PointerTag>
471 ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
472 let op = match *place {
473 Place::Ptr(mplace) => {
474 Operand::Indirect(mplace)
476 Place::Local { frame, local } =>
477 *self.access_local(&self.stack[frame], local, None)?
479 Ok(OpTy { op, layout: place.layout })
482 // Evaluate a place with the goal of reading from it. This lets us sometimes
483 // avoid allocations.
484 pub(super) fn eval_place_to_op(
486 place: &mir::Place<'tcx>,
487 layout: Option<TyLayout<'tcx>>,
488 ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
489 use rustc::mir::PlaceBase;
491 let base_op = match &place.base {
492 PlaceBase::Local(mir::RETURN_PLACE) =>
493 throw_unsup!(ReadFromReturnPointer),
494 PlaceBase::Local(local) => {
495 // Do not use the layout passed in as argument if the base we are looking at
496 // here is not the entire place.
497 // FIXME use place_projection.is_empty() when is available
498 let layout = if place.projection.is_empty() {
504 self.access_local(self.frame(), *local, layout)?
506 PlaceBase::Static(place_static) => {
507 self.eval_static_to_mplace(&place_static)?.into()
511 let op = place.projection.iter().try_fold(
513 |op, elem| self.operand_projection(op, elem)
516 trace!("eval_place_to_op: got {:?}", *op);
520 /// Evaluate the operand, returning a place where you can then find the data.
521 /// If you already know the layout, you can save two table lookups
522 /// by passing it in here.
525 mir_op: &mir::Operand<'tcx>,
526 layout: Option<TyLayout<'tcx>>,
527 ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
528 use rustc::mir::Operand::*;
529 let op = match *mir_op {
530 // FIXME: do some more logic on `move` to invalidate the old location
533 self.eval_place_to_op(place, layout)?,
535 Constant(ref constant) => {
536 let val = self.subst_from_frame_and_normalize_erasing_regions(constant.literal);
537 self.eval_const_to_op(val, layout)?
540 trace!("{:?}: {:?}", mir_op, *op);
544 /// Evaluate a bunch of operands at once
545 pub(super) fn eval_operands(
547 ops: &[mir::Operand<'tcx>],
548 ) -> InterpResult<'tcx, Vec<OpTy<'tcx, M::PointerTag>>> {
550 .map(|op| self.eval_operand(op, None))
554 // Used when the miri-engine runs into a constant and for extracting information from constants
555 // in patterns via the `const_eval` module
556 /// The `val` and `layout` are assumed to already be in our interpreter
557 /// "universe" (param_env).
558 crate fn eval_const_to_op(
560 val: &'tcx ty::Const<'tcx>,
561 layout: Option<TyLayout<'tcx>>,
562 ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
563 let tag_scalar = |scalar| match scalar {
564 Scalar::Ptr(ptr) => Scalar::Ptr(self.tag_static_base_pointer(ptr)),
565 Scalar::Raw { data, size } => Scalar::Raw { data, size },
567 // Early-return cases.
569 ConstValue::Param(_) =>
570 throw_inval!(TooGeneric),
571 ConstValue::Unevaluated(def_id, substs) => {
572 let instance = self.resolve(def_id, substs)?;
573 return Ok(OpTy::from(self.const_eval_raw(GlobalId {
580 // Other cases need layout.
581 let layout = from_known_layout(layout, || {
582 self.layout_of(val.ty)
584 let op = match val.val {
585 ConstValue::ByRef { alloc, offset } => {
586 let id = self.tcx.alloc_map.lock().create_memory_alloc(alloc);
587 // We rely on mutability being set correctly in that allocation to prevent writes
588 // where none should happen.
589 let ptr = self.tag_static_base_pointer(Pointer::new(id, offset));
590 Operand::Indirect(MemPlace::from_ptr(ptr, layout.align.abi))
592 ConstValue::Scalar(x) =>
593 Operand::Immediate(tag_scalar(x).into()),
594 ConstValue::Slice { data, start, end } => {
595 // We rely on mutability being set correctly in `data` to prevent writes
596 // where none should happen.
597 let ptr = Pointer::new(
598 self.tcx.alloc_map.lock().create_memory_alloc(data),
599 Size::from_bytes(start as u64), // offset: `start`
601 Operand::Immediate(Immediate::new_slice(
602 self.tag_static_base_pointer(ptr).into(),
603 (end - start) as u64, // len: `end - start`
607 ConstValue::Param(..) |
608 ConstValue::Infer(..) |
609 ConstValue::Placeholder(..) |
610 ConstValue::Unevaluated(..) =>
611 bug!("eval_const_to_op: Unexpected ConstValue {:?}", val),
613 Ok(OpTy { op, layout })
616 /// Read discriminant, return the runtime value as well as the variant index.
617 pub fn read_discriminant(
619 rval: OpTy<'tcx, M::PointerTag>,
620 ) -> InterpResult<'tcx, (u128, VariantIdx)> {
621 trace!("read_discriminant_value {:#?}", rval.layout);
623 let (discr_layout, discr_kind, discr_index) = match rval.layout.variants {
624 layout::Variants::Single { index } => {
625 let discr_val = rval.layout.ty.discriminant_for_variant(*self.tcx, index).map_or(
626 index.as_u32() as u128,
628 return Ok((discr_val, index));
630 layout::Variants::Multiple {
631 discr: ref discr_layout,
636 (discr_layout, discr_kind, discr_index),
639 // read raw discriminant value
640 let discr_op = self.operand_field(rval, discr_index as u64)?;
641 let discr_val = self.read_immediate(discr_op)?;
642 let raw_discr = discr_val.to_scalar_or_undef();
643 trace!("discr value: {:?}", raw_discr);
645 Ok(match *discr_kind {
646 layout::DiscriminantKind::Tag => {
647 let bits_discr = raw_discr
649 .and_then(|raw_discr| self.force_bits(raw_discr, discr_val.layout.size))
650 .map_err(|_| err_unsup!(InvalidDiscriminant(raw_discr.erase_tag())))?;
651 let real_discr = if discr_val.layout.ty.is_signed() {
652 // going from layout tag type to typeck discriminant type
653 // requires first sign extending with the discriminant layout
654 let sexted = sign_extend(bits_discr, discr_val.layout.size) as i128;
655 // and then zeroing with the typeck discriminant type
656 let discr_ty = rval.layout.ty
657 .ty_adt_def().expect("tagged layout corresponds to adt")
660 let size = layout::Integer::from_attr(self, discr_ty).size();
661 let truncatee = sexted as u128;
662 truncate(truncatee, size)
666 // Make sure we catch invalid discriminants
667 let index = match &rval.layout.ty.sty {
668 ty::Adt(adt, _) => adt
669 .discriminants(self.tcx.tcx)
670 .find(|(_, var)| var.val == real_discr),
671 ty::Generator(def_id, substs, _) => substs
672 .discriminants(*def_id, self.tcx.tcx)
673 .find(|(_, var)| var.val == real_discr),
674 _ => bug!("tagged layout for non-adt non-generator"),
676 || err_unsup!(InvalidDiscriminant(raw_discr.erase_tag()))
678 (real_discr, index.0)
680 layout::DiscriminantKind::Niche {
685 let variants_start = niche_variants.start().as_u32();
686 let variants_end = niche_variants.end().as_u32();
687 let raw_discr = raw_discr.not_undef().map_err(|_| {
688 err_unsup!(InvalidDiscriminant(ScalarMaybeUndef::Undef))
690 match raw_discr.to_bits_or_ptr(discr_val.layout.size, self) {
692 // The niche must be just 0 (which an inbounds pointer value never is)
693 let ptr_valid = niche_start == 0 && variants_start == variants_end &&
694 !self.memory.ptr_may_be_null(ptr);
696 throw_unsup!(InvalidDiscriminant(raw_discr.erase_tag().into()))
698 (dataful_variant.as_u32() as u128, dataful_variant)
701 // We need to use machine arithmetic to get the relative variant idx:
702 // variant_index_relative = discr_val - niche_start_val
703 let discr_layout = self.layout_of(discr_layout.value.to_int_ty(*self.tcx))?;
704 let discr_val = ImmTy::from_uint(raw_discr, discr_layout);
705 let niche_start_val = ImmTy::from_uint(niche_start, discr_layout);
706 let variant_index_relative_val = self.binary_op(
711 let variant_index_relative = variant_index_relative_val
713 .assert_bits(discr_val.layout.size);
714 // Check if this is in the range that indicates an actual discriminant.
715 if variant_index_relative <= u128::from(variants_end - variants_start) {
716 let variant_index_relative = u32::try_from(variant_index_relative)
717 .expect("we checked that this fits into a u32");
718 // Then computing the absolute variant idx should not overflow any more.
719 let variant_index = variants_start
720 .checked_add(variant_index_relative)
721 .expect("oveflow computing absolute variant idx");
722 assert!((variant_index as usize) < rval.layout.ty
724 .expect("tagged layout for non adt")
726 (u128::from(variant_index), VariantIdx::from_u32(variant_index))
728 (u128::from(dataful_variant.as_u32()), dataful_variant)