1 //! Command-line interface of the rustbuild build system.
3 //! This module implements the command-line parsing of the build system which
4 //! has various flags to configure how it's run.
6 use std::path::PathBuf;
11 use crate::builder::Builder;
12 use crate::config::{Config, TargetSelection};
13 use crate::setup::Profile;
15 use crate::{Build, DocTests};
23 impl Default for Color {
24 fn default() -> Self {
29 impl std::str::FromStr for Color {
32 fn from_str(s: &str) -> Result<Self, Self::Err> {
33 match s.to_lowercase().as_str() {
34 "always" => Ok(Self::Always),
35 "never" => Ok(Self::Never),
36 "auto" => Ok(Self::Auto),
42 /// Deserialized version of all flags for this compile.
44 pub verbose: usize, // number of -v args; each extra -v after the first is passed to Cargo
45 pub on_fail: Option<String>,
46 pub stage: Option<u32>,
47 pub keep_stage: Vec<u32>,
48 pub keep_stage_std: Vec<u32>,
50 pub host: Option<Vec<TargetSelection>>,
51 pub target: Option<Vec<TargetSelection>>,
52 pub config: Option<PathBuf>,
53 pub jobs: Option<u32>,
55 pub incremental: bool,
56 pub exclude: Vec<PathBuf>,
57 pub include_default_paths: bool,
58 pub rustc_error_format: Option<String>,
59 pub json_output: bool,
63 // This overrides the deny-warnings configuration option,
64 // which passes -Dwarnings to the compiler invocations.
66 // true => deny, false => warn
67 pub deny_warnings: Option<bool>,
69 pub llvm_skip_rebuild: Option<bool>,
71 pub rust_profile_use: Option<String>,
72 pub rust_profile_generate: Option<String>,
74 pub llvm_profile_use: Option<String>,
75 // LLVM doesn't support a custom location for generating profile
78 // llvm_out/build/profiles/ is the location this writes to.
79 pub llvm_profile_generate: bool,
106 /// Whether to automatically update stderr/stdout files
109 compare_mode: Option<String>,
110 pass: Option<String>,
112 test_args: Vec<String>,
113 rustc_args: Vec<String>,
116 rustfix_coverage: bool,
120 test_args: Vec<String>,
139 impl Default for Subcommand {
140 fn default() -> Subcommand {
141 Subcommand::Build { paths: vec![PathBuf::from("nowhere")] }
146 pub fn parse(args: &[String]) -> Flags {
147 let mut subcommand_help = String::from(
149 Usage: x.py <subcommand> [options] [<paths>...]
152 build, b Compile either the compiler or libraries
153 check, c Compile either the compiler or libraries, using cargo check
154 clippy Run clippy (uses rustup/cargo-installed clippy binary)
157 test, t Build and run some test suites
158 bench Build and run some benchmarks
159 doc, d Build documentation
160 clean Clean out build directories
161 dist Build distribution artifacts
162 install Install distribution artifacts
163 run, r Run tools contained in this repository
164 setup Create a config.toml (making it easier to use `x.py` itself)
166 To learn more about a subcommand, run `./x.py <subcommand> -h`",
169 let mut opts = Options::new();
170 // Options common to all subcommands
171 opts.optflagmulti("v", "verbose", "use verbose output (-vv for very verbose)");
172 opts.optflag("i", "incremental", "use incremental compilation");
173 opts.optopt("", "config", "TOML configuration file for build", "FILE");
174 opts.optopt("", "build", "build target of the stage0 compiler", "BUILD");
175 opts.optmulti("", "host", "host targets to build", "HOST");
176 opts.optmulti("", "target", "target targets to build", "TARGET");
177 opts.optmulti("", "exclude", "build paths to exclude", "PATH");
180 "include-default-paths",
181 "include default paths in addition to the provided ones",
183 opts.optopt("", "on-fail", "command to run on failure", "CMD");
184 opts.optflag("", "dry-run", "dry run; don't build anything");
188 "stage to build (indicates compiler to use/test, e.g., stage 0 uses the \
189 bootstrap compiler, stage 1 the stage 0 rustc artifacts, etc.)",
195 "stage(s) to keep without recompiling \
196 (pass multiple times to keep e.g., both stages 0 and 1)",
202 "stage(s) of the standard library to keep without recompiling \
203 (pass multiple times to keep e.g., both stages 0 and 1)",
206 opts.optopt("", "src", "path to the root of the rust checkout", "DIR");
208 "number of jobs to run in parallel; \
209 defaults to {} (this host's logical CPU count)",
210 std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get)
212 opts.optopt("j", "jobs", &j_msg, "JOBS");
213 opts.optflag("h", "help", "print this help message");
217 "if value is deny, will deny warnings, otherwise use default",
220 opts.optopt("", "error-format", "rustc error format", "FORMAT");
221 opts.optflag("", "json-output", "use message-format=json");
222 opts.optopt("", "color", "whether to use color in cargo and rustc output", "STYLE");
226 "whether rebuilding llvm should be skipped \
227 a VALUE of TRUE indicates that llvm will not be rebuilt \
228 VALUE overrides the skip-rebuild option in config.toml.",
233 "rust-profile-generate",
234 "generate PGO profile with rustc build",
237 opts.optopt("", "rust-profile-use", "use PGO profile for rustc build", "PROFILE");
238 opts.optflag("", "llvm-profile-generate", "generate PGO profile with llvm built for rustc");
239 opts.optopt("", "llvm-profile-use", "use PGO profile for llvm build", "PROFILE");
241 // We can't use getopt to parse the options until we have completed specifying which
242 // options are valid, but under the current implementation, some options are conditional on
243 // the subcommand. Therefore we must manually identify the subcommand first, so that we can
244 // complete the definition of the options. Then we can use the getopt::Matches object from
246 let subcommand = args.iter().find(|&s| {
266 let subcommand = match subcommand {
269 // No or an invalid subcommand -- show the general usage and subcommand help
270 // An exit code will be 0 when no subcommand is given, and 1 in case of an invalid
272 println!("{}\n", subcommand_help);
273 let exit_code = if args.is_empty() { 0 } else { 1 };
274 process::exit(exit_code);
278 // Some subcommands get extra options
279 match subcommand.as_str() {
281 opts.optflag("", "no-fail-fast", "Run all tests regardless of failure");
285 "extra arguments to be passed for the test tool being used \
286 (e.g. libtest, compiletest or rustdoc)",
292 "extra options to pass the compiler when running tests",
295 opts.optflag("", "no-doc", "do not run doc tests");
296 opts.optflag("", "doc", "only run doc tests");
297 opts.optflag("", "bless", "update all stderr/stdout files of failing ui tests");
298 opts.optflag("", "force-rerun", "rerun tests even if the inputs are unchanged");
302 "mode describing what file the actual ui output will be compared to",
308 "force {check,build,run}-pass tests to this mode.",
309 "check | build | run",
311 opts.optopt("", "run", "whether to execute run-* tests", "auto | always | never");
315 "enable this to generate a Rustfix coverage file, which is saved in \
316 `/<build_base>/rustfix_missing_coverage.txt`",
320 opts.optflag("", "all-targets", "Check all targets");
323 opts.optmulti("", "test-args", "extra arguments", "ARGS");
326 opts.optflag("", "fix", "automatically apply lint suggestions");
329 opts.optflag("", "open", "open the docs in a browser");
332 opts.optflag("", "all", "clean all build artifacts");
335 opts.optflag("", "check", "check formatting instead of applying.");
341 let usage = |exit_code: i32, opts: &Options, verbose: bool, subcommand_help: &str| -> ! {
342 let mut extra_help = String::new();
344 // All subcommands except `clean` can have an optional "Available paths" section
346 let config = Config::parse(&["build".to_string()]);
347 let build = Build::new(config);
349 let maybe_rules_help = Builder::get_help(&build, subcommand.as_str());
350 extra_help.push_str(maybe_rules_help.unwrap_or_default().as_str());
351 } else if !(subcommand.as_str() == "clean" || subcommand.as_str() == "fmt") {
353 format!("Run `./x.py {} -h -v` to see a list of available paths.", subcommand)
358 println!("{}", opts.usage(subcommand_help));
359 if !extra_help.is_empty() {
360 println!("{}", extra_help);
362 process::exit(exit_code);
365 // Done specifying what options are possible, so do the getopts parsing
366 let matches = opts.parse(args).unwrap_or_else(|e| {
367 // Invalid argument/option format
368 println!("\n{}\n", e);
369 usage(1, &opts, false, &subcommand_help);
372 // Extra sanity check to make sure we didn't hit this crazy corner case:
374 // ./x.py --frobulate clean build
375 // ^-- option ^ ^- actual subcommand
376 // \_ arg to option could be mistaken as subcommand
377 let mut pass_sanity_check = true;
378 match matches.free.get(0) {
379 Some(check_subcommand) => {
380 if check_subcommand != subcommand {
381 pass_sanity_check = false;
385 pass_sanity_check = false;
388 if !pass_sanity_check {
389 println!("{}\n", subcommand_help);
391 "Sorry, I couldn't figure out which subcommand you were trying to specify.\n\
392 You may need to move some options to after the subcommand.\n"
396 // Extra help text for some commands
397 match subcommand.as_str() {
399 subcommand_help.push_str(
402 This subcommand accepts a number of paths to directories to the crates
403 and/or artifacts to compile. For example, for a quick build of a usable
406 ./x.py build --stage 1 library/std
408 This will build a compiler and standard library from the local source code.
409 Once this is done, build/$ARCH/stage1 contains a usable compiler.
411 If no arguments are passed then the default artifacts for that stage are
412 compiled. For example:
414 ./x.py build --stage 0
419 subcommand_help.push_str(
422 This subcommand accepts a number of paths to directories to the crates
423 and/or artifacts to compile. For example:
425 ./x.py check library/std
427 If no arguments are passed then many artifacts are checked.",
431 subcommand_help.push_str(
434 This subcommand accepts a number of paths to directories to the crates
435 and/or artifacts to run clippy against. For example:
437 ./x.py clippy library/core
438 ./x.py clippy library/core library/proc_macro",
442 subcommand_help.push_str(
445 This subcommand accepts a number of paths to directories to the crates
446 and/or artifacts to run `cargo fix` against. For example:
448 ./x.py fix library/core
449 ./x.py fix library/core library/proc_macro",
453 subcommand_help.push_str(
456 This subcommand optionally accepts a `--check` flag which succeeds if formatting is correct and
457 fails if it is not. For example:
464 subcommand_help.push_str(
467 This subcommand accepts a number of paths to test directories that
468 should be compiled and run. For example:
470 ./x.py test src/test/ui
471 ./x.py test library/std --test-args hash_map
472 ./x.py test library/std --stage 0 --no-doc
473 ./x.py test src/test/ui --bless
474 ./x.py test src/test/ui --compare-mode nll
476 Note that `test src/test/* --stage N` does NOT depend on `build compiler/rustc --stage N`;
477 just like `build library/std --stage N` it tests the compiler produced by the previous
480 Execute tool tests with a tool name argument:
484 If no arguments are passed then the complete artifacts for that stage are
488 ./x.py test --stage 1",
492 subcommand_help.push_str(
495 This subcommand accepts a number of paths to directories of documentation
496 to build. For example:
498 ./x.py doc src/doc/book
499 ./x.py doc src/doc/nomicon
500 ./x.py doc src/doc/book library/std
501 ./x.py doc library/std --open
503 If no arguments are passed then everything is documented:
506 ./x.py doc --stage 1",
510 subcommand_help.push_str(
513 This subcommand accepts a number of paths to tools to build and run. For
516 ./x.py run src/tools/expand-yaml-anchors
518 At least a tool needs to be called.",
522 subcommand_help.push_str(&format!(
524 x.py setup creates a `config.toml` which changes the defaults for x.py itself.
527 This subcommand accepts a 'profile' to use for builds. For example:
531 The profile is optional and you will be prompted interactively if it is not given.
532 The following profiles are available:
535 Profile::all_for_help(" ").trim_end()
540 // Get any optional paths which occur after the subcommand
541 let mut paths = matches.free[1..].iter().map(|p| p.into()).collect::<Vec<PathBuf>>();
543 let verbose = matches.opt_present("verbose");
545 // User passed in -h/--help?
546 if matches.opt_present("help") {
547 usage(0, &opts, verbose, &subcommand_help);
550 let cmd = match subcommand.as_str() {
551 "build" | "b" => Subcommand::Build { paths },
553 if matches.opt_present("all-targets") {
555 "Warning: --all-targets is now on by default and does not need to be passed explicitly."
558 Subcommand::Check { paths }
560 "clippy" => Subcommand::Clippy { paths, fix: matches.opt_present("fix") },
561 "fix" => Subcommand::Fix { paths },
562 "test" | "t" => Subcommand::Test {
564 bless: matches.opt_present("bless"),
565 force_rerun: matches.opt_present("force-rerun"),
566 compare_mode: matches.opt_str("compare-mode"),
567 pass: matches.opt_str("pass"),
568 run: matches.opt_str("run"),
569 test_args: matches.opt_strs("test-args"),
570 rustc_args: matches.opt_strs("rustc-args"),
571 fail_fast: !matches.opt_present("no-fail-fast"),
572 rustfix_coverage: matches.opt_present("rustfix-coverage"),
573 doc_tests: if matches.opt_present("doc") {
575 } else if matches.opt_present("no-doc") {
581 "bench" => Subcommand::Bench { paths, test_args: matches.opt_strs("test-args") },
582 "doc" | "d" => Subcommand::Doc { paths, open: matches.opt_present("open") },
584 if !paths.is_empty() {
585 println!("\nclean does not take a path argument\n");
586 usage(1, &opts, verbose, &subcommand_help);
589 Subcommand::Clean { all: matches.opt_present("all") }
591 "fmt" => Subcommand::Format { check: matches.opt_present("check"), paths },
592 "dist" => Subcommand::Dist { paths },
593 "install" => Subcommand::Install { paths },
595 if paths.is_empty() {
596 println!("\nrun requires at least a path!\n");
597 usage(1, &opts, verbose, &subcommand_help);
599 Subcommand::Run { paths }
602 let profile = if paths.len() > 1 {
603 println!("\nat most one profile can be passed to setup\n");
604 usage(1, &opts, verbose, &subcommand_help)
605 } else if let Some(path) = paths.pop() {
606 let profile_string = t!(path.into_os_string().into_string().map_err(
607 |path| format!("{} is not a valid UTF8 string", path.to_string_lossy())
610 profile_string.parse().unwrap_or_else(|err| {
611 eprintln!("error: {}", err);
612 eprintln!("help: the available profiles are:");
613 eprint!("{}", Profile::all_for_help("- "));
614 std::process::exit(1);
617 t!(crate::setup::interactive_path())
619 Subcommand::Setup { profile }
622 usage(1, &opts, verbose, &subcommand_help);
626 if let Subcommand::Check { .. } = &cmd {
627 if matches.opt_str("keep-stage").is_some()
628 || matches.opt_str("keep-stage-std").is_some()
630 println!("--keep-stage not yet supported for x.py check");
636 verbose: matches.opt_count("verbose"),
637 stage: matches.opt_str("stage").map(|j| j.parse().expect("`stage` should be a number")),
638 dry_run: matches.opt_present("dry-run"),
639 on_fail: matches.opt_str("on-fail"),
640 rustc_error_format: matches.opt_str("error-format"),
641 json_output: matches.opt_present("json-output"),
643 .opt_strs("keep-stage")
645 .map(|j| j.parse().expect("`keep-stage` should be a number"))
647 keep_stage_std: matches
648 .opt_strs("keep-stage-std")
650 .map(|j| j.parse().expect("`keep-stage-std` should be a number"))
652 host: if matches.opt_present("host") {
654 split(&matches.opt_strs("host"))
656 .map(|x| TargetSelection::from_user(&x))
657 .collect::<Vec<_>>(),
662 target: if matches.opt_present("target") {
664 split(&matches.opt_strs("target"))
666 .map(|x| TargetSelection::from_user(&x))
667 .collect::<Vec<_>>(),
672 config: matches.opt_str("config").map(PathBuf::from),
673 jobs: matches.opt_str("jobs").map(|j| j.parse().expect("`jobs` should be a number")),
675 incremental: matches.opt_present("incremental"),
676 exclude: split(&matches.opt_strs("exclude"))
679 .collect::<Vec<_>>(),
680 include_default_paths: matches.opt_present("include-default-paths"),
681 deny_warnings: parse_deny_warnings(&matches),
682 llvm_skip_rebuild: matches.opt_str("llvm-skip-rebuild").map(|s| s.to_lowercase()).map(
683 |s| s.parse::<bool>().expect("`llvm-skip-rebuild` should be either true or false"),
686 .opt_get_default("color", Color::Auto)
687 .expect("`color` should be `always`, `never`, or `auto`"),
688 rust_profile_use: matches.opt_str("rust-profile-use"),
689 rust_profile_generate: matches.opt_str("rust-profile-generate"),
690 llvm_profile_use: matches.opt_str("llvm-profile-use"),
691 llvm_profile_generate: matches.opt_present("llvm-profile-generate"),
697 pub fn test_args(&self) -> Vec<&str> {
699 Subcommand::Test { ref test_args, .. } | Subcommand::Bench { ref test_args, .. } => {
700 test_args.iter().flat_map(|s| s.split_whitespace()).collect()
706 pub fn rustc_args(&self) -> Vec<&str> {
708 Subcommand::Test { ref rustc_args, .. } => {
709 rustc_args.iter().flat_map(|s| s.split_whitespace()).collect()
715 pub fn fail_fast(&self) -> bool {
717 Subcommand::Test { fail_fast, .. } => fail_fast,
722 pub fn doc_tests(&self) -> DocTests {
724 Subcommand::Test { doc_tests, .. } => doc_tests,
729 pub fn bless(&self) -> bool {
731 Subcommand::Test { bless, .. } => bless,
736 pub fn force_rerun(&self) -> bool {
738 Subcommand::Test { force_rerun, .. } => force_rerun,
743 pub fn rustfix_coverage(&self) -> bool {
745 Subcommand::Test { rustfix_coverage, .. } => rustfix_coverage,
750 pub fn compare_mode(&self) -> Option<&str> {
752 Subcommand::Test { ref compare_mode, .. } => compare_mode.as_ref().map(|s| &s[..]),
757 pub fn pass(&self) -> Option<&str> {
759 Subcommand::Test { ref pass, .. } => pass.as_ref().map(|s| &s[..]),
764 pub fn run(&self) -> Option<&str> {
766 Subcommand::Test { ref run, .. } => run.as_ref().map(|s| &s[..]),
771 pub fn open(&self) -> bool {
773 Subcommand::Doc { open, .. } => open,
779 fn split(s: &[String]) -> Vec<String> {
780 s.iter().flat_map(|s| s.split(',')).filter(|s| !s.is_empty()).map(|s| s.to_string()).collect()
783 fn parse_deny_warnings(matches: &getopts::Matches) -> Option<bool> {
784 match matches.opt_str("warnings").as_deref() {
785 Some("deny") => Some(true),
786 Some("warn") => Some(false),
788 eprintln!(r#"invalid value for --warnings: {:?}, expected "warn" or "deny""#, value,);