use rustc::hir::intravisit as visit; use rustc::hir::{self, *}; use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass}; use rustc::middle::expr_use_visitor::*; use rustc::middle::mem_categorization::{cmt_, Categorization}; use rustc::ty::layout::LayoutOf; use rustc::ty::{self, Ty}; use rustc::util::nodemap::HirIdSet; use rustc::{declare_tool_lint, impl_lint_pass}; use syntax::source_map::Span; use crate::utils::span_lint; #[derive(Copy, Clone)] pub struct BoxedLocal { pub too_large_for_stack: u64, } declare_clippy_lint! { /// **What it does:** Checks for usage of `Box` where an unboxed `T` would /// work fine. /// /// **Why is this bad?** This is an unnecessary allocation, and bad for /// performance. It is only necessary to allocate if you wish to move the box /// into something. /// /// **Known problems:** None. /// /// **Example:** /// ```rust /// # fn foo(bar: usize) {} /// let x = Box::new(1); /// foo(*x); /// println!("{}", *x); /// ``` pub BOXED_LOCAL, perf, "using `Box` where unnecessary" } fn is_non_trait_box(ty: Ty<'_>) -> bool { ty.is_box() && !ty.boxed_ty().is_trait() } struct EscapeDelegate<'a, 'tcx> { cx: &'a LateContext<'a, 'tcx>, set: HirIdSet, too_large_for_stack: u64, } impl_lint_pass!(BoxedLocal => [BOXED_LOCAL]); impl<'a, 'tcx> LateLintPass<'a, 'tcx> for BoxedLocal { fn check_fn( &mut self, cx: &LateContext<'a, 'tcx>, _: visit::FnKind<'tcx>, _: &'tcx FnDecl, body: &'tcx Body, _: Span, hir_id: HirId, ) { // If the method is an impl for a trait, don't warn. let parent_id = cx.tcx.hir().get_parent_item(hir_id); let parent_node = cx.tcx.hir().find(parent_id); if let Some(Node::Item(item)) = parent_node { if let ItemKind::Impl(_, _, _, _, Some(..), _, _) = item.node { return; } } let mut v = EscapeDelegate { cx, set: HirIdSet::default(), too_large_for_stack: self.too_large_for_stack, }; let fn_def_id = cx.tcx.hir().local_def_id(hir_id); let region_scope_tree = &cx.tcx.region_scope_tree(fn_def_id); ExprUseVisitor::new( &mut v, cx.tcx, fn_def_id, cx.param_env, region_scope_tree, cx.tables, None, ) .consume_body(body); for node in v.set { span_lint( cx, BOXED_LOCAL, cx.tcx.hir().span(node), "local variable doesn't need to be boxed here", ); } } } // TODO: Replace with Map::is_argument(..) when it's fixed fn is_argument(map: &hir::map::Map<'_>, id: HirId) -> bool { match map.find(id) { Some(Node::Binding(_)) => (), _ => return false, } match map.find(map.get_parent_node(id)) { Some(Node::Arg(_)) => true, _ => false, } } impl<'a, 'tcx> Delegate<'tcx> for EscapeDelegate<'a, 'tcx> { fn consume(&mut self, _: HirId, _: Span, cmt: &cmt_<'tcx>, mode: ConsumeMode) { if let Categorization::Local(lid) = cmt.cat { if let Move(DirectRefMove) | Move(CaptureMove) = mode { // moved out or in. clearly can't be localized self.set.remove(&lid); } } } fn matched_pat(&mut self, _: &Pat, _: &cmt_<'tcx>, _: MatchMode) {} fn consume_pat(&mut self, consume_pat: &Pat, cmt: &cmt_<'tcx>, _: ConsumeMode) { let map = &self.cx.tcx.hir(); if is_argument(map, consume_pat.hir_id) { // Skip closure arguments let parent_id = map.get_parent_node(consume_pat.hir_id); if let Some(Node::Expr(..)) = map.find(map.get_parent_node(parent_id)) { return; } if is_non_trait_box(cmt.ty) && !self.is_large_box(cmt.ty) { self.set.insert(consume_pat.hir_id); } return; } if let Categorization::Rvalue(..) = cmt.cat { if let Some(Node::Stmt(st)) = map.find(map.get_parent_node(cmt.hir_id)) { if let StmtKind::Local(ref loc) = st.node { if let Some(ref ex) = loc.init { if let ExprKind::Box(..) = ex.node { if is_non_trait_box(cmt.ty) && !self.is_large_box(cmt.ty) { // let x = box (...) self.set.insert(consume_pat.hir_id); } // TODO Box::new // TODO vec![] // TODO "foo".to_owned() and friends } } } } } if let Categorization::Local(lid) = cmt.cat { if self.set.contains(&lid) { // let y = x where x is known // remove x, insert y self.set.insert(consume_pat.hir_id); self.set.remove(&lid); } } } fn borrow( &mut self, _: HirId, _: Span, cmt: &cmt_<'tcx>, _: ty::Region<'_>, _: ty::BorrowKind, loan_cause: LoanCause, ) { if let Categorization::Local(lid) = cmt.cat { match loan_cause { // `x.foo()` // Used without autoderef-ing (i.e., `x.clone()`). LoanCause::AutoRef | // `&x` // `foo(&x)` where no extra autoref-ing is happening. LoanCause::AddrOf | // `match x` can move. LoanCause::MatchDiscriminant => { self.set.remove(&lid); } // Do nothing for matches, etc. These can't escape. _ => {} } } } fn decl_without_init(&mut self, _: HirId, _: Span) {} fn mutate(&mut self, _: HirId, _: Span, _: &cmt_<'tcx>, _: MutateMode) {} } impl<'a, 'tcx> EscapeDelegate<'a, 'tcx> { fn is_large_box(&self, ty: Ty<'tcx>) -> bool { // Large types need to be boxed to avoid stack overflows. if ty.is_box() { self.cx.layout_of(ty.boxed_ty()).ok().map_or(0, |l| l.size.bytes()) > self.too_large_for_stack } else { false } } }