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