rustc_passes/
hir_id_validator.rs

Help
1use rustc_data_structures::sync::Lock;
2use rustc_hir as hir;
3use rustc_hir::def_id::LocalDefId;
4use rustc_hir::{HirId, ItemLocalId, intravisit};
5use rustc_index::bit_set::GrowableBitSet;
6use rustc_middle::hir::nested_filter;
7use rustc_middle::ty::TyCtxt;
8
9pub fn check_crate(tcx: TyCtxt<'_>) {
10    let errors = Lock::new(Vec::new());
11
12    tcx.hir().par_for_each_module(|module_id| {
13        let mut v =
14            HirIdValidator { tcx, owner: None, hir_ids_seen: Default::default(), errors: &errors };
15
16        tcx.hir().visit_item_likes_in_module(module_id, &mut v);
17    });
18
19    let errors = errors.into_inner();
20
21    if !errors.is_empty() {
22        let message = errors.iter().fold(String::new(), |s1, s2| s1 + "\n" + s2);
23        tcx.dcx().delayed_bug(message);
24    }
25}
26
27struct HirIdValidator<'a, 'hir> {
28    tcx: TyCtxt<'hir>,
29    owner: Option<hir::OwnerId>,
30    hir_ids_seen: GrowableBitSet<ItemLocalId>,
31    errors: &'a Lock<Vec<String>>,
32}
33
34impl<'a, 'hir> HirIdValidator<'a, 'hir> {
35    fn new_visitor(&self, tcx: TyCtxt<'hir>) -> HirIdValidator<'a, 'hir> {
36        HirIdValidator { tcx, owner: None, hir_ids_seen: Default::default(), errors: self.errors }
37    }
38
39    #[cold]
40    #[inline(never)]
41    fn error(&self, f: impl FnOnce() -> String) {
42        self.errors.lock().push(f());
43    }
44
45    fn check<F: FnOnce(&mut HirIdValidator<'a, 'hir>)>(&mut self, owner: hir::OwnerId, walk: F) {
46        assert!(self.owner.is_none());
47        self.owner = Some(owner);
48        walk(self);
49
50        if owner == hir::CRATE_OWNER_ID {
51            return;
52        }
53
54        // There's always at least one entry for the owning item itself
55        let max = self
56            .hir_ids_seen
57            .iter()
58            .map(|local_id| local_id.as_usize())
59            .max()
60            .expect("owning item has no entry");
61
62        if max != self.hir_ids_seen.len() - 1 {
63            let hir = self.tcx.hir();
64            let pretty_owner = hir.def_path(owner.def_id).to_string_no_crate_verbose();
65
66            let missing_items: Vec<_> = (0..=max as u32)
67                .map(|i| ItemLocalId::from_u32(i))
68                .filter(|&local_id| !self.hir_ids_seen.contains(local_id))
69                .map(|local_id| hir.node_to_string(HirId { owner, local_id }))
70                .collect();
71
72            let seen_items: Vec<_> = self
73                .hir_ids_seen
74                .iter()
75                .map(|local_id| hir.node_to_string(HirId { owner, local_id }))
76                .collect();
77
78            self.error(|| {
79                format!(
80                    "ItemLocalIds not assigned densely in {pretty_owner}. \
81            Max ItemLocalId = {max}, missing IDs = {missing_items:#?}; seen IDs = {seen_items:#?}"
82                )
83            });
84        }
85    }
86
87    fn check_nested_id(&mut self, id: LocalDefId) {
88        let Some(owner) = self.owner else { return };
89        let def_parent = self.tcx.local_parent(id);
90        let def_parent_hir_id = self.tcx.local_def_id_to_hir_id(def_parent);
91        if def_parent_hir_id.owner != owner {
92            self.error(|| {
93                format!(
94                    "inconsistent Def parent at `{:?}` for `{:?}`:\nexpected={:?}\nfound={:?}",
95                    self.tcx.def_span(id),
96                    id,
97                    owner,
98                    def_parent_hir_id
99                )
100            });
101        }
102    }
103}
104
105impl<'a, 'hir> intravisit::Visitor<'hir> for HirIdValidator<'a, 'hir> {
106    type NestedFilter = nested_filter::OnlyBodies;
107
108    fn nested_visit_map(&mut self) -> Self::Map {
109        self.tcx.hir()
110    }
111
112    fn visit_nested_item(&mut self, id: hir::ItemId) {
113        self.check_nested_id(id.owner_id.def_id);
114    }
115
116    fn visit_nested_trait_item(&mut self, id: hir::TraitItemId) {
117        self.check_nested_id(id.owner_id.def_id);
118    }
119
120    fn visit_nested_impl_item(&mut self, id: hir::ImplItemId) {
121        self.check_nested_id(id.owner_id.def_id);
122    }
123
124    fn visit_nested_foreign_item(&mut self, id: hir::ForeignItemId) {
125        self.check_nested_id(id.owner_id.def_id);
126    }
127
128    fn visit_item(&mut self, i: &'hir hir::Item<'hir>) {
129        let mut inner_visitor = self.new_visitor(self.tcx);
130        inner_visitor.check(i.owner_id, |this| intravisit::walk_item(this, i));
131    }
132
133    fn visit_id(&mut self, hir_id: HirId) {
134        let owner = self.owner.expect("no owner");
135
136        if owner != hir_id.owner {
137            self.error(|| {
138                format!(
139                    "HirIdValidator: The recorded owner of {} is {} instead of {}",
140                    self.tcx.hir().node_to_string(hir_id),
141                    self.tcx.hir().def_path(hir_id.owner.def_id).to_string_no_crate_verbose(),
142                    self.tcx.hir().def_path(owner.def_id).to_string_no_crate_verbose()
143                )
144            });
145        }
146
147        self.hir_ids_seen.insert(hir_id.local_id);
148    }
149
150    fn visit_foreign_item(&mut self, i: &'hir hir::ForeignItem<'hir>) {
151        let mut inner_visitor = self.new_visitor(self.tcx);
152        inner_visitor.check(i.owner_id, |this| intravisit::walk_foreign_item(this, i));
153    }
154
155    fn visit_trait_item(&mut self, i: &'hir hir::TraitItem<'hir>) {
156        let mut inner_visitor = self.new_visitor(self.tcx);
157        inner_visitor.check(i.owner_id, |this| intravisit::walk_trait_item(this, i));
158    }
159
160    fn visit_impl_item(&mut self, i: &'hir hir::ImplItem<'hir>) {
161        let mut inner_visitor = self.new_visitor(self.tcx);
162        inner_visitor.check(i.owner_id, |this| intravisit::walk_impl_item(this, i));
163    }
164
165    fn visit_pattern_type_pattern(&mut self, p: &'hir hir::TyPat<'hir>) {
166        intravisit::walk_ty_pat(self, p)
167    }
168}
rustc_passes/hir_id_validator.rs

rustc_passes/
hir_id_validator.rs
