src/bootstrap/config.rs

   1 //! Serialized configuration of a build.
   2 //!
   3 //! This module implements parsing `config.toml` configuration files to tweak
   4 //! how the build runs.
   5
   6 use std::cmp;
   7 use std::collections::{HashMap, HashSet};
   8 use std::env;
   9 use std::fmt;
  10 use std::fs;
  11 use std::path::{Path, PathBuf};
  12 use std::str::FromStr;
  13
  14 use crate::builder::TaskPath;
  15 use crate::cache::{Interned, INTERNER};
  16 use crate::channel::GitInfo;
  17 pub use crate::flags::Subcommand;
  18 use crate::flags::{Color, Flags};
  19 use crate::util::{exe, t};
  20 use serde::{Deserialize, Deserializer};
  21
  22 macro_rules! check_ci_llvm {
  23     ($name:expr) => {
  24         assert!(
  25             $name.is_none(),
  26             "setting {} is incompatible with download-ci-llvm.",
  27             stringify!($name)
  28         );
  29     };
  30 }
  31
  32 /// Global configuration for the entire build and/or bootstrap.
  33 ///
  34 /// This structure is derived from a combination of both `config.toml` and
  35 /// `config.mk`. As of the time of this writing it's unlikely that `config.toml`
  36 /// is used all that much, so this is primarily filled out by `config.mk` which
  37 /// is generated from `./configure`.
  38 ///
  39 /// Note that this structure is not decoded directly into, but rather it is
  40 /// filled out from the decoded forms of the structs below. For documentation
  41 /// each field, see the corresponding fields in
  42 /// `config.toml.example`.
  43 #[derive(Default)]
  44 pub struct Config {
  45     pub changelog_seen: Option<usize>,
  46     pub ccache: Option<String>,
  47     /// Call Build::ninja() instead of this.
  48     pub ninja_in_file: bool,
  49     pub verbose: usize,
  50     pub submodules: Option<bool>,
  51     pub fast_submodules: bool,
  52     pub compiler_docs: bool,
  53     pub docs_minification: bool,
  54     pub docs: bool,
  55     pub locked_deps: bool,
  56     pub vendor: bool,
  57     pub target_config: HashMap<TargetSelection, Target>,
  58     pub full_bootstrap: bool,
  59     pub extended: bool,
  60     pub tools: Option<HashSet<String>>,
  61     pub sanitizers: bool,
  62     pub profiler: bool,
  63     pub ignore_git: bool,
  64     pub exclude: Vec<TaskPath>,
  65     pub include_default_paths: bool,
  66     pub rustc_error_format: Option<String>,
  67     pub json_output: bool,
  68     pub test_compare_mode: bool,
  69     pub llvm_libunwind: LlvmLibunwind,
  70     pub color: Color,
  71
  72     pub on_fail: Option<String>,
  73     pub stage: u32,
  74     pub keep_stage: Vec<u32>,
  75     pub keep_stage_std: Vec<u32>,
  76     pub src: PathBuf,
  77     // defaults to `config.toml`
  78     pub config: PathBuf,
  79     pub jobs: Option<u32>,
  80     pub cmd: Subcommand,
  81     pub incremental: bool,
  82     pub dry_run: bool,
  83     pub download_rustc: bool,
  84
  85     pub deny_warnings: bool,
  86     pub backtrace_on_ice: bool,
  87
  88     // llvm codegen options
  89     pub llvm_skip_rebuild: bool,
  90     pub llvm_assertions: bool,
  91     pub llvm_tests: bool,
  92     pub llvm_plugins: bool,
  93     pub llvm_optimize: bool,
  94     pub llvm_thin_lto: bool,
  95     pub llvm_release_debuginfo: bool,
  96     pub llvm_version_check: bool,
  97     pub llvm_static_stdcpp: bool,
  98     pub llvm_link_shared: bool,
  99     pub llvm_clang_cl: Option<String>,
 100     pub llvm_targets: Option<String>,
 101     pub llvm_experimental_targets: Option<String>,
 102     pub llvm_link_jobs: Option<u32>,
 103     pub llvm_version_suffix: Option<String>,
 104     pub llvm_use_linker: Option<String>,
 105     pub llvm_allow_old_toolchain: bool,
 106     pub llvm_polly: bool,
 107     pub llvm_clang: bool,
 108     pub llvm_from_ci: bool,
 109     pub llvm_build_config: HashMap<String, String>,
 110
 111     pub use_lld: bool,
 112     pub lld_enabled: bool,
 113     pub llvm_tools_enabled: bool,
 114
 115     pub llvm_cflags: Option<String>,
 116     pub llvm_cxxflags: Option<String>,
 117     pub llvm_ldflags: Option<String>,
 118     pub llvm_use_libcxx: bool,
 119
 120     // rust codegen options
 121     pub rust_optimize: bool,
 122     pub rust_codegen_units: Option<u32>,
 123     pub rust_codegen_units_std: Option<u32>,
 124     pub rust_debug_assertions: bool,
 125     pub rust_debug_assertions_std: bool,
 126     pub rust_overflow_checks: bool,
 127     pub rust_overflow_checks_std: bool,
 128     pub rust_debug_logging: bool,
 129     pub rust_debuginfo_level_rustc: u32,
 130     pub rust_debuginfo_level_std: u32,
 131     pub rust_debuginfo_level_tools: u32,
 132     pub rust_debuginfo_level_tests: u32,
 133     pub rust_run_dsymutil: bool,
 134     pub rust_rpath: bool,
 135     pub rustc_parallel: bool,
 136     pub rustc_default_linker: Option<String>,
 137     pub rust_optimize_tests: bool,
 138     pub rust_dist_src: bool,
 139     pub rust_codegen_backends: Vec<Interned<String>>,
 140     pub rust_verify_llvm_ir: bool,
 141     pub rust_thin_lto_import_instr_limit: Option<u32>,
 142     pub rust_remap_debuginfo: bool,
 143     pub rust_new_symbol_mangling: Option<bool>,
 144     pub rust_profile_use: Option<String>,
 145     pub rust_profile_generate: Option<String>,
 146     pub llvm_profile_use: Option<String>,
 147     pub llvm_profile_generate: bool,
 148
 149     pub build: TargetSelection,
 150     pub hosts: Vec<TargetSelection>,
 151     pub targets: Vec<TargetSelection>,
 152     pub local_rebuild: bool,
 153     pub jemalloc: bool,
 154     pub control_flow_guard: bool,
 155
 156     // dist misc
 157     pub dist_sign_folder: Option<PathBuf>,
 158     pub dist_upload_addr: Option<String>,
 159     pub dist_compression_formats: Option<Vec<String>>,
 160
 161     // libstd features
 162     pub backtrace: bool, // support for RUST_BACKTRACE
 163
 164     // misc
 165     pub low_priority: bool,
 166     pub channel: String,
 167     pub description: Option<String>,
 168     pub verbose_tests: bool,
 169     pub save_toolstates: Option<PathBuf>,
 170     pub print_step_timings: bool,
 171     pub print_step_rusage: bool,
 172     pub missing_tools: bool,
 173
 174     // Fallback musl-root for all targets
 175     pub musl_root: Option<PathBuf>,
 176     pub prefix: Option<PathBuf>,
 177     pub sysconfdir: Option<PathBuf>,
 178     pub datadir: Option<PathBuf>,
 179     pub docdir: Option<PathBuf>,
 180     pub bindir: PathBuf,
 181     pub libdir: Option<PathBuf>,
 182     pub mandir: Option<PathBuf>,
 183     pub codegen_tests: bool,
 184     pub nodejs: Option<PathBuf>,
 185     pub npm: Option<PathBuf>,
 186     pub gdb: Option<PathBuf>,
 187     pub python: Option<PathBuf>,
 188     pub cargo_native_static: bool,
 189     pub configure_args: Vec<String>,
 190
 191     // These are either the stage0 downloaded binaries or the locally installed ones.
 192     pub initial_cargo: PathBuf,
 193     pub initial_rustc: PathBuf,
 194     pub initial_rustfmt: Option<PathBuf>,
 195     pub out: PathBuf,
 196 }
 197
 198 #[derive(Debug, Clone, Copy, PartialEq)]
 199 pub enum LlvmLibunwind {
 200     No,
 201     InTree,
 202     System,
 203 }
 204
 205 impl Default for LlvmLibunwind {
 206     fn default() -> Self {
 207         Self::No
 208     }
 209 }
 210
 211 impl FromStr for LlvmLibunwind {
 212     type Err = String;
 213
 214     fn from_str(value: &str) -> Result<Self, Self::Err> {
 215         match value {
 216             "no" => Ok(Self::No),
 217             "in-tree" => Ok(Self::InTree),
 218             "system" => Ok(Self::System),
 219             invalid => Err(format!("Invalid value '{}' for rust.llvm-libunwind config.", invalid)),
 220         }
 221     }
 222 }
 223
 224 #[derive(Debug, Copy, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
 225 pub struct TargetSelection {
 226     pub triple: Interned<String>,
 227     file: Option<Interned<String>>,
 228 }
 229
 230 impl TargetSelection {
 231     pub fn from_user(selection: &str) -> Self {
 232         let path = Path::new(selection);
 233
 234         let (triple, file) = if path.exists() {
 235             let triple = path
 236                 .file_stem()
 237                 .expect("Target specification file has no file stem")
 238                 .to_str()
 239                 .expect("Target specification file stem is not UTF-8");
 240
 241             (triple, Some(selection))
 242         } else {
 243             (selection, None)
 244         };
 245
 246         let triple = INTERNER.intern_str(triple);
 247         let file = file.map(|f| INTERNER.intern_str(f));
 248
 249         Self { triple, file }
 250     }
 251
 252     pub fn rustc_target_arg(&self) -> &str {
 253         self.file.as_ref().unwrap_or(&self.triple)
 254     }
 255
 256     pub fn contains(&self, needle: &str) -> bool {
 257         self.triple.contains(needle)
 258     }
 259
 260     pub fn starts_with(&self, needle: &str) -> bool {
 261         self.triple.starts_with(needle)
 262     }
 263
 264     pub fn ends_with(&self, needle: &str) -> bool {
 265         self.triple.ends_with(needle)
 266     }
 267 }
 268
 269 impl fmt::Display for TargetSelection {
 270     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 271         write!(f, "{}", self.triple)?;
 272         if let Some(file) = self.file {
 273             write!(f, "({})", file)?;
 274         }
 275         Ok(())
 276     }
 277 }
 278
 279 impl PartialEq<&str> for TargetSelection {
 280     fn eq(&self, other: &&str) -> bool {
 281         self.triple == *other
 282     }
 283 }
 284
 285 /// Per-target configuration stored in the global configuration structure.
 286 #[derive(Default)]
 287 pub struct Target {
 288     /// Some(path to llvm-config) if using an external LLVM.
 289     pub llvm_config: Option<PathBuf>,
 290     /// Some(path to FileCheck) if one was specified.
 291     pub llvm_filecheck: Option<PathBuf>,
 292     pub cc: Option<PathBuf>,
 293     pub cxx: Option<PathBuf>,
 294     pub ar: Option<PathBuf>,
 295     pub ranlib: Option<PathBuf>,
 296     pub default_linker: Option<PathBuf>,
 297     pub linker: Option<PathBuf>,
 298     pub ndk: Option<PathBuf>,
 299     pub sanitizers: Option<bool>,
 300     pub profiler: Option<bool>,
 301     pub crt_static: Option<bool>,
 302     pub musl_root: Option<PathBuf>,
 303     pub musl_libdir: Option<PathBuf>,
 304     pub wasi_root: Option<PathBuf>,
 305     pub qemu_rootfs: Option<PathBuf>,
 306     pub no_std: bool,
 307 }
 308
 309 impl Target {
 310     pub fn from_triple(triple: &str) -> Self {
 311         let mut target: Self = Default::default();
 312         if triple.contains("-none") || triple.contains("nvptx") {
 313             target.no_std = true;
 314         }
 315         target
 316     }
 317 }
 318 /// Structure of the `config.toml` file that configuration is read from.
 319 ///
 320 /// This structure uses `Decodable` to automatically decode a TOML configuration
 321 /// file into this format, and then this is traversed and written into the above
 322 /// `Config` structure.
 323 #[derive(Deserialize, Default)]
 324 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
 325 struct TomlConfig {
 326     changelog_seen: Option<usize>,
 327     build: Option<Build>,
 328     install: Option<Install>,
 329     llvm: Option<Llvm>,
 330     rust: Option<Rust>,
 331     target: Option<HashMap<String, TomlTarget>>,
 332     dist: Option<Dist>,
 333     profile: Option<String>,
 334 }
 335
 336 trait Merge {
 337     fn merge(&mut self, other: Self);
 338 }
 339
 340 impl Merge for TomlConfig {
 341     fn merge(
 342         &mut self,
 343         TomlConfig { build, install, llvm, rust, dist, target, profile: _, changelog_seen: _ }: Self,
 344     ) {
 345         fn do_merge<T: Merge>(x: &mut Option<T>, y: Option<T>) {
 346             if let Some(new) = y {
 347                 if let Some(original) = x {
 348                     original.merge(new);
 349                 } else {
 350                     *x = Some(new);
 351                 }
 352             }
 353         }
 354         do_merge(&mut self.build, build);
 355         do_merge(&mut self.install, install);
 356         do_merge(&mut self.llvm, llvm);
 357         do_merge(&mut self.rust, rust);
 358         do_merge(&mut self.dist, dist);
 359         assert!(target.is_none(), "merging target-specific config is not currently supported");
 360     }
 361 }
 362
 363 // We are using a decl macro instead of a derive proc macro here to reduce the compile time of
 364 // rustbuild.
 365 macro_rules! define_config {
 366     ($(#[$attr:meta])* struct $name:ident {
 367         $($field:ident: Option<$field_ty:ty> = $field_key:literal,)*
 368     }) => {
 369         $(#[$attr])*
 370         struct $name {
 371             $($field: Option<$field_ty>,)*
 372         }
 373
 374         impl Merge for $name {
 375             fn merge(&mut self, other: Self) {
 376                 $(
 377                     if !self.$field.is_some() {
 378                         self.$field = other.$field;
 379                     }
 380                 )*
 381             }
 382         }
 383
 384         // The following is a trimmed version of what serde_derive generates. All parts not relevant
 385         // for toml deserialization have been removed. This reduces the binary size and improves
 386         // compile time of rustbuild.
 387         impl<'de> Deserialize<'de> for $name {
 388             fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
 389             where
 390                 D: Deserializer<'de>,
 391             {
 392                 #[allow(non_camel_case_types)]
 393                 enum FieldName {
 394                     $($field,)*
 395                 }
 396                 struct FieldNameVisitor;
 397                 impl<'de> serde::de::Visitor<'de> for FieldNameVisitor {
 398                     type Value = FieldName;
 399                     fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 400                         f.write_str("field identifier")
 401                     }
 402
 403                     #[inline]
 404                     fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
 405                     where
 406                         E: serde::de::Error,
 407                     {
 408                         match value {
 409                             $($field_key => Ok(FieldName::$field),)*
 410                             _ => Err(serde::de::Error::unknown_field(value, FIELDS)),
 411                         }
 412                     }
 413                 }
 414                 impl<'de> Deserialize<'de> for FieldName {
 415                     #[inline]
 416                     fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
 417                     where
 418                         D: Deserializer<'de>,
 419                     {
 420                         Deserializer::deserialize_identifier(deserializer, FieldNameVisitor)
 421                     }
 422                 }
 423                 struct Field;
 424                 impl<'de> serde::de::Visitor<'de> for Field {
 425                     type Value = $name;
 426                     fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 427                         f.write_str(concat!("struct ", stringify!($name)))
 428                     }
 429
 430                     #[inline]
 431                     fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error>
 432                     where
 433                         A: serde::de::MapAccess<'de>,
 434                     {
 435                         $(let mut $field: Option<$field_ty> = None;)*
 436                         while let Some(key) =
 437                             match serde::de::MapAccess::next_key::<FieldName>(&mut map) {
 438                                 Ok(val) => val,
 439                                 Err(err) => {
 440                                     return Err(err);
 441                                 }
 442                             }
 443                         {
 444                             match key {
 445                                 $(FieldName::$field => {
 446                                     if $field.is_some() {
 447                                         return Err(<A::Error as serde::de::Error>::duplicate_field(
 448                                             $field_key,
 449                                         ));
 450                                     }
 451                                     $field = match serde::de::MapAccess::next_value::<$field_ty>(
 452                                         &mut map,
 453                                     ) {
 454                                         Ok(val) => Some(val),
 455                                         Err(err) => {
 456                                             return Err(err);
 457                                         }
 458                                     };
 459                                 })*
 460                             }
 461                         }
 462                         Ok($name { $($field),* })
 463                     }
 464                 }
 465                 const FIELDS: &'static [&'static str] = &[
 466                     $($field_key,)*
 467                 ];
 468                 Deserializer::deserialize_struct(
 469                     deserializer,
 470                     stringify!($name),
 471                     FIELDS,
 472                     Field,
 473                 )
 474             }
 475         }
 476     }
 477 }
 478
 479 define_config! {
 480     /// TOML representation of various global build decisions.
 481     #[derive(Default)]
 482     struct Build {
 483         build: Option<String> = "build",
 484         host: Option<Vec<String>> = "host",
 485         target: Option<Vec<String>> = "target",
 486         build_dir: Option<String> = "build-dir",
 487         cargo: Option<String> = "cargo",
 488         rustc: Option<String> = "rustc",
 489         rustfmt: Option<PathBuf> = "rustfmt",
 490         docs: Option<bool> = "docs",
 491         compiler_docs: Option<bool> = "compiler-docs",
 492         docs_minification: Option<bool> = "docs-minification",
 493         submodules: Option<bool> = "submodules",
 494         fast_submodules: Option<bool> = "fast-submodules",
 495         gdb: Option<String> = "gdb",
 496         nodejs: Option<String> = "nodejs",
 497         npm: Option<String> = "npm",
 498         python: Option<String> = "python",
 499         locked_deps: Option<bool> = "locked-deps",
 500         vendor: Option<bool> = "vendor",
 501         full_bootstrap: Option<bool> = "full-bootstrap",
 502         extended: Option<bool> = "extended",
 503         tools: Option<HashSet<String>> = "tools",
 504         verbose: Option<usize> = "verbose",
 505         sanitizers: Option<bool> = "sanitizers",
 506         profiler: Option<bool> = "profiler",
 507         cargo_native_static: Option<bool> = "cargo-native-static",
 508         low_priority: Option<bool> = "low-priority",
 509         configure_args: Option<Vec<String>> = "configure-args",
 510         local_rebuild: Option<bool> = "local-rebuild",
 511         print_step_timings: Option<bool> = "print-step-timings",
 512         print_step_rusage: Option<bool> = "print-step-rusage",
 513         check_stage: Option<u32> = "check-stage",
 514         doc_stage: Option<u32> = "doc-stage",
 515         build_stage: Option<u32> = "build-stage",
 516         test_stage: Option<u32> = "test-stage",
 517         install_stage: Option<u32> = "install-stage",
 518         dist_stage: Option<u32> = "dist-stage",
 519         bench_stage: Option<u32> = "bench-stage",
 520         patch_binaries_for_nix: Option<bool> = "patch-binaries-for-nix",
 521     }
 522 }
 523
 524 define_config! {
 525     /// TOML representation of various global install decisions.
 526     struct Install {
 527         prefix: Option<String> = "prefix",
 528         sysconfdir: Option<String> = "sysconfdir",
 529         docdir: Option<String> = "docdir",
 530         bindir: Option<String> = "bindir",
 531         libdir: Option<String> = "libdir",
 532         mandir: Option<String> = "mandir",
 533         datadir: Option<String> = "datadir",
 534     }
 535 }
 536
 537 define_config! {
 538     /// TOML representation of how the LLVM build is configured.
 539     struct Llvm {
 540         skip_rebuild: Option<bool> = "skip-rebuild",
 541         optimize: Option<bool> = "optimize",
 542         thin_lto: Option<bool> = "thin-lto",
 543         release_debuginfo: Option<bool> = "release-debuginfo",
 544         assertions: Option<bool> = "assertions",
 545         tests: Option<bool> = "tests",
 546         plugins: Option<bool> = "plugins",
 547         ccache: Option<StringOrBool> = "ccache",
 548         version_check: Option<bool> = "version-check",
 549         static_libstdcpp: Option<bool> = "static-libstdcpp",
 550         ninja: Option<bool> = "ninja",
 551         targets: Option<String> = "targets",
 552         experimental_targets: Option<String> = "experimental-targets",
 553         link_jobs: Option<u32> = "link-jobs",
 554         link_shared: Option<bool> = "link-shared",
 555         version_suffix: Option<String> = "version-suffix",
 556         clang_cl: Option<String> = "clang-cl",
 557         cflags: Option<String> = "cflags",
 558         cxxflags: Option<String> = "cxxflags",
 559         ldflags: Option<String> = "ldflags",
 560         use_libcxx: Option<bool> = "use-libcxx",
 561         use_linker: Option<String> = "use-linker",
 562         allow_old_toolchain: Option<bool> = "allow-old-toolchain",
 563         polly: Option<bool> = "polly",
 564         clang: Option<bool> = "clang",
 565         download_ci_llvm: Option<StringOrBool> = "download-ci-llvm",
 566         build_config: Option<HashMap<String, String>> = "build-config",
 567     }
 568 }
 569
 570 define_config! {
 571     struct Dist {
 572         sign_folder: Option<String> = "sign-folder",
 573         gpg_password_file: Option<String> = "gpg-password-file",
 574         upload_addr: Option<String> = "upload-addr",
 575         src_tarball: Option<bool> = "src-tarball",
 576         missing_tools: Option<bool> = "missing-tools",
 577         compression_formats: Option<Vec<String>> = "compression-formats",
 578     }
 579 }
 580
 581 #[derive(Deserialize)]
 582 #[serde(untagged)]
 583 enum StringOrBool {
 584     String(String),
 585     Bool(bool),
 586 }
 587
 588 impl Default for StringOrBool {
 589     fn default() -> StringOrBool {
 590         StringOrBool::Bool(false)
 591     }
 592 }
 593
 594 define_config! {
 595     /// TOML representation of how the Rust build is configured.
 596     struct Rust {
 597         optimize: Option<bool> = "optimize",
 598         debug: Option<bool> = "debug",
 599         codegen_units: Option<u32> = "codegen-units",
 600         codegen_units_std: Option<u32> = "codegen-units-std",
 601         debug_assertions: Option<bool> = "debug-assertions",
 602         debug_assertions_std: Option<bool> = "debug-assertions-std",
 603         overflow_checks: Option<bool> = "overflow-checks",
 604         overflow_checks_std: Option<bool> = "overflow-checks-std",
 605         debug_logging: Option<bool> = "debug-logging",
 606         debuginfo_level: Option<u32> = "debuginfo-level",
 607         debuginfo_level_rustc: Option<u32> = "debuginfo-level-rustc",
 608         debuginfo_level_std: Option<u32> = "debuginfo-level-std",
 609         debuginfo_level_tools: Option<u32> = "debuginfo-level-tools",
 610         debuginfo_level_tests: Option<u32> = "debuginfo-level-tests",
 611         run_dsymutil: Option<bool> = "run-dsymutil",
 612         backtrace: Option<bool> = "backtrace",
 613         incremental: Option<bool> = "incremental",
 614         parallel_compiler: Option<bool> = "parallel-compiler",
 615         default_linker: Option<String> = "default-linker",
 616         channel: Option<String> = "channel",
 617         description: Option<String> = "description",
 618         musl_root: Option<String> = "musl-root",
 619         rpath: Option<bool> = "rpath",
 620         verbose_tests: Option<bool> = "verbose-tests",
 621         optimize_tests: Option<bool> = "optimize-tests",
 622         codegen_tests: Option<bool> = "codegen-tests",
 623         ignore_git: Option<bool> = "ignore-git",
 624         dist_src: Option<bool> = "dist-src",
 625         save_toolstates: Option<String> = "save-toolstates",
 626         codegen_backends: Option<Vec<String>> = "codegen-backends",
 627         lld: Option<bool> = "lld",
 628         use_lld: Option<bool> = "use-lld",
 629         llvm_tools: Option<bool> = "llvm-tools",
 630         deny_warnings: Option<bool> = "deny-warnings",
 631         backtrace_on_ice: Option<bool> = "backtrace-on-ice",
 632         verify_llvm_ir: Option<bool> = "verify-llvm-ir",
 633         thin_lto_import_instr_limit: Option<u32> = "thin-lto-import-instr-limit",
 634         remap_debuginfo: Option<bool> = "remap-debuginfo",
 635         jemalloc: Option<bool> = "jemalloc",
 636         test_compare_mode: Option<bool> = "test-compare-mode",
 637         llvm_libunwind: Option<String> = "llvm-libunwind",
 638         control_flow_guard: Option<bool> = "control-flow-guard",
 639         new_symbol_mangling: Option<bool> = "new-symbol-mangling",
 640         profile_generate: Option<String> = "profile-generate",
 641         profile_use: Option<String> = "profile-use",
 642         // ignored; this is set from an env var set by bootstrap.py
 643         download_rustc: Option<StringOrBool> = "download-rustc",
 644     }
 645 }
 646
 647 define_config! {
 648     /// TOML representation of how each build target is configured.
 649     struct TomlTarget {
 650         cc: Option<String> = "cc",
 651         cxx: Option<String> = "cxx",
 652         ar: Option<String> = "ar",
 653         ranlib: Option<String> = "ranlib",
 654         default_linker: Option<PathBuf> = "default-linker",
 655         linker: Option<String> = "linker",
 656         llvm_config: Option<String> = "llvm-config",
 657         llvm_filecheck: Option<String> = "llvm-filecheck",
 658         android_ndk: Option<String> = "android-ndk",
 659         sanitizers: Option<bool> = "sanitizers",
 660         profiler: Option<bool> = "profiler",
 661         crt_static: Option<bool> = "crt-static",
 662         musl_root: Option<String> = "musl-root",
 663         musl_libdir: Option<String> = "musl-libdir",
 664         wasi_root: Option<String> = "wasi-root",
 665         qemu_rootfs: Option<String> = "qemu-rootfs",
 666         no_std: Option<bool> = "no-std",
 667     }
 668 }
 669
 670 impl Config {
 671     pub fn default_opts() -> Config {
 672         let mut config = Config::default();
 673         config.llvm_optimize = true;
 674         config.ninja_in_file = true;
 675         config.llvm_version_check = true;
 676         config.backtrace = true;
 677         config.rust_optimize = true;
 678         config.rust_optimize_tests = true;
 679         config.submodules = None;
 680         config.fast_submodules = true;
 681         config.docs = true;
 682         config.docs_minification = true;
 683         config.rust_rpath = true;
 684         config.channel = "dev".to_string();
 685         config.codegen_tests = true;
 686         config.rust_dist_src = true;
 687         config.rust_codegen_backends = vec![INTERNER.intern_str("llvm")];
 688         config.deny_warnings = true;
 689         config.bindir = "bin".into();
 690
 691         // set by build.rs
 692         config.build = TargetSelection::from_user(&env!("BUILD_TRIPLE"));
 693         let manifest_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
 694         // Undo `src/bootstrap`
 695         config.src = manifest_dir.parent().unwrap().parent().unwrap().to_owned();
 696         config.out = PathBuf::from("build");
 697
 698         config.initial_cargo = PathBuf::from(env!("CARGO"));
 699         config.initial_rustc = PathBuf::from(env!("RUSTC"));
 700
 701         config
 702     }
 703
 704     pub fn parse(args: &[String]) -> Config {
 705         let flags = Flags::parse(&args);
 706
 707         let mut config = Config::default_opts();
 708         config.exclude = flags.exclude.into_iter().map(|path| TaskPath::parse(path)).collect();
 709         config.include_default_paths = flags.include_default_paths;
 710         config.rustc_error_format = flags.rustc_error_format;
 711         config.json_output = flags.json_output;
 712         config.on_fail = flags.on_fail;
 713         config.jobs = flags.jobs.map(threads_from_config);
 714         config.cmd = flags.cmd;
 715         config.incremental = flags.incremental;
 716         config.dry_run = flags.dry_run;
 717         config.keep_stage = flags.keep_stage;
 718         config.keep_stage_std = flags.keep_stage_std;
 719         config.color = flags.color;
 720         if let Some(value) = flags.deny_warnings {
 721             config.deny_warnings = value;
 722         }
 723         config.llvm_profile_use = flags.llvm_profile_use;
 724         config.llvm_profile_generate = flags.llvm_profile_generate;
 725
 726         #[cfg(test)]
 727         let get_toml = |_| TomlConfig::default();
 728         #[cfg(not(test))]
 729         let get_toml = |file: &Path| {
 730             use std::process;
 731
 732             let contents =
 733                 t!(fs::read_to_string(file), format!("config file {} not found", file.display()));
 734             // Deserialize to Value and then TomlConfig to prevent the Deserialize impl of
 735             // TomlConfig and sub types to be monomorphized 5x by toml.
 736             match toml::from_str(&contents)
 737                 .and_then(|table: toml::Value| TomlConfig::deserialize(table))
 738             {
 739                 Ok(table) => table,
 740                 Err(err) => {
 741                     println!("failed to parse TOML configuration '{}': {}", file.display(), err);
 742                     process::exit(2);
 743                 }
 744             }
 745         };
 746
 747         // Read from `--config`, then `RUST_BOOTSTRAP_CONFIG`, then `./config.toml`, then `config.toml` in the root directory.
 748         let toml_path = flags
 749             .config
 750             .clone()
 751             .or_else(|| env::var_os("RUST_BOOTSTRAP_CONFIG").map(PathBuf::from));
 752         let using_default_path = toml_path.is_none();
 753         let mut toml_path = toml_path.unwrap_or_else(|| PathBuf::from("config.toml"));
 754         if using_default_path && !toml_path.exists() {
 755             toml_path = config.src.join(toml_path);
 756         }
 757
 758         // Give a hard error if `--config` or `RUST_BOOTSTRAP_CONFIG` are set to a missing path,
 759         // but not if `config.toml` hasn't been created.
 760         let mut toml = if !using_default_path || toml_path.exists() {
 761             get_toml(&toml_path)
 762         } else {
 763             TomlConfig::default()
 764         };
 765
 766         if let Some(include) = &toml.profile {
 767             let mut include_path = config.src.clone();
 768             include_path.push("src");
 769             include_path.push("bootstrap");
 770             include_path.push("defaults");
 771             include_path.push(format!("config.{}.toml", include));
 772             let included_toml = get_toml(&include_path);
 773             toml.merge(included_toml);
 774         }
 775
 776         config.changelog_seen = toml.changelog_seen;
 777         config.config = toml_path;
 778
 779         let build = toml.build.unwrap_or_default();
 780
 781         set(&mut config.initial_rustc, build.rustc.map(PathBuf::from));
 782         set(&mut config.out, build.build_dir.map(PathBuf::from));
 783         // NOTE: Bootstrap spawns various commands with different working directories.
 784         // To avoid writing to random places on the file system, `config.out` needs to be an absolute path.
 785         if !config.out.is_absolute() {
 786             // `canonicalize` requires the path to already exist. Use our vendored copy of `absolute` instead.
 787             config.out = crate::util::absolute(&config.out);
 788         }
 789
 790         if config.dry_run {
 791             let dir = config.out.join("tmp-dry-run");
 792             t!(fs::create_dir_all(&dir));
 793             config.out = dir;
 794         }
 795
 796         config.hosts = if let Some(arg_host) = flags.host {
 797             arg_host
 798         } else if let Some(file_host) = build.host {
 799             file_host.iter().map(|h| TargetSelection::from_user(h)).collect()
 800         } else {
 801             vec![config.build]
 802         };
 803         config.targets = if let Some(arg_target) = flags.target {
 804             arg_target
 805         } else if let Some(file_target) = build.target {
 806             file_target.iter().map(|h| TargetSelection::from_user(h)).collect()
 807         } else {
 808             // If target is *not* configured, then default to the host
 809             // toolchains.
 810             config.hosts.clone()
 811         };
 812
 813         config.nodejs = build.nodejs.map(PathBuf::from);
 814         config.npm = build.npm.map(PathBuf::from);
 815         config.gdb = build.gdb.map(PathBuf::from);
 816         config.python = build.python.map(PathBuf::from);
 817         config.submodules = build.submodules;
 818         set(&mut config.low_priority, build.low_priority);
 819         set(&mut config.compiler_docs, build.compiler_docs);
 820         set(&mut config.docs_minification, build.docs_minification);
 821         set(&mut config.docs, build.docs);
 822         set(&mut config.fast_submodules, build.fast_submodules);
 823         set(&mut config.locked_deps, build.locked_deps);
 824         set(&mut config.vendor, build.vendor);
 825         set(&mut config.full_bootstrap, build.full_bootstrap);
 826         set(&mut config.extended, build.extended);
 827         config.tools = build.tools;
 828         if build.rustfmt.is_some() {
 829             config.initial_rustfmt = build.rustfmt;
 830         }
 831         set(&mut config.verbose, build.verbose);
 832         set(&mut config.sanitizers, build.sanitizers);
 833         set(&mut config.profiler, build.profiler);
 834         set(&mut config.cargo_native_static, build.cargo_native_static);
 835         set(&mut config.configure_args, build.configure_args);
 836         set(&mut config.local_rebuild, build.local_rebuild);
 837         set(&mut config.print_step_timings, build.print_step_timings);
 838         set(&mut config.print_step_rusage, build.print_step_rusage);
 839
 840         config.verbose = cmp::max(config.verbose, flags.verbose);
 841
 842         if let Some(install) = toml.install {
 843             config.prefix = install.prefix.map(PathBuf::from);
 844             config.sysconfdir = install.sysconfdir.map(PathBuf::from);
 845             config.datadir = install.datadir.map(PathBuf::from);
 846             config.docdir = install.docdir.map(PathBuf::from);
 847             set(&mut config.bindir, install.bindir.map(PathBuf::from));
 848             config.libdir = install.libdir.map(PathBuf::from);
 849             config.mandir = install.mandir.map(PathBuf::from);
 850         }
 851
 852         // We want the llvm-skip-rebuild flag to take precedence over the
 853         // skip-rebuild config.toml option so we store it separately
 854         // so that we can infer the right value
 855         let mut llvm_skip_rebuild = flags.llvm_skip_rebuild;
 856
 857         // Store off these values as options because if they're not provided
 858         // we'll infer default values for them later
 859         let mut llvm_assertions = None;
 860         let mut llvm_tests = None;
 861         let mut llvm_plugins = None;
 862         let mut debug = None;
 863         let mut debug_assertions = None;
 864         let mut debug_assertions_std = None;
 865         let mut overflow_checks = None;
 866         let mut overflow_checks_std = None;
 867         let mut debug_logging = None;
 868         let mut debuginfo_level = None;
 869         let mut debuginfo_level_rustc = None;
 870         let mut debuginfo_level_std = None;
 871         let mut debuginfo_level_tools = None;
 872         let mut debuginfo_level_tests = None;
 873         let mut optimize = None;
 874         let mut ignore_git = None;
 875
 876         if let Some(llvm) = toml.llvm {
 877             match llvm.ccache {
 878                 Some(StringOrBool::String(ref s)) => config.ccache = Some(s.to_string()),
 879                 Some(StringOrBool::Bool(true)) => {
 880                     config.ccache = Some("ccache".to_string());
 881                 }
 882                 Some(StringOrBool::Bool(false)) | None => {}
 883             }
 884             set(&mut config.ninja_in_file, llvm.ninja);
 885             llvm_assertions = llvm.assertions;
 886             llvm_tests = llvm.tests;
 887             llvm_plugins = llvm.plugins;
 888             llvm_skip_rebuild = llvm_skip_rebuild.or(llvm.skip_rebuild);
 889             set(&mut config.llvm_optimize, llvm.optimize);
 890             set(&mut config.llvm_thin_lto, llvm.thin_lto);
 891             set(&mut config.llvm_release_debuginfo, llvm.release_debuginfo);
 892             set(&mut config.llvm_version_check, llvm.version_check);
 893             set(&mut config.llvm_static_stdcpp, llvm.static_libstdcpp);
 894             set(&mut config.llvm_link_shared, llvm.link_shared);
 895             config.llvm_targets = llvm.targets.clone();
 896             config.llvm_experimental_targets = llvm.experimental_targets.clone();
 897             config.llvm_link_jobs = llvm.link_jobs;
 898             config.llvm_version_suffix = llvm.version_suffix.clone();
 899             config.llvm_clang_cl = llvm.clang_cl.clone();
 900
 901             config.llvm_cflags = llvm.cflags.clone();
 902             config.llvm_cxxflags = llvm.cxxflags.clone();
 903             config.llvm_ldflags = llvm.ldflags.clone();
 904             set(&mut config.llvm_use_libcxx, llvm.use_libcxx);
 905             config.llvm_use_linker = llvm.use_linker.clone();
 906             config.llvm_allow_old_toolchain = llvm.allow_old_toolchain.unwrap_or(false);
 907             config.llvm_polly = llvm.polly.unwrap_or(false);
 908             config.llvm_clang = llvm.clang.unwrap_or(false);
 909             config.llvm_build_config = llvm.build_config.clone().unwrap_or(Default::default());
 910             config.llvm_from_ci = match llvm.download_ci_llvm {
 911                 Some(StringOrBool::String(s)) => {
 912                     assert!(s == "if-available", "unknown option `{}` for download-ci-llvm", s);
 913                     // This is currently all tier 1 targets and tier 2 targets with host tools
 914                     // (since others may not have CI artifacts)
 915                     // https://doc.rust-lang.org/rustc/platform-support.html#tier-1
 916                     // FIXME: this is duplicated in bootstrap.py
 917                     let supported_platforms = [
 918                         // tier 1
 919                         "aarch64-unknown-linux-gnu",
 920                         "i686-pc-windows-gnu",
 921                         "i686-pc-windows-msvc",
 922                         "i686-unknown-linux-gnu",
 923                         "x86_64-unknown-linux-gnu",
 924                         "x86_64-apple-darwin",
 925                         "x86_64-pc-windows-gnu",
 926                         "x86_64-pc-windows-msvc",
 927                         // tier 2 with host tools
 928                         "aarch64-apple-darwin",
 929                         "aarch64-pc-windows-msvc",
 930                         "aarch64-unknown-linux-musl",
 931                         "arm-unknown-linux-gnueabi",
 932                         "arm-unknown-linux-gnueabihf",
 933                         "armv7-unknown-linux-gnueabihf",
 934                         "mips-unknown-linux-gnu",
 935                         "mips64-unknown-linux-gnuabi64",
 936                         "mips64el-unknown-linux-gnuabi64",
 937                         "mipsel-unknown-linux-gnu",
 938                         "powerpc-unknown-linux-gnu",
 939                         "powerpc64-unknown-linux-gnu",
 940                         "powerpc64le-unknown-linux-gnu",
 941                         "riscv64gc-unknown-linux-gnu",
 942                         "s390x-unknown-linux-gnu",
 943                         "x86_64-unknown-freebsd",
 944                         "x86_64-unknown-illumos",
 945                         "x86_64-unknown-linux-musl",
 946                         "x86_64-unknown-netbsd",
 947                     ];
 948                     supported_platforms.contains(&&*config.build.triple)
 949                 }
 950                 Some(StringOrBool::Bool(b)) => b,
 951                 None => false,
 952             };
 953
 954             if config.llvm_from_ci {
 955                 // None of the LLVM options, except assertions, are supported
 956                 // when using downloaded LLVM. We could just ignore these but
 957                 // that's potentially confusing, so force them to not be
 958                 // explicitly set. The defaults and CI defaults don't
 959                 // necessarily match but forcing people to match (somewhat
 960                 // arbitrary) CI configuration locally seems bad/hard.
 961                 check_ci_llvm!(llvm.optimize);
 962                 check_ci_llvm!(llvm.thin_lto);
 963                 check_ci_llvm!(llvm.release_debuginfo);
 964                 check_ci_llvm!(llvm.link_shared);
 965                 check_ci_llvm!(llvm.static_libstdcpp);
 966                 check_ci_llvm!(llvm.targets);
 967                 check_ci_llvm!(llvm.experimental_targets);
 968                 check_ci_llvm!(llvm.link_jobs);
 969                 check_ci_llvm!(llvm.clang_cl);
 970                 check_ci_llvm!(llvm.version_suffix);
 971                 check_ci_llvm!(llvm.cflags);
 972                 check_ci_llvm!(llvm.cxxflags);
 973                 check_ci_llvm!(llvm.ldflags);
 974                 check_ci_llvm!(llvm.use_libcxx);
 975                 check_ci_llvm!(llvm.use_linker);
 976                 check_ci_llvm!(llvm.allow_old_toolchain);
 977                 check_ci_llvm!(llvm.polly);
 978                 check_ci_llvm!(llvm.clang);
 979                 check_ci_llvm!(llvm.build_config);
 980                 check_ci_llvm!(llvm.plugins);
 981
 982                 // CI-built LLVM can be either dynamic or static.
 983                 let ci_llvm = config.out.join(&*config.build.triple).join("ci-llvm");
 984                 config.llvm_link_shared = if config.dry_run {
 985                     // just assume dynamic for now
 986                     true
 987                 } else {
 988                     let link_type = t!(
 989                         std::fs::read_to_string(ci_llvm.join("link-type.txt")),
 990                         format!("CI llvm missing: {}", ci_llvm.display())
 991                     );
 992                     link_type == "dynamic"
 993                 };
 994             }
 995
 996             if config.llvm_thin_lto && llvm.link_shared.is_none() {
 997                 // If we're building with ThinLTO on, by default we want to link
 998                 // to LLVM shared, to avoid re-doing ThinLTO (which happens in
 999                 // the link step) with each stage.
1000                 config.llvm_link_shared = true;
1001             }
1002         }
1003
1004         if let Some(rust) = toml.rust {
1005             debug = rust.debug;
1006             debug_assertions = rust.debug_assertions;
1007             debug_assertions_std = rust.debug_assertions_std;
1008             overflow_checks = rust.overflow_checks;
1009             overflow_checks_std = rust.overflow_checks_std;
1010             debug_logging = rust.debug_logging;
1011             debuginfo_level = rust.debuginfo_level;
1012             debuginfo_level_rustc = rust.debuginfo_level_rustc;
1013             debuginfo_level_std = rust.debuginfo_level_std;
1014             debuginfo_level_tools = rust.debuginfo_level_tools;
1015             debuginfo_level_tests = rust.debuginfo_level_tests;
1016             config.rust_run_dsymutil = rust.run_dsymutil.unwrap_or(false);
1017             optimize = rust.optimize;
1018             ignore_git = rust.ignore_git;
1019             config.rust_new_symbol_mangling = rust.new_symbol_mangling;
1020             set(&mut config.rust_optimize_tests, rust.optimize_tests);
1021             set(&mut config.codegen_tests, rust.codegen_tests);
1022             set(&mut config.rust_rpath, rust.rpath);
1023             set(&mut config.jemalloc, rust.jemalloc);
1024             set(&mut config.test_compare_mode, rust.test_compare_mode);
1025             config.llvm_libunwind = rust
1026                 .llvm_libunwind
1027                 .map(|v| v.parse().expect("failed to parse rust.llvm-libunwind"))
1028                 .unwrap_or_default();
1029             set(&mut config.backtrace, rust.backtrace);
1030             set(&mut config.channel, rust.channel);
1031             config.description = rust.description;
1032             set(&mut config.rust_dist_src, rust.dist_src);
1033             set(&mut config.verbose_tests, rust.verbose_tests);
1034             // in the case "false" is set explicitly, do not overwrite the command line args
1035             if let Some(true) = rust.incremental {
1036                 config.incremental = true;
1037             }
1038             set(&mut config.use_lld, rust.use_lld);
1039             set(&mut config.lld_enabled, rust.lld);
1040             set(&mut config.llvm_tools_enabled, rust.llvm_tools);
1041             config.rustc_parallel = rust.parallel_compiler.unwrap_or(false);
1042             config.rustc_default_linker = rust.default_linker;
1043             config.musl_root = rust.musl_root.map(PathBuf::from);
1044             config.save_toolstates = rust.save_toolstates.map(PathBuf::from);
1045             set(&mut config.deny_warnings, flags.deny_warnings.or(rust.deny_warnings));
1046             set(&mut config.backtrace_on_ice, rust.backtrace_on_ice);
1047             set(&mut config.rust_verify_llvm_ir, rust.verify_llvm_ir);
1048             config.rust_thin_lto_import_instr_limit = rust.thin_lto_import_instr_limit;
1049             set(&mut config.rust_remap_debuginfo, rust.remap_debuginfo);
1050             set(&mut config.control_flow_guard, rust.control_flow_guard);
1051
1052             if let Some(ref backends) = rust.codegen_backends {
1053                 config.rust_codegen_backends =
1054                     backends.iter().map(|s| INTERNER.intern_str(s)).collect();
1055             }
1056
1057             config.rust_codegen_units = rust.codegen_units.map(threads_from_config);
1058             config.rust_codegen_units_std = rust.codegen_units_std.map(threads_from_config);
1059             config.rust_profile_use = flags.rust_profile_use.or(rust.profile_use);
1060             config.rust_profile_generate = flags.rust_profile_generate.or(rust.profile_generate);
1061             config.download_rustc = env::var("BOOTSTRAP_DOWNLOAD_RUSTC").as_deref() == Ok("1");
1062         } else {
1063             config.rust_profile_use = flags.rust_profile_use;
1064             config.rust_profile_generate = flags.rust_profile_generate;
1065         }
1066
1067         if let Some(t) = toml.target {
1068             for (triple, cfg) in t {
1069                 let mut target = Target::from_triple(&triple);
1070
1071                 if let Some(ref s) = cfg.llvm_config {
1072                     target.llvm_config = Some(config.src.join(s));
1073                 }
1074                 if let Some(ref s) = cfg.llvm_filecheck {
1075                     target.llvm_filecheck = Some(config.src.join(s));
1076                 }
1077                 if let Some(ref s) = cfg.android_ndk {
1078                     target.ndk = Some(config.src.join(s));
1079                 }
1080                 if let Some(s) = cfg.no_std {
1081                     target.no_std = s;
1082                 }
1083                 target.cc = cfg.cc.map(PathBuf::from);
1084                 target.cxx = cfg.cxx.map(PathBuf::from);
1085                 target.ar = cfg.ar.map(PathBuf::from);
1086                 target.ranlib = cfg.ranlib.map(PathBuf::from);
1087                 target.linker = cfg.linker.map(PathBuf::from);
1088                 target.crt_static = cfg.crt_static;
1089                 target.musl_root = cfg.musl_root.map(PathBuf::from);
1090                 target.musl_libdir = cfg.musl_libdir.map(PathBuf::from);
1091                 target.wasi_root = cfg.wasi_root.map(PathBuf::from);
1092                 target.qemu_rootfs = cfg.qemu_rootfs.map(PathBuf::from);
1093                 target.sanitizers = cfg.sanitizers;
1094                 target.profiler = cfg.profiler;
1095
1096                 config.target_config.insert(TargetSelection::from_user(&triple), target);
1097             }
1098         }
1099
1100         if config.llvm_from_ci {
1101             let triple = &config.build.triple;
1102             let mut build_target = config
1103                 .target_config
1104                 .entry(config.build)
1105                 .or_insert_with(|| Target::from_triple(&triple));
1106
1107             check_ci_llvm!(build_target.llvm_config);
1108             check_ci_llvm!(build_target.llvm_filecheck);
1109             let ci_llvm_bin = config.out.join(&*config.build.triple).join("ci-llvm/bin");
1110             build_target.llvm_config = Some(ci_llvm_bin.join(exe("llvm-config", config.build)));
1111             build_target.llvm_filecheck = Some(ci_llvm_bin.join(exe("FileCheck", config.build)));
1112         }
1113
1114         if let Some(t) = toml.dist {
1115             config.dist_sign_folder = t.sign_folder.map(PathBuf::from);
1116             config.dist_upload_addr = t.upload_addr;
1117             config.dist_compression_formats = t.compression_formats;
1118             set(&mut config.rust_dist_src, t.src_tarball);
1119             set(&mut config.missing_tools, t.missing_tools);
1120         }
1121
1122         config.initial_rustfmt = config.initial_rustfmt.or_else({
1123             let build = config.build;
1124             let initial_rustc = &config.initial_rustc;
1125
1126             move || {
1127                 // Cargo does not provide a RUSTFMT environment variable, so we
1128                 // synthesize it manually.
1129                 let rustfmt = initial_rustc.with_file_name(exe("rustfmt", build));
1130
1131                 if rustfmt.exists() { Some(rustfmt) } else { None }
1132             }
1133         });
1134
1135         // Now that we've reached the end of our configuration, infer the
1136         // default values for all options that we haven't otherwise stored yet.
1137
1138         config.llvm_skip_rebuild = llvm_skip_rebuild.unwrap_or(false);
1139         config.llvm_assertions = llvm_assertions.unwrap_or(false);
1140         config.llvm_tests = llvm_tests.unwrap_or(false);
1141         config.llvm_plugins = llvm_plugins.unwrap_or(false);
1142         config.rust_optimize = optimize.unwrap_or(true);
1143
1144         let default = debug == Some(true);
1145         config.rust_debug_assertions = debug_assertions.unwrap_or(default);
1146         config.rust_debug_assertions_std =
1147             debug_assertions_std.unwrap_or(config.rust_debug_assertions);
1148         config.rust_overflow_checks = overflow_checks.unwrap_or(default);
1149         config.rust_overflow_checks_std =
1150             overflow_checks_std.unwrap_or(config.rust_overflow_checks);
1151
1152         config.rust_debug_logging = debug_logging.unwrap_or(config.rust_debug_assertions);
1153
1154         let with_defaults = |debuginfo_level_specific: Option<u32>| {
1155             debuginfo_level_specific.or(debuginfo_level).unwrap_or(if debug == Some(true) {
1156                 1
1157             } else {
1158                 0
1159             })
1160         };
1161         config.rust_debuginfo_level_rustc = with_defaults(debuginfo_level_rustc);
1162         config.rust_debuginfo_level_std = with_defaults(debuginfo_level_std);
1163         config.rust_debuginfo_level_tools = with_defaults(debuginfo_level_tools);
1164         config.rust_debuginfo_level_tests = debuginfo_level_tests.unwrap_or(0);
1165
1166         let default = config.channel == "dev";
1167         config.ignore_git = ignore_git.unwrap_or(default);
1168
1169         let download_rustc = config.download_rustc;
1170         // See https://github.com/rust-lang/compiler-team/issues/326
1171         config.stage = match config.cmd {
1172             Subcommand::Check { .. } => flags.stage.or(build.check_stage).unwrap_or(0),
1173             // `download-rustc` only has a speed-up for stage2 builds. Default to stage2 unless explicitly overridden.
1174             Subcommand::Doc { .. } => {
1175                 flags.stage.or(build.doc_stage).unwrap_or(if download_rustc { 2 } else { 0 })
1176             }
1177             Subcommand::Build { .. } => {
1178                 flags.stage.or(build.build_stage).unwrap_or(if download_rustc { 2 } else { 1 })
1179             }
1180             Subcommand::Test { .. } => {
1181                 flags.stage.or(build.test_stage).unwrap_or(if download_rustc { 2 } else { 1 })
1182             }
1183             Subcommand::Bench { .. } => flags.stage.or(build.bench_stage).unwrap_or(2),
1184             Subcommand::Dist { .. } => flags.stage.or(build.dist_stage).unwrap_or(2),
1185             Subcommand::Install { .. } => flags.stage.or(build.install_stage).unwrap_or(2),
1186             // These are all bootstrap tools, which don't depend on the compiler.
1187             // The stage we pass shouldn't matter, but use 0 just in case.
1188             Subcommand::Clean { .. }
1189             | Subcommand::Clippy { .. }
1190             | Subcommand::Fix { .. }
1191             | Subcommand::Run { .. }
1192             | Subcommand::Setup { .. }
1193             | Subcommand::Format { .. } => flags.stage.unwrap_or(0),
1194         };
1195
1196         // CI should always run stage 2 builds, unless it specifically states otherwise
1197         #[cfg(not(test))]
1198         if flags.stage.is_none() && crate::CiEnv::current() != crate::CiEnv::None {
1199             match config.cmd {
1200                 Subcommand::Test { .. }
1201                 | Subcommand::Doc { .. }
1202                 | Subcommand::Build { .. }
1203                 | Subcommand::Bench { .. }
1204                 | Subcommand::Dist { .. }
1205                 | Subcommand::Install { .. } => {
1206                     assert_eq!(
1207                         config.stage, 2,
1208                         "x.py should be run with `--stage 2` on CI, but was run with `--stage {}`",
1209                         config.stage,
1210                     );
1211                 }
1212                 Subcommand::Clean { .. }
1213                 | Subcommand::Check { .. }
1214                 | Subcommand::Clippy { .. }
1215                 | Subcommand::Fix { .. }
1216                 | Subcommand::Run { .. }
1217                 | Subcommand::Setup { .. }
1218                 | Subcommand::Format { .. } => {}
1219             }
1220         }
1221
1222         config
1223     }
1224
1225     /// Try to find the relative path of `bindir`, otherwise return it in full.
1226     pub fn bindir_relative(&self) -> &Path {
1227         let bindir = &self.bindir;
1228         if bindir.is_absolute() {
1229             // Try to make it relative to the prefix.
1230             if let Some(prefix) = &self.prefix {
1231                 if let Ok(stripped) = bindir.strip_prefix(prefix) {
1232                     return stripped;
1233                 }
1234             }
1235         }
1236         bindir
1237     }
1238
1239     /// Try to find the relative path of `libdir`.
1240     pub fn libdir_relative(&self) -> Option<&Path> {
1241         let libdir = self.libdir.as_ref()?;
1242         if libdir.is_relative() {
1243             Some(libdir)
1244         } else {
1245             // Try to make it relative to the prefix.
1246             libdir.strip_prefix(self.prefix.as_ref()?).ok()
1247         }
1248     }
1249
1250     pub fn verbose(&self) -> bool {
1251         self.verbose > 0
1252     }
1253
1254     pub fn sanitizers_enabled(&self, target: TargetSelection) -> bool {
1255         self.target_config.get(&target).map(|t| t.sanitizers).flatten().unwrap_or(self.sanitizers)
1256     }
1257
1258     pub fn any_sanitizers_enabled(&self) -> bool {
1259         self.target_config.values().any(|t| t.sanitizers == Some(true)) || self.sanitizers
1260     }
1261
1262     pub fn profiler_enabled(&self, target: TargetSelection) -> bool {
1263         self.target_config.get(&target).map(|t| t.profiler).flatten().unwrap_or(self.profiler)
1264     }
1265
1266     pub fn any_profiler_enabled(&self) -> bool {
1267         self.target_config.values().any(|t| t.profiler == Some(true)) || self.profiler
1268     }
1269
1270     pub fn llvm_enabled(&self) -> bool {
1271         self.rust_codegen_backends.contains(&INTERNER.intern_str("llvm"))
1272     }
1273
1274     pub fn submodules(&self, rust_info: &GitInfo) -> bool {
1275         self.submodules.unwrap_or(rust_info.is_git())
1276     }
1277 }
1278
1279 fn set<T>(field: &mut T, val: Option<T>) {
1280     if let Some(v) = val {
1281         *field = v;
1282     }
1283 }
1284
1285 fn threads_from_config(v: u32) -> u32 {
1286     match v {
1287         0 => std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get) as u32,
1288         n => n,
1289     }
1290 }