2 has_drop, is_copy, match_def_path, match_type, paths, snippet_opt, span_lint_hir, span_lint_hir_and_then,
5 use if_chain::if_chain;
7 use rustc::hir::intravisit::FnKind;
8 use rustc::hir::{def_id, Body, FnDecl, HirId};
9 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
12 visit::{MutatingUseContext, PlaceContext, Visitor as _},
14 use rustc::ty::{self, fold::TypeVisitor, Ty};
15 use rustc::{declare_lint_pass, declare_tool_lint};
16 use rustc_data_structures::{fx::FxHashMap, transitive_relation::TransitiveRelation};
17 use rustc_errors::Applicability;
18 use rustc_index::bit_set::{BitSet, HybridBitSet};
19 use rustc_mir::dataflow::{
20 do_dataflow, BitDenotation, BottomValue, DataflowResults, DataflowResultsCursor, DebugFormatted, GenKillSet,
22 use std::convert::TryFrom;
23 use syntax::source_map::{BytePos, Span};
25 macro_rules! unwrap_or_continue {
34 declare_clippy_lint! {
35 /// **What it does:** Checks for a redudant `clone()` (and its relatives) which clones an owned
36 /// value that is going to be dropped without further use.
38 /// **Why is this bad?** It is not always possible for the compiler to eliminate useless
39 /// allocations and deallocations generated by redundant `clone()`s.
41 /// **Known problems:**
43 /// False-negatives: analysis performed by this lint is conservative and limited.
47 /// # use std::path::Path;
48 /// # #[derive(Clone)]
51 /// # fn new() -> Self { Foo {} }
53 /// # fn call(x: Foo) {}
55 /// let x = Foo::new();
57 /// call(x.clone()); // this can just pass `x`
60 /// ["lorem", "ipsum"].join(" ").to_string();
62 /// Path::new("/a/b").join("c").to_path_buf();
66 "`clone()` of an owned value that is going to be dropped immediately"
69 declare_lint_pass!(RedundantClone => [REDUNDANT_CLONE]);
71 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for RedundantClone {
72 #[allow(clippy::too_many_lines)]
75 cx: &LateContext<'a, 'tcx>,
82 let def_id = cx.tcx.hir().body_owner_def_id(body.id());
83 let mir = cx.tcx.optimized_mir(def_id);
85 let dead_unwinds = BitSet::new_empty(mir.basic_blocks().len());
86 let maybe_storage_live_result = do_dataflow(
92 MaybeStorageLive::new(mir),
93 |bd, p| DebugFormatted::new(&bd.body.local_decls[p]),
95 let mut possible_borrower = {
96 let mut vis = PossibleBorrowerVisitor::new(cx, mir);
98 vis.into_map(cx, maybe_storage_live_result)
101 for (bb, bbdata) in mir.basic_blocks().iter_enumerated() {
102 let terminator = bbdata.terminator();
104 if terminator.source_info.span.from_expansion() {
109 if terminator.successors().any(|s| *s == bb) {
113 let (fn_def_id, arg, arg_ty, _) = unwrap_or_continue!(is_call_with_ref_arg(cx, mir, &terminator.kind));
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));
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));
123 if !from_borrow && !from_deref {
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));
130 let loc = mir::Location {
132 statement_index: bbdata.statements.len(),
136 let 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.
140 if cannot_move_out || !possible_borrower.only_borrowers(&[arg], cloned, loc) {
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.
149 let ps = mir.predecessors_for(bb);
153 let pred_terminator = mir[ps[0]].terminator();
155 // receiver of the `deref()` call
156 let pred_arg = if_chain! {
157 if let Some((pred_fn_def_id, pred_arg, pred_arg_ty, Some(res))) =
158 is_call_with_ref_arg(cx, mir, &pred_terminator.kind);
159 if res.base == mir::PlaceBase::Local(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);
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 {
174 statement_index: mir.basic_blocks()[bb].statements.len(),
177 // This can be turned into `res = move local` if `arg` and `cloned` are not borrowed
178 // at the last statement:
181 // pred_arg = &local;
182 // cloned = deref(pred_arg);
184 // StorageDead(pred_arg);
185 // res = to_path_buf(cloned);
187 if cannot_move_out || !possible_borrower.only_borrowers(&[arg, cloned], local, loc) {
194 // `local` cannot be moved out if it is used later
195 let used_later = traversal::ReversePostorder::new(&mir, bb).skip(1).any(|(tbb, tdata)| {
197 if tdata.terminator().successors().any(|s| *s == bb) {
201 let mut vis = LocalUseVisitor {
203 used_other_than_drop: false,
205 vis.visit_basic_block_data(tbb, tdata);
206 vis.used_other_than_drop
210 let span = terminator.source_info.span;
211 let node = if let mir::ClearCrossCrate::Set(scope_local_data) = &mir.source_scope_local_data {
212 scope_local_data[terminator.source_info.scope].lint_root
218 if let Some(snip) = snippet_opt(cx, span);
219 if let Some(dot) = snip.rfind('.');
221 let sugg_span = span.with_lo(
222 span.lo() + BytePos(u32::try_from(dot).unwrap())
224 let mut app = Applicability::MaybeIncorrect;
226 let mut call_snip = &snip[dot + 1..];
227 // Machine applicable when `call_snip` looks like `foobar()`
228 if call_snip.ends_with("()") {
229 call_snip = call_snip[..call_snip.len()-2].trim();
230 if call_snip.as_bytes().iter().all(|b| b.is_ascii_alphabetic() || *b == b'_') {
231 app = Applicability::MachineApplicable;
235 span_lint_hir_and_then(cx, REDUNDANT_CLONE, node, sugg_span, "redundant clone", |db| {
243 span.with_hi(span.lo() + BytePos(u32::try_from(dot).unwrap())),
244 "this value is dropped without further use",
248 span_lint_hir(cx, REDUNDANT_CLONE, node, span, "redundant clone");
256 /// If `kind` is `y = func(x: &T)` where `T: !Copy`, returns `(DefId of func, x, T, y)`.
257 fn is_call_with_ref_arg<'tcx>(
258 cx: &LateContext<'_, 'tcx>,
259 mir: &'tcx mir::Body<'tcx>,
260 kind: &'tcx mir::TerminatorKind<'tcx>,
261 ) -> Option<(def_id::DefId, mir::Local, Ty<'tcx>, Option<&'tcx mir::Place<'tcx>>)> {
263 if let mir::TerminatorKind::Call { func, args, destination, .. } = kind;
265 if let mir::Operand::Move(mir::Place { base: mir::PlaceBase::Local(local), .. }) = &args[0];
266 if let ty::FnDef(def_id, _) = func.ty(&*mir, cx.tcx).kind;
267 if let (inner_ty, 1) = walk_ptrs_ty_depth(args[0].ty(&*mir, cx.tcx));
268 if !is_copy(cx, inner_ty);
270 Some((def_id, *local, inner_ty, destination.as_ref().map(|(dest, _)| dest)))
277 type CannotMoveOut = bool;
279 /// Finds the first `to = (&)from`, and returns
280 /// ``Some((from, whether `from` cannot be moved out))``.
281 fn find_stmt_assigns_to<'tcx>(
282 cx: &LateContext<'_, 'tcx>,
283 mir: &mir::Body<'tcx>,
284 to_local: mir::Local,
287 ) -> Option<(mir::Local, CannotMoveOut)> {
288 let rvalue = mir.basic_blocks()[bb].statements.iter().rev().find_map(|stmt| {
289 if let mir::StatementKind::Assign(box (
291 base: mir::PlaceBase::Local(local),
297 return if *local == to_local { Some(v) } else { None };
303 match (by_ref, &*rvalue) {
304 (true, mir::Rvalue::Ref(_, _, place)) | (false, mir::Rvalue::Use(mir::Operand::Copy(place))) => {
305 base_local_and_movability(cx, mir, place)
311 /// Extracts and returns the undermost base `Local` of given `place`. Returns `place` itself
312 /// if it is already a `Local`.
314 /// Also reports whether given `place` cannot be moved out.
315 fn base_local_and_movability<'tcx>(
316 cx: &LateContext<'_, 'tcx>,
317 mir: &mir::Body<'tcx>,
318 place: &mir::Place<'tcx>,
319 ) -> Option<(mir::Local, CannotMoveOut)> {
320 use rustc::mir::PlaceRef;
322 // Dereference. You cannot move things out from a borrowed value.
323 let mut deref = false;
324 // Accessing a field of an ADT that has `Drop`. Moving the field out will cause E0509.
325 let mut field = false;
331 if let mir::PlaceBase::Local(local) = place_base {
332 while let [base @ .., elem] = projection {
334 deref |= matches!(elem, mir::ProjectionElem::Deref);
335 field |= matches!(elem, mir::ProjectionElem::Field(..))
338 mir::Place::ty_from(place_base, projection, &mir.local_decls, cx.tcx).ty,
342 Some((*local, deref || field))
348 struct LocalUseVisitor {
350 used_other_than_drop: bool,
353 impl<'tcx> mir::visit::Visitor<'tcx> for LocalUseVisitor {
354 fn visit_basic_block_data(&mut self, block: mir::BasicBlock, data: &mir::BasicBlockData<'tcx>) {
355 let statements = &data.statements;
356 for (statement_index, statement) in statements.iter().enumerate() {
357 self.visit_statement(statement, mir::Location { block, statement_index });
359 // Once flagged, skip remaining statements
360 if self.used_other_than_drop {
365 self.visit_terminator(
369 statement_index: statements.len(),
374 fn visit_local(&mut self, local: &mir::Local, ctx: PlaceContext, _: mir::Location) {
376 PlaceContext::MutatingUse(MutatingUseContext::Drop) | PlaceContext::NonUse(_) => return,
380 if *local == self.local {
381 self.used_other_than_drop = true;
386 /// Determines liveness of each local purely based on `StorageLive`/`Dead`.
387 #[derive(Copy, Clone)]
388 struct MaybeStorageLive<'a, 'tcx> {
389 body: &'a mir::Body<'tcx>,
392 impl<'a, 'tcx> MaybeStorageLive<'a, 'tcx> {
393 fn new(body: &'a mir::Body<'tcx>) -> Self {
394 MaybeStorageLive { body }
398 impl<'a, 'tcx> BitDenotation<'tcx> for MaybeStorageLive<'a, 'tcx> {
399 type Idx = mir::Local;
400 fn name() -> &'static str {
403 fn bits_per_block(&self) -> usize {
404 self.body.local_decls.len()
407 fn start_block_effect(&self, on_entry: &mut BitSet<mir::Local>) {
408 for arg in self.body.args_iter() {
409 on_entry.insert(arg);
413 fn statement_effect(&self, trans: &mut GenKillSet<mir::Local>, loc: mir::Location) {
414 let stmt = &self.body[loc.block].statements[loc.statement_index];
417 mir::StatementKind::StorageLive(l) => trans.gen(l),
418 mir::StatementKind::StorageDead(l) => trans.kill(l),
423 fn terminator_effect(&self, _trans: &mut GenKillSet<mir::Local>, _loc: mir::Location) {}
425 fn propagate_call_return(
427 _in_out: &mut BitSet<mir::Local>,
428 _call_bb: mir::BasicBlock,
429 _dest_bb: mir::BasicBlock,
430 _dest_place: &mir::Place<'tcx>,
432 // Nothing to do when a call returns successfully
436 impl<'a, 'tcx> BottomValue for MaybeStorageLive<'a, 'tcx> {
438 const BOTTOM_VALUE: bool = false;
441 /// Collects the possible borrowers of each local.
442 /// For example, `b = &a; c = &a;` will make `b` and (transitively) `c`
443 /// possible borrowers of `a`.
444 struct PossibleBorrowerVisitor<'a, 'tcx> {
445 possible_borrower: TransitiveRelation<mir::Local>,
446 body: &'a mir::Body<'tcx>,
447 cx: &'a LateContext<'a, 'tcx>,
450 impl<'a, 'tcx> PossibleBorrowerVisitor<'a, 'tcx> {
451 fn new(cx: &'a LateContext<'a, 'tcx>, body: &'a mir::Body<'tcx>) -> Self {
453 possible_borrower: TransitiveRelation::default(),
461 cx: &LateContext<'a, 'tcx>,
462 maybe_live: DataflowResults<'tcx, MaybeStorageLive<'a, 'tcx>>,
463 ) -> PossibleBorrower<'a, 'tcx> {
464 let mut map = FxHashMap::default();
465 for row in (1..self.body.local_decls.len()).map(mir::Local::from_usize) {
466 if is_copy(cx, self.body.local_decls[row].ty) {
470 let borrowers = self.possible_borrower.reachable_from(&row);
471 if !borrowers.is_empty() {
472 let mut bs = HybridBitSet::new_empty(self.body.local_decls.len());
473 for &c in borrowers {
474 if c != mir::Local::from_usize(0) {
485 let bs = BitSet::new_empty(self.body.local_decls.len());
488 maybe_live: DataflowResultsCursor::new(maybe_live, self.body),
489 bitset: (bs.clone(), bs),
494 impl<'a, 'tcx> mir::visit::Visitor<'tcx> for PossibleBorrowerVisitor<'a, 'tcx> {
495 fn visit_assign(&mut self, place: &mir::Place<'tcx>, rvalue: &mir::Rvalue<'_>, _location: mir::Location) {
496 if let mir::PlaceBase::Local(lhs) = place.base {
498 mir::Rvalue::Ref(_, _, borrowed) => {
499 if let mir::PlaceBase::Local(borrowed_local) = borrowed.base {
500 self.possible_borrower.add(borrowed_local, lhs);
504 if !ContainsRegion.visit_ty(place.ty(&self.body.local_decls, self.cx.tcx).ty) {
507 rvalue_locals(other, |rhs| {
509 self.possible_borrower.add(rhs, lhs);
517 fn visit_terminator(&mut self, terminator: &mir::Terminator<'_>, _loc: mir::Location) {
518 if let mir::TerminatorKind::Call {
523 base: mir::PlaceBase::Local(dest),
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) {
540 mir::Operand::Copy(p) | mir::Operand::Move(p) => {
541 if let mir::PlaceBase::Local(arg) = p.base {
542 self.possible_borrower.add(arg, *dest);
552 struct ContainsRegion;
554 impl TypeVisitor<'_> for ContainsRegion {
555 fn visit_region(&mut self, _: ty::Region<'_>) -> bool {
560 fn rvalue_locals(rvalue: &mir::Rvalue<'_>, mut visit: impl FnMut(mir::Local)) {
561 use rustc::mir::Rvalue::*;
563 let mut visit_op = |op: &mir::Operand<'_>| match op {
564 mir::Operand::Copy(p) | mir::Operand::Move(p) => {
565 if let mir::PlaceBase::Local(l) = p.base {
573 Use(op) | Repeat(op, _) | Cast(_, op, _) | UnaryOp(_, op) => visit_op(op),
574 Aggregate(_, ops) => ops.iter().for_each(visit_op),
575 BinaryOp(_, lhs, rhs) | CheckedBinaryOp(_, lhs, rhs) => {
583 /// Result of `PossibleBorrowerVisitor`.
584 struct PossibleBorrower<'a, 'tcx> {
585 /// Mapping `Local -> its possible borrowers`
586 map: FxHashMap<mir::Local, HybridBitSet<mir::Local>>,
587 maybe_live: DataflowResultsCursor<'a, 'tcx, MaybeStorageLive<'a, 'tcx>>,
588 // Caches to avoid allocation of `BitSet` on every query
589 bitset: (BitSet<mir::Local>, BitSet<mir::Local>),
592 impl PossibleBorrower<'_, '_> {
593 /// Returns true if the set of borrowers of `borrowed` living at `at` matches with `borrowers`.
594 fn only_borrowers(&mut self, borrowers: &[mir::Local], borrowed: mir::Local, at: mir::Location) -> bool {
595 self.maybe_live.seek(at);
597 self.bitset.0.clear();
598 let maybe_live = &mut self.maybe_live;
599 if let Some(bitset) = self.map.get(&borrowed) {
600 for b in bitset.iter().filter(move |b| maybe_live.contains(*b)) {
601 self.bitset.0.insert(b);
607 self.bitset.1.clear();
609 self.bitset.1.insert(*b);
612 self.bitset.0 == self.bitset.1