src/librustc/ty/context.rs

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