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,
81 pub llvm_bolt_profile_generate: bool,
82 pub llvm_bolt_profile_use: Option<String>,
86 #[cfg_attr(test, derive(Clone))]
97 clippy_lint_allow: Vec<String>,
98 clippy_lint_deny: Vec<String>,
99 clippy_lint_warn: Vec<String>,
100 clippy_lint_forbid: Vec<String>,
116 /// Whether to automatically update stderr/stdout files
119 compare_mode: Option<String>,
120 pass: Option<String>,
122 test_args: Vec<String>,
123 rustc_args: Vec<String>,
126 rustfix_coverage: bool,
130 test_args: Vec<String>,
146 profile: Option<PathBuf>,
150 impl Default for Subcommand {
151 fn default() -> Subcommand {
152 Subcommand::Build { paths: vec![PathBuf::from("nowhere")] }
157 pub fn parse(args: &[String]) -> Flags {
158 let mut subcommand_help = String::from(
160 Usage: x.py <subcommand> [options] [<paths>...]
163 build, b Compile either the compiler or libraries
164 check, c Compile either the compiler or libraries, using cargo check
165 clippy Run clippy (uses rustup/cargo-installed clippy binary)
168 test, t Build and run some test suites
169 bench Build and run some benchmarks
170 doc, d Build documentation
171 clean Clean out build directories
172 dist Build distribution artifacts
173 install Install distribution artifacts
174 run, r Run tools contained in this repository
175 setup Create a config.toml (making it easier to use `x.py` itself)
177 To learn more about a subcommand, run `./x.py <subcommand> -h`",
180 let mut opts = Options::new();
181 // Options common to all subcommands
182 opts.optflagmulti("v", "verbose", "use verbose output (-vv for very verbose)");
183 opts.optflag("i", "incremental", "use incremental compilation");
184 opts.optopt("", "config", "TOML configuration file for build", "FILE");
188 "Build directory, overrides `build.build-dir` in `config.toml`",
191 opts.optopt("", "build", "build target of the stage0 compiler", "BUILD");
192 opts.optmulti("", "host", "host targets to build", "HOST");
193 opts.optmulti("", "target", "target targets to build", "TARGET");
194 opts.optmulti("", "exclude", "build paths to exclude", "PATH");
197 "include-default-paths",
198 "include default paths in addition to the provided ones",
200 opts.optopt("", "on-fail", "command to run on failure", "CMD");
201 opts.optflag("", "dry-run", "dry run; don't build anything");
205 "stage to build (indicates compiler to use/test, e.g., stage 0 uses the \
206 bootstrap compiler, stage 1 the stage 0 rustc artifacts, etc.)",
212 "stage(s) to keep without recompiling \
213 (pass multiple times to keep e.g., both stages 0 and 1)",
219 "stage(s) of the standard library to keep without recompiling \
220 (pass multiple times to keep e.g., both stages 0 and 1)",
223 opts.optopt("", "src", "path to the root of the rust checkout", "DIR");
225 "number of jobs to run in parallel; \
226 defaults to {} (this host's logical CPU count)",
227 std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get)
229 opts.optopt("j", "jobs", &j_msg, "JOBS");
230 opts.optflag("h", "help", "print this help message");
234 "if value is deny, will deny warnings, otherwise use default",
237 opts.optopt("", "error-format", "rustc error format", "FORMAT");
238 opts.optflag("", "json-output", "use message-format=json");
239 opts.optopt("", "color", "whether to use color in cargo and rustc output", "STYLE");
243 "whether rebuilding llvm should be skipped \
244 a VALUE of TRUE indicates that llvm will not be rebuilt \
245 VALUE overrides the skip-rebuild option in config.toml.",
250 "rust-profile-generate",
251 "generate PGO profile with rustc build",
254 opts.optopt("", "rust-profile-use", "use PGO profile for rustc build", "PROFILE");
255 opts.optflag("", "llvm-profile-generate", "generate PGO profile with llvm built for rustc");
256 opts.optopt("", "llvm-profile-use", "use PGO profile for llvm build", "PROFILE");
257 opts.optmulti("A", "", "allow certain clippy lints", "OPT");
258 opts.optmulti("D", "", "deny certain clippy lints", "OPT");
259 opts.optmulti("W", "", "warn about certain clippy lints", "OPT");
260 opts.optmulti("F", "", "forbid certain clippy lints", "OPT");
261 opts.optflag("", "llvm-bolt-profile-generate", "generate BOLT profile for LLVM build");
262 opts.optopt("", "llvm-bolt-profile-use", "use BOLT profile for LLVM build", "PROFILE");
264 // We can't use getopt to parse the options until we have completed specifying which
265 // options are valid, but under the current implementation, some options are conditional on
266 // the subcommand. Therefore we must manually identify the subcommand first, so that we can
267 // complete the definition of the options. Then we can use the getopt::Matches object from
269 let subcommand = match args.iter().find_map(|s| Kind::parse(&s)) {
272 // No or an invalid subcommand -- show the general usage and subcommand help
273 // An exit code will be 0 when no subcommand is given, and 1 in case of an invalid
275 println!("{}\n", subcommand_help);
276 let exit_code = if args.is_empty() { 0 } else { 1 };
277 crate::detail_exit(exit_code);
281 // Some subcommands get extra options
284 opts.optflag("", "no-fail-fast", "Run all tests regardless of failure");
285 opts.optmulti("", "skip", "skips tests matching SUBSTRING, if supported by test tool. May be passed multiple times", "SUBSTRING");
289 "extra arguments to be passed for the test tool being used \
290 (e.g. libtest, compiletest or rustdoc)",
296 "extra options to pass the compiler when running tests",
299 opts.optflag("", "no-doc", "do not run doc tests");
300 opts.optflag("", "doc", "only run doc tests");
301 opts.optflag("", "bless", "update all stderr/stdout files of failing ui tests");
302 opts.optflag("", "force-rerun", "rerun tests even if the inputs are unchanged");
306 "mode describing what file the actual ui output will be compared to",
312 "force {check,build,run}-pass tests to this mode.",
313 "check | build | run",
315 opts.optopt("", "run", "whether to execute run-* tests", "auto | always | never");
319 "enable this to generate a Rustfix coverage file, which is saved in \
320 `/<build_base>/rustfix_missing_coverage.txt`",
324 opts.optflag("", "all-targets", "Check all targets");
327 opts.optmulti("", "test-args", "extra arguments", "ARGS");
330 opts.optflag("", "fix", "automatically apply lint suggestions");
333 opts.optflag("", "open", "open the docs in a browser");
337 "render the documentation in JSON format in addition to the usual HTML format",
341 opts.optflag("", "all", "clean all build artifacts");
344 opts.optflag("", "check", "check formatting instead of applying.");
347 opts.optmulti("", "args", "arguments for the tool", "ARGS");
353 let usage = |exit_code: i32, opts: &Options, verbose: bool, subcommand_help: &str| -> ! {
354 let config = Config::parse(&["setup".to_string()]);
355 let build = Build::new(config);
356 let paths = Builder::get_help(&build, subcommand);
358 println!("{}", opts.usage(subcommand_help));
359 if let Some(s) = paths {
364 "Run `./x.py {} -h -v` to see a list of available paths.",
369 panic!("No paths available for subcommand `{}`", subcommand.as_str());
371 crate::detail_exit(exit_code);
374 // Done specifying what options are possible, so do the getopts parsing
375 let matches = opts.parse(args).unwrap_or_else(|e| {
376 // Invalid argument/option format
377 println!("\n{}\n", e);
378 usage(1, &opts, false, &subcommand_help);
381 // Extra sanity check to make sure we didn't hit this crazy corner case:
383 // ./x.py --frobulate clean build
384 // ^-- option ^ ^- actual subcommand
385 // \_ arg to option could be mistaken as subcommand
386 let mut pass_sanity_check = true;
387 match matches.free.get(0).and_then(|s| Kind::parse(&s)) {
388 Some(check_subcommand) => {
389 if check_subcommand != subcommand {
390 pass_sanity_check = false;
394 pass_sanity_check = false;
397 if !pass_sanity_check {
398 eprintln!("{}\n", subcommand_help);
400 "Sorry, I couldn't figure out which subcommand you were trying to specify.\n\
401 You may need to move some options to after the subcommand.\n"
403 crate::detail_exit(1);
405 // Extra help text for some commands
408 subcommand_help.push_str(
411 This subcommand accepts a number of paths to directories to the crates
412 and/or artifacts to compile. For example, for a quick build of a usable
415 ./x.py build --stage 1 library/std
417 This will build a compiler and standard library from the local source code.
418 Once this is done, build/$ARCH/stage1 contains a usable compiler.
420 If no arguments are passed then the default artifacts for that stage are
421 compiled. For example:
423 ./x.py build --stage 0
428 subcommand_help.push_str(
431 This subcommand accepts a number of paths to directories to the crates
432 and/or artifacts to compile. For example:
434 ./x.py check library/std
436 If no arguments are passed then many artifacts are checked.",
440 subcommand_help.push_str(
443 This subcommand accepts a number of paths to directories to the crates
444 and/or artifacts to run clippy against. For example:
446 ./x.py clippy library/core
447 ./x.py clippy library/core library/proc_macro",
451 subcommand_help.push_str(
454 This subcommand accepts a number of paths to directories to the crates
455 and/or artifacts to run `cargo fix` against. For example:
457 ./x.py fix library/core
458 ./x.py fix library/core library/proc_macro",
462 subcommand_help.push_str(
465 This subcommand optionally accepts a `--check` flag which succeeds if formatting is correct and
466 fails if it is not. For example:
473 subcommand_help.push_str(
476 This subcommand accepts a number of paths to test directories that
477 should be compiled and run. For example:
479 ./x.py test src/test/ui
480 ./x.py test library/std --test-args hash_map
481 ./x.py test library/std --stage 0 --no-doc
482 ./x.py test src/test/ui --bless
483 ./x.py test src/test/ui --compare-mode chalk
485 Note that `test src/test/* --stage N` does NOT depend on `build compiler/rustc --stage N`;
486 just like `build library/std --stage N` it tests the compiler produced by the previous
489 Execute tool tests with a tool name argument:
493 If no arguments are passed then the complete artifacts for that stage are
497 ./x.py test --stage 1",
501 subcommand_help.push_str(
504 This subcommand accepts a number of paths to directories of documentation
505 to build. For example:
507 ./x.py doc src/doc/book
508 ./x.py doc src/doc/nomicon
509 ./x.py doc src/doc/book library/std
510 ./x.py doc library/std --json
511 ./x.py doc library/std --open
513 If no arguments are passed then everything is documented:
516 ./x.py doc --stage 1",
520 subcommand_help.push_str(
523 This subcommand accepts a number of paths to tools to build and run. For
526 ./x.py run src/tools/expand-yaml-anchors
528 At least a tool needs to be called.",
532 subcommand_help.push_str(&format!(
534 x.py setup creates a `config.toml` which changes the defaults for x.py itself.
537 This subcommand accepts a 'profile' to use for builds. For example:
541 The profile is optional and you will be prompted interactively if it is not given.
542 The following profiles are available:
545 Profile::all_for_help(" ").trim_end()
548 Kind::Bench | Kind::Clean | Kind::Dist | Kind::Install => {}
550 // Get any optional paths which occur after the subcommand
551 let mut paths = matches.free[1..].iter().map(|p| p.into()).collect::<Vec<PathBuf>>();
553 let verbose = matches.opt_present("verbose");
555 // User passed in -h/--help?
556 if matches.opt_present("help") {
557 usage(0, &opts, verbose, &subcommand_help);
560 let cmd = match subcommand {
561 Kind::Build => Subcommand::Build { paths },
563 if matches.opt_present("all-targets") {
565 "Warning: --all-targets is now on by default and does not need to be passed explicitly."
568 Subcommand::Check { paths }
570 Kind::Clippy => Subcommand::Clippy {
572 fix: matches.opt_present("fix"),
573 clippy_lint_allow: matches.opt_strs("A"),
574 clippy_lint_warn: matches.opt_strs("W"),
575 clippy_lint_deny: matches.opt_strs("D"),
576 clippy_lint_forbid: matches.opt_strs("F"),
578 Kind::Fix => Subcommand::Fix { paths },
579 Kind::Test => Subcommand::Test {
581 bless: matches.opt_present("bless"),
582 force_rerun: matches.opt_present("force-rerun"),
583 compare_mode: matches.opt_str("compare-mode"),
584 pass: matches.opt_str("pass"),
585 run: matches.opt_str("run"),
586 test_args: matches.opt_strs("test-args"),
587 rustc_args: matches.opt_strs("rustc-args"),
588 fail_fast: !matches.opt_present("no-fail-fast"),
589 rustfix_coverage: matches.opt_present("rustfix-coverage"),
590 doc_tests: if matches.opt_present("doc") {
592 } else if matches.opt_present("no-doc") {
598 Kind::Bench => Subcommand::Bench { paths, test_args: matches.opt_strs("test-args") },
599 Kind::Doc => Subcommand::Doc {
601 open: matches.opt_present("open"),
602 json: matches.opt_present("json"),
605 if !paths.is_empty() {
606 println!("\nclean does not take a path argument\n");
607 usage(1, &opts, verbose, &subcommand_help);
610 Subcommand::Clean { all: matches.opt_present("all") }
612 Kind::Format => Subcommand::Format { check: matches.opt_present("check"), paths },
613 Kind::Dist => Subcommand::Dist { paths },
614 Kind::Install => Subcommand::Install { paths },
616 if paths.is_empty() {
617 println!("\nrun requires at least a path!\n");
618 usage(1, &opts, verbose, &subcommand_help);
620 Subcommand::Run { paths, args: matches.opt_strs("args") }
623 let profile = if paths.len() > 1 {
624 eprintln!("\nerror: At most one profile can be passed to setup\n");
625 usage(1, &opts, verbose, &subcommand_help)
626 } else if let Some(path) = paths.pop() {
627 let profile_string = t!(path.into_os_string().into_string().map_err(
628 |path| format!("{} is not a valid UTF8 string", path.to_string_lossy())
631 let profile = profile_string.parse().unwrap_or_else(|err| {
632 eprintln!("error: {}", err);
633 eprintln!("help: the available profiles are:");
634 eprint!("{}", Profile::all_for_help("- "));
635 crate::detail_exit(1);
641 Subcommand::Setup { profile }
646 verbose: matches.opt_count("verbose"),
647 stage: matches.opt_str("stage").map(|j| j.parse().expect("`stage` should be a number")),
648 dry_run: matches.opt_present("dry-run"),
649 on_fail: matches.opt_str("on-fail"),
650 rustc_error_format: matches.opt_str("error-format"),
651 json_output: matches.opt_present("json-output"),
653 .opt_strs("keep-stage")
655 .map(|j| j.parse().expect("`keep-stage` should be a number"))
657 keep_stage_std: matches
658 .opt_strs("keep-stage-std")
660 .map(|j| j.parse().expect("`keep-stage-std` should be a number"))
662 host: if matches.opt_present("host") {
664 split(&matches.opt_strs("host"))
666 .map(|x| TargetSelection::from_user(&x))
667 .collect::<Vec<_>>(),
672 target: if matches.opt_present("target") {
674 split(&matches.opt_strs("target"))
676 .map(|x| TargetSelection::from_user(&x))
677 .collect::<Vec<_>>(),
682 config: matches.opt_str("config").map(PathBuf::from),
683 build_dir: matches.opt_str("build-dir").map(PathBuf::from),
684 jobs: matches.opt_str("jobs").map(|j| j.parse().expect("`jobs` should be a number")),
686 incremental: matches.opt_present("incremental"),
687 exclude: split(&matches.opt_strs("exclude"))
690 .collect::<Vec<_>>(),
691 include_default_paths: matches.opt_present("include-default-paths"),
692 deny_warnings: parse_deny_warnings(&matches),
693 llvm_skip_rebuild: matches.opt_str("llvm-skip-rebuild").map(|s| s.to_lowercase()).map(
694 |s| s.parse::<bool>().expect("`llvm-skip-rebuild` should be either true or false"),
697 .opt_get_default("color", Color::Auto)
698 .expect("`color` should be `always`, `never`, or `auto`"),
699 rust_profile_use: matches.opt_str("rust-profile-use"),
700 rust_profile_generate: matches.opt_str("rust-profile-generate"),
701 llvm_profile_use: matches.opt_str("llvm-profile-use"),
702 llvm_profile_generate: matches.opt_present("llvm-profile-generate"),
703 llvm_bolt_profile_generate: matches.opt_present("llvm-bolt-profile-generate"),
704 llvm_bolt_profile_use: matches.opt_str("llvm-bolt-profile-use"),
710 pub fn kind(&self) -> Kind {
712 Subcommand::Bench { .. } => Kind::Bench,
713 Subcommand::Build { .. } => Kind::Build,
714 Subcommand::Check { .. } => Kind::Check,
715 Subcommand::Clippy { .. } => Kind::Clippy,
716 Subcommand::Doc { .. } => Kind::Doc,
717 Subcommand::Fix { .. } => Kind::Fix,
718 Subcommand::Format { .. } => Kind::Format,
719 Subcommand::Test { .. } => Kind::Test,
720 Subcommand::Clean { .. } => Kind::Clean,
721 Subcommand::Dist { .. } => Kind::Dist,
722 Subcommand::Install { .. } => Kind::Install,
723 Subcommand::Run { .. } => Kind::Run,
724 Subcommand::Setup { .. } => Kind::Setup,
728 pub fn test_args(&self) -> Vec<&str> {
730 Subcommand::Test { ref test_args, .. } | Subcommand::Bench { ref test_args, .. } => {
731 test_args.iter().flat_map(|s| s.split_whitespace()).collect()
737 pub fn rustc_args(&self) -> Vec<&str> {
739 Subcommand::Test { ref rustc_args, .. } => {
740 rustc_args.iter().flat_map(|s| s.split_whitespace()).collect()
746 pub fn args(&self) -> Vec<&str> {
748 Subcommand::Run { ref args, .. } => {
749 args.iter().flat_map(|s| s.split_whitespace()).collect()
755 pub fn fail_fast(&self) -> bool {
757 Subcommand::Test { fail_fast, .. } => fail_fast,
762 pub fn doc_tests(&self) -> DocTests {
764 Subcommand::Test { doc_tests, .. } => doc_tests,
769 pub fn bless(&self) -> bool {
771 Subcommand::Test { bless, .. } => bless,
776 pub fn force_rerun(&self) -> bool {
778 Subcommand::Test { force_rerun, .. } => force_rerun,
783 pub fn rustfix_coverage(&self) -> bool {
785 Subcommand::Test { rustfix_coverage, .. } => rustfix_coverage,
790 pub fn compare_mode(&self) -> Option<&str> {
792 Subcommand::Test { ref compare_mode, .. } => compare_mode.as_ref().map(|s| &s[..]),
797 pub fn pass(&self) -> Option<&str> {
799 Subcommand::Test { ref pass, .. } => pass.as_ref().map(|s| &s[..]),
804 pub fn run(&self) -> Option<&str> {
806 Subcommand::Test { ref run, .. } => run.as_ref().map(|s| &s[..]),
811 pub fn open(&self) -> bool {
813 Subcommand::Doc { open, .. } => open,
818 pub fn json(&self) -> bool {
820 Subcommand::Doc { json, .. } => json,
826 fn split(s: &[String]) -> Vec<String> {
827 s.iter().flat_map(|s| s.split(',')).filter(|s| !s.is_empty()).map(|s| s.to_string()).collect()
830 fn parse_deny_warnings(matches: &getopts::Matches) -> Option<bool> {
831 match matches.opt_str("warnings").as_deref() {
832 Some("deny") => Some(true),
833 Some("warn") => Some(false),
835 eprintln!(r#"invalid value for --warnings: {:?}, expected "warn" or "deny""#, value,);
836 crate::detail_exit(1);