1 use self::collector::NodeCollector;
3 use crate::hir::{AttributeMap, IndexedHir, ModuleItems, Owner};
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;
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};
22 use rustc_target::spec::abi::Abi;
23 use std::collections::VecDeque;
28 fn fn_decl<'hir>(node: Node<'hir>) -> Option<&'hir FnDecl<'hir>> {
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, ..), .. }) => {
41 pub fn fn_sig<'hir>(node: Node<'hir>) -> Option<&'hir FnSig<'hir>> {
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),
50 pub fn associated_body<'hir>(node: Node<'hir>) -> Option<BodyId> {
53 kind: ItemKind::Const(_, body) | ItemKind::Static(.., body) | ItemKind::Fn(.., body),
56 | Node::TraitItem(TraitItem {
58 TraitItemKind::Const(_, Some(body)) | TraitItemKind::Fn(_, TraitFn::Provided(body)),
61 | Node::ImplItem(ImplItem {
62 kind: ImplItemKind::Const(_, body) | ImplItemKind::Fn(_, body),
65 | Node::Expr(Expr { kind: ExprKind::Closure(.., body, _, _), .. }) => Some(*body),
67 Node::AnonConst(constant) => Some(constant.body),
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,
80 #[derive(Copy, Clone)]
81 pub struct Map<'hir> {
82 pub(super) tcx: TyCtxt<'hir>,
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> {
92 impl<'hir> Iterator for ParentHirIterator<'hir> {
93 type Item = (HirId, Node<'hir>);
95 fn next(&mut self) -> Option<Self::Item> {
96 if self.current_id == CRATE_HIR_ID {
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);
103 if parent_id == self.current_id {
104 self.current_id = CRATE_HIR_ID;
108 self.current_id = parent_id;
109 if let Some(node) = self.map.find(parent_id) {
110 return Some((parent_id, node));
112 // If this `HirId` doesn't have an entry, skip it and look for its `parent_id`.
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> {
124 impl<'hir> Iterator for ParentOwnerIterator<'hir> {
125 type Item = (HirId, OwnerNode<'hir>);
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));
134 if self.current_id == CRATE_HIR_ID {
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;
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
145 self.current_id = HirId::make_owner(parent_id);
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));
155 impl<'hir> Map<'hir> {
156 pub fn krate(&self) -> &'hir Crate<'hir> {
157 self.tcx.hir_crate(())
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,
167 pub 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),
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)
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))
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)
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)
196 pub fn local_def_id(&self, hir_id: HirId) -> LocalDefId {
197 self.opt_local_def_id(hir_id).unwrap_or_else(|| {
199 "local_def_id: no entry for `{:?}`, which has a map of `{:?}`",
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)
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)
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()
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,
247 Node::ForeignItem(item) => match item.kind {
248 ForeignItemKind::Fn(..) => DefKind::Fn,
249 ForeignItemKind::Static(..) => DefKind::Static,
250 ForeignItemKind::Type => DefKind::ForeignTy,
252 Node::TraitItem(item) => match item.kind {
253 TraitItemKind::Const(..) => DefKind::AssocConst,
254 TraitItemKind::Fn(..) => DefKind::AssocFn,
255 TraitItemKind::Type(..) => DefKind::AssocTy,
257 Node::ImplItem(item) => match item.kind {
258 ImplItemKind::Const(..) => DefKind::AssocConst,
259 ImplItemKind::Fn(..) => DefKind::AssocFn,
260 ImplItemKind::TyAlias(..) => DefKind::AssocTy,
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);
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,
272 DefKind::Ctor(ctor_of, def::CtorKind::from_hir(variant_data))
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)),
281 Node::GenericParam(param) => match param.kind {
282 GenericParamKind::Lifetime { .. } => DefKind::LifetimeParam,
283 GenericParamKind::Type { .. } => DefKind::TyParam,
284 GenericParamKind::Const { .. } => DefKind::ConstParam,
286 Node::Crate(_) => DefKind::Mod,
288 | Node::PathSegment(_)
298 | Node::Visibility(_)
299 | Node::Block(_) => return None,
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))
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))
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 };
320 pub fn get_parent_node(&self, hir_id: HirId) -> HirId {
321 self.find_parent_node(hir_id).unwrap_or(CRATE_HIR_ID)
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())
330 let owner = self.tcx.hir_owner_nodes(id.owner)?;
331 let node = owner.nodes[id.local_id].as_ref()?;
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))
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)))
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)?;
349 OwnerNode::ImplItem(impl_item) => Some(&impl_item.generics),
350 OwnerNode::TraitItem(trait_item) => Some(&trait_item.generics),
351 OwnerNode::Item(Item {
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, .. }),
362 }) => Some(generics),
367 pub fn item(&self, id: ItemId) -> &'hir Item<'hir> {
368 self.tcx.hir_owner(id.def_id).unwrap().node.expect_item()
371 pub fn trait_item(&self, id: TraitItemId) -> &'hir TraitItem<'hir> {
372 self.tcx.hir_owner(id.def_id).unwrap().node.expect_trait_item()
375 pub fn impl_item(&self, id: ImplItemId) -> &'hir ImplItem<'hir> {
376 self.tcx.hir_owner(id.def_id).unwrap().node.expect_impl_item()
379 pub fn foreign_item(&self, id: ForeignItemId) -> &'hir ForeignItem<'hir> {
380 self.tcx.hir_owner(id.def_id).unwrap().node.expect_foreign_item()
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()
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) {
391 bug!("no node for hir_id `{}`", hir_id)
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) {
399 bug!("no node for hir_id `{}`", hir_id)
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);
410 bug!("no `enclosing_body_owner` for hir_id `{}`", hir_id);
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)));
422 pub fn body_owner_def_id(&self, id: BodyId) -> LocalDefId {
423 self.local_def_id(self.body_owner(id))
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()
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(|| {
437 "body_owned_by: {} has no associated body",
438 self.node_to_string(id)
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),
450 /// Returns the `BodyOwnerKind` of this `LocalDefId`.
452 /// Panics if `LocalDefId` does not have an associated body.
453 pub fn body_owner_kind(&self, id: HirId) -> BodyOwnerKind {
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,
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),
469 /// Returns the `ConstContext` of the body associated with this `LocalDefId`.
471 /// Panics if `LocalDefId` does not have an associated body.
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),
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,
484 if self.tcx.has_attr(did.to_def_id(), sym::default_method_body_is_const) =>
486 ConstContext::ConstFn
488 BodyOwnerKind::Fn | BodyOwnerKind::Closure => return None,
494 /// Returns an iterator of the `DefId`s for all body-owners in this
495 /// crate. If you would prefer to iterate over the bodies
496 /// themselves, you can do `self.hir().krate().body_ids.iter()`.
497 pub fn body_owners(self) -> impl Iterator<Item = LocalDefId> + 'hir {
498 self.krate().bodies.keys().map(move |&body_id| self.body_owner_def_id(body_id))
501 pub fn par_body_owners<F: Fn(LocalDefId) + Sync + Send>(self, f: F) {
502 par_for_each_in(&self.krate().bodies, |(&body_id, _)| f(self.body_owner_def_id(body_id)));
505 pub fn ty_param_owner(&self, id: HirId) -> HirId {
507 Node::Item(&Item { kind: ItemKind::Trait(..) | ItemKind::TraitAlias(..), .. }) => id,
508 Node::GenericParam(_) => self.get_parent_node(id),
509 _ => bug!("ty_param_owner: {} not a type parameter", self.node_to_string(id)),
513 pub fn ty_param_name(&self, id: HirId) -> Symbol {
515 Node::Item(&Item { kind: ItemKind::Trait(..) | ItemKind::TraitAlias(..), .. }) => {
518 Node::GenericParam(param) => param.name.ident().name,
519 _ => bug!("ty_param_name: {} not a type parameter", self.node_to_string(id)),
523 pub fn trait_impls(&self, trait_did: DefId) -> &'hir [LocalDefId] {
524 self.tcx.all_local_trait_impls(()).get(&trait_did).map_or(&[], |xs| &xs[..])
527 /// Gets the attributes on the crate. This is preferable to
528 /// invoking `krate.attrs` because it registers a tighter
529 /// dep-graph access.
530 pub fn krate_attrs(&self) -> &'hir [ast::Attribute] {
531 self.attrs(CRATE_HIR_ID)
534 pub fn get_module(&self, module: LocalDefId) -> (&'hir Mod<'hir>, Span, HirId) {
535 let hir_id = HirId::make_owner(module);
536 match self.tcx.hir_owner(module).map(|o| o.node) {
537 Some(OwnerNode::Item(&Item { span, kind: ItemKind::Mod(ref m), .. })) => {
540 Some(OwnerNode::Crate(item)) => (item, item.inner, hir_id),
541 node => panic!("not a module: {:?}", node),
545 /// Walks the contents of a crate. See also `Crate::visit_all_items`.
546 pub fn walk_toplevel_module(self, visitor: &mut impl Visitor<'hir>) {
547 let (top_mod, span, hir_id) = self.get_module(CRATE_DEF_ID);
548 visitor.visit_mod(top_mod, span, hir_id);
551 /// Walks the attributes in a crate.
552 pub fn walk_attributes(self, visitor: &mut impl Visitor<'hir>) {
553 let krate = self.krate();
554 for (&id, attrs) in krate.attrs.iter() {
556 visitor.visit_attribute(id, a)
561 /// Visits all items in the crate in some deterministic (but
562 /// unspecified) order. If you just need to process every item,
563 /// but don't care about nesting, this method is the best choice.
565 /// If you do care about nesting -- usually because your algorithm
566 /// follows lexical scoping rules -- then you want a different
567 /// approach. You should override `visit_nested_item` in your
568 /// visitor and then call `intravisit::walk_crate` instead.
569 pub fn visit_all_item_likes<V>(&self, visitor: &mut V)
571 V: itemlikevisit::ItemLikeVisitor<'hir>,
573 let krate = self.krate();
574 for owner in krate.owners.iter().filter_map(Option::as_ref) {
576 OwnerNode::Item(item) => visitor.visit_item(item),
577 OwnerNode::ForeignItem(item) => visitor.visit_foreign_item(item),
578 OwnerNode::ImplItem(item) => visitor.visit_impl_item(item),
579 OwnerNode::TraitItem(item) => visitor.visit_trait_item(item),
580 OwnerNode::Crate(_) => {}
585 /// A parallel version of `visit_all_item_likes`.
586 pub fn par_visit_all_item_likes<V>(&self, visitor: &V)
588 V: itemlikevisit::ParItemLikeVisitor<'hir> + Sync + Send,
590 let krate = self.krate();
591 par_for_each_in(&krate.owners.raw, |owner| match owner.as_ref() {
592 Some(OwnerNode::Item(item)) => visitor.visit_item(item),
593 Some(OwnerNode::ForeignItem(item)) => visitor.visit_foreign_item(item),
594 Some(OwnerNode::ImplItem(item)) => visitor.visit_impl_item(item),
595 Some(OwnerNode::TraitItem(item)) => visitor.visit_trait_item(item),
596 Some(OwnerNode::Crate(_)) | None => {}
600 pub fn visit_item_likes_in_module<V>(&self, module: LocalDefId, visitor: &mut V)
602 V: ItemLikeVisitor<'hir>,
604 let module = self.tcx.hir_module_items(module);
606 for id in module.items.iter() {
607 visitor.visit_item(self.item(*id));
610 for id in module.trait_items.iter() {
611 visitor.visit_trait_item(self.trait_item(*id));
614 for id in module.impl_items.iter() {
615 visitor.visit_impl_item(self.impl_item(*id));
618 for id in module.foreign_items.iter() {
619 visitor.visit_foreign_item(self.foreign_item(*id));
623 pub fn for_each_module(&self, f: impl Fn(LocalDefId)) {
624 let mut queue = VecDeque::new();
625 queue.push_back(CRATE_DEF_ID);
627 while let Some(id) = queue.pop_front() {
629 let items = self.tcx.hir_module_items(id);
630 queue.extend(items.submodules.iter().copied())
634 #[cfg(not(parallel_compiler))]
636 pub fn par_for_each_module(&self, f: impl Fn(LocalDefId)) {
637 self.for_each_module(f)
640 #[cfg(parallel_compiler)]
641 pub fn par_for_each_module(&self, f: impl Fn(LocalDefId) + Sync) {
642 use rustc_data_structures::sync::{par_iter, ParallelIterator};
643 par_iter_submodules(self.tcx, CRATE_DEF_ID, &f);
645 fn par_iter_submodules<F>(tcx: TyCtxt<'_>, module: LocalDefId, f: &F)
647 F: Fn(LocalDefId) + Sync,
650 let items = tcx.hir_module_items(module);
651 par_iter(&items.submodules[..]).for_each(|&sm| par_iter_submodules(tcx, sm, f));
655 /// Returns an iterator for the nodes in the ancestor tree of the `current_id`
656 /// until the crate root is reached. Prefer this over your own loop using `get_parent_node`.
657 pub fn parent_iter(self, current_id: HirId) -> ParentHirIterator<'hir> {
658 ParentHirIterator { current_id, map: self }
661 /// Returns an iterator for the nodes in the ancestor tree of the `current_id`
662 /// until the crate root is reached. Prefer this over your own loop using `get_parent_node`.
663 pub fn parent_owner_iter(self, current_id: HirId) -> ParentOwnerIterator<'hir> {
664 ParentOwnerIterator { current_id, map: self }
667 /// Checks if the node is left-hand side of an assignment.
668 pub fn is_lhs(&self, id: HirId) -> bool {
669 match self.find(self.get_parent_node(id)) {
670 Some(Node::Expr(expr)) => match expr.kind {
671 ExprKind::Assign(lhs, _rhs, _span) => lhs.hir_id == id,
678 /// Whether the expression pointed at by `hir_id` belongs to a `const` evaluation context.
679 /// Used exclusively for diagnostics, to avoid suggestion function calls.
680 pub fn is_inside_const_context(&self, hir_id: HirId) -> bool {
681 self.body_const_context(self.local_def_id(self.enclosing_body_owner(hir_id))).is_some()
684 /// Retrieves the `HirId` for `id`'s enclosing method, unless there's a
685 /// `while` or `loop` before reaching it, as block tail returns are not
686 /// available in them.
689 /// fn foo(x: usize) -> bool {
691 /// true // If `get_return_block` gets passed the `id` corresponding
692 /// } else { // to this, it will return `foo`'s `HirId`.
699 /// fn foo(x: usize) -> bool {
701 /// true // If `get_return_block` gets passed the `id` corresponding
702 /// } // to this, it will return `None`.
706 pub fn get_return_block(&self, id: HirId) -> Option<HirId> {
707 let mut iter = self.parent_iter(id).peekable();
708 let mut ignore_tail = false;
709 if let Some(node) = self.find(id) {
710 if let Node::Expr(Expr { kind: ExprKind::Ret(_), .. }) = node {
711 // When dealing with `return` statements, we don't care about climbing only tail
716 while let Some((hir_id, node)) = iter.next() {
717 if let (Some((_, next_node)), false) = (iter.peek(), ignore_tail) {
719 Node::Block(Block { expr: None, .. }) => return None,
720 // The current node is not the tail expression of its parent.
721 Node::Block(Block { expr: Some(e), .. }) if hir_id != e.hir_id => return None,
727 | Node::ForeignItem(_)
729 | Node::Expr(Expr { kind: ExprKind::Closure(..), .. })
730 | Node::ImplItem(_) => return Some(hir_id),
731 // Ignore `return`s on the first iteration
732 Node::Expr(Expr { kind: ExprKind::Loop(..) | ExprKind::Ret(..), .. })
733 | Node::Local(_) => {
742 /// Retrieves the `HirId` for `id`'s parent item, or `id` itself if no
743 /// parent item is in this map. The "parent item" is the closest parent node
744 /// in the HIR which is recorded by the map and is an item, either an item
745 /// in a module, trait, or impl.
746 pub fn get_parent_item(&self, hir_id: HirId) -> HirId {
747 if let Some((hir_id, _node)) = self.parent_owner_iter(hir_id).next() {
754 /// Returns the `HirId` of `id`'s nearest module parent, or `id` itself if no
755 /// module parent is in this map.
756 pub(super) fn get_module_parent_node(&self, hir_id: HirId) -> HirId {
757 for (hir_id, node) in self.parent_owner_iter(hir_id) {
758 if let OwnerNode::Item(&Item { kind: ItemKind::Mod(_), .. }) = node {
765 /// When on an if expression, a match arm tail expression or a match arm, give back
766 /// the enclosing `if` or `match` expression.
768 /// Used by error reporting when there's a type error in an if or match arm caused by the
769 /// expression needing to be unit.
770 pub fn get_if_cause(&self, hir_id: HirId) -> Option<&'hir Expr<'hir>> {
771 for (_, node) in self.parent_iter(hir_id) {
774 | Node::ForeignItem(_)
777 | Node::Stmt(Stmt { kind: StmtKind::Local(_), .. }) => break,
778 Node::Expr(expr @ Expr { kind: ExprKind::If(..) | ExprKind::Match(..), .. }) => {
787 /// Returns the nearest enclosing scope. A scope is roughly an item or block.
788 pub fn get_enclosing_scope(&self, hir_id: HirId) -> Option<HirId> {
789 for (hir_id, node) in self.parent_iter(hir_id) {
790 if let Node::Item(Item {
793 | ItemKind::Const(..)
794 | ItemKind::Static(..)
797 | ItemKind::Struct(..)
798 | ItemKind::Union(..)
799 | ItemKind::Trait(..)
800 | ItemKind::Impl { .. },
803 | Node::ForeignItem(ForeignItem { kind: ForeignItemKind::Fn(..), .. })
804 | Node::TraitItem(TraitItem { kind: TraitItemKind::Fn(..), .. })
805 | Node::ImplItem(ImplItem { kind: ImplItemKind::Fn(..), .. })
806 | Node::Block(_) = node
814 /// Returns the defining scope for an opaque type definition.
815 pub fn get_defining_scope(&self, id: HirId) -> HirId {
818 scope = self.get_enclosing_scope(scope).unwrap_or(CRATE_HIR_ID);
819 if scope == CRATE_HIR_ID || !matches!(self.get(scope), Node::Block(_)) {
825 pub fn get_parent_did(&self, id: HirId) -> LocalDefId {
826 self.local_def_id(self.get_parent_item(id))
829 pub fn get_foreign_abi(&self, hir_id: HirId) -> Abi {
830 let parent = self.get_parent_item(hir_id);
831 if let Some(node) = self.tcx.hir_owner(self.local_def_id(parent)) {
832 if let OwnerNode::Item(Item { kind: ItemKind::ForeignMod { abi, .. }, .. }) = node.node
837 bug!("expected foreign mod or inlined parent, found {}", self.node_to_string(parent))
840 pub fn expect_item(&self, id: HirId) -> &'hir Item<'hir> {
841 match self.tcx.hir_owner(id.expect_owner()) {
842 Some(Owner { node: OwnerNode::Item(item) }) => item,
843 _ => bug!("expected item, found {}", self.node_to_string(id)),
847 pub fn expect_impl_item(&self, id: HirId) -> &'hir ImplItem<'hir> {
848 match self.tcx.hir_owner(id.expect_owner()) {
849 Some(Owner { node: OwnerNode::ImplItem(item) }) => item,
850 _ => bug!("expected impl item, found {}", self.node_to_string(id)),
854 pub fn expect_trait_item(&self, id: HirId) -> &'hir TraitItem<'hir> {
855 match self.tcx.hir_owner(id.expect_owner()) {
856 Some(Owner { node: OwnerNode::TraitItem(item) }) => item,
857 _ => bug!("expected trait item, found {}", self.node_to_string(id)),
861 pub fn expect_variant(&self, id: HirId) -> &'hir Variant<'hir> {
862 match self.find(id) {
863 Some(Node::Variant(variant)) => variant,
864 _ => bug!("expected variant, found {}", self.node_to_string(id)),
868 pub fn expect_foreign_item(&self, id: HirId) -> &'hir ForeignItem<'hir> {
869 match self.tcx.hir_owner(id.expect_owner()) {
870 Some(Owner { node: OwnerNode::ForeignItem(item) }) => item,
871 _ => bug!("expected foreign item, found {}", self.node_to_string(id)),
875 pub fn expect_expr(&self, id: HirId) -> &'hir Expr<'hir> {
876 match self.find(id) {
877 Some(Node::Expr(expr)) => expr,
878 _ => bug!("expected expr, found {}", self.node_to_string(id)),
882 pub fn opt_name(&self, id: HirId) -> Option<Symbol> {
883 Some(match self.get(id) {
884 Node::Item(i) => i.ident.name,
885 Node::ForeignItem(fi) => fi.ident.name,
886 Node::ImplItem(ii) => ii.ident.name,
887 Node::TraitItem(ti) => ti.ident.name,
888 Node::Variant(v) => v.ident.name,
889 Node::Field(f) => f.ident.name,
890 Node::Lifetime(lt) => lt.name.ident().name,
891 Node::GenericParam(param) => param.name.ident().name,
892 Node::Binding(&Pat { kind: PatKind::Binding(_, _, l, _), .. }) => l.name,
893 Node::Ctor(..) => self.name(self.get_parent_item(id)),
898 pub fn name(&self, id: HirId) -> Symbol {
899 match self.opt_name(id) {
901 None => bug!("no name for {}", self.node_to_string(id)),
905 /// Given a node ID, gets a list of attributes associated with the AST
906 /// corresponding to the node-ID.
907 pub fn attrs(&self, id: HirId) -> &'hir [ast::Attribute] {
908 self.tcx.hir_attrs(id.owner).get(id.local_id)
911 /// Gets the span of the definition of the specified HIR node.
912 /// This is used by `tcx.get_span`
913 pub fn span(&self, hir_id: HirId) -> Span {
914 self.opt_span(hir_id)
915 .unwrap_or_else(|| bug!("hir::map::Map::span: id not in map: {:?}", hir_id))
918 pub fn opt_span(&self, hir_id: HirId) -> Option<Span> {
919 let span = match self.find(hir_id)? {
920 Node::Param(param) => param.span,
921 Node::Item(item) => match &item.kind {
922 ItemKind::Fn(sig, _, _) => sig.span,
925 Node::ForeignItem(foreign_item) => foreign_item.span,
926 Node::TraitItem(trait_item) => match &trait_item.kind {
927 TraitItemKind::Fn(sig, _) => sig.span,
928 _ => trait_item.span,
930 Node::ImplItem(impl_item) => match &impl_item.kind {
931 ImplItemKind::Fn(sig, _) => sig.span,
934 Node::Variant(variant) => variant.span,
935 Node::Field(field) => field.span,
936 Node::AnonConst(constant) => self.body(constant.body).value.span,
937 Node::Expr(expr) => expr.span,
938 Node::Stmt(stmt) => stmt.span,
939 Node::PathSegment(seg) => seg.ident.span,
940 Node::Ty(ty) => ty.span,
941 Node::TraitRef(tr) => tr.path.span,
942 Node::Binding(pat) => pat.span,
943 Node::Pat(pat) => pat.span,
944 Node::Arm(arm) => arm.span,
945 Node::Block(block) => block.span,
946 Node::Ctor(..) => match self.find(self.get_parent_node(hir_id))? {
947 Node::Item(item) => item.span,
948 Node::Variant(variant) => variant.span,
951 Node::Lifetime(lifetime) => lifetime.span,
952 Node::GenericParam(param) => param.span,
953 Node::Visibility(&Spanned {
954 node: VisibilityKind::Restricted { ref path, .. },
957 Node::Infer(i) => i.span,
958 Node::Visibility(v) => bug!("unexpected Visibility {:?}", v),
959 Node::Local(local) => local.span,
960 Node::Crate(item) => item.inner,
965 /// Like `hir.span()`, but includes the body of function items
966 /// (instead of just the function header)
967 pub fn span_with_body(&self, hir_id: HirId) -> Span {
968 match self.find(hir_id) {
969 Some(Node::TraitItem(item)) => item.span,
970 Some(Node::ImplItem(impl_item)) => impl_item.span,
971 Some(Node::Item(item)) => item.span,
972 Some(_) => self.span(hir_id),
973 _ => bug!("hir::map::Map::span_with_body: id not in map: {:?}", hir_id),
977 pub fn span_if_local(&self, id: DefId) -> Option<Span> {
978 id.as_local().and_then(|id| self.opt_span(self.local_def_id_to_hir_id(id)))
981 pub fn res_span(&self, res: Res) -> Option<Span> {
984 Res::Local(id) => Some(self.span(id)),
985 res => self.span_if_local(res.opt_def_id()?),
989 /// Get a representation of this `id` for debugging purposes.
990 /// NOTE: Do NOT use this in diagnostics!
991 pub fn node_to_string(&self, id: HirId) -> String {
992 hir_id_to_string(self, id)
995 /// Returns the HirId of `N` in `struct Foo<const N: usize = { ... }>` when
996 /// called with the HirId for the `{ ... }` anon const
997 pub fn opt_const_param_default_param_hir_id(&self, anon_const: HirId) -> Option<HirId> {
998 match self.get(self.get_parent_node(anon_const)) {
999 Node::GenericParam(GenericParam {
1001 kind: GenericParamKind::Const { .. },
1003 }) => Some(*param_id),
1009 impl<'hir> intravisit::Map<'hir> for Map<'hir> {
1010 fn find(&self, hir_id: HirId) -> Option<Node<'hir>> {
1014 fn body(&self, id: BodyId) -> &'hir Body<'hir> {
1018 fn item(&self, id: ItemId) -> &'hir Item<'hir> {
1022 fn trait_item(&self, id: TraitItemId) -> &'hir TraitItem<'hir> {
1026 fn impl_item(&self, id: ImplItemId) -> &'hir ImplItem<'hir> {
1030 fn foreign_item(&self, id: ForeignItemId) -> &'hir ForeignItem<'hir> {
1031 self.foreign_item(id)
1035 pub(super) fn index_hir<'tcx>(tcx: TyCtxt<'tcx>, (): ()) -> &'tcx IndexedHir<'tcx> {
1036 let _prof_timer = tcx.sess.prof.generic_activity("build_hir_map");
1038 // We can access untracked state since we are an eval_always query.
1039 let hcx = tcx.create_stable_hashing_context();
1040 let mut collector = NodeCollector::root(
1043 tcx.untracked_crate,
1044 &tcx.untracked_resolutions.definitions,
1047 let top_mod = tcx.untracked_crate.module();
1048 collector.visit_mod(top_mod, top_mod.inner, CRATE_HIR_ID);
1050 let map = collector.finalize_and_compute_crate_hash();
1051 tcx.arena.alloc(map)
1054 pub(super) fn crate_hash(tcx: TyCtxt<'_>, crate_num: CrateNum) -> Svh {
1055 assert_eq!(crate_num, LOCAL_CRATE);
1057 // We can access untracked state since we are an eval_always query.
1058 let mut hcx = tcx.create_stable_hashing_context();
1060 let mut hir_body_nodes: Vec<_> = tcx
1064 .filter_map(|(def_id, hod)| {
1065 let def_path_hash = tcx.untracked_resolutions.definitions.def_path_hash(def_id);
1066 let hash = hod.as_ref()?.hash;
1067 Some((def_path_hash, hash, def_id))
1070 hir_body_nodes.sort_unstable_by_key(|bn| bn.0);
1072 let upstream_crates = upstream_crates(tcx);
1074 // We hash the final, remapped names of all local source files so we
1075 // don't have to include the path prefix remapping commandline args.
1076 // If we included the full mapping in the SVH, we could only have
1077 // reproducible builds by compiling from the same directory. So we just
1078 // hash the result of the mapping instead of the mapping itself.
1079 let mut source_file_names: Vec<_> = tcx
1084 .filter(|source_file| source_file.cnum == LOCAL_CRATE)
1085 .map(|source_file| source_file.name_hash)
1088 source_file_names.sort_unstable();
1090 let mut stable_hasher = StableHasher::new();
1091 for (def_path_hash, fingerprint, def_id) in hir_body_nodes.iter() {
1092 def_path_hash.0.hash_stable(&mut hcx, &mut stable_hasher);
1093 fingerprint.hash_stable(&mut hcx, &mut stable_hasher);
1094 AttributeMap { map: &tcx.untracked_crate.attrs, prefix: *def_id }
1095 .hash_stable(&mut hcx, &mut stable_hasher);
1096 if tcx.sess.opts.debugging_opts.incremental_relative_spans {
1097 let span = tcx.untracked_resolutions.definitions.def_span(*def_id);
1098 debug_assert_eq!(span.parent(), None);
1099 span.hash_stable(&mut hcx, &mut stable_hasher);
1102 upstream_crates.hash_stable(&mut hcx, &mut stable_hasher);
1103 source_file_names.hash_stable(&mut hcx, &mut stable_hasher);
1104 tcx.sess.opts.dep_tracking_hash(true).hash_stable(&mut hcx, &mut stable_hasher);
1105 tcx.sess.local_stable_crate_id().hash_stable(&mut hcx, &mut stable_hasher);
1107 let crate_hash: Fingerprint = stable_hasher.finish();
1108 Svh::new(crate_hash.to_smaller_hash())
1111 fn upstream_crates(tcx: TyCtxt<'_>) -> Vec<(StableCrateId, Svh)> {
1112 let mut upstream_crates: Vec<_> = tcx
1116 let stable_crate_id = tcx.resolutions(()).cstore.stable_crate_id(cnum);
1117 let hash = tcx.crate_hash(cnum);
1118 (stable_crate_id, hash)
1121 upstream_crates.sort_unstable_by_key(|&(stable_crate_id, _)| stable_crate_id);
1125 fn hir_id_to_string(map: &Map<'_>, id: HirId) -> String {
1126 let id_str = format!(" (hir_id={})", id);
1129 // This functionality is used for debugging, try to use `TyCtxt` to get
1130 // the user-friendly path, otherwise fall back to stringifying `DefPath`.
1131 crate::ty::tls::with_opt(|tcx| {
1132 if let Some(tcx) = tcx {
1133 let def_id = map.local_def_id(id);
1134 tcx.def_path_str(def_id.to_def_id())
1135 } else if let Some(path) = map.def_path_from_hir_id(id) {
1136 path.data.into_iter().map(|elem| elem.to_string()).collect::<Vec<_>>().join("::")
1138 String::from("<missing path>")
1143 let span_str = || map.tcx.sess.source_map().span_to_snippet(map.span(id)).unwrap_or_default();
1144 let node_str = |prefix| format!("{} {}{}", prefix, span_str(), id_str);
1146 match map.find(id) {
1147 Some(Node::Item(item)) => {
1148 let item_str = match item.kind {
1149 ItemKind::ExternCrate(..) => "extern crate",
1150 ItemKind::Use(..) => "use",
1151 ItemKind::Static(..) => "static",
1152 ItemKind::Const(..) => "const",
1153 ItemKind::Fn(..) => "fn",
1154 ItemKind::Macro(..) => "macro",
1155 ItemKind::Mod(..) => "mod",
1156 ItemKind::ForeignMod { .. } => "foreign mod",
1157 ItemKind::GlobalAsm(..) => "global asm",
1158 ItemKind::TyAlias(..) => "ty",
1159 ItemKind::OpaqueTy(..) => "opaque type",
1160 ItemKind::Enum(..) => "enum",
1161 ItemKind::Struct(..) => "struct",
1162 ItemKind::Union(..) => "union",
1163 ItemKind::Trait(..) => "trait",
1164 ItemKind::TraitAlias(..) => "trait alias",
1165 ItemKind::Impl { .. } => "impl",
1167 format!("{} {}{}", item_str, path_str(), id_str)
1169 Some(Node::ForeignItem(_)) => format!("foreign item {}{}", path_str(), id_str),
1170 Some(Node::ImplItem(ii)) => match ii.kind {
1171 ImplItemKind::Const(..) => {
1172 format!("assoc const {} in {}{}", ii.ident, path_str(), id_str)
1174 ImplItemKind::Fn(..) => format!("method {} in {}{}", ii.ident, path_str(), id_str),
1175 ImplItemKind::TyAlias(_) => {
1176 format!("assoc type {} in {}{}", ii.ident, path_str(), id_str)
1179 Some(Node::TraitItem(ti)) => {
1180 let kind = match ti.kind {
1181 TraitItemKind::Const(..) => "assoc constant",
1182 TraitItemKind::Fn(..) => "trait method",
1183 TraitItemKind::Type(..) => "assoc type",
1186 format!("{} {} in {}{}", kind, ti.ident, path_str(), id_str)
1188 Some(Node::Variant(ref variant)) => {
1189 format!("variant {} in {}{}", variant.ident, path_str(), id_str)
1191 Some(Node::Field(ref field)) => {
1192 format!("field {} in {}{}", field.ident, path_str(), id_str)
1194 Some(Node::AnonConst(_)) => node_str("const"),
1195 Some(Node::Expr(_)) => node_str("expr"),
1196 Some(Node::Stmt(_)) => node_str("stmt"),
1197 Some(Node::PathSegment(_)) => node_str("path segment"),
1198 Some(Node::Ty(_)) => node_str("type"),
1199 Some(Node::TraitRef(_)) => node_str("trait ref"),
1200 Some(Node::Binding(_)) => node_str("local"),
1201 Some(Node::Pat(_)) => node_str("pat"),
1202 Some(Node::Param(_)) => node_str("param"),
1203 Some(Node::Arm(_)) => node_str("arm"),
1204 Some(Node::Block(_)) => node_str("block"),
1205 Some(Node::Infer(_)) => node_str("infer"),
1206 Some(Node::Local(_)) => node_str("local"),
1207 Some(Node::Ctor(..)) => format!("ctor {}{}", path_str(), id_str),
1208 Some(Node::Lifetime(_)) => node_str("lifetime"),
1209 Some(Node::GenericParam(ref param)) => format!("generic_param {:?}{}", param, id_str),
1210 Some(Node::Visibility(ref vis)) => format!("visibility {:?}{}", vis, id_str),
1211 Some(Node::Crate(..)) => String::from("root_crate"),
1212 None => format!("unknown node{}", id_str),
1216 pub(super) fn hir_module_items(tcx: TyCtxt<'_>, module_id: LocalDefId) -> ModuleItems {
1217 let mut collector = ModuleCollector {
1219 submodules: Vec::default(),
1220 items: Vec::default(),
1221 trait_items: Vec::default(),
1222 impl_items: Vec::default(),
1223 foreign_items: Vec::default(),
1226 let (hir_mod, span, hir_id) = tcx.hir().get_module(module_id);
1227 collector.visit_mod(hir_mod, span, hir_id);
1229 let ModuleCollector { submodules, items, trait_items, impl_items, foreign_items, .. } =
1231 return ModuleItems {
1232 submodules: submodules.into_boxed_slice(),
1233 items: items.into_boxed_slice(),
1234 trait_items: trait_items.into_boxed_slice(),
1235 impl_items: impl_items.into_boxed_slice(),
1236 foreign_items: foreign_items.into_boxed_slice(),
1239 struct ModuleCollector<'tcx> {
1241 submodules: Vec<LocalDefId>,
1243 trait_items: Vec<TraitItemId>,
1244 impl_items: Vec<ImplItemId>,
1245 foreign_items: Vec<ForeignItemId>,
1248 impl<'hir> Visitor<'hir> for ModuleCollector<'hir> {
1249 type Map = Map<'hir>;
1251 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
1252 intravisit::NestedVisitorMap::All(self.tcx.hir())
1255 fn visit_item(&mut self, item: &'hir Item<'hir>) {
1256 self.items.push(item.item_id());
1257 if let ItemKind::Mod(..) = item.kind {
1258 // If this declares another module, do not recurse inside it.
1259 self.submodules.push(item.def_id);
1261 intravisit::walk_item(self, item)
1265 fn visit_trait_item(&mut self, item: &'hir TraitItem<'hir>) {
1266 self.trait_items.push(item.trait_item_id());
1267 intravisit::walk_trait_item(self, item)
1270 fn visit_impl_item(&mut self, item: &'hir ImplItem<'hir>) {
1271 self.impl_items.push(item.impl_item_id());
1272 intravisit::walk_impl_item(self, item)
1275 fn visit_foreign_item(&mut self, item: &'hir ForeignItem<'hir>) {
1276 self.foreign_items.push(item.foreign_item_id());
1277 intravisit::walk_foreign_item(self, item)