src/bootstrap/config.rs

   1 //! Serialized configuration of a build.
   2 //!
   3 //! This module implements parsing `config.toml` configuration files to tweak
   4 //! how the build runs.
   5
   6 use std::cmp;
   7 use std::collections::{HashMap, HashSet};
   8 use std::env;
   9 use std::ffi::OsString;
  10 use std::fmt;
  11 use std::fs;
  12 use std::path::{Path, PathBuf};
  13 use std::str::FromStr;
  14
  15 use crate::cache::{Interned, INTERNER};
  16 pub use crate::flags::Subcommand;
  17 use crate::flags::{Color, Flags};
  18 use crate::util::exe;
  19 use build_helper::t;
  20 use merge::Merge;
  21 use serde::Deserialize;
  22
  23 macro_rules! check_ci_llvm {
  24     ($name:expr) => {
  25         assert!(
  26             $name.is_none(),
  27             "setting {} is incompatible with download-ci-llvm.",
  28             stringify!($name)
  29         );
  30     };
  31 }
  32
  33 /// Global configuration for the entire build and/or bootstrap.
  34 ///
  35 /// This structure is derived from a combination of both `config.toml` and
  36 /// `config.mk`. As of the time of this writing it's unlikely that `config.toml`
  37 /// is used all that much, so this is primarily filled out by `config.mk` which
  38 /// is generated from `./configure`.
  39 ///
  40 /// Note that this structure is not decoded directly into, but rather it is
  41 /// filled out from the decoded forms of the structs below. For documentation
  42 /// each field, see the corresponding fields in
  43 /// `config.toml.example`.
  44 #[derive(Default)]
  45 pub struct Config {
  46     pub changelog_seen: Option<usize>,
  47     pub ccache: Option<String>,
  48     /// Call Build::ninja() instead of this.
  49     pub ninja_in_file: bool,
  50     pub verbose: usize,
  51     pub submodules: bool,
  52     pub fast_submodules: bool,
  53     pub compiler_docs: bool,
  54     pub docs: bool,
  55     pub locked_deps: bool,
  56     pub vendor: bool,
  57     pub target_config: HashMap<TargetSelection, Target>,
  58     pub full_bootstrap: bool,
  59     pub extended: bool,
  60     pub tools: Option<HashSet<String>>,
  61     pub sanitizers: bool,
  62     pub profiler: bool,
  63     pub ignore_git: bool,
  64     pub exclude: Vec<PathBuf>,
  65     pub include_default_paths: bool,
  66     pub rustc_error_format: Option<String>,
  67     pub json_output: bool,
  68     pub test_compare_mode: bool,
  69     pub llvm_libunwind: Option<LlvmLibunwind>,
  70     pub color: Color,
  71
  72     pub on_fail: Option<String>,
  73     pub stage: u32,
  74     pub keep_stage: Vec<u32>,
  75     pub keep_stage_std: Vec<u32>,
  76     pub src: PathBuf,
  77     // defaults to `config.toml`
  78     pub config: PathBuf,
  79     pub jobs: Option<u32>,
  80     pub cmd: Subcommand,
  81     pub incremental: bool,
  82     pub dry_run: bool,
  83
  84     pub deny_warnings: bool,
  85     pub backtrace_on_ice: bool,
  86
  87     // llvm codegen options
  88     pub llvm_skip_rebuild: bool,
  89     pub llvm_assertions: bool,
  90     pub llvm_optimize: bool,
  91     pub llvm_thin_lto: bool,
  92     pub llvm_release_debuginfo: bool,
  93     pub llvm_version_check: bool,
  94     pub llvm_static_stdcpp: bool,
  95     pub llvm_link_shared: bool,
  96     pub llvm_clang_cl: Option<String>,
  97     pub llvm_targets: Option<String>,
  98     pub llvm_experimental_targets: Option<String>,
  99     pub llvm_link_jobs: Option<u32>,
 100     pub llvm_version_suffix: Option<String>,
 101     pub llvm_use_linker: Option<String>,
 102     pub llvm_allow_old_toolchain: Option<bool>,
 103     pub llvm_polly: Option<bool>,
 104     pub llvm_from_ci: bool,
 105
 106     pub use_lld: bool,
 107     pub lld_enabled: bool,
 108     pub llvm_tools_enabled: bool,
 109
 110     pub llvm_cflags: Option<String>,
 111     pub llvm_cxxflags: Option<String>,
 112     pub llvm_ldflags: Option<String>,
 113     pub llvm_use_libcxx: bool,
 114
 115     // rust codegen options
 116     pub rust_optimize: bool,
 117     pub rust_codegen_units: Option<u32>,
 118     pub rust_codegen_units_std: Option<u32>,
 119     pub rust_debug_assertions: bool,
 120     pub rust_debug_assertions_std: bool,
 121     pub rust_debug_logging: bool,
 122     pub rust_debuginfo_level_rustc: u32,
 123     pub rust_debuginfo_level_std: u32,
 124     pub rust_debuginfo_level_tools: u32,
 125     pub rust_debuginfo_level_tests: u32,
 126     pub rust_run_dsymutil: bool,
 127     pub rust_rpath: bool,
 128     pub rustc_parallel: bool,
 129     pub rustc_default_linker: Option<String>,
 130     pub rust_optimize_tests: bool,
 131     pub rust_dist_src: bool,
 132     pub rust_codegen_backends: Vec<Interned<String>>,
 133     pub rust_verify_llvm_ir: bool,
 134     pub rust_thin_lto_import_instr_limit: Option<u32>,
 135     pub rust_remap_debuginfo: bool,
 136     pub rust_new_symbol_mangling: bool,
 137     pub rust_profile_use: Option<String>,
 138     pub rust_profile_generate: Option<String>,
 139
 140     pub build: TargetSelection,
 141     pub hosts: Vec<TargetSelection>,
 142     pub targets: Vec<TargetSelection>,
 143     pub local_rebuild: bool,
 144     pub jemalloc: bool,
 145     pub control_flow_guard: bool,
 146
 147     // dist misc
 148     pub dist_sign_folder: Option<PathBuf>,
 149     pub dist_upload_addr: Option<String>,
 150     pub dist_gpg_password_file: Option<PathBuf>,
 151     pub dist_compression_formats: Option<Vec<String>>,
 152
 153     // libstd features
 154     pub backtrace: bool, // support for RUST_BACKTRACE
 155
 156     // misc
 157     pub low_priority: bool,
 158     pub channel: String,
 159     pub description: Option<String>,
 160     pub verbose_tests: bool,
 161     pub save_toolstates: Option<PathBuf>,
 162     pub print_step_timings: bool,
 163     pub missing_tools: bool,
 164
 165     // Fallback musl-root for all targets
 166     pub musl_root: Option<PathBuf>,
 167     pub prefix: Option<PathBuf>,
 168     pub sysconfdir: Option<PathBuf>,
 169     pub datadir: Option<PathBuf>,
 170     pub docdir: Option<PathBuf>,
 171     pub bindir: PathBuf,
 172     pub libdir: Option<PathBuf>,
 173     pub mandir: Option<PathBuf>,
 174     pub codegen_tests: bool,
 175     pub nodejs: Option<PathBuf>,
 176     pub gdb: Option<PathBuf>,
 177     pub python: Option<PathBuf>,
 178     pub cargo_native_static: bool,
 179     pub configure_args: Vec<String>,
 180
 181     // These are either the stage0 downloaded binaries or the locally installed ones.
 182     pub initial_cargo: PathBuf,
 183     pub initial_rustc: PathBuf,
 184     pub initial_rustfmt: Option<PathBuf>,
 185     pub out: PathBuf,
 186 }
 187
 188 #[derive(Debug, Clone, Copy, PartialEq)]
 189 pub enum LlvmLibunwind {
 190     No,
 191     InTree,
 192     System,
 193 }
 194
 195 impl Default for LlvmLibunwind {
 196     fn default() -> Self {
 197         Self::No
 198     }
 199 }
 200
 201 impl FromStr for LlvmLibunwind {
 202     type Err = String;
 203
 204     fn from_str(value: &str) -> Result<Self, Self::Err> {
 205         match value {
 206             "no" => Ok(Self::No),
 207             "in-tree" => Ok(Self::InTree),
 208             "system" => Ok(Self::System),
 209             invalid => Err(format!("Invalid value '{}' for rust.llvm-libunwind config.", invalid)),
 210         }
 211     }
 212 }
 213
 214 #[derive(Debug, Copy, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
 215 pub struct TargetSelection {
 216     pub triple: Interned<String>,
 217     file: Option<Interned<String>>,
 218 }
 219
 220 impl TargetSelection {
 221     pub fn from_user(selection: &str) -> Self {
 222         let path = Path::new(selection);
 223
 224         let (triple, file) = if path.exists() {
 225             let triple = path
 226                 .file_stem()
 227                 .expect("Target specification file has no file stem")
 228                 .to_str()
 229                 .expect("Target specification file stem is not UTF-8");
 230
 231             (triple, Some(selection))
 232         } else {
 233             (selection, None)
 234         };
 235
 236         let triple = INTERNER.intern_str(triple);
 237         let file = file.map(|f| INTERNER.intern_str(f));
 238
 239         Self { triple, file }
 240     }
 241
 242     pub fn rustc_target_arg(&self) -> &str {
 243         self.file.as_ref().unwrap_or(&self.triple)
 244     }
 245
 246     pub fn contains(&self, needle: &str) -> bool {
 247         self.triple.contains(needle)
 248     }
 249
 250     pub fn starts_with(&self, needle: &str) -> bool {
 251         self.triple.starts_with(needle)
 252     }
 253
 254     pub fn ends_with(&self, needle: &str) -> bool {
 255         self.triple.ends_with(needle)
 256     }
 257 }
 258
 259 impl fmt::Display for TargetSelection {
 260     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 261         write!(f, "{}", self.triple)?;
 262         if let Some(file) = self.file {
 263             write!(f, "({})", file)?;
 264         }
 265         Ok(())
 266     }
 267 }
 268
 269 impl PartialEq<&str> for TargetSelection {
 270     fn eq(&self, other: &&str) -> bool {
 271         self.triple == *other
 272     }
 273 }
 274
 275 /// Per-target configuration stored in the global configuration structure.
 276 #[derive(Default)]
 277 pub struct Target {
 278     /// Some(path to llvm-config) if using an external LLVM.
 279     pub llvm_config: Option<PathBuf>,
 280     /// Some(path to FileCheck) if one was specified.
 281     pub llvm_filecheck: Option<PathBuf>,
 282     pub cc: Option<PathBuf>,
 283     pub cxx: Option<PathBuf>,
 284     pub ar: Option<PathBuf>,
 285     pub ranlib: Option<PathBuf>,
 286     pub linker: Option<PathBuf>,
 287     pub ndk: Option<PathBuf>,
 288     pub sanitizers: Option<bool>,
 289     pub profiler: Option<bool>,
 290     pub crt_static: Option<bool>,
 291     pub musl_root: Option<PathBuf>,
 292     pub musl_libdir: Option<PathBuf>,
 293     pub wasi_root: Option<PathBuf>,
 294     pub qemu_rootfs: Option<PathBuf>,
 295     pub no_std: bool,
 296 }
 297
 298 impl Target {
 299     pub fn from_triple(triple: &str) -> Self {
 300         let mut target: Self = Default::default();
 301         if triple.contains("-none") || triple.contains("nvptx") {
 302             target.no_std = true;
 303         }
 304         target
 305     }
 306 }
 307 /// Structure of the `config.toml` file that configuration is read from.
 308 ///
 309 /// This structure uses `Decodable` to automatically decode a TOML configuration
 310 /// file into this format, and then this is traversed and written into the above
 311 /// `Config` structure.
 312 #[derive(Deserialize, Default)]
 313 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
 314 struct TomlConfig {
 315     changelog_seen: Option<usize>,
 316     build: Option<Build>,
 317     install: Option<Install>,
 318     llvm: Option<Llvm>,
 319     rust: Option<Rust>,
 320     target: Option<HashMap<String, TomlTarget>>,
 321     dist: Option<Dist>,
 322     profile: Option<String>,
 323 }
 324
 325 impl Merge for TomlConfig {
 326     fn merge(
 327         &mut self,
 328         TomlConfig { build, install, llvm, rust, dist, target, profile: _, changelog_seen: _ }: Self,
 329     ) {
 330         fn do_merge<T: Merge>(x: &mut Option<T>, y: Option<T>) {
 331             if let Some(new) = y {
 332                 if let Some(original) = x {
 333                     original.merge(new);
 334                 } else {
 335                     *x = Some(new);
 336                 }
 337             }
 338         }
 339         do_merge(&mut self.build, build);
 340         do_merge(&mut self.install, install);
 341         do_merge(&mut self.llvm, llvm);
 342         do_merge(&mut self.rust, rust);
 343         do_merge(&mut self.dist, dist);
 344         assert!(target.is_none(), "merging target-specific config is not currently supported");
 345     }
 346 }
 347
 348 /// TOML representation of various global build decisions.
 349 #[derive(Deserialize, Default, Clone, Merge)]
 350 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
 351 struct Build {
 352     build: Option<String>,
 353     host: Option<Vec<String>>,
 354     target: Option<Vec<String>>,
 355     // This is ignored, the rust code always gets the build directory from the `BUILD_DIR` env variable
 356     build_dir: Option<String>,
 357     cargo: Option<String>,
 358     rustc: Option<String>,
 359     rustfmt: Option<PathBuf>,
 360     docs: Option<bool>,
 361     compiler_docs: Option<bool>,
 362     submodules: Option<bool>,
 363     fast_submodules: Option<bool>,
 364     gdb: Option<String>,
 365     nodejs: Option<String>,
 366     python: Option<String>,
 367     locked_deps: Option<bool>,
 368     vendor: Option<bool>,
 369     full_bootstrap: Option<bool>,
 370     extended: Option<bool>,
 371     tools: Option<HashSet<String>>,
 372     verbose: Option<usize>,
 373     sanitizers: Option<bool>,
 374     profiler: Option<bool>,
 375     cargo_native_static: Option<bool>,
 376     low_priority: Option<bool>,
 377     configure_args: Option<Vec<String>>,
 378     local_rebuild: Option<bool>,
 379     print_step_timings: Option<bool>,
 380     doc_stage: Option<u32>,
 381     build_stage: Option<u32>,
 382     test_stage: Option<u32>,
 383     install_stage: Option<u32>,
 384     dist_stage: Option<u32>,
 385     bench_stage: Option<u32>,
 386 }
 387
 388 /// TOML representation of various global install decisions.
 389 #[derive(Deserialize, Default, Clone, Merge)]
 390 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
 391 struct Install {
 392     prefix: Option<String>,
 393     sysconfdir: Option<String>,
 394     docdir: Option<String>,
 395     bindir: Option<String>,
 396     libdir: Option<String>,
 397     mandir: Option<String>,
 398     datadir: Option<String>,
 399
 400     // standard paths, currently unused
 401     infodir: Option<String>,
 402     localstatedir: Option<String>,
 403 }
 404
 405 /// TOML representation of how the LLVM build is configured.
 406 #[derive(Deserialize, Default, Merge)]
 407 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
 408 struct Llvm {
 409     skip_rebuild: Option<bool>,
 410     optimize: Option<bool>,
 411     thin_lto: Option<bool>,
 412     release_debuginfo: Option<bool>,
 413     assertions: Option<bool>,
 414     ccache: Option<StringOrBool>,
 415     version_check: Option<bool>,
 416     static_libstdcpp: Option<bool>,
 417     ninja: Option<bool>,
 418     targets: Option<String>,
 419     experimental_targets: Option<String>,
 420     link_jobs: Option<u32>,
 421     link_shared: Option<bool>,
 422     version_suffix: Option<String>,
 423     clang_cl: Option<String>,
 424     cflags: Option<String>,
 425     cxxflags: Option<String>,
 426     ldflags: Option<String>,
 427     use_libcxx: Option<bool>,
 428     use_linker: Option<String>,
 429     allow_old_toolchain: Option<bool>,
 430     polly: Option<bool>,
 431     download_ci_llvm: Option<StringOrBool>,
 432 }
 433
 434 #[derive(Deserialize, Default, Clone, Merge)]
 435 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
 436 struct Dist {
 437     sign_folder: Option<String>,
 438     gpg_password_file: Option<String>,
 439     upload_addr: Option<String>,
 440     src_tarball: Option<bool>,
 441     missing_tools: Option<bool>,
 442     compression_formats: Option<Vec<String>>,
 443 }
 444
 445 #[derive(Deserialize)]
 446 #[serde(untagged)]
 447 enum StringOrBool {
 448     String(String),
 449     Bool(bool),
 450 }
 451
 452 impl Default for StringOrBool {
 453     fn default() -> StringOrBool {
 454         StringOrBool::Bool(false)
 455     }
 456 }
 457
 458 /// TOML representation of how the Rust build is configured.
 459 #[derive(Deserialize, Default, Merge)]
 460 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
 461 struct Rust {
 462     optimize: Option<bool>,
 463     debug: Option<bool>,
 464     codegen_units: Option<u32>,
 465     codegen_units_std: Option<u32>,
 466     debug_assertions: Option<bool>,
 467     debug_assertions_std: Option<bool>,
 468     debug_logging: Option<bool>,
 469     debuginfo_level: Option<u32>,
 470     debuginfo_level_rustc: Option<u32>,
 471     debuginfo_level_std: Option<u32>,
 472     debuginfo_level_tools: Option<u32>,
 473     debuginfo_level_tests: Option<u32>,
 474     run_dsymutil: Option<bool>,
 475     backtrace: Option<bool>,
 476     incremental: Option<bool>,
 477     parallel_compiler: Option<bool>,
 478     default_linker: Option<String>,
 479     channel: Option<String>,
 480     description: Option<String>,
 481     musl_root: Option<String>,
 482     rpath: Option<bool>,
 483     verbose_tests: Option<bool>,
 484     optimize_tests: Option<bool>,
 485     codegen_tests: Option<bool>,
 486     ignore_git: Option<bool>,
 487     dist_src: Option<bool>,
 488     save_toolstates: Option<String>,
 489     codegen_backends: Option<Vec<String>>,
 490     lld: Option<bool>,
 491     use_lld: Option<bool>,
 492     llvm_tools: Option<bool>,
 493     deny_warnings: Option<bool>,
 494     backtrace_on_ice: Option<bool>,
 495     verify_llvm_ir: Option<bool>,
 496     thin_lto_import_instr_limit: Option<u32>,
 497     remap_debuginfo: Option<bool>,
 498     jemalloc: Option<bool>,
 499     test_compare_mode: Option<bool>,
 500     llvm_libunwind: Option<String>,
 501     control_flow_guard: Option<bool>,
 502     new_symbol_mangling: Option<bool>,
 503     profile_generate: Option<String>,
 504     profile_use: Option<String>,
 505 }
 506
 507 /// TOML representation of how each build target is configured.
 508 #[derive(Deserialize, Default, Merge)]
 509 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
 510 struct TomlTarget {
 511     cc: Option<String>,
 512     cxx: Option<String>,
 513     ar: Option<String>,
 514     ranlib: Option<String>,
 515     linker: Option<String>,
 516     llvm_config: Option<String>,
 517     llvm_filecheck: Option<String>,
 518     android_ndk: Option<String>,
 519     sanitizers: Option<bool>,
 520     profiler: Option<bool>,
 521     crt_static: Option<bool>,
 522     musl_root: Option<String>,
 523     musl_libdir: Option<String>,
 524     wasi_root: Option<String>,
 525     qemu_rootfs: Option<String>,
 526     no_std: Option<bool>,
 527 }
 528
 529 impl Config {
 530     fn path_from_python(var_key: &str) -> PathBuf {
 531         match env::var_os(var_key) {
 532             Some(var_val) => Self::normalize_python_path(var_val),
 533             _ => panic!("expected '{}' to be set", var_key),
 534         }
 535     }
 536
 537     /// Normalizes paths from Python slightly. We don't trust paths from Python (#49785).
 538     fn normalize_python_path(path: OsString) -> PathBuf {
 539         Path::new(&path).components().collect()
 540     }
 541
 542     pub fn default_opts() -> Config {
 543         let mut config = Config::default();
 544         config.llvm_optimize = true;
 545         config.ninja_in_file = true;
 546         config.llvm_version_check = true;
 547         config.backtrace = true;
 548         config.rust_optimize = true;
 549         config.rust_optimize_tests = true;
 550         config.submodules = true;
 551         config.fast_submodules = true;
 552         config.docs = true;
 553         config.rust_rpath = true;
 554         config.channel = "dev".to_string();
 555         config.codegen_tests = true;
 556         config.ignore_git = false;
 557         config.rust_dist_src = true;
 558         config.rust_codegen_backends = vec![INTERNER.intern_str("llvm")];
 559         config.deny_warnings = true;
 560         config.missing_tools = false;
 561
 562         // set by build.rs
 563         config.build = TargetSelection::from_user(&env!("BUILD_TRIPLE"));
 564         let manifest_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
 565         // Undo `src/bootstrap`
 566         config.src = manifest_dir.parent().unwrap().parent().unwrap().to_owned();
 567         config.out = Config::path_from_python("BUILD_DIR");
 568
 569         config.initial_cargo = PathBuf::from(env!("CARGO"));
 570         config.initial_rustc = PathBuf::from(env!("RUSTC"));
 571
 572         config
 573     }
 574
 575     pub fn parse(args: &[String]) -> Config {
 576         let flags = Flags::parse(&args);
 577
 578         let mut config = Config::default_opts();
 579         config.exclude = flags.exclude;
 580         config.include_default_paths = flags.include_default_paths;
 581         config.rustc_error_format = flags.rustc_error_format;
 582         config.json_output = flags.json_output;
 583         config.on_fail = flags.on_fail;
 584         config.jobs = flags.jobs.map(threads_from_config);
 585         config.cmd = flags.cmd;
 586         config.incremental = flags.incremental;
 587         config.dry_run = flags.dry_run;
 588         config.keep_stage = flags.keep_stage;
 589         config.keep_stage_std = flags.keep_stage_std;
 590         config.bindir = "bin".into(); // default
 591         config.color = flags.color;
 592         if let Some(value) = flags.deny_warnings {
 593             config.deny_warnings = value;
 594         }
 595
 596         if config.dry_run {
 597             let dir = config.out.join("tmp-dry-run");
 598             t!(fs::create_dir_all(&dir));
 599             config.out = dir;
 600         }
 601
 602         #[cfg(test)]
 603         let get_toml = |_| TomlConfig::default();
 604         #[cfg(not(test))]
 605         let get_toml = |file: &Path| {
 606             use std::process;
 607
 608             let contents = t!(fs::read_to_string(file), "`include` config not found");
 609             match toml::from_str(&contents) {
 610                 Ok(table) => table,
 611                 Err(err) => {
 612                     println!("failed to parse TOML configuration '{}': {}", file.display(), err);
 613                     process::exit(2);
 614                 }
 615             }
 616         };
 617
 618         let mut toml = flags.config.as_deref().map(get_toml).unwrap_or_else(TomlConfig::default);
 619         if let Some(include) = &toml.profile {
 620             let mut include_path = config.src.clone();
 621             include_path.push("src");
 622             include_path.push("bootstrap");
 623             include_path.push("defaults");
 624             include_path.push(format!("config.{}.toml", include));
 625             let included_toml = get_toml(&include_path);
 626             toml.merge(included_toml);
 627         }
 628
 629         config.changelog_seen = toml.changelog_seen;
 630         if let Some(cfg) = flags.config {
 631             config.config = cfg;
 632         }
 633
 634         let build = toml.build.unwrap_or_default();
 635
 636         config.hosts = if let Some(arg_host) = flags.host {
 637             arg_host
 638         } else if let Some(file_host) = build.host {
 639             file_host.iter().map(|h| TargetSelection::from_user(h)).collect()
 640         } else {
 641             vec![config.build]
 642         };
 643         config.targets = if let Some(arg_target) = flags.target {
 644             arg_target
 645         } else if let Some(file_target) = build.target {
 646             file_target.iter().map(|h| TargetSelection::from_user(h)).collect()
 647         } else {
 648             // If target is *not* configured, then default to the host
 649             // toolchains.
 650             config.hosts.clone()
 651         };
 652
 653         config.nodejs = build.nodejs.map(PathBuf::from);
 654         config.gdb = build.gdb.map(PathBuf::from);
 655         config.python = build.python.map(PathBuf::from);
 656         set(&mut config.low_priority, build.low_priority);
 657         set(&mut config.compiler_docs, build.compiler_docs);
 658         set(&mut config.docs, build.docs);
 659         set(&mut config.submodules, build.submodules);
 660         set(&mut config.fast_submodules, build.fast_submodules);
 661         set(&mut config.locked_deps, build.locked_deps);
 662         set(&mut config.vendor, build.vendor);
 663         set(&mut config.full_bootstrap, build.full_bootstrap);
 664         set(&mut config.extended, build.extended);
 665         config.tools = build.tools;
 666         if build.rustfmt.is_some() {
 667             config.initial_rustfmt = build.rustfmt;
 668         }
 669         set(&mut config.verbose, build.verbose);
 670         set(&mut config.sanitizers, build.sanitizers);
 671         set(&mut config.profiler, build.profiler);
 672         set(&mut config.cargo_native_static, build.cargo_native_static);
 673         set(&mut config.configure_args, build.configure_args);
 674         set(&mut config.local_rebuild, build.local_rebuild);
 675         set(&mut config.print_step_timings, build.print_step_timings);
 676
 677         // See https://github.com/rust-lang/compiler-team/issues/326
 678         config.stage = match config.cmd {
 679             Subcommand::Doc { .. } => flags.stage.or(build.doc_stage).unwrap_or(0),
 680             Subcommand::Build { .. } => flags.stage.or(build.build_stage).unwrap_or(1),
 681             Subcommand::Test { .. } => flags.stage.or(build.test_stage).unwrap_or(1),
 682             Subcommand::Bench { .. } => flags.stage.or(build.bench_stage).unwrap_or(2),
 683             Subcommand::Dist { .. } => flags.stage.or(build.dist_stage).unwrap_or(2),
 684             Subcommand::Install { .. } => flags.stage.or(build.install_stage).unwrap_or(2),
 685             // These are all bootstrap tools, which don't depend on the compiler.
 686             // The stage we pass shouldn't matter, but use 0 just in case.
 687             Subcommand::Clean { .. }
 688             | Subcommand::Check { .. }
 689             | Subcommand::Clippy { .. }
 690             | Subcommand::Fix { .. }
 691             | Subcommand::Run { .. }
 692             | Subcommand::Setup { .. }
 693             | Subcommand::Format { .. } => flags.stage.unwrap_or(0),
 694         };
 695
 696         // CI should always run stage 2 builds, unless it specifically states otherwise
 697         #[cfg(not(test))]
 698         if flags.stage.is_none() && crate::CiEnv::current() != crate::CiEnv::None {
 699             match config.cmd {
 700                 Subcommand::Test { .. }
 701                 | Subcommand::Doc { .. }
 702                 | Subcommand::Build { .. }
 703                 | Subcommand::Bench { .. }
 704                 | Subcommand::Dist { .. }
 705                 | Subcommand::Install { .. } => {
 706                     assert_eq!(
 707                         config.stage, 2,
 708                         "x.py should be run with `--stage 2` on CI, but was run with `--stage {}`",
 709                         config.stage,
 710                     );
 711                 }
 712                 Subcommand::Clean { .. }
 713                 | Subcommand::Check { .. }
 714                 | Subcommand::Clippy { .. }
 715                 | Subcommand::Fix { .. }
 716                 | Subcommand::Run { .. }
 717                 | Subcommand::Setup { .. }
 718                 | Subcommand::Format { .. } => {}
 719             }
 720         }
 721
 722         config.verbose = cmp::max(config.verbose, flags.verbose);
 723
 724         if let Some(install) = toml.install {
 725             config.prefix = install.prefix.map(PathBuf::from);
 726             config.sysconfdir = install.sysconfdir.map(PathBuf::from);
 727             config.datadir = install.datadir.map(PathBuf::from);
 728             config.docdir = install.docdir.map(PathBuf::from);
 729             set(&mut config.bindir, install.bindir.map(PathBuf::from));
 730             config.libdir = install.libdir.map(PathBuf::from);
 731             config.mandir = install.mandir.map(PathBuf::from);
 732         }
 733
 734         // We want the llvm-skip-rebuild flag to take precedence over the
 735         // skip-rebuild config.toml option so we store it separately
 736         // so that we can infer the right value
 737         let mut llvm_skip_rebuild = flags.llvm_skip_rebuild;
 738
 739         // Store off these values as options because if they're not provided
 740         // we'll infer default values for them later
 741         let mut llvm_assertions = None;
 742         let mut debug = None;
 743         let mut debug_assertions = None;
 744         let mut debug_assertions_std = None;
 745         let mut debug_logging = None;
 746         let mut debuginfo_level = None;
 747         let mut debuginfo_level_rustc = None;
 748         let mut debuginfo_level_std = None;
 749         let mut debuginfo_level_tools = None;
 750         let mut debuginfo_level_tests = None;
 751         let mut optimize = None;
 752         let mut ignore_git = None;
 753
 754         if let Some(llvm) = toml.llvm {
 755             match llvm.ccache {
 756                 Some(StringOrBool::String(ref s)) => config.ccache = Some(s.to_string()),
 757                 Some(StringOrBool::Bool(true)) => {
 758                     config.ccache = Some("ccache".to_string());
 759                 }
 760                 Some(StringOrBool::Bool(false)) | None => {}
 761             }
 762             set(&mut config.ninja_in_file, llvm.ninja);
 763             llvm_assertions = llvm.assertions;
 764             llvm_skip_rebuild = llvm_skip_rebuild.or(llvm.skip_rebuild);
 765             set(&mut config.llvm_optimize, llvm.optimize);
 766             set(&mut config.llvm_thin_lto, llvm.thin_lto);
 767             set(&mut config.llvm_release_debuginfo, llvm.release_debuginfo);
 768             set(&mut config.llvm_version_check, llvm.version_check);
 769             set(&mut config.llvm_static_stdcpp, llvm.static_libstdcpp);
 770             set(&mut config.llvm_link_shared, llvm.link_shared);
 771             config.llvm_targets = llvm.targets.clone();
 772             config.llvm_experimental_targets = llvm.experimental_targets.clone();
 773             config.llvm_link_jobs = llvm.link_jobs;
 774             config.llvm_version_suffix = llvm.version_suffix.clone();
 775             config.llvm_clang_cl = llvm.clang_cl.clone();
 776
 777             config.llvm_cflags = llvm.cflags.clone();
 778             config.llvm_cxxflags = llvm.cxxflags.clone();
 779             config.llvm_ldflags = llvm.ldflags.clone();
 780             set(&mut config.llvm_use_libcxx, llvm.use_libcxx);
 781             config.llvm_use_linker = llvm.use_linker.clone();
 782             config.llvm_allow_old_toolchain = llvm.allow_old_toolchain;
 783             config.llvm_polly = llvm.polly;
 784             config.llvm_from_ci = match llvm.download_ci_llvm {
 785                 Some(StringOrBool::String(s)) => {
 786                     assert!(s == "if-available", "unknown option `{}` for download-ci-llvm", s);
 787                     config.build.triple == "x86_64-unknown-linux-gnu"
 788                 }
 789                 Some(StringOrBool::Bool(b)) => b,
 790                 None => false,
 791             };
 792
 793             if config.llvm_from_ci {
 794                 // None of the LLVM options, except assertions, are supported
 795                 // when using downloaded LLVM. We could just ignore these but
 796                 // that's potentially confusing, so force them to not be
 797                 // explicitly set. The defaults and CI defaults don't
 798                 // necessarily match but forcing people to match (somewhat
 799                 // arbitrary) CI configuration locally seems bad/hard.
 800                 check_ci_llvm!(llvm.optimize);
 801                 check_ci_llvm!(llvm.thin_lto);
 802                 check_ci_llvm!(llvm.release_debuginfo);
 803                 check_ci_llvm!(llvm.link_shared);
 804                 check_ci_llvm!(llvm.static_libstdcpp);
 805                 check_ci_llvm!(llvm.targets);
 806                 check_ci_llvm!(llvm.experimental_targets);
 807                 check_ci_llvm!(llvm.link_jobs);
 808                 check_ci_llvm!(llvm.link_shared);
 809                 check_ci_llvm!(llvm.clang_cl);
 810                 check_ci_llvm!(llvm.version_suffix);
 811                 check_ci_llvm!(llvm.cflags);
 812                 check_ci_llvm!(llvm.cxxflags);
 813                 check_ci_llvm!(llvm.ldflags);
 814                 check_ci_llvm!(llvm.use_libcxx);
 815                 check_ci_llvm!(llvm.use_linker);
 816                 check_ci_llvm!(llvm.allow_old_toolchain);
 817                 check_ci_llvm!(llvm.polly);
 818
 819                 // CI-built LLVM is shared
 820                 config.llvm_link_shared = true;
 821             }
 822
 823             if config.llvm_thin_lto {
 824                 // If we're building with ThinLTO on, we want to link to LLVM
 825                 // shared, to avoid re-doing ThinLTO (which happens in the link
 826                 // step) with each stage.
 827                 config.llvm_link_shared = true;
 828             }
 829         }
 830
 831         if let Some(rust) = toml.rust {
 832             debug = rust.debug;
 833             debug_assertions = rust.debug_assertions;
 834             debug_assertions_std = rust.debug_assertions_std;
 835             debug_logging = rust.debug_logging;
 836             debuginfo_level = rust.debuginfo_level;
 837             debuginfo_level_rustc = rust.debuginfo_level_rustc;
 838             debuginfo_level_std = rust.debuginfo_level_std;
 839             debuginfo_level_tools = rust.debuginfo_level_tools;
 840             debuginfo_level_tests = rust.debuginfo_level_tests;
 841             config.rust_run_dsymutil = rust.run_dsymutil.unwrap_or(false);
 842             optimize = rust.optimize;
 843             ignore_git = rust.ignore_git;
 844             set(&mut config.rust_new_symbol_mangling, rust.new_symbol_mangling);
 845             set(&mut config.rust_optimize_tests, rust.optimize_tests);
 846             set(&mut config.codegen_tests, rust.codegen_tests);
 847             set(&mut config.rust_rpath, rust.rpath);
 848             set(&mut config.jemalloc, rust.jemalloc);
 849             set(&mut config.test_compare_mode, rust.test_compare_mode);
 850             config.llvm_libunwind = rust
 851                 .llvm_libunwind
 852                 .map(|v| v.parse().expect("failed to parse rust.llvm-libunwind"));
 853             set(&mut config.backtrace, rust.backtrace);
 854             set(&mut config.channel, rust.channel);
 855             config.description = rust.description;
 856             set(&mut config.rust_dist_src, rust.dist_src);
 857             set(&mut config.verbose_tests, rust.verbose_tests);
 858             // in the case "false" is set explicitly, do not overwrite the command line args
 859             if let Some(true) = rust.incremental {
 860                 config.incremental = true;
 861             }
 862             set(&mut config.use_lld, rust.use_lld);
 863             set(&mut config.lld_enabled, rust.lld);
 864             set(&mut config.llvm_tools_enabled, rust.llvm_tools);
 865             config.rustc_parallel = rust.parallel_compiler.unwrap_or(false);
 866             config.rustc_default_linker = rust.default_linker;
 867             config.musl_root = rust.musl_root.map(PathBuf::from);
 868             config.save_toolstates = rust.save_toolstates.map(PathBuf::from);
 869             set(&mut config.deny_warnings, flags.deny_warnings.or(rust.deny_warnings));
 870             set(&mut config.backtrace_on_ice, rust.backtrace_on_ice);
 871             set(&mut config.rust_verify_llvm_ir, rust.verify_llvm_ir);
 872             config.rust_thin_lto_import_instr_limit = rust.thin_lto_import_instr_limit;
 873             set(&mut config.rust_remap_debuginfo, rust.remap_debuginfo);
 874             set(&mut config.control_flow_guard, rust.control_flow_guard);
 875
 876             if let Some(ref backends) = rust.codegen_backends {
 877                 config.rust_codegen_backends =
 878                     backends.iter().map(|s| INTERNER.intern_str(s)).collect();
 879             }
 880
 881             config.rust_codegen_units = rust.codegen_units.map(threads_from_config);
 882             config.rust_codegen_units_std = rust.codegen_units_std.map(threads_from_config);
 883             config.rust_profile_use = flags.rust_profile_use.or(rust.profile_use);
 884             config.rust_profile_generate = flags.rust_profile_generate.or(rust.profile_generate);
 885         } else {
 886             config.rust_profile_use = flags.rust_profile_use;
 887             config.rust_profile_generate = flags.rust_profile_generate;
 888         }
 889
 890         if let Some(t) = toml.target {
 891             for (triple, cfg) in t {
 892                 let mut target = Target::from_triple(&triple);
 893
 894                 if let Some(ref s) = cfg.llvm_config {
 895                     target.llvm_config = Some(config.src.join(s));
 896                 }
 897                 if let Some(ref s) = cfg.llvm_filecheck {
 898                     target.llvm_filecheck = Some(config.src.join(s));
 899                 }
 900                 if let Some(ref s) = cfg.android_ndk {
 901                     target.ndk = Some(config.src.join(s));
 902                 }
 903                 if let Some(s) = cfg.no_std {
 904                     target.no_std = s;
 905                 }
 906                 target.cc = cfg.cc.map(PathBuf::from);
 907                 target.cxx = cfg.cxx.map(PathBuf::from);
 908                 target.ar = cfg.ar.map(PathBuf::from);
 909                 target.ranlib = cfg.ranlib.map(PathBuf::from);
 910                 target.linker = cfg.linker.map(PathBuf::from);
 911                 target.crt_static = cfg.crt_static;
 912                 target.musl_root = cfg.musl_root.map(PathBuf::from);
 913                 target.musl_libdir = cfg.musl_libdir.map(PathBuf::from);
 914                 target.wasi_root = cfg.wasi_root.map(PathBuf::from);
 915                 target.qemu_rootfs = cfg.qemu_rootfs.map(PathBuf::from);
 916                 target.sanitizers = cfg.sanitizers;
 917                 target.profiler = cfg.profiler;
 918
 919                 config.target_config.insert(TargetSelection::from_user(&triple), target);
 920             }
 921         }
 922
 923         if config.llvm_from_ci {
 924             let triple = &config.build.triple;
 925             let mut build_target = config
 926                 .target_config
 927                 .entry(config.build)
 928                 .or_insert_with(|| Target::from_triple(&triple));
 929
 930             check_ci_llvm!(build_target.llvm_config);
 931             check_ci_llvm!(build_target.llvm_filecheck);
 932             let ci_llvm_bin = config.out.join(&*config.build.triple).join("ci-llvm/bin");
 933             build_target.llvm_config = Some(ci_llvm_bin.join(exe("llvm-config", config.build)));
 934             build_target.llvm_filecheck = Some(ci_llvm_bin.join(exe("FileCheck", config.build)));
 935         }
 936
 937         if let Some(t) = toml.dist {
 938             config.dist_sign_folder = t.sign_folder.map(PathBuf::from);
 939             config.dist_gpg_password_file = t.gpg_password_file.map(PathBuf::from);
 940             config.dist_upload_addr = t.upload_addr;
 941             config.dist_compression_formats = t.compression_formats;
 942             set(&mut config.rust_dist_src, t.src_tarball);
 943             set(&mut config.missing_tools, t.missing_tools);
 944         }
 945
 946         config.initial_rustfmt = config.initial_rustfmt.or_else({
 947             let build = config.build;
 948             let initial_rustc = &config.initial_rustc;
 949
 950             move || {
 951                 // Cargo does not provide a RUSTFMT environment variable, so we
 952                 // synthesize it manually.
 953                 let rustfmt = initial_rustc.with_file_name(exe("rustfmt", build));
 954
 955                 if rustfmt.exists() { Some(rustfmt) } else { None }
 956             }
 957         });
 958
 959         // Now that we've reached the end of our configuration, infer the
 960         // default values for all options that we haven't otherwise stored yet.
 961
 962         config.llvm_skip_rebuild = llvm_skip_rebuild.unwrap_or(false);
 963
 964         let default = false;
 965         config.llvm_assertions = llvm_assertions.unwrap_or(default);
 966
 967         let default = true;
 968         config.rust_optimize = optimize.unwrap_or(default);
 969
 970         let default = debug == Some(true);
 971         config.rust_debug_assertions = debug_assertions.unwrap_or(default);
 972         config.rust_debug_assertions_std =
 973             debug_assertions_std.unwrap_or(config.rust_debug_assertions);
 974
 975         config.rust_debug_logging = debug_logging.unwrap_or(config.rust_debug_assertions);
 976
 977         let with_defaults = |debuginfo_level_specific: Option<u32>| {
 978             debuginfo_level_specific.or(debuginfo_level).unwrap_or(if debug == Some(true) {
 979                 1
 980             } else {
 981                 0
 982             })
 983         };
 984         config.rust_debuginfo_level_rustc = with_defaults(debuginfo_level_rustc);
 985         config.rust_debuginfo_level_std = with_defaults(debuginfo_level_std);
 986         config.rust_debuginfo_level_tools = with_defaults(debuginfo_level_tools);
 987         config.rust_debuginfo_level_tests = debuginfo_level_tests.unwrap_or(0);
 988
 989         let default = config.channel == "dev";
 990         config.ignore_git = ignore_git.unwrap_or(default);
 991
 992         config
 993     }
 994
 995     /// Try to find the relative path of `bindir`, otherwise return it in full.
 996     pub fn bindir_relative(&self) -> &Path {
 997         let bindir = &self.bindir;
 998         if bindir.is_absolute() {
 999             // Try to make it relative to the prefix.
1000             if let Some(prefix) = &self.prefix {
1001                 if let Ok(stripped) = bindir.strip_prefix(prefix) {
1002                     return stripped;
1003                 }
1004             }
1005         }
1006         bindir
1007     }
1008
1009     /// Try to find the relative path of `libdir`.
1010     pub fn libdir_relative(&self) -> Option<&Path> {
1011         let libdir = self.libdir.as_ref()?;
1012         if libdir.is_relative() {
1013             Some(libdir)
1014         } else {
1015             // Try to make it relative to the prefix.
1016             libdir.strip_prefix(self.prefix.as_ref()?).ok()
1017         }
1018     }
1019
1020     pub fn verbose(&self) -> bool {
1021         self.verbose > 0
1022     }
1023
1024     pub fn very_verbose(&self) -> bool {
1025         self.verbose > 1
1026     }
1027
1028     pub fn sanitizers_enabled(&self, target: TargetSelection) -> bool {
1029         self.target_config.get(&target).map(|t| t.sanitizers).flatten().unwrap_or(self.sanitizers)
1030     }
1031
1032     pub fn any_sanitizers_enabled(&self) -> bool {
1033         self.target_config.values().any(|t| t.sanitizers == Some(true)) || self.sanitizers
1034     }
1035
1036     pub fn profiler_enabled(&self, target: TargetSelection) -> bool {
1037         self.target_config.get(&target).map(|t| t.profiler).flatten().unwrap_or(self.profiler)
1038     }
1039
1040     pub fn any_profiler_enabled(&self) -> bool {
1041         self.target_config.values().any(|t| t.profiler == Some(true)) || self.profiler
1042     }
1043
1044     pub fn llvm_enabled(&self) -> bool {
1045         self.rust_codegen_backends.contains(&INTERNER.intern_str("llvm"))
1046     }
1047 }
1048
1049 fn set<T>(field: &mut T, val: Option<T>) {
1050     if let Some(v) = val {
1051         *field = v;
1052     }
1053 }
1054
1055 fn threads_from_config(v: u32) -> u32 {
1056     match v {
1057         0 => num_cpus::get() as u32,
1058         n => n,
1059     }
1060 }