src/librustc/ty/context.rs

   1 // ignore-tidy-filelength
   2
   3 //! Type context book-keeping.
   4
   5 use crate::arena::Arena;
   6 use crate::dep_graph::DepGraph;
   7 use crate::dep_graph::{self, DepNode, DepConstructor};
   8 use crate::session::Session;
   9 use crate::session::config::{BorrowckMode, OutputFilenames};
  10 use crate::session::config::CrateType;
  11 use crate::middle;
  12 use crate::hir::{TraitCandidate, HirId, ItemKind, ItemLocalId, Node};
  13 use crate::hir::def::{Res, DefKind, Export};
  14 use crate::hir::def_id::{CrateNum, DefId, DefIndex, LOCAL_CRATE};
  15 use crate::hir::map as hir_map;
  16 use crate::hir::map::DefPathHash;
  17 use crate::lint::{self, Lint};
  18 use crate::ich::{StableHashingContext, NodeIdHashingMode};
  19 use crate::infer::canonical::{Canonical, CanonicalVarInfo, CanonicalVarInfos};
  20 use crate::infer::outlives::free_region_map::FreeRegionMap;
  21 use crate::middle::cstore::CrateStoreDyn;
  22 use crate::middle::cstore::EncodedMetadata;
  23 use crate::middle::lang_items;
  24 use crate::middle::resolve_lifetime::{self, ObjectLifetimeDefault};
  25 use crate::middle::stability;
  26 use crate::mir::{self, Body, interpret, ProjectionKind};
  27 use crate::mir::interpret::{ConstValue, Allocation, Scalar};
  28 use crate::ty::subst::{Kind, InternalSubsts, SubstsRef, Subst};
  29 use crate::ty::ReprOptions;
  30 use crate::traits;
  31 use crate::traits::{Clause, Clauses, GoalKind, Goal, Goals};
  32 use crate::ty::{self, DefIdTree, Ty, TypeAndMut};
  33 use crate::ty::{TyS, TyKind, List};
  34 use crate::ty::{AdtKind, AdtDef, ClosureSubsts, GeneratorSubsts, Region, Const};
  35 use crate::ty::{PolyFnSig, InferTy, ParamTy, ProjectionTy, ExistentialPredicate, Predicate};
  36 use crate::ty::RegionKind;
  37 use crate::ty::{TyVar, TyVid, IntVar, IntVid, FloatVar, FloatVid, ConstVid};
  38 use crate::ty::TyKind::*;
  39 use crate::ty::{InferConst, ParamConst};
  40 use crate::ty::GenericParamDefKind;
  41 use crate::ty::layout::{LayoutDetails, TargetDataLayout, VariantIdx};
  42 use crate::ty::query;
  43 use crate::ty::steal::Steal;
  44 use crate::ty::subst::{UserSubsts, UnpackedKind};
  45 use crate::ty::{BoundVar, BindingMode};
  46 use crate::ty::CanonicalPolyFnSig;
  47 use crate::util::common::ErrorReported;
  48 use crate::util::nodemap::{DefIdMap, DefIdSet, ItemLocalMap, ItemLocalSet};
  49 use crate::util::nodemap::{FxHashMap, FxHashSet};
  50 use errors::DiagnosticBuilder;
  51 use rustc_data_structures::interner::HashInterner;
  52 use smallvec::SmallVec;
  53 use rustc_data_structures::stable_hasher::{HashStable, hash_stable_hashmap,
  54                                            StableHasher, StableHasherResult,
  55                                            StableVec};
  56 use arena::SyncDroplessArena;
  57 use rustc_data_structures::indexed_vec::{Idx, IndexVec};
  58 use rustc_data_structures::sync::{Lrc, Lock, WorkerLocal};
  59 use std::any::Any;
  60 use std::borrow::Borrow;
  61 use std::cmp::Ordering;
  62 use std::collections::hash_map::{self, Entry};
  63 use std::hash::{Hash, Hasher};
  64 use std::fmt;
  65 use std::mem;
  66 use std::ops::{Deref, Bound};
  67 use std::iter;
  68 use std::sync::mpsc;
  69 use std::sync::Arc;
  70 use std::marker::PhantomData;
  71 use rustc_target::spec::abi;
  72 use rustc_macros::HashStable;
  73 use syntax::ast;
  74 use syntax::attr;
  75 use syntax::source_map::MultiSpan;
  76 use syntax::feature_gate;
  77 use syntax::symbol::{Symbol, InternedString, kw, sym};
  78 use syntax_pos::Span;
  79
  80 use crate::hir;
  81
  82 pub struct AllArenas {
  83     pub interner: SyncDroplessArena,
  84     pub local_interner: SyncDroplessArena,
  85 }
  86
  87 impl AllArenas {
  88     pub fn new() -> Self {
  89         AllArenas {
  90             interner: SyncDroplessArena::default(),
  91             local_interner: SyncDroplessArena::default(),
  92         }
  93     }
  94 }
  95
  96 type InternedSet<'tcx, T> = Lock<FxHashMap<Interned<'tcx, T>, ()>>;
  97
  98 pub struct CtxtInterners<'tcx> {
  99     /// The arena that types, regions, etc are allocated from
 100     arena: &'tcx SyncDroplessArena,
 101
 102     /// Specifically use a speedy hash algorithm for these hash sets,
 103     /// they're accessed quite often.
 104     type_: InternedSet<'tcx, TyS<'tcx>>,
 105     type_list: InternedSet<'tcx, List<Ty<'tcx>>>,
 106     substs: InternedSet<'tcx, InternalSubsts<'tcx>>,
 107     canonical_var_infos: InternedSet<'tcx, List<CanonicalVarInfo>>,
 108     region: InternedSet<'tcx, RegionKind>,
 109     existential_predicates: InternedSet<'tcx, List<ExistentialPredicate<'tcx>>>,
 110     predicates: InternedSet<'tcx, List<Predicate<'tcx>>>,
 111     clauses: InternedSet<'tcx, List<Clause<'tcx>>>,
 112     goal: InternedSet<'tcx, GoalKind<'tcx>>,
 113     goal_list: InternedSet<'tcx, List<Goal<'tcx>>>,
 114     projs: InternedSet<'tcx, List<ProjectionKind>>,
 115     const_: InternedSet<'tcx, Const<'tcx>>,
 116 }
 117
 118 impl<'tcx> CtxtInterners<'tcx> {
 119     fn new(arena: &'tcx SyncDroplessArena) -> CtxtInterners<'tcx> {
 120         CtxtInterners {
 121             arena,
 122             type_: Default::default(),
 123             type_list: Default::default(),
 124             substs: Default::default(),
 125             region: Default::default(),
 126             existential_predicates: Default::default(),
 127             canonical_var_infos: Default::default(),
 128             predicates: Default::default(),
 129             clauses: Default::default(),
 130             goal: Default::default(),
 131             goal_list: Default::default(),
 132             projs: Default::default(),
 133             const_: Default::default(),
 134         }
 135     }
 136
 137     /// Intern a type
 138     #[inline(never)]
 139     fn intern_ty(
 140         local: &CtxtInterners<'tcx>,
 141         global: &CtxtInterners<'tcx>,
 142         st: TyKind<'tcx>,
 143     ) -> Ty<'tcx> {
 144         let flags = super::flags::FlagComputation::for_sty(&st);
 145
 146         // HACK(eddyb) Depend on flags being accurate to
 147         // determine that all contents are in the global tcx.
 148         // See comments on Lift for why we can't use that.
 149         if flags.flags.intersects(ty::TypeFlags::KEEP_IN_LOCAL_TCX) {
 150             local.type_.borrow_mut().intern(st, |st| {
 151                 let ty_struct = TyS {
 152                     sty: st,
 153                     flags: flags.flags,
 154                     outer_exclusive_binder: flags.outer_exclusive_binder,
 155                 };
 156
 157                 // Make sure we don't end up with inference
 158                 // types/regions in the global interner
 159                 if ptr_eq(local, global) {
 160                     bug!("Attempted to intern `{:?}` which contains \
 161                         inference types/regions in the global type context",
 162                         &ty_struct);
 163                 }
 164
 165                 // This is safe because all the types the ty_struct can point to
 166                 // already is in the local arena or the global arena
 167                 let ty_struct: TyS<'tcx> = unsafe {
 168                     mem::transmute(ty_struct)
 169                 };
 170
 171                 Interned(local.arena.alloc(ty_struct))
 172             }).0
 173         } else {
 174             global.type_.borrow_mut().intern(st, |st| {
 175                 let ty_struct = TyS {
 176                     sty: st,
 177                     flags: flags.flags,
 178                     outer_exclusive_binder: flags.outer_exclusive_binder,
 179                 };
 180
 181                 // This is safe because all the types the ty_struct can point to
 182                 // already is in the global arena
 183                 let ty_struct: TyS<'tcx> = unsafe {
 184                     mem::transmute(ty_struct)
 185                 };
 186
 187                 Interned(global.arena.alloc(ty_struct))
 188             }).0
 189         }
 190     }
 191 }
 192
 193 pub struct Common<'tcx> {
 194     pub empty_predicates: ty::GenericPredicates<'tcx>,
 195 }
 196
 197 pub struct CommonTypes<'tcx> {
 198     pub unit: Ty<'tcx>,
 199     pub bool: Ty<'tcx>,
 200     pub char: Ty<'tcx>,
 201     pub isize: Ty<'tcx>,
 202     pub i8: Ty<'tcx>,
 203     pub i16: Ty<'tcx>,
 204     pub i32: Ty<'tcx>,
 205     pub i64: Ty<'tcx>,
 206     pub i128: Ty<'tcx>,
 207     pub usize: Ty<'tcx>,
 208     pub u8: Ty<'tcx>,
 209     pub u16: Ty<'tcx>,
 210     pub u32: Ty<'tcx>,
 211     pub u64: Ty<'tcx>,
 212     pub u128: Ty<'tcx>,
 213     pub f32: Ty<'tcx>,
 214     pub f64: Ty<'tcx>,
 215     pub never: Ty<'tcx>,
 216     pub err: Ty<'tcx>,
 217
 218     /// Dummy type used for the `Self` of a `TraitRef` created for converting
 219     /// a trait object, and which gets removed in `ExistentialTraitRef`.
 220     /// This type must not appear anywhere in other converted types.
 221     pub trait_object_dummy_self: Ty<'tcx>,
 222 }
 223
 224 pub struct CommonLifetimes<'tcx> {
 225     pub re_empty: Region<'tcx>,
 226     pub re_static: Region<'tcx>,
 227     pub re_erased: Region<'tcx>,
 228 }
 229
 230 pub struct CommonConsts<'tcx> {
 231     pub err: &'tcx Const<'tcx>,
 232 }
 233
 234 pub struct LocalTableInContext<'a, V: 'a> {
 235     local_id_root: Option<DefId>,
 236     data: &'a ItemLocalMap<V>
 237 }
 238
 239 /// Validate that the given HirId (respectively its `local_id` part) can be
 240 /// safely used as a key in the tables of a TypeckTable. For that to be
 241 /// the case, the HirId must have the same `owner` as all the other IDs in
 242 /// this table (signified by `local_id_root`). Otherwise the HirId
 243 /// would be in a different frame of reference and using its `local_id`
 244 /// would result in lookup errors, or worse, in silently wrong data being
 245 /// stored/returned.
 246 fn validate_hir_id_for_typeck_tables(local_id_root: Option<DefId>,
 247                                      hir_id: hir::HirId,
 248                                      mut_access: bool) {
 249     if cfg!(debug_assertions) {
 250         if let Some(local_id_root) = local_id_root {
 251             if hir_id.owner != local_id_root.index {
 252                 ty::tls::with(|tcx| {
 253                     bug!("node {} with HirId::owner {:?} cannot be placed in \
 254                           TypeckTables with local_id_root {:?}",
 255                          tcx.hir().node_to_string(hir_id),
 256                          DefId::local(hir_id.owner),
 257                          local_id_root)
 258                 });
 259             }
 260         } else {
 261             // We use "Null Object" TypeckTables in some of the analysis passes.
 262             // These are just expected to be empty and their `local_id_root` is
 263             // `None`. Therefore we cannot verify whether a given `HirId` would
 264             // be a valid key for the given table. Instead we make sure that
 265             // nobody tries to write to such a Null Object table.
 266             if mut_access {
 267                 bug!("access to invalid TypeckTables")
 268             }
 269         }
 270     }
 271 }
 272
 273 impl<'a, V> LocalTableInContext<'a, V> {
 274     pub fn contains_key(&self, id: hir::HirId) -> bool {
 275         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 276         self.data.contains_key(&id.local_id)
 277     }
 278
 279     pub fn get(&self, id: hir::HirId) -> Option<&V> {
 280         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 281         self.data.get(&id.local_id)
 282     }
 283
 284     pub fn iter(&self) -> hash_map::Iter<'_, hir::ItemLocalId, V> {
 285         self.data.iter()
 286     }
 287 }
 288
 289 impl<'a, V> ::std::ops::Index<hir::HirId> for LocalTableInContext<'a, V> {
 290     type Output = V;
 291
 292     fn index(&self, key: hir::HirId) -> &V {
 293         self.get(key).expect("LocalTableInContext: key not found")
 294     }
 295 }
 296
 297 pub struct LocalTableInContextMut<'a, V: 'a> {
 298     local_id_root: Option<DefId>,
 299     data: &'a mut ItemLocalMap<V>
 300 }
 301
 302 impl<'a, V> LocalTableInContextMut<'a, V> {
 303     pub fn get_mut(&mut self, id: hir::HirId) -> Option<&mut V> {
 304         validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
 305         self.data.get_mut(&id.local_id)
 306     }
 307
 308     pub fn entry(&mut self, id: hir::HirId) -> Entry<'_, hir::ItemLocalId, V> {
 309         validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
 310         self.data.entry(id.local_id)
 311     }
 312
 313     pub fn insert(&mut self, id: hir::HirId, val: V) -> Option<V> {
 314         validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
 315         self.data.insert(id.local_id, val)
 316     }
 317
 318     pub fn remove(&mut self, id: hir::HirId) -> Option<V> {
 319         validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
 320         self.data.remove(&id.local_id)
 321     }
 322 }
 323
 324 /// All information necessary to validate and reveal an `impl Trait` or `existential Type`
 325 #[derive(RustcEncodable, RustcDecodable, Debug, HashStable)]
 326 pub struct ResolvedOpaqueTy<'tcx> {
 327     /// The revealed type as seen by this function.
 328     pub concrete_type: Ty<'tcx>,
 329     /// Generic parameters on the opaque type as passed by this function.
 330     /// For `existential type Foo<A, B>; fn foo<T, U>() -> Foo<T, U> { .. }` this is `[T, U]`, not
 331     /// `[A, B]`
 332     pub substs: SubstsRef<'tcx>,
 333 }
 334
 335 #[derive(RustcEncodable, RustcDecodable, Debug)]
 336 pub struct TypeckTables<'tcx> {
 337     /// The HirId::owner all ItemLocalIds in this table are relative to.
 338     pub local_id_root: Option<DefId>,
 339
 340     /// Resolved definitions for `<T>::X` associated paths and
 341     /// method calls, including those of overloaded operators.
 342     type_dependent_defs: ItemLocalMap<Result<(DefKind, DefId), ErrorReported>>,
 343
 344     /// Resolved field indices for field accesses in expressions (`S { field }`, `obj.field`)
 345     /// or patterns (`S { field }`). The index is often useful by itself, but to learn more
 346     /// about the field you also need definition of the variant to which the field
 347     /// belongs, but it may not exist if it's a tuple field (`tuple.0`).
 348     field_indices: ItemLocalMap<usize>,
 349
 350     /// Stores the types for various nodes in the AST. Note that this table
 351     /// is not guaranteed to be populated until after typeck. See
 352     /// typeck::check::fn_ctxt for details.
 353     node_types: ItemLocalMap<Ty<'tcx>>,
 354
 355     /// Stores the type parameters which were substituted to obtain the type
 356     /// of this node. This only applies to nodes that refer to entities
 357     /// parameterized by type parameters, such as generic fns, types, or
 358     /// other items.
 359     node_substs: ItemLocalMap<SubstsRef<'tcx>>,
 360
 361     /// This will either store the canonicalized types provided by the user
 362     /// or the substitutions that the user explicitly gave (if any) attached
 363     /// to `id`. These will not include any inferred values. The canonical form
 364     /// is used to capture things like `_` or other unspecified values.
 365     ///
 366     /// For example, if the user wrote `foo.collect::<Vec<_>>()`, then the
 367     /// canonical substitutions would include only `for<X> { Vec<X> }`.
 368     ///
 369     /// See also `AscribeUserType` statement in MIR.
 370     user_provided_types: ItemLocalMap<CanonicalUserType<'tcx>>,
 371
 372     /// Stores the canonicalized types provided by the user. See also
 373     /// `AscribeUserType` statement in MIR.
 374     pub user_provided_sigs: DefIdMap<CanonicalPolyFnSig<'tcx>>,
 375
 376     adjustments: ItemLocalMap<Vec<ty::adjustment::Adjustment<'tcx>>>,
 377
 378     /// Stores the actual binding mode for all instances of hir::BindingAnnotation.
 379     pat_binding_modes: ItemLocalMap<BindingMode>,
 380
 381     /// Stores the types which were implicitly dereferenced in pattern binding modes
 382     /// for later usage in HAIR lowering. For example,
 383     ///
 384     /// ```
 385     /// match &&Some(5i32) {
 386     ///     Some(n) => {},
 387     ///     _ => {},
 388     /// }
 389     /// ```
 390     /// leads to a `vec![&&Option<i32>, &Option<i32>]`. Empty vectors are not stored.
 391     ///
 392     /// See:
 393     /// https://github.com/rust-lang/rfcs/blob/master/text/2005-match-ergonomics.md#definitions
 394     pat_adjustments: ItemLocalMap<Vec<Ty<'tcx>>>,
 395
 396     /// Borrows
 397     pub upvar_capture_map: ty::UpvarCaptureMap<'tcx>,
 398
 399     /// Records the reasons that we picked the kind of each closure;
 400     /// not all closures are present in the map.
 401     closure_kind_origins: ItemLocalMap<(Span, ast::Name)>,
 402
 403     /// For each fn, records the "liberated" types of its arguments
 404     /// and return type. Liberated means that all bound regions
 405     /// (including late-bound regions) are replaced with free
 406     /// equivalents. This table is not used in codegen (since regions
 407     /// are erased there) and hence is not serialized to metadata.
 408     liberated_fn_sigs: ItemLocalMap<ty::FnSig<'tcx>>,
 409
 410     /// For each FRU expression, record the normalized types of the fields
 411     /// of the struct - this is needed because it is non-trivial to
 412     /// normalize while preserving regions. This table is used only in
 413     /// MIR construction and hence is not serialized to metadata.
 414     fru_field_types: ItemLocalMap<Vec<Ty<'tcx>>>,
 415
 416     /// For every coercion cast we add the HIR node ID of the cast
 417     /// expression to this set.
 418     coercion_casts: ItemLocalSet,
 419
 420     /// Set of trait imports actually used in the method resolution.
 421     /// This is used for warning unused imports. During type
 422     /// checking, this `Lrc` should not be cloned: it must have a ref-count
 423     /// of 1 so that we can insert things into the set mutably.
 424     pub used_trait_imports: Lrc<DefIdSet>,
 425
 426     /// If any errors occurred while type-checking this body,
 427     /// this field will be set to `true`.
 428     pub tainted_by_errors: bool,
 429
 430     /// Stores the free-region relationships that were deduced from
 431     /// its where-clauses and parameter types. These are then
 432     /// read-again by borrowck.
 433     pub free_region_map: FreeRegionMap<'tcx>,
 434
 435     /// All the existential types that are restricted to concrete types
 436     /// by this function
 437     pub concrete_existential_types: FxHashMap<DefId, ResolvedOpaqueTy<'tcx>>,
 438
 439     /// Given the closure ID this map provides the list of UpvarIDs used by it.
 440     /// The upvarID contains the HIR node ID and it also contains the full path
 441     /// leading to the member of the struct or tuple that is used instead of the
 442     /// entire variable.
 443     pub upvar_list: ty::UpvarListMap,
 444 }
 445
 446 impl<'tcx> TypeckTables<'tcx> {
 447     pub fn empty(local_id_root: Option<DefId>) -> TypeckTables<'tcx> {
 448         TypeckTables {
 449             local_id_root,
 450             type_dependent_defs: Default::default(),
 451             field_indices: Default::default(),
 452             user_provided_types: Default::default(),
 453             user_provided_sigs: Default::default(),
 454             node_types: Default::default(),
 455             node_substs: Default::default(),
 456             adjustments: Default::default(),
 457             pat_binding_modes: Default::default(),
 458             pat_adjustments: Default::default(),
 459             upvar_capture_map: Default::default(),
 460             closure_kind_origins: Default::default(),
 461             liberated_fn_sigs: Default::default(),
 462             fru_field_types: Default::default(),
 463             coercion_casts: Default::default(),
 464             used_trait_imports: Lrc::new(Default::default()),
 465             tainted_by_errors: false,
 466             free_region_map: Default::default(),
 467             concrete_existential_types: Default::default(),
 468             upvar_list: Default::default(),
 469         }
 470     }
 471
 472     /// Returns the final resolution of a `QPath` in an `Expr` or `Pat` node.
 473     pub fn qpath_res(&self, qpath: &hir::QPath, id: hir::HirId) -> Res {
 474         match *qpath {
 475             hir::QPath::Resolved(_, ref path) => path.res,
 476             hir::QPath::TypeRelative(..) => self.type_dependent_def(id)
 477                 .map_or(Res::Err, |(kind, def_id)| Res::Def(kind, def_id)),
 478         }
 479     }
 480
 481     pub fn type_dependent_defs(
 482         &self,
 483     ) -> LocalTableInContext<'_, Result<(DefKind, DefId), ErrorReported>> {
 484         LocalTableInContext {
 485             local_id_root: self.local_id_root,
 486             data: &self.type_dependent_defs
 487         }
 488     }
 489
 490     pub fn type_dependent_def(&self, id: HirId) -> Option<(DefKind, DefId)> {
 491         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 492         self.type_dependent_defs.get(&id.local_id).cloned().and_then(|r| r.ok())
 493     }
 494
 495     pub fn type_dependent_def_id(&self, id: HirId) -> Option<DefId> {
 496         self.type_dependent_def(id).map(|(_, def_id)| def_id)
 497     }
 498
 499     pub fn type_dependent_defs_mut(
 500         &mut self,
 501     ) -> LocalTableInContextMut<'_, Result<(DefKind, DefId), ErrorReported>> {
 502         LocalTableInContextMut {
 503             local_id_root: self.local_id_root,
 504             data: &mut self.type_dependent_defs
 505         }
 506     }
 507
 508     pub fn field_indices(&self) -> LocalTableInContext<'_, usize> {
 509         LocalTableInContext {
 510             local_id_root: self.local_id_root,
 511             data: &self.field_indices
 512         }
 513     }
 514
 515     pub fn field_indices_mut(&mut self) -> LocalTableInContextMut<'_, usize> {
 516         LocalTableInContextMut {
 517             local_id_root: self.local_id_root,
 518             data: &mut self.field_indices
 519         }
 520     }
 521
 522     pub fn user_provided_types(
 523         &self
 524     ) -> LocalTableInContext<'_, CanonicalUserType<'tcx>> {
 525         LocalTableInContext {
 526             local_id_root: self.local_id_root,
 527             data: &self.user_provided_types
 528         }
 529     }
 530
 531     pub fn user_provided_types_mut(
 532         &mut self
 533     ) -> LocalTableInContextMut<'_, CanonicalUserType<'tcx>> {
 534         LocalTableInContextMut {
 535             local_id_root: self.local_id_root,
 536             data: &mut self.user_provided_types
 537         }
 538     }
 539
 540     pub fn node_types(&self) -> LocalTableInContext<'_, Ty<'tcx>> {
 541         LocalTableInContext {
 542             local_id_root: self.local_id_root,
 543             data: &self.node_types
 544         }
 545     }
 546
 547     pub fn node_types_mut(&mut self) -> LocalTableInContextMut<'_, Ty<'tcx>> {
 548         LocalTableInContextMut {
 549             local_id_root: self.local_id_root,
 550             data: &mut self.node_types
 551         }
 552     }
 553
 554     pub fn node_type(&self, id: hir::HirId) -> Ty<'tcx> {
 555         self.node_type_opt(id).unwrap_or_else(||
 556             bug!("node_type: no type for node `{}`",
 557                  tls::with(|tcx| tcx.hir().node_to_string(id)))
 558         )
 559     }
 560
 561     pub fn node_type_opt(&self, id: hir::HirId) -> Option<Ty<'tcx>> {
 562         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 563         self.node_types.get(&id.local_id).cloned()
 564     }
 565
 566     pub fn node_substs_mut(&mut self) -> LocalTableInContextMut<'_, SubstsRef<'tcx>> {
 567         LocalTableInContextMut {
 568             local_id_root: self.local_id_root,
 569             data: &mut self.node_substs
 570         }
 571     }
 572
 573     pub fn node_substs(&self, id: hir::HirId) -> SubstsRef<'tcx> {
 574         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 575         self.node_substs.get(&id.local_id).cloned().unwrap_or_else(|| InternalSubsts::empty())
 576     }
 577
 578     pub fn node_substs_opt(&self, id: hir::HirId) -> Option<SubstsRef<'tcx>> {
 579         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 580         self.node_substs.get(&id.local_id).cloned()
 581     }
 582
 583     // Returns the type of a pattern as a monotype. Like @expr_ty, this function
 584     // doesn't provide type parameter substitutions.
 585     pub fn pat_ty(&self, pat: &hir::Pat) -> Ty<'tcx> {
 586         self.node_type(pat.hir_id)
 587     }
 588
 589     pub fn pat_ty_opt(&self, pat: &hir::Pat) -> Option<Ty<'tcx>> {
 590         self.node_type_opt(pat.hir_id)
 591     }
 592
 593     // Returns the type of an expression as a monotype.
 594     //
 595     // NB (1): This is the PRE-ADJUSTMENT TYPE for the expression.  That is, in
 596     // some cases, we insert `Adjustment` annotations such as auto-deref or
 597     // auto-ref.  The type returned by this function does not consider such
 598     // adjustments.  See `expr_ty_adjusted()` instead.
 599     //
 600     // NB (2): This type doesn't provide type parameter substitutions; e.g., if you
 601     // ask for the type of "id" in "id(3)", it will return "fn(&isize) -> isize"
 602     // instead of "fn(ty) -> T with T = isize".
 603     pub fn expr_ty(&self, expr: &hir::Expr) -> Ty<'tcx> {
 604         self.node_type(expr.hir_id)
 605     }
 606
 607     pub fn expr_ty_opt(&self, expr: &hir::Expr) -> Option<Ty<'tcx>> {
 608         self.node_type_opt(expr.hir_id)
 609     }
 610
 611     pub fn adjustments(&self) -> LocalTableInContext<'_, Vec<ty::adjustment::Adjustment<'tcx>>> {
 612         LocalTableInContext {
 613             local_id_root: self.local_id_root,
 614             data: &self.adjustments
 615         }
 616     }
 617
 618     pub fn adjustments_mut(&mut self)
 619                            -> LocalTableInContextMut<'_, Vec<ty::adjustment::Adjustment<'tcx>>> {
 620         LocalTableInContextMut {
 621             local_id_root: self.local_id_root,
 622             data: &mut self.adjustments
 623         }
 624     }
 625
 626     pub fn expr_adjustments(&self, expr: &hir::Expr)
 627                             -> &[ty::adjustment::Adjustment<'tcx>] {
 628         validate_hir_id_for_typeck_tables(self.local_id_root, expr.hir_id, false);
 629         self.adjustments.get(&expr.hir_id.local_id).map_or(&[], |a| &a[..])
 630     }
 631
 632     /// Returns the type of `expr`, considering any `Adjustment`
 633     /// entry recorded for that expression.
 634     pub fn expr_ty_adjusted(&self, expr: &hir::Expr) -> Ty<'tcx> {
 635         self.expr_adjustments(expr)
 636             .last()
 637             .map_or_else(|| self.expr_ty(expr), |adj| adj.target)
 638     }
 639
 640     pub fn expr_ty_adjusted_opt(&self, expr: &hir::Expr) -> Option<Ty<'tcx>> {
 641         self.expr_adjustments(expr)
 642             .last()
 643             .map(|adj| adj.target)
 644             .or_else(|| self.expr_ty_opt(expr))
 645     }
 646
 647     pub fn is_method_call(&self, expr: &hir::Expr) -> bool {
 648         // Only paths and method calls/overloaded operators have
 649         // entries in type_dependent_defs, ignore the former here.
 650         if let hir::ExprKind::Path(_) = expr.node {
 651             return false;
 652         }
 653
 654         match self.type_dependent_defs().get(expr.hir_id) {
 655             Some(Ok((DefKind::Method, _))) => true,
 656             _ => false
 657         }
 658     }
 659
 660     pub fn pat_binding_modes(&self) -> LocalTableInContext<'_, BindingMode> {
 661         LocalTableInContext {
 662             local_id_root: self.local_id_root,
 663             data: &self.pat_binding_modes
 664         }
 665     }
 666
 667     pub fn pat_binding_modes_mut(&mut self)
 668                            -> LocalTableInContextMut<'_, BindingMode> {
 669         LocalTableInContextMut {
 670             local_id_root: self.local_id_root,
 671             data: &mut self.pat_binding_modes
 672         }
 673     }
 674
 675     pub fn pat_adjustments(&self) -> LocalTableInContext<'_, Vec<Ty<'tcx>>> {
 676         LocalTableInContext {
 677             local_id_root: self.local_id_root,
 678             data: &self.pat_adjustments,
 679         }
 680     }
 681
 682     pub fn pat_adjustments_mut(&mut self)
 683                                -> LocalTableInContextMut<'_, Vec<Ty<'tcx>>> {
 684         LocalTableInContextMut {
 685             local_id_root: self.local_id_root,
 686             data: &mut self.pat_adjustments,
 687         }
 688     }
 689
 690     pub fn upvar_capture(&self, upvar_id: ty::UpvarId) -> ty::UpvarCapture<'tcx> {
 691         self.upvar_capture_map[&upvar_id]
 692     }
 693
 694     pub fn closure_kind_origins(&self) -> LocalTableInContext<'_, (Span, ast::Name)> {
 695         LocalTableInContext {
 696             local_id_root: self.local_id_root,
 697             data: &self.closure_kind_origins
 698         }
 699     }
 700
 701     pub fn closure_kind_origins_mut(&mut self) -> LocalTableInContextMut<'_, (Span, ast::Name)> {
 702         LocalTableInContextMut {
 703             local_id_root: self.local_id_root,
 704             data: &mut self.closure_kind_origins
 705         }
 706     }
 707
 708     pub fn liberated_fn_sigs(&self) -> LocalTableInContext<'_, ty::FnSig<'tcx>> {
 709         LocalTableInContext {
 710             local_id_root: self.local_id_root,
 711             data: &self.liberated_fn_sigs
 712         }
 713     }
 714
 715     pub fn liberated_fn_sigs_mut(&mut self) -> LocalTableInContextMut<'_, ty::FnSig<'tcx>> {
 716         LocalTableInContextMut {
 717             local_id_root: self.local_id_root,
 718             data: &mut self.liberated_fn_sigs
 719         }
 720     }
 721
 722     pub fn fru_field_types(&self) -> LocalTableInContext<'_, Vec<Ty<'tcx>>> {
 723         LocalTableInContext {
 724             local_id_root: self.local_id_root,
 725             data: &self.fru_field_types
 726         }
 727     }
 728
 729     pub fn fru_field_types_mut(&mut self) -> LocalTableInContextMut<'_, Vec<Ty<'tcx>>> {
 730         LocalTableInContextMut {
 731             local_id_root: self.local_id_root,
 732             data: &mut self.fru_field_types
 733         }
 734     }
 735
 736     pub fn is_coercion_cast(&self, hir_id: hir::HirId) -> bool {
 737         validate_hir_id_for_typeck_tables(self.local_id_root, hir_id, true);
 738         self.coercion_casts.contains(&hir_id.local_id)
 739     }
 740
 741     pub fn set_coercion_cast(&mut self, id: ItemLocalId) {
 742         self.coercion_casts.insert(id);
 743     }
 744
 745     pub fn coercion_casts(&self) -> &ItemLocalSet {
 746         &self.coercion_casts
 747     }
 748
 749 }
 750
 751 impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for TypeckTables<'tcx> {
 752     fn hash_stable<W: StableHasherResult>(&self,
 753                                           hcx: &mut StableHashingContext<'a>,
 754                                           hasher: &mut StableHasher<W>) {
 755         let ty::TypeckTables {
 756             local_id_root,
 757             ref type_dependent_defs,
 758             ref field_indices,
 759             ref user_provided_types,
 760             ref user_provided_sigs,
 761             ref node_types,
 762             ref node_substs,
 763             ref adjustments,
 764             ref pat_binding_modes,
 765             ref pat_adjustments,
 766             ref upvar_capture_map,
 767             ref closure_kind_origins,
 768             ref liberated_fn_sigs,
 769             ref fru_field_types,
 770
 771             ref coercion_casts,
 772
 773             ref used_trait_imports,
 774             tainted_by_errors,
 775             ref free_region_map,
 776             ref concrete_existential_types,
 777             ref upvar_list,
 778
 779         } = *self;
 780
 781         hcx.with_node_id_hashing_mode(NodeIdHashingMode::HashDefPath, |hcx| {
 782             type_dependent_defs.hash_stable(hcx, hasher);
 783             field_indices.hash_stable(hcx, hasher);
 784             user_provided_types.hash_stable(hcx, hasher);
 785             user_provided_sigs.hash_stable(hcx, hasher);
 786             node_types.hash_stable(hcx, hasher);
 787             node_substs.hash_stable(hcx, hasher);
 788             adjustments.hash_stable(hcx, hasher);
 789             pat_binding_modes.hash_stable(hcx, hasher);
 790             pat_adjustments.hash_stable(hcx, hasher);
 791             hash_stable_hashmap(hcx, hasher, upvar_capture_map, |up_var_id, hcx| {
 792                 let ty::UpvarId {
 793                     var_path,
 794                     closure_expr_id
 795                 } = *up_var_id;
 796
 797                 let local_id_root =
 798                     local_id_root.expect("trying to hash invalid TypeckTables");
 799
 800                 let var_owner_def_id = DefId {
 801                     krate: local_id_root.krate,
 802                     index: var_path.hir_id.owner,
 803                 };
 804                 let closure_def_id = DefId {
 805                     krate: local_id_root.krate,
 806                     index: closure_expr_id.to_def_id().index,
 807                 };
 808                 (hcx.def_path_hash(var_owner_def_id),
 809                  var_path.hir_id.local_id,
 810                  hcx.def_path_hash(closure_def_id))
 811             });
 812
 813             closure_kind_origins.hash_stable(hcx, hasher);
 814             liberated_fn_sigs.hash_stable(hcx, hasher);
 815             fru_field_types.hash_stable(hcx, hasher);
 816             coercion_casts.hash_stable(hcx, hasher);
 817             used_trait_imports.hash_stable(hcx, hasher);
 818             tainted_by_errors.hash_stable(hcx, hasher);
 819             free_region_map.hash_stable(hcx, hasher);
 820             concrete_existential_types.hash_stable(hcx, hasher);
 821             upvar_list.hash_stable(hcx, hasher);
 822         })
 823     }
 824 }
 825
 826 newtype_index! {
 827     pub struct UserTypeAnnotationIndex {
 828         derive [HashStable]
 829         DEBUG_FORMAT = "UserType({})",
 830         const START_INDEX = 0,
 831     }
 832 }
 833
 834 /// Mapping of type annotation indices to canonical user type annotations.
 835 pub type CanonicalUserTypeAnnotations<'tcx> =
 836     IndexVec<UserTypeAnnotationIndex, CanonicalUserTypeAnnotation<'tcx>>;
 837
 838 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
 839 pub struct CanonicalUserTypeAnnotation<'tcx> {
 840     pub user_ty: CanonicalUserType<'tcx>,
 841     pub span: Span,
 842     pub inferred_ty: Ty<'tcx>,
 843 }
 844
 845 BraceStructTypeFoldableImpl! {
 846     impl<'tcx> TypeFoldable<'tcx> for CanonicalUserTypeAnnotation<'tcx> {
 847         user_ty, span, inferred_ty
 848     }
 849 }
 850
 851 BraceStructLiftImpl! {
 852     impl<'a, 'tcx> Lift<'tcx> for CanonicalUserTypeAnnotation<'a> {
 853         type Lifted = CanonicalUserTypeAnnotation<'tcx>;
 854         user_ty, span, inferred_ty
 855     }
 856 }
 857
 858 /// Canonicalized user type annotation.
 859 pub type CanonicalUserType<'tcx> = Canonical<'tcx, UserType<'tcx>>;
 860
 861 impl CanonicalUserType<'tcx> {
 862     /// Returns `true` if this represents a substitution of the form `[?0, ?1, ?2]`,
 863     /// i.e., each thing is mapped to a canonical variable with the same index.
 864     pub fn is_identity(&self) -> bool {
 865         match self.value {
 866             UserType::Ty(_) => false,
 867             UserType::TypeOf(_, user_substs) => {
 868                 if user_substs.user_self_ty.is_some() {
 869                     return false;
 870                 }
 871
 872                 user_substs.substs.iter().zip(BoundVar::new(0)..).all(|(kind, cvar)| {
 873                     match kind.unpack() {
 874                         UnpackedKind::Type(ty) => match ty.sty {
 875                             ty::Bound(debruijn, b) => {
 876                                 // We only allow a `ty::INNERMOST` index in substitutions.
 877                                 assert_eq!(debruijn, ty::INNERMOST);
 878                                 cvar == b.var
 879                             }
 880                             _ => false,
 881                         },
 882
 883                         UnpackedKind::Lifetime(r) => match r {
 884                             ty::ReLateBound(debruijn, br) => {
 885                                 // We only allow a `ty::INNERMOST` index in substitutions.
 886                                 assert_eq!(*debruijn, ty::INNERMOST);
 887                                 cvar == br.assert_bound_var()
 888                             }
 889                             _ => false,
 890                         },
 891
 892                         UnpackedKind::Const(ct) => match ct.val {
 893                             ConstValue::Infer(InferConst::Canonical(debruijn, b)) => {
 894                                 // We only allow a `ty::INNERMOST` index in substitutions.
 895                                 assert_eq!(debruijn, ty::INNERMOST);
 896                                 cvar == b
 897                             }
 898                             _ => false,
 899                         },
 900                     }
 901                 })
 902             },
 903         }
 904     }
 905 }
 906
 907 /// A user-given type annotation attached to a constant. These arise
 908 /// from constants that are named via paths, like `Foo::<A>::new` and
 909 /// so forth.
 910 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
 911 pub enum UserType<'tcx> {
 912     Ty(Ty<'tcx>),
 913
 914     /// The canonical type is the result of `type_of(def_id)` with the
 915     /// given substitutions applied.
 916     TypeOf(DefId, UserSubsts<'tcx>),
 917 }
 918
 919 EnumTypeFoldableImpl! {
 920     impl<'tcx> TypeFoldable<'tcx> for UserType<'tcx> {
 921         (UserType::Ty)(ty),
 922         (UserType::TypeOf)(def, substs),
 923     }
 924 }
 925
 926 EnumLiftImpl! {
 927     impl<'a, 'tcx> Lift<'tcx> for UserType<'a> {
 928         type Lifted = UserType<'tcx>;
 929         (UserType::Ty)(ty),
 930         (UserType::TypeOf)(def, substs),
 931     }
 932 }
 933
 934 impl<'tcx> CommonTypes<'tcx> {
 935     fn new(interners: &CtxtInterners<'tcx>) -> CommonTypes<'tcx> {
 936         let mk = |sty| CtxtInterners::intern_ty(interners, interners, sty);
 937
 938         CommonTypes {
 939             unit: mk(Tuple(List::empty())),
 940             bool: mk(Bool),
 941             char: mk(Char),
 942             never: mk(Never),
 943             err: mk(Error),
 944             isize: mk(Int(ast::IntTy::Isize)),
 945             i8: mk(Int(ast::IntTy::I8)),
 946             i16: mk(Int(ast::IntTy::I16)),
 947             i32: mk(Int(ast::IntTy::I32)),
 948             i64: mk(Int(ast::IntTy::I64)),
 949             i128: mk(Int(ast::IntTy::I128)),
 950             usize: mk(Uint(ast::UintTy::Usize)),
 951             u8: mk(Uint(ast::UintTy::U8)),
 952             u16: mk(Uint(ast::UintTy::U16)),
 953             u32: mk(Uint(ast::UintTy::U32)),
 954             u64: mk(Uint(ast::UintTy::U64)),
 955             u128: mk(Uint(ast::UintTy::U128)),
 956             f32: mk(Float(ast::FloatTy::F32)),
 957             f64: mk(Float(ast::FloatTy::F64)),
 958
 959             trait_object_dummy_self: mk(Infer(ty::FreshTy(0))),
 960         }
 961     }
 962 }
 963
 964 impl<'tcx> CommonLifetimes<'tcx> {
 965     fn new(interners: &CtxtInterners<'tcx>) -> CommonLifetimes<'tcx> {
 966         let mk = |r| {
 967             interners.region.borrow_mut().intern(r, |r| {
 968                 Interned(interners.arena.alloc(r))
 969             }).0
 970         };
 971
 972         CommonLifetimes {
 973             re_empty: mk(RegionKind::ReEmpty),
 974             re_static: mk(RegionKind::ReStatic),
 975             re_erased: mk(RegionKind::ReErased),
 976         }
 977     }
 978 }
 979
 980 impl<'tcx> CommonConsts<'tcx> {
 981     fn new(interners: &CtxtInterners<'tcx>, types: &CommonTypes<'tcx>) -> CommonConsts<'tcx> {
 982         let mk_const = |c| {
 983             interners.const_.borrow_mut().intern(c, |c| {
 984                 Interned(interners.arena.alloc(c))
 985             }).0
 986         };
 987
 988         CommonConsts {
 989             err: mk_const(ty::Const {
 990                 val: ConstValue::Scalar(Scalar::zst()),
 991                 ty: types.err,
 992             }),
 993         }
 994     }
 995 }
 996
 997 // This struct contains information regarding the `ReFree(FreeRegion)` corresponding to a lifetime
 998 // conflict.
 999 #[derive(Debug)]
1000 pub struct FreeRegionInfo {
1001     // def id corresponding to FreeRegion
1002     pub def_id: DefId,
1003     // the bound region corresponding to FreeRegion
1004     pub boundregion: ty::BoundRegion,
1005     // checks if bound region is in Impl Item
1006     pub is_impl_item: bool,
1007 }
1008
1009 /// The central data structure of the compiler. It stores references
1010 /// to the various **arenas** and also houses the results of the
1011 /// various **compiler queries** that have been performed. See the
1012 /// [rustc guide] for more details.
1013 ///
1014 /// [rustc guide]: https://rust-lang.github.io/rustc-guide/ty.html
1015 #[derive(Copy, Clone)]
1016 pub struct TyCtxt<'tcx> {
1017     gcx: &'tcx GlobalCtxt<'tcx>,
1018     interners: &'tcx CtxtInterners<'tcx>,
1019     dummy: PhantomData<&'tcx ()>,
1020 }
1021
1022 impl<'tcx> Deref for TyCtxt<'tcx> {
1023     type Target = &'tcx GlobalCtxt<'tcx>;
1024     #[inline(always)]
1025     fn deref(&self) -> &Self::Target {
1026         &self.gcx
1027     }
1028 }
1029
1030 pub struct GlobalCtxt<'tcx> {
1031     pub arena: WorkerLocal<Arena<'tcx>>,
1032
1033     global_interners: CtxtInterners<'tcx>,
1034     local_interners: CtxtInterners<'tcx>,
1035
1036     cstore: &'tcx CrateStoreDyn,
1037
1038     pub sess: &'tcx Session,
1039
1040     pub dep_graph: DepGraph,
1041
1042     /// Common objects.
1043     pub common: Common<'tcx>,
1044
1045     /// Common types, pre-interned for your convenience.
1046     pub types: CommonTypes<'tcx>,
1047
1048     /// Common lifetimes, pre-interned for your convenience.
1049     pub lifetimes: CommonLifetimes<'tcx>,
1050
1051     /// Common consts, pre-interned for your convenience.
1052     pub consts: CommonConsts<'tcx>,
1053
1054     /// Map indicating what traits are in scope for places where this
1055     /// is relevant; generated by resolve.
1056     trait_map: FxHashMap<DefIndex,
1057                          FxHashMap<ItemLocalId,
1058                                    StableVec<TraitCandidate>>>,
1059
1060     /// Export map produced by name resolution.
1061     export_map: FxHashMap<DefId, Vec<Export<hir::HirId>>>,
1062
1063     hir_map: hir_map::Map<'tcx>,
1064
1065     /// A map from DefPathHash -> DefId. Includes DefIds from the local crate
1066     /// as well as all upstream crates. Only populated in incremental mode.
1067     pub def_path_hash_to_def_id: Option<FxHashMap<DefPathHash, DefId>>,
1068
1069     pub queries: query::Queries<'tcx>,
1070
1071     maybe_unused_trait_imports: FxHashSet<DefId>,
1072     maybe_unused_extern_crates: Vec<(DefId, Span)>,
1073     /// A map of glob use to a set of names it actually imports. Currently only
1074     /// used in save-analysis.
1075     glob_map: FxHashMap<DefId, FxHashSet<ast::Name>>,
1076     /// Extern prelude entries. The value is `true` if the entry was introduced
1077     /// via `extern crate` item and not `--extern` option or compiler built-in.
1078     pub extern_prelude: FxHashMap<ast::Name, bool>,
1079
1080     // Internal cache for metadata decoding. No need to track deps on this.
1081     pub rcache: Lock<FxHashMap<ty::CReaderCacheKey, Ty<'tcx>>>,
1082
1083     /// Caches the results of trait selection. This cache is used
1084     /// for things that do not have to do with the parameters in scope.
1085     pub selection_cache: traits::SelectionCache<'tcx>,
1086
1087     /// Caches the results of trait evaluation. This cache is used
1088     /// for things that do not have to do with the parameters in scope.
1089     /// Merge this with `selection_cache`?
1090     pub evaluation_cache: traits::EvaluationCache<'tcx>,
1091
1092     /// The definite name of the current crate after taking into account
1093     /// attributes, commandline parameters, etc.
1094     pub crate_name: Symbol,
1095
1096     /// Data layout specification for the current target.
1097     pub data_layout: TargetDataLayout,
1098
1099     stability_interner: Lock<FxHashMap<&'tcx attr::Stability, ()>>,
1100
1101     /// Stores the value of constants (and deduplicates the actual memory)
1102     allocation_interner: Lock<FxHashMap<&'tcx Allocation, ()>>,
1103
1104     pub alloc_map: Lock<interpret::AllocMap<'tcx>>,
1105
1106     layout_interner: Lock<FxHashMap<&'tcx LayoutDetails, ()>>,
1107
1108     /// A general purpose channel to throw data out the back towards LLVM worker
1109     /// threads.
1110     ///
1111     /// This is intended to only get used during the codegen phase of the compiler
1112     /// when satisfying the query for a particular codegen unit. Internally in
1113     /// the query it'll send data along this channel to get processed later.
1114     pub tx_to_llvm_workers: Lock<mpsc::Sender<Box<dyn Any + Send>>>,
1115
1116     output_filenames: Arc<OutputFilenames>,
1117 }
1118
1119 impl<'tcx> TyCtxt<'tcx> {
1120     /// Gets the global `TyCtxt`.
1121     #[inline]
1122     pub fn global_tcx(self) -> TyCtxt<'tcx> {
1123         TyCtxt {
1124             gcx: self.gcx,
1125             interners: &self.gcx.global_interners,
1126             dummy: PhantomData,
1127         }
1128     }
1129
1130     #[inline(always)]
1131     pub fn hir(self) -> &'tcx hir_map::Map<'tcx> {
1132         &self.hir_map
1133     }
1134
1135     pub fn alloc_steal_mir(self, mir: Body<'tcx>) -> &'tcx Steal<Body<'tcx>> {
1136         self.arena.alloc(Steal::new(mir))
1137     }
1138
1139     pub fn alloc_adt_def(
1140         self,
1141         did: DefId,
1142         kind: AdtKind,
1143         variants: IndexVec<VariantIdx, ty::VariantDef>,
1144         repr: ReprOptions,
1145     ) -> &'tcx ty::AdtDef {
1146         let def = ty::AdtDef::new(self, did, kind, variants, repr);
1147         self.arena.alloc(def)
1148     }
1149
1150     pub fn intern_const_alloc(self, alloc: Allocation) -> &'tcx Allocation {
1151         self.allocation_interner.borrow_mut().intern(alloc, |alloc| {
1152             self.arena.alloc(alloc)
1153         })
1154     }
1155
1156     /// Allocates a byte or string literal for `mir::interpret`, read-only
1157     pub fn allocate_bytes(self, bytes: &[u8]) -> interpret::AllocId {
1158         // create an allocation that just contains these bytes
1159         let alloc = interpret::Allocation::from_byte_aligned_bytes(bytes);
1160         let alloc = self.intern_const_alloc(alloc);
1161         self.alloc_map.lock().create_memory_alloc(alloc)
1162     }
1163
1164     pub fn intern_stability(self, stab: attr::Stability) -> &'tcx attr::Stability {
1165         self.stability_interner.borrow_mut().intern(stab, |stab| {
1166             self.arena.alloc(stab)
1167         })
1168     }
1169
1170     pub fn intern_layout(self, layout: LayoutDetails) -> &'tcx LayoutDetails {
1171         self.layout_interner.borrow_mut().intern(layout, |layout| {
1172             self.arena.alloc(layout)
1173         })
1174     }
1175
1176     /// Returns a range of the start/end indices specified with the
1177     /// `rustc_layout_scalar_valid_range` attribute.
1178     pub fn layout_scalar_valid_range(self, def_id: DefId) -> (Bound<u128>, Bound<u128>) {
1179         let attrs = self.get_attrs(def_id);
1180         let get = |name| {
1181             let attr = match attrs.iter().find(|a| a.check_name(name)) {
1182                 Some(attr) => attr,
1183                 None => return Bound::Unbounded,
1184             };
1185             for meta in attr.meta_item_list().expect("rustc_layout_scalar_valid_range takes args") {
1186                 match meta.literal().expect("attribute takes lit").node {
1187                     ast::LitKind::Int(a, _) => return Bound::Included(a),
1188                     _ => span_bug!(attr.span, "rustc_layout_scalar_valid_range expects int arg"),
1189                 }
1190             }
1191             span_bug!(attr.span, "no arguments to `rustc_layout_scalar_valid_range` attribute");
1192         };
1193         (get(sym::rustc_layout_scalar_valid_range_start),
1194          get(sym::rustc_layout_scalar_valid_range_end))
1195     }
1196
1197     pub fn lift<T: ?Sized + Lift<'tcx>>(self, value: &T) -> Option<T::Lifted> {
1198         value.lift_to_tcx(self)
1199     }
1200
1201     /// Like lift, but only tries in the global tcx.
1202     pub fn lift_to_global<T: ?Sized + Lift<'tcx>>(self, value: &T) -> Option<T::Lifted> {
1203         value.lift_to_tcx(self.global_tcx())
1204     }
1205
1206     /// Returns `true` if self is the same as self.global_tcx().
1207     fn is_global(self) -> bool {
1208         ptr_eq(self.interners, &self.global_interners)
1209     }
1210
1211     /// Creates a type context and call the closure with a `TyCtxt` reference
1212     /// to the context. The closure enforces that the type context and any interned
1213     /// value (types, substs, etc.) can only be used while `ty::tls` has a valid
1214     /// reference to the context, to allow formatting values that need it.
1215     pub fn create_global_ctxt(
1216         s: &'tcx Session,
1217         cstore: &'tcx CrateStoreDyn,
1218         local_providers: ty::query::Providers<'tcx>,
1219         extern_providers: ty::query::Providers<'tcx>,
1220         arenas: &'tcx AllArenas,
1221         resolutions: ty::Resolutions,
1222         hir: hir_map::Map<'tcx>,
1223         on_disk_query_result_cache: query::OnDiskCache<'tcx>,
1224         crate_name: &str,
1225         tx: mpsc::Sender<Box<dyn Any + Send>>,
1226         output_filenames: &OutputFilenames,
1227     ) -> GlobalCtxt<'tcx> {
1228         let data_layout = TargetDataLayout::parse(&s.target.target).unwrap_or_else(|err| {
1229             s.fatal(&err);
1230         });
1231         let interners = CtxtInterners::new(&arenas.interner);
1232         let local_interners = CtxtInterners::new(&arenas.local_interner);
1233         let common = Common {
1234             empty_predicates: ty::GenericPredicates {
1235                 parent: None,
1236                 predicates: vec![],
1237             },
1238         };
1239         let common_types = CommonTypes::new(&interners);
1240         let common_lifetimes = CommonLifetimes::new(&interners);
1241         let common_consts = CommonConsts::new(&interners, &common_types);
1242         let dep_graph = hir.dep_graph.clone();
1243         let max_cnum = cstore.crates_untracked().iter().map(|c| c.as_usize()).max().unwrap_or(0);
1244         let mut providers = IndexVec::from_elem_n(extern_providers, max_cnum + 1);
1245         providers[LOCAL_CRATE] = local_providers;
1246
1247         let def_path_hash_to_def_id = if s.opts.build_dep_graph() {
1248             let upstream_def_path_tables: Vec<(CrateNum, Lrc<_>)> = cstore
1249                 .crates_untracked()
1250                 .iter()
1251                 .map(|&cnum| (cnum, cstore.def_path_table(cnum)))
1252                 .collect();
1253
1254             let def_path_tables = || {
1255                 upstream_def_path_tables
1256                     .iter()
1257                     .map(|&(cnum, ref rc)| (cnum, &**rc))
1258                     .chain(iter::once((LOCAL_CRATE, hir.definitions().def_path_table())))
1259             };
1260
1261             // Precompute the capacity of the hashmap so we don't have to
1262             // re-allocate when populating it.
1263             let capacity = def_path_tables().map(|(_, t)| t.size()).sum::<usize>();
1264
1265             let mut map: FxHashMap<_, _> = FxHashMap::with_capacity_and_hasher(
1266                 capacity,
1267                 ::std::default::Default::default()
1268             );
1269
1270             for (cnum, def_path_table) in def_path_tables() {
1271                 def_path_table.add_def_path_hashes_to(cnum, &mut map);
1272             }
1273
1274             Some(map)
1275         } else {
1276             None
1277         };
1278
1279         let mut trait_map: FxHashMap<_, FxHashMap<_, _>> = FxHashMap::default();
1280         for (k, v) in resolutions.trait_map {
1281             let hir_id = hir.node_to_hir_id(k);
1282             let map = trait_map.entry(hir_id.owner).or_default();
1283             map.insert(hir_id.local_id, StableVec::new(v));
1284         }
1285
1286         GlobalCtxt {
1287             sess: s,
1288             cstore,
1289             arena: WorkerLocal::new(|_| Arena::default()),
1290             global_interners: interners,
1291             local_interners: local_interners,
1292             dep_graph,
1293             common,
1294             types: common_types,
1295             lifetimes: common_lifetimes,
1296             consts: common_consts,
1297             trait_map,
1298             export_map: resolutions.export_map.into_iter().map(|(k, v)| {
1299                 let exports: Vec<_> = v.into_iter().map(|e| {
1300                     e.map_id(|id| hir.node_to_hir_id(id))
1301                 }).collect();
1302                 (k, exports)
1303             }).collect(),
1304             maybe_unused_trait_imports:
1305                 resolutions.maybe_unused_trait_imports
1306                     .into_iter()
1307                     .map(|id| hir.local_def_id(id))
1308                     .collect(),
1309             maybe_unused_extern_crates:
1310                 resolutions.maybe_unused_extern_crates
1311                     .into_iter()
1312                     .map(|(id, sp)| (hir.local_def_id(id), sp))
1313                     .collect(),
1314             glob_map: resolutions.glob_map.into_iter().map(|(id, names)| {
1315                 (hir.local_def_id(id), names)
1316             }).collect(),
1317             extern_prelude: resolutions.extern_prelude,
1318             hir_map: hir,
1319             def_path_hash_to_def_id,
1320             queries: query::Queries::new(
1321                 providers,
1322                 extern_providers,
1323                 on_disk_query_result_cache,
1324             ),
1325             rcache: Default::default(),
1326             selection_cache: Default::default(),
1327             evaluation_cache: Default::default(),
1328             crate_name: Symbol::intern(crate_name),
1329             data_layout,
1330             layout_interner: Default::default(),
1331             stability_interner: Default::default(),
1332             allocation_interner: Default::default(),
1333             alloc_map: Lock::new(interpret::AllocMap::new()),
1334             tx_to_llvm_workers: Lock::new(tx),
1335             output_filenames: Arc::new(output_filenames.clone()),
1336         }
1337     }
1338
1339     pub fn consider_optimizing<T: Fn() -> String>(&self, msg: T) -> bool {
1340         let cname = self.crate_name(LOCAL_CRATE).as_str();
1341         self.sess.consider_optimizing(&cname, msg)
1342     }
1343
1344     pub fn lib_features(self) -> &'tcx middle::lib_features::LibFeatures {
1345         self.get_lib_features(LOCAL_CRATE)
1346     }
1347
1348     pub fn lang_items(self) -> &'tcx middle::lang_items::LanguageItems {
1349         self.get_lang_items(LOCAL_CRATE)
1350     }
1351
1352     /// Due to missing llvm support for lowering 128 bit math to software emulation
1353     /// (on some targets), the lowering can be done in MIR.
1354     ///
1355     /// This function only exists until said support is implemented.
1356     pub fn is_binop_lang_item(&self, def_id: DefId) -> Option<(mir::BinOp, bool)> {
1357         let items = self.lang_items();
1358         let def_id = Some(def_id);
1359         if items.i128_add_fn() == def_id { Some((mir::BinOp::Add, false)) }
1360         else if items.u128_add_fn() == def_id { Some((mir::BinOp::Add, false)) }
1361         else if items.i128_sub_fn() == def_id { Some((mir::BinOp::Sub, false)) }
1362         else if items.u128_sub_fn() == def_id { Some((mir::BinOp::Sub, false)) }
1363         else if items.i128_mul_fn() == def_id { Some((mir::BinOp::Mul, false)) }
1364         else if items.u128_mul_fn() == def_id { Some((mir::BinOp::Mul, false)) }
1365         else if items.i128_div_fn() == def_id { Some((mir::BinOp::Div, false)) }
1366         else if items.u128_div_fn() == def_id { Some((mir::BinOp::Div, false)) }
1367         else if items.i128_rem_fn() == def_id { Some((mir::BinOp::Rem, false)) }
1368         else if items.u128_rem_fn() == def_id { Some((mir::BinOp::Rem, false)) }
1369         else if items.i128_shl_fn() == def_id { Some((mir::BinOp::Shl, false)) }
1370         else if items.u128_shl_fn() == def_id { Some((mir::BinOp::Shl, false)) }
1371         else if items.i128_shr_fn() == def_id { Some((mir::BinOp::Shr, false)) }
1372         else if items.u128_shr_fn() == def_id { Some((mir::BinOp::Shr, false)) }
1373         else if items.i128_addo_fn() == def_id { Some((mir::BinOp::Add, true)) }
1374         else if items.u128_addo_fn() == def_id { Some((mir::BinOp::Add, true)) }
1375         else if items.i128_subo_fn() == def_id { Some((mir::BinOp::Sub, true)) }
1376         else if items.u128_subo_fn() == def_id { Some((mir::BinOp::Sub, true)) }
1377         else if items.i128_mulo_fn() == def_id { Some((mir::BinOp::Mul, true)) }
1378         else if items.u128_mulo_fn() == def_id { Some((mir::BinOp::Mul, true)) }
1379         else if items.i128_shlo_fn() == def_id { Some((mir::BinOp::Shl, true)) }
1380         else if items.u128_shlo_fn() == def_id { Some((mir::BinOp::Shl, true)) }
1381         else if items.i128_shro_fn() == def_id { Some((mir::BinOp::Shr, true)) }
1382         else if items.u128_shro_fn() == def_id { Some((mir::BinOp::Shr, true)) }
1383         else { None }
1384     }
1385
1386     pub fn stability(self) -> &'tcx stability::Index<'tcx> {
1387         self.stability_index(LOCAL_CRATE)
1388     }
1389
1390     pub fn crates(self) -> &'tcx [CrateNum] {
1391         self.all_crate_nums(LOCAL_CRATE)
1392     }
1393
1394     pub fn features(self) -> &'tcx feature_gate::Features {
1395         self.features_query(LOCAL_CRATE)
1396     }
1397
1398     pub fn def_key(self, id: DefId) -> hir_map::DefKey {
1399         if id.is_local() {
1400             self.hir().def_key(id)
1401         } else {
1402             self.cstore.def_key(id)
1403         }
1404     }
1405
1406     /// Converts a `DefId` into its fully expanded `DefPath` (every
1407     /// `DefId` is really just an interned def-path).
1408     ///
1409     /// Note that if `id` is not local to this crate, the result will
1410     ///  be a non-local `DefPath`.
1411     pub fn def_path(self, id: DefId) -> hir_map::DefPath {
1412         if id.is_local() {
1413             self.hir().def_path(id)
1414         } else {
1415             self.cstore.def_path(id)
1416         }
1417     }
1418
1419     /// Returns whether or not the crate with CrateNum 'cnum'
1420     /// is marked as a private dependency
1421     pub fn is_private_dep(self, cnum: CrateNum) -> bool {
1422         if cnum == LOCAL_CRATE {
1423             false
1424         } else {
1425             self.cstore.crate_is_private_dep_untracked(cnum)
1426         }
1427     }
1428
1429     #[inline]
1430     pub fn def_path_hash(self, def_id: DefId) -> hir_map::DefPathHash {
1431         if def_id.is_local() {
1432             self.hir().definitions().def_path_hash(def_id.index)
1433         } else {
1434             self.cstore.def_path_hash(def_id)
1435         }
1436     }
1437
1438     pub fn def_path_debug_str(self, def_id: DefId) -> String {
1439         // We are explicitly not going through queries here in order to get
1440         // crate name and disambiguator since this code is called from debug!()
1441         // statements within the query system and we'd run into endless
1442         // recursion otherwise.
1443         let (crate_name, crate_disambiguator) = if def_id.is_local() {
1444             (self.crate_name.clone(),
1445              self.sess.local_crate_disambiguator())
1446         } else {
1447             (self.cstore.crate_name_untracked(def_id.krate),
1448              self.cstore.crate_disambiguator_untracked(def_id.krate))
1449         };
1450
1451         format!("{}[{}]{}",
1452                 crate_name,
1453                 // Don't print the whole crate disambiguator. That's just
1454                 // annoying in debug output.
1455                 &(crate_disambiguator.to_fingerprint().to_hex())[..4],
1456                 self.def_path(def_id).to_string_no_crate())
1457     }
1458
1459     pub fn metadata_encoding_version(self) -> Vec<u8> {
1460         self.cstore.metadata_encoding_version().to_vec()
1461     }
1462
1463     // Note that this is *untracked* and should only be used within the query
1464     // system if the result is otherwise tracked through queries
1465     pub fn crate_data_as_rc_any(self, cnum: CrateNum) -> Lrc<dyn Any> {
1466         self.cstore.crate_data_as_rc_any(cnum)
1467     }
1468
1469     #[inline(always)]
1470     pub fn create_stable_hashing_context(self) -> StableHashingContext<'tcx> {
1471         let krate = self.gcx.hir_map.forest.untracked_krate();
1472
1473         StableHashingContext::new(self.sess,
1474                                   krate,
1475                                   self.hir().definitions(),
1476                                   self.cstore)
1477     }
1478
1479     // This method makes sure that we have a DepNode and a Fingerprint for
1480     // every upstream crate. It needs to be called once right after the tcx is
1481     // created.
1482     // With full-fledged red/green, the method will probably become unnecessary
1483     // as this will be done on-demand.
1484     pub fn allocate_metadata_dep_nodes(self) {
1485         // We cannot use the query versions of crates() and crate_hash(), since
1486         // those would need the DepNodes that we are allocating here.
1487         for cnum in self.cstore.crates_untracked() {
1488             let dep_node = DepNode::new(self, DepConstructor::CrateMetadata(cnum));
1489             let crate_hash = self.cstore.crate_hash_untracked(cnum);
1490             self.dep_graph.with_task(dep_node,
1491                                      self,
1492                                      crate_hash,
1493                                      |_, x| x, // No transformation needed
1494                                      dep_graph::hash_result,
1495             );
1496         }
1497     }
1498
1499     pub fn serialize_query_result_cache<E>(self,
1500                                            encoder: &mut E)
1501                                            -> Result<(), E::Error>
1502         where E: ty::codec::TyEncoder
1503     {
1504         self.queries.on_disk_cache.serialize(self.global_tcx(), encoder)
1505     }
1506
1507     /// If true, we should use the AST-based borrowck (we may *also* use
1508     /// the MIR-based borrowck).
1509     pub fn use_ast_borrowck(self) -> bool {
1510         self.borrowck_mode().use_ast()
1511     }
1512
1513     /// If true, we should use the MIR-based borrow check, but also
1514     /// fall back on the AST borrow check if the MIR-based one errors.
1515     pub fn migrate_borrowck(self) -> bool {
1516         self.borrowck_mode().migrate()
1517     }
1518
1519     /// If true, make MIR codegen for `match` emit a temp that holds a
1520     /// borrow of the input to the match expression.
1521     pub fn generate_borrow_of_any_match_input(&self) -> bool {
1522         self.emit_read_for_match()
1523     }
1524
1525     /// If true, make MIR codegen for `match` emit FakeRead
1526     /// statements (which simulate the maximal effect of executing the
1527     /// patterns in a match arm).
1528     pub fn emit_read_for_match(&self) -> bool {
1529         !self.sess.opts.debugging_opts.nll_dont_emit_read_for_match
1530     }
1531
1532     /// What mode(s) of borrowck should we run? AST? MIR? both?
1533     /// (Also considers the `#![feature(nll)]` setting.)
1534     pub fn borrowck_mode(&self) -> BorrowckMode {
1535         // Here are the main constraints we need to deal with:
1536         //
1537         // 1. An opts.borrowck_mode of `BorrowckMode::Migrate` is
1538         //    synonymous with no `-Z borrowck=...` flag at all.
1539         //
1540         // 2. We want to allow developers on the Nightly channel
1541         //    to opt back into the "hard error" mode for NLL,
1542         //    (which they can do via specifying `#![feature(nll)]`
1543         //    explicitly in their crate).
1544         //
1545         // So, this precedence list is how pnkfelix chose to work with
1546         // the above constraints:
1547         //
1548         // * `#![feature(nll)]` *always* means use NLL with hard
1549         //   errors. (To simplify the code here, it now even overrides
1550         //   a user's attempt to specify `-Z borrowck=compare`, which
1551         //   we arguably do not need anymore and should remove.)
1552         //
1553         // * Otherwise, if no `-Z borrowck=...` then use migrate mode
1554         //
1555         // * Otherwise, use the behavior requested via `-Z borrowck=...`
1556
1557         if self.features().nll { return BorrowckMode::Mir; }
1558
1559         self.sess.opts.borrowck_mode
1560     }
1561
1562     #[inline]
1563     pub fn local_crate_exports_generics(self) -> bool {
1564         debug_assert!(self.sess.opts.share_generics());
1565
1566         self.sess.crate_types.borrow().iter().any(|crate_type| {
1567             match crate_type {
1568                 CrateType::Executable |
1569                 CrateType::Staticlib  |
1570                 CrateType::ProcMacro  |
1571                 CrateType::Cdylib     => false,
1572                 CrateType::Rlib       |
1573                 CrateType::Dylib      => true,
1574             }
1575         })
1576     }
1577
1578     // This method returns the DefId and the BoundRegion corresponding to the given region.
1579     pub fn is_suitable_region(&self, region: Region<'tcx>) -> Option<FreeRegionInfo> {
1580         let (suitable_region_binding_scope, bound_region) = match *region {
1581             ty::ReFree(ref free_region) => (free_region.scope, free_region.bound_region),
1582             ty::ReEarlyBound(ref ebr) => (
1583                 self.parent(ebr.def_id).unwrap(),
1584                 ty::BoundRegion::BrNamed(ebr.def_id, ebr.name),
1585             ),
1586             _ => return None, // not a free region
1587         };
1588
1589         let hir_id = self.hir()
1590             .as_local_hir_id(suitable_region_binding_scope)
1591             .unwrap();
1592         let is_impl_item = match self.hir().find_by_hir_id(hir_id) {
1593             Some(Node::Item(..)) | Some(Node::TraitItem(..)) => false,
1594             Some(Node::ImplItem(..)) => {
1595                 self.is_bound_region_in_impl_item(suitable_region_binding_scope)
1596             }
1597             _ => return None,
1598         };
1599
1600         return Some(FreeRegionInfo {
1601             def_id: suitable_region_binding_scope,
1602             boundregion: bound_region,
1603             is_impl_item: is_impl_item,
1604         });
1605     }
1606
1607     pub fn return_type_impl_trait(
1608         &self,
1609         scope_def_id: DefId,
1610     ) -> Option<Ty<'tcx>> {
1611         // HACK: `type_of_def_id()` will fail on these (#55796), so return None
1612         let hir_id = self.hir().as_local_hir_id(scope_def_id).unwrap();
1613         match self.hir().get(hir_id) {
1614             Node::Item(item) => {
1615                 match item.node {
1616                     ItemKind::Fn(..) => { /* type_of_def_id() will work */ }
1617                     _ => {
1618                         return None;
1619                     }
1620                 }
1621             }
1622             _ => { /* type_of_def_id() will work or panic */ }
1623         }
1624
1625         let ret_ty = self.type_of(scope_def_id);
1626         match ret_ty.sty {
1627             ty::FnDef(_, _) => {
1628                 let sig = ret_ty.fn_sig(*self);
1629                 let output = self.erase_late_bound_regions(&sig.output());
1630                 if output.is_impl_trait() {
1631                     Some(output)
1632                 } else {
1633                     None
1634                 }
1635             }
1636             _ => None
1637         }
1638     }
1639
1640     // Here we check if the bound region is in Impl Item.
1641     pub fn is_bound_region_in_impl_item(
1642         &self,
1643         suitable_region_binding_scope: DefId,
1644     ) -> bool {
1645         let container_id = self.associated_item(suitable_region_binding_scope)
1646             .container
1647             .id();
1648         if self.impl_trait_ref(container_id).is_some() {
1649             // For now, we do not try to target impls of traits. This is
1650             // because this message is going to suggest that the user
1651             // change the fn signature, but they may not be free to do so,
1652             // since the signature must match the trait.
1653             //
1654             // FIXME(#42706) -- in some cases, we could do better here.
1655             return true;
1656         }
1657         false
1658     }
1659
1660     /// Determine whether identifiers in the assembly have strict naming rules.
1661     /// Currently, only NVPTX* targets need it.
1662     pub fn has_strict_asm_symbol_naming(&self) -> bool {
1663         self.gcx.sess.target.target.arch.contains("nvptx")
1664     }
1665 }
1666
1667 impl<'tcx> TyCtxt<'tcx> {
1668     pub fn encode_metadata(self)
1669         -> EncodedMetadata
1670     {
1671         self.cstore.encode_metadata(self)
1672     }
1673 }
1674
1675 impl<'tcx> GlobalCtxt<'tcx> {
1676     /// Call the closure with a local `TyCtxt` using the given arena.
1677     /// `interners` is a slot passed so we can create a CtxtInterners
1678     /// with the same lifetime as `arena`.
1679     pub fn enter_local<F, R>(&'tcx self, f: F) -> R
1680     where
1681         F: FnOnce(TyCtxt<'tcx>) -> R,
1682     {
1683         let tcx = TyCtxt {
1684             gcx: self,
1685             interners: &self.local_interners,
1686             dummy: PhantomData,
1687         };
1688         ty::tls::with_related_context(tcx.global_tcx(), |icx| {
1689             let new_icx = ty::tls::ImplicitCtxt {
1690                 tcx,
1691                 query: icx.query.clone(),
1692                 diagnostics: icx.diagnostics,
1693                 layout_depth: icx.layout_depth,
1694                 task_deps: icx.task_deps,
1695             };
1696             ty::tls::enter_context(&new_icx, |_| {
1697                 f(tcx)
1698             })
1699         })
1700     }
1701 }
1702
1703 /// A trait implemented for all `X<'a>` types that can be safely and
1704 /// efficiently converted to `X<'tcx>` as long as they are part of the
1705 /// provided `TyCtxt<'tcx>`.
1706 /// This can be done, for example, for `Ty<'tcx>` or `SubstsRef<'tcx>`
1707 /// by looking them up in their respective interners.
1708 ///
1709 /// However, this is still not the best implementation as it does
1710 /// need to compare the components, even for interned values.
1711 /// It would be more efficient if `TypedArena` provided a way to
1712 /// determine whether the address is in the allocated range.
1713 ///
1714 /// None is returned if the value or one of the components is not part
1715 /// of the provided context.
1716 /// For `Ty`, `None` can be returned if either the type interner doesn't
1717 /// contain the `TyKind` key or if the address of the interned
1718 /// pointer differs. The latter case is possible if a primitive type,
1719 /// e.g., `()` or `u8`, was interned in a different context.
1720 pub trait Lift<'tcx>: fmt::Debug {
1721     type Lifted: fmt::Debug + 'tcx;
1722     fn lift_to_tcx(&self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted>;
1723 }
1724
1725
1726 macro_rules! nop_lift {
1727     ($ty:ty => $lifted:ty) => {
1728         impl<'a, 'tcx> Lift<'tcx> for $ty {
1729                     type Lifted = $lifted;
1730                     fn lift_to_tcx(&self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted> {
1731                         if tcx.interners.arena.in_arena(*self as *const _) {
1732                             return Some(unsafe { mem::transmute(*self) });
1733                         }
1734                         // Also try in the global tcx if we're not that.
1735                         if !tcx.is_global() {
1736                             self.lift_to_tcx(tcx.global_tcx())
1737                         } else {
1738                             None
1739                         }
1740                     }
1741                 }
1742     };
1743 }
1744
1745 macro_rules! nop_list_lift {
1746     ($ty:ty => $lifted:ty) => {
1747         impl<'a, 'tcx> Lift<'tcx> for &'a List<$ty> {
1748                     type Lifted = &'tcx List<$lifted>;
1749                     fn lift_to_tcx(&self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted> {
1750                         if self.is_empty() {
1751                             return Some(List::empty());
1752                         }
1753                         if tcx.interners.arena.in_arena(*self as *const _) {
1754                             return Some(unsafe { mem::transmute(*self) });
1755                         }
1756                         // Also try in the global tcx if we're not that.
1757                         if !tcx.is_global() {
1758                             self.lift_to_tcx(tcx.global_tcx())
1759                         } else {
1760                             None
1761                         }
1762                     }
1763                 }
1764     };
1765 }
1766
1767 nop_lift!{Ty<'a> => Ty<'tcx>}
1768 nop_lift!{Region<'a> => Region<'tcx>}
1769 nop_lift!{Goal<'a> => Goal<'tcx>}
1770 nop_lift!{&'a Const<'a> => &'tcx Const<'tcx>}
1771
1772 nop_list_lift!{Goal<'a> => Goal<'tcx>}
1773 nop_list_lift!{Clause<'a> => Clause<'tcx>}
1774 nop_list_lift!{Ty<'a> => Ty<'tcx>}
1775 nop_list_lift!{ExistentialPredicate<'a> => ExistentialPredicate<'tcx>}
1776 nop_list_lift!{Predicate<'a> => Predicate<'tcx>}
1777 nop_list_lift!{CanonicalVarInfo => CanonicalVarInfo}
1778 nop_list_lift!{ProjectionKind => ProjectionKind}
1779
1780 // this is the impl for `&'a InternalSubsts<'a>`
1781 nop_list_lift!{Kind<'a> => Kind<'tcx>}
1782
1783 pub mod tls {
1784     use super::{GlobalCtxt, TyCtxt, ptr_eq};
1785
1786     use std::fmt;
1787     use std::mem;
1788     use std::marker::PhantomData;
1789     use syntax_pos;
1790     use crate::ty::query;
1791     use errors::{Diagnostic, TRACK_DIAGNOSTICS};
1792     use rustc_data_structures::OnDrop;
1793     use rustc_data_structures::sync::{self, Lrc, Lock};
1794     use rustc_data_structures::thin_vec::ThinVec;
1795     use crate::dep_graph::TaskDeps;
1796
1797     #[cfg(not(parallel_compiler))]
1798     use std::cell::Cell;
1799
1800     #[cfg(parallel_compiler)]
1801     use rustc_rayon_core as rayon_core;
1802
1803     /// This is the implicit state of rustc. It contains the current
1804     /// TyCtxt and query. It is updated when creating a local interner or
1805     /// executing a new query. Whenever there's a TyCtxt value available
1806     /// you should also have access to an ImplicitCtxt through the functions
1807     /// in this module.
1808     #[derive(Clone)]
1809     pub struct ImplicitCtxt<'a, 'tcx> {
1810         /// The current TyCtxt. Initially created by `enter_global` and updated
1811         /// by `enter_local` with a new local interner
1812         pub tcx: TyCtxt<'tcx>,
1813
1814         /// The current query job, if any. This is updated by JobOwner::start in
1815         /// ty::query::plumbing when executing a query
1816         pub query: Option<Lrc<query::QueryJob<'tcx>>>,
1817
1818         /// Where to store diagnostics for the current query job, if any.
1819         /// This is updated by JobOwner::start in ty::query::plumbing when executing a query
1820         pub diagnostics: Option<&'a Lock<ThinVec<Diagnostic>>>,
1821
1822         /// Used to prevent layout from recursing too deeply.
1823         pub layout_depth: usize,
1824
1825         /// The current dep graph task. This is used to add dependencies to queries
1826         /// when executing them
1827         pub task_deps: Option<&'a Lock<TaskDeps>>,
1828     }
1829
1830     /// Sets Rayon's thread local variable which is preserved for Rayon jobs
1831     /// to `value` during the call to `f`. It is restored to its previous value after.
1832     /// This is used to set the pointer to the new ImplicitCtxt.
1833     #[cfg(parallel_compiler)]
1834     #[inline]
1835     fn set_tlv<F: FnOnce() -> R, R>(value: usize, f: F) -> R {
1836         rayon_core::tlv::with(value, f)
1837     }
1838
1839     /// Gets Rayon's thread local variable which is preserved for Rayon jobs.
1840     /// This is used to get the pointer to the current ImplicitCtxt.
1841     #[cfg(parallel_compiler)]
1842     #[inline]
1843     fn get_tlv() -> usize {
1844         rayon_core::tlv::get()
1845     }
1846
1847     #[cfg(not(parallel_compiler))]
1848     thread_local! {
1849         /// A thread local variable which stores a pointer to the current ImplicitCtxt.
1850         static TLV: Cell<usize> = Cell::new(0);
1851     }
1852
1853     /// Sets TLV to `value` during the call to `f`.
1854     /// It is restored to its previous value after.
1855     /// This is used to set the pointer to the new ImplicitCtxt.
1856     #[cfg(not(parallel_compiler))]
1857     #[inline]
1858     fn set_tlv<F: FnOnce() -> R, R>(value: usize, f: F) -> R {
1859         let old = get_tlv();
1860         let _reset = OnDrop(move || TLV.with(|tlv| tlv.set(old)));
1861         TLV.with(|tlv| tlv.set(value));
1862         f()
1863     }
1864
1865     /// This is used to get the pointer to the current ImplicitCtxt.
1866     #[cfg(not(parallel_compiler))]
1867     fn get_tlv() -> usize {
1868         TLV.with(|tlv| tlv.get())
1869     }
1870
1871     /// This is a callback from libsyntax as it cannot access the implicit state
1872     /// in librustc otherwise
1873     fn span_debug(span: syntax_pos::Span, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1874         with_opt(|tcx| {
1875             if let Some(tcx) = tcx {
1876                 write!(f, "{}", tcx.sess.source_map().span_to_string(span))
1877             } else {
1878                 syntax_pos::default_span_debug(span, f)
1879             }
1880         })
1881     }
1882
1883     /// This is a callback from libsyntax as it cannot access the implicit state
1884     /// in librustc otherwise. It is used to when diagnostic messages are
1885     /// emitted and stores them in the current query, if there is one.
1886     fn track_diagnostic(diagnostic: &Diagnostic) {
1887         with_context_opt(|icx| {
1888             if let Some(icx) = icx {
1889                 if let Some(ref diagnostics) = icx.diagnostics {
1890                     let mut diagnostics = diagnostics.lock();
1891                     diagnostics.extend(Some(diagnostic.clone()));
1892                 }
1893             }
1894         })
1895     }
1896
1897     /// Sets up the callbacks from libsyntax on the current thread
1898     pub fn with_thread_locals<F, R>(f: F) -> R
1899         where F: FnOnce() -> R
1900     {
1901         syntax_pos::SPAN_DEBUG.with(|span_dbg| {
1902             let original_span_debug = span_dbg.get();
1903             span_dbg.set(span_debug);
1904
1905             let _on_drop = OnDrop(move || {
1906                 span_dbg.set(original_span_debug);
1907             });
1908
1909             TRACK_DIAGNOSTICS.with(|current| {
1910                 let original = current.get();
1911                 current.set(track_diagnostic);
1912
1913                 let _on_drop = OnDrop(move || {
1914                     current.set(original);
1915                 });
1916
1917                 f()
1918             })
1919         })
1920     }
1921
1922     /// Sets `context` as the new current ImplicitCtxt for the duration of the function `f`
1923     #[inline]
1924     pub fn enter_context<'a, 'tcx, F, R>(context: &ImplicitCtxt<'a, 'tcx>, f: F) -> R
1925     where
1926         F: FnOnce(&ImplicitCtxt<'a, 'tcx>) -> R,
1927     {
1928         set_tlv(context as *const _ as usize, || {
1929             f(&context)
1930         })
1931     }
1932
1933     /// Enters GlobalCtxt by setting up libsyntax callbacks and
1934     /// creating a initial TyCtxt and ImplicitCtxt.
1935     /// This happens once per rustc session and TyCtxts only exists
1936     /// inside the `f` function.
1937     pub fn enter_global<'tcx, F, R>(gcx: &'tcx GlobalCtxt<'tcx>, f: F) -> R
1938     where
1939         F: FnOnce(TyCtxt<'tcx>) -> R,
1940     {
1941         // Update GCX_PTR to indicate there's a GlobalCtxt available
1942         GCX_PTR.with(|lock| {
1943             *lock.lock() = gcx as *const _ as usize;
1944         });
1945         // Set GCX_PTR back to 0 when we exit
1946         let _on_drop = OnDrop(move || {
1947             GCX_PTR.with(|lock| *lock.lock() = 0);
1948         });
1949
1950         let tcx = TyCtxt {
1951             gcx,
1952             interners: &gcx.global_interners,
1953             dummy: PhantomData,
1954         };
1955         let icx = ImplicitCtxt {
1956             tcx,
1957             query: None,
1958             diagnostics: None,
1959             layout_depth: 0,
1960             task_deps: None,
1961         };
1962         enter_context(&icx, |_| {
1963             f(tcx)
1964         })
1965     }
1966
1967     scoped_thread_local! {
1968         /// Stores a pointer to the GlobalCtxt if one is available.
1969         /// This is used to access the GlobalCtxt in the deadlock handler given to Rayon.
1970         pub static GCX_PTR: Lock<usize>
1971     }
1972
1973     /// Creates a TyCtxt and ImplicitCtxt based on the GCX_PTR thread local.
1974     /// This is used in the deadlock handler.
1975     pub unsafe fn with_global<F, R>(f: F) -> R
1976     where
1977         F: for<'tcx> FnOnce(TyCtxt<'tcx>) -> R,
1978     {
1979         let gcx = GCX_PTR.with(|lock| *lock.lock());
1980         assert!(gcx != 0);
1981         let gcx = &*(gcx as *const GlobalCtxt<'_>);
1982         let tcx = TyCtxt {
1983             gcx,
1984             interners: &gcx.global_interners,
1985             dummy: PhantomData,
1986         };
1987         let icx = ImplicitCtxt {
1988             query: None,
1989             diagnostics: None,
1990             tcx,
1991             layout_depth: 0,
1992             task_deps: None,
1993         };
1994         enter_context(&icx, |_| f(tcx))
1995     }
1996
1997     /// Allows access to the current ImplicitCtxt in a closure if one is available
1998     #[inline]
1999     pub fn with_context_opt<F, R>(f: F) -> R
2000     where
2001         F: for<'a, 'tcx> FnOnce(Option<&ImplicitCtxt<'a, 'tcx>>) -> R,
2002     {
2003         let context = get_tlv();
2004         if context == 0 {
2005             f(None)
2006         } else {
2007             // We could get a ImplicitCtxt pointer from another thread.
2008             // Ensure that ImplicitCtxt is Sync
2009             sync::assert_sync::<ImplicitCtxt<'_, '_>>();
2010
2011             unsafe { f(Some(&*(context as *const ImplicitCtxt<'_, '_>))) }
2012         }
2013     }
2014
2015     /// Allows access to the current ImplicitCtxt.
2016     /// Panics if there is no ImplicitCtxt available
2017     #[inline]
2018     pub fn with_context<F, R>(f: F) -> R
2019     where
2020         F: for<'a, 'tcx> FnOnce(&ImplicitCtxt<'a, 'tcx>) -> R,
2021     {
2022         with_context_opt(|opt_context| f(opt_context.expect("no ImplicitCtxt stored in tls")))
2023     }
2024
2025     /// Allows access to the current ImplicitCtxt whose tcx field has the same global
2026     /// interner as the tcx argument passed in. This means the closure is given an ImplicitCtxt
2027     /// with the same 'tcx lifetime as the TyCtxt passed in.
2028     /// This will panic if you pass it a TyCtxt which has a different global interner from
2029     /// the current ImplicitCtxt's tcx field.
2030     #[inline]
2031     pub fn with_related_context<'tcx, F, R>(tcx: TyCtxt<'tcx>, f: F) -> R
2032     where
2033         F: FnOnce(&ImplicitCtxt<'_, 'tcx>) -> R,
2034     {
2035         with_context(|context| {
2036             unsafe {
2037                 assert!(ptr_eq(context.tcx.gcx, tcx.gcx));
2038                 let context: &ImplicitCtxt<'_, '_> = mem::transmute(context);
2039                 f(context)
2040             }
2041         })
2042     }
2043
2044     /// Allows access to the current ImplicitCtxt whose tcx field has the same global
2045     /// interner and local interner as the tcx argument passed in. This means the closure
2046     /// is given an ImplicitCtxt with the same 'tcx and 'tcx lifetimes as the TyCtxt passed in.
2047     /// This will panic if you pass it a TyCtxt which has a different global interner or
2048     /// a different local interner from the current ImplicitCtxt's tcx field.
2049     #[inline]
2050     pub fn with_fully_related_context<'tcx, F, R>(tcx: TyCtxt<'tcx>, f: F) -> R
2051     where
2052         F: for<'b> FnOnce(&ImplicitCtxt<'b, 'tcx>) -> R,
2053     {
2054         with_context(|context| {
2055             unsafe {
2056                 assert!(ptr_eq(context.tcx.gcx, tcx.gcx));
2057                 assert!(ptr_eq(context.tcx.interners, tcx.interners));
2058                 let context: &ImplicitCtxt<'_, '_> = mem::transmute(context);
2059                 f(context)
2060             }
2061         })
2062     }
2063
2064     /// Allows access to the TyCtxt in the current ImplicitCtxt.
2065     /// Panics if there is no ImplicitCtxt available
2066     #[inline]
2067     pub fn with<F, R>(f: F) -> R
2068     where
2069         F: for<'tcx> FnOnce(TyCtxt<'tcx>) -> R,
2070     {
2071         with_context(|context| f(context.tcx))
2072     }
2073
2074     /// Allows access to the TyCtxt in the current ImplicitCtxt.
2075     /// The closure is passed None if there is no ImplicitCtxt available
2076     #[inline]
2077     pub fn with_opt<F, R>(f: F) -> R
2078     where
2079         F: for<'tcx> FnOnce(Option<TyCtxt<'tcx>>) -> R,
2080     {
2081         with_context_opt(|opt_context| f(opt_context.map(|context| context.tcx)))
2082     }
2083 }
2084
2085 macro_rules! sty_debug_print {
2086     ($ctxt: expr, $($variant: ident),*) => {{
2087         // curious inner module to allow variant names to be used as
2088         // variable names.
2089         #[allow(non_snake_case)]
2090         mod inner {
2091             use crate::ty::{self, TyCtxt};
2092             use crate::ty::context::Interned;
2093
2094             #[derive(Copy, Clone)]
2095             struct DebugStat {
2096                 total: usize,
2097                 lt_infer: usize,
2098                 ty_infer: usize,
2099                 ct_infer: usize,
2100                 all_infer: usize,
2101             }
2102
2103             pub fn go(tcx: TyCtxt<'_>) {
2104                 let mut total = DebugStat {
2105                     total: 0,
2106                     lt_infer: 0,
2107                     ty_infer: 0,
2108                     ct_infer: 0,
2109                     all_infer: 0,
2110                 };
2111                 $(let mut $variant = total;)*
2112
2113                 for &Interned(t) in tcx.interners.type_.borrow().keys() {
2114                     let variant = match t.sty {
2115                         ty::Bool | ty::Char | ty::Int(..) | ty::Uint(..) |
2116                             ty::Float(..) | ty::Str | ty::Never => continue,
2117                         ty::Error => /* unimportant */ continue,
2118                         $(ty::$variant(..) => &mut $variant,)*
2119                     };
2120                     let lt = t.flags.intersects(ty::TypeFlags::HAS_RE_INFER);
2121                     let ty = t.flags.intersects(ty::TypeFlags::HAS_TY_INFER);
2122                     let ct = t.flags.intersects(ty::TypeFlags::HAS_CT_INFER);
2123
2124                     variant.total += 1;
2125                     total.total += 1;
2126                     if lt { total.lt_infer += 1; variant.lt_infer += 1 }
2127                     if ty { total.ty_infer += 1; variant.ty_infer += 1 }
2128                     if ct { total.ct_infer += 1; variant.ct_infer += 1 }
2129                     if lt && ty && ct { total.all_infer += 1; variant.all_infer += 1 }
2130                 }
2131                 println!("Ty interner             total           ty lt ct all");
2132                 $(println!("    {:18}: {uses:6} {usespc:4.1}%, \
2133                             {ty:4.1}% {lt:5.1}% {ct:4.1}% {all:4.1}%",
2134                     stringify!($variant),
2135                     uses = $variant.total,
2136                     usespc = $variant.total as f64 * 100.0 / total.total as f64,
2137                     ty = $variant.ty_infer as f64 * 100.0  / total.total as f64,
2138                     lt = $variant.lt_infer as f64 * 100.0  / total.total as f64,
2139                     ct = $variant.ct_infer as f64 * 100.0  / total.total as f64,
2140                     all = $variant.all_infer as f64 * 100.0  / total.total as f64);
2141                 )*
2142                 println!("                  total {uses:6}        \
2143                           {ty:4.1}% {lt:5.1}% {ct:4.1}% {all:4.1}%",
2144                     uses = total.total,
2145                     ty = total.ty_infer as f64 * 100.0  / total.total as f64,
2146                     lt = total.lt_infer as f64 * 100.0  / total.total as f64,
2147                     ct = total.ct_infer as f64 * 100.0  / total.total as f64,
2148                     all = total.all_infer as f64 * 100.0  / total.total as f64)
2149             }
2150         }
2151
2152         inner::go($ctxt)
2153     }}
2154 }
2155
2156 impl<'tcx> TyCtxt<'tcx> {
2157     pub fn print_debug_stats(self) {
2158         sty_debug_print!(
2159             self,
2160             Adt, Array, Slice, RawPtr, Ref, FnDef, FnPtr, Placeholder,
2161             Generator, GeneratorWitness, Dynamic, Closure, Tuple, Bound,
2162             Param, Infer, UnnormalizedProjection, Projection, Opaque, Foreign);
2163
2164         println!("InternalSubsts interner: #{}", self.interners.substs.borrow().len());
2165         println!("Region interner: #{}", self.interners.region.borrow().len());
2166         println!("Stability interner: #{}", self.stability_interner.borrow().len());
2167         println!("Allocation interner: #{}", self.allocation_interner.borrow().len());
2168         println!("Layout interner: #{}", self.layout_interner.borrow().len());
2169     }
2170 }
2171
2172
2173 /// An entry in an interner.
2174 struct Interned<'tcx, T: 'tcx+?Sized>(&'tcx T);
2175
2176 impl<'tcx, T: 'tcx+?Sized> Clone for Interned<'tcx, T> {
2177     fn clone(&self) -> Self {
2178         Interned(self.0)
2179     }
2180 }
2181 impl<'tcx, T: 'tcx+?Sized> Copy for Interned<'tcx, T> {}
2182
2183 // N.B., an `Interned<Ty>` compares and hashes as a sty.
2184 impl<'tcx> PartialEq for Interned<'tcx, TyS<'tcx>> {
2185     fn eq(&self, other: &Interned<'tcx, TyS<'tcx>>) -> bool {
2186         self.0.sty == other.0.sty
2187     }
2188 }
2189
2190 impl<'tcx> Eq for Interned<'tcx, TyS<'tcx>> {}
2191
2192 impl<'tcx> Hash for Interned<'tcx, TyS<'tcx>> {
2193     fn hash<H: Hasher>(&self, s: &mut H) {
2194         self.0.sty.hash(s)
2195     }
2196 }
2197
2198 impl<'tcx> Borrow<TyKind<'tcx>> for Interned<'tcx, TyS<'tcx>> {
2199     fn borrow<'a>(&'a self) -> &'a TyKind<'tcx> {
2200         &self.0.sty
2201     }
2202 }
2203
2204 // N.B., an `Interned<List<T>>` compares and hashes as its elements.
2205 impl<'tcx, T: PartialEq> PartialEq for Interned<'tcx, List<T>> {
2206     fn eq(&self, other: &Interned<'tcx, List<T>>) -> bool {
2207         self.0[..] == other.0[..]
2208     }
2209 }
2210
2211 impl<'tcx, T: Eq> Eq for Interned<'tcx, List<T>> {}
2212
2213 impl<'tcx, T: Hash> Hash for Interned<'tcx, List<T>> {
2214     fn hash<H: Hasher>(&self, s: &mut H) {
2215         self.0[..].hash(s)
2216     }
2217 }
2218
2219 impl<'tcx> Borrow<[Ty<'tcx>]> for Interned<'tcx, List<Ty<'tcx>>> {
2220     fn borrow<'a>(&'a self) -> &'a [Ty<'tcx>] {
2221         &self.0[..]
2222     }
2223 }
2224
2225 impl<'tcx> Borrow<[CanonicalVarInfo]> for Interned<'tcx, List<CanonicalVarInfo>> {
2226     fn borrow(&self) -> &[CanonicalVarInfo] {
2227         &self.0[..]
2228     }
2229 }
2230
2231 impl<'tcx> Borrow<[Kind<'tcx>]> for Interned<'tcx, InternalSubsts<'tcx>> {
2232     fn borrow<'a>(&'a self) -> &'a [Kind<'tcx>] {
2233         &self.0[..]
2234     }
2235 }
2236
2237 impl<'tcx> Borrow<[ProjectionKind]>
2238     for Interned<'tcx, List<ProjectionKind>> {
2239     fn borrow(&self) -> &[ProjectionKind] {
2240         &self.0[..]
2241     }
2242 }
2243
2244 impl<'tcx> Borrow<RegionKind> for Interned<'tcx, RegionKind> {
2245     fn borrow(&self) -> &RegionKind {
2246         &self.0
2247     }
2248 }
2249
2250 impl<'tcx> Borrow<GoalKind<'tcx>> for Interned<'tcx, GoalKind<'tcx>> {
2251     fn borrow<'a>(&'a self) -> &'a GoalKind<'tcx> {
2252         &self.0
2253     }
2254 }
2255
2256 impl<'tcx> Borrow<[ExistentialPredicate<'tcx>]>
2257     for Interned<'tcx, List<ExistentialPredicate<'tcx>>>
2258 {
2259     fn borrow<'a>(&'a self) -> &'a [ExistentialPredicate<'tcx>] {
2260         &self.0[..]
2261     }
2262 }
2263
2264 impl<'tcx> Borrow<[Predicate<'tcx>]> for Interned<'tcx, List<Predicate<'tcx>>> {
2265     fn borrow<'a>(&'a self) -> &'a [Predicate<'tcx>] {
2266         &self.0[..]
2267     }
2268 }
2269
2270 impl<'tcx> Borrow<Const<'tcx>> for Interned<'tcx, Const<'tcx>> {
2271     fn borrow<'a>(&'a self) -> &'a Const<'tcx> {
2272         &self.0
2273     }
2274 }
2275
2276 impl<'tcx> Borrow<[Clause<'tcx>]> for Interned<'tcx, List<Clause<'tcx>>> {
2277     fn borrow<'a>(&'a self) -> &'a [Clause<'tcx>] {
2278         &self.0[..]
2279     }
2280 }
2281
2282 impl<'tcx> Borrow<[Goal<'tcx>]> for Interned<'tcx, List<Goal<'tcx>>> {
2283     fn borrow<'a>(&'a self) -> &'a [Goal<'tcx>] {
2284         &self.0[..]
2285     }
2286 }
2287
2288 macro_rules! intern_method {
2289     ($lt_tcx:tt, $name:ident: $method:ident($alloc:ty,
2290                                             $alloc_method:expr,
2291                                             $alloc_to_key:expr,
2292                                             $keep_in_local_tcx:expr) -> $ty:ty) => {
2293         impl<$lt_tcx> TyCtxt<$lt_tcx> {
2294             pub fn $method(self, v: $alloc) -> &$lt_tcx $ty {
2295                 let key = ($alloc_to_key)(&v);
2296
2297                 // HACK(eddyb) Depend on flags being accurate to
2298                 // determine that all contents are in the global tcx.
2299                 // See comments on Lift for why we can't use that.
2300                 if ($keep_in_local_tcx)(&v) {
2301                     self.interners.$name.borrow_mut().intern_ref(key, || {
2302                         // Make sure we don't end up with inference
2303                         // types/regions in the global tcx.
2304                         if self.is_global() {
2305                             bug!("Attempted to intern `{:?}` which contains \
2306                                 inference types/regions in the global type context",
2307                                 v);
2308                         }
2309
2310                         Interned($alloc_method(&self.interners.arena, v))
2311                     }).0
2312                 } else {
2313                     self.global_interners.$name.borrow_mut().intern_ref(key, || {
2314                         Interned($alloc_method(&self.global_interners.arena, v))
2315                     }).0
2316                 }
2317             }
2318         }
2319     }
2320 }
2321
2322 macro_rules! direct_interners {
2323     ($lt_tcx:tt, $($name:ident: $method:ident($keep_in_local_tcx:expr) -> $ty:ty),+) => {
2324         $(impl<$lt_tcx> PartialEq for Interned<$lt_tcx, $ty> {
2325             fn eq(&self, other: &Self) -> bool {
2326                 self.0 == other.0
2327             }
2328         }
2329
2330         impl<$lt_tcx> Eq for Interned<$lt_tcx, $ty> {}
2331
2332         impl<$lt_tcx> Hash for Interned<$lt_tcx, $ty> {
2333             fn hash<H: Hasher>(&self, s: &mut H) {
2334                 self.0.hash(s)
2335             }
2336         }
2337
2338         intern_method!(
2339             $lt_tcx,
2340             $name: $method($ty,
2341                            |a: &$lt_tcx SyncDroplessArena, v| -> &$lt_tcx $ty { a.alloc(v) },
2342                            |x| x,
2343                            $keep_in_local_tcx) -> $ty);)+
2344     }
2345 }
2346
2347 pub fn keep_local<'tcx, T: ty::TypeFoldable<'tcx>>(x: &T) -> bool {
2348     x.has_type_flags(ty::TypeFlags::KEEP_IN_LOCAL_TCX)
2349 }
2350
2351 direct_interners!('tcx,
2352     region: mk_region(|r: &RegionKind| r.keep_in_local_tcx()) -> RegionKind,
2353     goal: mk_goal(|c: &GoalKind<'_>| keep_local(c)) -> GoalKind<'tcx>,
2354     const_: mk_const(|c: &Const<'_>| keep_local(&c)) -> Const<'tcx>
2355 );
2356
2357 macro_rules! slice_interners {
2358     ($($field:ident: $method:ident($ty:ty)),+) => (
2359         $(intern_method!( 'tcx, $field: $method(
2360             &[$ty],
2361             |a, v| List::from_arena(a, v),
2362             Deref::deref,
2363             |xs: &[$ty]| xs.iter().any(keep_local)) -> List<$ty>);)+
2364     );
2365 }
2366
2367 slice_interners!(
2368     existential_predicates: _intern_existential_predicates(ExistentialPredicate<'tcx>),
2369     predicates: _intern_predicates(Predicate<'tcx>),
2370     type_list: _intern_type_list(Ty<'tcx>),
2371     substs: _intern_substs(Kind<'tcx>),
2372     clauses: _intern_clauses(Clause<'tcx>),
2373     goal_list: _intern_goals(Goal<'tcx>),
2374     projs: _intern_projs(ProjectionKind)
2375 );
2376
2377 // This isn't a perfect fit: CanonicalVarInfo slices are always
2378 // allocated in the global arena, so this `intern_method!` macro is
2379 // overly general.  But we just return false for the code that checks
2380 // whether they belong in the thread-local arena, so no harm done, and
2381 // seems better than open-coding the rest.
2382 intern_method! {
2383     'tcx,
2384     canonical_var_infos: _intern_canonical_var_infos(
2385         &[CanonicalVarInfo],
2386         |a, v| List::from_arena(a, v),
2387         Deref::deref,
2388         |_xs: &[CanonicalVarInfo]| -> bool { false }
2389     ) -> List<CanonicalVarInfo>
2390 }
2391
2392 impl<'tcx> TyCtxt<'tcx> {
2393     /// Given a `fn` type, returns an equivalent `unsafe fn` type;
2394     /// that is, a `fn` type that is equivalent in every way for being
2395     /// unsafe.
2396     pub fn safe_to_unsafe_fn_ty(self, sig: PolyFnSig<'tcx>) -> Ty<'tcx> {
2397         assert_eq!(sig.unsafety(), hir::Unsafety::Normal);
2398         self.mk_fn_ptr(sig.map_bound(|sig| ty::FnSig {
2399             unsafety: hir::Unsafety::Unsafe,
2400             ..sig
2401         }))
2402     }
2403
2404     /// Given a closure signature `sig`, returns an equivalent `fn`
2405     /// type with the same signature. Detuples and so forth -- so
2406     /// e.g., if we have a sig with `Fn<(u32, i32)>` then you would get
2407     /// a `fn(u32, i32)`.
2408     /// `unsafety` determines the unsafety of the `fn` type. If you pass
2409     /// `hir::Unsafety::Unsafe` in the previous example, then you would get
2410     /// an `unsafe fn (u32, i32)`.
2411     /// It cannot convert a closure that requires unsafe.
2412     pub fn coerce_closure_fn_ty(self, sig: PolyFnSig<'tcx>, unsafety: hir::Unsafety) -> Ty<'tcx> {
2413         let converted_sig = sig.map_bound(|s| {
2414             let params_iter = match s.inputs()[0].sty {
2415                 ty::Tuple(params) => {
2416                     params.into_iter().map(|k| k.expect_ty())
2417                 }
2418                 _ => bug!(),
2419             };
2420             self.mk_fn_sig(
2421                 params_iter,
2422                 s.output(),
2423                 s.c_variadic,
2424                 unsafety,
2425                 abi::Abi::Rust,
2426             )
2427         });
2428
2429         self.mk_fn_ptr(converted_sig)
2430     }
2431
2432     #[inline]
2433     pub fn mk_ty(&self, st: TyKind<'tcx>) -> Ty<'tcx> {
2434         CtxtInterners::intern_ty(&self.interners, &self.global_interners, st)
2435     }
2436
2437     pub fn mk_mach_int(self, tm: ast::IntTy) -> Ty<'tcx> {
2438         match tm {
2439             ast::IntTy::Isize   => self.types.isize,
2440             ast::IntTy::I8   => self.types.i8,
2441             ast::IntTy::I16  => self.types.i16,
2442             ast::IntTy::I32  => self.types.i32,
2443             ast::IntTy::I64  => self.types.i64,
2444             ast::IntTy::I128  => self.types.i128,
2445         }
2446     }
2447
2448     pub fn mk_mach_uint(self, tm: ast::UintTy) -> Ty<'tcx> {
2449         match tm {
2450             ast::UintTy::Usize   => self.types.usize,
2451             ast::UintTy::U8   => self.types.u8,
2452             ast::UintTy::U16  => self.types.u16,
2453             ast::UintTy::U32  => self.types.u32,
2454             ast::UintTy::U64  => self.types.u64,
2455             ast::UintTy::U128  => self.types.u128,
2456         }
2457     }
2458
2459     pub fn mk_mach_float(self, tm: ast::FloatTy) -> Ty<'tcx> {
2460         match tm {
2461             ast::FloatTy::F32  => self.types.f32,
2462             ast::FloatTy::F64  => self.types.f64,
2463         }
2464     }
2465
2466     #[inline]
2467     pub fn mk_str(self) -> Ty<'tcx> {
2468         self.mk_ty(Str)
2469     }
2470
2471     #[inline]
2472     pub fn mk_static_str(self) -> Ty<'tcx> {
2473         self.mk_imm_ref(self.lifetimes.re_static, self.mk_str())
2474     }
2475
2476     #[inline]
2477     pub fn mk_adt(self, def: &'tcx AdtDef, substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2478         // take a copy of substs so that we own the vectors inside
2479         self.mk_ty(Adt(def, substs))
2480     }
2481
2482     #[inline]
2483     pub fn mk_foreign(self, def_id: DefId) -> Ty<'tcx> {
2484         self.mk_ty(Foreign(def_id))
2485     }
2486
2487     pub fn mk_box(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2488         let def_id = self.require_lang_item(lang_items::OwnedBoxLangItem);
2489         let adt_def = self.adt_def(def_id);
2490         let substs = InternalSubsts::for_item(self, def_id, |param, substs| {
2491             match param.kind {
2492                 GenericParamDefKind::Lifetime |
2493                 GenericParamDefKind::Const => {
2494                     bug!()
2495                 }
2496                 GenericParamDefKind::Type { has_default, .. } => {
2497                     if param.index == 0 {
2498                         ty.into()
2499                     } else {
2500                         assert!(has_default);
2501                         self.type_of(param.def_id).subst(self, substs).into()
2502                     }
2503                 }
2504             }
2505         });
2506         self.mk_ty(Adt(adt_def, substs))
2507     }
2508
2509     #[inline]
2510     pub fn mk_ptr(self, tm: TypeAndMut<'tcx>) -> Ty<'tcx> {
2511         self.mk_ty(RawPtr(tm))
2512     }
2513
2514     #[inline]
2515     pub fn mk_ref(self, r: Region<'tcx>, tm: TypeAndMut<'tcx>) -> Ty<'tcx> {
2516         self.mk_ty(Ref(r, tm.ty, tm.mutbl))
2517     }
2518
2519     #[inline]
2520     pub fn mk_mut_ref(self, r: Region<'tcx>, ty: Ty<'tcx>) -> Ty<'tcx> {
2521         self.mk_ref(r, TypeAndMut {ty: ty, mutbl: hir::MutMutable})
2522     }
2523
2524     #[inline]
2525     pub fn mk_imm_ref(self, r: Region<'tcx>, ty: Ty<'tcx>) -> Ty<'tcx> {
2526         self.mk_ref(r, TypeAndMut {ty: ty, mutbl: hir::MutImmutable})
2527     }
2528
2529     #[inline]
2530     pub fn mk_mut_ptr(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2531         self.mk_ptr(TypeAndMut {ty: ty, mutbl: hir::MutMutable})
2532     }
2533
2534     #[inline]
2535     pub fn mk_imm_ptr(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2536         self.mk_ptr(TypeAndMut {ty: ty, mutbl: hir::MutImmutable})
2537     }
2538
2539     #[inline]
2540     pub fn mk_nil_ptr(self) -> Ty<'tcx> {
2541         self.mk_imm_ptr(self.mk_unit())
2542     }
2543
2544     #[inline]
2545     pub fn mk_array(self, ty: Ty<'tcx>, n: u64) -> Ty<'tcx> {
2546         self.mk_ty(Array(ty, ty::Const::from_usize(self.global_tcx(), n)))
2547     }
2548
2549     #[inline]
2550     pub fn mk_slice(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2551         self.mk_ty(Slice(ty))
2552     }
2553
2554     #[inline]
2555     pub fn intern_tup(self, ts: &[Ty<'tcx>]) -> Ty<'tcx> {
2556         let kinds: Vec<_> = ts.into_iter().map(|&t| Kind::from(t)).collect();
2557         self.mk_ty(Tuple(self.intern_substs(&kinds)))
2558     }
2559
2560     pub fn mk_tup<I: InternAs<[Ty<'tcx>], Ty<'tcx>>>(self, iter: I) -> I::Output {
2561         iter.intern_with(|ts| {
2562             let kinds: Vec<_> = ts.into_iter().map(|&t| Kind::from(t)).collect();
2563             self.mk_ty(Tuple(self.intern_substs(&kinds)))
2564         })
2565     }
2566
2567     #[inline]
2568     pub fn mk_unit(self) -> Ty<'tcx> {
2569         self.types.unit
2570     }
2571
2572     #[inline]
2573     pub fn mk_diverging_default(self) -> Ty<'tcx> {
2574         if self.features().never_type {
2575             self.types.never
2576         } else {
2577             self.intern_tup(&[])
2578         }
2579     }
2580
2581     #[inline]
2582     pub fn mk_bool(self) -> Ty<'tcx> {
2583         self.mk_ty(Bool)
2584     }
2585
2586     #[inline]
2587     pub fn mk_fn_def(self, def_id: DefId,
2588                      substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2589         self.mk_ty(FnDef(def_id, substs))
2590     }
2591
2592     #[inline]
2593     pub fn mk_fn_ptr(self, fty: PolyFnSig<'tcx>) -> Ty<'tcx> {
2594         self.mk_ty(FnPtr(fty))
2595     }
2596
2597     #[inline]
2598     pub fn mk_dynamic(
2599         self,
2600         obj: ty::Binder<&'tcx List<ExistentialPredicate<'tcx>>>,
2601         reg: ty::Region<'tcx>
2602     ) -> Ty<'tcx> {
2603         self.mk_ty(Dynamic(obj, reg))
2604     }
2605
2606     #[inline]
2607     pub fn mk_projection(self,
2608                          item_def_id: DefId,
2609                          substs: SubstsRef<'tcx>)
2610         -> Ty<'tcx> {
2611             self.mk_ty(Projection(ProjectionTy {
2612                 item_def_id,
2613                 substs,
2614             }))
2615         }
2616
2617     #[inline]
2618     pub fn mk_closure(self, closure_id: DefId, closure_substs: ClosureSubsts<'tcx>)
2619                       -> Ty<'tcx> {
2620         self.mk_ty(Closure(closure_id, closure_substs))
2621     }
2622
2623     #[inline]
2624     pub fn mk_generator(self,
2625                         id: DefId,
2626                         generator_substs: GeneratorSubsts<'tcx>,
2627                         movability: hir::GeneratorMovability)
2628                         -> Ty<'tcx> {
2629         self.mk_ty(Generator(id, generator_substs, movability))
2630     }
2631
2632     #[inline]
2633     pub fn mk_generator_witness(self, types: ty::Binder<&'tcx List<Ty<'tcx>>>) -> Ty<'tcx> {
2634         self.mk_ty(GeneratorWitness(types))
2635     }
2636
2637     #[inline]
2638     pub fn mk_ty_var(self, v: TyVid) -> Ty<'tcx> {
2639         self.mk_ty_infer(TyVar(v))
2640     }
2641
2642     #[inline]
2643     pub fn mk_const_var(self, v: ConstVid<'tcx>, ty: Ty<'tcx>) -> &'tcx Const<'tcx> {
2644         self.mk_const(ty::Const {
2645             val: ConstValue::Infer(InferConst::Var(v)),
2646             ty,
2647         })
2648     }
2649
2650     #[inline]
2651     pub fn mk_int_var(self, v: IntVid) -> Ty<'tcx> {
2652         self.mk_ty_infer(IntVar(v))
2653     }
2654
2655     #[inline]
2656     pub fn mk_float_var(self, v: FloatVid) -> Ty<'tcx> {
2657         self.mk_ty_infer(FloatVar(v))
2658     }
2659
2660     #[inline]
2661     pub fn mk_ty_infer(self, it: InferTy) -> Ty<'tcx> {
2662         self.mk_ty(Infer(it))
2663     }
2664
2665     #[inline]
2666     pub fn mk_const_infer(
2667         self,
2668         ic: InferConst<'tcx>,
2669         ty: Ty<'tcx>,
2670     ) -> &'tcx ty::Const<'tcx> {
2671         self.mk_const(ty::Const {
2672             val: ConstValue::Infer(ic),
2673             ty,
2674         })
2675     }
2676
2677     #[inline]
2678     pub fn mk_ty_param(self, index: u32, name: InternedString) -> Ty<'tcx> {
2679         self.mk_ty(Param(ParamTy { index, name: name }))
2680     }
2681
2682     #[inline]
2683     pub fn mk_const_param(
2684         self,
2685         index: u32,
2686         name: InternedString,
2687         ty: Ty<'tcx>
2688     ) -> &'tcx Const<'tcx> {
2689         self.mk_const(ty::Const {
2690             val: ConstValue::Param(ParamConst { index, name }),
2691             ty,
2692         })
2693     }
2694
2695     #[inline]
2696     pub fn mk_self_type(self) -> Ty<'tcx> {
2697         self.mk_ty_param(0, kw::SelfUpper.as_interned_str())
2698     }
2699
2700     pub fn mk_param_from_def(self, param: &ty::GenericParamDef) -> Kind<'tcx> {
2701         match param.kind {
2702             GenericParamDefKind::Lifetime => {
2703                 self.mk_region(ty::ReEarlyBound(param.to_early_bound_region_data())).into()
2704             }
2705             GenericParamDefKind::Type { .. } => self.mk_ty_param(param.index, param.name).into(),
2706             GenericParamDefKind::Const => {
2707                 self.mk_const_param(param.index, param.name, self.type_of(param.def_id)).into()
2708             }
2709         }
2710     }
2711
2712     #[inline]
2713     pub fn mk_opaque(self, def_id: DefId, substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2714         self.mk_ty(Opaque(def_id, substs))
2715     }
2716
2717     pub fn intern_existential_predicates(self, eps: &[ExistentialPredicate<'tcx>])
2718         -> &'tcx List<ExistentialPredicate<'tcx>> {
2719         assert!(!eps.is_empty());
2720         assert!(eps.windows(2).all(|w| w[0].stable_cmp(self, &w[1]) != Ordering::Greater));
2721         self._intern_existential_predicates(eps)
2722     }
2723
2724     pub fn intern_predicates(self, preds: &[Predicate<'tcx>])
2725         -> &'tcx List<Predicate<'tcx>> {
2726         // FIXME consider asking the input slice to be sorted to avoid
2727         // re-interning permutations, in which case that would be asserted
2728         // here.
2729         if preds.len() == 0 {
2730             // The macro-generated method below asserts we don't intern an empty slice.
2731             List::empty()
2732         } else {
2733             self._intern_predicates(preds)
2734         }
2735     }
2736
2737     pub fn intern_type_list(self, ts: &[Ty<'tcx>]) -> &'tcx List<Ty<'tcx>> {
2738         if ts.len() == 0 {
2739             List::empty()
2740         } else {
2741             self._intern_type_list(ts)
2742         }
2743     }
2744
2745     pub fn intern_substs(self, ts: &[Kind<'tcx>]) -> &'tcx List<Kind<'tcx>> {
2746         if ts.len() == 0 {
2747             List::empty()
2748         } else {
2749             self._intern_substs(ts)
2750         }
2751     }
2752
2753     pub fn intern_projs(self, ps: &[ProjectionKind]) -> &'tcx List<ProjectionKind> {
2754         if ps.len() == 0 {
2755             List::empty()
2756         } else {
2757             self._intern_projs(ps)
2758         }
2759     }
2760
2761     pub fn intern_canonical_var_infos(self, ts: &[CanonicalVarInfo]) -> CanonicalVarInfos<'tcx> {
2762         if ts.len() == 0 {
2763             List::empty()
2764         } else {
2765             self.global_tcx()._intern_canonical_var_infos(ts)
2766         }
2767     }
2768
2769     pub fn intern_clauses(self, ts: &[Clause<'tcx>]) -> Clauses<'tcx> {
2770         if ts.len() == 0 {
2771             List::empty()
2772         } else {
2773             self._intern_clauses(ts)
2774         }
2775     }
2776
2777     pub fn intern_goals(self, ts: &[Goal<'tcx>]) -> Goals<'tcx> {
2778         if ts.len() == 0 {
2779             List::empty()
2780         } else {
2781             self._intern_goals(ts)
2782         }
2783     }
2784
2785     pub fn mk_fn_sig<I>(self,
2786                         inputs: I,
2787                         output: I::Item,
2788                         c_variadic: bool,
2789                         unsafety: hir::Unsafety,
2790                         abi: abi::Abi)
2791         -> <I::Item as InternIteratorElement<Ty<'tcx>, ty::FnSig<'tcx>>>::Output
2792         where I: Iterator,
2793               I::Item: InternIteratorElement<Ty<'tcx>, ty::FnSig<'tcx>>
2794     {
2795         inputs.chain(iter::once(output)).intern_with(|xs| ty::FnSig {
2796             inputs_and_output: self.intern_type_list(xs),
2797             c_variadic, unsafety, abi
2798         })
2799     }
2800
2801     pub fn mk_existential_predicates<I: InternAs<[ExistentialPredicate<'tcx>],
2802                                      &'tcx List<ExistentialPredicate<'tcx>>>>(self, iter: I)
2803                                      -> I::Output {
2804         iter.intern_with(|xs| self.intern_existential_predicates(xs))
2805     }
2806
2807     pub fn mk_predicates<I: InternAs<[Predicate<'tcx>],
2808                                      &'tcx List<Predicate<'tcx>>>>(self, iter: I)
2809                                      -> I::Output {
2810         iter.intern_with(|xs| self.intern_predicates(xs))
2811     }
2812
2813     pub fn mk_type_list<I: InternAs<[Ty<'tcx>],
2814                         &'tcx List<Ty<'tcx>>>>(self, iter: I) -> I::Output {
2815         iter.intern_with(|xs| self.intern_type_list(xs))
2816     }
2817
2818     pub fn mk_substs<I: InternAs<[Kind<'tcx>],
2819                      &'tcx List<Kind<'tcx>>>>(self, iter: I) -> I::Output {
2820         iter.intern_with(|xs| self.intern_substs(xs))
2821     }
2822
2823     pub fn mk_substs_trait(self,
2824                      self_ty: Ty<'tcx>,
2825                      rest: &[Kind<'tcx>])
2826                     -> SubstsRef<'tcx>
2827     {
2828         self.mk_substs(iter::once(self_ty.into()).chain(rest.iter().cloned()))
2829     }
2830
2831     pub fn mk_clauses<I: InternAs<[Clause<'tcx>], Clauses<'tcx>>>(self, iter: I) -> I::Output {
2832         iter.intern_with(|xs| self.intern_clauses(xs))
2833     }
2834
2835     pub fn mk_goals<I: InternAs<[Goal<'tcx>], Goals<'tcx>>>(self, iter: I) -> I::Output {
2836         iter.intern_with(|xs| self.intern_goals(xs))
2837     }
2838
2839     pub fn lint_hir<S: Into<MultiSpan>>(self,
2840                                         lint: &'static Lint,
2841                                         hir_id: HirId,
2842                                         span: S,
2843                                         msg: &str) {
2844         self.struct_span_lint_hir(lint, hir_id, span.into(), msg).emit()
2845     }
2846
2847     pub fn lint_hir_note<S: Into<MultiSpan>>(self,
2848                                              lint: &'static Lint,
2849                                              hir_id: HirId,
2850                                              span: S,
2851                                              msg: &str,
2852                                              note: &str) {
2853         let mut err = self.struct_span_lint_hir(lint, hir_id, span.into(), msg);
2854         err.note(note);
2855         err.emit()
2856     }
2857
2858     pub fn lint_node_note<S: Into<MultiSpan>>(self,
2859                                               lint: &'static Lint,
2860                                               id: hir::HirId,
2861                                               span: S,
2862                                               msg: &str,
2863                                               note: &str) {
2864         let mut err = self.struct_span_lint_hir(lint, id, span.into(), msg);
2865         err.note(note);
2866         err.emit()
2867     }
2868
2869     /// Walks upwards from `id` to find a node which might change lint levels with attributes.
2870     /// It stops at `bound` and just returns it if reached.
2871     pub fn maybe_lint_level_root_bounded(
2872         self,
2873         mut id: hir::HirId,
2874         bound: hir::HirId,
2875     ) -> hir::HirId {
2876         loop {
2877             if id == bound {
2878                 return bound;
2879             }
2880             if lint::maybe_lint_level_root(self, id) {
2881                 return id;
2882             }
2883             let next = self.hir().get_parent_node_by_hir_id(id);
2884             if next == id {
2885                 bug!("lint traversal reached the root of the crate");
2886             }
2887             id = next;
2888         }
2889     }
2890
2891     pub fn lint_level_at_node(
2892         self,
2893         lint: &'static Lint,
2894         mut id: hir::HirId
2895     ) -> (lint::Level, lint::LintSource) {
2896         let sets = self.lint_levels(LOCAL_CRATE);
2897         loop {
2898             if let Some(pair) = sets.level_and_source(lint, id, self.sess) {
2899                 return pair
2900             }
2901             let next = self.hir().get_parent_node_by_hir_id(id);
2902             if next == id {
2903                 bug!("lint traversal reached the root of the crate");
2904             }
2905             id = next;
2906         }
2907     }
2908
2909     pub fn struct_span_lint_hir<S: Into<MultiSpan>>(self,
2910                                                     lint: &'static Lint,
2911                                                     hir_id: HirId,
2912                                                     span: S,
2913                                                     msg: &str)
2914         -> DiagnosticBuilder<'tcx>
2915     {
2916         let (level, src) = self.lint_level_at_node(lint, hir_id);
2917         lint::struct_lint_level(self.sess, lint, level, src, Some(span.into()), msg)
2918     }
2919
2920     pub fn struct_lint_node(self, lint: &'static Lint, id: HirId, msg: &str)
2921         -> DiagnosticBuilder<'tcx>
2922     {
2923         let (level, src) = self.lint_level_at_node(lint, id);
2924         lint::struct_lint_level(self.sess, lint, level, src, None, msg)
2925     }
2926
2927     pub fn in_scope_traits(self, id: HirId) -> Option<&'tcx StableVec<TraitCandidate>> {
2928         self.in_scope_traits_map(id.owner)
2929             .and_then(|map| map.get(&id.local_id))
2930     }
2931
2932     pub fn named_region(self, id: HirId) -> Option<resolve_lifetime::Region> {
2933         self.named_region_map(id.owner)
2934             .and_then(|map| map.get(&id.local_id).cloned())
2935     }
2936
2937     pub fn is_late_bound(self, id: HirId) -> bool {
2938         self.is_late_bound_map(id.owner)
2939             .map(|set| set.contains(&id.local_id))
2940             .unwrap_or(false)
2941     }
2942
2943     pub fn object_lifetime_defaults(self, id: HirId) -> Option<&'tcx [ObjectLifetimeDefault]> {
2944         self.object_lifetime_defaults_map(id.owner)
2945             .and_then(|map| map.get(&id.local_id).map(|v| &**v))
2946     }
2947 }
2948
2949 pub trait InternAs<T: ?Sized, R> {
2950     type Output;
2951     fn intern_with<F>(self, f: F) -> Self::Output
2952         where F: FnOnce(&T) -> R;
2953 }
2954
2955 impl<I, T, R, E> InternAs<[T], R> for I
2956     where E: InternIteratorElement<T, R>,
2957           I: Iterator<Item=E> {
2958     type Output = E::Output;
2959     fn intern_with<F>(self, f: F) -> Self::Output
2960         where F: FnOnce(&[T]) -> R {
2961         E::intern_with(self, f)
2962     }
2963 }
2964
2965 pub trait InternIteratorElement<T, R>: Sized {
2966     type Output;
2967     fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output;
2968 }
2969
2970 impl<T, R> InternIteratorElement<T, R> for T {
2971     type Output = R;
2972     fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output {
2973         f(&iter.collect::<SmallVec<[_; 8]>>())
2974     }
2975 }
2976
2977 impl<'a, T, R> InternIteratorElement<T, R> for &'a T
2978     where T: Clone + 'a
2979 {
2980     type Output = R;
2981     fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output {
2982         f(&iter.cloned().collect::<SmallVec<[_; 8]>>())
2983     }
2984 }
2985
2986 impl<T, R, E> InternIteratorElement<T, R> for Result<T, E> {
2987     type Output = Result<R, E>;
2988     fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output {
2989         Ok(f(&iter.collect::<Result<SmallVec<[_; 8]>, _>>()?))
2990     }
2991 }
2992
2993 // We are comparing types with different invariant lifetimes, so `ptr::eq`
2994 // won't work for us.
2995 fn ptr_eq<T, U>(t: *const T, u: *const U) -> bool {
2996     t as *const () == u as *const ()
2997 }
2998
2999 pub fn provide(providers: &mut ty::query::Providers<'_>) {
3000     providers.in_scope_traits_map = |tcx, id| tcx.gcx.trait_map.get(&id);
3001     providers.module_exports = |tcx, id| tcx.gcx.export_map.get(&id).map(|v| &v[..]);
3002     providers.crate_name = |tcx, id| {
3003         assert_eq!(id, LOCAL_CRATE);
3004         tcx.crate_name
3005     };
3006     providers.get_lib_features = |tcx, id| {
3007         assert_eq!(id, LOCAL_CRATE);
3008         tcx.arena.alloc(middle::lib_features::collect(tcx))
3009     };
3010     providers.get_lang_items = |tcx, id| {
3011         assert_eq!(id, LOCAL_CRATE);
3012         tcx.arena.alloc(middle::lang_items::collect(tcx))
3013     };
3014     providers.maybe_unused_trait_import = |tcx, id| {
3015         tcx.maybe_unused_trait_imports.contains(&id)
3016     };
3017     providers.maybe_unused_extern_crates = |tcx, cnum| {
3018         assert_eq!(cnum, LOCAL_CRATE);
3019         &tcx.maybe_unused_extern_crates[..]
3020     };
3021     providers.names_imported_by_glob_use = |tcx, id| {
3022         assert_eq!(id.krate, LOCAL_CRATE);
3023         Lrc::new(tcx.glob_map.get(&id).cloned().unwrap_or_default())
3024     };
3025
3026     providers.stability_index = |tcx, cnum| {
3027         assert_eq!(cnum, LOCAL_CRATE);
3028         tcx.arena.alloc(stability::Index::new(tcx))
3029     };
3030     providers.lookup_stability = |tcx, id| {
3031         assert_eq!(id.krate, LOCAL_CRATE);
3032         let id = tcx.hir().definitions().def_index_to_hir_id(id.index);
3033         tcx.stability().local_stability(id)
3034     };
3035     providers.lookup_deprecation_entry = |tcx, id| {
3036         assert_eq!(id.krate, LOCAL_CRATE);
3037         let id = tcx.hir().definitions().def_index_to_hir_id(id.index);
3038         tcx.stability().local_deprecation_entry(id)
3039     };
3040     providers.extern_mod_stmt_cnum = |tcx, id| {
3041         let id = tcx.hir().as_local_node_id(id).unwrap();
3042         tcx.cstore.extern_mod_stmt_cnum_untracked(id)
3043     };
3044     providers.all_crate_nums = |tcx, cnum| {
3045         assert_eq!(cnum, LOCAL_CRATE);
3046         tcx.arena.alloc_slice(&tcx.cstore.crates_untracked())
3047     };
3048     providers.postorder_cnums = |tcx, cnum| {
3049         assert_eq!(cnum, LOCAL_CRATE);
3050         tcx.arena.alloc_slice(&tcx.cstore.postorder_cnums_untracked())
3051     };
3052     providers.output_filenames = |tcx, cnum| {
3053         assert_eq!(cnum, LOCAL_CRATE);
3054         tcx.output_filenames.clone()
3055     };
3056     providers.features_query = |tcx, cnum| {
3057         assert_eq!(cnum, LOCAL_CRATE);
3058         tcx.arena.alloc(tcx.sess.features_untracked().clone())
3059     };
3060     providers.is_panic_runtime = |tcx, cnum| {
3061         assert_eq!(cnum, LOCAL_CRATE);
3062         attr::contains_name(tcx.hir().krate_attrs(), sym::panic_runtime)
3063     };
3064     providers.is_compiler_builtins = |tcx, cnum| {
3065         assert_eq!(cnum, LOCAL_CRATE);
3066         attr::contains_name(tcx.hir().krate_attrs(), sym::compiler_builtins)
3067     };
3068 }