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