2 use rustc::hir::def::Def;
4 use rustc_const_eval::lookup_const_by_id;
5 use syntax::ast::LitKind;
6 use syntax::codemap::Span;
7 use utils::{span_lint, span_lint_and_then};
10 /// **What it does:** Checks for incompatible bit masks in comparisons.
12 /// The formula for detecting if an expression of the type `_ <bit_op> m
13 /// <cmp_op> c` (where `<bit_op>` is one of {`&`, `|`} and `<cmp_op>` is one of
14 /// {`!=`, `>=`, `>`, `!=`, `>=`, `>`}) can be determined from the following
17 /// |Comparison |Bit Op|Example |is always|Formula |
18 /// |------------|------|------------|---------|----------------------|
19 /// |`==` or `!=`| `&` |`x & 2 == 3`|`false` |`c & m != c` |
20 /// |`<` or `>=`| `&` |`x & 2 < 3` |`true` |`m < c` |
21 /// |`>` or `<=`| `&` |`x & 1 > 1` |`false` |`m <= c` |
22 /// |`==` or `!=`| `|` |`x | 1 == 0`|`false` |`c | m != c` |
23 /// |`<` or `>=`| `|` |`x | 1 < 1` |`false` |`m >= c` |
24 /// |`<=` or `>` | `|` |`x | 1 > 0` |`true` |`m > c` |
26 /// **Why is this bad?** If the bits that the comparison cares about are always
27 /// set to zero or one by the bit mask, the comparison is constant `true` or
28 /// `false` (depending on mask, compared value, and operators).
30 /// So the code is actively misleading, and the only reason someone would write
31 /// this intentionally is to win an underhanded Rust contest or create a
32 /// test-case for this lint.
34 /// **Known problems:** None.
38 /// if (x & 1 == 2) { … }
43 "expressions of the form `_ & mask == select` that will only ever return `true` or `false`"
46 /// **What it does:** Checks for bit masks in comparisons which can be removed
47 /// without changing the outcome. The basic structure can be seen in the
50 /// |Comparison| Bit Op |Example |equals |
51 /// |----------|---------|-----------|-------|
52 /// |`>` / `<=`|`|` / `^`|`x | 2 > 3`|`x > 3`|
53 /// |`<` / `>=`|`|` / `^`|`x ^ 1 < 4`|`x < 4`|
55 /// **Why is this bad?** Not equally evil as [`bad_bit_mask`](#bad_bit_mask),
56 /// but still a bit misleading, because the bit mask is ineffective.
58 /// **Known problems:** False negatives: This lint will only match instances
59 /// where we have figured out the math (which is for a power-of-two compared
60 /// value). This means things like `x | 1 >= 7` (which would be better written
61 /// as `x >= 6`) will not be reported (but bit masks like this are fairly
66 /// if (x | 1 > 3) { … }
69 pub INEFFECTIVE_BIT_MASK,
71 "expressions where a bit mask will be rendered useless by a comparison, e.g. `(x | 1) > 2`"
74 /// **What it does:** Checks for bit masks that can be replaced by a call
75 /// to `trailing_zeros`
77 /// **Why is this bad?** `x.trailing_zeros() > 4` is much clearer than `x & 15 == 0`
79 /// **Known problems:** None
88 "expressions where a bit mask is less readable than the corresponding method call"
94 impl LintPass for BitMask {
95 fn get_lints(&self) -> LintArray {
96 lint_array!(BAD_BIT_MASK, INEFFECTIVE_BIT_MASK, VERBOSE_BIT_MASK)
100 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for BitMask {
101 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr) {
102 if let ExprBinary(ref cmp, ref left, ref right) = e.node {
103 if cmp.node.is_comparison() {
104 if let Some(cmp_opt) = fetch_int_literal(cx, right) {
105 check_compare(cx, left, cmp.node, cmp_opt, &e.span)
106 } else if let Some(cmp_val) = fetch_int_literal(cx, left) {
107 check_compare(cx, right, invert_cmp(cmp.node), cmp_val, &e.span)
112 let Expr_::ExprBinary(ref op, ref left, ref right) = e.node,
113 BinOp_::BiEq == op.node,
114 let Expr_::ExprBinary(ref op1, ref left1, ref right1) = left.node,
115 BinOp_::BiBitAnd == op1.node,
116 let Expr_::ExprLit(ref lit) = right1.node,
117 let LitKind::Int(n, _) = lit.node,
118 let Expr_::ExprLit(ref lit1) = right.node,
119 let LitKind::Int(0, _) = lit1.node,
120 n.leading_zeros() == n.count_zeros(),
122 span_lint_and_then(cx,
125 "bit mask could be simplified with a call to `trailing_zeros`",
127 let sugg = Sugg::hir(cx, left1, "...").maybe_par();
128 db.span_suggestion(e.span, "try", format!("{}.trailing_zeros() > {}", sugg, n.count_ones()));
134 fn invert_cmp(cmp: BinOp_) -> BinOp_ {
147 fn check_compare(cx: &LateContext, bit_op: &Expr, cmp_op: BinOp_, cmp_value: u128, span: &Span) {
148 if let ExprBinary(ref op, ref left, ref right) = bit_op.node {
149 if op.node != BiBitAnd && op.node != BiBitOr {
152 fetch_int_literal(cx, right)
153 .or_else(|| fetch_int_literal(cx, left))
154 .map_or((), |mask| check_bit_mask(cx, op.node, cmp_op, mask, cmp_value, span))
158 fn check_bit_mask(cx: &LateContext, bit_op: BinOp_, cmp_op: BinOp_, mask_value: u128, cmp_value: u128, span: &Span) {
163 if mask_value & cmp_value != cmp_value {
168 &format!("incompatible bit mask: `_ & {}` can never be equal to `{}`",
172 } else if mask_value == 0 {
173 span_lint(cx, BAD_BIT_MASK, *span, "&-masking with zero");
177 if mask_value | cmp_value != cmp_value {
181 &format!("incompatible bit mask: `_ | {}` can never be equal to `{}`",
192 if mask_value < cmp_value {
196 &format!("incompatible bit mask: `_ & {}` will always be lower than `{}`",
199 } else if mask_value == 0 {
200 span_lint(cx, BAD_BIT_MASK, *span, "&-masking with zero");
204 if mask_value >= cmp_value {
208 &format!("incompatible bit mask: `_ | {}` will never be lower than `{}`",
212 check_ineffective_lt(cx, *span, mask_value, cmp_value, "|");
215 BiBitXor => check_ineffective_lt(cx, *span, mask_value, cmp_value, "^"),
222 if mask_value <= cmp_value {
226 &format!("incompatible bit mask: `_ & {}` will never be higher than `{}`",
229 } else if mask_value == 0 {
230 span_lint(cx, BAD_BIT_MASK, *span, "&-masking with zero");
234 if mask_value > cmp_value {
238 &format!("incompatible bit mask: `_ | {}` will always be higher than `{}`",
242 check_ineffective_gt(cx, *span, mask_value, cmp_value, "|");
245 BiBitXor => check_ineffective_gt(cx, *span, mask_value, cmp_value, "^"),
253 fn check_ineffective_lt(cx: &LateContext, span: Span, m: u128, c: u128, op: &str) {
254 if c.is_power_of_two() && m < c {
256 INEFFECTIVE_BIT_MASK,
258 &format!("ineffective bit mask: `x {} {}` compared to `{}`, is the same as x compared directly",
265 fn check_ineffective_gt(cx: &LateContext, span: Span, m: u128, c: u128, op: &str) {
266 if (c + 1).is_power_of_two() && m <= c {
268 INEFFECTIVE_BIT_MASK,
270 &format!("ineffective bit mask: `x {} {}` compared to `{}`, is the same as x compared directly",
277 fn fetch_int_literal(cx: &LateContext, lit: &Expr) -> Option<u128> {
278 use rustc::ty::subst::Substs;
280 ExprLit(ref lit_ptr) => {
281 if let LitKind::Int(value, _) = lit_ptr.node {
282 Some(value) // TODO: Handle sign
287 ExprPath(ref qpath) => {
288 let def = cx.tables.qpath_def(qpath, lit.id);
289 if let Def::Const(def_id) = def {
290 lookup_const_by_id(cx.tcx, cx.param_env.and((def_id, Substs::empty()))).and_then(|(l, _ty)| {
291 let body = if let Some(id) = cx.tcx.hir.as_local_node_id(l) {
292 cx.tcx.mir_const_qualif(def_id);
293 cx.tcx.hir.body(cx.tcx.hir.body_owned_by(id))
295 cx.tcx.sess.cstore.item_body(cx.tcx, def_id)
297 fetch_int_literal(cx, &body.value)