compiler/rustc_type_ir/src/lib.rs

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