clippy_lints/src/non_copy_const.rs

   1 //! Checks for uses of const which the type is not `Freeze` (`Cell`-free).
   2 //!
   3 //! This lint is **deny** by default.
   4
   5 use std::ptr;
   6
   7 use rustc::hir::def::{DefKind, Res};
   8 use rustc::hir::*;
   9 use rustc::lint::{LateContext, LateLintPass, Lint, LintArray, LintPass};
  10 use rustc::ty::adjustment::Adjust;
  11 use rustc::ty::{Ty, TypeFlags};
  12 use rustc::{declare_lint_pass, declare_tool_lint};
  13 use rustc_errors::Applicability;
  14 use rustc_typeck::hir_ty_to_ty;
  15 use syntax_pos::{Span, DUMMY_SP};
  16
  17 use crate::utils::{in_constant, in_macro_or_desugar, is_copy, span_lint_and_then};
  18
  19 declare_clippy_lint! {
  20     /// **What it does:** Checks for declaration of `const` items which is interior
  21     /// mutable (e.g., contains a `Cell`, `Mutex`, `AtomicXxxx`, etc.).
  22     ///
  23     /// **Why is this bad?** Consts are copied everywhere they are referenced, i.e.,
  24     /// every time you refer to the const a fresh instance of the `Cell` or `Mutex`
  25     /// or `AtomicXxxx` will be created, which defeats the whole purpose of using
  26     /// these types in the first place.
  27     ///
  28     /// The `const` should better be replaced by a `static` item if a global
  29     /// variable is wanted, or replaced by a `const fn` if a constructor is wanted.
  30     ///
  31     /// **Known problems:** A "non-constant" const item is a legacy way to supply an
  32     /// initialized value to downstream `static` items (e.g., the
  33     /// `std::sync::ONCE_INIT` constant). In this case the use of `const` is legit,
  34     /// and this lint should be suppressed.
  35     ///
  36     /// **Example:**
  37     /// ```rust
  38     /// use std::sync::atomic::{AtomicUsize, Ordering::SeqCst};
  39     ///
  40     /// // Bad.
  41     /// const CONST_ATOM: AtomicUsize = AtomicUsize::new(12);
  42     /// CONST_ATOM.store(6, SeqCst); // the content of the atomic is unchanged
  43     /// assert_eq!(CONST_ATOM.load(SeqCst), 12); // because the CONST_ATOM in these lines are distinct
  44     ///
  45     /// // Good.
  46     /// static STATIC_ATOM: AtomicUsize = AtomicUsize::new(15);
  47     /// STATIC_ATOM.store(9, SeqCst);
  48     /// assert_eq!(STATIC_ATOM.load(SeqCst), 9); // use a `static` item to refer to the same instance
  49     /// ```
  50     pub DECLARE_INTERIOR_MUTABLE_CONST,
  51     correctness,
  52     "declaring const with interior mutability"
  53 }
  54
  55 declare_clippy_lint! {
  56     /// **What it does:** Checks if `const` items which is interior mutable (e.g.,
  57     /// contains a `Cell`, `Mutex`, `AtomicXxxx`, etc.) has been borrowed directly.
  58     ///
  59     /// **Why is this bad?** Consts are copied everywhere they are referenced, i.e.,
  60     /// every time you refer to the const a fresh instance of the `Cell` or `Mutex`
  61     /// or `AtomicXxxx` will be created, which defeats the whole purpose of using
  62     /// these types in the first place.
  63     ///
  64     /// The `const` value should be stored inside a `static` item.
  65     ///
  66     /// **Known problems:** None
  67     ///
  68     /// **Example:**
  69     /// ```rust
  70     /// use std::sync::atomic::{AtomicUsize, Ordering::SeqCst};
  71     /// const CONST_ATOM: AtomicUsize = AtomicUsize::new(12);
  72     ///
  73     /// // Bad.
  74     /// CONST_ATOM.store(6, SeqCst); // the content of the atomic is unchanged
  75     /// assert_eq!(CONST_ATOM.load(SeqCst), 12); // because the CONST_ATOM in these lines are distinct
  76     ///
  77     /// // Good.
  78     /// static STATIC_ATOM: AtomicUsize = CONST_ATOM;
  79     /// STATIC_ATOM.store(9, SeqCst);
  80     /// assert_eq!(STATIC_ATOM.load(SeqCst), 9); // use a `static` item to refer to the same instance
  81     /// ```
  82     pub BORROW_INTERIOR_MUTABLE_CONST,
  83     correctness,
  84     "referencing const with interior mutability"
  85 }
  86
  87 #[derive(Copy, Clone)]
  88 enum Source {
  89     Item { item: Span },
  90     Assoc { item: Span, ty: Span },
  91     Expr { expr: Span },
  92 }
  93
  94 impl Source {
  95     fn lint(&self) -> (&'static Lint, &'static str, Span) {
  96         match self {
  97             Source::Item { item } | Source::Assoc { item, .. } => (
  98                 DECLARE_INTERIOR_MUTABLE_CONST,
  99                 "a const item should never be interior mutable",
 100                 *item,
 101             ),
 102             Source::Expr { expr } => (
 103                 BORROW_INTERIOR_MUTABLE_CONST,
 104                 "a const item with interior mutability should not be borrowed",
 105                 *expr,
 106             ),
 107         }
 108     }
 109 }
 110
 111 fn verify_ty_bound<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>, source: Source) {
 112     if ty.is_freeze(cx.tcx, cx.param_env, DUMMY_SP) || is_copy(cx, ty) {
 113         // An `UnsafeCell` is `!Copy`, and an `UnsafeCell` is also the only type which
 114         // is `!Freeze`, thus if our type is `Copy` we can be sure it must be `Freeze`
 115         // as well.
 116         return;
 117     }
 118
 119     let (lint, msg, span) = source.lint();
 120     span_lint_and_then(cx, lint, span, msg, |db| {
 121         if in_macro_or_desugar(span) {
 122             return; // Don't give suggestions into macros.
 123         }
 124         match source {
 125             Source::Item { .. } => {
 126                 let const_kw_span = span.from_inner_byte_pos(0, 5);
 127                 db.span_suggestion(
 128                     const_kw_span,
 129                     "make this a static item",
 130                     "static".to_string(),
 131                     Applicability::MachineApplicable,
 132                 );
 133             },
 134             Source::Assoc { ty: ty_span, .. } => {
 135                 if ty.flags.contains(TypeFlags::HAS_FREE_LOCAL_NAMES) {
 136                     db.span_help(ty_span, &format!("consider requiring `{}` to be `Copy`", ty));
 137                 }
 138             },
 139             Source::Expr { .. } => {
 140                 db.help("assign this const to a local or static variable, and use the variable here");
 141             },
 142         }
 143     });
 144 }
 145
 146 declare_lint_pass!(NonCopyConst => [DECLARE_INTERIOR_MUTABLE_CONST, BORROW_INTERIOR_MUTABLE_CONST]);
 147
 148 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for NonCopyConst {
 149     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, it: &'tcx Item) {
 150         if let ItemKind::Const(hir_ty, ..) = &it.node {
 151             let ty = hir_ty_to_ty(cx.tcx, hir_ty);
 152             verify_ty_bound(cx, ty, Source::Item { item: it.span });
 153         }
 154     }
 155
 156     fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, trait_item: &'tcx TraitItem) {
 157         if let TraitItemKind::Const(hir_ty, ..) = &trait_item.node {
 158             let ty = hir_ty_to_ty(cx.tcx, hir_ty);
 159             verify_ty_bound(
 160                 cx,
 161                 ty,
 162                 Source::Assoc {
 163                     ty: hir_ty.span,
 164                     item: trait_item.span,
 165                 },
 166             );
 167         }
 168     }
 169
 170     fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, impl_item: &'tcx ImplItem) {
 171         if let ImplItemKind::Const(hir_ty, ..) = &impl_item.node {
 172             let item_hir_id = cx.tcx.hir().get_parent_node_by_hir_id(impl_item.hir_id);
 173             let item = cx.tcx.hir().expect_item_by_hir_id(item_hir_id);
 174             // Ensure the impl is an inherent impl.
 175             if let ItemKind::Impl(_, _, _, _, None, _, _) = item.node {
 176                 let ty = hir_ty_to_ty(cx.tcx, hir_ty);
 177                 verify_ty_bound(
 178                     cx,
 179                     ty,
 180                     Source::Assoc {
 181                         ty: hir_ty.span,
 182                         item: impl_item.span,
 183                     },
 184                 );
 185             }
 186         }
 187     }
 188
 189     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 190         if let ExprKind::Path(qpath) = &expr.node {
 191             // Only lint if we use the const item inside a function.
 192             if in_constant(cx, expr.hir_id) {
 193                 return;
 194             }
 195
 196             // Make sure it is a const item.
 197             match cx.tables.qpath_res(qpath, expr.hir_id) {
 198                 Res::Def(DefKind::Const, _) | Res::Def(DefKind::AssocConst, _) => {},
 199                 _ => return,
 200             };
 201
 202             // Climb up to resolve any field access and explicit referencing.
 203             let mut cur_expr = expr;
 204             let mut dereferenced_expr = expr;
 205             let mut needs_check_adjustment = true;
 206             loop {
 207                 let parent_id = cx.tcx.hir().get_parent_node_by_hir_id(cur_expr.hir_id);
 208                 if parent_id == cur_expr.hir_id {
 209                     break;
 210                 }
 211                 if let Some(Node::Expr(parent_expr)) = cx.tcx.hir().find_by_hir_id(parent_id) {
 212                     match &parent_expr.node {
 213                         ExprKind::AddrOf(..) => {
 214                             // `&e` => `e` must be referenced.
 215                             needs_check_adjustment = false;
 216                         },
 217                         ExprKind::Field(..) => {
 218                             dereferenced_expr = parent_expr;
 219                             needs_check_adjustment = true;
 220                         },
 221                         ExprKind::Index(e, _) if ptr::eq(&**e, cur_expr) => {
 222                             // `e[i]` => desugared to `*Index::index(&e, i)`,
 223                             // meaning `e` must be referenced.
 224                             // no need to go further up since a method call is involved now.
 225                             needs_check_adjustment = false;
 226                             break;
 227                         },
 228                         ExprKind::Unary(UnDeref, _) => {
 229                             // `*e` => desugared to `*Deref::deref(&e)`,
 230                             // meaning `e` must be referenced.
 231                             // no need to go further up since a method call is involved now.
 232                             needs_check_adjustment = false;
 233                             break;
 234                         },
 235                         _ => break,
 236                     }
 237                     cur_expr = parent_expr;
 238                 } else {
 239                     break;
 240                 }
 241             }
 242
 243             let ty = if needs_check_adjustment {
 244                 let adjustments = cx.tables.expr_adjustments(dereferenced_expr);
 245                 if let Some(i) = adjustments.iter().position(|adj| match adj.kind {
 246                     Adjust::Borrow(_) | Adjust::Deref(_) => true,
 247                     _ => false,
 248                 }) {
 249                     if i == 0 {
 250                         cx.tables.expr_ty(dereferenced_expr)
 251                     } else {
 252                         adjustments[i - 1].target
 253                     }
 254                 } else {
 255                     // No borrow adjustments means the entire const is moved.
 256                     return;
 257                 }
 258             } else {
 259                 cx.tables.expr_ty(dereferenced_expr)
 260             };
 261
 262             verify_ty_bound(cx, ty, Source::Expr { expr: expr.span });
 263         }
 264     }
 265 }