clippy_lints/src/escape.rs

   1 use rustc::hir::intravisit as visit;
   2 use rustc::hir::*;
   3 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   4 use rustc::middle::expr_use_visitor::*;
   5 use rustc::middle::mem_categorization::{cmt_, Categorization};
   6 use rustc::ty::layout::LayoutOf;
   7 use rustc::ty::{self, Ty};
   8 use rustc::util::nodemap::HirIdSet;
   9 use rustc::{declare_tool_lint, impl_lint_pass};
  10 use syntax::source_map::Span;
  11
  12 use crate::utils::span_lint;
  13
  14 #[derive(Copy, Clone)]
  15 pub struct BoxedLocal {
  16     pub too_large_for_stack: u64,
  17 }
  18
  19 declare_clippy_lint! {
  20     /// **What it does:** Checks for usage of `Box<T>` where an unboxed `T` would
  21     /// work fine.
  22     ///
  23     /// **Why is this bad?** This is an unnecessary allocation, and bad for
  24     /// performance. It is only necessary to allocate if you wish to move the box
  25     /// into something.
  26     ///
  27     /// **Known problems:** None.
  28     ///
  29     /// **Example:**
  30     /// ```rust
  31     /// fn main() {
  32     ///     let x = Box::new(1);
  33     ///     foo(*x);
  34     ///     println!("{}", *x);
  35     /// }
  36     /// ```
  37     pub BOXED_LOCAL,
  38     perf,
  39     "using `Box<T>` where unnecessary"
  40 }
  41
  42 fn is_non_trait_box(ty: Ty<'_>) -> bool {
  43     ty.is_box() && !ty.boxed_ty().is_trait()
  44 }
  45
  46 struct EscapeDelegate<'a, 'tcx> {
  47     cx: &'a LateContext<'a, 'tcx>,
  48     set: HirIdSet,
  49     too_large_for_stack: u64,
  50 }
  51
  52 impl_lint_pass!(BoxedLocal => [BOXED_LOCAL]);
  53
  54 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for BoxedLocal {
  55     fn check_fn(
  56         &mut self,
  57         cx: &LateContext<'a, 'tcx>,
  58         _: visit::FnKind<'tcx>,
  59         _: &'tcx FnDecl,
  60         body: &'tcx Body,
  61         _: Span,
  62         hir_id: HirId,
  63     ) {
  64         // If the method is an impl for a trait, don't warn.
  65         let parent_id = cx.tcx.hir().get_parent_item(hir_id);
  66         let parent_node = cx.tcx.hir().find(parent_id);
  67
  68         if let Some(Node::Item(item)) = parent_node {
  69             if let ItemKind::Impl(_, _, _, _, Some(..), _, _) = item.node {
  70                 return;
  71             }
  72         }
  73
  74         let mut v = EscapeDelegate {
  75             cx,
  76             set: HirIdSet::default(),
  77             too_large_for_stack: self.too_large_for_stack,
  78         };
  79
  80         let fn_def_id = cx.tcx.hir().local_def_id(hir_id);
  81         let region_scope_tree = &cx.tcx.region_scope_tree(fn_def_id);
  82         ExprUseVisitor::new(
  83             &mut v,
  84             cx.tcx,
  85             fn_def_id,
  86             cx.param_env,
  87             region_scope_tree,
  88             cx.tables,
  89             None,
  90         )
  91         .consume_body(body);
  92
  93         for node in v.set {
  94             span_lint(
  95                 cx,
  96                 BOXED_LOCAL,
  97                 cx.tcx.hir().span(node),
  98                 "local variable doesn't need to be boxed here",
  99             );
 100         }
 101     }
 102 }
 103
 104 impl<'a, 'tcx> Delegate<'tcx> for EscapeDelegate<'a, 'tcx> {
 105     fn consume(&mut self, _: HirId, _: Span, cmt: &cmt_<'tcx>, mode: ConsumeMode) {
 106         if let Categorization::Local(lid) = cmt.cat {
 107             if let Move(DirectRefMove) | Move(CaptureMove) = mode {
 108                 // moved out or in. clearly can't be localized
 109                 self.set.remove(&lid);
 110             }
 111         }
 112     }
 113     fn matched_pat(&mut self, _: &Pat, _: &cmt_<'tcx>, _: MatchMode) {}
 114     fn consume_pat(&mut self, consume_pat: &Pat, cmt: &cmt_<'tcx>, _: ConsumeMode) {
 115         let map = &self.cx.tcx.hir();
 116         if map.is_argument(consume_pat.hir_id) {
 117             // Skip closure arguments
 118             if let Some(Node::Expr(..)) = map.find(map.get_parent_node(consume_pat.hir_id)) {
 119                 return;
 120             }
 121             if is_non_trait_box(cmt.ty) && !self.is_large_box(cmt.ty) {
 122                 self.set.insert(consume_pat.hir_id);
 123             }
 124             return;
 125         }
 126         if let Categorization::Rvalue(..) = cmt.cat {
 127             if let Some(Node::Stmt(st)) = map.find(map.get_parent_node(cmt.hir_id)) {
 128                 if let StmtKind::Local(ref loc) = st.node {
 129                     if let Some(ref ex) = loc.init {
 130                         if let ExprKind::Box(..) = ex.node {
 131                             if is_non_trait_box(cmt.ty) && !self.is_large_box(cmt.ty) {
 132                                 // let x = box (...)
 133                                 self.set.insert(consume_pat.hir_id);
 134                             }
 135                             // TODO Box::new
 136                             // TODO vec![]
 137                             // TODO "foo".to_owned() and friends
 138                         }
 139                     }
 140                 }
 141             }
 142         }
 143         if let Categorization::Local(lid) = cmt.cat {
 144             if self.set.contains(&lid) {
 145                 // let y = x where x is known
 146                 // remove x, insert y
 147                 self.set.insert(consume_pat.hir_id);
 148                 self.set.remove(&lid);
 149             }
 150         }
 151     }
 152     fn borrow(
 153         &mut self,
 154         _: HirId,
 155         _: Span,
 156         cmt: &cmt_<'tcx>,
 157         _: ty::Region<'_>,
 158         _: ty::BorrowKind,
 159         loan_cause: LoanCause,
 160     ) {
 161         if let Categorization::Local(lid) = cmt.cat {
 162             match loan_cause {
 163                 // `x.foo()`
 164                 // Used without autoderef-ing (i.e., `x.clone()`).
 165                 LoanCause::AutoRef |
 166
 167                 // `&x`
 168                 // `foo(&x)` where no extra autoref-ing is happening.
 169                 LoanCause::AddrOf |
 170
 171                 // `match x` can move.
 172                 LoanCause::MatchDiscriminant => {
 173                     self.set.remove(&lid);
 174                 }
 175
 176                 // Do nothing for matches, etc. These can't escape.
 177                 _ => {}
 178             }
 179         }
 180     }
 181     fn decl_without_init(&mut self, _: HirId, _: Span) {}
 182     fn mutate(&mut self, _: HirId, _: Span, _: &cmt_<'tcx>, _: MutateMode) {}
 183 }
 184
 185 impl<'a, 'tcx> EscapeDelegate<'a, 'tcx> {
 186     fn is_large_box(&self, ty: Ty<'tcx>) -> bool {
 187         // Large types need to be boxed to avoid stack overflows.
 188         if ty.is_box() {
 189             self.cx.layout_of(ty.boxed_ty()).ok().map_or(0, |l| l.size.bytes()) > self.too_large_for_stack
 190         } else {
 191             false
 192         }
 193     }
 194 }