rust/clippy_lints/src/functions.rs

233 lines
7.3 KiB
Rust
Raw Normal View History

use rustc::hir::intravisit;
use rustc::hir;
use rustc::lint::*;
2017-08-21 05:57:33 -05:00
use rustc::ty;
2017-09-12 07:26:40 -05:00
use rustc::hir::def::Def;
use std::collections::HashSet;
2016-03-08 17:48:10 -06:00
use syntax::ast;
2018-04-27 07:00:43 -05:00
use rustc_target::spec::abi::Abi;
2016-03-08 17:48:10 -06:00
use syntax::codemap::Span;
2017-09-05 04:33:04 -05:00
use utils::{iter_input_pats, span_lint, type_is_unsafe_function};
2016-03-08 17:48:10 -06:00
/// **What it does:** Checks for functions with too many parameters.
2016-03-08 17:48:10 -06:00
///
/// **Why is this bad?** Functions with lots of parameters are considered bad
/// style and reduce readability (“what does the 5th parameter mean?”). Consider
/// grouping some parameters into a new type.
2016-03-08 17:48:10 -06:00
///
/// **Known problems:** None.
///
/// **Example:**
/// ```rust
2017-08-09 02:30:56 -05:00
/// fn foo(x: u32, y: u32, name: &str, c: Color, w: f32, h: f32, a: f32, b:
/// f32) { .. }
2016-03-08 17:48:10 -06:00
/// ```
2018-03-28 08:24:26 -05:00
declare_clippy_lint! {
2016-03-08 17:48:10 -06:00
pub TOO_MANY_ARGUMENTS,
2018-03-29 06:41:53 -05:00
complexity,
2016-03-08 17:48:10 -06:00
"functions with too many arguments"
}
/// **What it does:** Checks for public functions that dereferences raw pointer
/// arguments but are not marked unsafe.
///
/// **Why is this bad?** The function should probably be marked `unsafe`, since
/// for an arbitrary raw pointer, there is no way of telling for sure if it is
/// valid.
///
/// **Known problems:**
///
/// * It does not check functions recursively so if the pointer is passed to a
2017-08-09 02:30:56 -05:00
/// private non-`unsafe` function which does the dereferencing, the lint won't
/// trigger.
/// * It only checks for arguments whose type are raw pointers, not raw pointers
/// got from an argument in some other way (`fn foo(bar: &[*const u8])` or
/// `some_argument.get_raw_ptr()`).
///
/// **Example:**
/// ```rust
/// pub fn foo(x: *const u8) { println!("{}", unsafe { *x }); }
/// ```
2018-03-28 08:24:26 -05:00
declare_clippy_lint! {
pub NOT_UNSAFE_PTR_ARG_DEREF,
2018-03-28 08:24:26 -05:00
correctness,
"public functions dereferencing raw pointer arguments but not marked `unsafe`"
}
2017-08-09 02:30:56 -05:00
#[derive(Copy, Clone)]
2016-03-08 17:48:10 -06:00
pub struct Functions {
threshold: u64,
}
impl Functions {
2017-08-21 06:32:12 -05:00
pub fn new(threshold: u64) -> Self {
2017-09-05 04:33:04 -05:00
Self {
threshold,
2017-09-05 04:33:04 -05:00
}
2016-03-08 17:48:10 -06:00
}
}
impl LintPass for Functions {
fn get_lints(&self) -> LintArray {
lint_array!(TOO_MANY_ARGUMENTS, NOT_UNSAFE_PTR_ARG_DEREF)
2016-03-08 17:48:10 -06:00
}
}
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Functions {
fn check_fn(
&mut self,
cx: &LateContext<'a, 'tcx>,
kind: intravisit::FnKind<'tcx>,
decl: &'tcx hir::FnDecl,
body: &'tcx hir::Body,
span: Span,
2017-08-09 02:30:56 -05:00
nodeid: ast::NodeId,
) {
use rustc::hir::map::Node::*;
2016-03-08 17:48:10 -06:00
2017-02-02 10:53:28 -06:00
let is_impl = if let Some(NodeItem(item)) = cx.tcx.hir.find(cx.tcx.hir.get_parent_node(nodeid)) {
2018-01-15 05:07:38 -06:00
matches!(item.node, hir::ItemImpl(_, _, _, _, Some(_), _, _))
} else {
false
};
let unsafety = match kind {
hir::intravisit::FnKind::ItemFn(_, _, unsafety, _, _, _, _) => unsafety,
hir::intravisit::FnKind::Method(_, sig, _, _) => sig.unsafety,
hir::intravisit::FnKind::Closure(_) => return,
};
// don't warn for implementations, it's not their fault
if !is_impl {
// don't lint extern functions decls, it's not their fault either
match kind {
hir::intravisit::FnKind::Method(_, &hir::MethodSig { abi: Abi::Rust, .. }, _, _) |
hir::intravisit::FnKind::ItemFn(_, _, _, _, Abi::Rust, _, _) => self.check_arg_number(cx, decl, span),
_ => {},
}
2016-03-08 17:48:10 -06:00
}
self.check_raw_ptr(cx, unsafety, decl, body, nodeid);
2016-03-08 17:48:10 -06:00
}
fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx hir::TraitItem) {
if let hir::TraitItemKind::Method(ref sig, ref eid) = item.node {
// don't lint extern functions decls, it's not their fault
if sig.abi == Abi::Rust {
self.check_arg_number(cx, &sig.decl, item.span);
}
if let hir::TraitMethod::Provided(eid) = *eid {
2017-02-02 10:53:28 -06:00
let body = cx.tcx.hir.body(eid);
self.check_raw_ptr(cx, sig.unsafety, &sig.decl, body, item.id);
}
2016-03-08 17:48:10 -06:00
}
}
}
impl<'a, 'tcx> Functions {
2016-03-08 17:48:10 -06:00
fn check_arg_number(&self, cx: &LateContext, decl: &hir::FnDecl, span: Span) {
let args = decl.inputs.len() as u64;
if args > self.threshold {
2017-08-09 02:30:56 -05:00
span_lint(
cx,
TOO_MANY_ARGUMENTS,
span,
&format!("this function has too many arguments ({}/{})", args, self.threshold),
);
2016-03-08 17:48:10 -06:00
}
}
fn check_raw_ptr(
&self,
cx: &LateContext<'a, 'tcx>,
unsafety: hir::Unsafety,
decl: &'tcx hir::FnDecl,
body: &'tcx hir::Body,
2017-08-09 02:30:56 -05:00
nodeid: ast::NodeId,
) {
let expr = &body.value;
if unsafety == hir::Unsafety::Normal && cx.access_levels.is_exported(nodeid) {
2017-01-04 17:53:16 -06:00
let raw_ptrs = iter_input_pats(decl, body)
.zip(decl.inputs.iter())
.filter_map(|(arg, ty)| raw_ptr_arg(arg, ty))
.collect::<HashSet<_>>();
if !raw_ptrs.is_empty() {
2017-08-21 05:57:33 -05:00
let tables = cx.tcx.body_tables(body.id());
let mut v = DerefVisitor {
cx,
ptrs: raw_ptrs,
2017-08-21 05:57:33 -05:00
tables,
};
hir::intravisit::walk_expr(&mut v, expr);
}
}
}
}
2017-09-12 07:26:40 -05:00
fn raw_ptr_arg(arg: &hir::Arg, ty: &hir::Ty) -> Option<ast::NodeId> {
if let (&hir::PatKind::Binding(_, id, _, _), &hir::TyPtr(_)) = (&arg.pat.node, &ty.node) {
Some(id)
} else {
None
}
}
struct DerefVisitor<'a, 'tcx: 'a> {
cx: &'a LateContext<'a, 'tcx>,
2017-09-12 07:26:40 -05:00
ptrs: HashSet<ast::NodeId>,
2017-08-21 05:57:33 -05:00
tables: &'a ty::TypeckTables<'tcx>,
}
impl<'a, 'tcx> hir::intravisit::Visitor<'tcx> for DerefVisitor<'a, 'tcx> {
fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
match expr.node {
hir::ExprCall(ref f, ref args) => {
2017-08-21 05:57:33 -05:00
let ty = self.tables.expr_ty(f);
if type_is_unsafe_function(self.cx, ty) {
for arg in args {
self.check_arg(arg);
}
}
2016-12-20 11:21:30 -06:00
},
hir::ExprMethodCall(_, _, ref args) => {
2017-08-21 05:57:33 -05:00
let def_id = self.tables.type_dependent_defs()[expr.hir_id].def_id();
let base_type = self.cx.tcx.type_of(def_id);
if type_is_unsafe_function(self.cx, base_type) {
for arg in args {
self.check_arg(arg);
}
}
2016-12-20 11:21:30 -06:00
},
hir::ExprUnary(hir::UnDeref, ref ptr) => self.check_arg(ptr),
_ => (),
}
hir::intravisit::walk_expr(self, expr);
}
fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
intravisit::NestedVisitorMap::None
}
2016-03-08 17:48:10 -06:00
}
impl<'a, 'tcx: 'a> DerefVisitor<'a, 'tcx> {
fn check_arg(&self, ptr: &hir::Expr) {
if let hir::ExprPath(ref qpath) = ptr.node {
2017-09-12 07:26:40 -05:00
if let Def::Local(id) = self.cx.tables.qpath_def(qpath, ptr.hir_id) {
if self.ptrs.contains(&id) {
span_lint(
self.cx,
NOT_UNSAFE_PTR_ARG_DEREF,
ptr.span,
"this public function dereferences a raw pointer but is not marked `unsafe`",
);
}
}
}
}
}