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