]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_middle/src/query/mod.rs
Auto merge of #92169 - In-line:no-cache-selector-lrc, r=Mark-Simulacrum
[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         cache_on_disk_if { key.is_local() }
526         separate_provide_extern
527     }
528     query adt_destructor(key: DefId) -> Option<ty::Destructor> {
529         desc { |tcx| "computing `Drop` impl for `{}`", tcx.def_path_str(key) }
530         separate_provide_extern
531     }
532
533     // The cycle error here should be reported as an error by `check_representable`.
534     // We consider the type as Sized in the meanwhile to avoid
535     // further errors (done in impl Value for AdtSizedConstraint).
536     // Use `cycle_delay_bug` to delay the cycle error here to be emitted later
537     // in case we accidentally otherwise don't emit an error.
538     query adt_sized_constraint(
539         key: DefId
540     ) -> AdtSizedConstraint<'tcx> {
541         desc { |tcx| "computing `Sized` constraints for `{}`", tcx.def_path_str(key) }
542         cycle_delay_bug
543     }
544
545     query adt_dtorck_constraint(
546         key: DefId
547     ) -> Result<DtorckConstraint<'tcx>, NoSolution> {
548         desc { |tcx| "computing drop-check constraints for `{}`", tcx.def_path_str(key) }
549     }
550
551     /// Returns `true` if this is a const fn, use the `is_const_fn` to know whether your crate
552     /// actually sees it as const fn (e.g., the const-fn-ness might be unstable and you might
553     /// not have the feature gate active).
554     ///
555     /// **Do not call this function manually.** It is only meant to cache the base data for the
556     /// `is_const_fn` function.
557     query is_const_fn_raw(key: DefId) -> bool {
558         desc { |tcx| "checking if item is const fn: `{}`", tcx.def_path_str(key) }
559         separate_provide_extern
560     }
561
562     query asyncness(key: DefId) -> hir::IsAsync {
563         desc { |tcx| "checking if the function is async: `{}`", tcx.def_path_str(key) }
564         separate_provide_extern
565     }
566
567     /// Returns `true` if calls to the function may be promoted.
568     ///
569     /// This is either because the function is e.g., a tuple-struct or tuple-variant
570     /// constructor, or because it has the `#[rustc_promotable]` attribute. The attribute should
571     /// be removed in the future in favour of some form of check which figures out whether the
572     /// function does not inspect the bits of any of its arguments (so is essentially just a
573     /// constructor function).
574     query is_promotable_const_fn(key: DefId) -> bool {
575         desc { |tcx| "checking if item is promotable: `{}`", tcx.def_path_str(key) }
576     }
577
578     /// Returns `true` if this is a foreign item (i.e., linked via `extern { ... }`).
579     query is_foreign_item(key: DefId) -> bool {
580         desc { |tcx| "checking if `{}` is a foreign item", tcx.def_path_str(key) }
581         separate_provide_extern
582     }
583
584     /// Returns `Some(mutability)` if the node pointed to by `def_id` is a static item.
585     query static_mutability(def_id: DefId) -> Option<hir::Mutability> {
586         desc { |tcx| "looking up static mutability of `{}`", tcx.def_path_str(def_id) }
587         separate_provide_extern
588     }
589
590     /// Returns `Some(generator_kind)` if the node pointed to by `def_id` is a generator.
591     query generator_kind(def_id: DefId) -> Option<hir::GeneratorKind> {
592         desc { |tcx| "looking up generator kind of `{}`", tcx.def_path_str(def_id) }
593         separate_provide_extern
594     }
595
596     /// Gets a map with the variance of every item; use `item_variance` instead.
597     query crate_variances(_: ()) -> ty::CrateVariancesMap<'tcx> {
598         storage(ArenaCacheSelector<'tcx>)
599         desc { "computing the variances for items in this crate" }
600     }
601
602     /// Maps from the `DefId` of a type or region parameter to its (inferred) variance.
603     query variances_of(def_id: DefId) -> &'tcx [ty::Variance] {
604         desc { |tcx| "computing the variances of `{}`", tcx.def_path_str(def_id) }
605         separate_provide_extern
606     }
607
608     /// Maps from thee `DefId` of a type to its (inferred) outlives.
609     query inferred_outlives_crate(_: ()) -> ty::CratePredicatesMap<'tcx> {
610         storage(ArenaCacheSelector<'tcx>)
611         desc { "computing the inferred outlives predicates for items in this crate" }
612     }
613
614     /// Maps from an impl/trait `DefId` to a list of the `DefId`s of its items.
615     query associated_item_def_ids(key: DefId) -> &'tcx [DefId] {
616         desc { |tcx| "collecting associated items of `{}`", tcx.def_path_str(key) }
617         separate_provide_extern
618     }
619
620     /// Maps from a trait item to the trait item "descriptor".
621     query associated_item(key: DefId) -> ty::AssocItem {
622         desc { |tcx| "computing associated item data for `{}`", tcx.def_path_str(key) }
623         storage(ArenaCacheSelector<'tcx>)
624         separate_provide_extern
625     }
626
627     /// Collects the associated items defined on a trait or impl.
628     query associated_items(key: DefId) -> ty::AssocItems<'tcx> {
629         storage(ArenaCacheSelector<'tcx>)
630         desc { |tcx| "collecting associated items of {}", tcx.def_path_str(key) }
631     }
632
633     /// Maps from associated items on a trait to the corresponding associated
634     /// item on the impl specified by `impl_id`.
635     ///
636     /// For example, with the following code
637     ///
638     /// ```
639     /// struct Type {}
640     ///                         // DefId
641     /// trait Trait {           // trait_id
642     ///     fn f();             // trait_f
643     ///     fn g() {}           // trait_g
644     /// }
645     ///
646     /// impl Trait for Type {   // impl_id
647     ///     fn f() {}           // impl_f
648     ///     fn g() {}           // impl_g
649     /// }
650     /// ```
651     ///
652     /// The map returned for `tcx.impl_item_implementor_ids(impl_id)` would be
653     ///`{ trait_f: impl_f, trait_g: impl_g }`
654     query impl_item_implementor_ids(impl_id: DefId) -> FxHashMap<DefId, DefId> {
655         desc { |tcx| "comparing impl items against trait for {}", tcx.def_path_str(impl_id) }
656         storage(ArenaCacheSelector<'tcx>)
657     }
658
659     /// Given an `impl_id`, return the trait it implements.
660     /// Return `None` if this is an inherent impl.
661     query impl_trait_ref(impl_id: DefId) -> Option<ty::TraitRef<'tcx>> {
662         desc { |tcx| "computing trait implemented by `{}`", tcx.def_path_str(impl_id) }
663         separate_provide_extern
664     }
665     query impl_polarity(impl_id: DefId) -> ty::ImplPolarity {
666         desc { |tcx| "computing implementation polarity of `{}`", tcx.def_path_str(impl_id) }
667         separate_provide_extern
668     }
669
670     query issue33140_self_ty(key: DefId) -> Option<ty::Ty<'tcx>> {
671         desc { |tcx| "computing Self type wrt issue #33140 `{}`", tcx.def_path_str(key) }
672     }
673
674     /// Maps a `DefId` of a type to a list of its inherent impls.
675     /// Contains implementations of methods that are inherent to a type.
676     /// Methods in these implementations don't need to be exported.
677     query inherent_impls(key: DefId) -> &'tcx [DefId] {
678         desc { |tcx| "collecting inherent impls for `{}`", tcx.def_path_str(key) }
679         separate_provide_extern
680     }
681
682     /// The result of unsafety-checking this `LocalDefId`.
683     query unsafety_check_result(key: LocalDefId) -> &'tcx mir::UnsafetyCheckResult {
684         desc { |tcx| "unsafety-checking `{}`", tcx.def_path_str(key.to_def_id()) }
685         cache_on_disk_if { true }
686     }
687     query unsafety_check_result_for_const_arg(key: (LocalDefId, DefId)) -> &'tcx mir::UnsafetyCheckResult {
688         desc {
689             |tcx| "unsafety-checking the const argument `{}`",
690             tcx.def_path_str(key.0.to_def_id())
691         }
692     }
693
694     /// Unsafety-check this `LocalDefId` with THIR unsafeck. This should be
695     /// used with `-Zthir-unsafeck`.
696     query thir_check_unsafety(key: LocalDefId) {
697         desc { |tcx| "unsafety-checking `{}`", tcx.def_path_str(key.to_def_id()) }
698         cache_on_disk_if { true }
699     }
700     query thir_check_unsafety_for_const_arg(key: (LocalDefId, DefId)) {
701         desc {
702             |tcx| "unsafety-checking the const argument `{}`",
703             tcx.def_path_str(key.0.to_def_id())
704         }
705     }
706
707     /// HACK: when evaluated, this reports an "unsafe derive on repr(packed)" error.
708     ///
709     /// Unsafety checking is executed for each method separately, but we only want
710     /// to emit this error once per derive. As there are some impls with multiple
711     /// methods, we use a query for deduplication.
712     query unsafe_derive_on_repr_packed(key: LocalDefId) -> () {
713         desc { |tcx| "processing `{}`", tcx.def_path_str(key.to_def_id()) }
714     }
715
716     /// Computes the signature of the function.
717     query fn_sig(key: DefId) -> ty::PolyFnSig<'tcx> {
718         desc { |tcx| "computing function signature of `{}`", tcx.def_path_str(key) }
719         separate_provide_extern
720     }
721
722     /// Performs lint checking for the module.
723     query lint_mod(key: LocalDefId) -> () {
724         desc { |tcx| "linting {}", describe_as_module(key, tcx) }
725     }
726
727     /// Checks the attributes in the module.
728     query check_mod_attrs(key: LocalDefId) -> () {
729         desc { |tcx| "checking attributes in {}", describe_as_module(key, tcx) }
730     }
731
732     /// Checks for uses of unstable APIs in the module.
733     query check_mod_unstable_api_usage(key: LocalDefId) -> () {
734         desc { |tcx| "checking for unstable API usage in {}", describe_as_module(key, tcx) }
735     }
736
737     /// Checks the const bodies in the module for illegal operations (e.g. `if` or `loop`).
738     query check_mod_const_bodies(key: LocalDefId) -> () {
739         desc { |tcx| "checking consts in {}", describe_as_module(key, tcx) }
740     }
741
742     /// Checks the loops in the module.
743     query check_mod_loops(key: LocalDefId) -> () {
744         desc { |tcx| "checking loops in {}", describe_as_module(key, tcx) }
745     }
746
747     query check_mod_naked_functions(key: LocalDefId) -> () {
748         desc { |tcx| "checking naked functions in {}", describe_as_module(key, tcx) }
749     }
750
751     query check_mod_item_types(key: LocalDefId) -> () {
752         desc { |tcx| "checking item types in {}", describe_as_module(key, tcx) }
753     }
754
755     query check_mod_privacy(key: LocalDefId) -> () {
756         desc { |tcx| "checking privacy in {}", describe_as_module(key, tcx) }
757     }
758
759     query check_mod_intrinsics(key: LocalDefId) -> () {
760         desc { |tcx| "checking intrinsics in {}", describe_as_module(key, tcx) }
761     }
762
763     query check_mod_liveness(key: LocalDefId) -> () {
764         desc { |tcx| "checking liveness of variables in {}", describe_as_module(key, tcx) }
765     }
766
767     query check_mod_impl_wf(key: LocalDefId) -> () {
768         desc { |tcx| "checking that impls are well-formed in {}", describe_as_module(key, tcx) }
769     }
770
771     query collect_mod_item_types(key: LocalDefId) -> () {
772         desc { |tcx| "collecting item types in {}", describe_as_module(key, tcx) }
773     }
774
775     /// Caches `CoerceUnsized` kinds for impls on custom types.
776     query coerce_unsized_info(key: DefId) -> ty::adjustment::CoerceUnsizedInfo {
777         desc { |tcx| "computing CoerceUnsized info for `{}`", tcx.def_path_str(key) }
778         separate_provide_extern
779     }
780
781     query typeck_item_bodies(_: ()) -> () {
782         desc { "type-checking all item bodies" }
783     }
784
785     query typeck(key: LocalDefId) -> &'tcx ty::TypeckResults<'tcx> {
786         desc { |tcx| "type-checking `{}`", tcx.def_path_str(key.to_def_id()) }
787         cache_on_disk_if { true }
788     }
789     query typeck_const_arg(
790         key: (LocalDefId, DefId)
791     ) -> &'tcx ty::TypeckResults<'tcx> {
792         desc {
793             |tcx| "type-checking the const argument `{}`",
794             tcx.def_path_str(key.0.to_def_id()),
795         }
796     }
797     query diagnostic_only_typeck(key: LocalDefId) -> &'tcx ty::TypeckResults<'tcx> {
798         desc { |tcx| "type-checking `{}`", tcx.def_path_str(key.to_def_id()) }
799         cache_on_disk_if { true }
800         load_cached(tcx, id) {
801             #[cfg(bootstrap)]
802             {
803                 match match tcx.on_disk_cache().as_ref() {
804                     Some(c) => c.try_load_query_result(*tcx, id),
805                     None => None,
806                 } {
807                     Some(x) => Some(&*tcx.arena.alloc(x)),
808                     None => None,
809                 }
810             }
811             #[cfg(not(bootstrap))]
812             {
813                 let typeck_results: Option<ty::TypeckResults<'tcx>> = tcx
814                     .on_disk_cache().as_ref()
815                     .and_then(|c| c.try_load_query_result(*tcx, id));
816
817                 typeck_results.map(|x| &*tcx.arena.alloc(x))
818             }
819         }
820     }
821
822     query used_trait_imports(key: LocalDefId) -> &'tcx FxHashSet<LocalDefId> {
823         desc { |tcx| "used_trait_imports `{}`", tcx.def_path_str(key.to_def_id()) }
824         cache_on_disk_if { true }
825     }
826
827     query has_typeck_results(def_id: DefId) -> bool {
828         desc { |tcx| "checking whether `{}` has a body", tcx.def_path_str(def_id) }
829     }
830
831     query coherent_trait(def_id: DefId) -> () {
832         desc { |tcx| "coherence checking all impls of trait `{}`", tcx.def_path_str(def_id) }
833     }
834
835     /// Borrow-checks the function body. If this is a closure, returns
836     /// additional requirements that the closure's creator must verify.
837     query mir_borrowck(key: LocalDefId) -> &'tcx mir::BorrowCheckResult<'tcx> {
838         desc { |tcx| "borrow-checking `{}`", tcx.def_path_str(key.to_def_id()) }
839         cache_on_disk_if(tcx) { tcx.is_typeck_child(key.to_def_id()) }
840     }
841     query mir_borrowck_const_arg(key: (LocalDefId, DefId)) -> &'tcx mir::BorrowCheckResult<'tcx> {
842         desc {
843             |tcx| "borrow-checking the const argument`{}`",
844             tcx.def_path_str(key.0.to_def_id())
845         }
846     }
847
848     /// Gets a complete map from all types to their inherent impls.
849     /// Not meant to be used directly outside of coherence.
850     query crate_inherent_impls(k: ()) -> CrateInherentImpls {
851         storage(ArenaCacheSelector<'tcx>)
852         desc { "all inherent impls defined in crate" }
853     }
854
855     /// Checks all types in the crate for overlap in their inherent impls. Reports errors.
856     /// Not meant to be used directly outside of coherence.
857     query crate_inherent_impls_overlap_check(_: ()) -> () {
858         desc { "check for overlap between inherent impls defined in this crate" }
859     }
860
861     /// Checks whether all impls in the crate pass the overlap check, returning
862     /// which impls fail it. If all impls are correct, the returned slice is empty.
863     query orphan_check_crate(_: ()) -> &'tcx [LocalDefId] {
864         desc {
865             "checking whether the immpl in the this crate follow the orphan rules",
866         }
867     }
868
869     /// Check whether the function has any recursion that could cause the inliner to trigger
870     /// a cycle. Returns the call stack causing the cycle. The call stack does not contain the
871     /// current function, just all intermediate functions.
872     query mir_callgraph_reachable(key: (ty::Instance<'tcx>, LocalDefId)) -> bool {
873         fatal_cycle
874         desc { |tcx|
875             "computing if `{}` (transitively) calls `{}`",
876             key.0,
877             tcx.def_path_str(key.1.to_def_id()),
878         }
879     }
880
881     /// Obtain all the calls into other local functions
882     query mir_inliner_callees(key: ty::InstanceDef<'tcx>) -> &'tcx [(DefId, SubstsRef<'tcx>)] {
883         fatal_cycle
884         desc { |tcx|
885             "computing all local function calls in `{}`",
886             tcx.def_path_str(key.def_id()),
887         }
888     }
889
890     /// Evaluates a constant and returns the computed allocation.
891     ///
892     /// **Do not use this** directly, use the `tcx.eval_static_initializer` wrapper.
893     query eval_to_allocation_raw(key: ty::ParamEnvAnd<'tcx, GlobalId<'tcx>>)
894         -> EvalToAllocationRawResult<'tcx> {
895         desc { |tcx|
896             "const-evaluating + checking `{}`",
897             key.value.display(tcx)
898         }
899         cache_on_disk_if { true }
900     }
901
902     /// Evaluates const items or anonymous constants
903     /// (such as enum variant explicit discriminants or array lengths)
904     /// into a representation suitable for the type system and const generics.
905     ///
906     /// **Do not use this** directly, use one of the following wrappers: `tcx.const_eval_poly`,
907     /// `tcx.const_eval_resolve`, `tcx.const_eval_instance`, or `tcx.const_eval_global_id`.
908     query eval_to_const_value_raw(key: ty::ParamEnvAnd<'tcx, GlobalId<'tcx>>)
909         -> EvalToConstValueResult<'tcx> {
910         desc { |tcx|
911             "simplifying constant for the type system `{}`",
912             key.value.display(tcx)
913         }
914         cache_on_disk_if { true }
915     }
916
917     /// Convert an evaluated constant to a type level constant or
918     /// return `None` if that is not possible.
919     query const_to_valtree(
920         key: ty::ParamEnvAnd<'tcx, ConstAlloc<'tcx>>
921     ) -> Option<ty::ValTree<'tcx>> {
922         desc { "destructure constant" }
923         remap_env_constness
924     }
925
926     /// Destructure a constant ADT or array into its variant index and its
927     /// field values.
928     query destructure_const(
929         key: ty::ParamEnvAnd<'tcx, &'tcx ty::Const<'tcx>>
930     ) -> mir::DestructuredConst<'tcx> {
931         desc { "destructure constant" }
932         remap_env_constness
933     }
934
935     /// Dereference a constant reference or raw pointer and turn the result into a constant
936     /// again.
937     query deref_const(
938         key: ty::ParamEnvAnd<'tcx, &'tcx ty::Const<'tcx>>
939     ) -> &'tcx ty::Const<'tcx> {
940         desc { "deref constant" }
941         remap_env_constness
942     }
943
944     query const_caller_location(key: (rustc_span::Symbol, u32, u32)) -> ConstValue<'tcx> {
945         desc { "get a &core::panic::Location referring to a span" }
946     }
947
948     query lit_to_const(
949         key: LitToConstInput<'tcx>
950     ) -> Result<&'tcx ty::Const<'tcx>, LitToConstError> {
951         desc { "converting literal to const" }
952     }
953
954     query check_match(key: DefId) {
955         desc { |tcx| "match-checking `{}`", tcx.def_path_str(key) }
956         cache_on_disk_if { key.is_local() }
957     }
958
959     /// Performs part of the privacy check and computes "access levels".
960     query privacy_access_levels(_: ()) -> &'tcx AccessLevels {
961         eval_always
962         desc { "privacy access levels" }
963     }
964     query check_private_in_public(_: ()) -> () {
965         eval_always
966         desc { "checking for private elements in public interfaces" }
967     }
968
969     query reachable_set(_: ()) -> FxHashSet<LocalDefId> {
970         storage(ArenaCacheSelector<'tcx>)
971         desc { "reachability" }
972     }
973
974     /// Per-body `region::ScopeTree`. The `DefId` should be the owner `DefId` for the body;
975     /// in the case of closures, this will be redirected to the enclosing function.
976     query region_scope_tree(def_id: DefId) -> &'tcx region::ScopeTree {
977         desc { |tcx| "computing drop scopes for `{}`", tcx.def_path_str(def_id) }
978     }
979
980     /// Generates a MIR body for the shim.
981     query mir_shims(key: ty::InstanceDef<'tcx>) -> mir::Body<'tcx> {
982         storage(ArenaCacheSelector<'tcx>)
983         desc { |tcx| "generating MIR shim for `{}`", tcx.def_path_str(key.def_id()) }
984     }
985
986     /// The `symbol_name` query provides the symbol name for calling a
987     /// given instance from the local crate. In particular, it will also
988     /// look up the correct symbol name of instances from upstream crates.
989     query symbol_name(key: ty::Instance<'tcx>) -> ty::SymbolName<'tcx> {
990         desc { "computing the symbol for `{}`", key }
991         cache_on_disk_if { true }
992     }
993
994     query opt_def_kind(def_id: DefId) -> Option<DefKind> {
995         desc { |tcx| "looking up definition kind of `{}`", tcx.def_path_str(def_id) }
996         separate_provide_extern
997     }
998
999     /// Gets the span for the definition.
1000     query def_span(def_id: DefId) -> Span {
1001         desc { |tcx| "looking up span for `{}`", tcx.def_path_str(def_id) }
1002         separate_provide_extern
1003     }
1004
1005     /// Gets the span for the identifier of the definition.
1006     query def_ident_span(def_id: DefId) -> Option<Span> {
1007         desc { |tcx| "looking up span for `{}`'s identifier", tcx.def_path_str(def_id) }
1008         separate_provide_extern
1009     }
1010
1011     query lookup_stability(def_id: DefId) -> Option<&'tcx attr::Stability> {
1012         desc { |tcx| "looking up stability of `{}`", tcx.def_path_str(def_id) }
1013         separate_provide_extern
1014     }
1015
1016     query lookup_const_stability(def_id: DefId) -> Option<&'tcx attr::ConstStability> {
1017         desc { |tcx| "looking up const stability of `{}`", tcx.def_path_str(def_id) }
1018         separate_provide_extern
1019     }
1020
1021     query should_inherit_track_caller(def_id: DefId) -> bool {
1022         desc { |tcx| "computing should_inherit_track_caller of `{}`", tcx.def_path_str(def_id) }
1023     }
1024
1025     query lookup_deprecation_entry(def_id: DefId) -> Option<DeprecationEntry> {
1026         desc { |tcx| "checking whether `{}` is deprecated", tcx.def_path_str(def_id) }
1027         separate_provide_extern
1028     }
1029
1030     query item_attrs(def_id: DefId) -> &'tcx [ast::Attribute] {
1031         desc { |tcx| "collecting attributes of `{}`", tcx.def_path_str(def_id) }
1032         separate_provide_extern
1033     }
1034
1035     query codegen_fn_attrs(def_id: DefId) -> CodegenFnAttrs {
1036         desc { |tcx| "computing codegen attributes of `{}`", tcx.def_path_str(def_id) }
1037         storage(ArenaCacheSelector<'tcx>)
1038         cache_on_disk_if { true }
1039     }
1040
1041     query fn_arg_names(def_id: DefId) -> &'tcx [rustc_span::symbol::Ident] {
1042         desc { |tcx| "looking up function parameter names for `{}`", tcx.def_path_str(def_id) }
1043         separate_provide_extern
1044     }
1045     /// Gets the rendered value of the specified constant or associated constant.
1046     /// Used by rustdoc.
1047     query rendered_const(def_id: DefId) -> String {
1048         desc { |tcx| "rendering constant intializer of `{}`", tcx.def_path_str(def_id) }
1049         separate_provide_extern
1050     }
1051     query impl_parent(def_id: DefId) -> Option<DefId> {
1052         desc { |tcx| "computing specialization parent impl of `{}`", tcx.def_path_str(def_id) }
1053         separate_provide_extern
1054     }
1055
1056     /// Given an `associated_item`, find the trait it belongs to.
1057     /// Return `None` if the `DefId` is not an associated item.
1058     query trait_of_item(associated_item: DefId) -> Option<DefId> {
1059         desc { |tcx| "finding trait defining `{}`", tcx.def_path_str(associated_item) }
1060         separate_provide_extern
1061     }
1062
1063     query is_ctfe_mir_available(key: DefId) -> bool {
1064         desc { |tcx| "checking if item has ctfe mir available: `{}`", tcx.def_path_str(key) }
1065         separate_provide_extern
1066     }
1067     query is_mir_available(key: DefId) -> bool {
1068         desc { |tcx| "checking if item has mir available: `{}`", tcx.def_path_str(key) }
1069         separate_provide_extern
1070     }
1071
1072     query own_existential_vtable_entries(
1073         key: ty::PolyExistentialTraitRef<'tcx>
1074     ) -> &'tcx [DefId] {
1075         desc { |tcx| "finding all existential vtable entries for trait {}", tcx.def_path_str(key.def_id()) }
1076     }
1077
1078     query vtable_entries(key: ty::PolyTraitRef<'tcx>)
1079                         -> &'tcx [ty::VtblEntry<'tcx>] {
1080         desc { |tcx| "finding all vtable entries for trait {}", tcx.def_path_str(key.def_id()) }
1081     }
1082
1083     query vtable_trait_upcasting_coercion_new_vptr_slot(key: (ty::Ty<'tcx>, ty::Ty<'tcx>)) -> Option<usize> {
1084         desc { |tcx| "finding the slot within vtable for trait object {} vtable ptr during trait upcasting coercion from {} vtable",
1085             key.1, key.0 }
1086     }
1087
1088     query vtable_allocation(key: (Ty<'tcx>, Option<ty::PolyExistentialTraitRef<'tcx>>)) -> mir::interpret::AllocId {
1089         desc { |tcx| "vtable const allocation for <{} as {}>",
1090             key.0,
1091             key.1.map(|trait_ref| format!("{}", trait_ref)).unwrap_or("_".to_owned())
1092         }
1093     }
1094
1095     query codegen_fulfill_obligation(
1096         key: (ty::ParamEnv<'tcx>, ty::PolyTraitRef<'tcx>)
1097     ) -> Result<ImplSource<'tcx, ()>, ErrorReported> {
1098         cache_on_disk_if { true }
1099         desc { |tcx|
1100             "checking if `{}` fulfills its obligations",
1101             tcx.def_path_str(key.1.def_id())
1102         }
1103     }
1104
1105     /// Return all `impl` blocks in the current crate.
1106     query all_local_trait_impls(_: ()) -> &'tcx BTreeMap<DefId, Vec<LocalDefId>> {
1107         desc { "local trait impls" }
1108     }
1109
1110     /// Given a trait `trait_id`, return all known `impl` blocks.
1111     query trait_impls_of(trait_id: DefId) -> ty::trait_def::TraitImpls {
1112         storage(ArenaCacheSelector<'tcx>)
1113         desc { |tcx| "trait impls of `{}`", tcx.def_path_str(trait_id) }
1114     }
1115
1116     query specialization_graph_of(trait_id: DefId) -> specialization_graph::Graph {
1117         storage(ArenaCacheSelector<'tcx>)
1118         desc { |tcx| "building specialization graph of trait `{}`", tcx.def_path_str(trait_id) }
1119         cache_on_disk_if { true }
1120     }
1121     query object_safety_violations(trait_id: DefId) -> &'tcx [traits::ObjectSafetyViolation] {
1122         desc { |tcx| "determine object safety of trait `{}`", tcx.def_path_str(trait_id) }
1123     }
1124
1125     /// Gets the ParameterEnvironment for a given item; this environment
1126     /// will be in "user-facing" mode, meaning that it is suitable for
1127     /// type-checking etc, and it does not normalize specializable
1128     /// associated types. This is almost always what you want,
1129     /// unless you are doing MIR optimizations, in which case you
1130     /// might want to use `reveal_all()` method to change modes.
1131     query param_env(def_id: DefId) -> ty::ParamEnv<'tcx> {
1132         desc { |tcx| "computing normalized predicates of `{}`", tcx.def_path_str(def_id) }
1133     }
1134
1135     /// Like `param_env`, but returns the `ParamEnv` in `Reveal::All` mode.
1136     /// Prefer this over `tcx.param_env(def_id).with_reveal_all_normalized(tcx)`,
1137     /// as this method is more efficient.
1138     query param_env_reveal_all_normalized(def_id: DefId) -> ty::ParamEnv<'tcx> {
1139         desc { |tcx| "computing revealed normalized predicates of `{}`", tcx.def_path_str(def_id) }
1140     }
1141
1142     /// Trait selection queries. These are best used by invoking `ty.is_copy_modulo_regions()`,
1143     /// `ty.is_copy()`, etc, since that will prune the environment where possible.
1144     query is_copy_raw(env: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1145         desc { "computing whether `{}` is `Copy`", env.value }
1146         remap_env_constness
1147     }
1148     /// Query backing `TyS::is_sized`.
1149     query is_sized_raw(env: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1150         desc { "computing whether `{}` is `Sized`", env.value }
1151         remap_env_constness
1152     }
1153     /// Query backing `TyS::is_freeze`.
1154     query is_freeze_raw(env: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1155         desc { "computing whether `{}` is freeze", env.value }
1156         remap_env_constness
1157     }
1158     /// Query backing `TyS::is_unpin`.
1159     query is_unpin_raw(env: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1160         desc { "computing whether `{}` is `Unpin`", env.value }
1161         remap_env_constness
1162     }
1163     /// Query backing `TyS::needs_drop`.
1164     query needs_drop_raw(env: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1165         desc { "computing whether `{}` needs drop", env.value }
1166         remap_env_constness
1167     }
1168     /// Query backing `TyS::has_significant_drop_raw`.
1169     query has_significant_drop_raw(env: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1170         desc { "computing whether `{}` has a significant drop", env.value }
1171         remap_env_constness
1172     }
1173
1174     /// Query backing `TyS::is_structural_eq_shallow`.
1175     ///
1176     /// This is only correct for ADTs. Call `is_structural_eq_shallow` to handle all types
1177     /// correctly.
1178     query has_structural_eq_impls(ty: Ty<'tcx>) -> bool {
1179         desc {
1180             "computing whether `{:?}` implements `PartialStructuralEq` and `StructuralEq`",
1181             ty
1182         }
1183     }
1184
1185     /// A list of types where the ADT requires drop if and only if any of
1186     /// those types require drop. If the ADT is known to always need drop
1187     /// then `Err(AlwaysRequiresDrop)` is returned.
1188     query adt_drop_tys(def_id: DefId) -> Result<&'tcx ty::List<Ty<'tcx>>, AlwaysRequiresDrop> {
1189         desc { |tcx| "computing when `{}` needs drop", tcx.def_path_str(def_id) }
1190         cache_on_disk_if { true }
1191     }
1192
1193     /// A list of types where the ADT requires drop if and only if any of those types
1194     /// has significant drop. A type marked with the attribute `rustc_insignificant_dtor`
1195     /// is considered to not be significant. A drop is significant if it is implemented
1196     /// by the user or does anything that will have any observable behavior (other than
1197     /// freeing up memory). If the ADT is known to have a significant destructor then
1198     /// `Err(AlwaysRequiresDrop)` is returned.
1199     query adt_significant_drop_tys(def_id: DefId) -> Result<&'tcx ty::List<Ty<'tcx>>, AlwaysRequiresDrop> {
1200         desc { |tcx| "computing when `{}` has a significant destructor", tcx.def_path_str(def_id) }
1201         cache_on_disk_if { false }
1202     }
1203
1204     /// Computes the layout of a type. Note that this implicitly
1205     /// executes in "reveal all" mode, and will normalize the input type.
1206     query layout_of(
1207         key: ty::ParamEnvAnd<'tcx, Ty<'tcx>>
1208     ) -> Result<ty::layout::TyAndLayout<'tcx>, ty::layout::LayoutError<'tcx>> {
1209         desc { "computing layout of `{}`", key.value }
1210         remap_env_constness
1211     }
1212
1213     /// Compute a `FnAbi` suitable for indirect calls, i.e. to `fn` pointers.
1214     ///
1215     /// NB: this doesn't handle virtual calls - those should use `fn_abi_of_instance`
1216     /// instead, where the instance is an `InstanceDef::Virtual`.
1217     query fn_abi_of_fn_ptr(
1218         key: ty::ParamEnvAnd<'tcx, (ty::PolyFnSig<'tcx>, &'tcx ty::List<Ty<'tcx>>)>
1219     ) -> Result<&'tcx abi::call::FnAbi<'tcx, Ty<'tcx>>, ty::layout::FnAbiError<'tcx>> {
1220         desc { "computing call ABI of `{}` function pointers", key.value.0 }
1221         remap_env_constness
1222     }
1223
1224     /// Compute a `FnAbi` suitable for declaring/defining an `fn` instance, and for
1225     /// direct calls to an `fn`.
1226     ///
1227     /// NB: that includes virtual calls, which are represented by "direct calls"
1228     /// to an `InstanceDef::Virtual` instance (of `<dyn Trait as Trait>::fn`).
1229     query fn_abi_of_instance(
1230         key: ty::ParamEnvAnd<'tcx, (ty::Instance<'tcx>, &'tcx ty::List<Ty<'tcx>>)>
1231     ) -> Result<&'tcx abi::call::FnAbi<'tcx, Ty<'tcx>>, ty::layout::FnAbiError<'tcx>> {
1232         desc { "computing call ABI of `{}`", key.value.0 }
1233         remap_env_constness
1234     }
1235
1236     query dylib_dependency_formats(_: CrateNum)
1237                                     -> &'tcx [(CrateNum, LinkagePreference)] {
1238         desc { "dylib dependency formats of crate" }
1239         separate_provide_extern
1240     }
1241
1242     query dependency_formats(_: ()) -> Lrc<crate::middle::dependency_format::Dependencies> {
1243         desc { "get the linkage format of all dependencies" }
1244     }
1245
1246     query is_compiler_builtins(_: CrateNum) -> bool {
1247         fatal_cycle
1248         desc { "checking if the crate is_compiler_builtins" }
1249         separate_provide_extern
1250     }
1251     query has_global_allocator(_: CrateNum) -> bool {
1252         // This query depends on untracked global state in CStore
1253         eval_always
1254         fatal_cycle
1255         desc { "checking if the crate has_global_allocator" }
1256         separate_provide_extern
1257     }
1258     query has_panic_handler(_: CrateNum) -> bool {
1259         fatal_cycle
1260         desc { "checking if the crate has_panic_handler" }
1261         separate_provide_extern
1262     }
1263     query is_profiler_runtime(_: CrateNum) -> bool {
1264         fatal_cycle
1265         desc { "query a crate is `#![profiler_runtime]`" }
1266         separate_provide_extern
1267     }
1268     query panic_strategy(_: CrateNum) -> PanicStrategy {
1269         fatal_cycle
1270         desc { "query a crate's configured panic strategy" }
1271         separate_provide_extern
1272     }
1273     query panic_in_drop_strategy(_: CrateNum) -> PanicStrategy {
1274         fatal_cycle
1275         desc { "query a crate's configured panic-in-drop strategy" }
1276         separate_provide_extern
1277     }
1278     query is_no_builtins(_: CrateNum) -> bool {
1279         fatal_cycle
1280         desc { "test whether a crate has `#![no_builtins]`" }
1281         separate_provide_extern
1282     }
1283     query symbol_mangling_version(_: CrateNum) -> SymbolManglingVersion {
1284         fatal_cycle
1285         desc { "query a crate's symbol mangling version" }
1286         separate_provide_extern
1287     }
1288
1289     query extern_crate(def_id: DefId) -> Option<&'tcx ExternCrate> {
1290         eval_always
1291         desc { "getting crate's ExternCrateData" }
1292         separate_provide_extern
1293     }
1294
1295     query specializes(_: (DefId, DefId)) -> bool {
1296         desc { "computing whether impls specialize one another" }
1297     }
1298     query in_scope_traits_map(_: LocalDefId)
1299         -> Option<&'tcx FxHashMap<ItemLocalId, Box<[TraitCandidate]>>> {
1300         desc { "traits in scope at a block" }
1301     }
1302
1303     query module_reexports(def_id: LocalDefId) -> Option<&'tcx [ModChild]> {
1304         desc { |tcx| "looking up reexports of module `{}`", tcx.def_path_str(def_id.to_def_id()) }
1305     }
1306
1307     query impl_defaultness(def_id: DefId) -> hir::Defaultness {
1308         desc { |tcx| "looking up whether `{}` is a default impl", tcx.def_path_str(def_id) }
1309         separate_provide_extern
1310     }
1311
1312     query impl_constness(def_id: DefId) -> hir::Constness {
1313         desc { |tcx| "looking up whether `{}` is a const impl", tcx.def_path_str(def_id) }
1314         separate_provide_extern
1315     }
1316
1317     query check_item_well_formed(key: LocalDefId) -> () {
1318         desc { |tcx| "checking that `{}` is well-formed", tcx.def_path_str(key.to_def_id()) }
1319     }
1320     query check_trait_item_well_formed(key: LocalDefId) -> () {
1321         desc { |tcx| "checking that `{}` is well-formed", tcx.def_path_str(key.to_def_id()) }
1322     }
1323     query check_impl_item_well_formed(key: LocalDefId) -> () {
1324         desc { |tcx| "checking that `{}` is well-formed", tcx.def_path_str(key.to_def_id()) }
1325     }
1326
1327     // The `DefId`s of all non-generic functions and statics in the given crate
1328     // that can be reached from outside the crate.
1329     //
1330     // We expect this items to be available for being linked to.
1331     //
1332     // This query can also be called for `LOCAL_CRATE`. In this case it will
1333     // compute which items will be reachable to other crates, taking into account
1334     // the kind of crate that is currently compiled. Crates with only a
1335     // C interface have fewer reachable things.
1336     //
1337     // Does not include external symbols that don't have a corresponding DefId,
1338     // like the compiler-generated `main` function and so on.
1339     query reachable_non_generics(_: CrateNum)
1340         -> DefIdMap<SymbolExportLevel> {
1341         storage(ArenaCacheSelector<'tcx>)
1342         desc { "looking up the exported symbols of a crate" }
1343         separate_provide_extern
1344     }
1345     query is_reachable_non_generic(def_id: DefId) -> bool {
1346         desc { |tcx| "checking whether `{}` is an exported symbol", tcx.def_path_str(def_id) }
1347         separate_provide_extern
1348     }
1349     query is_unreachable_local_definition(def_id: LocalDefId) -> bool {
1350         desc { |tcx|
1351             "checking whether `{}` is reachable from outside the crate",
1352             tcx.def_path_str(def_id.to_def_id()),
1353         }
1354     }
1355
1356     /// The entire set of monomorphizations the local crate can safely link
1357     /// to because they are exported from upstream crates. Do not depend on
1358     /// this directly, as its value changes anytime a monomorphization gets
1359     /// added or removed in any upstream crate. Instead use the narrower
1360     /// `upstream_monomorphizations_for`, `upstream_drop_glue_for`, or, even
1361     /// better, `Instance::upstream_monomorphization()`.
1362     query upstream_monomorphizations(_: ()) -> DefIdMap<FxHashMap<SubstsRef<'tcx>, CrateNum>> {
1363         storage(ArenaCacheSelector<'tcx>)
1364         desc { "collecting available upstream monomorphizations" }
1365     }
1366
1367     /// Returns the set of upstream monomorphizations available for the
1368     /// generic function identified by the given `def_id`. The query makes
1369     /// sure to make a stable selection if the same monomorphization is
1370     /// available in multiple upstream crates.
1371     ///
1372     /// You likely want to call `Instance::upstream_monomorphization()`
1373     /// instead of invoking this query directly.
1374     query upstream_monomorphizations_for(def_id: DefId)
1375         -> Option<&'tcx FxHashMap<SubstsRef<'tcx>, CrateNum>> {
1376             desc { |tcx|
1377                 "collecting available upstream monomorphizations for `{}`",
1378                 tcx.def_path_str(def_id),
1379             }
1380             separate_provide_extern
1381         }
1382
1383     /// Returns the upstream crate that exports drop-glue for the given
1384     /// type (`substs` is expected to be a single-item list containing the
1385     /// type one wants drop-glue for).
1386     ///
1387     /// This is a subset of `upstream_monomorphizations_for` in order to
1388     /// increase dep-tracking granularity. Otherwise adding or removing any
1389     /// type with drop-glue in any upstream crate would invalidate all
1390     /// functions calling drop-glue of an upstream type.
1391     ///
1392     /// You likely want to call `Instance::upstream_monomorphization()`
1393     /// instead of invoking this query directly.
1394     ///
1395     /// NOTE: This query could easily be extended to also support other
1396     ///       common functions that have are large set of monomorphizations
1397     ///       (like `Clone::clone` for example).
1398     query upstream_drop_glue_for(substs: SubstsRef<'tcx>) -> Option<CrateNum> {
1399         desc { "available upstream drop-glue for `{:?}`", substs }
1400     }
1401
1402     query foreign_modules(_: CrateNum) -> Lrc<FxHashMap<DefId, ForeignModule>> {
1403         desc { "looking up the foreign modules of a linked crate" }
1404         separate_provide_extern
1405     }
1406
1407     /// Identifies the entry-point (e.g., the `main` function) for a given
1408     /// crate, returning `None` if there is no entry point (such as for library crates).
1409     query entry_fn(_: ()) -> Option<(DefId, EntryFnType)> {
1410         desc { "looking up the entry function of a crate" }
1411     }
1412     query proc_macro_decls_static(_: ()) -> Option<LocalDefId> {
1413         desc { "looking up the derive registrar for a crate" }
1414     }
1415     // The macro which defines `rustc_metadata::provide_extern` depends on this query's name.
1416     // Changing the name should cause a compiler error, but in case that changes, be aware.
1417     query crate_hash(_: CrateNum) -> Svh {
1418         eval_always
1419         desc { "looking up the hash a crate" }
1420         separate_provide_extern
1421     }
1422     query crate_host_hash(_: CrateNum) -> Option<Svh> {
1423         eval_always
1424         desc { "looking up the hash of a host version of a crate" }
1425         separate_provide_extern
1426     }
1427     query extra_filename(_: CrateNum) -> String {
1428         eval_always
1429         desc { "looking up the extra filename for a crate" }
1430         separate_provide_extern
1431     }
1432     query crate_extern_paths(_: CrateNum) -> Vec<PathBuf> {
1433         eval_always
1434         desc { "looking up the paths for extern crates" }
1435         separate_provide_extern
1436     }
1437
1438     /// Given a crate and a trait, look up all impls of that trait in the crate.
1439     /// Return `(impl_id, self_ty)`.
1440     query implementations_of_trait(_: (CrateNum, DefId)) -> &'tcx [(DefId, Option<SimplifiedType>)] {
1441         desc { "looking up implementations of a trait in a crate" }
1442         separate_provide_extern
1443     }
1444
1445     query is_dllimport_foreign_item(def_id: DefId) -> bool {
1446         desc { |tcx| "is_dllimport_foreign_item({})", tcx.def_path_str(def_id) }
1447     }
1448     query is_statically_included_foreign_item(def_id: DefId) -> bool {
1449         desc { |tcx| "is_statically_included_foreign_item({})", tcx.def_path_str(def_id) }
1450     }
1451     query native_library_kind(def_id: DefId)
1452         -> Option<NativeLibKind> {
1453         desc { |tcx| "native_library_kind({})", tcx.def_path_str(def_id) }
1454     }
1455
1456     /// Does lifetime resolution, but does not descend into trait items. This
1457     /// should only be used for resolving lifetimes of on trait definitions,
1458     /// and is used to avoid cycles. Importantly, `resolve_lifetimes` still visits
1459     /// the same lifetimes and is responsible for diagnostics.
1460     /// See `rustc_resolve::late::lifetimes for details.
1461     query resolve_lifetimes_trait_definition(_: LocalDefId) -> ResolveLifetimes {
1462         storage(ArenaCacheSelector<'tcx>)
1463         desc { "resolving lifetimes for a trait definition" }
1464     }
1465     /// Does lifetime resolution on items. Importantly, we can't resolve
1466     /// lifetimes directly on things like trait methods, because of trait params.
1467     /// See `rustc_resolve::late::lifetimes for details.
1468     query resolve_lifetimes(_: LocalDefId) -> ResolveLifetimes {
1469         storage(ArenaCacheSelector<'tcx>)
1470         desc { "resolving lifetimes" }
1471     }
1472     query named_region_map(_: LocalDefId) ->
1473         Option<&'tcx FxHashMap<ItemLocalId, Region>> {
1474         desc { "looking up a named region" }
1475     }
1476     query is_late_bound_map(_: LocalDefId) ->
1477         Option<(LocalDefId, &'tcx FxHashSet<ItemLocalId>)> {
1478         desc { "testing if a region is late bound" }
1479     }
1480     /// For a given item (like a struct), gets the default lifetimes to be used
1481     /// for each parameter if a trait object were to be passed for that parameter.
1482     /// For example, for `struct Foo<'a, T, U>`, this would be `['static, 'static]`.
1483     /// For `struct Foo<'a, T: 'a, U>`, this would instead be `['a, 'static]`.
1484     query object_lifetime_defaults_map(_: LocalDefId)
1485         -> Option<Vec<ObjectLifetimeDefault>> {
1486         desc { "looking up lifetime defaults for a region on an item" }
1487     }
1488     query late_bound_vars_map(_: LocalDefId)
1489         -> Option<&'tcx FxHashMap<ItemLocalId, Vec<ty::BoundVariableKind>>> {
1490         desc { "looking up late bound vars" }
1491     }
1492
1493     query lifetime_scope_map(_: LocalDefId) -> Option<FxHashMap<ItemLocalId, LifetimeScopeForPath>> {
1494         desc { "finds the lifetime scope for an HirId of a PathSegment" }
1495     }
1496
1497     query visibility(def_id: DefId) -> ty::Visibility {
1498         desc { |tcx| "computing visibility of `{}`", tcx.def_path_str(def_id) }
1499         separate_provide_extern
1500     }
1501
1502     /// Computes the set of modules from which this type is visibly uninhabited.
1503     /// To check whether a type is uninhabited at all (not just from a given module), you could
1504     /// check whether the forest is empty.
1505     query type_uninhabited_from(
1506         key: ty::ParamEnvAnd<'tcx, Ty<'tcx>>
1507     ) -> ty::inhabitedness::DefIdForest {
1508         desc { "computing the inhabitedness of `{:?}`", key }
1509         remap_env_constness
1510     }
1511
1512     query dep_kind(_: CrateNum) -> CrateDepKind {
1513         eval_always
1514         desc { "fetching what a dependency looks like" }
1515         separate_provide_extern
1516     }
1517
1518     /// Gets the name of the crate.
1519     query crate_name(_: CrateNum) -> Symbol {
1520         eval_always
1521         desc { "fetching what a crate is named" }
1522         separate_provide_extern
1523     }
1524     query module_children(def_id: DefId) -> &'tcx [ModChild] {
1525         desc { |tcx| "collecting child items of module `{}`", tcx.def_path_str(def_id) }
1526         separate_provide_extern
1527     }
1528     query extern_mod_stmt_cnum(def_id: LocalDefId) -> Option<CrateNum> {
1529         desc { |tcx| "computing crate imported by `{}`", tcx.def_path_str(def_id.to_def_id()) }
1530     }
1531
1532     query lib_features(_: ()) -> LibFeatures {
1533         storage(ArenaCacheSelector<'tcx>)
1534         desc { "calculating the lib features map" }
1535     }
1536     query defined_lib_features(_: CrateNum)
1537         -> &'tcx [(Symbol, Option<Symbol>)] {
1538         desc { "calculating the lib features defined in a crate" }
1539         separate_provide_extern
1540     }
1541     /// Returns the lang items defined in another crate by loading it from metadata.
1542     query get_lang_items(_: ()) -> LanguageItems {
1543         storage(ArenaCacheSelector<'tcx>)
1544         eval_always
1545         desc { "calculating the lang items map" }
1546     }
1547
1548     /// Returns all diagnostic items defined in all crates.
1549     query all_diagnostic_items(_: ()) -> rustc_hir::diagnostic_items::DiagnosticItems {
1550         storage(ArenaCacheSelector<'tcx>)
1551         eval_always
1552         desc { "calculating the diagnostic items map" }
1553     }
1554
1555     /// Returns the lang items defined in another crate by loading it from metadata.
1556     query defined_lang_items(_: CrateNum) -> &'tcx [(DefId, usize)] {
1557         desc { "calculating the lang items defined in a crate" }
1558         separate_provide_extern
1559     }
1560
1561     /// Returns the diagnostic items defined in a crate.
1562     query diagnostic_items(_: CrateNum) -> rustc_hir::diagnostic_items::DiagnosticItems {
1563         storage(ArenaCacheSelector<'tcx>)
1564         desc { "calculating the diagnostic items map in a crate" }
1565         separate_provide_extern
1566     }
1567
1568     query missing_lang_items(_: CrateNum) -> &'tcx [LangItem] {
1569         desc { "calculating the missing lang items in a crate" }
1570         separate_provide_extern
1571     }
1572     query visible_parent_map(_: ()) -> Lrc<DefIdMap<DefId>> {
1573         desc { "calculating the visible parent map" }
1574     }
1575     query trimmed_def_paths(_: ()) -> FxHashMap<DefId, Symbol> {
1576         storage(ArenaCacheSelector<'tcx>)
1577         desc { "calculating trimmed def paths" }
1578     }
1579     query missing_extern_crate_item(_: CrateNum) -> bool {
1580         eval_always
1581         desc { "seeing if we're missing an `extern crate` item for this crate" }
1582         separate_provide_extern
1583     }
1584     query used_crate_source(_: CrateNum) -> Lrc<CrateSource> {
1585         eval_always
1586         desc { "looking at the source for a crate" }
1587         separate_provide_extern
1588     }
1589     query postorder_cnums(_: ()) -> &'tcx [CrateNum] {
1590         eval_always
1591         desc { "generating a postorder list of CrateNums" }
1592     }
1593     /// Returns whether or not the crate with CrateNum 'cnum'
1594     /// is marked as a private dependency
1595     query is_private_dep(c: CrateNum) -> bool {
1596         eval_always
1597         desc { "check whether crate {} is a private dependency", c }
1598         separate_provide_extern
1599     }
1600     query allocator_kind(_: ()) -> Option<AllocatorKind> {
1601         eval_always
1602         desc { "allocator kind for the current crate" }
1603     }
1604
1605     query upvars_mentioned(def_id: DefId) -> Option<&'tcx FxIndexMap<hir::HirId, hir::Upvar>> {
1606         desc { |tcx| "collecting upvars mentioned in `{}`", tcx.def_path_str(def_id) }
1607     }
1608     query maybe_unused_trait_import(def_id: LocalDefId) -> bool {
1609         desc { |tcx| "maybe_unused_trait_import for `{}`", tcx.def_path_str(def_id.to_def_id()) }
1610     }
1611     query maybe_unused_extern_crates(_: ()) -> &'tcx [(LocalDefId, Span)] {
1612         desc { "looking up all possibly unused extern crates" }
1613     }
1614     query names_imported_by_glob_use(def_id: LocalDefId) -> &'tcx FxHashSet<Symbol> {
1615         desc { |tcx| "names_imported_by_glob_use for `{}`", tcx.def_path_str(def_id.to_def_id()) }
1616     }
1617
1618     query stability_index(_: ()) -> stability::Index<'tcx> {
1619         storage(ArenaCacheSelector<'tcx>)
1620         eval_always
1621         desc { "calculating the stability index for the local crate" }
1622     }
1623     query crates(_: ()) -> &'tcx [CrateNum] {
1624         eval_always
1625         desc { "fetching all foreign CrateNum instances" }
1626     }
1627
1628     /// A list of all traits in a crate, used by rustdoc and error reporting.
1629     /// NOTE: Not named just `traits` due to a naming conflict.
1630     query traits_in_crate(_: CrateNum) -> &'tcx [DefId] {
1631         desc { "fetching all traits in a crate" }
1632         separate_provide_extern
1633     }
1634
1635     /// The list of symbols exported from the given crate.
1636     ///
1637     /// - All names contained in `exported_symbols(cnum)` are guaranteed to
1638     ///   correspond to a publicly visible symbol in `cnum` machine code.
1639     /// - The `exported_symbols` sets of different crates do not intersect.
1640     query exported_symbols(_: CrateNum)
1641         -> &'tcx [(ExportedSymbol<'tcx>, SymbolExportLevel)] {
1642         desc { "exported_symbols" }
1643         separate_provide_extern
1644     }
1645
1646     query collect_and_partition_mono_items(_: ()) -> (&'tcx DefIdSet, &'tcx [CodegenUnit<'tcx>]) {
1647         eval_always
1648         desc { "collect_and_partition_mono_items" }
1649     }
1650     query is_codegened_item(def_id: DefId) -> bool {
1651         desc { |tcx| "determining whether `{}` needs codegen", tcx.def_path_str(def_id) }
1652     }
1653
1654     /// All items participating in code generation together with items inlined into them.
1655     query codegened_and_inlined_items(_: ()) -> &'tcx DefIdSet {
1656         eval_always
1657        desc { "codegened_and_inlined_items" }
1658     }
1659
1660     query codegen_unit(_: Symbol) -> &'tcx CodegenUnit<'tcx> {
1661         desc { "codegen_unit" }
1662     }
1663     query unused_generic_params(key: ty::InstanceDef<'tcx>) -> FiniteBitSet<u32> {
1664         cache_on_disk_if { key.def_id().is_local() }
1665         desc {
1666             |tcx| "determining which generic parameters are unused by `{}`",
1667                 tcx.def_path_str(key.def_id())
1668         }
1669         separate_provide_extern
1670     }
1671     query backend_optimization_level(_: ()) -> OptLevel {
1672         desc { "optimization level used by backend" }
1673     }
1674
1675     query output_filenames(_: ()) -> Arc<OutputFilenames> {
1676         eval_always
1677         desc { "output_filenames" }
1678     }
1679
1680     /// Do not call this query directly: invoke `normalize` instead.
1681     query normalize_projection_ty(
1682         goal: CanonicalProjectionGoal<'tcx>
1683     ) -> Result<
1684         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, NormalizationResult<'tcx>>>,
1685         NoSolution,
1686     > {
1687         desc { "normalizing `{:?}`", goal }
1688         remap_env_constness
1689     }
1690
1691     /// Do not call this query directly: invoke `try_normalize_erasing_regions` instead.
1692     query try_normalize_generic_arg_after_erasing_regions(
1693         goal: ParamEnvAnd<'tcx, GenericArg<'tcx>>
1694     ) -> Result<GenericArg<'tcx>, NoSolution> {
1695         desc { "normalizing `{}`", goal.value }
1696         remap_env_constness
1697     }
1698
1699     /// Do not call this query directly: invoke `try_normalize_erasing_regions` instead.
1700     query try_normalize_mir_const_after_erasing_regions(
1701         goal: ParamEnvAnd<'tcx, mir::ConstantKind<'tcx>>
1702     ) -> Result<mir::ConstantKind<'tcx>, NoSolution> {
1703         desc { "normalizing `{}`", goal.value }
1704         remap_env_constness
1705     }
1706
1707     query implied_outlives_bounds(
1708         goal: CanonicalTyGoal<'tcx>
1709     ) -> Result<
1710         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, Vec<OutlivesBound<'tcx>>>>,
1711         NoSolution,
1712     > {
1713         desc { "computing implied outlives bounds for `{:?}`", goal }
1714         remap_env_constness
1715     }
1716
1717     /// Do not call this query directly: invoke `infcx.at().dropck_outlives()` instead.
1718     query dropck_outlives(
1719         goal: CanonicalTyGoal<'tcx>
1720     ) -> Result<
1721         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, DropckOutlivesResult<'tcx>>>,
1722         NoSolution,
1723     > {
1724         desc { "computing dropck types for `{:?}`", goal }
1725         remap_env_constness
1726     }
1727
1728     /// Do not call this query directly: invoke `infcx.predicate_may_hold()` or
1729     /// `infcx.predicate_must_hold()` instead.
1730     query evaluate_obligation(
1731         goal: CanonicalPredicateGoal<'tcx>
1732     ) -> Result<traits::EvaluationResult, traits::OverflowError> {
1733         desc { "evaluating trait selection obligation `{}`", goal.value.value }
1734     }
1735
1736     query evaluate_goal(
1737         goal: traits::CanonicalChalkEnvironmentAndGoal<'tcx>
1738     ) -> Result<
1739         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ()>>,
1740         NoSolution
1741     > {
1742         desc { "evaluating trait selection obligation `{}`", goal.value }
1743     }
1744
1745     /// Do not call this query directly: part of the `Eq` type-op
1746     query type_op_ascribe_user_type(
1747         goal: CanonicalTypeOpAscribeUserTypeGoal<'tcx>
1748     ) -> Result<
1749         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ()>>,
1750         NoSolution,
1751     > {
1752         desc { "evaluating `type_op_ascribe_user_type` `{:?}`", goal }
1753         remap_env_constness
1754     }
1755
1756     /// Do not call this query directly: part of the `Eq` type-op
1757     query type_op_eq(
1758         goal: CanonicalTypeOpEqGoal<'tcx>
1759     ) -> Result<
1760         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ()>>,
1761         NoSolution,
1762     > {
1763         desc { "evaluating `type_op_eq` `{:?}`", goal }
1764         remap_env_constness
1765     }
1766
1767     /// Do not call this query directly: part of the `Subtype` type-op
1768     query type_op_subtype(
1769         goal: CanonicalTypeOpSubtypeGoal<'tcx>
1770     ) -> Result<
1771         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ()>>,
1772         NoSolution,
1773     > {
1774         desc { "evaluating `type_op_subtype` `{:?}`", goal }
1775         remap_env_constness
1776     }
1777
1778     /// Do not call this query directly: part of the `ProvePredicate` type-op
1779     query type_op_prove_predicate(
1780         goal: CanonicalTypeOpProvePredicateGoal<'tcx>
1781     ) -> Result<
1782         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ()>>,
1783         NoSolution,
1784     > {
1785         desc { "evaluating `type_op_prove_predicate` `{:?}`", goal }
1786     }
1787
1788     /// Do not call this query directly: part of the `Normalize` type-op
1789     query type_op_normalize_ty(
1790         goal: CanonicalTypeOpNormalizeGoal<'tcx, Ty<'tcx>>
1791     ) -> Result<
1792         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, Ty<'tcx>>>,
1793         NoSolution,
1794     > {
1795         desc { "normalizing `{:?}`", goal }
1796         remap_env_constness
1797     }
1798
1799     /// Do not call this query directly: part of the `Normalize` type-op
1800     query type_op_normalize_predicate(
1801         goal: CanonicalTypeOpNormalizeGoal<'tcx, ty::Predicate<'tcx>>
1802     ) -> Result<
1803         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ty::Predicate<'tcx>>>,
1804         NoSolution,
1805     > {
1806         desc { "normalizing `{:?}`", goal }
1807         remap_env_constness
1808     }
1809
1810     /// Do not call this query directly: part of the `Normalize` type-op
1811     query type_op_normalize_poly_fn_sig(
1812         goal: CanonicalTypeOpNormalizeGoal<'tcx, ty::PolyFnSig<'tcx>>
1813     ) -> Result<
1814         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ty::PolyFnSig<'tcx>>>,
1815         NoSolution,
1816     > {
1817         desc { "normalizing `{:?}`", goal }
1818         remap_env_constness
1819     }
1820
1821     /// Do not call this query directly: part of the `Normalize` type-op
1822     query type_op_normalize_fn_sig(
1823         goal: CanonicalTypeOpNormalizeGoal<'tcx, ty::FnSig<'tcx>>
1824     ) -> Result<
1825         &'tcx Canonical<'tcx, canonical::QueryResponse<'tcx, ty::FnSig<'tcx>>>,
1826         NoSolution,
1827     > {
1828         desc { "normalizing `{:?}`", goal }
1829         remap_env_constness
1830     }
1831
1832     query subst_and_check_impossible_predicates(key: (DefId, SubstsRef<'tcx>)) -> bool {
1833         desc { |tcx|
1834             "impossible substituted predicates:`{}`",
1835             tcx.def_path_str(key.0)
1836         }
1837     }
1838
1839     query method_autoderef_steps(
1840         goal: CanonicalTyGoal<'tcx>
1841     ) -> MethodAutoderefStepsResult<'tcx> {
1842         desc { "computing autoderef types for `{:?}`", goal }
1843         remap_env_constness
1844     }
1845
1846     query supported_target_features(_: CrateNum) -> FxHashMap<String, Option<Symbol>> {
1847         storage(ArenaCacheSelector<'tcx>)
1848         eval_always
1849         desc { "looking up supported target features" }
1850     }
1851
1852     /// Get an estimate of the size of an InstanceDef based on its MIR for CGU partitioning.
1853     query instance_def_size_estimate(def: ty::InstanceDef<'tcx>)
1854         -> usize {
1855         desc { |tcx| "estimating size for `{}`", tcx.def_path_str(def.def_id()) }
1856     }
1857
1858     query features_query(_: ()) -> &'tcx rustc_feature::Features {
1859         eval_always
1860         desc { "looking up enabled feature gates" }
1861     }
1862
1863     /// Attempt to resolve the given `DefId` to an `Instance`, for the
1864     /// given generics args (`SubstsRef`), returning one of:
1865     ///  * `Ok(Some(instance))` on success
1866     ///  * `Ok(None)` when the `SubstsRef` are still too generic,
1867     ///    and therefore don't allow finding the final `Instance`
1868     ///  * `Err(ErrorReported)` when the `Instance` resolution process
1869     ///    couldn't complete due to errors elsewhere - this is distinct
1870     ///    from `Ok(None)` to avoid misleading diagnostics when an error
1871     ///    has already been/will be emitted, for the original cause
1872     query resolve_instance(
1873         key: ty::ParamEnvAnd<'tcx, (DefId, SubstsRef<'tcx>)>
1874     ) -> Result<Option<ty::Instance<'tcx>>, ErrorReported> {
1875         desc { "resolving instance `{}`", ty::Instance::new(key.value.0, key.value.1) }
1876         remap_env_constness
1877     }
1878
1879     query resolve_instance_of_const_arg(
1880         key: ty::ParamEnvAnd<'tcx, (LocalDefId, DefId, SubstsRef<'tcx>)>
1881     ) -> Result<Option<ty::Instance<'tcx>>, ErrorReported> {
1882         desc {
1883             "resolving instance of the const argument `{}`",
1884             ty::Instance::new(key.value.0.to_def_id(), key.value.2),
1885         }
1886         remap_env_constness
1887     }
1888
1889     query normalize_opaque_types(key: &'tcx ty::List<ty::Predicate<'tcx>>) -> &'tcx ty::List<ty::Predicate<'tcx>> {
1890         desc { "normalizing opaque types in {:?}", key }
1891     }
1892
1893     /// Checks whether a type is definitely uninhabited. This is
1894     /// conservative: for some types that are uninhabited we return `false`,
1895     /// but we only return `true` for types that are definitely uninhabited.
1896     /// `ty.conservative_is_privately_uninhabited` implies that any value of type `ty`
1897     /// will be `Abi::Uninhabited`. (Note that uninhabited types may have nonzero
1898     /// size, to account for partial initialisation. See #49298 for details.)
1899     query conservative_is_privately_uninhabited(key: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
1900         desc { "conservatively checking if {:?} is privately uninhabited", key }
1901         remap_env_constness
1902     }
1903
1904     query limits(key: ()) -> Limits {
1905         desc { "looking up limits" }
1906     }
1907
1908     /// Performs an HIR-based well-formed check on the item with the given `HirId`. If
1909     /// we get an `Unimplemented` error that matches the provided `Predicate`, return
1910     /// the cause of the newly created obligation.
1911     ///
1912     /// This is only used by error-reporting code to get a better cause (in particular, a better
1913     /// span) for an *existing* error. Therefore, it is best-effort, and may never handle
1914     /// all of the cases that the normal `ty::Ty`-based wfcheck does. This is fine,
1915     /// because the `ty::Ty`-based wfcheck is always run.
1916     query diagnostic_hir_wf_check(key: (ty::Predicate<'tcx>, traits::WellFormedLoc)) -> Option<traits::ObligationCause<'tcx>> {
1917         eval_always
1918         no_hash
1919         desc { "performing HIR wf-checking for predicate {:?} at item {:?}", key.0, key.1 }
1920     }
1921 }