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