compiler/rustc_middle/src/ty/sty.rs

   1 //! This module contains `TyKind` and its major components.
   2
   3 #![allow(rustc::usage_of_ty_tykind)]
   4
   5 use self::InferTy::*;
   6 use self::TyKind::*;
   7
   8 use crate::infer::canonical::Canonical;
   9 use crate::ty::subst::{GenericArg, InternalSubsts, Subst, SubstsRef};
  10 use crate::ty::{
  11     self, AdtDef, DefIdTree, Discr, Ty, TyCtxt, TypeFlags, TypeFoldable, WithConstness,
  12 };
  13 use crate::ty::{DelaySpanBugEmitted, List, ParamEnv, TyS};
  14 use polonius_engine::Atom;
  15 use rustc_ast as ast;
  16 use rustc_data_structures::captures::Captures;
  17 use rustc_hir as hir;
  18 use rustc_hir::def_id::DefId;
  19 use rustc_index::vec::Idx;
  20 use rustc_macros::HashStable;
  21 use rustc_span::symbol::{kw, Ident, Symbol};
  22 use rustc_target::abi::VariantIdx;
  23 use rustc_target::spec::abi;
  24 use std::borrow::Cow;
  25 use std::cmp::Ordering;
  26 use std::marker::PhantomData;
  27 use std::ops::Range;
  28 use ty::util::IntTypeExt;
  29
  30 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
  31 #[derive(HashStable, TypeFoldable, Lift)]
  32 pub struct TypeAndMut<'tcx> {
  33     pub ty: Ty<'tcx>,
  34     pub mutbl: hir::Mutability,
  35 }
  36
  37 #[derive(Clone, PartialEq, PartialOrd, Eq, Ord, Hash, TyEncodable, TyDecodable, Copy)]
  38 #[derive(HashStable)]
  39 /// A "free" region `fr` can be interpreted as "some region
  40 /// at least as big as the scope `fr.scope`".
  41 pub struct FreeRegion {
  42     pub scope: DefId,
  43     pub bound_region: BoundRegion,
  44 }
  45
  46 #[derive(Clone, PartialEq, PartialOrd, Eq, Ord, Hash, TyEncodable, TyDecodable, Copy)]
  47 #[derive(HashStable)]
  48 pub enum BoundRegion {
  49     /// An anonymous region parameter for a given fn (&T)
  50     BrAnon(u32),
  51
  52     /// Named region parameters for functions (a in &'a T)
  53     ///
  54     /// The `DefId` is needed to distinguish free regions in
  55     /// the event of shadowing.
  56     BrNamed(DefId, Symbol),
  57
  58     /// Anonymous region for the implicit env pointer parameter
  59     /// to a closure
  60     BrEnv,
  61 }
  62
  63 impl BoundRegion {
  64     pub fn is_named(&self) -> bool {
  65         match *self {
  66             BoundRegion::BrNamed(_, name) => name != kw::UnderscoreLifetime,
  67             _ => false,
  68         }
  69     }
  70
  71     /// When canonicalizing, we replace unbound inference variables and free
  72     /// regions with anonymous late bound regions. This method asserts that
  73     /// we have an anonymous late bound region, which hence may refer to
  74     /// a canonical variable.
  75     pub fn assert_bound_var(&self) -> BoundVar {
  76         match *self {
  77             BoundRegion::BrAnon(var) => BoundVar::from_u32(var),
  78             _ => bug!("bound region is not anonymous"),
  79         }
  80     }
  81 }
  82
  83 /// N.B., if you change this, you'll probably want to change the corresponding
  84 /// AST structure in `librustc_ast/ast.rs` as well.
  85 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable, Debug)]
  86 #[derive(HashStable)]
  87 #[rustc_diagnostic_item = "TyKind"]
  88 pub enum TyKind<'tcx> {
  89     /// The primitive boolean type. Written as `bool`.
  90     Bool,
  91
  92     /// The primitive character type; holds a Unicode scalar value
  93     /// (a non-surrogate code point). Written as `char`.
  94     Char,
  95
  96     /// A primitive signed integer type. For example, `i32`.
  97     Int(ast::IntTy),
  98
  99     /// A primitive unsigned integer type. For example, `u32`.
 100     Uint(ast::UintTy),
 101
 102     /// A primitive floating-point type. For example, `f64`.
 103     Float(ast::FloatTy),
 104
 105     /// Structures, enumerations and unions.
 106     ///
 107     /// InternalSubsts here, possibly against intuition, *may* contain `Param`s.
 108     /// That is, even after substitution it is possible that there are type
 109     /// variables. This happens when the `Adt` corresponds to an ADT
 110     /// definition and not a concrete use of it.
 111     Adt(&'tcx AdtDef, SubstsRef<'tcx>),
 112
 113     /// An unsized FFI type that is opaque to Rust. Written as `extern type T`.
 114     Foreign(DefId),
 115
 116     /// The pointee of a string slice. Written as `str`.
 117     Str,
 118
 119     /// An array with the given length. Written as `[T; n]`.
 120     Array(Ty<'tcx>, &'tcx ty::Const<'tcx>),
 121
 122     /// The pointee of an array slice. Written as `[T]`.
 123     Slice(Ty<'tcx>),
 124
 125     /// A raw pointer. Written as `*mut T` or `*const T`
 126     RawPtr(TypeAndMut<'tcx>),
 127
 128     /// A reference; a pointer with an associated lifetime. Written as
 129     /// `&'a mut T` or `&'a T`.
 130     Ref(Region<'tcx>, Ty<'tcx>, hir::Mutability),
 131
 132     /// The anonymous type of a function declaration/definition. Each
 133     /// function has a unique type, which is output (for a function
 134     /// named `foo` returning an `i32`) as `fn() -> i32 {foo}`.
 135     ///
 136     /// For example the type of `bar` here:
 137     ///
 138     /// ```rust
 139     /// fn foo() -> i32 { 1 }
 140     /// let bar = foo; // bar: fn() -> i32 {foo}
 141     /// ```
 142     FnDef(DefId, SubstsRef<'tcx>),
 143
 144     /// A pointer to a function. Written as `fn() -> i32`.
 145     ///
 146     /// For example the type of `bar` here:
 147     ///
 148     /// ```rust
 149     /// fn foo() -> i32 { 1 }
 150     /// let bar: fn() -> i32 = foo;
 151     /// ```
 152     FnPtr(PolyFnSig<'tcx>),
 153
 154     /// A trait, defined with `trait`.
 155     Dynamic(Binder<&'tcx List<ExistentialPredicate<'tcx>>>, ty::Region<'tcx>),
 156
 157     /// The anonymous type of a closure. Used to represent the type of
 158     /// `|a| a`.
 159     Closure(DefId, SubstsRef<'tcx>),
 160
 161     /// The anonymous type of a generator. Used to represent the type of
 162     /// `|a| yield a`.
 163     Generator(DefId, SubstsRef<'tcx>, hir::Movability),
 164
 165     /// A type representin the types stored inside a generator.
 166     /// This should only appear in GeneratorInteriors.
 167     GeneratorWitness(Binder<&'tcx List<Ty<'tcx>>>),
 168
 169     /// The never type `!`
 170     Never,
 171
 172     /// A tuple type. For example, `(i32, bool)`.
 173     /// Use `TyS::tuple_fields` to iterate over the field types.
 174     Tuple(SubstsRef<'tcx>),
 175
 176     /// The projection of an associated type. For example,
 177     /// `<T as Trait<..>>::N`.
 178     Projection(ProjectionTy<'tcx>),
 179
 180     /// Opaque (`impl Trait`) type found in a return type.
 181     /// The `DefId` comes either from
 182     /// * the `impl Trait` ast::Ty node,
 183     /// * or the `type Foo = impl Trait` declaration
 184     /// The substitutions are for the generics of the function in question.
 185     /// After typeck, the concrete type can be found in the `types` map.
 186     Opaque(DefId, SubstsRef<'tcx>),
 187
 188     /// A type parameter; for example, `T` in `fn f<T>(x: T) {}`.
 189     Param(ParamTy),
 190
 191     /// Bound type variable, used only when preparing a trait query.
 192     Bound(ty::DebruijnIndex, BoundTy),
 193
 194     /// A placeholder type - universally quantified higher-ranked type.
 195     Placeholder(ty::PlaceholderType),
 196
 197     /// A type variable used during type checking.
 198     Infer(InferTy),
 199
 200     /// A placeholder for a type which could not be computed; this is
 201     /// propagated to avoid useless error messages.
 202     Error(DelaySpanBugEmitted),
 203 }
 204
 205 impl TyKind<'tcx> {
 206     #[inline]
 207     pub fn is_primitive(&self) -> bool {
 208         match self {
 209             Bool | Char | Int(_) | Uint(_) | Float(_) => true,
 210             _ => false,
 211         }
 212     }
 213 }
 214
 215 // `TyKind` is used a lot. Make sure it doesn't unintentionally get bigger.
 216 #[cfg(target_arch = "x86_64")]
 217 static_assert_size!(TyKind<'_>, 24);
 218
 219 /// A closure can be modeled as a struct that looks like:
 220 ///
 221 ///     struct Closure<'l0...'li, T0...Tj, CK, CS, U>(...U);
 222 ///
 223 /// where:
 224 ///
 225 /// - 'l0...'li and T0...Tj are the generic parameters
 226 ///   in scope on the function that defined the closure,
 227 /// - CK represents the *closure kind* (Fn vs FnMut vs FnOnce). This
 228 ///   is rather hackily encoded via a scalar type. See
 229 ///   `TyS::to_opt_closure_kind` for details.
 230 /// - CS represents the *closure signature*, representing as a `fn()`
 231 ///   type. For example, `fn(u32, u32) -> u32` would mean that the closure
 232 ///   implements `CK<(u32, u32), Output = u32>`, where `CK` is the trait
 233 ///   specified above.
 234 /// - U is a type parameter representing the types of its upvars, tupled up
 235 ///   (borrowed, if appropriate; that is, if an U field represents a by-ref upvar,
 236 ///    and the up-var has the type `Foo`, then that field of U will be `&Foo`).
 237 ///
 238 /// So, for example, given this function:
 239 ///
 240 ///     fn foo<'a, T>(data: &'a mut T) {
 241 ///          do(|| data.count += 1)
 242 ///     }
 243 ///
 244 /// the type of the closure would be something like:
 245 ///
 246 ///     struct Closure<'a, T, U>(...U);
 247 ///
 248 /// Note that the type of the upvar is not specified in the struct.
 249 /// You may wonder how the impl would then be able to use the upvar,
 250 /// if it doesn't know it's type? The answer is that the impl is
 251 /// (conceptually) not fully generic over Closure but rather tied to
 252 /// instances with the expected upvar types:
 253 ///
 254 ///     impl<'b, 'a, T> FnMut() for Closure<'a, T, (&'b mut &'a mut T,)> {
 255 ///         ...
 256 ///     }
 257 ///
 258 /// You can see that the *impl* fully specified the type of the upvar
 259 /// and thus knows full well that `data` has type `&'b mut &'a mut T`.
 260 /// (Here, I am assuming that `data` is mut-borrowed.)
 261 ///
 262 /// Now, the last question you may ask is: Why include the upvar types
 263 /// in an extra type parameter? The reason for this design is that the
 264 /// upvar types can reference lifetimes that are internal to the
 265 /// creating function. In my example above, for example, the lifetime
 266 /// `'b` represents the scope of the closure itself; this is some
 267 /// subset of `foo`, probably just the scope of the call to the to
 268 /// `do()`. If we just had the lifetime/type parameters from the
 269 /// enclosing function, we couldn't name this lifetime `'b`. Note that
 270 /// there can also be lifetimes in the types of the upvars themselves,
 271 /// if one of them happens to be a reference to something that the
 272 /// creating fn owns.
 273 ///
 274 /// OK, you say, so why not create a more minimal set of parameters
 275 /// that just includes the extra lifetime parameters? The answer is
 276 /// primarily that it would be hard --- we don't know at the time when
 277 /// we create the closure type what the full types of the upvars are,
 278 /// nor do we know which are borrowed and which are not. In this
 279 /// design, we can just supply a fresh type parameter and figure that
 280 /// out later.
 281 ///
 282 /// All right, you say, but why include the type parameters from the
 283 /// original function then? The answer is that codegen may need them
 284 /// when monomorphizing, and they may not appear in the upvars. A
 285 /// closure could capture no variables but still make use of some
 286 /// in-scope type parameter with a bound (e.g., if our example above
 287 /// had an extra `U: Default`, and the closure called `U::default()`).
 288 ///
 289 /// There is another reason. This design (implicitly) prohibits
 290 /// closures from capturing themselves (except via a trait
 291 /// object). This simplifies closure inference considerably, since it
 292 /// means that when we infer the kind of a closure or its upvars, we
 293 /// don't have to handle cycles where the decisions we make for
 294 /// closure C wind up influencing the decisions we ought to make for
 295 /// closure C (which would then require fixed point iteration to
 296 /// handle). Plus it fixes an ICE. :P
 297 ///
 298 /// ## Generators
 299 ///
 300 /// Generators are handled similarly in `GeneratorSubsts`.  The set of
 301 /// type parameters is similar, but `CK` and `CS` are replaced by the
 302 /// following type parameters:
 303 ///
 304 /// * `GS`: The generator's "resume type", which is the type of the
 305 ///   argument passed to `resume`, and the type of `yield` expressions
 306 ///   inside the generator.
 307 /// * `GY`: The "yield type", which is the type of values passed to
 308 ///   `yield` inside the generator.
 309 /// * `GR`: The "return type", which is the type of value returned upon
 310 ///   completion of the generator.
 311 /// * `GW`: The "generator witness".
 312 #[derive(Copy, Clone, Debug, TypeFoldable)]
 313 pub struct ClosureSubsts<'tcx> {
 314     /// Lifetime and type parameters from the enclosing function,
 315     /// concatenated with a tuple containing the types of the upvars.
 316     ///
 317     /// These are separated out because codegen wants to pass them around
 318     /// when monomorphizing.
 319     pub substs: SubstsRef<'tcx>,
 320 }
 321
 322 /// Struct returned by `split()`.
 323 pub struct ClosureSubstsParts<'tcx, T> {
 324     pub parent_substs: &'tcx [GenericArg<'tcx>],
 325     pub closure_kind_ty: T,
 326     pub closure_sig_as_fn_ptr_ty: T,
 327     pub tupled_upvars_ty: T,
 328 }
 329
 330 impl<'tcx> ClosureSubsts<'tcx> {
 331     /// Construct `ClosureSubsts` from `ClosureSubstsParts`, containing `Substs`
 332     /// for the closure parent, alongside additional closure-specific components.
 333     pub fn new(
 334         tcx: TyCtxt<'tcx>,
 335         parts: ClosureSubstsParts<'tcx, Ty<'tcx>>,
 336     ) -> ClosureSubsts<'tcx> {
 337         ClosureSubsts {
 338             substs: tcx.mk_substs(
 339                 parts.parent_substs.iter().copied().chain(
 340                     [parts.closure_kind_ty, parts.closure_sig_as_fn_ptr_ty, parts.tupled_upvars_ty]
 341                         .iter()
 342                         .map(|&ty| ty.into()),
 343                 ),
 344             ),
 345         }
 346     }
 347
 348     /// Divides the closure substs into their respective components.
 349     /// The ordering assumed here must match that used by `ClosureSubsts::new` above.
 350     fn split(self) -> ClosureSubstsParts<'tcx, GenericArg<'tcx>> {
 351         match self.substs[..] {
 352             [ref parent_substs @ .., closure_kind_ty, closure_sig_as_fn_ptr_ty, tupled_upvars_ty] => {
 353                 ClosureSubstsParts {
 354                     parent_substs,
 355                     closure_kind_ty,
 356                     closure_sig_as_fn_ptr_ty,
 357                     tupled_upvars_ty,
 358                 }
 359             }
 360             _ => bug!("closure substs missing synthetics"),
 361         }
 362     }
 363
 364     /// Returns `true` only if enough of the synthetic types are known to
 365     /// allow using all of the methods on `ClosureSubsts` without panicking.
 366     ///
 367     /// Used primarily by `ty::print::pretty` to be able to handle closure
 368     /// types that haven't had their synthetic types substituted in.
 369     pub fn is_valid(self) -> bool {
 370         self.substs.len() >= 3
 371             && matches!(self.split().tupled_upvars_ty.expect_ty().kind(), Tuple(_))
 372     }
 373
 374     /// Returns the substitutions of the closure's parent.
 375     pub fn parent_substs(self) -> &'tcx [GenericArg<'tcx>] {
 376         self.split().parent_substs
 377     }
 378
 379     #[inline]
 380     pub fn upvar_tys(self) -> impl Iterator<Item = Ty<'tcx>> + 'tcx {
 381         self.tupled_upvars_ty().tuple_fields()
 382     }
 383
 384     /// Returns the tuple type representing the upvars for this closure.
 385     #[inline]
 386     pub fn tupled_upvars_ty(self) -> Ty<'tcx> {
 387         self.split().tupled_upvars_ty.expect_ty()
 388     }
 389
 390     /// Returns the closure kind for this closure; may return a type
 391     /// variable during inference. To get the closure kind during
 392     /// inference, use `infcx.closure_kind(substs)`.
 393     pub fn kind_ty(self) -> Ty<'tcx> {
 394         self.split().closure_kind_ty.expect_ty()
 395     }
 396
 397     /// Returns the `fn` pointer type representing the closure signature for this
 398     /// closure.
 399     // FIXME(eddyb) this should be unnecessary, as the shallowly resolved
 400     // type is known at the time of the creation of `ClosureSubsts`,
 401     // see `rustc_typeck::check::closure`.
 402     pub fn sig_as_fn_ptr_ty(self) -> Ty<'tcx> {
 403         self.split().closure_sig_as_fn_ptr_ty.expect_ty()
 404     }
 405
 406     /// Returns the closure kind for this closure; only usable outside
 407     /// of an inference context, because in that context we know that
 408     /// there are no type variables.
 409     ///
 410     /// If you have an inference context, use `infcx.closure_kind()`.
 411     pub fn kind(self) -> ty::ClosureKind {
 412         self.kind_ty().to_opt_closure_kind().unwrap()
 413     }
 414
 415     /// Extracts the signature from the closure.
 416     pub fn sig(self) -> ty::PolyFnSig<'tcx> {
 417         let ty = self.sig_as_fn_ptr_ty();
 418         match ty.kind() {
 419             ty::FnPtr(sig) => *sig,
 420             _ => bug!("closure_sig_as_fn_ptr_ty is not a fn-ptr: {:?}", ty.kind()),
 421         }
 422     }
 423 }
 424
 425 /// Similar to `ClosureSubsts`; see the above documentation for more.
 426 #[derive(Copy, Clone, Debug, TypeFoldable)]
 427 pub struct GeneratorSubsts<'tcx> {
 428     pub substs: SubstsRef<'tcx>,
 429 }
 430
 431 pub struct GeneratorSubstsParts<'tcx, T> {
 432     pub parent_substs: &'tcx [GenericArg<'tcx>],
 433     pub resume_ty: T,
 434     pub yield_ty: T,
 435     pub return_ty: T,
 436     pub witness: T,
 437     pub tupled_upvars_ty: T,
 438 }
 439
 440 impl<'tcx> GeneratorSubsts<'tcx> {
 441     /// Construct `GeneratorSubsts` from `GeneratorSubstsParts`, containing `Substs`
 442     /// for the generator parent, alongside additional generator-specific components.
 443     pub fn new(
 444         tcx: TyCtxt<'tcx>,
 445         parts: GeneratorSubstsParts<'tcx, Ty<'tcx>>,
 446     ) -> GeneratorSubsts<'tcx> {
 447         GeneratorSubsts {
 448             substs: tcx.mk_substs(
 449                 parts.parent_substs.iter().copied().chain(
 450                     [
 451                         parts.resume_ty,
 452                         parts.yield_ty,
 453                         parts.return_ty,
 454                         parts.witness,
 455                         parts.tupled_upvars_ty,
 456                     ]
 457                     .iter()
 458                     .map(|&ty| ty.into()),
 459                 ),
 460             ),
 461         }
 462     }
 463
 464     /// Divides the generator substs into their respective components.
 465     /// The ordering assumed here must match that used by `GeneratorSubsts::new` above.
 466     fn split(self) -> GeneratorSubstsParts<'tcx, GenericArg<'tcx>> {
 467         match self.substs[..] {
 468             [ref parent_substs @ .., resume_ty, yield_ty, return_ty, witness, tupled_upvars_ty] => {
 469                 GeneratorSubstsParts {
 470                     parent_substs,
 471                     resume_ty,
 472                     yield_ty,
 473                     return_ty,
 474                     witness,
 475                     tupled_upvars_ty,
 476                 }
 477             }
 478             _ => bug!("generator substs missing synthetics"),
 479         }
 480     }
 481
 482     /// Returns `true` only if enough of the synthetic types are known to
 483     /// allow using all of the methods on `GeneratorSubsts` without panicking.
 484     ///
 485     /// Used primarily by `ty::print::pretty` to be able to handle generator
 486     /// types that haven't had their synthetic types substituted in.
 487     pub fn is_valid(self) -> bool {
 488         self.substs.len() >= 5
 489             && matches!(self.split().tupled_upvars_ty.expect_ty().kind(), Tuple(_))
 490     }
 491
 492     /// Returns the substitutions of the generator's parent.
 493     pub fn parent_substs(self) -> &'tcx [GenericArg<'tcx>] {
 494         self.split().parent_substs
 495     }
 496
 497     /// This describes the types that can be contained in a generator.
 498     /// It will be a type variable initially and unified in the last stages of typeck of a body.
 499     /// It contains a tuple of all the types that could end up on a generator frame.
 500     /// The state transformation MIR pass may only produce layouts which mention types
 501     /// in this tuple. Upvars are not counted here.
 502     pub fn witness(self) -> Ty<'tcx> {
 503         self.split().witness.expect_ty()
 504     }
 505
 506     #[inline]
 507     pub fn upvar_tys(self) -> impl Iterator<Item = Ty<'tcx>> + 'tcx {
 508         self.tupled_upvars_ty().tuple_fields()
 509     }
 510
 511     /// Returns the tuple type representing the upvars for this generator.
 512     #[inline]
 513     pub fn tupled_upvars_ty(self) -> Ty<'tcx> {
 514         self.split().tupled_upvars_ty.expect_ty()
 515     }
 516
 517     /// Returns the type representing the resume type of the generator.
 518     pub fn resume_ty(self) -> Ty<'tcx> {
 519         self.split().resume_ty.expect_ty()
 520     }
 521
 522     /// Returns the type representing the yield type of the generator.
 523     pub fn yield_ty(self) -> Ty<'tcx> {
 524         self.split().yield_ty.expect_ty()
 525     }
 526
 527     /// Returns the type representing the return type of the generator.
 528     pub fn return_ty(self) -> Ty<'tcx> {
 529         self.split().return_ty.expect_ty()
 530     }
 531
 532     /// Returns the "generator signature", which consists of its yield
 533     /// and return types.
 534     ///
 535     /// N.B., some bits of the code prefers to see this wrapped in a
 536     /// binder, but it never contains bound regions. Probably this
 537     /// function should be removed.
 538     pub fn poly_sig(self) -> PolyGenSig<'tcx> {
 539         ty::Binder::dummy(self.sig())
 540     }
 541
 542     /// Returns the "generator signature", which consists of its resume, yield
 543     /// and return types.
 544     pub fn sig(self) -> GenSig<'tcx> {
 545         ty::GenSig {
 546             resume_ty: self.resume_ty(),
 547             yield_ty: self.yield_ty(),
 548             return_ty: self.return_ty(),
 549         }
 550     }
 551 }
 552
 553 impl<'tcx> GeneratorSubsts<'tcx> {
 554     /// Generator has not been resumed yet.
 555     pub const UNRESUMED: usize = 0;
 556     /// Generator has returned or is completed.
 557     pub const RETURNED: usize = 1;
 558     /// Generator has been poisoned.
 559     pub const POISONED: usize = 2;
 560
 561     const UNRESUMED_NAME: &'static str = "Unresumed";
 562     const RETURNED_NAME: &'static str = "Returned";
 563     const POISONED_NAME: &'static str = "Panicked";
 564
 565     /// The valid variant indices of this generator.
 566     #[inline]
 567     pub fn variant_range(&self, def_id: DefId, tcx: TyCtxt<'tcx>) -> Range<VariantIdx> {
 568         // FIXME requires optimized MIR
 569         let num_variants = tcx.generator_layout(def_id).variant_fields.len();
 570         VariantIdx::new(0)..VariantIdx::new(num_variants)
 571     }
 572
 573     /// The discriminant for the given variant. Panics if the `variant_index` is
 574     /// out of range.
 575     #[inline]
 576     pub fn discriminant_for_variant(
 577         &self,
 578         def_id: DefId,
 579         tcx: TyCtxt<'tcx>,
 580         variant_index: VariantIdx,
 581     ) -> Discr<'tcx> {
 582         // Generators don't support explicit discriminant values, so they are
 583         // the same as the variant index.
 584         assert!(self.variant_range(def_id, tcx).contains(&variant_index));
 585         Discr { val: variant_index.as_usize() as u128, ty: self.discr_ty(tcx) }
 586     }
 587
 588     /// The set of all discriminants for the generator, enumerated with their
 589     /// variant indices.
 590     #[inline]
 591     pub fn discriminants(
 592         self,
 593         def_id: DefId,
 594         tcx: TyCtxt<'tcx>,
 595     ) -> impl Iterator<Item = (VariantIdx, Discr<'tcx>)> + Captures<'tcx> {
 596         self.variant_range(def_id, tcx).map(move |index| {
 597             (index, Discr { val: index.as_usize() as u128, ty: self.discr_ty(tcx) })
 598         })
 599     }
 600
 601     /// Calls `f` with a reference to the name of the enumerator for the given
 602     /// variant `v`.
 603     pub fn variant_name(v: VariantIdx) -> Cow<'static, str> {
 604         match v.as_usize() {
 605             Self::UNRESUMED => Cow::from(Self::UNRESUMED_NAME),
 606             Self::RETURNED => Cow::from(Self::RETURNED_NAME),
 607             Self::POISONED => Cow::from(Self::POISONED_NAME),
 608             _ => Cow::from(format!("Suspend{}", v.as_usize() - 3)),
 609         }
 610     }
 611
 612     /// The type of the state discriminant used in the generator type.
 613     #[inline]
 614     pub fn discr_ty(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
 615         tcx.types.u32
 616     }
 617
 618     /// This returns the types of the MIR locals which had to be stored across suspension points.
 619     /// It is calculated in rustc_mir::transform::generator::StateTransform.
 620     /// All the types here must be in the tuple in GeneratorInterior.
 621     ///
 622     /// The locals are grouped by their variant number. Note that some locals may
 623     /// be repeated in multiple variants.
 624     #[inline]
 625     pub fn state_tys(
 626         self,
 627         def_id: DefId,
 628         tcx: TyCtxt<'tcx>,
 629     ) -> impl Iterator<Item = impl Iterator<Item = Ty<'tcx>> + Captures<'tcx>> {
 630         let layout = tcx.generator_layout(def_id);
 631         layout.variant_fields.iter().map(move |variant| {
 632             variant.iter().map(move |field| layout.field_tys[*field].subst(tcx, self.substs))
 633         })
 634     }
 635
 636     /// This is the types of the fields of a generator which are not stored in a
 637     /// variant.
 638     #[inline]
 639     pub fn prefix_tys(self) -> impl Iterator<Item = Ty<'tcx>> {
 640         self.upvar_tys()
 641     }
 642 }
 643
 644 #[derive(Debug, Copy, Clone)]
 645 pub enum UpvarSubsts<'tcx> {
 646     Closure(SubstsRef<'tcx>),
 647     Generator(SubstsRef<'tcx>),
 648 }
 649
 650 impl<'tcx> UpvarSubsts<'tcx> {
 651     #[inline]
 652     pub fn upvar_tys(self) -> impl Iterator<Item = Ty<'tcx>> + 'tcx {
 653         let tupled_upvars_ty = match self {
 654             UpvarSubsts::Closure(substs) => substs.as_closure().split().tupled_upvars_ty,
 655             UpvarSubsts::Generator(substs) => substs.as_generator().split().tupled_upvars_ty,
 656         };
 657         tupled_upvars_ty.expect_ty().tuple_fields()
 658     }
 659 }
 660
 661 #[derive(Debug, Copy, Clone, PartialEq, PartialOrd, Ord, Eq, Hash, TyEncodable, TyDecodable)]
 662 #[derive(HashStable, TypeFoldable)]
 663 pub enum ExistentialPredicate<'tcx> {
 664     /// E.g., `Iterator`.
 665     Trait(ExistentialTraitRef<'tcx>),
 666     /// E.g., `Iterator::Item = T`.
 667     Projection(ExistentialProjection<'tcx>),
 668     /// E.g., `Send`.
 669     AutoTrait(DefId),
 670 }
 671
 672 impl<'tcx> ExistentialPredicate<'tcx> {
 673     /// Compares via an ordering that will not change if modules are reordered or other changes are
 674     /// made to the tree. In particular, this ordering is preserved across incremental compilations.
 675     pub fn stable_cmp(&self, tcx: TyCtxt<'tcx>, other: &Self) -> Ordering {
 676         use self::ExistentialPredicate::*;
 677         match (*self, *other) {
 678             (Trait(_), Trait(_)) => Ordering::Equal,
 679             (Projection(ref a), Projection(ref b)) => {
 680                 tcx.def_path_hash(a.item_def_id).cmp(&tcx.def_path_hash(b.item_def_id))
 681             }
 682             (AutoTrait(ref a), AutoTrait(ref b)) => {
 683                 tcx.trait_def(*a).def_path_hash.cmp(&tcx.trait_def(*b).def_path_hash)
 684             }
 685             (Trait(_), _) => Ordering::Less,
 686             (Projection(_), Trait(_)) => Ordering::Greater,
 687             (Projection(_), _) => Ordering::Less,
 688             (AutoTrait(_), _) => Ordering::Greater,
 689         }
 690     }
 691 }
 692
 693 impl<'tcx> Binder<ExistentialPredicate<'tcx>> {
 694     pub fn with_self_ty(&self, tcx: TyCtxt<'tcx>, self_ty: Ty<'tcx>) -> ty::Predicate<'tcx> {
 695         use crate::ty::ToPredicate;
 696         match self.skip_binder() {
 697             ExistentialPredicate::Trait(tr) => {
 698                 Binder(tr).with_self_ty(tcx, self_ty).without_const().to_predicate(tcx)
 699             }
 700             ExistentialPredicate::Projection(p) => {
 701                 Binder(p.with_self_ty(tcx, self_ty)).to_predicate(tcx)
 702             }
 703             ExistentialPredicate::AutoTrait(did) => {
 704                 let trait_ref =
 705                     Binder(ty::TraitRef { def_id: did, substs: tcx.mk_substs_trait(self_ty, &[]) });
 706                 trait_ref.without_const().to_predicate(tcx)
 707             }
 708         }
 709     }
 710 }
 711
 712 impl<'tcx> List<ExistentialPredicate<'tcx>> {
 713     /// Returns the "principal `DefId`" of this set of existential predicates.
 714     ///
 715     /// A Rust trait object type consists (in addition to a lifetime bound)
 716     /// of a set of trait bounds, which are separated into any number
 717     /// of auto-trait bounds, and at most one non-auto-trait bound. The
 718     /// non-auto-trait bound is called the "principal" of the trait
 719     /// object.
 720     ///
 721     /// Only the principal can have methods or type parameters (because
 722     /// auto traits can have neither of them). This is important, because
 723     /// it means the auto traits can be treated as an unordered set (methods
 724     /// would force an order for the vtable, while relating traits with
 725     /// type parameters without knowing the order to relate them in is
 726     /// a rather non-trivial task).
 727     ///
 728     /// For example, in the trait object `dyn fmt::Debug + Sync`, the
 729     /// principal bound is `Some(fmt::Debug)`, while the auto-trait bounds
 730     /// are the set `{Sync}`.
 731     ///
 732     /// It is also possible to have a "trivial" trait object that
 733     /// consists only of auto traits, with no principal - for example,
 734     /// `dyn Send + Sync`. In that case, the set of auto-trait bounds
 735     /// is `{Send, Sync}`, while there is no principal. These trait objects
 736     /// have a "trivial" vtable consisting of just the size, alignment,
 737     /// and destructor.
 738     pub fn principal(&self) -> Option<ExistentialTraitRef<'tcx>> {
 739         match self[0] {
 740             ExistentialPredicate::Trait(tr) => Some(tr),
 741             _ => None,
 742         }
 743     }
 744
 745     pub fn principal_def_id(&self) -> Option<DefId> {
 746         self.principal().map(|trait_ref| trait_ref.def_id)
 747     }
 748
 749     #[inline]
 750     pub fn projection_bounds<'a>(
 751         &'a self,
 752     ) -> impl Iterator<Item = ExistentialProjection<'tcx>> + 'a {
 753         self.iter().filter_map(|predicate| match predicate {
 754             ExistentialPredicate::Projection(projection) => Some(projection),
 755             _ => None,
 756         })
 757     }
 758
 759     #[inline]
 760     pub fn auto_traits<'a>(&'a self) -> impl Iterator<Item = DefId> + 'a {
 761         self.iter().filter_map(|predicate| match predicate {
 762             ExistentialPredicate::AutoTrait(did) => Some(did),
 763             _ => None,
 764         })
 765     }
 766 }
 767
 768 impl<'tcx> Binder<&'tcx List<ExistentialPredicate<'tcx>>> {
 769     pub fn principal(&self) -> Option<ty::Binder<ExistentialTraitRef<'tcx>>> {
 770         self.skip_binder().principal().map(Binder::bind)
 771     }
 772
 773     pub fn principal_def_id(&self) -> Option<DefId> {
 774         self.skip_binder().principal_def_id()
 775     }
 776
 777     #[inline]
 778     pub fn projection_bounds<'a>(
 779         &'a self,
 780     ) -> impl Iterator<Item = PolyExistentialProjection<'tcx>> + 'a {
 781         self.skip_binder().projection_bounds().map(Binder::bind)
 782     }
 783
 784     #[inline]
 785     pub fn auto_traits<'a>(&'a self) -> impl Iterator<Item = DefId> + 'a {
 786         self.skip_binder().auto_traits()
 787     }
 788
 789     pub fn iter<'a>(
 790         &'a self,
 791     ) -> impl DoubleEndedIterator<Item = Binder<ExistentialPredicate<'tcx>>> + 'tcx {
 792         self.skip_binder().iter().map(Binder::bind)
 793     }
 794 }
 795
 796 /// A complete reference to a trait. These take numerous guises in syntax,
 797 /// but perhaps the most recognizable form is in a where-clause:
 798 ///
 799 ///     T: Foo<U>
 800 ///
 801 /// This would be represented by a trait-reference where the `DefId` is the
 802 /// `DefId` for the trait `Foo` and the substs define `T` as parameter 0,
 803 /// and `U` as parameter 1.
 804 ///
 805 /// Trait references also appear in object types like `Foo<U>`, but in
 806 /// that case the `Self` parameter is absent from the substitutions.
 807 #[derive(Copy, Clone, PartialEq, Eq, Hash, TyEncodable, TyDecodable)]
 808 #[derive(HashStable, TypeFoldable)]
 809 pub struct TraitRef<'tcx> {
 810     pub def_id: DefId,
 811     pub substs: SubstsRef<'tcx>,
 812 }
 813
 814 impl<'tcx> TraitRef<'tcx> {
 815     pub fn new(def_id: DefId, substs: SubstsRef<'tcx>) -> TraitRef<'tcx> {
 816         TraitRef { def_id, substs }
 817     }
 818
 819     /// Returns a `TraitRef` of the form `P0: Foo<P1..Pn>` where `Pi`
 820     /// are the parameters defined on trait.
 821     pub fn identity(tcx: TyCtxt<'tcx>, def_id: DefId) -> TraitRef<'tcx> {
 822         TraitRef { def_id, substs: InternalSubsts::identity_for_item(tcx, def_id) }
 823     }
 824
 825     #[inline]
 826     pub fn self_ty(&self) -> Ty<'tcx> {
 827         self.substs.type_at(0)
 828     }
 829
 830     pub fn from_method(
 831         tcx: TyCtxt<'tcx>,
 832         trait_id: DefId,
 833         substs: SubstsRef<'tcx>,
 834     ) -> ty::TraitRef<'tcx> {
 835         let defs = tcx.generics_of(trait_id);
 836
 837         ty::TraitRef { def_id: trait_id, substs: tcx.intern_substs(&substs[..defs.params.len()]) }
 838     }
 839 }
 840
 841 pub type PolyTraitRef<'tcx> = Binder<TraitRef<'tcx>>;
 842
 843 impl<'tcx> PolyTraitRef<'tcx> {
 844     pub fn self_ty(&self) -> Binder<Ty<'tcx>> {
 845         self.map_bound_ref(|tr| tr.self_ty())
 846     }
 847
 848     pub fn def_id(&self) -> DefId {
 849         self.skip_binder().def_id
 850     }
 851
 852     pub fn to_poly_trait_predicate(&self) -> ty::PolyTraitPredicate<'tcx> {
 853         // Note that we preserve binding levels
 854         Binder(ty::TraitPredicate { trait_ref: self.skip_binder() })
 855     }
 856 }
 857
 858 /// An existential reference to a trait, where `Self` is erased.
 859 /// For example, the trait object `Trait<'a, 'b, X, Y>` is:
 860 ///
 861 ///     exists T. T: Trait<'a, 'b, X, Y>
 862 ///
 863 /// The substitutions don't include the erased `Self`, only trait
 864 /// type and lifetime parameters (`[X, Y]` and `['a, 'b]` above).
 865 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
 866 #[derive(HashStable, TypeFoldable)]
 867 pub struct ExistentialTraitRef<'tcx> {
 868     pub def_id: DefId,
 869     pub substs: SubstsRef<'tcx>,
 870 }
 871
 872 impl<'tcx> ExistentialTraitRef<'tcx> {
 873     pub fn erase_self_ty(
 874         tcx: TyCtxt<'tcx>,
 875         trait_ref: ty::TraitRef<'tcx>,
 876     ) -> ty::ExistentialTraitRef<'tcx> {
 877         // Assert there is a Self.
 878         trait_ref.substs.type_at(0);
 879
 880         ty::ExistentialTraitRef {
 881             def_id: trait_ref.def_id,
 882             substs: tcx.intern_substs(&trait_ref.substs[1..]),
 883         }
 884     }
 885
 886     /// Object types don't have a self type specified. Therefore, when
 887     /// we convert the principal trait-ref into a normal trait-ref,
 888     /// you must give *some* self type. A common choice is `mk_err()`
 889     /// or some placeholder type.
 890     pub fn with_self_ty(&self, tcx: TyCtxt<'tcx>, self_ty: Ty<'tcx>) -> ty::TraitRef<'tcx> {
 891         // otherwise the escaping vars would be captured by the binder
 892         // debug_assert!(!self_ty.has_escaping_bound_vars());
 893
 894         ty::TraitRef { def_id: self.def_id, substs: tcx.mk_substs_trait(self_ty, self.substs) }
 895     }
 896 }
 897
 898 pub type PolyExistentialTraitRef<'tcx> = Binder<ExistentialTraitRef<'tcx>>;
 899
 900 impl<'tcx> PolyExistentialTraitRef<'tcx> {
 901     pub fn def_id(&self) -> DefId {
 902         self.skip_binder().def_id
 903     }
 904
 905     /// Object types don't have a self type specified. Therefore, when
 906     /// we convert the principal trait-ref into a normal trait-ref,
 907     /// you must give *some* self type. A common choice is `mk_err()`
 908     /// or some placeholder type.
 909     pub fn with_self_ty(&self, tcx: TyCtxt<'tcx>, self_ty: Ty<'tcx>) -> ty::PolyTraitRef<'tcx> {
 910         self.map_bound(|trait_ref| trait_ref.with_self_ty(tcx, self_ty))
 911     }
 912 }
 913
 914 /// Binder is a binder for higher-ranked lifetimes or types. It is part of the
 915 /// compiler's representation for things like `for<'a> Fn(&'a isize)`
 916 /// (which would be represented by the type `PolyTraitRef ==
 917 /// Binder<TraitRef>`). Note that when we instantiate,
 918 /// erase, or otherwise "discharge" these bound vars, we change the
 919 /// type from `Binder<T>` to just `T` (see
 920 /// e.g., `liberate_late_bound_regions`).
 921 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
 922 pub struct Binder<T>(T);
 923
 924 impl<T> Binder<T> {
 925     /// Wraps `value` in a binder, asserting that `value` does not
 926     /// contain any bound vars that would be bound by the
 927     /// binder. This is commonly used to 'inject' a value T into a
 928     /// different binding level.
 929     pub fn dummy<'tcx>(value: T) -> Binder<T>
 930     where
 931         T: TypeFoldable<'tcx>,
 932     {
 933         debug_assert!(!value.has_escaping_bound_vars());
 934         Binder(value)
 935     }
 936
 937     /// Wraps `value` in a binder, binding higher-ranked vars (if any).
 938     pub fn bind(value: T) -> Binder<T> {
 939         Binder(value)
 940     }
 941
 942     /// Wraps `value` in a binder without actually binding any currently
 943     /// unbound variables.
 944     ///
 945     /// Note that this will shift all debrujin indices of escaping bound variables
 946     /// by 1 to avoid accidential captures.
 947     pub fn wrap_nonbinding(tcx: TyCtxt<'tcx>, value: T) -> Binder<T>
 948     where
 949         T: TypeFoldable<'tcx>,
 950     {
 951         if value.has_escaping_bound_vars() {
 952             Binder::bind(super::fold::shift_vars(tcx, &value, 1))
 953         } else {
 954             Binder::dummy(value)
 955         }
 956     }
 957
 958     /// Skips the binder and returns the "bound" value. This is a
 959     /// risky thing to do because it's easy to get confused about
 960     /// De Bruijn indices and the like. It is usually better to
 961     /// discharge the binder using `no_bound_vars` or
 962     /// `replace_late_bound_regions` or something like
 963     /// that. `skip_binder` is only valid when you are either
 964     /// extracting data that has nothing to do with bound vars, you
 965     /// are doing some sort of test that does not involve bound
 966     /// regions, or you are being very careful about your depth
 967     /// accounting.
 968     ///
 969     /// Some examples where `skip_binder` is reasonable:
 970     ///
 971     /// - extracting the `DefId` from a PolyTraitRef;
 972     /// - comparing the self type of a PolyTraitRef to see if it is equal to
 973     ///   a type parameter `X`, since the type `X` does not reference any regions
 974     pub fn skip_binder(self) -> T {
 975         self.0
 976     }
 977
 978     pub fn as_ref(&self) -> Binder<&T> {
 979         Binder(&self.0)
 980     }
 981
 982     pub fn map_bound_ref<F, U>(&self, f: F) -> Binder<U>
 983     where
 984         F: FnOnce(&T) -> U,
 985     {
 986         self.as_ref().map_bound(f)
 987     }
 988
 989     pub fn map_bound<F, U>(self, f: F) -> Binder<U>
 990     where
 991         F: FnOnce(T) -> U,
 992     {
 993         Binder(f(self.0))
 994     }
 995
 996     /// Unwraps and returns the value within, but only if it contains
 997     /// no bound vars at all. (In other words, if this binder --
 998     /// and indeed any enclosing binder -- doesn't bind anything at
 999     /// all.) Otherwise, returns `None`.
1000     ///
1001     /// (One could imagine having a method that just unwraps a single
1002     /// binder, but permits late-bound vars bound by enclosing
1003     /// binders, but that would require adjusting the debruijn
1004     /// indices, and given the shallow binding structure we often use,
1005     /// would not be that useful.)
1006     pub fn no_bound_vars<'tcx>(self) -> Option<T>
1007     where
1008         T: TypeFoldable<'tcx>,
1009     {
1010         if self.0.has_escaping_bound_vars() { None } else { Some(self.skip_binder()) }
1011     }
1012
1013     /// Given two things that have the same binder level,
1014     /// and an operation that wraps on their contents, executes the operation
1015     /// and then wraps its result.
1016     ///
1017     /// `f` should consider bound regions at depth 1 to be free, and
1018     /// anything it produces with bound regions at depth 1 will be
1019     /// bound in the resulting return value.
1020     pub fn fuse<U, F, R>(self, u: Binder<U>, f: F) -> Binder<R>
1021     where
1022         F: FnOnce(T, U) -> R,
1023     {
1024         Binder(f(self.0, u.0))
1025     }
1026
1027     /// Splits the contents into two things that share the same binder
1028     /// level as the original, returning two distinct binders.
1029     ///
1030     /// `f` should consider bound regions at depth 1 to be free, and
1031     /// anything it produces with bound regions at depth 1 will be
1032     /// bound in the resulting return values.
1033     pub fn split<U, V, F>(self, f: F) -> (Binder<U>, Binder<V>)
1034     where
1035         F: FnOnce(T) -> (U, V),
1036     {
1037         let (u, v) = f(self.0);
1038         (Binder(u), Binder(v))
1039     }
1040 }
1041
1042 impl<T> Binder<Option<T>> {
1043     pub fn transpose(self) -> Option<Binder<T>> {
1044         match self.0 {
1045             Some(v) => Some(Binder(v)),
1046             None => None,
1047         }
1048     }
1049 }
1050
1051 /// Represents the projection of an associated type. In explicit UFCS
1052 /// form this would be written `<T as Trait<..>>::N`.
1053 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1054 #[derive(HashStable, TypeFoldable)]
1055 pub struct ProjectionTy<'tcx> {
1056     /// The parameters of the associated item.
1057     pub substs: SubstsRef<'tcx>,
1058
1059     /// The `DefId` of the `TraitItem` for the associated type `N`.
1060     ///
1061     /// Note that this is not the `DefId` of the `TraitRef` containing this
1062     /// associated type, which is in `tcx.associated_item(item_def_id).container`.
1063     pub item_def_id: DefId,
1064 }
1065
1066 impl<'tcx> ProjectionTy<'tcx> {
1067     /// Construct a `ProjectionTy` by searching the trait from `trait_ref` for the
1068     /// associated item named `item_name`.
1069     pub fn from_ref_and_name(
1070         tcx: TyCtxt<'_>,
1071         trait_ref: ty::TraitRef<'tcx>,
1072         item_name: Ident,
1073     ) -> ProjectionTy<'tcx> {
1074         let item_def_id = tcx
1075             .associated_items(trait_ref.def_id)
1076             .find_by_name_and_kind(tcx, item_name, ty::AssocKind::Type, trait_ref.def_id)
1077             .unwrap()
1078             .def_id;
1079
1080         ProjectionTy { substs: trait_ref.substs, item_def_id }
1081     }
1082
1083     /// Extracts the underlying trait reference from this projection.
1084     /// For example, if this is a projection of `<T as Iterator>::Item`,
1085     /// then this function would return a `T: Iterator` trait reference.
1086     pub fn trait_ref(&self, tcx: TyCtxt<'tcx>) -> ty::TraitRef<'tcx> {
1087         let def_id = tcx.associated_item(self.item_def_id).container.id();
1088         ty::TraitRef { def_id, substs: self.substs.truncate_to(tcx, tcx.generics_of(def_id)) }
1089     }
1090
1091     pub fn self_ty(&self) -> Ty<'tcx> {
1092         self.substs.type_at(0)
1093     }
1094 }
1095
1096 #[derive(Copy, Clone, Debug, TypeFoldable)]
1097 pub struct GenSig<'tcx> {
1098     pub resume_ty: Ty<'tcx>,
1099     pub yield_ty: Ty<'tcx>,
1100     pub return_ty: Ty<'tcx>,
1101 }
1102
1103 pub type PolyGenSig<'tcx> = Binder<GenSig<'tcx>>;
1104
1105 impl<'tcx> PolyGenSig<'tcx> {
1106     pub fn resume_ty(&self) -> ty::Binder<Ty<'tcx>> {
1107         self.map_bound_ref(|sig| sig.resume_ty)
1108     }
1109     pub fn yield_ty(&self) -> ty::Binder<Ty<'tcx>> {
1110         self.map_bound_ref(|sig| sig.yield_ty)
1111     }
1112     pub fn return_ty(&self) -> ty::Binder<Ty<'tcx>> {
1113         self.map_bound_ref(|sig| sig.return_ty)
1114     }
1115 }
1116
1117 /// Signature of a function type, which we have arbitrarily
1118 /// decided to use to refer to the input/output types.
1119 ///
1120 /// - `inputs`: is the list of arguments and their modes.
1121 /// - `output`: is the return type.
1122 /// - `c_variadic`: indicates whether this is a C-variadic function.
1123 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1124 #[derive(HashStable, TypeFoldable)]
1125 pub struct FnSig<'tcx> {
1126     pub inputs_and_output: &'tcx List<Ty<'tcx>>,
1127     pub c_variadic: bool,
1128     pub unsafety: hir::Unsafety,
1129     pub abi: abi::Abi,
1130 }
1131
1132 impl<'tcx> FnSig<'tcx> {
1133     pub fn inputs(&self) -> &'tcx [Ty<'tcx>] {
1134         &self.inputs_and_output[..self.inputs_and_output.len() - 1]
1135     }
1136
1137     pub fn output(&self) -> Ty<'tcx> {
1138         self.inputs_and_output[self.inputs_and_output.len() - 1]
1139     }
1140
1141     // Creates a minimal `FnSig` to be used when encountering a `TyKind::Error` in a fallible
1142     // method.
1143     fn fake() -> FnSig<'tcx> {
1144         FnSig {
1145             inputs_and_output: List::empty(),
1146             c_variadic: false,
1147             unsafety: hir::Unsafety::Normal,
1148             abi: abi::Abi::Rust,
1149         }
1150     }
1151 }
1152
1153 pub type PolyFnSig<'tcx> = Binder<FnSig<'tcx>>;
1154
1155 impl<'tcx> PolyFnSig<'tcx> {
1156     #[inline]
1157     pub fn inputs(&self) -> Binder<&'tcx [Ty<'tcx>]> {
1158         self.map_bound_ref(|fn_sig| fn_sig.inputs())
1159     }
1160     #[inline]
1161     pub fn input(&self, index: usize) -> ty::Binder<Ty<'tcx>> {
1162         self.map_bound_ref(|fn_sig| fn_sig.inputs()[index])
1163     }
1164     pub fn inputs_and_output(&self) -> ty::Binder<&'tcx List<Ty<'tcx>>> {
1165         self.map_bound_ref(|fn_sig| fn_sig.inputs_and_output)
1166     }
1167     #[inline]
1168     pub fn output(&self) -> ty::Binder<Ty<'tcx>> {
1169         self.map_bound_ref(|fn_sig| fn_sig.output())
1170     }
1171     pub fn c_variadic(&self) -> bool {
1172         self.skip_binder().c_variadic
1173     }
1174     pub fn unsafety(&self) -> hir::Unsafety {
1175         self.skip_binder().unsafety
1176     }
1177     pub fn abi(&self) -> abi::Abi {
1178         self.skip_binder().abi
1179     }
1180 }
1181
1182 pub type CanonicalPolyFnSig<'tcx> = Canonical<'tcx, Binder<FnSig<'tcx>>>;
1183
1184 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1185 #[derive(HashStable)]
1186 pub struct ParamTy {
1187     pub index: u32,
1188     pub name: Symbol,
1189 }
1190
1191 impl<'tcx> ParamTy {
1192     pub fn new(index: u32, name: Symbol) -> ParamTy {
1193         ParamTy { index, name }
1194     }
1195
1196     pub fn for_self() -> ParamTy {
1197         ParamTy::new(0, kw::SelfUpper)
1198     }
1199
1200     pub fn for_def(def: &ty::GenericParamDef) -> ParamTy {
1201         ParamTy::new(def.index, def.name)
1202     }
1203
1204     pub fn to_ty(self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
1205         tcx.mk_ty_param(self.index, self.name)
1206     }
1207 }
1208
1209 #[derive(Copy, Clone, Hash, TyEncodable, TyDecodable, Eq, PartialEq, Ord, PartialOrd)]
1210 #[derive(HashStable)]
1211 pub struct ParamConst {
1212     pub index: u32,
1213     pub name: Symbol,
1214 }
1215
1216 impl<'tcx> ParamConst {
1217     pub fn new(index: u32, name: Symbol) -> ParamConst {
1218         ParamConst { index, name }
1219     }
1220
1221     pub fn for_def(def: &ty::GenericParamDef) -> ParamConst {
1222         ParamConst::new(def.index, def.name)
1223     }
1224
1225     pub fn to_const(self, tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> &'tcx ty::Const<'tcx> {
1226         tcx.mk_const_param(self.index, self.name, ty)
1227     }
1228 }
1229
1230 rustc_index::newtype_index! {
1231     /// A [De Bruijn index][dbi] is a standard means of representing
1232     /// regions (and perhaps later types) in a higher-ranked setting. In
1233     /// particular, imagine a type like this:
1234     ///
1235     ///     for<'a> fn(for<'b> fn(&'b isize, &'a isize), &'a char)
1236     ///     ^          ^            |        |         |
1237     ///     |          |            |        |         |
1238     ///     |          +------------+ 0      |         |
1239     ///     |                                |         |
1240     ///     +--------------------------------+ 1       |
1241     ///     |                                          |
1242     ///     +------------------------------------------+ 0
1243     ///
1244     /// In this type, there are two binders (the outer fn and the inner
1245     /// fn). We need to be able to determine, for any given region, which
1246     /// fn type it is bound by, the inner or the outer one. There are
1247     /// various ways you can do this, but a De Bruijn index is one of the
1248     /// more convenient and has some nice properties. The basic idea is to
1249     /// count the number of binders, inside out. Some examples should help
1250     /// clarify what I mean.
1251     ///
1252     /// Let's start with the reference type `&'b isize` that is the first
1253     /// argument to the inner function. This region `'b` is assigned a De
1254     /// Bruijn index of 0, meaning "the innermost binder" (in this case, a
1255     /// fn). The region `'a` that appears in the second argument type (`&'a
1256     /// isize`) would then be assigned a De Bruijn index of 1, meaning "the
1257     /// second-innermost binder". (These indices are written on the arrays
1258     /// in the diagram).
1259     ///
1260     /// What is interesting is that De Bruijn index attached to a particular
1261     /// variable will vary depending on where it appears. For example,
1262     /// the final type `&'a char` also refers to the region `'a` declared on
1263     /// the outermost fn. But this time, this reference is not nested within
1264     /// any other binders (i.e., it is not an argument to the inner fn, but
1265     /// rather the outer one). Therefore, in this case, it is assigned a
1266     /// De Bruijn index of 0, because the innermost binder in that location
1267     /// is the outer fn.
1268     ///
1269     /// [dbi]: https://en.wikipedia.org/wiki/De_Bruijn_index
1270     #[derive(HashStable)]
1271     pub struct DebruijnIndex {
1272         DEBUG_FORMAT = "DebruijnIndex({})",
1273         const INNERMOST = 0,
1274     }
1275 }
1276
1277 pub type Region<'tcx> = &'tcx RegionKind;
1278
1279 /// Representation of regions. Note that the NLL checker uses a distinct
1280 /// representation of regions. For this reason, it internally replaces all the
1281 /// regions with inference variables -- the index of the variable is then used
1282 /// to index into internal NLL data structures. See `rustc_mir::borrow_check`
1283 /// module for more information.
1284 ///
1285 /// ## The Region lattice within a given function
1286 ///
1287 /// In general, the region lattice looks like
1288 ///
1289 /// ```
1290 /// static ----------+-----...------+       (greatest)
1291 /// |                |              |
1292 /// early-bound and  |              |
1293 /// free regions     |              |
1294 /// |                |              |
1295 /// |                |              |
1296 /// empty(root)   placeholder(U1)   |
1297 /// |            /                  |
1298 /// |           /         placeholder(Un)
1299 /// empty(U1) --         /
1300 /// |                   /
1301 /// ...                /
1302 /// |                 /
1303 /// empty(Un) --------                      (smallest)
1304 /// ```
1305 ///
1306 /// Early-bound/free regions are the named lifetimes in scope from the
1307 /// function declaration. They have relationships to one another
1308 /// determined based on the declared relationships from the
1309 /// function.
1310 ///
1311 /// Note that inference variables and bound regions are not included
1312 /// in this diagram. In the case of inference variables, they should
1313 /// be inferred to some other region from the diagram.  In the case of
1314 /// bound regions, they are excluded because they don't make sense to
1315 /// include -- the diagram indicates the relationship between free
1316 /// regions.
1317 ///
1318 /// ## Inference variables
1319 ///
1320 /// During region inference, we sometimes create inference variables,
1321 /// represented as `ReVar`. These will be inferred by the code in
1322 /// `infer::lexical_region_resolve` to some free region from the
1323 /// lattice above (the minimal region that meets the
1324 /// constraints).
1325 ///
1326 /// During NLL checking, where regions are defined differently, we
1327 /// also use `ReVar` -- in that case, the index is used to index into
1328 /// the NLL region checker's data structures. The variable may in fact
1329 /// represent either a free region or an inference variable, in that
1330 /// case.
1331 ///
1332 /// ## Bound Regions
1333 ///
1334 /// These are regions that are stored behind a binder and must be substituted
1335 /// with some concrete region before being used. There are two kind of
1336 /// bound regions: early-bound, which are bound in an item's `Generics`,
1337 /// and are substituted by a `InternalSubsts`, and late-bound, which are part of
1338 /// higher-ranked types (e.g., `for<'a> fn(&'a ())`), and are substituted by
1339 /// the likes of `liberate_late_bound_regions`. The distinction exists
1340 /// because higher-ranked lifetimes aren't supported in all places. See [1][2].
1341 ///
1342 /// Unlike `Param`s, bound regions are not supposed to exist "in the wild"
1343 /// outside their binder, e.g., in types passed to type inference, and
1344 /// should first be substituted (by placeholder regions, free regions,
1345 /// or region variables).
1346 ///
1347 /// ## Placeholder and Free Regions
1348 ///
1349 /// One often wants to work with bound regions without knowing their precise
1350 /// identity. For example, when checking a function, the lifetime of a borrow
1351 /// can end up being assigned to some region parameter. In these cases,
1352 /// it must be ensured that bounds on the region can't be accidentally
1353 /// assumed without being checked.
1354 ///
1355 /// To do this, we replace the bound regions with placeholder markers,
1356 /// which don't satisfy any relation not explicitly provided.
1357 ///
1358 /// There are two kinds of placeholder regions in rustc: `ReFree` and
1359 /// `RePlaceholder`. When checking an item's body, `ReFree` is supposed
1360 /// to be used. These also support explicit bounds: both the internally-stored
1361 /// *scope*, which the region is assumed to outlive, as well as other
1362 /// relations stored in the `FreeRegionMap`. Note that these relations
1363 /// aren't checked when you `make_subregion` (or `eq_types`), only by
1364 /// `resolve_regions_and_report_errors`.
1365 ///
1366 /// When working with higher-ranked types, some region relations aren't
1367 /// yet known, so you can't just call `resolve_regions_and_report_errors`.
1368 /// `RePlaceholder` is designed for this purpose. In these contexts,
1369 /// there's also the risk that some inference variable laying around will
1370 /// get unified with your placeholder region: if you want to check whether
1371 /// `for<'a> Foo<'_>: 'a`, and you substitute your bound region `'a`
1372 /// with a placeholder region `'%a`, the variable `'_` would just be
1373 /// instantiated to the placeholder region `'%a`, which is wrong because
1374 /// the inference variable is supposed to satisfy the relation
1375 /// *for every value of the placeholder region*. To ensure that doesn't
1376 /// happen, you can use `leak_check`. This is more clearly explained
1377 /// by the [rustc dev guide].
1378 ///
1379 /// [1]: http://smallcultfollowing.com/babysteps/blog/2013/10/29/intermingled-parameter-lists/
1380 /// [2]: http://smallcultfollowing.com/babysteps/blog/2013/11/04/intermingled-parameter-lists/
1381 /// [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/traits/hrtb.html
1382 #[derive(Clone, PartialEq, Eq, Hash, Copy, TyEncodable, TyDecodable, PartialOrd, Ord)]
1383 pub enum RegionKind {
1384     /// Region bound in a type or fn declaration which will be
1385     /// substituted 'early' -- that is, at the same time when type
1386     /// parameters are substituted.
1387     ReEarlyBound(EarlyBoundRegion),
1388
1389     /// Region bound in a function scope, which will be substituted when the
1390     /// function is called.
1391     ReLateBound(DebruijnIndex, BoundRegion),
1392
1393     /// When checking a function body, the types of all arguments and so forth
1394     /// that refer to bound region parameters are modified to refer to free
1395     /// region parameters.
1396     ReFree(FreeRegion),
1397
1398     /// Static data that has an "infinite" lifetime. Top in the region lattice.
1399     ReStatic,
1400
1401     /// A region variable. Should not exist after typeck.
1402     ReVar(RegionVid),
1403
1404     /// A placeholder region -- basically, the higher-ranked version of `ReFree`.
1405     /// Should not exist after typeck.
1406     RePlaceholder(ty::PlaceholderRegion),
1407
1408     /// Empty lifetime is for data that is never accessed.  We tag the
1409     /// empty lifetime with a universe -- the idea is that we don't
1410     /// want `exists<'a> { forall<'b> { 'b: 'a } }` to be satisfiable.
1411     /// Therefore, the `'empty` in a universe `U` is less than all
1412     /// regions visible from `U`, but not less than regions not visible
1413     /// from `U`.
1414     ReEmpty(ty::UniverseIndex),
1415
1416     /// Erased region, used by trait selection, in MIR and during codegen.
1417     ReErased,
1418 }
1419
1420 #[derive(Copy, Clone, PartialEq, Eq, Hash, TyEncodable, TyDecodable, Debug, PartialOrd, Ord)]
1421 pub struct EarlyBoundRegion {
1422     pub def_id: DefId,
1423     pub index: u32,
1424     pub name: Symbol,
1425 }
1426
1427 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1428 pub struct TyVid {
1429     pub index: u32,
1430 }
1431
1432 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1433 pub struct ConstVid<'tcx> {
1434     pub index: u32,
1435     pub phantom: PhantomData<&'tcx ()>,
1436 }
1437
1438 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1439 pub struct IntVid {
1440     pub index: u32,
1441 }
1442
1443 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1444 pub struct FloatVid {
1445     pub index: u32,
1446 }
1447
1448 rustc_index::newtype_index! {
1449     pub struct RegionVid {
1450         DEBUG_FORMAT = custom,
1451     }
1452 }
1453
1454 impl Atom for RegionVid {
1455     fn index(self) -> usize {
1456         Idx::index(self)
1457     }
1458 }
1459
1460 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1461 #[derive(HashStable)]
1462 pub enum InferTy {
1463     TyVar(TyVid),
1464     IntVar(IntVid),
1465     FloatVar(FloatVid),
1466
1467     /// A `FreshTy` is one that is generated as a replacement for an
1468     /// unbound type variable. This is convenient for caching etc. See
1469     /// `infer::freshen` for more details.
1470     FreshTy(u32),
1471     FreshIntTy(u32),
1472     FreshFloatTy(u32),
1473 }
1474
1475 rustc_index::newtype_index! {
1476     pub struct BoundVar { .. }
1477 }
1478
1479 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1480 #[derive(HashStable)]
1481 pub struct BoundTy {
1482     pub var: BoundVar,
1483     pub kind: BoundTyKind,
1484 }
1485
1486 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1487 #[derive(HashStable)]
1488 pub enum BoundTyKind {
1489     Anon,
1490     Param(Symbol),
1491 }
1492
1493 impl From<BoundVar> for BoundTy {
1494     fn from(var: BoundVar) -> Self {
1495         BoundTy { var, kind: BoundTyKind::Anon }
1496     }
1497 }
1498
1499 /// A `ProjectionPredicate` for an `ExistentialTraitRef`.
1500 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1501 #[derive(HashStable, TypeFoldable)]
1502 pub struct ExistentialProjection<'tcx> {
1503     pub item_def_id: DefId,
1504     pub substs: SubstsRef<'tcx>,
1505     pub ty: Ty<'tcx>,
1506 }
1507
1508 pub type PolyExistentialProjection<'tcx> = Binder<ExistentialProjection<'tcx>>;
1509
1510 impl<'tcx> ExistentialProjection<'tcx> {
1511     /// Extracts the underlying existential trait reference from this projection.
1512     /// For example, if this is a projection of `exists T. <T as Iterator>::Item == X`,
1513     /// then this function would return a `exists T. T: Iterator` existential trait
1514     /// reference.
1515     pub fn trait_ref(&self, tcx: TyCtxt<'_>) -> ty::ExistentialTraitRef<'tcx> {
1516         let def_id = tcx.associated_item(self.item_def_id).container.id();
1517         ty::ExistentialTraitRef { def_id, substs: self.substs }
1518     }
1519
1520     pub fn with_self_ty(
1521         &self,
1522         tcx: TyCtxt<'tcx>,
1523         self_ty: Ty<'tcx>,
1524     ) -> ty::ProjectionPredicate<'tcx> {
1525         // otherwise the escaping regions would be captured by the binders
1526         debug_assert!(!self_ty.has_escaping_bound_vars());
1527
1528         ty::ProjectionPredicate {
1529             projection_ty: ty::ProjectionTy {
1530                 item_def_id: self.item_def_id,
1531                 substs: tcx.mk_substs_trait(self_ty, self.substs),
1532             },
1533             ty: self.ty,
1534         }
1535     }
1536 }
1537
1538 impl<'tcx> PolyExistentialProjection<'tcx> {
1539     pub fn with_self_ty(
1540         &self,
1541         tcx: TyCtxt<'tcx>,
1542         self_ty: Ty<'tcx>,
1543     ) -> ty::PolyProjectionPredicate<'tcx> {
1544         self.map_bound(|p| p.with_self_ty(tcx, self_ty))
1545     }
1546
1547     pub fn item_def_id(&self) -> DefId {
1548         self.skip_binder().item_def_id
1549     }
1550 }
1551
1552 impl DebruijnIndex {
1553     /// Returns the resulting index when this value is moved into
1554     /// `amount` number of new binders. So, e.g., if you had
1555     ///
1556     ///    for<'a> fn(&'a x)
1557     ///
1558     /// and you wanted to change it to
1559     ///
1560     ///    for<'a> fn(for<'b> fn(&'a x))
1561     ///
1562     /// you would need to shift the index for `'a` into a new binder.
1563     #[must_use]
1564     pub fn shifted_in(self, amount: u32) -> DebruijnIndex {
1565         DebruijnIndex::from_u32(self.as_u32() + amount)
1566     }
1567
1568     /// Update this index in place by shifting it "in" through
1569     /// `amount` number of binders.
1570     pub fn shift_in(&mut self, amount: u32) {
1571         *self = self.shifted_in(amount);
1572     }
1573
1574     /// Returns the resulting index when this value is moved out from
1575     /// `amount` number of new binders.
1576     #[must_use]
1577     pub fn shifted_out(self, amount: u32) -> DebruijnIndex {
1578         DebruijnIndex::from_u32(self.as_u32() - amount)
1579     }
1580
1581     /// Update in place by shifting out from `amount` binders.
1582     pub fn shift_out(&mut self, amount: u32) {
1583         *self = self.shifted_out(amount);
1584     }
1585
1586     /// Adjusts any De Bruijn indices so as to make `to_binder` the
1587     /// innermost binder. That is, if we have something bound at `to_binder`,
1588     /// it will now be bound at INNERMOST. This is an appropriate thing to do
1589     /// when moving a region out from inside binders:
1590     ///
1591     /// ```
1592     ///             for<'a>   fn(for<'b>   for<'c>   fn(&'a u32), _)
1593     /// // Binder:  D3           D2        D1            ^^
1594     /// ```
1595     ///
1596     /// Here, the region `'a` would have the De Bruijn index D3,
1597     /// because it is the bound 3 binders out. However, if we wanted
1598     /// to refer to that region `'a` in the second argument (the `_`),
1599     /// those two binders would not be in scope. In that case, we
1600     /// might invoke `shift_out_to_binder(D3)`. This would adjust the
1601     /// De Bruijn index of `'a` to D1 (the innermost binder).
1602     ///
1603     /// If we invoke `shift_out_to_binder` and the region is in fact
1604     /// bound by one of the binders we are shifting out of, that is an
1605     /// error (and should fail an assertion failure).
1606     pub fn shifted_out_to_binder(self, to_binder: DebruijnIndex) -> Self {
1607         self.shifted_out(to_binder.as_u32() - INNERMOST.as_u32())
1608     }
1609 }
1610
1611 /// Region utilities
1612 impl RegionKind {
1613     /// Is this region named by the user?
1614     pub fn has_name(&self) -> bool {
1615         match *self {
1616             RegionKind::ReEarlyBound(ebr) => ebr.has_name(),
1617             RegionKind::ReLateBound(_, br) => br.is_named(),
1618             RegionKind::ReFree(fr) => fr.bound_region.is_named(),
1619             RegionKind::ReStatic => true,
1620             RegionKind::ReVar(..) => false,
1621             RegionKind::RePlaceholder(placeholder) => placeholder.name.is_named(),
1622             RegionKind::ReEmpty(_) => false,
1623             RegionKind::ReErased => false,
1624         }
1625     }
1626
1627     pub fn is_late_bound(&self) -> bool {
1628         match *self {
1629             ty::ReLateBound(..) => true,
1630             _ => false,
1631         }
1632     }
1633
1634     pub fn is_placeholder(&self) -> bool {
1635         match *self {
1636             ty::RePlaceholder(..) => true,
1637             _ => false,
1638         }
1639     }
1640
1641     pub fn bound_at_or_above_binder(&self, index: DebruijnIndex) -> bool {
1642         match *self {
1643             ty::ReLateBound(debruijn, _) => debruijn >= index,
1644             _ => false,
1645         }
1646     }
1647
1648     /// Adjusts any De Bruijn indices so as to make `to_binder` the
1649     /// innermost binder. That is, if we have something bound at `to_binder`,
1650     /// it will now be bound at INNERMOST. This is an appropriate thing to do
1651     /// when moving a region out from inside binders:
1652     ///
1653     /// ```
1654     ///             for<'a>   fn(for<'b>   for<'c>   fn(&'a u32), _)
1655     /// // Binder:  D3           D2        D1            ^^
1656     /// ```
1657     ///
1658     /// Here, the region `'a` would have the De Bruijn index D3,
1659     /// because it is the bound 3 binders out. However, if we wanted
1660     /// to refer to that region `'a` in the second argument (the `_`),
1661     /// those two binders would not be in scope. In that case, we
1662     /// might invoke `shift_out_to_binder(D3)`. This would adjust the
1663     /// De Bruijn index of `'a` to D1 (the innermost binder).
1664     ///
1665     /// If we invoke `shift_out_to_binder` and the region is in fact
1666     /// bound by one of the binders we are shifting out of, that is an
1667     /// error (and should fail an assertion failure).
1668     pub fn shifted_out_to_binder(&self, to_binder: ty::DebruijnIndex) -> RegionKind {
1669         match *self {
1670             ty::ReLateBound(debruijn, r) => {
1671                 ty::ReLateBound(debruijn.shifted_out_to_binder(to_binder), r)
1672             }
1673             r => r,
1674         }
1675     }
1676
1677     pub fn type_flags(&self) -> TypeFlags {
1678         let mut flags = TypeFlags::empty();
1679
1680         match *self {
1681             ty::ReVar(..) => {
1682                 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1683                 flags = flags | TypeFlags::HAS_FREE_LOCAL_REGIONS;
1684                 flags = flags | TypeFlags::HAS_RE_INFER;
1685             }
1686             ty::RePlaceholder(..) => {
1687                 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1688                 flags = flags | TypeFlags::HAS_FREE_LOCAL_REGIONS;
1689                 flags = flags | TypeFlags::HAS_RE_PLACEHOLDER;
1690             }
1691             ty::ReEarlyBound(..) => {
1692                 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1693                 flags = flags | TypeFlags::HAS_FREE_LOCAL_REGIONS;
1694                 flags = flags | TypeFlags::HAS_RE_PARAM;
1695             }
1696             ty::ReFree { .. } => {
1697                 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1698                 flags = flags | TypeFlags::HAS_FREE_LOCAL_REGIONS;
1699             }
1700             ty::ReEmpty(_) | ty::ReStatic => {
1701                 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1702             }
1703             ty::ReLateBound(..) => {
1704                 flags = flags | TypeFlags::HAS_RE_LATE_BOUND;
1705             }
1706             ty::ReErased => {
1707                 flags = flags | TypeFlags::HAS_RE_ERASED;
1708             }
1709         }
1710
1711         debug!("type_flags({:?}) = {:?}", self, flags);
1712
1713         flags
1714     }
1715
1716     /// Given an early-bound or free region, returns the `DefId` where it was bound.
1717     /// For example, consider the regions in this snippet of code:
1718     ///
1719     /// ```
1720     /// impl<'a> Foo {
1721     ///      ^^ -- early bound, declared on an impl
1722     ///
1723     ///     fn bar<'b, 'c>(x: &self, y: &'b u32, z: &'c u64) where 'static: 'c
1724     ///            ^^  ^^     ^ anonymous, late-bound
1725     ///            |   early-bound, appears in where-clauses
1726     ///            late-bound, appears only in fn args
1727     ///     {..}
1728     /// }
1729     /// ```
1730     ///
1731     /// Here, `free_region_binding_scope('a)` would return the `DefId`
1732     /// of the impl, and for all the other highlighted regions, it
1733     /// would return the `DefId` of the function. In other cases (not shown), this
1734     /// function might return the `DefId` of a closure.
1735     pub fn free_region_binding_scope(&self, tcx: TyCtxt<'_>) -> DefId {
1736         match self {
1737             ty::ReEarlyBound(br) => tcx.parent(br.def_id).unwrap(),
1738             ty::ReFree(fr) => fr.scope,
1739             _ => bug!("free_region_binding_scope invoked on inappropriate region: {:?}", self),
1740         }
1741     }
1742 }
1743
1744 /// Type utilities
1745 impl<'tcx> TyS<'tcx> {
1746     #[inline(always)]
1747     pub fn kind(&self) -> &TyKind<'tcx> {
1748         &self.kind
1749     }
1750
1751     #[inline(always)]
1752     pub fn flags(&self) -> TypeFlags {
1753         self.flags
1754     }
1755
1756     #[inline]
1757     pub fn is_unit(&self) -> bool {
1758         match self.kind() {
1759             Tuple(ref tys) => tys.is_empty(),
1760             _ => false,
1761         }
1762     }
1763
1764     #[inline]
1765     pub fn is_never(&self) -> bool {
1766         match self.kind() {
1767             Never => true,
1768             _ => false,
1769         }
1770     }
1771
1772     /// Checks whether a type is definitely uninhabited. This is
1773     /// conservative: for some types that are uninhabited we return `false`,
1774     /// but we only return `true` for types that are definitely uninhabited.
1775     /// `ty.conservative_is_privately_uninhabited` implies that any value of type `ty`
1776     /// will be `Abi::Uninhabited`. (Note that uninhabited types may have nonzero
1777     /// size, to account for partial initialisation. See #49298 for details.)
1778     pub fn conservative_is_privately_uninhabited(&self, tcx: TyCtxt<'tcx>) -> bool {
1779         // FIXME(varkor): we can make this less conversative by substituting concrete
1780         // type arguments.
1781         match self.kind() {
1782             ty::Never => true,
1783             ty::Adt(def, _) if def.is_union() => {
1784                 // For now, `union`s are never considered uninhabited.
1785                 false
1786             }
1787             ty::Adt(def, _) => {
1788                 // Any ADT is uninhabited if either:
1789                 // (a) It has no variants (i.e. an empty `enum`);
1790                 // (b) Each of its variants (a single one in the case of a `struct`) has at least
1791                 //     one uninhabited field.
1792                 def.variants.iter().all(|var| {
1793                     var.fields.iter().any(|field| {
1794                         tcx.type_of(field.did).conservative_is_privately_uninhabited(tcx)
1795                     })
1796                 })
1797             }
1798             ty::Tuple(..) => {
1799                 self.tuple_fields().any(|ty| ty.conservative_is_privately_uninhabited(tcx))
1800             }
1801             ty::Array(ty, len) => {
1802                 match len.try_eval_usize(tcx, ParamEnv::empty()) {
1803                     // If the array is definitely non-empty, it's uninhabited if
1804                     // the type of its elements is uninhabited.
1805                     Some(n) if n != 0 => ty.conservative_is_privately_uninhabited(tcx),
1806                     _ => false,
1807                 }
1808             }
1809             ty::Ref(..) => {
1810                 // References to uninitialised memory is valid for any type, including
1811                 // uninhabited types, in unsafe code, so we treat all references as
1812                 // inhabited.
1813                 false
1814             }
1815             _ => false,
1816         }
1817     }
1818
1819     #[inline]
1820     pub fn is_primitive(&self) -> bool {
1821         self.kind().is_primitive()
1822     }
1823
1824     #[inline]
1825     pub fn is_adt(&self) -> bool {
1826         match self.kind() {
1827             Adt(..) => true,
1828             _ => false,
1829         }
1830     }
1831
1832     #[inline]
1833     pub fn is_ref(&self) -> bool {
1834         match self.kind() {
1835             Ref(..) => true,
1836             _ => false,
1837         }
1838     }
1839
1840     #[inline]
1841     pub fn is_ty_var(&self) -> bool {
1842         match self.kind() {
1843             Infer(TyVar(_)) => true,
1844             _ => false,
1845         }
1846     }
1847
1848     #[inline]
1849     pub fn is_ty_infer(&self) -> bool {
1850         match self.kind() {
1851             Infer(_) => true,
1852             _ => false,
1853         }
1854     }
1855
1856     #[inline]
1857     pub fn is_phantom_data(&self) -> bool {
1858         if let Adt(def, _) = self.kind() { def.is_phantom_data() } else { false }
1859     }
1860
1861     #[inline]
1862     pub fn is_bool(&self) -> bool {
1863         *self.kind() == Bool
1864     }
1865
1866     /// Returns `true` if this type is a `str`.
1867     #[inline]
1868     pub fn is_str(&self) -> bool {
1869         *self.kind() == Str
1870     }
1871
1872     #[inline]
1873     pub fn is_param(&self, index: u32) -> bool {
1874         match self.kind() {
1875             ty::Param(ref data) => data.index == index,
1876             _ => false,
1877         }
1878     }
1879
1880     #[inline]
1881     pub fn is_slice(&self) -> bool {
1882         match self.kind() {
1883             RawPtr(TypeAndMut { ty, .. }) | Ref(_, ty, _) => match ty.kind() {
1884                 Slice(_) | Str => true,
1885                 _ => false,
1886             },
1887             _ => false,
1888         }
1889     }
1890
1891     #[inline]
1892     pub fn is_array(&self) -> bool {
1893         match self.kind() {
1894             Array(..) => true,
1895             _ => false,
1896         }
1897     }
1898
1899     #[inline]
1900     pub fn is_simd(&self) -> bool {
1901         match self.kind() {
1902             Adt(def, _) => def.repr.simd(),
1903             _ => false,
1904         }
1905     }
1906
1907     pub fn sequence_element_type(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
1908         match self.kind() {
1909             Array(ty, _) | Slice(ty) => ty,
1910             Str => tcx.mk_mach_uint(ast::UintTy::U8),
1911             _ => bug!("`sequence_element_type` called on non-sequence value: {}", self),
1912         }
1913     }
1914
1915     pub fn simd_type(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
1916         match self.kind() {
1917             Adt(def, substs) => def.non_enum_variant().fields[0].ty(tcx, substs),
1918             _ => bug!("`simd_type` called on invalid type"),
1919         }
1920     }
1921
1922     pub fn simd_size(&self, _tcx: TyCtxt<'tcx>) -> u64 {
1923         // Parameter currently unused, but probably needed in the future to
1924         // allow `#[repr(simd)] struct Simd<T, const N: usize>([T; N]);`.
1925         match self.kind() {
1926             Adt(def, _) => def.non_enum_variant().fields.len() as u64,
1927             _ => bug!("`simd_size` called on invalid type"),
1928         }
1929     }
1930
1931     pub fn simd_size_and_type(&self, tcx: TyCtxt<'tcx>) -> (u64, Ty<'tcx>) {
1932         match self.kind() {
1933             Adt(def, substs) => {
1934                 let variant = def.non_enum_variant();
1935                 (variant.fields.len() as u64, variant.fields[0].ty(tcx, substs))
1936             }
1937             _ => bug!("`simd_size_and_type` called on invalid type"),
1938         }
1939     }
1940
1941     #[inline]
1942     pub fn is_region_ptr(&self) -> bool {
1943         match self.kind() {
1944             Ref(..) => true,
1945             _ => false,
1946         }
1947     }
1948
1949     #[inline]
1950     pub fn is_mutable_ptr(&self) -> bool {
1951         match self.kind() {
1952             RawPtr(TypeAndMut { mutbl: hir::Mutability::Mut, .. })
1953             | Ref(_, _, hir::Mutability::Mut) => true,
1954             _ => false,
1955         }
1956     }
1957
1958     #[inline]
1959     pub fn is_unsafe_ptr(&self) -> bool {
1960         match self.kind() {
1961             RawPtr(_) => true,
1962             _ => false,
1963         }
1964     }
1965
1966     /// Tests if this is any kind of primitive pointer type (reference, raw pointer, fn pointer).
1967     #[inline]
1968     pub fn is_any_ptr(&self) -> bool {
1969         self.is_region_ptr() || self.is_unsafe_ptr() || self.is_fn_ptr()
1970     }
1971
1972     #[inline]
1973     pub fn is_box(&self) -> bool {
1974         match self.kind() {
1975             Adt(def, _) => def.is_box(),
1976             _ => false,
1977         }
1978     }
1979
1980     /// Panics if called on any type other than `Box<T>`.
1981     pub fn boxed_ty(&self) -> Ty<'tcx> {
1982         match self.kind() {
1983             Adt(def, substs) if def.is_box() => substs.type_at(0),
1984             _ => bug!("`boxed_ty` is called on non-box type {:?}", self),
1985         }
1986     }
1987
1988     /// A scalar type is one that denotes an atomic datum, with no sub-components.
1989     /// (A RawPtr is scalar because it represents a non-managed pointer, so its
1990     /// contents are abstract to rustc.)
1991     #[inline]
1992     pub fn is_scalar(&self) -> bool {
1993         match self.kind() {
1994             Bool
1995             | Char
1996             | Int(_)
1997             | Float(_)
1998             | Uint(_)
1999             | Infer(IntVar(_) | FloatVar(_))
2000             | FnDef(..)
2001             | FnPtr(_)
2002             | RawPtr(_) => true,
2003             _ => false,
2004         }
2005     }
2006
2007     /// Returns `true` if this type is a floating point type.
2008     #[inline]
2009     pub fn is_floating_point(&self) -> bool {
2010         match self.kind() {
2011             Float(_) | Infer(FloatVar(_)) => true,
2012             _ => false,
2013         }
2014     }
2015
2016     #[inline]
2017     pub fn is_trait(&self) -> bool {
2018         match self.kind() {
2019             Dynamic(..) => true,
2020             _ => false,
2021         }
2022     }
2023
2024     #[inline]
2025     pub fn is_enum(&self) -> bool {
2026         match self.kind() {
2027             Adt(adt_def, _) => adt_def.is_enum(),
2028             _ => false,
2029         }
2030     }
2031
2032     #[inline]
2033     pub fn is_closure(&self) -> bool {
2034         match self.kind() {
2035             Closure(..) => true,
2036             _ => false,
2037         }
2038     }
2039
2040     #[inline]
2041     pub fn is_generator(&self) -> bool {
2042         match self.kind() {
2043             Generator(..) => true,
2044             _ => false,
2045         }
2046     }
2047
2048     #[inline]
2049     pub fn is_integral(&self) -> bool {
2050         match self.kind() {
2051             Infer(IntVar(_)) | Int(_) | Uint(_) => true,
2052             _ => false,
2053         }
2054     }
2055
2056     #[inline]
2057     pub fn is_fresh_ty(&self) -> bool {
2058         match self.kind() {
2059             Infer(FreshTy(_)) => true,
2060             _ => false,
2061         }
2062     }
2063
2064     #[inline]
2065     pub fn is_fresh(&self) -> bool {
2066         match self.kind() {
2067             Infer(FreshTy(_)) => true,
2068             Infer(FreshIntTy(_)) => true,
2069             Infer(FreshFloatTy(_)) => true,
2070             _ => false,
2071         }
2072     }
2073
2074     #[inline]
2075     pub fn is_char(&self) -> bool {
2076         match self.kind() {
2077             Char => true,
2078             _ => false,
2079         }
2080     }
2081
2082     #[inline]
2083     pub fn is_numeric(&self) -> bool {
2084         self.is_integral() || self.is_floating_point()
2085     }
2086
2087     #[inline]
2088     pub fn is_signed(&self) -> bool {
2089         match self.kind() {
2090             Int(_) => true,
2091             _ => false,
2092         }
2093     }
2094
2095     #[inline]
2096     pub fn is_ptr_sized_integral(&self) -> bool {
2097         match self.kind() {
2098             Int(ast::IntTy::Isize) | Uint(ast::UintTy::Usize) => true,
2099             _ => false,
2100         }
2101     }
2102
2103     #[inline]
2104     pub fn is_machine(&self) -> bool {
2105         match self.kind() {
2106             Int(..) | Uint(..) | Float(..) => true,
2107             _ => false,
2108         }
2109     }
2110
2111     #[inline]
2112     pub fn has_concrete_skeleton(&self) -> bool {
2113         match self.kind() {
2114             Param(_) | Infer(_) | Error(_) => false,
2115             _ => true,
2116         }
2117     }
2118
2119     /// Returns the type and mutability of `*ty`.
2120     ///
2121     /// The parameter `explicit` indicates if this is an *explicit* dereference.
2122     /// Some types -- notably unsafe ptrs -- can only be dereferenced explicitly.
2123     pub fn builtin_deref(&self, explicit: bool) -> Option<TypeAndMut<'tcx>> {
2124         match self.kind() {
2125             Adt(def, _) if def.is_box() => {
2126                 Some(TypeAndMut { ty: self.boxed_ty(), mutbl: hir::Mutability::Not })
2127             }
2128             Ref(_, ty, mutbl) => Some(TypeAndMut { ty, mutbl: *mutbl }),
2129             RawPtr(mt) if explicit => Some(*mt),
2130             _ => None,
2131         }
2132     }
2133
2134     /// Returns the type of `ty[i]`.
2135     pub fn builtin_index(&self) -> Option<Ty<'tcx>> {
2136         match self.kind() {
2137             Array(ty, _) | Slice(ty) => Some(ty),
2138             _ => None,
2139         }
2140     }
2141
2142     pub fn fn_sig(&self, tcx: TyCtxt<'tcx>) -> PolyFnSig<'tcx> {
2143         match self.kind() {
2144             FnDef(def_id, substs) => tcx.fn_sig(*def_id).subst(tcx, substs),
2145             FnPtr(f) => *f,
2146             Error(_) => {
2147                 // ignore errors (#54954)
2148                 ty::Binder::dummy(FnSig::fake())
2149             }
2150             Closure(..) => bug!(
2151                 "to get the signature of a closure, use `substs.as_closure().sig()` not `fn_sig()`",
2152             ),
2153             _ => bug!("Ty::fn_sig() called on non-fn type: {:?}", self),
2154         }
2155     }
2156
2157     #[inline]
2158     pub fn is_fn(&self) -> bool {
2159         match self.kind() {
2160             FnDef(..) | FnPtr(_) => true,
2161             _ => false,
2162         }
2163     }
2164
2165     #[inline]
2166     pub fn is_fn_ptr(&self) -> bool {
2167         match self.kind() {
2168             FnPtr(_) => true,
2169             _ => false,
2170         }
2171     }
2172
2173     #[inline]
2174     pub fn is_impl_trait(&self) -> bool {
2175         match self.kind() {
2176             Opaque(..) => true,
2177             _ => false,
2178         }
2179     }
2180
2181     #[inline]
2182     pub fn ty_adt_def(&self) -> Option<&'tcx AdtDef> {
2183         match self.kind() {
2184             Adt(adt, _) => Some(adt),
2185             _ => None,
2186         }
2187     }
2188
2189     /// Iterates over tuple fields.
2190     /// Panics when called on anything but a tuple.
2191     pub fn tuple_fields(&self) -> impl DoubleEndedIterator<Item = Ty<'tcx>> {
2192         match self.kind() {
2193             Tuple(substs) => substs.iter().map(|field| field.expect_ty()),
2194             _ => bug!("tuple_fields called on non-tuple"),
2195         }
2196     }
2197
2198     /// If the type contains variants, returns the valid range of variant indices.
2199     //
2200     // FIXME: This requires the optimized MIR in the case of generators.
2201     #[inline]
2202     pub fn variant_range(&self, tcx: TyCtxt<'tcx>) -> Option<Range<VariantIdx>> {
2203         match self.kind() {
2204             TyKind::Adt(adt, _) => Some(adt.variant_range()),
2205             TyKind::Generator(def_id, substs, _) => {
2206                 Some(substs.as_generator().variant_range(*def_id, tcx))
2207             }
2208             _ => None,
2209         }
2210     }
2211
2212     /// If the type contains variants, returns the variant for `variant_index`.
2213     /// Panics if `variant_index` is out of range.
2214     //
2215     // FIXME: This requires the optimized MIR in the case of generators.
2216     #[inline]
2217     pub fn discriminant_for_variant(
2218         &self,
2219         tcx: TyCtxt<'tcx>,
2220         variant_index: VariantIdx,
2221     ) -> Option<Discr<'tcx>> {
2222         match self.kind() {
2223             TyKind::Adt(adt, _) if adt.variants.is_empty() => {
2224                 bug!("discriminant_for_variant called on zero variant enum");
2225             }
2226             TyKind::Adt(adt, _) if adt.is_enum() => {
2227                 Some(adt.discriminant_for_variant(tcx, variant_index))
2228             }
2229             TyKind::Generator(def_id, substs, _) => {
2230                 Some(substs.as_generator().discriminant_for_variant(*def_id, tcx, variant_index))
2231             }
2232             _ => None,
2233         }
2234     }
2235
2236     /// Returns the type of the discriminant of this type.
2237     pub fn discriminant_ty(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
2238         match self.kind() {
2239             ty::Adt(adt, _) if adt.is_enum() => adt.repr.discr_type().to_ty(tcx),
2240             ty::Generator(_, substs, _) => substs.as_generator().discr_ty(tcx),
2241             _ => {
2242                 // This can only be `0`, for now, so `u8` will suffice.
2243                 tcx.types.u8
2244             }
2245         }
2246     }
2247
2248     /// When we create a closure, we record its kind (i.e., what trait
2249     /// it implements) into its `ClosureSubsts` using a type
2250     /// parameter. This is kind of a phantom type, except that the
2251     /// most convenient thing for us to are the integral types. This
2252     /// function converts such a special type into the closure
2253     /// kind. To go the other way, use
2254     /// `tcx.closure_kind_ty(closure_kind)`.
2255     ///
2256     /// Note that during type checking, we use an inference variable
2257     /// to represent the closure kind, because it has not yet been
2258     /// inferred. Once upvar inference (in `src/librustc_typeck/check/upvar.rs`)
2259     /// is complete, that type variable will be unified.
2260     pub fn to_opt_closure_kind(&self) -> Option<ty::ClosureKind> {
2261         match self.kind() {
2262             Int(int_ty) => match int_ty {
2263                 ast::IntTy::I8 => Some(ty::ClosureKind::Fn),
2264                 ast::IntTy::I16 => Some(ty::ClosureKind::FnMut),
2265                 ast::IntTy::I32 => Some(ty::ClosureKind::FnOnce),
2266                 _ => bug!("cannot convert type `{:?}` to a closure kind", self),
2267             },
2268
2269             // "Bound" types appear in canonical queries when the
2270             // closure type is not yet known
2271             Bound(..) | Infer(_) => None,
2272
2273             Error(_) => Some(ty::ClosureKind::Fn),
2274
2275             _ => bug!("cannot convert type `{:?}` to a closure kind", self),
2276         }
2277     }
2278
2279     /// Fast path helper for testing if a type is `Sized`.
2280     ///
2281     /// Returning true means the type is known to be sized. Returning
2282     /// `false` means nothing -- could be sized, might not be.
2283     pub fn is_trivially_sized(&self, tcx: TyCtxt<'tcx>) -> bool {
2284         match self.kind() {
2285             ty::Infer(ty::IntVar(_) | ty::FloatVar(_))
2286             | ty::Uint(_)
2287             | ty::Int(_)
2288             | ty::Bool
2289             | ty::Float(_)
2290             | ty::FnDef(..)
2291             | ty::FnPtr(_)
2292             | ty::RawPtr(..)
2293             | ty::Char
2294             | ty::Ref(..)
2295             | ty::Generator(..)
2296             | ty::GeneratorWitness(..)
2297             | ty::Array(..)
2298             | ty::Closure(..)
2299             | ty::Never
2300             | ty::Error(_) => true,
2301
2302             ty::Str | ty::Slice(_) | ty::Dynamic(..) | ty::Foreign(..) => false,
2303
2304             ty::Tuple(tys) => tys.iter().all(|ty| ty.expect_ty().is_trivially_sized(tcx)),
2305
2306             ty::Adt(def, _substs) => def.sized_constraint(tcx).is_empty(),
2307
2308             ty::Projection(_) | ty::Param(_) | ty::Opaque(..) => false,
2309
2310             ty::Infer(ty::TyVar(_)) => false,
2311
2312             ty::Bound(..)
2313             | ty::Placeholder(..)
2314             | ty::Infer(ty::FreshTy(_) | ty::FreshIntTy(_) | ty::FreshFloatTy(_)) => {
2315                 bug!("`is_trivially_sized` applied to unexpected type: {:?}", self)
2316             }
2317         }
2318     }
2319
2320     /// Is this a zero-sized type?
2321     pub fn is_zst(&'tcx self, tcx: TyCtxt<'tcx>, did: DefId) -> bool {
2322         tcx.layout_of(tcx.param_env(did).and(self)).map(|layout| layout.is_zst()).unwrap_or(false)
2323     }
2324 }