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