Add interior_mutable_consts lint

Author: Urgau

compiler/rustc_lint/messages.ftl

@@ -420,6 +420,14 @@ lint_incomplete_include =
 
 lint_inner_macro_attribute_unstable = inner macro attributes are unstable
 
+lint_interior_mutable_consts = interior mutability in `const` item have no effect to the `const` item it-self
+    .label = `{$ty_name}` is an interior mutable type
+    .temporary = each usage of a `const` item creates a new temporary
+    .never_original = only the temporaries and never the original `const` item `{$const_name}` will be modified
+    .suggestion_inline_const = for use as an initializer, consider using an inline-const `const {"{"} /* ... */ {"}"}` at the usage site instead
+    .suggestion_static = for a shared instance of `{$const_name}`, consider using a `static` item instead
+    .suggestion_allow = alternatively consider allowing the lint
+
 lint_invalid_asm_label_binary = avoid using labels containing only the digits `0` and `1` in inline assembly
     .label = use a different label that doesn't start with `0` or `1`
     .help = start numbering with `2` instead

compiler/rustc_lint/src/lints.rs

@@ -1806,6 +1806,55 @@ pub(crate) enum AmbiguousWidePointerComparisonsAddrSuggestion<'a> {
     },
 }
 
+#[derive(LintDiagnostic)]
+#[diag(lint_interior_mutable_consts)]
+#[note(lint_temporary)]
+#[note(lint_never_original)]
+#[help(lint_suggestion_inline_const)]
+pub(crate) struct InteriorMutableConstsDiag {
+    pub ty_name: Ident,
+    pub const_name: Ident,
+    #[label]
+    pub ty_span: Span,
+    #[subdiagnostic]
+    pub sugg_static: InteriorMutableConstsSuggestionStatic,
+    #[subdiagnostic]
+    pub sugg_allow: InteriorMutableConstsSuggestionAllow,
+}
+
+#[derive(Subdiagnostic)]
+pub(crate) enum InteriorMutableConstsSuggestionStatic {
+    #[suggestion(
+        lint_suggestion_static,
+        code = "{before}static ",
+        style = "verbose",
+        applicability = "maybe-incorrect"
+    )]
+    Spanful {
+        #[primary_span]
+        const_: Span,
+        before: &'static str,
+    },
+    #[help(lint_suggestion_static)]
+    Spanless,
+}
+
+#[derive(Subdiagnostic)]
+pub(crate) enum InteriorMutableConstsSuggestionAllow {
+    #[suggestion(
+        lint_suggestion_allow,
+        code = "#[allow(interior_mutable_consts)] ",
+        style = "verbose",
+        applicability = "maybe-incorrect"
+    )]
+    Spanful {
+        #[primary_span]
+        span: Span,
+    },
+    #[help(lint_suggestion_allow)]
+    Spanless,
+}
+
 pub(crate) struct ImproperCTypes<'a> {
     pub ty: Ty<'a>,
     pub desc: &'a str,

compiler/rustc_lint/src/types.rs

@@ -23,8 +23,10 @@ mod improper_ctypes;
 use crate::lints::{
     AmbiguousWidePointerComparisons, AmbiguousWidePointerComparisonsAddrMetadataSuggestion,
     AmbiguousWidePointerComparisonsAddrSuggestion, AtomicOrderingFence, AtomicOrderingLoad,
-    AtomicOrderingStore, ImproperCTypes, InvalidAtomicOrderingDiag, InvalidNanComparisons,
-    InvalidNanComparisonsSuggestion, UnusedComparisons, VariantSizeDifferencesDiag,
+    AtomicOrderingStore, ImproperCTypes, InteriorMutableConstsDiag,
+    InteriorMutableConstsSuggestionAllow, InteriorMutableConstsSuggestionStatic,
+    InvalidAtomicOrderingDiag, InvalidNanComparisons, InvalidNanComparisonsSuggestion,
+    UnusedComparisons, VariantSizeDifferencesDiag,
 };
 use crate::{LateContext, LateLintPass, LintContext, fluent_generated as fluent};
 
@@ -167,6 +169,37 @@ declare_lint! {
     "detects ambiguous wide pointer comparisons"
 }
 
