]> git.lizzy.rs Git - rust.git/commitdiff
Linting classical overflow checks.
authorKALPESH KRISHNA <kalpeshk2011@gmail.com>
Sun, 6 Mar 2016 15:01:17 +0000 (20:31 +0530)
committerKALPESH KRISHNA <kalpeshk2011@gmail.com>
Mon, 7 Mar 2016 21:18:42 +0000 (02:48 +0530)
README.md
src/lib.rs
src/overflow_check_conditional.rs [new file with mode: 0644]
tests/compile-fail/overflow_check_conditional.rs [new file with mode: 0644]

index ff875085da21a5161090fe9106f96d35f6cf83c1..77518df6b3990652d91ade3ec6ffe03f69cad2cc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ A collection of lints to catch common mistakes and improve your Rust code.
 [Jump to usage instructions](#usage)
 
 ##Lints
-There are 130 lints included in this crate:
+There are 131 lints included in this crate:
 
 name                                                                                                                 | default | meaning
 ---------------------------------------------------------------------------------------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -92,6 +92,7 @@ name
 [option_unwrap_used](https://github.com/Manishearth/rust-clippy/wiki#option_unwrap_used)                             | allow   | using `Option.unwrap()`, which should at least get a better message using `expect()`
 [or_fun_call](https://github.com/Manishearth/rust-clippy/wiki#or_fun_call)                                           | warn    | using any `*or` method when the `*or_else` would do
 [out_of_bounds_indexing](https://github.com/Manishearth/rust-clippy/wiki#out_of_bounds_indexing)                     | deny    | out of bound constant indexing
+[overflow_check_conditional](https://github.com/Manishearth/rust-clippy/wiki#overflow_check_conditional)             | warn    | Using overflow checks which are likely to panic
 [panic_params](https://github.com/Manishearth/rust-clippy/wiki#panic_params)                                         | warn    | missing parameters in `panic!`
 [precedence](https://github.com/Manishearth/rust-clippy/wiki#precedence)                                             | warn    | catches operations where precedence may be unclear. See the wiki for a list of cases caught
 [print_stdout](https://github.com/Manishearth/rust-clippy/wiki#print_stdout)                                         | allow   | printing on stdout
index 803a4c2345c36e94d3e98957463dd82ba692af4a..51292bea8b2f6d61059dec812fe0f99f10cbd01b 100644 (file)
@@ -79,6 +79,7 @@ fn main() {
 pub mod needless_update;
 pub mod no_effect;
 pub mod open_options;
+pub mod overflow_check_conditional;
 pub mod panic;
 pub mod precedence;
 pub mod print;
@@ -173,6 +174,7 @@ pub fn plugin_registrar(reg: &mut Registry) {
     reg.register_early_lint_pass(box formatting::Formatting);
     reg.register_late_lint_pass(box swap::Swap);
     reg.register_early_lint_pass(box if_not_else::IfNotElse);
+    reg.register_late_lint_pass(box overflow_check_conditional::OverflowCheckConditional);
 
     reg.register_lint_group("clippy_pedantic", vec![
         enum_glob_use::ENUM_GLOB_USE,
@@ -283,6 +285,7 @@ pub fn plugin_registrar(reg: &mut Registry) {
         needless_update::NEEDLESS_UPDATE,
         no_effect::NO_EFFECT,
         open_options::NONSENSICAL_OPEN_OPTIONS,
+        overflow_check_conditional::OVERFLOW_CHECK_CONDITIONAL,
         panic::PANIC_PARAMS,
         precedence::PRECEDENCE,
         ptr_arg::PTR_ARG,
diff --git a/src/overflow_check_conditional.rs b/src/overflow_check_conditional.rs
new file mode 100644 (file)
index 0000000..7f4f4b3
--- /dev/null
@@ -0,0 +1,41 @@
+use rustc::lint::*;
+use rustc_front::hir::*;
+use utils::{span_lint};
+
+/// **What it does:** This lint finds classic overflow checks.
+///
+/// **Why is this bad?** Most classic C overflow checks will fail in Rust. Users can use functions like `overflowing_*` and `wrapping_*` instead.
+///
+/// **Known problems:** None.
+///
+/// **Example:** `a + b < a`
+declare_lint!(pub OVERFLOW_CHECK_CONDITIONAL, Warn,
+              "Using overflow checks which are likely to panic");
+
+#[derive(Copy, Clone)]
+pub struct OverflowCheckConditional;
+
+impl LintPass for OverflowCheckConditional {
+    fn get_lints(&self) -> LintArray {
+        lint_array!(OVERFLOW_CHECK_CONDITIONAL)
+    }
+}
+
+impl LateLintPass for OverflowCheckConditional {
+    fn check_expr(&mut self, cx: &LateContext, expr: &Expr) {
+        if_let_chain! {[
+        let Expr_::ExprBinary(ref op, ref first, ref second) = expr.node,
+        let BinOp_::BiLt = op.node,
+        let Expr_::ExprBinary(ref op2, ref add1, ref add2) = first.node,
+        let BinOp_::BiAdd = op2.node,
+        let Expr_::ExprPath(_,ref path1) = add1.node,
+        let Expr_::ExprPath(_, ref path2) = add2.node,
+        let Expr_::ExprPath(_, ref path3) = second.node,
+        (&path1.segments[0]).identifier == (&path3.segments[0]).identifier || (&path2.segments[0]).identifier == (&path3.segments[0]).identifier,
+        cx.tcx.expr_ty(add1).is_integral(),
+        cx.tcx.expr_ty(add2).is_integral()
+        ], {
+            span_lint(cx, OVERFLOW_CHECK_CONDITIONAL, expr.span, "You are trying to use classic C overflow conditons that will fail in Rust.");
+        }}
+    }
+}
diff --git a/tests/compile-fail/overflow_check_conditional.rs b/tests/compile-fail/overflow_check_conditional.rs
new file mode 100644 (file)
index 0000000..0b5e486
--- /dev/null
@@ -0,0 +1,25 @@
+#![feature(plugin)]
+#![plugin(clippy)]
+
+#![deny(overflow_check_conditional)]
+
+fn main() {
+       let a: u32 = 1;
+       let b: u32 = 2;
+       let c: u32 = 3;
+       if a + b < a { //~ERROR You are trying to use classic C overflow conditons that will fail in Rust.
+
+       }
+       if a + b < b { //~ERROR You are trying to use classic C overflow conditons that will fail in Rust.
+
+       }
+       if a + b < c {
+
+       }
+       let i = 1.1;
+       let j = 2.2;
+       if i + j < i {
+
+       }
+}
+