compiler/rustc_middle/src/ty/util.rs

   1 //! Miscellaneous type-system utilities that are too small to deserve their own modules.
   2
   3 use crate::middle::codegen_fn_attrs::CodegenFnAttrFlags;
   4 use crate::mir;
   5 use crate::ty::layout::IntegerExt;
   6 use crate::ty::query::TyCtxtAt;
   7 use crate::ty::{
   8     self, DefIdTree, FallibleTypeFolder, Ty, TyCtxt, TypeFoldable, TypeFolder, TypeSuperFoldable,
   9     TypeVisitable,
  10 };
  11 use crate::ty::{GenericArgKind, SubstsRef};
  12 use rustc_apfloat::Float as _;
  13 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  14 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
  15 use rustc_errors::ErrorGuaranteed;
  16 use rustc_hir as hir;
  17 use rustc_hir::def::{CtorOf, DefKind, Res};
  18 use rustc_hir::def_id::DefId;
  19 use rustc_index::bit_set::GrowableBitSet;
  20 use rustc_index::vec::{Idx, IndexVec};
  21 use rustc_macros::HashStable;
  22 use rustc_span::{sym, DUMMY_SP};
  23 use rustc_target::abi::{Integer, IntegerType, Size, TargetDataLayout};
  24 use rustc_target::spec::abi::Abi;
  25 use smallvec::SmallVec;
  26 use std::{fmt, iter};
  27
  28 #[derive(Copy, Clone, Debug)]
  29 pub struct Discr<'tcx> {
  30     /// Bit representation of the discriminant (e.g., `-128i8` is `0xFF_u128`).
  31     pub val: u128,
  32     pub ty: Ty<'tcx>,
  33 }
  34
  35 /// Used as an input to [`TyCtxt::uses_unique_generic_params`].
  36 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
  37 pub enum IgnoreRegions {
  38     Yes,
  39     No,
  40 }
  41
  42 #[derive(Copy, Clone, Debug)]
  43 pub enum NotUniqueParam<'tcx> {
  44     DuplicateParam(ty::GenericArg<'tcx>),
  45     NotParam(ty::GenericArg<'tcx>),
  46 }
  47
  48 impl<'tcx> fmt::Display for Discr<'tcx> {
  49     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
  50         match *self.ty.kind() {
  51             ty::Int(ity) => {
  52                 let size = ty::tls::with(|tcx| Integer::from_int_ty(&tcx, ity).size());
  53                 let x = self.val;
  54                 // sign extend the raw representation to be an i128
  55                 let x = size.sign_extend(x) as i128;
  56                 write!(fmt, "{}", x)
  57             }
  58             _ => write!(fmt, "{}", self.val),
  59         }
  60     }
  61 }
  62
  63 fn int_size_and_signed<'tcx>(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> (Size, bool) {
  64     let (int, signed) = match *ty.kind() {
  65         ty::Int(ity) => (Integer::from_int_ty(&tcx, ity), true),
  66         ty::Uint(uty) => (Integer::from_uint_ty(&tcx, uty), false),
  67         _ => bug!("non integer discriminant"),
  68     };
  69     (int.size(), signed)
  70 }
  71
  72 impl<'tcx> Discr<'tcx> {
  73     /// Adds `1` to the value and wraps around if the maximum for the type is reached.
  74     pub fn wrap_incr(self, tcx: TyCtxt<'tcx>) -> Self {
  75         self.checked_add(tcx, 1).0
  76     }
  77     pub fn checked_add(self, tcx: TyCtxt<'tcx>, n: u128) -> (Self, bool) {
  78         let (size, signed) = int_size_and_signed(tcx, self.ty);
  79         let (val, oflo) = if signed {
  80             let min = size.signed_int_min();
  81             let max = size.signed_int_max();
  82             let val = size.sign_extend(self.val) as i128;
  83             assert!(n < (i128::MAX as u128));
  84             let n = n as i128;
  85             let oflo = val > max - n;
  86             let val = if oflo { min + (n - (max - val) - 1) } else { val + n };
  87             // zero the upper bits
  88             let val = val as u128;
  89             let val = size.truncate(val);
  90             (val, oflo)
  91         } else {
  92             let max = size.unsigned_int_max();
  93             let val = self.val;
  94             let oflo = val > max - n;
  95             let val = if oflo { n - (max - val) - 1 } else { val + n };
  96             (val, oflo)
  97         };
  98         (Self { val, ty: self.ty }, oflo)
  99     }
 100 }
 101
 102 pub trait IntTypeExt {
 103     fn to_ty<'tcx>(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx>;
 104     fn disr_incr<'tcx>(&self, tcx: TyCtxt<'tcx>, val: Option<Discr<'tcx>>) -> Option<Discr<'tcx>>;
 105     fn initial_discriminant<'tcx>(&self, tcx: TyCtxt<'tcx>) -> Discr<'tcx>;
 106 }
 107
 108 impl IntTypeExt for IntegerType {
 109     fn to_ty<'tcx>(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
 110         match self {
 111             IntegerType::Pointer(true) => tcx.types.isize,
 112             IntegerType::Pointer(false) => tcx.types.usize,
 113             IntegerType::Fixed(i, s) => i.to_ty(tcx, *s),
 114         }
 115     }
 116
 117     fn initial_discriminant<'tcx>(&self, tcx: TyCtxt<'tcx>) -> Discr<'tcx> {
 118         Discr { val: 0, ty: self.to_ty(tcx) }
 119     }
 120
 121     fn disr_incr<'tcx>(&self, tcx: TyCtxt<'tcx>, val: Option<Discr<'tcx>>) -> Option<Discr<'tcx>> {
 122         if let Some(val) = val {
 123             assert_eq!(self.to_ty(tcx), val.ty);
 124             let (new, oflo) = val.checked_add(tcx, 1);
 125             if oflo { None } else { Some(new) }
 126         } else {
 127             Some(self.initial_discriminant(tcx))
 128         }
 129     }
 130 }
 131
 132 impl<'tcx> TyCtxt<'tcx> {
 133     /// Creates a hash of the type `Ty` which will be the same no matter what crate
 134     /// context it's calculated within. This is used by the `type_id` intrinsic.
 135     pub fn type_id_hash(self, ty: Ty<'tcx>) -> u64 {
 136         // We want the type_id be independent of the types free regions, so we
 137         // erase them. The erase_regions() call will also anonymize bound
 138         // regions, which is desirable too.
 139         let ty = self.erase_regions(ty);
 140
 141         self.with_stable_hashing_context(|mut hcx| {
 142             let mut hasher = StableHasher::new();
 143             hcx.while_hashing_spans(false, |hcx| ty.hash_stable(hcx, &mut hasher));
 144             hasher.finish()
 145         })
 146     }
 147
 148     pub fn res_generics_def_id(self, res: Res) -> Option<DefId> {
 149         match res {
 150             Res::Def(DefKind::Ctor(CtorOf::Variant, _), def_id) => {
 151                 Some(self.parent(self.parent(def_id)))
 152             }
 153             Res::Def(DefKind::Variant | DefKind::Ctor(CtorOf::Struct, _), def_id) => {
 154                 Some(self.parent(def_id))
 155             }
 156             // Other `DefKind`s don't have generics and would ICE when calling
 157             // `generics_of`.
 158             Res::Def(
 159                 DefKind::Struct
 160                 | DefKind::Union
 161                 | DefKind::Enum
 162                 | DefKind::Trait
 163                 | DefKind::OpaqueTy
 164                 | DefKind::TyAlias
 165                 | DefKind::ForeignTy
 166                 | DefKind::TraitAlias
 167                 | DefKind::AssocTy
 168                 | DefKind::Fn
 169                 | DefKind::AssocFn
 170                 | DefKind::AssocConst
 171                 | DefKind::Impl,
 172                 def_id,
 173             ) => Some(def_id),
 174             Res::Err => None,
 175             _ => None,
 176         }
 177     }
 178
 179     pub fn has_error_field(self, ty: Ty<'tcx>) -> bool {
 180         if let ty::Adt(def, substs) = *ty.kind() {
 181             for field in def.all_fields() {
 182                 let field_ty = field.ty(self, substs);
 183                 if let ty::Error(_) = field_ty.kind() {
 184                     return true;
 185                 }
 186             }
 187         }
 188         false
 189     }
 190
 191     /// Attempts to returns the deeply last field of nested structures, but
 192     /// does not apply any normalization in its search. Returns the same type
 193     /// if input `ty` is not a structure at all.
 194     pub fn struct_tail_without_normalization(self, ty: Ty<'tcx>) -> Ty<'tcx> {
 195         let tcx = self;
 196         tcx.struct_tail_with_normalize(ty, |ty| ty, || {})
 197     }
 198
 199     /// Returns the deeply last field of nested structures, or the same type if
 200     /// not a structure at all. Corresponds to the only possible unsized field,
 201     /// and its type can be used to determine unsizing strategy.
 202     ///
 203     /// Should only be called if `ty` has no inference variables and does not
 204     /// need its lifetimes preserved (e.g. as part of codegen); otherwise
 205     /// normalization attempt may cause compiler bugs.
 206     pub fn struct_tail_erasing_lifetimes(
 207         self,
 208         ty: Ty<'tcx>,
 209         param_env: ty::ParamEnv<'tcx>,
 210     ) -> Ty<'tcx> {
 211         let tcx = self;
 212         tcx.struct_tail_with_normalize(ty, |ty| tcx.normalize_erasing_regions(param_env, ty), || {})
 213     }
 214
 215     /// Returns the deeply last field of nested structures, or the same type if
 216     /// not a structure at all. Corresponds to the only possible unsized field,
 217     /// and its type can be used to determine unsizing strategy.
 218     ///
 219     /// This is parameterized over the normalization strategy (i.e. how to
 220     /// handle `<T as Trait>::Assoc` and `impl Trait`); pass the identity
 221     /// function to indicate no normalization should take place.
 222     ///
 223     /// See also `struct_tail_erasing_lifetimes`, which is suitable for use
 224     /// during codegen.
 225     pub fn struct_tail_with_normalize(
 226         self,
 227         mut ty: Ty<'tcx>,
 228         mut normalize: impl FnMut(Ty<'tcx>) -> Ty<'tcx>,
 229         // This is currently used to allow us to walk a ValTree
 230         // in lockstep with the type in order to get the ValTree branch that
 231         // corresponds to an unsized field.
 232         mut f: impl FnMut() -> (),
 233     ) -> Ty<'tcx> {
 234         let recursion_limit = self.recursion_limit();
 235         for iteration in 0.. {
 236             if !recursion_limit.value_within_limit(iteration) {
 237                 return self.ty_error_with_message(
 238                     DUMMY_SP,
 239                     &format!("reached the recursion limit finding the struct tail for {}", ty),
 240                 );
 241             }
 242             match *ty.kind() {
 243                 ty::Adt(def, substs) => {
 244                     if !def.is_struct() {
 245                         break;
 246                     }
 247                     match def.non_enum_variant().fields.last() {
 248                         Some(field) => {
 249                             f();
 250                             ty = field.ty(self, substs);
 251                         }
 252                         None => break,
 253                     }
 254                 }
 255
 256                 ty::Tuple(tys) if let Some((&last_ty, _)) = tys.split_last() => {
 257                     f();
 258                     ty = last_ty;
 259                 }
 260
 261                 ty::Tuple(_) => break,
 262
 263                 ty::Alias(..) => {
 264                     let normalized = normalize(ty);
 265                     if ty == normalized {
 266                         return ty;
 267                     } else {
 268                         ty = normalized;
 269                     }
 270                 }
 271
 272                 _ => {
 273                     break;
 274                 }
 275             }
 276         }
 277         ty
 278     }
 279
 280     /// Same as applying `struct_tail` on `source` and `target`, but only
 281     /// keeps going as long as the two types are instances of the same
 282     /// structure definitions.
 283     /// For `(Foo<Foo<T>>, Foo<dyn Trait>)`, the result will be `(Foo<T>, Trait)`,
 284     /// whereas struct_tail produces `T`, and `Trait`, respectively.
 285     ///
 286     /// Should only be called if the types have no inference variables and do
 287     /// not need their lifetimes preserved (e.g., as part of codegen); otherwise,
 288     /// normalization attempt may cause compiler bugs.
 289     pub fn struct_lockstep_tails_erasing_lifetimes(
 290         self,
 291         source: Ty<'tcx>,
 292         target: Ty<'tcx>,
 293         param_env: ty::ParamEnv<'tcx>,
 294     ) -> (Ty<'tcx>, Ty<'tcx>) {
 295         let tcx = self;
 296         tcx.struct_lockstep_tails_with_normalize(source, target, |ty| {
 297             tcx.normalize_erasing_regions(param_env, ty)
 298         })
 299     }
 300
 301     /// Same as applying `struct_tail` on `source` and `target`, but only
 302     /// keeps going as long as the two types are instances of the same
 303     /// structure definitions.
 304     /// For `(Foo<Foo<T>>, Foo<dyn Trait>)`, the result will be `(Foo<T>, Trait)`,
 305     /// whereas struct_tail produces `T`, and `Trait`, respectively.
 306     ///
 307     /// See also `struct_lockstep_tails_erasing_lifetimes`, which is suitable for use
 308     /// during codegen.
 309     pub fn struct_lockstep_tails_with_normalize(
 310         self,
 311         source: Ty<'tcx>,
 312         target: Ty<'tcx>,
 313         normalize: impl Fn(Ty<'tcx>) -> Ty<'tcx>,
 314     ) -> (Ty<'tcx>, Ty<'tcx>) {
 315         let (mut a, mut b) = (source, target);
 316         loop {
 317             match (&a.kind(), &b.kind()) {
 318                 (&ty::Adt(a_def, a_substs), &ty::Adt(b_def, b_substs))
 319                     if a_def == b_def && a_def.is_struct() =>
 320                 {
 321                     if let Some(f) = a_def.non_enum_variant().fields.last() {
 322                         a = f.ty(self, a_substs);
 323                         b = f.ty(self, b_substs);
 324                     } else {
 325                         break;
 326                     }
 327                 }
 328                 (&ty::Tuple(a_tys), &ty::Tuple(b_tys)) if a_tys.len() == b_tys.len() => {
 329                     if let Some(&a_last) = a_tys.last() {
 330                         a = a_last;
 331                         b = *b_tys.last().unwrap();
 332                     } else {
 333                         break;
 334                     }
 335                 }
 336                 (ty::Alias(..), _) | (_, ty::Alias(..)) => {
 337                     // If either side is a projection, attempt to
 338                     // progress via normalization. (Should be safe to
 339                     // apply to both sides as normalization is
 340                     // idempotent.)
 341                     let a_norm = normalize(a);
 342                     let b_norm = normalize(b);
 343                     if a == a_norm && b == b_norm {
 344                         break;
 345                     } else {
 346                         a = a_norm;
 347                         b = b_norm;
 348                     }
 349                 }
 350
 351                 _ => break,
 352             }
 353         }
 354         (a, b)
 355     }
 356
 357     /// Calculate the destructor of a given type.
 358     pub fn calculate_dtor(
 359         self,
 360         adt_did: DefId,
 361         validate: impl Fn(Self, DefId) -> Result<(), ErrorGuaranteed>,
 362     ) -> Option<ty::Destructor> {
 363         let drop_trait = self.lang_items().drop_trait()?;
 364         self.ensure().coherent_trait(drop_trait);
 365
 366         let ty = self.type_of(adt_did);
 367         let (did, constness) = self.find_map_relevant_impl(drop_trait, ty, |impl_did| {
 368             if let Some(item_id) = self.associated_item_def_ids(impl_did).first() {
 369                 if validate(self, impl_did).is_ok() {
 370                     return Some((*item_id, self.constness(impl_did)));
 371                 }
 372             }
 373             None
 374         })?;
 375
 376         Some(ty::Destructor { did, constness })
 377     }
 378
 379     /// Returns the set of types that are required to be alive in
 380     /// order to run the destructor of `def` (see RFCs 769 and
 381     /// 1238).
 382     ///
 383     /// Note that this returns only the constraints for the
 384     /// destructor of `def` itself. For the destructors of the
 385     /// contents, you need `adt_dtorck_constraint`.
 386     pub fn destructor_constraints(self, def: ty::AdtDef<'tcx>) -> Vec<ty::subst::GenericArg<'tcx>> {
 387         let dtor = match def.destructor(self) {
 388             None => {
 389                 debug!("destructor_constraints({:?}) - no dtor", def.did());
 390                 return vec![];
 391             }
 392             Some(dtor) => dtor.did,
 393         };
 394
 395         let impl_def_id = self.parent(dtor);
 396         let impl_generics = self.generics_of(impl_def_id);
 397
 398         // We have a destructor - all the parameters that are not
 399         // pure_wrt_drop (i.e, don't have a #[may_dangle] attribute)
 400         // must be live.
 401
 402         // We need to return the list of parameters from the ADTs
 403         // generics/substs that correspond to impure parameters on the
 404         // impl's generics. This is a bit ugly, but conceptually simple:
 405         //
 406         // Suppose our ADT looks like the following
 407         //
 408         //     struct S<X, Y, Z>(X, Y, Z);
 409         //
 410         // and the impl is
 411         //
 412         //     impl<#[may_dangle] P0, P1, P2> Drop for S<P1, P2, P0>
 413         //
 414         // We want to return the parameters (X, Y). For that, we match
 415         // up the item-substs <X, Y, Z> with the substs on the impl ADT,
 416         // <P1, P2, P0>, and then look up which of the impl substs refer to
 417         // parameters marked as pure.
 418
 419         let impl_substs = match *self.type_of(impl_def_id).kind() {
 420             ty::Adt(def_, substs) if def_ == def => substs,
 421             _ => bug!(),
 422         };
 423
 424         let item_substs = match *self.type_of(def.did()).kind() {
 425             ty::Adt(def_, substs) if def_ == def => substs,
 426             _ => bug!(),
 427         };
 428
 429         let result = iter::zip(item_substs, impl_substs)
 430             .filter(|&(_, k)| {
 431                 match k.unpack() {
 432                     GenericArgKind::Lifetime(region) => match region.kind() {
 433                         ty::ReEarlyBound(ref ebr) => {
 434                             !impl_generics.region_param(ebr, self).pure_wrt_drop
 435                         }
 436                         // Error: not a region param
 437                         _ => false,
 438                     },
 439                     GenericArgKind::Type(ty) => match ty.kind() {
 440                         ty::Param(ref pt) => !impl_generics.type_param(pt, self).pure_wrt_drop,
 441                         // Error: not a type param
 442                         _ => false,
 443                     },
 444                     GenericArgKind::Const(ct) => match ct.kind() {
 445                         ty::ConstKind::Param(ref pc) => {
 446                             !impl_generics.const_param(pc, self).pure_wrt_drop
 447                         }
 448                         // Error: not a const param
 449                         _ => false,
 450                     },
 451                 }
 452             })
 453             .map(|(item_param, _)| item_param)
 454             .collect();
 455         debug!("destructor_constraint({:?}) = {:?}", def.did(), result);
 456         result
 457     }
 458
 459     /// Checks whether each generic argument is simply a unique generic parameter.
 460     pub fn uses_unique_generic_params(
 461         self,
 462         substs: SubstsRef<'tcx>,
 463         ignore_regions: IgnoreRegions,
 464     ) -> Result<(), NotUniqueParam<'tcx>> {
 465         let mut seen = GrowableBitSet::default();
 466         for arg in substs {
 467             match arg.unpack() {
 468                 GenericArgKind::Lifetime(lt) => {
 469                     if ignore_regions == IgnoreRegions::No {
 470                         let ty::ReEarlyBound(p) = lt.kind() else {
 471                             return Err(NotUniqueParam::NotParam(lt.into()))
 472                         };
 473                         if !seen.insert(p.index) {
 474                             return Err(NotUniqueParam::DuplicateParam(lt.into()));
 475                         }
 476                     }
 477                 }
 478                 GenericArgKind::Type(t) => match t.kind() {
 479                     ty::Param(p) => {
 480                         if !seen.insert(p.index) {
 481                             return Err(NotUniqueParam::DuplicateParam(t.into()));
 482                         }
 483                     }
 484                     _ => return Err(NotUniqueParam::NotParam(t.into())),
 485                 },
 486                 GenericArgKind::Const(c) => match c.kind() {
 487                     ty::ConstKind::Param(p) => {
 488                         if !seen.insert(p.index) {
 489                             return Err(NotUniqueParam::DuplicateParam(c.into()));
 490                         }
 491                     }
 492                     _ => return Err(NotUniqueParam::NotParam(c.into())),
 493                 },
 494             }
 495         }
 496
 497         Ok(())
 498     }
 499
 500     /// Returns `true` if `def_id` refers to a closure (e.g., `|x| x * 2`). Note
 501     /// that closures have a `DefId`, but the closure *expression* also
 502     /// has a `HirId` that is located within the context where the
 503     /// closure appears (and, sadly, a corresponding `NodeId`, since
 504     /// those are not yet phased out). The parent of the closure's
 505     /// `DefId` will also be the context where it appears.
 506     pub fn is_closure(self, def_id: DefId) -> bool {
 507         matches!(self.def_kind(def_id), DefKind::Closure | DefKind::Generator)
 508     }
 509
 510     /// Returns `true` if `def_id` refers to a definition that does not have its own
 511     /// type-checking context, i.e. closure, generator or inline const.
 512     pub fn is_typeck_child(self, def_id: DefId) -> bool {
 513         matches!(
 514             self.def_kind(def_id),
 515             DefKind::Closure | DefKind::Generator | DefKind::InlineConst
 516         )
 517     }
 518
 519     /// Returns `true` if `def_id` refers to a trait (i.e., `trait Foo { ... }`).
 520     pub fn is_trait(self, def_id: DefId) -> bool {
 521         self.def_kind(def_id) == DefKind::Trait
 522     }
 523
 524     /// Returns `true` if `def_id` refers to a trait alias (i.e., `trait Foo = ...;`),
 525     /// and `false` otherwise.
 526     pub fn is_trait_alias(self, def_id: DefId) -> bool {
 527         self.def_kind(def_id) == DefKind::TraitAlias
 528     }
 529
 530     /// Returns `true` if this `DefId` refers to the implicit constructor for
 531     /// a tuple struct like `struct Foo(u32)`, and `false` otherwise.
 532     pub fn is_constructor(self, def_id: DefId) -> bool {
 533         matches!(self.def_kind(def_id), DefKind::Ctor(..))
 534     }
 535
 536     /// Given the `DefId`, returns the `DefId` of the innermost item that
 537     /// has its own type-checking context or "inference environment".
 538     ///
 539     /// For example, a closure has its own `DefId`, but it is type-checked
 540     /// with the containing item. Similarly, an inline const block has its
 541     /// own `DefId` but it is type-checked together with the containing item.
 542     ///
 543     /// Therefore, when we fetch the
 544     /// `typeck` the closure, for example, we really wind up
 545     /// fetching the `typeck` the enclosing fn item.
 546     pub fn typeck_root_def_id(self, def_id: DefId) -> DefId {
 547         let mut def_id = def_id;
 548         while self.is_typeck_child(def_id) {
 549             def_id = self.parent(def_id);
 550         }
 551         def_id
 552     }
 553
 554     /// Given the `DefId` and substs a closure, creates the type of
 555     /// `self` argument that the closure expects. For example, for a
 556     /// `Fn` closure, this would return a reference type `&T` where
 557     /// `T = closure_ty`.
 558     ///
 559     /// Returns `None` if this closure's kind has not yet been inferred.
 560     /// This should only be possible during type checking.
 561     ///
 562     /// Note that the return value is a late-bound region and hence
 563     /// wrapped in a binder.
 564     pub fn closure_env_ty(
 565         self,
 566         closure_def_id: DefId,
 567         closure_substs: SubstsRef<'tcx>,
 568         env_region: ty::RegionKind<'tcx>,
 569     ) -> Option<Ty<'tcx>> {
 570         let closure_ty = self.mk_closure(closure_def_id, closure_substs);
 571         let closure_kind_ty = closure_substs.as_closure().kind_ty();
 572         let closure_kind = closure_kind_ty.to_opt_closure_kind()?;
 573         let env_ty = match closure_kind {
 574             ty::ClosureKind::Fn => self.mk_imm_ref(self.mk_region(env_region), closure_ty),
 575             ty::ClosureKind::FnMut => self.mk_mut_ref(self.mk_region(env_region), closure_ty),
 576             ty::ClosureKind::FnOnce => closure_ty,
 577         };
 578         Some(env_ty)
 579     }
 580
 581     /// Returns `true` if the node pointed to by `def_id` is a `static` item.
 582     #[inline]
 583     pub fn is_static(self, def_id: DefId) -> bool {
 584         matches!(self.def_kind(def_id), DefKind::Static(_))
 585     }
 586
 587     #[inline]
 588     pub fn static_mutability(self, def_id: DefId) -> Option<hir::Mutability> {
 589         if let DefKind::Static(mt) = self.def_kind(def_id) { Some(mt) } else { None }
 590     }
 591
 592     /// Returns `true` if this is a `static` item with the `#[thread_local]` attribute.
 593     pub fn is_thread_local_static(self, def_id: DefId) -> bool {
 594         self.codegen_fn_attrs(def_id).flags.contains(CodegenFnAttrFlags::THREAD_LOCAL)
 595     }
 596
 597     /// Returns `true` if the node pointed to by `def_id` is a mutable `static` item.
 598     #[inline]
 599     pub fn is_mutable_static(self, def_id: DefId) -> bool {
 600         self.static_mutability(def_id) == Some(hir::Mutability::Mut)
 601     }
 602
 603     /// Get the type of the pointer to the static that we use in MIR.
 604     pub fn static_ptr_ty(self, def_id: DefId) -> Ty<'tcx> {
 605         // Make sure that any constants in the static's type are evaluated.
 606         let static_ty = self.normalize_erasing_regions(ty::ParamEnv::empty(), self.type_of(def_id));
 607
 608         // Make sure that accesses to unsafe statics end up using raw pointers.
 609         // For thread-locals, this needs to be kept in sync with `Rvalue::ty`.
 610         if self.is_mutable_static(def_id) {
 611             self.mk_mut_ptr(static_ty)
 612         } else if self.is_foreign_item(def_id) {
 613             self.mk_imm_ptr(static_ty)
 614         } else {
 615             self.mk_imm_ref(self.lifetimes.re_erased, static_ty)
 616         }
 617     }
 618
 619     /// Expands the given impl trait type, stopping if the type is recursive.
 620     #[instrument(skip(self), level = "debug", ret)]
 621     pub fn try_expand_impl_trait_type(
 622         self,
 623         def_id: DefId,
 624         substs: SubstsRef<'tcx>,
 625     ) -> Result<Ty<'tcx>, Ty<'tcx>> {
 626         let mut visitor = OpaqueTypeExpander {
 627             seen_opaque_tys: FxHashSet::default(),
 628             expanded_cache: FxHashMap::default(),
 629             primary_def_id: Some(def_id),
 630             found_recursion: false,
 631             found_any_recursion: false,
 632             check_recursion: true,
 633             tcx: self,
 634         };
 635
 636         let expanded_type = visitor.expand_opaque_ty(def_id, substs).unwrap();
 637         if visitor.found_recursion { Err(expanded_type) } else { Ok(expanded_type) }
 638     }
 639
 640     pub fn bound_type_of(self, def_id: DefId) -> ty::EarlyBinder<Ty<'tcx>> {
 641         ty::EarlyBinder(self.type_of(def_id))
 642     }
 643
 644     pub fn bound_return_position_impl_trait_in_trait_tys(
 645         self,
 646         def_id: DefId,
 647     ) -> ty::EarlyBinder<Result<&'tcx FxHashMap<DefId, Ty<'tcx>>, ErrorGuaranteed>> {
 648         ty::EarlyBinder(self.collect_return_position_impl_trait_in_trait_tys(def_id))
 649     }
 650
 651     pub fn bound_fn_sig(self, def_id: DefId) -> ty::EarlyBinder<ty::PolyFnSig<'tcx>> {
 652         ty::EarlyBinder(self.fn_sig(def_id))
 653     }
 654
 655     pub fn bound_explicit_item_bounds(
 656         self,
 657         def_id: DefId,
 658     ) -> ty::EarlyBinder<&'tcx [(ty::Predicate<'tcx>, rustc_span::Span)]> {
 659         ty::EarlyBinder(self.explicit_item_bounds(def_id))
 660     }
 661
 662     pub fn bound_item_bounds(
 663         self,
 664         def_id: DefId,
 665     ) -> ty::EarlyBinder<&'tcx ty::List<ty::Predicate<'tcx>>> {
 666         ty::EarlyBinder(self.item_bounds(def_id))
 667     }
 668
 669     pub fn bound_predicates_of(
 670         self,
 671         def_id: DefId,
 672     ) -> ty::EarlyBinder<ty::generics::GenericPredicates<'tcx>> {
 673         ty::EarlyBinder(self.predicates_of(def_id))
 674     }
 675
 676     pub fn bound_explicit_predicates_of(
 677         self,
 678         def_id: DefId,
 679     ) -> ty::EarlyBinder<ty::generics::GenericPredicates<'tcx>> {
 680         ty::EarlyBinder(self.explicit_predicates_of(def_id))
 681     }
 682
 683     pub fn bound_impl_subject(self, def_id: DefId) -> ty::EarlyBinder<ty::ImplSubject<'tcx>> {
 684         ty::EarlyBinder(self.impl_subject(def_id))
 685     }
 686
 687     /// Returns names of captured upvars for closures and generators.
 688     ///
 689     /// Here are some examples:
 690     ///  - `name__field1__field2` when the upvar is captured by value.
 691     ///  - `_ref__name__field` when the upvar is captured by reference.
 692     ///
 693     /// For generators this only contains upvars that are shared by all states.
 694     pub fn closure_saved_names_of_captured_variables(
 695         self,
 696         def_id: DefId,
 697     ) -> SmallVec<[String; 16]> {
 698         let body = self.optimized_mir(def_id);
 699
 700         body.var_debug_info
 701             .iter()
 702             .filter_map(|var| {
 703                 let is_ref = match var.value {
 704                     mir::VarDebugInfoContents::Place(place)
 705                         if place.local == mir::Local::new(1) =>
 706                     {
 707                         // The projection is either `[.., Field, Deref]` or `[.., Field]`. It
 708                         // implies whether the variable is captured by value or by reference.
 709                         matches!(place.projection.last().unwrap(), mir::ProjectionElem::Deref)
 710                     }
 711                     _ => return None,
 712                 };
 713                 let prefix = if is_ref { "_ref__" } else { "" };
 714                 Some(prefix.to_owned() + var.name.as_str())
 715             })
 716             .collect()
 717     }
 718
 719     // FIXME(eddyb) maybe precompute this? Right now it's computed once
 720     // per generator monomorphization, but it doesn't depend on substs.
 721     pub fn generator_layout_and_saved_local_names(
 722         self,
 723         def_id: DefId,
 724     ) -> (
 725         &'tcx ty::GeneratorLayout<'tcx>,
 726         IndexVec<mir::GeneratorSavedLocal, Option<rustc_span::Symbol>>,
 727     ) {
 728         let tcx = self;
 729         let body = tcx.optimized_mir(def_id);
 730         let generator_layout = body.generator_layout().unwrap();
 731         let mut generator_saved_local_names =
 732             IndexVec::from_elem(None, &generator_layout.field_tys);
 733
 734         let state_arg = mir::Local::new(1);
 735         for var in &body.var_debug_info {
 736             let mir::VarDebugInfoContents::Place(place) = &var.value else { continue };
 737             if place.local != state_arg {
 738                 continue;
 739             }
 740             match place.projection[..] {
 741                 [
 742                     // Deref of the `Pin<&mut Self>` state argument.
 743                     mir::ProjectionElem::Field(..),
 744                     mir::ProjectionElem::Deref,
 745                     // Field of a variant of the state.
 746                     mir::ProjectionElem::Downcast(_, variant),
 747                     mir::ProjectionElem::Field(field, _),
 748                 ] => {
 749                     let name = &mut generator_saved_local_names
 750                         [generator_layout.variant_fields[variant][field]];
 751                     if name.is_none() {
 752                         name.replace(var.name);
 753                     }
 754                 }
 755                 _ => {}
 756             }
 757         }
 758         (generator_layout, generator_saved_local_names)
 759     }
 760 }
 761
 762 impl<'tcx> TyCtxtAt<'tcx> {
 763     pub fn bound_type_of(self, def_id: DefId) -> ty::EarlyBinder<Ty<'tcx>> {
 764         ty::EarlyBinder(self.type_of(def_id))
 765     }
 766 }
 767
 768 struct OpaqueTypeExpander<'tcx> {
 769     // Contains the DefIds of the opaque types that are currently being
 770     // expanded. When we expand an opaque type we insert the DefId of
 771     // that type, and when we finish expanding that type we remove the
 772     // its DefId.
 773     seen_opaque_tys: FxHashSet<DefId>,
 774     // Cache of all expansions we've seen so far. This is a critical
 775     // optimization for some large types produced by async fn trees.
 776     expanded_cache: FxHashMap<(DefId, SubstsRef<'tcx>), Ty<'tcx>>,
 777     primary_def_id: Option<DefId>,
 778     found_recursion: bool,
 779     found_any_recursion: bool,
 780     /// Whether or not to check for recursive opaque types.
 781     /// This is `true` when we're explicitly checking for opaque type
 782     /// recursion, and 'false' otherwise to avoid unnecessary work.
 783     check_recursion: bool,
 784     tcx: TyCtxt<'tcx>,
 785 }
 786
 787 impl<'tcx> OpaqueTypeExpander<'tcx> {
 788     fn expand_opaque_ty(&mut self, def_id: DefId, substs: SubstsRef<'tcx>) -> Option<Ty<'tcx>> {
 789         if self.found_any_recursion {
 790             return None;
 791         }
 792         let substs = substs.fold_with(self);
 793         if !self.check_recursion || self.seen_opaque_tys.insert(def_id) {
 794             let expanded_ty = match self.expanded_cache.get(&(def_id, substs)) {
 795                 Some(expanded_ty) => *expanded_ty,
 796                 None => {
 797                     let generic_ty = self.tcx.bound_type_of(def_id);
 798                     let concrete_ty = generic_ty.subst(self.tcx, substs);
 799                     let expanded_ty = self.fold_ty(concrete_ty);
 800                     self.expanded_cache.insert((def_id, substs), expanded_ty);
 801                     expanded_ty
 802                 }
 803             };
 804             if self.check_recursion {
 805                 self.seen_opaque_tys.remove(&def_id);
 806             }
 807             Some(expanded_ty)
 808         } else {
 809             // If another opaque type that we contain is recursive, then it
 810             // will report the error, so we don't have to.
 811             self.found_any_recursion = true;
 812             self.found_recursion = def_id == *self.primary_def_id.as_ref().unwrap();
 813             None
 814         }
 815     }
 816 }
 817
 818 impl<'tcx> TypeFolder<'tcx> for OpaqueTypeExpander<'tcx> {
 819     fn tcx(&self) -> TyCtxt<'tcx> {
 820         self.tcx
 821     }
 822
 823     fn fold_ty(&mut self, t: Ty<'tcx>) -> Ty<'tcx> {
 824         if let ty::Alias(ty::Opaque, ty::AliasTy { def_id, substs, .. }) = *t.kind() {
 825             self.expand_opaque_ty(def_id, substs).unwrap_or(t)
 826         } else if t.has_opaque_types() {
 827             t.super_fold_with(self)
 828         } else {
 829             t
 830         }
 831     }
 832 }
 833
 834 impl<'tcx> Ty<'tcx> {
 835     /// Returns the maximum value for the given numeric type (including `char`s)
 836     /// or returns `None` if the type is not numeric.
 837     pub fn numeric_max_val(self, tcx: TyCtxt<'tcx>) -> Option<ty::Const<'tcx>> {
 838         let val = match self.kind() {
 839             ty::Int(_) | ty::Uint(_) => {
 840                 let (size, signed) = int_size_and_signed(tcx, self);
 841                 let val =
 842                     if signed { size.signed_int_max() as u128 } else { size.unsigned_int_max() };
 843                 Some(val)
 844             }
 845             ty::Char => Some(std::char::MAX as u128),
 846             ty::Float(fty) => Some(match fty {
 847                 ty::FloatTy::F32 => rustc_apfloat::ieee::Single::INFINITY.to_bits(),
 848                 ty::FloatTy::F64 => rustc_apfloat::ieee::Double::INFINITY.to_bits(),
 849             }),
 850             _ => None,
 851         };
 852
 853         val.map(|v| ty::Const::from_bits(tcx, v, ty::ParamEnv::empty().and(self)))
 854     }
 855
 856     /// Returns the minimum value for the given numeric type (including `char`s)
 857     /// or returns `None` if the type is not numeric.
 858     pub fn numeric_min_val(self, tcx: TyCtxt<'tcx>) -> Option<ty::Const<'tcx>> {
 859         let val = match self.kind() {
 860             ty::Int(_) | ty::Uint(_) => {
 861                 let (size, signed) = int_size_and_signed(tcx, self);
 862                 let val = if signed { size.truncate(size.signed_int_min() as u128) } else { 0 };
 863                 Some(val)
 864             }
 865             ty::Char => Some(0),
 866             ty::Float(fty) => Some(match fty {
 867                 ty::FloatTy::F32 => (-::rustc_apfloat::ieee::Single::INFINITY).to_bits(),
 868                 ty::FloatTy::F64 => (-::rustc_apfloat::ieee::Double::INFINITY).to_bits(),
 869             }),
 870             _ => None,
 871         };
 872
 873         val.map(|v| ty::Const::from_bits(tcx, v, ty::ParamEnv::empty().and(self)))
 874     }
 875
 876     /// Checks whether values of this type `T` are *moved* or *copied*
 877     /// when referenced -- this amounts to a check for whether `T:
 878     /// Copy`, but note that we **don't** consider lifetimes when
 879     /// doing this check. This means that we may generate MIR which
 880     /// does copies even when the type actually doesn't satisfy the
 881     /// full requirements for the `Copy` trait (cc #29149) -- this
 882     /// winds up being reported as an error during NLL borrow check.
 883     pub fn is_copy_modulo_regions(self, tcx: TyCtxt<'tcx>, param_env: ty::ParamEnv<'tcx>) -> bool {
 884         self.is_trivially_pure_clone_copy() || tcx.is_copy_raw(param_env.and(self))
 885     }
 886
 887     /// Checks whether values of this type `T` have a size known at
 888     /// compile time (i.e., whether `T: Sized`). Lifetimes are ignored
 889     /// for the purposes of this check, so it can be an
 890     /// over-approximation in generic contexts, where one can have
 891     /// strange rules like `<T as Foo<'static>>::Bar: Sized` that
 892     /// actually carry lifetime requirements.
 893     pub fn is_sized(self, tcx: TyCtxt<'tcx>, param_env: ty::ParamEnv<'tcx>) -> bool {
 894         self.is_trivially_sized(tcx) || tcx.is_sized_raw(param_env.and(self))
 895     }
 896
 897     /// Checks whether values of this type `T` implement the `Freeze`
 898     /// trait -- frozen types are those that do not contain an
 899     /// `UnsafeCell` anywhere. This is a language concept used to
 900     /// distinguish "true immutability", which is relevant to
 901     /// optimization as well as the rules around static values. Note
 902     /// that the `Freeze` trait is not exposed to end users and is
 903     /// effectively an implementation detail.
 904     pub fn is_freeze(self, tcx: TyCtxt<'tcx>, param_env: ty::ParamEnv<'tcx>) -> bool {
 905         self.is_trivially_freeze() || tcx.is_freeze_raw(param_env.and(self))
 906     }
 907
 908     /// Fast path helper for testing if a type is `Freeze`.
 909     ///
 910     /// Returning true means the type is known to be `Freeze`. Returning
 911     /// `false` means nothing -- could be `Freeze`, might not be.
 912     fn is_trivially_freeze(self) -> bool {
 913         match self.kind() {
 914             ty::Int(_)
 915             | ty::Uint(_)
 916             | ty::Float(_)
 917             | ty::Bool
 918             | ty::Char
 919             | ty::Str
 920             | ty::Never
 921             | ty::Ref(..)
 922             | ty::RawPtr(_)
 923             | ty::FnDef(..)
 924             | ty::Error(_)
 925             | ty::FnPtr(_) => true,
 926             ty::Tuple(fields) => fields.iter().all(Self::is_trivially_freeze),
 927             ty::Slice(elem_ty) | ty::Array(elem_ty, _) => elem_ty.is_trivially_freeze(),
 928             ty::Adt(..)
 929             | ty::Bound(..)
 930             | ty::Closure(..)
 931             | ty::Dynamic(..)
 932             | ty::Foreign(_)
 933             | ty::Generator(..)
 934             | ty::GeneratorWitness(_)
 935             | ty::Infer(_)
 936             | ty::Alias(..)
 937             | ty::Param(_)
 938             | ty::Placeholder(_) => false,
 939         }
 940     }
 941
 942     /// Checks whether values of this type `T` implement the `Unpin` trait.
 943     pub fn is_unpin(self, tcx: TyCtxt<'tcx>, param_env: ty::ParamEnv<'tcx>) -> bool {
 944         self.is_trivially_unpin() || tcx.is_unpin_raw(param_env.and(self))
 945     }
 946
 947     /// Fast path helper for testing if a type is `Unpin`.
 948     ///
 949     /// Returning true means the type is known to be `Unpin`. Returning
 950     /// `false` means nothing -- could be `Unpin`, might not be.
 951     fn is_trivially_unpin(self) -> bool {
 952         match self.kind() {
 953             ty::Int(_)
 954             | ty::Uint(_)
 955             | ty::Float(_)
 956             | ty::Bool
 957             | ty::Char
 958             | ty::Str
 959             | ty::Never
 960             | ty::Ref(..)
 961             | ty::RawPtr(_)
 962             | ty::FnDef(..)
 963             | ty::Error(_)
 964             | ty::FnPtr(_) => true,
 965             ty::Tuple(fields) => fields.iter().all(Self::is_trivially_unpin),
 966             ty::Slice(elem_ty) | ty::Array(elem_ty, _) => elem_ty.is_trivially_unpin(),
 967             ty::Adt(..)
 968             | ty::Bound(..)
 969             | ty::Closure(..)
 970             | ty::Dynamic(..)
 971             | ty::Foreign(_)
 972             | ty::Generator(..)
 973             | ty::GeneratorWitness(_)
 974             | ty::Infer(_)
 975             | ty::Alias(..)
 976             | ty::Param(_)
 977             | ty::Placeholder(_) => false,
 978         }
 979     }
 980
 981     /// If `ty.needs_drop(...)` returns `true`, then `ty` is definitely
 982     /// non-copy and *might* have a destructor attached; if it returns
 983     /// `false`, then `ty` definitely has no destructor (i.e., no drop glue).
 984     ///
 985     /// (Note that this implies that if `ty` has a destructor attached,
 986     /// then `needs_drop` will definitely return `true` for `ty`.)
 987     ///
 988     /// Note that this method is used to check eligible types in unions.
 989     #[inline]
 990     pub fn needs_drop(self, tcx: TyCtxt<'tcx>, param_env: ty::ParamEnv<'tcx>) -> bool {
 991         // Avoid querying in simple cases.
 992         match needs_drop_components(self, &tcx.data_layout) {
 993             Err(AlwaysRequiresDrop) => true,
 994             Ok(components) => {
 995                 let query_ty = match *components {
 996                     [] => return false,
 997                     // If we've got a single component, call the query with that
 998                     // to increase the chance that we hit the query cache.
 999                     [component_ty] => component_ty,
1000                     _ => self,
1001                 };
1002
1003                 // This doesn't depend on regions, so try to minimize distinct
1004                 // query keys used.
1005                 // If normalization fails, we just use `query_ty`.
1006                 let query_ty =
1007                     tcx.try_normalize_erasing_regions(param_env, query_ty).unwrap_or(query_ty);
1008
1009                 tcx.needs_drop_raw(param_env.and(query_ty))
1010             }
1011         }
1012     }
1013
1014     /// Checks if `ty` has a significant drop.
1015     ///
1016     /// Note that this method can return false even if `ty` has a destructor
1017     /// attached; even if that is the case then the adt has been marked with
1018     /// the attribute `rustc_insignificant_dtor`.
1019     ///
1020     /// Note that this method is used to check for change in drop order for
1021     /// 2229 drop reorder migration analysis.
1022     #[inline]
1023     pub fn has_significant_drop(self, tcx: TyCtxt<'tcx>, param_env: ty::ParamEnv<'tcx>) -> bool {
1024         // Avoid querying in simple cases.
1025         match needs_drop_components(self, &tcx.data_layout) {
1026             Err(AlwaysRequiresDrop) => true,
1027             Ok(components) => {
1028                 let query_ty = match *components {
1029                     [] => return false,
1030                     // If we've got a single component, call the query with that
1031                     // to increase the chance that we hit the query cache.
1032                     [component_ty] => component_ty,
1033                     _ => self,
1034                 };
1035
1036                 // FIXME(#86868): We should be canonicalizing, or else moving this to a method of inference
1037                 // context, or *something* like that, but for now just avoid passing inference
1038                 // variables to queries that can't cope with them. Instead, conservatively
1039                 // return "true" (may change drop order).
1040                 if query_ty.needs_infer() {
1041                     return true;
1042                 }
1043
1044                 // This doesn't depend on regions, so try to minimize distinct
1045                 // query keys used.
1046                 let erased = tcx.normalize_erasing_regions(param_env, query_ty);
1047                 tcx.has_significant_drop_raw(param_env.and(erased))
1048             }
1049         }
1050     }
1051
1052     /// Returns `true` if equality for this type is both reflexive and structural.
1053     ///
1054     /// Reflexive equality for a type is indicated by an `Eq` impl for that type.
1055     ///
1056     /// Primitive types (`u32`, `str`) have structural equality by definition. For composite data
1057     /// types, equality for the type as a whole is structural when it is the same as equality
1058     /// between all components (fields, array elements, etc.) of that type. For ADTs, structural
1059     /// equality is indicated by an implementation of `PartialStructuralEq` and `StructuralEq` for
1060     /// that type.
1061     ///
1062     /// This function is "shallow" because it may return `true` for a composite type whose fields
1063     /// are not `StructuralEq`. For example, `[T; 4]` has structural equality regardless of `T`
1064     /// because equality for arrays is determined by the equality of each array element. If you
1065     /// want to know whether a given call to `PartialEq::eq` will proceed structurally all the way
1066     /// down, you will need to use a type visitor.
1067     #[inline]
1068     pub fn is_structural_eq_shallow(self, tcx: TyCtxt<'tcx>) -> bool {
1069         match self.kind() {
1070             // Look for an impl of both `PartialStructuralEq` and `StructuralEq`.
1071             ty::Adt(..) => tcx.has_structural_eq_impls(self),
1072
1073             // Primitive types that satisfy `Eq`.
1074             ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::Str | ty::Never => true,
1075
1076             // Composite types that satisfy `Eq` when all of their fields do.
1077             //
1078             // Because this function is "shallow", we return `true` for these composites regardless
1079             // of the type(s) contained within.
1080             ty::Ref(..) | ty::Array(..) | ty::Slice(_) | ty::Tuple(..) => true,
1081
1082             // Raw pointers use bitwise comparison.
1083             ty::RawPtr(_) | ty::FnPtr(_) => true,
1084
1085             // Floating point numbers are not `Eq`.
1086             ty::Float(_) => false,
1087
1088             // Conservatively return `false` for all others...
1089
1090             // Anonymous function types
1091             ty::FnDef(..) | ty::Closure(..) | ty::Dynamic(..) | ty::Generator(..) => false,
1092
1093             // Generic or inferred types
1094             //
1095             // FIXME(ecstaticmorse): Maybe we should `bug` here? This should probably only be
1096             // called for known, fully-monomorphized types.
1097             ty::Alias(..) | ty::Param(_) | ty::Bound(..) | ty::Placeholder(_) | ty::Infer(_) => {
1098                 false
1099             }
1100
1101             ty::Foreign(_) | ty::GeneratorWitness(..) | ty::Error(_) => false,
1102         }
1103     }
1104
1105     /// Peel off all reference types in this type until there are none left.
1106     ///
1107     /// This method is idempotent, i.e. `ty.peel_refs().peel_refs() == ty.peel_refs()`.
1108     ///
1109     /// # Examples
1110     ///
1111     /// - `u8` -> `u8`
1112     /// - `&'a mut u8` -> `u8`
1113     /// - `&'a &'b u8` -> `u8`
1114     /// - `&'a *const &'b u8 -> *const &'b u8`
1115     pub fn peel_refs(self) -> Ty<'tcx> {
1116         let mut ty = self;
1117         while let ty::Ref(_, inner_ty, _) = ty.kind() {
1118             ty = *inner_ty;
1119         }
1120         ty
1121     }
1122
1123     #[inline]
1124     pub fn outer_exclusive_binder(self) -> ty::DebruijnIndex {
1125         self.0.outer_exclusive_binder
1126     }
1127 }
1128
1129 pub enum ExplicitSelf<'tcx> {
1130     ByValue,
1131     ByReference(ty::Region<'tcx>, hir::Mutability),
1132     ByRawPointer(hir::Mutability),
1133     ByBox,
1134     Other,
1135 }
1136
1137 impl<'tcx> ExplicitSelf<'tcx> {
1138     /// Categorizes an explicit self declaration like `self: SomeType`
1139     /// into either `self`, `&self`, `&mut self`, `Box<self>`, or
1140     /// `Other`.
1141     /// This is mainly used to require the arbitrary_self_types feature
1142     /// in the case of `Other`, to improve error messages in the common cases,
1143     /// and to make `Other` non-object-safe.
1144     ///
1145     /// Examples:
1146     ///
1147     /// ```ignore (illustrative)
1148     /// impl<'a> Foo for &'a T {
1149     ///     // Legal declarations:
1150     ///     fn method1(self: &&'a T); // ExplicitSelf::ByReference
1151     ///     fn method2(self: &'a T); // ExplicitSelf::ByValue
1152     ///     fn method3(self: Box<&'a T>); // ExplicitSelf::ByBox
1153     ///     fn method4(self: Rc<&'a T>); // ExplicitSelf::Other
1154     ///
1155     ///     // Invalid cases will be caught by `check_method_receiver`:
1156     ///     fn method_err1(self: &'a mut T); // ExplicitSelf::Other
1157     ///     fn method_err2(self: &'static T) // ExplicitSelf::ByValue
1158     ///     fn method_err3(self: &&T) // ExplicitSelf::ByReference
1159     /// }
1160     /// ```
1161     ///
1162     pub fn determine<P>(self_arg_ty: Ty<'tcx>, is_self_ty: P) -> ExplicitSelf<'tcx>
1163     where
1164         P: Fn(Ty<'tcx>) -> bool,
1165     {
1166         use self::ExplicitSelf::*;
1167
1168         match *self_arg_ty.kind() {
1169             _ if is_self_ty(self_arg_ty) => ByValue,
1170             ty::Ref(region, ty, mutbl) if is_self_ty(ty) => ByReference(region, mutbl),
1171             ty::RawPtr(ty::TypeAndMut { ty, mutbl }) if is_self_ty(ty) => ByRawPointer(mutbl),
1172             ty::Adt(def, _) if def.is_box() && is_self_ty(self_arg_ty.boxed_ty()) => ByBox,
1173             _ => Other,
1174         }
1175     }
1176 }
1177
1178 /// Returns a list of types such that the given type needs drop if and only if
1179 /// *any* of the returned types need drop. Returns `Err(AlwaysRequiresDrop)` if
1180 /// this type always needs drop.
1181 pub fn needs_drop_components<'tcx>(
1182     ty: Ty<'tcx>,
1183     target_layout: &TargetDataLayout,
1184 ) -> Result<SmallVec<[Ty<'tcx>; 2]>, AlwaysRequiresDrop> {
1185     match ty.kind() {
1186         ty::Infer(ty::FreshIntTy(_))
1187         | ty::Infer(ty::FreshFloatTy(_))
1188         | ty::Bool
1189         | ty::Int(_)
1190         | ty::Uint(_)
1191         | ty::Float(_)
1192         | ty::Never
1193         | ty::FnDef(..)
1194         | ty::FnPtr(_)
1195         | ty::Char
1196         | ty::GeneratorWitness(..)
1197         | ty::RawPtr(_)
1198         | ty::Ref(..)
1199         | ty::Str => Ok(SmallVec::new()),
1200
1201         // Foreign types can never have destructors.
1202         ty::Foreign(..) => Ok(SmallVec::new()),
1203
1204         ty::Dynamic(..) | ty::Error(_) => Err(AlwaysRequiresDrop),
1205
1206         ty::Slice(ty) => needs_drop_components(*ty, target_layout),
1207         ty::Array(elem_ty, size) => {
1208             match needs_drop_components(*elem_ty, target_layout) {
1209                 Ok(v) if v.is_empty() => Ok(v),
1210                 res => match size.kind().try_to_bits(target_layout.pointer_size) {
1211                     // Arrays of size zero don't need drop, even if their element
1212                     // type does.
1213                     Some(0) => Ok(SmallVec::new()),
1214                     Some(_) => res,
1215                     // We don't know which of the cases above we are in, so
1216                     // return the whole type and let the caller decide what to
1217                     // do.
1218                     None => Ok(smallvec![ty]),
1219                 },
1220             }
1221         }
1222         // If any field needs drop, then the whole tuple does.
1223         ty::Tuple(fields) => fields.iter().try_fold(SmallVec::new(), move |mut acc, elem| {
1224             acc.extend(needs_drop_components(elem, target_layout)?);
1225             Ok(acc)
1226         }),
1227
1228         // These require checking for `Copy` bounds or `Adt` destructors.
1229         ty::Adt(..)
1230         | ty::Alias(..)
1231         | ty::Param(_)
1232         | ty::Bound(..)
1233         | ty::Placeholder(..)
1234         | ty::Infer(_)
1235         | ty::Closure(..)
1236         | ty::Generator(..) => Ok(smallvec![ty]),
1237     }
1238 }
1239
1240 pub fn is_trivially_const_drop(ty: Ty<'_>) -> bool {
1241     match *ty.kind() {
1242         ty::Bool
1243         | ty::Char
1244         | ty::Int(_)
1245         | ty::Uint(_)
1246         | ty::Float(_)
1247         | ty::Infer(ty::IntVar(_))
1248         | ty::Infer(ty::FloatVar(_))
1249         | ty::Str
1250         | ty::RawPtr(_)
1251         | ty::Ref(..)
1252         | ty::FnDef(..)
1253         | ty::FnPtr(_)
1254         | ty::Never
1255         | ty::Foreign(_) => true,
1256
1257         ty::Alias(..)
1258         | ty::Dynamic(..)
1259         | ty::Error(_)
1260         | ty::Bound(..)
1261         | ty::Param(_)
1262         | ty::Placeholder(_)
1263         | ty::Infer(_) => false,
1264
1265         // Not trivial because they have components, and instead of looking inside,
1266         // we'll just perform trait selection.
1267         ty::Closure(..) | ty::Generator(..) | ty::GeneratorWitness(_) | ty::Adt(..) => false,
1268
1269         ty::Array(ty, _) | ty::Slice(ty) => is_trivially_const_drop(ty),
1270
1271         ty::Tuple(tys) => tys.iter().all(|ty| is_trivially_const_drop(ty)),
1272     }
1273 }
1274
1275 /// Does the equivalent of
1276 /// ```ignore (ilustrative)
1277 /// let v = self.iter().map(|p| p.fold_with(folder)).collect::<SmallVec<[_; 8]>>();
1278 /// folder.tcx().intern_*(&v)
1279 /// ```
1280 pub fn fold_list<'tcx, F, T>(
1281     list: &'tcx ty::List<T>,
1282     folder: &mut F,
1283     intern: impl FnOnce(TyCtxt<'tcx>, &[T]) -> &'tcx ty::List<T>,
1284 ) -> Result<&'tcx ty::List<T>, F::Error>
1285 where
1286     F: FallibleTypeFolder<'tcx>,
1287     T: TypeFoldable<'tcx> + PartialEq + Copy,
1288 {
1289     let mut iter = list.iter();
1290     // Look for the first element that changed
1291     match iter.by_ref().enumerate().find_map(|(i, t)| match t.try_fold_with(folder) {
1292         Ok(new_t) if new_t == t => None,
1293         new_t => Some((i, new_t)),
1294     }) {
1295         Some((i, Ok(new_t))) => {
1296             // An element changed, prepare to intern the resulting list
1297             let mut new_list = SmallVec::<[_; 8]>::with_capacity(list.len());
1298             new_list.extend_from_slice(&list[..i]);
1299             new_list.push(new_t);
1300             for t in iter {
1301                 new_list.push(t.try_fold_with(folder)?)
1302             }
1303             Ok(intern(folder.tcx(), &new_list))
1304         }
1305         Some((_, Err(err))) => {
1306             return Err(err);
1307         }
1308         None => Ok(list),
1309     }
1310 }
1311
1312 #[derive(Copy, Clone, Debug, HashStable, TyEncodable, TyDecodable)]
1313 pub struct AlwaysRequiresDrop;
1314
1315 /// Reveals all opaque types in the given value, replacing them
1316 /// with their underlying types.
1317 pub fn reveal_opaque_types_in_bounds<'tcx>(
1318     tcx: TyCtxt<'tcx>,
1319     val: &'tcx ty::List<ty::Predicate<'tcx>>,
1320 ) -> &'tcx ty::List<ty::Predicate<'tcx>> {
1321     let mut visitor = OpaqueTypeExpander {
1322         seen_opaque_tys: FxHashSet::default(),
1323         expanded_cache: FxHashMap::default(),
1324         primary_def_id: None,
1325         found_recursion: false,
1326         found_any_recursion: false,
1327         check_recursion: false,
1328         tcx,
1329     };
1330     val.fold_with(&mut visitor)
1331 }
1332
1333 /// Determines whether an item is annotated with `doc(hidden)`.
1334 pub fn is_doc_hidden(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
1335     tcx.get_attrs(def_id, sym::doc)
1336         .filter_map(|attr| attr.meta_item_list())
1337         .any(|items| items.iter().any(|item| item.has_name(sym::hidden)))
1338 }
1339
1340 /// Determines whether an item is annotated with `doc(notable_trait)`.
1341 pub fn is_doc_notable_trait(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
1342     tcx.get_attrs(def_id, sym::doc)
1343         .filter_map(|attr| attr.meta_item_list())
1344         .any(|items| items.iter().any(|item| item.has_name(sym::notable_trait)))
1345 }
1346
1347 /// Determines whether an item is an intrinsic by Abi.
1348 pub fn is_intrinsic(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
1349     matches!(tcx.fn_sig(def_id).abi(), Abi::RustIntrinsic | Abi::PlatformIntrinsic)
1350 }
1351
1352 pub fn provide(providers: &mut ty::query::Providers) {
1353     *providers = ty::query::Providers {
1354         reveal_opaque_types_in_bounds,
1355         is_doc_hidden,
1356         is_doc_notable_trait,
1357         is_intrinsic,
1358         ..*providers
1359     }
1360 }