compiler/rustc_middle/src/ty/mod.rs

   1 //! Defines how the compiler represents types internally.
   2 //!
   3 //! Two important entities in this module are:
   4 //!
   5 //! - [`rustc_middle::ty::Ty`], used to represent the semantics of a type.
   6 //! - [`rustc_middle::ty::TyCtxt`], the central data structure in the compiler.
   7 //!
   8 //! For more information, see ["The `ty` module: representing types"] in the rustc-dev-guide.
   9 //!
  10 //! ["The `ty` module: representing types"]: https://rustc-dev-guide.rust-lang.org/ty.html
  11
  12 pub use self::fold::{
  13     FallibleTypeFolder, TypeFoldable, TypeFolder, TypeSuperFoldable, TypeVisitor,
  14 };
  15 pub use self::AssocItemContainer::*;
  16 pub use self::BorrowKind::*;
  17 pub use self::IntVarValue::*;
  18 pub use self::Variance::*;
  19 use crate::metadata::ModChild;
  20 use crate::middle::privacy::AccessLevels;
  21 use crate::mir::{Body, GeneratorLayout};
  22 use crate::traits::{self, Reveal};
  23 use crate::ty;
  24 use crate::ty::fast_reject::SimplifiedType;
  25 use crate::ty::util::Discr;
  26 pub use adt::*;
  27 pub use assoc::*;
  28 pub use generics::*;
  29 use rustc_ast as ast;
  30 use rustc_ast::node_id::NodeMap;
  31 use rustc_attr as attr;
  32 use rustc_data_structures::fingerprint::Fingerprint;
  33 use rustc_data_structures::fx::{FxHashMap, FxHashSet, FxIndexMap, FxIndexSet};
  34 use rustc_data_structures::intern::{Interned, WithStableHash};
  35 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
  36 use rustc_data_structures::tagged_ptr::CopyTaggedPtr;
  37 use rustc_hir as hir;
  38 use rustc_hir::def::{CtorKind, CtorOf, DefKind, LifetimeRes, Res};
  39 use rustc_hir::def_id::{CrateNum, DefId, LocalDefId, LocalDefIdMap};
  40 use rustc_hir::Node;
  41 use rustc_index::vec::IndexVec;
  42 use rustc_macros::HashStable;
  43 use rustc_query_system::ich::StableHashingContext;
  44 use rustc_span::hygiene::MacroKind;
  45 use rustc_span::symbol::{kw, sym, Ident, Symbol};
  46 use rustc_span::{ExpnId, Span};
  47 use rustc_target::abi::{Align, VariantIdx};
  48 pub use subst::*;
  49 pub use vtable::*;
  50
  51 use std::fmt::Debug;
  52 use std::hash::Hash;
  53 use std::ops::ControlFlow;
  54 use std::{fmt, str};
  55
  56 pub use crate::ty::diagnostics::*;
  57 pub use rustc_type_ir::InferTy::*;
  58 pub use rustc_type_ir::RegionKind::*;
  59 pub use rustc_type_ir::TyKind::*;
  60 pub use rustc_type_ir::*;
  61
  62 pub use self::binding::BindingMode;
  63 pub use self::binding::BindingMode::*;
  64 pub use self::closure::{
  65     is_ancestor_or_same_capture, place_to_string_for_capture, BorrowKind, CaptureInfo,
  66     CapturedPlace, ClosureKind, MinCaptureInformationMap, MinCaptureList,
  67     RootVariableMinCaptureList, UpvarCapture, UpvarCaptureMap, UpvarId, UpvarListMap, UpvarPath,
  68     CAPTURE_STRUCT_LOCAL,
  69 };
  70 pub use self::consts::{
  71     Const, ConstInt, ConstKind, ConstS, InferConst, ScalarInt, Unevaluated, ValTree,
  72 };
  73 pub use self::context::{
  74     tls, CanonicalUserType, CanonicalUserTypeAnnotation, CanonicalUserTypeAnnotations,
  75     CtxtInterners, DelaySpanBugEmitted, FreeRegionInfo, GeneratorDiagnosticData,
  76     GeneratorInteriorTypeCause, GlobalCtxt, Lift, OnDiskCache, TyCtxt, TypeckResults, UserType,
  77     UserTypeAnnotationIndex,
  78 };
  79 pub use self::instance::{Instance, InstanceDef};
  80 pub use self::list::List;
  81 pub use self::parameterized::ParameterizedOverTcx;
  82 pub use self::rvalue_scopes::RvalueScopes;
  83 pub use self::sty::BoundRegionKind::*;
  84 pub use self::sty::{
  85     Article, Binder, BoundRegion, BoundRegionKind, BoundTy, BoundTyKind, BoundVar,
  86     BoundVariableKind, CanonicalPolyFnSig, ClosureSubsts, ClosureSubstsParts, ConstVid,
  87     EarlyBinder, EarlyBoundRegion, ExistentialPredicate, ExistentialProjection,
  88     ExistentialTraitRef, FnSig, FreeRegion, GenSig, GeneratorSubsts, GeneratorSubstsParts,
  89     InlineConstSubsts, InlineConstSubstsParts, ParamConst, ParamTy, PolyExistentialProjection,
  90     PolyExistentialTraitRef, PolyFnSig, PolyGenSig, PolyTraitRef, ProjectionTy, Region, RegionKind,
  91     RegionVid, TraitRef, TyKind, TypeAndMut, UpvarSubsts, VarianceDiagInfo,
  92 };
  93 pub use self::trait_def::TraitDef;
  94
  95 pub mod _match;
  96 pub mod adjustment;
  97 pub mod binding;
  98 pub mod cast;
  99 pub mod codec;
 100 pub mod error;
 101 pub mod fast_reject;
 102 pub mod flags;
 103 pub mod fold;
 104 pub mod inhabitedness;
 105 pub mod layout;
 106 pub mod normalize_erasing_regions;
 107 pub mod print;
 108 pub mod query;
 109 pub mod relate;
 110 pub mod subst;
 111 pub mod trait_def;
 112 pub mod util;
 113 pub mod vtable;
 114 pub mod walk;
 115
 116 mod adt;
 117 mod assoc;
 118 mod closure;
 119 mod consts;
 120 mod context;
 121 mod diagnostics;
 122 mod erase_regions;
 123 mod generics;
 124 mod impls_ty;
 125 mod instance;
 126 mod list;
 127 mod parameterized;
 128 mod rvalue_scopes;
 129 mod structural_impls;
 130 mod sty;
 131
 132 // Data types
 133
 134 pub type RegisteredTools = FxHashSet<Ident>;
 135
 136 #[derive(Debug)]
 137 pub struct ResolverOutputs {
 138     pub visibilities: FxHashMap<LocalDefId, Visibility>,
 139     /// This field is used to decide whether we should make `PRIVATE_IN_PUBLIC` a hard error.
 140     pub has_pub_restricted: bool,
 141     /// Item with a given `LocalDefId` was defined during macro expansion with ID `ExpnId`.
 142     pub expn_that_defined: FxHashMap<LocalDefId, ExpnId>,
 143     /// Reference span for definitions.
 144     pub source_span: IndexVec<LocalDefId, Span>,
 145     pub access_levels: AccessLevels,
 146     pub extern_crate_map: FxHashMap<LocalDefId, CrateNum>,
 147     pub maybe_unused_trait_imports: FxIndexSet<LocalDefId>,
 148     pub maybe_unused_extern_crates: Vec<(LocalDefId, Span)>,
 149     pub reexport_map: FxHashMap<LocalDefId, Vec<ModChild>>,
 150     pub glob_map: FxHashMap<LocalDefId, FxHashSet<Symbol>>,
 151     /// Extern prelude entries. The value is `true` if the entry was introduced
 152     /// via `extern crate` item and not `--extern` option or compiler built-in.
 153     pub extern_prelude: FxHashMap<Symbol, bool>,
 154     pub main_def: Option<MainDefinition>,
 155     pub trait_impls: FxIndexMap<DefId, Vec<LocalDefId>>,
 156     /// A list of proc macro LocalDefIds, written out in the order in which
 157     /// they are declared in the static array generated by proc_macro_harness.
 158     pub proc_macros: Vec<LocalDefId>,
 159     /// Mapping from ident span to path span for paths that don't exist as written, but that
 160     /// exist under `std`. For example, wrote `str::from_utf8` instead of `std::str::from_utf8`.
 161     pub confused_type_with_std_module: FxHashMap<Span, Span>,
 162     pub registered_tools: RegisteredTools,
 163 }
 164
 165 /// Resolutions that should only be used for lowering.
 166 /// This struct is meant to be consumed by lowering.
 167 #[derive(Debug)]
 168 pub struct ResolverAstLowering {
 169     pub legacy_const_generic_args: FxHashMap<DefId, Option<Vec<usize>>>,
 170
 171     /// Resolutions for nodes that have a single resolution.
 172     pub partial_res_map: NodeMap<hir::def::PartialRes>,
 173     /// Resolutions for import nodes, which have multiple resolutions in different namespaces.
 174     pub import_res_map: NodeMap<hir::def::PerNS<Option<Res<ast::NodeId>>>>,
 175     /// Resolutions for labels (node IDs of their corresponding blocks or loops).
 176     pub label_res_map: NodeMap<ast::NodeId>,
 177     /// Resolutions for lifetimes.
 178     pub lifetimes_res_map: NodeMap<LifetimeRes>,
 179     /// Lifetime parameters that lowering will have to introduce.
 180     pub extra_lifetime_params_map: NodeMap<Vec<(Ident, ast::NodeId, LifetimeRes)>>,
 181
 182     pub next_node_id: ast::NodeId,
 183
 184     pub node_id_to_def_id: FxHashMap<ast::NodeId, LocalDefId>,
 185     pub def_id_to_node_id: IndexVec<LocalDefId, ast::NodeId>,
 186
 187     pub trait_map: NodeMap<Vec<hir::TraitCandidate>>,
 188     /// A small map keeping true kinds of built-in macros that appear to be fn-like on
 189     /// the surface (`macro` items in libcore), but are actually attributes or derives.
 190     pub builtin_macro_kinds: FxHashMap<LocalDefId, MacroKind>,
 191 }
 192
 193 #[derive(Clone, Copy, Debug)]
 194 pub struct MainDefinition {
 195     pub res: Res<ast::NodeId>,
 196     pub is_import: bool,
 197     pub span: Span,
 198 }
 199
 200 impl MainDefinition {
 201     pub fn opt_fn_def_id(self) -> Option<DefId> {
 202         if let Res::Def(DefKind::Fn, def_id) = self.res { Some(def_id) } else { None }
 203     }
 204 }
 205
 206 /// The "header" of an impl is everything outside the body: a Self type, a trait
 207 /// ref (in the case of a trait impl), and a set of predicates (from the
 208 /// bounds / where-clauses).
 209 #[derive(Clone, Debug, TypeFoldable)]
 210 pub struct ImplHeader<'tcx> {
 211     pub impl_def_id: DefId,
 212     pub self_ty: Ty<'tcx>,
 213     pub trait_ref: Option<TraitRef<'tcx>>,
 214     pub predicates: Vec<Predicate<'tcx>>,
 215 }
 216
 217 #[derive(Copy, Clone, Debug, TypeFoldable)]
 218 pub enum ImplSubject<'tcx> {
 219     Trait(TraitRef<'tcx>),
 220     Inherent(Ty<'tcx>),
 221 }
 222
 223 #[derive(
 224     Copy,
 225     Clone,
 226     PartialEq,
 227     Eq,
 228     Hash,
 229     TyEncodable,
 230     TyDecodable,
 231     HashStable,
 232     Debug,
 233     TypeFoldable
 234 )]
 235 pub enum ImplPolarity {
 236     /// `impl Trait for Type`
 237     Positive,
 238     /// `impl !Trait for Type`
 239     Negative,
 240     /// `#[rustc_reservation_impl] impl Trait for Type`
 241     ///
 242     /// This is a "stability hack", not a real Rust feature.
 243     /// See #64631 for details.
 244     Reservation,
 245 }
 246
 247 impl ImplPolarity {
 248     /// Flips polarity by turning `Positive` into `Negative` and `Negative` into `Positive`.
 249     pub fn flip(&self) -> Option<ImplPolarity> {
 250         match self {
 251             ImplPolarity::Positive => Some(ImplPolarity::Negative),
 252             ImplPolarity::Negative => Some(ImplPolarity::Positive),
 253             ImplPolarity::Reservation => None,
 254         }
 255     }
 256 }
 257
 258 impl fmt::Display for ImplPolarity {
 259     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 260         match self {
 261             Self::Positive => f.write_str("positive"),
 262             Self::Negative => f.write_str("negative"),
 263             Self::Reservation => f.write_str("reservation"),
 264         }
 265     }
 266 }
 267
 268 #[derive(Clone, Debug, PartialEq, Eq, Copy, Hash, Encodable, Decodable, HashStable)]
 269 pub enum Visibility {
 270     /// Visible everywhere (including in other crates).
 271     Public,
 272     /// Visible only in the given crate-local module.
 273     Restricted(DefId),
 274     /// Not visible anywhere in the local crate. This is the visibility of private external items.
 275     Invisible,
 276 }
 277
 278 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, HashStable, TyEncodable, TyDecodable)]
 279 pub enum BoundConstness {
 280     /// `T: Trait`
 281     NotConst,
 282     /// `T: ~const Trait`
 283     ///
 284     /// Requires resolving to const only when we are in a const context.
 285     ConstIfConst,
 286 }
 287
 288 impl BoundConstness {
 289     /// Reduce `self` and `constness` to two possible combined states instead of four.
 290     pub fn and(&mut self, constness: hir::Constness) -> hir::Constness {
 291         match (constness, self) {
 292             (hir::Constness::Const, BoundConstness::ConstIfConst) => hir::Constness::Const,
 293             (_, this) => {
 294                 *this = BoundConstness::NotConst;
 295                 hir::Constness::NotConst
 296             }
 297         }
 298     }
 299 }
 300
 301 impl fmt::Display for BoundConstness {
 302     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 303         match self {
 304             Self::NotConst => f.write_str("normal"),
 305             Self::ConstIfConst => f.write_str("`~const`"),
 306         }
 307     }
 308 }
 309
 310 #[derive(
 311     Clone,
 312     Debug,
 313     PartialEq,
 314     Eq,
 315     Copy,
 316     Hash,
 317     TyEncodable,
 318     TyDecodable,
 319     HashStable,
 320     TypeFoldable
 321 )]
 322 pub struct ClosureSizeProfileData<'tcx> {
 323     /// Tuple containing the types of closure captures before the feature `capture_disjoint_fields`
 324     pub before_feature_tys: Ty<'tcx>,
 325     /// Tuple containing the types of closure captures after the feature `capture_disjoint_fields`
 326     pub after_feature_tys: Ty<'tcx>,
 327 }
 328
 329 pub trait DefIdTree: Copy {
 330     fn opt_parent(self, id: DefId) -> Option<DefId>;
 331
 332     #[inline]
 333     #[track_caller]
 334     fn parent(self, id: DefId) -> DefId {
 335         match self.opt_parent(id) {
 336             Some(id) => id,
 337             // not `unwrap_or_else` to avoid breaking caller tracking
 338             None => bug!("{id:?} doesn't have a parent"),
 339         }
 340     }
 341
 342     #[inline]
 343     #[track_caller]
 344     fn opt_local_parent(self, id: LocalDefId) -> Option<LocalDefId> {
 345         self.opt_parent(id.to_def_id()).map(DefId::expect_local)
 346     }
 347
 348     #[inline]
 349     #[track_caller]
 350     fn local_parent(self, id: LocalDefId) -> LocalDefId {
 351         self.parent(id.to_def_id()).expect_local()
 352     }
 353
 354     fn is_descendant_of(self, mut descendant: DefId, ancestor: DefId) -> bool {
 355         if descendant.krate != ancestor.krate {
 356             return false;
 357         }
 358
 359         while descendant != ancestor {
 360             match self.opt_parent(descendant) {
 361                 Some(parent) => descendant = parent,
 362                 None => return false,
 363             }
 364         }
 365         true
 366     }
 367 }
 368
 369 impl<'tcx> DefIdTree for TyCtxt<'tcx> {
 370     #[inline]
 371     fn opt_parent(self, id: DefId) -> Option<DefId> {
 372         self.def_key(id).parent.map(|index| DefId { index, ..id })
 373     }
 374 }
 375
 376 impl Visibility {
 377     /// Returns `true` if an item with this visibility is accessible from the given block.
 378     pub fn is_accessible_from<T: DefIdTree>(self, module: DefId, tree: T) -> bool {
 379         let restriction = match self {
 380             // Public items are visible everywhere.
 381             Visibility::Public => return true,
 382             // Private items from other crates are visible nowhere.
 383             Visibility::Invisible => return false,
 384             // Restricted items are visible in an arbitrary local module.
 385             Visibility::Restricted(other) if other.krate != module.krate => return false,
 386             Visibility::Restricted(module) => module,
 387         };
 388
 389         tree.is_descendant_of(module, restriction)
 390     }
 391
 392     /// Returns `true` if this visibility is at least as accessible as the given visibility
 393     pub fn is_at_least<T: DefIdTree>(self, vis: Visibility, tree: T) -> bool {
 394         let vis_restriction = match vis {
 395             Visibility::Public => return self == Visibility::Public,
 396             Visibility::Invisible => return true,
 397             Visibility::Restricted(module) => module,
 398         };
 399
 400         self.is_accessible_from(vis_restriction, tree)
 401     }
 402
 403     // Returns `true` if this item is visible anywhere in the local crate.
 404     pub fn is_visible_locally(self) -> bool {
 405         match self {
 406             Visibility::Public => true,
 407             Visibility::Restricted(def_id) => def_id.is_local(),
 408             Visibility::Invisible => false,
 409         }
 410     }
 411
 412     pub fn is_public(self) -> bool {
 413         matches!(self, Visibility::Public)
 414     }
 415 }
 416
 417 /// The crate variances map is computed during typeck and contains the
 418 /// variance of every item in the local crate. You should not use it
 419 /// directly, because to do so will make your pass dependent on the
 420 /// HIR of every item in the local crate. Instead, use
 421 /// `tcx.variances_of()` to get the variance for a *particular*
 422 /// item.
 423 #[derive(HashStable, Debug)]
 424 pub struct CrateVariancesMap<'tcx> {
 425     /// For each item with generics, maps to a vector of the variance
 426     /// of its generics. If an item has no generics, it will have no
 427     /// entry.
 428     pub variances: FxHashMap<DefId, &'tcx [ty::Variance]>,
 429 }
 430
 431 // Contains information needed to resolve types and (in the future) look up
 432 // the types of AST nodes.
 433 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
 434 pub struct CReaderCacheKey {
 435     pub cnum: Option<CrateNum>,
 436     pub pos: usize,
 437 }
 438
 439 /// Represents a type.
 440 ///
 441 /// IMPORTANT:
 442 /// - This is a very "dumb" struct (with no derives and no `impls`).
 443 /// - Values of this type are always interned and thus unique, and are stored
 444 ///   as an `Interned<TyS>`.
 445 /// - `Ty` (which contains a reference to a `Interned<TyS>`) or `Interned<TyS>`
 446 ///   should be used everywhere instead of `TyS`. In particular, `Ty` has most
 447 ///   of the relevant methods.
 448 #[derive(PartialEq, Eq, PartialOrd, Ord)]
 449 #[allow(rustc::usage_of_ty_tykind)]
 450 pub(crate) struct TyS<'tcx> {
 451     /// This field shouldn't be used directly and may be removed in the future.
 452     /// Use `Ty::kind()` instead.
 453     kind: TyKind<'tcx>,
 454
 455     /// This field provides fast access to information that is also contained
 456     /// in `kind`.
 457     ///
 458     /// This field shouldn't be used directly and may be removed in the future.
 459     /// Use `Ty::flags()` instead.
 460     flags: TypeFlags,
 461
 462     /// This field provides fast access to information that is also contained
 463     /// in `kind`.
 464     ///
 465     /// This is a kind of confusing thing: it stores the smallest
 466     /// binder such that
 467     ///
 468     /// (a) the binder itself captures nothing but
 469     /// (b) all the late-bound things within the type are captured
 470     ///     by some sub-binder.
 471     ///
 472     /// So, for a type without any late-bound things, like `u32`, this
 473     /// will be *innermost*, because that is the innermost binder that
 474     /// captures nothing. But for a type `&'D u32`, where `'D` is a
 475     /// late-bound region with De Bruijn index `D`, this would be `D + 1`
 476     /// -- the binder itself does not capture `D`, but `D` is captured
 477     /// by an inner binder.
 478     ///
 479     /// We call this concept an "exclusive" binder `D` because all
 480     /// De Bruijn indices within the type are contained within `0..D`
 481     /// (exclusive).
 482     outer_exclusive_binder: ty::DebruijnIndex,
 483 }
 484
 485 // `TyS` is used a lot. Make sure it doesn't unintentionally get bigger.
 486 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
 487 static_assert_size!(TyS<'_>, 40);
 488
 489 // We are actually storing a stable hash cache next to the type, so let's
 490 // also check the full size
 491 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
 492 static_assert_size!(WithStableHash<TyS<'_>>, 56);
 493
 494 /// Use this rather than `TyS`, whenever possible.
 495 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, HashStable)]
 496 #[rustc_diagnostic_item = "Ty"]
 497 #[rustc_pass_by_value]
 498 pub struct Ty<'tcx>(Interned<'tcx, WithStableHash<TyS<'tcx>>>);
 499
 500 impl<'tcx> TyCtxt<'tcx> {
 501     /// A "bool" type used in rustc_mir_transform unit tests when we
 502     /// have not spun up a TyCtxt.
 503     pub const BOOL_TY_FOR_UNIT_TESTING: Ty<'tcx> = Ty(Interned::new_unchecked(&WithStableHash {
 504         internee: TyS {
 505             kind: ty::Bool,
 506             flags: TypeFlags::empty(),
 507             outer_exclusive_binder: DebruijnIndex::from_usize(0),
 508         },
 509         stable_hash: Fingerprint::ZERO,
 510     }));
 511 }
 512
 513 impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for TyS<'tcx> {
 514     #[inline]
 515     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
 516         let TyS {
 517             kind,
 518
 519             // The other fields just provide fast access to information that is
 520             // also contained in `kind`, so no need to hash them.
 521             flags: _,
 522
 523             outer_exclusive_binder: _,
 524         } = self;
 525
 526         kind.hash_stable(hcx, hasher)
 527     }
 528 }
 529
 530 impl ty::EarlyBoundRegion {
 531     /// Does this early bound region have a name? Early bound regions normally
 532     /// always have names except when using anonymous lifetimes (`'_`).
 533     pub fn has_name(&self) -> bool {
 534         self.name != kw::UnderscoreLifetime
 535     }
 536 }
 537
 538 /// Represents a predicate.
 539 ///
 540 /// See comments on `TyS`, which apply here too (albeit for
 541 /// `PredicateS`/`Predicate` rather than `TyS`/`Ty`).
 542 #[derive(Debug)]
 543 pub(crate) struct PredicateS<'tcx> {
 544     kind: Binder<'tcx, PredicateKind<'tcx>>,
 545     flags: TypeFlags,
 546     /// See the comment for the corresponding field of [TyS].
 547     outer_exclusive_binder: ty::DebruijnIndex,
 548 }
 549
 550 // This type is used a lot. Make sure it doesn't unintentionally get bigger.
 551 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
 552 static_assert_size!(PredicateS<'_>, 56);
 553
 554 /// Use this rather than `PredicateS`, whenever possible.
 555 #[derive(Clone, Copy, PartialEq, Eq, Hash)]
 556 #[rustc_pass_by_value]
 557 pub struct Predicate<'tcx>(Interned<'tcx, PredicateS<'tcx>>);
 558
 559 impl<'tcx> Predicate<'tcx> {
 560     /// Gets the inner `Binder<'tcx, PredicateKind<'tcx>>`.
 561     #[inline]
 562     pub fn kind(self) -> Binder<'tcx, PredicateKind<'tcx>> {
 563         self.0.kind
 564     }
 565
 566     #[inline(always)]
 567     pub fn flags(self) -> TypeFlags {
 568         self.0.flags
 569     }
 570
 571     #[inline(always)]
 572     pub fn outer_exclusive_binder(self) -> DebruijnIndex {
 573         self.0.outer_exclusive_binder
 574     }
 575
 576     /// Flips the polarity of a Predicate.
 577     ///
 578     /// Given `T: Trait` predicate it returns `T: !Trait` and given `T: !Trait` returns `T: Trait`.
 579     pub fn flip_polarity(self, tcx: TyCtxt<'tcx>) -> Option<Predicate<'tcx>> {
 580         let kind = self
 581             .kind()
 582             .map_bound(|kind| match kind {
 583                 PredicateKind::Trait(TraitPredicate { trait_ref, constness, polarity }) => {
 584                     Some(PredicateKind::Trait(TraitPredicate {
 585                         trait_ref,
 586                         constness,
 587                         polarity: polarity.flip()?,
 588                     }))
 589                 }
 590
 591                 _ => None,
 592             })
 593             .transpose()?;
 594
 595         Some(tcx.mk_predicate(kind))
 596     }
 597 }
 598
 599 impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for Predicate<'tcx> {
 600     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
 601         let PredicateS {
 602             ref kind,
 603
 604             // The other fields just provide fast access to information that is
 605             // also contained in `kind`, so no need to hash them.
 606             flags: _,
 607             outer_exclusive_binder: _,
 608         } = self.0.0;
 609
 610         kind.hash_stable(hcx, hasher);
 611     }
 612 }
 613
 614 #[derive(Clone, Copy, PartialEq, Eq, Hash, TyEncodable, TyDecodable)]
 615 #[derive(HashStable, TypeFoldable)]
 616 pub enum PredicateKind<'tcx> {
 617     /// Corresponds to `where Foo: Bar<A, B, C>`. `Foo` here would be
 618     /// the `Self` type of the trait reference and `A`, `B`, and `C`
 619     /// would be the type parameters.
 620     Trait(TraitPredicate<'tcx>),
 621
 622     /// `where 'a: 'b`
 623     RegionOutlives(RegionOutlivesPredicate<'tcx>),
 624
 625     /// `where T: 'a`
 626     TypeOutlives(TypeOutlivesPredicate<'tcx>),
 627
 628     /// `where <T as TraitRef>::Name == X`, approximately.
 629     /// See the `ProjectionPredicate` struct for details.
 630     Projection(ProjectionPredicate<'tcx>),
 631
 632     /// No syntax: `T` well-formed.
 633     WellFormed(GenericArg<'tcx>),
 634
 635     /// Trait must be object-safe.
 636     ObjectSafe(DefId),
 637
 638     /// No direct syntax. May be thought of as `where T: FnFoo<...>`
 639     /// for some substitutions `...` and `T` being a closure type.
 640     /// Satisfied (or refuted) once we know the closure's kind.
 641     ClosureKind(DefId, SubstsRef<'tcx>, ClosureKind),
 642
 643     /// `T1 <: T2`
 644     ///
 645     /// This obligation is created most often when we have two
 646     /// unresolved type variables and hence don't have enough
 647     /// information to process the subtyping obligation yet.
 648     Subtype(SubtypePredicate<'tcx>),
 649
 650     /// `T1` coerced to `T2`
 651     ///
 652     /// Like a subtyping obligation, this is created most often
 653     /// when we have two unresolved type variables and hence
 654     /// don't have enough information to process the coercion
 655     /// obligation yet. At the moment, we actually process coercions
 656     /// very much like subtyping and don't handle the full coercion
 657     /// logic.
 658     Coerce(CoercePredicate<'tcx>),
 659
 660     /// Constant initializer must evaluate successfully.
 661     ConstEvaluatable(ty::Unevaluated<'tcx, ()>),
 662
 663     /// Constants must be equal. The first component is the const that is expected.
 664     ConstEquate(Const<'tcx>, Const<'tcx>),
 665
 666     /// Represents a type found in the environment that we can use for implied bounds.
 667     ///
 668     /// Only used for Chalk.
 669     TypeWellFormedFromEnv(Ty<'tcx>),
 670 }
 671
 672 /// The crate outlives map is computed during typeck and contains the
 673 /// outlives of every item in the local crate. You should not use it
 674 /// directly, because to do so will make your pass dependent on the
 675 /// HIR of every item in the local crate. Instead, use
 676 /// `tcx.inferred_outlives_of()` to get the outlives for a *particular*
 677 /// item.
 678 #[derive(HashStable, Debug)]
 679 pub struct CratePredicatesMap<'tcx> {
 680     /// For each struct with outlive bounds, maps to a vector of the
 681     /// predicate of its outlive bounds. If an item has no outlives
 682     /// bounds, it will have no entry.
 683     pub predicates: FxHashMap<DefId, &'tcx [(Predicate<'tcx>, Span)]>,
 684 }
 685
 686 impl<'tcx> Predicate<'tcx> {
 687     /// Performs a substitution suitable for going from a
 688     /// poly-trait-ref to supertraits that must hold if that
 689     /// poly-trait-ref holds. This is slightly different from a normal
 690     /// substitution in terms of what happens with bound regions. See
 691     /// lengthy comment below for details.
 692     pub fn subst_supertrait(
 693         self,
 694         tcx: TyCtxt<'tcx>,
 695         trait_ref: &ty::PolyTraitRef<'tcx>,
 696     ) -> Predicate<'tcx> {
 697         // The interaction between HRTB and supertraits is not entirely
 698         // obvious. Let me walk you (and myself) through an example.
 699         //
 700         // Let's start with an easy case. Consider two traits:
 701         //
 702         //     trait Foo<'a>: Bar<'a,'a> { }
 703         //     trait Bar<'b,'c> { }
 704         //
 705         // Now, if we have a trait reference `for<'x> T: Foo<'x>`, then
 706         // we can deduce that `for<'x> T: Bar<'x,'x>`. Basically, if we
 707         // knew that `Foo<'x>` (for any 'x) then we also know that
 708         // `Bar<'x,'x>` (for any 'x). This more-or-less falls out from
 709         // normal substitution.
 710         //
 711         // In terms of why this is sound, the idea is that whenever there
 712         // is an impl of `T:Foo<'a>`, it must show that `T:Bar<'a,'a>`
 713         // holds.  So if there is an impl of `T:Foo<'a>` that applies to
 714         // all `'a`, then we must know that `T:Bar<'a,'a>` holds for all
 715         // `'a`.
 716         //
 717         // Another example to be careful of is this:
 718         //
 719         //     trait Foo1<'a>: for<'b> Bar1<'a,'b> { }
 720         //     trait Bar1<'b,'c> { }
 721         //
 722         // Here, if we have `for<'x> T: Foo1<'x>`, then what do we know?
 723         // The answer is that we know `for<'x,'b> T: Bar1<'x,'b>`. The
 724         // reason is similar to the previous example: any impl of
 725         // `T:Foo1<'x>` must show that `for<'b> T: Bar1<'x, 'b>`.  So
 726         // basically we would want to collapse the bound lifetimes from
 727         // the input (`trait_ref`) and the supertraits.
 728         //
 729         // To achieve this in practice is fairly straightforward. Let's
 730         // consider the more complicated scenario:
 731         //
 732         // - We start out with `for<'x> T: Foo1<'x>`. In this case, `'x`
 733         //   has a De Bruijn index of 1. We want to produce `for<'x,'b> T: Bar1<'x,'b>`,
 734         //   where both `'x` and `'b` would have a DB index of 1.
 735         //   The substitution from the input trait-ref is therefore going to be
 736         //   `'a => 'x` (where `'x` has a DB index of 1).
 737         // - The supertrait-ref is `for<'b> Bar1<'a,'b>`, where `'a` is an
 738         //   early-bound parameter and `'b' is a late-bound parameter with a
 739         //   DB index of 1.
 740         // - If we replace `'a` with `'x` from the input, it too will have
 741         //   a DB index of 1, and thus we'll have `for<'x,'b> Bar1<'x,'b>`
 742         //   just as we wanted.
 743         //
 744         // There is only one catch. If we just apply the substitution `'a
 745         // => 'x` to `for<'b> Bar1<'a,'b>`, the substitution code will
 746         // adjust the DB index because we substituting into a binder (it
 747         // tries to be so smart...) resulting in `for<'x> for<'b>
 748         // Bar1<'x,'b>` (we have no syntax for this, so use your
 749         // imagination). Basically the 'x will have DB index of 2 and 'b
 750         // will have DB index of 1. Not quite what we want. So we apply
 751         // the substitution to the *contents* of the trait reference,
 752         // rather than the trait reference itself (put another way, the
 753         // substitution code expects equal binding levels in the values
 754         // from the substitution and the value being substituted into, and
 755         // this trick achieves that).
 756
 757         // Working through the second example:
 758         // trait_ref: for<'x> T: Foo1<'^0.0>; substs: [T, '^0.0]
 759         // predicate: for<'b> Self: Bar1<'a, '^0.0>; substs: [Self, 'a, '^0.0]
 760         // We want to end up with:
 761         //     for<'x, 'b> T: Bar1<'^0.0, '^0.1>
 762         // To do this:
 763         // 1) We must shift all bound vars in predicate by the length
 764         //    of trait ref's bound vars. So, we would end up with predicate like
 765         //    Self: Bar1<'a, '^0.1>
 766         // 2) We can then apply the trait substs to this, ending up with
 767         //    T: Bar1<'^0.0, '^0.1>
 768         // 3) Finally, to create the final bound vars, we concatenate the bound
 769         //    vars of the trait ref with those of the predicate:
 770         //    ['x, 'b]
 771         let bound_pred = self.kind();
 772         let pred_bound_vars = bound_pred.bound_vars();
 773         let trait_bound_vars = trait_ref.bound_vars();
 774         // 1) Self: Bar1<'a, '^0.0> -> Self: Bar1<'a, '^0.1>
 775         let shifted_pred =
 776             tcx.shift_bound_var_indices(trait_bound_vars.len(), bound_pred.skip_binder());
 777         // 2) Self: Bar1<'a, '^0.1> -> T: Bar1<'^0.0, '^0.1>
 778         let new = EarlyBinder(shifted_pred).subst(tcx, trait_ref.skip_binder().substs);
 779         // 3) ['x] + ['b] -> ['x, 'b]
 780         let bound_vars =
 781             tcx.mk_bound_variable_kinds(trait_bound_vars.iter().chain(pred_bound_vars));
 782         tcx.reuse_or_mk_predicate(self, ty::Binder::bind_with_vars(new, bound_vars))
 783     }
 784 }
 785
 786 #[derive(Clone, Copy, PartialEq, Eq, Hash, TyEncodable, TyDecodable)]
 787 #[derive(HashStable, TypeFoldable)]
 788 pub struct TraitPredicate<'tcx> {
 789     pub trait_ref: TraitRef<'tcx>,
 790
 791     pub constness: BoundConstness,
 792
 793     /// If polarity is Positive: we are proving that the trait is implemented.
 794     ///
 795     /// If polarity is Negative: we are proving that a negative impl of this trait
 796     /// exists. (Note that coherence also checks whether negative impls of supertraits
 797     /// exist via a series of predicates.)
 798     ///
 799     /// If polarity is Reserved: that's a bug.
 800     pub polarity: ImplPolarity,
 801 }
 802
 803 pub type PolyTraitPredicate<'tcx> = ty::Binder<'tcx, TraitPredicate<'tcx>>;
 804
 805 impl<'tcx> TraitPredicate<'tcx> {
 806     pub fn remap_constness(&mut self, tcx: TyCtxt<'tcx>, param_env: &mut ParamEnv<'tcx>) {
 807         if std::intrinsics::unlikely(Some(self.trait_ref.def_id) == tcx.lang_items().drop_trait()) {
 808             // remap without changing constness of this predicate.
 809             // this is because `T: ~const Drop` has a different meaning to `T: Drop`
 810             // FIXME(fee1-dead): remove this logic after beta bump
 811             param_env.remap_constness_with(self.constness)
 812         } else {
 813             *param_env = param_env.with_constness(self.constness.and(param_env.constness()))
 814         }
 815     }
 816
 817     /// Remap the constness of this predicate before emitting it for diagnostics.
 818     pub fn remap_constness_diag(&mut self, param_env: ParamEnv<'tcx>) {
 819         // this is different to `remap_constness` that callees want to print this predicate
 820         // in case of selection errors. `T: ~const Drop` bounds cannot end up here when the
 821         // param_env is not const because we it is always satisfied in non-const contexts.
 822         if let hir::Constness::NotConst = param_env.constness() {
 823             self.constness = ty::BoundConstness::NotConst;
 824         }
 825     }
 826
 827     pub fn def_id(self) -> DefId {
 828         self.trait_ref.def_id
 829     }
 830
 831     pub fn self_ty(self) -> Ty<'tcx> {
 832         self.trait_ref.self_ty()
 833     }
 834
 835     #[inline]
 836     pub fn is_const_if_const(self) -> bool {
 837         self.constness == BoundConstness::ConstIfConst
 838     }
 839 }
 840
 841 impl<'tcx> PolyTraitPredicate<'tcx> {
 842     pub fn def_id(self) -> DefId {
 843         // Ok to skip binder since trait `DefId` does not care about regions.
 844         self.skip_binder().def_id()
 845     }
 846
 847     pub fn self_ty(self) -> ty::Binder<'tcx, Ty<'tcx>> {
 848         self.map_bound(|trait_ref| trait_ref.self_ty())
 849     }
 850
 851     /// Remap the constness of this predicate before emitting it for diagnostics.
 852     pub fn remap_constness_diag(&mut self, param_env: ParamEnv<'tcx>) {
 853         *self = self.map_bound(|mut p| {
 854             p.remap_constness_diag(param_env);
 855             p
 856         });
 857     }
 858
 859     #[inline]
 860     pub fn is_const_if_const(self) -> bool {
 861         self.skip_binder().is_const_if_const()
 862     }
 863 }
 864
 865 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
 866 #[derive(HashStable, TypeFoldable)]
 867 pub struct OutlivesPredicate<A, B>(pub A, pub B); // `A: B`
 868 pub type RegionOutlivesPredicate<'tcx> = OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>;
 869 pub type TypeOutlivesPredicate<'tcx> = OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>;
 870 pub type PolyRegionOutlivesPredicate<'tcx> = ty::Binder<'tcx, RegionOutlivesPredicate<'tcx>>;
 871 pub type PolyTypeOutlivesPredicate<'tcx> = ty::Binder<'tcx, TypeOutlivesPredicate<'tcx>>;
 872
 873 /// Encodes that `a` must be a subtype of `b`. The `a_is_expected` flag indicates
 874 /// whether the `a` type is the type that we should label as "expected" when
 875 /// presenting user diagnostics.
 876 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, TyEncodable, TyDecodable)]
 877 #[derive(HashStable, TypeFoldable)]
 878 pub struct SubtypePredicate<'tcx> {
 879     pub a_is_expected: bool,
 880     pub a: Ty<'tcx>,
 881     pub b: Ty<'tcx>,
 882 }
 883 pub type PolySubtypePredicate<'tcx> = ty::Binder<'tcx, SubtypePredicate<'tcx>>;
 884
 885 /// Encodes that we have to coerce *from* the `a` type to the `b` type.
 886 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, TyEncodable, TyDecodable)]
 887 #[derive(HashStable, TypeFoldable)]
 888 pub struct CoercePredicate<'tcx> {
 889     pub a: Ty<'tcx>,
 890     pub b: Ty<'tcx>,
 891 }
 892 pub type PolyCoercePredicate<'tcx> = ty::Binder<'tcx, CoercePredicate<'tcx>>;
 893
 894 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, TyEncodable, TyDecodable)]
 895 #[derive(HashStable, TypeFoldable)]
 896 pub enum Term<'tcx> {
 897     Ty(Ty<'tcx>),
 898     Const(Const<'tcx>),
 899 }
 900
 901 impl<'tcx> From<Ty<'tcx>> for Term<'tcx> {
 902     fn from(ty: Ty<'tcx>) -> Self {
 903         Term::Ty(ty)
 904     }
 905 }
 906
 907 impl<'tcx> From<Const<'tcx>> for Term<'tcx> {
 908     fn from(c: Const<'tcx>) -> Self {
 909         Term::Const(c)
 910     }
 911 }
 912
 913 impl<'tcx> Term<'tcx> {
 914     pub fn ty(&self) -> Option<Ty<'tcx>> {
 915         if let Term::Ty(ty) = self { Some(*ty) } else { None }
 916     }
 917     pub fn ct(&self) -> Option<Const<'tcx>> {
 918         if let Term::Const(c) = self { Some(*c) } else { None }
 919     }
 920 }
 921
 922 /// This kind of predicate has no *direct* correspondent in the
 923 /// syntax, but it roughly corresponds to the syntactic forms:
 924 ///
 925 /// 1. `T: TraitRef<..., Item = Type>`
 926 /// 2. `<T as TraitRef<...>>::Item == Type` (NYI)
 927 ///
 928 /// In particular, form #1 is "desugared" to the combination of a
 929 /// normal trait predicate (`T: TraitRef<...>`) and one of these
 930 /// predicates. Form #2 is a broader form in that it also permits
 931 /// equality between arbitrary types. Processing an instance of
 932 /// Form #2 eventually yields one of these `ProjectionPredicate`
 933 /// instances to normalize the LHS.
 934 #[derive(Copy, Clone, PartialEq, Eq, Hash, TyEncodable, TyDecodable)]
 935 #[derive(HashStable, TypeFoldable)]
 936 pub struct ProjectionPredicate<'tcx> {
 937     pub projection_ty: ProjectionTy<'tcx>,
 938     pub term: Term<'tcx>,
 939 }
 940
 941 pub type PolyProjectionPredicate<'tcx> = Binder<'tcx, ProjectionPredicate<'tcx>>;
 942
 943 impl<'tcx> PolyProjectionPredicate<'tcx> {
 944     /// Returns the `DefId` of the trait of the associated item being projected.
 945     #[inline]
 946     pub fn trait_def_id(&self, tcx: TyCtxt<'tcx>) -> DefId {
 947         self.skip_binder().projection_ty.trait_def_id(tcx)
 948     }
 949
 950     /// Get the [PolyTraitRef] required for this projection to be well formed.
 951     /// Note that for generic associated types the predicates of the associated
 952     /// type also need to be checked.
 953     #[inline]
 954     pub fn required_poly_trait_ref(&self, tcx: TyCtxt<'tcx>) -> PolyTraitRef<'tcx> {
 955         // Note: unlike with `TraitRef::to_poly_trait_ref()`,
 956         // `self.0.trait_ref` is permitted to have escaping regions.
 957         // This is because here `self` has a `Binder` and so does our
 958         // return value, so we are preserving the number of binding
 959         // levels.
 960         self.map_bound(|predicate| predicate.projection_ty.trait_ref(tcx))
 961     }
 962
 963     pub fn term(&self) -> Binder<'tcx, Term<'tcx>> {
 964         self.map_bound(|predicate| predicate.term)
 965     }
 966
 967     /// The `DefId` of the `TraitItem` for the associated type.
 968     ///
 969     /// Note that this is not the `DefId` of the `TraitRef` containing this
 970     /// associated type, which is in `tcx.associated_item(projection_def_id()).container`.
 971     pub fn projection_def_id(&self) -> DefId {
 972         // Ok to skip binder since trait `DefId` does not care about regions.
 973         self.skip_binder().projection_ty.item_def_id
 974     }
 975 }
 976
 977 pub trait ToPolyTraitRef<'tcx> {
 978     fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx>;
 979 }
 980
 981 impl<'tcx> ToPolyTraitRef<'tcx> for PolyTraitPredicate<'tcx> {
 982     fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
 983         self.map_bound_ref(|trait_pred| trait_pred.trait_ref)
 984     }
 985 }
 986
 987 pub trait ToPredicate<'tcx> {
 988     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx>;
 989 }
 990
 991 impl<'tcx> ToPredicate<'tcx> for Binder<'tcx, PredicateKind<'tcx>> {
 992     #[inline(always)]
 993     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx> {
 994         tcx.mk_predicate(self)
 995     }
 996 }
 997
 998 impl<'tcx> ToPredicate<'tcx> for PolyTraitPredicate<'tcx> {
 999     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx> {
1000         self.map_bound(PredicateKind::Trait).to_predicate(tcx)
1001     }
1002 }
1003
1004 impl<'tcx> ToPredicate<'tcx> for PolyRegionOutlivesPredicate<'tcx> {
1005     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx> {
1006         self.map_bound(PredicateKind::RegionOutlives).to_predicate(tcx)
1007     }
1008 }
1009
1010 impl<'tcx> ToPredicate<'tcx> for PolyTypeOutlivesPredicate<'tcx> {
1011     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx> {
1012         self.map_bound(PredicateKind::TypeOutlives).to_predicate(tcx)
1013     }
1014 }
1015
1016 impl<'tcx> ToPredicate<'tcx> for PolyProjectionPredicate<'tcx> {
1017     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx> {
1018         self.map_bound(PredicateKind::Projection).to_predicate(tcx)
1019     }
1020 }
1021
1022 impl<'tcx> Predicate<'tcx> {
1023     pub fn to_opt_poly_trait_pred(self) -> Option<PolyTraitPredicate<'tcx>> {
1024         let predicate = self.kind();
1025         match predicate.skip_binder() {
1026             PredicateKind::Trait(t) => Some(predicate.rebind(t)),
1027             PredicateKind::Projection(..)
1028             | PredicateKind::Subtype(..)
1029             | PredicateKind::Coerce(..)
1030             | PredicateKind::RegionOutlives(..)
1031             | PredicateKind::WellFormed(..)
1032             | PredicateKind::ObjectSafe(..)
1033             | PredicateKind::ClosureKind(..)
1034             | PredicateKind::TypeOutlives(..)
1035             | PredicateKind::ConstEvaluatable(..)
1036             | PredicateKind::ConstEquate(..)
1037             | PredicateKind::TypeWellFormedFromEnv(..) => None,
1038         }
1039     }
1040
1041     pub fn to_opt_type_outlives(self) -> Option<PolyTypeOutlivesPredicate<'tcx>> {
1042         let predicate = self.kind();
1043         match predicate.skip_binder() {
1044             PredicateKind::TypeOutlives(data) => Some(predicate.rebind(data)),
1045             PredicateKind::Trait(..)
1046             | PredicateKind::Projection(..)
1047             | PredicateKind::Subtype(..)
1048             | PredicateKind::Coerce(..)
1049             | PredicateKind::RegionOutlives(..)
1050             | PredicateKind::WellFormed(..)
1051             | PredicateKind::ObjectSafe(..)
1052             | PredicateKind::ClosureKind(..)
1053             | PredicateKind::ConstEvaluatable(..)
1054             | PredicateKind::ConstEquate(..)
1055             | PredicateKind::TypeWellFormedFromEnv(..) => None,
1056         }
1057     }
1058 }
1059
1060 /// Represents the bounds declared on a particular set of type
1061 /// parameters. Should eventually be generalized into a flag list of
1062 /// where-clauses. You can obtain an `InstantiatedPredicates` list from a
1063 /// `GenericPredicates` by using the `instantiate` method. Note that this method
1064 /// reflects an important semantic invariant of `InstantiatedPredicates`: while
1065 /// the `GenericPredicates` are expressed in terms of the bound type
1066 /// parameters of the impl/trait/whatever, an `InstantiatedPredicates` instance
1067 /// represented a set of bounds for some particular instantiation,
1068 /// meaning that the generic parameters have been substituted with
1069 /// their values.
1070 ///
1071 /// Example:
1072 /// ```ignore (illustrative)
1073 /// struct Foo<T, U: Bar<T>> { ... }
1074 /// ```
1075 /// Here, the `GenericPredicates` for `Foo` would contain a list of bounds like
1076 /// `[[], [U:Bar<T>]]`. Now if there were some particular reference
1077 /// like `Foo<isize,usize>`, then the `InstantiatedPredicates` would be `[[],
1078 /// [usize:Bar<isize>]]`.
1079 #[derive(Clone, Debug, TypeFoldable)]
1080 pub struct InstantiatedPredicates<'tcx> {
1081     pub predicates: Vec<Predicate<'tcx>>,
1082     pub spans: Vec<Span>,
1083 }
1084
1085 impl<'tcx> InstantiatedPredicates<'tcx> {
1086     pub fn empty() -> InstantiatedPredicates<'tcx> {
1087         InstantiatedPredicates { predicates: vec![], spans: vec![] }
1088     }
1089
1090     pub fn is_empty(&self) -> bool {
1091         self.predicates.is_empty()
1092     }
1093 }
1094
1095 #[derive(
1096     Copy,
1097     Clone,
1098     Debug,
1099     PartialEq,
1100     Eq,
1101     HashStable,
1102     TyEncodable,
1103     TyDecodable,
1104     TypeFoldable,
1105     Lift
1106 )]
1107 pub struct OpaqueTypeKey<'tcx> {
1108     pub def_id: DefId,
1109     pub substs: SubstsRef<'tcx>,
1110 }
1111
1112 #[derive(Copy, Clone, Debug, TypeFoldable, HashStable, TyEncodable, TyDecodable)]
1113 pub struct OpaqueHiddenType<'tcx> {
1114     /// The span of this particular definition of the opaque type. So
1115     /// for example:
1116     ///
1117     /// ```ignore (incomplete snippet)
1118     /// type Foo = impl Baz;
1119     /// fn bar() -> Foo {
1120     /// //          ^^^ This is the span we are looking for!
1121     /// }
1122     /// ```
1123     ///
1124     /// In cases where the fn returns `(impl Trait, impl Trait)` or
1125     /// other such combinations, the result is currently
1126     /// over-approximated, but better than nothing.
1127     pub span: Span,
1128
1129     /// The type variable that represents the value of the opaque type
1130     /// that we require. In other words, after we compile this function,
1131     /// we will be created a constraint like:
1132     /// ```ignore (pseudo-rust)
1133     /// Foo<'a, T> = ?C
1134     /// ```
1135     /// where `?C` is the value of this type variable. =) It may
1136     /// naturally refer to the type and lifetime parameters in scope
1137     /// in this function, though ultimately it should only reference
1138     /// those that are arguments to `Foo` in the constraint above. (In
1139     /// other words, `?C` should not include `'b`, even though it's a
1140     /// lifetime parameter on `foo`.)
1141     pub ty: Ty<'tcx>,
1142 }
1143
1144 impl<'tcx> OpaqueHiddenType<'tcx> {
1145     pub fn report_mismatch(&self, other: &Self, tcx: TyCtxt<'tcx>) {
1146         // Found different concrete types for the opaque type.
1147         let mut err = tcx.sess.struct_span_err(
1148             other.span,
1149             "concrete type differs from previous defining opaque type use",
1150         );
1151         err.span_label(other.span, format!("expected `{}`, got `{}`", self.ty, other.ty));
1152         if self.span == other.span {
1153             err.span_label(
1154                 self.span,
1155                 "this expression supplies two conflicting concrete types for the same opaque type",
1156             );
1157         } else {
1158             err.span_note(self.span, "previous use here");
1159         }
1160         err.emit();
1161     }
1162 }
1163
1164 /// The "placeholder index" fully defines a placeholder region, type, or const. Placeholders are
1165 /// identified by both a universe, as well as a name residing within that universe. Distinct bound
1166 /// regions/types/consts within the same universe simply have an unknown relationship to one
1167 /// another.
1168 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, TyEncodable, TyDecodable, PartialOrd, Ord)]
1169 pub struct Placeholder<T> {
1170     pub universe: UniverseIndex,
1171     pub name: T,
1172 }
1173
1174 impl<'a, T> HashStable<StableHashingContext<'a>> for Placeholder<T>
1175 where
1176     T: HashStable<StableHashingContext<'a>>,
1177 {
1178     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
1179         self.universe.hash_stable(hcx, hasher);
1180         self.name.hash_stable(hcx, hasher);
1181     }
1182 }
1183
1184 pub type PlaceholderRegion = Placeholder<BoundRegionKind>;
1185
1186 pub type PlaceholderType = Placeholder<BoundVar>;
1187
1188 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, HashStable)]
1189 #[derive(TyEncodable, TyDecodable, PartialOrd, Ord)]
1190 pub struct BoundConst<'tcx> {
1191     pub var: BoundVar,
1192     pub ty: Ty<'tcx>,
1193 }
1194
1195 pub type PlaceholderConst<'tcx> = Placeholder<BoundConst<'tcx>>;
1196
1197 /// A `DefId` which, in case it is a const argument, is potentially bundled with
1198 /// the `DefId` of the generic parameter it instantiates.
1199 ///
1200 /// This is used to avoid calls to `type_of` for const arguments during typeck
1201 /// which cause cycle errors.
1202 ///
1203 /// ```rust
1204 /// struct A;
1205 /// impl A {
1206 ///     fn foo<const N: usize>(&self) -> [u8; N] { [0; N] }
1207 ///     //           ^ const parameter
1208 /// }
1209 /// struct B;
1210 /// impl B {
1211 ///     fn foo<const M: u8>(&self) -> usize { 42 }
1212 ///     //           ^ const parameter
1213 /// }
1214 ///
1215 /// fn main() {
1216 ///     let a = A;
1217 ///     let _b = a.foo::<{ 3 + 7 }>();
1218 ///     //               ^^^^^^^^^ const argument
1219 /// }
1220 /// ```
1221 ///
1222 /// Let's look at the call `a.foo::<{ 3 + 7 }>()` here. We do not know
1223 /// which `foo` is used until we know the type of `a`.
1224 ///
1225 /// We only know the type of `a` once we are inside of `typeck(main)`.
1226 /// We also end up normalizing the type of `_b` during `typeck(main)` which
1227 /// requires us to evaluate the const argument.
1228 ///
1229 /// To evaluate that const argument we need to know its type,
1230 /// which we would get using `type_of(const_arg)`. This requires us to
1231 /// resolve `foo` as it can be either `usize` or `u8` in this example.
1232 /// However, resolving `foo` once again requires `typeck(main)` to get the type of `a`,
1233 /// which results in a cycle.
1234 ///
1235 /// In short we must not call `type_of(const_arg)` during `typeck(main)`.
1236 ///
1237 /// When first creating the `ty::Const` of the const argument inside of `typeck` we have
1238 /// already resolved `foo` so we know which const parameter this argument instantiates.
1239 /// This means that we also know the expected result of `type_of(const_arg)` even if we
1240 /// aren't allowed to call that query: it is equal to `type_of(const_param)` which is
1241 /// trivial to compute.
1242 ///
1243 /// If we now want to use that constant in a place which potentially needs its type
1244 /// we also pass the type of its `const_param`. This is the point of `WithOptConstParam`,
1245 /// except that instead of a `Ty` we bundle the `DefId` of the const parameter.
1246 /// Meaning that we need to use `type_of(const_param_did)` if `const_param_did` is `Some`
1247 /// to get the type of `did`.
1248 #[derive(Copy, Clone, Debug, TypeFoldable, Lift, TyEncodable, TyDecodable)]
1249 #[derive(PartialEq, Eq, PartialOrd, Ord)]
1250 #[derive(Hash, HashStable)]
1251 pub struct WithOptConstParam<T> {
1252     pub did: T,
1253     /// The `DefId` of the corresponding generic parameter in case `did` is
1254     /// a const argument.
1255     ///
1256     /// Note that even if `did` is a const argument, this may still be `None`.
1257     /// All queries taking `WithOptConstParam` start by calling `tcx.opt_const_param_of(def.did)`
1258     /// to potentially update `param_did` in the case it is `None`.
1259     pub const_param_did: Option<DefId>,
1260 }
1261
1262 impl<T> WithOptConstParam<T> {
1263     /// Creates a new `WithOptConstParam` setting `const_param_did` to `None`.
1264     #[inline(always)]
1265     pub fn unknown(did: T) -> WithOptConstParam<T> {
1266         WithOptConstParam { did, const_param_did: None }
1267     }
1268 }
1269
1270 impl WithOptConstParam<LocalDefId> {
1271     /// Returns `Some((did, param_did))` if `def_id` is a const argument,
1272     /// `None` otherwise.
1273     #[inline(always)]
1274     pub fn try_lookup(did: LocalDefId, tcx: TyCtxt<'_>) -> Option<(LocalDefId, DefId)> {
1275         tcx.opt_const_param_of(did).map(|param_did| (did, param_did))
1276     }
1277
1278     /// In case `self` is unknown but `self.did` is a const argument, this returns
1279     /// a `WithOptConstParam` with the correct `const_param_did`.
1280     #[inline(always)]
1281     pub fn try_upgrade(self, tcx: TyCtxt<'_>) -> Option<WithOptConstParam<LocalDefId>> {
1282         if self.const_param_did.is_none() {
1283             if let const_param_did @ Some(_) = tcx.opt_const_param_of(self.did) {
1284                 return Some(WithOptConstParam { did: self.did, const_param_did });
1285             }
1286         }
1287
1288         None
1289     }
1290
1291     pub fn to_global(self) -> WithOptConstParam<DefId> {
1292         WithOptConstParam { did: self.did.to_def_id(), const_param_did: self.const_param_did }
1293     }
1294
1295     pub fn def_id_for_type_of(self) -> DefId {
1296         if let Some(did) = self.const_param_did { did } else { self.did.to_def_id() }
1297     }
1298 }
1299
1300 impl WithOptConstParam<DefId> {
1301     pub fn as_local(self) -> Option<WithOptConstParam<LocalDefId>> {
1302         self.did
1303             .as_local()
1304             .map(|did| WithOptConstParam { did, const_param_did: self.const_param_did })
1305     }
1306
1307     pub fn as_const_arg(self) -> Option<(LocalDefId, DefId)> {
1308         if let Some(param_did) = self.const_param_did {
1309             if let Some(did) = self.did.as_local() {
1310                 return Some((did, param_did));
1311             }
1312         }
1313
1314         None
1315     }
1316
1317     pub fn is_local(self) -> bool {
1318         self.did.is_local()
1319     }
1320
1321     pub fn def_id_for_type_of(self) -> DefId {
1322         self.const_param_did.unwrap_or(self.did)
1323     }
1324 }
1325
1326 /// When type checking, we use the `ParamEnv` to track
1327 /// details about the set of where-clauses that are in scope at this
1328 /// particular point.
1329 #[derive(Copy, Clone, Hash, PartialEq, Eq)]
1330 pub struct ParamEnv<'tcx> {
1331     /// This packs both caller bounds and the reveal enum into one pointer.
1332     ///
1333     /// Caller bounds are `Obligation`s that the caller must satisfy. This is
1334     /// basically the set of bounds on the in-scope type parameters, translated
1335     /// into `Obligation`s, and elaborated and normalized.
1336     ///
1337     /// Use the `caller_bounds()` method to access.
1338     ///
1339     /// Typically, this is `Reveal::UserFacing`, but during codegen we
1340     /// want `Reveal::All`.
1341     ///
1342     /// Note: This is packed, use the reveal() method to access it.
1343     packed: CopyTaggedPtr<&'tcx List<Predicate<'tcx>>, ParamTag, true>,
1344 }
1345
1346 #[derive(Copy, Clone)]
1347 struct ParamTag {
1348     reveal: traits::Reveal,
1349     constness: hir::Constness,
1350 }
1351
1352 unsafe impl rustc_data_structures::tagged_ptr::Tag for ParamTag {
1353     const BITS: usize = 2;
1354     #[inline]
1355     fn into_usize(self) -> usize {
1356         match self {
1357             Self { reveal: traits::Reveal::UserFacing, constness: hir::Constness::NotConst } => 0,
1358             Self { reveal: traits::Reveal::All, constness: hir::Constness::NotConst } => 1,
1359             Self { reveal: traits::Reveal::UserFacing, constness: hir::Constness::Const } => 2,
1360             Self { reveal: traits::Reveal::All, constness: hir::Constness::Const } => 3,
1361         }
1362     }
1363     #[inline]
1364     unsafe fn from_usize(ptr: usize) -> Self {
1365         match ptr {
1366             0 => Self { reveal: traits::Reveal::UserFacing, constness: hir::Constness::NotConst },
1367             1 => Self { reveal: traits::Reveal::All, constness: hir::Constness::NotConst },
1368             2 => Self { reveal: traits::Reveal::UserFacing, constness: hir::Constness::Const },
1369             3 => Self { reveal: traits::Reveal::All, constness: hir::Constness::Const },
1370             _ => std::hint::unreachable_unchecked(),
1371         }
1372     }
1373 }
1374
1375 impl<'tcx> fmt::Debug for ParamEnv<'tcx> {
1376     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1377         f.debug_struct("ParamEnv")
1378             .field("caller_bounds", &self.caller_bounds())
1379             .field("reveal", &self.reveal())
1380             .field("constness", &self.constness())
1381             .finish()
1382     }
1383 }
1384
1385 impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for ParamEnv<'tcx> {
1386     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
1387         self.caller_bounds().hash_stable(hcx, hasher);
1388         self.reveal().hash_stable(hcx, hasher);
1389         self.constness().hash_stable(hcx, hasher);
1390     }
1391 }
1392
1393 impl<'tcx> TypeFoldable<'tcx> for ParamEnv<'tcx> {
1394     fn try_fold_with<F: ty::fold::FallibleTypeFolder<'tcx>>(
1395         self,
1396         folder: &mut F,
1397     ) -> Result<Self, F::Error> {
1398         Ok(ParamEnv::new(
1399             self.caller_bounds().try_fold_with(folder)?,
1400             self.reveal().try_fold_with(folder)?,
1401             self.constness().try_fold_with(folder)?,
1402         ))
1403     }
1404
1405     fn visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> ControlFlow<V::BreakTy> {
1406         self.caller_bounds().visit_with(visitor)?;
1407         self.reveal().visit_with(visitor)?;
1408         self.constness().visit_with(visitor)
1409     }
1410 }
1411
1412 impl<'tcx> ParamEnv<'tcx> {
1413     /// Construct a trait environment suitable for contexts where
1414     /// there are no where-clauses in scope. Hidden types (like `impl
1415     /// Trait`) are left hidden, so this is suitable for ordinary
1416     /// type-checking.
1417     #[inline]
1418     pub fn empty() -> Self {
1419         Self::new(List::empty(), Reveal::UserFacing, hir::Constness::NotConst)
1420     }
1421
1422     #[inline]
1423     pub fn caller_bounds(self) -> &'tcx List<Predicate<'tcx>> {
1424         self.packed.pointer()
1425     }
1426
1427     #[inline]
1428     pub fn reveal(self) -> traits::Reveal {
1429         self.packed.tag().reveal
1430     }
1431
1432     #[inline]
1433     pub fn constness(self) -> hir::Constness {
1434         self.packed.tag().constness
1435     }
1436
1437     #[inline]
1438     pub fn is_const(self) -> bool {
1439         self.packed.tag().constness == hir::Constness::Const
1440     }
1441
1442     /// Construct a trait environment with no where-clauses in scope
1443     /// where the values of all `impl Trait` and other hidden types
1444     /// are revealed. This is suitable for monomorphized, post-typeck
1445     /// environments like codegen or doing optimizations.
1446     ///
1447     /// N.B., if you want to have predicates in scope, use `ParamEnv::new`,
1448     /// or invoke `param_env.with_reveal_all()`.
1449     #[inline]
1450     pub fn reveal_all() -> Self {
1451         Self::new(List::empty(), Reveal::All, hir::Constness::NotConst)
1452     }
1453
1454     /// Construct a trait environment with the given set of predicates.
1455     #[inline]
1456     pub fn new(
1457         caller_bounds: &'tcx List<Predicate<'tcx>>,
1458         reveal: Reveal,
1459         constness: hir::Constness,
1460     ) -> Self {
1461         ty::ParamEnv { packed: CopyTaggedPtr::new(caller_bounds, ParamTag { reveal, constness }) }
1462     }
1463
1464     pub fn with_user_facing(mut self) -> Self {
1465         self.packed.set_tag(ParamTag { reveal: Reveal::UserFacing, ..self.packed.tag() });
1466         self
1467     }
1468
1469     #[inline]
1470     pub fn with_constness(mut self, constness: hir::Constness) -> Self {
1471         self.packed.set_tag(ParamTag { constness, ..self.packed.tag() });
1472         self
1473     }
1474
1475     #[inline]
1476     pub fn with_const(mut self) -> Self {
1477         self.packed.set_tag(ParamTag { constness: hir::Constness::Const, ..self.packed.tag() });
1478         self
1479     }
1480
1481     #[inline]
1482     pub fn without_const(mut self) -> Self {
1483         self.packed.set_tag(ParamTag { constness: hir::Constness::NotConst, ..self.packed.tag() });
1484         self
1485     }
1486
1487     #[inline]
1488     pub fn remap_constness_with(&mut self, mut constness: ty::BoundConstness) {
1489         *self = self.with_constness(constness.and(self.constness()))
1490     }
1491
1492     /// Returns a new parameter environment with the same clauses, but
1493     /// which "reveals" the true results of projections in all cases
1494     /// (even for associated types that are specializable). This is
1495     /// the desired behavior during codegen and certain other special
1496     /// contexts; normally though we want to use `Reveal::UserFacing`,
1497     /// which is the default.
1498     /// All opaque types in the caller_bounds of the `ParamEnv`
1499     /// will be normalized to their underlying types.
1500     /// See PR #65989 and issue #65918 for more details
1501     pub fn with_reveal_all_normalized(self, tcx: TyCtxt<'tcx>) -> Self {
1502         if self.packed.tag().reveal == traits::Reveal::All {
1503             return self;
1504         }
1505
1506         ParamEnv::new(
1507             tcx.normalize_opaque_types(self.caller_bounds()),
1508             Reveal::All,
1509             self.constness(),
1510         )
1511     }
1512
1513     /// Returns this same environment but with no caller bounds.
1514     #[inline]
1515     pub fn without_caller_bounds(self) -> Self {
1516         Self::new(List::empty(), self.reveal(), self.constness())
1517     }
1518
1519     /// Creates a suitable environment in which to perform trait
1520     /// queries on the given value. When type-checking, this is simply
1521     /// the pair of the environment plus value. But when reveal is set to
1522     /// All, then if `value` does not reference any type parameters, we will
1523     /// pair it with the empty environment. This improves caching and is generally
1524     /// invisible.
1525     ///
1526     /// N.B., we preserve the environment when type-checking because it
1527     /// is possible for the user to have wacky where-clauses like
1528     /// `where Box<u32>: Copy`, which are clearly never
1529     /// satisfiable. We generally want to behave as if they were true,
1530     /// although the surrounding function is never reachable.
1531     pub fn and<T: TypeFoldable<'tcx>>(self, value: T) -> ParamEnvAnd<'tcx, T> {
1532         match self.reveal() {
1533             Reveal::UserFacing => ParamEnvAnd { param_env: self, value },
1534
1535             Reveal::All => {
1536                 if value.is_global() {
1537                     ParamEnvAnd { param_env: self.without_caller_bounds(), value }
1538                 } else {
1539                     ParamEnvAnd { param_env: self, value }
1540                 }
1541             }
1542         }
1543     }
1544 }
1545
1546 // FIXME(ecstaticmorse): Audit all occurrences of `without_const().to_predicate(tcx)` to ensure that
1547 // the constness of trait bounds is being propagated correctly.
1548 impl<'tcx> PolyTraitRef<'tcx> {
1549     #[inline]
1550     pub fn with_constness(self, constness: BoundConstness) -> PolyTraitPredicate<'tcx> {
1551         self.map_bound(|trait_ref| ty::TraitPredicate {
1552             trait_ref,
1553             constness,
1554             polarity: ty::ImplPolarity::Positive,
1555         })
1556     }
1557
1558     #[inline]
1559     pub fn without_const(self) -> PolyTraitPredicate<'tcx> {
1560         self.with_constness(BoundConstness::NotConst)
1561     }
1562 }
1563
1564 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, TypeFoldable)]
1565 pub struct ParamEnvAnd<'tcx, T> {
1566     pub param_env: ParamEnv<'tcx>,
1567     pub value: T,
1568 }
1569
1570 impl<'tcx, T> ParamEnvAnd<'tcx, T> {
1571     pub fn into_parts(self) -> (ParamEnv<'tcx>, T) {
1572         (self.param_env, self.value)
1573     }
1574
1575     #[inline]
1576     pub fn without_const(mut self) -> Self {
1577         self.param_env = self.param_env.without_const();
1578         self
1579     }
1580 }
1581
1582 impl<'a, 'tcx, T> HashStable<StableHashingContext<'a>> for ParamEnvAnd<'tcx, T>
1583 where
1584     T: HashStable<StableHashingContext<'a>>,
1585 {
1586     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
1587         let ParamEnvAnd { ref param_env, ref value } = *self;
1588
1589         param_env.hash_stable(hcx, hasher);
1590         value.hash_stable(hcx, hasher);
1591     }
1592 }
1593
1594 #[derive(Copy, Clone, Debug, HashStable, Encodable, Decodable)]
1595 pub struct Destructor {
1596     /// The `DefId` of the destructor method
1597     pub did: DefId,
1598     /// The constness of the destructor method
1599     pub constness: hir::Constness,
1600 }
1601
1602 bitflags! {
1603     #[derive(HashStable, TyEncodable, TyDecodable)]
1604     pub struct VariantFlags: u32 {
1605         const NO_VARIANT_FLAGS        = 0;
1606         /// Indicates whether the field list of this variant is `#[non_exhaustive]`.
1607         const IS_FIELD_LIST_NON_EXHAUSTIVE = 1 << 0;
1608         /// Indicates whether this variant was obtained as part of recovering from
1609         /// a syntactic error. May be incomplete or bogus.
1610         const IS_RECOVERED = 1 << 1;
1611     }
1612 }
1613
1614 /// Definition of a variant -- a struct's fields or an enum variant.
1615 #[derive(Debug, HashStable, TyEncodable, TyDecodable)]
1616 pub struct VariantDef {
1617     /// `DefId` that identifies the variant itself.
1618     /// If this variant belongs to a struct or union, then this is a copy of its `DefId`.
1619     pub def_id: DefId,
1620     /// `DefId` that identifies the variant's constructor.
1621     /// If this variant is a struct variant, then this is `None`.
1622     pub ctor_def_id: Option<DefId>,
1623     /// Variant or struct name.
1624     pub name: Symbol,
1625     /// Discriminant of this variant.
1626     pub discr: VariantDiscr,
1627     /// Fields of this variant.
1628     pub fields: Vec<FieldDef>,
1629     /// Type of constructor of variant.
1630     pub ctor_kind: CtorKind,
1631     /// Flags of the variant (e.g. is field list non-exhaustive)?
1632     flags: VariantFlags,
1633 }
1634
1635 impl VariantDef {
1636     /// Creates a new `VariantDef`.
1637     ///
1638     /// `variant_did` is the `DefId` that identifies the enum variant (if this `VariantDef`
1639     /// represents an enum variant).
1640     ///
1641     /// `ctor_did` is the `DefId` that identifies the constructor of unit or
1642     /// tuple-variants/structs. If this is a `struct`-variant then this should be `None`.
1643     ///
1644     /// `parent_did` is the `DefId` of the `AdtDef` representing the enum or struct that
1645     /// owns this variant. It is used for checking if a struct has `#[non_exhaustive]` w/out having
1646     /// to go through the redirect of checking the ctor's attributes - but compiling a small crate
1647     /// requires loading the `AdtDef`s for all the structs in the universe (e.g., coherence for any
1648     /// built-in trait), and we do not want to load attributes twice.
1649     ///
1650     /// If someone speeds up attribute loading to not be a performance concern, they can
1651     /// remove this hack and use the constructor `DefId` everywhere.
1652     pub fn new(
1653         name: Symbol,
1654         variant_did: Option<DefId>,
1655         ctor_def_id: Option<DefId>,
1656         discr: VariantDiscr,
1657         fields: Vec<FieldDef>,
1658         ctor_kind: CtorKind,
1659         adt_kind: AdtKind,
1660         parent_did: DefId,
1661         recovered: bool,
1662         is_field_list_non_exhaustive: bool,
1663     ) -> Self {
1664         debug!(
1665             "VariantDef::new(name = {:?}, variant_did = {:?}, ctor_def_id = {:?}, discr = {:?},
1666              fields = {:?}, ctor_kind = {:?}, adt_kind = {:?}, parent_did = {:?})",
1667             name, variant_did, ctor_def_id, discr, fields, ctor_kind, adt_kind, parent_did,
1668         );
1669
1670         let mut flags = VariantFlags::NO_VARIANT_FLAGS;
1671         if is_field_list_non_exhaustive {
1672             flags |= VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE;
1673         }
1674
1675         if recovered {
1676             flags |= VariantFlags::IS_RECOVERED;
1677         }
1678
1679         VariantDef {
1680             def_id: variant_did.unwrap_or(parent_did),
1681             ctor_def_id,
1682             name,
1683             discr,
1684             fields,
1685             ctor_kind,
1686             flags,
1687         }
1688     }
1689
1690     /// Is this field list non-exhaustive?
1691     #[inline]
1692     pub fn is_field_list_non_exhaustive(&self) -> bool {
1693         self.flags.intersects(VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE)
1694     }
1695
1696     /// Was this variant obtained as part of recovering from a syntactic error?
1697     #[inline]
1698     pub fn is_recovered(&self) -> bool {
1699         self.flags.intersects(VariantFlags::IS_RECOVERED)
1700     }
1701
1702     /// Computes the `Ident` of this variant by looking up the `Span`
1703     pub fn ident(&self, tcx: TyCtxt<'_>) -> Ident {
1704         Ident::new(self.name, tcx.def_ident_span(self.def_id).unwrap())
1705     }
1706 }
1707
1708 #[derive(Copy, Clone, Debug, PartialEq, Eq, TyEncodable, TyDecodable, HashStable)]
1709 pub enum VariantDiscr {
1710     /// Explicit value for this variant, i.e., `X = 123`.
1711     /// The `DefId` corresponds to the embedded constant.
1712     Explicit(DefId),
1713
1714     /// The previous variant's discriminant plus one.
1715     /// For efficiency reasons, the distance from the
1716     /// last `Explicit` discriminant is being stored,
1717     /// or `0` for the first variant, if it has none.
1718     Relative(u32),
1719 }
1720
1721 #[derive(Debug, HashStable, TyEncodable, TyDecodable)]
1722 pub struct FieldDef {
1723     pub did: DefId,
1724     pub name: Symbol,
1725     pub vis: Visibility,
1726 }
1727
1728 bitflags! {
1729     #[derive(TyEncodable, TyDecodable, Default, HashStable)]
1730     pub struct ReprFlags: u8 {
1731         const IS_C               = 1 << 0;
1732         const IS_SIMD            = 1 << 1;
1733         const IS_TRANSPARENT     = 1 << 2;
1734         // Internal only for now. If true, don't reorder fields.
1735         const IS_LINEAR          = 1 << 3;
1736         // If true, don't expose any niche to type's context.
1737         const HIDE_NICHE         = 1 << 4;
1738         // If true, the type's layout can be randomized using
1739         // the seed stored in `ReprOptions.layout_seed`
1740         const RANDOMIZE_LAYOUT   = 1 << 5;
1741         // Any of these flags being set prevent field reordering optimisation.
1742         const IS_UNOPTIMISABLE   = ReprFlags::IS_C.bits
1743                                  | ReprFlags::IS_SIMD.bits
1744                                  | ReprFlags::IS_LINEAR.bits;
1745     }
1746 }
1747
1748 /// Represents the repr options provided by the user,
1749 #[derive(Copy, Clone, Debug, Eq, PartialEq, TyEncodable, TyDecodable, Default, HashStable)]
1750 pub struct ReprOptions {
1751     pub int: Option<attr::IntType>,
1752     pub align: Option<Align>,
1753     pub pack: Option<Align>,
1754     pub flags: ReprFlags,
1755     /// The seed to be used for randomizing a type's layout
1756     ///
1757     /// Note: This could technically be a `[u8; 16]` (a `u128`) which would
1758     /// be the "most accurate" hash as it'd encompass the item and crate
1759     /// hash without loss, but it does pay the price of being larger.
1760     /// Everything's a tradeoff, a `u64` seed should be sufficient for our
1761     /// purposes (primarily `-Z randomize-layout`)
1762     pub field_shuffle_seed: u64,
1763 }
1764
1765 impl ReprOptions {
1766     pub fn new(tcx: TyCtxt<'_>, did: DefId) -> ReprOptions {
1767         let mut flags = ReprFlags::empty();
1768         let mut size = None;
1769         let mut max_align: Option<Align> = None;
1770         let mut min_pack: Option<Align> = None;
1771
1772         // Generate a deterministically-derived seed from the item's path hash
1773         // to allow for cross-crate compilation to actually work
1774         let mut field_shuffle_seed = tcx.def_path_hash(did).0.to_smaller_hash();
1775
1776         // If the user defined a custom seed for layout randomization, xor the item's
1777         // path hash with the user defined seed, this will allowing determinism while
1778         // still allowing users to further randomize layout generation for e.g. fuzzing
1779         if let Some(user_seed) = tcx.sess.opts.debugging_opts.layout_seed {
1780             field_shuffle_seed ^= user_seed;
1781         }
1782
1783         for attr in tcx.get_attrs(did, sym::repr) {
1784             for r in attr::parse_repr_attr(&tcx.sess, attr) {
1785                 flags.insert(match r {
1786                     attr::ReprC => ReprFlags::IS_C,
1787                     attr::ReprPacked(pack) => {
1788                         let pack = Align::from_bytes(pack as u64).unwrap();
1789                         min_pack = Some(if let Some(min_pack) = min_pack {
1790                             min_pack.min(pack)
1791                         } else {
1792                             pack
1793                         });
1794                         ReprFlags::empty()
1795                     }
1796                     attr::ReprTransparent => ReprFlags::IS_TRANSPARENT,
1797                     attr::ReprNoNiche => ReprFlags::HIDE_NICHE,
1798                     attr::ReprSimd => ReprFlags::IS_SIMD,
1799                     attr::ReprInt(i) => {
1800                         size = Some(i);
1801                         ReprFlags::empty()
1802                     }
1803                     attr::ReprAlign(align) => {
1804                         max_align = max_align.max(Some(Align::from_bytes(align as u64).unwrap()));
1805                         ReprFlags::empty()
1806                     }
1807                 });
1808             }
1809         }
1810
1811         // If `-Z randomize-layout` was enabled for the type definition then we can
1812         // consider performing layout randomization
1813         if tcx.sess.opts.debugging_opts.randomize_layout {
1814             flags.insert(ReprFlags::RANDOMIZE_LAYOUT);
1815         }
1816
1817         // This is here instead of layout because the choice must make it into metadata.
1818         if !tcx.consider_optimizing(|| format!("Reorder fields of {:?}", tcx.def_path_str(did))) {
1819             flags.insert(ReprFlags::IS_LINEAR);
1820         }
1821
1822         Self { int: size, align: max_align, pack: min_pack, flags, field_shuffle_seed }
1823     }
1824
1825     #[inline]
1826     pub fn simd(&self) -> bool {
1827         self.flags.contains(ReprFlags::IS_SIMD)
1828     }
1829
1830     #[inline]
1831     pub fn c(&self) -> bool {
1832         self.flags.contains(ReprFlags::IS_C)
1833     }
1834
1835     #[inline]
1836     pub fn packed(&self) -> bool {
1837         self.pack.is_some()
1838     }
1839
1840     #[inline]
1841     pub fn transparent(&self) -> bool {
1842         self.flags.contains(ReprFlags::IS_TRANSPARENT)
1843     }
1844
1845     #[inline]
1846     pub fn linear(&self) -> bool {
1847         self.flags.contains(ReprFlags::IS_LINEAR)
1848     }
1849
1850     #[inline]
1851     pub fn hide_niche(&self) -> bool {
1852         self.flags.contains(ReprFlags::HIDE_NICHE)
1853     }
1854
1855     /// Returns the discriminant type, given these `repr` options.
1856     /// This must only be called on enums!
1857     pub fn discr_type(&self) -> attr::IntType {
1858         self.int.unwrap_or(attr::SignedInt(ast::IntTy::Isize))
1859     }
1860
1861     /// Returns `true` if this `#[repr()]` should inhabit "smart enum
1862     /// layout" optimizations, such as representing `Foo<&T>` as a
1863     /// single pointer.
1864     pub fn inhibit_enum_layout_opt(&self) -> bool {
1865         self.c() || self.int.is_some()
1866     }
1867
1868     /// Returns `true` if this `#[repr()]` should inhibit struct field reordering
1869     /// optimizations, such as with `repr(C)`, `repr(packed(1))`, or `repr(<int>)`.
1870     pub fn inhibit_struct_field_reordering_opt(&self) -> bool {
1871         if let Some(pack) = self.pack {
1872             if pack.bytes() == 1 {
1873                 return true;
1874             }
1875         }
1876
1877         self.flags.intersects(ReprFlags::IS_UNOPTIMISABLE) || self.int.is_some()
1878     }
1879
1880     /// Returns `true` if this type is valid for reordering and `-Z randomize-layout`
1881     /// was enabled for its declaration crate
1882     pub fn can_randomize_type_layout(&self) -> bool {
1883         !self.inhibit_struct_field_reordering_opt()
1884             && self.flags.contains(ReprFlags::RANDOMIZE_LAYOUT)
1885     }
1886
1887     /// Returns `true` if this `#[repr()]` should inhibit union ABI optimisations.
1888     pub fn inhibit_union_abi_opt(&self) -> bool {
1889         self.c()
1890     }
1891 }
1892
1893 impl<'tcx> FieldDef {
1894     /// Returns the type of this field. The resulting type is not normalized. The `subst` is
1895     /// typically obtained via the second field of [`TyKind::Adt`].
1896     pub fn ty(&self, tcx: TyCtxt<'tcx>, subst: SubstsRef<'tcx>) -> Ty<'tcx> {
1897         tcx.bound_type_of(self.did).subst(tcx, subst)
1898     }
1899
1900     /// Computes the `Ident` of this variant by looking up the `Span`
1901     pub fn ident(&self, tcx: TyCtxt<'_>) -> Ident {
1902         Ident::new(self.name, tcx.def_ident_span(self.did).unwrap())
1903     }
1904 }
1905
1906 pub type Attributes<'tcx> = impl Iterator<Item = &'tcx ast::Attribute>;
1907 #[derive(Debug, PartialEq, Eq)]
1908 pub enum ImplOverlapKind {
1909     /// These impls are always allowed to overlap.
1910     Permitted {
1911         /// Whether or not the impl is permitted due to the trait being a `#[marker]` trait
1912         marker: bool,
1913     },
1914     /// These impls are allowed to overlap, but that raises
1915     /// an issue #33140 future-compatibility warning.
1916     ///
1917     /// Some background: in Rust 1.0, the trait-object types `Send + Sync` (today's
1918     /// `dyn Send + Sync`) and `Sync + Send` (now `dyn Sync + Send`) were different.
1919     ///
1920     /// The widely-used version 0.1.0 of the crate `traitobject` had accidentally relied
1921     /// that difference, making what reduces to the following set of impls:
1922     ///
1923     /// ```compile_fail,(E0119)
1924     /// trait Trait {}
1925     /// impl Trait for dyn Send + Sync {}
1926     /// impl Trait for dyn Sync + Send {}
1927     /// ```
1928     ///
1929     /// Obviously, once we made these types be identical, that code causes a coherence
1930     /// error and a fairly big headache for us. However, luckily for us, the trait
1931     /// `Trait` used in this case is basically a marker trait, and therefore having
1932     /// overlapping impls for it is sound.
1933     ///
1934     /// To handle this, we basically regard the trait as a marker trait, with an additional
1935     /// future-compatibility warning. To avoid accidentally "stabilizing" this feature,
1936     /// it has the following restrictions:
1937     ///
1938     /// 1. The trait must indeed be a marker-like trait (i.e., no items), and must be
1939     /// positive impls.
1940     /// 2. The trait-ref of both impls must be equal.
1941     /// 3. The trait-ref of both impls must be a trait object type consisting only of
1942     /// marker traits.
1943     /// 4. Neither of the impls can have any where-clauses.
1944     ///
1945     /// Once `traitobject` 0.1.0 is no longer an active concern, this hack can be removed.
1946     Issue33140,
1947 }
1948
1949 impl<'tcx> TyCtxt<'tcx> {
1950     pub fn typeck_body(self, body: hir::BodyId) -> &'tcx TypeckResults<'tcx> {
1951         self.typeck(self.hir().body_owner_def_id(body))
1952     }
1953
1954     pub fn provided_trait_methods(self, id: DefId) -> impl 'tcx + Iterator<Item = &'tcx AssocItem> {
1955         self.associated_items(id)
1956             .in_definition_order()
1957             .filter(|item| item.kind == AssocKind::Fn && item.defaultness.has_value())
1958     }
1959
1960     /// Look up the name of a definition across crates. This does not look at HIR.
1961     pub fn opt_item_name(self, def_id: DefId) -> Option<Symbol> {
1962         if let Some(cnum) = def_id.as_crate_root() {
1963             Some(self.crate_name(cnum))
1964         } else {
1965             let def_key = self.def_key(def_id);
1966             match def_key.disambiguated_data.data {
1967                 // The name of a constructor is that of its parent.
1968                 rustc_hir::definitions::DefPathData::Ctor => self
1969                     .opt_item_name(DefId { krate: def_id.krate, index: def_key.parent.unwrap() }),
1970                 // The name of opaque types only exists in HIR.
1971                 rustc_hir::definitions::DefPathData::ImplTrait
1972                     if let Some(def_id) = def_id.as_local() =>
1973                     self.hir().opt_name(self.hir().local_def_id_to_hir_id(def_id)),
1974                 _ => def_key.get_opt_name(),
1975             }
1976         }
1977     }
1978
1979     /// Look up the name of a definition across crates. This does not look at HIR.
1980     ///
1981     /// This method will ICE if the corresponding item does not have a name.  In these cases, use
1982     /// [`opt_item_name`] instead.
1983     ///
1984     /// [`opt_item_name`]: Self::opt_item_name
1985     pub fn item_name(self, id: DefId) -> Symbol {
1986         self.opt_item_name(id).unwrap_or_else(|| {
1987             bug!("item_name: no name for {:?}", self.def_path(id));
1988         })
1989     }
1990
1991     /// Look up the name and span of a definition.
1992     ///
1993     /// See [`item_name`][Self::item_name] for more information.
1994     pub fn opt_item_ident(self, def_id: DefId) -> Option<Ident> {
1995         let def = self.opt_item_name(def_id)?;
1996         let span = def_id
1997             .as_local()
1998             .and_then(|id| self.def_ident_span(id))
1999             .unwrap_or(rustc_span::DUMMY_SP);
2000         Some(Ident::new(def, span))
2001     }
2002
2003     pub fn opt_associated_item(self, def_id: DefId) -> Option<&'tcx AssocItem> {
2004         if let DefKind::AssocConst | DefKind::AssocFn | DefKind::AssocTy = self.def_kind(def_id) {
2005             Some(self.associated_item(def_id))
2006         } else {
2007             None
2008         }
2009     }
2010
2011     pub fn field_index(self, hir_id: hir::HirId, typeck_results: &TypeckResults<'_>) -> usize {
2012         typeck_results.field_indices().get(hir_id).cloned().expect("no index for a field")
2013     }
2014
2015     pub fn find_field_index(self, ident: Ident, variant: &VariantDef) -> Option<usize> {
2016         variant
2017             .fields
2018             .iter()
2019             .position(|field| self.hygienic_eq(ident, field.ident(self), variant.def_id))
2020     }
2021
2022     /// Returns `true` if the impls are the same polarity and the trait either
2023     /// has no items or is annotated `#[marker]` and prevents item overrides.
2024     pub fn impls_are_allowed_to_overlap(
2025         self,
2026         def_id1: DefId,
2027         def_id2: DefId,
2028     ) -> Option<ImplOverlapKind> {
2029         // If either trait impl references an error, they're allowed to overlap,
2030         // as one of them essentially doesn't exist.
2031         if self.impl_trait_ref(def_id1).map_or(false, |tr| tr.references_error())
2032             || self.impl_trait_ref(def_id2).map_or(false, |tr| tr.references_error())
2033         {
2034             return Some(ImplOverlapKind::Permitted { marker: false });
2035         }
2036
2037         match (self.impl_polarity(def_id1), self.impl_polarity(def_id2)) {
2038             (ImplPolarity::Reservation, _) | (_, ImplPolarity::Reservation) => {
2039                 // `#[rustc_reservation_impl]` impls don't overlap with anything
2040                 debug!(
2041                     "impls_are_allowed_to_overlap({:?}, {:?}) = Some(Permitted) (reservations)",
2042                     def_id1, def_id2
2043                 );
2044                 return Some(ImplOverlapKind::Permitted { marker: false });
2045             }
2046             (ImplPolarity::Positive, ImplPolarity::Negative)
2047             | (ImplPolarity::Negative, ImplPolarity::Positive) => {
2048                 // `impl AutoTrait for Type` + `impl !AutoTrait for Type`
2049                 debug!(
2050                     "impls_are_allowed_to_overlap({:?}, {:?}) - None (differing polarities)",
2051                     def_id1, def_id2
2052                 );
2053                 return None;
2054             }
2055             (ImplPolarity::Positive, ImplPolarity::Positive)
2056             | (ImplPolarity::Negative, ImplPolarity::Negative) => {}
2057         };
2058
2059         let is_marker_overlap = {
2060             let is_marker_impl = |def_id: DefId| -> bool {
2061                 let trait_ref = self.impl_trait_ref(def_id);
2062                 trait_ref.map_or(false, |tr| self.trait_def(tr.def_id).is_marker)
2063             };
2064             is_marker_impl(def_id1) && is_marker_impl(def_id2)
2065         };
2066
2067         if is_marker_overlap {
2068             debug!(
2069                 "impls_are_allowed_to_overlap({:?}, {:?}) = Some(Permitted) (marker overlap)",
2070                 def_id1, def_id2
2071             );
2072             Some(ImplOverlapKind::Permitted { marker: true })
2073         } else {
2074             if let Some(self_ty1) = self.issue33140_self_ty(def_id1) {
2075                 if let Some(self_ty2) = self.issue33140_self_ty(def_id2) {
2076                     if self_ty1 == self_ty2 {
2077                         debug!(
2078                             "impls_are_allowed_to_overlap({:?}, {:?}) - issue #33140 HACK",
2079                             def_id1, def_id2
2080                         );
2081                         return Some(ImplOverlapKind::Issue33140);
2082                     } else {
2083                         debug!(
2084                             "impls_are_allowed_to_overlap({:?}, {:?}) - found {:?} != {:?}",
2085                             def_id1, def_id2, self_ty1, self_ty2
2086                         );
2087                     }
2088                 }
2089             }
2090
2091             debug!("impls_are_allowed_to_overlap({:?}, {:?}) = None", def_id1, def_id2);
2092             None
2093         }
2094     }
2095
2096     /// Returns `ty::VariantDef` if `res` refers to a struct,
2097     /// or variant or their constructors, panics otherwise.
2098     pub fn expect_variant_res(self, res: Res) -> &'tcx VariantDef {
2099         match res {
2100             Res::Def(DefKind::Variant, did) => {
2101                 let enum_did = self.parent(did);
2102                 self.adt_def(enum_did).variant_with_id(did)
2103             }
2104             Res::Def(DefKind::Struct | DefKind::Union, did) => self.adt_def(did).non_enum_variant(),
2105             Res::Def(DefKind::Ctor(CtorOf::Variant, ..), variant_ctor_did) => {
2106                 let variant_did = self.parent(variant_ctor_did);
2107                 let enum_did = self.parent(variant_did);
2108                 self.adt_def(enum_did).variant_with_ctor_id(variant_ctor_did)
2109             }
2110             Res::Def(DefKind::Ctor(CtorOf::Struct, ..), ctor_did) => {
2111                 let struct_did = self.parent(ctor_did);
2112                 self.adt_def(struct_did).non_enum_variant()
2113             }
2114             _ => bug!("expect_variant_res used with unexpected res {:?}", res),
2115         }
2116     }
2117
2118     /// Returns the possibly-auto-generated MIR of a `(DefId, Subst)` pair.
2119     #[instrument(skip(self), level = "debug")]
2120     pub fn instance_mir(self, instance: ty::InstanceDef<'tcx>) -> &'tcx Body<'tcx> {
2121         match instance {
2122             ty::InstanceDef::Item(def) => {
2123                 debug!("calling def_kind on def: {:?}", def);
2124                 let def_kind = self.def_kind(def.did);
2125                 debug!("returned from def_kind: {:?}", def_kind);
2126                 match def_kind {
2127                     DefKind::Const
2128                     | DefKind::Static(..)
2129                     | DefKind::AssocConst
2130                     | DefKind::Ctor(..)
2131                     | DefKind::AnonConst
2132                     | DefKind::InlineConst => self.mir_for_ctfe_opt_const_arg(def),
2133                     // If the caller wants `mir_for_ctfe` of a function they should not be using
2134                     // `instance_mir`, so we'll assume const fn also wants the optimized version.
2135                     _ => {
2136                         assert_eq!(def.const_param_did, None);
2137                         self.optimized_mir(def.did)
2138                     }
2139                 }
2140             }
2141             ty::InstanceDef::VtableShim(..)
2142             | ty::InstanceDef::ReifyShim(..)
2143             | ty::InstanceDef::Intrinsic(..)
2144             | ty::InstanceDef::FnPtrShim(..)
2145             | ty::InstanceDef::Virtual(..)
2146             | ty::InstanceDef::ClosureOnceShim { .. }
2147             | ty::InstanceDef::DropGlue(..)
2148             | ty::InstanceDef::CloneShim(..) => self.mir_shims(instance),
2149         }
2150     }
2151
2152     // FIXME(@lcnr): Remove this function.
2153     pub fn get_attrs_unchecked(self, did: DefId) -> &'tcx [ast::Attribute] {
2154         if let Some(did) = did.as_local() {
2155             self.hir().attrs(self.hir().local_def_id_to_hir_id(did))
2156         } else {
2157             self.item_attrs(did)
2158         }
2159     }
2160
2161     /// Gets all attributes with the given name.
2162     pub fn get_attrs(self, did: DefId, attr: Symbol) -> ty::Attributes<'tcx> {
2163         let filter_fn = move |a: &&ast::Attribute| a.has_name(attr);
2164         if let Some(did) = did.as_local() {
2165             self.hir().attrs(self.hir().local_def_id_to_hir_id(did)).iter().filter(filter_fn)
2166         } else if cfg!(debug_assertions) && rustc_feature::is_builtin_only_local(attr) {
2167             bug!("tried to access the `only_local` attribute `{}` from an extern crate", attr);
2168         } else {
2169             self.item_attrs(did).iter().filter(filter_fn)
2170         }
2171     }
2172
2173     pub fn get_attr(self, did: DefId, attr: Symbol) -> Option<&'tcx ast::Attribute> {
2174         self.get_attrs(did, attr).next()
2175     }
2176
2177     /// Determines whether an item is annotated with an attribute.
2178     pub fn has_attr(self, did: DefId, attr: Symbol) -> bool {
2179         if cfg!(debug_assertions) && !did.is_local() && rustc_feature::is_builtin_only_local(attr) {
2180             bug!("tried to access the `only_local` attribute `{}` from an extern crate", attr);
2181         } else {
2182             self.get_attrs(did, attr).next().is_some()
2183         }
2184     }
2185
2186     /// Returns `true` if this is an `auto trait`.
2187     pub fn trait_is_auto(self, trait_def_id: DefId) -> bool {
2188         self.trait_def(trait_def_id).has_auto_impl
2189     }
2190
2191     /// Returns layout of a generator. Layout might be unavailable if the
2192     /// generator is tainted by errors.
2193     pub fn generator_layout(self, def_id: DefId) -> Option<&'tcx GeneratorLayout<'tcx>> {
2194         self.optimized_mir(def_id).generator_layout()
2195     }
2196
2197     /// Given the `DefId` of an impl, returns the `DefId` of the trait it implements.
2198     /// If it implements no trait, returns `None`.
2199     pub fn trait_id_of_impl(self, def_id: DefId) -> Option<DefId> {
2200         self.impl_trait_ref(def_id).map(|tr| tr.def_id)
2201     }
2202
2203     /// If the given `DefId` describes a method belonging to an impl, returns the
2204     /// `DefId` of the impl that the method belongs to; otherwise, returns `None`.
2205     pub fn impl_of_method(self, def_id: DefId) -> Option<DefId> {
2206         self.opt_associated_item(def_id).and_then(|trait_item| match trait_item.container {
2207             TraitContainer(_) => None,
2208             ImplContainer(def_id) => Some(def_id),
2209         })
2210     }
2211
2212     /// If the given `DefId` belongs to a trait that was automatically derived, returns `true`.
2213     pub fn is_builtin_derive(self, def_id: DefId) -> bool {
2214         self.has_attr(def_id, sym::automatically_derived)
2215     }
2216
2217     /// Looks up the span of `impl_did` if the impl is local; otherwise returns `Err`
2218     /// with the name of the crate containing the impl.
2219     pub fn span_of_impl(self, impl_did: DefId) -> Result<Span, Symbol> {
2220         if let Some(impl_did) = impl_did.as_local() {
2221             Ok(self.def_span(impl_did))
2222         } else {
2223             Err(self.crate_name(impl_did.krate))
2224         }
2225     }
2226
2227     /// Hygienically compares a use-site name (`use_name`) for a field or an associated item with
2228     /// its supposed definition name (`def_name`). The method also needs `DefId` of the supposed
2229     /// definition's parent/scope to perform comparison.
2230     pub fn hygienic_eq(self, use_name: Ident, def_name: Ident, def_parent_def_id: DefId) -> bool {
2231         // We could use `Ident::eq` here, but we deliberately don't. The name
2232         // comparison fails frequently, and we want to avoid the expensive
2233         // `normalize_to_macros_2_0()` calls required for the span comparison whenever possible.
2234         use_name.name == def_name.name
2235             && use_name
2236                 .span
2237                 .ctxt()
2238                 .hygienic_eq(def_name.span.ctxt(), self.expn_that_defined(def_parent_def_id))
2239     }
2240
2241     pub fn adjust_ident(self, mut ident: Ident, scope: DefId) -> Ident {
2242         ident.span.normalize_to_macros_2_0_and_adjust(self.expn_that_defined(scope));
2243         ident
2244     }
2245
2246     pub fn adjust_ident_and_get_scope(
2247         self,
2248         mut ident: Ident,
2249         scope: DefId,
2250         block: hir::HirId,
2251     ) -> (Ident, DefId) {
2252         let scope = ident
2253             .span
2254             .normalize_to_macros_2_0_and_adjust(self.expn_that_defined(scope))
2255             .and_then(|actual_expansion| actual_expansion.expn_data().parent_module)
2256             .unwrap_or_else(|| self.parent_module(block).to_def_id());
2257         (ident, scope)
2258     }
2259
2260     pub fn is_object_safe(self, key: DefId) -> bool {
2261         self.object_safety_violations(key).is_empty()
2262     }
2263
2264     #[inline]
2265     pub fn is_const_fn_raw(self, def_id: DefId) -> bool {
2266         matches!(self.def_kind(def_id), DefKind::Fn | DefKind::AssocFn | DefKind::Ctor(..))
2267             && self.constness(def_id) == hir::Constness::Const
2268     }
2269
2270     #[inline]
2271     pub fn is_const_default_method(self, def_id: DefId) -> bool {
2272         matches!(self.trait_of_item(def_id), Some(trait_id) if self.has_attr(trait_id, sym::const_trait))
2273     }
2274 }
2275
2276 /// Yields the parent function's `LocalDefId` if `def_id` is an `impl Trait` definition.
2277 pub fn is_impl_trait_defn(tcx: TyCtxt<'_>, def_id: DefId) -> Option<LocalDefId> {
2278     let def_id = def_id.as_local()?;
2279     if let Node::Item(item) = tcx.hir().get_by_def_id(def_id) {
2280         if let hir::ItemKind::OpaqueTy(ref opaque_ty) = item.kind {
2281             return match opaque_ty.origin {
2282                 hir::OpaqueTyOrigin::FnReturn(parent) | hir::OpaqueTyOrigin::AsyncFn(parent) => {
2283                     Some(parent)
2284                 }
2285                 hir::OpaqueTyOrigin::TyAlias => None,
2286             };
2287         }
2288     }
2289     None
2290 }
2291
2292 pub fn int_ty(ity: ast::IntTy) -> IntTy {
2293     match ity {
2294         ast::IntTy::Isize => IntTy::Isize,
2295         ast::IntTy::I8 => IntTy::I8,
2296         ast::IntTy::I16 => IntTy::I16,
2297         ast::IntTy::I32 => IntTy::I32,
2298         ast::IntTy::I64 => IntTy::I64,
2299         ast::IntTy::I128 => IntTy::I128,
2300     }
2301 }
2302
2303 pub fn uint_ty(uty: ast::UintTy) -> UintTy {
2304     match uty {
2305         ast::UintTy::Usize => UintTy::Usize,
2306         ast::UintTy::U8 => UintTy::U8,
2307         ast::UintTy::U16 => UintTy::U16,
2308         ast::UintTy::U32 => UintTy::U32,
2309         ast::UintTy::U64 => UintTy::U64,
2310         ast::UintTy::U128 => UintTy::U128,
2311     }
2312 }
2313
2314 pub fn float_ty(fty: ast::FloatTy) -> FloatTy {
2315     match fty {
2316         ast::FloatTy::F32 => FloatTy::F32,
2317         ast::FloatTy::F64 => FloatTy::F64,
2318     }
2319 }
2320
2321 pub fn ast_int_ty(ity: IntTy) -> ast::IntTy {
2322     match ity {
2323         IntTy::Isize => ast::IntTy::Isize,
2324         IntTy::I8 => ast::IntTy::I8,
2325         IntTy::I16 => ast::IntTy::I16,
2326         IntTy::I32 => ast::IntTy::I32,
2327         IntTy::I64 => ast::IntTy::I64,
2328         IntTy::I128 => ast::IntTy::I128,
2329     }
2330 }
2331
2332 pub fn ast_uint_ty(uty: UintTy) -> ast::UintTy {
2333     match uty {
2334         UintTy::Usize => ast::UintTy::Usize,
2335         UintTy::U8 => ast::UintTy::U8,
2336         UintTy::U16 => ast::UintTy::U16,
2337         UintTy::U32 => ast::UintTy::U32,
2338         UintTy::U64 => ast::UintTy::U64,
2339         UintTy::U128 => ast::UintTy::U128,
2340     }
2341 }
2342
2343 pub fn provide(providers: &mut ty::query::Providers) {
2344     closure::provide(providers);
2345     context::provide(providers);
2346     erase_regions::provide(providers);
2347     layout::provide(providers);
2348     util::provide(providers);
2349     print::provide(providers);
2350     super::util::bug::provide(providers);
2351     super::middle::provide(providers);
2352     *providers = ty::query::Providers {
2353         trait_impls_of: trait_def::trait_impls_of_provider,
2354         incoherent_impls: trait_def::incoherent_impls_provider,
2355         type_uninhabited_from: inhabitedness::type_uninhabited_from,
2356         const_param_default: consts::const_param_default,
2357         vtable_allocation: vtable::vtable_allocation_provider,
2358         ..*providers
2359     };
2360 }
2361
2362 /// A map for the local crate mapping each type to a vector of its
2363 /// inherent impls. This is not meant to be used outside of coherence;
2364 /// rather, you should request the vector for a specific type via
2365 /// `tcx.inherent_impls(def_id)` so as to minimize your dependencies
2366 /// (constructing this map requires touching the entire crate).
2367 #[derive(Clone, Debug, Default, HashStable)]
2368 pub struct CrateInherentImpls {
2369     pub inherent_impls: LocalDefIdMap<Vec<DefId>>,
2370     pub incoherent_impls: FxHashMap<SimplifiedType, Vec<LocalDefId>>,
2371 }
2372
2373 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, HashStable)]
2374 pub struct SymbolName<'tcx> {
2375     /// `&str` gives a consistent ordering, which ensures reproducible builds.
2376     pub name: &'tcx str,
2377 }
2378
2379 impl<'tcx> SymbolName<'tcx> {
2380     pub fn new(tcx: TyCtxt<'tcx>, name: &str) -> SymbolName<'tcx> {
2381         SymbolName {
2382             name: unsafe { str::from_utf8_unchecked(tcx.arena.alloc_slice(name.as_bytes())) },
2383         }
2384     }
2385 }
2386
2387 impl<'tcx> fmt::Display for SymbolName<'tcx> {
2388     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
2389         fmt::Display::fmt(&self.name, fmt)
2390     }
2391 }
2392
2393 impl<'tcx> fmt::Debug for SymbolName<'tcx> {
2394     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
2395         fmt::Display::fmt(&self.name, fmt)
2396     }
2397 }
2398
2399 #[derive(Debug, Default, Copy, Clone)]
2400 pub struct FoundRelationships {
2401     /// This is true if we identified that this Ty (`?T`) is found in a `?T: Foo`
2402     /// obligation, where:
2403     ///
2404     ///  * `Foo` is not `Sized`
2405     ///  * `(): Foo` may be satisfied
2406     pub self_in_trait: bool,
2407     /// This is true if we identified that this Ty (`?T`) is found in a `<_ as
2408     /// _>::AssocType = ?T`
2409     pub output: bool,
2410 }
2411
2412 /// The constituent parts of a type level constant of kind ADT or array.
2413 #[derive(Copy, Clone, Debug, HashStable)]
2414 pub struct DestructuredConst<'tcx> {
2415     pub variant: Option<VariantIdx>,
2416     pub fields: &'tcx [ty::Const<'tcx>],
2417 }