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};
12 use std::path::{Path, PathBuf};
13 use std::process::Command;
14 use std::str::FromStr;
16 use crate::builder::TaskPath;
17 use crate::cache::{Interned, INTERNER};
18 use crate::channel::{self, GitInfo};
19 pub use crate::flags::Subcommand;
20 use crate::flags::{Color, Flags};
21 use crate::util::{exe, output, t};
22 use once_cell::sync::OnceCell;
23 use serde::{Deserialize, Deserializer};
25 macro_rules! check_ci_llvm {
29 "setting {} is incompatible with download-ci-llvm.",
35 #[derive(Clone, Default)]
37 /// This isn't a dry run.
40 /// This is a dry run enabled by bootstrap itself, so it can verify that no work is done.
42 /// This is a dry run enabled by the `--dry-run` flag.
46 /// Global configuration for the entire build and/or bootstrap.
48 /// This structure is derived from a combination of both `config.toml` and
49 /// `config.mk`. As of the time of this writing it's unlikely that `config.toml`
50 /// is used all that much, so this is primarily filled out by `config.mk` which
51 /// is generated from `./configure`.
53 /// Note that this structure is not decoded directly into, but rather it is
54 /// filled out from the decoded forms of the structs below. For documentation
55 /// each field, see the corresponding fields in
56 /// `config.toml.example`.
58 #[cfg_attr(test, derive(Clone))]
60 pub changelog_seen: Option<usize>,
61 pub ccache: Option<String>,
62 /// Call Build::ninja() instead of this.
63 pub ninja_in_file: bool,
65 pub submodules: Option<bool>,
66 pub compiler_docs: bool,
67 pub docs_minification: bool,
69 pub locked_deps: bool,
71 pub target_config: HashMap<TargetSelection, Target>,
72 pub full_bootstrap: bool,
74 pub tools: Option<HashSet<String>>,
78 pub exclude: Vec<TaskPath>,
79 pub include_default_paths: bool,
80 pub rustc_error_format: Option<String>,
81 pub json_output: bool,
82 pub test_compare_mode: bool,
84 pub patch_binaries_for_nix: bool,
85 pub stage0_metadata: Stage0Metadata,
87 pub on_fail: Option<String>,
89 pub keep_stage: Vec<u32>,
90 pub keep_stage_std: Vec<u32>,
92 /// defaults to `config.toml`
93 pub config: Option<PathBuf>,
94 pub jobs: Option<u32>,
96 pub incremental: bool,
98 /// `None` if we shouldn't download CI compiler artifacts, or the commit to download if we should.
100 download_rustc_commit: Option<String>,
102 pub download_rustc_commit: Option<String>,
104 pub deny_warnings: bool,
105 pub backtrace_on_ice: bool,
107 // llvm codegen options
108 pub llvm_skip_rebuild: bool,
109 pub llvm_assertions: bool,
110 pub llvm_tests: bool,
111 pub llvm_plugins: bool,
112 pub llvm_optimize: bool,
113 pub llvm_thin_lto: bool,
114 pub llvm_release_debuginfo: bool,
115 pub llvm_version_check: bool,
116 pub llvm_static_stdcpp: bool,
117 /// `None` if `llvm_from_ci` is true and we haven't yet downloaded llvm.
119 llvm_link_shared: Cell<Option<bool>>,
121 pub llvm_link_shared: Cell<Option<bool>>,
122 pub llvm_clang_cl: Option<String>,
123 pub llvm_targets: Option<String>,
124 pub llvm_experimental_targets: Option<String>,
125 pub llvm_link_jobs: Option<u32>,
126 pub llvm_version_suffix: Option<String>,
127 pub llvm_use_linker: Option<String>,
128 pub llvm_allow_old_toolchain: bool,
129 pub llvm_polly: bool,
130 pub llvm_clang: bool,
131 pub llvm_from_ci: bool,
132 pub llvm_build_config: HashMap<String, String>,
135 pub lld_enabled: bool,
136 pub llvm_tools_enabled: bool,
138 pub llvm_cflags: Option<String>,
139 pub llvm_cxxflags: Option<String>,
140 pub llvm_ldflags: Option<String>,
141 pub llvm_use_libcxx: bool,
143 // rust codegen options
144 pub rust_optimize: bool,
145 pub rust_codegen_units: Option<u32>,
146 pub rust_codegen_units_std: Option<u32>,
147 pub rust_debug_assertions: bool,
148 pub rust_debug_assertions_std: bool,
149 pub rust_overflow_checks: bool,
150 pub rust_overflow_checks_std: bool,
151 pub rust_debug_logging: bool,
152 pub rust_debuginfo_level_rustc: u32,
153 pub rust_debuginfo_level_std: u32,
154 pub rust_debuginfo_level_tools: u32,
155 pub rust_debuginfo_level_tests: u32,
156 pub rust_split_debuginfo: SplitDebuginfo,
157 pub rust_rpath: bool,
158 pub rustc_parallel: bool,
159 pub rustc_default_linker: Option<String>,
160 pub rust_optimize_tests: bool,
161 pub rust_dist_src: bool,
162 pub rust_codegen_backends: Vec<Interned<String>>,
163 pub rust_verify_llvm_ir: bool,
164 pub rust_thin_lto_import_instr_limit: Option<u32>,
165 pub rust_remap_debuginfo: bool,
166 pub rust_new_symbol_mangling: Option<bool>,
167 pub rust_profile_use: Option<String>,
168 pub rust_profile_generate: Option<String>,
169 pub rust_lto: RustcLto,
170 pub llvm_profile_use: Option<String>,
171 pub llvm_profile_generate: bool,
172 pub llvm_libunwind_default: Option<LlvmLibunwind>,
173 pub llvm_bolt_profile_generate: bool,
174 pub llvm_bolt_profile_use: Option<String>,
176 pub build: TargetSelection,
177 pub hosts: Vec<TargetSelection>,
178 pub targets: Vec<TargetSelection>,
179 pub local_rebuild: bool,
181 pub control_flow_guard: bool,
184 pub dist_sign_folder: Option<PathBuf>,
185 pub dist_upload_addr: Option<String>,
186 pub dist_compression_formats: Option<Vec<String>>,
189 pub backtrace: bool, // support for RUST_BACKTRACE
192 pub low_priority: bool,
194 pub description: Option<String>,
195 pub verbose_tests: bool,
196 pub save_toolstates: Option<PathBuf>,
197 pub print_step_timings: bool,
198 pub print_step_rusage: bool,
199 pub missing_tools: bool,
201 // Fallback musl-root for all targets
202 pub musl_root: Option<PathBuf>,
203 pub prefix: Option<PathBuf>,
204 pub sysconfdir: Option<PathBuf>,
205 pub datadir: Option<PathBuf>,
206 pub docdir: Option<PathBuf>,
208 pub libdir: Option<PathBuf>,
209 pub mandir: Option<PathBuf>,
210 pub codegen_tests: bool,
211 pub nodejs: Option<PathBuf>,
212 pub npm: Option<PathBuf>,
213 pub gdb: Option<PathBuf>,
214 pub python: Option<PathBuf>,
215 pub reuse: Option<PathBuf>,
216 pub cargo_native_static: bool,
217 pub configure_args: Vec<String>,
219 // These are either the stage0 downloaded binaries or the locally installed ones.
220 pub initial_cargo: PathBuf,
221 pub initial_rustc: PathBuf,
223 initial_rustfmt: RefCell<RustfmtState>,
225 pub initial_rustfmt: RefCell<RustfmtState>,
227 pub rust_info: channel::GitInfo,
230 #[derive(Default, Deserialize)]
231 #[cfg_attr(test, derive(Clone))]
232 pub struct Stage0Metadata {
233 pub config: Stage0Config,
234 pub checksums_sha256: HashMap<String, String>,
235 pub rustfmt: Option<RustfmtMetadata>,
237 #[derive(Default, Deserialize)]
238 #[cfg_attr(test, derive(Clone))]
239 pub struct Stage0Config {
240 pub dist_server: String,
241 pub artifacts_server: String,
242 pub artifacts_with_llvm_assertions_server: String,
243 pub git_merge_commit_email: String,
244 pub nightly_branch: String,
246 #[derive(Default, Deserialize)]
247 #[cfg_attr(test, derive(Clone))]
248 pub struct RustfmtMetadata {
253 #[derive(Clone, Debug)]
254 pub enum RustfmtState {
255 SystemToolchain(PathBuf),
261 impl Default for RustfmtState {
262 fn default() -> Self {
263 RustfmtState::LazyEvaluated
267 #[derive(Debug, Clone, Copy, PartialEq)]
268 pub enum LlvmLibunwind {
274 impl Default for LlvmLibunwind {
275 fn default() -> Self {
280 impl FromStr for LlvmLibunwind {
283 fn from_str(value: &str) -> Result<Self, Self::Err> {
285 "no" => Ok(Self::No),
286 "in-tree" => Ok(Self::InTree),
287 "system" => Ok(Self::System),
288 invalid => Err(format!("Invalid value '{}' for rust.llvm-libunwind config.", invalid)),
293 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
294 pub enum SplitDebuginfo {
300 impl Default for SplitDebuginfo {
301 fn default() -> Self {
306 impl std::str::FromStr for SplitDebuginfo {
309 fn from_str(s: &str) -> Result<Self, Self::Err> {
311 "packed" => Ok(SplitDebuginfo::Packed),
312 "unpacked" => Ok(SplitDebuginfo::Unpacked),
313 "off" => Ok(SplitDebuginfo::Off),
319 impl SplitDebuginfo {
320 /// Returns the default `-Csplit-debuginfo` value for the current target. See the comment for
321 /// `rust.split-debuginfo` in `config.toml.example`.
322 fn default_for_platform(target: &str) -> Self {
323 if target.contains("apple") {
324 SplitDebuginfo::Unpacked
325 } else if target.contains("windows") {
326 SplitDebuginfo::Packed
333 /// LTO mode used for compiling rustc itself.
334 #[derive(Default, Clone)]
342 impl std::str::FromStr for RustcLto {
345 fn from_str(s: &str) -> Result<Self, Self::Err> {
347 "thin-local" => Ok(RustcLto::ThinLocal),
348 "thin" => Ok(RustcLto::Thin),
349 "fat" => Ok(RustcLto::Fat),
350 _ => Err(format!("Invalid value for rustc LTO: {}", s)),
355 #[derive(Copy, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
356 pub struct TargetSelection {
357 pub triple: Interned<String>,
358 file: Option<Interned<String>>,
361 impl TargetSelection {
362 pub fn from_user(selection: &str) -> Self {
363 let path = Path::new(selection);
365 let (triple, file) = if path.exists() {
368 .expect("Target specification file has no file stem")
370 .expect("Target specification file stem is not UTF-8");
372 (triple, Some(selection))
377 let triple = INTERNER.intern_str(triple);
378 let file = file.map(|f| INTERNER.intern_str(f));
380 Self { triple, file }
383 pub fn rustc_target_arg(&self) -> &str {
384 self.file.as_ref().unwrap_or(&self.triple)
387 pub fn contains(&self, needle: &str) -> bool {
388 self.triple.contains(needle)
391 pub fn starts_with(&self, needle: &str) -> bool {
392 self.triple.starts_with(needle)
395 pub fn ends_with(&self, needle: &str) -> bool {
396 self.triple.ends_with(needle)
400 impl fmt::Display for TargetSelection {
401 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
402 write!(f, "{}", self.triple)?;
403 if let Some(file) = self.file {
404 write!(f, "({})", file)?;
410 impl fmt::Debug for TargetSelection {
411 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
412 write!(f, "{}", self)
416 impl PartialEq<&str> for TargetSelection {
417 fn eq(&self, other: &&str) -> bool {
418 self.triple == *other
422 /// Per-target configuration stored in the global configuration structure.
424 #[cfg_attr(test, derive(Clone))]
426 /// Some(path to llvm-config) if using an external LLVM.
427 pub llvm_config: Option<PathBuf>,
428 pub llvm_has_rust_patches: Option<bool>,
429 /// Some(path to FileCheck) if one was specified.
430 pub llvm_filecheck: Option<PathBuf>,
431 pub llvm_libunwind: Option<LlvmLibunwind>,
432 pub cc: Option<PathBuf>,
433 pub cxx: Option<PathBuf>,
434 pub ar: Option<PathBuf>,
435 pub ranlib: Option<PathBuf>,
436 pub default_linker: Option<PathBuf>,
437 pub linker: Option<PathBuf>,
438 pub ndk: Option<PathBuf>,
439 pub sanitizers: Option<bool>,
440 pub profiler: Option<bool>,
441 pub crt_static: Option<bool>,
442 pub musl_root: Option<PathBuf>,
443 pub musl_libdir: Option<PathBuf>,
444 pub wasi_root: Option<PathBuf>,
445 pub qemu_rootfs: Option<PathBuf>,
450 pub fn from_triple(triple: &str) -> Self {
451 let mut target: Self = Default::default();
452 if triple.contains("-none")
453 || triple.contains("nvptx")
454 || triple.contains("switch")
455 || triple.contains("-uefi")
457 target.no_std = true;
462 /// Structure of the `config.toml` file that configuration is read from.
464 /// This structure uses `Decodable` to automatically decode a TOML configuration
465 /// file into this format, and then this is traversed and written into the above
466 /// `Config` structure.
467 #[derive(Deserialize, Default)]
468 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
470 changelog_seen: Option<usize>,
471 build: Option<Build>,
472 install: Option<Install>,
475 target: Option<HashMap<String, TomlTarget>>,
477 profile: Option<String>,
481 fn merge(&mut self, other: Self);
484 impl Merge for TomlConfig {
487 TomlConfig { build, install, llvm, rust, dist, target, profile: _, changelog_seen: _ }: Self,
489 fn do_merge<T: Merge>(x: &mut Option<T>, y: Option<T>) {
490 if let Some(new) = y {
491 if let Some(original) = x {
498 do_merge(&mut self.build, build);
499 do_merge(&mut self.install, install);
500 do_merge(&mut self.llvm, llvm);
501 do_merge(&mut self.rust, rust);
502 do_merge(&mut self.dist, dist);
503 assert!(target.is_none(), "merging target-specific config is not currently supported");
507 // We are using a decl macro instead of a derive proc macro here to reduce the compile time of
509 macro_rules! define_config {
510 ($(#[$attr:meta])* struct $name:ident {
511 $($field:ident: Option<$field_ty:ty> = $field_key:literal,)*
515 $($field: Option<$field_ty>,)*
518 impl Merge for $name {
519 fn merge(&mut self, other: Self) {
521 if !self.$field.is_some() {
522 self.$field = other.$field;
528 // The following is a trimmed version of what serde_derive generates. All parts not relevant
529 // for toml deserialization have been removed. This reduces the binary size and improves
530 // compile time of rustbuild.
531 impl<'de> Deserialize<'de> for $name {
532 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
534 D: Deserializer<'de>,
537 impl<'de> serde::de::Visitor<'de> for Field {
539 fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
540 f.write_str(concat!("struct ", stringify!($name)))
544 fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error>
546 A: serde::de::MapAccess<'de>,
548 $(let mut $field: Option<$field_ty> = None;)*
549 while let Some(key) =
550 match serde::de::MapAccess::next_key::<String>(&mut map) {
559 if $field.is_some() {
560 return Err(<A::Error as serde::de::Error>::duplicate_field(
564 $field = match serde::de::MapAccess::next_value::<$field_ty>(
567 Ok(val) => Some(val),
574 return Err(serde::de::Error::unknown_field(key, FIELDS));
578 Ok($name { $($field),* })
581 const FIELDS: &'static [&'static str] = &[
584 Deserializer::deserialize_struct(
596 /// TOML representation of various global build decisions.
599 build: Option<String> = "build",
600 host: Option<Vec<String>> = "host",
601 target: Option<Vec<String>> = "target",
602 build_dir: Option<String> = "build-dir",
603 cargo: Option<String> = "cargo",
604 rustc: Option<String> = "rustc",
605 rustfmt: Option<PathBuf> = "rustfmt",
606 docs: Option<bool> = "docs",
607 compiler_docs: Option<bool> = "compiler-docs",
608 docs_minification: Option<bool> = "docs-minification",
609 submodules: Option<bool> = "submodules",
610 gdb: Option<String> = "gdb",
611 nodejs: Option<String> = "nodejs",
612 npm: Option<String> = "npm",
613 python: Option<String> = "python",
614 reuse: Option<String> = "reuse",
615 locked_deps: Option<bool> = "locked-deps",
616 vendor: Option<bool> = "vendor",
617 full_bootstrap: Option<bool> = "full-bootstrap",
618 extended: Option<bool> = "extended",
619 tools: Option<HashSet<String>> = "tools",
620 verbose: Option<usize> = "verbose",
621 sanitizers: Option<bool> = "sanitizers",
622 profiler: Option<bool> = "profiler",
623 cargo_native_static: Option<bool> = "cargo-native-static",
624 low_priority: Option<bool> = "low-priority",
625 configure_args: Option<Vec<String>> = "configure-args",
626 local_rebuild: Option<bool> = "local-rebuild",
627 print_step_timings: Option<bool> = "print-step-timings",
628 print_step_rusage: Option<bool> = "print-step-rusage",
629 check_stage: Option<u32> = "check-stage",
630 doc_stage: Option<u32> = "doc-stage",
631 build_stage: Option<u32> = "build-stage",
632 test_stage: Option<u32> = "test-stage",
633 install_stage: Option<u32> = "install-stage",
634 dist_stage: Option<u32> = "dist-stage",
635 bench_stage: Option<u32> = "bench-stage",
636 patch_binaries_for_nix: Option<bool> = "patch-binaries-for-nix",
637 metrics: Option<bool> = "metrics",
642 /// TOML representation of various global install decisions.
644 prefix: Option<String> = "prefix",
645 sysconfdir: Option<String> = "sysconfdir",
646 docdir: Option<String> = "docdir",
647 bindir: Option<String> = "bindir",
648 libdir: Option<String> = "libdir",
649 mandir: Option<String> = "mandir",
650 datadir: Option<String> = "datadir",
655 /// TOML representation of how the LLVM build is configured.
657 skip_rebuild: Option<bool> = "skip-rebuild",
658 optimize: Option<bool> = "optimize",
659 thin_lto: Option<bool> = "thin-lto",
660 release_debuginfo: Option<bool> = "release-debuginfo",
661 assertions: Option<bool> = "assertions",
662 tests: Option<bool> = "tests",
663 plugins: Option<bool> = "plugins",
664 ccache: Option<StringOrBool> = "ccache",
665 version_check: Option<bool> = "version-check",
666 static_libstdcpp: Option<bool> = "static-libstdcpp",
667 ninja: Option<bool> = "ninja",
668 targets: Option<String> = "targets",
669 experimental_targets: Option<String> = "experimental-targets",
670 link_jobs: Option<u32> = "link-jobs",
671 link_shared: Option<bool> = "link-shared",
672 version_suffix: Option<String> = "version-suffix",
673 clang_cl: Option<String> = "clang-cl",
674 cflags: Option<String> = "cflags",
675 cxxflags: Option<String> = "cxxflags",
676 ldflags: Option<String> = "ldflags",
677 use_libcxx: Option<bool> = "use-libcxx",
678 use_linker: Option<String> = "use-linker",
679 allow_old_toolchain: Option<bool> = "allow-old-toolchain",
680 polly: Option<bool> = "polly",
681 clang: Option<bool> = "clang",
682 download_ci_llvm: Option<StringOrBool> = "download-ci-llvm",
683 build_config: Option<HashMap<String, String>> = "build-config",
689 sign_folder: Option<String> = "sign-folder",
690 gpg_password_file: Option<String> = "gpg-password-file",
691 upload_addr: Option<String> = "upload-addr",
692 src_tarball: Option<bool> = "src-tarball",
693 missing_tools: Option<bool> = "missing-tools",
694 compression_formats: Option<Vec<String>> = "compression-formats",
698 #[derive(Deserialize)]
705 impl Default for StringOrBool {
706 fn default() -> StringOrBool {
707 StringOrBool::Bool(false)
712 /// TOML representation of how the Rust build is configured.
714 optimize: Option<bool> = "optimize",
715 debug: Option<bool> = "debug",
716 codegen_units: Option<u32> = "codegen-units",
717 codegen_units_std: Option<u32> = "codegen-units-std",
718 debug_assertions: Option<bool> = "debug-assertions",
719 debug_assertions_std: Option<bool> = "debug-assertions-std",
720 overflow_checks: Option<bool> = "overflow-checks",
721 overflow_checks_std: Option<bool> = "overflow-checks-std",
722 debug_logging: Option<bool> = "debug-logging",
723 debuginfo_level: Option<u32> = "debuginfo-level",
724 debuginfo_level_rustc: Option<u32> = "debuginfo-level-rustc",
725 debuginfo_level_std: Option<u32> = "debuginfo-level-std",
726 debuginfo_level_tools: Option<u32> = "debuginfo-level-tools",
727 debuginfo_level_tests: Option<u32> = "debuginfo-level-tests",
728 split_debuginfo: Option<String> = "split-debuginfo",
729 run_dsymutil: Option<bool> = "run-dsymutil",
730 backtrace: Option<bool> = "backtrace",
731 incremental: Option<bool> = "incremental",
732 parallel_compiler: Option<bool> = "parallel-compiler",
733 default_linker: Option<String> = "default-linker",
734 channel: Option<String> = "channel",
735 description: Option<String> = "description",
736 musl_root: Option<String> = "musl-root",
737 rpath: Option<bool> = "rpath",
738 verbose_tests: Option<bool> = "verbose-tests",
739 optimize_tests: Option<bool> = "optimize-tests",
740 codegen_tests: Option<bool> = "codegen-tests",
741 ignore_git: Option<bool> = "ignore-git",
742 dist_src: Option<bool> = "dist-src",
743 save_toolstates: Option<String> = "save-toolstates",
744 codegen_backends: Option<Vec<String>> = "codegen-backends",
745 lld: Option<bool> = "lld",
746 use_lld: Option<bool> = "use-lld",
747 llvm_tools: Option<bool> = "llvm-tools",
748 deny_warnings: Option<bool> = "deny-warnings",
749 backtrace_on_ice: Option<bool> = "backtrace-on-ice",
750 verify_llvm_ir: Option<bool> = "verify-llvm-ir",
751 thin_lto_import_instr_limit: Option<u32> = "thin-lto-import-instr-limit",
752 remap_debuginfo: Option<bool> = "remap-debuginfo",
753 jemalloc: Option<bool> = "jemalloc",
754 test_compare_mode: Option<bool> = "test-compare-mode",
755 llvm_libunwind: Option<String> = "llvm-libunwind",
756 control_flow_guard: Option<bool> = "control-flow-guard",
757 new_symbol_mangling: Option<bool> = "new-symbol-mangling",
758 profile_generate: Option<String> = "profile-generate",
759 profile_use: Option<String> = "profile-use",
760 // ignored; this is set from an env var set by bootstrap.py
761 download_rustc: Option<StringOrBool> = "download-rustc",
762 lto: Option<String> = "lto",
767 /// TOML representation of how each build target is configured.
769 cc: Option<String> = "cc",
770 cxx: Option<String> = "cxx",
771 ar: Option<String> = "ar",
772 ranlib: Option<String> = "ranlib",
773 default_linker: Option<PathBuf> = "default-linker",
774 linker: Option<String> = "linker",
775 llvm_config: Option<String> = "llvm-config",
776 llvm_has_rust_patches: Option<bool> = "llvm-has-rust-patches",
777 llvm_filecheck: Option<String> = "llvm-filecheck",
778 llvm_libunwind: Option<String> = "llvm-libunwind",
779 android_ndk: Option<String> = "android-ndk",
780 sanitizers: Option<bool> = "sanitizers",
781 profiler: Option<bool> = "profiler",
782 crt_static: Option<bool> = "crt-static",
783 musl_root: Option<String> = "musl-root",
784 musl_libdir: Option<String> = "musl-libdir",
785 wasi_root: Option<String> = "wasi-root",
786 qemu_rootfs: Option<String> = "qemu-rootfs",
787 no_std: Option<bool> = "no-std",
792 pub fn default_opts() -> Config {
793 let mut config = Config::default();
794 config.llvm_optimize = true;
795 config.ninja_in_file = true;
796 config.llvm_version_check = true;
797 config.llvm_static_stdcpp = false;
798 config.backtrace = true;
799 config.rust_optimize = true;
800 config.rust_optimize_tests = true;
801 config.submodules = None;
803 config.docs_minification = true;
804 config.rust_rpath = true;
805 config.channel = "dev".to_string();
806 config.codegen_tests = true;
807 config.rust_dist_src = true;
808 config.rust_codegen_backends = vec![INTERNER.intern_str("llvm")];
809 config.deny_warnings = true;
810 config.bindir = "bin".into();
813 config.build = TargetSelection::from_user(&env!("BUILD_TRIPLE"));
815 let manifest_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
816 // Undo `src/bootstrap`
817 config.src = manifest_dir.parent().unwrap().parent().unwrap().to_owned();
818 config.out = PathBuf::from("build");
823 pub fn parse(args: &[String]) -> Config {
824 let flags = Flags::parse(&args);
825 let mut config = Config::default_opts();
828 config.exclude = flags.exclude.into_iter().map(|path| TaskPath::parse(path)).collect();
829 config.include_default_paths = flags.include_default_paths;
830 config.rustc_error_format = flags.rustc_error_format;
831 config.json_output = flags.json_output;
832 config.on_fail = flags.on_fail;
833 config.jobs = flags.jobs.map(threads_from_config);
834 config.cmd = flags.cmd;
835 config.incremental = flags.incremental;
836 config.dry_run = if flags.dry_run { DryRun::UserSelected } else { DryRun::Disabled };
837 config.keep_stage = flags.keep_stage;
838 config.keep_stage_std = flags.keep_stage_std;
839 config.color = flags.color;
840 if let Some(value) = flags.deny_warnings {
841 config.deny_warnings = value;
843 config.llvm_profile_use = flags.llvm_profile_use;
844 config.llvm_profile_generate = flags.llvm_profile_generate;
845 config.llvm_bolt_profile_generate = flags.llvm_bolt_profile_generate;
846 config.llvm_bolt_profile_use = flags.llvm_bolt_profile_use;
848 if config.llvm_bolt_profile_generate && config.llvm_bolt_profile_use.is_some() {
850 "Cannot use both `llvm_bolt_profile_generate` and `llvm_bolt_profile_use` at the same time"
852 crate::detail_exit(1);
855 // Infer the rest of the configuration.
857 // Infer the source directory. This is non-trivial because we want to support a downloaded bootstrap binary,
858 // running on a completely machine from where it was compiled.
859 let mut cmd = Command::new("git");
860 // NOTE: we cannot support running from outside the repository because the only path we have available
861 // is set at compile time, which can be wrong if bootstrap was downloaded from source.
862 // We still support running outside the repository if we find we aren't in a git directory.
863 cmd.arg("rev-parse").arg("--show-toplevel");
864 // Discard stderr because we expect this to fail when building from a tarball.
866 .stderr(std::process::Stdio::null())
869 .and_then(|output| if output.status.success() { Some(output) } else { None });
870 if let Some(output) = output {
871 let git_root = String::from_utf8(output.stdout).unwrap();
872 // We need to canonicalize this path to make sure it uses backslashes instead of forward slashes.
873 let git_root = PathBuf::from(git_root.trim()).canonicalize().unwrap();
874 let s = git_root.to_str().unwrap();
876 // Bootstrap is quite bad at handling /? in front of paths
877 let src = match s.strip_prefix("\\\\?\\") {
878 Some(p) => PathBuf::from(p),
879 None => PathBuf::from(git_root),
881 // If this doesn't have at least `stage0.json`, we guessed wrong. This can happen when,
882 // for example, the build directory is inside of another unrelated git directory.
883 // In that case keep the original `CARGO_MANIFEST_DIR` handling.
885 // NOTE: this implies that downloadable bootstrap isn't supported when the build directory is outside
886 // the source directory. We could fix that by setting a variable from all three of python, ./x, and x.ps1.
887 if src.join("src").join("stage0.json").exists() {
891 // We're building from a tarball, not git sources.
892 // We don't support pre-downloaded bootstrap in this case.
896 // Use the build directory of the original x.py invocation, so that we can set `initial_rustc` properly.
897 config.out = Path::new(
898 &env::var_os("CARGO_TARGET_DIR").expect("cargo test directly is not supported"),
905 let stage0_json = t!(std::fs::read(&config.src.join("src").join("stage0.json")));
907 config.stage0_metadata = t!(serde_json::from_slice::<Stage0Metadata>(&stage0_json));
910 let get_toml = |_| TomlConfig::default();
912 let get_toml = |file: &Path| {
914 t!(fs::read_to_string(file), format!("config file {} not found", file.display()));
915 // Deserialize to Value and then TomlConfig to prevent the Deserialize impl of
916 // TomlConfig and sub types to be monomorphized 5x by toml.
917 match toml::from_str(&contents)
918 .and_then(|table: toml::Value| TomlConfig::deserialize(table))
922 eprintln!("failed to parse TOML configuration '{}': {}", file.display(), err);
923 crate::detail_exit(2);
928 // Read from `--config`, then `RUST_BOOTSTRAP_CONFIG`, then `./config.toml`, then `config.toml` in the root directory.
929 let toml_path = flags
932 .or_else(|| env::var_os("RUST_BOOTSTRAP_CONFIG").map(PathBuf::from));
933 let using_default_path = toml_path.is_none();
934 let mut toml_path = toml_path.unwrap_or_else(|| PathBuf::from("config.toml"));
935 if using_default_path && !toml_path.exists() {
936 toml_path = config.src.join(toml_path);
939 // Give a hard error if `--config` or `RUST_BOOTSTRAP_CONFIG` are set to a missing path,
940 // but not if `config.toml` hasn't been created.
941 let mut toml = if !using_default_path || toml_path.exists() {
942 config.config = Some(toml_path.clone());
945 config.config = None;
946 TomlConfig::default()
949 if let Some(include) = &toml.profile {
950 let mut include_path = config.src.clone();
951 include_path.push("src");
952 include_path.push("bootstrap");
953 include_path.push("defaults");
954 include_path.push(format!("config.{}.toml", include));
955 let included_toml = get_toml(&include_path);
956 toml.merge(included_toml);
959 config.changelog_seen = toml.changelog_seen;
961 let build = toml.build.unwrap_or_default();
963 set(&mut config.out, flags.build_dir.or_else(|| build.build_dir.map(PathBuf::from)));
964 // NOTE: Bootstrap spawns various commands with different working directories.
965 // To avoid writing to random places on the file system, `config.out` needs to be an absolute path.
966 if !config.out.is_absolute() {
967 // `canonicalize` requires the path to already exist. Use our vendored copy of `absolute` instead.
968 config.out = crate::util::absolute(&config.out);
971 config.initial_rustc = build
974 .unwrap_or_else(|| config.out.join(config.build.triple).join("stage0/bin/rustc"));
975 config.initial_cargo = build
978 .unwrap_or_else(|| config.out.join(config.build.triple).join("stage0/bin/cargo"));
980 // NOTE: it's important this comes *after* we set `initial_rustc` just above.
981 if config.dry_run() {
982 let dir = config.out.join("tmp-dry-run");
983 t!(fs::create_dir_all(&dir));
987 config.hosts = if let Some(arg_host) = flags.host {
989 } else if let Some(file_host) = build.host {
990 file_host.iter().map(|h| TargetSelection::from_user(h)).collect()
994 config.targets = if let Some(arg_target) = flags.target {
996 } else if let Some(file_target) = build.target {
997 file_target.iter().map(|h| TargetSelection::from_user(h)).collect()
999 // If target is *not* configured, then default to the host
1001 config.hosts.clone()
1004 config.nodejs = build.nodejs.map(PathBuf::from);
1005 config.npm = build.npm.map(PathBuf::from);
1006 config.gdb = build.gdb.map(PathBuf::from);
1007 config.python = build.python.map(PathBuf::from);
1008 config.reuse = build.reuse.map(PathBuf::from);
1009 config.submodules = build.submodules;
1010 set(&mut config.low_priority, build.low_priority);
1011 set(&mut config.compiler_docs, build.compiler_docs);
1012 set(&mut config.docs_minification, build.docs_minification);
1013 set(&mut config.docs, build.docs);
1014 set(&mut config.locked_deps, build.locked_deps);
1015 set(&mut config.vendor, build.vendor);
1016 set(&mut config.full_bootstrap, build.full_bootstrap);
1017 set(&mut config.extended, build.extended);
1018 config.tools = build.tools;
1019 set(&mut config.verbose, build.verbose);
1020 set(&mut config.sanitizers, build.sanitizers);
1021 set(&mut config.profiler, build.profiler);
1022 set(&mut config.cargo_native_static, build.cargo_native_static);
1023 set(&mut config.configure_args, build.configure_args);
1024 set(&mut config.local_rebuild, build.local_rebuild);
1025 set(&mut config.print_step_timings, build.print_step_timings);
1026 set(&mut config.print_step_rusage, build.print_step_rusage);
1027 set(&mut config.patch_binaries_for_nix, build.patch_binaries_for_nix);
1029 config.verbose = cmp::max(config.verbose, flags.verbose);
1031 if let Some(install) = toml.install {
1032 config.prefix = install.prefix.map(PathBuf::from);
1033 config.sysconfdir = install.sysconfdir.map(PathBuf::from);
1034 config.datadir = install.datadir.map(PathBuf::from);
1035 config.docdir = install.docdir.map(PathBuf::from);
1036 set(&mut config.bindir, install.bindir.map(PathBuf::from));
1037 config.libdir = install.libdir.map(PathBuf::from);
1038 config.mandir = install.mandir.map(PathBuf::from);
1041 // We want the llvm-skip-rebuild flag to take precedence over the
1042 // skip-rebuild config.toml option so we store it separately
1043 // so that we can infer the right value
1044 let mut llvm_skip_rebuild = flags.llvm_skip_rebuild;
1046 // Store off these values as options because if they're not provided
1047 // we'll infer default values for them later
1048 let mut llvm_assertions = None;
1049 let mut llvm_tests = None;
1050 let mut llvm_plugins = None;
1051 let mut debug = None;
1052 let mut debug_assertions = None;
1053 let mut debug_assertions_std = None;
1054 let mut overflow_checks = None;
1055 let mut overflow_checks_std = None;
1056 let mut debug_logging = None;
1057 let mut debuginfo_level = None;
1058 let mut debuginfo_level_rustc = None;
1059 let mut debuginfo_level_std = None;
1060 let mut debuginfo_level_tools = None;
1061 let mut debuginfo_level_tests = None;
1062 let mut optimize = None;
1063 let mut ignore_git = None;
1065 if let Some(llvm) = toml.llvm {
1067 Some(StringOrBool::String(ref s)) => config.ccache = Some(s.to_string()),
1068 Some(StringOrBool::Bool(true)) => {
1069 config.ccache = Some("ccache".to_string());
1071 Some(StringOrBool::Bool(false)) | None => {}
1073 set(&mut config.ninja_in_file, llvm.ninja);
1074 llvm_assertions = llvm.assertions;
1075 llvm_tests = llvm.tests;
1076 llvm_plugins = llvm.plugins;
1077 llvm_skip_rebuild = llvm_skip_rebuild.or(llvm.skip_rebuild);
1078 set(&mut config.llvm_optimize, llvm.optimize);
1079 set(&mut config.llvm_thin_lto, llvm.thin_lto);
1080 set(&mut config.llvm_release_debuginfo, llvm.release_debuginfo);
1081 set(&mut config.llvm_version_check, llvm.version_check);
1082 set(&mut config.llvm_static_stdcpp, llvm.static_libstdcpp);
1083 if let Some(v) = llvm.link_shared {
1084 config.llvm_link_shared.set(Some(v));
1086 config.llvm_targets = llvm.targets.clone();
1087 config.llvm_experimental_targets = llvm.experimental_targets.clone();
1088 config.llvm_link_jobs = llvm.link_jobs;
1089 config.llvm_version_suffix = llvm.version_suffix.clone();
1090 config.llvm_clang_cl = llvm.clang_cl.clone();
1092 config.llvm_cflags = llvm.cflags.clone();
1093 config.llvm_cxxflags = llvm.cxxflags.clone();
1094 config.llvm_ldflags = llvm.ldflags.clone();
1095 set(&mut config.llvm_use_libcxx, llvm.use_libcxx);
1096 config.llvm_use_linker = llvm.use_linker.clone();
1097 config.llvm_allow_old_toolchain = llvm.allow_old_toolchain.unwrap_or(false);
1098 config.llvm_polly = llvm.polly.unwrap_or(false);
1099 config.llvm_clang = llvm.clang.unwrap_or(false);
1100 config.llvm_build_config = llvm.build_config.clone().unwrap_or(Default::default());
1101 config.llvm_from_ci = match llvm.download_ci_llvm {
1102 Some(StringOrBool::String(s)) => {
1103 assert!(s == "if-available", "unknown option `{}` for download-ci-llvm", s);
1104 crate::native::is_ci_llvm_available(&config, llvm_assertions.unwrap_or(false))
1106 Some(StringOrBool::Bool(b)) => b,
1110 if config.llvm_from_ci {
1111 // None of the LLVM options, except assertions, are supported
1112 // when using downloaded LLVM. We could just ignore these but
1113 // that's potentially confusing, so force them to not be
1114 // explicitly set. The defaults and CI defaults don't
1115 // necessarily match but forcing people to match (somewhat
1116 // arbitrary) CI configuration locally seems bad/hard.
1117 check_ci_llvm!(llvm.optimize);
1118 check_ci_llvm!(llvm.thin_lto);
1119 check_ci_llvm!(llvm.release_debuginfo);
1120 // CI-built LLVM can be either dynamic or static. We won't know until we download it.
1121 check_ci_llvm!(llvm.link_shared);
1122 check_ci_llvm!(llvm.static_libstdcpp);
1123 check_ci_llvm!(llvm.targets);
1124 check_ci_llvm!(llvm.experimental_targets);
1125 check_ci_llvm!(llvm.link_jobs);
1126 check_ci_llvm!(llvm.clang_cl);
1127 check_ci_llvm!(llvm.version_suffix);
1128 check_ci_llvm!(llvm.cflags);
1129 check_ci_llvm!(llvm.cxxflags);
1130 check_ci_llvm!(llvm.ldflags);
1131 check_ci_llvm!(llvm.use_libcxx);
1132 check_ci_llvm!(llvm.use_linker);
1133 check_ci_llvm!(llvm.allow_old_toolchain);
1134 check_ci_llvm!(llvm.polly);
1135 check_ci_llvm!(llvm.clang);
1136 check_ci_llvm!(llvm.build_config);
1137 check_ci_llvm!(llvm.plugins);
1140 // NOTE: can never be hit when downloading from CI, since we call `check_ci_llvm!(thin_lto)` above.
1141 if config.llvm_thin_lto && llvm.link_shared.is_none() {
1142 // If we're building with ThinLTO on, by default we want to link
1143 // to LLVM shared, to avoid re-doing ThinLTO (which happens in
1144 // the link step) with each stage.
1145 config.llvm_link_shared.set(Some(true));
1149 if let Some(rust) = toml.rust {
1151 debug_assertions = rust.debug_assertions;
1152 debug_assertions_std = rust.debug_assertions_std;
1153 overflow_checks = rust.overflow_checks;
1154 overflow_checks_std = rust.overflow_checks_std;
1155 debug_logging = rust.debug_logging;
1156 debuginfo_level = rust.debuginfo_level;
1157 debuginfo_level_rustc = rust.debuginfo_level_rustc;
1158 debuginfo_level_std = rust.debuginfo_level_std;
1159 debuginfo_level_tools = rust.debuginfo_level_tools;
1160 debuginfo_level_tests = rust.debuginfo_level_tests;
1161 config.rust_split_debuginfo = rust
1164 .map(SplitDebuginfo::from_str)
1165 .map(|v| v.expect("invalid value for rust.split_debuginfo"))
1166 .unwrap_or(SplitDebuginfo::default_for_platform(&config.build.triple));
1167 optimize = rust.optimize;
1168 ignore_git = rust.ignore_git;
1169 config.rust_new_symbol_mangling = rust.new_symbol_mangling;
1170 set(&mut config.rust_optimize_tests, rust.optimize_tests);
1171 set(&mut config.codegen_tests, rust.codegen_tests);
1172 set(&mut config.rust_rpath, rust.rpath);
1173 set(&mut config.jemalloc, rust.jemalloc);
1174 set(&mut config.test_compare_mode, rust.test_compare_mode);
1175 set(&mut config.backtrace, rust.backtrace);
1176 set(&mut config.channel, rust.channel);
1177 config.description = rust.description;
1178 set(&mut config.rust_dist_src, rust.dist_src);
1179 set(&mut config.verbose_tests, rust.verbose_tests);
1180 // in the case "false" is set explicitly, do not overwrite the command line args
1181 if let Some(true) = rust.incremental {
1182 config.incremental = true;
1184 set(&mut config.use_lld, rust.use_lld);
1185 set(&mut config.lld_enabled, rust.lld);
1186 set(&mut config.llvm_tools_enabled, rust.llvm_tools);
1187 config.rustc_parallel = rust.parallel_compiler.unwrap_or(false);
1188 config.rustc_default_linker = rust.default_linker;
1189 config.musl_root = rust.musl_root.map(PathBuf::from);
1190 config.save_toolstates = rust.save_toolstates.map(PathBuf::from);
1191 set(&mut config.deny_warnings, flags.deny_warnings.or(rust.deny_warnings));
1192 set(&mut config.backtrace_on_ice, rust.backtrace_on_ice);
1193 set(&mut config.rust_verify_llvm_ir, rust.verify_llvm_ir);
1194 config.rust_thin_lto_import_instr_limit = rust.thin_lto_import_instr_limit;
1195 set(&mut config.rust_remap_debuginfo, rust.remap_debuginfo);
1196 set(&mut config.control_flow_guard, rust.control_flow_guard);
1197 config.llvm_libunwind_default = rust
1199 .map(|v| v.parse().expect("failed to parse rust.llvm-libunwind"));
1201 if let Some(ref backends) = rust.codegen_backends {
1202 config.rust_codegen_backends =
1203 backends.iter().map(|s| INTERNER.intern_str(s)).collect();
1206 config.rust_codegen_units = rust.codegen_units.map(threads_from_config);
1207 config.rust_codegen_units_std = rust.codegen_units_std.map(threads_from_config);
1208 config.rust_profile_use = flags.rust_profile_use.or(rust.profile_use);
1209 config.rust_profile_generate = flags.rust_profile_generate.or(rust.profile_generate);
1210 config.download_rustc_commit = config.download_ci_rustc_commit(rust.download_rustc);
1212 config.rust_lto = rust
1215 .map(|value| RustcLto::from_str(value).unwrap())
1216 .unwrap_or_default();
1218 config.rust_profile_use = flags.rust_profile_use;
1219 config.rust_profile_generate = flags.rust_profile_generate;
1222 if let Some(t) = toml.target {
1223 for (triple, cfg) in t {
1224 let mut target = Target::from_triple(&triple);
1226 if let Some(ref s) = cfg.llvm_config {
1227 target.llvm_config = Some(config.src.join(s));
1229 target.llvm_has_rust_patches = cfg.llvm_has_rust_patches;
1230 if let Some(ref s) = cfg.llvm_filecheck {
1231 target.llvm_filecheck = Some(config.src.join(s));
1233 target.llvm_libunwind = cfg
1236 .map(|v| v.parse().expect("failed to parse rust.llvm-libunwind"));
1237 if let Some(ref s) = cfg.android_ndk {
1238 target.ndk = Some(config.src.join(s));
1240 if let Some(s) = cfg.no_std {
1243 target.cc = cfg.cc.map(PathBuf::from);
1244 target.cxx = cfg.cxx.map(PathBuf::from);
1245 target.ar = cfg.ar.map(PathBuf::from);
1246 target.ranlib = cfg.ranlib.map(PathBuf::from);
1247 target.linker = cfg.linker.map(PathBuf::from);
1248 target.crt_static = cfg.crt_static;
1249 target.musl_root = cfg.musl_root.map(PathBuf::from);
1250 target.musl_libdir = cfg.musl_libdir.map(PathBuf::from);
1251 target.wasi_root = cfg.wasi_root.map(PathBuf::from);
1252 target.qemu_rootfs = cfg.qemu_rootfs.map(PathBuf::from);
1253 target.sanitizers = cfg.sanitizers;
1254 target.profiler = cfg.profiler;
1256 config.target_config.insert(TargetSelection::from_user(&triple), target);
1260 if config.llvm_from_ci {
1261 let triple = &config.build.triple;
1262 let ci_llvm_bin = config.ci_llvm_root().join("bin");
1263 let mut build_target = config
1265 .entry(config.build)
1266 .or_insert_with(|| Target::from_triple(&triple));
1268 check_ci_llvm!(build_target.llvm_config);
1269 check_ci_llvm!(build_target.llvm_filecheck);
1270 build_target.llvm_config = Some(ci_llvm_bin.join(exe("llvm-config", config.build)));
1271 build_target.llvm_filecheck = Some(ci_llvm_bin.join(exe("FileCheck", config.build)));
1274 if let Some(t) = toml.dist {
1275 config.dist_sign_folder = t.sign_folder.map(PathBuf::from);
1276 config.dist_upload_addr = t.upload_addr;
1277 config.dist_compression_formats = t.compression_formats;
1278 set(&mut config.rust_dist_src, t.src_tarball);
1279 set(&mut config.missing_tools, t.missing_tools);
1282 if let Some(r) = build.rustfmt {
1283 *config.initial_rustfmt.borrow_mut() = if r.exists() {
1284 RustfmtState::SystemToolchain(r)
1286 RustfmtState::Unavailable
1289 // If using a system toolchain for bootstrapping, see if that has rustfmt available.
1290 let host = config.build;
1291 let rustfmt_path = config.initial_rustc.with_file_name(exe("rustfmt", host));
1292 let bin_root = config.out.join(host.triple).join("stage0");
1293 if !rustfmt_path.starts_with(&bin_root) {
1294 // Using a system-provided toolchain; we shouldn't download rustfmt.
1295 *config.initial_rustfmt.borrow_mut() = RustfmtState::SystemToolchain(rustfmt_path);
1299 // Now that we've reached the end of our configuration, infer the
1300 // default values for all options that we haven't otherwise stored yet.
1302 config.llvm_skip_rebuild = llvm_skip_rebuild.unwrap_or(false);
1303 config.llvm_assertions = llvm_assertions.unwrap_or(false);
1304 config.llvm_tests = llvm_tests.unwrap_or(false);
1305 config.llvm_plugins = llvm_plugins.unwrap_or(false);
1306 config.rust_optimize = optimize.unwrap_or(true);
1308 let default = debug == Some(true);
1309 config.rust_debug_assertions = debug_assertions.unwrap_or(default);
1310 config.rust_debug_assertions_std =
1311 debug_assertions_std.unwrap_or(config.rust_debug_assertions);
1312 config.rust_overflow_checks = overflow_checks.unwrap_or(default);
1313 config.rust_overflow_checks_std =
1314 overflow_checks_std.unwrap_or(config.rust_overflow_checks);
1316 config.rust_debug_logging = debug_logging.unwrap_or(config.rust_debug_assertions);
1318 let with_defaults = |debuginfo_level_specific: Option<u32>| {
1319 debuginfo_level_specific.or(debuginfo_level).unwrap_or(if debug == Some(true) {
1325 config.rust_debuginfo_level_rustc = with_defaults(debuginfo_level_rustc);
1326 config.rust_debuginfo_level_std = with_defaults(debuginfo_level_std);
1327 config.rust_debuginfo_level_tools = with_defaults(debuginfo_level_tools);
1328 config.rust_debuginfo_level_tests = debuginfo_level_tests.unwrap_or(0);
1330 let default = config.channel == "dev";
1331 config.ignore_git = ignore_git.unwrap_or(default);
1332 config.rust_info = GitInfo::new(config.ignore_git, &config.src);
1334 let download_rustc = config.download_rustc_commit.is_some();
1335 // See https://github.com/rust-lang/compiler-team/issues/326
1336 config.stage = match config.cmd {
1337 Subcommand::Check { .. } => flags.stage.or(build.check_stage).unwrap_or(0),
1338 // `download-rustc` only has a speed-up for stage2 builds. Default to stage2 unless explicitly overridden.
1339 Subcommand::Doc { .. } => {
1340 flags.stage.or(build.doc_stage).unwrap_or(if download_rustc { 2 } else { 0 })
1342 Subcommand::Build { .. } => {
1343 flags.stage.or(build.build_stage).unwrap_or(if download_rustc { 2 } else { 1 })
1345 Subcommand::Test { .. } => {
1346 flags.stage.or(build.test_stage).unwrap_or(if download_rustc { 2 } else { 1 })
1348 Subcommand::Bench { .. } => flags.stage.or(build.bench_stage).unwrap_or(2),
1349 Subcommand::Dist { .. } => flags.stage.or(build.dist_stage).unwrap_or(2),
1350 Subcommand::Install { .. } => flags.stage.or(build.install_stage).unwrap_or(2),
1351 // These are all bootstrap tools, which don't depend on the compiler.
1352 // The stage we pass shouldn't matter, but use 0 just in case.
1353 Subcommand::Clean { .. }
1354 | Subcommand::Clippy { .. }
1355 | Subcommand::Fix { .. }
1356 | Subcommand::Run { .. }
1357 | Subcommand::Setup { .. }
1358 | Subcommand::Format { .. } => flags.stage.unwrap_or(0),
1361 // CI should always run stage 2 builds, unless it specifically states otherwise
1363 if flags.stage.is_none() && crate::CiEnv::current() != crate::CiEnv::None {
1365 Subcommand::Test { .. }
1366 | Subcommand::Doc { .. }
1367 | Subcommand::Build { .. }
1368 | Subcommand::Bench { .. }
1369 | Subcommand::Dist { .. }
1370 | Subcommand::Install { .. } => {
1373 "x.py should be run with `--stage 2` on CI, but was run with `--stage {}`",
1377 Subcommand::Clean { .. }
1378 | Subcommand::Check { .. }
1379 | Subcommand::Clippy { .. }
1380 | Subcommand::Fix { .. }
1381 | Subcommand::Run { .. }
1382 | Subcommand::Setup { .. }
1383 | Subcommand::Format { .. } => {}
1390 pub(crate) fn dry_run(&self) -> bool {
1391 match self.dry_run {
1392 DryRun::Disabled => false,
1393 DryRun::SelfCheck | DryRun::UserSelected => true,
1397 /// A git invocation which runs inside the source directory.
1399 /// Use this rather than `Command::new("git")` in order to support out-of-tree builds.
1400 pub(crate) fn git(&self) -> Command {
1401 let mut git = Command::new("git");
1402 git.current_dir(&self.src);
1406 /// Bootstrap embeds a version number into the name of shared libraries it uploads in CI.
1407 /// Return the version it would have used for the given commit.
1408 pub(crate) fn artifact_version_part(&self, commit: &str) -> String {
1409 let (channel, version) = if self.rust_info.is_managed_git_subrepository() {
1410 let mut channel = self.git();
1411 channel.arg("show").arg(format!("{}:src/ci/channel", commit));
1412 let channel = output(&mut channel);
1413 let mut version = self.git();
1414 version.arg("show").arg(format!("{}:src/version", commit));
1415 let version = output(&mut version);
1416 (channel.trim().to_owned(), version.trim().to_owned())
1418 let channel = fs::read_to_string(self.src.join("src/ci/channel"));
1419 let version = fs::read_to_string(self.src.join("src/version"));
1420 match (channel, version) {
1421 (Ok(channel), Ok(version)) => {
1422 (channel.trim().to_owned(), version.trim().to_owned())
1424 (channel, version) => {
1425 let src = self.src.display();
1426 eprintln!("error: failed to determine artifact channel and/or version");
1428 "help: consider using a git checkout or ensure these files are readable"
1430 if let Err(channel) = channel {
1431 eprintln!("reading {}/src/ci/channel failed: {:?}", src, channel);
1433 if let Err(version) = version {
1434 eprintln!("reading {}/src/version failed: {:?}", src, version);
1441 match channel.as_str() {
1442 "stable" => version,
1444 "nightly" => channel,
1445 other => unreachable!("{:?} is not recognized as a valid channel", other),
1449 /// Try to find the relative path of `bindir`, otherwise return it in full.
1450 pub fn bindir_relative(&self) -> &Path {
1451 let bindir = &self.bindir;
1452 if bindir.is_absolute() {
1453 // Try to make it relative to the prefix.
1454 if let Some(prefix) = &self.prefix {
1455 if let Ok(stripped) = bindir.strip_prefix(prefix) {
1463 /// Try to find the relative path of `libdir`.
1464 pub fn libdir_relative(&self) -> Option<&Path> {
1465 let libdir = self.libdir.as_ref()?;
1466 if libdir.is_relative() {
1469 // Try to make it relative to the prefix.
1470 libdir.strip_prefix(self.prefix.as_ref()?).ok()
1474 /// The absolute path to the downloaded LLVM artifacts.
1475 pub(crate) fn ci_llvm_root(&self) -> PathBuf {
1476 assert!(self.llvm_from_ci);
1477 self.out.join(&*self.build.triple).join("ci-llvm")
1480 /// Determine whether llvm should be linked dynamically.
1482 /// If `false`, llvm should be linked statically.
1483 /// This is computed on demand since LLVM might have to first be downloaded from CI.
1484 pub(crate) fn llvm_link_shared(&self) -> bool {
1485 let mut opt = self.llvm_link_shared.get();
1486 if opt.is_none() && self.dry_run() {
1487 // just assume static for now - dynamic linking isn't supported on all platforms
1491 let llvm_link_shared = *opt.get_or_insert_with(|| {
1492 if self.llvm_from_ci {
1493 self.maybe_download_ci_llvm();
1494 let ci_llvm = self.ci_llvm_root();
1496 std::fs::read_to_string(ci_llvm.join("link-type.txt")),
1497 format!("CI llvm missing: {}", ci_llvm.display())
1499 link_type == "dynamic"
1501 // unclear how thought-through this default is, but it maintains compatibility with
1502 // previous behavior
1506 self.llvm_link_shared.set(opt);
1510 /// Return whether we will use a downloaded, pre-compiled version of rustc, or just build from source.
1511 pub(crate) fn download_rustc(&self) -> bool {
1512 static DOWNLOAD_RUSTC: OnceCell<bool> = OnceCell::new();
1513 if self.dry_run() && DOWNLOAD_RUSTC.get().is_none() {
1514 // avoid trying to actually download the commit
1518 *DOWNLOAD_RUSTC.get_or_init(|| match &self.download_rustc_commit {
1521 self.download_ci_rustc(commit);
1527 pub(crate) fn initial_rustfmt(&self) -> Option<PathBuf> {
1528 match &mut *self.initial_rustfmt.borrow_mut() {
1529 RustfmtState::SystemToolchain(p) | RustfmtState::Downloaded(p) => Some(p.clone()),
1530 RustfmtState::Unavailable => None,
1531 r @ RustfmtState::LazyEvaluated => {
1533 return Some(PathBuf::new());
1535 let path = self.maybe_download_rustfmt();
1536 *r = if let Some(p) = &path {
1537 RustfmtState::Downloaded(p.clone())
1539 RustfmtState::Unavailable
1546 pub fn verbose(&self, msg: &str) {
1547 if self.verbose > 0 {
1548 println!("{}", msg);
1552 pub fn sanitizers_enabled(&self, target: TargetSelection) -> bool {
1553 self.target_config.get(&target).map(|t| t.sanitizers).flatten().unwrap_or(self.sanitizers)
1556 pub fn any_sanitizers_enabled(&self) -> bool {
1557 self.target_config.values().any(|t| t.sanitizers == Some(true)) || self.sanitizers
1560 pub fn profiler_enabled(&self, target: TargetSelection) -> bool {
1561 self.target_config.get(&target).map(|t| t.profiler).flatten().unwrap_or(self.profiler)
1564 pub fn any_profiler_enabled(&self) -> bool {
1565 self.target_config.values().any(|t| t.profiler == Some(true)) || self.profiler
1568 pub fn llvm_enabled(&self) -> bool {
1569 self.rust_codegen_backends.contains(&INTERNER.intern_str("llvm"))
1572 pub fn llvm_libunwind(&self, target: TargetSelection) -> LlvmLibunwind {
1575 .and_then(|t| t.llvm_libunwind)
1576 .or(self.llvm_libunwind_default)
1577 .unwrap_or(if target.contains("fuchsia") {
1578 LlvmLibunwind::InTree
1584 pub fn submodules(&self, rust_info: &GitInfo) -> bool {
1585 self.submodules.unwrap_or(rust_info.is_managed_git_subrepository())
1588 /// Returns the commit to download, or `None` if we shouldn't download CI artifacts.
1589 fn download_ci_rustc_commit(&self, download_rustc: Option<StringOrBool>) -> Option<String> {
1590 // If `download-rustc` is not set, default to rebuilding.
1591 let if_unchanged = match download_rustc {
1592 None | Some(StringOrBool::Bool(false)) => return None,
1593 Some(StringOrBool::Bool(true)) => false,
1594 Some(StringOrBool::String(s)) if s == "if-unchanged" => true,
1595 Some(StringOrBool::String(other)) => {
1596 panic!("unrecognized option for download-rustc: {}", other)
1600 // Handle running from a directory other than the top level
1601 let top_level = output(self.git().args(&["rev-parse", "--show-toplevel"]));
1602 let top_level = top_level.trim_end();
1603 let compiler = format!("{top_level}/compiler/");
1604 let library = format!("{top_level}/library/");
1606 // Look for a version to compare to based on the current commit.
1607 // Only commits merged by bors will have CI artifacts.
1608 let merge_base = output(
1611 .arg(format!("--author={}", self.stage0_metadata.config.git_merge_commit_email))
1612 .args(&["-n1", "--first-parent", "HEAD"]),
1614 let commit = merge_base.trim_end();
1615 if commit.is_empty() {
1616 println!("error: could not find commit hash for downloading rustc");
1617 println!("help: maybe your repository history is too shallow?");
1618 println!("help: consider disabling `download-rustc`");
1619 println!("help: or fetch enough history to include one upstream commit");
1620 crate::detail_exit(1);
1623 // Warn if there were changes to the compiler or standard library since the ancestor commit.
1624 let has_changes = !t!(self
1626 .args(&["diff-index", "--quiet", &commit, "--", &compiler, &library])
1631 if self.verbose > 0 {
1633 "warning: saw changes to compiler/ or library/ since {commit}; \
1634 ignoring `download-rustc`"
1640 "warning: `download-rustc` is enabled, but there are changes to \
1641 compiler/ or library/"
1645 Some(commit.to_string())
1649 fn set<T>(field: &mut T, val: Option<T>) {
1650 if let Some(v) = val {
1655 fn threads_from_config(v: u32) -> u32 {
1657 0 => std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get) as u32,