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