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