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::io::ErrorKind;
112 use std::path::{Path, PathBuf};
113 use std::process::Command;
116 use channel::GitInfo;
117 use config::{DryRun, Target};
118 use filetime::FileTime;
119 use once_cell::sync::OnceCell;
121 use crate::builder::Kind;
122 use crate::config::{LlvmLibunwind, TargetSelection};
124 exe, libdir, mtime, output, run, run_suppressed, symlink_dir, try_run_suppressed, CiEnv,
153 #[cfg(feature = "build-metrics")]
159 #[cfg(all(unix, not(target_os = "haiku")))]
161 pub unsafe fn setup(build: &mut crate::Build) {
162 if build.config.low_priority {
163 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
168 #[cfg(any(target_os = "haiku", target_os = "hermit", not(any(unix, windows))))]
170 pub unsafe fn setup(_build: &mut crate::Build) {}
173 pub use crate::builder::PathSet;
174 use crate::cache::{Interned, INTERNER};
175 pub use crate::config::Config;
176 pub use crate::flags::Subcommand;
178 const LLVM_TOOLS: &[&str] = &[
179 "llvm-cov", // used to generate coverage report
180 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
181 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
182 "llvm-objdump", // used to disassemble programs
183 "llvm-profdata", // used to inspect and merge files generated by profiles
184 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
185 "llvm-size", // used to prints the size of the linker sections of a program
186 "llvm-strip", // used to discard symbols from binary files to reduce their size
187 "llvm-ar", // used for creating and modifying archive files
188 "llvm-as", // used to convert LLVM assembly to LLVM bitcode
189 "llvm-dis", // used to disassemble LLVM bitcode
190 "llc", // used to compile LLVM bytecode
191 "opt", // used to optimize LLVM bytecode
194 /// LLD file names for all flavors.
195 const LLD_FILE_NAMES: &[&str] = &["ld.lld", "ld64.lld", "lld-link", "wasm-ld"];
197 pub const VERSION: usize = 2;
199 /// Extra --check-cfg to add when building
200 /// (Mode restriction, config name, config values (if any))
201 const EXTRA_CHECK_CFGS: &[(Option<Mode>, &'static str, Option<&[&'static str]>)] = &[
202 (None, "bootstrap", None),
203 (Some(Mode::Rustc), "parallel_compiler", None),
204 (Some(Mode::ToolRustc), "parallel_compiler", None),
205 (Some(Mode::Codegen), "parallel_compiler", None),
206 (Some(Mode::Std), "stdarch_intel_sde", None),
207 (Some(Mode::Std), "no_fp_fmt_parse", None),
208 (Some(Mode::Std), "no_global_oom_handling", None),
209 (Some(Mode::Std), "no_rc", None),
210 (Some(Mode::Std), "no_sync", None),
211 (Some(Mode::Std), "freebsd12", None),
212 (Some(Mode::Std), "backtrace_in_libstd", None),
213 /* Extra values not defined in the built-in targets yet, but used in std */
214 (Some(Mode::Std), "target_env", Some(&["libnx"])),
215 (Some(Mode::Std), "target_os", Some(&["watchos"])),
219 Some(&["asmjs", "spirv", "nvptx", "nvptx64", "le32", "xtensa"]),
221 /* Extra names used by dependencies */
222 // FIXME: Used by rustfmt is their test but is invalid (neither cargo nor bootstrap ever set
223 // this config) should probably by removed or use a allow attribute.
224 (Some(Mode::ToolRustc), "release", None),
225 // FIXME: Used by stdarch in their test, should use a allow attribute instead.
226 (Some(Mode::Std), "dont_compile_me", None),
227 // FIXME: Used by serde_json, but we should not be triggering on external dependencies.
228 (Some(Mode::Rustc), "no_btreemap_remove_entry", None),
229 (Some(Mode::ToolRustc), "no_btreemap_remove_entry", None),
230 // FIXME: Used by crossbeam-utils, but we should not be triggering on external dependencies.
231 (Some(Mode::Rustc), "crossbeam_loom", None),
232 (Some(Mode::ToolRustc), "crossbeam_loom", None),
233 // FIXME: Used by proc-macro2, but we should not be triggering on external dependencies.
234 (Some(Mode::Rustc), "span_locations", None),
235 (Some(Mode::ToolRustc), "span_locations", None),
236 // Can be passed in RUSTFLAGS to prevent direct syscalls in rustix.
237 (None, "rustix_use_libc", None),
240 /// A structure representing a Rust compiler.
242 /// Each compiler has a `stage` that it is associated with and a `host` that
243 /// corresponds to the platform the compiler runs on. This structure is used as
244 /// a parameter to many methods below.
245 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
246 pub struct Compiler {
248 host: TargetSelection,
251 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
253 /// Run normal tests and doc tests (default).
255 /// Do not run any doc tests.
257 /// Only run doc tests.
266 /// Global configuration for the build system.
268 /// This structure transitively contains all configuration for the build system.
269 /// All filesystem-encoded configuration is in `config`, all flags are in
270 /// `flags`, and then parsed or probed information is listed in the keys below.
272 /// This structure is a parameter of almost all methods in the build system,
273 /// although most functions are implemented as free functions rather than
274 /// methods specifically on this structure itself (to make it easier to
277 /// User-specified configuration from `config.toml`.
280 // Version information
283 // Properties derived from the above configuration
286 bootstrap_out: PathBuf,
287 cargo_info: channel::GitInfo,
288 rust_analyzer_info: channel::GitInfo,
289 clippy_info: channel::GitInfo,
290 miri_info: channel::GitInfo,
291 rustfmt_info: channel::GitInfo,
292 in_tree_llvm_info: channel::GitInfo,
298 // Targets for which to build
299 build: TargetSelection,
300 hosts: Vec<TargetSelection>,
301 targets: Vec<TargetSelection>,
303 initial_rustc: PathBuf,
304 initial_cargo: PathBuf,
305 initial_lld: PathBuf,
306 initial_libdir: PathBuf,
308 // Runtime state filled in later on
309 // C/C++ compilers and archiver for all targets
310 cc: HashMap<TargetSelection, cc::Tool>,
311 cxx: HashMap<TargetSelection, cc::Tool>,
312 ar: HashMap<TargetSelection, PathBuf>,
313 ranlib: HashMap<TargetSelection, PathBuf>,
315 // allow bidirectional lookups: both name -> path and path -> name
316 crates: HashMap<Interned<String>, Crate>,
317 crate_paths: HashMap<PathBuf, Interned<String>>,
320 delayed_failures: RefCell<Vec<String>>,
321 prerelease_version: Cell<Option<u32>>,
323 RefCell<HashMap<TargetSelection, HashMap<String, (&'static str, PathBuf, Vec<String>)>>>,
325 #[cfg(feature = "build-metrics")]
326 metrics: metrics::BuildMetrics,
331 name: Interned<String>,
332 deps: HashSet<Interned<String>>,
337 fn local_path(&self, build: &Build) -> PathBuf {
338 self.path.strip_prefix(&build.config.src).unwrap().into()
342 /// When building Rust various objects are handled differently.
343 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
344 pub enum DependencyType {
345 /// Libraries originating from proc-macros.
347 /// Typical Rust libraries.
349 /// Non Rust libraries and objects shipped to ease usage of certain targets.
353 /// The various "modes" of invoking Cargo.
355 /// These entries currently correspond to the various output directories of the
356 /// build system, with each mod generating output in a different directory.
357 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
359 /// Build the standard library, placing output in the "stageN-std" directory.
362 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
365 /// Build a codegen backend for rustc, placing the output in the "stageN-codegen" directory.
368 /// Build a tool, placing output in the "stage0-bootstrap-tools"
369 /// directory. This is for miscellaneous sets of tools that are built
370 /// using the bootstrap stage0 compiler in its entirety (target libraries
371 /// and all). Typically these tools compile with stable Rust.
374 /// Build a tool which uses the locally built std, placing output in the
375 /// "stageN-tools" directory. Its usage is quite rare, mainly used by
376 /// compiletest which needs libtest.
379 /// Build a tool which uses the locally built rustc and the target std,
380 /// placing the output in the "stageN-tools" directory. This is used for
381 /// anything that needs a fully functional rustc, such as rustdoc, clippy,
382 /// cargo, rls, rustfmt, miri, etc.
387 pub fn is_tool(&self) -> bool {
388 matches!(self, Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd)
391 pub fn must_support_dlopen(&self) -> bool {
392 matches!(self, Mode::Std | Mode::Codegen)
401 macro_rules! forward {
402 ( $( $fn:ident( $($param:ident: $ty:ty),* ) $( -> $ret:ty)? ),+ $(,)? ) => {
404 $( fn $fn(&self, $($param: $ty),* ) $( -> $ret)? {
405 self.config.$fn( $($param),* )
413 is_verbose() -> bool,
414 create(path: &Path, s: &str),
416 tempdir() -> PathBuf,
417 try_run(cmd: &mut Command) -> bool,
418 llvm_link_shared() -> bool,
419 download_rustc() -> bool,
420 initial_rustfmt() -> Option<PathBuf>,
424 /// Creates a new set of build configuration from the `flags` on the command
425 /// line and the filesystem `config`.
427 /// By default all build output will be placed in the current directory.
428 pub fn new(mut config: Config) -> Build {
429 let src = config.src.clone();
430 let out = config.out.clone();
433 // keep this consistent with the equivalent check in x.py:
434 // https://github.com/rust-lang/rust/blob/a8a33cf27166d3eabaffc58ed3799e054af3b0c6/src/bootstrap/bootstrap.py#L796-L797
435 let is_sudo = match env::var_os("SUDO_USER") {
436 Some(_sudo_user) => {
437 let uid = unsafe { libc::getuid() };
445 let ignore_git = config.ignore_git;
446 let rust_info = channel::GitInfo::new(ignore_git, &src);
447 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
448 let rust_analyzer_info =
449 channel::GitInfo::new(ignore_git, &src.join("src/tools/rust-analyzer"));
450 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
451 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
452 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
454 // we always try to use git for LLVM builds
455 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
457 let initial_target_libdir_str = if config.dry_run() {
458 "/dummy/lib/path/to/lib/".to_string()
461 Command::new(&config.initial_rustc)
463 .arg(config.build.rustc_target_arg())
465 .arg("target-libdir"),
468 let initial_target_dir = Path::new(&initial_target_libdir_str).parent().unwrap();
469 let initial_lld = initial_target_dir.join("bin").join("rust-lld");
471 let initial_sysroot = if config.dry_run() {
474 output(Command::new(&config.initial_rustc).arg("--print").arg("sysroot"))
476 let initial_libdir = initial_target_dir
481 .strip_prefix(initial_sysroot.trim())
485 let version = std::fs::read_to_string(src.join("src").join("version"))
486 .expect("failed to read src/version");
487 let version = version.trim();
489 let bootstrap_out = std::env::current_exe()
490 .expect("could not determine path to running process")
494 if !bootstrap_out.join(exe("rustc", config.build)).exists() && !cfg!(test) {
495 // this restriction can be lifted whenever https://github.com/rust-lang/rfcs/pull/3028 is implemented
497 "`rustc` not found in {}, run `cargo build --bins` before `cargo run`",
498 bootstrap_out.display()
502 if rust_info.is_from_tarball() && config.description.is_none() {
503 config.description = Some("built from a source tarball".to_owned());
506 let mut build = Build {
507 initial_rustc: config.initial_rustc.clone(),
508 initial_cargo: config.initial_cargo.clone(),
511 local_rebuild: config.local_rebuild,
512 fail_fast: config.cmd.fail_fast(),
513 doc_tests: config.cmd.doc_tests(),
514 verbosity: config.verbose,
517 hosts: config.hosts.clone(),
518 targets: config.targets.clone(),
521 version: version.to_string(),
535 ranlib: HashMap::new(),
536 crates: HashMap::new(),
537 crate_paths: HashMap::new(),
539 ci_env: CiEnv::current(),
540 delayed_failures: RefCell::new(Vec::new()),
541 prerelease_version: Cell::new(None),
542 tool_artifacts: Default::default(),
544 #[cfg(feature = "build-metrics")]
545 metrics: metrics::BuildMetrics::init(),
548 // If local-rust is the same major.minor as the current version, then force a
550 let local_version_verbose =
551 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
552 let local_release = local_version_verbose
554 .filter_map(|x| x.strip_prefix("release:"))
558 if local_release.split('.').take(2).eq(version.split('.').take(2)) {
559 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
560 build.local_rebuild = true;
563 build.verbose("finding compilers");
564 cc_detect::find(&mut build);
565 // When running `setup`, the profile is about to change, so any requirements we have now may
566 // be different on the next invocation. Don't check for them until the next time x.py is
567 // run. This is ok because `setup` never runs any build commands, so it won't fail if commands are missing.
569 // Similarly, for `setup` we don't actually need submodules or cargo metadata.
570 if !matches!(build.config.cmd, Subcommand::Setup { .. }) {
571 build.verbose("running sanity check");
572 sanity::check(&mut build);
574 // Make sure we update these before gathering metadata so we don't get an error about missing
576 let rust_submodules = [
577 "src/tools/rust-installer",
582 for s in rust_submodules {
583 build.update_submodule(Path::new(s));
585 // Now, update all existing submodules.
586 build.update_existing_submodules();
588 build.verbose("learning about cargo");
589 metadata::build(&mut build);
592 // Make a symbolic link so we can use a consistent directory in the documentation.
593 let build_triple = build.out.join(&build.build.triple);
594 let host = build.out.join("host");
595 if let Err(e) = symlink_dir(&build.config, &build_triple, &host) {
596 if e.kind() != ErrorKind::AlreadyExists {
598 "symlink_dir({} => {}) failed with {}",
600 build_triple.display(),
609 // modified from `check_submodule` and `update_submodule` in bootstrap.py
610 /// Given a path to the directory of a submodule, update it.
612 /// `relative_path` should be relative to the root of the git repository, not an absolute path.
613 pub(crate) fn update_submodule(&self, relative_path: &Path) {
614 fn dir_is_empty(dir: &Path) -> bool {
615 t!(std::fs::read_dir(dir)).next().is_none()
618 if !self.config.submodules(&self.rust_info()) {
622 let absolute_path = self.config.src.join(relative_path);
624 // NOTE: The check for the empty directory is here because when running x.py the first time,
625 // the submodule won't be checked out. Check it out now so we can build it.
626 if !channel::GitInfo::new(false, &absolute_path).is_managed_git_subrepository()
627 && !dir_is_empty(&absolute_path)
633 let checked_out_hash =
634 output(Command::new("git").args(&["rev-parse", "HEAD"]).current_dir(&absolute_path));
636 let recorded = output(
638 .args(&["ls-tree", "HEAD"])
640 .current_dir(&self.config.src),
642 let actual_hash = recorded
645 .unwrap_or_else(|| panic!("unexpected output `{}`", recorded));
648 if actual_hash == checked_out_hash.trim_end() {
649 // already checked out
653 println!("Updating submodule {}", relative_path.display());
656 .args(&["submodule", "-q", "sync"])
658 .current_dir(&self.config.src),
661 // Try passing `--progress` to start, then run git again without if that fails.
662 let update = |progress: bool| {
663 let mut git = Command::new("git");
664 git.args(&["submodule", "update", "--init", "--recursive", "--depth=1"]);
666 git.arg("--progress");
668 git.arg(relative_path).current_dir(&self.config.src);
671 // NOTE: doesn't use `try_run` because this shouldn't print an error if it fails.
672 if !update(true).status().map_or(false, |status| status.success()) {
673 self.run(&mut update(false));
676 // Save any local changes, but avoid running `git stash pop` if there are none (since it will exit with an error).
677 let has_local_modifications = !self.try_run(
679 .args(&["diff-index", "--quiet", "HEAD"])
680 .current_dir(&absolute_path),
682 if has_local_modifications {
683 self.run(Command::new("git").args(&["stash", "push"]).current_dir(&absolute_path));
686 self.run(Command::new("git").args(&["reset", "-q", "--hard"]).current_dir(&absolute_path));
687 self.run(Command::new("git").args(&["clean", "-qdfx"]).current_dir(&absolute_path));
689 if has_local_modifications {
690 self.run(Command::new("git").args(&["stash", "pop"]).current_dir(absolute_path));
694 /// If any submodule has been initialized already, sync it unconditionally.
695 /// This avoids contributors checking in a submodule change by accident.
696 pub fn update_existing_submodules(&self) {
697 // Avoid running git when there isn't a git checkout.
698 if !self.config.submodules(&self.rust_info()) {
704 .args(&["config", "--file"])
705 .arg(&self.config.src.join(".gitmodules"))
706 .args(&["--get-regexp", "path"]),
708 for line in output.lines() {
709 // Look for `submodule.$name.path = $path`
710 // Sample output: `submodule.src/rust-installer.path src/tools/rust-installer`
711 let submodule = Path::new(line.splitn(2, ' ').nth(1).unwrap());
712 // Don't update the submodule unless it's already been cloned.
713 if channel::GitInfo::new(false, submodule).is_managed_git_subrepository() {
714 self.update_submodule(submodule);
719 /// Executes the entire build, as configured by the flags and configuration.
720 pub fn build(&mut self) {
725 if let Subcommand::Format { check, paths } = &self.config.cmd {
726 return format::format(&builder::Builder::new(&self), *check, &paths);
729 if let Subcommand::Clean { all } = self.config.cmd {
730 return clean::clean(self, all);
733 // Download rustfmt early so that it can be used in rust-analyzer configs.
734 let _ = &builder::Builder::new(&self).initial_rustfmt();
737 let builder = builder::Builder::new(&self);
738 if let Some(path) = builder.paths.get(0) {
739 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
745 if !self.config.dry_run() {
747 self.config.dry_run = DryRun::SelfCheck;
748 let builder = builder::Builder::new(&self);
749 builder.execute_cli();
751 self.config.dry_run = DryRun::Disabled;
752 let builder = builder::Builder::new(&self);
753 builder.execute_cli();
755 let builder = builder::Builder::new(&self);
756 builder.execute_cli();
759 // Check for postponed failures from `test --no-fail-fast`.
760 let failures = self.delayed_failures.borrow();
761 if failures.len() > 0 {
762 eprintln!("\n{} command(s) did not execute successfully:\n", failures.len());
763 for failure in failures.iter() {
764 eprintln!(" - {}\n", failure);
769 #[cfg(feature = "build-metrics")]
770 self.metrics.persist(self);
773 /// Clear out `dir` if `input` is newer.
775 /// After this executes, it will also ensure that `dir` exists.
776 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
777 let stamp = dir.join(".stamp");
778 let mut cleared = false;
779 if mtime(&stamp) < mtime(input) {
780 self.verbose(&format!("Dirty - {}", dir.display()));
781 let _ = fs::remove_dir_all(dir);
783 } else if stamp.exists() {
786 t!(fs::create_dir_all(dir));
787 t!(File::create(stamp));
791 fn rust_info(&self) -> &GitInfo {
792 &self.config.rust_info
795 /// Gets the space-separated set of activated features for the standard
797 fn std_features(&self, target: TargetSelection) -> String {
798 let mut features = "panic-unwind".to_string();
800 match self.config.llvm_libunwind(target) {
801 LlvmLibunwind::InTree => features.push_str(" llvm-libunwind"),
802 LlvmLibunwind::System => features.push_str(" system-llvm-libunwind"),
803 LlvmLibunwind::No => {}
805 if self.config.backtrace {
806 features.push_str(" backtrace");
808 if self.config.profiler_enabled(target) {
809 features.push_str(" profiler");
814 /// Gets the space-separated set of activated features for the compiler.
815 fn rustc_features(&self, kind: Kind) -> String {
816 let mut features = vec![];
817 if self.config.jemalloc {
818 features.push("jemalloc");
820 if self.config.llvm_enabled() || kind == Kind::Check {
821 features.push("llvm");
823 // keep in sync with `bootstrap/compile.rs:rustc_cargo_env`
824 if self.config.rustc_parallel {
825 features.push("rustc_use_parallel_compiler");
828 // If debug logging is on, then we want the default for tracing:
829 // https://github.com/tokio-rs/tracing/blob/3dd5c03d907afdf2c39444a29931833335171554/tracing/src/level_filters.rs#L26
830 // which is everything (including debug/trace/etc.)
831 // if its unset, if debug_assertions is on, then debug_logging will also be on
832 // as well as tracing *ignoring* this feature when debug_assertions is on
833 if !self.config.rust_debug_logging {
834 features.push("max_level_info");
840 /// Component directory that Cargo will produce output into (e.g.
842 fn cargo_dir(&self) -> &'static str {
843 if self.config.rust_optimize { "release" } else { "debug" }
846 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
849 .join(&*compiler.host.triple)
850 .join(format!("stage{}-tools-bin", compiler.stage));
851 t!(fs::create_dir_all(&out));
855 /// Returns the root directory for all output generated in a particular
856 /// stage when running with a particular host compiler.
858 /// The mode indicates what the root directory is for.
859 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
860 let suffix = match mode {
862 Mode::Rustc => "-rustc",
863 Mode::Codegen => "-codegen",
864 Mode::ToolBootstrap => "-bootstrap-tools",
865 Mode::ToolStd | Mode::ToolRustc => "-tools",
867 self.out.join(&*compiler.host.triple).join(format!("stage{}{}", compiler.stage, suffix))
870 /// Returns the root output directory for all Cargo output in a given stage,
871 /// running a particular compiler, whether or not we're building the
872 /// standard library, and targeting the specified architecture.
873 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: TargetSelection) -> PathBuf {
874 self.stage_out(compiler, mode).join(&*target.triple).join(self.cargo_dir())
877 /// Root output directory for LLVM compiled for `target`
879 /// Note that if LLVM is configured externally then the directory returned
880 /// will likely be empty.
881 fn llvm_out(&self, target: TargetSelection) -> PathBuf {
882 self.out.join(&*target.triple).join("llvm")
885 fn lld_out(&self, target: TargetSelection) -> PathBuf {
886 self.out.join(&*target.triple).join("lld")
889 /// Output directory for all documentation for a target
890 fn doc_out(&self, target: TargetSelection) -> PathBuf {
891 self.out.join(&*target.triple).join("doc")
894 /// Output directory for all JSON-formatted documentation for a target
895 fn json_doc_out(&self, target: TargetSelection) -> PathBuf {
896 self.out.join(&*target.triple).join("json-doc")
899 fn test_out(&self, target: TargetSelection) -> PathBuf {
900 self.out.join(&*target.triple).join("test")
903 /// Output directory for all documentation for a target
904 fn compiler_doc_out(&self, target: TargetSelection) -> PathBuf {
905 self.out.join(&*target.triple).join("compiler-doc")
908 /// Output directory for some generated md crate documentation for a target (temporary)
909 fn md_doc_out(&self, target: TargetSelection) -> Interned<PathBuf> {
910 INTERNER.intern_path(self.out.join(&*target.triple).join("md-doc"))
913 /// Returns `true` if no custom `llvm-config` is set for the specified target.
915 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
916 fn is_rust_llvm(&self, target: TargetSelection) -> bool {
917 match self.config.target_config.get(&target) {
918 Some(Target { llvm_has_rust_patches: Some(patched), .. }) => *patched,
919 Some(Target { llvm_config, .. }) => {
920 // If the user set llvm-config we assume Rust is not patched,
921 // but first check to see if it was configured by llvm-from-ci.
922 (self.config.llvm_from_ci && target == self.config.build) || llvm_config.is_none()
928 /// Returns the path to `FileCheck` binary for the specified target
929 fn llvm_filecheck(&self, target: TargetSelection) -> PathBuf {
930 let target_config = self.config.target_config.get(&target);
931 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
933 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
934 let llvm_bindir = output(Command::new(s).arg("--bindir"));
935 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", target));
936 if filecheck.exists() {
939 // On Fedora the system LLVM installs FileCheck in the
940 // llvm subdirectory of the libdir.
941 let llvm_libdir = output(Command::new(s).arg("--libdir"));
943 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", target));
944 if lib_filecheck.exists() {
947 // Return the most normal file name, even though
948 // it doesn't exist, so that any error message
954 let base = self.llvm_out(target).join("build");
955 let base = if !self.ninja() && target.contains("msvc") {
956 if self.config.llvm_optimize {
957 if self.config.llvm_release_debuginfo {
958 base.join("RelWithDebInfo")
968 base.join("bin").join(exe("FileCheck", target))
972 /// Directory for libraries built from C/C++ code and shared between stages.
973 fn native_dir(&self, target: TargetSelection) -> PathBuf {
974 self.out.join(&*target.triple).join("native")
977 /// Root output directory for rust_test_helpers library compiled for
979 fn test_helpers_out(&self, target: TargetSelection) -> PathBuf {
980 self.native_dir(target).join("rust-test-helpers")
983 /// Adds the `RUST_TEST_THREADS` env var if necessary
984 fn add_rust_test_threads(&self, cmd: &mut Command) {
985 if env::var_os("RUST_TEST_THREADS").is_none() {
986 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
990 /// Returns the libdir of the snapshot compiler.
991 fn rustc_snapshot_libdir(&self) -> PathBuf {
992 self.rustc_snapshot_sysroot().join(libdir(self.config.build))
995 /// Returns the sysroot of the snapshot compiler.
996 fn rustc_snapshot_sysroot(&self) -> &Path {
997 static SYSROOT_CACHE: OnceCell<PathBuf> = once_cell::sync::OnceCell::new();
998 SYSROOT_CACHE.get_or_init(|| {
999 let mut rustc = Command::new(&self.initial_rustc);
1000 rustc.args(&["--print", "sysroot"]);
1001 output(&mut rustc).trim().into()
1005 /// Runs a command, printing out nice contextual information if it fails.
1006 fn run(&self, cmd: &mut Command) {
1007 if self.config.dry_run() {
1010 self.verbose(&format!("running: {:?}", cmd));
1011 run(cmd, self.is_verbose())
1014 /// Runs a command, printing out nice contextual information if it fails.
1015 fn run_quiet(&self, cmd: &mut Command) {
1016 if self.config.dry_run() {
1019 self.verbose(&format!("running: {:?}", cmd));
1023 /// Runs a command, printing out nice contextual information if it fails.
1024 /// Exits if the command failed to execute at all, otherwise returns its
1025 /// `status.success()`.
1026 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
1027 if self.config.dry_run() {
1030 self.verbose(&format!("running: {:?}", cmd));
1031 try_run_suppressed(cmd)
1034 pub fn is_verbose_than(&self, level: usize) -> bool {
1035 self.verbosity > level
1038 /// Prints a message if this build is configured in more verbose mode than `level`.
1039 fn verbose_than(&self, level: usize, msg: &str) {
1040 if self.is_verbose_than(level) {
1041 println!("{}", msg);
1045 fn info(&self, msg: &str) {
1046 match self.config.dry_run {
1047 DryRun::SelfCheck => return,
1048 DryRun::Disabled | DryRun::UserSelected => {
1049 println!("{}", msg);
1054 /// Returns the number of parallel jobs that have been configured for this
1056 fn jobs(&self) -> u32 {
1057 self.config.jobs.unwrap_or_else(|| {
1058 std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get) as u32
1062 fn debuginfo_map_to(&self, which: GitRepo) -> Option<String> {
1063 if !self.config.rust_remap_debuginfo {
1069 let sha = self.rust_sha().unwrap_or(&self.version);
1070 Some(format!("/rustc/{}", sha))
1072 GitRepo::Llvm => Some(String::from("/rustc/llvm")),
1076 /// Returns the path to the C compiler for the target specified.
1077 fn cc(&self, target: TargetSelection) -> &Path {
1078 self.cc[&target].path()
1081 /// Returns a list of flags to pass to the C compiler for the target
1083 fn cflags(&self, target: TargetSelection, which: GitRepo, c: CLang) -> Vec<String> {
1084 let base = match c {
1085 CLang::C => &self.cc[&target],
1086 CLang::Cxx => &self.cxx[&target],
1089 // Filter out -O and /O (the optimization flags) that we picked up from
1090 // cc-rs because the build scripts will determine that for themselves.
1094 .map(|s| s.to_string_lossy().into_owned())
1095 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
1096 .collect::<Vec<String>>();
1098 // If we're compiling on macOS then we add a few unconditional flags
1099 // indicating that we want libc++ (more filled out than libstdc++) and
1100 // we want to compile for 10.7. This way we can ensure that
1101 // LLVM/etc are all properly compiled.
1102 if target.contains("apple-darwin") {
1103 base.push("-stdlib=libc++".into());
1106 // Work around an apparently bad MinGW / GCC optimization,
1107 // See: https://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
1108 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
1109 if &*target.triple == "i686-pc-windows-gnu" {
1110 base.push("-fno-omit-frame-pointer".into());
1113 if let Some(map_to) = self.debuginfo_map_to(which) {
1114 let map = format!("{}={}", self.src.display(), map_to);
1115 let cc = self.cc(target);
1116 if cc.ends_with("clang") || cc.ends_with("gcc") {
1117 base.push(format!("-fdebug-prefix-map={}", map));
1118 } else if cc.ends_with("clang-cl.exe") {
1119 base.push("-Xclang".into());
1120 base.push(format!("-fdebug-prefix-map={}", map));
1126 /// Returns the path to the `ar` archive utility for the target specified.
1127 fn ar(&self, target: TargetSelection) -> Option<&Path> {
1128 self.ar.get(&target).map(|p| &**p)
1131 /// Returns the path to the `ranlib` utility for the target specified.
1132 fn ranlib(&self, target: TargetSelection) -> Option<&Path> {
1133 self.ranlib.get(&target).map(|p| &**p)
1136 /// Returns the path to the C++ compiler for the target specified.
1137 fn cxx(&self, target: TargetSelection) -> Result<&Path, String> {
1138 match self.cxx.get(&target) {
1139 Some(p) => Ok(p.path()),
1141 Err(format!("target `{}` is not configured as a host, only as a target", target))
1146 /// Returns the path to the linker for the given target if it needs to be overridden.
1147 fn linker(&self, target: TargetSelection) -> Option<&Path> {
1148 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
1151 } else if target.contains("vxworks") {
1152 // need to use CXX compiler as linker to resolve the exception functions
1153 // that are only existed in CXX libraries
1154 Some(self.cxx[&target].path())
1155 } else if target != self.config.build
1156 && util::use_host_linker(target)
1157 && !target.contains("msvc")
1159 Some(self.cc(target))
1160 } else if self.config.use_lld && !self.is_fuse_ld_lld(target) && self.build == target {
1161 Some(&self.initial_lld)
1167 // LLD is used through `-fuse-ld=lld` rather than directly.
1168 // Only MSVC targets use LLD directly at the moment.
1169 fn is_fuse_ld_lld(&self, target: TargetSelection) -> bool {
1170 self.config.use_lld && !target.contains("msvc")
1173 fn lld_flags(&self, target: TargetSelection) -> impl Iterator<Item = String> {
1174 let mut options = [None, None];
1176 if self.config.use_lld {
1177 if self.is_fuse_ld_lld(target) {
1178 options[0] = Some("-Clink-arg=-fuse-ld=lld".to_string());
1181 let no_threads = util::lld_flag_no_threads(target.contains("windows"));
1182 options[1] = Some(format!("-Clink-arg=-Wl,{}", no_threads));
1185 IntoIterator::into_iter(options).flatten()
1188 /// Returns if this target should statically link the C runtime, if specified
1189 fn crt_static(&self, target: TargetSelection) -> Option<bool> {
1190 if target.contains("pc-windows-msvc") {
1193 self.config.target_config.get(&target).and_then(|t| t.crt_static)
1197 /// Returns the "musl root" for this `target`, if defined
1198 fn musl_root(&self, target: TargetSelection) -> Option<&Path> {
1202 .and_then(|t| t.musl_root.as_ref())
1203 .or_else(|| self.config.musl_root.as_ref())
1207 /// Returns the "musl libdir" for this `target`.
1208 fn musl_libdir(&self, target: TargetSelection) -> Option<PathBuf> {
1209 let t = self.config.target_config.get(&target)?;
1210 if let libdir @ Some(_) = &t.musl_libdir {
1211 return libdir.clone();
1213 self.musl_root(target).map(|root| root.join("lib"))
1216 /// Returns the sysroot for the wasi target, if defined
1217 fn wasi_root(&self, target: TargetSelection) -> Option<&Path> {
1218 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
1221 /// Returns `true` if this is a no-std `target`, if defined
1222 fn no_std(&self, target: TargetSelection) -> Option<bool> {
1223 self.config.target_config.get(&target).map(|t| t.no_std)
1226 /// Returns `true` if the target will be tested using the `remote-test-client`
1227 /// and `remote-test-server` binaries.
1228 fn remote_tested(&self, target: TargetSelection) -> bool {
1229 self.qemu_rootfs(target).is_some()
1230 || target.contains("android")
1231 || env::var_os("TEST_DEVICE_ADDR").is_some()
1234 /// Returns the root of the "rootfs" image that this target will be using,
1235 /// if one was configured.
1237 /// If `Some` is returned then that means that tests for this target are
1238 /// emulated with QEMU and binaries will need to be shipped to the emulator.
1239 fn qemu_rootfs(&self, target: TargetSelection) -> Option<&Path> {
1240 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
1243 /// Path to the python interpreter to use
1244 fn python(&self) -> &Path {
1245 if self.config.build.ends_with("apple-darwin") {
1246 // Force /usr/bin/python3 on macOS for LLDB tests because we're loading the
1247 // LLDB plugin's compiled module which only works with the system python
1248 // (namely not Homebrew-installed python)
1249 Path::new("/usr/bin/python3")
1254 .expect("python is required for running LLDB or rustdoc tests")
1258 /// Temporary directory that extended error information is emitted to.
1259 fn extended_error_dir(&self) -> PathBuf {
1260 self.out.join("tmp/extended-error-metadata")
1263 /// Tests whether the `compiler` compiling for `target` should be forced to
1264 /// use a stage1 compiler instead.
1266 /// Currently, by default, the build system does not perform a "full
1267 /// bootstrap" by default where we compile the compiler three times.
1268 /// Instead, we compile the compiler two times. The final stage (stage2)
1269 /// just copies the libraries from the previous stage, which is what this
1272 /// Here we return `true` if:
1274 /// * The build isn't performing a full bootstrap
1275 /// * The `compiler` is in the final stage, 2
1276 /// * We're not cross-compiling, so the artifacts are already available in
1279 /// When all of these conditions are met the build will lift artifacts from
1280 /// the previous stage forward.
1281 fn force_use_stage1(&self, compiler: Compiler, target: TargetSelection) -> bool {
1282 !self.config.full_bootstrap
1283 && compiler.stage >= 2
1284 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
1287 /// Given `num` in the form "a.b.c" return a "release string" which
1288 /// describes the release version number.
1290 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
1291 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
1292 fn release(&self, num: &str) -> String {
1293 match &self.config.channel[..] {
1294 "stable" => num.to_string(),
1296 if self.rust_info().is_managed_git_subrepository() && !self.config.ignore_git {
1297 format!("{}-beta.{}", num, self.beta_prerelease_version())
1299 format!("{}-beta", num)
1302 "nightly" => format!("{}-nightly", num),
1303 _ => format!("{}-dev", num),
1307 fn beta_prerelease_version(&self) -> u32 {
1308 if let Some(s) = self.prerelease_version.get() {
1312 // Figure out how many merge commits happened since we branched off master.
1313 // That's our beta number!
1314 // (Note that we use a `..` range, not the `...` symmetric difference.)
1316 output(self.config.git().arg("rev-list").arg("--count").arg("--merges").arg(format!(
1317 "refs/remotes/origin/{}..HEAD",
1318 self.config.stage0_metadata.config.nightly_branch
1320 let n = count.trim().parse().unwrap();
1321 self.prerelease_version.set(Some(n));
1325 /// Returns the value of `release` above for Rust itself.
1326 fn rust_release(&self) -> String {
1327 self.release(&self.version)
1330 /// Returns the "package version" for a component given the `num` release
1333 /// The package version is typically what shows up in the names of tarballs.
1334 /// For channels like beta/nightly it's just the channel name, otherwise
1335 /// it's the `num` provided.
1336 fn package_vers(&self, num: &str) -> String {
1337 match &self.config.channel[..] {
1338 "stable" => num.to_string(),
1339 "beta" => "beta".to_string(),
1340 "nightly" => "nightly".to_string(),
1341 _ => format!("{}-dev", num),
1345 /// Returns the value of `package_vers` above for Rust itself.
1346 fn rust_package_vers(&self) -> String {
1347 self.package_vers(&self.version)
1350 /// Returns the `version` string associated with this compiler for Rust
1353 /// Note that this is a descriptive string which includes the commit date,
1354 /// sha, version, etc.
1355 fn rust_version(&self) -> String {
1356 let mut version = self.rust_info().version(self, &self.version);
1357 if let Some(ref s) = self.config.description {
1358 version.push_str(" (");
1359 version.push_str(s);
1365 /// Returns the full commit hash.
1366 fn rust_sha(&self) -> Option<&str> {
1367 self.rust_info().sha()
1370 /// Returns the `a.b.c` version that the given package is at.
1371 fn release_num(&self, package: &str) -> String {
1372 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1373 let toml = t!(fs::read_to_string(&toml_file_name));
1374 for line in toml.lines() {
1375 if let Some(stripped) =
1376 line.strip_prefix("version = \"").and_then(|s| s.strip_suffix("\""))
1378 return stripped.to_owned();
1382 panic!("failed to find version in {}'s Cargo.toml", package)
1385 /// Returns `true` if unstable features should be enabled for the compiler
1387 fn unstable_features(&self) -> bool {
1388 match &self.config.channel[..] {
1389 "stable" | "beta" => false,
1390 "nightly" | _ => true,
1394 /// Returns a Vec of all the dependencies of the given root crate,
1395 /// including transitive dependencies and the root itself. Only includes
1396 /// "local" crates (those in the local source tree, not from a registry).
1397 fn in_tree_crates(&self, root: &str, target: Option<TargetSelection>) -> Vec<&Crate> {
1398 let mut ret = Vec::new();
1399 let mut list = vec![INTERNER.intern_str(root)];
1400 let mut visited = HashSet::new();
1401 while let Some(krate) = list.pop() {
1402 let krate = &self.crates[&krate];
1404 for dep in &krate.deps {
1405 if !self.crates.contains_key(dep) {
1406 // Ignore non-workspace members.
1409 // Don't include optional deps if their features are not
1410 // enabled. Ideally this would be computed from `cargo
1411 // metadata --features …`, but that is somewhat slow. In
1412 // the future, we may want to consider just filtering all
1413 // build and dev dependencies in metadata::build.
1414 if visited.insert(dep)
1415 && (dep != "profiler_builtins"
1417 .map(|t| self.config.profiler_enabled(t))
1418 .unwrap_or_else(|| self.config.any_profiler_enabled()))
1419 && (dep != "rustc_codegen_llvm" || self.config.llvm_enabled())
1428 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, DependencyType)> {
1429 if self.config.dry_run() {
1433 let mut paths = Vec::new();
1434 let contents = t!(fs::read(stamp), &stamp);
1435 // This is the method we use for extracting paths from the stamp file passed to us. See
1436 // run_cargo for more information (in compile.rs).
1437 for part in contents.split(|b| *b == 0) {
1438 if part.is_empty() {
1441 let dependency_type = match part[0] as char {
1442 'h' => DependencyType::Host,
1443 's' => DependencyType::TargetSelfContained,
1444 't' => DependencyType::Target,
1445 _ => unreachable!(),
1447 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1448 paths.push((path, dependency_type));
1453 /// Copies a file from `src` to `dst`
1454 pub fn copy(&self, src: &Path, dst: &Path) {
1455 self.copy_internal(src, dst, false);
1458 fn copy_internal(&self, src: &Path, dst: &Path, dereference_symlinks: bool) {
1459 if self.config.dry_run() {
1462 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1466 let _ = fs::remove_file(&dst);
1467 let metadata = t!(src.symlink_metadata());
1468 let mut src = src.to_path_buf();
1469 if metadata.file_type().is_symlink() {
1470 if dereference_symlinks {
1471 src = t!(fs::canonicalize(src));
1473 let link = t!(fs::read_link(src));
1474 t!(self.symlink_file(link, dst));
1478 if let Ok(()) = fs::hard_link(&src, dst) {
1479 // Attempt to "easy copy" by creating a hard link
1480 // (symlinks don't work on windows), but if that fails
1481 // just fall back to a slow `copy` operation.
1483 if let Err(e) = fs::copy(&src, dst) {
1484 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1486 t!(fs::set_permissions(dst, metadata.permissions()));
1487 let atime = FileTime::from_last_access_time(&metadata);
1488 let mtime = FileTime::from_last_modification_time(&metadata);
1489 t!(filetime::set_file_times(dst, atime, mtime));
1493 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1494 /// when this function is called.
1495 pub fn cp_r(&self, src: &Path, dst: &Path) {
1496 if self.config.dry_run() {
1499 for f in self.read_dir(src) {
1500 let path = f.path();
1501 let name = path.file_name().unwrap();
1502 let dst = dst.join(name);
1503 if t!(f.file_type()).is_dir() {
1504 t!(fs::create_dir_all(&dst));
1505 self.cp_r(&path, &dst);
1507 let _ = fs::remove_file(&dst);
1508 self.copy(&path, &dst);
1513 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1514 /// when this function is called. Unwanted files or directories can be skipped
1515 /// by returning `false` from the filter function.
1516 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1517 // Immediately recurse with an empty relative path
1518 self.recurse_(src, dst, Path::new(""), filter)
1521 // Inner function does the actual work
1522 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1523 for f in self.read_dir(src) {
1524 let path = f.path();
1525 let name = path.file_name().unwrap();
1526 let dst = dst.join(name);
1527 let relative = relative.join(name);
1528 // Only copy file or directory if the filter function returns true
1529 if filter(&relative) {
1530 if t!(f.file_type()).is_dir() {
1531 let _ = fs::remove_dir_all(&dst);
1532 self.create_dir(&dst);
1533 self.recurse_(&path, &dst, &relative, filter);
1535 let _ = fs::remove_file(&dst);
1536 self.copy(&path, &dst);
1542 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1543 let file_name = src.file_name().unwrap();
1544 let dest = dest_folder.join(file_name);
1545 self.copy(src, &dest);
1548 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1549 if self.config.dry_run() {
1552 let dst = dstdir.join(src.file_name().unwrap());
1553 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1554 t!(fs::create_dir_all(dstdir));
1556 panic!("Error: File \"{}\" not found!", src.display());
1558 self.copy_internal(src, &dst, true);
1562 fn read(&self, path: &Path) -> String {
1563 if self.config.dry_run() {
1564 return String::new();
1566 t!(fs::read_to_string(path))
1569 fn create_dir(&self, dir: &Path) {
1570 if self.config.dry_run() {
1573 t!(fs::create_dir_all(dir))
1576 fn remove_dir(&self, dir: &Path) {
1577 if self.config.dry_run() {
1580 t!(fs::remove_dir_all(dir))
1583 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1584 let iter = match fs::read_dir(dir) {
1586 Err(_) if self.config.dry_run() => return vec![].into_iter(),
1587 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1589 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1592 fn symlink_file<P: AsRef<Path>, Q: AsRef<Path>>(&self, src: P, link: Q) -> io::Result<()> {
1594 use std::os::unix::fs::symlink as symlink_file;
1596 use std::os::windows::fs::symlink_file;
1597 if !self.config.dry_run() { symlink_file(src.as_ref(), link.as_ref()) } else { Ok(()) }
1600 /// Returns if config.ninja is enabled, and checks for ninja existence,
1601 /// exiting with a nicer error message if not.
1602 fn ninja(&self) -> bool {
1603 let mut cmd_finder = crate::sanity::Finder::new();
1605 if self.config.ninja_in_file {
1606 // Some Linux distros rename `ninja` to `ninja-build`.
1607 // CMake can work with either binary name.
1608 if cmd_finder.maybe_have("ninja-build").is_none()
1609 && cmd_finder.maybe_have("ninja").is_none()
1613 Couldn't find required command: ninja (or ninja-build)
1615 You should install ninja as described at
1616 <https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages>,
1617 or set `ninja = false` in the `[llvm]` section of `config.toml`.
1618 Alternatively, set `download-ci-llvm = true` in that `[llvm]` section
1619 to download LLVM rather than building it.
1626 // If ninja isn't enabled but we're building for MSVC then we try
1627 // doubly hard to enable it. It was realized in #43767 that the msbuild
1628 // CMake generator for MSVC doesn't respect configuration options like
1629 // disabling LLVM assertions, which can often be quite important!
1631 // In these cases we automatically enable Ninja if we find it in the
1633 if !self.config.ninja_in_file && self.config.build.contains("msvc") {
1634 if cmd_finder.maybe_have("ninja").is_some() {
1639 self.config.ninja_in_file
1644 fn chmod(path: &Path, perms: u32) {
1645 use std::os::unix::fs::*;
1646 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1649 fn chmod(_path: &Path, _perms: u32) {}
1651 /// If code is not 0 (successful exit status), exit status is 101 (rust's default error code.)
1652 /// If the test is running and code is an error code, it will cause a panic.
1653 fn detail_exit(code: i32) -> ! {
1654 // if in test and code is an error code, panic with status code provided
1656 panic!("status code: {}", code);
1658 // otherwise,exit with provided status code
1659 std::process::exit(code);
1664 pub fn with_stage(mut self, stage: u32) -> Compiler {
1669 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1670 pub fn is_snapshot(&self, build: &Build) -> bool {
1671 self.stage == 0 && self.host == build.build
1674 /// Returns if this compiler should be treated as a final stage one in the
1675 /// current build session.
1676 /// This takes into account whether we're performing a full bootstrap or
1677 /// not; don't directly compare the stage with `2`!
1678 pub fn is_final_stage(&self, build: &Build) -> bool {
1679 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1680 self.stage >= final_stage
1684 fn envify(s: &str) -> String {
1690 .flat_map(|c| c.to_uppercase())