1 //! The implementation of the query system itself. This defines the macros that
2 //! generate the actual methods on tcx which find and execute the provider,
3 //! manage the caches, and so forth.
6 use crate::on_disk_cache::{CacheDecoder, CacheEncoder, EncodedDepNodeIndex};
7 use crate::profiling_support::QueryKeyStringCache;
8 use crate::{on_disk_cache, Queries};
9 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
10 use rustc_data_structures::sync::{AtomicU64, Lock};
11 use rustc_errors::{Diagnostic, Handler};
12 use rustc_middle::dep_graph::{
13 self, DepKind, DepKindStruct, DepNode, DepNodeIndex, SerializedDepNodeIndex,
15 use rustc_middle::ty::tls::{self, ImplicitCtxt};
16 use rustc_middle::ty::{self, TyCtxt};
17 use rustc_query_system::dep_graph::{DepNodeParams, HasDepContext};
18 use rustc_query_system::ich::StableHashingContext;
19 use rustc_query_system::query::{
20 force_query, QueryConfig, QueryContext, QueryDescription, QueryJobId, QueryMap,
21 QuerySideEffects, QueryStackFrame,
23 use rustc_query_system::{LayoutOfDepth, QueryOverflow, Value};
24 use rustc_serialize::Decodable;
25 use rustc_session::Limit;
26 use rustc_span::def_id::LOCAL_CRATE;
28 use std::num::NonZeroU64;
29 use thin_vec::ThinVec;
31 #[derive(Copy, Clone)]
32 pub struct QueryCtxt<'tcx> {
33 pub tcx: TyCtxt<'tcx>,
34 pub queries: &'tcx Queries<'tcx>,
37 impl<'tcx> std::ops::Deref for QueryCtxt<'tcx> {
38 type Target = TyCtxt<'tcx>;
41 fn deref(&self) -> &Self::Target {
46 impl<'tcx> HasDepContext for QueryCtxt<'tcx> {
47 type DepKind = rustc_middle::dep_graph::DepKind;
48 type DepContext = TyCtxt<'tcx>;
51 fn dep_context(&self) -> &Self::DepContext {
56 impl QueryContext for QueryCtxt<'_> {
57 fn next_job_id(&self) -> QueryJobId {
60 self.queries.jobs.fetch_add(1, rustc_data_structures::sync::Ordering::Relaxed),
66 fn current_query_job(&self) -> Option<QueryJobId> {
67 tls::with_related_context(**self, |icx| icx.query)
70 fn try_collect_active_jobs(&self) -> Option<QueryMap> {
71 self.queries.try_collect_active_jobs(**self)
74 // Interactions with on_disk_cache
75 fn load_side_effects(&self, prev_dep_node_index: SerializedDepNodeIndex) -> QuerySideEffects {
79 .map(|c| c.load_side_effects(**self, prev_dep_node_index))
83 fn store_side_effects(&self, dep_node_index: DepNodeIndex, side_effects: QuerySideEffects) {
84 if let Some(c) = self.queries.on_disk_cache.as_ref() {
85 c.store_side_effects(dep_node_index, side_effects)
89 fn store_side_effects_for_anon_node(
91 dep_node_index: DepNodeIndex,
92 side_effects: QuerySideEffects,
94 if let Some(c) = self.queries.on_disk_cache.as_ref() {
95 c.store_side_effects_for_anon_node(dep_node_index, side_effects)
99 /// Executes a job by changing the `ImplicitCtxt` to point to the
100 /// new query job while it executes. It returns the diagnostics
101 /// captured during execution and the actual result.
107 diagnostics: Option<&Lock<ThinVec<Diagnostic>>>,
108 compute: impl FnOnce() -> R,
110 // The `TyCtxt` stored in TLS has the same global interner lifetime
111 // as `self`, so we use `with_related_context` to relate the 'tcx lifetimes
112 // when accessing the `ImplicitCtxt`.
113 tls::with_related_context(**self, move |current_icx| {
114 if depth_limit && !self.recursion_limit().value_within_limit(current_icx.query_depth) {
115 self.depth_limit_error(token);
118 // Update the `ImplicitCtxt` to point to our new query job.
119 let new_icx = ImplicitCtxt {
123 query_depth: current_icx.query_depth + depth_limit as usize,
124 task_deps: current_icx.task_deps,
127 // Use the `ImplicitCtxt` while we execute the query.
128 tls::enter_context(&new_icx, |_| {
129 rustc_data_structures::stack::ensure_sufficient_stack(compute)
134 fn depth_limit_error(&self, job: QueryJobId) {
136 let mut layout_of_depth = None;
137 if let Some(map) = self.try_collect_active_jobs() {
138 if let Some((info, depth)) = job.try_find_layout_root(map) {
139 span = Some(info.job.span);
140 layout_of_depth = Some(LayoutOfDepth { desc: info.query.description, depth });
144 let suggested_limit = match self.recursion_limit() {
145 Limit(0) => Limit(2),
149 self.sess.emit_fatal(QueryOverflow {
153 crate_name: self.crate_name(LOCAL_CRATE),
158 impl<'tcx> QueryCtxt<'tcx> {
160 pub fn from_tcx(tcx: TyCtxt<'tcx>) -> Self {
161 let queries = tcx.queries.as_any();
162 let queries = unsafe {
163 let queries = std::mem::transmute::<&dyn Any, &dyn Any>(queries);
164 let queries = queries.downcast_ref().unwrap();
165 let queries = std::mem::transmute::<&Queries<'_>, &Queries<'_>>(queries);
168 QueryCtxt { tcx, queries }
171 pub(crate) fn on_disk_cache(self) -> Option<&'tcx on_disk_cache::OnDiskCache<'tcx>> {
172 self.queries.on_disk_cache.as_ref()
175 pub(super) fn encode_query_results(
177 encoder: &mut CacheEncoder<'_, 'tcx>,
178 query_result_index: &mut EncodedDepNodeIndex,
180 for query in &self.queries.query_structs {
181 if let Some(encode) = query.encode_query_results {
182 encode(self, encoder, query_result_index);
187 pub fn try_print_query_stack(
189 query: Option<QueryJobId>,
191 num_frames: Option<usize>,
193 rustc_query_system::query::print_query_stack(self, query, handler, num_frames)
197 #[derive(Clone, Copy)]
198 pub(crate) struct QueryStruct<'tcx> {
199 pub try_collect_active_jobs: fn(QueryCtxt<'tcx>, &mut QueryMap) -> Option<()>,
200 pub alloc_self_profile_query_strings: fn(TyCtxt<'tcx>, &mut QueryKeyStringCache),
201 pub encode_query_results:
202 Option<fn(QueryCtxt<'tcx>, &mut CacheEncoder<'_, 'tcx>, &mut EncodedDepNodeIndex)>,
205 macro_rules! handle_cycle_error {
207 rustc_query_system::HandleCycleError::Error
209 ([(fatal_cycle) $($rest:tt)*]) => {{
210 rustc_query_system::HandleCycleError::Fatal
212 ([(cycle_delay_bug) $($rest:tt)*]) => {{
213 rustc_query_system::HandleCycleError::DelayBug
215 ([$other:tt $($modifiers:tt)*]) => {
216 handle_cycle_error!([$($modifiers)*])
220 macro_rules! is_anon {
224 ([(anon) $($rest:tt)*]) => {{
227 ([$other:tt $($modifiers:tt)*]) => {
228 is_anon!([$($modifiers)*])
232 macro_rules! is_eval_always {
236 ([(eval_always) $($rest:tt)*]) => {{
239 ([$other:tt $($modifiers:tt)*]) => {
240 is_eval_always!([$($modifiers)*])
244 macro_rules! depth_limit {
248 ([(depth_limit) $($rest:tt)*]) => {{
251 ([$other:tt $($modifiers:tt)*]) => {
252 depth_limit!([$($modifiers)*])
256 macro_rules! hash_result {
258 Some(dep_graph::hash_result)
260 ([(no_hash) $($rest:tt)*]) => {{
263 ([$other:tt $($modifiers:tt)*]) => {
264 hash_result!([$($modifiers)*])
268 macro_rules! get_provider {
269 ([][$tcx:expr, $name:ident, $key:expr]) => {{
270 $tcx.queries.local_providers.$name
272 ([(separate_provide_extern) $($rest:tt)*][$tcx:expr, $name:ident, $key:expr]) => {{
273 if $key.query_crate_is_local() {
274 $tcx.queries.local_providers.$name
276 $tcx.queries.extern_providers.$name
279 ([$other:tt $($modifiers:tt)*][$($args:tt)*]) => {
280 get_provider!([$($modifiers)*][$($args)*])
284 macro_rules! should_ever_cache_on_disk {
288 ([(cache) $($rest:tt)*]) => {{
289 Some($crate::plumbing::try_load_from_disk::<Self::Value>)
291 ([$other:tt $($modifiers:tt)*]) => {
292 should_ever_cache_on_disk!([$($modifiers)*])
296 pub(crate) fn create_query_frame<
298 K: Copy + Key + for<'a> HashStable<StableHashingContext<'a>>,
300 tcx: QueryCtxt<'tcx>,
301 do_describe: fn(QueryCtxt<'tcx>, K) -> String,
305 ) -> QueryStackFrame {
306 // Disable visible paths printing for performance reasons.
307 // Showing visible path instead of any path is not that important in production.
308 let description = ty::print::with_no_visible_paths!(
309 // Force filename-line mode to avoid invoking `type_of` query.
310 ty::print::with_forced_impl_filename_line!(do_describe(tcx, key))
313 if tcx.sess.verbose() { format!("{} [{}]", description, name) } else { description };
314 let span = if kind == dep_graph::DepKind::def_span {
315 // The `def_span` query is used to calculate `default_span`,
316 // so exit to avoid infinite recursion.
319 Some(key.default_span(*tcx))
321 let def_kind = if kind == dep_graph::DepKind::opt_def_kind {
322 // Try to avoid infinite recursion.
326 .and_then(|def_id| def_id.as_local())
327 .and_then(|def_id| tcx.opt_def_kind(def_id))
330 tcx.with_stable_hashing_context(|mut hcx| {
331 let mut hasher = StableHasher::new();
332 std::mem::discriminant(&kind).hash_stable(&mut hcx, &mut hasher);
333 key.hash_stable(&mut hcx, &mut hasher);
334 hasher.finish::<u64>()
338 QueryStackFrame::new(name, description, span, def_kind, hash)
341 fn try_load_from_on_disk_cache<'tcx, Q>(tcx: TyCtxt<'tcx>, dep_node: DepNode)
343 Q: QueryDescription<QueryCtxt<'tcx>>,
344 Q::Key: DepNodeParams<TyCtxt<'tcx>>,
346 debug_assert!(tcx.dep_graph.is_green(&dep_node));
348 let key = Q::Key::recover(tcx, &dep_node).unwrap_or_else(|| {
349 panic!("Failed to recover key for {:?} with hash {}", dep_node, dep_node.hash)
351 if Q::cache_on_disk(tcx, &key) {
352 let _ = Q::execute_query(tcx, key);
356 pub(crate) fn try_load_from_disk<'tcx, V>(
357 tcx: QueryCtxt<'tcx>,
358 id: SerializedDepNodeIndex,
361 V: for<'a> Decodable<CacheDecoder<'a, 'tcx>>,
363 tcx.on_disk_cache().as_ref()?.try_load_query_result(*tcx, id)
366 fn force_from_dep_node<'tcx, Q>(tcx: TyCtxt<'tcx>, dep_node: DepNode) -> bool
368 Q: QueryDescription<QueryCtxt<'tcx>>,
369 Q::Key: DepNodeParams<TyCtxt<'tcx>>,
370 Q::Value: Value<TyCtxt<'tcx>>,
372 // We must avoid ever having to call `force_from_dep_node()` for a
373 // `DepNode::codegen_unit`:
374 // Since we cannot reconstruct the query key of a `DepNode::codegen_unit`, we
375 // would always end up having to evaluate the first caller of the
376 // `codegen_unit` query that *is* reconstructible. This might very well be
377 // the `compile_codegen_unit` query, thus re-codegenning the whole CGU just
378 // to re-trigger calling the `codegen_unit` query with the right key. At
379 // that point we would already have re-done all the work we are trying to
380 // avoid doing in the first place.
381 // The solution is simple: Just explicitly call the `codegen_unit` query for
382 // each CGU, right after partitioning. This way `try_mark_green` will always
383 // hit the cache instead of having to go through `force_from_dep_node`.
384 // This assertion makes sure, we actually keep applying the solution above.
386 dep_node.kind != DepKind::codegen_unit,
387 "calling force_from_dep_node() on DepKind::codegen_unit"
390 if let Some(key) = Q::Key::recover(tcx, &dep_node) {
391 #[cfg(debug_assertions)]
392 let _guard = tracing::span!(tracing::Level::TRACE, stringify!($name), ?key).entered();
393 let tcx = QueryCtxt::from_tcx(tcx);
394 force_query::<Q, _>(tcx, key, dep_node);
401 pub(crate) fn query_callback<'tcx, Q: QueryConfig>(
403 is_eval_always: bool,
404 ) -> DepKindStruct<'tcx>
406 Q: QueryDescription<QueryCtxt<'tcx>>,
407 Q::Key: DepNodeParams<TyCtxt<'tcx>>,
409 let fingerprint_style = Q::Key::fingerprint_style();
411 if is_anon || !fingerprint_style.reconstructible() {
412 return DepKindStruct {
416 force_from_dep_node: None,
417 try_load_from_on_disk_cache: None,
425 force_from_dep_node: Some(force_from_dep_node::<Q>),
426 try_load_from_on_disk_cache: Some(try_load_from_on_disk_cache::<Q>),
430 macro_rules! expand_if_cached {
431 ([], $tokens:expr) => {{
434 ([(cache) $($rest:tt)*], $tokens:expr) => {{
437 ([$other:tt $($modifiers:tt)*], $tokens:expr) => {
438 expand_if_cached!([$($modifiers)*], $tokens)
442 // NOTE: `$V` isn't used here, but we still need to match on it so it can be passed to other macros
443 // invoked by `rustc_query_append`.
444 macro_rules! define_queries {
447 [$($modifiers:tt)*] fn $name:ident($($K:tt)*) -> $V:ty,)*) => {
448 define_queries_struct! {
449 input: ($(([$($modifiers)*] [$($attr)*] [$name]))*)
452 #[allow(nonstandard_style)]
454 use std::marker::PhantomData;
456 $(pub struct $name<'tcx> {
457 data: PhantomData<&'tcx ()>
461 $(impl<'tcx> QueryConfig for queries::$name<'tcx> {
462 type Key = query_keys::$name<'tcx>;
463 type Value = query_values::$name<'tcx>;
464 type Stored = query_stored::$name<'tcx>;
465 const NAME: &'static str = stringify!($name);
468 impl<'tcx> QueryDescription<QueryCtxt<'tcx>> for queries::$name<'tcx> {
469 rustc_query_description! { $name }
471 type Cache = query_storage::$name<'tcx>;
474 fn query_state<'a>(tcx: QueryCtxt<'tcx>) -> &'a QueryState<Self::Key>
475 where QueryCtxt<'tcx>: 'a
481 fn query_cache<'a>(tcx: QueryCtxt<'tcx>) -> &'a Self::Cache
484 &tcx.query_caches.$name
488 fn make_vtable(tcx: QueryCtxt<'tcx>, key: &Self::Key) ->
489 QueryVTable<QueryCtxt<'tcx>, Self::Key, Self::Value>
491 let compute = get_provider!([$($modifiers)*][tcx, $name, key]);
492 let cache_on_disk = Self::cache_on_disk(tcx.tcx, key);
494 anon: is_anon!([$($modifiers)*]),
495 eval_always: is_eval_always!([$($modifiers)*]),
496 depth_limit: depth_limit!([$($modifiers)*]),
497 dep_kind: dep_graph::DepKind::$name,
498 hash_result: hash_result!([$($modifiers)*]),
499 handle_cycle_error: handle_cycle_error!([$($modifiers)*]),
501 try_load_from_disk: if cache_on_disk { should_ever_cache_on_disk!([$($modifiers)*]) } else { None },
505 fn execute_query(tcx: TyCtxt<'tcx>, k: Self::Key) -> Self::Stored {
510 #[allow(nonstandard_style)]
511 mod query_callbacks {
513 use rustc_query_system::dep_graph::FingerprintStyle;
515 // We use this for most things when incr. comp. is turned off.
516 pub fn Null<'tcx>() -> DepKindStruct<'tcx> {
519 is_eval_always: false,
520 fingerprint_style: FingerprintStyle::Unit,
521 force_from_dep_node: Some(|_, dep_node| bug!("force_from_dep_node: encountered {:?}", dep_node)),
522 try_load_from_on_disk_cache: None,
526 // We use this for the forever-red node.
527 pub fn Red<'tcx>() -> DepKindStruct<'tcx> {
530 is_eval_always: false,
531 fingerprint_style: FingerprintStyle::Unit,
532 force_from_dep_node: Some(|_, dep_node| bug!("force_from_dep_node: encountered {:?}", dep_node)),
533 try_load_from_on_disk_cache: None,
537 pub fn TraitSelect<'tcx>() -> DepKindStruct<'tcx> {
540 is_eval_always: false,
541 fingerprint_style: FingerprintStyle::Unit,
542 force_from_dep_node: None,
543 try_load_from_on_disk_cache: None,
547 pub fn CompileCodegenUnit<'tcx>() -> DepKindStruct<'tcx> {
550 is_eval_always: false,
551 fingerprint_style: FingerprintStyle::Opaque,
552 force_from_dep_node: None,
553 try_load_from_on_disk_cache: None,
557 pub fn CompileMonoItem<'tcx>() -> DepKindStruct<'tcx> {
560 is_eval_always: false,
561 fingerprint_style: FingerprintStyle::Opaque,
562 force_from_dep_node: None,
563 try_load_from_on_disk_cache: None,
567 $(pub(crate) fn $name<'tcx>()-> DepKindStruct<'tcx> {
568 $crate::plumbing::query_callback::<queries::$name<'tcx>>(
569 is_anon!([$($modifiers)*]),
570 is_eval_always!([$($modifiers)*]),
576 use rustc_middle::ty::TyCtxt;
577 use $crate::plumbing::{QueryStruct, QueryCtxt};
578 use $crate::profiling_support::QueryKeyStringCache;
579 use rustc_query_system::query::{QueryDescription, QueryMap};
581 pub(super) const fn dummy_query_struct<'tcx>() -> QueryStruct<'tcx> {
582 fn noop_try_collect_active_jobs(_: QueryCtxt<'_>, _: &mut QueryMap) -> Option<()> {
585 fn noop_alloc_self_profile_query_strings(_: TyCtxt<'_>, _: &mut QueryKeyStringCache) {}
588 try_collect_active_jobs: noop_try_collect_active_jobs,
589 alloc_self_profile_query_strings: noop_alloc_self_profile_query_strings,
590 encode_query_results: None,
594 pub(super) use dummy_query_struct as Null;
595 pub(super) use dummy_query_struct as Red;
596 pub(super) use dummy_query_struct as TraitSelect;
597 pub(super) use dummy_query_struct as CompileCodegenUnit;
598 pub(super) use dummy_query_struct as CompileMonoItem;
601 pub(super) const fn $name<'tcx>() -> QueryStruct<'tcx> { QueryStruct {
602 try_collect_active_jobs: |tcx, qmap| {
603 let make_query = |tcx, key| {
604 let kind = rustc_middle::dep_graph::DepKind::$name;
605 let name = stringify!($name);
606 $crate::plumbing::create_query_frame(tcx, super::queries::$name::describe, key, kind, name)
608 tcx.queries.$name.try_collect_active_jobs(
614 alloc_self_profile_query_strings: |tcx, string_cache| {
615 $crate::profiling_support::alloc_self_profile_query_strings_for_query_cache(
618 &tcx.query_caches.$name,
622 encode_query_results: expand_if_cached!([$($modifiers)*], |tcx, encoder, query_result_index|
623 $crate::on_disk_cache::encode_query_results::<_, super::queries::$name<'_>>(tcx, encoder, query_result_index)
628 pub fn query_callbacks<'tcx>(arena: &'tcx Arena<'tcx>) -> &'tcx [DepKindStruct<'tcx>] {
629 arena.alloc_from_iter(make_dep_kind_array!(query_callbacks))
634 use crate::{ExternProviders, OnDiskCache, Providers};
636 impl<'tcx> Queries<'tcx> {
638 local_providers: Providers,
639 extern_providers: ExternProviders,
640 on_disk_cache: Option<OnDiskCache<'tcx>>,
642 use crate::query_structs;
644 local_providers: Box::new(local_providers),
645 extern_providers: Box::new(extern_providers),
646 query_structs: make_dep_kind_array!(query_structs).to_vec(),
648 jobs: AtomicU64::new(1),
654 macro_rules! define_queries_struct {
656 input: ($(([$($modifiers:tt)*] [$($attr:tt)*] [$name:ident]))*)) => {
658 pub struct Queries<'tcx> {
659 local_providers: Box<Providers>,
660 extern_providers: Box<ExternProviders>,
661 query_structs: Vec<$crate::plumbing::QueryStruct<'tcx>>,
663 pub on_disk_cache: Option<OnDiskCache<'tcx>>,
667 $($(#[$attr])* $name: QueryState<<queries::$name<'tcx> as QueryConfig>::Key>,)*
670 impl<'tcx> Queries<'tcx> {
671 pub(crate) fn try_collect_active_jobs(
674 ) -> Option<QueryMap> {
675 let tcx = QueryCtxt { tcx, queries: self };
676 let mut jobs = QueryMap::default();
678 for query in &self.query_structs {
679 (query.try_collect_active_jobs)(tcx, &mut jobs);
686 impl<'tcx> QueryEngine<'tcx> for Queries<'tcx> {
687 fn as_any(&'tcx self) -> &'tcx dyn std::any::Any {
688 let this = unsafe { std::mem::transmute::<&Queries<'_>, &Queries<'_>>(self) };
692 fn try_mark_green(&'tcx self, tcx: TyCtxt<'tcx>, dep_node: &dep_graph::DepNode) -> bool {
693 let qcx = QueryCtxt { tcx, queries: self };
694 tcx.dep_graph.try_mark_green(qcx, dep_node).is_some()
699 #[tracing::instrument(level = "trace", skip(self, tcx), ret)]
704 key: <queries::$name<'tcx> as QueryConfig>::Key,
706 ) -> Option<query_stored::$name<'tcx>> {
707 let qcx = QueryCtxt { tcx, queries: self };
708 get_query::<queries::$name<'tcx>, _>(qcx, span, key, mode)