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,
84 #[cfg_attr(test, derive(Clone))]
95 clippy_lint_allow: Vec<String>,
96 clippy_lint_deny: Vec<String>,
97 clippy_lint_warn: Vec<String>,
98 clippy_lint_forbid: Vec<String>,
114 /// Whether to automatically update stderr/stdout files
117 compare_mode: Option<String>,
118 pass: Option<String>,
120 test_args: Vec<String>,
121 rustc_args: Vec<String>,
124 rustfix_coverage: bool,
128 test_args: Vec<String>,
147 impl Default for Subcommand {
148 fn default() -> Subcommand {
149 Subcommand::Build { paths: vec![PathBuf::from("nowhere")] }
154 pub fn parse(args: &[String]) -> Flags {
155 let mut subcommand_help = String::from(
157 Usage: x.py <subcommand> [options] [<paths>...]
160 build, b Compile either the compiler or libraries
161 check, c Compile either the compiler or libraries, using cargo check
162 clippy Run clippy (uses rustup/cargo-installed clippy binary)
165 test, t Build and run some test suites
166 bench Build and run some benchmarks
167 doc, d Build documentation
168 clean Clean out build directories
169 dist Build distribution artifacts
170 install Install distribution artifacts
171 run, r Run tools contained in this repository
172 setup Create a config.toml (making it easier to use `x.py` itself)
174 To learn more about a subcommand, run `./x.py <subcommand> -h`",
177 let mut opts = Options::new();
178 // Options common to all subcommands
179 opts.optflagmulti("v", "verbose", "use verbose output (-vv for very verbose)");
180 opts.optflag("i", "incremental", "use incremental compilation");
181 opts.optopt("", "config", "TOML configuration file for build", "FILE");
185 "Build directory, overrides `build.build-dir` in `config.toml`",
188 opts.optopt("", "build", "build target of the stage0 compiler", "BUILD");
189 opts.optmulti("", "host", "host targets to build", "HOST");
190 opts.optmulti("", "target", "target targets to build", "TARGET");
191 opts.optmulti("", "exclude", "build paths to exclude", "PATH");
194 "include-default-paths",
195 "include default paths in addition to the provided ones",
197 opts.optopt("", "on-fail", "command to run on failure", "CMD");
198 opts.optflag("", "dry-run", "dry run; don't build anything");
202 "stage to build (indicates compiler to use/test, e.g., stage 0 uses the \
203 bootstrap compiler, stage 1 the stage 0 rustc artifacts, etc.)",
209 "stage(s) to keep without recompiling \
210 (pass multiple times to keep e.g., both stages 0 and 1)",
216 "stage(s) of the standard library to keep without recompiling \
217 (pass multiple times to keep e.g., both stages 0 and 1)",
220 opts.optopt("", "src", "path to the root of the rust checkout", "DIR");
222 "number of jobs to run in parallel; \
223 defaults to {} (this host's logical CPU count)",
224 std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get)
226 opts.optopt("j", "jobs", &j_msg, "JOBS");
227 opts.optflag("h", "help", "print this help message");
231 "if value is deny, will deny warnings, otherwise use default",
234 opts.optopt("", "error-format", "rustc error format", "FORMAT");
235 opts.optflag("", "json-output", "use message-format=json");
236 opts.optopt("", "color", "whether to use color in cargo and rustc output", "STYLE");
240 "whether rebuilding llvm should be skipped \
241 a VALUE of TRUE indicates that llvm will not be rebuilt \
242 VALUE overrides the skip-rebuild option in config.toml.",
247 "rust-profile-generate",
248 "generate PGO profile with rustc build",
251 opts.optopt("", "rust-profile-use", "use PGO profile for rustc build", "PROFILE");
252 opts.optflag("", "llvm-profile-generate", "generate PGO profile with llvm built for rustc");
253 opts.optopt("", "llvm-profile-use", "use PGO profile for llvm build", "PROFILE");
254 opts.optmulti("A", "", "allow certain clippy lints", "OPT");
255 opts.optmulti("D", "", "deny certain clippy lints", "OPT");
256 opts.optmulti("W", "", "warn about certain clippy lints", "OPT");
257 opts.optmulti("F", "", "forbid certain clippy lints", "OPT");
259 // We can't use getopt to parse the options until we have completed specifying which
260 // options are valid, but under the current implementation, some options are conditional on
261 // the subcommand. Therefore we must manually identify the subcommand first, so that we can
262 // complete the definition of the options. Then we can use the getopt::Matches object from
264 let subcommand = match args.iter().find_map(|s| Kind::parse(&s)) {
267 // No or an invalid subcommand -- show the general usage and subcommand help
268 // An exit code will be 0 when no subcommand is given, and 1 in case of an invalid
270 println!("{}\n", subcommand_help);
271 let exit_code = if args.is_empty() { 0 } else { 1 };
272 crate::detail_exit(exit_code);
276 // Some subcommands get extra options
279 opts.optflag("", "no-fail-fast", "Run all tests regardless of failure");
280 opts.optmulti("", "skip", "skips tests matching SUBSTRING, if supported by test tool. May be passed multiple times", "SUBSTRING");
284 "extra arguments to be passed for the test tool being used \
285 (e.g. libtest, compiletest or rustdoc)",
291 "extra options to pass the compiler when running tests",
294 opts.optflag("", "no-doc", "do not run doc tests");
295 opts.optflag("", "doc", "only run doc tests");
296 opts.optflag("", "bless", "update all stderr/stdout files of failing ui tests");
297 opts.optflag("", "force-rerun", "rerun tests even if the inputs are unchanged");
301 "mode describing what file the actual ui output will be compared to",
307 "force {check,build,run}-pass tests to this mode.",
308 "check | build | run",
310 opts.optopt("", "run", "whether to execute run-* tests", "auto | always | never");
314 "enable this to generate a Rustfix coverage file, which is saved in \
315 `/<build_base>/rustfix_missing_coverage.txt`",
319 opts.optflag("", "all-targets", "Check all targets");
322 opts.optmulti("", "test-args", "extra arguments", "ARGS");
325 opts.optflag("", "fix", "automatically apply lint suggestions");
328 opts.optflag("", "open", "open the docs in a browser");
332 "render the documentation in JSON format in addition to the usual HTML format",
336 opts.optflag("", "all", "clean all build artifacts");
339 opts.optflag("", "check", "check formatting instead of applying.");
345 let usage = |exit_code: i32, opts: &Options, verbose: bool, subcommand_help: &str| -> ! {
346 let config = Config::parse(&["build".to_string()]);
347 let build = Build::new(config);
348 let paths = Builder::get_help(&build, subcommand);
350 println!("{}", opts.usage(subcommand_help));
351 if let Some(s) = paths {
356 "Run `./x.py {} -h -v` to see a list of available paths.",
361 panic!("No paths available for subcommand `{}`", subcommand.as_str());
363 crate::detail_exit(exit_code);
366 // Done specifying what options are possible, so do the getopts parsing
367 let matches = opts.parse(args).unwrap_or_else(|e| {
368 // Invalid argument/option format
369 println!("\n{}\n", e);
370 usage(1, &opts, false, &subcommand_help);
373 // Extra sanity check to make sure we didn't hit this crazy corner case:
375 // ./x.py --frobulate clean build
376 // ^-- option ^ ^- actual subcommand
377 // \_ arg to option could be mistaken as subcommand
378 let mut pass_sanity_check = true;
379 match matches.free.get(0).and_then(|s| Kind::parse(&s)) {
380 Some(check_subcommand) => {
381 if check_subcommand != subcommand {
382 pass_sanity_check = false;
386 pass_sanity_check = false;
389 if !pass_sanity_check {
390 eprintln!("{}\n", subcommand_help);
392 "Sorry, I couldn't figure out which subcommand you were trying to specify.\n\
393 You may need to move some options to after the subcommand.\n"
395 crate::detail_exit(1);
397 // Extra help text for some commands
400 subcommand_help.push_str(
403 This subcommand accepts a number of paths to directories to the crates
404 and/or artifacts to compile. For example, for a quick build of a usable
407 ./x.py build --stage 1 library/std
409 This will build a compiler and standard library from the local source code.
410 Once this is done, build/$ARCH/stage1 contains a usable compiler.
412 If no arguments are passed then the default artifacts for that stage are
413 compiled. For example:
415 ./x.py build --stage 0
420 subcommand_help.push_str(
423 This subcommand accepts a number of paths to directories to the crates
424 and/or artifacts to compile. For example:
426 ./x.py check library/std
428 If no arguments are passed then many artifacts are checked.",
432 subcommand_help.push_str(
435 This subcommand accepts a number of paths to directories to the crates
436 and/or artifacts to run clippy against. For example:
438 ./x.py clippy library/core
439 ./x.py clippy library/core library/proc_macro",
443 subcommand_help.push_str(
446 This subcommand accepts a number of paths to directories to the crates
447 and/or artifacts to run `cargo fix` against. For example:
449 ./x.py fix library/core
450 ./x.py fix library/core library/proc_macro",
454 subcommand_help.push_str(
457 This subcommand optionally accepts a `--check` flag which succeeds if formatting is correct and
458 fails if it is not. For example:
465 subcommand_help.push_str(
468 This subcommand accepts a number of paths to test directories that
469 should be compiled and run. For example:
471 ./x.py test src/test/ui
472 ./x.py test library/std --test-args hash_map
473 ./x.py test library/std --stage 0 --no-doc
474 ./x.py test src/test/ui --bless
475 ./x.py test src/test/ui --compare-mode chalk
477 Note that `test src/test/* --stage N` does NOT depend on `build compiler/rustc --stage N`;
478 just like `build library/std --stage N` it tests the compiler produced by the previous
481 Execute tool tests with a tool name argument:
485 If no arguments are passed then the complete artifacts for that stage are
489 ./x.py test --stage 1",
493 subcommand_help.push_str(
496 This subcommand accepts a number of paths to directories of documentation
497 to build. For example:
499 ./x.py doc src/doc/book
500 ./x.py doc src/doc/nomicon
501 ./x.py doc src/doc/book library/std
502 ./x.py doc library/std --json
503 ./x.py doc library/std --open
505 If no arguments are passed then everything is documented:
508 ./x.py doc --stage 1",
512 subcommand_help.push_str(
515 This subcommand accepts a number of paths to tools to build and run. For
518 ./x.py run src/tools/expand-yaml-anchors
520 At least a tool needs to be called.",
524 subcommand_help.push_str(&format!(
526 x.py setup creates a `config.toml` which changes the defaults for x.py itself.
529 This subcommand accepts a 'profile' to use for builds. For example:
533 The profile is optional and you will be prompted interactively if it is not given.
534 The following profiles are available:
537 Profile::all_for_help(" ").trim_end()
540 Kind::Bench | Kind::Clean | Kind::Dist | Kind::Install => {}
542 // Get any optional paths which occur after the subcommand
543 let mut paths = matches.free[1..].iter().map(|p| p.into()).collect::<Vec<PathBuf>>();
545 let verbose = matches.opt_present("verbose");
547 // User passed in -h/--help?
548 if matches.opt_present("help") {
549 usage(0, &opts, verbose, &subcommand_help);
552 let cmd = match subcommand {
553 Kind::Build => Subcommand::Build { paths },
555 if matches.opt_present("all-targets") {
557 "Warning: --all-targets is now on by default and does not need to be passed explicitly."
560 Subcommand::Check { paths }
562 Kind::Clippy => Subcommand::Clippy {
564 fix: matches.opt_present("fix"),
565 clippy_lint_allow: matches.opt_strs("A"),
566 clippy_lint_warn: matches.opt_strs("W"),
567 clippy_lint_deny: matches.opt_strs("D"),
568 clippy_lint_forbid: matches.opt_strs("F"),
570 Kind::Fix => Subcommand::Fix { paths },
571 Kind::Test => Subcommand::Test {
573 bless: matches.opt_present("bless"),
574 force_rerun: matches.opt_present("force-rerun"),
575 compare_mode: matches.opt_str("compare-mode"),
576 pass: matches.opt_str("pass"),
577 run: matches.opt_str("run"),
578 test_args: matches.opt_strs("test-args"),
579 rustc_args: matches.opt_strs("rustc-args"),
580 fail_fast: !matches.opt_present("no-fail-fast"),
581 rustfix_coverage: matches.opt_present("rustfix-coverage"),
582 doc_tests: if matches.opt_present("doc") {
584 } else if matches.opt_present("no-doc") {
590 Kind::Bench => Subcommand::Bench { paths, test_args: matches.opt_strs("test-args") },
591 Kind::Doc => Subcommand::Doc {
593 open: matches.opt_present("open"),
594 json: matches.opt_present("json"),
597 if !paths.is_empty() {
598 println!("\nclean does not take a path argument\n");
599 usage(1, &opts, verbose, &subcommand_help);
602 Subcommand::Clean { all: matches.opt_present("all") }
604 Kind::Format => Subcommand::Format { check: matches.opt_present("check"), paths },
605 Kind::Dist => Subcommand::Dist { paths },
606 Kind::Install => Subcommand::Install { paths },
608 if paths.is_empty() {
609 println!("\nrun requires at least a path!\n");
610 usage(1, &opts, verbose, &subcommand_help);
612 Subcommand::Run { paths }
615 let profile = if paths.len() > 1 {
616 println!("\nat most one profile can be passed to setup\n");
617 usage(1, &opts, verbose, &subcommand_help)
618 } else if let Some(path) = paths.pop() {
619 let profile_string = t!(path.into_os_string().into_string().map_err(
620 |path| format!("{} is not a valid UTF8 string", path.to_string_lossy())
623 profile_string.parse().unwrap_or_else(|err| {
624 eprintln!("error: {}", err);
625 eprintln!("help: the available profiles are:");
626 eprint!("{}", Profile::all_for_help("- "));
627 crate::detail_exit(1);
630 t!(crate::setup::interactive_path())
632 Subcommand::Setup { profile }
637 verbose: matches.opt_count("verbose"),
638 stage: matches.opt_str("stage").map(|j| j.parse().expect("`stage` should be a number")),
639 dry_run: matches.opt_present("dry-run"),
640 on_fail: matches.opt_str("on-fail"),
641 rustc_error_format: matches.opt_str("error-format"),
642 json_output: matches.opt_present("json-output"),
644 .opt_strs("keep-stage")
646 .map(|j| j.parse().expect("`keep-stage` should be a number"))
648 keep_stage_std: matches
649 .opt_strs("keep-stage-std")
651 .map(|j| j.parse().expect("`keep-stage-std` should be a number"))
653 host: if matches.opt_present("host") {
655 split(&matches.opt_strs("host"))
657 .map(|x| TargetSelection::from_user(&x))
658 .collect::<Vec<_>>(),
663 target: if matches.opt_present("target") {
665 split(&matches.opt_strs("target"))
667 .map(|x| TargetSelection::from_user(&x))
668 .collect::<Vec<_>>(),
673 config: matches.opt_str("config").map(PathBuf::from),
674 build_dir: matches.opt_str("build-dir").map(PathBuf::from),
675 jobs: matches.opt_str("jobs").map(|j| j.parse().expect("`jobs` should be a number")),
677 incremental: matches.opt_present("incremental"),
678 exclude: split(&matches.opt_strs("exclude"))
681 .collect::<Vec<_>>(),
682 include_default_paths: matches.opt_present("include-default-paths"),
683 deny_warnings: parse_deny_warnings(&matches),
684 llvm_skip_rebuild: matches.opt_str("llvm-skip-rebuild").map(|s| s.to_lowercase()).map(
685 |s| s.parse::<bool>().expect("`llvm-skip-rebuild` should be either true or false"),
688 .opt_get_default("color", Color::Auto)
689 .expect("`color` should be `always`, `never`, or `auto`"),
690 rust_profile_use: matches.opt_str("rust-profile-use"),
691 rust_profile_generate: matches.opt_str("rust-profile-generate"),
692 llvm_profile_use: matches.opt_str("llvm-profile-use"),
693 llvm_profile_generate: matches.opt_present("llvm-profile-generate"),
699 pub fn kind(&self) -> Kind {
701 Subcommand::Bench { .. } => Kind::Bench,
702 Subcommand::Build { .. } => Kind::Build,
703 Subcommand::Check { .. } => Kind::Check,
704 Subcommand::Clippy { .. } => Kind::Clippy,
705 Subcommand::Doc { .. } => Kind::Doc,
706 Subcommand::Fix { .. } => Kind::Fix,
707 Subcommand::Format { .. } => Kind::Format,
708 Subcommand::Test { .. } => Kind::Test,
709 Subcommand::Clean { .. } => Kind::Clean,
710 Subcommand::Dist { .. } => Kind::Dist,
711 Subcommand::Install { .. } => Kind::Install,
712 Subcommand::Run { .. } => Kind::Run,
713 Subcommand::Setup { .. } => Kind::Setup,
717 pub fn test_args(&self) -> Vec<&str> {
718 let mut args = vec![];
721 Subcommand::Test { ref test_args, .. } | Subcommand::Bench { ref test_args, .. } => {
722 args.extend(test_args.iter().flat_map(|s| s.split_whitespace()))
730 pub fn rustc_args(&self) -> Vec<&str> {
732 Subcommand::Test { ref rustc_args, .. } => {
733 rustc_args.iter().flat_map(|s| s.split_whitespace()).collect()
739 pub fn fail_fast(&self) -> bool {
741 Subcommand::Test { fail_fast, .. } => fail_fast,
746 pub fn doc_tests(&self) -> DocTests {
748 Subcommand::Test { doc_tests, .. } => doc_tests,
753 pub fn bless(&self) -> bool {
755 Subcommand::Test { bless, .. } => bless,
760 pub fn force_rerun(&self) -> bool {
762 Subcommand::Test { force_rerun, .. } => force_rerun,
767 pub fn rustfix_coverage(&self) -> bool {
769 Subcommand::Test { rustfix_coverage, .. } => rustfix_coverage,
774 pub fn compare_mode(&self) -> Option<&str> {
776 Subcommand::Test { ref compare_mode, .. } => compare_mode.as_ref().map(|s| &s[..]),
781 pub fn pass(&self) -> Option<&str> {
783 Subcommand::Test { ref pass, .. } => pass.as_ref().map(|s| &s[..]),
788 pub fn run(&self) -> Option<&str> {
790 Subcommand::Test { ref run, .. } => run.as_ref().map(|s| &s[..]),
795 pub fn open(&self) -> bool {
797 Subcommand::Doc { open, .. } => open,
802 pub fn json(&self) -> bool {
804 Subcommand::Doc { json, .. } => json,
810 fn split(s: &[String]) -> Vec<String> {
811 s.iter().flat_map(|s| s.split(',')).filter(|s| !s.is_empty()).map(|s| s.to_string()).collect()
814 fn parse_deny_warnings(matches: &getopts::Matches) -> Option<bool> {
815 match matches.opt_str("warnings").as_deref() {
816 Some("deny") => Some(true),
817 Some("warn") => Some(false),
819 eprintln!(r#"invalid value for --warnings: {:?}, expected "warn" or "deny""#, value,);
820 crate::detail_exit(1);