2 attr_by_name, attrs::is_proc_macro, is_must_use_ty, is_trait_impl_item, is_type_diagnostic_item, iter_input_pats,
3 match_def_path, must_use_attr, path_to_local, return_ty, snippet, snippet_opt, span_lint, span_lint_and_help,
4 span_lint_and_then, trait_ref_of_method, type_is_unsafe_function,
6 use if_chain::if_chain;
7 use rustc_ast::ast::Attribute;
8 use rustc_data_structures::fx::FxHashSet;
9 use rustc_errors::Applicability;
11 use rustc_hir::intravisit;
12 use rustc_hir::{def::Res, def_id::DefId, QPath};
13 use rustc_lint::{LateContext, LateLintPass, LintContext};
14 use rustc_middle::hir::map::Map;
15 use rustc_middle::lint::in_external_macro;
16 use rustc_middle::ty::{self, Ty};
17 use rustc_session::{declare_tool_lint, impl_lint_pass};
18 use rustc_span::source_map::Span;
20 use rustc_target::spec::abi::Abi;
21 use rustc_typeck::hir_ty_to_ty;
23 declare_clippy_lint! {
24 /// **What it does:** Checks for functions with too many parameters.
26 /// **Why is this bad?** Functions with lots of parameters are considered bad
27 /// style and reduce readability (“what does the 5th parameter mean?”). Consider
28 /// grouping some parameters into a new type.
30 /// **Known problems:** None.
35 /// fn foo(x: u32, y: u32, name: &str, c: Color, w: f32, h: f32, a: f32, b: f32) {
39 pub TOO_MANY_ARGUMENTS,
41 "functions with too many arguments"
44 declare_clippy_lint! {
45 /// **What it does:** Checks for functions with a large amount of lines.
47 /// **Why is this bad?** Functions with a lot of lines are harder to understand
48 /// due to having to look at a larger amount of code to understand what the
49 /// function is doing. Consider splitting the body of the function into
50 /// multiple functions.
52 /// **Known problems:** None.
56 /// fn im_too_long() {
58 /// // ... 100 more LoC
64 "functions with too many lines"
67 declare_clippy_lint! {
68 /// **What it does:** Checks for public functions that dereference raw pointer
69 /// arguments but are not marked unsafe.
71 /// **Why is this bad?** The function should probably be marked `unsafe`, since
72 /// for an arbitrary raw pointer, there is no way of telling for sure if it is
75 /// **Known problems:**
77 /// * It does not check functions recursively so if the pointer is passed to a
78 /// private non-`unsafe` function which does the dereferencing, the lint won't
80 /// * It only checks for arguments whose type are raw pointers, not raw pointers
81 /// got from an argument in some other way (`fn foo(bar: &[*const u8])` or
82 /// `some_argument.get_raw_ptr()`).
87 /// pub fn foo(x: *const u8) {
88 /// println!("{}", unsafe { *x });
92 /// pub unsafe fn foo(x: *const u8) {
93 /// println!("{}", unsafe { *x });
96 pub NOT_UNSAFE_PTR_ARG_DEREF,
98 "public functions dereferencing raw pointer arguments but not marked `unsafe`"
101 declare_clippy_lint! {
102 /// **What it does:** Checks for a [`#[must_use]`] attribute on
103 /// unit-returning functions and methods.
105 /// [`#[must_use]`]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute
107 /// **Why is this bad?** Unit values are useless. The attribute is likely
108 /// a remnant of a refactoring that removed the return type.
110 /// **Known problems:** None.
119 "`#[must_use]` attribute on a unit-returning function / method"
122 declare_clippy_lint! {
123 /// **What it does:** Checks for a [`#[must_use]`] attribute without
124 /// further information on functions and methods that return a type already
125 /// marked as `#[must_use]`.
127 /// [`#[must_use]`]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute
129 /// **Why is this bad?** The attribute isn't needed. Not using the result
130 /// will already be reported. Alternatively, one can add some text to the
131 /// attribute to improve the lint message.
133 /// **Known problems:** None.
138 /// fn double_must_use() -> Result<(), ()> {
139 /// unimplemented!();
144 "`#[must_use]` attribute on a `#[must_use]`-returning function / method"
147 declare_clippy_lint! {
148 /// **What it does:** Checks for public functions that have no
149 /// [`#[must_use]`] attribute, but return something not already marked
150 /// must-use, have no mutable arg and mutate no statics.
152 /// [`#[must_use]`]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute
154 /// **Why is this bad?** Not bad at all, this lint just shows places where
155 /// you could add the attribute.
157 /// **Known problems:** The lint only checks the arguments for mutable
158 /// types without looking if they are actually changed. On the other hand,
159 /// it also ignores a broad range of potentially interesting side effects,
160 /// because we cannot decide whether the programmer intends the function to
161 /// be called for the side effect or the result. Expect many false
162 /// positives. At least we don't lint if the result type is unit or already
167 /// // this could be annotated with `#[must_use]`.
168 /// fn id<T>(t: T) -> T { t }
170 pub MUST_USE_CANDIDATE,
172 "function or method that could take a `#[must_use]` attribute"
175 declare_clippy_lint! {
176 /// **What it does:** Checks for public functions that return a `Result`
177 /// with an `Err` type of `()`. It suggests using a custom type that
178 /// implements [`std::error::Error`].
180 /// **Why is this bad?** Unit does not implement `Error` and carries no
181 /// further information about what went wrong.
183 /// **Known problems:** Of course, this lint assumes that `Result` is used
184 /// for a fallible operation (which is after all the intended use). However
185 /// code may opt to (mis)use it as a basic two-variant-enum. In that case,
186 /// the suggestion is misguided, and the code should use a custom enum
191 /// pub fn read_u8() -> Result<u8, ()> { Err(()) }
194 /// ```rust,should_panic
198 /// pub struct EndOfStream;
200 /// impl fmt::Display for EndOfStream {
201 /// fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
202 /// write!(f, "End of Stream")
206 /// impl std::error::Error for EndOfStream { }
208 /// pub fn read_u8() -> Result<u8, EndOfStream> { Err(EndOfStream) }
210 ///# read_u8().unwrap();
214 /// Note that there are crates that simplify creating the error type, e.g.
215 /// [`thiserror`](https://docs.rs/thiserror).
218 "public function returning `Result` with an `Err` type of `()`"
221 #[derive(Copy, Clone)]
222 pub struct Functions {
228 pub fn new(threshold: u64, max_lines: u64) -> Self {
229 Self { threshold, max_lines }
233 impl_lint_pass!(Functions => [
236 NOT_UNSAFE_PTR_ARG_DEREF,
243 impl<'tcx> LateLintPass<'tcx> for Functions {
246 cx: &LateContext<'tcx>,
247 kind: intravisit::FnKind<'tcx>,
248 decl: &'tcx hir::FnDecl<'_>,
249 body: &'tcx hir::Body<'_>,
253 let unsafety = match kind {
254 intravisit::FnKind::ItemFn(_, _, hir::FnHeader { unsafety, .. }, _) => unsafety,
255 intravisit::FnKind::Method(_, sig, _) => sig.header.unsafety,
256 intravisit::FnKind::Closure => return,
259 // don't warn for implementations, it's not their fault
260 if !is_trait_impl_item(cx, hir_id) {
261 // don't lint extern functions decls, it's not their fault either
263 intravisit::FnKind::Method(
266 header: hir::FnHeader { abi: Abi::Rust, .. },
271 | intravisit::FnKind::ItemFn(_, _, hir::FnHeader { abi: Abi::Rust, .. }, _) => {
272 self.check_arg_number(cx, decl, span.with_hi(decl.output.span().hi()))
278 Self::check_raw_ptr(cx, unsafety, decl, body, hir_id);
279 self.check_line_number(cx, span, body);
282 fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx hir::Item<'_>) {
283 let attrs = cx.tcx.hir().attrs(item.hir_id());
284 let attr = must_use_attr(attrs);
285 if let hir::ItemKind::Fn(ref sig, ref _generics, ref body_id) = item.kind {
286 let is_public = cx.access_levels.is_exported(item.hir_id());
287 let fn_header_span = item.span.with_hi(sig.decl.output.span().hi());
289 check_result_unit_err(cx, &sig.decl, item.span, fn_header_span);
291 if let Some(attr) = attr {
292 check_needless_must_use(cx, &sig.decl, item.hir_id(), item.span, fn_header_span, attr);
295 if is_public && !is_proc_macro(cx.sess(), attrs) && attr_by_name(attrs, "no_mangle").is_none() {
296 check_must_use_candidate(
299 cx.tcx.hir().body(*body_id),
302 item.span.with_hi(sig.decl.output.span().hi()),
303 "this function could have a `#[must_use]` attribute",
309 fn check_impl_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx hir::ImplItem<'_>) {
310 if let hir::ImplItemKind::Fn(ref sig, ref body_id) = item.kind {
311 let is_public = cx.access_levels.is_exported(item.hir_id());
312 let fn_header_span = item.span.with_hi(sig.decl.output.span().hi());
313 if is_public && trait_ref_of_method(cx, item.hir_id()).is_none() {
314 check_result_unit_err(cx, &sig.decl, item.span, fn_header_span);
316 let attrs = cx.tcx.hir().attrs(item.hir_id());
317 let attr = must_use_attr(attrs);
318 if let Some(attr) = attr {
319 check_needless_must_use(cx, &sig.decl, item.hir_id(), item.span, fn_header_span, attr);
321 && !is_proc_macro(cx.sess(), attrs)
322 && trait_ref_of_method(cx, item.hir_id()).is_none()
324 check_must_use_candidate(
327 cx.tcx.hir().body(*body_id),
330 item.span.with_hi(sig.decl.output.span().hi()),
331 "this method could have a `#[must_use]` attribute",
337 fn check_trait_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx hir::TraitItem<'_>) {
338 if let hir::TraitItemKind::Fn(ref sig, ref eid) = item.kind {
339 // don't lint extern functions decls, it's not their fault
340 if sig.header.abi == Abi::Rust {
341 self.check_arg_number(cx, &sig.decl, item.span.with_hi(sig.decl.output.span().hi()));
343 let is_public = cx.access_levels.is_exported(item.hir_id());
344 let fn_header_span = item.span.with_hi(sig.decl.output.span().hi());
346 check_result_unit_err(cx, &sig.decl, item.span, fn_header_span);
349 let attrs = cx.tcx.hir().attrs(item.hir_id());
350 let attr = must_use_attr(attrs);
351 if let Some(attr) = attr {
352 check_needless_must_use(cx, &sig.decl, item.hir_id(), item.span, fn_header_span, attr);
354 if let hir::TraitFn::Provided(eid) = *eid {
355 let body = cx.tcx.hir().body(eid);
356 Self::check_raw_ptr(cx, sig.header.unsafety, &sig.decl, body, item.hir_id());
358 if attr.is_none() && is_public && !is_proc_macro(cx.sess(), attrs) {
359 check_must_use_candidate(
365 item.span.with_hi(sig.decl.output.span().hi()),
366 "this method could have a `#[must_use]` attribute",
374 impl<'tcx> Functions {
375 fn check_arg_number(self, cx: &LateContext<'_>, decl: &hir::FnDecl<'_>, fn_span: Span) {
376 let args = decl.inputs.len() as u64;
377 if args > self.threshold {
382 &format!("this function has too many arguments ({}/{})", args, self.threshold),
387 fn check_line_number(self, cx: &LateContext<'_>, span: Span, body: &'tcx hir::Body<'_>) {
388 if in_external_macro(cx.sess(), span) {
392 let code_snippet = snippet(cx, body.value.span, "..");
393 let mut line_count: u64 = 0;
394 let mut in_comment = false;
395 let mut code_in_line;
397 // Skip the surrounding function decl.
398 let start_brace_idx = code_snippet.find('{').map_or(0, |i| i + 1);
399 let end_brace_idx = code_snippet.rfind('}').unwrap_or_else(|| code_snippet.len());
400 let function_lines = code_snippet[start_brace_idx..end_brace_idx].lines();
402 for mut line in function_lines {
403 code_in_line = false;
405 line = line.trim_start();
410 if let Some(i) = line.find("*/") {
411 line = &line[i + 2..];
416 let multi_idx = line.find("/*").unwrap_or_else(|| line.len());
417 let single_idx = line.find("//").unwrap_or_else(|| line.len());
418 code_in_line |= multi_idx > 0 && single_idx > 0;
419 // Implies multi_idx is below line.len()
420 if multi_idx < single_idx {
421 line = &line[multi_idx + 2..];
433 if line_count > self.max_lines {
438 &format!("this function has too many lines ({}/{})", line_count, self.max_lines),
444 cx: &LateContext<'tcx>,
445 unsafety: hir::Unsafety,
446 decl: &'tcx hir::FnDecl<'_>,
447 body: &'tcx hir::Body<'_>,
450 let expr = &body.value;
451 if unsafety == hir::Unsafety::Normal && cx.access_levels.is_exported(hir_id) {
452 let raw_ptrs = iter_input_pats(decl, body)
453 .zip(decl.inputs.iter())
454 .filter_map(|(arg, ty)| raw_ptr_arg(arg, ty))
455 .collect::<FxHashSet<_>>();
457 if !raw_ptrs.is_empty() {
458 let typeck_results = cx.tcx.typeck_body(body.id());
459 let mut v = DerefVisitor {
465 intravisit::walk_expr(&mut v, expr);
471 fn check_result_unit_err(cx: &LateContext<'_>, decl: &hir::FnDecl<'_>, item_span: Span, fn_header_span: Span) {
473 if !in_external_macro(cx.sess(), item_span);
474 if let hir::FnRetTy::Return(ref ty) = decl.output;
475 let ty = hir_ty_to_ty(cx.tcx, ty);
476 if is_type_diagnostic_item(cx, ty, sym::result_type);
477 if let ty::Adt(_, substs) = ty.kind();
478 let err_ty = substs.type_at(1);
485 "this returns a `Result<_, ()>",
487 "use a custom Error type instead",
493 fn check_needless_must_use(
494 cx: &LateContext<'_>,
495 decl: &hir::FnDecl<'_>,
498 fn_header_span: Span,
501 if in_external_macro(cx.sess(), item_span) {
504 if returns_unit(decl) {
509 "this unit-returning function has a `#[must_use]` attribute",
511 diag.span_suggestion(
513 "remove the attribute",
515 Applicability::MachineApplicable,
519 } else if !attr.is_value_str() && is_must_use_ty(cx, return_ty(cx, item_id)) {
524 "this function has an empty `#[must_use]` attribute, but returns a type already marked as `#[must_use]`",
526 "either add some descriptive text or remove the attribute",
531 fn check_must_use_candidate<'tcx>(
532 cx: &LateContext<'tcx>,
533 decl: &'tcx hir::FnDecl<'_>,
534 body: &'tcx hir::Body<'_>,
540 if has_mutable_arg(cx, body)
541 || mutates_static(cx, body)
542 || in_external_macro(cx.sess(), item_span)
543 || returns_unit(decl)
544 || !cx.access_levels.is_exported(item_id)
545 || is_must_use_ty(cx, return_ty(cx, item_id))
549 span_lint_and_then(cx, MUST_USE_CANDIDATE, fn_span, msg, |diag| {
550 if let Some(snippet) = snippet_opt(cx, fn_span) {
551 diag.span_suggestion(
554 format!("#[must_use] {}", snippet),
555 Applicability::MachineApplicable,
561 fn returns_unit(decl: &hir::FnDecl<'_>) -> bool {
563 hir::FnRetTy::DefaultReturn(_) => true,
564 hir::FnRetTy::Return(ref ty) => match ty.kind {
565 hir::TyKind::Tup(ref tys) => tys.is_empty(),
566 hir::TyKind::Never => true,
572 fn has_mutable_arg(cx: &LateContext<'_>, body: &hir::Body<'_>) -> bool {
573 let mut tys = FxHashSet::default();
574 body.params.iter().any(|param| is_mutable_pat(cx, ¶m.pat, &mut tys))
577 fn is_mutable_pat(cx: &LateContext<'_>, pat: &hir::Pat<'_>, tys: &mut FxHashSet<DefId>) -> bool {
578 if let hir::PatKind::Wild = pat.kind {
579 return false; // ignore `_` patterns
581 if cx.tcx.has_typeck_results(pat.hir_id.owner.to_def_id()) {
582 is_mutable_ty(cx, &cx.tcx.typeck(pat.hir_id.owner).pat_ty(pat), pat.span, tys)
588 static KNOWN_WRAPPER_TYS: &[&[&str]] = &[&["alloc", "rc", "Rc"], &["std", "sync", "Arc"]];
590 fn is_mutable_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>, span: Span, tys: &mut FxHashSet<DefId>) -> bool {
592 // primitive types are never mutable
593 ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::Float(_) | ty::Str => false,
594 ty::Adt(ref adt, ref substs) => {
595 tys.insert(adt.did) && !ty.is_freeze(cx.tcx.at(span), cx.param_env)
596 || KNOWN_WRAPPER_TYS.iter().any(|path| match_def_path(cx, adt.did, path))
597 && substs.types().any(|ty| is_mutable_ty(cx, ty, span, tys))
599 ty::Tuple(ref substs) => substs.types().any(|ty| is_mutable_ty(cx, ty, span, tys)),
600 ty::Array(ty, _) | ty::Slice(ty) => is_mutable_ty(cx, ty, span, tys),
601 ty::RawPtr(ty::TypeAndMut { ty, mutbl }) | ty::Ref(_, ty, mutbl) => {
602 mutbl == hir::Mutability::Mut || is_mutable_ty(cx, ty, span, tys)
604 // calling something constitutes a side effect, so return true on all callables
605 // also never calls need not be used, so return true for them, too
610 fn raw_ptr_arg(arg: &hir::Param<'_>, ty: &hir::Ty<'_>) -> Option<hir::HirId> {
611 if let (&hir::PatKind::Binding(_, id, _, _), &hir::TyKind::Ptr(_)) = (&arg.pat.kind, &ty.kind) {
618 struct DerefVisitor<'a, 'tcx> {
619 cx: &'a LateContext<'tcx>,
620 ptrs: FxHashSet<hir::HirId>,
621 typeck_results: &'a ty::TypeckResults<'tcx>,
624 impl<'a, 'tcx> intravisit::Visitor<'tcx> for DerefVisitor<'a, 'tcx> {
625 type Map = Map<'tcx>;
627 fn visit_expr(&mut self, expr: &'tcx hir::Expr<'_>) {
629 hir::ExprKind::Call(ref f, args) => {
630 let ty = self.typeck_results.expr_ty(f);
632 if type_is_unsafe_function(self.cx, ty) {
638 hir::ExprKind::MethodCall(_, _, args, _) => {
639 let def_id = self.typeck_results.type_dependent_def_id(expr.hir_id).unwrap();
640 let base_type = self.cx.tcx.type_of(def_id);
642 if type_is_unsafe_function(self.cx, base_type) {
648 hir::ExprKind::Unary(hir::UnOp::Deref, ref ptr) => self.check_arg(ptr),
652 intravisit::walk_expr(self, expr);
655 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
656 intravisit::NestedVisitorMap::None
660 impl<'a, 'tcx> DerefVisitor<'a, 'tcx> {
661 fn check_arg(&self, ptr: &hir::Expr<'_>) {
662 if let Some(id) = path_to_local(ptr) {
663 if self.ptrs.contains(&id) {
666 NOT_UNSAFE_PTR_ARG_DEREF,
668 "this public function dereferences a raw pointer but is not marked `unsafe`",
675 struct StaticMutVisitor<'a, 'tcx> {
676 cx: &'a LateContext<'tcx>,
677 mutates_static: bool,
680 impl<'a, 'tcx> intravisit::Visitor<'tcx> for StaticMutVisitor<'a, 'tcx> {
681 type Map = Map<'tcx>;
683 fn visit_expr(&mut self, expr: &'tcx hir::Expr<'_>) {
684 use hir::ExprKind::{AddrOf, Assign, AssignOp, Call, MethodCall};
686 if self.mutates_static {
690 Call(_, args) | MethodCall(_, _, args, _) => {
691 let mut tys = FxHashSet::default();
693 if self.cx.tcx.has_typeck_results(arg.hir_id.owner.to_def_id())
696 self.cx.tcx.typeck(arg.hir_id.owner).expr_ty(arg),
700 && is_mutated_static(arg)
702 self.mutates_static = true;
708 Assign(ref target, ..) | AssignOp(_, ref target, _) | AddrOf(_, hir::Mutability::Mut, ref target) => {
709 self.mutates_static |= is_mutated_static(target)
715 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
716 intravisit::NestedVisitorMap::None
720 fn is_mutated_static(e: &hir::Expr<'_>) -> bool {
721 use hir::ExprKind::{Field, Index, Path};
724 Path(QPath::Resolved(_, path)) => !matches!(path.res, Res::Local(_)),
726 Field(ref inner, _) | Index(ref inner, _) => is_mutated_static(inner),
731 fn mutates_static<'tcx>(cx: &LateContext<'tcx>, body: &'tcx hir::Body<'_>) -> bool {
732 let mut v = StaticMutVisitor {
734 mutates_static: false,
736 intravisit::walk_expr(&mut v, &body.value);