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).
5 use rustc::hir::{self, HirId};
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;
13 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
25 struct StatCollector<'k> {
26 krate: Option<&'k hir::Crate>,
27 data: FxHashMap<&'static str, NodeData>,
31 pub fn print_hir_stats(krate: &hir::Crate) {
32 let mut collector = StatCollector {
34 data: FxHashMap::default(),
35 seen: FxHashSet::default(),
37 hir_visit::walk_crate(&mut collector, krate);
38 collector.print("HIR STATS");
41 pub fn print_ast_stats(krate: &ast::Crate, title: &str) {
42 let mut collector = StatCollector {
44 data: FxHashMap::default(),
45 seen: FxHashSet::default(),
47 ast_visit::walk_crate(&mut collector, krate);
48 collector.print(title);
51 impl<'k> StatCollector<'k> {
53 fn record<T>(&mut self, label: &'static str, id: Id, node: &T) {
54 if id != Id::None && !self.seen.insert(id) {
58 let entry = self.data.entry(label).or_insert(NodeData {
64 entry.size = std::mem::size_of_val(node);
67 fn print(&self, title: &str) {
68 let mut stats: Vec<_> = self.data.iter().collect();
70 stats.sort_by_key(|&(_, ref d)| d.count * d.size);
72 let mut total_size = 0;
74 println!("\n{}\n", title);
76 println!("{:<18}{:>18}{:>14}{:>14}",
77 "Name", "Accumulated Size", "Count", "Item Size");
78 println!("----------------------------------------------------------------");
80 for (label, data) in stats {
81 println!("{:<18}{:>18}{:>14}{:>14}",
83 to_readable_str(data.count * data.size),
84 to_readable_str(data.count),
85 to_readable_str(data.size));
87 total_size += data.count * data.size;
89 println!("----------------------------------------------------------------");
90 println!("{:<18}{:>18}\n",
92 to_readable_str(total_size));
96 impl<'v> hir_visit::Visitor<'v> for StatCollector<'v> {
97 fn visit_param(&mut self, param: &'v hir::Param) {
98 self.record("Param", Id::Node(param.hir_id), param);
99 hir_visit::walk_param(self, param)
102 fn nested_visit_map<'this>(&'this mut self) -> hir_visit::NestedVisitorMap<'this, 'v> {
103 panic!("visit_nested_xxx must be manually implemented in this visitor")
106 fn visit_nested_item(&mut self, id: hir::ItemId) {
107 let nested_item = self.krate.unwrap().item(id.id);
108 self.visit_item(nested_item)
111 fn visit_nested_trait_item(&mut self, trait_item_id: hir::TraitItemId) {
112 let nested_trait_item = self.krate.unwrap().trait_item(trait_item_id);
113 self.visit_trait_item(nested_trait_item)
116 fn visit_nested_impl_item(&mut self, impl_item_id: hir::ImplItemId) {
117 let nested_impl_item = self.krate.unwrap().impl_item(impl_item_id);
118 self.visit_impl_item(nested_impl_item)
121 fn visit_nested_body(&mut self, body_id: hir::BodyId) {
122 let nested_body = self.krate.unwrap().body(body_id);
123 self.visit_body(nested_body)
126 fn visit_item(&mut self, i: &'v hir::Item) {
127 self.record("Item", Id::Node(i.hir_id), i);
128 hir_visit::walk_item(self, i)
131 fn visit_mod(&mut self, m: &'v hir::Mod, _s: Span, n: hir::HirId) {
132 self.record("Mod", Id::None, m);
133 hir_visit::walk_mod(self, m, n)
136 fn visit_foreign_item(&mut self, i: &'v hir::ForeignItem) {
137 self.record("ForeignItem", Id::Node(i.hir_id), i);
138 hir_visit::walk_foreign_item(self, i)
141 fn visit_local(&mut self, l: &'v hir::Local) {
142 self.record("Local", Id::Node(l.hir_id), l);
143 hir_visit::walk_local(self, l)
146 fn visit_block(&mut self, b: &'v hir::Block) {
147 self.record("Block", Id::Node(b.hir_id), b);
148 hir_visit::walk_block(self, b)
151 fn visit_stmt(&mut self, s: &'v hir::Stmt) {
152 self.record("Stmt", Id::Node(s.hir_id), s);
153 hir_visit::walk_stmt(self, s)
156 fn visit_arm(&mut self, a: &'v hir::Arm) {
157 self.record("Arm", Id::Node(a.hir_id), a);
158 hir_visit::walk_arm(self, a)
161 fn visit_pat(&mut self, p: &'v hir::Pat) {
162 self.record("Pat", Id::Node(p.hir_id), p);
163 hir_visit::walk_pat(self, p)
166 fn visit_expr(&mut self, ex: &'v hir::Expr) {
167 self.record("Expr", Id::Node(ex.hir_id), ex);
168 hir_visit::walk_expr(self, ex)
171 fn visit_ty(&mut self, t: &'v hir::Ty) {
172 self.record("Ty", Id::Node(t.hir_id), t);
173 hir_visit::walk_ty(self, t)
176 fn visit_fn(&mut self,
177 fk: hir_visit::FnKind<'v>,
182 self.record("FnDecl", Id::None, fd);
183 hir_visit::walk_fn(self, fk, fd, b, s, id)
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)
191 fn visit_trait_item(&mut self, ti: &'v hir::TraitItem) {
192 self.record("TraitItem", Id::Node(ti.hir_id), ti);
193 hir_visit::walk_trait_item(self, ti)
196 fn visit_impl_item(&mut self, ii: &'v hir::ImplItem) {
197 self.record("ImplItem", Id::Node(ii.hir_id), ii);
198 hir_visit::walk_impl_item(self, ii)
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)
206 fn visit_struct_field(&mut self, s: &'v hir::StructField) {
207 self.record("StructField", Id::Node(s.hir_id), s);
208 hir_visit::walk_struct_field(self, s)
211 fn visit_variant(&mut self,
213 g: &'v hir::Generics,
214 item_id: hir::HirId) {
215 self.record("Variant", Id::None, v);
216 hir_visit::walk_variant(self, v, g, item_id)
219 fn visit_lifetime(&mut self, lifetime: &'v hir::Lifetime) {
220 self.record("Lifetime", Id::Node(lifetime.hir_id), lifetime);
221 hir_visit::walk_lifetime(self, lifetime)
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)
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)
234 fn visit_path_segment(&mut self,
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)
241 fn visit_assoc_type_binding(&mut self, type_binding: &'v hir::TypeBinding) {
242 self.record("TypeBinding", Id::Node(type_binding.hir_id), type_binding);
243 hir_visit::walk_assoc_type_binding(self, type_binding)
246 fn visit_attribute(&mut self, attr: &'v ast::Attribute) {
247 self.record("Attribute", Id::Attr(attr.id), attr);
250 fn visit_macro_def(&mut self, macro_def: &'v hir::MacroDef) {
251 self.record("MacroDef", Id::Node(macro_def.hir_id), macro_def);
252 hir_visit::walk_macro_def(self, macro_def)
256 impl<'v> ast_visit::Visitor<'v> for StatCollector<'v> {
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)
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)
268 fn visit_item(&mut self, i: &'v ast::Item) {
269 self.record("Item", Id::None, i);
270 ast_visit::walk_item(self, i)
273 fn visit_local(&mut self, l: &'v ast::Local) {
274 self.record("Local", Id::None, l);
275 ast_visit::walk_local(self, l)
278 fn visit_block(&mut self, b: &'v ast::Block) {
279 self.record("Block", Id::None, b);
280 ast_visit::walk_block(self, b)
283 fn visit_stmt(&mut self, s: &'v ast::Stmt) {
284 self.record("Stmt", Id::None, s);
285 ast_visit::walk_stmt(self, s)
288 fn visit_arm(&mut self, a: &'v ast::Arm) {
289 self.record("Arm", Id::None, a);
290 ast_visit::walk_arm(self, a)
293 fn visit_pat(&mut self, p: &'v ast::Pat) {
294 self.record("Pat", Id::None, p);
295 ast_visit::walk_pat(self, p)
298 fn visit_expr(&mut self, ex: &'v ast::Expr) {
299 self.record("Expr", Id::None, ex);
300 ast_visit::walk_expr(self, ex)
303 fn visit_ty(&mut self, t: &'v ast::Ty) {
304 self.record("Ty", Id::None, t);
305 ast_visit::walk_ty(self, t)
308 fn visit_fn(&mut self,
309 fk: ast_visit::FnKind<'v>,
313 self.record("FnDecl", Id::None, fd);
314 ast_visit::walk_fn(self, fk, fd, s)
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)
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)
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)
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)
337 fn visit_variant(&mut self, v: &'v ast::Variant) {
338 self.record("Variant", Id::None, v);
339 ast_visit::walk_variant(self, v)
342 fn visit_lifetime(&mut self, lifetime: &'v ast::Lifetime) {
343 self.record("Lifetime", Id::None, lifetime);
344 ast_visit::walk_lifetime(self, lifetime)
347 fn visit_mac(&mut self, mac: &'v ast::Mac) {
348 self.record("Mac", Id::None, mac);
351 fn visit_path_segment(&mut self,
353 path_segment: &'v ast::PathSegment) {
354 self.record("PathSegment", Id::None, path_segment);
355 ast_visit::walk_path_segment(self, path_span, path_segment)
358 fn visit_assoc_ty_constraint(&mut self, constraint: &'v ast::AssocTyConstraint) {
359 self.record("AssocTyConstraint", Id::None, constraint);
360 ast_visit::walk_assoc_ty_constraint(self, constraint)
363 fn visit_attribute(&mut self, attr: &'v ast::Attribute) {
364 self.record("Attribute", Id::None, attr);