Skip to content

Commit

Permalink
Use sugg_lint_and_help
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancisMurillo committed Oct 10, 2020
1 parent 978a2ca commit 18bc948
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 10 deletions.
18 changes: 11 additions & 7 deletions clippy_lints/src/mut_mutex_lock.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use crate::utils::{is_type_diagnostic_item, span_lint_and_help};
use crate::utils::{is_type_diagnostic_item, span_lint_and_sugg};
use if_chain::if_chain;
use rustc_errors::Applicability;
use rustc_hir::{Expr, ExprKind, Mutability};
use rustc_lint::{LateContext, LateLintPass};
use rustc_middle::ty;
Expand All @@ -9,7 +10,9 @@ declare_clippy_lint! {
/// **What it does:** Checks for `&mut Mutex::lock` calls
///
/// **Why is this bad?** `Mutex::lock` is less efficient than
/// calling `Mutex::get_mut`
/// calling `Mutex::get_mut`. In addition you also have a statically
/// guarantee that the mutex isn't locked, instead of just a runtime
/// guarantee.
///
/// **Known problems:** None.
///
Expand Down Expand Up @@ -44,19 +47,20 @@ declare_lint_pass!(MutMutexLock => [MUT_MUTEX_LOCK]);
impl<'tcx> LateLintPass<'tcx> for MutMutexLock {
fn check_expr(&mut self, cx: &LateContext<'tcx>, ex: &'tcx Expr<'tcx>) {
if_chain! {
if let ExprKind::MethodCall(path, _span, args, _) = &ex.kind;
if let ExprKind::MethodCall(path, method_span, args, _) = &ex.kind;
if path.ident.name == sym!(lock);
let ty = cx.typeck_results().expr_ty(&args[0]);
if let ty::Ref(_, inner_ty, Mutability::Mut) = ty.kind();
if is_type_diagnostic_item(cx, inner_ty, sym!(mutex_type));
then {
span_lint_and_help(
span_lint_and_sugg(
cx,
MUT_MUTEX_LOCK,
ex.span,
*method_span,
"calling `&mut Mutex::lock` unnecessarily locks an exclusive (mutable) reference",
None,
"use `&mut Mutex::get_mut` instead",
"change this to",
"get_mut".to_owned(),
Applicability::MachineApplicable,
);
}
}
Expand Down
21 changes: 21 additions & 0 deletions tests/ui/mut_mutex_lock.fixed
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// run-rustfix
#![allow(dead_code, unused_mut)]
#![warn(clippy::mut_mutex_lock)]

use std::sync::{Arc, Mutex};

fn mut_mutex_lock() {
let mut value_rc = Arc::new(Mutex::new(42_u8));
let value_mutex = Arc::get_mut(&mut value_rc).unwrap();

let mut value = value_mutex.get_mut().unwrap();
*value += 1;
}

fn no_owned_mutex_lock() {
let mut value_rc = Arc::new(Mutex::new(42_u8));
let mut value = value_rc.lock().unwrap();
*value += 1;
}

fn main() {}
2 changes: 2 additions & 0 deletions tests/ui/mut_mutex_lock.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// run-rustfix
#![allow(dead_code, unused_mut)]
#![warn(clippy::mut_mutex_lock)]

use std::sync::{Arc, Mutex};
Expand Down
5 changes: 2 additions & 3 deletions tests/ui/mut_mutex_lock.stderr
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
error: calling `&mut Mutex::lock` unnecessarily locks an exclusive (mutable) reference
--> $DIR/mut_mutex_lock.rs:9:21
--> $DIR/mut_mutex_lock.rs:11:33
|
LL | let mut value = value_mutex.lock().unwrap();
| ^^^^^^^^^^^^^^^^^^
| ^^^^ help: change this to: `get_mut`
|
= note: `-D clippy::mut-mutex-lock` implied by `-D warnings`
= help: use `&mut Mutex::get_mut` instead

error: aborting due to previous error

0 comments on commit 18bc948

Please sign in to comment.