compiler/rustc_passes/src/hir_stats.rs

   1 // The visitors in this module collect sizes and counts of the most important
   2 // pieces of AST and HIR. The resulting numbers are good approximations but not
   3 // completely accurate (some things might be counted twice, others missed).
   4
   5 use rustc_ast::visit as ast_visit;
   6 use rustc_ast::visit::BoundKind;
   7 use rustc_ast::{self as ast, AttrId, NodeId};
   8 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
   9 use rustc_hir as hir;
  10 use rustc_hir::intravisit as hir_visit;
  11 use rustc_hir::HirId;
  12 use rustc_middle::hir::map::Map;
  13 use rustc_middle::ty::TyCtxt;
  14 use rustc_middle::util::common::to_readable_str;
  15 use rustc_span::Span;
  16
  17 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
  18 enum Id {
  19     Node(HirId),
  20     Attr(AttrId),
  21     None,
  22 }
  23
  24 struct NodeData {
  25     count: usize,
  26     size: usize,
  27 }
  28
  29 struct StatCollector<'k> {
  30     krate: Option<Map<'k>>,
  31     data: FxHashMap<&'static str, NodeData>,
  32     seen: FxHashSet<Id>,
  33 }
  34
  35 pub fn print_hir_stats(tcx: TyCtxt<'_>) {
  36     let mut collector = StatCollector {
  37         krate: Some(tcx.hir()),
  38         data: FxHashMap::default(),
  39         seen: FxHashSet::default(),
  40     };
  41     tcx.hir().walk_toplevel_module(&mut collector);
  42     tcx.hir().walk_attributes(&mut collector);
  43     collector.print("HIR STATS");
  44 }
  45
  46 pub fn print_ast_stats(krate: &ast::Crate, title: &str) {
  47     let mut collector =
  48         StatCollector { krate: None, data: FxHashMap::default(), seen: FxHashSet::default() };
  49     ast_visit::walk_crate(&mut collector, krate);
  50     collector.print(title);
  51 }
  52
  53 impl<'k> StatCollector<'k> {
  54     fn record<T>(&mut self, label: &'static str, id: Id, node: &T) {
  55         if id != Id::None && !self.seen.insert(id) {
  56             return;
  57         }
  58
  59         let entry = self.data.entry(label).or_insert(NodeData { count: 0, size: 0 });
  60
  61         entry.count += 1;
  62         entry.size = std::mem::size_of_val(node);
  63     }
  64
  65     fn print(&self, title: &str) {
  66         let mut stats: Vec<_> = self.data.iter().collect();
  67
  68         stats.sort_by_key(|&(_, ref d)| d.count * d.size);
  69
  70         let mut total_size = 0;
  71
  72         eprintln!("\n{}\n", title);
  73
  74         eprintln!("{:<18}{:>18}{:>14}{:>14}", "Name", "Accumulated Size", "Count", "Item Size");
  75         eprintln!("----------------------------------------------------------------");
  76
  77         for (label, data) in stats {
  78             eprintln!(
  79                 "{:<18}{:>18}{:>14}{:>14}",
  80                 label,
  81                 to_readable_str(data.count * data.size),
  82                 to_readable_str(data.count),
  83                 to_readable_str(data.size)
  84             );
  85
  86             total_size += data.count * data.size;
  87         }
  88         eprintln!("----------------------------------------------------------------");
  89         eprintln!("{:<18}{:>18}\n", "Total", to_readable_str(total_size));
  90     }
  91 }
  92
  93 impl<'v> hir_visit::Visitor<'v> for StatCollector<'v> {
  94     fn visit_param(&mut self, param: &'v hir::Param<'v>) {
  95         self.record("Param", Id::Node(param.hir_id), param);
  96         hir_visit::walk_param(self, param)
  97     }
  98
  99     fn visit_nested_item(&mut self, id: hir::ItemId) {
 100         let nested_item = self.krate.unwrap().item(id);
 101         self.visit_item(nested_item)
 102     }
 103
 104     fn visit_nested_trait_item(&mut self, trait_item_id: hir::TraitItemId) {
 105         let nested_trait_item = self.krate.unwrap().trait_item(trait_item_id);
 106         self.visit_trait_item(nested_trait_item)
 107     }
 108
 109     fn visit_nested_impl_item(&mut self, impl_item_id: hir::ImplItemId) {
 110         let nested_impl_item = self.krate.unwrap().impl_item(impl_item_id);
 111         self.visit_impl_item(nested_impl_item)
 112     }
 113
 114     fn visit_nested_foreign_item(&mut self, id: hir::ForeignItemId) {
 115         let nested_foreign_item = self.krate.unwrap().foreign_item(id);
 116         self.visit_foreign_item(nested_foreign_item);
 117     }
 118
 119     fn visit_nested_body(&mut self, body_id: hir::BodyId) {
 120         let nested_body = self.krate.unwrap().body(body_id);
 121         self.visit_body(nested_body)
 122     }
 123
 124     fn visit_item(&mut self, i: &'v hir::Item<'v>) {
 125         self.record("Item", Id::Node(i.hir_id()), i);
 126         hir_visit::walk_item(self, i)
 127     }
 128
 129     fn visit_foreign_item(&mut self, i: &'v hir::ForeignItem<'v>) {
 130         self.record("ForeignItem", Id::Node(i.hir_id()), i);
 131         hir_visit::walk_foreign_item(self, i)
 132     }
 133
 134     fn visit_local(&mut self, l: &'v hir::Local<'v>) {
 135         self.record("Local", Id::Node(l.hir_id), l);
 136         hir_visit::walk_local(self, l)
 137     }
 138
 139     fn visit_block(&mut self, b: &'v hir::Block<'v>) {
 140         self.record("Block", Id::Node(b.hir_id), b);
 141         hir_visit::walk_block(self, b)
 142     }
 143
 144     fn visit_stmt(&mut self, s: &'v hir::Stmt<'v>) {
 145         self.record("Stmt", Id::Node(s.hir_id), s);
 146         hir_visit::walk_stmt(self, s)
 147     }
 148
 149     fn visit_arm(&mut self, a: &'v hir::Arm<'v>) {
 150         self.record("Arm", Id::Node(a.hir_id), a);
 151         hir_visit::walk_arm(self, a)
 152     }
 153
 154     fn visit_pat(&mut self, p: &'v hir::Pat<'v>) {
 155         self.record("Pat", Id::Node(p.hir_id), p);
 156         hir_visit::walk_pat(self, p)
 157     }
 158
 159     fn visit_expr(&mut self, ex: &'v hir::Expr<'v>) {
 160         self.record("Expr", Id::Node(ex.hir_id), ex);
 161         hir_visit::walk_expr(self, ex)
 162     }
 163
 164     fn visit_ty(&mut self, t: &'v hir::Ty<'v>) {
 165         self.record("Ty", Id::Node(t.hir_id), t);
 166         hir_visit::walk_ty(self, t)
 167     }
 168
 169     fn visit_fn(
 170         &mut self,
 171         fk: hir_visit::FnKind<'v>,
 172         fd: &'v hir::FnDecl<'v>,
 173         b: hir::BodyId,
 174         s: Span,
 175         id: hir::HirId,
 176     ) {
 177         self.record("FnDecl", Id::None, fd);
 178         hir_visit::walk_fn(self, fk, fd, b, s, id)
 179     }
 180
 181     fn visit_where_predicate(&mut self, predicate: &'v hir::WherePredicate<'v>) {
 182         self.record("WherePredicate", Id::None, predicate);
 183         hir_visit::walk_where_predicate(self, predicate)
 184     }
 185
 186     fn visit_trait_item(&mut self, ti: &'v hir::TraitItem<'v>) {
 187         self.record("TraitItem", Id::Node(ti.hir_id()), ti);
 188         hir_visit::walk_trait_item(self, ti)
 189     }
 190
 191     fn visit_impl_item(&mut self, ii: &'v hir::ImplItem<'v>) {
 192         self.record("ImplItem", Id::Node(ii.hir_id()), ii);
 193         hir_visit::walk_impl_item(self, ii)
 194     }
 195
 196     fn visit_param_bound(&mut self, bounds: &'v hir::GenericBound<'v>) {
 197         self.record("GenericBound", Id::None, bounds);
 198         hir_visit::walk_param_bound(self, bounds)
 199     }
 200
 201     fn visit_field_def(&mut self, s: &'v hir::FieldDef<'v>) {
 202         self.record("FieldDef", Id::Node(s.hir_id), s);
 203         hir_visit::walk_field_def(self, s)
 204     }
 205
 206     fn visit_variant(
 207         &mut self,
 208         v: &'v hir::Variant<'v>,
 209         g: &'v hir::Generics<'v>,
 210         item_id: hir::HirId,
 211     ) {
 212         self.record("Variant", Id::None, v);
 213         hir_visit::walk_variant(self, v, g, item_id)
 214     }
 215
 216     fn visit_lifetime(&mut self, lifetime: &'v hir::Lifetime) {
 217         self.record("Lifetime", Id::Node(lifetime.hir_id), lifetime);
 218         hir_visit::walk_lifetime(self, lifetime)
 219     }
 220
 221     fn visit_qpath(&mut self, qpath: &'v hir::QPath<'v>, id: hir::HirId, span: Span) {
 222         self.record("QPath", Id::None, qpath);
 223         hir_visit::walk_qpath(self, qpath, id, span)
 224     }
 225
 226     fn visit_path(&mut self, path: &'v hir::Path<'v>, _id: hir::HirId) {
 227         self.record("Path", Id::None, path);
 228         hir_visit::walk_path(self, path)
 229     }
 230
 231     fn visit_path_segment(&mut self, path_span: Span, path_segment: &'v hir::PathSegment<'v>) {
 232         self.record("PathSegment", Id::None, path_segment);
 233         hir_visit::walk_path_segment(self, path_span, path_segment)
 234     }
 235
 236     fn visit_assoc_type_binding(&mut self, type_binding: &'v hir::TypeBinding<'v>) {
 237         self.record("TypeBinding", Id::Node(type_binding.hir_id), type_binding);
 238         hir_visit::walk_assoc_type_binding(self, type_binding)
 239     }
 240
 241     fn visit_attribute(&mut self, attr: &'v ast::Attribute) {
 242         self.record("Attribute", Id::Attr(attr.id), attr);
 243     }
 244 }
 245
 246 impl<'v> ast_visit::Visitor<'v> for StatCollector<'v> {
 247     fn visit_foreign_item(&mut self, i: &'v ast::ForeignItem) {
 248         self.record("ForeignItem", Id::None, i);
 249         ast_visit::walk_foreign_item(self, i)
 250     }
 251
 252     fn visit_item(&mut self, i: &'v ast::Item) {
 253         self.record("Item", Id::None, i);
 254         ast_visit::walk_item(self, i)
 255     }
 256
 257     fn visit_local(&mut self, l: &'v ast::Local) {
 258         self.record("Local", Id::None, l);
 259         ast_visit::walk_local(self, l)
 260     }
 261
 262     fn visit_block(&mut self, b: &'v ast::Block) {
 263         self.record("Block", Id::None, b);
 264         ast_visit::walk_block(self, b)
 265     }
 266
 267     fn visit_stmt(&mut self, s: &'v ast::Stmt) {
 268         self.record("Stmt", Id::None, s);
 269         ast_visit::walk_stmt(self, s)
 270     }
 271
 272     fn visit_arm(&mut self, a: &'v ast::Arm) {
 273         self.record("Arm", Id::None, a);
 274         ast_visit::walk_arm(self, a)
 275     }
 276
 277     fn visit_pat(&mut self, p: &'v ast::Pat) {
 278         self.record("Pat", Id::None, p);
 279         ast_visit::walk_pat(self, p)
 280     }
 281
 282     fn visit_expr(&mut self, ex: &'v ast::Expr) {
 283         self.record("Expr", Id::None, ex);
 284         ast_visit::walk_expr(self, ex)
 285     }
 286
 287     fn visit_ty(&mut self, t: &'v ast::Ty) {
 288         self.record("Ty", Id::None, t);
 289         ast_visit::walk_ty(self, t)
 290     }
 291
 292     fn visit_fn(&mut self, fk: ast_visit::FnKind<'v>, s: Span, _: NodeId) {
 293         self.record("FnDecl", Id::None, fk.decl());
 294         ast_visit::walk_fn(self, fk, s)
 295     }
 296
 297     fn visit_assoc_item(&mut self, item: &'v ast::AssocItem, ctxt: ast_visit::AssocCtxt) {
 298         let label = match ctxt {
 299             ast_visit::AssocCtxt::Trait => "TraitItem",
 300             ast_visit::AssocCtxt::Impl => "ImplItem",
 301         };
 302         self.record(label, Id::None, item);
 303         ast_visit::walk_assoc_item(self, item, ctxt);
 304     }
 305
 306     fn visit_param_bound(&mut self, bounds: &'v ast::GenericBound, _ctxt: BoundKind) {
 307         self.record("GenericBound", Id::None, bounds);
 308         ast_visit::walk_param_bound(self, bounds)
 309     }
 310
 311     fn visit_field_def(&mut self, s: &'v ast::FieldDef) {
 312         self.record("FieldDef", Id::None, s);
 313         ast_visit::walk_field_def(self, s)
 314     }
 315
 316     fn visit_variant(&mut self, v: &'v ast::Variant) {
 317         self.record("Variant", Id::None, v);
 318         ast_visit::walk_variant(self, v)
 319     }
 320
 321     fn visit_lifetime(&mut self, lifetime: &'v ast::Lifetime, _: ast_visit::LifetimeCtxt) {
 322         self.record("Lifetime", Id::None, lifetime);
 323         ast_visit::walk_lifetime(self, lifetime)
 324     }
 325
 326     fn visit_mac_call(&mut self, mac: &'v ast::MacCall) {
 327         self.record("MacCall", Id::None, mac);
 328         ast_visit::walk_mac(self, mac)
 329     }
 330
 331     fn visit_path_segment(&mut self, path_span: Span, path_segment: &'v ast::PathSegment) {
 332         self.record("PathSegment", Id::None, path_segment);
 333         ast_visit::walk_path_segment(self, path_span, path_segment)
 334     }
 335
 336     fn visit_assoc_constraint(&mut self, constraint: &'v ast::AssocConstraint) {
 337         self.record("AssocConstraint", Id::None, constraint);
 338         ast_visit::walk_assoc_constraint(self, constraint)
 339     }
 340
 341     fn visit_attribute(&mut self, attr: &'v ast::Attribute) {
 342         self.record("Attribute", Id::None, attr);
 343     }
 344 }