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