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