compiler/rustc_passes/src/hir_id_validator.rs

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