+declare_lint! {
+    /// The `interior_mutable_consts` lint detects instance where
+    /// const-items have a interior mutable type, which silently does nothing.
+    ///
+    /// ### Example
+    ///
+    /// ```
+    /// use std::sync::Once;
+    ///
+    /// const A: Once = Once::new(); // using `B` will always duplicate `B` and never
+    ///                              // modify it-self as it's a const-item and not a
+    ///                              // static-item
+    /// ```
+    ///
+    /// {{produces}}
+    ///
+    /// ### Explanation
+    ///
+    /// Using a const-item with an interior mutable type has no effect as const-item
+    /// are essentially inlined wherever they are used, meaning that they are copied
+    /// directly into the relevant context when used rendering modification through
+    /// interior mutability ineffective across usage of that const-item.
+    ///
+    /// The current implementation of this lint only warns on significant `std` and
+    /// `core` interior mutable types, like `Once`, `AtomicI32`, ... this is done out
+    /// of prudence and may be extended in the future.
+    INTERIOR_MUTABLE_CONSTS,
+    Warn,
+    "detects const items with interior mutable type",
+}
+
 #[derive(Copy, Clone)]
 pub(crate) struct TypeLimits {
     /// Id of the last visited negated expression
@@ -179,7 +212,8 @@ impl_lint_pass!(TypeLimits => [
     UNUSED_COMPARISONS,
     OVERFLOWING_LITERALS,
     INVALID_NAN_COMPARISONS,
-    AMBIGUOUS_WIDE_POINTER_COMPARISONS
+    AMBIGUOUS_WIDE_POINTER_COMPARISONS,
+    INTERIOR_MUTABLE_CONSTS,
 ]);
 
 impl TypeLimits {
@@ -513,6 +547,44 @@ impl<'tcx> LateLintPass<'tcx> for TypeLimits {
             })
         }
     }
