compiler/rustc_infer/src/infer/mod.rs

   1 pub use self::freshen::TypeFreshener;
   2 pub use self::lexical_region_resolve::RegionResolutionError;
   3 pub use self::LateBoundRegionConversionTime::*;
   4 pub use self::RegionVariableOrigin::*;
   5 pub use self::SubregionOrigin::*;
   6 pub use self::ValuePairs::*;
   7
   8 use self::opaque_types::OpaqueTypeStorage;
   9 pub(crate) use self::undo_log::{InferCtxtUndoLogs, Snapshot, UndoLog};
  10
  11 use crate::traits::{self, ObligationCause, PredicateObligations, TraitEngine, TraitEngineExt};
  12
  13 use rustc_data_structures::fx::FxIndexMap;
  14 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  15 use rustc_data_structures::sync::Lrc;
  16 use rustc_data_structures::undo_log::Rollback;
  17 use rustc_data_structures::unify as ut;
  18 use rustc_errors::{DiagnosticBuilder, ErrorGuaranteed};
  19 use rustc_hir::def_id::{DefId, LocalDefId};
  20 use rustc_middle::infer::canonical::{Canonical, CanonicalVarValues};
  21 use rustc_middle::infer::unify_key::{ConstVarValue, ConstVariableValue};
  22 use rustc_middle::infer::unify_key::{ConstVariableOrigin, ConstVariableOriginKind, ToType};
  23 use rustc_middle::mir::interpret::{ErrorHandled, EvalToValTreeResult};
  24 use rustc_middle::mir::ConstraintCategory;
  25 use rustc_middle::traits::select;
  26 use rustc_middle::ty::error::{ExpectedFound, TypeError};
  27 use rustc_middle::ty::fold::BoundVarReplacerDelegate;
  28 use rustc_middle::ty::fold::{TypeFoldable, TypeFolder, TypeSuperFoldable};
  29 use rustc_middle::ty::relate::RelateResult;
  30 use rustc_middle::ty::subst::{GenericArg, GenericArgKind, InternalSubsts, SubstsRef};
  31 use rustc_middle::ty::visit::TypeVisitable;
  32 pub use rustc_middle::ty::IntVarValue;
  33 use rustc_middle::ty::{self, GenericParamDefKind, InferConst, Ty, TyCtxt};
  34 use rustc_middle::ty::{ConstVid, FloatVid, IntVid, TyVid};
  35 use rustc_span::symbol::Symbol;
  36 use rustc_span::Span;
  37
  38 use std::cell::{Cell, RefCell};
  39 use std::fmt;
  40
  41 use self::combine::CombineFields;
  42 use self::error_reporting::TypeErrCtxt;
  43 use self::free_regions::RegionRelations;
  44 use self::lexical_region_resolve::LexicalRegionResolutions;
  45 use self::outlives::env::OutlivesEnvironment;
  46 use self::region_constraints::{GenericKind, RegionConstraintData, VarInfos, VerifyBound};
  47 use self::region_constraints::{
  48     RegionConstraintCollector, RegionConstraintStorage, RegionSnapshot,
  49 };
  50 use self::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
  51
  52 pub mod at;
  53 pub mod canonical;
  54 mod combine;
  55 mod equate;
  56 pub mod error_reporting;
  57 pub mod free_regions;
  58 mod freshen;
  59 mod fudge;
  60 mod glb;
  61 mod higher_ranked;
  62 pub mod lattice;
  63 mod lexical_region_resolve;
  64 mod lub;
  65 pub mod nll_relate;
  66 pub mod opaque_types;
  67 pub mod outlives;
  68 mod projection;
  69 pub mod region_constraints;
  70 pub mod resolve;
  71 mod sub;
  72 pub mod type_variable;
  73 mod undo_log;
  74
  75 #[must_use]
  76 #[derive(Debug)]
  77 pub struct InferOk<'tcx, T> {
  78     pub value: T,
  79     pub obligations: PredicateObligations<'tcx>,
  80 }
  81 pub type InferResult<'tcx, T> = Result<InferOk<'tcx, T>, TypeError<'tcx>>;
  82
  83 pub type UnitResult<'tcx> = RelateResult<'tcx, ()>; // "unify result"
  84 pub type FixupResult<'tcx, T> = Result<T, FixupError<'tcx>>; // "fixup result"
  85
  86 pub(crate) type UnificationTable<'a, 'tcx, T> = ut::UnificationTable<
  87     ut::InPlace<T, &'a mut ut::UnificationStorage<T>, &'a mut InferCtxtUndoLogs<'tcx>>,
  88 >;
  89
  90 /// This type contains all the things within `InferCtxt` that sit within a
  91 /// `RefCell` and are involved with taking/rolling back snapshots. Snapshot
  92 /// operations are hot enough that we want only one call to `borrow_mut` per
  93 /// call to `start_snapshot` and `rollback_to`.
  94 #[derive(Clone)]
  95 pub struct InferCtxtInner<'tcx> {
  96     /// Cache for projections. This cache is snapshotted along with the infcx.
  97     ///
  98     /// Public so that `traits::project` can use it.
  99     pub projection_cache: traits::ProjectionCacheStorage<'tcx>,
 100
 101     /// We instantiate `UnificationTable` with `bounds<Ty>` because the types
 102     /// that might instantiate a general type variable have an order,
 103     /// represented by its upper and lower bounds.
 104     type_variable_storage: type_variable::TypeVariableStorage<'tcx>,
 105
 106     /// Map from const parameter variable to the kind of const it represents.
 107     const_unification_storage: ut::UnificationTableStorage<ty::ConstVid<'tcx>>,
 108
 109     /// Map from integral variable to the kind of integer it represents.
 110     int_unification_storage: ut::UnificationTableStorage<ty::IntVid>,
 111
 112     /// Map from floating variable to the kind of float it represents.
 113     float_unification_storage: ut::UnificationTableStorage<ty::FloatVid>,
 114
 115     /// Tracks the set of region variables and the constraints between them.
 116     /// This is initially `Some(_)` but when
 117     /// `resolve_regions_and_report_errors` is invoked, this gets set to `None`
 118     /// -- further attempts to perform unification, etc., may fail if new
 119     /// region constraints would've been added.
 120     region_constraint_storage: Option<RegionConstraintStorage<'tcx>>,
 121
 122     /// A set of constraints that regionck must validate. Each
 123     /// constraint has the form `T:'a`, meaning "some type `T` must
 124     /// outlive the lifetime 'a". These constraints derive from
 125     /// instantiated type parameters. So if you had a struct defined
 126     /// like
 127     /// ```ignore (illustrative)
 128     ///     struct Foo<T:'static> { ... }
 129     /// ```
 130     /// then in some expression `let x = Foo { ... }` it will
 131     /// instantiate the type parameter `T` with a fresh type `$0`. At
 132     /// the same time, it will record a region obligation of
 133     /// `$0:'static`. This will get checked later by regionck. (We
 134     /// can't generally check these things right away because we have
 135     /// to wait until types are resolved.)
 136     ///
 137     /// These are stored in a map keyed to the id of the innermost
 138     /// enclosing fn body / static initializer expression. This is
 139     /// because the location where the obligation was incurred can be
 140     /// relevant with respect to which sublifetime assumptions are in
 141     /// place. The reason that we store under the fn-id, and not
 142     /// something more fine-grained, is so that it is easier for
 143     /// regionck to be sure that it has found *all* the region
 144     /// obligations (otherwise, it's easy to fail to walk to a
 145     /// particular node-id).
 146     ///
 147     /// Before running `resolve_regions_and_report_errors`, the creator
 148     /// of the inference context is expected to invoke
 149     /// [`InferCtxt::process_registered_region_obligations`]
 150     /// for each body-id in this map, which will process the
 151     /// obligations within. This is expected to be done 'late enough'
 152     /// that all type inference variables have been bound and so forth.
 153     region_obligations: Vec<RegionObligation<'tcx>>,
 154
 155     undo_log: InferCtxtUndoLogs<'tcx>,
 156
 157     /// Caches for opaque type inference.
 158     pub opaque_type_storage: OpaqueTypeStorage<'tcx>,
 159 }
 160
 161 impl<'tcx> InferCtxtInner<'tcx> {
 162     fn new() -> InferCtxtInner<'tcx> {
 163         InferCtxtInner {
 164             projection_cache: Default::default(),
 165             type_variable_storage: type_variable::TypeVariableStorage::new(),
 166             undo_log: InferCtxtUndoLogs::default(),
 167             const_unification_storage: ut::UnificationTableStorage::new(),
 168             int_unification_storage: ut::UnificationTableStorage::new(),
 169             float_unification_storage: ut::UnificationTableStorage::new(),
 170             region_constraint_storage: Some(RegionConstraintStorage::new()),
 171             region_obligations: vec![],
 172             opaque_type_storage: Default::default(),
 173         }
 174     }
 175
 176     #[inline]
 177     pub fn region_obligations(&self) -> &[RegionObligation<'tcx>] {
 178         &self.region_obligations
 179     }
 180
 181     #[inline]
 182     pub fn projection_cache(&mut self) -> traits::ProjectionCache<'_, 'tcx> {
 183         self.projection_cache.with_log(&mut self.undo_log)
 184     }
 185
 186     #[inline]
 187     fn type_variables(&mut self) -> type_variable::TypeVariableTable<'_, 'tcx> {
 188         self.type_variable_storage.with_log(&mut self.undo_log)
 189     }
 190
 191     #[inline]
 192     pub fn opaque_types(&mut self) -> opaque_types::OpaqueTypeTable<'_, 'tcx> {
 193         self.opaque_type_storage.with_log(&mut self.undo_log)
 194     }
 195
 196     #[inline]
 197     fn int_unification_table(
 198         &mut self,
 199     ) -> ut::UnificationTable<
 200         ut::InPlace<
 201             ty::IntVid,
 202             &mut ut::UnificationStorage<ty::IntVid>,
 203             &mut InferCtxtUndoLogs<'tcx>,
 204         >,
 205     > {
 206         self.int_unification_storage.with_log(&mut self.undo_log)
 207     }
 208
 209     #[inline]
 210     fn float_unification_table(
 211         &mut self,
 212     ) -> ut::UnificationTable<
 213         ut::InPlace<
 214             ty::FloatVid,
 215             &mut ut::UnificationStorage<ty::FloatVid>,
 216             &mut InferCtxtUndoLogs<'tcx>,
 217         >,
 218     > {
 219         self.float_unification_storage.with_log(&mut self.undo_log)
 220     }
 221
 222     #[inline]
 223     fn const_unification_table(
 224         &mut self,
 225     ) -> ut::UnificationTable<
 226         ut::InPlace<
 227             ty::ConstVid<'tcx>,
 228             &mut ut::UnificationStorage<ty::ConstVid<'tcx>>,
 229             &mut InferCtxtUndoLogs<'tcx>,
 230         >,
 231     > {
 232         self.const_unification_storage.with_log(&mut self.undo_log)
 233     }
 234
 235     #[inline]
 236     pub fn unwrap_region_constraints(&mut self) -> RegionConstraintCollector<'_, 'tcx> {
 237         self.region_constraint_storage
 238             .as_mut()
 239             .expect("region constraints already solved")
 240             .with_log(&mut self.undo_log)
 241     }
 242 }
 243
 244 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
 245 pub enum DefiningAnchor {
 246     /// `DefId` of the item.
 247     Bind(LocalDefId),
 248     /// When opaque types are not resolved, we `Bubble` up, meaning
 249     /// return the opaque/hidden type pair from query, for caller of query to handle it.
 250     Bubble,
 251     /// Used to catch type mismatch errors when handling opaque types.
 252     Error,
 253 }
 254
 255 pub struct InferCtxt<'tcx> {
 256     pub tcx: TyCtxt<'tcx>,
 257
 258     /// The `DefId` of the item in whose context we are performing inference or typeck.
 259     /// It is used to check whether an opaque type use is a defining use.
 260     ///
 261     /// If it is `DefiningAnchor::Bubble`, we can't resolve opaque types here and need to bubble up
 262     /// the obligation. This frequently happens for
 263     /// short lived InferCtxt within queries. The opaque type obligations are forwarded
 264     /// to the outside until the end up in an `InferCtxt` for typeck or borrowck.
 265     ///
 266     /// It is default value is `DefiningAnchor::Error`, this way it is easier to catch errors that
 267     /// might come up during inference or typeck.
 268     pub defining_use_anchor: DefiningAnchor,
 269
 270     /// Whether this inference context should care about region obligations in
 271     /// the root universe. Most notably, this is used during hir typeck as region
 272     /// solving is left to borrowck instead.
 273     pub considering_regions: bool,
 274
 275     pub inner: RefCell<InferCtxtInner<'tcx>>,
 276
 277     /// If set, this flag causes us to skip the 'leak check' during
 278     /// higher-ranked subtyping operations. This flag is a temporary one used
 279     /// to manage the removal of the leak-check: for the time being, we still run the
 280     /// leak-check, but we issue warnings. This flag can only be set to true
 281     /// when entering a snapshot.
 282     skip_leak_check: Cell<bool>,
 283
 284     /// Once region inference is done, the values for each variable.
 285     lexical_region_resolutions: RefCell<Option<LexicalRegionResolutions<'tcx>>>,
 286
 287     /// Caches the results of trait selection. This cache is used
 288     /// for things that have to do with the parameters in scope.
 289     pub selection_cache: select::SelectionCache<'tcx>,
 290
 291     /// Caches the results of trait evaluation.
 292     pub evaluation_cache: select::EvaluationCache<'tcx>,
 293
 294     /// the set of predicates on which errors have been reported, to
 295     /// avoid reporting the same error twice.
 296     pub reported_trait_errors: RefCell<FxIndexMap<Span, Vec<ty::Predicate<'tcx>>>>,
 297
 298     pub reported_closure_mismatch: RefCell<FxHashSet<(Span, Option<Span>)>>,
 299
 300     /// When an error occurs, we want to avoid reporting "derived"
 301     /// errors that are due to this original failure. Normally, we
 302     /// handle this with the `err_count_on_creation` count, which
 303     /// basically just tracks how many errors were reported when we
 304     /// started type-checking a fn and checks to see if any new errors
 305     /// have been reported since then. Not great, but it works.
 306     ///
 307     /// However, when errors originated in other passes -- notably
 308     /// resolve -- this heuristic breaks down. Therefore, we have this
 309     /// auxiliary flag that one can set whenever one creates a
 310     /// type-error that is due to an error in a prior pass.
 311     ///
 312     /// Don't read this flag directly, call `is_tainted_by_errors()`
 313     /// and `set_tainted_by_errors()`.
 314     tainted_by_errors: Cell<Option<ErrorGuaranteed>>,
 315
 316     /// Track how many errors were reported when this infcx is created.
 317     /// If the number of errors increases, that's also a sign (line
 318     /// `tainted_by_errors`) to avoid reporting certain kinds of errors.
 319     // FIXME(matthewjasper) Merge into `tainted_by_errors`
 320     err_count_on_creation: usize,
 321
 322     /// This flag is true while there is an active snapshot.
 323     in_snapshot: Cell<bool>,
 324
 325     /// What is the innermost universe we have created? Starts out as
 326     /// `UniverseIndex::root()` but grows from there as we enter
 327     /// universal quantifiers.
 328     ///
 329     /// N.B., at present, we exclude the universal quantifiers on the
 330     /// item we are type-checking, and just consider those names as
 331     /// part of the root universe. So this would only get incremented
 332     /// when we enter into a higher-ranked (`for<..>`) type or trait
 333     /// bound.
 334     universe: Cell<ty::UniverseIndex>,
 335
 336     /// During coherence we have to assume that other crates may add
 337     /// additional impls which we currently don't know about.
 338     ///
 339     /// To deal with this evaluation should be conservative
 340     /// and consider the possibility of impls from outside this crate.
 341     /// This comes up primarily when resolving ambiguity. Imagine
 342     /// there is some trait reference `$0: Bar` where `$0` is an
 343     /// inference variable. If `intercrate` is true, then we can never
 344     /// say for sure that this reference is not implemented, even if
 345     /// there are *no impls at all for `Bar`*, because `$0` could be
 346     /// bound to some type that in a downstream crate that implements
 347     /// `Bar`.
 348     ///
 349     /// Outside of coherence we set this to false because we are only
 350     /// interested in types that the user could actually have written.
 351     /// In other words, we consider `$0: Bar` to be unimplemented if
 352     /// there is no type that the user could *actually name* that
 353     /// would satisfy it. This avoids crippling inference, basically.
 354     pub intercrate: bool,
 355 }
 356
 357 /// See the `error_reporting` module for more details.
 358 #[derive(Clone, Copy, Debug, PartialEq, Eq, TypeFoldable, TypeVisitable)]
 359 pub enum ValuePairs<'tcx> {
 360     Regions(ExpectedFound<ty::Region<'tcx>>),
 361     Terms(ExpectedFound<ty::Term<'tcx>>),
 362     TraitRefs(ExpectedFound<ty::TraitRef<'tcx>>),
 363     PolyTraitRefs(ExpectedFound<ty::PolyTraitRef<'tcx>>),
 364     Sigs(ExpectedFound<ty::FnSig<'tcx>>),
 365 }
 366
 367 impl<'tcx> ValuePairs<'tcx> {
 368     pub fn ty(&self) -> Option<(Ty<'tcx>, Ty<'tcx>)> {
 369         if let ValuePairs::Terms(ExpectedFound { expected, found }) = self
 370             && let Some(expected) = expected.ty()
 371             && let Some(found) = found.ty()
 372         {
 373             Some((expected, found))
 374         } else {
 375             None
 376         }
 377     }
 378 }
 379
 380 /// The trace designates the path through inference that we took to
 381 /// encounter an error or subtyping constraint.
 382 ///
 383 /// See the `error_reporting` module for more details.
 384 #[derive(Clone, Debug)]
 385 pub struct TypeTrace<'tcx> {
 386     pub cause: ObligationCause<'tcx>,
 387     pub values: ValuePairs<'tcx>,
 388 }
 389
 390 /// The origin of a `r1 <= r2` constraint.
 391 ///
 392 /// See `error_reporting` module for more details
 393 #[derive(Clone, Debug)]
 394 pub enum SubregionOrigin<'tcx> {
 395     /// Arose from a subtyping relation
 396     Subtype(Box<TypeTrace<'tcx>>),
 397
 398     /// When casting `&'a T` to an `&'b Trait` object,
 399     /// relating `'a` to `'b`
 400     RelateObjectBound(Span),
 401
 402     /// Some type parameter was instantiated with the given type,
 403     /// and that type must outlive some region.
 404     RelateParamBound(Span, Ty<'tcx>, Option<Span>),
 405
 406     /// The given region parameter was instantiated with a region
 407     /// that must outlive some other region.
 408     RelateRegionParamBound(Span),
 409
 410     /// Creating a pointer `b` to contents of another reference
 411     Reborrow(Span),
 412
 413     /// Data with type `Ty<'tcx>` was borrowed
 414     DataBorrowed(Ty<'tcx>, Span),
 415
 416     /// (&'a &'b T) where a >= b
 417     ReferenceOutlivesReferent(Ty<'tcx>, Span),
 418
 419     /// Comparing the signature and requirements of an impl method against
 420     /// the containing trait.
 421     CompareImplItemObligation {
 422         span: Span,
 423         impl_item_def_id: LocalDefId,
 424         trait_item_def_id: DefId,
 425     },
 426
 427     /// Checking that the bounds of a trait's associated type hold for a given impl
 428     CheckAssociatedTypeBounds {
 429         parent: Box<SubregionOrigin<'tcx>>,
 430         impl_item_def_id: LocalDefId,
 431         trait_item_def_id: DefId,
 432     },
 433
 434     AscribeUserTypeProvePredicate(Span),
 435 }
 436
 437 // `SubregionOrigin` is used a lot. Make sure it doesn't unintentionally get bigger.
 438 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
 439 static_assert_size!(SubregionOrigin<'_>, 32);
 440
 441 impl<'tcx> SubregionOrigin<'tcx> {
 442     pub fn to_constraint_category(&self) -> ConstraintCategory<'tcx> {
 443         match self {
 444             Self::Subtype(type_trace) => type_trace.cause.to_constraint_category(),
 445             Self::AscribeUserTypeProvePredicate(span) => ConstraintCategory::Predicate(*span),
 446             _ => ConstraintCategory::BoringNoLocation,
 447         }
 448     }
 449 }
 450
 451 /// Times when we replace late-bound regions with variables:
 452 #[derive(Clone, Copy, Debug)]
 453 pub enum LateBoundRegionConversionTime {
 454     /// when a fn is called
 455     FnCall,
 456
 457     /// when two higher-ranked types are compared
 458     HigherRankedType,
 459
 460     /// when projecting an associated type
 461     AssocTypeProjection(DefId),
 462 }
 463
 464 /// Reasons to create a region inference variable
 465 ///
 466 /// See `error_reporting` module for more details
 467 #[derive(Copy, Clone, Debug)]
 468 pub enum RegionVariableOrigin {
 469     /// Region variables created for ill-categorized reasons,
 470     /// mostly indicates places in need of refactoring
 471     MiscVariable(Span),
 472
 473     /// Regions created by a `&P` or `[...]` pattern
 474     PatternRegion(Span),
 475
 476     /// Regions created by `&` operator
 477     AddrOfRegion(Span),
 478
 479     /// Regions created as part of an autoref of a method receiver
 480     Autoref(Span),
 481
 482     /// Regions created as part of an automatic coercion
 483     Coercion(Span),
 484
 485     /// Region variables created as the values for early-bound regions
 486     EarlyBoundRegion(Span, Symbol),
 487
 488     /// Region variables created for bound regions
 489     /// in a function or method that is called
 490     LateBoundRegion(Span, ty::BoundRegionKind, LateBoundRegionConversionTime),
 491
 492     UpvarRegion(ty::UpvarId, Span),
 493
 494     /// This origin is used for the inference variables that we create
 495     /// during NLL region processing.
 496     Nll(NllRegionVariableOrigin),
 497 }
 498
 499 #[derive(Copy, Clone, Debug)]
 500 pub enum NllRegionVariableOrigin {
 501     /// During NLL region processing, we create variables for free
 502     /// regions that we encounter in the function signature and
 503     /// elsewhere. This origin indices we've got one of those.
 504     FreeRegion,
 505
 506     /// "Universal" instantiation of a higher-ranked region (e.g.,
 507     /// from a `for<'a> T` binder). Meant to represent "any region".
 508     Placeholder(ty::PlaceholderRegion),
 509
 510     Existential {
 511         /// If this is true, then this variable was created to represent a lifetime
 512         /// bound in a `for` binder. For example, it might have been created to
 513         /// represent the lifetime `'a` in a type like `for<'a> fn(&'a u32)`.
 514         /// Such variables are created when we are trying to figure out if there
 515         /// is any valid instantiation of `'a` that could fit into some scenario.
 516         ///
 517         /// This is used to inform error reporting: in the case that we are trying to
 518         /// determine whether there is any valid instantiation of a `'a` variable that meets
 519         /// some constraint C, we want to blame the "source" of that `for` type,
 520         /// rather than blaming the source of the constraint C.
 521         from_forall: bool,
 522     },
 523 }
 524
 525 // FIXME(eddyb) investigate overlap between this and `TyOrConstInferVar`.
 526 #[derive(Copy, Clone, Debug)]
 527 pub enum FixupError<'tcx> {
 528     UnresolvedIntTy(IntVid),
 529     UnresolvedFloatTy(FloatVid),
 530     UnresolvedTy(TyVid),
 531     UnresolvedConst(ConstVid<'tcx>),
 532 }
 533
 534 /// See the `region_obligations` field for more information.
 535 #[derive(Clone, Debug)]
 536 pub struct RegionObligation<'tcx> {
 537     pub sub_region: ty::Region<'tcx>,
 538     pub sup_type: Ty<'tcx>,
 539     pub origin: SubregionOrigin<'tcx>,
 540 }
 541
 542 impl<'tcx> fmt::Display for FixupError<'tcx> {
 543     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 544         use self::FixupError::*;
 545
 546         match *self {
 547             UnresolvedIntTy(_) => write!(
 548                 f,
 549                 "cannot determine the type of this integer; \
 550                  add a suffix to specify the type explicitly"
 551             ),
 552             UnresolvedFloatTy(_) => write!(
 553                 f,
 554                 "cannot determine the type of this number; \
 555                  add a suffix to specify the type explicitly"
 556             ),
 557             UnresolvedTy(_) => write!(f, "unconstrained type"),
 558             UnresolvedConst(_) => write!(f, "unconstrained const value"),
 559         }
 560     }
 561 }
 562
 563 /// Used to configure inference contexts before their creation
 564 pub struct InferCtxtBuilder<'tcx> {
 565     tcx: TyCtxt<'tcx>,
 566     defining_use_anchor: DefiningAnchor,
 567     considering_regions: bool,
 568     /// Whether we are in coherence mode.
 569     intercrate: bool,
 570 }
 571
 572 pub trait TyCtxtInferExt<'tcx> {
 573     fn infer_ctxt(self) -> InferCtxtBuilder<'tcx>;
 574 }
 575
 576 impl<'tcx> TyCtxtInferExt<'tcx> for TyCtxt<'tcx> {
 577     fn infer_ctxt(self) -> InferCtxtBuilder<'tcx> {
 578         InferCtxtBuilder {
 579             tcx: self,
 580             defining_use_anchor: DefiningAnchor::Error,
 581             considering_regions: true,
 582             intercrate: false,
 583         }
 584     }
 585 }
 586
 587 impl<'tcx> InferCtxtBuilder<'tcx> {
 588     /// Whenever the `InferCtxt` should be able to handle defining uses of opaque types,
 589     /// you need to call this function. Otherwise the opaque type will be treated opaquely.
 590     ///
 591     /// It is only meant to be called in two places, for typeck
 592     /// (via `Inherited::build`) and for the inference context used
 593     /// in mir borrowck.
 594     pub fn with_opaque_type_inference(mut self, defining_use_anchor: DefiningAnchor) -> Self {
 595         self.defining_use_anchor = defining_use_anchor;
 596         self
 597     }
 598
 599     pub fn intercrate(mut self) -> Self {
 600         self.intercrate = true;
 601         self
 602     }
 603
 604     pub fn ignoring_regions(mut self) -> Self {
 605         self.considering_regions = false;
 606         self
 607     }
 608
 609     /// Given a canonical value `C` as a starting point, create an
 610     /// inference context that contains each of the bound values
 611     /// within instantiated as a fresh variable. The `f` closure is
 612     /// invoked with the new infcx, along with the instantiated value
 613     /// `V` and a substitution `S`. This substitution `S` maps from
 614     /// the bound values in `C` to their instantiated values in `V`
 615     /// (in other words, `S(C) = V`).
 616     pub fn build_with_canonical<T>(
 617         &mut self,
 618         span: Span,
 619         canonical: &Canonical<'tcx, T>,
 620     ) -> (InferCtxt<'tcx>, T, CanonicalVarValues<'tcx>)
 621     where
 622         T: TypeFoldable<'tcx>,
 623     {
 624         let infcx = self.build();
 625         let (value, subst) = infcx.instantiate_canonical_with_fresh_inference_vars(span, canonical);
 626         (infcx, value, subst)
 627     }
 628
 629     pub fn build(&mut self) -> InferCtxt<'tcx> {
 630         let InferCtxtBuilder { tcx, defining_use_anchor, considering_regions, intercrate } = *self;
 631         InferCtxt {
 632             tcx,
 633             defining_use_anchor,
 634             considering_regions,
 635             inner: RefCell::new(InferCtxtInner::new()),
 636             lexical_region_resolutions: RefCell::new(None),
 637             selection_cache: Default::default(),
 638             evaluation_cache: Default::default(),
 639             reported_trait_errors: Default::default(),
 640             reported_closure_mismatch: Default::default(),
 641             tainted_by_errors: Cell::new(None),
 642             err_count_on_creation: tcx.sess.err_count(),
 643             in_snapshot: Cell::new(false),
 644             skip_leak_check: Cell::new(false),
 645             universe: Cell::new(ty::UniverseIndex::ROOT),
 646             intercrate,
 647         }
 648     }
 649 }
 650
 651 impl<'tcx, T> InferOk<'tcx, T> {
 652     pub fn unit(self) -> InferOk<'tcx, ()> {
 653         InferOk { value: (), obligations: self.obligations }
 654     }
 655
 656     /// Extracts `value`, registering any obligations into `fulfill_cx`.
 657     pub fn into_value_registering_obligations(
 658         self,
 659         infcx: &InferCtxt<'tcx>,
 660         fulfill_cx: &mut dyn TraitEngine<'tcx>,
 661     ) -> T {
 662         let InferOk { value, obligations } = self;
 663         fulfill_cx.register_predicate_obligations(infcx, obligations);
 664         value
 665     }
 666 }
 667
 668 impl<'tcx> InferOk<'tcx, ()> {
 669     pub fn into_obligations(self) -> PredicateObligations<'tcx> {
 670         self.obligations
 671     }
 672 }
 673
 674 #[must_use = "once you start a snapshot, you should always consume it"]
 675 pub struct CombinedSnapshot<'tcx> {
 676     undo_snapshot: Snapshot<'tcx>,
 677     region_constraints_snapshot: RegionSnapshot,
 678     universe: ty::UniverseIndex,
 679     was_in_snapshot: bool,
 680 }
 681
 682 impl<'tcx> InferCtxt<'tcx> {
 683     /// Creates a `TypeErrCtxt` for emitting various inference errors.
 684     /// During typeck, use `FnCtxt::err_ctxt` instead.
 685     pub fn err_ctxt(&self) -> TypeErrCtxt<'_, 'tcx> {
 686         TypeErrCtxt {
 687             infcx: self,
 688             typeck_results: None,
 689             fallback_has_occurred: false,
 690             normalize_fn_sig: Box::new(|fn_sig| fn_sig),
 691         }
 692     }
 693
 694     pub fn is_in_snapshot(&self) -> bool {
 695         self.in_snapshot.get()
 696     }
 697
 698     pub fn freshen<T: TypeFoldable<'tcx>>(&self, t: T) -> T {
 699         t.fold_with(&mut self.freshener())
 700     }
 701
 702     /// Returns the origin of the type variable identified by `vid`, or `None`
 703     /// if this is not a type variable.
 704     ///
 705     /// No attempt is made to resolve `ty`.
 706     pub fn type_var_origin(&self, ty: Ty<'tcx>) -> Option<TypeVariableOrigin> {
 707         match *ty.kind() {
 708             ty::Infer(ty::TyVar(vid)) => {
 709                 Some(*self.inner.borrow_mut().type_variables().var_origin(vid))
 710             }
 711             _ => None,
 712         }
 713     }
 714
 715     pub fn freshener<'b>(&'b self) -> TypeFreshener<'b, 'tcx> {
 716         freshen::TypeFreshener::new(self, false)
 717     }
 718
 719     /// Like `freshener`, but does not replace `'static` regions.
 720     pub fn freshener_keep_static<'b>(&'b self) -> TypeFreshener<'b, 'tcx> {
 721         freshen::TypeFreshener::new(self, true)
 722     }
 723
 724     pub fn unsolved_variables(&self) -> Vec<Ty<'tcx>> {
 725         let mut inner = self.inner.borrow_mut();
 726         let mut vars: Vec<Ty<'_>> = inner
 727             .type_variables()
 728             .unsolved_variables()
 729             .into_iter()
 730             .map(|t| self.tcx.mk_ty_var(t))
 731             .collect();
 732         vars.extend(
 733             (0..inner.int_unification_table().len())
 734                 .map(|i| ty::IntVid { index: i as u32 })
 735                 .filter(|&vid| inner.int_unification_table().probe_value(vid).is_none())
 736                 .map(|v| self.tcx.mk_int_var(v)),
 737         );
 738         vars.extend(
 739             (0..inner.float_unification_table().len())
 740                 .map(|i| ty::FloatVid { index: i as u32 })
 741                 .filter(|&vid| inner.float_unification_table().probe_value(vid).is_none())
 742                 .map(|v| self.tcx.mk_float_var(v)),
 743         );
 744         vars
 745     }
 746
 747     fn combine_fields<'a>(
 748         &'a self,
 749         trace: TypeTrace<'tcx>,
 750         param_env: ty::ParamEnv<'tcx>,
 751         define_opaque_types: bool,
 752     ) -> CombineFields<'a, 'tcx> {
 753         CombineFields {
 754             infcx: self,
 755             trace,
 756             cause: None,
 757             param_env,
 758             obligations: PredicateObligations::new(),
 759             define_opaque_types,
 760         }
 761     }
 762
 763     fn start_snapshot(&self) -> CombinedSnapshot<'tcx> {
 764         debug!("start_snapshot()");
 765
 766         let in_snapshot = self.in_snapshot.replace(true);
 767
 768         let mut inner = self.inner.borrow_mut();
 769
 770         CombinedSnapshot {
 771             undo_snapshot: inner.undo_log.start_snapshot(),
 772             region_constraints_snapshot: inner.unwrap_region_constraints().start_snapshot(),
 773             universe: self.universe(),
 774             was_in_snapshot: in_snapshot,
 775         }
 776     }
 777
 778     #[instrument(skip(self, snapshot), level = "debug")]
 779     fn rollback_to(&self, cause: &str, snapshot: CombinedSnapshot<'tcx>) {
 780         let CombinedSnapshot {
 781             undo_snapshot,
 782             region_constraints_snapshot,
 783             universe,
 784             was_in_snapshot,
 785         } = snapshot;
 786
 787         self.in_snapshot.set(was_in_snapshot);
 788         self.universe.set(universe);
 789
 790         let mut inner = self.inner.borrow_mut();
 791         inner.rollback_to(undo_snapshot);
 792         inner.unwrap_region_constraints().rollback_to(region_constraints_snapshot);
 793     }
 794
 795     #[instrument(skip(self, snapshot), level = "debug")]
 796     fn commit_from(&self, snapshot: CombinedSnapshot<'tcx>) {
 797         let CombinedSnapshot {
 798             undo_snapshot,
 799             region_constraints_snapshot: _,
 800             universe: _,
 801             was_in_snapshot,
 802         } = snapshot;
 803
 804         self.in_snapshot.set(was_in_snapshot);
 805
 806         self.inner.borrow_mut().commit(undo_snapshot);
 807     }
 808
 809     /// Execute `f` and commit the bindings if closure `f` returns `Ok(_)`.
 810     #[instrument(skip(self, f), level = "debug")]
 811     pub fn commit_if_ok<T, E, F>(&self, f: F) -> Result<T, E>
 812     where
 813         F: FnOnce(&CombinedSnapshot<'tcx>) -> Result<T, E>,
 814     {
 815         let snapshot = self.start_snapshot();
 816         let r = f(&snapshot);
 817         debug!("commit_if_ok() -- r.is_ok() = {}", r.is_ok());
 818         match r {
 819             Ok(_) => {
 820                 self.commit_from(snapshot);
 821             }
 822             Err(_) => {
 823                 self.rollback_to("commit_if_ok -- error", snapshot);
 824             }
 825         }
 826         r
 827     }
 828
 829     /// Execute `f` then unroll any bindings it creates.
 830     #[instrument(skip(self, f), level = "debug")]
 831     pub fn probe<R, F>(&self, f: F) -> R
 832     where
 833         F: FnOnce(&CombinedSnapshot<'tcx>) -> R,
 834     {
 835         let snapshot = self.start_snapshot();
 836         let r = f(&snapshot);
 837         self.rollback_to("probe", snapshot);
 838         r
 839     }
 840
 841     /// If `should_skip` is true, then execute `f` then unroll any bindings it creates.
 842     #[instrument(skip(self, f), level = "debug")]
 843     pub fn probe_maybe_skip_leak_check<R, F>(&self, should_skip: bool, f: F) -> R
 844     where
 845         F: FnOnce(&CombinedSnapshot<'tcx>) -> R,
 846     {
 847         let snapshot = self.start_snapshot();
 848         let was_skip_leak_check = self.skip_leak_check.get();
 849         if should_skip {
 850             self.skip_leak_check.set(true);
 851         }
 852         let r = f(&snapshot);
 853         self.rollback_to("probe", snapshot);
 854         self.skip_leak_check.set(was_skip_leak_check);
 855         r
 856     }
 857
 858     /// Scan the constraints produced since `snapshot` began and returns:
 859     ///
 860     /// - `None` -- if none of them involve "region outlives" constraints
 861     /// - `Some(true)` -- if there are `'a: 'b` constraints where `'a` or `'b` is a placeholder
 862     /// - `Some(false)` -- if there are `'a: 'b` constraints but none involve placeholders
 863     pub fn region_constraints_added_in_snapshot(
 864         &self,
 865         snapshot: &CombinedSnapshot<'tcx>,
 866     ) -> Option<bool> {
 867         self.inner
 868             .borrow_mut()
 869             .unwrap_region_constraints()
 870             .region_constraints_added_in_snapshot(&snapshot.undo_snapshot)
 871     }
 872
 873     pub fn opaque_types_added_in_snapshot(&self, snapshot: &CombinedSnapshot<'tcx>) -> bool {
 874         self.inner.borrow().undo_log.opaque_types_in_snapshot(&snapshot.undo_snapshot)
 875     }
 876
 877     pub fn add_given(&self, sub: ty::Region<'tcx>, sup: ty::RegionVid) {
 878         self.inner.borrow_mut().unwrap_region_constraints().add_given(sub, sup);
 879     }
 880
 881     pub fn can_sub<T>(&self, param_env: ty::ParamEnv<'tcx>, a: T, b: T) -> UnitResult<'tcx>
 882     where
 883         T: at::ToTrace<'tcx>,
 884     {
 885         let origin = &ObligationCause::dummy();
 886         self.probe(|_| {
 887             self.at(origin, param_env).sub(a, b).map(|InferOk { obligations: _, .. }| {
 888                 // Ignore obligations, since we are unrolling
 889                 // everything anyway.
 890             })
 891         })
 892     }
 893
 894     pub fn can_eq<T>(&self, param_env: ty::ParamEnv<'tcx>, a: T, b: T) -> UnitResult<'tcx>
 895     where
 896         T: at::ToTrace<'tcx>,
 897     {
 898         let origin = &ObligationCause::dummy();
 899         self.probe(|_| {
 900             self.at(origin, param_env).eq(a, b).map(|InferOk { obligations: _, .. }| {
 901                 // Ignore obligations, since we are unrolling
 902                 // everything anyway.
 903             })
 904         })
 905     }
 906
 907     #[instrument(skip(self), level = "debug")]
 908     pub fn sub_regions(
 909         &self,
 910         origin: SubregionOrigin<'tcx>,
 911         a: ty::Region<'tcx>,
 912         b: ty::Region<'tcx>,
 913     ) {
 914         self.inner.borrow_mut().unwrap_region_constraints().make_subregion(origin, a, b);
 915     }
 916
 917     /// Require that the region `r` be equal to one of the regions in
 918     /// the set `regions`.
 919     #[instrument(skip(self), level = "debug")]
 920     pub fn member_constraint(
 921         &self,
 922         key: ty::OpaqueTypeKey<'tcx>,
 923         definition_span: Span,
 924         hidden_ty: Ty<'tcx>,
 925         region: ty::Region<'tcx>,
 926         in_regions: &Lrc<Vec<ty::Region<'tcx>>>,
 927     ) {
 928         self.inner.borrow_mut().unwrap_region_constraints().member_constraint(
 929             key,
 930             definition_span,
 931             hidden_ty,
 932             region,
 933             in_regions,
 934         );
 935     }
 936
 937     /// Processes a `Coerce` predicate from the fulfillment context.
 938     /// This is NOT the preferred way to handle coercion, which is to
 939     /// invoke `FnCtxt::coerce` or a similar method (see `coercion.rs`).
 940     ///
 941     /// This method here is actually a fallback that winds up being
 942     /// invoked when `FnCtxt::coerce` encounters unresolved type variables
 943     /// and records a coercion predicate. Presently, this method is equivalent
 944     /// to `subtype_predicate` -- that is, "coercing" `a` to `b` winds up
 945     /// actually requiring `a <: b`. This is of course a valid coercion,
 946     /// but it's not as flexible as `FnCtxt::coerce` would be.
 947     ///
 948     /// (We may refactor this in the future, but there are a number of
 949     /// practical obstacles. Among other things, `FnCtxt::coerce` presently
 950     /// records adjustments that are required on the HIR in order to perform
 951     /// the coercion, and we don't currently have a way to manage that.)
 952     pub fn coerce_predicate(
 953         &self,
 954         cause: &ObligationCause<'tcx>,
 955         param_env: ty::ParamEnv<'tcx>,
 956         predicate: ty::PolyCoercePredicate<'tcx>,
 957     ) -> Result<InferResult<'tcx, ()>, (TyVid, TyVid)> {
 958         let subtype_predicate = predicate.map_bound(|p| ty::SubtypePredicate {
 959             a_is_expected: false, // when coercing from `a` to `b`, `b` is expected
 960             a: p.a,
 961             b: p.b,
 962         });
 963         self.subtype_predicate(cause, param_env, subtype_predicate)
 964     }
 965
 966     pub fn subtype_predicate(
 967         &self,
 968         cause: &ObligationCause<'tcx>,
 969         param_env: ty::ParamEnv<'tcx>,
 970         predicate: ty::PolySubtypePredicate<'tcx>,
 971     ) -> Result<InferResult<'tcx, ()>, (TyVid, TyVid)> {
 972         // Check for two unresolved inference variables, in which case we can
 973         // make no progress. This is partly a micro-optimization, but it's
 974         // also an opportunity to "sub-unify" the variables. This isn't
 975         // *necessary* to prevent cycles, because they would eventually be sub-unified
 976         // anyhow during generalization, but it helps with diagnostics (we can detect
 977         // earlier that they are sub-unified).
 978         //
 979         // Note that we can just skip the binders here because
 980         // type variables can't (at present, at
 981         // least) capture any of the things bound by this binder.
 982         //
 983         // Note that this sub here is not just for diagnostics - it has semantic
 984         // effects as well.
 985         let r_a = self.shallow_resolve(predicate.skip_binder().a);
 986         let r_b = self.shallow_resolve(predicate.skip_binder().b);
 987         match (r_a.kind(), r_b.kind()) {
 988             (&ty::Infer(ty::TyVar(a_vid)), &ty::Infer(ty::TyVar(b_vid))) => {
 989                 self.inner.borrow_mut().type_variables().sub(a_vid, b_vid);
 990                 return Err((a_vid, b_vid));
 991             }
 992             _ => {}
 993         }
 994
 995         Ok(self.commit_if_ok(|_snapshot| {
 996             let ty::SubtypePredicate { a_is_expected, a, b } =
 997                 self.replace_bound_vars_with_placeholders(predicate);
 998
 999             let ok = self.at(cause, param_env).sub_exp(a_is_expected, a, b)?;
1000
1001             Ok(ok.unit())
1002         }))
1003     }
1004
1005     pub fn region_outlives_predicate(
1006         &self,
1007         cause: &traits::ObligationCause<'tcx>,
1008         predicate: ty::PolyRegionOutlivesPredicate<'tcx>,
1009     ) {
1010         let ty::OutlivesPredicate(r_a, r_b) = self.replace_bound_vars_with_placeholders(predicate);
1011         let origin =
1012             SubregionOrigin::from_obligation_cause(cause, || RelateRegionParamBound(cause.span));
1013         self.sub_regions(origin, r_b, r_a); // `b : a` ==> `a <= b`
1014     }
1015
1016     /// Number of type variables created so far.
1017     pub fn num_ty_vars(&self) -> usize {
1018         self.inner.borrow_mut().type_variables().num_vars()
1019     }
1020
1021     pub fn next_ty_var_id(&self, origin: TypeVariableOrigin) -> TyVid {
1022         self.inner.borrow_mut().type_variables().new_var(self.universe(), origin)
1023     }
1024
1025     pub fn next_ty_var(&self, origin: TypeVariableOrigin) -> Ty<'tcx> {
1026         self.tcx.mk_ty_var(self.next_ty_var_id(origin))
1027     }
1028
1029     pub fn next_ty_var_id_in_universe(
1030         &self,
1031         origin: TypeVariableOrigin,
1032         universe: ty::UniverseIndex,
1033     ) -> TyVid {
1034         self.inner.borrow_mut().type_variables().new_var(universe, origin)
1035     }
1036
1037     pub fn next_ty_var_in_universe(
1038         &self,
1039         origin: TypeVariableOrigin,
1040         universe: ty::UniverseIndex,
1041     ) -> Ty<'tcx> {
1042         let vid = self.next_ty_var_id_in_universe(origin, universe);
1043         self.tcx.mk_ty_var(vid)
1044     }
1045
1046     pub fn next_const_var(&self, ty: Ty<'tcx>, origin: ConstVariableOrigin) -> ty::Const<'tcx> {
1047         self.tcx.mk_const(self.next_const_var_id(origin), ty)
1048     }
1049
1050     pub fn next_const_var_in_universe(
1051         &self,
1052         ty: Ty<'tcx>,
1053         origin: ConstVariableOrigin,
1054         universe: ty::UniverseIndex,
1055     ) -> ty::Const<'tcx> {
1056         let vid = self
1057             .inner
1058             .borrow_mut()
1059             .const_unification_table()
1060             .new_key(ConstVarValue { origin, val: ConstVariableValue::Unknown { universe } });
1061         self.tcx.mk_const(vid, ty)
1062     }
1063
1064     pub fn next_const_var_id(&self, origin: ConstVariableOrigin) -> ConstVid<'tcx> {
1065         self.inner.borrow_mut().const_unification_table().new_key(ConstVarValue {
1066             origin,
1067             val: ConstVariableValue::Unknown { universe: self.universe() },
1068         })
1069     }
1070
1071     fn next_int_var_id(&self) -> IntVid {
1072         self.inner.borrow_mut().int_unification_table().new_key(None)
1073     }
1074
1075     pub fn next_int_var(&self) -> Ty<'tcx> {
1076         self.tcx.mk_int_var(self.next_int_var_id())
1077     }
1078
1079     fn next_float_var_id(&self) -> FloatVid {
1080         self.inner.borrow_mut().float_unification_table().new_key(None)
1081     }
1082
1083     pub fn next_float_var(&self) -> Ty<'tcx> {
1084         self.tcx.mk_float_var(self.next_float_var_id())
1085     }
1086
1087     /// Creates a fresh region variable with the next available index.
1088     /// The variable will be created in the maximum universe created
1089     /// thus far, allowing it to name any region created thus far.
1090     pub fn next_region_var(&self, origin: RegionVariableOrigin) -> ty::Region<'tcx> {
1091         self.next_region_var_in_universe(origin, self.universe())
1092     }
1093
1094     /// Creates a fresh region variable with the next available index
1095     /// in the given universe; typically, you can use
1096     /// `next_region_var` and just use the maximal universe.
1097     pub fn next_region_var_in_universe(
1098         &self,
1099         origin: RegionVariableOrigin,
1100         universe: ty::UniverseIndex,
1101     ) -> ty::Region<'tcx> {
1102         let region_var =
1103             self.inner.borrow_mut().unwrap_region_constraints().new_region_var(universe, origin);
1104         self.tcx.mk_region(ty::ReVar(region_var))
1105     }
1106
1107     /// Return the universe that the region `r` was created in.  For
1108     /// most regions (e.g., `'static`, named regions from the user,
1109     /// etc) this is the root universe U0. For inference variables or
1110     /// placeholders, however, it will return the universe which they
1111     /// are associated.
1112     pub fn universe_of_region(&self, r: ty::Region<'tcx>) -> ty::UniverseIndex {
1113         self.inner.borrow_mut().unwrap_region_constraints().universe(r)
1114     }
1115
1116     /// Number of region variables created so far.
1117     pub fn num_region_vars(&self) -> usize {
1118         self.inner.borrow_mut().unwrap_region_constraints().num_region_vars()
1119     }
1120
1121     /// Just a convenient wrapper of `next_region_var` for using during NLL.
1122     pub fn next_nll_region_var(&self, origin: NllRegionVariableOrigin) -> ty::Region<'tcx> {
1123         self.next_region_var(RegionVariableOrigin::Nll(origin))
1124     }
1125
1126     /// Just a convenient wrapper of `next_region_var` for using during NLL.
1127     pub fn next_nll_region_var_in_universe(
1128         &self,
1129         origin: NllRegionVariableOrigin,
1130         universe: ty::UniverseIndex,
1131     ) -> ty::Region<'tcx> {
1132         self.next_region_var_in_universe(RegionVariableOrigin::Nll(origin), universe)
1133     }
1134
1135     pub fn var_for_def(&self, span: Span, param: &ty::GenericParamDef) -> GenericArg<'tcx> {
1136         match param.kind {
1137             GenericParamDefKind::Lifetime => {
1138                 // Create a region inference variable for the given
1139                 // region parameter definition.
1140                 self.next_region_var(EarlyBoundRegion(span, param.name)).into()
1141             }
1142             GenericParamDefKind::Type { .. } => {
1143                 // Create a type inference variable for the given
1144                 // type parameter definition. The substitutions are
1145                 // for actual parameters that may be referred to by
1146                 // the default of this type parameter, if it exists.
1147                 // e.g., `struct Foo<A, B, C = (A, B)>(...);` when
1148                 // used in a path such as `Foo::<T, U>::new()` will
1149                 // use an inference variable for `C` with `[T, U]`
1150                 // as the substitutions for the default, `(T, U)`.
1151                 let ty_var_id = self.inner.borrow_mut().type_variables().new_var(
1152                     self.universe(),
1153                     TypeVariableOrigin {
1154                         kind: TypeVariableOriginKind::TypeParameterDefinition(
1155                             param.name,
1156                             Some(param.def_id),
1157                         ),
1158                         span,
1159                     },
1160                 );
1161
1162                 self.tcx.mk_ty_var(ty_var_id).into()
1163             }
1164             GenericParamDefKind::Const { .. } => {
1165                 let origin = ConstVariableOrigin {
1166                     kind: ConstVariableOriginKind::ConstParameterDefinition(
1167                         param.name,
1168                         param.def_id,
1169                     ),
1170                     span,
1171                 };
1172                 let const_var_id =
1173                     self.inner.borrow_mut().const_unification_table().new_key(ConstVarValue {
1174                         origin,
1175                         val: ConstVariableValue::Unknown { universe: self.universe() },
1176                     });
1177                 self.tcx.mk_const(const_var_id, self.tcx.type_of(param.def_id)).into()
1178             }
1179         }
1180     }
1181
1182     /// Given a set of generics defined on a type or impl, returns a substitution mapping each
1183     /// type/region parameter to a fresh inference variable.
1184     pub fn fresh_substs_for_item(&self, span: Span, def_id: DefId) -> SubstsRef<'tcx> {
1185         InternalSubsts::for_item(self.tcx, def_id, |param, _| self.var_for_def(span, param))
1186     }
1187
1188     /// Returns `true` if errors have been reported since this infcx was
1189     /// created. This is sometimes used as a heuristic to skip
1190     /// reporting errors that often occur as a result of earlier
1191     /// errors, but where it's hard to be 100% sure (e.g., unresolved
1192     /// inference variables, regionck errors).
1193     #[must_use = "this method does not have any side effects"]
1194     pub fn tainted_by_errors(&self) -> Option<ErrorGuaranteed> {
1195         debug!(
1196             "is_tainted_by_errors(err_count={}, err_count_on_creation={}, \
1197              tainted_by_errors={})",
1198             self.tcx.sess.err_count(),
1199             self.err_count_on_creation,
1200             self.tainted_by_errors.get().is_some()
1201         );
1202
1203         if let Some(e) = self.tainted_by_errors.get() {
1204             return Some(e);
1205         }
1206
1207         if self.tcx.sess.err_count() > self.err_count_on_creation {
1208             // errors reported since this infcx was made
1209             let e = self.tcx.sess.has_errors().unwrap();
1210             self.set_tainted_by_errors(e);
1211             return Some(e);
1212         }
1213
1214         None
1215     }
1216
1217     /// Set the "tainted by errors" flag to true. We call this when we
1218     /// observe an error from a prior pass.
1219     pub fn set_tainted_by_errors(&self, e: ErrorGuaranteed) {
1220         debug!("set_tainted_by_errors(ErrorGuaranteed)");
1221         self.tainted_by_errors.set(Some(e));
1222     }
1223
1224     pub fn skip_region_resolution(&self) {
1225         let (var_infos, _) = {
1226             let mut inner = self.inner.borrow_mut();
1227             let inner = &mut *inner;
1228             // Note: `inner.region_obligations` may not be empty, because we
1229             // didn't necessarily call `process_registered_region_obligations`.
1230             // This is okay, because that doesn't introduce new vars.
1231             inner
1232                 .region_constraint_storage
1233                 .take()
1234                 .expect("regions already resolved")
1235                 .with_log(&mut inner.undo_log)
1236                 .into_infos_and_data()
1237         };
1238
1239         let lexical_region_resolutions = LexicalRegionResolutions {
1240             values: rustc_index::vec::IndexVec::from_elem_n(
1241                 crate::infer::lexical_region_resolve::VarValue::Value(self.tcx.lifetimes.re_erased),
1242                 var_infos.len(),
1243             ),
1244         };
1245
1246         let old_value = self.lexical_region_resolutions.replace(Some(lexical_region_resolutions));
1247         assert!(old_value.is_none());
1248     }
1249
1250     /// Process the region constraints and return any errors that
1251     /// result. After this, no more unification operations should be
1252     /// done -- or the compiler will panic -- but it is legal to use
1253     /// `resolve_vars_if_possible` as well as `fully_resolve`.
1254     pub fn resolve_regions(
1255         &self,
1256         outlives_env: &OutlivesEnvironment<'tcx>,
1257     ) -> Vec<RegionResolutionError<'tcx>> {
1258         let (var_infos, data) = {
1259             let mut inner = self.inner.borrow_mut();
1260             let inner = &mut *inner;
1261             assert!(
1262                 self.tainted_by_errors().is_some() || inner.region_obligations.is_empty(),
1263                 "region_obligations not empty: {:#?}",
1264                 inner.region_obligations
1265             );
1266             inner
1267                 .region_constraint_storage
1268                 .take()
1269                 .expect("regions already resolved")
1270                 .with_log(&mut inner.undo_log)
1271                 .into_infos_and_data()
1272         };
1273
1274         let region_rels = &RegionRelations::new(self.tcx, outlives_env.free_region_map());
1275
1276         let (lexical_region_resolutions, errors) =
1277             lexical_region_resolve::resolve(outlives_env.param_env, region_rels, var_infos, data);
1278
1279         let old_value = self.lexical_region_resolutions.replace(Some(lexical_region_resolutions));
1280         assert!(old_value.is_none());
1281
1282         errors
1283     }
1284     /// Obtains (and clears) the current set of region
1285     /// constraints. The inference context is still usable: further
1286     /// unifications will simply add new constraints.
1287     ///
1288     /// This method is not meant to be used with normal lexical region
1289     /// resolution. Rather, it is used in the NLL mode as a kind of
1290     /// interim hack: basically we run normal type-check and generate
1291     /// region constraints as normal, but then we take them and
1292     /// translate them into the form that the NLL solver
1293     /// understands. See the NLL module for mode details.
1294     pub fn take_and_reset_region_constraints(&self) -> RegionConstraintData<'tcx> {
1295         assert!(
1296             self.inner.borrow().region_obligations.is_empty(),
1297             "region_obligations not empty: {:#?}",
1298             self.inner.borrow().region_obligations
1299         );
1300
1301         self.inner.borrow_mut().unwrap_region_constraints().take_and_reset_data()
1302     }
1303
1304     /// Gives temporary access to the region constraint data.
1305     pub fn with_region_constraints<R>(
1306         &self,
1307         op: impl FnOnce(&RegionConstraintData<'tcx>) -> R,
1308     ) -> R {
1309         let mut inner = self.inner.borrow_mut();
1310         op(inner.unwrap_region_constraints().data())
1311     }
1312
1313     pub fn region_var_origin(&self, vid: ty::RegionVid) -> RegionVariableOrigin {
1314         let mut inner = self.inner.borrow_mut();
1315         let inner = &mut *inner;
1316         inner
1317             .region_constraint_storage
1318             .as_mut()
1319             .expect("regions already resolved")
1320             .with_log(&mut inner.undo_log)
1321             .var_origin(vid)
1322     }
1323
1324     /// Takes ownership of the list of variable regions. This implies
1325     /// that all the region constraints have already been taken, and
1326     /// hence that `resolve_regions_and_report_errors` can never be
1327     /// called. This is used only during NLL processing to "hand off" ownership
1328     /// of the set of region variables into the NLL region context.
1329     pub fn take_region_var_origins(&self) -> VarInfos {
1330         let mut inner = self.inner.borrow_mut();
1331         let (var_infos, data) = inner
1332             .region_constraint_storage
1333             .take()
1334             .expect("regions already resolved")
1335             .with_log(&mut inner.undo_log)
1336             .into_infos_and_data();
1337         assert!(data.is_empty());
1338         var_infos
1339     }
1340
1341     #[instrument(level = "debug", skip(self), ret)]
1342     pub fn take_opaque_types(&self) -> opaque_types::OpaqueTypeMap<'tcx> {
1343         debug_assert_ne!(self.defining_use_anchor, DefiningAnchor::Error);
1344         std::mem::take(&mut self.inner.borrow_mut().opaque_type_storage.opaque_types)
1345     }
1346
1347     pub fn ty_to_string(&self, t: Ty<'tcx>) -> String {
1348         self.resolve_vars_if_possible(t).to_string()
1349     }
1350
1351     /// If `TyVar(vid)` resolves to a type, return that type. Else, return the
1352     /// universe index of `TyVar(vid)`.
1353     pub fn probe_ty_var(&self, vid: TyVid) -> Result<Ty<'tcx>, ty::UniverseIndex> {
1354         use self::type_variable::TypeVariableValue;
1355
1356         match self.inner.borrow_mut().type_variables().probe(vid) {
1357             TypeVariableValue::Known { value } => Ok(value),
1358             TypeVariableValue::Unknown { universe } => Err(universe),
1359         }
1360     }
1361
1362     /// Resolve any type variables found in `value` -- but only one
1363     /// level.  So, if the variable `?X` is bound to some type
1364     /// `Foo<?Y>`, then this would return `Foo<?Y>` (but `?Y` may
1365     /// itself be bound to a type).
1366     ///
1367     /// Useful when you only need to inspect the outermost level of
1368     /// the type and don't care about nested types (or perhaps you
1369     /// will be resolving them as well, e.g. in a loop).
1370     pub fn shallow_resolve<T>(&self, value: T) -> T
1371     where
1372         T: TypeFoldable<'tcx>,
1373     {
1374         value.fold_with(&mut ShallowResolver { infcx: self })
1375     }
1376
1377     pub fn root_var(&self, var: ty::TyVid) -> ty::TyVid {
1378         self.inner.borrow_mut().type_variables().root_var(var)
1379     }
1380
1381     /// Where possible, replaces type/const variables in
1382     /// `value` with their final value. Note that region variables
1383     /// are unaffected. If a type/const variable has not been unified, it
1384     /// is left as is. This is an idempotent operation that does
1385     /// not affect inference state in any way and so you can do it
1386     /// at will.
1387     pub fn resolve_vars_if_possible<T>(&self, value: T) -> T
1388     where
1389         T: TypeFoldable<'tcx>,
1390     {
1391         if !value.needs_infer() {
1392             return value; // Avoid duplicated subst-folding.
1393         }
1394         let mut r = resolve::OpportunisticVarResolver::new(self);
1395         value.fold_with(&mut r)
1396     }
1397
1398     pub fn resolve_numeric_literals_with_default<T>(&self, value: T) -> T
1399     where
1400         T: TypeFoldable<'tcx>,
1401     {
1402         if !value.needs_infer() {
1403             return value; // Avoid duplicated subst-folding.
1404         }
1405         let mut r = InferenceLiteralEraser { tcx: self.tcx };
1406         value.fold_with(&mut r)
1407     }
1408
1409     /// Returns the first unresolved type or const variable contained in `T`.
1410     pub fn first_unresolved_const_or_ty_var<T>(
1411         &self,
1412         value: &T,
1413     ) -> Option<(ty::Term<'tcx>, Option<Span>)>
1414     where
1415         T: TypeVisitable<'tcx>,
1416     {
1417         value.visit_with(&mut resolve::UnresolvedTypeOrConstFinder::new(self)).break_value()
1418     }
1419
1420     pub fn probe_const_var(
1421         &self,
1422         vid: ty::ConstVid<'tcx>,
1423     ) -> Result<ty::Const<'tcx>, ty::UniverseIndex> {
1424         match self.inner.borrow_mut().const_unification_table().probe_value(vid).val {
1425             ConstVariableValue::Known { value } => Ok(value),
1426             ConstVariableValue::Unknown { universe } => Err(universe),
1427         }
1428     }
1429
1430     pub fn fully_resolve<T: TypeFoldable<'tcx>>(&self, value: T) -> FixupResult<'tcx, T> {
1431         /*!
1432          * Attempts to resolve all type/region/const variables in
1433          * `value`. Region inference must have been run already (e.g.,
1434          * by calling `resolve_regions_and_report_errors`). If some
1435          * variable was never unified, an `Err` results.
1436          *
1437          * This method is idempotent, but it not typically not invoked
1438          * except during the writeback phase.
1439          */
1440
1441         let value = resolve::fully_resolve(self, value);
1442         assert!(
1443             value.as_ref().map_or(true, |value| !value.needs_infer()),
1444             "`{value:?}` is not fully resolved"
1445         );
1446         value
1447     }
1448
1449     pub fn replace_bound_vars_with_fresh_vars<T>(
1450         &self,
1451         span: Span,
1452         lbrct: LateBoundRegionConversionTime,
1453         value: ty::Binder<'tcx, T>,
1454     ) -> T
1455     where
1456         T: TypeFoldable<'tcx> + Copy,
1457     {
1458         if let Some(inner) = value.no_bound_vars() {
1459             return inner;
1460         }
1461
1462         struct ToFreshVars<'a, 'tcx> {
1463             infcx: &'a InferCtxt<'tcx>,
1464             span: Span,
1465             lbrct: LateBoundRegionConversionTime,
1466             map: FxHashMap<ty::BoundVar, ty::GenericArg<'tcx>>,
1467         }
1468
1469         impl<'tcx> BoundVarReplacerDelegate<'tcx> for ToFreshVars<'_, 'tcx> {
1470             fn replace_region(&mut self, br: ty::BoundRegion) -> ty::Region<'tcx> {
1471                 self.map
1472                     .entry(br.var)
1473                     .or_insert_with(|| {
1474                         self.infcx
1475                             .next_region_var(LateBoundRegion(self.span, br.kind, self.lbrct))
1476                             .into()
1477                     })
1478                     .expect_region()
1479             }
1480             fn replace_ty(&mut self, bt: ty::BoundTy) -> Ty<'tcx> {
1481                 self.map
1482                     .entry(bt.var)
1483                     .or_insert_with(|| {
1484                         self.infcx
1485                             .next_ty_var(TypeVariableOrigin {
1486                                 kind: TypeVariableOriginKind::MiscVariable,
1487                                 span: self.span,
1488                             })
1489                             .into()
1490                     })
1491                     .expect_ty()
1492             }
1493             fn replace_const(&mut self, bv: ty::BoundVar, ty: Ty<'tcx>) -> ty::Const<'tcx> {
1494                 self.map
1495                     .entry(bv)
1496                     .or_insert_with(|| {
1497                         self.infcx
1498                             .next_const_var(
1499                                 ty,
1500                                 ConstVariableOrigin {
1501                                     kind: ConstVariableOriginKind::MiscVariable,
1502                                     span: self.span,
1503                                 },
1504                             )
1505                             .into()
1506                     })
1507                     .expect_const()
1508             }
1509         }
1510         let delegate = ToFreshVars { infcx: self, span, lbrct, map: Default::default() };
1511         self.tcx.replace_bound_vars_uncached(value, delegate)
1512     }
1513
1514     /// See the [`region_constraints::RegionConstraintCollector::verify_generic_bound`] method.
1515     pub fn verify_generic_bound(
1516         &self,
1517         origin: SubregionOrigin<'tcx>,
1518         kind: GenericKind<'tcx>,
1519         a: ty::Region<'tcx>,
1520         bound: VerifyBound<'tcx>,
1521     ) {
1522         debug!("verify_generic_bound({:?}, {:?} <: {:?})", kind, a, bound);
1523
1524         self.inner
1525             .borrow_mut()
1526             .unwrap_region_constraints()
1527             .verify_generic_bound(origin, kind, a, bound);
1528     }
1529
1530     /// Obtains the latest type of the given closure; this may be a
1531     /// closure in the current function, in which case its
1532     /// `ClosureKind` may not yet be known.
1533     pub fn closure_kind(&self, closure_substs: SubstsRef<'tcx>) -> Option<ty::ClosureKind> {
1534         let closure_kind_ty = closure_substs.as_closure().kind_ty();
1535         let closure_kind_ty = self.shallow_resolve(closure_kind_ty);
1536         closure_kind_ty.to_opt_closure_kind()
1537     }
1538
1539     /// Clears the selection, evaluation, and projection caches. This is useful when
1540     /// repeatedly attempting to select an `Obligation` while changing only
1541     /// its `ParamEnv`, since `FulfillmentContext` doesn't use probing.
1542     pub fn clear_caches(&self) {
1543         self.selection_cache.clear();
1544         self.evaluation_cache.clear();
1545         self.inner.borrow_mut().projection_cache().clear();
1546     }
1547
1548     pub fn universe(&self) -> ty::UniverseIndex {
1549         self.universe.get()
1550     }
1551
1552     /// Creates and return a fresh universe that extends all previous
1553     /// universes. Updates `self.universe` to that new universe.
1554     pub fn create_next_universe(&self) -> ty::UniverseIndex {
1555         let u = self.universe.get().next_universe();
1556         self.universe.set(u);
1557         u
1558     }
1559
1560     pub fn try_const_eval_resolve(
1561         &self,
1562         param_env: ty::ParamEnv<'tcx>,
1563         unevaluated: ty::UnevaluatedConst<'tcx>,
1564         ty: Ty<'tcx>,
1565         span: Option<Span>,
1566     ) -> Result<ty::Const<'tcx>, ErrorHandled> {
1567         match self.const_eval_resolve(param_env, unevaluated, span) {
1568             Ok(Some(val)) => Ok(self.tcx.mk_const(val, ty)),
1569             Ok(None) => {
1570                 let tcx = self.tcx;
1571                 let def_id = unevaluated.def.did;
1572                 span_bug!(
1573                     tcx.def_span(def_id),
1574                     "unable to construct a constant value for the unevaluated constant {:?}",
1575                     unevaluated
1576                 );
1577             }
1578             Err(err) => Err(err),
1579         }
1580     }
1581
1582     /// Resolves and evaluates a constant.
1583     ///
1584     /// The constant can be located on a trait like `<A as B>::C`, in which case the given
1585     /// substitutions and environment are used to resolve the constant. Alternatively if the
1586     /// constant has generic parameters in scope the substitutions are used to evaluate the value of
1587     /// the constant. For example in `fn foo<T>() { let _ = [0; bar::<T>()]; }` the repeat count
1588     /// constant `bar::<T>()` requires a substitution for `T`, if the substitution for `T` is still
1589     /// too generic for the constant to be evaluated then `Err(ErrorHandled::TooGeneric)` is
1590     /// returned.
1591     ///
1592     /// This handles inferences variables within both `param_env` and `substs` by
1593     /// performing the operation on their respective canonical forms.
1594     #[instrument(skip(self), level = "debug")]
1595     pub fn const_eval_resolve(
1596         &self,
1597         mut param_env: ty::ParamEnv<'tcx>,
1598         unevaluated: ty::UnevaluatedConst<'tcx>,
1599         span: Option<Span>,
1600     ) -> EvalToValTreeResult<'tcx> {
1601         let mut substs = self.resolve_vars_if_possible(unevaluated.substs);
1602         debug!(?substs);
1603
1604         // Postpone the evaluation of constants whose substs depend on inference
1605         // variables
1606         let tcx = self.tcx;
1607         if substs.has_non_region_infer() {
1608             if let Some(ct) = tcx.bound_abstract_const(unevaluated.def)? {
1609                 let ct = tcx.expand_abstract_consts(ct.subst(tcx, substs));
1610                 if let Err(e) = ct.error_reported() {
1611                     return Err(ErrorHandled::Reported(e));
1612                 } else if ct.has_non_region_infer() || ct.has_non_region_param() {
1613                     return Err(ErrorHandled::TooGeneric);
1614                 } else {
1615                     substs = replace_param_and_infer_substs_with_placeholder(tcx, substs);
1616                 }
1617             } else {
1618                 substs = InternalSubsts::identity_for_item(tcx, unevaluated.def.did);
1619                 param_env = tcx.param_env(unevaluated.def.did);
1620             }
1621         }
1622
1623         let param_env_erased = tcx.erase_regions(param_env);
1624         let substs_erased = tcx.erase_regions(substs);
1625         debug!(?param_env_erased);
1626         debug!(?substs_erased);
1627
1628         let unevaluated = ty::UnevaluatedConst { def: unevaluated.def, substs: substs_erased };
1629
1630         // The return value is the evaluated value which doesn't contain any reference to inference
1631         // variables, thus we don't need to substitute back the original values.
1632         tcx.const_eval_resolve_for_typeck(param_env_erased, unevaluated, span)
1633     }
1634
1635     /// `ty_or_const_infer_var_changed` is equivalent to one of these two:
1636     ///   * `shallow_resolve(ty) != ty` (where `ty.kind = ty::Infer(_)`)
1637     ///   * `shallow_resolve(ct) != ct` (where `ct.kind = ty::ConstKind::Infer(_)`)
1638     ///
1639     /// However, `ty_or_const_infer_var_changed` is more efficient. It's always
1640     /// inlined, despite being large, because it has only two call sites that
1641     /// are extremely hot (both in `traits::fulfill`'s checking of `stalled_on`
1642     /// inference variables), and it handles both `Ty` and `ty::Const` without
1643     /// having to resort to storing full `GenericArg`s in `stalled_on`.
1644     #[inline(always)]
1645     pub fn ty_or_const_infer_var_changed(&self, infer_var: TyOrConstInferVar<'tcx>) -> bool {
1646         match infer_var {
1647             TyOrConstInferVar::Ty(v) => {
1648                 use self::type_variable::TypeVariableValue;
1649
1650                 // If `inlined_probe` returns a `Known` value, it never equals
1651                 // `ty::Infer(ty::TyVar(v))`.
1652                 match self.inner.borrow_mut().type_variables().inlined_probe(v) {
1653                     TypeVariableValue::Unknown { .. } => false,
1654                     TypeVariableValue::Known { .. } => true,
1655                 }
1656             }
1657
1658             TyOrConstInferVar::TyInt(v) => {
1659                 // If `inlined_probe_value` returns a value it's always a
1660                 // `ty::Int(_)` or `ty::UInt(_)`, which never matches a
1661                 // `ty::Infer(_)`.
1662                 self.inner.borrow_mut().int_unification_table().inlined_probe_value(v).is_some()
1663             }
1664
1665             TyOrConstInferVar::TyFloat(v) => {
1666                 // If `probe_value` returns a value it's always a
1667                 // `ty::Float(_)`, which never matches a `ty::Infer(_)`.
1668                 //
1669                 // Not `inlined_probe_value(v)` because this call site is colder.
1670                 self.inner.borrow_mut().float_unification_table().probe_value(v).is_some()
1671             }
1672
1673             TyOrConstInferVar::Const(v) => {
1674                 // If `probe_value` returns a `Known` value, it never equals
1675                 // `ty::ConstKind::Infer(ty::InferConst::Var(v))`.
1676                 //
1677                 // Not `inlined_probe_value(v)` because this call site is colder.
1678                 match self.inner.borrow_mut().const_unification_table().probe_value(v).val {
1679                     ConstVariableValue::Unknown { .. } => false,
1680                     ConstVariableValue::Known { .. } => true,
1681                 }
1682             }
1683         }
1684     }
1685 }
1686
1687 impl<'tcx> TypeErrCtxt<'_, 'tcx> {
1688     /// Processes registered region obliations and resolves regions, reporting
1689     /// any errors if any were raised. Prefer using this function over manually
1690     /// calling `resolve_regions_and_report_errors`.
1691     pub fn check_region_obligations_and_report_errors(
1692         &self,
1693         generic_param_scope: LocalDefId,
1694         outlives_env: &OutlivesEnvironment<'tcx>,
1695     ) -> Result<(), ErrorGuaranteed> {
1696         self.process_registered_region_obligations(
1697             outlives_env.region_bound_pairs(),
1698             outlives_env.param_env,
1699         );
1700
1701         self.resolve_regions_and_report_errors(generic_param_scope, outlives_env)
1702     }
1703
1704     /// Process the region constraints and report any errors that
1705     /// result. After this, no more unification operations should be
1706     /// done -- or the compiler will panic -- but it is legal to use
1707     /// `resolve_vars_if_possible` as well as `fully_resolve`.
1708     ///
1709     /// Make sure to call [`InferCtxt::process_registered_region_obligations`]
1710     /// first, or preferably use [`TypeErrCtxt::check_region_obligations_and_report_errors`]
1711     /// to do both of these operations together.
1712     pub fn resolve_regions_and_report_errors(
1713         &self,
1714         generic_param_scope: LocalDefId,
1715         outlives_env: &OutlivesEnvironment<'tcx>,
1716     ) -> Result<(), ErrorGuaranteed> {
1717         let errors = self.resolve_regions(outlives_env);
1718
1719         if let None = self.tainted_by_errors() {
1720             // As a heuristic, just skip reporting region errors
1721             // altogether if other errors have been reported while
1722             // this infcx was in use.  This is totally hokey but
1723             // otherwise we have a hard time separating legit region
1724             // errors from silly ones.
1725             self.report_region_errors(generic_param_scope, &errors);
1726         }
1727
1728         if errors.is_empty() {
1729             Ok(())
1730         } else {
1731             Err(self
1732                 .tcx
1733                 .sess
1734                 .delay_span_bug(rustc_span::DUMMY_SP, "error should have been emitted"))
1735         }
1736     }
1737
1738     // [Note-Type-error-reporting]
1739     // An invariant is that anytime the expected or actual type is Error (the special
1740     // error type, meaning that an error occurred when typechecking this expression),
1741     // this is a derived error. The error cascaded from another error (that was already
1742     // reported), so it's not useful to display it to the user.
1743     // The following methods implement this logic.
1744     // They check if either the actual or expected type is Error, and don't print the error
1745     // in this case. The typechecker should only ever report type errors involving mismatched
1746     // types using one of these methods, and should not call span_err directly for such
1747     // errors.
1748
1749     pub fn type_error_struct_with_diag<M>(
1750         &self,
1751         sp: Span,
1752         mk_diag: M,
1753         actual_ty: Ty<'tcx>,
1754     ) -> DiagnosticBuilder<'tcx, ErrorGuaranteed>
1755     where
1756         M: FnOnce(String) -> DiagnosticBuilder<'tcx, ErrorGuaranteed>,
1757     {
1758         let actual_ty = self.resolve_vars_if_possible(actual_ty);
1759         debug!("type_error_struct_with_diag({:?}, {:?})", sp, actual_ty);
1760
1761         let mut err = mk_diag(self.ty_to_string(actual_ty));
1762
1763         // Don't report an error if actual type is `Error`.
1764         if actual_ty.references_error() {
1765             err.downgrade_to_delayed_bug();
1766         }
1767
1768         err
1769     }
1770
1771     pub fn report_mismatched_types(
1772         &self,
1773         cause: &ObligationCause<'tcx>,
1774         expected: Ty<'tcx>,
1775         actual: Ty<'tcx>,
1776         err: TypeError<'tcx>,
1777     ) -> DiagnosticBuilder<'tcx, ErrorGuaranteed> {
1778         self.report_and_explain_type_error(TypeTrace::types(cause, true, expected, actual), err)
1779     }
1780
1781     pub fn report_mismatched_consts(
1782         &self,
1783         cause: &ObligationCause<'tcx>,
1784         expected: ty::Const<'tcx>,
1785         actual: ty::Const<'tcx>,
1786         err: TypeError<'tcx>,
1787     ) -> DiagnosticBuilder<'tcx, ErrorGuaranteed> {
1788         self.report_and_explain_type_error(TypeTrace::consts(cause, true, expected, actual), err)
1789     }
1790 }
1791
1792 /// Helper for `ty_or_const_infer_var_changed` (see comment on that), currently
1793 /// used only for `traits::fulfill`'s list of `stalled_on` inference variables.
1794 #[derive(Copy, Clone, Debug)]
1795 pub enum TyOrConstInferVar<'tcx> {
1796     /// Equivalent to `ty::Infer(ty::TyVar(_))`.
1797     Ty(TyVid),
1798     /// Equivalent to `ty::Infer(ty::IntVar(_))`.
1799     TyInt(IntVid),
1800     /// Equivalent to `ty::Infer(ty::FloatVar(_))`.
1801     TyFloat(FloatVid),
1802
1803     /// Equivalent to `ty::ConstKind::Infer(ty::InferConst::Var(_))`.
1804     Const(ConstVid<'tcx>),
1805 }
1806
1807 impl<'tcx> TyOrConstInferVar<'tcx> {
1808     /// Tries to extract an inference variable from a type or a constant, returns `None`
1809     /// for types other than `ty::Infer(_)` (or `InferTy::Fresh*`) and
1810     /// for constants other than `ty::ConstKind::Infer(_)` (or `InferConst::Fresh`).
1811     pub fn maybe_from_generic_arg(arg: GenericArg<'tcx>) -> Option<Self> {
1812         match arg.unpack() {
1813             GenericArgKind::Type(ty) => Self::maybe_from_ty(ty),
1814             GenericArgKind::Const(ct) => Self::maybe_from_const(ct),
1815             GenericArgKind::Lifetime(_) => None,
1816         }
1817     }
1818
1819     /// Tries to extract an inference variable from a type, returns `None`
1820     /// for types other than `ty::Infer(_)` (or `InferTy::Fresh*`).
1821     fn maybe_from_ty(ty: Ty<'tcx>) -> Option<Self> {
1822         match *ty.kind() {
1823             ty::Infer(ty::TyVar(v)) => Some(TyOrConstInferVar::Ty(v)),
1824             ty::Infer(ty::IntVar(v)) => Some(TyOrConstInferVar::TyInt(v)),
1825             ty::Infer(ty::FloatVar(v)) => Some(TyOrConstInferVar::TyFloat(v)),
1826             _ => None,
1827         }
1828     }
1829
1830     /// Tries to extract an inference variable from a constant, returns `None`
1831     /// for constants other than `ty::ConstKind::Infer(_)` (or `InferConst::Fresh`).
1832     fn maybe_from_const(ct: ty::Const<'tcx>) -> Option<Self> {
1833         match ct.kind() {
1834             ty::ConstKind::Infer(InferConst::Var(v)) => Some(TyOrConstInferVar::Const(v)),
1835             _ => None,
1836         }
1837     }
1838 }
1839
1840 /// Replace `{integer}` with `i32` and `{float}` with `f64`.
1841 /// Used only for diagnostics.
1842 struct InferenceLiteralEraser<'tcx> {
1843     tcx: TyCtxt<'tcx>,
1844 }
1845
1846 impl<'tcx> TypeFolder<'tcx> for InferenceLiteralEraser<'tcx> {
1847     fn tcx(&self) -> TyCtxt<'tcx> {
1848         self.tcx
1849     }
1850
1851     fn fold_ty(&mut self, ty: Ty<'tcx>) -> Ty<'tcx> {
1852         match ty.kind() {
1853             ty::Infer(ty::IntVar(_) | ty::FreshIntTy(_)) => self.tcx.types.i32,
1854             ty::Infer(ty::FloatVar(_) | ty::FreshFloatTy(_)) => self.tcx.types.f64,
1855             _ => ty.super_fold_with(self),
1856         }
1857     }
1858 }
1859
1860 struct ShallowResolver<'a, 'tcx> {
1861     infcx: &'a InferCtxt<'tcx>,
1862 }
1863
1864 impl<'a, 'tcx> TypeFolder<'tcx> for ShallowResolver<'a, 'tcx> {
1865     fn tcx<'b>(&'b self) -> TyCtxt<'tcx> {
1866         self.infcx.tcx
1867     }
1868
1869     /// If `ty` is a type variable of some kind, resolve it one level
1870     /// (but do not resolve types found in the result). If `typ` is
1871     /// not a type variable, just return it unmodified.
1872     fn fold_ty(&mut self, ty: Ty<'tcx>) -> Ty<'tcx> {
1873         match *ty.kind() {
1874             ty::Infer(ty::TyVar(v)) => {
1875                 // Not entirely obvious: if `typ` is a type variable,
1876                 // it can be resolved to an int/float variable, which
1877                 // can then be recursively resolved, hence the
1878                 // recursion. Note though that we prevent type
1879                 // variables from unifying to other type variables
1880                 // directly (though they may be embedded
1881                 // structurally), and we prevent cycles in any case,
1882                 // so this recursion should always be of very limited
1883                 // depth.
1884                 //
1885                 // Note: if these two lines are combined into one we get
1886                 // dynamic borrow errors on `self.inner`.
1887                 let known = self.infcx.inner.borrow_mut().type_variables().probe(v).known();
1888                 known.map_or(ty, |t| self.fold_ty(t))
1889             }
1890
1891             ty::Infer(ty::IntVar(v)) => self
1892                 .infcx
1893                 .inner
1894                 .borrow_mut()
1895                 .int_unification_table()
1896                 .probe_value(v)
1897                 .map_or(ty, |v| v.to_type(self.infcx.tcx)),
1898
1899             ty::Infer(ty::FloatVar(v)) => self
1900                 .infcx
1901                 .inner
1902                 .borrow_mut()
1903                 .float_unification_table()
1904                 .probe_value(v)
1905                 .map_or(ty, |v| v.to_type(self.infcx.tcx)),
1906
1907             _ => ty,
1908         }
1909     }
1910
1911     fn fold_const(&mut self, ct: ty::Const<'tcx>) -> ty::Const<'tcx> {
1912         if let ty::ConstKind::Infer(InferConst::Var(vid)) = ct.kind() {
1913             self.infcx
1914                 .inner
1915                 .borrow_mut()
1916                 .const_unification_table()
1917                 .probe_value(vid)
1918                 .val
1919                 .known()
1920                 .unwrap_or(ct)
1921         } else {
1922             ct
1923         }
1924     }
1925 }
1926
1927 impl<'tcx> TypeTrace<'tcx> {
1928     pub fn span(&self) -> Span {
1929         self.cause.span
1930     }
1931
1932     pub fn types(
1933         cause: &ObligationCause<'tcx>,
1934         a_is_expected: bool,
1935         a: Ty<'tcx>,
1936         b: Ty<'tcx>,
1937     ) -> TypeTrace<'tcx> {
1938         TypeTrace {
1939             cause: cause.clone(),
1940             values: Terms(ExpectedFound::new(a_is_expected, a.into(), b.into())),
1941         }
1942     }
1943
1944     pub fn poly_trait_refs(
1945         cause: &ObligationCause<'tcx>,
1946         a_is_expected: bool,
1947         a: ty::PolyTraitRef<'tcx>,
1948         b: ty::PolyTraitRef<'tcx>,
1949     ) -> TypeTrace<'tcx> {
1950         TypeTrace {
1951             cause: cause.clone(),
1952             values: PolyTraitRefs(ExpectedFound::new(a_is_expected, a, b)),
1953         }
1954     }
1955
1956     pub fn consts(
1957         cause: &ObligationCause<'tcx>,
1958         a_is_expected: bool,
1959         a: ty::Const<'tcx>,
1960         b: ty::Const<'tcx>,
1961     ) -> TypeTrace<'tcx> {
1962         TypeTrace {
1963             cause: cause.clone(),
1964             values: Terms(ExpectedFound::new(a_is_expected, a.into(), b.into())),
1965         }
1966     }
1967 }
1968
1969 impl<'tcx> SubregionOrigin<'tcx> {
1970     pub fn span(&self) -> Span {
1971         match *self {
1972             Subtype(ref a) => a.span(),
1973             RelateObjectBound(a) => a,
1974             RelateParamBound(a, ..) => a,
1975             RelateRegionParamBound(a) => a,
1976             Reborrow(a) => a,
1977             DataBorrowed(_, a) => a,
1978             ReferenceOutlivesReferent(_, a) => a,
1979             CompareImplItemObligation { span, .. } => span,
1980             AscribeUserTypeProvePredicate(span) => span,
1981             CheckAssociatedTypeBounds { ref parent, .. } => parent.span(),
1982         }
1983     }
1984
1985     pub fn from_obligation_cause<F>(cause: &traits::ObligationCause<'tcx>, default: F) -> Self
1986     where
1987         F: FnOnce() -> Self,
1988     {
1989         match *cause.code() {
1990             traits::ObligationCauseCode::ReferenceOutlivesReferent(ref_type) => {
1991                 SubregionOrigin::ReferenceOutlivesReferent(ref_type, cause.span)
1992             }
1993
1994             traits::ObligationCauseCode::CompareImplItemObligation {
1995                 impl_item_def_id,
1996                 trait_item_def_id,
1997                 kind: _,
1998             } => SubregionOrigin::CompareImplItemObligation {
1999                 span: cause.span,
2000                 impl_item_def_id,
2001                 trait_item_def_id,
2002             },
2003
2004             traits::ObligationCauseCode::CheckAssociatedTypeBounds {
2005                 impl_item_def_id,
2006                 trait_item_def_id,
2007             } => SubregionOrigin::CheckAssociatedTypeBounds {
2008                 impl_item_def_id,
2009                 trait_item_def_id,
2010                 parent: Box::new(default()),
2011             },
2012
2013             traits::ObligationCauseCode::AscribeUserTypeProvePredicate(span) => {
2014                 SubregionOrigin::AscribeUserTypeProvePredicate(span)
2015             }
2016
2017             _ => default(),
2018         }
2019     }
2020 }
2021
2022 impl RegionVariableOrigin {
2023     pub fn span(&self) -> Span {
2024         match *self {
2025             MiscVariable(a)
2026             | PatternRegion(a)
2027             | AddrOfRegion(a)
2028             | Autoref(a)
2029             | Coercion(a)
2030             | EarlyBoundRegion(a, ..)
2031             | LateBoundRegion(a, ..)
2032             | UpvarRegion(_, a) => a,
2033             Nll(..) => bug!("NLL variable used with `span`"),
2034         }
2035     }
2036 }
2037
2038 /// Replaces substs that reference param or infer variables with suitable
2039 /// placeholders. This function is meant to remove these param and infer
2040 /// substs when they're not actually needed to evaluate a constant.
2041 fn replace_param_and_infer_substs_with_placeholder<'tcx>(
2042     tcx: TyCtxt<'tcx>,
2043     substs: SubstsRef<'tcx>,
2044 ) -> SubstsRef<'tcx> {
2045     struct ReplaceParamAndInferWithPlaceholder<'tcx> {
2046         tcx: TyCtxt<'tcx>,
2047         idx: usize,
2048     }
2049
2050     impl<'tcx> TypeFolder<'tcx> for ReplaceParamAndInferWithPlaceholder<'tcx> {
2051         fn tcx(&self) -> TyCtxt<'tcx> {
2052             self.tcx
2053         }
2054
2055         fn fold_ty(&mut self, t: Ty<'tcx>) -> Ty<'tcx> {
2056             if let ty::Infer(_) = t.kind() {
2057                 self.tcx.mk_ty(ty::Placeholder(ty::PlaceholderType {
2058                     universe: ty::UniverseIndex::ROOT,
2059                     name: ty::BoundVar::from_usize({
2060                         let idx = self.idx;
2061                         self.idx += 1;
2062                         idx
2063                     }),
2064                 }))
2065             } else {
2066                 t.super_fold_with(self)
2067             }
2068         }
2069
2070         fn fold_const(&mut self, c: ty::Const<'tcx>) -> ty::Const<'tcx> {
2071             if let ty::ConstKind::Infer(_) = c.kind() {
2072                 let ty = c.ty();
2073                 // If the type references param or infer then ICE ICE ICE
2074                 if ty.has_non_region_param() || ty.has_non_region_infer() {
2075                     bug!("const `{c}`'s type should not reference params or types");
2076                 }
2077                 self.tcx.mk_const(
2078                     ty::PlaceholderConst {
2079                         universe: ty::UniverseIndex::ROOT,
2080                         name: ty::BoundVar::from_usize({
2081                             let idx = self.idx;
2082                             self.idx += 1;
2083                             idx
2084                         }),
2085                     },
2086                     ty,
2087                 )
2088             } else {
2089                 c.super_fold_with(self)
2090             }
2091         }
2092     }
2093
2094     substs.fold_with(&mut ReplaceParamAndInferWithPlaceholder { tcx, idx: 0 })
2095 }