1#![doc(html_root_url = "https://docs.rs/rucc-driver/0.10.3")]
30
31pub mod compile;
32pub mod deps;
33pub mod library;
34pub mod link;
35mod map;
36pub mod phase;
37pub mod preprocess;
38pub mod schedule;
39
40use std::fmt::Write as _;
41use std::io::Write as _;
42use std::path::PathBuf;
43
44use rucc_codegen::coverage::{self, Fired};
45use rucc_pp::Dependency;
46use rucc_session::{Dumps, EmitKind, Options, Preinclude, SaveTemps, Session, Std, runtime};
47use rucc_target::Triple;
48
49use crate::link::LinkOptions;
50
51pub use crate::compile::{Artifact, Compiled, Temps, compile, compile_ir};
52pub use crate::phase::{Input, InputKind, Job, LinkJob, Output, Phase, Plan};
53pub use crate::preprocess::{OsFileSystem, Preprocessed, preprocess};
54pub use crate::schedule::Jobs;
55
56pub const VERSION: &str = env!("CARGO_PKG_VERSION");
58
59#[derive(Debug, Clone, PartialEq, Eq)]
61pub enum Action {
62 Help,
64 Version,
66 Print(String),
72 PrintConfig(Box<Options>),
74 PrintPipeline(Box<Options>),
76 PrintPlan {
78 opts: Box<Options>,
80 plan: Box<Plan>,
82 link: Box<LinkOptions>,
84 },
85 Compile {
87 opts: Box<Options>,
89 plan: Box<Plan>,
91 link: Box<LinkOptions>,
93 jobs: Jobs,
95 verbose: bool,
97 },
98}
99
100#[derive(Debug, Clone, PartialEq, Eq)]
102pub struct CliError {
103 pub message: String,
106}
107
108impl std::fmt::Display for CliError {
109 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
110 f.write_str(&self.message)
111 }
112}
113
114impl std::error::Error for CliError {}
115
116fn err(message: impl Into<String>) -> CliError {
117 CliError { message: message.into() }
118}
119
120enum Query {
126 Machine,
128 Version,
130 Multiarch,
132 SearchDirs,
134 FileName(String),
136 ProgName(String),
138 Libgcc,
140}
141
142pub const USAGE: &str = "\
147rucc, an optimizing C compiler
148
149usage: rucc [options] file...
150
151options:
152 -c compile and assemble, do not link
153 -S compile only, emit assembly
154 -E preprocess only
155 -o <file> write output to <file>, or to standard output for -
156 -D <name>[=<value>], -U <name> define a macro, or undefine one after every -D
157 -I <dir> add <dir> to the include search path
158 -iquote -isystem -idirafter <dir> the other chains, -nostdinc drops ours
159 -I-, -iprefix <p>, -iwithprefix[before] <dir> the older spellings of those
160 -include <file>, -imacros <file> read <file> first, the second for its macros only
161 --sysroot=<dir> look for the library's headers under <dir>, -isysroot too
162 -P, -dM with -E: leave out the markers, or dump the macros
163 -M -MM -MD -MMD write a make rule for the source, the last two compile as well
164 -MF <file> -MT <t> -MQ <t> -MP where the rule goes, what it builds, targets with no recipe
165 -std=<dialect> c89 through c23, and the gnu spellings
166 -fgnuc-version=<v> the GCC release to claim, default 7.0.0
167 -x <lang> treat later inputs as <lang>, or none to stop
168 -O<level> optimize: 0, 1, 2, 3, s, z
169 -fsafety=<tier> check memory safety: off, detect, enforce, kernel
170 -f<pass> -fno-<pass> -fdump-ir=<what> -fopt-info[-<kind>][=FILE]
171 -fpass-fuel=<pass>=<n>, -fpass-fuel-global=<n> stop a pass, or all of them, after n
172 -fdisable-<pass>[=<funcs>], -fenable-<pass>[=<funcs>] run a pass on some functions only
173 -g -g0 -gdwarf-5, -fno-omit-frame-pointer, -mno-red-zone debug info, frame pointer, red zone
174 -l<name>, -L <dir>, -B <dir> link a library, where to look for one, where our own tools are
175 -fPIC -fpic -fPIE -fpie, -fno-common, -f[no-]strict-aliasing, -pipe what it does anyway
176 -static -shared -pie -no-pie -nostdlib -nostartfiles -nodefaultlibs -rdynamic -s how to link
177 -Wl,<arg>, -Xlinker <arg>, -fuse-ld=<name> hand an argument to the linker, or pick one
178 -Werror -pedantic -pedantic-errors -w how much to say, and whether it is fatal
179 -m64 -march= -mtune= -mcpu= -mabi= -mcmodel= what machine to generate for
180 -pthread build for more than one thread, and link the library for it
181 -dumpmachine -dumpversion -print-multiarch -print-search-dirs what this compiler is
182 -print-file-name=<name> -print-prog-name=<name> where a file or a program is
183 -j[n] compile n translation units at once, default all
184 -v, -### print each phase as it runs, or without running any
185 -save-temps[=cwd|obj], -time keep the .i and the .s, say how long each step took
186 --target=<triple> generate code for <triple>
187 --emit=<kind> exe, obj, asm, preprocessed, tast, ir, mir-final,
188 safety-summary, type-granules
189 --print-config, --print-pipeline print the configuration or the pipeline, and exit
190 --version print the version and exit
191 -h, --help print this message and exit
192
193See spec/04-driver-and-cli.md for the full flag reference.
194";
195
196fn joined_or_next(
200 arg: &str,
201 at: usize,
202 args: &[String],
203 i: &mut usize,
204) -> Result<String, CliError> {
205 if arg.len() > at {
206 return Ok(arg[at..].to_owned());
207 }
208 let next = args.get(*i).ok_or_else(|| err(format!("{arg} requires an argument")))?;
209 *i += 1;
210 Ok(next.clone())
211}
212
213pub fn parse_args(args: &[String]) -> Result<Action, CliError> {
220 let host = Triple::host()
221 .ok_or_else(|| err("this host is not a supported target and no --target was given"))?;
222 let mut opts = Options::new(host);
223 let mut inputs: Vec<Input> = Vec::new();
224 let mut print_config = false;
225 let mut print_pipeline = false;
226 let mut print_plan = false;
227 let mut verbose = false;
228 let mut jobs = Jobs::default();
229 let mut nostdinc = false;
230 let mut sysroot: Option<PathBuf> = None;
231 let mut output = None;
232 let mut link = LinkOptions::default();
233 let mut query: Option<Query> = None;
234 let mut threads = false;
235 let mut forced: Option<InputKind> = None;
238 let mut iprefix = String::new();
245
246 let mut i = 0;
247 while i < args.len() {
248 let arg = args[i].as_str();
249 i += 1;
250 match arg {
251 "-h" | "--help" => return Ok(Action::Help),
252 "--version" => return Ok(Action::Version),
253 "--print-config" => print_config = true,
254 "--print-pipeline" => print_pipeline = true,
255 "-###" => print_plan = true,
256 "-v" => verbose = true,
257 "-save-temps" => opts.save_temps = SaveTemps::Object,
261 _ if arg.starts_with("-save-temps=") => {
262 opts.save_temps = arg["-save-temps=".len()..].parse().map_err(err)?;
263 }
264 "-time" => opts.time = true,
267 "-c" => opts.emit = EmitKind::Object,
268 "-S" => opts.emit = EmitKind::Asm,
269 "-E" => opts.emit = EmitKind::Preprocessed,
270 "-g" => opts.debug_info = true,
271 "-g0" => opts.debug_info = false,
276 "-g1" | "-g2" | "-g3" | "-ggdb" | "-ggdb1" | "-ggdb2" | "-ggdb3" => {
277 opts.debug_info = true;
278 }
279 "-gdwarf" | "-gdwarf-5" => opts.debug_info = true,
282 _ if arg.starts_with("-gdwarf-") => {
283 return Err(err(format!(
284 "{arg}: this compiler writes DWARF 5 and no other version, see \
285 spec/11-debug-info.md"
286 )));
287 }
288 "-Werror" => opts.warnings_are_errors = true,
289 "-w" => opts.warnings = false,
292 "-pedantic-errors" => {
293 opts.pedantic = true;
294 opts.warnings_are_errors = true;
295 }
296 "-P" => opts.line_markers = false,
297 "-M" => {
304 opts.deps.emit = true;
305 opts.deps.instead_of_compiling = true;
306 }
307 "-MM" => {
308 opts.deps.emit = true;
309 opts.deps.instead_of_compiling = true;
310 opts.deps.system_headers = false;
311 }
312 "-MD" => opts.deps.emit = true,
313 "-MMD" => {
314 opts.deps.emit = true;
315 opts.deps.system_headers = false;
316 }
317 "-MP" => opts.deps.phony = true,
318 "-MF" | "-MT" | "-MQ" => {
321 let value =
322 args.get(i).ok_or_else(|| err(format!("{arg} requires an argument")))?;
323 i += 1;
324 match arg {
325 "-MF" => opts.deps.file = Some(value.clone()),
326 "-MT" => opts.deps.targets.push(value.clone()),
330 _ => opts.deps.targets.push(deps::escaped(value)),
331 }
332 }
333 "-dumpmachine" => query = Some(Query::Machine),
337 "-dumpversion" | "-dumpfullversion" => query = Some(Query::Version),
338 "-print-multiarch" => query = Some(Query::Multiarch),
339 "-print-search-dirs" => query = Some(Query::SearchDirs),
340 "-print-libgcc-file-name" => query = Some(Query::Libgcc),
341 _ if arg.starts_with("-print-file-name=") => {
342 query = Some(Query::FileName(arg["-print-file-name=".len()..].to_owned()));
343 }
344 _ if arg.starts_with("-print-prog-name=") => {
345 query = Some(Query::ProgName(arg["-print-prog-name=".len()..].to_owned()));
346 }
347 "-pthread" | "-pthreads" => {
352 opts.defines.push("_REENTRANT".to_owned());
353 threads = true;
354 }
355 "-ansi" => {
356 opts.std = Std::C89;
357 opts.gnu_extensions = false;
358 }
359 "-pedantic" | "-Wpedantic" => opts.pedantic = true,
362 "-fpermissive" => opts.permissive = true,
365 "-fno-permissive" => opts.permissive = false,
366 "-ffreestanding" => opts.hosted = false,
367 "-fhosted" => opts.hosted = true,
368 "-fno-builtin" => opts.builtins = false,
369 "-fbuiltin" => opts.builtins = true,
370 "-fgnu89-inline" => opts.gnu89_inline = true,
374 "-fno-gnu89-inline" => opts.gnu89_inline = false,
375 "-fno-omit-frame-pointer" => opts.frame_pointer = true,
378 "-fomit-frame-pointer" => opts.frame_pointer = false,
379 "-mno-red-zone" => opts.red_zone = false,
380 "-mred-zone" => opts.red_zone = true,
381 "-nostdinc" => nostdinc = true,
385 "-o" => {
386 output = Some(args.get(i).ok_or_else(|| err("-o requires an argument"))?.clone());
387 i += 1;
388 }
389 "-isysroot" => {
396 let dir = args.get(i).ok_or_else(|| err("-isysroot requires an argument"))?;
397 i += 1;
398 sysroot = Some(PathBuf::from(dir));
399 }
400 "-iquote" | "-isystem" | "-idirafter" => {
401 let dir = args.get(i).ok_or_else(|| err(format!("{arg} requires an argument")))?;
402 i += 1;
403 match arg {
404 "-iquote" => opts.search.push_quote(dir.clone()),
405 "-isystem" => opts.search.push_system(dir.clone()),
406 _ => opts.search.push_after(dir.clone()),
407 }
408 }
409 "-iprefix" => {
410 iprefix = args.get(i).ok_or_else(|| err("-iprefix requires an argument"))?.clone();
411 i += 1;
412 }
413 "-iwithprefix" | "-iwithprefixbefore" => {
419 let dir = args.get(i).ok_or_else(|| err(format!("{arg} requires an argument")))?;
420 i += 1;
421 let dir = format!("{iprefix}{dir}");
422 if arg == "-iwithprefix" {
423 opts.search.push_system(dir);
424 } else {
425 opts.search.push_bracket(dir);
426 }
427 }
428 "-include" | "-imacros" => {
429 let name = args.get(i).ok_or_else(|| err(format!("{arg} requires an argument")))?;
430 i += 1;
431 opts.preincludes
432 .push(Preinclude { name: name.clone(), macros_only: arg == "-imacros" });
433 }
434 "-I-" => opts.search.split_quote_chain(),
439 "-x" => {
440 let lang = args.get(i).ok_or_else(|| err("-x requires an argument"))?;
441 i += 1;
442 forced = if lang == "none" {
443 None
444 } else {
445 Some(InputKind::from_x_arg(lang).map_err(|e| err(format!("{e}")))?)
446 };
447 }
448 _ if arg.starts_with("-D") => {
456 let value = joined_or_next(arg, 2, args, &mut i)?;
457 opts.defines.push(value);
458 }
459 _ if arg.starts_with("-U") => {
460 let value = joined_or_next(arg, 2, args, &mut i)?;
461 opts.undefines.push(value);
462 }
463 _ if arg.starts_with("-I") => {
464 let dir = joined_or_next(arg, 2, args, &mut i)?;
465 opts.search.push_bracket(dir);
466 }
467 _ if arg.starts_with("-std=") => {
468 let name = &arg["-std=".len()..];
469 let (std, gnu) = Std::from_flag(name)
470 .ok_or_else(|| err(format!("unknown dialect `{name}`, see --help")))?;
471 opts.std = std;
472 opts.gnu_extensions = gnu;
473 }
474 _ if Dumps::is_family(arg) => {
483 opts.dumps.add(&arg[2..]);
484 }
485 _ if arg.starts_with("-fno-builtin-") => {
490 opts.no_builtin.push(arg["-fno-builtin-".len()..].to_owned());
491 }
492 _ if arg.starts_with("-fgnuc-version=") => {
493 let v = &arg["-fgnuc-version=".len()..];
494 opts.gnuc = v.parse().map_err(err)?;
495 }
496 "-fnested-functions" => {
501 return Err(err(
502 "nested functions are not supported: a call to one goes through a trampoline \
503 written on the stack, which no target that enforces an unexecutable stack \
504 allows",
505 ));
506 }
507 "-fno-nested-functions" => {}
508 "-fPIC" | "-fpic" | "-fPIE" | "-fpie" => {}
519 "-fno-pic" | "-fno-pie" => {
526 return Err(err(
527 "position dependent code is not supported: an address that may be in another \
528 object is loaded out of the global offset table, and nothing here emits the \
529 absolute form this asks for. Use -no-pie if what you meant was how to link",
530 ));
531 }
532 "-fno-common" => {}
538 "-fcommon" => {
542 return Err(err(
543 "a tentative definition is written into .bss as its own symbol here, and \
544 nothing emits the common symbol this asks the linker to merge. Give the \
545 variable a definition in one file and declare it extern in the others",
546 ));
547 }
548 "-fstrict-aliasing" | "-fno-strict-aliasing" => {}
562 "-pipe" => {}
565 "-fdiagnostics-color" | "-fno-diagnostics-color" => {}
572 _ if arg.starts_with("-fdiagnostics-color=") => {}
573 "-static" => link.is_static = true,
577 "-shared" => link.shared = true,
578 "-pie" => link.pie = Some(true),
579 "-no-pie" | "-nopie" => link.pie = Some(false),
580 "-nostdlib" => link.no_stdlib = true,
581 "-nostartfiles" => link.no_startfiles = true,
582 "-nodefaultlibs" => link.no_defaultlibs = true,
583 "-fno-builtins-lib" => link.no_builtins_lib = true,
584 "-fbuiltins-lib" => link.no_builtins_lib = false,
585 "-rdynamic" | "-export-dynamic" => link.export_dynamic = true,
586 "-s" => link.strip = true,
587 "-Xlinker" => {
588 let next = args.get(i).ok_or_else(|| err("-Xlinker requires an argument"))?;
589 i += 1;
590 link.passthrough.push(next.clone());
591 }
592 _ if arg.starts_with("-Wl,") => {
593 link.passthrough.extend(arg["-Wl,".len()..].split(',').map(str::to_owned));
596 }
597 _ if arg.starts_with("-fuse-ld=") => {
598 link.use_ld = Some(arg["-fuse-ld=".len()..].to_owned());
599 }
600 _ if arg.starts_with("-l") && arg.len() > 2 => {
601 inputs.push(Input::library(&arg[2..]));
602 }
603 "-l" => {
604 let next = args.get(i).ok_or_else(|| err("-l requires an argument"))?;
605 i += 1;
606 inputs.push(Input::library(next));
607 }
608 _ if arg.starts_with("-L") => {
609 link.search.push(PathBuf::from(joined_or_next(arg, 2, args, &mut i)?));
610 }
611 _ if arg.starts_with("-B") => {
612 link.prefixes.push(PathBuf::from(joined_or_next(arg, 2, args, &mut i)?));
613 }
614 _ if arg.starts_with("-j") => {
615 jobs = Jobs::parse(&arg[2..]).map_err(err)?;
616 }
617 _ if arg.starts_with("--sysroot=") => {
618 sysroot = Some(PathBuf::from(&arg["--sysroot=".len()..]));
619 }
620 _ if arg.starts_with("--target=") => {
621 let t = &arg["--target=".len()..];
622 opts.target = t.parse().map_err(|e| err(format!("{e}")))?;
623 }
624 _ if arg.starts_with("--emit=") => {
625 let k = &arg["--emit=".len()..];
626 opts.emit = k
627 .parse()
628 .map_err(|()| err(format!("unknown --emit kind `{k}`, see --help")))?;
629 }
630 "-O" | "-Og" => opts.opt_level = rucc_session::OptLevel::O1,
636 "-Ofast" => {
642 return Err(err(
643 "-Ofast is -O3 with fast math, and fast math is not implemented, see \
644 spec/04-driver-and-cli.md section 4.6",
645 ));
646 }
647 _ if arg.starts_with("-O") => {
648 opts.opt_level = arg[2..]
649 .parse()
650 .map_err(|()| err(format!("unknown optimization level `{arg}`")))?;
651 }
652 _ if arg.starts_with("-fvisibility=") => {
656 let seen = &arg["-fvisibility=".len()..];
657 opts.visibility = seen.parse().map_err(|()| {
658 err(format!(
659 "`{seen}` is not a visibility, which is default, hidden, internal or \
660 protected"
661 ))
662 })?;
663 }
664 _ if arg.starts_with("-fsafety=") => {
669 let tier = &arg["-fsafety=".len()..];
670 opts.safety = tier.parse().map_err(|()| {
671 err(format!(
672 "`{tier}` is not a safety tier, which is off, detect, enforce or kernel"
673 ))
674 })?;
675 }
676 _ if arg.starts_with("-fpass-fuel=") => {
680 let (name, count) = arg["-fpass-fuel=".len()..]
681 .split_once('=')
682 .ok_or_else(|| err("-fpass-fuel= is spelled <pass>=<count>"))?;
683 if rucc_opt::pass::find(name).is_none() {
684 return Err(err(format!(
685 "`{name}` is not a pass this compiler has, see --print-pipeline"
686 )));
687 }
688 let count: u32 = count
689 .parse()
690 .map_err(|_| err(format!("`{count}` is not a number of transformations")))?;
691 opts.pass_fuel.push((name.to_owned(), count));
692 }
693 _ if arg.starts_with("-fpass-fuel-global=") => {
694 let count = &arg["-fpass-fuel-global=".len()..];
695 let count: u32 = count
696 .parse()
697 .map_err(|_| err(format!("`{count}` is not a number of transformations")))?;
698 opts.pass_fuel_global = Some(count);
699 }
700 _ if arg == "-fopt-info"
705 || arg.starts_with("-fopt-info=")
706 || arg.starts_with("-fopt-info-") =>
707 {
708 let rest = &arg["-fopt-info".len()..];
709 let (kinds, file) = match rest.split_once('=') {
710 Some((kinds, file)) => (kinds, Some(file)),
711 None => (rest, None),
712 };
713 let kinds = kinds.strip_prefix('-').unwrap_or(kinds);
714 rucc_opt::Wants::none().add(kinds).map_err(err)?;
715 opts.opt_info.push(kinds.to_owned());
716 if let Some(file) = file {
717 if file.is_empty() {
718 return Err(err("-fopt-info= was given no file to write to"));
719 }
720 opts.opt_info_file = Some(file.to_owned());
721 }
722 }
723 _ if arg.starts_with("-fdump-ir=") => {
724 let spec = &arg["-fdump-ir=".len()..];
727 rucc_opt::Dumps::default().add(spec).map_err(err)?;
728 opts.dump_ir.push(spec.to_owned());
729 }
730 _ if arg.starts_with("-fdisable-") || arg.starts_with("-fenable-") => {
736 let on = arg.starts_with("-fenable-");
737 let spec = &arg[if on { "-fenable-".len() } else { "-fdisable-".len() }..];
738 rucc_opt::Gates::default().add(on, spec).map_err(err)?;
739 opts.pass_gates.push((on, spec.to_owned()));
740 }
741 _ if arg.strip_prefix("-fno-").is_some_and(|n| rucc_opt::pass::find(n).is_some()) => {
742 opts.passes.push((arg["-fno-".len()..].to_owned(), false));
743 }
744 _ if arg.strip_prefix("-f").is_some_and(|n| rucc_opt::pass::find(n).is_some()) => {
745 opts.passes.push((arg["-f".len()..].to_owned(), true));
746 }
747 "-Zverify-each" => opts.verify_each = true,
753 _ if arg.starts_with("-Zrule-coverage=") => {
754 let file = &arg["-Zrule-coverage=".len()..];
755 if file.is_empty() {
756 return Err(err("-Zrule-coverage= needs a file to write to"));
757 }
758 opts.rule_coverage = Some(file.to_owned());
759 }
760 _ if arg.starts_with("-Z") => {
761 return Err(err(format!(
762 "`{arg}` is not an unstable option this compiler has, see \
763 spec/04-driver-and-cli.md section 4.11 for the ones it does"
764 )));
765 }
766 "-m64" | "-m32" | "-mx32" => {
771 let want: u32 = match arg {
772 "-m64" => 64,
773 _ => 32,
774 };
775 let have = rucc_target::TargetInfo::new(opts.target).pointer_width;
776 if have != want {
777 return Err(err(format!(
778 "{arg} asks for a {want} bit target and {} is {have} bit, use \
779 --target= to name the one you mean",
780 opts.target
781 )));
782 }
783 }
784 _ if arg.starts_with("-march=")
790 || arg.starts_with("-mtune=")
791 || arg.starts_with("-mcpu=") => {}
792 _ if arg.starts_with("-mabi=") => {
795 let want = &arg["-mabi=".len()..];
796 let have = match opts.target.arch {
797 rucc_target::Arch::X86_64 => "sysv",
798 rucc_target::Arch::Aarch64 => "lp64",
799 rucc_target::Arch::Riscv64 => "lp64d",
800 };
801 if want != have {
802 return Err(err(format!(
803 "{arg}: {} uses the {have} convention and this compiler has no other",
804 opts.target
805 )));
806 }
807 }
808 "-mcmodel=small" => {}
812 _ if arg.starts_with("-mcmodel=") => {
813 return Err(err(format!(
814 "{arg}: this compiler emits the small code model and no other, see \
815 spec/12-targets.md"
816 )));
817 }
818 _ if arg.starts_with("-specs=") => {
822 return Err(err(
823 "-specs= is not supported: the parts of it builds rely on are -B, -L, \
824 -nostdlib, -nostartfiles and -Wl,, see spec/04-driver-and-cli.md \
825 section 4.4",
826 ));
827 }
828 _ if arg.starts_with("-Wa,") || arg.starts_with("-Wp,") => {
834 return Err(err(format!(
835 "`{arg}` is an argument for a separate assembler or preprocessor, and both \
836 are inside this compiler rather than programs it runs"
837 )));
838 }
839 "-Xassembler" | "-Xpreprocessor" => {
840 return Err(err(format!(
841 "{arg} hands an argument to a separate assembler or preprocessor, and both \
842 are inside this compiler rather than programs it runs"
843 )));
844 }
845 _ if arg.starts_with("-W") => {}
852 "-fno-ident"
858 | "-fident"
859 | "-funit-at-a-time"
860 | "-fno-unit-at-a-time"
861 | "-shared-libgcc"
862 | "-static-libgcc" => {}
863 _ if arg.starts_with('-') && arg.len() > 1 => {
864 return Err(err(format!("unknown option `{arg}`")));
869 }
870 _ => inputs.push(Input { path: arg.to_owned(), forced, library: false }),
871 }
872 }
873
874 link.sysroot = sysroot.clone();
881 if threads {
886 inputs.push(Input::library("pthread"));
887 }
888 if let Some(query) = query {
889 return Ok(Action::Print(answer(&query, &opts, &link)));
890 }
891 if opts.deps.instead_of_compiling {
897 opts.emit = EmitKind::Preprocessed;
898 }
899 if !nostdinc {
900 opts.search.push_system(runtime::DIR);
901 for dir in library::system_dirs(opts.target, sysroot.as_deref()) {
905 opts.search.push_system(dir);
906 }
907 }
908 opts.search.remove_duplicates();
912
913 if print_config {
916 return Ok(Action::PrintConfig(Box::new(opts)));
917 }
918 if print_pipeline {
919 return Ok(Action::PrintPipeline(Box::new(opts)));
920 }
921 let plan = Plan::new(&opts, &inputs, output.as_deref()).map_err(|e| err(e.message))?;
922 if print_plan {
923 return Ok(Action::PrintPlan {
924 opts: Box::new(opts),
925 plan: Box::new(plan),
926 link: Box::new(link),
927 });
928 }
929 Ok(Action::Compile {
930 opts: Box::new(opts),
931 plan: Box::new(plan),
932 link: Box::new(link),
933 jobs,
934 verbose,
935 })
936}
937
938fn answer(query: &Query, opts: &Options, link: &LinkOptions) -> String {
944 let found = |name: &str| {
945 link::find_in_search(link, opts.target, name)
946 .map_or_else(|| name.to_owned(), |path| path.display().to_string())
947 };
948 match query {
949 Query::Machine => opts.target.to_string(),
950 Query::Version => VERSION.to_owned(),
951 Query::Multiarch => link::multiarch(opts.target),
952 Query::SearchDirs => {
957 let here = std::env::current_exe()
958 .ok()
959 .and_then(|p| p.parent().map(std::path::Path::to_path_buf))
960 .unwrap_or_default();
961 let list = |dirs: &[PathBuf]| {
962 dirs.iter().map(|d| d.display().to_string()).collect::<Vec<_>>().join(":")
963 };
964 let libraries = link::search_dirs(link, opts.target);
965 format!(
966 "install: {}\nprograms: ={}\nlibraries: ={}",
967 here.display(),
968 list(&link.prefixes),
969 list(&libraries)
970 )
971 }
972 Query::FileName(name) => found(name),
973 Query::Libgcc => found("libgcc.a"),
977 Query::ProgName(name) => link
981 .prefixes
982 .iter()
983 .map(|dir| dir.join(name))
984 .find(|path| path.is_file())
985 .map_or_else(|| name.clone(), |path| path.display().to_string()),
986 }
987}
988
989#[must_use]
995pub fn print_pipeline(opts: &Options) -> String {
996 let mut settings = rucc_opt::Options::for_level(opts.opt_level);
997 settings.toggles.clone_from(&opts.passes);
998 settings.global_fuel = opts.pass_fuel_global;
999 for (on, spec) in &opts.pass_gates {
1000 let _ = settings.gates.add(*on, spec);
1003 }
1004 rucc_opt::pipeline::print(&settings)
1005}
1006
1007#[must_use]
1012pub fn print_config(opts: &Options) -> String {
1013 let sess = Session::new(opts.clone());
1014 let t = &sess.target;
1015 let mut out = String::new();
1016 let _ = writeln!(out, "version: {VERSION}");
1017 let _ = writeln!(out, "target: {}", opts.target);
1021 let _ = writeln!(out, "arch: {}", opts.target.arch.as_str());
1022 let _ = writeln!(out, "os: {}", opts.target.os.as_str());
1023 let _ = writeln!(out, "env: {}", opts.target.env.as_str());
1024 let _ = writeln!(out, "object-format: {}", t.object_format.as_str());
1025 let _ = writeln!(out, "pointer-width: {}", t.pointer_width);
1026 let _ = writeln!(out, "long-width: {}", t.long_width);
1027 let _ = writeln!(out, "long-double-width: {}", t.long_double_width);
1028 let _ = writeln!(out, "endian: {}", if t.little_endian { "little" } else { "big" });
1029 let _ = writeln!(out, "char-signed: {}", t.char_is_signed);
1030 let _ = writeln!(out, "va-list: {}", t.va_list.map_or("none", |list| list.as_str()));
1031 let regs: Vec<String> = t
1034 .regs
1035 .classes()
1036 .map(|(class, info)| format!("{} {}", info.name, t.regs.len(class)))
1037 .collect();
1038 let _ = writeln!(
1039 out,
1040 "registers: {}",
1041 if regs.is_empty() { "none".to_string() } else { regs.join(", ") }
1042 );
1043 let _ = writeln!(out, "opt-level: {}", sess.opts.opt_level);
1044 let _ = writeln!(out, "safety: {}", sess.opts.safety);
1045 let _ = writeln!(out, "emit: {}", sess.opts.emit.as_str());
1046 let _ = writeln!(out, "debug-info: {}", sess.opts.debug_info);
1047 let _ = writeln!(out, "frame-pointer: {}", sess.opts.frame_pointer);
1048 let _ = writeln!(out, "red-zone: {}", sess.opts.red_zone);
1049 for dir in sess.opts.search.dirs() {
1052 let system = if dir.is_system { " (system)" } else { "" };
1053 let _ = writeln!(out, "include: {}{system}", dir.path.display());
1054 }
1055 out
1056}
1057
1058fn deps_target_output<'a>(opts: &Options, plan: &'a Plan) -> Option<&'a str> {
1066 if opts.emit == EmitKind::Preprocessed { None } else { plan.output.as_deref() }
1067}
1068
1069fn write_named(path: &str, bytes: &[u8]) -> Result<(), String> {
1072 if path == "-" {
1073 return write_out(&Output::Stdout, bytes);
1074 }
1075 write_out(&Output::File(path.to_owned()), bytes)
1076}
1077
1078fn write_deps(
1084 opts: &Options,
1085 plan: &Plan,
1086 job: &Job,
1087 found: &[Dependency],
1088 stderr: &mut impl std::io::Write,
1089) -> bool {
1090 let targets = if opts.deps.targets.is_empty() {
1091 vec![deps::default_target(&job.input, deps_target_output(opts, plan))]
1092 } else {
1093 opts.deps.targets.clone()
1094 };
1095 let rule = deps::rule(&opts.deps, &targets, &job.input, found);
1096 let wrote = match deps::default_file(&opts.deps, &job.input, plan.output.as_deref()) {
1099 Some(path) => write_named(&path, rule.as_bytes()).and_then(|()| {
1103 if opts.deps.instead_of_compiling { write_out(&job.output, b"") } else { Ok(()) }
1104 }),
1105 None => write_out(&job.output, rule.as_bytes()),
1106 };
1107 if let Err(e) = wrote {
1108 let _ = writeln!(stderr, "rucc: error: {e}");
1109 return false;
1110 }
1111 true
1112}
1113
1114fn preprocess_all(opts: &Options, plan: &Plan) -> i32 {
1120 let fs = OsFileSystem::new();
1121 let mut stderr = std::io::stderr().lock();
1122 let mut failed = false;
1123 for job in &plan.jobs {
1124 if !job.phases.first().is_some_and(|p| *p == Phase::Preprocess) {
1125 continue;
1128 }
1129 let started = std::time::Instant::now();
1130 let result = preprocess(opts, &job.input, &fs);
1131 if opts.time {
1132 say_time(&job.input, started.elapsed(), &mut stderr);
1133 }
1134 for message in &result.messages {
1135 let _ = writeln!(stderr, "{message}");
1136 }
1137 if result.failed() {
1138 failed = true;
1139 continue;
1140 }
1141 if opts.deps.emit {
1142 failed |= !write_deps(opts, plan, job, &result.deps, &mut stderr);
1143 if opts.deps.instead_of_compiling {
1146 continue;
1147 }
1148 }
1149 if let Err(e) = write_out(&job.output, result.text.as_bytes()) {
1150 let _ = writeln!(stderr, "rucc: error: {e}");
1151 failed = true;
1152 }
1153 }
1154 i32::from(failed)
1155}
1156
1157fn compile_all(opts: &Options, plan: &Plan) -> i32 {
1163 let fs = OsFileSystem::new();
1164 let mut stderr = std::io::stderr().lock();
1165 let mut failed = false;
1166 let (mut remarks, ok) = Remarks::new(opts.opt_info_file.as_ref(), &mut stderr);
1167 failed |= !ok;
1168 let mut fired = Fired::new();
1169 for job in &plan.jobs {
1170 if !job.phases.contains(&Phase::Compile) {
1171 continue;
1172 }
1173 let started = std::time::Instant::now();
1177 let result = if job.kind == InputKind::Ir {
1178 compile_ir(opts, &job.input, &fs)
1179 } else {
1180 compile(opts, &job.input, &fs)
1181 };
1182 if opts.time {
1183 say_time(&job.input, started.elapsed(), &mut stderr);
1184 }
1185 fired.merge(&result.fired);
1186 failed |= !write_dumps(&job.input, &result.dumps, &mut stderr);
1187 failed |= !remarks.write(&result.remarks, &mut stderr);
1188 for message in &result.messages {
1189 let _ = writeln!(stderr, "{message}");
1190 }
1191 failed |= !write_temps(job, &result.temps, &mut stderr);
1194 if result.failed() {
1195 failed = true;
1196 continue;
1197 }
1198 if opts.deps.emit {
1203 failed |= !write_deps(opts, plan, job, &result.deps, &mut stderr);
1204 }
1205 if let Err(e) = write_out(&job.output, result.artifact.bytes()) {
1206 let _ = writeln!(stderr, "rucc: error: {e}");
1207 failed = true;
1208 }
1209 }
1210 failed |= !write_coverage(opts, &fired, &mut stderr);
1211 i32::from(failed)
1212}
1213
1214struct Scratch {
1221 dir: PathBuf,
1223}
1224
1225impl Scratch {
1226 fn new() -> Result<Scratch, String> {
1232 let dir = std::env::temp_dir().join(format!("rucc-{}", std::process::id()));
1233 std::fs::create_dir_all(&dir).map_err(|e| format!("{}: {e}", dir.display()))?;
1234 Ok(Scratch { dir })
1235 }
1236}
1237
1238impl Drop for Scratch {
1239 fn drop(&mut self) {
1240 let _ = std::fs::remove_dir_all(&self.dir);
1241 }
1242}
1243
1244fn link_line(opts: &Options, link: &LinkOptions, job: &LinkJob) -> Result<String, link::Error> {
1251 let linker = link::find(opts.target, link)?;
1252 let args = link::line(opts.target, link, &job.inputs, &job.output)?;
1253 Ok(link::render(&linker, &args))
1254}
1255
1256fn link_all(opts: &Options, plan: &Plan, link: &LinkOptions, verbose: bool) -> i32 {
1263 let Some(job) = &plan.link else {
1264 let mut stderr = std::io::stderr().lock();
1267 let _ = writeln!(stderr, "rucc: error: there is nothing to link");
1268 return 1;
1269 };
1270 let linker = match link::find(opts.target, link) {
1273 Ok(linker) => linker,
1274 Err(why) => return complain(why),
1275 };
1276
1277 let scratch = match Scratch::new() {
1278 Ok(scratch) => scratch,
1279 Err(why) => return complain(format!("could not make a place for the object files: {why}")),
1280 };
1281
1282 let fs = OsFileSystem::new();
1283 let mut failed = false;
1284 let mut produced: Vec<String> = Vec::with_capacity(plan.jobs.len());
1287 let mut fired = Fired::new();
1288 {
1289 let mut stderr = std::io::stderr().lock();
1290 let (mut remarks, ok) = Remarks::new(opts.opt_info_file.as_ref(), &mut stderr);
1291 failed |= !ok;
1292 for (at, job) in plan.jobs.iter().enumerate() {
1293 let out = match &job.output {
1294 Output::Temporary(hint) => {
1295 scratch.dir.join(format!("{at}-{hint}")).display().to_string()
1298 }
1299 Output::File(path) => path.clone(),
1300 Output::Stdout => continue,
1303 };
1304 produced.push(out.clone());
1305 if !job.phases.contains(&Phase::Compile) {
1306 continue;
1307 }
1308 let started = std::time::Instant::now();
1309 let result = if job.kind == InputKind::Ir {
1310 compile_ir(opts, &job.input, &fs)
1311 } else {
1312 compile(opts, &job.input, &fs)
1313 };
1314 if opts.time {
1315 say_time(&job.input, started.elapsed(), &mut stderr);
1316 }
1317 fired.merge(&result.fired);
1318 failed |= !write_dumps(&job.input, &result.dumps, &mut stderr);
1319 failed |= !remarks.write(&result.remarks, &mut stderr);
1320 for message in &result.messages {
1321 let _ = writeln!(stderr, "{message}");
1322 }
1323 failed |= !write_temps(job, &result.temps, &mut stderr);
1324 if result.failed() {
1325 failed = true;
1326 continue;
1327 }
1328 if opts.deps.emit {
1333 failed |= !write_deps(opts, plan, job, &result.deps, &mut stderr);
1334 }
1335 if !matches!(result.artifact, Artifact::Object(_)) {
1336 let _ = writeln!(
1341 stderr,
1342 "rucc: internal error: {}: no object file was produced for the link",
1343 job.input
1344 );
1345 failed = true;
1346 continue;
1347 }
1348 if let Err(e) = std::fs::write(&out, result.artifact.bytes()) {
1349 let _ = writeln!(stderr, "rucc: error: {out}: {e}");
1350 failed = true;
1351 }
1352 }
1353 failed |= !write_coverage(opts, &fired, &mut stderr);
1354 }
1355 if failed {
1356 return 1;
1360 }
1361
1362 let mut outputs = produced.into_iter();
1366 let mut items = Vec::with_capacity(job.inputs.len());
1367 for item in &job.inputs {
1368 match item {
1369 link::Item::Library(name) => items.push(link::Item::Library(name.clone())),
1370 link::Item::File(_) => match outputs.next() {
1371 Some(path) => items.push(link::Item::File(path)),
1372 None => return complain("the plan asks the linker for a file nothing produced"),
1373 },
1374 }
1375 }
1376
1377 let args = match link::line(opts.target, link, &items, &job.output) {
1378 Ok(args) => args,
1379 Err(why) => return complain(why),
1380 };
1381 if verbose {
1382 let mut stderr = std::io::stderr().lock();
1383 let _ = writeln!(stderr, "{}", link::render(&linker, &args));
1384 }
1385 let started = std::time::Instant::now();
1386 let ran = link::run(&linker, &args);
1387 if opts.time {
1388 let mut stderr = std::io::stderr().lock();
1391 say_time(&linker.name, started.elapsed(), &mut stderr);
1392 }
1393 match ran {
1394 Ok(()) => 0,
1395 Err(link::Error::Refused { .. }) => 1,
1398 Err(why) => complain(why),
1399 }
1400}
1401
1402fn complain(why: impl std::fmt::Display) -> i32 {
1404 let mut stderr = std::io::stderr().lock();
1405 let _ = writeln!(stderr, "rucc: error: {why}");
1406 1
1407}
1408
1409fn write_coverage(opts: &Options, fired: &Fired, stderr: &mut impl std::io::Write) -> bool {
1418 let Some(path) = &opts.rule_coverage else { return true };
1419 let Some(table) = coverage::table(opts.target.arch) else {
1420 let _ = writeln!(
1421 stderr,
1422 "rucc: error: there are no lowering rules for {} yet, so there is no coverage of them \
1423 to report",
1424 opts.target
1425 );
1426 return false;
1427 };
1428 match std::fs::write(path, fired.listing(table)) {
1429 Ok(()) => true,
1430 Err(e) => {
1431 let _ = writeln!(stderr, "rucc: error: {path}: {e}");
1432 false
1433 }
1434 }
1435}
1436
1437struct Remarks {
1444 file: Option<String>,
1446 started: bool,
1449}
1450
1451impl Remarks {
1452 fn new(file: Option<&String>, stderr: &mut impl std::io::Write) -> (Self, bool) {
1458 let mut ok = true;
1459 if let Some(path) = file {
1460 if let Err(e) = std::fs::write(path, "") {
1461 let _ = writeln!(stderr, "rucc: error: {path}: {e}");
1462 ok = false;
1463 }
1464 }
1465 (Self { file: file.cloned(), started: false }, ok)
1466 }
1467
1468 fn write(&mut self, text: &str, stderr: &mut impl std::io::Write) -> bool {
1474 if text.is_empty() {
1475 return true;
1476 }
1477 let Some(path) = &self.file else {
1478 let _ = write!(stderr, "{text}");
1479 return true;
1480 };
1481 let opened = std::fs::OpenOptions::new()
1482 .write(true)
1483 .append(self.started)
1484 .truncate(!self.started)
1485 .create(true)
1486 .open(path);
1487 self.started = true;
1488 let result =
1489 opened.and_then(|mut file| std::io::Write::write_all(&mut file, text.as_bytes()));
1490 if let Err(e) = result {
1491 let _ = writeln!(stderr, "rucc: error: {path}: {e}");
1492 return false;
1493 }
1494 true
1495 }
1496}
1497
1498fn write_dumps(input: &str, dumps: &[rucc_opt::Dump], stderr: &mut impl std::io::Write) -> bool {
1509 let stem = std::path::Path::new(input)
1510 .file_name()
1511 .map_or_else(|| input.to_owned(), |name| name.to_string_lossy().into_owned());
1512 let mut ok = true;
1513 for dump in dumps {
1514 let path = format!("{stem}.{}.ir", dump.name);
1515 if let Err(e) = std::fs::write(&path, &dump.text) {
1516 let _ = writeln!(stderr, "rucc: error: {path}: {e}");
1517 ok = false;
1518 }
1519 }
1520 ok
1521}
1522
1523fn write_temps(job: &Job, temps: &Temps, stderr: &mut impl std::io::Write) -> bool {
1529 let mut ok = true;
1530 let kept = [(job.saved_text(), &temps.preprocessed), (job.saved_asm(), &temps.assembly)];
1531 for (path, text) in kept {
1532 let (Some(path), Some(text)) = (path, text) else { continue };
1535 if let Err(e) = std::fs::write(&path, text) {
1536 let _ = writeln!(stderr, "rucc: error: {path}: {e}");
1537 ok = false;
1538 }
1539 }
1540 ok
1541}
1542
1543fn say_time(name: &str, took: std::time::Duration, stderr: &mut impl std::io::Write) {
1550 let _ = writeln!(stderr, "# {name} {:.2} {:.2}", took.as_secs_f64(), 0.0);
1551}
1552
1553fn write_out(output: &Output, bytes: &[u8]) -> Result<(), String> {
1560 match output {
1561 Output::Stdout => {
1562 let mut stdout = std::io::stdout().lock();
1563 stdout.write_all(bytes).map_err(|e| format!("writing to standard output: {e}"))
1564 }
1565 Output::File(path) | Output::Temporary(path) => {
1566 std::fs::write(path, bytes).map_err(|e| format!("{path}: {e}"))
1567 }
1568 }
1569}
1570
1571pub fn run(args: &[String]) -> i32 {
1576 match parse_args(args) {
1577 Ok(Action::Help) => {
1578 print!("{USAGE}");
1579 0
1580 }
1581 Ok(Action::Version) => {
1582 println!("rucc {VERSION}");
1583 0
1584 }
1585 Ok(Action::Print(line)) => {
1586 println!("{line}");
1587 0
1588 }
1589 Ok(Action::PrintConfig(opts)) => {
1590 print!("{}", print_config(&opts));
1591 0
1592 }
1593 Ok(Action::PrintPipeline(opts)) => {
1594 print!("{}", print_pipeline(&opts));
1595 0
1596 }
1597 Ok(Action::PrintPlan { opts, plan, link }) => {
1598 print!("{}", plan.render());
1599 if let Some(job) = &plan.link {
1603 match link_line(&opts, &link, job) {
1604 Ok(line) => println!("{line}"),
1605 Err(why) => {
1606 let mut stderr = std::io::stderr().lock();
1607 let _ = writeln!(stderr, "rucc: error: {why}");
1608 return 1;
1609 }
1610 }
1611 }
1612 0
1613 }
1614 Ok(Action::Compile { opts, plan, link, jobs, verbose }) => {
1615 {
1616 let mut stderr = std::io::stderr().lock();
1617 if verbose {
1618 let _ = write!(stderr, "{}", plan.render());
1619 let _ = writeln!(stderr, "workers: {}", jobs.count());
1620 }
1621 }
1622 if opts.emit == EmitKind::Preprocessed {
1623 return preprocess_all(&opts, &plan);
1624 }
1625 if opts.emit != EmitKind::Executable {
1626 return compile_all(&opts, &plan);
1627 }
1628 link_all(&opts, &plan, &link, verbose)
1629 }
1630 Err(e) => {
1631 let mut stderr = std::io::stderr().lock();
1632 let _ = writeln!(stderr, "rucc: error: {e}");
1633 let _ = writeln!(stderr, "rucc: note: run `rucc --help` for usage");
1634 1
1635 }
1636 }
1637}
1638
1639#[cfg(test)]
1640mod tests {
1641 use rucc_session::{GnucVersion, IncludeForm, OptLevel, Visibility};
1642
1643 use super::*;
1644
1645 fn args(s: &[&str]) -> Vec<String> {
1646 s.iter().map(|x| (*x).to_owned()).collect()
1647 }
1648
1649 #[test]
1650 fn help_and_version_win_over_everything_else() {
1651 assert_eq!(parse_args(&args(&["-c", "--help", "x.c"])).unwrap(), Action::Help);
1652 assert_eq!(parse_args(&args(&["--version"])).unwrap(), Action::Version);
1653 }
1654
1655 fn compile(s: &[&str]) -> (Box<Options>, Box<Plan>) {
1656 match parse_args(&args(s)).expect("expected a compilation") {
1657 Action::Compile { opts, plan, .. } => (opts, plan),
1658 other => panic!("expected a compilation, got {other:?}"),
1659 }
1660 }
1661
1662 fn linking(s: &[&str]) -> (Box<LinkOptions>, Box<Plan>) {
1663 match parse_args(&args(s)).expect("expected a compilation") {
1664 Action::Compile { link, plan, .. } => (link, plan),
1665 other => panic!("expected a compilation, got {other:?}"),
1666 }
1667 }
1668
1669 #[test]
1670 fn collects_inputs_and_flags() {
1671 let (opts, plan) = compile(&["-c", "-O2", "-g", "a.c", "b.c"]);
1672 let paths: Vec<&str> = plan.jobs.iter().map(|j| j.input.as_str()).collect();
1673 assert_eq!(paths, vec!["a.c", "b.c"]);
1674 assert_eq!(opts.opt_level, OptLevel::O2);
1675 assert_eq!(opts.emit, EmitKind::Object);
1676 assert!(opts.debug_info);
1677 }
1678
1679 #[test]
1682 fn an_unstable_option_is_taken_and_one_that_does_not_exist_is_refused() {
1683 let (opts, _) = compile(&["-c", "-Zrule-coverage=/tmp/rules.cov", "a.c"]);
1684 assert_eq!(opts.rule_coverage.as_deref(), Some("/tmp/rules.cov"));
1685
1686 let (plain, _) = compile(&["-c", "a.c"]);
1687 assert_eq!(plain.rule_coverage, None, "nothing is measured unless it was asked for");
1688
1689 assert!(parse_args(&args(&["-Zrule-coverage=", "a.c"])).is_err(), "a file with no name");
1690 let unknown = parse_args(&args(&["-Zwhat", "a.c"])).expect_err("there is no such option");
1691 assert!(unknown.message.contains("4.11"), "{}", unknown.message);
1692 }
1693
1694 #[test]
1695 fn a_bare_dash_o_means_o1_the_way_gcc_reads_it() {
1696 let (opts, _) = compile(&["-O", "a.c"]);
1697 assert_eq!(opts.opt_level, OptLevel::O1);
1698 }
1699
1700 #[test]
1701 fn dash_x_applies_to_later_inputs_only_and_none_stops_it() {
1702 let (_, plan) = compile(&["a.o", "-x", "c", "b.txt", "-x", "none", "c.o"]);
1703 assert_eq!(plan.jobs[0].kind, InputKind::LinkerInput);
1704 assert_eq!(plan.jobs[1].kind, InputKind::C);
1705 assert_eq!(plan.jobs[2].kind, InputKind::LinkerInput);
1706 }
1707
1708 #[test]
1709 fn dash_j_reaches_the_scheduler_and_defaults_to_the_machine() {
1710 let (_, _, jobs) = match parse_args(&args(&["-j4", "a.c"])).unwrap() {
1711 Action::Compile { opts, plan, jobs, .. } => (opts, plan, jobs),
1712 other => panic!("expected a compilation, got {other:?}"),
1713 };
1714 assert_eq!(jobs.count(), 4);
1715
1716 let default = match parse_args(&args(&["a.c"])).unwrap() {
1717 Action::Compile { jobs, .. } => jobs,
1718 other => panic!("expected a compilation, got {other:?}"),
1719 };
1720 assert_eq!(default, Jobs::available());
1721 assert!(parse_args(&args(&["-j0", "a.c"])).is_err());
1722 }
1723
1724 #[test]
1725 fn triple_hash_prints_the_plan_and_runs_nothing() {
1726 let a = parse_args(&args(&["-###", "-c", "a.c"])).unwrap();
1727 let Action::PrintPlan { plan, .. } = a else { panic!("expected a plan dump") };
1728 assert!(plan.render().contains("a.c: preprocess, compile, assemble -> a.o"));
1729 }
1730
1731 #[test]
1732 fn the_flag_that_keeps_the_intermediate_files_has_three_spellings_and_two_meanings() {
1733 assert_eq!(compile(&["-c", "-save-temps", "a.c"]).0.save_temps, SaveTemps::Object);
1737 assert_eq!(compile(&["-c", "-save-temps=obj", "a.c"]).0.save_temps, SaveTemps::Object);
1738 assert_eq!(compile(&["-c", "-save-temps=cwd", "a.c"]).0.save_temps, SaveTemps::Cwd);
1739 assert_eq!(compile(&["-c", "a.c"]).0.save_temps, SaveTemps::No);
1740 let (opts, _) = compile(&["-c", "-save-temps", "-save-temps=cwd", "a.c"]);
1744 assert_eq!(opts.save_temps, SaveTemps::Cwd);
1745 let e = parse_args(&args(&["-c", "-save-temps=nowhere", "a.c"])).unwrap_err();
1746 assert!(e.message.contains("accepted: cwd, obj"), "{}", e.message);
1747 }
1748
1749 #[test]
1750 fn the_flag_that_times_each_step_reaches_the_options_and_changes_nothing_else() {
1751 let (opts, plan) = compile(&["-c", "-time", "a.c"]);
1752 let (plain, without) = compile(&["-c", "a.c"]);
1753 assert!(opts.time);
1754 assert!(!plain.time);
1755 assert_eq!(plan.jobs[0].output, without.jobs[0].output);
1758 }
1759
1760 #[test]
1761 fn dash_x_names_what_it_accepts_when_it_does_not_know_a_language() {
1762 let e = parse_args(&args(&["-x", "fortran", "a.c"])).unwrap_err();
1763 assert!(e.message.contains("assembler-with-cpp"), "{}", e.message);
1764 }
1765
1766 #[test]
1767 fn an_unknown_flag_is_an_error_rather_than_a_shrug() {
1768 let e = parse_args(&args(&["-fno-such-thing", "a.c"])).unwrap_err();
1769 assert!(e.message.contains("unknown option"), "{}", e.message);
1770 }
1771
1772 #[test]
1775 fn permissive_reads_in_both_directions_and_the_last_one_wins() {
1776 let (opts, _) = compile(&["-c", "a.c"]);
1777 assert!(!opts.permissive, "off unless it is asked for");
1778
1779 let (opts, _) = compile(&["-c", "-fpermissive", "a.c"]);
1780 assert!(opts.permissive);
1781
1782 let (opts, _) = compile(&["-c", "-fpermissive", "-fno-permissive", "a.c"]);
1783 assert!(!opts.permissive);
1784 }
1785
1786 #[test]
1787 fn asking_for_nested_functions_is_told_why_it_is_not_coming() {
1788 let e = parse_args(&args(&["-fnested-functions", "a.c"])).unwrap_err();
1789 assert!(e.message.contains("trampoline"), "{}", e.message);
1790 assert!(parse_args(&args(&["-fno-nested-functions", "a.c"])).is_ok());
1791 }
1792
1793 #[test]
1794 fn the_flag_every_configure_script_writes_is_taken() {
1795 for flag in ["-fPIC", "-fpic", "-fPIE", "-fpie"] {
1798 let (opts, _) = compile(&["-c", flag, "a.c"]);
1799 assert_eq!(opts.emit, EmitKind::Object, "{flag}");
1800 }
1801 }
1802
1803 #[test]
1804 fn the_flags_that_describe_what_this_compiler_already_does_are_taken() {
1805 for flag in [
1809 "-fno-common",
1810 "-fstrict-aliasing",
1811 "-fno-strict-aliasing",
1812 "-pipe",
1813 "-fdiagnostics-color",
1814 "-fno-diagnostics-color",
1815 "-fdiagnostics-color=always",
1816 "-fdiagnostics-color=never",
1817 "-fdiagnostics-color=auto",
1818 ] {
1819 let (opts, _) = compile(&["-c", flag, "a.c"]);
1820 assert_eq!(opts.emit, EmitKind::Object, "{flag}");
1821 }
1822 }
1823
1824 #[test]
1825 fn asking_the_linker_to_merge_tentative_definitions_is_told_why_it_is_not_coming() {
1826 let e = parse_args(&args(&["-fcommon", "a.c"])).unwrap_err();
1829 assert!(e.message.contains(".bss"), "{}", e.message);
1830 assert!(e.message.contains("extern"), "the way out is worth saying: {}", e.message);
1831 }
1832
1833 #[test]
1834 fn asking_for_position_dependent_code_is_told_why_it_is_not_coming() {
1835 for flag in ["-fno-pic", "-fno-pie"] {
1836 let e = parse_args(&args(&[flag, "a.c"])).unwrap_err();
1837 assert!(e.message.contains("global offset table"), "{flag}: {}", e.message);
1838 assert!(e.message.contains("-no-pie"), "{flag}: {}", e.message);
1841 }
1842 }
1843
1844 #[test]
1845 fn an_unsupported_target_names_itself() {
1846 let e = parse_args(&args(&["--target=sparc64-linux-gnu", "a.c"])).unwrap_err();
1847 assert!(e.message.contains("sparc64"), "{}", e.message);
1848 }
1849
1850 #[test]
1851 fn no_inputs_is_an_error_but_print_config_needs_none() {
1852 assert!(parse_args(&args(&[])).is_err());
1853 assert!(matches!(parse_args(&args(&["--print-config"])), Ok(Action::PrintConfig(_))));
1854 }
1855
1856 #[test]
1857 fn print_config_reports_the_target_it_was_given_not_the_host() {
1858 let a = parse_args(&args(&["--print-config", "--target=riscv64-linux-musl"])).unwrap();
1859 let Action::PrintConfig(opts) = a else { panic!("expected a configuration dump") };
1860 let text = print_config(&opts);
1861 assert!(text.contains("target: riscv64-unknown-linux-musl"), "{text}");
1862 assert!(text.contains("char-signed: false"), "{text}");
1863 assert!(text.contains("object-format: elf"), "{text}");
1864 assert!(text.contains("va-list: void-pointer"), "{text}");
1865 assert!(text.contains("registers: none"), "{text}");
1868 }
1869
1870 #[test]
1871 fn print_config_has_one_key_per_line_and_a_fixed_order() {
1872 let opts = Options::new("x86_64-unknown-linux-gnu".parse().unwrap());
1873 let text = print_config(&opts);
1874 let keys: Vec<&str> =
1875 text.lines().map(|l| l.split(':').next().unwrap_or_default()).collect();
1876 assert_eq!(keys[0], "version");
1877 assert_eq!(keys[1], "target");
1878 assert_eq!(keys.len(), 19);
1879 assert!(text.ends_with('\n'));
1880 }
1881
1882 #[test]
1883 fn the_safety_tier_is_read_off_the_command_line_and_a_wrong_one_is_refused() {
1884 let (opts, _) = compile(&["a.c"]);
1885 assert_eq!(opts.safety, rucc_session::Safety::Off);
1886
1887 for (flag, tier) in [
1888 ("-fsafety=detect", rucc_session::Safety::Detect),
1889 ("-fsafety=enforce", rucc_session::Safety::Enforce),
1890 ("-fsafety=kernel", rucc_session::Safety::Kernel),
1891 ("-fsafety=off", rucc_session::Safety::Off),
1892 ] {
1893 let (opts, _) = compile(&[flag, "a.c"]);
1894 assert_eq!(opts.safety, tier, "{flag}");
1895 }
1896
1897 let (opts, _) = compile(&["-fsafety=enforce", "-fsafety=off", "a.c"]);
1899 assert_eq!(opts.safety, rucc_session::Safety::Off);
1900
1901 let e = parse_args(&args(&["-fsafety=on", "a.c"])).unwrap_err();
1904 assert!(e.message.contains("is not a safety tier"), "{}", e.message);
1905 assert!(parse_args(&args(&["-fsafety", "a.c"])).is_err());
1906 }
1907
1908 #[test]
1909 fn print_pipeline_answers_with_the_passes_the_level_asked_for() {
1910 let a = parse_args(&args(&["--print-pipeline", "-O2"])).unwrap();
1911 let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
1912 let text = print_pipeline(&opts);
1913 assert!(text.starts_with("level: -O2\n"), "{text}");
1914 assert!(text.contains("fold"), "{text}");
1915
1916 let a = parse_args(&args(&["--print-pipeline"])).unwrap();
1917 let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
1918 assert!(print_pipeline(&opts).contains("1: simplify-cfg,"), "{}", print_pipeline(&opts));
1921
1922 let a = parse_args(&args(&["--print-pipeline", "-fno-simplify-cfg"])).unwrap();
1923 let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
1924 assert!(print_pipeline(&opts).contains("no passes"), "{}", print_pipeline(&opts));
1927 }
1928
1929 #[test]
1930 fn print_pipeline_takes_the_toggles_into_account() {
1931 let a = parse_args(&args(&["--print-pipeline", "-O2", "-fno-fold"])).unwrap();
1932 let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
1933 let text = print_pipeline(&opts);
1934 assert!(!text.contains("fold"), "{text}");
1937 assert!(text.contains("dce"), "{text}");
1938
1939 let mut off = vec!["--print-pipeline".to_owned(), "-O2".to_owned()];
1943 off.extend(rucc_opt::PASSES.iter().map(|p| format!("-fno-{}", p.name())));
1944 let spelled: Vec<&str> = off.iter().map(String::as_str).collect();
1945 let a = parse_args(&args(&spelled)).unwrap();
1946 let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
1947 assert!(print_pipeline(&opts).contains("no passes"), "{}", print_pipeline(&opts));
1948 }
1949
1950 #[test]
1951 fn print_pipeline_says_when_a_budget_will_stop_the_run_short() {
1952 let a = parse_args(&args(&["--print-pipeline", "-O2"])).unwrap();
1953 let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
1954 assert!(!print_pipeline(&opts).contains("global fuel"));
1955
1956 let a = parse_args(&args(&["--print-pipeline", "-O2", "-fpass-fuel-global=4"])).unwrap();
1957 let Action::PrintPipeline(opts) = a else { panic!("expected a pipeline dump") };
1958 let text = print_pipeline(&opts);
1959 assert!(text.contains("global fuel: 4"), "{text}");
1962 }
1963
1964 #[test]
1967 fn a_pass_is_named_by_dash_f_and_unnamed_by_dash_f_no() {
1968 let (opts, _) = compile(&["-c", "-O0", "-ffold", "-fno-fold", "-ffold", "a.c"]);
1969 assert_eq!(
1970 opts.passes,
1971 [("fold".to_owned(), true), ("fold".to_owned(), false), ("fold".to_owned(), true)]
1972 );
1973
1974 let e = parse_args(&args(&["-fno-such-pass", "a.c"])).unwrap_err();
1975 assert!(e.message.contains("unknown option"), "{}", e.message);
1976 }
1977
1978 #[test]
1979 fn pass_fuel_names_a_pass_and_a_count_and_refuses_anything_else() {
1980 let (opts, _) = compile(&["-c", "-O2", "-fpass-fuel=fold=3", "a.c"]);
1981 assert_eq!(opts.pass_fuel, [("fold".to_owned(), 3)]);
1982
1983 let e = parse_args(&args(&["-fpass-fuel=fold", "a.c"])).unwrap_err();
1984 assert!(e.message.contains("<pass>=<count>"), "{}", e.message);
1985 let e = parse_args(&args(&["-fpass-fuel=nosuch=3", "a.c"])).unwrap_err();
1986 assert!(e.message.contains("--print-pipeline"), "{}", e.message);
1987 let e = parse_args(&args(&["-fpass-fuel=fold=lots", "a.c"])).unwrap_err();
1988 assert!(e.message.contains("not a number"), "{}", e.message);
1989 }
1990
1991 #[test]
1992 fn global_pass_fuel_is_a_count_on_its_own_and_defaults_to_no_limit() {
1993 let (opts, _) = compile(&["-c", "-O2", "a.c"]);
1994 assert_eq!(opts.pass_fuel_global, None);
1995
1996 let (opts, _) = compile(&["-c", "-O2", "-fpass-fuel-global=12", "a.c"]);
1997 assert_eq!(opts.pass_fuel_global, Some(12));
1998 assert!(opts.pass_fuel.is_empty());
2001
2002 let e = parse_args(&args(&["-fpass-fuel-global=lots", "a.c"])).unwrap_err();
2003 assert!(e.message.contains("not a number"), "{}", e.message);
2004 }
2005
2006 #[test]
2007 fn a_gate_names_a_pass_and_optionally_the_functions_it_covers() {
2008 let (opts, _) = compile(&["-c", "-O2", "-fdisable-fold", "-fenable-fold=2-4,main", "a.c"]);
2009 assert_eq!(
2010 opts.pass_gates,
2011 [(false, "fold".to_owned()), (true, "fold=2-4,main".to_owned())],
2012 "the order is what decides, so it has to survive the parse"
2013 );
2014
2015 let e = parse_args(&args(&["-fdisable-nosuch", "a.c"])).unwrap_err();
2016 assert!(e.message.contains("--print-pipeline"), "{}", e.message);
2017 let e = parse_args(&args(&["-fenable-fold=9-2", "a.c"])).unwrap_err();
2018 assert!(e.message.contains("ends before it starts"), "{}", e.message);
2019 let e = parse_args(&args(&["-fdisable-fold=", "a.c"])).unwrap_err();
2020 assert!(e.message.contains("is empty"), "{}", e.message);
2021 }
2022
2023 #[test]
2024 fn the_pipeline_listing_says_which_passes_a_gate_touched() {
2025 let (opts, _) = compile(&["-c", "-O2", "-fdisable-fold=main", "a.c"]);
2026 let text = print_pipeline(&opts);
2027 assert!(text.contains("fold, "), "{text}");
2028 assert!(text.contains("[off for main]"), "{text}");
2029 }
2030
2031 #[test]
2035 fn a_dump_is_checked_when_it_is_asked_for_rather_than_when_it_is_taken() {
2036 let (opts, _) = compile(&["-c", "-O2", "-fdump-ir=all", "-fdump-ir=after-fold", "a.c"]);
2037 assert_eq!(opts.dump_ir, ["all", "after-fold"]);
2038
2039 let e = parse_args(&args(&["-fdump-ir=after-nosuch", "a.c"])).unwrap_err();
2040 assert!(e.message.contains("nosuch"), "{}", e.message);
2041 assert!(parse_args(&args(&["-fdump-ir=sideways-fold", "a.c"])).is_err());
2042 }
2043
2044 #[test]
2050 fn opt_info_takes_kinds_and_a_file_and_refuses_a_kind_it_does_not_have() {
2051 let (opts, _) = compile(&["-c", "-O2", "-fopt-info", "a.c"]);
2052 assert_eq!(opts.opt_info, [""], "a bare flag asks for the rewrites");
2053 assert_eq!(opts.opt_info_file, None, "and goes to standard error");
2054
2055 let (opts, _) = compile(&["-c", "-O2", "-fopt-info-missed-note", "a.c"]);
2056 assert_eq!(opts.opt_info, ["missed-note"]);
2057
2058 let (opts, _) =
2061 compile(&["-c", "-O2", "-fopt-info-missed=one.txt", "-fopt-info-all=two.txt", "a.c"]);
2062 assert_eq!(opts.opt_info, ["missed", "all"]);
2063 assert_eq!(opts.opt_info_file.as_deref(), Some("two.txt"));
2064
2065 let e = parse_args(&args(&["-fopt-info-vectorized", "a.c"])).unwrap_err();
2066 assert!(e.message.contains("vectorized"), "{}", e.message);
2067 assert!(e.message.contains("`missed`"), "{}", e.message);
2068 let e = parse_args(&args(&["-fopt-info-missed=", "a.c"])).unwrap_err();
2069 assert!(e.message.contains("no file"), "{}", e.message);
2070 }
2071
2072 #[test]
2073 fn verify_each_is_unstable_and_off_unless_it_was_asked_for() {
2074 let (opts, _) = compile(&["-c", "-Zverify-each", "a.c"]);
2075 assert!(opts.verify_each);
2076 assert!(!USAGE.contains("verify-each"), "an unstable option stays out of the usage text");
2077 }
2078
2079 #[test]
2080 fn dash_o_needs_an_argument() {
2081 let e = parse_args(&args(&["a.c", "-o"])).unwrap_err();
2082 assert_eq!(e.message, "-o requires an argument");
2083 }
2084
2085 #[test]
2086 fn dash_d_and_dash_u_are_read_joined_or_separated_and_keep_their_order() {
2087 let (opts, _) = compile(&["-DFOO=1", "-D", "BAR", "-UBAZ", "-U", "QUX", "a.c"]);
2088 assert_eq!(opts.defines, ["FOO=1", "BAR"]);
2089 assert_eq!(opts.undefines, ["BAZ", "QUX"]);
2090 }
2091
2092 #[test]
2093 fn the_include_flags_land_on_the_chain_each_one_names() {
2094 let (opts, _) = compile(&[
2097 "-Ii",
2098 "-iquote",
2099 "q",
2100 "-isystem",
2101 "sys",
2102 "-idirafter",
2103 "after",
2104 "--sysroot=/nowhere-at-all",
2105 "a.c",
2106 ]);
2107 let dirs: Vec<&str> = opts.search.dirs().iter().filter_map(|d| d.path.to_str()).collect();
2108 assert_eq!(dirs, ["q", "i", "sys", runtime::DIR, "after"]);
2111 assert!(!opts.search.dirs()[1].is_system);
2112 assert!(opts.search.dirs()[2].is_system);
2113 }
2114
2115 #[test]
2116 fn the_librarys_headers_come_after_the_compilers_own_and_go_away_with_them() {
2117 let (opts, _) = compile(&["a.c"]);
2121 let dirs = opts.search.dirs();
2122 let ours = dirs.iter().position(|d| d.path.to_str() == Some(runtime::DIR));
2123 assert_eq!(ours, Some(0), "{dirs:?}");
2124 assert!(dirs[1..].iter().all(|d| d.is_system), "{dirs:?}");
2125 let (bare, _) = compile(&["-nostdinc", "a.c"]);
2126 assert!(bare.search.dirs().is_empty(), "{:?}", bare.search.dirs());
2127 }
2128
2129 #[test]
2130 fn a_sysroot_moves_the_librarys_directories_and_nothing_else() {
2131 let (opts, _) = compile(&["-isystem", "sys", "--sysroot=/nowhere-at-all", "a.c"]);
2132 let dirs: Vec<&str> = opts.search.dirs().iter().filter_map(|d| d.path.to_str()).collect();
2133 assert_eq!(dirs, ["sys", runtime::DIR]);
2134 }
2135
2136 #[test]
2137 fn dash_i_dash_moves_the_bracket_directories_into_the_quoted_chain() {
2138 let (opts, _) =
2139 compile(&["-Iinc1", "-iquote", "inc2", "-I-", "-Iinc3", "-nostdinc", "a.c"]);
2140 let dirs: Vec<&str> = opts.search.dirs().iter().filter_map(|d| d.path.to_str()).collect();
2141 assert_eq!(dirs, ["inc1", "inc2", "inc3"]);
2142 assert_eq!(opts.search.start(IncludeForm::Angled), 2);
2144 assert!(!opts.search.searches_current_dir());
2145 }
2146
2147 #[test]
2148 fn the_prefix_flags_stick_what_iprefix_said_on_the_front_of_what_follows_it() {
2149 let (opts, _) = compile(&[
2150 "-iprefix",
2151 "/tools/",
2152 "-iwithprefix",
2153 "late",
2154 "-iwithprefixbefore",
2155 "early",
2156 "-iprefix",
2157 "/other/",
2158 "-iwithprefix",
2159 "last",
2160 "-nostdinc",
2161 "a.c",
2162 ]);
2163 let dirs: Vec<&str> = opts.search.dirs().iter().filter_map(|d| d.path.to_str()).collect();
2164 assert_eq!(dirs, ["/tools/early", "/tools/late", "/other/last"]);
2167 assert!(!opts.search.dirs()[0].is_system);
2168 assert!(opts.search.dirs()[1].is_system);
2169 }
2170
2171 #[test]
2172 fn the_files_named_on_the_command_line_keep_their_order_and_which_flag_named_them() {
2173 let (opts, _) =
2174 compile(&["-include", "one.h", "-imacros", "two.h", "-include", "3.h", "a.c"]);
2175 let names: Vec<&str> = opts.preincludes.iter().map(|p| p.name.as_str()).collect();
2176 assert_eq!(names, ["one.h", "two.h", "3.h"]);
2177 assert_eq!(opts.preincludes.iter().filter(|p| p.macros_only).count(), 1);
2178 }
2179
2180 #[test]
2181 fn nostdinc_takes_the_compilers_own_headers_off_the_path() {
2182 let (opts, _) = compile(&["-Ii", "-nostdinc", "a.c"]);
2183 let dirs: Vec<&str> = opts.search.dirs().iter().filter_map(|d| d.path.to_str()).collect();
2184 assert_eq!(dirs, ["i"]);
2185 }
2186
2187 #[test]
2188 fn the_dialect_flags_set_the_language_and_the_extensions_separately() {
2189 let (opts, _) = compile(&["-std=gnu11", "a.c"]);
2190 assert_eq!(opts.std, Std::C11);
2191 assert!(opts.gnu_extensions);
2192
2193 let (opts, _) = compile(&["-std=iso9899:1999", "a.c"]);
2194 assert_eq!(opts.std, Std::C99);
2195 assert!(!opts.gnu_extensions);
2196
2197 let (opts, _) = compile(&["-ansi", "a.c"]);
2198 assert_eq!(opts.std, Std::C89);
2199 assert!(!opts.gnu_extensions);
2200
2201 let e = parse_args(&args(&["-std=c94jr", "a.c"])).unwrap_err();
2202 assert!(e.message.contains("unknown dialect"), "{}", e.message);
2203 }
2204
2205 #[test]
2206 fn the_dump_letters_are_a_family_and_everything_else_beginning_with_d_is_not() {
2207 let (opts, _) = compile(&["-dM", "a.c"]);
2208 assert!(opts.dumps.macros);
2209
2210 let (opts, _) = compile(&["-dDM", "a.c"]);
2213 assert!(opts.dumps.macros);
2214 let (opts, _) = compile(&["-dD", "a.c"]);
2215 assert!(!opts.dumps.macros);
2216
2217 let (opts, _) = compile(&["a.c"]);
2218 assert!(!opts.dumps.any());
2219
2220 assert_eq!(printed(&["-dumpversion", "a.c"]), VERSION);
2223 }
2224
2225 #[test]
2226 fn the_gcc_version_claimed_is_a_flag_and_the_short_spellings_are_the_ones_people_write() {
2227 let (opts, _) = compile(&["a.c"]);
2228 assert_eq!(
2229 opts.gnuc,
2230 GnucVersion { major: 7, minor: 0, patch: 0 },
2231 "the lowest claim a modern glibc gives its own declarations to"
2232 );
2233
2234 let (opts, _) = compile(&["-fgnuc-version=15.1.0", "a.c"]);
2235 assert_eq!(opts.gnuc, GnucVersion { major: 15, minor: 1, patch: 0 });
2236
2237 let (opts, _) = compile(&["-fgnuc-version=15", "a.c"]);
2240 assert_eq!(opts.gnuc, GnucVersion { major: 15, minor: 0, patch: 0 });
2241
2242 let (opts, _) = compile(&["-fgnuc-version=13.2", "a.c"]);
2243 assert_eq!(opts.gnuc, GnucVersion { major: 13, minor: 2, patch: 0 });
2244
2245 let e = parse_args(&args(&["-fgnuc-version=15.x", "a.c"])).unwrap_err();
2246 assert!(e.message.contains("minor that is not a number"), "{}", e.message);
2247
2248 let e = parse_args(&args(&["-fgnuc-version=1.2.3.4", "a.c"])).unwrap_err();
2249 assert!(e.message.contains("more than three"), "{}", e.message);
2250 }
2251
2252 #[test]
2253 fn pedantic_has_two_spellings_and_is_not_the_same_knob_as_the_dialect() {
2254 let (opts, _) = compile(&["-std=c17", "-pedantic", "a.c"]);
2255 assert!(opts.pedantic);
2256 assert_eq!(opts.std, Std::C17);
2257
2258 let (opts, _) = compile(&["-Wpedantic", "a.c"]);
2261 assert!(opts.pedantic);
2262
2263 let (opts, _) = compile(&["-std=c17", "a.c"]);
2264 assert!(!opts.pedantic, "a dialect on its own does not diagnose an extension");
2265 }
2266
2267 #[test]
2268 fn dash_p_and_dash_ffreestanding_reach_the_options() {
2269 let (opts, _) = compile(&["-E", "-P", "-ffreestanding", "a.c"]);
2270 assert!(!opts.line_markers);
2271 assert!(!opts.hosted);
2272 assert_eq!(opts.emit, EmitKind::Preprocessed);
2273 }
2274
2275 #[test]
2282 fn the_builtin_flags_are_read_in_both_directions_and_one_name_at_a_time() {
2283 let (opts, _) = compile(&["-c", "a.c"]);
2284 assert!(opts.builtins, "a library name means the library function by default");
2285 assert!(opts.no_builtin.is_empty());
2286
2287 let (opts, _) = compile(&["-c", "-fno-builtin", "a.c"]);
2288 assert!(!opts.builtins);
2289
2290 let (opts, _) = compile(&["-c", "-fno-builtin", "-fbuiltin", "a.c"]);
2291 assert!(opts.builtins, "the last mention decides");
2292
2293 let (opts, _) = compile(&["-c", "-fno-builtin-memcpy", "-fno-builtin-nonesuch", "a.c"]);
2294 assert!(opts.builtins, "one name is not the family");
2295 assert_eq!(opts.no_builtin, vec!["memcpy".to_owned(), "nonesuch".to_owned()]);
2296 }
2297
2298 #[test]
2306 fn visibility_takes_the_four_spellings_gcc_takes_and_refuses_the_rest() {
2307 let (opts, _) = compile(&["-c", "a.c"]);
2308 assert_eq!(opts.visibility, Visibility::Default, "exported unless something says not");
2309
2310 for (written, wanted) in [
2311 ("default", Visibility::Default),
2312 ("hidden", Visibility::Hidden),
2313 ("internal", Visibility::Hidden),
2314 ("protected", Visibility::Protected),
2315 ] {
2316 let (opts, _) = compile(&["-c", &format!("-fvisibility={written}"), "a.c"]);
2317 assert_eq!(opts.visibility, wanted, "{written}");
2318 }
2319
2320 let (opts, _) = compile(&["-c", "-fvisibility=hidden", "-fvisibility=default", "a.c"]);
2323 assert_eq!(opts.visibility, Visibility::Default, "the last mention decides");
2324
2325 let failed = parse_args(&args(&["-fvisibility=none", "a.c"])).expect_err("refused");
2329 assert!(failed.to_string().contains("is not a visibility"), "{failed}");
2330 }
2331
2332 #[test]
2335 fn gnu89_inline_is_off_until_it_is_asked_for_and_the_last_mention_decides() {
2336 let (opts, _) = compile(&["-c", "a.c"]);
2337 assert!(!opts.gnu89_inline, "C's reading of inline by default");
2338
2339 let (opts, _) = compile(&["-c", "-fgnu89-inline", "a.c"]);
2340 assert!(opts.gnu89_inline);
2341
2342 let (opts, _) = compile(&["-c", "-fgnu89-inline", "-fno-gnu89-inline", "a.c"]);
2343 assert!(!opts.gnu89_inline, "the last mention decides");
2344
2345 let (opts, _) = compile(&["-c", "-std=c89", "a.c"]);
2350 assert!(!opts.gnu89_inline);
2351 }
2352
2353 #[test]
2356 fn the_two_frame_flags_are_read_in_both_directions() {
2357 let (opts, _) = compile(&["-c", "a.c"]);
2358 assert!(!opts.frame_pointer, "gcc omits it above -O0 and so does this");
2359 assert!(opts.red_zone, "the psABI has one and nothing said not to use it");
2360
2361 let (opts, _) = compile(&["-c", "-fno-omit-frame-pointer", "-mno-red-zone", "a.c"]);
2362 assert!(opts.frame_pointer);
2363 assert!(!opts.red_zone);
2364
2365 let (opts, _) = compile(&[
2366 "-c",
2367 "-fno-omit-frame-pointer",
2368 "-fomit-frame-pointer",
2369 "-mno-red-zone",
2370 "-mred-zone",
2371 "a.c",
2372 ]);
2373 assert!(!opts.frame_pointer, "the last one wins, as it does in gcc");
2374 assert!(opts.red_zone);
2375 }
2376
2377 #[test]
2378 fn the_link_flags_are_collected_apart_from_the_compilation() {
2379 let (link, _) = linking(&[
2380 "-static",
2381 "-nostartfiles",
2382 "-rdynamic",
2383 "-s",
2384 "-fuse-ld=mold",
2385 "-L/opt/lib",
2386 "-B",
2387 "/opt/tools",
2388 "a.c",
2389 ]);
2390 assert!(link.is_static);
2391 assert!(link.no_startfiles);
2392 assert!(link.export_dynamic);
2393 assert!(link.strip);
2394 assert_eq!(link.use_ld.as_deref(), Some("mold"));
2395 assert_eq!(link.search, vec![PathBuf::from("/opt/lib")]);
2396 assert_eq!(link.prefixes, vec![PathBuf::from("/opt/tools")]);
2397 }
2398
2399 #[test]
2400 fn a_comma_in_dash_wl_separates_two_arguments() {
2401 let (link, _) = linking(&["-Wl,-rpath,/opt/lib", "-Xlinker", "--as-needed", "a.c"]);
2402 assert_eq!(link.passthrough, vec!["-rpath", "/opt/lib", "--as-needed"]);
2403 }
2404
2405 #[test]
2406 fn a_library_keeps_its_place_between_the_objects() {
2407 let (_, plan) = linking(&["--target=x86_64-unknown-linux-gnu", "a.c", "-lm", "b.c"]);
2412 let link = plan.link.expect("expected a link step");
2413 assert_eq!(
2414 link.inputs,
2415 vec![
2416 link::Item::File("a.o".into()),
2417 link::Item::Library("m".into()),
2418 link::Item::File("b.o".into()),
2419 ]
2420 );
2421 assert_eq!(plan.jobs.len(), 2);
2423 }
2424
2425 #[test]
2426 fn a_library_on_a_dash_c_line_is_a_note_rather_than_an_error() {
2427 let (_, plan) = linking(&["-c", "-lm", "a.c"]);
2428 assert!(plan.link.is_none());
2429 assert!(plan.notes.iter().any(|n| n.contains("-lm")), "{:?}", plan.notes);
2430 }
2431
2432 #[test]
2433 fn the_sysroot_reaches_the_linker_as_well_as_the_headers() {
2434 let (link, _) = linking(&["--sysroot=/opt/root", "a.c"]);
2435 assert_eq!(link.sysroot, Some(PathBuf::from("/opt/root")));
2436 }
2437
2438 fn printed(s: &[&str]) -> String {
2439 match parse_args(&args(s)).expect("expected an answer") {
2440 Action::Print(line) => line,
2441 other => panic!("expected an answer, got {other:?}"),
2442 }
2443 }
2444
2445 fn refused(s: &[&str]) -> String {
2446 parse_args(&args(s)).expect_err("expected a refusal").message
2447 }
2448
2449 #[test]
2450 fn a_warning_flag_this_compiler_has_not_heard_of_is_taken_rather_than_refused() {
2451 let (opts, _) = compile(&["-Wall", "-Wextra", "-Wno-format-truncation", "-c", "a.c"]);
2455 assert!(!opts.warnings_are_errors);
2456 assert!(opts.warnings);
2457 let (opts, _) = compile(&["-Werror", "-c", "a.c"]);
2459 assert!(opts.warnings_are_errors);
2460 let (opts, _) = compile(&["-w", "-c", "a.c"]);
2461 assert!(!opts.warnings);
2462 let (opts, _) = compile(&["-pedantic-errors", "-c", "a.c"]);
2463 assert!(opts.pedantic && opts.warnings_are_errors);
2464 }
2465
2466 #[test]
2467 fn an_argument_for_a_separate_tool_is_refused_rather_than_dropped() {
2468 assert!(refused(&["-Wa,--noexecstack", "-c", "a.c"]).contains("separate assembler"));
2470 assert!(refused(&["-Wp,-DX", "-c", "a.c"]).contains("separate assembler"));
2471 assert!(refused(&["-specs=/x", "a.c"]).contains("-specs= is not supported"));
2472 assert!(refused(&["-mcmodel=kernel", "-c", "a.c"]).contains("small code model"));
2473 assert!(refused(&["-gdwarf-4", "-c", "a.c"]).contains("DWARF 5"));
2474 assert!(refused(&["-Ofast", "-c", "a.c"]).contains("fast math"));
2475 let no32 = refused(&["--target=x86_64-unknown-linux-gnu", "-m32", "-c", "a.c"]);
2478 assert!(no32.contains("32 bit target"), "{no32}");
2479 }
2480
2481 #[test]
2482 fn the_levels_gcc_spells_differently_are_the_levels_they_mean() {
2483 assert_eq!(compile(&["-O", "-c", "a.c"]).0.opt_level, OptLevel::O1);
2484 assert_eq!(compile(&["-Og", "-c", "a.c"]).0.opt_level, OptLevel::O1);
2485 assert_eq!(compile(&["-O2", "-c", "a.c"]).0.opt_level, OptLevel::O2);
2486 }
2487
2488 #[test]
2489 fn the_machine_flags_that_name_what_we_already_do_are_taken_and_the_rest_are_not() {
2490 let line = ["--target=x86_64-unknown-linux-gnu", "-m64", "-march=x86-64-v3"];
2491 let (opts, _) =
2492 compile(&[&line[..], &["-mtune=native", "-mabi=sysv", "-c", "a.c"]].concat());
2493 assert_eq!(opts.target.to_string(), "x86_64-unknown-linux-gnu");
2494 let wrong = refused(&["--target=x86_64-unknown-linux-gnu", "-mabi=ms", "-c", "a.c"]);
2495 assert!(wrong.contains("sysv convention"), "{wrong}");
2496 }
2497
2498 #[test]
2499 fn the_thread_flag_is_a_macro_and_a_library_and_the_library_goes_last() {
2500 let (opts, plan) = compile(&["-pthread", "-c", "a.c"]);
2501 assert!(opts.defines.iter().any(|d| d == "_REENTRANT"));
2502 let names: Vec<&str> = plan.jobs.iter().map(|j| j.input.as_str()).collect();
2505 assert_eq!(names, vec!["a.c"]);
2506 }
2507
2508 #[test]
2509 fn the_questions_a_build_system_asks_before_it_compiles_anything() {
2510 let target = "--target=x86_64-unknown-linux-gnu";
2511 assert_eq!(printed(&[target, "-dumpmachine"]), "x86_64-unknown-linux-gnu");
2512 assert_eq!(printed(&[target, "-dumpversion"]), VERSION);
2513 assert_eq!(printed(&[target, "-dumpfullversion"]), VERSION);
2514 assert_eq!(printed(&[target, "-print-multiarch"]), "x86_64-linux-gnu");
2515 assert_eq!(printed(&[target, "-print-file-name=no-such-library.a"]), "no-such-library.a");
2518 assert_eq!(printed(&[target, "-print-prog-name=ld"]), "ld");
2519 let dirs = printed(&[target, "-print-search-dirs"]);
2520 assert!(dirs.starts_with("install: "), "{dirs}");
2521 assert!(dirs.contains("\nlibraries: ="), "{dirs}");
2522 }
2523
2524 #[test]
2525 fn the_two_dependency_flags_that_stop_after_the_rule_stop_after_the_rule() {
2526 let (opts, _) = compile(&["-M", "a.c"]);
2527 assert!(opts.deps.emit && opts.deps.instead_of_compiling);
2528 assert!(opts.deps.system_headers, "plain -M lists them");
2529 assert_eq!(opts.emit, EmitKind::Preprocessed);
2530
2531 let (opts, _) = compile(&["-M", "-c", "a.c"]);
2534 assert_eq!(opts.emit, EmitKind::Preprocessed);
2535
2536 let (opts, _) = compile(&["-MM", "a.c"]);
2537 assert!(!opts.deps.system_headers);
2538 }
2539
2540 #[test]
2541 fn the_two_that_end_in_d_leave_the_compilation_alone() {
2542 let (opts, _) = compile(&["-MD", "-c", "a.c"]);
2543 assert!(opts.deps.emit && !opts.deps.instead_of_compiling);
2544 assert!(opts.deps.system_headers);
2545 assert_eq!(opts.emit, EmitKind::Object);
2546
2547 let (opts, _) = compile(&["-MMD", "-c", "a.c"]);
2548 assert!(opts.deps.emit && !opts.deps.instead_of_compiling);
2549 assert!(!opts.deps.system_headers);
2550 }
2551
2552 #[test]
2553 fn nothing_puts_the_system_headers_back_once_a_flag_has_taken_them_out() {
2554 let (opts, _) = compile(&["-MM", "-M", "a.c"]);
2557 assert!(!opts.deps.system_headers);
2558 let (opts, _) = compile(&["-MD", "-MMD", "-c", "a.c"]);
2559 assert!(!opts.deps.system_headers);
2560 let (opts, _) = compile(&["-MMD", "-MD", "-c", "a.c"]);
2561 assert!(!opts.deps.system_headers);
2562 }
2563
2564 #[test]
2565 fn a_target_arrives_escaped_from_one_flag_and_untouched_from_the_other() {
2566 let (opts, _) = compile(&["-MM", "-MT", "a b.o", "-MQ", "a b.o", "a.c"]);
2567 assert_eq!(opts.deps.targets, vec!["a b.o".to_owned(), "a\\ b.o".to_owned()]);
2568 }
2569
2570 #[test]
2571 fn the_rest_of_the_family_is_a_file_and_a_switch() {
2572 let (opts, _) = compile(&["-MM", "-MF", "dep.d", "-MP", "a.c"]);
2573 assert_eq!(opts.deps.file.as_deref(), Some("dep.d"));
2574 assert!(opts.deps.phony);
2575
2576 for flag in ["-MF", "-MT", "-MQ"] {
2577 let e = parse_args(&args(&[flag])).unwrap_err();
2578 assert!(e.message.contains("requires an argument"), "{}", e.message);
2579 }
2580 }
2581
2582 struct TempTree(PathBuf);
2584
2585 impl Drop for TempTree {
2586 fn drop(&mut self) {
2587 let _ = std::fs::remove_dir_all(&self.0);
2588 }
2589 }
2590
2591 impl TempTree {
2592 fn new(name: &str, files: &[(&str, &str)]) -> TempTree {
2593 let dir = std::env::temp_dir().join(format!("rucc-deps-{}-{name}", std::process::id()));
2594 let _ = std::fs::remove_dir_all(&dir);
2595 std::fs::create_dir_all(&dir).expect("temporary directory should be writable");
2596 for (path, text) in files {
2597 let at = dir.join(path);
2598 if let Some(parent) = at.parent() {
2599 std::fs::create_dir_all(parent).expect("creating a subdirectory should work");
2600 }
2601 std::fs::write(&at, text).expect("writing a temporary file should work");
2602 }
2603 TempTree(dir)
2604 }
2605
2606 fn path(&self, name: &str) -> String {
2607 self.0.join(name).to_string_lossy().into_owned()
2608 }
2609 }
2610
2611 #[test]
2612 fn the_rule_names_what_the_includes_found_and_names_each_of_them_once() {
2613 let tree = TempTree::new(
2617 "found",
2618 &[
2619 ("a.c", "#include \"one.h\"\n#include \"two.h\"\nint main(void) { return X; }\n"),
2620 ("one.h", "#define X 0\n"),
2621 ("two.h", "#include \"one.h\"\n"),
2622 ],
2623 );
2624 let out = tree.path("dep.d");
2625 let code = run(&args(&["-MM", "-MF", &out, "-o", &tree.path("a.i"), &tree.path("a.c")]));
2626 assert_eq!(code, 0);
2627
2628 let text = std::fs::read_to_string(&out).expect("the rule should have been written");
2629 let names: Vec<&str> = text.split_whitespace().collect();
2630 assert_eq!(names.first(), Some(&"a.o:"), "{text}");
2632 assert_eq!(names.iter().filter(|n| n.ends_with("one.h")).count(), 1, "{text}");
2633 assert_eq!(names.iter().filter(|n| n.ends_with("two.h")).count(), 1, "{text}");
2634 assert_eq!(std::fs::read(tree.path("a.i")).expect("the output should exist"), b"");
2637 }
2638
2639 #[test]
2640 fn a_header_that_is_only_reached_under_a_guard_is_still_a_dependency() {
2641 let tree = TempTree::new(
2644 "guarded",
2645 &[
2646 ("a.c", "#include \"g.h\"\n#include \"g.h\"\nint main(void) { return 0; }\n"),
2647 ("g.h", "#ifndef G\n#define G\n#endif\n"),
2648 ],
2649 );
2650 let out = tree.path("dep.d");
2651 let code = run(&args(&["-MM", "-MF", &out, "-o", &tree.path("a.i"), &tree.path("a.c")]));
2652 assert_eq!(code, 0);
2653 let text = std::fs::read_to_string(&out).expect("the rule should have been written");
2654 assert_eq!(text.split_whitespace().filter(|n| n.ends_with("g.h")).count(), 1, "{text}");
2655 }
2656
2657 #[test]
2658 fn every_imacros_file_is_read_before_every_include_file_whatever_order_they_were_written() {
2659 let tree = TempTree::new(
2664 "preinclude",
2665 &[
2666 ("a.c", "int main(void) { return 0; }\n"),
2667 ("i.h", "#ifdef FROM_MACROS\nint saw_it;\n#else\nint missed_it;\n#endif\n"),
2668 ("m.h", "#define FROM_MACROS 1\nint macros_text;\n"),
2669 ],
2670 );
2671 let out = tree.path("a.i");
2672 let code = run(&args(&[
2673 "-E",
2674 "-include",
2675 &tree.path("i.h"),
2676 "-imacros",
2677 &tree.path("m.h"),
2678 "-o",
2679 &out,
2680 &tree.path("a.c"),
2681 ]));
2682 assert_eq!(code, 0);
2683 let text = std::fs::read_to_string(&out).expect("the output should have been written");
2684 assert!(text.contains("saw_it"), "{text}");
2685 assert!(!text.contains("macros_text"), "{text}");
2688 }
2689
2690 #[test]
2691 fn a_file_the_command_line_named_is_a_prerequisite_the_same_as_one_a_directive_named() {
2692 let tree = TempTree::new(
2693 "preinclude-deps",
2694 &[
2695 ("a.c", "int main(void) { return 0; }\n"),
2696 ("i.h", "int from_include;\n"),
2697 ("m.h", "#define M 1\n"),
2698 ],
2699 );
2700 let out = tree.path("dep.d");
2701 let code = run(&args(&[
2702 "-MM",
2703 "-MF",
2704 &out,
2705 "-include",
2706 &tree.path("i.h"),
2707 "-imacros",
2708 &tree.path("m.h"),
2709 "-o",
2710 &tree.path("a.i"),
2711 &tree.path("a.c"),
2712 ]));
2713 assert_eq!(code, 0);
2714 let text = std::fs::read_to_string(&out).expect("the rule should have been written");
2715 assert!(text.contains("i.h"), "{text}");
2716 assert!(text.contains("m.h"), "{text}");
2717 }
2718
2719 #[test]
2720 fn a_command_line_include_that_is_nowhere_on_the_path_is_an_error_and_not_a_warning() {
2721 let tree = TempTree::new(
2725 "preinclude-missing",
2726 &[("sub/a.c", "int main(void) { return 0; }\n"), ("sub/beside.h", "int x;\n")],
2727 );
2728 let code = run(&args(&["-E", "-include", "beside.h", "-o", "-", &tree.path("sub/a.c")]));
2729 assert_eq!(code, 1);
2730 }
2731
2732 #[test]
2733 fn a_command_line_that_links_names_the_executable_and_not_the_object_it_went_through() {
2734 let (opts, plan) = compile(&["-MD", "sub/a.c", "-o", "prog"]);
2738 assert_eq!(plan.output.as_deref(), Some("prog"));
2739 assert_eq!(deps::default_target("sub/a.c", deps_target_output(&opts, &plan)), "prog");
2740 assert_eq!(
2741 deps::default_file(&opts.deps, "sub/a.c", plan.output.as_deref()).as_deref(),
2742 Some("prog.d")
2743 );
2744 }
2745
2746 #[test]
2747 fn the_plan_keeps_the_output_name_because_the_rule_is_written_from_it() {
2748 let (_, plan) = compile(&["-MMD", "-c", "sub/a.c", "-o", "obj/x.o"]);
2749 assert_eq!(plan.output.as_deref(), Some("obj/x.o"));
2750 let (_, plan) = compile(&["-MMD", "-c", "sub/a.c"]);
2751 assert_eq!(plan.output, None);
2752 }
2753
2754 #[test]
2755 fn usage_fits_on_a_screen() {
2756 assert!(USAGE.lines().count() < 48, "usage text has grown past one screen");
2774 }
2775}