compiler/rustc_hir/src/definitions.rs

   1 //! For each definition, we track the following data. A definition
   2 //! here is defined somewhat circularly as "something with a `DefId`",
   3 //! but it generally corresponds to things like structs, enums, etc.
   4 //! There are also some rather random cases (like const initializer
   5 //! expressions) that are mostly just leftovers.
   6
   7 pub use crate::def_id::DefPathHash;
   8 use crate::def_id::{
   9     CrateNum, DefId, DefIndex, LocalDefId, StableCrateId, CRATE_DEF_INDEX, LOCAL_CRATE,
  10 };
  11 use crate::hir;
  12
  13 use rustc_data_structures::fx::FxHashMap;
  14 use rustc_data_structures::stable_hasher::StableHasher;
  15 use rustc_data_structures::unhash::UnhashMap;
  16 use rustc_index::vec::IndexVec;
  17 use rustc_span::crate_disambiguator::CrateDisambiguator;
  18 use rustc_span::hygiene::ExpnId;
  19 use rustc_span::symbol::{kw, sym, Symbol};
  20
  21 use std::fmt::{self, Write};
  22 use std::hash::Hash;
  23 use tracing::debug;
  24
  25 /// The `DefPathTable` maps `DefIndex`es to `DefKey`s and vice versa.
  26 /// Internally the `DefPathTable` holds a tree of `DefKey`s, where each `DefKey`
  27 /// stores the `DefIndex` of its parent.
  28 /// There is one `DefPathTable` for each crate.
  29 #[derive(Clone, Default)]
  30 pub struct DefPathTable {
  31     index_to_key: IndexVec<DefIndex, DefKey>,
  32     def_path_hashes: IndexVec<DefIndex, DefPathHash>,
  33     def_path_hash_to_index: UnhashMap<DefPathHash, DefIndex>,
  34 }
  35
  36 impl DefPathTable {
  37     fn allocate(&mut self, key: DefKey, def_path_hash: DefPathHash) -> DefIndex {
  38         let index = {
  39             let index = DefIndex::from(self.index_to_key.len());
  40             debug!("DefPathTable::insert() - {:?} <-> {:?}", key, index);
  41             self.index_to_key.push(key);
  42             index
  43         };
  44         self.def_path_hashes.push(def_path_hash);
  45         debug_assert!(self.def_path_hashes.len() == self.index_to_key.len());
  46
  47         // Check for hash collisions of DefPathHashes. These should be
  48         // exceedingly rare.
  49         if let Some(existing) = self.def_path_hash_to_index.insert(def_path_hash, index) {
  50             let def_path1 = DefPath::make(LOCAL_CRATE, existing, |idx| self.def_key(idx));
  51             let def_path2 = DefPath::make(LOCAL_CRATE, index, |idx| self.def_key(idx));
  52
  53             // Continuing with colliding DefPathHashes can lead to correctness
  54             // issues. We must abort compilation.
  55             //
  56             // The likelyhood of such a collision is very small, so actually
  57             // running into one could be indicative of a poor hash function
  58             // being used.
  59             //
  60             // See the documentation for DefPathHash for more information.
  61             panic!(
  62                 "found DefPathHash collsion between {:?} and {:?}. \
  63                     Compilation cannot continue.",
  64                 def_path1, def_path2
  65             );
  66         }
  67
  68         // Assert that all DefPathHashes correctly contain the local crate's
  69         // StableCrateId
  70         #[cfg(debug_assertions)]
  71         if let Some(root) = self.def_path_hashes.get(CRATE_DEF_INDEX) {
  72             assert!(def_path_hash.stable_crate_id() == root.stable_crate_id());
  73         }
  74
  75         index
  76     }
  77
  78     #[inline(always)]
  79     pub fn def_key(&self, index: DefIndex) -> DefKey {
  80         self.index_to_key[index]
  81     }
  82
  83     #[inline(always)]
  84     pub fn def_path_hash(&self, index: DefIndex) -> DefPathHash {
  85         let hash = self.def_path_hashes[index];
  86         debug!("def_path_hash({:?}) = {:?}", index, hash);
  87         hash
  88     }
  89
  90     pub fn enumerated_keys_and_path_hashes(
  91         &self,
  92     ) -> impl Iterator<Item = (DefIndex, &DefKey, &DefPathHash)> + '_ {
  93         self.index_to_key
  94             .iter_enumerated()
  95             .map(move |(index, key)| (index, key, &self.def_path_hashes[index]))
  96     }
  97
  98     pub fn all_def_path_hashes_and_def_ids(
  99         &self,
 100         krate: CrateNum,
 101     ) -> impl Iterator<Item = (DefPathHash, DefId)> + '_ {
 102         self.def_path_hashes
 103             .iter_enumerated()
 104             .map(move |(index, hash)| (*hash, DefId { krate, index }))
 105     }
 106 }
 107
 108 /// The definition table containing node definitions.
 109 /// It holds the `DefPathTable` for `LocalDefId`s/`DefPath`s.
 110 /// It also stores mappings to convert `LocalDefId`s to/from `HirId`s.
 111 #[derive(Clone)]
 112 pub struct Definitions {
 113     table: DefPathTable,
 114
 115     // FIXME(eddyb) ideally all `LocalDefId`s would be HIR owners.
 116     pub(super) def_id_to_hir_id: IndexVec<LocalDefId, Option<hir::HirId>>,
 117     /// The reverse mapping of `def_id_to_hir_id`.
 118     pub(super) hir_id_to_def_id: FxHashMap<hir::HirId, LocalDefId>,
 119
 120     /// If `ExpnId` is an ID of some macro expansion,
 121     /// then `DefId` is the normal module (`mod`) in which the expanded macro was defined.
 122     parent_modules_of_macro_defs: FxHashMap<ExpnId, DefId>,
 123     /// Item with a given `LocalDefId` was defined during macro expansion with ID `ExpnId`.
 124     expansions_that_defined: FxHashMap<LocalDefId, ExpnId>,
 125 }
 126
 127 /// A unique identifier that we can use to lookup a definition
 128 /// precisely. It combines the index of the definition's parent (if
 129 /// any) with a `DisambiguatedDefPathData`.
 130 #[derive(Copy, Clone, PartialEq, Debug, Encodable, Decodable)]
 131 pub struct DefKey {
 132     /// The parent path.
 133     pub parent: Option<DefIndex>,
 134
 135     /// The identifier of this node.
 136     pub disambiguated_data: DisambiguatedDefPathData,
 137 }
 138
 139 impl DefKey {
 140     pub(crate) fn compute_stable_hash(&self, parent: DefPathHash) -> DefPathHash {
 141         let mut hasher = StableHasher::new();
 142
 143         parent.hash(&mut hasher);
 144
 145         let DisambiguatedDefPathData { ref data, disambiguator } = self.disambiguated_data;
 146
 147         std::mem::discriminant(data).hash(&mut hasher);
 148         if let Some(name) = data.get_opt_name() {
 149             // Get a stable hash by considering the symbol chars rather than
 150             // the symbol index.
 151             name.as_str().hash(&mut hasher);
 152         }
 153
 154         disambiguator.hash(&mut hasher);
 155
 156         let local_hash: u64 = hasher.finish();
 157
 158         // Construct the new DefPathHash, making sure that the `crate_id`
 159         // portion of the hash is properly copied from the parent. This way the
 160         // `crate_id` part will be recursively propagated from the root to all
 161         // DefPathHashes in this DefPathTable.
 162         DefPathHash::new(parent.stable_crate_id(), local_hash)
 163     }
 164 }
 165
 166 /// A pair of `DefPathData` and an integer disambiguator. The integer is
 167 /// normally `0`, but in the event that there are multiple defs with the
 168 /// same `parent` and `data`, we use this field to disambiguate
 169 /// between them. This introduces some artificial ordering dependency
 170 /// but means that if you have, e.g., two impls for the same type in
 171 /// the same module, they do get distinct `DefId`s.
 172 #[derive(Copy, Clone, PartialEq, Debug, Encodable, Decodable)]
 173 pub struct DisambiguatedDefPathData {
 174     pub data: DefPathData,
 175     pub disambiguator: u32,
 176 }
 177
 178 impl DisambiguatedDefPathData {
 179     pub fn fmt_maybe_verbose(&self, writer: &mut impl Write, verbose: bool) -> fmt::Result {
 180         match self.data.name() {
 181             DefPathDataName::Named(name) => {
 182                 if verbose && self.disambiguator != 0 {
 183                     write!(writer, "{}#{}", name, self.disambiguator)
 184                 } else {
 185                     writer.write_str(&name.as_str())
 186                 }
 187             }
 188             DefPathDataName::Anon { namespace } => {
 189                 write!(writer, "{{{}#{}}}", namespace, self.disambiguator)
 190             }
 191         }
 192     }
 193 }
 194
 195 impl fmt::Display for DisambiguatedDefPathData {
 196     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 197         self.fmt_maybe_verbose(f, true)
 198     }
 199 }
 200
 201 #[derive(Clone, Debug, Encodable, Decodable)]
 202 pub struct DefPath {
 203     /// The path leading from the crate root to the item.
 204     pub data: Vec<DisambiguatedDefPathData>,
 205
 206     /// The crate root this path is relative to.
 207     pub krate: CrateNum,
 208 }
 209
 210 impl DefPath {
 211     pub fn make<FN>(krate: CrateNum, start_index: DefIndex, mut get_key: FN) -> DefPath
 212     where
 213         FN: FnMut(DefIndex) -> DefKey,
 214     {
 215         let mut data = vec![];
 216         let mut index = Some(start_index);
 217         loop {
 218             debug!("DefPath::make: krate={:?} index={:?}", krate, index);
 219             let p = index.unwrap();
 220             let key = get_key(p);
 221             debug!("DefPath::make: key={:?}", key);
 222             match key.disambiguated_data.data {
 223                 DefPathData::CrateRoot => {
 224                     assert!(key.parent.is_none());
 225                     break;
 226                 }
 227                 _ => {
 228                     data.push(key.disambiguated_data);
 229                     index = key.parent;
 230                 }
 231             }
 232         }
 233         data.reverse();
 234         DefPath { data, krate }
 235     }
 236
 237     /// Returns a string representation of the `DefPath` without
 238     /// the crate-prefix. This method is useful if you don't have
 239     /// a `TyCtxt` available.
 240     pub fn to_string_no_crate_verbose(&self) -> String {
 241         let mut s = String::with_capacity(self.data.len() * 16);
 242
 243         for component in &self.data {
 244             write!(s, "::{}", component).unwrap();
 245         }
 246
 247         s
 248     }
 249
 250     /// Returns a filename-friendly string of the `DefPath`, without
 251     /// the crate-prefix. This method is useful if you don't have
 252     /// a `TyCtxt` available.
 253     pub fn to_filename_friendly_no_crate(&self) -> String {
 254         let mut s = String::with_capacity(self.data.len() * 16);
 255
 256         let mut opt_delimiter = None;
 257         for component in &self.data {
 258             s.extend(opt_delimiter);
 259             opt_delimiter = Some('-');
 260             write!(s, "{}", component).unwrap();
 261         }
 262
 263         s
 264     }
 265 }
 266
 267 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Encodable, Decodable)]
 268 pub enum DefPathData {
 269     // Root: these should only be used for the root nodes, because
 270     // they are treated specially by the `def_path` function.
 271     /// The crate root (marker).
 272     CrateRoot,
 273     // Catch-all for random `DefId` things like `DUMMY_NODE_ID`.
 274     Misc,
 275
 276     // Different kinds of items and item-like things:
 277     /// An impl.
 278     Impl,
 279     /// Something in the type namespace.
 280     TypeNs(Symbol),
 281     /// Something in the value namespace.
 282     ValueNs(Symbol),
 283     /// Something in the macro namespace.
 284     MacroNs(Symbol),
 285     /// Something in the lifetime namespace.
 286     LifetimeNs(Symbol),
 287     /// A closure expression.
 288     ClosureExpr,
 289
 290     // Subportions of items:
 291     /// Implicit constructor for a unit or tuple-like struct or enum variant.
 292     Ctor,
 293     /// A constant expression (see `{ast,hir}::AnonConst`).
 294     AnonConst,
 295     /// An `impl Trait` type node.
 296     ImplTrait,
 297 }
 298
 299 impl Definitions {
 300     pub fn def_path_table(&self) -> &DefPathTable {
 301         &self.table
 302     }
 303
 304     /// Gets the number of definitions.
 305     pub fn def_index_count(&self) -> usize {
 306         self.table.index_to_key.len()
 307     }
 308
 309     pub fn def_key(&self, id: LocalDefId) -> DefKey {
 310         self.table.def_key(id.local_def_index)
 311     }
 312
 313     #[inline(always)]
 314     pub fn def_path_hash(&self, id: LocalDefId) -> DefPathHash {
 315         self.table.def_path_hash(id.local_def_index)
 316     }
 317
 318     /// Returns the path from the crate root to `index`. The root
 319     /// nodes are not included in the path (i.e., this will be an
 320     /// empty vector for the crate root). For an inlined item, this
 321     /// will be the path of the item in the external crate (but the
 322     /// path will begin with the path to the external crate).
 323     pub fn def_path(&self, id: LocalDefId) -> DefPath {
 324         DefPath::make(LOCAL_CRATE, id.local_def_index, |index| {
 325             self.def_key(LocalDefId { local_def_index: index })
 326         })
 327     }
 328
 329     #[inline]
 330     #[track_caller]
 331     pub fn local_def_id_to_hir_id(&self, id: LocalDefId) -> hir::HirId {
 332         self.def_id_to_hir_id[id].unwrap()
 333     }
 334
 335     #[inline]
 336     pub fn opt_hir_id_to_local_def_id(&self, hir_id: hir::HirId) -> Option<LocalDefId> {
 337         self.hir_id_to_def_id.get(&hir_id).copied()
 338     }
 339
 340     /// Adds a root definition (no parent) and a few other reserved definitions.
 341     pub fn new(crate_name: &str, crate_disambiguator: CrateDisambiguator) -> Definitions {
 342         let key = DefKey {
 343             parent: None,
 344             disambiguated_data: DisambiguatedDefPathData {
 345                 data: DefPathData::CrateRoot,
 346                 disambiguator: 0,
 347             },
 348         };
 349
 350         let stable_crate_id = StableCrateId::new(crate_name, crate_disambiguator);
 351         let parent_hash = DefPathHash::new(stable_crate_id, 0);
 352         let def_path_hash = key.compute_stable_hash(parent_hash);
 353
 354         // Create the root definition.
 355         let mut table = DefPathTable::default();
 356         let root = LocalDefId { local_def_index: table.allocate(key, def_path_hash) };
 357         assert_eq!(root.local_def_index, CRATE_DEF_INDEX);
 358
 359         Definitions {
 360             table,
 361             def_id_to_hir_id: Default::default(),
 362             hir_id_to_def_id: Default::default(),
 363             expansions_that_defined: Default::default(),
 364             parent_modules_of_macro_defs: Default::default(),
 365         }
 366     }
 367
 368     /// Retrieves the root definition.
 369     pub fn get_root_def(&self) -> LocalDefId {
 370         LocalDefId { local_def_index: CRATE_DEF_INDEX }
 371     }
 372
 373     /// Adds a definition with a parent definition.
 374     pub fn create_def(
 375         &mut self,
 376         parent: LocalDefId,
 377         data: DefPathData,
 378         expn_id: ExpnId,
 379         mut next_disambiguator: impl FnMut(LocalDefId, DefPathData) -> u32,
 380     ) -> LocalDefId {
 381         debug!("create_def(parent={:?}, data={:?}, expn_id={:?})", parent, data, expn_id);
 382
 383         // The root node must be created with `create_root_def()`.
 384         assert!(data != DefPathData::CrateRoot);
 385
 386         let disambiguator = next_disambiguator(parent, data);
 387         let key = DefKey {
 388             parent: Some(parent.local_def_index),
 389             disambiguated_data: DisambiguatedDefPathData { data, disambiguator },
 390         };
 391
 392         let parent_hash = self.table.def_path_hash(parent.local_def_index);
 393         let def_path_hash = key.compute_stable_hash(parent_hash);
 394
 395         debug!("create_def: after disambiguation, key = {:?}", key);
 396
 397         // Create the definition.
 398         let def_id = LocalDefId { local_def_index: self.table.allocate(key, def_path_hash) };
 399
 400         if expn_id != ExpnId::root() {
 401             self.expansions_that_defined.insert(def_id, expn_id);
 402         }
 403
 404         def_id
 405     }
 406
 407     /// Initializes the `LocalDefId` to `HirId` mapping once it has been generated during
 408     /// AST to HIR lowering.
 409     pub fn init_def_id_to_hir_id_mapping(
 410         &mut self,
 411         mapping: IndexVec<LocalDefId, Option<hir::HirId>>,
 412     ) {
 413         assert!(
 414             self.def_id_to_hir_id.is_empty(),
 415             "trying to initialize `LocalDefId` <-> `HirId` mappings twice"
 416         );
 417
 418         // Build the reverse mapping of `def_id_to_hir_id`.
 419         self.hir_id_to_def_id = mapping
 420             .iter_enumerated()
 421             .filter_map(|(def_id, hir_id)| hir_id.map(|hir_id| (hir_id, def_id)))
 422             .collect();
 423
 424         self.def_id_to_hir_id = mapping;
 425     }
 426
 427     pub fn expansion_that_defined(&self, id: LocalDefId) -> ExpnId {
 428         self.expansions_that_defined.get(&id).copied().unwrap_or_else(ExpnId::root)
 429     }
 430
 431     pub fn parent_module_of_macro_def(&self, expn_id: ExpnId) -> DefId {
 432         self.parent_modules_of_macro_defs[&expn_id]
 433     }
 434
 435     pub fn add_parent_module_of_macro_def(&mut self, expn_id: ExpnId, module: DefId) {
 436         self.parent_modules_of_macro_defs.insert(expn_id, module);
 437     }
 438
 439     pub fn iter_local_def_id(&self) -> impl Iterator<Item = LocalDefId> + '_ {
 440         self.def_id_to_hir_id.iter_enumerated().map(|(k, _)| k)
 441     }
 442 }
 443
 444 #[derive(Copy, Clone, PartialEq, Debug)]
 445 pub enum DefPathDataName {
 446     Named(Symbol),
 447     Anon { namespace: Symbol },
 448 }
 449
 450 impl DefPathData {
 451     pub fn get_opt_name(&self) -> Option<Symbol> {
 452         use self::DefPathData::*;
 453         match *self {
 454             TypeNs(name) | ValueNs(name) | MacroNs(name) | LifetimeNs(name) => Some(name),
 455
 456             Impl | CrateRoot | Misc | ClosureExpr | Ctor | AnonConst | ImplTrait => None,
 457         }
 458     }
 459
 460     pub fn name(&self) -> DefPathDataName {
 461         use self::DefPathData::*;
 462         match *self {
 463             TypeNs(name) | ValueNs(name) | MacroNs(name) | LifetimeNs(name) => {
 464                 DefPathDataName::Named(name)
 465             }
 466             // Note that this does not show up in user print-outs.
 467             CrateRoot => DefPathDataName::Anon { namespace: kw::Crate },
 468             Impl => DefPathDataName::Anon { namespace: kw::Impl },
 469             Misc => DefPathDataName::Anon { namespace: sym::misc },
 470             ClosureExpr => DefPathDataName::Anon { namespace: sym::closure },
 471             Ctor => DefPathDataName::Anon { namespace: sym::constructor },
 472             AnonConst => DefPathDataName::Anon { namespace: sym::constant },
 473             ImplTrait => DefPathDataName::Anon { namespace: sym::opaque },
 474         }
 475     }
 476 }
 477
 478 impl fmt::Display for DefPathData {
 479     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 480         match self.name() {
 481             DefPathDataName::Named(name) => f.write_str(&name.as_str()),
 482             // FIXME(#70334): this will generate legacy {{closure}}, {{impl}}, etc
 483             DefPathDataName::Anon { namespace } => write!(f, "{{{{{}}}}}", namespace),
 484         }
 485     }
 486 }