1 // ignore-tidy-filelength
3 //! Type context book-keeping.
5 use crate::arena::Arena;
6 use crate::dep_graph::DepGraph;
7 use crate::dep_graph::{self, DepNode, DepConstructor};
8 use crate::session::Session;
9 use crate::session::config::{BorrowckMode, OutputFilenames};
10 use crate::session::config::CrateType;
12 use crate::hir::{TraitCandidate, HirId, ItemKind, ItemLocalId, Node};
13 use crate::hir::def::{Res, DefKind, Export};
14 use crate::hir::def_id::{CrateNum, DefId, DefIndex, LOCAL_CRATE};
15 use crate::hir::map as hir_map;
16 use crate::hir::map::DefPathHash;
17 use crate::lint::{self, Lint};
18 use crate::ich::{StableHashingContext, NodeIdHashingMode};
19 use crate::infer::canonical::{Canonical, CanonicalVarInfo, CanonicalVarInfos};
20 use crate::infer::outlives::free_region_map::FreeRegionMap;
21 use crate::middle::cstore::CrateStoreDyn;
22 use crate::middle::cstore::EncodedMetadata;
23 use crate::middle::lang_items;
24 use crate::middle::resolve_lifetime::{self, ObjectLifetimeDefault};
25 use crate::middle::stability;
26 use crate::mir::{self, Mir, interpret, ProjectionKind};
27 use crate::mir::interpret::{ConstValue, Allocation};
28 use crate::ty::subst::{Kind, InternalSubsts, SubstsRef, Subst};
29 use crate::ty::ReprOptions;
31 use crate::traits::{Clause, Clauses, GoalKind, Goal, Goals};
32 use crate::ty::{self, DefIdTree, Ty, TypeAndMut};
33 use crate::ty::{TyS, TyKind, List};
34 use crate::ty::{AdtKind, AdtDef, ClosureSubsts, GeneratorSubsts, Region, Const};
35 use crate::ty::{PolyFnSig, InferTy, ParamTy, ProjectionTy, ExistentialPredicate, Predicate};
36 use crate::ty::RegionKind;
37 use crate::ty::{TyVar, TyVid, IntVar, IntVid, FloatVar, FloatVid, ConstVid};
38 use crate::ty::TyKind::*;
39 use crate::ty::{InferConst, ParamConst};
40 use crate::ty::GenericParamDefKind;
41 use crate::ty::layout::{LayoutDetails, TargetDataLayout, VariantIdx};
43 use crate::ty::steal::Steal;
44 use crate::ty::subst::{UserSubsts, UnpackedKind};
45 use crate::ty::{BoundVar, BindingMode};
46 use crate::ty::CanonicalPolyFnSig;
47 use crate::util::common::ErrorReported;
48 use crate::util::nodemap::{DefIdMap, DefIdSet, ItemLocalMap, ItemLocalSet};
49 use crate::util::nodemap::{FxHashMap, FxHashSet};
50 use errors::DiagnosticBuilder;
51 use rustc_data_structures::interner::HashInterner;
52 use smallvec::SmallVec;
53 use rustc_data_structures::stable_hasher::{HashStable, hash_stable_hashmap,
54 StableHasher, StableHasherResult,
56 use arena::{TypedArena, SyncDroplessArena};
57 use rustc_data_structures::indexed_vec::{Idx, IndexVec};
58 use rustc_data_structures::sync::{Lrc, Lock, WorkerLocal};
60 use std::borrow::Borrow;
61 use std::cmp::Ordering;
62 use std::collections::hash_map::{self, Entry};
63 use std::hash::{Hash, Hasher};
66 use std::ops::{Deref, Bound};
70 use std::marker::PhantomData;
71 use rustc_target::spec::abi;
72 use rustc_macros::HashStable;
75 use syntax::source_map::MultiSpan;
76 use syntax::feature_gate;
77 use syntax::symbol::{Symbol, InternedString, kw, sym};
82 pub struct AllArenas<'tcx> {
83 pub global: WorkerLocal<GlobalArenas<'tcx>>,
84 pub interner: SyncDroplessArena,
87 impl<'tcx> AllArenas<'tcx> {
88 pub fn new() -> Self {
90 global: WorkerLocal::new(|_| GlobalArenas::default()),
91 interner: SyncDroplessArena::default(),
98 pub struct GlobalArenas<'tcx> {
100 layout: TypedArena<LayoutDetails>,
103 generics: TypedArena<ty::Generics>,
104 trait_def: TypedArena<ty::TraitDef>,
105 adt_def: TypedArena<ty::AdtDef>,
106 steal_mir: TypedArena<Steal<Mir<'tcx>>>,
107 mir: TypedArena<Mir<'tcx>>,
108 tables: TypedArena<ty::TypeckTables<'tcx>>,
110 const_allocs: TypedArena<interpret::Allocation>,
113 type InternedSet<'tcx, T> = Lock<FxHashMap<Interned<'tcx, T>, ()>>;
115 pub struct CtxtInterners<'tcx> {
116 /// The arena that types, regions, etc are allocated from
117 arena: &'tcx SyncDroplessArena,
119 /// Specifically use a speedy hash algorithm for these hash sets,
120 /// they're accessed quite often.
121 type_: InternedSet<'tcx, TyS<'tcx>>,
122 type_list: InternedSet<'tcx, List<Ty<'tcx>>>,
123 substs: InternedSet<'tcx, InternalSubsts<'tcx>>,
124 canonical_var_infos: InternedSet<'tcx, List<CanonicalVarInfo>>,
125 region: InternedSet<'tcx, RegionKind>,
126 existential_predicates: InternedSet<'tcx, List<ExistentialPredicate<'tcx>>>,
127 predicates: InternedSet<'tcx, List<Predicate<'tcx>>>,
128 clauses: InternedSet<'tcx, List<Clause<'tcx>>>,
129 goal: InternedSet<'tcx, GoalKind<'tcx>>,
130 goal_list: InternedSet<'tcx, List<Goal<'tcx>>>,
131 projs: InternedSet<'tcx, List<ProjectionKind>>,
132 const_: InternedSet<'tcx, Const<'tcx>>,
135 impl<'gcx: 'tcx, 'tcx> CtxtInterners<'tcx> {
136 fn new(arena: &'tcx SyncDroplessArena) -> CtxtInterners<'tcx> {
139 type_: Default::default(),
140 type_list: Default::default(),
141 substs: Default::default(),
142 region: Default::default(),
143 existential_predicates: Default::default(),
144 canonical_var_infos: Default::default(),
145 predicates: Default::default(),
146 clauses: Default::default(),
147 goal: Default::default(),
148 goal_list: Default::default(),
149 projs: Default::default(),
150 const_: Default::default(),
157 local: &CtxtInterners<'tcx>,
158 global: &CtxtInterners<'gcx>,
161 let flags = super::flags::FlagComputation::for_sty(&st);
163 // HACK(eddyb) Depend on flags being accurate to
164 // determine that all contents are in the global tcx.
165 // See comments on Lift for why we can't use that.
166 if flags.flags.intersects(ty::TypeFlags::KEEP_IN_LOCAL_TCX) {
167 local.type_.borrow_mut().intern(st, |st| {
168 let ty_struct = TyS {
171 outer_exclusive_binder: flags.outer_exclusive_binder,
174 // Make sure we don't end up with inference
175 // types/regions in the global interner
176 if ptr_eq(local, global) {
177 bug!("Attempted to intern `{:?}` which contains \
178 inference types/regions in the global type context",
182 Interned(local.arena.alloc(ty_struct))
185 global.type_.borrow_mut().intern(st, |st| {
186 let ty_struct = TyS {
189 outer_exclusive_binder: flags.outer_exclusive_binder,
192 // This is safe because all the types the ty_struct can point to
193 // already is in the global arena
194 let ty_struct: TyS<'gcx> = unsafe {
195 mem::transmute(ty_struct)
198 Interned(global.arena.alloc(ty_struct))
204 pub struct CommonTypes<'tcx> {
225 /// Dummy type used for the `Self` of a `TraitRef` created for converting
226 /// a trait object, and which gets removed in `ExistentialTraitRef`.
227 /// This type must not appear anywhere in other converted types.
228 pub trait_object_dummy_self: Ty<'tcx>,
231 pub struct CommonLifetimes<'tcx> {
232 pub re_empty: Region<'tcx>,
233 pub re_static: Region<'tcx>,
234 pub re_erased: Region<'tcx>,
237 pub struct CommonConsts<'tcx> {
238 pub err: &'tcx Const<'tcx>,
241 pub struct LocalTableInContext<'a, V: 'a> {
242 local_id_root: Option<DefId>,
243 data: &'a ItemLocalMap<V>
246 /// Validate that the given HirId (respectively its `local_id` part) can be
247 /// safely used as a key in the tables of a TypeckTable. For that to be
248 /// the case, the HirId must have the same `owner` as all the other IDs in
249 /// this table (signified by `local_id_root`). Otherwise the HirId
250 /// would be in a different frame of reference and using its `local_id`
251 /// would result in lookup errors, or worse, in silently wrong data being
253 fn validate_hir_id_for_typeck_tables(local_id_root: Option<DefId>,
256 if cfg!(debug_assertions) {
257 if let Some(local_id_root) = local_id_root {
258 if hir_id.owner != local_id_root.index {
259 ty::tls::with(|tcx| {
260 let node_id = tcx.hir().hir_to_node_id(hir_id);
262 bug!("node {} with HirId::owner {:?} cannot be placed in \
263 TypeckTables with local_id_root {:?}",
264 tcx.hir().node_to_string(node_id),
265 DefId::local(hir_id.owner),
270 // We use "Null Object" TypeckTables in some of the analysis passes.
271 // These are just expected to be empty and their `local_id_root` is
272 // `None`. Therefore we cannot verify whether a given `HirId` would
273 // be a valid key for the given table. Instead we make sure that
274 // nobody tries to write to such a Null Object table.
276 bug!("access to invalid TypeckTables")
282 impl<'a, V> LocalTableInContext<'a, V> {
283 pub fn contains_key(&self, id: hir::HirId) -> bool {
284 validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
285 self.data.contains_key(&id.local_id)
288 pub fn get(&self, id: hir::HirId) -> Option<&V> {
289 validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
290 self.data.get(&id.local_id)
293 pub fn iter(&self) -> hash_map::Iter<'_, hir::ItemLocalId, V> {
298 impl<'a, V> ::std::ops::Index<hir::HirId> for LocalTableInContext<'a, V> {
301 fn index(&self, key: hir::HirId) -> &V {
302 self.get(key).expect("LocalTableInContext: key not found")
306 pub struct LocalTableInContextMut<'a, V: 'a> {
307 local_id_root: Option<DefId>,
308 data: &'a mut ItemLocalMap<V>
311 impl<'a, V> LocalTableInContextMut<'a, V> {
312 pub fn get_mut(&mut self, id: hir::HirId) -> Option<&mut V> {
313 validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
314 self.data.get_mut(&id.local_id)
317 pub fn entry(&mut self, id: hir::HirId) -> Entry<'_, hir::ItemLocalId, V> {
318 validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
319 self.data.entry(id.local_id)
322 pub fn insert(&mut self, id: hir::HirId, val: V) -> Option<V> {
323 validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
324 self.data.insert(id.local_id, val)
327 pub fn remove(&mut self, id: hir::HirId) -> Option<V> {
328 validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
329 self.data.remove(&id.local_id)
333 /// All information necessary to validate and reveal an `impl Trait` or `existential Type`
334 #[derive(RustcEncodable, RustcDecodable, Debug, HashStable)]
335 pub struct ResolvedOpaqueTy<'tcx> {
336 /// The revealed type as seen by this function.
337 pub concrete_type: Ty<'tcx>,
338 /// Generic parameters on the opaque type as passed by this function.
339 /// For `existential type Foo<A, B>; fn foo<T, U>() -> Foo<T, U> { .. }` this is `[T, U]`, not
341 pub substs: SubstsRef<'tcx>,
344 #[derive(RustcEncodable, RustcDecodable, Debug)]
345 pub struct TypeckTables<'tcx> {
346 /// The HirId::owner all ItemLocalIds in this table are relative to.
347 pub local_id_root: Option<DefId>,
349 /// Resolved definitions for `<T>::X` associated paths and
350 /// method calls, including those of overloaded operators.
351 type_dependent_defs: ItemLocalMap<Result<(DefKind, DefId), ErrorReported>>,
353 /// Resolved field indices for field accesses in expressions (`S { field }`, `obj.field`)
354 /// or patterns (`S { field }`). The index is often useful by itself, but to learn more
355 /// about the field you also need definition of the variant to which the field
356 /// belongs, but it may not exist if it's a tuple field (`tuple.0`).
357 field_indices: ItemLocalMap<usize>,
359 /// Stores the types for various nodes in the AST. Note that this table
360 /// is not guaranteed to be populated until after typeck. See
361 /// typeck::check::fn_ctxt for details.
362 node_types: ItemLocalMap<Ty<'tcx>>,
364 /// Stores the type parameters which were substituted to obtain the type
365 /// of this node. This only applies to nodes that refer to entities
366 /// parameterized by type parameters, such as generic fns, types, or
368 node_substs: ItemLocalMap<SubstsRef<'tcx>>,
370 /// This will either store the canonicalized types provided by the user
371 /// or the substitutions that the user explicitly gave (if any) attached
372 /// to `id`. These will not include any inferred values. The canonical form
373 /// is used to capture things like `_` or other unspecified values.
375 /// For example, if the user wrote `foo.collect::<Vec<_>>()`, then the
376 /// canonical substitutions would include only `for<X> { Vec<X> }`.
378 /// See also `AscribeUserType` statement in MIR.
379 user_provided_types: ItemLocalMap<CanonicalUserType<'tcx>>,
381 /// Stores the canonicalized types provided by the user. See also
382 /// `AscribeUserType` statement in MIR.
383 pub user_provided_sigs: DefIdMap<CanonicalPolyFnSig<'tcx>>,
385 adjustments: ItemLocalMap<Vec<ty::adjustment::Adjustment<'tcx>>>,
387 /// Stores the actual binding mode for all instances of hir::BindingAnnotation.
388 pat_binding_modes: ItemLocalMap<BindingMode>,
390 /// Stores the types which were implicitly dereferenced in pattern binding modes
391 /// for later usage in HAIR lowering. For example,
394 /// match &&Some(5i32) {
399 /// leads to a `vec![&&Option<i32>, &Option<i32>]`. Empty vectors are not stored.
402 /// https://github.com/rust-lang/rfcs/blob/master/text/2005-match-ergonomics.md#definitions
403 pat_adjustments: ItemLocalMap<Vec<Ty<'tcx>>>,
406 pub upvar_capture_map: ty::UpvarCaptureMap<'tcx>,
408 /// Records the reasons that we picked the kind of each closure;
409 /// not all closures are present in the map.
410 closure_kind_origins: ItemLocalMap<(Span, ast::Name)>,
412 /// For each fn, records the "liberated" types of its arguments
413 /// and return type. Liberated means that all bound regions
414 /// (including late-bound regions) are replaced with free
415 /// equivalents. This table is not used in codegen (since regions
416 /// are erased there) and hence is not serialized to metadata.
417 liberated_fn_sigs: ItemLocalMap<ty::FnSig<'tcx>>,
419 /// For each FRU expression, record the normalized types of the fields
420 /// of the struct - this is needed because it is non-trivial to
421 /// normalize while preserving regions. This table is used only in
422 /// MIR construction and hence is not serialized to metadata.
423 fru_field_types: ItemLocalMap<Vec<Ty<'tcx>>>,
425 /// For every coercion cast we add the HIR node ID of the cast
426 /// expression to this set.
427 coercion_casts: ItemLocalSet,
429 /// Set of trait imports actually used in the method resolution.
430 /// This is used for warning unused imports. During type
431 /// checking, this `Lrc` should not be cloned: it must have a ref-count
432 /// of 1 so that we can insert things into the set mutably.
433 pub used_trait_imports: Lrc<DefIdSet>,
435 /// If any errors occurred while type-checking this body,
436 /// this field will be set to `true`.
437 pub tainted_by_errors: bool,
439 /// Stores the free-region relationships that were deduced from
440 /// its where-clauses and parameter types. These are then
441 /// read-again by borrowck.
442 pub free_region_map: FreeRegionMap<'tcx>,
444 /// All the existential types that are restricted to concrete types
446 pub concrete_existential_types: FxHashMap<DefId, ResolvedOpaqueTy<'tcx>>,
448 /// Given the closure ID this map provides the list of UpvarIDs used by it.
449 /// The upvarID contains the HIR node ID and it also contains the full path
450 /// leading to the member of the struct or tuple that is used instead of the
452 pub upvar_list: ty::UpvarListMap,
455 impl<'tcx> TypeckTables<'tcx> {
456 pub fn empty(local_id_root: Option<DefId>) -> TypeckTables<'tcx> {
459 type_dependent_defs: Default::default(),
460 field_indices: Default::default(),
461 user_provided_types: Default::default(),
462 user_provided_sigs: Default::default(),
463 node_types: Default::default(),
464 node_substs: Default::default(),
465 adjustments: Default::default(),
466 pat_binding_modes: Default::default(),
467 pat_adjustments: Default::default(),
468 upvar_capture_map: Default::default(),
469 closure_kind_origins: Default::default(),
470 liberated_fn_sigs: Default::default(),
471 fru_field_types: Default::default(),
472 coercion_casts: Default::default(),
473 used_trait_imports: Lrc::new(Default::default()),
474 tainted_by_errors: false,
475 free_region_map: Default::default(),
476 concrete_existential_types: Default::default(),
477 upvar_list: Default::default(),
481 /// Returns the final resolution of a `QPath` in an `Expr` or `Pat` node.
482 pub fn qpath_res(&self, qpath: &hir::QPath, id: hir::HirId) -> Res {
484 hir::QPath::Resolved(_, ref path) => path.res,
485 hir::QPath::TypeRelative(..) => self.type_dependent_def(id)
486 .map_or(Res::Err, |(kind, def_id)| Res::Def(kind, def_id)),
490 pub fn type_dependent_defs(
492 ) -> LocalTableInContext<'_, Result<(DefKind, DefId), ErrorReported>> {
493 LocalTableInContext {
494 local_id_root: self.local_id_root,
495 data: &self.type_dependent_defs
499 pub fn type_dependent_def(&self, id: HirId) -> Option<(DefKind, DefId)> {
500 validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
501 self.type_dependent_defs.get(&id.local_id).cloned().and_then(|r| r.ok())
504 pub fn type_dependent_def_id(&self, id: HirId) -> Option<DefId> {
505 self.type_dependent_def(id).map(|(_, def_id)| def_id)
508 pub fn type_dependent_defs_mut(
510 ) -> LocalTableInContextMut<'_, Result<(DefKind, DefId), ErrorReported>> {
511 LocalTableInContextMut {
512 local_id_root: self.local_id_root,
513 data: &mut self.type_dependent_defs
517 pub fn field_indices(&self) -> LocalTableInContext<'_, usize> {
518 LocalTableInContext {
519 local_id_root: self.local_id_root,
520 data: &self.field_indices
524 pub fn field_indices_mut(&mut self) -> LocalTableInContextMut<'_, usize> {
525 LocalTableInContextMut {
526 local_id_root: self.local_id_root,
527 data: &mut self.field_indices
531 pub fn user_provided_types(
533 ) -> LocalTableInContext<'_, CanonicalUserType<'tcx>> {
534 LocalTableInContext {
535 local_id_root: self.local_id_root,
536 data: &self.user_provided_types
540 pub fn user_provided_types_mut(
542 ) -> LocalTableInContextMut<'_, CanonicalUserType<'tcx>> {
543 LocalTableInContextMut {
544 local_id_root: self.local_id_root,
545 data: &mut self.user_provided_types
549 pub fn node_types(&self) -> LocalTableInContext<'_, Ty<'tcx>> {
550 LocalTableInContext {
551 local_id_root: self.local_id_root,
552 data: &self.node_types
556 pub fn node_types_mut(&mut self) -> LocalTableInContextMut<'_, Ty<'tcx>> {
557 LocalTableInContextMut {
558 local_id_root: self.local_id_root,
559 data: &mut self.node_types
563 pub fn node_type(&self, id: hir::HirId) -> Ty<'tcx> {
564 self.node_type_opt(id).unwrap_or_else(||
565 bug!("node_type: no type for node `{}`",
566 tls::with(|tcx| tcx.hir().hir_to_string(id)))
570 pub fn node_type_opt(&self, id: hir::HirId) -> Option<Ty<'tcx>> {
571 validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
572 self.node_types.get(&id.local_id).cloned()
575 pub fn node_substs_mut(&mut self) -> LocalTableInContextMut<'_, SubstsRef<'tcx>> {
576 LocalTableInContextMut {
577 local_id_root: self.local_id_root,
578 data: &mut self.node_substs
582 pub fn node_substs(&self, id: hir::HirId) -> SubstsRef<'tcx> {
583 validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
584 self.node_substs.get(&id.local_id).cloned().unwrap_or_else(|| InternalSubsts::empty())
587 pub fn node_substs_opt(&self, id: hir::HirId) -> Option<SubstsRef<'tcx>> {
588 validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
589 self.node_substs.get(&id.local_id).cloned()
592 // Returns the type of a pattern as a monotype. Like @expr_ty, this function
593 // doesn't provide type parameter substitutions.
594 pub fn pat_ty(&self, pat: &hir::Pat) -> Ty<'tcx> {
595 self.node_type(pat.hir_id)
598 pub fn pat_ty_opt(&self, pat: &hir::Pat) -> Option<Ty<'tcx>> {
599 self.node_type_opt(pat.hir_id)
602 // Returns the type of an expression as a monotype.
604 // NB (1): This is the PRE-ADJUSTMENT TYPE for the expression. That is, in
605 // some cases, we insert `Adjustment` annotations such as auto-deref or
606 // auto-ref. The type returned by this function does not consider such
607 // adjustments. See `expr_ty_adjusted()` instead.
609 // NB (2): This type doesn't provide type parameter substitutions; e.g., if you
610 // ask for the type of "id" in "id(3)", it will return "fn(&isize) -> isize"
611 // instead of "fn(ty) -> T with T = isize".
612 pub fn expr_ty(&self, expr: &hir::Expr) -> Ty<'tcx> {
613 self.node_type(expr.hir_id)
616 pub fn expr_ty_opt(&self, expr: &hir::Expr) -> Option<Ty<'tcx>> {
617 self.node_type_opt(expr.hir_id)
620 pub fn adjustments(&self) -> LocalTableInContext<'_, Vec<ty::adjustment::Adjustment<'tcx>>> {
621 LocalTableInContext {
622 local_id_root: self.local_id_root,
623 data: &self.adjustments
627 pub fn adjustments_mut(&mut self)
628 -> LocalTableInContextMut<'_, Vec<ty::adjustment::Adjustment<'tcx>>> {
629 LocalTableInContextMut {
630 local_id_root: self.local_id_root,
631 data: &mut self.adjustments
635 pub fn expr_adjustments(&self, expr: &hir::Expr)
636 -> &[ty::adjustment::Adjustment<'tcx>] {
637 validate_hir_id_for_typeck_tables(self.local_id_root, expr.hir_id, false);
638 self.adjustments.get(&expr.hir_id.local_id).map_or(&[], |a| &a[..])
641 /// Returns the type of `expr`, considering any `Adjustment`
642 /// entry recorded for that expression.
643 pub fn expr_ty_adjusted(&self, expr: &hir::Expr) -> Ty<'tcx> {
644 self.expr_adjustments(expr)
646 .map_or_else(|| self.expr_ty(expr), |adj| adj.target)
649 pub fn expr_ty_adjusted_opt(&self, expr: &hir::Expr) -> Option<Ty<'tcx>> {
650 self.expr_adjustments(expr)
652 .map(|adj| adj.target)
653 .or_else(|| self.expr_ty_opt(expr))
656 pub fn is_method_call(&self, expr: &hir::Expr) -> bool {
657 // Only paths and method calls/overloaded operators have
658 // entries in type_dependent_defs, ignore the former here.
659 if let hir::ExprKind::Path(_) = expr.node {
663 match self.type_dependent_defs().get(expr.hir_id) {
664 Some(Ok((DefKind::Method, _))) => true,
669 pub fn pat_binding_modes(&self) -> LocalTableInContext<'_, BindingMode> {
670 LocalTableInContext {
671 local_id_root: self.local_id_root,
672 data: &self.pat_binding_modes
676 pub fn pat_binding_modes_mut(&mut self)
677 -> LocalTableInContextMut<'_, BindingMode> {
678 LocalTableInContextMut {
679 local_id_root: self.local_id_root,
680 data: &mut self.pat_binding_modes
684 pub fn pat_adjustments(&self) -> LocalTableInContext<'_, Vec<Ty<'tcx>>> {
685 LocalTableInContext {
686 local_id_root: self.local_id_root,
687 data: &self.pat_adjustments,
691 pub fn pat_adjustments_mut(&mut self)
692 -> LocalTableInContextMut<'_, Vec<Ty<'tcx>>> {
693 LocalTableInContextMut {
694 local_id_root: self.local_id_root,
695 data: &mut self.pat_adjustments,
699 pub fn upvar_capture(&self, upvar_id: ty::UpvarId) -> ty::UpvarCapture<'tcx> {
700 self.upvar_capture_map[&upvar_id]
703 pub fn closure_kind_origins(&self) -> LocalTableInContext<'_, (Span, ast::Name)> {
704 LocalTableInContext {
705 local_id_root: self.local_id_root,
706 data: &self.closure_kind_origins
710 pub fn closure_kind_origins_mut(&mut self) -> LocalTableInContextMut<'_, (Span, ast::Name)> {
711 LocalTableInContextMut {
712 local_id_root: self.local_id_root,
713 data: &mut self.closure_kind_origins
717 pub fn liberated_fn_sigs(&self) -> LocalTableInContext<'_, ty::FnSig<'tcx>> {
718 LocalTableInContext {
719 local_id_root: self.local_id_root,
720 data: &self.liberated_fn_sigs
724 pub fn liberated_fn_sigs_mut(&mut self) -> LocalTableInContextMut<'_, ty::FnSig<'tcx>> {
725 LocalTableInContextMut {
726 local_id_root: self.local_id_root,
727 data: &mut self.liberated_fn_sigs
731 pub fn fru_field_types(&self) -> LocalTableInContext<'_, Vec<Ty<'tcx>>> {
732 LocalTableInContext {
733 local_id_root: self.local_id_root,
734 data: &self.fru_field_types
738 pub fn fru_field_types_mut(&mut self) -> LocalTableInContextMut<'_, Vec<Ty<'tcx>>> {
739 LocalTableInContextMut {
740 local_id_root: self.local_id_root,
741 data: &mut self.fru_field_types
745 pub fn is_coercion_cast(&self, hir_id: hir::HirId) -> bool {
746 validate_hir_id_for_typeck_tables(self.local_id_root, hir_id, true);
747 self.coercion_casts.contains(&hir_id.local_id)
750 pub fn set_coercion_cast(&mut self, id: ItemLocalId) {
751 self.coercion_casts.insert(id);
754 pub fn coercion_casts(&self) -> &ItemLocalSet {
760 impl<'a, 'gcx> HashStable<StableHashingContext<'a>> for TypeckTables<'gcx> {
761 fn hash_stable<W: StableHasherResult>(&self,
762 hcx: &mut StableHashingContext<'a>,
763 hasher: &mut StableHasher<W>) {
764 let ty::TypeckTables {
766 ref type_dependent_defs,
768 ref user_provided_types,
769 ref user_provided_sigs,
773 ref pat_binding_modes,
775 ref upvar_capture_map,
776 ref closure_kind_origins,
777 ref liberated_fn_sigs,
782 ref used_trait_imports,
785 ref concrete_existential_types,
790 hcx.with_node_id_hashing_mode(NodeIdHashingMode::HashDefPath, |hcx| {
791 type_dependent_defs.hash_stable(hcx, hasher);
792 field_indices.hash_stable(hcx, hasher);
793 user_provided_types.hash_stable(hcx, hasher);
794 user_provided_sigs.hash_stable(hcx, hasher);
795 node_types.hash_stable(hcx, hasher);
796 node_substs.hash_stable(hcx, hasher);
797 adjustments.hash_stable(hcx, hasher);
798 pat_binding_modes.hash_stable(hcx, hasher);
799 pat_adjustments.hash_stable(hcx, hasher);
800 hash_stable_hashmap(hcx, hasher, upvar_capture_map, |up_var_id, hcx| {
807 local_id_root.expect("trying to hash invalid TypeckTables");
809 let var_owner_def_id = DefId {
810 krate: local_id_root.krate,
811 index: var_path.hir_id.owner,
813 let closure_def_id = DefId {
814 krate: local_id_root.krate,
815 index: closure_expr_id.to_def_id().index,
817 (hcx.def_path_hash(var_owner_def_id),
818 var_path.hir_id.local_id,
819 hcx.def_path_hash(closure_def_id))
822 closure_kind_origins.hash_stable(hcx, hasher);
823 liberated_fn_sigs.hash_stable(hcx, hasher);
824 fru_field_types.hash_stable(hcx, hasher);
825 coercion_casts.hash_stable(hcx, hasher);
826 used_trait_imports.hash_stable(hcx, hasher);
827 tainted_by_errors.hash_stable(hcx, hasher);
828 free_region_map.hash_stable(hcx, hasher);
829 concrete_existential_types.hash_stable(hcx, hasher);
830 upvar_list.hash_stable(hcx, hasher);
836 pub struct UserTypeAnnotationIndex {
838 DEBUG_FORMAT = "UserType({})",
839 const START_INDEX = 0,
843 /// Mapping of type annotation indices to canonical user type annotations.
844 pub type CanonicalUserTypeAnnotations<'tcx> =
845 IndexVec<UserTypeAnnotationIndex, CanonicalUserTypeAnnotation<'tcx>>;
847 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
848 pub struct CanonicalUserTypeAnnotation<'tcx> {
849 pub user_ty: CanonicalUserType<'tcx>,
851 pub inferred_ty: Ty<'tcx>,
854 BraceStructTypeFoldableImpl! {
855 impl<'tcx> TypeFoldable<'tcx> for CanonicalUserTypeAnnotation<'tcx> {
856 user_ty, span, inferred_ty
860 BraceStructLiftImpl! {
861 impl<'a, 'tcx> Lift<'tcx> for CanonicalUserTypeAnnotation<'a> {
862 type Lifted = CanonicalUserTypeAnnotation<'tcx>;
863 user_ty, span, inferred_ty
868 /// Canonicalized user type annotation.
869 pub type CanonicalUserType<'gcx> = Canonical<'gcx, UserType<'gcx>>;
871 impl CanonicalUserType<'gcx> {
872 /// Returns `true` if this represents a substitution of the form `[?0, ?1, ?2]`,
873 /// i.e., each thing is mapped to a canonical variable with the same index.
874 pub fn is_identity(&self) -> bool {
876 UserType::Ty(_) => false,
877 UserType::TypeOf(_, user_substs) => {
878 if user_substs.user_self_ty.is_some() {
882 user_substs.substs.iter().zip(BoundVar::new(0)..).all(|(kind, cvar)| {
883 match kind.unpack() {
884 UnpackedKind::Type(ty) => match ty.sty {
885 ty::Bound(debruijn, b) => {
886 // We only allow a `ty::INNERMOST` index in substitutions.
887 assert_eq!(debruijn, ty::INNERMOST);
893 UnpackedKind::Lifetime(r) => match r {
894 ty::ReLateBound(debruijn, br) => {
895 // We only allow a `ty::INNERMOST` index in substitutions.
896 assert_eq!(*debruijn, ty::INNERMOST);
897 cvar == br.assert_bound_var()
902 UnpackedKind::Const(ct) => match ct.val {
903 ConstValue::Infer(InferConst::Canonical(debruijn, b)) => {
904 // We only allow a `ty::INNERMOST` index in substitutions.
905 assert_eq!(debruijn, ty::INNERMOST);
917 /// A user-given type annotation attached to a constant. These arise
918 /// from constants that are named via paths, like `Foo::<A>::new` and
920 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
921 pub enum UserType<'tcx> {
924 /// The canonical type is the result of `type_of(def_id)` with the
925 /// given substitutions applied.
926 TypeOf(DefId, UserSubsts<'tcx>),
929 EnumTypeFoldableImpl! {
930 impl<'tcx> TypeFoldable<'tcx> for UserType<'tcx> {
932 (UserType::TypeOf)(def, substs),
937 impl<'a, 'tcx> Lift<'tcx> for UserType<'a> {
938 type Lifted = UserType<'tcx>;
940 (UserType::TypeOf)(def, substs),
944 impl<'tcx> CommonTypes<'tcx> {
945 fn new(interners: &CtxtInterners<'tcx>) -> CommonTypes<'tcx> {
946 let mk = |sty| CtxtInterners::intern_ty(interners, interners, sty);
949 unit: mk(Tuple(List::empty())),
954 isize: mk(Int(ast::IntTy::Isize)),
955 i8: mk(Int(ast::IntTy::I8)),
956 i16: mk(Int(ast::IntTy::I16)),
957 i32: mk(Int(ast::IntTy::I32)),
958 i64: mk(Int(ast::IntTy::I64)),
959 i128: mk(Int(ast::IntTy::I128)),
960 usize: mk(Uint(ast::UintTy::Usize)),
961 u8: mk(Uint(ast::UintTy::U8)),
962 u16: mk(Uint(ast::UintTy::U16)),
963 u32: mk(Uint(ast::UintTy::U32)),
964 u64: mk(Uint(ast::UintTy::U64)),
965 u128: mk(Uint(ast::UintTy::U128)),
966 f32: mk(Float(ast::FloatTy::F32)),
967 f64: mk(Float(ast::FloatTy::F64)),
969 trait_object_dummy_self: mk(Infer(ty::FreshTy(0))),
974 impl<'tcx> CommonLifetimes<'tcx> {
975 fn new(interners: &CtxtInterners<'tcx>) -> CommonLifetimes<'tcx> {
977 interners.region.borrow_mut().intern(r, |r| {
978 Interned(interners.arena.alloc(r))
983 re_empty: mk(RegionKind::ReEmpty),
984 re_static: mk(RegionKind::ReStatic),
985 re_erased: mk(RegionKind::ReErased),
990 impl<'tcx> CommonConsts<'tcx> {
991 fn new(interners: &CtxtInterners<'tcx>, types: &CommonTypes<'tcx>) -> CommonConsts<'tcx> {
993 interners.const_.borrow_mut().intern(c, |c| {
994 Interned(interners.arena.alloc(c))
999 err: mk_const(ty::Const::zero_sized(types.err)),
1004 // This struct contains information regarding the `ReFree(FreeRegion)` corresponding to a lifetime
1007 pub struct FreeRegionInfo {
1008 // def id corresponding to FreeRegion
1010 // the bound region corresponding to FreeRegion
1011 pub boundregion: ty::BoundRegion,
1012 // checks if bound region is in Impl Item
1013 pub is_impl_item: bool,
1016 /// The central data structure of the compiler. It stores references
1017 /// to the various **arenas** and also houses the results of the
1018 /// various **compiler queries** that have been performed. See the
1019 /// [rustc guide] for more details.
1021 /// [rustc guide]: https://rust-lang.github.io/rustc-guide/ty.html
1022 #[derive(Copy, Clone)]
1023 pub struct TyCtxt<'a, 'gcx: 'tcx, 'tcx: 'a> {
1024 gcx: &'gcx GlobalCtxt<'gcx>,
1025 interners: &'tcx CtxtInterners<'tcx>,
1026 dummy: PhantomData<&'a ()>,
1029 impl<'gcx> Deref for TyCtxt<'_, 'gcx, '_> {
1030 type Target = &'gcx GlobalCtxt<'gcx>;
1032 fn deref(&self) -> &Self::Target {
1037 pub struct GlobalCtxt<'tcx> {
1038 pub arena: WorkerLocal<Arena<'tcx>>,
1039 global_arenas: &'tcx WorkerLocal<GlobalArenas<'tcx>>,
1040 global_interners: CtxtInterners<'tcx>,
1042 cstore: &'tcx CrateStoreDyn,
1044 pub sess: &'tcx Session,
1046 pub dep_graph: DepGraph,
1048 /// Common types, pre-interned for your convenience.
1049 pub types: CommonTypes<'tcx>,
1051 /// Common lifetimes, pre-interned for your convenience.
1052 pub lifetimes: CommonLifetimes<'tcx>,
1054 /// Common consts, pre-interned for your convenience.
1055 pub consts: CommonConsts<'tcx>,
1057 /// Map indicating what traits are in scope for places where this
1058 /// is relevant; generated by resolve.
1059 trait_map: FxHashMap<DefIndex,
1060 Lrc<FxHashMap<ItemLocalId,
1061 Lrc<StableVec<TraitCandidate>>>>>,
1063 /// Export map produced by name resolution.
1064 export_map: FxHashMap<DefId, Lrc<Vec<Export<hir::HirId>>>>,
1066 hir_map: hir_map::Map<'tcx>,
1068 /// A map from DefPathHash -> DefId. Includes DefIds from the local crate
1069 /// as well as all upstream crates. Only populated in incremental mode.
1070 pub def_path_hash_to_def_id: Option<FxHashMap<DefPathHash, DefId>>,
1072 pub queries: query::Queries<'tcx>,
1074 // Records the captured variables referenced by every closure
1075 // expression. Do not track deps for this, just recompute it from
1076 // scratch every time.
1077 upvars: FxHashMap<DefId, Lrc<Vec<hir::Upvar>>>,
1079 maybe_unused_trait_imports: FxHashSet<DefId>,
1080 maybe_unused_extern_crates: Vec<(DefId, Span)>,
1081 /// A map of glob use to a set of names it actually imports. Currently only
1082 /// used in save-analysis.
1083 glob_map: FxHashMap<DefId, FxHashSet<ast::Name>>,
1084 /// Extern prelude entries. The value is `true` if the entry was introduced
1085 /// via `extern crate` item and not `--extern` option or compiler built-in.
1086 pub extern_prelude: FxHashMap<ast::Name, bool>,
1088 // Internal cache for metadata decoding. No need to track deps on this.
1089 pub rcache: Lock<FxHashMap<ty::CReaderCacheKey, Ty<'tcx>>>,
1091 /// Caches the results of trait selection. This cache is used
1092 /// for things that do not have to do with the parameters in scope.
1093 pub selection_cache: traits::SelectionCache<'tcx>,
1095 /// Caches the results of trait evaluation. This cache is used
1096 /// for things that do not have to do with the parameters in scope.
1097 /// Merge this with `selection_cache`?
1098 pub evaluation_cache: traits::EvaluationCache<'tcx>,
1100 /// The definite name of the current crate after taking into account
1101 /// attributes, commandline parameters, etc.
1102 pub crate_name: Symbol,
1104 /// Data layout specification for the current target.
1105 pub data_layout: TargetDataLayout,
1107 stability_interner: Lock<FxHashMap<&'tcx attr::Stability, ()>>,
1109 /// Stores the value of constants (and deduplicates the actual memory)
1110 allocation_interner: Lock<FxHashMap<&'tcx Allocation, ()>>,
1112 pub alloc_map: Lock<interpret::AllocMap<'tcx>>,
1114 layout_interner: Lock<FxHashMap<&'tcx LayoutDetails, ()>>,
1116 /// A general purpose channel to throw data out the back towards LLVM worker
1119 /// This is intended to only get used during the codegen phase of the compiler
1120 /// when satisfying the query for a particular codegen unit. Internally in
1121 /// the query it'll send data along this channel to get processed later.
1122 pub tx_to_llvm_workers: Lock<mpsc::Sender<Box<dyn Any + Send>>>,
1124 output_filenames: Arc<OutputFilenames>,
1127 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
1128 /// Gets the global `TyCtxt`.
1130 pub fn global_tcx(self) -> TyCtxt<'gcx, 'gcx, 'gcx> {
1133 interners: &self.gcx.global_interners,
1139 pub fn hir(self) -> &'a hir_map::Map<'gcx> {
1143 pub fn alloc_generics(self, generics: ty::Generics) -> &'gcx ty::Generics {
1144 self.global_arenas.generics.alloc(generics)
1147 pub fn alloc_steal_mir(self, mir: Mir<'gcx>) -> &'gcx Steal<Mir<'gcx>> {
1148 self.global_arenas.steal_mir.alloc(Steal::new(mir))
1151 pub fn alloc_mir(self, mir: Mir<'gcx>) -> &'gcx Mir<'gcx> {
1152 self.global_arenas.mir.alloc(mir)
1155 pub fn alloc_tables(self, tables: ty::TypeckTables<'gcx>) -> &'gcx ty::TypeckTables<'gcx> {
1156 self.global_arenas.tables.alloc(tables)
1159 pub fn alloc_trait_def(self, def: ty::TraitDef) -> &'gcx ty::TraitDef {
1160 self.global_arenas.trait_def.alloc(def)
1163 pub fn alloc_adt_def(self,
1166 variants: IndexVec<VariantIdx, ty::VariantDef>,
1168 -> &'gcx ty::AdtDef {
1169 let def = ty::AdtDef::new(self, did, kind, variants, repr);
1170 self.global_arenas.adt_def.alloc(def)
1173 pub fn intern_const_alloc(self, alloc: Allocation) -> &'gcx Allocation {
1174 self.allocation_interner.borrow_mut().intern(alloc, |alloc| {
1175 self.global_arenas.const_allocs.alloc(alloc)
1179 /// Allocates a byte or string literal for `mir::interpret`, read-only
1180 pub fn allocate_bytes(self, bytes: &[u8]) -> interpret::AllocId {
1181 // create an allocation that just contains these bytes
1182 let alloc = interpret::Allocation::from_byte_aligned_bytes(bytes, ());
1183 let alloc = self.intern_const_alloc(alloc);
1184 self.alloc_map.lock().allocate(alloc)
1187 pub fn intern_stability(self, stab: attr::Stability) -> &'gcx attr::Stability {
1188 self.stability_interner.borrow_mut().intern(stab, |stab| {
1189 self.global_interners.arena.alloc(stab)
1193 pub fn intern_layout(self, layout: LayoutDetails) -> &'gcx LayoutDetails {
1194 self.layout_interner.borrow_mut().intern(layout, |layout| {
1195 self.global_arenas.layout.alloc(layout)
1199 /// Returns a range of the start/end indices specified with the
1200 /// `rustc_layout_scalar_valid_range` attribute.
1201 pub fn layout_scalar_valid_range(self, def_id: DefId) -> (Bound<u128>, Bound<u128>) {
1202 let attrs = self.get_attrs(def_id);
1204 let attr = match attrs.iter().find(|a| a.check_name(name)) {
1206 None => return Bound::Unbounded,
1208 for meta in attr.meta_item_list().expect("rustc_layout_scalar_valid_range takes args") {
1209 match meta.literal().expect("attribute takes lit").node {
1210 ast::LitKind::Int(a, _) => return Bound::Included(a),
1211 _ => span_bug!(attr.span, "rustc_layout_scalar_valid_range expects int arg"),
1214 span_bug!(attr.span, "no arguments to `rustc_layout_scalar_valid_range` attribute");
1216 (get(sym::rustc_layout_scalar_valid_range_start),
1217 get(sym::rustc_layout_scalar_valid_range_end))
1220 pub fn lift<T: ?Sized + Lift<'tcx>>(self, value: &T) -> Option<T::Lifted> {
1221 value.lift_to_tcx(self)
1224 /// Like lift, but only tries in the global tcx.
1225 pub fn lift_to_global<T: ?Sized + Lift<'gcx>>(self, value: &T) -> Option<T::Lifted> {
1226 value.lift_to_tcx(self.global_tcx())
1229 /// Returns `true` if self is the same as self.global_tcx().
1230 fn is_global(self) -> bool {
1231 ptr_eq(self.interners, &self.global_interners)
1234 /// Creates a type context and call the closure with a `TyCtxt` reference
1235 /// to the context. The closure enforces that the type context and any interned
1236 /// value (types, substs, etc.) can only be used while `ty::tls` has a valid
1237 /// reference to the context, to allow formatting values that need it.
1238 pub fn create_global_ctxt(
1240 cstore: &'tcx CrateStoreDyn,
1241 local_providers: ty::query::Providers<'tcx>,
1242 extern_providers: ty::query::Providers<'tcx>,
1243 arenas: &'tcx AllArenas<'tcx>,
1244 resolutions: ty::Resolutions,
1245 hir: hir_map::Map<'tcx>,
1246 on_disk_query_result_cache: query::OnDiskCache<'tcx>,
1248 tx: mpsc::Sender<Box<dyn Any + Send>>,
1249 output_filenames: &OutputFilenames,
1250 ) -> GlobalCtxt<'tcx> {
1251 let data_layout = TargetDataLayout::parse(&s.target.target).unwrap_or_else(|err| {
1254 let interners = CtxtInterners::new(&arenas.interner);
1255 let common_types = CommonTypes::new(&interners);
1256 let common_lifetimes = CommonLifetimes::new(&interners);
1257 let common_consts = CommonConsts::new(&interners, &common_types);
1258 let dep_graph = hir.dep_graph.clone();
1259 let max_cnum = cstore.crates_untracked().iter().map(|c| c.as_usize()).max().unwrap_or(0);
1260 let mut providers = IndexVec::from_elem_n(extern_providers, max_cnum + 1);
1261 providers[LOCAL_CRATE] = local_providers;
1263 let def_path_hash_to_def_id = if s.opts.build_dep_graph() {
1264 let upstream_def_path_tables: Vec<(CrateNum, Lrc<_>)> = cstore
1267 .map(|&cnum| (cnum, cstore.def_path_table(cnum)))
1270 let def_path_tables = || {
1271 upstream_def_path_tables
1273 .map(|&(cnum, ref rc)| (cnum, &**rc))
1274 .chain(iter::once((LOCAL_CRATE, hir.definitions().def_path_table())))
1277 // Precompute the capacity of the hashmap so we don't have to
1278 // re-allocate when populating it.
1279 let capacity = def_path_tables().map(|(_, t)| t.size()).sum::<usize>();
1281 let mut map: FxHashMap<_, _> = FxHashMap::with_capacity_and_hasher(
1283 ::std::default::Default::default()
1286 for (cnum, def_path_table) in def_path_tables() {
1287 def_path_table.add_def_path_hashes_to(cnum, &mut map);
1295 let mut trait_map: FxHashMap<_, Lrc<FxHashMap<_, _>>> = FxHashMap::default();
1296 for (k, v) in resolutions.trait_map {
1297 let hir_id = hir.node_to_hir_id(k);
1298 let map = trait_map.entry(hir_id.owner).or_default();
1299 Lrc::get_mut(map).unwrap()
1300 .insert(hir_id.local_id,
1301 Lrc::new(StableVec::new(v)));
1307 arena: WorkerLocal::new(|_| Arena::default()),
1308 global_arenas: &arenas.global,
1309 global_interners: interners,
1311 types: common_types,
1312 lifetimes: common_lifetimes,
1313 consts: common_consts,
1315 export_map: resolutions.export_map.into_iter().map(|(k, v)| {
1316 let exports: Vec<_> = v.into_iter().map(|e| {
1317 e.map_id(|id| hir.node_to_hir_id(id))
1319 (k, Lrc::new(exports))
1321 upvars: resolutions.upvars.into_iter().map(|(k, v)| {
1322 let vars: Vec<_> = v.into_iter().map(|e| {
1323 e.map_id(|id| hir.node_to_hir_id(id))
1325 (hir.local_def_id(k), Lrc::new(vars))
1327 maybe_unused_trait_imports:
1328 resolutions.maybe_unused_trait_imports
1330 .map(|id| hir.local_def_id(id))
1332 maybe_unused_extern_crates:
1333 resolutions.maybe_unused_extern_crates
1335 .map(|(id, sp)| (hir.local_def_id(id), sp))
1337 glob_map: resolutions.glob_map.into_iter().map(|(id, names)| {
1338 (hir.local_def_id(id), names)
1340 extern_prelude: resolutions.extern_prelude,
1342 def_path_hash_to_def_id,
1343 queries: query::Queries::new(
1346 on_disk_query_result_cache,
1348 rcache: Default::default(),
1349 selection_cache: Default::default(),
1350 evaluation_cache: Default::default(),
1351 crate_name: Symbol::intern(crate_name),
1353 layout_interner: Default::default(),
1354 stability_interner: Default::default(),
1355 allocation_interner: Default::default(),
1356 alloc_map: Lock::new(interpret::AllocMap::new()),
1357 tx_to_llvm_workers: Lock::new(tx),
1358 output_filenames: Arc::new(output_filenames.clone()),
1362 pub fn consider_optimizing<T: Fn() -> String>(&self, msg: T) -> bool {
1363 let cname = self.crate_name(LOCAL_CRATE).as_str();
1364 self.sess.consider_optimizing(&cname, msg)
1367 pub fn lib_features(self) -> Lrc<middle::lib_features::LibFeatures> {
1368 self.get_lib_features(LOCAL_CRATE)
1371 pub fn lang_items(self) -> Lrc<middle::lang_items::LanguageItems> {
1372 self.get_lang_items(LOCAL_CRATE)
1375 /// Due to missing llvm support for lowering 128 bit math to software emulation
1376 /// (on some targets), the lowering can be done in MIR.
1378 /// This function only exists until said support is implemented.
1379 pub fn is_binop_lang_item(&self, def_id: DefId) -> Option<(mir::BinOp, bool)> {
1380 let items = self.lang_items();
1381 let def_id = Some(def_id);
1382 if items.i128_add_fn() == def_id { Some((mir::BinOp::Add, false)) }
1383 else if items.u128_add_fn() == def_id { Some((mir::BinOp::Add, false)) }
1384 else if items.i128_sub_fn() == def_id { Some((mir::BinOp::Sub, false)) }
1385 else if items.u128_sub_fn() == def_id { Some((mir::BinOp::Sub, false)) }
1386 else if items.i128_mul_fn() == def_id { Some((mir::BinOp::Mul, false)) }
1387 else if items.u128_mul_fn() == def_id { Some((mir::BinOp::Mul, false)) }
1388 else if items.i128_div_fn() == def_id { Some((mir::BinOp::Div, false)) }
1389 else if items.u128_div_fn() == def_id { Some((mir::BinOp::Div, false)) }
1390 else if items.i128_rem_fn() == def_id { Some((mir::BinOp::Rem, false)) }
1391 else if items.u128_rem_fn() == def_id { Some((mir::BinOp::Rem, false)) }
1392 else if items.i128_shl_fn() == def_id { Some((mir::BinOp::Shl, false)) }
1393 else if items.u128_shl_fn() == def_id { Some((mir::BinOp::Shl, false)) }
1394 else if items.i128_shr_fn() == def_id { Some((mir::BinOp::Shr, false)) }
1395 else if items.u128_shr_fn() == def_id { Some((mir::BinOp::Shr, false)) }
1396 else if items.i128_addo_fn() == def_id { Some((mir::BinOp::Add, true)) }
1397 else if items.u128_addo_fn() == def_id { Some((mir::BinOp::Add, true)) }
1398 else if items.i128_subo_fn() == def_id { Some((mir::BinOp::Sub, true)) }
1399 else if items.u128_subo_fn() == def_id { Some((mir::BinOp::Sub, true)) }
1400 else if items.i128_mulo_fn() == def_id { Some((mir::BinOp::Mul, true)) }
1401 else if items.u128_mulo_fn() == def_id { Some((mir::BinOp::Mul, true)) }
1402 else if items.i128_shlo_fn() == def_id { Some((mir::BinOp::Shl, true)) }
1403 else if items.u128_shlo_fn() == def_id { Some((mir::BinOp::Shl, true)) }
1404 else if items.i128_shro_fn() == def_id { Some((mir::BinOp::Shr, true)) }
1405 else if items.u128_shro_fn() == def_id { Some((mir::BinOp::Shr, true)) }
1409 pub fn stability(self) -> Lrc<stability::Index<'tcx>> {
1410 self.stability_index(LOCAL_CRATE)
1413 pub fn crates(self) -> Lrc<Vec<CrateNum>> {
1414 self.all_crate_nums(LOCAL_CRATE)
1417 pub fn features(self) -> Lrc<feature_gate::Features> {
1418 self.features_query(LOCAL_CRATE)
1421 pub fn def_key(self, id: DefId) -> hir_map::DefKey {
1423 self.hir().def_key(id)
1425 self.cstore.def_key(id)
1429 /// Converts a `DefId` into its fully expanded `DefPath` (every
1430 /// `DefId` is really just an interned def-path).
1432 /// Note that if `id` is not local to this crate, the result will
1433 /// be a non-local `DefPath`.
1434 pub fn def_path(self, id: DefId) -> hir_map::DefPath {
1436 self.hir().def_path(id)
1438 self.cstore.def_path(id)
1442 /// Returns whether or not the crate with CrateNum 'cnum'
1443 /// is marked as a private dependency
1444 pub fn is_private_dep(self, cnum: CrateNum) -> bool {
1445 if cnum == LOCAL_CRATE {
1448 self.cstore.crate_is_private_dep_untracked(cnum)
1453 pub fn def_path_hash(self, def_id: DefId) -> hir_map::DefPathHash {
1454 if def_id.is_local() {
1455 self.hir().definitions().def_path_hash(def_id.index)
1457 self.cstore.def_path_hash(def_id)
1461 pub fn def_path_debug_str(self, def_id: DefId) -> String {
1462 // We are explicitly not going through queries here in order to get
1463 // crate name and disambiguator since this code is called from debug!()
1464 // statements within the query system and we'd run into endless
1465 // recursion otherwise.
1466 let (crate_name, crate_disambiguator) = if def_id.is_local() {
1467 (self.crate_name.clone(),
1468 self.sess.local_crate_disambiguator())
1470 (self.cstore.crate_name_untracked(def_id.krate),
1471 self.cstore.crate_disambiguator_untracked(def_id.krate))
1476 // Don't print the whole crate disambiguator. That's just
1477 // annoying in debug output.
1478 &(crate_disambiguator.to_fingerprint().to_hex())[..4],
1479 self.def_path(def_id).to_string_no_crate())
1482 pub fn metadata_encoding_version(self) -> Vec<u8> {
1483 self.cstore.metadata_encoding_version().to_vec()
1486 // Note that this is *untracked* and should only be used within the query
1487 // system if the result is otherwise tracked through queries
1488 pub fn crate_data_as_rc_any(self, cnum: CrateNum) -> Lrc<dyn Any> {
1489 self.cstore.crate_data_as_rc_any(cnum)
1493 pub fn create_stable_hashing_context(self) -> StableHashingContext<'a> {
1494 let krate = self.gcx.hir_map.forest.untracked_krate();
1496 StableHashingContext::new(self.sess,
1498 self.hir().definitions(),
1502 // This method makes sure that we have a DepNode and a Fingerprint for
1503 // every upstream crate. It needs to be called once right after the tcx is
1505 // With full-fledged red/green, the method will probably become unnecessary
1506 // as this will be done on-demand.
1507 pub fn allocate_metadata_dep_nodes(self) {
1508 // We cannot use the query versions of crates() and crate_hash(), since
1509 // those would need the DepNodes that we are allocating here.
1510 for cnum in self.cstore.crates_untracked() {
1511 let dep_node = DepNode::new(self, DepConstructor::CrateMetadata(cnum));
1512 let crate_hash = self.cstore.crate_hash_untracked(cnum);
1513 self.dep_graph.with_task(dep_node,
1516 |_, x| x, // No transformation needed
1517 dep_graph::hash_result,
1522 pub fn serialize_query_result_cache<E>(self,
1524 -> Result<(), E::Error>
1525 where E: ty::codec::TyEncoder
1527 self.queries.on_disk_cache.serialize(self.global_tcx(), encoder)
1530 /// If true, we should use the AST-based borrowck (we may *also* use
1531 /// the MIR-based borrowck).
1532 pub fn use_ast_borrowck(self) -> bool {
1533 self.borrowck_mode().use_ast()
1536 /// If true, we should use the MIR-based borrow check, but also
1537 /// fall back on the AST borrow check if the MIR-based one errors.
1538 pub fn migrate_borrowck(self) -> bool {
1539 self.borrowck_mode().migrate()
1542 /// If true, make MIR codegen for `match` emit a temp that holds a
1543 /// borrow of the input to the match expression.
1544 pub fn generate_borrow_of_any_match_input(&self) -> bool {
1545 self.emit_read_for_match()
1548 /// If true, make MIR codegen for `match` emit FakeRead
1549 /// statements (which simulate the maximal effect of executing the
1550 /// patterns in a match arm).
1551 pub fn emit_read_for_match(&self) -> bool {
1552 !self.sess.opts.debugging_opts.nll_dont_emit_read_for_match
1555 /// What mode(s) of borrowck should we run? AST? MIR? both?
1556 /// (Also considers the `#![feature(nll)]` setting.)
1557 pub fn borrowck_mode(&self) -> BorrowckMode {
1558 // Here are the main constraints we need to deal with:
1560 // 1. An opts.borrowck_mode of `BorrowckMode::Migrate` is
1561 // synonymous with no `-Z borrowck=...` flag at all.
1563 // 2. We want to allow developers on the Nightly channel
1564 // to opt back into the "hard error" mode for NLL,
1565 // (which they can do via specifying `#![feature(nll)]`
1566 // explicitly in their crate).
1568 // So, this precedence list is how pnkfelix chose to work with
1569 // the above constraints:
1571 // * `#![feature(nll)]` *always* means use NLL with hard
1572 // errors. (To simplify the code here, it now even overrides
1573 // a user's attempt to specify `-Z borrowck=compare`, which
1574 // we arguably do not need anymore and should remove.)
1576 // * Otherwise, if no `-Z borrowck=...` then use migrate mode
1578 // * Otherwise, use the behavior requested via `-Z borrowck=...`
1580 if self.features().nll { return BorrowckMode::Mir; }
1582 self.sess.opts.borrowck_mode
1586 pub fn local_crate_exports_generics(self) -> bool {
1587 debug_assert!(self.sess.opts.share_generics());
1589 self.sess.crate_types.borrow().iter().any(|crate_type| {
1591 CrateType::Executable |
1592 CrateType::Staticlib |
1593 CrateType::ProcMacro |
1594 CrateType::Cdylib => false,
1596 CrateType::Dylib => true,
1601 // This method returns the DefId and the BoundRegion corresponding to the given region.
1602 pub fn is_suitable_region(&self, region: Region<'tcx>) -> Option<FreeRegionInfo> {
1603 let (suitable_region_binding_scope, bound_region) = match *region {
1604 ty::ReFree(ref free_region) => (free_region.scope, free_region.bound_region),
1605 ty::ReEarlyBound(ref ebr) => (
1606 self.parent(ebr.def_id).unwrap(),
1607 ty::BoundRegion::BrNamed(ebr.def_id, ebr.name),
1609 _ => return None, // not a free region
1612 let hir_id = self.hir()
1613 .as_local_hir_id(suitable_region_binding_scope)
1615 let is_impl_item = match self.hir().find_by_hir_id(hir_id) {
1616 Some(Node::Item(..)) | Some(Node::TraitItem(..)) => false,
1617 Some(Node::ImplItem(..)) => {
1618 self.is_bound_region_in_impl_item(suitable_region_binding_scope)
1623 return Some(FreeRegionInfo {
1624 def_id: suitable_region_binding_scope,
1625 boundregion: bound_region,
1626 is_impl_item: is_impl_item,
1630 pub fn return_type_impl_trait(
1632 scope_def_id: DefId,
1633 ) -> Option<Ty<'tcx>> {
1634 // HACK: `type_of_def_id()` will fail on these (#55796), so return None
1635 let hir_id = self.hir().as_local_hir_id(scope_def_id).unwrap();
1636 match self.hir().get_by_hir_id(hir_id) {
1637 Node::Item(item) => {
1639 ItemKind::Fn(..) => { /* type_of_def_id() will work */ }
1645 _ => { /* type_of_def_id() will work or panic */ }
1648 let ret_ty = self.type_of(scope_def_id);
1650 ty::FnDef(_, _) => {
1651 let sig = ret_ty.fn_sig(*self);
1652 let output = self.erase_late_bound_regions(&sig.output());
1653 if output.is_impl_trait() {
1663 // Here we check if the bound region is in Impl Item.
1664 pub fn is_bound_region_in_impl_item(
1666 suitable_region_binding_scope: DefId,
1668 let container_id = self.associated_item(suitable_region_binding_scope)
1671 if self.impl_trait_ref(container_id).is_some() {
1672 // For now, we do not try to target impls of traits. This is
1673 // because this message is going to suggest that the user
1674 // change the fn signature, but they may not be free to do so,
1675 // since the signature must match the trait.
1677 // FIXME(#42706) -- in some cases, we could do better here.
1683 /// Determine whether identifiers in the assembly have strict naming rules.
1684 /// Currently, only NVPTX* targets need it.
1685 pub fn has_strict_asm_symbol_naming(&self) -> bool {
1686 self.gcx.sess.target.target.arch.contains("nvptx")
1690 impl<'a, 'tcx> TyCtxt<'a, 'tcx, 'tcx> {
1691 pub fn encode_metadata(self)
1694 self.cstore.encode_metadata(self)
1698 impl<'gcx> GlobalCtxt<'gcx> {
1699 /// Call the closure with a local `TyCtxt` using the given arena.
1700 /// `interners` is a slot passed so we can create a CtxtInterners
1701 /// with the same lifetime as `arena`.
1702 pub fn enter_local<'tcx, F, R>(
1704 arena: &'tcx SyncDroplessArena,
1705 interners: &'tcx mut Option<CtxtInterners<'tcx>>,
1709 F: FnOnce(TyCtxt<'tcx, 'gcx, 'tcx>) -> R,
1712 *interners = Some(CtxtInterners::new(&arena));
1715 interners: interners.as_ref().unwrap(),
1718 ty::tls::with_related_context(tcx.global_tcx(), |icx| {
1719 let new_icx = ty::tls::ImplicitCtxt {
1721 query: icx.query.clone(),
1722 diagnostics: icx.diagnostics,
1723 layout_depth: icx.layout_depth,
1724 task_deps: icx.task_deps,
1726 ty::tls::enter_context(&new_icx, |_| {
1733 /// A trait implemented for all X<'a> types which can be safely and
1734 /// efficiently converted to X<'tcx> as long as they are part of the
1735 /// provided TyCtxt<'tcx>.
1736 /// This can be done, for example, for Ty<'tcx> or SubstsRef<'tcx>
1737 /// by looking them up in their respective interners.
1739 /// However, this is still not the best implementation as it does
1740 /// need to compare the components, even for interned values.
1741 /// It would be more efficient if TypedArena provided a way to
1742 /// determine whether the address is in the allocated range.
1744 /// None is returned if the value or one of the components is not part
1745 /// of the provided context.
1746 /// For Ty, None can be returned if either the type interner doesn't
1747 /// contain the TyKind key or if the address of the interned
1748 /// pointer differs. The latter case is possible if a primitive type,
1749 /// e.g., `()` or `u8`, was interned in a different context.
1750 pub trait Lift<'tcx>: fmt::Debug {
1751 type Lifted: fmt::Debug + 'tcx;
1752 fn lift_to_tcx<'a, 'gcx>(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Option<Self::Lifted>;
1756 macro_rules! nop_lift {
1757 ($ty:ty => $lifted:ty) => {
1758 impl<'a, 'tcx> Lift<'tcx> for $ty {
1759 type Lifted = $lifted;
1760 fn lift_to_tcx<'b, 'gcx>(&self, tcx: TyCtxt<'b, 'gcx, 'tcx>) -> Option<Self::Lifted> {
1761 if tcx.interners.arena.in_arena(*self as *const _) {
1762 return Some(unsafe { mem::transmute(*self) });
1764 // Also try in the global tcx if we're not that.
1765 if !tcx.is_global() {
1766 self.lift_to_tcx(tcx.global_tcx())
1775 macro_rules! nop_list_lift {
1776 ($ty:ty => $lifted:ty) => {
1777 impl<'a, 'tcx> Lift<'tcx> for &'a List<$ty> {
1778 type Lifted = &'tcx List<$lifted>;
1779 fn lift_to_tcx<'b, 'gcx>(&self, tcx: TyCtxt<'b, 'gcx, 'tcx>) -> Option<Self::Lifted> {
1780 if self.is_empty() {
1781 return Some(List::empty());
1783 if tcx.interners.arena.in_arena(*self as *const _) {
1784 return Some(unsafe { mem::transmute(*self) });
1786 // Also try in the global tcx if we're not that.
1787 if !tcx.is_global() {
1788 self.lift_to_tcx(tcx.global_tcx())
1797 nop_lift!{Ty<'a> => Ty<'tcx>}
1798 nop_lift!{Region<'a> => Region<'tcx>}
1799 nop_lift!{Goal<'a> => Goal<'tcx>}
1800 nop_lift!{&'a Const<'a> => &'tcx Const<'tcx>}
1802 nop_list_lift!{Goal<'a> => Goal<'tcx>}
1803 nop_list_lift!{Clause<'a> => Clause<'tcx>}
1804 nop_list_lift!{Ty<'a> => Ty<'tcx>}
1805 nop_list_lift!{ExistentialPredicate<'a> => ExistentialPredicate<'tcx>}
1806 nop_list_lift!{Predicate<'a> => Predicate<'tcx>}
1807 nop_list_lift!{CanonicalVarInfo => CanonicalVarInfo}
1808 nop_list_lift!{ProjectionKind => ProjectionKind}
1810 // this is the impl for `&'a InternalSubsts<'a>`
1811 nop_list_lift!{Kind<'a> => Kind<'tcx>}
1813 impl<'a, 'tcx> Lift<'tcx> for &'a mir::interpret::Allocation {
1814 type Lifted = &'tcx mir::interpret::Allocation;
1815 fn lift_to_tcx<'b, 'gcx>(&self, tcx: TyCtxt<'b, 'gcx, 'tcx>) -> Option<Self::Lifted> {
1816 assert!(tcx.global_arenas.const_allocs.in_arena(*self as *const _));
1817 Some(unsafe { mem::transmute(*self) })
1822 use super::{GlobalCtxt, TyCtxt, ptr_eq};
1826 use std::marker::PhantomData;
1828 use crate::ty::query;
1829 use errors::{Diagnostic, TRACK_DIAGNOSTICS};
1830 use rustc_data_structures::OnDrop;
1831 use rustc_data_structures::sync::{self, Lrc, Lock};
1832 use rustc_data_structures::thin_vec::ThinVec;
1833 use crate::dep_graph::TaskDeps;
1835 #[cfg(not(parallel_compiler))]
1836 use std::cell::Cell;
1838 #[cfg(parallel_compiler)]
1839 use rustc_rayon_core as rayon_core;
1841 /// This is the implicit state of rustc. It contains the current
1842 /// TyCtxt and query. It is updated when creating a local interner or
1843 /// executing a new query. Whenever there's a TyCtxt value available
1844 /// you should also have access to an ImplicitCtxt through the functions
1847 pub struct ImplicitCtxt<'a, 'gcx: 'tcx, 'tcx> {
1848 /// The current TyCtxt. Initially created by `enter_global` and updated
1849 /// by `enter_local` with a new local interner
1850 pub tcx: TyCtxt<'tcx, 'gcx, 'tcx>,
1852 /// The current query job, if any. This is updated by JobOwner::start in
1853 /// ty::query::plumbing when executing a query
1854 pub query: Option<Lrc<query::QueryJob<'gcx>>>,
1856 /// Where to store diagnostics for the current query job, if any.
1857 /// This is updated by JobOwner::start in ty::query::plumbing when executing a query
1858 pub diagnostics: Option<&'a Lock<ThinVec<Diagnostic>>>,
1860 /// Used to prevent layout from recursing too deeply.
1861 pub layout_depth: usize,
1863 /// The current dep graph task. This is used to add dependencies to queries
1864 /// when executing them
1865 pub task_deps: Option<&'a Lock<TaskDeps>>,
1868 /// Sets Rayon's thread local variable which is preserved for Rayon jobs
1869 /// to `value` during the call to `f`. It is restored to its previous value after.
1870 /// This is used to set the pointer to the new ImplicitCtxt.
1871 #[cfg(parallel_compiler)]
1873 fn set_tlv<F: FnOnce() -> R, R>(value: usize, f: F) -> R {
1874 rayon_core::tlv::with(value, f)
1877 /// Gets Rayon's thread local variable which is preserved for Rayon jobs.
1878 /// This is used to get the pointer to the current ImplicitCtxt.
1879 #[cfg(parallel_compiler)]
1881 fn get_tlv() -> usize {
1882 rayon_core::tlv::get()
1885 #[cfg(not(parallel_compiler))]
1887 /// A thread local variable which stores a pointer to the current ImplicitCtxt.
1888 static TLV: Cell<usize> = Cell::new(0);
1891 /// Sets TLV to `value` during the call to `f`.
1892 /// It is restored to its previous value after.
1893 /// This is used to set the pointer to the new ImplicitCtxt.
1894 #[cfg(not(parallel_compiler))]
1896 fn set_tlv<F: FnOnce() -> R, R>(value: usize, f: F) -> R {
1897 let old = get_tlv();
1898 let _reset = OnDrop(move || TLV.with(|tlv| tlv.set(old)));
1899 TLV.with(|tlv| tlv.set(value));
1903 /// This is used to get the pointer to the current ImplicitCtxt.
1904 #[cfg(not(parallel_compiler))]
1905 fn get_tlv() -> usize {
1906 TLV.with(|tlv| tlv.get())
1909 /// This is a callback from libsyntax as it cannot access the implicit state
1910 /// in librustc otherwise
1911 fn span_debug(span: syntax_pos::Span, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1913 if let Some(tcx) = tcx {
1914 write!(f, "{}", tcx.sess.source_map().span_to_string(span))
1916 syntax_pos::default_span_debug(span, f)
1921 /// This is a callback from libsyntax as it cannot access the implicit state
1922 /// in librustc otherwise. It is used to when diagnostic messages are
1923 /// emitted and stores them in the current query, if there is one.
1924 fn track_diagnostic(diagnostic: &Diagnostic) {
1925 with_context_opt(|icx| {
1926 if let Some(icx) = icx {
1927 if let Some(ref diagnostics) = icx.diagnostics {
1928 let mut diagnostics = diagnostics.lock();
1929 diagnostics.extend(Some(diagnostic.clone()));
1935 /// Sets up the callbacks from libsyntax on the current thread
1936 pub fn with_thread_locals<F, R>(f: F) -> R
1937 where F: FnOnce() -> R
1939 syntax_pos::SPAN_DEBUG.with(|span_dbg| {
1940 let original_span_debug = span_dbg.get();
1941 span_dbg.set(span_debug);
1943 let _on_drop = OnDrop(move || {
1944 span_dbg.set(original_span_debug);
1947 TRACK_DIAGNOSTICS.with(|current| {
1948 let original = current.get();
1949 current.set(track_diagnostic);
1951 let _on_drop = OnDrop(move || {
1952 current.set(original);
1960 /// Sets `context` as the new current ImplicitCtxt for the duration of the function `f`
1962 pub fn enter_context<'a, 'gcx: 'tcx, 'tcx, F, R>(context: &ImplicitCtxt<'a, 'gcx, 'tcx>,
1964 where F: FnOnce(&ImplicitCtxt<'a, 'gcx, 'tcx>) -> R
1966 set_tlv(context as *const _ as usize, || {
1971 /// Enters GlobalCtxt by setting up libsyntax callbacks and
1972 /// creating a initial TyCtxt and ImplicitCtxt.
1973 /// This happens once per rustc session and TyCtxts only exists
1974 /// inside the `f` function.
1975 pub fn enter_global<'gcx, F, R>(gcx: &'gcx GlobalCtxt<'gcx>, f: F) -> R
1976 where F: FnOnce(TyCtxt<'gcx, 'gcx, 'gcx>) -> R
1978 // Update GCX_PTR to indicate there's a GlobalCtxt available
1979 GCX_PTR.with(|lock| {
1980 *lock.lock() = gcx as *const _ as usize;
1982 // Set GCX_PTR back to 0 when we exit
1983 let _on_drop = OnDrop(move || {
1984 GCX_PTR.with(|lock| *lock.lock() = 0);
1989 interners: &gcx.global_interners,
1992 let icx = ImplicitCtxt {
1999 enter_context(&icx, |_| {
2004 scoped_thread_local! {
2005 /// Stores a pointer to the GlobalCtxt if one is available.
2006 /// This is used to access the GlobalCtxt in the deadlock handler given to Rayon.
2007 pub static GCX_PTR: Lock<usize>
2010 /// Creates a TyCtxt and ImplicitCtxt based on the GCX_PTR thread local.
2011 /// This is used in the deadlock handler.
2012 pub unsafe fn with_global<F, R>(f: F) -> R
2013 where F: for<'a, 'gcx, 'tcx> FnOnce(TyCtxt<'a, 'gcx, 'tcx>) -> R
2015 let gcx = GCX_PTR.with(|lock| *lock.lock());
2017 let gcx = &*(gcx as *const GlobalCtxt<'_>);
2020 interners: &gcx.global_interners,
2023 let icx = ImplicitCtxt {
2030 enter_context(&icx, |_| f(tcx))
2033 /// Allows access to the current ImplicitCtxt in a closure if one is available
2035 pub fn with_context_opt<F, R>(f: F) -> R
2036 where F: for<'a, 'gcx, 'tcx> FnOnce(Option<&ImplicitCtxt<'a, 'gcx, 'tcx>>) -> R
2038 let context = get_tlv();
2042 // We could get a ImplicitCtxt pointer from another thread.
2043 // Ensure that ImplicitCtxt is Sync
2044 sync::assert_sync::<ImplicitCtxt<'_, '_, '_>>();
2046 unsafe { f(Some(&*(context as *const ImplicitCtxt<'_, '_, '_>))) }
2050 /// Allows access to the current ImplicitCtxt.
2051 /// Panics if there is no ImplicitCtxt available
2053 pub fn with_context<F, R>(f: F) -> R
2054 where F: for<'a, 'gcx, 'tcx> FnOnce(&ImplicitCtxt<'a, 'gcx, 'tcx>) -> R
2056 with_context_opt(|opt_context| f(opt_context.expect("no ImplicitCtxt stored in tls")))
2059 /// Allows access to the current ImplicitCtxt whose tcx field has the same global
2060 /// interner as the tcx argument passed in. This means the closure is given an ImplicitCtxt
2061 /// with the same 'gcx lifetime as the TyCtxt passed in.
2062 /// This will panic if you pass it a TyCtxt which has a different global interner from
2063 /// the current ImplicitCtxt's tcx field.
2065 pub fn with_related_context<'a, 'gcx, 'tcx1, F, R>(tcx: TyCtxt<'a, 'gcx, 'tcx1>, f: F) -> R
2066 where F: for<'b, 'tcx2> FnOnce(&ImplicitCtxt<'b, 'gcx, 'tcx2>) -> R
2068 with_context(|context| {
2070 assert!(ptr_eq(context.tcx.gcx, tcx.gcx));
2071 let context: &ImplicitCtxt<'_, '_, '_> = mem::transmute(context);
2077 /// Allows access to the current ImplicitCtxt whose tcx field has the same global
2078 /// interner and local interner as the tcx argument passed in. This means the closure
2079 /// is given an ImplicitCtxt with the same 'tcx and 'gcx lifetimes as the TyCtxt passed in.
2080 /// This will panic if you pass it a TyCtxt which has a different global interner or
2081 /// a different local interner from the current ImplicitCtxt's tcx field.
2083 pub fn with_fully_related_context<'a, 'gcx, 'tcx, F, R>(tcx: TyCtxt<'a, 'gcx, 'tcx>, f: F) -> R
2084 where F: for<'b> FnOnce(&ImplicitCtxt<'b, 'gcx, 'tcx>) -> R
2086 with_context(|context| {
2088 assert!(ptr_eq(context.tcx.gcx, tcx.gcx));
2089 assert!(ptr_eq(context.tcx.interners, tcx.interners));
2090 let context: &ImplicitCtxt<'_, '_, '_> = mem::transmute(context);
2096 /// Allows access to the TyCtxt in the current ImplicitCtxt.
2097 /// Panics if there is no ImplicitCtxt available
2099 pub fn with<F, R>(f: F) -> R
2100 where F: for<'a, 'gcx, 'tcx> FnOnce(TyCtxt<'a, 'gcx, 'tcx>) -> R
2102 with_context(|context| f(context.tcx))
2105 /// Allows access to the TyCtxt in the current ImplicitCtxt.
2106 /// The closure is passed None if there is no ImplicitCtxt available
2108 pub fn with_opt<F, R>(f: F) -> R
2109 where F: for<'a, 'gcx, 'tcx> FnOnce(Option<TyCtxt<'a, 'gcx, 'tcx>>) -> R
2111 with_context_opt(|opt_context| f(opt_context.map(|context| context.tcx)))
2115 macro_rules! sty_debug_print {
2116 ($ctxt: expr, $($variant: ident),*) => {{
2117 // curious inner module to allow variant names to be used as
2119 #[allow(non_snake_case)]
2121 use crate::ty::{self, TyCtxt};
2122 use crate::ty::context::Interned;
2124 #[derive(Copy, Clone)]
2133 pub fn go(tcx: TyCtxt<'_, '_, '_>) {
2134 let mut total = DebugStat {
2141 $(let mut $variant = total;)*
2143 for &Interned(t) in tcx.interners.type_.borrow().keys() {
2144 let variant = match t.sty {
2145 ty::Bool | ty::Char | ty::Int(..) | ty::Uint(..) |
2146 ty::Float(..) | ty::Str | ty::Never => continue,
2147 ty::Error => /* unimportant */ continue,
2148 $(ty::$variant(..) => &mut $variant,)*
2150 let lt = t.flags.intersects(ty::TypeFlags::HAS_RE_INFER);
2151 let ty = t.flags.intersects(ty::TypeFlags::HAS_TY_INFER);
2152 let ct = t.flags.intersects(ty::TypeFlags::HAS_CT_INFER);
2156 if lt { total.lt_infer += 1; variant.lt_infer += 1 }
2157 if ty { total.ty_infer += 1; variant.ty_infer += 1 }
2158 if ct { total.ct_infer += 1; variant.ct_infer += 1 }
2159 if lt && ty && ct { total.all_infer += 1; variant.all_infer += 1 }
2161 println!("Ty interner total ty lt ct all");
2162 $(println!(" {:18}: {uses:6} {usespc:4.1}%, \
2163 {ty:4.1}% {lt:5.1}% {ct:4.1}% {all:4.1}%",
2164 stringify!($variant),
2165 uses = $variant.total,
2166 usespc = $variant.total as f64 * 100.0 / total.total as f64,
2167 ty = $variant.ty_infer as f64 * 100.0 / total.total as f64,
2168 lt = $variant.lt_infer as f64 * 100.0 / total.total as f64,
2169 ct = $variant.ct_infer as f64 * 100.0 / total.total as f64,
2170 all = $variant.all_infer as f64 * 100.0 / total.total as f64);
2172 println!(" total {uses:6} \
2173 {ty:4.1}% {lt:5.1}% {ct:4.1}% {all:4.1}%",
2175 ty = total.ty_infer as f64 * 100.0 / total.total as f64,
2176 lt = total.lt_infer as f64 * 100.0 / total.total as f64,
2177 ct = total.ct_infer as f64 * 100.0 / total.total as f64,
2178 all = total.all_infer as f64 * 100.0 / total.total as f64)
2186 impl<'a, 'tcx> TyCtxt<'a, 'tcx, 'tcx> {
2187 pub fn print_debug_stats(self) {
2190 Adt, Array, Slice, RawPtr, Ref, FnDef, FnPtr, Placeholder,
2191 Generator, GeneratorWitness, Dynamic, Closure, Tuple, Bound,
2192 Param, Infer, UnnormalizedProjection, Projection, Opaque, Foreign);
2194 println!("InternalSubsts interner: #{}", self.interners.substs.borrow().len());
2195 println!("Region interner: #{}", self.interners.region.borrow().len());
2196 println!("Stability interner: #{}", self.stability_interner.borrow().len());
2197 println!("Allocation interner: #{}", self.allocation_interner.borrow().len());
2198 println!("Layout interner: #{}", self.layout_interner.borrow().len());
2203 /// An entry in an interner.
2204 struct Interned<'tcx, T: 'tcx+?Sized>(&'tcx T);
2206 impl<'tcx, T: 'tcx+?Sized> Clone for Interned<'tcx, T> {
2207 fn clone(&self) -> Self {
2211 impl<'tcx, T: 'tcx+?Sized> Copy for Interned<'tcx, T> {}
2213 // N.B., an `Interned<Ty>` compares and hashes as a sty.
2214 impl<'tcx> PartialEq for Interned<'tcx, TyS<'tcx>> {
2215 fn eq(&self, other: &Interned<'tcx, TyS<'tcx>>) -> bool {
2216 self.0.sty == other.0.sty
2220 impl<'tcx> Eq for Interned<'tcx, TyS<'tcx>> {}
2222 impl<'tcx> Hash for Interned<'tcx, TyS<'tcx>> {
2223 fn hash<H: Hasher>(&self, s: &mut H) {
2228 impl<'tcx: 'lcx, 'lcx> Borrow<TyKind<'lcx>> for Interned<'tcx, TyS<'tcx>> {
2229 fn borrow<'a>(&'a self) -> &'a TyKind<'lcx> {
2234 // N.B., an `Interned<List<T>>` compares and hashes as its elements.
2235 impl<'tcx, T: PartialEq> PartialEq for Interned<'tcx, List<T>> {
2236 fn eq(&self, other: &Interned<'tcx, List<T>>) -> bool {
2237 self.0[..] == other.0[..]
2241 impl<'tcx, T: Eq> Eq for Interned<'tcx, List<T>> {}
2243 impl<'tcx, T: Hash> Hash for Interned<'tcx, List<T>> {
2244 fn hash<H: Hasher>(&self, s: &mut H) {
2249 impl<'tcx: 'lcx, 'lcx> Borrow<[Ty<'lcx>]> for Interned<'tcx, List<Ty<'tcx>>> {
2250 fn borrow<'a>(&'a self) -> &'a [Ty<'lcx>] {
2255 impl<'tcx: 'lcx, 'lcx> Borrow<[CanonicalVarInfo]> for Interned<'tcx, List<CanonicalVarInfo>> {
2256 fn borrow<'a>(&'a self) -> &'a [CanonicalVarInfo] {
2261 impl<'tcx: 'lcx, 'lcx> Borrow<[Kind<'lcx>]> for Interned<'tcx, InternalSubsts<'tcx>> {
2262 fn borrow<'a>(&'a self) -> &'a [Kind<'lcx>] {
2267 impl<'tcx> Borrow<[ProjectionKind]>
2268 for Interned<'tcx, List<ProjectionKind>> {
2269 fn borrow<'a>(&'a self) -> &'a [ProjectionKind] {
2274 impl<'tcx> Borrow<RegionKind> for Interned<'tcx, RegionKind> {
2275 fn borrow<'a>(&'a self) -> &'a RegionKind {
2280 impl<'tcx: 'lcx, 'lcx> Borrow<GoalKind<'lcx>> for Interned<'tcx, GoalKind<'tcx>> {
2281 fn borrow<'a>(&'a self) -> &'a GoalKind<'lcx> {
2286 impl<'tcx: 'lcx, 'lcx> Borrow<[ExistentialPredicate<'lcx>]>
2287 for Interned<'tcx, List<ExistentialPredicate<'tcx>>> {
2288 fn borrow<'a>(&'a self) -> &'a [ExistentialPredicate<'lcx>] {
2293 impl<'tcx: 'lcx, 'lcx> Borrow<[Predicate<'lcx>]>
2294 for Interned<'tcx, List<Predicate<'tcx>>> {
2295 fn borrow<'a>(&'a self) -> &'a [Predicate<'lcx>] {
2300 impl<'tcx: 'lcx, 'lcx> Borrow<Const<'lcx>> for Interned<'tcx, Const<'tcx>> {
2301 fn borrow<'a>(&'a self) -> &'a Const<'lcx> {
2306 impl<'tcx: 'lcx, 'lcx> Borrow<[Clause<'lcx>]>
2307 for Interned<'tcx, List<Clause<'tcx>>> {
2308 fn borrow<'a>(&'a self) -> &'a [Clause<'lcx>] {
2313 impl<'tcx: 'lcx, 'lcx> Borrow<[Goal<'lcx>]>
2314 for Interned<'tcx, List<Goal<'tcx>>> {
2315 fn borrow<'a>(&'a self) -> &'a [Goal<'lcx>] {
2320 macro_rules! intern_method {
2321 ($lt_tcx:tt, $name:ident: $method:ident($alloc:ty,
2324 $keep_in_local_tcx:expr) -> $ty:ty) => {
2325 impl<'a, 'gcx, $lt_tcx> TyCtxt<'a, 'gcx, $lt_tcx> {
2326 pub fn $method(self, v: $alloc) -> &$lt_tcx $ty {
2327 let key = ($alloc_to_key)(&v);
2329 // HACK(eddyb) Depend on flags being accurate to
2330 // determine that all contents are in the global tcx.
2331 // See comments on Lift for why we can't use that.
2332 if ($keep_in_local_tcx)(&v) {
2333 self.interners.$name.borrow_mut().intern_ref(key, || {
2334 // Make sure we don't end up with inference
2335 // types/regions in the global tcx.
2336 if self.is_global() {
2337 bug!("Attempted to intern `{:?}` which contains \
2338 inference types/regions in the global type context",
2342 Interned($alloc_method(&self.interners.arena, v))
2345 self.global_interners.$name.borrow_mut().intern_ref(key, || {
2346 // This transmutes $alloc<'tcx> to $alloc<'gcx>
2350 let i: &$lt_tcx $ty = $alloc_method(&self.global_interners.arena, v);
2352 let i = unsafe { mem::transmute(i) };
2361 macro_rules! direct_interners {
2362 ($lt_tcx:tt, $($name:ident: $method:ident($keep_in_local_tcx:expr) -> $ty:ty),+) => {
2363 $(impl<$lt_tcx> PartialEq for Interned<$lt_tcx, $ty> {
2364 fn eq(&self, other: &Self) -> bool {
2369 impl<$lt_tcx> Eq for Interned<$lt_tcx, $ty> {}
2371 impl<$lt_tcx> Hash for Interned<$lt_tcx, $ty> {
2372 fn hash<H: Hasher>(&self, s: &mut H) {
2380 |a: &$lt_tcx SyncDroplessArena, v| -> &$lt_tcx $ty { a.alloc(v) },
2382 $keep_in_local_tcx) -> $ty);)+
2386 pub fn keep_local<'tcx, T: ty::TypeFoldable<'tcx>>(x: &T) -> bool {
2387 x.has_type_flags(ty::TypeFlags::KEEP_IN_LOCAL_TCX)
2390 direct_interners!('tcx,
2391 region: mk_region(|r: &RegionKind| r.keep_in_local_tcx()) -> RegionKind,
2392 goal: mk_goal(|c: &GoalKind<'_>| keep_local(c)) -> GoalKind<'tcx>,
2393 const_: mk_const(|c: &Const<'_>| keep_local(&c)) -> Const<'tcx>
2396 macro_rules! slice_interners {
2397 ($($field:ident: $method:ident($ty:ty)),+) => (
2398 $(intern_method!( 'tcx, $field: $method(
2400 |a, v| List::from_arena(a, v),
2402 |xs: &[$ty]| xs.iter().any(keep_local)) -> List<$ty>);)+
2407 existential_predicates: _intern_existential_predicates(ExistentialPredicate<'tcx>),
2408 predicates: _intern_predicates(Predicate<'tcx>),
2409 type_list: _intern_type_list(Ty<'tcx>),
2410 substs: _intern_substs(Kind<'tcx>),
2411 clauses: _intern_clauses(Clause<'tcx>),
2412 goal_list: _intern_goals(Goal<'tcx>),
2413 projs: _intern_projs(ProjectionKind)
2416 // This isn't a perfect fit: CanonicalVarInfo slices are always
2417 // allocated in the global arena, so this `intern_method!` macro is
2418 // overly general. But we just return false for the code that checks
2419 // whether they belong in the thread-local arena, so no harm done, and
2420 // seems better than open-coding the rest.
2423 canonical_var_infos: _intern_canonical_var_infos(
2424 &[CanonicalVarInfo],
2425 |a, v| List::from_arena(a, v),
2427 |_xs: &[CanonicalVarInfo]| -> bool { false }
2428 ) -> List<CanonicalVarInfo>
2431 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
2432 /// Given a `fn` type, returns an equivalent `unsafe fn` type;
2433 /// that is, a `fn` type that is equivalent in every way for being
2435 pub fn safe_to_unsafe_fn_ty(self, sig: PolyFnSig<'tcx>) -> Ty<'tcx> {
2436 assert_eq!(sig.unsafety(), hir::Unsafety::Normal);
2437 self.mk_fn_ptr(sig.map_bound(|sig| ty::FnSig {
2438 unsafety: hir::Unsafety::Unsafe,
2443 /// Given a closure signature `sig`, returns an equivalent `fn`
2444 /// type with the same signature. Detuples and so forth -- so
2445 /// e.g., if we have a sig with `Fn<(u32, i32)>` then you would get
2446 /// a `fn(u32, i32)`.
2447 /// `unsafety` determines the unsafety of the `fn` type. If you pass
2448 /// `hir::Unsafety::Unsafe` in the previous example, then you would get
2449 /// an `unsafe fn (u32, i32)`.
2450 /// It cannot convert a closure that requires unsafe.
2451 pub fn coerce_closure_fn_ty(self, sig: PolyFnSig<'tcx>, unsafety: hir::Unsafety) -> Ty<'tcx> {
2452 let converted_sig = sig.map_bound(|s| {
2453 let params_iter = match s.inputs()[0].sty {
2454 ty::Tuple(params) => {
2455 params.into_iter().map(|k| k.expect_ty())
2468 self.mk_fn_ptr(converted_sig)
2472 pub fn mk_ty(&self, st: TyKind<'tcx>) -> Ty<'tcx> {
2473 CtxtInterners::intern_ty(&self.interners, &self.global_interners, st)
2476 pub fn mk_mach_int(self, tm: ast::IntTy) -> Ty<'tcx> {
2478 ast::IntTy::Isize => self.types.isize,
2479 ast::IntTy::I8 => self.types.i8,
2480 ast::IntTy::I16 => self.types.i16,
2481 ast::IntTy::I32 => self.types.i32,
2482 ast::IntTy::I64 => self.types.i64,
2483 ast::IntTy::I128 => self.types.i128,
2487 pub fn mk_mach_uint(self, tm: ast::UintTy) -> Ty<'tcx> {
2489 ast::UintTy::Usize => self.types.usize,
2490 ast::UintTy::U8 => self.types.u8,
2491 ast::UintTy::U16 => self.types.u16,
2492 ast::UintTy::U32 => self.types.u32,
2493 ast::UintTy::U64 => self.types.u64,
2494 ast::UintTy::U128 => self.types.u128,
2498 pub fn mk_mach_float(self, tm: ast::FloatTy) -> Ty<'tcx> {
2500 ast::FloatTy::F32 => self.types.f32,
2501 ast::FloatTy::F64 => self.types.f64,
2506 pub fn mk_str(self) -> Ty<'tcx> {
2511 pub fn mk_static_str(self) -> Ty<'tcx> {
2512 self.mk_imm_ref(self.lifetimes.re_static, self.mk_str())
2516 pub fn mk_adt(self, def: &'tcx AdtDef, substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2517 // take a copy of substs so that we own the vectors inside
2518 self.mk_ty(Adt(def, substs))
2522 pub fn mk_foreign(self, def_id: DefId) -> Ty<'tcx> {
2523 self.mk_ty(Foreign(def_id))
2526 pub fn mk_box(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2527 let def_id = self.require_lang_item(lang_items::OwnedBoxLangItem);
2528 let adt_def = self.adt_def(def_id);
2529 let substs = InternalSubsts::for_item(self, def_id, |param, substs| {
2531 GenericParamDefKind::Lifetime |
2532 GenericParamDefKind::Const => {
2535 GenericParamDefKind::Type { has_default, .. } => {
2536 if param.index == 0 {
2539 assert!(has_default);
2540 self.type_of(param.def_id).subst(self, substs).into()
2545 self.mk_ty(Adt(adt_def, substs))
2549 pub fn mk_ptr(self, tm: TypeAndMut<'tcx>) -> Ty<'tcx> {
2550 self.mk_ty(RawPtr(tm))
2554 pub fn mk_ref(self, r: Region<'tcx>, tm: TypeAndMut<'tcx>) -> Ty<'tcx> {
2555 self.mk_ty(Ref(r, tm.ty, tm.mutbl))
2559 pub fn mk_mut_ref(self, r: Region<'tcx>, ty: Ty<'tcx>) -> Ty<'tcx> {
2560 self.mk_ref(r, TypeAndMut {ty: ty, mutbl: hir::MutMutable})
2564 pub fn mk_imm_ref(self, r: Region<'tcx>, ty: Ty<'tcx>) -> Ty<'tcx> {
2565 self.mk_ref(r, TypeAndMut {ty: ty, mutbl: hir::MutImmutable})
2569 pub fn mk_mut_ptr(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2570 self.mk_ptr(TypeAndMut {ty: ty, mutbl: hir::MutMutable})
2574 pub fn mk_imm_ptr(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2575 self.mk_ptr(TypeAndMut {ty: ty, mutbl: hir::MutImmutable})
2579 pub fn mk_nil_ptr(self) -> Ty<'tcx> {
2580 self.mk_imm_ptr(self.mk_unit())
2584 pub fn mk_array(self, ty: Ty<'tcx>, n: u64) -> Ty<'tcx> {
2585 self.mk_ty(Array(ty, self.mk_const(
2586 ty::Const::from_usize(self.global_tcx(), n)
2591 pub fn mk_slice(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2592 self.mk_ty(Slice(ty))
2596 pub fn intern_tup(self, ts: &[Ty<'tcx>]) -> Ty<'tcx> {
2597 let kinds: Vec<_> = ts.into_iter().map(|&t| Kind::from(t)).collect();
2598 self.mk_ty(Tuple(self.intern_substs(&kinds)))
2601 pub fn mk_tup<I: InternAs<[Ty<'tcx>], Ty<'tcx>>>(self, iter: I) -> I::Output {
2602 iter.intern_with(|ts| {
2603 let kinds: Vec<_> = ts.into_iter().map(|&t| Kind::from(t)).collect();
2604 self.mk_ty(Tuple(self.intern_substs(&kinds)))
2609 pub fn mk_unit(self) -> Ty<'tcx> {
2614 pub fn mk_diverging_default(self) -> Ty<'tcx> {
2615 if self.features().never_type {
2618 self.intern_tup(&[])
2623 pub fn mk_bool(self) -> Ty<'tcx> {
2628 pub fn mk_fn_def(self, def_id: DefId,
2629 substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2630 self.mk_ty(FnDef(def_id, substs))
2634 pub fn mk_fn_ptr(self, fty: PolyFnSig<'tcx>) -> Ty<'tcx> {
2635 self.mk_ty(FnPtr(fty))
2641 obj: ty::Binder<&'tcx List<ExistentialPredicate<'tcx>>>,
2642 reg: ty::Region<'tcx>
2644 self.mk_ty(Dynamic(obj, reg))
2648 pub fn mk_projection(self,
2650 substs: SubstsRef<'tcx>)
2652 self.mk_ty(Projection(ProjectionTy {
2659 pub fn mk_closure(self, closure_id: DefId, closure_substs: ClosureSubsts<'tcx>)
2661 self.mk_ty(Closure(closure_id, closure_substs))
2665 pub fn mk_generator(self,
2667 generator_substs: GeneratorSubsts<'tcx>,
2668 movability: hir::GeneratorMovability)
2670 self.mk_ty(Generator(id, generator_substs, movability))
2674 pub fn mk_generator_witness(self, types: ty::Binder<&'tcx List<Ty<'tcx>>>) -> Ty<'tcx> {
2675 self.mk_ty(GeneratorWitness(types))
2679 pub fn mk_ty_var(self, v: TyVid) -> Ty<'tcx> {
2680 self.mk_ty_infer(TyVar(v))
2684 pub fn mk_const_var(self, v: ConstVid<'tcx>, ty: Ty<'tcx>) -> &'tcx Const<'tcx> {
2685 self.mk_const(ty::Const {
2686 val: ConstValue::Infer(InferConst::Var(v)),
2692 pub fn mk_int_var(self, v: IntVid) -> Ty<'tcx> {
2693 self.mk_ty_infer(IntVar(v))
2697 pub fn mk_float_var(self, v: FloatVid) -> Ty<'tcx> {
2698 self.mk_ty_infer(FloatVar(v))
2702 pub fn mk_ty_infer(self, it: InferTy) -> Ty<'tcx> {
2703 self.mk_ty(Infer(it))
2707 pub fn mk_const_infer(
2709 ic: InferConst<'tcx>,
2711 ) -> &'tcx ty::Const<'tcx> {
2712 self.mk_const(ty::Const {
2713 val: ConstValue::Infer(ic),
2719 pub fn mk_ty_param(self, index: u32, name: InternedString) -> Ty<'tcx> {
2720 self.mk_ty(Param(ParamTy { index, name: name }))
2724 pub fn mk_const_param(
2727 name: InternedString,
2729 ) -> &'tcx Const<'tcx> {
2730 self.mk_const(ty::Const {
2731 val: ConstValue::Param(ParamConst { index, name }),
2737 pub fn mk_self_type(self) -> Ty<'tcx> {
2738 self.mk_ty_param(0, kw::SelfUpper.as_interned_str())
2741 pub fn mk_param_from_def(self, param: &ty::GenericParamDef) -> Kind<'tcx> {
2743 GenericParamDefKind::Lifetime => {
2744 self.mk_region(ty::ReEarlyBound(param.to_early_bound_region_data())).into()
2746 GenericParamDefKind::Type { .. } => self.mk_ty_param(param.index, param.name).into(),
2747 GenericParamDefKind::Const => {
2748 self.mk_const_param(param.index, param.name, self.type_of(param.def_id)).into()
2754 pub fn mk_opaque(self, def_id: DefId, substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2755 self.mk_ty(Opaque(def_id, substs))
2758 pub fn intern_existential_predicates(self, eps: &[ExistentialPredicate<'tcx>])
2759 -> &'tcx List<ExistentialPredicate<'tcx>> {
2760 assert!(!eps.is_empty());
2761 assert!(eps.windows(2).all(|w| w[0].stable_cmp(self, &w[1]) != Ordering::Greater));
2762 self._intern_existential_predicates(eps)
2765 pub fn intern_predicates(self, preds: &[Predicate<'tcx>])
2766 -> &'tcx List<Predicate<'tcx>> {
2767 // FIXME consider asking the input slice to be sorted to avoid
2768 // re-interning permutations, in which case that would be asserted
2770 if preds.len() == 0 {
2771 // The macro-generated method below asserts we don't intern an empty slice.
2774 self._intern_predicates(preds)
2778 pub fn intern_type_list(self, ts: &[Ty<'tcx>]) -> &'tcx List<Ty<'tcx>> {
2782 self._intern_type_list(ts)
2786 pub fn intern_substs(self, ts: &[Kind<'tcx>]) -> &'tcx List<Kind<'tcx>> {
2790 self._intern_substs(ts)
2794 pub fn intern_projs(self, ps: &[ProjectionKind]) -> &'tcx List<ProjectionKind> {
2798 self._intern_projs(ps)
2802 pub fn intern_canonical_var_infos(self, ts: &[CanonicalVarInfo]) -> CanonicalVarInfos<'gcx> {
2806 self.global_tcx()._intern_canonical_var_infos(ts)
2810 pub fn intern_clauses(self, ts: &[Clause<'tcx>]) -> Clauses<'tcx> {
2814 self._intern_clauses(ts)
2818 pub fn intern_goals(self, ts: &[Goal<'tcx>]) -> Goals<'tcx> {
2822 self._intern_goals(ts)
2826 pub fn mk_fn_sig<I>(self,
2830 unsafety: hir::Unsafety,
2832 -> <I::Item as InternIteratorElement<Ty<'tcx>, ty::FnSig<'tcx>>>::Output
2834 I::Item: InternIteratorElement<Ty<'tcx>, ty::FnSig<'tcx>>
2836 inputs.chain(iter::once(output)).intern_with(|xs| ty::FnSig {
2837 inputs_and_output: self.intern_type_list(xs),
2838 c_variadic, unsafety, abi
2842 pub fn mk_existential_predicates<I: InternAs<[ExistentialPredicate<'tcx>],
2843 &'tcx List<ExistentialPredicate<'tcx>>>>(self, iter: I)
2845 iter.intern_with(|xs| self.intern_existential_predicates(xs))
2848 pub fn mk_predicates<I: InternAs<[Predicate<'tcx>],
2849 &'tcx List<Predicate<'tcx>>>>(self, iter: I)
2851 iter.intern_with(|xs| self.intern_predicates(xs))
2854 pub fn mk_type_list<I: InternAs<[Ty<'tcx>],
2855 &'tcx List<Ty<'tcx>>>>(self, iter: I) -> I::Output {
2856 iter.intern_with(|xs| self.intern_type_list(xs))
2859 pub fn mk_substs<I: InternAs<[Kind<'tcx>],
2860 &'tcx List<Kind<'tcx>>>>(self, iter: I) -> I::Output {
2861 iter.intern_with(|xs| self.intern_substs(xs))
2864 pub fn mk_substs_trait(self,
2866 rest: &[Kind<'tcx>])
2869 self.mk_substs(iter::once(self_ty.into()).chain(rest.iter().cloned()))
2872 pub fn mk_clauses<I: InternAs<[Clause<'tcx>], Clauses<'tcx>>>(self, iter: I) -> I::Output {
2873 iter.intern_with(|xs| self.intern_clauses(xs))
2876 pub fn mk_goals<I: InternAs<[Goal<'tcx>], Goals<'tcx>>>(self, iter: I) -> I::Output {
2877 iter.intern_with(|xs| self.intern_goals(xs))
2880 pub fn lint_hir<S: Into<MultiSpan>>(self,
2881 lint: &'static Lint,
2885 self.struct_span_lint_hir(lint, hir_id, span.into(), msg).emit()
2888 pub fn lint_hir_note<S: Into<MultiSpan>>(self,
2889 lint: &'static Lint,
2894 let mut err = self.struct_span_lint_hir(lint, hir_id, span.into(), msg);
2899 pub fn lint_node_note<S: Into<MultiSpan>>(self,
2900 lint: &'static Lint,
2905 let mut err = self.struct_span_lint_hir(lint, id, span.into(), msg);
2910 /// Walks upwards from `id` to find a node which might change lint levels with attributes.
2911 /// It stops at `bound` and just returns it if reached.
2912 pub fn maybe_lint_level_root_bounded(
2921 if lint::maybe_lint_level_root(self, id) {
2924 let next = self.hir().get_parent_node_by_hir_id(id);
2926 bug!("lint traversal reached the root of the crate");
2932 pub fn lint_level_at_node(
2934 lint: &'static Lint,
2936 ) -> (lint::Level, lint::LintSource) {
2937 let sets = self.lint_levels(LOCAL_CRATE);
2939 if let Some(pair) = sets.level_and_source(lint, id, self.sess) {
2942 let next = self.hir().get_parent_node_by_hir_id(id);
2944 bug!("lint traversal reached the root of the crate");
2950 pub fn struct_span_lint_hir<S: Into<MultiSpan>>(self,
2951 lint: &'static Lint,
2955 -> DiagnosticBuilder<'tcx>
2957 let (level, src) = self.lint_level_at_node(lint, hir_id);
2958 lint::struct_lint_level(self.sess, lint, level, src, Some(span.into()), msg)
2961 pub fn struct_lint_node(self, lint: &'static Lint, id: HirId, msg: &str)
2962 -> DiagnosticBuilder<'tcx>
2964 let (level, src) = self.lint_level_at_node(lint, id);
2965 lint::struct_lint_level(self.sess, lint, level, src, None, msg)
2968 pub fn in_scope_traits(self, id: HirId) -> Option<Lrc<StableVec<TraitCandidate>>> {
2969 self.in_scope_traits_map(id.owner)
2970 .and_then(|map| map.get(&id.local_id).cloned())
2973 pub fn named_region(self, id: HirId) -> Option<resolve_lifetime::Region> {
2974 self.named_region_map(id.owner)
2975 .and_then(|map| map.get(&id.local_id).cloned())
2978 pub fn is_late_bound(self, id: HirId) -> bool {
2979 self.is_late_bound_map(id.owner)
2980 .map(|set| set.contains(&id.local_id))
2984 pub fn object_lifetime_defaults(self, id: HirId)
2985 -> Option<Lrc<Vec<ObjectLifetimeDefault>>>
2987 self.object_lifetime_defaults_map(id.owner)
2988 .and_then(|map| map.get(&id.local_id).cloned())
2992 pub trait InternAs<T: ?Sized, R> {
2994 fn intern_with<F>(self, f: F) -> Self::Output
2995 where F: FnOnce(&T) -> R;
2998 impl<I, T, R, E> InternAs<[T], R> for I
2999 where E: InternIteratorElement<T, R>,
3000 I: Iterator<Item=E> {
3001 type Output = E::Output;
3002 fn intern_with<F>(self, f: F) -> Self::Output
3003 where F: FnOnce(&[T]) -> R {
3004 E::intern_with(self, f)
3008 pub trait InternIteratorElement<T, R>: Sized {
3010 fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output;
3013 impl<T, R> InternIteratorElement<T, R> for T {
3015 fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output {
3016 f(&iter.collect::<SmallVec<[_; 8]>>())
3020 impl<'a, T, R> InternIteratorElement<T, R> for &'a T
3024 fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output {
3025 f(&iter.cloned().collect::<SmallVec<[_; 8]>>())
3029 impl<T, R, E> InternIteratorElement<T, R> for Result<T, E> {
3030 type Output = Result<R, E>;
3031 fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output {
3032 Ok(f(&iter.collect::<Result<SmallVec<[_; 8]>, _>>()?))
3036 // We are comparing types with different invariant lifetimes, so `ptr::eq`
3037 // won't work for us.
3038 fn ptr_eq<T, U>(t: *const T, u: *const U) -> bool {
3039 t as *const () == u as *const ()
3042 pub fn provide(providers: &mut ty::query::Providers<'_>) {
3043 providers.in_scope_traits_map = |tcx, id| tcx.gcx.trait_map.get(&id).cloned();
3044 providers.module_exports = |tcx, id| tcx.gcx.export_map.get(&id).cloned();
3045 providers.crate_name = |tcx, id| {
3046 assert_eq!(id, LOCAL_CRATE);
3049 providers.get_lib_features = |tcx, id| {
3050 assert_eq!(id, LOCAL_CRATE);
3051 Lrc::new(middle::lib_features::collect(tcx))
3053 providers.get_lang_items = |tcx, id| {
3054 assert_eq!(id, LOCAL_CRATE);
3055 Lrc::new(middle::lang_items::collect(tcx))
3057 providers.upvars = |tcx, id| tcx.gcx.upvars.get(&id).cloned();
3058 providers.maybe_unused_trait_import = |tcx, id| {
3059 tcx.maybe_unused_trait_imports.contains(&id)
3061 providers.maybe_unused_extern_crates = |tcx, cnum| {
3062 assert_eq!(cnum, LOCAL_CRATE);
3063 Lrc::new(tcx.maybe_unused_extern_crates.clone())
3065 providers.names_imported_by_glob_use = |tcx, id| {
3066 assert_eq!(id.krate, LOCAL_CRATE);
3067 Lrc::new(tcx.glob_map.get(&id).cloned().unwrap_or_default())
3070 providers.stability_index = |tcx, cnum| {
3071 assert_eq!(cnum, LOCAL_CRATE);
3072 Lrc::new(stability::Index::new(tcx))
3074 providers.lookup_stability = |tcx, id| {
3075 assert_eq!(id.krate, LOCAL_CRATE);
3076 let id = tcx.hir().definitions().def_index_to_hir_id(id.index);
3077 tcx.stability().local_stability(id)
3079 providers.lookup_deprecation_entry = |tcx, id| {
3080 assert_eq!(id.krate, LOCAL_CRATE);
3081 let id = tcx.hir().definitions().def_index_to_hir_id(id.index);
3082 tcx.stability().local_deprecation_entry(id)
3084 providers.extern_mod_stmt_cnum = |tcx, id| {
3085 let id = tcx.hir().as_local_node_id(id).unwrap();
3086 tcx.cstore.extern_mod_stmt_cnum_untracked(id)
3088 providers.all_crate_nums = |tcx, cnum| {
3089 assert_eq!(cnum, LOCAL_CRATE);
3090 Lrc::new(tcx.cstore.crates_untracked())
3092 providers.postorder_cnums = |tcx, cnum| {
3093 assert_eq!(cnum, LOCAL_CRATE);
3094 Lrc::new(tcx.cstore.postorder_cnums_untracked())
3096 providers.output_filenames = |tcx, cnum| {
3097 assert_eq!(cnum, LOCAL_CRATE);
3098 tcx.output_filenames.clone()
3100 providers.features_query = |tcx, cnum| {
3101 assert_eq!(cnum, LOCAL_CRATE);
3102 Lrc::new(tcx.sess.features_untracked().clone())
3104 providers.is_panic_runtime = |tcx, cnum| {
3105 assert_eq!(cnum, LOCAL_CRATE);
3106 attr::contains_name(tcx.hir().krate_attrs(), sym::panic_runtime)
3108 providers.is_compiler_builtins = |tcx, cnum| {
3109 assert_eq!(cnum, LOCAL_CRATE);
3110 attr::contains_name(tcx.hir().krate_attrs(), sym::compiler_builtins)