src/librustc_middle/dep_graph/dep_node.rs

   1 //! This module defines the `DepNode` type which the compiler uses to represent
   2 //! nodes in the dependency graph.
   3 //!
   4 //! A `DepNode` consists of a `DepKind` (which
   5 //! specifies the kind of thing it represents, like a piece of HIR, MIR, etc)
   6 //! and a `Fingerprint`, a 128-bit hash value the exact meaning of which
   7 //! depends on the node's `DepKind`. Together, the kind and the fingerprint
   8 //! fully identify a dependency node, even across multiple compilation sessions.
   9 //! In other words, the value of the fingerprint does not depend on anything
  10 //! that is specific to a given compilation session, like an unpredictable
  11 //! interning key (e.g., NodeId, DefId, Symbol) or the numeric value of a
  12 //! pointer. The concept behind this could be compared to how git commit hashes
  13 //! uniquely identify a given commit and has a few advantages:
  14 //!
  15 //! * A `DepNode` can simply be serialized to disk and loaded in another session
  16 //!   without the need to do any "rebasing" (like we have to do for Spans and
  17 //!   NodeIds) or "retracing" (like we had to do for `DefId` in earlier
  18 //!   implementations of the dependency graph).
  19 //! * A `Fingerprint` is just a bunch of bits, which allows `DepNode` to
  20 //!   implement `Copy`, `Sync`, `Send`, `Freeze`, etc.
  21 //! * Since we just have a bit pattern, `DepNode` can be mapped from disk into
  22 //!   memory without any post-processing (e.g., "abomination-style" pointer
  23 //!   reconstruction).
  24 //! * Because a `DepNode` is self-contained, we can instantiate `DepNodes` that
  25 //!   refer to things that do not exist anymore. In previous implementations
  26 //!   `DepNode` contained a `DefId`. A `DepNode` referring to something that
  27 //!   had been removed between the previous and the current compilation session
  28 //!   could not be instantiated because the current compilation session
  29 //!   contained no `DefId` for thing that had been removed.
  30 //!
  31 //! `DepNode` definition happens in the `define_dep_nodes!()` macro. This macro
  32 //! defines the `DepKind` enum and a corresponding `DepConstructor` enum. The
  33 //! `DepConstructor` enum links a `DepKind` to the parameters that are needed at
  34 //! runtime in order to construct a valid `DepNode` fingerprint.
  35 //!
  36 //! Because the macro sees what parameters a given `DepKind` requires, it can
  37 //! "infer" some properties for each kind of `DepNode`:
  38 //!
  39 //! * Whether a `DepNode` of a given kind has any parameters at all. Some
  40 //!   `DepNode`s could represent global concepts with only one value.
  41 //! * Whether it is possible, in principle, to reconstruct a query key from a
  42 //!   given `DepNode`. Many `DepKind`s only require a single `DefId` parameter,
  43 //!   in which case it is possible to map the node's fingerprint back to the
  44 //!   `DefId` it was computed from. In other cases, too much information gets
  45 //!   lost during fingerprint computation.
  46 //!
  47 //! The `DepConstructor` enum, together with `DepNode::new()`, ensures that only
  48 //! valid `DepNode` instances can be constructed. For example, the API does not
  49 //! allow for constructing parameterless `DepNode`s with anything other
  50 //! than a zeroed out fingerprint. More generally speaking, it relieves the
  51 //! user of the `DepNode` API of having to know how to compute the expected
  52 //! fingerprint for a given set of node parameters.
  53
  54 use crate::mir::interpret::{GlobalId, LitToConstInput};
  55 use crate::traits;
  56 use crate::traits::query::{
  57     CanonicalPredicateGoal, CanonicalProjectionGoal, CanonicalTyGoal,
  58     CanonicalTypeOpAscribeUserTypeGoal, CanonicalTypeOpEqGoal, CanonicalTypeOpNormalizeGoal,
  59     CanonicalTypeOpProvePredicateGoal, CanonicalTypeOpSubtypeGoal,
  60 };
  61 use crate::ty::subst::{GenericArg, SubstsRef};
  62 use crate::ty::{self, ParamEnvAnd, Ty, TyCtxt};
  63
  64 use rustc_data_structures::fingerprint::Fingerprint;
  65 use rustc_hir::def_id::{CrateNum, DefId, LocalDefId, CRATE_DEF_INDEX};
  66 use rustc_hir::definitions::DefPathHash;
  67 use rustc_hir::HirId;
  68 use rustc_span::symbol::Symbol;
  69 use std::hash::Hash;
  70
  71 pub use rustc_query_system::dep_graph::{DepContext, DepNodeParams};
  72
  73 // erase!() just makes tokens go away. It's used to specify which macro argument
  74 // is repeated (i.e., which sub-expression of the macro we are in) but don't need
  75 // to actually use any of the arguments.
  76 macro_rules! erase {
  77     ($x:tt) => {{}};
  78 }
  79
  80 macro_rules! is_anon_attr {
  81     (anon) => {
  82         true
  83     };
  84     ($attr:ident) => {
  85         false
  86     };
  87 }
  88
  89 macro_rules! is_eval_always_attr {
  90     (eval_always) => {
  91         true
  92     };
  93     ($attr:ident) => {
  94         false
  95     };
  96 }
  97
  98 macro_rules! contains_anon_attr {
  99     ($($attr:ident $(($($attr_args:tt)*))* ),*) => ({$(is_anon_attr!($attr) | )* false});
 100 }
 101
 102 macro_rules! contains_eval_always_attr {
 103     ($($attr:ident $(($($attr_args:tt)*))* ),*) => ({$(is_eval_always_attr!($attr) | )* false});
 104 }
 105
 106 macro_rules! define_dep_nodes {
 107     (<$tcx:tt>
 108     $(
 109         [$($attrs:tt)*]
 110         $variant:ident $(( $tuple_arg_ty:ty $(,)? ))*
 111       ,)*
 112     ) => (
 113         #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Encodable, Decodable)]
 114         #[allow(non_camel_case_types)]
 115         pub enum DepKind {
 116             $($variant),*
 117         }
 118
 119         impl DepKind {
 120             #[allow(unreachable_code)]
 121             pub fn can_reconstruct_query_key<$tcx>(&self) -> bool {
 122                 match *self {
 123                     $(
 124                         DepKind :: $variant => {
 125                             if contains_anon_attr!($($attrs)*) {
 126                                 return false;
 127                             }
 128
 129                             // tuple args
 130                             $({
 131                                 return <$tuple_arg_ty as DepNodeParams<TyCtxt<'_>>>
 132                                     ::can_reconstruct_query_key();
 133                             })*
 134
 135                             true
 136                         }
 137                     )*
 138                 }
 139             }
 140
 141             pub fn is_anon(&self) -> bool {
 142                 match *self {
 143                     $(
 144                         DepKind :: $variant => { contains_anon_attr!($($attrs)*) }
 145                     )*
 146                 }
 147             }
 148
 149             pub fn is_eval_always(&self) -> bool {
 150                 match *self {
 151                     $(
 152                         DepKind :: $variant => { contains_eval_always_attr!($($attrs)*) }
 153                     )*
 154                 }
 155             }
 156
 157             #[allow(unreachable_code)]
 158             pub fn has_params(&self) -> bool {
 159                 match *self {
 160                     $(
 161                         DepKind :: $variant => {
 162                             // tuple args
 163                             $({
 164                                 erase!($tuple_arg_ty);
 165                                 return true;
 166                             })*
 167
 168                             false
 169                         }
 170                     )*
 171                 }
 172             }
 173         }
 174
 175         pub struct DepConstructor;
 176
 177         #[allow(non_camel_case_types)]
 178         impl DepConstructor {
 179             $(
 180                 #[inline(always)]
 181                 #[allow(unreachable_code, non_snake_case)]
 182                 pub fn $variant(_tcx: TyCtxt<'_>, $(arg: $tuple_arg_ty)*) -> DepNode {
 183                     // tuple args
 184                     $({
 185                         erase!($tuple_arg_ty);
 186                         return DepNode::construct(_tcx, DepKind::$variant, &arg)
 187                     })*
 188
 189                     return DepNode::construct(_tcx, DepKind::$variant, &())
 190                 }
 191             )*
 192         }
 193
 194         pub type DepNode = rustc_query_system::dep_graph::DepNode<DepKind>;
 195
 196         pub trait DepNodeExt: Sized {
 197             /// Construct a DepNode from the given DepKind and DefPathHash. This
 198             /// method will assert that the given DepKind actually requires a
 199             /// single DefId/DefPathHash parameter.
 200             fn from_def_path_hash(def_path_hash: DefPathHash, kind: DepKind) -> Self;
 201
 202             /// Extracts the DefId corresponding to this DepNode. This will work
 203             /// if two conditions are met:
 204             ///
 205             /// 1. The Fingerprint of the DepNode actually is a DefPathHash, and
 206             /// 2. the item that the DefPath refers to exists in the current tcx.
 207             ///
 208             /// Condition (1) is determined by the DepKind variant of the
 209             /// DepNode. Condition (2) might not be fulfilled if a DepNode
 210             /// refers to something from the previous compilation session that
 211             /// has been removed.
 212             fn extract_def_id(&self, tcx: TyCtxt<'_>) -> Option<DefId>;
 213
 214             /// Used in testing
 215             fn from_label_string(label: &str, def_path_hash: DefPathHash)
 216                 -> Result<Self, ()>;
 217
 218             /// Used in testing
 219             fn has_label_string(label: &str) -> bool;
 220         }
 221
 222         impl DepNodeExt for DepNode {
 223             /// Construct a DepNode from the given DepKind and DefPathHash. This
 224             /// method will assert that the given DepKind actually requires a
 225             /// single DefId/DefPathHash parameter.
 226             fn from_def_path_hash(def_path_hash: DefPathHash, kind: DepKind) -> DepNode {
 227                 debug_assert!(kind.can_reconstruct_query_key() && kind.has_params());
 228                 DepNode {
 229                     kind,
 230                     hash: def_path_hash.0,
 231                 }
 232             }
 233
 234             /// Extracts the DefId corresponding to this DepNode. This will work
 235             /// if two conditions are met:
 236             ///
 237             /// 1. The Fingerprint of the DepNode actually is a DefPathHash, and
 238             /// 2. the item that the DefPath refers to exists in the current tcx.
 239             ///
 240             /// Condition (1) is determined by the DepKind variant of the
 241             /// DepNode. Condition (2) might not be fulfilled if a DepNode
 242             /// refers to something from the previous compilation session that
 243             /// has been removed.
 244             fn extract_def_id(&self, tcx: TyCtxt<'tcx>) -> Option<DefId> {
 245                 if self.kind.can_reconstruct_query_key() {
 246                     let def_path_hash = DefPathHash(self.hash);
 247                     tcx.def_path_hash_to_def_id.as_ref()?.get(&def_path_hash).cloned()
 248                 } else {
 249                     None
 250                 }
 251             }
 252
 253             /// Used in testing
 254             fn from_label_string(label: &str, def_path_hash: DefPathHash) -> Result<DepNode, ()> {
 255                 let kind = match label {
 256                     $(
 257                         stringify!($variant) => DepKind::$variant,
 258                     )*
 259                     _ => return Err(()),
 260                 };
 261
 262                 if !kind.can_reconstruct_query_key() {
 263                     return Err(());
 264                 }
 265
 266                 if kind.has_params() {
 267                     Ok(DepNode::from_def_path_hash(def_path_hash, kind))
 268                 } else {
 269                     Ok(DepNode::new_no_params(kind))
 270                 }
 271             }
 272
 273             /// Used in testing
 274             fn has_label_string(label: &str) -> bool {
 275                 match label {
 276                     $(
 277                         stringify!($variant) => true,
 278                     )*
 279                     _ => false,
 280                 }
 281             }
 282         }
 283
 284         /// Contains variant => str representations for constructing
 285         /// DepNode groups for tests.
 286         #[allow(dead_code, non_upper_case_globals)]
 287         pub mod label_strs {
 288            $(
 289                 pub const $variant: &str = stringify!($variant);
 290             )*
 291         }
 292     );
 293 }
 294
 295 rustc_dep_node_append!([define_dep_nodes!][ <'tcx>
 296     // We use this for most things when incr. comp. is turned off.
 297     [] Null,
 298
 299     // Represents metadata from an extern crate.
 300     [eval_always] CrateMetadata(CrateNum),
 301
 302     [anon] TraitSelect,
 303
 304     [] CompileCodegenUnit(Symbol),
 305 ]);
 306
 307 impl<'tcx> DepNodeParams<TyCtxt<'tcx>> for DefId {
 308     #[inline]
 309     fn can_reconstruct_query_key() -> bool {
 310         true
 311     }
 312
 313     fn to_fingerprint(&self, tcx: TyCtxt<'tcx>) -> Fingerprint {
 314         tcx.def_path_hash(*self).0
 315     }
 316
 317     fn to_debug_str(&self, tcx: TyCtxt<'tcx>) -> String {
 318         tcx.def_path_str(*self)
 319     }
 320
 321     fn recover(tcx: TyCtxt<'tcx>, dep_node: &DepNode) -> Option<Self> {
 322         dep_node.extract_def_id(tcx)
 323     }
 324 }
 325
 326 impl<'tcx> DepNodeParams<TyCtxt<'tcx>> for LocalDefId {
 327     #[inline]
 328     fn can_reconstruct_query_key() -> bool {
 329         true
 330     }
 331
 332     fn to_fingerprint(&self, tcx: TyCtxt<'tcx>) -> Fingerprint {
 333         self.to_def_id().to_fingerprint(tcx)
 334     }
 335
 336     fn to_debug_str(&self, tcx: TyCtxt<'tcx>) -> String {
 337         self.to_def_id().to_debug_str(tcx)
 338     }
 339
 340     fn recover(tcx: TyCtxt<'tcx>, dep_node: &DepNode) -> Option<Self> {
 341         dep_node.extract_def_id(tcx).map(|id| id.expect_local())
 342     }
 343 }
 344
 345 impl<'tcx> DepNodeParams<TyCtxt<'tcx>> for CrateNum {
 346     #[inline]
 347     fn can_reconstruct_query_key() -> bool {
 348         true
 349     }
 350
 351     fn to_fingerprint(&self, tcx: TyCtxt<'tcx>) -> Fingerprint {
 352         let def_id = DefId { krate: *self, index: CRATE_DEF_INDEX };
 353         tcx.def_path_hash(def_id).0
 354     }
 355
 356     fn to_debug_str(&self, tcx: TyCtxt<'tcx>) -> String {
 357         tcx.crate_name(*self).to_string()
 358     }
 359
 360     fn recover(tcx: TyCtxt<'tcx>, dep_node: &DepNode) -> Option<Self> {
 361         dep_node.extract_def_id(tcx).map(|id| id.krate)
 362     }
 363 }
 364
 365 impl<'tcx> DepNodeParams<TyCtxt<'tcx>> for (DefId, DefId) {
 366     #[inline]
 367     fn can_reconstruct_query_key() -> bool {
 368         false
 369     }
 370
 371     // We actually would not need to specialize the implementation of this
 372     // method but it's faster to combine the hashes than to instantiate a full
 373     // hashing context and stable-hashing state.
 374     fn to_fingerprint(&self, tcx: TyCtxt<'tcx>) -> Fingerprint {
 375         let (def_id_0, def_id_1) = *self;
 376
 377         let def_path_hash_0 = tcx.def_path_hash(def_id_0);
 378         let def_path_hash_1 = tcx.def_path_hash(def_id_1);
 379
 380         def_path_hash_0.0.combine(def_path_hash_1.0)
 381     }
 382
 383     fn to_debug_str(&self, tcx: TyCtxt<'tcx>) -> String {
 384         let (def_id_0, def_id_1) = *self;
 385
 386         format!("({}, {})", tcx.def_path_debug_str(def_id_0), tcx.def_path_debug_str(def_id_1))
 387     }
 388 }
 389
 390 impl<'tcx> DepNodeParams<TyCtxt<'tcx>> for HirId {
 391     #[inline]
 392     fn can_reconstruct_query_key() -> bool {
 393         false
 394     }
 395
 396     // We actually would not need to specialize the implementation of this
 397     // method but it's faster to combine the hashes than to instantiate a full
 398     // hashing context and stable-hashing state.
 399     fn to_fingerprint(&self, tcx: TyCtxt<'tcx>) -> Fingerprint {
 400         let HirId { owner, local_id } = *self;
 401
 402         let def_path_hash = tcx.def_path_hash(owner.to_def_id());
 403         let local_id = Fingerprint::from_smaller_hash(local_id.as_u32().into());
 404
 405         def_path_hash.0.combine(local_id)
 406     }
 407 }