src/librustc/ty/context.rs

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