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 build_helper::ci::CiEnv;
117 use channel::GitInfo;
118 use config::{DryRun, Target};
119 use filetime::FileTime;
120 use once_cell::sync::OnceCell;
122 use crate::builder::Kind;
123 use crate::config::{LlvmLibunwind, TargetSelection};
125 exe, libdir, mtime, output, run, run_suppressed, symlink_dir, try_run_suppressed,
154 #[cfg(feature = "build-metrics")]
160 #[cfg(all(unix, not(target_os = "haiku")))]
162 pub unsafe fn setup(build: &mut crate::Build) {
163 if build.config.low_priority {
164 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
169 #[cfg(any(target_os = "haiku", target_os = "hermit", not(any(unix, windows))))]
171 pub unsafe fn setup(_build: &mut crate::Build) {}
174 pub use crate::builder::PathSet;
175 use crate::cache::{Interned, INTERNER};
176 pub use crate::config::Config;
177 pub use crate::flags::Subcommand;
179 const LLVM_TOOLS: &[&str] = &[
180 "llvm-cov", // used to generate coverage report
181 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
182 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
183 "llvm-objdump", // used to disassemble programs
184 "llvm-profdata", // used to inspect and merge files generated by profiles
185 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
186 "llvm-size", // used to prints the size of the linker sections of a program
187 "llvm-strip", // used to discard symbols from binary files to reduce their size
188 "llvm-ar", // used for creating and modifying archive files
189 "llvm-as", // used to convert LLVM assembly to LLVM bitcode
190 "llvm-dis", // used to disassemble LLVM bitcode
191 "llc", // used to compile LLVM bytecode
192 "opt", // used to optimize LLVM bytecode
195 /// LLD file names for all flavors.
196 const LLD_FILE_NAMES: &[&str] = &["ld.lld", "ld64.lld", "lld-link", "wasm-ld"];
198 pub const VERSION: usize = 2;
200 /// Extra --check-cfg to add when building
201 /// (Mode restriction, config name, config values (if any))
202 const EXTRA_CHECK_CFGS: &[(Option<Mode>, &'static str, Option<&[&'static str]>)] = &[
203 (None, "bootstrap", None),
204 (Some(Mode::Rustc), "parallel_compiler", None),
205 (Some(Mode::ToolRustc), "parallel_compiler", None),
206 (Some(Mode::ToolRustc), "emulate_second_only_system", None),
207 (Some(Mode::Codegen), "parallel_compiler", None),
208 (Some(Mode::Std), "stdarch_intel_sde", None),
209 (Some(Mode::Std), "no_fp_fmt_parse", None),
210 (Some(Mode::Std), "no_global_oom_handling", None),
211 (Some(Mode::Std), "no_rc", None),
212 (Some(Mode::Std), "no_sync", None),
213 (Some(Mode::Std), "freebsd12", None),
214 (Some(Mode::Std), "backtrace_in_libstd", None),
215 /* Extra values not defined in the built-in targets yet, but used in std */
216 (Some(Mode::Std), "target_env", Some(&["libnx"])),
217 (Some(Mode::Std), "target_os", Some(&["watchos"])),
221 Some(&["asmjs", "spirv", "nvptx", "nvptx64", "le32", "xtensa"]),
223 /* Extra names used by dependencies */
224 // FIXME: Used by rustfmt is their test but is invalid (neither cargo nor bootstrap ever set
225 // this config) should probably by removed or use a allow attribute.
226 (Some(Mode::ToolRustc), "release", None),
227 // FIXME: Used by stdarch in their test, should use a allow attribute instead.
228 (Some(Mode::Std), "dont_compile_me", None),
229 // FIXME: Used by serde_json, but we should not be triggering on external dependencies.
230 (Some(Mode::Rustc), "no_btreemap_remove_entry", None),
231 (Some(Mode::ToolRustc), "no_btreemap_remove_entry", None),
232 // FIXME: Used by crossbeam-utils, but we should not be triggering on external dependencies.
233 (Some(Mode::Rustc), "crossbeam_loom", None),
234 (Some(Mode::ToolRustc), "crossbeam_loom", None),
235 // FIXME: Used by proc-macro2, but we should not be triggering on external dependencies.
236 (Some(Mode::Rustc), "span_locations", None),
237 (Some(Mode::ToolRustc), "span_locations", None),
238 // Can be passed in RUSTFLAGS to prevent direct syscalls in rustix.
239 (None, "rustix_use_libc", None),
242 /// A structure representing a Rust compiler.
244 /// Each compiler has a `stage` that it is associated with and a `host` that
245 /// corresponds to the platform the compiler runs on. This structure is used as
246 /// a parameter to many methods below.
247 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
248 pub struct Compiler {
250 host: TargetSelection,
253 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
255 /// Run normal tests and doc tests (default).
257 /// Do not run any doc tests.
259 /// Only run doc tests.
268 /// Global configuration for the build system.
270 /// This structure transitively contains all configuration for the build system.
271 /// All filesystem-encoded configuration is in `config`, all flags are in
272 /// `flags`, and then parsed or probed information is listed in the keys below.
274 /// This structure is a parameter of almost all methods in the build system,
275 /// although most functions are implemented as free functions rather than
276 /// methods specifically on this structure itself (to make it easier to
279 /// User-specified configuration from `config.toml`.
282 // Version information
285 // Properties derived from the above configuration
288 bootstrap_out: PathBuf,
289 cargo_info: channel::GitInfo,
290 rust_analyzer_info: channel::GitInfo,
291 clippy_info: channel::GitInfo,
292 miri_info: channel::GitInfo,
293 rustfmt_info: channel::GitInfo,
294 in_tree_llvm_info: channel::GitInfo,
300 // Targets for which to build
301 build: TargetSelection,
302 hosts: Vec<TargetSelection>,
303 targets: Vec<TargetSelection>,
305 initial_rustc: PathBuf,
306 initial_cargo: PathBuf,
307 initial_lld: PathBuf,
308 initial_libdir: PathBuf,
310 // Runtime state filled in later on
311 // C/C++ compilers and archiver for all targets
312 cc: HashMap<TargetSelection, cc::Tool>,
313 cxx: HashMap<TargetSelection, cc::Tool>,
314 ar: HashMap<TargetSelection, PathBuf>,
315 ranlib: HashMap<TargetSelection, PathBuf>,
317 // allow bidirectional lookups: both name -> path and path -> name
318 crates: HashMap<Interned<String>, Crate>,
319 crate_paths: HashMap<PathBuf, Interned<String>>,
322 delayed_failures: RefCell<Vec<String>>,
323 prerelease_version: Cell<Option<u32>>,
325 RefCell<HashMap<TargetSelection, HashMap<String, (&'static str, PathBuf, Vec<String>)>>>,
327 #[cfg(feature = "build-metrics")]
328 metrics: metrics::BuildMetrics,
333 name: Interned<String>,
334 deps: HashSet<Interned<String>>,
339 fn local_path(&self, build: &Build) -> PathBuf {
340 self.path.strip_prefix(&build.config.src).unwrap().into()
344 /// When building Rust various objects are handled differently.
345 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
346 pub enum DependencyType {
347 /// Libraries originating from proc-macros.
349 /// Typical Rust libraries.
351 /// Non Rust libraries and objects shipped to ease usage of certain targets.
355 /// The various "modes" of invoking Cargo.
357 /// These entries currently correspond to the various output directories of the
358 /// build system, with each mod generating output in a different directory.
359 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
361 /// Build the standard library, placing output in the "stageN-std" directory.
364 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
367 /// Build a codegen backend for rustc, placing the output in the "stageN-codegen" directory.
370 /// Build a tool, placing output in the "stage0-bootstrap-tools"
371 /// directory. This is for miscellaneous sets of tools that are built
372 /// using the bootstrap stage0 compiler in its entirety (target libraries
373 /// and all). Typically these tools compile with stable Rust.
376 /// Build a tool which uses the locally built std, placing output in the
377 /// "stageN-tools" directory. Its usage is quite rare, mainly used by
378 /// compiletest which needs libtest.
381 /// Build a tool which uses the locally built rustc and the target std,
382 /// placing the output in the "stageN-tools" directory. This is used for
383 /// anything that needs a fully functional rustc, such as rustdoc, clippy,
384 /// cargo, rls, rustfmt, miri, etc.
389 pub fn is_tool(&self) -> bool {
390 matches!(self, Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd)
393 pub fn must_support_dlopen(&self) -> bool {
394 matches!(self, Mode::Std | Mode::Codegen)
403 macro_rules! forward {
404 ( $( $fn:ident( $($param:ident: $ty:ty),* ) $( -> $ret:ty)? ),+ $(,)? ) => {
406 $( fn $fn(&self, $($param: $ty),* ) $( -> $ret)? {
407 self.config.$fn( $($param),* )
415 is_verbose() -> bool,
416 create(path: &Path, s: &str),
418 tempdir() -> PathBuf,
419 try_run(cmd: &mut Command) -> bool,
420 llvm_link_shared() -> bool,
421 download_rustc() -> bool,
422 initial_rustfmt() -> Option<PathBuf>,
426 /// Creates a new set of build configuration from the `flags` on the command
427 /// line and the filesystem `config`.
429 /// By default all build output will be placed in the current directory.
430 pub fn new(mut config: Config) -> Build {
431 let src = config.src.clone();
432 let out = config.out.clone();
435 // keep this consistent with the equivalent check in x.py:
436 // https://github.com/rust-lang/rust/blob/a8a33cf27166d3eabaffc58ed3799e054af3b0c6/src/bootstrap/bootstrap.py#L796-L797
437 let is_sudo = match env::var_os("SUDO_USER") {
438 Some(_sudo_user) => {
439 let uid = unsafe { libc::getuid() };
447 let ignore_git = config.ignore_git;
448 let rust_info = channel::GitInfo::new(ignore_git, &src);
449 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
450 let rust_analyzer_info =
451 channel::GitInfo::new(ignore_git, &src.join("src/tools/rust-analyzer"));
452 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
453 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
454 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
456 // we always try to use git for LLVM builds
457 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
459 let initial_target_libdir_str = if config.dry_run() {
460 "/dummy/lib/path/to/lib/".to_string()
463 Command::new(&config.initial_rustc)
465 .arg(config.build.rustc_target_arg())
467 .arg("target-libdir"),
470 let initial_target_dir = Path::new(&initial_target_libdir_str).parent().unwrap();
471 let initial_lld = initial_target_dir.join("bin").join("rust-lld");
473 let initial_sysroot = if config.dry_run() {
476 output(Command::new(&config.initial_rustc).arg("--print").arg("sysroot"))
478 let initial_libdir = initial_target_dir
483 .strip_prefix(initial_sysroot.trim())
487 let version = std::fs::read_to_string(src.join("src").join("version"))
488 .expect("failed to read src/version");
489 let version = version.trim();
491 let bootstrap_out = std::env::current_exe()
492 .expect("could not determine path to running process")
496 if !bootstrap_out.join(exe("rustc", config.build)).exists() && !cfg!(test) {
497 // this restriction can be lifted whenever https://github.com/rust-lang/rfcs/pull/3028 is implemented
499 "`rustc` not found in {}, run `cargo build --bins` before `cargo run`",
500 bootstrap_out.display()
504 if rust_info.is_from_tarball() && config.description.is_none() {
505 config.description = Some("built from a source tarball".to_owned());
508 let mut build = Build {
509 initial_rustc: config.initial_rustc.clone(),
510 initial_cargo: config.initial_cargo.clone(),
513 local_rebuild: config.local_rebuild,
514 fail_fast: config.cmd.fail_fast(),
515 doc_tests: config.cmd.doc_tests(),
516 verbosity: config.verbose,
519 hosts: config.hosts.clone(),
520 targets: config.targets.clone(),
523 version: version.to_string(),
537 ranlib: HashMap::new(),
538 crates: HashMap::new(),
539 crate_paths: HashMap::new(),
541 ci_env: CiEnv::current(),
542 delayed_failures: RefCell::new(Vec::new()),
543 prerelease_version: Cell::new(None),
544 tool_artifacts: Default::default(),
546 #[cfg(feature = "build-metrics")]
547 metrics: metrics::BuildMetrics::init(),
550 // If local-rust is the same major.minor as the current version, then force a
552 let local_version_verbose =
553 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
554 let local_release = local_version_verbose
556 .filter_map(|x| x.strip_prefix("release:"))
560 if local_release.split('.').take(2).eq(version.split('.').take(2)) {
561 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
562 build.local_rebuild = true;
565 build.verbose("finding compilers");
566 cc_detect::find(&mut build);
567 // When running `setup`, the profile is about to change, so any requirements we have now may
568 // be different on the next invocation. Don't check for them until the next time x.py is
569 // run. This is ok because `setup` never runs any build commands, so it won't fail if commands are missing.
571 // Similarly, for `setup` we don't actually need submodules or cargo metadata.
572 if !matches!(build.config.cmd, Subcommand::Setup { .. }) {
573 build.verbose("running sanity check");
574 sanity::check(&mut build);
576 // Make sure we update these before gathering metadata so we don't get an error about missing
578 let rust_submodules = [
579 "src/tools/rust-installer",
584 for s in rust_submodules {
585 build.update_submodule(Path::new(s));
587 // Now, update all existing submodules.
588 build.update_existing_submodules();
590 build.verbose("learning about cargo");
591 metadata::build(&mut build);
594 // Make a symbolic link so we can use a consistent directory in the documentation.
595 let build_triple = build.out.join(&build.build.triple);
596 let host = build.out.join("host");
597 if let Err(e) = symlink_dir(&build.config, &build_triple, &host) {
598 if e.kind() != ErrorKind::AlreadyExists {
600 "symlink_dir({} => {}) failed with {}",
602 build_triple.display(),
611 // modified from `check_submodule` and `update_submodule` in bootstrap.py
612 /// Given a path to the directory of a submodule, update it.
614 /// `relative_path` should be relative to the root of the git repository, not an absolute path.
615 pub(crate) fn update_submodule(&self, relative_path: &Path) {
616 fn dir_is_empty(dir: &Path) -> bool {
617 t!(std::fs::read_dir(dir)).next().is_none()
620 if !self.config.submodules(&self.rust_info()) {
624 let absolute_path = self.config.src.join(relative_path);
626 // NOTE: The check for the empty directory is here because when running x.py the first time,
627 // the submodule won't be checked out. Check it out now so we can build it.
628 if !channel::GitInfo::new(false, &absolute_path).is_managed_git_subrepository()
629 && !dir_is_empty(&absolute_path)
635 let checked_out_hash =
636 output(Command::new("git").args(&["rev-parse", "HEAD"]).current_dir(&absolute_path));
638 let recorded = output(
640 .args(&["ls-tree", "HEAD"])
642 .current_dir(&self.config.src),
644 let actual_hash = recorded
647 .unwrap_or_else(|| panic!("unexpected output `{}`", recorded));
650 if actual_hash == checked_out_hash.trim_end() {
651 // already checked out
655 println!("Updating submodule {}", relative_path.display());
658 .args(&["submodule", "-q", "sync"])
660 .current_dir(&self.config.src),
663 // Try passing `--progress` to start, then run git again without if that fails.
664 let update = |progress: bool| {
665 let mut git = Command::new("git");
666 git.args(&["submodule", "update", "--init", "--recursive", "--depth=1"]);
668 git.arg("--progress");
670 git.arg(relative_path).current_dir(&self.config.src);
673 // NOTE: doesn't use `try_run` because this shouldn't print an error if it fails.
674 if !update(true).status().map_or(false, |status| status.success()) {
675 self.run(&mut update(false));
678 // Save any local changes, but avoid running `git stash pop` if there are none (since it will exit with an error).
679 let has_local_modifications = !self.try_run(
681 .args(&["diff-index", "--quiet", "HEAD"])
682 .current_dir(&absolute_path),
684 if has_local_modifications {
685 self.run(Command::new("git").args(&["stash", "push"]).current_dir(&absolute_path));
688 self.run(Command::new("git").args(&["reset", "-q", "--hard"]).current_dir(&absolute_path));
689 self.run(Command::new("git").args(&["clean", "-qdfx"]).current_dir(&absolute_path));
691 if has_local_modifications {
692 self.run(Command::new("git").args(&["stash", "pop"]).current_dir(absolute_path));
696 /// If any submodule has been initialized already, sync it unconditionally.
697 /// This avoids contributors checking in a submodule change by accident.
698 pub fn update_existing_submodules(&self) {
699 // Avoid running git when there isn't a git checkout.
700 if !self.config.submodules(&self.rust_info()) {
706 .args(&["config", "--file"])
707 .arg(&self.config.src.join(".gitmodules"))
708 .args(&["--get-regexp", "path"]),
710 for line in output.lines() {
711 // Look for `submodule.$name.path = $path`
712 // Sample output: `submodule.src/rust-installer.path src/tools/rust-installer`
713 let submodule = Path::new(line.splitn(2, ' ').nth(1).unwrap());
714 // Don't update the submodule unless it's already been cloned.
715 if channel::GitInfo::new(false, submodule).is_managed_git_subrepository() {
716 self.update_submodule(submodule);
721 /// Executes the entire build, as configured by the flags and configuration.
722 pub fn build(&mut self) {
727 if let Subcommand::Format { check, paths } = &self.config.cmd {
728 return format::format(&builder::Builder::new(&self), *check, &paths);
731 // Download rustfmt early so that it can be used in rust-analyzer configs.
732 let _ = &builder::Builder::new(&self).initial_rustfmt();
735 let builder = builder::Builder::new(&self);
736 if let Some(path) = builder.paths.get(0) {
737 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
743 if !self.config.dry_run() {
745 self.config.dry_run = DryRun::SelfCheck;
746 let builder = builder::Builder::new(&self);
747 builder.execute_cli();
749 self.config.dry_run = DryRun::Disabled;
750 let builder = builder::Builder::new(&self);
751 builder.execute_cli();
753 let builder = builder::Builder::new(&self);
754 builder.execute_cli();
757 // Check for postponed failures from `test --no-fail-fast`.
758 let failures = self.delayed_failures.borrow();
759 if failures.len() > 0 {
760 eprintln!("\n{} command(s) did not execute successfully:\n", failures.len());
761 for failure in failures.iter() {
762 eprintln!(" - {}\n", failure);
767 #[cfg(feature = "build-metrics")]
768 self.metrics.persist(self);
771 /// Clear out `dir` if `input` is newer.
773 /// After this executes, it will also ensure that `dir` exists.
774 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
775 let stamp = dir.join(".stamp");
776 let mut cleared = false;
777 if mtime(&stamp) < mtime(input) {
778 self.verbose(&format!("Dirty - {}", dir.display()));
779 let _ = fs::remove_dir_all(dir);
781 } else if stamp.exists() {
784 t!(fs::create_dir_all(dir));
785 t!(File::create(stamp));
789 fn rust_info(&self) -> &GitInfo {
790 &self.config.rust_info
793 /// Gets the space-separated set of activated features for the standard
795 fn std_features(&self, target: TargetSelection) -> String {
796 let mut features = " panic-unwind".to_string();
798 match self.config.llvm_libunwind(target) {
799 LlvmLibunwind::InTree => features.push_str(" llvm-libunwind"),
800 LlvmLibunwind::System => features.push_str(" system-llvm-libunwind"),
801 LlvmLibunwind::No => {}
803 if self.config.backtrace {
804 features.push_str(" backtrace");
806 if self.config.profiler_enabled(target) {
807 features.push_str(" profiler");
812 /// Gets the space-separated set of activated features for the compiler.
813 fn rustc_features(&self, kind: Kind) -> String {
814 let mut features = vec![];
815 if self.config.jemalloc {
816 features.push("jemalloc");
818 if self.config.llvm_enabled() || kind == Kind::Check {
819 features.push("llvm");
821 // keep in sync with `bootstrap/compile.rs:rustc_cargo_env`
822 if self.config.rustc_parallel {
823 features.push("rustc_use_parallel_compiler");
826 // If debug logging is on, then we want the default for tracing:
827 // https://github.com/tokio-rs/tracing/blob/3dd5c03d907afdf2c39444a29931833335171554/tracing/src/level_filters.rs#L26
828 // which is everything (including debug/trace/etc.)
829 // if its unset, if debug_assertions is on, then debug_logging will also be on
830 // as well as tracing *ignoring* this feature when debug_assertions is on
831 if !self.config.rust_debug_logging {
832 features.push("max_level_info");
838 /// Component directory that Cargo will produce output into (e.g.
840 fn cargo_dir(&self) -> &'static str {
841 if self.config.rust_optimize { "release" } else { "debug" }
844 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
847 .join(&*compiler.host.triple)
848 .join(format!("stage{}-tools-bin", compiler.stage));
849 t!(fs::create_dir_all(&out));
853 /// Returns the root directory for all output generated in a particular
854 /// stage when running with a particular host compiler.
856 /// The mode indicates what the root directory is for.
857 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
858 let suffix = match mode {
860 Mode::Rustc => "-rustc",
861 Mode::Codegen => "-codegen",
862 Mode::ToolBootstrap => "-bootstrap-tools",
863 Mode::ToolStd | Mode::ToolRustc => "-tools",
865 self.out.join(&*compiler.host.triple).join(format!("stage{}{}", compiler.stage, suffix))
868 /// Returns the root output directory for all Cargo output in a given stage,
869 /// running a particular compiler, whether or not we're building the
870 /// standard library, and targeting the specified architecture.
871 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: TargetSelection) -> PathBuf {
872 self.stage_out(compiler, mode).join(&*target.triple).join(self.cargo_dir())
875 /// Root output directory for LLVM compiled for `target`
877 /// Note that if LLVM is configured externally then the directory returned
878 /// will likely be empty.
879 fn llvm_out(&self, target: TargetSelection) -> PathBuf {
880 self.out.join(&*target.triple).join("llvm")
883 fn lld_out(&self, target: TargetSelection) -> PathBuf {
884 self.out.join(&*target.triple).join("lld")
887 /// Output directory for all documentation for a target
888 fn doc_out(&self, target: TargetSelection) -> PathBuf {
889 self.out.join(&*target.triple).join("doc")
892 /// Output directory for all JSON-formatted documentation for a target
893 fn json_doc_out(&self, target: TargetSelection) -> PathBuf {
894 self.out.join(&*target.triple).join("json-doc")
897 fn test_out(&self, target: TargetSelection) -> PathBuf {
898 self.out.join(&*target.triple).join("test")
901 /// Output directory for all documentation for a target
902 fn compiler_doc_out(&self, target: TargetSelection) -> PathBuf {
903 self.out.join(&*target.triple).join("compiler-doc")
906 /// Output directory for some generated md crate documentation for a target (temporary)
907 fn md_doc_out(&self, target: TargetSelection) -> Interned<PathBuf> {
908 INTERNER.intern_path(self.out.join(&*target.triple).join("md-doc"))
911 /// Returns `true` if no custom `llvm-config` is set for the specified target.
913 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
914 fn is_rust_llvm(&self, target: TargetSelection) -> bool {
915 match self.config.target_config.get(&target) {
916 Some(Target { llvm_has_rust_patches: Some(patched), .. }) => *patched,
917 Some(Target { llvm_config, .. }) => {
918 // If the user set llvm-config we assume Rust is not patched,
919 // but first check to see if it was configured by llvm-from-ci.
920 (self.config.llvm_from_ci && target == self.config.build) || llvm_config.is_none()
926 /// Returns the path to `FileCheck` binary for the specified target
927 fn llvm_filecheck(&self, target: TargetSelection) -> PathBuf {
928 let target_config = self.config.target_config.get(&target);
929 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
931 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
932 let llvm_bindir = output(Command::new(s).arg("--bindir"));
933 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", target));
934 if filecheck.exists() {
937 // On Fedora the system LLVM installs FileCheck in the
938 // llvm subdirectory of the libdir.
939 let llvm_libdir = output(Command::new(s).arg("--libdir"));
941 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", target));
942 if lib_filecheck.exists() {
945 // Return the most normal file name, even though
946 // it doesn't exist, so that any error message
952 let base = self.llvm_out(target).join("build");
953 let base = if !self.ninja() && target.contains("msvc") {
954 if self.config.llvm_optimize {
955 if self.config.llvm_release_debuginfo {
956 base.join("RelWithDebInfo")
966 base.join("bin").join(exe("FileCheck", target))
970 /// Directory for libraries built from C/C++ code and shared between stages.
971 fn native_dir(&self, target: TargetSelection) -> PathBuf {
972 self.out.join(&*target.triple).join("native")
975 /// Root output directory for rust_test_helpers library compiled for
977 fn test_helpers_out(&self, target: TargetSelection) -> PathBuf {
978 self.native_dir(target).join("rust-test-helpers")
981 /// Adds the `RUST_TEST_THREADS` env var if necessary
982 fn add_rust_test_threads(&self, cmd: &mut Command) {
983 if env::var_os("RUST_TEST_THREADS").is_none() {
984 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
988 /// Returns the libdir of the snapshot compiler.
989 fn rustc_snapshot_libdir(&self) -> PathBuf {
990 self.rustc_snapshot_sysroot().join(libdir(self.config.build))
993 /// Returns the sysroot of the snapshot compiler.
994 fn rustc_snapshot_sysroot(&self) -> &Path {
995 static SYSROOT_CACHE: OnceCell<PathBuf> = once_cell::sync::OnceCell::new();
996 SYSROOT_CACHE.get_or_init(|| {
997 let mut rustc = Command::new(&self.initial_rustc);
998 rustc.args(&["--print", "sysroot"]);
999 output(&mut rustc).trim().into()
1003 /// Runs a command, printing out nice contextual information if it fails.
1004 fn run(&self, cmd: &mut Command) {
1005 if self.config.dry_run() {
1008 self.verbose(&format!("running: {:?}", cmd));
1009 run(cmd, self.is_verbose())
1012 /// Runs a command, printing out nice contextual information if it fails.
1013 fn run_quiet(&self, cmd: &mut Command) {
1014 if self.config.dry_run() {
1017 self.verbose(&format!("running: {:?}", cmd));
1021 /// Runs a command, printing out nice contextual information if it fails.
1022 /// Exits if the command failed to execute at all, otherwise returns its
1023 /// `status.success()`.
1024 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
1025 if self.config.dry_run() {
1028 self.verbose(&format!("running: {:?}", cmd));
1029 try_run_suppressed(cmd)
1032 pub fn is_verbose_than(&self, level: usize) -> bool {
1033 self.verbosity > level
1036 /// Prints a message if this build is configured in more verbose mode than `level`.
1037 fn verbose_than(&self, level: usize, msg: &str) {
1038 if self.is_verbose_than(level) {
1039 println!("{}", msg);
1043 fn info(&self, msg: &str) {
1044 match self.config.dry_run {
1045 DryRun::SelfCheck => return,
1046 DryRun::Disabled | DryRun::UserSelected => {
1047 println!("{}", msg);
1052 /// Returns the number of parallel jobs that have been configured for this
1054 fn jobs(&self) -> u32 {
1055 self.config.jobs.unwrap_or_else(|| {
1056 std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get) as u32
1060 fn debuginfo_map_to(&self, which: GitRepo) -> Option<String> {
1061 if !self.config.rust_remap_debuginfo {
1067 let sha = self.rust_sha().unwrap_or(&self.version);
1068 Some(format!("/rustc/{}", sha))
1070 GitRepo::Llvm => Some(String::from("/rustc/llvm")),
1074 /// Returns the path to the C compiler for the target specified.
1075 fn cc(&self, target: TargetSelection) -> &Path {
1076 self.cc[&target].path()
1079 /// Returns a list of flags to pass to the C compiler for the target
1081 fn cflags(&self, target: TargetSelection, which: GitRepo, c: CLang) -> Vec<String> {
1082 let base = match c {
1083 CLang::C => &self.cc[&target],
1084 CLang::Cxx => &self.cxx[&target],
1087 // Filter out -O and /O (the optimization flags) that we picked up from
1088 // cc-rs because the build scripts will determine that for themselves.
1092 .map(|s| s.to_string_lossy().into_owned())
1093 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
1094 .collect::<Vec<String>>();
1096 // If we're compiling on macOS then we add a few unconditional flags
1097 // indicating that we want libc++ (more filled out than libstdc++) and
1098 // we want to compile for 10.7. This way we can ensure that
1099 // LLVM/etc are all properly compiled.
1100 if target.contains("apple-darwin") {
1101 base.push("-stdlib=libc++".into());
1104 // Work around an apparently bad MinGW / GCC optimization,
1105 // See: https://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
1106 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
1107 if &*target.triple == "i686-pc-windows-gnu" {
1108 base.push("-fno-omit-frame-pointer".into());
1111 if let Some(map_to) = self.debuginfo_map_to(which) {
1112 let map = format!("{}={}", self.src.display(), map_to);
1113 let cc = self.cc(target);
1114 if cc.ends_with("clang") || cc.ends_with("gcc") {
1115 base.push(format!("-fdebug-prefix-map={}", map));
1116 } else if cc.ends_with("clang-cl.exe") {
1117 base.push("-Xclang".into());
1118 base.push(format!("-fdebug-prefix-map={}", map));
1124 /// Returns the path to the `ar` archive utility for the target specified.
1125 fn ar(&self, target: TargetSelection) -> Option<&Path> {
1126 self.ar.get(&target).map(|p| &**p)
1129 /// Returns the path to the `ranlib` utility for the target specified.
1130 fn ranlib(&self, target: TargetSelection) -> Option<&Path> {
1131 self.ranlib.get(&target).map(|p| &**p)
1134 /// Returns the path to the C++ compiler for the target specified.
1135 fn cxx(&self, target: TargetSelection) -> Result<&Path, String> {
1136 match self.cxx.get(&target) {
1137 Some(p) => Ok(p.path()),
1139 Err(format!("target `{}` is not configured as a host, only as a target", target))
1144 /// Returns the path to the linker for the given target if it needs to be overridden.
1145 fn linker(&self, target: TargetSelection) -> Option<&Path> {
1146 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
1149 } else if target.contains("vxworks") {
1150 // need to use CXX compiler as linker to resolve the exception functions
1151 // that are only existed in CXX libraries
1152 Some(self.cxx[&target].path())
1153 } else if target != self.config.build
1154 && util::use_host_linker(target)
1155 && !target.contains("msvc")
1157 Some(self.cc(target))
1158 } else if self.config.use_lld && !self.is_fuse_ld_lld(target) && self.build == target {
1159 Some(&self.initial_lld)
1165 // LLD is used through `-fuse-ld=lld` rather than directly.
1166 // Only MSVC targets use LLD directly at the moment.
1167 fn is_fuse_ld_lld(&self, target: TargetSelection) -> bool {
1168 self.config.use_lld && !target.contains("msvc")
1171 fn lld_flags(&self, target: TargetSelection) -> impl Iterator<Item = String> {
1172 let mut options = [None, None];
1174 if self.config.use_lld {
1175 if self.is_fuse_ld_lld(target) {
1176 options[0] = Some("-Clink-arg=-fuse-ld=lld".to_string());
1179 let no_threads = util::lld_flag_no_threads(target.contains("windows"));
1180 options[1] = Some(format!("-Clink-arg=-Wl,{}", no_threads));
1183 IntoIterator::into_iter(options).flatten()
1186 /// Returns if this target should statically link the C runtime, if specified
1187 fn crt_static(&self, target: TargetSelection) -> Option<bool> {
1188 if target.contains("pc-windows-msvc") {
1191 self.config.target_config.get(&target).and_then(|t| t.crt_static)
1195 /// Returns the "musl root" for this `target`, if defined
1196 fn musl_root(&self, target: TargetSelection) -> Option<&Path> {
1200 .and_then(|t| t.musl_root.as_ref())
1201 .or_else(|| self.config.musl_root.as_ref())
1205 /// Returns the "musl libdir" for this `target`.
1206 fn musl_libdir(&self, target: TargetSelection) -> Option<PathBuf> {
1207 let t = self.config.target_config.get(&target)?;
1208 if let libdir @ Some(_) = &t.musl_libdir {
1209 return libdir.clone();
1211 self.musl_root(target).map(|root| root.join("lib"))
1214 /// Returns the sysroot for the wasi target, if defined
1215 fn wasi_root(&self, target: TargetSelection) -> Option<&Path> {
1216 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
1219 /// Returns `true` if this is a no-std `target`, if defined
1220 fn no_std(&self, target: TargetSelection) -> Option<bool> {
1221 self.config.target_config.get(&target).map(|t| t.no_std)
1224 /// Returns `true` if the target will be tested using the `remote-test-client`
1225 /// and `remote-test-server` binaries.
1226 fn remote_tested(&self, target: TargetSelection) -> bool {
1227 self.qemu_rootfs(target).is_some()
1228 || target.contains("android")
1229 || env::var_os("TEST_DEVICE_ADDR").is_some()
1232 /// Returns the root of the "rootfs" image that this target will be using,
1233 /// if one was configured.
1235 /// If `Some` is returned then that means that tests for this target are
1236 /// emulated with QEMU and binaries will need to be shipped to the emulator.
1237 fn qemu_rootfs(&self, target: TargetSelection) -> Option<&Path> {
1238 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
1241 /// Path to the python interpreter to use
1242 fn python(&self) -> &Path {
1243 if self.config.build.ends_with("apple-darwin") {
1244 // Force /usr/bin/python3 on macOS for LLDB tests because we're loading the
1245 // LLDB plugin's compiled module which only works with the system python
1246 // (namely not Homebrew-installed python)
1247 Path::new("/usr/bin/python3")
1252 .expect("python is required for running LLDB or rustdoc tests")
1256 /// Temporary directory that extended error information is emitted to.
1257 fn extended_error_dir(&self) -> PathBuf {
1258 self.out.join("tmp/extended-error-metadata")
1261 /// Tests whether the `compiler` compiling for `target` should be forced to
1262 /// use a stage1 compiler instead.
1264 /// Currently, by default, the build system does not perform a "full
1265 /// bootstrap" by default where we compile the compiler three times.
1266 /// Instead, we compile the compiler two times. The final stage (stage2)
1267 /// just copies the libraries from the previous stage, which is what this
1270 /// Here we return `true` if:
1272 /// * The build isn't performing a full bootstrap
1273 /// * The `compiler` is in the final stage, 2
1274 /// * We're not cross-compiling, so the artifacts are already available in
1277 /// When all of these conditions are met the build will lift artifacts from
1278 /// the previous stage forward.
1279 fn force_use_stage1(&self, compiler: Compiler, target: TargetSelection) -> bool {
1280 !self.config.full_bootstrap
1281 && compiler.stage >= 2
1282 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
1285 /// Given `num` in the form "a.b.c" return a "release string" which
1286 /// describes the release version number.
1288 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
1289 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
1290 fn release(&self, num: &str) -> String {
1291 match &self.config.channel[..] {
1292 "stable" => num.to_string(),
1294 if self.rust_info().is_managed_git_subrepository() && !self.config.ignore_git {
1295 format!("{}-beta.{}", num, self.beta_prerelease_version())
1297 format!("{}-beta", num)
1300 "nightly" => format!("{}-nightly", num),
1301 _ => format!("{}-dev", num),
1305 fn beta_prerelease_version(&self) -> u32 {
1306 if let Some(s) = self.prerelease_version.get() {
1310 // Figure out how many merge commits happened since we branched off master.
1311 // That's our beta number!
1312 // (Note that we use a `..` range, not the `...` symmetric difference.)
1314 output(self.config.git().arg("rev-list").arg("--count").arg("--merges").arg(format!(
1315 "refs/remotes/origin/{}..HEAD",
1316 self.config.stage0_metadata.config.nightly_branch
1318 let n = count.trim().parse().unwrap();
1319 self.prerelease_version.set(Some(n));
1323 /// Returns the value of `release` above for Rust itself.
1324 fn rust_release(&self) -> String {
1325 self.release(&self.version)
1328 /// Returns the "package version" for a component given the `num` release
1331 /// The package version is typically what shows up in the names of tarballs.
1332 /// For channels like beta/nightly it's just the channel name, otherwise
1333 /// it's the `num` provided.
1334 fn package_vers(&self, num: &str) -> String {
1335 match &self.config.channel[..] {
1336 "stable" => num.to_string(),
1337 "beta" => "beta".to_string(),
1338 "nightly" => "nightly".to_string(),
1339 _ => format!("{}-dev", num),
1343 /// Returns the value of `package_vers` above for Rust itself.
1344 fn rust_package_vers(&self) -> String {
1345 self.package_vers(&self.version)
1348 /// Returns the `version` string associated with this compiler for Rust
1351 /// Note that this is a descriptive string which includes the commit date,
1352 /// sha, version, etc.
1353 fn rust_version(&self) -> String {
1354 let mut version = self.rust_info().version(self, &self.version);
1355 if let Some(ref s) = self.config.description {
1356 version.push_str(" (");
1357 version.push_str(s);
1363 /// Returns the full commit hash.
1364 fn rust_sha(&self) -> Option<&str> {
1365 self.rust_info().sha()
1368 /// Returns the `a.b.c` version that the given package is at.
1369 fn release_num(&self, package: &str) -> String {
1370 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1371 let toml = t!(fs::read_to_string(&toml_file_name));
1372 for line in toml.lines() {
1373 if let Some(stripped) =
1374 line.strip_prefix("version = \"").and_then(|s| s.strip_suffix("\""))
1376 return stripped.to_owned();
1380 panic!("failed to find version in {}'s Cargo.toml", package)
1383 /// Returns `true` if unstable features should be enabled for the compiler
1385 fn unstable_features(&self) -> bool {
1386 match &self.config.channel[..] {
1387 "stable" | "beta" => false,
1388 "nightly" | _ => true,
1392 /// Returns a Vec of all the dependencies of the given root crate,
1393 /// including transitive dependencies and the root itself. Only includes
1394 /// "local" crates (those in the local source tree, not from a registry).
1395 fn in_tree_crates(&self, root: &str, target: Option<TargetSelection>) -> Vec<&Crate> {
1396 let mut ret = Vec::new();
1397 let mut list = vec![INTERNER.intern_str(root)];
1398 let mut visited = HashSet::new();
1399 while let Some(krate) = list.pop() {
1403 .unwrap_or_else(|| panic!("metadata missing for {krate}: {:?}", self.crates));
1405 for dep in &krate.deps {
1406 if !self.crates.contains_key(dep) {
1407 // Ignore non-workspace members.
1410 // Don't include optional deps if their features are not
1411 // enabled. Ideally this would be computed from `cargo
1412 // metadata --features …`, but that is somewhat slow. In
1413 // the future, we may want to consider just filtering all
1414 // build and dev dependencies in metadata::build.
1415 if visited.insert(dep)
1416 && (dep != "profiler_builtins"
1418 .map(|t| self.config.profiler_enabled(t))
1419 .unwrap_or_else(|| self.config.any_profiler_enabled()))
1420 && (dep != "rustc_codegen_llvm" || self.config.llvm_enabled())
1429 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, DependencyType)> {
1430 if self.config.dry_run() {
1434 if !stamp.exists() {
1436 "Error: Unable to find the stamp file {}, did you try to keep a nonexistent build stage?",
1439 crate::detail_exit(1);
1442 let mut paths = Vec::new();
1443 let contents = t!(fs::read(stamp), &stamp);
1444 // This is the method we use for extracting paths from the stamp file passed to us. See
1445 // run_cargo for more information (in compile.rs).
1446 for part in contents.split(|b| *b == 0) {
1447 if part.is_empty() {
1450 let dependency_type = match part[0] as char {
1451 'h' => DependencyType::Host,
1452 's' => DependencyType::TargetSelfContained,
1453 't' => DependencyType::Target,
1454 _ => unreachable!(),
1456 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1457 paths.push((path, dependency_type));
1462 /// Copies a file from `src` to `dst`
1463 pub fn copy(&self, src: &Path, dst: &Path) {
1464 self.copy_internal(src, dst, false);
1467 fn copy_internal(&self, src: &Path, dst: &Path, dereference_symlinks: bool) {
1468 if self.config.dry_run() {
1471 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1475 let _ = fs::remove_file(&dst);
1476 let metadata = t!(src.symlink_metadata());
1477 let mut src = src.to_path_buf();
1478 if metadata.file_type().is_symlink() {
1479 if dereference_symlinks {
1480 src = t!(fs::canonicalize(src));
1482 let link = t!(fs::read_link(src));
1483 t!(self.symlink_file(link, dst));
1487 if let Ok(()) = fs::hard_link(&src, dst) {
1488 // Attempt to "easy copy" by creating a hard link
1489 // (symlinks don't work on windows), but if that fails
1490 // just fall back to a slow `copy` operation.
1492 if let Err(e) = fs::copy(&src, dst) {
1493 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1495 t!(fs::set_permissions(dst, metadata.permissions()));
1496 let atime = FileTime::from_last_access_time(&metadata);
1497 let mtime = FileTime::from_last_modification_time(&metadata);
1498 t!(filetime::set_file_times(dst, atime, mtime));
1502 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1503 /// when this function is called.
1504 pub fn cp_r(&self, src: &Path, dst: &Path) {
1505 if self.config.dry_run() {
1508 for f in self.read_dir(src) {
1509 let path = f.path();
1510 let name = path.file_name().unwrap();
1511 let dst = dst.join(name);
1512 if t!(f.file_type()).is_dir() {
1513 t!(fs::create_dir_all(&dst));
1514 self.cp_r(&path, &dst);
1516 let _ = fs::remove_file(&dst);
1517 self.copy(&path, &dst);
1522 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1523 /// when this function is called. Unwanted files or directories can be skipped
1524 /// by returning `false` from the filter function.
1525 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1526 // Immediately recurse with an empty relative path
1527 self.recurse_(src, dst, Path::new(""), filter)
1530 // Inner function does the actual work
1531 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1532 for f in self.read_dir(src) {
1533 let path = f.path();
1534 let name = path.file_name().unwrap();
1535 let dst = dst.join(name);
1536 let relative = relative.join(name);
1537 // Only copy file or directory if the filter function returns true
1538 if filter(&relative) {
1539 if t!(f.file_type()).is_dir() {
1540 let _ = fs::remove_dir_all(&dst);
1541 self.create_dir(&dst);
1542 self.recurse_(&path, &dst, &relative, filter);
1544 let _ = fs::remove_file(&dst);
1545 self.copy(&path, &dst);
1551 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1552 let file_name = src.file_name().unwrap();
1553 let dest = dest_folder.join(file_name);
1554 self.copy(src, &dest);
1557 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1558 if self.config.dry_run() {
1561 let dst = dstdir.join(src.file_name().unwrap());
1562 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1563 t!(fs::create_dir_all(dstdir));
1565 panic!("Error: File \"{}\" not found!", src.display());
1567 self.copy_internal(src, &dst, true);
1571 fn read(&self, path: &Path) -> String {
1572 if self.config.dry_run() {
1573 return String::new();
1575 t!(fs::read_to_string(path))
1578 fn create_dir(&self, dir: &Path) {
1579 if self.config.dry_run() {
1582 t!(fs::create_dir_all(dir))
1585 fn remove_dir(&self, dir: &Path) {
1586 if self.config.dry_run() {
1589 t!(fs::remove_dir_all(dir))
1592 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1593 let iter = match fs::read_dir(dir) {
1595 Err(_) if self.config.dry_run() => return vec![].into_iter(),
1596 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1598 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1601 fn symlink_file<P: AsRef<Path>, Q: AsRef<Path>>(&self, src: P, link: Q) -> io::Result<()> {
1603 use std::os::unix::fs::symlink as symlink_file;
1605 use std::os::windows::fs::symlink_file;
1606 if !self.config.dry_run() { symlink_file(src.as_ref(), link.as_ref()) } else { Ok(()) }
1609 /// Returns if config.ninja is enabled, and checks for ninja existence,
1610 /// exiting with a nicer error message if not.
1611 fn ninja(&self) -> bool {
1612 let mut cmd_finder = crate::sanity::Finder::new();
1614 if self.config.ninja_in_file {
1615 // Some Linux distros rename `ninja` to `ninja-build`.
1616 // CMake can work with either binary name.
1617 if cmd_finder.maybe_have("ninja-build").is_none()
1618 && cmd_finder.maybe_have("ninja").is_none()
1622 Couldn't find required command: ninja (or ninja-build)
1624 You should install ninja as described at
1625 <https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages>,
1626 or set `ninja = false` in the `[llvm]` section of `config.toml`.
1627 Alternatively, set `download-ci-llvm = true` in that `[llvm]` section
1628 to download LLVM rather than building it.
1635 // If ninja isn't enabled but we're building for MSVC then we try
1636 // doubly hard to enable it. It was realized in #43767 that the msbuild
1637 // CMake generator for MSVC doesn't respect configuration options like
1638 // disabling LLVM assertions, which can often be quite important!
1640 // In these cases we automatically enable Ninja if we find it in the
1642 if !self.config.ninja_in_file && self.config.build.contains("msvc") {
1643 if cmd_finder.maybe_have("ninja").is_some() {
1648 self.config.ninja_in_file
1653 fn chmod(path: &Path, perms: u32) {
1654 use std::os::unix::fs::*;
1655 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1658 fn chmod(_path: &Path, _perms: u32) {}
1660 /// If code is not 0 (successful exit status), exit status is 101 (rust's default error code.)
1661 /// If the test is running and code is an error code, it will cause a panic.
1662 fn detail_exit(code: i32) -> ! {
1663 // if in test and code is an error code, panic with status code provided
1665 panic!("status code: {}", code);
1667 // otherwise,exit with provided status code
1668 std::process::exit(code);
1673 pub fn with_stage(mut self, stage: u32) -> Compiler {
1678 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1679 pub fn is_snapshot(&self, build: &Build) -> bool {
1680 self.stage == 0 && self.host == build.build
1683 /// Returns if this compiler should be treated as a final stage one in the
1684 /// current build session.
1685 /// This takes into account whether we're performing a full bootstrap or
1686 /// not; don't directly compare the stage with `2`!
1687 pub fn is_final_stage(&self, build: &Build) -> bool {
1688 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1689 self.stage >= final_stage
1693 fn envify(s: &str) -> String {
1699 .flat_map(|c| c.to_uppercase())