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