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.txt`, 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, OpenOptions};
110 use std::io::{Read, Seek, SeekFrom, Write};
111 use std::path::{Path, PathBuf};
112 use std::process::{self, Command};
117 use std::os::unix::fs::symlink as symlink_file;
119 use std::os::windows::fs::symlink_file;
121 use build_helper::{mtime, output, run, run_suppressed, t, try_run, try_run_suppressed};
122 use filetime::FileTime;
124 use crate::config::{LlvmLibunwind, TargetSelection};
125 use crate::util::{exe, libdir, CiEnv};
154 #[cfg(all(unix, not(target_os = "haiku")))]
156 pub unsafe fn setup(build: &mut crate::Build) {
157 if build.config.low_priority {
158 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
163 #[cfg(any(target_os = "haiku", target_os = "hermit", not(any(unix, windows))))]
165 pub unsafe fn setup(_build: &mut crate::Build) {}
168 use crate::cache::{Interned, INTERNER};
169 pub use crate::config::Config;
170 pub use crate::flags::Subcommand;
172 const LLVM_TOOLS: &[&str] = &[
173 "llvm-cov", // used to generate coverage report
174 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
175 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
176 "llvm-objdump", // used to disassemble programs
177 "llvm-profdata", // used to inspect and merge files generated by profiles
178 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
179 "llvm-size", // used to prints the size of the linker sections of a program
180 "llvm-strip", // used to discard symbols from binary files to reduce their size
181 "llvm-ar", // used for creating and modifying archive files
182 "llvm-as", // used to convert LLVM assembly to LLVM bitcode
183 "llvm-dis", // used to disassemble LLVM bitcode
184 "llc", // used to compile LLVM bytecode
185 "opt", // used to optimize LLVM bytecode
188 pub const VERSION: usize = 2;
190 /// A structure representing a Rust compiler.
192 /// Each compiler has a `stage` that it is associated with and a `host` that
193 /// corresponds to the platform the compiler runs on. This structure is used as
194 /// a parameter to many methods below.
195 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
196 pub struct Compiler {
198 host: TargetSelection,
201 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
203 /// Run normal tests and doc tests (default).
205 /// Do not run any doc tests.
207 /// Only run doc tests.
216 /// Global configuration for the build system.
218 /// This structure transitively contains all configuration for the build system.
219 /// All filesystem-encoded configuration is in `config`, all flags are in
220 /// `flags`, and then parsed or probed information is listed in the keys below.
222 /// This structure is a parameter of almost all methods in the build system,
223 /// although most functions are implemented as free functions rather than
224 /// methods specifically on this structure itself (to make it easier to
227 /// User-specified configuration from `config.toml`.
230 // Version information
233 // Properties derived from the above configuration
236 rust_info: channel::GitInfo,
237 cargo_info: channel::GitInfo,
238 rls_info: channel::GitInfo,
239 rust_analyzer_info: channel::GitInfo,
240 clippy_info: channel::GitInfo,
241 miri_info: channel::GitInfo,
242 rustfmt_info: channel::GitInfo,
243 in_tree_llvm_info: channel::GitInfo,
249 // Targets for which to build
250 build: TargetSelection,
251 hosts: Vec<TargetSelection>,
252 targets: Vec<TargetSelection>,
254 // Stage 0 (downloaded) compiler, lld and cargo or their local rust equivalents
255 initial_rustc: PathBuf,
256 initial_cargo: PathBuf,
257 initial_lld: PathBuf,
258 initial_libdir: PathBuf,
260 // Runtime state filled in later on
261 // C/C++ compilers and archiver for all targets
262 cc: HashMap<TargetSelection, cc::Tool>,
263 cxx: HashMap<TargetSelection, cc::Tool>,
264 ar: HashMap<TargetSelection, PathBuf>,
265 ranlib: HashMap<TargetSelection, PathBuf>,
267 crates: HashMap<Interned<String>, Crate>,
270 delayed_failures: RefCell<Vec<String>>,
271 prerelease_version: Cell<Option<u32>>,
273 RefCell<HashMap<TargetSelection, HashMap<String, (&'static str, PathBuf, Vec<String>)>>>,
278 name: Interned<String>,
279 deps: HashSet<Interned<String>>,
285 fn local_path(&self, build: &Build) -> PathBuf {
286 self.path.strip_prefix(&build.config.src).unwrap().into()
290 /// When building Rust various objects are handled differently.
291 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
292 pub enum DependencyType {
293 /// Libraries originating from proc-macros.
295 /// Typical Rust libraries.
297 /// Non Rust libraries and objects shipped to ease usage of certain targets.
301 /// The various "modes" of invoking Cargo.
303 /// These entries currently correspond to the various output directories of the
304 /// build system, with each mod generating output in a different directory.
305 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
307 /// Build the standard library, placing output in the "stageN-std" directory.
310 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
313 /// Build a codegen backend for rustc, placing the output in the "stageN-codegen" directory.
316 /// Build a tool, placing output in the "stage0-bootstrap-tools"
317 /// directory. This is for miscellaneous sets of tools that are built
318 /// using the bootstrap stage0 compiler in its entirety (target libraries
319 /// and all). Typically these tools compile with stable Rust.
322 /// Build a tool which uses the locally built std, placing output in the
323 /// "stageN-tools" directory. Its usage is quite rare, mainly used by
324 /// compiletest which needs libtest.
327 /// Build a tool which uses the locally built rustc and the target std,
328 /// placing the output in the "stageN-tools" directory. This is used for
329 /// anything that needs a fully functional rustc, such as rustdoc, clippy,
330 /// cargo, rls, rustfmt, miri, etc.
335 pub fn is_tool(&self) -> bool {
336 matches!(self, Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd)
339 pub fn must_support_dlopen(&self) -> bool {
340 matches!(self, Mode::Std | Mode::Codegen)
345 /// Creates a new set of build configuration from the `flags` on the command
346 /// line and the filesystem `config`.
348 /// By default all build output will be placed in the current directory.
349 pub fn new(config: Config) -> Build {
350 let src = config.src.clone();
351 let out = config.out.clone();
353 let is_sudo = match env::var_os("SUDO_USER") {
354 Some(sudo_user) => match env::var_os("USER") {
355 Some(user) => user != sudo_user,
361 let ignore_git = config.ignore_git;
362 let rust_info = channel::GitInfo::new(ignore_git, &src);
363 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
364 let rls_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rls"));
365 let rust_analyzer_info =
366 channel::GitInfo::new(ignore_git, &src.join("src/tools/rust-analyzer"));
367 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
368 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
369 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
371 // we always try to use git for LLVM builds
372 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
374 let initial_target_libdir_str = if config.dry_run {
375 "/dummy/lib/path/to/lib/".to_string()
378 Command::new(&config.initial_rustc)
380 .arg(config.build.rustc_target_arg())
382 .arg("target-libdir"),
385 let initial_target_dir = Path::new(&initial_target_libdir_str).parent().unwrap();
386 let initial_lld = initial_target_dir.join("bin").join("rust-lld");
388 let initial_sysroot = if config.dry_run {
391 output(Command::new(&config.initial_rustc).arg("--print").arg("sysroot"))
393 let initial_libdir = initial_target_dir
398 .strip_prefix(initial_sysroot.trim())
402 let version = std::fs::read_to_string(src.join("src").join("version"))
403 .expect("failed to read src/version");
404 let version = version.trim();
406 let mut build = Build {
407 initial_rustc: config.initial_rustc.clone(),
408 initial_cargo: config.initial_cargo.clone(),
411 local_rebuild: config.local_rebuild,
412 fail_fast: config.cmd.fail_fast(),
413 doc_tests: config.cmd.doc_tests(),
414 verbosity: config.verbose,
417 hosts: config.hosts.clone(),
418 targets: config.targets.clone(),
421 version: version.to_string(),
436 ranlib: HashMap::new(),
437 crates: HashMap::new(),
439 ci_env: CiEnv::current(),
440 delayed_failures: RefCell::new(Vec::new()),
441 prerelease_version: Cell::new(None),
442 tool_artifacts: Default::default(),
445 build.verbose("finding compilers");
446 cc_detect::find(&mut build);
447 // When running `setup`, the profile is about to change, so any requirements we have now may
448 // be different on the next invocation. Don't check for them until the next time x.py is
449 // run. This is ok because `setup` never runs any build commands, so it won't fail if commands are missing.
450 if !matches!(build.config.cmd, Subcommand::Setup { .. }) {
451 build.verbose("running sanity check");
452 sanity::check(&mut build);
455 // If local-rust is the same major.minor as the current version, then force a
457 let local_version_verbose =
458 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
459 let local_release = local_version_verbose
461 .filter_map(|x| x.strip_prefix("release:"))
465 if local_release.split('.').take(2).eq(version.split('.').take(2)) {
466 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
467 build.local_rebuild = true;
470 build.verbose("learning about cargo");
471 metadata::build(&mut build);
476 pub fn build_triple(&self) -> &[Interned<String>] {
477 slice::from_ref(&self.build.triple)
480 /// Executes the entire build, as configured by the flags and configuration.
481 pub fn build(&mut self) {
486 // If the LLVM submodule has been initialized already, sync it unconditionally. This avoids
487 // contributors checking in a submodule change by accident.
488 if self.in_tree_llvm_info.is_git() {
489 native::update_llvm_submodule(self);
492 if let Subcommand::Format { check, paths } = &self.config.cmd {
493 return format::format(self, *check, &paths);
496 if let Subcommand::Clean { all } = self.config.cmd {
497 return clean::clean(self, all);
500 if let Subcommand::Setup { profile } = &self.config.cmd {
501 return setup::setup(&self.config.src, *profile);
505 let builder = builder::Builder::new(&self);
506 if let Some(path) = builder.paths.get(0) {
507 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
513 if !self.config.dry_run {
515 self.config.dry_run = true;
516 let builder = builder::Builder::new(&self);
517 builder.execute_cli();
519 self.config.dry_run = false;
520 let builder = builder::Builder::new(&self);
521 builder.execute_cli();
523 let builder = builder::Builder::new(&self);
524 builder.execute_cli();
527 // Check for postponed failures from `test --no-fail-fast`.
528 let failures = self.delayed_failures.borrow();
529 if failures.len() > 0 {
530 println!("\n{} command(s) did not execute successfully:\n", failures.len());
531 for failure in failures.iter() {
532 println!(" - {}\n", failure);
538 /// Clear out `dir` if `input` is newer.
540 /// After this executes, it will also ensure that `dir` exists.
541 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
542 let stamp = dir.join(".stamp");
543 let mut cleared = false;
544 if mtime(&stamp) < mtime(input) {
545 self.verbose(&format!("Dirty - {}", dir.display()));
546 let _ = fs::remove_dir_all(dir);
548 } else if stamp.exists() {
551 t!(fs::create_dir_all(dir));
552 t!(File::create(stamp));
556 /// Gets the space-separated set of activated features for the standard
558 fn std_features(&self, target: TargetSelection) -> String {
559 let mut features = "panic-unwind".to_string();
561 match self.config.llvm_libunwind {
562 LlvmLibunwind::InTree => features.push_str(" llvm-libunwind"),
563 LlvmLibunwind::System => features.push_str(" system-llvm-libunwind"),
564 LlvmLibunwind::No => {}
566 if self.config.backtrace {
567 features.push_str(" backtrace");
569 if self.config.profiler_enabled(target) {
570 features.push_str(" profiler");
575 /// Gets the space-separated set of activated features for the compiler.
576 fn rustc_features(&self) -> String {
577 let mut features = String::new();
578 if self.config.jemalloc {
579 features.push_str("jemalloc");
581 if self.config.llvm_enabled() {
582 features.push_str(" llvm");
585 // If debug logging is on, then we want the default for tracing:
586 // https://github.com/tokio-rs/tracing/blob/3dd5c03d907afdf2c39444a29931833335171554/tracing/src/level_filters.rs#L26
587 // which is everything (including debug/trace/etc.)
588 // if its unset, if debug_assertions is on, then debug_logging will also be on
589 // as well as tracing *ignoring* this feature when debug_assertions is on
590 if !self.config.rust_debug_logging {
591 features.push_str(" max_level_info");
597 /// Component directory that Cargo will produce output into (e.g.
599 fn cargo_dir(&self) -> &'static str {
600 if self.config.rust_optimize { "release" } else { "debug" }
603 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
606 .join(&*compiler.host.triple)
607 .join(format!("stage{}-tools-bin", compiler.stage));
608 t!(fs::create_dir_all(&out));
612 /// Returns the root directory for all output generated in a particular
613 /// stage when running with a particular host compiler.
615 /// The mode indicates what the root directory is for.
616 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
617 let suffix = match mode {
619 Mode::Rustc => "-rustc",
620 Mode::Codegen => "-codegen",
621 Mode::ToolBootstrap => "-bootstrap-tools",
622 Mode::ToolStd | Mode::ToolRustc => "-tools",
624 self.out.join(&*compiler.host.triple).join(format!("stage{}{}", compiler.stage, suffix))
627 /// Returns the root output directory for all Cargo output in a given stage,
628 /// running a particular compiler, whether or not we're building the
629 /// standard library, and targeting the specified architecture.
630 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: TargetSelection) -> PathBuf {
631 self.stage_out(compiler, mode).join(&*target.triple).join(self.cargo_dir())
634 /// Root output directory for LLVM compiled for `target`
636 /// Note that if LLVM is configured externally then the directory returned
637 /// will likely be empty.
638 fn llvm_out(&self, target: TargetSelection) -> PathBuf {
639 self.out.join(&*target.triple).join("llvm")
642 fn lld_out(&self, target: TargetSelection) -> PathBuf {
643 self.out.join(&*target.triple).join("lld")
646 /// Output directory for all documentation for a target
647 fn doc_out(&self, target: TargetSelection) -> PathBuf {
648 self.out.join(&*target.triple).join("doc")
651 fn test_out(&self, target: TargetSelection) -> PathBuf {
652 self.out.join(&*target.triple).join("test")
655 /// Output directory for all documentation for a target
656 fn compiler_doc_out(&self, target: TargetSelection) -> PathBuf {
657 self.out.join(&*target.triple).join("compiler-doc")
660 /// Output directory for some generated md crate documentation for a target (temporary)
661 fn md_doc_out(&self, target: TargetSelection) -> Interned<PathBuf> {
662 INTERNER.intern_path(self.out.join(&*target.triple).join("md-doc"))
665 /// Returns `true` if no custom `llvm-config` is set for the specified target.
667 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
668 fn is_rust_llvm(&self, target: TargetSelection) -> bool {
669 if self.config.llvm_from_ci && target == self.config.build {
673 match self.config.target_config.get(&target) {
674 Some(ref c) => c.llvm_config.is_none(),
679 /// Returns the path to `FileCheck` binary for the specified target
680 fn llvm_filecheck(&self, target: TargetSelection) -> PathBuf {
681 let target_config = self.config.target_config.get(&target);
682 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
684 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
685 let llvm_bindir = output(Command::new(s).arg("--bindir"));
686 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", target));
687 if filecheck.exists() {
690 // On Fedora the system LLVM installs FileCheck in the
691 // llvm subdirectory of the libdir.
692 let llvm_libdir = output(Command::new(s).arg("--libdir"));
694 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", target));
695 if lib_filecheck.exists() {
698 // Return the most normal file name, even though
699 // it doesn't exist, so that any error message
705 let base = self.llvm_out(self.config.build).join("build");
706 let base = if !self.ninja() && self.config.build.contains("msvc") {
707 if self.config.llvm_optimize {
708 if self.config.llvm_release_debuginfo {
709 base.join("RelWithDebInfo")
719 base.join("bin").join(exe("FileCheck", target))
723 /// Directory for libraries built from C/C++ code and shared between stages.
724 fn native_dir(&self, target: TargetSelection) -> PathBuf {
725 self.out.join(&*target.triple).join("native")
728 /// Root output directory for rust_test_helpers library compiled for
730 fn test_helpers_out(&self, target: TargetSelection) -> PathBuf {
731 self.native_dir(target).join("rust-test-helpers")
734 /// Adds the `RUST_TEST_THREADS` env var if necessary
735 fn add_rust_test_threads(&self, cmd: &mut Command) {
736 if env::var_os("RUST_TEST_THREADS").is_none() {
737 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
741 /// Returns the libdir of the snapshot compiler.
742 fn rustc_snapshot_libdir(&self) -> PathBuf {
743 self.rustc_snapshot_sysroot().join(libdir(self.config.build))
746 /// Returns the sysroot of the snapshot compiler.
747 fn rustc_snapshot_sysroot(&self) -> &Path {
748 self.initial_rustc.parent().unwrap().parent().unwrap()
751 /// Runs a command, printing out nice contextual information if it fails.
752 fn run(&self, cmd: &mut Command) {
753 if self.config.dry_run {
756 self.verbose(&format!("running: {:?}", cmd));
760 /// Runs a command, printing out nice contextual information if it fails.
761 fn run_quiet(&self, cmd: &mut Command) {
762 if self.config.dry_run {
765 self.verbose(&format!("running: {:?}", cmd));
769 /// Runs a command, printing out nice contextual information if it fails.
770 /// Exits if the command failed to execute at all, otherwise returns its
771 /// `status.success()`.
772 fn try_run(&self, cmd: &mut Command) -> bool {
773 if self.config.dry_run {
776 self.verbose(&format!("running: {:?}", cmd));
780 /// Runs a command, printing out nice contextual information if it fails.
781 /// Exits if the command failed to execute at all, otherwise returns its
782 /// `status.success()`.
783 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
784 if self.config.dry_run {
787 self.verbose(&format!("running: {:?}", cmd));
788 try_run_suppressed(cmd)
791 pub fn is_verbose(&self) -> bool {
795 /// Prints a message if this build is configured in verbose mode.
796 fn verbose(&self, msg: &str) {
797 if self.is_verbose() {
802 pub fn is_verbose_than(&self, level: usize) -> bool {
803 self.verbosity > level
806 /// Prints a message if this build is configured in more verbose mode than `level`.
807 fn verbose_than(&self, level: usize, msg: &str) {
808 if self.is_verbose_than(level) {
813 fn info(&self, msg: &str) {
814 if self.config.dry_run {
820 /// Returns the number of parallel jobs that have been configured for this
822 fn jobs(&self) -> u32 {
823 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
826 fn debuginfo_map_to(&self, which: GitRepo) -> Option<String> {
827 if !self.config.rust_remap_debuginfo {
833 let sha = self.rust_sha().unwrap_or(&self.version);
834 Some(format!("/rustc/{}", sha))
836 GitRepo::Llvm => Some(String::from("/rustc/llvm")),
840 /// Returns the path to the C compiler for the target specified.
841 fn cc(&self, target: TargetSelection) -> &Path {
842 self.cc[&target].path()
845 /// Returns a list of flags to pass to the C compiler for the target
847 fn cflags(&self, target: TargetSelection, which: GitRepo) -> Vec<String> {
848 // Filter out -O and /O (the optimization flags) that we picked up from
849 // cc-rs because the build scripts will determine that for themselves.
850 let mut base = self.cc[&target]
853 .map(|s| s.to_string_lossy().into_owned())
854 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
855 .collect::<Vec<String>>();
857 // If we're compiling on macOS then we add a few unconditional flags
858 // indicating that we want libc++ (more filled out than libstdc++) and
859 // we want to compile for 10.7. This way we can ensure that
860 // LLVM/etc are all properly compiled.
861 if target.contains("apple-darwin") {
862 base.push("-stdlib=libc++".into());
865 // Work around an apparently bad MinGW / GCC optimization,
866 // See: https://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
867 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
868 if &*target.triple == "i686-pc-windows-gnu" {
869 base.push("-fno-omit-frame-pointer".into());
872 if let Some(map_to) = self.debuginfo_map_to(which) {
873 let map = format!("{}={}", self.src.display(), map_to);
874 let cc = self.cc(target);
875 if cc.ends_with("clang") || cc.ends_with("gcc") {
876 base.push(format!("-fdebug-prefix-map={}", map));
877 } else if cc.ends_with("clang-cl.exe") {
878 base.push("-Xclang".into());
879 base.push(format!("-fdebug-prefix-map={}", map));
885 /// Returns the path to the `ar` archive utility for the target specified.
886 fn ar(&self, target: TargetSelection) -> Option<&Path> {
887 self.ar.get(&target).map(|p| &**p)
890 /// Returns the path to the `ranlib` utility for the target specified.
891 fn ranlib(&self, target: TargetSelection) -> Option<&Path> {
892 self.ranlib.get(&target).map(|p| &**p)
895 /// Returns the path to the C++ compiler for the target specified.
896 fn cxx(&self, target: TargetSelection) -> Result<&Path, String> {
897 match self.cxx.get(&target) {
898 Some(p) => Ok(p.path()),
900 Err(format!("target `{}` is not configured as a host, only as a target", target))
905 /// Returns the path to the linker for the given target if it needs to be overridden.
906 fn linker(&self, target: TargetSelection) -> Option<&Path> {
907 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
910 } else if target.contains("vxworks") {
911 // need to use CXX compiler as linker to resolve the exception functions
912 // that are only existed in CXX libraries
913 Some(self.cxx[&target].path())
914 } else if target != self.config.build
915 && util::use_host_linker(target)
916 && !target.contains("msvc")
918 Some(self.cc(target))
919 } else if self.config.use_lld && !self.is_fuse_ld_lld(target) && self.build == target {
920 Some(&self.initial_lld)
926 // LLD is used through `-fuse-ld=lld` rather than directly.
927 // Only MSVC targets use LLD directly at the moment.
928 fn is_fuse_ld_lld(&self, target: TargetSelection) -> bool {
929 self.config.use_lld && !target.contains("msvc")
932 fn lld_flags(&self, target: TargetSelection) -> impl Iterator<Item = String> {
933 let mut options = [None, None];
935 if self.config.use_lld {
936 if self.is_fuse_ld_lld(target) {
937 options[0] = Some("-Clink-arg=-fuse-ld=lld".to_string());
940 let threads = if target.contains("windows") { "/threads:1" } else { "--threads=1" };
941 options[1] = Some(format!("-Clink-arg=-Wl,{}", threads));
944 std::array::IntoIter::new(options).flatten()
947 /// Returns if this target should statically link the C runtime, if specified
948 fn crt_static(&self, target: TargetSelection) -> Option<bool> {
949 if target.contains("pc-windows-msvc") {
952 self.config.target_config.get(&target).and_then(|t| t.crt_static)
956 /// Returns the "musl root" for this `target`, if defined
957 fn musl_root(&self, target: TargetSelection) -> Option<&Path> {
961 .and_then(|t| t.musl_root.as_ref())
962 .or_else(|| self.config.musl_root.as_ref())
966 /// Returns the "musl libdir" for this `target`.
967 fn musl_libdir(&self, target: TargetSelection) -> Option<PathBuf> {
968 let t = self.config.target_config.get(&target)?;
969 if let libdir @ Some(_) = &t.musl_libdir {
970 return libdir.clone();
972 self.musl_root(target).map(|root| root.join("lib"))
975 /// Returns the sysroot for the wasi target, if defined
976 fn wasi_root(&self, target: TargetSelection) -> Option<&Path> {
977 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
980 /// Returns `true` if this is a no-std `target`, if defined
981 fn no_std(&self, target: TargetSelection) -> Option<bool> {
982 self.config.target_config.get(&target).map(|t| t.no_std)
985 /// Returns `true` if the target will be tested using the `remote-test-client`
986 /// and `remote-test-server` binaries.
987 fn remote_tested(&self, target: TargetSelection) -> bool {
988 self.qemu_rootfs(target).is_some()
989 || target.contains("android")
990 || env::var_os("TEST_DEVICE_ADDR").is_some()
993 /// Returns the root of the "rootfs" image that this target will be using,
994 /// if one was configured.
996 /// If `Some` is returned then that means that tests for this target are
997 /// emulated with QEMU and binaries will need to be shipped to the emulator.
998 fn qemu_rootfs(&self, target: TargetSelection) -> Option<&Path> {
999 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
1002 /// Path to the python interpreter to use
1003 fn python(&self) -> &Path {
1004 self.config.python.as_ref().unwrap()
1007 /// Temporary directory that extended error information is emitted to.
1008 fn extended_error_dir(&self) -> PathBuf {
1009 self.out.join("tmp/extended-error-metadata")
1012 /// Tests whether the `compiler` compiling for `target` should be forced to
1013 /// use a stage1 compiler instead.
1015 /// Currently, by default, the build system does not perform a "full
1016 /// bootstrap" by default where we compile the compiler three times.
1017 /// Instead, we compile the compiler two times. The final stage (stage2)
1018 /// just copies the libraries from the previous stage, which is what this
1021 /// Here we return `true` if:
1023 /// * The build isn't performing a full bootstrap
1024 /// * The `compiler` is in the final stage, 2
1025 /// * We're not cross-compiling, so the artifacts are already available in
1028 /// When all of these conditions are met the build will lift artifacts from
1029 /// the previous stage forward.
1030 fn force_use_stage1(&self, compiler: Compiler, target: TargetSelection) -> bool {
1031 !self.config.full_bootstrap
1032 && compiler.stage >= 2
1033 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
1036 /// Given `num` in the form "a.b.c" return a "release string" which
1037 /// describes the release version number.
1039 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
1040 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
1041 fn release(&self, num: &str) -> String {
1042 match &self.config.channel[..] {
1043 "stable" => num.to_string(),
1045 if self.rust_info.is_git() {
1046 format!("{}-beta.{}", num, self.beta_prerelease_version())
1048 format!("{}-beta", num)
1051 "nightly" => format!("{}-nightly", num),
1052 _ => format!("{}-dev", num),
1056 fn beta_prerelease_version(&self) -> u32 {
1057 if let Some(s) = self.prerelease_version.get() {
1061 // Figure out how many merge commits happened since we branched off master.
1062 // That's our beta number!
1063 // (Note that we use a `..` range, not the `...` symmetric difference.)
1069 .arg("refs/remotes/origin/master..HEAD")
1070 .current_dir(&self.src),
1072 let n = count.trim().parse().unwrap();
1073 self.prerelease_version.set(Some(n));
1077 /// Returns the value of `release` above for Rust itself.
1078 fn rust_release(&self) -> String {
1079 self.release(&self.version)
1082 /// Returns the "package version" for a component given the `num` release
1085 /// The package version is typically what shows up in the names of tarballs.
1086 /// For channels like beta/nightly it's just the channel name, otherwise
1087 /// it's the `num` provided.
1088 fn package_vers(&self, num: &str) -> String {
1089 match &self.config.channel[..] {
1090 "stable" => num.to_string(),
1091 "beta" => "beta".to_string(),
1092 "nightly" => "nightly".to_string(),
1093 _ => format!("{}-dev", num),
1097 /// Returns the value of `package_vers` above for Rust itself.
1098 fn rust_package_vers(&self) -> String {
1099 self.package_vers(&self.version)
1102 fn llvm_link_tools_dynamically(&self, target: TargetSelection) -> bool {
1103 target.contains("linux-gnu") || target.contains("apple-darwin")
1106 /// Returns the `version` string associated with this compiler for Rust
1109 /// Note that this is a descriptive string which includes the commit date,
1110 /// sha, version, etc.
1111 fn rust_version(&self) -> String {
1112 let mut version = self.rust_info.version(self, &self.version);
1113 if let Some(ref s) = self.config.description {
1114 version.push_str(" (");
1115 version.push_str(s);
1121 /// Returns the full commit hash.
1122 fn rust_sha(&self) -> Option<&str> {
1123 self.rust_info.sha()
1126 /// Returns the `a.b.c` version that the given package is at.
1127 fn release_num(&self, package: &str) -> String {
1128 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1129 let toml = t!(fs::read_to_string(&toml_file_name));
1130 for line in toml.lines() {
1131 if let Some(stripped) =
1132 line.strip_prefix("version = \"").and_then(|s| s.strip_suffix("\""))
1134 return stripped.to_owned();
1138 panic!("failed to find version in {}'s Cargo.toml", package)
1141 /// Returns `true` if unstable features should be enabled for the compiler
1143 fn unstable_features(&self) -> bool {
1144 match &self.config.channel[..] {
1145 "stable" | "beta" => false,
1146 "nightly" | _ => true,
1150 /// Returns a Vec of all the dependencies of the given root crate,
1151 /// including transitive dependencies and the root itself. Only includes
1152 /// "local" crates (those in the local source tree, not from a registry).
1153 fn in_tree_crates(&self, root: &str, target: Option<TargetSelection>) -> Vec<&Crate> {
1154 let mut ret = Vec::new();
1155 let mut list = vec![INTERNER.intern_str(root)];
1156 let mut visited = HashSet::new();
1157 while let Some(krate) = list.pop() {
1158 let krate = &self.crates[&krate];
1160 for dep in &krate.deps {
1161 if !self.crates.contains_key(dep) {
1162 // Ignore non-workspace members.
1165 // Don't include optional deps if their features are not
1166 // enabled. Ideally this would be computed from `cargo
1167 // metadata --features …`, but that is somewhat slow. Just
1168 // skip `build_helper` since there aren't any operations we
1169 // want to perform on it. In the future, we may want to
1170 // consider just filtering all build and dev dependencies in
1172 if visited.insert(dep)
1173 && dep != "build_helper"
1174 && (dep != "profiler_builtins"
1176 .map(|t| self.config.profiler_enabled(t))
1177 .unwrap_or_else(|| self.config.any_profiler_enabled()))
1178 && (dep != "rustc_codegen_llvm" || self.config.llvm_enabled())
1187 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, DependencyType)> {
1188 if self.config.dry_run {
1192 let mut paths = Vec::new();
1193 let contents = t!(fs::read(stamp), &stamp);
1194 // This is the method we use for extracting paths from the stamp file passed to us. See
1195 // run_cargo for more information (in compile.rs).
1196 for part in contents.split(|b| *b == 0) {
1197 if part.is_empty() {
1200 let dependency_type = match part[0] as char {
1201 'h' => DependencyType::Host,
1202 's' => DependencyType::TargetSelfContained,
1203 't' => DependencyType::Target,
1204 _ => unreachable!(),
1206 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1207 paths.push((path, dependency_type));
1212 /// Copies a file from `src` to `dst`
1213 pub fn copy(&self, src: &Path, dst: &Path) {
1214 if self.config.dry_run {
1217 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1221 let _ = fs::remove_file(&dst);
1222 let metadata = t!(src.symlink_metadata());
1223 if metadata.file_type().is_symlink() {
1224 let link = t!(fs::read_link(src));
1225 t!(symlink_file(link, dst));
1226 } else if let Ok(()) = fs::hard_link(src, dst) {
1227 // Attempt to "easy copy" by creating a hard link
1228 // (symlinks don't work on windows), but if that fails
1229 // just fall back to a slow `copy` operation.
1231 if let Err(e) = fs::copy(src, dst) {
1232 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1234 t!(fs::set_permissions(dst, metadata.permissions()));
1235 let atime = FileTime::from_last_access_time(&metadata);
1236 let mtime = FileTime::from_last_modification_time(&metadata);
1237 t!(filetime::set_file_times(dst, atime, mtime));
1241 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1242 /// new string for each replacement.)
1243 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1244 if self.config.dry_run {
1247 let mut contents = String::new();
1248 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1249 t!(file.read_to_string(&mut contents));
1250 for &(target, replacement) in replacements {
1251 contents = contents.replace(target, replacement);
1253 t!(file.seek(SeekFrom::Start(0)));
1254 t!(file.set_len(0));
1255 t!(file.write_all(contents.as_bytes()));
1258 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1259 /// when this function is called.
1260 pub fn cp_r(&self, src: &Path, dst: &Path) {
1261 if self.config.dry_run {
1264 for f in self.read_dir(src) {
1265 let path = f.path();
1266 let name = path.file_name().unwrap();
1267 let dst = dst.join(name);
1268 if t!(f.file_type()).is_dir() {
1269 t!(fs::create_dir_all(&dst));
1270 self.cp_r(&path, &dst);
1272 let _ = fs::remove_file(&dst);
1273 self.copy(&path, &dst);
1278 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1279 /// when this function is called. Unwanted files or directories can be skipped
1280 /// by returning `false` from the filter function.
1281 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1282 // Immediately recurse with an empty relative path
1283 self.recurse_(src, dst, Path::new(""), filter)
1286 // Inner function does the actual work
1287 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1288 for f in self.read_dir(src) {
1289 let path = f.path();
1290 let name = path.file_name().unwrap();
1291 let dst = dst.join(name);
1292 let relative = relative.join(name);
1293 // Only copy file or directory if the filter function returns true
1294 if filter(&relative) {
1295 if t!(f.file_type()).is_dir() {
1296 let _ = fs::remove_dir_all(&dst);
1297 self.create_dir(&dst);
1298 self.recurse_(&path, &dst, &relative, filter);
1300 let _ = fs::remove_file(&dst);
1301 self.copy(&path, &dst);
1307 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1308 let file_name = src.file_name().unwrap();
1309 let dest = dest_folder.join(file_name);
1310 self.copy(src, &dest);
1313 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1314 if self.config.dry_run {
1317 let dst = dstdir.join(src.file_name().unwrap());
1318 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1319 t!(fs::create_dir_all(dstdir));
1320 drop(fs::remove_file(&dst));
1323 panic!("Error: File \"{}\" not found!", src.display());
1325 let metadata = t!(src.symlink_metadata());
1326 if let Err(e) = fs::copy(&src, &dst) {
1327 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1329 t!(fs::set_permissions(&dst, metadata.permissions()));
1330 let atime = FileTime::from_last_access_time(&metadata);
1331 let mtime = FileTime::from_last_modification_time(&metadata);
1332 t!(filetime::set_file_times(&dst, atime, mtime));
1337 fn create(&self, path: &Path, s: &str) {
1338 if self.config.dry_run {
1341 t!(fs::write(path, s));
1344 fn read(&self, path: &Path) -> String {
1345 if self.config.dry_run {
1346 return String::new();
1348 t!(fs::read_to_string(path))
1351 fn create_dir(&self, dir: &Path) {
1352 if self.config.dry_run {
1355 t!(fs::create_dir_all(dir))
1358 fn remove_dir(&self, dir: &Path) {
1359 if self.config.dry_run {
1362 t!(fs::remove_dir_all(dir))
1365 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1366 let iter = match fs::read_dir(dir) {
1368 Err(_) if self.config.dry_run => return vec![].into_iter(),
1369 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1371 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1374 fn remove(&self, f: &Path) {
1375 if self.config.dry_run {
1378 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1381 /// Returns if config.ninja is enabled, and checks for ninja existence,
1382 /// exiting with a nicer error message if not.
1383 fn ninja(&self) -> bool {
1384 let mut cmd_finder = crate::sanity::Finder::new();
1386 if self.config.ninja_in_file {
1387 // Some Linux distros rename `ninja` to `ninja-build`.
1388 // CMake can work with either binary name.
1389 if cmd_finder.maybe_have("ninja-build").is_none()
1390 && cmd_finder.maybe_have("ninja").is_none()
1394 Couldn't find required command: ninja
1395 You should install ninja, or set `ninja=false` in config.toml in the `[llvm]` section.
1398 std::process::exit(1);
1402 // If ninja isn't enabled but we're building for MSVC then we try
1403 // doubly hard to enable it. It was realized in #43767 that the msbuild
1404 // CMake generator for MSVC doesn't respect configuration options like
1405 // disabling LLVM assertions, which can often be quite important!
1407 // In these cases we automatically enable Ninja if we find it in the
1409 if !self.config.ninja_in_file && self.config.build.contains("msvc") {
1410 if cmd_finder.maybe_have("ninja").is_some() {
1415 self.config.ninja_in_file
1420 fn chmod(path: &Path, perms: u32) {
1421 use std::os::unix::fs::*;
1422 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1425 fn chmod(_path: &Path, _perms: u32) {}
1428 pub fn with_stage(mut self, stage: u32) -> Compiler {
1433 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1434 pub fn is_snapshot(&self, build: &Build) -> bool {
1435 self.stage == 0 && self.host == build.build
1438 /// Returns if this compiler should be treated as a final stage one in the
1439 /// current build session.
1440 /// This takes into account whether we're performing a full bootstrap or
1441 /// not; don't directly compare the stage with `2`!
1442 pub fn is_final_stage(&self, build: &Build) -> bool {
1443 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1444 self.stage >= final_stage
1448 fn envify(s: &str) -> String {
1454 .flat_map(|c| c.to_uppercase())