rust/clippy_lints/src/swap_ptr_to_ref.rs
Yuri Astrakhan e67b2bf732 Apply uninlined_format-args to clippy_lints
This change is needed for the uninlined_format-args lint to be merged.
See https://github.com/rust-lang/rust-clippy/pull/9233
2022-09-23 13:42:59 -04:00

81 lines
3.3 KiB
Rust

use clippy_utils::diagnostics::span_lint_and_then;
use clippy_utils::source::snippet_with_context;
use clippy_utils::{match_def_path, path_def_id, paths};
use rustc_errors::Applicability;
use rustc_hir::{BorrowKind, Expr, ExprKind, Mutability, UnOp};
use rustc_lint::{LateContext, LateLintPass};
use rustc_session::{declare_lint_pass, declare_tool_lint};
use rustc_span::{Span, SyntaxContext};
declare_clippy_lint! {
/// ### What it does
/// Checks for calls to `core::mem::swap` where either parameter is derived from a pointer
///
/// ### Why is this bad?
/// When at least one parameter to `swap` is derived from a pointer it may overlap with the
/// other. This would then lead to undefined behavior.
///
/// ### Example
/// ```rust
/// unsafe fn swap(x: &[*mut u32], y: &[*mut u32]) {
/// for (&x, &y) in x.iter().zip(y) {
/// core::mem::swap(&mut *x, &mut *y);
/// }
/// }
/// ```
/// Use instead:
/// ```rust
/// unsafe fn swap(x: &[*mut u32], y: &[*mut u32]) {
/// for (&x, &y) in x.iter().zip(y) {
/// core::ptr::swap(x, y);
/// }
/// }
/// ```
#[clippy::version = "1.63.0"]
pub SWAP_PTR_TO_REF,
suspicious,
"call to `mem::swap` using pointer derived references"
}
declare_lint_pass!(SwapPtrToRef => [SWAP_PTR_TO_REF]);
impl LateLintPass<'_> for SwapPtrToRef {
fn check_expr(&mut self, cx: &LateContext<'_>, e: &Expr<'_>) {
if let ExprKind::Call(fn_expr, [arg1, arg2]) = e.kind
&& let Some(fn_id) = path_def_id(cx, fn_expr)
&& match_def_path(cx, fn_id, &paths::MEM_SWAP)
&& let ctxt = e.span.ctxt()
&& let (from_ptr1, arg1_span) = is_ptr_to_ref(cx, arg1, ctxt)
&& let (from_ptr2, arg2_span) = is_ptr_to_ref(cx, arg2, ctxt)
&& (from_ptr1 || from_ptr2)
{
span_lint_and_then(
cx,
SWAP_PTR_TO_REF,
e.span,
"call to `core::mem::swap` with a parameter derived from a raw pointer",
|diag| {
if !((from_ptr1 && arg1_span.is_none()) || (from_ptr2 && arg2_span.is_none())) {
let mut app = Applicability::MachineApplicable;
let snip1 = snippet_with_context(cx, arg1_span.unwrap_or(arg1.span), ctxt, "..", &mut app).0;
let snip2 = snippet_with_context(cx, arg2_span.unwrap_or(arg2.span), ctxt, "..", &mut app).0;
diag.span_suggestion(e.span, "use ptr::swap", format!("core::ptr::swap({snip1}, {snip2})"), app);
}
}
);
}
}
}
/// Checks if the expression converts a mutable pointer to a mutable reference. If it is, also
/// returns the span of the pointer expression if it's suitable for making a suggestion.
fn is_ptr_to_ref(cx: &LateContext<'_>, e: &Expr<'_>, ctxt: SyntaxContext) -> (bool, Option<Span>) {
if let ExprKind::AddrOf(BorrowKind::Ref, Mutability::Mut, borrowed_expr) = e.kind
&& let ExprKind::Unary(UnOp::Deref, derefed_expr) = borrowed_expr.kind
&& cx.typeck_results().expr_ty(derefed_expr).is_unsafe_ptr()
{
(true, (borrowed_expr.span.ctxt() == ctxt || derefed_expr.span.ctxt() == ctxt).then_some(derefed_expr.span))
} else {
(false, None)
}
}