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