src/librustc_mir/const_eval.rs

   1 // Not in interpret to make sure we do not use private implementation details
   2
   3 use std::fmt;
   4 use std::error::Error;
   5 use std::borrow::{Borrow, Cow};
   6 use std::hash::Hash;
   7 use std::collections::hash_map::Entry;
   8 use std::convert::TryInto;
   9
  10 use rustc::hir::def::DefKind;
  11 use rustc::hir::def_id::DefId;
  12 use rustc::middle::lang_items::PanicLocationLangItem;
  13 use rustc::mir::interpret::{ConstEvalErr, ErrorHandled, ScalarMaybeUndef};
  14 use rustc::mir;
  15 use rustc::ty::{self, Ty, TyCtxt, subst::Subst};
  16 use rustc::ty::layout::{self, LayoutOf, VariantIdx};
  17 use rustc::traits::Reveal;
  18 use rustc_data_structures::fx::FxHashMap;
  19 use crate::interpret::eval_nullary_intrinsic;
  20
  21 use syntax::{source_map::{Span, DUMMY_SP}, symbol::Symbol};
  22
  23 use crate::interpret::{self,
  24     PlaceTy, MPlaceTy, OpTy, ImmTy, Immediate, Scalar, Pointer,
  25     RawConst, ConstValue, Machine,
  26     InterpResult, InterpErrorInfo, GlobalId, InterpCx, StackPopCleanup,
  27     Allocation, AllocId, MemoryKind, Memory,
  28     snapshot, RefTracking, intern_const_alloc_recursive,
  29 };
  30
  31 /// Number of steps until the detector even starts doing anything.
  32 /// Also, a warning is shown to the user when this number is reached.
  33 const STEPS_UNTIL_DETECTOR_ENABLED: isize = 1_000_000;
  34 /// The number of steps between loop detector snapshots.
  35 /// Should be a power of two for performance reasons.
  36 const DETECTOR_SNAPSHOT_PERIOD: isize = 256;
  37
  38 /// The `InterpCx` is only meant to be used to do field and index projections into constants for
  39 /// `simd_shuffle` and const patterns in match arms.
  40 ///
  41 /// The function containing the `match` that is currently being analyzed may have generic bounds
  42 /// that inform us about the generic bounds of the constant. E.g., using an associated constant
  43 /// of a function's generic parameter will require knowledge about the bounds on the generic
  44 /// parameter. These bounds are passed to `mk_eval_cx` via the `ParamEnv` argument.
  45 fn mk_eval_cx<'mir, 'tcx>(
  46     tcx: TyCtxt<'tcx>,
  47     span: Span,
  48     param_env: ty::ParamEnv<'tcx>,
  49 ) -> CompileTimeEvalContext<'mir, 'tcx> {
  50     debug!("mk_eval_cx: {:?}", param_env);
  51     InterpCx::new(tcx.at(span), param_env, CompileTimeInterpreter::new(), Default::default())
  52 }
  53
  54 fn op_to_const<'tcx>(
  55     ecx: &CompileTimeEvalContext<'_, 'tcx>,
  56     op: OpTy<'tcx>,
  57 ) -> &'tcx ty::Const<'tcx> {
  58     // We do not have value optmizations for everything.
  59     // Only scalars and slices, since they are very common.
  60     // Note that further down we turn scalars of undefined bits back to `ByRef`. These can result
  61     // from scalar unions that are initialized with one of their zero sized variants. We could
  62     // instead allow `ConstValue::Scalar` to store `ScalarMaybeUndef`, but that would affect all
  63     // the usual cases of extracting e.g. a `usize`, without there being a real use case for the
  64     // `Undef` situation.
  65     let try_as_immediate = match op.layout.abi {
  66         layout::Abi::Scalar(..) => true,
  67         layout::Abi::ScalarPair(..) => match op.layout.ty.kind {
  68             ty::Ref(_, inner, _) => match inner.kind {
  69                 ty::Slice(elem) => elem == ecx.tcx.types.u8,
  70                 ty::Str => true,
  71                 _ => false,
  72             },
  73             _ => false,
  74         },
  75         _ => false,
  76     };
  77     let immediate = if try_as_immediate {
  78         Err(ecx.read_immediate(op).expect("normalization works on validated constants"))
  79     } else {
  80         // It is guaranteed that any non-slice scalar pair is actually ByRef here.
  81         // When we come back from raw const eval, we are always by-ref. The only way our op here is
  82         // by-val is if we are in const_field, i.e., if this is (a field of) something that we
  83         // "tried to make immediate" before. We wouldn't do that for non-slice scalar pairs or
  84         // structs containing such.
  85         op.try_as_mplace()
  86     };
  87     let val = match immediate {
  88         Ok(mplace) => {
  89             let ptr = mplace.ptr.to_ptr().unwrap();
  90             let alloc = ecx.tcx.alloc_map.lock().unwrap_memory(ptr.alloc_id);
  91             ConstValue::ByRef { alloc, offset: ptr.offset }
  92         },
  93         // see comment on `let try_as_immediate` above
  94         Err(ImmTy { imm: Immediate::Scalar(x), .. }) => match x {
  95             ScalarMaybeUndef::Scalar(s) => ConstValue::Scalar(s),
  96             ScalarMaybeUndef::Undef => {
  97                 // When coming out of "normal CTFE", we'll always have an `Indirect` operand as
  98                 // argument and we will not need this. The only way we can already have an
  99                 // `Immediate` is when we are called from `const_field`, and that `Immediate`
 100                 // comes from a constant so it can happen have `Undef`, because the indirect
 101                 // memory that was read had undefined bytes.
 102                 let mplace = op.assert_mem_place();
 103                 let ptr = mplace.ptr.to_ptr().unwrap();
 104                 let alloc = ecx.tcx.alloc_map.lock().unwrap_memory(ptr.alloc_id);
 105                 ConstValue::ByRef { alloc, offset: ptr.offset }
 106             },
 107         },
 108         Err(ImmTy { imm: Immediate::ScalarPair(a, b), .. }) => {
 109             let (data, start) = match a.not_undef().unwrap() {
 110                 Scalar::Ptr(ptr) => (
 111                     ecx.tcx.alloc_map.lock().unwrap_memory(ptr.alloc_id),
 112                     ptr.offset.bytes(),
 113                 ),
 114                 Scalar::Raw { .. } => (
 115                     ecx.tcx.intern_const_alloc(Allocation::from_byte_aligned_bytes(
 116                         b"" as &[u8],
 117                     )),
 118                     0,
 119                 ),
 120             };
 121             let len = b.to_usize(&ecx.tcx.tcx).unwrap();
 122             let start = start.try_into().unwrap();
 123             let len: usize = len.try_into().unwrap();
 124             ConstValue::Slice {
 125                 data,
 126                 start,
 127                 end: start + len,
 128             }
 129         },
 130     };
 131     ecx.tcx.mk_const(ty::Const { val, ty: op.layout.ty })
 132 }
 133
 134 // Returns a pointer to where the result lives
 135 fn eval_body_using_ecx<'mir, 'tcx>(
 136     ecx: &mut CompileTimeEvalContext<'mir, 'tcx>,
 137     cid: GlobalId<'tcx>,
 138     body: &'mir mir::Body<'tcx>,
 139 ) -> InterpResult<'tcx, MPlaceTy<'tcx>> {
 140     debug!("eval_body_using_ecx: {:?}, {:?}", cid, ecx.param_env);
 141     let tcx = ecx.tcx.tcx;
 142     let layout = ecx.layout_of(body.return_ty().subst(tcx, cid.instance.substs))?;
 143     assert!(!layout.is_unsized());
 144     let ret = ecx.allocate(layout, MemoryKind::Stack);
 145
 146     let name = ty::tls::with(|tcx| tcx.def_path_str(cid.instance.def_id()));
 147     let prom = cid.promoted.map_or(String::new(), |p| format!("::promoted[{:?}]", p));
 148     trace!("eval_body_using_ecx: pushing stack frame for global: {}{}", name, prom);
 149     assert!(body.arg_count == 0);
 150     ecx.push_stack_frame(
 151         cid.instance,
 152         body.span,
 153         body,
 154         Some(ret.into()),
 155         StackPopCleanup::None { cleanup: false },
 156     )?;
 157
 158     // The main interpreter loop.
 159     ecx.run()?;
 160
 161     // Intern the result
 162     intern_const_alloc_recursive(ecx, tcx.static_mutability(cid.instance.def_id()), ret)?;
 163
 164     debug!("eval_body_using_ecx done: {:?}", *ret);
 165     Ok(ret)
 166 }
 167
 168 #[derive(Clone, Debug)]
 169 pub enum ConstEvalError {
 170     NeedsRfc(String),
 171 }
 172
 173 impl<'tcx> Into<InterpErrorInfo<'tcx>> for ConstEvalError {
 174     fn into(self) -> InterpErrorInfo<'tcx> {
 175         err_unsup!(Unsupported(self.to_string())).into()
 176     }
 177 }
 178
 179 impl fmt::Display for ConstEvalError {
 180     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 181         use self::ConstEvalError::*;
 182         match *self {
 183             NeedsRfc(ref msg) => {
 184                 write!(
 185                     f,
 186                     "\"{}\" needs an rfc before being allowed inside constants",
 187                     msg
 188                 )
 189             }
 190         }
 191     }
 192 }
 193
 194 impl Error for ConstEvalError {
 195     fn description(&self) -> &str {
 196         use self::ConstEvalError::*;
 197         match *self {
 198             NeedsRfc(_) => "this feature needs an rfc before being allowed inside constants",
 199         }
 200     }
 201
 202     fn cause(&self) -> Option<&dyn Error> {
 203         None
 204     }
 205 }
 206
 207 // Extra machine state for CTFE, and the Machine instance
 208 pub struct CompileTimeInterpreter<'mir, 'tcx> {
 209     /// When this value is negative, it indicates the number of interpreter
 210     /// steps *until* the loop detector is enabled. When it is positive, it is
 211     /// the number of steps after the detector has been enabled modulo the loop
 212     /// detector period.
 213     pub(super) steps_since_detector_enabled: isize,
 214
 215     /// Extra state to detect loops.
 216     pub(super) loop_detector: snapshot::InfiniteLoopDetector<'mir, 'tcx>,
 217 }
 218
 219 impl<'mir, 'tcx> CompileTimeInterpreter<'mir, 'tcx> {
 220     fn new() -> Self {
 221         CompileTimeInterpreter {
 222             loop_detector: Default::default(),
 223             steps_since_detector_enabled: -STEPS_UNTIL_DETECTOR_ENABLED,
 224         }
 225     }
 226 }
 227
 228 impl<K: Hash + Eq, V> interpret::AllocMap<K, V> for FxHashMap<K, V> {
 229     #[inline(always)]
 230     fn contains_key<Q: ?Sized + Hash + Eq>(&mut self, k: &Q) -> bool
 231         where K: Borrow<Q>
 232     {
 233         FxHashMap::contains_key(self, k)
 234     }
 235
 236     #[inline(always)]
 237     fn insert(&mut self, k: K, v: V) -> Option<V>
 238     {
 239         FxHashMap::insert(self, k, v)
 240     }
 241
 242     #[inline(always)]
 243     fn remove<Q: ?Sized + Hash + Eq>(&mut self, k: &Q) -> Option<V>
 244         where K: Borrow<Q>
 245     {
 246         FxHashMap::remove(self, k)
 247     }
 248
 249     #[inline(always)]
 250     fn filter_map_collect<T>(&self, mut f: impl FnMut(&K, &V) -> Option<T>) -> Vec<T> {
 251         self.iter()
 252             .filter_map(move |(k, v)| f(k, &*v))
 253             .collect()
 254     }
 255
 256     #[inline(always)]
 257     fn get_or<E>(
 258         &self,
 259         k: K,
 260         vacant: impl FnOnce() -> Result<V, E>
 261     ) -> Result<&V, E>
 262     {
 263         match self.get(&k) {
 264             Some(v) => Ok(v),
 265             None => {
 266                 vacant()?;
 267                 bug!("The CTFE machine shouldn't ever need to extend the alloc_map when reading")
 268             }
 269         }
 270     }
 271
 272     #[inline(always)]
 273     fn get_mut_or<E>(
 274         &mut self,
 275         k: K,
 276         vacant: impl FnOnce() -> Result<V, E>
 277     ) -> Result<&mut V, E>
 278     {
 279         match self.entry(k) {
 280             Entry::Occupied(e) => Ok(e.into_mut()),
 281             Entry::Vacant(e) => {
 282                 let v = vacant()?;
 283                 Ok(e.insert(v))
 284             }
 285         }
 286     }
 287 }
 288
 289 crate type CompileTimeEvalContext<'mir, 'tcx> =
 290     InterpCx<'mir, 'tcx, CompileTimeInterpreter<'mir, 'tcx>>;
 291
 292 impl interpret::MayLeak for ! {
 293     #[inline(always)]
 294     fn may_leak(self) -> bool {
 295         // `self` is uninhabited
 296         self
 297     }
 298 }
 299
 300 impl<'mir, 'tcx> interpret::Machine<'mir, 'tcx> for CompileTimeInterpreter<'mir, 'tcx> {
 301     type MemoryKinds = !;
 302     type PointerTag = ();
 303     type ExtraFnVal = !;
 304
 305     type FrameExtra = ();
 306     type MemoryExtra = ();
 307     type AllocExtra = ();
 308
 309     type MemoryMap = FxHashMap<AllocId, (MemoryKind<!>, Allocation)>;
 310
 311     const STATIC_KIND: Option<!> = None; // no copying of statics allowed
 312
 313     // We do not check for alignment to avoid having to carry an `Align`
 314     // in `ConstValue::ByRef`.
 315     const CHECK_ALIGN: bool = false;
 316
 317     #[inline(always)]
 318     fn enforce_validity(_ecx: &InterpCx<'mir, 'tcx, Self>) -> bool {
 319         false // for now, we don't enforce validity
 320     }
 321
 322     fn find_fn(
 323         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 324         instance: ty::Instance<'tcx>,
 325         args: &[OpTy<'tcx>],
 326         dest: Option<PlaceTy<'tcx>>,
 327         ret: Option<mir::BasicBlock>,
 328     ) -> InterpResult<'tcx, Option<&'mir mir::Body<'tcx>>> {
 329         debug!("eval_fn_call: {:?}", instance);
 330         // Only check non-glue functions
 331         if let ty::InstanceDef::Item(def_id) = instance.def {
 332             // Execution might have wandered off into other crates, so we cannot do a stability-
 333             // sensitive check here.  But we can at least rule out functions that are not const
 334             // at all.
 335             if !ecx.tcx.is_const_fn_raw(def_id) {
 336                 // Some functions we support even if they are non-const -- but avoid testing
 337                 // that for const fn!  We certainly do *not* want to actually call the fn
 338                 // though, so be sure we return here.
 339                 return if ecx.hook_fn(instance, args, dest)? {
 340                     ecx.goto_block(ret)?; // fully evaluated and done
 341                     Ok(None)
 342                 } else {
 343                     throw_unsup_format!("calling non-const function `{}`", instance)
 344                 };
 345             }
 346         }
 347         // This is a const fn. Call it.
 348         Ok(Some(match ecx.load_mir(instance.def, None) {
 349             Ok(body) => body,
 350             Err(err) => {
 351                 if let err_unsup!(NoMirFor(ref path)) = err.kind {
 352                     return Err(
 353                         ConstEvalError::NeedsRfc(format!("calling extern function `{}`", path))
 354                             .into(),
 355                     );
 356                 }
 357                 return Err(err);
 358             }
 359         }))
 360     }
 361
 362     fn call_extra_fn(
 363         _ecx: &mut InterpCx<'mir, 'tcx, Self>,
 364         fn_val: !,
 365         _args: &[OpTy<'tcx>],
 366         _dest: Option<PlaceTy<'tcx>>,
 367         _ret: Option<mir::BasicBlock>,
 368     ) -> InterpResult<'tcx> {
 369         match fn_val {}
 370     }
 371
 372     fn call_intrinsic(
 373         ecx: &mut InterpCx<'mir, 'tcx, Self>,
 374         span: Span,
 375         instance: ty::Instance<'tcx>,
 376         args: &[OpTy<'tcx>],
 377         dest: PlaceTy<'tcx>,
 378     ) -> InterpResult<'tcx> {
 379         if ecx.emulate_intrinsic(span, instance, args, dest)? {
 380             return Ok(());
 381         }
 382         // An intrinsic that we do not support
 383         let intrinsic_name = ecx.tcx.item_name(instance.def_id());
 384         Err(
 385             ConstEvalError::NeedsRfc(format!("calling intrinsic `{}`", intrinsic_name)).into()
 386         )
 387     }
 388
 389     fn ptr_to_int(
 390         _mem: &Memory<'mir, 'tcx, Self>,
 391         _ptr: Pointer,
 392     ) -> InterpResult<'tcx, u64> {
 393         Err(
 394             ConstEvalError::NeedsRfc("pointer-to-integer cast".to_string()).into(),
 395         )
 396     }
 397
 398     fn binary_ptr_op(
 399         _ecx: &InterpCx<'mir, 'tcx, Self>,
 400         _bin_op: mir::BinOp,
 401         _left: ImmTy<'tcx>,
 402         _right: ImmTy<'tcx>,
 403     ) -> InterpResult<'tcx, (Scalar, bool, Ty<'tcx>)> {
 404         Err(
 405             ConstEvalError::NeedsRfc("pointer arithmetic or comparison".to_string()).into(),
 406         )
 407     }
 408
 409     fn find_foreign_static(
 410         _tcx: TyCtxt<'tcx>,
 411         _def_id: DefId,
 412     ) -> InterpResult<'tcx, Cow<'tcx, Allocation<Self::PointerTag>>> {
 413         throw_unsup!(ReadForeignStatic)
 414     }
 415
 416     #[inline(always)]
 417     fn tag_allocation<'b>(
 418         _memory_extra: &(),
 419         _id: AllocId,
 420         alloc: Cow<'b, Allocation>,
 421         _kind: Option<MemoryKind<!>>,
 422     ) -> (Cow<'b, Allocation<Self::PointerTag>>, Self::PointerTag) {
 423         // We do not use a tag so we can just cheaply forward the allocation
 424         (alloc, ())
 425     }
 426
 427     #[inline(always)]
 428     fn tag_static_base_pointer(
 429         _memory_extra: &(),
 430         _id: AllocId,
 431     ) -> Self::PointerTag {
 432         ()
 433     }
 434
 435     fn box_alloc(
 436         _ecx: &mut InterpCx<'mir, 'tcx, Self>,
 437         _dest: PlaceTy<'tcx>,
 438     ) -> InterpResult<'tcx> {
 439         Err(
 440             ConstEvalError::NeedsRfc("heap allocations via `box` keyword".to_string()).into(),
 441         )
 442     }
 443
 444     fn before_terminator(ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx> {
 445         {
 446             let steps = &mut ecx.machine.steps_since_detector_enabled;
 447
 448             *steps += 1;
 449             if *steps < 0 {
 450                 return Ok(());
 451             }
 452
 453             *steps %= DETECTOR_SNAPSHOT_PERIOD;
 454             if *steps != 0 {
 455                 return Ok(());
 456             }
 457         }
 458
 459         let span = ecx.frame().span;
 460         ecx.machine.loop_detector.observe_and_analyze(
 461             *ecx.tcx,
 462             span,
 463             &ecx.memory,
 464             &ecx.stack[..],
 465         )
 466     }
 467
 468     #[inline(always)]
 469     fn stack_push(_ecx: &mut InterpCx<'mir, 'tcx, Self>) -> InterpResult<'tcx> {
 470         Ok(())
 471     }
 472
 473     /// Called immediately before a stack frame gets popped.
 474     #[inline(always)]
 475     fn stack_pop(_ecx: &mut InterpCx<'mir, 'tcx, Self>, _extra: ()) -> InterpResult<'tcx> {
 476         Ok(())
 477     }
 478 }
 479
 480 /// Extracts a field of a (variant of a) const.
 481 // this function uses `unwrap` copiously, because an already validated constant must have valid
 482 // fields and can thus never fail outside of compiler bugs
 483 pub fn const_field<'tcx>(
 484     tcx: TyCtxt<'tcx>,
 485     param_env: ty::ParamEnv<'tcx>,
 486     variant: Option<VariantIdx>,
 487     field: mir::Field,
 488     value: &'tcx ty::Const<'tcx>,
 489 ) -> &'tcx ty::Const<'tcx> {
 490     trace!("const_field: {:?}, {:?}", field, value);
 491     let ecx = mk_eval_cx(tcx, DUMMY_SP, param_env);
 492     // get the operand again
 493     let op = ecx.eval_const_to_op(value, None).unwrap();
 494     // downcast
 495     let down = match variant {
 496         None => op,
 497         Some(variant) => ecx.operand_downcast(op, variant).unwrap(),
 498     };
 499     // then project
 500     let field = ecx.operand_field(down, field.index() as u64).unwrap();
 501     // and finally move back to the const world, always normalizing because
 502     // this is not called for statics.
 503     op_to_const(&ecx, field)
 504 }
 505
 506 pub fn const_caller_location<'tcx>(
 507     tcx: TyCtxt<'tcx>,
 508     (file, line, col): (Symbol, u32, u32),
 509 ) -> &'tcx ty::Const<'tcx> {
 510     trace!("const_caller_location: {}:{}:{}", file, line, col);
 511     let mut ecx = mk_eval_cx(tcx, DUMMY_SP, ty::ParamEnv::reveal_all());
 512
 513     let loc_ty = tcx.mk_imm_ref(
 514         tcx.lifetimes.re_static,
 515         tcx.type_of(tcx.require_lang_item(PanicLocationLangItem, None))
 516             .subst(tcx, tcx.mk_substs([tcx.lifetimes.re_static.into()].iter())),
 517     );
 518     let loc_place = ecx.alloc_caller_location(file, line, col).unwrap();
 519     intern_const_alloc_recursive(&mut ecx, None, loc_place).unwrap();
 520     let loc_const = ty::Const {
 521         ty: loc_ty,
 522         val: ConstValue::Scalar(loc_place.ptr.into()),
 523     };
 524
 525     tcx.mk_const(loc_const)
 526 }
 527
 528 // this function uses `unwrap` copiously, because an already validated constant must have valid
 529 // fields and can thus never fail outside of compiler bugs
 530 pub fn const_variant_index<'tcx>(
 531     tcx: TyCtxt<'tcx>,
 532     param_env: ty::ParamEnv<'tcx>,
 533     val: &'tcx ty::Const<'tcx>,
 534 ) -> VariantIdx {
 535     trace!("const_variant_index: {:?}", val);
 536     let ecx = mk_eval_cx(tcx, DUMMY_SP, param_env);
 537     let op = ecx.eval_const_to_op(val, None).unwrap();
 538     ecx.read_discriminant(op).unwrap().1
 539 }
 540
 541 /// Turn an interpreter error into something to report to the user.
 542 /// As a side-effect, if RUSTC_CTFE_BACKTRACE is set, this prints the backtrace.
 543 /// Should be called only if the error is actually going to to be reported!
 544 pub fn error_to_const_error<'mir, 'tcx, M: Machine<'mir, 'tcx>>(
 545     ecx: &InterpCx<'mir, 'tcx, M>,
 546     mut error: InterpErrorInfo<'tcx>,
 547 ) -> ConstEvalErr<'tcx> {
 548     error.print_backtrace();
 549     let stacktrace = ecx.generate_stacktrace(None);
 550     ConstEvalErr { error: error.kind, stacktrace, span: ecx.tcx.span }
 551 }
 552
 553 pub fn note_on_undefined_behavior_error() -> &'static str {
 554     "The rules on what exactly is undefined behavior aren't clear, \
 555      so this check might be overzealous. Please open an issue on the rustc \
 556      repository if you believe it should not be considered undefined behavior."
 557 }
 558
 559 fn validate_and_turn_into_const<'tcx>(
 560     tcx: TyCtxt<'tcx>,
 561     constant: RawConst<'tcx>,
 562     key: ty::ParamEnvAnd<'tcx, GlobalId<'tcx>>,
 563 ) -> ::rustc::mir::interpret::ConstEvalResult<'tcx> {
 564     let cid = key.value;
 565     let ecx = mk_eval_cx(tcx, tcx.def_span(key.value.instance.def_id()), key.param_env);
 566     let val = (|| {
 567         let mplace = ecx.raw_const_to_mplace(constant)?;
 568         let mut ref_tracking = RefTracking::new(mplace);
 569         while let Some((mplace, path)) = ref_tracking.todo.pop() {
 570             ecx.validate_operand(
 571                 mplace.into(),
 572                 path,
 573                 Some(&mut ref_tracking),
 574             )?;
 575         }
 576         // Now that we validated, turn this into a proper constant.
 577         // Statics/promoteds are always `ByRef`, for the rest `op_to_const` decides
 578         // whether they become immediates.
 579         let def_id = cid.instance.def.def_id();
 580         if tcx.is_static(def_id) || cid.promoted.is_some() {
 581             let ptr = mplace.ptr.to_ptr()?;
 582             Ok(tcx.mk_const(ty::Const {
 583                 val: ConstValue::ByRef {
 584                     alloc: ecx.tcx.alloc_map.lock().unwrap_memory(ptr.alloc_id),
 585                     offset: ptr.offset,
 586                 },
 587                 ty: mplace.layout.ty,
 588             }))
 589         } else {
 590             Ok(op_to_const(&ecx, mplace.into()))
 591         }
 592     })();
 593
 594     val.map_err(|error| {
 595         let err = error_to_const_error(&ecx, error);
 596         match err.struct_error(ecx.tcx, "it is undefined behavior to use this value") {
 597             Ok(mut diag) => {
 598                 diag.note(note_on_undefined_behavior_error());
 599                 diag.emit();
 600                 ErrorHandled::Reported
 601             }
 602             Err(err) => err,
 603         }
 604     })
 605 }
 606
 607 pub fn const_eval_provider<'tcx>(
 608     tcx: TyCtxt<'tcx>,
 609     key: ty::ParamEnvAnd<'tcx, GlobalId<'tcx>>,
 610 ) -> ::rustc::mir::interpret::ConstEvalResult<'tcx> {
 611     // see comment in const_eval_raw_provider for what we're doing here
 612     if key.param_env.reveal == Reveal::All {
 613         let mut key = key.clone();
 614         key.param_env.reveal = Reveal::UserFacing;
 615         match tcx.const_eval(key) {
 616             // try again with reveal all as requested
 617             Err(ErrorHandled::TooGeneric) => {
 618                 // Promoteds should never be "too generic" when getting evaluated.
 619                 // They either don't get evaluated, or we are in a monomorphic context
 620                 assert!(key.value.promoted.is_none());
 621             },
 622             // dedupliate calls
 623             other => return other,
 624         }
 625     }
 626
 627     // We call `const_eval` for zero arg intrinsics, too, in order to cache their value.
 628     // Catch such calls and evaluate them instead of trying to load a constant's MIR.
 629     if let ty::InstanceDef::Intrinsic(def_id) = key.value.instance.def {
 630         let ty = key.value.instance.ty(tcx);
 631         let substs = match ty.kind {
 632             ty::FnDef(_, substs) => substs,
 633             _ => bug!("intrinsic with type {:?}", ty),
 634         };
 635         return eval_nullary_intrinsic(tcx, key.param_env, def_id, substs)
 636             .map_err(|error| {
 637                 let span = tcx.def_span(def_id);
 638                 let error = ConstEvalErr { error: error.kind, stacktrace: vec![], span };
 639                 error.report_as_error(tcx.at(span), "could not evaluate nullary intrinsic")
 640             })
 641     }
 642
 643     tcx.const_eval_raw(key).and_then(|val| {
 644         validate_and_turn_into_const(tcx, val, key)
 645     })
 646 }
 647
 648 pub fn const_eval_raw_provider<'tcx>(
 649     tcx: TyCtxt<'tcx>,
 650     key: ty::ParamEnvAnd<'tcx, GlobalId<'tcx>>,
 651 ) -> ::rustc::mir::interpret::ConstEvalRawResult<'tcx> {
 652     // Because the constant is computed twice (once per value of `Reveal`), we are at risk of
 653     // reporting the same error twice here. To resolve this, we check whether we can evaluate the
 654     // constant in the more restrictive `Reveal::UserFacing`, which most likely already was
 655     // computed. For a large percentage of constants that will already have succeeded. Only
 656     // associated constants of generic functions will fail due to not enough monomorphization
 657     // information being available.
 658
 659     // In case we fail in the `UserFacing` variant, we just do the real computation.
 660     if key.param_env.reveal == Reveal::All {
 661         let mut key = key.clone();
 662         key.param_env.reveal = Reveal::UserFacing;
 663         match tcx.const_eval_raw(key) {
 664             // try again with reveal all as requested
 665             Err(ErrorHandled::TooGeneric) => {},
 666             // dedupliate calls
 667             other => return other,
 668         }
 669     }
 670     if cfg!(debug_assertions) {
 671         // Make sure we format the instance even if we do not print it.
 672         // This serves as a regression test against an ICE on printing.
 673         // The next two lines concatenated contain some discussion:
 674         // https://rust-lang.zulipchat.com/#narrow/stream/146212-t-compiler.2Fconst-eval/
 675         // subject/anon_const_instance_printing/near/135980032
 676         let instance = key.value.instance.to_string();
 677         trace!("const eval: {:?} ({})", key, instance);
 678     }
 679
 680     let cid = key.value;
 681     let def_id = cid.instance.def.def_id();
 682
 683     if def_id.is_local() && tcx.typeck_tables_of(def_id).tainted_by_errors {
 684         return Err(ErrorHandled::Reported);
 685     }
 686
 687     let span = tcx.def_span(cid.instance.def_id());
 688     let mut ecx = InterpCx::new(
 689         tcx.at(span),
 690         key.param_env,
 691         CompileTimeInterpreter::new(),
 692         Default::default()
 693     );
 694
 695     let res = ecx.load_mir(cid.instance.def, cid.promoted);
 696     res.and_then(
 697         |body| eval_body_using_ecx(&mut ecx, cid, body)
 698     ).and_then(|place| {
 699         Ok(RawConst {
 700             alloc_id: place.ptr.assert_ptr().alloc_id,
 701             ty: place.layout.ty
 702         })
 703     }).map_err(|error| {
 704         let err = error_to_const_error(&ecx, error);
 705         // errors in statics are always emitted as fatal errors
 706         if tcx.is_static(def_id) {
 707             // Ensure that if the above error was either `TooGeneric` or `Reported`
 708             // an error must be reported.
 709             let v = err.report_as_error(ecx.tcx, "could not evaluate static initializer");
 710             tcx.sess.delay_span_bug(
 711                 err.span,
 712                 &format!("static eval failure did not emit an error: {:#?}", v)
 713             );
 714             v
 715         } else if def_id.is_local() {
 716             // constant defined in this crate, we can figure out a lint level!
 717             match tcx.def_kind(def_id) {
 718                 // constants never produce a hard error at the definition site. Anything else is
 719                 // a backwards compatibility hazard (and will break old versions of winapi for sure)
 720                 //
 721                 // note that validation may still cause a hard error on this very same constant,
 722                 // because any code that existed before validation could not have failed validation
 723                 // thus preventing such a hard error from being a backwards compatibility hazard
 724                 Some(DefKind::Const) | Some(DefKind::AssocConst) => {
 725                     let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
 726                     err.report_as_lint(
 727                         tcx.at(tcx.def_span(def_id)),
 728                         "any use of this value will cause an error",
 729                         hir_id,
 730                         Some(err.span),
 731                     )
 732                 },
 733                 // promoting runtime code is only allowed to error if it references broken constants
 734                 // any other kind of error will be reported to the user as a deny-by-default lint
 735                 _ => if let Some(p) = cid.promoted {
 736                     let span = tcx.promoted_mir(def_id)[p].span;
 737                     if let err_inval!(ReferencedConstant) = err.error {
 738                         err.report_as_error(
 739                             tcx.at(span),
 740                             "evaluation of constant expression failed",
 741                         )
 742                     } else {
 743                         err.report_as_lint(
 744                             tcx.at(span),
 745                             "reaching this expression at runtime will panic or abort",
 746                             tcx.hir().as_local_hir_id(def_id).unwrap(),
 747                             Some(err.span),
 748                         )
 749                     }
 750                 // anything else (array lengths, enum initializers, constant patterns) are reported
 751                 // as hard errors
 752                 } else {
 753                     err.report_as_error(
 754                         ecx.tcx,
 755                         "evaluation of constant value failed",
 756                     )
 757                 },
 758             }
 759         } else {
 760             // use of broken constant from other crate
 761             err.report_as_error(ecx.tcx, "could not evaluate constant")
 762         }
 763     })
 764 }