compiler/rustc_mir/src/interpret/eval_context.rs

   1 use std::cell::Cell;
   2 use std::fmt;
   3 use std::mem;
   4
   5 use rustc_data_structures::fx::FxHashMap;
   6 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
   7 use rustc_hir::{self as hir, def_id::DefId, definitions::DefPathData};
   8 use rustc_index::vec::IndexVec;
   9 use rustc_macros::HashStable;
  10 use rustc_middle::ich::StableHashingContext;
  11 use rustc_middle::mir;
  12 use rustc_middle::mir::interpret::{GlobalId, InterpResult, Pointer, Scalar};
  13 use rustc_middle::ty::layout::{self, TyAndLayout};
  14 use rustc_middle::ty::{
  15     self, query::TyCtxtAt, subst::SubstsRef, ParamEnv, Ty, TyCtxt, TypeFoldable,
  16 };
  17 use rustc_span::{Pos, Span};
  18 use rustc_target::abi::{Align, HasDataLayout, LayoutOf, Size, TargetDataLayout};
  19
  20 use super::{
  21     Immediate, MPlaceTy, Machine, MemPlace, MemPlaceMeta, Memory, Operand, Place, PlaceTy,
  22     ScalarMaybeUninit, StackPopJump,
  23 };
  24 use crate::transform::validate::equal_up_to_regions;
  25 use crate::util::storage::AlwaysLiveLocals;
  26
  27 pub struct InterpCx<'mir, 'tcx, M: Machine<'mir, 'tcx>> {
  28     /// Stores the `Machine` instance.
  29     ///
  30     /// Note: the stack is provided by the machine.
  31     pub machine: M,
  32
  33     /// The results of the type checker, from rustc.
  34     /// The span in this is the "root" of the evaluation, i.e., the const
  35     /// we are evaluating (if this is CTFE).
  36     pub tcx: TyCtxtAt<'tcx>,
  37
  38     /// Bounds in scope for polymorphic evaluations.
  39     pub(crate) param_env: ty::ParamEnv<'tcx>,
  40
  41     /// The virtual memory system.
  42     pub memory: Memory<'mir, 'tcx, M>,
  43
  44     /// A cache for deduplicating vtables
  45     pub(super) vtables:
  46         FxHashMap<(Ty<'tcx>, Option<ty::PolyExistentialTraitRef<'tcx>>), Pointer<M::PointerTag>>,
  47 }
  48
  49 // The Phantomdata exists to prevent this type from being `Send`. If it were sent across a thread
  50 // boundary and dropped in the other thread, it would exit the span in the other thread.
  51 struct SpanGuard(tracing::Span, std::marker::PhantomData<*const u8>);
  52
  53 impl SpanGuard {
  54     /// By default a `SpanGuard` does nothing.
  55     fn new() -> Self {
  56         Self(tracing::Span::none(), std::marker::PhantomData)
  57     }
  58
  59     /// If a span is entered, we exit the previous span (if any, normally none) and enter the
  60     /// new span. This is mainly so we don't have to use `Option` for the `tracing_span` field of
  61     /// `Frame` by creating a dummy span to being with and then entering it once the frame has
  62     /// been pushed.
  63     fn enter(&mut self, span: tracing::Span) {
  64         // This executes the destructor on the previous instance of `SpanGuard`, ensuring that
  65         // we never enter or exit more spans than vice versa. Unless you `mem::leak`, then we
  66         // can't protect the tracing stack, but that'll just lead to weird logging, no actual
  67         // problems.
  68         *self = Self(span, std::marker::PhantomData);
  69         self.0.with_subscriber(|(id, dispatch)| {
  70             dispatch.enter(id);
  71         });
  72     }
  73 }
  74
  75 impl Drop for SpanGuard {
  76     fn drop(&mut self) {
  77         self.0.with_subscriber(|(id, dispatch)| {
  78             dispatch.exit(id);
  79         });
  80     }
  81 }
  82
  83 /// A stack frame.
  84 pub struct Frame<'mir, 'tcx, Tag = (), Extra = ()> {
  85     ////////////////////////////////////////////////////////////////////////////////
  86     // Function and callsite information
  87     ////////////////////////////////////////////////////////////////////////////////
  88     /// The MIR for the function called on this frame.
  89     pub body: &'mir mir::Body<'tcx>,
  90
  91     /// The def_id and substs of the current function.
  92     pub instance: ty::Instance<'tcx>,
  93
  94     /// Extra data for the machine.
  95     pub extra: Extra,
  96
  97     ////////////////////////////////////////////////////////////////////////////////
  98     // Return place and locals
  99     ////////////////////////////////////////////////////////////////////////////////
 100     /// Work to perform when returning from this function.
 101     pub return_to_block: StackPopCleanup,
 102
 103     /// The location where the result of the current stack frame should be written to,
 104     /// and its layout in the caller.
 105     pub return_place: Option<PlaceTy<'tcx, Tag>>,
 106
 107     /// The list of locals for this stack frame, stored in order as
 108     /// `[return_ptr, arguments..., variables..., temporaries...]`.
 109     /// The locals are stored as `Option<Value>`s.
 110     /// `None` represents a local that is currently dead, while a live local
 111     /// can either directly contain `Scalar` or refer to some part of an `Allocation`.
 112     pub locals: IndexVec<mir::Local, LocalState<'tcx, Tag>>,
 113
 114     /// The span of the `tracing` crate is stored here.
 115     /// When the guard is dropped, the span is exited. This gives us
 116     /// a full stack trace on all tracing statements.
 117     tracing_span: SpanGuard,
 118
 119     ////////////////////////////////////////////////////////////////////////////////
 120     // Current position within the function
 121     ////////////////////////////////////////////////////////////////////////////////
 122     /// If this is `Err`, we are not currently executing any particular statement in
 123     /// this frame (can happen e.g. during frame initialization, and during unwinding on
 124     /// frames without cleanup code).
 125     /// We basically abuse `Result` as `Either`.
 126     pub(super) loc: Result<mir::Location, Span>,
 127 }
 128
 129 /// What we store about a frame in an interpreter backtrace.
 130 #[derive(Debug)]
 131 pub struct FrameInfo<'tcx> {
 132     pub instance: ty::Instance<'tcx>,
 133     pub span: Span,
 134     pub lint_root: Option<hir::HirId>,
 135 }
 136
 137 #[derive(Clone, Eq, PartialEq, Debug, HashStable)] // Miri debug-prints these
 138 pub enum StackPopCleanup {
 139     /// Jump to the next block in the caller, or cause UB if None (that's a function
 140     /// that may never return). Also store layout of return place so
 141     /// we can validate it at that layout.
 142     /// `ret` stores the block we jump to on a normal return, while `unwind`
 143     /// stores the block used for cleanup during unwinding.
 144     Goto { ret: Option<mir::BasicBlock>, unwind: Option<mir::BasicBlock> },
 145     /// Just do nothing: Used by Main and for the `box_alloc` hook in miri.
 146     /// `cleanup` says whether locals are deallocated. Static computation
 147     /// wants them leaked to intern what they need (and just throw away
 148     /// the entire `ecx` when it is done).
 149     None { cleanup: bool },
 150 }
 151
 152 /// State of a local variable including a memoized layout
 153 #[derive(Clone, PartialEq, Eq, HashStable)]
 154 pub struct LocalState<'tcx, Tag = ()> {
 155     pub value: LocalValue<Tag>,
 156     /// Don't modify if `Some`, this is only used to prevent computing the layout twice
 157     #[stable_hasher(ignore)]
 158     pub layout: Cell<Option<TyAndLayout<'tcx>>>,
 159 }
 160
 161 /// Current value of a local variable
 162 #[derive(Copy, Clone, PartialEq, Eq, Debug, HashStable)] // Miri debug-prints these
 163 pub enum LocalValue<Tag = ()> {
 164     /// This local is not currently alive, and cannot be used at all.
 165     Dead,
 166     /// This local is alive but not yet initialized. It can be written to
 167     /// but not read from or its address taken. Locals get initialized on
 168     /// first write because for unsized locals, we do not know their size
 169     /// before that.
 170     Uninitialized,
 171     /// A normal, live local.
 172     /// Mostly for convenience, we re-use the `Operand` type here.
 173     /// This is an optimization over just always having a pointer here;
 174     /// we can thus avoid doing an allocation when the local just stores
 175     /// immediate values *and* never has its address taken.
 176     Live(Operand<Tag>),
 177 }
 178
 179 impl<'tcx, Tag: Copy + 'static> LocalState<'tcx, Tag> {
 180     /// Read the local's value or error if the local is not yet live or not live anymore.
 181     ///
 182     /// Note: This may only be invoked from the `Machine::access_local` hook and not from
 183     /// anywhere else. You may be invalidating machine invariants if you do!
 184     pub fn access(&self) -> InterpResult<'tcx, Operand<Tag>> {
 185         match self.value {
 186             LocalValue::Dead => throw_ub!(DeadLocal),
 187             LocalValue::Uninitialized => {
 188                 bug!("The type checker should prevent reading from a never-written local")
 189             }
 190             LocalValue::Live(val) => Ok(val),
 191         }
 192     }
 193
 194     /// Overwrite the local.  If the local can be overwritten in place, return a reference
 195     /// to do so; otherwise return the `MemPlace` to consult instead.
 196     ///
 197     /// Note: This may only be invoked from the `Machine::access_local_mut` hook and not from
 198     /// anywhere else. You may be invalidating machine invariants if you do!
 199     pub fn access_mut(
 200         &mut self,
 201     ) -> InterpResult<'tcx, Result<&mut LocalValue<Tag>, MemPlace<Tag>>> {
 202         match self.value {
 203             LocalValue::Dead => throw_ub!(DeadLocal),
 204             LocalValue::Live(Operand::Indirect(mplace)) => Ok(Err(mplace)),
 205             ref mut
 206             local @ (LocalValue::Live(Operand::Immediate(_)) | LocalValue::Uninitialized) => {
 207                 Ok(Ok(local))
 208             }
 209         }
 210     }
 211 }
 212
 213 impl<'mir, 'tcx, Tag> Frame<'mir, 'tcx, Tag> {
 214     pub fn with_extra<Extra>(self, extra: Extra) -> Frame<'mir, 'tcx, Tag, Extra> {
 215         Frame {
 216             body: self.body,
 217             instance: self.instance,
 218             return_to_block: self.return_to_block,
 219             return_place: self.return_place,
 220             locals: self.locals,
 221             loc: self.loc,
 222             extra,
 223             tracing_span: self.tracing_span,
 224         }
 225     }
 226 }
 227
 228 impl<'mir, 'tcx, Tag, Extra> Frame<'mir, 'tcx, Tag, Extra> {
 229     /// Get the current location within the Frame.
 230     ///
 231     /// If this is `Err`, we are not currently executing any particular statement in
 232     /// this frame (can happen e.g. during frame initialization, and during unwinding on
 233     /// frames without cleanup code).
 234     /// We basically abuse `Result` as `Either`.
 235     ///
 236     /// Used by priroda.
 237     pub fn current_loc(&self) -> Result<mir::Location, Span> {
 238         self.loc
 239     }
 240
 241     /// Return the `SourceInfo` of the current instruction.
 242     pub fn current_source_info(&self) -> Option<&mir::SourceInfo> {
 243         self.loc.ok().map(|loc| self.body.source_info(loc))
 244     }
 245
 246     pub fn current_span(&self) -> Span {
 247         match self.loc {
 248             Ok(loc) => self.body.source_info(loc).span,
 249             Err(span) => span,
 250         }
 251     }
 252 }
 253
 254 impl<'tcx> fmt::Display for FrameInfo<'tcx> {
 255     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 256         ty::tls::with(|tcx| {
 257             if tcx.def_key(self.instance.def_id()).disambiguated_data.data
 258                 == DefPathData::ClosureExpr
 259             {
 260                 write!(f, "inside closure")?;
 261             } else {
 262                 write!(f, "inside `{}`", self.instance)?;
 263             }
 264             if !self.span.is_dummy() {
 265                 let lo = tcx.sess.source_map().lookup_char_pos(self.span.lo());
 266                 write!(f, " at {}:{}:{}", lo.file.name, lo.line, lo.col.to_usize() + 1)?;
 267             }
 268             Ok(())
 269         })
 270     }
 271 }
 272
 273 impl<'mir, 'tcx, M: Machine<'mir, 'tcx>> HasDataLayout for InterpCx<'mir, 'tcx, M> {
 274     #[inline]
 275     fn data_layout(&self) -> &TargetDataLayout {
 276         &self.tcx.data_layout
 277     }
 278 }
 279
 280 impl<'mir, 'tcx, M> layout::HasTyCtxt<'tcx> for InterpCx<'mir, 'tcx, M>
 281 where
 282     M: Machine<'mir, 'tcx>,
 283 {
 284     #[inline]
 285     fn tcx(&self) -> TyCtxt<'tcx> {
 286         *self.tcx
 287     }
 288 }
 289
 290 impl<'mir, 'tcx, M> layout::HasParamEnv<'tcx> for InterpCx<'mir, 'tcx, M>
 291 where
 292     M: Machine<'mir, 'tcx>,
 293 {
 294     fn param_env(&self) -> ty::ParamEnv<'tcx> {
 295         self.param_env
 296     }
 297 }
 298
 299 impl<'mir, 'tcx: 'mir, M: Machine<'mir, 'tcx>> LayoutOf for InterpCx<'mir, 'tcx, M> {
 300     type Ty = Ty<'tcx>;
 301     type TyAndLayout = InterpResult<'tcx, TyAndLayout<'tcx>>;
 302
 303     #[inline]
 304     fn layout_of(&self, ty: Ty<'tcx>) -> Self::TyAndLayout {
 305         self.tcx
 306             .layout_of(self.param_env.and(ty))
 307             .map_err(|layout| err_inval!(Layout(layout)).into())
 308     }
 309 }
 310
 311 /// Test if it is valid for a MIR assignment to assign `src`-typed place to `dest`-typed value.
 312 /// This test should be symmetric, as it is primarily about layout compatibility.
 313 pub(super) fn mir_assign_valid_types<'tcx>(
 314     tcx: TyCtxt<'tcx>,
 315     param_env: ParamEnv<'tcx>,
 316     src: TyAndLayout<'tcx>,
 317     dest: TyAndLayout<'tcx>,
 318 ) -> bool {
 319     // Type-changing assignments can happen when subtyping is used. While
 320     // all normal lifetimes are erased, higher-ranked types with their
 321     // late-bound lifetimes are still around and can lead to type
 322     // differences. So we compare ignoring lifetimes.
 323     if equal_up_to_regions(tcx, param_env, src.ty, dest.ty) {
 324         // Make sure the layout is equal, too -- just to be safe. Miri really
 325         // needs layout equality. For performance reason we skip this check when
 326         // the types are equal. Equal types *can* have different layouts when
 327         // enum downcast is involved (as enum variants carry the type of the
 328         // enum), but those should never occur in assignments.
 329         if cfg!(debug_assertions) || src.ty != dest.ty {
 330             assert_eq!(src.layout, dest.layout);
 331         }
 332         true
 333     } else {
 334         false
 335     }
 336 }
 337
 338 /// Use the already known layout if given (but sanity check in debug mode),
 339 /// or compute the layout.
 340 #[cfg_attr(not(debug_assertions), inline(always))]
 341 pub(super) fn from_known_layout<'tcx>(
 342     tcx: TyCtxtAt<'tcx>,
 343     param_env: ParamEnv<'tcx>,
 344     known_layout: Option<TyAndLayout<'tcx>>,
 345     compute: impl FnOnce() -> InterpResult<'tcx, TyAndLayout<'tcx>>,
 346 ) -> InterpResult<'tcx, TyAndLayout<'tcx>> {
 347     match known_layout {
 348         None => compute(),
 349         Some(known_layout) => {
 350             if cfg!(debug_assertions) {
 351                 let check_layout = compute()?;
 352                 if !mir_assign_valid_types(tcx.tcx, param_env, check_layout, known_layout) {
 353                     span_bug!(
 354                         tcx.span,
 355                         "expected type differs from actual type.\nexpected: {:?}\nactual: {:?}",
 356                         known_layout.ty,
 357                         check_layout.ty,
 358                     );
 359                 }
 360             }
 361             Ok(known_layout)
 362         }
 363     }
 364 }
 365
 366 impl<'mir, 'tcx: 'mir, M: Machine<'mir, 'tcx>> InterpCx<'mir, 'tcx, M> {
 367     pub fn new(
 368         tcx: TyCtxt<'tcx>,
 369         root_span: Span,
 370         param_env: ty::ParamEnv<'tcx>,
 371         machine: M,
 372         memory_extra: M::MemoryExtra,
 373     ) -> Self {
 374         InterpCx {
 375             machine,
 376             tcx: tcx.at(root_span),
 377             param_env,
 378             memory: Memory::new(tcx, memory_extra),
 379             vtables: FxHashMap::default(),
 380         }
 381     }
 382
 383     #[inline(always)]
 384     pub fn cur_span(&self) -> Span {
 385         self.stack().last().map_or(self.tcx.span, |f| f.current_span())
 386     }
 387
 388     #[inline(always)]
 389     pub fn force_ptr(
 390         &self,
 391         scalar: Scalar<M::PointerTag>,
 392     ) -> InterpResult<'tcx, Pointer<M::PointerTag>> {
 393         self.memory.force_ptr(scalar)
 394     }
 395
 396     #[inline(always)]
 397     pub fn force_bits(
 398         &self,
 399         scalar: Scalar<M::PointerTag>,
 400         size: Size,
 401     ) -> InterpResult<'tcx, u128> {
 402         self.memory.force_bits(scalar, size)
 403     }
 404
 405     /// Call this to turn untagged "global" pointers (obtained via `tcx`) into
 406     /// the machine pointer to the allocation.  Must never be used
 407     /// for any other pointers, nor for TLS statics.
 408     ///
 409     /// Using the resulting pointer represents a *direct* access to that memory
 410     /// (e.g. by directly using a `static`),
 411     /// as opposed to access through a pointer that was created by the program.
 412     ///
 413     /// This function can fail only if `ptr` points to an `extern static`.
 414     #[inline(always)]
 415     pub fn global_base_pointer(&self, ptr: Pointer) -> InterpResult<'tcx, Pointer<M::PointerTag>> {
 416         self.memory.global_base_pointer(ptr)
 417     }
 418
 419     #[inline(always)]
 420     pub(crate) fn stack(&self) -> &[Frame<'mir, 'tcx, M::PointerTag, M::FrameExtra>] {
 421         M::stack(self)
 422     }
 423
 424     #[inline(always)]
 425     pub(crate) fn stack_mut(
 426         &mut self,
 427     ) -> &mut Vec<Frame<'mir, 'tcx, M::PointerTag, M::FrameExtra>> {
 428         M::stack_mut(self)
 429     }
 430
 431     #[inline(always)]
 432     pub fn frame_idx(&self) -> usize {
 433         let stack = self.stack();
 434         assert!(!stack.is_empty());
 435         stack.len() - 1
 436     }
 437
 438     #[inline(always)]
 439     pub fn frame(&self) -> &Frame<'mir, 'tcx, M::PointerTag, M::FrameExtra> {
 440         self.stack().last().expect("no call frames exist")
 441     }
 442
 443     #[inline(always)]
 444     pub fn frame_mut(&mut self) -> &mut Frame<'mir, 'tcx, M::PointerTag, M::FrameExtra> {
 445         self.stack_mut().last_mut().expect("no call frames exist")
 446     }
 447
 448     #[inline(always)]
 449     pub(super) fn body(&self) -> &'mir mir::Body<'tcx> {
 450         self.frame().body
 451     }
 452
 453     #[inline(always)]
 454     pub fn sign_extend(&self, value: u128, ty: TyAndLayout<'_>) -> u128 {
 455         assert!(ty.abi.is_signed());
 456         ty.size.sign_extend(value)
 457     }
 458
 459     #[inline(always)]
 460     pub fn truncate(&self, value: u128, ty: TyAndLayout<'_>) -> u128 {
 461         ty.size.truncate(value)
 462     }
 463
 464     #[inline]
 465     pub fn type_is_freeze(&self, ty: Ty<'tcx>) -> bool {
 466         ty.is_freeze(self.tcx, self.param_env)
 467     }
 468
 469     pub fn load_mir(
 470         &self,
 471         instance: ty::InstanceDef<'tcx>,
 472         promoted: Option<mir::Promoted>,
 473     ) -> InterpResult<'tcx, &'tcx mir::Body<'tcx>> {
 474         // do not continue if typeck errors occurred (can only occur in local crate)
 475         let def = instance.with_opt_param();
 476         if let Some(def) = def.as_local() {
 477             if self.tcx.has_typeck_results(def.did) {
 478                 if let Some(error_reported) = self.tcx.typeck_opt_const_arg(def).tainted_by_errors {
 479                     throw_inval!(AlreadyReported(error_reported))
 480                 }
 481             }
 482         }
 483         trace!("load mir(instance={:?}, promoted={:?})", instance, promoted);
 484         if let Some(promoted) = promoted {
 485             return Ok(&self.tcx.promoted_mir_opt_const_arg(def)[promoted]);
 486         }
 487         M::load_mir(self, instance)
 488     }
 489
 490     /// Call this on things you got out of the MIR (so it is as generic as the current
 491     /// stack frame), to bring it into the proper environment for this interpreter.
 492     pub(super) fn subst_from_current_frame_and_normalize_erasing_regions<T: TypeFoldable<'tcx>>(
 493         &self,
 494         value: T,
 495     ) -> T {
 496         self.subst_from_frame_and_normalize_erasing_regions(self.frame(), value)
 497     }
 498
 499     /// Call this on things you got out of the MIR (so it is as generic as the provided
 500     /// stack frame), to bring it into the proper environment for this interpreter.
 501     pub(super) fn subst_from_frame_and_normalize_erasing_regions<T: TypeFoldable<'tcx>>(
 502         &self,
 503         frame: &Frame<'mir, 'tcx, M::PointerTag, M::FrameExtra>,
 504         value: T,
 505     ) -> T {
 506         frame.instance.subst_mir_and_normalize_erasing_regions(*self.tcx, self.param_env, value)
 507     }
 508
 509     /// The `substs` are assumed to already be in our interpreter "universe" (param_env).
 510     pub(super) fn resolve(
 511         &self,
 512         def: ty::WithOptConstParam<DefId>,
 513         substs: SubstsRef<'tcx>,
 514     ) -> InterpResult<'tcx, ty::Instance<'tcx>> {
 515         trace!("resolve: {:?}, {:#?}", def, substs);
 516         trace!("param_env: {:#?}", self.param_env);
 517         trace!("substs: {:#?}", substs);
 518         match ty::Instance::resolve_opt_const_arg(*self.tcx, self.param_env, def, substs) {
 519             Ok(Some(instance)) => Ok(instance),
 520             Ok(None) => throw_inval!(TooGeneric),
 521
 522             // FIXME(eddyb) this could be a bit more specific than `AlreadyReported`.
 523             Err(error_reported) => throw_inval!(AlreadyReported(error_reported)),
 524         }
 525     }
 526
 527     #[inline(always)]
 528     pub fn layout_of_local(
 529         &self,
 530         frame: &Frame<'mir, 'tcx, M::PointerTag, M::FrameExtra>,
 531         local: mir::Local,
 532         layout: Option<TyAndLayout<'tcx>>,
 533     ) -> InterpResult<'tcx, TyAndLayout<'tcx>> {
 534         // `const_prop` runs into this with an invalid (empty) frame, so we
 535         // have to support that case (mostly by skipping all caching).
 536         match frame.locals.get(local).and_then(|state| state.layout.get()) {
 537             None => {
 538                 let layout = from_known_layout(self.tcx, self.param_env, layout, || {
 539                     let local_ty = frame.body.local_decls[local].ty;
 540                     let local_ty =
 541                         self.subst_from_frame_and_normalize_erasing_regions(frame, local_ty);
 542                     self.layout_of(local_ty)
 543                 })?;
 544                 if let Some(state) = frame.locals.get(local) {
 545                     // Layouts of locals are requested a lot, so we cache them.
 546                     state.layout.set(Some(layout));
 547                 }
 548                 Ok(layout)
 549             }
 550             Some(layout) => Ok(layout),
 551         }
 552     }
 553
 554     /// Returns the actual dynamic size and alignment of the place at the given type.
 555     /// Only the "meta" (metadata) part of the place matters.
 556     /// This can fail to provide an answer for extern types.
 557     pub(super) fn size_and_align_of(
 558         &self,
 559         metadata: &MemPlaceMeta<M::PointerTag>,
 560         layout: &TyAndLayout<'tcx>,
 561     ) -> InterpResult<'tcx, Option<(Size, Align)>> {
 562         if !layout.is_unsized() {
 563             return Ok(Some((layout.size, layout.align.abi)));
 564         }
 565         match layout.ty.kind() {
 566             ty::Adt(..) | ty::Tuple(..) => {
 567                 // First get the size of all statically known fields.
 568                 // Don't use type_of::sizing_type_of because that expects t to be sized,
 569                 // and it also rounds up to alignment, which we want to avoid,
 570                 // as the unsized field's alignment could be smaller.
 571                 assert!(!layout.ty.is_simd());
 572                 assert!(layout.fields.count() > 0);
 573                 trace!("DST layout: {:?}", layout);
 574
 575                 let sized_size = layout.fields.offset(layout.fields.count() - 1);
 576                 let sized_align = layout.align.abi;
 577                 trace!(
 578                     "DST {} statically sized prefix size: {:?} align: {:?}",
 579                     layout.ty,
 580                     sized_size,
 581                     sized_align
 582                 );
 583
 584                 // Recurse to get the size of the dynamically sized field (must be
 585                 // the last field).  Can't have foreign types here, how would we
 586                 // adjust alignment and size for them?
 587                 let field = layout.field(self, layout.fields.count() - 1)?;
 588                 let (unsized_size, unsized_align) =
 589                     match self.size_and_align_of(metadata, &field)? {
 590                         Some(size_and_align) => size_and_align,
 591                         None => {
 592                             // A field with extern type.  If this field is at offset 0, we behave
 593                             // like the underlying extern type.
 594                             // FIXME: Once we have made decisions for how to handle size and alignment
 595                             // of `extern type`, this should be adapted.  It is just a temporary hack
 596                             // to get some code to work that probably ought to work.
 597                             if sized_size == Size::ZERO {
 598                                 return Ok(None);
 599                             } else {
 600                                 span_bug!(
 601                                     self.cur_span(),
 602                                     "Fields cannot be extern types, unless they are at offset 0"
 603                                 )
 604                             }
 605                         }
 606                     };
 607
 608                 // FIXME (#26403, #27023): We should be adding padding
 609                 // to `sized_size` (to accommodate the `unsized_align`
 610                 // required of the unsized field that follows) before
 611                 // summing it with `sized_size`. (Note that since #26403
 612                 // is unfixed, we do not yet add the necessary padding
 613                 // here. But this is where the add would go.)
 614
 615                 // Return the sum of sizes and max of aligns.
 616                 let size = sized_size + unsized_size; // `Size` addition
 617
 618                 // Choose max of two known alignments (combined value must
 619                 // be aligned according to more restrictive of the two).
 620                 let align = sized_align.max(unsized_align);
 621
 622                 // Issue #27023: must add any necessary padding to `size`
 623                 // (to make it a multiple of `align`) before returning it.
 624                 let size = size.align_to(align);
 625
 626                 // Check if this brought us over the size limit.
 627                 if size.bytes() >= self.tcx.data_layout.obj_size_bound() {
 628                     throw_ub!(InvalidMeta("total size is bigger than largest supported object"));
 629                 }
 630                 Ok(Some((size, align)))
 631             }
 632             ty::Dynamic(..) => {
 633                 let vtable = metadata.unwrap_meta();
 634                 // Read size and align from vtable (already checks size).
 635                 Ok(Some(self.read_size_and_align_from_vtable(vtable)?))
 636             }
 637
 638             ty::Slice(_) | ty::Str => {
 639                 let len = metadata.unwrap_meta().to_machine_usize(self)?;
 640                 let elem = layout.field(self, 0)?;
 641
 642                 // Make sure the slice is not too big.
 643                 let size = elem.size.checked_mul(len, self).ok_or_else(|| {
 644                     err_ub!(InvalidMeta("slice is bigger than largest supported object"))
 645                 })?;
 646                 Ok(Some((size, elem.align.abi)))
 647             }
 648
 649             ty::Foreign(_) => Ok(None),
 650
 651             _ => span_bug!(self.cur_span(), "size_and_align_of::<{:?}> not supported", layout.ty),
 652         }
 653     }
 654     #[inline]
 655     pub fn size_and_align_of_mplace(
 656         &self,
 657         mplace: &MPlaceTy<'tcx, M::PointerTag>,
 658     ) -> InterpResult<'tcx, Option<(Size, Align)>> {
 659         self.size_and_align_of(&mplace.meta, &mplace.layout)
 660     }
 661
 662     pub fn push_stack_frame(
 663         &mut self,
 664         instance: ty::Instance<'tcx>,
 665         body: &'mir mir::Body<'tcx>,
 666         return_place: Option<&PlaceTy<'tcx, M::PointerTag>>,
 667         return_to_block: StackPopCleanup,
 668     ) -> InterpResult<'tcx> {
 669         // first push a stack frame so we have access to the local substs
 670         let pre_frame = Frame {
 671             body,
 672             loc: Err(body.span), // Span used for errors caused during preamble.
 673             return_to_block,
 674             return_place: return_place.copied(),
 675             // empty local array, we fill it in below, after we are inside the stack frame and
 676             // all methods actually know about the frame
 677             locals: IndexVec::new(),
 678             instance,
 679             tracing_span: SpanGuard::new(),
 680             extra: (),
 681         };
 682         let frame = M::init_frame_extra(self, pre_frame)?;
 683         self.stack_mut().push(frame);
 684
 685         // Make sure all the constants required by this frame evaluate successfully (post-monomorphization check).
 686         for const_ in &body.required_consts {
 687             let span = const_.span;
 688             let const_ =
 689                 self.subst_from_current_frame_and_normalize_erasing_regions(const_.literal);
 690             self.mir_const_to_op(&const_, None).map_err(|err| {
 691                 // If there was an error, set the span of the current frame to this constant.
 692                 // Avoiding doing this when evaluation succeeds.
 693                 self.frame_mut().loc = Err(span);
 694                 err
 695             })?;
 696         }
 697
 698         // Locals are initially uninitialized.
 699         let dummy = LocalState { value: LocalValue::Uninitialized, layout: Cell::new(None) };
 700         let mut locals = IndexVec::from_elem(dummy, &body.local_decls);
 701
 702         // Now mark those locals as dead that we do not want to initialize
 703         // Mark locals that use `Storage*` annotations as dead on function entry.
 704         let always_live = AlwaysLiveLocals::new(self.body());
 705         for local in locals.indices() {
 706             if !always_live.contains(local) {
 707                 locals[local].value = LocalValue::Dead;
 708             }
 709         }
 710         // done
 711         self.frame_mut().locals = locals;
 712         M::after_stack_push(self)?;
 713         self.frame_mut().loc = Ok(mir::Location::START);
 714
 715         let span = info_span!("frame", "{}", instance);
 716         self.frame_mut().tracing_span.enter(span);
 717
 718         Ok(())
 719     }
 720
 721     /// Jump to the given block.
 722     #[inline]
 723     pub fn go_to_block(&mut self, target: mir::BasicBlock) {
 724         self.frame_mut().loc = Ok(mir::Location { block: target, statement_index: 0 });
 725     }
 726
 727     /// *Return* to the given `target` basic block.
 728     /// Do *not* use for unwinding! Use `unwind_to_block` instead.
 729     ///
 730     /// If `target` is `None`, that indicates the function cannot return, so we raise UB.
 731     pub fn return_to_block(&mut self, target: Option<mir::BasicBlock>) -> InterpResult<'tcx> {
 732         if let Some(target) = target {
 733             self.go_to_block(target);
 734             Ok(())
 735         } else {
 736             throw_ub!(Unreachable)
 737         }
 738     }
 739
 740     /// *Unwind* to the given `target` basic block.
 741     /// Do *not* use for returning! Use `return_to_block` instead.
 742     ///
 743     /// If `target` is `None`, that indicates the function does not need cleanup during
 744     /// unwinding, and we will just keep propagating that upwards.
 745     pub fn unwind_to_block(&mut self, target: Option<mir::BasicBlock>) {
 746         self.frame_mut().loc = match target {
 747             Some(block) => Ok(mir::Location { block, statement_index: 0 }),
 748             None => Err(self.frame_mut().body.span),
 749         };
 750     }
 751
 752     /// Pops the current frame from the stack, deallocating the
 753     /// memory for allocated locals.
 754     ///
 755     /// If `unwinding` is `false`, then we are performing a normal return
 756     /// from a function. In this case, we jump back into the frame of the caller,
 757     /// and continue execution as normal.
 758     ///
 759     /// If `unwinding` is `true`, then we are in the middle of a panic,
 760     /// and need to unwind this frame. In this case, we jump to the
 761     /// `cleanup` block for the function, which is responsible for running
 762     /// `Drop` impls for any locals that have been initialized at this point.
 763     /// The cleanup block ends with a special `Resume` terminator, which will
 764     /// cause us to continue unwinding.
 765     pub(super) fn pop_stack_frame(&mut self, unwinding: bool) -> InterpResult<'tcx> {
 766         info!(
 767             "popping stack frame ({})",
 768             if unwinding { "during unwinding" } else { "returning from function" }
 769         );
 770
 771         // Sanity check `unwinding`.
 772         assert_eq!(
 773             unwinding,
 774             match self.frame().loc {
 775                 Ok(loc) => self.body().basic_blocks()[loc.block].is_cleanup,
 776                 Err(_) => true,
 777             }
 778         );
 779
 780         if unwinding && self.frame_idx() == 0 {
 781             throw_ub_format!("unwinding past the topmost frame of the stack");
 782         }
 783
 784         let frame =
 785             self.stack_mut().pop().expect("tried to pop a stack frame, but there were none");
 786
 787         if !unwinding {
 788             // Copy the return value to the caller's stack frame.
 789             if let Some(ref return_place) = frame.return_place {
 790                 let op = self.access_local(&frame, mir::RETURN_PLACE, None)?;
 791                 self.copy_op_transmute(&op, return_place)?;
 792                 trace!("{:?}", self.dump_place(**return_place));
 793             } else {
 794                 throw_ub!(Unreachable);
 795             }
 796         }
 797
 798         // Now where do we jump next?
 799
 800         // Usually we want to clean up (deallocate locals), but in a few rare cases we don't.
 801         // In that case, we return early. We also avoid validation in that case,
 802         // because this is CTFE and the final value will be thoroughly validated anyway.
 803         let (cleanup, next_block) = match frame.return_to_block {
 804             StackPopCleanup::Goto { ret, unwind } => {
 805                 (true, Some(if unwinding { unwind } else { ret }))
 806             }
 807             StackPopCleanup::None { cleanup, .. } => (cleanup, None),
 808         };
 809
 810         if !cleanup {
 811             assert!(self.stack().is_empty(), "only the topmost frame should ever be leaked");
 812             assert!(next_block.is_none(), "tried to skip cleanup when we have a next block!");
 813             assert!(!unwinding, "tried to skip cleanup during unwinding");
 814             // Leak the locals, skip validation, skip machine hook.
 815             return Ok(());
 816         }
 817
 818         // Cleanup: deallocate all locals that are backed by an allocation.
 819         for local in &frame.locals {
 820             self.deallocate_local(local.value)?;
 821         }
 822
 823         if M::after_stack_pop(self, frame, unwinding)? == StackPopJump::NoJump {
 824             // The hook already did everything.
 825             // We want to skip the `info!` below, hence early return.
 826             return Ok(());
 827         }
 828         // Normal return, figure out where to jump.
 829         if unwinding {
 830             // Follow the unwind edge.
 831             let unwind = next_block.expect("Encountered StackPopCleanup::None when unwinding!");
 832             self.unwind_to_block(unwind);
 833         } else {
 834             // Follow the normal return edge.
 835             if let Some(ret) = next_block {
 836                 self.return_to_block(ret)?;
 837             }
 838         }
 839
 840         Ok(())
 841     }
 842
 843     /// Mark a storage as live, killing the previous content.
 844     pub fn storage_live(&mut self, local: mir::Local) -> InterpResult<'tcx> {
 845         assert!(local != mir::RETURN_PLACE, "Cannot make return place live");
 846         trace!("{:?} is now live", local);
 847
 848         let local_val = LocalValue::Uninitialized;
 849         // StorageLive expects the local to be dead, and marks it live.
 850         let old = mem::replace(&mut self.frame_mut().locals[local].value, local_val);
 851         if !matches!(old, LocalValue::Dead) {
 852             throw_ub_format!("StorageLive on a local that was already live");
 853         }
 854         Ok(())
 855     }
 856
 857     pub fn storage_dead(&mut self, local: mir::Local) -> InterpResult<'tcx> {
 858         assert!(local != mir::RETURN_PLACE, "Cannot make return place dead");
 859         trace!("{:?} is now dead", local);
 860
 861         // It is entirely okay for this local to be already dead (at least that's how we currently generate MIR)
 862         let old = mem::replace(&mut self.frame_mut().locals[local].value, LocalValue::Dead);
 863         self.deallocate_local(old)?;
 864         Ok(())
 865     }
 866
 867     fn deallocate_local(&mut self, local: LocalValue<M::PointerTag>) -> InterpResult<'tcx> {
 868         if let LocalValue::Live(Operand::Indirect(MemPlace { ptr, .. })) = local {
 869             // All locals have a backing allocation, even if the allocation is empty
 870             // due to the local having ZST type.
 871             let ptr = ptr.assert_ptr();
 872             trace!("deallocating local: {:?}", self.memory.dump_alloc(ptr.alloc_id));
 873             self.memory.deallocate_local(ptr)?;
 874         };
 875         Ok(())
 876     }
 877
 878     pub fn eval_to_allocation(
 879         &self,
 880         gid: GlobalId<'tcx>,
 881     ) -> InterpResult<'tcx, MPlaceTy<'tcx, M::PointerTag>> {
 882         // For statics we pick `ParamEnv::reveal_all`, because statics don't have generics
 883         // and thus don't care about the parameter environment. While we could just use
 884         // `self.param_env`, that would mean we invoke the query to evaluate the static
 885         // with different parameter environments, thus causing the static to be evaluated
 886         // multiple times.
 887         let param_env = if self.tcx.is_static(gid.instance.def_id()) {
 888             ty::ParamEnv::reveal_all()
 889         } else {
 890             self.param_env
 891         };
 892         let val = self.tcx.eval_to_allocation_raw(param_env.and(gid))?;
 893         self.raw_const_to_mplace(val)
 894     }
 895
 896     #[must_use]
 897     pub fn dump_place(&'a self, place: Place<M::PointerTag>) -> PlacePrinter<'a, 'mir, 'tcx, M> {
 898         PlacePrinter { ecx: self, place }
 899     }
 900
 901     #[must_use]
 902     pub fn generate_stacktrace(&self) -> Vec<FrameInfo<'tcx>> {
 903         let mut frames = Vec::new();
 904         for frame in self.stack().iter().rev() {
 905             let lint_root = frame.current_source_info().and_then(|source_info| {
 906                 match &frame.body.source_scopes[source_info.scope].local_data {
 907                     mir::ClearCrossCrate::Set(data) => Some(data.lint_root),
 908                     mir::ClearCrossCrate::Clear => None,
 909                 }
 910             });
 911             let span = frame.current_span();
 912
 913             frames.push(FrameInfo { span, instance: frame.instance, lint_root });
 914         }
 915         trace!("generate stacktrace: {:#?}", frames);
 916         frames
 917     }
 918 }
 919
 920 #[doc(hidden)]
 921 /// Helper struct for the `dump_place` function.
 922 pub struct PlacePrinter<'a, 'mir, 'tcx, M: Machine<'mir, 'tcx>> {
 923     ecx: &'a InterpCx<'mir, 'tcx, M>,
 924     place: Place<M::PointerTag>,
 925 }
 926
 927 impl<'a, 'mir, 'tcx: 'mir, M: Machine<'mir, 'tcx>> std::fmt::Debug
 928     for PlacePrinter<'a, 'mir, 'tcx, M>
 929 {
 930     fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 931         match self.place {
 932             Place::Local { frame, local } => {
 933                 let mut allocs = Vec::new();
 934                 write!(fmt, "{:?}", local)?;
 935                 if frame != self.ecx.frame_idx() {
 936                     write!(fmt, " ({} frames up)", self.ecx.frame_idx() - frame)?;
 937                 }
 938                 write!(fmt, ":")?;
 939
 940                 match self.ecx.stack()[frame].locals[local].value {
 941                     LocalValue::Dead => write!(fmt, " is dead")?,
 942                     LocalValue::Uninitialized => write!(fmt, " is uninitialized")?,
 943                     LocalValue::Live(Operand::Indirect(mplace)) => match mplace.ptr {
 944                         Scalar::Ptr(ptr) => {
 945                             write!(
 946                                 fmt,
 947                                 " by align({}){} ref:",
 948                                 mplace.align.bytes(),
 949                                 match mplace.meta {
 950                                     MemPlaceMeta::Meta(meta) => format!(" meta({:?})", meta),
 951                                     MemPlaceMeta::Poison | MemPlaceMeta::None => String::new(),
 952                                 }
 953                             )?;
 954                             allocs.push(ptr.alloc_id);
 955                         }
 956                         ptr => write!(fmt, " by integral ref: {:?}", ptr)?,
 957                     },
 958                     LocalValue::Live(Operand::Immediate(Immediate::Scalar(val))) => {
 959                         write!(fmt, " {:?}", val)?;
 960                         if let ScalarMaybeUninit::Scalar(Scalar::Ptr(ptr)) = val {
 961                             allocs.push(ptr.alloc_id);
 962                         }
 963                     }
 964                     LocalValue::Live(Operand::Immediate(Immediate::ScalarPair(val1, val2))) => {
 965                         write!(fmt, " ({:?}, {:?})", val1, val2)?;
 966                         if let ScalarMaybeUninit::Scalar(Scalar::Ptr(ptr)) = val1 {
 967                             allocs.push(ptr.alloc_id);
 968                         }
 969                         if let ScalarMaybeUninit::Scalar(Scalar::Ptr(ptr)) = val2 {
 970                             allocs.push(ptr.alloc_id);
 971                         }
 972                     }
 973                 }
 974
 975                 write!(fmt, ": {:?}", self.ecx.memory.dump_allocs(allocs))
 976             }
 977             Place::Ptr(mplace) => match mplace.ptr {
 978                 Scalar::Ptr(ptr) => write!(
 979                     fmt,
 980                     "by align({}) ref: {:?}",
 981                     mplace.align.bytes(),
 982                     self.ecx.memory.dump_alloc(ptr.alloc_id)
 983                 ),
 984                 ptr => write!(fmt, " integral by ref: {:?}", ptr),
 985             },
 986         }
 987     }
 988 }
 989
 990 impl<'ctx, 'mir, 'tcx, Tag, Extra> HashStable<StableHashingContext<'ctx>>
 991     for Frame<'mir, 'tcx, Tag, Extra>
 992 where
 993     Extra: HashStable<StableHashingContext<'ctx>>,
 994     Tag: HashStable<StableHashingContext<'ctx>>,
 995 {
 996     fn hash_stable(&self, hcx: &mut StableHashingContext<'ctx>, hasher: &mut StableHasher) {
 997         // Exhaustive match on fields to make sure we forget no field.
 998         let Frame {
 999             body,
1000             instance,
1001             return_to_block,
1002             return_place,
1003             locals,
1004             loc,
1005             extra,
1006             tracing_span: _,
1007         } = self;
1008         body.hash_stable(hcx, hasher);
1009         instance.hash_stable(hcx, hasher);
1010         return_to_block.hash_stable(hcx, hasher);
1011         return_place.as_ref().map(|r| &**r).hash_stable(hcx, hasher);
1012         locals.hash_stable(hcx, hasher);
1013         loc.hash_stable(hcx, hasher);
1014         extra.hash_stable(hcx, hasher);
1015     }
1016 }