src/tools/clippy/clippy_lints/src/eval_order_dependence.rs

   1 use clippy_utils::diagnostics::{span_lint, span_lint_and_note};
   2 use clippy_utils::{get_parent_expr, path_to_local, path_to_local_id};
   3 use rustc_hir::intravisit::{walk_expr, NestedVisitorMap, Visitor};
   4 use rustc_hir::{BinOpKind, Block, Expr, ExprKind, Guard, HirId, Local, Node, Stmt, StmtKind};
   5 use rustc_lint::{LateContext, LateLintPass};
   6 use rustc_middle::hir::map::Map;
   7 use rustc_middle::ty;
   8 use rustc_session::{declare_lint_pass, declare_tool_lint};
   9
  10 declare_clippy_lint! {
  11     /// **What it does:** Checks for a read and a write to the same variable where
  12     /// whether the read occurs before or after the write depends on the evaluation
  13     /// order of sub-expressions.
  14     ///
  15     /// **Why is this bad?** It is often confusing to read. In addition, the
  16     /// sub-expression evaluation order for Rust is not well documented.
  17     ///
  18     /// **Known problems:** Code which intentionally depends on the evaluation
  19     /// order, or which is correct for any evaluation order.
  20     ///
  21     /// **Example:**
  22     /// ```rust
  23     /// let mut x = 0;
  24     ///
  25     /// // Bad
  26     /// let a = {
  27     ///     x = 1;
  28     ///     1
  29     /// } + x;
  30     /// // Unclear whether a is 1 or 2.
  31     ///
  32     /// // Good
  33     /// let tmp = {
  34     ///     x = 1;
  35     ///     1
  36     /// };
  37     /// let a = tmp + x;
  38     /// ```
  39     pub EVAL_ORDER_DEPENDENCE,
  40     complexity,
  41     "whether a variable read occurs before a write depends on sub-expression evaluation order"
  42 }
  43
  44 declare_clippy_lint! {
  45     /// **What it does:** Checks for diverging calls that are not match arms or
  46     /// statements.
  47     ///
  48     /// **Why is this bad?** It is often confusing to read. In addition, the
  49     /// sub-expression evaluation order for Rust is not well documented.
  50     ///
  51     /// **Known problems:** Someone might want to use `some_bool || panic!()` as a
  52     /// shorthand.
  53     ///
  54     /// **Example:**
  55     /// ```rust,no_run
  56     /// # fn b() -> bool { true }
  57     /// # fn c() -> bool { true }
  58     /// let a = b() || panic!() || c();
  59     /// // `c()` is dead, `panic!()` is only called if `b()` returns `false`
  60     /// let x = (a, b, c, panic!());
  61     /// // can simply be replaced by `panic!()`
  62     /// ```
  63     pub DIVERGING_SUB_EXPRESSION,
  64     complexity,
  65     "whether an expression contains a diverging sub expression"
  66 }
  67
  68 declare_lint_pass!(EvalOrderDependence => [EVAL_ORDER_DEPENDENCE, DIVERGING_SUB_EXPRESSION]);
  69
  70 impl<'tcx> LateLintPass<'tcx> for EvalOrderDependence {
  71     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
  72         // Find a write to a local variable.
  73         match expr.kind {
  74             ExprKind::Assign(ref lhs, ..) | ExprKind::AssignOp(_, ref lhs, _) => {
  75                 if let Some(var) = path_to_local(lhs) {
  76                     let mut visitor = ReadVisitor {
  77                         cx,
  78                         var,
  79                         write_expr: expr,
  80                         last_expr: expr,
  81                     };
  82                     check_for_unsequenced_reads(&mut visitor);
  83                 }
  84             },
  85             _ => {},
  86         }
  87     }
  88     fn check_stmt(&mut self, cx: &LateContext<'tcx>, stmt: &'tcx Stmt<'_>) {
  89         match stmt.kind {
  90             StmtKind::Local(ref local) => {
  91                 if let Local { init: Some(ref e), .. } = **local {
  92                     DivergenceVisitor { cx }.visit_expr(e);
  93                 }
  94             },
  95             StmtKind::Expr(ref e) | StmtKind::Semi(ref e) => DivergenceVisitor { cx }.maybe_walk_expr(e),
  96             StmtKind::Item(..) => {},
  97         }
  98     }
  99 }
 100
 101 struct DivergenceVisitor<'a, 'tcx> {
 102     cx: &'a LateContext<'tcx>,
 103 }
 104
 105 impl<'a, 'tcx> DivergenceVisitor<'a, 'tcx> {
 106     fn maybe_walk_expr(&mut self, e: &'tcx Expr<'_>) {
 107         match e.kind {
 108             ExprKind::Closure(..) => {},
 109             ExprKind::Match(ref e, arms, _) => {
 110                 self.visit_expr(e);
 111                 for arm in arms {
 112                     if let Some(Guard::If(if_expr)) = arm.guard {
 113                         self.visit_expr(if_expr)
 114                     }
 115                     // make sure top level arm expressions aren't linted
 116                     self.maybe_walk_expr(&*arm.body);
 117                 }
 118             },
 119             _ => walk_expr(self, e),
 120         }
 121     }
 122     fn report_diverging_sub_expr(&mut self, e: &Expr<'_>) {
 123         span_lint(self.cx, DIVERGING_SUB_EXPRESSION, e.span, "sub-expression diverges");
 124     }
 125 }
 126
 127 impl<'a, 'tcx> Visitor<'tcx> for DivergenceVisitor<'a, 'tcx> {
 128     type Map = Map<'tcx>;
 129
 130     fn visit_expr(&mut self, e: &'tcx Expr<'_>) {
 131         match e.kind {
 132             ExprKind::Continue(_) | ExprKind::Break(_, _) | ExprKind::Ret(_) => self.report_diverging_sub_expr(e),
 133             ExprKind::Call(ref func, _) => {
 134                 let typ = self.cx.typeck_results().expr_ty(func);
 135                 match typ.kind() {
 136                     ty::FnDef(..) | ty::FnPtr(_) => {
 137                         let sig = typ.fn_sig(self.cx.tcx);
 138                         if let ty::Never = self.cx.tcx.erase_late_bound_regions(sig).output().kind() {
 139                             self.report_diverging_sub_expr(e);
 140                         }
 141                     },
 142                     _ => {},
 143                 }
 144             },
 145             ExprKind::MethodCall(..) => {
 146                 let borrowed_table = self.cx.typeck_results();
 147                 if borrowed_table.expr_ty(e).is_never() {
 148                     self.report_diverging_sub_expr(e);
 149                 }
 150             },
 151             _ => {
 152                 // do not lint expressions referencing objects of type `!`, as that required a
 153                 // diverging expression
 154                 // to begin with
 155             },
 156         }
 157         self.maybe_walk_expr(e);
 158     }
 159     fn visit_block(&mut self, _: &'tcx Block<'_>) {
 160         // don't continue over blocks, LateLintPass already does that
 161     }
 162     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
 163         NestedVisitorMap::None
 164     }
 165 }
 166
 167 /// Walks up the AST from the given write expression (`vis.write_expr`) looking
 168 /// for reads to the same variable that are unsequenced relative to the write.
 169 ///
 170 /// This means reads for which there is a common ancestor between the read and
 171 /// the write such that
 172 ///
 173 /// * evaluating the ancestor necessarily evaluates both the read and the write (for example, `&x`
 174 ///   and `|| x = 1` don't necessarily evaluate `x`), and
 175 ///
 176 /// * which one is evaluated first depends on the order of sub-expression evaluation. Blocks, `if`s,
 177 ///   loops, `match`es, and the short-circuiting logical operators are considered to have a defined
 178 ///   evaluation order.
 179 ///
 180 /// When such a read is found, the lint is triggered.
 181 fn check_for_unsequenced_reads(vis: &mut ReadVisitor<'_, '_>) {
 182     let map = &vis.cx.tcx.hir();
 183     let mut cur_id = vis.write_expr.hir_id;
 184     loop {
 185         let parent_id = map.get_parent_node(cur_id);
 186         if parent_id == cur_id {
 187             break;
 188         }
 189         let parent_node = match map.find(parent_id) {
 190             Some(parent) => parent,
 191             None => break,
 192         };
 193
 194         let stop_early = match parent_node {
 195             Node::Expr(expr) => check_expr(vis, expr),
 196             Node::Stmt(stmt) => check_stmt(vis, stmt),
 197             Node::Item(_) => {
 198                 // We reached the top of the function, stop.
 199                 break;
 200             },
 201             _ => StopEarly::KeepGoing,
 202         };
 203         match stop_early {
 204             StopEarly::Stop => break,
 205             StopEarly::KeepGoing => {},
 206         }
 207
 208         cur_id = parent_id;
 209     }
 210 }
 211
 212 /// Whether to stop early for the loop in `check_for_unsequenced_reads`. (If
 213 /// `check_expr` weren't an independent function, this would be unnecessary and
 214 /// we could just use `break`).
 215 enum StopEarly {
 216     KeepGoing,
 217     Stop,
 218 }
 219
 220 fn check_expr<'a, 'tcx>(vis: &mut ReadVisitor<'a, 'tcx>, expr: &'tcx Expr<'_>) -> StopEarly {
 221     if expr.hir_id == vis.last_expr.hir_id {
 222         return StopEarly::KeepGoing;
 223     }
 224
 225     match expr.kind {
 226         ExprKind::Array(_)
 227         | ExprKind::Tup(_)
 228         | ExprKind::MethodCall(..)
 229         | ExprKind::Call(_, _)
 230         | ExprKind::Assign(..)
 231         | ExprKind::Index(_, _)
 232         | ExprKind::Repeat(_, _)
 233         | ExprKind::Struct(_, _, _) => {
 234             walk_expr(vis, expr);
 235         },
 236         ExprKind::Binary(op, _, _) | ExprKind::AssignOp(op, _, _) => {
 237             if op.node == BinOpKind::And || op.node == BinOpKind::Or {
 238                 // x && y and x || y always evaluate x first, so these are
 239                 // strictly sequenced.
 240             } else {
 241                 walk_expr(vis, expr);
 242             }
 243         },
 244         ExprKind::Closure(_, _, _, _, _) => {
 245             // Either
 246             //
 247             // * `var` is defined in the closure body, in which case we've reached the top of the enclosing
 248             //   function and can stop, or
 249             //
 250             // * `var` is captured by the closure, in which case, because evaluating a closure does not evaluate
 251             //   its body, we don't necessarily have a write, so we need to stop to avoid generating false
 252             //   positives.
 253             //
 254             // This is also the only place we need to stop early (grrr).
 255             return StopEarly::Stop;
 256         },
 257         // All other expressions either have only one child or strictly
 258         // sequence the evaluation order of their sub-expressions.
 259         _ => {},
 260     }
 261
 262     vis.last_expr = expr;
 263
 264     StopEarly::KeepGoing
 265 }
 266
 267 fn check_stmt<'a, 'tcx>(vis: &mut ReadVisitor<'a, 'tcx>, stmt: &'tcx Stmt<'_>) -> StopEarly {
 268     match stmt.kind {
 269         StmtKind::Expr(ref expr) | StmtKind::Semi(ref expr) => check_expr(vis, expr),
 270         // If the declaration is of a local variable, check its initializer
 271         // expression if it has one. Otherwise, keep going.
 272         StmtKind::Local(ref local) => local
 273             .init
 274             .as_ref()
 275             .map_or(StopEarly::KeepGoing, |expr| check_expr(vis, expr)),
 276         StmtKind::Item(..) => StopEarly::KeepGoing,
 277     }
 278 }
 279
 280 /// A visitor that looks for reads from a variable.
 281 struct ReadVisitor<'a, 'tcx> {
 282     cx: &'a LateContext<'tcx>,
 283     /// The ID of the variable we're looking for.
 284     var: HirId,
 285     /// The expressions where the write to the variable occurred (for reporting
 286     /// in the lint).
 287     write_expr: &'tcx Expr<'tcx>,
 288     /// The last (highest in the AST) expression we've checked, so we know not
 289     /// to recheck it.
 290     last_expr: &'tcx Expr<'tcx>,
 291 }
 292
 293 impl<'a, 'tcx> Visitor<'tcx> for ReadVisitor<'a, 'tcx> {
 294     type Map = Map<'tcx>;
 295
 296     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
 297         if expr.hir_id == self.last_expr.hir_id {
 298             return;
 299         }
 300
 301         if path_to_local_id(expr, self.var) {
 302             // Check that this is a read, not a write.
 303             if !is_in_assignment_position(self.cx, expr) {
 304                 span_lint_and_note(
 305                     self.cx,
 306                     EVAL_ORDER_DEPENDENCE,
 307                     expr.span,
 308                     "unsequenced read of a variable",
 309                     Some(self.write_expr.span),
 310                     "whether read occurs before this write depends on evaluation order",
 311                 );
 312             }
 313         }
 314         match expr.kind {
 315             // We're about to descend a closure. Since we don't know when (or
 316             // if) the closure will be evaluated, any reads in it might not
 317             // occur here (or ever). Like above, bail to avoid false positives.
 318             ExprKind::Closure(_, _, _, _, _) |
 319
 320             // We want to avoid a false positive when a variable name occurs
 321             // only to have its address taken, so we stop here. Technically,
 322             // this misses some weird cases, eg.
 323             //
 324             // ```rust
 325             // let mut x = 0;
 326             // let a = foo(&{x = 1; x}, x);
 327             // ```
 328             //
 329             // TODO: fix this
 330             ExprKind::AddrOf(_, _, _) => {
 331                 return;
 332             }
 333             _ => {}
 334         }
 335
 336         walk_expr(self, expr);
 337     }
 338     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
 339         NestedVisitorMap::None
 340     }
 341 }
 342
 343 /// Returns `true` if `expr` is the LHS of an assignment, like `expr = ...`.
 344 fn is_in_assignment_position(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
 345     if let Some(parent) = get_parent_expr(cx, expr) {
 346         if let ExprKind::Assign(ref lhs, ..) = parent.kind {
 347             return lhs.hir_id == expr.hir_id;
 348         }
 349     }
 350     false
 351 }