]> git.lizzy.rs Git - rust.git/blob - src/librustc_mir/interpret/operand.rs
the alignment checks on access can no longer fail now
[rust.git] / src / librustc_mir / interpret / operand.rs
1 //! Functions concerning immediate values and operands, and reading from operands.
2 //! All high-level functions to read from memory work on operands as sources.
3
4 use std::convert::TryInto;
5
6 use rustc::{mir, ty};
7 use rustc::ty::layout::{
8     self, Size, LayoutOf, TyLayout, HasDataLayout, IntegerExt, VariantIdx,
9 };
10
11 use rustc::mir::interpret::{
12     GlobalId, AllocId,
13     ConstValue, Pointer, Scalar,
14     InterpResult, InterpError,
15     sign_extend, truncate,
16 };
17 use super::{
18     InterpCx, Machine,
19     MemPlace, MPlaceTy, PlaceTy, Place,
20 };
21 pub use rustc::mir::interpret::ScalarMaybeUndef;
22
23 /// A `Value` represents a single immediate self-contained Rust value.
24 ///
25 /// For optimization of a few very common cases, there is also a representation for a pair of
26 /// primitive values (`ScalarPair`). It allows Miri to avoid making allocations for checked binary
27 /// operations and fat pointers. This idea was taken from rustc's codegen.
28 /// In particular, thanks to `ScalarPair`, arithmetic operations and casts can be entirely
29 /// defined on `Immediate`, and do not have to work with a `Place`.
30 #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
31 pub enum Immediate<Tag=(), Id=AllocId> {
32     Scalar(ScalarMaybeUndef<Tag, Id>),
33     ScalarPair(ScalarMaybeUndef<Tag, Id>, ScalarMaybeUndef<Tag, Id>),
34 }
35
36 impl<'tcx, Tag> Immediate<Tag> {
37     #[inline]
38     pub fn from_scalar(val: Scalar<Tag>) -> Self {
39         Immediate::Scalar(ScalarMaybeUndef::Scalar(val))
40     }
41
42     pub fn new_slice(
43         val: Scalar<Tag>,
44         len: u64,
45         cx: &impl HasDataLayout
46     ) -> Self {
47         Immediate::ScalarPair(
48             val.into(),
49             Scalar::from_uint(len, cx.data_layout().pointer_size).into(),
50         )
51     }
52
53     pub fn new_dyn_trait(val: Scalar<Tag>, vtable: Pointer<Tag>) -> Self {
54         Immediate::ScalarPair(val.into(), Scalar::Ptr(vtable).into())
55     }
56
57     #[inline]
58     pub fn to_scalar_or_undef(self) -> ScalarMaybeUndef<Tag> {
59         match self {
60             Immediate::Scalar(val) => val,
61             Immediate::ScalarPair(..) => bug!("Got a fat pointer where a scalar was expected"),
62         }
63     }
64
65     #[inline]
66     pub fn to_scalar(self) -> InterpResult<'tcx, Scalar<Tag>> {
67         self.to_scalar_or_undef().not_undef()
68     }
69
70     #[inline]
71     pub fn to_scalar_pair(self) -> InterpResult<'tcx, (Scalar<Tag>, Scalar<Tag>)> {
72         match self {
73             Immediate::Scalar(..) => bug!("Got a thin pointer where a scalar pair was expected"),
74             Immediate::ScalarPair(a, b) => Ok((a.not_undef()?, b.not_undef()?))
75         }
76     }
77
78     /// Converts the immediate into a pointer (or a pointer-sized integer).
79     /// Throws away the second half of a ScalarPair!
80     #[inline]
81     pub fn to_scalar_ptr(self) -> InterpResult<'tcx, Scalar<Tag>> {
82         match self {
83             Immediate::Scalar(ptr) |
84             Immediate::ScalarPair(ptr, _) => ptr.not_undef(),
85         }
86     }
87
88     /// Converts the value into its metadata.
89     /// Throws away the first half of a ScalarPair!
90     #[inline]
91     pub fn to_meta(self) -> InterpResult<'tcx, Option<Scalar<Tag>>> {
92         Ok(match self {
93             Immediate::Scalar(_) => None,
94             Immediate::ScalarPair(_, meta) => Some(meta.not_undef()?),
95         })
96     }
97 }
98
99 // ScalarPair needs a type to interpret, so we often have an immediate and a type together
100 // as input for binary and cast operations.
101 #[derive(Copy, Clone, Debug)]
102 pub struct ImmTy<'tcx, Tag=()> {
103     pub imm: Immediate<Tag>,
104     pub layout: TyLayout<'tcx>,
105 }
106
107 impl<'tcx, Tag> ::std::ops::Deref for ImmTy<'tcx, Tag> {
108     type Target = Immediate<Tag>;
109     #[inline(always)]
110     fn deref(&self) -> &Immediate<Tag> {
111         &self.imm
112     }
113 }
114
115 /// An `Operand` is the result of computing a `mir::Operand`. It can be immediate,
116 /// or still in memory. The latter is an optimization, to delay reading that chunk of
117 /// memory and to avoid having to store arbitrary-sized data here.
118 #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
119 pub enum Operand<Tag=(), Id=AllocId> {
120     Immediate(Immediate<Tag, Id>),
121     Indirect(MemPlace<Tag, Id>),
122 }
123
124 impl<Tag> Operand<Tag> {
125     #[inline]
126     pub fn assert_mem_place(self) -> MemPlace<Tag>
127         where Tag: ::std::fmt::Debug
128     {
129         match self {
130             Operand::Indirect(mplace) => mplace,
131             _ => bug!("assert_mem_place: expected Operand::Indirect, got {:?}", self),
132
133         }
134     }
135
136     #[inline]
137     pub fn assert_immediate(self) -> Immediate<Tag>
138         where Tag: ::std::fmt::Debug
139     {
140         match self {
141             Operand::Immediate(imm) => imm,
142             _ => bug!("assert_immediate: expected Operand::Immediate, got {:?}", self),
143
144         }
145     }
146 }
147
148 #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
149 pub struct OpTy<'tcx, Tag=()> {
150     op: Operand<Tag>,
151     pub layout: TyLayout<'tcx>,
152 }
153
154 impl<'tcx, Tag> ::std::ops::Deref for OpTy<'tcx, Tag> {
155     type Target = Operand<Tag>;
156     #[inline(always)]
157     fn deref(&self) -> &Operand<Tag> {
158         &self.op
159     }
160 }
161
162 impl<'tcx, Tag: Copy> From<MPlaceTy<'tcx, Tag>> for OpTy<'tcx, Tag> {
163     #[inline(always)]
164     fn from(mplace: MPlaceTy<'tcx, Tag>) -> Self {
165         OpTy {
166             op: Operand::Indirect(*mplace),
167             layout: mplace.layout
168         }
169     }
170 }
171
172 impl<'tcx, Tag> From<ImmTy<'tcx, Tag>> for OpTy<'tcx, Tag> {
173     #[inline(always)]
174     fn from(val: ImmTy<'tcx, Tag>) -> Self {
175         OpTy {
176             op: Operand::Immediate(val.imm),
177             layout: val.layout
178         }
179     }
180 }
181
182 impl<'tcx, Tag: Copy> ImmTy<'tcx, Tag>
183 {
184     #[inline]
185     pub fn from_scalar(val: Scalar<Tag>, layout: TyLayout<'tcx>) -> Self {
186         ImmTy { imm: Immediate::from_scalar(val), layout }
187     }
188
189     #[inline]
190     pub fn to_bits(self) -> InterpResult<'tcx, u128> {
191         self.to_scalar()?.to_bits(self.layout.size)
192     }
193 }
194
195 // Use the existing layout if given (but sanity check in debug mode),
196 // or compute the layout.
197 #[inline(always)]
198 pub(super) fn from_known_layout<'tcx>(
199     layout: Option<TyLayout<'tcx>>,
200     compute: impl FnOnce() -> InterpResult<'tcx, TyLayout<'tcx>>
201 ) -> InterpResult<'tcx, TyLayout<'tcx>> {
202     match layout {
203         None => compute(),
204         Some(layout) => {
205             if cfg!(debug_assertions) {
206                 let layout2 = compute()?;
207                 assert_eq!(layout.details, layout2.details,
208                     "Mismatch in layout of supposedly equal-layout types {:?} and {:?}",
209                     layout.ty, layout2.ty);
210             }
211             Ok(layout)
212         }
213     }
214 }
215
216 impl<'mir, 'tcx, M: Machine<'mir, 'tcx>> InterpCx<'mir, 'tcx, M> {
217     /// Normalice `place.ptr` to a `Pointer` if this is a place and not a ZST.
218     /// Can be helpful to avoid lots of `force_ptr` calls later, if this place is used a lot.
219     #[inline]
220     pub fn force_op_ptr(
221         &self,
222         op: OpTy<'tcx, M::PointerTag>,
223     ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
224         match op.try_as_mplace() {
225             Ok(mplace) => Ok(self.force_mplace_ptr(mplace)?.into()),
226             Err(imm) => Ok(imm.into()), // Nothing to cast/force
227         }
228     }
229
230     /// Try reading an immediate in memory; this is interesting particularly for `ScalarPair`.
231     /// Returns `None` if the layout does not permit loading this as a value.
232     fn try_read_immediate_from_mplace(
233         &self,
234         mplace: MPlaceTy<'tcx, M::PointerTag>,
235     ) -> InterpResult<'tcx, Option<ImmTy<'tcx, M::PointerTag>>> {
236         if mplace.layout.is_unsized() {
237             // Don't touch unsized
238             return Ok(None);
239         }
240
241         let ptr = match self.check_mplace_access(mplace, None)
242             .expect("places should be checked on creation")
243         {
244             Some(ptr) => ptr,
245             None => return Ok(Some(ImmTy { // zero-sized type
246                 imm: Immediate::Scalar(Scalar::zst().into()),
247                 layout: mplace.layout,
248             })),
249         };
250
251         match mplace.layout.abi {
252             layout::Abi::Scalar(..) => {
253                 let scalar = self.memory
254                     .get(ptr.alloc_id)?
255                     .read_scalar(self, ptr, mplace.layout.size)?;
256                 Ok(Some(ImmTy {
257                     imm: Immediate::Scalar(scalar),
258                     layout: mplace.layout,
259                 }))
260             }
261             layout::Abi::ScalarPair(ref a, ref b) => {
262                 // We checked `ptr_align` above, so all fields will have the alignment they need.
263                 // We would anyway check against `ptr_align.restrict_for_offset(b_offset)`,
264                 // which `ptr.offset(b_offset)` cannot possibly fail to satisfy.
265                 let (a, b) = (&a.value, &b.value);
266                 let (a_size, b_size) = (a.size(self), b.size(self));
267                 let a_ptr = ptr;
268                 let b_offset = a_size.align_to(b.align(self).abi);
269                 assert!(b_offset.bytes() > 0); // we later use the offset to tell apart the fields
270                 let b_ptr = ptr.offset(b_offset, self)?;
271                 let a_val = self.memory
272                     .get(ptr.alloc_id)?
273                     .read_scalar(self, a_ptr, a_size)?;
274                 let b_val = self.memory
275                     .get(ptr.alloc_id)?
276                     .read_scalar(self, b_ptr, b_size)?;
277                 Ok(Some(ImmTy {
278                     imm: Immediate::ScalarPair(a_val, b_val),
279                     layout: mplace.layout,
280                 }))
281             }
282             _ => Ok(None),
283         }
284     }
285
286     /// Try returning an immediate for the operand.
287     /// If the layout does not permit loading this as an immediate, return where in memory
288     /// we can find the data.
289     /// Note that for a given layout, this operation will either always fail or always
290     /// succeed!  Whether it succeeds depends on whether the layout can be represented
291     /// in a `Immediate`, not on which data is stored there currently.
292     pub(crate) fn try_read_immediate(
293         &self,
294         src: OpTy<'tcx, M::PointerTag>,
295     ) -> InterpResult<'tcx, Result<ImmTy<'tcx, M::PointerTag>, MPlaceTy<'tcx, M::PointerTag>>> {
296         Ok(match src.try_as_mplace() {
297             Ok(mplace) => {
298                 if let Some(val) = self.try_read_immediate_from_mplace(mplace)? {
299                     Ok(val)
300                 } else {
301                     Err(mplace)
302                 }
303             },
304             Err(val) => Ok(val),
305         })
306     }
307
308     /// Read an immediate from a place, asserting that that is possible with the given layout.
309     #[inline(always)]
310     pub fn read_immediate(
311         &self,
312         op: OpTy<'tcx, M::PointerTag>
313     ) -> InterpResult<'tcx, ImmTy<'tcx, M::PointerTag>> {
314         if let Ok(imm) = self.try_read_immediate(op)? {
315             Ok(imm)
316         } else {
317             bug!("primitive read failed for type: {:?}", op.layout.ty);
318         }
319     }
320
321     /// Read a scalar from a place
322     pub fn read_scalar(
323         &self,
324         op: OpTy<'tcx, M::PointerTag>
325     ) -> InterpResult<'tcx, ScalarMaybeUndef<M::PointerTag>> {
326         Ok(self.read_immediate(op)?.to_scalar_or_undef())
327     }
328
329     // Turn the MPlace into a string (must already be dereferenced!)
330     pub fn read_str(
331         &self,
332         mplace: MPlaceTy<'tcx, M::PointerTag>,
333     ) -> InterpResult<'tcx, &str> {
334         let len = mplace.len(self)?;
335         let bytes = self.memory.read_bytes(mplace.ptr, Size::from_bytes(len as u64))?;
336         let str = ::std::str::from_utf8(bytes)
337             .map_err(|err| InterpError::ValidationFailure(err.to_string()))?;
338         Ok(str)
339     }
340
341     /// Projection functions
342     pub fn operand_field(
343         &self,
344         op: OpTy<'tcx, M::PointerTag>,
345         field: u64,
346     ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
347         let base = match op.try_as_mplace() {
348             Ok(mplace) => {
349                 // The easy case
350                 let field = self.mplace_field(mplace, field)?;
351                 return Ok(field.into());
352             },
353             Err(value) => value
354         };
355
356         let field = field.try_into().unwrap();
357         let field_layout = op.layout.field(self, field)?;
358         if field_layout.is_zst() {
359             let immediate = Immediate::Scalar(Scalar::zst().into());
360             return Ok(OpTy { op: Operand::Immediate(immediate), layout: field_layout });
361         }
362         let offset = op.layout.fields.offset(field);
363         let immediate = match *base {
364             // the field covers the entire type
365             _ if offset.bytes() == 0 && field_layout.size == op.layout.size => *base,
366             // extract fields from types with `ScalarPair` ABI
367             Immediate::ScalarPair(a, b) => {
368                 let val = if offset.bytes() == 0 { a } else { b };
369                 Immediate::Scalar(val)
370             },
371             Immediate::Scalar(val) =>
372                 bug!("field access on non aggregate {:#?}, {:#?}", val, op.layout),
373         };
374         Ok(OpTy { op: Operand::Immediate(immediate), layout: field_layout })
375     }
376
377     pub fn operand_downcast(
378         &self,
379         op: OpTy<'tcx, M::PointerTag>,
380         variant: VariantIdx,
381     ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
382         // Downcasts only change the layout
383         Ok(match op.try_as_mplace() {
384             Ok(mplace) => {
385                 self.mplace_downcast(mplace, variant)?.into()
386             },
387             Err(..) => {
388                 let layout = op.layout.for_variant(self, variant);
389                 OpTy { layout, ..op }
390             }
391         })
392     }
393
394     pub fn operand_projection(
395         &self,
396         base: OpTy<'tcx, M::PointerTag>,
397         proj_elem: &mir::PlaceElem<'tcx>,
398     ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
399         use rustc::mir::ProjectionElem::*;
400         Ok(match *proj_elem {
401             Field(field, _) => self.operand_field(base, field.index() as u64)?,
402             Downcast(_, variant) => self.operand_downcast(base, variant)?,
403             Deref => self.deref_operand(base)?.into(),
404             Subslice { .. } | ConstantIndex { .. } | Index(_) => if base.layout.is_zst() {
405                 OpTy {
406                     op: Operand::Immediate(Immediate::Scalar(Scalar::zst().into())),
407                     // the actual index doesn't matter, so we just pick a convenient one like 0
408                     layout: base.layout.field(self, 0)?,
409                 }
410             } else {
411                 // The rest should only occur as mplace, we do not use Immediates for types
412                 // allowing such operations.  This matches place_projection forcing an allocation.
413                 let mplace = base.assert_mem_place();
414                 self.mplace_projection(mplace, proj_elem)?.into()
415             }
416         })
417     }
418
419     /// This is used by [priroda](https://github.com/oli-obk/priroda) to get an OpTy from a local
420     pub fn access_local(
421         &self,
422         frame: &super::Frame<'mir, 'tcx, M::PointerTag, M::FrameExtra>,
423         local: mir::Local,
424         layout: Option<TyLayout<'tcx>>,
425     ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
426         assert_ne!(local, mir::RETURN_PLACE);
427         let layout = self.layout_of_local(frame, local, layout)?;
428         let op = if layout.is_zst() {
429             // Do not read from ZST, they might not be initialized
430             Operand::Immediate(Immediate::Scalar(Scalar::zst().into()))
431         } else {
432             frame.locals[local].access()?
433         };
434         Ok(OpTy { op, layout })
435     }
436
437     /// Every place can be read from, so we can turn them into an operand
438     #[inline(always)]
439     pub fn place_to_op(
440         &self,
441         place: PlaceTy<'tcx, M::PointerTag>
442     ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
443         let op = match *place {
444             Place::Ptr(mplace) => {
445                 Operand::Indirect(mplace)
446             }
447             Place::Local { frame, local } =>
448                 *self.access_local(&self.stack[frame], local, None)?
449         };
450         Ok(OpTy { op, layout: place.layout })
451     }
452
453     // Evaluate a place with the goal of reading from it.  This lets us sometimes
454     // avoid allocations.
455     pub(super) fn eval_place_to_op(
456         &self,
457         mir_place: &mir::Place<'tcx>,
458         layout: Option<TyLayout<'tcx>>,
459     ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
460         use rustc::mir::PlaceBase;
461
462         mir_place.iterate(|place_base, place_projection| {
463             let mut op = match place_base {
464                 PlaceBase::Local(mir::RETURN_PLACE) => return err!(ReadFromReturnPointer),
465                 PlaceBase::Local(local) => {
466                     // Do not use the layout passed in as argument if the base we are looking at
467                     // here is not the entire place.
468                     // FIXME use place_projection.is_empty() when is available
469                     let layout = if mir_place.projection.is_none() {
470                         layout
471                     } else {
472                         None
473                     };
474
475                     self.access_local(self.frame(), *local, layout)?
476                 }
477                 PlaceBase::Static(place_static) => {
478                     self.eval_static_to_mplace(place_static)?.into()
479                 }
480             };
481
482             for proj in place_projection {
483                 op = self.operand_projection(op, &proj.elem)?
484             }
485
486             trace!("eval_place_to_op: got {:?}", *op);
487             Ok(op)
488         })
489     }
490
491     /// Evaluate the operand, returning a place where you can then find the data.
492     /// If you already know the layout, you can save two table lookups
493     /// by passing it in here.
494     pub fn eval_operand(
495         &self,
496         mir_op: &mir::Operand<'tcx>,
497         layout: Option<TyLayout<'tcx>>,
498     ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
499         use rustc::mir::Operand::*;
500         let op = match *mir_op {
501             // FIXME: do some more logic on `move` to invalidate the old location
502             Copy(ref place) |
503             Move(ref place) =>
504                 self.eval_place_to_op(place, layout)?,
505
506             Constant(ref constant) => self.eval_const_to_op(constant.literal, layout)?,
507         };
508         trace!("{:?}: {:?}", mir_op, *op);
509         Ok(op)
510     }
511
512     /// Evaluate a bunch of operands at once
513     pub(super) fn eval_operands(
514         &self,
515         ops: &[mir::Operand<'tcx>],
516     ) -> InterpResult<'tcx, Vec<OpTy<'tcx, M::PointerTag>>> {
517         ops.into_iter()
518             .map(|op| self.eval_operand(op, None))
519             .collect()
520     }
521
522     // Used when the miri-engine runs into a constant and for extracting information from constants
523     // in patterns via the `const_eval` module
524     crate fn eval_const_to_op(
525         &self,
526         val: &'tcx ty::Const<'tcx>,
527         layout: Option<TyLayout<'tcx>>,
528     ) -> InterpResult<'tcx, OpTy<'tcx, M::PointerTag>> {
529         let tag_scalar = |scalar| match scalar {
530             Scalar::Ptr(ptr) => Scalar::Ptr(self.tag_static_base_pointer(ptr)),
531             Scalar::Raw { data, size } => Scalar::Raw { data, size },
532         };
533         // Early-return cases.
534         match val.val {
535             ConstValue::Param(_) => return err!(TooGeneric), // FIXME(oli-obk): try to monomorphize
536             ConstValue::Unevaluated(def_id, substs) => {
537                 let instance = self.resolve(def_id, substs)?;
538                 return Ok(OpTy::from(self.const_eval_raw(GlobalId {
539                     instance,
540                     promoted: None,
541                 })?));
542             }
543             _ => {}
544         }
545         // Other cases need layout.
546         let layout = from_known_layout(layout, || {
547             self.layout_of(self.monomorphize(val.ty)?)
548         })?;
549         let op = match val.val {
550             ConstValue::ByRef { offset, align, alloc } => {
551                 let id = self.tcx.alloc_map.lock().create_memory_alloc(alloc);
552                 // We rely on mutability being set correctly in that allocation to prevent writes
553                 // where none should happen.
554                 let ptr = self.tag_static_base_pointer(Pointer::new(id, offset));
555                 Operand::Indirect(MemPlace::from_ptr(ptr, align))
556             },
557             ConstValue::Scalar(x) =>
558                 Operand::Immediate(Immediate::Scalar(tag_scalar(x).into())),
559             ConstValue::Slice { data, start, end } => {
560                 // We rely on mutability being set correctly in `data` to prevent writes
561                 // where none should happen.
562                 let ptr = Pointer::new(
563                     self.tcx.alloc_map.lock().create_memory_alloc(data),
564                     Size::from_bytes(start as u64), // offset: `start`
565                 );
566                 Operand::Immediate(Immediate::new_slice(
567                     self.tag_static_base_pointer(ptr).into(),
568                     (end - start) as u64, // len: `end - start`
569                     self,
570                 ))
571             }
572             ConstValue::Param(..) |
573             ConstValue::Infer(..) |
574             ConstValue::Placeholder(..) |
575             ConstValue::Unevaluated(..) =>
576                 bug!("eval_const_to_op: Unexpected ConstValue {:?}", val),
577         };
578         Ok(OpTy { op, layout })
579     }
580
581     /// Read discriminant, return the runtime value as well as the variant index.
582     pub fn read_discriminant(
583         &self,
584         rval: OpTy<'tcx, M::PointerTag>,
585     ) -> InterpResult<'tcx, (u128, VariantIdx)> {
586         trace!("read_discriminant_value {:#?}", rval.layout);
587
588         let (discr_kind, discr_index) = match rval.layout.variants {
589             layout::Variants::Single { index } => {
590                 let discr_val = rval.layout.ty.discriminant_for_variant(*self.tcx, index).map_or(
591                     index.as_u32() as u128,
592                     |discr| discr.val);
593                 return Ok((discr_val, index));
594             }
595             layout::Variants::Multiple { ref discr_kind, discr_index, .. } =>
596                 (discr_kind, discr_index),
597         };
598
599         // read raw discriminant value
600         let discr_op = self.operand_field(rval, discr_index as u64)?;
601         let discr_val = self.read_immediate(discr_op)?;
602         let raw_discr = discr_val.to_scalar_or_undef();
603         trace!("discr value: {:?}", raw_discr);
604         // post-process
605         Ok(match *discr_kind {
606             layout::DiscriminantKind::Tag => {
607                 let bits_discr = match raw_discr.to_bits(discr_val.layout.size) {
608                     Ok(raw_discr) => raw_discr,
609                     Err(_) => return err!(InvalidDiscriminant(raw_discr.erase_tag())),
610                 };
611                 let real_discr = if discr_val.layout.ty.is_signed() {
612                     // going from layout tag type to typeck discriminant type
613                     // requires first sign extending with the layout discriminant
614                     let sexted = sign_extend(bits_discr, discr_val.layout.size) as i128;
615                     // and then zeroing with the typeck discriminant type
616                     let discr_ty = rval.layout.ty
617                         .ty_adt_def().expect("tagged layout corresponds to adt")
618                         .repr
619                         .discr_type();
620                     let size = layout::Integer::from_attr(self, discr_ty).size();
621                     let truncatee = sexted as u128;
622                     truncate(truncatee, size)
623                 } else {
624                     bits_discr
625                 };
626                 // Make sure we catch invalid discriminants
627                 let index = match &rval.layout.ty.sty {
628                     ty::Adt(adt, _) => adt
629                         .discriminants(self.tcx.tcx)
630                         .find(|(_, var)| var.val == real_discr),
631                     ty::Generator(def_id, substs, _) => substs
632                         .discriminants(*def_id, self.tcx.tcx)
633                         .find(|(_, var)| var.val == real_discr),
634                     _ => bug!("tagged layout for non-adt non-generator"),
635                 }.ok_or_else(|| InterpError::InvalidDiscriminant(raw_discr.erase_tag()))?;
636                 (real_discr, index.0)
637             },
638             layout::DiscriminantKind::Niche {
639                 dataful_variant,
640                 ref niche_variants,
641                 niche_start,
642             } => {
643                 let variants_start = niche_variants.start().as_u32() as u128;
644                 let variants_end = niche_variants.end().as_u32() as u128;
645                 let raw_discr = raw_discr.not_undef()
646                     .map_err(|_| InterpError::InvalidDiscriminant(ScalarMaybeUndef::Undef))?;
647                 match raw_discr.to_bits_or_ptr(discr_val.layout.size, self) {
648                     Err(ptr) => {
649                         // The niche must be just 0 (which an inbounds pointer value never is)
650                         let ptr_valid = niche_start == 0 && variants_start == variants_end &&
651                             !self.memory.ptr_may_be_null(ptr);
652                         if !ptr_valid {
653                             return err!(InvalidDiscriminant(raw_discr.erase_tag().into()));
654                         }
655                         (dataful_variant.as_u32() as u128, dataful_variant)
656                     },
657                     Ok(raw_discr) => {
658                         let adjusted_discr = raw_discr.wrapping_sub(niche_start)
659                             .wrapping_add(variants_start);
660                         if variants_start <= adjusted_discr && adjusted_discr <= variants_end {
661                             let index = adjusted_discr as usize;
662                             assert_eq!(index as u128, adjusted_discr);
663                             assert!(index < rval.layout.ty
664                                 .ty_adt_def()
665                                 .expect("tagged layout for non adt")
666                                 .variants.len());
667                             (adjusted_discr, VariantIdx::from_usize(index))
668                         } else {
669                             (dataful_variant.as_u32() as u128, dataful_variant)
670                         }
671                     },
672                 }
673             }
674         })
675     }
676 }