compiler/rustc_ast_lowering/src/index.rs

   1 use rustc_data_structures::fx::FxHashMap;
   2 use rustc_data_structures::sorted_map::SortedMap;
   3 use rustc_hir as hir;
   4 use rustc_hir::def_id::LocalDefId;
   5 use rustc_hir::definitions;
   6 use rustc_hir::intravisit::{self, Visitor};
   7 use rustc_hir::*;
   8 use rustc_index::vec::{Idx, IndexVec};
   9 use rustc_session::Session;
  10 use rustc_span::source_map::SourceMap;
  11 use rustc_span::{Span, DUMMY_SP};
  12
  13 use tracing::debug;
  14
  15 /// A visitor that walks over the HIR and collects `Node`s into a HIR map.
  16 pub(super) struct NodeCollector<'a, 'hir> {
  17     /// Source map
  18     source_map: &'a SourceMap,
  19     bodies: &'a SortedMap<ItemLocalId, &'hir Body<'hir>>,
  20
  21     /// Outputs
  22     nodes: IndexVec<ItemLocalId, Option<ParentedNode<'hir>>>,
  23     parenting: FxHashMap<LocalDefId, ItemLocalId>,
  24
  25     /// The parent of this node
  26     parent_node: hir::ItemLocalId,
  27
  28     owner: LocalDefId,
  29
  30     definitions: &'a definitions::Definitions,
  31 }
  32
  33 pub(super) fn index_hir<'hir>(
  34     sess: &Session,
  35     definitions: &definitions::Definitions,
  36     item: hir::OwnerNode<'hir>,
  37     bodies: &SortedMap<ItemLocalId, &'hir Body<'hir>>,
  38 ) -> (IndexVec<ItemLocalId, Option<ParentedNode<'hir>>>, FxHashMap<LocalDefId, ItemLocalId>) {
  39     let mut nodes = IndexVec::new();
  40     // This node's parent should never be accessed: the owner's parent is computed by the
  41     // hir_owner_parent query.  Make it invalid (= ItemLocalId::MAX) to force an ICE whenever it is
  42     // used.
  43     nodes.push(Some(ParentedNode { parent: ItemLocalId::INVALID, node: item.into() }));
  44     let mut collector = NodeCollector {
  45         source_map: sess.source_map(),
  46         definitions,
  47         owner: item.def_id(),
  48         parent_node: ItemLocalId::new(0),
  49         nodes,
  50         bodies,
  51         parenting: FxHashMap::default(),
  52     };
  53
  54     match item {
  55         OwnerNode::Crate(citem) => collector.visit_mod(&citem, citem.inner, hir::CRATE_HIR_ID),
  56         OwnerNode::Item(item) => collector.visit_item(item),
  57         OwnerNode::TraitItem(item) => collector.visit_trait_item(item),
  58         OwnerNode::ImplItem(item) => collector.visit_impl_item(item),
  59         OwnerNode::ForeignItem(item) => collector.visit_foreign_item(item),
  60     };
  61
  62     (collector.nodes, collector.parenting)
  63 }
  64
  65 impl<'a, 'hir> NodeCollector<'a, 'hir> {
  66     fn insert(&mut self, span: Span, hir_id: HirId, node: Node<'hir>) {
  67         debug_assert_eq!(self.owner, hir_id.owner);
  68         debug_assert_ne!(hir_id.local_id.as_u32(), 0);
  69
  70         // Make sure that the DepNode of some node coincides with the HirId
  71         // owner of that node.
  72         if cfg!(debug_assertions) {
  73             if hir_id.owner != self.owner {
  74                 panic!(
  75                     "inconsistent DepNode at `{:?}` for `{:?}`: \
  76                      current_dep_node_owner={} ({:?}), hir_id.owner={} ({:?})",
  77                     self.source_map.span_to_diagnostic_string(span),
  78                     node,
  79                     self.definitions.def_path(self.owner).to_string_no_crate_verbose(),
  80                     self.owner,
  81                     self.definitions.def_path(hir_id.owner).to_string_no_crate_verbose(),
  82                     hir_id.owner,
  83                 )
  84             }
  85         }
  86
  87         self.nodes.insert(hir_id.local_id, ParentedNode { parent: self.parent_node, node: node });
  88     }
  89
  90     fn with_parent<F: FnOnce(&mut Self)>(&mut self, parent_node_id: HirId, f: F) {
  91         debug_assert_eq!(parent_node_id.owner, self.owner);
  92         let parent_node = self.parent_node;
  93         self.parent_node = parent_node_id.local_id;
  94         f(self);
  95         self.parent_node = parent_node;
  96     }
  97
  98     fn insert_nested(&mut self, item: LocalDefId) {
  99         self.parenting.insert(item, self.parent_node);
 100     }
 101 }
 102
 103 impl<'a, 'hir> Visitor<'hir> for NodeCollector<'a, 'hir> {
 104     /// Because we want to track parent items and so forth, enable
 105     /// deep walking so that we walk nested items in the context of
 106     /// their outer items.
 107
 108     fn visit_nested_item(&mut self, item: ItemId) {
 109         debug!("visit_nested_item: {:?}", item);
 110         self.insert_nested(item.def_id);
 111     }
 112
 113     fn visit_nested_trait_item(&mut self, item_id: TraitItemId) {
 114         self.insert_nested(item_id.def_id);
 115     }
 116
 117     fn visit_nested_impl_item(&mut self, item_id: ImplItemId) {
 118         self.insert_nested(item_id.def_id);
 119     }
 120
 121     fn visit_nested_foreign_item(&mut self, foreign_id: ForeignItemId) {
 122         self.insert_nested(foreign_id.def_id);
 123     }
 124
 125     fn visit_nested_body(&mut self, id: BodyId) {
 126         debug_assert_eq!(id.hir_id.owner, self.owner);
 127         let body = self.bodies[&id.hir_id.local_id];
 128         self.visit_body(body);
 129     }
 130
 131     fn visit_param(&mut self, param: &'hir Param<'hir>) {
 132         let node = Node::Param(param);
 133         self.insert(param.pat.span, param.hir_id, node);
 134         self.with_parent(param.hir_id, |this| {
 135             intravisit::walk_param(this, param);
 136         });
 137     }
 138
 139     fn visit_item(&mut self, i: &'hir Item<'hir>) {
 140         debug!("visit_item: {:?}", i);
 141         debug_assert_eq!(i.def_id, self.owner);
 142         self.with_parent(i.hir_id(), |this| {
 143             if let ItemKind::Struct(ref struct_def, _) = i.kind {
 144                 // If this is a tuple or unit-like struct, register the constructor.
 145                 if let Some(ctor_hir_id) = struct_def.ctor_hir_id() {
 146                     this.insert(i.span, ctor_hir_id, Node::Ctor(struct_def));
 147                 }
 148             }
 149             intravisit::walk_item(this, i);
 150         });
 151     }
 152
 153     fn visit_foreign_item(&mut self, fi: &'hir ForeignItem<'hir>) {
 154         debug_assert_eq!(fi.def_id, self.owner);
 155         self.with_parent(fi.hir_id(), |this| {
 156             intravisit::walk_foreign_item(this, fi);
 157         });
 158     }
 159
 160     fn visit_generic_param(&mut self, param: &'hir GenericParam<'hir>) {
 161         self.insert(param.span, param.hir_id, Node::GenericParam(param));
 162         intravisit::walk_generic_param(self, param);
 163     }
 164
 165     fn visit_const_param_default(&mut self, param: HirId, ct: &'hir AnonConst) {
 166         self.with_parent(param, |this| {
 167             intravisit::walk_const_param_default(this, ct);
 168         })
 169     }
 170
 171     fn visit_trait_item(&mut self, ti: &'hir TraitItem<'hir>) {
 172         debug_assert_eq!(ti.def_id, self.owner);
 173         self.with_parent(ti.hir_id(), |this| {
 174             intravisit::walk_trait_item(this, ti);
 175         });
 176     }
 177
 178     fn visit_impl_item(&mut self, ii: &'hir ImplItem<'hir>) {
 179         debug_assert_eq!(ii.def_id, self.owner);
 180         self.with_parent(ii.hir_id(), |this| {
 181             intravisit::walk_impl_item(this, ii);
 182         });
 183     }
 184
 185     fn visit_pat(&mut self, pat: &'hir Pat<'hir>) {
 186         let node =
 187             if let PatKind::Binding(..) = pat.kind { Node::Binding(pat) } else { Node::Pat(pat) };
 188         self.insert(pat.span, pat.hir_id, node);
 189
 190         self.with_parent(pat.hir_id, |this| {
 191             intravisit::walk_pat(this, pat);
 192         });
 193     }
 194
 195     fn visit_arm(&mut self, arm: &'hir Arm<'hir>) {
 196         let node = Node::Arm(arm);
 197
 198         self.insert(arm.span, arm.hir_id, node);
 199
 200         self.with_parent(arm.hir_id, |this| {
 201             intravisit::walk_arm(this, arm);
 202         });
 203     }
 204
 205     fn visit_anon_const(&mut self, constant: &'hir AnonConst) {
 206         self.insert(DUMMY_SP, constant.hir_id, Node::AnonConst(constant));
 207
 208         self.with_parent(constant.hir_id, |this| {
 209             intravisit::walk_anon_const(this, constant);
 210         });
 211     }
 212
 213     fn visit_expr(&mut self, expr: &'hir Expr<'hir>) {
 214         self.insert(expr.span, expr.hir_id, Node::Expr(expr));
 215
 216         self.with_parent(expr.hir_id, |this| {
 217             intravisit::walk_expr(this, expr);
 218         });
 219     }
 220
 221     fn visit_stmt(&mut self, stmt: &'hir Stmt<'hir>) {
 222         self.insert(stmt.span, stmt.hir_id, Node::Stmt(stmt));
 223
 224         self.with_parent(stmt.hir_id, |this| {
 225             intravisit::walk_stmt(this, stmt);
 226         });
 227     }
 228
 229     fn visit_path_segment(&mut self, path_span: Span, path_segment: &'hir PathSegment<'hir>) {
 230         if let Some(hir_id) = path_segment.hir_id {
 231             self.insert(path_span, hir_id, Node::PathSegment(path_segment));
 232         }
 233         intravisit::walk_path_segment(self, path_span, path_segment);
 234     }
 235
 236     fn visit_ty(&mut self, ty: &'hir Ty<'hir>) {
 237         self.insert(ty.span, ty.hir_id, Node::Ty(ty));
 238
 239         self.with_parent(ty.hir_id, |this| {
 240             intravisit::walk_ty(this, ty);
 241         });
 242     }
 243
 244     fn visit_infer(&mut self, inf: &'hir InferArg) {
 245         self.insert(inf.span, inf.hir_id, Node::Infer(inf));
 246
 247         self.with_parent(inf.hir_id, |this| {
 248             intravisit::walk_inf(this, inf);
 249         });
 250     }
 251
 252     fn visit_trait_ref(&mut self, tr: &'hir TraitRef<'hir>) {
 253         self.insert(tr.path.span, tr.hir_ref_id, Node::TraitRef(tr));
 254
 255         self.with_parent(tr.hir_ref_id, |this| {
 256             intravisit::walk_trait_ref(this, tr);
 257         });
 258     }
 259
 260     fn visit_fn(
 261         &mut self,
 262         fk: intravisit::FnKind<'hir>,
 263         fd: &'hir FnDecl<'hir>,
 264         b: BodyId,
 265         s: Span,
 266         id: HirId,
 267     ) {
 268         assert_eq!(self.owner, id.owner);
 269         assert_eq!(self.parent_node, id.local_id);
 270         intravisit::walk_fn(self, fk, fd, b, s, id);
 271     }
 272
 273     fn visit_block(&mut self, block: &'hir Block<'hir>) {
 274         self.insert(block.span, block.hir_id, Node::Block(block));
 275         self.with_parent(block.hir_id, |this| {
 276             intravisit::walk_block(this, block);
 277         });
 278     }
 279
 280     fn visit_local(&mut self, l: &'hir Local<'hir>) {
 281         self.insert(l.span, l.hir_id, Node::Local(l));
 282         self.with_parent(l.hir_id, |this| {
 283             intravisit::walk_local(this, l);
 284         })
 285     }
 286
 287     fn visit_lifetime(&mut self, lifetime: &'hir Lifetime) {
 288         self.insert(lifetime.span, lifetime.hir_id, Node::Lifetime(lifetime));
 289     }
 290
 291     fn visit_vis(&mut self, visibility: &'hir Visibility<'hir>) {
 292         match visibility.node {
 293             VisibilityKind::Public | VisibilityKind::Crate(_) | VisibilityKind::Inherited => {}
 294             VisibilityKind::Restricted { hir_id, .. } => {
 295                 self.insert(visibility.span, hir_id, Node::Visibility(visibility));
 296                 self.with_parent(hir_id, |this| {
 297                     intravisit::walk_vis(this, visibility);
 298                 });
 299             }
 300         }
 301     }
 302
 303     fn visit_variant(&mut self, v: &'hir Variant<'hir>, g: &'hir Generics<'hir>, item_id: HirId) {
 304         self.insert(v.span, v.id, Node::Variant(v));
 305         self.with_parent(v.id, |this| {
 306             // Register the constructor of this variant.
 307             if let Some(ctor_hir_id) = v.data.ctor_hir_id() {
 308                 this.insert(v.span, ctor_hir_id, Node::Ctor(&v.data));
 309             }
 310             intravisit::walk_variant(this, v, g, item_id);
 311         });
 312     }
 313
 314     fn visit_field_def(&mut self, field: &'hir FieldDef<'hir>) {
 315         self.insert(field.span, field.hir_id, Node::Field(field));
 316         self.with_parent(field.hir_id, |this| {
 317             intravisit::walk_field_def(this, field);
 318         });
 319     }
 320
 321     fn visit_trait_item_ref(&mut self, ii: &'hir TraitItemRef) {
 322         // Do not visit the duplicate information in TraitItemRef. We want to
 323         // map the actual nodes, not the duplicate ones in the *Ref.
 324         let TraitItemRef { id, ident: _, kind: _, span: _, defaultness: _ } = *ii;
 325
 326         self.visit_nested_trait_item(id);
 327     }
 328
 329     fn visit_impl_item_ref(&mut self, ii: &'hir ImplItemRef) {
 330         // Do not visit the duplicate information in ImplItemRef. We want to
 331         // map the actual nodes, not the duplicate ones in the *Ref.
 332         let ImplItemRef { id, ident: _, kind: _, span: _, defaultness: _, trait_item_def_id: _ } =
 333             *ii;
 334
 335         self.visit_nested_impl_item(id);
 336     }
 337
 338     fn visit_foreign_item_ref(&mut self, fi: &'hir ForeignItemRef) {
 339         // Do not visit the duplicate information in ForeignItemRef. We want to
 340         // map the actual nodes, not the duplicate ones in the *Ref.
 341         let ForeignItemRef { id, ident: _, span: _ } = *fi;
 342
 343         self.visit_nested_foreign_item(id);
 344     }
 345 }