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};
110 use std::path::{Path, PathBuf};
111 use std::process::{self, Command};
115 use std::os::unix::fs::symlink as symlink_file;
117 use std::os::windows::fs::symlink_file;
119 use filetime::FileTime;
120 use once_cell::sync::OnceCell;
122 use crate::builder::Kind;
123 use crate::config::{LlvmLibunwind, TargetSelection};
125 check_run, exe, libdir, mtime, output, run, run_suppressed, t, try_run, try_run_suppressed,
156 #[cfg(all(unix, not(target_os = "haiku")))]
158 pub unsafe fn setup(build: &mut crate::Build) {
159 if build.config.low_priority {
160 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
165 #[cfg(any(target_os = "haiku", target_os = "hermit", not(any(unix, windows))))]
167 pub unsafe fn setup(_build: &mut crate::Build) {}
170 use crate::cache::{Interned, INTERNER};
171 pub use crate::config::Config;
172 pub use crate::flags::Subcommand;
174 const LLVM_TOOLS: &[&str] = &[
175 "llvm-cov", // used to generate coverage report
176 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
177 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
178 "llvm-objdump", // used to disassemble programs
179 "llvm-profdata", // used to inspect and merge files generated by profiles
180 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
181 "llvm-size", // used to prints the size of the linker sections of a program
182 "llvm-strip", // used to discard symbols from binary files to reduce their size
183 "llvm-ar", // used for creating and modifying archive files
184 "llvm-as", // used to convert LLVM assembly to LLVM bitcode
185 "llvm-dis", // used to disassemble LLVM bitcode
186 "llc", // used to compile LLVM bytecode
187 "opt", // used to optimize LLVM bytecode
190 pub const VERSION: usize = 2;
192 /// Extra --check-cfg to add when building
193 /// (Mode restriction, config name, config values (if any))
194 const EXTRA_CHECK_CFGS: &[(Option<Mode>, &'static str, Option<&[&'static str]>)] = &[
195 (None, "bootstrap", None),
196 (Some(Mode::Rustc), "parallel_compiler", None),
197 (Some(Mode::ToolRustc), "parallel_compiler", None),
198 (Some(Mode::Std), "stdarch_intel_sde", None),
199 (Some(Mode::Std), "no_fp_fmt_parse", None),
200 (Some(Mode::Std), "no_global_oom_handling", None),
201 (Some(Mode::Std), "freebsd12", None),
202 (Some(Mode::Std), "backtrace_in_libstd", None),
203 /* Extra values not defined in the built-in targets yet, but used in std */
204 (Some(Mode::Std), "target_env", Some(&["libnx"])),
205 (Some(Mode::Std), "target_os", Some(&["watchos"])),
209 Some(&["asmjs", "spirv", "nvptx", "nvptx64", "le32", "xtensa"]),
211 /* Extra names used by dependencies */
212 // FIXME: Used by rustfmt is their test but is invalid (neither cargo nor bootstrap ever set
213 // this config) should probably by removed or use a allow attribute.
214 (Some(Mode::ToolRustc), "release", None),
215 // FIXME: Used by stdarch in their test, should use a allow attribute instead.
216 (Some(Mode::Std), "dont_compile_me", None),
217 // FIXME: Used by serde_json, but we should not be triggering on external dependencies.
218 (Some(Mode::Rustc), "no_btreemap_remove_entry", None),
219 (Some(Mode::ToolRustc), "no_btreemap_remove_entry", None),
220 // FIXME: Used by crossbeam-utils, but we should not be triggering on external dependencies.
221 (Some(Mode::Rustc), "crossbeam_loom", None),
222 (Some(Mode::ToolRustc), "crossbeam_loom", None),
223 // FIXME: Used by proc-macro2, but we should not be triggering on external dependencies.
224 (Some(Mode::Rustc), "span_locations", None),
225 (Some(Mode::ToolRustc), "span_locations", None),
228 /// A structure representing a Rust compiler.
230 /// Each compiler has a `stage` that it is associated with and a `host` that
231 /// corresponds to the platform the compiler runs on. This structure is used as
232 /// a parameter to many methods below.
233 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
234 pub struct Compiler {
236 host: TargetSelection,
239 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
241 /// Run normal tests and doc tests (default).
243 /// Do not run any doc tests.
245 /// Only run doc tests.
254 /// Global configuration for the build system.
256 /// This structure transitively contains all configuration for the build system.
257 /// All filesystem-encoded configuration is in `config`, all flags are in
258 /// `flags`, and then parsed or probed information is listed in the keys below.
260 /// This structure is a parameter of almost all methods in the build system,
261 /// although most functions are implemented as free functions rather than
262 /// methods specifically on this structure itself (to make it easier to
265 /// User-specified configuration from `config.toml`.
268 // Version information
271 // Properties derived from the above configuration
274 bootstrap_out: PathBuf,
275 rust_info: channel::GitInfo,
276 cargo_info: channel::GitInfo,
277 rls_info: channel::GitInfo,
278 rust_analyzer_info: channel::GitInfo,
279 clippy_info: channel::GitInfo,
280 miri_info: channel::GitInfo,
281 rustfmt_info: channel::GitInfo,
282 in_tree_llvm_info: channel::GitInfo,
288 // Targets for which to build
289 build: TargetSelection,
290 hosts: Vec<TargetSelection>,
291 targets: Vec<TargetSelection>,
293 // Stage 0 (downloaded) compiler, lld and cargo or their local rust equivalents
294 initial_rustc: PathBuf,
295 initial_cargo: PathBuf,
296 initial_lld: PathBuf,
297 initial_libdir: PathBuf,
299 // Runtime state filled in later on
300 // C/C++ compilers and archiver for all targets
301 cc: HashMap<TargetSelection, cc::Tool>,
302 cxx: HashMap<TargetSelection, cc::Tool>,
303 ar: HashMap<TargetSelection, PathBuf>,
304 ranlib: HashMap<TargetSelection, PathBuf>,
306 // allow bidirectional lookups: both name -> path and path -> name
307 crates: HashMap<Interned<String>, Crate>,
308 crate_paths: HashMap<PathBuf, Interned<String>>,
311 delayed_failures: RefCell<Vec<String>>,
312 prerelease_version: Cell<Option<u32>>,
314 RefCell<HashMap<TargetSelection, HashMap<String, (&'static str, PathBuf, Vec<String>)>>>,
319 name: Interned<String>,
320 deps: HashSet<Interned<String>>,
325 fn local_path(&self, build: &Build) -> PathBuf {
326 self.path.strip_prefix(&build.config.src).unwrap().into()
330 /// When building Rust various objects are handled differently.
331 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
332 pub enum DependencyType {
333 /// Libraries originating from proc-macros.
335 /// Typical Rust libraries.
337 /// Non Rust libraries and objects shipped to ease usage of certain targets.
341 /// The various "modes" of invoking Cargo.
343 /// These entries currently correspond to the various output directories of the
344 /// build system, with each mod generating output in a different directory.
345 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
347 /// Build the standard library, placing output in the "stageN-std" directory.
350 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
353 /// Build a codegen backend for rustc, placing the output in the "stageN-codegen" directory.
356 /// Build a tool, placing output in the "stage0-bootstrap-tools"
357 /// directory. This is for miscellaneous sets of tools that are built
358 /// using the bootstrap stage0 compiler in its entirety (target libraries
359 /// and all). Typically these tools compile with stable Rust.
362 /// Build a tool which uses the locally built std, placing output in the
363 /// "stageN-tools" directory. Its usage is quite rare, mainly used by
364 /// compiletest which needs libtest.
367 /// Build a tool which uses the locally built rustc and the target std,
368 /// placing the output in the "stageN-tools" directory. This is used for
369 /// anything that needs a fully functional rustc, such as rustdoc, clippy,
370 /// cargo, rls, rustfmt, miri, etc.
375 pub fn is_tool(&self) -> bool {
376 matches!(self, Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd)
379 pub fn must_support_dlopen(&self) -> bool {
380 matches!(self, Mode::Std | Mode::Codegen)
390 /// Creates a new set of build configuration from the `flags` on the command
391 /// line and the filesystem `config`.
393 /// By default all build output will be placed in the current directory.
394 pub fn new(config: Config) -> Build {
395 let src = config.src.clone();
396 let out = config.out.clone();
398 let is_sudo = match env::var_os("SUDO_USER") {
399 Some(sudo_user) => match env::var_os("USER") {
400 Some(user) => user != sudo_user,
406 let ignore_git = config.ignore_git;
407 let rust_info = channel::GitInfo::new(ignore_git, &src);
408 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
409 let rls_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rls"));
410 let rust_analyzer_info =
411 channel::GitInfo::new(ignore_git, &src.join("src/tools/rust-analyzer"));
412 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
413 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
414 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
416 // we always try to use git for LLVM builds
417 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
419 let initial_target_libdir_str = if config.dry_run {
420 "/dummy/lib/path/to/lib/".to_string()
423 Command::new(&config.initial_rustc)
425 .arg(config.build.rustc_target_arg())
427 .arg("target-libdir"),
430 let initial_target_dir = Path::new(&initial_target_libdir_str).parent().unwrap();
431 let initial_lld = initial_target_dir.join("bin").join("rust-lld");
433 let initial_sysroot = if config.dry_run {
436 output(Command::new(&config.initial_rustc).arg("--print").arg("sysroot"))
438 let initial_libdir = initial_target_dir
443 .strip_prefix(initial_sysroot.trim())
447 let version = std::fs::read_to_string(src.join("src").join("version"))
448 .expect("failed to read src/version");
449 let version = version.trim();
451 let bootstrap_out = if std::env::var("BOOTSTRAP_PYTHON").is_ok() {
452 out.join("bootstrap").join("debug")
454 let workspace_target_dir = std::env::var("CARGO_TARGET_DIR")
456 .unwrap_or_else(|_| src.join("target"));
457 let bootstrap_out = workspace_target_dir.join("debug");
458 if !bootstrap_out.join("rustc").exists() && !cfg!(test) {
459 // this restriction can be lifted whenever https://github.com/rust-lang/rfcs/pull/3028 is implemented
460 panic!("run `cargo build --bins` before `cargo run`")
465 let mut build = Build {
466 initial_rustc: config.initial_rustc.clone(),
467 initial_cargo: config.initial_cargo.clone(),
470 local_rebuild: config.local_rebuild,
471 fail_fast: config.cmd.fail_fast(),
472 doc_tests: config.cmd.doc_tests(),
473 verbosity: config.verbose,
476 hosts: config.hosts.clone(),
477 targets: config.targets.clone(),
480 version: version.to_string(),
496 ranlib: HashMap::new(),
497 crates: HashMap::new(),
498 crate_paths: HashMap::new(),
500 ci_env: CiEnv::current(),
501 delayed_failures: RefCell::new(Vec::new()),
502 prerelease_version: Cell::new(None),
503 tool_artifacts: Default::default(),
506 build.verbose("finding compilers");
507 cc_detect::find(&mut build);
508 // When running `setup`, the profile is about to change, so any requirements we have now may
509 // be different on the next invocation. Don't check for them until the next time x.py is
510 // run. This is ok because `setup` never runs any build commands, so it won't fail if commands are missing.
511 if !matches!(build.config.cmd, Subcommand::Setup { .. }) {
512 build.verbose("running sanity check");
513 sanity::check(&mut build);
516 // If local-rust is the same major.minor as the current version, then force a
518 let local_version_verbose =
519 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
520 let local_release = local_version_verbose
522 .filter_map(|x| x.strip_prefix("release:"))
526 if local_release.split('.').take(2).eq(version.split('.').take(2)) {
527 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
528 build.local_rebuild = true;
531 build.verbose("learning about cargo");
532 metadata::build(&mut build);
537 // modified from `check_submodule` and `update_submodule` in bootstrap.py
538 /// Given a path to the directory of a submodule, update it.
540 /// `relative_path` should be relative to the root of the git repository, not an absolute path.
541 pub(crate) fn update_submodule(&self, relative_path: &Path) {
542 fn dir_is_empty(dir: &Path) -> bool {
543 t!(std::fs::read_dir(dir)).next().is_none()
546 if !self.config.submodules(&self.rust_info) {
550 let absolute_path = self.config.src.join(relative_path);
552 // NOTE: The check for the empty directory is here because when running x.py the first time,
553 // the submodule won't be checked out. Check it out now so we can build it.
554 if !channel::GitInfo::new(false, &absolute_path).is_git() && !dir_is_empty(&absolute_path) {
559 let checked_out_hash =
560 output(Command::new("git").args(&["rev-parse", "HEAD"]).current_dir(&absolute_path));
562 let recorded = output(
564 .args(&["ls-tree", "HEAD"])
566 .current_dir(&self.config.src),
568 let actual_hash = recorded
571 .unwrap_or_else(|| panic!("unexpected output `{}`", recorded));
574 if actual_hash == checked_out_hash.trim_end() {
575 // already checked out
579 println!("Updating submodule {}", relative_path.display());
582 .args(&["submodule", "-q", "sync"])
584 .current_dir(&self.config.src),
587 // Try passing `--progress` to start, then run git again without if that fails.
588 let update = |progress: bool| {
589 let mut git = Command::new("git");
590 git.args(&["submodule", "update", "--init", "--recursive", "--depth=1"]);
592 git.arg("--progress");
594 git.arg(relative_path).current_dir(&self.config.src);
597 // NOTE: doesn't use `try_run` because this shouldn't print an error if it fails.
598 if !update(true).status().map_or(false, |status| status.success()) {
599 self.run(&mut update(false));
602 self.run(Command::new("git").args(&["reset", "-q", "--hard"]).current_dir(&absolute_path));
603 self.run(Command::new("git").args(&["clean", "-qdfx"]).current_dir(absolute_path));
606 /// If any submodule has been initialized already, sync it unconditionally.
607 /// This avoids contributors checking in a submodule change by accident.
608 pub fn maybe_update_submodules(&self) {
609 // WARNING: keep this in sync with the submodules hard-coded in bootstrap.py
610 let mut bootstrap_submodules: Vec<&str> = vec![
611 "src/tools/rust-installer",
618 // As in bootstrap.py, we include `rust-analyzer` if `build.vendor` was set in
620 if self.config.vendor {
621 bootstrap_submodules.push("src/tools/rust-analyzer");
623 // Avoid running git when there isn't a git checkout.
624 if !self.config.submodules(&self.rust_info) {
629 .args(&["config", "--file"])
630 .arg(&self.config.src.join(".gitmodules"))
631 .args(&["--get-regexp", "path"]),
633 for line in output.lines() {
634 // Look for `submodule.$name.path = $path`
635 // Sample output: `submodule.src/rust-installer.path src/tools/rust-installer`
636 let submodule = Path::new(line.splitn(2, ' ').nth(1).unwrap());
637 // avoid updating submodules twice
638 if !bootstrap_submodules.iter().any(|&p| Path::new(p) == submodule)
639 && channel::GitInfo::new(false, submodule).is_git()
641 self.update_submodule(submodule);
646 /// Executes the entire build, as configured by the flags and configuration.
647 pub fn build(&mut self) {
652 self.maybe_update_submodules();
654 if let Subcommand::Format { check, paths } = &self.config.cmd {
655 return format::format(self, *check, &paths);
658 if let Subcommand::Clean { all } = self.config.cmd {
659 return clean::clean(self, all);
662 if let Subcommand::Setup { profile } = &self.config.cmd {
663 return setup::setup(&self.config, *profile);
667 let builder = builder::Builder::new(&self);
668 if let Some(path) = builder.paths.get(0) {
669 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
675 if !self.config.dry_run {
677 self.config.dry_run = true;
678 let builder = builder::Builder::new(&self);
679 builder.execute_cli();
681 self.config.dry_run = false;
682 let builder = builder::Builder::new(&self);
683 builder.execute_cli();
685 let builder = builder::Builder::new(&self);
686 builder.execute_cli();
689 // Check for postponed failures from `test --no-fail-fast`.
690 let failures = self.delayed_failures.borrow();
691 if failures.len() > 0 {
692 println!("\n{} command(s) did not execute successfully:\n", failures.len());
693 for failure in failures.iter() {
694 println!(" - {}\n", failure);
700 /// Clear out `dir` if `input` is newer.
702 /// After this executes, it will also ensure that `dir` exists.
703 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
704 let stamp = dir.join(".stamp");
705 let mut cleared = false;
706 if mtime(&stamp) < mtime(input) {
707 self.verbose(&format!("Dirty - {}", dir.display()));
708 let _ = fs::remove_dir_all(dir);
710 } else if stamp.exists() {
713 t!(fs::create_dir_all(dir));
714 t!(File::create(stamp));
718 /// Gets the space-separated set of activated features for the standard
720 fn std_features(&self, target: TargetSelection) -> String {
721 let mut features = "panic-unwind".to_string();
723 match self.config.llvm_libunwind(target) {
724 LlvmLibunwind::InTree => features.push_str(" llvm-libunwind"),
725 LlvmLibunwind::System => features.push_str(" system-llvm-libunwind"),
726 LlvmLibunwind::No => {}
728 if self.config.backtrace {
729 features.push_str(" backtrace");
731 if self.config.profiler_enabled(target) {
732 features.push_str(" profiler");
737 /// Gets the space-separated set of activated features for the compiler.
738 fn rustc_features(&self, kind: Kind) -> String {
739 let mut features = vec![];
740 if self.config.jemalloc {
741 features.push("jemalloc");
743 if self.config.llvm_enabled() || kind == Kind::Check {
744 features.push("llvm");
746 // keep in sync with `bootstrap/compile.rs:rustc_cargo_env`
747 if self.config.rustc_parallel {
748 features.push("rustc_use_parallel_compiler");
751 // If debug logging is on, then we want the default for tracing:
752 // https://github.com/tokio-rs/tracing/blob/3dd5c03d907afdf2c39444a29931833335171554/tracing/src/level_filters.rs#L26
753 // which is everything (including debug/trace/etc.)
754 // if its unset, if debug_assertions is on, then debug_logging will also be on
755 // as well as tracing *ignoring* this feature when debug_assertions is on
756 if !self.config.rust_debug_logging {
757 features.push("max_level_info");
763 /// Component directory that Cargo will produce output into (e.g.
765 fn cargo_dir(&self) -> &'static str {
766 if self.config.rust_optimize { "release" } else { "debug" }
769 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
772 .join(&*compiler.host.triple)
773 .join(format!("stage{}-tools-bin", compiler.stage));
774 t!(fs::create_dir_all(&out));
778 /// Returns the root directory for all output generated in a particular
779 /// stage when running with a particular host compiler.
781 /// The mode indicates what the root directory is for.
782 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
783 let suffix = match mode {
785 Mode::Rustc => "-rustc",
786 Mode::Codegen => "-codegen",
787 Mode::ToolBootstrap => "-bootstrap-tools",
788 Mode::ToolStd | Mode::ToolRustc => "-tools",
790 self.out.join(&*compiler.host.triple).join(format!("stage{}{}", compiler.stage, suffix))
793 /// Returns the root output directory for all Cargo output in a given stage,
794 /// running a particular compiler, whether or not we're building the
795 /// standard library, and targeting the specified architecture.
796 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: TargetSelection) -> PathBuf {
797 self.stage_out(compiler, mode).join(&*target.triple).join(self.cargo_dir())
800 /// Root output directory for LLVM compiled for `target`
802 /// Note that if LLVM is configured externally then the directory returned
803 /// will likely be empty.
804 fn llvm_out(&self, target: TargetSelection) -> PathBuf {
805 self.out.join(&*target.triple).join("llvm")
808 fn lld_out(&self, target: TargetSelection) -> PathBuf {
809 self.out.join(&*target.triple).join("lld")
812 /// Output directory for all documentation for a target
813 fn doc_out(&self, target: TargetSelection) -> PathBuf {
814 self.out.join(&*target.triple).join("doc")
817 fn test_out(&self, target: TargetSelection) -> PathBuf {
818 self.out.join(&*target.triple).join("test")
821 /// Output directory for all documentation for a target
822 fn compiler_doc_out(&self, target: TargetSelection) -> PathBuf {
823 self.out.join(&*target.triple).join("compiler-doc")
826 /// Output directory for some generated md crate documentation for a target (temporary)
827 fn md_doc_out(&self, target: TargetSelection) -> Interned<PathBuf> {
828 INTERNER.intern_path(self.out.join(&*target.triple).join("md-doc"))
831 /// Returns `true` if no custom `llvm-config` is set for the specified target.
833 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
834 fn is_rust_llvm(&self, target: TargetSelection) -> bool {
835 if self.config.llvm_from_ci && target == self.config.build {
839 match self.config.target_config.get(&target) {
840 Some(ref c) => c.llvm_config.is_none(),
845 /// Returns the path to `FileCheck` binary for the specified target
846 fn llvm_filecheck(&self, target: TargetSelection) -> PathBuf {
847 let target_config = self.config.target_config.get(&target);
848 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
850 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
851 let llvm_bindir = output(Command::new(s).arg("--bindir"));
852 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", target));
853 if filecheck.exists() {
856 // On Fedora the system LLVM installs FileCheck in the
857 // llvm subdirectory of the libdir.
858 let llvm_libdir = output(Command::new(s).arg("--libdir"));
860 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", target));
861 if lib_filecheck.exists() {
864 // Return the most normal file name, even though
865 // it doesn't exist, so that any error message
871 let base = self.llvm_out(target).join("build");
872 let base = if !self.ninja() && target.contains("msvc") {
873 if self.config.llvm_optimize {
874 if self.config.llvm_release_debuginfo {
875 base.join("RelWithDebInfo")
885 base.join("bin").join(exe("FileCheck", target))
889 /// Directory for libraries built from C/C++ code and shared between stages.
890 fn native_dir(&self, target: TargetSelection) -> PathBuf {
891 self.out.join(&*target.triple).join("native")
894 /// Root output directory for rust_test_helpers library compiled for
896 fn test_helpers_out(&self, target: TargetSelection) -> PathBuf {
897 self.native_dir(target).join("rust-test-helpers")
900 /// Adds the `RUST_TEST_THREADS` env var if necessary
901 fn add_rust_test_threads(&self, cmd: &mut Command) {
902 if env::var_os("RUST_TEST_THREADS").is_none() {
903 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
907 /// Returns the libdir of the snapshot compiler.
908 fn rustc_snapshot_libdir(&self) -> PathBuf {
909 self.rustc_snapshot_sysroot().join(libdir(self.config.build))
912 /// Returns the sysroot of the snapshot compiler.
913 fn rustc_snapshot_sysroot(&self) -> &Path {
914 static SYSROOT_CACHE: OnceCell<PathBuf> = once_cell::sync::OnceCell::new();
915 SYSROOT_CACHE.get_or_init(|| {
916 let mut rustc = Command::new(&self.initial_rustc);
917 rustc.args(&["--print", "sysroot"]);
918 output(&mut rustc).trim().into()
922 /// Runs a command, printing out nice contextual information if it fails.
923 fn run(&self, cmd: &mut Command) {
924 if self.config.dry_run {
927 self.verbose(&format!("running: {:?}", cmd));
928 run(cmd, self.is_verbose())
931 /// Runs a command, printing out nice contextual information if it fails.
932 fn run_quiet(&self, cmd: &mut Command) {
933 if self.config.dry_run {
936 self.verbose(&format!("running: {:?}", cmd));
940 /// Runs a command, printing out nice contextual information if it fails.
941 /// Exits if the command failed to execute at all, otherwise returns its
942 /// `status.success()`.
943 fn try_run(&self, cmd: &mut Command) -> bool {
944 if self.config.dry_run {
947 self.verbose(&format!("running: {:?}", cmd));
948 try_run(cmd, self.is_verbose())
951 /// Runs a command, printing out nice contextual information if it fails.
952 /// Exits if the command failed to execute at all, otherwise returns its
953 /// `status.success()`.
954 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
955 if self.config.dry_run {
958 self.verbose(&format!("running: {:?}", cmd));
959 try_run_suppressed(cmd)
962 /// Runs a command, printing out nice contextual information if it fails.
963 /// Returns false if do not execute at all, otherwise returns its
964 /// `status.success()`.
965 fn check_run(&self, cmd: &mut Command) -> bool {
966 if self.config.dry_run {
969 self.verbose(&format!("running: {:?}", cmd));
970 check_run(cmd, self.is_verbose())
973 pub fn is_verbose(&self) -> bool {
977 /// Prints a message if this build is configured in verbose mode.
978 fn verbose(&self, msg: &str) {
979 if self.is_verbose() {
984 pub fn is_verbose_than(&self, level: usize) -> bool {
985 self.verbosity > level
988 /// Prints a message if this build is configured in more verbose mode than `level`.
989 fn verbose_than(&self, level: usize, msg: &str) {
990 if self.is_verbose_than(level) {
995 fn info(&self, msg: &str) {
996 if self.config.dry_run {
1002 /// Returns the number of parallel jobs that have been configured for this
1004 fn jobs(&self) -> u32 {
1005 self.config.jobs.unwrap_or_else(|| {
1006 std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get) as u32
1010 fn debuginfo_map_to(&self, which: GitRepo) -> Option<String> {
1011 if !self.config.rust_remap_debuginfo {
1017 let sha = self.rust_sha().unwrap_or(&self.version);
1018 Some(format!("/rustc/{}", sha))
1020 GitRepo::Llvm => Some(String::from("/rustc/llvm")),
1024 /// Returns the path to the C compiler for the target specified.
1025 fn cc(&self, target: TargetSelection) -> &Path {
1026 self.cc[&target].path()
1029 /// Returns a list of flags to pass to the C compiler for the target
1031 fn cflags(&self, target: TargetSelection, which: GitRepo, c: CLang) -> Vec<String> {
1032 let base = match c {
1033 CLang::C => &self.cc[&target],
1034 CLang::Cxx => &self.cxx[&target],
1037 // Filter out -O and /O (the optimization flags) that we picked up from
1038 // cc-rs because the build scripts will determine that for themselves.
1042 .map(|s| s.to_string_lossy().into_owned())
1043 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
1044 .collect::<Vec<String>>();
1046 // If we're compiling on macOS then we add a few unconditional flags
1047 // indicating that we want libc++ (more filled out than libstdc++) and
1048 // we want to compile for 10.7. This way we can ensure that
1049 // LLVM/etc are all properly compiled.
1050 if target.contains("apple-darwin") {
1051 base.push("-stdlib=libc++".into());
1054 // Work around an apparently bad MinGW / GCC optimization,
1055 // See: https://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
1056 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
1057 if &*target.triple == "i686-pc-windows-gnu" {
1058 base.push("-fno-omit-frame-pointer".into());
1061 if let Some(map_to) = self.debuginfo_map_to(which) {
1062 let map = format!("{}={}", self.src.display(), map_to);
1063 let cc = self.cc(target);
1064 if cc.ends_with("clang") || cc.ends_with("gcc") {
1065 base.push(format!("-fdebug-prefix-map={}", map));
1066 } else if cc.ends_with("clang-cl.exe") {
1067 base.push("-Xclang".into());
1068 base.push(format!("-fdebug-prefix-map={}", map));
1074 /// Returns the path to the `ar` archive utility for the target specified.
1075 fn ar(&self, target: TargetSelection) -> Option<&Path> {
1076 self.ar.get(&target).map(|p| &**p)
1079 /// Returns the path to the `ranlib` utility for the target specified.
1080 fn ranlib(&self, target: TargetSelection) -> Option<&Path> {
1081 self.ranlib.get(&target).map(|p| &**p)
1084 /// Returns the path to the C++ compiler for the target specified.
1085 fn cxx(&self, target: TargetSelection) -> Result<&Path, String> {
1086 match self.cxx.get(&target) {
1087 Some(p) => Ok(p.path()),
1089 Err(format!("target `{}` is not configured as a host, only as a target", target))
1094 /// Returns the path to the linker for the given target if it needs to be overridden.
1095 fn linker(&self, target: TargetSelection) -> Option<&Path> {
1096 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
1099 } else if target.contains("vxworks") {
1100 // need to use CXX compiler as linker to resolve the exception functions
1101 // that are only existed in CXX libraries
1102 Some(self.cxx[&target].path())
1103 } else if target != self.config.build
1104 && util::use_host_linker(target)
1105 && !target.contains("msvc")
1107 Some(self.cc(target))
1108 } else if self.config.use_lld && !self.is_fuse_ld_lld(target) && self.build == target {
1109 Some(&self.initial_lld)
1115 // LLD is used through `-fuse-ld=lld` rather than directly.
1116 // Only MSVC targets use LLD directly at the moment.
1117 fn is_fuse_ld_lld(&self, target: TargetSelection) -> bool {
1118 self.config.use_lld && !target.contains("msvc")
1121 fn lld_flags(&self, target: TargetSelection) -> impl Iterator<Item = String> {
1122 let mut options = [None, None];
1124 if self.config.use_lld {
1125 if self.is_fuse_ld_lld(target) {
1126 options[0] = Some("-Clink-arg=-fuse-ld=lld".to_string());
1129 let threads = if target.contains("windows") { "/threads:1" } else { "--threads=1" };
1130 options[1] = Some(format!("-Clink-arg=-Wl,{}", threads));
1133 IntoIterator::into_iter(options).flatten()
1136 /// Returns if this target should statically link the C runtime, if specified
1137 fn crt_static(&self, target: TargetSelection) -> Option<bool> {
1138 if target.contains("pc-windows-msvc") {
1141 self.config.target_config.get(&target).and_then(|t| t.crt_static)
1145 /// Returns the "musl root" for this `target`, if defined
1146 fn musl_root(&self, target: TargetSelection) -> Option<&Path> {
1150 .and_then(|t| t.musl_root.as_ref())
1151 .or_else(|| self.config.musl_root.as_ref())
1155 /// Returns the "musl libdir" for this `target`.
1156 fn musl_libdir(&self, target: TargetSelection) -> Option<PathBuf> {
1157 let t = self.config.target_config.get(&target)?;
1158 if let libdir @ Some(_) = &t.musl_libdir {
1159 return libdir.clone();
1161 self.musl_root(target).map(|root| root.join("lib"))
1164 /// Returns the sysroot for the wasi target, if defined
1165 fn wasi_root(&self, target: TargetSelection) -> Option<&Path> {
1166 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
1169 /// Returns `true` if this is a no-std `target`, if defined
1170 fn no_std(&self, target: TargetSelection) -> Option<bool> {
1171 self.config.target_config.get(&target).map(|t| t.no_std)
1174 /// Returns `true` if the target will be tested using the `remote-test-client`
1175 /// and `remote-test-server` binaries.
1176 fn remote_tested(&self, target: TargetSelection) -> bool {
1177 self.qemu_rootfs(target).is_some()
1178 || target.contains("android")
1179 || env::var_os("TEST_DEVICE_ADDR").is_some()
1182 /// Returns the root of the "rootfs" image that this target will be using,
1183 /// if one was configured.
1185 /// If `Some` is returned then that means that tests for this target are
1186 /// emulated with QEMU and binaries will need to be shipped to the emulator.
1187 fn qemu_rootfs(&self, target: TargetSelection) -> Option<&Path> {
1188 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
1191 /// Path to the python interpreter to use
1192 fn python(&self) -> &Path {
1193 if self.config.build.ends_with("apple-darwin") {
1194 // Force /usr/bin/python3 on macOS for LLDB tests because we're loading the
1195 // LLDB plugin's compiled module which only works with the system python
1196 // (namely not Homebrew-installed python)
1197 Path::new("/usr/bin/python3")
1202 .expect("python is required for running LLDB or rustdoc tests")
1206 /// Temporary directory that extended error information is emitted to.
1207 fn extended_error_dir(&self) -> PathBuf {
1208 self.out.join("tmp/extended-error-metadata")
1211 /// Tests whether the `compiler` compiling for `target` should be forced to
1212 /// use a stage1 compiler instead.
1214 /// Currently, by default, the build system does not perform a "full
1215 /// bootstrap" by default where we compile the compiler three times.
1216 /// Instead, we compile the compiler two times. The final stage (stage2)
1217 /// just copies the libraries from the previous stage, which is what this
1220 /// Here we return `true` if:
1222 /// * The build isn't performing a full bootstrap
1223 /// * The `compiler` is in the final stage, 2
1224 /// * We're not cross-compiling, so the artifacts are already available in
1227 /// When all of these conditions are met the build will lift artifacts from
1228 /// the previous stage forward.
1229 fn force_use_stage1(&self, compiler: Compiler, target: TargetSelection) -> bool {
1230 !self.config.full_bootstrap
1231 && compiler.stage >= 2
1232 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
1235 /// Given `num` in the form "a.b.c" return a "release string" which
1236 /// describes the release version number.
1238 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
1239 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
1240 fn release(&self, num: &str) -> String {
1241 match &self.config.channel[..] {
1242 "stable" => num.to_string(),
1244 if self.rust_info.is_git() && !self.config.ignore_git {
1245 format!("{}-beta.{}", num, self.beta_prerelease_version())
1247 format!("{}-beta", num)
1250 "nightly" => format!("{}-nightly", num),
1251 _ => format!("{}-dev", num),
1255 fn beta_prerelease_version(&self) -> u32 {
1256 if let Some(s) = self.prerelease_version.get() {
1260 // Figure out how many merge commits happened since we branched off master.
1261 // That's our beta number!
1262 // (Note that we use a `..` range, not the `...` symmetric difference.)
1268 .arg("refs/remotes/origin/master..HEAD")
1269 .current_dir(&self.src),
1271 let n = count.trim().parse().unwrap();
1272 self.prerelease_version.set(Some(n));
1276 /// Returns the value of `release` above for Rust itself.
1277 fn rust_release(&self) -> String {
1278 self.release(&self.version)
1281 /// Returns the "package version" for a component given the `num` release
1284 /// The package version is typically what shows up in the names of tarballs.
1285 /// For channels like beta/nightly it's just the channel name, otherwise
1286 /// it's the `num` provided.
1287 fn package_vers(&self, num: &str) -> String {
1288 match &self.config.channel[..] {
1289 "stable" => num.to_string(),
1290 "beta" => "beta".to_string(),
1291 "nightly" => "nightly".to_string(),
1292 _ => format!("{}-dev", num),
1296 /// Returns the value of `package_vers` above for Rust itself.
1297 fn rust_package_vers(&self) -> String {
1298 self.package_vers(&self.version)
1301 fn llvm_link_tools_dynamically(&self, target: TargetSelection) -> bool {
1302 target.contains("linux-gnu") || target.contains("apple-darwin")
1305 /// Returns the `version` string associated with this compiler for Rust
1308 /// Note that this is a descriptive string which includes the commit date,
1309 /// sha, version, etc.
1310 fn rust_version(&self) -> String {
1311 let mut version = self.rust_info.version(self, &self.version);
1312 if let Some(ref s) = self.config.description {
1313 version.push_str(" (");
1314 version.push_str(s);
1320 /// Returns the full commit hash.
1321 fn rust_sha(&self) -> Option<&str> {
1322 self.rust_info.sha()
1325 /// Returns the `a.b.c` version that the given package is at.
1326 fn release_num(&self, package: &str) -> String {
1327 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1328 let toml = t!(fs::read_to_string(&toml_file_name));
1329 for line in toml.lines() {
1330 if let Some(stripped) =
1331 line.strip_prefix("version = \"").and_then(|s| s.strip_suffix("\""))
1333 return stripped.to_owned();
1337 panic!("failed to find version in {}'s Cargo.toml", package)
1340 /// Returns `true` if unstable features should be enabled for the compiler
1342 fn unstable_features(&self) -> bool {
1343 match &self.config.channel[..] {
1344 "stable" | "beta" => false,
1345 "nightly" | _ => true,
1349 /// Returns a Vec of all the dependencies of the given root crate,
1350 /// including transitive dependencies and the root itself. Only includes
1351 /// "local" crates (those in the local source tree, not from a registry).
1352 fn in_tree_crates(&self, root: &str, target: Option<TargetSelection>) -> Vec<&Crate> {
1353 let mut ret = Vec::new();
1354 let mut list = vec![INTERNER.intern_str(root)];
1355 let mut visited = HashSet::new();
1356 while let Some(krate) = list.pop() {
1357 let krate = &self.crates[&krate];
1359 for dep in &krate.deps {
1360 if !self.crates.contains_key(dep) {
1361 // Ignore non-workspace members.
1364 // Don't include optional deps if their features are not
1365 // enabled. Ideally this would be computed from `cargo
1366 // metadata --features …`, but that is somewhat slow. In
1367 // the future, we may want to consider just filtering all
1368 // build and dev dependencies in metadata::build.
1369 if visited.insert(dep)
1370 && (dep != "profiler_builtins"
1372 .map(|t| self.config.profiler_enabled(t))
1373 .unwrap_or_else(|| self.config.any_profiler_enabled()))
1374 && (dep != "rustc_codegen_llvm" || self.config.llvm_enabled())
1383 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, DependencyType)> {
1384 if self.config.dry_run {
1388 let mut paths = Vec::new();
1389 let contents = t!(fs::read(stamp), &stamp);
1390 // This is the method we use for extracting paths from the stamp file passed to us. See
1391 // run_cargo for more information (in compile.rs).
1392 for part in contents.split(|b| *b == 0) {
1393 if part.is_empty() {
1396 let dependency_type = match part[0] as char {
1397 'h' => DependencyType::Host,
1398 's' => DependencyType::TargetSelfContained,
1399 't' => DependencyType::Target,
1400 _ => unreachable!(),
1402 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1403 paths.push((path, dependency_type));
1408 /// Create a temporary directory in `out` and return its path.
1410 /// NOTE: this temporary directory is shared between all steps;
1411 /// if you need an empty directory, create a new subdirectory inside it.
1412 fn tempdir(&self) -> PathBuf {
1413 let tmp = self.out.join("tmp");
1414 t!(fs::create_dir_all(&tmp));
1418 /// Copies a file from `src` to `dst`
1419 pub fn copy(&self, src: &Path, dst: &Path) {
1420 if self.config.dry_run {
1423 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1427 let _ = fs::remove_file(&dst);
1428 let metadata = t!(src.symlink_metadata());
1429 if metadata.file_type().is_symlink() {
1430 let link = t!(fs::read_link(src));
1431 t!(symlink_file(link, dst));
1432 } else if let Ok(()) = fs::hard_link(src, dst) {
1433 // Attempt to "easy copy" by creating a hard link
1434 // (symlinks don't work on windows), but if that fails
1435 // just fall back to a slow `copy` operation.
1437 if let Err(e) = fs::copy(src, dst) {
1438 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1440 t!(fs::set_permissions(dst, metadata.permissions()));
1441 let atime = FileTime::from_last_access_time(&metadata);
1442 let mtime = FileTime::from_last_modification_time(&metadata);
1443 t!(filetime::set_file_times(dst, atime, mtime));
1447 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1448 /// when this function is called.
1449 pub fn cp_r(&self, src: &Path, dst: &Path) {
1450 if self.config.dry_run {
1453 for f in self.read_dir(src) {
1454 let path = f.path();
1455 let name = path.file_name().unwrap();
1456 let dst = dst.join(name);
1457 if t!(f.file_type()).is_dir() {
1458 t!(fs::create_dir_all(&dst));
1459 self.cp_r(&path, &dst);
1461 let _ = fs::remove_file(&dst);
1462 self.copy(&path, &dst);
1467 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1468 /// when this function is called. Unwanted files or directories can be skipped
1469 /// by returning `false` from the filter function.
1470 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1471 // Immediately recurse with an empty relative path
1472 self.recurse_(src, dst, Path::new(""), filter)
1475 // Inner function does the actual work
1476 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1477 for f in self.read_dir(src) {
1478 let path = f.path();
1479 let name = path.file_name().unwrap();
1480 let dst = dst.join(name);
1481 let relative = relative.join(name);
1482 // Only copy file or directory if the filter function returns true
1483 if filter(&relative) {
1484 if t!(f.file_type()).is_dir() {
1485 let _ = fs::remove_dir_all(&dst);
1486 self.create_dir(&dst);
1487 self.recurse_(&path, &dst, &relative, filter);
1489 let _ = fs::remove_file(&dst);
1490 self.copy(&path, &dst);
1496 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1497 let file_name = src.file_name().unwrap();
1498 let dest = dest_folder.join(file_name);
1499 self.copy(src, &dest);
1502 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1503 if self.config.dry_run {
1506 let dst = dstdir.join(src.file_name().unwrap());
1507 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1508 t!(fs::create_dir_all(dstdir));
1509 drop(fs::remove_file(&dst));
1512 panic!("Error: File \"{}\" not found!", src.display());
1514 let metadata = t!(src.symlink_metadata());
1515 if let Err(e) = fs::copy(&src, &dst) {
1516 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1518 t!(fs::set_permissions(&dst, metadata.permissions()));
1519 let atime = FileTime::from_last_access_time(&metadata);
1520 let mtime = FileTime::from_last_modification_time(&metadata);
1521 t!(filetime::set_file_times(&dst, atime, mtime));
1526 fn create(&self, path: &Path, s: &str) {
1527 if self.config.dry_run {
1530 t!(fs::write(path, s));
1533 fn read(&self, path: &Path) -> String {
1534 if self.config.dry_run {
1535 return String::new();
1537 t!(fs::read_to_string(path))
1540 fn create_dir(&self, dir: &Path) {
1541 if self.config.dry_run {
1544 t!(fs::create_dir_all(dir))
1547 fn remove_dir(&self, dir: &Path) {
1548 if self.config.dry_run {
1551 t!(fs::remove_dir_all(dir))
1554 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1555 let iter = match fs::read_dir(dir) {
1557 Err(_) if self.config.dry_run => return vec![].into_iter(),
1558 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1560 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1563 fn remove(&self, f: &Path) {
1564 if self.config.dry_run {
1567 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1570 /// Returns if config.ninja is enabled, and checks for ninja existence,
1571 /// exiting with a nicer error message if not.
1572 fn ninja(&self) -> bool {
1573 let mut cmd_finder = crate::sanity::Finder::new();
1575 if self.config.ninja_in_file {
1576 // Some Linux distros rename `ninja` to `ninja-build`.
1577 // CMake can work with either binary name.
1578 if cmd_finder.maybe_have("ninja-build").is_none()
1579 && cmd_finder.maybe_have("ninja").is_none()
1583 Couldn't find required command: ninja (or ninja-build)
1585 You should install ninja as described at
1586 <https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages>,
1587 or set `ninja = false` in the `[llvm]` section of `config.toml`.
1588 Alternatively, set `download-ci-llvm = true` in that `[llvm]` section
1589 to download LLVM rather than building it.
1592 std::process::exit(1);
1596 // If ninja isn't enabled but we're building for MSVC then we try
1597 // doubly hard to enable it. It was realized in #43767 that the msbuild
1598 // CMake generator for MSVC doesn't respect configuration options like
1599 // disabling LLVM assertions, which can often be quite important!
1601 // In these cases we automatically enable Ninja if we find it in the
1603 if !self.config.ninja_in_file && self.config.build.contains("msvc") {
1604 if cmd_finder.maybe_have("ninja").is_some() {
1609 self.config.ninja_in_file
1614 fn chmod(path: &Path, perms: u32) {
1615 use std::os::unix::fs::*;
1616 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1619 fn chmod(_path: &Path, _perms: u32) {}
1622 pub fn with_stage(mut self, stage: u32) -> Compiler {
1627 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1628 pub fn is_snapshot(&self, build: &Build) -> bool {
1629 self.stage == 0 && self.host == build.build
1632 /// Returns if this compiler should be treated as a final stage one in the
1633 /// current build session.
1634 /// This takes into account whether we're performing a full bootstrap or
1635 /// not; don't directly compare the stage with `2`!
1636 pub fn is_final_stage(&self, build: &Build) -> bool {
1637 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1638 self.stage >= final_stage
1642 fn envify(s: &str) -> String {
1648 .flat_map(|c| c.to_uppercase())