compiletest/common.rs
1use std::borrow::Cow;
2use std::collections::{BTreeSet, HashMap, HashSet};
3use std::iter;
4use std::process::Command;
5use std::str::FromStr;
6use std::sync::OnceLock;
7
8use build_helper::git::GitConfig;
9use camino::{Utf8Path, Utf8PathBuf};
10use semver::Version;
11
12use crate::debuggers::LldbVersion;
13use crate::edition::Edition;
14use crate::executor::TestVariant;
15use crate::fatal;
16use crate::util::{Utf8PathBufExt, add_dylib_path, string_enum};
17
18string_enum! {
19 #[derive(Clone, Copy, PartialEq, Debug)]
20 pub(crate) enum TestMode {
21 Pretty => "pretty",
22 DebugInfo => "debuginfo",
23 Codegen => "codegen",
24 RustdocHtml => "rustdoc-html",
25 RustdocJson => "rustdoc-json",
26 CodegenUnits => "codegen-units",
27 Incremental => "incremental",
28 RunMake => "run-make",
29 Ui => "ui",
30 RustdocJs => "rustdoc-js",
31 MirOpt => "mir-opt",
32 Assembly => "assembly",
33 CoverageMap => "coverage-map",
34 CoverageRun => "coverage-run",
35 Crashes => "crashes",
36 }
37}
38
39impl TestMode {
40 pub(crate) fn aux_dir_disambiguator(self) -> &'static str {
41 // Pretty-printing tests could run concurrently, and if they do,
42 // they need to keep their output segregated.
43 match self {
44 TestMode::Pretty => ".pretty",
45 _ => "",
46 }
47 }
48
49 pub(crate) fn output_dir_disambiguator(self) -> &'static str {
50 // Coverage tests use the same test files for multiple test modes,
51 // so each mode should have a separate output directory.
52 match self {
53 TestMode::CoverageMap | TestMode::CoverageRun => self.to_str(),
54 _ => "",
55 }
56 }
57}
58
59// Note that coverage tests use the same test files for multiple test modes.
60string_enum! {
61 #[derive(Clone, Copy, PartialEq, Debug)]
62 pub(crate) enum TestSuite {
63 AssemblyLlvm => "assembly-llvm",
64 CodegenLlvm => "codegen-llvm",
65 CodegenUnits => "codegen-units",
66 Coverage => "coverage",
67 CoverageRunRustdoc => "coverage-run-rustdoc",
68 Crashes => "crashes",
69 Debuginfo => "debuginfo",
70 Incremental => "incremental",
71 MirOpt => "mir-opt",
72 Pretty => "pretty",
73 RunMake => "run-make",
74 RunMakeCargo => "run-make-cargo",
75 RustdocHtml => "rustdoc-html",
76 RustdocGui => "rustdoc-gui",
77 RustdocJs => "rustdoc-js",
78 RustdocJsStd=> "rustdoc-js-std",
79 RustdocJson => "rustdoc-json",
80 RustdocUi => "rustdoc-ui",
81 Ui => "ui",
82 UiFullDeps => "ui-fulldeps",
83 BuildStd => "build-std",
84 }
85}
86
87string_enum! {
88 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
89 pub(crate) enum PassFailMode {
90 CheckFail => "check-fail",
91 CheckPass => "check-pass",
92 BuildFail => "build-fail",
93 BuildPass => "build-pass",
94 /// Running the program must make it exit with a regular failure exit code
95 /// in the range `1..=127`. If the program is terminated by e.g. a signal
96 /// the test will fail.
97 RunFail => "run-fail",
98 /// Running the program must result in a crash, e.g. by `SIGABRT` or
99 /// `SIGSEGV` on Unix or on Windows by having an appropriate NTSTATUS high
100 /// bit in the exit code.
101 RunCrash => "run-crash",
102 /// Running the program must either fail or crash. Useful for e.g. sanitizer
103 /// tests since some sanitizer implementations exit the process with code 1
104 /// to in the face of memory errors while others abort (crash) the process
105 /// in the face of memory errors.
106 RunFailOrCrash => "run-fail-or-crash",
107 RunPass => "run-pass",
108 }
109}
110
111impl PassFailMode {
112 pub(crate) fn is_pass(&self) -> bool {
113 match self {
114 PassFailMode::CheckPass | PassFailMode::BuildPass | PassFailMode::RunPass => true,
115
116 PassFailMode::CheckFail
117 | PassFailMode::BuildFail
118 | PassFailMode::RunFail
119 | PassFailMode::RunCrash
120 | PassFailMode::RunFailOrCrash => false,
121 }
122 }
123
124 pub(crate) fn is_check(&self) -> bool {
125 match self {
126 PassFailMode::CheckFail | PassFailMode::CheckPass => true,
127
128 PassFailMode::BuildFail
129 | PassFailMode::BuildPass
130 | PassFailMode::RunFail
131 | PassFailMode::RunCrash
132 | PassFailMode::RunFailOrCrash
133 | PassFailMode::RunPass => false,
134 }
135 }
136
137 pub(crate) fn is_run(&self) -> bool {
138 match self {
139 PassFailMode::CheckFail
140 | PassFailMode::CheckPass
141 | PassFailMode::BuildFail
142 | PassFailMode::BuildPass => false,
143
144 PassFailMode::RunFail
145 | PassFailMode::RunCrash
146 | PassFailMode::RunFailOrCrash
147 | PassFailMode::RunPass => true,
148 }
149 }
150}
151
152string_enum! {
153 #[derive(Clone, Copy, PartialEq, Debug, Hash)]
154 pub(crate) enum ForcePassMode {
155 Check => "check",
156 Build => "build",
157 Run => "run",
158 }
159}
160
161string_enum! {
162 #[derive(Clone, Copy, PartialEq, Debug, Hash)]
163 pub(crate) enum RunResult {
164 Pass => "run-pass",
165 Fail => "run-fail",
166 Crash => "run-crash",
167 }
168}
169
170string_enum! {
171 #[derive(Clone, Debug, PartialEq)]
172 pub(crate) enum CompareMode {
173 Polonius => "polonius",
174 NextSolver => "next-solver",
175 NextSolverCoherence => "next-solver-coherence",
176 SplitDwarf => "split-dwarf",
177 SplitDwarfSingle => "split-dwarf-single",
178 }
179}
180
181string_enum! {
182 #[derive(Clone, Copy, Debug, PartialEq)]
183 pub(crate) enum Debugger {
184 Cdb => "cdb",
185 Gdb => "gdb",
186 Lldb => "lldb",
187 }
188}
189
190#[derive(Clone, Copy, Debug, PartialEq, Default, serde::Deserialize)]
191#[serde(rename_all = "kebab-case")]
192pub(crate) enum PanicStrategy {
193 #[default]
194 Unwind,
195 Abort,
196}
197
198impl PanicStrategy {
199 pub(crate) fn for_miropt_test_tools(&self) -> miropt_test_tools::PanicStrategy {
200 match self {
201 PanicStrategy::Unwind => miropt_test_tools::PanicStrategy::Unwind,
202 PanicStrategy::Abort => miropt_test_tools::PanicStrategy::Abort,
203 }
204 }
205}
206
207#[derive(Clone, Debug, PartialEq, serde::Deserialize)]
208#[serde(rename_all = "kebab-case")]
209pub(crate) enum Sanitizer {
210 Address,
211 Cfi,
212 Dataflow,
213 Kcfi,
214 KernelAddress,
215 KernelHwaddress,
216 Leak,
217 Memory,
218 Memtag,
219 Safestack,
220 ShadowCallStack,
221 Thread,
222 Hwaddress,
223 Realtime,
224}
225
226#[derive(Clone, Copy, Debug, PartialEq)]
227pub(crate) enum CodegenBackend {
228 Cranelift,
229 Gcc,
230 Llvm,
231}
232
233impl FromStr for CodegenBackend {
234 type Err = &'static str;
235
236 fn from_str(value: &str) -> Result<Self, Self::Err> {
237 match value.to_lowercase().as_str() {
238 "cranelift" => Ok(Self::Cranelift),
239 "gcc" => Ok(Self::Gcc),
240 "llvm" => Ok(Self::Llvm),
241 _ => Err("unknown codegen backend"),
242 }
243 }
244}
245
246impl CodegenBackend {
247 pub(crate) fn as_str(self) -> &'static str {
248 match self {
249 Self::Cranelift => "cranelift",
250 Self::Gcc => "gcc",
251 Self::Llvm => "llvm",
252 }
253 }
254
255 pub(crate) fn is_llvm(self) -> bool {
256 matches!(self, Self::Llvm)
257 }
258}
259
260/// Configuration for `compiletest` *per invocation*.
261///
262/// In terms of `bootstrap`, this means that `./x test tests/ui tests/run-make` actually correspond
263/// to *two* separate invocations of `compiletest`.
264///
265/// FIXME: this `Config` struct should be broken up into smaller logically contained sub-config
266/// structs, it's too much of a "soup" of everything at the moment.
267///
268/// # Configuration sources
269///
270/// Configuration values for `compiletest` comes from several sources:
271///
272/// - CLI args passed from `bootstrap` while running the `compiletest` binary.
273/// - Env vars.
274/// - Discovery (e.g. trying to identify a suitable debugger based on filesystem discovery).
275/// - Cached output of running the `rustc` under test (e.g. output of `rustc` print requests).
276///
277/// FIXME: make sure we *clearly* account for sources of *all* config options.
278///
279/// FIXME: audit these options to make sure we are not hashing less than necessary for build stamp
280/// (for changed test detection).
281#[derive(Debug, Clone)]
282pub(crate) struct Config {
283 /// Some [`TestMode`]s support [snapshot testing], where a *reference snapshot* of outputs (of
284 /// `stdout`, `stderr`, or other form of artifacts) can be compared to the *actual output*.
285 ///
286 /// This option can be set to `true` to update the *reference snapshots* in-place, otherwise
287 /// `compiletest` will only try to compare.
288 ///
289 /// [snapshot testing]: https://jestjs.io/docs/snapshot-testing
290 pub(crate) bless: bool,
291
292 /// Attempt to stop as soon as possible after any test fails. We may still run a few more tests
293 /// before stopping when multiple test threads are used.
294 pub(crate) fail_fast: bool,
295
296 /// Path to libraries needed to run the *staged* `rustc`-under-test on the **host** platform.
297 ///
298 /// For example:
299 /// - `/home/ferris/rust/build/x86_64-unknown-linux-gnu/stage1/bin/lib`
300 pub(crate) host_compile_lib_path: Utf8PathBuf,
301
302 /// Path to libraries needed to run the compiled executable for the **target** platform. This
303 /// corresponds to the **target** sysroot libraries, including the **target** standard library.
304 ///
305 /// For example:
306 /// - `/home/ferris/rust/build/x86_64-unknown-linux-gnu/stage1/lib/rustlib/i686-unknown-linux-gnu/lib`
307 ///
308 /// FIXME: this is very under-documented in conjunction with the `remote-test-client` scheme and
309 /// `RUNNER` scheme to actually run the target executable under the target platform environment,
310 /// cf. [`Self::remote_test_client`] and [`Self::runner`].
311 pub(crate) target_run_lib_path: Utf8PathBuf,
312
313 /// Path to the `rustc`-under-test.
314 ///
315 /// For `ui-fulldeps` test suite specifically:
316 ///
317 /// - This is the **stage 0** compiler when testing `ui-fulldeps` under `--stage=1`.
318 /// - This is the **stage 2** compiler when testing `ui-fulldeps` under `--stage=2`.
319 ///
320 /// See [`Self::query_rustc_path`] for the `--stage=1` `ui-fulldeps` scenario where a separate
321 /// in-tree `rustc` is used for querying target information.
322 ///
323 /// For example:
324 /// - `/home/ferris/rust/build/x86_64-unknown-linux-gnu/stage1/bin/rustc`
325 ///
326 /// # Note on forced stage0
327 ///
328 /// It is possible for this `rustc` to be a stage 0 `rustc` if explicitly configured with the
329 /// bootstrap option `build.compiletest-allow-stage0=true` and specifying `--stage=0`.
330 pub(crate) rustc_path: Utf8PathBuf,
331
332 /// Path to a *staged* **host** platform cargo executable (unless stage 0 is forced). This
333 /// staged `cargo` is only used within `run-make` test recipes during recipe run time (and is
334 /// *not* used to compile the test recipes), and so must be staged as there may be differences
335 /// between e.g. beta `cargo` vs in-tree `cargo`.
336 ///
337 /// For example:
338 /// - `/home/ferris/rust/build/x86_64-unknown-linux-gnu/stage1-tools-bin/cargo`
339 ///
340 /// FIXME: maybe rename this to reflect that this is a *staged* host cargo.
341 pub(crate) cargo_path: Option<Utf8PathBuf>,
342
343 /// Path to the stage 0 `rustc` used to build `run-make` recipes. This must not be confused with
344 /// [`Self::rustc_path`].
345 ///
346 /// For example:
347 /// - `/home/ferris/rust/build/x86_64-unknown-linux-gnu/stage0/bin/rustc`
348 pub(crate) stage0_rustc_path: Option<Utf8PathBuf>,
349
350 /// Path to the stage 1 or higher `rustc` used to obtain target information via
351 /// `--print=all-target-specs-json` and similar queries.
352 ///
353 /// Normally this is unset, because [`Self::rustc_path`] can be used instead.
354 /// But when running "stage 1" ui-fulldeps tests, `rustc_path` is a stage 0
355 /// compiler, whereas target specs must be obtained from a stage 1+ compiler
356 /// (in case the JSON format has changed since the last bootstrap bump).
357 pub(crate) query_rustc_path: Option<Utf8PathBuf>,
358
359 /// Path to the `rustdoc`-under-test. Like [`Self::rustc_path`], this `rustdoc` is *staged*.
360 pub(crate) rustdoc_path: Option<Utf8PathBuf>,
361
362 /// Path to the `src/tools/coverage-dump/` bootstrap tool executable.
363 pub(crate) coverage_dump_path: Option<Utf8PathBuf>,
364
365 /// Path to the Python 3 executable to use for htmldocck and some run-make tests.
366 pub(crate) python: String,
367
368 /// Path to the `src/tools/jsondocck/` bootstrap tool executable.
369 pub(crate) jsondocck_path: Option<Utf8PathBuf>,
370
371 /// Path to the `src/tools/jsondoclint/` bootstrap tool executable.
372 pub(crate) jsondoclint_path: Option<Utf8PathBuf>,
373
374 /// Path to a host LLVM `FileCheck` executable.
375 pub(crate) llvm_filecheck: Option<Utf8PathBuf>,
376
377 /// Path to a host LLVM bintools directory.
378 ///
379 /// For example:
380 /// - `/home/ferris/rust/build/x86_64-unknown-linux-gnu/llvm/bin`
381 pub(crate) llvm_bin_dir: Option<Utf8PathBuf>,
382
383 /// The path to the **target** `clang` executable to run `clang`-based tests with. If `None`,
384 /// then these tests will be ignored.
385 pub(crate) run_clang_based_tests_with: Option<Utf8PathBuf>,
386
387 /// Path to the directory containing the sources. This corresponds to the root folder of a
388 /// `rust-lang/rust` checkout.
389 ///
390 /// For example:
391 /// - `/home/ferris/rust`
392 ///
393 /// FIXME: this name is confusing, because this is actually `$checkout_root`, **not** the
394 /// `$checkout_root/src/` folder.
395 pub(crate) src_root: Utf8PathBuf,
396
397 /// Absolute path to the test suite directory.
398 ///
399 /// For example:
400 /// - `/home/ferris/rust/tests/ui`
401 /// - `/home/ferris/rust/tests/coverage`
402 pub(crate) src_test_suite_root: Utf8PathBuf,
403
404 /// Path to the top-level build directory used by bootstrap.
405 ///
406 /// For example:
407 /// - `/home/ferris/rust/build`
408 pub(crate) build_root: Utf8PathBuf,
409
410 /// Path to the build directory used by the current test suite.
411 ///
412 /// For example:
413 /// - `/home/ferris/rust/build/x86_64-unknown-linux-gnu/test/ui`
414 /// - `/home/ferris/rust/build/x86_64-unknown-linux-gnu/test/coverage`
415 pub(crate) build_test_suite_root: Utf8PathBuf,
416
417 /// Path to the directory containing the sysroot of the `rustc`-under-test.
418 ///
419 /// For example:
420 /// - `/home/ferris/rust/build/x86_64-unknown-linux-gnu/stage1`
421 /// - `/home/ferris/rust/build/x86_64-unknown-linux-gnu/stage2`
422 ///
423 /// When stage 0 is forced, this will correspond to the sysroot *of* that specified stage 0
424 /// `rustc`.
425 ///
426 /// FIXME: this name is confusing, because it doesn't specify *which* compiler this sysroot
427 /// corresponds to. It's actually the `rustc`-under-test, and not the bootstrap `rustc`, unless
428 /// stage 0 is forced and no custom stage 0 `rustc` was otherwise specified (so that it
429 /// *happens* to run against the bootstrap `rustc`, but this non-custom bootstrap `rustc` case
430 /// is not really supported).
431 pub(crate) sysroot_base: Utf8PathBuf,
432
433 /// The number of the stage under test.
434 pub(crate) stage: u32,
435
436 /// The id of the stage under test (stage1-xxx, etc).
437 ///
438 /// FIXME: reconsider this string; this is hashed for test build stamp.
439 pub(crate) stage_id: String,
440
441 /// The [`TestMode`]. E.g. [`TestMode::Ui`]. Each test mode can correspond to one or more test
442 /// suites.
443 ///
444 /// FIXME: stop using stringly-typed test suites!
445 pub(crate) mode: TestMode,
446
447 /// The test suite.
448 ///
449 /// Example: `tests/ui/` is [`TestSuite::Ui`] test *suite*, which happens to also be of the
450 /// [`TestMode::Ui`] test *mode*.
451 ///
452 /// Note that the same test suite (e.g. `tests/coverage/`) may correspond to multiple test
453 /// modes, e.g. `tests/coverage/` can be run under both [`TestMode::CoverageRun`] and
454 /// [`TestMode::CoverageMap`].
455 pub(crate) suite: TestSuite,
456
457 /// Run ignored tests *unconditionally*, overriding their ignore reason.
458 ///
459 /// FIXME: this is wired up through the test execution logic, but **not** accessible from
460 /// `bootstrap` directly; `compiletest` exposes this as `--ignored`. I.e. you'd have to use `./x
461 /// test $test_suite -- --ignored=true`.
462 pub(crate) run_ignored: bool,
463
464 /// Whether *staged* `rustc`-under-test was built with debug assertions.
465 ///
466 /// FIXME: make it clearer that this refers to the staged `rustc`-under-test, not stage 0
467 /// `rustc`.
468 pub(crate) with_rustc_debug_assertions: bool,
469
470 /// Whether *staged* `std` was built with debug assertions.
471 ///
472 /// FIXME: make it clearer that this refers to the staged `std`, not stage 0 `std`.
473 pub(crate) with_std_debug_assertions: bool,
474
475 /// Whether *staged* `std` was built with remapping of debuginfo.
476 ///
477 /// FIXME: make it clearer that this refers to the staged `std`, not stage 0 `std`.
478 pub(crate) with_std_remap_debuginfo: bool,
479
480 /// Only run tests that match these filters (using `libtest` "test name contains" filter logic).
481 ///
482 /// FIXME(#139660): the current hand-rolled test executor intentionally mimics the `libtest`
483 /// "test name contains" filter matching logic to preserve previous `libtest` executor behavior,
484 /// but this is often not intuitive. We should consider changing that behavior with an MCP to do
485 /// test path *prefix* matching which better corresponds to how `compiletest` `tests/` are
486 /// organized, and how users would intuitively expect the filtering logic to work like.
487 pub(crate) filters: Vec<String>,
488
489 /// Skip tests matching these substrings. The matching logic exactly corresponds to
490 /// [`Self::filters`] but inverted.
491 ///
492 /// FIXME(#139660): ditto on test matching behavior.
493 pub(crate) skip: Vec<String>,
494
495 /// Exactly match the filter, rather than a substring.
496 ///
497 /// FIXME(#139660): ditto on test matching behavior.
498 pub(crate) filter_exact: bool,
499
500 /// Force the pass mode of a check/build/run test to instead use this mode instead.
501 ///
502 /// FIXME: make it even more obvious (especially in PR CI where `--pass=check` is used) when a
503 /// pass mode is forced when the test fails, because it can be very non-obvious when e.g. an
504 /// error is emitted only when `//@ build-pass` but not `//@ check-pass`.
505 pub(crate) force_pass_mode: Option<ForcePassMode>,
506
507 /// Explicitly enable or disable running of the target test binary.
508 ///
509 /// FIXME: this scheme is a bit confusing, and at times questionable. Re-evaluate this run
510 /// scheme.
511 ///
512 /// FIXME: Currently `--run` is a tri-state, it can be `--run={auto,always,never}`, and when
513 /// `--run=auto` is specified, it's run if the platform doesn't end with `-fuchsia`. See
514 /// [`Config::run_enabled`].
515 pub(crate) run: Option<bool>,
516
517 /// A command line to prefix target program execution with, for running under valgrind for
518 /// example, i.e. `$runner target.exe [args..]`. Similar to `CARGO_*_RUNNER` configuration.
519 ///
520 /// Note: this is not to be confused with [`Self::remote_test_client`], which is a different
521 /// scheme.
522 ///
523 /// FIXME: the runner scheme is very under-documented.
524 pub(crate) runner: Option<String>,
525
526 /// Compiler flags to pass to the *staged* `rustc`-under-test when building for the **host**
527 /// platform.
528 pub(crate) host_rustcflags: Vec<String>,
529
530 /// Compiler flags to pass to the *staged* `rustc`-under-test when building for the **target**
531 /// platform.
532 pub(crate) target_rustcflags: Vec<String>,
533
534 /// Whether the *staged* `rustc`-under-test and the associated *staged* `std` has been built
535 /// with randomized struct layouts.
536 pub(crate) rust_randomized_layout: bool,
537
538 /// Whether tests should be optimized by default (`-O`). Individual test suites and test files
539 /// may override this setting.
540 ///
541 /// FIXME: this flag / config option is somewhat misleading. For instance, in ui tests, it's
542 /// *only* applied to the [`PassFailMode::RunPass`] test crate and not its auxiliaries.
543 pub(crate) optimize_tests: bool,
544
545 /// Target platform tuple.
546 pub(crate) target: String,
547
548 /// Host platform tuple.
549 pub(crate) host: String,
550
551 /// Path to / name of the Microsoft Console Debugger (CDB) executable.
552 ///
553 /// FIXME: this is an *opt-in* "override" option. When this isn't provided, we try to conjure a
554 /// cdb by looking at the user's program files on Windows... See `debuggers::find_cdb`.
555 pub(crate) cdb: Option<Utf8PathBuf>,
556
557 /// Version of CDB.
558 ///
559 /// FIXME: `cdb_version` is *derived* from cdb, but it's *not* technically a config!
560 ///
561 /// FIXME: audit cdb version gating.
562 pub(crate) cdb_version: Option<[u16; 4]>,
563
564 /// Path to / name of the GDB executable.
565 ///
566 /// FIXME: the fallback path when `gdb` isn't provided tries to find *a* `gdb` or `gdb.exe` from
567 /// `PATH`, which is... arguably questionable.
568 ///
569 /// FIXME: we are propagating a python from `PYTHONPATH`, not from an explicit config for gdb
570 /// debugger script.
571 pub(crate) gdb: Option<Utf8PathBuf>,
572
573 /// Version of GDB, encoded as ((major * 1000) + minor) * 1000 + patch
574 ///
575 /// FIXME: this gdb version gating scheme is possibly questionable -- gdb does not use semver,
576 /// only its major version is likely materially meaningful, cf.
577 /// <https://sourceware.org/gdb/wiki/Internals%20Versions>. Even the major version I'm not sure
578 /// is super meaningful. Maybe min gdb `major.minor` version gating is sufficient for the
579 /// purposes of debuginfo tests?
580 ///
581 /// FIXME: `gdb_version` is *derived* from gdb, but it's *not* technically a config!
582 pub(crate) gdb_version: Option<u32>,
583
584 /// Path to or name of the LLDB executable to use for debuginfo tests.
585 pub(crate) lldb: Option<Utf8PathBuf>,
586
587 /// Version of LLDB.
588 ///
589 /// FIXME: `lldb_version` is *derived* from lldb, but it's *not* technically a config!
590 pub(crate) lldb_version: Option<LldbVersion>,
591
592 /// Version of LLVM.
593 ///
594 /// FIXME: Audit the fallback derivation of
595 /// [`crate::directives::extract_llvm_version_from_binary`], that seems very questionable?
596 pub(crate) llvm_version: Option<Version>,
597
598 /// Is LLVM a system LLVM.
599 pub(crate) system_llvm: bool,
600
601 /// Path to the android tools.
602 ///
603 /// Note: this is only used for android gdb debugger script in the debuginfo test suite.
604 ///
605 /// FIXME: take a look at this; this is piggy-backing off of gdb code paths but only for
606 /// `arm-linux-androideabi` target.
607 pub(crate) android_cross_path: Option<Utf8PathBuf>,
608
609 /// Extra parameter to run adb on `arm-linux-androideabi`.
610 ///
611 /// FIXME: is this *only* `arm-linux-androideabi`, or is it also for other Tier 2/3 android
612 /// targets?
613 ///
614 /// FIXME: take a look at this; this is piggy-backing off of gdb code paths but only for
615 /// `arm-linux-androideabi` target.
616 pub(crate) adb_path: Option<Utf8PathBuf>,
617
618 /// Extra parameter to run test suite on `arm-linux-androideabi`.
619 ///
620 /// FIXME: is this *only* `arm-linux-androideabi`, or is it also for other Tier 2/3 android
621 /// targets?
622 ///
623 /// FIXME: take a look at this; this is piggy-backing off of gdb code paths but only for
624 /// `arm-linux-androideabi` target.
625 pub(crate) adb_test_dir: Option<Utf8PathBuf>,
626
627 /// Status whether android device available or not. When unavailable, this will cause tests to
628 /// panic when the test binary is attempted to be run.
629 ///
630 /// FIXME: take a look at this; this also influences adb in gdb code paths in a strange way.
631 pub(crate) adb_device_status: bool,
632
633 /// Verbose dump a lot of info.
634 ///
635 /// FIXME: this is *way* too coarse; the user can't select *which* info to verbosely dump.
636 pub(crate) verbose: bool,
637
638 /// Whether to enable verbose subprocess output for run-make tests.
639 /// Set to false to suppress output for passing tests (e.g. for cg_clif with --no-capture).
640 pub verbose_run_make_subprocess_output: bool,
641
642 /// Where to find the remote test client process, if we're using it.
643 ///
644 /// Note: this is *only* used for target platform executables created by `run-make` test
645 /// recipes.
646 ///
647 /// Note: this is not to be confused with [`Self::runner`], which is a different scheme.
648 ///
649 /// FIXME: the `remote_test_client` scheme is very under-documented.
650 pub(crate) remote_test_client: Option<Utf8PathBuf>,
651
652 /// [`CompareMode`] describing what file the actual ui output will be compared to.
653 ///
654 /// FIXME: currently, [`CompareMode`] is a mishmash of lot of things (different borrow-checker
655 /// model, different trait solver, different debugger, etc.).
656 pub(crate) compare_mode: Option<CompareMode>,
657
658 /// If true, this will generate a coverage file with UI test files that run `MachineApplicable`
659 /// diagnostics but are missing `run-rustfix` annotations. The generated coverage file is
660 /// created in `$test_suite_build_root/rustfix_missing_coverage.txt`
661 pub(crate) rustfix_coverage: bool,
662
663 /// Whether to run `enzyme` autodiff tests.
664 pub(crate) has_enzyme: bool,
665
666 /// Whether to run `offload` autodiff tests.
667 pub(crate) has_offload: bool,
668
669 /// The current Rust channel info.
670 ///
671 /// FIXME: treat this more carefully; "stable", "beta" and "nightly" are definitely valid, but
672 /// channel might also be "dev" or such, which should be treated as "nightly".
673 pub(crate) channel: String,
674
675 /// Whether adding git commit information such as the commit hash has been enabled for building.
676 ///
677 /// FIXME: `compiletest` cannot trust `bootstrap` for this information, because `bootstrap` can
678 /// have bugs and had bugs on that logic. We need to figure out how to obtain this e.g. directly
679 /// from CI or via git locally.
680 pub(crate) git_hash: bool,
681
682 /// The default Rust edition.
683 pub(crate) edition: Option<Edition>,
684
685 // Configuration for various run-make tests frobbing things like C compilers or querying about
686 // various LLVM component information.
687 //
688 // FIXME: this really should be better packaged together.
689 // FIXME: these need better docs, e.g. for *host*, or for *target*?
690 pub(crate) cc: String,
691 pub(crate) cxx: String,
692 pub(crate) cflags: String,
693 pub(crate) cxxflags: String,
694 pub(crate) ar: String,
695 pub(crate) target_linker: Option<String>,
696 pub(crate) host_linker: Option<String>,
697 pub(crate) llvm_components: String,
698
699 /// Path to a NodeJS executable. Used for JS doctests, emscripten and WASM tests.
700 pub(crate) nodejs: Option<Utf8PathBuf>,
701
702 /// Whether to rerun tests even if the inputs are unchanged.
703 pub(crate) force_rerun: bool,
704
705 /// Only rerun the tests that result has been modified according to `git status`.
706 ///
707 /// FIXME: this is undocumented.
708 ///
709 /// FIXME: how does this interact with [`Self::force_rerun`]?
710 pub(crate) only_modified: bool,
711
712 // FIXME: these are really not "config"s, but rather are information derived from
713 // `rustc`-under-test. This poses an interesting conundrum: if we're testing the
714 // `rustc`-under-test, can we trust its print request outputs and target cfgs? In theory, this
715 // itself can break or be unreliable -- ideally, we'd be sharing these kind of information not
716 // through `rustc`-under-test's execution output. In practice, however, print requests are very
717 // unlikely to completely break (we also have snapshot ui tests for them). Furthermore, even if
718 // we share them via some kind of static config, that static config can still be wrong! Who
719 // tests the tester? Therefore, we make a pragmatic compromise here, and use information derived
720 // from print requests produced by the `rustc`-under-test.
721 //
722 // FIXME: move them out from `Config`, because they are *not* configs.
723 pub(crate) target_cfgs: OnceLock<TargetCfgs>,
724 pub(crate) builtin_cfg_names: OnceLock<HashSet<String>>,
725 pub(crate) supported_crate_types: OnceLock<HashSet<String>>,
726
727 /// Should we capture console output that would be printed by test runners via their `stdout`
728 /// and `stderr` trait objects, or via the custom panic hook.
729 ///
730 /// The default is `true`. This can be disabled via the compiletest cli flag `--no-capture`
731 /// (which mirrors the libtest `--no-capture` flag).
732 pub(crate) capture: bool,
733
734 /// Needed both to construct [`build_helper::git::GitConfig`].
735 pub(crate) nightly_branch: String,
736 pub(crate) git_merge_commit_email: String,
737
738 /// True if the profiler runtime is enabled for this target. Used by the
739 /// `needs-profiler-runtime` directive in test files.
740 pub(crate) profiler_runtime: bool,
741
742 /// Command for visual diff display, e.g. `diff-tool --color=always`.
743 pub(crate) diff_command: Option<String>,
744
745 /// Path to minicore aux library (`tests/auxiliary/minicore.rs`), used for `no_core` tests that
746 /// need `core` stubs in cross-compilation scenarios that do not otherwise want/need to
747 /// `-Zbuild-std`. Used in e.g. ABI tests.
748 pub(crate) minicore_path: Utf8PathBuf,
749
750 /// Current codegen backend used.
751 pub(crate) default_codegen_backend: CodegenBackend,
752 /// Name/path of the backend to use instead of `default_codegen_backend`.
753 pub(crate) override_codegen_backend: Option<String>,
754 /// Whether to ignore `//@ ignore-backends`.
755 pub(crate) bypass_ignore_backends: bool,
756
757 /// Number of parallel jobs configured for the build.
758 ///
759 /// This is forwarded from bootstrap's `jobs` configuration.
760 pub(crate) jobs: u32,
761
762 /// Number of parallel threads to use for the frontend when building test artifacts.
763 pub(crate) parallel_frontend_threads: u32,
764 /// Number of times to execute each test.
765 pub(crate) iteration_count: u32,
766}
767
768impl Config {
769 pub(crate) const DEFAULT_PARALLEL_FRONTEND_THREADS: u32 = 1;
770 pub(crate) const DEFAULT_ITERATION_COUNT: u32 = 1;
771
772 /// FIXME: this run scheme is... confusing.
773 pub(crate) fn run_enabled(&self) -> bool {
774 self.run.unwrap_or_else(|| {
775 // Auto-detect whether to run based on the platform.
776 !self.target.ends_with("-fuchsia")
777 })
778 }
779
780 pub(crate) fn target_cfgs(&self) -> &TargetCfgs {
781 self.target_cfgs.get_or_init(|| TargetCfgs::new(self))
782 }
783
784 pub(crate) fn target_cfg(&self) -> &TargetCfg {
785 &self.target_cfgs().current
786 }
787
788 pub(crate) fn matches_arch(&self, arch: &str) -> bool {
789 self.target_cfg().arch == arch
790 || {
791 // Matching all the thumb variants as one can be convenient.
792 // (thumbv6m, thumbv7em, thumbv7m, etc.)
793 arch == "thumb" && self.target.starts_with("thumb")
794 }
795 || (arch == "i586" && self.target.starts_with("i586-"))
796 }
797
798 pub(crate) fn matches_os(&self, os: &str) -> bool {
799 self.target_cfg().os == os
800 }
801
802 pub(crate) fn matches_env(&self, env: &str) -> bool {
803 self.target_cfg().env == env
804 }
805
806 pub(crate) fn matches_abi(&self, abi: &str) -> bool {
807 self.target_cfg().abi == abi
808 }
809
810 #[cfg_attr(not(test), expect(dead_code, reason = "only used by tests for `ignore-{family}`"))]
811 pub(crate) fn matches_family(&self, family: &str) -> bool {
812 self.target_cfg().families.iter().any(|f| f == family)
813 }
814
815 pub(crate) fn is_big_endian(&self) -> bool {
816 self.target_cfg().endian == Endian::Big
817 }
818
819 pub(crate) fn get_pointer_width(&self) -> u32 {
820 *&self.target_cfg().pointer_width
821 }
822
823 pub(crate) fn can_unwind(&self) -> bool {
824 self.target_cfg().panic == PanicStrategy::Unwind
825 }
826
827 /// Get the list of builtin, 'well known' cfg names
828 pub(crate) fn builtin_cfg_names(&self) -> &HashSet<String> {
829 self.builtin_cfg_names.get_or_init(|| builtin_cfg_names(self))
830 }
831
832 /// Get the list of crate types that the target platform supports.
833 pub(crate) fn supported_crate_types(&self) -> &HashSet<String> {
834 self.supported_crate_types.get_or_init(|| supported_crate_types(self))
835 }
836
837 pub(crate) fn has_threads(&self) -> bool {
838 // Wasm targets don't have threads unless `-threads` is in the target
839 // name, such as `wasm32-wasip1-threads`.
840 if self.target.starts_with("wasm") {
841 return self.target.contains("threads");
842 }
843 true
844 }
845
846 pub(crate) fn has_asm_support(&self) -> bool {
847 // This should match the stable list in `LoweringContext::lower_inline_asm`.
848 static ASM_SUPPORTED_ARCHS: &[&str] = &[
849 "x86",
850 "x86_64",
851 "arm",
852 "aarch64",
853 "arm64ec",
854 "riscv32",
855 "riscv64",
856 "loongarch32",
857 "loongarch64",
858 "s390x",
859 // These targets require an additional asm_experimental_arch feature.
860 // "nvptx64", "hexagon", "mips", "mips64", "spirv", "wasm32",
861 ];
862 ASM_SUPPORTED_ARCHS.contains(&self.target_cfg().arch.as_str())
863 }
864
865 pub(crate) fn git_config(&self) -> GitConfig<'_> {
866 GitConfig {
867 nightly_branch: &self.nightly_branch,
868 git_merge_commit_email: &self.git_merge_commit_email,
869 }
870 }
871
872 pub(crate) fn has_subprocess_support(&self) -> bool {
873 // FIXME(#135928): compiletest is always a **host** tool. Building and running an
874 // capability detection executable against the **target** is not trivial. The short term
875 // solution here is to hard-code some targets to allow/deny, unfortunately.
876
877 let unsupported_target = self.target_cfg().env == "sgx"
878 || matches!(self.target_cfg().arch.as_str(), "wasm32" | "wasm64")
879 || self.target_cfg().os == "emscripten";
880 !unsupported_target
881 }
882
883 /// Whether the parallel frontend is enabled,
884 /// which is the case when `parallel_frontend_threads` is not set to `1`.
885 ///
886 /// - `0` means auto-detect: use the number of available hardware threads on the host.
887 /// But we treat it as the parallel frontend being enabled in this case.
888 /// - `1` means single-threaded (parallel frontend disabled).
889 /// - `>1` means an explicitly configured thread count.
890 pub(crate) fn parallel_frontend_enabled(&self) -> bool {
891 self.parallel_frontend_threads != 1
892 }
893}
894
895/// Known widths of `target_has_atomic`.
896pub(crate) const KNOWN_TARGET_HAS_ATOMIC_WIDTHS: &[&str] = &["8", "16", "32", "64", "128", "ptr"];
897
898#[derive(Debug, Clone)]
899pub(crate) struct TargetCfgs {
900 pub(crate) current: TargetCfg,
901 pub(crate) all_targets: HashSet<String>,
902 pub(crate) all_archs: HashSet<String>,
903 pub(crate) all_oses: HashSet<String>,
904 pub(crate) all_oses_and_envs: HashSet<String>,
905 pub(crate) all_envs: HashSet<String>,
906 pub(crate) all_abis: HashSet<String>,
907 pub(crate) all_families: HashSet<String>,
908 pub(crate) all_pointer_widths: HashSet<String>,
909 pub(crate) all_rustc_abis: HashSet<String>,
910}
911
912impl TargetCfgs {
913 fn new(config: &Config) -> TargetCfgs {
914 let mut targets: HashMap<String, TargetCfg> = serde_json::from_str(&query_rustc_output(
915 config,
916 &["--print=all-target-specs-json", "-Zunstable-options"],
917 Default::default(),
918 ))
919 .unwrap();
920
921 let mut all_targets = HashSet::new();
922 let mut all_archs = HashSet::new();
923 let mut all_oses = HashSet::new();
924 let mut all_oses_and_envs = HashSet::new();
925 let mut all_envs = HashSet::new();
926 let mut all_abis = HashSet::new();
927 let mut all_families = HashSet::new();
928 let mut all_pointer_widths = HashSet::new();
929 // NOTE: for distinction between `abi` and `rustc_abi`, see comment on
930 // `TargetCfg::rustc_abi`.
931 let mut all_rustc_abis = HashSet::new();
932
933 // If current target is not included in the `--print=all-target-specs-json` output,
934 // we check whether it is a custom target from the user or a synthetic target from bootstrap.
935 if !targets.contains_key(&config.target) {
936 let mut envs: HashMap<String, String> = HashMap::new();
937
938 if let Ok(t) = std::env::var("RUST_TARGET_PATH") {
939 envs.insert("RUST_TARGET_PATH".into(), t);
940 }
941
942 // This returns false only when the target is neither a synthetic target
943 // nor a custom target from the user, indicating it is most likely invalid.
944 if config.target.ends_with(".json") || !envs.is_empty() {
945 targets.insert(
946 config.target.clone(),
947 serde_json::from_str(&query_rustc_output(
948 config,
949 &[
950 "--print=target-spec-json",
951 "-Zunstable-options",
952 "--target",
953 &config.target,
954 ],
955 envs,
956 ))
957 .unwrap(),
958 );
959 }
960 }
961
962 for (target, cfg) in targets.iter() {
963 all_archs.insert(cfg.arch.clone());
964 all_oses.insert(cfg.os.clone());
965 all_oses_and_envs.insert(cfg.os_and_env());
966 all_envs.insert(cfg.env.clone());
967 all_abis.insert(cfg.abi.clone());
968 for family in &cfg.families {
969 all_families.insert(family.clone());
970 }
971 all_pointer_widths.insert(format!("{}bit", cfg.pointer_width));
972 if let Some(rustc_abi) = &cfg.rustc_abi {
973 all_rustc_abis.insert(rustc_abi.clone());
974 }
975 all_targets.insert(target.clone());
976 }
977
978 Self {
979 current: Self::get_current_target_config(config, &targets),
980 all_targets,
981 all_archs,
982 all_oses,
983 all_oses_and_envs,
984 all_envs,
985 all_abis,
986 all_families,
987 all_pointer_widths,
988 all_rustc_abis,
989 }
990 }
991
992 fn get_current_target_config(
993 config: &Config,
994 targets: &HashMap<String, TargetCfg>,
995 ) -> TargetCfg {
996 let mut cfg = targets[&config.target].clone();
997
998 // To get the target information for the current target, we take the target spec obtained
999 // from `--print=all-target-specs-json`, and then we enrich it with the information
1000 // gathered from `--print=cfg --target=$target`.
1001 //
1002 // This is done because some parts of the target spec can be overridden with `-C` flags,
1003 // which are respected for `--print=cfg` but not for `--print=all-target-specs-json`. The
1004 // code below extracts them from `--print=cfg`: make sure to only override fields that can
1005 // actually be changed with `-C` flags.
1006 for config in query_rustc_output(
1007 config,
1008 // `-Zunstable-options` is necessary when compiletest is running with custom targets
1009 // (such as synthetic targets used to bless mir-opt tests).
1010 &["-Zunstable-options", "--print=cfg", "--target", &config.target],
1011 Default::default(),
1012 )
1013 .trim()
1014 .lines()
1015 {
1016 let (name, value) = config
1017 .split_once("=\"")
1018 .map(|(name, value)| {
1019 (
1020 name,
1021 Some(
1022 value
1023 .strip_suffix('\"')
1024 .expect("key-value pair should be properly quoted"),
1025 ),
1026 )
1027 })
1028 .unwrap_or_else(|| (config, None));
1029
1030 match (name, value) {
1031 // Can be overridden with `-C panic=$strategy`.
1032 ("panic", Some("abort")) => cfg.panic = PanicStrategy::Abort,
1033 ("panic", Some("unwind")) => cfg.panic = PanicStrategy::Unwind,
1034 ("panic", other) => panic!("unexpected value for panic cfg: {other:?}"),
1035
1036 ("target_has_atomic", Some(width))
1037 if KNOWN_TARGET_HAS_ATOMIC_WIDTHS.contains(&width) =>
1038 {
1039 cfg.target_has_atomic.insert(width.to_string());
1040 }
1041 ("target_has_atomic", Some(other)) => {
1042 panic!("unexpected value for `target_has_atomic` cfg: {other:?}")
1043 }
1044 // Nightly-only std-internal impl detail.
1045 ("target_has_atomic", None) => {}
1046 _ => {}
1047 }
1048 }
1049
1050 cfg
1051 }
1052}
1053
1054#[derive(Clone, Debug, serde::Deserialize)]
1055#[serde(rename_all = "kebab-case")]
1056pub(crate) struct TargetCfg {
1057 pub(crate) arch: String,
1058 #[serde(default = "default_os")]
1059 pub(crate) os: String,
1060 #[serde(default)]
1061 pub(crate) env: String,
1062 #[serde(default)]
1063 pub(crate) abi: String,
1064 #[serde(rename = "target-family", default)]
1065 pub(crate) families: Vec<String>,
1066 #[serde(rename = "target-pointer-width")]
1067 pub(crate) pointer_width: u32,
1068 #[serde(rename = "target-endian", default)]
1069 endian: Endian,
1070 #[serde(rename = "panic-strategy", default)]
1071 pub(crate) panic: PanicStrategy,
1072 #[serde(default)]
1073 pub(crate) dynamic_linking: bool,
1074 #[serde(rename = "supported-sanitizers", default)]
1075 pub(crate) sanitizers: Vec<Sanitizer>,
1076 #[serde(rename = "supports-xray", default)]
1077 pub(crate) xray: bool,
1078 #[serde(default = "default_reloc_model")]
1079 pub(crate) relocation_model: String,
1080 // NOTE: `rustc_abi` should not be confused with `abi`. `rustc_abi` was introduced in #137037 to
1081 // make SSE2 *required* by the ABI (kind of a hack to make a target feature *required* via the
1082 // target spec).
1083 pub(crate) rustc_abi: Option<String>,
1084
1085 /// ELF is the "default" binary format, so the compiler typically doesn't
1086 /// emit a `"binary-format"` field for ELF targets.
1087 ///
1088 /// See `impl ToJson for Target` in `compiler/rustc_target/src/spec/json.rs`.
1089 #[serde(default = "default_binary_format_elf")]
1090 pub(crate) binary_format: Cow<'static, str>,
1091
1092 // Not present in target cfg json output, additional derived information.
1093 #[serde(skip)]
1094 /// Supported target atomic widths: e.g. `8` to `128` or `ptr`. This is derived from the builtin
1095 /// `target_has_atomic` `cfg`s e.g. `target_has_atomic="8"`.
1096 pub(crate) target_has_atomic: BTreeSet<String>,
1097}
1098
1099impl TargetCfg {
1100 pub(crate) fn os_and_env(&self) -> String {
1101 format!("{}-{}", self.os, self.env)
1102 }
1103}
1104
1105fn default_os() -> String {
1106 "none".into()
1107}
1108
1109fn default_reloc_model() -> String {
1110 "pic".into()
1111}
1112
1113fn default_binary_format_elf() -> Cow<'static, str> {
1114 Cow::Borrowed("elf")
1115}
1116
1117#[derive(Eq, PartialEq, Clone, Debug, Default, serde::Deserialize)]
1118#[serde(rename_all = "kebab-case")]
1119pub(crate) enum Endian {
1120 #[default]
1121 Little,
1122 Big,
1123}
1124
1125fn builtin_cfg_names(config: &Config) -> HashSet<String> {
1126 query_rustc_output(
1127 config,
1128 &["--print=check-cfg", "-Zunstable-options", "--check-cfg=cfg()"],
1129 Default::default(),
1130 )
1131 .lines()
1132 .map(|l| extract_cfg_name(&l).unwrap().to_string())
1133 .chain(std::iter::once(String::from("test")))
1134 .collect()
1135}
1136
1137/// Extract the cfg name from `cfg(name, values(...))` lines
1138fn extract_cfg_name(check_cfg_line: &str) -> Result<&str, &'static str> {
1139 let trimmed = check_cfg_line.trim();
1140
1141 #[rustfmt::skip]
1142 let inner = trimmed
1143 .strip_prefix("cfg(")
1144 .ok_or("missing cfg(")?
1145 .strip_suffix(")")
1146 .ok_or("missing )")?;
1147
1148 let first_comma = inner.find(',').ok_or("no comma found")?;
1149
1150 Ok(inner[..first_comma].trim())
1151}
1152
1153pub(crate) const KNOWN_CRATE_TYPES: &[&str] =
1154 &["bin", "cdylib", "dylib", "lib", "proc-macro", "rlib", "staticlib"];
1155
1156fn supported_crate_types(config: &Config) -> HashSet<String> {
1157 let crate_types: HashSet<_> = query_rustc_output(
1158 config,
1159 &["--target", &config.target, "--print=supported-crate-types", "-Zunstable-options"],
1160 Default::default(),
1161 )
1162 .lines()
1163 .map(|l| l.to_string())
1164 .collect();
1165
1166 for crate_type in crate_types.iter() {
1167 assert!(
1168 KNOWN_CRATE_TYPES.contains(&crate_type.as_str()),
1169 "unexpected crate type `{}`: known crate types are {:?}",
1170 crate_type,
1171 KNOWN_CRATE_TYPES
1172 );
1173 }
1174
1175 crate_types
1176}
1177
1178pub(crate) fn query_rustc_output(
1179 config: &Config,
1180 args: &[&str],
1181 envs: HashMap<String, String>,
1182) -> String {
1183 let query_rustc_path = config.query_rustc_path.as_deref().unwrap_or(&config.rustc_path);
1184
1185 let mut command = Command::new(query_rustc_path);
1186 add_dylib_path(&mut command, iter::once(&config.host_compile_lib_path));
1187 command.args(&config.target_rustcflags).args(args);
1188 command.env("RUSTC_BOOTSTRAP", "1");
1189 command.envs(envs);
1190
1191 let output = match command.output() {
1192 Ok(output) => output,
1193 Err(e) => {
1194 fatal!("failed to run {command:?}: {e}");
1195 }
1196 };
1197 if !output.status.success() {
1198 fatal!(
1199 "failed to run {command:?}\n--- stdout\n{}\n--- stderr\n{}",
1200 String::from_utf8(output.stdout).unwrap(),
1201 String::from_utf8(output.stderr).unwrap(),
1202 );
1203 }
1204 String::from_utf8(output.stdout).unwrap()
1205}
1206
1207/// Path information for a single test file.
1208#[derive(Debug, Clone)]
1209pub(crate) struct TestPaths {
1210 /// Full path to the test file.
1211 ///
1212 /// For example:
1213 /// - `/home/ferris/rust/tests/ui/warnings/hello-world.rs`
1214 ///
1215 /// ---
1216 ///
1217 /// For `run-make` tests, this path is the _directory_ that contains
1218 /// `rmake.rs`.
1219 ///
1220 /// For example:
1221 /// - `/home/ferris/rust/tests/run-make/emit`
1222 pub(crate) file: Utf8PathBuf,
1223
1224 /// Subset of the full path that excludes the suite directory and the
1225 /// test filename. For tests in the root of their test suite directory,
1226 /// this is blank.
1227 ///
1228 /// For example:
1229 /// - `file`: `/home/ferris/rust/tests/ui/warnings/hello-world.rs`
1230 /// - `relative_dir`: `warnings`
1231 pub(crate) relative_dir: Utf8PathBuf,
1232}
1233
1234/// Used by `ui` tests to generate things like `foo.stderr` from `foo.rs`.
1235pub(crate) fn expected_output_path(
1236 testpaths: &TestPaths,
1237 revision: Option<&str>,
1238 compare_mode: &Option<CompareMode>,
1239 kind: &str,
1240) -> Utf8PathBuf {
1241 assert!(UI_EXTENSIONS.contains(&kind));
1242 let mut parts = Vec::new();
1243
1244 if let Some(x) = revision {
1245 parts.push(x);
1246 }
1247 if let Some(ref x) = *compare_mode {
1248 parts.push(x.to_str());
1249 }
1250 parts.push(kind);
1251
1252 let extension = parts.join(".");
1253 testpaths.file.with_extension(extension)
1254}
1255
1256pub(crate) const UI_EXTENSIONS: &[&str] = &[
1257 UI_STDERR,
1258 UI_SVG,
1259 UI_WINDOWS_SVG,
1260 UI_STDOUT,
1261 UI_FIXED,
1262 UI_RUN_STDERR,
1263 UI_RUN_STDOUT,
1264 UI_STDERR_64,
1265 UI_STDERR_32,
1266 UI_STDERR_16,
1267 UI_COVERAGE,
1268 UI_COVERAGE_MAP,
1269];
1270pub(crate) const UI_STDERR: &str = "stderr";
1271pub(crate) const UI_SVG: &str = "svg";
1272pub(crate) const UI_WINDOWS_SVG: &str = "windows.svg";
1273pub(crate) const UI_STDOUT: &str = "stdout";
1274pub(crate) const UI_FIXED: &str = "fixed";
1275pub(crate) const UI_RUN_STDERR: &str = "run.stderr";
1276pub(crate) const UI_RUN_STDOUT: &str = "run.stdout";
1277pub(crate) const UI_STDERR_64: &str = "64bit.stderr";
1278pub(crate) const UI_STDERR_32: &str = "32bit.stderr";
1279pub(crate) const UI_STDERR_16: &str = "16bit.stderr";
1280pub(crate) const UI_COVERAGE: &str = "coverage";
1281pub(crate) const UI_COVERAGE_MAP: &str = "cov-map";
1282
1283/// Absolute path to the directory where all output for all tests in the given `relative_dir` group
1284/// should reside. Example:
1285///
1286/// ```text
1287/// /path/to/build/host-tuple/test/ui/relative/
1288/// ```
1289///
1290/// This is created early when tests are collected to avoid race conditions.
1291pub(crate) fn output_relative_path(config: &Config, relative_dir: &Utf8Path) -> Utf8PathBuf {
1292 config.build_test_suite_root.join(relative_dir)
1293}
1294
1295/// Generates a unique name for the test, such as `testname.revision.mode`.
1296pub(crate) fn output_testname_unique(
1297 config: &Config,
1298 testpaths: &TestPaths,
1299 variant: &TestVariant,
1300) -> Utf8PathBuf {
1301 let mode = config.compare_mode.as_ref().map_or("", |m| m.to_str());
1302 let debugger = variant.debugger.as_ref().map_or("", |m| m.to_str());
1303 Utf8PathBuf::from(&testpaths.file.file_stem().unwrap())
1304 .with_extra_extension(config.mode.output_dir_disambiguator())
1305 .with_extra_extension(variant.revision().unwrap_or(""))
1306 .with_extra_extension(mode)
1307 .with_extra_extension(debugger)
1308}
1309
1310/// Absolute path to the directory where all output for the given
1311/// test/revision should reside. Example:
1312/// /path/to/build/host-tuple/test/ui/relative/testname.revision.mode/
1313pub(crate) fn output_base_dir(
1314 config: &Config,
1315 testpaths: &TestPaths,
1316 variant: &TestVariant,
1317) -> Utf8PathBuf {
1318 output_relative_path(config, &testpaths.relative_dir)
1319 .join(output_testname_unique(config, testpaths, variant))
1320}
1321
1322/// Absolute path to the base filename used as output for the given
1323/// test/revision. Example:
1324/// /path/to/build/host-tuple/test/ui/relative/testname.revision.mode/testname
1325pub(crate) fn output_base_name(
1326 config: &Config,
1327 testpaths: &TestPaths,
1328 variant: &TestVariant,
1329) -> Utf8PathBuf {
1330 output_base_dir(config, testpaths, variant).join(testpaths.file.file_stem().unwrap())
1331}
1332
1333/// Absolute path to the directory to use for incremental compilation. Example:
1334/// /path/to/build/host-tuple/test/ui/relative/testname.mode/testname.inc
1335pub(crate) fn incremental_dir(
1336 config: &Config,
1337 testpaths: &TestPaths,
1338 variant: &TestVariant,
1339) -> Utf8PathBuf {
1340 output_base_name(config, testpaths, variant).with_extension("inc")
1341}