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