rust-clippy/src/bit_mask.rs

189 lines
6 KiB
Rust
Raw Normal View History

use rustc::plugin::Registry;
use rustc::lint::*;
use rustc::middle::const_eval::lookup_const_by_id;
use rustc::middle::def::*;
use syntax::ast::*;
use syntax::ast_util::{is_comparison_binop, binop_to_string};
use syntax::ptr::P;
use syntax::codemap::Span;
2015-07-26 14:53:11 +00:00
use utils::span_lint;
declare_lint! {
pub BAD_BIT_MASK,
Deny,
"Deny the use of incompatible bit masks in comparisons, e.g. \
'(a & 1) == 2'"
}
2015-05-15 12:09:29 +00:00
declare_lint! {
pub INEFFECTIVE_BIT_MASK,
Warn,
"Warn on the use of an ineffective bit mask in comparisons, e.g. \
'(a & 1) > 2'"
2015-05-15 12:09:29 +00:00
}
/// Checks for incompatible bit masks in comparisons, e.g. `x & 1 == 2`.
/// This cannot work because the bit that makes up the value two was
/// zeroed out by the bit-and with 1. So the formula for detecting if an
/// expression of the type `_ <bit_op> m <cmp_op> c` (where `<bit_op>`
/// is one of {`&`, '|'} and `<cmp_op>` is one of {`!=`, `>=`, `>` ,
/// `!=`, `>=`, `>`}) can be determined from the following table:
///
/// |Comparison |Bit-Op|Example |is always|Formula |
/// |------------|------|------------|---------|----------------------|
/// |`==` or `!=`| `&` |`x & 2 == 3`|`false` |`c & m != c` |
/// |`<` or `>=`| `&` |`x & 2 < 3` |`true` |`m < c` |
/// |`>` or `<=`| `&` |`x & 1 > 1` |`false` |`m <= c` |
/// |`==` or `!=`| `|` |`x | 1 == 0`|`false` |`c | m != c` |
2015-05-23 10:32:29 +00:00
/// |`<` or `>=`| `|` |`x | 1 < 1` |`false` |`m >= c` |
/// |`<=` or `>` | `|` |`x | 1 > 0` |`true` |`m > c` |
///
/// This lint is **deny** by default
///
/// There is also a lint that warns on ineffective masks that is *warn*
/// by default
#[derive(Copy,Clone)]
pub struct BitMask;
impl LintPass for BitMask {
fn get_lints(&self) -> LintArray {
2015-05-15 12:09:29 +00:00
lint_array!(BAD_BIT_MASK, INEFFECTIVE_BIT_MASK)
}
fn check_expr(&mut self, cx: &Context, e: &Expr) {
if let ExprBinary(ref cmp, ref left, ref right) = e.node {
if is_comparison_binop(cmp.node) {
fetch_int_literal(cx, right).map_or_else(||
fetch_int_literal(cx, left).map_or((), |cmp_val|
check_compare(cx, right, invert_cmp(cmp.node),
cmp_val, &e.span)),
|cmp_opt| check_compare(cx, left, cmp.node, cmp_opt,
&e.span))
}
}
}
}
fn invert_cmp(cmp : BinOp_) -> BinOp_ {
match cmp {
BiEq => BiEq,
BiNe => BiNe,
BiLt => BiGt,
BiGt => BiLt,
BiLe => BiGe,
BiGe => BiLe,
_ => BiOr // Dummy
}
}
fn check_compare(cx: &Context, bit_op: &Expr, cmp_op: BinOp_, cmp_value: u64, span: &Span) {
match &bit_op.node {
&ExprParen(ref subexp) => check_compare(cx, subexp, cmp_op, cmp_value, span),
&ExprBinary(ref op, ref left, ref right) => {
if op.node != BiBitAnd && op.node != BiBitOr { return; }
fetch_int_literal(cx, right).or_else(|| fetch_int_literal(
cx, left)).map_or((), |mask| check_bit_mask(cx, op.node,
cmp_op, mask, cmp_value, span))
},
_ => ()
}
}
2015-06-06 00:27:48 +00:00
fn check_bit_mask(cx: &Context, bit_op: BinOp_, cmp_op: BinOp_,
mask_value: u64, cmp_value: u64, span: &Span) {
match cmp_op {
BiEq | BiNe => match bit_op {
BiBitAnd => if mask_value & cmp_value != mask_value {
2015-06-06 00:27:48 +00:00
if cmp_value != 0 {
2015-07-26 14:53:11 +00:00
span_lint(cx, BAD_BIT_MASK, *span, &format!(
2015-06-06 00:27:48 +00:00
"incompatible bit mask: _ & {} can never be equal to {}",
mask_value, cmp_value));
}
} else {
if mask_value == 0 {
2015-07-26 14:53:11 +00:00
span_lint(cx, BAD_BIT_MASK, *span,
2015-06-06 00:27:48 +00:00
&format!("&-masking with zero"));
}
},
BiBitOr => if mask_value | cmp_value != cmp_value {
2015-07-26 14:53:11 +00:00
span_lint(cx, BAD_BIT_MASK, *span, &format!(
2015-06-06 00:27:48 +00:00
"incompatible bit mask: _ | {} can never be equal to {}",
mask_value, cmp_value));
},
_ => ()
},
BiLt | BiGe => match bit_op {
BiBitAnd => if mask_value < cmp_value {
2015-07-26 14:53:11 +00:00
span_lint(cx, BAD_BIT_MASK, *span, &format!(
2015-05-15 12:09:29 +00:00
"incompatible bit mask: _ & {} will always be lower than {}",
mask_value, cmp_value));
} else {
if mask_value == 0 {
2015-07-26 14:53:11 +00:00
span_lint(cx, BAD_BIT_MASK, *span,
2015-06-06 00:27:48 +00:00
&format!("&-masking with zero"));
}
},
BiBitOr => if mask_value >= cmp_value {
2015-07-26 14:53:11 +00:00
span_lint(cx, BAD_BIT_MASK, *span, &format!(
2015-05-15 12:09:29 +00:00
"incompatible bit mask: _ | {} will never be lower than {}",
mask_value, cmp_value));
} else {
if mask_value < cmp_value {
2015-07-26 14:53:11 +00:00
span_lint(cx, INEFFECTIVE_BIT_MASK, *span, &format!(
2015-05-15 12:09:29 +00:00
"ineffective bit mask: x | {} compared to {} is the same as x compared directly",
mask_value, cmp_value));
}
},
_ => ()
},
BiLe | BiGt => match bit_op {
BiBitAnd => if mask_value <= cmp_value {
2015-07-26 14:53:11 +00:00
span_lint(cx, BAD_BIT_MASK, *span, &format!(
2015-05-15 12:09:29 +00:00
"incompatible bit mask: _ & {} will never be higher than {}",
mask_value, cmp_value));
} else {
if mask_value == 0 {
2015-07-26 14:53:11 +00:00
span_lint(cx, BAD_BIT_MASK, *span,
2015-06-06 00:27:48 +00:00
&format!("&-masking with zero"));
}
},
BiBitOr => if mask_value > cmp_value {
2015-07-26 14:53:11 +00:00
span_lint(cx, BAD_BIT_MASK, *span, &format!(
2015-05-15 12:09:29 +00:00
"incompatible bit mask: _ | {} will always be higher than {}",
mask_value, cmp_value));
} else {
if mask_value < cmp_value {
2015-07-26 14:53:11 +00:00
span_lint(cx, INEFFECTIVE_BIT_MASK, *span, &format!(
2015-05-15 12:09:29 +00:00
"ineffective bit mask: x | {} compared to {} is the same as x compared directly",
mask_value, cmp_value));
}
},
_ => ()
},
_ => ()
}
}
fn fetch_int_literal(cx: &Context, lit : &Expr) -> Option<u64> {
match &lit.node {
&ExprLit(ref lit_ptr) => {
if let &LitInt(value, _) = &lit_ptr.node {
Option::Some(value) //TODO: Handle sign
} else { Option::None }
},
&ExprPath(_, _) => {
2015-05-07 04:41:54 +00:00
// Important to let the borrow expire before the const lookup to avoid double
// borrowing.
let def_map = cx.tcx.def_map.borrow();
match def_map.get(&lit.id) {
Some(&PathResolution { base_def: DefConst(def_id), ..}) => Some(def_id),
_ => None
}
}
.and_then(|def_id| lookup_const_by_id(cx.tcx, def_id, Option::None))
.and_then(|l| fetch_int_literal(cx, l)),
_ => Option::None
}
}