1 // Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution.
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.
12 use crate::rustc::hir;
13 use crate::rustc::hir::intravisit::FnKind;
14 use crate::rustc::hir::*;
15 use crate::rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
16 use crate::rustc::session::config::Config as SessionConfig;
17 use crate::rustc::ty::{self, FnSig};
18 use crate::rustc::{declare_tool_lint, lint_array};
19 use crate::rustc_errors::Applicability;
20 use crate::rustc_target::abi::LayoutOf;
21 use crate::rustc_target::spec::abi::Abi;
22 use crate::syntax::ast::NodeId;
23 use crate::syntax_pos::Span;
24 use crate::utils::{in_macro, is_copy, is_self_ty, snippet, span_lint_and_sugg};
25 use if_chain::if_chain;
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
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
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.
41 /// The configuration option `trivial_copy_size_limit` can be set to override
42 /// this limit for a project.
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
53 /// assert_eq!(v, 42);
57 /// assert_eq!(v, 42);
60 declare_clippy_lint! {
61 pub TRIVIALLY_COPY_PASS_BY_REF,
63 "functions taking small copyable arguments by reference"
66 pub struct TriviallyCopyPassByRef {
70 impl<'a, 'tcx> 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
84 fn check_trait_method(&mut self, cx: &LateContext<'_, 'tcx>, item: &TraitItemRef) {
85 let method_def_id = cx.tcx.hir().local_def_id(item.id.node_id);
86 let method_sig = cx.tcx.fn_sig(method_def_id);
87 let method_sig = cx.tcx.erase_late_bound_regions(&method_sig);
89 let decl = match cx.tcx.hir().fn_decl(item.id.node_id) {
94 self.check_poly_fn(cx, &decl, &method_sig, None);
97 fn check_poly_fn(&mut self, cx: &LateContext<'_, 'tcx>, decl: &FnDecl, sig: &FnSig<'tcx>, span: Option<Span>) {
98 // Use lifetimes to determine if we're returning a reference to the
99 // argument. In that case we can't switch to pass-by-value as the
100 // argument will not live long enough.
101 let output_lts = match sig.output().sty {
102 ty::Ref(output_lt, _, _) => vec![output_lt],
103 ty::Adt(_, substs) => substs.regions().collect(),
107 for (input, &ty) in decl.inputs.iter().zip(sig.inputs()) {
108 // All spans generated from a proc-macro invocation are the same...
110 Some(s) if s == input.span => return,
115 if let ty::Ref(input_lt, ty, Mutability::MutImmutable) = ty.sty;
116 if !output_lts.contains(&input_lt);
118 if let Some(size) = cx.layout_of(ty).ok().map(|l| l.size.bytes());
119 if size <= self.limit;
120 if let hir::TyKind::Rptr(_, MutTy { ty: ref decl_ty, .. }) = input.node;
122 let value_type = if is_self_ty(decl_ty) {
125 snippet(cx, decl_ty.span, "_").into()
129 TRIVIALLY_COPY_PASS_BY_REF,
131 "this argument is passed by reference, but would be more efficient if passed by value",
132 "consider passing by value instead",
134 Applicability::Unspecified,
141 fn check_trait_items(&mut self, cx: &LateContext<'_, '_>, trait_items: &[TraitItemRef]) {
142 for item in trait_items {
143 if let AssociatedItemKind::Method { .. } = item.kind {
144 self.check_trait_method(cx, item);
150 impl LintPass for TriviallyCopyPassByRef {
151 fn get_lints(&self) -> LintArray {
152 lint_array![TRIVIALLY_COPY_PASS_BY_REF]
156 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TriviallyCopyPassByRef {
157 fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
158 if in_macro(item.span) {
161 if let ItemKind::Trait(_, _, _, _, ref trait_items) = item.node {
162 self.check_trait_items(cx, trait_items);
168 cx: &LateContext<'a, 'tcx>,
180 FnKind::ItemFn(.., header, _, attrs) => {
181 if header.abi != Abi::Rust {
185 if a.meta_item_list().is_some() && a.name() == "proc_macro_derive" {
190 FnKind::Method(..) => (),
194 // Exclude non-inherent impls
195 if let Some(Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_node(node_id)) {
196 if matches!(item.node, ItemKind::Impl(_, _, _, _, Some(_), _, _) |
203 let fn_def_id = cx.tcx.hir().local_def_id(node_id);
205 let fn_sig = cx.tcx.fn_sig(fn_def_id);
206 let fn_sig = cx.tcx.erase_late_bound_regions(&fn_sig);
208 self.check_poly_fn(cx, decl, &fn_sig, Some(span));