Add a new lint for unconstructible pub structs

mu001999 · mu001999 · commit 9af22296986d · 2024-07-30T21:20:36.000+08:00
diff --git a/compiler/rustc_lint/src/lib.rs b/compiler/rustc_lint/src/lib.rs
@@ -281,6 +281,7 @@ fn register_builtins(store: &mut LintStore) {
         UNUSED_VARIABLES,
         UNUSED_ASSIGNMENTS,
         DEAD_CODE,
+        UNCONSTRUCTIBLE_PUB_STRUCT,
         UNUSED_MUT,
         UNREACHABLE_CODE,
         UNREACHABLE_PATTERNS,
diff --git a/compiler/rustc_lint_defs/src/builtin.rs b/compiler/rustc_lint_defs/src/builtin.rs
@@ -106,6 +106,7 @@ declare_lint_pass! {
         TYVAR_BEHIND_RAW_POINTER,
         UNCONDITIONAL_PANIC,
         UNCONDITIONAL_RECURSION,
+        UNCONSTRUCTIBLE_PUB_STRUCT,
         UNCOVERED_PARAM_IN_PROJECTION,
         UNDEFINED_NAKED_FUNCTION_ABI,
         UNEXPECTED_CFGS,
@@ -725,6 +726,35 @@ declare_lint! {
     "detect unused, unexported items"
 }
 
+declare_lint! {
+    /// The `unconstructible_pub_struct` lint detects public structs that
+    /// are unused locally and cannot be constructed externally.
+    ///
+    /// ### Example
+    ///
+    /// ```rust
+    /// pub struct Foo(i32);
+    /// ```
+    ///
+    /// {{produces}}
+    ///
+    /// ### Explanation
+    ///
+    /// Unconstructible pub structs may signal a mistake or unfinished code.
+    /// To silence the warning for individual items, prefix the name with an
+    /// underscore such as `_Foo`.
+    ///
+    /// To preserve this lint, add a field with units or never types which
+    /// indicates that the behaivor is intentional, or use `PhantomData` as
+    /// fields' type if the struct is only used at the type level to check
+    /// things like well-formedness.
+    ///
+    /// Otherwise, consider removing it if the struct is no longer in use.
+    pub UNCONSTRUCTIBLE_PUB_STRUCT,
+    Warn,
+    "detects pub structs that are unused locally and cannot be constructed externally"
+}
+
 declare_lint! {
     /// The `unused_attributes` lint detects attributes that were not used by
     /// the compiler.
diff --git a/compiler/rustc_passes/src/dead.rs b/compiler/rustc_passes/src/dead.rs
@@ -20,7 +20,7 @@ use rustc_middle::query::Providers;
 use rustc_middle::ty::{self, AssocItemContainer, TyCtxt};
 use rustc_middle::{bug, span_bug};
 use rustc_session::lint;
-use rustc_session::lint::builtin::DEAD_CODE;
+use rustc_session::lint::builtin::{DEAD_CODE, UNCONSTRUCTIBLE_PUB_STRUCT};
 use rustc_span::symbol::{sym, Symbol};
 use rustc_target::abi::FieldIdx;
 
@@ -739,6 +739,12 @@ impl<'tcx> Visitor<'tcx> for MarkSymbolVisitor<'tcx> {
     }
 }
 
+fn has_allow_unconstructible_pub_struct(tcx: TyCtxt<'_>, def_id: LocalDefId) -> bool {
+    let hir_id = tcx.local_def_id_to_hir_id(def_id);
+    let lint_level = tcx.lint_level_at_node(lint::builtin::UNCONSTRUCTIBLE_PUB_STRUCT, hir_id).0;
+    matches!(lint_level, lint::Allow | lint::Expect(_))
+}
+
 fn has_allow_dead_code_or_lang_attr(
     tcx: TyCtxt<'_>,
     def_id: LocalDefId,
@@ -930,7 +936,7 @@ fn create_and_seed_worklist(
                     match tcx.def_kind(id) {
                         DefKind::Impl { .. } => false,
                         DefKind::AssocConst | DefKind::AssocTy | DefKind::AssocFn => !matches!(tcx.associated_item(id).container, AssocItemContainer::ImplContainer),
-                        DefKind::Struct => struct_all_fields_are_public(tcx, id) || has_allow_dead_code_or_lang_attr(tcx, id).is_some(),
+                        DefKind::Struct => has_allow_unconstructible_pub_struct(tcx, id) || struct_all_fields_are_public(tcx, id),
                         _ => true
                     })
                 .map(|id| (id, ComesFromAllowExpect::No))
@@ -1177,8 +1183,16 @@ impl<'tcx> DeadVisitor<'tcx> {
             },
         };
 
+        let lint = if tcx.visibility(first_item.def_id).is_public()
+            && matches!(tcx.def_kind(first_item.def_id), DefKind::Struct)
+        {
+            UNCONSTRUCTIBLE_PUB_STRUCT
+        } else {
+            DEAD_CODE
+        };
+
         let hir_id = tcx.local_def_id_to_hir_id(first_item.def_id);
-        self.tcx.emit_node_span_lint(DEAD_CODE, hir_id, MultiSpan::from_spans(spans), diag);
+        self.tcx.emit_node_span_lint(lint, hir_id, MultiSpan::from_spans(spans), diag);
     }
 
     fn warn_multiple(
diff --git a/tests/ui/const-generics/defaults/repr-c-issue-82792.rs b/tests/ui/const-generics/defaults/repr-c-issue-82792.rs
@@ -2,7 +2,7 @@
 
 //@ run-pass
 
-#[allow(dead_code)]
+#[allow(unconstructible_pub_struct)]
 #[repr(C)]
 pub struct Loaf<T: Sized, const N: usize = 1> {
     head: [T; N],
diff --git a/tests/ui/const-generics/generic_const_exprs/associated-consts.rs b/tests/ui/const-generics/generic_const_exprs/associated-consts.rs
@@ -16,7 +16,7 @@ impl BlockCipher for BarCipher {
     const BLOCK_SIZE: usize = 32;
 }
 
-#[allow(dead_code)]
+#[allow(unconstructible_pub_struct)]
 pub struct Block<C>(C);
 
 pub fn test<C: BlockCipher, const M: usize>()
diff --git a/tests/ui/const-generics/transparent-maybeunit-array-wrapper.rs b/tests/ui/const-generics/transparent-maybeunit-array-wrapper.rs
@@ -6,7 +6,7 @@
 
 use std::mem::MaybeUninit;
 
-#[allow(dead_code)]
+#[allow(unconstructible_pub_struct)]
 #[repr(transparent)]
 pub struct MaybeUninitWrapper<const N: usize>(MaybeUninit<[u64; N]>);
 
diff --git a/tests/ui/issues/issue-5708.rs b/tests/ui/issues/issue-5708.rs
@@ -44,7 +44,7 @@ pub trait MyTrait<T> {
     fn dummy(&self, t: T) -> T { panic!() }
 }
 
-#[allow(dead_code)]
+#[allow(unconstructible_pub_struct)]
 pub struct MyContainer<'a, T:'a> {
     foos: Vec<&'a (dyn MyTrait<T>+'a)> ,
 }
diff --git a/tests/ui/lint/dead-code/lint-dead-code-1.rs b/tests/ui/lint/dead-code/lint-dead-code-1.rs
@@ -3,6 +3,7 @@
 #![allow(non_camel_case_types)]
 #![allow(non_upper_case_globals)]
 #![deny(dead_code)]
+#![deny(unconstructible_pub_struct)]
 
 #![crate_type="lib"]
 
diff --git a/tests/ui/lint/dead-code/lint-dead-code-1.stderr b/tests/ui/lint/dead-code/lint-dead-code-1.stderr
@@ -1,5 +1,5 @@
 error: static `priv_static` is never used
-  --> $DIR/lint-dead-code-1.rs:20:8
+  --> $DIR/lint-dead-code-1.rs:21:8
    |
 LL | static priv_static: isize = 0;
    |        ^^^^^^^^^^^
@@ -11,37 +11,43 @@ LL | #![deny(dead_code)]
    |         ^^^^^^^^^
 
 error: constant `priv_const` is never used
-  --> $DIR/lint-dead-code-1.rs:27:7
+  --> $DIR/lint-dead-code-1.rs:28:7
    |
 LL | const priv_const: isize = 0;
    |       ^^^^^^^^^^
 
 error: struct `PrivStruct` is never constructed
-  --> $DIR/lint-dead-code-1.rs:35:8
+  --> $DIR/lint-dead-code-1.rs:36:8
    |
 LL | struct PrivStruct;
    |        ^^^^^^^^^^
 
 error: struct `StructUsedAsField` is never constructed
-  --> $DIR/lint-dead-code-1.rs:49:8
+  --> $DIR/lint-dead-code-1.rs:50:8
    |
 LL | struct StructUsedAsField;
    |        ^^^^^^^^^^^^^^^^^
 
 error: struct `PubStruct2` is never constructed
-  --> $DIR/lint-dead-code-1.rs:52:12
+  --> $DIR/lint-dead-code-1.rs:53:12
    |
 LL | pub struct PubStruct2 {
    |            ^^^^^^^^^^
+   |
+note: the lint level is defined here
+  --> $DIR/lint-dead-code-1.rs:6:9
+   |
+LL | #![deny(unconstructible_pub_struct)]
+   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 error: enum `priv_enum` is never used
-  --> $DIR/lint-dead-code-1.rs:63:6
+  --> $DIR/lint-dead-code-1.rs:64:6
    |
 LL | enum priv_enum { foo2, bar2 }
    |      ^^^^^^^^^
 
 error: variant `bar3` is never constructed
-  --> $DIR/lint-dead-code-1.rs:66:5
+  --> $DIR/lint-dead-code-1.rs:67:5
    |
 LL | enum used_enum {
    |      --------- variant in this enum
@@ -50,31 +56,31 @@ LL |     bar3
    |     ^^^^
 
 error: function `priv_fn` is never used
-  --> $DIR/lint-dead-code-1.rs:87:4
+  --> $DIR/lint-dead-code-1.rs:88:4
    |
 LL | fn priv_fn() {
    |    ^^^^^^^
 
 error: function `foo` is never used
-  --> $DIR/lint-dead-code-1.rs:92:4
+  --> $DIR/lint-dead-code-1.rs:93:4
    |
 LL | fn foo() {
    |    ^^^
 
 error: function `bar` is never used
-  --> $DIR/lint-dead-code-1.rs:97:4
+  --> $DIR/lint-dead-code-1.rs:98:4
    |
 LL | fn bar() {
    |    ^^^
 
 error: function `baz` is never used
-  --> $DIR/lint-dead-code-1.rs:101:4
+  --> $DIR/lint-dead-code-1.rs:102:4
    |
 LL | fn baz() -> impl Copy {
    |    ^^^
 
 error: struct `Bar` is never constructed
-  --> $DIR/lint-dead-code-1.rs:12:16
+  --> $DIR/lint-dead-code-1.rs:13:16
    |
 LL |     pub struct Bar;
    |                ^^^
diff --git a/tests/ui/lint/dead-code/unconstructible-pub-struct.rs b/tests/ui/lint/dead-code/unconstructible-pub-struct.rs
@@ -1,5 +1,5 @@
 #![feature(never_type)]
-#![deny(dead_code)]
+#![deny(unconstructible_pub_struct)]
 
 pub struct T1(!);
 pub struct T2(());
@@ -32,4 +32,6 @@ pub struct T9<X> { //~ ERROR struct `T9` is never constructed
     _y: i32,
 }
 
+pub struct _T10(i32);
+
 fn main() {}
diff --git a/tests/ui/lint/dead-code/unconstructible-pub-struct.stderr b/tests/ui/lint/dead-code/unconstructible-pub-struct.stderr
@@ -7,8 +7,8 @@ LL | pub struct T9<X> {
 note: the lint level is defined here
   --> $DIR/unconstructible-pub-struct.rs:2:9
    |
-LL | #![deny(dead_code)]
-   |         ^^^^^^^^^
+LL | #![deny(unconstructible_pub_struct)]
+   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 error: aborting due to 1 previous error
 
diff --git a/tests/ui/lint/dead-code/unused-adt-impl-pub-trait-with-assoc-const.rs b/tests/ui/lint/dead-code/unused-adt-impl-pub-trait-with-assoc-const.rs
@@ -1,4 +1,4 @@
-#![deny(dead_code)]
+#![deny(unused)]
 
 struct T1; //~ ERROR struct `T1` is never constructed
 struct T2; //~ ERROR struct `T2` is never constructed
diff --git a/tests/ui/lint/dead-code/unused-adt-impl-pub-trait-with-assoc-const.stderr b/tests/ui/lint/dead-code/unused-adt-impl-pub-trait-with-assoc-const.stderr
@@ -7,8 +7,9 @@ LL | struct T1;
 note: the lint level is defined here
   --> $DIR/unused-adt-impl-pub-trait-with-assoc-const.rs:1:9
    |
-LL | #![deny(dead_code)]
-   |         ^^^^^^^^^
+LL | #![deny(unused)]
+   |         ^^^^^^
+   = note: `#[deny(dead_code)]` implied by `#[deny(unused)]`
 
 error: struct `T2` is never constructed
   --> $DIR/unused-adt-impl-pub-trait-with-assoc-const.rs:4:8
@@ -21,6 +22,8 @@ error: struct `T3` is never constructed
    |
 LL | pub struct T3(i32);
    |            ^^
+   |
+   = note: `#[deny(unconstructible_pub_struct)]` implied by `#[deny(unused)]`
 
 error: field `0` is never read
   --> $DIR/unused-adt-impl-pub-trait-with-assoc-const.rs:6:15
diff --git a/tests/ui/lint/dead-code/unused-pub-struct.rs b/tests/ui/lint/dead-code/unused-pub-struct.rs
@@ -1,4 +1,4 @@
-#![deny(dead_code)]
+#![deny(unused)]
 
 pub struct NotLint1(());
 pub struct NotLint2(std::marker::PhantomData<i32>);
diff --git a/tests/ui/lint/dead-code/unused-pub-struct.stderr b/tests/ui/lint/dead-code/unused-pub-struct.stderr
@@ -7,8 +7,9 @@ LL | pub struct NeverConstructed(i32);
 note: the lint level is defined here
   --> $DIR/unused-pub-struct.rs:1:9
    |
-LL | #![deny(dead_code)]
-   |         ^^^^^^^^^
+LL | #![deny(unused)]
+   |         ^^^^^^
+   = note: `#[deny(unconstructible_pub_struct)]` implied by `#[deny(unused)]`
 
 error: aborting due to 1 previous error
 
diff --git a/tests/ui/macros/macro-pub-matcher.rs b/tests/ui/macros/macro-pub-matcher.rs
@@ -1,5 +1,5 @@
 //@ run-pass
-#![allow(dead_code, unused_imports, unused_macro_rules)]
+#![allow(dead_code, unused_imports, unused_macro_rules, unconstructible_pub_struct)]
 
 /**
 Ensure that `:vis` matches can be captured in existing positions, and passed
diff --git a/tests/ui/modules/auxiliary/dummy_lib.rs b/tests/ui/modules/auxiliary/dummy_lib.rs
@@ -1,2 +1,2 @@
-#[allow(dead_code)]
+#[allow(unconstructible_pub_struct)]
 pub struct Dummy;
diff --git a/tests/ui/parser/recover/recover-where-clause-before-tuple-struct-body-0.fixed b/tests/ui/parser/recover/recover-where-clause-before-tuple-struct-body-0.fixed
@@ -1,7 +1,8 @@
 // Regression test for issues #100790 and #106439.
 //@ run-rustfix
 
-#[allow(dead_code)]
+#![allow(unused)]
+
 pub struct Example(usize)
 where
     (): Sized;
diff --git a/tests/ui/parser/recover/recover-where-clause-before-tuple-struct-body-0.rs b/tests/ui/parser/recover/recover-where-clause-before-tuple-struct-body-0.rs
@@ -1,7 +1,8 @@
 // Regression test for issues #100790 and #106439.
 //@ run-rustfix
 
-#[allow(dead_code)]
+#![allow(unused)]
+
 pub struct Example
 where
     (): Sized,
diff --git a/tests/ui/parser/recover/recover-where-clause-before-tuple-struct-body-0.stderr b/tests/ui/parser/recover/recover-where-clause-before-tuple-struct-body-0.stderr
@@ -1,5 +1,5 @@
 error: where clauses are not allowed before tuple struct bodies
-  --> $DIR/recover-where-clause-before-tuple-struct-body-0.rs:6:1
+  --> $DIR/recover-where-clause-before-tuple-struct-body-0.rs:7:1
    |
 LL |   pub struct Example
    |              ------- while parsing this tuple struct
@@ -17,7 +17,7 @@ LL ~     (): Sized;
    |
 
 error: where clauses are not allowed before tuple struct bodies
-  --> $DIR/recover-where-clause-before-tuple-struct-body-0.rs:12:1
+  --> $DIR/recover-where-clause-before-tuple-struct-body-0.rs:13:1
    |
 LL |   struct _Demo
    |          ----- while parsing this tuple struct
diff --git a/tests/ui/pub/pub-ident-struct-4.fixed b/tests/ui/pub/pub-ident-struct-4.fixed
@@ -1,6 +1,6 @@
 //@ run-rustfix
 
-#[allow(dead_code)]
+#[allow(unused)]
 pub struct T(String);
 //~^ ERROR missing `struct` for struct definition
 
diff --git a/tests/ui/pub/pub-ident-struct-4.rs b/tests/ui/pub/pub-ident-struct-4.rs
@@ -1,6 +1,6 @@
 //@ run-rustfix
 
-#[allow(dead_code)]
+#[allow(unused)]
 pub T(String);
 //~^ ERROR missing `struct` for struct definition
 
diff --git a/tests/ui/regions/regions-issue-21422.rs b/tests/ui/regions/regions-issue-21422.rs
@@ -5,7 +5,7 @@
 
 //@ pretty-expanded FIXME #23616
 
-#[allow(dead_code)]
+#[allow(unconstructible_pub_struct)]
 pub struct P<'a> {
     _ptr: *const &'a u8,
 }
diff --git a/tests/ui/structs-enums/newtype-struct-with-dtor.rs b/tests/ui/structs-enums/newtype-struct-with-dtor.rs
@@ -1,12 +1,11 @@
 //@ run-pass
 #![allow(unused_unsafe)]
 #![allow(unused_variables)]
+#![allow(unconstructible_pub_struct)]
 //@ pretty-expanded FIXME #23616
 
-#[allow(dead_code)]
 pub struct Fd(u32);
 
-#[allow(dead_code)]
 fn foo(a: u32) {}
 
 impl Drop for Fd {
diff --git a/tests/ui/suggestions/option-content-move.fixed b/tests/ui/suggestions/option-content-move.fixed
diff --git a/tests/ui/suggestions/option-content-move.rs b/tests/ui/suggestions/option-content-move.rs
diff --git a/tests/ui/suggestions/option-content-move.stderr b/tests/ui/suggestions/option-content-move.stderr
diff --git a/tests/ui/traits/object/generics.rs b/tests/ui/traits/object/generics.rs

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ impl BlockCipher for BarCipher {`
`16`	`16`	`const BLOCK_SIZE: usize = 32;`
`17`	`17`	`}`
`18`	`18`
`19`		`-#[allow(dead_code)]`
	`19`	`+#[allow(unconstructible_pub_struct)]`
`20`	`20`	`pub struct Block<C>(C);`
`21`	`21`
`22`	`22`	`pub fn test<C: BlockCipher, const M: usize>()`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ pub trait MyTrait<T> {`
`44`	`44`	`fn dummy(&self, t: T) -> T { panic!() }`
`45`	`45`	`}`
`46`	`46`
`47`		`-#[allow(dead_code)]`
	`47`	`+#[allow(unconstructible_pub_struct)]`
`48`	`48`	`pub struct MyContainer<'a, T:'a> {`
`49`	`49`	`foos: Vec<&'a (dyn MyTrait<T>+'a)> ,`
`50`	`50`	`}`