]> git.lizzy.rs Git - rust.git/blob - clippy_lints/src/bit_mask.rs
Merge remote-tracking branch 'origin/rust-1.31.0' into HEAD
[rust.git] / clippy_lints / src / bit_mask.rs
1 use crate::consts::{constant, Constant};
2 use crate::utils::sugg::Sugg;
3 use crate::utils::{span_lint, span_lint_and_then};
4 use if_chain::if_chain;
5 use rustc::hir::*;
6 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
7 use rustc::{declare_tool_lint, impl_lint_pass};
8 use rustc_errors::Applicability;
9 use syntax::ast::LitKind;
10 use syntax::source_map::Span;
11
12 declare_clippy_lint! {
13     /// **What it does:** Checks for incompatible bit masks in comparisons.
14     ///
15     /// The formula for detecting if an expression of the type `_ <bit_op> m
16     /// <cmp_op> c` (where `<bit_op>` is one of {`&`, `|`} and `<cmp_op>` is one of
17     /// {`!=`, `>=`, `>`, `!=`, `>=`, `>`}) can be determined from the following
18     /// table:
19     ///
20     /// |Comparison  |Bit Op|Example     |is always|Formula               |
21     /// |------------|------|------------|---------|----------------------|
22     /// |`==` or `!=`| `&`  |`x & 2 == 3`|`false`  |`c & m != c`          |
23     /// |`<`  or `>=`| `&`  |`x & 2 < 3` |`true`   |`m < c`               |
24     /// |`>`  or `<=`| `&`  |`x & 1 > 1` |`false`  |`m <= c`              |
25     /// |`==` or `!=`| `|`  |`x | 1 == 0`|`false`  |`c | m != c`          |
26     /// |`<`  or `>=`| `|`  |`x | 1 < 1` |`false`  |`m >= c`              |
27     /// |`<=` or `>` | `|`  |`x | 1 > 0` |`true`   |`m > c`               |
28     ///
29     /// **Why is this bad?** If the bits that the comparison cares about are always
30     /// set to zero or one by the bit mask, the comparison is constant `true` or
31     /// `false` (depending on mask, compared value, and operators).
32     ///
33     /// So the code is actively misleading, and the only reason someone would write
34     /// this intentionally is to win an underhanded Rust contest or create a
35     /// test-case for this lint.
36     ///
37     /// **Known problems:** None.
38     ///
39     /// **Example:**
40     /// ```rust
41     /// # let x = 1;
42     /// if (x & 1 == 2) { }
43     /// ```
44     pub BAD_BIT_MASK,
45     correctness,
46     "expressions of the form `_ & mask == select` that will only ever return `true` or `false`"
47 }
48
49 declare_clippy_lint! {
50     /// **What it does:** Checks for bit masks in comparisons which can be removed
51     /// without changing the outcome. The basic structure can be seen in the
52     /// following table:
53     ///
54     /// |Comparison| Bit Op  |Example    |equals |
55     /// |----------|---------|-----------|-------|
56     /// |`>` / `<=`|`|` / `^`|`x | 2 > 3`|`x > 3`|
57     /// |`<` / `>=`|`|` / `^`|`x ^ 1 < 4`|`x < 4`|
58     ///
59     /// **Why is this bad?** Not equally evil as [`bad_bit_mask`](#bad_bit_mask),
60     /// but still a bit misleading, because the bit mask is ineffective.
61     ///
62     /// **Known problems:** False negatives: This lint will only match instances
63     /// where we have figured out the math (which is for a power-of-two compared
64     /// value). This means things like `x | 1 >= 7` (which would be better written
65     /// as `x >= 6`) will not be reported (but bit masks like this are fairly
66     /// uncommon).
67     ///
68     /// **Example:**
69     /// ```rust
70     /// # let x = 1;
71     /// if (x | 1 > 3) {  }
72     /// ```
73     pub INEFFECTIVE_BIT_MASK,
74     correctness,
75     "expressions where a bit mask will be rendered useless by a comparison, e.g., `(x | 1) > 2`"
76 }
77
78 declare_clippy_lint! {
79     /// **What it does:** Checks for bit masks that can be replaced by a call
80     /// to `trailing_zeros`
81     ///
82     /// **Why is this bad?** `x.trailing_zeros() > 4` is much clearer than `x & 15
83     /// == 0`
84     ///
85     /// **Known problems:** llvm generates better code for `x & 15 == 0` on x86
86     ///
87     /// **Example:**
88     /// ```rust
89     /// # let x = 1;
90     /// if x & 0x1111 == 0 { }
91     /// ```
92     pub VERBOSE_BIT_MASK,
93     style,
94     "expressions where a bit mask is less readable than the corresponding method call"
95 }
96
97 #[derive(Copy, Clone)]
98 pub struct BitMask {
99     verbose_bit_mask_threshold: u64,
100 }
101
102 impl BitMask {
103     pub fn new(verbose_bit_mask_threshold: u64) -> Self {
104         Self {
105             verbose_bit_mask_threshold,
106         }
107     }
108 }
109
110 impl_lint_pass!(BitMask => [BAD_BIT_MASK, INEFFECTIVE_BIT_MASK, VERBOSE_BIT_MASK]);
111
112 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for BitMask {
113     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr) {
114         if let ExprKind::Binary(cmp, left, right) = &e.node {
115             if cmp.node.is_comparison() {
116                 if let Some(cmp_opt) = fetch_int_literal(cx, right) {
117                     check_compare(cx, left, cmp.node, cmp_opt, e.span)
118                 } else if let Some(cmp_val) = fetch_int_literal(cx, left) {
119                     check_compare(cx, right, invert_cmp(cmp.node), cmp_val, e.span)
120                 }
121             }
122         }
123         if_chain! {
124             if let ExprKind::Binary(op, left, right) = &e.node;
125             if BinOpKind::Eq == op.node;
126             if let ExprKind::Binary(op1, left1, right1) = &left.node;
127             if BinOpKind::BitAnd == op1.node;
128             if let ExprKind::Lit(lit) = &right1.node;
129             if let LitKind::Int(n, _) = lit.node;
130             if let ExprKind::Lit(lit1) = &right.node;
131             if let LitKind::Int(0, _) = lit1.node;
132             if n.leading_zeros() == n.count_zeros();
133             if n > u128::from(self.verbose_bit_mask_threshold);
134             then {
135                 span_lint_and_then(cx,
136                                    VERBOSE_BIT_MASK,
137                                    e.span,
138                                    "bit mask could be simplified with a call to `trailing_zeros`",
139                                    |db| {
140                     let sugg = Sugg::hir(cx, left1, "...").maybe_par();
141                     db.span_suggestion(
142                         e.span,
143                         "try",
144                         format!("{}.trailing_zeros() >= {}", sugg, n.count_ones()),
145                         Applicability::MaybeIncorrect,
146                     );
147                 });
148             }
149         }
150     }
151 }
152
153 fn invert_cmp(cmp: BinOpKind) -> BinOpKind {
154     match cmp {
155         BinOpKind::Eq => BinOpKind::Eq,
156         BinOpKind::Ne => BinOpKind::Ne,
157         BinOpKind::Lt => BinOpKind::Gt,
158         BinOpKind::Gt => BinOpKind::Lt,
159         BinOpKind::Le => BinOpKind::Ge,
160         BinOpKind::Ge => BinOpKind::Le,
161         _ => BinOpKind::Or, // Dummy
162     }
163 }
164
165 fn check_compare(cx: &LateContext<'_, '_>, bit_op: &Expr, cmp_op: BinOpKind, cmp_value: u128, span: Span) {
166     if let ExprKind::Binary(op, left, right) = &bit_op.node {
167         if op.node != BinOpKind::BitAnd && op.node != BinOpKind::BitOr {
168             return;
169         }
170         fetch_int_literal(cx, right)
171             .or_else(|| fetch_int_literal(cx, left))
172             .map_or((), |mask| check_bit_mask(cx, op.node, cmp_op, mask, cmp_value, span))
173     }
174 }
175
176 #[allow(clippy::too_many_lines)]
177 fn check_bit_mask(
178     cx: &LateContext<'_, '_>,
179     bit_op: BinOpKind,
180     cmp_op: BinOpKind,
181     mask_value: u128,
182     cmp_value: u128,
183     span: Span,
184 ) {
185     match cmp_op {
186         BinOpKind::Eq | BinOpKind::Ne => match bit_op {
187             BinOpKind::BitAnd => {
188                 if mask_value & cmp_value != cmp_value {
189                     if cmp_value != 0 {
190                         span_lint(
191                             cx,
192                             BAD_BIT_MASK,
193                             span,
194                             &format!(
195                                 "incompatible bit mask: `_ & {}` can never be equal to `{}`",
196                                 mask_value, cmp_value
197                             ),
198                         );
199                     }
200                 } else if mask_value == 0 {
201                     span_lint(cx, BAD_BIT_MASK, span, "&-masking with zero");
202                 }
203             },
204             BinOpKind::BitOr => {
205                 if mask_value | cmp_value != cmp_value {
206                     span_lint(
207                         cx,
208                         BAD_BIT_MASK,
209                         span,
210                         &format!(
211                             "incompatible bit mask: `_ | {}` can never be equal to `{}`",
212                             mask_value, cmp_value
213                         ),
214                     );
215                 }
216             },
217             _ => (),
218         },
219         BinOpKind::Lt | BinOpKind::Ge => match bit_op {
220             BinOpKind::BitAnd => {
221                 if mask_value < cmp_value {
222                     span_lint(
223                         cx,
224                         BAD_BIT_MASK,
225                         span,
226                         &format!(
227                             "incompatible bit mask: `_ & {}` will always be lower than `{}`",
228                             mask_value, cmp_value
229                         ),
230                     );
231                 } else if mask_value == 0 {
232                     span_lint(cx, BAD_BIT_MASK, span, "&-masking with zero");
233                 }
234             },
235             BinOpKind::BitOr => {
236                 if mask_value >= cmp_value {
237                     span_lint(
238                         cx,
239                         BAD_BIT_MASK,
240                         span,
241                         &format!(
242                             "incompatible bit mask: `_ | {}` will never be lower than `{}`",
243                             mask_value, cmp_value
244                         ),
245                     );
246                 } else {
247                     check_ineffective_lt(cx, span, mask_value, cmp_value, "|");
248                 }
249             },
250             BinOpKind::BitXor => check_ineffective_lt(cx, span, mask_value, cmp_value, "^"),
251             _ => (),
252         },
253         BinOpKind::Le | BinOpKind::Gt => match bit_op {
254             BinOpKind::BitAnd => {
255                 if mask_value <= cmp_value {
256                     span_lint(
257                         cx,
258                         BAD_BIT_MASK,
259                         span,
260                         &format!(
261                             "incompatible bit mask: `_ & {}` will never be higher than `{}`",
262                             mask_value, cmp_value
263                         ),
264                     );
265                 } else if mask_value == 0 {
266                     span_lint(cx, BAD_BIT_MASK, span, "&-masking with zero");
267                 }
268             },
269             BinOpKind::BitOr => {
270                 if mask_value > cmp_value {
271                     span_lint(
272                         cx,
273                         BAD_BIT_MASK,
274                         span,
275                         &format!(
276                             "incompatible bit mask: `_ | {}` will always be higher than `{}`",
277                             mask_value, cmp_value
278                         ),
279                     );
280                 } else {
281                     check_ineffective_gt(cx, span, mask_value, cmp_value, "|");
282                 }
283             },
284             BinOpKind::BitXor => check_ineffective_gt(cx, span, mask_value, cmp_value, "^"),
285             _ => (),
286         },
287         _ => (),
288     }
289 }
290
291 fn check_ineffective_lt(cx: &LateContext<'_, '_>, span: Span, m: u128, c: u128, op: &str) {
292     if c.is_power_of_two() && m < c {
293         span_lint(
294             cx,
295             INEFFECTIVE_BIT_MASK,
296             span,
297             &format!(
298                 "ineffective bit mask: `x {} {}` compared to `{}`, is the same as x compared directly",
299                 op, m, c
300             ),
301         );
302     }
303 }
304
305 fn check_ineffective_gt(cx: &LateContext<'_, '_>, span: Span, m: u128, c: u128, op: &str) {
306     if (c + 1).is_power_of_two() && m <= c {
307         span_lint(
308             cx,
309             INEFFECTIVE_BIT_MASK,
310             span,
311             &format!(
312                 "ineffective bit mask: `x {} {}` compared to `{}`, is the same as x compared directly",
313                 op, m, c
314             ),
315         );
316     }
317 }
318
319 fn fetch_int_literal(cx: &LateContext<'_, '_>, lit: &Expr) -> Option<u128> {
320     match constant(cx, cx.tables, lit)?.0 {
321         Constant::Int(n) => Some(n),
322         _ => None,
323     }
324 }