Add static_mut_ref lint

Author: obeis

Cargo.lock

@@ -4109,6 +4109,7 @@ dependencies = [
  "rustc_feature",
  "rustc_fluent_macro",
  "rustc_hir",
+ "rustc_hir_pretty",
  "rustc_index",
  "rustc_infer",
  "rustc_macros",

compiler/rustc_lint/Cargo.toml

@@ -13,6 +13,7 @@ rustc_errors = { path = "../rustc_errors" }
 rustc_feature = { path = "../rustc_feature" }
 rustc_fluent_macro = { path = "../rustc_fluent_macro" }
 rustc_hir = { path = "../rustc_hir" }
+rustc_hir_pretty = { path = "../rustc_hir_pretty" }
 rustc_index = { path = "../rustc_index" }
 rustc_infer = { path = "../rustc_infer" }
 rustc_macros = { path = "../rustc_macros" }

compiler/rustc_lint/messages.ftl

@@ -496,6 +496,13 @@ lint_requested_level = requested on the command line with `{$level} {$lint_name}
 
 lint_span_use_eq_ctxt = use `.eq_ctxt()` instead of `.ctxt() == .ctxt()`
 
+lint_static_mut_ref = use of mutable static is discouraged
+    .label = use of mutable static
+    .note = use of mutable static is a hard error from 2024 edition
+    .suggestion = use `addr_of_mut!` macro
+
+lint_static_mut_ref_why_note = mutable statics can be written to by multiple threads: aliasing violations or data races will cause undefined behavior
+
 lint_supertrait_as_deref_target = `{$t}` implements `Deref` with supertrait `{$target_principal}` as target
     .label = target type is set here
 

compiler/rustc_lint/src/lib.rs

@@ -83,6 +83,7 @@ mod passes;
 mod ptr_nulls;
 mod redundant_semicolon;
 mod reference_casting;
+mod static_mut_ref;
 mod traits;
 mod types;
 mod unused;
@@ -121,6 +122,7 @@ use pass_by_value::*;
 use ptr_nulls::*;
 use redundant_semicolon::*;
 use reference_casting::*;
+use static_mut_ref::*;
 use traits::*;
 use types::*;
 use unused::*;
@@ -239,6 +241,7 @@ late_lint_methods!(
             MissingDebugImplementations: MissingDebugImplementations,
             MissingDoc: MissingDoc,
             AsyncFnInTrait: AsyncFnInTrait,
+            StaticMutRef: StaticMutRef,
         ]
     ]
 );

compiler/rustc_lint/src/lints.rs

@@ -1845,3 +1845,20 @@ impl<'a> DecorateLint<'a, ()> for AsyncFnInTraitDiag {
         fluent::lint_async_fn_in_trait
     }
 }
+
+// static_mut_ref.rs
+#[derive(LintDiagnostic)]
+#[diag(lint_static_mut_ref)]
+#[note]
+pub struct UseOfStaticMut {
+    #[label]
+    #[suggestion(
+        style = "verbose",
+        code = "addr_of_mut!({var})",
+        applicability = "maybe-incorrect"
+    )]
+    pub span: Span,
+    #[note(lint_static_mut_ref_why_note)]
+    pub why_note: (),
+    pub var: String,
+}

compiler/rustc_lint/src/static_mut_ref.rs

@@ -0,0 +1,95 @@
+use crate::lints::UseOfStaticMut;
+use crate::{LateContext, LateLintPass, LintContext};
+use rustc_ast::BorrowKind;
+use rustc_hir::{
+    def::{DefKind, Res::Def},
+    intravisit::FnKind,
+    Block, BlockCheckMode, Body, ExprKind, FnDecl, QPath, Stmt, StmtKind,
+    UnsafeSource::UserProvided,
+    Unsafety,
+};
+use rustc_hir_pretty::qpath_to_string;
+use rustc_span::{def_id::LocalDefId, Span};
+use rustc_type_ir::Mutability;
+
+declare_lint! {
+    /// The `static_mut_ref` lint checks for use of mutable static
+    /// inside `unsafe` blocks and `unsafe` functions.
+    ///
+    /// ### Example
+    ///
+    /// ```rust,no_run
+    /// fn main() {
+    ///     static mut X: i32 = 23;
+    ///     unsafe {
+    ///         let y = &X;
+    ///     }
+    /// }
+    ///
+    /// unsafe fn foo() {
+    ///     static mut X: i32 = 23;
+    ///     let y = &X;
+    /// }
+    /// ```
+    ///
+    /// {{produces}}
+    ///
+    /// ### Explanation
+    ///
+    /// Use of mutable static is almost always a mistake and can lead to
+    /// undefined behavior and various other problems in your code.
+    ///
+    /// This lint is "warn" by default on editions up to 2021, from 2024 it is
+    /// a hard error.
+    pub STATIC_MUT_REF,
+    Warn,
+    "use of mutable static is discouraged"
+}
+
+declare_lint_pass!(StaticMutRef => [STATIC_MUT_REF]);
+
+impl<'tcx> LateLintPass<'tcx> for StaticMutRef {
+    fn check_block(&mut self, cx: &LateContext<'tcx>, block: &'tcx Block<'tcx>) {
+        if let BlockCheckMode::UnsafeBlock(src) = block.rules
+            && matches!(src, UserProvided)
+        {
+            check_stmts(cx, block.stmts);
+        }
+    }
+
+    fn check_fn(
+        &mut self,
+        cx: &LateContext<'tcx>,
+        fn_kind: FnKind<'tcx>,
+        _: &'tcx FnDecl<'tcx>,
+        body: &'tcx Body<'tcx>,
+        _: Span,
+        _: LocalDefId,
+    ) {
+        if let FnKind::ItemFn(_, _, h) = fn_kind
+            && matches!(h.unsafety, Unsafety::Unsafe)
+            && let ExprKind::Block(block, _) = body.value.kind
+        {
+            check_stmts(cx, block.stmts);
+        }
+    }
+}
+
+fn check_stmts(cx: &LateContext<'_>, stmts: &[Stmt<'_>]) {
+    for stmt in stmts.iter() {
+        if let StmtKind::Local(loc) = stmt.kind
+            && let Some(init) = loc.init
+            && let ExprKind::AddrOf(borrow_kind, _, expr) = init.kind
+            && matches!(borrow_kind, BorrowKind::Ref)
+            && let ExprKind::Path(qpath) = expr.kind
+            && let QPath::Resolved(_, path) = qpath
+            && let Def(def_kind, _) = path.res
+            && let DefKind::Static(mt) = def_kind
+            && matches!(mt, Mutability::Mut)
+        {
+            let span = init.span;
+            let var = qpath_to_string(&qpath);
+            cx.emit_spanned_lint(STATIC_MUT_REF, span, UseOfStaticMut { span, why_note: (), var });
+        }
+    }
+}