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};
9 use std::ffi::OsString;
11 use std::path::{Path, PathBuf};
14 use crate::cache::{Interned, INTERNER};
15 use crate::flags::Flags;
16 pub use crate::flags::Subcommand;
18 use serde::Deserialize;
21 /// Global configuration for the entire build and/or bootstrap.
23 /// This structure is derived from a combination of both `config.toml` and
24 /// `config.mk`. As of the time of this writing it's unlikely that `config.toml`
25 /// is used all that much, so this is primarily filled out by `config.mk` which
26 /// is generated from `./configure`.
28 /// Note that this structure is not decoded directly into, but rather it is
29 /// filled out from the decoded forms of the structs below. For documentation
30 /// each field, see the corresponding fields in
31 /// `config.toml.example`.
34 pub ccache: Option<String>,
38 pub fast_submodules: bool,
39 pub compiler_docs: bool,
41 pub locked_deps: bool,
43 pub target_config: HashMap<Interned<String>, Target>,
44 pub full_bootstrap: bool,
46 pub tools: Option<HashSet<String>>,
50 pub exclude: Vec<PathBuf>,
51 pub rustc_error_format: Option<String>,
52 pub test_compare_mode: bool,
53 pub llvm_libunwind: bool,
55 pub skip_only_host_steps: bool,
57 pub on_fail: Option<String>,
58 pub stage: Option<u32>,
59 pub keep_stage: Vec<u32>,
61 pub jobs: Option<u32>,
63 pub incremental: bool,
66 pub deny_warnings: bool,
67 pub backtrace_on_ice: bool,
69 // llvm codegen options
70 pub llvm_assertions: bool,
71 pub llvm_optimize: bool,
72 pub llvm_thin_lto: bool,
73 pub llvm_release_debuginfo: bool,
74 pub llvm_version_check: bool,
75 pub llvm_static_stdcpp: bool,
76 pub llvm_link_shared: bool,
77 pub llvm_clang_cl: Option<String>,
78 pub llvm_targets: Option<String>,
79 pub llvm_experimental_targets: Option<String>,
80 pub llvm_link_jobs: Option<u32>,
81 pub llvm_version_suffix: Option<String>,
82 pub llvm_use_linker: Option<String>,
83 pub llvm_allow_old_toolchain: Option<bool>,
85 pub lld_enabled: bool,
86 pub lldb_enabled: bool,
87 pub llvm_tools_enabled: bool,
89 pub llvm_cflags: Option<String>,
90 pub llvm_cxxflags: Option<String>,
91 pub llvm_ldflags: Option<String>,
92 pub llvm_use_libcxx: bool,
94 // rust codegen options
95 pub rust_optimize: bool,
96 pub rust_codegen_units: Option<u32>,
97 pub rust_codegen_units_std: Option<u32>,
98 pub rust_debug_assertions: bool,
99 pub rust_debuginfo_level_rustc: u32,
100 pub rust_debuginfo_level_std: u32,
101 pub rust_debuginfo_level_tools: u32,
102 pub rust_debuginfo_level_tests: u32,
103 pub rust_rpath: bool,
104 pub rustc_parallel: bool,
105 pub rustc_default_linker: Option<String>,
106 pub rust_optimize_tests: bool,
107 pub rust_dist_src: bool,
108 pub rust_codegen_backends: Vec<Interned<String>>,
109 pub rust_verify_llvm_ir: bool,
110 pub rust_remap_debuginfo: bool,
112 pub build: Interned<String>,
113 pub hosts: Vec<Interned<String>>,
114 pub targets: Vec<Interned<String>>,
115 pub local_rebuild: bool,
119 pub dist_sign_folder: Option<PathBuf>,
120 pub dist_upload_addr: Option<String>,
121 pub dist_gpg_password_file: Option<PathBuf>,
124 pub backtrace: bool, // support for RUST_BACKTRACE
127 pub low_priority: bool,
129 pub verbose_tests: bool,
130 pub save_toolstates: Option<PathBuf>,
131 pub print_step_timings: bool,
132 pub missing_tools: bool,
134 // Fallback musl-root for all targets
135 pub musl_root: Option<PathBuf>,
136 pub prefix: Option<PathBuf>,
137 pub sysconfdir: Option<PathBuf>,
138 pub datadir: Option<PathBuf>,
139 pub docdir: Option<PathBuf>,
141 pub libdir: Option<PathBuf>,
142 pub mandir: Option<PathBuf>,
143 pub codegen_tests: bool,
144 pub nodejs: Option<PathBuf>,
145 pub gdb: Option<PathBuf>,
146 pub python: Option<PathBuf>,
147 pub cargo_native_static: bool,
148 pub configure_args: Vec<String>,
150 // These are either the stage0 downloaded binaries or the locally installed ones.
151 pub initial_cargo: PathBuf,
152 pub initial_rustc: PathBuf,
153 pub initial_rustfmt: Option<PathBuf>,
157 /// Per-target configuration stored in the global configuration structure.
160 /// Some(path to llvm-config) if using an external LLVM.
161 pub llvm_config: Option<PathBuf>,
162 /// Some(path to FileCheck) if one was specified.
163 pub llvm_filecheck: Option<PathBuf>,
164 pub cc: Option<PathBuf>,
165 pub cxx: Option<PathBuf>,
166 pub ar: Option<PathBuf>,
167 pub ranlib: Option<PathBuf>,
168 pub linker: Option<PathBuf>,
169 pub ndk: Option<PathBuf>,
170 pub crt_static: Option<bool>,
171 pub musl_root: Option<PathBuf>,
172 pub wasi_root: Option<PathBuf>,
173 pub qemu_rootfs: Option<PathBuf>,
177 /// Structure of the `config.toml` file that configuration is read from.
179 /// This structure uses `Decodable` to automatically decode a TOML configuration
180 /// file into this format, and then this is traversed and written into the above
181 /// `Config` structure.
182 #[derive(Deserialize, Default)]
183 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
185 build: Option<Build>,
186 install: Option<Install>,
189 target: Option<HashMap<String, TomlTarget>>,
193 /// TOML representation of various global build decisions.
194 #[derive(Deserialize, Default, Clone)]
195 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
197 build: Option<String>,
202 cargo: Option<String>,
203 rustc: Option<String>,
205 compiler_docs: Option<bool>,
206 submodules: Option<bool>,
207 fast_submodules: Option<bool>,
209 nodejs: Option<String>,
210 python: Option<String>,
211 locked_deps: Option<bool>,
212 vendor: Option<bool>,
213 full_bootstrap: Option<bool>,
214 extended: Option<bool>,
215 tools: Option<HashSet<String>>,
216 verbose: Option<usize>,
217 sanitizers: Option<bool>,
218 profiler: Option<bool>,
219 cargo_native_static: Option<bool>,
220 low_priority: Option<bool>,
221 configure_args: Option<Vec<String>>,
222 local_rebuild: Option<bool>,
223 print_step_timings: Option<bool>,
226 /// TOML representation of various global install decisions.
227 #[derive(Deserialize, Default, Clone)]
228 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
230 prefix: Option<String>,
231 sysconfdir: Option<String>,
232 docdir: Option<String>,
233 bindir: Option<String>,
234 libdir: Option<String>,
235 mandir: Option<String>,
236 datadir: Option<String>,
238 // standard paths, currently unused
239 infodir: Option<String>,
240 localstatedir: Option<String>,
243 /// TOML representation of how the LLVM build is configured.
244 #[derive(Deserialize, Default)]
245 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
247 optimize: Option<bool>,
248 thin_lto: Option<bool>,
249 release_debuginfo: Option<bool>,
250 assertions: Option<bool>,
251 ccache: Option<StringOrBool>,
252 version_check: Option<bool>,
253 static_libstdcpp: Option<bool>,
255 targets: Option<String>,
256 experimental_targets: Option<String>,
257 link_jobs: Option<u32>,
258 link_shared: Option<bool>,
259 version_suffix: Option<String>,
260 clang_cl: Option<String>,
261 cflags: Option<String>,
262 cxxflags: Option<String>,
263 ldflags: Option<String>,
264 use_libcxx: Option<bool>,
265 use_linker: Option<String>,
266 allow_old_toolchain: Option<bool>,
269 #[derive(Deserialize, Default, Clone)]
270 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
272 sign_folder: Option<String>,
273 gpg_password_file: Option<String>,
274 upload_addr: Option<String>,
275 src_tarball: Option<bool>,
276 missing_tools: Option<bool>,
279 #[derive(Deserialize)]
286 impl Default for StringOrBool {
287 fn default() -> StringOrBool {
288 StringOrBool::Bool(false)
292 /// TOML representation of how the Rust build is configured.
293 #[derive(Deserialize, Default)]
294 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
296 optimize: Option<bool>,
298 codegen_units: Option<u32>,
299 codegen_units_std: Option<u32>,
300 debug_assertions: Option<bool>,
301 debuginfo_level: Option<u32>,
302 debuginfo_level_rustc: Option<u32>,
303 debuginfo_level_std: Option<u32>,
304 debuginfo_level_tools: Option<u32>,
305 debuginfo_level_tests: Option<u32>,
306 backtrace: Option<bool>,
307 incremental: Option<bool>,
308 parallel_compiler: Option<bool>,
309 default_linker: Option<String>,
310 channel: Option<String>,
311 musl_root: Option<String>,
313 verbose_tests: Option<bool>,
314 optimize_tests: Option<bool>,
315 codegen_tests: Option<bool>,
316 ignore_git: Option<bool>,
317 dist_src: Option<bool>,
318 save_toolstates: Option<String>,
319 codegen_backends: Option<Vec<String>>,
321 llvm_tools: Option<bool>,
323 deny_warnings: Option<bool>,
324 backtrace_on_ice: Option<bool>,
325 verify_llvm_ir: Option<bool>,
326 remap_debuginfo: Option<bool>,
327 jemalloc: Option<bool>,
328 test_compare_mode: Option<bool>,
329 llvm_libunwind: Option<bool>,
332 /// TOML representation of how each build target is configured.
333 #[derive(Deserialize, Default)]
334 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
339 ranlib: Option<String>,
340 linker: Option<String>,
341 llvm_config: Option<String>,
342 llvm_filecheck: Option<String>,
343 android_ndk: Option<String>,
344 crt_static: Option<bool>,
345 musl_root: Option<String>,
346 wasi_root: Option<String>,
347 qemu_rootfs: Option<String>,
351 fn path_from_python(var_key: &str) -> PathBuf {
352 match env::var_os(var_key) {
353 Some(var_val) => Self::normalize_python_path(var_val),
354 _ => panic!("expected '{}' to be set", var_key),
358 /// Normalizes paths from Python slightly. We don't trust paths from Python (#49785).
359 fn normalize_python_path(path: OsString) -> PathBuf {
360 Path::new(&path).components().collect()
363 pub fn default_opts() -> Config {
364 let mut config = Config::default();
365 config.llvm_optimize = true;
366 config.llvm_version_check = true;
367 config.backtrace = true;
368 config.rust_optimize = true;
369 config.rust_optimize_tests = true;
370 config.submodules = true;
371 config.fast_submodules = true;
373 config.rust_rpath = true;
374 config.channel = "dev".to_string();
375 config.codegen_tests = true;
376 config.ignore_git = false;
377 config.rust_dist_src = true;
378 config.rust_codegen_backends = vec![INTERNER.intern_str("llvm")];
379 config.deny_warnings = true;
380 config.missing_tools = false;
382 // set by bootstrap.py
383 config.build = INTERNER.intern_str(&env::var("BUILD").expect("'BUILD' to be set"));
384 config.src = Config::path_from_python("SRC");
385 config.out = Config::path_from_python("BUILD_DIR");
387 config.initial_rustc = Config::path_from_python("RUSTC");
388 config.initial_cargo = Config::path_from_python("CARGO");
389 config.initial_rustfmt = env::var_os("RUSTFMT").map(Config::normalize_python_path);
394 pub fn parse(args: &[String]) -> Config {
395 let flags = Flags::parse(&args);
396 let file = flags.config.clone();
397 let mut config = Config::default_opts();
398 config.exclude = flags.exclude;
399 config.rustc_error_format = flags.rustc_error_format;
400 config.on_fail = flags.on_fail;
401 config.stage = flags.stage;
402 config.jobs = flags.jobs.map(threads_from_config);
403 config.cmd = flags.cmd;
404 config.incremental = flags.incremental;
405 config.dry_run = flags.dry_run;
406 config.keep_stage = flags.keep_stage;
407 config.bindir = "bin".into(); // default
408 if let Some(value) = flags.deny_warnings {
409 config.deny_warnings = value;
413 let dir = config.out.join("tmp-dry-run");
414 t!(fs::create_dir_all(&dir));
418 // If --target was specified but --host wasn't specified, don't run any host-only tests.
419 let has_hosts = !flags.host.is_empty();
420 let has_targets = !flags.target.is_empty();
421 config.skip_only_host_steps = !has_hosts && has_targets;
425 let contents = t!(fs::read_to_string(&file));
426 match toml::from_str(&contents) {
430 "failed to parse TOML configuration '{}': {}",
438 .unwrap_or_else(|| TomlConfig::default());
440 let build = toml.build.clone().unwrap_or_default();
441 // set by bootstrap.py
442 config.hosts.push(config.build.clone());
443 for host in build.host.iter() {
444 let host = INTERNER.intern_str(host);
445 if !config.hosts.contains(&host) {
446 config.hosts.push(host);
450 config.hosts.iter().cloned().chain(build.target.iter().map(|s| INTERNER.intern_str(s)))
452 if !config.targets.contains(&target) {
453 config.targets.push(target);
456 config.hosts = if !flags.host.is_empty() { flags.host } else { config.hosts };
457 config.targets = if !flags.target.is_empty() { flags.target } else { config.targets };
459 config.nodejs = build.nodejs.map(PathBuf::from);
460 config.gdb = build.gdb.map(PathBuf::from);
461 config.python = build.python.map(PathBuf::from);
462 set(&mut config.low_priority, build.low_priority);
463 set(&mut config.compiler_docs, build.compiler_docs);
464 set(&mut config.docs, build.docs);
465 set(&mut config.submodules, build.submodules);
466 set(&mut config.fast_submodules, build.fast_submodules);
467 set(&mut config.locked_deps, build.locked_deps);
468 set(&mut config.vendor, build.vendor);
469 set(&mut config.full_bootstrap, build.full_bootstrap);
470 set(&mut config.extended, build.extended);
471 config.tools = build.tools;
472 set(&mut config.verbose, build.verbose);
473 set(&mut config.sanitizers, build.sanitizers);
474 set(&mut config.profiler, build.profiler);
475 set(&mut config.cargo_native_static, build.cargo_native_static);
476 set(&mut config.configure_args, build.configure_args);
477 set(&mut config.local_rebuild, build.local_rebuild);
478 set(&mut config.print_step_timings, build.print_step_timings);
479 config.verbose = cmp::max(config.verbose, flags.verbose);
481 if let Some(ref install) = toml.install {
482 config.prefix = install.prefix.clone().map(PathBuf::from);
483 config.sysconfdir = install.sysconfdir.clone().map(PathBuf::from);
484 config.datadir = install.datadir.clone().map(PathBuf::from);
485 config.docdir = install.docdir.clone().map(PathBuf::from);
486 set(&mut config.bindir, install.bindir.clone().map(PathBuf::from));
487 config.libdir = install.libdir.clone().map(PathBuf::from);
488 config.mandir = install.mandir.clone().map(PathBuf::from);
491 // Store off these values as options because if they're not provided
492 // we'll infer default values for them later
493 let mut llvm_assertions = None;
494 let mut debug = None;
495 let mut debug_assertions = None;
496 let mut debuginfo_level = None;
497 let mut debuginfo_level_rustc = None;
498 let mut debuginfo_level_std = None;
499 let mut debuginfo_level_tools = None;
500 let mut debuginfo_level_tests = None;
501 let mut optimize = None;
502 let mut ignore_git = None;
504 if let Some(ref llvm) = toml.llvm {
506 Some(StringOrBool::String(ref s)) => config.ccache = Some(s.to_string()),
507 Some(StringOrBool::Bool(true)) => {
508 config.ccache = Some("ccache".to_string());
510 Some(StringOrBool::Bool(false)) | None => {}
512 set(&mut config.ninja, llvm.ninja);
513 llvm_assertions = llvm.assertions;
514 set(&mut config.llvm_optimize, llvm.optimize);
515 set(&mut config.llvm_thin_lto, llvm.thin_lto);
516 set(&mut config.llvm_release_debuginfo, llvm.release_debuginfo);
517 set(&mut config.llvm_version_check, llvm.version_check);
518 set(&mut config.llvm_static_stdcpp, llvm.static_libstdcpp);
519 set(&mut config.llvm_link_shared, llvm.link_shared);
520 config.llvm_targets = llvm.targets.clone();
521 config.llvm_experimental_targets = llvm.experimental_targets.clone();
522 config.llvm_link_jobs = llvm.link_jobs;
523 config.llvm_version_suffix = llvm.version_suffix.clone();
524 config.llvm_clang_cl = llvm.clang_cl.clone();
526 config.llvm_cflags = llvm.cflags.clone();
527 config.llvm_cxxflags = llvm.cxxflags.clone();
528 config.llvm_ldflags = llvm.ldflags.clone();
529 set(&mut config.llvm_use_libcxx, llvm.use_libcxx);
530 config.llvm_use_linker = llvm.use_linker.clone();
531 config.llvm_allow_old_toolchain = llvm.allow_old_toolchain.clone();
534 if let Some(ref rust) = toml.rust {
536 debug_assertions = rust.debug_assertions;
537 debuginfo_level = rust.debuginfo_level;
538 debuginfo_level_rustc = rust.debuginfo_level_rustc;
539 debuginfo_level_std = rust.debuginfo_level_std;
540 debuginfo_level_tools = rust.debuginfo_level_tools;
541 debuginfo_level_tests = rust.debuginfo_level_tests;
542 optimize = rust.optimize;
543 ignore_git = rust.ignore_git;
544 set(&mut config.rust_optimize_tests, rust.optimize_tests);
545 set(&mut config.codegen_tests, rust.codegen_tests);
546 set(&mut config.rust_rpath, rust.rpath);
547 set(&mut config.jemalloc, rust.jemalloc);
548 set(&mut config.test_compare_mode, rust.test_compare_mode);
549 set(&mut config.llvm_libunwind, rust.llvm_libunwind);
550 set(&mut config.backtrace, rust.backtrace);
551 set(&mut config.channel, rust.channel.clone());
552 set(&mut config.rust_dist_src, rust.dist_src);
553 set(&mut config.verbose_tests, rust.verbose_tests);
554 // in the case "false" is set explicitly, do not overwrite the command line args
555 if let Some(true) = rust.incremental {
556 config.incremental = true;
558 set(&mut config.lld_enabled, rust.lld);
559 set(&mut config.lldb_enabled, rust.lldb);
560 set(&mut config.llvm_tools_enabled, rust.llvm_tools);
561 config.rustc_parallel = rust.parallel_compiler.unwrap_or(false);
562 config.rustc_default_linker = rust.default_linker.clone();
563 config.musl_root = rust.musl_root.clone().map(PathBuf::from);
564 config.save_toolstates = rust.save_toolstates.clone().map(PathBuf::from);
565 set(&mut config.deny_warnings, flags.deny_warnings.or(rust.deny_warnings));
566 set(&mut config.backtrace_on_ice, rust.backtrace_on_ice);
567 set(&mut config.rust_verify_llvm_ir, rust.verify_llvm_ir);
568 set(&mut config.rust_remap_debuginfo, rust.remap_debuginfo);
570 if let Some(ref backends) = rust.codegen_backends {
571 config.rust_codegen_backends =
572 backends.iter().map(|s| INTERNER.intern_str(s)).collect();
575 config.rust_codegen_units = rust.codegen_units.map(threads_from_config);
576 config.rust_codegen_units_std = rust.codegen_units_std.map(threads_from_config);
579 if let Some(ref t) = toml.target {
580 for (triple, cfg) in t {
581 let mut target = Target::default();
583 if let Some(ref s) = cfg.llvm_config {
584 target.llvm_config = Some(config.src.join(s));
586 if let Some(ref s) = cfg.llvm_filecheck {
587 target.llvm_filecheck = Some(config.src.join(s));
589 if let Some(ref s) = cfg.android_ndk {
590 target.ndk = Some(config.src.join(s));
592 target.cc = cfg.cc.clone().map(PathBuf::from);
593 target.cxx = cfg.cxx.clone().map(PathBuf::from);
594 target.ar = cfg.ar.clone().map(PathBuf::from);
595 target.ranlib = cfg.ranlib.clone().map(PathBuf::from);
596 target.linker = cfg.linker.clone().map(PathBuf::from);
597 target.crt_static = cfg.crt_static.clone();
598 target.musl_root = cfg.musl_root.clone().map(PathBuf::from);
599 target.wasi_root = cfg.wasi_root.clone().map(PathBuf::from);
600 target.qemu_rootfs = cfg.qemu_rootfs.clone().map(PathBuf::from);
602 config.target_config.insert(INTERNER.intern_string(triple.clone()), target);
606 if let Some(ref t) = toml.dist {
607 config.dist_sign_folder = t.sign_folder.clone().map(PathBuf::from);
608 config.dist_gpg_password_file = t.gpg_password_file.clone().map(PathBuf::from);
609 config.dist_upload_addr = t.upload_addr.clone();
610 set(&mut config.rust_dist_src, t.src_tarball);
611 set(&mut config.missing_tools, t.missing_tools);
614 // Now that we've reached the end of our configuration, infer the
615 // default values for all options that we haven't otherwise stored yet.
617 set(&mut config.initial_rustc, build.rustc.map(PathBuf::from));
618 set(&mut config.initial_cargo, build.cargo.map(PathBuf::from));
621 config.llvm_assertions = llvm_assertions.unwrap_or(default);
624 config.rust_optimize = optimize.unwrap_or(default);
626 let default = debug == Some(true);
627 config.rust_debug_assertions = debug_assertions.unwrap_or(default);
629 let with_defaults = |debuginfo_level_specific: Option<u32>| {
630 debuginfo_level_specific.or(debuginfo_level).unwrap_or(if debug == Some(true) {
636 config.rust_debuginfo_level_rustc = with_defaults(debuginfo_level_rustc);
637 config.rust_debuginfo_level_std = with_defaults(debuginfo_level_std);
638 config.rust_debuginfo_level_tools = with_defaults(debuginfo_level_tools);
639 config.rust_debuginfo_level_tests = debuginfo_level_tests.unwrap_or(0);
641 let default = config.channel == "dev";
642 config.ignore_git = ignore_git.unwrap_or(default);
647 /// Try to find the relative path of `bindir`, otherwise return it in full.
648 pub fn bindir_relative(&self) -> &Path {
649 let bindir = &self.bindir;
650 if bindir.is_absolute() {
651 // Try to make it relative to the prefix.
652 if let Some(prefix) = &self.prefix {
653 if let Ok(stripped) = bindir.strip_prefix(prefix) {
661 /// Try to find the relative path of `libdir`.
662 pub fn libdir_relative(&self) -> Option<&Path> {
663 let libdir = self.libdir.as_ref()?;
664 if libdir.is_relative() {
667 // Try to make it relative to the prefix.
668 libdir.strip_prefix(self.prefix.as_ref()?).ok()
672 pub fn verbose(&self) -> bool {
676 pub fn very_verbose(&self) -> bool {
680 pub fn llvm_enabled(&self) -> bool {
681 self.rust_codegen_backends.contains(&INTERNER.intern_str("llvm"))
685 fn set<T>(field: &mut T, val: Option<T>) {
686 if let Some(v) = val {
691 fn threads_from_config(v: u32) -> u32 {
693 0 => num_cpus::get() as u32,