src/librustc/ty/context.rs

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