Skip to content

Commit cffde73

Browse files
dpaoliellodpaoliello
committed
Verify llvm-needs-components are not empty and match the --target value
1 parent 7278554 commit cffde73

30 files changed

+277
-97
lines changed

‎src/doc/rustc-dev-guide/src/tests/directives.md‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,8 +293,6 @@ See [Pretty-printer](compiletest.md#pretty-printer-tests).
293293

294294
- `no-auto-check-cfg` — disable auto check-cfg (only for `--check-cfg` tests)
295295
- [`revisions`](compiletest.md#revisions) — compile multiple times
296-
- [`unused-revision-names`](compiletest.md#ignoring-unused-revision-names) -
297-
suppress tidy checks for mentioning unknown revision names
298296
-[`forbid-output`](compiletest.md#incremental-tests) — incremental cfail rejects
299297
output pattern
300298
- [`should-ice`](compiletest.md#incremental-tests) — incremental cfail should
@@ -315,6 +313,17 @@ test suites that use those tools:
315313
- `llvm-cov-flags` adds extra flags when running LLVM's `llvm-cov` tool.
316314
- Used by [coverage tests](compiletest.md#coverage-tests) in `coverage-run` mode.
317315

316+
### Tidy specific directives
317+
318+
The following directives control how the [tidy script](../conventions.md#formatting)
319+
verifies tests.
320+
321+
- `ignore-tidy-target-specific-tests` disables checking that the appropriate
322+
LLVM component is required (via a `needs-llvm-components` directive) when a
323+
test is compiled for a specific target (via the `--target` flag in a
324+
`compile-flag` directive).
325+
- [`unused-revision-names`](compiletest.md#ignoring-unused-revision-names) -
326+
suppress tidy checks for mentioning unknown revision names.
318327

319328
## Substitutions
320329

‎src/tools/compiletest/src/directives.rs‎

Lines changed: 141 additions & 43 deletions
Large diffs are not rendered by default.

‎src/tools/compiletest/src/directives/auxiliary.rs‎

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
44
use std::iter;
55

6+
use camino::Utf8Path;
7+
68
use super::directives::{AUX_BIN, AUX_BUILD, AUX_CODEGEN_BACKEND, AUX_CRATE, PROC_MACRO};
79
use crate::common::Config;
810

@@ -41,17 +43,42 @@ impl AuxProps {
4143

4244
/// If the given test directive line contains an `aux-*` directive, parse it
4345
/// and update [`AuxProps`] accordingly.
44-
pub(super) fn parse_and_update_aux(config: &Config, ln: &str, aux: &mut AuxProps) {
46+
pub(super) fn parse_and_update_aux(
47+
config: &Config,
48+
ln: &str,
49+
testfile: &Utf8Path,
50+
line_number: usize,
51+
aux: &mut AuxProps,
52+
) {
4553
if !(ln.starts_with("aux-") || ln.starts_with("proc-macro")) {
4654
return;
4755
}
4856

49-
config.push_name_value_directive(ln, AUX_BUILD, &mut aux.builds, |r| r.trim().to_string());
50-
config.push_name_value_directive(ln, AUX_BIN, &mut aux.bins, |r| r.trim().to_string());
51-
config.push_name_value_directive(ln, AUX_CRATE, &mut aux.crates, parse_aux_crate);
52-
config
53-
.push_name_value_directive(ln, PROC_MACRO, &mut aux.proc_macros, |r| r.trim().to_string());
54-
if let Some(r) = config.parse_name_value_directive(ln, AUX_CODEGEN_BACKEND) {
57+
config.push_name_value_directive(ln, AUX_BUILD, testfile, line_number, &mut aux.builds, |r| {
58+
r.trim().to_string()
59+
});
60+
config.push_name_value_directive(ln, AUX_BIN, testfile, line_number, &mut aux.bins, |r| {
61+
r.trim().to_string()
62+
});
63+
config.push_name_value_directive(
64+
ln,
65+
AUX_CRATE,
66+
testfile,
67+
line_number,
68+
&mut aux.crates,
69+
parse_aux_crate,
70+
);
71+
config.push_name_value_directive(
72+
ln,
73+
PROC_MACRO,
74+
testfile,
75+
line_number,
76+
&mut aux.proc_macros,
77+
|r| r.trim().to_string(),
78+
);
79+
if let Some(r) =
80+
config.parse_name_value_directive(ln, AUX_CODEGEN_BACKEND, testfile, line_number)
81+
{
5582
aux.codegen_backend = Some(r.trim().to_owned());
5683
}
5784
}

‎src/tools/compiletest/src/runtest/debugger.rs‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,14 @@ impl DebuggerCommands {
4747
continue;
4848
};
4949

50-
if let Some(command) = config.parse_name_value_directive(&line, &command_directive) {
50+
if let Some(command) =
51+
config.parse_name_value_directive(&line, &command_directive, file, line_no)
52+
{
5153
commands.push(command);
5254
}
53-
if let Some(pattern) = config.parse_name_value_directive(&line, &check_directive) {
55+
if let Some(pattern) =
56+
config.parse_name_value_directive(&line, &check_directive, file, line_no)
57+
{
5458
check_lines.push((line_no, pattern));
5559
}
5660
}

‎src/tools/tidy/src/style.rs‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -519,8 +519,11 @@ pub fn check(path: &Path, bad: &mut bool) {
519519
.any(|directive| matches!(directive, Directive::Ignore(_)));
520520
let has_alphabetical_directive = line.contains("tidy-alphabetical-start")
521521
|| line.contains("tidy-alphabetical-end");
522-
let has_recognized_directive =
523-
has_recognized_ignore_directive || has_alphabetical_directive;
522+
let has_other_tidy_ignore_directive =
523+
line.contains("ignore-tidy-target-specific-tests");
524+
let has_recognized_directive = has_recognized_ignore_directive
525+
|| has_alphabetical_directive
526+
|| has_other_tidy_ignore_directive;
524527
if contains_potential_directive && (!has_recognized_directive) {
525528
err("Unrecognized tidy directive")
526529
}

‎src/tools/tidy/src/target_specific_tests.rs‎

Lines changed: 51 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,16 @@ const COMPILE_FLAGS_HEADER: &str = "compile-flags:";
1212

1313
#[derive(Default, Debug)]
1414
struct RevisionInfo<'a> {
15-
target_arch: Option<&'a str>,
15+
target_arch: Option<Option<&'a str>>,
1616
llvm_components: Option<Vec<&'a str>>,
1717
}
1818

1919
pub fn check(tests_path: &Path, bad: &mut bool) {
2020
crate::walk::walk(tests_path, |path, _is_dir| filter_not_rust(path), &mut |entry, content| {
21+
if content.contains("// ignore-tidy-target-specific-tests") {
22+
return;
23+
}
24+
2125
let file = entry.path().display();
2226
let mut header_map = BTreeMap::new();
2327
iter_header(content, &mut |HeaderLine { revision, directive, .. }| {
@@ -34,10 +38,11 @@ pub fn check(tests_path: &Path, bad: &mut bool) {
3438
&& let Some((_, v)) = compile_flags.split_once("--target")
3539
{
3640
let v = v.trim_start_matches([' ', '=']);
37-
let v = if v == "{{target}}" { Some((v, v)) } else { v.split_once("-") };
38-
if let Some((arch, _)) = v {
39-
let info = header_map.entry(revision).or_insert(RevisionInfo::default());
40-
info.target_arch.replace(arch);
41+
let info = header_map.entry(revision).or_insert(RevisionInfo::default());
42+
if v.starts_with("{{") {
43+
info.target_arch.replace(None);
44+
} else if let Some((arch, _)) = v.split_once("-") {
45+
info.target_arch.replace(Some(arch));
4146
} else {
4247
eprintln!("{file}: seems to have a malformed --target value");
4348
*bad = true;
@@ -54,9 +59,11 @@ pub fn check(tests_path: &Path, bad: &mut bool) {
5459
let rev = rev.unwrap_or("[unspecified]");
5560
match (target_arch, llvm_components) {
5661
(None, None) => {}
57-
(Some(_), None) => {
62+
(Some(target_arch), None) => {
63+
let llvm_component =
64+
target_arch.map_or_else(|| "<arch>".to_string(), arch_to_llvm_component);
5865
eprintln!(
59-
"{file}: revision {rev} should specify `{LLVM_COMPONENTS_HEADER}` as it has `--target` set"
66+
"{file}: revision {rev} should specify `{LLVM_COMPONENTS_HEADER} {llvm_component}` as it has `--target` set"
6067
);
6168
*bad = true;
6269
}
@@ -66,11 +73,45 @@ pub fn check(tests_path: &Path, bad: &mut bool) {
6673
);
6774
*bad = true;
6875
}
69-
(Some(_), Some(_)) => {
70-
// FIXME: check specified components against the target architectures we
71-
// gathered.
76+
(Some(target_arch), Some(llvm_components)) => {
77+
if let Some(target_arch) = target_arch {
78+
let llvm_component = arch_to_llvm_component(target_arch);
79+
if !llvm_components.contains(&llvm_component.as_str()) {
80+
eprintln!(
81+
"{file}: revision {rev} should specify `{LLVM_COMPONENTS_HEADER} {llvm_component}` as it has `--target` set"
82+
);
83+
*bad = true;
84+
}
85+
}
7286
}
7387
}
7488
}
7589
});
7690
}
91+
92+
fn arch_to_llvm_component(arch: &str) -> String {
93+
// NOTE: This is an *approximate* mapping of Rust's `--target` architecture to LLVM component
94+
// names. It is not intended to be an authoritative source, but rather a best-effort that's good
95+
// enough for the purpose of this tidy check.
96+
match arch {
97+
"amdgcn" => "amdgpu".into(),
98+
"aarch64_be" | "arm64_32" | "arm64e" | "arm64ec" => "aarch64".into(),
99+
"i386" | "i586" | "i686" | "x86" | "x86_64" | "x86_64h" => "x86".into(),
100+
"loongarch32" | "loongarch64" => "loongarch".into(),
101+
"nvptx64" => "nvptx".into(),
102+
"s390x" => "systemz".into(),
103+
"sparc64" | "sparcv9" => "sparc".into(),
104+
"wasm32" | "wasm32v1" | "wasm64" => "webassembly".into(),
105+
_ if arch.starts_with("armeb")
106+
|| arch.starts_with("armv")
107+
|| arch.starts_with("thumbv") =>
108+
{
109+
"arm".into()
110+
}
111+
_ if arch.starts_with("bpfe") => "bpf".into(),
112+
_ if arch.starts_with("mips") => "mips".into(),
113+
_ if arch.starts_with("powerpc") => "powerpc".into(),
114+
_ if arch.starts_with("riscv") => "riscv".into(),
115+
_ => arch.to_ascii_lowercase(),
116+
}
117+
}

‎tests/codegen-llvm/abi-efiapi.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
//@ add-core-stubs
44
//@ revisions:x86_64 i686 aarch64 arm riscv
55
//@[x86_64] compile-flags: --target x86_64-unknown-uefi
6-
//@[x86_64] needs-llvm-components: aarch64 arm riscv
6+
//@[x86_64] needs-llvm-components: x86
77
//@[i686] compile-flags: --target i686-unknown-linux-musl
8-
//@[i686] needs-llvm-components: aarch64 arm riscv
8+
//@[i686] needs-llvm-components: x86
99
//@[aarch64] compile-flags: --target aarch64-unknown-none
10-
//@[aarch64] needs-llvm-components: aarch64 arm riscv
10+
//@[aarch64] needs-llvm-components: aarch64
1111
//@[arm] compile-flags: --target armv7r-none-eabi
12-
//@[arm] needs-llvm-components: aarch64 arm riscv
12+
//@[arm] needs-llvm-components: arm
1313
//@[riscv] compile-flags: --target riscv64gc-unknown-none-elf
14-
//@[riscv] needs-llvm-components: aarch64 arm riscv
14+
//@[riscv] needs-llvm-components: riscv
1515
//@ compile-flags: -C no-prepopulate-passes
1616

1717
#![crate_type = "lib"]

‎tests/codegen-llvm/cast-target-abi.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
//@ compile-flags: -Copt-level=3 -Cno-prepopulate-passes -Zlint-llvm-ir
55

66
//@[aarch64] compile-flags: --target aarch64-unknown-linux-gnu
7-
//@[aarch64] needs-llvm-components: arm
7+
//@[aarch64] needs-llvm-components: aarch64
88
//@[loongarch64] compile-flags: --target loongarch64-unknown-linux-gnu
99
//@[loongarch64] needs-llvm-components: loongarch
1010
//@[powerpc64] compile-flags: --target powerpc64-unknown-linux-gnu

‎tests/codegen-llvm/cf-protection.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
//@ add-core-stubs
44
//@ revisions: undefined none branch return full
55
//@ needs-llvm-components: x86
6-
//@ [undefined] compile-flags:
6+
// [undefined] no extra compile-flags
77
//@ [none] compile-flags: -Z cf-protection=none
88
//@ [branch] compile-flags: -Z cf-protection=branch
99
//@ [return] compile-flags: -Z cf-protection=return

‎tests/codegen-llvm/codemodels.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//@ only-x86_64
22

33
//@ revisions: NOMODEL MODEL-SMALL MODEL-KERNEL MODEL-MEDIUM MODEL-LARGE
4-
//@[NOMODEL] compile-flags:
4+
// [NOMODEL] no compile-flags
55
//@[MODEL-SMALL] compile-flags: -C code-model=small
66
//@[MODEL-KERNEL] compile-flags: -C code-model=kernel
77
//@[MODEL-MEDIUM] compile-flags: -C code-model=medium

0 commit comments

Comments
 (0)