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