1 //! Serialized configuration of a build.
3 //! This module implements parsing `config.toml` configuration files to tweak
4 //! how the build runs.
7 use std::collections::{HashMap, HashSet};
11 use std::path::{Path, PathBuf};
12 use std::str::FromStr;
14 use crate::builder::TaskPath;
15 use crate::cache::{Interned, INTERNER};
16 use crate::channel::GitInfo;
17 pub use crate::flags::Subcommand;
18 use crate::flags::{Color, Flags};
19 use crate::util::{exe, t};
20 use serde::Deserialize;
22 macro_rules! check_ci_llvm {
26 "setting {} is incompatible with download-ci-llvm.",
32 /// Global configuration for the entire build and/or bootstrap.
34 /// This structure is derived from a combination of both `config.toml` and
35 /// `config.mk`. As of the time of this writing it's unlikely that `config.toml`
36 /// is used all that much, so this is primarily filled out by `config.mk` which
37 /// is generated from `./configure`.
39 /// Note that this structure is not decoded directly into, but rather it is
40 /// filled out from the decoded forms of the structs below. For documentation
41 /// each field, see the corresponding fields in
42 /// `config.toml.example`.
45 pub changelog_seen: Option<usize>,
46 pub ccache: Option<String>,
47 /// Call Build::ninja() instead of this.
48 pub ninja_in_file: bool,
50 pub submodules: Option<bool>,
51 pub fast_submodules: bool,
52 pub compiler_docs: bool,
53 pub docs_minification: bool,
55 pub locked_deps: bool,
57 pub target_config: HashMap<TargetSelection, Target>,
58 pub full_bootstrap: bool,
60 pub tools: Option<HashSet<String>>,
64 pub exclude: Vec<TaskPath>,
65 pub include_default_paths: bool,
66 pub rustc_error_format: Option<String>,
67 pub json_output: bool,
68 pub test_compare_mode: bool,
69 pub llvm_libunwind: LlvmLibunwind,
72 pub on_fail: Option<String>,
74 pub keep_stage: Vec<u32>,
75 pub keep_stage_std: Vec<u32>,
77 // defaults to `config.toml`
79 pub jobs: Option<u32>,
81 pub incremental: bool,
83 pub download_rustc: bool,
85 pub deny_warnings: bool,
86 pub backtrace_on_ice: bool,
88 // llvm codegen options
89 pub llvm_skip_rebuild: bool,
90 pub llvm_assertions: bool,
92 pub llvm_plugins: bool,
93 pub llvm_optimize: bool,
94 pub llvm_thin_lto: bool,
95 pub llvm_release_debuginfo: bool,
96 pub llvm_version_check: bool,
97 pub llvm_static_stdcpp: bool,
98 pub llvm_link_shared: bool,
99 pub llvm_clang_cl: Option<String>,
100 pub llvm_targets: Option<String>,
101 pub llvm_experimental_targets: Option<String>,
102 pub llvm_link_jobs: Option<u32>,
103 pub llvm_version_suffix: Option<String>,
104 pub llvm_use_linker: Option<String>,
105 pub llvm_allow_old_toolchain: bool,
106 pub llvm_polly: bool,
107 pub llvm_clang: bool,
108 pub llvm_from_ci: bool,
109 pub llvm_build_config: HashMap<String, String>,
112 pub lld_enabled: bool,
113 pub llvm_tools_enabled: bool,
115 pub llvm_cflags: Option<String>,
116 pub llvm_cxxflags: Option<String>,
117 pub llvm_ldflags: Option<String>,
118 pub llvm_use_libcxx: bool,
120 // rust codegen options
121 pub rust_optimize: bool,
122 pub rust_codegen_units: Option<u32>,
123 pub rust_codegen_units_std: Option<u32>,
124 pub rust_debug_assertions: bool,
125 pub rust_debug_assertions_std: bool,
126 pub rust_overflow_checks: bool,
127 pub rust_overflow_checks_std: bool,
128 pub rust_debug_logging: bool,
129 pub rust_debuginfo_level_rustc: u32,
130 pub rust_debuginfo_level_std: u32,
131 pub rust_debuginfo_level_tools: u32,
132 pub rust_debuginfo_level_tests: u32,
133 pub rust_run_dsymutil: bool,
134 pub rust_rpath: bool,
135 pub rustc_parallel: bool,
136 pub rustc_default_linker: Option<String>,
137 pub rust_optimize_tests: bool,
138 pub rust_dist_src: bool,
139 pub rust_codegen_backends: Vec<Interned<String>>,
140 pub rust_verify_llvm_ir: bool,
141 pub rust_thin_lto_import_instr_limit: Option<u32>,
142 pub rust_remap_debuginfo: bool,
143 pub rust_new_symbol_mangling: Option<bool>,
144 pub rust_profile_use: Option<String>,
145 pub rust_profile_generate: Option<String>,
146 pub llvm_profile_use: Option<String>,
147 pub llvm_profile_generate: bool,
149 pub build: TargetSelection,
150 pub hosts: Vec<TargetSelection>,
151 pub targets: Vec<TargetSelection>,
152 pub local_rebuild: bool,
154 pub control_flow_guard: bool,
157 pub dist_sign_folder: Option<PathBuf>,
158 pub dist_upload_addr: Option<String>,
159 pub dist_compression_formats: Option<Vec<String>>,
162 pub backtrace: bool, // support for RUST_BACKTRACE
165 pub low_priority: bool,
167 pub description: Option<String>,
168 pub verbose_tests: bool,
169 pub save_toolstates: Option<PathBuf>,
170 pub print_step_timings: bool,
171 pub print_step_rusage: bool,
172 pub missing_tools: bool,
174 // Fallback musl-root for all targets
175 pub musl_root: Option<PathBuf>,
176 pub prefix: Option<PathBuf>,
177 pub sysconfdir: Option<PathBuf>,
178 pub datadir: Option<PathBuf>,
179 pub docdir: Option<PathBuf>,
181 pub libdir: Option<PathBuf>,
182 pub mandir: Option<PathBuf>,
183 pub codegen_tests: bool,
184 pub nodejs: Option<PathBuf>,
185 pub npm: Option<PathBuf>,
186 pub gdb: Option<PathBuf>,
187 pub python: Option<PathBuf>,
188 pub cargo_native_static: bool,
189 pub configure_args: Vec<String>,
191 // These are either the stage0 downloaded binaries or the locally installed ones.
192 pub initial_cargo: PathBuf,
193 pub initial_rustc: PathBuf,
194 pub initial_rustfmt: Option<PathBuf>,
198 #[derive(Debug, Clone, Copy, PartialEq)]
199 pub enum LlvmLibunwind {
205 impl Default for LlvmLibunwind {
206 fn default() -> Self {
211 impl FromStr for LlvmLibunwind {
214 fn from_str(value: &str) -> Result<Self, Self::Err> {
216 "no" => Ok(Self::No),
217 "in-tree" => Ok(Self::InTree),
218 "system" => Ok(Self::System),
219 invalid => Err(format!("Invalid value '{}' for rust.llvm-libunwind config.", invalid)),
224 #[derive(Debug, Copy, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
225 pub struct TargetSelection {
226 pub triple: Interned<String>,
227 file: Option<Interned<String>>,
230 impl TargetSelection {
231 pub fn from_user(selection: &str) -> Self {
232 let path = Path::new(selection);
234 let (triple, file) = if path.exists() {
237 .expect("Target specification file has no file stem")
239 .expect("Target specification file stem is not UTF-8");
241 (triple, Some(selection))
246 let triple = INTERNER.intern_str(triple);
247 let file = file.map(|f| INTERNER.intern_str(f));
249 Self { triple, file }
252 pub fn rustc_target_arg(&self) -> &str {
253 self.file.as_ref().unwrap_or(&self.triple)
256 pub fn contains(&self, needle: &str) -> bool {
257 self.triple.contains(needle)
260 pub fn starts_with(&self, needle: &str) -> bool {
261 self.triple.starts_with(needle)
264 pub fn ends_with(&self, needle: &str) -> bool {
265 self.triple.ends_with(needle)
269 impl fmt::Display for TargetSelection {
270 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
271 write!(f, "{}", self.triple)?;
272 if let Some(file) = self.file {
273 write!(f, "({})", file)?;
279 impl PartialEq<&str> for TargetSelection {
280 fn eq(&self, other: &&str) -> bool {
281 self.triple == *other
285 /// Per-target configuration stored in the global configuration structure.
288 /// Some(path to llvm-config) if using an external LLVM.
289 pub llvm_config: Option<PathBuf>,
290 /// Some(path to FileCheck) if one was specified.
291 pub llvm_filecheck: Option<PathBuf>,
292 pub cc: Option<PathBuf>,
293 pub cxx: Option<PathBuf>,
294 pub ar: Option<PathBuf>,
295 pub ranlib: Option<PathBuf>,
296 pub default_linker: Option<PathBuf>,
297 pub linker: Option<PathBuf>,
298 pub ndk: Option<PathBuf>,
299 pub sanitizers: Option<bool>,
300 pub profiler: Option<bool>,
301 pub crt_static: Option<bool>,
302 pub musl_root: Option<PathBuf>,
303 pub musl_libdir: Option<PathBuf>,
304 pub wasi_root: Option<PathBuf>,
305 pub qemu_rootfs: Option<PathBuf>,
310 pub fn from_triple(triple: &str) -> Self {
311 let mut target: Self = Default::default();
312 if triple.contains("-none") || triple.contains("nvptx") {
313 target.no_std = true;
318 /// Structure of the `config.toml` file that configuration is read from.
320 /// This structure uses `Decodable` to automatically decode a TOML configuration
321 /// file into this format, and then this is traversed and written into the above
322 /// `Config` structure.
323 #[derive(Deserialize, Default)]
324 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
326 changelog_seen: Option<usize>,
327 build: Option<Build>,
328 install: Option<Install>,
331 target: Option<HashMap<String, TomlTarget>>,
333 profile: Option<String>,
337 fn merge(&mut self, other: Self);
340 impl Merge for TomlConfig {
343 TomlConfig { build, install, llvm, rust, dist, target, profile: _, changelog_seen: _ }: Self,
345 fn do_merge<T: Merge>(x: &mut Option<T>, y: Option<T>) {
346 if let Some(new) = y {
347 if let Some(original) = x {
354 do_merge(&mut self.build, build);
355 do_merge(&mut self.install, install);
356 do_merge(&mut self.llvm, llvm);
357 do_merge(&mut self.rust, rust);
358 do_merge(&mut self.dist, dist);
359 assert!(target.is_none(), "merging target-specific config is not currently supported");
363 // We are using a decl macro instead of a derive proc macro here to reduce the compile time of
365 macro_rules! derive_merge {
366 ($(#[$attr:meta])* struct $name:ident {
367 $($field:ident: $field_ty:ty,)*
371 $($field: $field_ty,)*
374 impl Merge for $name {
375 fn merge(&mut self, other: Self) {
377 if !self.$field.is_some() {
378 self.$field = other.$field;
387 /// TOML representation of various global build decisions.
388 #[derive(Deserialize, Default)]
389 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
391 build: Option<String>,
392 host: Option<Vec<String>>,
393 target: Option<Vec<String>>,
394 build_dir: Option<String>,
395 cargo: Option<String>,
396 rustc: Option<String>,
397 rustfmt: Option<PathBuf>,
399 compiler_docs: Option<bool>,
400 docs_minification: Option<bool>,
401 submodules: Option<bool>,
402 fast_submodules: Option<bool>,
404 nodejs: Option<String>,
406 python: Option<String>,
407 locked_deps: Option<bool>,
408 vendor: Option<bool>,
409 full_bootstrap: Option<bool>,
410 extended: Option<bool>,
411 tools: Option<HashSet<String>>,
412 verbose: Option<usize>,
413 sanitizers: Option<bool>,
414 profiler: Option<bool>,
415 cargo_native_static: Option<bool>,
416 low_priority: Option<bool>,
417 configure_args: Option<Vec<String>>,
418 local_rebuild: Option<bool>,
419 print_step_timings: Option<bool>,
420 print_step_rusage: Option<bool>,
421 check_stage: Option<u32>,
422 doc_stage: Option<u32>,
423 build_stage: Option<u32>,
424 test_stage: Option<u32>,
425 install_stage: Option<u32>,
426 dist_stage: Option<u32>,
427 bench_stage: Option<u32>,
428 patch_binaries_for_nix: Option<bool>,
433 /// TOML representation of various global install decisions.
434 #[derive(Deserialize)]
435 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
437 prefix: Option<String>,
438 sysconfdir: Option<String>,
439 docdir: Option<String>,
440 bindir: Option<String>,
441 libdir: Option<String>,
442 mandir: Option<String>,
443 datadir: Option<String>,
448 /// TOML representation of how the LLVM build is configured.
449 #[derive(Deserialize)]
450 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
452 skip_rebuild: Option<bool>,
453 optimize: Option<bool>,
454 thin_lto: Option<bool>,
455 release_debuginfo: Option<bool>,
456 assertions: Option<bool>,
458 plugins: Option<bool>,
459 ccache: Option<StringOrBool>,
460 version_check: Option<bool>,
461 static_libstdcpp: Option<bool>,
463 targets: Option<String>,
464 experimental_targets: Option<String>,
465 link_jobs: Option<u32>,
466 link_shared: Option<bool>,
467 version_suffix: Option<String>,
468 clang_cl: Option<String>,
469 cflags: Option<String>,
470 cxxflags: Option<String>,
471 ldflags: Option<String>,
472 use_libcxx: Option<bool>,
473 use_linker: Option<String>,
474 allow_old_toolchain: Option<bool>,
477 download_ci_llvm: Option<StringOrBool>,
478 build_config: Option<HashMap<String, String>>,
483 #[derive(Deserialize)]
484 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
486 sign_folder: Option<String>,
487 gpg_password_file: Option<String>,
488 upload_addr: Option<String>,
489 src_tarball: Option<bool>,
490 missing_tools: Option<bool>,
491 compression_formats: Option<Vec<String>>,
495 #[derive(Deserialize)]
502 impl Default for StringOrBool {
503 fn default() -> StringOrBool {
504 StringOrBool::Bool(false)
509 /// TOML representation of how the Rust build is configured.
510 #[derive(Deserialize)]
511 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
513 optimize: Option<bool>,
515 codegen_units: Option<u32>,
516 codegen_units_std: Option<u32>,
517 debug_assertions: Option<bool>,
518 debug_assertions_std: Option<bool>,
519 overflow_checks: Option<bool>,
520 overflow_checks_std: Option<bool>,
521 debug_logging: Option<bool>,
522 debuginfo_level: Option<u32>,
523 debuginfo_level_rustc: Option<u32>,
524 debuginfo_level_std: Option<u32>,
525 debuginfo_level_tools: Option<u32>,
526 debuginfo_level_tests: Option<u32>,
527 run_dsymutil: Option<bool>,
528 backtrace: Option<bool>,
529 incremental: Option<bool>,
530 parallel_compiler: Option<bool>,
531 default_linker: Option<String>,
532 channel: Option<String>,
533 description: Option<String>,
534 musl_root: Option<String>,
536 verbose_tests: Option<bool>,
537 optimize_tests: Option<bool>,
538 codegen_tests: Option<bool>,
539 ignore_git: Option<bool>,
540 dist_src: Option<bool>,
541 save_toolstates: Option<String>,
542 codegen_backends: Option<Vec<String>>,
544 use_lld: Option<bool>,
545 llvm_tools: Option<bool>,
546 deny_warnings: Option<bool>,
547 backtrace_on_ice: Option<bool>,
548 verify_llvm_ir: Option<bool>,
549 thin_lto_import_instr_limit: Option<u32>,
550 remap_debuginfo: Option<bool>,
551 jemalloc: Option<bool>,
552 test_compare_mode: Option<bool>,
553 llvm_libunwind: Option<String>,
554 control_flow_guard: Option<bool>,
555 new_symbol_mangling: Option<bool>,
556 profile_generate: Option<String>,
557 profile_use: Option<String>,
558 // ignored; this is set from an env var set by bootstrap.py
559 download_rustc: Option<StringOrBool>,
564 /// TOML representation of how each build target is configured.
565 #[derive(Deserialize)]
566 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
571 ranlib: Option<String>,
572 default_linker: Option<PathBuf>,
573 linker: Option<String>,
574 llvm_config: Option<String>,
575 llvm_filecheck: Option<String>,
576 android_ndk: Option<String>,
577 sanitizers: Option<bool>,
578 profiler: Option<bool>,
579 crt_static: Option<bool>,
580 musl_root: Option<String>,
581 musl_libdir: Option<String>,
582 wasi_root: Option<String>,
583 qemu_rootfs: Option<String>,
584 no_std: Option<bool>,
589 pub fn default_opts() -> Config {
590 let mut config = Config::default();
591 config.llvm_optimize = true;
592 config.ninja_in_file = true;
593 config.llvm_version_check = true;
594 config.backtrace = true;
595 config.rust_optimize = true;
596 config.rust_optimize_tests = true;
597 config.submodules = None;
598 config.fast_submodules = true;
600 config.docs_minification = true;
601 config.rust_rpath = true;
602 config.channel = "dev".to_string();
603 config.codegen_tests = true;
604 config.rust_dist_src = true;
605 config.rust_codegen_backends = vec![INTERNER.intern_str("llvm")];
606 config.deny_warnings = true;
607 config.bindir = "bin".into();
610 config.build = TargetSelection::from_user(&env!("BUILD_TRIPLE"));
611 let manifest_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
612 // Undo `src/bootstrap`
613 config.src = manifest_dir.parent().unwrap().parent().unwrap().to_owned();
614 config.out = PathBuf::from("build");
616 config.initial_cargo = PathBuf::from(env!("CARGO"));
617 config.initial_rustc = PathBuf::from(env!("RUSTC"));
622 pub fn parse(args: &[String]) -> Config {
623 let flags = Flags::parse(&args);
625 let mut config = Config::default_opts();
626 config.exclude = flags.exclude.into_iter().map(|path| TaskPath::parse(path)).collect();
627 config.include_default_paths = flags.include_default_paths;
628 config.rustc_error_format = flags.rustc_error_format;
629 config.json_output = flags.json_output;
630 config.on_fail = flags.on_fail;
631 config.jobs = flags.jobs.map(threads_from_config);
632 config.cmd = flags.cmd;
633 config.incremental = flags.incremental;
634 config.dry_run = flags.dry_run;
635 config.keep_stage = flags.keep_stage;
636 config.keep_stage_std = flags.keep_stage_std;
637 config.color = flags.color;
638 if let Some(value) = flags.deny_warnings {
639 config.deny_warnings = value;
641 config.llvm_profile_use = flags.llvm_profile_use;
642 config.llvm_profile_generate = flags.llvm_profile_generate;
645 let get_toml = |_| TomlConfig::default();
647 let get_toml = |file: &Path| {
651 t!(fs::read_to_string(file), format!("config file {} not found", file.display()));
652 match toml::from_str(&contents) {
655 println!("failed to parse TOML configuration '{}': {}", file.display(), err);
661 // Read from `--config`, then `RUST_BOOTSTRAP_CONFIG`, then `./config.toml`, then `config.toml` in the root directory.
662 let toml_path = flags
665 .or_else(|| env::var_os("RUST_BOOTSTRAP_CONFIG").map(PathBuf::from));
666 let using_default_path = toml_path.is_none();
667 let mut toml_path = toml_path.unwrap_or_else(|| PathBuf::from("config.toml"));
668 if using_default_path && !toml_path.exists() {
669 toml_path = config.src.join(toml_path);
672 // Give a hard error if `--config` or `RUST_BOOTSTRAP_CONFIG` are set to a missing path,
673 // but not if `config.toml` hasn't been created.
674 let mut toml = if !using_default_path || toml_path.exists() {
677 TomlConfig::default()
680 if let Some(include) = &toml.profile {
681 let mut include_path = config.src.clone();
682 include_path.push("src");
683 include_path.push("bootstrap");
684 include_path.push("defaults");
685 include_path.push(format!("config.{}.toml", include));
686 let included_toml = get_toml(&include_path);
687 toml.merge(included_toml);
690 config.changelog_seen = toml.changelog_seen;
691 config.config = toml_path;
693 let build = toml.build.unwrap_or_default();
695 set(&mut config.initial_rustc, build.rustc.map(PathBuf::from));
696 set(&mut config.out, build.build_dir.map(PathBuf::from));
697 // NOTE: Bootstrap spawns various commands with different working directories.
698 // To avoid writing to random places on the file system, `config.out` needs to be an absolute path.
699 if !config.out.is_absolute() {
700 // `canonicalize` requires the path to already exist. Use our vendored copy of `absolute` instead.
701 config.out = crate::util::absolute(&config.out);
705 let dir = config.out.join("tmp-dry-run");
706 t!(fs::create_dir_all(&dir));
710 config.hosts = if let Some(arg_host) = flags.host {
712 } else if let Some(file_host) = build.host {
713 file_host.iter().map(|h| TargetSelection::from_user(h)).collect()
717 config.targets = if let Some(arg_target) = flags.target {
719 } else if let Some(file_target) = build.target {
720 file_target.iter().map(|h| TargetSelection::from_user(h)).collect()
722 // If target is *not* configured, then default to the host
727 config.nodejs = build.nodejs.map(PathBuf::from);
728 config.npm = build.npm.map(PathBuf::from);
729 config.gdb = build.gdb.map(PathBuf::from);
730 config.python = build.python.map(PathBuf::from);
731 config.submodules = build.submodules;
732 set(&mut config.low_priority, build.low_priority);
733 set(&mut config.compiler_docs, build.compiler_docs);
734 set(&mut config.docs_minification, build.docs_minification);
735 set(&mut config.docs, build.docs);
736 set(&mut config.fast_submodules, build.fast_submodules);
737 set(&mut config.locked_deps, build.locked_deps);
738 set(&mut config.vendor, build.vendor);
739 set(&mut config.full_bootstrap, build.full_bootstrap);
740 set(&mut config.extended, build.extended);
741 config.tools = build.tools;
742 if build.rustfmt.is_some() {
743 config.initial_rustfmt = build.rustfmt;
745 set(&mut config.verbose, build.verbose);
746 set(&mut config.sanitizers, build.sanitizers);
747 set(&mut config.profiler, build.profiler);
748 set(&mut config.cargo_native_static, build.cargo_native_static);
749 set(&mut config.configure_args, build.configure_args);
750 set(&mut config.local_rebuild, build.local_rebuild);
751 set(&mut config.print_step_timings, build.print_step_timings);
752 set(&mut config.print_step_rusage, build.print_step_rusage);
754 config.verbose = cmp::max(config.verbose, flags.verbose);
756 if let Some(install) = toml.install {
757 config.prefix = install.prefix.map(PathBuf::from);
758 config.sysconfdir = install.sysconfdir.map(PathBuf::from);
759 config.datadir = install.datadir.map(PathBuf::from);
760 config.docdir = install.docdir.map(PathBuf::from);
761 set(&mut config.bindir, install.bindir.map(PathBuf::from));
762 config.libdir = install.libdir.map(PathBuf::from);
763 config.mandir = install.mandir.map(PathBuf::from);
766 // We want the llvm-skip-rebuild flag to take precedence over the
767 // skip-rebuild config.toml option so we store it separately
768 // so that we can infer the right value
769 let mut llvm_skip_rebuild = flags.llvm_skip_rebuild;
771 // Store off these values as options because if they're not provided
772 // we'll infer default values for them later
773 let mut llvm_assertions = None;
774 let mut llvm_tests = None;
775 let mut llvm_plugins = None;
776 let mut debug = None;
777 let mut debug_assertions = None;
778 let mut debug_assertions_std = None;
779 let mut overflow_checks = None;
780 let mut overflow_checks_std = None;
781 let mut debug_logging = None;
782 let mut debuginfo_level = None;
783 let mut debuginfo_level_rustc = None;
784 let mut debuginfo_level_std = None;
785 let mut debuginfo_level_tools = None;
786 let mut debuginfo_level_tests = None;
787 let mut optimize = None;
788 let mut ignore_git = None;
790 if let Some(llvm) = toml.llvm {
792 Some(StringOrBool::String(ref s)) => config.ccache = Some(s.to_string()),
793 Some(StringOrBool::Bool(true)) => {
794 config.ccache = Some("ccache".to_string());
796 Some(StringOrBool::Bool(false)) | None => {}
798 set(&mut config.ninja_in_file, llvm.ninja);
799 llvm_assertions = llvm.assertions;
800 llvm_tests = llvm.tests;
801 llvm_plugins = llvm.plugins;
802 llvm_skip_rebuild = llvm_skip_rebuild.or(llvm.skip_rebuild);
803 set(&mut config.llvm_optimize, llvm.optimize);
804 set(&mut config.llvm_thin_lto, llvm.thin_lto);
805 set(&mut config.llvm_release_debuginfo, llvm.release_debuginfo);
806 set(&mut config.llvm_version_check, llvm.version_check);
807 set(&mut config.llvm_static_stdcpp, llvm.static_libstdcpp);
808 set(&mut config.llvm_link_shared, llvm.link_shared);
809 config.llvm_targets = llvm.targets.clone();
810 config.llvm_experimental_targets = llvm.experimental_targets.clone();
811 config.llvm_link_jobs = llvm.link_jobs;
812 config.llvm_version_suffix = llvm.version_suffix.clone();
813 config.llvm_clang_cl = llvm.clang_cl.clone();
815 config.llvm_cflags = llvm.cflags.clone();
816 config.llvm_cxxflags = llvm.cxxflags.clone();
817 config.llvm_ldflags = llvm.ldflags.clone();
818 set(&mut config.llvm_use_libcxx, llvm.use_libcxx);
819 config.llvm_use_linker = llvm.use_linker.clone();
820 config.llvm_allow_old_toolchain = llvm.allow_old_toolchain.unwrap_or(false);
821 config.llvm_polly = llvm.polly.unwrap_or(false);
822 config.llvm_clang = llvm.clang.unwrap_or(false);
823 config.llvm_build_config = llvm.build_config.clone().unwrap_or(Default::default());
824 config.llvm_from_ci = match llvm.download_ci_llvm {
825 Some(StringOrBool::String(s)) => {
826 assert!(s == "if-available", "unknown option `{}` for download-ci-llvm", s);
827 // This is currently all tier 1 targets and tier 2 targets with host tools
828 // (since others may not have CI artifacts)
829 // https://doc.rust-lang.org/rustc/platform-support.html#tier-1
830 // FIXME: this is duplicated in bootstrap.py
831 let supported_platforms = [
833 "aarch64-unknown-linux-gnu",
834 "i686-pc-windows-gnu",
835 "i686-pc-windows-msvc",
836 "i686-unknown-linux-gnu",
837 "x86_64-unknown-linux-gnu",
838 "x86_64-apple-darwin",
839 "x86_64-pc-windows-gnu",
840 "x86_64-pc-windows-msvc",
841 // tier 2 with host tools
842 "aarch64-apple-darwin",
843 "aarch64-pc-windows-msvc",
844 "aarch64-unknown-linux-musl",
845 "arm-unknown-linux-gnueabi",
846 "arm-unknown-linux-gnueabihf",
847 "armv7-unknown-linux-gnueabihf",
848 "mips-unknown-linux-gnu",
849 "mips64-unknown-linux-gnuabi64",
850 "mips64el-unknown-linux-gnuabi64",
851 "mipsel-unknown-linux-gnu",
852 "powerpc-unknown-linux-gnu",
853 "powerpc64-unknown-linux-gnu",
854 "powerpc64le-unknown-linux-gnu",
855 "riscv64gc-unknown-linux-gnu",
856 "s390x-unknown-linux-gnu",
857 "x86_64-unknown-freebsd",
858 "x86_64-unknown-illumos",
859 "x86_64-unknown-linux-musl",
860 "x86_64-unknown-netbsd",
862 supported_platforms.contains(&&*config.build.triple)
864 Some(StringOrBool::Bool(b)) => b,
868 if config.llvm_from_ci {
869 // None of the LLVM options, except assertions, are supported
870 // when using downloaded LLVM. We could just ignore these but
871 // that's potentially confusing, so force them to not be
872 // explicitly set. The defaults and CI defaults don't
873 // necessarily match but forcing people to match (somewhat
874 // arbitrary) CI configuration locally seems bad/hard.
875 check_ci_llvm!(llvm.optimize);
876 check_ci_llvm!(llvm.thin_lto);
877 check_ci_llvm!(llvm.release_debuginfo);
878 check_ci_llvm!(llvm.link_shared);
879 check_ci_llvm!(llvm.static_libstdcpp);
880 check_ci_llvm!(llvm.targets);
881 check_ci_llvm!(llvm.experimental_targets);
882 check_ci_llvm!(llvm.link_jobs);
883 check_ci_llvm!(llvm.clang_cl);
884 check_ci_llvm!(llvm.version_suffix);
885 check_ci_llvm!(llvm.cflags);
886 check_ci_llvm!(llvm.cxxflags);
887 check_ci_llvm!(llvm.ldflags);
888 check_ci_llvm!(llvm.use_libcxx);
889 check_ci_llvm!(llvm.use_linker);
890 check_ci_llvm!(llvm.allow_old_toolchain);
891 check_ci_llvm!(llvm.polly);
892 check_ci_llvm!(llvm.clang);
893 check_ci_llvm!(llvm.build_config);
894 check_ci_llvm!(llvm.plugins);
896 // CI-built LLVM can be either dynamic or static.
897 let ci_llvm = config.out.join(&*config.build.triple).join("ci-llvm");
898 config.llvm_link_shared = if config.dry_run {
899 // just assume dynamic for now
903 std::fs::read_to_string(ci_llvm.join("link-type.txt")),
904 format!("CI llvm missing: {}", ci_llvm.display())
906 link_type == "dynamic"
910 if config.llvm_thin_lto && llvm.link_shared.is_none() {
911 // If we're building with ThinLTO on, by default we want to link
912 // to LLVM shared, to avoid re-doing ThinLTO (which happens in
913 // the link step) with each stage.
914 config.llvm_link_shared = true;
918 if let Some(rust) = toml.rust {
920 debug_assertions = rust.debug_assertions;
921 debug_assertions_std = rust.debug_assertions_std;
922 overflow_checks = rust.overflow_checks;
923 overflow_checks_std = rust.overflow_checks_std;
924 debug_logging = rust.debug_logging;
925 debuginfo_level = rust.debuginfo_level;
926 debuginfo_level_rustc = rust.debuginfo_level_rustc;
927 debuginfo_level_std = rust.debuginfo_level_std;
928 debuginfo_level_tools = rust.debuginfo_level_tools;
929 debuginfo_level_tests = rust.debuginfo_level_tests;
930 config.rust_run_dsymutil = rust.run_dsymutil.unwrap_or(false);
931 optimize = rust.optimize;
932 ignore_git = rust.ignore_git;
933 config.rust_new_symbol_mangling = rust.new_symbol_mangling;
934 set(&mut config.rust_optimize_tests, rust.optimize_tests);
935 set(&mut config.codegen_tests, rust.codegen_tests);
936 set(&mut config.rust_rpath, rust.rpath);
937 set(&mut config.jemalloc, rust.jemalloc);
938 set(&mut config.test_compare_mode, rust.test_compare_mode);
939 config.llvm_libunwind = rust
941 .map(|v| v.parse().expect("failed to parse rust.llvm-libunwind"))
942 .unwrap_or_default();
943 set(&mut config.backtrace, rust.backtrace);
944 set(&mut config.channel, rust.channel);
945 config.description = rust.description;
946 set(&mut config.rust_dist_src, rust.dist_src);
947 set(&mut config.verbose_tests, rust.verbose_tests);
948 // in the case "false" is set explicitly, do not overwrite the command line args
949 if let Some(true) = rust.incremental {
950 config.incremental = true;
952 set(&mut config.use_lld, rust.use_lld);
953 set(&mut config.lld_enabled, rust.lld);
954 set(&mut config.llvm_tools_enabled, rust.llvm_tools);
955 config.rustc_parallel = rust.parallel_compiler.unwrap_or(false);
956 config.rustc_default_linker = rust.default_linker;
957 config.musl_root = rust.musl_root.map(PathBuf::from);
958 config.save_toolstates = rust.save_toolstates.map(PathBuf::from);
959 set(&mut config.deny_warnings, flags.deny_warnings.or(rust.deny_warnings));
960 set(&mut config.backtrace_on_ice, rust.backtrace_on_ice);
961 set(&mut config.rust_verify_llvm_ir, rust.verify_llvm_ir);
962 config.rust_thin_lto_import_instr_limit = rust.thin_lto_import_instr_limit;
963 set(&mut config.rust_remap_debuginfo, rust.remap_debuginfo);
964 set(&mut config.control_flow_guard, rust.control_flow_guard);
966 if let Some(ref backends) = rust.codegen_backends {
967 config.rust_codegen_backends =
968 backends.iter().map(|s| INTERNER.intern_str(s)).collect();
971 config.rust_codegen_units = rust.codegen_units.map(threads_from_config);
972 config.rust_codegen_units_std = rust.codegen_units_std.map(threads_from_config);
973 config.rust_profile_use = flags.rust_profile_use.or(rust.profile_use);
974 config.rust_profile_generate = flags.rust_profile_generate.or(rust.profile_generate);
975 config.download_rustc = env::var("BOOTSTRAP_DOWNLOAD_RUSTC").as_deref() == Ok("1");
977 config.rust_profile_use = flags.rust_profile_use;
978 config.rust_profile_generate = flags.rust_profile_generate;
981 if let Some(t) = toml.target {
982 for (triple, cfg) in t {
983 let mut target = Target::from_triple(&triple);
985 if let Some(ref s) = cfg.llvm_config {
986 target.llvm_config = Some(config.src.join(s));
988 if let Some(ref s) = cfg.llvm_filecheck {
989 target.llvm_filecheck = Some(config.src.join(s));
991 if let Some(ref s) = cfg.android_ndk {
992 target.ndk = Some(config.src.join(s));
994 if let Some(s) = cfg.no_std {
997 target.cc = cfg.cc.map(PathBuf::from);
998 target.cxx = cfg.cxx.map(PathBuf::from);
999 target.ar = cfg.ar.map(PathBuf::from);
1000 target.ranlib = cfg.ranlib.map(PathBuf::from);
1001 target.linker = cfg.linker.map(PathBuf::from);
1002 target.crt_static = cfg.crt_static;
1003 target.musl_root = cfg.musl_root.map(PathBuf::from);
1004 target.musl_libdir = cfg.musl_libdir.map(PathBuf::from);
1005 target.wasi_root = cfg.wasi_root.map(PathBuf::from);
1006 target.qemu_rootfs = cfg.qemu_rootfs.map(PathBuf::from);
1007 target.sanitizers = cfg.sanitizers;
1008 target.profiler = cfg.profiler;
1010 config.target_config.insert(TargetSelection::from_user(&triple), target);
1014 if config.llvm_from_ci {
1015 let triple = &config.build.triple;
1016 let mut build_target = config
1018 .entry(config.build)
1019 .or_insert_with(|| Target::from_triple(&triple));
1021 check_ci_llvm!(build_target.llvm_config);
1022 check_ci_llvm!(build_target.llvm_filecheck);
1023 let ci_llvm_bin = config.out.join(&*config.build.triple).join("ci-llvm/bin");
1024 build_target.llvm_config = Some(ci_llvm_bin.join(exe("llvm-config", config.build)));
1025 build_target.llvm_filecheck = Some(ci_llvm_bin.join(exe("FileCheck", config.build)));
1028 if let Some(t) = toml.dist {
1029 config.dist_sign_folder = t.sign_folder.map(PathBuf::from);
1030 config.dist_upload_addr = t.upload_addr;
1031 config.dist_compression_formats = t.compression_formats;
1032 set(&mut config.rust_dist_src, t.src_tarball);
1033 set(&mut config.missing_tools, t.missing_tools);
1036 config.initial_rustfmt = config.initial_rustfmt.or_else({
1037 let build = config.build;
1038 let initial_rustc = &config.initial_rustc;
1041 // Cargo does not provide a RUSTFMT environment variable, so we
1042 // synthesize it manually.
1043 let rustfmt = initial_rustc.with_file_name(exe("rustfmt", build));
1045 if rustfmt.exists() { Some(rustfmt) } else { None }
1049 // Now that we've reached the end of our configuration, infer the
1050 // default values for all options that we haven't otherwise stored yet.
1052 config.llvm_skip_rebuild = llvm_skip_rebuild.unwrap_or(false);
1053 config.llvm_assertions = llvm_assertions.unwrap_or(false);
1054 config.llvm_tests = llvm_tests.unwrap_or(false);
1055 config.llvm_plugins = llvm_plugins.unwrap_or(false);
1056 config.rust_optimize = optimize.unwrap_or(true);
1058 let default = debug == Some(true);
1059 config.rust_debug_assertions = debug_assertions.unwrap_or(default);
1060 config.rust_debug_assertions_std =
1061 debug_assertions_std.unwrap_or(config.rust_debug_assertions);
1062 config.rust_overflow_checks = overflow_checks.unwrap_or(default);
1063 config.rust_overflow_checks_std =
1064 overflow_checks_std.unwrap_or(config.rust_overflow_checks);
1066 config.rust_debug_logging = debug_logging.unwrap_or(config.rust_debug_assertions);
1068 let with_defaults = |debuginfo_level_specific: Option<u32>| {
1069 debuginfo_level_specific.or(debuginfo_level).unwrap_or(if debug == Some(true) {
1075 config.rust_debuginfo_level_rustc = with_defaults(debuginfo_level_rustc);
1076 config.rust_debuginfo_level_std = with_defaults(debuginfo_level_std);
1077 config.rust_debuginfo_level_tools = with_defaults(debuginfo_level_tools);
1078 config.rust_debuginfo_level_tests = debuginfo_level_tests.unwrap_or(0);
1080 let default = config.channel == "dev";
1081 config.ignore_git = ignore_git.unwrap_or(default);
1083 let download_rustc = config.download_rustc;
1084 // See https://github.com/rust-lang/compiler-team/issues/326
1085 config.stage = match config.cmd {
1086 Subcommand::Check { .. } => flags.stage.or(build.check_stage).unwrap_or(0),
1087 // `download-rustc` only has a speed-up for stage2 builds. Default to stage2 unless explicitly overridden.
1088 Subcommand::Doc { .. } => {
1089 flags.stage.or(build.doc_stage).unwrap_or(if download_rustc { 2 } else { 0 })
1091 Subcommand::Build { .. } => {
1092 flags.stage.or(build.build_stage).unwrap_or(if download_rustc { 2 } else { 1 })
1094 Subcommand::Test { .. } => {
1095 flags.stage.or(build.test_stage).unwrap_or(if download_rustc { 2 } else { 1 })
1097 Subcommand::Bench { .. } => flags.stage.or(build.bench_stage).unwrap_or(2),
1098 Subcommand::Dist { .. } => flags.stage.or(build.dist_stage).unwrap_or(2),
1099 Subcommand::Install { .. } => flags.stage.or(build.install_stage).unwrap_or(2),
1100 // These are all bootstrap tools, which don't depend on the compiler.
1101 // The stage we pass shouldn't matter, but use 0 just in case.
1102 Subcommand::Clean { .. }
1103 | Subcommand::Clippy { .. }
1104 | Subcommand::Fix { .. }
1105 | Subcommand::Run { .. }
1106 | Subcommand::Setup { .. }
1107 | Subcommand::Format { .. } => flags.stage.unwrap_or(0),
1110 // CI should always run stage 2 builds, unless it specifically states otherwise
1112 if flags.stage.is_none() && crate::CiEnv::current() != crate::CiEnv::None {
1114 Subcommand::Test { .. }
1115 | Subcommand::Doc { .. }
1116 | Subcommand::Build { .. }
1117 | Subcommand::Bench { .. }
1118 | Subcommand::Dist { .. }
1119 | Subcommand::Install { .. } => {
1122 "x.py should be run with `--stage 2` on CI, but was run with `--stage {}`",
1126 Subcommand::Clean { .. }
1127 | Subcommand::Check { .. }
1128 | Subcommand::Clippy { .. }
1129 | Subcommand::Fix { .. }
1130 | Subcommand::Run { .. }
1131 | Subcommand::Setup { .. }
1132 | Subcommand::Format { .. } => {}
1139 /// Try to find the relative path of `bindir`, otherwise return it in full.
1140 pub fn bindir_relative(&self) -> &Path {
1141 let bindir = &self.bindir;
1142 if bindir.is_absolute() {
1143 // Try to make it relative to the prefix.
1144 if let Some(prefix) = &self.prefix {
1145 if let Ok(stripped) = bindir.strip_prefix(prefix) {
1153 /// Try to find the relative path of `libdir`.
1154 pub fn libdir_relative(&self) -> Option<&Path> {
1155 let libdir = self.libdir.as_ref()?;
1156 if libdir.is_relative() {
1159 // Try to make it relative to the prefix.
1160 libdir.strip_prefix(self.prefix.as_ref()?).ok()
1164 pub fn verbose(&self) -> bool {
1168 pub fn sanitizers_enabled(&self, target: TargetSelection) -> bool {
1169 self.target_config.get(&target).map(|t| t.sanitizers).flatten().unwrap_or(self.sanitizers)
1172 pub fn any_sanitizers_enabled(&self) -> bool {
1173 self.target_config.values().any(|t| t.sanitizers == Some(true)) || self.sanitizers
1176 pub fn profiler_enabled(&self, target: TargetSelection) -> bool {
1177 self.target_config.get(&target).map(|t| t.profiler).flatten().unwrap_or(self.profiler)
1180 pub fn any_profiler_enabled(&self) -> bool {
1181 self.target_config.values().any(|t| t.profiler == Some(true)) || self.profiler
1184 pub fn llvm_enabled(&self) -> bool {
1185 self.rust_codegen_backends.contains(&INTERNER.intern_str("llvm"))
1188 pub fn submodules(&self, rust_info: &GitInfo) -> bool {
1189 self.submodules.unwrap_or(rust_info.is_git())
1193 fn set<T>(field: &mut T, val: Option<T>) {
1194 if let Some(v) = val {
1199 fn threads_from_config(v: u32) -> u32 {
1201 0 => std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get) as u32,