1 // Copyright 2013 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 // This implements the dead-code warning pass. It follows middle::reachable
12 // closely. The idea is that all reachable symbols are live, codes called
13 // from live codes are live, and everything else is dead.
15 use front::map as ast_map;
17 use rustc_front::intravisit::{self, Visitor};
19 use middle::{def, pat_util, privacy, ty};
20 use middle::def_id::{DefId};
22 use util::nodemap::NodeSet;
24 use std::collections::HashSet;
25 use syntax::{ast, codemap};
26 use syntax::attr::{self, AttrMetaMethods};
28 // Any local node that may call something in its body block should be
29 // explored. For example, if it's a live NodeItem that is a
30 // function, then we should explore its block to check for codes that
31 // may need to be marked as live.
32 fn should_explore(tcx: &ty::ctxt, node_id: ast::NodeId) -> bool {
33 match tcx.map.find(node_id) {
34 Some(ast_map::NodeItem(..)) |
35 Some(ast_map::NodeImplItem(..)) |
36 Some(ast_map::NodeForeignItem(..)) |
37 Some(ast_map::NodeTraitItem(..)) =>
44 struct MarkSymbolVisitor<'a, 'tcx: 'a> {
45 worklist: Vec<ast::NodeId>,
46 tcx: &'a ty::ctxt<'tcx>,
47 live_symbols: Box<HashSet<ast::NodeId>>,
48 struct_has_extern_repr: bool,
49 ignore_non_const_paths: bool,
50 inherited_pub_visibility: bool,
51 ignore_variant_stack: Vec<DefId>,
54 impl<'a, 'tcx> MarkSymbolVisitor<'a, 'tcx> {
55 fn new(tcx: &'a ty::ctxt<'tcx>,
56 worklist: Vec<ast::NodeId>) -> MarkSymbolVisitor<'a, 'tcx> {
60 live_symbols: box HashSet::new(),
61 struct_has_extern_repr: false,
62 ignore_non_const_paths: false,
63 inherited_pub_visibility: false,
64 ignore_variant_stack: vec![],
68 fn check_def_id(&mut self, def_id: DefId) {
69 if let Some(node_id) = self.tcx.map.as_local_node_id(def_id) {
70 if should_explore(self.tcx, node_id) {
71 self.worklist.push(node_id);
73 self.live_symbols.insert(node_id);
77 fn insert_def_id(&mut self, def_id: DefId) {
78 if let Some(node_id) = self.tcx.map.as_local_node_id(def_id) {
79 debug_assert!(!should_explore(self.tcx, node_id));
80 self.live_symbols.insert(node_id);
84 fn lookup_and_handle_definition(&mut self, id: &ast::NodeId) {
85 use middle::ty::TypeVariants::{TyEnum, TyStruct};
87 // If `bar` is a trait item, make sure to mark Foo as alive in `Foo::bar`
88 self.tcx.tables.borrow().item_substs.get(id)
89 .and_then(|substs| substs.substs.self_ty())
90 .map(|ty| match ty.sty {
91 TyEnum(tyid, _) | TyStruct(tyid, _) => self.check_def_id(tyid.did),
95 self.tcx.def_map.borrow().get(id).map(|def| {
96 match def.full_def() {
97 def::DefConst(_) | def::DefAssociatedConst(..) => {
98 self.check_def_id(def.def_id());
100 _ if self.ignore_non_const_paths => (),
101 def::DefPrimTy(_) => (),
102 def::DefSelfTy(..) => (),
103 def::DefVariant(enum_id, variant_id, _) => {
104 self.check_def_id(enum_id);
105 if !self.ignore_variant_stack.contains(&variant_id) {
106 self.check_def_id(variant_id);
110 self.check_def_id(def.def_id());
116 fn lookup_and_handle_method(&mut self, id: ast::NodeId) {
117 let method_call = ty::MethodCall::expr(id);
118 let method = self.tcx.tables.borrow().method_map[&method_call];
119 self.check_def_id(method.def_id);
122 fn handle_field_access(&mut self, lhs: &hir::Expr, name: ast::Name) {
123 if let ty::TyStruct(def, _) = self.tcx.expr_ty_adjusted(lhs).sty {
124 self.insert_def_id(def.struct_variant().field_named(name).did);
126 self.tcx.sess.span_bug(lhs.span, "named field access on non-struct")
130 fn handle_tup_field_access(&mut self, lhs: &hir::Expr, idx: usize) {
131 if let ty::TyStruct(def, _) = self.tcx.expr_ty_adjusted(lhs).sty {
132 self.insert_def_id(def.struct_variant().fields[idx].did);
136 fn handle_field_pattern_match(&mut self, lhs: &hir::Pat,
137 pats: &[codemap::Spanned<hir::FieldPat>]) {
138 let def = self.tcx.def_map.borrow().get(&lhs.id).unwrap().full_def();
139 let pat_ty = self.tcx.node_id_to_type(lhs.id);
140 let variant = match pat_ty.sty {
141 ty::TyStruct(adt, _) | ty::TyEnum(adt, _) => adt.variant_of_def(def),
142 _ => self.tcx.sess.span_bug(lhs.span, "non-ADT in struct pattern")
145 if let hir::PatWild = pat.node.pat.node {
148 self.insert_def_id(variant.field_named(pat.node.name).did);
152 fn mark_live_symbols(&mut self) {
153 let mut scanned = HashSet::new();
154 while !self.worklist.is_empty() {
155 let id = self.worklist.pop().unwrap();
156 if scanned.contains(&id) {
161 match self.tcx.map.find(id) {
163 self.live_symbols.insert(id);
164 self.visit_node(node);
171 fn visit_node(&mut self, node: &ast_map::Node) {
172 let had_extern_repr = self.struct_has_extern_repr;
173 self.struct_has_extern_repr = false;
174 let had_inherited_pub_visibility = self.inherited_pub_visibility;
175 self.inherited_pub_visibility = false;
177 ast_map::NodeItem(item) => {
179 hir::ItemStruct(..) => {
180 self.struct_has_extern_repr = item.attrs.iter().any(|attr| {
181 attr::find_repr_attrs(self.tcx.sess.diagnostic(), attr)
182 .contains(&attr::ReprExtern)
185 intravisit::walk_item(self, &*item);
187 hir::ItemEnum(..) => {
188 self.inherited_pub_visibility = item.vis == hir::Public;
189 intravisit::walk_item(self, &*item);
193 | hir::ItemStatic(..)
194 | hir::ItemConst(..) => {
195 intravisit::walk_item(self, &*item);
200 ast_map::NodeTraitItem(trait_item) => {
201 intravisit::walk_trait_item(self, trait_item);
203 ast_map::NodeImplItem(impl_item) => {
204 intravisit::walk_impl_item(self, impl_item);
206 ast_map::NodeForeignItem(foreign_item) => {
207 intravisit::walk_foreign_item(self, &*foreign_item);
211 self.struct_has_extern_repr = had_extern_repr;
212 self.inherited_pub_visibility = had_inherited_pub_visibility;
216 impl<'a, 'tcx, 'v> Visitor<'v> for MarkSymbolVisitor<'a, 'tcx> {
218 fn visit_variant_data(&mut self, def: &hir::VariantData, _: ast::Name,
219 _: &hir::Generics, _: ast::NodeId, _: codemap::Span) {
220 let has_extern_repr = self.struct_has_extern_repr;
221 let inherited_pub_visibility = self.inherited_pub_visibility;
222 let live_fields = def.fields().iter().filter(|f| {
223 has_extern_repr || inherited_pub_visibility || match f.node.kind {
224 hir::NamedField(_, hir::Public) => true,
228 self.live_symbols.extend(live_fields.map(|f| f.node.id));
230 intravisit::walk_struct_def(self, def);
233 fn visit_expr(&mut self, expr: &hir::Expr) {
235 hir::ExprMethodCall(..) => {
236 self.lookup_and_handle_method(expr.id);
238 hir::ExprField(ref lhs, ref name) => {
239 self.handle_field_access(&**lhs, name.node);
241 hir::ExprTupField(ref lhs, idx) => {
242 self.handle_tup_field_access(&**lhs, idx.node);
247 intravisit::walk_expr(self, expr);
250 fn visit_arm(&mut self, arm: &hir::Arm) {
251 if arm.pats.len() == 1 {
252 let pat = &*arm.pats[0];
253 let variants = pat_util::necessary_variants(&self.tcx.def_map.borrow(), pat);
255 // Inside the body, ignore constructions of variants
256 // necessary for the pattern to match. Those construction sites
257 // can't be reached unless the variant is constructed elsewhere.
258 let len = self.ignore_variant_stack.len();
259 self.ignore_variant_stack.push_all(&*variants);
260 intravisit::walk_arm(self, arm);
261 self.ignore_variant_stack.truncate(len);
263 intravisit::walk_arm(self, arm);
267 fn visit_pat(&mut self, pat: &hir::Pat) {
268 let def_map = &self.tcx.def_map;
270 hir::PatStruct(_, ref fields, _) => {
271 self.handle_field_pattern_match(pat, fields);
273 _ if pat_util::pat_is_const(&def_map.borrow(), pat) => {
274 // it might be the only use of a const
275 self.lookup_and_handle_definition(&pat.id)
280 self.ignore_non_const_paths = true;
281 intravisit::walk_pat(self, pat);
282 self.ignore_non_const_paths = false;
285 fn visit_path(&mut self, path: &hir::Path, id: ast::NodeId) {
286 self.lookup_and_handle_definition(&id);
287 intravisit::walk_path(self, path);
290 fn visit_path_list_item(&mut self, path: &hir::Path, item: &hir::PathListItem) {
291 self.lookup_and_handle_definition(&item.node.id());
292 intravisit::walk_path_list_item(self, path, item);
296 fn has_allow_dead_code_or_lang_attr(attrs: &[ast::Attribute]) -> bool {
297 if attr::contains_name(attrs, "lang") {
301 let dead_code = lint::builtin::DEAD_CODE.name_lower();
302 for attr in lint::gather_attrs(attrs) {
304 Ok((ref name, lint::Allow, _))
305 if &name[..] == dead_code => return true,
312 // This visitor seeds items that
313 // 1) We want to explicitly consider as live:
314 // * Item annotated with #[allow(dead_code)]
315 // - This is done so that if we want to suppress warnings for a
316 // group of dead functions, we only have to annotate the "root".
317 // For example, if both `f` and `g` are dead and `f` calls `g`,
318 // then annotating `f` with `#[allow(dead_code)]` will suppress
319 // warning for both `f` and `g`.
320 // * Item annotated with #[lang=".."]
321 // - This is because lang items are always callable from elsewhere.
323 // 2) We are not sure to be live or not
324 // * Implementation of a trait method
326 worklist: Vec<ast::NodeId>
329 impl<'v> Visitor<'v> for LifeSeeder {
330 fn visit_item(&mut self, item: &hir::Item) {
331 let allow_dead_code = has_allow_dead_code_or_lang_attr(&item.attrs);
333 self.worklist.push(item.id);
336 hir::ItemEnum(ref enum_def, _) if allow_dead_code => {
337 self.worklist.extend(enum_def.variants.iter()
338 .map(|variant| variant.node.data.id()));
340 hir::ItemTrait(_, _, _, ref trait_items) => {
341 for trait_item in trait_items {
342 match trait_item.node {
343 hir::ConstTraitItem(_, Some(_)) |
344 hir::MethodTraitItem(_, Some(_)) => {
345 if has_allow_dead_code_or_lang_attr(&trait_item.attrs) {
346 self.worklist.push(trait_item.id);
353 hir::ItemImpl(_, _, _, ref opt_trait, _, ref impl_items) => {
354 for impl_item in impl_items {
355 match impl_item.node {
356 hir::ImplItemKind::Const(..) |
357 hir::ImplItemKind::Method(..) => {
358 if opt_trait.is_some() ||
359 has_allow_dead_code_or_lang_attr(&impl_item.attrs) {
360 self.worklist.push(impl_item.id);
363 hir::ImplItemKind::Type(_) => {}
372 fn create_and_seed_worklist(tcx: &ty::ctxt,
373 exported_items: &privacy::ExportedItems,
374 reachable_symbols: &NodeSet,
375 krate: &hir::Crate) -> Vec<ast::NodeId> {
376 let mut worklist = Vec::new();
378 // Preferably, we would only need to seed the worklist with reachable
379 // symbols. However, since the set of reachable symbols differs
380 // depending on whether a crate is built as bin or lib, and we want
381 // the warning to be consistent, we also seed the worklist with
383 for id in exported_items {
386 for id in reachable_symbols {
387 // Reachable variants can be dead, because we warn about
388 // variants never constructed, not variants never used.
389 if let Some(ast_map::NodeVariant(..)) = tcx.map.find(*id) {
396 match *tcx.sess.entry_fn.borrow() {
397 Some((id, _)) => worklist.push(id),
401 // Seed implemented trait items
402 let mut life_seeder = LifeSeeder {
405 krate.visit_all_items(&mut life_seeder);
407 return life_seeder.worklist;
410 fn find_live(tcx: &ty::ctxt,
411 exported_items: &privacy::ExportedItems,
412 reachable_symbols: &NodeSet,
414 -> Box<HashSet<ast::NodeId>> {
415 let worklist = create_and_seed_worklist(tcx, exported_items,
416 reachable_symbols, krate);
417 let mut symbol_visitor = MarkSymbolVisitor::new(tcx, worklist);
418 symbol_visitor.mark_live_symbols();
419 symbol_visitor.live_symbols
422 fn get_struct_ctor_id(item: &hir::Item) -> Option<ast::NodeId> {
424 hir::ItemStruct(ref struct_def, _) if !struct_def.is_struct() => {
425 Some(struct_def.id())
431 struct DeadVisitor<'a, 'tcx: 'a> {
432 tcx: &'a ty::ctxt<'tcx>,
433 live_symbols: Box<HashSet<ast::NodeId>>,
436 impl<'a, 'tcx> DeadVisitor<'a, 'tcx> {
437 fn should_warn_about_item(&mut self, item: &hir::Item) -> bool {
438 let should_warn = match item.node {
443 | hir::ItemStruct(..) => true,
446 let ctor_id = get_struct_ctor_id(item);
447 should_warn && !self.symbol_is_live(item.id, ctor_id)
450 fn should_warn_about_field(&mut self, node: &hir::StructField_) -> bool {
451 let is_named = node.name().is_some();
452 let field_type = self.tcx.node_id_to_type(node.id);
453 let is_marker_field = match field_type.ty_to_def_id() {
454 Some(def_id) => self.tcx.lang_items.items().any(|(_, item)| *item == Some(def_id)),
458 && !self.symbol_is_live(node.id, None)
460 && !has_allow_dead_code_or_lang_attr(&node.attrs)
463 fn should_warn_about_variant(&mut self, variant: &hir::Variant_) -> bool {
464 !self.symbol_is_live(variant.data.id(), None)
465 && !has_allow_dead_code_or_lang_attr(&variant.attrs)
468 // id := node id of an item's definition.
469 // ctor_id := `Some` if the item is a struct_ctor (tuple struct),
471 // If the item is a struct_ctor, then either its `id` or
472 // `ctor_id` (unwrapped) is in the live_symbols set. More specifically,
473 // DefMap maps the ExprPath of a struct_ctor to the node referred by
474 // `ctor_id`. On the other hand, in a statement like
475 // `type <ident> <generics> = <ty>;` where <ty> refers to a struct_ctor,
476 // DefMap maps <ty> to `id` instead.
477 fn symbol_is_live(&mut self,
479 ctor_id: Option<ast::NodeId>)
481 if self.live_symbols.contains(&id)
482 || ctor_id.map_or(false,
483 |ctor| self.live_symbols.contains(&ctor)) {
486 // If it's a type whose items are live, then it's live, too.
487 // This is done to handle the case where, for example, the static
488 // method of a private type is used, but the type itself is never
490 let impl_items = self.tcx.impl_items.borrow();
491 match self.tcx.inherent_impls.borrow().get(&self.tcx.map.local_def_id(id)) {
494 for impl_did in impl_list.iter() {
495 for item_did in impl_items.get(impl_did).unwrap().iter() {
496 if let Some(item_node_id) =
497 self.tcx.map.as_local_node_id(item_did.def_id()) {
498 if self.live_symbols.contains(&item_node_id) {
509 fn warn_dead_code(&mut self,
514 let name = name.as_str();
515 if !name.starts_with("_") {
518 .add_lint(lint::builtin::DEAD_CODE,
521 format!("{} is never used: `{}`", node_type, name));
526 impl<'a, 'tcx, 'v> Visitor<'v> for DeadVisitor<'a, 'tcx> {
527 /// Walk nested items in place so that we don't report dead-code
528 /// on inner functions when the outer function is already getting
529 /// an error. We could do this also by checking the parents, but
530 /// this is how the code is setup and it seems harmless enough.
531 fn visit_nested_item(&mut self, item: hir::ItemId) {
532 self.visit_item(self.tcx.map.expect_item(item.id))
535 fn visit_item(&mut self, item: &hir::Item) {
536 if self.should_warn_about_item(item) {
541 item.node.descriptive_variant()
544 // Only continue if we didn't warn
545 intravisit::walk_item(self, item);
549 fn visit_variant(&mut self, variant: &hir::Variant, g: &hir::Generics, id: ast::NodeId) {
550 if self.should_warn_about_variant(&variant.node) {
551 self.warn_dead_code(variant.node.data.id(), variant.span,
552 variant.node.name, "variant");
554 intravisit::walk_variant(self, variant, g, id);
558 fn visit_foreign_item(&mut self, fi: &hir::ForeignItem) {
559 if !self.symbol_is_live(fi.id, None) {
560 self.warn_dead_code(fi.id, fi.span, fi.name, fi.node.descriptive_variant());
562 intravisit::walk_foreign_item(self, fi);
565 fn visit_struct_field(&mut self, field: &hir::StructField) {
566 if self.should_warn_about_field(&field.node) {
567 self.warn_dead_code(field.node.id, field.span,
568 field.node.name().unwrap(), "struct field");
571 intravisit::walk_struct_field(self, field);
574 fn visit_impl_item(&mut self, impl_item: &hir::ImplItem) {
575 match impl_item.node {
576 hir::ImplItemKind::Const(_, ref expr) => {
577 if !self.symbol_is_live(impl_item.id, None) {
578 self.warn_dead_code(impl_item.id, impl_item.span,
579 impl_item.name, "associated const");
581 intravisit::walk_expr(self, expr)
583 hir::ImplItemKind::Method(_, ref body) => {
584 if !self.symbol_is_live(impl_item.id, None) {
585 self.warn_dead_code(impl_item.id, impl_item.span,
586 impl_item.name, "method");
588 intravisit::walk_block(self, body)
590 hir::ImplItemKind::Type(..) => {}
594 // Overwrite so that we don't warn the trait item itself.
595 fn visit_trait_item(&mut self, trait_item: &hir::TraitItem) {
596 match trait_item.node {
597 hir::ConstTraitItem(_, Some(ref expr)) => {
598 intravisit::walk_expr(self, expr)
600 hir::MethodTraitItem(_, Some(ref body)) => {
601 intravisit::walk_block(self, body)
603 hir::ConstTraitItem(_, None) |
604 hir::MethodTraitItem(_, None) |
605 hir::TypeTraitItem(..) => {}
610 pub fn check_crate(tcx: &ty::ctxt,
611 exported_items: &privacy::ExportedItems,
612 reachable_symbols: &NodeSet) {
613 let krate = tcx.map.krate();
614 let live_symbols = find_live(tcx, exported_items,
615 reachable_symbols, krate);
616 let mut visitor = DeadVisitor { tcx: tcx, live_symbols: live_symbols };
617 intravisit::walk_crate(&mut visitor, krate);