1 //! Serialized configuration of a build.
3 //! This module implements parsing `config.toml` configuration files to tweak
4 //! how the build runs.
6 use std::cell::{Cell, RefCell};
8 use std::collections::{HashMap, HashSet};
13 use std::path::{Path, PathBuf};
14 use std::process::Command;
15 use std::str::FromStr;
17 use crate::builder::{Builder, TaskPath};
18 use crate::cache::{Interned, INTERNER};
19 use crate::channel::GitInfo;
20 pub use crate::flags::Subcommand;
21 use crate::flags::{Color, Flags};
22 use crate::util::{exe, output, program_out_of_date, t};
23 use once_cell::sync::OnceCell;
24 use serde::{Deserialize, Deserializer};
26 macro_rules! check_ci_llvm {
30 "setting {} is incompatible with download-ci-llvm.",
36 /// Global configuration for the entire build and/or bootstrap.
38 /// This structure is derived from a combination of both `config.toml` and
39 /// `config.mk`. As of the time of this writing it's unlikely that `config.toml`
40 /// is used all that much, so this is primarily filled out by `config.mk` which
41 /// is generated from `./configure`.
43 /// Note that this structure is not decoded directly into, but rather it is
44 /// filled out from the decoded forms of the structs below. For documentation
45 /// each field, see the corresponding fields in
46 /// `config.toml.example`.
48 #[cfg_attr(test, derive(Clone))]
50 pub changelog_seen: Option<usize>,
51 pub ccache: Option<String>,
52 /// Call Build::ninja() instead of this.
53 pub ninja_in_file: bool,
55 pub submodules: Option<bool>,
56 pub compiler_docs: bool,
57 pub docs_minification: bool,
59 pub locked_deps: bool,
61 pub target_config: HashMap<TargetSelection, Target>,
62 pub full_bootstrap: bool,
64 pub tools: Option<HashSet<String>>,
68 pub exclude: Vec<TaskPath>,
69 pub include_default_paths: bool,
70 pub rustc_error_format: Option<String>,
71 pub json_output: bool,
72 pub test_compare_mode: bool,
74 pub patch_binaries_for_nix: bool,
75 pub stage0_metadata: Stage0Metadata,
77 pub on_fail: Option<String>,
79 pub keep_stage: Vec<u32>,
80 pub keep_stage_std: Vec<u32>,
82 /// defaults to `config.toml`
84 pub jobs: Option<u32>,
86 pub incremental: bool,
88 /// `None` if we shouldn't download CI compiler artifacts, or the commit to download if we should.
90 download_rustc_commit: Option<String>,
92 pub download_rustc_commit: Option<String>,
94 pub deny_warnings: bool,
95 pub backtrace_on_ice: bool,
97 // llvm codegen options
98 pub llvm_skip_rebuild: bool,
99 pub llvm_assertions: bool,
100 pub llvm_tests: bool,
101 pub llvm_plugins: bool,
102 pub llvm_optimize: bool,
103 pub llvm_thin_lto: bool,
104 pub llvm_release_debuginfo: bool,
105 pub llvm_version_check: bool,
106 pub llvm_static_stdcpp: bool,
107 /// `None` if `llvm_from_ci` is true and we haven't yet downloaded llvm.
109 llvm_link_shared: Cell<Option<bool>>,
111 pub llvm_link_shared: Cell<Option<bool>>,
112 pub llvm_clang_cl: Option<String>,
113 pub llvm_targets: Option<String>,
114 pub llvm_experimental_targets: Option<String>,
115 pub llvm_link_jobs: Option<u32>,
116 pub llvm_version_suffix: Option<String>,
117 pub llvm_use_linker: Option<String>,
118 pub llvm_allow_old_toolchain: bool,
119 pub llvm_polly: bool,
120 pub llvm_clang: bool,
121 pub llvm_from_ci: bool,
122 pub llvm_build_config: HashMap<String, String>,
125 pub lld_enabled: bool,
126 pub llvm_tools_enabled: bool,
128 pub llvm_cflags: Option<String>,
129 pub llvm_cxxflags: Option<String>,
130 pub llvm_ldflags: Option<String>,
131 pub llvm_use_libcxx: bool,
133 // rust codegen options
134 pub rust_optimize: bool,
135 pub rust_codegen_units: Option<u32>,
136 pub rust_codegen_units_std: Option<u32>,
137 pub rust_debug_assertions: bool,
138 pub rust_debug_assertions_std: bool,
139 pub rust_overflow_checks: bool,
140 pub rust_overflow_checks_std: bool,
141 pub rust_debug_logging: bool,
142 pub rust_debuginfo_level_rustc: u32,
143 pub rust_debuginfo_level_std: u32,
144 pub rust_debuginfo_level_tools: u32,
145 pub rust_debuginfo_level_tests: u32,
146 pub rust_split_debuginfo: SplitDebuginfo,
147 pub rust_rpath: bool,
148 pub rustc_parallel: bool,
149 pub rustc_default_linker: Option<String>,
150 pub rust_optimize_tests: bool,
151 pub rust_dist_src: bool,
152 pub rust_codegen_backends: Vec<Interned<String>>,
153 pub rust_verify_llvm_ir: bool,
154 pub rust_thin_lto_import_instr_limit: Option<u32>,
155 pub rust_remap_debuginfo: bool,
156 pub rust_new_symbol_mangling: Option<bool>,
157 pub rust_profile_use: Option<String>,
158 pub rust_profile_generate: Option<String>,
159 pub llvm_profile_use: Option<String>,
160 pub llvm_profile_generate: bool,
161 pub llvm_libunwind_default: Option<LlvmLibunwind>,
163 pub build: TargetSelection,
164 pub hosts: Vec<TargetSelection>,
165 pub targets: Vec<TargetSelection>,
166 pub local_rebuild: bool,
168 pub control_flow_guard: bool,
171 pub dist_sign_folder: Option<PathBuf>,
172 pub dist_upload_addr: Option<String>,
173 pub dist_compression_formats: Option<Vec<String>>,
176 pub backtrace: bool, // support for RUST_BACKTRACE
179 pub low_priority: bool,
181 pub description: Option<String>,
182 pub verbose_tests: bool,
183 pub save_toolstates: Option<PathBuf>,
184 pub print_step_timings: bool,
185 pub print_step_rusage: bool,
186 pub missing_tools: bool,
188 // Fallback musl-root for all targets
189 pub musl_root: Option<PathBuf>,
190 pub prefix: Option<PathBuf>,
191 pub sysconfdir: Option<PathBuf>,
192 pub datadir: Option<PathBuf>,
193 pub docdir: Option<PathBuf>,
195 pub libdir: Option<PathBuf>,
196 pub mandir: Option<PathBuf>,
197 pub codegen_tests: bool,
198 pub nodejs: Option<PathBuf>,
199 pub npm: Option<PathBuf>,
200 pub gdb: Option<PathBuf>,
201 pub python: Option<PathBuf>,
202 pub cargo_native_static: bool,
203 pub configure_args: Vec<String>,
205 // These are either the stage0 downloaded binaries or the locally installed ones.
206 pub initial_cargo: PathBuf,
207 pub initial_rustc: PathBuf,
209 initial_rustfmt: RefCell<RustfmtState>,
211 pub initial_rustfmt: RefCell<RustfmtState>,
215 #[derive(Default, Deserialize)]
216 #[cfg_attr(test, derive(Clone))]
217 pub struct Stage0Metadata {
218 pub config: Stage0Config,
219 pub checksums_sha256: HashMap<String, String>,
220 pub rustfmt: Option<RustfmtMetadata>,
222 #[derive(Default, Deserialize)]
223 #[cfg_attr(test, derive(Clone))]
224 pub struct Stage0Config {
225 pub dist_server: String,
226 pub artifacts_server: String,
227 pub artifacts_with_llvm_assertions_server: String,
228 pub git_merge_commit_email: String,
229 pub nightly_branch: String,
231 #[derive(Default, Deserialize)]
232 #[cfg_attr(test, derive(Clone))]
233 pub struct RustfmtMetadata {
238 #[derive(Clone, Debug)]
239 pub enum RustfmtState {
240 SystemToolchain(PathBuf),
246 impl Default for RustfmtState {
247 fn default() -> Self {
248 RustfmtState::LazyEvaluated
252 #[derive(Debug, Clone, Copy, PartialEq)]
253 pub enum LlvmLibunwind {
259 impl Default for LlvmLibunwind {
260 fn default() -> Self {
265 impl FromStr for LlvmLibunwind {
268 fn from_str(value: &str) -> Result<Self, Self::Err> {
270 "no" => Ok(Self::No),
271 "in-tree" => Ok(Self::InTree),
272 "system" => Ok(Self::System),
273 invalid => Err(format!("Invalid value '{}' for rust.llvm-libunwind config.", invalid)),
278 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
279 pub enum SplitDebuginfo {
285 impl Default for SplitDebuginfo {
286 fn default() -> Self {
291 impl std::str::FromStr for SplitDebuginfo {
294 fn from_str(s: &str) -> Result<Self, Self::Err> {
296 "packed" => Ok(SplitDebuginfo::Packed),
297 "unpacked" => Ok(SplitDebuginfo::Unpacked),
298 "off" => Ok(SplitDebuginfo::Off),
304 impl SplitDebuginfo {
305 /// Returns the default `-Csplit-debuginfo` value for the current target. See the comment for
306 /// `rust.split-debuginfo` in `config.toml.example`.
307 fn default_for_platform(target: &str) -> Self {
308 if target.contains("apple") {
309 SplitDebuginfo::Unpacked
310 } else if target.contains("windows") {
311 SplitDebuginfo::Packed
318 #[derive(Copy, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
319 pub struct TargetSelection {
320 pub triple: Interned<String>,
321 file: Option<Interned<String>>,
324 impl TargetSelection {
325 pub fn from_user(selection: &str) -> Self {
326 let path = Path::new(selection);
328 let (triple, file) = if path.exists() {
331 .expect("Target specification file has no file stem")
333 .expect("Target specification file stem is not UTF-8");
335 (triple, Some(selection))
340 let triple = INTERNER.intern_str(triple);
341 let file = file.map(|f| INTERNER.intern_str(f));
343 Self { triple, file }
346 pub fn rustc_target_arg(&self) -> &str {
347 self.file.as_ref().unwrap_or(&self.triple)
350 pub fn contains(&self, needle: &str) -> bool {
351 self.triple.contains(needle)
354 pub fn starts_with(&self, needle: &str) -> bool {
355 self.triple.starts_with(needle)
358 pub fn ends_with(&self, needle: &str) -> bool {
359 self.triple.ends_with(needle)
363 impl fmt::Display for TargetSelection {
364 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
365 write!(f, "{}", self.triple)?;
366 if let Some(file) = self.file {
367 write!(f, "({})", file)?;
373 impl fmt::Debug for TargetSelection {
374 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
375 write!(f, "{}", self)
379 impl PartialEq<&str> for TargetSelection {
380 fn eq(&self, other: &&str) -> bool {
381 self.triple == *other
385 /// Per-target configuration stored in the global configuration structure.
387 #[cfg_attr(test, derive(Clone))]
389 /// Some(path to llvm-config) if using an external LLVM.
390 pub llvm_config: Option<PathBuf>,
391 /// Some(path to FileCheck) if one was specified.
392 pub llvm_filecheck: Option<PathBuf>,
393 pub llvm_libunwind: Option<LlvmLibunwind>,
394 pub cc: Option<PathBuf>,
395 pub cxx: Option<PathBuf>,
396 pub ar: Option<PathBuf>,
397 pub ranlib: Option<PathBuf>,
398 pub default_linker: Option<PathBuf>,
399 pub linker: Option<PathBuf>,
400 pub ndk: Option<PathBuf>,
401 pub sanitizers: Option<bool>,
402 pub profiler: Option<bool>,
403 pub crt_static: Option<bool>,
404 pub musl_root: Option<PathBuf>,
405 pub musl_libdir: Option<PathBuf>,
406 pub wasi_root: Option<PathBuf>,
407 pub qemu_rootfs: Option<PathBuf>,
412 pub fn from_triple(triple: &str) -> Self {
413 let mut target: Self = Default::default();
414 if triple.contains("-none")
415 || triple.contains("nvptx")
416 || triple.contains("switch")
417 || triple.contains("-uefi")
419 target.no_std = true;
424 /// Structure of the `config.toml` file that configuration is read from.
426 /// This structure uses `Decodable` to automatically decode a TOML configuration
427 /// file into this format, and then this is traversed and written into the above
428 /// `Config` structure.
429 #[derive(Deserialize, Default)]
430 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
432 changelog_seen: Option<usize>,
433 build: Option<Build>,
434 install: Option<Install>,
437 target: Option<HashMap<String, TomlTarget>>,
439 profile: Option<String>,
443 fn merge(&mut self, other: Self);
446 impl Merge for TomlConfig {
449 TomlConfig { build, install, llvm, rust, dist, target, profile: _, changelog_seen: _ }: Self,
451 fn do_merge<T: Merge>(x: &mut Option<T>, y: Option<T>) {
452 if let Some(new) = y {
453 if let Some(original) = x {
460 do_merge(&mut self.build, build);
461 do_merge(&mut self.install, install);
462 do_merge(&mut self.llvm, llvm);
463 do_merge(&mut self.rust, rust);
464 do_merge(&mut self.dist, dist);
465 assert!(target.is_none(), "merging target-specific config is not currently supported");
469 // We are using a decl macro instead of a derive proc macro here to reduce the compile time of
471 macro_rules! define_config {
472 ($(#[$attr:meta])* struct $name:ident {
473 $($field:ident: Option<$field_ty:ty> = $field_key:literal,)*
477 $($field: Option<$field_ty>,)*
480 impl Merge for $name {
481 fn merge(&mut self, other: Self) {
483 if !self.$field.is_some() {
484 self.$field = other.$field;
490 // The following is a trimmed version of what serde_derive generates. All parts not relevant
491 // for toml deserialization have been removed. This reduces the binary size and improves
492 // compile time of rustbuild.
493 impl<'de> Deserialize<'de> for $name {
494 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
496 D: Deserializer<'de>,
499 impl<'de> serde::de::Visitor<'de> for Field {
501 fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
502 f.write_str(concat!("struct ", stringify!($name)))
506 fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error>
508 A: serde::de::MapAccess<'de>,
510 $(let mut $field: Option<$field_ty> = None;)*
511 while let Some(key) =
512 match serde::de::MapAccess::next_key::<String>(&mut map) {
521 if $field.is_some() {
522 return Err(<A::Error as serde::de::Error>::duplicate_field(
526 $field = match serde::de::MapAccess::next_value::<$field_ty>(
529 Ok(val) => Some(val),
536 return Err(serde::de::Error::unknown_field(key, FIELDS));
540 Ok($name { $($field),* })
543 const FIELDS: &'static [&'static str] = &[
546 Deserializer::deserialize_struct(
558 /// TOML representation of various global build decisions.
561 build: Option<String> = "build",
562 host: Option<Vec<String>> = "host",
563 target: Option<Vec<String>> = "target",
564 build_dir: Option<String> = "build-dir",
565 cargo: Option<String> = "cargo",
566 rustc: Option<String> = "rustc",
567 rustfmt: Option<PathBuf> = "rustfmt",
568 docs: Option<bool> = "docs",
569 compiler_docs: Option<bool> = "compiler-docs",
570 docs_minification: Option<bool> = "docs-minification",
571 submodules: Option<bool> = "submodules",
572 gdb: Option<String> = "gdb",
573 nodejs: Option<String> = "nodejs",
574 npm: Option<String> = "npm",
575 python: Option<String> = "python",
576 locked_deps: Option<bool> = "locked-deps",
577 vendor: Option<bool> = "vendor",
578 full_bootstrap: Option<bool> = "full-bootstrap",
579 extended: Option<bool> = "extended",
580 tools: Option<HashSet<String>> = "tools",
581 verbose: Option<usize> = "verbose",
582 sanitizers: Option<bool> = "sanitizers",
583 profiler: Option<bool> = "profiler",
584 cargo_native_static: Option<bool> = "cargo-native-static",
585 low_priority: Option<bool> = "low-priority",
586 configure_args: Option<Vec<String>> = "configure-args",
587 local_rebuild: Option<bool> = "local-rebuild",
588 print_step_timings: Option<bool> = "print-step-timings",
589 print_step_rusage: Option<bool> = "print-step-rusage",
590 check_stage: Option<u32> = "check-stage",
591 doc_stage: Option<u32> = "doc-stage",
592 build_stage: Option<u32> = "build-stage",
593 test_stage: Option<u32> = "test-stage",
594 install_stage: Option<u32> = "install-stage",
595 dist_stage: Option<u32> = "dist-stage",
596 bench_stage: Option<u32> = "bench-stage",
597 patch_binaries_for_nix: Option<bool> = "patch-binaries-for-nix",
598 metrics: Option<bool> = "metrics",
603 /// TOML representation of various global install decisions.
605 prefix: Option<String> = "prefix",
606 sysconfdir: Option<String> = "sysconfdir",
607 docdir: Option<String> = "docdir",
608 bindir: Option<String> = "bindir",
609 libdir: Option<String> = "libdir",
610 mandir: Option<String> = "mandir",
611 datadir: Option<String> = "datadir",
616 /// TOML representation of how the LLVM build is configured.
618 skip_rebuild: Option<bool> = "skip-rebuild",
619 optimize: Option<bool> = "optimize",
620 thin_lto: Option<bool> = "thin-lto",
621 release_debuginfo: Option<bool> = "release-debuginfo",
622 assertions: Option<bool> = "assertions",
623 tests: Option<bool> = "tests",
624 plugins: Option<bool> = "plugins",
625 ccache: Option<StringOrBool> = "ccache",
626 version_check: Option<bool> = "version-check",
627 static_libstdcpp: Option<bool> = "static-libstdcpp",
628 ninja: Option<bool> = "ninja",
629 targets: Option<String> = "targets",
630 experimental_targets: Option<String> = "experimental-targets",
631 link_jobs: Option<u32> = "link-jobs",
632 link_shared: Option<bool> = "link-shared",
633 version_suffix: Option<String> = "version-suffix",
634 clang_cl: Option<String> = "clang-cl",
635 cflags: Option<String> = "cflags",
636 cxxflags: Option<String> = "cxxflags",
637 ldflags: Option<String> = "ldflags",
638 use_libcxx: Option<bool> = "use-libcxx",
639 use_linker: Option<String> = "use-linker",
640 allow_old_toolchain: Option<bool> = "allow-old-toolchain",
641 polly: Option<bool> = "polly",
642 clang: Option<bool> = "clang",
643 download_ci_llvm: Option<StringOrBool> = "download-ci-llvm",
644 build_config: Option<HashMap<String, String>> = "build-config",
650 sign_folder: Option<String> = "sign-folder",
651 gpg_password_file: Option<String> = "gpg-password-file",
652 upload_addr: Option<String> = "upload-addr",
653 src_tarball: Option<bool> = "src-tarball",
654 missing_tools: Option<bool> = "missing-tools",
655 compression_formats: Option<Vec<String>> = "compression-formats",
659 #[derive(Deserialize)]
666 impl Default for StringOrBool {
667 fn default() -> StringOrBool {
668 StringOrBool::Bool(false)
673 /// TOML representation of how the Rust build is configured.
675 optimize: Option<bool> = "optimize",
676 debug: Option<bool> = "debug",
677 codegen_units: Option<u32> = "codegen-units",
678 codegen_units_std: Option<u32> = "codegen-units-std",
679 debug_assertions: Option<bool> = "debug-assertions",
680 debug_assertions_std: Option<bool> = "debug-assertions-std",
681 overflow_checks: Option<bool> = "overflow-checks",
682 overflow_checks_std: Option<bool> = "overflow-checks-std",
683 debug_logging: Option<bool> = "debug-logging",
684 debuginfo_level: Option<u32> = "debuginfo-level",
685 debuginfo_level_rustc: Option<u32> = "debuginfo-level-rustc",
686 debuginfo_level_std: Option<u32> = "debuginfo-level-std",
687 debuginfo_level_tools: Option<u32> = "debuginfo-level-tools",
688 debuginfo_level_tests: Option<u32> = "debuginfo-level-tests",
689 split_debuginfo: Option<String> = "split-debuginfo",
690 run_dsymutil: Option<bool> = "run-dsymutil",
691 backtrace: Option<bool> = "backtrace",
692 incremental: Option<bool> = "incremental",
693 parallel_compiler: Option<bool> = "parallel-compiler",
694 default_linker: Option<String> = "default-linker",
695 channel: Option<String> = "channel",
696 description: Option<String> = "description",
697 musl_root: Option<String> = "musl-root",
698 rpath: Option<bool> = "rpath",
699 verbose_tests: Option<bool> = "verbose-tests",
700 optimize_tests: Option<bool> = "optimize-tests",
701 codegen_tests: Option<bool> = "codegen-tests",
702 ignore_git: Option<bool> = "ignore-git",
703 dist_src: Option<bool> = "dist-src",
704 save_toolstates: Option<String> = "save-toolstates",
705 codegen_backends: Option<Vec<String>> = "codegen-backends",
706 lld: Option<bool> = "lld",
707 use_lld: Option<bool> = "use-lld",
708 llvm_tools: Option<bool> = "llvm-tools",
709 deny_warnings: Option<bool> = "deny-warnings",
710 backtrace_on_ice: Option<bool> = "backtrace-on-ice",
711 verify_llvm_ir: Option<bool> = "verify-llvm-ir",
712 thin_lto_import_instr_limit: Option<u32> = "thin-lto-import-instr-limit",
713 remap_debuginfo: Option<bool> = "remap-debuginfo",
714 jemalloc: Option<bool> = "jemalloc",
715 test_compare_mode: Option<bool> = "test-compare-mode",
716 llvm_libunwind: Option<String> = "llvm-libunwind",
717 control_flow_guard: Option<bool> = "control-flow-guard",
718 new_symbol_mangling: Option<bool> = "new-symbol-mangling",
719 profile_generate: Option<String> = "profile-generate",
720 profile_use: Option<String> = "profile-use",
721 // ignored; this is set from an env var set by bootstrap.py
722 download_rustc: Option<StringOrBool> = "download-rustc",
727 /// TOML representation of how each build target is configured.
729 cc: Option<String> = "cc",
730 cxx: Option<String> = "cxx",
731 ar: Option<String> = "ar",
732 ranlib: Option<String> = "ranlib",
733 default_linker: Option<PathBuf> = "default-linker",
734 linker: Option<String> = "linker",
735 llvm_config: Option<String> = "llvm-config",
736 llvm_filecheck: Option<String> = "llvm-filecheck",
737 llvm_libunwind: Option<String> = "llvm-libunwind",
738 android_ndk: Option<String> = "android-ndk",
739 sanitizers: Option<bool> = "sanitizers",
740 profiler: Option<bool> = "profiler",
741 crt_static: Option<bool> = "crt-static",
742 musl_root: Option<String> = "musl-root",
743 musl_libdir: Option<String> = "musl-libdir",
744 wasi_root: Option<String> = "wasi-root",
745 qemu_rootfs: Option<String> = "qemu-rootfs",
746 no_std: Option<bool> = "no-std",
751 pub fn default_opts() -> Config {
752 let mut config = Config::default();
753 config.llvm_optimize = true;
754 config.ninja_in_file = true;
755 config.llvm_version_check = true;
756 config.llvm_static_stdcpp = true;
757 config.backtrace = true;
758 config.rust_optimize = true;
759 config.rust_optimize_tests = true;
760 config.submodules = None;
762 config.docs_minification = true;
763 config.rust_rpath = true;
764 config.channel = "dev".to_string();
765 config.codegen_tests = true;
766 config.rust_dist_src = true;
767 config.rust_codegen_backends = vec![INTERNER.intern_str("llvm")];
768 config.deny_warnings = true;
769 config.bindir = "bin".into();
772 config.build = TargetSelection::from_user(&env!("BUILD_TRIPLE"));
773 let manifest_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
774 // Undo `src/bootstrap`
775 config.src = manifest_dir.parent().unwrap().parent().unwrap().to_owned();
776 config.out = PathBuf::from("build");
778 config.initial_cargo = PathBuf::from(env!("CARGO"));
779 config.initial_rustc = PathBuf::from(env!("RUSTC"));
784 pub fn parse(args: &[String]) -> Config {
785 let flags = Flags::parse(&args);
787 let mut config = Config::default_opts();
788 config.exclude = flags.exclude.into_iter().map(|path| TaskPath::parse(path)).collect();
789 config.include_default_paths = flags.include_default_paths;
790 config.rustc_error_format = flags.rustc_error_format;
791 config.json_output = flags.json_output;
792 config.on_fail = flags.on_fail;
793 config.jobs = flags.jobs.map(threads_from_config);
794 config.cmd = flags.cmd;
795 config.incremental = flags.incremental;
796 config.dry_run = flags.dry_run;
797 config.keep_stage = flags.keep_stage;
798 config.keep_stage_std = flags.keep_stage_std;
799 config.color = flags.color;
800 if let Some(value) = flags.deny_warnings {
801 config.deny_warnings = value;
803 config.llvm_profile_use = flags.llvm_profile_use;
804 config.llvm_profile_generate = flags.llvm_profile_generate;
806 let stage0_json = t!(std::fs::read(&config.src.join("src").join("stage0.json")));
807 config.stage0_metadata = t!(serde_json::from_slice::<Stage0Metadata>(&stage0_json));
810 let get_toml = |_| TomlConfig::default();
812 let get_toml = |file: &Path| {
814 t!(fs::read_to_string(file), format!("config file {} not found", file.display()));
815 // Deserialize to Value and then TomlConfig to prevent the Deserialize impl of
816 // TomlConfig and sub types to be monomorphized 5x by toml.
817 match toml::from_str(&contents)
818 .and_then(|table: toml::Value| TomlConfig::deserialize(table))
822 eprintln!("failed to parse TOML configuration '{}': {}", file.display(), err);
823 crate::detail_exit(2);
828 // Read from `--config`, then `RUST_BOOTSTRAP_CONFIG`, then `./config.toml`, then `config.toml` in the root directory.
829 let toml_path = flags
832 .or_else(|| env::var_os("RUST_BOOTSTRAP_CONFIG").map(PathBuf::from));
833 let using_default_path = toml_path.is_none();
834 let mut toml_path = toml_path.unwrap_or_else(|| PathBuf::from("config.toml"));
835 if using_default_path && !toml_path.exists() {
836 toml_path = config.src.join(toml_path);
839 // Give a hard error if `--config` or `RUST_BOOTSTRAP_CONFIG` are set to a missing path,
840 // but not if `config.toml` hasn't been created.
841 let mut toml = if !using_default_path || toml_path.exists() {
844 TomlConfig::default()
847 if let Some(include) = &toml.profile {
848 let mut include_path = config.src.clone();
849 include_path.push("src");
850 include_path.push("bootstrap");
851 include_path.push("defaults");
852 include_path.push(format!("config.{}.toml", include));
853 let included_toml = get_toml(&include_path);
854 toml.merge(included_toml);
857 config.changelog_seen = toml.changelog_seen;
858 config.config = toml_path;
860 let build = toml.build.unwrap_or_default();
862 set(&mut config.initial_rustc, build.rustc.map(PathBuf::from));
863 set(&mut config.out, flags.build_dir.or_else(|| build.build_dir.map(PathBuf::from)));
864 // NOTE: Bootstrap spawns various commands with different working directories.
865 // To avoid writing to random places on the file system, `config.out` needs to be an absolute path.
866 if !config.out.is_absolute() {
867 // `canonicalize` requires the path to already exist. Use our vendored copy of `absolute` instead.
868 config.out = crate::util::absolute(&config.out);
872 let dir = config.out.join("tmp-dry-run");
873 t!(fs::create_dir_all(&dir));
877 config.hosts = if let Some(arg_host) = flags.host {
879 } else if let Some(file_host) = build.host {
880 file_host.iter().map(|h| TargetSelection::from_user(h)).collect()
884 config.targets = if let Some(arg_target) = flags.target {
886 } else if let Some(file_target) = build.target {
887 file_target.iter().map(|h| TargetSelection::from_user(h)).collect()
889 // If target is *not* configured, then default to the host
894 config.nodejs = build.nodejs.map(PathBuf::from);
895 config.npm = build.npm.map(PathBuf::from);
896 config.gdb = build.gdb.map(PathBuf::from);
897 config.python = build.python.map(PathBuf::from);
898 config.submodules = build.submodules;
899 set(&mut config.low_priority, build.low_priority);
900 set(&mut config.compiler_docs, build.compiler_docs);
901 set(&mut config.docs_minification, build.docs_minification);
902 set(&mut config.docs, build.docs);
903 set(&mut config.locked_deps, build.locked_deps);
904 set(&mut config.vendor, build.vendor);
905 set(&mut config.full_bootstrap, build.full_bootstrap);
906 set(&mut config.extended, build.extended);
907 config.tools = build.tools;
908 set(&mut config.verbose, build.verbose);
909 set(&mut config.sanitizers, build.sanitizers);
910 set(&mut config.profiler, build.profiler);
911 set(&mut config.cargo_native_static, build.cargo_native_static);
912 set(&mut config.configure_args, build.configure_args);
913 set(&mut config.local_rebuild, build.local_rebuild);
914 set(&mut config.print_step_timings, build.print_step_timings);
915 set(&mut config.print_step_rusage, build.print_step_rusage);
916 set(&mut config.patch_binaries_for_nix, build.patch_binaries_for_nix);
918 config.verbose = cmp::max(config.verbose, flags.verbose);
920 if let Some(install) = toml.install {
921 config.prefix = install.prefix.map(PathBuf::from);
922 config.sysconfdir = install.sysconfdir.map(PathBuf::from);
923 config.datadir = install.datadir.map(PathBuf::from);
924 config.docdir = install.docdir.map(PathBuf::from);
925 set(&mut config.bindir, install.bindir.map(PathBuf::from));
926 config.libdir = install.libdir.map(PathBuf::from);
927 config.mandir = install.mandir.map(PathBuf::from);
930 // We want the llvm-skip-rebuild flag to take precedence over the
931 // skip-rebuild config.toml option so we store it separately
932 // so that we can infer the right value
933 let mut llvm_skip_rebuild = flags.llvm_skip_rebuild;
935 // Store off these values as options because if they're not provided
936 // we'll infer default values for them later
937 let mut llvm_assertions = None;
938 let mut llvm_tests = None;
939 let mut llvm_plugins = None;
940 let mut debug = None;
941 let mut debug_assertions = None;
942 let mut debug_assertions_std = None;
943 let mut overflow_checks = None;
944 let mut overflow_checks_std = None;
945 let mut debug_logging = None;
946 let mut debuginfo_level = None;
947 let mut debuginfo_level_rustc = None;
948 let mut debuginfo_level_std = None;
949 let mut debuginfo_level_tools = None;
950 let mut debuginfo_level_tests = None;
951 let mut optimize = None;
952 let mut ignore_git = None;
954 if let Some(llvm) = toml.llvm {
956 Some(StringOrBool::String(ref s)) => config.ccache = Some(s.to_string()),
957 Some(StringOrBool::Bool(true)) => {
958 config.ccache = Some("ccache".to_string());
960 Some(StringOrBool::Bool(false)) | None => {}
962 set(&mut config.ninja_in_file, llvm.ninja);
963 llvm_assertions = llvm.assertions;
964 llvm_tests = llvm.tests;
965 llvm_plugins = llvm.plugins;
966 llvm_skip_rebuild = llvm_skip_rebuild.or(llvm.skip_rebuild);
967 set(&mut config.llvm_optimize, llvm.optimize);
968 set(&mut config.llvm_thin_lto, llvm.thin_lto);
969 set(&mut config.llvm_release_debuginfo, llvm.release_debuginfo);
970 set(&mut config.llvm_version_check, llvm.version_check);
971 set(&mut config.llvm_static_stdcpp, llvm.static_libstdcpp);
972 if let Some(v) = llvm.link_shared {
973 config.llvm_link_shared.set(Some(v));
975 config.llvm_targets = llvm.targets.clone();
976 config.llvm_experimental_targets = llvm.experimental_targets.clone();
977 config.llvm_link_jobs = llvm.link_jobs;
978 config.llvm_version_suffix = llvm.version_suffix.clone();
979 config.llvm_clang_cl = llvm.clang_cl.clone();
981 config.llvm_cflags = llvm.cflags.clone();
982 config.llvm_cxxflags = llvm.cxxflags.clone();
983 config.llvm_ldflags = llvm.ldflags.clone();
984 set(&mut config.llvm_use_libcxx, llvm.use_libcxx);
985 config.llvm_use_linker = llvm.use_linker.clone();
986 config.llvm_allow_old_toolchain = llvm.allow_old_toolchain.unwrap_or(false);
987 config.llvm_polly = llvm.polly.unwrap_or(false);
988 config.llvm_clang = llvm.clang.unwrap_or(false);
989 config.llvm_build_config = llvm.build_config.clone().unwrap_or(Default::default());
990 config.llvm_from_ci = match llvm.download_ci_llvm {
991 Some(StringOrBool::String(s)) => {
992 assert!(s == "if-available", "unknown option `{}` for download-ci-llvm", s);
993 crate::native::is_ci_llvm_available(&config, llvm_assertions.unwrap_or(false))
995 Some(StringOrBool::Bool(b)) => b,
999 if config.llvm_from_ci {
1000 // None of the LLVM options, except assertions, are supported
1001 // when using downloaded LLVM. We could just ignore these but
1002 // that's potentially confusing, so force them to not be
1003 // explicitly set. The defaults and CI defaults don't
1004 // necessarily match but forcing people to match (somewhat
1005 // arbitrary) CI configuration locally seems bad/hard.
1006 check_ci_llvm!(llvm.optimize);
1007 check_ci_llvm!(llvm.thin_lto);
1008 check_ci_llvm!(llvm.release_debuginfo);
1009 // CI-built LLVM can be either dynamic or static. We won't know until we download it.
1010 check_ci_llvm!(llvm.link_shared);
1011 check_ci_llvm!(llvm.static_libstdcpp);
1012 check_ci_llvm!(llvm.targets);
1013 check_ci_llvm!(llvm.experimental_targets);
1014 check_ci_llvm!(llvm.link_jobs);
1015 check_ci_llvm!(llvm.clang_cl);
1016 check_ci_llvm!(llvm.version_suffix);
1017 check_ci_llvm!(llvm.cflags);
1018 check_ci_llvm!(llvm.cxxflags);
1019 check_ci_llvm!(llvm.ldflags);
1020 check_ci_llvm!(llvm.use_libcxx);
1021 check_ci_llvm!(llvm.use_linker);
1022 check_ci_llvm!(llvm.allow_old_toolchain);
1023 check_ci_llvm!(llvm.polly);
1024 check_ci_llvm!(llvm.clang);
1025 check_ci_llvm!(llvm.build_config);
1026 check_ci_llvm!(llvm.plugins);
1029 // NOTE: can never be hit when downloading from CI, since we call `check_ci_llvm!(thin_lto)` above.
1030 if config.llvm_thin_lto && llvm.link_shared.is_none() {
1031 // If we're building with ThinLTO on, by default we want to link
1032 // to LLVM shared, to avoid re-doing ThinLTO (which happens in
1033 // the link step) with each stage.
1034 config.llvm_link_shared.set(Some(true));
1038 if let Some(rust) = toml.rust {
1040 debug_assertions = rust.debug_assertions;
1041 debug_assertions_std = rust.debug_assertions_std;
1042 overflow_checks = rust.overflow_checks;
1043 overflow_checks_std = rust.overflow_checks_std;
1044 debug_logging = rust.debug_logging;
1045 debuginfo_level = rust.debuginfo_level;
1046 debuginfo_level_rustc = rust.debuginfo_level_rustc;
1047 debuginfo_level_std = rust.debuginfo_level_std;
1048 debuginfo_level_tools = rust.debuginfo_level_tools;
1049 debuginfo_level_tests = rust.debuginfo_level_tests;
1050 config.rust_split_debuginfo = rust
1053 .map(SplitDebuginfo::from_str)
1054 .map(|v| v.expect("invalid value for rust.split_debuginfo"))
1055 .unwrap_or(SplitDebuginfo::default_for_platform(&config.build.triple));
1056 optimize = rust.optimize;
1057 ignore_git = rust.ignore_git;
1058 config.rust_new_symbol_mangling = rust.new_symbol_mangling;
1059 set(&mut config.rust_optimize_tests, rust.optimize_tests);
1060 set(&mut config.codegen_tests, rust.codegen_tests);
1061 set(&mut config.rust_rpath, rust.rpath);
1062 set(&mut config.jemalloc, rust.jemalloc);
1063 set(&mut config.test_compare_mode, rust.test_compare_mode);
1064 set(&mut config.backtrace, rust.backtrace);
1065 set(&mut config.channel, rust.channel);
1066 config.description = rust.description;
1067 set(&mut config.rust_dist_src, rust.dist_src);
1068 set(&mut config.verbose_tests, rust.verbose_tests);
1069 // in the case "false" is set explicitly, do not overwrite the command line args
1070 if let Some(true) = rust.incremental {
1071 config.incremental = true;
1073 set(&mut config.use_lld, rust.use_lld);
1074 set(&mut config.lld_enabled, rust.lld);
1075 set(&mut config.llvm_tools_enabled, rust.llvm_tools);
1076 config.rustc_parallel = rust.parallel_compiler.unwrap_or(false);
1077 config.rustc_default_linker = rust.default_linker;
1078 config.musl_root = rust.musl_root.map(PathBuf::from);
1079 config.save_toolstates = rust.save_toolstates.map(PathBuf::from);
1080 set(&mut config.deny_warnings, flags.deny_warnings.or(rust.deny_warnings));
1081 set(&mut config.backtrace_on_ice, rust.backtrace_on_ice);
1082 set(&mut config.rust_verify_llvm_ir, rust.verify_llvm_ir);
1083 config.rust_thin_lto_import_instr_limit = rust.thin_lto_import_instr_limit;
1084 set(&mut config.rust_remap_debuginfo, rust.remap_debuginfo);
1085 set(&mut config.control_flow_guard, rust.control_flow_guard);
1086 config.llvm_libunwind_default = rust
1088 .map(|v| v.parse().expect("failed to parse rust.llvm-libunwind"));
1090 if let Some(ref backends) = rust.codegen_backends {
1091 config.rust_codegen_backends =
1092 backends.iter().map(|s| INTERNER.intern_str(s)).collect();
1095 config.rust_codegen_units = rust.codegen_units.map(threads_from_config);
1096 config.rust_codegen_units_std = rust.codegen_units_std.map(threads_from_config);
1097 config.rust_profile_use = flags.rust_profile_use.or(rust.profile_use);
1098 config.rust_profile_generate = flags.rust_profile_generate.or(rust.profile_generate);
1099 config.download_rustc_commit = download_ci_rustc_commit(&config, rust.download_rustc);
1101 config.rust_profile_use = flags.rust_profile_use;
1102 config.rust_profile_generate = flags.rust_profile_generate;
1105 if let Some(t) = toml.target {
1106 for (triple, cfg) in t {
1107 let mut target = Target::from_triple(&triple);
1109 if let Some(ref s) = cfg.llvm_config {
1110 target.llvm_config = Some(config.src.join(s));
1112 if let Some(ref s) = cfg.llvm_filecheck {
1113 target.llvm_filecheck = Some(config.src.join(s));
1115 target.llvm_libunwind = cfg
1118 .map(|v| v.parse().expect("failed to parse rust.llvm-libunwind"));
1119 if let Some(ref s) = cfg.android_ndk {
1120 target.ndk = Some(config.src.join(s));
1122 if let Some(s) = cfg.no_std {
1125 target.cc = cfg.cc.map(PathBuf::from);
1126 target.cxx = cfg.cxx.map(PathBuf::from);
1127 target.ar = cfg.ar.map(PathBuf::from);
1128 target.ranlib = cfg.ranlib.map(PathBuf::from);
1129 target.linker = cfg.linker.map(PathBuf::from);
1130 target.crt_static = cfg.crt_static;
1131 target.musl_root = cfg.musl_root.map(PathBuf::from);
1132 target.musl_libdir = cfg.musl_libdir.map(PathBuf::from);
1133 target.wasi_root = cfg.wasi_root.map(PathBuf::from);
1134 target.qemu_rootfs = cfg.qemu_rootfs.map(PathBuf::from);
1135 target.sanitizers = cfg.sanitizers;
1136 target.profiler = cfg.profiler;
1138 config.target_config.insert(TargetSelection::from_user(&triple), target);
1142 if config.llvm_from_ci {
1143 let triple = &config.build.triple;
1144 let ci_llvm_bin = config.ci_llvm_root().join("bin");
1145 let mut build_target = config
1147 .entry(config.build)
1148 .or_insert_with(|| Target::from_triple(&triple));
1150 check_ci_llvm!(build_target.llvm_config);
1151 check_ci_llvm!(build_target.llvm_filecheck);
1152 build_target.llvm_config = Some(ci_llvm_bin.join(exe("llvm-config", config.build)));
1153 build_target.llvm_filecheck = Some(ci_llvm_bin.join(exe("FileCheck", config.build)));
1156 if let Some(t) = toml.dist {
1157 config.dist_sign_folder = t.sign_folder.map(PathBuf::from);
1158 config.dist_upload_addr = t.upload_addr;
1159 config.dist_compression_formats = t.compression_formats;
1160 set(&mut config.rust_dist_src, t.src_tarball);
1161 set(&mut config.missing_tools, t.missing_tools);
1164 if let Some(r) = build.rustfmt {
1165 *config.initial_rustfmt.borrow_mut() = if r.exists() {
1166 RustfmtState::SystemToolchain(r)
1168 RustfmtState::Unavailable
1171 // If using a system toolchain for bootstrapping, see if that has rustfmt available.
1172 let host = config.build;
1173 let rustfmt_path = config.initial_rustc.with_file_name(exe("rustfmt", host));
1174 let bin_root = config.out.join(host.triple).join("stage0");
1175 if !rustfmt_path.starts_with(&bin_root) {
1176 // Using a system-provided toolchain; we shouldn't download rustfmt.
1177 *config.initial_rustfmt.borrow_mut() = RustfmtState::SystemToolchain(rustfmt_path);
1181 // Now that we've reached the end of our configuration, infer the
1182 // default values for all options that we haven't otherwise stored yet.
1184 config.llvm_skip_rebuild = llvm_skip_rebuild.unwrap_or(false);
1185 config.llvm_assertions = llvm_assertions.unwrap_or(false);
1186 config.llvm_tests = llvm_tests.unwrap_or(false);
1187 config.llvm_plugins = llvm_plugins.unwrap_or(false);
1188 config.rust_optimize = optimize.unwrap_or(true);
1190 let default = debug == Some(true);
1191 config.rust_debug_assertions = debug_assertions.unwrap_or(default);
1192 config.rust_debug_assertions_std =
1193 debug_assertions_std.unwrap_or(config.rust_debug_assertions);
1194 config.rust_overflow_checks = overflow_checks.unwrap_or(default);
1195 config.rust_overflow_checks_std =
1196 overflow_checks_std.unwrap_or(config.rust_overflow_checks);
1198 config.rust_debug_logging = debug_logging.unwrap_or(config.rust_debug_assertions);
1200 let with_defaults = |debuginfo_level_specific: Option<u32>| {
1201 debuginfo_level_specific.or(debuginfo_level).unwrap_or(if debug == Some(true) {
1207 config.rust_debuginfo_level_rustc = with_defaults(debuginfo_level_rustc);
1208 config.rust_debuginfo_level_std = with_defaults(debuginfo_level_std);
1209 config.rust_debuginfo_level_tools = with_defaults(debuginfo_level_tools);
1210 config.rust_debuginfo_level_tests = debuginfo_level_tests.unwrap_or(0);
1212 let default = config.channel == "dev";
1213 config.ignore_git = ignore_git.unwrap_or(default);
1215 let download_rustc = config.download_rustc_commit.is_some();
1216 // See https://github.com/rust-lang/compiler-team/issues/326
1217 config.stage = match config.cmd {
1218 Subcommand::Check { .. } => flags.stage.or(build.check_stage).unwrap_or(0),
1219 // `download-rustc` only has a speed-up for stage2 builds. Default to stage2 unless explicitly overridden.
1220 Subcommand::Doc { .. } => {
1221 flags.stage.or(build.doc_stage).unwrap_or(if download_rustc { 2 } else { 0 })
1223 Subcommand::Build { .. } => {
1224 flags.stage.or(build.build_stage).unwrap_or(if download_rustc { 2 } else { 1 })
1226 Subcommand::Test { .. } => {
1227 flags.stage.or(build.test_stage).unwrap_or(if download_rustc { 2 } else { 1 })
1229 Subcommand::Bench { .. } => flags.stage.or(build.bench_stage).unwrap_or(2),
1230 Subcommand::Dist { .. } => flags.stage.or(build.dist_stage).unwrap_or(2),
1231 Subcommand::Install { .. } => flags.stage.or(build.install_stage).unwrap_or(2),
1232 // These are all bootstrap tools, which don't depend on the compiler.
1233 // The stage we pass shouldn't matter, but use 0 just in case.
1234 Subcommand::Clean { .. }
1235 | Subcommand::Clippy { .. }
1236 | Subcommand::Fix { .. }
1237 | Subcommand::Run { .. }
1238 | Subcommand::Setup { .. }
1239 | Subcommand::Format { .. } => flags.stage.unwrap_or(0),
1242 // CI should always run stage 2 builds, unless it specifically states otherwise
1244 if flags.stage.is_none() && crate::CiEnv::current() != crate::CiEnv::None {
1246 Subcommand::Test { .. }
1247 | Subcommand::Doc { .. }
1248 | Subcommand::Build { .. }
1249 | Subcommand::Bench { .. }
1250 | Subcommand::Dist { .. }
1251 | Subcommand::Install { .. } => {
1254 "x.py should be run with `--stage 2` on CI, but was run with `--stage {}`",
1258 Subcommand::Clean { .. }
1259 | Subcommand::Check { .. }
1260 | Subcommand::Clippy { .. }
1261 | Subcommand::Fix { .. }
1262 | Subcommand::Run { .. }
1263 | Subcommand::Setup { .. }
1264 | Subcommand::Format { .. } => {}
1271 /// A git invocation which runs inside the source directory.
1273 /// Use this rather than `Command::new("git")` in order to support out-of-tree builds.
1274 pub(crate) fn git(&self) -> Command {
1275 let mut git = Command::new("git");
1276 git.current_dir(&self.src);
1280 pub(crate) fn artifact_channel(&self, commit: &str) -> String {
1281 let mut channel = self.git();
1282 channel.arg("show").arg(format!("{}:src/ci/channel", commit));
1283 let channel = output(&mut channel);
1284 channel.trim().to_owned()
1287 /// Try to find the relative path of `bindir`, otherwise return it in full.
1288 pub fn bindir_relative(&self) -> &Path {
1289 let bindir = &self.bindir;
1290 if bindir.is_absolute() {
1291 // Try to make it relative to the prefix.
1292 if let Some(prefix) = &self.prefix {
1293 if let Ok(stripped) = bindir.strip_prefix(prefix) {
1301 /// Try to find the relative path of `libdir`.
1302 pub fn libdir_relative(&self) -> Option<&Path> {
1303 let libdir = self.libdir.as_ref()?;
1304 if libdir.is_relative() {
1307 // Try to make it relative to the prefix.
1308 libdir.strip_prefix(self.prefix.as_ref()?).ok()
1312 /// The absolute path to the downloaded LLVM artifacts.
1313 pub(crate) fn ci_llvm_root(&self) -> PathBuf {
1314 assert!(self.llvm_from_ci);
1315 self.out.join(&*self.build.triple).join("ci-llvm")
1318 /// Determine whether llvm should be linked dynamically.
1320 /// If `false`, llvm should be linked statically.
1321 /// This is computed on demand since LLVM might have to first be downloaded from CI.
1322 pub(crate) fn llvm_link_shared(builder: &Builder<'_>) -> bool {
1323 let mut opt = builder.config.llvm_link_shared.get();
1324 if opt.is_none() && builder.config.dry_run {
1325 // just assume static for now - dynamic linking isn't supported on all platforms
1329 let llvm_link_shared = *opt.get_or_insert_with(|| {
1330 if builder.config.llvm_from_ci {
1331 crate::native::maybe_download_ci_llvm(builder);
1332 let ci_llvm = builder.config.ci_llvm_root();
1334 std::fs::read_to_string(ci_llvm.join("link-type.txt")),
1335 format!("CI llvm missing: {}", ci_llvm.display())
1337 link_type == "dynamic"
1339 // unclear how thought-through this default is, but it maintains compatibility with
1340 // previous behavior
1344 builder.config.llvm_link_shared.set(opt);
1348 /// Return whether we will use a downloaded, pre-compiled version of rustc, or just build from source.
1349 pub(crate) fn download_rustc(builder: &Builder<'_>) -> bool {
1350 static DOWNLOAD_RUSTC: OnceCell<bool> = OnceCell::new();
1351 if builder.config.dry_run && DOWNLOAD_RUSTC.get().is_none() {
1352 // avoid trying to actually download the commit
1356 *DOWNLOAD_RUSTC.get_or_init(|| match &builder.config.download_rustc_commit {
1359 download_ci_rustc(builder, commit);
1365 pub(crate) fn initial_rustfmt(builder: &Builder<'_>) -> Option<PathBuf> {
1366 match &mut *builder.config.initial_rustfmt.borrow_mut() {
1367 RustfmtState::SystemToolchain(p) | RustfmtState::Downloaded(p) => Some(p.clone()),
1368 RustfmtState::Unavailable => None,
1369 r @ RustfmtState::LazyEvaluated => {
1370 if builder.config.dry_run {
1371 return Some(PathBuf::new());
1373 let path = maybe_download_rustfmt(builder);
1374 *r = if let Some(p) = &path {
1375 RustfmtState::Downloaded(p.clone())
1377 RustfmtState::Unavailable
1384 pub fn verbose(&self) -> bool {
1388 pub fn sanitizers_enabled(&self, target: TargetSelection) -> bool {
1389 self.target_config.get(&target).map(|t| t.sanitizers).flatten().unwrap_or(self.sanitizers)
1392 pub fn any_sanitizers_enabled(&self) -> bool {
1393 self.target_config.values().any(|t| t.sanitizers == Some(true)) || self.sanitizers
1396 pub fn profiler_enabled(&self, target: TargetSelection) -> bool {
1397 self.target_config.get(&target).map(|t| t.profiler).flatten().unwrap_or(self.profiler)
1400 pub fn any_profiler_enabled(&self) -> bool {
1401 self.target_config.values().any(|t| t.profiler == Some(true)) || self.profiler
1404 pub fn llvm_enabled(&self) -> bool {
1405 self.rust_codegen_backends.contains(&INTERNER.intern_str("llvm"))
1408 pub fn llvm_libunwind(&self, target: TargetSelection) -> LlvmLibunwind {
1411 .and_then(|t| t.llvm_libunwind)
1412 .or(self.llvm_libunwind_default)
1413 .unwrap_or(if target.contains("fuchsia") {
1414 LlvmLibunwind::InTree
1420 pub fn submodules(&self, rust_info: &GitInfo) -> bool {
1421 self.submodules.unwrap_or(rust_info.is_git())
1425 fn set<T>(field: &mut T, val: Option<T>) {
1426 if let Some(v) = val {
1431 fn threads_from_config(v: u32) -> u32 {
1433 0 => std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get) as u32,
1438 /// Returns the commit to download, or `None` if we shouldn't download CI artifacts.
1439 fn download_ci_rustc_commit(
1441 download_rustc: Option<StringOrBool>,
1442 ) -> Option<String> {
1443 // If `download-rustc` is not set, default to rebuilding.
1444 let if_unchanged = match download_rustc {
1445 None | Some(StringOrBool::Bool(false)) => return None,
1446 Some(StringOrBool::Bool(true)) => false,
1447 Some(StringOrBool::String(s)) if s == "if-unchanged" => true,
1448 Some(StringOrBool::String(other)) => {
1449 panic!("unrecognized option for download-rustc: {}", other)
1453 // Handle running from a directory other than the top level
1454 let top_level = output(config.git().args(&["rev-parse", "--show-toplevel"]));
1455 let top_level = top_level.trim_end();
1456 let compiler = format!("{top_level}/compiler/");
1457 let library = format!("{top_level}/library/");
1459 // Look for a version to compare to based on the current commit.
1460 // Only commits merged by bors will have CI artifacts.
1461 let merge_base = output(
1465 .arg(format!("--author={}", config.stage0_metadata.config.git_merge_commit_email))
1466 .args(&["-n1", "--first-parent", "HEAD"]),
1468 let commit = merge_base.trim_end();
1469 if commit.is_empty() {
1470 println!("error: could not find commit hash for downloading rustc");
1471 println!("help: maybe your repository history is too shallow?");
1472 println!("help: consider disabling `download-rustc`");
1473 println!("help: or fetch enough history to include one upstream commit");
1474 crate::detail_exit(1);
1477 // Warn if there were changes to the compiler or standard library since the ancestor commit.
1478 let has_changes = !t!(config
1480 .args(&["diff-index", "--quiet", &commit, "--", &compiler, &library])
1485 if config.verbose > 0 {
1487 "warning: saw changes to compiler/ or library/ since {commit}; \
1488 ignoring `download-rustc`"
1494 "warning: `download-rustc` is enabled, but there are changes to \
1495 compiler/ or library/"
1499 Some(commit.to_string())
1502 fn maybe_download_rustfmt(builder: &Builder<'_>) -> Option<PathBuf> {
1503 let RustfmtMetadata { date, version } = builder.config.stage0_metadata.rustfmt.as_ref()?;
1504 let channel = format!("{version}-{date}");
1506 let host = builder.config.build;
1507 let rustfmt_path = builder.config.initial_rustc.with_file_name(exe("rustfmt", host));
1508 let bin_root = builder.config.out.join(host.triple).join("stage0");
1509 let rustfmt_stamp = bin_root.join(".rustfmt-stamp");
1510 if rustfmt_path.exists() && !program_out_of_date(&rustfmt_stamp, &channel) {
1511 return Some(rustfmt_path);
1514 let filename = format!("rustfmt-{version}-{build}.tar.xz", build = host.triple);
1515 download_component(builder, DownloadSource::Dist, filename, "rustfmt-preview", &date, "stage0");
1517 builder.fix_bin_or_dylib(&bin_root.join("bin").join("rustfmt"));
1518 builder.fix_bin_or_dylib(&bin_root.join("bin").join("cargo-fmt"));
1520 builder.create(&rustfmt_stamp, &channel);
1524 fn download_ci_rustc(builder: &Builder<'_>, commit: &str) {
1525 builder.verbose(&format!("using downloaded stage2 artifacts from CI (commit {commit})"));
1526 let channel = builder.config.artifact_channel(commit);
1527 let host = builder.config.build.triple;
1528 let bin_root = builder.out.join(host).join("ci-rustc");
1529 let rustc_stamp = bin_root.join(".rustc-stamp");
1531 if !bin_root.join("bin").join("rustc").exists() || program_out_of_date(&rustc_stamp, commit) {
1532 if bin_root.exists() {
1533 t!(fs::remove_dir_all(&bin_root));
1535 let filename = format!("rust-std-{channel}-{host}.tar.xz");
1536 let pattern = format!("rust-std-{host}");
1537 download_ci_component(builder, filename, &pattern, commit);
1538 let filename = format!("rustc-{channel}-{host}.tar.xz");
1539 download_ci_component(builder, filename, "rustc", commit);
1540 // download-rustc doesn't need its own cargo, it can just use beta's.
1541 let filename = format!("rustc-dev-{channel}-{host}.tar.xz");
1542 download_ci_component(builder, filename, "rustc-dev", commit);
1544 builder.fix_bin_or_dylib(&bin_root.join("bin").join("rustc"));
1545 builder.fix_bin_or_dylib(&bin_root.join("bin").join("rustdoc"));
1546 let lib_dir = bin_root.join("lib");
1547 for lib in t!(fs::read_dir(&lib_dir), lib_dir.display().to_string()) {
1549 if lib.path().extension() == Some(OsStr::new("so")) {
1550 builder.fix_bin_or_dylib(&lib.path());
1553 t!(fs::write(rustc_stamp, commit));
1557 pub(crate) enum DownloadSource {
1562 /// Download a single component of a CI-built toolchain (not necessarily a published nightly).
1563 // NOTE: intentionally takes an owned string to avoid downloading multiple times by accident
1564 fn download_ci_component(builder: &Builder<'_>, filename: String, prefix: &str, commit: &str) {
1565 download_component(builder, DownloadSource::CI, filename, prefix, commit, "ci-rustc")
1568 fn download_component(
1569 builder: &Builder<'_>,
1570 mode: DownloadSource,
1576 let cache_dst = builder.out.join("cache");
1577 let cache_dir = cache_dst.join(key);
1578 if !cache_dir.exists() {
1579 t!(fs::create_dir_all(&cache_dir));
1582 let bin_root = builder.out.join(builder.config.build.triple).join(destination);
1583 let tarball = cache_dir.join(&filename);
1584 let (base_url, url, should_verify) = match mode {
1585 DownloadSource::CI => (
1586 builder.config.stage0_metadata.config.artifacts_server.clone(),
1587 format!("{key}/{filename}"),
1590 DownloadSource::Dist => {
1591 let dist_server = env::var("RUSTUP_DIST_SERVER")
1592 .unwrap_or(builder.config.stage0_metadata.config.dist_server.to_string());
1593 // NOTE: make `dist` part of the URL because that's how it's stored in src/stage0.json
1594 (dist_server, format!("dist/{key}/{filename}"), true)
1598 // For the beta compiler, put special effort into ensuring the checksums are valid.
1599 // FIXME: maybe we should do this for download-rustc as well? but it would be a pain to update
1600 // this on each and every nightly ...
1601 let checksum = if should_verify {
1602 let error = format!(
1603 "src/stage0.json doesn't contain a checksum for {url}. \
1604 Pre-built artifacts might not be available for this \
1605 target at this time, see https://doc.rust-lang.org/nightly\
1606 /rustc/platform-support.html for more information."
1608 let sha256 = builder.config.stage0_metadata.checksums_sha256.get(&url).expect(&error);
1609 if tarball.exists() {
1610 if builder.verify(&tarball, sha256) {
1611 builder.unpack(&tarball, &bin_root, prefix);
1614 builder.verbose(&format!(
1615 "ignoring cached file {} due to failed verification",
1618 builder.remove(&tarball);
1622 } else if tarball.exists() {
1623 builder.unpack(&tarball, &bin_root, prefix);
1629 builder.download_component(&format!("{base_url}/{url}"), &tarball, "");
1630 if let Some(sha256) = checksum {
1631 if !builder.verify(&tarball, sha256) {
1632 panic!("failed to verify {}", tarball.display());
1636 builder.unpack(&tarball, &bin_root, prefix);