+
+    fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx hir::Item<'tcx>) {
+        if let hir::ItemKind::Const(ty, _generics, _body_id) = item.kind
+            && let hir::TyKind::Path(ref qpath) = ty.kind
+            && let Some(def_id) = cx.qpath_res(qpath, ty.hir_id).opt_def_id()
+            && cx.tcx.has_attr(def_id, sym::rustc_significant_interior_mutable_type)
+            && let Some(ty_name) = cx.tcx.opt_item_ident(def_id)
+        {
+            let (sugg_static, sugg_allow) = if let Some(vis_span) =
+                item.vis_span.find_ancestor_inside(item.span)
+                && item.span.can_be_used_for_suggestions()
+                && vis_span.can_be_used_for_suggestions()
+            {
+                (
+                    InteriorMutableConstsSuggestionStatic::Spanful {
+                        const_: item.vis_span.between(item.ident.span),
+                        before: if !vis_span.is_empty() { " " } else { "" },
+                    },
+                    InteriorMutableConstsSuggestionAllow::Spanful {
+                        span: item.span.shrink_to_lo(),
+                    },
+                )
+            } else {
+                (
+                    InteriorMutableConstsSuggestionStatic::Spanless,
+                    InteriorMutableConstsSuggestionAllow::Spanless,
+                )
+            };
+
+            cx.emit_span_lint(INTERIOR_MUTABLE_CONSTS, item.span, InteriorMutableConstsDiag {
+                ty_name,
+                ty_span: ty.span,
+                const_name: item.ident,
+                sugg_static,
+                sugg_allow,
+            });
+        }
+    }
 }
 
 declare_lint! {

tests/ui/lint/interior-mutable-types-in-consts-not-sync.rs

@@ -0,0 +1,16 @@
+//@ check-pass
+
+use std::cell::{Cell, RefCell, UnsafeCell, LazyCell, OnceCell};
+
+const A: Cell<i32> = Cell::new(0);
+//~^ WARN interior mutability in `const` item
+const B: RefCell<i32> = RefCell::new(0);
+//~^ WARN interior mutability in `const` item
+const C: UnsafeCell<i32> = UnsafeCell::new(0);
+//~^ WARN interior mutability in `const` item
+const D: LazyCell<i32> = LazyCell::new(|| 0);
+//~^ WARN interior mutability in `const` item
+const E: OnceCell<i32> = OnceCell::new();
+//~^ WARN interior mutability in `const` item
+
+fn main() {}

tests/ui/lint/interior-mutable-types-in-consts-not-sync.stderr

@@ -0,0 +1,103 @@
+warning: interior mutability in `const` item have no effect to the `const` item it-self
+  --> $DIR/interior-mutable-types-in-consts-not-sync.rs:5:1
+   |
+LL | const A: Cell<i32> = Cell::new(0);
+   | ^^^^^^^^^---------^^^^^^^^^^^^^^^^
+   |          |
+   |          `Cell` is an interior mutable type
+   |
+   = note: each usage of a `const` item creates a new temporary
+   = note: only the temporaries and never the original `const` item `A` will be modified
+   = help: for use as an initializer, consider using an inline-const `const { /* ... */ }` at the usage site instead
+   = note: `#[warn(interior_mutable_consts)]` on by default
+help: for a shared instance of `A`, consider using a `static` item instead
+   |
+LL | static A: Cell<i32> = Cell::new(0);
+   | ~~~~~~
+help: alternatively consider allowing the lint
+   |
+LL | #[allow(interior_mutable_consts)] const A: Cell<i32> = Cell::new(0);
+   | +++++++++++++++++++++++++++++++++
+
+warning: interior mutability in `const` item have no effect to the `const` item it-self
+  --> $DIR/interior-mutable-types-in-consts-not-sync.rs:7:1
+   |
+LL | const B: RefCell<i32> = RefCell::new(0);
+   | ^^^^^^^^^------------^^^^^^^^^^^^^^^^^^^
+   |          |
+   |          `RefCell` is an interior mutable type
+   |
+   = note: each usage of a `const` item creates a new temporary
+   = note: only the temporaries and never the original `const` item `B` will be modified
+   = help: for use as an initializer, consider using an inline-const `const { /* ... */ }` at the usage site instead
+help: for a shared instance of `B`, consider using a `static` item instead
+   |
+LL | static B: RefCell<i32> = RefCell::new(0);
+   | ~~~~~~
+help: alternatively consider allowing the lint
+   |
+LL | #[allow(interior_mutable_consts)] const B: RefCell<i32> = RefCell::new(0);
+   | +++++++++++++++++++++++++++++++++
+
+warning: interior mutability in `const` item have no effect to the `const` item it-self
+  --> $DIR/interior-mutable-types-in-consts-not-sync.rs:9:1
+   |
+LL | const C: UnsafeCell<i32> = UnsafeCell::new(0);
+   | ^^^^^^^^^---------------^^^^^^^^^^^^^^^^^^^^^^
+   |          |
+   |          `UnsafeCell` is an interior mutable type
+   |
+   = note: each usage of a `const` item creates a new temporary
+   = note: only the temporaries and never the original `const` item `C` will be modified
+   = help: for use as an initializer, consider using an inline-const `const { /* ... */ }` at the usage site instead
+help: for a shared instance of `C`, consider using a `static` item instead
+   |
+LL | static C: UnsafeCell<i32> = UnsafeCell::new(0);
+   | ~~~~~~
+help: alternatively consider allowing the lint
+   |
+LL | #[allow(interior_mutable_consts)] const C: UnsafeCell<i32> = UnsafeCell::new(0);
+   | +++++++++++++++++++++++++++++++++
+
+warning: interior mutability in `const` item have no effect to the `const` item it-self
+  --> $DIR/interior-mutable-types-in-consts-not-sync.rs:11:1
+   |
+LL | const D: LazyCell<i32> = LazyCell::new(|| 0);
+   | ^^^^^^^^^-------------^^^^^^^^^^^^^^^^^^^^^^^
+   |          |
+   |          `LazyCell` is an interior mutable type
+   |
+   = note: each usage of a `const` item creates a new temporary
+   = note: only the temporaries and never the original `const` item `D` will be modified
+   = help: for use as an initializer, consider using an inline-const `const { /* ... */ }` at the usage site instead
+help: for a shared instance of `D`, consider using a `static` item instead
+   |
+LL | static D: LazyCell<i32> = LazyCell::new(|| 0);
+   | ~~~~~~
+help: alternatively consider allowing the lint
+   |
+LL | #[allow(interior_mutable_consts)] const D: LazyCell<i32> = LazyCell::new(|| 0);
+   | +++++++++++++++++++++++++++++++++
+
+warning: interior mutability in `const` item have no effect to the `const` item it-self
+  --> $DIR/interior-mutable-types-in-consts-not-sync.rs:13:1
+   |
+LL | const E: OnceCell<i32> = OnceCell::new();
+   | ^^^^^^^^^-------------^^^^^^^^^^^^^^^^^^^
+   |          |
+   |          `OnceCell` is an interior mutable type
+   |
+   = note: each usage of a `const` item creates a new temporary
+   = note: only the temporaries and never the original `const` item `E` will be modified
+   = help: for use as an initializer, consider using an inline-const `const { /* ... */ }` at the usage site instead
+help: for a shared instance of `E`, consider using a `static` item instead
+   |
+LL | static E: OnceCell<i32> = OnceCell::new();
+   | ~~~~~~
+help: alternatively consider allowing the lint
+   |
+LL | #[allow(interior_mutable_consts)] const E: OnceCell<i32> = OnceCell::new();
+   | +++++++++++++++++++++++++++++++++
+
+warning: 5 warnings emitted
+

tests/ui/lint/interior-mutable-types-in-consts.fixed

@@ -0,0 +1,46 @@
+//@ check-pass
+//@ run-rustfix
+
+#![allow(dead_code)] // for rustfix
+#![feature(reentrant_lock)]
+
+use std::sync::{Once, Barrier, Condvar, LazyLock, Mutex, OnceLock, ReentrantLock, RwLock};
+use std::sync::atomic::{AtomicBool, AtomicPtr, AtomicI32, AtomicU32};
+
+#[allow(interior_mutable_consts)] static A: Once = Once::new();
+//~^ WARN interior mutability in `const` item
+#[allow(interior_mutable_consts)] static B: Barrier = Barrier::new(0);
+//~^ WARN interior mutability in `const` item
+#[allow(interior_mutable_consts)] static C: Condvar = Condvar::new();
+//~^ WARN interior mutability in `const` item
+#[allow(interior_mutable_consts)] static D: LazyLock<i32> = LazyLock::new(|| 0);
+//~^ WARN interior mutability in `const` item
+#[allow(interior_mutable_consts)] static E: Mutex<i32> = Mutex::new(0);
+//~^ WARN interior mutability in `const` item
+#[allow(interior_mutable_consts)] static F: OnceLock<i32> = OnceLock::new();
+//~^ WARN interior mutability in `const` item
+#[allow(interior_mutable_consts)] static G: ReentrantLock<i32> = ReentrantLock::new(0);
+//~^ WARN interior mutability in `const` item
+#[allow(interior_mutable_consts)] static H: RwLock<i32> = RwLock::new(0);
+//~^ WARN interior mutability in `const` item
+#[allow(interior_mutable_consts)] static I: AtomicBool = AtomicBool::new(false);
+//~^ WARN interior mutability in `const` item
+#[allow(interior_mutable_consts)] static J: AtomicPtr<i32> = AtomicPtr::new(std::ptr::null_mut());
+//~^ WARN interior mutability in `const` item
+#[allow(interior_mutable_consts)] static K: AtomicI32 = AtomicI32::new(0);
+//~^ WARN interior mutability in `const` item
+#[allow(interior_mutable_consts)] static L: AtomicU32 = AtomicU32::new(0);
+//~^ WARN interior mutability in `const` item
+
+#[allow(interior_mutable_consts)] pub(crate) static X: Once = Once::new();
+//~^ WARN interior mutability in `const` item
+
+fn main() {
+    #[allow(interior_mutable_consts)] static Z: Once = Once::new();
+    //~^ WARN interior mutability in `const` item
+}
+
+struct S;
+impl S {
+    const Z: Once = Once::new(); // not a const-item
+}

tests/ui/lint/interior-mutable-types-in-consts.rs

@@ -0,0 +1,46 @@
+//@ check-pass
+//@ run-rustfix
+
+#![allow(dead_code)] // for rustfix
+#![feature(reentrant_lock)]
+
+use std::sync::{Once, Barrier, Condvar, LazyLock, Mutex, OnceLock, ReentrantLock, RwLock};
+use std::sync::atomic::{AtomicBool, AtomicPtr, AtomicI32, AtomicU32};
+
+const A: Once = Once::new();
+//~^ WARN interior mutability in `const` item
+const B: Barrier = Barrier::new(0);
+//~^ WARN interior mutability in `const` item
+const C: Condvar = Condvar::new();
+//~^ WARN interior mutability in `const` item
+const D: LazyLock<i32> = LazyLock::new(|| 0);
+//~^ WARN interior mutability in `const` item
+const E: Mutex<i32> = Mutex::new(0);
+//~^ WARN interior mutability in `const` item
+const F: OnceLock<i32> = OnceLock::new();
+//~^ WARN interior mutability in `const` item
+const G: ReentrantLock<i32> = ReentrantLock::new(0);
+//~^ WARN interior mutability in `const` item
+const H: RwLock<i32> = RwLock::new(0);
+//~^ WARN interior mutability in `const` item
+const I: AtomicBool = AtomicBool::new(false);
+//~^ WARN interior mutability in `const` item
+const J: AtomicPtr<i32> = AtomicPtr::new(std::ptr::null_mut());
+//~^ WARN interior mutability in `const` item
+const K: AtomicI32 = AtomicI32::new(0);
+//~^ WARN interior mutability in `const` item
+const L: AtomicU32 = AtomicU32::new(0);
+//~^ WARN interior mutability in `const` item
+
+pub(crate) const X: Once = Once::new();
+//~^ WARN interior mutability in `const` item
+
+fn main() {
+    const Z: Once = Once::new();
+    //~^ WARN interior mutability in `const` item
+}
+
+struct S;
+impl S {
+    const Z: Once = Once::new(); // not a const-item
+}