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::collections::{HashMap, HashSet};
9 use std::path::{Path, PathBuf};
16 use serde::Deserialize;
17 use crate::cache::{INTERNER, Interned};
18 use crate::flags::Flags;
19 pub use crate::flags::Subcommand;
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 run_host_only: 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: 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_codegen_backends_dir: String,
110 pub rust_verify_llvm_ir: bool,
111 pub rust_remap_debuginfo: bool,
113 pub build: Interned<String>,
114 pub hosts: Vec<Interned<String>>,
115 pub targets: Vec<Interned<String>>,
116 pub local_rebuild: bool,
120 pub dist_sign_folder: Option<PathBuf>,
121 pub dist_upload_addr: Option<String>,
122 pub dist_gpg_password_file: Option<PathBuf>,
125 pub backtrace: bool, // support for RUST_BACKTRACE
126 pub wasm_syscall: bool,
129 pub low_priority: bool,
131 pub verbose_tests: bool,
133 pub save_toolstates: Option<PathBuf>,
134 pub print_step_timings: bool,
135 pub missing_tools: bool,
137 // Fallback musl-root for all targets
138 pub musl_root: Option<PathBuf>,
139 pub prefix: Option<PathBuf>,
140 pub sysconfdir: Option<PathBuf>,
141 pub datadir: Option<PathBuf>,
142 pub docdir: Option<PathBuf>,
143 pub bindir: Option<PathBuf>,
144 pub libdir: Option<PathBuf>,
145 pub mandir: Option<PathBuf>,
146 pub codegen_tests: bool,
147 pub nodejs: Option<PathBuf>,
148 pub gdb: Option<PathBuf>,
149 pub python: Option<PathBuf>,
150 pub cargo_native_static: bool,
151 pub configure_args: Vec<String>,
153 // These are either the stage0 downloaded binaries or the locally installed ones.
154 pub initial_cargo: PathBuf,
155 pub initial_rustc: PathBuf,
159 /// Per-target configuration stored in the global configuration structure.
162 /// Some(path to llvm-config) if using an external LLVM.
163 pub llvm_config: Option<PathBuf>,
164 /// Some(path to FileCheck) if one was specified.
165 pub llvm_filecheck: Option<PathBuf>,
166 pub cc: Option<PathBuf>,
167 pub cxx: Option<PathBuf>,
168 pub ar: Option<PathBuf>,
169 pub ranlib: Option<PathBuf>,
170 pub linker: Option<PathBuf>,
171 pub ndk: Option<PathBuf>,
172 pub crt_static: Option<bool>,
173 pub musl_root: Option<PathBuf>,
174 pub wasi_root: Option<PathBuf>,
175 pub qemu_rootfs: Option<PathBuf>,
179 /// Structure of the `config.toml` file that configuration is read from.
181 /// This structure uses `Decodable` to automatically decode a TOML configuration
182 /// file into this format, and then this is traversed and written into the above
183 /// `Config` structure.
184 #[derive(Deserialize, Default)]
185 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
187 build: Option<Build>,
188 install: Option<Install>,
191 target: Option<HashMap<String, TomlTarget>>,
195 /// TOML representation of various global build decisions.
196 #[derive(Deserialize, Default, Clone)]
197 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
199 build: Option<String>,
204 cargo: Option<String>,
205 rustc: Option<String>,
206 low_priority: Option<bool>,
207 compiler_docs: Option<bool>,
209 submodules: Option<bool>,
210 fast_submodules: Option<bool>,
212 locked_deps: Option<bool>,
213 vendor: Option<bool>,
214 nodejs: Option<String>,
215 python: Option<String>,
216 full_bootstrap: Option<bool>,
217 extended: Option<bool>,
218 tools: Option<HashSet<String>>,
219 verbose: Option<usize>,
220 sanitizers: Option<bool>,
221 profiler: Option<bool>,
222 cargo_native_static: Option<bool>,
223 configure_args: Option<Vec<String>>,
224 local_rebuild: Option<bool>,
225 print_step_timings: Option<bool>,
228 /// TOML representation of various global install decisions.
229 #[derive(Deserialize, Default, Clone)]
230 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
232 prefix: Option<String>,
233 sysconfdir: Option<String>,
234 datadir: Option<String>,
235 docdir: Option<String>,
236 bindir: Option<String>,
237 libdir: Option<String>,
238 mandir: Option<String>,
240 // standard paths, currently unused
241 infodir: Option<String>,
242 localstatedir: Option<String>,
245 /// TOML representation of how the LLVM build is configured.
246 #[derive(Deserialize, Default)]
247 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
249 ccache: Option<StringOrBool>,
251 assertions: Option<bool>,
252 optimize: Option<bool>,
253 thin_lto: Option<bool>,
254 release_debuginfo: Option<bool>,
255 version_check: Option<bool>,
256 static_libstdcpp: Option<bool>,
257 targets: Option<String>,
258 experimental_targets: Option<String>,
259 link_jobs: Option<u32>,
260 link_shared: Option<bool>,
261 version_suffix: Option<String>,
262 clang_cl: Option<String>,
263 cflags: Option<String>,
264 cxxflags: Option<String>,
265 ldflags: Option<String>,
266 use_libcxx: Option<bool>,
267 use_linker: Option<String>,
268 allow_old_toolchain: Option<bool>,
271 #[derive(Deserialize, Default, Clone)]
272 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
274 sign_folder: Option<String>,
275 gpg_password_file: Option<String>,
276 upload_addr: Option<String>,
277 src_tarball: Option<bool>,
278 missing_tools: Option<bool>,
281 #[derive(Deserialize)]
288 impl Default for StringOrBool {
289 fn default() -> StringOrBool {
290 StringOrBool::Bool(false)
294 /// TOML representation of how the Rust build is configured.
295 #[derive(Deserialize, Default)]
296 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
298 optimize: Option<bool>,
299 codegen_units: Option<u32>,
300 codegen_units_std: Option<u32>,
301 debug_assertions: Option<bool>,
302 debuginfo_level: Option<u32>,
303 debuginfo_level_rustc: Option<u32>,
304 debuginfo_level_std: Option<u32>,
305 debuginfo_level_tools: Option<u32>,
306 debuginfo_level_tests: Option<u32>,
307 parallel_compiler: Option<bool>,
308 backtrace: Option<bool>,
309 default_linker: Option<String>,
310 channel: Option<String>,
311 musl_root: Option<String>,
313 optimize_tests: Option<bool>,
314 codegen_tests: Option<bool>,
315 ignore_git: Option<bool>,
317 dist_src: Option<bool>,
318 verbose_tests: Option<bool>,
319 test_miri: Option<bool>,
320 incremental: Option<bool>,
321 save_toolstates: Option<String>,
322 codegen_backends: Option<Vec<String>>,
323 codegen_backends_dir: Option<String>,
324 wasm_syscall: Option<bool>,
327 llvm_tools: Option<bool>,
328 deny_warnings: Option<bool>,
329 backtrace_on_ice: Option<bool>,
330 verify_llvm_ir: Option<bool>,
331 remap_debuginfo: Option<bool>,
332 jemalloc: Option<bool>,
333 test_compare_mode: Option<bool>,
334 llvm_libunwind: Option<bool>,
337 /// TOML representation of how each build target is configured.
338 #[derive(Deserialize, Default)]
339 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
341 llvm_config: Option<String>,
342 llvm_filecheck: Option<String>,
346 ranlib: Option<String>,
347 linker: Option<String>,
348 android_ndk: Option<String>,
349 crt_static: Option<bool>,
350 musl_root: Option<String>,
351 wasi_root: Option<String>,
352 qemu_rootfs: Option<String>,
356 fn path_from_python(var_key: &str) -> PathBuf {
357 match env::var_os(var_key) {
358 // Do not trust paths from Python and normalize them slightly (#49785).
359 Some(var_val) => Path::new(&var_val).components().collect(),
360 _ => panic!("expected '{}' to be set", var_key),
364 pub fn default_opts() -> Config {
365 let mut config = Config::default();
366 config.llvm_optimize = true;
367 config.llvm_version_check = true;
368 config.backtrace = true;
369 config.rust_optimize = true;
370 config.rust_optimize_tests = true;
371 config.submodules = true;
372 config.fast_submodules = true;
374 config.rust_rpath = true;
375 config.channel = "dev".to_string();
376 config.codegen_tests = true;
377 config.ignore_git = false;
378 config.rust_dist_src = true;
379 config.test_miri = false;
380 config.rust_codegen_backends = vec![INTERNER.intern_str("llvm")];
381 config.rust_codegen_backends_dir = "codegen-backends".to_owned();
382 config.deny_warnings = true;
383 config.missing_tools = false;
385 // set by bootstrap.py
386 config.build = INTERNER.intern_str(&env::var("BUILD").expect("'BUILD' to be set"));
387 config.src = Config::path_from_python("SRC");
388 config.out = Config::path_from_python("BUILD_DIR");
390 config.initial_rustc = Config::path_from_python("RUSTC");
391 config.initial_cargo = Config::path_from_python("CARGO");
396 pub fn parse(args: &[String]) -> Config {
397 let flags = Flags::parse(&args);
398 let file = flags.config.clone();
399 let mut config = Config::default_opts();
400 config.exclude = flags.exclude;
401 config.rustc_error_format = flags.rustc_error_format;
402 config.on_fail = flags.on_fail;
403 config.stage = flags.stage;
404 config.jobs = flags.jobs;
405 config.cmd = flags.cmd;
406 config.incremental = flags.incremental;
407 config.dry_run = flags.dry_run;
408 config.keep_stage = flags.keep_stage;
409 if let Some(value) = flags.warnings {
410 config.deny_warnings = value;
414 let dir = config.out.join("tmp-dry-run");
415 t!(fs::create_dir_all(&dir));
419 // If --target was specified but --host wasn't specified, don't run any host-only tests.
420 config.run_host_only = !(flags.host.is_empty() && !flags.target.is_empty());
422 let toml = file.map(|file| {
423 let contents = t!(fs::read_to_string(&file));
424 match toml::from_str(&contents) {
427 println!("failed to parse TOML configuration '{}': {}",
428 file.display(), err);
432 }).unwrap_or_else(|| TomlConfig::default());
434 let build = toml.build.clone().unwrap_or_default();
435 // set by bootstrap.py
436 config.hosts.push(config.build.clone());
437 for host in build.host.iter() {
438 let host = INTERNER.intern_str(host);
439 if !config.hosts.contains(&host) {
440 config.hosts.push(host);
443 for target in config.hosts.iter().cloned()
444 .chain(build.target.iter().map(|s| INTERNER.intern_str(s)))
446 if !config.targets.contains(&target) {
447 config.targets.push(target);
450 config.hosts = if !flags.host.is_empty() {
455 config.targets = if !flags.target.is_empty() {
462 config.nodejs = build.nodejs.map(PathBuf::from);
463 config.gdb = build.gdb.map(PathBuf::from);
464 config.python = build.python.map(PathBuf::from);
465 set(&mut config.low_priority, build.low_priority);
466 set(&mut config.compiler_docs, build.compiler_docs);
467 set(&mut config.docs, build.docs);
468 set(&mut config.submodules, build.submodules);
469 set(&mut config.fast_submodules, build.fast_submodules);
470 set(&mut config.locked_deps, build.locked_deps);
471 set(&mut config.vendor, build.vendor);
472 set(&mut config.full_bootstrap, build.full_bootstrap);
473 set(&mut config.extended, build.extended);
474 config.tools = build.tools;
475 set(&mut config.verbose, build.verbose);
476 set(&mut config.sanitizers, build.sanitizers);
477 set(&mut config.profiler, build.profiler);
478 set(&mut config.cargo_native_static, build.cargo_native_static);
479 set(&mut config.configure_args, build.configure_args);
480 set(&mut config.local_rebuild, build.local_rebuild);
481 set(&mut config.print_step_timings, build.print_step_timings);
482 config.verbose = cmp::max(config.verbose, flags.verbose);
484 if let Some(ref install) = toml.install {
485 config.prefix = install.prefix.clone().map(PathBuf::from);
486 config.sysconfdir = install.sysconfdir.clone().map(PathBuf::from);
487 config.datadir = install.datadir.clone().map(PathBuf::from);
488 config.docdir = install.docdir.clone().map(PathBuf::from);
489 config.bindir = install.bindir.clone().map(PathBuf::from);
490 config.libdir = install.libdir.clone().map(PathBuf::from);
491 config.mandir = install.mandir.clone().map(PathBuf::from);
494 // Store off these values as options because if they're not provided
495 // we'll infer default values for them later
496 let mut llvm_assertions = None;
497 let mut debug = None;
498 let mut debug_assertions = None;
499 let mut debuginfo_level = None;
500 let mut debuginfo_level_rustc = None;
501 let mut debuginfo_level_std = None;
502 let mut debuginfo_level_tools = None;
503 let mut debuginfo_level_tests = None;
504 let mut optimize = None;
505 let mut ignore_git = None;
507 if let Some(ref llvm) = toml.llvm {
509 Some(StringOrBool::String(ref s)) => {
510 config.ccache = Some(s.to_string())
512 Some(StringOrBool::Bool(true)) => {
513 config.ccache = Some("ccache".to_string());
515 Some(StringOrBool::Bool(false)) | None => {}
517 set(&mut config.ninja, llvm.ninja);
518 llvm_assertions = llvm.assertions;
519 set(&mut config.llvm_optimize, llvm.optimize);
520 set(&mut config.llvm_thin_lto, llvm.thin_lto);
521 set(&mut config.llvm_release_debuginfo, llvm.release_debuginfo);
522 set(&mut config.llvm_version_check, llvm.version_check);
523 set(&mut config.llvm_static_stdcpp, llvm.static_libstdcpp);
524 set(&mut config.llvm_link_shared, llvm.link_shared);
525 config.llvm_targets = llvm.targets.clone();
526 config.llvm_experimental_targets = llvm.experimental_targets.clone()
527 .unwrap_or_else(|| "WebAssembly;RISCV".to_string());
528 config.llvm_link_jobs = llvm.link_jobs;
529 config.llvm_version_suffix = llvm.version_suffix.clone();
530 config.llvm_clang_cl = llvm.clang_cl.clone();
532 config.llvm_cflags = llvm.cflags.clone();
533 config.llvm_cxxflags = llvm.cxxflags.clone();
534 config.llvm_ldflags = llvm.ldflags.clone();
535 set(&mut config.llvm_use_libcxx, llvm.use_libcxx);
536 config.llvm_use_linker = llvm.use_linker.clone();
537 config.llvm_allow_old_toolchain = llvm.allow_old_toolchain.clone();
540 if let Some(ref rust) = toml.rust {
542 debug_assertions = rust.debug_assertions;
543 debuginfo_level = rust.debuginfo_level;
544 debuginfo_level_rustc = rust.debuginfo_level_rustc;
545 debuginfo_level_std = rust.debuginfo_level_std;
546 debuginfo_level_tools = rust.debuginfo_level_tools;
547 debuginfo_level_tests = rust.debuginfo_level_tests;
548 optimize = rust.optimize;
549 ignore_git = rust.ignore_git;
550 set(&mut config.rust_optimize_tests, rust.optimize_tests);
551 set(&mut config.codegen_tests, rust.codegen_tests);
552 set(&mut config.rust_rpath, rust.rpath);
553 set(&mut config.jemalloc, rust.jemalloc);
554 set(&mut config.test_compare_mode, rust.test_compare_mode);
555 set(&mut config.llvm_libunwind, rust.llvm_libunwind);
556 set(&mut config.backtrace, rust.backtrace);
557 set(&mut config.channel, rust.channel.clone());
558 set(&mut config.rust_dist_src, rust.dist_src);
559 set(&mut config.verbose_tests, rust.verbose_tests);
560 set(&mut config.test_miri, rust.test_miri);
561 // in the case "false" is set explicitly, do not overwrite the command line args
562 if let Some(true) = rust.incremental {
563 config.incremental = true;
565 set(&mut config.wasm_syscall, rust.wasm_syscall);
566 set(&mut config.lld_enabled, rust.lld);
567 set(&mut config.lldb_enabled, rust.lldb);
568 set(&mut config.llvm_tools_enabled, rust.llvm_tools);
569 config.rustc_parallel = rust.parallel_compiler.unwrap_or(false);
570 config.rustc_default_linker = rust.default_linker.clone();
571 config.musl_root = rust.musl_root.clone().map(PathBuf::from);
572 config.save_toolstates = rust.save_toolstates.clone().map(PathBuf::from);
573 set(&mut config.deny_warnings, rust.deny_warnings.or(flags.warnings));
574 set(&mut config.backtrace_on_ice, rust.backtrace_on_ice);
575 set(&mut config.rust_verify_llvm_ir, rust.verify_llvm_ir);
576 set(&mut config.rust_remap_debuginfo, rust.remap_debuginfo);
578 if let Some(ref backends) = rust.codegen_backends {
579 config.rust_codegen_backends = backends.iter()
580 .map(|s| INTERNER.intern_str(s))
584 set(&mut config.rust_codegen_backends_dir, rust.codegen_backends_dir.clone());
586 match rust.codegen_units {
587 Some(0) => config.rust_codegen_units = Some(num_cpus::get() as u32),
588 Some(n) => config.rust_codegen_units = Some(n),
592 config.rust_codegen_units_std = rust.codegen_units_std;
595 if let Some(ref t) = toml.target {
596 for (triple, cfg) in t {
597 let mut target = Target::default();
599 if let Some(ref s) = cfg.llvm_config {
600 target.llvm_config = Some(config.src.join(s));
602 if let Some(ref s) = cfg.llvm_filecheck {
603 target.llvm_filecheck = Some(config.src.join(s));
605 if let Some(ref s) = cfg.android_ndk {
606 target.ndk = Some(config.src.join(s));
608 target.cc = cfg.cc.clone().map(PathBuf::from);
609 target.cxx = cfg.cxx.clone().map(PathBuf::from);
610 target.ar = cfg.ar.clone().map(PathBuf::from);
611 target.ranlib = cfg.ranlib.clone().map(PathBuf::from);
612 target.linker = cfg.linker.clone().map(PathBuf::from);
613 target.crt_static = cfg.crt_static.clone();
614 target.musl_root = cfg.musl_root.clone().map(PathBuf::from);
615 target.wasi_root = cfg.wasi_root.clone().map(PathBuf::from);
616 target.qemu_rootfs = cfg.qemu_rootfs.clone().map(PathBuf::from);
618 config.target_config.insert(INTERNER.intern_string(triple.clone()), target);
622 if let Some(ref t) = toml.dist {
623 config.dist_sign_folder = t.sign_folder.clone().map(PathBuf::from);
624 config.dist_gpg_password_file = t.gpg_password_file.clone().map(PathBuf::from);
625 config.dist_upload_addr = t.upload_addr.clone();
626 set(&mut config.rust_dist_src, t.src_tarball);
627 set(&mut config.missing_tools, t.missing_tools);
630 // Now that we've reached the end of our configuration, infer the
631 // default values for all options that we haven't otherwise stored yet.
633 set(&mut config.initial_rustc, build.rustc.map(PathBuf::from));
634 set(&mut config.initial_cargo, build.cargo.map(PathBuf::from));
637 config.llvm_assertions = llvm_assertions.unwrap_or(default);
640 config.rust_optimize = optimize.unwrap_or(default);
642 let default = debug == Some(true);
643 config.rust_debug_assertions = debug_assertions.unwrap_or(default);
645 let with_defaults = |debuginfo_level_specific: Option<u32>| {
646 debuginfo_level_specific
648 .unwrap_or(if debug == Some(true) { 2 } else { 0 })
650 config.rust_debuginfo_level_rustc = with_defaults(debuginfo_level_rustc);
651 config.rust_debuginfo_level_std = with_defaults(debuginfo_level_std);
652 config.rust_debuginfo_level_tools = with_defaults(debuginfo_level_tools);
653 config.rust_debuginfo_level_tests = debuginfo_level_tests.unwrap_or(0);
655 let default = config.channel == "dev";
656 config.ignore_git = ignore_git.unwrap_or(default);
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"))
682 || self.rust_codegen_backends.contains(&INTERNER.intern_str("emscripten"))
686 fn set<T>(field: &mut T, val: Option<T>) {
687 if let Some(v) = val {