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::cell::{Cell, RefCell};
   7 use std::cmp;
   8 use std::collections::{HashMap, HashSet};
   9 use std::env;
  10 use std::ffi::OsStr;
  11 use std::fmt;
  12 use std::fs;
  13 use std::path::{Path, PathBuf};
  14 use std::process::Command;
  15 use std::str::FromStr;
  16
  17 use crate::builder::{Builder, TaskPath};
  18 use crate::cache::{Interned, INTERNER};
  19 use crate::channel::GitInfo;
  20 pub use crate::flags::Subcommand;
  21 use crate::flags::{Color, Flags};
  22 use crate::util::{exe, output, program_out_of_date, t};
  23 use once_cell::sync::OnceCell;
  24 use serde::{Deserialize, Deserializer};
  25
  26 macro_rules! check_ci_llvm {
  27     ($name:expr) => {
  28         assert!(
  29             $name.is_none(),
  30             "setting {} is incompatible with download-ci-llvm.",
  31             stringify!($name)
  32         );
  33     };
  34 }
  35
  36 /// Global configuration for the entire build and/or bootstrap.
  37 ///
  38 /// This structure is derived from a combination of both `config.toml` and
  39 /// `config.mk`. As of the time of this writing it's unlikely that `config.toml`
  40 /// is used all that much, so this is primarily filled out by `config.mk` which
  41 /// is generated from `./configure`.
  42 ///
  43 /// Note that this structure is not decoded directly into, but rather it is
  44 /// filled out from the decoded forms of the structs below. For documentation
  45 /// each field, see the corresponding fields in
  46 /// `config.toml.example`.
  47 #[derive(Default)]
  48 #[cfg_attr(test, derive(Clone))]
  49 pub struct Config {
  50     pub changelog_seen: Option<usize>,
  51     pub ccache: Option<String>,
  52     /// Call Build::ninja() instead of this.
  53     pub ninja_in_file: bool,
  54     pub verbose: usize,
  55     pub submodules: Option<bool>,
  56     pub compiler_docs: bool,
  57     pub docs_minification: bool,
  58     pub docs: bool,
  59     pub locked_deps: bool,
  60     pub vendor: bool,
  61     pub target_config: HashMap<TargetSelection, Target>,
  62     pub full_bootstrap: bool,
  63     pub extended: bool,
  64     pub tools: Option<HashSet<String>>,
  65     pub sanitizers: bool,
  66     pub profiler: bool,
  67     pub ignore_git: bool,
  68     pub exclude: Vec<TaskPath>,
  69     pub include_default_paths: bool,
  70     pub rustc_error_format: Option<String>,
  71     pub json_output: bool,
  72     pub test_compare_mode: bool,
  73     pub color: Color,
  74     pub patch_binaries_for_nix: bool,
  75     pub stage0_metadata: Stage0Metadata,
  76
  77     pub on_fail: Option<String>,
  78     pub stage: u32,
  79     pub keep_stage: Vec<u32>,
  80     pub keep_stage_std: Vec<u32>,
  81     pub src: PathBuf,
  82     /// defaults to `config.toml`
  83     pub config: PathBuf,
  84     pub jobs: Option<u32>,
  85     pub cmd: Subcommand,
  86     pub incremental: bool,
  87     pub dry_run: bool,
  88     /// `None` if we shouldn't download CI compiler artifacts, or the commit to download if we should.
  89     #[cfg(not(test))]
  90     download_rustc_commit: Option<String>,
  91     #[cfg(test)]
  92     pub download_rustc_commit: Option<String>,
  93
  94     pub deny_warnings: bool,
  95     pub backtrace_on_ice: bool,
  96
  97     // llvm codegen options
  98     pub llvm_skip_rebuild: bool,
  99     pub llvm_assertions: bool,
 100     pub llvm_tests: bool,
 101     pub llvm_plugins: bool,
 102     pub llvm_optimize: bool,
 103     pub llvm_thin_lto: bool,
 104     pub llvm_release_debuginfo: bool,
 105     pub llvm_version_check: bool,
 106     pub llvm_static_stdcpp: bool,
 107     /// `None` if `llvm_from_ci` is true and we haven't yet downloaded llvm.
 108     #[cfg(not(test))]
 109     llvm_link_shared: Cell<Option<bool>>,
 110     #[cfg(test)]
 111     pub llvm_link_shared: Cell<Option<bool>>,
 112     pub llvm_clang_cl: Option<String>,
 113     pub llvm_targets: Option<String>,
 114     pub llvm_experimental_targets: Option<String>,
 115     pub llvm_link_jobs: Option<u32>,
 116     pub llvm_version_suffix: Option<String>,
 117     pub llvm_use_linker: Option<String>,
 118     pub llvm_allow_old_toolchain: bool,
 119     pub llvm_polly: bool,
 120     pub llvm_clang: bool,
 121     pub llvm_from_ci: bool,
 122     pub llvm_build_config: HashMap<String, String>,
 123
 124     pub use_lld: bool,
 125     pub lld_enabled: bool,
 126     pub llvm_tools_enabled: bool,
 127
 128     pub llvm_cflags: Option<String>,
 129     pub llvm_cxxflags: Option<String>,
 130     pub llvm_ldflags: Option<String>,
 131     pub llvm_use_libcxx: bool,
 132
 133     // rust codegen options
 134     pub rust_optimize: bool,
 135     pub rust_codegen_units: Option<u32>,
 136     pub rust_codegen_units_std: Option<u32>,
 137     pub rust_debug_assertions: bool,
 138     pub rust_debug_assertions_std: bool,
 139     pub rust_overflow_checks: bool,
 140     pub rust_overflow_checks_std: bool,
 141     pub rust_debug_logging: bool,
 142     pub rust_debuginfo_level_rustc: u32,
 143     pub rust_debuginfo_level_std: u32,
 144     pub rust_debuginfo_level_tools: u32,
 145     pub rust_debuginfo_level_tests: u32,
 146     pub rust_split_debuginfo: SplitDebuginfo,
 147     pub rust_rpath: bool,
 148     pub rustc_parallel: bool,
 149     pub rustc_default_linker: Option<String>,
 150     pub rust_optimize_tests: bool,
 151     pub rust_dist_src: bool,
 152     pub rust_codegen_backends: Vec<Interned<String>>,
 153     pub rust_verify_llvm_ir: bool,
 154     pub rust_thin_lto_import_instr_limit: Option<u32>,
 155     pub rust_remap_debuginfo: bool,
 156     pub rust_new_symbol_mangling: Option<bool>,
 157     pub rust_profile_use: Option<String>,
 158     pub rust_profile_generate: Option<String>,
 159     pub llvm_profile_use: Option<String>,
 160     pub llvm_profile_generate: bool,
 161     pub llvm_libunwind_default: Option<LlvmLibunwind>,
 162
 163     pub build: TargetSelection,
 164     pub hosts: Vec<TargetSelection>,
 165     pub targets: Vec<TargetSelection>,
 166     pub local_rebuild: bool,
 167     pub jemalloc: bool,
 168     pub control_flow_guard: bool,
 169
 170     // dist misc
 171     pub dist_sign_folder: Option<PathBuf>,
 172     pub dist_upload_addr: Option<String>,
 173     pub dist_compression_formats: Option<Vec<String>>,
 174
 175     // libstd features
 176     pub backtrace: bool, // support for RUST_BACKTRACE
 177
 178     // misc
 179     pub low_priority: bool,
 180     pub channel: String,
 181     pub description: Option<String>,
 182     pub verbose_tests: bool,
 183     pub save_toolstates: Option<PathBuf>,
 184     pub print_step_timings: bool,
 185     pub print_step_rusage: bool,
 186     pub missing_tools: bool,
 187
 188     // Fallback musl-root for all targets
 189     pub musl_root: Option<PathBuf>,
 190     pub prefix: Option<PathBuf>,
 191     pub sysconfdir: Option<PathBuf>,
 192     pub datadir: Option<PathBuf>,
 193     pub docdir: Option<PathBuf>,
 194     pub bindir: PathBuf,
 195     pub libdir: Option<PathBuf>,
 196     pub mandir: Option<PathBuf>,
 197     pub codegen_tests: bool,
 198     pub nodejs: Option<PathBuf>,
 199     pub npm: Option<PathBuf>,
 200     pub gdb: Option<PathBuf>,
 201     pub python: Option<PathBuf>,
 202     pub cargo_native_static: bool,
 203     pub configure_args: Vec<String>,
 204
 205     // These are either the stage0 downloaded binaries or the locally installed ones.
 206     pub initial_cargo: PathBuf,
 207     pub initial_rustc: PathBuf,
 208     #[cfg(not(test))]
 209     initial_rustfmt: RefCell<RustfmtState>,
 210     #[cfg(test)]
 211     pub initial_rustfmt: RefCell<RustfmtState>,
 212     pub out: PathBuf,
 213 }
 214
 215 #[derive(Default, Deserialize)]
 216 #[cfg_attr(test, derive(Clone))]
 217 pub struct Stage0Metadata {
 218     pub config: Stage0Config,
 219     pub checksums_sha256: HashMap<String, String>,
 220     pub rustfmt: Option<RustfmtMetadata>,
 221 }
 222 #[derive(Default, Deserialize)]
 223 #[cfg_attr(test, derive(Clone))]
 224 pub struct Stage0Config {
 225     pub dist_server: String,
 226     pub artifacts_server: String,
 227     pub artifacts_with_llvm_assertions_server: String,
 228     pub git_merge_commit_email: String,
 229     pub nightly_branch: String,
 230 }
 231 #[derive(Default, Deserialize)]
 232 #[cfg_attr(test, derive(Clone))]
 233 pub struct RustfmtMetadata {
 234     pub date: String,
 235     pub version: String,
 236 }
 237
 238 #[derive(Clone, Debug)]
 239 pub enum RustfmtState {
 240     SystemToolchain(PathBuf),
 241     Downloaded(PathBuf),
 242     Unavailable,
 243     LazyEvaluated,
 244 }
 245
 246 impl Default for RustfmtState {
 247     fn default() -> Self {
 248         RustfmtState::LazyEvaluated
 249     }
 250 }
 251
 252 #[derive(Debug, Clone, Copy, PartialEq)]
 253 pub enum LlvmLibunwind {
 254     No,
 255     InTree,
 256     System,
 257 }
 258
 259 impl Default for LlvmLibunwind {
 260     fn default() -> Self {
 261         Self::No
 262     }
 263 }
 264
 265 impl FromStr for LlvmLibunwind {
 266     type Err = String;
 267
 268     fn from_str(value: &str) -> Result<Self, Self::Err> {
 269         match value {
 270             "no" => Ok(Self::No),
 271             "in-tree" => Ok(Self::InTree),
 272             "system" => Ok(Self::System),
 273             invalid => Err(format!("Invalid value '{}' for rust.llvm-libunwind config.", invalid)),
 274         }
 275     }
 276 }
 277
 278 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
 279 pub enum SplitDebuginfo {
 280     Packed,
 281     Unpacked,
 282     Off,
 283 }
 284
 285 impl Default for SplitDebuginfo {
 286     fn default() -> Self {
 287         SplitDebuginfo::Off
 288     }
 289 }
 290
 291 impl std::str::FromStr for SplitDebuginfo {
 292     type Err = ();
 293
 294     fn from_str(s: &str) -> Result<Self, Self::Err> {
 295         match s {
 296             "packed" => Ok(SplitDebuginfo::Packed),
 297             "unpacked" => Ok(SplitDebuginfo::Unpacked),
 298             "off" => Ok(SplitDebuginfo::Off),
 299             _ => Err(()),
 300         }
 301     }
 302 }
 303
 304 impl SplitDebuginfo {
 305     /// Returns the default `-Csplit-debuginfo` value for the current target. See the comment for
 306     /// `rust.split-debuginfo` in `config.toml.example`.
 307     fn default_for_platform(target: &str) -> Self {
 308         if target.contains("apple") {
 309             SplitDebuginfo::Unpacked
 310         } else if target.contains("windows") {
 311             SplitDebuginfo::Packed
 312         } else {
 313             SplitDebuginfo::Off
 314         }
 315     }
 316 }
 317
 318 #[derive(Copy, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
 319 pub struct TargetSelection {
 320     pub triple: Interned<String>,
 321     file: Option<Interned<String>>,
 322 }
 323
 324 impl TargetSelection {
 325     pub fn from_user(selection: &str) -> Self {
 326         let path = Path::new(selection);
 327
 328         let (triple, file) = if path.exists() {
 329             let triple = path
 330                 .file_stem()
 331                 .expect("Target specification file has no file stem")
 332                 .to_str()
 333                 .expect("Target specification file stem is not UTF-8");
 334
 335             (triple, Some(selection))
 336         } else {
 337             (selection, None)
 338         };
 339
 340         let triple = INTERNER.intern_str(triple);
 341         let file = file.map(|f| INTERNER.intern_str(f));
 342
 343         Self { triple, file }
 344     }
 345
 346     pub fn rustc_target_arg(&self) -> &str {
 347         self.file.as_ref().unwrap_or(&self.triple)
 348     }
 349
 350     pub fn contains(&self, needle: &str) -> bool {
 351         self.triple.contains(needle)
 352     }
 353
 354     pub fn starts_with(&self, needle: &str) -> bool {
 355         self.triple.starts_with(needle)
 356     }
 357
 358     pub fn ends_with(&self, needle: &str) -> bool {
 359         self.triple.ends_with(needle)
 360     }
 361 }
 362
 363 impl fmt::Display for TargetSelection {
 364     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 365         write!(f, "{}", self.triple)?;
 366         if let Some(file) = self.file {
 367             write!(f, "({})", file)?;
 368         }
 369         Ok(())
 370     }
 371 }
 372
 373 impl fmt::Debug for TargetSelection {
 374     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 375         write!(f, "{}", self)
 376     }
 377 }
 378
 379 impl PartialEq<&str> for TargetSelection {
 380     fn eq(&self, other: &&str) -> bool {
 381         self.triple == *other
 382     }
 383 }
 384
 385 /// Per-target configuration stored in the global configuration structure.
 386 #[derive(Default)]
 387 #[cfg_attr(test, derive(Clone))]
 388 pub struct Target {
 389     /// Some(path to llvm-config) if using an external LLVM.
 390     pub llvm_config: Option<PathBuf>,
 391     /// Some(path to FileCheck) if one was specified.
 392     pub llvm_filecheck: Option<PathBuf>,
 393     pub llvm_libunwind: Option<LlvmLibunwind>,
 394     pub cc: Option<PathBuf>,
 395     pub cxx: Option<PathBuf>,
 396     pub ar: Option<PathBuf>,
 397     pub ranlib: Option<PathBuf>,
 398     pub default_linker: Option<PathBuf>,
 399     pub linker: Option<PathBuf>,
 400     pub ndk: Option<PathBuf>,
 401     pub sanitizers: Option<bool>,
 402     pub profiler: Option<bool>,
 403     pub crt_static: Option<bool>,
 404     pub musl_root: Option<PathBuf>,
 405     pub musl_libdir: Option<PathBuf>,
 406     pub wasi_root: Option<PathBuf>,
 407     pub qemu_rootfs: Option<PathBuf>,
 408     pub no_std: bool,
 409 }
 410
 411 impl Target {
 412     pub fn from_triple(triple: &str) -> Self {
 413         let mut target: Self = Default::default();
 414         if triple.contains("-none") || triple.contains("nvptx") || triple.contains("switch") {
 415             target.no_std = true;
 416         }
 417         target
 418     }
 419 }
 420 /// Structure of the `config.toml` file that configuration is read from.
 421 ///
 422 /// This structure uses `Decodable` to automatically decode a TOML configuration
 423 /// file into this format, and then this is traversed and written into the above
 424 /// `Config` structure.
 425 #[derive(Deserialize, Default)]
 426 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
 427 struct TomlConfig {
 428     changelog_seen: Option<usize>,
 429     build: Option<Build>,
 430     install: Option<Install>,
 431     llvm: Option<Llvm>,
 432     rust: Option<Rust>,
 433     target: Option<HashMap<String, TomlTarget>>,
 434     dist: Option<Dist>,
 435     profile: Option<String>,
 436 }
 437
 438 trait Merge {
 439     fn merge(&mut self, other: Self);
 440 }
 441
 442 impl Merge for TomlConfig {
 443     fn merge(
 444         &mut self,
 445         TomlConfig { build, install, llvm, rust, dist, target, profile: _, changelog_seen: _ }: Self,
 446     ) {
 447         fn do_merge<T: Merge>(x: &mut Option<T>, y: Option<T>) {
 448             if let Some(new) = y {
 449                 if let Some(original) = x {
 450                     original.merge(new);
 451                 } else {
 452                     *x = Some(new);
 453                 }
 454             }
 455         }
 456         do_merge(&mut self.build, build);
 457         do_merge(&mut self.install, install);
 458         do_merge(&mut self.llvm, llvm);
 459         do_merge(&mut self.rust, rust);
 460         do_merge(&mut self.dist, dist);
 461         assert!(target.is_none(), "merging target-specific config is not currently supported");
 462     }
 463 }
 464
 465 // We are using a decl macro instead of a derive proc macro here to reduce the compile time of
 466 // rustbuild.
 467 macro_rules! define_config {
 468     ($(#[$attr:meta])* struct $name:ident {
 469         $($field:ident: Option<$field_ty:ty> = $field_key:literal,)*
 470     }) => {
 471         $(#[$attr])*
 472         struct $name {
 473             $($field: Option<$field_ty>,)*
 474         }
 475
 476         impl Merge for $name {
 477             fn merge(&mut self, other: Self) {
 478                 $(
 479                     if !self.$field.is_some() {
 480                         self.$field = other.$field;
 481                     }
 482                 )*
 483             }
 484         }
 485
 486         // The following is a trimmed version of what serde_derive generates. All parts not relevant
 487         // for toml deserialization have been removed. This reduces the binary size and improves
 488         // compile time of rustbuild.
 489         impl<'de> Deserialize<'de> for $name {
 490             fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
 491             where
 492                 D: Deserializer<'de>,
 493             {
 494                 struct Field;
 495                 impl<'de> serde::de::Visitor<'de> for Field {
 496                     type Value = $name;
 497                     fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 498                         f.write_str(concat!("struct ", stringify!($name)))
 499                     }
 500
 501                     #[inline]
 502                     fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error>
 503                     where
 504                         A: serde::de::MapAccess<'de>,
 505                     {
 506                         $(let mut $field: Option<$field_ty> = None;)*
 507                         while let Some(key) =
 508                             match serde::de::MapAccess::next_key::<String>(&mut map) {
 509                                 Ok(val) => val,
 510                                 Err(err) => {
 511                                     return Err(err);
 512                                 }
 513                             }
 514                         {
 515                             match &*key {
 516                                 $($field_key => {
 517                                     if $field.is_some() {
 518                                         return Err(<A::Error as serde::de::Error>::duplicate_field(
 519                                             $field_key,
 520                                         ));
 521                                     }
 522                                     $field = match serde::de::MapAccess::next_value::<$field_ty>(
 523                                         &mut map,
 524                                     ) {
 525                                         Ok(val) => Some(val),
 526                                         Err(err) => {
 527                                             return Err(err);
 528                                         }
 529                                     };
 530                                 })*
 531                                 key => {
 532                                     return Err(serde::de::Error::unknown_field(key, FIELDS));
 533                                 }
 534                             }
 535                         }
 536                         Ok($name { $($field),* })
 537                     }
 538                 }
 539                 const FIELDS: &'static [&'static str] = &[
 540                     $($field_key,)*
 541                 ];
 542                 Deserializer::deserialize_struct(
 543                     deserializer,
 544                     stringify!($name),
 545                     FIELDS,
 546                     Field,
 547                 )
 548             }
 549         }
 550     }
 551 }
 552
 553 define_config! {
 554     /// TOML representation of various global build decisions.
 555     #[derive(Default)]
 556     struct Build {
 557         build: Option<String> = "build",
 558         host: Option<Vec<String>> = "host",
 559         target: Option<Vec<String>> = "target",
 560         build_dir: Option<String> = "build-dir",
 561         cargo: Option<String> = "cargo",
 562         rustc: Option<String> = "rustc",
 563         rustfmt: Option<PathBuf> = "rustfmt",
 564         docs: Option<bool> = "docs",
 565         compiler_docs: Option<bool> = "compiler-docs",
 566         docs_minification: Option<bool> = "docs-minification",
 567         submodules: Option<bool> = "submodules",
 568         gdb: Option<String> = "gdb",
 569         nodejs: Option<String> = "nodejs",
 570         npm: Option<String> = "npm",
 571         python: Option<String> = "python",
 572         locked_deps: Option<bool> = "locked-deps",
 573         vendor: Option<bool> = "vendor",
 574         full_bootstrap: Option<bool> = "full-bootstrap",
 575         extended: Option<bool> = "extended",
 576         tools: Option<HashSet<String>> = "tools",
 577         verbose: Option<usize> = "verbose",
 578         sanitizers: Option<bool> = "sanitizers",
 579         profiler: Option<bool> = "profiler",
 580         cargo_native_static: Option<bool> = "cargo-native-static",
 581         low_priority: Option<bool> = "low-priority",
 582         configure_args: Option<Vec<String>> = "configure-args",
 583         local_rebuild: Option<bool> = "local-rebuild",
 584         print_step_timings: Option<bool> = "print-step-timings",
 585         print_step_rusage: Option<bool> = "print-step-rusage",
 586         check_stage: Option<u32> = "check-stage",
 587         doc_stage: Option<u32> = "doc-stage",
 588         build_stage: Option<u32> = "build-stage",
 589         test_stage: Option<u32> = "test-stage",
 590         install_stage: Option<u32> = "install-stage",
 591         dist_stage: Option<u32> = "dist-stage",
 592         bench_stage: Option<u32> = "bench-stage",
 593         patch_binaries_for_nix: Option<bool> = "patch-binaries-for-nix",
 594         metrics: Option<bool> = "metrics",
 595     }
 596 }
 597
 598 define_config! {
 599     /// TOML representation of various global install decisions.
 600     struct Install {
 601         prefix: Option<String> = "prefix",
 602         sysconfdir: Option<String> = "sysconfdir",
 603         docdir: Option<String> = "docdir",
 604         bindir: Option<String> = "bindir",
 605         libdir: Option<String> = "libdir",
 606         mandir: Option<String> = "mandir",
 607         datadir: Option<String> = "datadir",
 608     }
 609 }
 610
 611 define_config! {
 612     /// TOML representation of how the LLVM build is configured.
 613     struct Llvm {
 614         skip_rebuild: Option<bool> = "skip-rebuild",
 615         optimize: Option<bool> = "optimize",
 616         thin_lto: Option<bool> = "thin-lto",
 617         release_debuginfo: Option<bool> = "release-debuginfo",
 618         assertions: Option<bool> = "assertions",
 619         tests: Option<bool> = "tests",
 620         plugins: Option<bool> = "plugins",
 621         ccache: Option<StringOrBool> = "ccache",
 622         version_check: Option<bool> = "version-check",
 623         static_libstdcpp: Option<bool> = "static-libstdcpp",
 624         ninja: Option<bool> = "ninja",
 625         targets: Option<String> = "targets",
 626         experimental_targets: Option<String> = "experimental-targets",
 627         link_jobs: Option<u32> = "link-jobs",
 628         link_shared: Option<bool> = "link-shared",
 629         version_suffix: Option<String> = "version-suffix",
 630         clang_cl: Option<String> = "clang-cl",
 631         cflags: Option<String> = "cflags",
 632         cxxflags: Option<String> = "cxxflags",
 633         ldflags: Option<String> = "ldflags",
 634         use_libcxx: Option<bool> = "use-libcxx",
 635         use_linker: Option<String> = "use-linker",
 636         allow_old_toolchain: Option<bool> = "allow-old-toolchain",
 637         polly: Option<bool> = "polly",
 638         clang: Option<bool> = "clang",
 639         download_ci_llvm: Option<StringOrBool> = "download-ci-llvm",
 640         build_config: Option<HashMap<String, String>> = "build-config",
 641     }
 642 }
 643
 644 define_config! {
 645     struct Dist {
 646         sign_folder: Option<String> = "sign-folder",
 647         gpg_password_file: Option<String> = "gpg-password-file",
 648         upload_addr: Option<String> = "upload-addr",
 649         src_tarball: Option<bool> = "src-tarball",
 650         missing_tools: Option<bool> = "missing-tools",
 651         compression_formats: Option<Vec<String>> = "compression-formats",
 652     }
 653 }
 654
 655 #[derive(Deserialize)]
 656 #[serde(untagged)]
 657 enum StringOrBool {
 658     String(String),
 659     Bool(bool),
 660 }
 661
 662 impl Default for StringOrBool {
 663     fn default() -> StringOrBool {
 664         StringOrBool::Bool(false)
 665     }
 666 }
 667
 668 define_config! {
 669     /// TOML representation of how the Rust build is configured.
 670     struct Rust {
 671         optimize: Option<bool> = "optimize",
 672         debug: Option<bool> = "debug",
 673         codegen_units: Option<u32> = "codegen-units",
 674         codegen_units_std: Option<u32> = "codegen-units-std",
 675         debug_assertions: Option<bool> = "debug-assertions",
 676         debug_assertions_std: Option<bool> = "debug-assertions-std",
 677         overflow_checks: Option<bool> = "overflow-checks",
 678         overflow_checks_std: Option<bool> = "overflow-checks-std",
 679         debug_logging: Option<bool> = "debug-logging",
 680         debuginfo_level: Option<u32> = "debuginfo-level",
 681         debuginfo_level_rustc: Option<u32> = "debuginfo-level-rustc",
 682         debuginfo_level_std: Option<u32> = "debuginfo-level-std",
 683         debuginfo_level_tools: Option<u32> = "debuginfo-level-tools",
 684         debuginfo_level_tests: Option<u32> = "debuginfo-level-tests",
 685         split_debuginfo: Option<String> = "split-debuginfo",
 686         run_dsymutil: Option<bool> = "run-dsymutil",
 687         backtrace: Option<bool> = "backtrace",
 688         incremental: Option<bool> = "incremental",
 689         parallel_compiler: Option<bool> = "parallel-compiler",
 690         default_linker: Option<String> = "default-linker",
 691         channel: Option<String> = "channel",
 692         description: Option<String> = "description",
 693         musl_root: Option<String> = "musl-root",
 694         rpath: Option<bool> = "rpath",
 695         verbose_tests: Option<bool> = "verbose-tests",
 696         optimize_tests: Option<bool> = "optimize-tests",
 697         codegen_tests: Option<bool> = "codegen-tests",
 698         ignore_git: Option<bool> = "ignore-git",
 699         dist_src: Option<bool> = "dist-src",
 700         save_toolstates: Option<String> = "save-toolstates",
 701         codegen_backends: Option<Vec<String>> = "codegen-backends",
 702         lld: Option<bool> = "lld",
 703         use_lld: Option<bool> = "use-lld",
 704         llvm_tools: Option<bool> = "llvm-tools",
 705         deny_warnings: Option<bool> = "deny-warnings",
 706         backtrace_on_ice: Option<bool> = "backtrace-on-ice",
 707         verify_llvm_ir: Option<bool> = "verify-llvm-ir",
 708         thin_lto_import_instr_limit: Option<u32> = "thin-lto-import-instr-limit",
 709         remap_debuginfo: Option<bool> = "remap-debuginfo",
 710         jemalloc: Option<bool> = "jemalloc",
 711         test_compare_mode: Option<bool> = "test-compare-mode",
 712         llvm_libunwind: Option<String> = "llvm-libunwind",
 713         control_flow_guard: Option<bool> = "control-flow-guard",
 714         new_symbol_mangling: Option<bool> = "new-symbol-mangling",
 715         profile_generate: Option<String> = "profile-generate",
 716         profile_use: Option<String> = "profile-use",
 717         // ignored; this is set from an env var set by bootstrap.py
 718         download_rustc: Option<StringOrBool> = "download-rustc",
 719     }
 720 }
 721
 722 define_config! {
 723     /// TOML representation of how each build target is configured.
 724     struct TomlTarget {
 725         cc: Option<String> = "cc",
 726         cxx: Option<String> = "cxx",
 727         ar: Option<String> = "ar",
 728         ranlib: Option<String> = "ranlib",
 729         default_linker: Option<PathBuf> = "default-linker",
 730         linker: Option<String> = "linker",
 731         llvm_config: Option<String> = "llvm-config",
 732         llvm_filecheck: Option<String> = "llvm-filecheck",
 733         llvm_libunwind: Option<String> = "llvm-libunwind",
 734         android_ndk: Option<String> = "android-ndk",
 735         sanitizers: Option<bool> = "sanitizers",
 736         profiler: Option<bool> = "profiler",
 737         crt_static: Option<bool> = "crt-static",
 738         musl_root: Option<String> = "musl-root",
 739         musl_libdir: Option<String> = "musl-libdir",
 740         wasi_root: Option<String> = "wasi-root",
 741         qemu_rootfs: Option<String> = "qemu-rootfs",
 742         no_std: Option<bool> = "no-std",
 743     }
 744 }
 745
 746 impl Config {
 747     pub fn default_opts() -> Config {
 748         let mut config = Config::default();
 749         config.llvm_optimize = true;
 750         config.ninja_in_file = true;
 751         config.llvm_version_check = true;
 752         config.llvm_static_stdcpp = true;
 753         config.backtrace = true;
 754         config.rust_optimize = true;
 755         config.rust_optimize_tests = true;
 756         config.submodules = None;
 757         config.docs = true;
 758         config.docs_minification = true;
 759         config.rust_rpath = true;
 760         config.channel = "dev".to_string();
 761         config.codegen_tests = true;
 762         config.rust_dist_src = true;
 763         config.rust_codegen_backends = vec![INTERNER.intern_str("llvm")];
 764         config.deny_warnings = true;
 765         config.bindir = "bin".into();
 766
 767         // set by build.rs
 768         config.build = TargetSelection::from_user(&env!("BUILD_TRIPLE"));
 769         let manifest_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
 770         // Undo `src/bootstrap`
 771         config.src = manifest_dir.parent().unwrap().parent().unwrap().to_owned();
 772         config.out = PathBuf::from("build");
 773
 774         config.initial_cargo = PathBuf::from(env!("CARGO"));
 775         config.initial_rustc = PathBuf::from(env!("RUSTC"));
 776
 777         config
 778     }
 779
 780     pub fn parse(args: &[String]) -> Config {
 781         let flags = Flags::parse(&args);
 782
 783         let mut config = Config::default_opts();
 784         config.exclude = flags.exclude.into_iter().map(|path| TaskPath::parse(path)).collect();
 785         config.include_default_paths = flags.include_default_paths;
 786         config.rustc_error_format = flags.rustc_error_format;
 787         config.json_output = flags.json_output;
 788         config.on_fail = flags.on_fail;
 789         config.jobs = flags.jobs.map(threads_from_config);
 790         config.cmd = flags.cmd;
 791         config.incremental = flags.incremental;
 792         config.dry_run = flags.dry_run;
 793         config.keep_stage = flags.keep_stage;
 794         config.keep_stage_std = flags.keep_stage_std;
 795         config.color = flags.color;
 796         if let Some(value) = flags.deny_warnings {
 797             config.deny_warnings = value;
 798         }
 799         config.llvm_profile_use = flags.llvm_profile_use;
 800         config.llvm_profile_generate = flags.llvm_profile_generate;
 801
 802         let stage0_json = t!(std::fs::read(&config.src.join("src").join("stage0.json")));
 803         config.stage0_metadata = t!(serde_json::from_slice::<Stage0Metadata>(&stage0_json));
 804
 805         #[cfg(test)]
 806         let get_toml = |_| TomlConfig::default();
 807         #[cfg(not(test))]
 808         let get_toml = |file: &Path| {
 809             let contents =
 810                 t!(fs::read_to_string(file), format!("config file {} not found", file.display()));
 811             // Deserialize to Value and then TomlConfig to prevent the Deserialize impl of
 812             // TomlConfig and sub types to be monomorphized 5x by toml.
 813             match toml::from_str(&contents)
 814                 .and_then(|table: toml::Value| TomlConfig::deserialize(table))
 815             {
 816                 Ok(table) => table,
 817                 Err(err) => {
 818                     eprintln!("failed to parse TOML configuration '{}': {}", file.display(), err);
 819                     crate::detail_exit(2);
 820                 }
 821             }
 822         };
 823
 824         // Read from `--config`, then `RUST_BOOTSTRAP_CONFIG`, then `./config.toml`, then `config.toml` in the root directory.
 825         let toml_path = flags
 826             .config
 827             .clone()
 828             .or_else(|| env::var_os("RUST_BOOTSTRAP_CONFIG").map(PathBuf::from));
 829         let using_default_path = toml_path.is_none();
 830         let mut toml_path = toml_path.unwrap_or_else(|| PathBuf::from("config.toml"));
 831         if using_default_path && !toml_path.exists() {
 832             toml_path = config.src.join(toml_path);
 833         }
 834
 835         // Give a hard error if `--config` or `RUST_BOOTSTRAP_CONFIG` are set to a missing path,
 836         // but not if `config.toml` hasn't been created.
 837         let mut toml = if !using_default_path || toml_path.exists() {
 838             get_toml(&toml_path)
 839         } else {
 840             TomlConfig::default()
 841         };
 842
 843         if let Some(include) = &toml.profile {
 844             let mut include_path = config.src.clone();
 845             include_path.push("src");
 846             include_path.push("bootstrap");
 847             include_path.push("defaults");
 848             include_path.push(format!("config.{}.toml", include));
 849             let included_toml = get_toml(&include_path);
 850             toml.merge(included_toml);
 851         }
 852
 853         config.changelog_seen = toml.changelog_seen;
 854         config.config = toml_path;
 855
 856         let build = toml.build.unwrap_or_default();
 857
 858         set(&mut config.initial_rustc, build.rustc.map(PathBuf::from));
 859         set(&mut config.out, flags.build_dir.or_else(|| build.build_dir.map(PathBuf::from)));
 860         // NOTE: Bootstrap spawns various commands with different working directories.
 861         // To avoid writing to random places on the file system, `config.out` needs to be an absolute path.
 862         if !config.out.is_absolute() {
 863             // `canonicalize` requires the path to already exist. Use our vendored copy of `absolute` instead.
 864             config.out = crate::util::absolute(&config.out);
 865         }
 866
 867         if config.dry_run {
 868             let dir = config.out.join("tmp-dry-run");
 869             t!(fs::create_dir_all(&dir));
 870             config.out = dir;
 871         }
 872
 873         config.hosts = if let Some(arg_host) = flags.host {
 874             arg_host
 875         } else if let Some(file_host) = build.host {
 876             file_host.iter().map(|h| TargetSelection::from_user(h)).collect()
 877         } else {
 878             vec![config.build]
 879         };
 880         config.targets = if let Some(arg_target) = flags.target {
 881             arg_target
 882         } else if let Some(file_target) = build.target {
 883             file_target.iter().map(|h| TargetSelection::from_user(h)).collect()
 884         } else {
 885             // If target is *not* configured, then default to the host
 886             // toolchains.
 887             config.hosts.clone()
 888         };
 889
 890         config.nodejs = build.nodejs.map(PathBuf::from);
 891         config.npm = build.npm.map(PathBuf::from);
 892         config.gdb = build.gdb.map(PathBuf::from);
 893         config.python = build.python.map(PathBuf::from);
 894         config.submodules = build.submodules;
 895         set(&mut config.low_priority, build.low_priority);
 896         set(&mut config.compiler_docs, build.compiler_docs);
 897         set(&mut config.docs_minification, build.docs_minification);
 898         set(&mut config.docs, build.docs);
 899         set(&mut config.locked_deps, build.locked_deps);
 900         set(&mut config.vendor, build.vendor);
 901         set(&mut config.full_bootstrap, build.full_bootstrap);
 902         set(&mut config.extended, build.extended);
 903         config.tools = build.tools;
 904         set(&mut config.verbose, build.verbose);
 905         set(&mut config.sanitizers, build.sanitizers);
 906         set(&mut config.profiler, build.profiler);
 907         set(&mut config.cargo_native_static, build.cargo_native_static);
 908         set(&mut config.configure_args, build.configure_args);
 909         set(&mut config.local_rebuild, build.local_rebuild);
 910         set(&mut config.print_step_timings, build.print_step_timings);
 911         set(&mut config.print_step_rusage, build.print_step_rusage);
 912         set(&mut config.patch_binaries_for_nix, build.patch_binaries_for_nix);
 913
 914         config.verbose = cmp::max(config.verbose, flags.verbose);
 915
 916         if let Some(install) = toml.install {
 917             config.prefix = install.prefix.map(PathBuf::from);
 918             config.sysconfdir = install.sysconfdir.map(PathBuf::from);
 919             config.datadir = install.datadir.map(PathBuf::from);
 920             config.docdir = install.docdir.map(PathBuf::from);
 921             set(&mut config.bindir, install.bindir.map(PathBuf::from));
 922             config.libdir = install.libdir.map(PathBuf::from);
 923             config.mandir = install.mandir.map(PathBuf::from);
 924         }
 925
 926         // We want the llvm-skip-rebuild flag to take precedence over the
 927         // skip-rebuild config.toml option so we store it separately
 928         // so that we can infer the right value
 929         let mut llvm_skip_rebuild = flags.llvm_skip_rebuild;
 930
 931         // Store off these values as options because if they're not provided
 932         // we'll infer default values for them later
 933         let mut llvm_assertions = None;
 934         let mut llvm_tests = None;
 935         let mut llvm_plugins = None;
 936         let mut debug = None;
 937         let mut debug_assertions = None;
 938         let mut debug_assertions_std = None;
 939         let mut overflow_checks = None;
 940         let mut overflow_checks_std = None;
 941         let mut debug_logging = None;
 942         let mut debuginfo_level = None;
 943         let mut debuginfo_level_rustc = None;
 944         let mut debuginfo_level_std = None;
 945         let mut debuginfo_level_tools = None;
 946         let mut debuginfo_level_tests = None;
 947         let mut optimize = None;
 948         let mut ignore_git = None;
 949
 950         if let Some(llvm) = toml.llvm {
 951             match llvm.ccache {
 952                 Some(StringOrBool::String(ref s)) => config.ccache = Some(s.to_string()),
 953                 Some(StringOrBool::Bool(true)) => {
 954                     config.ccache = Some("ccache".to_string());
 955                 }
 956                 Some(StringOrBool::Bool(false)) | None => {}
 957             }
 958             set(&mut config.ninja_in_file, llvm.ninja);
 959             llvm_assertions = llvm.assertions;
 960             llvm_tests = llvm.tests;
 961             llvm_plugins = llvm.plugins;
 962             llvm_skip_rebuild = llvm_skip_rebuild.or(llvm.skip_rebuild);
 963             set(&mut config.llvm_optimize, llvm.optimize);
 964             set(&mut config.llvm_thin_lto, llvm.thin_lto);
 965             set(&mut config.llvm_release_debuginfo, llvm.release_debuginfo);
 966             set(&mut config.llvm_version_check, llvm.version_check);
 967             set(&mut config.llvm_static_stdcpp, llvm.static_libstdcpp);
 968             if let Some(v) = llvm.link_shared {
 969                 config.llvm_link_shared.set(Some(v));
 970             }
 971             config.llvm_targets = llvm.targets.clone();
 972             config.llvm_experimental_targets = llvm.experimental_targets.clone();
 973             config.llvm_link_jobs = llvm.link_jobs;
 974             config.llvm_version_suffix = llvm.version_suffix.clone();
 975             config.llvm_clang_cl = llvm.clang_cl.clone();
 976
 977             config.llvm_cflags = llvm.cflags.clone();
 978             config.llvm_cxxflags = llvm.cxxflags.clone();
 979             config.llvm_ldflags = llvm.ldflags.clone();
 980             set(&mut config.llvm_use_libcxx, llvm.use_libcxx);
 981             config.llvm_use_linker = llvm.use_linker.clone();
 982             config.llvm_allow_old_toolchain = llvm.allow_old_toolchain.unwrap_or(false);
 983             config.llvm_polly = llvm.polly.unwrap_or(false);
 984             config.llvm_clang = llvm.clang.unwrap_or(false);
 985             config.llvm_build_config = llvm.build_config.clone().unwrap_or(Default::default());
 986             config.llvm_from_ci = match llvm.download_ci_llvm {
 987                 Some(StringOrBool::String(s)) => {
 988                     assert!(s == "if-available", "unknown option `{}` for download-ci-llvm", s);
 989                     // This is currently all tier 1 targets and tier 2 targets with host tools
 990                     // (since others may not have CI artifacts)
 991                     // https://doc.rust-lang.org/rustc/platform-support.html#tier-1
 992                     // FIXME: this is duplicated in bootstrap.py
 993                     let supported_platforms = [
 994                         // tier 1
 995                         "aarch64-unknown-linux-gnu",
 996                         "i686-pc-windows-gnu",
 997                         "i686-pc-windows-msvc",
 998                         "i686-unknown-linux-gnu",
 999                         "x86_64-unknown-linux-gnu",
1000                         "x86_64-apple-darwin",
1001                         "x86_64-pc-windows-gnu",
1002                         "x86_64-pc-windows-msvc",
1003                         // tier 2 with host tools
1004                         "aarch64-apple-darwin",
1005                         "aarch64-pc-windows-msvc",
1006                         "aarch64-unknown-linux-musl",
1007                         "arm-unknown-linux-gnueabi",
1008                         "arm-unknown-linux-gnueabihf",
1009                         "armv7-unknown-linux-gnueabihf",
1010                         "mips-unknown-linux-gnu",
1011                         "mips64-unknown-linux-gnuabi64",
1012                         "mips64el-unknown-linux-gnuabi64",
1013                         "mipsel-unknown-linux-gnu",
1014                         "powerpc-unknown-linux-gnu",
1015                         "powerpc64-unknown-linux-gnu",
1016                         "powerpc64le-unknown-linux-gnu",
1017                         "riscv64gc-unknown-linux-gnu",
1018                         "s390x-unknown-linux-gnu",
1019                         "x86_64-unknown-freebsd",
1020                         "x86_64-unknown-illumos",
1021                         "x86_64-unknown-linux-musl",
1022                         "x86_64-unknown-netbsd",
1023                     ];
1024                     supported_platforms.contains(&&*config.build.triple)
1025                 }
1026                 Some(StringOrBool::Bool(b)) => b,
1027                 None => false,
1028             };
1029
1030             if config.llvm_from_ci {
1031                 // None of the LLVM options, except assertions, are supported
1032                 // when using downloaded LLVM. We could just ignore these but
1033                 // that's potentially confusing, so force them to not be
1034                 // explicitly set. The defaults and CI defaults don't
1035                 // necessarily match but forcing people to match (somewhat
1036                 // arbitrary) CI configuration locally seems bad/hard.
1037                 check_ci_llvm!(llvm.optimize);
1038                 check_ci_llvm!(llvm.thin_lto);
1039                 check_ci_llvm!(llvm.release_debuginfo);
1040                 // CI-built LLVM can be either dynamic or static. We won't know until we download it.
1041                 check_ci_llvm!(llvm.link_shared);
1042                 check_ci_llvm!(llvm.static_libstdcpp);
1043                 check_ci_llvm!(llvm.targets);
1044                 check_ci_llvm!(llvm.experimental_targets);
1045                 check_ci_llvm!(llvm.link_jobs);
1046                 check_ci_llvm!(llvm.clang_cl);
1047                 check_ci_llvm!(llvm.version_suffix);
1048                 check_ci_llvm!(llvm.cflags);
1049                 check_ci_llvm!(llvm.cxxflags);
1050                 check_ci_llvm!(llvm.ldflags);
1051                 check_ci_llvm!(llvm.use_libcxx);
1052                 check_ci_llvm!(llvm.use_linker);
1053                 check_ci_llvm!(llvm.allow_old_toolchain);
1054                 check_ci_llvm!(llvm.polly);
1055                 check_ci_llvm!(llvm.clang);
1056                 check_ci_llvm!(llvm.build_config);
1057                 check_ci_llvm!(llvm.plugins);
1058             }
1059
1060             // NOTE: can never be hit when downloading from CI, since we call `check_ci_llvm!(thin_lto)` above.
1061             if config.llvm_thin_lto && llvm.link_shared.is_none() {
1062                 // If we're building with ThinLTO on, by default we want to link
1063                 // to LLVM shared, to avoid re-doing ThinLTO (which happens in
1064                 // the link step) with each stage.
1065                 config.llvm_link_shared.set(Some(true));
1066             }
1067         }
1068
1069         if let Some(rust) = toml.rust {
1070             debug = rust.debug;
1071             debug_assertions = rust.debug_assertions;
1072             debug_assertions_std = rust.debug_assertions_std;
1073             overflow_checks = rust.overflow_checks;
1074             overflow_checks_std = rust.overflow_checks_std;
1075             debug_logging = rust.debug_logging;
1076             debuginfo_level = rust.debuginfo_level;
1077             debuginfo_level_rustc = rust.debuginfo_level_rustc;
1078             debuginfo_level_std = rust.debuginfo_level_std;
1079             debuginfo_level_tools = rust.debuginfo_level_tools;
1080             debuginfo_level_tests = rust.debuginfo_level_tests;
1081             config.rust_split_debuginfo = rust
1082                 .split_debuginfo
1083                 .as_deref()
1084                 .map(SplitDebuginfo::from_str)
1085                 .map(|v| v.expect("invalid value for rust.split_debuginfo"))
1086                 .unwrap_or(SplitDebuginfo::default_for_platform(&config.build.triple));
1087             optimize = rust.optimize;
1088             ignore_git = rust.ignore_git;
1089             config.rust_new_symbol_mangling = rust.new_symbol_mangling;
1090             set(&mut config.rust_optimize_tests, rust.optimize_tests);
1091             set(&mut config.codegen_tests, rust.codegen_tests);
1092             set(&mut config.rust_rpath, rust.rpath);
1093             set(&mut config.jemalloc, rust.jemalloc);
1094             set(&mut config.test_compare_mode, rust.test_compare_mode);
1095             set(&mut config.backtrace, rust.backtrace);
1096             set(&mut config.channel, rust.channel);
1097             config.description = rust.description;
1098             set(&mut config.rust_dist_src, rust.dist_src);
1099             set(&mut config.verbose_tests, rust.verbose_tests);
1100             // in the case "false" is set explicitly, do not overwrite the command line args
1101             if let Some(true) = rust.incremental {
1102                 config.incremental = true;
1103             }
1104             set(&mut config.use_lld, rust.use_lld);
1105             set(&mut config.lld_enabled, rust.lld);
1106             set(&mut config.llvm_tools_enabled, rust.llvm_tools);
1107             config.rustc_parallel = rust.parallel_compiler.unwrap_or(false);
1108             config.rustc_default_linker = rust.default_linker;
1109             config.musl_root = rust.musl_root.map(PathBuf::from);
1110             config.save_toolstates = rust.save_toolstates.map(PathBuf::from);
1111             set(&mut config.deny_warnings, flags.deny_warnings.or(rust.deny_warnings));
1112             set(&mut config.backtrace_on_ice, rust.backtrace_on_ice);
1113             set(&mut config.rust_verify_llvm_ir, rust.verify_llvm_ir);
1114             config.rust_thin_lto_import_instr_limit = rust.thin_lto_import_instr_limit;
1115             set(&mut config.rust_remap_debuginfo, rust.remap_debuginfo);
1116             set(&mut config.control_flow_guard, rust.control_flow_guard);
1117             config.llvm_libunwind_default = rust
1118                 .llvm_libunwind
1119                 .map(|v| v.parse().expect("failed to parse rust.llvm-libunwind"));
1120
1121             if let Some(ref backends) = rust.codegen_backends {
1122                 config.rust_codegen_backends =
1123                     backends.iter().map(|s| INTERNER.intern_str(s)).collect();
1124             }
1125
1126             config.rust_codegen_units = rust.codegen_units.map(threads_from_config);
1127             config.rust_codegen_units_std = rust.codegen_units_std.map(threads_from_config);
1128             config.rust_profile_use = flags.rust_profile_use.or(rust.profile_use);
1129             config.rust_profile_generate = flags.rust_profile_generate.or(rust.profile_generate);
1130             config.download_rustc_commit = download_ci_rustc_commit(&config, rust.download_rustc);
1131         } else {
1132             config.rust_profile_use = flags.rust_profile_use;
1133             config.rust_profile_generate = flags.rust_profile_generate;
1134         }
1135
1136         if let Some(t) = toml.target {
1137             for (triple, cfg) in t {
1138                 let mut target = Target::from_triple(&triple);
1139
1140                 if let Some(ref s) = cfg.llvm_config {
1141                     target.llvm_config = Some(config.src.join(s));
1142                 }
1143                 if let Some(ref s) = cfg.llvm_filecheck {
1144                     target.llvm_filecheck = Some(config.src.join(s));
1145                 }
1146                 target.llvm_libunwind = cfg
1147                     .llvm_libunwind
1148                     .as_ref()
1149                     .map(|v| v.parse().expect("failed to parse rust.llvm-libunwind"));
1150                 if let Some(ref s) = cfg.android_ndk {
1151                     target.ndk = Some(config.src.join(s));
1152                 }
1153                 if let Some(s) = cfg.no_std {
1154                     target.no_std = s;
1155                 }
1156                 target.cc = cfg.cc.map(PathBuf::from);
1157                 target.cxx = cfg.cxx.map(PathBuf::from);
1158                 target.ar = cfg.ar.map(PathBuf::from);
1159                 target.ranlib = cfg.ranlib.map(PathBuf::from);
1160                 target.linker = cfg.linker.map(PathBuf::from);
1161                 target.crt_static = cfg.crt_static;
1162                 target.musl_root = cfg.musl_root.map(PathBuf::from);
1163                 target.musl_libdir = cfg.musl_libdir.map(PathBuf::from);
1164                 target.wasi_root = cfg.wasi_root.map(PathBuf::from);
1165                 target.qemu_rootfs = cfg.qemu_rootfs.map(PathBuf::from);
1166                 target.sanitizers = cfg.sanitizers;
1167                 target.profiler = cfg.profiler;
1168
1169                 config.target_config.insert(TargetSelection::from_user(&triple), target);
1170             }
1171         }
1172
1173         if config.llvm_from_ci {
1174             let triple = &config.build.triple;
1175             let mut build_target = config
1176                 .target_config
1177                 .entry(config.build)
1178                 .or_insert_with(|| Target::from_triple(&triple));
1179
1180             check_ci_llvm!(build_target.llvm_config);
1181             check_ci_llvm!(build_target.llvm_filecheck);
1182             let ci_llvm_bin = config.out.join(&*config.build.triple).join("ci-llvm/bin");
1183             build_target.llvm_config = Some(ci_llvm_bin.join(exe("llvm-config", config.build)));
1184             build_target.llvm_filecheck = Some(ci_llvm_bin.join(exe("FileCheck", config.build)));
1185         }
1186
1187         if let Some(t) = toml.dist {
1188             config.dist_sign_folder = t.sign_folder.map(PathBuf::from);
1189             config.dist_upload_addr = t.upload_addr;
1190             config.dist_compression_formats = t.compression_formats;
1191             set(&mut config.rust_dist_src, t.src_tarball);
1192             set(&mut config.missing_tools, t.missing_tools);
1193         }
1194
1195         if let Some(r) = build.rustfmt {
1196             *config.initial_rustfmt.borrow_mut() = if r.exists() {
1197                 RustfmtState::SystemToolchain(r)
1198             } else {
1199                 RustfmtState::Unavailable
1200             };
1201         } else {
1202             // If using a system toolchain for bootstrapping, see if that has rustfmt available.
1203             let host = config.build;
1204             let rustfmt_path = config.initial_rustc.with_file_name(exe("rustfmt", host));
1205             let bin_root = config.out.join(host.triple).join("stage0");
1206             if !rustfmt_path.starts_with(&bin_root) {
1207                 // Using a system-provided toolchain; we shouldn't download rustfmt.
1208                 *config.initial_rustfmt.borrow_mut() = RustfmtState::SystemToolchain(rustfmt_path);
1209             }
1210         }
1211
1212         // Now that we've reached the end of our configuration, infer the
1213         // default values for all options that we haven't otherwise stored yet.
1214
1215         config.llvm_skip_rebuild = llvm_skip_rebuild.unwrap_or(false);
1216         config.llvm_assertions = llvm_assertions.unwrap_or(false);
1217         config.llvm_tests = llvm_tests.unwrap_or(false);
1218         config.llvm_plugins = llvm_plugins.unwrap_or(false);
1219         config.rust_optimize = optimize.unwrap_or(true);
1220
1221         let default = debug == Some(true);
1222         config.rust_debug_assertions = debug_assertions.unwrap_or(default);
1223         config.rust_debug_assertions_std =
1224             debug_assertions_std.unwrap_or(config.rust_debug_assertions);
1225         config.rust_overflow_checks = overflow_checks.unwrap_or(default);
1226         config.rust_overflow_checks_std =
1227             overflow_checks_std.unwrap_or(config.rust_overflow_checks);
1228
1229         config.rust_debug_logging = debug_logging.unwrap_or(config.rust_debug_assertions);
1230
1231         let with_defaults = |debuginfo_level_specific: Option<u32>| {
1232             debuginfo_level_specific.or(debuginfo_level).unwrap_or(if debug == Some(true) {
1233                 1
1234             } else {
1235                 0
1236             })
1237         };
1238         config.rust_debuginfo_level_rustc = with_defaults(debuginfo_level_rustc);
1239         config.rust_debuginfo_level_std = with_defaults(debuginfo_level_std);
1240         config.rust_debuginfo_level_tools = with_defaults(debuginfo_level_tools);
1241         config.rust_debuginfo_level_tests = debuginfo_level_tests.unwrap_or(0);
1242
1243         let default = config.channel == "dev";
1244         config.ignore_git = ignore_git.unwrap_or(default);
1245
1246         let download_rustc = config.download_rustc_commit.is_some();
1247         // See https://github.com/rust-lang/compiler-team/issues/326
1248         config.stage = match config.cmd {
1249             Subcommand::Check { .. } => flags.stage.or(build.check_stage).unwrap_or(0),
1250             // `download-rustc` only has a speed-up for stage2 builds. Default to stage2 unless explicitly overridden.
1251             Subcommand::Doc { .. } => {
1252                 flags.stage.or(build.doc_stage).unwrap_or(if download_rustc { 2 } else { 0 })
1253             }
1254             Subcommand::Build { .. } => {
1255                 flags.stage.or(build.build_stage).unwrap_or(if download_rustc { 2 } else { 1 })
1256             }
1257             Subcommand::Test { .. } => {
1258                 flags.stage.or(build.test_stage).unwrap_or(if download_rustc { 2 } else { 1 })
1259             }
1260             Subcommand::Bench { .. } => flags.stage.or(build.bench_stage).unwrap_or(2),
1261             Subcommand::Dist { .. } => flags.stage.or(build.dist_stage).unwrap_or(2),
1262             Subcommand::Install { .. } => flags.stage.or(build.install_stage).unwrap_or(2),
1263             // These are all bootstrap tools, which don't depend on the compiler.
1264             // The stage we pass shouldn't matter, but use 0 just in case.
1265             Subcommand::Clean { .. }
1266             | Subcommand::Clippy { .. }
1267             | Subcommand::Fix { .. }
1268             | Subcommand::Run { .. }
1269             | Subcommand::Setup { .. }
1270             | Subcommand::Format { .. } => flags.stage.unwrap_or(0),
1271         };
1272
1273         // CI should always run stage 2 builds, unless it specifically states otherwise
1274         #[cfg(not(test))]
1275         if flags.stage.is_none() && crate::CiEnv::current() != crate::CiEnv::None {
1276             match config.cmd {
1277                 Subcommand::Test { .. }
1278                 | Subcommand::Doc { .. }
1279                 | Subcommand::Build { .. }
1280                 | Subcommand::Bench { .. }
1281                 | Subcommand::Dist { .. }
1282                 | Subcommand::Install { .. } => {
1283                     assert_eq!(
1284                         config.stage, 2,
1285                         "x.py should be run with `--stage 2` on CI, but was run with `--stage {}`",
1286                         config.stage,
1287                     );
1288                 }
1289                 Subcommand::Clean { .. }
1290                 | Subcommand::Check { .. }
1291                 | Subcommand::Clippy { .. }
1292                 | Subcommand::Fix { .. }
1293                 | Subcommand::Run { .. }
1294                 | Subcommand::Setup { .. }
1295                 | Subcommand::Format { .. } => {}
1296             }
1297         }
1298
1299         config
1300     }
1301
1302     /// A git invocation which runs inside the source directory.
1303     ///
1304     /// Use this rather than `Command::new("git")` in order to support out-of-tree builds.
1305     pub(crate) fn git(&self) -> Command {
1306         let mut git = Command::new("git");
1307         git.current_dir(&self.src);
1308         git
1309     }
1310
1311     /// Try to find the relative path of `bindir`, otherwise return it in full.
1312     pub fn bindir_relative(&self) -> &Path {
1313         let bindir = &self.bindir;
1314         if bindir.is_absolute() {
1315             // Try to make it relative to the prefix.
1316             if let Some(prefix) = &self.prefix {
1317                 if let Ok(stripped) = bindir.strip_prefix(prefix) {
1318                     return stripped;
1319                 }
1320             }
1321         }
1322         bindir
1323     }
1324
1325     /// Try to find the relative path of `libdir`.
1326     pub fn libdir_relative(&self) -> Option<&Path> {
1327         let libdir = self.libdir.as_ref()?;
1328         if libdir.is_relative() {
1329             Some(libdir)
1330         } else {
1331             // Try to make it relative to the prefix.
1332             libdir.strip_prefix(self.prefix.as_ref()?).ok()
1333         }
1334     }
1335
1336     /// The absolute path to the downloaded LLVM artifacts.
1337     pub(crate) fn ci_llvm_root(&self) -> PathBuf {
1338         assert!(self.llvm_from_ci);
1339         self.out.join(&*self.build.triple).join("ci-llvm")
1340     }
1341
1342     /// Determine whether llvm should be linked dynamically.
1343     ///
1344     /// If `false`, llvm should be linked statically.
1345     /// This is computed on demand since LLVM might have to first be downloaded from CI.
1346     pub(crate) fn llvm_link_shared(builder: &Builder<'_>) -> bool {
1347         let mut opt = builder.config.llvm_link_shared.get();
1348         if opt.is_none() && builder.config.dry_run {
1349             // just assume static for now - dynamic linking isn't supported on all platforms
1350             return false;
1351         }
1352
1353         let llvm_link_shared = *opt.get_or_insert_with(|| {
1354             if builder.config.llvm_from_ci {
1355                 crate::native::maybe_download_ci_llvm(builder);
1356                 let ci_llvm = builder.config.ci_llvm_root();
1357                 let link_type = t!(
1358                     std::fs::read_to_string(ci_llvm.join("link-type.txt")),
1359                     format!("CI llvm missing: {}", ci_llvm.display())
1360                 );
1361                 link_type == "dynamic"
1362             } else {
1363                 // unclear how thought-through this default is, but it maintains compatibility with
1364                 // previous behavior
1365                 false
1366             }
1367         });
1368         builder.config.llvm_link_shared.set(opt);
1369         llvm_link_shared
1370     }
1371
1372     /// Return whether we will use a downloaded, pre-compiled version of rustc, or just build from source.
1373     pub(crate) fn download_rustc(builder: &Builder<'_>) -> bool {
1374         static DOWNLOAD_RUSTC: OnceCell<bool> = OnceCell::new();
1375         if builder.config.dry_run && DOWNLOAD_RUSTC.get().is_none() {
1376             // avoid trying to actually download the commit
1377             return false;
1378         }
1379
1380         *DOWNLOAD_RUSTC.get_or_init(|| match &builder.config.download_rustc_commit {
1381             None => false,
1382             Some(commit) => {
1383                 download_ci_rustc(builder, commit);
1384                 true
1385             }
1386         })
1387     }
1388
1389     pub(crate) fn initial_rustfmt(builder: &Builder<'_>) -> Option<PathBuf> {
1390         match &mut *builder.config.initial_rustfmt.borrow_mut() {
1391             RustfmtState::SystemToolchain(p) | RustfmtState::Downloaded(p) => Some(p.clone()),
1392             RustfmtState::Unavailable => None,
1393             r @ RustfmtState::LazyEvaluated => {
1394                 if builder.config.dry_run {
1395                     return Some(PathBuf::new());
1396                 }
1397                 let path = maybe_download_rustfmt(builder);
1398                 *r = if let Some(p) = &path {
1399                     RustfmtState::Downloaded(p.clone())
1400                 } else {
1401                     RustfmtState::Unavailable
1402                 };
1403                 path
1404             }
1405         }
1406     }
1407
1408     pub fn verbose(&self) -> bool {
1409         self.verbose > 0
1410     }
1411
1412     pub fn sanitizers_enabled(&self, target: TargetSelection) -> bool {
1413         self.target_config.get(&target).map(|t| t.sanitizers).flatten().unwrap_or(self.sanitizers)
1414     }
1415
1416     pub fn any_sanitizers_enabled(&self) -> bool {
1417         self.target_config.values().any(|t| t.sanitizers == Some(true)) || self.sanitizers
1418     }
1419
1420     pub fn profiler_enabled(&self, target: TargetSelection) -> bool {
1421         self.target_config.get(&target).map(|t| t.profiler).flatten().unwrap_or(self.profiler)
1422     }
1423
1424     pub fn any_profiler_enabled(&self) -> bool {
1425         self.target_config.values().any(|t| t.profiler == Some(true)) || self.profiler
1426     }
1427
1428     pub fn llvm_enabled(&self) -> bool {
1429         self.rust_codegen_backends.contains(&INTERNER.intern_str("llvm"))
1430     }
1431
1432     pub fn llvm_libunwind(&self, target: TargetSelection) -> LlvmLibunwind {
1433         self.target_config
1434             .get(&target)
1435             .and_then(|t| t.llvm_libunwind)
1436             .or(self.llvm_libunwind_default)
1437             .unwrap_or(LlvmLibunwind::No)
1438     }
1439
1440     pub fn submodules(&self, rust_info: &GitInfo) -> bool {
1441         self.submodules.unwrap_or(rust_info.is_git())
1442     }
1443 }
1444
1445 fn set<T>(field: &mut T, val: Option<T>) {
1446     if let Some(v) = val {
1447         *field = v;
1448     }
1449 }
1450
1451 fn threads_from_config(v: u32) -> u32 {
1452     match v {
1453         0 => num_cpus::get() as u32,
1454         n => n,
1455     }
1456 }
1457
1458 /// Returns the commit to download, or `None` if we shouldn't download CI artifacts.
1459 fn download_ci_rustc_commit(
1460     config: &Config,
1461     download_rustc: Option<StringOrBool>,
1462 ) -> Option<String> {
1463     // If `download-rustc` is not set, default to rebuilding.
1464     let if_unchanged = match download_rustc {
1465         None | Some(StringOrBool::Bool(false)) => return None,
1466         Some(StringOrBool::Bool(true)) => false,
1467         Some(StringOrBool::String(s)) if s == "if-unchanged" => true,
1468         Some(StringOrBool::String(other)) => {
1469             panic!("unrecognized option for download-rustc: {}", other)
1470         }
1471     };
1472
1473     // Handle running from a directory other than the top level
1474     let top_level = output(config.git().args(&["rev-parse", "--show-toplevel"]));
1475     let top_level = top_level.trim_end();
1476     let compiler = format!("{top_level}/compiler/");
1477     let library = format!("{top_level}/library/");
1478
1479     // Look for a version to compare to based on the current commit.
1480     // Only commits merged by bors will have CI artifacts.
1481     let merge_base = output(
1482         config
1483             .git()
1484             .arg("rev-list")
1485             .arg(format!("--author={}", config.stage0_metadata.config.git_merge_commit_email))
1486             .args(&["-n1", "--first-parent", "HEAD"]),
1487     );
1488     let commit = merge_base.trim_end();
1489     if commit.is_empty() {
1490         println!("error: could not find commit hash for downloading rustc");
1491         println!("help: maybe your repository history is too shallow?");
1492         println!("help: consider disabling `download-rustc`");
1493         println!("help: or fetch enough history to include one upstream commit");
1494         crate::detail_exit(1);
1495     }
1496
1497     // Warn if there were changes to the compiler or standard library since the ancestor commit.
1498     let has_changes = !t!(config
1499         .git()
1500         .args(&["diff-index", "--quiet", &commit, "--", &compiler, &library])
1501         .status())
1502     .success();
1503     if has_changes {
1504         if if_unchanged {
1505             if config.verbose > 0 {
1506                 println!(
1507                     "warning: saw changes to compiler/ or library/ since {commit}; \
1508                           ignoring `download-rustc`"
1509                 );
1510             }
1511             return None;
1512         }
1513         println!(
1514             "warning: `download-rustc` is enabled, but there are changes to \
1515                   compiler/ or library/"
1516         );
1517     }
1518
1519     Some(commit.to_string())
1520 }
1521
1522 fn maybe_download_rustfmt(builder: &Builder<'_>) -> Option<PathBuf> {
1523     let RustfmtMetadata { date, version } = builder.config.stage0_metadata.rustfmt.as_ref()?;
1524     let channel = format!("{version}-{date}");
1525
1526     let host = builder.config.build;
1527     let rustfmt_path = builder.config.initial_rustc.with_file_name(exe("rustfmt", host));
1528     let bin_root = builder.config.out.join(host.triple).join("stage0");
1529     let rustfmt_stamp = bin_root.join(".rustfmt-stamp");
1530     if rustfmt_path.exists() && !program_out_of_date(&rustfmt_stamp, &channel) {
1531         return Some(rustfmt_path);
1532     }
1533
1534     let filename = format!("rustfmt-{version}-{build}.tar.xz", build = host.triple);
1535     download_component(builder, DownloadSource::Dist, filename, "rustfmt-preview", &date, "stage0");
1536
1537     builder.fix_bin_or_dylib(&bin_root.join("bin").join("rustfmt"));
1538     builder.fix_bin_or_dylib(&bin_root.join("bin").join("cargo-fmt"));
1539
1540     builder.create(&rustfmt_stamp, &channel);
1541     Some(rustfmt_path)
1542 }
1543
1544 fn download_ci_rustc(builder: &Builder<'_>, commit: &str) {
1545     builder.verbose(&format!("using downloaded stage2 artifacts from CI (commit {commit})"));
1546     // FIXME: support downloading artifacts from the beta channel
1547     const CHANNEL: &str = "nightly";
1548     let host = builder.config.build.triple;
1549     let bin_root = builder.out.join(host).join("ci-rustc");
1550     let rustc_stamp = bin_root.join(".rustc-stamp");
1551
1552     if !bin_root.join("bin").join("rustc").exists() || program_out_of_date(&rustc_stamp, commit) {
1553         if bin_root.exists() {
1554             t!(fs::remove_dir_all(&bin_root));
1555         }
1556         let filename = format!("rust-std-{CHANNEL}-{host}.tar.xz");
1557         let pattern = format!("rust-std-{host}");
1558         download_ci_component(builder, filename, &pattern, commit);
1559         let filename = format!("rustc-{CHANNEL}-{host}.tar.xz");
1560         download_ci_component(builder, filename, "rustc", commit);
1561         // download-rustc doesn't need its own cargo, it can just use beta's.
1562         let filename = format!("rustc-dev-{CHANNEL}-{host}.tar.xz");
1563         download_ci_component(builder, filename, "rustc-dev", commit);
1564
1565         builder.fix_bin_or_dylib(&bin_root.join("bin").join("rustc"));
1566         builder.fix_bin_or_dylib(&bin_root.join("bin").join("rustdoc"));
1567         let lib_dir = bin_root.join("lib");
1568         for lib in t!(fs::read_dir(&lib_dir), lib_dir.display().to_string()) {
1569             let lib = t!(lib);
1570             if lib.path().extension() == Some(OsStr::new("so")) {
1571                 builder.fix_bin_or_dylib(&lib.path());
1572             }
1573         }
1574         t!(fs::write(rustc_stamp, commit));
1575     }
1576 }
1577
1578 pub(crate) enum DownloadSource {
1579     CI,
1580     Dist,
1581 }
1582
1583 /// Download a single component of a CI-built toolchain (not necessarily a published nightly).
1584 // NOTE: intentionally takes an owned string to avoid downloading multiple times by accident
1585 fn download_ci_component(builder: &Builder<'_>, filename: String, prefix: &str, commit: &str) {
1586     download_component(builder, DownloadSource::CI, filename, prefix, commit, "ci-rustc")
1587 }
1588
1589 fn download_component(
1590     builder: &Builder<'_>,
1591     mode: DownloadSource,
1592     filename: String,
1593     prefix: &str,
1594     key: &str,
1595     destination: &str,
1596 ) {
1597     let cache_dst = builder.out.join("cache");
1598     let cache_dir = cache_dst.join(key);
1599     if !cache_dir.exists() {
1600         t!(fs::create_dir_all(&cache_dir));
1601     }
1602
1603     let bin_root = builder.out.join(builder.config.build.triple).join(destination);
1604     let tarball = cache_dir.join(&filename);
1605     let (base_url, url, should_verify) = match mode {
1606         DownloadSource::CI => (
1607             builder.config.stage0_metadata.config.artifacts_server.clone(),
1608             format!("{key}/{filename}"),
1609             false,
1610         ),
1611         DownloadSource::Dist => {
1612             let dist_server = env::var("RUSTUP_DIST_SERVER")
1613                 .unwrap_or(builder.config.stage0_metadata.config.dist_server.to_string());
1614             // NOTE: make `dist` part of the URL because that's how it's stored in src/stage0.json
1615             (dist_server, format!("dist/{key}/{filename}"), true)
1616         }
1617     };
1618
1619     // For the beta compiler, put special effort into ensuring the checksums are valid.
1620     // FIXME: maybe we should do this for download-rustc as well? but it would be a pain to update
1621     // this on each and every nightly ...
1622     let checksum = if should_verify {
1623         let error = format!(
1624             "src/stage0.json doesn't contain a checksum for {url}. \
1625             Pre-built artifacts might not be available for this \
1626             target at this time, see https://doc.rust-lang.org/nightly\
1627             /rustc/platform-support.html for more information."
1628         );
1629         let sha256 = builder.config.stage0_metadata.checksums_sha256.get(&url).expect(&error);
1630         if tarball.exists() {
1631             if builder.verify(&tarball, sha256) {
1632                 builder.unpack(&tarball, &bin_root, prefix);
1633                 return;
1634             } else {
1635                 builder.verbose(&format!(
1636                     "ignoring cached file {} due to failed verification",
1637                     tarball.display()
1638                 ));
1639                 builder.remove(&tarball);
1640             }
1641         }
1642         Some(sha256)
1643     } else if tarball.exists() {
1644         builder.unpack(&tarball, &bin_root, prefix);
1645         return;
1646     } else {
1647         None
1648     };
1649
1650     builder.download_component(&format!("{base_url}/{url}"), &tarball, "");
1651     if let Some(sha256) = checksum {
1652         if !builder.verify(&tarball, sha256) {
1653             panic!("failed to verify {}", tarball.display());
1654         }
1655     }
1656
1657     builder.unpack(&tarball, &bin_root, prefix);
1658 }