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