clippy_lints/src/mut_key.rs

   1 use crate::utils::{match_def_path, paths, span_lint, trait_ref_of_method};
   2 use rustc_hir as hir;
   3 use rustc_lint::{LateContext, LateLintPass};
   4 use rustc_middle::ty::{Adt, Array, RawPtr, Ref, Slice, Tuple, Ty, TypeAndMut};
   5 use rustc_session::{declare_lint_pass, declare_tool_lint};
   6 use rustc_span::source_map::Span;
   7
   8 declare_clippy_lint! {
   9     /// **What it does:** Checks for sets/maps with mutable key types.
  10     ///
  11     /// **Why is this bad?** All of `HashMap`, `HashSet`, `BTreeMap` and
  12     /// `BtreeSet` rely on either the hash or the order of keys be unchanging,
  13     /// so having types with interior mutability is a bad idea.
  14     ///
  15     /// **Known problems:** It's correct to use a struct, that contains interior mutability
  16     /// as a key, when its `Hash` implementation doesn't access any of the interior mutable types.
  17     /// However, this lint is unable to recognize this, so it causes a false positive in theses cases.
  18     /// The `bytes` crate is a great example of this.
  19     ///
  20     /// **Example:**
  21     /// ```rust
  22     /// use std::cmp::{PartialEq, Eq};
  23     /// use std::collections::HashSet;
  24     /// use std::hash::{Hash, Hasher};
  25     /// use std::sync::atomic::AtomicUsize;
  26     ///# #[allow(unused)]
  27     ///
  28     /// struct Bad(AtomicUsize);
  29     /// impl PartialEq for Bad {
  30     ///     fn eq(&self, rhs: &Self) -> bool {
  31     ///          ..
  32     /// ; unimplemented!();
  33     ///     }
  34     /// }
  35     ///
  36     /// impl Eq for Bad {}
  37     ///
  38     /// impl Hash for Bad {
  39     ///     fn hash<H: Hasher>(&self, h: &mut H) {
  40     ///         ..
  41     /// ; unimplemented!();
  42     ///     }
  43     /// }
  44     ///
  45     /// fn main() {
  46     ///     let _: HashSet<Bad> = HashSet::new();
  47     /// }
  48     /// ```
  49     pub MUTABLE_KEY_TYPE,
  50     correctness,
  51     "Check for mutable `Map`/`Set` key type"
  52 }
  53
  54 declare_lint_pass!(MutableKeyType => [ MUTABLE_KEY_TYPE ]);
  55
  56 impl<'tcx> LateLintPass<'tcx> for MutableKeyType {
  57     fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx hir::Item<'tcx>) {
  58         if let hir::ItemKind::Fn(ref sig, ..) = item.kind {
  59             check_sig(cx, item.hir_id, &sig.decl);
  60         }
  61     }
  62
  63     fn check_impl_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx hir::ImplItem<'tcx>) {
  64         if let hir::ImplItemKind::Fn(ref sig, ..) = item.kind {
  65             if trait_ref_of_method(cx, item.hir_id).is_none() {
  66                 check_sig(cx, item.hir_id, &sig.decl);
  67             }
  68         }
  69     }
  70
  71     fn check_trait_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx hir::TraitItem<'tcx>) {
  72         if let hir::TraitItemKind::Fn(ref sig, ..) = item.kind {
  73             check_sig(cx, item.hir_id, &sig.decl);
  74         }
  75     }
  76
  77     fn check_local(&mut self, cx: &LateContext<'_>, local: &hir::Local<'_>) {
  78         if let hir::PatKind::Wild = local.pat.kind {
  79             return;
  80         }
  81         check_ty(cx, local.span, cx.typeck_results().pat_ty(&*local.pat));
  82     }
  83 }
  84
  85 fn check_sig<'tcx>(cx: &LateContext<'tcx>, item_hir_id: hir::HirId, decl: &hir::FnDecl<'_>) {
  86     let fn_def_id = cx.tcx.hir().local_def_id(item_hir_id);
  87     let fn_sig = cx.tcx.fn_sig(fn_def_id);
  88     for (hir_ty, ty) in decl.inputs.iter().zip(fn_sig.inputs().skip_binder().iter()) {
  89         check_ty(cx, hir_ty.span, ty);
  90     }
  91     check_ty(
  92         cx,
  93         decl.output.span(),
  94         cx.tcx.erase_late_bound_regions(&fn_sig.output()),
  95     );
  96 }
  97
  98 // We want to lint 1. sets or maps with 2. not immutable key types and 3. no unerased
  99 // generics (because the compiler cannot ensure immutability for unknown types).
 100 fn check_ty<'tcx>(cx: &LateContext<'tcx>, span: Span, ty: Ty<'tcx>) {
 101     let ty = ty.peel_refs();
 102     if let Adt(def, substs) = ty.kind() {
 103         if [&paths::HASHMAP, &paths::BTREEMAP, &paths::HASHSET, &paths::BTREESET]
 104             .iter()
 105             .any(|path| match_def_path(cx, def.did, &**path))
 106             && is_mutable_type(cx, substs.type_at(0), span)
 107         {
 108             span_lint(cx, MUTABLE_KEY_TYPE, span, "mutable key type");
 109         }
 110     }
 111 }
 112
 113 fn is_mutable_type<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>, span: Span) -> bool {
 114     match *ty.kind() {
 115         RawPtr(TypeAndMut { ty: inner_ty, mutbl }) | Ref(_, inner_ty, mutbl) => {
 116             mutbl == hir::Mutability::Mut || is_mutable_type(cx, inner_ty, span)
 117         },
 118         Slice(inner_ty) => is_mutable_type(cx, inner_ty, span),
 119         Array(inner_ty, size) => {
 120             size.try_eval_usize(cx.tcx, cx.param_env).map_or(true, |u| u != 0) && is_mutable_type(cx, inner_ty, span)
 121         },
 122         Tuple(..) => ty.tuple_fields().any(|ty| is_mutable_type(cx, ty, span)),
 123         Adt(..) => cx.tcx.layout_of(cx.param_env.and(ty)).is_ok() && !ty.is_freeze(cx.tcx.at(span), cx.param_env),
 124         _ => false,
 125     }
 126 }