clippy_lints/src/escape.rs

   1 use rustc::hir::intravisit as visit;
   2 use rustc::hir::{self, *};
   3 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   4 use rustc_typeck::expr_use_visitor::*;
   5 use rustc::ty::layout::LayoutOf;
   6 use rustc::ty::{self, Ty};
   7 use rustc::util::nodemap::HirIdSet;
   8 use rustc::{declare_tool_lint, impl_lint_pass};
   9 use syntax::source_map::Span;
  10
  11 use crate::utils::span_lint;
  12
  13 #[derive(Copy, Clone)]
  14 pub struct BoxedLocal {
  15     pub too_large_for_stack: u64,
  16 }
  17
  18 declare_clippy_lint! {
  19     /// **What it does:** Checks for usage of `Box<T>` where an unboxed `T` would
  20     /// work fine.
  21     ///
  22     /// **Why is this bad?** This is an unnecessary allocation, and bad for
  23     /// performance. It is only necessary to allocate if you wish to move the box
  24     /// into something.
  25     ///
  26     /// **Known problems:** None.
  27     ///
  28     /// **Example:**
  29     /// ```rust
  30     /// # fn foo(bar: usize) {}
  31     /// let x = Box::new(1);
  32     /// foo(*x);
  33     /// println!("{}", *x);
  34     /// ```
  35     pub BOXED_LOCAL,
  36     perf,
  37     "using `Box<T>` where unnecessary"
  38 }
  39
  40 fn is_non_trait_box(ty: Ty<'_>) -> bool {
  41     ty.is_box() && !ty.boxed_ty().is_trait()
  42 }
  43
  44 struct EscapeDelegate<'a, 'tcx> {
  45     cx: &'a LateContext<'a, 'tcx>,
  46     set: HirIdSet,
  47     too_large_for_stack: u64,
  48 }
  49
  50 impl_lint_pass!(BoxedLocal => [BOXED_LOCAL]);
  51
  52 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for BoxedLocal {
  53     fn check_fn(
  54         &mut self,
  55         cx: &LateContext<'a, 'tcx>,
  56         _: visit::FnKind<'tcx>,
  57         _: &'tcx FnDecl,
  58         body: &'tcx Body,
  59         _: Span,
  60         hir_id: HirId,
  61     ) {
  62         // If the method is an impl for a trait, don't warn.
  63         let parent_id = cx.tcx.hir().get_parent_item(hir_id);
  64         let parent_node = cx.tcx.hir().find(parent_id);
  65
  66         if let Some(Node::Item(item)) = parent_node {
  67             if let ItemKind::Impl(_, _, _, _, Some(..), _, _) = item.kind {
  68                 return;
  69             }
  70         }
  71
  72         let mut v = EscapeDelegate {
  73             cx,
  74             set: HirIdSet::default(),
  75             too_large_for_stack: self.too_large_for_stack,
  76         };
  77
  78         let fn_def_id = cx.tcx.hir().local_def_id(hir_id);
  79         let region_scope_tree = &cx.tcx.region_scope_tree(fn_def_id);
  80         ExprUseVisitor::new(&mut v, cx.tcx, fn_def_id, cx.param_env, region_scope_tree, cx.tables).consume_body(body);
  81
  82         for node in v.set {
  83             span_lint(
  84                 cx,
  85                 BOXED_LOCAL,
  86                 cx.tcx.hir().span(node),
  87                 "local variable doesn't need to be boxed here",
  88             );
  89         }
  90     }
  91 }
  92
  93 // TODO: Replace with Map::is_argument(..) when it's fixed
  94 fn is_argument(map: &hir::map::Map<'_>, id: HirId) -> bool {
  95     match map.find(id) {
  96         Some(Node::Binding(_)) => (),
  97         _ => return false,
  98     }
  99
 100     match map.find(map.get_parent_node(id)) {
 101         Some(Node::Param(_)) => true,
 102         _ => false,
 103     }
 104 }
 105
 106 impl<'a, 'tcx> Delegate<'tcx> for EscapeDelegate<'a, 'tcx> {
 107     fn consume(&mut self, cmt: &Place<'tcx>, mode: ConsumeMode) {
 108         if let Categorization::Local(lid) = cmt.cat {
 109             if let ConsumeMode::Move = mode {
 110                 // moved out or in. clearly can't be localized
 111                 self.set.remove(&lid);
 112             }
 113         }
 114         let map = &self.cx.tcx.hir();
 115         if let Categorization::Local(lid) = cmt.cat {
 116             if let Some(Node::Binding(_)) = map.find(cmt.hir_id) {
 117                 if self.set.contains(&lid) {
 118                     // let y = x where x is known
 119                     // remove x, insert y
 120                     self.set.insert(cmt.hir_id);
 121                     self.set.remove(&lid);
 122                 }
 123             }
 124         }
 125     }
 126
 127     fn borrow(&mut self, cmt: &Place<'tcx>, _: ty::BorrowKind) {
 128         if let Categorization::Local(lid) = cmt.cat {
 129             self.set.remove(&lid);
 130         }
 131     }
 132
 133     fn mutate(&mut self, cmt: &Place<'tcx>) {
 134         let map = &self.cx.tcx.hir();
 135         if is_argument(map, cmt.hir_id) {
 136             // Skip closure arguments
 137             let parent_id = map.get_parent_node(cmt.hir_id);
 138             if let Some(Node::Expr(..)) = map.find(map.get_parent_node(parent_id)) {
 139                 return;
 140             }
 141
 142             if is_non_trait_box(cmt.ty) && !self.is_large_box(cmt.ty) {
 143                 self.set.insert(cmt.hir_id);
 144             }
 145             return;
 146         }
 147     }
 148 }
 149
 150 impl<'a, 'tcx> EscapeDelegate<'a, 'tcx> {
 151     fn is_large_box(&self, ty: Ty<'tcx>) -> bool {
 152         // Large types need to be boxed to avoid stack overflows.
 153         if ty.is_box() {
 154             self.cx.layout_of(ty.boxed_ty()).map_or(0, |l| l.size.bytes()) > self.too_large_for_stack
 155         } else {
 156             false
 157         }
 158     }
 159 }