src/tools/clippy/clippy_lints/src/if_let_mutex.rs

   1 use clippy_utils::diagnostics::span_lint_and_help;
   2 use clippy_utils::ty::is_type_diagnostic_item;
   3 use clippy_utils::SpanlessEq;
   4 use if_chain::if_chain;
   5 use rustc_hir::intravisit::{self as visit, NestedVisitorMap, Visitor};
   6 use rustc_hir::{Expr, ExprKind, MatchSource};
   7 use rustc_lint::{LateContext, LateLintPass};
   8 use rustc_middle::hir::map::Map;
   9 use rustc_session::{declare_lint_pass, declare_tool_lint};
  10
  11 declare_clippy_lint! {
  12     /// ### What it does
  13     /// Checks for `Mutex::lock` calls in `if let` expression
  14     /// with lock calls in any of the else blocks.
  15     ///
  16     /// ### Why is this bad?
  17     /// The Mutex lock remains held for the whole
  18     /// `if let ... else` block and deadlocks.
  19     ///
  20     /// ### Example
  21     /// ```rust,ignore
  22     /// if let Ok(thing) = mutex.lock() {
  23     ///     do_thing();
  24     /// } else {
  25     ///     mutex.lock();
  26     /// }
  27     /// ```
  28     /// Should be written
  29     /// ```rust,ignore
  30     /// let locked = mutex.lock();
  31     /// if let Ok(thing) = locked {
  32     ///     do_thing(thing);
  33     /// } else {
  34     ///     use_locked(locked);
  35     /// }
  36     /// ```
  37     pub IF_LET_MUTEX,
  38     correctness,
  39     "locking a `Mutex` in an `if let` block can cause deadlocks"
  40 }
  41
  42 declare_lint_pass!(IfLetMutex => [IF_LET_MUTEX]);
  43
  44 impl<'tcx> LateLintPass<'tcx> for IfLetMutex {
  45     fn check_expr(&mut self, cx: &LateContext<'tcx>, ex: &'tcx Expr<'tcx>) {
  46         let mut arm_visit = ArmVisitor {
  47             mutex_lock_called: false,
  48             found_mutex: None,
  49             cx,
  50         };
  51         let mut op_visit = OppVisitor {
  52             mutex_lock_called: false,
  53             found_mutex: None,
  54             cx,
  55         };
  56         if let ExprKind::Match(
  57             op,
  58             arms,
  59             MatchSource::IfLetDesugar {
  60                 contains_else_clause: true,
  61             },
  62         ) = ex.kind
  63         {
  64             op_visit.visit_expr(op);
  65             if op_visit.mutex_lock_called {
  66                 for arm in arms {
  67                     arm_visit.visit_arm(arm);
  68                 }
  69
  70                 if arm_visit.mutex_lock_called && arm_visit.same_mutex(cx, op_visit.found_mutex.unwrap()) {
  71                     span_lint_and_help(
  72                         cx,
  73                         IF_LET_MUTEX,
  74                         ex.span,
  75                         "calling `Mutex::lock` inside the scope of another `Mutex::lock` causes a deadlock",
  76                         None,
  77                         "move the lock call outside of the `if let ...` expression",
  78                     );
  79                 }
  80             }
  81         }
  82     }
  83 }
  84
  85 /// Checks if `Mutex::lock` is called in the `if let` expr.
  86 pub struct OppVisitor<'a, 'tcx> {
  87     mutex_lock_called: bool,
  88     found_mutex: Option<&'tcx Expr<'tcx>>,
  89     cx: &'a LateContext<'tcx>,
  90 }
  91
  92 impl<'tcx> Visitor<'tcx> for OppVisitor<'_, 'tcx> {
  93     type Map = Map<'tcx>;
  94
  95     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
  96         if let Some(mutex) = is_mutex_lock_call(self.cx, expr) {
  97             self.found_mutex = Some(mutex);
  98             self.mutex_lock_called = true;
  99             return;
 100         }
 101         visit::walk_expr(self, expr);
 102     }
 103
 104     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
 105         NestedVisitorMap::None
 106     }
 107 }
 108
 109 /// Checks if `Mutex::lock` is called in any of the branches.
 110 pub struct ArmVisitor<'a, 'tcx> {
 111     mutex_lock_called: bool,
 112     found_mutex: Option<&'tcx Expr<'tcx>>,
 113     cx: &'a LateContext<'tcx>,
 114 }
 115
 116 impl<'tcx> Visitor<'tcx> for ArmVisitor<'_, 'tcx> {
 117     type Map = Map<'tcx>;
 118
 119     fn visit_expr(&mut self, expr: &'tcx Expr<'tcx>) {
 120         if let Some(mutex) = is_mutex_lock_call(self.cx, expr) {
 121             self.found_mutex = Some(mutex);
 122             self.mutex_lock_called = true;
 123             return;
 124         }
 125         visit::walk_expr(self, expr);
 126     }
 127
 128     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
 129         NestedVisitorMap::None
 130     }
 131 }
 132
 133 impl<'tcx, 'l> ArmVisitor<'tcx, 'l> {
 134     fn same_mutex(&self, cx: &LateContext<'_>, op_mutex: &Expr<'_>) -> bool {
 135         self.found_mutex
 136             .map_or(false, |arm_mutex| SpanlessEq::new(cx).eq_expr(op_mutex, arm_mutex))
 137     }
 138 }
 139
 140 fn is_mutex_lock_call<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) -> Option<&'tcx Expr<'tcx>> {
 141     if_chain! {
 142         if let ExprKind::MethodCall(path, _span, args, _) = &expr.kind;
 143         if path.ident.as_str() == "lock";
 144         let ty = cx.typeck_results().expr_ty(&args[0]);
 145         if is_type_diagnostic_item(cx, ty, sym!(mutex_type));
 146         then {
 147             Some(&args[0])
 148         } else {
 149             None
 150         }
 151     }
 152 }