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 pub llvm_has_rust_patches: Option<bool>,
392 /// Some(path to FileCheck) if one was specified.
393 pub llvm_filecheck: Option<PathBuf>,
394 pub llvm_libunwind: Option<LlvmLibunwind>,
395 pub cc: Option<PathBuf>,
396 pub cxx: Option<PathBuf>,
397 pub ar: Option<PathBuf>,
398 pub ranlib: Option<PathBuf>,
399 pub default_linker: Option<PathBuf>,
400 pub linker: Option<PathBuf>,
401 pub ndk: Option<PathBuf>,
402 pub sanitizers: Option<bool>,
403 pub profiler: Option<bool>,
404 pub crt_static: Option<bool>,
405 pub musl_root: Option<PathBuf>,
406 pub musl_libdir: Option<PathBuf>,
407 pub wasi_root: Option<PathBuf>,
408 pub qemu_rootfs: Option<PathBuf>,
413 pub fn from_triple(triple: &str) -> Self {
414 let mut target: Self = Default::default();
415 if triple.contains("-none")
416 || triple.contains("nvptx")
417 || triple.contains("switch")
418 || triple.contains("-uefi")
420 target.no_std = true;
425 /// Structure of the `config.toml` file that configuration is read from.
427 /// This structure uses `Decodable` to automatically decode a TOML configuration
428 /// file into this format, and then this is traversed and written into the above
429 /// `Config` structure.
430 #[derive(Deserialize, Default)]
431 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
433 changelog_seen: Option<usize>,
434 build: Option<Build>,
435 install: Option<Install>,
438 target: Option<HashMap<String, TomlTarget>>,
440 profile: Option<String>,
444 fn merge(&mut self, other: Self);
447 impl Merge for TomlConfig {
450 TomlConfig { build, install, llvm, rust, dist, target, profile: _, changelog_seen: _ }: Self,
452 fn do_merge<T: Merge>(x: &mut Option<T>, y: Option<T>) {
453 if let Some(new) = y {
454 if let Some(original) = x {
461 do_merge(&mut self.build, build);
462 do_merge(&mut self.install, install);
463 do_merge(&mut self.llvm, llvm);
464 do_merge(&mut self.rust, rust);
465 do_merge(&mut self.dist, dist);
466 assert!(target.is_none(), "merging target-specific config is not currently supported");
470 // We are using a decl macro instead of a derive proc macro here to reduce the compile time of
472 macro_rules! define_config {
473 ($(#[$attr:meta])* struct $name:ident {
474 $($field:ident: Option<$field_ty:ty> = $field_key:literal,)*
478 $($field: Option<$field_ty>,)*
481 impl Merge for $name {
482 fn merge(&mut self, other: Self) {
484 if !self.$field.is_some() {
485 self.$field = other.$field;
491 // The following is a trimmed version of what serde_derive generates. All parts not relevant
492 // for toml deserialization have been removed. This reduces the binary size and improves
493 // compile time of rustbuild.
494 impl<'de> Deserialize<'de> for $name {
495 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
497 D: Deserializer<'de>,
500 impl<'de> serde::de::Visitor<'de> for Field {
502 fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
503 f.write_str(concat!("struct ", stringify!($name)))
507 fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error>
509 A: serde::de::MapAccess<'de>,
511 $(let mut $field: Option<$field_ty> = None;)*
512 while let Some(key) =
513 match serde::de::MapAccess::next_key::<String>(&mut map) {
522 if $field.is_some() {
523 return Err(<A::Error as serde::de::Error>::duplicate_field(
527 $field = match serde::de::MapAccess::next_value::<$field_ty>(
530 Ok(val) => Some(val),
537 return Err(serde::de::Error::unknown_field(key, FIELDS));
541 Ok($name { $($field),* })
544 const FIELDS: &'static [&'static str] = &[
547 Deserializer::deserialize_struct(
559 /// TOML representation of various global build decisions.
562 build: Option<String> = "build",
563 host: Option<Vec<String>> = "host",
564 target: Option<Vec<String>> = "target",
565 build_dir: Option<String> = "build-dir",
566 cargo: Option<String> = "cargo",
567 rustc: Option<String> = "rustc",
568 rustfmt: Option<PathBuf> = "rustfmt",
569 docs: Option<bool> = "docs",
570 compiler_docs: Option<bool> = "compiler-docs",
571 docs_minification: Option<bool> = "docs-minification",
572 submodules: Option<bool> = "submodules",
573 gdb: Option<String> = "gdb",
574 nodejs: Option<String> = "nodejs",
575 npm: Option<String> = "npm",
576 python: Option<String> = "python",
577 locked_deps: Option<bool> = "locked-deps",
578 vendor: Option<bool> = "vendor",
579 full_bootstrap: Option<bool> = "full-bootstrap",
580 extended: Option<bool> = "extended",
581 tools: Option<HashSet<String>> = "tools",
582 verbose: Option<usize> = "verbose",
583 sanitizers: Option<bool> = "sanitizers",
584 profiler: Option<bool> = "profiler",
585 cargo_native_static: Option<bool> = "cargo-native-static",
586 low_priority: Option<bool> = "low-priority",
587 configure_args: Option<Vec<String>> = "configure-args",
588 local_rebuild: Option<bool> = "local-rebuild",
589 print_step_timings: Option<bool> = "print-step-timings",
590 print_step_rusage: Option<bool> = "print-step-rusage",
591 check_stage: Option<u32> = "check-stage",
592 doc_stage: Option<u32> = "doc-stage",
593 build_stage: Option<u32> = "build-stage",
594 test_stage: Option<u32> = "test-stage",
595 install_stage: Option<u32> = "install-stage",
596 dist_stage: Option<u32> = "dist-stage",
597 bench_stage: Option<u32> = "bench-stage",
598 patch_binaries_for_nix: Option<bool> = "patch-binaries-for-nix",
599 metrics: Option<bool> = "metrics",
604 /// TOML representation of various global install decisions.
606 prefix: Option<String> = "prefix",
607 sysconfdir: Option<String> = "sysconfdir",
608 docdir: Option<String> = "docdir",
609 bindir: Option<String> = "bindir",
610 libdir: Option<String> = "libdir",
611 mandir: Option<String> = "mandir",
612 datadir: Option<String> = "datadir",
617 /// TOML representation of how the LLVM build is configured.
619 skip_rebuild: Option<bool> = "skip-rebuild",
620 optimize: Option<bool> = "optimize",
621 thin_lto: Option<bool> = "thin-lto",
622 release_debuginfo: Option<bool> = "release-debuginfo",
623 assertions: Option<bool> = "assertions",
624 tests: Option<bool> = "tests",
625 plugins: Option<bool> = "plugins",
626 ccache: Option<StringOrBool> = "ccache",
627 version_check: Option<bool> = "version-check",
628 static_libstdcpp: Option<bool> = "static-libstdcpp",
629 ninja: Option<bool> = "ninja",
630 targets: Option<String> = "targets",
631 experimental_targets: Option<String> = "experimental-targets",
632 link_jobs: Option<u32> = "link-jobs",
633 link_shared: Option<bool> = "link-shared",
634 version_suffix: Option<String> = "version-suffix",
635 clang_cl: Option<String> = "clang-cl",
636 cflags: Option<String> = "cflags",
637 cxxflags: Option<String> = "cxxflags",
638 ldflags: Option<String> = "ldflags",
639 use_libcxx: Option<bool> = "use-libcxx",
640 use_linker: Option<String> = "use-linker",
641 allow_old_toolchain: Option<bool> = "allow-old-toolchain",
642 polly: Option<bool> = "polly",
643 clang: Option<bool> = "clang",
644 download_ci_llvm: Option<StringOrBool> = "download-ci-llvm",
645 build_config: Option<HashMap<String, String>> = "build-config",
651 sign_folder: Option<String> = "sign-folder",
652 gpg_password_file: Option<String> = "gpg-password-file",
653 upload_addr: Option<String> = "upload-addr",
654 src_tarball: Option<bool> = "src-tarball",
655 missing_tools: Option<bool> = "missing-tools",
656 compression_formats: Option<Vec<String>> = "compression-formats",
660 #[derive(Deserialize)]
667 impl Default for StringOrBool {
668 fn default() -> StringOrBool {
669 StringOrBool::Bool(false)
674 /// TOML representation of how the Rust build is configured.
676 optimize: Option<bool> = "optimize",
677 debug: Option<bool> = "debug",
678 codegen_units: Option<u32> = "codegen-units",
679 codegen_units_std: Option<u32> = "codegen-units-std",
680 debug_assertions: Option<bool> = "debug-assertions",
681 debug_assertions_std: Option<bool> = "debug-assertions-std",
682 overflow_checks: Option<bool> = "overflow-checks",
683 overflow_checks_std: Option<bool> = "overflow-checks-std",
684 debug_logging: Option<bool> = "debug-logging",
685 debuginfo_level: Option<u32> = "debuginfo-level",
686 debuginfo_level_rustc: Option<u32> = "debuginfo-level-rustc",
687 debuginfo_level_std: Option<u32> = "debuginfo-level-std",
688 debuginfo_level_tools: Option<u32> = "debuginfo-level-tools",
689 debuginfo_level_tests: Option<u32> = "debuginfo-level-tests",
690 split_debuginfo: Option<String> = "split-debuginfo",
691 run_dsymutil: Option<bool> = "run-dsymutil",
692 backtrace: Option<bool> = "backtrace",
693 incremental: Option<bool> = "incremental",
694 parallel_compiler: Option<bool> = "parallel-compiler",
695 default_linker: Option<String> = "default-linker",
696 channel: Option<String> = "channel",
697 description: Option<String> = "description",
698 musl_root: Option<String> = "musl-root",
699 rpath: Option<bool> = "rpath",
700 verbose_tests: Option<bool> = "verbose-tests",
701 optimize_tests: Option<bool> = "optimize-tests",
702 codegen_tests: Option<bool> = "codegen-tests",
703 ignore_git: Option<bool> = "ignore-git",
704 dist_src: Option<bool> = "dist-src",
705 save_toolstates: Option<String> = "save-toolstates",
706 codegen_backends: Option<Vec<String>> = "codegen-backends",
707 lld: Option<bool> = "lld",
708 use_lld: Option<bool> = "use-lld",
709 llvm_tools: Option<bool> = "llvm-tools",
710 deny_warnings: Option<bool> = "deny-warnings",
711 backtrace_on_ice: Option<bool> = "backtrace-on-ice",
712 verify_llvm_ir: Option<bool> = "verify-llvm-ir",
713 thin_lto_import_instr_limit: Option<u32> = "thin-lto-import-instr-limit",
714 remap_debuginfo: Option<bool> = "remap-debuginfo",
715 jemalloc: Option<bool> = "jemalloc",
716 test_compare_mode: Option<bool> = "test-compare-mode",
717 llvm_libunwind: Option<String> = "llvm-libunwind",
718 control_flow_guard: Option<bool> = "control-flow-guard",
719 new_symbol_mangling: Option<bool> = "new-symbol-mangling",
720 profile_generate: Option<String> = "profile-generate",
721 profile_use: Option<String> = "profile-use",
722 // ignored; this is set from an env var set by bootstrap.py
723 download_rustc: Option<StringOrBool> = "download-rustc",
728 /// TOML representation of how each build target is configured.
730 cc: Option<String> = "cc",
731 cxx: Option<String> = "cxx",
732 ar: Option<String> = "ar",
733 ranlib: Option<String> = "ranlib",
734 default_linker: Option<PathBuf> = "default-linker",
735 linker: Option<String> = "linker",
736 llvm_config: Option<String> = "llvm-config",
737 llvm_has_rust_patches: Option<bool> = "llvm-has-rust-patches",
738 llvm_filecheck: Option<String> = "llvm-filecheck",
739 llvm_libunwind: Option<String> = "llvm-libunwind",
740 android_ndk: Option<String> = "android-ndk",
741 sanitizers: Option<bool> = "sanitizers",
742 profiler: Option<bool> = "profiler",
743 crt_static: Option<bool> = "crt-static",
744 musl_root: Option<String> = "musl-root",
745 musl_libdir: Option<String> = "musl-libdir",
746 wasi_root: Option<String> = "wasi-root",
747 qemu_rootfs: Option<String> = "qemu-rootfs",
748 no_std: Option<bool> = "no-std",
753 pub fn default_opts() -> Config {
754 let mut config = Config::default();
755 config.llvm_optimize = true;
756 config.ninja_in_file = true;
757 config.llvm_version_check = true;
758 config.llvm_static_stdcpp = true;
759 config.backtrace = true;
760 config.rust_optimize = true;
761 config.rust_optimize_tests = true;
762 config.submodules = None;
764 config.docs_minification = true;
765 config.rust_rpath = true;
766 config.channel = "dev".to_string();
767 config.codegen_tests = true;
768 config.rust_dist_src = true;
769 config.rust_codegen_backends = vec![INTERNER.intern_str("llvm")];
770 config.deny_warnings = true;
771 config.bindir = "bin".into();
774 config.build = TargetSelection::from_user(&env!("BUILD_TRIPLE"));
776 let manifest_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
777 // Undo `src/bootstrap`
778 config.src = manifest_dir.parent().unwrap().parent().unwrap().to_owned();
779 config.out = PathBuf::from("build");
784 pub fn parse(args: &[String]) -> Config {
785 let flags = Flags::parse(&args);
786 let mut config = Config::default_opts();
789 config.exclude = flags.exclude.into_iter().map(|path| TaskPath::parse(path)).collect();
790 config.include_default_paths = flags.include_default_paths;
791 config.rustc_error_format = flags.rustc_error_format;
792 config.json_output = flags.json_output;
793 config.on_fail = flags.on_fail;
794 config.jobs = flags.jobs.map(threads_from_config);
795 config.cmd = flags.cmd;
796 config.incremental = flags.incremental;
797 config.dry_run = flags.dry_run;
798 config.keep_stage = flags.keep_stage;
799 config.keep_stage_std = flags.keep_stage_std;
800 config.color = flags.color;
801 if let Some(value) = flags.deny_warnings {
802 config.deny_warnings = value;
804 config.llvm_profile_use = flags.llvm_profile_use;
805 config.llvm_profile_generate = flags.llvm_profile_generate;
807 // Infer the rest of the configuration.
809 // Infer the source directory. This is non-trivial because we want to support a downloaded bootstrap binary,
810 // running on a completely machine from where it was compiled.
811 let mut cmd = Command::new("git");
812 // NOTE: we cannot support running from outside the repository because the only path we have available
813 // is set at compile time, which can be wrong if bootstrap was downloaded from source.
814 // We still support running outside the repository if we find we aren't in a git directory.
815 cmd.arg("rev-parse").arg("--show-toplevel");
816 // Discard stderr because we expect this to fail when building from a tarball.
818 .stderr(std::process::Stdio::null())
821 .and_then(|output| if output.status.success() { Some(output) } else { None });
822 if let Some(output) = output {
823 let git_root = String::from_utf8(output.stdout).unwrap();
824 config.src = PathBuf::from(git_root.trim().to_owned())
826 // We're building from a tarball, not git sources.
827 // We don't support pre-downloaded bootstrap in this case.
831 // Use the build directory of the original x.py invocation, so that we can set `initial_rustc` properly.
832 config.out = Path::new(
833 &env::var_os("CARGO_TARGET_DIR").expect("cargo test directly is not supported"),
840 let stage0_json = t!(std::fs::read(&config.src.join("src").join("stage0.json")));
842 config.stage0_metadata = t!(serde_json::from_slice::<Stage0Metadata>(&stage0_json));
845 let get_toml = |_| TomlConfig::default();
847 let get_toml = |file: &Path| {
849 t!(fs::read_to_string(file), format!("config file {} not found", file.display()));
850 // Deserialize to Value and then TomlConfig to prevent the Deserialize impl of
851 // TomlConfig and sub types to be monomorphized 5x by toml.
852 match toml::from_str(&contents)
853 .and_then(|table: toml::Value| TomlConfig::deserialize(table))
857 eprintln!("failed to parse TOML configuration '{}': {}", file.display(), err);
858 crate::detail_exit(2);
863 // Read from `--config`, then `RUST_BOOTSTRAP_CONFIG`, then `./config.toml`, then `config.toml` in the root directory.
864 let toml_path = flags
867 .or_else(|| env::var_os("RUST_BOOTSTRAP_CONFIG").map(PathBuf::from));
868 let using_default_path = toml_path.is_none();
869 let mut toml_path = toml_path.unwrap_or_else(|| PathBuf::from("config.toml"));
870 if using_default_path && !toml_path.exists() {
871 toml_path = config.src.join(toml_path);
874 // Give a hard error if `--config` or `RUST_BOOTSTRAP_CONFIG` are set to a missing path,
875 // but not if `config.toml` hasn't been created.
876 let mut toml = if !using_default_path || toml_path.exists() {
879 TomlConfig::default()
882 if let Some(include) = &toml.profile {
883 let mut include_path = config.src.clone();
884 include_path.push("src");
885 include_path.push("bootstrap");
886 include_path.push("defaults");
887 include_path.push(format!("config.{}.toml", include));
888 let included_toml = get_toml(&include_path);
889 toml.merge(included_toml);
892 config.changelog_seen = toml.changelog_seen;
893 config.config = toml_path;
895 let build = toml.build.unwrap_or_default();
896 let has_custom_rustc = build.rustc.is_some();
898 set(&mut config.initial_rustc, build.rustc.map(PathBuf::from));
899 set(&mut config.out, flags.build_dir.or_else(|| build.build_dir.map(PathBuf::from)));
900 // NOTE: Bootstrap spawns various commands with different working directories.
901 // To avoid writing to random places on the file system, `config.out` needs to be an absolute path.
902 if !config.out.is_absolute() {
903 // `canonicalize` requires the path to already exist. Use our vendored copy of `absolute` instead.
904 config.out = crate::util::absolute(&config.out);
907 if !has_custom_rustc && !config.initial_rustc.starts_with(&config.out) {
908 config.initial_rustc = config.out.join(config.build.triple).join("stage0/bin/rustc");
909 config.initial_cargo = config.out.join(config.build.triple).join("stage0/bin/cargo");
912 // NOTE: it's important this comes *after* we set `initial_rustc` just above.
914 let dir = config.out.join("tmp-dry-run");
915 t!(fs::create_dir_all(&dir));
919 config.hosts = if let Some(arg_host) = flags.host {
921 } else if let Some(file_host) = build.host {
922 file_host.iter().map(|h| TargetSelection::from_user(h)).collect()
926 config.targets = if let Some(arg_target) = flags.target {
928 } else if let Some(file_target) = build.target {
929 file_target.iter().map(|h| TargetSelection::from_user(h)).collect()
931 // If target is *not* configured, then default to the host
936 config.nodejs = build.nodejs.map(PathBuf::from);
937 config.npm = build.npm.map(PathBuf::from);
938 config.gdb = build.gdb.map(PathBuf::from);
939 config.python = build.python.map(PathBuf::from);
940 config.submodules = build.submodules;
941 set(&mut config.low_priority, build.low_priority);
942 set(&mut config.compiler_docs, build.compiler_docs);
943 set(&mut config.docs_minification, build.docs_minification);
944 set(&mut config.docs, build.docs);
945 set(&mut config.locked_deps, build.locked_deps);
946 set(&mut config.vendor, build.vendor);
947 set(&mut config.full_bootstrap, build.full_bootstrap);
948 set(&mut config.extended, build.extended);
949 config.tools = build.tools;
950 set(&mut config.verbose, build.verbose);
951 set(&mut config.sanitizers, build.sanitizers);
952 set(&mut config.profiler, build.profiler);
953 set(&mut config.cargo_native_static, build.cargo_native_static);
954 set(&mut config.configure_args, build.configure_args);
955 set(&mut config.local_rebuild, build.local_rebuild);
956 set(&mut config.print_step_timings, build.print_step_timings);
957 set(&mut config.print_step_rusage, build.print_step_rusage);
958 set(&mut config.patch_binaries_for_nix, build.patch_binaries_for_nix);
960 config.verbose = cmp::max(config.verbose, flags.verbose);
962 if let Some(install) = toml.install {
963 config.prefix = install.prefix.map(PathBuf::from);
964 config.sysconfdir = install.sysconfdir.map(PathBuf::from);
965 config.datadir = install.datadir.map(PathBuf::from);
966 config.docdir = install.docdir.map(PathBuf::from);
967 set(&mut config.bindir, install.bindir.map(PathBuf::from));
968 config.libdir = install.libdir.map(PathBuf::from);
969 config.mandir = install.mandir.map(PathBuf::from);
972 // We want the llvm-skip-rebuild flag to take precedence over the
973 // skip-rebuild config.toml option so we store it separately
974 // so that we can infer the right value
975 let mut llvm_skip_rebuild = flags.llvm_skip_rebuild;
977 // Store off these values as options because if they're not provided
978 // we'll infer default values for them later
979 let mut llvm_assertions = None;
980 let mut llvm_tests = None;
981 let mut llvm_plugins = None;
982 let mut debug = None;
983 let mut debug_assertions = None;
984 let mut debug_assertions_std = None;
985 let mut overflow_checks = None;
986 let mut overflow_checks_std = None;
987 let mut debug_logging = None;
988 let mut debuginfo_level = None;
989 let mut debuginfo_level_rustc = None;
990 let mut debuginfo_level_std = None;
991 let mut debuginfo_level_tools = None;
992 let mut debuginfo_level_tests = None;
993 let mut optimize = None;
994 let mut ignore_git = None;
996 if let Some(llvm) = toml.llvm {
998 Some(StringOrBool::String(ref s)) => config.ccache = Some(s.to_string()),
999 Some(StringOrBool::Bool(true)) => {
1000 config.ccache = Some("ccache".to_string());
1002 Some(StringOrBool::Bool(false)) | None => {}
1004 set(&mut config.ninja_in_file, llvm.ninja);
1005 llvm_assertions = llvm.assertions;
1006 llvm_tests = llvm.tests;
1007 llvm_plugins = llvm.plugins;
1008 llvm_skip_rebuild = llvm_skip_rebuild.or(llvm.skip_rebuild);
1009 set(&mut config.llvm_optimize, llvm.optimize);
1010 set(&mut config.llvm_thin_lto, llvm.thin_lto);
1011 set(&mut config.llvm_release_debuginfo, llvm.release_debuginfo);
1012 set(&mut config.llvm_version_check, llvm.version_check);
1013 set(&mut config.llvm_static_stdcpp, llvm.static_libstdcpp);
1014 if let Some(v) = llvm.link_shared {
1015 config.llvm_link_shared.set(Some(v));
1017 config.llvm_targets = llvm.targets.clone();
1018 config.llvm_experimental_targets = llvm.experimental_targets.clone();
1019 config.llvm_link_jobs = llvm.link_jobs;
1020 config.llvm_version_suffix = llvm.version_suffix.clone();
1021 config.llvm_clang_cl = llvm.clang_cl.clone();
1023 config.llvm_cflags = llvm.cflags.clone();
1024 config.llvm_cxxflags = llvm.cxxflags.clone();
1025 config.llvm_ldflags = llvm.ldflags.clone();
1026 set(&mut config.llvm_use_libcxx, llvm.use_libcxx);
1027 config.llvm_use_linker = llvm.use_linker.clone();
1028 config.llvm_allow_old_toolchain = llvm.allow_old_toolchain.unwrap_or(false);
1029 config.llvm_polly = llvm.polly.unwrap_or(false);
1030 config.llvm_clang = llvm.clang.unwrap_or(false);
1031 config.llvm_build_config = llvm.build_config.clone().unwrap_or(Default::default());
1032 config.llvm_from_ci = match llvm.download_ci_llvm {
1033 Some(StringOrBool::String(s)) => {
1034 assert!(s == "if-available", "unknown option `{}` for download-ci-llvm", s);
1035 crate::native::is_ci_llvm_available(&config, llvm_assertions.unwrap_or(false))
1037 Some(StringOrBool::Bool(b)) => b,
1041 if config.llvm_from_ci {
1042 // None of the LLVM options, except assertions, are supported
1043 // when using downloaded LLVM. We could just ignore these but
1044 // that's potentially confusing, so force them to not be
1045 // explicitly set. The defaults and CI defaults don't
1046 // necessarily match but forcing people to match (somewhat
1047 // arbitrary) CI configuration locally seems bad/hard.
1048 check_ci_llvm!(llvm.optimize);
1049 check_ci_llvm!(llvm.thin_lto);
1050 check_ci_llvm!(llvm.release_debuginfo);
1051 // CI-built LLVM can be either dynamic or static. We won't know until we download it.
1052 check_ci_llvm!(llvm.link_shared);
1053 check_ci_llvm!(llvm.static_libstdcpp);
1054 check_ci_llvm!(llvm.targets);
1055 check_ci_llvm!(llvm.experimental_targets);
1056 check_ci_llvm!(llvm.link_jobs);
1057 check_ci_llvm!(llvm.clang_cl);
1058 check_ci_llvm!(llvm.version_suffix);
1059 check_ci_llvm!(llvm.cflags);
1060 check_ci_llvm!(llvm.cxxflags);
1061 check_ci_llvm!(llvm.ldflags);
1062 check_ci_llvm!(llvm.use_libcxx);
1063 check_ci_llvm!(llvm.use_linker);
1064 check_ci_llvm!(llvm.allow_old_toolchain);
1065 check_ci_llvm!(llvm.polly);
1066 check_ci_llvm!(llvm.clang);
1067 check_ci_llvm!(llvm.build_config);
1068 check_ci_llvm!(llvm.plugins);
1071 // NOTE: can never be hit when downloading from CI, since we call `check_ci_llvm!(thin_lto)` above.
1072 if config.llvm_thin_lto && llvm.link_shared.is_none() {
1073 // If we're building with ThinLTO on, by default we want to link
1074 // to LLVM shared, to avoid re-doing ThinLTO (which happens in
1075 // the link step) with each stage.
1076 config.llvm_link_shared.set(Some(true));
1080 if let Some(rust) = toml.rust {
1082 debug_assertions = rust.debug_assertions;
1083 debug_assertions_std = rust.debug_assertions_std;
1084 overflow_checks = rust.overflow_checks;
1085 overflow_checks_std = rust.overflow_checks_std;
1086 debug_logging = rust.debug_logging;
1087 debuginfo_level = rust.debuginfo_level;
1088 debuginfo_level_rustc = rust.debuginfo_level_rustc;
1089 debuginfo_level_std = rust.debuginfo_level_std;
1090 debuginfo_level_tools = rust.debuginfo_level_tools;
1091 debuginfo_level_tests = rust.debuginfo_level_tests;
1092 config.rust_split_debuginfo = rust
1095 .map(SplitDebuginfo::from_str)
1096 .map(|v| v.expect("invalid value for rust.split_debuginfo"))
1097 .unwrap_or(SplitDebuginfo::default_for_platform(&config.build.triple));
1098 optimize = rust.optimize;
1099 ignore_git = rust.ignore_git;
1100 config.rust_new_symbol_mangling = rust.new_symbol_mangling;
1101 set(&mut config.rust_optimize_tests, rust.optimize_tests);
1102 set(&mut config.codegen_tests, rust.codegen_tests);
1103 set(&mut config.rust_rpath, rust.rpath);
1104 set(&mut config.jemalloc, rust.jemalloc);
1105 set(&mut config.test_compare_mode, rust.test_compare_mode);
1106 set(&mut config.backtrace, rust.backtrace);
1107 set(&mut config.channel, rust.channel);
1108 config.description = rust.description;
1109 set(&mut config.rust_dist_src, rust.dist_src);
1110 set(&mut config.verbose_tests, rust.verbose_tests);
1111 // in the case "false" is set explicitly, do not overwrite the command line args
1112 if let Some(true) = rust.incremental {
1113 config.incremental = true;
1115 set(&mut config.use_lld, rust.use_lld);
1116 set(&mut config.lld_enabled, rust.lld);
1117 set(&mut config.llvm_tools_enabled, rust.llvm_tools);
1118 config.rustc_parallel = rust.parallel_compiler.unwrap_or(false);
1119 config.rustc_default_linker = rust.default_linker;
1120 config.musl_root = rust.musl_root.map(PathBuf::from);
1121 config.save_toolstates = rust.save_toolstates.map(PathBuf::from);
1122 set(&mut config.deny_warnings, flags.deny_warnings.or(rust.deny_warnings));
1123 set(&mut config.backtrace_on_ice, rust.backtrace_on_ice);
1124 set(&mut config.rust_verify_llvm_ir, rust.verify_llvm_ir);
1125 config.rust_thin_lto_import_instr_limit = rust.thin_lto_import_instr_limit;
1126 set(&mut config.rust_remap_debuginfo, rust.remap_debuginfo);
1127 set(&mut config.control_flow_guard, rust.control_flow_guard);
1128 config.llvm_libunwind_default = rust
1130 .map(|v| v.parse().expect("failed to parse rust.llvm-libunwind"));
1132 if let Some(ref backends) = rust.codegen_backends {
1133 config.rust_codegen_backends =
1134 backends.iter().map(|s| INTERNER.intern_str(s)).collect();
1137 config.rust_codegen_units = rust.codegen_units.map(threads_from_config);
1138 config.rust_codegen_units_std = rust.codegen_units_std.map(threads_from_config);
1139 config.rust_profile_use = flags.rust_profile_use.or(rust.profile_use);
1140 config.rust_profile_generate = flags.rust_profile_generate.or(rust.profile_generate);
1141 config.download_rustc_commit = download_ci_rustc_commit(&config, rust.download_rustc);
1143 config.rust_profile_use = flags.rust_profile_use;
1144 config.rust_profile_generate = flags.rust_profile_generate;
1147 if let Some(t) = toml.target {
1148 for (triple, cfg) in t {
1149 let mut target = Target::from_triple(&triple);
1151 if let Some(ref s) = cfg.llvm_config {
1152 target.llvm_config = Some(config.src.join(s));
1154 target.llvm_has_rust_patches = cfg.llvm_has_rust_patches;
1155 if let Some(ref s) = cfg.llvm_filecheck {
1156 target.llvm_filecheck = Some(config.src.join(s));
1158 target.llvm_libunwind = cfg
1161 .map(|v| v.parse().expect("failed to parse rust.llvm-libunwind"));
1162 if let Some(ref s) = cfg.android_ndk {
1163 target.ndk = Some(config.src.join(s));
1165 if let Some(s) = cfg.no_std {
1168 target.cc = cfg.cc.map(PathBuf::from);
1169 target.cxx = cfg.cxx.map(PathBuf::from);
1170 target.ar = cfg.ar.map(PathBuf::from);
1171 target.ranlib = cfg.ranlib.map(PathBuf::from);
1172 target.linker = cfg.linker.map(PathBuf::from);
1173 target.crt_static = cfg.crt_static;
1174 target.musl_root = cfg.musl_root.map(PathBuf::from);
1175 target.musl_libdir = cfg.musl_libdir.map(PathBuf::from);
1176 target.wasi_root = cfg.wasi_root.map(PathBuf::from);
1177 target.qemu_rootfs = cfg.qemu_rootfs.map(PathBuf::from);
1178 target.sanitizers = cfg.sanitizers;
1179 target.profiler = cfg.profiler;
1181 config.target_config.insert(TargetSelection::from_user(&triple), target);
1185 if config.llvm_from_ci {
1186 let triple = &config.build.triple;
1187 let ci_llvm_bin = config.ci_llvm_root().join("bin");
1188 let mut build_target = config
1190 .entry(config.build)
1191 .or_insert_with(|| Target::from_triple(&triple));
1193 check_ci_llvm!(build_target.llvm_config);
1194 check_ci_llvm!(build_target.llvm_filecheck);
1195 build_target.llvm_config = Some(ci_llvm_bin.join(exe("llvm-config", config.build)));
1196 build_target.llvm_filecheck = Some(ci_llvm_bin.join(exe("FileCheck", config.build)));
1199 if let Some(t) = toml.dist {
1200 config.dist_sign_folder = t.sign_folder.map(PathBuf::from);
1201 config.dist_upload_addr = t.upload_addr;
1202 config.dist_compression_formats = t.compression_formats;
1203 set(&mut config.rust_dist_src, t.src_tarball);
1204 set(&mut config.missing_tools, t.missing_tools);
1207 if let Some(r) = build.rustfmt {
1208 *config.initial_rustfmt.borrow_mut() = if r.exists() {
1209 RustfmtState::SystemToolchain(r)
1211 RustfmtState::Unavailable
1214 // If using a system toolchain for bootstrapping, see if that has rustfmt available.
1215 let host = config.build;
1216 let rustfmt_path = config.initial_rustc.with_file_name(exe("rustfmt", host));
1217 let bin_root = config.out.join(host.triple).join("stage0");
1218 if !rustfmt_path.starts_with(&bin_root) {
1219 // Using a system-provided toolchain; we shouldn't download rustfmt.
1220 *config.initial_rustfmt.borrow_mut() = RustfmtState::SystemToolchain(rustfmt_path);
1224 // Now that we've reached the end of our configuration, infer the
1225 // default values for all options that we haven't otherwise stored yet.
1227 config.llvm_skip_rebuild = llvm_skip_rebuild.unwrap_or(false);
1228 config.llvm_assertions = llvm_assertions.unwrap_or(false);
1229 config.llvm_tests = llvm_tests.unwrap_or(false);
1230 config.llvm_plugins = llvm_plugins.unwrap_or(false);
1231 config.rust_optimize = optimize.unwrap_or(true);
1233 let default = debug == Some(true);
1234 config.rust_debug_assertions = debug_assertions.unwrap_or(default);
1235 config.rust_debug_assertions_std =
1236 debug_assertions_std.unwrap_or(config.rust_debug_assertions);
1237 config.rust_overflow_checks = overflow_checks.unwrap_or(default);
1238 config.rust_overflow_checks_std =
1239 overflow_checks_std.unwrap_or(config.rust_overflow_checks);
1241 config.rust_debug_logging = debug_logging.unwrap_or(config.rust_debug_assertions);
1243 let with_defaults = |debuginfo_level_specific: Option<u32>| {
1244 debuginfo_level_specific.or(debuginfo_level).unwrap_or(if debug == Some(true) {
1250 config.rust_debuginfo_level_rustc = with_defaults(debuginfo_level_rustc);
1251 config.rust_debuginfo_level_std = with_defaults(debuginfo_level_std);
1252 config.rust_debuginfo_level_tools = with_defaults(debuginfo_level_tools);
1253 config.rust_debuginfo_level_tests = debuginfo_level_tests.unwrap_or(0);
1255 let default = config.channel == "dev";
1256 config.ignore_git = ignore_git.unwrap_or(default);
1258 let download_rustc = config.download_rustc_commit.is_some();
1259 // See https://github.com/rust-lang/compiler-team/issues/326
1260 config.stage = match config.cmd {
1261 Subcommand::Check { .. } => flags.stage.or(build.check_stage).unwrap_or(0),
1262 // `download-rustc` only has a speed-up for stage2 builds. Default to stage2 unless explicitly overridden.
1263 Subcommand::Doc { .. } => {
1264 flags.stage.or(build.doc_stage).unwrap_or(if download_rustc { 2 } else { 0 })
1266 Subcommand::Build { .. } => {
1267 flags.stage.or(build.build_stage).unwrap_or(if download_rustc { 2 } else { 1 })
1269 Subcommand::Test { .. } => {
1270 flags.stage.or(build.test_stage).unwrap_or(if download_rustc { 2 } else { 1 })
1272 Subcommand::Bench { .. } => flags.stage.or(build.bench_stage).unwrap_or(2),
1273 Subcommand::Dist { .. } => flags.stage.or(build.dist_stage).unwrap_or(2),
1274 Subcommand::Install { .. } => flags.stage.or(build.install_stage).unwrap_or(2),
1275 // These are all bootstrap tools, which don't depend on the compiler.
1276 // The stage we pass shouldn't matter, but use 0 just in case.
1277 Subcommand::Clean { .. }
1278 | Subcommand::Clippy { .. }
1279 | Subcommand::Fix { .. }
1280 | Subcommand::Run { .. }
1281 | Subcommand::Setup { .. }
1282 | Subcommand::Format { .. } => flags.stage.unwrap_or(0),
1285 // CI should always run stage 2 builds, unless it specifically states otherwise
1287 if flags.stage.is_none() && crate::CiEnv::current() != crate::CiEnv::None {
1289 Subcommand::Test { .. }
1290 | Subcommand::Doc { .. }
1291 | Subcommand::Build { .. }
1292 | Subcommand::Bench { .. }
1293 | Subcommand::Dist { .. }
1294 | Subcommand::Install { .. } => {
1297 "x.py should be run with `--stage 2` on CI, but was run with `--stage {}`",
1301 Subcommand::Clean { .. }
1302 | Subcommand::Check { .. }
1303 | Subcommand::Clippy { .. }
1304 | Subcommand::Fix { .. }
1305 | Subcommand::Run { .. }
1306 | Subcommand::Setup { .. }
1307 | Subcommand::Format { .. } => {}
1314 /// A git invocation which runs inside the source directory.
1316 /// Use this rather than `Command::new("git")` in order to support out-of-tree builds.
1317 pub(crate) fn git(&self) -> Command {
1318 let mut git = Command::new("git");
1319 git.current_dir(&self.src);
1323 pub(crate) fn artifact_channel(&self, commit: &str) -> String {
1324 let mut channel = self.git();
1325 channel.arg("show").arg(format!("{}:src/ci/channel", commit));
1326 let channel = output(&mut channel);
1327 channel.trim().to_owned()
1330 /// Try to find the relative path of `bindir`, otherwise return it in full.
1331 pub fn bindir_relative(&self) -> &Path {
1332 let bindir = &self.bindir;
1333 if bindir.is_absolute() {
1334 // Try to make it relative to the prefix.
1335 if let Some(prefix) = &self.prefix {
1336 if let Ok(stripped) = bindir.strip_prefix(prefix) {
1344 /// Try to find the relative path of `libdir`.
1345 pub fn libdir_relative(&self) -> Option<&Path> {
1346 let libdir = self.libdir.as_ref()?;
1347 if libdir.is_relative() {
1350 // Try to make it relative to the prefix.
1351 libdir.strip_prefix(self.prefix.as_ref()?).ok()
1355 /// The absolute path to the downloaded LLVM artifacts.
1356 pub(crate) fn ci_llvm_root(&self) -> PathBuf {
1357 assert!(self.llvm_from_ci);
1358 self.out.join(&*self.build.triple).join("ci-llvm")
1361 /// Determine whether llvm should be linked dynamically.
1363 /// If `false`, llvm should be linked statically.
1364 /// This is computed on demand since LLVM might have to first be downloaded from CI.
1365 pub(crate) fn llvm_link_shared(builder: &Builder<'_>) -> bool {
1366 let mut opt = builder.config.llvm_link_shared.get();
1367 if opt.is_none() && builder.config.dry_run {
1368 // just assume static for now - dynamic linking isn't supported on all platforms
1372 let llvm_link_shared = *opt.get_or_insert_with(|| {
1373 if builder.config.llvm_from_ci {
1374 crate::native::maybe_download_ci_llvm(builder);
1375 let ci_llvm = builder.config.ci_llvm_root();
1377 std::fs::read_to_string(ci_llvm.join("link-type.txt")),
1378 format!("CI llvm missing: {}", ci_llvm.display())
1380 link_type == "dynamic"
1382 // unclear how thought-through this default is, but it maintains compatibility with
1383 // previous behavior
1387 builder.config.llvm_link_shared.set(opt);
1391 /// Return whether we will use a downloaded, pre-compiled version of rustc, or just build from source.
1392 pub(crate) fn download_rustc(builder: &Builder<'_>) -> bool {
1393 static DOWNLOAD_RUSTC: OnceCell<bool> = OnceCell::new();
1394 if builder.config.dry_run && DOWNLOAD_RUSTC.get().is_none() {
1395 // avoid trying to actually download the commit
1399 *DOWNLOAD_RUSTC.get_or_init(|| match &builder.config.download_rustc_commit {
1402 download_ci_rustc(builder, commit);
1408 pub(crate) fn initial_rustfmt(builder: &Builder<'_>) -> Option<PathBuf> {
1409 match &mut *builder.config.initial_rustfmt.borrow_mut() {
1410 RustfmtState::SystemToolchain(p) | RustfmtState::Downloaded(p) => Some(p.clone()),
1411 RustfmtState::Unavailable => None,
1412 r @ RustfmtState::LazyEvaluated => {
1413 if builder.config.dry_run {
1414 return Some(PathBuf::new());
1416 let path = maybe_download_rustfmt(builder);
1417 *r = if let Some(p) = &path {
1418 RustfmtState::Downloaded(p.clone())
1420 RustfmtState::Unavailable
1427 pub fn verbose(&self) -> bool {
1431 pub fn sanitizers_enabled(&self, target: TargetSelection) -> bool {
1432 self.target_config.get(&target).map(|t| t.sanitizers).flatten().unwrap_or(self.sanitizers)
1435 pub fn any_sanitizers_enabled(&self) -> bool {
1436 self.target_config.values().any(|t| t.sanitizers == Some(true)) || self.sanitizers
1439 pub fn profiler_enabled(&self, target: TargetSelection) -> bool {
1440 self.target_config.get(&target).map(|t| t.profiler).flatten().unwrap_or(self.profiler)
1443 pub fn any_profiler_enabled(&self) -> bool {
1444 self.target_config.values().any(|t| t.profiler == Some(true)) || self.profiler
1447 pub fn llvm_enabled(&self) -> bool {
1448 self.rust_codegen_backends.contains(&INTERNER.intern_str("llvm"))
1451 pub fn llvm_libunwind(&self, target: TargetSelection) -> LlvmLibunwind {
1454 .and_then(|t| t.llvm_libunwind)
1455 .or(self.llvm_libunwind_default)
1456 .unwrap_or(if target.contains("fuchsia") {
1457 LlvmLibunwind::InTree
1463 pub fn submodules(&self, rust_info: &GitInfo) -> bool {
1464 self.submodules.unwrap_or(rust_info.is_git())
1468 fn set<T>(field: &mut T, val: Option<T>) {
1469 if let Some(v) = val {
1474 fn threads_from_config(v: u32) -> u32 {
1476 0 => std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get) as u32,
1481 /// Returns the commit to download, or `None` if we shouldn't download CI artifacts.
1482 fn download_ci_rustc_commit(
1484 download_rustc: Option<StringOrBool>,
1485 ) -> Option<String> {
1486 // If `download-rustc` is not set, default to rebuilding.
1487 let if_unchanged = match download_rustc {
1488 None | Some(StringOrBool::Bool(false)) => return None,
1489 Some(StringOrBool::Bool(true)) => false,
1490 Some(StringOrBool::String(s)) if s == "if-unchanged" => true,
1491 Some(StringOrBool::String(other)) => {
1492 panic!("unrecognized option for download-rustc: {}", other)
1496 // Handle running from a directory other than the top level
1497 let top_level = output(config.git().args(&["rev-parse", "--show-toplevel"]));
1498 let top_level = top_level.trim_end();
1499 let compiler = format!("{top_level}/compiler/");
1500 let library = format!("{top_level}/library/");
1502 // Look for a version to compare to based on the current commit.
1503 // Only commits merged by bors will have CI artifacts.
1504 let merge_base = output(
1508 .arg(format!("--author={}", config.stage0_metadata.config.git_merge_commit_email))
1509 .args(&["-n1", "--first-parent", "HEAD"]),
1511 let commit = merge_base.trim_end();
1512 if commit.is_empty() {
1513 println!("error: could not find commit hash for downloading rustc");
1514 println!("help: maybe your repository history is too shallow?");
1515 println!("help: consider disabling `download-rustc`");
1516 println!("help: or fetch enough history to include one upstream commit");
1517 crate::detail_exit(1);
1520 // Warn if there were changes to the compiler or standard library since the ancestor commit.
1521 let has_changes = !t!(config
1523 .args(&["diff-index", "--quiet", &commit, "--", &compiler, &library])
1528 if config.verbose > 0 {
1530 "warning: saw changes to compiler/ or library/ since {commit}; \
1531 ignoring `download-rustc`"
1537 "warning: `download-rustc` is enabled, but there are changes to \
1538 compiler/ or library/"
1542 Some(commit.to_string())
1545 fn maybe_download_rustfmt(builder: &Builder<'_>) -> Option<PathBuf> {
1546 let RustfmtMetadata { date, version } = builder.config.stage0_metadata.rustfmt.as_ref()?;
1547 let channel = format!("{version}-{date}");
1549 let host = builder.config.build;
1550 let rustfmt_path = builder.config.initial_rustc.with_file_name(exe("rustfmt", host));
1551 let bin_root = builder.config.out.join(host.triple).join("stage0");
1552 let rustfmt_stamp = bin_root.join(".rustfmt-stamp");
1553 if rustfmt_path.exists() && !program_out_of_date(&rustfmt_stamp, &channel) {
1554 return Some(rustfmt_path);
1557 let filename = format!("rustfmt-{version}-{build}.tar.xz", build = host.triple);
1558 download_component(builder, DownloadSource::Dist, filename, "rustfmt-preview", &date, "stage0");
1560 builder.fix_bin_or_dylib(&bin_root.join("bin").join("rustfmt"));
1561 builder.fix_bin_or_dylib(&bin_root.join("bin").join("cargo-fmt"));
1563 builder.create(&rustfmt_stamp, &channel);
1567 fn download_ci_rustc(builder: &Builder<'_>, commit: &str) {
1568 builder.verbose(&format!("using downloaded stage2 artifacts from CI (commit {commit})"));
1569 let channel = builder.config.artifact_channel(commit);
1570 let host = builder.config.build.triple;
1571 let bin_root = builder.out.join(host).join("ci-rustc");
1572 let rustc_stamp = bin_root.join(".rustc-stamp");
1574 if !bin_root.join("bin").join("rustc").exists() || program_out_of_date(&rustc_stamp, commit) {
1575 if bin_root.exists() {
1576 t!(fs::remove_dir_all(&bin_root));
1578 let filename = format!("rust-std-{channel}-{host}.tar.xz");
1579 let pattern = format!("rust-std-{host}");
1580 download_ci_component(builder, filename, &pattern, commit);
1581 let filename = format!("rustc-{channel}-{host}.tar.xz");
1582 download_ci_component(builder, filename, "rustc", commit);
1583 // download-rustc doesn't need its own cargo, it can just use beta's.
1584 let filename = format!("rustc-dev-{channel}-{host}.tar.xz");
1585 download_ci_component(builder, filename, "rustc-dev", commit);
1587 builder.fix_bin_or_dylib(&bin_root.join("bin").join("rustc"));
1588 builder.fix_bin_or_dylib(&bin_root.join("bin").join("rustdoc"));
1589 let lib_dir = bin_root.join("lib");
1590 for lib in t!(fs::read_dir(&lib_dir), lib_dir.display().to_string()) {
1592 if lib.path().extension() == Some(OsStr::new("so")) {
1593 builder.fix_bin_or_dylib(&lib.path());
1596 t!(fs::write(rustc_stamp, commit));
1600 pub(crate) enum DownloadSource {
1605 /// Download a single component of a CI-built toolchain (not necessarily a published nightly).
1606 // NOTE: intentionally takes an owned string to avoid downloading multiple times by accident
1607 fn download_ci_component(builder: &Builder<'_>, filename: String, prefix: &str, commit: &str) {
1608 download_component(builder, DownloadSource::CI, filename, prefix, commit, "ci-rustc")
1611 fn download_component(
1612 builder: &Builder<'_>,
1613 mode: DownloadSource,
1619 let cache_dst = builder.out.join("cache");
1620 let cache_dir = cache_dst.join(key);
1621 if !cache_dir.exists() {
1622 t!(fs::create_dir_all(&cache_dir));
1625 let bin_root = builder.out.join(builder.config.build.triple).join(destination);
1626 let tarball = cache_dir.join(&filename);
1627 let (base_url, url, should_verify) = match mode {
1628 DownloadSource::CI => (
1629 builder.config.stage0_metadata.config.artifacts_server.clone(),
1630 format!("{key}/{filename}"),
1633 DownloadSource::Dist => {
1634 let dist_server = env::var("RUSTUP_DIST_SERVER")
1635 .unwrap_or(builder.config.stage0_metadata.config.dist_server.to_string());
1636 // NOTE: make `dist` part of the URL because that's how it's stored in src/stage0.json
1637 (dist_server, format!("dist/{key}/{filename}"), true)
1641 // For the beta compiler, put special effort into ensuring the checksums are valid.
1642 // FIXME: maybe we should do this for download-rustc as well? but it would be a pain to update
1643 // this on each and every nightly ...
1644 let checksum = if should_verify {
1645 let error = format!(
1646 "src/stage0.json doesn't contain a checksum for {url}. \
1647 Pre-built artifacts might not be available for this \
1648 target at this time, see https://doc.rust-lang.org/nightly\
1649 /rustc/platform-support.html for more information."
1651 let sha256 = builder.config.stage0_metadata.checksums_sha256.get(&url).expect(&error);
1652 if tarball.exists() {
1653 if builder.verify(&tarball, sha256) {
1654 builder.unpack(&tarball, &bin_root, prefix);
1657 builder.verbose(&format!(
1658 "ignoring cached file {} due to failed verification",
1661 builder.remove(&tarball);
1665 } else if tarball.exists() {
1666 builder.unpack(&tarball, &bin_root, prefix);
1672 builder.download_component(&format!("{base_url}/{url}"), &tarball, "");
1673 if let Some(sha256) = checksum {
1674 if !builder.verify(&tarball, sha256) {
1675 panic!("failed to verify {}", tarball.display());
1679 builder.unpack(&tarball, &bin_root, prefix);