]> git.lizzy.rs Git - rust.git/blob - src/librustc_mir/interpret/place.rs
Rollup merge of #70038 - DutchGhost:const-forget-tests, r=RalfJung
[rust.git] / src / librustc_mir / interpret / place.rs
1 //! Computations on places -- field projections, going from mir::Place, and writing
2 //! into a place.
3 //! All high-level functions to write to memory work on places as destinations.
4
5 use std::convert::TryFrom;
6 use std::hash::Hash;
7
8 use rustc::mir;
9 use rustc::mir::interpret::truncate;
10 use rustc::ty::layout::{
11     self, Align, HasDataLayout, LayoutOf, PrimitiveExt, Size, TyLayout, VariantIdx,
12 };
13 use rustc::ty::{self, Ty};
14 use rustc_macros::HashStable;
15
16 use super::{
17     AllocId, AllocMap, Allocation, AllocationExtra, ImmTy, Immediate, InterpCx, InterpResult,
18     LocalValue, Machine, MemoryKind, OpTy, Operand, Pointer, PointerArithmetic, RawConst, Scalar,
19     ScalarMaybeUndef,
20 };
21
22 #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, HashStable)]
23 /// Information required for the sound usage of a `MemPlace`.
24 pub enum MemPlaceMeta<Tag = (), Id = AllocId> {
25     /// The unsized payload (e.g. length for slices or vtable pointer for trait objects).
26     Meta(Scalar<Tag, Id>),
27     /// `Sized` types or unsized `extern type`
28     None,
29     /// The address of this place may not be taken. This protects the `MemPlace` from coming from
30     /// a ZST Operand with a backing allocation and being converted to an integer address. This
31     /// should be impossible, because you can't take the address of an operand, but this is a second
32     /// protection layer ensuring that we don't mess up.
33     Poison,
34 }
35
36 impl<Tag, Id> MemPlaceMeta<Tag, Id> {
37     pub fn unwrap_meta(self) -> Scalar<Tag, Id> {
38         match self {
39             Self::Meta(s) => s,
40             Self::None | Self::Poison => {
41                 bug!("expected wide pointer extra data (e.g. slice length or trait object vtable)")
42             }
43         }
44     }
45     fn has_meta(self) -> bool {
46         match self {
47             Self::Meta(_) => true,
48             Self::None | Self::Poison => false,
49         }
50     }
51 }
52
53 impl<Tag> MemPlaceMeta<Tag> {
54     pub fn erase_tag(self) -> MemPlaceMeta<()> {
55         match self {
56             Self::Meta(s) => MemPlaceMeta::Meta(s.erase_tag()),
57             Self::None => MemPlaceMeta::None,
58             Self::Poison => MemPlaceMeta::Poison,
59         }
60     }
61 }
62
63 #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, HashStable)]
64 pub struct MemPlace<Tag = (), Id = AllocId> {
65     /// A place may have an integral pointer for ZSTs, and since it might
66     /// be turned back into a reference before ever being dereferenced.
67     /// However, it may never be undef.
68     pub ptr: Scalar<Tag, Id>,
69     pub align: Align,
70     /// Metadata for unsized places. Interpretation is up to the type.
71     /// Must not be present for sized types, but can be missing for unsized types
72     /// (e.g., `extern type`).
73     pub meta: MemPlaceMeta<Tag, Id>,
74 }
75
76 #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, HashStable)]
77 pub enum Place<Tag = (), Id = AllocId> {
78     /// A place referring to a value allocated in the `Memory` system.
79     Ptr(MemPlace<Tag, Id>),
80
81     /// To support alloc-free locals, we are able to write directly to a local.
82     /// (Without that optimization, we'd just always be a `MemPlace`.)
83     Local { frame: usize, local: mir::Local },
84 }
85
86 #[derive(Copy, Clone, Debug)]
87 pub struct PlaceTy<'tcx, Tag = ()> {
88     place: Place<Tag>, // Keep this private; it helps enforce invariants.
89     pub layout: TyLayout<'tcx>,
90 }
91
92 impl<'tcx, Tag> ::std::ops::Deref for PlaceTy<'tcx, Tag> {
93     type Target = Place<Tag>;
94     #[inline(always)]
95     fn deref(&self) -> &Place<Tag> {
96         &self.place
97     }
98 }
99
100 /// A MemPlace with its layout. Constructing it is only possible in this module.
101 #[derive(Copy, Clone, Debug, Hash, Eq, PartialEq)]
102 pub struct MPlaceTy<'tcx, Tag = ()> {
103     mplace: MemPlace<Tag>,
104     pub layout: TyLayout<'tcx>,
105 }
106
107 impl<'tcx, Tag> ::std::ops::Deref for MPlaceTy<'tcx, Tag> {
108     type Target = MemPlace<Tag>;
109     #[inline(always)]
110     fn deref(&self) -> &MemPlace<Tag> {
111         &self.mplace
112     }
113 }
114
115 impl<'tcx, Tag> From<MPlaceTy<'tcx, Tag>> for PlaceTy<'tcx, Tag> {
116     #[inline(always)]
117     fn from(mplace: MPlaceTy<'tcx, Tag>) -> Self {
118         PlaceTy { place: Place::Ptr(mplace.mplace), layout: mplace.layout }
119     }
120 }
121
122 impl<Tag> MemPlace<Tag> {
123     /// Replace ptr tag, maintain vtable tag (if any)
124     #[inline]
125     pub fn replace_tag(self, new_tag: Tag) -> Self {
126         MemPlace { ptr: self.ptr.erase_tag().with_tag(new_tag), align: self.align, meta: self.meta }
127     }
128
129     #[inline]
130     pub fn erase_tag(self) -> MemPlace {
131         MemPlace { ptr: self.ptr.erase_tag(), align: self.align, meta: self.meta.erase_tag() }
132     }
133
134     #[inline(always)]
135     fn from_scalar_ptr(ptr: Scalar<Tag>, align: Align) -> Self {
136         MemPlace { ptr, align, meta: MemPlaceMeta::None }
137     }
138
139     /// Produces a Place that will error if attempted to be read from or written to
140     #[inline(always)]
141     fn null(cx: &impl HasDataLayout) -> Self {
142         Self::from_scalar_ptr(Scalar::ptr_null(cx), Align::from_bytes(1).unwrap())
143     }
144
145     #[inline(always)]
146     pub fn from_ptr(ptr: Pointer<Tag>, align: Align) -> Self {
147         Self::from_scalar_ptr(ptr.into(), align)
148     }
149
150     /// Turn a mplace into a (thin or wide) pointer, as a reference, pointing to the same space.
151     /// This is the inverse of `ref_to_mplace`.
152     #[inline(always)]
153     pub fn to_ref(self) -> Immediate<Tag> {
154         match self.meta {
155             MemPlaceMeta::None => Immediate::Scalar(self.ptr.into()),
156             MemPlaceMeta::Meta(meta) => Immediate::ScalarPair(self.ptr.into(), meta.into()),
157             MemPlaceMeta::Poison => bug!(
158                 "MPlaceTy::dangling may never be used to produce a \
159                 place that will have the address of its pointee taken"
160             ),
161         }
162     }
163
164     pub fn offset(
165         self,
166         offset: Size,
167         meta: MemPlaceMeta<Tag>,
168         cx: &impl HasDataLayout,
169     ) -> InterpResult<'tcx, Self> {
170         Ok(MemPlace {
171             ptr: self.ptr.ptr_offset(offset, cx)?,
172             align: self.align.restrict_for_offset(offset),
173             meta,
174         })
175     }
176 }
177
178 impl<'tcx, Tag> MPlaceTy<'tcx, Tag> {
179     /// Produces a MemPlace that works for ZST but nothing else
180     #[inline]
181     pub fn dangling(layout: TyLayout<'tcx>, cx: &impl HasDataLayout) -> Self {
182         let align = layout.align.abi;
183         let ptr = Scalar::from_uint(align.bytes(), cx.pointer_size());
184         // `Poison` this to make sure that the pointer value `ptr` is never observable by the program.
185         MPlaceTy { mplace: MemPlace { ptr, align, meta: MemPlaceMeta::Poison }, layout }
186     }
187
188     /// Replace ptr tag, maintain vtable tag (if any)
189     #[inline]
190     pub fn replace_tag(self, new_tag: Tag) -> Self {
191         MPlaceTy { mplace: self.mplace.replace_tag(new_tag), layout: self.layout }
192     }
193
194     #[inline]
195     pub fn offset(
196         self,
197         offset: Size,
198         meta: MemPlaceMeta<Tag>,
199         layout: TyLayout<'tcx>,
200         cx: &impl HasDataLayout,
201     ) -> InterpResult<'tcx, Self> {
202         Ok(MPlaceTy { mplace: self.mplace.offset(offset, meta, cx)?, layout })
203     }
204
205     #[inline]
206     fn from_aligned_ptr(ptr: Pointer<Tag>, layout: TyLayout<'tcx>) -> Self {
207         MPlaceTy { mplace: MemPlace::from_ptr(ptr, layout.align.abi), layout }
208     }
209
210     #[inline]
211     pub(super) fn len(self, cx: &impl HasDataLayout) -> InterpResult<'tcx, u64> {
212         if self.layout.is_unsized() {
213             // We need to consult `meta` metadata
214             match self.layout.ty.kind {
215                 ty::Slice(..) | ty::Str => {
216                     return self.mplace.meta.unwrap_meta().to_machine_usize(cx);
217                 }
218                 _ => bug!("len not supported on unsized type {:?}", self.layout.ty),
219             }
220         } else {
221             // Go through the layout.  There are lots of types that support a length,
222             // e.g., SIMD types.
223             match self.layout.fields {
224                 layout::FieldPlacement::Array { count, .. } => Ok(count),
225                 _ => bug!("len not supported on sized type {:?}", self.layout.ty),
226             }
227         }
228     }
229
230     #[inline]
231     pub(super) fn vtable(self) -> Scalar<Tag> {
232         match self.layout.ty.kind {
233             ty::Dynamic(..) => self.mplace.meta.unwrap_meta(),
234             _ => bug!("vtable not supported on type {:?}", self.layout.ty),
235         }
236     }
237 }
238
239 // These are defined here because they produce a place.
240 impl<'tcx, Tag: ::std::fmt::Debug + Copy> OpTy<'tcx, Tag> {
241     #[inline(always)]
242     /// Note: do not call `as_ref` on the resulting place. This function should only be used to
243     /// read from the resulting mplace, not to get its address back.
244     pub fn try_as_mplace(
245         self,
246         cx: &impl HasDataLayout,
247     ) -> Result<MPlaceTy<'tcx, Tag>, ImmTy<'tcx, Tag>> {
248         match *self {
249             Operand::Indirect(mplace) => Ok(MPlaceTy { mplace, layout: self.layout }),
250             Operand::Immediate(_) if self.layout.is_zst() => {
251                 Ok(MPlaceTy::dangling(self.layout, cx))
252             }
253             Operand::Immediate(imm) => Err(ImmTy { imm, layout: self.layout }),
254         }
255     }
256
257     #[inline(always)]
258     /// Note: do not call `as_ref` on the resulting place. This function should only be used to
259     /// read from the resulting mplace, not to get its address back.
260     pub fn assert_mem_place(self, cx: &impl HasDataLayout) -> MPlaceTy<'tcx, Tag> {
261         self.try_as_mplace(cx).unwrap()
262     }
263 }
264
265 impl<Tag: ::std::fmt::Debug> Place<Tag> {
266     /// Produces a Place that will error if attempted to be read from or written to
267     #[inline(always)]
268     fn null(cx: &impl HasDataLayout) -> Self {
269         Place::Ptr(MemPlace::null(cx))
270     }
271
272     #[inline]
273     pub fn assert_mem_place(self) -> MemPlace<Tag> {
274         match self {
275             Place::Ptr(mplace) => mplace,
276             _ => bug!("assert_mem_place: expected Place::Ptr, got {:?}", self),
277         }
278     }
279 }
280
281 impl<'tcx, Tag: ::std::fmt::Debug> PlaceTy<'tcx, Tag> {
282     #[inline]
283     pub fn assert_mem_place(self) -> MPlaceTy<'tcx, Tag> {
284         MPlaceTy { mplace: self.place.assert_mem_place(), layout: self.layout }
285     }
286 }
287
288 // separating the pointer tag for `impl Trait`, see https://github.com/rust-lang/rust/issues/54385
289 impl<'mir, 'tcx, Tag, M> InterpCx<'mir, 'tcx, M>
290 where
291     // FIXME: Working around https://github.com/rust-lang/rust/issues/54385
292     Tag: ::std::fmt::Debug + Copy + Eq + Hash + 'static,
293     M: Machine<'mir, 'tcx, PointerTag = Tag>,
294     // FIXME: Working around https://github.com/rust-lang/rust/issues/24159
295     M::MemoryMap: AllocMap<AllocId, (MemoryKind<M::MemoryKinds>, Allocation<Tag, M::AllocExtra>)>,
296     M::AllocExtra: AllocationExtra<Tag>,
297 {
298     /// Take a value, which represents a (thin or wide) reference, and make it a place.
299     /// Alignment is just based on the type.  This is the inverse of `MemPlace::to_ref()`.
300     ///
301     /// Only call this if you are sure the place is "valid" (aligned and inbounds), or do not
302     /// want to ever use the place for memory access!
303     /// Generally prefer `deref_operand`.
304     pub fn ref_to_mplace(
305         &self,
306         val: ImmTy<'tcx, M::PointerTag>,
307     ) -> InterpResult<'tcx, MPlaceTy<'tcx, M::PointerTag>> {
308         let pointee_type =
309             val.layout.ty.builtin_deref(true).expect("`ref_to_mplace` called on non-ptr type").ty;
310         let layout = self.layout_of(pointee_type)?;
311         let (ptr, meta) = match *val {
312             Immediate::Scalar(ptr) => (ptr.not_undef()?, MemPlaceMeta::None),
313             Immediate::ScalarPair(ptr, meta) => {
314                 (ptr.not_undef()?, MemPlaceMeta::Meta(meta.not_undef()?))
315             }
316         };
317
318         let mplace = MemPlace {
319             ptr,
320             // We could use the run-time alignment here. For now, we do not, because
321             // the point of tracking the alignment here is to make sure that the *static*
322             // alignment information emitted with the loads is correct. The run-time
323             // alignment can only be more restrictive.
324             align: layout.align.abi,
325             meta,
326         };
327         Ok(MPlaceTy { mplace, layout })
328     }
329
330     /// Take an operand, representing a pointer, and dereference it to a place -- that
331     /// will always be a MemPlace.  Lives in `place.rs` because it creates a place.
332     pub fn deref_operand(
333         &self,
334         src: OpTy<'tcx, M::PointerTag>,
335     ) -> InterpResult<'tcx, MPlaceTy<'tcx, M::PointerTag>> {
336         let val = self.read_immediate(src)?;
337         trace!("deref to {} on {:?}", val.layout.ty, *val);
338         let place = self.ref_to_mplace(val)?;
339         self.mplace_access_checked(place)
340     }
341
342     /// Check if the given place is good for memory access with the given
343     /// size, falling back to the layout's size if `None` (in the latter case,
344     /// this must be a statically sized type).
345     ///
346     /// On success, returns `None` for zero-sized accesses (where nothing else is
347     /// left to do) and a `Pointer` to use for the actual access otherwise.
348     #[inline]
349     pub(super) fn check_mplace_access(
350         &self,
351         place: MPlaceTy<'tcx, M::PointerTag>,
352         size: Option<Size>,
353     ) -> InterpResult<'tcx, Option<Pointer<M::PointerTag>>> {
354         let size = size.unwrap_or_else(|| {
355             assert!(!place.layout.is_unsized());
356             assert!(!place.meta.has_meta());
357             place.layout.size
358         });
359         self.memory.check_ptr_access(place.ptr, size, place.align)
360     }
361
362     /// Return the "access-checked" version of this `MPlace`, where for non-ZST
363     /// this is definitely a `Pointer`.
364     pub fn mplace_access_checked(
365         &self,
366         mut place: MPlaceTy<'tcx, M::PointerTag>,
367     ) -> InterpResult<'tcx, MPlaceTy<'tcx, M::PointerTag>> {
368         let (size, align) = self
369             .size_and_align_of_mplace(place)?
370             .unwrap_or((place.layout.size, place.layout.align.abi));
371         assert!(place.mplace.align <= align, "dynamic alignment less strict than static one?");
372         place.mplace.align = align; // maximally strict checking
373         // When dereferencing a pointer, it must be non-NULL, aligned, and live.
374         if let Some(ptr) = self.check_mplace_access(place, Some(size))? {
375             place.mplace.ptr = ptr.into();
376         }
377         Ok(place)
378     }
379
380     /// Force `place.ptr` to a `Pointer`.
381     /// Can be helpful to avoid lots of `force_ptr` calls later, if this place is used a lot.
382     pub(super) fn force_mplace_ptr(
383         &self,
384         mut place: MPlaceTy<'tcx, M::PointerTag>,
385     ) -> InterpResult<'tcx, MPlaceTy<'tcx, M::PointerTag>> {
386         place.mplace.ptr = self.force_ptr(place.mplace.ptr)?.into();
387         Ok(place)
388     }
389
390     /// Offset a pointer to project to a field. Unlike `place_field`, this is always
391     /// possible without allocating, so it can take `&self`. Also return the field's layout.
392     /// This supports both struct and array fields.
393     #[inline(always)]
394     pub fn mplace_field(
395         &self,
396         base: MPlaceTy<'tcx, M::PointerTag>,
397         field: u64,
398     ) -> InterpResult<'tcx, MPlaceTy<'tcx, M::PointerTag>> {
399         // Not using the layout method because we want to compute on u64
400         let offset = match base.layout.fields {
401             layout::FieldPlacement::Arbitrary { ref offsets, .. } => {
402                 offsets[usize::try_from(field).unwrap()]
403             }
404             layout::FieldPlacement::Array { stride, .. } => {
405                 let len = base.len(self)?;
406                 if field >= len {
407                     // This can only be reached in ConstProp and non-rustc-MIR.
408                     throw_ub!(BoundsCheckFailed { len, index: field });
409                 }
410                 stride * field
411             }
412             layout::FieldPlacement::Union(count) => {
413                 assert!(
414                     field < count as u64,
415                     "Tried to access field {} of union {:#?} with {} fields",
416                     field,
417                     base.layout,
418                     count
419                 );
420                 // Offset is always 0
421                 Size::from_bytes(0)
422             }
423         };
424         // the only way conversion can fail if is this is an array (otherwise we already panicked
425         // above). In that case, all fields are equal.
426         let field_layout = base.layout.field(self, usize::try_from(field).unwrap_or(0))?;
427
428         // Offset may need adjustment for unsized fields.
429         let (meta, offset) = if field_layout.is_unsized() {
430             // Re-use parent metadata to determine dynamic field layout.
431             // With custom DSTS, this *will* execute user-defined code, but the same
432             // happens at run-time so that's okay.
433             let align = match self.size_and_align_of(base.meta, field_layout)? {
434                 Some((_, align)) => align,
435                 None if offset == Size::ZERO => {
436                     // An extern type at offset 0, we fall back to its static alignment.
437                     // FIXME: Once we have made decisions for how to handle size and alignment
438                     // of `extern type`, this should be adapted.  It is just a temporary hack
439                     // to get some code to work that probably ought to work.
440                     field_layout.align.abi
441                 }
442                 None => bug!("Cannot compute offset for extern type field at non-0 offset"),
443             };
444             (base.meta, offset.align_to(align))
445         } else {
446             // base.meta could be present; we might be accessing a sized field of an unsized
447             // struct.
448             (MemPlaceMeta::None, offset)
449         };
450
451         // We do not look at `base.layout.align` nor `field_layout.align`, unlike
452         // codegen -- mostly to see if we can get away with that
453         base.offset(offset, meta, field_layout, self)
454     }
455
456     // Iterates over all fields of an array. Much more efficient than doing the
457     // same by repeatedly calling `mplace_array`.
458     pub(super) fn mplace_array_fields(
459         &self,
460         base: MPlaceTy<'tcx, Tag>,
461     ) -> InterpResult<'tcx, impl Iterator<Item = InterpResult<'tcx, MPlaceTy<'tcx, Tag>>> + 'tcx>
462     {
463         let len = base.len(self)?; // also asserts that we have a type where this makes sense
464         let stride = match base.layout.fields {
465             layout::FieldPlacement::Array { stride, .. } => stride,
466             _ => bug!("mplace_array_fields: expected an array layout"),
467         };
468         let layout = base.layout.field(self, 0)?;
469         let dl = &self.tcx.data_layout;
470         Ok((0..len).map(move |i| base.offset(i * stride, MemPlaceMeta::None, layout, dl)))
471     }
472
473     fn mplace_subslice(
474         &self,
475         base: MPlaceTy<'tcx, M::PointerTag>,
476         from: u64,
477         to: u64,
478         from_end: bool,
479     ) -> InterpResult<'tcx, MPlaceTy<'tcx, M::PointerTag>> {
480         let len = base.len(self)?; // also asserts that we have a type where this makes sense
481         let actual_to = if from_end {
482             if from + to > len {
483                 // This can only be reached in ConstProp and non-rustc-MIR.
484                 throw_ub!(BoundsCheckFailed { len: len as u64, index: from as u64 + to as u64 });
485             }
486             len - to
487         } else {
488             to
489         };
490
491         // Not using layout method because that works with usize, and does not work with slices
492         // (that have count 0 in their layout).
493         let from_offset = match base.layout.fields {
494             layout::FieldPlacement::Array { stride, .. } => stride * from,
495             _ => bug!("Unexpected layout of index access: {:#?}", base.layout),
496         };
497
498         // Compute meta and new layout
499         let inner_len = actual_to - from;
500         let (meta, ty) = match base.layout.ty.kind {
501             // It is not nice to match on the type, but that seems to be the only way to
502             // implement this.
503             ty::Array(inner, _) => (MemPlaceMeta::None, self.tcx.mk_array(inner, inner_len)),
504             ty::Slice(..) => {
505                 let len = Scalar::from_uint(inner_len, self.pointer_size());
506                 (MemPlaceMeta::Meta(len), base.layout.ty)
507             }
508             _ => bug!("cannot subslice non-array type: `{:?}`", base.layout.ty),
509         };
510         let layout = self.layout_of(ty)?;
511         base.offset(from_offset, meta, layout, self)
512     }
513
514     pub(super) fn mplace_downcast(
515         &self,
516         base: MPlaceTy<'tcx, M::PointerTag>,
517         variant: VariantIdx,
518     ) -> InterpResult<'tcx, MPlaceTy<'tcx, M::PointerTag>> {
519         // Downcasts only change the layout
520         assert!(!base.meta.has_meta());
521         Ok(MPlaceTy { layout: base.layout.for_variant(self, variant), ..base })
522     }
523
524     /// Project into an mplace
525     pub(super) fn mplace_projection(
526         &self,
527         base: MPlaceTy<'tcx, M::PointerTag>,
528         proj_elem: &mir::PlaceElem<'tcx>,
529     ) -> InterpResult<'tcx, MPlaceTy<'tcx, M::PointerTag>> {
530         use rustc::mir::ProjectionElem::*;
531         Ok(match *proj_elem {
532             Field(field, _) => self.mplace_field(base, field.index() as u64)?,
533             Downcast(_, variant) => self.mplace_downcast(base, variant)?,
534             Deref => self.deref_operand(base.into())?,
535
536             Index(local) => {
537                 let layout = self.layout_of(self.tcx.types.usize)?;
538                 let n = self.access_local(self.frame(), local, Some(layout))?;
539                 let n = self.read_scalar(n)?;
540                 let n = self.force_bits(n.not_undef()?, self.tcx.data_layout.pointer_size)?;
541                 self.mplace_field(base, u64::try_from(n).unwrap())?
542             }
543
544             ConstantIndex { offset, min_length, from_end } => {
545                 let n = base.len(self)?;
546                 if n < min_length as u64 {
547                     // This can only be reached in ConstProp and non-rustc-MIR.
548                     throw_ub!(BoundsCheckFailed { len: min_length as u64, index: n as u64 });
549                 }
550
551                 let index = if from_end {
552                     assert!(0 < offset && offset - 1 < min_length);
553                     n - u64::from(offset)
554                 } else {
555                     assert!(offset < min_length);
556                     u64::from(offset)
557                 };
558
559                 self.mplace_field(base, index)?
560             }
561
562             Subslice { from, to, from_end } => {
563                 self.mplace_subslice(base, u64::from(from), u64::from(to), from_end)?
564             }
565         })
566     }
567
568     /// Gets the place of a field inside the place, and also the field's type.
569     /// Just a convenience function, but used quite a bit.
570     /// This is the only projection that might have a side-effect: We cannot project
571     /// into the field of a local `ScalarPair`, we have to first allocate it.
572     pub fn place_field(
573         &mut self,
574         base: PlaceTy<'tcx, M::PointerTag>,
575         field: u64,
576     ) -> InterpResult<'tcx, PlaceTy<'tcx, M::PointerTag>> {
577         // FIXME: We could try to be smarter and avoid allocation for fields that span the
578         // entire place.
579         let mplace = self.force_allocation(base)?;
580         Ok(self.mplace_field(mplace, field)?.into())
581     }
582
583     pub fn place_downcast(
584         &self,
585         base: PlaceTy<'tcx, M::PointerTag>,
586         variant: VariantIdx,
587     ) -> InterpResult<'tcx, PlaceTy<'tcx, M::PointerTag>> {
588         // Downcast just changes the layout
589         Ok(match base.place {
590             Place::Ptr(mplace) => {
591                 self.mplace_downcast(MPlaceTy { mplace, layout: base.layout }, variant)?.into()
592             }
593             Place::Local { .. } => {
594                 let layout = base.layout.for_variant(self, variant);
595                 PlaceTy { layout, ..base }
596             }
597         })
598     }
599
600     /// Projects into a place.
601     pub fn place_projection(
602         &mut self,
603         base: PlaceTy<'tcx, M::PointerTag>,
604         proj_elem: &mir::ProjectionElem<mir::Local, Ty<'tcx>>,
605     ) -> InterpResult<'tcx, PlaceTy<'tcx, M::PointerTag>> {
606         use rustc::mir::ProjectionElem::*;
607         Ok(match *proj_elem {
608             Field(field, _) => self.place_field(base, field.index() as u64)?,
609             Downcast(_, variant) => self.place_downcast(base, variant)?,
610             Deref => self.deref_operand(self.place_to_op(base)?)?.into(),
611             // For the other variants, we have to force an allocation.
612             // This matches `operand_projection`.
613             Subslice { .. } | ConstantIndex { .. } | Index(_) => {
614                 let mplace = self.force_allocation(base)?;
615                 self.mplace_projection(mplace, proj_elem)?.into()
616             }
617         })
618     }
619
620     /// Computes a place. You should only use this if you intend to write into this
621     /// place; for reading, a more efficient alternative is `eval_place_for_read`.
622     pub fn eval_place(
623         &mut self,
624         place: &mir::Place<'tcx>,
625     ) -> InterpResult<'tcx, PlaceTy<'tcx, M::PointerTag>> {
626         let mut place_ty = match place.local {
627             mir::RETURN_PLACE => {
628                 // `return_place` has the *caller* layout, but we want to use our
629                 // `layout to verify our assumption. The caller will validate
630                 // their layout on return.
631                 PlaceTy {
632                     place: match self.frame().return_place {
633                         Some(p) => *p,
634                         // Even if we don't have a return place, we sometimes need to
635                         // create this place, but any attempt to read from / write to it
636                         // (even a ZST read/write) needs to error, so let us make this
637                         // a NULL place.
638                         //
639                         // FIXME: Ideally we'd make sure that the place projections also
640                         // bail out.
641                         None => Place::null(&*self),
642                     },
643                     layout: self.layout_of(
644                         self.subst_from_current_frame_and_normalize_erasing_regions(
645                             self.frame().body.return_ty(),
646                         ),
647                     )?,
648                 }
649             }
650             local => PlaceTy {
651                 // This works even for dead/uninitialized locals; we check further when writing
652                 place: Place::Local { frame: self.cur_frame(), local },
653                 layout: self.layout_of_local(self.frame(), local, None)?,
654             },
655         };
656
657         for elem in place.projection.iter() {
658             place_ty = self.place_projection(place_ty, elem)?
659         }
660
661         self.dump_place(place_ty.place);
662         Ok(place_ty)
663     }
664
665     /// Write a scalar to a place
666     #[inline(always)]
667     pub fn write_scalar(
668         &mut self,
669         val: impl Into<ScalarMaybeUndef<M::PointerTag>>,
670         dest: PlaceTy<'tcx, M::PointerTag>,
671     ) -> InterpResult<'tcx> {
672         self.write_immediate(Immediate::Scalar(val.into()), dest)
673     }
674
675     /// Write an immediate to a place
676     #[inline(always)]
677     pub fn write_immediate(
678         &mut self,
679         src: Immediate<M::PointerTag>,
680         dest: PlaceTy<'tcx, M::PointerTag>,
681     ) -> InterpResult<'tcx> {
682         self.write_immediate_no_validate(src, dest)?;
683
684         if M::enforce_validity(self) {
685             // Data got changed, better make sure it matches the type!
686             self.validate_operand(self.place_to_op(dest)?)?;
687         }
688
689         Ok(())
690     }
691
692     /// Write an `Immediate` to memory.
693     #[inline(always)]
694     pub fn write_immediate_to_mplace(
695         &mut self,
696         src: Immediate<M::PointerTag>,
697         dest: MPlaceTy<'tcx, M::PointerTag>,
698     ) -> InterpResult<'tcx> {
699         self.write_immediate_to_mplace_no_validate(src, dest)?;
700
701         if M::enforce_validity(self) {
702             // Data got changed, better make sure it matches the type!
703             self.validate_operand(dest.into())?;
704         }
705
706         Ok(())
707     }
708
709     /// Write an immediate to a place.
710     /// If you use this you are responsible for validating that things got copied at the
711     /// right type.
712     fn write_immediate_no_validate(
713         &mut self,
714         src: Immediate<M::PointerTag>,
715         dest: PlaceTy<'tcx, M::PointerTag>,
716     ) -> InterpResult<'tcx> {
717         if cfg!(debug_assertions) {
718             // This is a very common path, avoid some checks in release mode
719             assert!(!dest.layout.is_unsized(), "Cannot write unsized data");
720             match src {
721                 Immediate::Scalar(ScalarMaybeUndef::Scalar(Scalar::Ptr(_))) => assert_eq!(
722                     self.pointer_size(),
723                     dest.layout.size,
724                     "Size mismatch when writing pointer"
725                 ),
726                 Immediate::Scalar(ScalarMaybeUndef::Scalar(Scalar::Raw { size, .. })) => {
727                     assert_eq!(
728                         Size::from_bytes(size.into()),
729                         dest.layout.size,
730                         "Size mismatch when writing bits"
731                     )
732                 }
733                 Immediate::Scalar(ScalarMaybeUndef::Undef) => {} // undef can have any size
734                 Immediate::ScalarPair(_, _) => {
735                     // FIXME: Can we check anything here?
736                 }
737             }
738         }
739         trace!("write_immediate: {:?} <- {:?}: {}", *dest, src, dest.layout.ty);
740
741         // See if we can avoid an allocation. This is the counterpart to `try_read_immediate`,
742         // but not factored as a separate function.
743         let mplace = match dest.place {
744             Place::Local { frame, local } => {
745                 match self.stack[frame].locals[local].access_mut()? {
746                     Ok(local) => {
747                         // Local can be updated in-place.
748                         *local = LocalValue::Live(Operand::Immediate(src));
749                         return Ok(());
750                     }
751                     Err(mplace) => {
752                         // The local is in memory, go on below.
753                         mplace
754                     }
755                 }
756             }
757             Place::Ptr(mplace) => mplace, // already referring to memory
758         };
759         let dest = MPlaceTy { mplace, layout: dest.layout };
760
761         // This is already in memory, write there.
762         self.write_immediate_to_mplace_no_validate(src, dest)
763     }
764
765     /// Write an immediate to memory.
766     /// If you use this you are responsible for validating that things got copied at the
767     /// right type.
768     fn write_immediate_to_mplace_no_validate(
769         &mut self,
770         value: Immediate<M::PointerTag>,
771         dest: MPlaceTy<'tcx, M::PointerTag>,
772     ) -> InterpResult<'tcx> {
773         // Note that it is really important that the type here is the right one, and matches the
774         // type things are read at. In case `src_val` is a `ScalarPair`, we don't do any magic here
775         // to handle padding properly, which is only correct if we never look at this data with the
776         // wrong type.
777
778         // Invalid places are a thing: the return place of a diverging function
779         let ptr = match self.check_mplace_access(dest, None)? {
780             Some(ptr) => ptr,
781             None => return Ok(()), // zero-sized access
782         };
783
784         let tcx = &*self.tcx;
785         // FIXME: We should check that there are dest.layout.size many bytes available in
786         // memory.  The code below is not sufficient, with enough padding it might not
787         // cover all the bytes!
788         match value {
789             Immediate::Scalar(scalar) => {
790                 match dest.layout.abi {
791                     layout::Abi::Scalar(_) => {} // fine
792                     _ => {
793                         bug!("write_immediate_to_mplace: invalid Scalar layout: {:#?}", dest.layout)
794                     }
795                 }
796                 self.memory.get_raw_mut(ptr.alloc_id)?.write_scalar(
797                     tcx,
798                     ptr,
799                     scalar,
800                     dest.layout.size,
801                 )
802             }
803             Immediate::ScalarPair(a_val, b_val) => {
804                 // We checked `ptr_align` above, so all fields will have the alignment they need.
805                 // We would anyway check against `ptr_align.restrict_for_offset(b_offset)`,
806                 // which `ptr.offset(b_offset)` cannot possibly fail to satisfy.
807                 let (a, b) = match dest.layout.abi {
808                     layout::Abi::ScalarPair(ref a, ref b) => (&a.value, &b.value),
809                     _ => bug!(
810                         "write_immediate_to_mplace: invalid ScalarPair layout: {:#?}",
811                         dest.layout
812                     ),
813                 };
814                 let (a_size, b_size) = (a.size(self), b.size(self));
815                 let b_offset = a_size.align_to(b.align(self).abi);
816                 let b_ptr = ptr.offset(b_offset, self)?;
817
818                 // It is tempting to verify `b_offset` against `layout.fields.offset(1)`,
819                 // but that does not work: We could be a newtype around a pair, then the
820                 // fields do not match the `ScalarPair` components.
821
822                 self.memory.get_raw_mut(ptr.alloc_id)?.write_scalar(tcx, ptr, a_val, a_size)?;
823                 self.memory.get_raw_mut(b_ptr.alloc_id)?.write_scalar(tcx, b_ptr, b_val, b_size)
824             }
825         }
826     }
827
828     /// Copies the data from an operand to a place. This does not support transmuting!
829     /// Use `copy_op_transmute` if the layouts could disagree.
830     #[inline(always)]
831     pub fn copy_op(
832         &mut self,
833         src: OpTy<'tcx, M::PointerTag>,
834         dest: PlaceTy<'tcx, M::PointerTag>,
835     ) -> InterpResult<'tcx> {
836         self.copy_op_no_validate(src, dest)?;
837
838         if M::enforce_validity(self) {
839             // Data got changed, better make sure it matches the type!
840             self.validate_operand(self.place_to_op(dest)?)?;
841         }
842
843         Ok(())
844     }
845
846     /// Copies the data from an operand to a place. This does not support transmuting!
847     /// Use `copy_op_transmute` if the layouts could disagree.
848     /// Also, if you use this you are responsible for validating that things get copied at the
849     /// right type.
850     fn copy_op_no_validate(
851         &mut self,
852         src: OpTy<'tcx, M::PointerTag>,
853         dest: PlaceTy<'tcx, M::PointerTag>,
854     ) -> InterpResult<'tcx> {
855         // We do NOT compare the types for equality, because well-typed code can
856         // actually "transmute" `&mut T` to `&T` in an assignment without a cast.
857         assert!(
858             src.layout.details == dest.layout.details,
859             "Layout mismatch when copying!\nsrc: {:#?}\ndest: {:#?}",
860             src,
861             dest
862         );
863
864         // Let us see if the layout is simple so we take a shortcut, avoid force_allocation.
865         let src = match self.try_read_immediate(src)? {
866             Ok(src_val) => {
867                 assert!(!src.layout.is_unsized(), "cannot have unsized immediates");
868                 // Yay, we got a value that we can write directly.
869                 // FIXME: Add a check to make sure that if `src` is indirect,
870                 // it does not overlap with `dest`.
871                 return self.write_immediate_no_validate(*src_val, dest);
872             }
873             Err(mplace) => mplace,
874         };
875         // Slow path, this does not fit into an immediate. Just memcpy.
876         trace!("copy_op: {:?} <- {:?}: {}", *dest, src, dest.layout.ty);
877
878         // This interprets `src.meta` with the `dest` local's layout, if an unsized local
879         // is being initialized!
880         let (dest, size) = self.force_allocation_maybe_sized(dest, src.meta)?;
881         let size = size.unwrap_or_else(|| {
882             assert!(
883                 !dest.layout.is_unsized(),
884                 "Cannot copy into already initialized unsized place"
885             );
886             dest.layout.size
887         });
888         assert_eq!(src.meta, dest.meta, "Can only copy between equally-sized instances");
889
890         let src = self
891             .check_mplace_access(src, Some(size))
892             .expect("places should be checked on creation");
893         let dest = self
894             .check_mplace_access(dest, Some(size))
895             .expect("places should be checked on creation");
896         let (src_ptr, dest_ptr) = match (src, dest) {
897             (Some(src_ptr), Some(dest_ptr)) => (src_ptr, dest_ptr),
898             (None, None) => return Ok(()), // zero-sized copy
899             _ => bug!("The pointers should both be Some or both None"),
900         };
901
902         self.memory.copy(src_ptr, dest_ptr, size, /*nonoverlapping*/ true)
903     }
904
905     /// Copies the data from an operand to a place. The layouts may disagree, but they must
906     /// have the same size.
907     pub fn copy_op_transmute(
908         &mut self,
909         src: OpTy<'tcx, M::PointerTag>,
910         dest: PlaceTy<'tcx, M::PointerTag>,
911     ) -> InterpResult<'tcx> {
912         if src.layout.details == dest.layout.details {
913             // Fast path: Just use normal `copy_op`
914             return self.copy_op(src, dest);
915         }
916         // We still require the sizes to match.
917         if src.layout.size != dest.layout.size {
918             // FIXME: This should be an assert instead of an error, but if we transmute within an
919             // array length computation, `typeck` may not have yet been run and errored out. In fact
920             // most likey we *are* running `typeck` right now. Investigate whether we can bail out
921             // on `typeck_tables().has_errors` at all const eval entry points.
922             debug!("Size mismatch when transmuting!\nsrc: {:#?}\ndest: {:#?}", src, dest);
923             throw_inval!(TransmuteSizeDiff(src.layout.ty, dest.layout.ty));
924         }
925         // Unsized copies rely on interpreting `src.meta` with `dest.layout`, we want
926         // to avoid that here.
927         assert!(
928             !src.layout.is_unsized() && !dest.layout.is_unsized(),
929             "Cannot transmute unsized data"
930         );
931
932         // The hard case is `ScalarPair`.  `src` is already read from memory in this case,
933         // using `src.layout` to figure out which bytes to use for the 1st and 2nd field.
934         // We have to write them to `dest` at the offsets they were *read at*, which is
935         // not necessarily the same as the offsets in `dest.layout`!
936         // Hence we do the copy with the source layout on both sides.  We also make sure to write
937         // into memory, because if `dest` is a local we would not even have a way to write
938         // at the `src` offsets; the fact that we came from a different layout would
939         // just be lost.
940         let dest = self.force_allocation(dest)?;
941         self.copy_op_no_validate(
942             src,
943             PlaceTy::from(MPlaceTy { mplace: *dest, layout: src.layout }),
944         )?;
945
946         if M::enforce_validity(self) {
947             // Data got changed, better make sure it matches the type!
948             self.validate_operand(dest.into())?;
949         }
950
951         Ok(())
952     }
953
954     /// Ensures that a place is in memory, and returns where it is.
955     /// If the place currently refers to a local that doesn't yet have a matching allocation,
956     /// create such an allocation.
957     /// This is essentially `force_to_memplace`.
958     ///
959     /// This supports unsized types and returns the computed size to avoid some
960     /// redundant computation when copying; use `force_allocation` for a simpler, sized-only
961     /// version.
962     pub fn force_allocation_maybe_sized(
963         &mut self,
964         place: PlaceTy<'tcx, M::PointerTag>,
965         meta: MemPlaceMeta<M::PointerTag>,
966     ) -> InterpResult<'tcx, (MPlaceTy<'tcx, M::PointerTag>, Option<Size>)> {
967         let (mplace, size) = match place.place {
968             Place::Local { frame, local } => {
969                 match self.stack[frame].locals[local].access_mut()? {
970                     Ok(&mut local_val) => {
971                         // We need to make an allocation.
972
973                         // We need the layout of the local.  We can NOT use the layout we got,
974                         // that might e.g., be an inner field of a struct with `Scalar` layout,
975                         // that has different alignment than the outer field.
976                         let local_layout = self.layout_of_local(&self.stack[frame], local, None)?;
977                         // We also need to support unsized types, and hence cannot use `allocate`.
978                         let (size, align) = self
979                             .size_and_align_of(meta, local_layout)?
980                             .expect("Cannot allocate for non-dyn-sized type");
981                         let ptr = self.memory.allocate(size, align, MemoryKind::Stack);
982                         let mplace = MemPlace { ptr: ptr.into(), align, meta };
983                         if let LocalValue::Live(Operand::Immediate(value)) = local_val {
984                             // Preserve old value.
985                             // We don't have to validate as we can assume the local
986                             // was already valid for its type.
987                             let mplace = MPlaceTy { mplace, layout: local_layout };
988                             self.write_immediate_to_mplace_no_validate(value, mplace)?;
989                         }
990                         // Now we can call `access_mut` again, asserting it goes well,
991                         // and actually overwrite things.
992                         *self.stack[frame].locals[local].access_mut().unwrap().unwrap() =
993                             LocalValue::Live(Operand::Indirect(mplace));
994                         (mplace, Some(size))
995                     }
996                     Err(mplace) => (mplace, None), // this already was an indirect local
997                 }
998             }
999             Place::Ptr(mplace) => (mplace, None),
1000         };
1001         // Return with the original layout, so that the caller can go on
1002         Ok((MPlaceTy { mplace, layout: place.layout }, size))
1003     }
1004
1005     #[inline(always)]
1006     pub fn force_allocation(
1007         &mut self,
1008         place: PlaceTy<'tcx, M::PointerTag>,
1009     ) -> InterpResult<'tcx, MPlaceTy<'tcx, M::PointerTag>> {
1010         Ok(self.force_allocation_maybe_sized(place, MemPlaceMeta::None)?.0)
1011     }
1012
1013     pub fn allocate(
1014         &mut self,
1015         layout: TyLayout<'tcx>,
1016         kind: MemoryKind<M::MemoryKinds>,
1017     ) -> MPlaceTy<'tcx, M::PointerTag> {
1018         let ptr = self.memory.allocate(layout.size, layout.align.abi, kind);
1019         MPlaceTy::from_aligned_ptr(ptr, layout)
1020     }
1021
1022     /// Returns a wide MPlace.
1023     pub fn allocate_str(
1024         &mut self,
1025         str: &str,
1026         kind: MemoryKind<M::MemoryKinds>,
1027     ) -> MPlaceTy<'tcx, M::PointerTag> {
1028         let ptr = self.memory.allocate_static_bytes(str.as_bytes(), kind);
1029         let meta = Scalar::from_uint(str.len() as u128, self.pointer_size());
1030         let mplace = MemPlace {
1031             ptr: ptr.into(),
1032             align: Align::from_bytes(1).unwrap(),
1033             meta: MemPlaceMeta::Meta(meta),
1034         };
1035
1036         let layout = self.layout_of(self.tcx.mk_static_str()).unwrap();
1037         MPlaceTy { mplace, layout }
1038     }
1039
1040     pub fn write_discriminant_index(
1041         &mut self,
1042         variant_index: VariantIdx,
1043         dest: PlaceTy<'tcx, M::PointerTag>,
1044     ) -> InterpResult<'tcx> {
1045         // Layout computation excludes uninhabited variants from consideration
1046         // therefore there's no way to represent those variants in the given layout.
1047         if dest.layout.for_variant(self, variant_index).abi.is_uninhabited() {
1048             throw_ub!(Unreachable);
1049         }
1050
1051         match dest.layout.variants {
1052             layout::Variants::Single { index } => {
1053                 assert_eq!(index, variant_index);
1054             }
1055             layout::Variants::Multiple {
1056                 discr_kind: layout::DiscriminantKind::Tag,
1057                 discr: ref discr_layout,
1058                 discr_index,
1059                 ..
1060             } => {
1061                 // No need to validate that the discriminant here because the
1062                 // `TyLayout::for_variant()` call earlier already checks the variant is valid.
1063
1064                 let discr_val =
1065                     dest.layout.ty.discriminant_for_variant(*self.tcx, variant_index).unwrap().val;
1066
1067                 // raw discriminants for enums are isize or bigger during
1068                 // their computation, but the in-memory tag is the smallest possible
1069                 // representation
1070                 let size = discr_layout.value.size(self);
1071                 let discr_val = truncate(discr_val, size);
1072
1073                 let discr_dest = self.place_field(dest, discr_index as u64)?;
1074                 self.write_scalar(Scalar::from_uint(discr_val, size), discr_dest)?;
1075             }
1076             layout::Variants::Multiple {
1077                 discr_kind:
1078                     layout::DiscriminantKind::Niche { dataful_variant, ref niche_variants, niche_start },
1079                 discr: ref discr_layout,
1080                 discr_index,
1081                 ..
1082             } => {
1083                 // No need to validate that the discriminant here because the
1084                 // `TyLayout::for_variant()` call earlier already checks the variant is valid.
1085
1086                 if variant_index != dataful_variant {
1087                     let variants_start = niche_variants.start().as_u32();
1088                     let variant_index_relative = variant_index
1089                         .as_u32()
1090                         .checked_sub(variants_start)
1091                         .expect("overflow computing relative variant idx");
1092                     // We need to use machine arithmetic when taking into account `niche_start`:
1093                     // discr_val = variant_index_relative + niche_start_val
1094                     let discr_layout = self.layout_of(discr_layout.value.to_int_ty(*self.tcx))?;
1095                     let niche_start_val = ImmTy::from_uint(niche_start, discr_layout);
1096                     let variant_index_relative_val =
1097                         ImmTy::from_uint(variant_index_relative, discr_layout);
1098                     let discr_val = self.binary_op(
1099                         mir::BinOp::Add,
1100                         variant_index_relative_val,
1101                         niche_start_val,
1102                     )?;
1103                     // Write result.
1104                     let niche_dest = self.place_field(dest, discr_index as u64)?;
1105                     self.write_immediate(*discr_val, niche_dest)?;
1106                 }
1107             }
1108         }
1109
1110         Ok(())
1111     }
1112
1113     pub fn raw_const_to_mplace(
1114         &self,
1115         raw: RawConst<'tcx>,
1116     ) -> InterpResult<'tcx, MPlaceTy<'tcx, M::PointerTag>> {
1117         // This must be an allocation in `tcx`
1118         assert!(self.tcx.alloc_map.lock().get(raw.alloc_id).is_some());
1119         let ptr = self.tag_static_base_pointer(Pointer::from(raw.alloc_id));
1120         let layout = self.layout_of(raw.ty)?;
1121         Ok(MPlaceTy::from_aligned_ptr(ptr, layout))
1122     }
1123
1124     /// Turn a place with a `dyn Trait` type into a place with the actual dynamic type.
1125     /// Also return some more information so drop doesn't have to run the same code twice.
1126     pub(super) fn unpack_dyn_trait(
1127         &self,
1128         mplace: MPlaceTy<'tcx, M::PointerTag>,
1129     ) -> InterpResult<'tcx, (ty::Instance<'tcx>, MPlaceTy<'tcx, M::PointerTag>)> {
1130         let vtable = mplace.vtable(); // also sanity checks the type
1131         let (instance, ty) = self.read_drop_type_from_vtable(vtable)?;
1132         let layout = self.layout_of(ty)?;
1133
1134         // More sanity checks
1135         if cfg!(debug_assertions) {
1136             let (size, align) = self.read_size_and_align_from_vtable(vtable)?;
1137             assert_eq!(size, layout.size);
1138             // only ABI alignment is preserved
1139             assert_eq!(align, layout.align.abi);
1140         }
1141
1142         let mplace = MPlaceTy { mplace: MemPlace { meta: MemPlaceMeta::None, ..*mplace }, layout };
1143         Ok((instance, mplace))
1144     }
1145 }