-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Uplift clippy::{drop,forget}_{ref,copy}
lints
#109732
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
d36e390
Remove and fix useless drop of reference
Urgau 7dab609
Remove useless drop of copy type
Urgau 28cdbc2
Uplift clippy::drop_ref to rustc
Urgau 3d1940d
Drop uplifted clippy::drop_ref
Urgau 156f556
Uplift clippy::drop_copy to rustc
Urgau bbb24ce
Drop uplifted clippy::drop_copy
Urgau 1ef9c16
Uplift clippy::forget_ref to rustc
Urgau cf6d227
Drop uplifted clippy::forget_ref
Urgau 971b9b2
Uplift clippy::forget_copy to rustc
Urgau 3f81b6b
Drop uplifted clippy::forget_copy
Urgau 61ff271
Adjust tests for new drop and forget lints
Urgau 77773ad
Allow the drop_copy lint in some library examples
Urgau 457fa95
Use label instead of note to be more consistent with other lints
Urgau d23f895
Improve warning message by saying that it "does nothing"
Urgau e280df5
Add note to suggest using `let _ = x` to ignore the value
Urgau f5aede9
Improve code around SGX waitqueue
Urgau File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,164 @@ | ||
use rustc_hir::{Arm, Expr, ExprKind, Node}; | ||
use rustc_span::sym; | ||
|
||
use crate::{ | ||
lints::{DropCopyDiag, DropRefDiag, ForgetCopyDiag, ForgetRefDiag}, | ||
LateContext, LateLintPass, LintContext, | ||
}; | ||
|
||
declare_lint! { | ||
/// The `drop_ref` lint checks for calls to `std::mem::drop` with a reference | ||
/// instead of an owned value. | ||
/// | ||
/// ### Example | ||
/// | ||
/// ```rust | ||
/// # fn operation_that_requires_mutex_to_be_unlocked() {} // just to make it compile | ||
/// # let mutex = std::sync::Mutex::new(1); // just to make it compile | ||
/// let mut lock_guard = mutex.lock(); | ||
/// std::mem::drop(&lock_guard); // Should have been drop(lock_guard), mutex | ||
/// // still locked | ||
/// operation_that_requires_mutex_to_be_unlocked(); | ||
/// ``` | ||
/// | ||
/// {{produces}} | ||
/// | ||
/// ### Explanation | ||
/// | ||
/// Calling `drop` on a reference will only drop the | ||
/// reference itself, which is a no-op. It will not call the `drop` method (from | ||
/// the `Drop` trait implementation) on the underlying referenced value, which | ||
/// is likely what was intended. | ||
pub DROP_REF, | ||
Warn, | ||
"calls to `std::mem::drop` with a reference instead of an owned value" | ||
} | ||
|
||
declare_lint! { | ||
/// The `forget_ref` lint checks for calls to `std::mem::forget` with a reference | ||
/// instead of an owned value. | ||
/// | ||
/// ### Example | ||
/// | ||
/// ```rust | ||
/// let x = Box::new(1); | ||
/// std::mem::forget(&x); // Should have been forget(x), x will still be dropped | ||
/// ``` | ||
/// | ||
/// {{produces}} | ||
/// | ||
/// ### Explanation | ||
/// | ||
/// Calling `forget` on a reference will only forget the | ||
/// reference itself, which is a no-op. It will not forget the underlying | ||
/// referenced value, which is likely what was intended. | ||
pub FORGET_REF, | ||
Warn, | ||
"calls to `std::mem::forget` with a reference instead of an owned value" | ||
} | ||
|
||
declare_lint! { | ||
/// The `drop_copy` lint checks for calls to `std::mem::drop` with a value | ||
/// that derives the Copy trait. | ||
/// | ||
/// ### Example | ||
/// | ||
/// ```rust | ||
/// let x: i32 = 42; // i32 implements Copy | ||
/// std::mem::drop(x); // A copy of x is passed to the function, leaving the | ||
/// // original unaffected | ||
/// ``` | ||
/// | ||
/// {{produces}} | ||
/// | ||
/// ### Explanation | ||
/// | ||
/// Calling `std::mem::drop` [does nothing for types that | ||
/// implement Copy](https://doc.rust-lang.org/std/mem/fn.drop.html), since the | ||
/// value will be copied and moved into the function on invocation. | ||
pub DROP_COPY, | ||
Warn, | ||
"calls to `std::mem::drop` with a value that implements Copy" | ||
} | ||
|
||
declare_lint! { | ||
/// The `forget_copy` lint checks for calls to `std::mem::forget` with a value | ||
/// that derives the Copy trait. | ||
/// | ||
/// ### Example | ||
/// | ||
/// ```rust | ||
/// let x: i32 = 42; // i32 implements Copy | ||
/// std::mem::forget(x); // A copy of x is passed to the function, leaving the | ||
/// // original unaffected | ||
/// ``` | ||
/// | ||
/// {{produces}} | ||
/// | ||
/// ### Explanation | ||
/// | ||
/// Calling `std::mem::forget` [does nothing for types that | ||
/// implement Copy](https://doc.rust-lang.org/std/mem/fn.drop.html) since the | ||
/// value will be copied and moved into the function on invocation. | ||
/// | ||
/// An alternative, but also valid, explanation is that Copy types do not | ||
/// implement the Drop trait, which means they have no destructors. Without a | ||
/// destructor, there is nothing for `std::mem::forget` to ignore. | ||
pub FORGET_COPY, | ||
Warn, | ||
"calls to `std::mem::forget` with a value that implements Copy" | ||
} | ||
|
||
declare_lint_pass!(DropForgetUseless => [DROP_REF, FORGET_REF, DROP_COPY, FORGET_COPY]); | ||
|
||
impl<'tcx> LateLintPass<'tcx> for DropForgetUseless { | ||
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'tcx>) { | ||
if let ExprKind::Call(path, [arg]) = expr.kind | ||
&& let ExprKind::Path(ref qpath) = path.kind | ||
&& let Some(def_id) = cx.qpath_res(qpath, path.hir_id).opt_def_id() | ||
&& let Some(fn_name) = cx.tcx.get_diagnostic_name(def_id) | ||
{ | ||
let arg_ty = cx.typeck_results().expr_ty(arg); | ||
let is_copy = arg_ty.is_copy_modulo_regions(cx.tcx, cx.param_env); | ||
let drop_is_single_call_in_arm = is_single_call_in_arm(cx, arg, expr); | ||
match fn_name { | ||
sym::mem_drop if arg_ty.is_ref() && !drop_is_single_call_in_arm => { | ||
cx.emit_spanned_lint(DROP_REF, expr.span, DropRefDiag { arg_ty, label: arg.span }); | ||
}, | ||
sym::mem_forget if arg_ty.is_ref() => { | ||
cx.emit_spanned_lint(FORGET_REF, expr.span, ForgetRefDiag { arg_ty, label: arg.span }); | ||
}, | ||
sym::mem_drop if is_copy && !drop_is_single_call_in_arm => { | ||
cx.emit_spanned_lint(DROP_COPY, expr.span, DropCopyDiag { arg_ty, label: arg.span }); | ||
} | ||
sym::mem_forget if is_copy => { | ||
cx.emit_spanned_lint(FORGET_COPY, expr.span, ForgetCopyDiag { arg_ty, label: arg.span }); | ||
} | ||
_ => return, | ||
}; | ||
} | ||
} | ||
} | ||
|
||
// Dropping returned value of a function, as in the following snippet is considered idiomatic, see | ||
// rust-lang/rust-clippy#9482 for examples. | ||
// | ||
// ``` | ||
// match <var> { | ||
// <pat> => drop(fn_with_side_effect_and_returning_some_value()), | ||
// .. | ||
// } | ||
// ``` | ||
fn is_single_call_in_arm<'tcx>( | ||
cx: &LateContext<'tcx>, | ||
arg: &'tcx Expr<'_>, | ||
drop_expr: &'tcx Expr<'_>, | ||
) -> bool { | ||
if matches!(arg.kind, ExprKind::Call(..) | ExprKind::MethodCall(..)) { | ||
let parent_node = cx.tcx.hir().find_parent(drop_expr.hir_id); | ||
if let Some(Node::Arm(Arm { body, .. })) = &parent_node { | ||
return body.hir_id == drop_expr.hir_id; | ||
} | ||
} | ||
false | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.