clippy_lints/src/indexing_slicing.rs

   1 //! lint on indexing and slicing operations
   2
   3 use crate::consts::{constant, Constant};
   4 use crate::utils;
   5 use crate::utils::higher;
   6 use crate::utils::higher::Range;
   7 use rustc::ty;
   8 use rustc_hir::*;
   9 use rustc_lint::{LateContext, LateLintPass};
  10 use rustc_session::{declare_lint_pass, declare_tool_lint};
  11 use syntax::ast::RangeLimits;
  12
  13 declare_clippy_lint! {
  14     /// **What it does:** Checks for out of bounds array indexing with a constant
  15     /// index.
  16     ///
  17     /// **Why is this bad?** This will always panic at runtime.
  18     ///
  19     /// **Known problems:** Hopefully none.
  20     ///
  21     /// **Example:**
  22     /// ```no_run
  23     /// # #![allow(const_err)]
  24     /// let x = [1, 2, 3, 4];
  25     ///
  26     /// // Bad
  27     /// x[9];
  28     /// &x[2..9];
  29     ///
  30     /// // Good
  31     /// x[0];
  32     /// x[3];
  33     /// ```
  34     pub OUT_OF_BOUNDS_INDEXING,
  35     correctness,
  36     "out of bounds constant indexing"
  37 }
  38
  39 declare_clippy_lint! {
  40     /// **What it does:** Checks for usage of indexing or slicing. Arrays are special cases, this lint
  41     /// does report on arrays if we can tell that slicing operations are in bounds and does not
  42     /// lint on constant `usize` indexing on arrays because that is handled by rustc's `const_err` lint.
  43     ///
  44     /// **Why is this bad?** Indexing and slicing can panic at runtime and there are
  45     /// safe alternatives.
  46     ///
  47     /// **Known problems:** Hopefully none.
  48     ///
  49     /// **Example:**
  50     /// ```rust,no_run
  51     /// // Vector
  52     /// let x = vec![0; 5];
  53     ///
  54     /// // Bad
  55     /// x[2];
  56     /// &x[2..100];
  57     /// &x[2..];
  58     /// &x[..100];
  59     ///
  60     /// // Good
  61     /// x.get(2);
  62     /// x.get(2..100);
  63     /// x.get(2..);
  64     /// x.get(..100);
  65     ///
  66     /// // Array
  67     /// let y = [0, 1, 2, 3];
  68     ///
  69     /// // Bad
  70     /// &y[10..100];
  71     /// &y[10..];
  72     /// &y[..100];
  73     ///
  74     /// // Good
  75     /// &y[2..];
  76     /// &y[..2];
  77     /// &y[0..3];
  78     /// y.get(10);
  79     /// y.get(10..100);
  80     /// y.get(10..);
  81     /// y.get(..100);
  82     /// ```
  83     pub INDEXING_SLICING,
  84     restriction,
  85     "indexing/slicing usage"
  86 }
  87
  88 declare_lint_pass!(IndexingSlicing => [INDEXING_SLICING, OUT_OF_BOUNDS_INDEXING]);
  89
  90 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for IndexingSlicing {
  91     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) {
  92         if let ExprKind::Index(ref array, ref index) = &expr.kind {
  93             let ty = cx.tables.expr_ty(array);
  94             if let Some(range) = higher::range(cx, index) {
  95                 // Ranged indexes, i.e., &x[n..m], &x[n..], &x[..n] and &x[..]
  96                 if let ty::Array(_, s) = ty.kind {
  97                     let size: u128 = s.eval_usize(cx.tcx, cx.param_env).into();
  98
  99                     let const_range = to_const_range(cx, range, size);
 100
 101                     if let (Some(start), _) = const_range {
 102                         if start > size {
 103                             utils::span_lint(
 104                                 cx,
 105                                 OUT_OF_BOUNDS_INDEXING,
 106                                 range.start.map_or(expr.span, |start| start.span),
 107                                 "range is out of bounds",
 108                             );
 109                             return;
 110                         }
 111                     }
 112
 113                     if let (_, Some(end)) = const_range {
 114                         if end > size {
 115                             utils::span_lint(
 116                                 cx,
 117                                 OUT_OF_BOUNDS_INDEXING,
 118                                 range.end.map_or(expr.span, |end| end.span),
 119                                 "range is out of bounds",
 120                             );
 121                             return;
 122                         }
 123                     }
 124
 125                     if let (Some(_), Some(_)) = const_range {
 126                         // early return because both start and end are constants
 127                         // and we have proven above that they are in bounds
 128                         return;
 129                     }
 130                 }
 131
 132                 let help_msg = match (range.start, range.end) {
 133                     (None, Some(_)) => "Consider using `.get(..n)`or `.get_mut(..n)` instead",
 134                     (Some(_), None) => "Consider using `.get(n..)` or .get_mut(n..)` instead",
 135                     (Some(_), Some(_)) => "Consider using `.get(n..m)` or `.get_mut(n..m)` instead",
 136                     (None, None) => return, // [..] is ok.
 137                 };
 138
 139                 utils::span_help_and_lint(cx, INDEXING_SLICING, expr.span, "slicing may panic.", help_msg);
 140             } else {
 141                 // Catchall non-range index, i.e., [n] or [n << m]
 142                 if let ty::Array(..) = ty.kind {
 143                     // Index is a constant uint.
 144                     if let Some(..) = constant(cx, cx.tables, index) {
 145                         // Let rustc's `const_err` lint handle constant `usize` indexing on arrays.
 146                         return;
 147                     }
 148                 }
 149
 150                 utils::span_help_and_lint(
 151                     cx,
 152                     INDEXING_SLICING,
 153                     expr.span,
 154                     "indexing may panic.",
 155                     "Consider using `.get(n)` or `.get_mut(n)` instead",
 156                 );
 157             }
 158         }
 159     }
 160 }
 161
 162 /// Returns a tuple of options with the start and end (exclusive) values of
 163 /// the range. If the start or end is not constant, None is returned.
 164 fn to_const_range<'a, 'tcx>(
 165     cx: &LateContext<'a, 'tcx>,
 166     range: Range<'_>,
 167     array_size: u128,
 168 ) -> (Option<u128>, Option<u128>) {
 169     let s = range.start.map(|expr| constant(cx, cx.tables, expr).map(|(c, _)| c));
 170     let start = match s {
 171         Some(Some(Constant::Int(x))) => Some(x),
 172         Some(_) => None,
 173         None => Some(0),
 174     };
 175
 176     let e = range.end.map(|expr| constant(cx, cx.tables, expr).map(|(c, _)| c));
 177     let end = match e {
 178         Some(Some(Constant::Int(x))) => {
 179             if range.limits == RangeLimits::Closed {
 180                 Some(x + 1)
 181             } else {
 182                 Some(x)
 183             }
 184         },
 185         Some(_) => None,
 186         None => Some(array_size),
 187     };
 188
 189     (start, end)
 190 }