3 use crate::utils::{in_macro_or_desugar, is_copy, is_self_ty, snippet, span_lint_and_sugg};
4 use if_chain::if_chain;
7 use rustc::hir::intravisit::FnKind;
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;
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
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
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.
32 /// The configuration option `trivial_copy_size_limit` can be set to override
33 /// this limit for a project.
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
44 /// assert_eq!(v, 42);
48 /// assert_eq!(v, 42);
51 pub TRIVIALLY_COPY_PASS_BY_REF,
53 "functions taking small copyable arguments by reference"
56 pub struct TriviallyCopyPassByRef {
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
75 fn check_poly_fn(&mut self, cx: &LateContext<'_, 'tcx>, hir_id: HirId, decl: &FnDecl, span: Option<Span>) {
76 let fn_def_id = cx.tcx.hir().local_def_id_from_hir_id(hir_id);
78 let fn_sig = cx.tcx.fn_sig(fn_def_id);
79 let fn_sig = cx.tcx.erase_late_bound_regions(&fn_sig);
81 // Use lifetimes to determine if we're returning a reference to the
82 // argument. In that case we can't switch to pass-by-value as the
83 // argument will not live long enough.
84 let output_lts = match fn_sig.output().sty {
85 ty::Ref(output_lt, _, _) => vec![output_lt],
86 ty::Adt(_, substs) => substs.regions().collect(),
90 for (input, &ty) in decl.inputs.iter().zip(fn_sig.inputs()) {
91 // All spans generated from a proc-macro invocation are the same...
93 Some(s) if s == input.span => return,
98 if let ty::Ref(input_lt, ty, Mutability::MutImmutable) = ty.sty;
99 if !output_lts.contains(&input_lt);
101 if let Some(size) = cx.layout_of(ty).ok().map(|l| l.size.bytes());
102 if size <= self.limit;
103 if let hir::TyKind::Rptr(_, MutTy { ty: ref decl_ty, .. }) = input.node;
105 let value_type = if is_self_ty(decl_ty) {
108 snippet(cx, decl_ty.span, "_").into()
112 TRIVIALLY_COPY_PASS_BY_REF,
114 &format!("this argument ({} byte) is passed by reference, but would be more efficient if passed by value (limit: {} byte)", size, self.limit),
115 "consider passing by value instead",
117 Applicability::Unspecified,
125 impl_lint_pass!(TriviallyCopyPassByRef => [TRIVIALLY_COPY_PASS_BY_REF]);
127 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TriviallyCopyPassByRef {
128 fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx hir::TraitItem) {
129 if in_macro_or_desugar(item.span) {
133 if let hir::TraitItemKind::Method(method_sig, _) = &item.node {
134 self.check_poly_fn(cx, item.hir_id, &*method_sig.decl, None);
140 cx: &LateContext<'a, 'tcx>,
147 if in_macro_or_desugar(span) {
152 FnKind::ItemFn(.., header, _, attrs) => {
153 if header.abi != Abi::Rust {
157 if a.meta_item_list().is_some() && a.check_name(sym!(proc_macro_derive)) {
162 FnKind::Method(..) => (),
166 // Exclude non-inherent impls
167 if let Some(Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_node(hir_id)) {
168 if matches!(item.node, ItemKind::Impl(_, _, _, _, Some(_), _, _) |
175 self.check_poly_fn(cx, hir_id, decl, Some(span));