]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_middle/src/query/mod.rs
Rollup merge of #90156 - jsha:less-border-bottom-2, r=GuillaumeGomez
[rust.git] / compiler / rustc_middle / src / query / mod.rs
1 // Each of these queries corresponds to a function pointer field in the
2 // `Providers` struct for requesting a value of that type, and a method
3 // on `tcx: TyCtxt` (and `tcx.at(span)`) for doing that request in a way
4 // which memoizes and does dep-graph tracking, wrapping around the actual
5 // `Providers` that the driver creates (using several `rustc_*` crates).
6 //
7 // The result type of each query must implement `Clone`, and additionally
8 // `ty::query::values::Value`, which produces an appropriate placeholder
9 // (error) value if the query resulted in a query cycle.
10 // Queries marked with `fatal_cycle` do not need the latter implementation,
11 // as they will raise an fatal error on query cycles instead.
12 rustc_queries! {
13     query trigger_delay_span_bug(key: DefId) -> () {
14         desc { "trigger a delay span bug" }
15     }
16
17     query resolutions(_: ()) -> &'tcx ty::ResolverOutputs {
18         eval_always
19         no_hash
20         desc { "get the resolver outputs" }
21     }
22
23     /// Return the span for a definition.
24     /// Contrary to `def_span` below, this query returns the full absolute span of the definition.
25     /// This span is meant for dep-tracking rather than diagnostics. It should not be used outside
26     /// of rustc_middle::hir::source_map.
27     query source_span(key: LocalDefId) -> Span {
28         desc { "get the source span" }
29     }
30
31     /// Represents crate as a whole (as distinct from the top-level crate module).
32     /// If you call `hir_crate` (e.g., indirectly by calling `tcx.hir().krate()`),
33     /// we will have to assume that any change means that you need to be recompiled.
34     /// This is because the `hir_crate` query gives you access to all other items.
35     /// To avoid this fate, do not call `tcx.hir().krate()`; instead,
36     /// prefer wrappers like `tcx.visit_all_items_in_krate()`.
37     query hir_crate(key: ()) -> &'tcx Crate<'tcx> {
38         eval_always
39         desc { "get the crate HIR" }
40     }
41
42     /// The items in a module.
43     ///
44     /// This can be conveniently accessed by `tcx.hir().visit_item_likes_in_module`.
45     /// Avoid calling this query directly.
46     query hir_module_items(key: LocalDefId) -> rustc_middle::hir::ModuleItems {
47         storage(ArenaCacheSelector<'tcx>)
48         desc { |tcx| "HIR module items in `{}`", tcx.def_path_str(key.to_def_id()) }
49     }
50
51     /// Gives access to the HIR node for the HIR owner `key`.
52     ///
53     /// This can be conveniently accessed by methods on `tcx.hir()`.
54     /// Avoid calling this query directly.
55     query hir_owner(key: LocalDefId) -> Option<crate::hir::Owner<'tcx>> {
56         desc { |tcx| "HIR owner of `{}`", tcx.def_path_str(key.to_def_id()) }
57     }
58
59     /// Gives access to the HIR node's parent for the HIR owner `key`.
60     ///
61     /// This can be conveniently accessed by methods on `tcx.hir()`.
62     /// Avoid calling this query directly.
63     query hir_owner_parent(key: LocalDefId) -> hir::HirId {
64         desc { |tcx| "HIR parent of `{}`", tcx.def_path_str(key.to_def_id()) }
65     }
66
67     /// Gives access to the HIR nodes and bodies inside the HIR owner `key`.
68     ///
69     /// This can be conveniently accessed by methods on `tcx.hir()`.
70     /// Avoid calling this query directly.
71     query hir_owner_nodes(key: LocalDefId) -> Option<&'tcx hir::OwnerNodes<'tcx>> {
72         desc { |tcx| "HIR owner items in `{}`", tcx.def_path_str(key.to_def_id()) }
73     }
74
75     /// Gives access to the HIR attributes inside the HIR owner `key`.
76     ///
77     /// This can be conveniently accessed by methods on `tcx.hir()`.
78     /// Avoid calling this query directly.
79     query hir_attrs(key: LocalDefId) -> &'tcx hir::AttributeMap<'tcx> {
80         desc { |tcx| "HIR owner attributes in `{}`", tcx.def_path_str(key.to_def_id()) }
81     }
82
83     /// Computes the `DefId` of the corresponding const parameter in case the `key` is a
84     /// const argument and returns `None` otherwise.
85     ///
86     /// ```ignore (incomplete)
87     /// let a = foo::<7>();
88     /// //            ^ Calling `opt_const_param_of` for this argument,
89     ///
90     /// fn foo<const N: usize>()
91     /// //           ^ returns this `DefId`.
92     ///
93     /// fn bar() {
94     /// // ^ While calling `opt_const_param_of` for other bodies returns `None`.
95     /// }
96     /// ```
97     // It looks like caching this query on disk actually slightly
98     // worsened performance in #74376.
99     //
100     // Once const generics are more prevalently used, we might want to
101     // consider only caching calls returning `Some`.
102     query opt_const_param_of(key: LocalDefId) -> Option<DefId> {
103         desc { |tcx| "computing the optional const parameter of `{}`", tcx.def_path_str(key.to_def_id()) }
104     }
105
106     /// Given the def_id of a const-generic parameter, computes the associated default const
107     /// parameter. e.g. `fn example<const N: usize=3>` called on `N` would return `3`.
108     query const_param_default(param: DefId) -> &'tcx ty::Const<'tcx> {
109         desc { |tcx| "compute const default for a given parameter `{}`", tcx.def_path_str(param)  }
110         separate_provide_extern
111     }
112
113     query default_anon_const_substs(key: DefId) -> SubstsRef<'tcx> {
114         desc { |tcx| "computing the default generic arguments for `{}`", tcx.def_path_str(key) }
115     }
116
117     /// Records the type of every item.
118     query type_of(key: DefId) -> Ty<'tcx> {
119         desc { |tcx|
120             "{action} `{path}`",
121             action = {
122                 use rustc_hir::def::DefKind;
123                 match tcx.def_kind(key) {
124                     DefKind::TyAlias => "expanding type alias",
125                     DefKind::TraitAlias => "expanding trait alias",
126                     _ => "computing type of",
127                 }
128             },
129             path = tcx.def_path_str(key),
130         }
131         cache_on_disk_if { key.is_local() }
132         separate_provide_extern
133     }
134
135     query analysis(key: ()) -> Result<(), ErrorReported> {
136         eval_always
137         desc { "running analysis passes on this crate" }
138     }
139
140     /// Maps from the `DefId` of an item (trait/struct/enum/fn) to its
141     /// associated generics.
142     query generics_of(key: DefId) -> ty::Generics {
143         desc { |tcx| "computing generics of `{}`", tcx.def_path_str(key) }
144         storage(ArenaCacheSelector<'tcx>)
145         cache_on_disk_if { key.is_local() }
146         separate_provide_extern
147     }
148
149     /// Maps from the `DefId` of an item (trait/struct/enum/fn) to the
150     /// predicates (where-clauses) that must be proven true in order
151     /// to reference it. This is almost always the "predicates query"
152     /// that you want.
153     ///
154     /// `predicates_of` builds on `predicates_defined_on` -- in fact,
155     /// it is almost always the same as that query, except for the
156     /// case of traits. For traits, `predicates_of` contains
157     /// an additional `Self: Trait<...>` predicate that users don't
158     /// actually write. This reflects the fact that to invoke the
159     /// trait (e.g., via `Default::default`) you must supply types
160     /// that actually implement the trait. (However, this extra
161     /// predicate gets in the way of some checks, which are intended
162     /// to operate over only the actual where-clauses written by the
163     /// user.)
164     query predicates_of(key: DefId) -> ty::GenericPredicates<'tcx> {
165         desc { |tcx| "computing predicates of `{}`", tcx.def_path_str(key) }
166         cache_on_disk_if { key.is_local() }
167     }
168
169     /// Returns the list of bounds that can be used for
170     /// `SelectionCandidate::ProjectionCandidate(_)` and
171     /// `ProjectionTyCandidate::TraitDef`.
172     /// Specifically this is the bounds written on the trait's type
173     /// definition, or those after the `impl` keyword
174     ///
175     /// ```ignore (incomplete)
176     /// type X: Bound + 'lt
177     /// //      ^^^^^^^^^^^
178     /// impl Debug + Display
179     /// //   ^^^^^^^^^^^^^^^
180     /// ```
181     ///
182     /// `key` is the `DefId` of the associated type or opaque type.
183     ///
184     /// Bounds from the parent (e.g. with nested impl trait) are not included.
185     query explicit_item_bounds(key: DefId) -> &'tcx [(ty::Predicate<'tcx>, Span)] {
186         desc { |tcx| "finding item bounds for `{}`", tcx.def_path_str(key) }
187         separate_provide_extern
188     }
189
190     /// Elaborated version of the predicates from `explicit_item_bounds`.
191     ///
192     /// For example:
193     ///
194     /// ```
195     /// trait MyTrait {
196     ///     type MyAType: Eq + ?Sized;
197     /// }
198     /// ```
199     ///
200     /// `explicit_item_bounds` returns `[<Self as MyTrait>::MyAType: Eq]`,
201     /// and `item_bounds` returns
202     /// ```text
203     /// [
204     ///     <Self as Trait>::MyAType: Eq,
205     ///     <Self as Trait>::MyAType: PartialEq<<Self as Trait>::MyAType>
206     /// ]
207     /// ```
208     ///
209     /// Bounds from the parent (e.g. with nested impl trait) are not included.
210     query item_bounds(key: DefId) -> &'tcx ty::List<ty::Predicate<'tcx>> {
211         desc { |tcx| "elaborating item bounds for `{}`", tcx.def_path_str(key) }
212     }
213
214     query native_libraries(_: CrateNum) -> Lrc<Vec<NativeLib>> {
215         desc { "looking up the native libraries of a linked crate" }
216         separate_provide_extern
217     }
218
219     query lint_levels(_: ()) -> LintLevelMap {
220         storage(ArenaCacheSelector<'tcx>)
221         eval_always
222         desc { "computing the lint levels for items in this crate" }
223     }
224
225     query parent_module_from_def_id(key: LocalDefId) -> LocalDefId {
226         eval_always
227         desc { |tcx| "parent module of `{}`", tcx.def_path_str(key.to_def_id()) }
228     }
229
230     query expn_that_defined(key: DefId) -> rustc_span::ExpnId {
231         // This query reads from untracked data in definitions.
232         eval_always
233         desc { |tcx| "expansion that defined `{}`", tcx.def_path_str(key) }
234         separate_provide_extern
235     }
236
237     query is_panic_runtime(_: CrateNum) -> bool {
238         fatal_cycle
239         desc { "checking if the crate is_panic_runtime" }
240         separate_provide_extern
241     }
242
243     /// Fetch the THIR for a given body. If typeck for that body failed, returns an empty `Thir`.
244     query thir_body(key: ty::WithOptConstParam<LocalDefId>) -> (&'tcx Steal<thir::Thir<'tcx>>, thir::ExprId) {
245         // Perf tests revealed that hashing THIR is inefficient (see #85729).
246         no_hash
247         desc { |tcx| "building THIR for `{}`", tcx.def_path_str(key.did.to_def_id()) }
248     }
249
250     /// Create a THIR tree for debugging.
251     query thir_tree(key: ty::WithOptConstParam<LocalDefId>) -> String {
252         no_hash
253         desc { |tcx| "constructing THIR tree for `{}`", tcx.def_path_str(key.did.to_def_id()) }
254     }
255
256     /// Set of all the `DefId`s in this crate that have MIR associated with
257     /// them. This includes all the body owners, but also things like struct
258     /// constructors.
259     query mir_keys(_: ()) -> FxHashSet<LocalDefId> {
260         storage(ArenaCacheSelector<'tcx>)
261         desc { "getting a list of all mir_keys" }
262     }
263
264     /// Maps DefId's that have an associated `mir::Body` to the result
265     /// of the MIR const-checking pass. This is the set of qualifs in
266     /// the final value of a `const`.
267     query mir_const_qualif(key: DefId) -> mir::ConstQualifs {
268         desc { |tcx| "const checking `{}`", tcx.def_path_str(key) }
269         cache_on_disk_if { key.is_local() }
270         separate_provide_extern
271     }
272     query mir_const_qualif_const_arg(
273         key: (LocalDefId, DefId)
274     ) -> mir::ConstQualifs {
275         desc {
276             |tcx| "const checking the const argument `{}`",
277             tcx.def_path_str(key.0.to_def_id())
278         }
279     }
280
281     /// Fetch the MIR for a given `DefId` right after it's built - this includes
282     /// unreachable code.
283     query mir_built(key: ty::WithOptConstParam<LocalDefId>) -> &'tcx Steal<mir::Body<'tcx>> {
284         desc { |tcx| "building MIR for `{}`", tcx.def_path_str(key.did.to_def_id()) }
285     }
286
287     /// Fetch the MIR for a given `DefId` up till the point where it is
288     /// ready for const qualification.
289     ///
290     /// See the README for the `mir` module for details.
291     query mir_const(key: ty::WithOptConstParam<LocalDefId>) -> &'tcx Steal<mir::Body<'tcx>> {
292         desc {
293             |tcx| "processing MIR for {}`{}`",
294             if key.const_param_did.is_some() { "the const argument " } else { "" },
295             tcx.def_path_str(key.did.to_def_id()),
296         }
297         no_hash
298     }
299
300     /// Try to build an abstract representation of the given constant.
301     query thir_abstract_const(
302         key: DefId
303     ) -> Result<Option<&'tcx [thir::abstract_const::Node<'tcx>]>, ErrorReported> {
304         desc {
305             |tcx| "building an abstract representation for {}", tcx.def_path_str(key),
306         }
307         separate_provide_extern
308     }
309     /// Try to build an abstract representation of the given constant.
310     query thir_abstract_const_of_const_arg(
311         key: (LocalDefId, DefId)
312     ) -> Result<Option<&'tcx [thir::abstract_const::Node<'tcx>]>, ErrorReported> {
313         desc {
314             |tcx|
315             "building an abstract representation for the const argument {}",
316             tcx.def_path_str(key.0.to_def_id()),
317         }
318     }
319
320     query try_unify_abstract_consts(key: (
321         ty::Unevaluated<'tcx, ()>, ty::Unevaluated<'tcx, ()>
322     )) -> bool {
323         desc {
324             |tcx| "trying to unify the generic constants {} and {}",
325             tcx.def_path_str(key.0.def.did), tcx.def_path_str(key.1.def.did)
326         }
327     }
328
329     query mir_drops_elaborated_and_const_checked(
330         key: ty::WithOptConstParam<LocalDefId>
331     ) -> &'tcx Steal<mir::Body<'tcx>> {
332         no_hash
333         desc { |tcx| "elaborating drops for `{}`", tcx.def_path_str(key.did.to_def_id()) }
334     }
335
336     query mir_for_ctfe(
337         key: DefId
338     ) -> &'tcx mir::Body<'tcx> {
339         desc { |tcx| "caching mir of `{}` for CTFE", tcx.def_path_str(key) }
340         cache_on_disk_if { key.is_local() }
341         separate_provide_extern
342     }
343
344     query mir_for_ctfe_of_const_arg(key: (LocalDefId, DefId)) -> &'tcx mir::Body<'tcx> {
345         desc {
346             |tcx| "MIR for CTFE of the const argument `{}`",
347             tcx.def_path_str(key.0.to_def_id())
348         }
349     }
350
351     query mir_promoted(key: ty::WithOptConstParam<LocalDefId>) ->
352         (
353             &'tcx Steal<mir::Body<'tcx>>,
354             &'tcx Steal<IndexVec<mir::Promoted, mir::Body<'tcx>>>
355         ) {
356         no_hash
357         desc {
358             |tcx| "processing {}`{}`",
359             if key.const_param_did.is_some() { "the const argument " } else { "" },
360             tcx.def_path_str(key.did.to_def_id()),
361         }
362     }
363
364     query symbols_for_closure_captures(
365         key: (LocalDefId, DefId)
366     ) -> Vec<rustc_span::Symbol> {
367         desc {
368             |tcx| "symbols for captures of closure `{}` in `{}`",
369             tcx.def_path_str(key.1),
370             tcx.def_path_str(key.0.to_def_id())
371         }
372     }
373
374     /// MIR after our optimization passes have run. This is MIR that is ready
375     /// for codegen. This is also the only query that can fetch non-local MIR, at present.
376     query optimized_mir(key: DefId) -> &'tcx mir::Body<'tcx> {
377         desc { |tcx| "optimizing MIR for `{}`", tcx.def_path_str(key) }
378         cache_on_disk_if { key.is_local() }
379         separate_provide_extern
380     }
381
382     /// Returns coverage summary info for a function, after executing the `InstrumentCoverage`
383     /// MIR pass (assuming the -Zinstrument-coverage option is enabled).
384     query coverageinfo(key: ty::InstanceDef<'tcx>) -> mir::CoverageInfo {
385         desc { |tcx| "retrieving coverage info from MIR for `{}`", tcx.def_path_str(key.def_id()) }
386         storage(ArenaCacheSelector<'tcx>)
387     }
388
389     /// Returns the name of the file that contains the function body, if instrumented for coverage.
390     query covered_file_name(key: DefId) -> Option<Symbol> {
391         desc {
392             |tcx| "retrieving the covered file name, if instrumented, for `{}`",
393             tcx.def_path_str(key)
394         }
395         storage(ArenaCacheSelector<'tcx>)
396         cache_on_disk_if { key.is_local() }
397     }
398
399     /// Returns the `CodeRegions` for a function that has instrumented coverage, in case the
400     /// function was optimized out before codegen, and before being added to the Coverage Map.
401     query covered_code_regions(key: DefId) -> Vec<&'tcx mir::coverage::CodeRegion> {
402         desc {
403             |tcx| "retrieving the covered `CodeRegion`s, if instrumented, for `{}`",
404             tcx.def_path_str(key)
405         }
406         storage(ArenaCacheSelector<'tcx>)
407         cache_on_disk_if { key.is_local() }
408     }
409
410     /// The `DefId` is the `DefId` of the containing MIR body. Promoteds do not have their own
411     /// `DefId`. This function returns all promoteds in the specified body. The body references
412     /// promoteds by the `DefId` and the `mir::Promoted` index. This is necessary, because
413     /// after inlining a body may refer to promoteds from other bodies. In that case you still
414     /// need to use the `DefId` of the original body.
415     query promoted_mir(key: DefId) -> &'tcx IndexVec<mir::Promoted, mir::Body<'tcx>> {
416         desc { |tcx| "optimizing promoted MIR for `{}`", tcx.def_path_str(key) }
417         cache_on_disk_if { key.is_local() }
418         separate_provide_extern
419     }
420     query promoted_mir_of_const_arg(
421         key: (LocalDefId, DefId)
422     ) -> &'tcx IndexVec<mir::Promoted, mir::Body<'tcx>> {
423         desc {
424             |tcx| "optimizing promoted MIR for the const argument `{}`",
425             tcx.def_path_str(key.0.to_def_id()),
426         }
427     }
428
429     /// Erases regions from `ty` to yield a new type.
430     /// Normally you would just use `tcx.erase_regions(value)`,
431     /// however, which uses this query as a kind of cache.
432     query erase_regions_ty(ty: Ty<'tcx>) -> Ty<'tcx> {
433         // This query is not expected to have input -- as a result, it
434         // is not a good candidates for "replay" because it is essentially a
435         // pure function of its input (and hence the expectation is that
436         // no caller would be green **apart** from just these
437         // queries). Making it anonymous avoids hashing the result, which
438         // may save a bit of time.
439         anon
440         desc { "erasing regions from `{:?}`", ty }
441     }
442
443     query wasm_import_module_map(_: CrateNum) -> FxHashMap<DefId, String> {
444         storage(ArenaCacheSelector<'tcx>)
445         desc { "wasm import module map" }
446     }
447
448     /// Maps from the `DefId` of an item (trait/struct/enum/fn) to the
449     /// predicates (where-clauses) directly defined on it. This is
450     /// equal to the `explicit_predicates_of` predicates plus the
451     /// `inferred_outlives_of` predicates.
452     query predicates_defined_on(key: DefId) -> ty::GenericPredicates<'tcx> {
453         desc { |tcx| "computing predicates of `{}`", tcx.def_path_str(key) }
454     }
455
456     /// Returns everything that looks like a predicate written explicitly
457     /// by the user on a trait item.
458     ///
459     /// Traits are unusual, because predicates on associated types are
460     /// converted into bounds on that type for backwards compatibility:
461     ///
462     /// trait X where Self::U: Copy { type U; }
463     ///
464     /// becomes
465     ///
466     /// trait X { type U: Copy; }
467     ///
468     /// `explicit_predicates_of` and `explicit_item_bounds` will then take
469     /// the appropriate subsets of the predicates here.
470     query trait_explicit_predicates_and_bounds(key: LocalDefId) -> ty::GenericPredicates<'tcx> {
471         desc { |tcx| "computing explicit predicates of trait `{}`", tcx.def_path_str(key.to_def_id()) }
472     }
473
474     /// Returns the predicates written explicitly by the user.
475     query explicit_predicates_of(key: DefId) -> ty::GenericPredicates<'tcx> {
476         desc { |tcx| "computing explicit predicates of `{}`", tcx.def_path_str(key) }
477         separate_provide_extern
478     }
479
480     /// Returns the inferred outlives predicates (e.g., for `struct
481     /// Foo<'a, T> { x: &'a T }`, this would return `T: 'a`).
482     query inferred_outlives_of(key: DefId) -> &'tcx [(ty::Predicate<'tcx>, Span)] {
483         desc { |tcx| "computing inferred outlives predicates of `{}`", tcx.def_path_str(key) }
484         separate_provide_extern
485     }
486
487     /// Maps from the `DefId` of a trait to the list of
488     /// super-predicates. This is a subset of the full list of
489     /// predicates. We store these in a separate map because we must
490     /// evaluate them even during type conversion, often before the
491     /// full predicates are available (note that supertraits have
492     /// additional acyclicity requirements).
493     query super_predicates_of(key: DefId) -> ty::GenericPredicates<'tcx> {
494         desc { |tcx| "computing the super predicates of `{}`", tcx.def_path_str(key) }
495         separate_provide_extern
496     }
497
498     /// The `Option<Ident>` is the name of an associated type. If it is `None`, then this query
499     /// returns the full set of predicates. If `Some<Ident>`, then the query returns only the
500     /// subset of super-predicates that reference traits that define the given associated type.
501     /// This is used to avoid cycles in resolving types like `T::Item`.
502     query super_predicates_that_define_assoc_type(key: (DefId, Option<rustc_span::symbol::Ident>)) -> ty::GenericPredicates<'tcx> {
503         desc { |tcx| "computing the super traits of `{}`{}",
504             tcx.def_path_str(key.0),
505             if let Some(assoc_name) = key.1 { format!(" with associated type name `{}`", assoc_name) } else { "".to_string() },
506         }
507     }
508
509     /// To avoid cycles within the predicates of a single item we compute
510     /// per-type-parameter predicates for resolving `T::AssocTy`.
511     query type_param_predicates(key: (DefId, LocalDefId, rustc_span::symbol::Ident)) -> ty::GenericPredicates<'tcx> {
512         desc { |tcx| "computing the bounds for type parameter `{}`", {
513             let id = tcx.hir().local_def_id_to_hir_id(key.1);
514             tcx.hir().ty_param_name(id)
515         }}
516     }
517
518     query trait_def(key: DefId) -> ty::TraitDef {
519         desc { |tcx| "computing trait definition for `{}`", tcx.def_path_str(key) }
520         storage(ArenaCacheSelector<'tcx>)
521         separate_provide_extern
522     }
523     query adt_def(key: DefId) -> &'tcx ty::AdtDef {
524         desc { |tcx| "computing ADT definition for `{}`", tcx.def_path_str(key) }
525         separate_provide_extern
526     }
527     query adt_destructor(key: DefId) -> Option<ty::Destructor> {
528         desc { |tcx| "computing `Drop` impl for `{}`", tcx.def_path_str(key) }
529         separate_provide_extern
530     }
531
532     // The cycle error here should be reported as an error by `check_representable`.
533     // We consider the type as Sized in the meanwhile to avoid
534     // further errors (done in impl Value for AdtSizedConstraint).
535     // Use `cycle_delay_bug` to delay the cycle error here to be emitted later
536     // in case we accidentally otherwise don't emit an error.
537     query adt_sized_constraint(
538         key: DefId
539     ) -> AdtSizedConstraint<'tcx> {
540         desc { |tcx| "computing `Sized` constraints for `{}`", tcx.def_path_str(key) }
541         cycle_delay_bug
542     }
543
544     query adt_dtorck_constraint(
545         key: DefId
546     ) -> Result<DtorckConstraint<'tcx>, NoSolution> {
547         desc { |tcx| "computing drop-check constraints for `{}`", tcx.def_path_str(key) }
548     }
549
550     /// Returns `true` if this is a const fn, use the `is_const_fn` to know whether your crate
551     /// actually sees it as const fn (e.g., the const-fn-ness might be unstable and you might
552     /// not have the feature gate active).
553     ///
554     /// **Do not call this function manually.** It is only meant to cache the base data for the
555     /// `is_const_fn` function.
556     query is_const_fn_raw(key: DefId) -> bool {
557         desc { |tcx| "checking if item is const fn: `{}`", tcx.def_path_str(key) }
558         separate_provide_extern
559     }
560
561     query asyncness(key: DefId) -> hir::IsAsync {
562         desc { |tcx| "checking if the function is async: `{}`", tcx.def_path_str(key) }
563         separate_provide_extern
564     }
565
566     /// Returns `true` if calls to the function may be promoted.
567     ///
568     /// This is either because the function is e.g., a tuple-struct or tuple-variant
569     /// constructor, or because it has the `#[rustc_promotable]` attribute. The attribute should
570     /// be removed in the future in favour of some form of check which figures out whether the
571     /// function does not inspect the bits of any of its arguments (so is essentially just a
572     /// constructor function).
573     query is_promotable_const_fn(key: DefId) -> bool {
574         desc { |tcx| "checking if item is promotable: `{}`", tcx.def_path_str(key) }
575     }
576
577     /// Returns `true` if this is a foreign item (i.e., linked via `extern { ... }`).
578     query is_foreign_item(key: DefId) -> bool {
579         desc { |tcx| "checking if `{}` is a foreign item", tcx.def_path_str(key) }
580         separate_provide_extern
581     }
582
583     /// Returns `Some(mutability)` if the node pointed to by `def_id` is a static item.
584     query static_mutability(def_id: DefId) -> Option<hir::Mutability> {
585         desc { |tcx| "looking up static mutability of `{}`", tcx.def_path_str(def_id) }
586         separate_provide_extern
587     }
588
589     /// Returns `Some(generator_kind)` if the node pointed to by `def_id` is a generator.
590     query generator_kind(def_id: DefId) -> Option<hir::GeneratorKind> {
591         desc { |tcx| "looking up generator kind of `{}`", tcx.def_path_str(def_id) }
592         separate_provide_extern
593     }
594
595     /// Gets a map with the variance of every item; use `item_variance` instead.
596     query crate_variances(_: ()) -> ty::CrateVariancesMap<'tcx> {
597         storage(ArenaCacheSelector<'tcx>)
598         desc { "computing the variances for items in this crate" }
599     }
600
601     /// Maps from the `DefId` of a type or region parameter to its (inferred) variance.
602     query variances_of(def_id: DefId) -> &'tcx [ty::Variance] {
603         desc { |tcx| "computing the variances of `{}`", tcx.def_path_str(def_id) }
604         separate_provide_extern
605     }
606
607     /// Maps from thee `DefId` of a type to its (inferred) outlives.
608     query inferred_outlives_crate(_: ()) -> ty::CratePredicatesMap<'tcx> {
609         storage(ArenaCacheSelector<'tcx>)
610         desc { "computing the inferred outlives predicates for items in this crate" }
611     }
612
613     /// Maps from an impl/trait `DefId` to a list of the `DefId`s of its items.
614     query associated_item_def_ids(key: DefId) -> &'tcx [DefId] {
615         desc { |tcx| "collecting associated items of `{}`", tcx.def_path_str(key) }
616         separate_provide_extern
617     }
618
619     /// Maps from a trait item to the trait item "descriptor".
620     query associated_item(key: DefId) -> ty::AssocItem {
621         desc { |tcx| "computing associated item data for `{}`", tcx.def_path_str(key) }
622         storage(ArenaCacheSelector<'tcx>)
623         separate_provide_extern
624     }
625
626     /// Collects the associated items defined on a trait or impl.
627     query associated_items(key: DefId) -> ty::AssocItems<'tcx> {
628         storage(ArenaCacheSelector<'tcx>)
629         desc { |tcx| "collecting associated items of {}", tcx.def_path_str(key) }
630     }
631
632     /// Given an `impl_id`, return the trait it implements.
633     /// Return `None` if this is an inherent impl.
634     query impl_trait_ref(impl_id: DefId) -> Option<ty::TraitRef<'tcx>> {
635         desc { |tcx| "computing trait implemented by `{}`", tcx.def_path_str(impl_id) }
636         separate_provide_extern
637     }
638     query impl_polarity(impl_id: DefId) -> ty::ImplPolarity {
639         desc { |tcx| "computing implementation polarity of `{}`", tcx.def_path_str(impl_id) }
640         separate_provide_extern
641     }
642
643     query issue33140_self_ty(key: DefId) -> Option<ty::Ty<'tcx>> {
644         desc { |tcx| "computing Self type wrt issue #33140 `{}`", tcx.def_path_str(key) }
645     }
646
647     /// Maps a `DefId` of a type to a list of its inherent impls.
648     /// Contains implementations of methods that are inherent to a type.
649     /// Methods in these implementations don't need to be exported.
650     query inherent_impls(key: DefId) -> &'tcx [DefId] {
651         desc { |tcx| "collecting inherent impls for `{}`", tcx.def_path_str(key) }
652         eval_always
653         separate_provide_extern
654     }
655
656     /// The result of unsafety-checking this `LocalDefId`.
657     query unsafety_check_result(key: LocalDefId) -> &'tcx mir::UnsafetyCheckResult {
658         desc { |tcx| "unsafety-checking `{}`", tcx.def_path_str(key.to_def_id()) }
659         cache_on_disk_if { true }
660     }
661     query unsafety_check_result_for_const_arg(key: (LocalDefId, DefId)) -> &'tcx mir::UnsafetyCheckResult {
662         desc {
663             |tcx| "unsafety-checking the const argument `{}`",
664             tcx.def_path_str(key.0.to_def_id())
665         }
666     }
667
668     /// Unsafety-check this `LocalDefId` with THIR unsafeck. This should be
669     /// used with `-Zthir-unsafeck`.
670     query thir_check_unsafety(key: LocalDefId) {
671         desc { |tcx| "unsafety-checking `{}`", tcx.def_path_str(key.to_def_id()) }
672         cache_on_disk_if { true }
673     }
674     query thir_check_unsafety_for_const_arg(key: (LocalDefId, DefId)) {
675         desc {
676             |tcx| "unsafety-checking the const argument `{}`",
677             tcx.def_path_str(key.0.to_def_id())
678         }
679     }
680
681     /// HACK: when evaluated, this reports an "unsafe derive on repr(packed)" error.
682     ///
683     /// Unsafety checking is executed for each method separately, but we only want
684     /// to emit this error once per derive. As there are some impls with multiple
685     /// methods, we use a query for deduplication.
686     query unsafe_derive_on_repr_packed(key: LocalDefId) -> () {
687         desc { |tcx| "processing `{}`", tcx.def_path_str(key.to_def_id()) }
688     }
689
690     /// Computes the signature of the function.
691     query fn_sig(key: DefId) -> ty::PolyFnSig<'tcx> {
692         desc { |tcx| "computing function signature of `{}`", tcx.def_path_str(key) }
693         separate_provide_extern
694     }
695
696     /// Performs lint checking for the module.
697     query lint_mod(key: LocalDefId) -> () {
698         desc { |tcx| "linting {}", describe_as_module(key, tcx) }
699     }
700
701     /// Checks the attributes in the module.
702     query check_mod_attrs(key: LocalDefId) -> () {
703         desc { |tcx| "checking attributes in {}", describe_as_module(key, tcx) }
704     }
705
706     /// Checks for uses of unstable APIs in the module.
707     query check_mod_unstable_api_usage(key: LocalDefId) -> () {
708         desc { |tcx| "checking for unstable API usage in {}", describe_as_module(key, tcx) }
709     }
710
711     /// Checks the const bodies in the module for illegal operations (e.g. `if` or `loop`).
712     query check_mod_const_bodies(key: LocalDefId) -> () {
713         desc { |tcx| "checking consts in {}", describe_as_module(key, tcx) }
714     }
715
716     /// Checks the loops in the module.
717     query check_mod_loops(key: LocalDefId) -> () {
718         desc { |tcx| "checking loops in {}", describe_as_module(key, tcx) }
719     }
720
721     query check_mod_naked_functions(key: LocalDefId) -> () {
722         desc { |tcx| "checking naked functions in {}", describe_as_module(key, tcx) }
723     }
724
725     query check_mod_item_types(key: LocalDefId) -> () {
726         desc { |tcx| "checking item types in {}", describe_as_module(key, tcx) }
727     }
728
729     query check_mod_privacy(key: LocalDefId) -> () {
730         desc { |tcx| "checking privacy in {}", describe_as_module(key, tcx) }
731     }
732
733     query check_mod_intrinsics(key: LocalDefId) -> () {
734         desc { |tcx| "checking intrinsics in {}", describe_as_module(key, tcx) }
735     }
736
737     query check_mod_liveness(key: LocalDefId) -> () {
738         desc { |tcx| "checking liveness of variables in {}", describe_as_module(key, tcx) }
739     }
740
741     query check_mod_impl_wf(key: LocalDefId) -> () {
742         desc { |tcx| "checking that impls are well-formed in {}", describe_as_module(key, tcx) }
743     }
744
745     query collect_mod_item_types(key: LocalDefId) -> () {
746         desc { |tcx| "collecting item types in {}", describe_as_module(key, tcx) }
747     }
748
749     /// Caches `CoerceUnsized` kinds for impls on custom types.
750     query coerce_unsized_info(key: DefId) -> ty::adjustment::CoerceUnsizedInfo {
751         desc { |tcx| "computing CoerceUnsized info for `{}`", tcx.def_path_str(key) }
752         separate_provide_extern
753     }
754
755     query typeck_item_bodies(_: ()) -> () {
756         desc { "type-checking all item bodies" }
757     }
758
759     query typeck(key: LocalDefId) -> &'tcx ty::TypeckResults<'tcx> {
760         desc { |tcx| "type-checking `{}`", tcx.def_path_str(key.to_def_id()) }
761         cache_on_disk_if { true }
762     }
763     query typeck_const_arg(
764         key: (LocalDefId, DefId)
765     ) -> &'tcx ty::TypeckResults<'tcx> {
766         desc {
767             |tcx| "type-checking the const argument `{}`",
768             tcx.def_path_str(key.0.to_def_id()),
769         }
770     }
771     query diagnostic_only_typeck(key: LocalDefId) -> &'tcx ty::TypeckResults<'tcx> {
772         desc { |tcx| "type-checking `{}`", tcx.def_path_str(key.to_def_id()) }
773         cache_on_disk_if { true }
774         load_cached(tcx, id) {
775             let typeck_results: Option<ty::TypeckResults<'tcx>> = tcx
776                 .on_disk_cache().as_ref()
777                 .and_then(|c| c.try_load_query_result(*tcx, id));
778
779             typeck_results.map(|x| &*tcx.arena.alloc(x))
780         }
781     }
782
783     query used_trait_imports(key: LocalDefId) -> &'tcx FxHashSet<LocalDefId> {
784         desc { |tcx| "used_trait_imports `{}`", tcx.def_path_str(key.to_def_id()) }
785         cache_on_disk_if { true }
786     }
787
788     query has_typeck_results(def_id: DefId) -> bool {
789         desc { |tcx| "checking whether `{}` has a body", tcx.def_path_str(def_id) }
790     }
791
792     query coherent_trait(def_id: DefId) -> () {
793         desc { |tcx| "coherence checking all impls of trait `{}`", tcx.def_path_str(def_id) }
794     }
795
796     /// Borrow-checks the function body. If this is a closure, returns
797     /// additional requirements that the closure's creator must verify.
798     query mir_borrowck(key: LocalDefId) -> &'tcx mir::BorrowCheckResult<'tcx> {
799         desc { |tcx| "borrow-checking `{}`", tcx.def_path_str(key.to_def_id()) }
800         cache_on_disk_if(tcx) { tcx.is_closure(key.to_def_id()) }
801     }
802     query mir_borrowck_const_arg(key: (LocalDefId, DefId)) -> &'tcx mir::BorrowCheckResult<'tcx> {
803         desc {
804             |tcx| "borrow-checking the const argument`{}`",
805             tcx.def_path_str(key.0.to_def_id())
806         }
807     }
808
809     /// Gets a complete map from all types to their inherent impls.
810     /// Not meant to be used directly outside of coherence.
811     query crate_inherent_impls(k: ()) -> CrateInherentImpls {
812         storage(ArenaCacheSelector<'tcx>)
813         eval_always
814         desc { "all inherent impls defined in crate" }
815     }
816
817     /// Checks all types in the crate for overlap in their inherent impls. Reports errors.
818     /// Not meant to be used directly outside of coherence.
819     query crate_inherent_impls_overlap_check(_: ())
820         -> () {
821         eval_always
822         desc { "check for overlap between inherent impls defined in this crate" }
823     }
824
825     /// Check whether the function has any recursion that could cause the inliner to trigger
826     /// a cycle. Returns the call stack causing the cycle. The call stack does not contain the
827     /// current function, just all intermediate functions.
828     query mir_callgraph_reachable(key: (ty::Instance<'tcx>, LocalDefId)) -> bool {
829         fatal_cycle
830         desc { |tcx|
831             "computing if `{}` (transitively) calls `{}`",
832             key.0,
833             tcx.def_path_str(key.1.to_def_id()),
834         }
835     }
836
837     /// Obtain all the calls into other local functions
838     query mir_inliner_callees(key: ty::InstanceDef<'tcx>) -> &'tcx [(DefId, SubstsRef<'tcx>)] {
839         fatal_cycle
840         desc { |tcx|
841             "computing all local function calls in `{}`",
842             tcx.def_path_str(key.def_id()),
843         }
844     }
845
846     /// Evaluates a constant and returns the computed allocation.
847     ///
848     /// **Do not use this** directly, use the `tcx.eval_static_initializer` wrapper.
849     query eval_to_allocation_raw(key: ty::ParamEnvAnd<'tcx, GlobalId<'tcx>>)
850         -> EvalToAllocationRawResult<'tcx> {
851         desc { |tcx|
852             "const-evaluating + checking `{}`",
853             key.value.display(tcx)
854         }
855         cache_on_disk_if { true }
856     }
857
858     /// Evaluates const items or anonymous constants
859     /// (such as enum variant explicit discriminants or array lengths)
860     /// into a representation suitable for the type system and const generics.
861     ///
862     /// **Do not use this** directly, use one of the following wrappers: `tcx.const_eval_poly`,
863     /// `tcx.const_eval_resolve`, `tcx.const_eval_instance`, or `tcx.const_eval_global_id`.
864     query eval_to_const_value_raw(key: ty::ParamEnvAnd<'tcx, GlobalId<'tcx>>)
865         -> EvalToConstValueResult<'tcx> {
866         desc { |tcx|
867             "simplifying constant for the type system `{}`",
868             key.value.display(tcx)
869         }
870         cache_on_disk_if { true }
871     }
872
873     /// Convert an evaluated constant to a type level constant or
874     /// return `None` if that is not possible.
875     query const_to_valtree(
876         key: ty::ParamEnvAnd<'tcx, ConstAlloc<'tcx>>
877     ) -> Option<ty::ValTree<'tcx>> {
878         desc { "destructure constant" }
879     }
880
881     /// Destructure a constant ADT or array into its variant index and its
882     /// field values.
883     query destructure_const(
884         key: ty::ParamEnvAnd<'tcx, &'tcx ty::Const<'tcx>>
885     ) -> mir::DestructuredConst<'tcx> {
886         desc { "destructure constant" }
887     }
888
889     /// Dereference a constant reference or raw pointer and turn the result into a constant
890     /// again.
891     query deref_const(
892         key: ty::ParamEnvAnd<'tcx, &'tcx ty::Const<'tcx>>
893     ) -> &'tcx ty::Const<'tcx> {
894         desc { "deref constant" }
895     }
896
897     query const_caller_location(key: (rustc_span::Symbol, u32, u32)) -> ConstValue<'tcx> {
898         desc { "get a &core::panic::Location referring to a span" }
899     }
900
901     query lit_to_const(
902         key: LitToConstInput<'tcx>
903     ) -> Result<&'tcx ty::Const<'tcx>, LitToConstError> {
904         desc { "converting literal to const" }
905     }
906
907     query check_match(key: DefId) {
908         desc { |tcx| "match-checking `{}`", tcx.def_path_str(key) }
909         cache_on_disk_if { key.is_local() }
910     }
911
912     /// Performs part of the privacy check and computes "access levels".
913     query privacy_access_levels(_: ()) -> &'tcx AccessLevels {
914         eval_always
915         desc { "privacy access levels" }
916     }
917     query check_private_in_public(_: ()) -> () {
918         eval_always
919         desc { "checking for private elements in public interfaces" }
920     }
921
922     query reachable_set(_: ()) -> FxHashSet<LocalDefId> {
923         storage(ArenaCacheSelector<'tcx>)
924         desc { "reachability" }
925     }
926
927     /// Per-body `region::ScopeTree`. The `DefId` should be the owner `DefId` for the body;
928     /// in the case of closures, this will be redirected to the enclosing function.
929     query region_scope_tree(def_id: DefId) -> &'tcx region::ScopeTree {
930         desc { |tcx| "computing drop scopes for `{}`", tcx.def_path_str(def_id) }
931     }
932
933     /// Generates a MIR body for the shim.
934     query mir_shims(key: ty::InstanceDef<'tcx>) -> mir::Body<'tcx> {
935         storage(ArenaCacheSelector<'tcx>)
936         desc { |tcx| "generating MIR shim for `{}`", tcx.def_path_str(key.def_id()) }
937     }
938
939     /// The `symbol_name` query provides the symbol name for calling a
940     /// given instance from the local crate. In particular, it will also
941     /// look up the correct symbol name of instances from upstream crates.
942     query symbol_name(key: ty::Instance<'tcx>) -> ty::SymbolName<'tcx> {
943         desc { "computing the symbol for `{}`", key }
944         cache_on_disk_if { true }
945     }
946
947     query opt_def_kind(def_id: DefId) -> Option<DefKind> {
948         desc { |tcx| "looking up definition kind of `{}`", tcx.def_path_str(def_id) }
949         separate_provide_extern
950     }
951
952     /// Gets the span for the definition.
953     query def_span(def_id: DefId) -> Span {
954         desc { |tcx| "looking up span for `{}`", tcx.def_path_str(def_id) }
955         separate_provide_extern
956     }
957
958     /// Gets the span for the identifier of the definition.
959     query def_ident_span(def_id: DefId) -> Option<Span> {
960         desc { |tcx| "looking up span for `{}`'s identifier", tcx.def_path_str(def_id) }
961         separate_provide_extern
962     }
963
964     query lookup_stability(def_id: DefId) -> Option<&'tcx attr::Stability> {
965         desc { |tcx| "looking up stability of `{}`", tcx.def_path_str(def_id) }
966         separate_provide_extern
967     }
968
969     query lookup_const_stability(def_id: DefId) -> Option<&'tcx attr::ConstStability> {
970         desc { |tcx| "looking up const stability of `{}`", tcx.def_path_str(def_id) }
971         separate_provide_extern
972     }
973
974     query should_inherit_track_caller(def_id: DefId) -> bool {
975         desc { |tcx| "computing should_inherit_track_caller of `{}`", tcx.def_path_str(def_id) }
976     }
977
978     query lookup_deprecation_entry(def_id: DefId) -> Option<DeprecationEntry> {
979         desc { |tcx| "checking whether `{}` is deprecated", tcx.def_path_str(def_id) }
980         separate_provide_extern
981     }
982
983     query item_attrs(def_id: DefId) -> &'tcx [ast::Attribute] {
984         desc { |tcx| "collecting attributes of `{}`", tcx.def_path_str(def_id) }
985         separate_provide_extern
986     }
987
988     query codegen_fn_attrs(def_id: DefId) -> CodegenFnAttrs {
989         desc { |tcx| "computing codegen attributes of `{}`", tcx.def_path_str(def_id) }
990         storage(ArenaCacheSelector<'tcx>)
991         cache_on_disk_if { true }
992     }
993
994     query fn_arg_names(def_id: DefId) -> &'tcx [rustc_span::symbol::Ident] {
995         desc { |tcx| "looking up function parameter names for `{}`", tcx.def_path_str(def_id) }
996         separate_provide_extern
997     }
998     /// Gets the rendered value of the specified constant or associated constant.
999     /// Used by rustdoc.
1000     query rendered_const(def_id: DefId) -> String {
1001         desc { |tcx| "rendering constant intializer of `{}`", tcx.def_path_str(def_id) }
1002         separate_provide_extern
1003     }
1004     query impl_parent(def_id: DefId) -> Option<DefId> {
1005         desc { |tcx| "computing specialization parent impl of `{}`", tcx.def_path_str(def_id) }
1006         separate_provide_extern
1007     }
1008
1009     /// Given an `associated_item`, find the trait it belongs to.
1010     /// Return `None` if the `DefId` is not an associated item.
1011     query trait_of_item(associated_item: DefId) -> Option<DefId> {
1012         desc { |tcx| "finding trait defining `{}`", tcx.def_path_str(associated_item) }
1013         separate_provide_extern
1014     }
1015
1016     query is_ctfe_mir_available(key: DefId) -> bool {
1017         desc { |tcx| "checking if item has ctfe mir available: `{}`", tcx.def_path_str(key) }
1018         separate_provide_extern
1019     }
1020     query is_mir_available(key: DefId) -> bool {
1021         desc { |tcx| "checking if item has mir available: `{}`", tcx.def_path_str(key) }
1022         separate_provide_extern
1023     }
1024
1025     query own_existential_vtable_entries(
1026         key: ty::PolyExistentialTraitRef<'tcx>
1027     ) -> &'tcx [DefId] {
1028         desc { |tcx| "finding all existential vtable entries for trait {}", tcx.def_path_str(key.def_id()) }
1029     }
1030
1031     query vtable_entries(key: ty::PolyTraitRef<'tcx>)
1032                         -> &'tcx [ty::VtblEntry<'tcx>] {
1033         desc { |tcx| "finding all vtable entries for trait {}", tcx.def_path_str(key.def_id()) }
1034     }
1035
1036     query vtable_trait_upcasting_coercion_new_vptr_slot(key: (ty::Ty<'tcx>, ty::Ty<'tcx>)) -> Option<usize> {
1037         desc { |tcx| "finding the slot within vtable for trait object {} vtable ptr during trait upcasting coercion from {} vtable",
1038             key.1, key.0 }
1039     }
1040
1041     query vtable_allocation(key: (Ty<'tcx>, Option<ty::PolyExistentialTraitRef<'tcx>>)) -> mir::interpret::AllocId {
1042         desc { |tcx| "vtable const allocation for <{} as {}>",
1043             key.0,
1044             key.1.map(|trait_ref| format!("{}", trait_ref)).unwrap_or("_".to_owned())
1045         }
1046     }
1047
1048     query codegen_fulfill_obligation(
1049         key: (ty::ParamEnv<'tcx>, ty::PolyTraitRef<'tcx>)
1050     ) -> Result<ImplSource<'tcx, ()>, ErrorReported> {
1051         cache_on_disk_if { true }
1052         desc { |tcx|
1053             "checking if `{}` fulfills its obligations",
1054             tcx.def_path_str(key.1.def_id())
1055         }
1056     }
1057
1058     /// Return all `impl` blocks in the current crate.
1059     ///
1060     /// To allow caching this between crates, you must pass in [`LOCAL_CRATE`] as the crate number.
1061     /// Passing in any other crate will cause an ICE.
1062     ///
1063     /// [`LOCAL_CRATE`]: rustc_hir::def_id::LOCAL_CRATE
1064     query all_local_trait_impls(_: ()) -> &'tcx BTreeMap<DefId, Vec<LocalDefId>> {
1065         desc { "local trait impls" }
1066     }
1067
1068     /// Given a trait `trait_id`, return all known `impl` blocks.
1069     query trait_impls_of(trait_id: DefId) -> ty::trait_def::TraitImpls {
1070         storage(ArenaCacheSelector<'tcx>)
1071         desc { |tcx| "trait impls of `{}`", tcx.def_path_str(trait_id) }
1072     }
1073
1074     query specialization_graph_of(trait_id: DefId) -> specialization_graph::Graph {
1075         storage(ArenaCacheSelector<'tcx>)
1076         desc { |tcx| "building specialization graph of trait `{}`", tcx.def_path_str(trait_id) }
1077         cache_on_disk_if { true }
1078     }
1079     query object_safety_violations(trait_id: DefId) -> &'tcx [traits::ObjectSafetyViolation] {
1080         desc { |tcx| "determine object safety of trait `{}`", tcx.def_path_str(trait_id) }
1081     }
1082
1083     /// Gets the ParameterEnvironment for a given item; this environment
1084     /// will be in "user-facing" mode, meaning that it is suitable for
1085     /// type-checking etc, and it does not normalize specializable
1086     /// associated types. This is almost always what you want,
1087     /// unless you are doing MIR optimizations, in which case you
1088     /// might want to use `reveal_all()` method to change modes.
1089     query param_env(def_id: DefId) -> ty::ParamEnv<'tcx> {
1090         desc { |tcx| "computing normalized predicates of `{}`", tcx.def_path_str(def_id) }
1091     }
1092
1093     /// Like `param_env`, but returns the `ParamEnv` in `Reveal::All` mode.
1094     /// Prefer this over `tcx.param_env(def_id).with_reveal_all_normalized(tcx)`,
1095     /// as this method is more efficient.
1096     query param_env_reveal_all_normalized(def_id: DefId) -> ty::ParamEnv<'tcx> {
1097         desc { |tcx| "computing revealed normalized predicates of `{}`", tcx.def_path_str(def_id) }
1098     }
1099
1100     /// Trait selection queries. These are best used by invoking `ty.is_copy_modulo_regions()`,
1101     /// `ty.is_copy()`, etc, since that will prune the environment where possible.
1102     query is_copy_raw(env: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1103         desc { "computing whether `{}` is `Copy`", env.value }
1104     }
1105     /// Query backing `TyS::is_sized`.
1106     query is_sized_raw(env: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1107         desc { "computing whether `{}` is `Sized`", env.value }
1108     }
1109     /// Query backing `TyS::is_freeze`.
1110     query is_freeze_raw(env: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1111         desc { "computing whether `{}` is freeze", env.value }
1112     }
1113     /// Query backing `TyS::is_unpin`.
1114     query is_unpin_raw(env: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1115         desc { "computing whether `{}` is `Unpin`", env.value }
1116     }
1117     /// Query backing `TyS::needs_drop`.
1118     query needs_drop_raw(env: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1119         desc { "computing whether `{}` needs drop", env.value }
1120     }
1121     /// Query backing `TyS::has_significant_drop_raw`.
1122     query has_significant_drop_raw(env: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1123         desc { "computing whether `{}` has a significant drop", env.value }
1124     }
1125
1126     /// Query backing `TyS::is_structural_eq_shallow`.
1127     ///
1128     /// This is only correct for ADTs. Call `is_structural_eq_shallow` to handle all types
1129     /// correctly.
1130     query has_structural_eq_impls(ty: Ty<'tcx>) -> bool {
1131         desc {
1132             "computing whether `{:?}` implements `PartialStructuralEq` and `StructuralEq`",
1133             ty
1134         }
1135     }
1136
1137     /// A list of types where the ADT requires drop if and only if any of
1138     /// those types require drop. If the ADT is known to always need drop
1139     /// then `Err(AlwaysRequiresDrop)` is returned.
1140     query adt_drop_tys(def_id: DefId) -> Result<&'tcx ty::List<Ty<'tcx>>, AlwaysRequiresDrop> {
1141         desc { |tcx| "computing when `{}` needs drop", tcx.def_path_str(def_id) }
1142         cache_on_disk_if { true }
1143     }
1144
1145     /// A list of types where the ADT requires drop if and only if any of those types
1146     /// has significant drop. A type marked with the attribute `rustc_insignificant_dtor`
1147     /// is considered to not be significant. A drop is significant if it is implemented
1148     /// by the user or does anything that will have any observable behavior (other than
1149     /// freeing up memory). If the ADT is known to have a significant destructor then
1150     /// `Err(AlwaysRequiresDrop)` is returned.
1151     query adt_significant_drop_tys(def_id: DefId) -> Result<&'tcx ty::List<Ty<'tcx>>, AlwaysRequiresDrop> {
1152         desc { |tcx| "computing when `{}` has a significant destructor", tcx.def_path_str(def_id) }
1153         cache_on_disk_if { false }
1154     }
1155
1156     /// Computes the layout of a type. Note that this implicitly
1157     /// executes in "reveal all" mode, and will normalize the input type.
1158     query layout_of(
1159         key: ty::ParamEnvAnd<'tcx, Ty<'tcx>>
1160     ) -> Result<ty::layout::TyAndLayout<'tcx>, ty::layout::LayoutError<'tcx>> {
1161         desc { "computing layout of `{}`", key.value }
1162     }
1163
1164     /// Compute a `FnAbi` suitable for indirect calls, i.e. to `fn` pointers.
1165     ///
1166     /// NB: this doesn't handle virtual calls - those should use `fn_abi_of_instance`
1167     /// instead, where the instance is an `InstanceDef::Virtual`.
1168     query fn_abi_of_fn_ptr(
1169         key: ty::ParamEnvAnd<'tcx, (ty::PolyFnSig<'tcx>, &'tcx ty::List<Ty<'tcx>>)>
1170     ) -> Result<&'tcx abi::call::FnAbi<'tcx, Ty<'tcx>>, ty::layout::FnAbiError<'tcx>> {
1171         desc { "computing call ABI of `{}` function pointers", key.value.0 }
1172     }
1173
1174     /// Compute a `FnAbi` suitable for declaring/defining an `fn` instance, and for
1175     /// direct calls to an `fn`.
1176     ///
1177     /// NB: that includes virtual calls, which are represented by "direct calls"
1178     /// to an `InstanceDef::Virtual` instance (of `<dyn Trait as Trait>::fn`).
1179     query fn_abi_of_instance(
1180         key: ty::ParamEnvAnd<'tcx, (ty::Instance<'tcx>, &'tcx ty::List<Ty<'tcx>>)>
1181     ) -> Result<&'tcx abi::call::FnAbi<'tcx, Ty<'tcx>>, ty::layout::FnAbiError<'tcx>> {
1182         desc { "computing call ABI of `{}`", key.value.0 }
1183     }
1184
1185     query dylib_dependency_formats(_: CrateNum)
1186                                     -> &'tcx [(CrateNum, LinkagePreference)] {
1187         desc { "dylib dependency formats of crate" }
1188         separate_provide_extern
1189     }
1190
1191     query dependency_formats(_: ()) -> Lrc<crate::middle::dependency_format::Dependencies> {
1192         desc { "get the linkage format of all dependencies" }
1193     }
1194
1195     query is_compiler_builtins(_: CrateNum) -> bool {
1196         fatal_cycle
1197         desc { "checking if the crate is_compiler_builtins" }
1198         separate_provide_extern
1199     }
1200     query has_global_allocator(_: CrateNum) -> bool {
1201         // This query depends on untracked global state in CStore
1202         eval_always
1203         fatal_cycle
1204         desc { "checking if the crate has_global_allocator" }
1205         separate_provide_extern
1206     }
1207     query has_panic_handler(_: CrateNum) -> bool {
1208         fatal_cycle
1209         desc { "checking if the crate has_panic_handler" }
1210         separate_provide_extern
1211     }
1212     query is_profiler_runtime(_: CrateNum) -> bool {
1213         fatal_cycle
1214         desc { "query a crate is `#![profiler_runtime]`" }
1215         separate_provide_extern
1216     }
1217     query panic_strategy(_: CrateNum) -> PanicStrategy {
1218         fatal_cycle
1219         desc { "query a crate's configured panic strategy" }
1220         separate_provide_extern
1221     }
1222     query panic_in_drop_strategy(_: CrateNum) -> PanicStrategy {
1223         fatal_cycle
1224         desc { "query a crate's configured panic-in-drop strategy" }
1225         separate_provide_extern
1226     }
1227     query is_no_builtins(_: CrateNum) -> bool {
1228         fatal_cycle
1229         desc { "test whether a crate has `#![no_builtins]`" }
1230         separate_provide_extern
1231     }
1232     query symbol_mangling_version(_: CrateNum) -> SymbolManglingVersion {
1233         fatal_cycle
1234         desc { "query a crate's symbol mangling version" }
1235         separate_provide_extern
1236     }
1237
1238     query extern_crate(def_id: DefId) -> Option<&'tcx ExternCrate> {
1239         eval_always
1240         desc { "getting crate's ExternCrateData" }
1241         separate_provide_extern
1242     }
1243
1244     query specializes(_: (DefId, DefId)) -> bool {
1245         desc { "computing whether impls specialize one another" }
1246     }
1247     query in_scope_traits_map(_: LocalDefId)
1248         -> Option<&'tcx FxHashMap<ItemLocalId, Box<[TraitCandidate]>>> {
1249         desc { "traits in scope at a block" }
1250     }
1251
1252     query module_exports(def_id: LocalDefId) -> Option<&'tcx [Export]> {
1253         desc { |tcx| "looking up items exported by `{}`", tcx.def_path_str(def_id.to_def_id()) }
1254     }
1255
1256     query impl_defaultness(def_id: DefId) -> hir::Defaultness {
1257         desc { |tcx| "looking up whether `{}` is a default impl", tcx.def_path_str(def_id) }
1258         separate_provide_extern
1259     }
1260
1261     query impl_constness(def_id: DefId) -> hir::Constness {
1262         desc { |tcx| "looking up whether `{}` is a const impl", tcx.def_path_str(def_id) }
1263         separate_provide_extern
1264     }
1265
1266     query check_item_well_formed(key: LocalDefId) -> () {
1267         desc { |tcx| "checking that `{}` is well-formed", tcx.def_path_str(key.to_def_id()) }
1268     }
1269     query check_trait_item_well_formed(key: LocalDefId) -> () {
1270         desc { |tcx| "checking that `{}` is well-formed", tcx.def_path_str(key.to_def_id()) }
1271     }
1272     query check_impl_item_well_formed(key: LocalDefId) -> () {
1273         desc { |tcx| "checking that `{}` is well-formed", tcx.def_path_str(key.to_def_id()) }
1274     }
1275
1276     // The `DefId`s of all non-generic functions and statics in the given crate
1277     // that can be reached from outside the crate.
1278     //
1279     // We expect this items to be available for being linked to.
1280     //
1281     // This query can also be called for `LOCAL_CRATE`. In this case it will
1282     // compute which items will be reachable to other crates, taking into account
1283     // the kind of crate that is currently compiled. Crates with only a
1284     // C interface have fewer reachable things.
1285     //
1286     // Does not include external symbols that don't have a corresponding DefId,
1287     // like the compiler-generated `main` function and so on.
1288     query reachable_non_generics(_: CrateNum)
1289         -> DefIdMap<SymbolExportLevel> {
1290         storage(ArenaCacheSelector<'tcx>)
1291         desc { "looking up the exported symbols of a crate" }
1292         separate_provide_extern
1293     }
1294     query is_reachable_non_generic(def_id: DefId) -> bool {
1295         desc { |tcx| "checking whether `{}` is an exported symbol", tcx.def_path_str(def_id) }
1296         separate_provide_extern
1297     }
1298     query is_unreachable_local_definition(def_id: LocalDefId) -> bool {
1299         desc { |tcx|
1300             "checking whether `{}` is reachable from outside the crate",
1301             tcx.def_path_str(def_id.to_def_id()),
1302         }
1303     }
1304
1305     /// The entire set of monomorphizations the local crate can safely link
1306     /// to because they are exported from upstream crates. Do not depend on
1307     /// this directly, as its value changes anytime a monomorphization gets
1308     /// added or removed in any upstream crate. Instead use the narrower
1309     /// `upstream_monomorphizations_for`, `upstream_drop_glue_for`, or, even
1310     /// better, `Instance::upstream_monomorphization()`.
1311     query upstream_monomorphizations(_: ()) -> DefIdMap<FxHashMap<SubstsRef<'tcx>, CrateNum>> {
1312         storage(ArenaCacheSelector<'tcx>)
1313         desc { "collecting available upstream monomorphizations" }
1314     }
1315
1316     /// Returns the set of upstream monomorphizations available for the
1317     /// generic function identified by the given `def_id`. The query makes
1318     /// sure to make a stable selection if the same monomorphization is
1319     /// available in multiple upstream crates.
1320     ///
1321     /// You likely want to call `Instance::upstream_monomorphization()`
1322     /// instead of invoking this query directly.
1323     query upstream_monomorphizations_for(def_id: DefId)
1324         -> Option<&'tcx FxHashMap<SubstsRef<'tcx>, CrateNum>> {
1325             desc { |tcx|
1326                 "collecting available upstream monomorphizations for `{}`",
1327                 tcx.def_path_str(def_id),
1328             }
1329             separate_provide_extern
1330         }
1331
1332     /// Returns the upstream crate that exports drop-glue for the given
1333     /// type (`substs` is expected to be a single-item list containing the
1334     /// type one wants drop-glue for).
1335     ///
1336     /// This is a subset of `upstream_monomorphizations_for` in order to
1337     /// increase dep-tracking granularity. Otherwise adding or removing any
1338     /// type with drop-glue in any upstream crate would invalidate all
1339     /// functions calling drop-glue of an upstream type.
1340     ///
1341     /// You likely want to call `Instance::upstream_monomorphization()`
1342     /// instead of invoking this query directly.
1343     ///
1344     /// NOTE: This query could easily be extended to also support other
1345     ///       common functions that have are large set of monomorphizations
1346     ///       (like `Clone::clone` for example).
1347     query upstream_drop_glue_for(substs: SubstsRef<'tcx>) -> Option<CrateNum> {
1348         desc { "available upstream drop-glue for `{:?}`", substs }
1349     }
1350
1351     query foreign_modules(_: CrateNum) -> Lrc<FxHashMap<DefId, ForeignModule>> {
1352         desc { "looking up the foreign modules of a linked crate" }
1353         separate_provide_extern
1354     }
1355
1356     /// Identifies the entry-point (e.g., the `main` function) for a given
1357     /// crate, returning `None` if there is no entry point (such as for library crates).
1358     query entry_fn(_: ()) -> Option<(DefId, EntryFnType)> {
1359         desc { "looking up the entry function of a crate" }
1360     }
1361     query proc_macro_decls_static(_: ()) -> Option<LocalDefId> {
1362         desc { "looking up the derive registrar for a crate" }
1363     }
1364     // The macro which defines `rustc_metadata::provide_extern` depends on this query's name.
1365     // Changing the name should cause a compiler error, but in case that changes, be aware.
1366     query crate_hash(_: CrateNum) -> Svh {
1367         eval_always
1368         desc { "looking up the hash a crate" }
1369         separate_provide_extern
1370     }
1371     query crate_host_hash(_: CrateNum) -> Option<Svh> {
1372         eval_always
1373         desc { "looking up the hash of a host version of a crate" }
1374         separate_provide_extern
1375     }
1376     query extra_filename(_: CrateNum) -> String {
1377         eval_always
1378         desc { "looking up the extra filename for a crate" }
1379         separate_provide_extern
1380     }
1381     query crate_extern_paths(_: CrateNum) -> Vec<PathBuf> {
1382         eval_always
1383         desc { "looking up the paths for extern crates" }
1384         separate_provide_extern
1385     }
1386
1387     /// Given a crate and a trait, look up all impls of that trait in the crate.
1388     /// Return `(impl_id, self_ty)`.
1389     query implementations_of_trait(_: (CrateNum, DefId))
1390         -> &'tcx [(DefId, Option<ty::fast_reject::SimplifiedType>)] {
1391         desc { "looking up implementations of a trait in a crate" }
1392         separate_provide_extern
1393     }
1394
1395     /// Given a crate, look up all trait impls in that crate.
1396     /// Return `(impl_id, self_ty)`.
1397     query all_trait_implementations(_: CrateNum)
1398         -> &'tcx [(DefId, Option<ty::fast_reject::SimplifiedType>)] {
1399         desc { "looking up all (?) trait implementations" }
1400         separate_provide_extern
1401     }
1402
1403     query is_dllimport_foreign_item(def_id: DefId) -> bool {
1404         desc { |tcx| "is_dllimport_foreign_item({})", tcx.def_path_str(def_id) }
1405     }
1406     query is_statically_included_foreign_item(def_id: DefId) -> bool {
1407         desc { |tcx| "is_statically_included_foreign_item({})", tcx.def_path_str(def_id) }
1408     }
1409     query native_library_kind(def_id: DefId)
1410         -> Option<NativeLibKind> {
1411         desc { |tcx| "native_library_kind({})", tcx.def_path_str(def_id) }
1412     }
1413
1414     /// Does lifetime resolution, but does not descend into trait items. This
1415     /// should only be used for resolving lifetimes of on trait definitions,
1416     /// and is used to avoid cycles. Importantly, `resolve_lifetimes` still visits
1417     /// the same lifetimes and is responsible for diagnostics.
1418     /// See `rustc_resolve::late::lifetimes for details.
1419     query resolve_lifetimes_trait_definition(_: LocalDefId) -> ResolveLifetimes {
1420         storage(ArenaCacheSelector<'tcx>)
1421         desc { "resolving lifetimes for a trait definition" }
1422     }
1423     /// Does lifetime resolution on items. Importantly, we can't resolve
1424     /// lifetimes directly on things like trait methods, because of trait params.
1425     /// See `rustc_resolve::late::lifetimes for details.
1426     query resolve_lifetimes(_: LocalDefId) -> ResolveLifetimes {
1427         storage(ArenaCacheSelector<'tcx>)
1428         desc { "resolving lifetimes" }
1429     }
1430     query named_region_map(_: LocalDefId) ->
1431         Option<&'tcx FxHashMap<ItemLocalId, Region>> {
1432         desc { "looking up a named region" }
1433     }
1434     query is_late_bound_map(_: LocalDefId) ->
1435         Option<(LocalDefId, &'tcx FxHashSet<ItemLocalId>)> {
1436         desc { "testing if a region is late bound" }
1437     }
1438     /// For a given item (like a struct), gets the default lifetimes to be used
1439     /// for each parameter if a trait object were to be passed for that parameter.
1440     /// For example, for `struct Foo<'a, T, U>`, this would be `['static, 'static]`.
1441     /// For `struct Foo<'a, T: 'a, U>`, this would instead be `['a, 'static]`.
1442     query object_lifetime_defaults_map(_: LocalDefId)
1443         -> Option<Vec<ObjectLifetimeDefault>> {
1444         desc { "looking up lifetime defaults for a region on an item" }
1445     }
1446     query late_bound_vars_map(_: LocalDefId)
1447         -> Option<&'tcx FxHashMap<ItemLocalId, Vec<ty::BoundVariableKind>>> {
1448         desc { "looking up late bound vars" }
1449     }
1450
1451     query lifetime_scope_map(_: LocalDefId) -> Option<FxHashMap<ItemLocalId, LifetimeScopeForPath>> {
1452         desc { "finds the lifetime scope for an HirId of a PathSegment" }
1453     }
1454
1455     query visibility(def_id: DefId) -> ty::Visibility {
1456         desc { |tcx| "computing visibility of `{}`", tcx.def_path_str(def_id) }
1457         separate_provide_extern
1458     }
1459
1460     /// Computes the set of modules from which this type is visibly uninhabited.
1461     /// To check whether a type is uninhabited at all (not just from a given module), you could
1462     /// check whether the forest is empty.
1463     query type_uninhabited_from(
1464         key: ty::ParamEnvAnd<'tcx, Ty<'tcx>>
1465     ) -> ty::inhabitedness::DefIdForest {
1466         desc { "computing the inhabitedness of `{:?}`", key }
1467     }
1468
1469     query dep_kind(_: CrateNum) -> CrateDepKind {
1470         eval_always
1471         desc { "fetching what a dependency looks like" }
1472         separate_provide_extern
1473     }
1474
1475     /// Gets the name of the crate.
1476     query crate_name(_: CrateNum) -> Symbol {
1477         eval_always
1478         desc { "fetching what a crate is named" }
1479         separate_provide_extern
1480     }
1481     query item_children(def_id: DefId) -> &'tcx [Export] {
1482         desc { |tcx| "collecting child items of `{}`", tcx.def_path_str(def_id) }
1483         separate_provide_extern
1484     }
1485     query extern_mod_stmt_cnum(def_id: LocalDefId) -> Option<CrateNum> {
1486         desc { |tcx| "computing crate imported by `{}`", tcx.def_path_str(def_id.to_def_id()) }
1487     }
1488
1489     query get_lib_features(_: ()) -> LibFeatures {
1490         storage(ArenaCacheSelector<'tcx>)
1491         eval_always
1492         desc { "calculating the lib features map" }
1493     }
1494     query defined_lib_features(_: CrateNum)
1495         -> &'tcx [(Symbol, Option<Symbol>)] {
1496         desc { "calculating the lib features defined in a crate" }
1497         separate_provide_extern
1498     }
1499     /// Returns the lang items defined in another crate by loading it from metadata.
1500     query get_lang_items(_: ()) -> LanguageItems {
1501         storage(ArenaCacheSelector<'tcx>)
1502         eval_always
1503         desc { "calculating the lang items map" }
1504     }
1505
1506     /// Returns all diagnostic items defined in all crates.
1507     query all_diagnostic_items(_: ()) -> rustc_hir::diagnostic_items::DiagnosticItems {
1508         storage(ArenaCacheSelector<'tcx>)
1509         eval_always
1510         desc { "calculating the diagnostic items map" }
1511     }
1512
1513     /// Returns the lang items defined in another crate by loading it from metadata.
1514     query defined_lang_items(_: CrateNum) -> &'tcx [(DefId, usize)] {
1515         desc { "calculating the lang items defined in a crate" }
1516         separate_provide_extern
1517     }
1518
1519     /// Returns the diagnostic items defined in a crate.
1520     query diagnostic_items(_: CrateNum) -> rustc_hir::diagnostic_items::DiagnosticItems {
1521         storage(ArenaCacheSelector<'tcx>)
1522         desc { "calculating the diagnostic items map in a crate" }
1523         separate_provide_extern
1524     }
1525
1526     query missing_lang_items(_: CrateNum) -> &'tcx [LangItem] {
1527         desc { "calculating the missing lang items in a crate" }
1528         separate_provide_extern
1529     }
1530     query visible_parent_map(_: ()) -> DefIdMap<DefId> {
1531         storage(ArenaCacheSelector<'tcx>)
1532         desc { "calculating the visible parent map" }
1533     }
1534     query trimmed_def_paths(_: ()) -> FxHashMap<DefId, Symbol> {
1535         storage(ArenaCacheSelector<'tcx>)
1536         desc { "calculating trimmed def paths" }
1537     }
1538     query missing_extern_crate_item(_: CrateNum) -> bool {
1539         eval_always
1540         desc { "seeing if we're missing an `extern crate` item for this crate" }
1541         separate_provide_extern
1542     }
1543     query used_crate_source(_: CrateNum) -> Lrc<CrateSource> {
1544         eval_always
1545         desc { "looking at the source for a crate" }
1546         separate_provide_extern
1547     }
1548     query postorder_cnums(_: ()) -> &'tcx [CrateNum] {
1549         eval_always
1550         desc { "generating a postorder list of CrateNums" }
1551     }
1552     /// Returns whether or not the crate with CrateNum 'cnum'
1553     /// is marked as a private dependency
1554     query is_private_dep(c: CrateNum) -> bool {
1555         eval_always
1556         desc { "check whether crate {} is a private dependency", c }
1557         separate_provide_extern
1558     }
1559     query allocator_kind(_: ()) -> Option<AllocatorKind> {
1560         eval_always
1561         desc { "allocator kind for the current crate" }
1562     }
1563
1564     query upvars_mentioned(def_id: DefId) -> Option<&'tcx FxIndexMap<hir::HirId, hir::Upvar>> {
1565         desc { |tcx| "collecting upvars mentioned in `{}`", tcx.def_path_str(def_id) }
1566         eval_always
1567     }
1568     query maybe_unused_trait_import(def_id: LocalDefId) -> bool {
1569         desc { |tcx| "maybe_unused_trait_import for `{}`", tcx.def_path_str(def_id.to_def_id()) }
1570     }
1571     query maybe_unused_extern_crates(_: ()) -> &'tcx [(LocalDefId, Span)] {
1572         desc { "looking up all possibly unused extern crates" }
1573     }
1574     query names_imported_by_glob_use(def_id: LocalDefId) -> &'tcx FxHashSet<Symbol> {
1575         desc { |tcx| "names_imported_by_glob_use for `{}`", tcx.def_path_str(def_id.to_def_id()) }
1576     }
1577
1578     query stability_index(_: ()) -> stability::Index<'tcx> {
1579         storage(ArenaCacheSelector<'tcx>)
1580         eval_always
1581         desc { "calculating the stability index for the local crate" }
1582     }
1583     query crates(_: ()) -> &'tcx [CrateNum] {
1584         eval_always
1585         desc { "fetching all foreign CrateNum instances" }
1586     }
1587
1588     /// A vector of every trait accessible in the whole crate
1589     /// (i.e., including those from subcrates). This is used only for
1590     /// error reporting.
1591     query all_traits(_: ()) -> &'tcx [DefId] {
1592         desc { "fetching all foreign and local traits" }
1593     }
1594
1595     /// The list of symbols exported from the given crate.
1596     ///
1597     /// - All names contained in `exported_symbols(cnum)` are guaranteed to
1598     ///   correspond to a publicly visible symbol in `cnum` machine code.
1599     /// - The `exported_symbols` sets of different crates do not intersect.
1600     query exported_symbols(_: CrateNum)
1601         -> &'tcx [(ExportedSymbol<'tcx>, SymbolExportLevel)] {
1602         desc { "exported_symbols" }
1603         separate_provide_extern
1604     }
1605
1606     query collect_and_partition_mono_items(_: ()) -> (&'tcx DefIdSet, &'tcx [CodegenUnit<'tcx>]) {
1607         eval_always
1608         desc { "collect_and_partition_mono_items" }
1609     }
1610     query is_codegened_item(def_id: DefId) -> bool {
1611         desc { |tcx| "determining whether `{}` needs codegen", tcx.def_path_str(def_id) }
1612     }
1613
1614     /// All items participating in code generation together with items inlined into them.
1615     query codegened_and_inlined_items(_: ()) -> &'tcx DefIdSet {
1616         eval_always
1617        desc { "codegened_and_inlined_items" }
1618     }
1619
1620     query codegen_unit(_: Symbol) -> &'tcx CodegenUnit<'tcx> {
1621         desc { "codegen_unit" }
1622     }
1623     query unused_generic_params(key: ty::InstanceDef<'tcx>) -> FiniteBitSet<u32> {
1624         cache_on_disk_if { key.def_id().is_local() }
1625         desc {
1626             |tcx| "determining which generic parameters are unused by `{}`",
1627                 tcx.def_path_str(key.def_id())
1628         }
1629         separate_provide_extern
1630     }
1631     query backend_optimization_level(_: ()) -> OptLevel {
1632         desc { "optimization level used by backend" }
1633     }
1634
1635     query output_filenames(_: ()) -> Arc<OutputFilenames> {
1636         eval_always
1637         desc { "output_filenames" }
1638     }
1639
1640     /// Do not call this query directly: invoke `normalize` instead.
1641     query normalize_projection_ty(
1642         goal: CanonicalProjectionGoal<'tcx>
1643     ) -> Result<
1644         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, NormalizationResult<'tcx>>>,
1645         NoSolution,
1646     > {
1647         desc { "normalizing `{:?}`", goal }
1648     }
1649
1650     /// Do not call this query directly: invoke `normalize_erasing_regions` instead.
1651     query normalize_generic_arg_after_erasing_regions(
1652         goal: ParamEnvAnd<'tcx, GenericArg<'tcx>>
1653     ) -> GenericArg<'tcx> {
1654         desc { "normalizing `{}`", goal.value }
1655     }
1656
1657     /// Do not call this query directly: invoke `normalize_erasing_regions` instead.
1658     query normalize_mir_const_after_erasing_regions(
1659         goal: ParamEnvAnd<'tcx, mir::ConstantKind<'tcx>>
1660     ) -> mir::ConstantKind<'tcx> {
1661         desc { "normalizing `{}`", goal.value }
1662     }
1663
1664     query implied_outlives_bounds(
1665         goal: CanonicalTyGoal<'tcx>
1666     ) -> Result<
1667         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, Vec<OutlivesBound<'tcx>>>>,
1668         NoSolution,
1669     > {
1670         desc { "computing implied outlives bounds for `{:?}`", goal }
1671     }
1672
1673     /// Do not call this query directly: invoke `infcx.at().dropck_outlives()` instead.
1674     query dropck_outlives(
1675         goal: CanonicalTyGoal<'tcx>
1676     ) -> Result<
1677         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, DropckOutlivesResult<'tcx>>>,
1678         NoSolution,
1679     > {
1680         desc { "computing dropck types for `{:?}`", goal }
1681     }
1682
1683     /// Do not call this query directly: invoke `infcx.predicate_may_hold()` or
1684     /// `infcx.predicate_must_hold()` instead.
1685     query evaluate_obligation(
1686         goal: CanonicalPredicateGoal<'tcx>
1687     ) -> Result<traits::EvaluationResult, traits::OverflowError> {
1688         desc { "evaluating trait selection obligation `{}`", goal.value.value }
1689     }
1690
1691     query evaluate_goal(
1692         goal: traits::CanonicalChalkEnvironmentAndGoal<'tcx>
1693     ) -> Result<
1694         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ()>>,
1695         NoSolution
1696     > {
1697         desc { "evaluating trait selection obligation `{}`", goal.value }
1698     }
1699
1700     /// Do not call this query directly: part of the `Eq` type-op
1701     query type_op_ascribe_user_type(
1702         goal: CanonicalTypeOpAscribeUserTypeGoal<'tcx>
1703     ) -> Result<
1704         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ()>>,
1705         NoSolution,
1706     > {
1707         desc { "evaluating `type_op_ascribe_user_type` `{:?}`", goal }
1708     }
1709
1710     /// Do not call this query directly: part of the `Eq` type-op
1711     query type_op_eq(
1712         goal: CanonicalTypeOpEqGoal<'tcx>
1713     ) -> Result<
1714         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ()>>,
1715         NoSolution,
1716     > {
1717         desc { "evaluating `type_op_eq` `{:?}`", goal }
1718     }
1719
1720     /// Do not call this query directly: part of the `Subtype` type-op
1721     query type_op_subtype(
1722         goal: CanonicalTypeOpSubtypeGoal<'tcx>
1723     ) -> Result<
1724         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ()>>,
1725         NoSolution,
1726     > {
1727         desc { "evaluating `type_op_subtype` `{:?}`", goal }
1728     }
1729
1730     /// Do not call this query directly: part of the `ProvePredicate` type-op
1731     query type_op_prove_predicate(
1732         goal: CanonicalTypeOpProvePredicateGoal<'tcx>
1733     ) -> Result<
1734         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ()>>,
1735         NoSolution,
1736     > {
1737         desc { "evaluating `type_op_prove_predicate` `{:?}`", goal }
1738     }
1739
1740     /// Do not call this query directly: part of the `Normalize` type-op
1741     query type_op_normalize_ty(
1742         goal: CanonicalTypeOpNormalizeGoal<'tcx, Ty<'tcx>>
1743     ) -> Result<
1744         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, Ty<'tcx>>>,
1745         NoSolution,
1746     > {
1747         desc { "normalizing `{:?}`", goal }
1748     }
1749
1750     /// Do not call this query directly: part of the `Normalize` type-op
1751     query type_op_normalize_predicate(
1752         goal: CanonicalTypeOpNormalizeGoal<'tcx, ty::Predicate<'tcx>>
1753     ) -> Result<
1754         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ty::Predicate<'tcx>>>,
1755         NoSolution,
1756     > {
1757         desc { "normalizing `{:?}`", goal }
1758     }
1759
1760     /// Do not call this query directly: part of the `Normalize` type-op
1761     query type_op_normalize_poly_fn_sig(
1762         goal: CanonicalTypeOpNormalizeGoal<'tcx, ty::PolyFnSig<'tcx>>
1763     ) -> Result<
1764         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ty::PolyFnSig<'tcx>>>,
1765         NoSolution,
1766     > {
1767         desc { "normalizing `{:?}`", goal }
1768     }
1769
1770     /// Do not call this query directly: part of the `Normalize` type-op
1771     query type_op_normalize_fn_sig(
1772         goal: CanonicalTypeOpNormalizeGoal<'tcx, ty::FnSig<'tcx>>
1773     ) -> Result<
1774         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ty::FnSig<'tcx>>>,
1775         NoSolution,
1776     > {
1777         desc { "normalizing `{:?}`", goal }
1778     }
1779
1780     query subst_and_check_impossible_predicates(key: (DefId, SubstsRef<'tcx>)) -> bool {
1781         desc { |tcx|
1782             "impossible substituted predicates:`{}`",
1783             tcx.def_path_str(key.0)
1784         }
1785     }
1786
1787     query method_autoderef_steps(
1788         goal: CanonicalTyGoal<'tcx>
1789     ) -> MethodAutoderefStepsResult<'tcx> {
1790         desc { "computing autoderef types for `{:?}`", goal }
1791     }
1792
1793     query supported_target_features(_: CrateNum) -> FxHashMap<String, Option<Symbol>> {
1794         storage(ArenaCacheSelector<'tcx>)
1795         eval_always
1796         desc { "looking up supported target features" }
1797     }
1798
1799     /// Get an estimate of the size of an InstanceDef based on its MIR for CGU partitioning.
1800     query instance_def_size_estimate(def: ty::InstanceDef<'tcx>)
1801         -> usize {
1802         desc { |tcx| "estimating size for `{}`", tcx.def_path_str(def.def_id()) }
1803     }
1804
1805     query features_query(_: ()) -> &'tcx rustc_feature::Features {
1806         eval_always
1807         desc { "looking up enabled feature gates" }
1808     }
1809
1810     /// Attempt to resolve the given `DefId` to an `Instance`, for the
1811     /// given generics args (`SubstsRef`), returning one of:
1812     ///  * `Ok(Some(instance))` on success
1813     ///  * `Ok(None)` when the `SubstsRef` are still too generic,
1814     ///    and therefore don't allow finding the final `Instance`
1815     ///  * `Err(ErrorReported)` when the `Instance` resolution process
1816     ///    couldn't complete due to errors elsewhere - this is distinct
1817     ///    from `Ok(None)` to avoid misleading diagnostics when an error
1818     ///    has already been/will be emitted, for the original cause
1819     query resolve_instance(
1820         key: ty::ParamEnvAnd<'tcx, (DefId, SubstsRef<'tcx>)>
1821     ) -> Result<Option<ty::Instance<'tcx>>, ErrorReported> {
1822         desc { "resolving instance `{}`", ty::Instance::new(key.value.0, key.value.1) }
1823     }
1824
1825     query resolve_instance_of_const_arg(
1826         key: ty::ParamEnvAnd<'tcx, (LocalDefId, DefId, SubstsRef<'tcx>)>
1827     ) -> Result<Option<ty::Instance<'tcx>>, ErrorReported> {
1828         desc {
1829             "resolving instance of the const argument `{}`",
1830             ty::Instance::new(key.value.0.to_def_id(), key.value.2),
1831         }
1832     }
1833
1834     query normalize_opaque_types(key: &'tcx ty::List<ty::Predicate<'tcx>>) -> &'tcx ty::List<ty::Predicate<'tcx>> {
1835         desc { "normalizing opaque types in {:?}", key }
1836     }
1837
1838     /// Checks whether a type is definitely uninhabited. This is
1839     /// conservative: for some types that are uninhabited we return `false`,
1840     /// but we only return `true` for types that are definitely uninhabited.
1841     /// `ty.conservative_is_privately_uninhabited` implies that any value of type `ty`
1842     /// will be `Abi::Uninhabited`. (Note that uninhabited types may have nonzero
1843     /// size, to account for partial initialisation. See #49298 for details.)
1844     query conservative_is_privately_uninhabited(key: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1845         desc { "conservatively checking if {:?} is privately uninhabited", key }
1846     }
1847
1848     query limits(key: ()) -> Limits {
1849         desc { "looking up limits" }
1850     }
1851
1852     /// Performs an HIR-based well-formed check on the item with the given `HirId`. If
1853     /// we get an `Unimplemented` error that matches the provided `Predicate`, return
1854     /// the cause of the newly created obligation.
1855     ///
1856     /// This is only used by error-reporting code to get a better cause (in particular, a better
1857     /// span) for an *existing* error. Therefore, it is best-effort, and may never handle
1858     /// all of the cases that the normal `ty::Ty`-based wfcheck does. This is fine,
1859     /// because the `ty::Ty`-based wfcheck is always run.
1860     query diagnostic_hir_wf_check(key: (ty::Predicate<'tcx>, traits::WellFormedLoc)) -> Option<traits::ObligationCause<'tcx>> {
1861         eval_always
1862         no_hash
1863         desc { "performing HIR wf-checking for predicate {:?} at item {:?}", key.0, key.1 }
1864     }
1865 }