1 // Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution.
4 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
5 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
7 // option. This file may not be copied, modified, or distributed
8 // except according to those terms.
11 #![allow(clippy::default_hash_types)]
13 use crate::reexport::*;
14 use crate::rustc::hir;
15 use crate::rustc::hir::*;
16 use crate::rustc::hir::intravisit::{walk_body, walk_expr, walk_ty, FnKind, NestedVisitorMap, Visitor};
17 use crate::rustc::lint::{LateContext, LateLintPass, LintArray, LintPass, in_external_macro, LintContext};
18 use crate::rustc::{declare_tool_lint, lint_array};
19 use if_chain::if_chain;
20 use crate::rustc::ty::{self, Ty, TyCtxt, TypeckTables};
21 use crate::rustc::ty::layout::LayoutOf;
22 use crate::rustc_typeck::hir_ty_to_ty;
23 use std::cmp::Ordering;
24 use std::collections::BTreeMap;
26 use crate::syntax::ast::{FloatTy, IntTy, UintTy};
27 use crate::syntax::source_map::Span;
28 use crate::syntax::errors::DiagnosticBuilder;
29 use crate::rustc_target::spec::abi::Abi;
30 use crate::utils::{comparisons, differing_macro_contexts, higher, in_constant, in_macro, last_path_segment, match_def_path, match_path,
31 match_type, multispan_sugg, opt_def_id, same_tys, snippet, snippet_opt, span_help_and_lint, span_lint,
32 span_lint_and_sugg, span_lint_and_then, clip, unsext, sext, int_bits};
33 use crate::utils::paths;
34 use crate::consts::{constant, Constant};
36 /// Handles all the linting of funky types
37 #[allow(missing_copy_implementations)]
40 /// **What it does:** Checks for use of `Box<Vec<_>>` anywhere in the code.
42 /// **Why is this bad?** `Vec` already keeps its contents in a separate area on
43 /// the heap. So if you `Box` it, you just add another level of indirection
44 /// without any benefit whatsoever.
46 /// **Known problems:** None.
51 /// values: Box<Vec<Foo>>,
62 declare_clippy_lint! {
65 "usage of `Box<Vec<T>>`, vector elements are already on the heap"
68 /// **What it does:** Checks for use of `Option<Option<_>>` in function signatures and type
71 /// **Why is this bad?** `Option<_>` represents an optional value. `Option<Option<_>>`
72 /// represents an optional optional value which is logically the same thing as an optional
73 /// value but has an unneeded extra level of wrapping.
75 /// **Known problems:** None.
79 /// fn x() -> Option<Option<u32>> {
82 declare_clippy_lint! {
85 "usage of `Option<Option<T>>`"
88 /// **What it does:** Checks for usage of any `LinkedList`, suggesting to use a
89 /// `Vec` or a `VecDeque` (formerly called `RingBuf`).
91 /// **Why is this bad?** Gankro says:
93 /// > The TL;DR of `LinkedList` is that it's built on a massive amount of
94 /// pointers and indirection.
95 /// > It wastes memory, it has terrible cache locality, and is all-around slow.
97 /// > "only" amortized for push/pop, should be faster in the general case for
98 /// almost every possible
99 /// > workload, and isn't even amortized at all if you can predict the capacity
102 /// > `LinkedList`s are only really good if you're doing a lot of merging or
103 /// splitting of lists.
104 /// > This is because they can just mangle some pointers instead of actually
105 /// copying the data. Even
106 /// > if you're doing a lot of insertion in the middle of the list, `RingBuf`
107 /// can still be better
108 /// > because of how expensive it is to seek to the middle of a `LinkedList`.
110 /// **Known problems:** False positives – the instances where using a
111 /// `LinkedList` makes sense are few and far between, but they can still happen.
115 /// let x = LinkedList::new();
117 declare_clippy_lint! {
120 "usage of LinkedList, usually a vector is faster, or a more specialized data \
121 structure like a VecDeque"
124 /// **What it does:** Checks for use of `&Box<T>` anywhere in the code.
126 /// **Why is this bad?** Any `&Box<T>` can also be a `&T`, which is more
129 /// **Known problems:** None.
133 /// fn foo(bar: &Box<T>) { ... }
139 /// fn foo(bar: &T) { ... }
141 declare_clippy_lint! {
144 "a borrow of a boxed type"
147 impl LintPass for TypePass {
148 fn get_lints(&self) -> LintArray {
149 lint_array!(BOX_VEC, OPTION_OPTION, LINKEDLIST, BORROWED_BOX)
153 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TypePass {
154 fn check_fn(&mut self, cx: &LateContext<'_, '_>, _: FnKind<'_>, decl: &FnDecl, _: &Body, _: Span, id: NodeId) {
155 // skip trait implementations, see #605
156 if let Some(hir::Node::Item(item)) = cx.tcx.hir.find(cx.tcx.hir.get_parent(id)) {
157 if let ItemKind::Impl(_, _, _, _, Some(..), _, _) = item.node {
162 check_fn_decl(cx, decl);
165 fn check_struct_field(&mut self, cx: &LateContext<'_, '_>, field: &StructField) {
166 check_ty(cx, &field.ty, false);
169 fn check_trait_item(&mut self, cx: &LateContext<'_, '_>, item: &TraitItem) {
171 TraitItemKind::Const(ref ty, _) | TraitItemKind::Type(_, Some(ref ty)) => check_ty(cx, ty, false),
172 TraitItemKind::Method(ref sig, _) => check_fn_decl(cx, &sig.decl),
177 fn check_local(&mut self, cx: &LateContext<'_, '_>, local: &Local) {
178 if let Some(ref ty) = local.ty {
179 check_ty(cx, ty, true);
184 fn check_fn_decl(cx: &LateContext<'_, '_>, decl: &FnDecl) {
185 for input in &decl.inputs {
186 check_ty(cx, input, false);
189 if let FunctionRetTy::Return(ref ty) = decl.output {
190 check_ty(cx, ty, false);
194 /// Check if `qpath` has last segment with type parameter matching `path`
195 fn match_type_parameter(cx: &LateContext<'_, '_>, qpath: &QPath, path: &[&str]) -> bool {
196 let last = last_path_segment(qpath);
198 if let Some(ref params) = last.args;
199 if !params.parenthesized;
200 if let Some(ty) = params.args.iter().find_map(|arg| match arg {
201 GenericArg::Type(ty) => Some(ty),
202 GenericArg::Lifetime(_) => None,
204 if let TyKind::Path(ref qpath) = ty.node;
205 if let Some(did) = opt_def_id(cx.tables.qpath_def(qpath, cx.tcx.hir.node_to_hir_id(ty.id)));
206 if match_def_path(cx.tcx, did, path);
214 /// Recursively check for `TypePass` lints in the given type. Stop at the first
217 /// The parameter `is_local` distinguishes the context of the type; types from
218 /// local bindings should only be checked for the `BORROWED_BOX` lint.
219 fn check_ty(cx: &LateContext<'_, '_>, ast_ty: &hir::Ty, is_local: bool) {
220 if in_macro(ast_ty.span) {
224 TyKind::Path(ref qpath) if !is_local => {
225 let hir_id = cx.tcx.hir.node_to_hir_id(ast_ty.id);
226 let def = cx.tables.qpath_def(qpath, hir_id);
227 if let Some(def_id) = opt_def_id(def) {
228 if Some(def_id) == cx.tcx.lang_items().owned_box() {
229 if match_type_parameter(cx, qpath, &paths::VEC) {
234 "you seem to be trying to use `Box<Vec<T>>`. Consider using just `Vec<T>`",
235 "`Vec<T>` is already on the heap, `Box<Vec<T>>` makes an extra allocation.",
237 return; // don't recurse into the type
239 } else if match_def_path(cx.tcx, def_id, &paths::OPTION) {
240 if match_type_parameter(cx, qpath, &paths::OPTION) {
245 "consider using `Option<T>` instead of `Option<Option<T>>` or a custom \
246 enum if you need to distinguish all 3 cases",
248 return; // don't recurse into the type
250 } else if match_def_path(cx.tcx, def_id, &paths::LINKED_LIST) {
255 "I see you're using a LinkedList! Perhaps you meant some other data structure?",
256 "a VecDeque might work",
258 return; // don't recurse into the type
262 QPath::Resolved(Some(ref ty), ref p) => {
263 check_ty(cx, ty, is_local);
264 for ty in p.segments.iter().flat_map(|seg| {
267 .map_or_else(|| [].iter(), |params| params.args.iter())
268 .filter_map(|arg| match arg {
269 GenericArg::Type(ty) => Some(ty),
270 GenericArg::Lifetime(_) => None,
273 check_ty(cx, ty, is_local);
276 QPath::Resolved(None, ref p) => for ty in p.segments.iter().flat_map(|seg| {
279 .map_or_else(|| [].iter(), |params| params.args.iter())
280 .filter_map(|arg| match arg {
281 GenericArg::Type(ty) => Some(ty),
282 GenericArg::Lifetime(_) => None,
285 check_ty(cx, ty, is_local);
287 QPath::TypeRelative(ref ty, ref seg) => {
288 check_ty(cx, ty, is_local);
289 if let Some(ref params) = seg.args {
290 for ty in params.args.iter().filter_map(|arg| match arg {
291 GenericArg::Type(ty) => Some(ty),
292 GenericArg::Lifetime(_) => None,
294 check_ty(cx, ty, is_local);
300 TyKind::Rptr(ref lt, ref mut_ty) => check_ty_rptr(cx, ast_ty, is_local, lt, mut_ty),
302 TyKind::Slice(ref ty) | TyKind::Array(ref ty, _) | TyKind::Ptr(MutTy { ref ty, .. }) => check_ty(cx, ty, is_local),
303 TyKind::Tup(ref tys) => for ty in tys {
304 check_ty(cx, ty, is_local);
310 fn check_ty_rptr(cx: &LateContext<'_, '_>, ast_ty: &hir::Ty, is_local: bool, lt: &Lifetime, mut_ty: &MutTy) {
311 match mut_ty.ty.node {
312 TyKind::Path(ref qpath) => {
313 let hir_id = cx.tcx.hir.node_to_hir_id(mut_ty.ty.id);
314 let def = cx.tables.qpath_def(qpath, hir_id);
316 if let Some(def_id) = opt_def_id(def);
317 if Some(def_id) == cx.tcx.lang_items().owned_box();
318 if let QPath::Resolved(None, ref path) = *qpath;
319 if let [ref bx] = *path.segments;
320 if let Some(ref params) = bx.args;
321 if !params.parenthesized;
322 if let Some(inner) = params.args.iter().find_map(|arg| match arg {
323 GenericArg::Type(ty) => Some(ty),
324 GenericArg::Lifetime(_) => None,
327 if is_any_trait(inner) {
328 // Ignore `Box<Any>` types, see #1884 for details.
332 let ltopt = if lt.is_elided() {
335 format!("{} ", lt.name.ident().name.as_str())
337 let mutopt = if mut_ty.mutbl == Mutability::MutMutable {
342 span_lint_and_sugg(cx,
345 "you seem to be trying to use `&Box<T>`. Consider using just `&T`",
347 format!("&{}{}{}", ltopt, mutopt, &snippet(cx, inner.span, ".."))
349 return; // don't recurse into the type
352 check_ty(cx, &mut_ty.ty, is_local);
354 _ => check_ty(cx, &mut_ty.ty, is_local),
358 // Returns true if given type is `Any` trait.
359 fn is_any_trait(t: &hir::Ty) -> bool {
361 if let TyKind::TraitObject(ref traits, _) = t.node;
362 if traits.len() >= 1;
363 // Only Send/Sync can be used as additional traits, so it is enough to
364 // check only the first trait.
365 if match_path(&traits[0].trait_ref.path, &paths::ANY_TRAIT);
374 #[allow(missing_copy_implementations)]
377 /// **What it does:** Checks for binding a unit value.
379 /// **Why is this bad?** A unit value cannot usefully be used anywhere. So
380 /// binding one is kind of pointless.
382 /// **Known problems:** None.
388 declare_clippy_lint! {
391 "creating a let binding to a value of unit type, which usually can't be used afterwards"
394 fn check_let_unit(cx: &LateContext<'_, '_>, decl: &Decl) {
395 if let DeclKind::Local(ref local) = decl.node {
396 if is_unit(cx.tables.pat_ty(&local.pat)) {
397 if in_external_macro(cx.sess(), decl.span) || in_macro(local.pat.span) {
400 if higher::is_from_for_desugar(decl) {
408 "this let-binding has unit value. Consider omitting `let {} =`",
409 snippet(cx, local.pat.span, "..")
416 impl LintPass for LetPass {
417 fn get_lints(&self) -> LintArray {
418 lint_array!(LET_UNIT_VALUE)
422 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for LetPass {
423 fn check_decl(&mut self, cx: &LateContext<'a, 'tcx>, decl: &'tcx Decl) {
424 check_let_unit(cx, decl)
428 /// **What it does:** Checks for comparisons to unit.
430 /// **Why is this bad?** Unit is always equal to itself, and thus is just a
431 /// clumsily written constant. Mostly this happens when someone accidentally
432 /// adds semicolons at the end of the operands.
434 /// **Known problems:** None.
438 /// if { foo(); } == { bar(); } { baz(); }
442 /// { foo(); bar(); baz(); }
444 declare_clippy_lint! {
447 "comparing unit values"
450 #[allow(missing_copy_implementations)]
453 impl LintPass for UnitCmp {
454 fn get_lints(&self) -> LintArray {
455 lint_array!(UNIT_CMP)
459 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnitCmp {
460 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
461 if in_macro(expr.span) {
464 if let ExprKind::Binary(ref cmp, ref left, _) = expr.node {
466 if op.is_comparison() && is_unit(cx.tables.expr_ty(left)) {
467 let result = match op {
468 BinOpKind::Eq | BinOpKind::Le | BinOpKind::Ge => "true",
476 "{}-comparison of unit values detected. This will always be {}",
486 /// **What it does:** Checks for passing a unit value as an argument to a function without using a unit literal (`()`).
488 /// **Why is this bad?** This is likely the result of an accidental semicolon.
490 /// **Known problems:** None.
499 declare_clippy_lint! {
502 "passing unit to a function"
507 impl LintPass for UnitArg {
508 fn get_lints(&self) -> LintArray {
509 lint_array!(UNIT_ARG)
513 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnitArg {
514 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
515 if in_macro(expr.span) {
519 ExprKind::Call(_, ref args) | ExprKind::MethodCall(_, _, ref args) => {
521 if is_unit(cx.tables.expr_ty(arg)) && !is_unit_literal(arg) {
522 let map = &cx.tcx.hir;
523 // apparently stuff in the desugaring of `?` can trigger this
524 // so check for that here
525 // only the calls to `Try::from_error` is marked as desugared,
526 // so we need to check both the current Expr and its parent.
527 if !is_questionmark_desugar_marked_call(expr) {
529 let opt_parent_node = map.find(map.get_parent_node(expr.id));
530 if let Some(hir::Node::Expr(parent_expr)) = opt_parent_node;
531 if is_questionmark_desugar_marked_call(parent_expr);
534 // `expr` and `parent_expr` where _both_ not from
535 // desugaring `?`, so lint
540 "passing a unit value to a function",
541 "if you intended to pass a unit value, use a unit literal instead",
555 fn is_questionmark_desugar_marked_call(expr: &Expr) -> bool {
556 use crate::syntax_pos::hygiene::CompilerDesugaringKind;
557 if let ExprKind::Call(ref callee, _) = expr.node {
558 callee.span.is_compiler_desugaring(CompilerDesugaringKind::QuestionMark)
564 fn is_unit(ty: Ty<'_>) -> bool {
566 ty::Tuple(slice) if slice.is_empty() => true,
571 fn is_unit_literal(expr: &Expr) -> bool {
573 ExprKind::Tup(ref slice) if slice.is_empty() => true,
580 /// **What it does:** Checks for casts from any numerical to a float type where
581 /// the receiving type cannot store all values from the original type without
582 /// rounding errors. This possible rounding is to be expected, so this lint is
583 /// `Allow` by default.
585 /// Basically, this warns on casting any integer with 32 or more bits to `f32`
586 /// or any 64-bit integer to `f64`.
588 /// **Why is this bad?** It's not bad at all. But in some applications it can be
589 /// helpful to know where precision loss can take place. This lint can help find
590 /// those places in the code.
592 /// **Known problems:** None.
596 /// let x = u64::MAX; x as f64
598 declare_clippy_lint! {
599 pub CAST_PRECISION_LOSS,
601 "casts that cause loss of precision, e.g. `x as f32` where `x: u64`"
604 /// **What it does:** Checks for casts from a signed to an unsigned numerical
605 /// type. In this case, negative values wrap around to large positive values,
606 /// which can be quite surprising in practice. However, as the cast works as
607 /// defined, this lint is `Allow` by default.
609 /// **Why is this bad?** Possibly surprising results. You can activate this lint
610 /// as a one-time check to see where numerical wrapping can arise.
612 /// **Known problems:** None.
617 /// y as u128 // will return 18446744073709551615
619 declare_clippy_lint! {
622 "casts from signed types to unsigned types, e.g. `x as u32` where `x: i32`"
625 /// **What it does:** Checks for on casts between numerical types that may
626 /// truncate large values. This is expected behavior, so the cast is `Allow` by
629 /// **Why is this bad?** In some problem domains, it is good practice to avoid
630 /// truncation. This lint can be activated to help assess where additional
631 /// checks could be beneficial.
633 /// **Known problems:** None.
637 /// fn as_u8(x: u64) -> u8 { x as u8 }
639 declare_clippy_lint! {
640 pub CAST_POSSIBLE_TRUNCATION,
642 "casts that may cause truncation of the value, e.g. `x as u8` where `x: u32`, \
643 or `x as i32` where `x: f32`"
646 /// **What it does:** Checks for casts from an unsigned type to a signed type of
647 /// the same size. Performing such a cast is a 'no-op' for the compiler,
648 /// i.e. nothing is changed at the bit level, and the binary representation of
649 /// the value is reinterpreted. This can cause wrapping if the value is too big
650 /// for the target signed type. However, the cast works as defined, so this lint
651 /// is `Allow` by default.
653 /// **Why is this bad?** While such a cast is not bad in itself, the results can
654 /// be surprising when this is not the intended behavior, as demonstrated by the
657 /// **Known problems:** None.
661 /// u32::MAX as i32 // will yield a value of `-1`
663 declare_clippy_lint! {
664 pub CAST_POSSIBLE_WRAP,
666 "casts that may cause wrapping around the value, e.g. `x as i32` where `x: u32` \
670 /// **What it does:** Checks for on casts between numerical types that may
671 /// be replaced by safe conversion functions.
673 /// **Why is this bad?** Rust's `as` keyword will perform many kinds of
674 /// conversions, including silently lossy conversions. Conversion functions such
675 /// as `i32::from` will only perform lossless conversions. Using the conversion
676 /// functions prevents conversions from turning into silent lossy conversions if
677 /// the types of the input expressions ever change, and make it easier for
678 /// people reading the code to know that the conversion is lossless.
680 /// **Known problems:** None.
684 /// fn as_u64(x: u8) -> u64 { x as u64 }
687 /// Using `::from` would look like this:
690 /// fn as_u64(x: u8) -> u64 { u64::from(x) }
692 declare_clippy_lint! {
695 "casts using `as` that are known to be lossless, e.g. `x as u64` where `x: u8`"
698 /// **What it does:** Checks for casts to the same type.
700 /// **Why is this bad?** It's just unnecessary.
702 /// **Known problems:** None.
706 /// let _ = 2i32 as i32
708 declare_clippy_lint! {
709 pub UNNECESSARY_CAST,
711 "cast to the same type, e.g. `x as i32` where `x: i32`"
714 /// **What it does:** Checks for casts from a less-strictly-aligned pointer to a
715 /// more-strictly-aligned pointer
717 /// **Why is this bad?** Dereferencing the resulting pointer may be undefined
720 /// **Known problems:** None.
724 /// let _ = (&1u8 as *const u8) as *const u16;
725 /// let _ = (&mut 1u8 as *mut u8) as *mut u16;
727 declare_clippy_lint! {
728 pub CAST_PTR_ALIGNMENT,
730 "cast from a pointer to a more-strictly-aligned pointer"
733 /// **What it does:** Checks for casts of function pointers to something other than usize
735 /// **Why is this bad?**
736 /// Casting a function pointer to anything other than usize/isize is not portable across
737 /// architectures, because you end up losing bits if the target type is too small or end up with a
738 /// bunch of extra bits that waste space and add more instructions to the final binary than
739 /// strictly necessary for the problem
741 /// Casting to isize also doesn't make sense since there are no signed addresses.
747 /// fn fun() -> i32 {}
748 /// let a = fun as i64;
751 /// fn fun2() -> i32 {}
752 /// let a = fun2 as usize;
754 declare_clippy_lint! {
755 pub FN_TO_NUMERIC_CAST,
757 "casting a function pointer to a numeric type other than usize"
760 /// **What it does:** Checks for casts of a function pointer to a numeric type not wide enough to
763 /// **Why is this bad?**
764 /// Such a cast discards some bits of the function's address. If this is intended, it would be more
765 /// clearly expressed by casting to usize first, then casting the usize to the intended type (with
766 /// a comment) to perform the truncation.
772 /// fn fn1() -> i16 { 1 };
773 /// let _ = fn1 as i32;
775 /// // Better: Cast to usize first, then comment with the reason for the truncation
776 /// fn fn2() -> i16 { 1 };
777 /// let fn_ptr = fn2 as usize;
778 /// let fn_ptr_truncated = fn_ptr as i32;
780 declare_clippy_lint! {
781 pub FN_TO_NUMERIC_CAST_WITH_TRUNCATION,
783 "casting a function pointer to a numeric type not wide enough to store the address"
786 /// Returns the size in bits of an integral type.
787 /// Will return 0 if the type is not an int or uint variant
788 fn int_ty_to_nbits(typ: Ty<'_>, tcx: TyCtxt<'_, '_, '_>) -> u64 {
790 ty::Int(i) => match i {
791 IntTy::Isize => tcx.data_layout.pointer_size.bits(),
798 ty::Uint(i) => match i {
799 UintTy::Usize => tcx.data_layout.pointer_size.bits(),
810 fn is_isize_or_usize(typ: Ty<'_>) -> bool {
812 ty::Int(IntTy::Isize) | ty::Uint(UintTy::Usize) => true,
817 fn span_precision_loss_lint(cx: &LateContext<'_, '_>, expr: &Expr, cast_from: Ty<'_>, cast_to_f64: bool) {
818 let mantissa_nbits = if cast_to_f64 { 52 } else { 23 };
819 let arch_dependent = is_isize_or_usize(cast_from) && cast_to_f64;
820 let arch_dependent_str = "on targets with 64-bit wide pointers ";
821 let from_nbits_str = if arch_dependent {
823 } else if is_isize_or_usize(cast_from) {
824 "32 or 64".to_owned()
826 int_ty_to_nbits(cast_from, cx.tcx).to_string()
833 "casting {0} to {1} causes a loss of precision {2}({0} is {3} bits wide, but {1}'s mantissa \
834 is only {4} bits wide)",
836 if cast_to_f64 { "f64" } else { "f32" },
848 fn should_strip_parens(op: &Expr, snip: &str) -> bool {
849 if let ExprKind::Binary(_, _, _) = op.node {
850 if snip.starts_with('(') && snip.ends_with(')') {
857 fn span_lossless_lint(cx: &LateContext<'_, '_>, expr: &Expr, op: &Expr, cast_from: Ty<'_>, cast_to: Ty<'_>) {
858 // Do not suggest using From in consts/statics until it is valid to do so (see #2267).
859 if in_constant(cx, expr.id) { return }
860 // The suggestion is to use a function call, so if the original expression
861 // has parens on the outside, they are no longer needed.
862 let opt = snippet_opt(cx, op.span);
863 let sugg = if let Some(ref snip) = opt {
864 if should_strip_parens(op, snip) {
865 &snip[1..snip.len() - 1]
877 &format!("casting {} to {} may become silently lossy if types change", cast_from, cast_to),
879 format!("{}::from({})", cast_to, sugg),
889 fn check_truncation_and_wrapping(cx: &LateContext<'_, '_>, expr: &Expr, cast_from: Ty<'_>, cast_to: Ty<'_>) {
890 let arch_64_suffix = " on targets with 64-bit wide pointers";
891 let arch_32_suffix = " on targets with 32-bit wide pointers";
892 let cast_unsigned_to_signed = !cast_from.is_signed() && cast_to.is_signed();
893 let from_nbits = int_ty_to_nbits(cast_from, cx.tcx);
894 let to_nbits = int_ty_to_nbits(cast_to, cx.tcx);
895 let (span_truncation, suffix_truncation, span_wrap, suffix_wrap) =
896 match (is_isize_or_usize(cast_from), is_isize_or_usize(cast_to)) {
897 (true, true) | (false, false) => (
898 to_nbits < from_nbits,
900 to_nbits == from_nbits && cast_unsigned_to_signed,
910 to_nbits <= 32 && cast_unsigned_to_signed,
916 cast_unsigned_to_signed,
917 if from_nbits == 64 {
927 CAST_POSSIBLE_TRUNCATION,
930 "casting {} to {} may truncate the value{}",
933 match suffix_truncation {
934 ArchSuffix::_32 => arch_32_suffix,
935 ArchSuffix::_64 => arch_64_suffix,
936 ArchSuffix::None => "",
947 "casting {} to {} may wrap around the value{}",
951 ArchSuffix::_32 => arch_32_suffix,
952 ArchSuffix::_64 => arch_64_suffix,
953 ArchSuffix::None => "",
960 fn check_lossless(cx: &LateContext<'_, '_>, expr: &Expr, op: &Expr, cast_from: Ty<'_>, cast_to: Ty<'_>) {
961 let cast_signed_to_unsigned = cast_from.is_signed() && !cast_to.is_signed();
962 let from_nbits = int_ty_to_nbits(cast_from, cx.tcx);
963 let to_nbits = int_ty_to_nbits(cast_to, cx.tcx);
964 if !is_isize_or_usize(cast_from) && !is_isize_or_usize(cast_to) && from_nbits < to_nbits && !cast_signed_to_unsigned
966 span_lossless_lint(cx, expr, op, cast_from, cast_to);
970 impl LintPass for CastPass {
971 fn get_lints(&self) -> LintArray {
975 CAST_POSSIBLE_TRUNCATION,
981 FN_TO_NUMERIC_CAST_WITH_TRUNCATION,
986 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for CastPass {
987 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
988 if let ExprKind::Cast(ref ex, _) = expr.node {
989 let (cast_from, cast_to) = (cx.tables.expr_ty(ex), cx.tables.expr_ty(expr));
990 lint_fn_to_numeric_cast(cx, expr, ex, cast_from, cast_to);
991 if let ExprKind::Lit(ref lit) = ex.node {
992 use crate::syntax::ast::{LitIntType, LitKind};
994 LitKind::Int(_, LitIntType::Unsuffixed) | LitKind::FloatUnsuffixed(_) => {},
995 _ => if cast_from.sty == cast_to.sty && !in_external_macro(cx.sess(), expr.span) {
1000 &format!("casting to the same type is unnecessary (`{}` -> `{}`)", cast_from, cast_to),
1005 if cast_from.is_numeric() && cast_to.is_numeric() && !in_external_macro(cx.sess(), expr.span) {
1006 match (cast_from.is_integral(), cast_to.is_integral()) {
1008 let from_nbits = int_ty_to_nbits(cast_from, cx.tcx);
1009 let to_nbits = if let ty::Float(FloatTy::F32) = cast_to.sty {
1014 if is_isize_or_usize(cast_from) || from_nbits >= to_nbits {
1015 span_precision_loss_lint(cx, expr, cast_from, to_nbits == 64);
1017 if from_nbits < to_nbits {
1018 span_lossless_lint(cx, expr, ex, cast_from, cast_to);
1024 CAST_POSSIBLE_TRUNCATION,
1026 &format!("casting {} to {} may truncate the value", cast_from, cast_to),
1028 if !cast_to.is_signed() {
1033 &format!("casting {} to {} may lose the sign of the value", cast_from, cast_to),
1038 if cast_from.is_signed() && !cast_to.is_signed() {
1043 &format!("casting {} to {} may lose the sign of the value", cast_from, cast_to),
1046 check_truncation_and_wrapping(cx, expr, cast_from, cast_to);
1047 check_lossless(cx, expr, ex, cast_from, cast_to);
1050 if let (&ty::Float(FloatTy::F64), &ty::Float(FloatTy::F32)) = (&cast_from.sty, &cast_to.sty)
1054 CAST_POSSIBLE_TRUNCATION,
1056 "casting f64 to f32 may truncate the value",
1059 if let (&ty::Float(FloatTy::F32), &ty::Float(FloatTy::F64)) = (&cast_from.sty, &cast_to.sty)
1061 span_lossless_lint(cx, expr, ex, cast_from, cast_to);
1068 if let ty::RawPtr(from_ptr_ty) = &cast_from.sty;
1069 if let ty::RawPtr(to_ptr_ty) = &cast_to.sty;
1070 if let Some(from_align) = cx.layout_of(from_ptr_ty.ty).ok().map(|a| a.align.abi());
1071 if let Some(to_align) = cx.layout_of(to_ptr_ty.ty).ok().map(|a| a.align.abi());
1072 if from_align < to_align;
1073 // with c_void, we inherently need to trust the user
1075 match_type(cx, from_ptr_ty.ty, &paths::C_VOID)
1076 || match_type(cx, from_ptr_ty.ty, &paths::C_VOID_LIBC)
1083 &format!("casting from `{}` to a more-strictly-aligned pointer (`{}`)", cast_from, cast_to)
1091 fn lint_fn_to_numeric_cast(cx: &LateContext<'_, '_>, expr: &Expr, cast_expr: &Expr, cast_from: Ty<'_>, cast_to: Ty<'_>) {
1092 // We only want to check casts to `ty::Uint` or `ty::Int`
1094 ty::Uint(_) | ty::Int(..) => { /* continue on */ },
1097 match cast_from.sty {
1098 ty::FnDef(..) | ty::FnPtr(_) => {
1099 let from_snippet = snippet(cx, cast_expr.span, "x");
1101 let to_nbits = int_ty_to_nbits(cast_to, cx.tcx);
1102 if to_nbits < cx.tcx.data_layout.pointer_size.bits() {
1105 FN_TO_NUMERIC_CAST_WITH_TRUNCATION,
1107 &format!("casting function pointer `{}` to `{}`, which truncates the value", from_snippet, cast_to),
1109 format!("{} as usize", from_snippet)
1112 } else if cast_to.sty != ty::Uint(UintTy::Usize) {
1117 &format!("casting function pointer `{}` to `{}`", from_snippet, cast_to),
1119 format!("{} as usize", from_snippet)
1127 /// **What it does:** Checks for types used in structs, parameters and `let`
1128 /// declarations above a certain complexity threshold.
1130 /// **Why is this bad?** Too complex types make the code less readable. Consider
1131 /// using a `type` definition to simplify them.
1133 /// **Known problems:** None.
1137 /// struct Foo { inner: Rc<Vec<Vec<Box<(u32, u32, u32, u32)>>>> }
1139 declare_clippy_lint! {
1140 pub TYPE_COMPLEXITY,
1142 "usage of very complex types that might be better factored into `type` definitions"
1145 #[allow(missing_copy_implementations)]
1146 pub struct TypeComplexityPass {
1150 impl TypeComplexityPass {
1151 pub fn new(threshold: u64) -> Self {
1158 impl LintPass for TypeComplexityPass {
1159 fn get_lints(&self) -> LintArray {
1160 lint_array!(TYPE_COMPLEXITY)
1164 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TypeComplexityPass {
1167 cx: &LateContext<'a, 'tcx>,
1174 self.check_fndecl(cx, decl);
1177 fn check_struct_field(&mut self, cx: &LateContext<'a, 'tcx>, field: &'tcx StructField) {
1178 // enum variants are also struct fields now
1179 self.check_type(cx, &field.ty);
1182 fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
1184 ItemKind::Static(ref ty, _, _) | ItemKind::Const(ref ty, _) => self.check_type(cx, ty),
1185 // functions, enums, structs, impls and traits are covered
1190 fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx TraitItem) {
1192 TraitItemKind::Const(ref ty, _) | TraitItemKind::Type(_, Some(ref ty)) => self.check_type(cx, ty),
1193 TraitItemKind::Method(MethodSig { ref decl, .. }, TraitMethod::Required(_)) => self.check_fndecl(cx, decl),
1194 // methods with default impl are covered by check_fn
1199 fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx ImplItem) {
1201 ImplItemKind::Const(ref ty, _) | ImplItemKind::Type(ref ty) => self.check_type(cx, ty),
1202 // methods are covered by check_fn
1207 fn check_local(&mut self, cx: &LateContext<'a, 'tcx>, local: &'tcx Local) {
1208 if let Some(ref ty) = local.ty {
1209 self.check_type(cx, ty);
1214 impl<'a, 'tcx> TypeComplexityPass {
1215 fn check_fndecl(&self, cx: &LateContext<'a, 'tcx>, decl: &'tcx FnDecl) {
1216 for arg in &decl.inputs {
1217 self.check_type(cx, arg);
1219 if let Return(ref ty) = decl.output {
1220 self.check_type(cx, ty);
1224 fn check_type(&self, cx: &LateContext<'_, '_>, ty: &hir::Ty) {
1225 if in_macro(ty.span) {
1229 let mut visitor = TypeComplexityVisitor { score: 0, nest: 1 };
1230 visitor.visit_ty(ty);
1234 if score > self.threshold {
1239 "very complex type used. Consider factoring parts into `type` definitions",
1245 /// Walks a type and assigns a complexity score to it.
1246 struct TypeComplexityVisitor {
1247 /// total complexity score of the type
1249 /// current nesting level
1253 impl<'tcx> Visitor<'tcx> for TypeComplexityVisitor {
1254 fn visit_ty(&mut self, ty: &'tcx hir::Ty) {
1255 let (add_score, sub_nest) = match ty.node {
1256 // _, &x and *x have only small overhead; don't mess with nesting level
1257 TyKind::Infer | TyKind::Ptr(..) | TyKind::Rptr(..) => (1, 0),
1259 // the "normal" components of a type: named types, arrays/tuples
1260 TyKind::Path(..) | TyKind::Slice(..) | TyKind::Tup(..) | TyKind::Array(..) => (10 * self.nest, 1),
1262 // function types bring a lot of overhead
1263 TyKind::BareFn(ref bare) if bare.abi == Abi::Rust => (50 * self.nest, 1),
1265 TyKind::TraitObject(ref param_bounds, _) => {
1266 let has_lifetime_parameters = param_bounds
1268 .any(|bound| bound.bound_generic_params.iter().any(|gen| match gen.kind {
1269 GenericParamKind::Lifetime { .. } => true,
1272 if has_lifetime_parameters {
1273 // complex trait bounds like A<'a, 'b>
1276 // simple trait bounds like A + B
1283 self.score += add_score;
1284 self.nest += sub_nest;
1286 self.nest -= sub_nest;
1288 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1289 NestedVisitorMap::None
1293 /// **What it does:** Checks for expressions where a character literal is cast
1294 /// to `u8` and suggests using a byte literal instead.
1296 /// **Why is this bad?** In general, casting values to smaller types is
1297 /// error-prone and should be avoided where possible. In the particular case of
1298 /// converting a character literal to u8, it is easy to avoid by just using a
1299 /// byte literal instead. As an added bonus, `b'a'` is even slightly shorter
1300 /// than `'a' as u8`.
1302 /// **Known problems:** None.
1309 /// A better version, using the byte literal:
1314 declare_clippy_lint! {
1317 "casting a character literal to u8"
1320 pub struct CharLitAsU8;
1322 impl LintPass for CharLitAsU8 {
1323 fn get_lints(&self) -> LintArray {
1324 lint_array!(CHAR_LIT_AS_U8)
1328 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for CharLitAsU8 {
1329 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
1330 use crate::syntax::ast::{LitKind, UintTy};
1332 if let ExprKind::Cast(ref e, _) = expr.node {
1333 if let ExprKind::Lit(ref l) = e.node {
1334 if let LitKind::Char(_) = l.node {
1335 if ty::Uint(UintTy::U8) == cx.tables.expr_ty(expr).sty && !in_macro(expr.span) {
1336 let msg = "casting character literal to u8. `char`s \
1337 are 4 bytes wide in rust, so casting to u8 \
1339 let help = format!("Consider using a byte literal instead:\nb{}", snippet(cx, e.span, "'x'"));
1340 span_help_and_lint(cx, CHAR_LIT_AS_U8, expr.span, msg, &help);
1348 /// **What it does:** Checks for comparisons where one side of the relation is
1349 /// either the minimum or maximum value for its type and warns if it involves a
1350 /// case that is always true or always false. Only integer and boolean types are
1353 /// **Why is this bad?** An expression like `min <= x` may misleadingly imply
1354 /// that is is possible for `x` to be less than the minimum. Expressions like
1355 /// `max < x` are probably mistakes.
1357 /// **Known problems:** For `usize` the size of the current compile target will
1358 /// be assumed (e.g. 64 bits on 64 bit systems). This means code that uses such
1359 /// a comparison to detect target pointer width will trigger this lint. One can
1360 /// use `mem::sizeof` and compare its value or conditional compilation
1362 /// like `#[cfg(target_pointer_width = "64")] ..` instead.
1367 /// 100 > std::i32::MAX
1369 declare_clippy_lint! {
1370 pub ABSURD_EXTREME_COMPARISONS,
1372 "a comparison with a maximum or minimum value that is always true or false"
1375 pub struct AbsurdExtremeComparisons;
1377 impl LintPass for AbsurdExtremeComparisons {
1378 fn get_lints(&self) -> LintArray {
1379 lint_array!(ABSURD_EXTREME_COMPARISONS)
1388 struct ExtremeExpr<'a> {
1393 enum AbsurdComparisonResult {
1396 InequalityImpossible,
1400 fn is_cast_between_fixed_and_target<'a, 'tcx>(
1401 cx: &LateContext<'a, 'tcx>,
1405 if let ExprKind::Cast(ref cast_exp, _) = expr.node {
1406 let precast_ty = cx.tables.expr_ty(cast_exp);
1407 let cast_ty = cx.tables.expr_ty(expr);
1409 return is_isize_or_usize(precast_ty) != is_isize_or_usize(cast_ty)
1415 fn detect_absurd_comparison<'a, 'tcx>(
1416 cx: &LateContext<'a, 'tcx>,
1420 ) -> Option<(ExtremeExpr<'tcx>, AbsurdComparisonResult)> {
1421 use crate::types::ExtremeType::*;
1422 use crate::types::AbsurdComparisonResult::*;
1423 use crate::utils::comparisons::*;
1425 // absurd comparison only makes sense on primitive types
1426 // primitive types don't implement comparison operators with each other
1427 if cx.tables.expr_ty(lhs) != cx.tables.expr_ty(rhs) {
1431 // comparisons between fix sized types and target sized types are considered unanalyzable
1432 if is_cast_between_fixed_and_target(cx, lhs) || is_cast_between_fixed_and_target(cx, rhs) {
1436 let normalized = normalize_comparison(op, lhs, rhs);
1437 let (rel, normalized_lhs, normalized_rhs) = if let Some(val) = normalized {
1443 let lx = detect_extreme_expr(cx, normalized_lhs);
1444 let rx = detect_extreme_expr(cx, normalized_rhs);
1449 (Some(l @ ExtremeExpr { which: Maximum, .. }), _) => (l, AlwaysFalse), // max < x
1450 (_, Some(r @ ExtremeExpr { which: Minimum, .. })) => (r, AlwaysFalse), // x < min
1456 (Some(l @ ExtremeExpr { which: Minimum, .. }), _) => (l, AlwaysTrue), // min <= x
1457 (Some(l @ ExtremeExpr { which: Maximum, .. }), _) => (l, InequalityImpossible), // max <= x
1458 (_, Some(r @ ExtremeExpr { which: Minimum, .. })) => (r, InequalityImpossible), // x <= min
1459 (_, Some(r @ ExtremeExpr { which: Maximum, .. })) => (r, AlwaysTrue), // x <= max
1463 Rel::Ne | Rel::Eq => return None,
1467 fn detect_extreme_expr<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) -> Option<ExtremeExpr<'tcx>> {
1468 use crate::types::ExtremeType::*;
1470 let ty = cx.tables.expr_ty(expr);
1472 let cv = constant(cx, cx.tables, expr)?.0;
1474 let which = match (&ty.sty, cv) {
1475 (&ty::Bool, Constant::Bool(false)) |
1476 (&ty::Uint(_), Constant::Int(0)) => Minimum,
1477 (&ty::Int(ity), Constant::Int(i)) if i == unsext(cx.tcx, i128::min_value() >> (128 - int_bits(cx.tcx, ity)), ity) => Minimum,
1479 (&ty::Bool, Constant::Bool(true)) => Maximum,
1480 (&ty::Int(ity), Constant::Int(i)) if i == unsext(cx.tcx, i128::max_value() >> (128 - int_bits(cx.tcx, ity)), ity) => Maximum,
1481 (&ty::Uint(uty), Constant::Int(i)) if clip(cx.tcx, u128::max_value(), uty) == i => Maximum,
1491 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for AbsurdExtremeComparisons {
1492 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
1493 use crate::types::ExtremeType::*;
1494 use crate::types::AbsurdComparisonResult::*;
1496 if let ExprKind::Binary(ref cmp, ref lhs, ref rhs) = expr.node {
1497 if let Some((culprit, result)) = detect_absurd_comparison(cx, cmp.node, lhs, rhs) {
1498 if !in_macro(expr.span) {
1499 let msg = "this comparison involving the minimum or maximum element for this \
1500 type contains a case that is always true or always false";
1502 let conclusion = match result {
1503 AlwaysFalse => "this comparison is always false".to_owned(),
1504 AlwaysTrue => "this comparison is always true".to_owned(),
1505 InequalityImpossible => format!(
1506 "the case where the two sides are not equal never occurs, consider using {} == {} \
1508 snippet(cx, lhs.span, "lhs"),
1509 snippet(cx, rhs.span, "rhs")
1514 "because {} is the {} value for this type, {}",
1515 snippet(cx, culprit.expr.span, "x"),
1516 match culprit.which {
1517 Minimum => "minimum",
1518 Maximum => "maximum",
1523 span_help_and_lint(cx, ABSURD_EXTREME_COMPARISONS, expr.span, msg, &help);
1530 /// **What it does:** Checks for comparisons where the relation is always either
1531 /// true or false, but where one side has been upcast so that the comparison is
1532 /// necessary. Only integer types are checked.
1534 /// **Why is this bad?** An expression like `let x : u8 = ...; (x as u32) > 300`
1535 /// will mistakenly imply that it is possible for `x` to be outside the range of
1538 /// **Known problems:**
1539 /// https://github.com/rust-lang-nursery/rust-clippy/issues/886
1543 /// let x : u8 = ...; (x as u32) > 300
1545 declare_clippy_lint! {
1546 pub INVALID_UPCAST_COMPARISONS,
1548 "a comparison involving an upcast which is always true or false"
1551 pub struct InvalidUpcastComparisons;
1553 impl LintPass for InvalidUpcastComparisons {
1554 fn get_lints(&self) -> LintArray {
1555 lint_array!(INVALID_UPCAST_COMPARISONS)
1559 #[derive(Copy, Clone, Debug, Eq)]
1566 #[allow(clippy::cast_sign_loss)]
1567 fn cmp_s_u(s: i128, u: u128) -> Ordering {
1570 } else if u > (i128::max_value() as u128) {
1578 impl PartialEq for FullInt {
1579 fn eq(&self, other: &Self) -> bool {
1580 self.partial_cmp(other)
1581 .expect("partial_cmp only returns Some(_)") == Ordering::Equal
1585 impl PartialOrd for FullInt {
1586 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1587 Some(match (self, other) {
1588 (&FullInt::S(s), &FullInt::S(o)) => s.cmp(&o),
1589 (&FullInt::U(s), &FullInt::U(o)) => s.cmp(&o),
1590 (&FullInt::S(s), &FullInt::U(o)) => Self::cmp_s_u(s, o),
1591 (&FullInt::U(s), &FullInt::S(o)) => Self::cmp_s_u(o, s).reverse(),
1595 impl Ord for FullInt {
1596 fn cmp(&self, other: &Self) -> Ordering {
1597 self.partial_cmp(other)
1598 .expect("partial_cmp for FullInt can never return None")
1603 fn numeric_cast_precast_bounds<'a>(cx: &LateContext<'_, '_>, expr: &'a Expr) -> Option<(FullInt, FullInt)> {
1604 use crate::syntax::ast::{IntTy, UintTy};
1607 if let ExprKind::Cast(ref cast_exp, _) = expr.node {
1608 let pre_cast_ty = cx.tables.expr_ty(cast_exp);
1609 let cast_ty = cx.tables.expr_ty(expr);
1610 // if it's a cast from i32 to u32 wrapping will invalidate all these checks
1611 if cx.layout_of(pre_cast_ty).ok().map(|l| l.size) == cx.layout_of(cast_ty).ok().map(|l| l.size) {
1614 match pre_cast_ty.sty {
1615 ty::Int(int_ty) => Some(match int_ty {
1616 IntTy::I8 => (FullInt::S(i128::from(i8::min_value())), FullInt::S(i128::from(i8::max_value()))),
1618 FullInt::S(i128::from(i16::min_value())),
1619 FullInt::S(i128::from(i16::max_value())),
1622 FullInt::S(i128::from(i32::min_value())),
1623 FullInt::S(i128::from(i32::max_value())),
1626 FullInt::S(i128::from(i64::min_value())),
1627 FullInt::S(i128::from(i64::max_value())),
1629 IntTy::I128 => (FullInt::S(i128::min_value()), FullInt::S(i128::max_value())),
1630 IntTy::Isize => (FullInt::S(isize::min_value() as i128), FullInt::S(isize::max_value() as i128)),
1632 ty::Uint(uint_ty) => Some(match uint_ty {
1633 UintTy::U8 => (FullInt::U(u128::from(u8::min_value())), FullInt::U(u128::from(u8::max_value()))),
1635 FullInt::U(u128::from(u16::min_value())),
1636 FullInt::U(u128::from(u16::max_value())),
1639 FullInt::U(u128::from(u32::min_value())),
1640 FullInt::U(u128::from(u32::max_value())),
1643 FullInt::U(u128::from(u64::min_value())),
1644 FullInt::U(u128::from(u64::max_value())),
1646 UintTy::U128 => (FullInt::U(u128::min_value()), FullInt::U(u128::max_value())),
1647 UintTy::Usize => (FullInt::U(usize::min_value() as u128), FullInt::U(usize::max_value() as u128)),
1656 fn node_as_const_fullint<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) -> Option<FullInt> {
1657 let val = constant(cx, cx.tables, expr)?.0;
1658 if let Constant::Int(const_int) = val {
1659 match cx.tables.expr_ty(expr).sty {
1660 ty::Int(ity) => Some(FullInt::S(sext(cx.tcx, const_int, ity))),
1661 ty::Uint(_) => Some(FullInt::U(const_int)),
1669 fn err_upcast_comparison(cx: &LateContext<'_, '_>, span: Span, expr: &Expr, always: bool) {
1670 if let ExprKind::Cast(ref cast_val, _) = expr.node {
1673 INVALID_UPCAST_COMPARISONS,
1676 "because of the numeric bounds on `{}` prior to casting, this expression is always {}",
1677 snippet(cx, cast_val.span, "the expression"),
1678 if always { "true" } else { "false" },
1684 fn upcast_comparison_bounds_err<'a, 'tcx>(
1685 cx: &LateContext<'a, 'tcx>,
1687 rel: comparisons::Rel,
1688 lhs_bounds: Option<(FullInt, FullInt)>,
1693 use crate::utils::comparisons::*;
1695 if let Some((lb, ub)) = lhs_bounds {
1696 if let Some(norm_rhs_val) = node_as_const_fullint(cx, rhs) {
1697 if rel == Rel::Eq || rel == Rel::Ne {
1698 if norm_rhs_val < lb || norm_rhs_val > ub {
1699 err_upcast_comparison(cx, span, lhs, rel == Rel::Ne);
1701 } else if match rel {
1702 Rel::Lt => if invert {
1707 Rel::Le => if invert {
1712 Rel::Eq | Rel::Ne => unreachable!(),
1714 err_upcast_comparison(cx, span, lhs, true)
1715 } else if match rel {
1716 Rel::Lt => if invert {
1721 Rel::Le => if invert {
1726 Rel::Eq | Rel::Ne => unreachable!(),
1728 err_upcast_comparison(cx, span, lhs, false)
1734 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for InvalidUpcastComparisons {
1735 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
1736 if let ExprKind::Binary(ref cmp, ref lhs, ref rhs) = expr.node {
1737 let normalized = comparisons::normalize_comparison(cmp.node, lhs, rhs);
1738 let (rel, normalized_lhs, normalized_rhs) = if let Some(val) = normalized {
1744 let lhs_bounds = numeric_cast_precast_bounds(cx, normalized_lhs);
1745 let rhs_bounds = numeric_cast_precast_bounds(cx, normalized_rhs);
1747 upcast_comparison_bounds_err(cx, expr.span, rel, lhs_bounds, normalized_lhs, normalized_rhs, false);
1748 upcast_comparison_bounds_err(cx, expr.span, rel, rhs_bounds, normalized_rhs, normalized_lhs, true);
1753 /// **What it does:** Checks for public `impl` or `fn` missing generalization
1754 /// over different hashers and implicitly defaulting to the default hashing
1755 /// algorithm (SipHash).
1757 /// **Why is this bad?** `HashMap` or `HashSet` with custom hashers cannot be
1760 /// **Known problems:** Suggestions for replacing constructors can contain
1761 /// false-positives. Also applying suggestions can require modification of other
1762 /// pieces of code, possibly including external crates.
1766 /// impl<K: Hash + Eq, V> Serialize for HashMap<K, V> { ... }
1768 /// pub foo(map: &mut HashMap<i32, i32>) { .. }
1770 declare_clippy_lint! {
1771 pub IMPLICIT_HASHER,
1773 "missing generalization over different hashers"
1776 pub struct ImplicitHasher;
1778 impl LintPass for ImplicitHasher {
1779 fn get_lints(&self) -> LintArray {
1780 lint_array!(IMPLICIT_HASHER)
1784 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for ImplicitHasher {
1785 #[allow(clippy::cast_possible_truncation)]
1786 fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
1787 use crate::syntax_pos::BytePos;
1789 fn suggestion<'a, 'tcx>(
1790 cx: &LateContext<'a, 'tcx>,
1791 db: &mut DiagnosticBuilder<'_>,
1792 generics_span: Span,
1793 generics_suggestion_span: Span,
1794 target: &ImplicitHasherType<'_>,
1795 vis: ImplicitHasherConstructorVisitor<'_, '_, '_>,
1797 let generics_snip = snippet(cx, generics_span, "");
1799 let generics_snip = if generics_snip.is_empty() {
1802 &generics_snip[1..generics_snip.len() - 1]
1807 "consider adding a type parameter".to_string(),
1810 generics_suggestion_span,
1812 "<{}{}S: ::std::hash::BuildHasher{}>",
1814 if generics_snip.is_empty() { "" } else { ", " },
1815 if vis.suggestions.is_empty() {
1818 // request users to add `Default` bound so that generic constructors can be used
1825 format!("{}<{}, S>", target.type_name(), target.type_arguments(),),
1830 if !vis.suggestions.is_empty() {
1831 multispan_sugg(db, "...and use generic constructor".into(), vis.suggestions);
1835 if !cx.access_levels.is_exported(item.id) {
1840 ItemKind::Impl(_, _, _, ref generics, _, ref ty, ref items) => {
1841 let mut vis = ImplicitHasherTypeVisitor::new(cx);
1844 for target in &vis.found {
1845 if differing_macro_contexts(item.span, target.span()) {
1849 let generics_suggestion_span = generics.span.substitute_dummy({
1850 let pos = snippet_opt(cx, item.span.until(target.span()))
1851 .and_then(|snip| Some(item.span.lo() + BytePos(snip.find("impl")? as u32 + 4)));
1852 if let Some(pos) = pos {
1853 Span::new(pos, pos, item.span.data().ctxt)
1859 let mut ctr_vis = ImplicitHasherConstructorVisitor::new(cx, target);
1860 for item in items.iter().map(|item| cx.tcx.hir.impl_item(item.id)) {
1861 ctr_vis.visit_impl_item(item);
1868 &format!("impl for `{}` should be generalized over different hashers", target.type_name()),
1870 suggestion(cx, db, generics.span, generics_suggestion_span, target, ctr_vis);
1875 ItemKind::Fn(ref decl, .., ref generics, body_id) => {
1876 let body = cx.tcx.hir.body(body_id);
1878 for ty in &decl.inputs {
1879 let mut vis = ImplicitHasherTypeVisitor::new(cx);
1882 for target in &vis.found {
1883 let generics_suggestion_span = generics.span.substitute_dummy({
1884 let pos = snippet_opt(cx, item.span.until(body.arguments[0].pat.span))
1886 let i = snip.find("fn")?;
1887 Some(item.span.lo() + BytePos((i + (&snip[i..]).find('(')?) as u32))
1889 .expect("failed to create span for type parameters");
1890 Span::new(pos, pos, item.span.data().ctxt)
1893 let mut ctr_vis = ImplicitHasherConstructorVisitor::new(cx, target);
1894 ctr_vis.visit_body(body);
1901 "parameter of type `{}` should be generalized over different hashers",
1905 suggestion(cx, db, generics.span, generics_suggestion_span, target, ctr_vis);
1916 enum ImplicitHasherType<'tcx> {
1917 HashMap(Span, Ty<'tcx>, Cow<'static, str>, Cow<'static, str>),
1918 HashSet(Span, Ty<'tcx>, Cow<'static, str>),
1921 impl<'tcx> ImplicitHasherType<'tcx> {
1922 /// Checks that `ty` is a target type without a BuildHasher.
1923 fn new<'a>(cx: &LateContext<'a, 'tcx>, hir_ty: &hir::Ty) -> Option<Self> {
1924 if let TyKind::Path(QPath::Resolved(None, ref path)) = hir_ty.node {
1925 let params: Vec<_> = path.segments.last().as_ref()?.args.as_ref()?
1926 .args.iter().filter_map(|arg| match arg {
1927 GenericArg::Type(ty) => Some(ty),
1928 GenericArg::Lifetime(_) => None,
1930 let params_len = params.len();
1932 let ty = hir_ty_to_ty(cx.tcx, hir_ty);
1934 if match_path(path, &paths::HASHMAP) && params_len == 2 {
1935 Some(ImplicitHasherType::HashMap(
1938 snippet(cx, params[0].span, "K"),
1939 snippet(cx, params[1].span, "V"),
1941 } else if match_path(path, &paths::HASHSET) && params_len == 1 {
1942 Some(ImplicitHasherType::HashSet(hir_ty.span, ty, snippet(cx, params[0].span, "T")))
1951 fn type_name(&self) -> &'static str {
1953 ImplicitHasherType::HashMap(..) => "HashMap",
1954 ImplicitHasherType::HashSet(..) => "HashSet",
1958 fn type_arguments(&self) -> String {
1960 ImplicitHasherType::HashMap(.., ref k, ref v) => format!("{}, {}", k, v),
1961 ImplicitHasherType::HashSet(.., ref t) => format!("{}", t),
1965 fn ty(&self) -> Ty<'tcx> {
1967 ImplicitHasherType::HashMap(_, ty, ..) | ImplicitHasherType::HashSet(_, ty, ..) => ty,
1971 fn span(&self) -> Span {
1973 ImplicitHasherType::HashMap(span, ..) | ImplicitHasherType::HashSet(span, ..) => span,
1978 struct ImplicitHasherTypeVisitor<'a, 'tcx: 'a> {
1979 cx: &'a LateContext<'a, 'tcx>,
1980 found: Vec<ImplicitHasherType<'tcx>>,
1983 impl<'a, 'tcx: 'a> ImplicitHasherTypeVisitor<'a, 'tcx> {
1984 fn new(cx: &'a LateContext<'a, 'tcx>) -> Self {
1985 Self { cx, found: vec![] }
1989 impl<'a, 'tcx: 'a> Visitor<'tcx> for ImplicitHasherTypeVisitor<'a, 'tcx> {
1990 fn visit_ty(&mut self, t: &'tcx hir::Ty) {
1991 if let Some(target) = ImplicitHasherType::new(self.cx, t) {
1992 self.found.push(target);
1998 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1999 NestedVisitorMap::None
2003 /// Looks for default-hasher-dependent constructors like `HashMap::new`.
2004 struct ImplicitHasherConstructorVisitor<'a, 'b, 'tcx: 'a + 'b> {
2005 cx: &'a LateContext<'a, 'tcx>,
2006 body: &'a TypeckTables<'tcx>,
2007 target: &'b ImplicitHasherType<'tcx>,
2008 suggestions: BTreeMap<Span, String>,
2011 impl<'a, 'b, 'tcx: 'a + 'b> ImplicitHasherConstructorVisitor<'a, 'b, 'tcx> {
2012 fn new(cx: &'a LateContext<'a, 'tcx>, target: &'b ImplicitHasherType<'tcx>) -> Self {
2017 suggestions: BTreeMap::new(),
2022 impl<'a, 'b, 'tcx: 'a + 'b> Visitor<'tcx> for ImplicitHasherConstructorVisitor<'a, 'b, 'tcx> {
2023 fn visit_body(&mut self, body: &'tcx Body) {
2024 self.body = self.cx.tcx.body_tables(body.id());
2025 walk_body(self, body);
2028 fn visit_expr(&mut self, e: &'tcx Expr) {
2030 if let ExprKind::Call(ref fun, ref args) = e.node;
2031 if let ExprKind::Path(QPath::TypeRelative(ref ty, ref method)) = fun.node;
2032 if let TyKind::Path(QPath::Resolved(None, ref ty_path)) = ty.node;
2034 if !same_tys(self.cx, self.target.ty(), self.body.expr_ty(e)) {
2038 if match_path(ty_path, &paths::HASHMAP) {
2039 if method.ident.name == "new" {
2041 .insert(e.span, "HashMap::default()".to_string());
2042 } else if method.ident.name == "with_capacity" {
2043 self.suggestions.insert(
2046 "HashMap::with_capacity_and_hasher({}, Default::default())",
2047 snippet(self.cx, args[0].span, "capacity"),
2051 } else if match_path(ty_path, &paths::HASHSET) {
2052 if method.ident.name == "new" {
2054 .insert(e.span, "HashSet::default()".to_string());
2055 } else if method.ident.name == "with_capacity" {
2056 self.suggestions.insert(
2059 "HashSet::with_capacity_and_hasher({}, Default::default())",
2060 snippet(self.cx, args[0].span, "capacity"),
2071 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
2072 NestedVisitorMap::OnlyBodies(&self.cx.tcx.hir)