1 //! Implementation of rustbuild, the Rust build system.
3 //! This module, and its descendants, are the implementation of the Rust build
4 //! system. Most of this build system is backed by Cargo but the outer layer
5 //! here serves as the ability to orchestrate calling Cargo, sequencing Cargo
6 //! builds, building artifacts like LLVM, etc. The goals of rustbuild are:
8 //! * To be an easily understandable, easily extensible, and maintainable build
10 //! * Leverage standard tools in the Rust ecosystem to build the compiler, aka
11 //! crates.io and Cargo.
12 //! * A standard interface to build across all platforms, including MSVC
16 //! The build system defers most of the complicated logic managing invocations
17 //! of rustc and rustdoc to Cargo itself. However, moving through various stages
18 //! and copying artifacts is still necessary for it to do. Each time rustbuild
19 //! is invoked, it will iterate through the list of predefined steps and execute
20 //! each serially in turn if it matches the paths passed or is a default rule.
21 //! For each step rustbuild relies on the step internally being incremental and
22 //! parallel. Note, though, that the `-j` parameter to rustbuild gets forwarded
23 //! to appropriate test harnesses and such.
25 //! Most of the "meaty" steps that matter are backed by Cargo, which does indeed
26 //! have its own parallelism and incremental management. Later steps, like
27 //! tests, aren't incremental and simply run the entire suite currently.
28 //! However, compiletest itself tries to avoid running tests when the artifacts
29 //! that are involved (mainly the compiler) haven't changed.
31 //! When you execute `x.py build`, the steps executed are:
33 //! * First, the python script is run. This will automatically download the
34 //! stage0 rustc and cargo according to `src/stage0.json`, or use the cached
35 //! versions if they're available. These are then used to compile rustbuild
36 //! itself (using Cargo). Finally, control is then transferred to rustbuild.
38 //! * Rustbuild takes over, performs sanity checks, probes the environment,
39 //! reads configuration, and starts executing steps as it reads the command
40 //! line arguments (paths) or going through the default rules.
42 //! The build output will be something like the following:
44 //! Building stage0 std artifacts
45 //! Copying stage0 std
46 //! Building stage0 test artifacts
47 //! Copying stage0 test
48 //! Building stage0 compiler artifacts
49 //! Copying stage0 rustc
50 //! Assembling stage1 compiler
51 //! Building stage1 std artifacts
52 //! Copying stage1 std
53 //! Building stage1 test artifacts
54 //! Copying stage1 test
55 //! Building stage1 compiler artifacts
56 //! Copying stage1 rustc
57 //! Assembling stage2 compiler
58 //! Uplifting stage1 std
59 //! Uplifting stage1 test
60 //! Uplifting stage1 rustc
62 //! Let's disect that a little:
64 //! ## Building stage0 {std,test,compiler} artifacts
66 //! These steps use the provided (downloaded, usually) compiler to compile the
67 //! local Rust source into libraries we can use.
69 //! ## Copying stage0 {std,test,rustc}
71 //! This copies the build output from Cargo into
72 //! `build/$HOST/stage0-sysroot/lib/rustlib/$ARCH/lib`. FIXME: this step's
73 //! documentation should be expanded -- the information already here may be
76 //! ## Assembling stage1 compiler
78 //! This copies the libraries we built in "building stage0 ... artifacts" into
79 //! the stage1 compiler's lib directory. These are the host libraries that the
80 //! compiler itself uses to run. These aren't actually used by artifacts the new
81 //! compiler generates. This step also copies the rustc and rustdoc binaries we
82 //! generated into build/$HOST/stage/bin.
84 //! The stage1/bin/rustc is a fully functional compiler, but it doesn't yet have
85 //! any libraries to link built binaries or libraries to. The next 3 steps will
86 //! provide those libraries for it; they are mostly equivalent to constructing
87 //! the stage1/bin compiler so we don't go through them individually.
89 //! ## Uplifting stage1 {std,test,rustc}
91 //! This step copies the libraries from the stage1 compiler sysroot into the
92 //! stage2 compiler. This is done to avoid rebuilding the compiler; libraries
93 //! we'd build in this step should be identical (in function, if not necessarily
94 //! identical on disk) so there's no need to recompile the compiler again. Note
95 //! that if you want to, you can enable the full-bootstrap option to change this
98 //! Each step is driven by a separate Cargo project and rustbuild orchestrates
99 //! copying files between steps and otherwise preparing for Cargo to run.
101 //! ## Further information
103 //! More documentation can be found in each respective module below, and you can
104 //! also check out the `src/bootstrap/README.md` file for more information.
106 use std::cell::{Cell, RefCell};
107 use std::collections::{HashMap, HashSet};
109 use std::fs::{self, File};
111 use std::path::{Path, PathBuf};
112 use std::process::Command;
115 use filetime::FileTime;
116 use once_cell::sync::OnceCell;
118 use crate::builder::Kind;
119 use crate::config::{LlvmLibunwind, TargetSelection};
121 check_run, exe, libdir, mtime, output, run, run_suppressed, try_run, try_run_suppressed, CiEnv,
148 #[cfg(feature = "build-metrics")]
154 #[cfg(all(unix, not(target_os = "haiku")))]
156 pub unsafe fn setup(build: &mut crate::Build) {
157 if build.config.low_priority {
158 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
163 #[cfg(any(target_os = "haiku", target_os = "hermit", not(any(unix, windows))))]
165 pub unsafe fn setup(_build: &mut crate::Build) {}
168 pub use crate::builder::PathSet;
169 use crate::cache::{Interned, INTERNER};
170 pub use crate::config::Config;
171 pub use crate::flags::Subcommand;
173 const LLVM_TOOLS: &[&str] = &[
174 "llvm-cov", // used to generate coverage report
175 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
176 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
177 "llvm-objdump", // used to disassemble programs
178 "llvm-profdata", // used to inspect and merge files generated by profiles
179 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
180 "llvm-size", // used to prints the size of the linker sections of a program
181 "llvm-strip", // used to discard symbols from binary files to reduce their size
182 "llvm-ar", // used for creating and modifying archive files
183 "llvm-as", // used to convert LLVM assembly to LLVM bitcode
184 "llvm-dis", // used to disassemble LLVM bitcode
185 "llc", // used to compile LLVM bytecode
186 "opt", // used to optimize LLVM bytecode
189 pub const VERSION: usize = 2;
191 /// Extra --check-cfg to add when building
192 /// (Mode restriction, config name, config values (if any))
193 const EXTRA_CHECK_CFGS: &[(Option<Mode>, &'static str, Option<&[&'static str]>)] = &[
194 (None, "bootstrap", None),
195 (Some(Mode::Rustc), "parallel_compiler", None),
196 (Some(Mode::ToolRustc), "parallel_compiler", None),
197 (Some(Mode::Std), "stdarch_intel_sde", None),
198 (Some(Mode::Std), "no_fp_fmt_parse", None),
199 (Some(Mode::Std), "no_global_oom_handling", None),
200 (Some(Mode::Std), "freebsd12", None),
201 (Some(Mode::Std), "backtrace_in_libstd", None),
202 /* Extra values not defined in the built-in targets yet, but used in std */
203 (Some(Mode::Std), "target_env", Some(&["libnx"])),
204 (Some(Mode::Std), "target_os", Some(&["watchos"])),
208 Some(&["asmjs", "spirv", "nvptx", "nvptx64", "le32", "xtensa"]),
210 /* Extra names used by dependencies */
211 // FIXME: Used by rustfmt is their test but is invalid (neither cargo nor bootstrap ever set
212 // this config) should probably by removed or use a allow attribute.
213 (Some(Mode::ToolRustc), "release", None),
214 // FIXME: Used by stdarch in their test, should use a allow attribute instead.
215 (Some(Mode::Std), "dont_compile_me", None),
216 // FIXME: Used by serde_json, but we should not be triggering on external dependencies.
217 (Some(Mode::Rustc), "no_btreemap_remove_entry", None),
218 (Some(Mode::ToolRustc), "no_btreemap_remove_entry", None),
219 // FIXME: Used by crossbeam-utils, but we should not be triggering on external dependencies.
220 (Some(Mode::Rustc), "crossbeam_loom", None),
221 (Some(Mode::ToolRustc), "crossbeam_loom", None),
222 // FIXME: Used by proc-macro2, but we should not be triggering on external dependencies.
223 (Some(Mode::Rustc), "span_locations", None),
224 (Some(Mode::ToolRustc), "span_locations", None),
227 /// A structure representing a Rust compiler.
229 /// Each compiler has a `stage` that it is associated with and a `host` that
230 /// corresponds to the platform the compiler runs on. This structure is used as
231 /// a parameter to many methods below.
232 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
233 pub struct Compiler {
235 host: TargetSelection,
238 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
240 /// Run normal tests and doc tests (default).
242 /// Do not run any doc tests.
244 /// Only run doc tests.
253 /// Global configuration for the build system.
255 /// This structure transitively contains all configuration for the build system.
256 /// All filesystem-encoded configuration is in `config`, all flags are in
257 /// `flags`, and then parsed or probed information is listed in the keys below.
259 /// This structure is a parameter of almost all methods in the build system,
260 /// although most functions are implemented as free functions rather than
261 /// methods specifically on this structure itself (to make it easier to
264 /// User-specified configuration from `config.toml`.
267 // Version information
270 // Properties derived from the above configuration
273 bootstrap_out: PathBuf,
274 rust_info: channel::GitInfo,
275 cargo_info: channel::GitInfo,
276 rust_analyzer_info: channel::GitInfo,
277 clippy_info: channel::GitInfo,
278 miri_info: channel::GitInfo,
279 rustfmt_info: channel::GitInfo,
280 in_tree_llvm_info: channel::GitInfo,
286 // Targets for which to build
287 build: TargetSelection,
288 hosts: Vec<TargetSelection>,
289 targets: Vec<TargetSelection>,
291 initial_rustc: PathBuf,
292 initial_cargo: PathBuf,
293 initial_lld: PathBuf,
294 initial_libdir: PathBuf,
296 // Runtime state filled in later on
297 // C/C++ compilers and archiver for all targets
298 cc: HashMap<TargetSelection, cc::Tool>,
299 cxx: HashMap<TargetSelection, cc::Tool>,
300 ar: HashMap<TargetSelection, PathBuf>,
301 ranlib: HashMap<TargetSelection, PathBuf>,
303 // allow bidirectional lookups: both name -> path and path -> name
304 crates: HashMap<Interned<String>, Crate>,
305 crate_paths: HashMap<PathBuf, Interned<String>>,
308 delayed_failures: RefCell<Vec<String>>,
309 prerelease_version: Cell<Option<u32>>,
311 RefCell<HashMap<TargetSelection, HashMap<String, (&'static str, PathBuf, Vec<String>)>>>,
313 #[cfg(feature = "build-metrics")]
314 metrics: metrics::BuildMetrics,
319 name: Interned<String>,
320 deps: HashSet<Interned<String>>,
325 fn local_path(&self, build: &Build) -> PathBuf {
326 self.path.strip_prefix(&build.config.src).unwrap().into()
330 /// When building Rust various objects are handled differently.
331 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
332 pub enum DependencyType {
333 /// Libraries originating from proc-macros.
335 /// Typical Rust libraries.
337 /// Non Rust libraries and objects shipped to ease usage of certain targets.
341 /// The various "modes" of invoking Cargo.
343 /// These entries currently correspond to the various output directories of the
344 /// build system, with each mod generating output in a different directory.
345 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
347 /// Build the standard library, placing output in the "stageN-std" directory.
350 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
353 /// Build a codegen backend for rustc, placing the output in the "stageN-codegen" directory.
356 /// Build a tool, placing output in the "stage0-bootstrap-tools"
357 /// directory. This is for miscellaneous sets of tools that are built
358 /// using the bootstrap stage0 compiler in its entirety (target libraries
359 /// and all). Typically these tools compile with stable Rust.
362 /// Build a tool which uses the locally built std, placing output in the
363 /// "stageN-tools" directory. Its usage is quite rare, mainly used by
364 /// compiletest which needs libtest.
367 /// Build a tool which uses the locally built rustc and the target std,
368 /// placing the output in the "stageN-tools" directory. This is used for
369 /// anything that needs a fully functional rustc, such as rustdoc, clippy,
370 /// cargo, rls, rustfmt, miri, etc.
375 pub fn is_tool(&self) -> bool {
376 matches!(self, Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd)
379 pub fn must_support_dlopen(&self) -> bool {
380 matches!(self, Mode::Std | Mode::Codegen)
390 /// Creates a new set of build configuration from the `flags` on the command
391 /// line and the filesystem `config`.
393 /// By default all build output will be placed in the current directory.
394 pub fn new(config: Config) -> Build {
395 let src = config.src.clone();
396 let out = config.out.clone();
398 let is_sudo = match env::var_os("SUDO_USER") {
399 Some(sudo_user) => match env::var_os("USER") {
400 Some(user) => user != sudo_user,
406 let ignore_git = config.ignore_git;
407 let rust_info = channel::GitInfo::new(ignore_git, &src);
408 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
409 let rust_analyzer_info =
410 channel::GitInfo::new(ignore_git, &src.join("src/tools/rust-analyzer"));
411 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
412 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
413 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
415 // we always try to use git for LLVM builds
416 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
418 let initial_target_libdir_str = if config.dry_run {
419 "/dummy/lib/path/to/lib/".to_string()
422 Command::new(&config.initial_rustc)
424 .arg(config.build.rustc_target_arg())
426 .arg("target-libdir"),
429 let initial_target_dir = Path::new(&initial_target_libdir_str).parent().unwrap();
430 let initial_lld = initial_target_dir.join("bin").join("rust-lld");
432 let initial_sysroot = if config.dry_run {
435 output(Command::new(&config.initial_rustc).arg("--print").arg("sysroot"))
437 let initial_libdir = initial_target_dir
442 .strip_prefix(initial_sysroot.trim())
446 let version = std::fs::read_to_string(src.join("src").join("version"))
447 .expect("failed to read src/version");
448 let version = version.trim();
450 let bootstrap_out = if std::env::var("BOOTSTRAP_PYTHON").is_ok() {
451 out.join("bootstrap").join("debug")
453 let workspace_target_dir = std::env::var("CARGO_TARGET_DIR")
455 .unwrap_or_else(|_| src.join("target"));
456 let bootstrap_out = workspace_target_dir.join("debug");
457 if !bootstrap_out.join("rustc").exists() && !cfg!(test) {
458 // this restriction can be lifted whenever https://github.com/rust-lang/rfcs/pull/3028 is implemented
459 panic!("run `cargo build --bins` before `cargo run`")
464 let mut build = Build {
465 initial_rustc: config.initial_rustc.clone(),
466 initial_cargo: config.initial_cargo.clone(),
469 local_rebuild: config.local_rebuild,
470 fail_fast: config.cmd.fail_fast(),
471 doc_tests: config.cmd.doc_tests(),
472 verbosity: config.verbose,
475 hosts: config.hosts.clone(),
476 targets: config.targets.clone(),
479 version: version.to_string(),
494 ranlib: HashMap::new(),
495 crates: HashMap::new(),
496 crate_paths: HashMap::new(),
498 ci_env: CiEnv::current(),
499 delayed_failures: RefCell::new(Vec::new()),
500 prerelease_version: Cell::new(None),
501 tool_artifacts: Default::default(),
503 #[cfg(feature = "build-metrics")]
504 metrics: metrics::BuildMetrics::init(),
507 build.verbose("finding compilers");
508 cc_detect::find(&mut build);
509 // When running `setup`, the profile is about to change, so any requirements we have now may
510 // be different on the next invocation. Don't check for them until the next time x.py is
511 // run. This is ok because `setup` never runs any build commands, so it won't fail if commands are missing.
512 if !matches!(build.config.cmd, Subcommand::Setup { .. }) {
513 build.verbose("running sanity check");
514 sanity::check(&mut build);
517 // If local-rust is the same major.minor as the current version, then force a
519 let local_version_verbose =
520 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
521 let local_release = local_version_verbose
523 .filter_map(|x| x.strip_prefix("release:"))
527 if local_release.split('.').take(2).eq(version.split('.').take(2)) {
528 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
529 build.local_rebuild = true;
532 // Make sure we update these before gathering metadata so we don't get an error about missing
534 let rust_submodules = [
535 "src/tools/rust-installer",
541 for s in rust_submodules {
542 build.update_submodule(Path::new(s));
545 build.verbose("learning about cargo");
546 metadata::build(&mut build);
551 // modified from `check_submodule` and `update_submodule` in bootstrap.py
552 /// Given a path to the directory of a submodule, update it.
554 /// `relative_path` should be relative to the root of the git repository, not an absolute path.
555 pub(crate) fn update_submodule(&self, relative_path: &Path) {
556 fn dir_is_empty(dir: &Path) -> bool {
557 t!(std::fs::read_dir(dir)).next().is_none()
560 if !self.config.submodules(&self.rust_info) {
564 let absolute_path = self.config.src.join(relative_path);
566 // NOTE: The check for the empty directory is here because when running x.py the first time,
567 // the submodule won't be checked out. Check it out now so we can build it.
568 if !channel::GitInfo::new(false, &absolute_path).is_git() && !dir_is_empty(&absolute_path) {
573 let checked_out_hash =
574 output(Command::new("git").args(&["rev-parse", "HEAD"]).current_dir(&absolute_path));
576 let recorded = output(
578 .args(&["ls-tree", "HEAD"])
580 .current_dir(&self.config.src),
582 let actual_hash = recorded
585 .unwrap_or_else(|| panic!("unexpected output `{}`", recorded));
588 if actual_hash == checked_out_hash.trim_end() {
589 // already checked out
593 println!("Updating submodule {}", relative_path.display());
596 .args(&["submodule", "-q", "sync"])
598 .current_dir(&self.config.src),
601 // Try passing `--progress` to start, then run git again without if that fails.
602 let update = |progress: bool| {
603 let mut git = Command::new("git");
604 git.args(&["submodule", "update", "--init", "--recursive", "--depth=1"]);
606 git.arg("--progress");
608 git.arg(relative_path).current_dir(&self.config.src);
611 // NOTE: doesn't use `try_run` because this shouldn't print an error if it fails.
612 if !update(true).status().map_or(false, |status| status.success()) {
613 self.run(&mut update(false));
616 self.run(Command::new("git").args(&["reset", "-q", "--hard"]).current_dir(&absolute_path));
617 self.run(Command::new("git").args(&["clean", "-qdfx"]).current_dir(absolute_path));
620 /// If any submodule has been initialized already, sync it unconditionally.
621 /// This avoids contributors checking in a submodule change by accident.
622 pub fn maybe_update_submodules(&self) {
623 // Avoid running git when there isn't a git checkout.
624 if !self.config.submodules(&self.rust_info) {
630 .args(&["config", "--file"])
631 .arg(&self.config.src.join(".gitmodules"))
632 .args(&["--get-regexp", "path"]),
634 for line in output.lines() {
635 // Look for `submodule.$name.path = $path`
636 // Sample output: `submodule.src/rust-installer.path src/tools/rust-installer`
637 let submodule = Path::new(line.splitn(2, ' ').nth(1).unwrap());
638 // Don't update the submodule unless it's already been cloned.
639 if channel::GitInfo::new(false, submodule).is_git() {
640 self.update_submodule(submodule);
645 /// Executes the entire build, as configured by the flags and configuration.
646 pub fn build(&mut self) {
651 self.maybe_update_submodules();
653 if let Subcommand::Format { check, paths } = &self.config.cmd {
654 return format::format(&builder::Builder::new(&self), *check, &paths);
657 if let Subcommand::Clean { all } = self.config.cmd {
658 return clean::clean(self, all);
661 if let Subcommand::Setup { profile } = &self.config.cmd {
662 return setup::setup(&self.config, *profile);
666 let builder = builder::Builder::new(&self);
667 if let Some(path) = builder.paths.get(0) {
668 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
674 if !self.config.dry_run {
676 self.config.dry_run = true;
677 let builder = builder::Builder::new(&self);
678 builder.execute_cli();
680 self.config.dry_run = false;
681 let builder = builder::Builder::new(&self);
682 builder.execute_cli();
684 let builder = builder::Builder::new(&self);
685 builder.execute_cli();
688 // Check for postponed failures from `test --no-fail-fast`.
689 let failures = self.delayed_failures.borrow();
690 if failures.len() > 0 {
691 eprintln!("\n{} command(s) did not execute successfully:\n", failures.len());
692 for failure in failures.iter() {
693 eprintln!(" - {}\n", failure);
698 #[cfg(feature = "build-metrics")]
699 self.metrics.persist(self);
702 /// Clear out `dir` if `input` is newer.
704 /// After this executes, it will also ensure that `dir` exists.
705 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
706 let stamp = dir.join(".stamp");
707 let mut cleared = false;
708 if mtime(&stamp) < mtime(input) {
709 self.verbose(&format!("Dirty - {}", dir.display()));
710 let _ = fs::remove_dir_all(dir);
712 } else if stamp.exists() {
715 t!(fs::create_dir_all(dir));
716 t!(File::create(stamp));
720 /// Gets the space-separated set of activated features for the standard
722 fn std_features(&self, target: TargetSelection) -> String {
723 let mut features = "panic-unwind".to_string();
725 match self.config.llvm_libunwind(target) {
726 LlvmLibunwind::InTree => features.push_str(" llvm-libunwind"),
727 LlvmLibunwind::System => features.push_str(" system-llvm-libunwind"),
728 LlvmLibunwind::No => {}
730 if self.config.backtrace {
731 features.push_str(" backtrace");
733 if self.config.profiler_enabled(target) {
734 features.push_str(" profiler");
739 /// Gets the space-separated set of activated features for the compiler.
740 fn rustc_features(&self, kind: Kind) -> String {
741 let mut features = vec![];
742 if self.config.jemalloc {
743 features.push("jemalloc");
745 if self.config.llvm_enabled() || kind == Kind::Check {
746 features.push("llvm");
748 // keep in sync with `bootstrap/compile.rs:rustc_cargo_env`
749 if self.config.rustc_parallel {
750 features.push("rustc_use_parallel_compiler");
753 // If debug logging is on, then we want the default for tracing:
754 // https://github.com/tokio-rs/tracing/blob/3dd5c03d907afdf2c39444a29931833335171554/tracing/src/level_filters.rs#L26
755 // which is everything (including debug/trace/etc.)
756 // if its unset, if debug_assertions is on, then debug_logging will also be on
757 // as well as tracing *ignoring* this feature when debug_assertions is on
758 if !self.config.rust_debug_logging {
759 features.push("max_level_info");
765 /// Component directory that Cargo will produce output into (e.g.
767 fn cargo_dir(&self) -> &'static str {
768 if self.config.rust_optimize { "release" } else { "debug" }
771 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
774 .join(&*compiler.host.triple)
775 .join(format!("stage{}-tools-bin", compiler.stage));
776 t!(fs::create_dir_all(&out));
780 /// Returns the root directory for all output generated in a particular
781 /// stage when running with a particular host compiler.
783 /// The mode indicates what the root directory is for.
784 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
785 let suffix = match mode {
787 Mode::Rustc => "-rustc",
788 Mode::Codegen => "-codegen",
789 Mode::ToolBootstrap => "-bootstrap-tools",
790 Mode::ToolStd | Mode::ToolRustc => "-tools",
792 self.out.join(&*compiler.host.triple).join(format!("stage{}{}", compiler.stage, suffix))
795 /// Returns the root output directory for all Cargo output in a given stage,
796 /// running a particular compiler, whether or not we're building the
797 /// standard library, and targeting the specified architecture.
798 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: TargetSelection) -> PathBuf {
799 self.stage_out(compiler, mode).join(&*target.triple).join(self.cargo_dir())
802 /// Root output directory for LLVM compiled for `target`
804 /// Note that if LLVM is configured externally then the directory returned
805 /// will likely be empty.
806 fn llvm_out(&self, target: TargetSelection) -> PathBuf {
807 self.out.join(&*target.triple).join("llvm")
810 fn lld_out(&self, target: TargetSelection) -> PathBuf {
811 self.out.join(&*target.triple).join("lld")
814 /// Output directory for all documentation for a target
815 fn doc_out(&self, target: TargetSelection) -> PathBuf {
816 self.out.join(&*target.triple).join("doc")
819 fn test_out(&self, target: TargetSelection) -> PathBuf {
820 self.out.join(&*target.triple).join("test")
823 /// Output directory for all documentation for a target
824 fn compiler_doc_out(&self, target: TargetSelection) -> PathBuf {
825 self.out.join(&*target.triple).join("compiler-doc")
828 /// Output directory for some generated md crate documentation for a target (temporary)
829 fn md_doc_out(&self, target: TargetSelection) -> Interned<PathBuf> {
830 INTERNER.intern_path(self.out.join(&*target.triple).join("md-doc"))
833 /// Returns `true` if no custom `llvm-config` is set for the specified target.
835 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
836 fn is_rust_llvm(&self, target: TargetSelection) -> bool {
837 if self.config.llvm_from_ci && target == self.config.build {
841 match self.config.target_config.get(&target) {
842 Some(ref c) => c.llvm_config.is_none(),
847 /// Returns the path to `FileCheck` binary for the specified target
848 fn llvm_filecheck(&self, target: TargetSelection) -> PathBuf {
849 let target_config = self.config.target_config.get(&target);
850 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
852 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
853 let llvm_bindir = output(Command::new(s).arg("--bindir"));
854 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", target));
855 if filecheck.exists() {
858 // On Fedora the system LLVM installs FileCheck in the
859 // llvm subdirectory of the libdir.
860 let llvm_libdir = output(Command::new(s).arg("--libdir"));
862 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", target));
863 if lib_filecheck.exists() {
866 // Return the most normal file name, even though
867 // it doesn't exist, so that any error message
873 let base = self.llvm_out(target).join("build");
874 let base = if !self.ninja() && target.contains("msvc") {
875 if self.config.llvm_optimize {
876 if self.config.llvm_release_debuginfo {
877 base.join("RelWithDebInfo")
887 base.join("bin").join(exe("FileCheck", target))
891 /// Directory for libraries built from C/C++ code and shared between stages.
892 fn native_dir(&self, target: TargetSelection) -> PathBuf {
893 self.out.join(&*target.triple).join("native")
896 /// Root output directory for rust_test_helpers library compiled for
898 fn test_helpers_out(&self, target: TargetSelection) -> PathBuf {
899 self.native_dir(target).join("rust-test-helpers")
902 /// Adds the `RUST_TEST_THREADS` env var if necessary
903 fn add_rust_test_threads(&self, cmd: &mut Command) {
904 if env::var_os("RUST_TEST_THREADS").is_none() {
905 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
909 /// Returns the libdir of the snapshot compiler.
910 fn rustc_snapshot_libdir(&self) -> PathBuf {
911 self.rustc_snapshot_sysroot().join(libdir(self.config.build))
914 /// Returns the sysroot of the snapshot compiler.
915 fn rustc_snapshot_sysroot(&self) -> &Path {
916 static SYSROOT_CACHE: OnceCell<PathBuf> = once_cell::sync::OnceCell::new();
917 SYSROOT_CACHE.get_or_init(|| {
918 let mut rustc = Command::new(&self.initial_rustc);
919 rustc.args(&["--print", "sysroot"]);
920 output(&mut rustc).trim().into()
924 /// Runs a command, printing out nice contextual information if it fails.
925 fn run(&self, cmd: &mut Command) {
926 if self.config.dry_run {
929 self.verbose(&format!("running: {:?}", cmd));
930 run(cmd, self.is_verbose())
933 /// Runs a command, printing out nice contextual information if it fails.
934 fn run_quiet(&self, cmd: &mut Command) {
935 if self.config.dry_run {
938 self.verbose(&format!("running: {:?}", cmd));
942 /// Runs a command, printing out nice contextual information if it fails.
943 /// Exits if the command failed to execute at all, otherwise returns its
944 /// `status.success()`.
945 fn try_run(&self, cmd: &mut Command) -> bool {
946 if self.config.dry_run {
949 self.verbose(&format!("running: {:?}", cmd));
950 try_run(cmd, self.is_verbose())
953 /// Runs a command, printing out nice contextual information if it fails.
954 /// Exits if the command failed to execute at all, otherwise returns its
955 /// `status.success()`.
956 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
957 if self.config.dry_run {
960 self.verbose(&format!("running: {:?}", cmd));
961 try_run_suppressed(cmd)
964 /// Runs a command, printing out nice contextual information if it fails.
965 /// Returns false if do not execute at all, otherwise returns its
966 /// `status.success()`.
967 fn check_run(&self, cmd: &mut Command) -> bool {
968 if self.config.dry_run {
971 self.verbose(&format!("running: {:?}", cmd));
972 check_run(cmd, self.is_verbose())
975 pub fn is_verbose(&self) -> bool {
979 /// Prints a message if this build is configured in verbose mode.
980 fn verbose(&self, msg: &str) {
981 if self.is_verbose() {
986 pub fn is_verbose_than(&self, level: usize) -> bool {
987 self.verbosity > level
990 /// Prints a message if this build is configured in more verbose mode than `level`.
991 fn verbose_than(&self, level: usize, msg: &str) {
992 if self.is_verbose_than(level) {
997 fn info(&self, msg: &str) {
998 if self.config.dry_run {
1001 println!("{}", msg);
1004 /// Returns the number of parallel jobs that have been configured for this
1006 fn jobs(&self) -> u32 {
1007 self.config.jobs.unwrap_or_else(|| {
1008 std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get) as u32
1012 fn debuginfo_map_to(&self, which: GitRepo) -> Option<String> {
1013 if !self.config.rust_remap_debuginfo {
1019 let sha = self.rust_sha().unwrap_or(&self.version);
1020 Some(format!("/rustc/{}", sha))
1022 GitRepo::Llvm => Some(String::from("/rustc/llvm")),
1026 /// Returns the path to the C compiler for the target specified.
1027 fn cc(&self, target: TargetSelection) -> &Path {
1028 self.cc[&target].path()
1031 /// Returns a list of flags to pass to the C compiler for the target
1033 fn cflags(&self, target: TargetSelection, which: GitRepo, c: CLang) -> Vec<String> {
1034 let base = match c {
1035 CLang::C => &self.cc[&target],
1036 CLang::Cxx => &self.cxx[&target],
1039 // Filter out -O and /O (the optimization flags) that we picked up from
1040 // cc-rs because the build scripts will determine that for themselves.
1044 .map(|s| s.to_string_lossy().into_owned())
1045 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
1046 .collect::<Vec<String>>();
1048 // If we're compiling on macOS then we add a few unconditional flags
1049 // indicating that we want libc++ (more filled out than libstdc++) and
1050 // we want to compile for 10.7. This way we can ensure that
1051 // LLVM/etc are all properly compiled.
1052 if target.contains("apple-darwin") {
1053 base.push("-stdlib=libc++".into());
1056 // Work around an apparently bad MinGW / GCC optimization,
1057 // See: https://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
1058 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
1059 if &*target.triple == "i686-pc-windows-gnu" {
1060 base.push("-fno-omit-frame-pointer".into());
1063 if let Some(map_to) = self.debuginfo_map_to(which) {
1064 let map = format!("{}={}", self.src.display(), map_to);
1065 let cc = self.cc(target);
1066 if cc.ends_with("clang") || cc.ends_with("gcc") {
1067 base.push(format!("-fdebug-prefix-map={}", map));
1068 } else if cc.ends_with("clang-cl.exe") {
1069 base.push("-Xclang".into());
1070 base.push(format!("-fdebug-prefix-map={}", map));
1076 /// Returns the path to the `ar` archive utility for the target specified.
1077 fn ar(&self, target: TargetSelection) -> Option<&Path> {
1078 self.ar.get(&target).map(|p| &**p)
1081 /// Returns the path to the `ranlib` utility for the target specified.
1082 fn ranlib(&self, target: TargetSelection) -> Option<&Path> {
1083 self.ranlib.get(&target).map(|p| &**p)
1086 /// Returns the path to the C++ compiler for the target specified.
1087 fn cxx(&self, target: TargetSelection) -> Result<&Path, String> {
1088 match self.cxx.get(&target) {
1089 Some(p) => Ok(p.path()),
1091 Err(format!("target `{}` is not configured as a host, only as a target", target))
1096 /// Returns the path to the linker for the given target if it needs to be overridden.
1097 fn linker(&self, target: TargetSelection) -> Option<&Path> {
1098 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
1101 } else if target.contains("vxworks") {
1102 // need to use CXX compiler as linker to resolve the exception functions
1103 // that are only existed in CXX libraries
1104 Some(self.cxx[&target].path())
1105 } else if target != self.config.build
1106 && util::use_host_linker(target)
1107 && !target.contains("msvc")
1109 Some(self.cc(target))
1110 } else if self.config.use_lld && !self.is_fuse_ld_lld(target) && self.build == target {
1111 Some(&self.initial_lld)
1117 // LLD is used through `-fuse-ld=lld` rather than directly.
1118 // Only MSVC targets use LLD directly at the moment.
1119 fn is_fuse_ld_lld(&self, target: TargetSelection) -> bool {
1120 self.config.use_lld && !target.contains("msvc")
1123 fn lld_flags(&self, target: TargetSelection) -> impl Iterator<Item = String> {
1124 let mut options = [None, None];
1126 if self.config.use_lld {
1127 if self.is_fuse_ld_lld(target) {
1128 options[0] = Some("-Clink-arg=-fuse-ld=lld".to_string());
1131 let threads = if target.contains("windows") { "/threads:1" } else { "--threads=1" };
1132 options[1] = Some(format!("-Clink-arg=-Wl,{}", threads));
1135 IntoIterator::into_iter(options).flatten()
1138 /// Returns if this target should statically link the C runtime, if specified
1139 fn crt_static(&self, target: TargetSelection) -> Option<bool> {
1140 if target.contains("pc-windows-msvc") {
1143 self.config.target_config.get(&target).and_then(|t| t.crt_static)
1147 /// Returns the "musl root" for this `target`, if defined
1148 fn musl_root(&self, target: TargetSelection) -> Option<&Path> {
1152 .and_then(|t| t.musl_root.as_ref())
1153 .or_else(|| self.config.musl_root.as_ref())
1157 /// Returns the "musl libdir" for this `target`.
1158 fn musl_libdir(&self, target: TargetSelection) -> Option<PathBuf> {
1159 let t = self.config.target_config.get(&target)?;
1160 if let libdir @ Some(_) = &t.musl_libdir {
1161 return libdir.clone();
1163 self.musl_root(target).map(|root| root.join("lib"))
1166 /// Returns the sysroot for the wasi target, if defined
1167 fn wasi_root(&self, target: TargetSelection) -> Option<&Path> {
1168 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
1171 /// Returns `true` if this is a no-std `target`, if defined
1172 fn no_std(&self, target: TargetSelection) -> Option<bool> {
1173 self.config.target_config.get(&target).map(|t| t.no_std)
1176 /// Returns `true` if the target will be tested using the `remote-test-client`
1177 /// and `remote-test-server` binaries.
1178 fn remote_tested(&self, target: TargetSelection) -> bool {
1179 self.qemu_rootfs(target).is_some()
1180 || target.contains("android")
1181 || env::var_os("TEST_DEVICE_ADDR").is_some()
1184 /// Returns the root of the "rootfs" image that this target will be using,
1185 /// if one was configured.
1187 /// If `Some` is returned then that means that tests for this target are
1188 /// emulated with QEMU and binaries will need to be shipped to the emulator.
1189 fn qemu_rootfs(&self, target: TargetSelection) -> Option<&Path> {
1190 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
1193 /// Path to the python interpreter to use
1194 fn python(&self) -> &Path {
1195 if self.config.build.ends_with("apple-darwin") {
1196 // Force /usr/bin/python3 on macOS for LLDB tests because we're loading the
1197 // LLDB plugin's compiled module which only works with the system python
1198 // (namely not Homebrew-installed python)
1199 Path::new("/usr/bin/python3")
1204 .expect("python is required for running LLDB or rustdoc tests")
1208 /// Temporary directory that extended error information is emitted to.
1209 fn extended_error_dir(&self) -> PathBuf {
1210 self.out.join("tmp/extended-error-metadata")
1213 /// Tests whether the `compiler` compiling for `target` should be forced to
1214 /// use a stage1 compiler instead.
1216 /// Currently, by default, the build system does not perform a "full
1217 /// bootstrap" by default where we compile the compiler three times.
1218 /// Instead, we compile the compiler two times. The final stage (stage2)
1219 /// just copies the libraries from the previous stage, which is what this
1222 /// Here we return `true` if:
1224 /// * The build isn't performing a full bootstrap
1225 /// * The `compiler` is in the final stage, 2
1226 /// * We're not cross-compiling, so the artifacts are already available in
1229 /// When all of these conditions are met the build will lift artifacts from
1230 /// the previous stage forward.
1231 fn force_use_stage1(&self, compiler: Compiler, target: TargetSelection) -> bool {
1232 !self.config.full_bootstrap
1233 && compiler.stage >= 2
1234 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
1237 /// Given `num` in the form "a.b.c" return a "release string" which
1238 /// describes the release version number.
1240 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
1241 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
1242 fn release(&self, num: &str) -> String {
1243 match &self.config.channel[..] {
1244 "stable" => num.to_string(),
1246 if self.rust_info.is_git() && !self.config.ignore_git {
1247 format!("{}-beta.{}", num, self.beta_prerelease_version())
1249 format!("{}-beta", num)
1252 "nightly" => format!("{}-nightly", num),
1253 _ => format!("{}-dev", num),
1257 fn beta_prerelease_version(&self) -> u32 {
1258 if let Some(s) = self.prerelease_version.get() {
1262 // Figure out how many merge commits happened since we branched off master.
1263 // That's our beta number!
1264 // (Note that we use a `..` range, not the `...` symmetric difference.)
1266 output(self.config.git().arg("rev-list").arg("--count").arg("--merges").arg(format!(
1267 "refs/remotes/origin/{}..HEAD",
1268 self.config.stage0_metadata.config.nightly_branch
1270 let n = count.trim().parse().unwrap();
1271 self.prerelease_version.set(Some(n));
1275 /// Returns the value of `release` above for Rust itself.
1276 fn rust_release(&self) -> String {
1277 self.release(&self.version)
1280 /// Returns the "package version" for a component given the `num` release
1283 /// The package version is typically what shows up in the names of tarballs.
1284 /// For channels like beta/nightly it's just the channel name, otherwise
1285 /// it's the `num` provided.
1286 fn package_vers(&self, num: &str) -> String {
1287 match &self.config.channel[..] {
1288 "stable" => num.to_string(),
1289 "beta" => "beta".to_string(),
1290 "nightly" => "nightly".to_string(),
1291 _ => format!("{}-dev", num),
1295 /// Returns the value of `package_vers` above for Rust itself.
1296 fn rust_package_vers(&self) -> String {
1297 self.package_vers(&self.version)
1300 fn llvm_link_tools_dynamically(&self, target: TargetSelection) -> bool {
1301 target.contains("linux-gnu") || target.contains("apple-darwin")
1304 /// Returns the `version` string associated with this compiler for Rust
1307 /// Note that this is a descriptive string which includes the commit date,
1308 /// sha, version, etc.
1309 fn rust_version(&self) -> String {
1310 let mut version = self.rust_info.version(self, &self.version);
1311 if let Some(ref s) = self.config.description {
1312 version.push_str(" (");
1313 version.push_str(s);
1319 /// Returns the full commit hash.
1320 fn rust_sha(&self) -> Option<&str> {
1321 self.rust_info.sha()
1324 /// Returns the `a.b.c` version that the given package is at.
1325 fn release_num(&self, package: &str) -> String {
1326 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1327 let toml = t!(fs::read_to_string(&toml_file_name));
1328 for line in toml.lines() {
1329 if let Some(stripped) =
1330 line.strip_prefix("version = \"").and_then(|s| s.strip_suffix("\""))
1332 return stripped.to_owned();
1336 panic!("failed to find version in {}'s Cargo.toml", package)
1339 /// Returns `true` if unstable features should be enabled for the compiler
1341 fn unstable_features(&self) -> bool {
1342 match &self.config.channel[..] {
1343 "stable" | "beta" => false,
1344 "nightly" | _ => true,
1348 /// Returns a Vec of all the dependencies of the given root crate,
1349 /// including transitive dependencies and the root itself. Only includes
1350 /// "local" crates (those in the local source tree, not from a registry).
1351 fn in_tree_crates(&self, root: &str, target: Option<TargetSelection>) -> Vec<&Crate> {
1352 let mut ret = Vec::new();
1353 let mut list = vec![INTERNER.intern_str(root)];
1354 let mut visited = HashSet::new();
1355 while let Some(krate) = list.pop() {
1356 let krate = &self.crates[&krate];
1358 for dep in &krate.deps {
1359 if !self.crates.contains_key(dep) {
1360 // Ignore non-workspace members.
1363 // Don't include optional deps if their features are not
1364 // enabled. Ideally this would be computed from `cargo
1365 // metadata --features …`, but that is somewhat slow. In
1366 // the future, we may want to consider just filtering all
1367 // build and dev dependencies in metadata::build.
1368 if visited.insert(dep)
1369 && (dep != "profiler_builtins"
1371 .map(|t| self.config.profiler_enabled(t))
1372 .unwrap_or_else(|| self.config.any_profiler_enabled()))
1373 && (dep != "rustc_codegen_llvm" || self.config.llvm_enabled())
1382 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, DependencyType)> {
1383 if self.config.dry_run {
1387 let mut paths = Vec::new();
1388 let contents = t!(fs::read(stamp), &stamp);
1389 // This is the method we use for extracting paths from the stamp file passed to us. See
1390 // run_cargo for more information (in compile.rs).
1391 for part in contents.split(|b| *b == 0) {
1392 if part.is_empty() {
1395 let dependency_type = match part[0] as char {
1396 'h' => DependencyType::Host,
1397 's' => DependencyType::TargetSelfContained,
1398 't' => DependencyType::Target,
1399 _ => unreachable!(),
1401 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1402 paths.push((path, dependency_type));
1407 /// Create a temporary directory in `out` and return its path.
1409 /// NOTE: this temporary directory is shared between all steps;
1410 /// if you need an empty directory, create a new subdirectory inside it.
1411 fn tempdir(&self) -> PathBuf {
1412 let tmp = self.out.join("tmp");
1413 t!(fs::create_dir_all(&tmp));
1417 /// Copies a file from `src` to `dst`
1418 pub fn copy(&self, src: &Path, dst: &Path) {
1419 self.copy_internal(src, dst, false);
1422 fn copy_internal(&self, src: &Path, dst: &Path, dereference_symlinks: bool) {
1423 if self.config.dry_run {
1426 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1430 let _ = fs::remove_file(&dst);
1431 let metadata = t!(src.symlink_metadata());
1432 let mut src = src.to_path_buf();
1433 if metadata.file_type().is_symlink() {
1434 if dereference_symlinks {
1435 src = t!(fs::canonicalize(src));
1437 let link = t!(fs::read_link(src));
1438 t!(self.symlink_file(link, dst));
1442 if let Ok(()) = fs::hard_link(&src, dst) {
1443 // Attempt to "easy copy" by creating a hard link
1444 // (symlinks don't work on windows), but if that fails
1445 // just fall back to a slow `copy` operation.
1447 if let Err(e) = fs::copy(&src, dst) {
1448 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1450 t!(fs::set_permissions(dst, metadata.permissions()));
1451 let atime = FileTime::from_last_access_time(&metadata);
1452 let mtime = FileTime::from_last_modification_time(&metadata);
1453 t!(filetime::set_file_times(dst, atime, mtime));
1457 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1458 /// when this function is called.
1459 pub fn cp_r(&self, src: &Path, dst: &Path) {
1460 if self.config.dry_run {
1463 for f in self.read_dir(src) {
1464 let path = f.path();
1465 let name = path.file_name().unwrap();
1466 let dst = dst.join(name);
1467 if t!(f.file_type()).is_dir() {
1468 t!(fs::create_dir_all(&dst));
1469 self.cp_r(&path, &dst);
1471 let _ = fs::remove_file(&dst);
1472 self.copy(&path, &dst);
1477 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1478 /// when this function is called. Unwanted files or directories can be skipped
1479 /// by returning `false` from the filter function.
1480 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1481 // Immediately recurse with an empty relative path
1482 self.recurse_(src, dst, Path::new(""), filter)
1485 // Inner function does the actual work
1486 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1487 for f in self.read_dir(src) {
1488 let path = f.path();
1489 let name = path.file_name().unwrap();
1490 let dst = dst.join(name);
1491 let relative = relative.join(name);
1492 // Only copy file or directory if the filter function returns true
1493 if filter(&relative) {
1494 if t!(f.file_type()).is_dir() {
1495 let _ = fs::remove_dir_all(&dst);
1496 self.create_dir(&dst);
1497 self.recurse_(&path, &dst, &relative, filter);
1499 let _ = fs::remove_file(&dst);
1500 self.copy(&path, &dst);
1506 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1507 let file_name = src.file_name().unwrap();
1508 let dest = dest_folder.join(file_name);
1509 self.copy(src, &dest);
1512 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1513 if self.config.dry_run {
1516 let dst = dstdir.join(src.file_name().unwrap());
1517 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1518 t!(fs::create_dir_all(dstdir));
1520 panic!("Error: File \"{}\" not found!", src.display());
1522 self.copy_internal(src, &dst, true);
1526 fn create(&self, path: &Path, s: &str) {
1527 if self.config.dry_run {
1530 t!(fs::write(path, s));
1533 fn read(&self, path: &Path) -> String {
1534 if self.config.dry_run {
1535 return String::new();
1537 t!(fs::read_to_string(path))
1540 fn create_dir(&self, dir: &Path) {
1541 if self.config.dry_run {
1544 t!(fs::create_dir_all(dir))
1547 fn remove_dir(&self, dir: &Path) {
1548 if self.config.dry_run {
1551 t!(fs::remove_dir_all(dir))
1554 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1555 let iter = match fs::read_dir(dir) {
1557 Err(_) if self.config.dry_run => return vec![].into_iter(),
1558 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1560 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1563 fn symlink_file<P: AsRef<Path>, Q: AsRef<Path>>(&self, src: P, link: Q) -> io::Result<()> {
1565 use std::os::unix::fs::symlink as symlink_file;
1567 use std::os::windows::fs::symlink_file;
1568 if !self.config.dry_run { symlink_file(src.as_ref(), link.as_ref()) } else { Ok(()) }
1571 fn remove(&self, f: &Path) {
1572 if self.config.dry_run {
1575 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1578 /// Returns if config.ninja is enabled, and checks for ninja existence,
1579 /// exiting with a nicer error message if not.
1580 fn ninja(&self) -> bool {
1581 let mut cmd_finder = crate::sanity::Finder::new();
1583 if self.config.ninja_in_file {
1584 // Some Linux distros rename `ninja` to `ninja-build`.
1585 // CMake can work with either binary name.
1586 if cmd_finder.maybe_have("ninja-build").is_none()
1587 && cmd_finder.maybe_have("ninja").is_none()
1591 Couldn't find required command: ninja (or ninja-build)
1593 You should install ninja as described at
1594 <https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages>,
1595 or set `ninja = false` in the `[llvm]` section of `config.toml`.
1596 Alternatively, set `download-ci-llvm = true` in that `[llvm]` section
1597 to download LLVM rather than building it.
1604 // If ninja isn't enabled but we're building for MSVC then we try
1605 // doubly hard to enable it. It was realized in #43767 that the msbuild
1606 // CMake generator for MSVC doesn't respect configuration options like
1607 // disabling LLVM assertions, which can often be quite important!
1609 // In these cases we automatically enable Ninja if we find it in the
1611 if !self.config.ninja_in_file && self.config.build.contains("msvc") {
1612 if cmd_finder.maybe_have("ninja").is_some() {
1617 self.config.ninja_in_file
1622 fn chmod(path: &Path, perms: u32) {
1623 use std::os::unix::fs::*;
1624 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1627 fn chmod(_path: &Path, _perms: u32) {}
1629 /// If code is not 0 (successful exit status), exit status is 101 (rust's default error code.)
1630 /// If the test is running and code is an error code, it will cause a panic.
1631 fn detail_exit(code: i32) -> ! {
1632 // if in test and code is an error code, panic with staus code provided
1633 if cfg!(test) && code != 0 {
1634 panic!("status code: {}", code);
1636 //otherwise,exit with provided status code
1637 std::process::exit(code);
1642 pub fn with_stage(mut self, stage: u32) -> Compiler {
1647 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1648 pub fn is_snapshot(&self, build: &Build) -> bool {
1649 self.stage == 0 && self.host == build.build
1652 /// Returns if this compiler should be treated as a final stage one in the
1653 /// current build session.
1654 /// This takes into account whether we're performing a full bootstrap or
1655 /// not; don't directly compare the stage with `2`!
1656 pub fn is_final_stage(&self, build: &Build) -> bool {
1657 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1658 self.stage >= final_stage
1662 fn envify(s: &str) -> String {
1668 .flat_map(|c| c.to_uppercase())