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