compiler/rustc_middle/src/hir/map/mod.rs

   1 use self::collector::NodeCollector;
   2
   3 use crate::hir::{AttributeMap, IndexedHir, ModuleItems, Owner};
   4 use crate::ty::TyCtxt;
   5 use rustc_ast as ast;
   6 use rustc_data_structures::fingerprint::Fingerprint;
   7 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
   8 use rustc_data_structures::svh::Svh;
   9 use rustc_data_structures::sync::{par_for_each_in, Send, Sync};
  10 use rustc_hir::def::{DefKind, Res};
  11 use rustc_hir::def_id::{CrateNum, DefId, LocalDefId, CRATE_DEF_ID, LOCAL_CRATE};
  12 use rustc_hir::definitions::{DefKey, DefPath, DefPathHash};
  13 use rustc_hir::intravisit::{self, Visitor};
  14 use rustc_hir::itemlikevisit::ItemLikeVisitor;
  15 use rustc_hir::*;
  16 use rustc_index::vec::Idx;
  17 use rustc_span::def_id::StableCrateId;
  18 use rustc_span::hygiene::MacroKind;
  19 use rustc_span::source_map::Spanned;
  20 use rustc_span::symbol::{kw, sym, Ident, Symbol};
  21 use rustc_span::Span;
  22 use rustc_target::spec::abi::Abi;
  23 use std::collections::VecDeque;
  24
  25 pub mod blocks;
  26 mod collector;
  27
  28 fn fn_decl<'hir>(node: Node<'hir>) -> Option<&'hir FnDecl<'hir>> {
  29     match node {
  30         Node::Item(Item { kind: ItemKind::Fn(sig, _, _), .. })
  31         | Node::TraitItem(TraitItem { kind: TraitItemKind::Fn(sig, _), .. })
  32         | Node::ImplItem(ImplItem { kind: ImplItemKind::Fn(sig, _), .. }) => Some(&sig.decl),
  33         Node::Expr(Expr { kind: ExprKind::Closure(_, fn_decl, ..), .. })
  34         | Node::ForeignItem(ForeignItem { kind: ForeignItemKind::Fn(fn_decl, ..), .. }) => {
  35             Some(fn_decl)
  36         }
  37         _ => None,
  38     }
  39 }
  40
  41 pub fn fn_sig<'hir>(node: Node<'hir>) -> Option<&'hir FnSig<'hir>> {
  42     match &node {
  43         Node::Item(Item { kind: ItemKind::Fn(sig, _, _), .. })
  44         | Node::TraitItem(TraitItem { kind: TraitItemKind::Fn(sig, _), .. })
  45         | Node::ImplItem(ImplItem { kind: ImplItemKind::Fn(sig, _), .. }) => Some(sig),
  46         _ => None,
  47     }
  48 }
  49
  50 pub fn associated_body<'hir>(node: Node<'hir>) -> Option<BodyId> {
  51     match node {
  52         Node::Item(Item {
  53             kind: ItemKind::Const(_, body) | ItemKind::Static(.., body) | ItemKind::Fn(.., body),
  54             ..
  55         })
  56         | Node::TraitItem(TraitItem {
  57             kind:
  58                 TraitItemKind::Const(_, Some(body)) | TraitItemKind::Fn(_, TraitFn::Provided(body)),
  59             ..
  60         })
  61         | Node::ImplItem(ImplItem {
  62             kind: ImplItemKind::Const(_, body) | ImplItemKind::Fn(_, body),
  63             ..
  64         })
  65         | Node::Expr(Expr { kind: ExprKind::Closure(.., body, _, _), .. }) => Some(*body),
  66
  67         Node::AnonConst(constant) => Some(constant.body),
  68
  69         _ => None,
  70     }
  71 }
  72
  73 fn is_body_owner<'hir>(node: Node<'hir>, hir_id: HirId) -> bool {
  74     match associated_body(node) {
  75         Some(b) => b.hir_id == hir_id,
  76         None => false,
  77     }
  78 }
  79
  80 #[derive(Copy, Clone)]
  81 pub struct Map<'hir> {
  82     pub(super) tcx: TyCtxt<'hir>,
  83 }
  84
  85 /// An iterator that walks up the ancestor tree of a given `HirId`.
  86 /// Constructed using `tcx.hir().parent_iter(hir_id)`.
  87 pub struct ParentHirIterator<'hir> {
  88     current_id: HirId,
  89     map: Map<'hir>,
  90 }
  91
  92 impl<'hir> Iterator for ParentHirIterator<'hir> {
  93     type Item = (HirId, Node<'hir>);
  94
  95     fn next(&mut self) -> Option<Self::Item> {
  96         if self.current_id == CRATE_HIR_ID {
  97             return None;
  98         }
  99         loop {
 100             // There are nodes that do not have entries, so we need to skip them.
 101             let parent_id = self.map.get_parent_node(self.current_id);
 102
 103             if parent_id == self.current_id {
 104                 self.current_id = CRATE_HIR_ID;
 105                 return None;
 106             }
 107
 108             self.current_id = parent_id;
 109             if let Some(node) = self.map.find(parent_id) {
 110                 return Some((parent_id, node));
 111             }
 112             // If this `HirId` doesn't have an entry, skip it and look for its `parent_id`.
 113         }
 114     }
 115 }
 116
 117 /// An iterator that walks up the ancestor tree of a given `HirId`.
 118 /// Constructed using `tcx.hir().parent_owner_iter(hir_id)`.
 119 pub struct ParentOwnerIterator<'hir> {
 120     current_id: HirId,
 121     map: Map<'hir>,
 122 }
 123
 124 impl<'hir> Iterator for ParentOwnerIterator<'hir> {
 125     type Item = (HirId, OwnerNode<'hir>);
 126
 127     fn next(&mut self) -> Option<Self::Item> {
 128         if self.current_id.local_id.index() != 0 {
 129             self.current_id.local_id = ItemLocalId::new(0);
 130             if let Some(node) = self.map.tcx.hir_owner(self.current_id.owner) {
 131                 return Some((self.current_id, node.node));
 132             }
 133         }
 134         if self.current_id == CRATE_HIR_ID {
 135             return None;
 136         }
 137         loop {
 138             // There are nodes that do not have entries, so we need to skip them.
 139             let parent_id = self.map.def_key(self.current_id.owner).parent;
 140
 141             let parent_id = parent_id.map_or(CRATE_HIR_ID.owner, |local_def_index| {
 142                 let def_id = LocalDefId { local_def_index };
 143                 self.map.local_def_id_to_hir_id(def_id).owner
 144             });
 145             self.current_id = HirId::make_owner(parent_id);
 146
 147             // If this `HirId` doesn't have an entry, skip it and look for its `parent_id`.
 148             if let Some(node) = self.map.tcx.hir_owner(self.current_id.owner) {
 149                 return Some((self.current_id, node.node));
 150             }
 151         }
 152     }
 153 }
 154
 155 impl<'hir> Map<'hir> {
 156     pub fn krate(&self) -> &'hir Crate<'hir> {
 157         self.tcx.hir_crate(())
 158     }
 159
 160     pub fn root_module(&self) -> &'hir Mod<'hir> {
 161         match self.tcx.hir_owner(CRATE_DEF_ID).map(|o| o.node) {
 162             Some(OwnerNode::Crate(item)) => item,
 163             _ => panic!(),
 164         }
 165     }
 166
 167     crate fn items(&self) -> impl Iterator<Item = &'hir Item<'hir>> + 'hir {
 168         let krate = self.krate();
 169         krate.owners.iter().filter_map(|owner| match owner.as_ref()? {
 170             OwnerNode::Item(item) => Some(*item),
 171             _ => None,
 172         })
 173     }
 174
 175     pub fn def_key(&self, def_id: LocalDefId) -> DefKey {
 176         // Accessing the DefKey is ok, since it is part of DefPathHash.
 177         self.tcx.untracked_resolutions.definitions.def_key(def_id)
 178     }
 179
 180     pub fn def_path_from_hir_id(&self, id: HirId) -> Option<DefPath> {
 181         self.opt_local_def_id(id).map(|def_id| self.def_path(def_id))
 182     }
 183
 184     pub fn def_path(&self, def_id: LocalDefId) -> DefPath {
 185         // Accessing the DefPath is ok, since it is part of DefPathHash.
 186         self.tcx.untracked_resolutions.definitions.def_path(def_id)
 187     }
 188
 189     #[inline]
 190     pub fn def_path_hash(self, def_id: LocalDefId) -> DefPathHash {
 191         // Accessing the DefPathHash is ok, it is incr. comp. stable.
 192         self.tcx.untracked_resolutions.definitions.def_path_hash(def_id)
 193     }
 194
 195     #[inline]
 196     pub fn local_def_id(&self, hir_id: HirId) -> LocalDefId {
 197         self.opt_local_def_id(hir_id).unwrap_or_else(|| {
 198             bug!(
 199                 "local_def_id: no entry for `{:?}`, which has a map of `{:?}`",
 200                 hir_id,
 201                 self.find(hir_id)
 202             )
 203         })
 204     }
 205
 206     #[inline]
 207     pub fn opt_local_def_id(&self, hir_id: HirId) -> Option<LocalDefId> {
 208         // FIXME(#85914) is this access safe for incr. comp.?
 209         self.tcx.untracked_resolutions.definitions.opt_hir_id_to_local_def_id(hir_id)
 210     }
 211
 212     #[inline]
 213     pub fn local_def_id_to_hir_id(&self, def_id: LocalDefId) -> HirId {
 214         // FIXME(#85914) is this access safe for incr. comp.?
 215         self.tcx.untracked_resolutions.definitions.local_def_id_to_hir_id(def_id)
 216     }
 217
 218     pub fn iter_local_def_id(&self) -> impl Iterator<Item = LocalDefId> + '_ {
 219         // Create a dependency to the crate to be sure we reexcute this when the amount of
 220         // definitions change.
 221         self.tcx.ensure().hir_crate(());
 222         self.tcx.untracked_resolutions.definitions.iter_local_def_id()
 223     }
 224
 225     pub fn opt_def_kind(&self, local_def_id: LocalDefId) -> Option<DefKind> {
 226         let hir_id = self.local_def_id_to_hir_id(local_def_id);
 227         let def_kind = match self.find(hir_id)? {
 228             Node::Item(item) => match item.kind {
 229                 ItemKind::Static(..) => DefKind::Static,
 230                 ItemKind::Const(..) => DefKind::Const,
 231                 ItemKind::Fn(..) => DefKind::Fn,
 232                 ItemKind::Macro(..) => DefKind::Macro(MacroKind::Bang),
 233                 ItemKind::Mod(..) => DefKind::Mod,
 234                 ItemKind::OpaqueTy(..) => DefKind::OpaqueTy,
 235                 ItemKind::TyAlias(..) => DefKind::TyAlias,
 236                 ItemKind::Enum(..) => DefKind::Enum,
 237                 ItemKind::Struct(..) => DefKind::Struct,
 238                 ItemKind::Union(..) => DefKind::Union,
 239                 ItemKind::Trait(..) => DefKind::Trait,
 240                 ItemKind::TraitAlias(..) => DefKind::TraitAlias,
 241                 ItemKind::ExternCrate(_) => DefKind::ExternCrate,
 242                 ItemKind::Use(..) => DefKind::Use,
 243                 ItemKind::ForeignMod { .. } => DefKind::ForeignMod,
 244                 ItemKind::GlobalAsm(..) => DefKind::GlobalAsm,
 245                 ItemKind::Impl { .. } => DefKind::Impl,
 246             },
 247             Node::ForeignItem(item) => match item.kind {
 248                 ForeignItemKind::Fn(..) => DefKind::Fn,
 249                 ForeignItemKind::Static(..) => DefKind::Static,
 250                 ForeignItemKind::Type => DefKind::ForeignTy,
 251             },
 252             Node::TraitItem(item) => match item.kind {
 253                 TraitItemKind::Const(..) => DefKind::AssocConst,
 254                 TraitItemKind::Fn(..) => DefKind::AssocFn,
 255                 TraitItemKind::Type(..) => DefKind::AssocTy,
 256             },
 257             Node::ImplItem(item) => match item.kind {
 258                 ImplItemKind::Const(..) => DefKind::AssocConst,
 259                 ImplItemKind::Fn(..) => DefKind::AssocFn,
 260                 ImplItemKind::TyAlias(..) => DefKind::AssocTy,
 261             },
 262             Node::Variant(_) => DefKind::Variant,
 263             Node::Ctor(variant_data) => {
 264                 // FIXME(eddyb) is this even possible, if we have a `Node::Ctor`?
 265                 assert_ne!(variant_data.ctor_hir_id(), None);
 266
 267                 let ctor_of = match self.find(self.get_parent_node(hir_id)) {
 268                     Some(Node::Item(..)) => def::CtorOf::Struct,
 269                     Some(Node::Variant(..)) => def::CtorOf::Variant,
 270                     _ => unreachable!(),
 271                 };
 272                 DefKind::Ctor(ctor_of, def::CtorKind::from_hir(variant_data))
 273             }
 274             Node::AnonConst(_) => DefKind::AnonConst,
 275             Node::Field(_) => DefKind::Field,
 276             Node::Expr(expr) => match expr.kind {
 277                 ExprKind::Closure(.., None) => DefKind::Closure,
 278                 ExprKind::Closure(.., Some(_)) => DefKind::Generator,
 279                 _ => bug!("def_kind: unsupported node: {}", self.node_to_string(hir_id)),
 280             },
 281             Node::GenericParam(param) => match param.kind {
 282                 GenericParamKind::Lifetime { .. } => DefKind::LifetimeParam,
 283                 GenericParamKind::Type { .. } => DefKind::TyParam,
 284                 GenericParamKind::Const { .. } => DefKind::ConstParam,
 285             },
 286             Node::Crate(_) => DefKind::Mod,
 287             Node::Stmt(_)
 288             | Node::PathSegment(_)
 289             | Node::Ty(_)
 290             | Node::Infer(_)
 291             | Node::TraitRef(_)
 292             | Node::Pat(_)
 293             | Node::Binding(_)
 294             | Node::Local(_)
 295             | Node::Param(_)
 296             | Node::Arm(_)
 297             | Node::Lifetime(_)
 298             | Node::Visibility(_)
 299             | Node::Block(_) => return None,
 300         };
 301         Some(def_kind)
 302     }
 303
 304     pub fn def_kind(&self, local_def_id: LocalDefId) -> DefKind {
 305         self.opt_def_kind(local_def_id)
 306             .unwrap_or_else(|| bug!("def_kind: unsupported node: {:?}", local_def_id))
 307     }
 308
 309     pub fn find_parent_node(&self, id: HirId) -> Option<HirId> {
 310         if id.local_id == ItemLocalId::from_u32(0) {
 311             Some(self.tcx.hir_owner_parent(id.owner))
 312         } else {
 313             let owner = self.tcx.hir_owner_nodes(id.owner)?;
 314             let node = owner.nodes[id.local_id].as_ref()?;
 315             let hir_id = HirId { owner: id.owner, local_id: node.parent };
 316             Some(hir_id)
 317         }
 318     }
 319
 320     pub fn get_parent_node(&self, hir_id: HirId) -> HirId {
 321         self.find_parent_node(hir_id).unwrap_or(CRATE_HIR_ID)
 322     }
 323
 324     /// Retrieves the `Node` corresponding to `id`, returning `None` if cannot be found.
 325     pub fn find(&self, id: HirId) -> Option<Node<'hir>> {
 326         if id.local_id == ItemLocalId::from_u32(0) {
 327             let owner = self.tcx.hir_owner(id.owner)?;
 328             Some(owner.node.into())
 329         } else {
 330             let owner = self.tcx.hir_owner_nodes(id.owner)?;
 331             let node = owner.nodes[id.local_id].as_ref()?;
 332             Some(node.node)
 333         }
 334     }
 335
 336     /// Retrieves the `Node` corresponding to `id`, panicking if it cannot be found.
 337     pub fn get(&self, id: HirId) -> Node<'hir> {
 338         self.find(id).unwrap_or_else(|| bug!("couldn't find hir id {} in the HIR map", id))
 339     }
 340
 341     pub fn get_if_local(&self, id: DefId) -> Option<Node<'hir>> {
 342         id.as_local().and_then(|id| self.find(self.local_def_id_to_hir_id(id)))
 343     }
 344
 345     pub fn get_generics(&self, id: DefId) -> Option<&'hir Generics<'hir>> {
 346         let id = id.as_local()?;
 347         let node = self.tcx.hir_owner(id)?;
 348         match node.node {
 349             OwnerNode::ImplItem(impl_item) => Some(&impl_item.generics),
 350             OwnerNode::TraitItem(trait_item) => Some(&trait_item.generics),
 351             OwnerNode::Item(Item {
 352                 kind:
 353                     ItemKind::Fn(_, generics, _)
 354                     | ItemKind::TyAlias(_, generics)
 355                     | ItemKind::Enum(_, generics)
 356                     | ItemKind::Struct(_, generics)
 357                     | ItemKind::Union(_, generics)
 358                     | ItemKind::Trait(_, _, generics, ..)
 359                     | ItemKind::TraitAlias(generics, _)
 360                     | ItemKind::Impl(Impl { generics, .. }),
 361                 ..
 362             }) => Some(generics),
 363             _ => None,
 364         }
 365     }
 366
 367     pub fn item(&self, id: ItemId) -> &'hir Item<'hir> {
 368         self.tcx.hir_owner(id.def_id).unwrap().node.expect_item()
 369     }
 370
 371     pub fn trait_item(&self, id: TraitItemId) -> &'hir TraitItem<'hir> {
 372         self.tcx.hir_owner(id.def_id).unwrap().node.expect_trait_item()
 373     }
 374
 375     pub fn impl_item(&self, id: ImplItemId) -> &'hir ImplItem<'hir> {
 376         self.tcx.hir_owner(id.def_id).unwrap().node.expect_impl_item()
 377     }
 378
 379     pub fn foreign_item(&self, id: ForeignItemId) -> &'hir ForeignItem<'hir> {
 380         self.tcx.hir_owner(id.def_id).unwrap().node.expect_foreign_item()
 381     }
 382
 383     pub fn body(&self, id: BodyId) -> &'hir Body<'hir> {
 384         self.tcx.hir_owner_nodes(id.hir_id.owner).unwrap().bodies.get(&id.hir_id.local_id).unwrap()
 385     }
 386
 387     pub fn fn_decl_by_hir_id(&self, hir_id: HirId) -> Option<&'hir FnDecl<'hir>> {
 388         if let Some(node) = self.find(hir_id) {
 389             fn_decl(node)
 390         } else {
 391             bug!("no node for hir_id `{}`", hir_id)
 392         }
 393     }
 394
 395     pub fn fn_sig_by_hir_id(&self, hir_id: HirId) -> Option<&'hir FnSig<'hir>> {
 396         if let Some(node) = self.find(hir_id) {
 397             fn_sig(node)
 398         } else {
 399             bug!("no node for hir_id `{}`", hir_id)
 400         }
 401     }
 402
 403     pub fn enclosing_body_owner(&self, hir_id: HirId) -> HirId {
 404         for (parent, _) in self.parent_iter(hir_id) {
 405             if let Some(body) = self.maybe_body_owned_by(parent) {
 406                 return self.body_owner(body);
 407             }
 408         }
 409
 410         bug!("no `enclosing_body_owner` for hir_id `{}`", hir_id);
 411     }
 412
 413     /// Returns the `HirId` that corresponds to the definition of
 414     /// which this is the body of, i.e., a `fn`, `const` or `static`
 415     /// item (possibly associated), a closure, or a `hir::AnonConst`.
 416     pub fn body_owner(&self, BodyId { hir_id }: BodyId) -> HirId {
 417         let parent = self.get_parent_node(hir_id);
 418         assert!(self.find(parent).map_or(false, |n| is_body_owner(n, hir_id)));
 419         parent
 420     }
 421
 422     pub fn body_owner_def_id(&self, id: BodyId) -> LocalDefId {
 423         self.local_def_id(self.body_owner(id))
 424     }
 425
 426     /// Given a `HirId`, returns the `BodyId` associated with it,
 427     /// if the node is a body owner, otherwise returns `None`.
 428     pub fn maybe_body_owned_by(&self, hir_id: HirId) -> Option<BodyId> {
 429         self.find(hir_id).map(associated_body).flatten()
 430     }
 431
 432     /// Given a body owner's id, returns the `BodyId` associated with it.
 433     pub fn body_owned_by(&self, id: HirId) -> BodyId {
 434         self.maybe_body_owned_by(id).unwrap_or_else(|| {
 435             span_bug!(
 436                 self.span(id),
 437                 "body_owned_by: {} has no associated body",
 438                 self.node_to_string(id)
 439             );
 440         })
 441     }
 442
 443     pub fn body_param_names(&self, id: BodyId) -> impl Iterator<Item = Ident> + 'hir {
 444         self.body(id).params.iter().map(|arg| match arg.pat.kind {
 445             PatKind::Binding(_, _, ident, _) => ident,
 446             _ => Ident::new(kw::Empty, rustc_span::DUMMY_SP),
 447         })
 448     }
 449
 450     /// Returns the `BodyOwnerKind` of this `LocalDefId`.
 451     ///
 452     /// Panics if `LocalDefId` does not have an associated body.
 453     pub fn body_owner_kind(&self, id: HirId) -> BodyOwnerKind {
 454         match self.get(id) {
 455             Node::Item(&Item { kind: ItemKind::Const(..), .. })
 456             | Node::TraitItem(&TraitItem { kind: TraitItemKind::Const(..), .. })
 457             | Node::ImplItem(&ImplItem { kind: ImplItemKind::Const(..), .. })
 458             | Node::AnonConst(_) => BodyOwnerKind::Const,
 459             Node::Ctor(..)
 460             | Node::Item(&Item { kind: ItemKind::Fn(..), .. })
 461             | Node::TraitItem(&TraitItem { kind: TraitItemKind::Fn(..), .. })
 462             | Node::ImplItem(&ImplItem { kind: ImplItemKind::Fn(..), .. }) => BodyOwnerKind::Fn,
 463             Node::Item(&Item { kind: ItemKind::Static(_, m, _), .. }) => BodyOwnerKind::Static(m),
 464             Node::Expr(&Expr { kind: ExprKind::Closure(..), .. }) => BodyOwnerKind::Closure,
 465             node => bug!("{:#?} is not a body node", node),
 466         }
 467     }
 468
 469     /// Returns the `ConstContext` of the body associated with this `LocalDefId`.
 470     ///
 471     /// Panics if `LocalDefId` does not have an associated body.
 472     ///
 473     /// This should only be used for determining the context of a body, a return
 474     /// value of `Some` does not always suggest that the owner of the body is `const`.
 475     pub fn body_const_context(&self, did: LocalDefId) -> Option<ConstContext> {
 476         let hir_id = self.local_def_id_to_hir_id(did);
 477         let ccx = match self.body_owner_kind(hir_id) {
 478             BodyOwnerKind::Const => ConstContext::Const,
 479             BodyOwnerKind::Static(mt) => ConstContext::Static(mt),
 480
 481             BodyOwnerKind::Fn if self.tcx.is_constructor(did.to_def_id()) => return None,
 482             BodyOwnerKind::Fn if self.tcx.is_const_fn_raw(did.to_def_id()) => ConstContext::ConstFn,
 483             BodyOwnerKind::Fn
 484                 if self.tcx.has_attr(did.to_def_id(), sym::default_method_body_is_const) =>
 485             {
 486                 ConstContext::ConstFn
 487             }
 488             BodyOwnerKind::Fn | BodyOwnerKind::Closure => return None,
 489         };
 490
 491         Some(ccx)
 492     }
 493
 494     pub fn ty_param_owner(&self, id: HirId) -> HirId {
 495         match self.get(id) {
 496             Node::Item(&Item { kind: ItemKind::Trait(..) | ItemKind::TraitAlias(..), .. }) => id,
 497             Node::GenericParam(_) => self.get_parent_node(id),
 498             _ => bug!("ty_param_owner: {} not a type parameter", self.node_to_string(id)),
 499         }
 500     }
 501
 502     pub fn ty_param_name(&self, id: HirId) -> Symbol {
 503         match self.get(id) {
 504             Node::Item(&Item { kind: ItemKind::Trait(..) | ItemKind::TraitAlias(..), .. }) => {
 505                 kw::SelfUpper
 506             }
 507             Node::GenericParam(param) => param.name.ident().name,
 508             _ => bug!("ty_param_name: {} not a type parameter", self.node_to_string(id)),
 509         }
 510     }
 511
 512     pub fn trait_impls(&self, trait_did: DefId) -> &'hir [LocalDefId] {
 513         self.tcx.all_local_trait_impls(()).get(&trait_did).map_or(&[], |xs| &xs[..])
 514     }
 515
 516     /// Gets the attributes on the crate. This is preferable to
 517     /// invoking `krate.attrs` because it registers a tighter
 518     /// dep-graph access.
 519     pub fn krate_attrs(&self) -> &'hir [ast::Attribute] {
 520         self.attrs(CRATE_HIR_ID)
 521     }
 522
 523     pub fn get_module(&self, module: LocalDefId) -> (&'hir Mod<'hir>, Span, HirId) {
 524         let hir_id = HirId::make_owner(module);
 525         match self.tcx.hir_owner(module).map(|o| o.node) {
 526             Some(OwnerNode::Item(&Item { span, kind: ItemKind::Mod(ref m), .. })) => {
 527                 (m, span, hir_id)
 528             }
 529             Some(OwnerNode::Crate(item)) => (item, item.inner, hir_id),
 530             node => panic!("not a module: {:?}", node),
 531         }
 532     }
 533
 534     /// Walks the contents of a crate. See also `Crate::visit_all_items`.
 535     pub fn walk_toplevel_module(self, visitor: &mut impl Visitor<'hir>) {
 536         let (top_mod, span, hir_id) = self.get_module(CRATE_DEF_ID);
 537         visitor.visit_mod(top_mod, span, hir_id);
 538     }
 539
 540     /// Walks the attributes in a crate.
 541     pub fn walk_attributes(self, visitor: &mut impl Visitor<'hir>) {
 542         let krate = self.krate();
 543         for (&id, attrs) in krate.attrs.iter() {
 544             for a in *attrs {
 545                 visitor.visit_attribute(id, a)
 546             }
 547         }
 548     }
 549
 550     /// Visits all items in the crate in some deterministic (but
 551     /// unspecified) order. If you just need to process every item,
 552     /// but don't care about nesting, this method is the best choice.
 553     ///
 554     /// If you do care about nesting -- usually because your algorithm
 555     /// follows lexical scoping rules -- then you want a different
 556     /// approach. You should override `visit_nested_item` in your
 557     /// visitor and then call `intravisit::walk_crate` instead.
 558     pub fn visit_all_item_likes<V>(&self, visitor: &mut V)
 559     where
 560         V: itemlikevisit::ItemLikeVisitor<'hir>,
 561     {
 562         let krate = self.krate();
 563         for owner in krate.owners.iter().filter_map(Option::as_ref) {
 564             match owner {
 565                 OwnerNode::Item(item) => visitor.visit_item(item),
 566                 OwnerNode::ForeignItem(item) => visitor.visit_foreign_item(item),
 567                 OwnerNode::ImplItem(item) => visitor.visit_impl_item(item),
 568                 OwnerNode::TraitItem(item) => visitor.visit_trait_item(item),
 569                 OwnerNode::Crate(_) => {}
 570             }
 571         }
 572     }
 573
 574     /// A parallel version of `visit_all_item_likes`.
 575     pub fn par_visit_all_item_likes<V>(&self, visitor: &V)
 576     where
 577         V: itemlikevisit::ParItemLikeVisitor<'hir> + Sync + Send,
 578     {
 579         let krate = self.krate();
 580         par_for_each_in(&krate.owners.raw, |owner| match owner.as_ref() {
 581             Some(OwnerNode::Item(item)) => visitor.visit_item(item),
 582             Some(OwnerNode::ForeignItem(item)) => visitor.visit_foreign_item(item),
 583             Some(OwnerNode::ImplItem(item)) => visitor.visit_impl_item(item),
 584             Some(OwnerNode::TraitItem(item)) => visitor.visit_trait_item(item),
 585             Some(OwnerNode::Crate(_)) | None => {}
 586         })
 587     }
 588
 589     pub fn visit_item_likes_in_module<V>(&self, module: LocalDefId, visitor: &mut V)
 590     where
 591         V: ItemLikeVisitor<'hir>,
 592     {
 593         let module = self.tcx.hir_module_items(module);
 594
 595         for id in module.items.iter() {
 596             visitor.visit_item(self.item(*id));
 597         }
 598
 599         for id in module.trait_items.iter() {
 600             visitor.visit_trait_item(self.trait_item(*id));
 601         }
 602
 603         for id in module.impl_items.iter() {
 604             visitor.visit_impl_item(self.impl_item(*id));
 605         }
 606
 607         for id in module.foreign_items.iter() {
 608             visitor.visit_foreign_item(self.foreign_item(*id));
 609         }
 610     }
 611
 612     pub fn for_each_module(&self, f: impl Fn(LocalDefId)) {
 613         let mut queue = VecDeque::new();
 614         queue.push_back(CRATE_DEF_ID);
 615
 616         while let Some(id) = queue.pop_front() {
 617             f(id);
 618             let items = self.tcx.hir_module_items(id);
 619             queue.extend(items.submodules.iter().copied())
 620         }
 621     }
 622
 623     #[cfg(not(parallel_compiler))]
 624     #[inline]
 625     pub fn par_for_each_module(&self, f: impl Fn(LocalDefId)) {
 626         self.for_each_module(f)
 627     }
 628
 629     #[cfg(parallel_compiler)]
 630     pub fn par_for_each_module(&self, f: impl Fn(LocalDefId) + Sync) {
 631         use rustc_data_structures::sync::{par_iter, ParallelIterator};
 632         par_iter_submodules(self.tcx, CRATE_DEF_ID, &f);
 633
 634         fn par_iter_submodules<F>(tcx: TyCtxt<'_>, module: LocalDefId, f: &F)
 635         where
 636             F: Fn(LocalDefId) + Sync,
 637         {
 638             (*f)(module);
 639             let items = tcx.hir_module_items(module);
 640             par_iter(&items.submodules[..]).for_each(|&sm| par_iter_submodules(tcx, sm, f));
 641         }
 642     }
 643
 644     /// Returns an iterator for the nodes in the ancestor tree of the `current_id`
 645     /// until the crate root is reached. Prefer this over your own loop using `get_parent_node`.
 646     pub fn parent_iter(self, current_id: HirId) -> ParentHirIterator<'hir> {
 647         ParentHirIterator { current_id, map: self }
 648     }
 649
 650     /// Returns an iterator for the nodes in the ancestor tree of the `current_id`
 651     /// until the crate root is reached. Prefer this over your own loop using `get_parent_node`.
 652     pub fn parent_owner_iter(self, current_id: HirId) -> ParentOwnerIterator<'hir> {
 653         ParentOwnerIterator { current_id, map: self }
 654     }
 655
 656     /// Checks if the node is left-hand side of an assignment.
 657     pub fn is_lhs(&self, id: HirId) -> bool {
 658         match self.find(self.get_parent_node(id)) {
 659             Some(Node::Expr(expr)) => match expr.kind {
 660                 ExprKind::Assign(lhs, _rhs, _span) => lhs.hir_id == id,
 661                 _ => false,
 662             },
 663             _ => false,
 664         }
 665     }
 666
 667     /// Whether the expression pointed at by `hir_id` belongs to a `const` evaluation context.
 668     /// Used exclusively for diagnostics, to avoid suggestion function calls.
 669     pub fn is_inside_const_context(&self, hir_id: HirId) -> bool {
 670         self.body_const_context(self.local_def_id(self.enclosing_body_owner(hir_id))).is_some()
 671     }
 672
 673     /// Retrieves the `HirId` for `id`'s enclosing method, unless there's a
 674     /// `while` or `loop` before reaching it, as block tail returns are not
 675     /// available in them.
 676     ///
 677     /// ```
 678     /// fn foo(x: usize) -> bool {
 679     ///     if x == 1 {
 680     ///         true  // If `get_return_block` gets passed the `id` corresponding
 681     ///     } else {  // to this, it will return `foo`'s `HirId`.
 682     ///         false
 683     ///     }
 684     /// }
 685     /// ```
 686     ///
 687     /// ```
 688     /// fn foo(x: usize) -> bool {
 689     ///     loop {
 690     ///         true  // If `get_return_block` gets passed the `id` corresponding
 691     ///     }         // to this, it will return `None`.
 692     ///     false
 693     /// }
 694     /// ```
 695     pub fn get_return_block(&self, id: HirId) -> Option<HirId> {
 696         let mut iter = self.parent_iter(id).peekable();
 697         let mut ignore_tail = false;
 698         if let Some(node) = self.find(id) {
 699             if let Node::Expr(Expr { kind: ExprKind::Ret(_), .. }) = node {
 700                 // When dealing with `return` statements, we don't care about climbing only tail
 701                 // expressions.
 702                 ignore_tail = true;
 703             }
 704         }
 705         while let Some((hir_id, node)) = iter.next() {
 706             if let (Some((_, next_node)), false) = (iter.peek(), ignore_tail) {
 707                 match next_node {
 708                     Node::Block(Block { expr: None, .. }) => return None,
 709                     // The current node is not the tail expression of its parent.
 710                     Node::Block(Block { expr: Some(e), .. }) if hir_id != e.hir_id => return None,
 711                     _ => {}
 712                 }
 713             }
 714             match node {
 715                 Node::Item(_)
 716                 | Node::ForeignItem(_)
 717                 | Node::TraitItem(_)
 718                 | Node::Expr(Expr { kind: ExprKind::Closure(..), .. })
 719                 | Node::ImplItem(_) => return Some(hir_id),
 720                 // Ignore `return`s on the first iteration
 721                 Node::Expr(Expr { kind: ExprKind::Loop(..) | ExprKind::Ret(..), .. })
 722                 | Node::Local(_) => {
 723                     return None;
 724                 }
 725                 _ => {}
 726             }
 727         }
 728         None
 729     }
 730
 731     /// Retrieves the `HirId` for `id`'s parent item, or `id` itself if no
 732     /// parent item is in this map. The "parent item" is the closest parent node
 733     /// in the HIR which is recorded by the map and is an item, either an item
 734     /// in a module, trait, or impl.
 735     pub fn get_parent_item(&self, hir_id: HirId) -> HirId {
 736         if let Some((hir_id, _node)) = self.parent_owner_iter(hir_id).next() {
 737             hir_id
 738         } else {
 739             CRATE_HIR_ID
 740         }
 741     }
 742
 743     /// Returns the `HirId` of `id`'s nearest module parent, or `id` itself if no
 744     /// module parent is in this map.
 745     pub(super) fn get_module_parent_node(&self, hir_id: HirId) -> HirId {
 746         for (hir_id, node) in self.parent_owner_iter(hir_id) {
 747             if let OwnerNode::Item(&Item { kind: ItemKind::Mod(_), .. }) = node {
 748                 return hir_id;
 749             }
 750         }
 751         CRATE_HIR_ID
 752     }
 753
 754     /// When on an if expression, a match arm tail expression or a match arm, give back
 755     /// the enclosing `if` or `match` expression.
 756     ///
 757     /// Used by error reporting when there's a type error in an if or match arm caused by the
 758     /// expression needing to be unit.
 759     pub fn get_if_cause(&self, hir_id: HirId) -> Option<&'hir Expr<'hir>> {
 760         for (_, node) in self.parent_iter(hir_id) {
 761             match node {
 762                 Node::Item(_)
 763                 | Node::ForeignItem(_)
 764                 | Node::TraitItem(_)
 765                 | Node::ImplItem(_)
 766                 | Node::Stmt(Stmt { kind: StmtKind::Local(_), .. }) => break,
 767                 Node::Expr(expr @ Expr { kind: ExprKind::If(..) | ExprKind::Match(..), .. }) => {
 768                     return Some(expr);
 769                 }
 770                 _ => {}
 771             }
 772         }
 773         None
 774     }
 775
 776     /// Returns the nearest enclosing scope. A scope is roughly an item or block.
 777     pub fn get_enclosing_scope(&self, hir_id: HirId) -> Option<HirId> {
 778         for (hir_id, node) in self.parent_iter(hir_id) {
 779             if let Node::Item(Item {
 780                 kind:
 781                     ItemKind::Fn(..)
 782                     | ItemKind::Const(..)
 783                     | ItemKind::Static(..)
 784                     | ItemKind::Mod(..)
 785                     | ItemKind::Enum(..)
 786                     | ItemKind::Struct(..)
 787                     | ItemKind::Union(..)
 788                     | ItemKind::Trait(..)
 789                     | ItemKind::Impl { .. },
 790                 ..
 791             })
 792             | Node::ForeignItem(ForeignItem { kind: ForeignItemKind::Fn(..), .. })
 793             | Node::TraitItem(TraitItem { kind: TraitItemKind::Fn(..), .. })
 794             | Node::ImplItem(ImplItem { kind: ImplItemKind::Fn(..), .. })
 795             | Node::Block(_) = node
 796             {
 797                 return Some(hir_id);
 798             }
 799         }
 800         None
 801     }
 802
 803     /// Returns the defining scope for an opaque type definition.
 804     pub fn get_defining_scope(&self, id: HirId) -> HirId {
 805         let mut scope = id;
 806         loop {
 807             scope = self.get_enclosing_scope(scope).unwrap_or(CRATE_HIR_ID);
 808             if scope == CRATE_HIR_ID || !matches!(self.get(scope), Node::Block(_)) {
 809                 return scope;
 810             }
 811         }
 812     }
 813
 814     pub fn get_parent_did(&self, id: HirId) -> LocalDefId {
 815         self.local_def_id(self.get_parent_item(id))
 816     }
 817
 818     pub fn get_foreign_abi(&self, hir_id: HirId) -> Abi {
 819         let parent = self.get_parent_item(hir_id);
 820         if let Some(node) = self.tcx.hir_owner(self.local_def_id(parent)) {
 821             if let OwnerNode::Item(Item { kind: ItemKind::ForeignMod { abi, .. }, .. }) = node.node
 822             {
 823                 return *abi;
 824             }
 825         }
 826         bug!("expected foreign mod or inlined parent, found {}", self.node_to_string(parent))
 827     }
 828
 829     pub fn expect_item(&self, id: HirId) -> &'hir Item<'hir> {
 830         match self.tcx.hir_owner(id.expect_owner()) {
 831             Some(Owner { node: OwnerNode::Item(item) }) => item,
 832             _ => bug!("expected item, found {}", self.node_to_string(id)),
 833         }
 834     }
 835
 836     pub fn expect_impl_item(&self, id: HirId) -> &'hir ImplItem<'hir> {
 837         match self.tcx.hir_owner(id.expect_owner()) {
 838             Some(Owner { node: OwnerNode::ImplItem(item) }) => item,
 839             _ => bug!("expected impl item, found {}", self.node_to_string(id)),
 840         }
 841     }
 842
 843     pub fn expect_trait_item(&self, id: HirId) -> &'hir TraitItem<'hir> {
 844         match self.tcx.hir_owner(id.expect_owner()) {
 845             Some(Owner { node: OwnerNode::TraitItem(item) }) => item,
 846             _ => bug!("expected trait item, found {}", self.node_to_string(id)),
 847         }
 848     }
 849
 850     pub fn expect_variant(&self, id: HirId) -> &'hir Variant<'hir> {
 851         match self.find(id) {
 852             Some(Node::Variant(variant)) => variant,
 853             _ => bug!("expected variant, found {}", self.node_to_string(id)),
 854         }
 855     }
 856
 857     pub fn expect_foreign_item(&self, id: HirId) -> &'hir ForeignItem<'hir> {
 858         match self.tcx.hir_owner(id.expect_owner()) {
 859             Some(Owner { node: OwnerNode::ForeignItem(item) }) => item,
 860             _ => bug!("expected foreign item, found {}", self.node_to_string(id)),
 861         }
 862     }
 863
 864     pub fn expect_expr(&self, id: HirId) -> &'hir Expr<'hir> {
 865         match self.find(id) {
 866             Some(Node::Expr(expr)) => expr,
 867             _ => bug!("expected expr, found {}", self.node_to_string(id)),
 868         }
 869     }
 870
 871     pub fn opt_name(&self, id: HirId) -> Option<Symbol> {
 872         Some(match self.get(id) {
 873             Node::Item(i) => i.ident.name,
 874             Node::ForeignItem(fi) => fi.ident.name,
 875             Node::ImplItem(ii) => ii.ident.name,
 876             Node::TraitItem(ti) => ti.ident.name,
 877             Node::Variant(v) => v.ident.name,
 878             Node::Field(f) => f.ident.name,
 879             Node::Lifetime(lt) => lt.name.ident().name,
 880             Node::GenericParam(param) => param.name.ident().name,
 881             Node::Binding(&Pat { kind: PatKind::Binding(_, _, l, _), .. }) => l.name,
 882             Node::Ctor(..) => self.name(self.get_parent_item(id)),
 883             _ => return None,
 884         })
 885     }
 886
 887     pub fn name(&self, id: HirId) -> Symbol {
 888         match self.opt_name(id) {
 889             Some(name) => name,
 890             None => bug!("no name for {}", self.node_to_string(id)),
 891         }
 892     }
 893
 894     /// Given a node ID, gets a list of attributes associated with the AST
 895     /// corresponding to the node-ID.
 896     pub fn attrs(&self, id: HirId) -> &'hir [ast::Attribute] {
 897         self.tcx.hir_attrs(id.owner).get(id.local_id)
 898     }
 899
 900     /// Gets the span of the definition of the specified HIR node.
 901     /// This is used by `tcx.get_span`
 902     pub fn span(&self, hir_id: HirId) -> Span {
 903         self.opt_span(hir_id)
 904             .unwrap_or_else(|| bug!("hir::map::Map::span: id not in map: {:?}", hir_id))
 905     }
 906
 907     pub fn opt_span(&self, hir_id: HirId) -> Option<Span> {
 908         let span = match self.find(hir_id)? {
 909             Node::Param(param) => param.span,
 910             Node::Item(item) => match &item.kind {
 911                 ItemKind::Fn(sig, _, _) => sig.span,
 912                 _ => item.span,
 913             },
 914             Node::ForeignItem(foreign_item) => foreign_item.span,
 915             Node::TraitItem(trait_item) => match &trait_item.kind {
 916                 TraitItemKind::Fn(sig, _) => sig.span,
 917                 _ => trait_item.span,
 918             },
 919             Node::ImplItem(impl_item) => match &impl_item.kind {
 920                 ImplItemKind::Fn(sig, _) => sig.span,
 921                 _ => impl_item.span,
 922             },
 923             Node::Variant(variant) => variant.span,
 924             Node::Field(field) => field.span,
 925             Node::AnonConst(constant) => self.body(constant.body).value.span,
 926             Node::Expr(expr) => expr.span,
 927             Node::Stmt(stmt) => stmt.span,
 928             Node::PathSegment(seg) => seg.ident.span,
 929             Node::Ty(ty) => ty.span,
 930             Node::TraitRef(tr) => tr.path.span,
 931             Node::Binding(pat) => pat.span,
 932             Node::Pat(pat) => pat.span,
 933             Node::Arm(arm) => arm.span,
 934             Node::Block(block) => block.span,
 935             Node::Ctor(..) => match self.find(self.get_parent_node(hir_id))? {
 936                 Node::Item(item) => item.span,
 937                 Node::Variant(variant) => variant.span,
 938                 _ => unreachable!(),
 939             },
 940             Node::Lifetime(lifetime) => lifetime.span,
 941             Node::GenericParam(param) => param.span,
 942             Node::Visibility(&Spanned {
 943                 node: VisibilityKind::Restricted { ref path, .. },
 944                 ..
 945             }) => path.span,
 946             Node::Infer(i) => i.span,
 947             Node::Visibility(v) => bug!("unexpected Visibility {:?}", v),
 948             Node::Local(local) => local.span,
 949             Node::Crate(item) => item.inner,
 950         };
 951         Some(span)
 952     }
 953
 954     /// Like `hir.span()`, but includes the body of function items
 955     /// (instead of just the function header)
 956     pub fn span_with_body(&self, hir_id: HirId) -> Span {
 957         match self.find(hir_id) {
 958             Some(Node::TraitItem(item)) => item.span,
 959             Some(Node::ImplItem(impl_item)) => impl_item.span,
 960             Some(Node::Item(item)) => item.span,
 961             Some(_) => self.span(hir_id),
 962             _ => bug!("hir::map::Map::span_with_body: id not in map: {:?}", hir_id),
 963         }
 964     }
 965
 966     pub fn span_if_local(&self, id: DefId) -> Option<Span> {
 967         id.as_local().and_then(|id| self.opt_span(self.local_def_id_to_hir_id(id)))
 968     }
 969
 970     pub fn res_span(&self, res: Res) -> Option<Span> {
 971         match res {
 972             Res::Err => None,
 973             Res::Local(id) => Some(self.span(id)),
 974             res => self.span_if_local(res.opt_def_id()?),
 975         }
 976     }
 977
 978     /// Get a representation of this `id` for debugging purposes.
 979     /// NOTE: Do NOT use this in diagnostics!
 980     pub fn node_to_string(&self, id: HirId) -> String {
 981         hir_id_to_string(self, id)
 982     }
 983
 984     /// Returns the HirId of `N` in `struct Foo<const N: usize = { ... }>` when
 985     /// called with the HirId for the `{ ... }` anon const
 986     pub fn opt_const_param_default_param_hir_id(&self, anon_const: HirId) -> Option<HirId> {
 987         match self.get(self.get_parent_node(anon_const)) {
 988             Node::GenericParam(GenericParam {
 989                 hir_id: param_id,
 990                 kind: GenericParamKind::Const { .. },
 991                 ..
 992             }) => Some(*param_id),
 993             _ => None,
 994         }
 995     }
 996 }
 997
 998 impl<'hir> intravisit::Map<'hir> for Map<'hir> {
 999     fn find(&self, hir_id: HirId) -> Option<Node<'hir>> {
