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};
15 use serde::Deserialize;
16 use crate::cache::{INTERNER, Interned};
17 use crate::flags::Flags;
18 pub use crate::flags::Subcommand;
20 /// Global configuration for the entire build and/or bootstrap.
22 /// This structure is derived from a combination of both `config.toml` and
23 /// `config.mk`. As of the time of this writing it's unlikely that `config.toml`
24 /// is used all that much, so this is primarily filled out by `config.mk` which
25 /// is generated from `./configure`.
27 /// Note that this structure is not decoded directly into, but rather it is
28 /// filled out from the decoded forms of the structs below. For documentation
29 /// each field, see the corresponding fields in
30 /// `config.toml.example`.
33 pub ccache: Option<String>,
37 pub fast_submodules: bool,
38 pub compiler_docs: bool,
40 pub locked_deps: bool,
42 pub target_config: HashMap<Interned<String>, Target>,
43 pub full_bootstrap: bool,
45 pub tools: Option<HashSet<String>>,
49 pub exclude: Vec<PathBuf>,
50 pub rustc_error_format: Option<String>,
51 pub test_compare_mode: bool,
52 pub llvm_libunwind: bool,
54 pub skip_only_host_steps: bool,
56 pub on_fail: Option<String>,
57 pub stage: Option<u32>,
58 pub keep_stage: Vec<u32>,
60 pub jobs: Option<u32>,
62 pub incremental: bool,
65 pub deny_warnings: bool,
66 pub backtrace_on_ice: bool,
68 // llvm codegen options
69 pub llvm_assertions: bool,
70 pub llvm_optimize: bool,
71 pub llvm_thin_lto: bool,
72 pub llvm_release_debuginfo: bool,
73 pub llvm_version_check: bool,
74 pub llvm_static_stdcpp: bool,
75 pub llvm_link_shared: bool,
76 pub llvm_clang_cl: Option<String>,
77 pub llvm_targets: Option<String>,
78 pub llvm_experimental_targets: Option<String>,
79 pub llvm_link_jobs: Option<u32>,
80 pub llvm_version_suffix: Option<String>,
81 pub llvm_use_linker: Option<String>,
82 pub llvm_allow_old_toolchain: Option<bool>,
84 pub lld_enabled: bool,
85 pub lldb_enabled: bool,
86 pub llvm_tools_enabled: bool,
88 pub llvm_cflags: Option<String>,
89 pub llvm_cxxflags: Option<String>,
90 pub llvm_ldflags: Option<String>,
91 pub llvm_use_libcxx: bool,
93 // rust codegen options
94 pub rust_optimize: bool,
95 pub rust_codegen_units: Option<u32>,
96 pub rust_codegen_units_std: Option<u32>,
97 pub rust_debug_assertions: bool,
98 pub rust_debuginfo_level_rustc: u32,
99 pub rust_debuginfo_level_std: u32,
100 pub rust_debuginfo_level_tools: u32,
101 pub rust_debuginfo_level_tests: u32,
102 pub rust_rpath: bool,
103 pub rustc_parallel: bool,
104 pub rustc_default_linker: Option<String>,
105 pub rust_optimize_tests: bool,
106 pub rust_dist_src: bool,
107 pub rust_codegen_backends: Vec<Interned<String>>,
108 pub rust_codegen_backends_dir: 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,
156 /// Per-target configuration stored in the global configuration structure.
159 /// Some(path to llvm-config) if using an external LLVM.
160 pub llvm_config: Option<PathBuf>,
161 /// Some(path to FileCheck) if one was specified.
162 pub llvm_filecheck: Option<PathBuf>,
163 pub cc: Option<PathBuf>,
164 pub cxx: Option<PathBuf>,
165 pub ar: Option<PathBuf>,
166 pub ranlib: Option<PathBuf>,
167 pub linker: Option<PathBuf>,
168 pub ndk: Option<PathBuf>,
169 pub crt_static: Option<bool>,
170 pub musl_root: Option<PathBuf>,
171 pub wasi_root: Option<PathBuf>,
172 pub qemu_rootfs: Option<PathBuf>,
176 /// Structure of the `config.toml` file that configuration is read from.
178 /// This structure uses `Decodable` to automatically decode a TOML configuration
179 /// file into this format, and then this is traversed and written into the above
180 /// `Config` structure.
181 #[derive(Deserialize, Default)]
182 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
184 build: Option<Build>,
185 install: Option<Install>,
188 target: Option<HashMap<String, TomlTarget>>,
192 /// TOML representation of various global build decisions.
193 #[derive(Deserialize, Default, Clone)]
194 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
196 build: Option<String>,
201 cargo: Option<String>,
202 rustc: Option<String>,
204 compiler_docs: Option<bool>,
205 submodules: Option<bool>,
206 fast_submodules: Option<bool>,
208 nodejs: Option<String>,
209 python: Option<String>,
210 locked_deps: Option<bool>,
211 vendor: Option<bool>,
212 full_bootstrap: Option<bool>,
213 extended: Option<bool>,
214 tools: Option<HashSet<String>>,
215 verbose: Option<usize>,
216 sanitizers: Option<bool>,
217 profiler: Option<bool>,
218 cargo_native_static: Option<bool>,
219 low_priority: Option<bool>,
220 configure_args: Option<Vec<String>>,
221 local_rebuild: Option<bool>,
222 print_step_timings: Option<bool>,
225 /// TOML representation of various global install decisions.
226 #[derive(Deserialize, Default, Clone)]
227 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
229 prefix: Option<String>,
230 sysconfdir: Option<String>,
231 docdir: Option<String>,
232 bindir: Option<String>,
233 libdir: Option<String>,
234 mandir: Option<String>,
235 datadir: Option<String>,
237 // standard paths, currently unused
238 infodir: Option<String>,
239 localstatedir: Option<String>,
242 /// TOML representation of how the LLVM build is configured.
243 #[derive(Deserialize, Default)]
244 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
246 optimize: Option<bool>,
247 thin_lto: Option<bool>,
248 release_debuginfo: Option<bool>,
249 assertions: Option<bool>,
250 ccache: Option<StringOrBool>,
251 version_check: Option<bool>,
252 static_libstdcpp: Option<bool>,
254 targets: Option<String>,
255 experimental_targets: Option<String>,
256 link_jobs: Option<u32>,
257 link_shared: Option<bool>,
258 version_suffix: Option<String>,
259 clang_cl: Option<String>,
260 cflags: Option<String>,
261 cxxflags: Option<String>,
262 ldflags: Option<String>,
263 use_libcxx: Option<bool>,
264 use_linker: Option<String>,
265 allow_old_toolchain: Option<bool>,
268 #[derive(Deserialize, Default, Clone)]
269 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
271 sign_folder: Option<String>,
272 gpg_password_file: Option<String>,
273 upload_addr: Option<String>,
274 src_tarball: Option<bool>,
275 missing_tools: Option<bool>,
278 #[derive(Deserialize)]
285 impl Default for StringOrBool {
286 fn default() -> StringOrBool {
287 StringOrBool::Bool(false)
291 /// TOML representation of how the Rust build is configured.
292 #[derive(Deserialize, Default)]
293 #[serde(deny_unknown_fields, rename_all = "kebab-case")]
295 optimize: Option<bool>,
296 codegen_units: Option<u32>,
297 codegen_units_std: Option<u32>,
298 debug_assertions: Option<bool>,
299 debuginfo_level: Option<u32>,
300 debuginfo_level_rustc: Option<u32>,
301 debuginfo_level_std: Option<u32>,
302 debuginfo_level_tools: Option<u32>,
303 debuginfo_level_tests: Option<u32>,
304 parallel_compiler: Option<bool>,
305 backtrace: Option<bool>,
306 default_linker: Option<String>,
307 channel: Option<String>,
308 musl_root: Option<String>,
310 optimize_tests: Option<bool>,
311 codegen_tests: Option<bool>,
312 ignore_git: Option<bool>,
314 dist_src: Option<bool>,
315 verbose_tests: Option<bool>,
316 incremental: Option<bool>,
317 save_toolstates: Option<String>,
318 codegen_backends: Option<Vec<String>>,
319 codegen_backends_dir: Option<String>,
322 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")]
336 llvm_config: Option<String>,
337 llvm_filecheck: Option<String>,
341 ranlib: Option<String>,
342 linker: 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 // Do not trust paths from Python and normalize them slightly (#49785).
354 Some(var_val) => Path::new(&var_val).components().collect(),
355 _ => panic!("expected '{}' to be set", var_key),
359 pub fn default_opts() -> Config {
360 let mut config = Config::default();
361 config.llvm_optimize = true;
362 config.llvm_version_check = true;
363 config.backtrace = true;
364 config.rust_optimize = true;
365 config.rust_optimize_tests = true;
366 config.submodules = true;
367 config.fast_submodules = true;
369 config.rust_rpath = true;
370 config.channel = "dev".to_string();
371 config.codegen_tests = true;
372 config.ignore_git = false;
373 config.rust_dist_src = true;
374 config.rust_codegen_backends = vec![INTERNER.intern_str("llvm")];
375 config.rust_codegen_backends_dir = "codegen-backends".to_owned();
376 config.deny_warnings = true;
377 config.missing_tools = false;
379 // set by bootstrap.py
380 config.build = INTERNER.intern_str(&env::var("BUILD").expect("'BUILD' to be set"));
381 config.src = Config::path_from_python("SRC");
382 config.out = Config::path_from_python("BUILD_DIR");
384 config.initial_rustc = Config::path_from_python("RUSTC");
385 config.initial_cargo = Config::path_from_python("CARGO");
390 pub fn parse(args: &[String]) -> Config {
391 let flags = Flags::parse(&args);
392 let file = flags.config.clone();
393 let mut config = Config::default_opts();
394 config.exclude = flags.exclude;
395 config.rustc_error_format = flags.rustc_error_format;
396 config.on_fail = flags.on_fail;
397 config.stage = flags.stage;
398 config.jobs = flags.jobs.map(threads_from_config);
399 config.cmd = flags.cmd;
400 config.incremental = flags.incremental;
401 config.dry_run = flags.dry_run;
402 config.keep_stage = flags.keep_stage;
403 config.bindir = "bin".into(); // default
404 if let Some(value) = flags.deny_warnings {
405 config.deny_warnings = value;
409 let dir = config.out.join("tmp-dry-run");
410 t!(fs::create_dir_all(&dir));
414 // If --target was specified but --host wasn't specified, don't run any host-only tests.
415 let has_hosts = !flags.host.is_empty();
416 let has_targets = !flags.target.is_empty();
417 config.skip_only_host_steps = !has_hosts && has_targets;
419 let toml = file.map(|file| {
420 let contents = t!(fs::read_to_string(&file));
421 match toml::from_str(&contents) {
424 println!("failed to parse TOML configuration '{}': {}",
425 file.display(), err);
429 }).unwrap_or_else(|| TomlConfig::default());
431 let build = toml.build.clone().unwrap_or_default();
432 // set by bootstrap.py
433 config.hosts.push(config.build.clone());
434 for host in build.host.iter() {
435 let host = INTERNER.intern_str(host);
436 if !config.hosts.contains(&host) {
437 config.hosts.push(host);
440 for target in config.hosts.iter().cloned()
441 .chain(build.target.iter().map(|s| INTERNER.intern_str(s)))
443 if !config.targets.contains(&target) {
444 config.targets.push(target);
447 config.hosts = if !flags.host.is_empty() {
452 config.targets = if !flags.target.is_empty() {
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)) => {
507 config.ccache = Some(s.to_string())
509 Some(StringOrBool::Bool(true)) => {
510 config.ccache = Some("ccache".to_string());
512 Some(StringOrBool::Bool(false)) | None => {}
514 set(&mut config.ninja, llvm.ninja);
515 llvm_assertions = llvm.assertions;
516 set(&mut config.llvm_optimize, llvm.optimize);
517 set(&mut config.llvm_thin_lto, llvm.thin_lto);
518 set(&mut config.llvm_release_debuginfo, llvm.release_debuginfo);
519 set(&mut config.llvm_version_check, llvm.version_check);
520 set(&mut config.llvm_static_stdcpp, llvm.static_libstdcpp);
521 set(&mut config.llvm_link_shared, llvm.link_shared);
522 config.llvm_targets = llvm.targets.clone();
523 config.llvm_experimental_targets = llvm.experimental_targets.clone();
524 config.llvm_link_jobs = llvm.link_jobs;
525 config.llvm_version_suffix = llvm.version_suffix.clone();
526 config.llvm_clang_cl = llvm.clang_cl.clone();
528 config.llvm_cflags = llvm.cflags.clone();
529 config.llvm_cxxflags = llvm.cxxflags.clone();
530 config.llvm_ldflags = llvm.ldflags.clone();
531 set(&mut config.llvm_use_libcxx, llvm.use_libcxx);
532 config.llvm_use_linker = llvm.use_linker.clone();
533 config.llvm_allow_old_toolchain = llvm.allow_old_toolchain.clone();
536 if let Some(ref rust) = toml.rust {
538 debug_assertions = rust.debug_assertions;
539 debuginfo_level = rust.debuginfo_level;
540 debuginfo_level_rustc = rust.debuginfo_level_rustc;
541 debuginfo_level_std = rust.debuginfo_level_std;
542 debuginfo_level_tools = rust.debuginfo_level_tools;
543 debuginfo_level_tests = rust.debuginfo_level_tests;
544 optimize = rust.optimize;
545 ignore_git = rust.ignore_git;
546 set(&mut config.rust_optimize_tests, rust.optimize_tests);
547 set(&mut config.codegen_tests, rust.codegen_tests);
548 set(&mut config.rust_rpath, rust.rpath);
549 set(&mut config.jemalloc, rust.jemalloc);
550 set(&mut config.test_compare_mode, rust.test_compare_mode);
551 set(&mut config.llvm_libunwind, rust.llvm_libunwind);
552 set(&mut config.backtrace, rust.backtrace);
553 set(&mut config.channel, rust.channel.clone());
554 set(&mut config.rust_dist_src, rust.dist_src);
555 set(&mut config.verbose_tests, rust.verbose_tests);
556 // in the case "false" is set explicitly, do not overwrite the command line args
557 if let Some(true) = rust.incremental {
558 config.incremental = true;
560 set(&mut config.lld_enabled, rust.lld);
561 set(&mut config.lldb_enabled, rust.lldb);
562 set(&mut config.llvm_tools_enabled, rust.llvm_tools);
563 config.rustc_parallel = rust.parallel_compiler.unwrap_or(false);
564 config.rustc_default_linker = rust.default_linker.clone();
565 config.musl_root = rust.musl_root.clone().map(PathBuf::from);
566 config.save_toolstates = rust.save_toolstates.clone().map(PathBuf::from);
567 set(&mut config.deny_warnings, flags.deny_warnings.or(rust.deny_warnings));
568 set(&mut config.backtrace_on_ice, rust.backtrace_on_ice);
569 set(&mut config.rust_verify_llvm_ir, rust.verify_llvm_ir);
570 set(&mut config.rust_remap_debuginfo, rust.remap_debuginfo);
572 if let Some(ref backends) = rust.codegen_backends {
573 config.rust_codegen_backends = backends.iter()
574 .map(|s| INTERNER.intern_str(s))
578 set(&mut config.rust_codegen_backends_dir, rust.codegen_backends_dir.clone());
580 config.rust_codegen_units = rust.codegen_units.map(threads_from_config);
581 config.rust_codegen_units_std = rust.codegen_units_std.map(threads_from_config);
584 if let Some(ref t) = toml.target {
585 for (triple, cfg) in t {
586 let mut target = Target::default();
588 if let Some(ref s) = cfg.llvm_config {
589 target.llvm_config = Some(config.src.join(s));
591 if let Some(ref s) = cfg.llvm_filecheck {
592 target.llvm_filecheck = Some(config.src.join(s));
594 if let Some(ref s) = cfg.android_ndk {
595 target.ndk = Some(config.src.join(s));
597 target.cc = cfg.cc.clone().map(PathBuf::from);
598 target.cxx = cfg.cxx.clone().map(PathBuf::from);
599 target.ar = cfg.ar.clone().map(PathBuf::from);
600 target.ranlib = cfg.ranlib.clone().map(PathBuf::from);
601 target.linker = cfg.linker.clone().map(PathBuf::from);
602 target.crt_static = cfg.crt_static.clone();
603 target.musl_root = cfg.musl_root.clone().map(PathBuf::from);
604 target.wasi_root = cfg.wasi_root.clone().map(PathBuf::from);
605 target.qemu_rootfs = cfg.qemu_rootfs.clone().map(PathBuf::from);
607 config.target_config.insert(INTERNER.intern_string(triple.clone()), target);
611 if let Some(ref t) = toml.dist {
612 config.dist_sign_folder = t.sign_folder.clone().map(PathBuf::from);
613 config.dist_gpg_password_file = t.gpg_password_file.clone().map(PathBuf::from);
614 config.dist_upload_addr = t.upload_addr.clone();
615 set(&mut config.rust_dist_src, t.src_tarball);
616 set(&mut config.missing_tools, t.missing_tools);
619 // Now that we've reached the end of our configuration, infer the
620 // default values for all options that we haven't otherwise stored yet.
622 set(&mut config.initial_rustc, build.rustc.map(PathBuf::from));
623 set(&mut config.initial_cargo, build.cargo.map(PathBuf::from));
626 config.llvm_assertions = llvm_assertions.unwrap_or(default);
629 config.rust_optimize = optimize.unwrap_or(default);
631 let default = debug == Some(true);
632 config.rust_debug_assertions = debug_assertions.unwrap_or(default);
634 let with_defaults = |debuginfo_level_specific: Option<u32>| {
635 debuginfo_level_specific
637 .unwrap_or(if debug == Some(true) { 2 } else { 0 })
639 config.rust_debuginfo_level_rustc = with_defaults(debuginfo_level_rustc);
640 config.rust_debuginfo_level_std = with_defaults(debuginfo_level_std);
641 config.rust_debuginfo_level_tools = with_defaults(debuginfo_level_tools);
642 config.rust_debuginfo_level_tests = debuginfo_level_tests.unwrap_or(0);
644 let default = config.channel == "dev";
645 config.ignore_git = ignore_git.unwrap_or(default);
650 /// Try to find the relative path of `libdir`.
651 pub fn libdir_relative(&self) -> Option<&Path> {
652 let libdir = self.libdir.as_ref()?;
653 if libdir.is_relative() {
656 // Try to make it relative to the prefix.
657 libdir.strip_prefix(self.prefix.as_ref()?).ok()
661 pub fn verbose(&self) -> bool {
665 pub fn very_verbose(&self) -> bool {
669 pub fn llvm_enabled(&self) -> bool {
670 self.rust_codegen_backends.contains(&INTERNER.intern_str("llvm"))
671 || self.rust_codegen_backends.contains(&INTERNER.intern_str("emscripten"))
675 fn set<T>(field: &mut T, val: Option<T>) {
676 if let Some(v) = val {
681 fn threads_from_config(v: u32) -> u32 {
683 0 => num_cpus::get() as u32,