clippy_lints/src/functions.rs

   1 use matches::matches;
   2 use rustc::hir::intravisit;
   3 use rustc::hir;
   4 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   5 use rustc::{declare_tool_lint, lint_array};
   6 use rustc::ty;
   7 use rustc::hir::def::Def;
   8 use std::collections::HashSet;
   9 use syntax::ast;
  10 use rustc_target::spec::abi::Abi;
  11 use syntax::source_map::Span;
  12 use crate::utils::{iter_input_pats, span_lint, type_is_unsafe_function};
  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:
  25 /// f32) { .. }
  26 /// ```
  27 declare_clippy_lint! {
  28     pub TOO_MANY_ARGUMENTS,
  29     complexity,
  30     "functions with too many arguments"
  31 }
  32
  33 /// **What it does:** Checks for public functions that dereferences raw pointer
  34 /// arguments but are not marked unsafe.
  35 ///
  36 /// **Why is this bad?** The function should probably be marked `unsafe`, since
  37 /// for an arbitrary raw pointer, there is no way of telling for sure if it is
  38 /// valid.
  39 ///
  40 /// **Known problems:**
  41 ///
  42 /// * It does not check functions recursively so if the pointer is passed to a
  43 /// private non-`unsafe` function which does the dereferencing, the lint won't
  44 /// trigger.
  45 /// * It only checks for arguments whose type are raw pointers, not raw pointers
  46 /// got from an argument in some other way (`fn foo(bar: &[*const u8])` or
  47 /// `some_argument.get_raw_ptr()`).
  48 ///
  49 /// **Example:**
  50 /// ```rust
  51 /// pub fn foo(x: *const u8) { println!("{}", unsafe { *x }); }
  52 /// ```
  53 declare_clippy_lint! {
  54     pub NOT_UNSAFE_PTR_ARG_DEREF,
  55     correctness,
  56     "public functions dereferencing raw pointer arguments but not marked `unsafe`"
  57 }
  58
  59 #[derive(Copy, Clone)]
  60 pub struct Functions {
  61     threshold: u64,
  62 }
  63
  64 impl Functions {
  65     pub fn new(threshold: u64) -> Self {
  66         Self {
  67             threshold,
  68         }
  69     }
  70 }
  71
  72 impl LintPass for Functions {
  73     fn get_lints(&self) -> LintArray {
  74         lint_array!(TOO_MANY_ARGUMENTS, NOT_UNSAFE_PTR_ARG_DEREF)
  75     }
  76 }
  77
  78 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Functions {
  79     fn check_fn(
  80         &mut self,
  81         cx: &LateContext<'a, 'tcx>,
  82         kind: intravisit::FnKind<'tcx>,
  83         decl: &'tcx hir::FnDecl,
  84         body: &'tcx hir::Body,
  85         span: Span,
  86         nodeid: ast::NodeId,
  87     ) {
  88         let is_impl = if let Some(hir::Node::Item(item)) = cx.tcx.hir.find(cx.tcx.hir.get_parent_node(nodeid)) {
  89             matches!(item.node, hir::ItemKind::Impl(_, _, _, _, Some(_), _, _))
  90         } else {
  91             false
  92         };
  93
  94         let unsafety = match kind {
  95             hir::intravisit::FnKind::ItemFn(_, _, hir::FnHeader { unsafety, .. }, _, _) => unsafety,
  96             hir::intravisit::FnKind::Method(_, sig, _, _) => sig.header.unsafety,
  97             hir::intravisit::FnKind::Closure(_) => return,
  98         };
  99
 100         // don't warn for implementations, it's not their fault
 101         if !is_impl {
 102             // don't lint extern functions decls, it's not their fault either
 103             match kind {
 104                 hir::intravisit::FnKind::Method(_, &hir::MethodSig { header: hir::FnHeader { abi: Abi::Rust, .. }, .. }, _, _) |
 105                 hir::intravisit::FnKind::ItemFn(_, _, hir::FnHeader { abi: Abi::Rust, .. }, _, _) => self.check_arg_number(cx, decl, span),
 106                 _ => {},
 107             }
 108         }
 109
 110         self.check_raw_ptr(cx, unsafety, decl, body, nodeid);
 111     }
 112
 113     fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx hir::TraitItem) {
 114         if let hir::TraitItemKind::Method(ref sig, ref eid) = item.node {
 115             // don't lint extern functions decls, it's not their fault
 116             if sig.header.abi == Abi::Rust {
 117                 self.check_arg_number(cx, &sig.decl, item.span);
 118             }
 119
 120             if let hir::TraitMethod::Provided(eid) = *eid {
 121                 let body = cx.tcx.hir.body(eid);
 122                 self.check_raw_ptr(cx, sig.header.unsafety, &sig.decl, body, item.id);
 123             }
 124         }
 125     }
 126 }
 127
 128 impl<'a, 'tcx> Functions {
 129     fn check_arg_number(self, cx: &LateContext<'_, '_>, decl: &hir::FnDecl, span: Span) {
 130         let args = decl.inputs.len() as u64;
 131         if args > self.threshold {
 132             span_lint(
 133                 cx,
 134                 TOO_MANY_ARGUMENTS,
 135                 span,
 136                 &format!("this function has too many arguments ({}/{})", args, self.threshold),
 137             );
 138         }
 139     }
 140
 141     fn check_raw_ptr(
 142         self,
 143         cx: &LateContext<'a, 'tcx>,
 144         unsafety: hir::Unsafety,
 145         decl: &'tcx hir::FnDecl,
 146         body: &'tcx hir::Body,
 147         nodeid: ast::NodeId,
 148     ) {
 149         let expr = &body.value;
 150         if unsafety == hir::Unsafety::Normal && cx.access_levels.is_exported(nodeid) {
 151             let raw_ptrs = iter_input_pats(decl, body)
 152                 .zip(decl.inputs.iter())
 153                 .filter_map(|(arg, ty)| raw_ptr_arg(arg, ty))
 154                 .collect::<HashSet<_>>();
 155
 156             if !raw_ptrs.is_empty() {
 157                 let tables = cx.tcx.body_tables(body.id());
 158                 let mut v = DerefVisitor {
 159                     cx,
 160                     ptrs: raw_ptrs,
 161                     tables,
 162                 };
 163
 164                 hir::intravisit::walk_expr(&mut v, expr);
 165             }
 166         }
 167     }
 168 }
 169
 170 fn raw_ptr_arg(arg: &hir::Arg, ty: &hir::Ty) -> Option<ast::NodeId> {
 171     if let (&hir::PatKind::Binding(_, id, _, _), &hir::TyKind::Ptr(_)) = (&arg.pat.node, &ty.node) {
 172         Some(id)
 173     } else {
 174         None
 175     }
 176 }
 177
 178 struct DerefVisitor<'a, 'tcx: 'a> {
 179     cx: &'a LateContext<'a, 'tcx>,
 180     ptrs: HashSet<ast::NodeId>,
 181     tables: &'a ty::TypeckTables<'tcx>,
 182 }
 183
 184 impl<'a, 'tcx> hir::intravisit::Visitor<'tcx> for DerefVisitor<'a, 'tcx> {
 185     fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
 186         match expr.node {
 187             hir::ExprKind::Call(ref f, ref args) => {
 188                 let ty = self.tables.expr_ty(f);
 189
 190                 if type_is_unsafe_function(self.cx, ty) {
 191                     for arg in args {
 192                         self.check_arg(arg);
 193                     }
 194                 }
 195             },
 196             hir::ExprKind::MethodCall(_, _, ref args) => {
 197                 let def_id = self.tables.type_dependent_defs()[expr.hir_id].def_id();
 198                 let base_type = self.cx.tcx.type_of(def_id);
 199
 200                 if type_is_unsafe_function(self.cx, base_type) {
 201                     for arg in args {
 202                         self.check_arg(arg);
 203                     }
 204                 }
 205             },
 206             hir::ExprKind::Unary(hir::UnDeref, ref ptr) => self.check_arg(ptr),
 207             _ => (),
 208         }
 209
 210         hir::intravisit::walk_expr(self, expr);
 211     }
 212     fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
 213         intravisit::NestedVisitorMap::None
 214     }
 215 }
 216
 217 impl<'a, 'tcx: 'a> DerefVisitor<'a, 'tcx> {
 218     fn check_arg(&self, ptr: &hir::Expr) {
 219         if let hir::ExprKind::Path(ref qpath) = ptr.node {
 220             if let Def::Local(id) = self.cx.tables.qpath_def(qpath, ptr.hir_id) {
 221                 if self.ptrs.contains(&id) {
 222                     span_lint(
 223                         self.cx,
 224                         NOT_UNSAFE_PTR_ARG_DEREF,
 225                         ptr.span,
 226                         "this public function dereferences a raw pointer but is not marked `unsafe`",
 227                     );
 228                 }
 229             }
 230         }
 231     }
 232 }