new_lint non_reentrant_functions

Signed-off-by: mojave2 <[email protected]>

Author: kiscad

CHANGELOG.md

@@ -4782,6 +4782,7 @@ Released 2018-09-13
 [`no_mangle_with_rust_abi`]: https://rust-lang.github.io/rust-clippy/master/index.html#no_mangle_with_rust_abi
 [`non_ascii_literal`]: https://rust-lang.github.io/rust-clippy/master/index.html#non_ascii_literal
 [`non_octal_unix_permissions`]: https://rust-lang.github.io/rust-clippy/master/index.html#non_octal_unix_permissions
+[`non_reentrant_functions`]: https://rust-lang.github.io/rust-clippy/master/index.html#non_reentrant_functions
 [`non_send_fields_in_send_ty`]: https://rust-lang.github.io/rust-clippy/master/index.html#non_send_fields_in_send_ty
 [`nonminimal_bool`]: https://rust-lang.github.io/rust-clippy/master/index.html#nonminimal_bool
 [`nonsensical_open_options`]: https://rust-lang.github.io/rust-clippy/master/index.html#nonsensical_open_options

clippy_lints/src/declared_lints.rs

@@ -471,6 +471,7 @@ pub(crate) static LINTS: &[&crate::LintInfo] = &[
     crate::non_expressive_names::MANY_SINGLE_CHAR_NAMES_INFO,
     crate::non_expressive_names::SIMILAR_NAMES_INFO,
     crate::non_octal_unix_permissions::NON_OCTAL_UNIX_PERMISSIONS_INFO,
+    crate::non_reentrant_functions::NON_REENTRANT_FUNCTIONS_INFO,
     crate::non_send_fields_in_send_ty::NON_SEND_FIELDS_IN_SEND_TY_INFO,
     crate::nonstandard_macro_braces::NONSTANDARD_MACRO_BRACES_INFO,
     crate::octal_escapes::OCTAL_ESCAPES_INFO,

clippy_lints/src/lib.rs

@@ -232,6 +232,7 @@ mod no_mangle_with_rust_abi;
 mod non_copy_const;
 mod non_expressive_names;
 mod non_octal_unix_permissions;
+mod non_reentrant_functions;
 mod non_send_fields_in_send_ty;
 mod nonstandard_macro_braces;
 mod octal_escapes;
@@ -966,6 +967,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
     store.register_late_pass(move |_| Box::new(guidelines::GuidelineLints::new(mem_unsafe_functions.clone())));
     store.register_late_pass(|_| Box::new(unsafe_block_in_proc_macro::UnsafeBlockInProcMacro::new()));
     store.register_early_pass(|| Box::new(implicit_abi::ImplicitAbi));
+    store.register_early_pass(|| Box::new(non_reentrant_functions::NonReentrantFunctions));
     // add lints here, do not remove this comment, it's used in `new_lint`
 }
 

clippy_lints/src/non_reentrant_functions.rs

@@ -0,0 +1,59 @@
+use clippy_utils::diagnostics::span_lint;
+use rustc_ast::ast::{Expr, ExprKind, Path};
+use rustc_lint::{EarlyContext, EarlyLintPass};
+use rustc_session::{declare_lint_pass, declare_tool_lint};
+
+declare_clippy_lint! {
+    /// ### What it does
+    ///
+    /// ### Why is this bad?
+    ///
+    /// ### Example
+    /// ```rust
+    /// // example code where clippy issues a warning
+    /// ```
+    /// Use instead:
+    /// ```rust
+    /// // example code which does not raise clippy warning
+    /// ```
+    #[clippy::version = "1.70.0"]
+    pub NON_REENTRANT_FUNCTIONS,
+    nursery,
+    "this function is a non-reentrant-function"
+}
+declare_lint_pass!(NonReentrantFunctions => [NON_REENTRANT_FUNCTIONS]);
+
+impl EarlyLintPass for NonReentrantFunctions {
+    fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &Expr) {
+        if expr.span.from_expansion() {
+            return;
+        }
+
+        let msg: &str = "consider using the reentrant version of the function";
+
+        match expr.kind {
+            ExprKind::Call(ref func, _) => {
+                if is_reentrant_fn(func) {
+                    span_lint(cx, NON_REENTRANT_FUNCTIONS, expr.span, msg);
+                }
+            },
+            _ => {},
+        }
+    }
+}
+
+fn is_reentrant_fn(func: &Expr) -> bool {
+    match &func.kind {
+        ExprKind::Path(_, Path { segments, .. }) => {
+            let seg = segments.iter().last().unwrap();
+            let ident = format!("{:?}", seg.ident);
+            check_reentrant_by_fn_name(&ident)
+        },
+        _ => false,
+    }
+}
+
+fn check_reentrant_by_fn_name(func: &str) -> bool {
+    let name = func.split("#").next().unwrap();
+    name == "strtok" || name == "localtime"
+}

tests/ui/non_reentrant_functions.rs

@@ -0,0 +1,25 @@
+#![warn(clippy::non_reentrant_functions)]
+#![feature(rustc_private)]
+extern crate libc;
+
+#[allow(unused)]
+use libc::{c_char, localtime, strtok, time_t};
+use std::ffi::{CStr, CString};
+
+fn main() {
+    // test code goes here
+    unsafe {
+        let _tm = localtime(&0i64 as *const time_t);
+    }
+
+    let string = CString::new("welcome-to-rust").unwrap();
+    let string = string.as_ptr() as *mut c_char;
+    let delim = CString::new(" - ").unwrap();
+    let delim = delim.as_ptr();
+
+    let mut token = unsafe { strtok(string, delim) };
+    while !token.is_null() {
+        println!("{:?}", unsafe { CStr::from_ptr(token) });
+        token = unsafe { strtok(std::ptr::null_mut(), delim) };
+    }
+}

tests/ui/non_reentrant_functions.stderr

@@ -0,0 +1,22 @@
+error: consider using the reentrant version of the function
+  --> $DIR/non_reentrant_functions.rs:12:19
+   |
+LL |         let _tm = localtime(&0i64 as *const time_t);
+   |                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+   |
+   = note: `-D clippy::non-reentrant-functions` implied by `-D warnings`
+
+error: consider using the reentrant version of the function
+  --> $DIR/non_reentrant_functions.rs:20:30
+   |
+LL |     let mut token = unsafe { strtok(string, delim) };
+   |                              ^^^^^^^^^^^^^^^^^^^^^
+
+error: consider using the reentrant version of the function
+  --> $DIR/non_reentrant_functions.rs:23:26
+   |
+LL |         token = unsafe { strtok(std::ptr::null_mut(), delim) };
+   |                          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+error: aborting due to 3 previous errors
+