Skip to content

Commit 36d5c0e

Browse files
committed
Reject macro calls inside of #![crate_name]
1 parent f023513 commit 36d5c0e

21 files changed

+191
-114
lines changed

Diff for: compiler/rustc_driver_impl/src/lib.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -752,11 +752,12 @@ fn print_crate_info(
752752
return Compilation::Continue;
753753
};
754754
let t_outputs = rustc_interface::util::build_output_filenames(attrs, sess);
755-
let id = rustc_session::output::find_crate_name(sess, attrs);
755+
let crate_name = passes::get_crate_name(sess, attrs);
756756
let crate_types = collect_crate_types(sess, attrs);
757757
for &style in &crate_types {
758-
let fname =
759-
rustc_session::output::filename_for_input(sess, style, id, &t_outputs);
758+
let fname = rustc_session::output::filename_for_input(
759+
sess, style, crate_name, &t_outputs,
760+
);
760761
println_info!("{}", fname.as_path().file_name().unwrap().to_string_lossy());
761762
}
762763
}
@@ -765,8 +766,7 @@ fn print_crate_info(
765766
// no crate attributes, print out an error and exit
766767
return Compilation::Continue;
767768
};
768-
let id = rustc_session::output::find_crate_name(sess, attrs);
769-
println_info!("{id}");
769+
println_info!("{}", passes::get_crate_name(sess, attrs));
770770
}
771771
Cfg => {
772772
let mut cfgs = sess

Diff for: compiler/rustc_expand/src/module.rs

+6-6
Original file line numberDiff line numberDiff line change
@@ -180,12 +180,12 @@ pub(crate) fn mod_file_path_from_attr(
180180
let first_path = attrs.iter().find(|at| at.has_name(sym::path))?;
181181
let Some(path_sym) = first_path.value_str() else {
182182
// This check is here mainly to catch attempting to use a macro,
183-
// such as #[path = concat!(...)]. This isn't currently supported
184-
// because otherwise the InvocationCollector would need to defer
185-
// loading a module until the #[path] attribute was expanded, and
186-
// it doesn't support that (and would likely add a bit of
187-
// complexity). Usually bad forms are checked in AstValidator (via
188-
// `check_builtin_attribute`), but by the time that runs the macro
183+
// such as `#[path = concat!(...)]`. This isn't supported because
184+
// otherwise the `InvocationCollector` would need to defer loading
185+
// a module until the `#[path]` attribute was expanded, and it
186+
// doesn't support that (and would likely add a bit of complexity).
187+
// Usually bad forms are checked during semantic analysis via
188+
// `TyCtxt::check_mod_attrs`), but by the time that runs the macro
189189
// is expanded, and it doesn't give an error.
190190
validate_attr::emit_fatal_malformed_builtin_attribute(&sess.psess, first_path, sym::path);
191191
};

Diff for: compiler/rustc_incremental/src/persist/fs.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,9 @@ use rustc_data_structures::{base_n, flock};
117117
use rustc_fs_util::{LinkOrCopy, link_or_copy, try_canonicalize};
118118
use rustc_middle::bug;
119119
use rustc_session::config::CrateType;
120-
use rustc_session::output::{collect_crate_types, find_crate_name};
120+
use rustc_session::output::collect_crate_types;
121121
use rustc_session::{Session, StableCrateId};
122+
use rustc_span::Symbol;
122123
use tracing::debug;
123124

124125
use crate::errors;
@@ -211,7 +212,7 @@ pub fn in_incr_comp_dir(incr_comp_session_dir: &Path, file_name: &str) -> PathBu
211212
/// The garbage collection will take care of it.
212213
///
213214
/// [`rustc_interface::queries::dep_graph`]: ../../rustc_interface/struct.Queries.html#structfield.dep_graph
214-
pub(crate) fn prepare_session_directory(sess: &Session) {
215+
pub(crate) fn prepare_session_directory(sess: &Session, crate_name: Symbol) {
215216
if sess.opts.incremental.is_none() {
216217
return;
217218
}
@@ -221,7 +222,7 @@ pub(crate) fn prepare_session_directory(sess: &Session) {
221222
debug!("prepare_session_directory");
222223

223224
// {incr-comp-dir}/{crate-name-and-disambiguator}
224-
let crate_dir = crate_path(sess);
225+
let crate_dir = crate_path(sess, crate_name);
225226
debug!("crate-dir: {}", crate_dir.display());
226227
create_dir(sess, &crate_dir, "crate");
227228

@@ -594,10 +595,9 @@ fn string_to_timestamp(s: &str) -> Result<SystemTime, &'static str> {
594595
Ok(UNIX_EPOCH + duration)
595596
}
596597

597-
fn crate_path(sess: &Session) -> PathBuf {
598+
fn crate_path(sess: &Session, crate_name: Symbol) -> PathBuf {
598599
let incr_dir = sess.opts.incremental.as_ref().unwrap().clone();
599600

600-
let crate_name = find_crate_name(sess, &[]);
601601
let crate_types = collect_crate_types(sess, &[]);
602602
let stable_crate_id = StableCrateId::new(
603603
crate_name,

Diff for: compiler/rustc_incremental/src/persist/load.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ use rustc_serialize::Decodable;
1111
use rustc_serialize::opaque::MemDecoder;
1212
use rustc_session::Session;
1313
use rustc_session::config::IncrementalStateAssertion;
14+
use rustc_span::Symbol;
1415
use tracing::{debug, warn};
1516

1617
use super::data::*;
@@ -203,9 +204,9 @@ pub fn load_query_result_cache(sess: &Session) -> Option<OnDiskCache> {
203204

204205
/// Setups the dependency graph by loading an existing graph from disk and set up streaming of a
205206
/// new graph to an incremental session directory.
206-
pub fn setup_dep_graph(sess: &Session) -> DepGraph {
207+
pub fn setup_dep_graph(sess: &Session, crate_name: Symbol) -> DepGraph {
207208
// `load_dep_graph` can only be called after `prepare_session_directory`.
208-
prepare_session_directory(sess);
209+
prepare_session_directory(sess, crate_name);
209210

210211
let res = sess.opts.build_dep_graph().then(|| load_dep_graph(sess));
211212

Diff for: compiler/rustc_interface/messages.ftl

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
interface_cant_emit_mir =
22
could not emit MIR: {$error}
33
4+
interface_crate_name_does_not_match = `--crate-name` and `#[crate_name]` are required to match, but `{$crate_name}` != `{$attr_crate_name}`
5+
6+
interface_crate_name_invalid = crate names cannot start with a `-`, but `{$crate_name}` has a leading hyphen
7+
48
interface_emoji_identifier =
59
identifiers cannot contain emoji: `{$ident}`
610

Diff for: compiler/rustc_interface/src/errors.rs

+15
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@ use std::path::Path;
44
use rustc_macros::Diagnostic;
55
use rustc_span::{Span, Symbol};
66

7+
#[derive(Diagnostic)]
8+
#[diag(interface_crate_name_does_not_match)]
9+
pub(crate) struct CrateNameDoesNotMatch {
10+
#[primary_span]
11+
pub(crate) span: Span,
12+
pub(crate) crate_name: Symbol,
13+
pub(crate) attr_crate_name: Symbol,
14+
}
15+
16+
#[derive(Diagnostic)]
17+
#[diag(interface_crate_name_invalid)]
18+
pub(crate) struct CrateNameInvalid<'a> {
19+
pub(crate) crate_name: &'a str,
20+
}
21+
722
#[derive(Diagnostic)]
823
#[diag(interface_ferris_identifier)]
924
pub struct FerrisIdentifier {

Diff for: compiler/rustc_interface/src/passes.rs

+80-21
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ use rustc_resolve::Resolver;
2929
use rustc_session::code_stats::VTableSizeInfo;
3030
use rustc_session::config::{CrateType, Input, OutFileName, OutputFilenames, OutputType};
3131
use rustc_session::cstore::Untracked;
32-
use rustc_session::output::{collect_crate_types, filename_for_input, find_crate_name};
32+
use rustc_session::output::{collect_crate_types, filename_for_input};
3333
use rustc_session::search_paths::PathKind;
3434
use rustc_session::{Limit, Session};
3535
use rustc_span::symbol::{Symbol, sym};
36-
use rustc_span::{ErrorGuaranteed, FileName, SourceFileHash, SourceFileHashAlgorithm};
36+
use rustc_span::{ErrorGuaranteed, FileName, SourceFileHash, SourceFileHashAlgorithm, Span};
3737
use rustc_target::spec::PanicStrategy;
3838
use rustc_trait_selection::traits;
3939
use tracing::{info, instrument};
@@ -726,8 +726,7 @@ pub(crate) fn create_global_ctxt<'tcx>(
726726

727727
let pre_configured_attrs = rustc_expand::config::pre_configure_attrs(sess, &krate.attrs);
728728

729-
// parse `#[crate_name]` even if `--crate-name` was passed, to make sure it matches.
730-
let crate_name = find_crate_name(sess, &pre_configured_attrs);
729+
let crate_name = get_crate_name(sess, &pre_configured_attrs);
731730
let crate_types = collect_crate_types(sess, &pre_configured_attrs);
732731
let stable_crate_id = StableCrateId::new(
733732
crate_name,
@@ -736,7 +735,7 @@ pub(crate) fn create_global_ctxt<'tcx>(
736735
sess.cfg_version,
737736
);
738737
let outputs = util::build_output_filenames(&pre_configured_attrs, sess);
739-
let dep_graph = setup_dep_graph(sess);
738+
let dep_graph = setup_dep_graph(sess, crate_name);
740739

741740
let cstore =
742741
FreezeLock::new(Box::new(CStore::new(compiler.codegen_backend.metadata_loader())) as _);
@@ -1128,23 +1127,83 @@ pub(crate) fn start_codegen<'tcx>(
11281127
codegen
11291128
}
11301129

1131-
fn get_recursion_limit(krate_attrs: &[ast::Attribute], sess: &Session) -> Limit {
1132-
if let Some(attr) = krate_attrs
1133-
.iter()
1134-
.find(|attr| attr.has_name(sym::recursion_limit) && attr.value_str().is_none())
1130+
/// Compute and validate the crate name.
1131+
pub fn get_crate_name(sess: &Session, krate_attrs: &[ast::Attribute]) -> Symbol {
1132+
// We unconditionally validate all `#![crate_name]`s even if a crate name was
1133+
// set on the command line via `--crate-name` which we prioritize over the
1134+
// crate attributes. We perform the validation here instead of later to ensure
1135+
// it gets run in all code paths requiring the crate name very early on.
1136+
// Namely, print requests (`--print`).
1137+
let attr_crate_name =
1138+
validate_and_find_value_str_builtin_attr(sym::crate_name, sess, krate_attrs);
1139+
1140+
let validate = |name, span| {
1141+
rustc_session::output::validate_crate_name(sess, name, span);
1142+
name
1143+
};
1144+
1145+
if let Some(crate_name) = &sess.opts.crate_name {
1146+
let crate_name = Symbol::intern(crate_name);
1147+
if let Some((attr_crate_name, span)) = attr_crate_name
1148+
&& attr_crate_name != crate_name
1149+
{
1150+
sess.dcx().emit_err(errors::CrateNameDoesNotMatch {
1151+
span,
1152+
crate_name,
1153+
attr_crate_name,
1154+
});
1155+
}
1156+
return validate(crate_name, None);
1157+
}
1158+
1159+
if let Some((crate_name, span)) = attr_crate_name {
1160+
return validate(crate_name, Some(span));
1161+
}
1162+
1163+
if let Input::File(ref path) = sess.io.input
1164+
&& let Some(file_stem) = path.file_stem().and_then(|s| s.to_str())
11351165
{
1136-
// This is here mainly to check for using a macro, such as
1137-
// #![recursion_limit = foo!()]. That is not supported since that
1138-
// would require expanding this while in the middle of expansion,
1139-
// which needs to know the limit before expanding. Otherwise,
1140-
// validation would normally be caught in AstValidator (via
1141-
// `check_builtin_attribute`), but by the time that runs the macro
1142-
// is expanded, and it doesn't give an error.
1143-
validate_attr::emit_fatal_malformed_builtin_attribute(
1144-
&sess.psess,
1145-
attr,
1146-
sym::recursion_limit,
1147-
);
1166+
if file_stem.starts_with('-') {
1167+
sess.dcx().emit_err(errors::CrateNameInvalid { crate_name: file_stem });
1168+
} else {
1169+
return validate(Symbol::intern(&file_stem.replace('-', "_")), None);
1170+
}
11481171
}
1172+
1173+
sym::rust_out
1174+
}
1175+
1176+
fn get_recursion_limit(krate_attrs: &[ast::Attribute], sess: &Session) -> Limit {
1177+
// We don't permit macro calls inside of the attribute (e.g., #![recursion_limit = `expand!()`])
1178+
// because that would require expanding this while in the middle of expansion, which needs to
1179+
// know the limit before expanding.
1180+
let _ = validate_and_find_value_str_builtin_attr(sym::recursion_limit, sess, krate_attrs);
11491181
rustc_middle::middle::limits::get_recursion_limit(krate_attrs, sess)
11501182
}
1183+
1184+
/// Validate *all* occurrences of the given "[value-str]" built-in attribute and return the first find.
1185+
///
1186+
/// This validator is intended for built-in attributes whose value needs to be known very early
1187+
/// during compilation (namely, before macro expansion) and it mainly exists to reject macro calls
1188+
/// inside of the attributes, such as in `#![name = expand!()]`. Normal attribute validation happens
1189+
/// during semantic analysis via [`TyCtxt::check_mod_attrs`] which happens *after* macro expansion
1190+
/// when such macro calls (here: `expand`) have already been expanded and we can no longer check for
1191+
/// their presence.
1192+
///
1193+
/// [value-str]: ast::Attribute::value_str
1194+
fn validate_and_find_value_str_builtin_attr(
1195+
name: Symbol,
1196+
sess: &Session,
1197+
krate_attrs: &[ast::Attribute],
1198+
) -> Option<(Symbol, Span)> {
1199+
let mut result = None;
1200+
// Validate *all* relevant attributes, not just the first occurrence.
1201+
for attr in ast::attr::filter_by_name(krate_attrs, name) {
1202+
let Some(value) = attr.value_str() else {
1203+
validate_attr::emit_fatal_malformed_builtin_attribute(&sess.psess, attr, name)
1204+
};
1205+
// Choose the first occurrence as our result.
1206+
result.get_or_insert((value, attr.span));
1207+
}
1208+
result
1209+
}

Diff for: compiler/rustc_interface/src/util.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -401,11 +401,11 @@ pub(crate) fn check_attr_crate_type(
401401
}
402402
} else {
403403
// This is here mainly to check for using a macro, such as
404-
// #![crate_type = foo!()]. That is not supported since the
404+
// `#![crate_type = foo!()]`. That is not supported since the
405405
// crate type needs to be known very early in compilation long
406406
// before expansion. Otherwise, validation would normally be
407-
// caught in AstValidator (via `check_builtin_attribute`), but
408-
// by the time that runs the macro is expanded, and it doesn't
407+
// caught during semantic analysis via `TyCtxt::check_mod_attrs`,
408+
// but by the time that runs the macro is expanded, and it doesn't
409409
// give an error.
410410
validate_attr::emit_fatal_malformed_builtin_attribute(
411411
&sess.psess,

Diff for: compiler/rustc_session/messages.ftl

-4
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,8 @@ session_cannot_mix_and_match_sanitizers = `-Zsanitizer={$first}` is incompatible
88
session_cli_feature_diagnostic_help =
99
add `-Zcrate-attr="feature({$feature})"` to the command-line options to enable
1010
11-
session_crate_name_does_not_match = `--crate-name` and `#[crate_name]` are required to match, but `{$crate_name}` != `{$attr_crate_name}`
12-
1311
session_crate_name_empty = crate name must not be empty
1412
15-
session_crate_name_invalid = crate names cannot start with a `-`, but `{$s}` has a leading hyphen
16-
1713
session_embed_source_insufficient_dwarf_version = `-Zembed-source=y` requires at least `-Z dwarf-version=5` but DWARF version is {$dwarf_version}
1814
1915
session_embed_source_requires_debug_info = `-Zembed-source=y` requires debug information to be enabled

Diff for: compiler/rustc_session/src/errors.rs

-15
Original file line numberDiff line numberDiff line change
@@ -211,21 +211,6 @@ pub(crate) struct FileWriteFail<'a> {
211211
pub(crate) err: String,
212212
}
213213

214-
#[derive(Diagnostic)]
215-
#[diag(session_crate_name_does_not_match)]
216-
pub(crate) struct CrateNameDoesNotMatch {
217-
#[primary_span]
218-
pub(crate) span: Span,
219-
pub(crate) crate_name: Symbol,
220-
pub(crate) attr_crate_name: Symbol,
221-
}
222-
223-
#[derive(Diagnostic)]
224-
#[diag(session_crate_name_invalid)]
225-
pub(crate) struct CrateNameInvalid<'a> {
226-
pub(crate) s: &'a str,
227-
}
228-
229214
#[derive(Diagnostic)]
230215
#[diag(session_crate_name_empty)]
231216
pub(crate) struct CrateNameEmpty {

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

+3-53
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,13 @@
22
33
use std::path::Path;
44

5-
use rustc_ast::{self as ast, attr};
5+
use rustc_ast as ast;
66
use rustc_span::symbol::sym;
77
use rustc_span::{Span, Symbol};
88

99
use crate::Session;
10-
use crate::config::{self, CrateType, Input, OutFileName, OutputFilenames, OutputType};
11-
use crate::errors::{
12-
self, CrateNameDoesNotMatch, CrateNameEmpty, CrateNameInvalid, FileIsNotWriteable,
13-
InvalidCharacterInCrateName,
14-
};
10+
use crate::config::{self, CrateType, OutFileName, OutputFilenames, OutputType};
11+
use crate::errors::{self, CrateNameEmpty, FileIsNotWriteable, InvalidCharacterInCrateName};
1512

1613
pub fn out_filename(
1714
sess: &Session,
@@ -50,53 +47,6 @@ fn is_writeable(p: &Path) -> bool {
5047
}
5148
}
5249

53-
/// Find and [validate] the crate name.
54-
///
55-
/// [validate]: validate_crate_name
56-
pub fn find_crate_name(sess: &Session, attrs: &[ast::Attribute]) -> Symbol {
57-
let validate = |name, span| {
58-
validate_crate_name(sess, name, span);
59-
name
60-
};
61-
62-
// Look in attributes 100% of the time to make sure the attribute is marked
63-
// as used. After doing this, however, we still prioritize a crate name from
64-
// the command line over one found in the #[crate_name] attribute. If we
65-
// find both we ensure that they're the same later on as well.
66-
let attr_crate_name =
67-
attr::find_by_name(attrs, sym::crate_name).and_then(|at| at.value_str().map(|s| (at, s)));
68-
69-
if let Some(crate_name) = &sess.opts.crate_name {
70-
let crate_name = Symbol::intern(crate_name);
71-
if let Some((attr, attr_crate_name)) = attr_crate_name
72-
&& attr_crate_name != crate_name
73-
{
74-
sess.dcx().emit_err(CrateNameDoesNotMatch {
75-
span: attr.span,
76-
crate_name,
77-
attr_crate_name,
78-
});
79-
}
80-
return validate(crate_name, None);
81-
}
82-
83-
if let Some((attr, crate_name)) = attr_crate_name {
84-
return validate(crate_name, Some(attr.span));
85-
}
86-
87-
if let Input::File(ref path) = sess.io.input
88-
&& let Some(s) = path.file_stem().and_then(|s| s.to_str())
89-
{
90-
if s.starts_with('-') {
91-
sess.dcx().emit_err(CrateNameInvalid { s });
92-
} else {
93-
return validate(Symbol::intern(&s.replace('-', "_")), None);
94-
}
95-
}
96-
97-
sym::rust_out
98-
}
99-
10050
/// Validate the given crate name.
10151
///
10252
/// Note that this validation is more permissive than identifier parsing. It considers

0 commit comments

Comments
 (0)