clippy_lints/src/trivially_copy_pass_by_ref.rs

   1 use std::cmp;
   2
   3 use crate::utils::{in_macro_or_desugar, is_copy, is_self_ty, snippet, span_lint_and_sugg};
   4 use if_chain::if_chain;
   5 use matches::matches;
   6 use rustc::hir;
   7 use rustc::hir::intravisit::FnKind;
   8 use rustc::hir::*;
   9 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
  10 use rustc::session::config::Config as SessionConfig;
  11 use rustc::ty::{self, FnSig};
  12 use rustc::{declare_tool_lint, impl_lint_pass};
  13 use rustc_errors::Applicability;
  14 use rustc_target::abi::LayoutOf;
  15 use rustc_target::spec::abi::Abi;
  16 use syntax_pos::Span;
  17
  18 declare_clippy_lint! {
  19     /// **What it does:** Checks for functions taking arguments by reference, where
  20     /// the argument type is `Copy` and small enough to be more efficient to always
  21     /// pass by value.
  22     ///
  23     /// **Why is this bad?** In many calling conventions instances of structs will
  24     /// be passed through registers if they fit into two or less general purpose
  25     /// registers.
  26     ///
  27     /// **Known problems:** This lint is target register size dependent, it is
  28     /// limited to 32-bit to try and reduce portability problems between 32 and
  29     /// 64-bit, but if you are compiling for 8 or 16-bit targets then the limit
  30     /// will be different.
  31     ///
  32     /// The configuration option `trivial_copy_size_limit` can be set to override
  33     /// this limit for a project.
  34     ///
  35     /// This lint attempts to allow passing arguments by reference if a reference
  36     /// to that argument is returned. This is implemented by comparing the lifetime
  37     /// of the argument and return value for equality. However, this can cause
  38     /// false positives in cases involving multiple lifetimes that are bounded by
  39     /// each other.
  40     ///
  41     /// **Example:**
  42     /// ```rust
  43     /// fn foo(v: &u32) {
  44     ///     assert_eq!(v, 42);
  45     /// }
  46     /// // should be
  47     /// fn foo(v: u32) {
  48     ///     assert_eq!(v, 42);
  49     /// }
  50     /// ```
  51     pub TRIVIALLY_COPY_PASS_BY_REF,
  52     perf,
  53     "functions taking small copyable arguments by reference"
  54 }
  55
  56 pub struct TriviallyCopyPassByRef {
  57     limit: u64,
  58 }
  59
  60 impl<'a, 'tcx> TriviallyCopyPassByRef {
  61     pub fn new(limit: Option<u64>, target: &SessionConfig) -> Self {
  62         let limit = limit.unwrap_or_else(|| {
  63             let bit_width = target.usize_ty.bit_width().expect("usize should have a width") as u64;
  64             // Cap the calculated bit width at 32-bits to reduce
  65             // portability problems between 32 and 64-bit targets
  66             let bit_width = cmp::min(bit_width, 32);
  67             #[allow(clippy::integer_division)]
  68             let byte_width = bit_width / 8;
  69             // Use a limit of 2 times the register byte width
  70             byte_width * 2
  71         });
  72         Self { limit }
  73     }
  74
  75     fn check_trait_method(&mut self, cx: &LateContext<'_, 'tcx>, item: &TraitItemRef) {
  76         let method_def_id = cx.tcx.hir().local_def_id_from_hir_id(item.id.hir_id);
  77         let method_sig = cx.tcx.fn_sig(method_def_id);
  78         let method_sig = cx.tcx.erase_late_bound_regions(&method_sig);
  79
  80         let decl = match cx.tcx.hir().fn_decl_by_hir_id(item.id.hir_id) {
  81             Some(b) => b,
  82             None => return,
  83         };
  84
  85         self.check_poly_fn(cx, &decl, &method_sig, None);
  86     }
  87
  88     fn check_poly_fn(&mut self, cx: &LateContext<'_, 'tcx>, decl: &FnDecl, sig: &FnSig<'tcx>, span: Option<Span>) {
  89         // Use lifetimes to determine if we're returning a reference to the
  90         // argument. In that case we can't switch to pass-by-value as the
  91         // argument will not live long enough.
  92         let output_lts = match sig.output().sty {
  93             ty::Ref(output_lt, _, _) => vec![output_lt],
  94             ty::Adt(_, substs) => substs.regions().collect(),
  95             _ => vec![],
  96         };
  97
  98         for (input, &ty) in decl.inputs.iter().zip(sig.inputs()) {
  99             // All spans generated from a proc-macro invocation are the same...
 100             match span {
 101                 Some(s) if s == input.span => return,
 102                 _ => (),
 103             }
 104
 105             if_chain! {
 106                 if let ty::Ref(input_lt, ty, Mutability::MutImmutable) = ty.sty;
 107                 if !output_lts.contains(&input_lt);
 108                 if is_copy(cx, ty);
 109                 if let Some(size) = cx.layout_of(ty).ok().map(|l| l.size.bytes());
 110                 if size <= self.limit;
 111                 if let hir::TyKind::Rptr(_, MutTy { ty: ref decl_ty, .. }) = input.node;
 112                 then {
 113                     let value_type = if is_self_ty(decl_ty) {
 114                         "self".into()
 115                     } else {
 116                         snippet(cx, decl_ty.span, "_").into()
 117                     };
 118                     span_lint_and_sugg(
 119                         cx,
 120                         TRIVIALLY_COPY_PASS_BY_REF,
 121                         input.span,
 122                         &format!("this argument ({} byte) is passed by reference, but would be more efficient if passed by value (limit: {} byte)", size, self.limit),
 123                         "consider passing by value instead",
 124                         value_type,
 125                         Applicability::Unspecified,
 126                     );
 127                 }
 128             }
 129         }
 130     }
 131
 132     fn check_trait_items(&mut self, cx: &LateContext<'_, '_>, trait_items: &[TraitItemRef]) {
 133         for item in trait_items {
 134             if let AssocItemKind::Method { .. } = item.kind {
 135                 self.check_trait_method(cx, item);
 136             }
 137         }
 138     }
 139 }
 140
 141 impl_lint_pass!(TriviallyCopyPassByRef => [TRIVIALLY_COPY_PASS_BY_REF]);
 142
 143 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TriviallyCopyPassByRef {
 144     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
 145         if in_macro_or_desugar(item.span) {
 146             return;
 147         }
 148         if let ItemKind::Trait(_, _, _, _, ref trait_items) = item.node {
 149             self.check_trait_items(cx, trait_items);
 150         }
 151     }
 152
 153     fn check_fn(
 154         &mut self,
 155         cx: &LateContext<'a, 'tcx>,
 156         kind: FnKind<'tcx>,
 157         decl: &'tcx FnDecl,
 158         _body: &'tcx Body,
 159         span: Span,
 160         hir_id: HirId,
 161     ) {
 162         if in_macro_or_desugar(span) {
 163             return;
 164         }
 165
 166         match kind {
 167             FnKind::ItemFn(.., header, _, attrs) => {
 168                 if header.abi != Abi::Rust {
 169                     return;
 170                 }
 171                 for a in attrs {
 172                     if a.meta_item_list().is_some() && a.check_name(sym!(proc_macro_derive)) {
 173                         return;
 174                     }
 175                 }
 176             },
 177             FnKind::Method(..) => (),
 178             _ => return,
 179         }
 180
 181         // Exclude non-inherent impls
 182         if let Some(Node::Item(item)) = cx
 183             .tcx
 184             .hir()
 185             .find_by_hir_id(cx.tcx.hir().get_parent_node_by_hir_id(hir_id))
 186         {
 187             if matches!(item.node, ItemKind::Impl(_, _, _, _, Some(_), _, _) |
 188                 ItemKind::Trait(..))
 189             {
 190                 return;
 191             }
 192         }
 193
 194         let fn_def_id = cx.tcx.hir().local_def_id_from_hir_id(hir_id);
 195
 196         let fn_sig = cx.tcx.fn_sig(fn_def_id);
 197         let fn_sig = cx.tcx.erase_late_bound_regions(&fn_sig);
 198
 199         self.check_poly_fn(cx, decl, &fn_sig, Some(span));
 200     }
 201 }