clippy_lints/src/functions.rs

   1 use crate::utils::{iter_input_pats, snippet, span_lint, type_is_unsafe_function};
   2 use matches::matches;
   3 use rustc::hir;
   4 use rustc::hir::def::Def;
   5 use rustc::hir::intravisit;
   6 use rustc::lint::{in_external_macro, LateContext, LateLintPass, LintArray, LintContext, LintPass};
   7 use rustc::ty;
   8 use rustc::{declare_tool_lint, lint_array};
   9 use rustc_data_structures::fx::FxHashSet;
  10 use rustc_target::spec::abi::Abi;
  11 use syntax::ast;
  12 use syntax::source_map::Span;
  13
  14 /// **What it does:** Checks for functions with too many parameters.
  15 ///
  16 /// **Why is this bad?** Functions with lots of parameters are considered bad
  17 /// style and reduce readability (“what does the 5th parameter mean?”). Consider
  18 /// grouping some parameters into a new type.
  19 ///
  20 /// **Known problems:** None.
  21 ///
  22 /// **Example:**
  23 /// ```rust
  24 /// fn foo(x: u32, y: u32, name: &str, c: Color, w: f32, h: f32, a: f32, b: f32) {
  25 ///     ..
  26 /// }
  27 /// ```
  28 declare_clippy_lint! {
  29     pub TOO_MANY_ARGUMENTS,
  30     complexity,
  31     "functions with too many arguments"
  32 }
  33
  34 /// **What it does:** Checks for functions with a large amount of lines.
  35 ///
  36 /// **Why is this bad?** Functions with a lot of lines are harder to understand
  37 /// due to having to look at a larger amount of code to understand what the
  38 /// function is doing. Consider splitting the body of the function into
  39 /// multiple functions.
  40 ///
  41 /// **Known problems:** None.
  42 ///
  43 /// **Example:**
  44 /// ``` rust
  45 /// fn im_too_long() {
  46 /// println!("");
  47 /// // ... 100 more LoC
  48 /// println!("");
  49 /// }
  50 /// ```
  51 declare_clippy_lint! {
  52     pub TOO_MANY_LINES,
  53     pedantic,
  54     "functions with too many lines"
  55 }
  56
  57 /// **What it does:** Checks for public functions that dereferences raw pointer
  58 /// arguments but are not marked unsafe.
  59 ///
  60 /// **Why is this bad?** The function should probably be marked `unsafe`, since
  61 /// for an arbitrary raw pointer, there is no way of telling for sure if it is
  62 /// valid.
  63 ///
  64 /// **Known problems:**
  65 ///
  66 /// * It does not check functions recursively so if the pointer is passed to a
  67 /// private non-`unsafe` function which does the dereferencing, the lint won't
  68 /// trigger.
  69 /// * It only checks for arguments whose type are raw pointers, not raw pointers
  70 /// got from an argument in some other way (`fn foo(bar: &[*const u8])` or
  71 /// `some_argument.get_raw_ptr()`).
  72 ///
  73 /// **Example:**
  74 /// ```rust
  75 /// pub fn foo(x: *const u8) {
  76 ///     println!("{}", unsafe { *x });
  77 /// }
  78 /// ```
  79 declare_clippy_lint! {
  80     pub NOT_UNSAFE_PTR_ARG_DEREF,
  81     correctness,
  82     "public functions dereferencing raw pointer arguments but not marked `unsafe`"
  83 }
  84
  85 #[derive(Copy, Clone)]
  86 pub struct Functions {
  87     threshold: u64,
  88     max_lines: u64,
  89 }
  90
  91 impl Functions {
  92     pub fn new(threshold: u64, max_lines: u64) -> Self {
  93         Self { threshold, max_lines }
  94     }
  95 }
  96
  97 impl LintPass for Functions {
  98     fn get_lints(&self) -> LintArray {
  99         lint_array!(TOO_MANY_ARGUMENTS, TOO_MANY_LINES, NOT_UNSAFE_PTR_ARG_DEREF)
 100     }
 101
 102     fn name(&self) -> &'static str {
 103         "Functions"
 104     }
 105 }
 106
 107 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Functions {
 108     fn check_fn(
 109         &mut self,
 110         cx: &LateContext<'a, 'tcx>,
 111         kind: intravisit::FnKind<'tcx>,
 112         decl: &'tcx hir::FnDecl,
 113         body: &'tcx hir::Body,
 114         span: Span,
 115         hir_id: hir::HirId,
 116     ) {
 117         let is_impl = if let Some(hir::Node::Item(item)) = cx
 118             .tcx
 119             .hir()
 120             .find_by_hir_id(cx.tcx.hir().get_parent_node_by_hir_id(hir_id))
 121         {
 122             matches!(item.node, hir::ItemKind::Impl(_, _, _, _, Some(_), _, _))
 123         } else {
 124             false
 125         };
 126
 127         let unsafety = match kind {
 128             hir::intravisit::FnKind::ItemFn(_, _, hir::FnHeader { unsafety, .. }, _, _) => unsafety,
 129             hir::intravisit::FnKind::Method(_, sig, _, _) => sig.header.unsafety,
 130             hir::intravisit::FnKind::Closure(_) => return,
 131         };
 132
 133         // don't warn for implementations, it's not their fault
 134         if !is_impl {
 135             // don't lint extern functions decls, it's not their fault either
 136             match kind {
 137                 hir::intravisit::FnKind::Method(
 138                     _,
 139                     &hir::MethodSig {
 140                         header: hir::FnHeader { abi: Abi::Rust, .. },
 141                         ..
 142                     },
 143                     _,
 144                     _,
 145                 )
 146                 | hir::intravisit::FnKind::ItemFn(_, _, hir::FnHeader { abi: Abi::Rust, .. }, _, _) => {
 147                     self.check_arg_number(cx, decl, span)
 148                 },
 149                 _ => {},
 150             }
 151         }
 152
 153         let nodeid = cx.tcx.hir().hir_to_node_id(hir_id);
 154         self.check_raw_ptr(cx, unsafety, decl, body, nodeid);
 155         self.check_line_number(cx, span);
 156     }
 157
 158     fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx hir::TraitItem) {
 159         if let hir::TraitItemKind::Method(ref sig, ref eid) = item.node {
 160             // don't lint extern functions decls, it's not their fault
 161             if sig.header.abi == Abi::Rust {
 162                 self.check_arg_number(cx, &sig.decl, item.span);
 163             }
 164
 165             if let hir::TraitMethod::Provided(eid) = *eid {
 166                 let body = cx.tcx.hir().body(eid);
 167                 self.check_raw_ptr(cx, sig.header.unsafety, &sig.decl, body, item.id);
 168             }
 169         }
 170     }
 171 }
 172
 173 impl<'a, 'tcx> Functions {
 174     fn check_arg_number(self, cx: &LateContext<'_, '_>, decl: &hir::FnDecl, span: Span) {
 175         let args = decl.inputs.len() as u64;
 176         if args > self.threshold {
 177             span_lint(
 178                 cx,
 179                 TOO_MANY_ARGUMENTS,
 180                 span,
 181                 &format!("this function has too many arguments ({}/{})", args, self.threshold),
 182             );
 183         }
 184     }
 185
 186     fn check_line_number(self, cx: &LateContext<'_, '_>, span: Span) {
 187         if in_external_macro(cx.sess(), span) {
 188             return;
 189         }
 190
 191         let code_snippet = snippet(cx, span, "..");
 192         let mut line_count: u64 = 0;
 193         let mut in_comment = false;
 194         let mut code_in_line;
 195
 196         // Skip the surrounding function decl.
 197         let start_brace_idx = match code_snippet.find('{') {
 198             Some(i) => i + 1,
 199             None => 0,
 200         };
 201         let end_brace_idx = match code_snippet.find('}') {
 202             Some(i) => i,
 203             None => code_snippet.len(),
 204         };
 205         let function_lines = code_snippet[start_brace_idx..end_brace_idx].lines();
 206
 207         for mut line in function_lines {
 208             code_in_line = false;
 209             loop {
 210                 line = line.trim_start();
 211                 if line.is_empty() {
 212                     break;
 213                 }
 214                 if in_comment {
 215                     match line.find("*/") {
 216                         Some(i) => {
 217                             line = &line[i + 2..];
 218                             in_comment = false;
 219                             continue;
 220                         },
 221                         None => break,
 222                     }
 223                 } else {
 224                     let multi_idx = match line.find("/*") {
 225                         Some(i) => i,
 226                         None => line.len(),
 227                     };
 228                     let single_idx = match line.find("//") {
 229                         Some(i) => i,
 230                         None => line.len(),
 231                     };
 232                     code_in_line |= multi_idx > 0 && single_idx > 0;
 233                     // Implies multi_idx is below line.len()
 234                     if multi_idx < single_idx {
 235                         line = &line[multi_idx + 2..];
 236                         in_comment = true;
 237                         continue;
 238                     }
 239                     break;
 240                 }
 241             }
 242             if code_in_line {
 243                 line_count += 1;
 244             }
 245         }
 246
 247         if line_count > self.max_lines {
 248             span_lint(cx, TOO_MANY_LINES, span, "This function has a large number of lines.")
 249         }
 250     }
 251
 252     fn check_raw_ptr(
 253         self,
 254         cx: &LateContext<'a, 'tcx>,
 255         unsafety: hir::Unsafety,
 256         decl: &'tcx hir::FnDecl,
 257         body: &'tcx hir::Body,
 258         nodeid: ast::NodeId,
 259     ) {
 260         let expr = &body.value;
 261         if unsafety == hir::Unsafety::Normal && cx.access_levels.is_exported(nodeid) {
 262             let raw_ptrs = iter_input_pats(decl, body)
 263                 .zip(decl.inputs.iter())
 264                 .filter_map(|(arg, ty)| raw_ptr_arg(arg, ty))
 265                 .collect::<FxHashSet<_>>();
 266
 267             if !raw_ptrs.is_empty() {
 268                 let tables = cx.tcx.body_tables(body.id());
 269                 let mut v = DerefVisitor {
 270                     cx,
 271                     ptrs: raw_ptrs,
 272                     tables,
 273                 };
 274
 275                 hir::intravisit::walk_expr(&mut v, expr);
 276             }
 277         }
 278     }
 279 }
 280
 281 fn raw_ptr_arg(arg: &hir::Arg, ty: &hir::Ty) -> Option<ast::NodeId> {
 282     if let (&hir::PatKind::Binding(_, id, _, _, _), &hir::TyKind::Ptr(_)) = (&arg.pat.node, &ty.node) {
 283         Some(id)
 284     } else {
 285         None
 286     }
 287 }
 288
 289 struct DerefVisitor<'a, 'tcx: 'a> {
 290     cx: &'a LateContext<'a, 'tcx>,
 291     ptrs: FxHashSet<ast::NodeId>,
 292     tables: &'a ty::TypeckTables<'tcx>,
 293 }
 294
 295 impl<'a, 'tcx> hir::intravisit::Visitor<'tcx> for DerefVisitor<'a, 'tcx> {
 296     fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
 297         match expr.node {
 298             hir::ExprKind::Call(ref f, ref args) => {
 299                 let ty = self.tables.expr_ty(f);
 300
 301                 if type_is_unsafe_function(self.cx, ty) {
 302                     for arg in args {
 303                         self.check_arg(arg);
 304                     }
 305                 }
 306             },
 307             hir::ExprKind::MethodCall(_, _, ref args) => {
 308                 let def_id = self.tables.type_dependent_defs()[expr.hir_id].def_id();
 309                 let base_type = self.cx.tcx.type_of(def_id);
 310
 311                 if type_is_unsafe_function(self.cx, base_type) {
 312                     for arg in args {
 313                         self.check_arg(arg);
 314                     }
 315                 }
 316             },
 317             hir::ExprKind::Unary(hir::UnDeref, ref ptr) => self.check_arg(ptr),
 318             _ => (),
 319         }
 320
 321         hir::intravisit::walk_expr(self, expr);
 322     }
 323     fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
 324         intravisit::NestedVisitorMap::None
 325     }
 326 }
 327
 328 impl<'a, 'tcx: 'a> DerefVisitor<'a, 'tcx> {
 329     fn check_arg(&self, ptr: &hir::Expr) {
 330         if let hir::ExprKind::Path(ref qpath) = ptr.node {
 331             if let Def::Local(id) = self.cx.tables.qpath_def(qpath, ptr.hir_id) {
 332                 if self.ptrs.contains(&id) {
 333                     span_lint(
 334                         self.cx,
 335                         NOT_UNSAFE_PTR_ARG_DEREF,
 336                         ptr.span,
 337                         "this public function dereferences a raw pointer but is not marked `unsafe`",
 338                     );
 339                 }
 340             }
 341         }
 342     }
 343 }