rust/clippy_lints/src/mutex_atomic.rs

105 lines
3.4 KiB
Rust
Raw Normal View History

2016-07-15 17:25:44 -05:00
//! Checks for uses of mutex where an atomic value could be used
//!
//! This lint is **warn** by default
use clippy_utils::diagnostics::span_lint;
use clippy_utils::ty::is_type_diagnostic_item;
2020-01-06 10:39:50 -06:00
use rustc_hir::Expr;
2020-01-12 00:08:41 -06:00
use rustc_lint::{LateContext, LateLintPass};
use rustc_middle::ty::{self, Ty};
2020-01-11 05:37:08 -06:00
use rustc_session::{declare_lint_pass, declare_tool_lint};
2018-03-28 08:24:26 -05:00
declare_clippy_lint! {
/// ### What it does
/// Checks for usages of `Mutex<X>` where an atomic will do.
///
/// ### Why is this bad?
/// Using a mutex just to make access to a plain bool or
/// reference sequential is shooting flies with cannons.
/// `std::sync::atomic::AtomicBool` and `std::sync::atomic::AtomicPtr` are leaner and
/// faster.
///
/// ### Known problems
/// This lint cannot detect if the mutex is actually used
/// for waiting before a critical section.
///
/// ### Example
/// ```rust
/// # let y = true;
///
/// // Bad
/// # use std::sync::Mutex;
/// let x = Mutex::new(&y);
///
/// // Good
/// # use std::sync::atomic::AtomicBool;
/// let x = AtomicBool::new(y);
/// ```
pub MUTEX_ATOMIC,
2018-03-28 08:24:26 -05:00
perf,
2016-07-15 17:25:44 -05:00
"using a mutex where an atomic value could be used instead"
}
2018-03-28 08:24:26 -05:00
declare_clippy_lint! {
/// ### What it does
/// Checks for usages of `Mutex<X>` where `X` is an integral
/// type.
///
/// ### Why is this bad?
/// Using a mutex just to make access to a plain integer
/// sequential is
/// shooting flies with cannons. `std::sync::atomic::AtomicUsize` is leaner and faster.
///
/// ### Known problems
/// This lint cannot detect if the mutex is actually used
/// for waiting before a critical section.
///
/// ### Example
/// ```rust
/// # use std::sync::Mutex;
/// let x = Mutex::new(0usize);
///
/// // Good
/// # use std::sync::atomic::AtomicUsize;
/// let x = AtomicUsize::new(0usize);
/// ```
pub MUTEX_INTEGER,
2018-03-29 06:41:53 -05:00
nursery,
2016-07-15 17:25:44 -05:00
"using a mutex for an integer type"
}
2019-04-08 15:43:55 -05:00
declare_lint_pass!(Mutex => [MUTEX_ATOMIC, MUTEX_INTEGER]);
impl<'tcx> LateLintPass<'tcx> for Mutex {
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
2020-07-17 03:47:04 -05:00
let ty = cx.typeck_results().expr_ty(expr);
if let ty::Adt(_, subst) = ty.kind() {
if is_type_diagnostic_item(cx, ty, sym!(mutex_type)) {
let mutex_param = subst.type_at(0);
if let Some(atomic_name) = get_atomic_name(mutex_param) {
2017-08-09 02:30:56 -05:00
let msg = format!(
"consider using an `{}` instead of a `Mutex` here; if you just want the locking \
behavior and not the internal type, consider using `Mutex<()>`",
2017-08-09 02:30:56 -05:00
atomic_name
);
match *mutex_param.kind() {
ty::Uint(t) if t != ty::UintTy::Usize => span_lint(cx, MUTEX_INTEGER, expr.span, &msg),
ty::Int(t) if t != ty::IntTy::Isize => span_lint(cx, MUTEX_INTEGER, expr.span, &msg),
2016-01-03 22:26:12 -06:00
_ => span_lint(cx, MUTEX_ATOMIC, expr.span, &msg),
2015-12-31 14:39:03 -06:00
};
}
}
}
}
}
fn get_atomic_name(ty: Ty<'_>) -> Option<&'static str> {
match ty.kind() {
ty::Bool => Some("AtomicBool"),
ty::Uint(_) => Some("AtomicUsize"),
ty::Int(_) => Some("AtomicIsize"),
ty::RawPtr(_) => Some("AtomicPtr"),
2016-01-03 22:26:12 -06:00
_ => None,
}
}