rustc_middle/query/
mod.rs

1//! Defines the various compiler queries.
2//!
3//! For more information on the query system, see
4//! ["Queries: demand-driven compilation"](https://rustc-dev-guide.rust-lang.org/query.html).
5//! This chapter includes instructions for adding new queries.
6
7#![allow(unused_parens)]
8
9use std::ffi::OsStr;
10use std::mem;
11use std::path::PathBuf;
12use std::sync::Arc;
13
14use rustc_arena::TypedArena;
15use rustc_ast::expand::StrippedCfgItem;
16use rustc_ast::expand::allocator::AllocatorKind;
17use rustc_data_structures::fingerprint::Fingerprint;
18use rustc_data_structures::fx::{FxIndexMap, FxIndexSet};
19use rustc_data_structures::sorted_map::SortedMap;
20use rustc_data_structures::steal::Steal;
21use rustc_data_structures::svh::Svh;
22use rustc_data_structures::unord::{UnordMap, UnordSet};
23use rustc_errors::ErrorGuaranteed;
24use rustc_hir::def::{DefKind, DocLinkResMap};
25use rustc_hir::def_id::{
26    CrateNum, DefId, DefIdMap, LocalDefId, LocalDefIdMap, LocalDefIdSet, LocalModDefId,
27};
28use rustc_hir::lang_items::{LangItem, LanguageItems};
29use rustc_hir::{Crate, ItemLocalId, ItemLocalMap, PreciseCapturingArgKind, TraitCandidate};
30use rustc_index::IndexVec;
31use rustc_lint_defs::LintId;
32use rustc_macros::rustc_queries;
33use rustc_query_system::ich::StableHashingContext;
34use rustc_query_system::query::{
35    QueryCache, QueryMode, QueryStackDeferred, QueryState, try_get_cached,
36};
37use rustc_session::Limits;
38use rustc_session::config::{EntryFnType, OptLevel, OutputFilenames, SymbolManglingVersion};
39use rustc_session::cstore::{
40    CrateDepKind, CrateSource, ExternCrate, ForeignModule, LinkagePreference, NativeLib,
41};
42use rustc_session::lint::LintExpectationId;
43use rustc_span::def_id::LOCAL_CRATE;
44use rustc_span::source_map::Spanned;
45use rustc_span::{DUMMY_SP, Span, Symbol};
46use rustc_target::spec::PanicStrategy;
47use {rustc_abi as abi, rustc_ast as ast, rustc_attr_data_structures as attr, rustc_hir as hir};
48
49use crate::infer::canonical::{self, Canonical};
50use crate::lint::LintExpectation;
51use crate::metadata::ModChild;
52use crate::middle::codegen_fn_attrs::CodegenFnAttrs;
53use crate::middle::debugger_visualizer::DebuggerVisualizerFile;
54use crate::middle::exported_symbols::{ExportedSymbol, SymbolExportInfo};
55use crate::middle::lib_features::LibFeatures;
56use crate::middle::privacy::EffectiveVisibilities;
57use crate::middle::resolve_bound_vars::{ObjectLifetimeDefault, ResolveBoundVars, ResolvedArg};
58use crate::middle::stability::{self, DeprecationEntry};
59use crate::mir::interpret::{
60    EvalStaticInitializerRawResult, EvalToAllocationRawResult, EvalToConstValueResult,
61    EvalToValTreeResult, GlobalId, LitToConstInput,
62};
63use crate::mir::mono::{CodegenUnit, CollectionMode, MonoItem, MonoItemPartitions};
64use crate::query::erase::{Erase, erase, restore};
65use crate::query::plumbing::{
66    CyclePlaceholder, DynamicQuery, query_ensure, query_ensure_error_guaranteed, query_get_at,
67};
68use crate::traits::query::{
69    CanonicalAliasGoal, CanonicalDropckOutlivesGoal, CanonicalImpliedOutlivesBoundsGoal,
70    CanonicalPredicateGoal, CanonicalTyGoal, CanonicalTypeOpAscribeUserTypeGoal,
71    CanonicalTypeOpNormalizeGoal, CanonicalTypeOpProvePredicateGoal, DropckConstraint,
72    DropckOutlivesResult, MethodAutoderefStepsResult, NoSolution, NormalizationResult,
73    OutlivesBound,
74};
75use crate::traits::{
76    CodegenObligationError, DynCompatibilityViolation, EvaluationResult, ImplSource,
77    ObligationCause, OverflowError, WellFormedLoc, specialization_graph,
78};
79use crate::ty::fast_reject::SimplifiedType;
80use crate::ty::layout::ValidityRequirement;
81use crate::ty::print::{PrintTraitRefExt, describe_as_module};
82use crate::ty::util::AlwaysRequiresDrop;
83use crate::ty::{
84    self, CrateInherentImpls, GenericArg, GenericArgsRef, PseudoCanonicalInput, Ty, TyCtxt,
85    TyCtxtFeed,
86};
87use crate::{dep_graph, mir, thir};
88
89mod arena_cached;
90pub mod erase;
91mod keys;
92pub use keys::{AsLocalKey, Key, LocalCrate};
93pub mod on_disk_cache;
94#[macro_use]
95pub mod plumbing;
96pub use plumbing::{IntoQueryParam, TyCtxtAt, TyCtxtEnsureDone, TyCtxtEnsureOk};
97
98// Each of these queries corresponds to a function pointer field in the
99// `Providers` struct for requesting a value of that type, and a method
100// on `tcx: TyCtxt` (and `tcx.at(span)`) for doing that request in a way
101// which memoizes and does dep-graph tracking, wrapping around the actual
102// `Providers` that the driver creates (using several `rustc_*` crates).
103//
104// The result type of each query must implement `Clone`, and additionally
105// `ty::query::values::Value`, which produces an appropriate placeholder
106// (error) value if the query resulted in a query cycle.
107// Queries marked with `fatal_cycle` do not need the latter implementation,
108// as they will raise an fatal error on query cycles instead.
109rustc_queries! {
110    /// This exists purely for testing the interactions between delayed bugs and incremental.
111    query trigger_delayed_bug(key: DefId) {
112        desc { "triggering a delayed bug for testing incremental" }
113    }
114
115    /// Collects the list of all tools registered using `#![register_tool]`.
116    query registered_tools(_: ()) -> &'tcx ty::RegisteredTools {
117        arena_cache
118        desc { "compute registered tools for crate" }
119    }
120
121    query early_lint_checks(_: ()) {
122        desc { "perform lints prior to AST lowering" }
123    }
124
125    /// Tracked access to environment variables.
126    ///
127    /// Useful for the implementation of `std::env!`, `proc-macro`s change
128    /// detection and other changes in the compiler's behaviour that is easier
129    /// to control with an environment variable than a flag.
130    ///
131    /// NOTE: This currently does not work with dependency info in the
132    /// analysis, codegen and linking passes, place extra code at the top of
133    /// `rustc_interface::passes::write_dep_info` to make that work.
134    query env_var_os(key: &'tcx OsStr) -> Option<&'tcx OsStr> {
135        // Environment variables are global state
136        eval_always
137        desc { "get the value of an environment variable" }
138    }
139
140    query resolutions(_: ()) -> &'tcx ty::ResolverGlobalCtxt {
141        no_hash
142        desc { "getting the resolver outputs" }
143    }
144
145    query resolver_for_lowering_raw(_: ()) -> (&'tcx Steal<(ty::ResolverAstLowering, Arc<ast::Crate>)>, &'tcx ty::ResolverGlobalCtxt) {
146        eval_always
147        no_hash
148        desc { "getting the resolver for lowering" }
149    }
150
151    /// Return the span for a definition.
152    ///
153    /// Contrary to `def_span` below, this query returns the full absolute span of the definition.
154    /// This span is meant for dep-tracking rather than diagnostics. It should not be used outside
155    /// of rustc_middle::hir::source_map.
156    query source_span(key: LocalDefId) -> Span {
157        // Accesses untracked data
158        eval_always
159        desc { "getting the source span" }
160    }
161
162    /// Represents crate as a whole (as distinct from the top-level crate module).
163    ///
164    /// If you call `tcx.hir_crate(())` we will have to assume that any change
165    /// means that you need to be recompiled. This is because the `hir_crate`
166    /// query gives you access to all other items. To avoid this fate, do not
167    /// call `tcx.hir_crate(())`; instead, prefer wrappers like
168    /// [`TyCtxt::hir_visit_all_item_likes_in_crate`].
169    query hir_crate(key: ()) -> &'tcx Crate<'tcx> {
170        arena_cache
171        eval_always
172        desc { "getting the crate HIR" }
173    }
174
175    /// All items in the crate.
176    query hir_crate_items(_: ()) -> &'tcx rustc_middle::hir::ModuleItems {
177        arena_cache
178        eval_always
179        desc { "getting HIR crate items" }
180    }
181
182    /// The items in a module.
183    ///
184    /// This can be conveniently accessed by `tcx.hir_visit_item_likes_in_module`.
185    /// Avoid calling this query directly.
186    query hir_module_items(key: LocalModDefId) -> &'tcx rustc_middle::hir::ModuleItems {
187        arena_cache
188        desc { |tcx| "getting HIR module items in `{}`", tcx.def_path_str(key) }
189        cache_on_disk_if { true }
190    }
191
192    /// Returns HIR ID for the given `LocalDefId`.
193    query local_def_id_to_hir_id(key: LocalDefId) -> hir::HirId {
194        desc { |tcx| "getting HIR ID of `{}`", tcx.def_path_str(key) }
195        feedable
196    }
197
198    /// Gives access to the HIR node's parent for the HIR owner `key`.
199    ///
200    /// This can be conveniently accessed by `tcx.hir_*` methods.
201    /// Avoid calling this query directly.
202    query hir_owner_parent(key: hir::OwnerId) -> hir::HirId {
203        desc { |tcx| "getting HIR parent of `{}`", tcx.def_path_str(key) }
204    }
205
206    /// Gives access to the HIR nodes and bodies inside `key` if it's a HIR owner.
207    ///
208    /// This can be conveniently accessed by `tcx.hir_*` methods.
209    /// Avoid calling this query directly.
210    query opt_hir_owner_nodes(key: LocalDefId) -> Option<&'tcx hir::OwnerNodes<'tcx>> {
211        desc { |tcx| "getting HIR owner items in `{}`", tcx.def_path_str(key) }
212        feedable
213    }
214
215    /// Gives access to the HIR attributes inside the HIR owner `key`.
216    ///
217    /// This can be conveniently accessed by `tcx.hir_*` methods.
218    /// Avoid calling this query directly.
219    query hir_attr_map(key: hir::OwnerId) -> &'tcx hir::AttributeMap<'tcx> {
220        desc { |tcx| "getting HIR owner attributes in `{}`", tcx.def_path_str(key) }
221        feedable
222    }
223
224    /// Returns the *default* of the const pararameter given by `DefId`.
225    ///
226    /// E.g., given `struct Ty<const N: usize = 3>;` this returns `3` for `N`.
227    query const_param_default(param: DefId) -> ty::EarlyBinder<'tcx, ty::Const<'tcx>> {
228        desc { |tcx| "computing the default for const parameter `{}`", tcx.def_path_str(param)  }
229        cache_on_disk_if { param.is_local() }
230        separate_provide_extern
231    }
232
233    /// Returns the *type* of the definition given by `DefId`.
234    ///
235    /// For type aliases (whether eager or lazy) and associated types, this returns
236    /// the underlying aliased type (not the corresponding [alias type]).
237    ///
238    /// For opaque types, this returns and thus reveals the hidden type! If you
239    /// want to detect cycle errors use `type_of_opaque` instead.
240    ///
241    /// To clarify, for type definitions, this does *not* return the "type of a type"
242    /// (aka *kind* or *sort*) in the type-theoretical sense! It merely returns
243    /// the type primarily *associated with* it.
244    ///
245    /// # Panics
246    ///
247    /// This query will panic if the given definition doesn't (and can't
248    /// conceptually) have an (underlying) type.
249    ///
250    /// [alias type]: rustc_middle::ty::AliasTy
251    query type_of(key: DefId) -> ty::EarlyBinder<'tcx, Ty<'tcx>> {
252        desc { |tcx|
253            "{action} `{path}`",
254            action = match tcx.def_kind(key) {
255                DefKind::TyAlias => "expanding type alias",
256                DefKind::TraitAlias => "expanding trait alias",
257                _ => "computing type of",
258            },
259            path = tcx.def_path_str(key),
260        }
261        cache_on_disk_if { key.is_local() }
262        separate_provide_extern
263        feedable
264    }
265
266    /// Returns the *hidden type* of the opaque type given by `DefId` unless a cycle occurred.
267    ///
268    /// This is a specialized instance of [`Self::type_of`] that detects query cycles.
269    /// Unless `CyclePlaceholder` needs to be handled separately, call [`Self::type_of`] instead.
270    /// This is used to improve the error message in cases where revealing the hidden type
271    /// for auto-trait leakage cycles.
272    ///
273    /// # Panics
274    ///
275    /// This query will panic if the given definition is not an opaque type.
276    query type_of_opaque(key: DefId) -> Result<ty::EarlyBinder<'tcx, Ty<'tcx>>, CyclePlaceholder> {
277        desc { |tcx|
278            "computing type of opaque `{path}`",
279            path = tcx.def_path_str(key),
280        }
281        cycle_stash
282    }
283    query type_of_opaque_hir_typeck(key: LocalDefId) -> ty::EarlyBinder<'tcx, Ty<'tcx>> {
284        desc { |tcx|
285            "computing type of opaque `{path}` via HIR typeck",
286            path = tcx.def_path_str(key),
287        }
288    }
289
290    /// Returns whether the type alias given by `DefId` is lazy.
291    ///
292    /// I.e., if the type alias expands / ought to expand to a [weak] [alias type]
293    /// instead of the underyling aliased type.
294    ///
295    /// Relevant for features `lazy_type_alias` and `type_alias_impl_trait`.
296    ///
297    /// # Panics
298    ///
299    /// This query *may* panic if the given definition is not a type alias.
300    ///
301    /// [weak]: rustc_middle::ty::Weak
302    /// [alias type]: rustc_middle::ty::AliasTy
303    query type_alias_is_lazy(key: DefId) -> bool {
304        desc { |tcx|
305            "computing whether the type alias `{path}` is lazy",
306            path = tcx.def_path_str(key),
307        }
308        separate_provide_extern
309    }
310
311    query collect_return_position_impl_trait_in_trait_tys(key: DefId)
312        -> Result<&'tcx DefIdMap<ty::EarlyBinder<'tcx, Ty<'tcx>>>, ErrorGuaranteed>
313    {
314        desc { "comparing an impl and trait method signature, inferring any hidden `impl Trait` types in the process" }
315        cache_on_disk_if { key.is_local() }
316        separate_provide_extern
317    }
318
319    query opaque_ty_origin(key: DefId) -> hir::OpaqueTyOrigin<DefId>
320    {
321        desc { "determine where the opaque originates from" }
322        separate_provide_extern
323    }
324
325    query unsizing_params_for_adt(key: DefId) -> &'tcx rustc_index::bit_set::DenseBitSet<u32>
326    {
327        arena_cache
328        desc { |tcx|
329            "determining what parameters of `{}` can participate in unsizing",
330            tcx.def_path_str(key),
331        }
332    }
333
334    /// The root query triggering all analysis passes like typeck or borrowck.
335    query analysis(key: ()) {
336        eval_always
337        desc { "running analysis passes on this crate" }
338    }
339
340    /// This query checks the fulfillment of collected lint expectations.
341    /// All lint emitting queries have to be done before this is executed
342    /// to ensure that all expectations can be fulfilled.
343    ///
344    /// This is an extra query to enable other drivers (like rustdoc) to
345    /// only execute a small subset of the `analysis` query, while allowing
346    /// lints to be expected. In rustc, this query will be executed as part of
347    /// the `analysis` query and doesn't have to be called a second time.
348    ///
349    /// Tools can additionally pass in a tool filter. That will restrict the
350    /// expectations to only trigger for lints starting with the listed tool
351    /// name. This is useful for cases were not all linting code from rustc
352    /// was called. With the default `None` all registered lints will also
353    /// be checked for expectation fulfillment.
354    query check_expectations(key: Option<Symbol>) {
355        eval_always
356        desc { "checking lint expectations (RFC 2383)" }
357    }
358
359    /// Returns the *generics* of the definition given by `DefId`.
360    query generics_of(key: DefId) -> &'tcx ty::Generics {
361        desc { |tcx| "computing generics of `{}`", tcx.def_path_str(key) }
362        arena_cache
363        cache_on_disk_if { key.is_local() }
364        separate_provide_extern
365        feedable
366    }
367
368    /// Returns the (elaborated) *predicates* of the definition given by `DefId`
369    /// that must be proven true at usage sites (and which can be assumed at definition site).
370    ///
371    /// This is almost always *the* "predicates query" that you want.
372    ///
373    /// **Tip**: You can use `#[rustc_dump_predicates]` on an item to basically print
374    /// the result of this query for use in UI tests or for debugging purposes.
375    query predicates_of(key: DefId) -> ty::GenericPredicates<'tcx> {
376        desc { |tcx| "computing predicates of `{}`", tcx.def_path_str(key) }
377        cache_on_disk_if { key.is_local() }
378        feedable
379    }
380
381    query opaque_types_defined_by(
382        key: LocalDefId
383    ) -> &'tcx ty::List<LocalDefId> {
384        desc {
385            |tcx| "computing the opaque types defined by `{}`",
386            tcx.def_path_str(key.to_def_id())
387        }
388    }
389
390    /// Returns the explicitly user-written *bounds* on the associated or opaque type given by `DefId`
391    /// that must be proven true at definition site (and which can be assumed at usage sites).
392    ///
393    /// For associated types, these must be satisfied for an implementation
394    /// to be well-formed, and for opaque types, these are required to be
395    /// satisfied by the hidden type of the opaque.
396    ///
397    /// Bounds from the parent (e.g. with nested `impl Trait`) are not included.
398    ///
399    /// Syntactially, these are the bounds written on associated types in trait
400    /// definitions, or those after the `impl` keyword for an opaque:
401    ///
402    /// ```ignore (illustrative)
403    /// trait Trait { type X: Bound + 'lt; }
404    /// //                    ^^^^^^^^^^^
405    /// fn function() -> impl Debug + Display { /*...*/ }
406    /// //                    ^^^^^^^^^^^^^^^
407    /// ```
408    query explicit_item_bounds(key: DefId) -> ty::EarlyBinder<'tcx, &'tcx [(ty::Clause<'tcx>, Span)]> {
409        desc { |tcx| "finding item bounds for `{}`", tcx.def_path_str(key) }
410        cache_on_disk_if { key.is_local() }
411        separate_provide_extern
412        feedable
413    }
414
415    /// Returns the explicitly user-written *bounds* that share the `Self` type of the item.
416    ///
417    /// These are a subset of the [explicit item bounds] that may explicitly be used for things
418    /// like closure signature deduction.
419    ///
420    /// [explicit item bounds]: Self::explicit_item_bounds
421    query explicit_item_self_bounds(key: DefId) -> ty::EarlyBinder<'tcx, &'tcx [(ty::Clause<'tcx>, Span)]> {
422        desc { |tcx| "finding item bounds for `{}`", tcx.def_path_str(key) }
423        cache_on_disk_if { key.is_local() }
424        separate_provide_extern
425        feedable
426    }
427
428    /// Returns the (elaborated) *bounds* on the associated or opaque type given by `DefId`
429    /// that must be proven true at definition site (and which can be assumed at usage sites).
430    ///
431    /// Bounds from the parent (e.g. with nested `impl Trait`) are not included.
432    ///
433    /// **Tip**: You can use `#[rustc_dump_item_bounds]` on an item to basically print
434    /// the result of this query for use in UI tests or for debugging purposes.
435    ///
436    /// # Examples
437    ///
438    /// ```
439    /// trait Trait { type Assoc: Eq + ?Sized; }
440    /// ```
441    ///
442    /// While [`Self::explicit_item_bounds`] returns `[<Self as Trait>::Assoc: Eq]`
443    /// here, `item_bounds` returns:
444    ///
445    /// ```text
446    /// [
447    ///     <Self as Trait>::Assoc: Eq,
448    ///     <Self as Trait>::Assoc: PartialEq<<Self as Trait>::Assoc>
449    /// ]
450    /// ```
451    query item_bounds(key: DefId) -> ty::EarlyBinder<'tcx, ty::Clauses<'tcx>> {
452        desc { |tcx| "elaborating item bounds for `{}`", tcx.def_path_str(key) }
453    }
454
455    query item_self_bounds(key: DefId) -> ty::EarlyBinder<'tcx, ty::Clauses<'tcx>> {
456        desc { |tcx| "elaborating item assumptions for `{}`", tcx.def_path_str(key) }
457    }
458
459    query item_non_self_bounds(key: DefId) -> ty::EarlyBinder<'tcx, ty::Clauses<'tcx>> {
460        desc { |tcx| "elaborating item assumptions for `{}`", tcx.def_path_str(key) }
461    }
462
463    query impl_super_outlives(key: DefId) -> ty::EarlyBinder<'tcx, ty::Clauses<'tcx>> {
464        desc { |tcx| "elaborating supertrait outlives for trait of `{}`", tcx.def_path_str(key) }
465    }
466
467    /// Look up all native libraries this crate depends on.
468    /// These are assembled from the following places:
469    /// - `extern` blocks (depending on their `link` attributes)
470    /// - the `libs` (`-l`) option
471    query native_libraries(_: CrateNum) -> &'tcx Vec<NativeLib> {
472        arena_cache
473        desc { "looking up the native libraries of a linked crate" }
474        separate_provide_extern
475    }
476
477    query shallow_lint_levels_on(key: hir::OwnerId) -> &'tcx rustc_middle::lint::ShallowLintLevelMap {
478        arena_cache
479        desc { |tcx| "looking up lint levels for `{}`", tcx.def_path_str(key) }
480    }
481
482    query lint_expectations(_: ()) -> &'tcx Vec<(LintExpectationId, LintExpectation)> {
483        arena_cache
484        desc { "computing `#[expect]`ed lints in this crate" }
485    }
486
487    query lints_that_dont_need_to_run(_: ()) -> &'tcx UnordSet<LintId> {
488        arena_cache
489        desc { "Computing all lints that are explicitly enabled or with a default level greater than Allow" }
490    }
491
492    query expn_that_defined(key: DefId) -> rustc_span::ExpnId {
493        desc { |tcx| "getting the expansion that defined `{}`", tcx.def_path_str(key) }
494        separate_provide_extern
495    }
496
497    query is_panic_runtime(_: CrateNum) -> bool {
498        fatal_cycle
499        desc { "checking if the crate is_panic_runtime" }
500        separate_provide_extern
501    }
502
503    /// Checks whether a type is representable or infinitely sized
504    query representability(_: LocalDefId) -> rustc_middle::ty::Representability {
505        desc { "checking if `{}` is representable", tcx.def_path_str(key) }
506        // infinitely sized types will cause a cycle
507        cycle_delay_bug
508        // we don't want recursive representability calls to be forced with
509        // incremental compilation because, if a cycle occurs, we need the
510        // entire cycle to be in memory for diagnostics
511        anon
512    }
513
514    /// An implementation detail for the `representability` query
515    query representability_adt_ty(_: Ty<'tcx>) -> rustc_middle::ty::Representability {
516        desc { "checking if `{}` is representable", key }
517        cycle_delay_bug
518        anon
519    }
520
521    /// Set of param indexes for type params that are in the type's representation
522    query params_in_repr(key: DefId) -> &'tcx rustc_index::bit_set::DenseBitSet<u32> {
523        desc { "finding type parameters in the representation" }
524        arena_cache
525        no_hash
526        separate_provide_extern
527    }
528
529    /// Fetch the THIR for a given body.
530    query thir_body(key: LocalDefId) -> Result<(&'tcx Steal<thir::Thir<'tcx>>, thir::ExprId), ErrorGuaranteed> {
531        // Perf tests revealed that hashing THIR is inefficient (see #85729).
532        no_hash
533        desc { |tcx| "building THIR for `{}`", tcx.def_path_str(key) }
534    }
535
536    /// Set of all the `DefId`s in this crate that have MIR associated with
537    /// them. This includes all the body owners, but also things like struct
538    /// constructors.
539    query mir_keys(_: ()) -> &'tcx rustc_data_structures::fx::FxIndexSet<LocalDefId> {
540        arena_cache
541        desc { "getting a list of all mir_keys" }
542    }
543
544    /// Maps DefId's that have an associated `mir::Body` to the result
545    /// of the MIR const-checking pass. This is the set of qualifs in
546    /// the final value of a `const`.
547    query mir_const_qualif(key: DefId) -> mir::ConstQualifs {
548        desc { |tcx| "const checking `{}`", tcx.def_path_str(key) }
549        cache_on_disk_if { key.is_local() }
550        separate_provide_extern
551    }
552
553    /// Build the MIR for a given `DefId` and prepare it for const qualification.
554    ///
555    /// See the [rustc dev guide] for more info.
556    ///
557    /// [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/mir/construction.html
558    query mir_built(key: LocalDefId) -> &'tcx Steal<mir::Body<'tcx>> {
559        desc { |tcx| "building MIR for `{}`", tcx.def_path_str(key) }
560        feedable
561    }
562
563    /// Try to build an abstract representation of the given constant.
564    query thir_abstract_const(
565        key: DefId
566    ) -> Result<Option<ty::EarlyBinder<'tcx, ty::Const<'tcx>>>, ErrorGuaranteed> {
567        desc {
568            |tcx| "building an abstract representation for `{}`", tcx.def_path_str(key),
569        }
570        separate_provide_extern
571    }
572
573    query mir_drops_elaborated_and_const_checked(key: LocalDefId) -> &'tcx Steal<mir::Body<'tcx>> {
574        no_hash
575        desc { |tcx| "elaborating drops for `{}`", tcx.def_path_str(key) }
576    }
577
578    query mir_for_ctfe(
579        key: DefId
580    ) -> &'tcx mir::Body<'tcx> {
581        desc { |tcx| "caching mir of `{}` for CTFE", tcx.def_path_str(key) }
582        cache_on_disk_if { key.is_local() }
583        separate_provide_extern
584    }
585
586    query mir_promoted(key: LocalDefId) -> (
587        &'tcx Steal<mir::Body<'tcx>>,
588        &'tcx Steal<IndexVec<mir::Promoted, mir::Body<'tcx>>>
589    ) {
590        no_hash
591        desc { |tcx| "promoting constants in MIR for `{}`", tcx.def_path_str(key) }
592    }
593
594    query closure_typeinfo(key: LocalDefId) -> ty::ClosureTypeInfo<'tcx> {
595        desc {
596            |tcx| "finding symbols for captures of closure `{}`",
597            tcx.def_path_str(key)
598        }
599    }
600
601    /// Returns names of captured upvars for closures and coroutines.
602    ///
603    /// Here are some examples:
604    ///  - `name__field1__field2` when the upvar is captured by value.
605    ///  - `_ref__name__field` when the upvar is captured by reference.
606    ///
607    /// For coroutines this only contains upvars that are shared by all states.
608    query closure_saved_names_of_captured_variables(def_id: DefId) -> &'tcx IndexVec<abi::FieldIdx, Symbol> {
609        arena_cache
610        desc { |tcx| "computing debuginfo for closure `{}`", tcx.def_path_str(def_id) }
611        separate_provide_extern
612    }
613
614    query mir_coroutine_witnesses(key: DefId) -> Option<&'tcx mir::CoroutineLayout<'tcx>> {
615        arena_cache
616        desc { |tcx| "coroutine witness types for `{}`", tcx.def_path_str(key) }
617        cache_on_disk_if { key.is_local() }
618        separate_provide_extern
619    }
620
621    query check_coroutine_obligations(key: LocalDefId) -> Result<(), ErrorGuaranteed> {
622        desc { |tcx| "verify auto trait bounds for coroutine interior type `{}`", tcx.def_path_str(key) }
623        return_result_from_ensure_ok
624    }
625
626    /// MIR after our optimization passes have run. This is MIR that is ready
627    /// for codegen. This is also the only query that can fetch non-local MIR, at present.
628    query optimized_mir(key: DefId) -> &'tcx mir::Body<'tcx> {
629        desc { |tcx| "optimizing MIR for `{}`", tcx.def_path_str(key) }
630        cache_on_disk_if { key.is_local() }
631        separate_provide_extern
632    }
633
634    /// Checks for the nearest `#[coverage(off)]` or `#[coverage(on)]` on
635    /// this def and any enclosing defs, up to the crate root.
636    ///
637    /// Returns `false` if `#[coverage(off)]` was found, or `true` if
638    /// either `#[coverage(on)]` or no coverage attribute was found.
639    query coverage_attr_on(key: LocalDefId) -> bool {
640        desc { |tcx| "checking for `#[coverage(..)]` on `{}`", tcx.def_path_str(key) }
641        feedable
642    }
643
644    /// Scans through a function's MIR after MIR optimizations, to prepare the
645    /// information needed by codegen when `-Cinstrument-coverage` is active.
646    ///
647    /// This includes the details of where to insert `llvm.instrprof.increment`
648    /// intrinsics, and the expression tables to be embedded in the function's
649    /// coverage metadata.
650    ///
651    /// FIXME(Zalathar): This query's purpose has drifted a bit and should
652    /// probably be renamed, but that can wait until after the potential
653    /// follow-ups to #136053 have settled down.
654    ///
655    /// Returns `None` for functions that were not instrumented.
656    query coverage_ids_info(key: ty::InstanceKind<'tcx>) -> Option<&'tcx mir::coverage::CoverageIdsInfo> {
657        desc { |tcx| "retrieving coverage IDs info from MIR for `{}`", tcx.def_path_str(key.def_id()) }
658        arena_cache
659    }
660
661    /// The `DefId` is the `DefId` of the containing MIR body. Promoteds do not have their own
662    /// `DefId`. This function returns all promoteds in the specified body. The body references
663    /// promoteds by the `DefId` and the `mir::Promoted` index. This is necessary, because
664    /// after inlining a body may refer to promoteds from other bodies. In that case you still
665    /// need to use the `DefId` of the original body.
666    query promoted_mir(key: DefId) -> &'tcx IndexVec<mir::Promoted, mir::Body<'tcx>> {
667        desc { |tcx| "optimizing promoted MIR for `{}`", tcx.def_path_str(key) }
668        cache_on_disk_if { key.is_local() }
669        separate_provide_extern
670    }
671
672    /// Erases regions from `ty` to yield a new type.
673    /// Normally you would just use `tcx.erase_regions(value)`,
674    /// however, which uses this query as a kind of cache.
675    query erase_regions_ty(ty: Ty<'tcx>) -> Ty<'tcx> {
676        // This query is not expected to have input -- as a result, it
677        // is not a good candidates for "replay" because it is essentially a
678        // pure function of its input (and hence the expectation is that
679        // no caller would be green **apart** from just these
680        // queries). Making it anonymous avoids hashing the result, which
681        // may save a bit of time.
682        anon
683        desc { "erasing regions from `{}`", ty }
684    }
685
686    query wasm_import_module_map(_: CrateNum) -> &'tcx DefIdMap<String> {
687        arena_cache
688        desc { "getting wasm import module map" }
689    }
690
691    /// Returns the explicitly user-written *predicates and bounds* of the trait given by `DefId`.
692    ///
693    /// Traits are unusual, because predicates on associated types are
694    /// converted into bounds on that type for backwards compatibility:
695    ///
696    /// ```
697    /// trait X where Self::U: Copy { type U; }
698    /// ```
699    ///
700    /// becomes
701    ///
702    /// ```
703    /// trait X { type U: Copy; }
704    /// ```
705    ///
706    /// [`Self::explicit_predicates_of`] and [`Self::explicit_item_bounds`] will
707    /// then take the appropriate subsets of the predicates here.
708    ///
709    /// # Panics
710    ///
711    /// This query will panic if the given definition is not a trait.
712    query trait_explicit_predicates_and_bounds(key: LocalDefId) -> ty::GenericPredicates<'tcx> {
713        desc { |tcx| "computing explicit predicates of trait `{}`", tcx.def_path_str(key) }
714    }
715
716    /// Returns the explicitly user-written *predicates* of the definition given by `DefId`
717    /// that must be proven true at usage sites (and which can be assumed at definition site).
718    ///
719    /// You should probably use [`Self::predicates_of`] unless you're looking for
720    /// predicates with explicit spans for diagnostics purposes.
721    query explicit_predicates_of(key: DefId) -> ty::GenericPredicates<'tcx> {
722        desc { |tcx| "computing explicit predicates of `{}`", tcx.def_path_str(key) }
723        cache_on_disk_if { key.is_local() }
724        separate_provide_extern
725        feedable
726    }
727
728    /// Returns the *inferred outlives-predicates* of the item given by `DefId`.
729    ///
730    /// E.g., for `struct Foo<'a, T> { x: &'a T }`, this would return `[T: 'a]`.
731    ///
732    /// **Tip**: You can use `#[rustc_outlives]` on an item to basically print the
733    /// result of this query for use in UI tests or for debugging purposes.
734    query inferred_outlives_of(key: DefId) -> &'tcx [(ty::Clause<'tcx>, Span)] {
735        desc { |tcx| "computing inferred outlives-predicates of `{}`", tcx.def_path_str(key) }
736        cache_on_disk_if { key.is_local() }
737        separate_provide_extern
738        feedable
739    }
740
741    /// Returns the explicitly user-written *super-predicates* of the trait given by `DefId`.
742    ///
743    /// These predicates are unelaborated and consequently don't contain transitive super-predicates.
744    ///
745    /// This is a subset of the full list of predicates. We store these in a separate map
746    /// because we must evaluate them even during type conversion, often before the full
747    /// predicates are available (note that super-predicates must not be cyclic).
748    query explicit_super_predicates_of(key: DefId) -> ty::EarlyBinder<'tcx, &'tcx [(ty::Clause<'tcx>, Span)]> {
749        desc { |tcx| "computing the super predicates of `{}`", tcx.def_path_str(key) }
750        cache_on_disk_if { key.is_local() }
751        separate_provide_extern
752    }
753
754    /// The predicates of the trait that are implied during elaboration.
755    ///
756    /// This is a superset of the super-predicates of the trait, but a subset of the predicates
757    /// of the trait. For regular traits, this includes all super-predicates and their
758    /// associated type bounds. For trait aliases, currently, this includes all of the
759    /// predicates of the trait alias.
760    query explicit_implied_predicates_of(key: DefId) -> ty::EarlyBinder<'tcx, &'tcx [(ty::Clause<'tcx>, Span)]> {
761        desc { |tcx| "computing the implied predicates of `{}`", tcx.def_path_str(key) }
762        cache_on_disk_if { key.is_local() }
763        separate_provide_extern
764    }
765
766    /// The Ident is the name of an associated type.The query returns only the subset
767    /// of supertraits that define the given associated type. This is used to avoid
768    /// cycles in resolving type-dependent associated item paths like `T::Item`.
769    query explicit_supertraits_containing_assoc_item(
770        key: (DefId, rustc_span::Ident)
771    ) -> ty::EarlyBinder<'tcx, &'tcx [(ty::Clause<'tcx>, Span)]> {
772        desc { |tcx| "computing the super traits of `{}` with associated type name `{}`",
773            tcx.def_path_str(key.0),
774            key.1
775        }
776    }
777
778    /// Compute the conditions that need to hold for a conditionally-const item to be const.
779    /// That is, compute the set of `~const` where clauses for a given item.
780    ///
781    /// This can be thought of as the `~const` equivalent of `predicates_of`. These are the
782    /// predicates that need to be proven at usage sites, and can be assumed at definition.
783    ///
784    /// This query also computes the `~const` where clauses for associated types, which are
785    /// not "const", but which have item bounds which may be `~const`. These must hold for
786    /// the `~const` item bound to hold.
787    query const_conditions(
788        key: DefId
789    ) -> ty::ConstConditions<'tcx> {
790        desc { |tcx| "computing the conditions for `{}` to be considered const",
791            tcx.def_path_str(key)
792        }
793        separate_provide_extern
794    }
795
796    /// Compute the const bounds that are implied for a conditionally-const item.
797    ///
798    /// This can be though of as the `~const` equivalent of `explicit_item_bounds`. These
799    /// are the predicates that need to proven at definition sites, and can be assumed at
800    /// usage sites.
801    query explicit_implied_const_bounds(
802        key: DefId
803    ) -> ty::EarlyBinder<'tcx, &'tcx [(ty::PolyTraitRef<'tcx>, Span)]> {
804        desc { |tcx| "computing the implied `~const` bounds for `{}`",
805            tcx.def_path_str(key)
806        }
807        separate_provide_extern
808    }
809
810    /// To avoid cycles within the predicates of a single item we compute
811    /// per-type-parameter predicates for resolving `T::AssocTy`.
812    query type_param_predicates(
813        key: (LocalDefId, LocalDefId, rustc_span::Ident)
814    ) -> ty::EarlyBinder<'tcx, &'tcx [(ty::Clause<'tcx>, Span)]> {
815        desc { |tcx| "computing the bounds for type parameter `{}`", tcx.hir_ty_param_name(key.1) }
816    }
817
818    query trait_def(key: DefId) -> &'tcx ty::TraitDef {
819        desc { |tcx| "computing trait definition for `{}`", tcx.def_path_str(key) }
820        arena_cache
821        cache_on_disk_if { key.is_local() }
822        separate_provide_extern
823    }
824    query adt_def(key: DefId) -> ty::AdtDef<'tcx> {
825        desc { |tcx| "computing ADT definition for `{}`", tcx.def_path_str(key) }
826        cache_on_disk_if { key.is_local() }
827        separate_provide_extern
828    }
829    query adt_destructor(key: DefId) -> Option<ty::Destructor> {
830        desc { |tcx| "computing `Drop` impl for `{}`", tcx.def_path_str(key) }
831        cache_on_disk_if { key.is_local() }
832        separate_provide_extern
833    }
834    query adt_async_destructor(key: DefId) -> Option<ty::AsyncDestructor> {
835        desc { |tcx| "computing `AsyncDrop` impl for `{}`", tcx.def_path_str(key) }
836        cache_on_disk_if { key.is_local() }
837        separate_provide_extern
838    }
839
840    query adt_sized_constraint(key: DefId) -> Option<ty::EarlyBinder<'tcx, Ty<'tcx>>> {
841        desc { |tcx| "computing the `Sized` constraint for `{}`", tcx.def_path_str(key) }
842    }
843
844    query adt_dtorck_constraint(
845        key: DefId
846    ) -> &'tcx DropckConstraint<'tcx> {
847        desc { |tcx| "computing drop-check constraints for `{}`", tcx.def_path_str(key) }
848    }
849
850    /// Returns the constness of the function-like[^1] definition given by `DefId`.
851    ///
852    /// Tuple struct/variant constructors are *always* const, foreign functions are
853    /// *never* const. The rest is const iff marked with keyword `const` (or rather
854    /// its parent in the case of associated functions).
855    ///
856    /// <div class="warning">
857    ///
858    /// **Do not call this query** directly. It is only meant to cache the base data for the
859    /// higher-level functions. Consider using `is_const_fn` or `is_const_trait_impl` instead.
860    ///
861    /// Also note that neither of them takes into account feature gates, stability and
862    /// const predicates/conditions!
863    ///
864    /// </div>
865    ///
866    /// # Panics
867    ///
868    /// This query will panic if the given definition is not function-like[^1].
869    ///
870    /// [^1]: Tuple struct/variant constructors, closures and free, associated and foreign functions.
871    query constness(key: DefId) -> hir::Constness {
872        desc { |tcx| "checking if item is const: `{}`", tcx.def_path_str(key) }
873        separate_provide_extern
874        feedable
875    }
876
877    query asyncness(key: DefId) -> ty::Asyncness {
878        desc { |tcx| "checking if the function is async: `{}`", tcx.def_path_str(key) }
879        separate_provide_extern
880    }
881
882    /// Returns `true` if calls to the function may be promoted.
883    ///
884    /// This is either because the function is e.g., a tuple-struct or tuple-variant
885    /// constructor, or because it has the `#[rustc_promotable]` attribute. The attribute should
886    /// be removed in the future in favour of some form of check which figures out whether the
887    /// function does not inspect the bits of any of its arguments (so is essentially just a
888    /// constructor function).
889    query is_promotable_const_fn(key: DefId) -> bool {
890        desc { |tcx| "checking if item is promotable: `{}`", tcx.def_path_str(key) }
891    }
892
893    /// The body of the coroutine, modified to take its upvars by move rather than by ref.
894    ///
895    /// This is used by coroutine-closures, which must return a different flavor of coroutine
896    /// when called using `AsyncFnOnce::call_once`. It is produced by the `ByMoveBody` pass which
897    /// is run right after building the initial MIR, and will only be populated for coroutines
898    /// which come out of the async closure desugaring.
899    query coroutine_by_move_body_def_id(def_id: DefId) -> DefId {
900        desc { |tcx| "looking up the coroutine by-move body for `{}`", tcx.def_path_str(def_id) }
901        separate_provide_extern
902    }
903
904    /// Returns `Some(coroutine_kind)` if the node pointed to by `def_id` is a coroutine.
905    query coroutine_kind(def_id: DefId) -> Option<hir::CoroutineKind> {
906        desc { |tcx| "looking up coroutine kind of `{}`", tcx.def_path_str(def_id) }
907        separate_provide_extern
908        feedable
909    }
910
911    query coroutine_for_closure(def_id: DefId) -> DefId {
912        desc { |_tcx| "Given a coroutine-closure def id, return the def id of the coroutine returned by it" }
913        separate_provide_extern
914    }
915
916    /// Gets a map with the variances of every item in the local crate.
917    ///
918    /// <div class="warning">
919    ///
920    /// **Do not call this query** directly, use [`Self::variances_of`] instead.
921    ///
922    /// </div>
923    query crate_variances(_: ()) -> &'tcx ty::CrateVariancesMap<'tcx> {
924        arena_cache
925        desc { "computing the variances for items in this crate" }
926    }
927
928    /// Returns the (inferred) variances of the item given by `DefId`.
929    ///
930    /// The list of variances corresponds to the list of (early-bound) generic
931    /// parameters of the item (including its parents).
932    ///
933    /// **Tip**: You can use `#[rustc_variance]` on an item to basically print the
934    /// result of this query for use in UI tests or for debugging purposes.
935    query variances_of(def_id: DefId) -> &'tcx [ty::Variance] {
936        desc { |tcx| "computing the variances of `{}`", tcx.def_path_str(def_id) }
937        cache_on_disk_if { def_id.is_local() }
938        separate_provide_extern
939        cycle_delay_bug
940    }
941
942    /// Gets a map with the inferred outlives-predicates of every item in the local crate.
943    ///
944    /// <div class="warning">
945    ///
946    /// **Do not call this query** directly, use [`Self::inferred_outlives_of`] instead.
947    ///
948    /// </div>
949    query inferred_outlives_crate(_: ()) -> &'tcx ty::CratePredicatesMap<'tcx> {
950        arena_cache
951        desc { "computing the inferred outlives-predicates for items in this crate" }
952    }
953
954    /// Maps from an impl/trait or struct/variant `DefId`
955    /// to a list of the `DefId`s of its associated items or fields.
956    query associated_item_def_ids(key: DefId) -> &'tcx [DefId] {
957        desc { |tcx| "collecting associated items or fields of `{}`", tcx.def_path_str(key) }
958        cache_on_disk_if { key.is_local() }
959        separate_provide_extern
960    }
961
962    /// Maps from a trait/impl item to the trait/impl item "descriptor".
963    query associated_item(key: DefId) -> ty::AssocItem {
964        desc { |tcx| "computing associated item data for `{}`", tcx.def_path_str(key) }
965        cache_on_disk_if { key.is_local() }
966        separate_provide_extern
967        feedable
968    }
969
970    /// Collects the associated items defined on a trait or impl.
971    query associated_items(key: DefId) -> &'tcx ty::AssocItems {
972        arena_cache
973        desc { |tcx| "collecting associated items of `{}`", tcx.def_path_str(key) }
974    }
975
976    /// Maps from associated items on a trait to the corresponding associated
977    /// item on the impl specified by `impl_id`.
978    ///
979    /// For example, with the following code
980    ///
981    /// ```
982    /// struct Type {}
983    ///                         // DefId
984    /// trait Trait {           // trait_id
985    ///     fn f();             // trait_f
986    ///     fn g() {}           // trait_g
987    /// }
988    ///
989    /// impl Trait for Type {   // impl_id
990    ///     fn f() {}           // impl_f
991    ///     fn g() {}           // impl_g
992    /// }
993    /// ```
994    ///
995    /// The map returned for `tcx.impl_item_implementor_ids(impl_id)` would be
996    ///`{ trait_f: impl_f, trait_g: impl_g }`
997    query impl_item_implementor_ids(impl_id: DefId) -> &'tcx DefIdMap<DefId> {
998        arena_cache
999        desc { |tcx| "comparing impl items against trait for `{}`", tcx.def_path_str(impl_id) }
1000    }
1001
1002    /// Given `fn_def_id` of a trait or of an impl that implements a given trait:
1003    /// if `fn_def_id` is the def id of a function defined inside a trait, then it creates and returns
1004    /// the associated items that correspond to each impl trait in return position for that trait.
1005    /// if `fn_def_id` is the def id of a function defined inside an impl that implements a trait, then it
1006    /// creates and returns the associated items that correspond to each impl trait in return position
1007    /// of the implemented trait.
1008    query associated_types_for_impl_traits_in_associated_fn(fn_def_id: DefId) -> &'tcx [DefId] {
1009        desc { |tcx| "creating associated items for opaque types returned by `{}`", tcx.def_path_str(fn_def_id) }
1010        cache_on_disk_if { fn_def_id.is_local() }
1011        separate_provide_extern
1012    }
1013
1014    /// Given an impl trait in trait `opaque_ty_def_id`, create and return the corresponding
1015    /// associated item.
1016    query associated_type_for_impl_trait_in_trait(opaque_ty_def_id: LocalDefId) -> LocalDefId {
1017        desc { |tcx| "creating the associated item corresponding to the opaque type `{}`", tcx.def_path_str(opaque_ty_def_id.to_def_id()) }
1018        cache_on_disk_if { true }
1019    }
1020
1021    /// Given an `impl_id`, return the trait it implements along with some header information.
1022    /// Return `None` if this is an inherent impl.
1023    query impl_trait_header(impl_id: DefId) -> Option<ty::ImplTraitHeader<'tcx>> {
1024        desc { |tcx| "computing trait implemented by `{}`", tcx.def_path_str(impl_id) }
1025        cache_on_disk_if { impl_id.is_local() }
1026        separate_provide_extern
1027    }
1028
1029    /// Given an `impl_def_id`, return true if the self type is guaranteed to be unsized due
1030    /// to either being one of the built-in unsized types (str/slice/dyn) or to be a struct
1031    /// whose tail is one of those types.
1032    query impl_self_is_guaranteed_unsized(impl_def_id: DefId) -> bool {
1033        desc { |tcx| "computing whether `{}` has a guaranteed unsized self type", tcx.def_path_str(impl_def_id) }
1034    }
1035
1036    /// Maps a `DefId` of a type to a list of its inherent impls.
1037    /// Contains implementations of methods that are inherent to a type.
1038    /// Methods in these implementations don't need to be exported.
1039    query inherent_impls(key: DefId) -> &'tcx [DefId] {
1040        desc { |tcx| "collecting inherent impls for `{}`", tcx.def_path_str(key) }
1041        cache_on_disk_if { key.is_local() }
1042        separate_provide_extern
1043    }
1044
1045    query incoherent_impls(key: SimplifiedType) -> &'tcx [DefId] {
1046        desc { |tcx| "collecting all inherent impls for `{:?}`", key }
1047    }
1048
1049    /// Unsafety-check this `LocalDefId`.
1050    query check_unsafety(key: LocalDefId) {
1051        desc { |tcx| "unsafety-checking `{}`", tcx.def_path_str(key) }
1052    }
1053
1054    /// Checks well-formedness of tail calls (`become f()`).
1055    query check_tail_calls(key: LocalDefId) -> Result<(), rustc_errors::ErrorGuaranteed> {
1056        desc { |tcx| "tail-call-checking `{}`", tcx.def_path_str(key) }
1057        return_result_from_ensure_ok
1058    }
1059
1060    /// Returns the types assumed to be well formed while "inside" of the given item.
1061    ///
1062    /// Note that we've liberated the late bound regions of function signatures, so
1063    /// this can not be used to check whether these types are well formed.
1064    query assumed_wf_types(key: LocalDefId) -> &'tcx [(Ty<'tcx>, Span)] {
1065        desc { |tcx| "computing the implied bounds of `{}`", tcx.def_path_str(key) }
1066    }
1067
1068    /// We need to store the assumed_wf_types for an RPITIT so that impls of foreign
1069    /// traits with return-position impl trait in traits can inherit the right wf types.
1070    query assumed_wf_types_for_rpitit(key: DefId) -> &'tcx [(Ty<'tcx>, Span)] {
1071        desc { |tcx| "computing the implied bounds of `{}`", tcx.def_path_str(key) }
1072        separate_provide_extern
1073    }
1074
1075    /// Computes the signature of the function.
1076    query fn_sig(key: DefId) -> ty::EarlyBinder<'tcx, ty::PolyFnSig<'tcx>> {
1077        desc { |tcx| "computing function signature of `{}`", tcx.def_path_str(key) }
1078        cache_on_disk_if { key.is_local() }
1079        separate_provide_extern
1080        cycle_delay_bug
1081    }
1082
1083    /// Performs lint checking for the module.
1084    query lint_mod(key: LocalModDefId) {
1085        desc { |tcx| "linting {}", describe_as_module(key, tcx) }
1086    }
1087
1088    query check_unused_traits(_: ()) {
1089        desc { "checking unused trait imports in crate" }
1090    }
1091
1092    /// Checks the attributes in the module.
1093    query check_mod_attrs(key: LocalModDefId) {
1094        desc { |tcx| "checking attributes in {}", describe_as_module(key, tcx) }
1095    }
1096
1097    /// Checks for uses of unstable APIs in the module.
1098    query check_mod_unstable_api_usage(key: LocalModDefId) {
1099        desc { |tcx| "checking for unstable API usage in {}", describe_as_module(key, tcx) }
1100    }
1101
1102    /// Checks the loops in the module.
1103    query check_mod_loops(key: LocalModDefId) {
1104        desc { |tcx| "checking loops in {}", describe_as_module(key, tcx) }
1105    }
1106
1107    query check_mod_naked_functions(key: LocalModDefId) {
1108        desc { |tcx| "checking naked functions in {}", describe_as_module(key, tcx) }
1109    }
1110
1111    query check_mod_privacy(key: LocalModDefId) {
1112        desc { |tcx| "checking privacy in {}", describe_as_module(key.to_local_def_id(), tcx) }
1113    }
1114
1115    query check_liveness(key: LocalDefId) {
1116        desc { |tcx| "checking liveness of variables in `{}`", tcx.def_path_str(key) }
1117    }
1118
1119    /// Return the live symbols in the crate for dead code check.
1120    ///
1121    /// The second return value maps from ADTs to ignored derived traits (e.g. Debug and Clone) and
1122    /// their respective impl (i.e., part of the derive macro)
1123    query live_symbols_and_ignored_derived_traits(_: ()) -> &'tcx (
1124        LocalDefIdSet,
1125        LocalDefIdMap<Vec<(DefId, DefId)>>
1126    ) {
1127        arena_cache
1128        desc { "finding live symbols in crate" }
1129    }
1130
1131    query check_mod_deathness(key: LocalModDefId) {
1132        desc { |tcx| "checking deathness of variables in {}", describe_as_module(key, tcx) }
1133    }
1134
1135    query check_mod_type_wf(key: LocalModDefId) -> Result<(), ErrorGuaranteed> {
1136        desc { |tcx| "checking that types are well-formed in {}", describe_as_module(key, tcx) }
1137        return_result_from_ensure_ok
1138    }
1139
1140    /// Caches `CoerceUnsized` kinds for impls on custom types.
1141    query coerce_unsized_info(key: DefId) -> Result<ty::adjustment::CoerceUnsizedInfo, ErrorGuaranteed> {
1142        desc { |tcx| "computing CoerceUnsized info for `{}`", tcx.def_path_str(key) }
1143        cache_on_disk_if { key.is_local() }
1144        separate_provide_extern
1145        return_result_from_ensure_ok
1146    }
1147
1148    query typeck(key: LocalDefId) -> &'tcx ty::TypeckResults<'tcx> {
1149        desc { |tcx| "type-checking `{}`", tcx.def_path_str(key) }
1150        cache_on_disk_if(tcx) { !tcx.is_typeck_child(key.to_def_id()) }
1151    }
1152
1153    query used_trait_imports(key: LocalDefId) -> &'tcx UnordSet<LocalDefId> {
1154        desc { |tcx| "finding used_trait_imports `{}`", tcx.def_path_str(key) }
1155        cache_on_disk_if { true }
1156    }
1157
1158    query coherent_trait(def_id: DefId) -> Result<(), ErrorGuaranteed> {
1159        desc { |tcx| "coherence checking all impls of trait `{}`", tcx.def_path_str(def_id) }
1160        return_result_from_ensure_ok
1161    }
1162
1163    /// Borrow-checks the given typeck root, e.g. functions, const/static items,
1164    /// and its children, e.g. closures, inline consts.
1165    query mir_borrowck(key: LocalDefId) -> Result<&'tcx mir::ConcreteOpaqueTypes<'tcx>, ErrorGuaranteed> {
1166        desc { |tcx| "borrow-checking `{}`", tcx.def_path_str(key) }
1167    }
1168
1169    /// Gets a complete map from all types to their inherent impls.
1170    ///
1171    /// <div class="warning">
1172    ///
1173    /// **Not meant to be used** directly outside of coherence.
1174    ///
1175    /// </div>
1176    query crate_inherent_impls(k: ()) -> (&'tcx CrateInherentImpls, Result<(), ErrorGuaranteed>) {
1177        desc { "finding all inherent impls defined in crate" }
1178    }
1179
1180    /// Checks all types in the crate for overlap in their inherent impls. Reports errors.
1181    ///
1182    /// <div class="warning">
1183    ///
1184    /// **Not meant to be used** directly outside of coherence.
1185    ///
1186    /// </div>
1187    query crate_inherent_impls_validity_check(_: ()) -> Result<(), ErrorGuaranteed> {
1188        desc { "check for inherent impls that should not be defined in crate" }
1189        return_result_from_ensure_ok
1190    }
1191
1192    /// Checks all types in the crate for overlap in their inherent impls. Reports errors.
1193    ///
1194    /// <div class="warning">
1195    ///
1196    /// **Not meant to be used** directly outside of coherence.
1197    ///
1198    /// </div>
1199    query crate_inherent_impls_overlap_check(_: ()) -> Result<(), ErrorGuaranteed> {
1200        desc { "check for overlap between inherent impls defined in this crate" }
1201        return_result_from_ensure_ok
1202    }
1203
1204    /// Checks whether all impls in the crate pass the overlap check, returning
1205    /// which impls fail it. If all impls are correct, the returned slice is empty.
1206    query orphan_check_impl(key: LocalDefId) -> Result<(), ErrorGuaranteed> {
1207        desc { |tcx|
1208            "checking whether impl `{}` follows the orphan rules",
1209            tcx.def_path_str(key),
1210        }
1211        return_result_from_ensure_ok
1212    }
1213
1214    /// Check whether the function has any recursion that could cause the inliner to trigger
1215    /// a cycle.
1216    query mir_callgraph_reachable(key: (ty::Instance<'tcx>, LocalDefId)) -> bool {
1217        fatal_cycle
1218        desc { |tcx|
1219            "computing if `{}` (transitively) calls `{}`",
1220            key.0,
1221            tcx.def_path_str(key.1),
1222        }
1223    }
1224
1225    /// Obtain all the calls into other local functions
1226    query mir_inliner_callees(key: ty::InstanceKind<'tcx>) -> &'tcx [(DefId, GenericArgsRef<'tcx>)] {
1227        fatal_cycle
1228        desc { |tcx|
1229            "computing all local function calls in `{}`",
1230            tcx.def_path_str(key.def_id()),
1231        }
1232    }
1233
1234    /// Computes the tag (if any) for a given type and variant.
1235    ///
1236    /// `None` means that the variant doesn't need a tag (because it is niched).
1237    ///
1238    /// # Panics
1239    ///
1240    /// This query will panic for uninhabited variants and if the passed type is not an enum.
1241    query tag_for_variant(
1242        key: (Ty<'tcx>, abi::VariantIdx)
1243    ) -> Option<ty::ScalarInt> {
1244        desc { "computing variant tag for enum" }
1245    }
1246
1247    /// Evaluates a constant and returns the computed allocation.
1248    ///
1249    /// <div class="warning">
1250    ///
1251    /// **Do not call this query** directly, use [`Self::eval_to_const_value_raw`] or
1252    /// [`Self::eval_to_valtree`] instead.
1253    ///
1254    /// </div>
1255    query eval_to_allocation_raw(key: ty::PseudoCanonicalInput<'tcx, GlobalId<'tcx>>)
1256        -> EvalToAllocationRawResult<'tcx> {
1257        desc { |tcx|
1258            "const-evaluating + checking `{}`",
1259            key.value.display(tcx)
1260        }
1261        cache_on_disk_if { true }
1262    }
1263
1264    /// Evaluate a static's initializer, returning the allocation of the initializer's memory.
1265    query eval_static_initializer(key: DefId) -> EvalStaticInitializerRawResult<'tcx> {
1266        desc { |tcx|
1267            "evaluating initializer of static `{}`",
1268            tcx.def_path_str(key)
1269        }
1270        cache_on_disk_if { key.is_local() }
1271        separate_provide_extern
1272        feedable
1273    }
1274
1275    /// Evaluates const items or anonymous constants[^1] into a representation
1276    /// suitable for the type system and const generics.
1277    ///
1278    /// <div class="warning">
1279    ///
1280    /// **Do not call this** directly, use one of the following wrappers:
1281    /// [`TyCtxt::const_eval_poly`], [`TyCtxt::const_eval_resolve`],
1282    /// [`TyCtxt::const_eval_instance`], or [`TyCtxt::const_eval_global_id`].
1283    ///
1284    /// </div>
1285    ///
1286    /// [^1]: Such as enum variant explicit discriminants or array lengths.
1287    query eval_to_const_value_raw(key: ty::PseudoCanonicalInput<'tcx, GlobalId<'tcx>>)
1288        -> EvalToConstValueResult<'tcx> {
1289        desc { |tcx|
1290            "simplifying constant for the type system `{}`",
1291            key.value.display(tcx)
1292        }
1293        depth_limit
1294        cache_on_disk_if { true }
1295    }
1296
1297    /// Evaluate a constant and convert it to a type level constant or
1298    /// return `None` if that is not possible.
1299    query eval_to_valtree(
1300        key: ty::PseudoCanonicalInput<'tcx, GlobalId<'tcx>>
1301    ) -> EvalToValTreeResult<'tcx> {
1302        desc { "evaluating type-level constant" }
1303    }
1304
1305    /// Converts a type-level constant value into a MIR constant value.
1306    query valtree_to_const_val(key: ty::Value<'tcx>) -> mir::ConstValue<'tcx> {
1307        desc { "converting type-level constant value to MIR constant value"}
1308    }
1309
1310    /// Destructures array, ADT or tuple constants into the constants
1311    /// of their fields.
1312    query destructure_const(key: ty::Const<'tcx>) -> ty::DestructuredConst<'tcx> {
1313        desc { "destructuring type level constant"}
1314    }
1315
1316    // FIXME get rid of this with valtrees
1317    query lit_to_const(
1318        key: LitToConstInput<'tcx>
1319    ) -> ty::Const<'tcx> {
1320        desc { "converting literal to const" }
1321    }
1322
1323    query check_match(key: LocalDefId) -> Result<(), rustc_errors::ErrorGuaranteed> {
1324        desc { |tcx| "match-checking `{}`", tcx.def_path_str(key) }
1325        return_result_from_ensure_ok
1326    }
1327
1328    /// Performs part of the privacy check and computes effective visibilities.
1329    query effective_visibilities(_: ()) -> &'tcx EffectiveVisibilities {
1330        eval_always
1331        desc { "checking effective visibilities" }
1332    }
1333    query check_private_in_public(_: ()) {
1334        eval_always
1335        desc { "checking for private elements in public interfaces" }
1336    }
1337
1338    query reachable_set(_: ()) -> &'tcx LocalDefIdSet {
1339        arena_cache
1340        desc { "reachability" }
1341        cache_on_disk_if { true }
1342    }
1343
1344    /// Per-body `region::ScopeTree`. The `DefId` should be the owner `DefId` for the body;
1345    /// in the case of closures, this will be redirected to the enclosing function.
1346    query region_scope_tree(def_id: DefId) -> &'tcx crate::middle::region::ScopeTree {
1347        desc { |tcx| "computing drop scopes for `{}`", tcx.def_path_str(def_id) }
1348    }
1349
1350    /// Generates a MIR body for the shim.
1351    query mir_shims(key: ty::InstanceKind<'tcx>) -> &'tcx mir::Body<'tcx> {
1352        arena_cache
1353        desc { |tcx| "generating MIR shim for `{}`", tcx.def_path_str(key.def_id()) }
1354    }
1355
1356    /// The `symbol_name` query provides the symbol name for calling a
1357    /// given instance from the local crate. In particular, it will also
1358    /// look up the correct symbol name of instances from upstream crates.
1359    query symbol_name(key: ty::Instance<'tcx>) -> ty::SymbolName<'tcx> {
1360        desc { "computing the symbol for `{}`", key }
1361        cache_on_disk_if { true }
1362    }
1363
1364    query def_kind(def_id: DefId) -> DefKind {
1365        desc { |tcx| "looking up definition kind of `{}`", tcx.def_path_str(def_id) }
1366        cache_on_disk_if { def_id.is_local() }
1367        separate_provide_extern
1368        feedable
1369    }
1370
1371    /// Gets the span for the definition.
1372    query def_span(def_id: DefId) -> Span {
1373        desc { |tcx| "looking up span for `{}`", tcx.def_path_str(def_id) }
1374        cache_on_disk_if { def_id.is_local() }
1375        separate_provide_extern
1376        feedable
1377    }
1378
1379    /// Gets the span for the identifier of the definition.
1380    query def_ident_span(def_id: DefId) -> Option<Span> {
1381        desc { |tcx| "looking up span for `{}`'s identifier", tcx.def_path_str(def_id) }
1382        cache_on_disk_if { def_id.is_local() }
1383        separate_provide_extern
1384        feedable
1385    }
1386
1387    query lookup_stability(def_id: DefId) -> Option<attr::Stability> {
1388        desc { |tcx| "looking up stability of `{}`", tcx.def_path_str(def_id) }
1389        cache_on_disk_if { def_id.is_local() }
1390        separate_provide_extern
1391    }
1392
1393    query lookup_const_stability(def_id: DefId) -> Option<attr::ConstStability> {
1394        desc { |tcx| "looking up const stability of `{}`", tcx.def_path_str(def_id) }
1395        cache_on_disk_if { def_id.is_local() }
1396        separate_provide_extern
1397    }
1398
1399    query lookup_default_body_stability(def_id: DefId) -> Option<attr::DefaultBodyStability> {
1400        desc { |tcx| "looking up default body stability of `{}`", tcx.def_path_str(def_id) }
1401        separate_provide_extern
1402    }
1403
1404    query should_inherit_track_caller(def_id: DefId) -> bool {
1405        desc { |tcx| "computing should_inherit_track_caller of `{}`", tcx.def_path_str(def_id) }
1406    }
1407
1408    query lookup_deprecation_entry(def_id: DefId) -> Option<DeprecationEntry> {
1409        desc { |tcx| "checking whether `{}` is deprecated", tcx.def_path_str(def_id) }
1410        cache_on_disk_if { def_id.is_local() }
1411        separate_provide_extern
1412    }
1413
1414    /// Determines whether an item is annotated with `#[doc(hidden)]`.
1415    query is_doc_hidden(def_id: DefId) -> bool {
1416        desc { |tcx| "checking whether `{}` is `doc(hidden)`", tcx.def_path_str(def_id) }
1417        separate_provide_extern
1418    }
1419
1420    /// Determines whether an item is annotated with `#[doc(notable_trait)]`.
1421    query is_doc_notable_trait(def_id: DefId) -> bool {
1422        desc { |tcx| "checking whether `{}` is `doc(notable_trait)`", tcx.def_path_str(def_id) }
1423    }
1424
1425    /// Returns the attributes on the item at `def_id`.
1426    ///
1427    /// Do not use this directly, use `tcx.get_attrs` instead.
1428    query attrs_for_def(def_id: DefId) -> &'tcx [hir::Attribute] {
1429        desc { |tcx| "collecting attributes of `{}`", tcx.def_path_str(def_id) }
1430        separate_provide_extern
1431    }
1432
1433    query codegen_fn_attrs(def_id: DefId) -> &'tcx CodegenFnAttrs {
1434        desc { |tcx| "computing codegen attributes of `{}`", tcx.def_path_str(def_id) }
1435        arena_cache
1436        cache_on_disk_if { def_id.is_local() }
1437        separate_provide_extern
1438        feedable
1439    }
1440
1441    query asm_target_features(def_id: DefId) -> &'tcx FxIndexSet<Symbol> {
1442        desc { |tcx| "computing target features for inline asm of `{}`", tcx.def_path_str(def_id) }
1443    }
1444
1445    query fn_arg_idents(def_id: DefId) -> &'tcx [Option<rustc_span::Ident>] {
1446        desc { |tcx| "looking up function parameter identifiers for `{}`", tcx.def_path_str(def_id) }
1447        separate_provide_extern
1448    }
1449
1450    /// Gets the rendered value of the specified constant or associated constant.
1451    /// Used by rustdoc.
1452    query rendered_const(def_id: DefId) -> &'tcx String {
1453        arena_cache
1454        desc { |tcx| "rendering constant initializer of `{}`", tcx.def_path_str(def_id) }
1455        separate_provide_extern
1456    }
1457
1458    /// Gets the rendered precise capturing args for an opaque for use in rustdoc.
1459    query rendered_precise_capturing_args(def_id: DefId) -> Option<&'tcx [PreciseCapturingArgKind<Symbol, Symbol>]> {
1460        desc { |tcx| "rendering precise capturing args for `{}`", tcx.def_path_str(def_id) }
1461        separate_provide_extern
1462    }
1463
1464    query impl_parent(def_id: DefId) -> Option<DefId> {
1465        desc { |tcx| "computing specialization parent impl of `{}`", tcx.def_path_str(def_id) }
1466        separate_provide_extern
1467    }
1468
1469    query is_ctfe_mir_available(key: DefId) -> bool {
1470        desc { |tcx| "checking if item has CTFE MIR available: `{}`", tcx.def_path_str(key) }
1471        cache_on_disk_if { key.is_local() }
1472        separate_provide_extern
1473    }
1474    query is_mir_available(key: DefId) -> bool {
1475        desc { |tcx| "checking if item has MIR available: `{}`", tcx.def_path_str(key) }
1476        cache_on_disk_if { key.is_local() }
1477        separate_provide_extern
1478    }
1479
1480    query own_existential_vtable_entries(
1481        key: DefId
1482    ) -> &'tcx [DefId] {
1483        desc { |tcx| "finding all existential vtable entries for trait `{}`", tcx.def_path_str(key) }
1484    }
1485
1486    query vtable_entries(key: ty::TraitRef<'tcx>)
1487                        -> &'tcx [ty::VtblEntry<'tcx>] {
1488        desc { |tcx| "finding all vtable entries for trait `{}`", tcx.def_path_str(key.def_id) }
1489    }
1490
1491    query first_method_vtable_slot(key: ty::TraitRef<'tcx>) -> usize {
1492        desc { |tcx| "finding the slot within the vtable of `{}` for the implementation of `{}`", key.self_ty(), key.print_only_trait_name() }
1493    }
1494
1495    query supertrait_vtable_slot(key: (Ty<'tcx>, Ty<'tcx>)) -> Option<usize> {
1496        desc { |tcx| "finding the slot within vtable for trait object `{}` vtable ptr during trait upcasting coercion from `{}` vtable",
1497            key.1, key.0 }
1498    }
1499
1500    query vtable_allocation(key: (Ty<'tcx>, Option<ty::ExistentialTraitRef<'tcx>>)) -> mir::interpret::AllocId {
1501        desc { |tcx| "vtable const allocation for <{} as {}>",
1502            key.0,
1503            key.1.map(|trait_ref| format!("{trait_ref}")).unwrap_or("_".to_owned())
1504        }
1505    }
1506
1507    query codegen_select_candidate(
1508        key: PseudoCanonicalInput<'tcx, ty::TraitRef<'tcx>>
1509    ) -> Result<&'tcx ImplSource<'tcx, ()>, CodegenObligationError> {
1510        cache_on_disk_if { true }
1511        desc { |tcx| "computing candidate for `{}`", key.value }
1512    }
1513
1514    /// Return all `impl` blocks in the current crate.
1515    query all_local_trait_impls(_: ()) -> &'tcx rustc_data_structures::fx::FxIndexMap<DefId, Vec<LocalDefId>> {
1516        desc { "finding local trait impls" }
1517    }
1518
1519    /// Return all `impl` blocks of the given trait in the current crate.
1520    query local_trait_impls(trait_id: DefId) -> &'tcx [LocalDefId] {
1521        desc { "finding local trait impls of `{}`", tcx.def_path_str(trait_id) }
1522    }
1523
1524    /// Given a trait `trait_id`, return all known `impl` blocks.
1525    query trait_impls_of(trait_id: DefId) -> &'tcx ty::trait_def::TraitImpls {
1526        arena_cache
1527        desc { |tcx| "finding trait impls of `{}`", tcx.def_path_str(trait_id) }
1528    }
1529
1530    query specialization_graph_of(trait_id: DefId) -> Result<&'tcx specialization_graph::Graph, ErrorGuaranteed> {
1531        desc { |tcx| "building specialization graph of trait `{}`", tcx.def_path_str(trait_id) }
1532        cache_on_disk_if { true }
1533        return_result_from_ensure_ok
1534    }
1535    query dyn_compatibility_violations(trait_id: DefId) -> &'tcx [DynCompatibilityViolation] {
1536        desc { |tcx| "determining dyn-compatibility of trait `{}`", tcx.def_path_str(trait_id) }
1537    }
1538    query is_dyn_compatible(trait_id: DefId) -> bool {
1539        desc { |tcx| "checking if trait `{}` is dyn-compatible", tcx.def_path_str(trait_id) }
1540    }
1541
1542    /// Gets the ParameterEnvironment for a given item; this environment
1543    /// will be in "user-facing" mode, meaning that it is suitable for
1544    /// type-checking etc, and it does not normalize specializable
1545    /// associated types.
1546    ///
1547    /// You should almost certainly not use this. If you already have an InferCtxt, then
1548    /// you should also probably have a `ParamEnv` from when it was built. If you don't,
1549    /// then you should take a `TypingEnv` to ensure that you handle opaque types correctly.
1550    query param_env(def_id: DefId) -> ty::ParamEnv<'tcx> {
1551        desc { |tcx| "computing normalized predicates of `{}`", tcx.def_path_str(def_id) }
1552        feedable
1553    }
1554
1555    /// Like `param_env`, but returns the `ParamEnv` after all opaque types have been
1556    /// replaced with their hidden type. This is used in the old trait solver
1557    /// when in `PostAnalysis` mode and should not be called directly.
1558    query param_env_normalized_for_post_analysis(def_id: DefId) -> ty::ParamEnv<'tcx> {
1559        desc { |tcx| "computing revealed normalized predicates of `{}`", tcx.def_path_str(def_id) }
1560    }
1561
1562    /// Trait selection queries. These are best used by invoking `ty.is_copy_modulo_regions()`,
1563    /// `ty.is_copy()`, etc, since that will prune the environment where possible.
1564    query is_copy_raw(env: ty::PseudoCanonicalInput<'tcx, Ty<'tcx>>) -> bool {
1565        desc { "computing whether `{}` is `Copy`", env.value }
1566    }
1567    /// Trait selection queries. These are best used by invoking `ty.is_use_cloned_modulo_regions()`,
1568    /// `ty.is_use_cloned()`, etc, since that will prune the environment where possible.
1569    query is_use_cloned_raw(env: ty::PseudoCanonicalInput<'tcx, Ty<'tcx>>) -> bool {
1570        desc { "computing whether `{}` is `UseCloned`", env.value }
1571    }
1572    /// Query backing `Ty::is_sized`.
1573    query is_sized_raw(env: ty::PseudoCanonicalInput<'tcx, Ty<'tcx>>) -> bool {
1574        desc { "computing whether `{}` is `Sized`", env.value }
1575    }
1576    /// Query backing `Ty::is_freeze`.
1577    query is_freeze_raw(env: ty::PseudoCanonicalInput<'tcx, Ty<'tcx>>) -> bool {
1578        desc { "computing whether `{}` is freeze", env.value }
1579    }
1580    /// Query backing `Ty::is_unpin`.
1581    query is_unpin_raw(env: ty::PseudoCanonicalInput<'tcx, Ty<'tcx>>) -> bool {
1582        desc { "computing whether `{}` is `Unpin`", env.value }
1583    }
1584    /// Query backing `Ty::needs_drop`.
1585    query needs_drop_raw(env: ty::PseudoCanonicalInput<'tcx, Ty<'tcx>>) -> bool {
1586        desc { "computing whether `{}` needs drop", env.value }
1587    }
1588    /// Query backing `Ty::needs_async_drop`.
1589    query needs_async_drop_raw(env: ty::PseudoCanonicalInput<'tcx, Ty<'tcx>>) -> bool {
1590        desc { "computing whether `{}` needs async drop", env.value }
1591    }
1592    /// Query backing `Ty::has_significant_drop_raw`.
1593    query has_significant_drop_raw(env: ty::PseudoCanonicalInput<'tcx, Ty<'tcx>>) -> bool {
1594        desc { "computing whether `{}` has a significant drop", env.value }
1595    }
1596
1597    /// Query backing `Ty::is_structural_eq_shallow`.
1598    ///
1599    /// This is only correct for ADTs. Call `is_structural_eq_shallow` to handle all types
1600    /// correctly.
1601    query has_structural_eq_impl(ty: Ty<'tcx>) -> bool {
1602        desc {
1603            "computing whether `{}` implements `StructuralPartialEq`",
1604            ty
1605        }
1606    }
1607
1608    /// A list of types where the ADT requires drop if and only if any of
1609    /// those types require drop. If the ADT is known to always need drop
1610    /// then `Err(AlwaysRequiresDrop)` is returned.
1611    query adt_drop_tys(def_id: DefId) -> Result<&'tcx ty::List<Ty<'tcx>>, AlwaysRequiresDrop> {
1612        desc { |tcx| "computing when `{}` needs drop", tcx.def_path_str(def_id) }
1613        cache_on_disk_if { true }
1614    }
1615
1616    /// A list of types where the ADT requires drop if and only if any of those types
1617    /// has significant drop. A type marked with the attribute `rustc_insignificant_dtor`
1618    /// is considered to not be significant. A drop is significant if it is implemented
1619    /// by the user or does anything that will have any observable behavior (other than
1620    /// freeing up memory). If the ADT is known to have a significant destructor then
1621    /// `Err(AlwaysRequiresDrop)` is returned.
1622    query adt_significant_drop_tys(def_id: DefId) -> Result<&'tcx ty::List<Ty<'tcx>>, AlwaysRequiresDrop> {
1623        desc { |tcx| "computing when `{}` has a significant destructor", tcx.def_path_str(def_id) }
1624    }
1625
1626    /// Returns a list of types which (a) have a potentially significant destructor
1627    /// and (b) may be dropped as a result of dropping a value of some type `ty`
1628    /// (in the given environment).
1629    ///
1630    /// The idea of "significant" drop is somewhat informal and is used only for
1631    /// diagnostics and edition migrations. The idea is that a significant drop may have
1632    /// some visible side-effect on execution; freeing memory is NOT considered a side-effect.
1633    /// The rules are as follows:
1634    /// * Type with no explicit drop impl do not have significant drop.
1635    /// * Types with a drop impl are assumed to have significant drop unless they have a `#[rustc_insignificant_dtor]` annotation.
1636    ///
1637    /// Note that insignificant drop is a "shallow" property. A type like `Vec<LockGuard>` does not
1638    /// have significant drop but the type `LockGuard` does, and so if `ty  = Vec<LockGuard>`
1639    /// then the return value would be `&[LockGuard]`.
1640    /// *IMPORTANT*: *DO NOT* run this query before promoted MIR body is constructed,
1641    /// because this query partially depends on that query.
1642    /// Otherwise, there is a risk of query cycles.
1643    query list_significant_drop_tys(ty: ty::PseudoCanonicalInput<'tcx, Ty<'tcx>>) -> &'tcx ty::List<Ty<'tcx>> {
1644        desc { |tcx| "computing when `{}` has a significant destructor", ty.value }
1645    }
1646
1647    /// Computes the layout of a type. Note that this implicitly
1648    /// executes in `TypingMode::PostAnalysis`, and will normalize the input type.
1649    query layout_of(
1650        key: ty::PseudoCanonicalInput<'tcx, Ty<'tcx>>
1651    ) -> Result<ty::layout::TyAndLayout<'tcx>, &'tcx ty::layout::LayoutError<'tcx>> {
1652        depth_limit
1653        desc { "computing layout of `{}`", key.value }
1654        // we emit our own error during query cycle handling
1655        cycle_delay_bug
1656    }
1657
1658    /// Compute a `FnAbi` suitable for indirect calls, i.e. to `fn` pointers.
1659    ///
1660    /// NB: this doesn't handle virtual calls - those should use `fn_abi_of_instance`
1661    /// instead, where the instance is an `InstanceKind::Virtual`.
1662    query fn_abi_of_fn_ptr(
1663        key: ty::PseudoCanonicalInput<'tcx, (ty::PolyFnSig<'tcx>, &'tcx ty::List<Ty<'tcx>>)>
1664    ) -> Result<&'tcx rustc_target::callconv::FnAbi<'tcx, Ty<'tcx>>, &'tcx ty::layout::FnAbiError<'tcx>> {
1665        desc { "computing call ABI of `{}` function pointers", key.value.0 }
1666    }
1667
1668    /// Compute a `FnAbi` suitable for declaring/defining an `fn` instance, and for
1669    /// direct calls to an `fn`.
1670    ///
1671    /// NB: that includes virtual calls, which are represented by "direct calls"
1672    /// to an `InstanceKind::Virtual` instance (of `<dyn Trait as Trait>::fn`).
1673    query fn_abi_of_instance(
1674        key: ty::PseudoCanonicalInput<'tcx, (ty::Instance<'tcx>, &'tcx ty::List<Ty<'tcx>>)>
1675    ) -> Result<&'tcx rustc_target::callconv::FnAbi<'tcx, Ty<'tcx>>, &'tcx ty::layout::FnAbiError<'tcx>> {
1676        desc { "computing call ABI of `{}`", key.value.0 }
1677    }
1678
1679    query dylib_dependency_formats(_: CrateNum)
1680                                    -> &'tcx [(CrateNum, LinkagePreference)] {
1681        desc { "getting dylib dependency formats of crate" }
1682        separate_provide_extern
1683    }
1684
1685    query dependency_formats(_: ()) -> &'tcx Arc<crate::middle::dependency_format::Dependencies> {
1686        arena_cache
1687        desc { "getting the linkage format of all dependencies" }
1688    }
1689
1690    query is_compiler_builtins(_: CrateNum) -> bool {
1691        fatal_cycle
1692        desc { "checking if the crate is_compiler_builtins" }
1693        separate_provide_extern
1694    }
1695    query has_global_allocator(_: CrateNum) -> bool {
1696        // This query depends on untracked global state in CStore
1697        eval_always
1698        fatal_cycle
1699        desc { "checking if the crate has_global_allocator" }
1700        separate_provide_extern
1701    }
1702    query has_alloc_error_handler(_: CrateNum) -> bool {
1703        // This query depends on untracked global state in CStore
1704        eval_always
1705        fatal_cycle
1706        desc { "checking if the crate has_alloc_error_handler" }
1707        separate_provide_extern
1708    }
1709    query has_panic_handler(_: CrateNum) -> bool {
1710        fatal_cycle
1711        desc { "checking if the crate has_panic_handler" }
1712        separate_provide_extern
1713    }
1714    query is_profiler_runtime(_: CrateNum) -> bool {
1715        fatal_cycle
1716        desc { "checking if a crate is `#![profiler_runtime]`" }
1717        separate_provide_extern
1718    }
1719    query has_ffi_unwind_calls(key: LocalDefId) -> bool {
1720        desc { |tcx| "checking if `{}` contains FFI-unwind calls", tcx.def_path_str(key) }
1721        cache_on_disk_if { true }
1722    }
1723    query required_panic_strategy(_: CrateNum) -> Option<PanicStrategy> {
1724        fatal_cycle
1725        desc { "getting a crate's required panic strategy" }
1726        separate_provide_extern
1727    }
1728    query panic_in_drop_strategy(_: CrateNum) -> PanicStrategy {
1729        fatal_cycle
1730        desc { "getting a crate's configured panic-in-drop strategy" }
1731        separate_provide_extern
1732    }
1733    query is_no_builtins(_: CrateNum) -> bool {
1734        fatal_cycle
1735        desc { "getting whether a crate has `#![no_builtins]`" }
1736        separate_provide_extern
1737    }
1738    query symbol_mangling_version(_: CrateNum) -> SymbolManglingVersion {
1739        fatal_cycle
1740        desc { "getting a crate's symbol mangling version" }
1741        separate_provide_extern
1742    }
1743
1744    query extern_crate(def_id: CrateNum) -> Option<&'tcx ExternCrate> {
1745        eval_always
1746        desc { "getting crate's ExternCrateData" }
1747        separate_provide_extern
1748    }
1749
1750    query specialization_enabled_in(cnum: CrateNum) -> bool {
1751        desc { "checking whether the crate enabled `specialization`/`min_specialization`" }
1752        separate_provide_extern
1753    }
1754
1755    query specializes(_: (DefId, DefId)) -> bool {
1756        desc { "computing whether impls specialize one another" }
1757    }
1758    query in_scope_traits_map(_: hir::OwnerId)
1759        -> Option<&'tcx ItemLocalMap<Box<[TraitCandidate]>>> {
1760        desc { "getting traits in scope at a block" }
1761    }
1762
1763    /// Returns whether the impl or associated function has the `default` keyword.
1764    query defaultness(def_id: DefId) -> hir::Defaultness {
1765        desc { |tcx| "looking up whether `{}` has `default`", tcx.def_path_str(def_id) }
1766        separate_provide_extern
1767        feedable
1768    }
1769
1770    query check_well_formed(key: LocalDefId) -> Result<(), ErrorGuaranteed> {
1771        desc { |tcx| "checking that `{}` is well-formed", tcx.def_path_str(key) }
1772        return_result_from_ensure_ok
1773    }
1774
1775    query enforce_impl_non_lifetime_params_are_constrained(key: LocalDefId) -> Result<(), ErrorGuaranteed> {
1776        desc { |tcx| "checking that `{}`'s generics are constrained by the impl header", tcx.def_path_str(key) }
1777        return_result_from_ensure_ok
1778    }
1779
1780    // The `DefId`s of all non-generic functions and statics in the given crate
1781    // that can be reached from outside the crate.
1782    //
1783    // We expect this items to be available for being linked to.
1784    //
1785    // This query can also be called for `LOCAL_CRATE`. In this case it will
1786    // compute which items will be reachable to other crates, taking into account
1787    // the kind of crate that is currently compiled. Crates with only a
1788    // C interface have fewer reachable things.
1789    //
1790    // Does not include external symbols that don't have a corresponding DefId,
1791    // like the compiler-generated `main` function and so on.
1792    query reachable_non_generics(_: CrateNum)
1793        -> &'tcx DefIdMap<SymbolExportInfo> {
1794        arena_cache
1795        desc { "looking up the exported symbols of a crate" }
1796        separate_provide_extern
1797    }
1798    query is_reachable_non_generic(def_id: DefId) -> bool {
1799        desc { |tcx| "checking whether `{}` is an exported symbol", tcx.def_path_str(def_id) }
1800        cache_on_disk_if { def_id.is_local() }
1801        separate_provide_extern
1802    }
1803    query is_unreachable_local_definition(def_id: LocalDefId) -> bool {
1804        desc { |tcx|
1805            "checking whether `{}` is reachable from outside the crate",
1806            tcx.def_path_str(def_id),
1807        }
1808    }
1809
1810    /// The entire set of monomorphizations the local crate can safely
1811    /// link to because they are exported from upstream crates. Do
1812    /// not depend on this directly, as its value changes anytime
1813    /// a monomorphization gets added or removed in any upstream
1814    /// crate. Instead use the narrower `upstream_monomorphizations_for`,
1815    /// `upstream_drop_glue_for`, `upstream_async_drop_glue_for`, or,
1816    /// even better, `Instance::upstream_monomorphization()`.
1817    query upstream_monomorphizations(_: ()) -> &'tcx DefIdMap<UnordMap<GenericArgsRef<'tcx>, CrateNum>> {
1818        arena_cache
1819        desc { "collecting available upstream monomorphizations" }
1820    }
1821
1822    /// Returns the set of upstream monomorphizations available for the
1823    /// generic function identified by the given `def_id`. The query makes
1824    /// sure to make a stable selection if the same monomorphization is
1825    /// available in multiple upstream crates.
1826    ///
1827    /// You likely want to call `Instance::upstream_monomorphization()`
1828    /// instead of invoking this query directly.
1829    query upstream_monomorphizations_for(def_id: DefId)
1830        -> Option<&'tcx UnordMap<GenericArgsRef<'tcx>, CrateNum>>
1831    {
1832        desc { |tcx|
1833            "collecting available upstream monomorphizations for `{}`",
1834            tcx.def_path_str(def_id),
1835        }
1836        separate_provide_extern
1837    }
1838
1839    /// Returns the upstream crate that exports drop-glue for the given
1840    /// type (`args` is expected to be a single-item list containing the
1841    /// type one wants drop-glue for).
1842    ///
1843    /// This is a subset of `upstream_monomorphizations_for` in order to
1844    /// increase dep-tracking granularity. Otherwise adding or removing any
1845    /// type with drop-glue in any upstream crate would invalidate all
1846    /// functions calling drop-glue of an upstream type.
1847    ///
1848    /// You likely want to call `Instance::upstream_monomorphization()`
1849    /// instead of invoking this query directly.
1850    ///
1851    /// NOTE: This query could easily be extended to also support other
1852    ///       common functions that have are large set of monomorphizations
1853    ///       (like `Clone::clone` for example).
1854    query upstream_drop_glue_for(args: GenericArgsRef<'tcx>) -> Option<CrateNum> {
1855        desc { "available upstream drop-glue for `{:?}`", args }
1856    }
1857
1858    /// Returns the upstream crate that exports async-drop-glue for
1859    /// the given type (`args` is expected to be a single-item list
1860    /// containing the type one wants async-drop-glue for).
1861    ///
1862    /// This is a subset of `upstream_monomorphizations_for` in order
1863    /// to increase dep-tracking granularity. Otherwise adding or
1864    /// removing any type with async-drop-glue in any upstream crate
1865    /// would invalidate all functions calling async-drop-glue of an
1866    /// upstream type.
1867    ///
1868    /// You likely want to call `Instance::upstream_monomorphization()`
1869    /// instead of invoking this query directly.
1870    ///
1871    /// NOTE: This query could easily be extended to also support other
1872    ///       common functions that have are large set of monomorphizations
1873    ///       (like `Clone::clone` for example).
1874    query upstream_async_drop_glue_for(args: GenericArgsRef<'tcx>) -> Option<CrateNum> {
1875        desc { "available upstream async-drop-glue for `{:?}`", args }
1876    }
1877
1878    /// Returns a list of all `extern` blocks of a crate.
1879    query foreign_modules(_: CrateNum) -> &'tcx FxIndexMap<DefId, ForeignModule> {
1880        arena_cache
1881        desc { "looking up the foreign modules of a linked crate" }
1882        separate_provide_extern
1883    }
1884
1885    /// Lint against `extern fn` declarations having incompatible types.
1886    query clashing_extern_declarations(_: ()) {
1887        desc { "checking `extern fn` declarations are compatible" }
1888    }
1889
1890    /// Identifies the entry-point (e.g., the `main` function) for a given
1891    /// crate, returning `None` if there is no entry point (such as for library crates).
1892    query entry_fn(_: ()) -> Option<(DefId, EntryFnType)> {
1893        desc { "looking up the entry function of a crate" }
1894    }
1895
1896    /// Finds the `rustc_proc_macro_decls` item of a crate.
1897    query proc_macro_decls_static(_: ()) -> Option<LocalDefId> {
1898        desc { "looking up the proc macro declarations for a crate" }
1899    }
1900
1901    // The macro which defines `rustc_metadata::provide_extern` depends on this query's name.
1902    // Changing the name should cause a compiler error, but in case that changes, be aware.
1903    //
1904    // The hash should not be calculated before the `analysis` pass is complete, specifically
1905    // until `tcx.untracked().definitions.freeze()` has been called, otherwise if incremental
1906    // compilation is enabled calculating this hash can freeze this structure too early in
1907    // compilation and cause subsequent crashes when attempting to write to `definitions`
1908    query crate_hash(_: CrateNum) -> Svh {
1909        eval_always
1910        desc { "looking up the hash a crate" }
1911        separate_provide_extern
1912    }
1913
1914    /// Gets the hash for the host proc macro. Used to support -Z dual-proc-macro.
1915    query crate_host_hash(_: CrateNum) -> Option<Svh> {
1916        eval_always
1917        desc { "looking up the hash of a host version of a crate" }
1918        separate_provide_extern
1919    }
1920
1921    /// Gets the extra data to put in each output filename for a crate.
1922    /// For example, compiling the `foo` crate with `extra-filename=-a` creates a `libfoo-b.rlib` file.
1923    query extra_filename(_: CrateNum) -> &'tcx String {
1924        arena_cache
1925        eval_always
1926        desc { "looking up the extra filename for a crate" }
1927        separate_provide_extern
1928    }
1929
1930    /// Gets the paths where the crate came from in the file system.
1931    query crate_extern_paths(_: CrateNum) -> &'tcx Vec<PathBuf> {
1932        arena_cache
1933        eval_always
1934        desc { "looking up the paths for extern crates" }
1935        separate_provide_extern
1936    }
1937
1938    /// Given a crate and a trait, look up all impls of that trait in the crate.
1939    /// Return `(impl_id, self_ty)`.
1940    query implementations_of_trait(_: (CrateNum, DefId)) -> &'tcx [(DefId, Option<SimplifiedType>)] {
1941        desc { "looking up implementations of a trait in a crate" }
1942        separate_provide_extern
1943    }
1944
1945    /// Collects all incoherent impls for the given crate and type.
1946    ///
1947    /// Do not call this directly, but instead use the `incoherent_impls` query.
1948    /// This query is only used to get the data necessary for that query.
1949    query crate_incoherent_impls(key: (CrateNum, SimplifiedType)) -> &'tcx [DefId] {
1950        desc { |tcx| "collecting all impls for a type in a crate" }
1951        separate_provide_extern
1952    }
1953
1954    /// Get the corresponding native library from the `native_libraries` query
1955    query native_library(def_id: DefId) -> Option<&'tcx NativeLib> {
1956        desc { |tcx| "getting the native library for `{}`", tcx.def_path_str(def_id) }
1957    }
1958
1959    query inherit_sig_for_delegation_item(def_id: LocalDefId) -> &'tcx [Ty<'tcx>] {
1960        desc { "inheriting delegation signature" }
1961    }
1962
1963    /// Does lifetime resolution on items. Importantly, we can't resolve
1964    /// lifetimes directly on things like trait methods, because of trait params.
1965    /// See `rustc_resolve::late::lifetimes` for details.
1966    query resolve_bound_vars(owner_id: hir::OwnerId) -> &'tcx ResolveBoundVars {
1967        arena_cache
1968        desc { |tcx| "resolving lifetimes for `{}`", tcx.def_path_str(owner_id) }
1969    }
1970    query named_variable_map(owner_id: hir::OwnerId) -> &'tcx SortedMap<ItemLocalId, ResolvedArg> {
1971        desc { |tcx| "looking up a named region inside `{}`", tcx.def_path_str(owner_id) }
1972    }
1973    query is_late_bound_map(owner_id: hir::OwnerId) -> Option<&'tcx FxIndexSet<ItemLocalId>> {
1974        desc { |tcx| "testing if a region is late bound inside `{}`", tcx.def_path_str(owner_id) }
1975    }
1976    /// Returns the *default lifetime* to be used if a trait object type were to be passed for
1977    /// the type parameter given by `DefId`.
1978    ///
1979    /// **Tip**: You can use `#[rustc_object_lifetime_default]` on an item to basically
1980    /// print the result of this query for use in UI tests or for debugging purposes.
1981    ///
1982    /// # Examples
1983    ///
1984    /// - For `T` in `struct Foo<'a, T: 'a>(&'a T);`, this would be `Param('a)`
1985    /// - For `T` in `struct Bar<'a, T>(&'a T);`, this would be `Empty`
1986    ///
1987    /// # Panics
1988    ///
1989    /// This query will panic if the given definition is not a type parameter.
1990    query object_lifetime_default(def_id: DefId) -> ObjectLifetimeDefault {
1991        desc { "looking up lifetime defaults for type parameter `{}`", tcx.def_path_str(def_id) }
1992        separate_provide_extern
1993    }
1994    query late_bound_vars_map(owner_id: hir::OwnerId)
1995        -> &'tcx SortedMap<ItemLocalId, Vec<ty::BoundVariableKind>> {
1996        desc { |tcx| "looking up late bound vars inside `{}`", tcx.def_path_str(owner_id) }
1997    }
1998    /// For an opaque type, return the list of (captured lifetime, inner generic param).
1999    /// ```ignore (illustrative)
2000    /// fn foo<'a: 'a, 'b, T>(&'b u8) -> impl Into<Self> + 'b { ... }
2001    /// ```
2002    ///
2003    /// We would return `[('a, '_a), ('b, '_b)]`, with `'a` early-bound and `'b` late-bound.
2004    ///
2005    /// After hir_ty_lowering, we get:
2006    /// ```ignore (pseudo-code)
2007    /// opaque foo::<'a>::opaque<'_a, '_b>: Into<Foo<'_a>> + '_b;
2008    ///                          ^^^^^^^^ inner generic params
2009    /// fn foo<'a>: for<'b> fn(&'b u8) -> foo::<'a>::opaque::<'a, 'b>
2010    ///                                                       ^^^^^^ captured lifetimes
2011    /// ```
2012    query opaque_captured_lifetimes(def_id: LocalDefId) -> &'tcx [(ResolvedArg, LocalDefId)] {
2013        desc { |tcx| "listing captured lifetimes for opaque `{}`", tcx.def_path_str(def_id) }
2014    }
2015
2016    /// Computes the visibility of the provided `def_id`.
2017    ///
2018    /// If the item from the `def_id` doesn't have a visibility, it will panic. For example
2019    /// a generic type parameter will panic if you call this method on it:
2020    ///
2021    /// ```
2022    /// use std::fmt::Debug;
2023    ///
2024    /// pub trait Foo<T: Debug> {}
2025    /// ```
2026    ///
2027    /// In here, if you call `visibility` on `T`, it'll panic.
2028    query visibility(def_id: DefId) -> ty::Visibility<DefId> {
2029        desc { |tcx| "computing visibility of `{}`", tcx.def_path_str(def_id) }
2030        separate_provide_extern
2031        feedable
2032    }
2033
2034    query inhabited_predicate_adt(key: DefId) -> ty::inhabitedness::InhabitedPredicate<'tcx> {
2035        desc { "computing the uninhabited predicate of `{:?}`", key }
2036    }
2037
2038    /// Do not call this query directly: invoke `Ty::inhabited_predicate` instead.
2039    query inhabited_predicate_type(key: Ty<'tcx>) -> ty::inhabitedness::InhabitedPredicate<'tcx> {
2040        desc { "computing the uninhabited predicate of `{}`", key }
2041    }
2042
2043    query dep_kind(_: CrateNum) -> CrateDepKind {
2044        eval_always
2045        desc { "fetching what a dependency looks like" }
2046        separate_provide_extern
2047    }
2048
2049    /// Gets the name of the crate.
2050    query crate_name(_: CrateNum) -> Symbol {
2051        feedable
2052        desc { "fetching what a crate is named" }
2053        separate_provide_extern
2054    }
2055    query module_children(def_id: DefId) -> &'tcx [ModChild] {
2056        desc { |tcx| "collecting child items of module `{}`", tcx.def_path_str(def_id) }
2057        separate_provide_extern
2058    }
2059    query extern_mod_stmt_cnum(def_id: LocalDefId) -> Option<CrateNum> {
2060        desc { |tcx| "computing crate imported by `{}`", tcx.def_path_str(def_id) }
2061    }
2062
2063    /// Gets the number of definitions in a foreign crate.
2064    ///
2065    /// This allows external tools to iterate over all definitions in a foreign crate.
2066    ///
2067    /// This should never be used for the local crate, instead use `iter_local_def_id`.
2068    query num_extern_def_ids(_: CrateNum) -> usize {
2069        desc { "fetching the number of definitions in a crate" }
2070        separate_provide_extern
2071    }
2072
2073    query lib_features(_: CrateNum) -> &'tcx LibFeatures {
2074        desc { "calculating the lib features defined in a crate" }
2075        separate_provide_extern
2076        arena_cache
2077    }
2078    query stability_implications(_: CrateNum) -> &'tcx UnordMap<Symbol, Symbol> {
2079        arena_cache
2080        desc { "calculating the implications between `#[unstable]` features defined in a crate" }
2081        separate_provide_extern
2082    }
2083    /// Whether the function is an intrinsic
2084    query intrinsic_raw(def_id: DefId) -> Option<rustc_middle::ty::IntrinsicDef> {
2085        desc { |tcx| "fetch intrinsic name if `{}` is an intrinsic", tcx.def_path_str(def_id) }
2086        separate_provide_extern
2087    }
2088    /// Returns the lang items defined in another crate by loading it from metadata.
2089    query get_lang_items(_: ()) -> &'tcx LanguageItems {
2090        arena_cache
2091        eval_always
2092        desc { "calculating the lang items map" }
2093    }
2094
2095    /// Returns all diagnostic items defined in all crates.
2096    query all_diagnostic_items(_: ()) -> &'tcx rustc_hir::diagnostic_items::DiagnosticItems {
2097        arena_cache
2098        eval_always
2099        desc { "calculating the diagnostic items map" }
2100    }
2101
2102    /// Returns the lang items defined in another crate by loading it from metadata.
2103    query defined_lang_items(_: CrateNum) -> &'tcx [(DefId, LangItem)] {
2104        desc { "calculating the lang items defined in a crate" }
2105        separate_provide_extern
2106    }
2107
2108    /// Returns the diagnostic items defined in a crate.
2109    query diagnostic_items(_: CrateNum) -> &'tcx rustc_hir::diagnostic_items::DiagnosticItems {
2110        arena_cache
2111        desc { "calculating the diagnostic items map in a crate" }
2112        separate_provide_extern
2113    }
2114
2115    query missing_lang_items(_: CrateNum) -> &'tcx [LangItem] {
2116        desc { "calculating the missing lang items in a crate" }
2117        separate_provide_extern
2118    }
2119
2120    /// The visible parent map is a map from every item to a visible parent.
2121    /// It prefers the shortest visible path to an item.
2122    /// Used for diagnostics, for example path trimming.
2123    /// The parents are modules, enums or traits.
2124    query visible_parent_map(_: ()) -> &'tcx DefIdMap<DefId> {
2125        arena_cache
2126        desc { "calculating the visible parent map" }
2127    }
2128    /// Collects the "trimmed", shortest accessible paths to all items for diagnostics.
2129    /// See the [provider docs](`rustc_middle::ty::print::trimmed_def_paths`) for more info.
2130    query trimmed_def_paths(_: ()) -> &'tcx DefIdMap<Symbol> {
2131        arena_cache
2132        desc { "calculating trimmed def paths" }
2133    }
2134    query missing_extern_crate_item(_: CrateNum) -> bool {
2135        eval_always
2136        desc { "seeing if we're missing an `extern crate` item for this crate" }
2137        separate_provide_extern
2138    }
2139    query used_crate_source(_: CrateNum) -> &'tcx Arc<CrateSource> {
2140        arena_cache
2141        eval_always
2142        desc { "looking at the source for a crate" }
2143        separate_provide_extern
2144    }
2145
2146    /// Returns the debugger visualizers defined for this crate.
2147    /// NOTE: This query has to be marked `eval_always` because it reads data
2148    ///       directly from disk that is not tracked anywhere else. I.e. it
2149    ///       represents a genuine input to the query system.
2150    query debugger_visualizers(_: CrateNum) -> &'tcx Vec<DebuggerVisualizerFile> {
2151        arena_cache
2152        desc { "looking up the debugger visualizers for this crate" }
2153        separate_provide_extern
2154        eval_always
2155    }
2156
2157    query postorder_cnums(_: ()) -> &'tcx [CrateNum] {
2158        eval_always
2159        desc { "generating a postorder list of CrateNums" }
2160    }
2161    /// Returns whether or not the crate with CrateNum 'cnum'
2162    /// is marked as a private dependency
2163    query is_private_dep(c: CrateNum) -> bool {
2164        eval_always
2165        desc { "checking whether crate `{}` is a private dependency", c }
2166        separate_provide_extern
2167    }
2168    query allocator_kind(_: ()) -> Option<AllocatorKind> {
2169        eval_always
2170        desc { "getting the allocator kind for the current crate" }
2171    }
2172    query alloc_error_handler_kind(_: ()) -> Option<AllocatorKind> {
2173        eval_always
2174        desc { "alloc error handler kind for the current crate" }
2175    }
2176
2177    query upvars_mentioned(def_id: DefId) -> Option<&'tcx FxIndexMap<hir::HirId, hir::Upvar>> {
2178        desc { |tcx| "collecting upvars mentioned in `{}`", tcx.def_path_str(def_id) }
2179    }
2180    query maybe_unused_trait_imports(_: ()) -> &'tcx FxIndexSet<LocalDefId> {
2181        desc { "fetching potentially unused trait imports" }
2182    }
2183    query names_imported_by_glob_use(def_id: LocalDefId) -> &'tcx UnordSet<Symbol> {
2184        desc { |tcx| "finding names imported by glob use for `{}`", tcx.def_path_str(def_id) }
2185    }
2186
2187    query stability_index(_: ()) -> &'tcx stability::Index {
2188        arena_cache
2189        eval_always
2190        desc { "calculating the stability index for the local crate" }
2191    }
2192    /// All available crates in the graph, including those that should not be user-facing
2193    /// (such as private crates).
2194    query crates(_: ()) -> &'tcx [CrateNum] {
2195        eval_always
2196        desc { "fetching all foreign CrateNum instances" }
2197    }
2198    // Crates that are loaded non-speculatively (not for diagnostics or doc links).
2199    // FIXME: This is currently only used for collecting lang items, but should be used instead of
2200    // `crates` in most other cases too.
2201    query used_crates(_: ()) -> &'tcx [CrateNum] {
2202        eval_always
2203        desc { "fetching `CrateNum`s for all crates loaded non-speculatively" }
2204    }
2205
2206    /// A list of all traits in a crate, used by rustdoc and error reporting.
2207    query traits(_: CrateNum) -> &'tcx [DefId] {
2208        desc { "fetching all traits in a crate" }
2209        separate_provide_extern
2210    }
2211
2212    query trait_impls_in_crate(_: CrateNum) -> &'tcx [DefId] {
2213        desc { "fetching all trait impls in a crate" }
2214        separate_provide_extern
2215    }
2216
2217    /// The list of symbols exported from the given crate.
2218    ///
2219    /// - All names contained in `exported_symbols(cnum)` are guaranteed to
2220    ///   correspond to a publicly visible symbol in `cnum` machine code.
2221    /// - The `exported_symbols` sets of different crates do not intersect.
2222    query exported_symbols(cnum: CrateNum) -> &'tcx [(ExportedSymbol<'tcx>, SymbolExportInfo)] {
2223        desc { "collecting exported symbols for crate `{}`", cnum}
2224        cache_on_disk_if { *cnum == LOCAL_CRATE }
2225        separate_provide_extern
2226    }
2227
2228    query collect_and_partition_mono_items(_: ()) -> MonoItemPartitions<'tcx> {
2229        eval_always
2230        desc { "collect_and_partition_mono_items" }
2231    }
2232
2233    query is_codegened_item(def_id: DefId) -> bool {
2234        desc { |tcx| "determining whether `{}` needs codegen", tcx.def_path_str(def_id) }
2235    }
2236
2237    query codegen_unit(sym: Symbol) -> &'tcx CodegenUnit<'tcx> {
2238        desc { "getting codegen unit `{sym}`" }
2239    }
2240
2241    query backend_optimization_level(_: ()) -> OptLevel {
2242        desc { "optimization level used by backend" }
2243    }
2244
2245    /// Return the filenames where output artefacts shall be stored.
2246    ///
2247    /// This query returns an `&Arc` because codegen backends need the value even after the `TyCtxt`
2248    /// has been destroyed.
2249    query output_filenames(_: ()) -> &'tcx Arc<OutputFilenames> {
2250        feedable
2251        desc { "getting output filenames" }
2252        arena_cache
2253    }
2254
2255    /// <div class="warning">
2256    ///
2257    /// Do not call this query directly: Invoke `normalize` instead.
2258    ///
2259    /// </div>
2260    query normalize_canonicalized_projection_ty(
2261        goal: CanonicalAliasGoal<'tcx>
2262    ) -> Result<
2263        &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, NormalizationResult<'tcx>>>,
2264        NoSolution,
2265    > {
2266        desc { "normalizing `{}`", goal.canonical.value.value }
2267    }
2268
2269    /// <div class="warning">
2270    ///
2271    /// Do not call this query directly: Invoke `normalize` instead.
2272    ///
2273    /// </div>
2274    query normalize_canonicalized_weak_ty(
2275        goal: CanonicalAliasGoal<'tcx>
2276    ) -> Result<
2277        &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, NormalizationResult<'tcx>>>,
2278        NoSolution,
2279    > {
2280        desc { "normalizing `{}`", goal.canonical.value.value }
2281    }
2282
2283    /// <div class="warning">
2284    ///
2285    /// Do not call this query directly: Invoke `normalize` instead.
2286    ///
2287    /// </div>
2288    query normalize_canonicalized_inherent_projection_ty(
2289        goal: CanonicalAliasGoal<'tcx>
2290    ) -> Result<
2291        &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, NormalizationResult<'tcx>>>,
2292        NoSolution,
2293    > {
2294        desc { "normalizing `{}`", goal.canonical.value.value }
2295    }
2296
2297    /// Do not call this query directly: invoke `try_normalize_erasing_regions` instead.
2298    query try_normalize_generic_arg_after_erasing_regions(
2299        goal: PseudoCanonicalInput<'tcx, GenericArg<'tcx>>
2300    ) -> Result<GenericArg<'tcx>, NoSolution> {
2301        desc { "normalizing `{}`", goal.value }
2302    }
2303
2304    query implied_outlives_bounds(
2305        key: (CanonicalImpliedOutlivesBoundsGoal<'tcx>, bool)
2306    ) -> Result<
2307        &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, Vec<OutlivesBound<'tcx>>>>,
2308        NoSolution,
2309    > {
2310        desc { "computing implied outlives bounds for `{}` (hack disabled = {:?})", key.0.canonical.value.value.ty, key.1 }
2311    }
2312
2313    /// Do not call this query directly:
2314    /// invoke `DropckOutlives::new(dropped_ty)).fully_perform(typeck.infcx)` instead.
2315    query dropck_outlives(
2316        goal: CanonicalDropckOutlivesGoal<'tcx>
2317    ) -> Result<
2318        &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, DropckOutlivesResult<'tcx>>>,
2319        NoSolution,
2320    > {
2321        desc { "computing dropck types for `{}`", goal.canonical.value.value.dropped_ty }
2322    }
2323
2324    /// Do not call this query directly: invoke `infcx.predicate_may_hold()` or
2325    /// `infcx.predicate_must_hold()` instead.
2326    query evaluate_obligation(
2327        goal: CanonicalPredicateGoal<'tcx>
2328    ) -> Result<EvaluationResult, OverflowError> {
2329        desc { "evaluating trait selection obligation `{}`", goal.canonical.value.value }
2330    }
2331
2332    /// Do not call this query directly: part of the `Eq` type-op
2333    query type_op_ascribe_user_type(
2334        goal: CanonicalTypeOpAscribeUserTypeGoal<'tcx>
2335    ) -> Result<
2336        &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ()>>,
2337        NoSolution,
2338    > {
2339        desc { "evaluating `type_op_ascribe_user_type` `{:?}`", goal.canonical.value.value }
2340    }
2341
2342    /// Do not call this query directly: part of the `ProvePredicate` type-op
2343    query type_op_prove_predicate(
2344        goal: CanonicalTypeOpProvePredicateGoal<'tcx>
2345    ) -> Result<
2346        &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ()>>,
2347        NoSolution,
2348    > {
2349        desc { "evaluating `type_op_prove_predicate` `{:?}`", goal.canonical.value.value }
2350    }
2351
2352    /// Do not call this query directly: part of the `Normalize` type-op
2353    query type_op_normalize_ty(
2354        goal: CanonicalTypeOpNormalizeGoal<'tcx, Ty<'tcx>>
2355    ) -> Result<
2356        &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, Ty<'tcx>>>,
2357        NoSolution,
2358    > {
2359        desc { "normalizing `{}`", goal.canonical.value.value.value }
2360    }
2361
2362    /// Do not call this query directly: part of the `Normalize` type-op
2363    query type_op_normalize_clause(
2364        goal: CanonicalTypeOpNormalizeGoal<'tcx, ty::Clause<'tcx>>
2365    ) -> Result<
2366        &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ty::Clause<'tcx>>>,
2367        NoSolution,
2368    > {
2369        desc { "normalizing `{:?}`", goal.canonical.value.value.value }
2370    }
2371
2372    /// Do not call this query directly: part of the `Normalize` type-op
2373    query type_op_normalize_poly_fn_sig(
2374        goal: CanonicalTypeOpNormalizeGoal<'tcx, ty::PolyFnSig<'tcx>>
2375    ) -> Result<
2376        &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ty::PolyFnSig<'tcx>>>,
2377        NoSolution,
2378    > {
2379        desc { "normalizing `{:?}`", goal.canonical.value.value.value }
2380    }
2381
2382    /// Do not call this query directly: part of the `Normalize` type-op
2383    query type_op_normalize_fn_sig(
2384        goal: CanonicalTypeOpNormalizeGoal<'tcx, ty::FnSig<'tcx>>
2385    ) -> Result<
2386        &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ty::FnSig<'tcx>>>,
2387        NoSolution,
2388    > {
2389        desc { "normalizing `{:?}`", goal.canonical.value.value.value }
2390    }
2391
2392    query instantiate_and_check_impossible_predicates(key: (DefId, GenericArgsRef<'tcx>)) -> bool {
2393        desc { |tcx|
2394            "checking impossible instantiated predicates: `{}`",
2395            tcx.def_path_str(key.0)
2396        }
2397    }
2398
2399    query is_impossible_associated_item(key: (DefId, DefId)) -> bool {
2400        desc { |tcx|
2401            "checking if `{}` is impossible to reference within `{}`",
2402            tcx.def_path_str(key.1),
2403            tcx.def_path_str(key.0),
2404        }
2405    }
2406
2407    query method_autoderef_steps(
2408        goal: CanonicalTyGoal<'tcx>
2409    ) -> MethodAutoderefStepsResult<'tcx> {
2410        desc { "computing autoderef types for `{}`", goal.canonical.value.value }
2411    }
2412
2413    /// Returns the Rust target features for the current target. These are not always the same as LLVM target features!
2414    query rust_target_features(_: CrateNum) -> &'tcx UnordMap<String, rustc_target::target_features::Stability> {
2415        arena_cache
2416        eval_always
2417        desc { "looking up Rust target features" }
2418    }
2419
2420    query implied_target_features(feature: Symbol) -> &'tcx Vec<Symbol> {
2421        arena_cache
2422        eval_always
2423        desc { "looking up implied target features" }
2424    }
2425
2426    query features_query(_: ()) -> &'tcx rustc_feature::Features {
2427        feedable
2428        desc { "looking up enabled feature gates" }
2429    }
2430
2431    query crate_for_resolver((): ()) -> &'tcx Steal<(rustc_ast::Crate, rustc_ast::AttrVec)> {
2432        feedable
2433        no_hash
2434        desc { "the ast before macro expansion and name resolution" }
2435    }
2436
2437    /// Attempt to resolve the given `DefId` to an `Instance`, for the
2438    /// given generics args (`GenericArgsRef`), returning one of:
2439    ///  * `Ok(Some(instance))` on success
2440    ///  * `Ok(None)` when the `GenericArgsRef` are still too generic,
2441    ///    and therefore don't allow finding the final `Instance`
2442    ///  * `Err(ErrorGuaranteed)` when the `Instance` resolution process
2443    ///    couldn't complete due to errors elsewhere - this is distinct
2444    ///    from `Ok(None)` to avoid misleading diagnostics when an error
2445    ///    has already been/will be emitted, for the original cause.
2446    query resolve_instance_raw(
2447        key: ty::PseudoCanonicalInput<'tcx, (DefId, GenericArgsRef<'tcx>)>
2448    ) -> Result<Option<ty::Instance<'tcx>>, ErrorGuaranteed> {
2449        desc { "resolving instance `{}`", ty::Instance::new(key.value.0, key.value.1) }
2450    }
2451
2452    query reveal_opaque_types_in_bounds(key: ty::Clauses<'tcx>) -> ty::Clauses<'tcx> {
2453        desc { "revealing opaque types in `{:?}`", key }
2454    }
2455
2456    query limits(key: ()) -> Limits {
2457        desc { "looking up limits" }
2458    }
2459
2460    /// Performs an HIR-based well-formed check on the item with the given `HirId`. If
2461    /// we get an `Unimplemented` error that matches the provided `Predicate`, return
2462    /// the cause of the newly created obligation.
2463    ///
2464    /// This is only used by error-reporting code to get a better cause (in particular, a better
2465    /// span) for an *existing* error. Therefore, it is best-effort, and may never handle
2466    /// all of the cases that the normal `ty::Ty`-based wfcheck does. This is fine,
2467    /// because the `ty::Ty`-based wfcheck is always run.
2468    query diagnostic_hir_wf_check(
2469        key: (ty::Predicate<'tcx>, WellFormedLoc)
2470    ) -> Option<&'tcx ObligationCause<'tcx>> {
2471        arena_cache
2472        eval_always
2473        no_hash
2474        desc { "performing HIR wf-checking for predicate `{:?}` at item `{:?}`", key.0, key.1 }
2475    }
2476
2477    /// The list of backend features computed from CLI flags (`-Ctarget-cpu`, `-Ctarget-feature`,
2478    /// `--target` and similar).
2479    query global_backend_features(_: ()) -> &'tcx Vec<String> {
2480        arena_cache
2481        eval_always
2482        desc { "computing the backend features for CLI flags" }
2483    }
2484
2485    query check_validity_requirement(key: (ValidityRequirement, ty::PseudoCanonicalInput<'tcx, Ty<'tcx>>)) -> Result<bool, &'tcx ty::layout::LayoutError<'tcx>> {
2486        desc { "checking validity requirement for `{}`: {}", key.1.value, key.0 }
2487    }
2488
2489    /// This takes the def-id of an associated item from a impl of a trait,
2490    /// and checks its validity against the trait item it corresponds to.
2491    ///
2492    /// Any other def id will ICE.
2493    query compare_impl_item(key: LocalDefId) -> Result<(), ErrorGuaranteed> {
2494        desc { |tcx| "checking assoc item `{}` is compatible with trait definition", tcx.def_path_str(key) }
2495        return_result_from_ensure_ok
2496    }
2497
2498    query deduced_param_attrs(def_id: DefId) -> &'tcx [ty::DeducedParamAttrs] {
2499        desc { |tcx| "deducing parameter attributes for {}", tcx.def_path_str(def_id) }
2500        separate_provide_extern
2501    }
2502
2503    query doc_link_resolutions(def_id: DefId) -> &'tcx DocLinkResMap {
2504        eval_always
2505        desc { "resolutions for documentation links for a module" }
2506        separate_provide_extern
2507    }
2508
2509    query doc_link_traits_in_scope(def_id: DefId) -> &'tcx [DefId] {
2510        eval_always
2511        desc { "traits in scope for documentation links for a module" }
2512        separate_provide_extern
2513    }
2514
2515    /// Get all item paths that were stripped by a `#[cfg]` in a particular crate.
2516    /// Should not be called for the local crate before the resolver outputs are created, as it
2517    /// is only fed there.
2518    query stripped_cfg_items(cnum: CrateNum) -> &'tcx [StrippedCfgItem] {
2519        desc { "getting cfg-ed out item names" }
2520        separate_provide_extern
2521    }
2522
2523    query generics_require_sized_self(def_id: DefId) -> bool {
2524        desc { "check whether the item has a `where Self: Sized` bound" }
2525    }
2526
2527    query cross_crate_inlinable(def_id: DefId) -> bool {
2528        desc { "whether the item should be made inlinable across crates" }
2529        separate_provide_extern
2530    }
2531
2532    /// Perform monomorphization-time checking on this item.
2533    /// This is used for lints/errors that can only be checked once the instance is fully
2534    /// monomorphized.
2535    query check_mono_item(key: ty::Instance<'tcx>) {
2536        desc { "monomorphization-time checking" }
2537    }
2538
2539    /// Builds the set of functions that should be skipped for the move-size check.
2540    query skip_move_check_fns(_: ()) -> &'tcx FxIndexSet<DefId> {
2541        arena_cache
2542        desc { "functions to skip for move-size check" }
2543    }
2544
2545    query items_of_instance(key: (ty::Instance<'tcx>, CollectionMode)) -> (&'tcx [Spanned<MonoItem<'tcx>>], &'tcx [Spanned<MonoItem<'tcx>>]) {
2546        desc { "collecting items used by `{}`", key.0 }
2547        cache_on_disk_if { true }
2548    }
2549
2550    query size_estimate(key: ty::Instance<'tcx>) -> usize {
2551        desc { "estimating codegen size of `{}`", key }
2552        cache_on_disk_if { true }
2553    }
2554}
2555
2556rustc_query_append! { define_callbacks! }
2557rustc_feedable_queries! { define_feedable! }