src/librustc/hir/map/collector.rs

   1 use super::*;
   2 use crate::dep_graph::{DepGraph, DepKind, DepNodeIndex};
   3 use crate::hir;
   4 use crate::hir::map::HirEntryMap;
   5 use crate::hir::def_id::{LOCAL_CRATE, CrateNum};
   6 use crate::hir::intravisit::{Visitor, NestedVisitorMap};
   7 use rustc_data_structures::svh::Svh;
   8 use rustc_index::vec::IndexVec;
   9 use crate::ich::Fingerprint;
  10 use crate::middle::cstore::CrateStore;
  11 use crate::session::CrateDisambiguator;
  12 use crate::session::Session;
  13 use crate::util::nodemap::FxHashMap;
  14 use syntax::ast::NodeId;
  15 use syntax::source_map::SourceMap;
  16 use syntax_pos::Span;
  17 use std::iter::repeat;
  18
  19 use crate::ich::StableHashingContext;
  20 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
  21
  22 /// A visitor that walks over the HIR and collects `Node`s into a HIR map.
  23 pub(super) struct NodeCollector<'a, 'hir> {
  24     /// The crate
  25     krate: &'hir Crate<'hir>,
  26
  27     /// Source map
  28     source_map: &'a SourceMap,
  29
  30     /// The node map
  31     map: HirEntryMap<'hir>,
  32     /// The parent of this node
  33     parent_node: hir::HirId,
  34
  35     // These fields keep track of the currently relevant DepNodes during
  36     // the visitor's traversal.
  37     current_dep_node_owner: DefIndex,
  38     current_signature_dep_index: DepNodeIndex,
  39     current_full_dep_index: DepNodeIndex,
  40     currently_in_body: bool,
  41
  42     dep_graph: &'a DepGraph,
  43     definitions: &'a definitions::Definitions,
  44     hir_to_node_id: &'a FxHashMap<HirId, NodeId>,
  45
  46     hcx: StableHashingContext<'a>,
  47
  48     // We are collecting `DepNode::HirBody` hashes here so we can compute the
  49     // crate hash from then later on.
  50     hir_body_nodes: Vec<(DefPathHash, Fingerprint)>,
  51 }
  52
  53 fn input_dep_node_and_hash<I>(
  54     dep_graph: &DepGraph,
  55     hcx: &mut StableHashingContext<'_>,
  56     dep_node: DepNode,
  57     input: I,
  58 ) -> (DepNodeIndex, Fingerprint)
  59 where
  60     I: for<'a> HashStable<StableHashingContext<'a>>,
  61 {
  62     let dep_node_index = dep_graph.input_task(dep_node, &mut *hcx, &input).1;
  63
  64     let hash = if dep_graph.is_fully_enabled() {
  65         dep_graph.fingerprint_of(dep_node_index)
  66     } else {
  67         let mut stable_hasher = StableHasher::new();
  68         input.hash_stable(hcx, &mut stable_hasher);
  69         stable_hasher.finish()
  70     };
  71
  72     (dep_node_index, hash)
  73 }
  74
  75 fn alloc_hir_dep_nodes<I>(
  76     dep_graph: &DepGraph,
  77     hcx: &mut StableHashingContext<'_>,
  78     def_path_hash: DefPathHash,
  79     item_like: I,
  80     hir_body_nodes: &mut Vec<(DefPathHash, Fingerprint)>,
  81 ) -> (DepNodeIndex, DepNodeIndex)
  82 where
  83     I: for<'a> HashStable<StableHashingContext<'a>>,
  84 {
  85     let sig = dep_graph.input_task(
  86         def_path_hash.to_dep_node(DepKind::Hir),
  87         &mut *hcx,
  88         HirItemLike { item_like: &item_like, hash_bodies: false },
  89     ).1;
  90     let (full, hash) = input_dep_node_and_hash(
  91         dep_graph,
  92         hcx,
  93         def_path_hash.to_dep_node(DepKind::HirBody),
  94         HirItemLike { item_like: &item_like, hash_bodies: true },
  95     );
  96     hir_body_nodes.push((def_path_hash, hash));
  97     (sig, full)
  98 }
  99
 100 impl<'a, 'hir> NodeCollector<'a, 'hir> {
 101     pub(super) fn root(sess: &'a Session,
 102                        krate: &'hir Crate<'hir>,
 103                        dep_graph: &'a DepGraph,
 104                        definitions: &'a definitions::Definitions,
 105                        hir_to_node_id: &'a FxHashMap<HirId, NodeId>,
 106                        mut hcx: StableHashingContext<'a>)
 107                 -> NodeCollector<'a, 'hir> {
 108         let root_mod_def_path_hash = definitions.def_path_hash(CRATE_DEF_INDEX);
 109
 110         let mut hir_body_nodes = Vec::new();
 111
 112         // Allocate `DepNode`s for the root module.
 113         let (root_mod_sig_dep_index, root_mod_full_dep_index) = {
 114             let Crate {
 115                 ref module,
 116                 // Crate attributes are not copied over to the root `Mod`, so hash
 117                 // them explicitly here.
 118                 ref attrs,
 119                 span,
 120                 // These fields are handled separately:
 121                 exported_macros: _,
 122                 non_exported_macro_attrs: _,
 123                 items: _,
 124                 trait_items: _,
 125                 impl_items: _,
 126                 bodies: _,
 127                 trait_impls: _,
 128                 body_ids: _,
 129                 modules: _,
 130             } = *krate;
 131
 132             alloc_hir_dep_nodes(
 133                 dep_graph,
 134                 &mut hcx,
 135                 root_mod_def_path_hash,
 136                 (module, attrs, span),
 137                 &mut hir_body_nodes,
 138             )
 139         };
 140
 141         {
 142             dep_graph.input_task(
 143                 DepNode::new_no_params(DepKind::AllLocalTraitImpls),
 144                 &mut hcx,
 145                 &krate.trait_impls,
 146             );
 147         }
 148
 149         let mut collector = NodeCollector {
 150             krate,
 151             source_map: sess.source_map(),
 152             map: IndexVec::from_elem_n(IndexVec::new(), definitions.def_index_count()),
 153             parent_node: hir::CRATE_HIR_ID,
 154             current_signature_dep_index: root_mod_sig_dep_index,
 155             current_full_dep_index: root_mod_full_dep_index,
 156             current_dep_node_owner: CRATE_DEF_INDEX,
 157             currently_in_body: false,
 158             dep_graph,
 159             definitions,
 160             hir_to_node_id,
 161             hcx,
 162             hir_body_nodes,
 163         };
 164         collector.insert_entry(hir::CRATE_HIR_ID, Entry {
 165             parent: hir::CRATE_HIR_ID,
 166             dep_node: root_mod_sig_dep_index,
 167             node: Node::Crate,
 168         });
 169
 170         collector
 171     }
 172
 173     pub(super) fn finalize_and_compute_crate_hash(mut self,
 174                                                   crate_disambiguator: CrateDisambiguator,
 175                                                   cstore: &dyn CrateStore,
 176                                                   commandline_args_hash: u64)
 177                                                   -> (HirEntryMap<'hir>, Svh)
 178     {
 179         self.hir_body_nodes.sort_unstable_by_key(|bn| bn.0);
 180
 181         let node_hashes = self
 182             .hir_body_nodes
 183             .iter()
 184             .fold(Fingerprint::ZERO, |combined_fingerprint, &(def_path_hash, fingerprint)| {
 185                 combined_fingerprint.combine(def_path_hash.0.combine(fingerprint))
 186             });
 187
 188         let mut upstream_crates: Vec<_> = cstore.crates_untracked().iter().map(|&cnum| {
 189             let name = cstore.crate_name_untracked(cnum);
 190             let disambiguator = cstore.crate_disambiguator_untracked(cnum).to_fingerprint();
 191             let hash = cstore.crate_hash_untracked(cnum);
 192             (name, disambiguator, hash)
 193         }).collect();
 194
 195         upstream_crates.sort_unstable_by_key(|&(name, dis, _)| (name.as_str(), dis));
 196
 197         // We hash the final, remapped names of all local source files so we
 198         // don't have to include the path prefix remapping commandline args.
 199         // If we included the full mapping in the SVH, we could only have
 200         // reproducible builds by compiling from the same directory. So we just
 201         // hash the result of the mapping instead of the mapping itself.
 202         let mut source_file_names: Vec<_> = self
 203             .source_map
 204             .files()
 205             .iter()
 206             .filter(|source_file| CrateNum::from_u32(source_file.crate_of_origin) == LOCAL_CRATE)
 207             .map(|source_file| source_file.name_hash)
 208             .collect();
 209
 210         source_file_names.sort_unstable();
 211
 212         let crate_hash_input = (
 213             ((node_hashes, upstream_crates), source_file_names),
 214             (commandline_args_hash, crate_disambiguator.to_fingerprint())
 215         );
 216
 217         let (_, crate_hash) = input_dep_node_and_hash(
 218             self.dep_graph,
 219             &mut self.hcx,
 220             DepNode::new_no_params(DepKind::Krate),
 221             crate_hash_input,
 222         );
 223
 224         let svh = Svh::new(crate_hash.to_smaller_hash());
 225         (self.map, svh)
 226     }
 227
 228     fn insert_entry(&mut self, id: HirId, entry: Entry<'hir>) {
 229         debug!("hir_map: {:?} => {:?}", id, entry);
 230         let local_map = &mut self.map[id.owner];
 231         let i = id.local_id.as_u32() as usize;
 232         let len = local_map.len();
 233         if i >= len {
 234             local_map.extend(repeat(None).take(i - len + 1));
 235         }
 236         local_map[id.local_id] = Some(entry);
 237     }
 238
 239     fn insert(&mut self, span: Span, hir_id: HirId, node: Node<'hir>) {
 240         let entry = Entry {
 241             parent: self.parent_node,
 242             dep_node: if self.currently_in_body {
 243                 self.current_full_dep_index
 244             } else {
 245                 self.current_signature_dep_index
 246             },
 247             node,
 248         };
 249
 250         // Make sure that the DepNode of some node coincides with the HirId
 251         // owner of that node.
 252         if cfg!(debug_assertions) {
 253             let node_id = self.hir_to_node_id[&hir_id];
 254             assert_eq!(self.definitions.node_to_hir_id(node_id), hir_id);
 255
 256             if hir_id.owner != self.current_dep_node_owner {
 257                 let node_str = match self.definitions.opt_def_index(node_id) {
 258                     Some(def_index) => {
 259                         self.definitions.def_path(def_index).to_string_no_crate()
 260                     }
 261                     None => format!("{:?}", node)
 262                 };
 263
 264                 let forgot_str = if hir_id == crate::hir::DUMMY_HIR_ID {
 265                     format!("\nMaybe you forgot to lower the node id {:?}?", node_id)
 266                 } else {
 267                     String::new()
 268                 };
 269
 270                 span_bug!(
 271                     span,
 272                     "inconsistent DepNode at `{:?}` for `{}`: \
 273                      current_dep_node_owner={} ({:?}), hir_id.owner={} ({:?}){}",
 274                     self.source_map.span_to_string(span),
 275                     node_str,
 276                     self.definitions
 277                         .def_path(self.current_dep_node_owner)
 278                         .to_string_no_crate(),
 279                     self.current_dep_node_owner,
 280                     self.definitions.def_path(hir_id.owner).to_string_no_crate(),
 281                     hir_id.owner,
 282                     forgot_str,
 283                 )
 284             }
 285         }
 286
 287         self.insert_entry(hir_id, entry);
 288     }
 289
 290     fn with_parent<F: FnOnce(&mut Self)>(
 291         &mut self,
 292         parent_node_id: HirId,
 293         f: F,
 294     ) {
 295         let parent_node = self.parent_node;
 296         self.parent_node = parent_node_id;
 297         f(self);
 298         self.parent_node = parent_node;
 299     }
 300
 301     fn with_dep_node_owner<T: for<'b> HashStable<StableHashingContext<'b>>,
 302                            F: FnOnce(&mut Self)>(&mut self,
 303                                                  dep_node_owner: DefIndex,
 304                                                  item_like: &T,
 305                                                  f: F) {
 306         let prev_owner = self.current_dep_node_owner;
 307         let prev_signature_dep_index = self.current_signature_dep_index;
 308         let prev_full_dep_index = self.current_full_dep_index;
 309         let prev_in_body = self.currently_in_body;
 310
 311         let def_path_hash = self.definitions.def_path_hash(dep_node_owner);
 312
 313         let (signature_dep_index, full_dep_index) = alloc_hir_dep_nodes(
 314             self.dep_graph,
 315             &mut self.hcx,
 316             def_path_hash,
 317             item_like,
 318             &mut self.hir_body_nodes,
 319         );
 320         self.current_signature_dep_index = signature_dep_index;
 321         self.current_full_dep_index = full_dep_index;
 322
 323         self.current_dep_node_owner = dep_node_owner;
 324         self.currently_in_body = false;
 325         f(self);
 326         self.currently_in_body = prev_in_body;
 327         self.current_dep_node_owner = prev_owner;
 328         self.current_full_dep_index = prev_full_dep_index;
 329         self.current_signature_dep_index = prev_signature_dep_index;
 330     }
 331 }
 332
 333 impl<'a, 'hir> Visitor<'hir> for NodeCollector<'a, 'hir> {
 334     /// Because we want to track parent items and so forth, enable
 335     /// deep walking so that we walk nested items in the context of
 336     /// their outer items.
 337
 338     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'hir> {
 339         panic!("`visit_nested_xxx` must be manually implemented in this visitor");
 340     }
 341
 342     fn visit_nested_item(&mut self, item: ItemId) {
 343         debug!("visit_nested_item: {:?}", item);
 344         self.visit_item(self.krate.item(item.id));
 345     }
 346
 347     fn visit_nested_trait_item(&mut self, item_id: TraitItemId) {
 348         self.visit_trait_item(self.krate.trait_item(item_id));
 349     }
 350
 351     fn visit_nested_impl_item(&mut self, item_id: ImplItemId) {
 352         self.visit_impl_item(self.krate.impl_item(item_id));
 353     }
 354
 355     fn visit_nested_body(&mut self, id: BodyId) {
 356         let prev_in_body = self.currently_in_body;
 357         self.currently_in_body = true;
 358         self.visit_body(self.krate.body(id));
 359         self.currently_in_body = prev_in_body;
 360     }
 361
 362     fn visit_param(&mut self, param: &'hir Param) {
 363         let node = Node::Param(param);
 364         self.insert(param.pat.span, param.hir_id, node);
 365         self.with_parent(param.hir_id, |this| {
 366             intravisit::walk_param(this, param);
 367         });
 368     }
 369
 370     fn visit_item(&mut self, i: &'hir Item<'hir>) {
 371         debug!("visit_item: {:?}", i);
 372         debug_assert_eq!(i.hir_id.owner,
 373                          self.definitions.opt_def_index(self.hir_to_node_id[&i.hir_id]).unwrap());
 374         self.with_dep_node_owner(i.hir_id.owner, i, |this| {
 375             this.insert(i.span, i.hir_id, Node::Item(i));
 376             this.with_parent(i.hir_id, |this| {
 377                 if let ItemKind::Struct(ref struct_def, _) = i.kind {
 378                     // If this is a tuple or unit-like struct, register the constructor.
 379                     if let Some(ctor_hir_id) = struct_def.ctor_hir_id() {
 380                         this.insert(i.span, ctor_hir_id, Node::Ctor(struct_def));
 381                     }
 382                 }
 383                 intravisit::walk_item(this, i);
 384             });
 385         });
 386     }
 387
 388     fn visit_foreign_item(&mut self, foreign_item: &'hir ForeignItem<'hir>) {
 389         self.insert(foreign_item.span, foreign_item.hir_id, Node::ForeignItem(foreign_item));
 390
 391         self.with_parent(foreign_item.hir_id, |this| {
 392             intravisit::walk_foreign_item(this, foreign_item);
 393         });
 394     }
 395
 396     fn visit_generic_param(&mut self, param: &'hir GenericParam) {
 397         self.insert(param.span, param.hir_id, Node::GenericParam(param));
 398         intravisit::walk_generic_param(self, param);
 399     }
 400
 401     fn visit_trait_item(&mut self, ti: &'hir TraitItem<'hir>) {
 402         debug_assert_eq!(ti.hir_id.owner,
 403                          self.definitions.opt_def_index(self.hir_to_node_id[&ti.hir_id]).unwrap());
 404         self.with_dep_node_owner(ti.hir_id.owner, ti, |this| {
 405             this.insert(ti.span, ti.hir_id, Node::TraitItem(ti));
 406
 407             this.with_parent(ti.hir_id, |this| {
 408                 intravisit::walk_trait_item(this, ti);
 409             });
 410         });
 411     }
 412
 413     fn visit_impl_item(&mut self, ii: &'hir ImplItem<'hir>) {
 414         debug_assert_eq!(ii.hir_id.owner,
 415                          self.definitions.opt_def_index(self.hir_to_node_id[&ii.hir_id]).unwrap());
 416         self.with_dep_node_owner(ii.hir_id.owner, ii, |this| {
 417             this.insert(ii.span, ii.hir_id, Node::ImplItem(ii));
 418
 419             this.with_parent(ii.hir_id, |this| {
 420                 intravisit::walk_impl_item(this, ii);
 421             });
 422         });
 423     }
 424
 425     fn visit_pat(&mut self, pat: &'hir Pat) {
 426         let node = if let PatKind::Binding(..) = pat.kind {
 427             Node::Binding(pat)
 428         } else {
 429             Node::Pat(pat)
 430         };
 431         self.insert(pat.span, pat.hir_id, node);
 432
 433         self.with_parent(pat.hir_id, |this| {
 434             intravisit::walk_pat(this, pat);
 435         });
 436     }
 437
 438     fn visit_arm(&mut self, arm: &'hir Arm) {
 439         let node = Node::Arm(arm);
 440
 441         self.insert(arm.span, arm.hir_id, node);
 442
 443         self.with_parent(arm.hir_id, |this| {
 444             intravisit::walk_arm(this, arm);
 445         });
 446     }
 447
 448     fn visit_anon_const(&mut self, constant: &'hir AnonConst) {
 449         self.insert(DUMMY_SP, constant.hir_id, Node::AnonConst(constant));
 450
 451         self.with_parent(constant.hir_id, |this| {
 452             intravisit::walk_anon_const(this, constant);
 453         });
 454     }
 455
 456     fn visit_expr(&mut self, expr: &'hir Expr) {
 457         self.insert(expr.span, expr.hir_id, Node::Expr(expr));
 458
 459         self.with_parent(expr.hir_id, |this| {
 460             intravisit::walk_expr(this, expr);
 461         });
 462     }
 463
 464     fn visit_stmt(&mut self, stmt: &'hir Stmt) {
 465         self.insert(stmt.span, stmt.hir_id, Node::Stmt(stmt));
 466
 467         self.with_parent(stmt.hir_id, |this| {
 468             intravisit::walk_stmt(this, stmt);
 469         });
 470     }
 471
 472     fn visit_path_segment(&mut self, path_span: Span, path_segment: &'hir PathSegment) {
 473         if let Some(hir_id) = path_segment.hir_id {
 474             self.insert(path_span, hir_id, Node::PathSegment(path_segment));
 475         }
 476         intravisit::walk_path_segment(self, path_span, path_segment);
 477     }
 478
 479     fn visit_ty(&mut self, ty: &'hir Ty) {
 480         self.insert(ty.span, ty.hir_id, Node::Ty(ty));
 481
 482         self.with_parent(ty.hir_id, |this| {
 483             intravisit::walk_ty(this, ty);
 484         });
 485     }
 486
 487     fn visit_trait_ref(&mut self, tr: &'hir TraitRef) {
 488         self.insert(tr.path.span, tr.hir_ref_id, Node::TraitRef(tr));
 489
 490         self.with_parent(tr.hir_ref_id, |this| {
 491             intravisit::walk_trait_ref(this, tr);
 492         });
 493     }
 494
 495     fn visit_fn(&mut self, fk: intravisit::FnKind<'hir>, fd: &'hir FnDecl,
 496                 b: BodyId, s: Span, id: HirId) {
 497         assert_eq!(self.parent_node, id);
 498         intravisit::walk_fn(self, fk, fd, b, s, id);
 499     }
 500
 501     fn visit_block(&mut self, block: &'hir Block) {
 502         self.insert(block.span, block.hir_id, Node::Block(block));
 503         self.with_parent(block.hir_id, |this| {
 504             intravisit::walk_block(this, block);
 505         });
 506     }
 507
 508     fn visit_local(&mut self, l: &'hir Local) {
 509         self.insert(l.span, l.hir_id, Node::Local(l));
 510         self.with_parent(l.hir_id, |this| {
 511             intravisit::walk_local(this, l)
 512         })
 513     }
 514
 515     fn visit_lifetime(&mut self, lifetime: &'hir Lifetime) {
 516         self.insert(lifetime.span, lifetime.hir_id, Node::Lifetime(lifetime));
 517     }
 518
 519     fn visit_vis(&mut self, visibility: &'hir Visibility) {
 520         match visibility.node {
 521             VisibilityKind::Public |
 522             VisibilityKind::Crate(_) |
 523             VisibilityKind::Inherited => {}
 524             VisibilityKind::Restricted { hir_id, .. } => {
 525                 self.insert(visibility.span, hir_id, Node::Visibility(visibility));
 526                 self.with_parent(hir_id, |this| {
 527                     intravisit::walk_vis(this, visibility);
 528                 });
 529             }
 530         }
 531     }
 532
 533     fn visit_macro_def(&mut self, macro_def: &'hir MacroDef<'hir>) {
 534         let node_id = self.hir_to_node_id[&macro_def.hir_id];
 535         let def_index = self.definitions.opt_def_index(node_id).unwrap();
 536
 537         self.with_dep_node_owner(def_index, macro_def, |this| {
 538             this.insert(macro_def.span, macro_def.hir_id, Node::MacroDef(macro_def));
 539         });
 540     }
 541
 542     fn visit_variant(&mut self, v: &'hir Variant, g: &'hir Generics, item_id: HirId) {
 543         self.insert(v.span, v.id, Node::Variant(v));
 544         self.with_parent(v.id, |this| {
 545             // Register the constructor of this variant.
 546             if let Some(ctor_hir_id) = v.data.ctor_hir_id() {
 547                 this.insert(v.span, ctor_hir_id, Node::Ctor(&v.data));
 548             }
 549             intravisit::walk_variant(this, v, g, item_id);
 550         });
 551     }
 552
 553     fn visit_struct_field(&mut self, field: &'hir StructField) {
 554         self.insert(field.span, field.hir_id, Node::Field(field));
 555         self.with_parent(field.hir_id, |this| {
 556             intravisit::walk_struct_field(this, field);
 557         });
 558     }
 559
 560     fn visit_trait_item_ref(&mut self, ii: &'hir TraitItemRef) {
 561         // Do not visit the duplicate information in TraitItemRef. We want to
 562         // map the actual nodes, not the duplicate ones in the *Ref.
 563         let TraitItemRef {
 564             id,
 565             ident: _,
 566             kind: _,
 567             span: _,
 568             defaultness: _,
 569         } = *ii;
 570
 571         self.visit_nested_trait_item(id);
 572     }
 573
 574     fn visit_impl_item_ref(&mut self, ii: &'hir ImplItemRef) {
 575         // Do not visit the duplicate information in ImplItemRef. We want to
 576         // map the actual nodes, not the duplicate ones in the *Ref.
 577         let ImplItemRef {
 578             id,
 579             ident: _,
 580             kind: _,
 581             span: _,
 582             vis: _,
 583             defaultness: _,
 584         } = *ii;
 585
 586         self.visit_nested_impl_item(id);
 587     }
 588 }
 589
 590 // This is a wrapper structure that allows determining if span values within
 591 // the wrapped item should be hashed or not.
 592 struct HirItemLike<T> {
 593     item_like: T,
 594     hash_bodies: bool,
 595 }
 596
 597 impl<'hir, T> HashStable<StableHashingContext<'hir>> for HirItemLike<T>
 598 where
 599     T: HashStable<StableHashingContext<'hir>>,
 600 {
 601     fn hash_stable(&self, hcx: &mut StableHashingContext<'hir>, hasher: &mut StableHasher) {
 602         hcx.while_hashing_hir_bodies(self.hash_bodies, |hcx| {
 603             self.item_like.hash_stable(hcx, hasher);
 604         });
 605     }
 606 }