]> git.lizzy.rs Git - rust.git/blob - clippy_lints/src/redundant_clone.rs
Auto merge of #5365 - mgr-inz-rafal:issue4983_bool_updates, r=yaahc
[rust.git] / clippy_lints / src / redundant_clone.rs
1 use crate::utils::{
2     fn_has_unsatisfiable_preds, has_drop, is_copy, match_def_path, match_type, paths, snippet_opt, span_lint_hir,
3     span_lint_hir_and_then, walk_ptrs_ty_depth,
4 };
5 use if_chain::if_chain;
6 use rustc_data_structures::{fx::FxHashMap, transitive_relation::TransitiveRelation};
7 use rustc_errors::Applicability;
8 use rustc_hir::intravisit::FnKind;
9 use rustc_hir::{def_id, Body, FnDecl, HirId};
10 use rustc_index::bit_set::{BitSet, HybridBitSet};
11 use rustc_lint::{LateContext, LateLintPass};
12 use rustc_middle::mir::{
13     self, traversal,
14     visit::{MutatingUseContext, NonMutatingUseContext, PlaceContext, Visitor as _},
15 };
16 use rustc_middle::ty::{self, fold::TypeVisitor, Ty};
17 use rustc_mir::dataflow::BottomValue;
18 use rustc_mir::dataflow::{Analysis, AnalysisDomain, GenKill, GenKillAnalysis, ResultsCursor};
19 use rustc_session::{declare_lint_pass, declare_tool_lint};
20 use rustc_span::source_map::{BytePos, Span};
21 use std::convert::TryFrom;
22
23 macro_rules! unwrap_or_continue {
24     ($x:expr) => {
25         match $x {
26             Some(x) => x,
27             None => continue,
28         }
29     };
30 }
31
32 declare_clippy_lint! {
33     /// **What it does:** Checks for a redundant `clone()` (and its relatives) which clones an owned
34     /// value that is going to be dropped without further use.
35     ///
36     /// **Why is this bad?** It is not always possible for the compiler to eliminate useless
37     /// allocations and deallocations generated by redundant `clone()`s.
38     ///
39     /// **Known problems:**
40     ///
41     /// False-negatives: analysis performed by this lint is conservative and limited.
42     ///
43     /// **Example:**
44     /// ```rust
45     /// # use std::path::Path;
46     /// # #[derive(Clone)]
47     /// # struct Foo;
48     /// # impl Foo {
49     /// #     fn new() -> Self { Foo {} }
50     /// # }
51     /// # fn call(x: Foo) {}
52     /// {
53     ///     let x = Foo::new();
54     ///     call(x.clone());
55     ///     call(x.clone()); // this can just pass `x`
56     /// }
57     ///
58     /// ["lorem", "ipsum"].join(" ").to_string();
59     ///
60     /// Path::new("/a/b").join("c").to_path_buf();
61     /// ```
62     pub REDUNDANT_CLONE,
63     perf,
64     "`clone()` of an owned value that is going to be dropped immediately"
65 }
66
67 declare_lint_pass!(RedundantClone => [REDUNDANT_CLONE]);
68
69 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for RedundantClone {
70     #[allow(clippy::too_many_lines)]
71     fn check_fn(
72         &mut self,
73         cx: &LateContext<'a, 'tcx>,
74         _: FnKind<'tcx>,
75         _: &'tcx FnDecl<'_>,
76         body: &'tcx Body<'_>,
77         _: Span,
78         _: HirId,
79     ) {
80         let def_id = cx.tcx.hir().body_owner_def_id(body.id());
81
82         // Building MIR for `fn`s with unsatisfiable preds results in ICE.
83         if fn_has_unsatisfiable_preds(cx, def_id) {
84             return;
85         }
86
87         let mir = cx.tcx.optimized_mir(def_id);
88         let mir_read_only = mir.unwrap_read_only();
89
90         let maybe_storage_live_result = MaybeStorageLive
91             .into_engine(cx.tcx, mir, def_id)
92             .iterate_to_fixpoint()
93             .into_results_cursor(mir);
94         let mut possible_borrower = {
95             let mut vis = PossibleBorrowerVisitor::new(cx, mir);
96             vis.visit_body(&mir_read_only);
97             vis.into_map(cx, maybe_storage_live_result)
98         };
99
100         for (bb, bbdata) in mir.basic_blocks().iter_enumerated() {
101             let terminator = bbdata.terminator();
102
103             if terminator.source_info.span.from_expansion() {
104                 continue;
105             }
106
107             // Give up on loops
108             if terminator.successors().any(|s| *s == bb) {
109                 continue;
110             }
111
112             let (fn_def_id, arg, arg_ty, clone_ret) =
113                 unwrap_or_continue!(is_call_with_ref_arg(cx, mir, &terminator.kind));
114
115             let from_borrow = match_def_path(cx, fn_def_id, &paths::CLONE_TRAIT_METHOD)
116                 || match_def_path(cx, fn_def_id, &paths::TO_OWNED_METHOD)
117                 || (match_def_path(cx, fn_def_id, &paths::TO_STRING_METHOD) && match_type(cx, arg_ty, &paths::STRING));
118
119             let from_deref = !from_borrow
120                 && (match_def_path(cx, fn_def_id, &paths::PATH_TO_PATH_BUF)
121                     || match_def_path(cx, fn_def_id, &paths::OS_STR_TO_OS_STRING));
122
123             if !from_borrow && !from_deref {
124                 continue;
125             }
126
127             // `{ cloned = &arg; clone(move cloned); }` or `{ cloned = &arg; to_path_buf(cloned); }`
128             let (cloned, cannot_move_out) = unwrap_or_continue!(find_stmt_assigns_to(cx, mir, arg, from_borrow, bb));
129
130             let loc = mir::Location {
131                 block: bb,
132                 statement_index: bbdata.statements.len(),
133             };
134
135             // `Local` to be cloned, and a local of `clone` call's destination
136             let (local, ret_local) = if from_borrow {
137                 // `res = clone(arg)` can be turned into `res = move arg;`
138                 // if `arg` is the only borrow of `cloned` at this point.
139
140                 if cannot_move_out || !possible_borrower.only_borrowers(&[arg], cloned, loc) {
141                     continue;
142                 }
143
144                 (cloned, clone_ret)
145             } else {
146                 // `arg` is a reference as it is `.deref()`ed in the previous block.
147                 // Look into the predecessor block and find out the source of deref.
148
149                 let ps = mir_read_only.predecessors_for(bb);
150                 if ps.len() != 1 {
151                     continue;
152                 }
153                 let pred_terminator = mir[ps[0]].terminator();
154
155                 // receiver of the `deref()` call
156                 let (pred_arg, deref_clone_ret) = if_chain! {
157                     if let Some((pred_fn_def_id, pred_arg, pred_arg_ty, res)) =
158                         is_call_with_ref_arg(cx, mir, &pred_terminator.kind);
159                     if res == cloned;
160                     if match_def_path(cx, pred_fn_def_id, &paths::DEREF_TRAIT_METHOD);
161                     if match_type(cx, pred_arg_ty, &paths::PATH_BUF)
162                         || match_type(cx, pred_arg_ty, &paths::OS_STRING);
163                     then {
164                         (pred_arg, res)
165                     } else {
166                         continue;
167                     }
168                 };
169
170                 let (local, cannot_move_out) =
171                     unwrap_or_continue!(find_stmt_assigns_to(cx, mir, pred_arg, true, ps[0]));
172                 let loc = mir::Location {
173                     block: bb,
174                     statement_index: mir.basic_blocks()[bb].statements.len(),
175                 };
176
177                 // This can be turned into `res = move local` if `arg` and `cloned` are not borrowed
178                 // at the last statement:
179                 //
180                 // ```
181                 // pred_arg = &local;
182                 // cloned = deref(pred_arg);
183                 // arg = &cloned;
184                 // StorageDead(pred_arg);
185                 // res = to_path_buf(cloned);
186                 // ```
187                 if cannot_move_out || !possible_borrower.only_borrowers(&[arg, cloned], local, loc) {
188                     continue;
189                 }
190
191                 (local, deref_clone_ret)
192             };
193
194             let is_temp = mir_read_only.local_kind(ret_local) == mir::LocalKind::Temp;
195
196             // 1. `local` can be moved out if it is not used later.
197             // 2. If `ret_local` is a temporary and is neither consumed nor mutated, we can remove this `clone`
198             // call anyway.
199             let (used, consumed_or_mutated) = traversal::ReversePostorder::new(&mir, bb).skip(1).fold(
200                 (false, !is_temp),
201                 |(used, consumed), (tbb, tdata)| {
202                     // Short-circuit
203                     if (used && consumed) ||
204                         // Give up on loops
205                         tdata.terminator().successors().any(|s| *s == bb)
206                     {
207                         return (true, true);
208                     }
209
210                     let mut vis = LocalUseVisitor {
211                         used: (local, false),
212                         consumed_or_mutated: (ret_local, false),
213                     };
214                     vis.visit_basic_block_data(tbb, tdata);
215                     (used || vis.used.1, consumed || vis.consumed_or_mutated.1)
216                 },
217             );
218
219             if !used || !consumed_or_mutated {
220                 let span = terminator.source_info.span;
221                 let scope = terminator.source_info.scope;
222                 let node = mir.source_scopes[scope]
223                     .local_data
224                     .as_ref()
225                     .assert_crate_local()
226                     .lint_root;
227
228                 if_chain! {
229                     if let Some(snip) = snippet_opt(cx, span);
230                     if let Some(dot) = snip.rfind('.');
231                     then {
232                         let sugg_span = span.with_lo(
233                             span.lo() + BytePos(u32::try_from(dot).unwrap())
234                         );
235                         let mut app = Applicability::MaybeIncorrect;
236
237                         let mut call_snip = &snip[dot + 1..];
238                         // Machine applicable when `call_snip` looks like `foobar()`
239                         if call_snip.ends_with("()") {
240                             call_snip = call_snip[..call_snip.len()-2].trim();
241                             if call_snip.as_bytes().iter().all(|b| b.is_ascii_alphabetic() || *b == b'_') {
242                                 app = Applicability::MachineApplicable;
243                             }
244                         }
245
246                         span_lint_hir_and_then(cx, REDUNDANT_CLONE, node, sugg_span, "redundant clone", |db| {
247                             db.span_suggestion(
248                                 sugg_span,
249                                 "remove this",
250                                 String::new(),
251                                 app,
252                             );
253                             if used {
254                                 db.span_note(
255                                     span,
256                                     "cloned value is neither consumed nor mutated",
257                                 );
258                             } else {
259                                 db.span_note(
260                                     span.with_hi(span.lo() + BytePos(u32::try_from(dot).unwrap())),
261                                     "this value is dropped without further use",
262                                 );
263                             }
264                         });
265                     } else {
266                         span_lint_hir(cx, REDUNDANT_CLONE, node, span, "redundant clone");
267                     }
268                 }
269             }
270         }
271     }
272 }
273
274 /// If `kind` is `y = func(x: &T)` where `T: !Copy`, returns `(DefId of func, x, T, y)`.
275 fn is_call_with_ref_arg<'tcx>(
276     cx: &LateContext<'_, 'tcx>,
277     mir: &'tcx mir::Body<'tcx>,
278     kind: &'tcx mir::TerminatorKind<'tcx>,
279 ) -> Option<(def_id::DefId, mir::Local, Ty<'tcx>, mir::Local)> {
280     if_chain! {
281         if let mir::TerminatorKind::Call { func, args, destination, .. } = kind;
282         if args.len() == 1;
283         if let mir::Operand::Move(mir::Place { local, .. }) = &args[0];
284         if let ty::FnDef(def_id, _) = func.ty(&*mir, cx.tcx).kind;
285         if let (inner_ty, 1) = walk_ptrs_ty_depth(args[0].ty(&*mir, cx.tcx));
286         if !is_copy(cx, inner_ty);
287         then {
288             Some((def_id, *local, inner_ty, destination.as_ref().map(|(dest, _)| dest)?.as_local()?))
289         } else {
290             None
291         }
292     }
293 }
294
295 type CannotMoveOut = bool;
296
297 /// Finds the first `to = (&)from`, and returns
298 /// ``Some((from, whether `from` cannot be moved out))``.
299 fn find_stmt_assigns_to<'tcx>(
300     cx: &LateContext<'_, 'tcx>,
301     mir: &mir::Body<'tcx>,
302     to_local: mir::Local,
303     by_ref: bool,
304     bb: mir::BasicBlock,
305 ) -> Option<(mir::Local, CannotMoveOut)> {
306     let rvalue = mir.basic_blocks()[bb].statements.iter().rev().find_map(|stmt| {
307         if let mir::StatementKind::Assign(box (mir::Place { local, .. }, v)) = &stmt.kind {
308             return if *local == to_local { Some(v) } else { None };
309         }
310
311         None
312     })?;
313
314     match (by_ref, &*rvalue) {
315         (true, mir::Rvalue::Ref(_, _, place)) | (false, mir::Rvalue::Use(mir::Operand::Copy(place))) => {
316             base_local_and_movability(cx, mir, *place)
317         },
318         (false, mir::Rvalue::Ref(_, _, place)) => {
319             if let [mir::ProjectionElem::Deref] = place.as_ref().projection {
320                 base_local_and_movability(cx, mir, *place)
321             } else {
322                 None
323             }
324         },
325         _ => None,
326     }
327 }
328
329 /// Extracts and returns the undermost base `Local` of given `place`. Returns `place` itself
330 /// if it is already a `Local`.
331 ///
332 /// Also reports whether given `place` cannot be moved out.
333 fn base_local_and_movability<'tcx>(
334     cx: &LateContext<'_, 'tcx>,
335     mir: &mir::Body<'tcx>,
336     place: mir::Place<'tcx>,
337 ) -> Option<(mir::Local, CannotMoveOut)> {
338     use rustc_middle::mir::PlaceRef;
339
340     // Dereference. You cannot move things out from a borrowed value.
341     let mut deref = false;
342     // Accessing a field of an ADT that has `Drop`. Moving the field out will cause E0509.
343     let mut field = false;
344
345     let PlaceRef { local, mut projection } = place.as_ref();
346     while let [base @ .., elem] = projection {
347         projection = base;
348         deref |= matches!(elem, mir::ProjectionElem::Deref);
349         field |= matches!(elem, mir::ProjectionElem::Field(..))
350             && has_drop(cx, mir::Place::ty_from(local, projection, &mir.local_decls, cx.tcx).ty);
351     }
352
353     Some((local, deref || field))
354 }
355
356 struct LocalUseVisitor {
357     used: (mir::Local, bool),
358     consumed_or_mutated: (mir::Local, bool),
359 }
360
361 impl<'tcx> mir::visit::Visitor<'tcx> for LocalUseVisitor {
362     fn visit_basic_block_data(&mut self, block: mir::BasicBlock, data: &mir::BasicBlockData<'tcx>) {
363         let statements = &data.statements;
364         for (statement_index, statement) in statements.iter().enumerate() {
365             self.visit_statement(statement, mir::Location { block, statement_index });
366         }
367
368         self.visit_terminator(
369             data.terminator(),
370             mir::Location {
371                 block,
372                 statement_index: statements.len(),
373             },
374         );
375     }
376
377     fn visit_place(&mut self, place: &mir::Place<'tcx>, ctx: PlaceContext, _: mir::Location) {
378         let local = place.local;
379
380         if local == self.used.0
381             && !matches!(ctx, PlaceContext::MutatingUse(MutatingUseContext::Drop) | PlaceContext::NonUse(_))
382         {
383             self.used.1 = true;
384         }
385
386         if local == self.consumed_or_mutated.0 {
387             match ctx {
388                 PlaceContext::NonMutatingUse(NonMutatingUseContext::Move)
389                 | PlaceContext::MutatingUse(MutatingUseContext::Borrow) => {
390                     self.consumed_or_mutated.1 = true;
391                 },
392                 _ => {},
393             }
394         }
395     }
396 }
397
398 /// Determines liveness of each local purely based on `StorageLive`/`Dead`.
399 #[derive(Copy, Clone)]
400 struct MaybeStorageLive;
401
402 impl<'tcx> AnalysisDomain<'tcx> for MaybeStorageLive {
403     type Idx = mir::Local;
404     const NAME: &'static str = "maybe_storage_live";
405
406     fn bits_per_block(&self, body: &mir::Body<'tcx>) -> usize {
407         body.local_decls.len()
408     }
409
410     fn initialize_start_block(&self, body: &mir::Body<'tcx>, state: &mut BitSet<Self::Idx>) {
411         for arg in body.args_iter() {
412             state.insert(arg);
413         }
414     }
415 }
416
417 impl<'tcx> GenKillAnalysis<'tcx> for MaybeStorageLive {
418     fn statement_effect(&self, trans: &mut impl GenKill<Self::Idx>, stmt: &mir::Statement<'tcx>, _: mir::Location) {
419         match stmt.kind {
420             mir::StatementKind::StorageLive(l) => trans.gen(l),
421             mir::StatementKind::StorageDead(l) => trans.kill(l),
422             _ => (),
423         }
424     }
425
426     fn terminator_effect(
427         &self,
428         _trans: &mut impl GenKill<Self::Idx>,
429         _terminator: &mir::Terminator<'tcx>,
430         _loc: mir::Location,
431     ) {
432     }
433
434     fn call_return_effect(
435         &self,
436         _in_out: &mut impl GenKill<Self::Idx>,
437         _block: mir::BasicBlock,
438         _func: &mir::Operand<'tcx>,
439         _args: &[mir::Operand<'tcx>],
440         _return_place: &mir::Place<'tcx>,
441     ) {
442         // Nothing to do when a call returns successfully
443     }
444 }
445
446 impl BottomValue for MaybeStorageLive {
447     /// bottom = dead
448     const BOTTOM_VALUE: bool = false;
449 }
450
451 /// Collects the possible borrowers of each local.
452 /// For example, `b = &a; c = &a;` will make `b` and (transitively) `c`
453 /// possible borrowers of `a`.
454 struct PossibleBorrowerVisitor<'a, 'tcx> {
455     possible_borrower: TransitiveRelation<mir::Local>,
456     body: &'a mir::Body<'tcx>,
457     cx: &'a LateContext<'a, 'tcx>,
458 }
459
460 impl<'a, 'tcx> PossibleBorrowerVisitor<'a, 'tcx> {
461     fn new(cx: &'a LateContext<'a, 'tcx>, body: &'a mir::Body<'tcx>) -> Self {
462         Self {
463             possible_borrower: TransitiveRelation::default(),
464             cx,
465             body,
466         }
467     }
468
469     fn into_map(
470         self,
471         cx: &LateContext<'a, 'tcx>,
472         maybe_live: ResultsCursor<'tcx, 'tcx, MaybeStorageLive>,
473     ) -> PossibleBorrowerMap<'a, 'tcx> {
474         let mut map = FxHashMap::default();
475         for row in (1..self.body.local_decls.len()).map(mir::Local::from_usize) {
476             if is_copy(cx, self.body.local_decls[row].ty) {
477                 continue;
478             }
479
480             let borrowers = self.possible_borrower.reachable_from(&row);
481             if !borrowers.is_empty() {
482                 let mut bs = HybridBitSet::new_empty(self.body.local_decls.len());
483                 for &c in borrowers {
484                     if c != mir::Local::from_usize(0) {
485                         bs.insert(c);
486                     }
487                 }
488
489                 if !bs.is_empty() {
490                     map.insert(row, bs);
491                 }
492             }
493         }
494
495         let bs = BitSet::new_empty(self.body.local_decls.len());
496         PossibleBorrowerMap {
497             map,
498             maybe_live,
499             bitset: (bs.clone(), bs),
500         }
501     }
502 }
503
504 impl<'a, 'tcx> mir::visit::Visitor<'tcx> for PossibleBorrowerVisitor<'a, 'tcx> {
505     fn visit_assign(&mut self, place: &mir::Place<'tcx>, rvalue: &mir::Rvalue<'_>, _location: mir::Location) {
506         let lhs = place.local;
507         match rvalue {
508             mir::Rvalue::Ref(_, _, borrowed) => {
509                 self.possible_borrower.add(borrowed.local, lhs);
510             },
511             other => {
512                 if !ContainsRegion.visit_ty(place.ty(&self.body.local_decls, self.cx.tcx).ty) {
513                     return;
514                 }
515                 rvalue_locals(other, |rhs| {
516                     if lhs != rhs {
517                         self.possible_borrower.add(rhs, lhs);
518                     }
519                 });
520             },
521         }
522     }
523
524     fn visit_terminator(&mut self, terminator: &mir::Terminator<'_>, _loc: mir::Location) {
525         if let mir::TerminatorKind::Call {
526             args,
527             destination: Some((mir::Place { local: dest, .. }, _)),
528             ..
529         } = &terminator.kind
530         {
531             // If the call returns something with lifetimes,
532             // let's conservatively assume the returned value contains lifetime of all the arguments.
533             // For example, given `let y: Foo<'a> = foo(x)`, `y` is considered to be a possible borrower of `x`.
534             if !ContainsRegion.visit_ty(&self.body.local_decls[*dest].ty) {
535                 return;
536             }
537
538             for op in args {
539                 match op {
540                     mir::Operand::Copy(p) | mir::Operand::Move(p) => {
541                         self.possible_borrower.add(p.local, *dest);
542                     },
543                     _ => (),
544                 }
545             }
546         }
547     }
548 }
549
550 struct ContainsRegion;
551
552 impl TypeVisitor<'_> for ContainsRegion {
553     fn visit_region(&mut self, _: ty::Region<'_>) -> bool {
554         true
555     }
556 }
557
558 fn rvalue_locals(rvalue: &mir::Rvalue<'_>, mut visit: impl FnMut(mir::Local)) {
559     use rustc_middle::mir::Rvalue::{Aggregate, BinaryOp, Cast, CheckedBinaryOp, Repeat, UnaryOp, Use};
560
561     let mut visit_op = |op: &mir::Operand<'_>| match op {
562         mir::Operand::Copy(p) | mir::Operand::Move(p) => visit(p.local),
563         _ => (),
564     };
565
566     match rvalue {
567         Use(op) | Repeat(op, _) | Cast(_, op, _) | UnaryOp(_, op) => visit_op(op),
568         Aggregate(_, ops) => ops.iter().for_each(visit_op),
569         BinaryOp(_, lhs, rhs) | CheckedBinaryOp(_, lhs, rhs) => {
570             visit_op(lhs);
571             visit_op(rhs);
572         },
573         _ => (),
574     }
575 }
576
577 /// Result of `PossibleBorrowerVisitor`.
578 struct PossibleBorrowerMap<'a, 'tcx> {
579     /// Mapping `Local -> its possible borrowers`
580     map: FxHashMap<mir::Local, HybridBitSet<mir::Local>>,
581     maybe_live: ResultsCursor<'a, 'tcx, MaybeStorageLive>,
582     // Caches to avoid allocation of `BitSet` on every query
583     bitset: (BitSet<mir::Local>, BitSet<mir::Local>),
584 }
585
586 impl PossibleBorrowerMap<'_, '_> {
587     /// Returns true if the set of borrowers of `borrowed` living at `at` matches with `borrowers`.
588     fn only_borrowers(&mut self, borrowers: &[mir::Local], borrowed: mir::Local, at: mir::Location) -> bool {
589         self.maybe_live.seek_after(at);
590
591         self.bitset.0.clear();
592         let maybe_live = &mut self.maybe_live;
593         if let Some(bitset) = self.map.get(&borrowed) {
594             for b in bitset.iter().filter(move |b| maybe_live.contains(*b)) {
595                 self.bitset.0.insert(b);
596             }
597         } else {
598             return false;
599         }
600
601         self.bitset.1.clear();
602         for b in borrowers {
603             self.bitset.1.insert(*b);
604         }
605
606         self.bitset.0 == self.bitset.1
607     }
608 }