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