clippy_lints/src/eval_order_dependence.rs

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