src/librustc_middle/ty/mod.rs

   1 // ignore-tidy-filelength
   2 pub use self::fold::{TypeFoldable, TypeVisitor};
   3 pub use self::AssocItemContainer::*;
   4 pub use self::BorrowKind::*;
   5 pub use self::IntVarValue::*;
   6 pub use self::Variance::*;
   7
   8 use crate::hir::exports::ExportMap;
   9 use crate::ich::StableHashingContext;
  10 use crate::infer::canonical::Canonical;
  11 use crate::middle::cstore::CrateStoreDyn;
  12 use crate::middle::resolve_lifetime::ObjectLifetimeDefault;
  13 use crate::mir::interpret::ErrorHandled;
  14 use crate::mir::Body;
  15 use crate::mir::GeneratorLayout;
  16 use crate::traits::{self, Reveal};
  17 use crate::ty;
  18 use crate::ty::subst::{GenericArg, InternalSubsts, Subst, SubstsRef};
  19 use crate::ty::util::{Discr, IntTypeExt};
  20 use rustc_ast::ast;
  21 use rustc_attr as attr;
  22 use rustc_data_structures::captures::Captures;
  23 use rustc_data_structures::fingerprint::Fingerprint;
  24 use rustc_data_structures::fx::FxHashMap;
  25 use rustc_data_structures::fx::FxHashSet;
  26 use rustc_data_structures::fx::FxIndexMap;
  27 use rustc_data_structures::sorted_map::SortedIndexMultiMap;
  28 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
  29 use rustc_data_structures::sync::{self, par_iter, ParallelIterator};
  30 use rustc_errors::ErrorReported;
  31 use rustc_hir as hir;
  32 use rustc_hir::def::{CtorKind, CtorOf, DefKind, Namespace, Res};
  33 use rustc_hir::def_id::{CrateNum, DefId, DefIdMap, LocalDefId, CRATE_DEF_INDEX};
  34 use rustc_hir::lang_items::{FnMutTraitLangItem, FnOnceTraitLangItem, FnTraitLangItem};
  35 use rustc_hir::{Constness, Node};
  36 use rustc_index::vec::{Idx, IndexVec};
  37 use rustc_macros::HashStable;
  38 use rustc_serialize::{self, Encodable, Encoder};
  39 use rustc_session::DataTypeKind;
  40 use rustc_span::hygiene::ExpnId;
  41 use rustc_span::symbol::{kw, sym, Ident, Symbol};
  42 use rustc_span::Span;
  43 use rustc_target::abi::{Align, VariantIdx};
  44
  45 use std::cell::RefCell;
  46 use std::cmp::Ordering;
  47 use std::fmt;
  48 use std::hash::{Hash, Hasher};
  49 use std::marker::PhantomData;
  50 use std::ops::Range;
  51 use std::ptr;
  52 use std::str;
  53
  54 pub use self::sty::BoundRegion::*;
  55 pub use self::sty::InferTy::*;
  56 pub use self::sty::RegionKind;
  57 pub use self::sty::RegionKind::*;
  58 pub use self::sty::TyKind::*;
  59 pub use self::sty::{Binder, BoundTy, BoundTyKind, BoundVar, DebruijnIndex, INNERMOST};
  60 pub use self::sty::{BoundRegion, EarlyBoundRegion, FreeRegion, Region};
  61 pub use self::sty::{CanonicalPolyFnSig, FnSig, GenSig, PolyFnSig, PolyGenSig};
  62 pub use self::sty::{ClosureSubsts, GeneratorSubsts, TypeAndMut, UpvarSubsts};
  63 pub use self::sty::{ConstVid, FloatVid, IntVid, RegionVid, TyVid};
  64 pub use self::sty::{ExistentialPredicate, InferTy, ParamConst, ParamTy, ProjectionTy};
  65 pub use self::sty::{ExistentialProjection, PolyExistentialProjection};
  66 pub use self::sty::{ExistentialTraitRef, PolyExistentialTraitRef};
  67 pub use self::sty::{PolyTraitRef, TraitRef, TyKind};
  68 pub use crate::ty::diagnostics::*;
  69
  70 pub use self::binding::BindingMode;
  71 pub use self::binding::BindingMode::*;
  72
  73 pub use self::context::{tls, FreeRegionInfo, TyCtxt};
  74 pub use self::context::{
  75     CanonicalUserType, CanonicalUserTypeAnnotation, CanonicalUserTypeAnnotations, ResolvedOpaqueTy,
  76     UserType, UserTypeAnnotationIndex,
  77 };
  78 pub use self::context::{
  79     CtxtInterners, GeneratorInteriorTypeCause, GlobalCtxt, Lift, TypeckResults,
  80 };
  81
  82 pub use self::instance::{Instance, InstanceDef};
  83
  84 pub use self::list::List;
  85
  86 pub use self::trait_def::TraitDef;
  87
  88 pub use self::query::queries;
  89
  90 pub use self::consts::{Const, ConstInt, ConstKind, InferConst};
  91
  92 pub mod adjustment;
  93 pub mod binding;
  94 pub mod cast;
  95 #[macro_use]
  96 pub mod codec;
  97 pub mod _match;
  98 mod erase_regions;
  99 pub mod error;
 100 pub mod fast_reject;
 101 pub mod flags;
 102 pub mod fold;
 103 pub mod inhabitedness;
 104 pub mod layout;
 105 pub mod normalize_erasing_regions;
 106 pub mod outlives;
 107 pub mod print;
 108 pub mod query;
 109 pub mod relate;
 110 pub mod steal;
 111 pub mod subst;
 112 pub mod trait_def;
 113 pub mod util;
 114 pub mod walk;
 115
 116 mod consts;
 117 mod context;
 118 mod diagnostics;
 119 mod instance;
 120 mod list;
 121 mod structural_impls;
 122 mod sty;
 123
 124 // Data types
 125
 126 pub struct ResolverOutputs {
 127     pub definitions: rustc_hir::definitions::Definitions,
 128     pub cstore: Box<CrateStoreDyn>,
 129     pub extern_crate_map: FxHashMap<LocalDefId, CrateNum>,
 130     pub maybe_unused_trait_imports: FxHashSet<LocalDefId>,
 131     pub maybe_unused_extern_crates: Vec<(LocalDefId, Span)>,
 132     pub export_map: ExportMap<LocalDefId>,
 133     pub glob_map: FxHashMap<LocalDefId, FxHashSet<Symbol>>,
 134     /// Extern prelude entries. The value is `true` if the entry was introduced
 135     /// via `extern crate` item and not `--extern` option or compiler built-in.
 136     pub extern_prelude: FxHashMap<Symbol, bool>,
 137 }
 138
 139 #[derive(Clone, Copy, PartialEq, Eq, Debug, HashStable, Hash)]
 140 pub enum AssocItemContainer {
 141     TraitContainer(DefId),
 142     ImplContainer(DefId),
 143 }
 144
 145 impl AssocItemContainer {
 146     /// Asserts that this is the `DefId` of an associated item declared
 147     /// in a trait, and returns the trait `DefId`.
 148     pub fn assert_trait(&self) -> DefId {
 149         match *self {
 150             TraitContainer(id) => id,
 151             _ => bug!("associated item has wrong container type: {:?}", self),
 152         }
 153     }
 154
 155     pub fn id(&self) -> DefId {
 156         match *self {
 157             TraitContainer(id) => id,
 158             ImplContainer(id) => id,
 159         }
 160     }
 161 }
 162
 163 /// The "header" of an impl is everything outside the body: a Self type, a trait
 164 /// ref (in the case of a trait impl), and a set of predicates (from the
 165 /// bounds / where-clauses).
 166 #[derive(Clone, Debug, TypeFoldable)]
 167 pub struct ImplHeader<'tcx> {
 168     pub impl_def_id: DefId,
 169     pub self_ty: Ty<'tcx>,
 170     pub trait_ref: Option<TraitRef<'tcx>>,
 171     pub predicates: Vec<Predicate<'tcx>>,
 172 }
 173
 174 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, HashStable)]
 175 pub enum ImplPolarity {
 176     /// `impl Trait for Type`
 177     Positive,
 178     /// `impl !Trait for Type`
 179     Negative,
 180     /// `#[rustc_reservation_impl] impl Trait for Type`
 181     ///
 182     /// This is a "stability hack", not a real Rust feature.
 183     /// See #64631 for details.
 184     Reservation,
 185 }
 186
 187 #[derive(Copy, Clone, Debug, PartialEq, HashStable, Eq, Hash)]
 188 pub struct AssocItem {
 189     pub def_id: DefId,
 190     #[stable_hasher(project(name))]
 191     pub ident: Ident,
 192     pub kind: AssocKind,
 193     pub vis: Visibility,
 194     pub defaultness: hir::Defaultness,
 195     pub container: AssocItemContainer,
 196
 197     /// Whether this is a method with an explicit self
 198     /// as its first parameter, allowing method calls.
 199     pub fn_has_self_parameter: bool,
 200 }
 201
 202 #[derive(Copy, Clone, PartialEq, Debug, HashStable, Eq, Hash)]
 203 pub enum AssocKind {
 204     Const,
 205     Fn,
 206     Type,
 207 }
 208
 209 impl AssocKind {
 210     pub fn namespace(&self) -> Namespace {
 211         match *self {
 212             ty::AssocKind::Type => Namespace::TypeNS,
 213             ty::AssocKind::Const | ty::AssocKind::Fn => Namespace::ValueNS,
 214         }
 215     }
 216
 217     pub fn as_def_kind(&self) -> DefKind {
 218         match self {
 219             AssocKind::Const => DefKind::AssocConst,
 220             AssocKind::Fn => DefKind::AssocFn,
 221             AssocKind::Type => DefKind::AssocTy,
 222         }
 223     }
 224 }
 225
 226 impl AssocItem {
 227     pub fn signature(&self, tcx: TyCtxt<'_>) -> String {
 228         match self.kind {
 229             ty::AssocKind::Fn => {
 230                 // We skip the binder here because the binder would deanonymize all
 231                 // late-bound regions, and we don't want method signatures to show up
 232                 // `as for<'r> fn(&'r MyType)`.  Pretty-printing handles late-bound
 233                 // regions just fine, showing `fn(&MyType)`.
 234                 tcx.fn_sig(self.def_id).skip_binder().to_string()
 235             }
 236             ty::AssocKind::Type => format!("type {};", self.ident),
 237             ty::AssocKind::Const => {
 238                 format!("const {}: {:?};", self.ident, tcx.type_of(self.def_id))
 239             }
 240         }
 241     }
 242 }
 243
 244 /// A list of `ty::AssocItem`s in definition order that allows for efficient lookup by name.
 245 ///
 246 /// When doing lookup by name, we try to postpone hygienic comparison for as long as possible since
 247 /// it is relatively expensive. Instead, items are indexed by `Symbol` and hygienic comparison is
 248 /// done only on items with the same name.
 249 #[derive(Debug, Clone, PartialEq, HashStable)]
 250 pub struct AssociatedItems<'tcx> {
 251     items: SortedIndexMultiMap<u32, Symbol, &'tcx ty::AssocItem>,
 252 }
 253
 254 impl<'tcx> AssociatedItems<'tcx> {
 255     /// Constructs an `AssociatedItems` map from a series of `ty::AssocItem`s in definition order.
 256     pub fn new(items_in_def_order: impl IntoIterator<Item = &'tcx ty::AssocItem>) -> Self {
 257         let items = items_in_def_order.into_iter().map(|item| (item.ident.name, item)).collect();
 258         AssociatedItems { items }
 259     }
 260
 261     /// Returns a slice of associated items in the order they were defined.
 262     ///
 263     /// New code should avoid relying on definition order. If you need a particular associated item
 264     /// for a known trait, make that trait a lang item instead of indexing this array.
 265     pub fn in_definition_order(&self) -> impl '_ + Iterator<Item = &ty::AssocItem> {
 266         self.items.iter().map(|(_, v)| *v)
 267     }
 268
 269     /// Returns an iterator over all associated items with the given name, ignoring hygiene.
 270     pub fn filter_by_name_unhygienic(
 271         &self,
 272         name: Symbol,
 273     ) -> impl '_ + Iterator<Item = &ty::AssocItem> {
 274         self.items.get_by_key(&name).copied()
 275     }
 276
 277     /// Returns an iterator over all associated items with the given name.
 278     ///
 279     /// Multiple items may have the same name if they are in different `Namespace`s. For example,
 280     /// an associated type can have the same name as a method. Use one of the `find_by_name_and_*`
 281     /// methods below if you know which item you are looking for.
 282     pub fn filter_by_name(
 283         &'a self,
 284         tcx: TyCtxt<'a>,
 285         ident: Ident,
 286         parent_def_id: DefId,
 287     ) -> impl 'a + Iterator<Item = &'a ty::AssocItem> {
 288         self.filter_by_name_unhygienic(ident.name)
 289             .filter(move |item| tcx.hygienic_eq(ident, item.ident, parent_def_id))
 290     }
 291
 292     /// Returns the associated item with the given name and `AssocKind`, if one exists.
 293     pub fn find_by_name_and_kind(
 294         &self,
 295         tcx: TyCtxt<'_>,
 296         ident: Ident,
 297         kind: AssocKind,
 298         parent_def_id: DefId,
 299     ) -> Option<&ty::AssocItem> {
 300         self.filter_by_name_unhygienic(ident.name)
 301             .filter(|item| item.kind == kind)
 302             .find(|item| tcx.hygienic_eq(ident, item.ident, parent_def_id))
 303     }
 304
 305     /// Returns the associated item with the given name in the given `Namespace`, if one exists.
 306     pub fn find_by_name_and_namespace(
 307         &self,
 308         tcx: TyCtxt<'_>,
 309         ident: Ident,
 310         ns: Namespace,
 311         parent_def_id: DefId,
 312     ) -> Option<&ty::AssocItem> {
 313         self.filter_by_name_unhygienic(ident.name)
 314             .filter(|item| item.kind.namespace() == ns)
 315             .find(|item| tcx.hygienic_eq(ident, item.ident, parent_def_id))
 316     }
 317 }
 318
 319 #[derive(Clone, Debug, PartialEq, Eq, Copy, RustcEncodable, RustcDecodable, HashStable, Hash)]
 320 pub enum Visibility {
 321     /// Visible everywhere (including in other crates).
 322     Public,
 323     /// Visible only in the given crate-local module.
 324     Restricted(DefId),
 325     /// Not visible anywhere in the local crate. This is the visibility of private external items.
 326     Invisible,
 327 }
 328
 329 pub trait DefIdTree: Copy {
 330     fn parent(self, id: DefId) -> Option<DefId>;
 331
 332     fn is_descendant_of(self, mut descendant: DefId, ancestor: DefId) -> bool {
 333         if descendant.krate != ancestor.krate {
 334             return false;
 335         }
 336
 337         while descendant != ancestor {
 338             match self.parent(descendant) {
 339                 Some(parent) => descendant = parent,
 340                 None => return false,
 341             }
 342         }
 343         true
 344     }
 345 }
 346
 347 impl<'tcx> DefIdTree for TyCtxt<'tcx> {
 348     fn parent(self, id: DefId) -> Option<DefId> {
 349         self.def_key(id).parent.map(|index| DefId { index, ..id })
 350     }
 351 }
 352
 353 impl Visibility {
 354     pub fn from_hir(visibility: &hir::Visibility<'_>, id: hir::HirId, tcx: TyCtxt<'_>) -> Self {
 355         match visibility.node {
 356             hir::VisibilityKind::Public => Visibility::Public,
 357             hir::VisibilityKind::Crate(_) => Visibility::Restricted(DefId::local(CRATE_DEF_INDEX)),
 358             hir::VisibilityKind::Restricted { ref path, .. } => match path.res {
 359                 // If there is no resolution, `resolve` will have already reported an error, so
 360                 // assume that the visibility is public to avoid reporting more privacy errors.
 361                 Res::Err => Visibility::Public,
 362                 def => Visibility::Restricted(def.def_id()),
 363             },
 364             hir::VisibilityKind::Inherited => {
 365                 Visibility::Restricted(tcx.parent_module(id).to_def_id())
 366             }
 367         }
 368     }
 369
 370     /// Returns `true` if an item with this visibility is accessible from the given block.
 371     pub fn is_accessible_from<T: DefIdTree>(self, module: DefId, tree: T) -> bool {
 372         let restriction = match self {
 373             // Public items are visible everywhere.
 374             Visibility::Public => return true,
 375             // Private items from other crates are visible nowhere.
 376             Visibility::Invisible => return false,
 377             // Restricted items are visible in an arbitrary local module.
 378             Visibility::Restricted(other) if other.krate != module.krate => return false,
 379             Visibility::Restricted(module) => module,
 380         };
 381
 382         tree.is_descendant_of(module, restriction)
 383     }
 384
 385     /// Returns `true` if this visibility is at least as accessible as the given visibility
 386     pub fn is_at_least<T: DefIdTree>(self, vis: Visibility, tree: T) -> bool {
 387         let vis_restriction = match vis {
 388             Visibility::Public => return self == Visibility::Public,
 389             Visibility::Invisible => return true,
 390             Visibility::Restricted(module) => module,
 391         };
 392
 393         self.is_accessible_from(vis_restriction, tree)
 394     }
 395
 396     // Returns `true` if this item is visible anywhere in the local crate.
 397     pub fn is_visible_locally(self) -> bool {
 398         match self {
 399             Visibility::Public => true,
 400             Visibility::Restricted(def_id) => def_id.is_local(),
 401             Visibility::Invisible => false,
 402         }
 403     }
 404 }
 405
 406 #[derive(Copy, Clone, PartialEq, RustcDecodable, RustcEncodable, HashStable)]
 407 pub enum Variance {
 408     Covariant,     // T<A> <: T<B> iff A <: B -- e.g., function return type
 409     Invariant,     // T<A> <: T<B> iff B == A -- e.g., type of mutable cell
 410     Contravariant, // T<A> <: T<B> iff B <: A -- e.g., function param type
 411     Bivariant,     // T<A> <: T<B>            -- e.g., unused type parameter
 412 }
 413
 414 /// The crate variances map is computed during typeck and contains the
 415 /// variance of every item in the local crate. You should not use it
 416 /// directly, because to do so will make your pass dependent on the
 417 /// HIR of every item in the local crate. Instead, use
 418 /// `tcx.variances_of()` to get the variance for a *particular*
 419 /// item.
 420 #[derive(HashStable)]
 421 pub struct CrateVariancesMap<'tcx> {
 422     /// For each item with generics, maps to a vector of the variance
 423     /// of its generics. If an item has no generics, it will have no
 424     /// entry.
 425     pub variances: FxHashMap<DefId, &'tcx [ty::Variance]>,
 426 }
 427
 428 impl Variance {
 429     /// `a.xform(b)` combines the variance of a context with the
 430     /// variance of a type with the following meaning. If we are in a
 431     /// context with variance `a`, and we encounter a type argument in
 432     /// a position with variance `b`, then `a.xform(b)` is the new
 433     /// variance with which the argument appears.
 434     ///
 435     /// Example 1:
 436     ///
 437     ///     *mut Vec<i32>
 438     ///
 439     /// Here, the "ambient" variance starts as covariant. `*mut T` is
 440     /// invariant with respect to `T`, so the variance in which the
 441     /// `Vec<i32>` appears is `Covariant.xform(Invariant)`, which
 442     /// yields `Invariant`. Now, the type `Vec<T>` is covariant with
 443     /// respect to its type argument `T`, and hence the variance of
 444     /// the `i32` here is `Invariant.xform(Covariant)`, which results
 445     /// (again) in `Invariant`.
 446     ///
 447     /// Example 2:
 448     ///
 449     ///     fn(*const Vec<i32>, *mut Vec<i32)
 450     ///
 451     /// The ambient variance is covariant. A `fn` type is
 452     /// contravariant with respect to its parameters, so the variance
 453     /// within which both pointer types appear is
 454     /// `Covariant.xform(Contravariant)`, or `Contravariant`. `*const
 455     /// T` is covariant with respect to `T`, so the variance within
 456     /// which the first `Vec<i32>` appears is
 457     /// `Contravariant.xform(Covariant)` or `Contravariant`. The same
 458     /// is true for its `i32` argument. In the `*mut T` case, the
 459     /// variance of `Vec<i32>` is `Contravariant.xform(Invariant)`,
 460     /// and hence the outermost type is `Invariant` with respect to
 461     /// `Vec<i32>` (and its `i32` argument).
 462     ///
 463     /// Source: Figure 1 of "Taming the Wildcards:
 464     /// Combining Definition- and Use-Site Variance" published in PLDI'11.
 465     pub fn xform(self, v: ty::Variance) -> ty::Variance {
 466         match (self, v) {
 467             // Figure 1, column 1.
 468             (ty::Covariant, ty::Covariant) => ty::Covariant,
 469             (ty::Covariant, ty::Contravariant) => ty::Contravariant,
 470             (ty::Covariant, ty::Invariant) => ty::Invariant,
 471             (ty::Covariant, ty::Bivariant) => ty::Bivariant,
 472
 473             // Figure 1, column 2.
 474             (ty::Contravariant, ty::Covariant) => ty::Contravariant,
 475             (ty::Contravariant, ty::Contravariant) => ty::Covariant,
 476             (ty::Contravariant, ty::Invariant) => ty::Invariant,
 477             (ty::Contravariant, ty::Bivariant) => ty::Bivariant,
 478
 479             // Figure 1, column 3.
 480             (ty::Invariant, _) => ty::Invariant,
 481
 482             // Figure 1, column 4.
 483             (ty::Bivariant, _) => ty::Bivariant,
 484         }
 485     }
 486 }
 487
 488 // Contains information needed to resolve types and (in the future) look up
 489 // the types of AST nodes.
 490 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
 491 pub struct CReaderCacheKey {
 492     pub cnum: CrateNum,
 493     pub pos: usize,
 494 }
 495
 496 bitflags! {
 497     /// Flags that we track on types. These flags are propagated upwards
 498     /// through the type during type construction, so that we can quickly check
 499     /// whether the type has various kinds of types in it without recursing
 500     /// over the type itself.
 501     pub struct TypeFlags: u32 {
 502         // Does this have parameters? Used to determine whether substitution is
 503         // required.
 504         /// Does this have [Param]?
 505         const HAS_TY_PARAM                = 1 << 0;
 506         /// Does this have [ReEarlyBound]?
 507         const HAS_RE_PARAM                = 1 << 1;
 508         /// Does this have [ConstKind::Param]?
 509         const HAS_CT_PARAM                = 1 << 2;
 510
 511         const NEEDS_SUBST                 = TypeFlags::HAS_TY_PARAM.bits
 512                                           | TypeFlags::HAS_RE_PARAM.bits
 513                                           | TypeFlags::HAS_CT_PARAM.bits;
 514
 515         /// Does this have [Infer]?
 516         const HAS_TY_INFER                = 1 << 3;
 517         /// Does this have [ReVar]?
 518         const HAS_RE_INFER                = 1 << 4;
 519         /// Does this have [ConstKind::Infer]?
 520         const HAS_CT_INFER                = 1 << 5;
 521
 522         /// Does this have inference variables? Used to determine whether
 523         /// inference is required.
 524         const NEEDS_INFER                 = TypeFlags::HAS_TY_INFER.bits
 525                                           | TypeFlags::HAS_RE_INFER.bits
 526                                           | TypeFlags::HAS_CT_INFER.bits;
 527
 528         /// Does this have [Placeholder]?
 529         const HAS_TY_PLACEHOLDER          = 1 << 6;
 530         /// Does this have [RePlaceholder]?
 531         const HAS_RE_PLACEHOLDER          = 1 << 7;
 532         /// Does this have [ConstKind::Placeholder]?
 533         const HAS_CT_PLACEHOLDER          = 1 << 8;
 534
 535         /// `true` if there are "names" of regions and so forth
 536         /// that are local to a particular fn/inferctxt
 537         const HAS_FREE_LOCAL_REGIONS      = 1 << 9;
 538
 539         /// `true` if there are "names" of types and regions and so forth
 540         /// that are local to a particular fn
 541         const HAS_FREE_LOCAL_NAMES        = TypeFlags::HAS_TY_PARAM.bits
 542                                           | TypeFlags::HAS_CT_PARAM.bits
 543                                           | TypeFlags::HAS_TY_INFER.bits
 544                                           | TypeFlags::HAS_CT_INFER.bits
 545                                           | TypeFlags::HAS_TY_PLACEHOLDER.bits
 546                                           | TypeFlags::HAS_CT_PLACEHOLDER.bits
 547                                           | TypeFlags::HAS_FREE_LOCAL_REGIONS.bits;
 548
 549         /// Does this have [Projection]?
 550         const HAS_TY_PROJECTION           = 1 << 10;
 551         /// Does this have [Opaque]?
 552         const HAS_TY_OPAQUE               = 1 << 11;
 553         /// Does this have [ConstKind::Unevaluated]?
 554         const HAS_CT_PROJECTION           = 1 << 12;
 555
 556         /// Could this type be normalized further?
 557         const HAS_PROJECTION              = TypeFlags::HAS_TY_PROJECTION.bits
 558                                           | TypeFlags::HAS_TY_OPAQUE.bits
 559                                           | TypeFlags::HAS_CT_PROJECTION.bits;
 560
 561         /// Is an error type/const reachable?
 562         const HAS_ERROR                   = 1 << 13;
 563
 564         /// Does this have any region that "appears free" in the type?
 565         /// Basically anything but [ReLateBound] and [ReErased].
 566         const HAS_FREE_REGIONS            = 1 << 14;
 567
 568         /// Does this have any [ReLateBound] regions? Used to check
 569         /// if a global bound is safe to evaluate.
 570         const HAS_RE_LATE_BOUND           = 1 << 15;
 571
 572         /// Does this have any [ReErased] regions?
 573         const HAS_RE_ERASED               = 1 << 16;
 574
 575         /// Does this value have parameters/placeholders/inference variables which could be
 576         /// replaced later, in a way that would change the results of `impl` specialization?
 577         const STILL_FURTHER_SPECIALIZABLE = 1 << 17;
 578     }
 579 }
 580
 581 #[allow(rustc::usage_of_ty_tykind)]
 582 pub struct TyS<'tcx> {
 583     pub kind: TyKind<'tcx>,
 584     pub flags: TypeFlags,
 585
 586     /// This is a kind of confusing thing: it stores the smallest
 587     /// binder such that
 588     ///
 589     /// (a) the binder itself captures nothing but
 590     /// (b) all the late-bound things within the type are captured
 591     ///     by some sub-binder.
 592     ///
 593     /// So, for a type without any late-bound things, like `u32`, this
 594     /// will be *innermost*, because that is the innermost binder that
 595     /// captures nothing. But for a type `&'D u32`, where `'D` is a
 596     /// late-bound region with De Bruijn index `D`, this would be `D + 1`
 597     /// -- the binder itself does not capture `D`, but `D` is captured
 598     /// by an inner binder.
 599     ///
 600     /// We call this concept an "exclusive" binder `D` because all
 601     /// De Bruijn indices within the type are contained within `0..D`
 602     /// (exclusive).
 603     outer_exclusive_binder: ty::DebruijnIndex,
 604 }
 605
 606 // `TyS` is used a lot. Make sure it doesn't unintentionally get bigger.
 607 #[cfg(target_arch = "x86_64")]
 608 static_assert_size!(TyS<'_>, 32);
 609
 610 impl<'tcx> Ord for TyS<'tcx> {
 611     fn cmp(&self, other: &TyS<'tcx>) -> Ordering {
 612         self.kind.cmp(&other.kind)
 613     }
 614 }
 615
 616 impl<'tcx> PartialOrd for TyS<'tcx> {
 617     fn partial_cmp(&self, other: &TyS<'tcx>) -> Option<Ordering> {
 618         Some(self.kind.cmp(&other.kind))
 619     }
 620 }
 621
 622 impl<'tcx> PartialEq for TyS<'tcx> {
 623     #[inline]
 624     fn eq(&self, other: &TyS<'tcx>) -> bool {
 625         ptr::eq(self, other)
 626     }
 627 }
 628 impl<'tcx> Eq for TyS<'tcx> {}
 629
 630 impl<'tcx> Hash for TyS<'tcx> {
 631     fn hash<H: Hasher>(&self, s: &mut H) {
 632         (self as *const TyS<'_>).hash(s)
 633     }
 634 }
 635
 636 impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for TyS<'tcx> {
 637     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
 638         let ty::TyS {
 639             ref kind,
 640
 641             // The other fields just provide fast access to information that is
 642             // also contained in `kind`, so no need to hash them.
 643             flags: _,
 644
 645             outer_exclusive_binder: _,
 646         } = *self;
 647
 648         kind.hash_stable(hcx, hasher);
 649     }
 650 }
 651
 652 #[rustc_diagnostic_item = "Ty"]
 653 pub type Ty<'tcx> = &'tcx TyS<'tcx>;
 654
 655 impl<'tcx> rustc_serialize::UseSpecializedEncodable for Ty<'tcx> {}
 656 impl<'tcx> rustc_serialize::UseSpecializedDecodable for Ty<'tcx> {}
 657 impl<'tcx> rustc_serialize::UseSpecializedDecodable for &'tcx List<Ty<'tcx>> {}
 658
 659 pub type CanonicalTy<'tcx> = Canonical<'tcx, Ty<'tcx>>;
 660
 661 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
 662 pub struct UpvarPath {
 663     pub hir_id: hir::HirId,
 664 }
 665
 666 /// Upvars do not get their own `NodeId`. Instead, we use the pair of
 667 /// the original var ID (that is, the root variable that is referenced
 668 /// by the upvar) and the ID of the closure expression.
 669 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
 670 pub struct UpvarId {
 671     pub var_path: UpvarPath,
 672     pub closure_expr_id: LocalDefId,
 673 }
 674
 675 #[derive(Clone, PartialEq, Debug, RustcEncodable, RustcDecodable, Copy, HashStable)]
 676 pub enum BorrowKind {
 677     /// Data must be immutable and is aliasable.
 678     ImmBorrow,
 679
 680     /// Data must be immutable but not aliasable. This kind of borrow
 681     /// cannot currently be expressed by the user and is used only in
 682     /// implicit closure bindings. It is needed when the closure
 683     /// is borrowing or mutating a mutable referent, e.g.:
 684     ///
 685     ///    let x: &mut isize = ...;
 686     ///    let y = || *x += 5;
 687     ///
 688     /// If we were to try to translate this closure into a more explicit
 689     /// form, we'd encounter an error with the code as written:
 690     ///
 691     ///    struct Env { x: & &mut isize }
 692     ///    let x: &mut isize = ...;
 693     ///    let y = (&mut Env { &x }, fn_ptr);  // Closure is pair of env and fn
 694     ///    fn fn_ptr(env: &mut Env) { **env.x += 5; }
 695     ///
 696     /// This is then illegal because you cannot mutate a `&mut` found
 697     /// in an aliasable location. To solve, you'd have to translate with
 698     /// an `&mut` borrow:
 699     ///
 700     ///    struct Env { x: & &mut isize }
 701     ///    let x: &mut isize = ...;
 702     ///    let y = (&mut Env { &mut x }, fn_ptr); // changed from &x to &mut x
 703     ///    fn fn_ptr(env: &mut Env) { **env.x += 5; }
 704     ///
 705     /// Now the assignment to `**env.x` is legal, but creating a
 706     /// mutable pointer to `x` is not because `x` is not mutable. We
 707     /// could fix this by declaring `x` as `let mut x`. This is ok in
 708     /// user code, if awkward, but extra weird for closures, since the
 709     /// borrow is hidden.
 710     ///
 711     /// So we introduce a "unique imm" borrow -- the referent is
 712     /// immutable, but not aliasable. This solves the problem. For
 713     /// simplicity, we don't give users the way to express this
 714     /// borrow, it's just used when translating closures.
 715     UniqueImmBorrow,
 716
 717     /// Data is mutable and not aliasable.
 718     MutBorrow,
 719 }
 720
 721 /// Information describing the capture of an upvar. This is computed
 722 /// during `typeck`, specifically by `regionck`.
 723 #[derive(PartialEq, Clone, Debug, Copy, RustcEncodable, RustcDecodable, HashStable)]
 724 pub enum UpvarCapture<'tcx> {
 725     /// Upvar is captured by value. This is always true when the
 726     /// closure is labeled `move`, but can also be true in other cases
 727     /// depending on inference.
 728     ByValue,
 729
 730     /// Upvar is captured by reference.
 731     ByRef(UpvarBorrow<'tcx>),
 732 }
 733
 734 #[derive(PartialEq, Clone, Copy, RustcEncodable, RustcDecodable, HashStable)]
 735 pub struct UpvarBorrow<'tcx> {
 736     /// The kind of borrow: by-ref upvars have access to shared
 737     /// immutable borrows, which are not part of the normal language
 738     /// syntax.
 739     pub kind: BorrowKind,
 740
 741     /// Region of the resulting reference.
 742     pub region: ty::Region<'tcx>,
 743 }
 744
 745 pub type UpvarListMap = FxHashMap<DefId, FxIndexMap<hir::HirId, UpvarId>>;
 746 pub type UpvarCaptureMap<'tcx> = FxHashMap<UpvarId, UpvarCapture<'tcx>>;
 747
 748 #[derive(Clone, Copy, PartialEq, Eq)]
 749 pub enum IntVarValue {
 750     IntType(ast::IntTy),
 751     UintType(ast::UintTy),
 752 }
 753
 754 #[derive(Clone, Copy, PartialEq, Eq)]
 755 pub struct FloatVarValue(pub ast::FloatTy);
 756
 757 impl ty::EarlyBoundRegion {
 758     pub fn to_bound_region(&self) -> ty::BoundRegion {
 759         ty::BoundRegion::BrNamed(self.def_id, self.name)
 760     }
 761
 762     /// Does this early bound region have a name? Early bound regions normally
 763     /// always have names except when using anonymous lifetimes (`'_`).
 764     pub fn has_name(&self) -> bool {
 765         self.name != kw::UnderscoreLifetime
 766     }
 767 }
 768
 769 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable)]
 770 pub enum GenericParamDefKind {
 771     Lifetime,
 772     Type {
 773         has_default: bool,
 774         object_lifetime_default: ObjectLifetimeDefault,
 775         synthetic: Option<hir::SyntheticTyParamKind>,
 776     },
 777     Const,
 778 }
 779
 780 impl GenericParamDefKind {
 781     pub fn descr(&self) -> &'static str {
 782         match self {
 783             GenericParamDefKind::Lifetime => "lifetime",
 784             GenericParamDefKind::Type { .. } => "type",
 785             GenericParamDefKind::Const => "constant",
 786         }
 787     }
 788 }
 789
 790 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable)]
 791 pub struct GenericParamDef {
 792     pub name: Symbol,
 793     pub def_id: DefId,
 794     pub index: u32,
 795
 796     /// `pure_wrt_drop`, set by the (unsafe) `#[may_dangle]` attribute
 797     /// on generic parameter `'a`/`T`, asserts data behind the parameter
 798     /// `'a`/`T` won't be accessed during the parent type's `Drop` impl.
 799     pub pure_wrt_drop: bool,
 800
 801     pub kind: GenericParamDefKind,
 802 }
 803
 804 impl GenericParamDef {
 805     pub fn to_early_bound_region_data(&self) -> ty::EarlyBoundRegion {
 806         if let GenericParamDefKind::Lifetime = self.kind {
 807             ty::EarlyBoundRegion { def_id: self.def_id, index: self.index, name: self.name }
 808         } else {
 809             bug!("cannot convert a non-lifetime parameter def to an early bound region")
 810         }
 811     }
 812
 813     pub fn to_bound_region(&self) -> ty::BoundRegion {
 814         if let GenericParamDefKind::Lifetime = self.kind {
 815             self.to_early_bound_region_data().to_bound_region()
 816         } else {
 817             bug!("cannot convert a non-lifetime parameter def to an early bound region")
 818         }
 819     }
 820 }
 821
 822 #[derive(Default)]
 823 pub struct GenericParamCount {
 824     pub lifetimes: usize,
 825     pub types: usize,
 826     pub consts: usize,
 827 }
 828
 829 /// Information about the formal type/lifetime parameters associated
 830 /// with an item or method. Analogous to `hir::Generics`.
 831 ///
 832 /// The ordering of parameters is the same as in `Subst` (excluding child generics):
 833 /// `Self` (optionally), `Lifetime` params..., `Type` params...
 834 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable)]
 835 pub struct Generics {
 836     pub parent: Option<DefId>,
 837     pub parent_count: usize,
 838     pub params: Vec<GenericParamDef>,
 839
 840     /// Reverse map to the `index` field of each `GenericParamDef`.
 841     #[stable_hasher(ignore)]
 842     pub param_def_id_to_index: FxHashMap<DefId, u32>,
 843
 844     pub has_self: bool,
 845     pub has_late_bound_regions: Option<Span>,
 846 }
 847
 848 impl<'tcx> Generics {
 849     pub fn count(&self) -> usize {
 850         self.parent_count + self.params.len()
 851     }
 852
 853     pub fn own_counts(&self) -> GenericParamCount {
 854         // We could cache this as a property of `GenericParamCount`, but
 855         // the aim is to refactor this away entirely eventually and the
 856         // presence of this method will be a constant reminder.
 857         let mut own_counts: GenericParamCount = Default::default();
 858
 859         for param in &self.params {
 860             match param.kind {
 861                 GenericParamDefKind::Lifetime => own_counts.lifetimes += 1,
 862                 GenericParamDefKind::Type { .. } => own_counts.types += 1,
 863                 GenericParamDefKind::Const => own_counts.consts += 1,
 864             };
 865         }
 866
 867         own_counts
 868     }
 869
 870     pub fn requires_monomorphization(&self, tcx: TyCtxt<'tcx>) -> bool {
 871         if self.own_requires_monomorphization() {
 872             return true;
 873         }
 874
 875         if let Some(parent_def_id) = self.parent {
 876             let parent = tcx.generics_of(parent_def_id);
 877             parent.requires_monomorphization(tcx)
 878         } else {
 879             false
 880         }
 881     }
 882
 883     pub fn own_requires_monomorphization(&self) -> bool {
 884         for param in &self.params {
 885             match param.kind {
 886                 GenericParamDefKind::Type { .. } | GenericParamDefKind::Const => return true,
 887                 GenericParamDefKind::Lifetime => {}
 888             }
 889         }
 890         false
 891     }
 892
 893     /// Returns the `GenericParamDef` with the given index.
 894     pub fn param_at(&'tcx self, param_index: usize, tcx: TyCtxt<'tcx>) -> &'tcx GenericParamDef {
 895         if let Some(index) = param_index.checked_sub(self.parent_count) {
 896             &self.params[index]
 897         } else {
 898             tcx.generics_of(self.parent.expect("parent_count > 0 but no parent?"))
 899                 .param_at(param_index, tcx)
 900         }
 901     }
 902
 903     /// Returns the `GenericParamDef` associated with this `EarlyBoundRegion`.
 904     pub fn region_param(
 905         &'tcx self,
 906         param: &EarlyBoundRegion,
 907         tcx: TyCtxt<'tcx>,
 908     ) -> &'tcx GenericParamDef {
 909         let param = self.param_at(param.index as usize, tcx);
 910         match param.kind {
 911             GenericParamDefKind::Lifetime => param,
 912             _ => bug!("expected lifetime parameter, but found another generic parameter"),
 913         }
 914     }
 915
 916     /// Returns the `GenericParamDef` associated with this `ParamTy`.
 917     pub fn type_param(&'tcx self, param: &ParamTy, tcx: TyCtxt<'tcx>) -> &'tcx GenericParamDef {
 918         let param = self.param_at(param.index as usize, tcx);
 919         match param.kind {
 920             GenericParamDefKind::Type { .. } => param,
 921             _ => bug!("expected type parameter, but found another generic parameter"),
 922         }
 923     }
 924
 925     /// Returns the `GenericParamDef` associated with this `ParamConst`.
 926     pub fn const_param(&'tcx self, param: &ParamConst, tcx: TyCtxt<'tcx>) -> &GenericParamDef {
 927         let param = self.param_at(param.index as usize, tcx);
 928         match param.kind {
 929             GenericParamDefKind::Const => param,
 930             _ => bug!("expected const parameter, but found another generic parameter"),
 931         }
 932     }
 933 }
 934
 935 /// Bounds on generics.
 936 #[derive(Copy, Clone, Default, Debug, RustcEncodable, RustcDecodable, HashStable)]
 937 pub struct GenericPredicates<'tcx> {
 938     pub parent: Option<DefId>,
 939     pub predicates: &'tcx [(Predicate<'tcx>, Span)],
 940 }
 941
 942 impl<'tcx> GenericPredicates<'tcx> {
 943     pub fn instantiate(
 944         &self,
 945         tcx: TyCtxt<'tcx>,
 946         substs: SubstsRef<'tcx>,
 947     ) -> InstantiatedPredicates<'tcx> {
 948         let mut instantiated = InstantiatedPredicates::empty();
 949         self.instantiate_into(tcx, &mut instantiated, substs);
 950         instantiated
 951     }
 952
 953     pub fn instantiate_own(
 954         &self,
 955         tcx: TyCtxt<'tcx>,
 956         substs: SubstsRef<'tcx>,
 957     ) -> InstantiatedPredicates<'tcx> {
 958         InstantiatedPredicates {
 959             predicates: self.predicates.iter().map(|(p, _)| p.subst(tcx, substs)).collect(),
 960             spans: self.predicates.iter().map(|(_, sp)| *sp).collect(),
 961         }
 962     }
 963
 964     fn instantiate_into(
 965         &self,
 966         tcx: TyCtxt<'tcx>,
 967         instantiated: &mut InstantiatedPredicates<'tcx>,
 968         substs: SubstsRef<'tcx>,
 969     ) {
 970         if let Some(def_id) = self.parent {
 971             tcx.predicates_of(def_id).instantiate_into(tcx, instantiated, substs);
 972         }
 973         instantiated.predicates.extend(self.predicates.iter().map(|(p, _)| p.subst(tcx, substs)));
 974         instantiated.spans.extend(self.predicates.iter().map(|(_, sp)| *sp));
 975     }
 976
 977     pub fn instantiate_identity(&self, tcx: TyCtxt<'tcx>) -> InstantiatedPredicates<'tcx> {
 978         let mut instantiated = InstantiatedPredicates::empty();
 979         self.instantiate_identity_into(tcx, &mut instantiated);
 980         instantiated
 981     }
 982
 983     fn instantiate_identity_into(
 984         &self,
 985         tcx: TyCtxt<'tcx>,
 986         instantiated: &mut InstantiatedPredicates<'tcx>,
 987     ) {
 988         if let Some(def_id) = self.parent {
 989             tcx.predicates_of(def_id).instantiate_identity_into(tcx, instantiated);
 990         }
 991         instantiated.predicates.extend(self.predicates.iter().map(|(p, _)| p));
 992         instantiated.spans.extend(self.predicates.iter().map(|(_, s)| s));
 993     }
 994
 995     pub fn instantiate_supertrait(
 996         &self,
 997         tcx: TyCtxt<'tcx>,
 998         poly_trait_ref: &ty::PolyTraitRef<'tcx>,
 999     ) -> InstantiatedPredicates<'tcx> {
1000         assert_eq!(self.parent, None);
1001         InstantiatedPredicates {
1002             predicates: self
1003                 .predicates
1004                 .iter()
1005                 .map(|(pred, _)| pred.subst_supertrait(tcx, poly_trait_ref))
1006                 .collect(),
1007             spans: self.predicates.iter().map(|(_, sp)| *sp).collect(),
1008         }
1009     }
1010 }
1011
1012 #[derive(Debug)]
1013 crate struct PredicateInner<'tcx> {
1014     kind: PredicateKind<'tcx>,
1015     flags: TypeFlags,
1016     /// See the comment for the corresponding field of [TyS].
1017     outer_exclusive_binder: ty::DebruijnIndex,
1018 }
1019
1020 #[cfg(target_arch = "x86_64")]
1021 static_assert_size!(PredicateInner<'_>, 40);
1022
1023 #[derive(Clone, Copy, Lift)]
1024 pub struct Predicate<'tcx> {
1025     inner: &'tcx PredicateInner<'tcx>,
1026 }
1027
1028 impl rustc_serialize::UseSpecializedEncodable for Predicate<'_> {}
1029 impl rustc_serialize::UseSpecializedDecodable for Predicate<'_> {}
1030
1031 impl<'tcx> PartialEq for Predicate<'tcx> {
1032     fn eq(&self, other: &Self) -> bool {
1033         // `self.kind` is always interned.
1034         ptr::eq(self.inner, other.inner)
1035     }
1036 }
1037
1038 impl Hash for Predicate<'_> {
1039     fn hash<H: Hasher>(&self, s: &mut H) {
1040         (self.inner as *const PredicateInner<'_>).hash(s)
1041     }
1042 }
1043
1044 impl<'tcx> Eq for Predicate<'tcx> {}
1045
1046 impl<'tcx> Predicate<'tcx> {
1047     #[inline(always)]
1048     pub fn kind(self) -> &'tcx PredicateKind<'tcx> {
1049         &self.inner.kind
1050     }
1051 }
1052
1053 impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for Predicate<'tcx> {
1054     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
1055         let PredicateInner {
1056             ref kind,
1057
1058             // The other fields just provide fast access to information that is
1059             // also contained in `kind`, so no need to hash them.
1060             flags: _,
1061             outer_exclusive_binder: _,
1062         } = self.inner;
1063
1064         kind.hash_stable(hcx, hasher);
1065     }
1066 }
1067
1068 impl<'tcx> Predicate<'tcx> {
1069     pub fn kint(self, tcx: TyCtxt<'tcx>) -> &'tcx PredicateKint<'tcx> {
1070         // I am efficient
1071         tcx.intern_predicate_kint(match *self.kind() {
1072             PredicateKind::Trait(binder, data) => {
1073                 if let Some(simpl) = binder.no_bound_vars() {
1074                     PredicateKint::Trait(simpl, data)
1075                 } else {
1076                     let inner = tcx
1077                         .intern_predicate_kint(PredicateKint::Trait(*binder.skip_binder(), data));
1078                     PredicateKint::ForAll(Binder::bind(inner))
1079                 }
1080             }
1081             PredicateKind::RegionOutlives(binder) => {
1082                 if let Some(simpl) = binder.no_bound_vars() {
1083                     PredicateKint::RegionOutlives(simpl)
1084                 } else {
1085                     let inner = tcx.intern_predicate_kint(PredicateKint::RegionOutlives(
1086                         *binder.skip_binder(),
1087                     ));
1088                     PredicateKint::ForAll(Binder::bind(inner))
1089                 }
1090             }
1091             PredicateKind::TypeOutlives(binder) => {
1092                 if let Some(simpl) = binder.no_bound_vars() {
1093                     PredicateKint::TypeOutlives(simpl)
1094                 } else {
1095                     let inner = tcx
1096                         .intern_predicate_kint(PredicateKint::TypeOutlives(*binder.skip_binder()));
1097                     PredicateKint::ForAll(Binder::bind(inner))
1098                 }
1099             }
1100             PredicateKind::Projection(binder) => {
1101                 if let Some(simpl) = binder.no_bound_vars() {
1102                     PredicateKint::Projection(simpl)
1103                 } else {
1104                     let inner =
1105                         tcx.intern_predicate_kint(PredicateKint::Projection(*binder.skip_binder()));
1106                     PredicateKint::ForAll(Binder::bind(inner))
1107                 }
1108             }
1109             PredicateKind::WellFormed(arg) => PredicateKint::WellFormed(arg),
1110             PredicateKind::ObjectSafe(def_id) => PredicateKint::ObjectSafe(def_id),
1111             PredicateKind::ClosureKind(def_id, substs, kind) => {
1112                 PredicateKint::ClosureKind(def_id, substs, kind)
1113             }
1114             PredicateKind::Subtype(binder) => {
1115                 if let Some(simpl) = binder.no_bound_vars() {
1116                     PredicateKint::Subtype(simpl)
1117                 } else {
1118                     let inner =
1119                         tcx.intern_predicate_kint(PredicateKint::Subtype(*binder.skip_binder()));
1120                     PredicateKint::ForAll(Binder::bind(inner))
1121                 }
1122             }
1123             PredicateKind::ConstEvaluatable(def, substs) => {
1124                 PredicateKint::ConstEvaluatable(def, substs)
1125             }
1126             PredicateKind::ConstEquate(l, r) => PredicateKint::ConstEquate(l, r),
1127         })
1128     }
1129 }
1130
1131 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1132 #[derive(TypeFoldable)]
1133 pub enum PredicateKint<'tcx> {
1134     /// Corresponds to `where Foo: Bar<A, B, C>`. `Foo` here would be
1135     /// the `Self` type of the trait reference and `A`, `B`, and `C`
1136     /// would be the type parameters.
1137     ///
1138     /// A trait predicate will have `Constness::Const` if it originates
1139     /// from a bound on a `const fn` without the `?const` opt-out (e.g.,
1140     /// `const fn foobar<Foo: Bar>() {}`).
1141     Trait(TraitPredicate<'tcx>, Constness),
1142
1143     /// `where 'a: 'b`
1144     RegionOutlives(RegionOutlivesPredicate<'tcx>),
1145
1146     /// `where T: 'a`
1147     TypeOutlives(TypeOutlivesPredicate<'tcx>),
1148
1149     /// `where <T as TraitRef>::Name == X`, approximately.
1150     /// See the `ProjectionPredicate` struct for details.
1151     Projection(ProjectionPredicate<'tcx>),
1152
1153     /// No syntax: `T` well-formed.
1154     WellFormed(GenericArg<'tcx>),
1155
1156     /// Trait must be object-safe.
1157     ObjectSafe(DefId),
1158
1159     /// No direct syntax. May be thought of as `where T: FnFoo<...>`
1160     /// for some substitutions `...` and `T` being a closure type.
1161     /// Satisfied (or refuted) once we know the closure's kind.
1162     ClosureKind(DefId, SubstsRef<'tcx>, ClosureKind),
1163
1164     /// `T1 <: T2`
1165     Subtype(SubtypePredicate<'tcx>),
1166
1167     /// Constant initializer must evaluate successfully.
1168     ConstEvaluatable(DefId, SubstsRef<'tcx>),
1169
1170     /// Constants must be equal. The first component is the const that is expected.
1171     ConstEquate(&'tcx Const<'tcx>, &'tcx Const<'tcx>),
1172
1173     /// `for<'a>: ...`
1174     ForAll(Binder<&'tcx PredicateKint<'tcx>>),
1175 }
1176
1177 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1178 #[derive(HashStable, TypeFoldable)]
1179 pub enum PredicateKind<'tcx> {
1180     /// Corresponds to `where Foo: Bar<A, B, C>`. `Foo` here would be
1181     /// the `Self` type of the trait reference and `A`, `B`, and `C`
1182     /// would be the type parameters.
1183     ///
1184     /// A trait predicate will have `Constness::Const` if it originates
1185     /// from a bound on a `const fn` without the `?const` opt-out (e.g.,
1186     /// `const fn foobar<Foo: Bar>() {}`).
1187     Trait(PolyTraitPredicate<'tcx>, Constness),
1188
1189     /// `where 'a: 'b`
1190     RegionOutlives(PolyRegionOutlivesPredicate<'tcx>),
1191
1192     /// `where T: 'a`
1193     TypeOutlives(PolyTypeOutlivesPredicate<'tcx>),
1194
1195     /// `where <T as TraitRef>::Name == X`, approximately.
1196     /// See the `ProjectionPredicate` struct for details.
1197     Projection(PolyProjectionPredicate<'tcx>),
1198
1199     /// No syntax: `T` well-formed.
1200     WellFormed(GenericArg<'tcx>),
1201
1202     /// Trait must be object-safe.
1203     ObjectSafe(DefId),
1204
1205     /// No direct syntax. May be thought of as `where T: FnFoo<...>`
1206     /// for some substitutions `...` and `T` being a closure type.
1207     /// Satisfied (or refuted) once we know the closure's kind.
1208     ClosureKind(DefId, SubstsRef<'tcx>, ClosureKind),
1209
1210     /// `T1 <: T2`
1211     Subtype(PolySubtypePredicate<'tcx>),
1212
1213     /// Constant initializer must evaluate successfully.
1214     ConstEvaluatable(ty::WithOptConstParam<DefId>, SubstsRef<'tcx>),
1215
1216     /// Constants must be equal. The first component is the const that is expected.
1217     ConstEquate(&'tcx Const<'tcx>, &'tcx Const<'tcx>),
1218 }
1219
1220 /// The crate outlives map is computed during typeck and contains the
1221 /// outlives of every item in the local crate. You should not use it
1222 /// directly, because to do so will make your pass dependent on the
1223 /// HIR of every item in the local crate. Instead, use
1224 /// `tcx.inferred_outlives_of()` to get the outlives for a *particular*
1225 /// item.
1226 #[derive(HashStable)]
1227 pub struct CratePredicatesMap<'tcx> {
1228     /// For each struct with outlive bounds, maps to a vector of the
1229     /// predicate of its outlive bounds. If an item has no outlives
1230     /// bounds, it will have no entry.
1231     pub predicates: FxHashMap<DefId, &'tcx [(ty::Predicate<'tcx>, Span)]>,
1232 }
1233
1234 impl<'tcx> Predicate<'tcx> {
1235     /// Performs a substitution suitable for going from a
1236     /// poly-trait-ref to supertraits that must hold if that
1237     /// poly-trait-ref holds. This is slightly different from a normal
1238     /// substitution in terms of what happens with bound regions. See
1239     /// lengthy comment below for details.
1240     pub fn subst_supertrait(
1241         self,
1242         tcx: TyCtxt<'tcx>,
1243         trait_ref: &ty::PolyTraitRef<'tcx>,
1244     ) -> ty::Predicate<'tcx> {
1245         // The interaction between HRTB and supertraits is not entirely
1246         // obvious. Let me walk you (and myself) through an example.
1247         //
1248         // Let's start with an easy case. Consider two traits:
1249         //
1250         //     trait Foo<'a>: Bar<'a,'a> { }
1251         //     trait Bar<'b,'c> { }
1252         //
1253         // Now, if we have a trait reference `for<'x> T: Foo<'x>`, then
1254         // we can deduce that `for<'x> T: Bar<'x,'x>`. Basically, if we
1255         // knew that `Foo<'x>` (for any 'x) then we also know that
1256         // `Bar<'x,'x>` (for any 'x). This more-or-less falls out from
1257         // normal substitution.
1258         //
1259         // In terms of why this is sound, the idea is that whenever there
1260         // is an impl of `T:Foo<'a>`, it must show that `T:Bar<'a,'a>`
1261         // holds.  So if there is an impl of `T:Foo<'a>` that applies to
1262         // all `'a`, then we must know that `T:Bar<'a,'a>` holds for all
1263         // `'a`.
1264         //
1265         // Another example to be careful of is this:
1266         //
1267         //     trait Foo1<'a>: for<'b> Bar1<'a,'b> { }
1268         //     trait Bar1<'b,'c> { }
1269         //
1270         // Here, if we have `for<'x> T: Foo1<'x>`, then what do we know?
1271         // The answer is that we know `for<'x,'b> T: Bar1<'x,'b>`. The
1272         // reason is similar to the previous example: any impl of
1273         // `T:Foo1<'x>` must show that `for<'b> T: Bar1<'x, 'b>`.  So
1274         // basically we would want to collapse the bound lifetimes from
1275         // the input (`trait_ref`) and the supertraits.
1276         //
1277         // To achieve this in practice is fairly straightforward. Let's
1278         // consider the more complicated scenario:
1279         //
1280         // - We start out with `for<'x> T: Foo1<'x>`. In this case, `'x`
1281         //   has a De Bruijn index of 1. We want to produce `for<'x,'b> T: Bar1<'x,'b>`,
1282         //   where both `'x` and `'b` would have a DB index of 1.
1283         //   The substitution from the input trait-ref is therefore going to be
1284         //   `'a => 'x` (where `'x` has a DB index of 1).
1285         // - The super-trait-ref is `for<'b> Bar1<'a,'b>`, where `'a` is an
1286         //   early-bound parameter and `'b' is a late-bound parameter with a
1287         //   DB index of 1.
1288         // - If we replace `'a` with `'x` from the input, it too will have
1289         //   a DB index of 1, and thus we'll have `for<'x,'b> Bar1<'x,'b>`
1290         //   just as we wanted.
1291         //
1292         // There is only one catch. If we just apply the substitution `'a
1293         // => 'x` to `for<'b> Bar1<'a,'b>`, the substitution code will
1294         // adjust the DB index because we substituting into a binder (it
1295         // tries to be so smart...) resulting in `for<'x> for<'b>
1296         // Bar1<'x,'b>` (we have no syntax for this, so use your
1297         // imagination). Basically the 'x will have DB index of 2 and 'b
1298         // will have DB index of 1. Not quite what we want. So we apply
1299         // the substitution to the *contents* of the trait reference,
1300         // rather than the trait reference itself (put another way, the
1301         // substitution code expects equal binding levels in the values
1302         // from the substitution and the value being substituted into, and
1303         // this trick achieves that).
1304
1305         let substs = trait_ref.skip_binder().substs;
1306         let kind = match self.kint(tcx) {
1307             PredicateKint::ForAll(binder) => *binder.skip_binder(),
1308             kind => kind,
1309         };
1310
1311         let new = kind.subst(tcx, substs);
1312
1313         let rebound = if new.has_escaping_bound_vars() {
1314             PredicateKint::ForAll(Binder::bind(tcx.intern_predicate_kint(new)))
1315         } else {
1316             new
1317         };
1318
1319         if rebound != *kind { rebound.to_predicate(tcx) } else { self }
1320     }
1321 }
1322
1323 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1324 #[derive(HashStable, TypeFoldable)]
1325 pub struct TraitPredicate<'tcx> {
1326     pub trait_ref: TraitRef<'tcx>,
1327 }
1328
1329 pub type PolyTraitPredicate<'tcx> = ty::Binder<TraitPredicate<'tcx>>;
1330
1331 impl<'tcx> TraitPredicate<'tcx> {
1332     pub fn def_id(self) -> DefId {
1333         self.trait_ref.def_id
1334     }
1335
1336     pub fn self_ty(self) -> Ty<'tcx> {
1337         self.trait_ref.self_ty()
1338     }
1339 }
1340
1341 impl<'tcx> PolyTraitPredicate<'tcx> {
1342     pub fn def_id(self) -> DefId {
1343         // Ok to skip binder since trait `DefId` does not care about regions.
1344         self.skip_binder().def_id()
1345     }
1346 }
1347
1348 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, RustcEncodable, RustcDecodable)]
1349 #[derive(HashStable, TypeFoldable)]
1350 pub struct OutlivesPredicate<A, B>(pub A, pub B); // `A: B`
1351 pub type PolyOutlivesPredicate<A, B> = ty::Binder<OutlivesPredicate<A, B>>;
1352 pub type RegionOutlivesPredicate<'tcx> = OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>;
1353 pub type TypeOutlivesPredicate<'tcx> = OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>;
1354 pub type PolyRegionOutlivesPredicate<'tcx> = ty::Binder<RegionOutlivesPredicate<'tcx>>;
1355 pub type PolyTypeOutlivesPredicate<'tcx> = ty::Binder<TypeOutlivesPredicate<'tcx>>;
1356
1357 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
1358 #[derive(HashStable, TypeFoldable)]
1359 pub struct SubtypePredicate<'tcx> {
1360     pub a_is_expected: bool,
1361     pub a: Ty<'tcx>,
1362     pub b: Ty<'tcx>,
1363 }
1364 pub type PolySubtypePredicate<'tcx> = ty::Binder<SubtypePredicate<'tcx>>;
1365
1366 /// This kind of predicate has no *direct* correspondent in the
1367 /// syntax, but it roughly corresponds to the syntactic forms:
1368 ///
1369 /// 1. `T: TraitRef<..., Item = Type>`
1370 /// 2. `<T as TraitRef<...>>::Item == Type` (NYI)
1371 ///
1372 /// In particular, form #1 is "desugared" to the combination of a
1373 /// normal trait predicate (`T: TraitRef<...>`) and one of these
1374 /// predicates. Form #2 is a broader form in that it also permits
1375 /// equality between arbitrary types. Processing an instance of
1376 /// Form #2 eventually yields one of these `ProjectionPredicate`
1377 /// instances to normalize the LHS.
1378 #[derive(Copy, Clone, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1379 #[derive(HashStable, TypeFoldable)]
1380 pub struct ProjectionPredicate<'tcx> {
1381     pub projection_ty: ProjectionTy<'tcx>,
1382     pub ty: Ty<'tcx>,
1383 }
1384
1385 pub type PolyProjectionPredicate<'tcx> = Binder<ProjectionPredicate<'tcx>>;
1386
1387 impl<'tcx> PolyProjectionPredicate<'tcx> {
1388     /// Returns the `DefId` of the associated item being projected.
1389     pub fn item_def_id(&self) -> DefId {
1390         self.skip_binder().projection_ty.item_def_id
1391     }
1392
1393     #[inline]
1394     pub fn to_poly_trait_ref(&self, tcx: TyCtxt<'tcx>) -> PolyTraitRef<'tcx> {
1395         // Note: unlike with `TraitRef::to_poly_trait_ref()`,
1396         // `self.0.trait_ref` is permitted to have escaping regions.
1397         // This is because here `self` has a `Binder` and so does our
1398         // return value, so we are preserving the number of binding
1399         // levels.
1400         self.map_bound(|predicate| predicate.projection_ty.trait_ref(tcx))
1401     }
1402
1403     pub fn ty(&self) -> Binder<Ty<'tcx>> {
1404         self.map_bound(|predicate| predicate.ty)
1405     }
1406
1407     /// The `DefId` of the `TraitItem` for the associated type.
1408     ///
1409     /// Note that this is not the `DefId` of the `TraitRef` containing this
1410     /// associated type, which is in `tcx.associated_item(projection_def_id()).container`.
1411     pub fn projection_def_id(&self) -> DefId {
1412         // Ok to skip binder since trait `DefId` does not care about regions.
1413         self.skip_binder().projection_ty.item_def_id
1414     }
1415 }
1416
1417 pub trait ToPolyTraitRef<'tcx> {
1418     fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx>;
1419 }
1420
1421 impl<'tcx> ToPolyTraitRef<'tcx> for TraitRef<'tcx> {
1422     fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1423         ty::Binder::dummy(*self)
1424     }
1425 }
1426
1427 impl<'tcx> ToPolyTraitRef<'tcx> for PolyTraitPredicate<'tcx> {
1428     fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1429         self.map_bound_ref(|trait_pred| trait_pred.trait_ref)
1430     }
1431 }
1432
1433 pub trait ToPredicate<'tcx> {
1434     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx>;
1435 }
1436
1437 impl ToPredicate<'tcx> for PredicateKind<'tcx> {
1438     #[inline(always)]
1439     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx> {
1440         tcx.mk_predicate(self)
1441     }
1442 }
1443
1444 impl ToPredicate<'tcx> for PredicateKint<'tcx> {
1445     #[inline(always)]
1446     fn to_predicate(&self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx> {
1447         let (predicate, in_binder) = if let PredicateKint::ForAll(binder) = self {
1448             (*binder.skip_binder(), true)
1449         } else {
1450             (self, false)
1451         };
1452
1453         macro_rules! bind {
1454             ($expr:expr) => {
1455                 match $expr {
1456                     expr => {
1457                         if in_binder {
1458                             Binder::bind(expr)
1459                         } else {
1460                             Binder::dummy(expr)
1461                         }
1462                     }
1463                 }
1464             };
1465         }
1466
1467         match *predicate {
1468             PredicateKint::ForAll(_) => bug!("unexpected PredicateKint: {:?}", self),
1469             PredicateKint::Trait(data, ct) => PredicateKind::Trait(bind!(data), ct),
1470             PredicateKint::RegionOutlives(data) => PredicateKind::RegionOutlives(bind!(data)),
1471             PredicateKint::TypeOutlives(data) => PredicateKind::TypeOutlives(bind!(data)),
1472             PredicateKint::Projection(data) => PredicateKind::Projection(bind!(data)),
1473             PredicateKint::WellFormed(arg) => {
1474                 if in_binder {
1475                     bug!("unexpected ForAll: {:?}", self)
1476                 } else {
1477                     PredicateKind::WellFormed(arg)
1478                 }
1479             }
1480             PredicateKint::ObjectSafe(def_id) => {
1481                 if in_binder {
1482                     bug!("unexpected ForAll: {:?}", self)
1483                 } else {
1484                     PredicateKind::ObjectSafe(def_id)
1485                 }
1486             }
1487             PredicateKint::ClosureKind(def_id, substs, kind) => {
1488                 if in_binder {
1489                     bug!("unexpected ForAll: {:?}", self)
1490                 } else {
1491                     PredicateKind::ClosureKind(def_id, substs, kind)
1492                 }
1493             }
1494             PredicateKint::Subtype(data) => PredicateKind::Subtype(bind!(data)),
1495             PredicateKint::ConstEvaluatable(def_id, substs) => {
1496                 if in_binder {
1497                     bug!("unexpected ForAll: {:?}", self)
1498                 } else {
1499                     PredicateKind::ConstEvaluatable(def_id, substs)
1500                 }
1501             }
1502             PredicateKint::ConstEquate(l, r) => {
1503                 if in_binder {
1504                     bug!("unexpected ForAll: {:?}", self)
1505                 } else {
1506                     PredicateKind::ConstEquate(l, r)
1507                 }
1508             }
1509         }
1510         .to_predicate(tcx)
1511     }
1512 }
1513
1514 impl<'tcx> ToPredicate<'tcx> for ConstnessAnd<TraitRef<'tcx>> {
1515     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx> {
1516         ty::PredicateKind::Trait(
1517             ty::Binder::dummy(ty::TraitPredicate { trait_ref: self.value }),
1518             self.constness,
1519         )
1520         .to_predicate(tcx)
1521     }
1522 }
1523
1524 impl<'tcx> ToPredicate<'tcx> for ConstnessAnd<&TraitRef<'tcx>> {
1525     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx> {
1526         ty::PredicateKind::Trait(
1527             ty::Binder::dummy(ty::TraitPredicate { trait_ref: *self.value }),
1528             self.constness,
1529         )
1530         .to_predicate(tcx)
1531     }
1532 }
1533
1534 impl<'tcx> ToPredicate<'tcx> for ConstnessAnd<PolyTraitRef<'tcx>> {
1535     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx> {
1536         ty::PredicateKind::Trait(self.value.to_poly_trait_predicate(), self.constness)
1537             .to_predicate(tcx)
1538     }
1539 }
1540
1541 impl<'tcx> ToPredicate<'tcx> for PolyRegionOutlivesPredicate<'tcx> {
1542     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx> {
1543         PredicateKind::RegionOutlives(self).to_predicate(tcx)
1544     }
1545 }
1546
1547 impl<'tcx> ToPredicate<'tcx> for PolyTypeOutlivesPredicate<'tcx> {
1548     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx> {
1549         PredicateKind::TypeOutlives(self).to_predicate(tcx)
1550     }
1551 }
1552
1553 impl<'tcx> ToPredicate<'tcx> for PolyProjectionPredicate<'tcx> {
1554     fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx> {
1555         PredicateKind::Projection(self).to_predicate(tcx)
1556     }
1557 }
1558
1559 impl<'tcx> Predicate<'tcx> {
1560     pub fn to_opt_poly_trait_ref(self) -> Option<PolyTraitRef<'tcx>> {
1561         match self.kind() {
1562             &PredicateKind::Trait(ref t, _) => Some(t.to_poly_trait_ref()),
1563             PredicateKind::Projection(..)
1564             | PredicateKind::Subtype(..)
1565             | PredicateKind::RegionOutlives(..)
1566             | PredicateKind::WellFormed(..)
1567             | PredicateKind::ObjectSafe(..)
1568             | PredicateKind::ClosureKind(..)
1569             | PredicateKind::TypeOutlives(..)
1570             | PredicateKind::ConstEvaluatable(..)
1571             | PredicateKind::ConstEquate(..) => None,
1572         }
1573     }
1574
1575     pub fn to_opt_type_outlives(self) -> Option<PolyTypeOutlivesPredicate<'tcx>> {
1576         match self.kind() {
1577             &PredicateKind::TypeOutlives(data) => Some(data),
1578             PredicateKind::Trait(..)
1579             | PredicateKind::Projection(..)
1580             | PredicateKind::Subtype(..)
1581             | PredicateKind::RegionOutlives(..)
1582             | PredicateKind::WellFormed(..)
1583             | PredicateKind::ObjectSafe(..)
1584             | PredicateKind::ClosureKind(..)
1585             | PredicateKind::ConstEvaluatable(..)
1586             | PredicateKind::ConstEquate(..) => None,
1587         }
1588     }
1589 }
1590
1591 /// Represents the bounds declared on a particular set of type
1592 /// parameters. Should eventually be generalized into a flag list of
1593 /// where-clauses. You can obtain a `InstantiatedPredicates` list from a
1594 /// `GenericPredicates` by using the `instantiate` method. Note that this method
1595 /// reflects an important semantic invariant of `InstantiatedPredicates`: while
1596 /// the `GenericPredicates` are expressed in terms of the bound type
1597 /// parameters of the impl/trait/whatever, an `InstantiatedPredicates` instance
1598 /// represented a set of bounds for some particular instantiation,
1599 /// meaning that the generic parameters have been substituted with
1600 /// their values.
1601 ///
1602 /// Example:
1603 ///
1604 ///     struct Foo<T, U: Bar<T>> { ... }
1605 ///
1606 /// Here, the `GenericPredicates` for `Foo` would contain a list of bounds like
1607 /// `[[], [U:Bar<T>]]`. Now if there were some particular reference
1608 /// like `Foo<isize,usize>`, then the `InstantiatedPredicates` would be `[[],
1609 /// [usize:Bar<isize>]]`.
1610 #[derive(Clone, Debug, TypeFoldable)]
1611 pub struct InstantiatedPredicates<'tcx> {
1612     pub predicates: Vec<Predicate<'tcx>>,
1613     pub spans: Vec<Span>,
1614 }
1615
1616 impl<'tcx> InstantiatedPredicates<'tcx> {
1617     pub fn empty() -> InstantiatedPredicates<'tcx> {
1618         InstantiatedPredicates { predicates: vec![], spans: vec![] }
1619     }
1620
1621     pub fn is_empty(&self) -> bool {
1622         self.predicates.is_empty()
1623     }
1624 }
1625
1626 rustc_index::newtype_index! {
1627     /// "Universes" are used during type- and trait-checking in the
1628     /// presence of `for<..>` binders to control what sets of names are
1629     /// visible. Universes are arranged into a tree: the root universe
1630     /// contains names that are always visible. Each child then adds a new
1631     /// set of names that are visible, in addition to those of its parent.
1632     /// We say that the child universe "extends" the parent universe with
1633     /// new names.
1634     ///
1635     /// To make this more concrete, consider this program:
1636     ///
1637     /// ```
1638     /// struct Foo { }
1639     /// fn bar<T>(x: T) {
1640     ///   let y: for<'a> fn(&'a u8, Foo) = ...;
1641     /// }
1642     /// ```
1643     ///
1644     /// The struct name `Foo` is in the root universe U0. But the type
1645     /// parameter `T`, introduced on `bar`, is in an extended universe U1
1646     /// -- i.e., within `bar`, we can name both `T` and `Foo`, but outside
1647     /// of `bar`, we cannot name `T`. Then, within the type of `y`, the
1648     /// region `'a` is in a universe U2 that extends U1, because we can
1649     /// name it inside the fn type but not outside.
1650     ///
1651     /// Universes are used to do type- and trait-checking around these
1652     /// "forall" binders (also called **universal quantification**). The
1653     /// idea is that when, in the body of `bar`, we refer to `T` as a
1654     /// type, we aren't referring to any type in particular, but rather a
1655     /// kind of "fresh" type that is distinct from all other types we have
1656     /// actually declared. This is called a **placeholder** type, and we
1657     /// use universes to talk about this. In other words, a type name in
1658     /// universe 0 always corresponds to some "ground" type that the user
1659     /// declared, but a type name in a non-zero universe is a placeholder
1660     /// type -- an idealized representative of "types in general" that we
1661     /// use for checking generic functions.
1662     pub struct UniverseIndex {
1663         derive [HashStable]
1664         DEBUG_FORMAT = "U{}",
1665     }
1666 }
1667
1668 impl UniverseIndex {
1669     pub const ROOT: UniverseIndex = UniverseIndex::from_u32(0);
1670
1671     /// Returns the "next" universe index in order -- this new index
1672     /// is considered to extend all previous universes. This
1673     /// corresponds to entering a `forall` quantifier. So, for
1674     /// example, suppose we have this type in universe `U`:
1675     ///
1676     /// ```
1677     /// for<'a> fn(&'a u32)
1678     /// ```
1679     ///
1680     /// Once we "enter" into this `for<'a>` quantifier, we are in a
1681     /// new universe that extends `U` -- in this new universe, we can
1682     /// name the region `'a`, but that region was not nameable from
1683     /// `U` because it was not in scope there.
1684     pub fn next_universe(self) -> UniverseIndex {
1685         UniverseIndex::from_u32(self.private.checked_add(1).unwrap())
1686     }
1687
1688     /// Returns `true` if `self` can name a name from `other` -- in other words,
1689     /// if the set of names in `self` is a superset of those in
1690     /// `other` (`self >= other`).
1691     pub fn can_name(self, other: UniverseIndex) -> bool {
1692         self.private >= other.private
1693     }
1694
1695     /// Returns `true` if `self` cannot name some names from `other` -- in other
1696     /// words, if the set of names in `self` is a strict subset of
1697     /// those in `other` (`self < other`).
1698     pub fn cannot_name(self, other: UniverseIndex) -> bool {
1699         self.private < other.private
1700     }
1701 }
1702
1703 /// The "placeholder index" fully defines a placeholder region.
1704 /// Placeholder regions are identified by both a **universe** as well
1705 /// as a "bound-region" within that universe. The `bound_region` is
1706 /// basically a name -- distinct bound regions within the same
1707 /// universe are just two regions with an unknown relationship to one
1708 /// another.
1709 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, PartialOrd, Ord)]
1710 pub struct Placeholder<T> {
1711     pub universe: UniverseIndex,
1712     pub name: T,
1713 }
1714
1715 impl<'a, T> HashStable<StableHashingContext<'a>> for Placeholder<T>
1716 where
1717     T: HashStable<StableHashingContext<'a>>,
1718 {
1719     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
1720         self.universe.hash_stable(hcx, hasher);
1721         self.name.hash_stable(hcx, hasher);
1722     }
1723 }
1724
1725 pub type PlaceholderRegion = Placeholder<BoundRegion>;
1726
1727 pub type PlaceholderType = Placeholder<BoundVar>;
1728
1729 pub type PlaceholderConst = Placeholder<BoundVar>;
1730
1731 /// A `DefId` which is potentially bundled with its corresponding generic parameter
1732 /// in case `did` is a const argument.
1733 ///
1734 /// This is used to prevent cycle errors during typeck
1735 /// as `type_of(const_arg)` depends on `typeck(owning_body)`
1736 /// which once again requires the type of its generic arguments.
1737 ///
1738 /// Luckily we only need to deal with const arguments once we
1739 /// know their corresponding parameters. We (ab)use this by
1740 /// calling `type_of(param_did)` for these arguments.
1741 ///
1742 /// ```rust
1743 /// #![feature(const_generics)]
1744 ///
1745 /// struct A;
1746 /// impl A {
1747 ///     fn foo<const N: usize>(&self) -> usize { N }
1748 /// }
1749 /// struct B;
1750 /// impl B {
1751 ///     fn foo<const N: u8>(&self) -> usize { 42 }
1752 /// }
1753 ///
1754 /// fn main() {
1755 ///     let a = A;
1756 ///     a.foo::<7>();
1757 /// }
1758 /// ```
1759 #[derive(Copy, Clone, Debug, TypeFoldable, Lift, RustcEncodable, RustcDecodable)]
1760 #[derive(PartialEq, Eq, PartialOrd, Ord)]
1761 #[derive(Hash, HashStable)]
1762 pub struct WithOptConstParam<T> {
1763     pub did: T,
1764     /// The `DefId` of the corresponding generic paramter in case `did` is
1765     /// a const argument.
1766     ///
1767     /// Note that even if `did` is a const argument, this may still be `None`.
1768     /// All queries taking `WithOptConstParam` start by calling `tcx.opt_const_param_of(def.did)`
1769     /// to potentially update `param_did` in case it `None`.
1770     pub const_param_did: Option<DefId>,
1771 }
1772
1773 impl<T> WithOptConstParam<T> {
1774     /// Creates a new `WithOptConstParam` setting `const_param_did` to `None`.
1775     #[inline(always)]
1776     pub fn unknown(did: T) -> WithOptConstParam<T> {
1777         WithOptConstParam { did, const_param_did: None }
1778     }
1779 }
1780
1781 impl WithOptConstParam<LocalDefId> {
1782     /// Returns `Some((did, param_did))` if `def_id` is a const argument,
1783     /// `None` otherwise.
1784     #[inline(always)]
1785     pub fn try_lookup(did: LocalDefId, tcx: TyCtxt<'_>) -> Option<(LocalDefId, DefId)> {
1786         tcx.opt_const_param_of(did).map(|param_did| (did, param_did))
1787     }
1788
1789     /// In case `self` is unknown but `self.did` is a const argument, this returns
1790     /// a `WithOptConstParam` with the correct `const_param_did`.
1791     #[inline(always)]
1792     pub fn try_upgrade(self, tcx: TyCtxt<'_>) -> Option<WithOptConstParam<LocalDefId>> {
1793         if self.const_param_did.is_none() {
1794             if let const_param_did @ Some(_) = tcx.opt_const_param_of(self.did) {
1795                 return Some(WithOptConstParam { did: self.did, const_param_did });
1796             }
1797         }
1798
1799         None
1800     }
1801
1802     pub fn to_global(self) -> WithOptConstParam<DefId> {
1803         WithOptConstParam { did: self.did.to_def_id(), const_param_did: self.const_param_did }
1804     }
1805
1806     pub fn def_id_for_type_of(self) -> DefId {
1807         if let Some(did) = self.const_param_did { did } else { self.did.to_def_id() }
1808     }
1809 }
1810
1811 impl WithOptConstParam<DefId> {
1812     pub fn as_local(self) -> Option<WithOptConstParam<LocalDefId>> {
1813         self.did
1814             .as_local()
1815             .map(|did| WithOptConstParam { did, const_param_did: self.const_param_did })
1816     }
1817
1818     pub fn as_const_arg(self) -> Option<(LocalDefId, DefId)> {
1819         if let Some(param_did) = self.const_param_did {
1820             if let Some(did) = self.did.as_local() {
1821                 return Some((did, param_did));
1822             }
1823         }
1824
1825         None
1826     }
1827
1828     pub fn expect_local(self) -> WithOptConstParam<LocalDefId> {
1829         self.as_local().unwrap()
1830     }
1831
1832     pub fn is_local(self) -> bool {
1833         self.did.is_local()
1834     }
1835
1836     pub fn def_id_for_type_of(self) -> DefId {
1837         self.const_param_did.unwrap_or(self.did)
1838     }
1839 }
1840
1841 /// When type checking, we use the `ParamEnv` to track
1842 /// details about the set of where-clauses that are in scope at this
1843 /// particular point.
1844 #[derive(Copy, Clone)]
1845 pub struct ParamEnv<'tcx> {
1846     // We pack the caller_bounds List pointer and a Reveal enum into this usize.
1847     // Specifically, the low bit represents Reveal, with 0 meaning `UserFacing`
1848     // and 1 meaning `All`. The rest is the pointer.
1849     //
1850     // This relies on the List<ty::Predicate<'tcx>> type having at least 2-byte
1851     // alignment. Lists start with a usize and are repr(C) so this should be
1852     // fine; there is a debug_assert in the constructor as well.
1853     //
1854     // Note that the choice of 0 for UserFacing is intentional -- since it is the
1855     // first variant in Reveal this means that joining the pointer is a simple `or`.
1856     packed_data: usize,
1857
1858     /// `Obligation`s that the caller must satisfy. This is basically
1859     /// the set of bounds on the in-scope type parameters, translated
1860     /// into `Obligation`s, and elaborated and normalized.
1861     ///
1862     /// Note: This is packed into the `packed_data` usize above, use the
1863     /// `caller_bounds()` method to access it.
1864     caller_bounds: PhantomData<&'tcx List<ty::Predicate<'tcx>>>,
1865
1866     /// Typically, this is `Reveal::UserFacing`, but during codegen we
1867     /// want `Reveal::All`.
1868     ///
1869     /// Note: This is packed into the caller_bounds usize above, use the reveal()
1870     /// method to access it.
1871     reveal: PhantomData<traits::Reveal>,
1872
1873     /// If this `ParamEnv` comes from a call to `tcx.param_env(def_id)`,
1874     /// register that `def_id` (useful for transitioning to the chalk trait
1875     /// solver).
1876     pub def_id: Option<DefId>,
1877 }
1878
1879 impl<'tcx> fmt::Debug for ParamEnv<'tcx> {
1880     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1881         f.debug_struct("ParamEnv")
1882             .field("caller_bounds", &self.caller_bounds())
1883             .field("reveal", &self.reveal())
1884             .field("def_id", &self.def_id)
1885             .finish()
1886     }
1887 }
1888
1889 impl<'tcx> Hash for ParamEnv<'tcx> {
1890     fn hash<H: Hasher>(&self, state: &mut H) {
1891         // List hashes as the raw pointer, so we can skip splitting into the
1892         // pointer and the enum.
1893         self.packed_data.hash(state);
1894         self.def_id.hash(state);
1895     }
1896 }
1897
1898 impl<'tcx> PartialEq for ParamEnv<'tcx> {
1899     fn eq(&self, other: &Self) -> bool {
1900         self.caller_bounds() == other.caller_bounds()
1901             && self.reveal() == other.reveal()
1902             && self.def_id == other.def_id
1903     }
1904 }
1905 impl<'tcx> Eq for ParamEnv<'tcx> {}
1906
1907 impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for ParamEnv<'tcx> {
1908     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
1909         self.caller_bounds().hash_stable(hcx, hasher);
1910         self.reveal().hash_stable(hcx, hasher);
1911         self.def_id.hash_stable(hcx, hasher);
1912     }
1913 }
1914
1915 impl<'tcx> TypeFoldable<'tcx> for ParamEnv<'tcx> {
1916     fn super_fold_with<F: ty::fold::TypeFolder<'tcx>>(&self, folder: &mut F) -> Self {
1917         ParamEnv::new(
1918             self.caller_bounds().fold_with(folder),
1919             self.reveal().fold_with(folder),
1920             self.def_id.fold_with(folder),
1921         )
1922     }
1923
1924     fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> bool {
1925         self.caller_bounds().visit_with(visitor)
1926             || self.reveal().visit_with(visitor)
1927             || self.def_id.visit_with(visitor)
1928     }
1929 }
1930
1931 impl<'tcx> ParamEnv<'tcx> {
1932     /// Construct a trait environment suitable for contexts where
1933     /// there are no where-clauses in scope. Hidden types (like `impl
1934     /// Trait`) are left hidden, so this is suitable for ordinary
1935     /// type-checking.
1936     #[inline]
1937     pub fn empty() -> Self {
1938         Self::new(List::empty(), Reveal::UserFacing, None)
1939     }
1940
1941     #[inline]
1942     pub fn caller_bounds(self) -> &'tcx List<ty::Predicate<'tcx>> {
1943         // mask out bottom bit
1944         unsafe { &*((self.packed_data & (!1)) as *const _) }
1945     }
1946
1947     #[inline]
1948     pub fn reveal(self) -> traits::Reveal {
1949         if self.packed_data & 1 == 0 { traits::Reveal::UserFacing } else { traits::Reveal::All }
1950     }
1951
1952     /// Construct a trait environment with no where-clauses in scope
1953     /// where the values of all `impl Trait` and other hidden types
1954     /// are revealed. This is suitable for monomorphized, post-typeck
1955     /// environments like codegen or doing optimizations.
1956     ///
1957     /// N.B., if you want to have predicates in scope, use `ParamEnv::new`,
1958     /// or invoke `param_env.with_reveal_all()`.
1959     #[inline]
1960     pub fn reveal_all() -> Self {
1961         Self::new(List::empty(), Reveal::All, None)
1962     }
1963
1964     /// Construct a trait environment with the given set of predicates.
1965     #[inline]
1966     pub fn new(
1967         caller_bounds: &'tcx List<ty::Predicate<'tcx>>,
1968         reveal: Reveal,
1969         def_id: Option<DefId>,
1970     ) -> Self {
1971         let packed_data = caller_bounds as *const _ as usize;
1972         // Check that we can pack the reveal data into the pointer.
1973         debug_assert!(packed_data & 1 == 0);
1974         ty::ParamEnv {
1975             packed_data: packed_data
1976                 | match reveal {
1977                     Reveal::UserFacing => 0,
1978                     Reveal::All => 1,
1979                 },
1980             caller_bounds: PhantomData,
1981             reveal: PhantomData,
1982             def_id,
1983         }
1984     }
1985
1986     pub fn with_user_facing(mut self) -> Self {
1987         // clear bottom bit
1988         self.packed_data &= !1;
1989         self
1990     }
1991
1992     /// Returns a new parameter environment with the same clauses, but
1993     /// which "reveals" the true results of projections in all cases
1994     /// (even for associated types that are specializable). This is
1995     /// the desired behavior during codegen and certain other special
1996     /// contexts; normally though we want to use `Reveal::UserFacing`,
1997     /// which is the default.
1998     pub fn with_reveal_all(mut self) -> Self {
1999         self.packed_data |= 1;
2000         self
2001     }
2002
2003     /// Returns this same environment but with no caller bounds.
2004     pub fn without_caller_bounds(self) -> Self {
2005         Self::new(List::empty(), self.reveal(), self.def_id)
2006     }
2007
2008     /// Creates a suitable environment in which to perform trait
2009     /// queries on the given value. When type-checking, this is simply
2010     /// the pair of the environment plus value. But when reveal is set to
2011     /// All, then if `value` does not reference any type parameters, we will
2012     /// pair it with the empty environment. This improves caching and is generally
2013     /// invisible.
2014     ///
2015     /// N.B., we preserve the environment when type-checking because it
2016     /// is possible for the user to have wacky where-clauses like
2017     /// `where Box<u32>: Copy`, which are clearly never
2018     /// satisfiable. We generally want to behave as if they were true,
2019     /// although the surrounding function is never reachable.
2020     pub fn and<T: TypeFoldable<'tcx>>(self, value: T) -> ParamEnvAnd<'tcx, T> {
2021         match self.reveal() {
2022             Reveal::UserFacing => ParamEnvAnd { param_env: self, value },
2023
2024             Reveal::All => {
2025                 if value.is_global() {
2026                     ParamEnvAnd { param_env: self.without_caller_bounds(), value }
2027                 } else {
2028                     ParamEnvAnd { param_env: self, value }
2029                 }
2030             }
2031         }
2032     }
2033 }
2034
2035 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
2036 pub struct ConstnessAnd<T> {
2037     pub constness: Constness,
2038     pub value: T,
2039 }
2040
2041 // FIXME(ecstaticmorse): Audit all occurrences of `without_const().to_predicate(tcx)` to ensure that
2042 // the constness of trait bounds is being propagated correctly.
2043 pub trait WithConstness: Sized {
2044     #[inline]
2045     fn with_constness(self, constness: Constness) -> ConstnessAnd<Self> {
2046         ConstnessAnd { constness, value: self }
2047     }
2048
2049     #[inline]
2050     fn with_const(self) -> ConstnessAnd<Self> {
2051         self.with_constness(Constness::Const)
2052     }
2053
2054     #[inline]
2055     fn without_const(self) -> ConstnessAnd<Self> {
2056         self.with_constness(Constness::NotConst)
2057     }
2058 }
2059
2060 impl<T> WithConstness for T {}
2061
2062 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, TypeFoldable)]
2063 pub struct ParamEnvAnd<'tcx, T> {
2064     pub param_env: ParamEnv<'tcx>,
2065     pub value: T,
2066 }
2067
2068 impl<'tcx, T> ParamEnvAnd<'tcx, T> {
2069     pub fn into_parts(self) -> (ParamEnv<'tcx>, T) {
2070         (self.param_env, self.value)
2071     }
2072 }
2073
2074 impl<'a, 'tcx, T> HashStable<StableHashingContext<'a>> for ParamEnvAnd<'tcx, T>
2075 where
2076     T: HashStable<StableHashingContext<'a>>,
2077 {
2078     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
2079         let ParamEnvAnd { ref param_env, ref value } = *self;
2080
2081         param_env.hash_stable(hcx, hasher);
2082         value.hash_stable(hcx, hasher);
2083     }
2084 }
2085
2086 #[derive(Copy, Clone, Debug, HashStable)]
2087 pub struct Destructor {
2088     /// The `DefId` of the destructor method
2089     pub did: DefId,
2090 }
2091
2092 bitflags! {
2093     #[derive(HashStable)]
2094     pub struct AdtFlags: u32 {
2095         const NO_ADT_FLAGS        = 0;
2096         /// Indicates whether the ADT is an enum.
2097         const IS_ENUM             = 1 << 0;
2098         /// Indicates whether the ADT is a union.
2099         const IS_UNION            = 1 << 1;
2100         /// Indicates whether the ADT is a struct.
2101         const IS_STRUCT           = 1 << 2;
2102         /// Indicates whether the ADT is a struct and has a constructor.
2103         const HAS_CTOR            = 1 << 3;
2104         /// Indicates whether the type is `PhantomData`.
2105         const IS_PHANTOM_DATA     = 1 << 4;
2106         /// Indicates whether the type has a `#[fundamental]` attribute.
2107         const IS_FUNDAMENTAL      = 1 << 5;
2108         /// Indicates whether the type is `Box`.
2109         const IS_BOX              = 1 << 6;
2110         /// Indicates whether the type is `ManuallyDrop`.
2111         const IS_MANUALLY_DROP    = 1 << 7;
2112         /// Indicates whether the variant list of this ADT is `#[non_exhaustive]`.
2113         /// (i.e., this flag is never set unless this ADT is an enum).
2114         const IS_VARIANT_LIST_NON_EXHAUSTIVE = 1 << 8;
2115     }
2116 }
2117
2118 bitflags! {
2119     #[derive(HashStable)]
2120     pub struct VariantFlags: u32 {
2121         const NO_VARIANT_FLAGS        = 0;
2122         /// Indicates whether the field list of this variant is `#[non_exhaustive]`.
2123         const IS_FIELD_LIST_NON_EXHAUSTIVE = 1 << 0;
2124     }
2125 }
2126
2127 /// Definition of a variant -- a struct's fields or a enum variant.
2128 #[derive(Debug, HashStable)]
2129 pub struct VariantDef {
2130     /// `DefId` that identifies the variant itself.
2131     /// If this variant belongs to a struct or union, then this is a copy of its `DefId`.
2132     pub def_id: DefId,
2133     /// `DefId` that identifies the variant's constructor.
2134     /// If this variant is a struct variant, then this is `None`.
2135     pub ctor_def_id: Option<DefId>,
2136     /// Variant or struct name.
2137     #[stable_hasher(project(name))]
2138     pub ident: Ident,
2139     /// Discriminant of this variant.
2140     pub discr: VariantDiscr,
2141     /// Fields of this variant.
2142     pub fields: Vec<FieldDef>,
2143     /// Type of constructor of variant.
2144     pub ctor_kind: CtorKind,
2145     /// Flags of the variant (e.g. is field list non-exhaustive)?
2146     flags: VariantFlags,
2147     /// Variant is obtained as part of recovering from a syntactic error.
2148     /// May be incomplete or bogus.
2149     pub recovered: bool,
2150 }
2151
2152 impl<'tcx> VariantDef {
2153     /// Creates a new `VariantDef`.
2154     ///
2155     /// `variant_did` is the `DefId` that identifies the enum variant (if this `VariantDef`
2156     /// represents an enum variant).
2157     ///
2158     /// `ctor_did` is the `DefId` that identifies the constructor of unit or
2159     /// tuple-variants/structs. If this is a `struct`-variant then this should be `None`.
2160     ///
2161     /// `parent_did` is the `DefId` of the `AdtDef` representing the enum or struct that
2162     /// owns this variant. It is used for checking if a struct has `#[non_exhaustive]` w/out having
2163     /// to go through the redirect of checking the ctor's attributes - but compiling a small crate
2164     /// requires loading the `AdtDef`s for all the structs in the universe (e.g., coherence for any
2165     /// built-in trait), and we do not want to load attributes twice.
2166     ///
2167     /// If someone speeds up attribute loading to not be a performance concern, they can
2168     /// remove this hack and use the constructor `DefId` everywhere.
2169     pub fn new(
2170         tcx: TyCtxt<'tcx>,
2171         ident: Ident,
2172         variant_did: Option<DefId>,
2173         ctor_def_id: Option<DefId>,
2174         discr: VariantDiscr,
2175         fields: Vec<FieldDef>,
2176         ctor_kind: CtorKind,
2177         adt_kind: AdtKind,
2178         parent_did: DefId,
2179         recovered: bool,
2180     ) -> Self {
2181         debug!(
2182             "VariantDef::new(ident = {:?}, variant_did = {:?}, ctor_def_id = {:?}, discr = {:?},
2183              fields = {:?}, ctor_kind = {:?}, adt_kind = {:?}, parent_did = {:?})",
2184             ident, variant_did, ctor_def_id, discr, fields, ctor_kind, adt_kind, parent_did,
2185         );
2186
2187         let mut flags = VariantFlags::NO_VARIANT_FLAGS;
2188         if adt_kind == AdtKind::Struct && tcx.has_attr(parent_did, sym::non_exhaustive) {
2189             debug!("found non-exhaustive field list for {:?}", parent_did);
2190             flags = flags | VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE;
2191         } else if let Some(variant_did) = variant_did {
2192             if tcx.has_attr(variant_did, sym::non_exhaustive) {
2193                 debug!("found non-exhaustive field list for {:?}", variant_did);
2194                 flags = flags | VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE;
2195             }
2196         }
2197
2198         VariantDef {
2199             def_id: variant_did.unwrap_or(parent_did),
2200             ctor_def_id,
2201             ident,
2202             discr,
2203             fields,
2204             ctor_kind,
2205             flags,
2206             recovered,
2207         }
2208     }
2209
2210     /// Is this field list non-exhaustive?
2211     #[inline]
2212     pub fn is_field_list_non_exhaustive(&self) -> bool {
2213         self.flags.intersects(VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE)
2214     }
2215
2216     /// `repr(transparent)` structs can have a single non-ZST field, this function returns that
2217     /// field.
2218     pub fn transparent_newtype_field(&self, tcx: TyCtxt<'tcx>) -> Option<&FieldDef> {
2219         for field in &self.fields {
2220             let field_ty = field.ty(tcx, InternalSubsts::identity_for_item(tcx, self.def_id));
2221             if !field_ty.is_zst(tcx, self.def_id) {
2222                 return Some(field);
2223             }
2224         }
2225
2226         None
2227     }
2228 }
2229
2230 #[derive(Copy, Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable, HashStable)]
2231 pub enum VariantDiscr {
2232     /// Explicit value for this variant, i.e., `X = 123`.
2233     /// The `DefId` corresponds to the embedded constant.
2234     Explicit(DefId),
2235
2236     /// The previous variant's discriminant plus one.
2237     /// For efficiency reasons, the distance from the
2238     /// last `Explicit` discriminant is being stored,
2239     /// or `0` for the first variant, if it has none.
2240     Relative(u32),
2241 }
2242
2243 #[derive(Debug, HashStable)]
2244 pub struct FieldDef {
2245     pub did: DefId,
2246     #[stable_hasher(project(name))]
2247     pub ident: Ident,
2248     pub vis: Visibility,
2249 }
2250
2251 /// The definition of a user-defined type, e.g., a `struct`, `enum`, or `union`.
2252 ///
2253 /// These are all interned (by `alloc_adt_def`) into the global arena.
2254 ///
2255 /// The initialism *ADT* stands for an [*algebraic data type (ADT)*][adt].
2256 /// This is slightly wrong because `union`s are not ADTs.
2257 /// Moreover, Rust only allows recursive data types through indirection.
2258 ///
2259 /// [adt]: https://en.wikipedia.org/wiki/Algebraic_data_type
2260 pub struct AdtDef {
2261     /// The `DefId` of the struct, enum or union item.
2262     pub did: DefId,
2263     /// Variants of the ADT. If this is a struct or union, then there will be a single variant.
2264     pub variants: IndexVec<VariantIdx, VariantDef>,
2265     /// Flags of the ADT (e.g., is this a struct? is this non-exhaustive?).
2266     flags: AdtFlags,
2267     /// Repr options provided by the user.
2268     pub repr: ReprOptions,
2269 }
2270
2271 impl PartialOrd for AdtDef {
2272     fn partial_cmp(&self, other: &AdtDef) -> Option<Ordering> {
2273         Some(self.cmp(&other))
2274     }
2275 }
2276
2277 /// There should be only one AdtDef for each `did`, therefore
2278 /// it is fine to implement `Ord` only based on `did`.
2279 impl Ord for AdtDef {
2280     fn cmp(&self, other: &AdtDef) -> Ordering {
2281         self.did.cmp(&other.did)
2282     }
2283 }
2284
2285 impl PartialEq for AdtDef {
2286     // `AdtDef`s are always interned, and this is part of `TyS` equality.
2287     #[inline]
2288     fn eq(&self, other: &Self) -> bool {
2289         ptr::eq(self, other)
2290     }
2291 }
2292
2293 impl Eq for AdtDef {}
2294
2295 impl Hash for AdtDef {
2296     #[inline]
2297     fn hash<H: Hasher>(&self, s: &mut H) {
2298         (self as *const AdtDef).hash(s)
2299     }
2300 }
2301
2302 impl<'tcx> rustc_serialize::UseSpecializedEncodable for &'tcx AdtDef {
2303     fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
2304         self.did.encode(s)
2305     }
2306 }
2307
2308 impl<'tcx> rustc_serialize::UseSpecializedDecodable for &'tcx AdtDef {}
2309
2310 impl<'a> HashStable<StableHashingContext<'a>> for AdtDef {
2311     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
2312         thread_local! {
2313             static CACHE: RefCell<FxHashMap<usize, Fingerprint>> = Default::default();
2314         }
2315
2316         let hash: Fingerprint = CACHE.with(|cache| {
2317             let addr = self as *const AdtDef as usize;
2318             *cache.borrow_mut().entry(addr).or_insert_with(|| {
2319                 let ty::AdtDef { did, ref variants, ref flags, ref repr } = *self;
2320
2321                 let mut hasher = StableHasher::new();
2322                 did.hash_stable(hcx, &mut hasher);
2323                 variants.hash_stable(hcx, &mut hasher);
2324                 flags.hash_stable(hcx, &mut hasher);
2325                 repr.hash_stable(hcx, &mut hasher);
2326
2327                 hasher.finish()
2328             })
2329         });
2330
2331         hash.hash_stable(hcx, hasher);
2332     }
2333 }
2334
2335 #[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
2336 pub enum AdtKind {
2337     Struct,
2338     Union,
2339     Enum,
2340 }
2341
2342 impl Into<DataTypeKind> for AdtKind {
2343     fn into(self) -> DataTypeKind {
2344         match self {
2345             AdtKind::Struct => DataTypeKind::Struct,
2346             AdtKind::Union => DataTypeKind::Union,
2347             AdtKind::Enum => DataTypeKind::Enum,
2348         }
2349     }
2350 }
2351
2352 bitflags! {
2353     #[derive(RustcEncodable, RustcDecodable, Default, HashStable)]
2354     pub struct ReprFlags: u8 {
2355         const IS_C               = 1 << 0;
2356         const IS_SIMD            = 1 << 1;
2357         const IS_TRANSPARENT     = 1 << 2;
2358         // Internal only for now. If true, don't reorder fields.
2359         const IS_LINEAR          = 1 << 3;
2360         // If true, don't expose any niche to type's context.
2361         const HIDE_NICHE         = 1 << 4;
2362         // Any of these flags being set prevent field reordering optimisation.
2363         const IS_UNOPTIMISABLE   = ReprFlags::IS_C.bits |
2364                                    ReprFlags::IS_SIMD.bits |
2365                                    ReprFlags::IS_LINEAR.bits;
2366     }
2367 }
2368
2369 /// Represents the repr options provided by the user,
2370 #[derive(Copy, Clone, Debug, Eq, PartialEq, RustcEncodable, RustcDecodable, Default, HashStable)]
2371 pub struct ReprOptions {
2372     pub int: Option<attr::IntType>,
2373     pub align: Option<Align>,
2374     pub pack: Option<Align>,
2375     pub flags: ReprFlags,
2376 }
2377
2378 impl ReprOptions {
2379     pub fn new(tcx: TyCtxt<'_>, did: DefId) -> ReprOptions {
2380         let mut flags = ReprFlags::empty();
2381         let mut size = None;
2382         let mut max_align: Option<Align> = None;
2383         let mut min_pack: Option<Align> = None;
2384         for attr in tcx.get_attrs(did).iter() {
2385             for r in attr::find_repr_attrs(&tcx.sess.parse_sess, attr) {
2386                 flags.insert(match r {
2387                     attr::ReprC => ReprFlags::IS_C,
2388                     attr::ReprPacked(pack) => {
2389                         let pack = Align::from_bytes(pack as u64).unwrap();
2390                         min_pack = Some(if let Some(min_pack) = min_pack {
2391                             min_pack.min(pack)
2392                         } else {
2393                             pack
2394                         });
2395                         ReprFlags::empty()
2396                     }
2397                     attr::ReprTransparent => ReprFlags::IS_TRANSPARENT,
2398                     attr::ReprNoNiche => ReprFlags::HIDE_NICHE,
2399                     attr::ReprSimd => ReprFlags::IS_SIMD,
2400                     attr::ReprInt(i) => {
2401                         size = Some(i);
2402                         ReprFlags::empty()
2403                     }
2404                     attr::ReprAlign(align) => {
2405                         max_align = max_align.max(Some(Align::from_bytes(align as u64).unwrap()));
2406                         ReprFlags::empty()
2407                     }
2408                 });
2409             }
2410         }
2411
2412         // This is here instead of layout because the choice must make it into metadata.
2413         if !tcx.consider_optimizing(|| format!("Reorder fields of {:?}", tcx.def_path_str(did))) {
2414             flags.insert(ReprFlags::IS_LINEAR);
2415         }
2416         ReprOptions { int: size, align: max_align, pack: min_pack, flags }
2417     }
2418
2419     #[inline]
2420     pub fn simd(&self) -> bool {
2421         self.flags.contains(ReprFlags::IS_SIMD)
2422     }
2423     #[inline]
2424     pub fn c(&self) -> bool {
2425         self.flags.contains(ReprFlags::IS_C)
2426     }
2427     #[inline]
2428     pub fn packed(&self) -> bool {
2429         self.pack.is_some()
2430     }
2431     #[inline]
2432     pub fn transparent(&self) -> bool {
2433         self.flags.contains(ReprFlags::IS_TRANSPARENT)
2434     }
2435     #[inline]
2436     pub fn linear(&self) -> bool {
2437         self.flags.contains(ReprFlags::IS_LINEAR)
2438     }
2439     #[inline]
2440     pub fn hide_niche(&self) -> bool {
2441         self.flags.contains(ReprFlags::HIDE_NICHE)
2442     }
2443
2444     /// Returns the discriminant type, given these `repr` options.
2445     /// This must only be called on enums!
2446     pub fn discr_type(&self) -> attr::IntType {
2447         self.int.unwrap_or(attr::SignedInt(ast::IntTy::Isize))
2448     }
2449
2450     /// Returns `true` if this `#[repr()]` should inhabit "smart enum
2451     /// layout" optimizations, such as representing `Foo<&T>` as a
2452     /// single pointer.
2453     pub fn inhibit_enum_layout_opt(&self) -> bool {
2454         self.c() || self.int.is_some()
2455     }
2456
2457     /// Returns `true` if this `#[repr()]` should inhibit struct field reordering
2458     /// optimizations, such as with `repr(C)`, `repr(packed(1))`, or `repr(<int>)`.
2459     pub fn inhibit_struct_field_reordering_opt(&self) -> bool {
2460         if let Some(pack) = self.pack {
2461             if pack.bytes() == 1 {
2462                 return true;
2463             }
2464         }
2465         self.flags.intersects(ReprFlags::IS_UNOPTIMISABLE) || self.int.is_some()
2466     }
2467
2468     /// Returns `true` if this `#[repr()]` should inhibit union ABI optimisations.
2469     pub fn inhibit_union_abi_opt(&self) -> bool {
2470         self.c()
2471     }
2472 }
2473
2474 impl<'tcx> AdtDef {
2475     /// Creates a new `AdtDef`.
2476     fn new(
2477         tcx: TyCtxt<'_>,
2478         did: DefId,
2479         kind: AdtKind,
2480         variants: IndexVec<VariantIdx, VariantDef>,
2481         repr: ReprOptions,
2482     ) -> Self {
2483         debug!("AdtDef::new({:?}, {:?}, {:?}, {:?})", did, kind, variants, repr);
2484         let mut flags = AdtFlags::NO_ADT_FLAGS;
2485
2486         if kind == AdtKind::Enum && tcx.has_attr(did, sym::non_exhaustive) {
2487             debug!("found non-exhaustive variant list for {:?}", did);
2488             flags = flags | AdtFlags::IS_VARIANT_LIST_NON_EXHAUSTIVE;
2489         }
2490
2491         flags |= match kind {
2492             AdtKind::Enum => AdtFlags::IS_ENUM,
2493             AdtKind::Union => AdtFlags::IS_UNION,
2494             AdtKind::Struct => AdtFlags::IS_STRUCT,
2495         };
2496
2497         if kind == AdtKind::Struct && variants[VariantIdx::new(0)].ctor_def_id.is_some() {
2498             flags |= AdtFlags::HAS_CTOR;
2499         }
2500
2501         let attrs = tcx.get_attrs(did);
2502         if attr::contains_name(&attrs, sym::fundamental) {
2503             flags |= AdtFlags::IS_FUNDAMENTAL;
2504         }
2505         if Some(did) == tcx.lang_items().phantom_data() {
2506             flags |= AdtFlags::IS_PHANTOM_DATA;
2507         }
2508         if Some(did) == tcx.lang_items().owned_box() {
2509             flags |= AdtFlags::IS_BOX;
2510         }
2511         if Some(did) == tcx.lang_items().manually_drop() {
2512             flags |= AdtFlags::IS_MANUALLY_DROP;
2513         }
2514
2515         AdtDef { did, variants, flags, repr }
2516     }
2517
2518     /// Returns `true` if this is a struct.
2519     #[inline]
2520     pub fn is_struct(&self) -> bool {
2521         self.flags.contains(AdtFlags::IS_STRUCT)
2522     }
2523
2524     /// Returns `true` if this is a union.
2525     #[inline]
2526     pub fn is_union(&self) -> bool {
2527         self.flags.contains(AdtFlags::IS_UNION)
2528     }
2529
2530     /// Returns `true` if this is a enum.
2531     #[inline]
2532     pub fn is_enum(&self) -> bool {
2533         self.flags.contains(AdtFlags::IS_ENUM)
2534     }
2535
2536     /// Returns `true` if the variant list of this ADT is `#[non_exhaustive]`.
2537     #[inline]
2538     pub fn is_variant_list_non_exhaustive(&self) -> bool {
2539         self.flags.contains(AdtFlags::IS_VARIANT_LIST_NON_EXHAUSTIVE)
2540     }
2541
2542     /// Returns the kind of the ADT.
2543     #[inline]
2544     pub fn adt_kind(&self) -> AdtKind {
2545         if self.is_enum() {
2546             AdtKind::Enum
2547         } else if self.is_union() {
2548             AdtKind::Union
2549         } else {
2550             AdtKind::Struct
2551         }
2552     }
2553
2554     /// Returns a description of this abstract data type.
2555     pub fn descr(&self) -> &'static str {
2556         match self.adt_kind() {
2557             AdtKind::Struct => "struct",
2558             AdtKind::Union => "union",
2559             AdtKind::Enum => "enum",
2560         }
2561     }
2562
2563     /// Returns a description of a variant of this abstract data type.
2564     #[inline]
2565     pub fn variant_descr(&self) -> &'static str {
2566         match self.adt_kind() {
2567             AdtKind::Struct => "struct",
2568             AdtKind::Union => "union",
2569             AdtKind::Enum => "variant",
2570         }
2571     }
2572
2573     /// If this function returns `true`, it implies that `is_struct` must return `true`.
2574     #[inline]
2575     pub fn has_ctor(&self) -> bool {
2576         self.flags.contains(AdtFlags::HAS_CTOR)
2577     }
2578
2579     /// Returns `true` if this type is `#[fundamental]` for the purposes
2580     /// of coherence checking.
2581     #[inline]
2582     pub fn is_fundamental(&self) -> bool {
2583         self.flags.contains(AdtFlags::IS_FUNDAMENTAL)
2584     }
2585
2586     /// Returns `true` if this is `PhantomData<T>`.
2587     #[inline]
2588     pub fn is_phantom_data(&self) -> bool {
2589         self.flags.contains(AdtFlags::IS_PHANTOM_DATA)
2590     }
2591
2592     /// Returns `true` if this is Box<T>.
2593     #[inline]
2594     pub fn is_box(&self) -> bool {
2595         self.flags.contains(AdtFlags::IS_BOX)
2596     }
2597
2598     /// Returns `true` if this is `ManuallyDrop<T>`.
2599     #[inline]
2600     pub fn is_manually_drop(&self) -> bool {
2601         self.flags.contains(AdtFlags::IS_MANUALLY_DROP)
2602     }
2603
2604     /// Returns `true` if this type has a destructor.
2605     pub fn has_dtor(&self, tcx: TyCtxt<'tcx>) -> bool {
2606         self.destructor(tcx).is_some()
2607     }
2608
2609     /// Asserts this is a struct or union and returns its unique variant.
2610     pub fn non_enum_variant(&self) -> &VariantDef {
2611         assert!(self.is_struct() || self.is_union());
2612         &self.variants[VariantIdx::new(0)]
2613     }
2614
2615     #[inline]
2616     pub fn predicates(&self, tcx: TyCtxt<'tcx>) -> GenericPredicates<'tcx> {
2617         tcx.predicates_of(self.did)
2618     }
2619
2620     /// Returns an iterator over all fields contained
2621     /// by this ADT.
2622     #[inline]
2623     pub fn all_fields(&self) -> impl Iterator<Item = &FieldDef> + Clone {
2624         self.variants.iter().flat_map(|v| v.fields.iter())
2625     }
2626
2627     pub fn is_payloadfree(&self) -> bool {
2628         !self.variants.is_empty() && self.variants.iter().all(|v| v.fields.is_empty())
2629     }
2630
2631     /// Return a `VariantDef` given a variant id.
2632     pub fn variant_with_id(&self, vid: DefId) -> &VariantDef {
2633         self.variants.iter().find(|v| v.def_id == vid).expect("variant_with_id: unknown variant")
2634     }
2635
2636     /// Return a `VariantDef` given a constructor id.
2637     pub fn variant_with_ctor_id(&self, cid: DefId) -> &VariantDef {
2638         self.variants
2639             .iter()
2640             .find(|v| v.ctor_def_id == Some(cid))
2641             .expect("variant_with_ctor_id: unknown variant")
2642     }
2643
2644     /// Return the index of `VariantDef` given a variant id.
2645     pub fn variant_index_with_id(&self, vid: DefId) -> VariantIdx {
2646         self.variants
2647             .iter_enumerated()
2648             .find(|(_, v)| v.def_id == vid)
2649             .expect("variant_index_with_id: unknown variant")
2650             .0
2651     }
2652
2653     /// Return the index of `VariantDef` given a constructor id.
2654     pub fn variant_index_with_ctor_id(&self, cid: DefId) -> VariantIdx {
2655         self.variants
2656             .iter_enumerated()
2657             .find(|(_, v)| v.ctor_def_id == Some(cid))
2658             .expect("variant_index_with_ctor_id: unknown variant")
2659             .0
2660     }
2661
2662     pub fn variant_of_res(&self, res: Res) -> &VariantDef {
2663         match res {
2664             Res::Def(DefKind::Variant, vid) => self.variant_with_id(vid),
2665             Res::Def(DefKind::Ctor(..), cid) => self.variant_with_ctor_id(cid),
2666             Res::Def(DefKind::Struct, _)
2667             | Res::Def(DefKind::Union, _)
2668             | Res::Def(DefKind::TyAlias, _)
2669             | Res::Def(DefKind::AssocTy, _)
2670             | Res::SelfTy(..)
2671             | Res::SelfCtor(..) => self.non_enum_variant(),
2672             _ => bug!("unexpected res {:?} in variant_of_res", res),
2673         }
2674     }
2675
2676     #[inline]
2677     pub fn eval_explicit_discr(&self, tcx: TyCtxt<'tcx>, expr_did: DefId) -> Option<Discr<'tcx>> {
2678         assert!(self.is_enum());
2679         let param_env = tcx.param_env(expr_did);
2680         let repr_type = self.repr.discr_type();
2681         match tcx.const_eval_poly(expr_did) {
2682             Ok(val) => {
2683                 let ty = repr_type.to_ty(tcx);
2684                 if let Some(b) = val.try_to_bits_for_ty(tcx, param_env, ty) {
2685                     trace!("discriminants: {} ({:?})", b, repr_type);
2686                     Some(Discr { val: b, ty })
2687                 } else {
2688                     info!("invalid enum discriminant: {:#?}", val);
2689                     crate::mir::interpret::struct_error(
2690                         tcx.at(tcx.def_span(expr_did)),
2691                         "constant evaluation of enum discriminant resulted in non-integer",
2692                     )
2693                     .emit();
2694                     None
2695                 }
2696             }
2697             Err(err) => {
2698                 let msg = match err {
2699                     ErrorHandled::Reported(ErrorReported) | ErrorHandled::Linted => {
2700                         "enum discriminant evaluation failed"
2701                     }
2702                     ErrorHandled::TooGeneric => "enum discriminant depends on generics",
2703                 };
2704                 tcx.sess.delay_span_bug(tcx.def_span(expr_did), msg);
2705                 None
2706             }
2707         }
2708     }
2709
2710     #[inline]
2711     pub fn discriminants(
2712         &'tcx self,
2713         tcx: TyCtxt<'tcx>,
2714     ) -> impl Iterator<Item = (VariantIdx, Discr<'tcx>)> + Captures<'tcx> {
2715         assert!(self.is_enum());
2716         let repr_type = self.repr.discr_type();
2717         let initial = repr_type.initial_discriminant(tcx);
2718         let mut prev_discr = None::<Discr<'tcx>>;
2719         self.variants.iter_enumerated().map(move |(i, v)| {
2720             let mut discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
2721             if let VariantDiscr::Explicit(expr_did) = v.discr {
2722                 if let Some(new_discr) = self.eval_explicit_discr(tcx, expr_did) {
2723                     discr = new_discr;
2724                 }
2725             }
2726             prev_discr = Some(discr);
2727
2728             (i, discr)
2729         })
2730     }
2731
2732     #[inline]
2733     pub fn variant_range(&self) -> Range<VariantIdx> {
2734         VariantIdx::new(0)..VariantIdx::new(self.variants.len())
2735     }
2736
2737     /// Computes the discriminant value used by a specific variant.
2738     /// Unlike `discriminants`, this is (amortized) constant-time,
2739     /// only doing at most one query for evaluating an explicit
2740     /// discriminant (the last one before the requested variant),
2741     /// assuming there are no constant-evaluation errors there.
2742     #[inline]
2743     pub fn discriminant_for_variant(
2744         &self,
2745         tcx: TyCtxt<'tcx>,
2746         variant_index: VariantIdx,
2747     ) -> Discr<'tcx> {
2748         assert!(self.is_enum());
2749         let (val, offset) = self.discriminant_def_for_variant(variant_index);
2750         let explicit_value = val
2751             .and_then(|expr_did| self.eval_explicit_discr(tcx, expr_did))
2752             .unwrap_or_else(|| self.repr.discr_type().initial_discriminant(tcx));
2753         explicit_value.checked_add(tcx, offset as u128).0
2754     }
2755
2756     /// Yields a `DefId` for the discriminant and an offset to add to it
2757     /// Alternatively, if there is no explicit discriminant, returns the
2758     /// inferred discriminant directly.
2759     pub fn discriminant_def_for_variant(&self, variant_index: VariantIdx) -> (Option<DefId>, u32) {
2760         assert!(!self.variants.is_empty());
2761         let mut explicit_index = variant_index.as_u32();
2762         let expr_did;
2763         loop {
2764             match self.variants[VariantIdx::from_u32(explicit_index)].discr {
2765                 ty::VariantDiscr::Relative(0) => {
2766                     expr_did = None;
2767                     break;
2768                 }
2769                 ty::VariantDiscr::Relative(distance) => {
2770                     explicit_index -= distance;
2771                 }
2772                 ty::VariantDiscr::Explicit(did) => {
2773                     expr_did = Some(did);
2774                     break;
2775                 }
2776             }
2777         }
2778         (expr_did, variant_index.as_u32() - explicit_index)
2779     }
2780
2781     pub fn destructor(&self, tcx: TyCtxt<'tcx>) -> Option<Destructor> {
2782         tcx.adt_destructor(self.did)
2783     }
2784
2785     /// Returns a list of types such that `Self: Sized` if and only
2786     /// if that type is `Sized`, or `TyErr` if this type is recursive.
2787     ///
2788     /// Oddly enough, checking that the sized-constraint is `Sized` is
2789     /// actually more expressive than checking all members:
2790     /// the `Sized` trait is inductive, so an associated type that references
2791     /// `Self` would prevent its containing ADT from being `Sized`.
2792     ///
2793     /// Due to normalization being eager, this applies even if
2794     /// the associated type is behind a pointer (e.g., issue #31299).
2795     pub fn sized_constraint(&self, tcx: TyCtxt<'tcx>) -> &'tcx [Ty<'tcx>] {
2796         tcx.adt_sized_constraint(self.did).0
2797     }
2798 }
2799
2800 impl<'tcx> FieldDef {
2801     /// Returns the type of this field. The `subst` is typically obtained
2802     /// via the second field of `TyKind::AdtDef`.
2803     pub fn ty(&self, tcx: TyCtxt<'tcx>, subst: SubstsRef<'tcx>) -> Ty<'tcx> {
2804         tcx.type_of(self.did).subst(tcx, subst)
2805     }
2806 }
2807
2808 /// Represents the various closure traits in the language. This
2809 /// will determine the type of the environment (`self`, in the
2810 /// desugaring) argument that the closure expects.
2811 ///
2812 /// You can get the environment type of a closure using
2813 /// `tcx.closure_env_ty()`.
2814 #[derive(Clone, Copy, PartialOrd, Ord, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
2815 #[derive(HashStable)]
2816 pub enum ClosureKind {
2817     // Warning: Ordering is significant here! The ordering is chosen
2818     // because the trait Fn is a subtrait of FnMut and so in turn, and
2819     // hence we order it so that Fn < FnMut < FnOnce.
2820     Fn,
2821     FnMut,
2822     FnOnce,
2823 }
2824
2825 impl<'tcx> ClosureKind {
2826     // This is the initial value used when doing upvar inference.
2827     pub const LATTICE_BOTTOM: ClosureKind = ClosureKind::Fn;
2828
2829     pub fn trait_did(&self, tcx: TyCtxt<'tcx>) -> DefId {
2830         match *self {
2831             ClosureKind::Fn => tcx.require_lang_item(FnTraitLangItem, None),
2832             ClosureKind::FnMut => tcx.require_lang_item(FnMutTraitLangItem, None),
2833             ClosureKind::FnOnce => tcx.require_lang_item(FnOnceTraitLangItem, None),
2834         }
2835     }
2836
2837     /// Returns `true` if this a type that impls this closure kind
2838     /// must also implement `other`.
2839     pub fn extends(self, other: ty::ClosureKind) -> bool {
2840         match (self, other) {
2841             (ClosureKind::Fn, ClosureKind::Fn) => true,
2842             (ClosureKind::Fn, ClosureKind::FnMut) => true,
2843             (ClosureKind::Fn, ClosureKind::FnOnce) => true,
2844             (ClosureKind::FnMut, ClosureKind::FnMut) => true,
2845             (ClosureKind::FnMut, ClosureKind::FnOnce) => true,
2846             (ClosureKind::FnOnce, ClosureKind::FnOnce) => true,
2847             _ => false,
2848         }
2849     }
2850
2851     /// Returns the representative scalar type for this closure kind.
2852     /// See `TyS::to_opt_closure_kind` for more details.
2853     pub fn to_ty(self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
2854         match self {
2855             ty::ClosureKind::Fn => tcx.types.i8,
2856             ty::ClosureKind::FnMut => tcx.types.i16,
2857             ty::ClosureKind::FnOnce => tcx.types.i32,
2858         }
2859     }
2860 }
2861
2862 impl BorrowKind {
2863     pub fn from_mutbl(m: hir::Mutability) -> BorrowKind {
2864         match m {
2865             hir::Mutability::Mut => MutBorrow,
2866             hir::Mutability::Not => ImmBorrow,
2867         }
2868     }
2869
2870     /// Returns a mutability `m` such that an `&m T` pointer could be used to obtain this borrow
2871     /// kind. Because borrow kinds are richer than mutabilities, we sometimes have to pick a
2872     /// mutability that is stronger than necessary so that it at least *would permit* the borrow in
2873     /// question.
2874     pub fn to_mutbl_lossy(self) -> hir::Mutability {
2875         match self {
2876             MutBorrow => hir::Mutability::Mut,
2877             ImmBorrow => hir::Mutability::Not,
2878
2879             // We have no type corresponding to a unique imm borrow, so
2880             // use `&mut`. It gives all the capabilities of an `&uniq`
2881             // and hence is a safe "over approximation".
2882             UniqueImmBorrow => hir::Mutability::Mut,
2883         }
2884     }
2885
2886     pub fn to_user_str(&self) -> &'static str {
2887         match *self {
2888             MutBorrow => "mutable",
2889             ImmBorrow => "immutable",
2890             UniqueImmBorrow => "uniquely immutable",
2891         }
2892     }
2893 }
2894
2895 pub type Attributes<'tcx> = &'tcx [ast::Attribute];
2896
2897 #[derive(Debug, PartialEq, Eq)]
2898 pub enum ImplOverlapKind {
2899     /// These impls are always allowed to overlap.
2900     Permitted {
2901         /// Whether or not the impl is permitted due to the trait being a `#[marker]` trait
2902         marker: bool,
2903     },
2904     /// These impls are allowed to overlap, but that raises
2905     /// an issue #33140 future-compatibility warning.
2906     ///
2907     /// Some background: in Rust 1.0, the trait-object types `Send + Sync` (today's
2908     /// `dyn Send + Sync`) and `Sync + Send` (now `dyn Sync + Send`) were different.
2909     ///
2910     /// The widely-used version 0.1.0 of the crate `traitobject` had accidentally relied
2911     /// that difference, making what reduces to the following set of impls:
2912     ///
2913     /// ```
2914     /// trait Trait {}
2915     /// impl Trait for dyn Send + Sync {}
2916     /// impl Trait for dyn Sync + Send {}
2917     /// ```
2918     ///
2919     /// Obviously, once we made these types be identical, that code causes a coherence
2920     /// error and a fairly big headache for us. However, luckily for us, the trait
2921     /// `Trait` used in this case is basically a marker trait, and therefore having
2922     /// overlapping impls for it is sound.
2923     ///
2924     /// To handle this, we basically regard the trait as a marker trait, with an additional
2925     /// future-compatibility warning. To avoid accidentally "stabilizing" this feature,
2926     /// it has the following restrictions:
2927     ///
2928     /// 1. The trait must indeed be a marker-like trait (i.e., no items), and must be
2929     /// positive impls.
2930     /// 2. The trait-ref of both impls must be equal.
2931     /// 3. The trait-ref of both impls must be a trait object type consisting only of
2932     /// marker traits.
2933     /// 4. Neither of the impls can have any where-clauses.
2934     ///
2935     /// Once `traitobject` 0.1.0 is no longer an active concern, this hack can be removed.
2936     Issue33140,
2937 }
2938
2939 impl<'tcx> TyCtxt<'tcx> {
2940     pub fn typeck_body(self, body: hir::BodyId) -> &'tcx TypeckResults<'tcx> {
2941         self.typeck(self.hir().body_owner_def_id(body))
2942     }
2943
2944     /// Returns an iterator of the `DefId`s for all body-owners in this
2945     /// crate. If you would prefer to iterate over the bodies
2946     /// themselves, you can do `self.hir().krate().body_ids.iter()`.
2947     pub fn body_owners(self) -> impl Iterator<Item = LocalDefId> + Captures<'tcx> + 'tcx {
2948         self.hir()
2949             .krate()
2950             .body_ids
2951             .iter()
2952             .map(move |&body_id| self.hir().body_owner_def_id(body_id))
2953     }
2954
2955     pub fn par_body_owners<F: Fn(LocalDefId) + sync::Sync + sync::Send>(self, f: F) {
2956         par_iter(&self.hir().krate().body_ids)
2957             .for_each(|&body_id| f(self.hir().body_owner_def_id(body_id)));
2958     }
2959
2960     pub fn provided_trait_methods(self, id: DefId) -> impl 'tcx + Iterator<Item = &'tcx AssocItem> {
2961         self.associated_items(id)
2962             .in_definition_order()
2963             .filter(|item| item.kind == AssocKind::Fn && item.defaultness.has_value())
2964     }
2965
2966     pub fn opt_item_name(self, def_id: DefId) -> Option<Ident> {
2967         def_id
2968             .as_local()
2969             .and_then(|def_id| self.hir().get(self.hir().as_local_hir_id(def_id)).ident())
2970     }
2971
2972     pub fn opt_associated_item(self, def_id: DefId) -> Option<&'tcx AssocItem> {
2973         let is_associated_item = if let Some(def_id) = def_id.as_local() {
2974             match self.hir().get(self.hir().as_local_hir_id(def_id)) {
2975                 Node::TraitItem(_) | Node::ImplItem(_) => true,
2976                 _ => false,
2977             }
2978         } else {
2979             match self.def_kind(def_id) {
2980                 DefKind::AssocConst | DefKind::AssocFn | DefKind::AssocTy => true,
2981                 _ => false,
2982             }
2983         };
2984
2985         is_associated_item.then(|| self.associated_item(def_id))
2986     }
2987
2988     pub fn field_index(self, hir_id: hir::HirId, typeck_results: &TypeckResults<'_>) -> usize {
2989         typeck_results.field_indices().get(hir_id).cloned().expect("no index for a field")
2990     }
2991
2992     pub fn find_field_index(self, ident: Ident, variant: &VariantDef) -> Option<usize> {
2993         variant.fields.iter().position(|field| self.hygienic_eq(ident, field.ident, variant.def_id))
2994     }
2995
2996     /// Returns `true` if the impls are the same polarity and the trait either
2997     /// has no items or is annotated `#[marker]` and prevents item overrides.
2998     pub fn impls_are_allowed_to_overlap(
2999         self,
3000         def_id1: DefId,
3001         def_id2: DefId,
3002     ) -> Option<ImplOverlapKind> {
3003         // If either trait impl references an error, they're allowed to overlap,
3004         // as one of them essentially doesn't exist.
3005         if self.impl_trait_ref(def_id1).map_or(false, |tr| tr.references_error())
3006             || self.impl_trait_ref(def_id2).map_or(false, |tr| tr.references_error())
3007         {
3008             return Some(ImplOverlapKind::Permitted { marker: false });
3009         }
3010
3011         match (self.impl_polarity(def_id1), self.impl_polarity(def_id2)) {
3012             (ImplPolarity::Reservation, _) | (_, ImplPolarity::Reservation) => {
3013                 // `#[rustc_reservation_impl]` impls don't overlap with anything
3014                 debug!(
3015                     "impls_are_allowed_to_overlap({:?}, {:?}) = Some(Permitted) (reservations)",
3016                     def_id1, def_id2
3017                 );
3018                 return Some(ImplOverlapKind::Permitted { marker: false });
3019             }
3020             (ImplPolarity::Positive, ImplPolarity::Negative)
3021             | (ImplPolarity::Negative, ImplPolarity::Positive) => {
3022                 // `impl AutoTrait for Type` + `impl !AutoTrait for Type`
3023                 debug!(
3024                     "impls_are_allowed_to_overlap({:?}, {:?}) - None (differing polarities)",
3025                     def_id1, def_id2
3026                 );
3027                 return None;
3028             }
3029             (ImplPolarity::Positive, ImplPolarity::Positive)
3030             | (ImplPolarity::Negative, ImplPolarity::Negative) => {}
3031         };
3032
3033         let is_marker_overlap = {
3034             let is_marker_impl = |def_id: DefId| -> bool {
3035                 let trait_ref = self.impl_trait_ref(def_id);
3036                 trait_ref.map_or(false, |tr| self.trait_def(tr.def_id).is_marker)
3037             };
3038             is_marker_impl(def_id1) && is_marker_impl(def_id2)
3039         };
3040
3041         if is_marker_overlap {
3042             debug!(
3043                 "impls_are_allowed_to_overlap({:?}, {:?}) = Some(Permitted) (marker overlap)",
3044                 def_id1, def_id2
3045             );
3046             Some(ImplOverlapKind::Permitted { marker: true })
3047         } else {
3048             if let Some(self_ty1) = self.issue33140_self_ty(def_id1) {
3049                 if let Some(self_ty2) = self.issue33140_self_ty(def_id2) {
3050                     if self_ty1 == self_ty2 {
3051                         debug!(
3052                             "impls_are_allowed_to_overlap({:?}, {:?}) - issue #33140 HACK",
3053                             def_id1, def_id2
3054                         );
3055                         return Some(ImplOverlapKind::Issue33140);
3056                     } else {
3057                         debug!(
3058                             "impls_are_allowed_to_overlap({:?}, {:?}) - found {:?} != {:?}",
3059                             def_id1, def_id2, self_ty1, self_ty2
3060                         );
3061                     }
3062                 }
3063             }
3064
3065             debug!("impls_are_allowed_to_overlap({:?}, {:?}) = None", def_id1, def_id2);
3066             None
3067         }
3068     }
3069
3070     /// Returns `ty::VariantDef` if `res` refers to a struct,
3071     /// or variant or their constructors, panics otherwise.
3072     pub fn expect_variant_res(self, res: Res) -> &'tcx VariantDef {
3073         match res {
3074             Res::Def(DefKind::Variant, did) => {
3075                 let enum_did = self.parent(did).unwrap();
3076                 self.adt_def(enum_did).variant_with_id(did)
3077             }
3078             Res::Def(DefKind::Struct | DefKind::Union, did) => self.adt_def(did).non_enum_variant(),
3079             Res::Def(DefKind::Ctor(CtorOf::Variant, ..), variant_ctor_did) => {
3080                 let variant_did = self.parent(variant_ctor_did).unwrap();
3081                 let enum_did = self.parent(variant_did).unwrap();
3082                 self.adt_def(enum_did).variant_with_ctor_id(variant_ctor_did)
3083             }
3084             Res::Def(DefKind::Ctor(CtorOf::Struct, ..), ctor_did) => {
3085                 let struct_did = self.parent(ctor_did).expect("struct ctor has no parent");
3086                 self.adt_def(struct_did).non_enum_variant()
3087             }
3088             _ => bug!("expect_variant_res used with unexpected res {:?}", res),
3089         }
3090     }
3091
3092     pub fn item_name(self, id: DefId) -> Symbol {
3093         if id.index == CRATE_DEF_INDEX {
3094             self.original_crate_name(id.krate)
3095         } else {
3096             let def_key = self.def_key(id);
3097             match def_key.disambiguated_data.data {
3098                 // The name of a constructor is that of its parent.
3099                 rustc_hir::definitions::DefPathData::Ctor => {
3100                     self.item_name(DefId { krate: id.krate, index: def_key.parent.unwrap() })
3101                 }
3102                 _ => def_key.disambiguated_data.data.get_opt_name().unwrap_or_else(|| {
3103                     bug!("item_name: no name for {:?}", self.def_path(id));
3104                 }),
3105             }
3106         }
3107     }
3108
3109     /// Returns the possibly-auto-generated MIR of a `(DefId, Subst)` pair.
3110     pub fn instance_mir(self, instance: ty::InstanceDef<'tcx>) -> &'tcx Body<'tcx> {
3111         match instance {
3112             ty::InstanceDef::Item(def) => {
3113                 if let Some((did, param_did)) = def.as_const_arg() {
3114                     self.optimized_mir_of_const_arg((did, param_did))
3115                 } else {
3116                     self.optimized_mir(def.did)
3117                 }
3118             }
3119             ty::InstanceDef::VtableShim(..)
3120             | ty::InstanceDef::ReifyShim(..)
3121             | ty::InstanceDef::Intrinsic(..)
3122             | ty::InstanceDef::FnPtrShim(..)
3123             | ty::InstanceDef::Virtual(..)
3124             | ty::InstanceDef::ClosureOnceShim { .. }
3125             | ty::InstanceDef::DropGlue(..)
3126             | ty::InstanceDef::CloneShim(..) => self.mir_shims(instance),
3127         }
3128     }
3129
3130     /// Gets the attributes of a definition.
3131     pub fn get_attrs(self, did: DefId) -> Attributes<'tcx> {
3132         if let Some(did) = did.as_local() {
3133             self.hir().attrs(self.hir().as_local_hir_id(did))
3134         } else {
3135             self.item_attrs(did)
3136         }
3137     }
3138
3139     /// Determines whether an item is annotated with an attribute.
3140     pub fn has_attr(self, did: DefId, attr: Symbol) -> bool {
3141         attr::contains_name(&self.get_attrs(did), attr)
3142     }
3143
3144     /// Returns `true` if this is an `auto trait`.
3145     pub fn trait_is_auto(self, trait_def_id: DefId) -> bool {
3146         self.trait_def(trait_def_id).has_auto_impl
3147     }
3148
3149     pub fn generator_layout(self, def_id: DefId) -> &'tcx GeneratorLayout<'tcx> {
3150         self.optimized_mir(def_id).generator_layout.as_ref().unwrap()
3151     }
3152
3153     /// Given the `DefId` of an impl, returns the `DefId` of the trait it implements.
3154     /// If it implements no trait, returns `None`.
3155     pub fn trait_id_of_impl(self, def_id: DefId) -> Option<DefId> {
3156         self.impl_trait_ref(def_id).map(|tr| tr.def_id)
3157     }
3158
3159     /// If the given defid describes a method belonging to an impl, returns the
3160     /// `DefId` of the impl that the method belongs to; otherwise, returns `None`.
3161     pub fn impl_of_method(self, def_id: DefId) -> Option<DefId> {
3162         self.opt_associated_item(def_id).and_then(|trait_item| match trait_item.container {
3163             TraitContainer(_) => None,
3164             ImplContainer(def_id) => Some(def_id),
3165         })
3166     }
3167
3168     /// Looks up the span of `impl_did` if the impl is local; otherwise returns `Err`
3169     /// with the name of the crate containing the impl.
3170     pub fn span_of_impl(self, impl_did: DefId) -> Result<Span, Symbol> {
3171         if let Some(impl_did) = impl_did.as_local() {
3172             let hir_id = self.hir().as_local_hir_id(impl_did);
3173             Ok(self.hir().span(hir_id))
3174         } else {
3175             Err(self.crate_name(impl_did.krate))
3176         }
3177     }
3178
3179     /// Hygienically compares a use-site name (`use_name`) for a field or an associated item with
3180     /// its supposed definition name (`def_name`). The method also needs `DefId` of the supposed
3181     /// definition's parent/scope to perform comparison.
3182     pub fn hygienic_eq(self, use_name: Ident, def_name: Ident, def_parent_def_id: DefId) -> bool {
3183         // We could use `Ident::eq` here, but we deliberately don't. The name
3184         // comparison fails frequently, and we want to avoid the expensive
3185         // `normalize_to_macros_2_0()` calls required for the span comparison whenever possible.
3186         use_name.name == def_name.name
3187             && use_name
3188                 .span
3189                 .ctxt()
3190                 .hygienic_eq(def_name.span.ctxt(), self.expansion_that_defined(def_parent_def_id))
3191     }
3192
3193     fn expansion_that_defined(self, scope: DefId) -> ExpnId {
3194         match scope.as_local() {
3195             Some(scope) => self.hir().definitions().expansion_that_defined(scope),
3196             None => ExpnId::root(),
3197         }
3198     }
3199
3200     pub fn adjust_ident(self, mut ident: Ident, scope: DefId) -> Ident {
3201         ident.span.normalize_to_macros_2_0_and_adjust(self.expansion_that_defined(scope));
3202         ident
3203     }
3204
3205     pub fn adjust_ident_and_get_scope(
3206         self,
3207         mut ident: Ident,
3208         scope: DefId,
3209         block: hir::HirId,
3210     ) -> (Ident, DefId) {
3211         let scope =
3212             match ident.span.normalize_to_macros_2_0_and_adjust(self.expansion_that_defined(scope))
3213             {
3214                 Some(actual_expansion) => {
3215                     self.hir().definitions().parent_module_of_macro_def(actual_expansion)
3216                 }
3217                 None => self.parent_module(block).to_def_id(),
3218             };
3219         (ident, scope)
3220     }
3221
3222     pub fn is_object_safe(self, key: DefId) -> bool {
3223         self.object_safety_violations(key).is_empty()
3224     }
3225 }
3226
3227 #[derive(Clone, HashStable)]
3228 pub struct AdtSizedConstraint<'tcx>(pub &'tcx [Ty<'tcx>]);
3229
3230 /// Yields the parent function's `DefId` if `def_id` is an `impl Trait` definition.
3231 pub fn is_impl_trait_defn(tcx: TyCtxt<'_>, def_id: DefId) -> Option<DefId> {
3232     if let Some(def_id) = def_id.as_local() {
3233         if let Node::Item(item) = tcx.hir().get(tcx.hir().as_local_hir_id(def_id)) {
3234             if let hir::ItemKind::OpaqueTy(ref opaque_ty) = item.kind {
3235                 return opaque_ty.impl_trait_fn;
3236             }
3237         }
3238     }
3239     None
3240 }
3241
3242 pub fn provide(providers: &mut ty::query::Providers) {
3243     context::provide(providers);
3244     erase_regions::provide(providers);
3245     layout::provide(providers);
3246     super::util::bug::provide(providers);
3247     *providers = ty::query::Providers {
3248         trait_impls_of: trait_def::trait_impls_of_provider,
3249         all_local_trait_impls: trait_def::all_local_trait_impls,
3250         ..*providers
3251     };
3252 }
3253
3254 /// A map for the local crate mapping each type to a vector of its
3255 /// inherent impls. This is not meant to be used outside of coherence;
3256 /// rather, you should request the vector for a specific type via
3257 /// `tcx.inherent_impls(def_id)` so as to minimize your dependencies
3258 /// (constructing this map requires touching the entire crate).
3259 #[derive(Clone, Debug, Default, HashStable)]
3260 pub struct CrateInherentImpls {
3261     pub inherent_impls: DefIdMap<Vec<DefId>>,
3262 }
3263
3264 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, HashStable)]
3265 pub struct SymbolName<'tcx> {
3266     /// `&str` gives a consistent ordering, which ensures reproducible builds.
3267     pub name: &'tcx str,
3268 }
3269
3270 impl<'tcx> SymbolName<'tcx> {
3271     pub fn new(tcx: TyCtxt<'tcx>, name: &str) -> SymbolName<'tcx> {
3272         SymbolName {
3273             name: unsafe { str::from_utf8_unchecked(tcx.arena.alloc_slice(name.as_bytes())) },
3274         }
3275     }
3276 }
3277
3278 impl<'tcx> fmt::Display for SymbolName<'tcx> {
3279     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
3280         fmt::Display::fmt(&self.name, fmt)
3281     }
3282 }
3283
3284 impl<'tcx> fmt::Debug for SymbolName<'tcx> {
3285     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
3286         fmt::Display::fmt(&self.name, fmt)
3287     }
3288 }
3289
3290 impl<'tcx> rustc_serialize::UseSpecializedEncodable for SymbolName<'tcx> {
3291     fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
3292         s.emit_str(self.name)
3293     }
3294 }
3295
3296 // The decoding takes place in `decode_symbol_name()`.
3297 impl<'tcx> rustc_serialize::UseSpecializedDecodable for SymbolName<'tcx> {}