clippy_lints/src/trivially_copy_pass_by_ref.rs

   1 // Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution.
   3 //
   4 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   5 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   7 // option. This file may not be copied, modified, or distributed
   8 // except according to those terms.
   9
  10
  11 use std::cmp;
  12
  13 use matches::matches;
  14 use crate::rustc::hir;
  15 use crate::rustc::hir::*;
  16 use crate::rustc::hir::intravisit::FnKind;
  17 use crate::rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
  18 use crate::rustc::{declare_tool_lint, lint_array};
  19 use if_chain::if_chain;
  20 use crate::rustc::ty::TyKind;
  21 use crate::rustc::session::config::Config as SessionConfig;
  22 use crate::rustc_target::spec::abi::Abi;
  23 use crate::rustc_target::abi::LayoutOf;
  24 use crate::syntax::ast::NodeId;
  25 use crate::syntax_pos::Span;
  26 use crate::utils::{in_macro, is_copy, is_self, span_lint_and_sugg, snippet};
  27
  28 /// **What it does:** Checks for functions taking arguments by reference, where
  29 /// the argument type is `Copy` and small enough to be more efficient to always
  30 /// pass by value.
  31 ///
  32 /// **Why is this bad?** In many calling conventions instances of structs will
  33 /// be passed through registers if they fit into two or less general purpose
  34 /// registers.
  35 ///
  36 /// **Known problems:** This lint is target register size dependent, it is
  37 /// limited to 32-bit to try and reduce portability problems between 32 and
  38 /// 64-bit, but if you are compiling for 8 or 16-bit targets then the limit
  39 /// will be different.
  40 ///
  41 /// The configuration option `trivial_copy_size_limit` can be set to override
  42 /// this limit for a project.
  43 ///
  44 /// This lint attempts to allow passing arguments by reference if a reference
  45 /// to that argument is returned. This is implemented by comparing the lifetime
  46 /// of the argument and return value for equality. However, this can cause
  47 /// false positives in cases involving multiple lifetimes that are bounded by
  48 /// each other.
  49 ///
  50 /// **Example:**
  51 /// ```rust
  52 /// fn foo(v: &u32) {
  53 ///     assert_eq!(v, 42);
  54 /// }
  55 /// // should be
  56 /// fn foo(v: u32) {
  57 ///     assert_eq!(v, 42);
  58 /// }
  59 /// ```
  60 declare_clippy_lint! {
  61     pub TRIVIALLY_COPY_PASS_BY_REF,
  62     perf,
  63     "functions taking small copyable arguments by reference"
  64 }
  65
  66 pub struct TriviallyCopyPassByRef {
  67     limit: u64,
  68 }
  69
  70 impl TriviallyCopyPassByRef {
  71     pub fn new(limit: Option<u64>, target: &SessionConfig) -> Self {
  72         let limit = limit.unwrap_or_else(|| {
  73             let bit_width = target.usize_ty.bit_width().expect("usize should have a width") as u64;
  74             // Cap the calculated bit width at 32-bits to reduce
  75             // portability problems between 32 and 64-bit targets
  76             let bit_width = cmp::min(bit_width, 32);
  77             let byte_width = bit_width / 8;
  78             // Use a limit of 2 times the register bit width
  79             byte_width * 2
  80         });
  81         Self { limit }
  82     }
  83 }
  84
  85 impl LintPass for TriviallyCopyPassByRef {
  86     fn get_lints(&self) -> LintArray {
  87         lint_array![TRIVIALLY_COPY_PASS_BY_REF]
  88     }
  89 }
  90
  91 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TriviallyCopyPassByRef {
  92     fn check_fn(
  93         &mut self,
  94         cx: &LateContext<'a, 'tcx>,
  95         kind: FnKind<'tcx>,
  96         decl: &'tcx FnDecl,
  97         body: &'tcx Body,
  98         span: Span,
  99         node_id: NodeId,
 100     ) {
 101         if in_macro(span) {
 102             return;
 103         }
 104
 105         match kind {
 106             FnKind::ItemFn(.., header, _, attrs) => {
 107                 if header.abi != Abi::Rust {
 108                     return;
 109                 }
 110                 for a in attrs {
 111                     if a.meta_item_list().is_some() && a.name() == "proc_macro_derive" {
 112                         return;
 113                     }
 114                 }
 115             },
 116             FnKind::Method(..) => (),
 117             _ => return,
 118         }
 119
 120         // Exclude non-inherent impls
 121         if let Some(Node::Item(item)) = cx.tcx.hir.find(cx.tcx.hir.get_parent_node(node_id)) {
 122             if matches!(item.node, ItemKind::Impl(_, _, _, _, Some(_), _, _) |
 123                 ItemKind::Trait(..))
 124             {
 125                 return;
 126             }
 127         }
 128
 129         let fn_def_id = cx.tcx.hir.local_def_id(node_id);
 130
 131         let fn_sig = cx.tcx.fn_sig(fn_def_id);
 132         let fn_sig = cx.tcx.erase_late_bound_regions(&fn_sig);
 133
 134         // Use lifetimes to determine if we're returning a reference to the
 135         // argument. In that case we can't switch to pass-by-value as the
 136         // argument will not live long enough.
 137         let output_lts = match fn_sig.output().sty {
 138             TyKind::Ref(output_lt, _, _) => vec![output_lt],
 139             TyKind::Adt(_, substs) => substs.regions().collect(),
 140             _ => vec![],
 141         };
 142
 143         for ((input, &ty), arg) in decl.inputs.iter().zip(fn_sig.inputs()).zip(&body.arguments) {
 144             // All spans generated from a proc-macro invocation are the same...
 145             if span == input.span {
 146                 return;
 147             }
 148
 149             if_chain! {
 150                 if let TyKind::Ref(input_lt, ty, Mutability::MutImmutable) = ty.sty;
 151                 if !output_lts.contains(&input_lt);
 152                 if is_copy(cx, ty);
 153                 if let Some(size) = cx.layout_of(ty).ok().map(|l| l.size.bytes());
 154                 if size <= self.limit;
 155                 if let hir::TyKind::Rptr(_, MutTy { ty: ref decl_ty, .. }) = input.node;
 156                 then {
 157                     let value_type = if is_self(arg) {
 158                         "self".into()
 159                     } else {
 160                         snippet(cx, decl_ty.span, "_").into()
 161                     };
 162                     span_lint_and_sugg(
 163                         cx,
 164                         TRIVIALLY_COPY_PASS_BY_REF,
 165                         input.span,
 166                         "this argument is passed by reference, but would be more efficient if passed by value",
 167                         "consider passing by value instead",
 168                         value_type);
 169                 }
 170             }
 171         }
 172     }
 173 }