compiler/rustc_type_ir/src/lib.rs

   1 #![feature(fmt_helpers_for_derive)]
   2 #![feature(min_specialization)]
   3 #![feature(rustc_attrs)]
   4
   5 #[macro_use]
   6 extern crate bitflags;
   7 #[macro_use]
   8 extern crate rustc_macros;
   9
  10 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
  11 use rustc_data_structures::unify::{EqUnifyValue, UnifyKey};
  12 use smallvec::SmallVec;
  13 use std::fmt;
  14 use std::fmt::Debug;
  15 use std::hash::Hash;
  16 use std::mem::discriminant;
  17
  18 pub mod codec;
  19 pub mod sty;
  20
  21 pub use codec::*;
  22 pub use sty::*;
  23
  24 pub trait Interner {
  25     type AdtDef: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  26     type SubstsRef: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  27     type DefId: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  28     type Ty: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  29     type Const: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  30     type Region: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  31     type TypeAndMut: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  32     type Mutability: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  33     type Movability: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  34     type PolyFnSig: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  35     type ListBinderExistentialPredicate: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  36     type BinderListTy: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  37     type ListTy: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  38     type ProjectionTy: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  39     type ParamTy: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  40     type BoundTy: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  41     type PlaceholderType: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  42     type InferTy: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  43     type DelaySpanBugEmitted: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  44     type PredicateKind: Clone + Debug + Hash + PartialEq + Eq;
  45     type AllocId: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  46
  47     type EarlyBoundRegion: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  48     type BoundRegion: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  49     type FreeRegion: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  50     type RegionVid: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  51     type PlaceholderRegion: Clone + Debug + Hash + PartialEq + Eq + PartialOrd + Ord;
  52 }
  53
  54 pub trait InternAs<T: ?Sized, R> {
  55     type Output;
  56     fn intern_with<F>(self, f: F) -> Self::Output
  57     where
  58         F: FnOnce(&T) -> R;
  59 }
  60
  61 impl<I, T, R, E> InternAs<[T], R> for I
  62 where
  63     E: InternIteratorElement<T, R>,
  64     I: Iterator<Item = E>,
  65 {
  66     type Output = E::Output;
  67     fn intern_with<F>(self, f: F) -> Self::Output
  68     where
  69         F: FnOnce(&[T]) -> R,
  70     {
  71         E::intern_with(self, f)
  72     }
  73 }
  74
  75 pub trait InternIteratorElement<T, R>: Sized {
  76     type Output;
  77     fn intern_with<I: Iterator<Item = Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output;
  78 }
  79
  80 impl<T, R> InternIteratorElement<T, R> for T {
  81     type Output = R;
  82     fn intern_with<I: Iterator<Item = Self>, F: FnOnce(&[T]) -> R>(
  83         mut iter: I,
  84         f: F,
  85     ) -> Self::Output {
  86         // This code is hot enough that it's worth specializing for the most
  87         // common length lists, to avoid the overhead of `SmallVec` creation.
  88         // Lengths 0, 1, and 2 typically account for ~95% of cases. If
  89         // `size_hint` is incorrect a panic will occur via an `unwrap` or an
  90         // `assert`.
  91         match iter.size_hint() {
  92             (0, Some(0)) => {
  93                 assert!(iter.next().is_none());
  94                 f(&[])
  95             }
  96             (1, Some(1)) => {
  97                 let t0 = iter.next().unwrap();
  98                 assert!(iter.next().is_none());
  99                 f(&[t0])
 100             }
 101             (2, Some(2)) => {
 102                 let t0 = iter.next().unwrap();
 103                 let t1 = iter.next().unwrap();
 104                 assert!(iter.next().is_none());
 105                 f(&[t0, t1])
 106             }
 107             _ => f(&iter.collect::<SmallVec<[_; 8]>>()),
 108         }
 109     }
 110 }
 111
 112 impl<'a, T, R> InternIteratorElement<T, R> for &'a T
 113 where
 114     T: Clone + 'a,
 115 {
 116     type Output = R;
 117     fn intern_with<I: Iterator<Item = Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output {
 118         // This code isn't hot.
 119         f(&iter.cloned().collect::<SmallVec<[_; 8]>>())
 120     }
 121 }
 122
 123 impl<T, R, E> InternIteratorElement<T, R> for Result<T, E> {
 124     type Output = Result<R, E>;
 125     fn intern_with<I: Iterator<Item = Self>, F: FnOnce(&[T]) -> R>(
 126         mut iter: I,
 127         f: F,
 128     ) -> Self::Output {
 129         // This code is hot enough that it's worth specializing for the most
 130         // common length lists, to avoid the overhead of `SmallVec` creation.
 131         // Lengths 0, 1, and 2 typically account for ~95% of cases. If
 132         // `size_hint` is incorrect a panic will occur via an `unwrap` or an
 133         // `assert`, unless a failure happens first, in which case the result
 134         // will be an error anyway.
 135         Ok(match iter.size_hint() {
 136             (0, Some(0)) => {
 137                 assert!(iter.next().is_none());
 138                 f(&[])
 139             }
 140             (1, Some(1)) => {
 141                 let t0 = iter.next().unwrap()?;
 142                 assert!(iter.next().is_none());
 143                 f(&[t0])
 144             }
 145             (2, Some(2)) => {
 146                 let t0 = iter.next().unwrap()?;
 147                 let t1 = iter.next().unwrap()?;
 148                 assert!(iter.next().is_none());
 149                 f(&[t0, t1])
 150             }
 151             _ => f(&iter.collect::<Result<SmallVec<[_; 8]>, _>>()?),
 152         })
 153     }
 154 }
 155
 156 bitflags! {
 157     /// Flags that we track on types. These flags are propagated upwards
 158     /// through the type during type construction, so that we can quickly check
 159     /// whether the type has various kinds of types in it without recursing
 160     /// over the type itself.
 161     pub struct TypeFlags: u32 {
 162         // Does this have parameters? Used to determine whether substitution is
 163         // required.
 164         /// Does this have `Param`?
 165         const HAS_TY_PARAM                = 1 << 0;
 166         /// Does this have `ReEarlyBound`?
 167         const HAS_RE_PARAM                = 1 << 1;
 168         /// Does this have `ConstKind::Param`?
 169         const HAS_CT_PARAM                = 1 << 2;
 170
 171         const NEEDS_SUBST                 = TypeFlags::HAS_TY_PARAM.bits
 172                                           | TypeFlags::HAS_RE_PARAM.bits
 173                                           | TypeFlags::HAS_CT_PARAM.bits;
 174
 175         /// Does this have `Infer`?
 176         const HAS_TY_INFER                = 1 << 3;
 177         /// Does this have `ReVar`?
 178         const HAS_RE_INFER                = 1 << 4;
 179         /// Does this have `ConstKind::Infer`?
 180         const HAS_CT_INFER                = 1 << 5;
 181
 182         /// Does this have inference variables? Used to determine whether
 183         /// inference is required.
 184         const NEEDS_INFER                 = TypeFlags::HAS_TY_INFER.bits
 185                                           | TypeFlags::HAS_RE_INFER.bits
 186                                           | TypeFlags::HAS_CT_INFER.bits;
 187
 188         /// Does this have `Placeholder`?
 189         const HAS_TY_PLACEHOLDER          = 1 << 6;
 190         /// Does this have `RePlaceholder`?
 191         const HAS_RE_PLACEHOLDER          = 1 << 7;
 192         /// Does this have `ConstKind::Placeholder`?
 193         const HAS_CT_PLACEHOLDER          = 1 << 8;
 194
 195         /// `true` if there are "names" of regions and so forth
 196         /// that are local to a particular fn/inferctxt
 197         const HAS_FREE_LOCAL_REGIONS      = 1 << 9;
 198
 199         /// `true` if there are "names" of types and regions and so forth
 200         /// that are local to a particular fn
 201         const HAS_FREE_LOCAL_NAMES        = TypeFlags::HAS_TY_PARAM.bits
 202                                           | TypeFlags::HAS_CT_PARAM.bits
 203                                           | TypeFlags::HAS_TY_INFER.bits
 204                                           | TypeFlags::HAS_CT_INFER.bits
 205                                           | TypeFlags::HAS_TY_PLACEHOLDER.bits
 206                                           | TypeFlags::HAS_CT_PLACEHOLDER.bits
 207                                           // The `evaluate_obligation` query does not return further
 208                                           // obligations. If it evaluates an obligation with an opaque
 209                                           // type, that opaque type may get compared to another type,
 210                                           // constraining it. We would lose this information.
 211                                           // FIXME: differentiate between crate-local opaque types
 212                                           // and opaque types from other crates, as only opaque types
 213                                           // from the local crate can possibly be a local name
 214                                           | TypeFlags::HAS_TY_OPAQUE.bits
 215                                           // We consider 'freshened' types and constants
 216                                           // to depend on a particular fn.
 217                                           // The freshening process throws away information,
 218                                           // which can make things unsuitable for use in a global
 219                                           // cache. Note that there is no 'fresh lifetime' flag -
 220                                           // freshening replaces all lifetimes with `ReErased`,
 221                                           // which is different from how types/const are freshened.
 222                                           | TypeFlags::HAS_TY_FRESH.bits
 223                                           | TypeFlags::HAS_CT_FRESH.bits
 224                                           | TypeFlags::HAS_FREE_LOCAL_REGIONS.bits;
 225
 226         /// Does this have `Projection`?
 227         const HAS_TY_PROJECTION           = 1 << 10;
 228         /// Does this have `Opaque`?
 229         const HAS_TY_OPAQUE               = 1 << 11;
 230         /// Does this have `ConstKind::Unevaluated`?
 231         const HAS_CT_PROJECTION           = 1 << 12;
 232
 233         /// Could this type be normalized further?
 234         const HAS_PROJECTION              = TypeFlags::HAS_TY_PROJECTION.bits
 235                                           | TypeFlags::HAS_TY_OPAQUE.bits
 236                                           | TypeFlags::HAS_CT_PROJECTION.bits;
 237
 238         /// Is an error type/const reachable?
 239         const HAS_ERROR                   = 1 << 13;
 240
 241         /// Does this have any region that "appears free" in the type?
 242         /// Basically anything but `ReLateBound` and `ReErased`.
 243         const HAS_FREE_REGIONS            = 1 << 14;
 244
 245         /// Does this have any `ReLateBound` regions? Used to check
 246         /// if a global bound is safe to evaluate.
 247         const HAS_RE_LATE_BOUND           = 1 << 15;
 248
 249         /// Does this have any `ReErased` regions?
 250         const HAS_RE_ERASED               = 1 << 16;
 251
 252         /// Does this value have parameters/placeholders/inference variables which could be
 253         /// replaced later, in a way that would change the results of `impl` specialization?
 254         const STILL_FURTHER_SPECIALIZABLE = 1 << 17;
 255
 256         /// Does this value have `InferTy::FreshTy/FreshIntTy/FreshFloatTy`?
 257         const HAS_TY_FRESH                = 1 << 18;
 258
 259         /// Does this value have `InferConst::Fresh`?
 260         const HAS_CT_FRESH                = 1 << 19;
 261     }
 262 }
 263
 264 rustc_index::newtype_index! {
 265     /// A [De Bruijn index][dbi] is a standard means of representing
 266     /// regions (and perhaps later types) in a higher-ranked setting. In
 267     /// particular, imagine a type like this:
 268     /// ```ignore (illustrative)
 269     ///    for<'a> fn(for<'b> fn(&'b isize, &'a isize), &'a char)
 270     /// // ^          ^            |          |           |
 271     /// // |          |            |          |           |
 272     /// // |          +------------+ 0        |           |
 273     /// // |                                  |           |
 274     /// // +----------------------------------+ 1         |
 275     /// // |                                              |
 276     /// // +----------------------------------------------+ 0
 277     /// ```
 278     /// In this type, there are two binders (the outer fn and the inner
 279     /// fn). We need to be able to determine, for any given region, which
 280     /// fn type it is bound by, the inner or the outer one. There are
 281     /// various ways you can do this, but a De Bruijn index is one of the
 282     /// more convenient and has some nice properties. The basic idea is to
 283     /// count the number of binders, inside out. Some examples should help
 284     /// clarify what I mean.
 285     ///
 286     /// Let's start with the reference type `&'b isize` that is the first
 287     /// argument to the inner function. This region `'b` is assigned a De
 288     /// Bruijn index of 0, meaning "the innermost binder" (in this case, a
 289     /// fn). The region `'a` that appears in the second argument type (`&'a
 290     /// isize`) would then be assigned a De Bruijn index of 1, meaning "the
 291     /// second-innermost binder". (These indices are written on the arrows
 292     /// in the diagram).
 293     ///
 294     /// What is interesting is that De Bruijn index attached to a particular
 295     /// variable will vary depending on where it appears. For example,
 296     /// the final type `&'a char` also refers to the region `'a` declared on
 297     /// the outermost fn. But this time, this reference is not nested within
 298     /// any other binders (i.e., it is not an argument to the inner fn, but
 299     /// rather the outer one). Therefore, in this case, it is assigned a
 300     /// De Bruijn index of 0, because the innermost binder in that location
 301     /// is the outer fn.
 302     ///
 303     /// [dbi]: https://en.wikipedia.org/wiki/De_Bruijn_index
 304     pub struct DebruijnIndex {
 305         DEBUG_FORMAT = "DebruijnIndex({})",
 306         const INNERMOST = 0,
 307     }
 308 }
 309
 310 impl DebruijnIndex {
 311     /// Returns the resulting index when this value is moved into
 312     /// `amount` number of new binders. So, e.g., if you had
 313     ///
 314     ///    for<'a> fn(&'a x)
 315     ///
 316     /// and you wanted to change it to
 317     ///
 318     ///    for<'a> fn(for<'b> fn(&'a x))
 319     ///
 320     /// you would need to shift the index for `'a` into a new binder.
 321     #[must_use]
 322     pub fn shifted_in(self, amount: u32) -> DebruijnIndex {
 323         DebruijnIndex::from_u32(self.as_u32() + amount)
 324     }
 325
 326     /// Update this index in place by shifting it "in" through
 327     /// `amount` number of binders.
 328     pub fn shift_in(&mut self, amount: u32) {
 329         *self = self.shifted_in(amount);
 330     }
 331
 332     /// Returns the resulting index when this value is moved out from
 333     /// `amount` number of new binders.
 334     #[must_use]
 335     pub fn shifted_out(self, amount: u32) -> DebruijnIndex {
 336         DebruijnIndex::from_u32(self.as_u32() - amount)
 337     }
 338
 339     /// Update in place by shifting out from `amount` binders.
 340     pub fn shift_out(&mut self, amount: u32) {
 341         *self = self.shifted_out(amount);
 342     }
 343
 344     /// Adjusts any De Bruijn indices so as to make `to_binder` the
 345     /// innermost binder. That is, if we have something bound at `to_binder`,
 346     /// it will now be bound at INNERMOST. This is an appropriate thing to do
 347     /// when moving a region out from inside binders:
 348     ///
 349     /// ```ignore (illustrative)
 350     ///             for<'a>   fn(for<'b>   for<'c>   fn(&'a u32), _)
 351     /// // Binder:  D3           D2        D1            ^^
 352     /// ```
 353     ///
 354     /// Here, the region `'a` would have the De Bruijn index D3,
 355     /// because it is the bound 3 binders out. However, if we wanted
 356     /// to refer to that region `'a` in the second argument (the `_`),
 357     /// those two binders would not be in scope. In that case, we
 358     /// might invoke `shift_out_to_binder(D3)`. This would adjust the
 359     /// De Bruijn index of `'a` to D1 (the innermost binder).
 360     ///
 361     /// If we invoke `shift_out_to_binder` and the region is in fact
 362     /// bound by one of the binders we are shifting out of, that is an
 363     /// error (and should fail an assertion failure).
 364     pub fn shifted_out_to_binder(self, to_binder: DebruijnIndex) -> Self {
 365         self.shifted_out(to_binder.as_u32() - INNERMOST.as_u32())
 366     }
 367 }
 368
 369 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
 370 #[derive(Encodable, Decodable)]
 371 pub enum IntTy {
 372     Isize,
 373     I8,
 374     I16,
 375     I32,
 376     I64,
 377     I128,
 378 }
 379
 380 impl IntTy {
 381     pub fn name_str(&self) -> &'static str {
 382         match *self {
 383             IntTy::Isize => "isize",
 384             IntTy::I8 => "i8",
 385             IntTy::I16 => "i16",
 386             IntTy::I32 => "i32",
 387             IntTy::I64 => "i64",
 388             IntTy::I128 => "i128",
 389         }
 390     }
 391
 392     pub fn bit_width(&self) -> Option<u64> {
 393         Some(match *self {
 394             IntTy::Isize => return None,
 395             IntTy::I8 => 8,
 396             IntTy::I16 => 16,
 397             IntTy::I32 => 32,
 398             IntTy::I64 => 64,
 399             IntTy::I128 => 128,
 400         })
 401     }
 402
 403     pub fn normalize(&self, target_width: u32) -> Self {
 404         match self {
 405             IntTy::Isize => match target_width {
 406                 16 => IntTy::I16,
 407                 32 => IntTy::I32,
 408                 64 => IntTy::I64,
 409                 _ => unreachable!(),
 410             },
 411             _ => *self,
 412         }
 413     }
 414 }
 415
 416 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Copy, Debug)]
 417 #[derive(Encodable, Decodable)]
 418 pub enum UintTy {
 419     Usize,
 420     U8,
 421     U16,
 422     U32,
 423     U64,
 424     U128,
 425 }
 426
 427 impl UintTy {
 428     pub fn name_str(&self) -> &'static str {
 429         match *self {
 430             UintTy::Usize => "usize",
 431             UintTy::U8 => "u8",
 432             UintTy::U16 => "u16",
 433             UintTy::U32 => "u32",
 434             UintTy::U64 => "u64",
 435             UintTy::U128 => "u128",
 436         }
 437     }
 438
 439     pub fn bit_width(&self) -> Option<u64> {
 440         Some(match *self {
 441             UintTy::Usize => return None,
 442             UintTy::U8 => 8,
 443             UintTy::U16 => 16,
 444             UintTy::U32 => 32,
 445             UintTy::U64 => 64,
 446             UintTy::U128 => 128,
 447         })
 448     }
 449
 450     pub fn normalize(&self, target_width: u32) -> Self {
 451         match self {
 452             UintTy::Usize => match target_width {
 453                 16 => UintTy::U16,
 454                 32 => UintTy::U32,
 455                 64 => UintTy::U64,
 456                 _ => unreachable!(),
 457             },
 458             _ => *self,
 459         }
 460     }
 461 }
 462
 463 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
 464 #[derive(Encodable, Decodable)]
 465 pub enum FloatTy {
 466     F32,
 467     F64,
 468 }
 469
 470 impl FloatTy {
 471     pub fn name_str(self) -> &'static str {
 472         match self {
 473             FloatTy::F32 => "f32",
 474             FloatTy::F64 => "f64",
 475         }
 476     }
 477
 478     pub fn bit_width(self) -> u64 {
 479         match self {
 480             FloatTy::F32 => 32,
 481             FloatTy::F64 => 64,
 482         }
 483     }
 484 }
 485
 486 #[derive(Clone, Copy, PartialEq, Eq)]
 487 pub enum IntVarValue {
 488     IntType(IntTy),
 489     UintType(UintTy),
 490 }
 491
 492 #[derive(Clone, Copy, PartialEq, Eq)]
 493 pub struct FloatVarValue(pub FloatTy);
 494
 495 rustc_index::newtype_index! {
 496     /// A **ty**pe **v**ariable **ID**.
 497     pub struct TyVid {
 498         DEBUG_FORMAT = "_#{}t"
 499     }
 500 }
 501
 502 /// An **int**egral (`u32`, `i32`, `usize`, etc.) type **v**ariable **ID**.
 503 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Encodable, Decodable)]
 504 pub struct IntVid {
 505     pub index: u32,
 506 }
 507
 508 /// An **float**ing-point (`f32` or `f64`) type **v**ariable **ID**.
 509 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Encodable, Decodable)]
 510 pub struct FloatVid {
 511     pub index: u32,
 512 }
 513
 514 /// A placeholder for a type that hasn't been inferred yet.
 515 ///
 516 /// E.g., if we have an empty array (`[]`), then we create a fresh
 517 /// type variable for the element type since we won't know until it's
 518 /// used what the element type is supposed to be.
 519 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Encodable, Decodable)]
 520 pub enum InferTy {
 521     /// A type variable.
 522     TyVar(TyVid),
 523     /// An integral type variable (`{integer}`).
 524     ///
 525     /// These are created when the compiler sees an integer literal like
 526     /// `1` that could be several different types (`u8`, `i32`, `u32`, etc.).
 527     /// We don't know until it's used what type it's supposed to be, so
 528     /// we create a fresh type variable.
 529     IntVar(IntVid),
 530     /// A floating-point type variable (`{float}`).
 531     ///
 532     /// These are created when the compiler sees an float literal like
 533     /// `1.0` that could be either an `f32` or an `f64`.
 534     /// We don't know until it's used what type it's supposed to be, so
 535     /// we create a fresh type variable.
 536     FloatVar(FloatVid),
 537
 538     /// A [`FreshTy`][Self::FreshTy] is one that is generated as a replacement
 539     /// for an unbound type variable. This is convenient for caching etc. See
 540     /// `rustc_infer::infer::freshen` for more details.
 541     ///
 542     /// Compare with [`TyVar`][Self::TyVar].
 543     FreshTy(u32),
 544     /// Like [`FreshTy`][Self::FreshTy], but as a replacement for [`IntVar`][Self::IntVar].
 545     FreshIntTy(u32),
 546     /// Like [`FreshTy`][Self::FreshTy], but as a replacement for [`FloatVar`][Self::FloatVar].
 547     FreshFloatTy(u32),
 548 }
 549
 550 /// Raw `TyVid` are used as the unification key for `sub_relations`;
 551 /// they carry no values.
 552 impl UnifyKey for TyVid {
 553     type Value = ();
 554     #[inline]
 555     fn index(&self) -> u32 {
 556         self.as_u32()
 557     }
 558     #[inline]
 559     fn from_index(i: u32) -> TyVid {
 560         TyVid::from_u32(i)
 561     }
 562     fn tag() -> &'static str {
 563         "TyVid"
 564     }
 565 }
 566
 567 impl EqUnifyValue for IntVarValue {}
 568
 569 impl UnifyKey for IntVid {
 570     type Value = Option<IntVarValue>;
 571     #[inline] // make this function eligible for inlining - it is quite hot.
 572     fn index(&self) -> u32 {
 573         self.index
 574     }
 575     #[inline]
 576     fn from_index(i: u32) -> IntVid {
 577         IntVid { index: i }
 578     }
 579     fn tag() -> &'static str {
 580         "IntVid"
 581     }
 582 }
 583
 584 impl EqUnifyValue for FloatVarValue {}
 585
 586 impl UnifyKey for FloatVid {
 587     type Value = Option<FloatVarValue>;
 588     #[inline]
 589     fn index(&self) -> u32 {
 590         self.index
 591     }
 592     #[inline]
 593     fn from_index(i: u32) -> FloatVid {
 594         FloatVid { index: i }
 595     }
 596     fn tag() -> &'static str {
 597         "FloatVid"
 598     }
 599 }
 600
 601 #[derive(Copy, Clone, PartialEq, Decodable, Encodable, Hash)]
 602 pub enum Variance {
 603     Covariant,     // T<A> <: T<B> iff A <: B -- e.g., function return type
 604     Invariant,     // T<A> <: T<B> iff B == A -- e.g., type of mutable cell
 605     Contravariant, // T<A> <: T<B> iff B <: A -- e.g., function param type
 606     Bivariant,     // T<A> <: T<B>            -- e.g., unused type parameter
 607 }
 608
 609 impl Variance {
 610     /// `a.xform(b)` combines the variance of a context with the
 611     /// variance of a type with the following meaning. If we are in a
 612     /// context with variance `a`, and we encounter a type argument in
 613     /// a position with variance `b`, then `a.xform(b)` is the new
 614     /// variance with which the argument appears.
 615     ///
 616     /// Example 1:
 617     /// ```ignore (illustrative)
 618     /// *mut Vec<i32>
 619     /// ```
 620     /// Here, the "ambient" variance starts as covariant. `*mut T` is
 621     /// invariant with respect to `T`, so the variance in which the
 622     /// `Vec<i32>` appears is `Covariant.xform(Invariant)`, which
 623     /// yields `Invariant`. Now, the type `Vec<T>` is covariant with
 624     /// respect to its type argument `T`, and hence the variance of
 625     /// the `i32` here is `Invariant.xform(Covariant)`, which results
 626     /// (again) in `Invariant`.
 627     ///
 628     /// Example 2:
 629     /// ```ignore (illustrative)
 630     /// fn(*const Vec<i32>, *mut Vec<i32)
 631     /// ```
 632     /// The ambient variance is covariant. A `fn` type is
 633     /// contravariant with respect to its parameters, so the variance
 634     /// within which both pointer types appear is
 635     /// `Covariant.xform(Contravariant)`, or `Contravariant`. `*const
 636     /// T` is covariant with respect to `T`, so the variance within
 637     /// which the first `Vec<i32>` appears is
 638     /// `Contravariant.xform(Covariant)` or `Contravariant`. The same
 639     /// is true for its `i32` argument. In the `*mut T` case, the
 640     /// variance of `Vec<i32>` is `Contravariant.xform(Invariant)`,
 641     /// and hence the outermost type is `Invariant` with respect to
 642     /// `Vec<i32>` (and its `i32` argument).
 643     ///
 644     /// Source: Figure 1 of "Taming the Wildcards:
 645     /// Combining Definition- and Use-Site Variance" published in PLDI'11.
 646     pub fn xform(self, v: Variance) -> Variance {
 647         match (self, v) {
 648             // Figure 1, column 1.
 649             (Variance::Covariant, Variance::Covariant) => Variance::Covariant,
 650             (Variance::Covariant, Variance::Contravariant) => Variance::Contravariant,
 651             (Variance::Covariant, Variance::Invariant) => Variance::Invariant,
 652             (Variance::Covariant, Variance::Bivariant) => Variance::Bivariant,
 653
 654             // Figure 1, column 2.
 655             (Variance::Contravariant, Variance::Covariant) => Variance::Contravariant,
 656             (Variance::Contravariant, Variance::Contravariant) => Variance::Covariant,
 657             (Variance::Contravariant, Variance::Invariant) => Variance::Invariant,
 658             (Variance::Contravariant, Variance::Bivariant) => Variance::Bivariant,
 659
 660             // Figure 1, column 3.
 661             (Variance::Invariant, _) => Variance::Invariant,
 662
 663             // Figure 1, column 4.
 664             (Variance::Bivariant, _) => Variance::Bivariant,
 665         }
 666     }
 667 }
 668
 669 impl<CTX> HashStable<CTX> for DebruijnIndex {
 670     fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
 671         self.as_u32().hash_stable(ctx, hasher);
 672     }
 673 }
 674
 675 impl<CTX> HashStable<CTX> for IntTy {
 676     fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
 677         discriminant(self).hash_stable(ctx, hasher);
 678     }
 679 }
 680
 681 impl<CTX> HashStable<CTX> for UintTy {
 682     fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
 683         discriminant(self).hash_stable(ctx, hasher);
 684     }
 685 }
 686
 687 impl<CTX> HashStable<CTX> for FloatTy {
 688     fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
 689         discriminant(self).hash_stable(ctx, hasher);
 690     }
 691 }
 692
 693 impl<CTX> HashStable<CTX> for InferTy {
 694     fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
 695         use InferTy::*;
 696         discriminant(self).hash_stable(ctx, hasher);
 697         match self {
 698             TyVar(v) => v.as_u32().hash_stable(ctx, hasher),
 699             IntVar(v) => v.index.hash_stable(ctx, hasher),
 700             FloatVar(v) => v.index.hash_stable(ctx, hasher),
 701             FreshTy(v) | FreshIntTy(v) | FreshFloatTy(v) => v.hash_stable(ctx, hasher),
 702         }
 703     }
 704 }
 705
 706 impl<CTX> HashStable<CTX> for Variance {
 707     fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
 708         discriminant(self).hash_stable(ctx, hasher);
 709     }
 710 }
 711
 712 impl fmt::Debug for IntVarValue {
 713     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 714         match *self {
 715             IntVarValue::IntType(ref v) => v.fmt(f),
 716             IntVarValue::UintType(ref v) => v.fmt(f),
 717         }
 718     }
 719 }
 720
 721 impl fmt::Debug for FloatVarValue {
 722     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 723         self.0.fmt(f)
 724     }
 725 }
 726
 727 impl fmt::Debug for IntVid {
 728     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 729         write!(f, "_#{}i", self.index)
 730     }
 731 }
 732
 733 impl fmt::Debug for FloatVid {
 734     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 735         write!(f, "_#{}f", self.index)
 736     }
 737 }
 738
 739 impl fmt::Debug for InferTy {
 740     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 741         use InferTy::*;
 742         match *self {
 743             TyVar(ref v) => v.fmt(f),
 744             IntVar(ref v) => v.fmt(f),
 745             FloatVar(ref v) => v.fmt(f),
 746             FreshTy(v) => write!(f, "FreshTy({:?})", v),
 747             FreshIntTy(v) => write!(f, "FreshIntTy({:?})", v),
 748             FreshFloatTy(v) => write!(f, "FreshFloatTy({:?})", v),
 749         }
 750     }
 751 }
 752
 753 impl fmt::Debug for Variance {
 754     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 755         f.write_str(match *self {
 756             Variance::Covariant => "+",
 757             Variance::Contravariant => "-",
 758             Variance::Invariant => "o",
 759             Variance::Bivariant => "*",
 760         })
 761     }
 762 }
 763
 764 impl fmt::Display for InferTy {
 765     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 766         use InferTy::*;
 767         match *self {
 768             TyVar(_) => write!(f, "_"),
 769             IntVar(_) => write!(f, "{}", "{integer}"),
 770             FloatVar(_) => write!(f, "{}", "{float}"),
 771             FreshTy(v) => write!(f, "FreshTy({})", v),
 772             FreshIntTy(v) => write!(f, "FreshIntTy({})", v),
 773             FreshFloatTy(v) => write!(f, "FreshFloatTy({})", v),
 774         }
 775     }
 776 }
 777
 778 rustc_index::newtype_index! {
 779     /// "Universes" are used during type- and trait-checking in the
 780     /// presence of `for<..>` binders to control what sets of names are
 781     /// visible. Universes are arranged into a tree: the root universe
 782     /// contains names that are always visible. Each child then adds a new
 783     /// set of names that are visible, in addition to those of its parent.
 784     /// We say that the child universe "extends" the parent universe with
 785     /// new names.
 786     ///
 787     /// To make this more concrete, consider this program:
 788     ///
 789     /// ```ignore (illustrative)
 790     /// struct Foo { }
 791     /// fn bar<T>(x: T) {
 792     ///   let y: for<'a> fn(&'a u8, Foo) = ...;
 793     /// }
 794     /// ```
 795     ///
 796     /// The struct name `Foo` is in the root universe U0. But the type
 797     /// parameter `T`, introduced on `bar`, is in an extended universe U1
 798     /// -- i.e., within `bar`, we can name both `T` and `Foo`, but outside
 799     /// of `bar`, we cannot name `T`. Then, within the type of `y`, the
 800     /// region `'a` is in a universe U2 that extends U1, because we can
 801     /// name it inside the fn type but not outside.
 802     ///
 803     /// Universes are used to do type- and trait-checking around these
 804     /// "forall" binders (also called **universal quantification**). The
 805     /// idea is that when, in the body of `bar`, we refer to `T` as a
 806     /// type, we aren't referring to any type in particular, but rather a
 807     /// kind of "fresh" type that is distinct from all other types we have
 808     /// actually declared. This is called a **placeholder** type, and we
 809     /// use universes to talk about this. In other words, a type name in
 810     /// universe 0 always corresponds to some "ground" type that the user
 811     /// declared, but a type name in a non-zero universe is a placeholder
 812     /// type -- an idealized representative of "types in general" that we
 813     /// use for checking generic functions.
 814     pub struct UniverseIndex {
 815         DEBUG_FORMAT = "U{}",
 816     }
 817 }
 818
 819 impl UniverseIndex {
 820     pub const ROOT: UniverseIndex = UniverseIndex::from_u32(0);
 821
 822     /// Returns the "next" universe index in order -- this new index
 823     /// is considered to extend all previous universes. This
 824     /// corresponds to entering a `forall` quantifier. So, for
 825     /// example, suppose we have this type in universe `U`:
 826     ///
 827     /// ```ignore (illustrative)
 828     /// for<'a> fn(&'a u32)
 829     /// ```
 830     ///
 831     /// Once we "enter" into this `for<'a>` quantifier, we are in a
 832     /// new universe that extends `U` -- in this new universe, we can
 833     /// name the region `'a`, but that region was not nameable from
 834     /// `U` because it was not in scope there.
 835     pub fn next_universe(self) -> UniverseIndex {
 836         UniverseIndex::from_u32(self.private.checked_add(1).unwrap())
 837     }
 838
 839     /// Returns `true` if `self` can name a name from `other` -- in other words,
 840     /// if the set of names in `self` is a superset of those in
 841     /// `other` (`self >= other`).
 842     pub fn can_name(self, other: UniverseIndex) -> bool {
 843         self.private >= other.private
 844     }
 845
 846     /// Returns `true` if `self` cannot name some names from `other` -- in other
 847     /// words, if the set of names in `self` is a strict subset of
 848     /// those in `other` (`self < other`).
 849     pub fn cannot_name(self, other: UniverseIndex) -> bool {
 850         self.private < other.private
 851     }
 852 }
 853
 854 impl<CTX> HashStable<CTX> for UniverseIndex {
 855     fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
 856         self.private.hash_stable(ctx, hasher);
 857     }
 858 }