1 //! Type context book-keeping.
3 use crate::arena::Arena;
4 use crate::dep_graph::{DepGraph, DepKind, DepKindStruct};
5 use crate::hir::place::Place as HirPlace;
6 use crate::infer::canonical::{Canonical, CanonicalVarInfo, CanonicalVarInfos};
7 use crate::lint::{struct_lint_level, LintDiagnosticBuilder, LintLevelSource};
8 use crate::middle::resolve_lifetime::{self, LifetimeScopeForPath};
9 use crate::middle::stability;
10 use crate::mir::interpret::{self, Allocation, ConstValue, Scalar};
12 Body, BorrowCheckResult, Field, Local, Place, PlaceElem, ProjectionKind, Promoted,
14 use crate::thir::Thir;
16 use crate::ty::query::{self, TyCtxtAt};
17 use crate::ty::subst::{GenericArg, GenericArgKind, InternalSubsts, Subst, SubstsRef, UserSubsts};
18 use crate::ty::TyKind::*;
20 self, AdtDef, AdtKind, Binder, BindingMode, BoundVar, CanonicalPolyFnSig,
21 ClosureSizeProfileData, Const, ConstS, ConstVid, DefIdTree, ExistentialPredicate, FloatTy,
22 FloatVar, FloatVid, GenericParamDefKind, InferConst, InferTy, IntTy, IntVar, IntVid, List,
23 ParamConst, ParamTy, PolyFnSig, Predicate, PredicateKind, PredicateS, ProjectionTy, Region,
24 RegionKind, ReprOptions, TraitObjectVisitor, Ty, TyKind, TyS, TyVar, TyVid, TypeAndMut, UintTy,
27 use rustc_attr as attr;
28 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
29 use rustc_data_structures::intern::Interned;
30 use rustc_data_structures::memmap::Mmap;
31 use rustc_data_structures::profiling::SelfProfilerRef;
32 use rustc_data_structures::sharded::{IntoPointer, ShardedHashMap};
33 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
34 use rustc_data_structures::steal::Steal;
35 use rustc_data_structures::sync::{self, Lock, Lrc, WorkerLocal};
36 use rustc_errors::ErrorReported;
38 use rustc_hir::def::{DefKind, Res};
39 use rustc_hir::def_id::{CrateNum, DefId, DefIdMap, LocalDefId, LOCAL_CRATE};
40 use rustc_hir::intravisit::Visitor;
41 use rustc_hir::lang_items::LangItem;
43 Constness, ExprKind, HirId, ImplItemKind, ItemKind, ItemLocalId, ItemLocalMap, ItemLocalSet,
44 Node, TraitCandidate, TraitItemKind,
46 use rustc_index::vec::{Idx, IndexVec};
47 use rustc_macros::HashStable;
48 use rustc_middle::mir::FakeReadCause;
49 use rustc_query_system::ich::{NodeIdHashingMode, StableHashingContext};
50 use rustc_serialize::opaque::{FileEncodeResult, FileEncoder};
51 use rustc_session::config::{BorrowckMode, CrateType, OutputFilenames};
52 use rustc_session::lint::{Level, Lint};
53 use rustc_session::Limit;
54 use rustc_session::Session;
55 use rustc_span::def_id::{DefPathHash, StableCrateId};
56 use rustc_span::source_map::{MultiSpan, SourceMap};
57 use rustc_span::symbol::{kw, sym, Ident, Symbol};
58 use rustc_span::{Span, DUMMY_SP};
59 use rustc_target::abi::{Layout, TargetDataLayout, VariantIdx};
60 use rustc_target::spec::abi;
62 use smallvec::SmallVec;
64 use std::borrow::Borrow;
65 use std::cmp::Ordering;
66 use std::collections::hash_map::{self, Entry};
68 use std::hash::{Hash, Hasher};
71 use std::ops::{Bound, Deref};
74 pub trait OnDiskCache<'tcx>: rustc_data_structures::sync::Sync {
75 /// Creates a new `OnDiskCache` instance from the serialized data in `data`.
76 fn new(sess: &'tcx Session, data: Mmap, start_pos: usize) -> Self
80 fn new_empty(source_map: &'tcx SourceMap) -> Self
84 fn drop_serialized_data(&self, tcx: TyCtxt<'tcx>);
86 fn serialize(&self, tcx: TyCtxt<'tcx>, encoder: &mut FileEncoder) -> FileEncodeResult;
89 /// A type that is not publicly constructable. This prevents people from making [`TyKind::Error`]s
90 /// except through the error-reporting functions on a [`tcx`][TyCtxt].
91 #[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
92 #[derive(TyEncodable, TyDecodable, HashStable)]
93 pub struct DelaySpanBugEmitted(());
95 type InternedSet<'tcx, T> = ShardedHashMap<InternedInSet<'tcx, T>, ()>;
97 pub struct CtxtInterners<'tcx> {
98 /// The arena that types, regions, etc. are allocated from.
99 arena: &'tcx WorkerLocal<Arena<'tcx>>,
101 // Specifically use a speedy hash algorithm for these hash sets, since
102 // they're accessed quite often.
103 type_: InternedSet<'tcx, TyS<'tcx>>,
104 substs: InternedSet<'tcx, InternalSubsts<'tcx>>,
105 canonical_var_infos: InternedSet<'tcx, List<CanonicalVarInfo<'tcx>>>,
106 region: InternedSet<'tcx, RegionKind>,
107 poly_existential_predicates:
108 InternedSet<'tcx, List<ty::Binder<'tcx, ExistentialPredicate<'tcx>>>>,
109 predicate: InternedSet<'tcx, PredicateS<'tcx>>,
110 predicates: InternedSet<'tcx, List<Predicate<'tcx>>>,
111 projs: InternedSet<'tcx, List<ProjectionKind>>,
112 place_elems: InternedSet<'tcx, List<PlaceElem<'tcx>>>,
113 const_: InternedSet<'tcx, ConstS<'tcx>>,
114 const_allocation: InternedSet<'tcx, Allocation>,
115 bound_variable_kinds: InternedSet<'tcx, List<ty::BoundVariableKind>>,
116 layout: InternedSet<'tcx, Layout>,
117 adt_def: InternedSet<'tcx, AdtDef>,
119 /// `#[stable]` and `#[unstable]` attributes
120 stability: InternedSet<'tcx, attr::Stability>,
122 /// `#[rustc_const_stable]` and `#[rustc_const_unstable]` attributes
123 const_stability: InternedSet<'tcx, attr::ConstStability>,
126 impl<'tcx> CtxtInterners<'tcx> {
127 fn new(arena: &'tcx WorkerLocal<Arena<'tcx>>) -> CtxtInterners<'tcx> {
130 type_: Default::default(),
131 substs: Default::default(),
132 region: Default::default(),
133 poly_existential_predicates: Default::default(),
134 canonical_var_infos: Default::default(),
135 predicate: Default::default(),
136 predicates: Default::default(),
137 projs: Default::default(),
138 place_elems: Default::default(),
139 const_: Default::default(),
140 const_allocation: Default::default(),
141 bound_variable_kinds: Default::default(),
142 layout: Default::default(),
143 adt_def: Default::default(),
144 stability: Default::default(),
145 const_stability: Default::default(),
150 #[allow(rustc::usage_of_ty_tykind)]
152 fn intern_ty(&self, kind: TyKind<'tcx>) -> Ty<'tcx> {
153 Ty(Interned::new_unchecked(
155 .intern(kind, |kind| {
156 let flags = super::flags::FlagComputation::for_kind(&kind);
158 let ty_struct = TyS {
161 outer_exclusive_binder: flags.outer_exclusive_binder,
164 InternedInSet(self.arena.alloc(ty_struct))
171 fn intern_predicate(&self, kind: Binder<'tcx, PredicateKind<'tcx>>) -> Predicate<'tcx> {
172 Predicate(Interned::new_unchecked(
174 .intern(kind, |kind| {
175 let flags = super::flags::FlagComputation::for_predicate(kind);
177 let predicate_struct = PredicateS {
180 outer_exclusive_binder: flags.outer_exclusive_binder,
183 InternedInSet(self.arena.alloc(predicate_struct))
190 pub struct CommonTypes<'tcx> {
210 pub self_param: Ty<'tcx>,
212 /// Dummy type used for the `Self` of a `TraitRef` created for converting
213 /// a trait object, and which gets removed in `ExistentialTraitRef`.
214 /// This type must not appear anywhere in other converted types.
215 pub trait_object_dummy_self: Ty<'tcx>,
218 pub struct CommonLifetimes<'tcx> {
219 /// `ReEmpty` in the root universe.
220 pub re_root_empty: Region<'tcx>,
223 pub re_static: Region<'tcx>,
225 /// Erased region, used outside of type inference.
226 pub re_erased: Region<'tcx>,
229 pub struct CommonConsts<'tcx> {
230 pub unit: Const<'tcx>,
233 pub struct LocalTableInContext<'a, V> {
234 hir_owner: LocalDefId,
235 data: &'a ItemLocalMap<V>,
238 /// Validate that the given HirId (respectively its `local_id` part) can be
239 /// safely used as a key in the maps of a TypeckResults. For that to be
240 /// the case, the HirId must have the same `owner` as all the other IDs in
241 /// this table (signified by `hir_owner`). Otherwise the HirId
242 /// would be in a different frame of reference and using its `local_id`
243 /// would result in lookup errors, or worse, in silently wrong data being
246 fn validate_hir_id_for_typeck_results(hir_owner: LocalDefId, hir_id: hir::HirId) {
247 if hir_id.owner != hir_owner {
248 invalid_hir_id_for_typeck_results(hir_owner, hir_id);
254 fn invalid_hir_id_for_typeck_results(hir_owner: LocalDefId, hir_id: hir::HirId) {
255 ty::tls::with(|tcx| {
257 "node {} with HirId::owner {:?} cannot be placed in TypeckResults with hir_owner {:?}",
258 tcx.hir().node_to_string(hir_id),
265 impl<'a, V> LocalTableInContext<'a, V> {
266 pub fn contains_key(&self, id: hir::HirId) -> bool {
267 validate_hir_id_for_typeck_results(self.hir_owner, id);
268 self.data.contains_key(&id.local_id)
271 pub fn get(&self, id: hir::HirId) -> Option<&V> {
272 validate_hir_id_for_typeck_results(self.hir_owner, id);
273 self.data.get(&id.local_id)
276 pub fn iter(&self) -> hash_map::Iter<'_, hir::ItemLocalId, V> {
281 impl<'a, V> ::std::ops::Index<hir::HirId> for LocalTableInContext<'a, V> {
284 fn index(&self, key: hir::HirId) -> &V {
285 self.get(key).expect("LocalTableInContext: key not found")
289 pub struct LocalTableInContextMut<'a, V> {
290 hir_owner: LocalDefId,
291 data: &'a mut ItemLocalMap<V>,
294 impl<'a, V> LocalTableInContextMut<'a, V> {
295 pub fn get_mut(&mut self, id: hir::HirId) -> Option<&mut V> {
296 validate_hir_id_for_typeck_results(self.hir_owner, id);
297 self.data.get_mut(&id.local_id)
300 pub fn entry(&mut self, id: hir::HirId) -> Entry<'_, hir::ItemLocalId, V> {
301 validate_hir_id_for_typeck_results(self.hir_owner, id);
302 self.data.entry(id.local_id)
305 pub fn insert(&mut self, id: hir::HirId, val: V) -> Option<V> {
306 validate_hir_id_for_typeck_results(self.hir_owner, id);
307 self.data.insert(id.local_id, val)
310 pub fn remove(&mut self, id: hir::HirId) -> Option<V> {
311 validate_hir_id_for_typeck_results(self.hir_owner, id);
312 self.data.remove(&id.local_id)
316 /// Whenever a value may be live across a generator yield, the type of that value winds up in the
317 /// `GeneratorInteriorTypeCause` struct. This struct adds additional information about such
318 /// captured types that can be useful for diagnostics. In particular, it stores the span that
319 /// caused a given type to be recorded, along with the scope that enclosed the value (which can
320 /// be used to find the await that the value is live across).
324 /// ```ignore (pseudo-Rust)
332 /// Here, we would store the type `T`, the span of the value `x`, the "scope-span" for
333 /// the scope that contains `x`, the expr `T` evaluated from, and the span of `foo.await`.
334 #[derive(TyEncodable, TyDecodable, Clone, Debug, Eq, Hash, PartialEq, HashStable)]
335 #[derive(TypeFoldable)]
336 pub struct GeneratorInteriorTypeCause<'tcx> {
337 /// Type of the captured binding.
339 /// Span of the binding that was captured.
341 /// Span of the scope of the captured binding.
342 pub scope_span: Option<Span>,
343 /// Span of `.await` or `yield` expression.
344 pub yield_span: Span,
345 /// Expr which the type evaluated from.
346 pub expr: Option<hir::HirId>,
349 #[derive(TyEncodable, TyDecodable, Debug)]
350 pub struct TypeckResults<'tcx> {
351 /// The `HirId::owner` all `ItemLocalId`s in this table are relative to.
352 pub hir_owner: LocalDefId,
354 /// Resolved definitions for `<T>::X` associated paths and
355 /// method calls, including those of overloaded operators.
356 type_dependent_defs: ItemLocalMap<Result<(DefKind, DefId), ErrorReported>>,
358 /// Resolved field indices for field accesses in expressions (`S { field }`, `obj.field`)
359 /// or patterns (`S { field }`). The index is often useful by itself, but to learn more
360 /// about the field you also need definition of the variant to which the field
361 /// belongs, but it may not exist if it's a tuple field (`tuple.0`).
362 field_indices: ItemLocalMap<usize>,
364 /// Stores the types for various nodes in the AST. Note that this table
365 /// is not guaranteed to be populated outside inference. See
366 /// typeck::check::fn_ctxt for details.
367 node_types: ItemLocalMap<Ty<'tcx>>,
369 /// Stores the type parameters which were substituted to obtain the type
370 /// of this node. This only applies to nodes that refer to entities
371 /// parameterized by type parameters, such as generic fns, types, or
373 node_substs: ItemLocalMap<SubstsRef<'tcx>>,
375 /// This will either store the canonicalized types provided by the user
376 /// or the substitutions that the user explicitly gave (if any) attached
377 /// to `id`. These will not include any inferred values. The canonical form
378 /// is used to capture things like `_` or other unspecified values.
380 /// For example, if the user wrote `foo.collect::<Vec<_>>()`, then the
381 /// canonical substitutions would include only `for<X> { Vec<X> }`.
383 /// See also `AscribeUserType` statement in MIR.
384 user_provided_types: ItemLocalMap<CanonicalUserType<'tcx>>,
386 /// Stores the canonicalized types provided by the user. See also
387 /// `AscribeUserType` statement in MIR.
388 pub user_provided_sigs: DefIdMap<CanonicalPolyFnSig<'tcx>>,
390 adjustments: ItemLocalMap<Vec<ty::adjustment::Adjustment<'tcx>>>,
392 /// Stores the actual binding mode for all instances of hir::BindingAnnotation.
393 pat_binding_modes: ItemLocalMap<BindingMode>,
395 /// Stores the types which were implicitly dereferenced in pattern binding modes
396 /// for later usage in THIR lowering. For example,
399 /// match &&Some(5i32) {
404 /// leads to a `vec![&&Option<i32>, &Option<i32>]`. Empty vectors are not stored.
407 /// <https://github.com/rust-lang/rfcs/blob/master/text/2005-match-ergonomics.md#definitions>
408 pat_adjustments: ItemLocalMap<Vec<Ty<'tcx>>>,
410 /// Records the reasons that we picked the kind of each closure;
411 /// not all closures are present in the map.
412 closure_kind_origins: ItemLocalMap<(Span, HirPlace<'tcx>)>,
414 /// For each fn, records the "liberated" types of its arguments
415 /// and return type. Liberated means that all bound regions
416 /// (including late-bound regions) are replaced with free
417 /// equivalents. This table is not used in codegen (since regions
418 /// are erased there) and hence is not serialized to metadata.
420 /// This table also contains the "revealed" values for any `impl Trait`
421 /// that appear in the signature and whose values are being inferred
422 /// by this function.
427 /// fn foo(x: &u32) -> impl Debug { *x }
430 /// The function signature here would be:
433 /// for<'a> fn(&'a u32) -> Foo
436 /// where `Foo` is an opaque type created for this function.
439 /// The *liberated* form of this would be
442 /// fn(&'a u32) -> u32
445 /// Note that `'a` is not bound (it would be an `ReFree`) and
446 /// that the `Foo` opaque type is replaced by its hidden type.
447 liberated_fn_sigs: ItemLocalMap<ty::FnSig<'tcx>>,
449 /// For each FRU expression, record the normalized types of the fields
450 /// of the struct - this is needed because it is non-trivial to
451 /// normalize while preserving regions. This table is used only in
452 /// MIR construction and hence is not serialized to metadata.
453 fru_field_types: ItemLocalMap<Vec<Ty<'tcx>>>,
455 /// For every coercion cast we add the HIR node ID of the cast
456 /// expression to this set.
457 coercion_casts: ItemLocalSet,
459 /// Set of trait imports actually used in the method resolution.
460 /// This is used for warning unused imports. During type
461 /// checking, this `Lrc` should not be cloned: it must have a ref-count
462 /// of 1 so that we can insert things into the set mutably.
463 pub used_trait_imports: Lrc<FxHashSet<LocalDefId>>,
465 /// If any errors occurred while type-checking this body,
466 /// this field will be set to `Some(ErrorReported)`.
467 pub tainted_by_errors: Option<ErrorReported>,
469 /// All the opaque types that are restricted to concrete types
470 /// by this function.
471 pub concrete_opaque_types: FxHashSet<DefId>,
473 /// Tracks the minimum captures required for a closure;
474 /// see `MinCaptureInformationMap` for more details.
475 pub closure_min_captures: ty::MinCaptureInformationMap<'tcx>,
477 /// Tracks the fake reads required for a closure and the reason for the fake read.
478 /// When performing pattern matching for closures, there are times we don't end up
479 /// reading places that are mentioned in a closure (because of _ patterns). However,
480 /// to ensure the places are initialized, we introduce fake reads.
481 /// Consider these two examples:
482 /// ``` (discriminant matching with only wildcard arm)
484 /// let c = || match x { _ => () };
486 /// In this example, we don't need to actually read/borrow `x` in `c`, and so we don't
487 /// want to capture it. However, we do still want an error here, because `x` should have
488 /// to be initialized at the point where c is created. Therefore, we add a "fake read"
490 /// ``` (destructured assignments)
492 /// let (t1, t2) = t;
495 /// In the second example, we capture the disjoint fields of `t` (`t.0` & `t.1`), but
496 /// we never capture `t`. This becomes an issue when we build MIR as we require
497 /// information on `t` in order to create place `t.0` and `t.1`. We can solve this
498 /// issue by fake reading `t`.
499 pub closure_fake_reads: FxHashMap<DefId, Vec<(HirPlace<'tcx>, FakeReadCause, hir::HirId)>>,
501 /// Stores the type, expression, span and optional scope span of all types
502 /// that are live across the yield of this generator (if a generator).
503 pub generator_interior_types: ty::Binder<'tcx, Vec<GeneratorInteriorTypeCause<'tcx>>>,
505 /// We sometimes treat byte string literals (which are of type `&[u8; N]`)
506 /// as `&[u8]`, depending on the pattern in which they are used.
507 /// This hashset records all instances where we behave
508 /// like this to allow `const_to_pat` to reliably handle this situation.
509 pub treat_byte_string_as_slice: ItemLocalSet,
511 /// Contains the data for evaluating the effect of feature `capture_disjoint_fields`
513 pub closure_size_eval: FxHashMap<DefId, ClosureSizeProfileData<'tcx>>,
516 impl<'tcx> TypeckResults<'tcx> {
517 pub fn new(hir_owner: LocalDefId) -> TypeckResults<'tcx> {
520 type_dependent_defs: Default::default(),
521 field_indices: Default::default(),
522 user_provided_types: Default::default(),
523 user_provided_sigs: Default::default(),
524 node_types: Default::default(),
525 node_substs: Default::default(),
526 adjustments: Default::default(),
527 pat_binding_modes: Default::default(),
528 pat_adjustments: Default::default(),
529 closure_kind_origins: Default::default(),
530 liberated_fn_sigs: Default::default(),
531 fru_field_types: Default::default(),
532 coercion_casts: Default::default(),
533 used_trait_imports: Lrc::new(Default::default()),
534 tainted_by_errors: None,
535 concrete_opaque_types: Default::default(),
536 closure_min_captures: Default::default(),
537 closure_fake_reads: Default::default(),
538 generator_interior_types: ty::Binder::dummy(Default::default()),
539 treat_byte_string_as_slice: Default::default(),
540 closure_size_eval: Default::default(),
544 /// Returns the final resolution of a `QPath` in an `Expr` or `Pat` node.
545 pub fn qpath_res(&self, qpath: &hir::QPath<'_>, id: hir::HirId) -> Res {
547 hir::QPath::Resolved(_, ref path) => path.res,
548 hir::QPath::TypeRelative(..) | hir::QPath::LangItem(..) => self
549 .type_dependent_def(id)
550 .map_or(Res::Err, |(kind, def_id)| Res::Def(kind, def_id)),
554 pub fn type_dependent_defs(
556 ) -> LocalTableInContext<'_, Result<(DefKind, DefId), ErrorReported>> {
557 LocalTableInContext { hir_owner: self.hir_owner, data: &self.type_dependent_defs }
560 pub fn type_dependent_def(&self, id: HirId) -> Option<(DefKind, DefId)> {
561 validate_hir_id_for_typeck_results(self.hir_owner, id);
562 self.type_dependent_defs.get(&id.local_id).cloned().and_then(|r| r.ok())
565 pub fn type_dependent_def_id(&self, id: HirId) -> Option<DefId> {
566 self.type_dependent_def(id).map(|(_, def_id)| def_id)
569 pub fn type_dependent_defs_mut(
571 ) -> LocalTableInContextMut<'_, Result<(DefKind, DefId), ErrorReported>> {
572 LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.type_dependent_defs }
575 pub fn field_indices(&self) -> LocalTableInContext<'_, usize> {
576 LocalTableInContext { hir_owner: self.hir_owner, data: &self.field_indices }
579 pub fn field_indices_mut(&mut self) -> LocalTableInContextMut<'_, usize> {
580 LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.field_indices }
583 pub fn user_provided_types(&self) -> LocalTableInContext<'_, CanonicalUserType<'tcx>> {
584 LocalTableInContext { hir_owner: self.hir_owner, data: &self.user_provided_types }
587 pub fn user_provided_types_mut(
589 ) -> LocalTableInContextMut<'_, CanonicalUserType<'tcx>> {
590 LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.user_provided_types }
593 pub fn node_types(&self) -> LocalTableInContext<'_, Ty<'tcx>> {
594 LocalTableInContext { hir_owner: self.hir_owner, data: &self.node_types }
597 pub fn node_types_mut(&mut self) -> LocalTableInContextMut<'_, Ty<'tcx>> {
598 LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.node_types }
601 pub fn node_type(&self, id: hir::HirId) -> Ty<'tcx> {
602 self.node_type_opt(id).unwrap_or_else(|| {
603 bug!("node_type: no type for node `{}`", tls::with(|tcx| tcx.hir().node_to_string(id)))
607 pub fn node_type_opt(&self, id: hir::HirId) -> Option<Ty<'tcx>> {
608 validate_hir_id_for_typeck_results(self.hir_owner, id);
609 self.node_types.get(&id.local_id).cloned()
612 pub fn node_substs_mut(&mut self) -> LocalTableInContextMut<'_, SubstsRef<'tcx>> {
613 LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.node_substs }
616 pub fn node_substs(&self, id: hir::HirId) -> SubstsRef<'tcx> {
617 validate_hir_id_for_typeck_results(self.hir_owner, id);
618 self.node_substs.get(&id.local_id).cloned().unwrap_or_else(|| InternalSubsts::empty())
621 pub fn node_substs_opt(&self, id: hir::HirId) -> Option<SubstsRef<'tcx>> {
622 validate_hir_id_for_typeck_results(self.hir_owner, id);
623 self.node_substs.get(&id.local_id).cloned()
626 // Returns the type of a pattern as a monotype. Like @expr_ty, this function
627 // doesn't provide type parameter substitutions.
628 pub fn pat_ty(&self, pat: &hir::Pat<'_>) -> Ty<'tcx> {
629 self.node_type(pat.hir_id)
632 // Returns the type of an expression as a monotype.
634 // NB (1): This is the PRE-ADJUSTMENT TYPE for the expression. That is, in
635 // some cases, we insert `Adjustment` annotations such as auto-deref or
636 // auto-ref. The type returned by this function does not consider such
637 // adjustments. See `expr_ty_adjusted()` instead.
639 // NB (2): This type doesn't provide type parameter substitutions; e.g., if you
640 // ask for the type of "id" in "id(3)", it will return "fn(&isize) -> isize"
641 // instead of "fn(ty) -> T with T = isize".
642 pub fn expr_ty(&self, expr: &hir::Expr<'_>) -> Ty<'tcx> {
643 self.node_type(expr.hir_id)
646 pub fn expr_ty_opt(&self, expr: &hir::Expr<'_>) -> Option<Ty<'tcx>> {
647 self.node_type_opt(expr.hir_id)
650 pub fn adjustments(&self) -> LocalTableInContext<'_, Vec<ty::adjustment::Adjustment<'tcx>>> {
651 LocalTableInContext { hir_owner: self.hir_owner, data: &self.adjustments }
654 pub fn adjustments_mut(
656 ) -> LocalTableInContextMut<'_, Vec<ty::adjustment::Adjustment<'tcx>>> {
657 LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.adjustments }
660 pub fn expr_adjustments(&self, expr: &hir::Expr<'_>) -> &[ty::adjustment::Adjustment<'tcx>] {
661 validate_hir_id_for_typeck_results(self.hir_owner, expr.hir_id);
662 self.adjustments.get(&expr.hir_id.local_id).map_or(&[], |a| &a[..])
665 /// Returns the type of `expr`, considering any `Adjustment`
666 /// entry recorded for that expression.
667 pub fn expr_ty_adjusted(&self, expr: &hir::Expr<'_>) -> Ty<'tcx> {
668 self.expr_adjustments(expr).last().map_or_else(|| self.expr_ty(expr), |adj| adj.target)
671 pub fn expr_ty_adjusted_opt(&self, expr: &hir::Expr<'_>) -> Option<Ty<'tcx>> {
672 self.expr_adjustments(expr).last().map(|adj| adj.target).or_else(|| self.expr_ty_opt(expr))
675 pub fn is_method_call(&self, expr: &hir::Expr<'_>) -> bool {
676 // Only paths and method calls/overloaded operators have
677 // entries in type_dependent_defs, ignore the former here.
678 if let hir::ExprKind::Path(_) = expr.kind {
682 matches!(self.type_dependent_defs().get(expr.hir_id), Some(Ok((DefKind::AssocFn, _))))
685 pub fn extract_binding_mode(&self, s: &Session, id: HirId, sp: Span) -> Option<BindingMode> {
686 self.pat_binding_modes().get(id).copied().or_else(|| {
687 s.delay_span_bug(sp, "missing binding mode");
692 pub fn pat_binding_modes(&self) -> LocalTableInContext<'_, BindingMode> {
693 LocalTableInContext { hir_owner: self.hir_owner, data: &self.pat_binding_modes }
696 pub fn pat_binding_modes_mut(&mut self) -> LocalTableInContextMut<'_, BindingMode> {
697 LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.pat_binding_modes }
700 pub fn pat_adjustments(&self) -> LocalTableInContext<'_, Vec<Ty<'tcx>>> {
701 LocalTableInContext { hir_owner: self.hir_owner, data: &self.pat_adjustments }
704 pub fn pat_adjustments_mut(&mut self) -> LocalTableInContextMut<'_, Vec<Ty<'tcx>>> {
705 LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.pat_adjustments }
708 /// For a given closure, returns the iterator of `ty::CapturedPlace`s that are captured
710 pub fn closure_min_captures_flattened(
712 closure_def_id: DefId,
713 ) -> impl Iterator<Item = &ty::CapturedPlace<'tcx>> {
714 self.closure_min_captures
715 .get(&closure_def_id)
716 .map(|closure_min_captures| closure_min_captures.values().flat_map(|v| v.iter()))
721 pub fn closure_kind_origins(&self) -> LocalTableInContext<'_, (Span, HirPlace<'tcx>)> {
722 LocalTableInContext { hir_owner: self.hir_owner, data: &self.closure_kind_origins }
725 pub fn closure_kind_origins_mut(
727 ) -> LocalTableInContextMut<'_, (Span, HirPlace<'tcx>)> {
728 LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.closure_kind_origins }
731 pub fn liberated_fn_sigs(&self) -> LocalTableInContext<'_, ty::FnSig<'tcx>> {
732 LocalTableInContext { hir_owner: self.hir_owner, data: &self.liberated_fn_sigs }
735 pub fn liberated_fn_sigs_mut(&mut self) -> LocalTableInContextMut<'_, ty::FnSig<'tcx>> {
736 LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.liberated_fn_sigs }
739 pub fn fru_field_types(&self) -> LocalTableInContext<'_, Vec<Ty<'tcx>>> {
740 LocalTableInContext { hir_owner: self.hir_owner, data: &self.fru_field_types }
743 pub fn fru_field_types_mut(&mut self) -> LocalTableInContextMut<'_, Vec<Ty<'tcx>>> {
744 LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.fru_field_types }
747 pub fn is_coercion_cast(&self, hir_id: hir::HirId) -> bool {
748 validate_hir_id_for_typeck_results(self.hir_owner, hir_id);
749 self.coercion_casts.contains(&hir_id.local_id)
752 pub fn set_coercion_cast(&mut self, id: ItemLocalId) {
753 self.coercion_casts.insert(id);
756 pub fn coercion_casts(&self) -> &ItemLocalSet {
761 impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for TypeckResults<'tcx> {
762 fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
763 let ty::TypeckResults {
765 ref type_dependent_defs,
767 ref user_provided_types,
768 ref user_provided_sigs,
772 ref pat_binding_modes,
774 ref closure_kind_origins,
775 ref liberated_fn_sigs,
778 ref used_trait_imports,
780 ref concrete_opaque_types,
781 ref closure_min_captures,
782 ref closure_fake_reads,
783 ref generator_interior_types,
784 ref treat_byte_string_as_slice,
785 ref closure_size_eval,
788 hcx.with_node_id_hashing_mode(NodeIdHashingMode::HashDefPath, |hcx| {
789 hcx.local_def_path_hash(hir_owner);
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);
801 closure_kind_origins.hash_stable(hcx, hasher);
802 liberated_fn_sigs.hash_stable(hcx, hasher);
803 fru_field_types.hash_stable(hcx, hasher);
804 coercion_casts.hash_stable(hcx, hasher);
805 used_trait_imports.hash_stable(hcx, hasher);
806 tainted_by_errors.hash_stable(hcx, hasher);
807 concrete_opaque_types.hash_stable(hcx, hasher);
808 closure_min_captures.hash_stable(hcx, hasher);
809 closure_fake_reads.hash_stable(hcx, hasher);
810 generator_interior_types.hash_stable(hcx, hasher);
811 treat_byte_string_as_slice.hash_stable(hcx, hasher);
812 closure_size_eval.hash_stable(hcx, hasher);
817 rustc_index::newtype_index! {
818 pub struct UserTypeAnnotationIndex {
820 DEBUG_FORMAT = "UserType({})",
821 const START_INDEX = 0,
825 /// Mapping of type annotation indices to canonical user type annotations.
826 pub type CanonicalUserTypeAnnotations<'tcx> =
827 IndexVec<UserTypeAnnotationIndex, CanonicalUserTypeAnnotation<'tcx>>;
829 #[derive(Clone, Debug, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
830 pub struct CanonicalUserTypeAnnotation<'tcx> {
831 pub user_ty: CanonicalUserType<'tcx>,
833 pub inferred_ty: Ty<'tcx>,
836 /// Canonicalized user type annotation.
837 pub type CanonicalUserType<'tcx> = Canonical<'tcx, UserType<'tcx>>;
839 impl<'tcx> CanonicalUserType<'tcx> {
840 /// Returns `true` if this represents a substitution of the form `[?0, ?1, ?2]`,
841 /// i.e., each thing is mapped to a canonical variable with the same index.
842 pub fn is_identity(&self) -> bool {
844 UserType::Ty(_) => false,
845 UserType::TypeOf(_, user_substs) => {
846 if user_substs.user_self_ty.is_some() {
850 iter::zip(user_substs.substs, BoundVar::new(0)..).all(|(kind, cvar)| {
851 match kind.unpack() {
852 GenericArgKind::Type(ty) => match ty.kind() {
853 ty::Bound(debruijn, b) => {
854 // We only allow a `ty::INNERMOST` index in substitutions.
855 assert_eq!(*debruijn, ty::INNERMOST);
861 GenericArgKind::Lifetime(r) => match *r {
862 ty::ReLateBound(debruijn, br) => {
863 // We only allow a `ty::INNERMOST` index in substitutions.
864 assert_eq!(debruijn, ty::INNERMOST);
870 GenericArgKind::Const(ct) => match ct.val() {
871 ty::ConstKind::Bound(debruijn, b) => {
872 // We only allow a `ty::INNERMOST` index in substitutions.
873 assert_eq!(debruijn, ty::INNERMOST);
885 /// A user-given type annotation attached to a constant. These arise
886 /// from constants that are named via paths, like `Foo::<A>::new` and
888 #[derive(Copy, Clone, Debug, PartialEq, TyEncodable, TyDecodable)]
889 #[derive(HashStable, TypeFoldable, Lift)]
890 pub enum UserType<'tcx> {
893 /// The canonical type is the result of `type_of(def_id)` with the
894 /// given substitutions applied.
895 TypeOf(DefId, UserSubsts<'tcx>),
898 impl<'tcx> CommonTypes<'tcx> {
899 fn new(interners: &CtxtInterners<'tcx>) -> CommonTypes<'tcx> {
900 let mk = |ty| interners.intern_ty(ty);
903 unit: mk(Tuple(List::empty())),
907 isize: mk(Int(ty::IntTy::Isize)),
908 i8: mk(Int(ty::IntTy::I8)),
909 i16: mk(Int(ty::IntTy::I16)),
910 i32: mk(Int(ty::IntTy::I32)),
911 i64: mk(Int(ty::IntTy::I64)),
912 i128: mk(Int(ty::IntTy::I128)),
913 usize: mk(Uint(ty::UintTy::Usize)),
914 u8: mk(Uint(ty::UintTy::U8)),
915 u16: mk(Uint(ty::UintTy::U16)),
916 u32: mk(Uint(ty::UintTy::U32)),
917 u64: mk(Uint(ty::UintTy::U64)),
918 u128: mk(Uint(ty::UintTy::U128)),
919 f32: mk(Float(ty::FloatTy::F32)),
920 f64: mk(Float(ty::FloatTy::F64)),
922 self_param: mk(ty::Param(ty::ParamTy { index: 0, name: kw::SelfUpper })),
924 trait_object_dummy_self: mk(Infer(ty::FreshTy(0))),
929 impl<'tcx> CommonLifetimes<'tcx> {
930 fn new(interners: &CtxtInterners<'tcx>) -> CommonLifetimes<'tcx> {
932 Region(Interned::new_unchecked(
933 interners.region.intern(r, |r| InternedInSet(interners.arena.alloc(r))).0,
938 re_root_empty: mk(ty::ReEmpty(ty::UniverseIndex::ROOT)),
939 re_static: mk(ty::ReStatic),
940 re_erased: mk(ty::ReErased),
945 impl<'tcx> CommonConsts<'tcx> {
946 fn new(interners: &CtxtInterners<'tcx>, types: &CommonTypes<'tcx>) -> CommonConsts<'tcx> {
948 Const(Interned::new_unchecked(
949 interners.const_.intern(c, |c| InternedInSet(interners.arena.alloc(c))).0,
954 unit: mk_const(ty::ConstS {
955 val: ty::ConstKind::Value(ConstValue::Scalar(Scalar::ZST)),
962 // This struct contains information regarding the `ReFree(FreeRegion)` corresponding to a lifetime
965 pub struct FreeRegionInfo {
966 // `LocalDefId` corresponding to FreeRegion
967 pub def_id: LocalDefId,
968 // the bound region corresponding to FreeRegion
969 pub boundregion: ty::BoundRegionKind,
970 // checks if bound region is in Impl Item
971 pub is_impl_item: bool,
974 /// The central data structure of the compiler. It stores references
975 /// to the various **arenas** and also houses the results of the
976 /// various **compiler queries** that have been performed. See the
977 /// [rustc dev guide] for more details.
979 /// [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/ty.html
980 #[derive(Copy, Clone)]
981 #[rustc_diagnostic_item = "TyCtxt"]
982 #[cfg_attr(not(bootstrap), rustc_pass_by_value)]
983 pub struct TyCtxt<'tcx> {
984 gcx: &'tcx GlobalCtxt<'tcx>,
987 impl<'tcx> Deref for TyCtxt<'tcx> {
988 type Target = &'tcx GlobalCtxt<'tcx>;
990 fn deref(&self) -> &Self::Target {
995 pub struct GlobalCtxt<'tcx> {
996 pub arena: &'tcx WorkerLocal<Arena<'tcx>>,
998 interners: CtxtInterners<'tcx>,
1000 pub sess: &'tcx Session,
1002 /// This only ever stores a `LintStore` but we don't want a dependency on that type here.
1004 /// FIXME(Centril): consider `dyn LintStoreMarker` once
1005 /// we can upcast to `Any` for some additional type safety.
1006 pub lint_store: Lrc<dyn Any + sync::Sync + sync::Send>,
1008 pub dep_graph: DepGraph,
1010 pub prof: SelfProfilerRef,
1012 /// Common types, pre-interned for your convenience.
1013 pub types: CommonTypes<'tcx>,
1015 /// Common lifetimes, pre-interned for your convenience.
1016 pub lifetimes: CommonLifetimes<'tcx>,
1018 /// Common consts, pre-interned for your convenience.
1019 pub consts: CommonConsts<'tcx>,
1021 /// Output of the resolver.
1022 pub(crate) untracked_resolutions: ty::ResolverOutputs,
1024 pub(crate) untracked_crate: &'tcx hir::Crate<'tcx>,
1026 /// This provides access to the incremental compilation on-disk cache for query results.
1027 /// Do not access this directly. It is only meant to be used by
1028 /// `DepGraph::try_mark_green()` and the query infrastructure.
1029 /// This is `None` if we are not incremental compilation mode
1030 pub on_disk_cache: Option<&'tcx dyn OnDiskCache<'tcx>>,
1032 pub queries: &'tcx dyn query::QueryEngine<'tcx>,
1033 pub query_caches: query::QueryCaches<'tcx>,
1034 query_kinds: &'tcx [DepKindStruct],
1036 // Internal caches for metadata decoding. No need to track deps on this.
1037 pub ty_rcache: Lock<FxHashMap<ty::CReaderCacheKey, Ty<'tcx>>>,
1038 pub pred_rcache: Lock<FxHashMap<ty::CReaderCacheKey, Predicate<'tcx>>>,
1040 /// Caches the results of trait selection. This cache is used
1041 /// for things that do not have to do with the parameters in scope.
1042 pub selection_cache: traits::SelectionCache<'tcx>,
1044 /// Caches the results of trait evaluation. This cache is used
1045 /// for things that do not have to do with the parameters in scope.
1046 /// Merge this with `selection_cache`?
1047 pub evaluation_cache: traits::EvaluationCache<'tcx>,
1049 /// The definite name of the current crate after taking into account
1050 /// attributes, commandline parameters, etc.
1053 /// Data layout specification for the current target.
1054 pub data_layout: TargetDataLayout,
1056 /// Stores memory for globals (statics/consts).
1057 pub(crate) alloc_map: Lock<interpret::AllocMap<'tcx>>,
1059 output_filenames: Arc<OutputFilenames>,
1062 impl<'tcx> TyCtxt<'tcx> {
1063 pub fn typeck_opt_const_arg(
1065 def: ty::WithOptConstParam<LocalDefId>,
1066 ) -> &'tcx TypeckResults<'tcx> {
1067 if let Some(param_did) = def.const_param_did {
1068 self.typeck_const_arg((def.did, param_did))
1070 self.typeck(def.did)
1074 pub fn mir_borrowck_opt_const_arg(
1076 def: ty::WithOptConstParam<LocalDefId>,
1077 ) -> &'tcx BorrowCheckResult<'tcx> {
1078 if let Some(param_did) = def.const_param_did {
1079 self.mir_borrowck_const_arg((def.did, param_did))
1081 self.mir_borrowck(def.did)
1085 pub fn alloc_steal_thir(self, thir: Thir<'tcx>) -> &'tcx Steal<Thir<'tcx>> {
1086 self.arena.alloc(Steal::new(thir))
1089 pub fn alloc_steal_mir(self, mir: Body<'tcx>) -> &'tcx Steal<Body<'tcx>> {
1090 self.arena.alloc(Steal::new(mir))
1093 pub fn alloc_steal_promoted(
1095 promoted: IndexVec<Promoted, Body<'tcx>>,
1096 ) -> &'tcx Steal<IndexVec<Promoted, Body<'tcx>>> {
1097 self.arena.alloc(Steal::new(promoted))
1100 pub fn alloc_adt_def(
1104 variants: IndexVec<VariantIdx, ty::VariantDef>,
1106 ) -> &'tcx ty::AdtDef {
1107 self.intern_adt_def(ty::AdtDef::new(self, did, kind, variants, repr))
1110 /// Allocates a read-only byte or string literal for `mir::interpret`.
1111 pub fn allocate_bytes(self, bytes: &[u8]) -> interpret::AllocId {
1112 // Create an allocation that just contains these bytes.
1113 let alloc = interpret::Allocation::from_bytes_byte_aligned_immutable(bytes);
1114 let alloc = self.intern_const_alloc(alloc);
1115 self.create_memory_alloc(alloc)
1118 /// Returns a range of the start/end indices specified with the
1119 /// `rustc_layout_scalar_valid_range` attribute.
1120 // FIXME(eddyb) this is an awkward spot for this method, maybe move it?
1121 pub fn layout_scalar_valid_range(self, def_id: DefId) -> (Bound<u128>, Bound<u128>) {
1122 let attrs = self.get_attrs(def_id);
1124 let Some(attr) = attrs.iter().find(|a| a.has_name(name)) else {
1125 return Bound::Unbounded;
1127 debug!("layout_scalar_valid_range: attr={:?}", attr);
1130 ast::NestedMetaItem::Literal(ast::Lit {
1131 kind: ast::LitKind::Int(a, _), ..
1134 ) = attr.meta_item_list().as_deref()
1139 .delay_span_bug(attr.span, "invalid rustc_layout_scalar_valid_range attribute");
1144 get(sym::rustc_layout_scalar_valid_range_start),
1145 get(sym::rustc_layout_scalar_valid_range_end),
1149 pub fn lift<T: Lift<'tcx>>(self, value: T) -> Option<T::Lifted> {
1150 value.lift_to_tcx(self)
1153 /// Creates a type context and call the closure with a `TyCtxt` reference
1154 /// to the context. The closure enforces that the type context and any interned
1155 /// value (types, substs, etc.) can only be used while `ty::tls` has a valid
1156 /// reference to the context, to allow formatting values that need it.
1157 pub fn create_global_ctxt(
1159 lint_store: Lrc<dyn Any + sync::Send + sync::Sync>,
1160 arena: &'tcx WorkerLocal<Arena<'tcx>>,
1161 resolutions: ty::ResolverOutputs,
1162 krate: &'tcx hir::Crate<'tcx>,
1163 dep_graph: DepGraph,
1164 on_disk_cache: Option<&'tcx dyn OnDiskCache<'tcx>>,
1165 queries: &'tcx dyn query::QueryEngine<'tcx>,
1166 query_kinds: &'tcx [DepKindStruct],
1168 output_filenames: OutputFilenames,
1169 ) -> GlobalCtxt<'tcx> {
1170 let data_layout = TargetDataLayout::parse(&s.target).unwrap_or_else(|err| {
1173 let interners = CtxtInterners::new(arena);
1174 let common_types = CommonTypes::new(&interners);
1175 let common_lifetimes = CommonLifetimes::new(&interners);
1176 let common_consts = CommonConsts::new(&interners, &common_types);
1184 untracked_resolutions: resolutions,
1185 prof: s.prof.clone(),
1186 types: common_types,
1187 lifetimes: common_lifetimes,
1188 consts: common_consts,
1189 untracked_crate: krate,
1192 query_caches: query::QueryCaches::default(),
1194 ty_rcache: Default::default(),
1195 pred_rcache: Default::default(),
1196 selection_cache: Default::default(),
1197 evaluation_cache: Default::default(),
1198 crate_name: Symbol::intern(crate_name),
1200 alloc_map: Lock::new(interpret::AllocMap::new()),
1201 output_filenames: Arc::new(output_filenames),
1205 crate fn query_kind(self, k: DepKind) -> &'tcx DepKindStruct {
1206 &self.query_kinds[k as usize]
1209 /// Constructs a `TyKind::Error` type and registers a `delay_span_bug` to ensure it gets used.
1211 pub fn ty_error(self) -> Ty<'tcx> {
1212 self.ty_error_with_message(DUMMY_SP, "TyKind::Error constructed but no error reported")
1215 /// Constructs a `TyKind::Error` type and registers a `delay_span_bug` with the given `msg` to
1216 /// ensure it gets used.
1218 pub fn ty_error_with_message<S: Into<MultiSpan>>(self, span: S, msg: &str) -> Ty<'tcx> {
1219 self.sess.delay_span_bug(span, msg);
1220 self.mk_ty(Error(DelaySpanBugEmitted(())))
1223 /// Like [TyCtxt::ty_error] but for constants.
1225 pub fn const_error(self, ty: Ty<'tcx>) -> Const<'tcx> {
1226 self.const_error_with_message(
1229 "ty::ConstKind::Error constructed but no error reported",
1233 /// Like [TyCtxt::ty_error_with_message] but for constants.
1235 pub fn const_error_with_message<S: Into<MultiSpan>>(
1241 self.sess.delay_span_bug(span, msg);
1242 self.mk_const(ty::ConstS { val: ty::ConstKind::Error(DelaySpanBugEmitted(())), ty })
1245 pub fn consider_optimizing<T: Fn() -> String>(self, msg: T) -> bool {
1246 let cname = self.crate_name(LOCAL_CRATE);
1247 self.sess.consider_optimizing(cname.as_str(), msg)
1250 /// Obtain all lang items of this crate and all dependencies (recursively)
1251 pub fn lang_items(self) -> &'tcx rustc_hir::lang_items::LanguageItems {
1252 self.get_lang_items(())
1255 /// Obtain the given diagnostic item's `DefId`. Use `is_diagnostic_item` if you just want to
1256 /// compare against another `DefId`, since `is_diagnostic_item` is cheaper.
1257 pub fn get_diagnostic_item(self, name: Symbol) -> Option<DefId> {
1258 self.all_diagnostic_items(()).name_to_id.get(&name).copied()
1261 /// Obtain the diagnostic item's name
1262 pub fn get_diagnostic_name(self, id: DefId) -> Option<Symbol> {
1263 self.diagnostic_items(id.krate).id_to_name.get(&id).copied()
1266 /// Check whether the diagnostic item with the given `name` has the given `DefId`.
1267 pub fn is_diagnostic_item(self, name: Symbol, did: DefId) -> bool {
1268 self.diagnostic_items(did.krate).name_to_id.get(&name) == Some(&did)
1271 pub fn stability(self) -> &'tcx stability::Index<'tcx> {
1272 self.stability_index(())
1275 pub fn features(self) -> &'tcx rustc_feature::Features {
1276 self.features_query(())
1279 pub fn def_key(self, id: DefId) -> rustc_hir::definitions::DefKey {
1280 // Accessing the DefKey is ok, since it is part of DefPathHash.
1281 if let Some(id) = id.as_local() {
1282 self.untracked_resolutions.definitions.def_key(id)
1284 self.untracked_resolutions.cstore.def_key(id)
1288 /// Converts a `DefId` into its fully expanded `DefPath` (every
1289 /// `DefId` is really just an interned `DefPath`).
1291 /// Note that if `id` is not local to this crate, the result will
1292 /// be a non-local `DefPath`.
1293 pub fn def_path(self, id: DefId) -> rustc_hir::definitions::DefPath {
1294 // Accessing the DefPath is ok, since it is part of DefPathHash.
1295 if let Some(id) = id.as_local() {
1296 self.untracked_resolutions.definitions.def_path(id)
1298 self.untracked_resolutions.cstore.def_path(id)
1303 pub fn def_path_hash(self, def_id: DefId) -> rustc_hir::definitions::DefPathHash {
1304 // Accessing the DefPathHash is ok, it is incr. comp. stable.
1305 if let Some(def_id) = def_id.as_local() {
1306 self.untracked_resolutions.definitions.def_path_hash(def_id)
1308 self.untracked_resolutions.cstore.def_path_hash(def_id)
1313 pub fn stable_crate_id(self, crate_num: CrateNum) -> StableCrateId {
1314 if crate_num == LOCAL_CRATE {
1315 self.sess.local_stable_crate_id()
1317 self.untracked_resolutions.cstore.stable_crate_id(crate_num)
1321 /// Maps a StableCrateId to the corresponding CrateNum. This method assumes
1322 /// that the crate in question has already been loaded by the CrateStore.
1324 pub fn stable_crate_id_to_crate_num(self, stable_crate_id: StableCrateId) -> CrateNum {
1325 if stable_crate_id == self.sess.local_stable_crate_id() {
1328 self.untracked_resolutions.cstore.stable_crate_id_to_crate_num(stable_crate_id)
1332 /// Converts a `DefPathHash` to its corresponding `DefId` in the current compilation
1333 /// session, if it still exists. This is used during incremental compilation to
1334 /// turn a deserialized `DefPathHash` into its current `DefId`.
1335 pub fn def_path_hash_to_def_id(self, hash: DefPathHash, err: &mut dyn FnMut() -> !) -> DefId {
1336 debug!("def_path_hash_to_def_id({:?})", hash);
1338 let stable_crate_id = hash.stable_crate_id();
1340 // If this is a DefPathHash from the local crate, we can look up the
1341 // DefId in the tcx's `Definitions`.
1342 if stable_crate_id == self.sess.local_stable_crate_id() {
1343 self.untracked_resolutions
1345 .local_def_path_hash_to_def_id(hash, err)
1348 // If this is a DefPathHash from an upstream crate, let the CrateStore map
1350 let cstore = &self.untracked_resolutions.cstore;
1351 let cnum = cstore.stable_crate_id_to_crate_num(stable_crate_id);
1352 cstore.def_path_hash_to_def_id(cnum, hash)
1356 pub fn def_path_debug_str(self, def_id: DefId) -> String {
1357 // We are explicitly not going through queries here in order to get
1358 // crate name and stable crate id since this code is called from debug!()
1359 // statements within the query system and we'd run into endless
1360 // recursion otherwise.
1361 let (crate_name, stable_crate_id) = if def_id.is_local() {
1362 (self.crate_name, self.sess.local_stable_crate_id())
1364 let cstore = &self.untracked_resolutions.cstore;
1365 (cstore.crate_name(def_id.krate), cstore.stable_crate_id(def_id.krate))
1371 // Don't print the whole stable crate id. That's just
1372 // annoying in debug output.
1373 &(format!("{:08x}", stable_crate_id.to_u64()))[..4],
1374 self.def_path(def_id).to_string_no_crate_verbose()
1378 /// Note that this is *untracked* and should only be used within the query
1379 /// system if the result is otherwise tracked through queries
1380 pub fn cstore_untracked(self) -> &'tcx ty::CrateStoreDyn {
1381 &*self.untracked_resolutions.cstore
1384 /// Note that this is *untracked* and should only be used within the query
1385 /// system if the result is otherwise tracked through queries
1386 pub fn definitions_untracked(self) -> &'tcx hir::definitions::Definitions {
1387 &self.untracked_resolutions.definitions
1391 pub fn create_stable_hashing_context(self) -> StableHashingContext<'tcx> {
1392 let resolutions = &self.gcx.untracked_resolutions;
1393 StableHashingContext::new(self.sess, &resolutions.definitions, &*resolutions.cstore)
1397 pub fn create_no_span_stable_hashing_context(self) -> StableHashingContext<'tcx> {
1398 let resolutions = &self.gcx.untracked_resolutions;
1399 StableHashingContext::ignore_spans(
1401 &resolutions.definitions,
1402 &*resolutions.cstore,
1406 pub fn serialize_query_result_cache(self, encoder: &mut FileEncoder) -> FileEncodeResult {
1407 self.on_disk_cache.as_ref().map_or(Ok(()), |c| c.serialize(self, encoder))
1410 /// If `true`, we should use the MIR-based borrowck, but also
1411 /// fall back on the AST borrowck if the MIR-based one errors.
1412 pub fn migrate_borrowck(self) -> bool {
1413 self.borrowck_mode().migrate()
1416 /// What mode(s) of borrowck should we run? AST? MIR? both?
1417 /// (Also considers the `#![feature(nll)]` setting.)
1418 pub fn borrowck_mode(self) -> BorrowckMode {
1419 // Here are the main constraints we need to deal with:
1421 // 1. An opts.borrowck_mode of `BorrowckMode::Migrate` is
1422 // synonymous with no `-Z borrowck=...` flag at all.
1424 // 2. We want to allow developers on the Nightly channel
1425 // to opt back into the "hard error" mode for NLL,
1426 // (which they can do via specifying `#![feature(nll)]`
1427 // explicitly in their crate).
1429 // So, this precedence list is how pnkfelix chose to work with
1430 // the above constraints:
1432 // * `#![feature(nll)]` *always* means use NLL with hard
1433 // errors. (To simplify the code here, it now even overrides
1434 // a user's attempt to specify `-Z borrowck=compare`, which
1435 // we arguably do not need anymore and should remove.)
1437 // * Otherwise, if no `-Z borrowck=...` then use migrate mode
1439 // * Otherwise, use the behavior requested via `-Z borrowck=...`
1441 if self.features().nll {
1442 return BorrowckMode::Mir;
1445 self.sess.opts.borrowck_mode
1448 /// If `true`, we should use lazy normalization for constants, otherwise
1449 /// we still evaluate them eagerly.
1451 pub fn lazy_normalization(self) -> bool {
1452 let features = self.features();
1453 // Note: We only use lazy normalization for generic const expressions.
1454 features.generic_const_exprs
1458 pub fn local_crate_exports_generics(self) -> bool {
1459 debug_assert!(self.sess.opts.share_generics());
1461 self.sess.crate_types().iter().any(|crate_type| {
1463 CrateType::Executable
1464 | CrateType::Staticlib
1465 | CrateType::ProcMacro
1466 | CrateType::Cdylib => false,
1468 // FIXME rust-lang/rust#64319, rust-lang/rust#64872:
1469 // We want to block export of generics from dylibs,
1470 // but we must fix rust-lang/rust#65890 before we can
1471 // do that robustly.
1472 CrateType::Dylib => true,
1474 CrateType::Rlib => true,
1479 // Returns the `DefId` and the `BoundRegionKind` corresponding to the given region.
1480 pub fn is_suitable_region(self, region: Region<'tcx>) -> Option<FreeRegionInfo> {
1481 let (suitable_region_binding_scope, bound_region) = match *region {
1482 ty::ReFree(ref free_region) => {
1483 (free_region.scope.expect_local(), free_region.bound_region)
1485 ty::ReEarlyBound(ref ebr) => (
1486 self.parent(ebr.def_id).unwrap().expect_local(),
1487 ty::BoundRegionKind::BrNamed(ebr.def_id, ebr.name),
1489 _ => return None, // not a free region
1492 let is_impl_item = match self.hir().find_by_def_id(suitable_region_binding_scope) {
1493 Some(Node::Item(..) | Node::TraitItem(..)) => false,
1494 Some(Node::ImplItem(..)) => {
1495 self.is_bound_region_in_impl_item(suitable_region_binding_scope)
1500 Some(FreeRegionInfo {
1501 def_id: suitable_region_binding_scope,
1502 boundregion: bound_region,
1507 /// Given a `DefId` for an `fn`, return all the `dyn` and `impl` traits in its return type.
1508 pub fn return_type_impl_or_dyn_traits(
1510 scope_def_id: LocalDefId,
1511 ) -> Vec<&'tcx hir::Ty<'tcx>> {
1512 let hir_id = self.hir().local_def_id_to_hir_id(scope_def_id);
1513 let Some(hir::FnDecl { output: hir::FnRetTy::Return(hir_output), .. }) = self.hir().fn_decl_by_hir_id(hir_id) else {
1517 let mut v = TraitObjectVisitor(vec![], self.hir());
1518 v.visit_ty(hir_output);
1522 pub fn return_type_impl_trait(self, scope_def_id: LocalDefId) -> Option<(Ty<'tcx>, Span)> {
1523 // `type_of()` will fail on these (#55796, #86483), so only allow `fn`s or closures.
1524 match self.hir().get_by_def_id(scope_def_id) {
1525 Node::Item(&hir::Item { kind: ItemKind::Fn(..), .. }) => {}
1526 Node::TraitItem(&hir::TraitItem { kind: TraitItemKind::Fn(..), .. }) => {}
1527 Node::ImplItem(&hir::ImplItem { kind: ImplItemKind::Fn(..), .. }) => {}
1528 Node::Expr(&hir::Expr { kind: ExprKind::Closure(..), .. }) => {}
1532 let ret_ty = self.type_of(scope_def_id);
1533 match ret_ty.kind() {
1534 ty::FnDef(_, _) => {
1535 let sig = ret_ty.fn_sig(self);
1536 let output = self.erase_late_bound_regions(sig.output());
1537 if output.is_impl_trait() {
1538 let hir_id = self.hir().local_def_id_to_hir_id(scope_def_id);
1539 let fn_decl = self.hir().fn_decl_by_hir_id(hir_id).unwrap();
1540 Some((output, fn_decl.output.span()))
1549 // Checks if the bound region is in Impl Item.
1550 pub fn is_bound_region_in_impl_item(self, suitable_region_binding_scope: LocalDefId) -> bool {
1552 self.associated_item(suitable_region_binding_scope.to_def_id()).container.id();
1553 if self.impl_trait_ref(container_id).is_some() {
1554 // For now, we do not try to target impls of traits. This is
1555 // because this message is going to suggest that the user
1556 // change the fn signature, but they may not be free to do so,
1557 // since the signature must match the trait.
1559 // FIXME(#42706) -- in some cases, we could do better here.
1565 /// Determines whether identifiers in the assembly have strict naming rules.
1566 /// Currently, only NVPTX* targets need it.
1567 pub fn has_strict_asm_symbol_naming(self) -> bool {
1568 self.sess.target.arch.contains("nvptx")
1571 /// Returns `&'static core::panic::Location<'static>`.
1572 pub fn caller_location_ty(self) -> Ty<'tcx> {
1574 self.lifetimes.re_static,
1575 self.type_of(self.require_lang_item(LangItem::PanicLocation, None))
1576 .subst(self, self.mk_substs([self.lifetimes.re_static.into()].iter())),
1580 /// Returns a displayable description and article for the given `def_id` (e.g. `("a", "struct")`).
1581 pub fn article_and_description(self, def_id: DefId) -> (&'static str, &'static str) {
1582 match self.def_kind(def_id) {
1583 DefKind::Generator => match self.generator_kind(def_id).unwrap() {
1584 rustc_hir::GeneratorKind::Async(..) => ("an", "async closure"),
1585 rustc_hir::GeneratorKind::Gen => ("a", "generator"),
1587 def_kind => (def_kind.article(), def_kind.descr(def_id)),
1591 pub fn type_length_limit(self) -> Limit {
1592 self.limits(()).type_length_limit
1595 pub fn recursion_limit(self) -> Limit {
1596 self.limits(()).recursion_limit
1599 pub fn move_size_limit(self) -> Limit {
1600 self.limits(()).move_size_limit
1603 pub fn const_eval_limit(self) -> Limit {
1604 self.limits(()).const_eval_limit
1607 pub fn all_traits(self) -> impl Iterator<Item = DefId> + 'tcx {
1608 iter::once(LOCAL_CRATE)
1609 .chain(self.crates(()).iter().copied())
1610 .flat_map(move |cnum| self.traits_in_crate(cnum).iter().copied())
1614 /// A trait implemented for all `X<'a>` types that can be safely and
1615 /// efficiently converted to `X<'tcx>` as long as they are part of the
1616 /// provided `TyCtxt<'tcx>`.
1617 /// This can be done, for example, for `Ty<'tcx>` or `SubstsRef<'tcx>`
1618 /// by looking them up in their respective interners.
1620 /// However, this is still not the best implementation as it does
1621 /// need to compare the components, even for interned values.
1622 /// It would be more efficient if `TypedArena` provided a way to
1623 /// determine whether the address is in the allocated range.
1625 /// `None` is returned if the value or one of the components is not part
1626 /// of the provided context.
1627 /// For `Ty`, `None` can be returned if either the type interner doesn't
1628 /// contain the `TyKind` key or if the address of the interned
1629 /// pointer differs. The latter case is possible if a primitive type,
1630 /// e.g., `()` or `u8`, was interned in a different context.
1631 pub trait Lift<'tcx>: fmt::Debug {
1632 type Lifted: fmt::Debug + 'tcx;
1633 fn lift_to_tcx(self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted>;
1636 // Deprecated: we are in the process of converting all uses to `nop_lift`.
1637 macro_rules! nop_lift_old {
1638 ($set:ident; $ty:ty => $lifted:ty) => {
1639 impl<'a, 'tcx> Lift<'tcx> for $ty {
1640 type Lifted = $lifted;
1641 fn lift_to_tcx(self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted> {
1642 if tcx.interners.$set.contains_pointer_to(&InternedInSet(self)) {
1643 Some(unsafe { mem::transmute(self) })
1652 macro_rules! nop_lift {
1653 ($set:ident; $ty:ty => $lifted:ty) => {
1654 impl<'a, 'tcx> Lift<'tcx> for $ty {
1655 type Lifted = $lifted;
1656 fn lift_to_tcx(self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted> {
1657 if tcx.interners.$set.contains_pointer_to(&InternedInSet(self.0.0)) {
1658 // SAFETY: `self` is interned and therefore valid
1659 // for the entire lifetime of the `TyCtxt`.
1660 Some(unsafe { mem::transmute(self) })
1669 // Can't use the macros as we have reuse the `substs` here.
1671 // See `intern_type_list` for more info.
1672 impl<'a, 'tcx> Lift<'tcx> for &'a List<Ty<'a>> {
1673 type Lifted = &'tcx List<Ty<'tcx>>;
1674 fn lift_to_tcx(self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted> {
1675 if self.is_empty() {
1676 return Some(List::empty());
1678 if tcx.interners.substs.contains_pointer_to(&InternedInSet(self.as_substs())) {
1679 // SAFETY: `self` is interned and therefore valid
1680 // for the entire lifetime of the `TyCtxt`.
1681 Some(unsafe { mem::transmute::<&'a List<Ty<'a>>, &'tcx List<Ty<'tcx>>>(self) })
1688 macro_rules! nop_list_lift {
1689 ($set:ident; $ty:ty => $lifted:ty) => {
1690 impl<'a, 'tcx> Lift<'tcx> for &'a List<$ty> {
1691 type Lifted = &'tcx List<$lifted>;
1692 fn lift_to_tcx(self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted> {
1693 if self.is_empty() {
1694 return Some(List::empty());
1696 if tcx.interners.$set.contains_pointer_to(&InternedInSet(self)) {
1697 Some(unsafe { mem::transmute(self) })
1706 nop_lift! {type_; Ty<'a> => Ty<'tcx>}
1707 nop_lift! {region; Region<'a> => Region<'tcx>}
1708 nop_lift! {const_; Const<'a> => Const<'tcx>}
1709 nop_lift_old! {const_allocation; &'a Allocation => &'tcx Allocation}
1710 nop_lift! {predicate; Predicate<'a> => Predicate<'tcx>}
1712 nop_list_lift! {poly_existential_predicates; ty::Binder<'a, ExistentialPredicate<'a>> => ty::Binder<'tcx, ExistentialPredicate<'tcx>>}
1713 nop_list_lift! {predicates; Predicate<'a> => Predicate<'tcx>}
1714 nop_list_lift! {canonical_var_infos; CanonicalVarInfo<'a> => CanonicalVarInfo<'tcx>}
1715 nop_list_lift! {projs; ProjectionKind => ProjectionKind}
1716 nop_list_lift! {bound_variable_kinds; ty::BoundVariableKind => ty::BoundVariableKind}
1718 // This is the impl for `&'a InternalSubsts<'a>`.
1719 nop_list_lift! {substs; GenericArg<'a> => GenericArg<'tcx>}
1721 CloneLiftImpls! { for<'tcx> { Constness, traits::WellFormedLoc, } }
1724 use super::{ptr_eq, GlobalCtxt, TyCtxt};
1726 use crate::dep_graph::TaskDepsRef;
1727 use crate::ty::query;
1728 use rustc_data_structures::sync::{self, Lock};
1729 use rustc_data_structures::thin_vec::ThinVec;
1730 use rustc_errors::Diagnostic;
1733 #[cfg(not(parallel_compiler))]
1734 use std::cell::Cell;
1736 #[cfg(parallel_compiler)]
1737 use rustc_rayon_core as rayon_core;
1739 /// This is the implicit state of rustc. It contains the current
1740 /// `TyCtxt` and query. It is updated when creating a local interner or
1741 /// executing a new query. Whenever there's a `TyCtxt` value available
1742 /// you should also have access to an `ImplicitCtxt` through the functions
1745 pub struct ImplicitCtxt<'a, 'tcx> {
1746 /// The current `TyCtxt`.
1747 pub tcx: TyCtxt<'tcx>,
1749 /// The current query job, if any. This is updated by `JobOwner::start` in
1750 /// `ty::query::plumbing` when executing a query.
1751 pub query: Option<query::QueryJobId>,
1753 /// Where to store diagnostics for the current query job, if any.
1754 /// This is updated by `JobOwner::start` in `ty::query::plumbing` when executing a query.
1755 pub diagnostics: Option<&'a Lock<ThinVec<Diagnostic>>>,
1757 /// Used to prevent layout from recursing too deeply.
1758 pub layout_depth: usize,
1760 /// The current dep graph task. This is used to add dependencies to queries
1761 /// when executing them.
1762 pub task_deps: TaskDepsRef<'a>,
1765 impl<'a, 'tcx> ImplicitCtxt<'a, 'tcx> {
1766 pub fn new(gcx: &'tcx GlobalCtxt<'tcx>) -> Self {
1767 let tcx = TyCtxt { gcx };
1773 task_deps: TaskDepsRef::Ignore,
1778 /// Sets Rayon's thread-local variable, which is preserved for Rayon jobs
1779 /// to `value` during the call to `f`. It is restored to its previous value after.
1780 /// This is used to set the pointer to the new `ImplicitCtxt`.
1781 #[cfg(parallel_compiler)]
1783 fn set_tlv<F: FnOnce() -> R, R>(value: usize, f: F) -> R {
1784 rayon_core::tlv::with(value, f)
1787 /// Gets Rayon's thread-local variable, which is preserved for Rayon jobs.
1788 /// This is used to get the pointer to the current `ImplicitCtxt`.
1789 #[cfg(parallel_compiler)]
1791 pub fn get_tlv() -> usize {
1792 rayon_core::tlv::get()
1795 #[cfg(not(parallel_compiler))]
1797 /// A thread local variable that stores a pointer to the current `ImplicitCtxt`.
1798 static TLV: Cell<usize> = const { Cell::new(0) };
1801 /// Sets TLV to `value` during the call to `f`.
1802 /// It is restored to its previous value after.
1803 /// This is used to set the pointer to the new `ImplicitCtxt`.
1804 #[cfg(not(parallel_compiler))]
1806 fn set_tlv<F: FnOnce() -> R, R>(value: usize, f: F) -> R {
1807 let old = get_tlv();
1808 let _reset = rustc_data_structures::OnDrop(move || TLV.with(|tlv| tlv.set(old)));
1809 TLV.with(|tlv| tlv.set(value));
1813 /// Gets the pointer to the current `ImplicitCtxt`.
1814 #[cfg(not(parallel_compiler))]
1816 fn get_tlv() -> usize {
1817 TLV.with(|tlv| tlv.get())
1820 /// Sets `context` as the new current `ImplicitCtxt` for the duration of the function `f`.
1822 pub fn enter_context<'a, 'tcx, F, R>(context: &ImplicitCtxt<'a, 'tcx>, f: F) -> R
1824 F: FnOnce(&ImplicitCtxt<'a, 'tcx>) -> R,
1826 set_tlv(context as *const _ as usize, || f(&context))
1829 /// Allows access to the current `ImplicitCtxt` in a closure if one is available.
1831 pub fn with_context_opt<F, R>(f: F) -> R
1833 F: for<'a, 'tcx> FnOnce(Option<&ImplicitCtxt<'a, 'tcx>>) -> R,
1835 let context = get_tlv();
1839 // We could get an `ImplicitCtxt` pointer from another thread.
1840 // Ensure that `ImplicitCtxt` is `Sync`.
1841 sync::assert_sync::<ImplicitCtxt<'_, '_>>();
1843 unsafe { f(Some(&*(context as *const ImplicitCtxt<'_, '_>))) }
1847 /// Allows access to the current `ImplicitCtxt`.
1848 /// Panics if there is no `ImplicitCtxt` available.
1850 pub fn with_context<F, R>(f: F) -> R
1852 F: for<'a, 'tcx> FnOnce(&ImplicitCtxt<'a, 'tcx>) -> R,
1854 with_context_opt(|opt_context| f(opt_context.expect("no ImplicitCtxt stored in tls")))
1857 /// Allows access to the current `ImplicitCtxt` whose tcx field is the same as the tcx argument
1858 /// passed in. This means the closure is given an `ImplicitCtxt` with the same `'tcx` lifetime
1859 /// as the `TyCtxt` passed in.
1860 /// This will panic if you pass it a `TyCtxt` which is different from the current
1861 /// `ImplicitCtxt`'s `tcx` field.
1863 pub fn with_related_context<'tcx, F, R>(tcx: TyCtxt<'tcx>, f: F) -> R
1865 F: FnOnce(&ImplicitCtxt<'_, 'tcx>) -> R,
1867 with_context(|context| unsafe {
1868 assert!(ptr_eq(context.tcx.gcx, tcx.gcx));
1869 let context: &ImplicitCtxt<'_, '_> = mem::transmute(context);
1874 /// Allows access to the `TyCtxt` in the current `ImplicitCtxt`.
1875 /// Panics if there is no `ImplicitCtxt` available.
1877 pub fn with<F, R>(f: F) -> R
1879 F: for<'tcx> FnOnce(TyCtxt<'tcx>) -> R,
1881 with_context(|context| f(context.tcx))
1884 /// Allows access to the `TyCtxt` in the current `ImplicitCtxt`.
1885 /// The closure is passed None if there is no `ImplicitCtxt` available.
1887 pub fn with_opt<F, R>(f: F) -> R
1889 F: for<'tcx> FnOnce(Option<TyCtxt<'tcx>>) -> R,
1891 with_context_opt(|opt_context| f(opt_context.map(|context| context.tcx)))
1895 macro_rules! sty_debug_print {
1896 ($fmt: expr, $ctxt: expr, $($variant: ident),*) => {{
1897 // Curious inner module to allow variant names to be used as
1899 #[allow(non_snake_case)]
1901 use crate::ty::{self, TyCtxt};
1902 use crate::ty::context::InternedInSet;
1904 #[derive(Copy, Clone)]
1913 pub fn go(fmt: &mut std::fmt::Formatter<'_>, tcx: TyCtxt<'_>) -> std::fmt::Result {
1914 let mut total = DebugStat {
1921 $(let mut $variant = total;)*
1923 let shards = tcx.interners.type_.lock_shards();
1924 let types = shards.iter().flat_map(|shard| shard.keys());
1925 for &InternedInSet(t) in types {
1926 let variant = match t.kind {
1927 ty::Bool | ty::Char | ty::Int(..) | ty::Uint(..) |
1928 ty::Float(..) | ty::Str | ty::Never => continue,
1929 ty::Error(_) => /* unimportant */ continue,
1930 $(ty::$variant(..) => &mut $variant,)*
1932 let lt = t.flags.intersects(ty::TypeFlags::HAS_RE_INFER);
1933 let ty = t.flags.intersects(ty::TypeFlags::HAS_TY_INFER);
1934 let ct = t.flags.intersects(ty::TypeFlags::HAS_CT_INFER);
1938 if lt { total.lt_infer += 1; variant.lt_infer += 1 }
1939 if ty { total.ty_infer += 1; variant.ty_infer += 1 }
1940 if ct { total.ct_infer += 1; variant.ct_infer += 1 }
1941 if lt && ty && ct { total.all_infer += 1; variant.all_infer += 1 }
1943 writeln!(fmt, "Ty interner total ty lt ct all")?;
1944 $(writeln!(fmt, " {:18}: {uses:6} {usespc:4.1}%, \
1945 {ty:4.1}% {lt:5.1}% {ct:4.1}% {all:4.1}%",
1946 stringify!($variant),
1947 uses = $variant.total,
1948 usespc = $variant.total as f64 * 100.0 / total.total as f64,
1949 ty = $variant.ty_infer as f64 * 100.0 / total.total as f64,
1950 lt = $variant.lt_infer as f64 * 100.0 / total.total as f64,
1951 ct = $variant.ct_infer as f64 * 100.0 / total.total as f64,
1952 all = $variant.all_infer as f64 * 100.0 / total.total as f64)?;
1954 writeln!(fmt, " total {uses:6} \
1955 {ty:4.1}% {lt:5.1}% {ct:4.1}% {all:4.1}%",
1957 ty = total.ty_infer as f64 * 100.0 / total.total as f64,
1958 lt = total.lt_infer as f64 * 100.0 / total.total as f64,
1959 ct = total.ct_infer as f64 * 100.0 / total.total as f64,
1960 all = total.all_infer as f64 * 100.0 / total.total as f64)
1964 inner::go($fmt, $ctxt)
1968 impl<'tcx> TyCtxt<'tcx> {
1969 pub fn debug_stats(self) -> impl std::fmt::Debug + 'tcx {
1970 struct DebugStats<'tcx>(TyCtxt<'tcx>);
1972 impl<'tcx> std::fmt::Debug for DebugStats<'tcx> {
1973 fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1998 writeln!(fmt, "InternalSubsts interner: #{}", self.0.interners.substs.len())?;
1999 writeln!(fmt, "Region interner: #{}", self.0.interners.region.len())?;
2000 writeln!(fmt, "Stability interner: #{}", self.0.interners.stability.len())?;
2003 "Const Stability interner: #{}",
2004 self.0.interners.const_stability.len()
2008 "Const Allocation interner: #{}",
2009 self.0.interners.const_allocation.len()
2011 writeln!(fmt, "Layout interner: #{}", self.0.interners.layout.len())?;
2021 // This type holds a `T` in the interner. The `T` is stored in the arena and
2022 // this type just holds a pointer to it, but it still effectively owns it. It
2023 // impls `Borrow` so that it can be looked up using the original
2024 // (non-arena-memory-owning) types.
2025 struct InternedInSet<'tcx, T: ?Sized>(&'tcx T);
2027 impl<'tcx, T: 'tcx + ?Sized> Clone for InternedInSet<'tcx, T> {
2028 fn clone(&self) -> Self {
2029 InternedInSet(self.0)
2033 impl<'tcx, T: 'tcx + ?Sized> Copy for InternedInSet<'tcx, T> {}
2035 impl<'tcx, T: 'tcx + ?Sized> IntoPointer for InternedInSet<'tcx, T> {
2036 fn into_pointer(&self) -> *const () {
2037 self.0 as *const _ as *const ()
2041 #[allow(rustc::usage_of_ty_tykind)]
2042 impl<'tcx> Borrow<TyKind<'tcx>> for InternedInSet<'tcx, TyS<'tcx>> {
2043 fn borrow<'a>(&'a self) -> &'a TyKind<'tcx> {
2048 impl<'tcx> PartialEq for InternedInSet<'tcx, TyS<'tcx>> {
2049 fn eq(&self, other: &InternedInSet<'tcx, TyS<'tcx>>) -> bool {
2050 // The `Borrow` trait requires that `x.borrow() == y.borrow()` equals
2052 self.0.kind == other.0.kind
2056 impl<'tcx> Eq for InternedInSet<'tcx, TyS<'tcx>> {}
2058 impl<'tcx> Hash for InternedInSet<'tcx, TyS<'tcx>> {
2059 fn hash<H: Hasher>(&self, s: &mut H) {
2060 // The `Borrow` trait requires that `x.borrow().hash(s) == x.hash(s)`.
2065 impl<'tcx> Borrow<Binder<'tcx, PredicateKind<'tcx>>> for InternedInSet<'tcx, PredicateS<'tcx>> {
2066 fn borrow<'a>(&'a self) -> &'a Binder<'tcx, PredicateKind<'tcx>> {
2071 impl<'tcx> PartialEq for InternedInSet<'tcx, PredicateS<'tcx>> {
2072 fn eq(&self, other: &InternedInSet<'tcx, PredicateS<'tcx>>) -> bool {
2073 // The `Borrow` trait requires that `x.borrow() == y.borrow()` equals
2075 self.0.kind == other.0.kind
2079 impl<'tcx> Eq for InternedInSet<'tcx, PredicateS<'tcx>> {}
2081 impl<'tcx> Hash for InternedInSet<'tcx, PredicateS<'tcx>> {
2082 fn hash<H: Hasher>(&self, s: &mut H) {
2083 // The `Borrow` trait requires that `x.borrow().hash(s) == x.hash(s)`.
2088 impl<'tcx, T> Borrow<[T]> for InternedInSet<'tcx, List<T>> {
2089 fn borrow<'a>(&'a self) -> &'a [T] {
2094 impl<'tcx, T: PartialEq> PartialEq for InternedInSet<'tcx, List<T>> {
2095 fn eq(&self, other: &InternedInSet<'tcx, List<T>>) -> bool {
2096 // The `Borrow` trait requires that `x.borrow() == y.borrow()` equals
2098 self.0[..] == other.0[..]
2102 impl<'tcx, T: Eq> Eq for InternedInSet<'tcx, List<T>> {}
2104 impl<'tcx, T: Hash> Hash for InternedInSet<'tcx, List<T>> {
2105 fn hash<H: Hasher>(&self, s: &mut H) {
2106 // The `Borrow` trait requires that `x.borrow().hash(s) == x.hash(s)`.
2111 macro_rules! direct_interners {
2112 ($($name:ident: $method:ident($ty:ty): $ret_ctor:ident -> $ret_ty:ty,)+) => {
2113 $(impl<'tcx> Borrow<$ty> for InternedInSet<'tcx, $ty> {
2114 fn borrow<'a>(&'a self) -> &'a $ty {
2119 impl<'tcx> PartialEq for InternedInSet<'tcx, $ty> {
2120 fn eq(&self, other: &Self) -> bool {
2121 // The `Borrow` trait requires that `x.borrow() == y.borrow()`
2127 impl<'tcx> Eq for InternedInSet<'tcx, $ty> {}
2129 impl<'tcx> Hash for InternedInSet<'tcx, $ty> {
2130 fn hash<H: Hasher>(&self, s: &mut H) {
2131 // The `Borrow` trait requires that `x.borrow().hash(s) ==
2137 impl<'tcx> TyCtxt<'tcx> {
2138 pub fn $method(self, v: $ty) -> $ret_ty {
2139 $ret_ctor(Interned::new_unchecked(self.interners.$name.intern(v, |v| {
2140 InternedInSet(self.interners.arena.alloc(v))
2148 region: mk_region(RegionKind): Region -> Region<'tcx>,
2149 const_: mk_const(ConstS<'tcx>): Const -> Const<'tcx>,
2152 macro_rules! direct_interners_old {
2153 ($($name:ident: $method:ident($ty:ty),)+) => {
2154 $(impl<'tcx> Borrow<$ty> for InternedInSet<'tcx, $ty> {
2155 fn borrow<'a>(&'a self) -> &'a $ty {
2160 impl<'tcx> PartialEq for InternedInSet<'tcx, $ty> {
2161 fn eq(&self, other: &Self) -> bool {
2162 // The `Borrow` trait requires that `x.borrow() == y.borrow()`
2168 impl<'tcx> Eq for InternedInSet<'tcx, $ty> {}
2170 impl<'tcx> Hash for InternedInSet<'tcx, $ty> {
2171 fn hash<H: Hasher>(&self, s: &mut H) {
2172 // The `Borrow` trait requires that `x.borrow().hash(s) ==
2178 impl<'tcx> TyCtxt<'tcx> {
2179 pub fn $method(self, v: $ty) -> &'tcx $ty {
2180 self.interners.$name.intern(v, |v| {
2181 InternedInSet(self.interners.arena.alloc(v))
2188 // FIXME: eventually these should all be converted to `direct_interners`.
2189 direct_interners_old! {
2190 const_allocation: intern_const_alloc(Allocation),
2191 layout: intern_layout(Layout),
2192 adt_def: intern_adt_def(AdtDef),
2193 stability: intern_stability(attr::Stability),
2194 const_stability: intern_const_stability(attr::ConstStability),
2197 macro_rules! slice_interners {
2198 ($($field:ident: $method:ident($ty:ty)),+ $(,)?) => (
2199 impl<'tcx> TyCtxt<'tcx> {
2200 $(pub fn $method(self, v: &[$ty]) -> &'tcx List<$ty> {
2201 self.interners.$field.intern_ref(v, || {
2202 InternedInSet(List::from_arena(&*self.arena, v))
2210 substs: _intern_substs(GenericArg<'tcx>),
2211 canonical_var_infos: _intern_canonical_var_infos(CanonicalVarInfo<'tcx>),
2212 poly_existential_predicates:
2213 _intern_poly_existential_predicates(ty::Binder<'tcx, ExistentialPredicate<'tcx>>),
2214 predicates: _intern_predicates(Predicate<'tcx>),
2215 projs: _intern_projs(ProjectionKind),
2216 place_elems: _intern_place_elems(PlaceElem<'tcx>),
2217 bound_variable_kinds: _intern_bound_variable_kinds(ty::BoundVariableKind),
2220 impl<'tcx> TyCtxt<'tcx> {
2221 /// Given a `fn` type, returns an equivalent `unsafe fn` type;
2222 /// that is, a `fn` type that is equivalent in every way for being
2224 pub fn safe_to_unsafe_fn_ty(self, sig: PolyFnSig<'tcx>) -> Ty<'tcx> {
2225 assert_eq!(sig.unsafety(), hir::Unsafety::Normal);
2226 self.mk_fn_ptr(sig.map_bound(|sig| ty::FnSig { unsafety: hir::Unsafety::Unsafe, ..sig }))
2229 /// Given the def_id of a Trait `trait_def_id` and the name of an associated item `assoc_name`
2230 /// returns true if the `trait_def_id` defines an associated item of name `assoc_name`.
2231 pub fn trait_may_define_assoc_type(self, trait_def_id: DefId, assoc_name: Ident) -> bool {
2232 self.super_traits_of(trait_def_id).any(|trait_did| {
2233 self.associated_items(trait_did)
2234 .find_by_name_and_kind(self, assoc_name, ty::AssocKind::Type, trait_did)
2239 /// Computes the def-ids of the transitive supertraits of `trait_def_id`. This (intentionally)
2240 /// does not compute the full elaborated super-predicates but just the set of def-ids. It is used
2241 /// to identify which traits may define a given associated type to help avoid cycle errors.
2242 /// Returns a `DefId` iterator.
2243 fn super_traits_of(self, trait_def_id: DefId) -> impl Iterator<Item = DefId> + 'tcx {
2244 let mut set = FxHashSet::default();
2245 let mut stack = vec![trait_def_id];
2247 set.insert(trait_def_id);
2249 iter::from_fn(move || -> Option<DefId> {
2250 let trait_did = stack.pop()?;
2251 let generic_predicates = self.super_predicates_of(trait_did);
2253 for (predicate, _) in generic_predicates.predicates {
2254 if let ty::PredicateKind::Trait(data) = predicate.kind().skip_binder() {
2255 if set.insert(data.def_id()) {
2256 stack.push(data.def_id());
2265 /// Given a closure signature, returns an equivalent fn signature. Detuples
2266 /// and so forth -- so e.g., if we have a sig with `Fn<(u32, i32)>` then
2267 /// you would get a `fn(u32, i32)`.
2268 /// `unsafety` determines the unsafety of the fn signature. If you pass
2269 /// `hir::Unsafety::Unsafe` in the previous example, then you would get
2270 /// an `unsafe fn (u32, i32)`.
2271 /// It cannot convert a closure that requires unsafe.
2272 pub fn signature_unclosure(
2274 sig: PolyFnSig<'tcx>,
2275 unsafety: hir::Unsafety,
2276 ) -> PolyFnSig<'tcx> {
2278 let params_iter = match s.inputs()[0].kind() {
2279 ty::Tuple(params) => params.into_iter(),
2282 self.mk_fn_sig(params_iter, s.output(), s.c_variadic, unsafety, abi::Abi::Rust)
2286 /// Same a `self.mk_region(kind)`, but avoids accessing the interners if
2289 pub fn reuse_or_mk_region(self, r: Region<'tcx>, kind: RegionKind) -> Region<'tcx> {
2290 if *r == kind { r } else { self.mk_region(kind) }
2293 #[allow(rustc::usage_of_ty_tykind)]
2295 pub fn mk_ty(self, st: TyKind<'tcx>) -> Ty<'tcx> {
2296 self.interners.intern_ty(st)
2300 pub fn mk_predicate(self, binder: Binder<'tcx, PredicateKind<'tcx>>) -> Predicate<'tcx> {
2301 self.interners.intern_predicate(binder)
2305 pub fn reuse_or_mk_predicate(
2307 pred: Predicate<'tcx>,
2308 binder: Binder<'tcx, PredicateKind<'tcx>>,
2309 ) -> Predicate<'tcx> {
2310 if pred.kind() != binder { self.mk_predicate(binder) } else { pred }
2313 pub fn mk_mach_int(self, tm: IntTy) -> Ty<'tcx> {
2315 IntTy::Isize => self.types.isize,
2316 IntTy::I8 => self.types.i8,
2317 IntTy::I16 => self.types.i16,
2318 IntTy::I32 => self.types.i32,
2319 IntTy::I64 => self.types.i64,
2320 IntTy::I128 => self.types.i128,
2324 pub fn mk_mach_uint(self, tm: UintTy) -> Ty<'tcx> {
2326 UintTy::Usize => self.types.usize,
2327 UintTy::U8 => self.types.u8,
2328 UintTy::U16 => self.types.u16,
2329 UintTy::U32 => self.types.u32,
2330 UintTy::U64 => self.types.u64,
2331 UintTy::U128 => self.types.u128,
2335 pub fn mk_mach_float(self, tm: FloatTy) -> Ty<'tcx> {
2337 FloatTy::F32 => self.types.f32,
2338 FloatTy::F64 => self.types.f64,
2343 pub fn mk_static_str(self) -> Ty<'tcx> {
2344 self.mk_imm_ref(self.lifetimes.re_static, self.types.str_)
2348 pub fn mk_adt(self, def: &'tcx AdtDef, substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2349 // Take a copy of substs so that we own the vectors inside.
2350 self.mk_ty(Adt(def, substs))
2354 pub fn mk_foreign(self, def_id: DefId) -> Ty<'tcx> {
2355 self.mk_ty(Foreign(def_id))
2358 fn mk_generic_adt(self, wrapper_def_id: DefId, ty_param: Ty<'tcx>) -> Ty<'tcx> {
2359 let adt_def = self.adt_def(wrapper_def_id);
2361 InternalSubsts::for_item(self, wrapper_def_id, |param, substs| match param.kind {
2362 GenericParamDefKind::Lifetime | GenericParamDefKind::Const { .. } => bug!(),
2363 GenericParamDefKind::Type { has_default, .. } => {
2364 if param.index == 0 {
2367 assert!(has_default);
2368 self.type_of(param.def_id).subst(self, substs).into()
2372 self.mk_ty(Adt(adt_def, substs))
2376 pub fn mk_box(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2377 let def_id = self.require_lang_item(LangItem::OwnedBox, None);
2378 self.mk_generic_adt(def_id, ty)
2382 pub fn mk_lang_item(self, ty: Ty<'tcx>, item: LangItem) -> Option<Ty<'tcx>> {
2383 let def_id = self.lang_items().require(item).ok()?;
2384 Some(self.mk_generic_adt(def_id, ty))
2388 pub fn mk_diagnostic_item(self, ty: Ty<'tcx>, name: Symbol) -> Option<Ty<'tcx>> {
2389 let def_id = self.get_diagnostic_item(name)?;
2390 Some(self.mk_generic_adt(def_id, ty))
2394 pub fn mk_maybe_uninit(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2395 let def_id = self.require_lang_item(LangItem::MaybeUninit, None);
2396 self.mk_generic_adt(def_id, ty)
2400 pub fn mk_ptr(self, tm: TypeAndMut<'tcx>) -> Ty<'tcx> {
2401 self.mk_ty(RawPtr(tm))
2405 pub fn mk_ref(self, r: Region<'tcx>, tm: TypeAndMut<'tcx>) -> Ty<'tcx> {
2406 self.mk_ty(Ref(r, tm.ty, tm.mutbl))
2410 pub fn mk_mut_ref(self, r: Region<'tcx>, ty: Ty<'tcx>) -> Ty<'tcx> {
2411 self.mk_ref(r, TypeAndMut { ty, mutbl: hir::Mutability::Mut })
2415 pub fn mk_imm_ref(self, r: Region<'tcx>, ty: Ty<'tcx>) -> Ty<'tcx> {
2416 self.mk_ref(r, TypeAndMut { ty, mutbl: hir::Mutability::Not })
2420 pub fn mk_mut_ptr(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2421 self.mk_ptr(TypeAndMut { ty, mutbl: hir::Mutability::Mut })
2425 pub fn mk_imm_ptr(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2426 self.mk_ptr(TypeAndMut { ty, mutbl: hir::Mutability::Not })
2430 pub fn mk_array(self, ty: Ty<'tcx>, n: u64) -> Ty<'tcx> {
2431 self.mk_ty(Array(ty, ty::Const::from_usize(self, n)))
2435 pub fn mk_slice(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2436 self.mk_ty(Slice(ty))
2440 pub fn intern_tup(self, ts: &[Ty<'tcx>]) -> Ty<'tcx> {
2441 self.mk_ty(Tuple(self.intern_type_list(&ts)))
2444 pub fn mk_tup<I: InternAs<[Ty<'tcx>], Ty<'tcx>>>(self, iter: I) -> I::Output {
2445 iter.intern_with(|ts| self.mk_ty(Tuple(self.intern_type_list(&ts))))
2449 pub fn mk_unit(self) -> Ty<'tcx> {
2454 pub fn mk_diverging_default(self) -> Ty<'tcx> {
2455 if self.features().never_type_fallback { self.types.never } else { self.types.unit }
2459 pub fn mk_fn_def(self, def_id: DefId, substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2460 self.mk_ty(FnDef(def_id, substs))
2464 pub fn mk_fn_ptr(self, fty: PolyFnSig<'tcx>) -> Ty<'tcx> {
2465 self.mk_ty(FnPtr(fty))
2471 obj: &'tcx List<ty::Binder<'tcx, ExistentialPredicate<'tcx>>>,
2472 reg: ty::Region<'tcx>,
2474 self.mk_ty(Dynamic(obj, reg))
2478 pub fn mk_projection(self, item_def_id: DefId, substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2479 self.mk_ty(Projection(ProjectionTy { item_def_id, substs }))
2483 pub fn mk_closure(self, closure_id: DefId, closure_substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2484 self.mk_ty(Closure(closure_id, closure_substs))
2488 pub fn mk_generator(
2491 generator_substs: SubstsRef<'tcx>,
2492 movability: hir::Movability,
2494 self.mk_ty(Generator(id, generator_substs, movability))
2498 pub fn mk_generator_witness(self, types: ty::Binder<'tcx, &'tcx List<Ty<'tcx>>>) -> Ty<'tcx> {
2499 self.mk_ty(GeneratorWitness(types))
2503 pub fn mk_ty_var(self, v: TyVid) -> Ty<'tcx> {
2504 self.mk_ty_infer(TyVar(v))
2508 pub fn mk_const_var(self, v: ConstVid<'tcx>, ty: Ty<'tcx>) -> Const<'tcx> {
2509 self.mk_const(ty::ConstS { val: ty::ConstKind::Infer(InferConst::Var(v)), ty })
2513 pub fn mk_int_var(self, v: IntVid) -> Ty<'tcx> {
2514 self.mk_ty_infer(IntVar(v))
2518 pub fn mk_float_var(self, v: FloatVid) -> Ty<'tcx> {
2519 self.mk_ty_infer(FloatVar(v))
2523 pub fn mk_ty_infer(self, it: InferTy) -> Ty<'tcx> {
2524 self.mk_ty(Infer(it))
2528 pub fn mk_const_infer(self, ic: InferConst<'tcx>, ty: Ty<'tcx>) -> ty::Const<'tcx> {
2529 self.mk_const(ty::ConstS { val: ty::ConstKind::Infer(ic), ty })
2533 pub fn mk_ty_param(self, index: u32, name: Symbol) -> Ty<'tcx> {
2534 self.mk_ty(Param(ParamTy { index, name }))
2538 pub fn mk_const_param(self, index: u32, name: Symbol, ty: Ty<'tcx>) -> Const<'tcx> {
2539 self.mk_const(ty::ConstS { val: ty::ConstKind::Param(ParamConst { index, name }), ty })
2542 pub fn mk_param_from_def(self, param: &ty::GenericParamDef) -> GenericArg<'tcx> {
2544 GenericParamDefKind::Lifetime => {
2545 self.mk_region(ty::ReEarlyBound(param.to_early_bound_region_data())).into()
2547 GenericParamDefKind::Type { .. } => self.mk_ty_param(param.index, param.name).into(),
2548 GenericParamDefKind::Const { .. } => {
2549 self.mk_const_param(param.index, param.name, self.type_of(param.def_id)).into()
2555 pub fn mk_opaque(self, def_id: DefId, substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2556 self.mk_ty(Opaque(def_id, substs))
2559 pub fn mk_place_field(self, place: Place<'tcx>, f: Field, ty: Ty<'tcx>) -> Place<'tcx> {
2560 self.mk_place_elem(place, PlaceElem::Field(f, ty))
2563 pub fn mk_place_deref(self, place: Place<'tcx>) -> Place<'tcx> {
2564 self.mk_place_elem(place, PlaceElem::Deref)
2567 pub fn mk_place_downcast(
2570 adt_def: &'tcx AdtDef,
2571 variant_index: VariantIdx,
2575 PlaceElem::Downcast(Some(adt_def.variants[variant_index].name), variant_index),
2579 pub fn mk_place_downcast_unnamed(
2582 variant_index: VariantIdx,
2584 self.mk_place_elem(place, PlaceElem::Downcast(None, variant_index))
2587 pub fn mk_place_index(self, place: Place<'tcx>, index: Local) -> Place<'tcx> {
2588 self.mk_place_elem(place, PlaceElem::Index(index))
2591 /// This method copies `Place`'s projection, add an element and reintern it. Should not be used
2592 /// to build a full `Place` it's just a convenient way to grab a projection and modify it in
2594 pub fn mk_place_elem(self, place: Place<'tcx>, elem: PlaceElem<'tcx>) -> Place<'tcx> {
2595 let mut projection = place.projection.to_vec();
2596 projection.push(elem);
2598 Place { local: place.local, projection: self.intern_place_elems(&projection) }
2601 pub fn intern_poly_existential_predicates(
2603 eps: &[ty::Binder<'tcx, ExistentialPredicate<'tcx>>],
2604 ) -> &'tcx List<ty::Binder<'tcx, ExistentialPredicate<'tcx>>> {
2605 assert!(!eps.is_empty());
2608 .all(|[a, b]| a.skip_binder().stable_cmp(self, &b.skip_binder())
2609 != Ordering::Greater)
2611 self._intern_poly_existential_predicates(eps)
2614 pub fn intern_predicates(self, preds: &[Predicate<'tcx>]) -> &'tcx List<Predicate<'tcx>> {
2615 // FIXME consider asking the input slice to be sorted to avoid
2616 // re-interning permutations, in which case that would be asserted
2618 if preds.is_empty() {
2619 // The macro-generated method below asserts we don't intern an empty slice.
2622 self._intern_predicates(preds)
2626 pub fn intern_type_list(self, ts: &[Ty<'tcx>]) -> &'tcx List<Ty<'tcx>> {
2630 // Actually intern type lists as lists of `GenericArg`s.
2632 // Transmuting from `Ty<'tcx>` to `GenericArg<'tcx>` is sound
2633 // as explained in ty_slice_as_generic_arg`. With this,
2634 // we guarantee that even when transmuting between `List<Ty<'tcx>>`
2635 // and `List<GenericArg<'tcx>>`, the uniqueness requirement for
2637 let substs = self._intern_substs(ty::subst::ty_slice_as_generic_args(ts));
2638 substs.try_as_type_list().unwrap()
2642 pub fn intern_substs(self, ts: &[GenericArg<'tcx>]) -> &'tcx List<GenericArg<'tcx>> {
2643 if ts.is_empty() { List::empty() } else { self._intern_substs(ts) }
2646 pub fn intern_projs(self, ps: &[ProjectionKind]) -> &'tcx List<ProjectionKind> {
2647 if ps.is_empty() { List::empty() } else { self._intern_projs(ps) }
2650 pub fn intern_place_elems(self, ts: &[PlaceElem<'tcx>]) -> &'tcx List<PlaceElem<'tcx>> {
2651 if ts.is_empty() { List::empty() } else { self._intern_place_elems(ts) }
2654 pub fn intern_canonical_var_infos(
2656 ts: &[CanonicalVarInfo<'tcx>],
2657 ) -> CanonicalVarInfos<'tcx> {
2658 if ts.is_empty() { List::empty() } else { self._intern_canonical_var_infos(ts) }
2661 pub fn intern_bound_variable_kinds(
2663 ts: &[ty::BoundVariableKind],
2664 ) -> &'tcx List<ty::BoundVariableKind> {
2665 if ts.is_empty() { List::empty() } else { self._intern_bound_variable_kinds(ts) }
2668 pub fn mk_fn_sig<I>(
2673 unsafety: hir::Unsafety,
2675 ) -> <I::Item as InternIteratorElement<Ty<'tcx>, ty::FnSig<'tcx>>>::Output
2677 I: Iterator<Item: InternIteratorElement<Ty<'tcx>, ty::FnSig<'tcx>>>,
2679 inputs.chain(iter::once(output)).intern_with(|xs| ty::FnSig {
2680 inputs_and_output: self.intern_type_list(xs),
2687 pub fn mk_poly_existential_predicates<
2689 [ty::Binder<'tcx, ExistentialPredicate<'tcx>>],
2690 &'tcx List<ty::Binder<'tcx, ExistentialPredicate<'tcx>>>,
2696 iter.intern_with(|xs| self.intern_poly_existential_predicates(xs))
2699 pub fn mk_predicates<I: InternAs<[Predicate<'tcx>], &'tcx List<Predicate<'tcx>>>>(
2703 iter.intern_with(|xs| self.intern_predicates(xs))
2706 pub fn mk_type_list<I: InternAs<[Ty<'tcx>], &'tcx List<Ty<'tcx>>>>(self, iter: I) -> I::Output {
2707 iter.intern_with(|xs| self.intern_type_list(xs))
2710 pub fn mk_substs<I: InternAs<[GenericArg<'tcx>], &'tcx List<GenericArg<'tcx>>>>(
2714 iter.intern_with(|xs| self.intern_substs(xs))
2717 pub fn mk_place_elems<I: InternAs<[PlaceElem<'tcx>], &'tcx List<PlaceElem<'tcx>>>>(
2721 iter.intern_with(|xs| self.intern_place_elems(xs))
2724 pub fn mk_substs_trait(self, self_ty: Ty<'tcx>, rest: &[GenericArg<'tcx>]) -> SubstsRef<'tcx> {
2725 self.mk_substs(iter::once(self_ty.into()).chain(rest.iter().cloned()))
2728 pub fn mk_bound_variable_kinds<
2729 I: InternAs<[ty::BoundVariableKind], &'tcx List<ty::BoundVariableKind>>,
2734 iter.intern_with(|xs| self.intern_bound_variable_kinds(xs))
2737 /// Walks upwards from `id` to find a node which might change lint levels with attributes.
2738 /// It stops at `bound` and just returns it if reached.
2739 pub fn maybe_lint_level_root_bounded(self, mut id: HirId, bound: HirId) -> HirId {
2740 let hir = self.hir();
2746 if hir.attrs(id).iter().any(|attr| Level::from_symbol(attr.name_or_empty()).is_some()) {
2749 let next = hir.get_parent_node(id);
2751 bug!("lint traversal reached the root of the crate");
2757 pub fn lint_level_at_node(
2759 lint: &'static Lint,
2761 ) -> (Level, LintLevelSource) {
2762 let sets = self.lint_levels(());
2764 if let Some(pair) = sets.level_and_source(lint, id, self.sess) {
2767 let next = self.hir().get_parent_node(id);
2769 bug!("lint traversal reached the root of the crate");
2775 pub fn struct_span_lint_hir(
2777 lint: &'static Lint,
2779 span: impl Into<MultiSpan>,
2780 decorate: impl for<'a> FnOnce(LintDiagnosticBuilder<'a>),
2782 let (level, src) = self.lint_level_at_node(lint, hir_id);
2783 struct_lint_level(self.sess, lint, level, src, Some(span.into()), decorate);
2786 pub fn struct_lint_node(
2788 lint: &'static Lint,
2790 decorate: impl for<'a> FnOnce(LintDiagnosticBuilder<'a>),
2792 let (level, src) = self.lint_level_at_node(lint, id);
2793 struct_lint_level(self.sess, lint, level, src, None, decorate);
2796 pub fn in_scope_traits(self, id: HirId) -> Option<&'tcx [TraitCandidate]> {
2797 let map = self.in_scope_traits_map(id.owner)?;
2798 let candidates = map.get(&id.local_id)?;
2802 pub fn named_region(self, id: HirId) -> Option<resolve_lifetime::Region> {
2803 debug!(?id, "named_region");
2804 self.named_region_map(id.owner).and_then(|map| map.get(&id.local_id).cloned())
2807 pub fn is_late_bound(self, id: HirId) -> bool {
2808 self.is_late_bound_map(id.owner)
2809 .map_or(false, |(owner, set)| owner == id.owner && set.contains(&id.local_id))
2812 pub fn late_bound_vars(self, id: HirId) -> &'tcx List<ty::BoundVariableKind> {
2813 self.mk_bound_variable_kinds(
2814 self.late_bound_vars_map(id.owner)
2815 .and_then(|map| map.get(&id.local_id).cloned())
2816 .unwrap_or_else(|| {
2817 bug!("No bound vars found for {:?} ({:?})", self.hir().node_to_string(id), id)
2823 pub fn lifetime_scope(self, id: HirId) -> Option<&'tcx LifetimeScopeForPath> {
2824 self.lifetime_scope_map(id.owner).as_ref().and_then(|map| map.get(&id.local_id))
2827 /// Whether the `def_id` counts as const fn in the current crate, considering all active
2829 pub fn is_const_fn(self, def_id: DefId) -> bool {
2830 if self.is_const_fn_raw(def_id) {
2831 match self.lookup_const_stability(def_id) {
2832 Some(stability) if stability.level.is_unstable() => {
2833 // has a `rustc_const_unstable` attribute, check whether the user enabled the
2834 // corresponding feature gate.
2836 .declared_lib_features
2838 .any(|&(sym, _)| sym == stability.feature)
2840 // functions without const stability are either stable user written
2841 // const fn or the user is using feature gates and we thus don't
2842 // care what they do
2851 impl<'tcx> TyCtxtAt<'tcx> {
2852 /// Constructs a `TyKind::Error` type and registers a `delay_span_bug` to ensure it gets used.
2854 pub fn ty_error(self) -> Ty<'tcx> {
2855 self.tcx.ty_error_with_message(self.span, "TyKind::Error constructed but no error reported")
2858 /// Constructs a `TyKind::Error` type and registers a `delay_span_bug` with the given `msg to
2859 /// ensure it gets used.
2861 pub fn ty_error_with_message(self, msg: &str) -> Ty<'tcx> {
2862 self.tcx.ty_error_with_message(self.span, msg)
2866 pub trait InternAs<T: ?Sized, R> {
2868 fn intern_with<F>(self, f: F) -> Self::Output
2873 impl<I, T, R, E> InternAs<[T], R> for I
2875 E: InternIteratorElement<T, R>,
2876 I: Iterator<Item = E>,
2878 type Output = E::Output;
2879 fn intern_with<F>(self, f: F) -> Self::Output
2881 F: FnOnce(&[T]) -> R,
2883 E::intern_with(self, f)
2887 pub trait InternIteratorElement<T, R>: Sized {
2889 fn intern_with<I: Iterator<Item = Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output;
2892 impl<T, R> InternIteratorElement<T, R> for T {
2894 fn intern_with<I: Iterator<Item = Self>, F: FnOnce(&[T]) -> R>(
2898 // This code is hot enough that it's worth specializing for the most
2899 // common length lists, to avoid the overhead of `SmallVec` creation.
2900 // Lengths 0, 1, and 2 typically account for ~95% of cases. If
2901 // `size_hint` is incorrect a panic will occur via an `unwrap` or an
2903 match iter.size_hint() {
2905 assert!(iter.next().is_none());
2909 let t0 = iter.next().unwrap();
2910 assert!(iter.next().is_none());
2914 let t0 = iter.next().unwrap();
2915 let t1 = iter.next().unwrap();
2916 assert!(iter.next().is_none());
2919 _ => f(&iter.collect::<SmallVec<[_; 8]>>()),
2924 impl<'a, T, R> InternIteratorElement<T, R> for &'a T
2929 fn intern_with<I: Iterator<Item = Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output {
2930 // This code isn't hot.
2931 f(&iter.cloned().collect::<SmallVec<[_; 8]>>())
2935 impl<T, R, E> InternIteratorElement<T, R> for Result<T, E> {
2936 type Output = Result<R, E>;
2937 fn intern_with<I: Iterator<Item = Self>, F: FnOnce(&[T]) -> R>(
2941 // This code is hot enough that it's worth specializing for the most
2942 // common length lists, to avoid the overhead of `SmallVec` creation.
2943 // Lengths 0, 1, and 2 typically account for ~95% of cases. If
2944 // `size_hint` is incorrect a panic will occur via an `unwrap` or an
2945 // `assert`, unless a failure happens first, in which case the result
2946 // will be an error anyway.
2947 Ok(match iter.size_hint() {
2949 assert!(iter.next().is_none());
2953 let t0 = iter.next().unwrap()?;
2954 assert!(iter.next().is_none());
2958 let t0 = iter.next().unwrap()?;
2959 let t1 = iter.next().unwrap()?;
2960 assert!(iter.next().is_none());
2963 _ => f(&iter.collect::<Result<SmallVec<[_; 8]>, _>>()?),
2968 // We are comparing types with different invariant lifetimes, so `ptr::eq`
2969 // won't work for us.
2970 fn ptr_eq<T, U>(t: *const T, u: *const U) -> bool {
2971 t as *const () == u as *const ()
2974 pub fn provide(providers: &mut ty::query::Providers) {
2975 providers.resolutions = |tcx, ()| &tcx.untracked_resolutions;
2976 providers.module_reexports =
2977 |tcx, id| tcx.resolutions(()).reexport_map.get(&id).map(|v| &v[..]);
2978 providers.crate_name = |tcx, id| {
2979 assert_eq!(id, LOCAL_CRATE);
2982 providers.maybe_unused_trait_import =
2983 |tcx, id| tcx.resolutions(()).maybe_unused_trait_imports.contains(&id);
2984 providers.maybe_unused_extern_crates =
2985 |tcx, ()| &tcx.resolutions(()).maybe_unused_extern_crates[..];
2986 providers.names_imported_by_glob_use = |tcx, id| {
2987 tcx.arena.alloc(tcx.resolutions(()).glob_map.get(&id).cloned().unwrap_or_default())
2990 providers.lookup_stability = |tcx, id| tcx.stability().local_stability(id.expect_local());
2991 providers.lookup_const_stability =
2992 |tcx, id| tcx.stability().local_const_stability(id.expect_local());
2993 providers.lookup_deprecation_entry =
2994 |tcx, id| tcx.stability().local_deprecation_entry(id.expect_local());
2995 providers.extern_mod_stmt_cnum =
2996 |tcx, id| tcx.resolutions(()).extern_crate_map.get(&id).cloned();
2997 providers.output_filenames = |tcx, ()| &tcx.output_filenames;
2998 providers.features_query = |tcx, ()| tcx.sess.features_untracked();
2999 providers.is_panic_runtime = |tcx, cnum| {
3000 assert_eq!(cnum, LOCAL_CRATE);
3001 tcx.sess.contains_name(tcx.hir().krate_attrs(), sym::panic_runtime)
3003 providers.is_compiler_builtins = |tcx, cnum| {
3004 assert_eq!(cnum, LOCAL_CRATE);
3005 tcx.sess.contains_name(tcx.hir().krate_attrs(), sym::compiler_builtins)
3007 providers.has_panic_handler = |tcx, cnum| {
3008 assert_eq!(cnum, LOCAL_CRATE);
3009 // We want to check if the panic handler was defined in this crate
3010 tcx.lang_items().panic_impl().map_or(false, |did| did.is_local())