1000         self.find(hir_id)
1001     }
1002
1003     fn body(&self, id: BodyId) -> &'hir Body<'hir> {
1004         self.body(id)
1005     }
1006
1007     fn item(&self, id: ItemId) -> &'hir Item<'hir> {
1008         self.item(id)
1009     }
1010
1011     fn trait_item(&self, id: TraitItemId) -> &'hir TraitItem<'hir> {
1012         self.trait_item(id)
1013     }
1014
1015     fn impl_item(&self, id: ImplItemId) -> &'hir ImplItem<'hir> {
1016         self.impl_item(id)
1017     }
1018
1019     fn foreign_item(&self, id: ForeignItemId) -> &'hir ForeignItem<'hir> {
1020         self.foreign_item(id)
1021     }
1022 }
1023
1024 pub(super) fn index_hir<'tcx>(tcx: TyCtxt<'tcx>, (): ()) -> &'tcx IndexedHir<'tcx> {
1025     let _prof_timer = tcx.sess.prof.generic_activity("build_hir_map");
1026
1027     // We can access untracked state since we are an eval_always query.
1028     let hcx = tcx.create_stable_hashing_context();
1029     let mut collector = NodeCollector::root(
1030         tcx.sess,
1031         &**tcx.arena,
1032         tcx.untracked_crate,
1033         &tcx.untracked_resolutions.definitions,
1034         hcx,
1035     );
1036     let top_mod = tcx.untracked_crate.module();
1037     collector.visit_mod(top_mod, top_mod.inner, CRATE_HIR_ID);
1038
1039     let map = collector.finalize_and_compute_crate_hash();
1040     tcx.arena.alloc(map)
1041 }
1042
1043 pub(super) fn crate_hash(tcx: TyCtxt<'_>, crate_num: CrateNum) -> Svh {
1044     assert_eq!(crate_num, LOCAL_CRATE);
1045
1046     // We can access untracked state since we are an eval_always query.
1047     let mut hcx = tcx.create_stable_hashing_context();
1048
1049     let mut hir_body_nodes: Vec<_> = tcx
1050         .index_hir(())
1051         .map
1052         .iter_enumerated()
1053         .filter_map(|(def_id, hod)| {
1054             let def_path_hash = tcx.untracked_resolutions.definitions.def_path_hash(def_id);
1055             let hash = hod.as_ref()?.hash;
1056             Some((def_path_hash, hash, def_id))
1057         })
1058         .collect();
1059     hir_body_nodes.sort_unstable_by_key(|bn| bn.0);
1060
1061     let upstream_crates = upstream_crates(tcx);
1062
1063     // We hash the final, remapped names of all local source files so we
1064     // don't have to include the path prefix remapping commandline args.
1065     // If we included the full mapping in the SVH, we could only have
1066     // reproducible builds by compiling from the same directory. So we just
1067     // hash the result of the mapping instead of the mapping itself.
1068     let mut source_file_names: Vec<_> = tcx
1069         .sess
1070         .source_map()
1071         .files()
1072         .iter()
1073         .filter(|source_file| source_file.cnum == LOCAL_CRATE)
1074         .map(|source_file| source_file.name_hash)
1075         .collect();
1076
1077     source_file_names.sort_unstable();
1078
1079     let mut stable_hasher = StableHasher::new();
1080     for (def_path_hash, fingerprint, def_id) in hir_body_nodes.iter() {
1081         def_path_hash.0.hash_stable(&mut hcx, &mut stable_hasher);
1082         fingerprint.hash_stable(&mut hcx, &mut stable_hasher);
1083         AttributeMap { map: &tcx.untracked_crate.attrs, prefix: *def_id }
1084             .hash_stable(&mut hcx, &mut stable_hasher);
1085         if tcx.sess.opts.debugging_opts.incremental_relative_spans {
1086             let span = tcx.untracked_resolutions.definitions.def_span(*def_id);
1087             debug_assert_eq!(span.parent(), None);
1088             span.hash_stable(&mut hcx, &mut stable_hasher);
1089         }
1090     }
1091     upstream_crates.hash_stable(&mut hcx, &mut stable_hasher);
1092     source_file_names.hash_stable(&mut hcx, &mut stable_hasher);
1093     tcx.sess.opts.dep_tracking_hash(true).hash_stable(&mut hcx, &mut stable_hasher);
1094     tcx.sess.local_stable_crate_id().hash_stable(&mut hcx, &mut stable_hasher);
1095
1096     let crate_hash: Fingerprint = stable_hasher.finish();
1097     Svh::new(crate_hash.to_smaller_hash())
1098 }
1099
1100 fn upstream_crates(tcx: TyCtxt<'_>) -> Vec<(StableCrateId, Svh)> {
1101     let mut upstream_crates: Vec<_> = tcx
1102         .crates(())
1103         .iter()
1104         .map(|&cnum| {
1105             let stable_crate_id = tcx.resolutions(()).cstore.stable_crate_id(cnum);
1106             let hash = tcx.crate_hash(cnum);
1107             (stable_crate_id, hash)
1108         })
1109         .collect();
1110     upstream_crates.sort_unstable_by_key(|&(stable_crate_id, _)| stable_crate_id);
1111     upstream_crates
1112 }
1113
1114 fn hir_id_to_string(map: &Map<'_>, id: HirId) -> String {
1115     let id_str = format!(" (hir_id={})", id);
1116
1117     let path_str = || {
1118         // This functionality is used for debugging, try to use `TyCtxt` to get
1119         // the user-friendly path, otherwise fall back to stringifying `DefPath`.
1120         crate::ty::tls::with_opt(|tcx| {
1121             if let Some(tcx) = tcx {
1122                 let def_id = map.local_def_id(id);
1123                 tcx.def_path_str(def_id.to_def_id())
1124             } else if let Some(path) = map.def_path_from_hir_id(id) {
1125                 path.data.into_iter().map(|elem| elem.to_string()).collect::<Vec<_>>().join("::")
1126             } else {
1127                 String::from("<missing path>")
1128             }
1129         })
1130     };
1131
1132     let span_str = || map.tcx.sess.source_map().span_to_snippet(map.span(id)).unwrap_or_default();
1133     let node_str = |prefix| format!("{} {}{}", prefix, span_str(), id_str);
1134
1135     match map.find(id) {
1136         Some(Node::Item(item)) => {
1137             let item_str = match item.kind {
1138                 ItemKind::ExternCrate(..) => "extern crate",
1139                 ItemKind::Use(..) => "use",
1140                 ItemKind::Static(..) => "static",
1141                 ItemKind::Const(..) => "const",
1142                 ItemKind::Fn(..) => "fn",
1143                 ItemKind::Macro(..) => "macro",
1144                 ItemKind::Mod(..) => "mod",
1145                 ItemKind::ForeignMod { .. } => "foreign mod",
1146                 ItemKind::GlobalAsm(..) => "global asm",
1147                 ItemKind::TyAlias(..) => "ty",
1148                 ItemKind::OpaqueTy(..) => "opaque type",
1149                 ItemKind::Enum(..) => "enum",
1150                 ItemKind::Struct(..) => "struct",
1151                 ItemKind::Union(..) => "union",
1152                 ItemKind::Trait(..) => "trait",
1153                 ItemKind::TraitAlias(..) => "trait alias",
1154                 ItemKind::Impl { .. } => "impl",
1155             };
1156             format!("{} {}{}", item_str, path_str(), id_str)
1157         }
1158         Some(Node::ForeignItem(_)) => format!("foreign item {}{}", path_str(), id_str),
1159         Some(Node::ImplItem(ii)) => match ii.kind {
1160             ImplItemKind::Const(..) => {
1161                 format!("assoc const {} in {}{}", ii.ident, path_str(), id_str)
1162             }
1163             ImplItemKind::Fn(..) => format!("method {} in {}{}", ii.ident, path_str(), id_str),
1164             ImplItemKind::TyAlias(_) => {
1165                 format!("assoc type {} in {}{}", ii.ident, path_str(), id_str)
1166             }
1167         },
1168         Some(Node::TraitItem(ti)) => {
1169             let kind = match ti.kind {
1170                 TraitItemKind::Const(..) => "assoc constant",
1171                 TraitItemKind::Fn(..) => "trait method",
1172                 TraitItemKind::Type(..) => "assoc type",
1173             };
1174
1175             format!("{} {} in {}{}", kind, ti.ident, path_str(), id_str)
1176         }
1177         Some(Node::Variant(ref variant)) => {
1178             format!("variant {} in {}{}", variant.ident, path_str(), id_str)
1179         }
1180         Some(Node::Field(ref field)) => {
1181             format!("field {} in {}{}", field.ident, path_str(), id_str)
1182         }
1183         Some(Node::AnonConst(_)) => node_str("const"),
1184         Some(Node::Expr(_)) => node_str("expr"),
1185         Some(Node::Stmt(_)) => node_str("stmt"),
1186         Some(Node::PathSegment(_)) => node_str("path segment"),
1187         Some(Node::Ty(_)) => node_str("type"),
1188         Some(Node::TraitRef(_)) => node_str("trait ref"),
1189         Some(Node::Binding(_)) => node_str("local"),
1190         Some(Node::Pat(_)) => node_str("pat"),
1191         Some(Node::Param(_)) => node_str("param"),
1192         Some(Node::Arm(_)) => node_str("arm"),
1193         Some(Node::Block(_)) => node_str("block"),
1194         Some(Node::Infer(_)) => node_str("infer"),
1195         Some(Node::Local(_)) => node_str("local"),
1196         Some(Node::Ctor(..)) => format!("ctor {}{}", path_str(), id_str),
1197         Some(Node::Lifetime(_)) => node_str("lifetime"),
1198         Some(Node::GenericParam(ref param)) => format!("generic_param {:?}{}", param, id_str),
1199         Some(Node::Visibility(ref vis)) => format!("visibility {:?}{}", vis, id_str),
1200         Some(Node::Crate(..)) => String::from("root_crate"),
1201         None => format!("unknown node{}", id_str),
1202     }
1203 }
1204
1205 pub(super) fn hir_module_items(tcx: TyCtxt<'_>, module_id: LocalDefId) -> ModuleItems {
1206     let mut collector = ModuleCollector {
1207         tcx,
1208         submodules: Vec::default(),
1209         items: Vec::default(),
1210         trait_items: Vec::default(),
1211         impl_items: Vec::default(),
1212         foreign_items: Vec::default(),
1213     };
1214
1215     let (hir_mod, span, hir_id) = tcx.hir().get_module(module_id);
1216     collector.visit_mod(hir_mod, span, hir_id);
1217
1218     let ModuleCollector { submodules, items, trait_items, impl_items, foreign_items, .. } =
1219         collector;
1220     return ModuleItems {
1221         submodules: submodules.into_boxed_slice(),
1222         items: items.into_boxed_slice(),
1223         trait_items: trait_items.into_boxed_slice(),
1224         impl_items: impl_items.into_boxed_slice(),
1225         foreign_items: foreign_items.into_boxed_slice(),
1226     };
1227
1228     struct ModuleCollector<'tcx> {
1229         tcx: TyCtxt<'tcx>,
1230         submodules: Vec<LocalDefId>,
1231         items: Vec<ItemId>,
1232         trait_items: Vec<TraitItemId>,
1233         impl_items: Vec<ImplItemId>,
1234         foreign_items: Vec<ForeignItemId>,
1235     }
1236
1237     impl<'hir> Visitor<'hir> for ModuleCollector<'hir> {
1238         type Map = Map<'hir>;
1239
1240         fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
1241             intravisit::NestedVisitorMap::All(self.tcx.hir())
1242         }
1243
1244         fn visit_item(&mut self, item: &'hir Item<'hir>) {
1245             self.items.push(item.item_id());
1246             if let ItemKind::Mod(..) = item.kind {
1247                 // If this declares another module, do not recurse inside it.
1248                 self.submodules.push(item.def_id);
1249             } else {
1250                 intravisit::walk_item(self, item)
1251             }
1252         }
1253
1254         fn visit_trait_item(&mut self, item: &'hir TraitItem<'hir>) {
1255             self.trait_items.push(item.trait_item_id());
1256             intravisit::walk_trait_item(self, item)
1257         }
1258
1259         fn visit_impl_item(&mut self, item: &'hir ImplItem<'hir>) {
1260             self.impl_items.push(item.impl_item_id());
1261             intravisit::walk_impl_item(self, item)
1262         }
1263
1264         fn visit_foreign_item(&mut self, item: &'hir ForeignItem<'hir>) {
1265             self.foreign_items.push(item.foreign_item_id());
1266             intravisit::walk_foreign_item(self, item)
1267         }
1268     }
1269 }