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