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::Def;
   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_tool_lint, lint_array};
  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, 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(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 pub struct NonCopyConst;
 147
 148 impl LintPass for NonCopyConst {
 149     fn get_lints(&self) -> LintArray {
 150         lint_array!(DECLARE_INTERIOR_MUTABLE_CONST, BORROW_INTERIOR_MUTABLE_CONST)
 151     }
 152
 153     fn name(&self) -> &'static str {
 154         "NonCopyConst"
 155     }
 156 }
 157
 158 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for NonCopyConst {
 159     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, it: &'tcx Item) {
 160         if let ItemKind::Const(hir_ty, ..) = &it.node {
 161             let ty = hir_ty_to_ty(cx.tcx, hir_ty);
 162             verify_ty_bound(cx, ty, Source::Item { item: it.span });
 163         }
 164     }
 165
 166     fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, trait_item: &'tcx TraitItem) {
 167         if let TraitItemKind::Const(hir_ty, ..) = &trait_item.node {
 168             let ty = hir_ty_to_ty(cx.tcx, hir_ty);
 169             verify_ty_bound(
 170                 cx,
 171                 ty,
 172                 Source::Assoc {
 173                     ty: hir_ty.span,
 174                     item: trait_item.span,
 175                 },
 176             );
 177         }
 178     }
 179
 180     fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, impl_item: &'tcx ImplItem) {
 181         if let ImplItemKind::Const(hir_ty, ..) = &impl_item.node {
 182             let item_hir_id = cx.tcx.hir().get_parent_node_by_hir_id(impl_item.hir_id);
 183             let item = cx.tcx.hir().expect_item_by_hir_id(item_hir_id);
 184             // Ensure the impl is an inherent impl.
 185             if let ItemKind::Impl(_, _, _, _, None, _, _) = item.node {
 186                 let ty = hir_ty_to_ty(cx.tcx, hir_ty);
 187                 verify_ty_bound(
 188                     cx,
 189                     ty,
 190                     Source::Assoc {
 191                         ty: hir_ty.span,
 192                         item: impl_item.span,
 193                     },
 194                 );
 195             }
 196         }
 197     }
 198
 199     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 200         if let ExprKind::Path(qpath) = &expr.node {
 201             // Only lint if we use the const item inside a function.
 202             if in_constant(cx, expr.hir_id) {
 203                 return;
 204             }
 205
 206             // Make sure it is a const item.
 207             match cx.tables.qpath_def(qpath, expr.hir_id) {
 208                 Def::Const(_) | Def::AssociatedConst(_) => {},
 209                 _ => return,
 210             };
 211
 212             // Climb up to resolve any field access and explicit referencing.
 213             let mut cur_expr = expr;
 214             let mut dereferenced_expr = expr;
 215             let mut needs_check_adjustment = true;
 216             loop {
 217                 let parent_id = cx.tcx.hir().get_parent_node_by_hir_id(cur_expr.hir_id);
 218                 if parent_id == cur_expr.hir_id {
 219                     break;
 220                 }
 221                 if let Some(Node::Expr(parent_expr)) = cx.tcx.hir().find_by_hir_id(parent_id) {
 222                     match &parent_expr.node {
 223                         ExprKind::AddrOf(..) => {
 224                             // `&e` => `e` must be referenced.
 225                             needs_check_adjustment = false;
 226                         },
 227                         ExprKind::Field(..) => {
 228                             dereferenced_expr = parent_expr;
 229                             needs_check_adjustment = true;
 230                         },
 231                         ExprKind::Index(e, _) if ptr::eq(&**e, cur_expr) => {
 232                             // `e[i]` => desugared to `*Index::index(&e, i)`,
 233                             // meaning `e` must be referenced.
 234                             // no need to go further up since a method call is involved now.
 235                             needs_check_adjustment = false;
 236                             break;
 237                         },
 238                         ExprKind::Unary(UnDeref, _) => {
 239                             // `*e` => desugared to `*Deref::deref(&e)`,
 240                             // meaning `e` must be referenced.
 241                             // no need to go further up since a method call is involved now.
 242                             needs_check_adjustment = false;
 243                             break;
 244                         },
 245                         _ => break,
 246                     }
 247                     cur_expr = parent_expr;
 248                 } else {
 249                     break;
 250                 }
 251             }
 252
 253             let ty = if needs_check_adjustment {
 254                 let adjustments = cx.tables.expr_adjustments(dereferenced_expr);
 255                 if let Some(i) = adjustments.iter().position(|adj| match adj.kind {
 256                     Adjust::Borrow(_) | Adjust::Deref(_) => true,
 257                     _ => false,
 258                 }) {
 259                     if i == 0 {
 260                         cx.tables.expr_ty(dereferenced_expr)
 261                     } else {
 262                         adjustments[i - 1].target
 263                     }
 264                 } else {
 265                     // No borrow adjustments means the entire const is moved.
 266                     return;
 267                 }
 268             } else {
 269                 cx.tables.expr_ty(dereferenced_expr)
 270             };
 271
 272             verify_ty_bound(cx, ty, Source::Expr { expr: expr.span });
 273         }
 274     }
 275 }