Skip to main content

rucc_driver/
lib.rs

1//! The driver: command line parsing, the phase graph, job scheduling and the linker
2//! invocation.
3//!
4//! Design: `spec/04-driver-and-cli.md`. Layer rank 13, see `spec/18-package-layout.md`.
5//!
6//! This is the only crate that is allowed to know the process exists. It reads the command
7//! line, touches the file system, spawns the linker and writes to the terminal, and it hands
8//! everything below it a [`Session`]. The binary crate is a `main` that calls
9//! [`run`] and nothing else, so that the whole driver is reachable from a test.
10//!
11//! # Status
12//!
13//! `--help`, `--version` and `--print-config` are real, which is the `M0` exit criterion in
14//! `spec/17-milestones.md`. The phase graph is real and `-###` prints it, and the scheduler
15//! that will run it is real and tested.
16//!
17//! Two phases run. `-E` reads the file, runs phase 4 over it and writes the result, to `-o` or
18//! to standard output. `--emit=tast` carries on through phase 7, the parse and the checking,
19//! and writes the typed tree. The flags those two read are real with them, which is `-D`, `-U`,
20//! `-I`, `-I-`, `-iquote`, `-isystem`, `-idirafter`, `-iprefix`, `-iwithprefix`,
21//! `-iwithprefixbefore`, `-include`, `-imacros`, `--sysroot=`, `-isysroot`, `-P`, `-std=`,
22//! `-fgnuc-version=`, `-ansi`, `-ffreestanding`, `-fno-builtin`, `-fno-builtin-<name>`,
23//! `-fgnu89-inline`, `-pedantic` and `-Werror`.
24//! The phases after them still say they are not implemented.
25//!
26//! This crate is tier 3 in `spec/18-package-layout.md` section 18.5: its Rust API is
27//! explicitly unstable and will change without a major version bump.
28
29#![doc(html_root_url = "https://docs.rs/rucc-driver/0.10.40")]
30
31pub mod cache;
32pub mod compile;
33pub mod deps;
34pub mod fetch;
35pub mod install;
36pub mod library;
37pub mod link;
38mod map;
39pub mod phase;
40pub mod preprocess;
41pub mod schedule;
42
43use std::fmt::Write as _;
44use std::io::Write as _;
45use std::path::PathBuf;
46
47use rucc_codegen::coverage::{self, Fired};
48use rucc_codegen::pressure::Pressure;
49use rucc_pp::Dependency;
50use rucc_session::{
51    Compress, Control, Dumps, EmitKind, Hook, Options, Pic, PrefixMap, Preinclude, Protector,
52    SaveTemps, Session, Std, Wrapping, runtime,
53};
54use rucc_sysroot::{Manifest, Sysroot};
55use rucc_target::{ObjectFormat, Triple};
56use rucc_tuple::TargetTuple;
57
58use crate::link::LinkOptions;
59
60pub use crate::compile::{Artifact, Compiled, Temps, compile, compile_ir};
61pub use crate::phase::{ArchiveJob, Input, InputKind, Job, LinkJob, Output, Phase, Plan};
62pub use crate::preprocess::{OsFileSystem, Preprocessed, preprocess};
63pub use crate::schedule::Jobs;
64
65/// The compiler's version, taken from the workspace manifest.
66pub const VERSION: &str = env!("CARGO_PKG_VERSION");
67
68/// What the command line asked for.
69#[derive(Debug, Clone, PartialEq, Eq)]
70pub enum Action {
71    /// Print usage and exit successfully.
72    Help,
73    /// Print the version and exit successfully.
74    Version,
75    /// Print one line and exit successfully, which is what the `-dump` and `-print` family do.
76    ///
77    /// A build system asks these before it compiles anything, and what it does with the answer
78    /// is paste it into a path or into another command line, so each one is a single line with
79    /// no decoration around it.
80    Print(String),
81    /// Print the resolved configuration and exit successfully.
82    PrintConfig(Box<Options>),
83    /// Print the passes the level will run and exit successfully.
84    PrintPipeline(Box<Options>),
85    /// Print the phase plan and the link line and exit successfully, which is `-###`.
86    PrintPlan {
87        /// The resolved options, which is what says what the link line is for.
88        opts: Box<Options>,
89        /// What to do to each input, and in what order.
90        plan: Box<Plan>,
91        /// What the command line said about linking.
92        link: Box<LinkOptions>,
93    },
94    /// `--fetch <tuple>`, which gets the sysroot this release pins for a target and installs it.
95    ///
96    /// The only action in this compiler that may run another program to move bytes onto the
97    /// machine, which is `spec/cross-compile/13-distribution.md` section 13.8's rule rather than a
98    /// property of how this happens to be written: a compilation has no branch that reaches it.
99    Fetch {
100        /// The artifact, from the table in [`rucc_sysroot::artifact`]. Resolved here rather than where the
101        /// work happens, so that a target nothing is pinned for is a refusal from the parser like
102        /// every other thing a command line can ask for and not have.
103        what: &'static rucc_sysroot::Pinned,
104        /// The target, which names the directory under the cache the tree is installed at and is
105        /// checked against the record inside the artifact.
106        target: TargetTuple,
107        /// Where the cache is, read where everything else that needs it reads it.
108        cache: PathBuf,
109    },
110    /// Compile the given inputs.
111    Compile {
112        /// The resolved options.
113        opts: Box<Options>,
114        /// What to do to each input, and in what order.
115        plan: Box<Plan>,
116        /// What the command line said about linking.
117        link: Box<LinkOptions>,
118        /// How many translation units to compile at once.
119        jobs: Jobs,
120        /// Whether `-v` asked for the plan to be printed while it runs.
121        verbose: bool,
122    },
123}
124
125/// Why a command line was rejected.
126#[derive(Debug, Clone, PartialEq, Eq)]
127pub struct CliError {
128    /// The message, lowercase and without a trailing period, in the same shape as any other
129    /// diagnostic.
130    pub message: String,
131}
132
133impl std::fmt::Display for CliError {
134    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
135        f.write_str(&self.message)
136    }
137}
138
139impl std::error::Error for CliError {}
140
141fn err(message: impl Into<String>) -> CliError {
142    CliError { message: message.into() }
143}
144
145/// The two halves of one prefix mapping flag's argument, where `flag` includes its trailing `=`.
146///
147/// The split is at the last `=` in what follows the flag, not the first, which is gcc's rule and
148/// the only one that lets a directory whose name contains an `=` be the old half. It also means
149/// `-fmacro-prefix-map=a=b=c` rewrites `a=b` to `c` rather than `a` to `b=c`, which looks like a
150/// trap until you notice the alternative traps the far more common case.
151fn rewrite<'a>(arg: &'a str, flag: &str) -> Result<(&'a str, &'a str), CliError> {
152    let rest = &arg[flag.len()..];
153    PrefixMap::split(rest).ok_or_else(|| {
154        let flag = flag.trim_end_matches('=');
155        err(format!(
156            "`{rest}` is not a rewrite for `{flag}`, which is an old prefix, an `=` and a new one"
157        ))
158    })
159}
160
161/// A question the command line asked instead of asking for a compilation.
162///
163/// These are answered after the loop rather than where they are read, because every one of them
164/// is about the target or about the library search and the last word on both is the end of the
165/// command line.
166enum Query {
167    /// `-dumpmachine`, the triple.
168    Machine,
169    /// `-dumpversion` and `-dumpfullversion`, which are the same three numbers here.
170    Version,
171    /// `-print-multiarch`, the directory name a distribution files this target under.
172    Multiarch,
173    /// `-print-search-dirs`, in the three lines GCC prints.
174    SearchDirs,
175    /// `-print-sysroot`, the root the headers and the libraries are read under.
176    Sysroot,
177    /// `-print-sysroot-provenance`, what is in that root and where each of it came from.
178    SysrootProvenance,
179    /// `-print-sysroot-digest`, the one number that names all of it.
180    SysrootDigest,
181    /// `-print-file-name=<name>`, the full path of a library file.
182    FileName(String),
183    /// `-print-prog-name=<name>`, the full path of a program.
184    ProgName(String),
185    /// `-print-libgcc-file-name`, which is `-print-file-name=libgcc.a` under another spelling.
186    Libgcc,
187}
188
189/// Usage text.
190///
191/// Deliberately short. `spec/04-driver-and-cli.md` puts the full flag reference in the
192/// manual page, because a `--help` nobody can read in one screen is a `--help` nobody reads.
193pub const USAGE: &str = "\
194rucc, an optimizing C compiler
195
196usage: rucc [options] file...
197
198options:
199  -c                     compile and assemble, do not link
200  -S                     compile only, emit assembly
201  -E                     preprocess only
202  -o <file>              write output to <file>, or to standard output for -
203  -D <name>[=<value>], -U <name>      define a macro, or undefine one after every -D
204  -I <dir>               add <dir> to the include search path
205  -iquote -isystem -idirafter <dir>   the other chains, -nostdinc drops ours
206  -I-, -iprefix <p>, -iwithprefix[before] <dir>   the older spellings of those
207  -include <file>, -imacros <file>    read <file> first, the second for its macros only
208  --sysroot=<dir>        look for the library's headers under <dir>, -isysroot too
209  -P, -dM                with -E: leave out the markers, or dump the macros
210  -M -MM -MD -MMD        write a make rule for the source, the last two compile as well
211  -MF <file> -MT <t> -MQ <t> -MP   where the rule goes, what it builds, targets with no recipe
212  -std=<dialect>         c89 through c23, and the gnu spellings
213  -fgnuc-version=<v>     the GCC release to claim, default 7.0.0
214  -x <lang>              treat later inputs as <lang>, or none to stop
215  -O<level>              optimize: 0, 1, 2, 3, s, z
216  -fsafety=<tier>        check memory safety: off, detect, enforce, kernel
217  -f[no-]sanitize=<what>   the negative is taken, the positive is refused by name
218  -f[no-]safety-subobject   a write has to stay inside the member it names
219  -f[no-]safety-restrict    two restrict pointers of one block may not meet
220  -f<pass> -fno-<pass> -fdump-ir=<what> -fopt-info[-<kind>][=FILE]
221  -fpass-fuel=<pass>=<n>, -fpass-fuel-global=<n>   stop a pass, or all of them, after n
222  -fdisable-<pass>[=<funcs>], -fenable-<pass>[=<funcs>]   run a pass on some functions only
223  -g -g0 -gdwarf-5, -fno-omit-frame-pointer, -mno-red-zone   debug info, frame pointer, red zone
224  -gz[=none|zlib|zlib-gnu|zstd] -gno-split-dwarf   compress debug sections, one file not two
225  -flto[=auto|jobserver|<n>] -fno-lto -ffat-lto-objects   read, and not done yet
226  -fprofile-use[=<path>] -fprofile-dir=<dir>   read too, where -fprofile-generate is refused
227  -f[no-]stack-protector[-strong|-all], -f[no-]stack-clash-protection, -fcf-protection=<edges>
228  -ffunction-sections -fdata-sections   a section per function or variable, for --gc-sections
229  -fvisibility=<what>    default, hidden, internal or protected, when nothing in the source said
230  -l<name>, -L <dir>, -B <dir>   link a library, where to look for one, where our own tools are
231  -fPIC -fpic -fPIE -fpie, -fno-common, -pipe   what it does anyway
232  -f[no-]strict-aliasing, -f[no-]delete-null-pointer-checks   what it assumes anyway
233  -static -shared -pie -no-pie -nostdlib -nostartfiles -nodefaultlibs -rdynamic -s   how to link
234  -Wl,<arg>, -Xlinker <arg>, -fuse-ld=<name>   hand an argument to the linker, or pick one
235  -Werror -pedantic -pedantic-errors -w   how much to say, and whether it is fatal
236  -m64 -march= -mtune= -mcpu= -mabi= -mcmodel=   what machine to generate for
237  -pg -p, -mfentry -mno-fentry   call a profiler on the way in, and where that call goes
238  -fpatchable-function-entry=<n>[,<m>]   room at the top of every function to patch later
239  -fwrapv, -fwrapv-pointer, -fno-strict-overflow   signed or pointer overflow wraps
240  -ftrapv                signed overflow stops the program instead
241  -f[no-]signed-char, -f[no-]unsigned-char, -f[no-]short-enums   change the ABI
242  -ffp-contract=<how>    fuse a multiply and an addition: fast, on or off
243  -fexcess-precision=<how>, -f[no-]rounding-math, -f[no-]trapping-math   what may be folded
244  -ffile-prefix-map=<old>=<new>   rewrite that front of every path we put in the output
245  -fmacro-prefix-map= -fdebug-prefix-map= -fprofile-prefix-map=   the same, one output each
246  -pthread               build for more than one thread, and link the library for it
247  -dumpmachine -dumpversion -print-multiarch -print-search-dirs   what this compiler is
248  -print-file-name=<name> -print-prog-name=<name>   where a file or a program is
249  -print-sysroot         the root the headers and the libraries are read under
250  -print-sysroot-provenance   every input under it, where it came from and its licence
251  -print-sysroot-digest   the sha256 of that record, which names the whole sysroot in one line
252  --fetch <tuple>        get the sysroot this release pins for <tuple> and install it in the cache
253  --offline              never download anything, which a compilation never does anyway
254  -j[n]                  compile n translation units at once, default all
255  -v, -###               print each phase as it runs, or without running any
256  -save-temps[=cwd|obj], -time   keep the .i and the .s, say how long each step took
257  --target=<triple>      generate code for <triple>
258  --emit=<kind>          exe, obj, archive, asm, preprocessed, tast, ir, mir-final,
259                         safety-summary, type-granules
260  --print-config, --print-pipeline    print the configuration or the pipeline, and exit
261  --version              print the version and exit
262  -h, --help             print this message and exit
263
264See spec/04-driver-and-cli.md for the full flag reference.
265";
266
267/// The argument of a flag that may be joined to it or may be the next word.
268///
269/// `-DFOO` and `-D FOO` are the same thing, and `at` is where the flag's own letters end.
270fn joined_or_next(
271    arg: &str,
272    at: usize,
273    args: &[String],
274    i: &mut usize,
275) -> Result<String, CliError> {
276    if arg.len() > at {
277        return Ok(arg[at..].to_owned());
278    }
279    let next = args.get(*i).ok_or_else(|| err(format!("{arg} requires an argument")))?;
280    *i += 1;
281    Ok(next.clone())
282}
283
284/// Every name that may follow `-fsanitize=`, which is gcc 16's list and three of this compiler's
285/// own.
286///
287/// The three are on it because `spec/07-types-and-semantics.md` section 7.7 already promises them:
288/// each undefined behaviour this compiler exploits is listed there with the check that detects it,
289/// and `alias`, `restrict` and `memory` are checks gcc has no spelling for. gcc refuses `memory`
290/// outright, since the sanitizer of that name is clang's. A name being here means it is a name
291/// rather than a typo, and nothing more than that: every one of them is refused after the loop,
292/// because none of them is implemented.
293///
294/// `all` is deliberately absent. gcc takes it only in the negative, so it is handled where each of
295/// those two spellings is read rather than by being on this list.
296const SANITIZERS: [&str; 34] = [
297    "address",
298    "kernel-address",
299    "hwaddress",
300    "kernel-hwaddress",
301    "pointer-compare",
302    "pointer-subtract",
303    "thread",
304    "leak",
305    "undefined",
306    "shift",
307    "shift-base",
308    "shift-exponent",
309    "integer-divide-by-zero",
310    "unreachable",
311    "vla-bound",
312    "null",
313    "return",
314    "signed-integer-overflow",
315    "bounds",
316    "bounds-strict",
317    "alignment",
318    "object-size",
319    "float-divide-by-zero",
320    "float-cast-overflow",
321    "nonnull-attribute",
322    "returns-nonnull-attribute",
323    "bool",
324    "enum",
325    "vptr",
326    "pointer-overflow",
327    "builtin",
328    "alias",
329    "restrict",
330    "memory",
331];
332
333/// Parses a command line, without the program name.
334///
335/// # Errors
336///
337/// Returns the message to print when the arguments do not name a compilation this compiler
338/// can attempt.
339pub fn parse_args(args: &[String]) -> Result<Action, CliError> {
340    let host = Triple::host()
341        .ok_or_else(|| err("this host is not a supported target and no --target was given"))?;
342    let mut opts = Options::new(host);
343    let mut inputs: Vec<Input> = Vec::new();
344    let mut print_config = false;
345    let mut print_pipeline = false;
346    let mut print_plan = false;
347    let mut verbose = false;
348    let mut jobs = Jobs::default();
349    let mut nostdinc = false;
350    let mut sysroot: Option<PathBuf> = None;
351    // The whole ten field target, kept beside the three field one because `--target=` can pin a
352    // libc version and `Triple` has nowhere to put it. It decides `__GLIBC_MINOR__` and nothing
353    // else today, and `None` is a command line that named no target, which is this machine.
354    let mut pinned: Option<TargetTuple> = None;
355    let mut output = None;
356    let mut link = LinkOptions::default();
357    let mut query: Option<Query> = None;
358    // What `--fetch` named, and whether `--offline` forbade it. Both are weighed after the loop
359    // because either can be written after the other.
360    let mut fetch: Option<String> = None;
361    let mut offline = false;
362    let mut threads = false;
363    // Which sanitizers are still asked for by the end of the command line. Accumulated across the
364    // loop rather than answered where it was read, because `-fno-sanitize=` turns one off and a
365    // build that asks for a check and then takes it back has asked for nothing. What happens to a
366    // set that is not empty is decided after the loop.
367    let mut sanitizers: Vec<&str> = Vec::new();
368    // `-x` applies to inputs that come after it and stays in effect until the next one, which
369    // is why it is tracked across the loop rather than attached to a single argument.
370    let mut forced: Option<InputKind> = None;
371    // What `-iprefix` last said, stuck on the front of every later `-iwithprefix`. It applies to
372    // the flags after it and not the ones before, so a command line may set it more than once.
373    // GCC's default is its own installed header directory with the last component taken off,
374    // which is a path a cross compiler's build system knows and passes; there is no equivalent
375    // here, so with no `-iprefix` the prefix is nothing and `-iwithprefix` names a directory
376    // outright.
377    let mut iprefix = String::new();
378
379    let mut i = 0;
380    while i < args.len() {
381        let arg = args[i].as_str();
382        i += 1;
383        match arg {
384            "-h" | "--help" => return Ok(Action::Help),
385            "--version" => return Ok(Action::Version),
386            // The sysroot fetch, which is weighed after the loop rather than acted on here, because
387            // `--offline` written after it has to be able to forbid it. Both spellings, since a
388            // flag that takes a tuple gets written both ways and neither is a guess at what the
389            // other meant.
390            "--fetch" => {
391                let value = args
392                    .get(i)
393                    .ok_or_else(|| err("--fetch requires the target to get a sysroot for"))?;
394                i += 1;
395                fetch = Some(value.clone());
396            }
397            _ if arg.starts_with("--fetch=") => {
398                fetch = Some(arg["--fetch=".len()..].to_owned());
399            }
400            // Accepted on any command line and only ever read by the fetch, because an ordinary
401            // compile downloads nothing with or without it. So this flag takes nothing away today,
402            // which is the property section 13.2 asks for rather than an omission: a build that
403            // passes it is saying what it expects of this compiler, and what it expects is already
404            // true.
405            "--offline" => offline = true,
406            "--print-config" => print_config = true,
407            "--print-pipeline" => print_pipeline = true,
408            "-###" => print_plan = true,
409            "-v" => verbose = true,
410            // The files a compilation goes through, kept rather than thrown away. The bare
411            // spelling means `=obj` and not `=cwd`, which is not what the manual says and is what
412            // gcc 16 does; `SaveTemps::Object` carries the measurement.
413            "-save-temps" => opts.save_temps = SaveTemps::Object,
414            _ if arg.starts_with("-save-temps=") => {
415                opts.save_temps = arg["-save-temps=".len()..].parse().map_err(err)?;
416            }
417            // How long each step took. A misspelling of this is worth rejecting rather than
418            // ignoring, since a run that says nothing looks like a compilation that took no time.
419            "-time" => opts.time = true,
420            "-c" => opts.emit = EmitKind::Object,
421            "-S" => opts.emit = EmitKind::Asm,
422            "-E" => opts.emit = EmitKind::Preprocessed,
423            "-g" => opts.debug_info = true,
424            // GCC's own levels of how much debug information to write. Zero is none and every
425            // other number is some, and this compiler has one amount, so the numbers above zero
426            // all mean the same thing here. `-ggdb` is the same flag asking for whatever the
427            // debugger on the machine prefers, which is what we emit anyway.
428            "-g0" => opts.debug_info = false,
429            "-g1" | "-g2" | "-g3" | "-ggdb" | "-ggdb1" | "-ggdb2" | "-ggdb3" => {
430                opts.debug_info = true;
431            }
432            // The version of DWARF to write. We write DWARF 5 and nothing else, so a build that
433            // asks for another version is told rather than handed a file it cannot read.
434            "-gdwarf" | "-gdwarf-5" => opts.debug_info = true,
435            _ if arg.starts_with("-gdwarf-") => {
436                return Err(err(format!(
437                    "{arg}: this compiler writes DWARF 5 and no other version, see \
438                     spec/11-debug-info.md"
439                )));
440            }
441            // Whether the debug information goes in a file of its own beside the object. gcc
442            // writes that `.dwo` whether or not it found anything to put in it, which means a
443            // build system that declares the file as an output gets one and a make rule that
444            // depends on it fires. Refused for that reason rather than taken: section 4.1 takes a
445            // flag that changes nothing and refuses one that changes what is produced, and a file
446            // that does not appear is the plainest change of that kind there is. The negative
447            // spelling is taken, because putting it all in the object is what happens anyway.
448            "-gno-split-dwarf" => {}
449            "-gsplit-dwarf" => {
450                return Err(err(format!(
451                    "{arg}: this compiler writes no separate `.dwo` file, and a build that \
452                     expects one beside each object would wait for a file that never arrives, \
453                     see spec/11-debug-info.md"
454                )));
455            }
456            // How the debug sections are compressed. There are none yet, so every answer produces
457            // the same bytes and taking the flag promises nothing that is not kept. The value is
458            // still checked, because a typo in a distribution's flags is worth finding when the
459            // compiler reads it rather than when somebody later wonders why nothing got smaller.
460            // Bare `-gz` means `zlib`, which the manual leaves for the reader to discover.
461            "-gz" => opts.compress = Compress::Zlib,
462            _ if arg.starts_with("-gz=") => {
463                let how = &arg["-gz=".len()..];
464                opts.compress = how.parse().map_err(|()| {
465                    err(format!(
466                        "`{how}` is not a way to compress debug sections, which is none, zlib, \
467                         zlib-gnu or zstd"
468                    ))
469                })?;
470            }
471            "-Werror" => opts.warnings_are_errors = true,
472            // Nothing that is not fatal is said at all. Read at the one place a diagnostic goes
473            // through rather than here, so that a warning `-w` dropped is not counted either.
474            "-w" => opts.warnings = false,
475            "-pedantic-errors" => {
476                opts.pedantic = true;
477                opts.warnings_are_errors = true;
478            }
479            "-P" => opts.line_markers = false,
480            // The dependency family, which section 4.4 calls required because every build system
481            // that generates its own makefiles asks for it. The two that end in `D` write a file
482            // beside the object and let the compilation happen, and the two that do not write to
483            // standard output and stop after it. Nothing here turns the system headers back on
484            // once a flag has turned them off, which is GCC's behaviour and is why `-MM -M` is
485            // `-MM`: the flag asking for fewer of them is the one with something to say.
486            "-M" => {
487                opts.deps.emit = true;
488                opts.deps.instead_of_compiling = true;
489            }
490            "-MM" => {
491                opts.deps.emit = true;
492                opts.deps.instead_of_compiling = true;
493                opts.deps.system_headers = false;
494            }
495            "-MD" => opts.deps.emit = true,
496            "-MMD" => {
497                opts.deps.emit = true;
498                opts.deps.system_headers = false;
499            }
500            "-MP" => opts.deps.phony = true,
501            // These three take a word and only in the separated form, which is how GCC spells
502            // them and how every build system writes them.
503            "-MF" | "-MT" | "-MQ" => {
504                let value =
505                    args.get(i).ok_or_else(|| err(format!("{arg} requires an argument")))?;
506                i += 1;
507                match arg {
508                    "-MF" => opts.deps.file = Some(value.clone()),
509                    // The whole of the difference between the two. `-MT` is for a build that has
510                    // already escaped what it is passing, and `-MQ` is for one that has a name
511                    // and wants it to arrive as that name.
512                    "-MT" => opts.deps.targets.push(value.clone()),
513                    _ => opts.deps.targets.push(deps::escaped(value)),
514                }
515            }
516            // The questions a build system asks before it compiles anything. Answered after the
517            // loop, because each one is about the target or the library search and the command
518            // line has not finished saying what those are.
519            "-dumpmachine" => query = Some(Query::Machine),
520            "-dumpversion" | "-dumpfullversion" => query = Some(Query::Version),
521            "-print-multiarch" => query = Some(Query::Multiarch),
522            "-print-search-dirs" => query = Some(Query::SearchDirs),
523            "-print-sysroot" => query = Some(Query::Sysroot),
524            // Both spellings, because this one is ours rather than GCC's and our own documents
525            // write it both ways: section 13.5 of `spec/cross-compile/13-distribution.md` gives it
526            // two dashes like the other flags we invented, and document 12's table gives it one
527            // like the `-print-` family it sits in. A person who reads either and types what it
528            // says is right, so neither is refused.
529            "-print-sysroot-provenance" | "--print-sysroot-provenance" => {
530                query = Some(Query::SysrootProvenance);
531            }
532            "-print-sysroot-digest" | "--print-sysroot-digest" => {
533                query = Some(Query::SysrootDigest);
534            }
535            "-print-libgcc-file-name" => query = Some(Query::Libgcc),
536            _ if arg.starts_with("-print-file-name=") => {
537                query = Some(Query::FileName(arg["-print-file-name=".len()..].to_owned()));
538            }
539            _ if arg.starts_with("-print-prog-name=") => {
540                query = Some(Query::ProgName(arg["-print-prog-name=".len()..].to_owned()));
541            }
542            // A program built to run in more than one thread. On every platform this compiler
543            // targets that is a macro the library's headers read and one more library on the
544            // link line, and the library is added after the loop so that it lands after the
545            // objects that refer to it.
546            "-pthread" | "-pthreads" => {
547                opts.defines.push("_REENTRANT".to_owned());
548                threads = true;
549            }
550            "-ansi" => {
551                opts.std = Std::C89;
552                opts.gnu_extensions = false;
553            }
554            // `-Wpedantic` is the same flag under the name the `-W` family gives it, which is
555            // the spelling a build system that groups its warning flags tends to write.
556            "-pedantic" | "-Wpedantic" => opts.pedantic = true,
557            // Both directions, because a build that needs this for one directory turns it back
558            // off for the next one rather than leaving it on for the whole tree.
559            "-fpermissive" => opts.permissive = true,
560            "-fno-permissive" => opts.permissive = false,
561            "-ffreestanding" => opts.hosted = false,
562            "-fhosted" => opts.hosted = true,
563            "-fno-builtin" => opts.builtins = false,
564            "-fbuiltin" => opts.builtins = true,
565            // The C89 dialects are under GNU's reading whatever this says, so turning it off
566            // there is turning off something the dialect asked for, which is accepted and does
567            // nothing. gcc refuses that command line, and there is nothing it could have meant.
568            "-fgnu89-inline" => opts.gnu89_inline = true,
569            "-fno-gnu89-inline" => opts.gnu89_inline = false,
570            // Both directions of each, because a build system that wants one of these usually
571            // writes it beside the flag that turns it back off for one directory.
572            "-fno-omit-frame-pointer" => opts.frame_pointer = true,
573            "-fomit-frame-pointer" => opts.frame_pointer = false,
574            // Both directions again, for the same reason, and a third answer for a command line
575            // that wrote neither: see `reorder_blocks` in `rucc_session`.
576            "-freorder-blocks" => opts.reorder_blocks = Some(true),
577            "-fno-reorder-blocks" => opts.reorder_blocks = Some(false),
578            "-mno-red-zone" => opts.red_zone = false,
579            "-mred-zone" => opts.red_zone = true,
580            // Four flags rather than one with an argument, which is how gcc spells them and how
581            // every build line writes them. Last one wins, because a package build puts
582            // `-fstack-protector-strong` in its global flags and a directory that cannot have one
583            // turns it back off on the line after.
584            "-fno-stack-protector" | "-fno-stack-protector-all" | "-fno-stack-protector-strong" => {
585                opts.protector = Protector::None;
586            }
587            "-fstack-protector" => opts.protector = Protector::Buffers,
588            "-fstack-protector-strong" => opts.protector = Protector::Strong,
589            "-fstack-protector-all" => opts.protector = Protector::All,
590            // The other half of what a hardened build asks for, and it is a question about the
591            // frame rather than about the function, so it is a switch rather than a level.
592            "-fstack-clash-protection" => opts.stack_clash = true,
593            "-fno-stack-clash-protection" => opts.stack_clash = false,
594            // The third of them, and the one that is a question with an argument rather than a
595            // family of spellings, because what it asks about is which of the two edges of a
596            // control flow transfer is checked. Bare is both of them, which is what gcc does.
597            "-fcf-protection" => opts.control = Control::Full,
598            "-fno-cf-protection" => opts.control = Control::None,
599            // Two spellings of the same request, which is what gcc has as well. `-p` was the older
600            // profiler and `-pg` the one that also recorded who called whom, and on every platform
601            // this compiler targets there is now one hook and both ask for it.
602            "-pg" | "-p" => {
603                opts.profile = true;
604                link.profile = true;
605            }
606            // Accepted on their own and doing nothing on their own, which is gcc's behaviour: they
607            // say where the call goes and a command line that asked for no call has nowhere to put
608            // one. That matters because a build system that sets `-mfentry` globally and `-pg` per
609            // directory is a build system that would otherwise fail on every other directory.
610            "-mfentry" => opts.hook = Hook::Early,
611            "-mno-fentry" => opts.hook = Hook::Late,
612            // GCC drops its own include directory along with the system ones, because its
613            // headers are half of a pair with the library's and half a pair is worse than
614            // none. A build that passes this is supplying the whole set itself.
615            "-nostdinc" => nostdinc = true,
616            "-o" => {
617                output = Some(args.get(i).ok_or_else(|| err("-o requires an argument"))?.clone());
618                i += 1;
619            }
620            // The flags that take a directory only in the separated form. GCC spells them
621            // this way and nothing writes `-iquotedir`, so accepting the joined form would
622            // mean guessing at a path that starts with the flag's own letters.
623            // Apple's spelling of `--sysroot`, and the one its own build systems pass. The
624            // two mean the same thing here: the configured directories are under there rather
625            // than under the root.
626            "-isysroot" => {
627                let dir = args.get(i).ok_or_else(|| err("-isysroot requires an argument"))?;
628                i += 1;
629                sysroot = Some(PathBuf::from(dir));
630            }
631            "-iquote" | "-isystem" | "-idirafter" => {
632                let dir = args.get(i).ok_or_else(|| err(format!("{arg} requires an argument")))?;
633                i += 1;
634                match arg {
635                    "-iquote" => opts.search.push_quote(dir.clone()),
636                    "-isystem" => opts.search.push_system(dir.clone()),
637                    _ => opts.search.push_after(dir.clone()),
638                }
639            }
640            "-iprefix" => {
641                iprefix = args.get(i).ok_or_else(|| err("-iprefix requires an argument"))?.clone();
642                i += 1;
643            }
644            // Where GCC puts these is not where its manual says it puts them, and this is the
645            // measured answer rather than the documented one: `-iwithprefix` lands in the
646            // `-isystem` slot and not the `-idirafter` slot, and `-iwithprefixbefore` lands in
647            // the `-I` slot. A cross build that uses them is relying on the behaviour, since
648            // that is the compiler it was developed against.
649            "-iwithprefix" | "-iwithprefixbefore" => {
650                let dir = args.get(i).ok_or_else(|| err(format!("{arg} requires an argument")))?;
651                i += 1;
652                let dir = format!("{iprefix}{dir}");
653                if arg == "-iwithprefix" {
654                    opts.search.push_system(dir);
655                } else {
656                    opts.search.push_bracket(dir);
657                }
658            }
659            "-include" | "-imacros" => {
660                let name = args.get(i).ok_or_else(|| err(format!("{arg} requires an argument")))?;
661                i += 1;
662                opts.preincludes
663                    .push(Preinclude { name: name.clone(), macros_only: arg == "-imacros" });
664            }
665            // The flag `-iquote` was introduced to replace, still passed by build systems old
666            // enough to predate the replacement. It is not a directory: it says that every `-I`
667            // so far is for quoted includes only, and that a quoted include stops looking next
668            // to the file that wrote it.
669            "-I-" => opts.search.split_quote_chain(),
670            "-x" => {
671                let lang = args.get(i).ok_or_else(|| err("-x requires an argument"))?;
672                i += 1;
673                forced = if lang == "none" {
674                    None
675                } else {
676                    Some(InputKind::from_x_arg(lang).map_err(|e| err(format!("{e}")))?)
677                };
678            }
679            // Not a GCC flag. spec/03-architecture.md section 3.5 compiles several
680            // translation units in one process rather than making the build system fork, and
681            // section 3.8's determinism check compares `-j1` against `-j16`, so the knob has
682            // to exist and has to be spelled the way `make` spells it.
683            // `-DFOO`, `-D FOO` and the same for `-U` and `-I`. Both forms are in wide use
684            // and a build system may produce either, so both are read here rather than
685            // being normalised by whatever generated the command line.
686            _ if arg.starts_with("-D") => {
687                let value = joined_or_next(arg, 2, args, &mut i)?;
688                opts.defines.push(value);
689            }
690            _ if arg.starts_with("-U") => {
691                let value = joined_or_next(arg, 2, args, &mut i)?;
692                opts.undefines.push(value);
693            }
694            _ if arg.starts_with("-I") => {
695                let dir = joined_or_next(arg, 2, args, &mut i)?;
696                opts.search.push_bracket(dir);
697            }
698            _ if arg.starts_with("-std=") => {
699                let name = &arg["-std=".len()..];
700                let (std, gnu) = Std::from_flag(name)
701                    .ok_or_else(|| err(format!("unknown dialect `{name}`, see --help")))?;
702                opts.std = std;
703                opts.gnu_extensions = gnu;
704            }
705            // Section 4.5. The claim decides which half of glibc's `sys/cdefs.h` we are
706            // handed, so a differential run that does not set it is comparing two compilers
707            // that believe they are different compilers.
708            // GCC packs these into one flag, so `-dDI` is two of them. Letters in the family
709            // that we have not written yet are accepted and ignored, because a dump is a
710            // debugging aid and a build that asks for one should still compile. A letter
711            // outside the family falls through to the unknown option error, which is what
712            // keeps `-dumpversion` from being read as a dump of nothing.
713            _ if Dumps::is_family(arg) => {
714                opts.dumps.add(&arg[2..]);
715            }
716            // One name at a time, which is what a build that means its own `memcpy` and the
717            // library's everything else writes. The name is not checked against a list, because
718            // the flag is about what the program means by a name and a program is allowed to mean
719            // something by a name this compiler has never heard of.
720            _ if arg.starts_with("-fno-builtin-") => {
721                opts.no_builtin.push(arg["-fno-builtin-".len()..].to_owned());
722            }
723            _ if arg.starts_with("-fgnuc-version=") => {
724                let v = &arg["-fgnuc-version=".len()..];
725                opts.gnuc = v.parse().map_err(err)?;
726            }
727            // spec/13-gnu-compat.md section 13.3 promises this flag an error that says why rather
728            // than the unknown option one, because a build reaching for it is asking for a feature
729            // and deserves to be told it is not coming rather than told the spelling is wrong.
730            // The negative form is what this compiler does anyway, so it is taken and dropped.
731            "-fnested-functions" => {
732                return Err(err(
733                    "nested functions are not supported: a call to one goes through a trampoline \
734                     written on the stack, which no target that enforces an unexecutable stack \
735                     allows",
736                ));
737            }
738            "-fno-nested-functions" => {}
739            // Which of the two links the output is for, which is a real difference and not a
740            // description of what happens anyway. Everything here is position independent either
741            // way, and what these decide is whether a name may be one another object defines or
742            // replaces, because a link that produces an executable puts every name in the same
743            // program and a link that produces a shared library does not.
744            //
745            // It matters that they are accepted at all, whatever they then do. Every autoconf and
746            // cmake build puts `-fPIC` on the compile line, so a compiler that rejects it cannot
747            // be the `CC` of a project that has a configure script, whatever else it can do. That
748            // is how this was found: building SQLite's test fixture stopped on it.
749            "-fPIC" | "-fpic" => opts.pic = Pic::Library,
750            // Not a synonym of the pair above, which is what they were treated as until #756. The
751            // library is the expensive answer and gcc makes it the one that has to be asked for,
752            // so this is also what nothing at all means.
753            "-fPIE" | "-fpie" => opts.pic = Pic::Executable,
754            // A different question from the pair above, and the one every distribution build of a
755            // shared library answers. `-fPIC` decides how an address is reached, and this decides
756            // whether the optimizer may believe a body it can see, because an exported name is one
757            // the dynamic linker may find another definition of first. On by default, which is
758            // gcc's arrangement and is the honest answer, and off is a promise the build makes and
759            // nothing checks.
760            "-fsemantic-interposition" => opts.interposition = true,
761            "-fno-semantic-interposition" => opts.interposition = false,
762            // Two requests rather than one, and the same table answers both, so what decides is
763            // whether either of them is standing. gcc arranges it the same way: the asynchronous
764            // one is the default here and it implies the other, and a line that asks for a table
765            // and against an asynchronous one gets a table.
766            "-fasynchronous-unwind-tables" => opts.async_unwind_tables = true,
767            "-fno-asynchronous-unwind-tables" => opts.async_unwind_tables = false,
768            "-funwind-tables" => opts.unwind_tables = true,
769            "-fno-unwind-tables" => opts.unwind_tables = false,
770            // The other direction is a request, not a description, and it is one this compiler
771            // cannot grant, so it gets the treatment section 13.3 asks for rather than the unknown
772            // option error. Answering it by carrying on would be answering a different question:
773            // the code would still be position independent, which is correct everywhere an
774            // ordinary program runs and is wrong in a kernel, where the flag is written precisely
775            // because there is no loader to fill a global offset table in.
776            "-fno-pic" | "-fno-pie" => {
777                return Err(err(
778                    "position dependent code is not supported: an address that may be in another \
779                     object is loaded out of the global offset table, and nothing here emits the \
780                     absolute form this asks for. Use -no-pie if what you meant was how to link",
781                ));
782            }
783            // A section per function and a section per variable, which is what makes
784            // `--gc-sections` able to drop anything: a linker can leave out a section nothing
785            // reaches and cannot leave out half of one. Both directions are taken, and the off
786            // one is the default rather than a refusal, since a build that writes it is asking
787            // for what happens anyway.
788            "-ffunction-sections" => opts.function_sections = true,
789            "-fno-function-sections" => opts.function_sections = false,
790            "-fdata-sections" => opts.data_sections = true,
791            "-fno-data-sections" => opts.data_sections = false,
792            // Another description of what this compiler does. A file scope declaration with no
793            // initializer is written into `.bss` as an ordinary defined symbol, not offered to the
794            // linker as a common one for it to merge, which is what `-fno-common` asks for and what
795            // gcc has done by default since 10. Nothing in the front end produces `Linkage::Common`
796            // at all.
797            "-fno-common" => {}
798            // What overflows rather than being undefined. Every one of these takes something away
799            // from the optimizer rather than asking it to do anything, which is why the negative
800            // spellings are the interesting ones and the positive spellings are the default.
801            //
802            // `-fno-strict-overflow` is both of the others, which is gcc's own reading of it: its
803            // help text for `-fstrict-overflow` says "negated as -fwrapv -fwrapv-pointer". So it is
804            // written here as the pair rather than kept as a third thing to test everywhere.
805            //
806            // `-ftrapv` is the exception and is the one that asks for something. It is the other
807            // answer to the question `-fwrapv` answers, so the two cannot both hold and each clears
808            // the other, which makes the last one on the command line the one that counts. That is
809            // gcc 16's behaviour and was measured rather than read: `-ftrapv -fwrapv` emits no
810            // checked calls and `-fwrapv -ftrapv` emits them. The positive spelling of the pointer
811            // question is left alone by both, because neither has anything to say about it.
812            "-fwrapv" => {
813                opts.wrapping.signed = true;
814                opts.wrapping.trap = false;
815            }
816            "-fno-wrapv" => opts.wrapping.signed = false,
817            "-fwrapv-pointer" => opts.wrapping.pointer = true,
818            "-fno-wrapv-pointer" => opts.wrapping.pointer = false,
819            "-fno-strict-overflow" => opts.wrapping = Wrapping::ALL,
820            // Which does not clear the checked one, because gcc does not: `-ftrapv
821            // -fstrict-overflow` still emits the calls. It says what is assumed and not what
822            // happens.
823            "-fstrict-overflow" => {
824                opts.wrapping.signed = false;
825                opts.wrapping.pointer = false;
826            }
827            "-ftrapv" => {
828                opts.wrapping.trap = true;
829                opts.wrapping.signed = false;
830            }
831            "-fno-trapv" => opts.wrapping.trap = false,
832            // The two flags that say what a plain `char` is, which is one question with two
833            // spellings each: gcc reads `-fno-signed-char` as `-funsigned-char` and
834            // `-fno-unsigned-char` as `-fsigned-char`, so there are four ways to write two
835            // answers and the last one written wins. Nothing is set until one of them is given,
836            // because the target's own ABI is the answer otherwise and it is not the same answer
837            // everywhere: x86-64 and Apple's arm64 are signed, Linux's arm64 is not.
838            "-fsigned-char" | "-fno-unsigned-char" => opts.char_signed = Some(true),
839            "-funsigned-char" | "-fno-signed-char" => opts.char_signed = Some(false),
840            // And the size of an enumeration, which is the other thing in this group that changes
841            // the ABI rather than the code.
842            "-fshort-enums" => opts.short_enums = true,
843            "-fno-short-enums" => opts.short_enums = false,
844            // And the request, which is the one that cannot be granted. It is a real difference and
845            // not a preference: two files each writing `int g;` link under `-fcommon` and are a
846            // duplicate definition without it, which is the whole reason the flag survives.
847            "-fcommon" => {
848                return Err(err(
849                    "a tentative definition is written into .bss as its own symbol here, and \
850                     nothing emits the common symbol this asks the linker to merge. Give the \
851                     variable a definition in one file and declare it extern in the others",
852                ));
853            }
854            // Both directions of this one are recorded, and what they decide is whether lowering
855            // names the type each access goes through. Turning it off is the front end leaving the
856            // name off rather than a pass being told to ignore one it can see, which is one
857            // condition in one place, and it is the reading that survives link time optimization:
858            // a unit built with the flag off keeps its own answer when its bodies end up in a
859            // module beside bodies that were not.
860            //
861            // Nothing in the pipeline reads those names yet. Layer 3 of the alias analysis does
862            // and is tested, and no pass at any level asks the alias analysis anything today, so
863            // no program compiles differently for having passed this. The flag is wired anyway,
864            // because the change that makes a pass ask is not the change anybody will remember to
865            // wire it in, and a flag that is taken and dropped once the names mean something is
866            // the miscompilation `spec/04-driver-and-cli.md` section 4.1 warns about in as many
867            // words.
868            "-fstrict-aliasing" => opts.strict_aliasing = true,
869            "-fno-strict-aliasing" => opts.strict_aliasing = false,
870            // The same shape of answer for the same reason, and the flag the kernel writes beside
871            // the one above it.
872            //
873            // Nothing here concludes that a pointer is not null from the fact that it was
874            // dereferenced. There is no such conclusion to draw from, because no pass records one:
875            // a load says where it read and nothing else, and a comparison against null is an
876            // ordinary comparison of two values the optimizer has no fact about. So a function
877            // that reads through a pointer and then tests it keeps the test, which is what the
878            // kernel wants and what `-fno-delete-null-pointer-checks` asks for, and what gcc has
879            // to be asked for because it draws the conclusion by default.
880            //
881            // `-fdelete-null-pointer-checks` is the request to draw it, and it goes the way
882            // `-fstrict-aliasing` does: assuming less than was asked for costs speed and not
883            // correctness, and `-O2` implies it, so refusing it would stop builds for nothing.
884            "-fdelete-null-pointer-checks" | "-fno-delete-null-pointer-checks" => {}
885            // The floating point group, which goes the same way and for the same reason, and which
886            // is worth writing out because the reason is easy to get backwards.
887            //
888            // Each of these has a restrictive spelling and a permissive one. The restrictive ones,
889            // `-frounding-math` and `-ftrapping-math`, say that the rounding mode may have been
890            // changed and that an exception raised by an operation may be looked at, so an
891            // arithmetic the compiler folds at compile time is an arithmetic whose rounding and
892            // whose exception the program does not get. Nothing here folds any floating point
893            // arithmetic in a function body: `0.1 + 0.2` is an `fadd` and `1.0 / 0.0` is a divide
894            // that runs, at every level. So both of those describe what already happens.
895            //
896            // The permissive ones are the other half, and they are licences rather than requests
897            // for an answer. `-fno-rounding-math` says the rounding mode is the default one and
898            // `-fno-trapping-math` says nothing looks at the exceptions, which together are
899            // permission to fold. Not folding is the conservative side of that permission and is
900            // what a program is entitled to whichever was written, so `-fno-rounding-math` costs
901            // speed and not correctness, which is the test section 4.1 puts a licence through.
902            "-frounding-math" | "-fno-rounding-math" => {}
903            // `-fno-trapping-math` is the one of the four that is kept, because there is one
904            // conversion this compiler does not fold and gcc folds under it, and the two answers
905            // differ. Converting a constant floating value to an integer type it does not fit in
906            // is undefined behaviour rather than a value: left to the hardware it is one
907            // instruction and the answer is the integer indefinite value, and folded it is the
908            // nearest end of the integer's range. Both compilers leave it to the instruction by
909            // default and gcc folds it under this flag, so a program built with it and compiled
910            // without it gets a different number rather than a slower one. `-ftrapping-math` is
911            // gcc's default, so a build spelling it out is asking for what it already has.
912            "-ftrapping-math" => opts.trapping_math = true,
913            "-fno-trapping-math" => opts.trapping_math = false,
914            // About temporary files rather than about code. There is nothing between the phases of
915            // one compilation here to write to a file in the first place.
916            "-pipe" => {}
917            // Nothing here writes colour, so all of these are the same answer, and it is the answer
918            // that costs nothing: the diagnostics come out plain either way and no build depends on
919            // an escape sequence being there. Taken rather than refused because cmake writes
920            // `-fdiagnostics-color=always` on every compile line when the generator is ninja, which
921            // makes this the second most common flag after `-fPIC` to stop a build over a question
922            // about how the text looks.
923            "-fdiagnostics-color" | "-fno-diagnostics-color" => {}
924            _ if arg.starts_with("-fdiagnostics-color=") => {}
925            // The link flags. None of them changes the compilation, which is why they are
926            // collected apart from `opts` and why `-lm` on a `-c` line is a note rather than an
927            // error: it is a thing said to a linker that is not going to run.
928            "-static" => link.is_static = true,
929            "-shared" => link.shared = true,
930            "-pie" => link.pie = Some(true),
931            "-no-pie" | "-nopie" => link.pie = Some(false),
932            "-nostdlib" => link.no_stdlib = true,
933            "-nostartfiles" => link.no_startfiles = true,
934            "-nodefaultlibs" => link.no_defaultlibs = true,
935            "-fno-builtins-lib" => link.no_builtins_lib = true,
936            "-fbuiltins-lib" => link.no_builtins_lib = false,
937            "-rdynamic" | "-export-dynamic" => link.export_dynamic = true,
938            "-s" => link.strip = true,
939            "-Xlinker" => {
940                let next = args.get(i).ok_or_else(|| err("-Xlinker requires an argument"))?;
941                i += 1;
942                link.passthrough.push(next.clone());
943            }
944            _ if arg.starts_with("-Wl,") => {
945                // Commas separate arguments rather than being part of one, which is what makes
946                // `-Wl,-rpath,/opt/lib` two words to the linker and one word here.
947                link.passthrough.extend(arg["-Wl,".len()..].split(',').map(str::to_owned));
948            }
949            _ if arg.starts_with("-fuse-ld=") => {
950                link.use_ld = Some(arg["-fuse-ld=".len()..].to_owned());
951            }
952            _ if arg.starts_with("-l") && arg.len() > 2 => {
953                inputs.push(Input::library(&arg[2..]));
954            }
955            "-l" => {
956                let next = args.get(i).ok_or_else(|| err("-l requires an argument"))?;
957                i += 1;
958                inputs.push(Input::library(next));
959            }
960            _ if arg.starts_with("-L") => {
961                link.search.push(PathBuf::from(joined_or_next(arg, 2, args, &mut i)?));
962            }
963            _ if arg.starts_with("-B") => {
964                link.prefixes.push(PathBuf::from(joined_or_next(arg, 2, args, &mut i)?));
965            }
966            _ if arg.starts_with("-j") => {
967                jobs = Jobs::parse(&arg[2..]).map_err(err)?;
968            }
969            _ if arg.starts_with("--sysroot=") => {
970                sysroot = Some(PathBuf::from(&arg["--sysroot=".len()..]));
971            }
972            _ if arg.starts_with("--target=") => {
973                let t = &arg["--target=".len()..];
974                opts.target = t.parse().map_err(|e| err(format!("{e}")))?;
975                // The same string again, as the model that has room for a libc version. A spelling
976                // the three field parser took and this one does not is not an error, because the
977                // one that decides what is compiled has already accepted it and the only thing
978                // lost is a version nobody asked for.
979                pinned = t.parse().ok();
980            }
981            _ if arg.starts_with("--emit=") => {
982                let k = &arg["--emit=".len()..];
983                opts.emit = k
984                    .parse()
985                    .map_err(|()| err(format!("unknown --emit kind `{k}`, see --help")))?;
986            }
987            // A bare `-O` is `-O1`, which is what GCC has and what a hand written makefile tends
988            // to write. `-Og` is GCC's level for a build somebody is going to step through, and
989            // it is `-O1` with the transformations that move code around left out; this compiler
990            // has no such level yet, so it is the nearest one and `--print-pipeline` says what
991            // that came to rather than the flag pretending otherwise.
992            "-O" | "-Og" => opts.opt_level = rucc_session::OptLevel::O1,
993            // The union of `-O3` and `-ffast-math`, and the second half of that changes what
994            // floating point arithmetic means. Refused rather than taken as `-O3`, because a
995            // build that asks for fast math and is quietly given ordinary arithmetic gets a
996            // slower program than it asked for and a build that is given fast math it did not
997            // ask for gets a wrong one.
998            "-Ofast" => {
999                return Err(err(
1000                    "-Ofast is -O3 with fast math, and fast math is not implemented, see \
1001                     spec/04-driver-and-cli.md section 4.6",
1002                ));
1003            }
1004            _ if arg.starts_with("-O") => {
1005                opts.opt_level = arg[2..]
1006                    .parse()
1007                    .map_err(|()| err(format!("unknown optimization level `{arg}`")))?;
1008            }
1009            // How far a multiply and an addition may be fused into one rounding. Before the
1010            // optimizer's `-f` family below for the reason the ones under it are, and kept rather
1011            // than dropped because it is the one flag in its group this compiler could act on: it
1012            // rides into the IR as an attribute on each function with a body, so the day the code
1013            // generator forms an `fma` it already knows which functions were given permission.
1014            // Nothing forms one today, under any value of this and under any `-march=`.
1015            _ if arg.starts_with("-ffp-contract=") => {
1016                let how = &arg["-ffp-contract=".len()..];
1017                opts.fp_contract = how.parse().map_err(|()| {
1018                    err(format!("`{how}` is not a contraction, which is fast, on or off"))
1019                })?;
1020            }
1021            // How much of an expression may be computed wider than it was written. The values are
1022            // gcc's and so is the refusal of anything else, and none of the three changes anything
1023            // here: an operation is computed in the type C says it is on every target this compiler
1024            // has a back end for, so `__FLT_EVAL_METHOD__` is 0 and `standard` is already what
1025            // happens. `fast` and `16` are permission to be wider, which is a licence this takes
1026            // and does not use, the same way the two above are. The flag is worth taking because
1027            // glibc's headers and a good deal of configure output write it, and because the answer
1028            // it asks about is one this compiler can state rather than guess at: there is no x87
1029            // target here, which is the machine the whole question was invented for.
1030            // Whether a local and a spilled value that are never both wanted may be the same bytes
1031            // of the frame. gcc's three values, and two of them mean the same thing here: what rucc
1032            // shares is a local whose address provably never leaves the function, which is narrower
1033            // than `named_vars` and narrower still than `all`, so both of them get it. `none` is
1034            // the one that changes anything, and it is the flag a program that reads a local
1035            // through a pointer it kept past the end of the block writes.
1036            _ if arg.starts_with("-fstack-reuse=") => {
1037                let how = &arg["-fstack-reuse=".len()..];
1038                opts.stack_reuse = match how {
1039                    "all" | "named_vars" => Some(true),
1040                    "none" => Some(false),
1041                    _ => {
1042                        return Err(err(format!(
1043                            "`{how}` is not a stack reuse, which is all, named_vars or none"
1044                        )));
1045                    }
1046                };
1047            }
1048            _ if arg.starts_with("-fexcess-precision=") => {
1049                let how = &arg["-fexcess-precision=".len()..];
1050                if !matches!(how, "16" | "fast" | "standard") {
1051                    return Err(err(format!(
1052                        "`{how}` is not an excess precision, which is 16, fast or standard"
1053                    )));
1054                }
1055            }
1056            // Which front of a path is rewritten before it reaches the output, which is how a
1057            // build gets the same bytes out of two different directories. The four spellings are
1058            // one flag each into three lists, and `-ffile-prefix-map=` is the three of them at
1059            // once. Only the macro list does anything today, because `__FILE__` is the only place
1060            // a path reaches the output: there is no DWARF and no profile data yet, so the other
1061            // two are recorded for the work that will read them. The argument splits at the last
1062            // `=` rather than the first, which is gcc's rule and is what lets a directory with an
1063            // `=` in its name be the old half.
1064            _ if arg.starts_with("-fmacro-prefix-map=") => {
1065                let (old, new) = rewrite(arg, "-fmacro-prefix-map=")?;
1066                opts.prefix_map.macros.push(old, new);
1067            }
1068            _ if arg.starts_with("-fdebug-prefix-map=") => {
1069                let (old, new) = rewrite(arg, "-fdebug-prefix-map=")?;
1070                opts.prefix_map.debug.push(old, new);
1071            }
1072            _ if arg.starts_with("-fprofile-prefix-map=") => {
1073                let (old, new) = rewrite(arg, "-fprofile-prefix-map=")?;
1074                opts.prefix_map.profile.push(old, new);
1075            }
1076            _ if arg.starts_with("-ffile-prefix-map=") => {
1077                let (old, new) = rewrite(arg, "-ffile-prefix-map=")?;
1078                opts.prefix_map.macros.push(old, new);
1079                opts.prefix_map.debug.push(old, new);
1080                opts.prefix_map.profile.push(old, new);
1081            }
1082            // A whole optimization rather than a flag, and the family is taken rather than
1083            // refused because of what ignoring it does. There is none of it here yet, so a build
1084            // that asks for it gets a program that is correct and slower than it could have been,
1085            // which is what section 4.1 means by a hint about speed and what every compilation at
1086            // `-O0` already is. The objects settle the rest of the argument: gcc's `-flto` object
1087            // holds the bytecode and no machine code at all, and every object here holds the code,
1088            // which is exactly what `-ffat-lto-objects` asks gcc for. So a build passing `-flto`
1089            // to this compiler gets objects that are more usable than the ones it asked for rather
1090            // than different ones. Every value is still checked against gcc's, because somebody
1091            // who wrote `-flto=thin` meant clang and had better hear about it here.
1092            "-flto" => opts.lto.requested = true,
1093            "-fno-lto" => opts.lto.requested = false,
1094            _ if arg.starts_with("-flto=") => {
1095                let how = &arg["-flto=".len()..];
1096                opts.lto.jobs = how.parse().map_err(|()| {
1097                    err(format!(
1098                        "`{how}` is not a number of link time jobs, which is auto, jobserver or a \
1099                         count above zero"
1100                    ))
1101                })?;
1102                opts.lto.requested = true;
1103            }
1104            _ if arg.starts_with("-flto-partition=") => {
1105                let how = &arg["-flto-partition=".len()..];
1106                opts.lto.partition = how.parse().map_err(|()| {
1107                    err(format!(
1108                        "`{how}` is not a partitioning model, which is balanced, 1to1, one, max \
1109                         or none"
1110                    ))
1111                })?;
1112            }
1113            _ if arg.starts_with("-flto-compression-level=") => {
1114                let how = &arg["-flto-compression-level=".len()..];
1115                let level =
1116                    how.parse::<u8>().ok().filter(|level| *level <= 19).ok_or_else(|| {
1117                        err(format!("`{how}` is not a compression level, 0 to 19"))
1118                    })?;
1119                opts.lto.compression = Some(level);
1120            }
1121            // Whether the object keeps its machine code as well as the bytecode. It always does
1122            // here, so the first of these describes what happens and the second asks for an object
1123            // with less in it, which is a smaller file and not a different program, so both are
1124            // taken.
1125            "-ffat-lto-objects" | "-fno-fat-lto-objects" => {}
1126            // Whether the linker is handed a plugin that does the link time work. The design in
1127            // `spec/09-optimizer.md` has this driver doing that work itself and never loading a
1128            // plugin into anybody, so neither answer is a question it has to hold.
1129            "-fuse-linker-plugin" | "-fno-use-linker-plugin" => {}
1130            // Reading a profile back. Taken for the reason the family above it is: nothing here
1131            // reads one, so a build that asks gets the program it would have got anyway, and gcc
1132            // itself produces a byte for byte identical object from `-fprofile-use` when there are
1133            // no counts beside the file. The path is recorded for the pass that will read it. The
1134            // warning gcc prints when it looked and found nothing is deliberately not copied,
1135            // because nothing here looks, and a warning about a file that was never opened would
1136            // fire on the builds that have a perfectly good profile as well as on the ones that
1137            // do not.
1138            "-fprofile-use" => opts.profile_data.requested = true,
1139            "-fno-profile-use" => opts.profile_data.requested = false,
1140            _ if arg.starts_with("-fprofile-use=") => {
1141                opts.profile_data.path = Some(arg["-fprofile-use=".len()..].to_string());
1142                opts.profile_data.requested = true;
1143            }
1144            _ if arg.starts_with("-fprofile-dir=") => {
1145                opts.profile_data.dir = Some(arg["-fprofile-dir=".len()..].to_string());
1146            }
1147            "-fprofile-abs-path" => opts.profile_data.absolute = true,
1148            "-fno-profile-abs-path" => opts.profile_data.absolute = false,
1149            "-fprofile-correction" => opts.profile_data.correction = true,
1150            "-fno-profile-correction" => opts.profile_data.correction = false,
1151            "-fprofile-partial-training" => opts.profile_data.partial_training = true,
1152            "-fno-profile-partial-training" => opts.profile_data.partial_training = false,
1153            // Writing the counts rather than reading them, which is refused rather than taken and
1154            // is the same line `-gsplit-dwarf` falls on the far side of. Ignoring these means a
1155            // file a build declared as an output never appears: the instrumented program writes a
1156            // `.gcda` as it exits and `-ftest-coverage` writes a `.gcno` beside the object, and a
1157            // two stage build that got neither would go on to optimize against no counts at all
1158            // and report coverage of nothing, with nothing along the way saying so. The objects
1159            // say the rest: gcc's `-fprofile-generate` object holds 375 bytes of code where a
1160            // plain one holds 71, and 296 bytes of counters that a plain one does not have, so
1161            // this is a flag that changes the output rather than a hint about speed.
1162            "-fprofile-arcs"
1163            | "--coverage"
1164            | "-fcondition-coverage"
1165            | "-fpath-coverage"
1166            | "-fprofile-generate" => {
1167                return Err(err(format!(
1168                    "{arg}: this compiler does not instrument for profiling, and a build that \
1169                     expects the counts a run of the instrumented program writes would optimize \
1170                     against nothing on its second pass, see spec/04-driver-and-cli.md"
1171                )));
1172            }
1173            _ if arg.starts_with("-fprofile-generate=") => {
1174                return Err(err(format!(
1175                    "{arg}: this compiler does not instrument for profiling, and a build that \
1176                     expects the counts a run of the instrumented program writes would optimize \
1177                     against nothing on its second pass, see spec/04-driver-and-cli.md"
1178                )));
1179            }
1180            "-ftest-coverage" => {
1181                return Err(err(format!(
1182                    "{arg}: this compiler writes no `.gcno` file beside the object, and a build \
1183                     that expects one would wait for a file that never arrives, see \
1184                     spec/04-driver-and-cli.md"
1185                )));
1186            }
1187            // The rest of the family describes instrumentation that is refused above, so what is
1188            // left to do with them is check them and drop them. They are checked because a
1189            // misspelling in a distribution's flags is worth finding here rather than on the day
1190            // the instrumentation lands, and dropped because there is nothing for an answer about
1191            // how a counter is written to be an answer about.
1192            _ if arg.starts_with("-fprofile-update=") => {
1193                let how = &arg["-fprofile-update=".len()..];
1194                if !matches!(how, "single" | "atomic" | "prefer-atomic") {
1195                    return Err(err(format!(
1196                        "`{how}` is not a profile update method, which is single, atomic or \
1197                         prefer-atomic"
1198                    )));
1199                }
1200            }
1201            _ if arg.starts_with("-fprofile-reproducible=") => {
1202                let how = &arg["-fprofile-reproducible=".len()..];
1203                if !matches!(how, "serial" | "parallel-runs" | "multithreaded") {
1204                    return Err(err(format!(
1205                        "`{how}` is not a profile reproducibility method, which is serial, \
1206                         parallel-runs or multithreaded"
1207                    )));
1208                }
1209            }
1210            "-fprofile-values" | "-fno-profile-values" | "-fprofile-info-section" => {}
1211            "-fno-test-coverage" | "-fno-profile-arcs" | "-fno-profile-generate" => {}
1212            _ if arg.starts_with("-fprofile-filter-files=")
1213                || arg.starts_with("-fprofile-exclude-files=")
1214                || arg.starts_with("-fprofile-note=") => {}
1215            // What every name gets when nothing in the source said, which the attribute in the
1216            // source overrides rather than the other way round. Before the optimizer's `-f`
1217            // family below for the reason the tier below it is.
1218            _ if arg.starts_with("-fvisibility=") => {
1219                let seen = &arg["-fvisibility=".len()..];
1220                opts.visibility = seen.parse().map_err(|()| {
1221                    err(format!(
1222                        "`{seen}` is not a visibility, which is default, hidden, internal or \
1223                         protected"
1224                    ))
1225                })?;
1226            }
1227            // Which edges of a control flow transfer are checked. Before the optimizer's `-f`
1228            // family below for the reason the two above it are, and last of the three so that the
1229            // bare spelling and the negative one are matched exactly rather than by this.
1230            _ if arg.starts_with("-fcf-protection=") => {
1231                let edges = &arg["-fcf-protection=".len()..];
1232                opts.control = edges.parse().map_err(|()| {
1233                    err(format!(
1234                        "`{edges}` is not a control flow protection, which is full, branch, \
1235                         return, none or check"
1236                    ))
1237                })?;
1238            }
1239            // How much room every function opens with for something to be written over later.
1240            // Before the optimizer's `-f` family below for the reason the ones above it are.
1241            _ if arg.starts_with("-fpatchable-function-entry=") => {
1242                let room = &arg["-fpatchable-function-entry=".len()..];
1243                opts.patchable = room.parse().map_err(|()| {
1244                    err(format!(
1245                        "`{room}` is not an amount of room to reserve, which is a number of bytes                          and then, after a comma, how many of them go in front of the function's                          own label"
1246                    ))
1247                })?;
1248            }
1249            // The memory safety monitor, from section 15.4 of
1250            // `spec/safe-memory/15-integration.md`. Before the optimizer's `-f` family below,
1251            // because a pass that took the name `safety=detect` would otherwise be handed the
1252            // flag, and the tier is not a pass.
1253            _ if arg.starts_with("-fsafety=") => {
1254                let tier = &arg["-fsafety=".len()..];
1255                opts.safety = tier.parse().map_err(|()| {
1256                    err(format!(
1257                        "`{tier}` is not a safety tier, which is off, detect, enforce or kernel"
1258                    ))
1259                })?;
1260            }
1261            // Whether padding participates, from section 9.3 of document 09. Spelled out rather
1262            // than folded into the tier because it is a departure somebody who has read that
1263            // section makes, and the two defaults it describes are a property of what is being
1264            // built rather than of how much checking is wanted.
1265            _ if arg.starts_with("-fsafety-init=") => {
1266                let mode = &arg["-fsafety-init=".len()..];
1267                opts.padding = mode.parse().map_err(|()| {
1268                    err(format!("`{mode}` is not a padding mode, which is padding or nopadding"))
1269                })?;
1270            }
1271            // Row S4, from section 9.4 of document 09. A bare flag with no value, because the
1272            // strict form of that section needs a member id the front end does not name yet and
1273            // accepting the spelling for it would be accepting a promise this build cannot keep.
1274            // Before `-fno-` is looked at below, for the reason the tier is.
1275            "-fsafety-subobject" => opts.subobject = rucc_session::Subobject::Members,
1276            "-fno-safety-subobject" => opts.subobject = rucc_session::Subobject::Off,
1277            _ if arg.starts_with("-fsafety-subobject=") => {
1278                let form = &arg["-fsafety-subobject=".len()..];
1279                return Err(err(format!(
1280                    "`{form}` is not a form of -fsafety-subobject. The flag takes no value, and \
1281                     the strict form of section 9.4 is tamnd/rucc#967"
1282                )));
1283            }
1284            // Row Y8, from section 9.6 of document 09. A bare flag with no value, for the reason
1285            // the one above has none: there is one form of this check and a spelling that suggested
1286            // otherwise would be promising something. Before `-fno-` is looked at below, the same
1287            // way.
1288            "-fsafety-restrict" => opts.promise = rucc_session::Promise::Blocks,
1289            "-fno-safety-restrict" => opts.promise = rucc_session::Promise::Off,
1290            _ if arg.starts_with("-fsafety-restrict=") => {
1291                let form = &arg["-fsafety-restrict=".len()..];
1292                return Err(err(format!(
1293                    "`{form}` is not a form of -fsafety-restrict. The flag takes no value."
1294                )));
1295            }
1296            // Section 9.5's races, which take a value because the section gives them three modes
1297            // and the difference between two of them is which classes get reported rather than how
1298            // much is recorded. `-fno-` is the same as `=off` and is spelled out here for the same
1299            // reason the two above spell theirs out.
1300            _ if arg.starts_with("-fsafety-races=") => {
1301                let mode = &arg["-fsafety-races=".len()..];
1302                opts.races = mode.parse().map_err(|()| {
1303                    err(format!("`{mode}` is not a race mode, which is off, metadata or pointer"))
1304                })?;
1305            }
1306            "-fno-safety-races" => opts.races = rucc_session::Races::Off,
1307            // The sanitizers of document 12, which are checks at run time rather than a way of
1308            // generating the same program. Each name is held to gcc 16's list, and what is still
1309            // asked for by the end of the line is answered after the loop, so that a command line
1310            // which turns one on and then off again is a command line that asked for nothing.
1311            //
1312            // Before the optimizer's `-f` family below, for the reason the tier above it is.
1313            _ if arg.starts_with("-fsanitize=") => {
1314                for one in arg["-fsanitize=".len()..].split(',') {
1315                    if one == "all" {
1316                        // gcc takes `all` only in the negative, because turning every check on at
1317                        // once includes checks that contradict each other.
1318                        return Err(err(
1319                            "`-fsanitize=all` is not a gcc option, only `-fno-sanitize=all` is",
1320                        ));
1321                    }
1322                    if !SANITIZERS.contains(&one) {
1323                        return Err(err(format!(
1324                            "`{one}` is not a sanitizer, see spec/04-driver-and-cli.md section 4.7"
1325                        )));
1326                    }
1327                    if !sanitizers.contains(&one) {
1328                        sanitizers.push(one);
1329                    }
1330                }
1331            }
1332            _ if arg.starts_with("-fno-sanitize=") => {
1333                for one in arg["-fno-sanitize=".len()..].split(',') {
1334                    if one == "all" {
1335                        sanitizers.clear();
1336                        continue;
1337                    }
1338                    if !SANITIZERS.contains(&one) {
1339                        return Err(err(format!(
1340                            "`{one}` is not a sanitizer, see spec/04-driver-and-cli.md section 4.7"
1341                        )));
1342                    }
1343                    sanitizers.retain(|asked| *asked != one);
1344                }
1345            }
1346            // What a check does when it fires, and where the records about the checked objects go.
1347            // Each of them is an answer about the sanitizers refused after the loop, so there is
1348            // nothing left for them to change here. The names are still held to the list, because
1349            // a misspelling in a build's flags is worth finding when the compiler reads it.
1350            _ if arg.starts_with("-fsanitize-recover=")
1351                || arg.starts_with("-fno-sanitize-recover=")
1352                || arg.starts_with("-fsanitize-trap=")
1353                || arg.starts_with("-fno-sanitize-trap=") =>
1354            {
1355                // The guard above matched on a spelling that has an `=` in it, so the tail is
1356                // whatever follows the first one.
1357                let how = arg.split_once('=').map_or("", |(_, rest)| rest);
1358                for one in how.split(',') {
1359                    if one != "all" && !SANITIZERS.contains(&one) {
1360                        return Err(err(format!(
1361                            "`{one}` is not a sanitizer, see spec/04-driver-and-cli.md section 4.7"
1362                        )));
1363                    }
1364                }
1365            }
1366            "-fsanitize-undefined-trap-on-error"
1367            | "-fsanitize-address-use-after-scope"
1368            | "-fno-sanitize-address-use-after-scope" => {}
1369            _ if arg.starts_with("-fsanitize-sections=") => {}
1370            // Counting which edges a run reached, which is how a fuzzer knows an input was worth
1371            // keeping. Refused rather than dropped, because a fuzzer whose calls into
1372            // `__sanitizer_cov_*` were never generated runs blind and reports coverage of nothing,
1373            // and there is no point in the campaign where that announces itself.
1374            _ if arg.starts_with("-fsanitize-coverage=") => {
1375                let how = &arg["-fsanitize-coverage=".len()..];
1376                for one in how.split(',') {
1377                    if !matches!(one, "trace-pc" | "trace-cmp") {
1378                        return Err(err(format!(
1379                            "`{one}` is not a coverage instrumentation, which is trace-pc or \
1380                             trace-cmp"
1381                        )));
1382                    }
1383                }
1384                return Err(err(format!(
1385                    "{arg}: this compiler generates no coverage callbacks, and a fuzzer built \
1386                     with it would run without any feedback at all, see \
1387                     spec/04-driver-and-cli.md section 4.7"
1388                )));
1389            }
1390            // The optimizer's own flags, from section 9.10 of `spec/09-optimizer.md`. These come
1391            // after every `-f` the rest of the compiler answers to, so a pass can never take a
1392            // name that already means something else on the command line.
1393            _ if arg.starts_with("-fpass-fuel=") => {
1394                let (name, count) = arg["-fpass-fuel=".len()..]
1395                    .split_once('=')
1396                    .ok_or_else(|| err("-fpass-fuel= is spelled <pass>=<count>"))?;
1397                if rucc_opt::pass::find(name).is_none() {
1398                    return Err(err(format!(
1399                        "`{name}` is not a pass this compiler has, see --print-pipeline"
1400                    )));
1401                }
1402                let count: u32 = count
1403                    .parse()
1404                    .map_err(|_| err(format!("`{count}` is not a number of transformations")))?;
1405                opts.pass_fuel.push((name.to_owned(), count));
1406            }
1407            _ if arg.starts_with("-fpass-fuel-global=") => {
1408                let count = &arg["-fpass-fuel-global=".len()..];
1409                let count: u32 = count
1410                    .parse()
1411                    .map_err(|_| err(format!("`{count}` is not a number of transformations")))?;
1412                opts.pass_fuel_global = Some(count);
1413            }
1414            // Everything from `-fopt-info` to the end of the argument, which is optional
1415            // keywords joined by hyphens and an optional `=<file>`. Checked here rather than
1416            // where the remarks are printed, because by then the compilation somebody wanted
1417            // to hear about is over.
1418            _ if arg == "-fopt-info"
1419                || arg.starts_with("-fopt-info=")
1420                || arg.starts_with("-fopt-info-") =>
1421            {
1422                let rest = &arg["-fopt-info".len()..];
1423                let (kinds, file) = match rest.split_once('=') {
1424                    Some((kinds, file)) => (kinds, Some(file)),
1425                    None => (rest, None),
1426                };
1427                let kinds = kinds.strip_prefix('-').unwrap_or(kinds);
1428                rucc_opt::Wants::none().add(kinds).map_err(err)?;
1429                opts.opt_info.push(kinds.to_owned());
1430                if let Some(file) = file {
1431                    if file.is_empty() {
1432                        return Err(err("-fopt-info= was given no file to write to"));
1433                    }
1434                    opts.opt_info_file = Some(file.to_owned());
1435                }
1436            }
1437            _ if arg.starts_with("-fdump-ir=") => {
1438                // Checked here rather than where the dumps are taken, because the compilation
1439                // that would have been dumped is over by then.
1440                let spec = &arg["-fdump-ir=".len()..];
1441                rucc_opt::Dumps::default().add(spec).map_err(err)?;
1442                opts.dump_ir.push(spec.to_owned());
1443            }
1444            // Before the bare `-f<pass>` below, because a pass called `enable-something` would
1445            // otherwise take the flag away from the gate. Checked here rather than where the
1446            // pipeline reads it, for the reason that applies to all of these: a misspelled pass
1447            // name that quietly gated nothing looks exactly like a pass that is not the guilty
1448            // one, and a bisection would carry on past the thing it was looking for.
1449            _ if arg.starts_with("-fdisable-") || arg.starts_with("-fenable-") => {
1450                let on = arg.starts_with("-fenable-");
1451                let spec = &arg[if on { "-fenable-".len() } else { "-fdisable-".len() }..];
1452                rucc_opt::Gates::default().add(on, spec).map_err(err)?;
1453                opts.pass_gates.push((on, spec.to_owned()));
1454            }
1455            _ if arg.strip_prefix("-fno-").is_some_and(|n| rucc_opt::pass::find(n).is_some()) => {
1456                opts.passes.push((arg["-fno-".len()..].to_owned(), false));
1457            }
1458            _ if arg.strip_prefix("-f").is_some_and(|n| rucc_opt::pass::find(n).is_some()) => {
1459                opts.passes.push((arg["-f".len()..].to_owned(), true));
1460            }
1461            // The flags that name a pass of gcc's own. They arrive from the torture suite, where a
1462            // program reduced from a miscompilation usually names the pass that miscompiled it on
1463            // its `dg-options` line, and they arrive from hand written build files for the same
1464            // reason. Section 4.1 sorts a flag by what the output would be without it, and by that
1465            // rule these are one pile: a flag that turns one of gcc's passes on or off is asking
1466            // for a compiler that does not exist here, and the program it is attached to is a
1467            // correctness test that passes either way. Turning on a pass we do not have costs
1468            // speed, turning off a pass we do not have costs nothing, and neither changes what the
1469            // program computes.
1470            //
1471            // rucc's own pass names are matched above this, so `-fno-dce` turns off the dce this
1472            // compiler has rather than landing here, and the day one of these names becomes a pass
1473            // here it stops being taken and dropped without anybody editing this list.
1474            //
1475            // Two of them are prefixes rather than names, which is the one place this file takes a
1476            // family instead of a flag. gcc files its gimple passes under `-ftree-` and its
1477            // interprocedural passes under `-fipa-`, both namespaces are pass selection and
1478            // nothing else, and there is no member of either that changes the meaning of a program
1479            // that was already correct. The rest are written out one at a time, because they live
1480            // in the flat `-f` namespace where the neighbours do change meanings.
1481            _ if arg.starts_with("-ftree-") || arg.starts_with("-fno-tree-") => {}
1482            _ if arg.starts_with("-fipa-") || arg.starts_with("-fno-ipa-") => {}
1483            "-fexpensive-optimizations" | "-fno-expensive-optimizations" => {}
1484            "-fmodulo-sched" | "-fno-modulo-sched" => {}
1485            "-fvect-cost-model" | "-fno-vect-cost-model" => {}
1486            _ if arg.starts_with("-fvect-cost-model=") || arg.starts_with("-fsimd-cost-model=") => {
1487            }
1488            "-fearly-inlining" | "-fno-early-inlining" => {}
1489            "-finline"
1490            | "-fno-inline"
1491            | "-finline-functions"
1492            | "-fno-inline-functions"
1493            | "-finline-small-functions"
1494            | "-fno-inline-small-functions"
1495            | "-finline-functions-called-once"
1496            | "-fno-inline-functions-called-once" => {}
1497            "-foptimize-strlen" | "-fno-optimize-strlen" => {}
1498            "-fira-share-spill-slots" | "-fno-ira-share-spill-slots" => {}
1499            // The charset flags are not in that pile, because an encoding is a statement about
1500            // what the bytes of the source mean rather than about how fast the output is. The
1501            // preprocessor reads UTF-8 and has no converter, so the one name that describes what
1502            // already happens is taken and every other name is refused. Spelled without regard to
1503            // case and with both of the spellings iconv answers to, since a build writes whichever
1504            // one its author typed.
1505            _ if arg.starts_with("-finput-charset=") => {
1506                let name = &arg["-finput-charset=".len()..];
1507                if !name.eq_ignore_ascii_case("utf-8") && !name.eq_ignore_ascii_case("utf8") {
1508                    return Err(err(format!(
1509                        "-finput-charset={name}: the preprocessor reads UTF-8 and has no \
1510                         converter, so a file in another encoding would be read as though it were \
1511                         UTF-8 rather than converted",
1512                    )));
1513                }
1514            }
1515            // The three that come in on the same `dg-options` lines and are the other half of
1516            // section 4.1's rule, because each of them changes what the program does and not how
1517            // fast it does it. The negative form of each is what this compiler does anyway, so it
1518            // is taken and dropped, which is the shape `-fnested-functions` has above.
1519            "-ffast-math" => {
1520                return Err(err(
1521                    "-ffast-math is a licence to answer a floating point arithmetic differently \
1522                     from the way the source wrote it, and it is not one flag: it defines \
1523                     __FAST_MATH__, which a library header reads, and gcc links a startup file \
1524                     that puts the hardware in flush to zero mode for the whole process. Taking it \
1525                     and dropping it would change what other objects in the same program answer. \
1526                     -ffp-contract= and -fexcess-precision= are the parts of it this compiler has",
1527                ));
1528            }
1529            "-fno-fast-math" => {}
1530            "-fnon-call-exceptions" => {
1531                return Err(err(
1532                    "-fnon-call-exceptions is a promise that an instruction which is not a call \
1533                     can raise an exception the unwinder finds a handler for, and nothing here \
1534                     produces a landing pad for a trapping instruction. A program built without it \
1535                     would unwind past the handler it wrote",
1536                ));
1537            }
1538            "-fno-non-call-exceptions" => {}
1539            "-finstrument-functions" => {
1540                return Err(err(
1541                    "-finstrument-functions calls __cyg_profile_func_enter on entry to every \
1542                     function and __cyg_profile_func_exit on the way out, and nothing here emits \
1543                     either call. A program that asks for them usually counts them, so taking the \
1544                     flag and dropping it would turn a program that fails loudly into one that \
1545                     fails quietly",
1546                ));
1547            }
1548            "-fno-instrument-functions" => {}
1549            // The unstable options, spelled the way rustc spells them and carrying the same
1550            // promise, which is none: one of these may change or go away in any release. They are
1551            // measurements and debugging aids rather than things a build asks for, which is why
1552            // none of them is in the usage text and all of them are in section 4.11 of
1553            // `spec/04-driver-and-cli.md`.
1554            "-Zverify-each" => opts.verify_each = true,
1555            _ if arg.starts_with("-Zrule-coverage=") => {
1556                let file = &arg["-Zrule-coverage=".len()..];
1557                if file.is_empty() {
1558                    return Err(err("-Zrule-coverage= needs a file to write to"));
1559                }
1560                opts.rule_coverage = Some(file.to_owned());
1561            }
1562            _ if arg.starts_with("-Zregister-pressure=") => {
1563                let file = &arg["-Zregister-pressure=".len()..];
1564                if file.is_empty() {
1565                    return Err(err("-Zregister-pressure= needs a file to write to"));
1566                }
1567                opts.register_pressure = Some(file.to_owned());
1568            }
1569            _ if arg.starts_with("-Z") => {
1570                return Err(err(format!(
1571                    "`{arg}` is not an unstable option this compiler has, see \
1572                     spec/04-driver-and-cli.md section 4.11 for the ones it does"
1573                )));
1574            }
1575            // The word size, which is a statement about the target and is taken as one. A build
1576            // that says the size the target already has is saying nothing, and one that says the
1577            // other size is asking for a target this compiler does not have, which it is told
1578            // rather than being given the wrong one.
1579            "-m64" | "-m32" | "-mx32" => {
1580                let want: u32 = match arg {
1581                    "-m64" => 64,
1582                    _ => 32,
1583                };
1584                let have = rucc_target::TargetInfo::new(opts.target).pointer_width;
1585                if have != want {
1586                    return Err(err(format!(
1587                        "{arg} asks for a {want} bit target and {} is {have} bit, use \
1588                         --target= to name the one you mean",
1589                        opts.target
1590                    )));
1591                }
1592            }
1593            // Which processor in the family to generate for. This compiler emits the base
1594            // instruction set of the architecture and nothing above it, so a program built with
1595            // any of these runs on the machine that was named; it is a program that could have
1596            // been faster rather than a program that is wrong, which is what makes these safe to
1597            // take and ignore where a flag that changed the meaning of the code would not be.
1598            _ if arg.starts_with("-march=")
1599                || arg.starts_with("-mtune=")
1600                || arg.starts_with("-mcpu=") => {}
1601            // The calling convention, which is not safe to ignore. Taken when it names the one
1602            // the target already uses and refused otherwise.
1603            _ if arg.starts_with("-mabi=") => {
1604                let want = &arg["-mabi=".len()..];
1605                let have = match opts.target.arch {
1606                    rucc_target::Arch::X86_64 => "sysv",
1607                    rucc_target::Arch::Aarch64 => "lp64",
1608                    rucc_target::Arch::Riscv64 => "lp64d",
1609                };
1610                if want != have {
1611                    return Err(err(format!(
1612                        "{arg}: {} uses the {have} convention and this compiler has no other",
1613                        opts.target
1614                    )));
1615                }
1616            }
1617            // How far apart the pieces of the program may be. The small model is what we emit and
1618            // it is every hosted program's default; the kernel model is a different one and a
1619            // build that asks for it and does not get it links and then does not run.
1620            "-mcmodel=small" => {}
1621            _ if arg.starts_with("-mcmodel=") => {
1622                return Err(err(format!(
1623                    "{arg}: this compiler emits the small code model and no other, see \
1624                     spec/12-targets.md"
1625                )));
1626            }
1627            // GCC's own scripting language for how the driver builds a command line.
1628            // `spec/04-driver-and-cli.md` section 4.4 settles that we will not have it, so a
1629            // build reaching for it is told which flags do the same job.
1630            _ if arg.starts_with("-specs=") => {
1631                return Err(err(
1632                    "-specs= is not supported: the parts of it builds rely on are -B, -L, \
1633                     -nostdlib, -nostartfiles and -Wl,, see spec/04-driver-and-cli.md \
1634                     section 4.4",
1635                ));
1636            }
1637            // Arguments meant for a separate assembler or preprocessor, which this compiler does
1638            // not have: both are inside it and neither reads a command line. Refused rather than
1639            // dropped, because every one of these says something about the output and a build
1640            // that asked for `-Wa,--noexecstack` and was silently given an executable stack got
1641            // the opposite of what it asked for.
1642            _ if arg.starts_with("-Wa,") || arg.starts_with("-Wp,") => {
1643                return Err(err(format!(
1644                    "`{arg}` is an argument for a separate assembler or preprocessor, and both \
1645                     are inside this compiler rather than programs it runs"
1646                )));
1647            }
1648            "-Xassembler" | "-Xpreprocessor" => {
1649                return Err(err(format!(
1650                    "{arg} hands an argument to a separate assembler or preprocessor, and both \
1651                     are inside this compiler rather than programs it runs"
1652                )));
1653            }
1654            // Everything else in the `-W` family. `spec/04-driver-and-cli.md` section 4.1 has
1655            // this one as a rule about build systems rather than about warnings: autoconf finds
1656            // out whether a warning flag exists by passing it and looking at the exit status, so
1657            // a compiler that refuses one it has not heard of fails a configure script written
1658            // for a GCC newer than itself. The names are not checked against a list because this
1659            // compiler has no warning groups for a list to be of, which #485 is about.
1660            _ if arg.starts_with("-W") => {}
1661            // Flags that name something this compiler does not do and would not do differently
1662            // if it did. `-fno-ident` is about a comment in the output that we do not write
1663            // either way, and the others are about a way of ordering the compilation that has
1664            // been GCC's only way for twenty years. Section 4.1 asks for the list to be short
1665            // and for adding to it to be deliberate, which is why it is written out here.
1666            "-fno-ident"
1667            | "-fident"
1668            | "-funit-at-a-time"
1669            | "-fno-unit-at-a-time"
1670            | "-shared-libgcc"
1671            | "-static-libgcc" => {}
1672            _ if arg.starts_with('-') && arg.len() > 1 => {
1673                // Silently ignoring an unknown flag is how a build ends up not doing what
1674                // its author asked. spec/13-gnu-compat.md section 13.4 makes this an error
1675                // for the flags that change code generation, and the safe default until the
1676                // flag table is populated is to reject everything we do not know.
1677                return Err(err(format!("unknown option `{arg}`")));
1678            }
1679            _ => inputs.push(Input { path: arg.to_owned(), forced, library: false }),
1680        }
1681    }
1682
1683    // The fetch, before anything that resolves a compilation, because `--fetch` does not describe
1684    // one. It is here rather than in the loop so that `--offline` can forbid it whichever order the
1685    // two were written in, and it is before the refusals below so that a command line asking for a
1686    // sysroot is not told about a sanitizer.
1687    if let Some(named) = fetch {
1688        return fetch_action(&named, offline, &inputs);
1689    }
1690
1691    // Last, so that it lands after every `-isystem` the command line gave. That is GCC's
1692    // order: a directory the user names outranks the compiler's own, and the compiler's own
1693    // outranks the library's. It is pushed after the loop rather than before it because
1694    // `SearchPath` appends within a group and the position is what the order is.
1695    // The same directory the headers were looked for under, because a sysroot is a statement
1696    // about a whole installation and not about half of one.
1697    // After the loop, because `-fno-sanitize=` can take back what an earlier flag asked for and a
1698    // command line that turns a check on and off again has asked for nothing. What is left is
1699    // refused rather than dropped, and it is the one place in this parser where the reason is not
1700    // that the output would differ. A sanitizer is a promise that the program is watched while it
1701    // runs, so a build that asks for one and is quietly given a program with no checks in it does
1702    // not get a slower program or a bigger file, it gets a test suite that passes for the wrong
1703    // reason. `-fsafety=` is the checking this compiler does have, and the message says so, because
1704    // somebody reaching for `-fsanitize=address` wants the nearest thing rather than a list of
1705    // options.
1706    if let Some(first) = sanitizers.first() {
1707        return Err(err(format!(
1708            "-fsanitize={first}: this compiler has no sanitizer instrumentation, and a build that \
1709             asked for one and got none would run its tests unchecked, see \
1710             spec/04-driver-and-cli.md section 4.7. `-fsafety=detect` is the memory checking this \
1711             compiler does have"
1712        )));
1713    }
1714    link.sysroot = sysroot.clone();
1715    // Where a sysroot for a target that is not this machine would be. Read once, here, rather than
1716    // inside the link line, because a link line that read the environment could only be tested on a
1717    // machine whose environment said the right thing, and the link line is the last thing that
1718    // touches a binary. `spec/cross-compile/13-distribution.md` section 13.2 owns the answer.
1719    link.cache = Some(cache::dir());
1720    // And the ten field spelling of the target, because the release on it decides two things the
1721    // three field one cannot say: whether a target that is this architecture is still a cross
1722    // compile, and which directory under the cache it is against. After the loop because the last
1723    // `--target=` on the command line is the one that counts.
1724    link.pinned = pinned;
1725    // After the loop rather than where `-pthread` was read, so that it lands after the objects
1726    // that refer to it. A static link takes the definitions it needs from a library when it
1727    // reaches it and not afterwards, so a library before the objects is a library that answers
1728    // nothing.
1729    if threads {
1730        inputs.push(Input::library("pthread"));
1731    }
1732    if let Some(query) = query {
1733        return Ok(Action::Print(answer(&query, &opts, &link)?));
1734    }
1735    // `-M` and `-MM` produce the rule and nothing else, so the run stops after phase 4 whatever
1736    // else the command line asked for. Read here rather than where the flag was, because a `-c`
1737    // written after it has to lose and the loop cannot know that until it has ended. The output
1738    // file is where the rule goes rather than where an object would have gone, and the last
1739    // phase being the preprocessor is what makes that true without a second rule for it.
1740    if opts.deps.instead_of_compiling {
1741        opts.emit = EmitKind::Preprocessed;
1742    }
1743    if !nostdinc {
1744        opts.search.push_system(runtime::DIR);
1745        // And the library's after ours, which is the other half of the same order. They go on
1746        // here rather than at the point `--target=` or `--sysroot=` was read because either
1747        // one changes the answer and the last word on both is the end of the loop.
1748        //
1749        // Which library's is the question `link::cross_sysroot` answers, and it is asked here so
1750        // that the headers and the libraries come from the same place. A target that is this
1751        // machine reads this machine's headers, and a target that is not reads the ones in the
1752        // sysroot for it rather than the ones next door.
1753        let cross = link::cross_sysroot(opts.target, &link);
1754        let kernel = link::cross_kernel(opts.target, &link);
1755        // And the version of those headers, which only the bundled tree has an answer for. A host
1756        // glibc and a tree the user named both define `__GLIBC_MINOR__` in their own `features.h`,
1757        // and a second definition with a different value is a warning on every file, so the
1758        // condition is the same one that chose the directories.
1759        if cross.is_some() {
1760            let target = pinned.unwrap_or_else(|| opts.target.tuple());
1761            opts.glibc_minor = rucc_sysroot::bundled_glibc_minor(target).map_err(|skew| {
1762                err(format!(
1763                    "{skew}; pin a release the tree has, or name a tree that has that one \
1764                     with --sysroot"
1765                ))
1766            })?;
1767        }
1768        let system =
1769            library::header_dirs(opts.target, sysroot.as_deref(), cross.as_ref(), kernel.as_ref());
1770        // The two licence walls of `spec/cross-compile/13-distribution.md` section 13.4, which are
1771        // the only way step 3 comes back with nothing on a hosted target. Section 8.6 asks for the
1772        // answer to name the licence and the lawful ways to get what is behind it, rather than
1773        // leaving a person with an `#include` that failed as though a directory had gone missing.
1774        //
1775        // It is left on the search path instead of refused here, because a program that includes
1776        // none of the library needs none of the SDK and section 8.6 is explicit that targeting the
1777        // platform has to keep working. So the reason waits until an include has actually failed,
1778        // which is the only moment it helps and the only moment it is true.
1779        //
1780        // The condition is that step 3 found nothing at all, so an `SDKROOT`, an `INCLUDE` or a mac
1781        // with Xcode on it all pass through untouched, and `-nostdinc` never reaches this block. A
1782        // `--sysroot` or `-isysroot` passes through as well, even when the tree it names turns out to
1783        // be empty or absent: somebody who wrote a path has already answered the question this
1784        // message asks, and answering it again over the top of a mistyped directory would hide the
1785        // mistake behind a licence notice.
1786        if system.is_empty() && sysroot.is_none() {
1787            let tuple = pinned.unwrap_or_else(|| opts.target.tuple());
1788            if let Some(wall) = rucc_sysroot::Wall::of(tuple) {
1789                opts.search.explain_missing_system(wall.no_headers(&tuple.to_canonical_string()));
1790            }
1791        }
1792        for dir in system {
1793            opts.search.push_system(dir);
1794        }
1795    }
1796    // Once, here, rather than as each directory is pushed. A `-I` that names a system
1797    // directory has to lose to the system entry and the system entry is added last, so the
1798    // question cannot be answered until the whole path is known.
1799    opts.search.remove_duplicates();
1800
1801    // The target has to be resolved before the configuration is printed, so this check comes
1802    // after the loop rather than at the point `--print-config` was seen.
1803    if print_config {
1804        return Ok(Action::PrintConfig(Box::new(opts)));
1805    }
1806    if print_pipeline {
1807        return Ok(Action::PrintPipeline(Box::new(opts)));
1808    }
1809    let plan = Plan::new(&opts, &inputs, output.as_deref()).map_err(|e| err(e.message))?;
1810    if print_plan {
1811        return Ok(Action::PrintPlan {
1812            opts: Box::new(opts),
1813            plan: Box::new(plan),
1814            link: Box::new(link),
1815        });
1816    }
1817    Ok(Action::Compile {
1818        opts: Box::new(opts),
1819        plan: Box::new(plan),
1820        link: Box::new(link),
1821        jobs,
1822        verbose,
1823    })
1824}
1825
1826/// What `--fetch <tuple>` asked for, or why it is not a thing that can be done.
1827///
1828/// The lookup happens here rather than at the point the bytes would move, so that a target this
1829/// release pins nothing for is a refusal from the parser and the only code that runs a downloader is
1830/// code that already knows what it is getting.
1831///
1832/// # Errors
1833///
1834/// [`CliError`] when `--offline` forbade it, when there are input files as well, when the tuple is
1835/// not a target this compiler knows, when its sysroot is behind one of section 13.4's licence walls,
1836/// and when this release pins no artifact for it.
1837fn fetch_action(named: &str, offline: bool, inputs: &[Input]) -> Result<Action, CliError> {
1838    // Not a precedence question. Section 13.2 says `--offline` forbids a fetch entirely, so a
1839    // command line that writes both has asked for two opposite things and the answer is to say so
1840    // rather than to pick one of them.
1841    if offline {
1842        return Err(err(
1843            "--fetch asks for a download and --offline forbids every download, so this command \
1844             line asks for two opposite things. Drop one of them: --offline is how a build says it \
1845             will not reach the network, and --fetch is the only thing in this compiler that does",
1846        ));
1847    }
1848    if let Some(first) = inputs.first() {
1849        return Err(err(format!(
1850            "--fetch gets a sysroot and compiles nothing, so `{}` on the same command line is an \
1851             input that nothing would read",
1852            first.path
1853        )));
1854    }
1855    let target: TargetTuple = named
1856        .parse()
1857        .map_err(|why| err(format!("--fetch {named}: {why}, so there is no sysroot to get")))?;
1858    // The canonical spelling, because that is what a row is named by and what the directory under
1859    // the cache is called, and a person is free to write a tuple the long way round.
1860    let tuple = target.to_canonical_string();
1861    // Before the table is consulted, because a target behind a licence wall is not a row that has not
1862    // been written yet. Section 13.4 is that no release pins one of these ever, so the message says
1863    // the licence and the two lawful ways rather than naming the producer that will publish the rest.
1864    if let Some(wall) = rucc_sysroot::Wall::of(target) {
1865        return Err(err(format!("--fetch {tuple}: {}", wall.no_fetch(&tuple))));
1866    }
1867    let Some(what) = rucc_sysroot::pinned_for(&tuple) else {
1868        return Err(err(unpinned(&tuple)));
1869    };
1870    Ok(Action::Fetch { what, target, cache: cache::dir() })
1871}
1872
1873/// Why there is nothing to fetch for a target, which is a different sentence while the table is
1874/// empty.
1875///
1876/// A release that pins nothing and a release that pins eleven targets and not this one are two
1877/// situations, and a message that did not tell them apart would send somebody looking for a typo in
1878/// their tuple when the answer is that this work is not finished.
1879fn unpinned(tuple: &str) -> String {
1880    let pinned = rucc_sysroot::pinned_targets();
1881    if pinned.is_empty() {
1882        return format!(
1883            "this release pins no sysroot for {tuple}, and it pins none for any target yet. A \
1884             sysroot is built and published by the producer in tamnd/rucc-cross, per \
1885             spec/cross-compile/13-distribution.md section 13.8, and a release of this compiler \
1886             names one by URL and by hash afterwards. Until then, pass --sysroot=<dir> to compile \
1887             against a tree you have already"
1888        );
1889    }
1890    format!(
1891        "this release pins no sysroot for {tuple}. What it pins is {}. Pass --sysroot=<dir> to \
1892         compile against a tree you have already",
1893        pinned.join(", ")
1894    )
1895}
1896
1897/// Gets the artifact and installs it, saying what each step did.
1898///
1899/// The steps are section 13.8's and so are the messages: the transport is somebody else's program
1900/// and the check is ours, so a person reading this wants to know which downloader ran, that the
1901/// bytes matched, how many files the record named and where the tree ended up. A fetch of something
1902/// that is already there says that instead and moves nothing.
1903fn fetch_sysroot(what: &rucc_sysroot::Pinned, target: TargetTuple, cache: &std::path::Path) -> i32 {
1904    let tuple = target.to_canonical_string();
1905    let archive = what.archive_in(cache);
1906    let say = |line: &str| println!("rucc: {tuple}: {line}");
1907    match fetch::fetch(what.url, what.sha256, &archive) {
1908        Ok(fetch::Fetched::AlreadyThere) => {
1909            say(&format!("{} is already here and matches the hash", archive.display()));
1910        }
1911        Ok(fetch::Fetched::Downloaded(by)) => {
1912            say(&format!("downloaded {} with {}", what.url, by.program()));
1913        }
1914        Err(why) => return complain(why),
1915    }
1916    match install::install(&archive, what.sha256, target, cache) {
1917        Ok(done) => {
1918            match &done.before {
1919                install::Before::Nothing => {
1920                    say(&format!("{} files installed at {}", done.files, done.root.display()));
1921                }
1922                install::Before::TheSame => {
1923                    say(&format!(
1924                        "the same sysroot is already at {}, so nothing moved",
1925                        done.root.display()
1926                    ));
1927                }
1928                install::Before::Different(was) => {
1929                    say(&format!(
1930                        "{} files installed at {}, over a tree whose record digested to {was}",
1931                        done.files,
1932                        done.root.display()
1933                    ));
1934                }
1935            }
1936            say(&format!("the record digests to {}", done.digest));
1937            0
1938        }
1939        Err(why) => complain(why),
1940    }
1941}
1942
1943/// What one of the `-dump` and `-print` flags prints.
1944///
1945/// GCC prints the name back unchanged when it cannot find the file a `-print` flag asked about,
1946/// which is what makes the answer safe to paste into a link line whether or not the file is
1947/// there, and this does the same.
1948fn answer(query: &Query, opts: &Options, link: &LinkOptions) -> Result<String, CliError> {
1949    let found = |name: &str| {
1950        link::find_in_search(link, opts.target, name)
1951            .map_or_else(|| name.to_owned(), |path| path.display().to_string())
1952    };
1953    Ok(match query {
1954        Query::Machine => opts.target.to_string(),
1955        Query::Version => VERSION.to_owned(),
1956        Query::Multiarch => link::multiarch(opts.target),
1957        // The three lines GCC prints, in its order and with its punctuation, because what reads
1958        // them is a script written against that shape. There is no installation directory to
1959        // report: this compiler is one binary that works wherever it is copied, and the headers
1960        // it ships are inside it, so `install` is where the binary is and nothing is under it.
1961        Query::SearchDirs => {
1962            let here = std::env::current_exe()
1963                .ok()
1964                .and_then(|p| p.parent().map(std::path::Path::to_path_buf))
1965                .unwrap_or_default();
1966            let list = |dirs: &[PathBuf]| {
1967                dirs.iter().map(|d| d.display().to_string()).collect::<Vec<_>>().join(":")
1968            };
1969            let libraries = link::search_dirs(link, opts.target);
1970            format!(
1971                "install: {}\nprograms: ={}\nlibraries: ={}",
1972                here.display(),
1973                list(&link.prefixes),
1974                list(&libraries)
1975            )
1976        }
1977        // The root the rest of the answers are under, which a build system asks for when it wants
1978        // to find a file itself rather than ask for one by name, and which is the first thing to
1979        // look at when a cross build read a header nobody expected. A native compile has no
1980        // sysroot and the answer is the empty line, which is what GCC prints when it was
1981        // configured without one. `--sysroot` wins over ours because it wins everywhere else.
1982        Query::Sysroot => {
1983            sysroot_root(opts, link).map(|root| root.display().to_string()).unwrap_or_default()
1984        }
1985        // Section 13.5 of `spec/cross-compile/13-distribution.md`: for every input that is not this
1986        // compiler's own code, what it is, where it was got, its hash, its licence and whether it
1987        // was bundled, generated or fetched. What is printed is the manifest the sysroot already
1988        // carries rather than a second format saying the same things, because the three uses 13.5
1989        // gives for this are a licence notice, a reproducibility check and a security audit, and all
1990        // three are somebody else parsing it. One format is one parser to write.
1991        // Read and rendered rather than copied out, so that what comes back is the format this
1992        // build understands. The last newline comes off because whatever prints an answer adds
1993        // one, the way it does for every other query here. Keeping it would put a blank line at
1994        // the end of the one answer that is a file somebody diffs against the file it came from.
1995        Query::SysrootProvenance => match sysroot_manifest(opts, link)? {
1996            Some(manifest) => manifest.render().trim_end_matches('\n').to_string(),
1997            None => String::new(),
1998        },
1999        // Section 13.2 of the same document, which asks for the hash of a cache directory's
2000        // contents in the directory's name. A name cannot carry one, because the path has to be
2001        // computable before anything has been read, by the producer about to write the files and by
2002        // the compiler about to read them, and neither has the contents when it asks. So the number
2003        // is here instead, and it is the sha256 of the record rather than of a walk of the tree,
2004        // which means `sha256sum` over the manifest answers the same thing.
2005        Query::SysrootDigest => match sysroot_manifest(opts, link)? {
2006            Some(manifest) => manifest.digest(),
2007            None => String::new(),
2008        },
2009        Query::FileName(name) => found(name),
2010        // The name GCC gives the library of routines a compiler's output calls that the C
2011        // library does not have. Ours is built in and there is no file, so the answer is the
2012        // name itself, which is what GCC prints when it cannot find one either.
2013        Query::Libgcc => found("libgcc.a"),
2014        // A program rather than a library: the linker and the archiver are the ones a build asks
2015        // about, and this compiler finds them on the path or under `-B` rather than shipping
2016        // them, so the name back is the honest answer unless a `-B` prefix holds one.
2017        Query::ProgName(name) => link
2018            .prefixes
2019            .iter()
2020            .map(|dir| dir.join(name))
2021            .find(|path| path.is_file())
2022            .map_or_else(|| name.clone(), |path| path.display().to_string()),
2023    })
2024}
2025
2026/// The root every sysroot answer is about.
2027///
2028/// One function rather than a copy in each, because the other flags exist to say what is inside the
2029/// tree this one names, and two answers that disagreed about which tree that is would be a
2030/// difference nobody would think to look for. `--sysroot` wins over ours because it wins everywhere
2031/// else.
2032fn sysroot_root(opts: &Options, link: &LinkOptions) -> Option<PathBuf> {
2033    link.sysroot
2034        .clone()
2035        .or_else(|| link::cross_sysroot(opts.target, link).map(|at| at.root().to_path_buf()))
2036}
2037
2038/// The record of the sysroot this command line reads, when there is one to read.
2039///
2040/// [`None`] covers two cases that both print nothing, and they are different things. A compile for
2041/// this machine has no sysroot at all, and a tree somebody laid out themselves and pointed
2042/// `--sysroot` at carries no manifest, so nothing here knows where any of it came from. Saying
2043/// nothing is the only honest answer to either, and a reader can tell it from a manifest with no
2044/// inputs in it because that one still has its header lines.
2045///
2046/// # Errors
2047///
2048/// A manifest this build cannot parse, and anything else that went wrong reading the file. Passing a
2049/// record we could not read on to whoever asked would make their parser the one that finds the
2050/// problem, and every use section 13.5 gives for these two flags is somebody else reading the
2051/// output.
2052fn sysroot_manifest(opts: &Options, link: &LinkOptions) -> Result<Option<Manifest>, CliError> {
2053    let Some(root) = sysroot_root(opts, link) else {
2054        return Ok(None);
2055    };
2056    let path = Sysroot::at(root, opts.target.tuple()).manifest_path();
2057    match std::fs::read_to_string(&path) {
2058        Ok(text) => Manifest::parse(&text)
2059            .map(Some)
2060            .map_err(|why| err(format!("{}: {why}", path.display()))),
2061        Err(why) if why.kind() == std::io::ErrorKind::NotFound => Ok(None),
2062        Err(why) => Err(err(format!("{}: {why}", path.display()))),
2063    }
2064}
2065
2066/// Renders the passes this level will run, in order, with what each one does.
2067///
2068/// The level is the whole of the answer unless a `-f` flag edited it, which is section 9.1 of
2069/// `spec/09-optimizer.md`: a level is a list somebody wrote down rather than something that
2070/// emerges from which flags happen to be set, and this is how that list is read.
2071#[must_use]
2072pub fn print_pipeline(opts: &Options) -> String {
2073    let mut settings = rucc_opt::Options::for_level(opts.opt_level);
2074    settings.toggles.clone_from(&opts.passes);
2075    settings.global_fuel = opts.pass_fuel_global;
2076    for (on, spec) in &opts.pass_gates {
2077        // Every spelling was checked while the arguments were parsed, so there is nothing here
2078        // this can refuse, and a listing is not the place to report it if there were.
2079        let _ = settings.gates.add(*on, spec);
2080    }
2081    rucc_opt::pipeline::print(&settings)
2082}
2083
2084/// Renders the resolved configuration.
2085///
2086/// One `key: value` per line, sorted by nothing in particular but fixed in order, because
2087/// this output is diffed across hosts in CI and a reordering would read as a change.
2088#[must_use]
2089pub fn print_config(opts: &Options) -> String {
2090    let sess = Session::new(opts.clone());
2091    let t = &sess.target;
2092    let mut out = String::new();
2093    let _ = writeln!(out, "version: {VERSION}");
2094    // The three field triple the driver was given rather than the ten field tuple it widens to,
2095    // because this output is what a build system reads to find out what it asked for. The tuple is
2096    // the compiler's model of the machine and this line is a receipt for a command line.
2097    let _ = writeln!(out, "target: {}", opts.target);
2098    let _ = writeln!(out, "arch: {}", opts.target.arch.as_str());
2099    let _ = writeln!(out, "os: {}", opts.target.os.as_str());
2100    let _ = writeln!(out, "env: {}", opts.target.env.as_str());
2101    let _ = writeln!(out, "object-format: {}", t.object_format.as_str());
2102    let _ = writeln!(out, "pointer-width: {}", t.pointer_width);
2103    let _ = writeln!(out, "long-width: {}", t.long_width);
2104    let _ = writeln!(out, "long-double-width: {}", t.long_double_width);
2105    let _ = writeln!(out, "endian: {}", if t.little_endian { "little" } else { "big" });
2106    let _ = writeln!(out, "char-signed: {}", t.char_is_signed);
2107    let _ = writeln!(out, "va-list: {}", t.va_list.map_or("none", |list| list.as_str()));
2108    // The register file as a count per class, which is enough to tell a target whose registers
2109    // are described from one whose are not without printing sixteen names nobody asked for.
2110    let regs: Vec<String> = t
2111        .regs
2112        .classes()
2113        .map(|(class, info)| format!("{} {}", info.name, t.regs.len(class)))
2114        .collect();
2115    let _ = writeln!(
2116        out,
2117        "registers: {}",
2118        if regs.is_empty() { "none".to_string() } else { regs.join(", ") }
2119    );
2120    let _ = writeln!(out, "opt-level: {}", sess.opts.opt_level);
2121    let _ = writeln!(out, "safety: {}", sess.opts.safety);
2122    let _ = writeln!(out, "emit: {}", sess.opts.emit.as_str());
2123    let _ = writeln!(out, "debug-info: {}", sess.opts.debug_info);
2124    let _ = writeln!(out, "frame-pointer: {}", sess.opts.frame_pointer);
2125    let _ = writeln!(out, "red-zone: {}", sess.opts.red_zone);
2126    let _ = writeln!(out, "stack-protector: {}", sess.opts.protector);
2127    let _ = writeln!(out, "stack-clash-protection: {}", sess.opts.stack_clash);
2128    let _ = writeln!(out, "cf-protection: {}", sess.opts.control);
2129    let _ = writeln!(out, "patchable-function-entry: {}", sess.opts.patchable);
2130    let _ = writeln!(out, "profile: {}", sess.opts.profile);
2131    let _ = writeln!(out, "profile-hook: {}", sess.opts.hook);
2132    // Last because it is the one key with more than one line under it, and the only one
2133    // whose value is a property of the machine rather than of the command line.
2134    for dir in sess.opts.search.dirs() {
2135        let system = if dir.is_system { " (system)" } else { "" };
2136        let _ = writeln!(out, "include: {}{system}", dir.path.display());
2137    }
2138    out
2139}
2140
2141/// The output name the make target is taken from, which is the `-o` argument or nothing.
2142///
2143/// A run that stops at the preprocessor has not named an object, whatever its `-o` says: under
2144/// `-E` that argument is the preprocessed text and under `-M` it is the rule itself, and neither
2145/// is a file `make` would rebuild by running this rule. GCC agrees and falls back to the source
2146/// name in both, which is why a `-MD -E -o out.i` writes `out.d` holding a rule for `a.o`. From
2147/// `-S` on the argument does name what the rule builds, and it is used as written.
2148fn deps_target_output<'a>(opts: &Options, plan: &'a Plan) -> Option<&'a str> {
2149    if opts.emit == EmitKind::Preprocessed { None } else { plan.output.as_deref() }
2150}
2151
2152/// Writes to a path the command line named rather than one the plan derived, where `-` is
2153/// standard output.
2154fn write_named(path: &str, bytes: &[u8]) -> Result<(), String> {
2155    if path == "-" {
2156        return write_out(&Output::Stdout, bytes);
2157    }
2158    write_out(&Output::File(path.to_owned()), bytes)
2159}
2160
2161/// Writes the make rule for one input, and reports whether it got there.
2162///
2163/// A rule with no file of its own goes where the compilation it replaced would have written,
2164/// which is what makes the usual makefile recipe work: `rucc -M $< -o $@` leaves the rule in
2165/// `$@`, and the same line with the `-o` left off puts it on standard output.
2166fn write_deps(
2167    opts: &Options,
2168    plan: &Plan,
2169    job: &Job,
2170    found: &[Dependency],
2171    stderr: &mut impl std::io::Write,
2172) -> bool {
2173    let targets = if opts.deps.targets.is_empty() {
2174        vec![deps::default_target(&job.input, deps_target_output(opts, plan))]
2175    } else {
2176        opts.deps.targets.clone()
2177    };
2178    let rule = deps::rule(&opts.deps, &targets, &job.input, found);
2179    // The file, on the other hand, is named after the `-o` in every mode that still has one to
2180    // spend, which is every mode except the two that spend it on the rule.
2181    let wrote = match deps::default_file(&opts.deps, &job.input, plan.output.as_deref()) {
2182        // A `-MF` on a run that had nowhere else to put the rule leaves the file the `-o`
2183        // named empty rather than absent, because a makefile that named it as a target of its
2184        // own is a makefile that will look for it.
2185        Some(path) => write_named(&path, rule.as_bytes()).and_then(|()| {
2186            if opts.deps.instead_of_compiling { write_out(&job.output, b"") } else { Ok(()) }
2187        }),
2188        None => write_out(&job.output, rule.as_bytes()),
2189    };
2190    if let Err(e) = wrote {
2191        let _ = writeln!(stderr, "rucc: error: {e}");
2192        return false;
2193    }
2194    true
2195}
2196
2197/// Runs phase 4 over every input that has one, and writes what came out.
2198///
2199/// One input that fails does not stop the others. A build that reports every file it could
2200/// not preprocess in one run is worth more than one that stops at the first, and the exit
2201/// status is still a failure either way.
2202fn preprocess_all(opts: &Options, plan: &Plan) -> i32 {
2203    let fs = OsFileSystem::new();
2204    let mut stderr = std::io::stderr().lock();
2205    let mut failed = false;
2206    for job in &plan.jobs {
2207        if !job.phases.first().is_some_and(|p| *p == Phase::Preprocess) {
2208            // An input that is already preprocessed, or an object file. GCC passes these
2209            // through untouched, and the plan has already said so in its notes.
2210            continue;
2211        }
2212        let started = std::time::Instant::now();
2213        let result = preprocess(opts, &job.input, &fs);
2214        if opts.time {
2215            say_time(&job.input, started.elapsed(), &mut stderr);
2216        }
2217        for message in &result.messages {
2218            let _ = writeln!(stderr, "{message}");
2219        }
2220        if result.failed() {
2221            failed = true;
2222            continue;
2223        }
2224        if opts.deps.emit {
2225            failed |= !write_deps(opts, plan, job, &result.deps, &mut stderr);
2226            // `-M` and `-MM` asked for the rule instead of the text, so there is nothing else
2227            // to write. The other two asked for both and fall through to the text below.
2228            if opts.deps.instead_of_compiling {
2229                continue;
2230            }
2231        }
2232        if let Err(e) = write_out(&job.output, result.text.as_bytes()) {
2233            let _ = writeln!(stderr, "rucc: error: {e}");
2234            failed = true;
2235        }
2236    }
2237    i32::from(failed)
2238}
2239
2240/// Runs the front end over every input that has a compile phase, and writes what came out.
2241///
2242/// The same rule as [`preprocess_all`]: one input that fails does not stop the others, and the
2243/// exit status is a failure either way. An input that is already assembly or an object has no
2244/// compile phase and is passed over here, which the plan has already said in its notes.
2245fn compile_all(opts: &Options, plan: &Plan) -> i32 {
2246    let fs = OsFileSystem::new();
2247    let mut stderr = std::io::stderr().lock();
2248    let mut failed = false;
2249    let (mut remarks, ok) = Remarks::new(opts.opt_info_file.as_ref(), &mut stderr);
2250    failed |= !ok;
2251    let mut fired = Fired::new();
2252    let mut pressure = Pressure::new();
2253    for job in &plan.jobs {
2254        if !job.phases.contains(&Phase::Compile) {
2255            continue;
2256        }
2257        // An input of IR is read back rather than compiled, since the C it came from is not
2258        // here any more. Everything after this is the same, so the two paths meet again at the
2259        // messages and the file the result is written to.
2260        let started = std::time::Instant::now();
2261        let result = if job.kind == InputKind::Ir {
2262            compile_ir(opts, &job.input, &fs)
2263        } else {
2264            compile(opts, &job.input, &fs)
2265        };
2266        if opts.time {
2267            say_time(&job.input, started.elapsed(), &mut stderr);
2268        }
2269        fired.merge(&result.fired);
2270        pressure.merge(&result.pressure);
2271        failed |= !write_dumps(&job.input, &result.dumps, &mut stderr);
2272        failed |= !remarks.write(&result.remarks, &mut stderr);
2273        for message in &result.messages {
2274            let _ = writeln!(stderr, "{message}");
2275        }
2276        // Before the failure below, because a compilation that stopped in the back end is exactly
2277        // the one whose preprocessed source somebody wants to look at.
2278        failed |= !write_temps(job, &result.temps, &mut stderr);
2279        if result.failed() {
2280            failed = true;
2281            continue;
2282        }
2283        // `-MD` and `-MMD` write the rule beside the object and let the compilation happen, so
2284        // this is the one path where both files come out of the same run. An input of IR has no
2285        // dependencies to report and produces an empty list, which produces a rule naming only
2286        // itself, and that is the honest answer rather than a missing file.
2287        if opts.deps.emit {
2288            failed |= !write_deps(opts, plan, job, &result.deps, &mut stderr);
2289        }
2290        if let Err(e) = write_out(&job.output, result.artifact.bytes()) {
2291            let _ = writeln!(stderr, "rucc: error: {e}");
2292            failed = true;
2293        }
2294    }
2295    failed |= !write_coverage(opts, &fired, &mut stderr);
2296    failed |= !write_pressure(opts, &pressure, &mut stderr);
2297    i32::from(failed)
2298}
2299
2300/// A directory for the object files only the link step ever sees, removed when it goes away.
2301///
2302/// `-c` writes its object where the user can see it and linking does not, which is the whole of
2303/// the difference: a `rucc a.c b.c` leaves an executable behind and nothing else, the same as
2304/// every other compiler. Removing them on drop rather than at the end of a function is so that a
2305/// link that failed leaves nothing behind either.
2306struct Scratch {
2307    /// Where the objects go.
2308    dir: PathBuf,
2309}
2310
2311impl Scratch {
2312    /// Makes one, under whatever the platform calls its temporary directory.
2313    ///
2314    /// The name carries the process id so that two compilers running at once do not share a
2315    /// directory, which they would otherwise do the moment two of them compiled a file of the
2316    /// same name.
2317    fn new() -> Result<Scratch, String> {
2318        let dir = std::env::temp_dir().join(format!("rucc-{}", std::process::id()));
2319        std::fs::create_dir_all(&dir).map_err(|e| format!("{}: {e}", dir.display()))?;
2320        Ok(Scratch { dir })
2321    }
2322}
2323
2324impl Drop for Scratch {
2325    fn drop(&mut self) {
2326        let _ = std::fs::remove_dir_all(&self.dir);
2327    }
2328}
2329
2330/// The link line the plan describes, for `-###`.
2331///
2332/// The names in it are the hints the plan carries rather than the temporaries a real compilation
2333/// would choose, because `-###` prints the line without having compiled anything and so has
2334/// nothing to point at. That also makes the printed line readable rather than naming a directory
2335/// that only exists while a compilation is running.
2336fn link_line(opts: &Options, link: &LinkOptions, job: &LinkJob) -> Result<String, link::Error> {
2337    let linker = link::find(opts.target, link)?;
2338    let args = link::line(opts.target, link, &job.inputs, &job.output)?;
2339    Ok(link::render(&linker, &args))
2340}
2341
2342/// Compiles everything, then links it.
2343///
2344/// The objects go in a directory that is removed afterwards, which is why this is not
2345/// [`compile_all`] followed by a link: the plan says an object feeding the linker is temporary
2346/// and does not say where, because where is a question that only has an answer once something is
2347/// running.
2348fn link_all(opts: &Options, plan: &Plan, link: &LinkOptions, verbose: bool) -> i32 {
2349    let Some(job) = &plan.link else {
2350        // Every path into here comes from a plan whose last phase is the link, and such a plan
2351        // has a link job. Saying so is cheaper than an unwrap that would have to be explained.
2352        let mut stderr = std::io::stderr().lock();
2353        let _ = writeln!(stderr, "rucc: error: there is nothing to link");
2354        return 1;
2355    };
2356    // Before anything is compiled, because a linker that is not on the machine is worth knowing
2357    // about in the second it takes to look rather than after the compilation.
2358    // And before that, whether this link has a line at all and whether what it reads is on the
2359    // machine. Both are answerable now, and a target whose sysroot has not been built is worth
2360    // saying so about before the compilation rather than after it.
2361    if let Err(why) = link::preflight(opts.target, link) {
2362        return complain(why);
2363    }
2364    let linker = match link::find(opts.target, link) {
2365        Ok(linker) => linker,
2366        Err(why) => return complain(why),
2367    };
2368
2369    let scratch = match Scratch::new() {
2370        Ok(scratch) => scratch,
2371        Err(why) => return complain(format!("could not make a place for the object files: {why}")),
2372    };
2373
2374    let fs = OsFileSystem::new();
2375    let mut failed = false;
2376    // One per job, in job order, which is what lets the link line below be rebuilt with the real
2377    // paths in it: every job contributes exactly one file to the line and does so in this order.
2378    let mut produced: Vec<String> = Vec::with_capacity(plan.jobs.len());
2379    let mut fired = Fired::new();
2380    let mut pressure = Pressure::new();
2381    {
2382        let mut stderr = std::io::stderr().lock();
2383        let (mut remarks, ok) = Remarks::new(opts.opt_info_file.as_ref(), &mut stderr);
2384        failed |= !ok;
2385        for (at, job) in plan.jobs.iter().enumerate() {
2386            let out = match &job.output {
2387                Output::Temporary(hint) => {
2388                    // The index because two inputs in different directories can have the same
2389                    // name, and the two objects of `rucc a/x.c b/x.c` must not be one file.
2390                    scratch.dir.join(format!("{at}-{hint}")).display().to_string()
2391                }
2392                Output::File(path) => path.clone(),
2393                // A job feeding the linker never writes to standard output, since the plan gives
2394                // it a temporary. This is here so that the match is total rather than a panic.
2395                Output::Stdout => continue,
2396            };
2397            produced.push(out.clone());
2398            if !job.phases.contains(&Phase::Compile) {
2399                continue;
2400            }
2401            let started = std::time::Instant::now();
2402            let result = if job.kind == InputKind::Ir {
2403                compile_ir(opts, &job.input, &fs)
2404            } else {
2405                compile(opts, &job.input, &fs)
2406            };
2407            if opts.time {
2408                say_time(&job.input, started.elapsed(), &mut stderr);
2409            }
2410            fired.merge(&result.fired);
2411            pressure.merge(&result.pressure);
2412            failed |= !write_dumps(&job.input, &result.dumps, &mut stderr);
2413            failed |= !remarks.write(&result.remarks, &mut stderr);
2414            for message in &result.messages {
2415                let _ = writeln!(stderr, "{message}");
2416            }
2417            failed |= !write_temps(job, &result.temps, &mut stderr);
2418            if result.failed() {
2419                failed = true;
2420                continue;
2421            }
2422            // A `-MD` on a command line that links writes the rule next to the executable and
2423            // names the executable as its target, since that is the file this source builds
2424            // here. The object it went through is in a temporary directory and is gone by the
2425            // time `make` reads any of this.
2426            if opts.deps.emit {
2427                failed |= !write_deps(opts, plan, job, &result.deps, &mut stderr);
2428            }
2429            if !matches!(result.artifact, Artifact::Object { .. }) {
2430                // Worth saying rather than writing whatever it is and letting the linker read it.
2431                // An empty file is a valid empty linker script, so a link handed one gets as far
2432                // as reporting every symbol of this file undefined, which is a page of messages
2433                // about something that went wrong here.
2434                let _ = writeln!(
2435                    stderr,
2436                    "rucc: internal error: {}: no object file was produced for the link",
2437                    job.input
2438                );
2439                failed = true;
2440                continue;
2441            }
2442            if let Err(e) = std::fs::write(&out, result.artifact.bytes()) {
2443                let _ = writeln!(stderr, "rucc: error: {out}: {e}");
2444                failed = true;
2445            }
2446        }
2447        failed |= !write_coverage(opts, &fired, &mut stderr);
2448        failed |= !write_pressure(opts, &pressure, &mut stderr);
2449    }
2450    if failed {
2451        // Nothing is linked from a compilation that did not finish. A linker run over the objects
2452        // that did compile would report every function of the file that did not as undefined,
2453        // which is a page of messages about a mistake already reported once.
2454        return 1;
2455    }
2456
2457    // The items in command line order with the temporaries filled in. A library contributes no
2458    // job and passes through, and every file item takes the next job's real output, which is
2459    // what keeps a library that was written between two objects between them here.
2460    let mut outputs = produced.into_iter();
2461    let mut items = Vec::with_capacity(job.inputs.len());
2462    for item in &job.inputs {
2463        match item {
2464            link::Item::Library(name) => items.push(link::Item::Library(name.clone())),
2465            link::Item::File(_) => match outputs.next() {
2466                Some(path) => items.push(link::Item::File(path)),
2467                None => return complain("the plan asks the linker for a file nothing produced"),
2468            },
2469        }
2470    }
2471
2472    let args = match link::line(opts.target, link, &items, &job.output) {
2473        Ok(args) => args,
2474        Err(why) => return complain(why),
2475    };
2476    if verbose {
2477        let mut stderr = std::io::stderr().lock();
2478        let _ = writeln!(stderr, "{}", link::render(&linker, &args));
2479    }
2480    let started = std::time::Instant::now();
2481    let ran = link::run(&linker, &args);
2482    if opts.time {
2483        // The one step of a compilation that really is another program, so this line is the same
2484        // measurement gcc's is and names the linker the way gcc names `collect2`.
2485        let mut stderr = std::io::stderr().lock();
2486        say_time(&linker.name, started.elapsed(), &mut stderr);
2487    }
2488    match ran {
2489        Ok(()) => 0,
2490        // The linker has already said what was wrong on its own error output, and repeating that
2491        // linking failed would only push its message further up the screen.
2492        Err(link::Error::Refused { .. }) => 1,
2493        Err(why) => complain(why),
2494    }
2495}
2496
2497/// Compiles everything and writes the objects into one static library.
2498///
2499/// No temporary directory and no second program. The objects never reach the file system at all:
2500/// they go from the compiler into the archive writer, which is both faster than writing a directory
2501/// of files for an `ar` to read back and the reason the symbol index can be written at all. A
2502/// member's index entries are the names the object writer says it wrote, and the only thing that
2503/// knows those is the run that wrote it.
2504///
2505/// `-save-temps` is the exception. It asked for the objects to be kept, the plan gave them names a
2506/// person can find, and they are written there as well as put in the archive.
2507fn archive_all(opts: &Options, plan: &Plan) -> i32 {
2508    let Some(job) = &plan.archive else {
2509        // Every path into here comes from a plan whose last phase is the archive, and such a plan
2510        // has an archive job. Saying so is cheaper than an unwrap that would have to be explained.
2511        return complain("there is nothing to put in an archive");
2512    };
2513    // Before anything is compiled, because a format this has no container for is worth knowing
2514    // about in the second it takes to look rather than after the whole compilation.
2515    let flavour = match opts.target.os.object_format() {
2516        ObjectFormat::Elf => rucc_archive::Flavour::Gnu,
2517        ObjectFormat::Coff => rucc_archive::Flavour::Coff,
2518        // Mach-O wants the BSD flavour, whose index is a different member under a different name,
2519        // and wasm has no archives of its own at all. Neither has an object writer either, so a
2520        // command line reaching this would have failed in the next step regardless.
2521        format @ (ObjectFormat::MachO | ObjectFormat::Wasm) => {
2522            return complain(format!(
2523                "there is no archive format for {} objects in this compiler yet",
2524                format.as_str()
2525            ));
2526        }
2527    };
2528
2529    let fs = OsFileSystem::new();
2530    let mut failed = false;
2531    let mut members: Vec<rucc_archive::Member> = Vec::with_capacity(plan.jobs.len());
2532    let mut names = job.members.iter();
2533    let mut fired = Fired::new();
2534    let mut pressure = Pressure::new();
2535    {
2536        let mut stderr = std::io::stderr().lock();
2537        let (mut remarks, ok) = Remarks::new(opts.opt_info_file.as_ref(), &mut stderr);
2538        failed |= !ok;
2539        for plan_job in &plan.jobs {
2540            // What the plan called this member. The two lists are walked together rather than the
2541            // name being worked out again here, so that what `-###` printed and what goes in the
2542            // file cannot come apart.
2543            let Some(member) = names.next() else {
2544                return complain("the plan asks the archive for a member nothing produced");
2545            };
2546            if !plan_job.phases.contains(&Phase::Compile) {
2547                // Assembly, which enters the pipeline after the compile phase. There is no
2548                // assembler for a file of text in this compiler, so there is no object to put in,
2549                // and an archive quietly missing one is worse than a message about it.
2550                let _ = writeln!(
2551                    &mut stderr,
2552                    "rucc: error: {}: this compiler has no assembler for a file of assembly yet, \
2553                     so it cannot go into an archive",
2554                    plan_job.input
2555                );
2556                failed = true;
2557                continue;
2558            }
2559            let started = std::time::Instant::now();
2560            let result = if plan_job.kind == InputKind::Ir {
2561                compile_ir(opts, &plan_job.input, &fs)
2562            } else {
2563                compile(opts, &plan_job.input, &fs)
2564            };
2565            if opts.time {
2566                say_time(&plan_job.input, started.elapsed(), &mut stderr);
2567            }
2568            fired.merge(&result.fired);
2569            pressure.merge(&result.pressure);
2570            failed |= !write_dumps(&plan_job.input, &result.dumps, &mut stderr);
2571            failed |= !remarks.write(&result.remarks, &mut stderr);
2572            for message in &result.messages {
2573                let _ = writeln!(stderr, "{message}");
2574            }
2575            failed |= !write_temps(plan_job, &result.temps, &mut stderr);
2576            if result.failed() {
2577                failed = true;
2578                continue;
2579            }
2580            if opts.deps.emit {
2581                failed |= !write_deps(opts, plan, plan_job, &result.deps, &mut stderr);
2582            }
2583            let Artifact::Object { bytes, defines } = result.artifact else {
2584                let _ = writeln!(
2585                    stderr,
2586                    "rucc: internal error: {}: no object file was produced for the archive",
2587                    plan_job.input
2588                );
2589                failed = true;
2590                continue;
2591            };
2592            // Under `-save-temps` the plan gave the object a name a person can find, so it is
2593            // written there too. Otherwise it is only ever a member and never a file.
2594            if let Output::File(path) = &plan_job.output {
2595                if let Err(e) = std::fs::write(path, &bytes) {
2596                    let _ = writeln!(stderr, "rucc: error: {path}: {e}");
2597                    failed = true;
2598                }
2599            }
2600            members.push(rucc_archive::Member { name: member.clone(), body: bytes, defines });
2601        }
2602        failed |= !write_coverage(opts, &fired, &mut stderr);
2603        failed |= !write_pressure(opts, &pressure, &mut stderr);
2604    }
2605    if failed {
2606        // Nothing is written from a compilation that did not finish, for the reason the link gives:
2607        // an archive missing the file that failed is one a link reports every name of as undefined,
2608        // which is a page of messages about a mistake already reported once.
2609        return 1;
2610    }
2611
2612    let bytes = match rucc_archive::write(flavour, &members) {
2613        Ok(bytes) => bytes,
2614        // Every one of these is a bug here rather than a program's mistake: the names came from the
2615        // object writer and the bodies came from this process.
2616        Err(why) => return complain(format!("the archive could not be written: {why}")),
2617    };
2618    match std::fs::write(&job.output, &bytes) {
2619        Ok(()) => 0,
2620        Err(e) => complain(format!("{}: {e}", job.output)),
2621    }
2622}
2623
2624/// Prints one driver level message and gives back the exit status that goes with it.
2625fn complain(why: impl std::fmt::Display) -> i32 {
2626    let mut stderr = std::io::stderr().lock();
2627    let _ = writeln!(stderr, "rucc: error: {why}");
2628    1
2629}
2630
2631/// Writes what `-Zrule-coverage=FILE` asked for, and says whether it could.
2632///
2633/// Once for the whole command line rather than once per input, because the question is which
2634/// lowering rules this run of the compiler reached and a file per input would leave the reader
2635/// unioning files to find out something one process already knew.
2636///
2637/// A file that could not be written is a failure and not a warning. What asks for this is a
2638/// measurement run, and a measurement that quietly did not happen is worse than one that stopped.
2639fn write_coverage(opts: &Options, fired: &Fired, stderr: &mut impl std::io::Write) -> bool {
2640    let Some(path) = &opts.rule_coverage else { return true };
2641    let Some(table) = coverage::table(opts.target.arch) else {
2642        let _ = writeln!(
2643            stderr,
2644            "rucc: error: there are no lowering rules for {} yet, so there is no coverage of them \
2645             to report",
2646            opts.target
2647        );
2648        return false;
2649    };
2650    match std::fs::write(path, fired.listing(table)) {
2651        Ok(()) => true,
2652        Err(e) => {
2653            let _ = writeln!(stderr, "rucc: error: {path}: {e}");
2654            false
2655        }
2656    }
2657}
2658
2659/// Writes what `-Zregister-pressure=FILE` asked for, and says whether it could.
2660///
2661/// Once for the whole command line, for the reason [`write_coverage`] gives, and a file that could
2662/// not be written is a failure for the reason it gives too. There is no equivalent of the missing
2663/// rule table here, since every target this compiles for has an allocator, and a run that reached
2664/// no back end at all writes an empty listing rather than nothing: a measurement of a build that
2665/// produced no code is still an answer and it is the honest one.
2666fn write_pressure(opts: &Options, pressure: &Pressure, stderr: &mut impl std::io::Write) -> bool {
2667    let Some(path) = &opts.register_pressure else { return true };
2668    match std::fs::write(path, pressure.listing()) {
2669        Ok(()) => true,
2670        Err(e) => {
2671            let _ = writeln!(stderr, "rucc: error: {path}: {e}");
2672            false
2673        }
2674    }
2675}
2676
2677/// Where the `-fopt-info` remarks go, and how much of the run has already gone there.
2678///
2679/// Standard error by default, and one file for the whole run when `-fopt-info=<file>` named one.
2680/// A file rather than the diagnostic stream is what a harness wants: the corpus in
2681/// `tamnd/rucc-corpus` matches a rejection against what the compiler said on standard error, and
2682/// a few thousand remarks mixed into that would bury it.
2683struct Remarks {
2684    /// The file, if there is one.
2685    file: Option<String>,
2686    /// Whether anything has been written to it yet, which decides between truncating and
2687    /// appending. One file holds the whole run rather than the last input in it.
2688    started: bool,
2689}
2690
2691impl Remarks {
2692    /// Prepares the destination, emptying the file if there is one.
2693    ///
2694    /// Emptied here rather than at the first remark, because a run where no pass had anything to
2695    /// say should leave an empty file and not yesterday's. An absent file and an empty one are
2696    /// different facts and something reading this will act on the difference.
2697    fn new(file: Option<&String>, stderr: &mut impl std::io::Write) -> (Self, bool) {
2698        let mut ok = true;
2699        if let Some(path) = file {
2700            if let Err(e) = std::fs::write(path, "") {
2701                let _ = writeln!(stderr, "rucc: error: {path}: {e}");
2702                ok = false;
2703            }
2704        }
2705        (Self { file: file.cloned(), started: false }, ok)
2706    }
2707
2708    /// Writes one input's remarks, and says whether that worked.
2709    ///
2710    /// A file that cannot be written is a failure and not a warning, for the reason
2711    /// [`write_dumps`] gives: remarks that quietly did not arrive look exactly like a compilation
2712    /// where nothing happened.
2713    fn write(&mut self, text: &str, stderr: &mut impl std::io::Write) -> bool {
2714        if text.is_empty() {
2715            return true;
2716        }
2717        let Some(path) = &self.file else {
2718            let _ = write!(stderr, "{text}");
2719            return true;
2720        };
2721        let opened = std::fs::OpenOptions::new()
2722            .write(true)
2723            .append(self.started)
2724            .truncate(!self.started)
2725            .create(true)
2726            .open(path);
2727        self.started = true;
2728        let result =
2729            opened.and_then(|mut file| std::io::Write::write_all(&mut file, text.as_bytes()));
2730        if let Err(e) = result {
2731            let _ = writeln!(stderr, "rucc: error: {path}: {e}");
2732            return false;
2733        }
2734        true
2735    }
2736}
2737
2738/// Writes what `-fdump-ir=` asked to see, one file per dump.
2739///
2740/// The name is the input file with the dump's own name and `.ir` after it, so a directory listing
2741/// after a run is the passes in the order they ran, per input. They go in the working directory
2742/// rather than beside the output, because a dump is something a person asked for at a prompt and
2743/// the working directory is where that person is.
2744///
2745/// A file that could not be written is a failure and not a warning, for the reason
2746/// [`write_coverage`] gives: what asked for this is somebody debugging a pass, and a dump that
2747/// quietly did not happen looks exactly like a pass that did not run.
2748fn write_dumps(input: &str, dumps: &[rucc_opt::Dump], stderr: &mut impl std::io::Write) -> bool {
2749    let stem = std::path::Path::new(input)
2750        .file_name()
2751        .map_or_else(|| input.to_owned(), |name| name.to_string_lossy().into_owned());
2752    let mut ok = true;
2753    for dump in dumps {
2754        let path = format!("{stem}.{}.ir", dump.name);
2755        if let Err(e) = std::fs::write(&path, &dump.text) {
2756            let _ = writeln!(stderr, "rucc: error: {path}: {e}");
2757            ok = false;
2758        }
2759    }
2760    ok
2761}
2762
2763/// Writes the files `-save-temps` kept, which is nothing at all unless it was given.
2764///
2765/// A file that could not be written is a failure rather than a warning, for the reason
2766/// [`write_dumps`] gives: somebody asked for these by name, and one that quietly did not happen
2767/// looks like a compilation that never went through that step.
2768fn write_temps(job: &Job, temps: &Temps, stderr: &mut impl std::io::Write) -> bool {
2769    let mut ok = true;
2770    let kept = [(job.saved_text(), &temps.preprocessed), (job.saved_asm(), &temps.assembly)];
2771    for (path, text) in kept {
2772        // A step the compilation did not reach has nothing to keep, and a job that is not keeping
2773        // that step has nowhere to put it. Either way there is no file here.
2774        let (Some(path), Some(text)) = (path, text) else { continue };
2775        if let Err(e) = std::fs::write(&path, text) {
2776            let _ = writeln!(stderr, "rucc: error: {path}: {e}");
2777            ok = false;
2778        }
2779    }
2780    ok
2781}
2782
2783/// One line of `-time`, which is what a step was called and how long it took.
2784///
2785/// GCC's two numbers are the user and the system time of a subprocess it ran. This compiler runs
2786/// no subprocess for anything but the link, so what is measured here is the wall clock of the
2787/// step and the second column is always zero. The shape of the line is kept because a person
2788/// reading it next to gcc's should not have to work out which column is which.
2789fn say_time(name: &str, took: std::time::Duration, stderr: &mut impl std::io::Write) {
2790    let _ = writeln!(stderr, "# {name} {:.2} {:.2}", took.as_secs_f64(), 0.0);
2791}
2792
2793/// Writes one job's result where the plan said it goes.
2794///
2795/// # Errors
2796///
2797/// Returns the message to print, which names the file when there is one, because "permission
2798/// denied" on its own does not say which file was refused.
2799fn write_out(output: &Output, bytes: &[u8]) -> Result<(), String> {
2800    match output {
2801        Output::Stdout => {
2802            let mut stdout = std::io::stdout().lock();
2803            stdout.write_all(bytes).map_err(|e| format!("writing to standard output: {e}"))
2804        }
2805        Output::File(path) | Output::Temporary(path) => {
2806            std::fs::write(path, bytes).map_err(|e| format!("{path}: {e}"))
2807        }
2808    }
2809}
2810
2811/// Runs the driver and returns the process exit code.
2812///
2813/// `args` excludes the program name. Output goes to `stdout` and errors to `stderr`, which
2814/// is the one place in the compiler that is true.
2815pub fn run(args: &[String]) -> i32 {
2816    match parse_args(args) {
2817        Ok(Action::Help) => {
2818            print!("{USAGE}");
2819            0
2820        }
2821        Ok(Action::Version) => {
2822            println!("rucc {VERSION}");
2823            0
2824        }
2825        Ok(Action::Print(line)) => {
2826            println!("{line}");
2827            0
2828        }
2829        Ok(Action::PrintConfig(opts)) => {
2830            print!("{}", print_config(&opts));
2831            0
2832        }
2833        Ok(Action::PrintPipeline(opts)) => {
2834            print!("{}", print_pipeline(&opts));
2835            0
2836        }
2837        Ok(Action::PrintPlan { opts, plan, link }) => {
2838            print!("{}", plan.render());
2839            // The line as it would be typed, which is the half of `-###` that section 4.3 says
2840            // arrives with the link. It is printed even when the linker is not on this machine,
2841            // because what a build wants from `-###` is what the compiler would do.
2842            if let Some(job) = &plan.link {
2843                match link_line(&opts, &link, job) {
2844                    Ok(line) => println!("{line}"),
2845                    Err(why) => {
2846                        let mut stderr = std::io::stderr().lock();
2847                        let _ = writeln!(stderr, "rucc: error: {why}");
2848                        return 1;
2849                    }
2850                }
2851            }
2852            0
2853        }
2854        Ok(Action::Fetch { what, target, cache }) => fetch_sysroot(what, target, &cache),
2855        Ok(Action::Compile { opts, plan, link, jobs, verbose }) => {
2856            {
2857                let mut stderr = std::io::stderr().lock();
2858                if verbose {
2859                    let _ = write!(stderr, "{}", plan.render());
2860                    let _ = writeln!(stderr, "workers: {}", jobs.count());
2861                }
2862            }
2863            if opts.emit == EmitKind::Preprocessed {
2864                return preprocess_all(&opts, &plan);
2865            }
2866            if opts.emit == EmitKind::Archive {
2867                return archive_all(&opts, &plan);
2868            }
2869            if opts.emit != EmitKind::Executable {
2870                return compile_all(&opts, &plan);
2871            }
2872            link_all(&opts, &plan, &link, verbose)
2873        }
2874        Err(e) => {
2875            let mut stderr = std::io::stderr().lock();
2876            let _ = writeln!(stderr, "rucc: error: {e}");
2877            let _ = writeln!(stderr, "rucc: note: run `rucc --help` for usage");
2878            1
2879        }
2880    }
2881}
2882
2883#[cfg(test)]
2884mod tests {
2885    use rucc_session::{
2886        Contract, GnucVersion, IncludeForm, LtoJobs, OptLevel, Partition, Patchable, Visibility,
2887    };
2888
2889    use super::*;
2890
2891    fn args(s: &[&str]) -> Vec<String> {
2892        s.iter().map(|x| (*x).to_owned()).collect()
2893    }
2894
2895    #[test]
2896    fn help_and_version_win_over_everything_else() {
2897        assert_eq!(parse_args(&args(&["-c", "--help", "x.c"])).unwrap(), Action::Help);
2898        assert_eq!(parse_args(&args(&["--version"])).unwrap(), Action::Version);
2899    }
2900
2901    fn compile(s: &[&str]) -> (Box<Options>, Box<Plan>) {
2902        match parse_args(&args(s)).expect("expected a compilation") {
2903            Action::Compile { opts, plan, .. } => (opts, plan),
2904            other => panic!("expected a compilation, got {other:?}"),
2905        }
2906    }
2907
2908    fn linking(s: &[&str]) -> (Box<LinkOptions>, Box<Plan>) {
2909        match parse_args(&args(s)).expect("expected a compilation") {
2910            Action::Compile { link, plan, .. } => (link, plan),
2911            other => panic!("expected a compilation, got {other:?}"),
2912        }
2913    }
2914
2915    #[test]
2916    fn collects_inputs_and_flags() {
2917        let (opts, plan) = compile(&["-c", "-O2", "-g", "a.c", "b.c"]);
2918        let paths: Vec<&str> = plan.jobs.iter().map(|j| j.input.as_str()).collect();
2919        assert_eq!(paths, vec!["a.c", "b.c"]);
2920        assert_eq!(opts.opt_level, OptLevel::O2);
2921        assert_eq!(opts.emit, EmitKind::Object);
2922        assert!(opts.debug_info);
2923    }
2924
2925    /// The unstable options, which are spelled apart from everything else on purpose: what is
2926    /// under `-Z` promises nothing, and a build that reaches for one should have had to say so.
2927    #[test]
2928    fn an_unstable_option_is_taken_and_one_that_does_not_exist_is_refused() {
2929        let (opts, _) = compile(&["-c", "-Zrule-coverage=/tmp/rules.cov", "a.c"]);
2930        assert_eq!(opts.rule_coverage.as_deref(), Some("/tmp/rules.cov"));
2931
2932        let (plain, _) = compile(&["-c", "a.c"]);
2933        assert_eq!(plain.rule_coverage, None, "nothing is measured unless it was asked for");
2934
2935        assert!(parse_args(&args(&["-Zrule-coverage=", "a.c"])).is_err(), "a file with no name");
2936        let unknown = parse_args(&args(&["-Zwhat", "a.c"])).expect_err("there is no such option");
2937        assert!(unknown.message.contains("4.11"), "{}", unknown.message);
2938    }
2939
2940    /// The other measurement written to a file, which reads the same way and fails the same way.
2941    #[test]
2942    fn where_the_register_pressure_goes_is_asked_for_the_same_way() {
2943        let (opts, _) = compile(&["-c", "-O2", "-Zregister-pressure=/tmp/spills.txt", "a.c"]);
2944        assert_eq!(opts.register_pressure.as_deref(), Some("/tmp/spills.txt"));
2945
2946        let (plain, _) = compile(&["-c", "a.c"]);
2947        assert_eq!(plain.register_pressure, None, "nothing is measured unless it was asked for");
2948
2949        assert!(parse_args(&args(&["-Zregister-pressure=", "a.c"])).is_err(), "no file named");
2950    }
2951
2952    #[test]
2953    fn a_bare_dash_o_means_o1_the_way_gcc_reads_it() {
2954        let (opts, _) = compile(&["-O", "a.c"]);
2955        assert_eq!(opts.opt_level, OptLevel::O1);
2956    }
2957
2958    #[test]
2959    fn dash_x_applies_to_later_inputs_only_and_none_stops_it() {
2960        let (_, plan) = compile(&["a.o", "-x", "c", "b.txt", "-x", "none", "c.o"]);
2961        assert_eq!(plan.jobs[0].kind, InputKind::LinkerInput);
2962        assert_eq!(plan.jobs[1].kind, InputKind::C);
2963        assert_eq!(plan.jobs[2].kind, InputKind::LinkerInput);
2964    }
2965
2966    #[test]
2967    fn dash_j_reaches_the_scheduler_and_defaults_to_the_machine() {
2968        let (_, _, jobs) = match parse_args(&args(&["-j4", "a.c"])).unwrap() {
2969            Action::Compile { opts, plan, jobs, .. } => (opts, plan, jobs),
2970            other => panic!("expected a compilation, got {other:?}"),
2971        };
2972        assert_eq!(jobs.count(), 4);
2973
2974        let default = match parse_args(&args(&["a.c"])).unwrap() {
2975            Action::Compile { jobs, .. } => jobs,
2976            other => panic!("expected a compilation, got {other:?}"),
2977        };
2978        assert_eq!(default, Jobs::available());
2979        assert!(parse_args(&args(&["-j0", "a.c"])).is_err());
2980    }
2981
2982    #[test]
2983    fn triple_hash_prints_the_plan_and_runs_nothing() {
2984        let a = parse_args(&args(&["-###", "-c", "a.c"])).unwrap();
2985        let Action::PrintPlan { plan, .. } = a else { panic!("expected a plan dump") };
2986        assert!(plan.render().contains("a.c: preprocess, compile, assemble -> a.o"));
2987    }
2988
2989    #[test]
2990    fn the_flag_that_keeps_the_intermediate_files_has_three_spellings_and_two_meanings() {
2991        // The bare one is `=obj` and not `=cwd`. gcc's manual says the opposite and gcc 16 does
2992        // this, and following the compiler is what makes a build that reads either of them find
2993        // the files where they are.
2994        assert_eq!(compile(&["-c", "-save-temps", "a.c"]).0.save_temps, SaveTemps::Object);
2995        assert_eq!(compile(&["-c", "-save-temps=obj", "a.c"]).0.save_temps, SaveTemps::Object);
2996        assert_eq!(compile(&["-c", "-save-temps=cwd", "a.c"]).0.save_temps, SaveTemps::Cwd);
2997        assert_eq!(compile(&["-c", "a.c"]).0.save_temps, SaveTemps::No);
2998        // The last one on the line decides, the way it does for every other flag with an
2999        // argument, and a keyword that is neither is fatal rather than ignored: a run that kept
3000        // nothing and said nothing looks exactly like one where the files were not produced.
3001        let (opts, _) = compile(&["-c", "-save-temps", "-save-temps=cwd", "a.c"]);
3002        assert_eq!(opts.save_temps, SaveTemps::Cwd);
3003        let e = parse_args(&args(&["-c", "-save-temps=nowhere", "a.c"])).unwrap_err();
3004        assert!(e.message.contains("accepted: cwd, obj"), "{}", e.message);
3005    }
3006
3007    #[test]
3008    fn the_flag_that_times_each_step_reaches_the_options_and_changes_nothing_else() {
3009        let (opts, plan) = compile(&["-c", "-time", "a.c"]);
3010        let (plain, without) = compile(&["-c", "a.c"]);
3011        assert!(opts.time);
3012        assert!(!plain.time);
3013        // Against the same line without the flag rather than against a spelling of the object's
3014        // name, since what the object is called is the host's business and this is not about that.
3015        assert_eq!(plan.jobs[0].output, without.jobs[0].output);
3016    }
3017
3018    #[test]
3019    fn dash_x_names_what_it_accepts_when_it_does_not_know_a_language() {
3020        let e = parse_args(&args(&["-x", "fortran", "a.c"])).unwrap_err();
3021        assert!(e.message.contains("assembler-with-cpp"), "{}", e.message);
3022    }
3023
3024    /// What `--fetch` says while the table in [`artifact`] has no rows in it, which is what every
3025    /// run of it says today and is the reason the message distinguishes the two cases.
3026    #[test]
3027    fn a_fetch_of_a_target_nothing_is_pinned_for_says_so_rather_than_reaching_the_network() {
3028        let e = parse_args(&args(&["--fetch", "x86_64-linux-musl"])).unwrap_err();
3029        assert!(e.message.contains("pins no sysroot for x86_64-linux-musl"), "{}", e.message);
3030        // And where one comes from, because the answer is not on this machine.
3031        assert!(e.message.contains("tamnd/rucc-cross"), "{}", e.message);
3032        // The joined spelling is the same flag.
3033        let joined = parse_args(&args(&["--fetch=x86_64-linux-musl"])).unwrap_err();
3034        assert_eq!(joined, e);
3035    }
3036
3037    /// The two targets a release will never pin, which is a different answer from the one above.
3038    ///
3039    /// Section 13.4. A person who reads "this release pins no sysroot yet" waits for a release that
3040    /// does, and no release of this compiler can ship either of these, so the message names the
3041    /// licence that decides it and what to do instead.
3042    #[test]
3043    fn a_fetch_of_a_target_behind_a_licence_wall_says_so_rather_than_saying_not_yet() {
3044        let e = parse_args(&args(&["--fetch", "aarch64-macos"])).unwrap_err();
3045        assert!(e.message.contains("Xcode licence"), "{}", e.message);
3046        assert!(e.message.contains("there never will be"), "{}", e.message);
3047        assert!(!e.message.contains("tamnd/rucc-cross"), "{}", e.message);
3048
3049        let e = parse_args(&args(&["--fetch", "x86_64-windows-msvc"])).unwrap_err();
3050        assert!(e.message.contains("redistributed"), "{}", e.message);
3051        // The way out of this one is a target rather than a download, and it is the default already.
3052        assert!(e.message.contains("mingw-w64"), "{}", e.message);
3053        // And the mingw-w64 target next to it is an ordinary unpinned target.
3054        let e = parse_args(&args(&["--fetch", "x86_64-windows-gnu"])).unwrap_err();
3055        assert!(e.message.contains("pins no sysroot"), "{}", e.message);
3056    }
3057
3058    /// An Apple target on a machine with no SDK, which is section 8.6's other host.
3059    ///
3060    /// Not run on a mac, where the SDK this is about is installed and the compile is the ordinary one
3061    /// that uses it. What the reason says is asserted in `rucc_sysroot::wall` and where it is printed
3062    /// is asserted in `rucc-pp`, so what is left here is that the driver works it out and leaves it
3063    /// where the preprocessor will find it, and that neither way past the wall leaves one behind.
3064    #[test]
3065    fn an_apple_target_with_no_sdk_anywhere_carries_the_licence_rather_than_a_missing_directory() {
3066        if cfg!(target_os = "macos") || std::env::var_os("SDKROOT").is_some() {
3067            return;
3068        }
3069        let (opts, _) = compile(&["--target=aarch64-macos", "-c", "a.c"]);
3070        let why = opts.search.missing_system().expect("the wall is the reason there are none");
3071        assert!(why.contains("aarch64-macos needs a macOS SDK"), "{why}");
3072        assert!(why.contains("Xcode licence"), "{why}");
3073        assert!(why.contains("-isysroot"), "{why}");
3074
3075        // A program that includes none of the library needs none of the SDK, which is what section
3076        // 8.6 means by being able to target the platform without one, so there is nothing to explain.
3077        let (opts, _) = compile(&["--target=aarch64-macos", "-nostdinc", "-c", "a.c"]);
3078        assert_eq!(opts.search.missing_system(), None);
3079        // And naming a path is the other way through, whether or not the path is there: a mistyped
3080        // directory is a mistake to report on its own terms rather than a licence to explain.
3081        let (opts, _) = compile(&["--target=aarch64-macos", "-isysroot", "/opt/sdk", "-c", "a.c"]);
3082        assert_eq!(opts.search.missing_system(), None);
3083    }
3084
3085    /// The same wall on the compile side of an MSVC target, where the way past it is a tuple.
3086    #[test]
3087    fn an_msvc_target_with_no_sdk_named_says_which_environment_needs_nothing_installed() {
3088        if std::env::var_os("INCLUDE").is_some() {
3089            return;
3090        }
3091        let (opts, _) = compile(&["--target=x86_64-windows-msvc", "-c", "a.c"]);
3092        let why = opts.search.missing_system().expect("the wall is the reason there are none");
3093        assert!(why.contains("the Windows SDK and its universal CRT"), "{why}");
3094        assert!(why.contains("mingw-w64"), "{why}");
3095        // And the mingw-w64 target has its headers from us, so nothing is missing to explain.
3096        let (opts, _) = compile(&["--target=x86_64-windows-gnu", "-c", "a.c"]);
3097        assert_eq!(opts.search.missing_system(), None);
3098    }
3099
3100    #[test]
3101    fn a_fetch_with_no_target_and_a_fetch_of_a_tuple_that_is_not_one_both_say_which() {
3102        let e = parse_args(&args(&["--fetch"])).unwrap_err();
3103        assert!(e.message.contains("--fetch requires"), "{}", e.message);
3104        let e = parse_args(&args(&["--fetch", "sparc64-solaris-gnu"])).unwrap_err();
3105        assert!(e.message.contains("--fetch sparc64-solaris-gnu"), "{}", e.message);
3106        assert!(e.message.contains("no sysroot to get"), "{}", e.message);
3107    }
3108
3109    /// Both flags on one line ask for opposite things, in either order.
3110    #[test]
3111    fn a_fetch_and_offline_together_is_a_refusal_whichever_way_round_they_are_written() {
3112        for line in [
3113            vec!["--offline", "--fetch", "x86_64-linux-musl"],
3114            vec!["--fetch", "x86_64-linux-musl", "--offline"],
3115        ] {
3116            let e = parse_args(&args(&line)).unwrap_err();
3117            assert!(e.message.contains("two opposite things"), "{}", e.message);
3118        }
3119    }
3120
3121    #[test]
3122    fn a_fetch_does_not_compile_anything_and_says_so_when_it_is_handed_a_file() {
3123        let e = parse_args(&args(&["--fetch", "x86_64-linux-musl", "a.c"])).unwrap_err();
3124        assert!(e.message.contains("compiles nothing"), "{}", e.message);
3125        assert!(e.message.contains("a.c"), "{}", e.message);
3126    }
3127
3128    /// `--offline` on its own is accepted and changes nothing, because an ordinary compile
3129    /// downloads nothing with or without it. A build that passes it everywhere is the case this is
3130    /// for, and it must not lose the compilation it was passed beside.
3131    #[test]
3132    fn offline_on_a_compilation_is_the_same_compilation() {
3133        let (opts, plan) = compile(&["-c", "--offline", "a.c"]);
3134        let (plain, without) = compile(&["-c", "a.c"]);
3135        assert_eq!(opts.target, plain.target);
3136        assert_eq!(plan.jobs.len(), without.jobs.len());
3137        assert_eq!(plan.jobs[0].output, without.jobs[0].output);
3138    }
3139
3140    #[test]
3141    fn an_unknown_flag_is_an_error_rather_than_a_shrug() {
3142        let e = parse_args(&args(&["-fno-such-thing", "a.c"])).unwrap_err();
3143        assert!(e.message.contains("unknown option"), "{}", e.message);
3144    }
3145
3146    /// `-fpermissive` and the flag that turns it back off, which a build writes beside it when
3147    /// one directory needs the older rules and the rest of the tree does not.
3148    #[test]
3149    fn permissive_reads_in_both_directions_and_the_last_one_wins() {
3150        let (opts, _) = compile(&["-c", "a.c"]);
3151        assert!(!opts.permissive, "off unless it is asked for");
3152
3153        let (opts, _) = compile(&["-c", "-fpermissive", "a.c"]);
3154        assert!(opts.permissive);
3155
3156        let (opts, _) = compile(&["-c", "-fpermissive", "-fno-permissive", "a.c"]);
3157        assert!(!opts.permissive);
3158    }
3159
3160    #[test]
3161    fn asking_for_nested_functions_is_told_why_it_is_not_coming() {
3162        let e = parse_args(&args(&["-fnested-functions", "a.c"])).unwrap_err();
3163        assert!(e.message.contains("trampoline"), "{}", e.message);
3164        assert!(parse_args(&args(&["-fno-nested-functions", "a.c"])).is_ok());
3165    }
3166
3167    #[test]
3168    fn the_flag_every_configure_script_writes_is_taken() {
3169        // All four spellings, because a build writes whichever one its macros picked and a
3170        // compiler that takes three of them is a compiler that fails on the fourth.
3171        for flag in ["-fPIC", "-fpic", "-fPIE", "-fpie"] {
3172            let (opts, _) = compile(&["-c", flag, "a.c"]);
3173            assert_eq!(opts.emit, EmitKind::Object, "{flag}");
3174        }
3175    }
3176
3177    #[test]
3178    fn a_table_is_written_unless_the_build_says_nothing_will_walk_it() {
3179        let (opts, _) = compile(&["-c", "a.c"]);
3180        assert!(opts.unwinds(), "the default is off");
3181        let (opts, _) = compile(&["-c", "-fno-asynchronous-unwind-tables", "a.c"]);
3182        assert!(!opts.unwinds(), "the build was not taken at its word");
3183        let (opts, _) = compile(&[
3184            "-c",
3185            "-fno-asynchronous-unwind-tables",
3186            "-fasynchronous-unwind-tables",
3187            "a.c",
3188        ]);
3189        assert!(opts.unwinds(), "the last flag did not win");
3190        // The weaker request, which the same table answers, so a line that asks for a table and
3191        // against an asynchronous one gets one. That is gcc's arrangement and it turns up when a
3192        // build turns the asynchronous one off globally and a directory asks for a table back.
3193        let (opts, _) =
3194            compile(&["-c", "-fno-asynchronous-unwind-tables", "-funwind-tables", "a.c"]);
3195        assert!(opts.unwinds(), "the weaker request was dropped");
3196        let (opts, _) = compile(&["-c", "-fno-unwind-tables", "a.c"]);
3197        assert!(opts.unwinds(), "the weaker negative turned off the stronger request");
3198        let (opts, _) =
3199            compile(&["-c", "-fno-unwind-tables", "-fno-asynchronous-unwind-tables", "a.c"]);
3200        assert!(!opts.unwinds(), "both were turned off and one stayed on");
3201    }
3202
3203    #[test]
3204    fn the_flags_that_describe_what_this_compiler_already_does_are_taken() {
3205        // Every one of these is on a real build line somewhere and every one of them was an
3206        // unknown option. What they have in common is that the answer rucc gives is the answer
3207        // they ask for, so there is nothing to implement and nothing to refuse.
3208        for flag in [
3209            "-fno-common",
3210            "-fstrict-aliasing",
3211            "-fno-strict-aliasing",
3212            "-fdelete-null-pointer-checks",
3213            "-fno-delete-null-pointer-checks",
3214            "-frounding-math",
3215            "-fno-rounding-math",
3216            "-fexcess-precision=standard",
3217            "-fexcess-precision=fast",
3218            "-fexcess-precision=16",
3219            "-pipe",
3220            "-fdiagnostics-color",
3221            "-fno-diagnostics-color",
3222            "-fdiagnostics-color=always",
3223            "-fdiagnostics-color=never",
3224            "-fdiagnostics-color=auto",
3225        ] {
3226            let (opts, _) = compile(&["-c", flag, "a.c"]);
3227            assert_eq!(opts.emit, EmitKind::Object, "{flag}");
3228        }
3229    }
3230
3231    #[test]
3232    fn whether_an_exception_is_looked_at_is_kept_and_defaults_to_gccs_answer() {
3233        let (opts, _) = compile(&["-c", "a.c"]);
3234        assert!(opts.trapping_math, "the default was not gcc's");
3235        let (opts, _) = compile(&["-c", "-fno-trapping-math", "a.c"]);
3236        assert!(!opts.trapping_math);
3237        let (opts, _) = compile(&["-c", "-ftrapping-math", "a.c"]);
3238        assert!(opts.trapping_math, "spelling out the default turned it off");
3239        // The last one written wins, which is how a build line that inherits a flag from one
3240        // place and overrides it in another is read.
3241        let (opts, _) = compile(&["-c", "-fno-trapping-math", "-ftrapping-math", "a.c"]);
3242        assert!(opts.trapping_math);
3243    }
3244
3245    /// The flags a torture program writes on its own `dg-options` line, which is where most of
3246    /// these come from: a program reduced from a miscompilation names the pass that miscompiled
3247    /// it. Eighteen programs in the suite stopped on the driver before anything read them, and
3248    /// tamnd/rucc#1019 is the list.
3249    #[test]
3250    fn the_flags_that_name_a_pass_of_gccs_own_are_taken_and_dropped() {
3251        for flag in [
3252            "-fno-tree-ccp",
3253            "-fno-tree-dominator-opts",
3254            "-fno-tree-vrp",
3255            "-fno-tree-bit-ccp",
3256            "-fno-tree-coalesce-vars",
3257            "-ftree-vectorize",
3258            "-ftree-loop-distribution",
3259            "-fno-ipa-cp",
3260            "-fipa-pta",
3261            "-fmodulo-sched",
3262            "-fno-vect-cost-model",
3263            "-fvect-cost-model=unlimited",
3264            "-fsimd-cost-model=cheap",
3265            "-fexpensive-optimizations",
3266            "-fno-early-inlining",
3267            "-fno-inline",
3268            "-finline-functions",
3269            "-foptimize-strlen",
3270            "-fno-ira-share-spill-slots",
3271        ] {
3272            let (opts, _) = compile(&["-c", flag, "a.c"]);
3273            assert_eq!(opts.emit, EmitKind::Object, "{flag}");
3274            assert!(opts.passes.is_empty(), "{flag} named a pass of gcc's and not one of ours");
3275        }
3276    }
3277
3278    /// The two namespaces are taken whole, so a name neither this test nor gcc 16 has heard of
3279    /// goes the same way as the ones above rather than stopping a build on the day gcc adds it.
3280    #[test]
3281    fn a_pass_name_in_either_family_is_taken_whether_or_not_it_is_one_gcc_has() {
3282        for flag in ["-ftree-no-such-pass", "-fno-ipa-no-such-pass"] {
3283            let (opts, _) = compile(&["-c", flag, "a.c"]);
3284            assert_eq!(opts.emit, EmitKind::Object, "{flag}");
3285        }
3286    }
3287
3288    /// A pass this compiler has keeps its flag, since the arms that read the registry are above
3289    /// the family arms. `dce` is the one both compilers have a name for, and `execute/pr97421-2.c`
3290    /// is the program that writes it.
3291    #[test]
3292    fn a_pass_name_this_compiler_has_is_still_read_as_a_pass() {
3293        let (opts, _) = compile(&["-c", "-fno-dce", "a.c"]);
3294        assert_eq!(opts.passes, vec![("dce".to_owned(), false)]);
3295    }
3296
3297    /// The encoding of the source is not a question about speed, so the one name that describes
3298    /// what the preprocessor does is taken and every other name is refused.
3299    #[test]
3300    fn the_input_charset_is_taken_when_it_names_the_one_that_is_read() {
3301        for flag in ["-finput-charset=utf-8", "-finput-charset=UTF-8", "-finput-charset=utf8"] {
3302            let (opts, _) = compile(&["-c", flag, "a.c"]);
3303            assert_eq!(opts.emit, EmitKind::Object, "{flag}");
3304        }
3305
3306        let e = parse_args(&args(&["-c", "-finput-charset=latin1", "a.c"])).unwrap_err();
3307        assert!(e.message.contains("latin1"), "{}", e.message);
3308        assert!(e.message.contains("UTF-8"), "what is read is worth saying: {}", e.message);
3309    }
3310
3311    /// The other half of the same rule. Each of these changes what the program does rather than
3312    /// how fast it does it, so each is refused with the reason, and the negative of each is what
3313    /// happens anyway and is taken.
3314    #[test]
3315    fn the_three_that_change_the_answer_are_refused_and_their_negatives_are_taken() {
3316        for (flag, word) in [
3317            ("-ffast-math", "__FAST_MATH__"),
3318            ("-fnon-call-exceptions", "landing pad"),
3319            ("-finstrument-functions", "__cyg_profile_func_enter"),
3320        ] {
3321            let e = parse_args(&args(&["-c", flag, "a.c"])).unwrap_err();
3322            assert!(e.message.contains(word), "{flag}: {}", e.message);
3323            assert!(!e.message.contains("unknown option"), "{flag} deserves a reason");
3324
3325            let off = format!("-fno-{}", flag.trim_start_matches("-f"));
3326            let (opts, _) = compile(&["-c", &off, "a.c"]);
3327            assert_eq!(opts.emit, EmitKind::Object, "{off}");
3328        }
3329    }
3330
3331    #[test]
3332    fn asking_the_linker_to_merge_tentative_definitions_is_told_why_it_is_not_coming() {
3333        // The one of that family that is a request rather than a description, and it is a real
3334        // difference: two files each writing `int g;` link under it and do not without it.
3335        let e = parse_args(&args(&["-fcommon", "a.c"])).unwrap_err();
3336        assert!(e.message.contains(".bss"), "{}", e.message);
3337        assert!(e.message.contains("extern"), "the way out is worth saying: {}", e.message);
3338    }
3339
3340    #[test]
3341    fn asking_for_position_dependent_code_is_told_why_it_is_not_coming() {
3342        for flag in ["-fno-pic", "-fno-pie"] {
3343            let e = parse_args(&args(&[flag, "a.c"])).unwrap_err();
3344            assert!(e.message.contains("global offset table"), "{flag}: {}", e.message);
3345            // The one it may have meant, since the two are a letter apart and one of them is
3346            // about linking and is taken.
3347            assert!(e.message.contains("-no-pie"), "{flag}: {}", e.message);
3348        }
3349    }
3350
3351    #[test]
3352    fn an_unsupported_target_names_itself() {
3353        let e = parse_args(&args(&["--target=sparc64-linux-gnu", "a.c"])).unwrap_err();
3354        assert!(e.message.contains("sparc64"), "{}", e.message);
3355    }
3356
3357    #[test]
3358    fn no_inputs_is_an_error_but_print_config_needs_none() {
3359        assert!(parse_args(&args(&[])).is_err());
3360        assert!(matches!(parse_args(&args(&["--print-config"])), Ok(Action::PrintConfig(_))));
3361    }
3362
3363    #[test]
3364    fn print_config_reports_the_target_it_was_given_not_the_host() {
3365        let a = parse_args(&args(&["--print-config", "--target=riscv64-linux-musl"])).unwrap();
3366        let Action::PrintConfig(opts) = a else { panic!("expected a configuration dump") };
3367        let text = print_config(&opts);
3368        assert!(text.contains("target: riscv64-unknown-linux-musl"), "{text}");
3369        assert!(text.contains("char-signed: false"), "{text}");
3370        assert!(text.contains("object-format: elf"), "{text}");
3371        assert!(text.contains("va-list: void-pointer"), "{text}");
3372        // RISC-V has a register file and this compiler has not written it down yet, and the
3373        // dump says which of those two it is rather than leaving the line out.
3374        assert!(text.contains("registers: none"), "{text}");
3375    }
3376
3377    #[test]
3378    fn print_config_has_one_key_per_line_and_a_fixed_order() {
3379        let opts = Options::new("x86_64-unknown-linux-gnu".parse().unwrap());
3380        let text = print_config(&opts);
3381        let keys: Vec<&str> =
3382            text.lines().map(|l| l.split(':').next().unwrap_or_default()).collect();
3383        assert_eq!(keys[0], "version");
3384        assert_eq!(keys[1], "target");
3385        assert_eq!(keys.len(), 25);
3386        assert!(text.ends_with('\n'));
3387    }
3388
3389    #[test]
3390    fn the_safety_tier_is_read_off_the_command_line_and_a_wrong_one_is_refused() {
3391        let (opts, _) = compile(&["a.c"]);
3392        assert_eq!(opts.safety, rucc_session::Safety::Off);
3393
3394        for (flag, tier) in [
3395            ("-fsafety=detect", rucc_session::Safety::Detect),
3396            ("-fsafety=enforce", rucc_session::Safety::Enforce),
3397            ("-fsafety=kernel", rucc_session::Safety::Kernel),
3398            ("-fsafety=off", rucc_session::Safety::Off),
3399        ] {
3400            let (opts, _) = compile(&[flag, "a.c"]);
3401            assert_eq!(opts.safety, tier, "{flag}");
3402        }
3403
3404        // The last one wins, the way every other repeated flag on this command line does.
3405        let (opts, _) = compile(&["-fsafety=enforce", "-fsafety=off", "a.c"]);
3406        assert_eq!(opts.safety, rucc_session::Safety::Off);
3407
3408        // A misspelled tier is refused rather than ignored. Silently compiling without the
3409        // monitor a build asked for is the one failure mode this feature cannot have.
3410        let e = parse_args(&args(&["-fsafety=on", "a.c"])).unwrap_err();
3411        assert!(e.message.contains("is not a safety tier"), "{}", e.message);
3412        assert!(parse_args(&args(&["-fsafety", "a.c"])).is_err());
3413    }
3414
3415    #[test]
3416    fn the_padding_mode_is_read_off_the_command_line_and_a_wrong_one_is_refused() {
3417        // The default is the one section 9.3 of document 09 gives library code, which is that
3418        // padding does not participate, so a record filled a member at a time is not reported.
3419        let (opts, _) = compile(&["a.c"]);
3420        assert_eq!(opts.padding, rucc_session::Padding::Ignored);
3421
3422        let (opts, _) = compile(&["-fsafety=detect", "-fsafety-init=padding", "a.c"]);
3423        assert_eq!(opts.padding, rucc_session::Padding::Tracked);
3424
3425        let (opts, _) = compile(&["-fsafety-init=padding", "-fsafety-init=nopadding", "a.c"]);
3426        assert_eq!(opts.padding, rucc_session::Padding::Ignored);
3427
3428        // The tier is still a tier. A flag whose name starts the same way must not be eaten by
3429        // the one above it, which is the thing worth pinning about a pair of names like these.
3430        let (opts, _) = compile(&["-fsafety-init=padding", "a.c"]);
3431        assert_eq!(opts.safety, rucc_session::Safety::Off);
3432
3433        let e = parse_args(&args(&["-fsafety-init=some", "a.c"])).unwrap_err();
3434        assert!(e.message.contains("is not a padding mode"), "{}", e.message);
3435    }
3436
3437    #[test]
3438    fn whether_a_write_has_to_stay_inside_its_member_is_read_off_the_command_line() {
3439        // Off by default, because a store to allocated storage sets its effective type and C 6.5
3440        // lets a program reuse a buffer as something else. Row S4 is a build opting out of that.
3441        let (opts, _) = compile(&["a.c"]);
3442        assert_eq!(opts.subobject, rucc_session::Subobject::Off);
3443
3444        let (opts, _) = compile(&["-fsafety=detect", "-fsafety-subobject", "a.c"]);
3445        assert_eq!(opts.subobject, rucc_session::Subobject::Members);
3446
3447        let (opts, _) = compile(&["-fsafety-subobject", "-fno-safety-subobject", "a.c"]);
3448        assert_eq!(opts.subobject, rucc_session::Subobject::Off);
3449
3450        // It takes no value. The form that would take one is the strict reading of section 9.4,
3451        // which is not written yet, so say so rather than accept a spelling that does nothing.
3452        let e = parse_args(&args(&["-fsafety-subobject=strict", "a.c"])).unwrap_err();
3453        assert!(e.message.contains("tamnd/rucc#967"), "{}", e.message);
3454    }
3455
3456    #[test]
3457    fn whether_two_restrict_pointers_may_meet_is_read_off_the_command_line() {
3458        // Off by default, because the record a block keeps is the union of what each pointer
3459        // reached, so two pointers striding through one array without landing on the same byte are
3460        // reported and by the letter of the standard those are different objects. Row Y8 is a build
3461        // deciding it would rather know.
3462        let (opts, _) = compile(&["a.c"]);
3463        assert_eq!(opts.promise, rucc_session::Promise::Off);
3464
3465        let (opts, _) = compile(&["-fsafety=detect", "-fsafety-restrict", "a.c"]);
3466        assert_eq!(opts.promise, rucc_session::Promise::Blocks);
3467
3468        let (opts, _) = compile(&["-fsafety-restrict", "-fno-safety-restrict", "a.c"]);
3469        assert_eq!(opts.promise, rucc_session::Promise::Off);
3470
3471        // The tier is still a tier, which is the thing worth pinning about a pair of names where
3472        // one is the front of the other.
3473        let (opts, _) = compile(&["-fsafety-restrict", "a.c"]);
3474        assert_eq!(opts.safety, rucc_session::Safety::Off);
3475
3476        let e = parse_args(&args(&["-fsafety-restrict=blocks", "a.c"])).unwrap_err();
3477        assert!(e.message.contains("takes no value"), "{}", e.message);
3478    }
3479
3480    #[test]
3481    fn safety_races_takes_a_mode_and_defaults_to_watching_nothing() {
3482        // Three modes rather than a bare flag, because section 9.5 gives two answers that record
3483        // the same thing and report different classes, so a flag with no value could not say which
3484        // was wanted. Off by default for the reason on `rucc_session::Races`, which is not a cost
3485        // argument: this is the one plane where an edge nobody interposed costs a false report.
3486        let (opts, _) = compile(&["a.c"]);
3487        assert_eq!(opts.races, rucc_session::Races::Off);
3488
3489        let (opts, _) = compile(&["-fsafety-races=metadata", "a.c"]);
3490        assert_eq!(opts.races, rucc_session::Races::Metadata);
3491
3492        let (opts, _) = compile(&["-fsafety-races=pointer", "a.c"]);
3493        assert_eq!(opts.races, rucc_session::Races::Pointer);
3494
3495        // Last one wins, as it does for every other mode flag here.
3496        let (opts, _) = compile(&["-fsafety-races=pointer", "-fno-safety-races", "a.c"]);
3497        assert_eq!(opts.races, rucc_session::Races::Off);
3498
3499        let e = parse_args(&args(&["-fsafety-races=all", "a.c"])).unwrap_err();
3500        assert!(e.message.contains("off, metadata or pointer"), "{}", e.message);
3501    }
3502
3503    #[test]
3504    fn print_pipeline_answers_with_the_passes_the_level_asked_for() {
3505        let a = parse_args(&args(&["--print-pipeline", "-O2"])).unwrap();
3506        let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
3507        let text = print_pipeline(&opts);
3508        assert!(text.starts_with("level: -O2\n"), "{text}");
3509        assert!(text.contains("fold"), "{text}");
3510
3511        let a = parse_args(&args(&["--print-pipeline"])).unwrap();
3512        let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
3513        // Two passes run at `-O0` and neither is an optimization. The first moves what
3514        // `__builtin_expect` said onto the branch and takes the instruction away, so that nothing
3515        // past the optimizer has to know the instruction exists. The second removes code nothing
3516        // reaches. See issue 359.
3517        assert!(print_pipeline(&opts).contains("1: expect,"), "{}", print_pipeline(&opts));
3518        assert!(print_pipeline(&opts).contains("2: simplify-cfg,"), "{}", print_pipeline(&opts));
3519
3520        let a = parse_args(&args(&["--print-pipeline", "-fno-simplify-cfg"])).unwrap();
3521        let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
3522        // The second turns off and the first does not, because nothing below the optimizer lowers
3523        // what it removes, so `-fno-expect` is a compile that stops rather than one that runs.
3524        let text = print_pipeline(&opts);
3525        assert!(text.contains("1: expect,"), "{text}");
3526        assert!(!text.contains("simplify-cfg"), "{text}");
3527    }
3528
3529    #[test]
3530    fn print_pipeline_takes_the_toggles_into_account() {
3531        let a = parse_args(&args(&["--print-pipeline", "-O2", "-fno-fold"])).unwrap();
3532        let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
3533        let text = print_pipeline(&opts);
3534        // The one that was named is gone and the rest of the level is not, which is the whole
3535        // of what a toggle promises.
3536        assert!(!text.contains("fold"), "{text}");
3537        assert!(text.contains("dce"), "{text}");
3538
3539        // Every pass the compiler has, named off. Built from the registry rather than written
3540        // out, so a pass added later is turned off here too and this keeps testing the thing it
3541        // is about, which is that the toggles can empty a level down to the passes that are not
3542        // optional. Those are named, because a listing that is all of them is a level nobody
3543        // emptied and the assertion would pass while saying nothing.
3544        let mut off = vec!["--print-pipeline".to_owned(), "-O2".to_owned()];
3545        off.extend(rucc_opt::PASSES.iter().map(|p| format!("-fno-{}", p.name())));
3546        let spelled: Vec<&str> = off.iter().map(String::as_str).collect();
3547        let a = parse_args(&args(&spelled)).unwrap();
3548        let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
3549        let text = print_pipeline(&opts);
3550        let left: Vec<&str> =
3551            rucc_opt::PASSES.iter().filter(|p| p.required()).map(|p| p.name()).collect();
3552        assert_eq!(left, vec!["expect"], "{text}");
3553        for (at, name) in left.iter().enumerate() {
3554            assert!(text.contains(&format!("{}: {name},", at + 1)), "{text}");
3555        }
3556        assert!(!text.contains("dce"), "{text}");
3557    }
3558
3559    #[test]
3560    fn print_pipeline_says_when_a_budget_will_stop_the_run_short() {
3561        let a = parse_args(&args(&["--print-pipeline", "-O2"])).unwrap();
3562        let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
3563        assert!(!print_pipeline(&opts).contains("global fuel"));
3564
3565        let a = parse_args(&args(&["--print-pipeline", "-O2", "-fpass-fuel-global=4"])).unwrap();
3566        let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
3567        let text = print_pipeline(&opts);
3568        // Because the listing is the answer to what this compilation will do, and a run that
3569        // stops after four rewrites is not doing what the level says it does.
3570        assert!(text.contains("global fuel: 4"), "{text}");
3571    }
3572
3573    /// A pass is turned on and off by its own name, and the order the flags were given in is
3574    /// kept, because the last spelling of a name is the one that decides.
3575    #[test]
3576    fn a_pass_is_named_by_dash_f_and_unnamed_by_dash_f_no() {
3577        let (opts, _) = compile(&["-c", "-O0", "-ffold", "-fno-fold", "-ffold", "a.c"]);
3578        assert_eq!(
3579            opts.passes,
3580            [("fold".to_owned(), true), ("fold".to_owned(), false), ("fold".to_owned(), true)]
3581        );
3582
3583        let e = parse_args(&args(&["-fno-such-pass", "a.c"])).unwrap_err();
3584        assert!(e.message.contains("unknown option"), "{}", e.message);
3585    }
3586
3587    #[test]
3588    fn pass_fuel_names_a_pass_and_a_count_and_refuses_anything_else() {
3589        let (opts, _) = compile(&["-c", "-O2", "-fpass-fuel=fold=3", "a.c"]);
3590        assert_eq!(opts.pass_fuel, [("fold".to_owned(), 3)]);
3591
3592        let e = parse_args(&args(&["-fpass-fuel=fold", "a.c"])).unwrap_err();
3593        assert!(e.message.contains("<pass>=<count>"), "{}", e.message);
3594        let e = parse_args(&args(&["-fpass-fuel=nosuch=3", "a.c"])).unwrap_err();
3595        assert!(e.message.contains("--print-pipeline"), "{}", e.message);
3596        let e = parse_args(&args(&["-fpass-fuel=fold=lots", "a.c"])).unwrap_err();
3597        assert!(e.message.contains("not a number"), "{}", e.message);
3598    }
3599
3600    #[test]
3601    fn global_pass_fuel_is_a_count_on_its_own_and_defaults_to_no_limit() {
3602        let (opts, _) = compile(&["-c", "-O2", "a.c"]);
3603        assert_eq!(opts.pass_fuel_global, None);
3604
3605        let (opts, _) = compile(&["-c", "-O2", "-fpass-fuel-global=12", "a.c"]);
3606        assert_eq!(opts.pass_fuel_global, Some(12));
3607        // And it is not the per pass flag with a longer name, so neither spelling swallows the
3608        // other.
3609        assert!(opts.pass_fuel.is_empty());
3610
3611        let e = parse_args(&args(&["-fpass-fuel-global=lots", "a.c"])).unwrap_err();
3612        assert!(e.message.contains("not a number"), "{}", e.message);
3613    }
3614
3615    #[test]
3616    fn a_gate_names_a_pass_and_optionally_the_functions_it_covers() {
3617        let (opts, _) = compile(&["-c", "-O2", "-fdisable-fold", "-fenable-fold=2-4,main", "a.c"]);
3618        assert_eq!(
3619            opts.pass_gates,
3620            [(false, "fold".to_owned()), (true, "fold=2-4,main".to_owned())],
3621            "the order is what decides, so it has to survive the parse"
3622        );
3623
3624        let e = parse_args(&args(&["-fdisable-nosuch", "a.c"])).unwrap_err();
3625        assert!(e.message.contains("--print-pipeline"), "{}", e.message);
3626        let e = parse_args(&args(&["-fenable-fold=9-2", "a.c"])).unwrap_err();
3627        assert!(e.message.contains("ends before it starts"), "{}", e.message);
3628        let e = parse_args(&args(&["-fdisable-fold=", "a.c"])).unwrap_err();
3629        assert!(e.message.contains("is empty"), "{}", e.message);
3630    }
3631
3632    #[test]
3633    fn the_pipeline_listing_says_which_passes_a_gate_touched() {
3634        let (opts, _) = compile(&["-c", "-O2", "-fdisable-fold=main", "a.c"]);
3635        let text = print_pipeline(&opts);
3636        assert!(text.contains("fold, "), "{text}");
3637        assert!(text.contains("[off for main]"), "{text}");
3638    }
3639
3640    /// The spelling is checked while the arguments are read, because a dump that names a pass
3641    /// this compiler does not have is a typo, and a typo found after the compilation has run is
3642    /// found too late to be any use.
3643    #[test]
3644    fn a_dump_is_checked_when_it_is_asked_for_rather_than_when_it_is_taken() {
3645        let (opts, _) = compile(&["-c", "-O2", "-fdump-ir=all", "-fdump-ir=after-fold", "a.c"]);
3646        assert_eq!(opts.dump_ir, ["all", "after-fold"]);
3647
3648        let e = parse_args(&args(&["-fdump-ir=after-nosuch", "a.c"])).unwrap_err();
3649        assert!(e.message.contains("nosuch"), "{}", e.message);
3650        assert!(parse_args(&args(&["-fdump-ir=sideways-fold", "a.c"])).is_err());
3651    }
3652
3653    /// Every spelling `-fopt-info` takes, and the one it does not.
3654    ///
3655    /// The keywords are checked here for the same reason a dump's pass name is: a person who
3656    /// misspelled one gets no output, and no output is also what a compilation where nothing
3657    /// happened looks like. Telling those two apart is the entire reason to reach for this flag.
3658    #[test]
3659    fn opt_info_takes_kinds_and_a_file_and_refuses_a_kind_it_does_not_have() {
3660        let (opts, _) = compile(&["-c", "-O2", "-fopt-info", "a.c"]);
3661        assert_eq!(opts.opt_info, [""], "a bare flag asks for the rewrites");
3662        assert_eq!(opts.opt_info_file, None, "and goes to standard error");
3663
3664        let (opts, _) = compile(&["-c", "-O2", "-fopt-info-missed-note", "a.c"]);
3665        assert_eq!(opts.opt_info, ["missed-note"]);
3666
3667        // Two flags add up rather than the second replacing the first, and the file is the last
3668        // one that named a file, which is how GCC treats both.
3669        let (opts, _) =
3670            compile(&["-c", "-O2", "-fopt-info-missed=one.txt", "-fopt-info-all=two.txt", "a.c"]);
3671        assert_eq!(opts.opt_info, ["missed", "all"]);
3672        assert_eq!(opts.opt_info_file.as_deref(), Some("two.txt"));
3673
3674        let e = parse_args(&args(&["-fopt-info-vectorized", "a.c"])).unwrap_err();
3675        assert!(e.message.contains("vectorized"), "{}", e.message);
3676        assert!(e.message.contains("`missed`"), "{}", e.message);
3677        let e = parse_args(&args(&["-fopt-info-missed=", "a.c"])).unwrap_err();
3678        assert!(e.message.contains("no file"), "{}", e.message);
3679    }
3680
3681    #[test]
3682    fn verify_each_is_unstable_and_off_unless_it_was_asked_for() {
3683        let (opts, _) = compile(&["-c", "-Zverify-each", "a.c"]);
3684        assert!(opts.verify_each);
3685        assert!(!USAGE.contains("verify-each"), "an unstable option stays out of the usage text");
3686    }
3687
3688    #[test]
3689    fn dash_o_needs_an_argument() {
3690        let e = parse_args(&args(&["a.c", "-o"])).unwrap_err();
3691        assert_eq!(e.message, "-o requires an argument");
3692    }
3693
3694    #[test]
3695    fn dash_d_and_dash_u_are_read_joined_or_separated_and_keep_their_order() {
3696        let (opts, _) = compile(&["-DFOO=1", "-D", "BAR", "-UBAZ", "-U", "QUX", "a.c"]);
3697        assert_eq!(opts.defines, ["FOO=1", "BAR"]);
3698        assert_eq!(opts.undefines, ["BAZ", "QUX"]);
3699    }
3700
3701    #[test]
3702    fn the_include_flags_land_on_the_chain_each_one_names() {
3703        // A sysroot with nothing under it, so that the library's own directories are the
3704        // same on every machine this test runs on, which is none of them.
3705        let (opts, _) = compile(&[
3706            "-Ii",
3707            "-iquote",
3708            "q",
3709            "-isystem",
3710            "sys",
3711            "-idirafter",
3712            "after",
3713            "--sysroot=/nowhere-at-all",
3714            "a.c",
3715        ]);
3716        let dirs: Vec<&str> = opts.search.dirs().iter().filter_map(|d| d.path.to_str()).collect();
3717        // The compiler's own headers sit after every `-isystem` and before `-idirafter`,
3718        // which is where GCC puts its own: a directory the user named outranks ours.
3719        assert_eq!(dirs, ["q", "i", "sys", runtime::DIR, "after"]);
3720        assert!(!opts.search.dirs()[1].is_system);
3721        assert!(opts.search.dirs()[2].is_system);
3722    }
3723
3724    #[test]
3725    fn the_librarys_headers_come_after_the_compilers_own_and_go_away_with_them() {
3726        // Which machine this runs on decides what is on the path, so the test is about the
3727        // order rather than about the names: ours is on it, the library's follow it, and
3728        // `-nostdinc` is the one flag that takes both halves of the pair off at once.
3729        let (opts, _) = compile(&["a.c"]);
3730        let dirs = opts.search.dirs();
3731        let ours = dirs.iter().position(|d| d.path.to_str() == Some(runtime::DIR));
3732        assert_eq!(ours, Some(0), "{dirs:?}");
3733        assert!(dirs[1..].iter().all(|d| d.is_system), "{dirs:?}");
3734        let (bare, _) = compile(&["-nostdinc", "a.c"]);
3735        assert!(bare.search.dirs().is_empty(), "{:?}", bare.search.dirs());
3736    }
3737
3738    #[test]
3739    fn a_sysroot_moves_the_librarys_directories_and_nothing_else() {
3740        let (opts, _) = compile(&["-isystem", "sys", "--sysroot=/nowhere-at-all", "a.c"]);
3741        let dirs: Vec<&str> = opts.search.dirs().iter().filter_map(|d| d.path.to_str()).collect();
3742        assert_eq!(dirs, ["sys", runtime::DIR]);
3743    }
3744
3745    #[test]
3746    fn a_cross_compile_reads_the_targets_own_headers_rather_than_the_ones_next_door() {
3747        // The target is not the machine this test runs on wherever it runs, so the answer is the
3748        // same on all of them: the libc's two include directories for that target, the kernel's
3749        // two, and nothing from here. A header read from here is the quiet failure of section 8.5, a
3750        // program that builds on the build machine and is wrong everywhere else.
3751        let (opts, _) = compile(&["--target=riscv64-linux-musl", "-c", "a.c"]);
3752        let dirs: Vec<&std::path::Path> =
3753            opts.search.dirs().iter().map(|d| d.path.as_path()).collect();
3754        let root = cache::dir().join("sysroots").join("riscv64-linux-musl");
3755        let kernel = cache::dir().join("kernel-headers");
3756        assert_eq!(dirs.len(), 5, "{dirs:?}");
3757        assert_eq!(dirs[0], std::path::Path::new(runtime::DIR));
3758        assert_eq!(dirs[1], root.join("include").join("riscv64"));
3759        assert_eq!(dirs[2], root.join("include").join("generic"));
3760        // The kernel's, which are beside the sysroots rather than inside one, because every target
3761        // that shares an architecture reads the same files.
3762        assert_eq!(dirs[3], kernel.join("riscv"));
3763        assert_eq!(dirs[4], kernel.join("generic"));
3764    }
3765
3766    #[test]
3767    fn a_cross_compile_to_something_that_is_not_linux_reads_no_kernel_headers() {
3768        // The other side of the same answer. Windows has its own system headers and no `linux/` at
3769        // all, so the list is the libc's two and the question never arises, which is the `None` that
3770        // `link::cross_kernel` returns rather than a directory nothing would be found in.
3771        let (opts, _) = compile(&["--target=x86_64-pc-windows-gnu", "-c", "a.c"]);
3772        let dirs: Vec<&std::path::Path> =
3773            opts.search.dirs().iter().map(|d| d.path.as_path()).collect();
3774        assert_eq!(dirs.len(), 3, "{dirs:?}");
3775        assert!(!dirs.iter().any(|dir| dir.ends_with("kernel-headers")), "{dirs:?}");
3776    }
3777
3778    #[test]
3779    fn the_glibc_version_macro_goes_with_the_bundled_tree_and_with_nothing_else() {
3780        // One tree serves every glibc release, so the release is what the target supplies, and the
3781        // condition is the same one that chose the directories. A host glibc and a tree somebody
3782        // named both define `__GLIBC_MINOR__` in their own `features.h`, and two definitions with
3783        // different values is a warning on every compilation of every file.
3784        //
3785        // The architecture is chosen against this machine's rather than written down, because the
3786        // bundled tree is only in effect for a target that is not this machine. The first version of
3787        // this test said x86_64-linux-gnu, which is a cross compile on a mac and this machine on a
3788        // Linux runner, so it passed here and failed there.
3789        let gnu = format!("--target={}-linux-gnu", cross_arch());
3790        let (bundled, _) = compile(&[&gnu, "-c", "a.c"]);
3791        assert_eq!(bundled.glibc_minor, Some(44));
3792        let pin = format!("{gnu}.2.28");
3793        let (pinned, _) = compile(&[&pin, "-c", "a.c"]);
3794        assert_eq!(pinned.glibc_minor, Some(28));
3795
3796        let (named, _) = compile(&[&gnu, "--sysroot=/nowhere-at-all", "-c", "a.c"]);
3797        assert_eq!(named.glibc_minor, None);
3798        let (none, _) = compile(&[&gnu, "-nostdinc", "-c", "a.c"]);
3799        assert_eq!(none.glibc_minor, None);
3800        let musl = format!("--target={}-linux-musl", cross_arch());
3801        let (musl, _) = compile(&[&musl, "-c", "a.c"]);
3802        assert_eq!(musl.glibc_minor, None);
3803
3804        // And this machine's own target gets nothing, whatever this machine is, because its headers
3805        // come from the machine and its own `features.h` defines the macro. On a glibc Linux box
3806        // that is the case this test had backwards; on a mac it is true for the other reason, which
3807        // is that Darwin is not a glibc target at all.
3808        if let Some(host) = Triple::host() {
3809            let native = format!("--target={}", host.tuple());
3810            let (native, _) = compile(&[&native, "-c", "a.c"]);
3811            assert_eq!(native.glibc_minor, None);
3812        }
3813    }
3814
3815    #[test]
3816    fn a_pinned_release_on_this_machines_own_target_reads_the_bundled_tree() {
3817        // The end to end half of the answer in `link::cross_for`. A release named for this machine's
3818        // own target is a cross compile, so the headers are the bundled tree's and the macro says
3819        // what was asked for rather than what this machine has.
3820        //
3821        // Only on a glibc box, because a release is a glibc release: a mac has no `__GLIBC_MINOR__`
3822        // to get wrong and nothing to pin. That makes this a test the Linux runners carry, which is
3823        // where the case lives.
3824        let Some(host) = Triple::host() else { return };
3825        if host.env != rucc_target::Env::Gnu {
3826            return;
3827        }
3828        let pin = format!("--target={}.2.28", host.tuple());
3829        let (opts, _) = compile(&[&pin, "-c", "a.c"]);
3830        assert_eq!(opts.glibc_minor, Some(28));
3831        let root = cache::dir().join("sysroots").join(format!("{}.2.28", host.tuple()));
3832        let dirs: Vec<&std::path::Path> =
3833            opts.search.dirs().iter().map(|d| d.path.as_path()).collect();
3834        assert!(dirs.iter().any(|dir| dir.starts_with(&root)), "{dirs:?}");
3835        // And nothing of this machine's, which is the failure this was: a program compiled against
3836        // 2.44 declarations and told it was 2.28.
3837        assert!(!dirs.iter().any(|dir| *dir == std::path::Path::new("/usr/include")), "{dirs:?}");
3838    }
3839
3840    /// An architecture that is not this machine's, out of the three the driver has targets for.
3841    ///
3842    /// A test about the bundled sysroot has to name a target that is not the host, because a target
3843    /// that is the host reads the host's own headers and libraries. Asking which machine this is
3844    /// beats picking a row and hoping, and it is two lines.
3845    fn cross_arch() -> &'static str {
3846        match Triple::host().map(|host| host.arch) {
3847            Some(rucc_target::Arch::X86_64) => "aarch64",
3848            _ => "x86_64",
3849        }
3850    }
3851
3852    #[test]
3853    fn a_glibc_newer_than_the_bundled_tree_is_refused_by_name() {
3854        // Both versions in the message, because the two things a person can do about it are pin a
3855        // release the tree has and name a sysroot that has the one they asked for, and neither is a
3856        // choice they can make without knowing which release the tree is.
3857        //
3858        // Not this machine's architecture, for the reason the test above gives: the refusal is about
3859        // the bundled tree, and the bundled tree is not what a target that is this machine reads.
3860        let target = format!("--target={}-linux-gnu.2.99", cross_arch());
3861        let message = refused(&[&target, "-c", "a.c"]);
3862        assert!(message.contains("asked for glibc 2.99"), "{message}");
3863        assert!(message.contains("bundled headers are glibc 2.44"), "{message}");
3864        assert!(message.contains("--sysroot"), "{message}");
3865    }
3866
3867    #[test]
3868    fn a_sysroot_the_user_named_is_still_what_a_cross_compile_reads() {
3869        // The tree somebody assembled beats the one we would build, on the headers as on the
3870        // libraries. It is empty here, which is why the list comes out short: the directories under
3871        // it are checked for rather than assumed, and a tree that is not there offers nothing.
3872        let (opts, _) =
3873            compile(&["--target=riscv64-linux-musl", "--sysroot=/nowhere-at-all", "-c", "a.c"]);
3874        let dirs: Vec<&std::path::Path> =
3875            opts.search.dirs().iter().map(|d| d.path.as_path()).collect();
3876        assert_eq!(dirs, [std::path::Path::new(runtime::DIR)]);
3877    }
3878
3879    #[test]
3880    fn dash_i_dash_moves_the_bracket_directories_into_the_quoted_chain() {
3881        let (opts, _) =
3882            compile(&["-Iinc1", "-iquote", "inc2", "-I-", "-Iinc3", "-nostdinc", "a.c"]);
3883        let dirs: Vec<&str> = opts.search.dirs().iter().filter_map(|d| d.path.to_str()).collect();
3884        assert_eq!(dirs, ["inc1", "inc2", "inc3"]);
3885        // An angled include sees only what came after the flag.
3886        assert_eq!(opts.search.start(IncludeForm::Angled), 2);
3887        assert!(!opts.search.searches_current_dir());
3888    }
3889
3890    #[test]
3891    fn the_prefix_flags_stick_what_iprefix_said_on_the_front_of_what_follows_it() {
3892        let (opts, _) = compile(&[
3893            "-iprefix",
3894            "/tools/",
3895            "-iwithprefix",
3896            "late",
3897            "-iwithprefixbefore",
3898            "early",
3899            "-iprefix",
3900            "/other/",
3901            "-iwithprefix",
3902            "last",
3903            "-nostdinc",
3904            "a.c",
3905        ]);
3906        let dirs: Vec<&str> = opts.search.dirs().iter().filter_map(|d| d.path.to_str()).collect();
3907        // `-iwithprefixbefore` is an `-I` and the other two are `-isystem`, which is where GCC
3908        // puts them rather than where its manual says it does.
3909        assert_eq!(dirs, ["/tools/early", "/tools/late", "/other/last"]);
3910        assert!(!opts.search.dirs()[0].is_system);
3911        assert!(opts.search.dirs()[1].is_system);
3912    }
3913
3914    #[test]
3915    fn the_files_named_on_the_command_line_keep_their_order_and_which_flag_named_them() {
3916        let (opts, _) =
3917            compile(&["-include", "one.h", "-imacros", "two.h", "-include", "3.h", "a.c"]);
3918        let names: Vec<&str> = opts.preincludes.iter().map(|p| p.name.as_str()).collect();
3919        assert_eq!(names, ["one.h", "two.h", "3.h"]);
3920        assert_eq!(opts.preincludes.iter().filter(|p| p.macros_only).count(), 1);
3921    }
3922
3923    #[test]
3924    fn nostdinc_takes_the_compilers_own_headers_off_the_path() {
3925        let (opts, _) = compile(&["-Ii", "-nostdinc", "a.c"]);
3926        let dirs: Vec<&str> = opts.search.dirs().iter().filter_map(|d| d.path.to_str()).collect();
3927        assert_eq!(dirs, ["i"]);
3928    }
3929
3930    #[test]
3931    fn the_dialect_flags_set_the_language_and_the_extensions_separately() {
3932        let (opts, _) = compile(&["-std=gnu11", "a.c"]);
3933        assert_eq!(opts.std, Std::C11);
3934        assert!(opts.gnu_extensions);
3935
3936        let (opts, _) = compile(&["-std=iso9899:1999", "a.c"]);
3937        assert_eq!(opts.std, Std::C99);
3938        assert!(!opts.gnu_extensions);
3939
3940        let (opts, _) = compile(&["-ansi", "a.c"]);
3941        assert_eq!(opts.std, Std::C89);
3942        assert!(!opts.gnu_extensions);
3943
3944        let e = parse_args(&args(&["-std=c94jr", "a.c"])).unwrap_err();
3945        assert!(e.message.contains("unknown dialect"), "{}", e.message);
3946    }
3947
3948    #[test]
3949    fn the_dump_letters_are_a_family_and_everything_else_beginning_with_d_is_not() {
3950        let (opts, _) = compile(&["-dM", "a.c"]);
3951        assert!(opts.dumps.macros);
3952
3953        // Packed, the way GCC takes them, and a letter in the family we have not written yet
3954        // is accepted and does nothing rather than failing a build.
3955        let (opts, _) = compile(&["-dDM", "a.c"]);
3956        assert!(opts.dumps.macros);
3957        let (opts, _) = compile(&["-dD", "a.c"]);
3958        assert!(!opts.dumps.macros);
3959
3960        let (opts, _) = compile(&["a.c"]);
3961        assert!(!opts.dumps.any());
3962
3963        // `-dumpversion` is a different flag that happens to start the same way, and it is read
3964        // as itself rather than as a dump of nothing.
3965        assert_eq!(printed(&["-dumpversion", "a.c"]), VERSION);
3966    }
3967
3968    #[test]
3969    fn the_gcc_version_claimed_is_a_flag_and_the_short_spellings_are_the_ones_people_write() {
3970        let (opts, _) = compile(&["a.c"]);
3971        assert_eq!(
3972            opts.gnuc,
3973            GnucVersion { major: 7, minor: 0, patch: 0 },
3974            "the lowest claim a modern glibc gives its own declarations to"
3975        );
3976
3977        let (opts, _) = compile(&["-fgnuc-version=15.1.0", "a.c"]);
3978        assert_eq!(opts.gnuc, GnucVersion { major: 15, minor: 1, patch: 0 });
3979
3980        // A missing component is zero. `gcc -dumpversion` says `15` on a release with no
3981        // patchlevel and a harness that pastes that back has to be understood.
3982        let (opts, _) = compile(&["-fgnuc-version=15", "a.c"]);
3983        assert_eq!(opts.gnuc, GnucVersion { major: 15, minor: 0, patch: 0 });
3984
3985        let (opts, _) = compile(&["-fgnuc-version=13.2", "a.c"]);
3986        assert_eq!(opts.gnuc, GnucVersion { major: 13, minor: 2, patch: 0 });
3987
3988        let e = parse_args(&args(&["-fgnuc-version=15.x", "a.c"])).unwrap_err();
3989        assert!(e.message.contains("minor that is not a number"), "{}", e.message);
3990
3991        let e = parse_args(&args(&["-fgnuc-version=1.2.3.4", "a.c"])).unwrap_err();
3992        assert!(e.message.contains("more than three"), "{}", e.message);
3993    }
3994
3995    #[test]
3996    fn pedantic_has_two_spellings_and_is_not_the_same_knob_as_the_dialect() {
3997        let (opts, _) = compile(&["-std=c17", "-pedantic", "a.c"]);
3998        assert!(opts.pedantic);
3999        assert_eq!(opts.std, Std::C17);
4000
4001        // The `-W` family's name for it, which is what a build that groups its warning flags
4002        // tends to write.
4003        let (opts, _) = compile(&["-Wpedantic", "a.c"]);
4004        assert!(opts.pedantic);
4005
4006        let (opts, _) = compile(&["-std=c17", "a.c"]);
4007        assert!(!opts.pedantic, "a dialect on its own does not diagnose an extension");
4008    }
4009
4010    #[test]
4011    fn dash_p_and_dash_ffreestanding_reach_the_options() {
4012        let (opts, _) = compile(&["-E", "-P", "-ffreestanding", "a.c"]);
4013        assert!(!opts.line_markers);
4014        assert!(!opts.hosted);
4015        assert_eq!(opts.emit, EmitKind::Preprocessed);
4016    }
4017
4018    /// The two ways a build says it means its own function by a name the C library also has.
4019    ///
4020    /// `-fno-builtin` is all of them and `-fno-builtin-<name>` is one, and the second is what a
4021    /// build writes when it means its own `memcpy` and the library's everything else. The name is
4022    /// kept as it was written and not checked against anything, because a program is allowed to
4023    /// mean something by a name this compiler has never heard of.
4024    #[test]
4025    fn the_builtin_flags_are_read_in_both_directions_and_one_name_at_a_time() {
4026        let (opts, _) = compile(&["-c", "a.c"]);
4027        assert!(opts.builtins, "a library name means the library function by default");
4028        assert!(opts.no_builtin.is_empty());
4029
4030        let (opts, _) = compile(&["-c", "-fno-builtin", "a.c"]);
4031        assert!(!opts.builtins);
4032
4033        let (opts, _) = compile(&["-c", "-fno-builtin", "-fbuiltin", "a.c"]);
4034        assert!(opts.builtins, "the last mention decides");
4035
4036        let (opts, _) = compile(&["-c", "-fno-builtin-memcpy", "-fno-builtin-nonesuch", "a.c"]);
4037        assert!(opts.builtins, "one name is not the family");
4038        assert_eq!(opts.no_builtin, vec!["memcpy".to_owned(), "nonesuch".to_owned()]);
4039    }
4040
4041    /// `-fvisibility=`, which is on every cmake project that cares about which names it exports
4042    /// and which was refused as an unknown option until now.
4043    ///
4044    /// Four spellings and three answers. `internal` is hidden plus a promise about never taking
4045    /// the address across a component boundary, and nothing derives anything from that promise
4046    /// here, so it comes out as the weaker of the two rather than as a refusal that stops a build
4047    /// over a distinction this compiler does not make.
4048    #[test]
4049    fn visibility_takes_the_four_spellings_gcc_takes_and_refuses_the_rest() {
4050        let (opts, _) = compile(&["-c", "a.c"]);
4051        assert_eq!(opts.visibility, Visibility::Default, "exported unless something says not");
4052
4053        for (written, wanted) in [
4054            ("default", Visibility::Default),
4055            ("hidden", Visibility::Hidden),
4056            ("internal", Visibility::Hidden),
4057            ("protected", Visibility::Protected),
4058        ] {
4059            let (opts, _) = compile(&["-c", &format!("-fvisibility={written}"), "a.c"]);
4060            assert_eq!(opts.visibility, wanted, "{written}");
4061        }
4062
4063        // The last mention decides, which is what every other flag of this shape does and what a
4064        // build that turns something off for one directory relies on.
4065        let (opts, _) = compile(&["-c", "-fvisibility=hidden", "-fvisibility=default", "a.c"]);
4066        assert_eq!(opts.visibility, Visibility::Default, "the last mention decides");
4067
4068        // A spelling gcc does not take is refused rather than read as the default, because a
4069        // build that meant hidden and got exported is a library with the wrong interface and
4070        // nothing said about it anywhere.
4071        let failed = parse_args(&args(&["-fvisibility=none", "a.c"])).expect_err("refused");
4072        assert!(failed.to_string().contains("is not a visibility"), "{failed}");
4073    }
4074
4075    /// `-ffp-contract=`, which is the one flag in the floating point group that is kept rather than
4076    /// described, and the values are gcc 16's three.
4077    #[test]
4078    fn how_far_a_multiply_and_an_addition_may_be_fused_is_asked_for() {
4079        let (opts, _) = compile(&["-c", "a.c"]);
4080        assert_eq!(opts.fp_contract, Contract::Off, "a licence nobody granted is not assumed");
4081
4082        for (written, wanted) in
4083            [("off", Contract::Off), ("on", Contract::On), ("fast", Contract::Fast)]
4084        {
4085            let (opts, _) = compile(&["-c", &format!("-ffp-contract={written}"), "a.c"]);
4086            assert_eq!(opts.fp_contract, wanted, "{written}");
4087        }
4088
4089        let (opts, _) = compile(&["-c", "-ffp-contract=fast", "-ffp-contract=off", "a.c"]);
4090        assert_eq!(opts.fp_contract, Contract::Off, "the last mention decides");
4091
4092        // Refused rather than read as one of the three, because a build that asked for no fusing
4093        // and was given the default would be one whose numbers change and whose command line says
4094        // they should not. gcc refuses the same spellings and names the same three in its message.
4095        for bad in ["-ffp-contract=none", "-ffp-contract=", "-ffp-contract=Fast"] {
4096            let failed = parse_args(&args(&[bad, "a.c"])).expect_err("refused");
4097            assert!(failed.to_string().contains("is not a contraction"), "{bad}: {failed}");
4098        }
4099
4100        // And the other one that takes a value, which is taken and kept nowhere: every operation
4101        // here is computed in the type it was written in, so `standard` is what happens and the
4102        // other two are permission to do something this does not do.
4103        let failed = parse_args(&args(&["-fexcess-precision=long", "a.c"])).expect_err("refused");
4104        assert!(failed.to_string().contains("is not an excess precision"), "{failed}");
4105    }
4106
4107    /// The four prefix mapping flags, which are what a distribution passes to get the same bytes
4108    /// out of `/build/pkg-1.2` and out of `/home/someone/pkg-1.2`. Three lists rather than one
4109    /// because gcc has three, and `-ffile-prefix-map=` is the three of them at once.
4110    #[test]
4111    fn a_prefix_mapping_flag_goes_on_the_list_its_spelling_names() {
4112        let (opts, _) = compile(&["-c", "a.c"]);
4113        assert!(opts.prefix_map.macros.is_empty(), "nothing is rewritten unless it is asked for");
4114        assert!(opts.prefix_map.debug.is_empty(), "nor here");
4115        assert!(opts.prefix_map.profile.is_empty(), "nor here");
4116
4117        let (opts, _) = compile(&["-c", "-fmacro-prefix-map=/build=.", "a.c"]);
4118        assert_eq!(opts.prefix_map.macros.apply("/build/a.c"), "./a.c", "the one it names");
4119        assert!(opts.prefix_map.debug.is_empty(), "and not the two it does not");
4120
4121        let (opts, _) = compile(&["-c", "-fdebug-prefix-map=/build=.", "a.c"]);
4122        assert_eq!(opts.prefix_map.debug.apply("/build/a.c"), "./a.c", "the one it names");
4123        assert!(opts.prefix_map.macros.is_empty(), "and not the two it does not");
4124
4125        let (opts, _) = compile(&["-c", "-fprofile-prefix-map=/build=.", "a.c"]);
4126        assert_eq!(opts.prefix_map.profile.apply("/build/a.c"), "./a.c", "the one it names");
4127        assert!(opts.prefix_map.macros.is_empty(), "and not the two it does not");
4128
4129        let (opts, _) = compile(&["-c", "-ffile-prefix-map=/build=.", "a.c"]);
4130        for list in [&opts.prefix_map.macros, &opts.prefix_map.debug, &opts.prefix_map.profile] {
4131            assert_eq!(list.apply("/build/a.c"), "./a.c", "all three at once");
4132        }
4133
4134        // Every mention is kept and the last one that matches wins, unlike the flags above whose
4135        // last mention replaces the earlier ones. A build writes one of these per source root and
4136        // expects all of them to be in force, which is the whole point of a list.
4137        let (opts, _) =
4138            compile(&["-c", "-ffile-prefix-map=/a=one", "-ffile-prefix-map=/b=two", "a.c"]);
4139        assert_eq!(opts.prefix_map.macros.apply("/a/x.c"), "one/x.c", "the earlier one still acts");
4140        assert_eq!(opts.prefix_map.macros.apply("/b/x.c"), "two/x.c", "and so does the later one");
4141
4142        // An argument with no `=` is refused rather than ignored, because a build whose paths were
4143        // meant to be rewritten and were not is one that ships the build directory's name and says
4144        // nothing about it. gcc refuses the same thing.
4145        for bad in ["-fmacro-prefix-map=nope", "-ffile-prefix-map=", "-fdebug-prefix-map=/build"] {
4146            let failed = parse_args(&args(&[bad, "a.c"])).expect_err("refused");
4147            assert!(failed.to_string().contains("is not a rewrite for"), "{bad}: {failed}");
4148        }
4149    }
4150
4151    /// `-ffunction-sections` and `-fdata-sections`, which are what make `--gc-sections` able to
4152    /// drop anything: a linker can leave out a section nothing reaches and cannot leave out half of
4153    /// one. A kernel and an embedded image are both linked that way.
4154    ///
4155    /// Two flags rather than one because gcc has two, and a build that asks for one of them and not
4156    /// the other is a build that measured something: splitting the code is nearly free at link time
4157    /// and splitting the data can defeat the linker's ordering of what is next to what.
4158    #[test]
4159    fn a_section_per_function_and_a_section_per_variable_are_asked_for_one_at_a_time() {
4160        let (opts, _) = compile(&["-c", "a.c"]);
4161        assert!(!opts.function_sections, "one text section unless something says otherwise");
4162        assert!(!opts.data_sections);
4163
4164        let (opts, _) = compile(&["-c", "-ffunction-sections", "a.c"]);
4165        assert!(opts.function_sections);
4166        assert!(!opts.data_sections, "one flag is not the other");
4167
4168        let (opts, _) = compile(&["-c", "-fdata-sections", "a.c"]);
4169        assert!(opts.data_sections);
4170        assert!(!opts.function_sections);
4171
4172        // Both directions taken, and the off one is what happens anyway rather than a refusal,
4173        // since a build that writes it is asking for the default.
4174        let (opts, _) = compile(&[
4175            "-c",
4176            "-ffunction-sections",
4177            "-fno-function-sections",
4178            "-fdata-sections",
4179            "-fno-data-sections",
4180            "a.c",
4181        ]);
4182        assert!(!opts.function_sections, "the last mention decides");
4183        assert!(!opts.data_sections, "the last mention decides");
4184    }
4185
4186    /// `-fgnu89-inline`, which is off by default and is not implied by anything on the command
4187    /// line, since the dialect asks for GNU's reading further in rather than through this.
4188    #[test]
4189    fn gnu89_inline_is_off_until_it_is_asked_for_and_the_last_mention_decides() {
4190        let (opts, _) = compile(&["-c", "a.c"]);
4191        assert!(!opts.gnu89_inline, "C's reading of inline by default");
4192
4193        let (opts, _) = compile(&["-c", "-fgnu89-inline", "a.c"]);
4194        assert!(opts.gnu89_inline);
4195
4196        let (opts, _) = compile(&["-c", "-fgnu89-inline", "-fno-gnu89-inline", "a.c"]);
4197        assert!(!opts.gnu89_inline, "the last mention decides");
4198
4199        // The C89 dialects are under GNU's reading whether this was written or not, so the flag
4200        // stays off there and the dialect is what the checker and the macro set both ask. That is
4201        // also why `-std=c89 -fno-gnu89-inline` needs no diagnostic: it asks for the reading the
4202        // dialect already has. gcc refuses that command line, which is measured in the issue.
4203        let (opts, _) = compile(&["-c", "-std=c89", "a.c"]);
4204        assert!(!opts.gnu89_inline);
4205    }
4206
4207    /// Both spellings of both frame flags, since a build that wants one usually writes the
4208    /// other beside it for the one file that has to be compiled the ordinary way.
4209    #[test]
4210    fn the_two_frame_flags_are_read_in_both_directions() {
4211        let (opts, _) = compile(&["-c", "a.c"]);
4212        assert!(!opts.frame_pointer, "gcc omits it above -O0 and so does this");
4213        assert!(opts.red_zone, "the psABI has one and nothing said not to use it");
4214
4215        let (opts, _) = compile(&["-c", "-fno-omit-frame-pointer", "-mno-red-zone", "a.c"]);
4216        assert!(opts.frame_pointer);
4217        assert!(!opts.red_zone);
4218
4219        let (opts, _) = compile(&[
4220            "-c",
4221            "-fno-omit-frame-pointer",
4222            "-fomit-frame-pointer",
4223            "-mno-red-zone",
4224            "-mred-zone",
4225            "a.c",
4226        ]);
4227        assert!(!opts.frame_pointer, "the last one wins, as it does in gcc");
4228        assert!(opts.red_zone);
4229    }
4230
4231    /// Four flags rather than one with an argument, which is how gcc spells them, and the negative
4232    /// spelled three ways because a build that turns one off writes whichever it turned on.
4233    #[test]
4234    fn the_stack_protector_is_four_flags_and_the_last_one_wins() {
4235        let (opts, _) = compile(&["-c", "a.c"]);
4236        assert_eq!(opts.protector, Protector::None, "gcc protects nothing unless it was asked");
4237
4238        for (flag, want) in [
4239            ("-fstack-protector", Protector::Buffers),
4240            ("-fstack-protector-strong", Protector::Strong),
4241            ("-fstack-protector-all", Protector::All),
4242        ] {
4243            let (opts, _) = compile(&["-c", flag, "a.c"]);
4244            assert_eq!(opts.protector, want, "{flag}");
4245        }
4246
4247        // What a package build does: the strong one in the global flags and one directory that
4248        // cannot have a protector turning it off on the line after.
4249        for off in ["-fno-stack-protector", "-fno-stack-protector-strong"] {
4250            let (opts, _) = compile(&["-c", "-fstack-protector-strong", off, "a.c"]);
4251            assert_eq!(opts.protector, Protector::None, "{off}");
4252        }
4253        let (opts, _) = compile(&["-c", "-fno-stack-protector", "-fstack-protector-all", "a.c"]);
4254        assert_eq!(opts.protector, Protector::All, "the last one wins either way round");
4255    }
4256
4257    /// A switch rather than a level, because how a frame is taken is one question and which
4258    /// functions get a canary is another, and gcc spells it that way for the same reason.
4259    #[test]
4260    fn taking_a_frame_a_page_at_a_time_is_off_until_it_is_asked_for() {
4261        let (opts, _) = compile(&["-c", "a.c"]);
4262        assert!(!opts.stack_clash, "gcc takes a frame in one subtraction unless it was asked");
4263
4264        let (opts, _) = compile(&["-c", "-fstack-clash-protection", "a.c"]);
4265        assert!(opts.stack_clash);
4266
4267        // The same shape a package build uses for the protector: on in the global flags and off
4268        // for the one directory that cannot have it.
4269        let (opts, _) =
4270            compile(&["-c", "-fstack-clash-protection", "-fno-stack-clash-protection", "a.c"]);
4271        assert!(!opts.stack_clash);
4272        let (opts, _) =
4273            compile(&["-c", "-fno-stack-clash-protection", "-fstack-clash-protection", "a.c"]);
4274        assert!(opts.stack_clash, "the last one wins either way round");
4275
4276        // The two are independent, since one is about the frame and the other about the function.
4277        let (opts, _) =
4278            compile(&["-c", "-fstack-clash-protection", "-fstack-protector-strong", "a.c"]);
4279        assert!(opts.stack_clash);
4280        assert_eq!(opts.protector, Protector::Strong);
4281    }
4282
4283    /// One flag with an argument rather than a family of spellings, because what it asks about is
4284    /// which of the two edges of a control flow transfer is checked and the two are not separate
4285    /// questions to the hardware.
4286    #[test]
4287    fn which_control_flow_edges_are_checked_is_asked_for_by_name() {
4288        let (opts, _) = compile(&["-c", "a.c"]);
4289        assert_eq!(opts.control, Control::None, "gcc's default on the targets this compiler has");
4290
4291        for (arg, want) in [
4292            ("-fcf-protection", Control::Full),
4293            ("-fcf-protection=full", Control::Full),
4294            ("-fcf-protection=branch", Control::Branch),
4295            ("-fcf-protection=return", Control::Return),
4296            ("-fcf-protection=none", Control::None),
4297            ("-fcf-protection=check", Control::Check),
4298        ] {
4299            let (opts, _) = compile(&["-c", arg, "a.c"]);
4300            assert_eq!(opts.control, want, "{arg}");
4301        }
4302
4303        // The shape a package build uses: on in the global flags and off for the one directory
4304        // that cannot have it, whichever of the two spellings of off it reaches for.
4305        let (opts, _) = compile(&["-c", "-fcf-protection=full", "-fno-cf-protection", "a.c"]);
4306        assert_eq!(opts.control, Control::None);
4307        let (opts, _) = compile(&["-c", "-fno-cf-protection", "-fcf-protection=branch", "a.c"]);
4308        assert_eq!(opts.control, Control::Branch, "the last one wins either way round");
4309    }
4310
4311    /// The profiler is asked for by two spellings, and where its hook goes by two more.
4312    ///
4313    /// The two halves are separate on purpose. `-mfentry` on its own says where a call would go and
4314    /// asks for no call, which is what gcc does with it, and a build system that sets it globally
4315    /// and asks for the profile per directory needs that to be true rather than an error.
4316    ///
4317    /// The link is asserted alongside, because the flag changes it too and a build that compiled
4318    /// with it and linked without it is a program that calls the hook everywhere and never writes a
4319    /// profile.
4320    #[test]
4321    fn the_profiler_and_where_its_hook_goes_are_two_separate_questions() {
4322        let (opts, _) = compile(&["-c", "a.c"]);
4323        assert!(!opts.profile);
4324        assert_eq!(opts.hook, Hook::Platform, "neither was named, so the target decides");
4325
4326        for arg in ["-pg", "-p"] {
4327            let (opts, _) = compile(&["-c", arg, "a.c"]);
4328            assert!(opts.profile, "{arg}");
4329            let (link, _) = linking(&[arg, "a.c"]);
4330            assert!(link.profile, "{arg} changes the link as well");
4331        }
4332
4333        for (arg, want) in [("-mfentry", Hook::Early), ("-mno-fentry", Hook::Late)] {
4334            let (opts, _) = compile(&["-c", arg, "a.c"]);
4335            assert_eq!(opts.hook, want, "{arg}");
4336            assert!(!opts.profile, "{arg} asks for no call of its own");
4337        }
4338
4339        let (opts, _) = compile(&["-c", "-mfentry", "-mno-fentry", "-pg", "a.c"]);
4340        assert_eq!(opts.hook, Hook::Late, "the last one wins");
4341        assert!(opts.profile);
4342    }
4343
4344    /// How much room a patcher is promised, which is one number or two.
4345    ///
4346    /// A command line that did not ask is asserted alongside, because the flag has to be written to
4347    /// mean anything and a build that reserved room nobody asked for would grow every function in
4348    /// it for nothing.
4349    #[test]
4350    fn the_room_a_patcher_is_promised_is_a_number_of_bytes_and_where_they_go() {
4351        let (opts, _) = compile(&["-c", "a.c"]);
4352        assert_eq!(opts.patchable, Patchable::default());
4353        assert!(!opts.patchable.any(), "nothing is reserved unless it was asked for");
4354
4355        let (opts, _) = compile(&["-c", "-fpatchable-function-entry=16", "a.c"]);
4356        assert_eq!(opts.patchable, Patchable { total: 16, before: 0 });
4357
4358        let (opts, _) = compile(&["-c", "-fpatchable-function-entry=5,3", "a.c"]);
4359        assert_eq!(opts.patchable, Patchable { total: 5, before: 3 });
4360        assert_eq!(opts.patchable.after(), 2);
4361
4362        // The last one wins, which is what every other flag of this shape does and what a build
4363        // that adds one to a command line it did not write is relying on.
4364        let (opts, _) = compile(&[
4365            "-c",
4366            "-fpatchable-function-entry=5,3",
4367            "-fpatchable-function-entry=2",
4368            "a.c",
4369        ]);
4370        assert_eq!(opts.patchable, Patchable { total: 2, before: 0 });
4371    }
4372
4373    /// And a request nothing could satisfy is refused rather than rounded into one that can be.
4374    #[test]
4375    fn room_in_front_of_the_label_that_is_more_than_the_room_asked_for_is_refused() {
4376        for arg in ["-fpatchable-function-entry=1,2", "-fpatchable-function-entry=x"] {
4377            let e = parse_args(&args(&["-c", arg, "a.c"])).unwrap_err();
4378            assert!(e.message.contains("is not an amount of room to reserve"), "{}", e.message);
4379        }
4380    }
4381
4382    /// What wraps rather than being undefined, which is two questions and three flags.
4383    ///
4384    /// The older flag is the pair of the newer two, which is gcc's own reading of it, so a build
4385    /// that writes `-fno-strict-overflow` gets both and a build that writes one of the others gets
4386    /// only what it asked for.
4387    #[test]
4388    fn what_overflows_rather_than_being_undefined_is_asked_for_two_ways() {
4389        let (opts, _) = compile(&["-c", "a.c"]);
4390        assert_eq!(opts.wrapping, Wrapping::NONE, "nothing wraps unless it was asked for");
4391
4392        let (opts, _) = compile(&["-c", "-fwrapv", "a.c"]);
4393        assert_eq!(opts.wrapping, Wrapping { signed: true, pointer: false, trap: false });
4394
4395        let (opts, _) = compile(&["-c", "-fwrapv-pointer", "a.c"]);
4396        assert_eq!(opts.wrapping, Wrapping { signed: false, pointer: true, trap: false });
4397
4398        let (opts, _) = compile(&["-c", "-fno-strict-overflow", "a.c"]);
4399        assert_eq!(opts.wrapping, Wrapping::ALL);
4400
4401        // And the last one wins, in both directions. A build that turns one of these on globally
4402        // and off for one directory is relying on that, and so is one that writes the pair and
4403        // then takes half of it back.
4404        let (opts, _) = compile(&["-c", "-fwrapv", "-fno-wrapv", "a.c"]);
4405        assert_eq!(opts.wrapping, Wrapping::NONE);
4406
4407        let (opts, _) = compile(&["-c", "-fno-strict-overflow", "-fstrict-overflow", "a.c"]);
4408        assert_eq!(opts.wrapping, Wrapping::NONE);
4409
4410        let (opts, _) = compile(&["-c", "-fno-strict-overflow", "-fno-wrapv-pointer", "a.c"]);
4411        assert_eq!(opts.wrapping, Wrapping { signed: true, pointer: false, trap: false });
4412    }
4413
4414    /// And the other answer to the signed question cannot be held at the same time as the first.
4415    ///
4416    /// A program cannot both wrap and stop, so writing both is writing a contradiction, and gcc
4417    /// resolves it by letting the last one win rather than by reporting anything. That was measured
4418    /// against gcc 16 rather than read out of the manual, which says nothing about it: `-ftrapv
4419    /// -fwrapv` emits no checked calls and `-fwrapv -ftrapv` emits them.
4420    #[test]
4421    fn a_signed_overflow_that_stops_is_the_other_answer_and_not_a_third_one() {
4422        let (opts, _) = compile(&["-c", "-ftrapv", "a.c"]);
4423        assert_eq!(opts.wrapping, Wrapping { signed: false, pointer: false, trap: true });
4424
4425        let (opts, _) = compile(&["-c", "-fwrapv", "-ftrapv", "a.c"]);
4426        assert_eq!(opts.wrapping, Wrapping { signed: false, pointer: false, trap: true });
4427
4428        let (opts, _) = compile(&["-c", "-ftrapv", "-fwrapv", "a.c"]);
4429        assert_eq!(opts.wrapping, Wrapping { signed: true, pointer: false, trap: false });
4430
4431        let (opts, _) = compile(&["-c", "-ftrapv", "-fno-strict-overflow", "a.c"]);
4432        assert_eq!(opts.wrapping, Wrapping::ALL);
4433
4434        let (opts, _) = compile(&["-c", "-ftrapv", "-fno-trapv", "a.c"]);
4435        assert_eq!(opts.wrapping, Wrapping::NONE);
4436
4437        // And the flag that says what may be assumed says nothing about what happens, so it leaves
4438        // this alone where it takes the wrapping away. gcc does the same.
4439        let (opts, _) = compile(&["-c", "-ftrapv", "-fstrict-overflow", "a.c"]);
4440        assert_eq!(opts.wrapping, Wrapping { signed: false, pointer: false, trap: true });
4441    }
4442
4443    /// What a plain `char` is, which is four spellings of two answers and nothing by default.
4444    ///
4445    /// Nothing is the target's own answer and has to stay distinct from both of the others, since
4446    /// the same command line means a signed `char` on x86-64 and an unsigned one on Linux's arm64.
4447    /// The negative spellings are the other flag rather than a way of asking for the default, which
4448    /// was measured against gcc 16: `-fno-signed-char` defines `__CHAR_UNSIGNED__` and
4449    /// `-fno-unsigned-char` does not.
4450    #[test]
4451    fn the_signedness_of_a_plain_char_is_asked_for_in_four_ways() {
4452        let (opts, _) = compile(&["-c", "a.c"]);
4453        assert_eq!(opts.char_signed, None);
4454
4455        for flag in ["-fsigned-char", "-fno-unsigned-char"] {
4456            let (opts, _) = compile(&["-c", flag, "a.c"]);
4457            assert_eq!(opts.char_signed, Some(true), "{flag}");
4458        }
4459
4460        for flag in ["-funsigned-char", "-fno-signed-char"] {
4461            let (opts, _) = compile(&["-c", flag, "a.c"]);
4462            assert_eq!(opts.char_signed, Some(false), "{flag}");
4463        }
4464
4465        // And the last one wins, which is what a build that sets one globally and the other for a
4466        // directory relies on.
4467        let (opts, _) = compile(&["-c", "-funsigned-char", "-fsigned-char", "a.c"]);
4468        assert_eq!(opts.char_signed, Some(true));
4469
4470        // And what is asked for reaches the target, because that is what every other part of the
4471        // compiler asks. The triple is one whose own answer is the opposite, so a session that
4472        // ignored the flag would still read as signed here.
4473        let (opts, _) =
4474            compile(&["-c", "--target=aarch64-unknown-linux-gnu", "-fsigned-char", "a.c"]);
4475        assert!(Session::new(*opts).target.char_is_signed);
4476        let (opts, _) = compile(&["-c", "--target=aarch64-unknown-linux-gnu", "a.c"]);
4477        assert!(!Session::new(*opts).target.char_is_signed);
4478    }
4479
4480    /// And the size of an enumeration, which is one question with two spellings.
4481    #[test]
4482    fn the_smallest_enumeration_is_asked_for_and_taken_back() {
4483        let (opts, _) = compile(&["-c", "a.c"]);
4484        assert!(!opts.short_enums);
4485
4486        let (opts, _) = compile(&["-c", "-fshort-enums", "a.c"]);
4487        assert!(opts.short_enums);
4488
4489        let (opts, _) = compile(&["-c", "-fshort-enums", "-fno-short-enums", "a.c"]);
4490        assert!(!opts.short_enums);
4491
4492        let (opts, _) = compile(&["-c", "-fno-short-enums", "-fshort-enums", "a.c"]);
4493        assert!(opts.short_enums);
4494    }
4495
4496    /// And a value nothing means is refused rather than taken for the nearest thing it looks like.
4497    ///
4498    /// `-fcf-protection=all` is the spelling somebody writes from memory, and a compiler that read
4499    /// it as `full` would be guessing, while one that let it fall through to the optimizer's `-f`
4500    /// family would report it as an unknown pass. Neither is the news the build wants.
4501    #[test]
4502    fn a_control_flow_protection_nothing_means_is_refused() {
4503        let e = parse_args(&args(&["-c", "-fcf-protection=all", "a.c"])).unwrap_err();
4504        assert!(e.message.contains("is not a control flow protection"), "{}", e.message);
4505        assert!(e.message.contains("full, branch, return, none or check"), "{}", e.message);
4506    }
4507
4508    #[test]
4509    fn the_link_flags_are_collected_apart_from_the_compilation() {
4510        let (link, _) = linking(&[
4511            "-static",
4512            "-nostartfiles",
4513            "-rdynamic",
4514            "-s",
4515            "-fuse-ld=mold",
4516            "-L/opt/lib",
4517            "-B",
4518            "/opt/tools",
4519            "a.c",
4520        ]);
4521        assert!(link.is_static);
4522        assert!(link.no_startfiles);
4523        assert!(link.export_dynamic);
4524        assert!(link.strip);
4525        assert_eq!(link.use_ld.as_deref(), Some("mold"));
4526        assert_eq!(link.search, vec![PathBuf::from("/opt/lib")]);
4527        assert_eq!(link.prefixes, vec![PathBuf::from("/opt/tools")]);
4528    }
4529
4530    #[test]
4531    fn a_comma_in_dash_wl_separates_two_arguments() {
4532        let (link, _) = linking(&["-Wl,-rpath,/opt/lib", "-Xlinker", "--as-needed", "a.c"]);
4533        assert_eq!(link.passthrough, vec!["-rpath", "/opt/lib", "--as-needed"]);
4534    }
4535
4536    #[test]
4537    fn a_library_keeps_its_place_between_the_objects() {
4538        // Link order is semantic: `-lm` written between two files resolves for the one before
4539        // it and not for the one after, so a library cannot be collected into a list of its own.
4540        // The target is named because the suffix of an object is the target's and this asserts
4541        // on the names: the same command line on a Windows host plans two `.obj` files.
4542        let (_, plan) = linking(&["--target=x86_64-unknown-linux-gnu", "a.c", "-lm", "b.c"]);
4543        let link = plan.link.expect("expected a link step");
4544        assert_eq!(
4545            link.inputs,
4546            vec![
4547                link::Item::File("a.o".into()),
4548                link::Item::Library("m".into()),
4549                link::Item::File("b.o".into()),
4550            ]
4551        );
4552        // And it is not a job, because there is nothing to compile in a library.
4553        assert_eq!(plan.jobs.len(), 2);
4554    }
4555
4556    #[test]
4557    fn a_library_on_a_dash_c_line_is_a_note_rather_than_an_error() {
4558        let (_, plan) = linking(&["-c", "-lm", "a.c"]);
4559        assert!(plan.link.is_none());
4560        assert!(plan.notes.iter().any(|n| n.contains("-lm")), "{:?}", plan.notes);
4561    }
4562
4563    #[test]
4564    fn the_sysroot_reaches_the_linker_as_well_as_the_headers() {
4565        let (link, _) = linking(&["--sysroot=/opt/root", "a.c"]);
4566        assert_eq!(link.sysroot, Some(PathBuf::from("/opt/root")));
4567    }
4568
4569    fn printed(s: &[&str]) -> String {
4570        match parse_args(&args(s)).expect("expected an answer") {
4571            Action::Print(line) => line,
4572            other => panic!("expected an answer, got {other:?}"),
4573        }
4574    }
4575
4576    fn refused(s: &[&str]) -> String {
4577        parse_args(&args(s)).expect_err("expected a refusal").message
4578    }
4579
4580    #[test]
4581    fn a_warning_flag_this_compiler_has_not_heard_of_is_taken_rather_than_refused() {
4582        // The rule in section 4.1, and the reason for it is autoconf: a configure script finds
4583        // out whether a warning flag exists by passing it and looking at the exit status, so a
4584        // compiler that refuses one it does not know fails a script written for a newer GCC.
4585        let (opts, _) = compile(&["-Wall", "-Wextra", "-Wno-format-truncation", "-c", "a.c"]);
4586        assert!(!opts.warnings_are_errors);
4587        assert!(opts.warnings);
4588        // The two spellings that do mean something are still read.
4589        let (opts, _) = compile(&["-Werror", "-c", "a.c"]);
4590        assert!(opts.warnings_are_errors);
4591        let (opts, _) = compile(&["-w", "-c", "a.c"]);
4592        assert!(!opts.warnings);
4593        let (opts, _) = compile(&["-pedantic-errors", "-c", "a.c"]);
4594        assert!(opts.pedantic && opts.warnings_are_errors);
4595    }
4596
4597    #[test]
4598    fn an_argument_for_a_separate_tool_is_refused_rather_than_dropped() {
4599        // Every one of these says something about the output, so the wrong answer is silence.
4600        assert!(refused(&["-Wa,--noexecstack", "-c", "a.c"]).contains("separate assembler"));
4601        assert!(refused(&["-Wp,-DX", "-c", "a.c"]).contains("separate assembler"));
4602        assert!(refused(&["-specs=/x", "a.c"]).contains("-specs= is not supported"));
4603        assert!(refused(&["-mcmodel=kernel", "-c", "a.c"]).contains("small code model"));
4604        assert!(refused(&["-gdwarf-4", "-c", "a.c"]).contains("DWARF 5"));
4605        assert!(refused(&["-Ofast", "-c", "a.c"]).contains("fast math"));
4606        // The word size the target does not have, which is a target this compiler was not asked
4607        // for rather than a flag it does not know.
4608        let no32 = refused(&["--target=x86_64-unknown-linux-gnu", "-m32", "-c", "a.c"]);
4609        assert!(no32.contains("32 bit target"), "{no32}");
4610    }
4611
4612    /// `-gz` and the two spellings of the split, which are the two questions about the shape of
4613    /// the debug output rather than about how much of it there is.
4614    ///
4615    /// Both answers here are about what happens when there is debug information to shape, and
4616    /// there is none yet, so what is being asserted is that the flags are read and remembered
4617    /// rather than that anything changed in the output. That is the whole of what taking them
4618    /// claims, and it is worth a test because the day `rucc-debug` writes a section this is where
4619    /// it comes to find out what the command line said.
4620    #[test]
4621    fn the_shape_of_the_debug_output_is_recorded_even_where_there_is_none_of_it() {
4622        let (opts, _) = compile(&["-c", "a.c"]);
4623        assert_eq!(opts.compress, Compress::None, "uncompressed unless somebody asks");
4624
4625        // Bare `-gz` is `-gz=zlib`, measured against gcc 16 rather than read out of the manual,
4626        // which describes the flag without ever saying which algorithm it picks.
4627        assert_eq!(compile(&["-gz", "-c", "a.c"]).0.compress, Compress::Zlib);
4628        for (spelling, want) in [
4629            ("none", Compress::None),
4630            ("zlib", Compress::Zlib),
4631            ("zlib-gnu", Compress::ZlibGnu),
4632            ("zstd", Compress::Zstd),
4633        ] {
4634            let (opts, _) = compile(&[&format!("-gz={spelling}"), "-c", "a.c"]);
4635            assert_eq!(opts.compress, want, "{spelling}");
4636        }
4637
4638        // A value nothing here has heard of is refused rather than rounded to the nearest one,
4639        // because a build that asked for `zstd` and quietly got `zlib` would ship a file its
4640        // reader may not understand and would have no way of finding out.
4641        for bad in ["-gz=gzip", "-gz="] {
4642            let failed = refused(&[bad, "-c", "a.c"]);
4643            assert!(failed.contains("is not a way to compress"), "{bad}: {failed}");
4644        }
4645
4646        // The split is refused in the direction that would have written a file and taken in the
4647        // direction that describes what happens. A build system that names the `.dwo` as an
4648        // output has to hear about it now rather than at the point the file is missing.
4649        let (opts, _) = compile(&["-gno-split-dwarf", "-g", "-c", "a.c"]);
4650        assert!(opts.debug_info, "the negative spelling says nothing about how much");
4651        let failed = refused(&["-gsplit-dwarf", "-c", "a.c"]);
4652        assert!(failed.contains(".dwo"), "the refusal names the file it would have written");
4653    }
4654
4655    /// The `-flto` family, which is the whole of an optimization this compiler does not do.
4656    ///
4657    /// Taken rather than refused because ignoring it gives a correct program that is slower than
4658    /// it could have been, which is section 4.1's hint about speed. The values are still held to
4659    /// gcc's, so a command line written for clang is told rather than quietly taken.
4660    #[test]
4661    fn the_link_time_family_is_read_and_checked_and_nothing_is_done_about_it() {
4662        let (opts, _) = compile(&["-c", "a.c"]);
4663        assert!(!opts.lto.requested, "nothing asks unless the command line does");
4664
4665        let (opts, _) = compile(&["-flto", "-c", "a.c"]);
4666        assert!(opts.lto.requested);
4667        assert_eq!(opts.lto.jobs, LtoJobs::One, "bare -flto is one process, the way gcc reads it");
4668
4669        // The last of the two directions wins, the same as every other pair of `-f` spellings.
4670        assert!(!compile(&["-flto", "-fno-lto", "-c", "a.c"]).0.lto.requested);
4671        assert!(compile(&["-fno-lto", "-flto", "-c", "a.c"]).0.lto.requested);
4672
4673        // A count is a count, and asking for one implies asking for the optimization.
4674        for (spelling, want) in [
4675            ("auto", LtoJobs::Auto),
4676            ("jobserver", LtoJobs::Jobserver),
4677            ("1", LtoJobs::One),
4678            ("8", LtoJobs::Count(8)),
4679        ] {
4680            let (opts, _) = compile(&[&format!("-flto={spelling}"), "-c", "a.c"]);
4681            assert_eq!(opts.lto.jobs, want, "{spelling}");
4682            assert!(opts.lto.requested, "{spelling} asks for it too");
4683        }
4684
4685        // gcc refuses a zero rather than reading it as `-fno-lto`, and `thin` is clang's spelling
4686        // of a question gcc answers with `-flto-partition=`, so somebody who wrote it meant a
4687        // different compiler and gets told so here rather than getting a serial link.
4688        for bad in ["-flto=0", "-flto=thin", "-flto=full", "-flto=-1"] {
4689            let failed = refused(&[bad, "-c", "a.c"]);
4690            assert!(failed.contains("link time jobs"), "{bad}: {failed}");
4691        }
4692
4693        // How the program is cut up before the work is spread over it.
4694        assert_eq!(compile(&["-c", "a.c"]).0.lto.partition, Partition::Balanced, "gcc's default");
4695        for (spelling, want) in [
4696            ("balanced", Partition::Balanced),
4697            ("1to1", Partition::OneToOne),
4698            ("one", Partition::One),
4699            ("max", Partition::Max),
4700            ("none", Partition::None),
4701        ] {
4702            let (opts, _) = compile(&[&format!("-flto-partition={spelling}"), "-c", "a.c"]);
4703            assert_eq!(opts.lto.partition, want, "{spelling}");
4704        }
4705        assert!(refused(&["-flto-partition=big", "-c", "a.c"]).contains("partitioning model"));
4706
4707        // And how hard the bytecode is compressed on its way into the object, which is zstd's
4708        // range of levels and is the range gcc checks an argument against.
4709        assert_eq!(compile(&["-c", "a.c"]).0.lto.compression, None, "whatever it does by default");
4710        assert_eq!(compile(&["-flto-compression-level=0", "-c", "a.c"]).0.lto.compression, Some(0));
4711        let (opts, _) = compile(&["-flto-compression-level=19", "-c", "a.c"]);
4712        assert_eq!(opts.lto.compression, Some(19));
4713        for bad in ["-flto-compression-level=20", "-flto-compression-level=-1"] {
4714            let failed = refused(&[bad, "-c", "a.c"]);
4715            assert!(failed.contains("compression level"), "{bad}: {failed}");
4716        }
4717
4718        // The two pairs that describe an arrangement rather than ask for one. Every object here
4719        // holds its machine code, so the fat spelling is what already happens and the other is a
4720        // smaller file rather than a different program, and the plugin pair is about a tool the
4721        // design in `spec/09-optimizer.md` never loads.
4722        for taken in [
4723            "-ffat-lto-objects",
4724            "-fno-fat-lto-objects",
4725            "-fuse-linker-plugin",
4726            "-fno-use-linker-plugin",
4727        ] {
4728            let (opts, _) = compile(&[taken, "-c", "a.c"]);
4729            assert!(!opts.lto.requested, "{taken} says nothing about whether to do it");
4730        }
4731    }
4732
4733    /// The profile family, which is the only one here that splits down the middle.
4734    ///
4735    /// Reading a profile is taken and writing one is refused, and the line between them is the one
4736    /// section 4.1 draws: ignoring a request to read the counts gives a correct program that is
4737    /// slower than it could have been, and ignoring a request to write them means a file the build
4738    /// declared as an output never appears.
4739    #[test]
4740    fn reading_a_profile_is_taken_and_writing_one_is_refused() {
4741        let (opts, _) = compile(&["-c", "a.c"]);
4742        assert!(!opts.profile_data.requested, "nothing asks unless the command line does");
4743        assert_eq!(opts.profile_data.path, None);
4744
4745        let (opts, _) = compile(&["-fprofile-use", "-c", "a.c"]);
4746        assert!(opts.profile_data.requested);
4747        assert_eq!(opts.profile_data.path, None, "beside the object, the way gcc looks");
4748
4749        let (opts, _) = compile(&["-fprofile-use=/counts", "-c", "a.c"]);
4750        assert!(opts.profile_data.requested, "naming a path asks for it too");
4751        assert_eq!(opts.profile_data.path.as_deref(), Some("/counts"));
4752
4753        // The last of the two directions wins, the same as every other pair of `-f` spellings.
4754        assert!(
4755            !compile(&["-fprofile-use", "-fno-profile-use", "-c", "a.c"]).0.profile_data.requested
4756        );
4757        assert!(
4758            compile(&["-fno-profile-use", "-fprofile-use", "-c", "a.c"]).0.profile_data.requested
4759        );
4760
4761        // The rest of the reading half, which is where the files are and three answers about what
4762        // to make of what is in them.
4763        let (opts, _) = compile(&[
4764            "-fprofile-dir=/build/profiles",
4765            "-fprofile-abs-path",
4766            "-fprofile-correction",
4767            "-fprofile-partial-training",
4768            "-c",
4769            "a.c",
4770        ]);
4771        assert_eq!(opts.profile_data.dir.as_deref(), Some("/build/profiles"));
4772        assert!(opts.profile_data.absolute);
4773        assert!(opts.profile_data.correction);
4774        assert!(opts.profile_data.partial_training);
4775
4776        // Writing one, which is refused by name. The first four instrument the program and the
4777        // last writes a file beside the object, and a build that got neither and no message would
4778        // go on to optimize against counts that were never gathered.
4779        for writing in [
4780            "-fprofile-generate",
4781            "-fprofile-generate=/build/profiles",
4782            "-fprofile-arcs",
4783            "--coverage",
4784            "-fcondition-coverage",
4785            "-fpath-coverage",
4786        ] {
4787            let failed = refused(&[writing, "-c", "a.c"]);
4788            assert!(failed.contains("instrument"), "{writing}: {failed}");
4789        }
4790        assert!(refused(&["-ftest-coverage", "-c", "a.c"]).contains(".gcno"), "it names the file");
4791
4792        // The negative spellings of the refused half are what already happens, so they are taken.
4793        for taken in ["-fno-profile-generate", "-fno-profile-arcs", "-fno-test-coverage"] {
4794            let (opts, _) = compile(&[taken, "-c", "a.c"]);
4795            assert!(!opts.profile_data.requested, "{taken} asks for nothing");
4796        }
4797
4798        // And the flags that describe the instrumentation that is refused above, which are checked
4799        // and dropped. Checked because a typo is worth finding here rather than on the day the
4800        // instrumentation lands.
4801        for taken in [
4802            "-fprofile-update=single",
4803            "-fprofile-update=atomic",
4804            "-fprofile-update=prefer-atomic",
4805            "-fprofile-reproducible=serial",
4806            "-fprofile-reproducible=parallel-runs",
4807            "-fprofile-reproducible=multithreaded",
4808            "-fprofile-values",
4809            "-fno-profile-values",
4810            "-fprofile-info-section",
4811            "-fprofile-filter-files=a.c",
4812            "-fprofile-exclude-files=b.c",
4813            "-fprofile-note=a.gcno",
4814        ] {
4815            let (opts, _) = compile(&[taken, "-c", "a.c"]);
4816            assert!(!opts.profile_data.requested, "{taken} says nothing about reading one");
4817        }
4818        assert!(refused(&["-fprofile-update=none", "-c", "a.c"]).contains("update method"));
4819        assert!(refused(&["-fprofile-reproducible=any", "-c", "a.c"]).contains("reproducibility"));
4820    }
4821
4822    /// The sanitizers, which are refused by name and are the one family refused for a reason that
4823    /// is not about the bytes.
4824    ///
4825    /// A sanitizer is a promise that the program is watched while it runs, so a build that asked
4826    /// for one and was quietly given a program with no checks in it gets a test suite that passes
4827    /// for the wrong reason rather than a slower program.
4828    #[test]
4829    fn a_sanitizer_that_is_still_asked_for_at_the_end_of_the_line_is_refused_by_name() {
4830        for asked in ["address", "undefined", "thread", "kernel-address", "leak", "memory"] {
4831            let failed = refused(&[&format!("-fsanitize={asked}"), "-c", "a.c"]);
4832            assert!(failed.contains(asked), "the refusal names what was asked for: {failed}");
4833            assert!(failed.contains("-fsafety=detect"), "and the nearest thing: {failed}");
4834        }
4835
4836        // A list is every name in it, and the first one still standing is the one named.
4837        let failed = refused(&["-fsanitize=address,undefined", "-c", "a.c"]);
4838        assert!(failed.contains("address"), "{failed}");
4839
4840        // A name that is not one, which is worth its own message: somebody who wrote `-fsanitize`
4841        // with a typo in it has a different problem from somebody who wrote a real one.
4842        for bad in ["-fsanitize=bogus", "-fsanitize=address,bogus", "-fno-sanitize=bogus"] {
4843            let failed = refused(&[bad, "-c", "a.c"]);
4844            assert!(failed.contains("is not a sanitizer"), "{bad}: {failed}");
4845        }
4846
4847        // gcc takes `all` only in the negative, and so does this.
4848        assert!(refused(&["-fsanitize=all", "-c", "a.c"]).contains("only `-fno-sanitize=all`"));
4849
4850        // Asking and then taking it back is asking for nothing, which is why the answer waits for
4851        // the end of the line. A build whose shared flags turn a check on and whose rule for one
4852        // file turns it off again compiles that file here.
4853        for pair in [
4854            ["-fsanitize=address", "-fno-sanitize=address"],
4855            ["-fsanitize=address,undefined", "-fno-sanitize=all"],
4856            ["-fsanitize=undefined", "-fno-sanitize=undefined"],
4857        ] {
4858            let (opts, _) = compile(&[pair[0], pair[1], "-c", "a.c"]);
4859            assert_eq!(opts.safety, rucc_session::Safety::Off, "{pair:?} asked for nothing");
4860        }
4861        // And the other order still asks, because the last word is the one that counts.
4862        assert!(!refused(&["-fno-sanitize=address", "-fsanitize=address", "-c", "a.c"]).is_empty());
4863
4864        // What a check does when it fires is an answer about checks that are refused, so there is
4865        // nothing left for it to change and it is taken.
4866        for taken in [
4867            "-fsanitize-recover=undefined",
4868            "-fno-sanitize-recover=all",
4869            "-fsanitize-trap=undefined",
4870            "-fno-sanitize-trap=all",
4871            "-fsanitize-undefined-trap-on-error",
4872            "-fsanitize-address-use-after-scope",
4873            "-fno-sanitize-address-use-after-scope",
4874            "-fsanitize-sections=.data",
4875        ] {
4876            let (opts, _) = compile(&[taken, "-c", "a.c"]);
4877            assert_eq!(opts.safety, rucc_session::Safety::Off, "{taken} asks for no checking");
4878        }
4879        assert!(refused(&["-fsanitize-recover=bogus", "-c", "a.c"]).contains("is not a sanitizer"));
4880
4881        // Coverage instrumentation is refused rather than dropped, because a fuzzer with no
4882        // feedback runs blind and never says so.
4883        let failed = refused(&["-fsanitize-coverage=trace-pc", "-c", "a.c"]);
4884        assert!(failed.contains("feedback"), "{failed}");
4885        let failed = refused(&["-fsanitize-coverage=trace-pc-guard", "-c", "a.c"]);
4886        assert!(failed.contains("trace-pc or trace-cmp"), "gcc takes two of them: {failed}");
4887    }
4888
4889    #[test]
4890    fn the_levels_gcc_spells_differently_are_the_levels_they_mean() {
4891        assert_eq!(compile(&["-O", "-c", "a.c"]).0.opt_level, OptLevel::O1);
4892        assert_eq!(compile(&["-Og", "-c", "a.c"]).0.opt_level, OptLevel::O1);
4893        assert_eq!(compile(&["-O2", "-c", "a.c"]).0.opt_level, OptLevel::O2);
4894    }
4895
4896    #[test]
4897    fn the_machine_flags_that_name_what_we_already_do_are_taken_and_the_rest_are_not() {
4898        let line = ["--target=x86_64-unknown-linux-gnu", "-m64", "-march=x86-64-v3"];
4899        let (opts, _) =
4900            compile(&[&line[..], &["-mtune=native", "-mabi=sysv", "-c", "a.c"]].concat());
4901        assert_eq!(opts.target.to_string(), "x86_64-unknown-linux-gnu");
4902        let wrong = refused(&["--target=x86_64-unknown-linux-gnu", "-mabi=ms", "-c", "a.c"]);
4903        assert!(wrong.contains("sysv convention"), "{wrong}");
4904    }
4905
4906    #[test]
4907    fn the_thread_flag_is_a_macro_and_a_library_and_the_library_goes_last() {
4908        let (opts, plan) = compile(&["-pthread", "-c", "a.c"]);
4909        assert!(opts.defines.iter().any(|d| d == "_REENTRANT"));
4910        // After the input, because a static link takes what it needs from a library when it
4911        // reaches it and not afterwards.
4912        let names: Vec<&str> = plan.jobs.iter().map(|j| j.input.as_str()).collect();
4913        assert_eq!(names, vec!["a.c"]);
4914    }
4915
4916    #[test]
4917    fn the_questions_a_build_system_asks_before_it_compiles_anything() {
4918        let target = "--target=x86_64-unknown-linux-gnu";
4919        assert_eq!(printed(&[target, "-dumpmachine"]), "x86_64-unknown-linux-gnu");
4920        assert_eq!(printed(&[target, "-dumpversion"]), VERSION);
4921        assert_eq!(printed(&[target, "-dumpfullversion"]), VERSION);
4922        assert_eq!(printed(&[target, "-print-multiarch"]), "x86_64-linux-gnu");
4923        // A name nothing holds comes back unchanged, which is GCC's rule and is what makes the
4924        // answer safe to paste into a link line whether or not the file is there.
4925        assert_eq!(printed(&[target, "-print-file-name=no-such-library.a"]), "no-such-library.a");
4926        assert_eq!(printed(&[target, "-print-prog-name=ld"]), "ld");
4927        let dirs = printed(&[target, "-print-search-dirs"]);
4928        assert!(dirs.starts_with("install: "), "{dirs}");
4929        assert!(dirs.contains("\nlibraries: ="), "{dirs}");
4930    }
4931
4932    #[test]
4933    fn the_sysroot_in_effect_is_the_one_the_command_line_named_or_the_one_for_the_target() {
4934        // A tree the user named is the answer whatever the target is, because it is the answer to
4935        // every other question too.
4936        assert_eq!(printed(&["--sysroot=/opt/cross", "-print-sysroot"]), "/opt/cross");
4937
4938        // A target that is no machine this suite runs on is read under the cache, and the answer is
4939        // the root rather than one of the directories under it, since what asks is looking for a
4940        // file of its own.
4941        let root = cache::dir().join("sysroots").join("riscv64-linux-musl");
4942        assert_eq!(
4943            printed(&["--target=riscv64-linux-musl", "-print-sysroot"]),
4944            root.display().to_string()
4945        );
4946
4947        // And a compile for this machine has no sysroot, which is the empty line GCC prints when it
4948        // was configured without one rather than a `/` that would be a claim about the filesystem.
4949        let host = Triple::host().expect("a host this compiler knows");
4950        assert_eq!(printed(&[&format!("--target={host}"), "-print-sysroot"]), "");
4951    }
4952
4953    #[test]
4954    fn the_provenance_of_a_sysroot_is_the_manifest_it_carries() {
4955        // Section 13.5 wants seven things per input and wants them machine readable, and the manifest
4956        // is the record that already has them, so the flag prints that rather than a second format.
4957        let manifest = "rucc sysroot manifest 3\n\
4958                        target\tx86_64-linux-musl\n\
4959                        kernel\t6.12\n\
4960                        include/generic/stdio.h\tmusl-1.2.5\t\
4961                        https://musl.libc.org/releases/musl-1.2.5.tar.gz\t\
4962                        0000000000000000000000000000000000000000000000000000000000000000\tmit\t\
4963                        bundled\n\
4964                        lib/libc.so\tmusl-1.2.5\t\
4965                        https://musl.libc.org/releases/musl-1.2.5.tar.gz\t\
4966                        1111111111111111111111111111111111111111111111111111111111111111\tmit\t\
4967                        generated\n";
4968        let tree = TempTree::new("provenance", &[("manifest", manifest)]);
4969        let sysroot = format!("--sysroot={}", tree.0.display());
4970        // The kernel line of tamnd/rucc#934 is in the answer without anything here naming it, because
4971        // the flag parses the record and renders it again rather than picking fields out of it. That
4972        // is the reason it prints a manifest and not a format of its own.
4973        //
4974        // The answer is the file without its last newline, because whatever prints it adds one. The
4975        // file is what somebody diffs the output against, so the two have to be the same bytes.
4976        assert_eq!(printed(&[&sysroot, "-print-sysroot-provenance"]) + "\n", manifest);
4977
4978        // A tree with no manifest in it is a tree somebody assembled themselves, and nothing here
4979        // knows where any of it came from. Saying nothing is the only honest answer, and a reader can
4980        // tell it from a manifest with no inputs because that one still has its two header lines.
4981        let bare = TempTree::new("provenance-bare", &[]);
4982        assert_eq!(
4983            printed(&[&format!("--sysroot={}", bare.0.display()), "-print-sysroot-provenance"]),
4984            ""
4985        );
4986
4987        // And a compile for this machine has no sysroot at all, which is the same empty answer
4988        // `-print-sysroot` gives for it.
4989        let host = Triple::host().expect("a host this compiler knows");
4990        assert_eq!(printed(&[&format!("--target={host}"), "-print-sysroot-provenance"]), "");
4991
4992        // And the other spelling, which section 13.5 is the document that writes.
4993        assert_eq!(printed(&[&sysroot, "--print-sysroot-provenance"]) + "\n", manifest);
4994
4995        // tamnd/rucc#1021. The digest of the same tree is the sha256 of that record, so it is one
4996        // line where the provenance is a few hundred, and it is checkable with `sha256sum` because
4997        // the bytes it is over are the bytes of the file. The number here is that hash of the
4998        // fixture above, computed by `sha256sum` rather than by this compiler.
4999        assert_eq!(
5000            printed(&[&sysroot, "-print-sysroot-digest"]),
5001            "d705ae6ebeafeb7fda4bd57cecc7882bf49784b17015664a09cfae25a1b2000a"
5002        );
5003        assert_eq!(
5004            printed(&[&sysroot, "--print-sysroot-digest"]),
5005            printed(&[&sysroot, "-print-sysroot-digest"])
5006        );
5007
5008        // And the two empty answers are empty here too, because a digest of nothing would read as a
5009        // claim about a sysroot rather than as the absence of one.
5010        assert_eq!(
5011            printed(&[&format!("--sysroot={}", bare.0.display()), "-print-sysroot-digest"]),
5012            ""
5013        );
5014        assert_eq!(printed(&[&format!("--target={host}"), "-print-sysroot-digest"]), "");
5015    }
5016
5017    #[test]
5018    fn a_manifest_this_build_cannot_read_is_refused_rather_than_printed() {
5019        // Passing a file we could not parse to whoever asked would make their parser the one that
5020        // finds the problem, and the three uses section 13.5 gives for this are all somebody else
5021        // parsing it.
5022        let tree = TempTree::new(
5023            "provenance-bad",
5024            &[("manifest", "rucc sysroot manifest 3\ntarget\tx86_64-linux-musl\nlib/libc.a\n")],
5025        );
5026        let message =
5027            refused(&[&format!("--sysroot={}", tree.0.display()), "-print-sysroot-provenance"]);
5028        assert!(message.contains("manifest"), "{message}");
5029        assert!(message.contains("1 fields where an input has six"), "{message}");
5030
5031        // The digest is refused for the same file and for a stronger reason: a hash of bytes this
5032        // build cannot read would be a number that names a record nobody can act on.
5033        let digest =
5034            refused(&[&format!("--sysroot={}", tree.0.display()), "-print-sysroot-digest"]);
5035        assert_eq!(digest, message);
5036    }
5037
5038    #[test]
5039    fn the_two_dependency_flags_that_stop_after_the_rule_stop_after_the_rule() {
5040        let (opts, _) = compile(&["-M", "a.c"]);
5041        assert!(opts.deps.emit && opts.deps.instead_of_compiling);
5042        assert!(opts.deps.system_headers, "plain -M lists them");
5043        assert_eq!(opts.emit, EmitKind::Preprocessed);
5044
5045        // Even where a later flag asked for something else, because the family is a mode and
5046        // the mode is what the run is for.
5047        let (opts, _) = compile(&["-M", "-c", "a.c"]);
5048        assert_eq!(opts.emit, EmitKind::Preprocessed);
5049
5050        let (opts, _) = compile(&["-MM", "a.c"]);
5051        assert!(!opts.deps.system_headers);
5052    }
5053
5054    #[test]
5055    fn the_two_that_end_in_d_leave_the_compilation_alone() {
5056        let (opts, _) = compile(&["-MD", "-c", "a.c"]);
5057        assert!(opts.deps.emit && !opts.deps.instead_of_compiling);
5058        assert!(opts.deps.system_headers);
5059        assert_eq!(opts.emit, EmitKind::Object);
5060
5061        let (opts, _) = compile(&["-MMD", "-c", "a.c"]);
5062        assert!(opts.deps.emit && !opts.deps.instead_of_compiling);
5063        assert!(!opts.deps.system_headers);
5064    }
5065
5066    #[test]
5067    fn nothing_puts_the_system_headers_back_once_a_flag_has_taken_them_out() {
5068        // GCC's rule, and not an oversight in it. The flag asking for fewer of them is read as
5069        // the answer, because the other one never asked the question.
5070        let (opts, _) = compile(&["-MM", "-M", "a.c"]);
5071        assert!(!opts.deps.system_headers);
5072        let (opts, _) = compile(&["-MD", "-MMD", "-c", "a.c"]);
5073        assert!(!opts.deps.system_headers);
5074        let (opts, _) = compile(&["-MMD", "-MD", "-c", "a.c"]);
5075        assert!(!opts.deps.system_headers);
5076    }
5077
5078    #[test]
5079    fn a_target_arrives_escaped_from_one_flag_and_untouched_from_the_other() {
5080        let (opts, _) = compile(&["-MM", "-MT", "a b.o", "-MQ", "a b.o", "a.c"]);
5081        assert_eq!(opts.deps.targets, vec!["a b.o".to_owned(), "a\\ b.o".to_owned()]);
5082    }
5083
5084    #[test]
5085    fn the_rest_of_the_family_is_a_file_and_a_switch() {
5086        let (opts, _) = compile(&["-MM", "-MF", "dep.d", "-MP", "a.c"]);
5087        assert_eq!(opts.deps.file.as_deref(), Some("dep.d"));
5088        assert!(opts.deps.phony);
5089
5090        for flag in ["-MF", "-MT", "-MQ"] {
5091            let e = parse_args(&args(&[flag])).unwrap_err();
5092            assert!(e.message.contains("requires an argument"), "{}", e.message);
5093        }
5094    }
5095
5096    /// A directory of sources for one test, removed when the test is done with it.
5097    struct TempTree(PathBuf);
5098
5099    impl Drop for TempTree {
5100        fn drop(&mut self) {
5101            let _ = std::fs::remove_dir_all(&self.0);
5102        }
5103    }
5104
5105    impl TempTree {
5106        fn new(name: &str, files: &[(&str, &str)]) -> TempTree {
5107            let dir = std::env::temp_dir().join(format!("rucc-deps-{}-{name}", std::process::id()));
5108            let _ = std::fs::remove_dir_all(&dir);
5109            std::fs::create_dir_all(&dir).expect("temporary directory should be writable");
5110            for (path, text) in files {
5111                let at = dir.join(path);
5112                if let Some(parent) = at.parent() {
5113                    std::fs::create_dir_all(parent).expect("creating a subdirectory should work");
5114                }
5115                std::fs::write(&at, text).expect("writing a temporary file should work");
5116            }
5117            TempTree(dir)
5118        }
5119
5120        fn path(&self, name: &str) -> String {
5121            self.0.join(name).to_string_lossy().into_owned()
5122        }
5123    }
5124
5125    #[test]
5126    fn the_rule_names_what_the_includes_found_and_names_each_of_them_once() {
5127        // End to end, because the list comes from the preprocessor and the format comes from
5128        // somewhere else, and a test of either half on its own would pass with the two of them
5129        // wired up backwards.
5130        let tree = TempTree::new(
5131            "found",
5132            &[
5133                ("a.c", "#include \"one.h\"\n#include \"two.h\"\nint main(void) { return X; }\n"),
5134                ("one.h", "#define X 0\n"),
5135                ("two.h", "#include \"one.h\"\n"),
5136            ],
5137        );
5138        let out = tree.path("dep.d");
5139        let code = run(&args(&["-MM", "-MF", &out, "-o", &tree.path("a.i"), &tree.path("a.c")]));
5140        assert_eq!(code, 0);
5141
5142        let text = std::fs::read_to_string(&out).expect("the rule should have been written");
5143        let names: Vec<&str> = text.split_whitespace().collect();
5144        // The target, the source, and each header once however many times it was reached.
5145        assert_eq!(names.first(), Some(&"a.o:"), "{text}");
5146        assert_eq!(names.iter().filter(|n| n.ends_with("one.h")).count(), 1, "{text}");
5147        assert_eq!(names.iter().filter(|n| n.ends_with("two.h")).count(), 1, "{text}");
5148        // And the `-o` went to the file the rule replaced, which is left empty rather than
5149        // absent because a makefile that named it as a target will look for it.
5150        assert_eq!(std::fs::read(tree.path("a.i")).expect("the output should exist"), b"");
5151    }
5152
5153    #[test]
5154    fn a_header_that_is_only_reached_under_a_guard_is_still_a_dependency() {
5155        // The multiple-include optimization means the second reach never opens the file. It is
5156        // still a file this translation unit was built from, so it is still in the rule.
5157        let tree = TempTree::new(
5158            "guarded",
5159            &[
5160                ("a.c", "#include \"g.h\"\n#include \"g.h\"\nint main(void) { return 0; }\n"),
5161                ("g.h", "#ifndef G\n#define G\n#endif\n"),
5162            ],
5163        );
5164        let out = tree.path("dep.d");
5165        let code = run(&args(&["-MM", "-MF", &out, "-o", &tree.path("a.i"), &tree.path("a.c")]));
5166        assert_eq!(code, 0);
5167        let text = std::fs::read_to_string(&out).expect("the rule should have been written");
5168        assert_eq!(text.split_whitespace().filter(|n| n.ends_with("g.h")).count(), 1, "{text}");
5169    }
5170
5171    #[test]
5172    fn every_imacros_file_is_read_before_every_include_file_whatever_order_they_were_written() {
5173        // Measured against GCC rather than read: the two flags the other way round produce the
5174        // same output byte for byte, so the command line order between the two families does not
5175        // decide anything and the order within one does. The `-include` file here can only see
5176        // the definition if the `-imacros` file that was written after it ran first.
5177        let tree = TempTree::new(
5178            "preinclude",
5179            &[
5180                ("a.c", "int main(void) { return 0; }\n"),
5181                ("i.h", "#ifdef FROM_MACROS\nint saw_it;\n#else\nint missed_it;\n#endif\n"),
5182                ("m.h", "#define FROM_MACROS 1\nint macros_text;\n"),
5183            ],
5184        );
5185        let out = tree.path("a.i");
5186        let code = run(&args(&[
5187            "-E",
5188            "-include",
5189            &tree.path("i.h"),
5190            "-imacros",
5191            &tree.path("m.h"),
5192            "-o",
5193            &out,
5194            &tree.path("a.c"),
5195        ]));
5196        assert_eq!(code, 0);
5197        let text = std::fs::read_to_string(&out).expect("the output should have been written");
5198        assert!(text.contains("saw_it"), "{text}");
5199        // And the text of the `-imacros` file is thrown away, which is the whole difference
5200        // between the two flags.
5201        assert!(!text.contains("macros_text"), "{text}");
5202    }
5203
5204    #[test]
5205    fn a_file_the_command_line_named_is_a_prerequisite_the_same_as_one_a_directive_named() {
5206        let tree = TempTree::new(
5207            "preinclude-deps",
5208            &[
5209                ("a.c", "int main(void) { return 0; }\n"),
5210                ("i.h", "int from_include;\n"),
5211                ("m.h", "#define M 1\n"),
5212            ],
5213        );
5214        let out = tree.path("dep.d");
5215        let code = run(&args(&[
5216            "-MM",
5217            "-MF",
5218            &out,
5219            "-include",
5220            &tree.path("i.h"),
5221            "-imacros",
5222            &tree.path("m.h"),
5223            "-o",
5224            &tree.path("a.i"),
5225            &tree.path("a.c"),
5226        ]));
5227        assert_eq!(code, 0);
5228        let text = std::fs::read_to_string(&out).expect("the rule should have been written");
5229        assert!(text.contains("i.h"), "{text}");
5230        assert!(text.contains("m.h"), "{text}");
5231    }
5232
5233    #[test]
5234    fn a_command_line_include_that_is_nowhere_on_the_path_is_an_error_and_not_a_warning() {
5235        // Including the directory of the source file, which is not on the path for these: the
5236        // command line was not written there, so a name in it is relative to where the compiler
5237        // was run rather than to where the source sits.
5238        let tree = TempTree::new(
5239            "preinclude-missing",
5240            &[("sub/a.c", "int main(void) { return 0; }\n"), ("sub/beside.h", "int x;\n")],
5241        );
5242        let code = run(&args(&["-E", "-include", "beside.h", "-o", "-", &tree.path("sub/a.c")]));
5243        assert_eq!(code, 1);
5244    }
5245
5246    #[test]
5247    fn a_command_line_that_links_names_the_executable_and_not_the_object_it_went_through() {
5248        // The object a link goes through is in a temporary directory and is gone before `make`
5249        // reads any of this, so the rule that named it would be a rule for a file that is never
5250        // there. The target and the file are both the `-o`, which is the executable.
5251        let (opts, plan) = compile(&["-MD", "sub/a.c", "-o", "prog"]);
5252        assert_eq!(plan.output.as_deref(), Some("prog"));
5253        assert_eq!(deps::default_target("sub/a.c", deps_target_output(&opts, &plan)), "prog");
5254        assert_eq!(
5255            deps::default_file(&opts.deps, "sub/a.c", plan.output.as_deref()).as_deref(),
5256            Some("prog.d")
5257        );
5258    }
5259
5260    #[test]
5261    fn the_plan_keeps_the_output_name_because_the_rule_is_written_from_it() {
5262        let (_, plan) = compile(&["-MMD", "-c", "sub/a.c", "-o", "obj/x.o"]);
5263        assert_eq!(plan.output.as_deref(), Some("obj/x.o"));
5264        let (_, plan) = compile(&["-MMD", "-c", "sub/a.c"]);
5265        assert_eq!(plan.output, None);
5266    }
5267
5268    #[test]
5269    fn usage_fits_on_a_screen() {
5270        // Not a style preference. A help text that scrolls is one nobody reads, and this is
5271        // the cheapest way to keep it honest as flags accumulate. The number goes up only when
5272        // a family of flags arrives that has nowhere to share a line, which the two pass gates
5273        // were and which the two fuel flags and `-fsafety=` now are, and it goes up by exactly
5274        // the lines that family took. The four it went up by last are the flags a build system
5275        // passes without being asked to: how much to say, what machine to generate for, threads,
5276        // and the questions `configure` asks before it compiles anything. The one it went up by
5277        // last is the second line of `--emit`, whose kinds are a family that has now outgrown
5278        // one line and has nowhere else to go. The two it went up by last are the dependency
5279        // family, which is eight flags that share nothing with anything above them. The one it
5280        // went up by last is the four spellings of position independent code, which every
5281        // configure script writes and which could only have shared the link line, and that line
5282        // is already four characters short of the limit. The two it went up by last are the rest
5283        // of the include family, which is six more flags that change where a header is looked for
5284        // and two that name a header outright. The one it went up by last is the pair that keeps
5285        // the intermediate files and times the steps, which belong next to the two flags above
5286        // them that are also about watching a compilation rather than changing one. The two it
5287        // went up by last are the section flags and the visibility flag, which are what a build
5288        // that cares about the size of what it ships and about which names it exports writes, and
5289        // the second of them was already taken and only missing from here. The one it went up by
5290        // last is the stack protector, which is four spellings of one question and which every
5291        // distribution puts on every command line it issues, so a build that reads this list
5292        // looking for it and does not find it has to go and read the specification instead. The one
5293        // it went up by last is the profiler, which is two spellings of the request and two of
5294        // where the call goes, and which is about watching a program run rather than about what is
5295        // generated, so it shares its subject with nothing above it. The one it went up by last is
5296        // the room a function opens with for something to be written over it later, which takes an
5297        // argument of its own shape and is what a kernel build asks for, so it fits beside the
5298        // profiler and nothing else. The one it went up by last is what overflows rather than being
5299        // undefined, which is three spellings of two questions and which a kernel build and a great
5300        // deal of code written before the standard settled both pass. The one it went up by last is
5301        // the other answer to the first of those questions, which could not share the line because
5302        // what it asks for is the opposite of what the flags on that line ask for. The one it went
5303        // up by last is the split of the line that lists what this compiler does anyway into that
5304        // and what it assumes anyway, which are two different claims that were sharing a line until
5305        // the second of them got a second flag and the line stopped fitting. The one it went up by
5306        // last is the three flags that change the ABI rather than the code, which have to be given
5307        // to every file in a program or none of them and which therefore belong somewhere a person
5308        // reading this list will see them. The one it went up by last is the floating point group,
5309        // which is two lines rather than one because the first of them is a choice this compiler
5310        // records and the rest are claims about what it does anyway, and putting a real setting on
5311        // the same line as three flags that change nothing would be misleading about both. The one
5312        // it went up by last is the flag that says a write has to stay inside the member it names,
5313        // which is a setting rather than a claim and so cannot share the line above it, that being
5314        // the one that picks a tier. The two it went up by last are the prefix mapping family,
5315        // which is four flags whose whole job is to keep a build's output the same from two
5316        // different directories, and which a person chasing a reproducible build comes here
5317        // looking for by name. The one it went up by last is how the debug sections are compressed
5318        // and whether they go in a file of their own, which are two questions about the shape of
5319        // the debug output, where the line above them is about how much of it there is. The one it
5320        // went up by last is the `restrict` contract, which is a setting for the same reason the
5321        // flag that keeps a write inside its member is and which is the check a person who has been
5322        // bitten by a vectorizer comes here looking for. The one it went up by last is link time
5323        // optimization, which is a whole optimization rather than a flag and which says so on its
5324        // own line, because a build that passes it and reads this looking for what it got is
5325        // asking a question no other line here answers. The one it went up by last is the sysroot,
5326        // which is the question somebody asks when a cross build read a file nobody expected, and
5327        // which has no room on the line above it because the answers there are a path each and this
5328        // one is the root all of them are under. The one it went up by last is what is inside that
5329        // root and where each of it came from, which is a question about a whole tree rather than
5330        // about a path and which is long enough on its own that it could not have shared a line with
5331        // anything. The one it went up by last is the profile family, which splits down the middle
5332        // where no other family here does, so the line has to name the half that is taken and the
5333        // half that is refused or it would be read as taking both. The one it went up by last is
5334        // the sanitizers, which are what somebody reaching for a checked build writes first and
5335        // which belong beside the tier that is the nearest thing here to what they asked for. The
5336        // one it went up by last is the digest of that record, which is the same tree as one number
5337        // and could not share the line above it because that line prints a few hundred lines and
5338        // this one prints sixty four characters, and a reader who wants the short answer is looking
5339        // for it by name rather than reading the long one. The one it went up by last is the
5340        // sysroot fetch, which is the only command here that gets something from somewhere else and
5341        // is therefore the one a person wants to have read before they run it rather than after.
5342        // And the flag beside it that forbids every download, which earns its line by being what a
5343        // build in a sealed environment passes and by meaning something even though an ordinary
5344        // compile downloads nothing either way.
5345        assert!(USAGE.lines().count() < 72, "usage text has grown past one screen");
5346    }
5347}