Skip to content

Commit 453a1a8

Browse files
matthiaskrgrmatthiaskrgr
authored
Rollup merge of #133545 - clubby789:symbol-intern-lit, r=jieyouxu
Lint against Symbol::intern on a string literal Disabled in tests where this doesn't make much sense
2 parents c179a15 + 71b698c commit 453a1a8

File tree

20 files changed

+94
-37
lines changed

20 files changed

+94
-37
lines changed

Diff for: ‎compiler/rustc_ast_passes/src/feature_gate.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ use rustc_ast::{NodeId, PatKind, attr, token};
44
use rustc_feature::{AttributeGate, BUILTIN_ATTRIBUTE_MAP, BuiltinAttribute, Features, GateIssue};
55
use rustc_session::Session;
66
use rustc_session::parse::{feature_err, feature_err_issue, feature_warn};
7+
use rustc_span::Span;
78
use rustc_span::source_map::Spanned;
8-
use rustc_span::symbol::sym;
9-
use rustc_span::{Span, Symbol};
9+
use rustc_span::symbol::{Symbol, sym};
1010
use rustc_target::spec::abi;
1111
use thin_vec::ThinVec;
1212

@@ -695,6 +695,7 @@ fn check_new_solver_banned_features(sess: &Session, features: &Features) {
695695
.find(|feat| feat.gate_name == sym::generic_const_exprs)
696696
.map(|feat| feat.attr_sp)
697697
{
698+
#[cfg_attr(not(bootstrap), allow(rustc::symbol_intern_string_literal))]
698699
sess.dcx().emit_err(errors::IncompatibleFeatures {
699700
spans: vec![gce_span],
700701
f1: Symbol::intern("-Znext-solver=globally"),

Diff for: ‎compiler/rustc_borrowck/src/universal_regions.rs

+4-6
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ use rustc_middle::ty::{
3333
TyCtxt, TypeVisitableExt,
3434
};
3535
use rustc_middle::{bug, span_bug};
36+
use rustc_span::ErrorGuaranteed;
3637
use rustc_span::symbol::{kw, sym};
37-
use rustc_span::{ErrorGuaranteed, Symbol};
3838
use tracing::{debug, instrument};
3939

4040
use crate::BorrowckInferCtxt;
@@ -524,7 +524,7 @@ impl<'cx, 'tcx> UniversalRegionsBuilder<'cx, 'tcx> {
524524

525525
let reg_vid = self
526526
.infcx
527-
.next_nll_region_var(FR, || RegionCtxt::Free(Symbol::intern("c-variadic")))
527+
.next_nll_region_var(FR, || RegionCtxt::Free(sym::c_dash_variadic))
528528
.as_var();
529529

530530
let region = ty::Region::new_var(self.infcx.tcx, reg_vid);
@@ -540,10 +540,8 @@ impl<'cx, 'tcx> UniversalRegionsBuilder<'cx, 'tcx> {
540540
}
541541
}
542542

543-
let fr_fn_body = self
544-
.infcx
545-
.next_nll_region_var(FR, || RegionCtxt::Free(Symbol::intern("fn_body")))
546-
.as_var();
543+
let fr_fn_body =
544+
self.infcx.next_nll_region_var(FR, || RegionCtxt::Free(sym::fn_body)).as_var();
547545

548546
let num_universals = self.infcx.num_region_vars();
549547

Diff for: ‎compiler/rustc_codegen_cranelift/src/driver/jit.rs

+2-7
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ fn create_jit_module(
7474
jit_builder.symbol("__clif_jit_fn", clif_jit_fn as *const u8);
7575
let mut jit_module = UnwindModule::new(JITModule::new(jit_builder), false);
7676

77-
let cx = crate::CodegenCx::new(tcx, jit_module.isa(), false, Symbol::intern("dummy_cgu_name"));
77+
let cx = crate::CodegenCx::new(tcx, jit_module.isa(), false, sym::dummy_cgu_name);
7878

7979
crate::allocator::codegen(tcx, &mut jit_module);
8080

@@ -276,12 +276,7 @@ fn jit_fn(instance_ptr: *const Instance<'static>, trampoline_ptr: *const u8) ->
276276

277277
jit_module.module.prepare_for_function_redefine(func_id).unwrap();
278278

279-
let mut cx = crate::CodegenCx::new(
280-
tcx,
281-
jit_module.isa(),
282-
false,
283-
Symbol::intern("dummy_cgu_name"),
284-
);
279+
let mut cx = crate::CodegenCx::new(tcx, jit_module.isa(), false, sym::dummy_cgu_name);
285280
codegen_and_compile_fn(tcx, &mut cx, &mut Context::new(), jit_module, instance);
286281

287282
assert!(cx.global_asm.is_empty());

Diff for: ‎compiler/rustc_codegen_cranelift/src/lib.rs

+2-7
Original file line numberDiff line numberDiff line change
@@ -189,18 +189,13 @@ impl CodegenBackend for CraneliftCodegenBackend {
189189
// FIXME return the actually used target features. this is necessary for #[cfg(target_feature)]
190190
if sess.target.arch == "x86_64" && sess.target.os != "none" {
191191
// x86_64 mandates SSE2 support
192-
vec![Symbol::intern("fxsr"), sym::sse, Symbol::intern("sse2")]
192+
vec![sym::fsxr, sym::sse, sym::sse2]
193193
} else if sess.target.arch == "aarch64" {
194194
match &*sess.target.os {
195195
"none" => vec![],
196196
// On macOS the aes, sha2 and sha3 features are enabled by default and ring
197197
// fails to compile on macOS when they are not present.
198-
"macos" => vec![
199-
sym::neon,
200-
Symbol::intern("aes"),
201-
Symbol::intern("sha2"),
202-
Symbol::intern("sha3"),
203-
],
198+
"macos" => vec![sym::neon, sym::aes, sym::sha2, sym::sha3],
204199
// AArch64 mandates Neon support
205200
_ => vec![sym::neon],
206201
}

Diff for: ‎compiler/rustc_hir_analysis/src/collect/generics_of.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@ pub(super) fn generics_of(tcx: TyCtxt<'_>, def_id: LocalDefId) -> ty::Generics {
419419
if let Node::ConstBlock(_) = node {
420420
own_params.push(ty::GenericParamDef {
421421
index: next_index(),
422-
name: Symbol::intern("<const_ty>"),
422+
name: rustc_span::sym::const_ty_placeholder,
423423
def_id: def_id.to_def_id(),
424424
pure_wrt_drop: false,
425425
kind: ty::GenericParamDefKind::Type { has_default: false, synthetic: false },

Diff for: ‎compiler/rustc_hir_typeck/src/method/suggest.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -664,7 +664,7 @@ impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
664664
let is_write = sugg_span.ctxt().outer_expn_data().macro_def_id.is_some_and(|def_id| {
665665
tcx.is_diagnostic_item(sym::write_macro, def_id)
666666
|| tcx.is_diagnostic_item(sym::writeln_macro, def_id)
667-
}) && item_name.name == Symbol::intern("write_fmt");
667+
}) && item_name.name == sym::write_fmt;
668668
let mut err = if is_write && let SelfSource::MethodCall(rcvr_expr) = source {
669669
self.suggest_missing_writer(rcvr_ty, rcvr_expr)
670670
} else {

Diff for: ‎compiler/rustc_lint/messages.ftl

+3
Original file line numberDiff line numberDiff line change
@@ -775,6 +775,9 @@ lint_suspicious_double_ref_clone =
775775
lint_suspicious_double_ref_deref =
776776
using `.deref()` on a double reference, which returns `{$ty}` instead of dereferencing the inner type
777777
778+
lint_symbol_intern_string_literal = using `Symbol::intern` on a string literal
779+
.help = consider adding the symbol to `compiler/rustc_span/src/symbol.rs`
780+
778781
lint_trailing_semi_macro = trailing semicolon in macro used in expression position
779782
.note1 = macro invocations at the end of a block are treated as expressions
780783
.note2 = to ignore the value produced by the macro, add a semicolon after the invocation of `{$name}`

Diff for: ‎compiler/rustc_lint/src/internal.rs

+33-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ use tracing::debug;
1717

1818
use crate::lints::{
1919
BadOptAccessDiag, DefaultHashTypesDiag, DiagOutOfImpl, LintPassByHand, NonExistentDocKeyword,
20-
NonGlobImportTypeIrInherent, QueryInstability, QueryUntracked, SpanUseEqCtxtDiag, TyQualified,
21-
TykindDiag, TykindKind, TypeIrInherentUsage, UntranslatableDiag,
20+
NonGlobImportTypeIrInherent, QueryInstability, QueryUntracked, SpanUseEqCtxtDiag,
21+
SymbolInternStringLiteralDiag, TyQualified, TykindDiag, TykindKind, TypeIrInherentUsage,
22+
UntranslatableDiag,
2223
};
2324
use crate::{EarlyContext, EarlyLintPass, LateContext, LateLintPass, LintContext};
2425

@@ -650,3 +651,33 @@ fn is_span_ctxt_call(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
650651
_ => false,
651652
}
652653
}
654+
655+
declare_tool_lint! {
656+
/// The `symbol_intern_string_literal` detects `Symbol::intern` being called on a string literal
657+
pub rustc::SYMBOL_INTERN_STRING_LITERAL,
658+
// rustc_driver crates out of the compiler can't/shouldn't add preinterned symbols;
659+
// bootstrap will deny this manually
660+
Allow,
661+
"Forbid uses of string literals in `Symbol::intern`, suggesting preinterning instead",
662+
report_in_external_macro: true
663+
}
664+
665+
declare_lint_pass!(SymbolInternStringLiteral => [SYMBOL_INTERN_STRING_LITERAL]);
666+
667+
impl<'tcx> LateLintPass<'tcx> for SymbolInternStringLiteral {
668+
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx rustc_hir::Expr<'tcx>) {
669+
if let ExprKind::Call(path, [arg]) = expr.kind
670+
&& let ExprKind::Path(ref qpath) = path.kind
671+
&& let Some(def_id) = cx.qpath_res(qpath, path.hir_id).opt_def_id()
672+
&& cx.tcx.is_diagnostic_item(sym::SymbolIntern, def_id)
673+
&& let ExprKind::Lit(kind) = arg.kind
674+
&& let rustc_ast::LitKind::Str(_, _) = kind.node
675+
{
676+
cx.emit_span_lint(
677+
SYMBOL_INTERN_STRING_LITERAL,
678+
kind.span,
679+
SymbolInternStringLiteralDiag,
680+
);
681+
}
682+
}
683+
}

Diff for: ‎compiler/rustc_lint/src/lib.rs

+2
Original file line numberDiff line numberDiff line change
@@ -614,6 +614,8 @@ fn register_internals(store: &mut LintStore) {
614614
store.register_late_mod_pass(|_| Box::new(PassByValue));
615615
store.register_lints(&SpanUseEqCtxt::lint_vec());
616616
store.register_late_mod_pass(|_| Box::new(SpanUseEqCtxt));
617+
store.register_lints(&SymbolInternStringLiteral::lint_vec());
618+
store.register_late_mod_pass(|_| Box::new(SymbolInternStringLiteral));
617619
// FIXME(davidtwco): deliberately do not include `UNTRANSLATABLE_DIAGNOSTIC` and
618620
// `DIAGNOSTIC_OUTSIDE_OF_IMPL` here because `-Wrustc::internal` is provided to every crate and
619621
// these lints will trigger all of the time - change this once migration to diagnostic structs

Diff for: ‎compiler/rustc_lint/src/lints.rs

+5
Original file line numberDiff line numberDiff line change
@@ -907,6 +907,11 @@ pub(crate) struct QueryUntracked {
907907
#[diag(lint_span_use_eq_ctxt)]
908908
pub(crate) struct SpanUseEqCtxtDiag;
909909

910+
#[derive(LintDiagnostic)]
911+
#[diag(lint_symbol_intern_string_literal)]
912+
#[help]
913+
pub(crate) struct SymbolInternStringLiteralDiag;
914+
910915
#[derive(LintDiagnostic)]
911916
#[diag(lint_tykind_kind)]
912917
pub(crate) struct TykindKind {

Diff for: ‎compiler/rustc_lint/src/unused.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1563,7 +1563,7 @@ impl UnusedImportBraces {
15631563
}
15641564
rename.unwrap_or(orig_ident).name
15651565
}
1566-
ast::UseTreeKind::Glob => Symbol::intern("*"),
1566+
ast::UseTreeKind::Glob => sym::asterisk,
15671567
ast::UseTreeKind::Nested { .. } => return,
15681568
};
15691569

Diff for: ‎compiler/rustc_metadata/src/creader.rs

+5-4
Original file line numberDiff line numberDiff line change
@@ -861,8 +861,10 @@ impl<'a, 'tcx> CrateLoader<'a, 'tcx> {
861861
// First up we check for global allocators. Look at the crate graph here
862862
// and see what's a global allocator, including if we ourselves are a
863863
// global allocator.
864-
let mut global_allocator =
865-
self.cstore.has_global_allocator.then(|| Symbol::intern("this crate"));
864+
#[cfg_attr(not(bootstrap), allow(rustc::symbol_intern_string_literal))]
865+
let this_crate = Symbol::intern("this crate");
866+
867+
let mut global_allocator = self.cstore.has_global_allocator.then_some(this_crate);
866868
for (_, data) in self.cstore.iter_crate_data() {
867869
if data.has_global_allocator() {
868870
match global_allocator {
@@ -876,8 +878,7 @@ impl<'a, 'tcx> CrateLoader<'a, 'tcx> {
876878
}
877879
}
878880
}
879-
let mut alloc_error_handler =
880-
self.cstore.has_alloc_error_handler.then(|| Symbol::intern("this crate"));
881+
let mut alloc_error_handler = self.cstore.has_alloc_error_handler.then_some(this_crate);
881882
for (_, data) in self.cstore.iter_crate_data() {
882883
if data.has_alloc_error_handler() {
883884
match alloc_error_handler {

Diff for: ‎compiler/rustc_metadata/src/rmeta/decoder.rs

+1
Original file line numberDiff line numberDiff line change
@@ -872,6 +872,7 @@ impl MetadataBlob {
872872

873873
let def_kind = root.tables.def_kind.get(blob, item).unwrap();
874874
let def_key = root.tables.def_keys.get(blob, item).unwrap().decode(blob);
875+
#[cfg_attr(not(bootstrap), allow(rustc::symbol_intern_string_literal))]
875876
let def_name = if item == CRATE_DEF_INDEX {
876877
rustc_span::symbol::kw::Crate
877878
} else {

Diff for: ‎compiler/rustc_parse/src/parser/ty.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use rustc_ast::{
99
};
1010
use rustc_errors::{Applicability, PResult};
1111
use rustc_span::symbol::{Ident, kw, sym};
12-
use rustc_span::{ErrorGuaranteed, Span, Symbol};
12+
use rustc_span::{ErrorGuaranteed, Span};
1313
use thin_vec::{ThinVec, thin_vec};
1414

1515
use super::{Parser, PathStyle, SeqSep, TokenType, Trailing};
@@ -1136,7 +1136,7 @@ impl<'a> Parser<'a> {
11361136
Some(ast::Path {
11371137
span: fn_token_span.to(self.prev_token.span),
11381138
segments: thin_vec![ast::PathSegment {
1139-
ident: Ident::new(Symbol::intern("Fn"), fn_token_span),
1139+
ident: Ident::new(sym::Fn, fn_token_span),
11401140
id: DUMMY_NODE_ID,
11411141
args: Some(P(ast::GenericArgs::Parenthesized(ast::ParenthesizedArgs {
11421142
span: args_lo.to(self.prev_token.span),

Diff for: ‎compiler/rustc_resolve/src/late/diagnostics.rs

+1
Original file line numberDiff line numberDiff line change
@@ -3113,6 +3113,7 @@ impl<'ast, 'ra: 'ast, 'tcx> LateResolutionVisitor<'_, 'ast, 'ra, 'tcx> {
31133113
}
31143114
}
31153115

3116+
#[cfg_attr(not(bootstrap), allow(rustc::symbol_intern_string_literal))]
31163117
let existing_name = match &in_scope_lifetimes[..] {
31173118
[] => Symbol::intern("'a"),
31183119
[(existing, _)] => existing.name,

Diff for: ‎compiler/rustc_resolve/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2257,7 +2257,7 @@ fn module_to_string(module: Module<'_>) -> Option<String> {
22572257
collect_mod(names, parent);
22582258
}
22592259
} else {
2260-
names.push(Symbol::intern("<opaque>"));
2260+
names.push(sym::opaque_module_name_placeholder);
22612261
collect_mod(names, module.parent.unwrap());
22622262
}
22632263
}

Diff for: ‎compiler/rustc_session/src/output.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ pub fn find_crate_name(sess: &Session, attrs: &[ast::Attribute]) -> Symbol {
8787
}
8888
}
8989

90-
Symbol::intern("rust_out")
90+
sym::rust_out
9191
}
9292

9393
pub fn validate_crate_name(sess: &Session, s: Symbol, sp: Option<Span>) {

Diff for: ‎compiler/rustc_span/src/symbol.rs

+16
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,7 @@ symbols! {
298298
Return,
299299
Right,
300300
Rust,
301+
RustaceansAreAwesome,
301302
RustcDecodable,
302303
RustcEncodable,
303304
RwLock,
@@ -316,6 +317,7 @@ symbols! {
316317
StructuralPartialEq,
317318
SubdiagMessage,
318319
Subdiagnostic,
320+
SymbolIntern,
319321
Sync,
320322
SyncUnsafeCell,
321323
T,
@@ -377,6 +379,7 @@ symbols! {
377379
adt_const_params,
378380
advanced_slice_patterns,
379381
adx_target_feature,
382+
aes,
380383
aggregate_raw_ptr,
381384
alias,
382385
align,
@@ -440,6 +443,7 @@ symbols! {
440443
associated_types,
441444
assume,
442445
assume_init,
446+
asterisk: "*",
443447
async_await,
444448
async_call,
445449
async_call_mut,
@@ -521,6 +525,7 @@ symbols! {
521525
btreeset_iter,
522526
builtin_syntax,
523527
c,
528+
c_dash_variadic,
524529
c_str,
525530
c_str_literals,
526531
c_unwind,
@@ -651,6 +656,7 @@ symbols! {
651656
const_trait_bound_opt_out,
652657
const_trait_impl,
653658
const_try,
659+
const_ty_placeholder: "<const_ty>",
654660
constant,
655661
constructor,
656662
convert_identity,
@@ -780,6 +786,7 @@ symbols! {
780786
drop_types_in_const,
781787
dropck_eyepatch,
782788
dropck_parametricity,
789+
dummy_cgu_name,
783790
dylib,
784791
dyn_compatible_for_dispatch,
785792
dyn_metadata,
@@ -923,6 +930,7 @@ symbols! {
923930
fmuladdf32,
924931
fmuladdf64,
925932
fn_align,
933+
fn_body,
926934
fn_delegation,
927935
fn_must_use,
928936
fn_mut,
@@ -963,6 +971,7 @@ symbols! {
963971
fs_create_dir,
964972
fsub_algebraic,
965973
fsub_fast,
974+
fsxr,
966975
full,
967976
fundamental,
968977
fused_iterator,
@@ -1386,6 +1395,7 @@ symbols! {
13861395
on,
13871396
on_unimplemented,
13881397
opaque,
1398+
opaque_module_name_placeholder: "<opaque>",
13891399
open_options_new,
13901400
ops,
13911401
opt_out_copy,
@@ -1655,6 +1665,7 @@ symbols! {
16551665
rust_eh_catch_typeinfo,
16561666
rust_eh_personality,
16571667
rust_logo,
1668+
rust_out,
16581669
rustc,
16591670
rustc_abi,
16601671
rustc_allocator,
@@ -1777,6 +1788,8 @@ symbols! {
17771788
self_in_typedefs,
17781789
self_struct_ctor,
17791790
semitransparent,
1791+
sha2,
1792+
sha3,
17801793
sha512_sm_x86,
17811794
shadow_call_stack,
17821795
shallow,
@@ -1891,6 +1904,7 @@ symbols! {
18911904
sreg,
18921905
sreg_low16,
18931906
sse,
1907+
sse2,
18941908
sse4a_target_feature,
18951909
stable,
18961910
staged_api,
@@ -2178,6 +2192,7 @@ symbols! {
21782192
wrapping_sub,
21792193
wreg,
21802194
write_bytes,
2195+
write_fmt,
21812196
write_macro,
21822197
write_str,
21832198
write_via_move,
@@ -2407,6 +2422,7 @@ impl Symbol {
24072422
}
24082423

24092424
/// Maps a string to its interned representation.
2425+
#[rustc_diagnostic_item = "SymbolIntern"]
24102426
pub fn intern(string: &str) -> Self {
24112427
with_session_globals(|session_globals| session_globals.symbol_interner.intern(string))
24122428
}

0 commit comments

Comments
 (0)