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;
10 use crate::builder::{Builder, Kind};
11 use crate::config::{Config, TargetSelection};
12 use crate::setup::Profile;
14 use crate::{Build, DocTests};
16 #[derive(Copy, Clone)]
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 build_dir: Option<PathBuf>,
54 pub jobs: Option<u32>,
56 pub incremental: bool,
57 pub exclude: Vec<PathBuf>,
58 pub include_default_paths: bool,
59 pub rustc_error_format: Option<String>,
60 pub json_output: bool,
64 // This overrides the deny-warnings configuration option,
65 // which passes -Dwarnings to the compiler invocations.
67 // true => deny, false => warn
68 pub deny_warnings: Option<bool>,
70 pub llvm_skip_rebuild: Option<bool>,
72 pub rust_profile_use: Option<String>,
73 pub rust_profile_generate: Option<String>,
75 pub llvm_profile_use: Option<String>,
76 // LLVM doesn't support a custom location for generating profile
79 // llvm_out/build/profiles/ is the location this writes to.
80 pub llvm_profile_generate: bool,
83 #[cfg_attr(test, derive(Clone))]
94 clippy_lint_allow: Vec<String>,
95 clippy_lint_deny: Vec<String>,
96 clippy_lint_warn: Vec<String>,
97 clippy_lint_forbid: Vec<String>,
112 /// Whether to automatically update stderr/stdout files
115 compare_mode: Option<String>,
116 pass: Option<String>,
119 test_args: Vec<String>,
120 rustc_args: Vec<String>,
123 rustfix_coverage: bool,
127 test_args: Vec<String>,
146 impl Default for Subcommand {
147 fn default() -> Subcommand {
148 Subcommand::Build { paths: vec![PathBuf::from("nowhere")] }
153 pub fn parse(args: &[String]) -> Flags {
154 let mut subcommand_help = String::from(
156 Usage: x.py <subcommand> [options] [<paths>...]
159 build, b Compile either the compiler or libraries
160 check, c Compile either the compiler or libraries, using cargo check
161 clippy Run clippy (uses rustup/cargo-installed clippy binary)
164 test, t Build and run some test suites
165 bench Build and run some benchmarks
166 doc, d Build documentation
167 clean Clean out build directories
168 dist Build distribution artifacts
169 install Install distribution artifacts
170 run, r Run tools contained in this repository
171 setup Create a config.toml (making it easier to use `x.py` itself)
173 To learn more about a subcommand, run `./x.py <subcommand> -h`",
176 let mut opts = Options::new();
177 // Options common to all subcommands
178 opts.optflagmulti("v", "verbose", "use verbose output (-vv for very verbose)");
179 opts.optflag("i", "incremental", "use incremental compilation");
180 opts.optopt("", "config", "TOML configuration file for build", "FILE");
184 "Build directory, overrides `build.build-dir` in `config.toml`",
187 opts.optopt("", "build", "build target of the stage0 compiler", "BUILD");
188 opts.optmulti("", "host", "host targets to build", "HOST");
189 opts.optmulti("", "target", "target targets to build", "TARGET");
190 opts.optmulti("", "exclude", "build paths to exclude", "PATH");
193 "include-default-paths",
194 "include default paths in addition to the provided ones",
196 opts.optopt("", "on-fail", "command to run on failure", "CMD");
197 opts.optflag("", "dry-run", "dry run; don't build anything");
201 "stage to build (indicates compiler to use/test, e.g., stage 0 uses the \
202 bootstrap compiler, stage 1 the stage 0 rustc artifacts, etc.)",
208 "stage(s) to keep without recompiling \
209 (pass multiple times to keep e.g., both stages 0 and 1)",
215 "stage(s) of the standard library to keep without recompiling \
216 (pass multiple times to keep e.g., both stages 0 and 1)",
219 opts.optopt("", "src", "path to the root of the rust checkout", "DIR");
221 "number of jobs to run in parallel; \
222 defaults to {} (this host's logical CPU count)",
225 opts.optopt("j", "jobs", &j_msg, "JOBS");
226 opts.optflag("h", "help", "print this help message");
230 "if value is deny, will deny warnings, otherwise use default",
233 opts.optopt("", "error-format", "rustc error format", "FORMAT");
234 opts.optflag("", "json-output", "use message-format=json");
235 opts.optopt("", "color", "whether to use color in cargo and rustc output", "STYLE");
239 "whether rebuilding llvm should be skipped \
240 a VALUE of TRUE indicates that llvm will not be rebuilt \
241 VALUE overrides the skip-rebuild option in config.toml.",
246 "rust-profile-generate",
247 "generate PGO profile with rustc build",
250 opts.optopt("", "rust-profile-use", "use PGO profile for rustc build", "PROFILE");
251 opts.optflag("", "llvm-profile-generate", "generate PGO profile with llvm built for rustc");
252 opts.optopt("", "llvm-profile-use", "use PGO profile for llvm build", "PROFILE");
253 opts.optmulti("A", "", "allow certain clippy lints", "OPT");
254 opts.optmulti("D", "", "deny certain clippy lints", "OPT");
255 opts.optmulti("W", "", "warn about certain clippy lints", "OPT");
256 opts.optmulti("F", "", "forbid certain clippy lints", "OPT");
258 // We can't use getopt to parse the options until we have completed specifying which
259 // options are valid, but under the current implementation, some options are conditional on
260 // the subcommand. Therefore we must manually identify the subcommand first, so that we can
261 // complete the definition of the options. Then we can use the getopt::Matches object from
263 let subcommand = match args.iter().find_map(|s| Kind::parse(&s)) {
266 // No or an invalid subcommand -- show the general usage and subcommand help
267 // An exit code will be 0 when no subcommand is given, and 1 in case of an invalid
269 println!("{}\n", subcommand_help);
270 let exit_code = if args.is_empty() { 0 } else { 1 };
271 crate::detail_exit(exit_code);
275 // Some subcommands get extra options
278 opts.optflag("", "no-fail-fast", "Run all tests regardless of failure");
279 opts.optmulti("", "skip", "skips tests matching SUBSTRING, if supported by test tool. May be passed multiple times", "SUBSTRING");
283 "extra arguments to be passed for the test tool being used \
284 (e.g. libtest, compiletest or rustdoc)",
290 "extra options to pass the compiler when running tests",
293 opts.optflag("", "no-doc", "do not run doc tests");
294 opts.optflag("", "doc", "only run doc tests");
295 opts.optflag("", "bless", "update all stderr/stdout files of failing ui tests");
296 opts.optflag("", "force-rerun", "rerun tests even if the inputs are unchanged");
300 "mode describing what file the actual ui output will be compared to",
306 "force {check,build,run}-pass tests to this mode.",
307 "check | build | run",
309 opts.optopt("", "run", "whether to execute run-* tests", "auto | always | never");
313 "enable this to generate a Rustfix coverage file, which is saved in \
314 `/<build_base>/rustfix_missing_coverage.txt`",
318 opts.optflag("", "all-targets", "Check all targets");
321 opts.optmulti("", "test-args", "extra arguments", "ARGS");
324 opts.optflag("", "fix", "automatically apply lint suggestions");
327 opts.optflag("", "open", "open the docs in a browser");
330 opts.optflag("", "all", "clean all build artifacts");
333 opts.optflag("", "check", "check formatting instead of applying.");
339 let usage = |exit_code: i32, opts: &Options, verbose: bool, subcommand_help: &str| -> ! {
340 let config = Config::parse(&["build".to_string()]);
341 let build = Build::new(config);
342 let paths = Builder::get_help(&build, subcommand);
344 println!("{}", opts.usage(subcommand_help));
345 if let Some(s) = paths {
350 "Run `./x.py {} -h -v` to see a list of available paths.",
355 panic!("No paths available for subcommand `{}`", subcommand.as_str());
357 crate::detail_exit(exit_code);
360 // Done specifying what options are possible, so do the getopts parsing
361 let matches = opts.parse(args).unwrap_or_else(|e| {
362 // Invalid argument/option format
363 println!("\n{}\n", e);
364 usage(1, &opts, false, &subcommand_help);
367 // Extra sanity check to make sure we didn't hit this crazy corner case:
369 // ./x.py --frobulate clean build
370 // ^-- option ^ ^- actual subcommand
371 // \_ arg to option could be mistaken as subcommand
372 let mut pass_sanity_check = true;
373 match matches.free.get(0).and_then(|s| Kind::parse(&s)) {
374 Some(check_subcommand) => {
375 if check_subcommand != subcommand {
376 pass_sanity_check = false;
380 pass_sanity_check = false;
383 if !pass_sanity_check {
384 eprintln!("{}\n", subcommand_help);
386 "Sorry, I couldn't figure out which subcommand you were trying to specify.\n\
387 You may need to move some options to after the subcommand.\n"
389 crate::detail_exit(1);
391 // Extra help text for some commands
394 subcommand_help.push_str(
397 This subcommand accepts a number of paths to directories to the crates
398 and/or artifacts to compile. For example, for a quick build of a usable
401 ./x.py build --stage 1 library/std
403 This will build a compiler and standard library from the local source code.
404 Once this is done, build/$ARCH/stage1 contains a usable compiler.
406 If no arguments are passed then the default artifacts for that stage are
407 compiled. For example:
409 ./x.py build --stage 0
414 subcommand_help.push_str(
417 This subcommand accepts a number of paths to directories to the crates
418 and/or artifacts to compile. For example:
420 ./x.py check library/std
422 If no arguments are passed then many artifacts are checked.",
426 subcommand_help.push_str(
429 This subcommand accepts a number of paths to directories to the crates
430 and/or artifacts to run clippy against. For example:
432 ./x.py clippy library/core
433 ./x.py clippy library/core library/proc_macro",
437 subcommand_help.push_str(
440 This subcommand accepts a number of paths to directories to the crates
441 and/or artifacts to run `cargo fix` against. For example:
443 ./x.py fix library/core
444 ./x.py fix library/core library/proc_macro",
448 subcommand_help.push_str(
451 This subcommand optionally accepts a `--check` flag which succeeds if formatting is correct and
452 fails if it is not. For example:
459 subcommand_help.push_str(
462 This subcommand accepts a number of paths to test directories that
463 should be compiled and run. For example:
465 ./x.py test src/test/ui
466 ./x.py test library/std --test-args hash_map
467 ./x.py test library/std --stage 0 --no-doc
468 ./x.py test src/test/ui --bless
469 ./x.py test src/test/ui --compare-mode chalk
471 Note that `test src/test/* --stage N` does NOT depend on `build compiler/rustc --stage N`;
472 just like `build library/std --stage N` it tests the compiler produced by the previous
475 Execute tool tests with a tool name argument:
479 If no arguments are passed then the complete artifacts for that stage are
483 ./x.py test --stage 1",
487 subcommand_help.push_str(
490 This subcommand accepts a number of paths to directories of documentation
491 to build. For example:
493 ./x.py doc src/doc/book
494 ./x.py doc src/doc/nomicon
495 ./x.py doc src/doc/book library/std
496 ./x.py doc library/std --open
498 If no arguments are passed then everything is documented:
501 ./x.py doc --stage 1",
505 subcommand_help.push_str(
508 This subcommand accepts a number of paths to tools to build and run. For
511 ./x.py run src/tools/expand-yaml-anchors
513 At least a tool needs to be called.",
517 subcommand_help.push_str(&format!(
519 x.py setup creates a `config.toml` which changes the defaults for x.py itself.
522 This subcommand accepts a 'profile' to use for builds. For example:
526 The profile is optional and you will be prompted interactively if it is not given.
527 The following profiles are available:
530 Profile::all_for_help(" ").trim_end()
533 Kind::Bench | Kind::Clean | Kind::Dist | Kind::Install => {}
535 // Get any optional paths which occur after the subcommand
536 let mut paths = matches.free[1..].iter().map(|p| p.into()).collect::<Vec<PathBuf>>();
538 let verbose = matches.opt_present("verbose");
540 // User passed in -h/--help?
541 if matches.opt_present("help") {
542 usage(0, &opts, verbose, &subcommand_help);
545 let cmd = match subcommand {
546 Kind::Build => Subcommand::Build { paths },
548 if matches.opt_present("all-targets") {
550 "Warning: --all-targets is now on by default and does not need to be passed explicitly."
553 Subcommand::Check { paths }
555 Kind::Clippy => Subcommand::Clippy {
557 fix: matches.opt_present("fix"),
558 clippy_lint_allow: matches.opt_strs("A"),
559 clippy_lint_warn: matches.opt_strs("W"),
560 clippy_lint_deny: matches.opt_strs("D"),
561 clippy_lint_forbid: matches.opt_strs("F"),
563 Kind::Fix => Subcommand::Fix { paths },
564 Kind::Test => Subcommand::Test {
566 bless: matches.opt_present("bless"),
567 force_rerun: matches.opt_present("force-rerun"),
568 compare_mode: matches.opt_str("compare-mode"),
569 pass: matches.opt_str("pass"),
570 run: matches.opt_str("run"),
571 skip: matches.opt_strs("skip"),
572 test_args: matches.opt_strs("test-args"),
573 rustc_args: matches.opt_strs("rustc-args"),
574 fail_fast: !matches.opt_present("no-fail-fast"),
575 rustfix_coverage: matches.opt_present("rustfix-coverage"),
576 doc_tests: if matches.opt_present("doc") {
578 } else if matches.opt_present("no-doc") {
584 Kind::Bench => Subcommand::Bench { paths, test_args: matches.opt_strs("test-args") },
585 Kind::Doc => Subcommand::Doc { paths, open: matches.opt_present("open") },
587 if !paths.is_empty() {
588 println!("\nclean does not take a path argument\n");
589 usage(1, &opts, verbose, &subcommand_help);
592 Subcommand::Clean { all: matches.opt_present("all") }
594 Kind::Format => Subcommand::Format { check: matches.opt_present("check"), paths },
595 Kind::Dist => Subcommand::Dist { paths },
596 Kind::Install => Subcommand::Install { paths },
598 if paths.is_empty() {
599 println!("\nrun requires at least a path!\n");
600 usage(1, &opts, verbose, &subcommand_help);
602 Subcommand::Run { paths }
605 let profile = if paths.len() > 1 {
606 println!("\nat most one profile can be passed to setup\n");
607 usage(1, &opts, verbose, &subcommand_help)
608 } else if let Some(path) = paths.pop() {
609 let profile_string = t!(path.into_os_string().into_string().map_err(
610 |path| format!("{} is not a valid UTF8 string", path.to_string_lossy())
613 profile_string.parse().unwrap_or_else(|err| {
614 eprintln!("error: {}", err);
615 eprintln!("help: the available profiles are:");
616 eprint!("{}", Profile::all_for_help("- "));
617 crate::detail_exit(1);
620 t!(crate::setup::interactive_path())
622 Subcommand::Setup { profile }
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 eprintln!("--keep-stage not yet supported for x.py check");
631 crate::detail_exit(1);
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 build_dir: matches.opt_str("build-dir").map(PathBuf::from),
674 jobs: matches.opt_str("jobs").map(|j| j.parse().expect("`jobs` should be a number")),
676 incremental: matches.opt_present("incremental"),
677 exclude: split(&matches.opt_strs("exclude"))
680 .collect::<Vec<_>>(),
681 include_default_paths: matches.opt_present("include-default-paths"),
682 deny_warnings: parse_deny_warnings(&matches),
683 llvm_skip_rebuild: matches.opt_str("llvm-skip-rebuild").map(|s| s.to_lowercase()).map(
684 |s| s.parse::<bool>().expect("`llvm-skip-rebuild` should be either true or false"),
687 .opt_get_default("color", Color::Auto)
688 .expect("`color` should be `always`, `never`, or `auto`"),
689 rust_profile_use: matches.opt_str("rust-profile-use"),
690 rust_profile_generate: matches.opt_str("rust-profile-generate"),
691 llvm_profile_use: matches.opt_str("llvm-profile-use"),
692 llvm_profile_generate: matches.opt_present("llvm-profile-generate"),
698 pub fn kind(&self) -> Kind {
700 Subcommand::Bench { .. } => Kind::Bench,
701 Subcommand::Build { .. } => Kind::Build,
702 Subcommand::Check { .. } => Kind::Check,
703 Subcommand::Clippy { .. } => Kind::Clippy,
704 Subcommand::Doc { .. } => Kind::Doc,
705 Subcommand::Fix { .. } => Kind::Fix,
706 Subcommand::Format { .. } => Kind::Format,
707 Subcommand::Test { .. } => Kind::Test,
708 Subcommand::Clean { .. } => Kind::Clean,
709 Subcommand::Dist { .. } => Kind::Dist,
710 Subcommand::Install { .. } => Kind::Install,
711 Subcommand::Run { .. } => Kind::Run,
712 Subcommand::Setup { .. } => Kind::Setup,
716 pub fn test_args(&self) -> Vec<&str> {
717 let mut args = vec![];
720 Subcommand::Test { ref skip, .. } => {
723 args.push(s.as_str());
730 Subcommand::Test { ref test_args, .. } | Subcommand::Bench { ref test_args, .. } => {
731 args.extend(test_args.iter().flat_map(|s| s.split_whitespace()))
739 pub fn rustc_args(&self) -> Vec<&str> {
741 Subcommand::Test { ref rustc_args, .. } => {
742 rustc_args.iter().flat_map(|s| s.split_whitespace()).collect()
748 pub fn fail_fast(&self) -> bool {
750 Subcommand::Test { fail_fast, .. } => fail_fast,
755 pub fn doc_tests(&self) -> DocTests {
757 Subcommand::Test { doc_tests, .. } => doc_tests,
762 pub fn bless(&self) -> bool {
764 Subcommand::Test { bless, .. } => bless,
769 pub fn force_rerun(&self) -> bool {
771 Subcommand::Test { force_rerun, .. } => force_rerun,
776 pub fn rustfix_coverage(&self) -> bool {
778 Subcommand::Test { rustfix_coverage, .. } => rustfix_coverage,
783 pub fn compare_mode(&self) -> Option<&str> {
785 Subcommand::Test { ref compare_mode, .. } => compare_mode.as_ref().map(|s| &s[..]),
790 pub fn pass(&self) -> Option<&str> {
792 Subcommand::Test { ref pass, .. } => pass.as_ref().map(|s| &s[..]),
797 pub fn run(&self) -> Option<&str> {
799 Subcommand::Test { ref run, .. } => run.as_ref().map(|s| &s[..]),
804 pub fn open(&self) -> bool {
806 Subcommand::Doc { open, .. } => open,
812 fn split(s: &[String]) -> Vec<String> {
813 s.iter().flat_map(|s| s.split(',')).filter(|s| !s.is_empty()).map(|s| s.to_string()).collect()
816 fn parse_deny_warnings(matches: &getopts::Matches) -> Option<bool> {
817 match matches.opt_str("warnings").as_deref() {
818 Some("deny") => Some(true),
819 Some("warn") => Some(false),
821 eprintln!(r#"invalid value for --warnings: {:?}, expected "warn" or "deny""#, value,);
822 crate::detail_exit(1);