rustc_middle/query/
mod.rs

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