clippy_lints/src/needless_pass_by_value.rs

   1 use crate::utils::ptr::get_spans;
   2 use crate::utils::{
   3     get_trait_def_id, implements_trait, in_macro_or_desugar, is_copy, is_self, match_type, multispan_sugg, paths,
   4     snippet, snippet_opt, span_lint_and_then,
   5 };
   6 use if_chain::if_chain;
   7 use matches::matches;
   8 use rustc::hir::intravisit::FnKind;
   9 use rustc::hir::*;
  10 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
  11 use rustc::middle::expr_use_visitor as euv;
  12 use rustc::middle::mem_categorization as mc;
  13 use rustc::traits;
  14 use rustc::ty::{self, RegionKind, TypeFoldable};
  15 use rustc::{declare_lint_pass, declare_tool_lint};
  16 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  17 use rustc_errors::Applicability;
  18 use rustc_target::spec::abi::Abi;
  19 use std::borrow::Cow;
  20 use syntax::ast::Attribute;
  21 use syntax::errors::DiagnosticBuilder;
  22 use syntax_pos::Span;
  23
  24 declare_clippy_lint! {
  25     /// **What it does:** Checks for functions taking arguments by value, but not
  26     /// consuming them in its
  27     /// body.
  28     ///
  29     /// **Why is this bad?** Taking arguments by reference is more flexible and can
  30     /// sometimes avoid
  31     /// unnecessary allocations.
  32     ///
  33     /// **Known problems:**
  34     /// * This lint suggests taking an argument by reference,
  35     /// however sometimes it is better to let users decide the argument type
  36     /// (by using `Borrow` trait, for example), depending on how the function is used.
  37     ///
  38     /// **Example:**
  39     /// ```rust
  40     /// fn foo(v: Vec<i32>) {
  41     ///     assert_eq!(v.len(), 42);
  42     /// }
  43     /// // should be
  44     /// fn foo(v: &[i32]) {
  45     ///     assert_eq!(v.len(), 42);
  46     /// }
  47     /// ```
  48     pub NEEDLESS_PASS_BY_VALUE,
  49     pedantic,
  50     "functions taking arguments by value, but not consuming them in its body"
  51 }
  52
  53 declare_lint_pass!(NeedlessPassByValue => [NEEDLESS_PASS_BY_VALUE]);
  54
  55 macro_rules! need {
  56     ($e: expr) => {
  57         if let Some(x) = $e {
  58             x
  59         } else {
  60             return;
  61         }
  62     };
  63 }
  64
  65 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for NeedlessPassByValue {
  66     #[allow(clippy::too_many_lines)]
  67     fn check_fn(
  68         &mut self,
  69         cx: &LateContext<'a, 'tcx>,
  70         kind: FnKind<'tcx>,
  71         decl: &'tcx FnDecl,
  72         body: &'tcx Body,
  73         span: Span,
  74         hir_id: HirId,
  75     ) {
  76         if in_macro_or_desugar(span) {
  77             return;
  78         }
  79
  80         match kind {
  81             FnKind::ItemFn(.., header, _, attrs) => {
  82                 if header.abi != Abi::Rust || requires_exact_signature(attrs) {
  83                     return;
  84                 }
  85             },
  86             FnKind::Method(..) => (),
  87             _ => return,
  88         }
  89
  90         // Exclude non-inherent impls
  91         if let Some(Node::Item(item)) = cx
  92             .tcx
  93             .hir()
  94             .find_by_hir_id(cx.tcx.hir().get_parent_node_by_hir_id(hir_id))
  95         {
  96             if matches!(item.node, ItemKind::Impl(_, _, _, _, Some(_), _, _) |
  97                 ItemKind::Trait(..))
  98             {
  99                 return;
 100             }
 101         }
 102
 103         // Allow `Borrow` or functions to be taken by value
 104         let borrow_trait = need!(get_trait_def_id(cx, &paths::BORROW_TRAIT));
 105         let whitelisted_traits = [
 106             need!(cx.tcx.lang_items().fn_trait()),
 107             need!(cx.tcx.lang_items().fn_once_trait()),
 108             need!(cx.tcx.lang_items().fn_mut_trait()),
 109             need!(get_trait_def_id(cx, &paths::RANGE_ARGUMENT_TRAIT)),
 110         ];
 111
 112         let sized_trait = need!(cx.tcx.lang_items().sized_trait());
 113
 114         let fn_def_id = cx.tcx.hir().local_def_id_from_hir_id(hir_id);
 115
 116         let preds = traits::elaborate_predicates(cx.tcx, cx.param_env.caller_bounds.to_vec())
 117             .filter(|p| !p.is_global())
 118             .filter_map(|pred| {
 119                 if let ty::Predicate::Trait(poly_trait_ref) = pred {
 120                     if poly_trait_ref.def_id() == sized_trait || poly_trait_ref.skip_binder().has_escaping_bound_vars()
 121                     {
 122                         return None;
 123                     }
 124                     Some(poly_trait_ref)
 125                 } else {
 126                     None
 127                 }
 128             })
 129             .collect::<Vec<_>>();
 130
 131         // Collect moved variables and spans which will need dereferencings from the
 132         // function body.
 133         let MovedVariablesCtxt {
 134             moved_vars,
 135             spans_need_deref,
 136             ..
 137         } = {
 138             let mut ctx = MovedVariablesCtxt::new(cx);
 139             let region_scope_tree = &cx.tcx.region_scope_tree(fn_def_id);
 140             euv::ExprUseVisitor::new(&mut ctx, cx.tcx, cx.param_env, region_scope_tree, cx.tables, None)
 141                 .consume_body(body);
 142             ctx
 143         };
 144
 145         let fn_sig = cx.tcx.fn_sig(fn_def_id);
 146         let fn_sig = cx.tcx.erase_late_bound_regions(&fn_sig);
 147
 148         for (idx, ((input, &ty), arg)) in decl.inputs.iter().zip(fn_sig.inputs()).zip(&body.arguments).enumerate() {
 149             // All spans generated from a proc-macro invocation are the same...
 150             if span == input.span {
 151                 return;
 152             }
 153
 154             // Ignore `self`s.
 155             if idx == 0 {
 156                 if let PatKind::Binding(.., ident, _) = arg.pat.node {
 157                     if ident.as_str() == "self" {
 158                         continue;
 159                     }
 160                 }
 161             }
 162
 163             //
 164             // * Exclude a type that is specifically bounded by `Borrow`.
 165             // * Exclude a type whose reference also fulfills its bound. (e.g., `std::convert::AsRef`,
 166             //   `serde::Serialize`)
 167             let (implements_borrow_trait, all_borrowable_trait) = {
 168                 let preds = preds
 169                     .iter()
 170                     .filter(|t| t.skip_binder().self_ty() == ty)
 171                     .collect::<Vec<_>>();
 172
 173                 (
 174                     preds.iter().any(|t| t.def_id() == borrow_trait),
 175                     !preds.is_empty()
 176                         && preds.iter().all(|t| {
 177                             let ty_params = &t
 178                                 .skip_binder()
 179                                 .trait_ref
 180                                 .substs
 181                                 .iter()
 182                                 .skip(1)
 183                                 .cloned()
 184                                 .collect::<Vec<_>>();
 185                             implements_trait(cx, cx.tcx.mk_imm_ref(&RegionKind::ReEmpty, ty), t.def_id(), ty_params)
 186                         }),
 187                 )
 188             };
 189
 190             if_chain! {
 191                 if !is_self(arg);
 192                 if !ty.is_mutable_pointer();
 193                 if !is_copy(cx, ty);
 194                 if !whitelisted_traits.iter().any(|&t| implements_trait(cx, ty, t, &[]));
 195                 if !implements_borrow_trait;
 196                 if !all_borrowable_trait;
 197
 198                 if let PatKind::Binding(mode, canonical_id, ..) = arg.pat.node;
 199                 if !moved_vars.contains(&canonical_id);
 200                 then {
 201                     if mode == BindingAnnotation::Mutable || mode == BindingAnnotation::RefMut {
 202                         continue;
 203                     }
 204
 205                     // Dereference suggestion
 206                     let sugg = |db: &mut DiagnosticBuilder<'_>| {
 207                         if let ty::Adt(def, ..) = ty.sty {
 208                             if let Some(span) = cx.tcx.hir().span_if_local(def.did) {
 209                                 if cx.param_env.can_type_implement_copy(cx.tcx, ty).is_ok() {
 210                                     db.span_help(span, "consider marking this type as Copy");
 211                                 }
 212                             }
 213                         }
 214
 215                         let deref_span = spans_need_deref.get(&canonical_id);
 216                         if_chain! {
 217                             if match_type(cx, ty, &paths::VEC);
 218                             if let Some(clone_spans) =
 219                                 get_spans(cx, Some(body.id()), idx, &[("clone", ".to_owned()")]);
 220                             if let TyKind::Path(QPath::Resolved(_, ref path)) = input.node;
 221                             if let Some(elem_ty) = path.segments.iter()
 222                                 .find(|seg| seg.ident.name == "Vec")
 223                                 .and_then(|ps| ps.args.as_ref())
 224                                 .map(|params| params.args.iter().find_map(|arg| match arg {
 225                                     GenericArg::Type(ty) => Some(ty),
 226                                     _ => None,
 227                                 }).unwrap());
 228                             then {
 229                                 let slice_ty = format!("&[{}]", snippet(cx, elem_ty.span, "_"));
 230                                 db.span_suggestion(
 231                                     input.span,
 232                                     "consider changing the type to",
 233                                     slice_ty,
 234                                     Applicability::Unspecified,
 235                                 );
 236
 237                                 for (span, suggestion) in clone_spans {
 238                                     db.span_suggestion(
 239                                         span,
 240                                         &snippet_opt(cx, span)
 241                                             .map_or(
 242                                                 "change the call to".into(),
 243                                                 |x| Cow::from(format!("change `{}` to", x)),
 244                                             ),
 245                                         suggestion.into(),
 246                                         Applicability::Unspecified,
 247                                     );
 248                                 }
 249
 250                                 // cannot be destructured, no need for `*` suggestion
 251                                 assert!(deref_span.is_none());
 252                                 return;
 253                             }
 254                         }
 255
 256                         if match_type(cx, ty, &paths::STRING) {
 257                             if let Some(clone_spans) =
 258                                 get_spans(cx, Some(body.id()), idx, &[("clone", ".to_string()"), ("as_str", "")]) {
 259                                 db.span_suggestion(
 260                                     input.span,
 261                                     "consider changing the type to",
 262                                     "&str".to_string(),
 263                                     Applicability::Unspecified,
 264                                 );
 265
 266                                 for (span, suggestion) in clone_spans {
 267                                     db.span_suggestion(
 268                                         span,
 269                                         &snippet_opt(cx, span)
 270                                             .map_or(
 271                                                 "change the call to".into(),
 272                                                 |x| Cow::from(format!("change `{}` to", x))
 273                                             ),
 274                                         suggestion.into(),
 275                                         Applicability::Unspecified,
 276                                     );
 277                                 }
 278
 279                                 assert!(deref_span.is_none());
 280                                 return;
 281                             }
 282                         }
 283
 284                         let mut spans = vec![(input.span, format!("&{}", snippet(cx, input.span, "_")))];
 285
 286                         // Suggests adding `*` to dereference the added reference.
 287                         if let Some(deref_span) = deref_span {
 288                             spans.extend(
 289                                 deref_span
 290                                     .iter()
 291                                     .cloned()
 292                                     .map(|span| (span, format!("*{}", snippet(cx, span, "<expr>")))),
 293                             );
 294                             spans.sort_by_key(|&(span, _)| span);
 295                         }
 296                         multispan_sugg(db, "consider taking a reference instead".to_string(), spans);
 297                     };
 298
 299                     span_lint_and_then(
 300                         cx,
 301                         NEEDLESS_PASS_BY_VALUE,
 302                         input.span,
 303                         "this argument is passed by value, but not consumed in the function body",
 304                         sugg,
 305                     );
 306                 }
 307             }
 308         }
 309     }
 310 }
 311
 312 /// Functions marked with these attributes must have the exact signature.
 313 fn requires_exact_signature(attrs: &[Attribute]) -> bool {
 314     attrs.iter().any(|attr| {
 315         ["proc_macro", "proc_macro_attribute", "proc_macro_derive"]
 316             .iter()
 317             .any(|&allow| attr.check_name(allow))
 318     })
 319 }
 320
 321 struct MovedVariablesCtxt<'a, 'tcx: 'a> {
 322     cx: &'a LateContext<'a, 'tcx>,
 323     moved_vars: FxHashSet<HirId>,
 324     /// Spans which need to be prefixed with `*` for dereferencing the
 325     /// suggested additional reference.
 326     spans_need_deref: FxHashMap<HirId, FxHashSet<Span>>,
 327 }
 328
 329 impl<'a, 'tcx> MovedVariablesCtxt<'a, 'tcx> {
 330     fn new(cx: &'a LateContext<'a, 'tcx>) -> Self {
 331         Self {
 332             cx,
 333             moved_vars: FxHashSet::default(),
 334             spans_need_deref: FxHashMap::default(),
 335         }
 336     }
 337
 338     fn move_common(&mut self, _consume_id: HirId, _span: Span, cmt: &mc::cmt_<'tcx>) {
 339         let cmt = unwrap_downcast_or_interior(cmt);
 340
 341         if let mc::Categorization::Local(vid) = cmt.cat {
 342             self.moved_vars.insert(vid);
 343         }
 344     }
 345
 346     fn non_moving_pat(&mut self, matched_pat: &Pat, cmt: &mc::cmt_<'tcx>) {
 347         let cmt = unwrap_downcast_or_interior(cmt);
 348
 349         if let mc::Categorization::Local(vid) = cmt.cat {
 350             let mut id = matched_pat.hir_id;
 351             loop {
 352                 let parent = self.cx.tcx.hir().get_parent_node_by_hir_id(id);
 353                 if id == parent {
 354                     // no parent
 355                     return;
 356                 }
 357                 id = parent;
 358
 359                 if let Some(node) = self.cx.tcx.hir().find_by_hir_id(id) {
 360                     match node {
 361                         Node::Expr(e) => {
 362                             // `match` and `if let`
 363                             if let ExprKind::Match(ref c, ..) = e.node {
 364                                 self.spans_need_deref
 365                                     .entry(vid)
 366                                     .or_insert_with(FxHashSet::default)
 367                                     .insert(c.span);
 368                             }
 369                         },
 370
 371                         Node::Stmt(s) => {
 372                             // `let <pat> = x;`
 373                             if_chain! {
 374                                 if let StmtKind::Local(ref local) = s.node;
 375                                 then {
 376                                     self.spans_need_deref
 377                                         .entry(vid)
 378                                         .or_insert_with(FxHashSet::default)
 379                                         .insert(local.init
 380                                             .as_ref()
 381                                             .map(|e| e.span)
 382                                             .expect("`let` stmt without init aren't caught by match_pat"));
 383                                 }
 384                             }
 385                         },
 386
 387                         _ => {},
 388                     }
 389                 }
 390             }
 391         }
 392     }
 393 }
 394
 395 impl<'a, 'tcx> euv::Delegate<'tcx> for MovedVariablesCtxt<'a, 'tcx> {
 396     fn consume(&mut self, consume_id: HirId, consume_span: Span, cmt: &mc::cmt_<'tcx>, mode: euv::ConsumeMode) {
 397         if let euv::ConsumeMode::Move(_) = mode {
 398             self.move_common(consume_id, consume_span, cmt);
 399         }
 400     }
 401
 402     fn matched_pat(&mut self, matched_pat: &Pat, cmt: &mc::cmt_<'tcx>, mode: euv::MatchMode) {
 403         if let euv::MatchMode::MovingMatch = mode {
 404             self.move_common(matched_pat.hir_id, matched_pat.span, cmt);
 405         } else {
 406             self.non_moving_pat(matched_pat, cmt);
 407         }
 408     }
 409
 410     fn consume_pat(&mut self, consume_pat: &Pat, cmt: &mc::cmt_<'tcx>, mode: euv::ConsumeMode) {
 411         if let euv::ConsumeMode::Move(_) = mode {
 412             self.move_common(consume_pat.hir_id, consume_pat.span, cmt);
 413         }
 414     }
 415
 416     fn borrow(
 417         &mut self,
 418         _: HirId,
 419         _: Span,
 420         _: &mc::cmt_<'tcx>,
 421         _: ty::Region<'_>,
 422         _: ty::BorrowKind,
 423         _: euv::LoanCause,
 424     ) {
 425     }
 426
 427     fn mutate(&mut self, _: HirId, _: Span, _: &mc::cmt_<'tcx>, _: euv::MutateMode) {}
 428
 429     fn decl_without_init(&mut self, _: HirId, _: Span) {}
 430 }
 431
 432 fn unwrap_downcast_or_interior<'a, 'tcx>(mut cmt: &'a mc::cmt_<'tcx>) -> mc::cmt_<'tcx> {
 433     loop {
 434         match cmt.cat {
 435             mc::Categorization::Downcast(ref c, _) | mc::Categorization::Interior(ref c, _) => {
 436                 cmt = c;
 437             },
 438             _ => return (*cmt).clone(),
 439         }
 440     }
 441 }