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))]
108 /// Whether to automatically update stderr/stdout files
111 compare_mode: Option<String>,
112 pass: Option<String>,
115 test_args: Vec<String>,
116 rustc_args: Vec<String>,
119 rustfix_coverage: bool,
123 test_args: Vec<String>,
142 impl Default for Subcommand {
143 fn default() -> Subcommand {
144 Subcommand::Build { paths: vec![PathBuf::from("nowhere")] }
149 pub fn parse(args: &[String]) -> Flags {
150 let mut subcommand_help = String::from(
152 Usage: x.py <subcommand> [options] [<paths>...]
155 build, b Compile either the compiler or libraries
156 check, c Compile either the compiler or libraries, using cargo check
157 clippy Run clippy (uses rustup/cargo-installed clippy binary)
160 test, t Build and run some test suites
161 bench Build and run some benchmarks
162 doc, d Build documentation
163 clean Clean out build directories
164 dist Build distribution artifacts
165 install Install distribution artifacts
166 run, r Run tools contained in this repository
167 setup Create a config.toml (making it easier to use `x.py` itself)
169 To learn more about a subcommand, run `./x.py <subcommand> -h`",
172 let mut opts = Options::new();
173 // Options common to all subcommands
174 opts.optflagmulti("v", "verbose", "use verbose output (-vv for very verbose)");
175 opts.optflag("i", "incremental", "use incremental compilation");
176 opts.optopt("", "config", "TOML configuration file for build", "FILE");
180 "Build directory, overrides `build.build-dir` in `config.toml`",
183 opts.optopt("", "build", "build target of the stage0 compiler", "BUILD");
184 opts.optmulti("", "host", "host targets to build", "HOST");
185 opts.optmulti("", "target", "target targets to build", "TARGET");
186 opts.optmulti("", "exclude", "build paths to exclude", "PATH");
189 "include-default-paths",
190 "include default paths in addition to the provided ones",
192 opts.optopt("", "on-fail", "command to run on failure", "CMD");
193 opts.optflag("", "dry-run", "dry run; don't build anything");
197 "stage to build (indicates compiler to use/test, e.g., stage 0 uses the \
198 bootstrap compiler, stage 1 the stage 0 rustc artifacts, etc.)",
204 "stage(s) to keep without recompiling \
205 (pass multiple times to keep e.g., both stages 0 and 1)",
211 "stage(s) of the standard library to keep without recompiling \
212 (pass multiple times to keep e.g., both stages 0 and 1)",
215 opts.optopt("", "src", "path to the root of the rust checkout", "DIR");
217 "number of jobs to run in parallel; \
218 defaults to {} (this host's logical CPU count)",
221 opts.optopt("j", "jobs", &j_msg, "JOBS");
222 opts.optflag("h", "help", "print this help message");
226 "if value is deny, will deny warnings, otherwise use default",
229 opts.optopt("", "error-format", "rustc error format", "FORMAT");
230 opts.optflag("", "json-output", "use message-format=json");
231 opts.optopt("", "color", "whether to use color in cargo and rustc output", "STYLE");
235 "whether rebuilding llvm should be skipped \
236 a VALUE of TRUE indicates that llvm will not be rebuilt \
237 VALUE overrides the skip-rebuild option in config.toml.",
242 "rust-profile-generate",
243 "generate PGO profile with rustc build",
246 opts.optopt("", "rust-profile-use", "use PGO profile for rustc build", "PROFILE");
247 opts.optflag("", "llvm-profile-generate", "generate PGO profile with llvm built for rustc");
248 opts.optopt("", "llvm-profile-use", "use PGO profile for llvm build", "PROFILE");
250 // We can't use getopt to parse the options until we have completed specifying which
251 // options are valid, but under the current implementation, some options are conditional on
252 // the subcommand. Therefore we must manually identify the subcommand first, so that we can
253 // complete the definition of the options. Then we can use the getopt::Matches object from
255 let subcommand = match args.iter().find_map(|s| Kind::parse(&s)) {
258 // No or an invalid subcommand -- show the general usage and subcommand help
259 // An exit code will be 0 when no subcommand is given, and 1 in case of an invalid
261 println!("{}\n", subcommand_help);
262 let exit_code = if args.is_empty() { 0 } else { 1 };
263 crate::detail_exit(exit_code);
267 // Some subcommands get extra options
270 opts.optflag("", "no-fail-fast", "Run all tests regardless of failure");
271 opts.optmulti("", "skip", "skips tests matching SUBSTRING, if supported by test tool. May be passed multiple times", "SUBSTRING");
275 "extra arguments to be passed for the test tool being used \
276 (e.g. libtest, compiletest or rustdoc)",
282 "extra options to pass the compiler when running tests",
285 opts.optflag("", "no-doc", "do not run doc tests");
286 opts.optflag("", "doc", "only run doc tests");
287 opts.optflag("", "bless", "update all stderr/stdout files of failing ui tests");
288 opts.optflag("", "force-rerun", "rerun tests even if the inputs are unchanged");
292 "mode describing what file the actual ui output will be compared to",
298 "force {check,build,run}-pass tests to this mode.",
299 "check | build | run",
301 opts.optopt("", "run", "whether to execute run-* tests", "auto | always | never");
305 "enable this to generate a Rustfix coverage file, which is saved in \
306 `/<build_base>/rustfix_missing_coverage.txt`",
310 opts.optflag("", "all-targets", "Check all targets");
313 opts.optmulti("", "test-args", "extra arguments", "ARGS");
316 opts.optflag("", "fix", "automatically apply lint suggestions");
319 opts.optflag("", "open", "open the docs in a browser");
322 opts.optflag("", "all", "clean all build artifacts");
325 opts.optflag("", "check", "check formatting instead of applying.");
331 let usage = |exit_code: i32, opts: &Options, verbose: bool, subcommand_help: &str| -> ! {
332 let config = Config::parse(&["build".to_string()]);
333 let build = Build::new(config);
334 let paths = Builder::get_help(&build, subcommand);
336 println!("{}", opts.usage(subcommand_help));
337 if let Some(s) = paths {
342 "Run `./x.py {} -h -v` to see a list of available paths.",
347 panic!("No paths available for subcommand `{}`", subcommand.as_str());
349 crate::detail_exit(exit_code);
352 // Done specifying what options are possible, so do the getopts parsing
353 let matches = opts.parse(args).unwrap_or_else(|e| {
354 // Invalid argument/option format
355 println!("\n{}\n", e);
356 usage(1, &opts, false, &subcommand_help);
359 // Extra sanity check to make sure we didn't hit this crazy corner case:
361 // ./x.py --frobulate clean build
362 // ^-- option ^ ^- actual subcommand
363 // \_ arg to option could be mistaken as subcommand
364 let mut pass_sanity_check = true;
365 match matches.free.get(0).and_then(|s| Kind::parse(&s)) {
366 Some(check_subcommand) => {
367 if check_subcommand != subcommand {
368 pass_sanity_check = false;
372 pass_sanity_check = false;
375 if !pass_sanity_check {
376 eprintln!("{}\n", subcommand_help);
378 "Sorry, I couldn't figure out which subcommand you were trying to specify.\n\
379 You may need to move some options to after the subcommand.\n"
381 crate::detail_exit(1);
383 // Extra help text for some commands
386 subcommand_help.push_str(
389 This subcommand accepts a number of paths to directories to the crates
390 and/or artifacts to compile. For example, for a quick build of a usable
393 ./x.py build --stage 1 library/std
395 This will build a compiler and standard library from the local source code.
396 Once this is done, build/$ARCH/stage1 contains a usable compiler.
398 If no arguments are passed then the default artifacts for that stage are
399 compiled. For example:
401 ./x.py build --stage 0
406 subcommand_help.push_str(
409 This subcommand accepts a number of paths to directories to the crates
410 and/or artifacts to compile. For example:
412 ./x.py check library/std
414 If no arguments are passed then many artifacts are checked.",
418 subcommand_help.push_str(
421 This subcommand accepts a number of paths to directories to the crates
422 and/or artifacts to run clippy against. For example:
424 ./x.py clippy library/core
425 ./x.py clippy library/core library/proc_macro",
429 subcommand_help.push_str(
432 This subcommand accepts a number of paths to directories to the crates
433 and/or artifacts to run `cargo fix` against. For example:
435 ./x.py fix library/core
436 ./x.py fix library/core library/proc_macro",
440 subcommand_help.push_str(
443 This subcommand optionally accepts a `--check` flag which succeeds if formatting is correct and
444 fails if it is not. For example:
451 subcommand_help.push_str(
454 This subcommand accepts a number of paths to test directories that
455 should be compiled and run. For example:
457 ./x.py test src/test/ui
458 ./x.py test library/std --test-args hash_map
459 ./x.py test library/std --stage 0 --no-doc
460 ./x.py test src/test/ui --bless
461 ./x.py test src/test/ui --compare-mode chalk
463 Note that `test src/test/* --stage N` does NOT depend on `build compiler/rustc --stage N`;
464 just like `build library/std --stage N` it tests the compiler produced by the previous
467 Execute tool tests with a tool name argument:
471 If no arguments are passed then the complete artifacts for that stage are
475 ./x.py test --stage 1",
479 subcommand_help.push_str(
482 This subcommand accepts a number of paths to directories of documentation
483 to build. For example:
485 ./x.py doc src/doc/book
486 ./x.py doc src/doc/nomicon
487 ./x.py doc src/doc/book library/std
488 ./x.py doc library/std --open
490 If no arguments are passed then everything is documented:
493 ./x.py doc --stage 1",
497 subcommand_help.push_str(
500 This subcommand accepts a number of paths to tools to build and run. For
503 ./x.py run src/tools/expand-yaml-anchors
505 At least a tool needs to be called.",
509 subcommand_help.push_str(&format!(
511 x.py setup creates a `config.toml` which changes the defaults for x.py itself.
514 This subcommand accepts a 'profile' to use for builds. For example:
518 The profile is optional and you will be prompted interactively if it is not given.
519 The following profiles are available:
522 Profile::all_for_help(" ").trim_end()
525 Kind::Bench | Kind::Clean | Kind::Dist | Kind::Install => {}
527 // Get any optional paths which occur after the subcommand
528 let mut paths = matches.free[1..].iter().map(|p| p.into()).collect::<Vec<PathBuf>>();
530 let verbose = matches.opt_present("verbose");
532 // User passed in -h/--help?
533 if matches.opt_present("help") {
534 usage(0, &opts, verbose, &subcommand_help);
537 let cmd = match subcommand {
538 Kind::Build => Subcommand::Build { paths },
540 if matches.opt_present("all-targets") {
542 "Warning: --all-targets is now on by default and does not need to be passed explicitly."
545 Subcommand::Check { paths }
547 Kind::Clippy => Subcommand::Clippy { paths, fix: matches.opt_present("fix") },
548 Kind::Fix => Subcommand::Fix { paths },
549 Kind::Test => Subcommand::Test {
551 bless: matches.opt_present("bless"),
552 force_rerun: matches.opt_present("force-rerun"),
553 compare_mode: matches.opt_str("compare-mode"),
554 pass: matches.opt_str("pass"),
555 run: matches.opt_str("run"),
556 skip: matches.opt_strs("skip"),
557 test_args: matches.opt_strs("test-args"),
558 rustc_args: matches.opt_strs("rustc-args"),
559 fail_fast: !matches.opt_present("no-fail-fast"),
560 rustfix_coverage: matches.opt_present("rustfix-coverage"),
561 doc_tests: if matches.opt_present("doc") {
563 } else if matches.opt_present("no-doc") {
569 Kind::Bench => Subcommand::Bench { paths, test_args: matches.opt_strs("test-args") },
570 Kind::Doc => Subcommand::Doc { paths, open: matches.opt_present("open") },
572 if !paths.is_empty() {
573 println!("\nclean does not take a path argument\n");
574 usage(1, &opts, verbose, &subcommand_help);
577 Subcommand::Clean { all: matches.opt_present("all") }
579 Kind::Format => Subcommand::Format { check: matches.opt_present("check"), paths },
580 Kind::Dist => Subcommand::Dist { paths },
581 Kind::Install => Subcommand::Install { paths },
583 if paths.is_empty() {
584 println!("\nrun requires at least a path!\n");
585 usage(1, &opts, verbose, &subcommand_help);
587 Subcommand::Run { paths }
590 let profile = if paths.len() > 1 {
591 println!("\nat most one profile can be passed to setup\n");
592 usage(1, &opts, verbose, &subcommand_help)
593 } else if let Some(path) = paths.pop() {
594 let profile_string = t!(path.into_os_string().into_string().map_err(
595 |path| format!("{} is not a valid UTF8 string", path.to_string_lossy())
598 profile_string.parse().unwrap_or_else(|err| {
599 eprintln!("error: {}", err);
600 eprintln!("help: the available profiles are:");
601 eprint!("{}", Profile::all_for_help("- "));
602 crate::detail_exit(1);
605 t!(crate::setup::interactive_path())
607 Subcommand::Setup { profile }
611 if let Subcommand::Check { .. } = &cmd {
612 if matches.opt_str("keep-stage").is_some()
613 || matches.opt_str("keep-stage-std").is_some()
615 eprintln!("--keep-stage not yet supported for x.py check");
616 crate::detail_exit(1);
621 verbose: matches.opt_count("verbose"),
622 stage: matches.opt_str("stage").map(|j| j.parse().expect("`stage` should be a number")),
623 dry_run: matches.opt_present("dry-run"),
624 on_fail: matches.opt_str("on-fail"),
625 rustc_error_format: matches.opt_str("error-format"),
626 json_output: matches.opt_present("json-output"),
628 .opt_strs("keep-stage")
630 .map(|j| j.parse().expect("`keep-stage` should be a number"))
632 keep_stage_std: matches
633 .opt_strs("keep-stage-std")
635 .map(|j| j.parse().expect("`keep-stage-std` should be a number"))
637 host: if matches.opt_present("host") {
639 split(&matches.opt_strs("host"))
641 .map(|x| TargetSelection::from_user(&x))
642 .collect::<Vec<_>>(),
647 target: if matches.opt_present("target") {
649 split(&matches.opt_strs("target"))
651 .map(|x| TargetSelection::from_user(&x))
652 .collect::<Vec<_>>(),
657 config: matches.opt_str("config").map(PathBuf::from),
658 build_dir: matches.opt_str("build-dir").map(PathBuf::from),
659 jobs: matches.opt_str("jobs").map(|j| j.parse().expect("`jobs` should be a number")),
661 incremental: matches.opt_present("incremental"),
662 exclude: split(&matches.opt_strs("exclude"))
665 .collect::<Vec<_>>(),
666 include_default_paths: matches.opt_present("include-default-paths"),
667 deny_warnings: parse_deny_warnings(&matches),
668 llvm_skip_rebuild: matches.opt_str("llvm-skip-rebuild").map(|s| s.to_lowercase()).map(
669 |s| s.parse::<bool>().expect("`llvm-skip-rebuild` should be either true or false"),
672 .opt_get_default("color", Color::Auto)
673 .expect("`color` should be `always`, `never`, or `auto`"),
674 rust_profile_use: matches.opt_str("rust-profile-use"),
675 rust_profile_generate: matches.opt_str("rust-profile-generate"),
676 llvm_profile_use: matches.opt_str("llvm-profile-use"),
677 llvm_profile_generate: matches.opt_present("llvm-profile-generate"),
683 pub fn kind(&self) -> Kind {
685 Subcommand::Bench { .. } => Kind::Bench,
686 Subcommand::Build { .. } => Kind::Build,
687 Subcommand::Check { .. } => Kind::Check,
688 Subcommand::Clippy { .. } => Kind::Clippy,
689 Subcommand::Doc { .. } => Kind::Doc,
690 Subcommand::Fix { .. } => Kind::Fix,
691 Subcommand::Format { .. } => Kind::Format,
692 Subcommand::Test { .. } => Kind::Test,
693 Subcommand::Clean { .. } => Kind::Clean,
694 Subcommand::Dist { .. } => Kind::Dist,
695 Subcommand::Install { .. } => Kind::Install,
696 Subcommand::Run { .. } => Kind::Run,
697 Subcommand::Setup { .. } => Kind::Setup,
701 pub fn test_args(&self) -> Vec<&str> {
702 let mut args = vec![];
705 Subcommand::Test { ref skip, .. } => {
708 args.push(s.as_str());
715 Subcommand::Test { ref test_args, .. } | Subcommand::Bench { ref test_args, .. } => {
716 args.extend(test_args.iter().flat_map(|s| s.split_whitespace()))
724 pub fn rustc_args(&self) -> Vec<&str> {
726 Subcommand::Test { ref rustc_args, .. } => {
727 rustc_args.iter().flat_map(|s| s.split_whitespace()).collect()
733 pub fn fail_fast(&self) -> bool {
735 Subcommand::Test { fail_fast, .. } => fail_fast,
740 pub fn doc_tests(&self) -> DocTests {
742 Subcommand::Test { doc_tests, .. } => doc_tests,
747 pub fn bless(&self) -> bool {
749 Subcommand::Test { bless, .. } => bless,
754 pub fn force_rerun(&self) -> bool {
756 Subcommand::Test { force_rerun, .. } => force_rerun,
761 pub fn rustfix_coverage(&self) -> bool {
763 Subcommand::Test { rustfix_coverage, .. } => rustfix_coverage,
768 pub fn compare_mode(&self) -> Option<&str> {
770 Subcommand::Test { ref compare_mode, .. } => compare_mode.as_ref().map(|s| &s[..]),
775 pub fn pass(&self) -> Option<&str> {
777 Subcommand::Test { ref pass, .. } => pass.as_ref().map(|s| &s[..]),
782 pub fn run(&self) -> Option<&str> {
784 Subcommand::Test { ref run, .. } => run.as_ref().map(|s| &s[..]),
789 pub fn open(&self) -> bool {
791 Subcommand::Doc { open, .. } => open,
797 fn split(s: &[String]) -> Vec<String> {
798 s.iter().flat_map(|s| s.split(',')).filter(|s| !s.is_empty()).map(|s| s.to_string()).collect()
801 fn parse_deny_warnings(matches: &getopts::Matches) -> Option<bool> {
802 match matches.opt_str("warnings").as_deref() {
803 Some("deny") => Some(true),
804 Some("warn") => Some(false),
806 eprintln!(r#"invalid value for --warnings: {:?}, expected "warn" or "deny""#, value,);
807 crate::detail_exit(1);