compiler/rustc_query_system/src/query/config.rs

   1 //! Query configuration and description traits.
   2
   3 use crate::dep_graph::DepNode;
   4 use crate::dep_graph::SerializedDepNodeIndex;
   5 use crate::query::caches::QueryCache;
   6 use crate::query::{QueryCacheStore, QueryContext, QueryState};
   7
   8 use rustc_data_structures::fingerprint::Fingerprint;
   9 use rustc_errors::DiagnosticBuilder;
  10 use std::fmt::Debug;
  11 use std::hash::Hash;
  12
  13 pub trait QueryConfig {
  14     const NAME: &'static str;
  15
  16     type Key: Eq + Hash + Clone + Debug;
  17     type Value;
  18     type Stored: Clone;
  19 }
  20
  21 pub(crate) struct QueryVtable<CTX: QueryContext, K, V> {
  22     pub anon: bool,
  23     pub dep_kind: CTX::DepKind,
  24     pub eval_always: bool,
  25
  26     pub hash_result: fn(&mut CTX::StableHashingContext, &V) -> Option<Fingerprint>,
  27     pub handle_cycle_error: fn(CTX, DiagnosticBuilder<'_>) -> V,
  28     pub cache_on_disk: fn(CTX, &K, Option<&V>) -> bool,
  29     pub try_load_from_disk: fn(CTX, SerializedDepNodeIndex) -> Option<V>,
  30 }
  31
  32 impl<CTX: QueryContext, K, V> QueryVtable<CTX, K, V> {
  33     pub(crate) fn to_dep_node(&self, tcx: CTX::DepContext, key: &K) -> DepNode<CTX::DepKind>
  34     where
  35         K: crate::dep_graph::DepNodeParams<CTX::DepContext>,
  36     {
  37         DepNode::construct(tcx, self.dep_kind, key)
  38     }
  39
  40     pub(crate) fn hash_result(
  41         &self,
  42         hcx: &mut CTX::StableHashingContext,
  43         value: &V,
  44     ) -> Option<Fingerprint> {
  45         (self.hash_result)(hcx, value)
  46     }
  47
  48     pub(crate) fn cache_on_disk(&self, tcx: CTX, key: &K, value: Option<&V>) -> bool {
  49         (self.cache_on_disk)(tcx, key, value)
  50     }
  51
  52     pub(crate) fn try_load_from_disk(&self, tcx: CTX, index: SerializedDepNodeIndex) -> Option<V> {
  53         (self.try_load_from_disk)(tcx, index)
  54     }
  55 }
  56
  57 pub trait QueryAccessors<CTX: QueryContext>: QueryConfig {
  58     const ANON: bool;
  59     const EVAL_ALWAYS: bool;
  60     const DEP_KIND: CTX::DepKind;
  61
  62     type Cache: QueryCache<Key = Self::Key, Stored = Self::Stored, Value = Self::Value>;
  63
  64     // Don't use this method to access query results, instead use the methods on TyCtxt
  65     fn query_state<'a>(tcx: CTX) -> &'a QueryState<CTX::DepKind, Self::Key>
  66     where
  67         CTX: 'a;
  68
  69     // Don't use this method to access query results, instead use the methods on TyCtxt
  70     fn query_cache<'a>(tcx: CTX) -> &'a QueryCacheStore<Self::Cache>
  71     where
  72         CTX: 'a;
  73
  74     // Don't use this method to compute query results, instead use the methods on TyCtxt
  75     fn compute_fn(tcx: CTX, key: &Self::Key) -> fn(CTX::DepContext, Self::Key) -> Self::Value;
  76
  77     fn hash_result(
  78         hcx: &mut CTX::StableHashingContext,
  79         result: &Self::Value,
  80     ) -> Option<Fingerprint>;
  81
  82     fn handle_cycle_error(tcx: CTX, diag: DiagnosticBuilder<'_>) -> Self::Value;
  83 }
  84
  85 pub trait QueryDescription<CTX: QueryContext>: QueryAccessors<CTX> {
  86     fn describe(tcx: CTX, key: Self::Key) -> String;
  87
  88     #[inline]
  89     fn cache_on_disk(_: CTX, _: &Self::Key, _: Option<&Self::Value>) -> bool {
  90         false
  91     }
  92
  93     fn try_load_from_disk(_: CTX, _: SerializedDepNodeIndex) -> Option<Self::Value> {
  94         panic!("QueryDescription::load_from_disk() called for an unsupported query.")
  95     }
  96 }
  97
  98 pub(crate) trait QueryVtableExt<CTX: QueryContext, K, V> {
  99     const VTABLE: QueryVtable<CTX, K, V>;
 100 }
 101
 102 impl<CTX, Q> QueryVtableExt<CTX, Q::Key, Q::Value> for Q
 103 where
 104     CTX: QueryContext,
 105     Q: QueryDescription<CTX>,
 106 {
 107     const VTABLE: QueryVtable<CTX, Q::Key, Q::Value> = QueryVtable {
 108         anon: Q::ANON,
 109         dep_kind: Q::DEP_KIND,
 110         eval_always: Q::EVAL_ALWAYS,
 111         hash_result: Q::hash_result,
 112         handle_cycle_error: Q::handle_cycle_error,
 113         cache_on_disk: Q::cache_on_disk,
 114         try_load_from_disk: Q::try_load_from_disk,
 115     };
 116 }