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 build_helper::{mtime, output, run, run_suppressed, t, try_run, try_run_suppressed};
120 use filetime::FileTime;
122 use crate::config::{LlvmLibunwind, TargetSelection};
123 use crate::util::{exe, libdir, CiEnv};
152 #[cfg(all(unix, not(target_os = "haiku")))]
154 pub unsafe fn setup(build: &mut crate::Build) {
155 if build.config.low_priority {
156 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
161 #[cfg(any(target_os = "haiku", target_os = "hermit", not(any(unix, windows))))]
163 pub unsafe fn setup(_build: &mut crate::Build) {}
166 use crate::cache::{Interned, INTERNER};
167 pub use crate::config::Config;
168 pub use crate::flags::Subcommand;
170 const LLVM_TOOLS: &[&str] = &[
171 "llvm-cov", // used to generate coverage report
172 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
173 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
174 "llvm-objdump", // used to disassemble programs
175 "llvm-profdata", // used to inspect and merge files generated by profiles
176 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
177 "llvm-size", // used to prints the size of the linker sections of a program
178 "llvm-strip", // used to discard symbols from binary files to reduce their size
179 "llvm-ar", // used for creating and modifying archive files
180 "llvm-as", // used to convert LLVM assembly to LLVM bitcode
181 "llvm-dis", // used to disassemble LLVM bitcode
182 "llc", // used to compile LLVM bytecode
183 "opt", // used to optimize LLVM bytecode
186 pub const VERSION: usize = 2;
188 /// A structure representing a Rust compiler.
190 /// Each compiler has a `stage` that it is associated with and a `host` that
191 /// corresponds to the platform the compiler runs on. This structure is used as
192 /// a parameter to many methods below.
193 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
194 pub struct Compiler {
196 host: TargetSelection,
199 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
201 /// Run normal tests and doc tests (default).
203 /// Do not run any doc tests.
205 /// Only run doc tests.
214 /// Global configuration for the build system.
216 /// This structure transitively contains all configuration for the build system.
217 /// All filesystem-encoded configuration is in `config`, all flags are in
218 /// `flags`, and then parsed or probed information is listed in the keys below.
220 /// This structure is a parameter of almost all methods in the build system,
221 /// although most functions are implemented as free functions rather than
222 /// methods specifically on this structure itself (to make it easier to
225 /// User-specified configuration from `config.toml`.
228 // Version information
231 // Properties derived from the above configuration
234 rust_info: channel::GitInfo,
235 cargo_info: channel::GitInfo,
236 rls_info: channel::GitInfo,
237 rust_analyzer_info: channel::GitInfo,
238 clippy_info: channel::GitInfo,
239 miri_info: channel::GitInfo,
240 rustfmt_info: channel::GitInfo,
241 in_tree_llvm_info: channel::GitInfo,
247 // Targets for which to build
248 build: TargetSelection,
249 hosts: Vec<TargetSelection>,
250 targets: Vec<TargetSelection>,
252 // Stage 0 (downloaded) compiler, lld and cargo or their local rust equivalents
253 initial_rustc: PathBuf,
254 initial_cargo: PathBuf,
255 initial_lld: PathBuf,
256 initial_libdir: PathBuf,
258 // Runtime state filled in later on
259 // C/C++ compilers and archiver for all targets
260 cc: HashMap<TargetSelection, cc::Tool>,
261 cxx: HashMap<TargetSelection, cc::Tool>,
262 ar: HashMap<TargetSelection, PathBuf>,
263 ranlib: HashMap<TargetSelection, PathBuf>,
265 crates: HashMap<Interned<String>, Crate>,
268 delayed_failures: RefCell<Vec<String>>,
269 prerelease_version: Cell<Option<u32>>,
271 RefCell<HashMap<TargetSelection, HashMap<String, (&'static str, PathBuf, Vec<String>)>>>,
276 name: Interned<String>,
277 deps: HashSet<Interned<String>>,
282 fn local_path(&self, build: &Build) -> PathBuf {
283 self.path.strip_prefix(&build.config.src).unwrap().into()
287 /// When building Rust various objects are handled differently.
288 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
289 pub enum DependencyType {
290 /// Libraries originating from proc-macros.
292 /// Typical Rust libraries.
294 /// Non Rust libraries and objects shipped to ease usage of certain targets.
298 /// The various "modes" of invoking Cargo.
300 /// These entries currently correspond to the various output directories of the
301 /// build system, with each mod generating output in a different directory.
302 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
304 /// Build the standard library, placing output in the "stageN-std" directory.
307 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
310 /// Build a codegen backend for rustc, placing the output in the "stageN-codegen" directory.
313 /// Build a tool, placing output in the "stage0-bootstrap-tools"
314 /// directory. This is for miscellaneous sets of tools that are built
315 /// using the bootstrap stage0 compiler in its entirety (target libraries
316 /// and all). Typically these tools compile with stable Rust.
319 /// Build a tool which uses the locally built std, placing output in the
320 /// "stageN-tools" directory. Its usage is quite rare, mainly used by
321 /// compiletest which needs libtest.
324 /// Build a tool which uses the locally built rustc and the target std,
325 /// placing the output in the "stageN-tools" directory. This is used for
326 /// anything that needs a fully functional rustc, such as rustdoc, clippy,
327 /// cargo, rls, rustfmt, miri, etc.
332 pub fn is_tool(&self) -> bool {
333 matches!(self, Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd)
336 pub fn must_support_dlopen(&self) -> bool {
337 matches!(self, Mode::Std | Mode::Codegen)
342 /// Creates a new set of build configuration from the `flags` on the command
343 /// line and the filesystem `config`.
345 /// By default all build output will be placed in the current directory.
346 pub fn new(config: Config) -> Build {
347 let src = config.src.clone();
348 let out = config.out.clone();
350 let is_sudo = match env::var_os("SUDO_USER") {
351 Some(sudo_user) => match env::var_os("USER") {
352 Some(user) => user != sudo_user,
358 let ignore_git = config.ignore_git;
359 let rust_info = channel::GitInfo::new(ignore_git, &src);
360 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
361 let rls_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rls"));
362 let rust_analyzer_info =
363 channel::GitInfo::new(ignore_git, &src.join("src/tools/rust-analyzer"));
364 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
365 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
366 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
368 // we always try to use git for LLVM builds
369 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
371 let initial_target_libdir_str = if config.dry_run {
372 "/dummy/lib/path/to/lib/".to_string()
375 Command::new(&config.initial_rustc)
377 .arg(config.build.rustc_target_arg())
379 .arg("target-libdir"),
382 let initial_target_dir = Path::new(&initial_target_libdir_str).parent().unwrap();
383 let initial_lld = initial_target_dir.join("bin").join("rust-lld");
385 let initial_sysroot = if config.dry_run {
388 output(Command::new(&config.initial_rustc).arg("--print").arg("sysroot"))
390 let initial_libdir = initial_target_dir
395 .strip_prefix(initial_sysroot.trim())
399 let version = std::fs::read_to_string(src.join("src").join("version"))
400 .expect("failed to read src/version");
401 let version = version.trim();
403 let mut build = Build {
404 initial_rustc: config.initial_rustc.clone(),
405 initial_cargo: config.initial_cargo.clone(),
408 local_rebuild: config.local_rebuild,
409 fail_fast: config.cmd.fail_fast(),
410 doc_tests: config.cmd.doc_tests(),
411 verbosity: config.verbose,
414 hosts: config.hosts.clone(),
415 targets: config.targets.clone(),
418 version: version.to_string(),
433 ranlib: HashMap::new(),
434 crates: HashMap::new(),
436 ci_env: CiEnv::current(),
437 delayed_failures: RefCell::new(Vec::new()),
438 prerelease_version: Cell::new(None),
439 tool_artifacts: Default::default(),
442 build.verbose("finding compilers");
443 cc_detect::find(&mut build);
444 // When running `setup`, the profile is about to change, so any requirements we have now may
445 // be different on the next invocation. Don't check for them until the next time x.py is
446 // run. This is ok because `setup` never runs any build commands, so it won't fail if commands are missing.
447 if !matches!(build.config.cmd, Subcommand::Setup { .. }) {
448 build.verbose("running sanity check");
449 sanity::check(&mut build);
452 // If local-rust is the same major.minor as the current version, then force a
454 let local_version_verbose =
455 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
456 let local_release = local_version_verbose
458 .filter_map(|x| x.strip_prefix("release:"))
462 if local_release.split('.').take(2).eq(version.split('.').take(2)) {
463 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
464 build.local_rebuild = true;
467 build.verbose("learning about cargo");
468 metadata::build(&mut build);
473 // modified from `check_submodule` and `update_submodule` in bootstrap.py
474 /// Given a path to the directory of a submodule, update it.
476 /// `relative_path` should be relative to the root of the git repository, not an absolute path.
477 pub(crate) fn update_submodule(&self, relative_path: &Path) {
478 fn dir_is_empty(dir: &Path) -> bool {
479 t!(std::fs::read_dir(dir)).next().is_none()
482 if !self.config.submodules(&self.rust_info) {
486 let absolute_path = self.config.src.join(relative_path);
488 // NOTE: The check for the empty directory is here because when running x.py the first time,
489 // the submodule won't be checked out. Check it out now so we can build it.
490 if !channel::GitInfo::new(false, &absolute_path).is_git() && !dir_is_empty(&absolute_path) {
495 if self.config.fast_submodules {
496 let checked_out_hash = output(
497 Command::new("git").args(&["rev-parse", "HEAD"]).current_dir(&absolute_path),
500 let recorded = output(
502 .args(&["ls-tree", "HEAD"])
504 .current_dir(&self.config.src),
506 let actual_hash = recorded
509 .unwrap_or_else(|| panic!("unexpected output `{}`", recorded));
512 if actual_hash == checked_out_hash.trim_end() {
513 // already checked out
518 println!("Updating submodule {}", relative_path.display());
521 .args(&["submodule", "-q", "sync"])
523 .current_dir(&self.config.src),
526 // Try passing `--progress` to start, then run git again without if that fails.
527 let update = |progress: bool| {
528 let mut git = Command::new("git");
529 git.args(&["submodule", "update", "--init", "--recursive", "--depth=1"]);
531 git.arg("--progress");
533 git.arg(relative_path).current_dir(&self.config.src);
536 // NOTE: doesn't use `try_run` because this shouldn't print an error if it fails.
537 if !update(true).status().map_or(false, |status| status.success()) {
538 self.run(&mut update(false));
541 self.run(Command::new("git").args(&["reset", "-q", "--hard"]).current_dir(&absolute_path));
542 self.run(Command::new("git").args(&["clean", "-qdfx"]).current_dir(absolute_path));
545 /// If any submodule has been initialized already, sync it unconditionally.
546 /// This avoids contributors checking in a submodule change by accident.
547 pub fn maybe_update_submodules(&self) {
548 // WARNING: keep this in sync with the submodules hard-coded in bootstrap.py
549 const BOOTSTRAP_SUBMODULES: &[&str] = &[
550 "src/tools/rust-installer",
557 // Avoid running git when there isn't a git checkout.
558 if !self.config.submodules(&self.rust_info) {
563 .args(&["config", "--file"])
564 .arg(&self.config.src.join(".gitmodules"))
565 .args(&["--get-regexp", "path"]),
567 for line in output.lines() {
568 // Look for `submodule.$name.path = $path`
569 // Sample output: `submodule.src/rust-installer.path src/tools/rust-installer`
570 let submodule = Path::new(line.splitn(2, ' ').nth(1).unwrap());
571 // avoid updating submodules twice
572 if !BOOTSTRAP_SUBMODULES.iter().any(|&p| Path::new(p) == submodule)
573 && channel::GitInfo::new(false, submodule).is_git()
575 self.update_submodule(submodule);
580 /// Executes the entire build, as configured by the flags and configuration.
581 pub fn build(&mut self) {
586 self.maybe_update_submodules();
588 if let Subcommand::Format { check, paths } = &self.config.cmd {
589 return format::format(self, *check, &paths);
592 if let Subcommand::Clean { all } = self.config.cmd {
593 return clean::clean(self, all);
596 if let Subcommand::Setup { profile } = &self.config.cmd {
597 return setup::setup(&self.config.src, *profile);
601 let builder = builder::Builder::new(&self);
602 if let Some(path) = builder.paths.get(0) {
603 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
609 if !self.config.dry_run {
611 self.config.dry_run = true;
612 let builder = builder::Builder::new(&self);
613 builder.execute_cli();
615 self.config.dry_run = false;
616 let builder = builder::Builder::new(&self);
617 builder.execute_cli();
619 let builder = builder::Builder::new(&self);
620 builder.execute_cli();
623 // Check for postponed failures from `test --no-fail-fast`.
624 let failures = self.delayed_failures.borrow();
625 if failures.len() > 0 {
626 println!("\n{} command(s) did not execute successfully:\n", failures.len());
627 for failure in failures.iter() {
628 println!(" - {}\n", failure);
634 /// Clear out `dir` if `input` is newer.
636 /// After this executes, it will also ensure that `dir` exists.
637 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
638 let stamp = dir.join(".stamp");
639 let mut cleared = false;
640 if mtime(&stamp) < mtime(input) {
641 self.verbose(&format!("Dirty - {}", dir.display()));
642 let _ = fs::remove_dir_all(dir);
644 } else if stamp.exists() {
647 t!(fs::create_dir_all(dir));
648 t!(File::create(stamp));
652 /// Gets the space-separated set of activated features for the standard
654 fn std_features(&self, target: TargetSelection) -> String {
655 let mut features = "panic-unwind".to_string();
657 match self.config.llvm_libunwind {
658 LlvmLibunwind::InTree => features.push_str(" llvm-libunwind"),
659 LlvmLibunwind::System => features.push_str(" system-llvm-libunwind"),
660 LlvmLibunwind::No => {}
662 if self.config.backtrace {
663 features.push_str(" backtrace");
665 if self.config.profiler_enabled(target) {
666 features.push_str(" profiler");
671 /// Gets the space-separated set of activated features for the compiler.
672 fn rustc_features(&self) -> String {
673 let mut features = String::new();
674 if self.config.jemalloc {
675 features.push_str("jemalloc");
677 if self.config.llvm_enabled() {
678 features.push_str(" llvm");
681 // If debug logging is on, then we want the default for tracing:
682 // https://github.com/tokio-rs/tracing/blob/3dd5c03d907afdf2c39444a29931833335171554/tracing/src/level_filters.rs#L26
683 // which is everything (including debug/trace/etc.)
684 // if its unset, if debug_assertions is on, then debug_logging will also be on
685 // as well as tracing *ignoring* this feature when debug_assertions is on
686 if !self.config.rust_debug_logging {
687 features.push_str(" max_level_info");
693 /// Component directory that Cargo will produce output into (e.g.
695 fn cargo_dir(&self) -> &'static str {
696 if self.config.rust_optimize { "release" } else { "debug" }
699 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
702 .join(&*compiler.host.triple)
703 .join(format!("stage{}-tools-bin", compiler.stage));
704 t!(fs::create_dir_all(&out));
708 /// Returns the root directory for all output generated in a particular
709 /// stage when running with a particular host compiler.
711 /// The mode indicates what the root directory is for.
712 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
713 let suffix = match mode {
715 Mode::Rustc => "-rustc",
716 Mode::Codegen => "-codegen",
717 Mode::ToolBootstrap => "-bootstrap-tools",
718 Mode::ToolStd | Mode::ToolRustc => "-tools",
720 self.out.join(&*compiler.host.triple).join(format!("stage{}{}", compiler.stage, suffix))
723 /// Returns the root output directory for all Cargo output in a given stage,
724 /// running a particular compiler, whether or not we're building the
725 /// standard library, and targeting the specified architecture.
726 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: TargetSelection) -> PathBuf {
727 self.stage_out(compiler, mode).join(&*target.triple).join(self.cargo_dir())
730 /// Root output directory for LLVM compiled for `target`
732 /// Note that if LLVM is configured externally then the directory returned
733 /// will likely be empty.
734 fn llvm_out(&self, target: TargetSelection) -> PathBuf {
735 self.out.join(&*target.triple).join("llvm")
738 fn lld_out(&self, target: TargetSelection) -> PathBuf {
739 self.out.join(&*target.triple).join("lld")
742 /// Output directory for all documentation for a target
743 fn doc_out(&self, target: TargetSelection) -> PathBuf {
744 self.out.join(&*target.triple).join("doc")
747 fn test_out(&self, target: TargetSelection) -> PathBuf {
748 self.out.join(&*target.triple).join("test")
751 /// Output directory for all documentation for a target
752 fn compiler_doc_out(&self, target: TargetSelection) -> PathBuf {
753 self.out.join(&*target.triple).join("compiler-doc")
756 /// Output directory for some generated md crate documentation for a target (temporary)
757 fn md_doc_out(&self, target: TargetSelection) -> Interned<PathBuf> {
758 INTERNER.intern_path(self.out.join(&*target.triple).join("md-doc"))
761 /// Returns `true` if no custom `llvm-config` is set for the specified target.
763 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
764 fn is_rust_llvm(&self, target: TargetSelection) -> bool {
765 if self.config.llvm_from_ci && target == self.config.build {
769 match self.config.target_config.get(&target) {
770 Some(ref c) => c.llvm_config.is_none(),
775 /// Returns the path to `FileCheck` binary for the specified target
776 fn llvm_filecheck(&self, target: TargetSelection) -> PathBuf {
777 let target_config = self.config.target_config.get(&target);
778 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
780 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
781 let llvm_bindir = output(Command::new(s).arg("--bindir"));
782 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", target));
783 if filecheck.exists() {
786 // On Fedora the system LLVM installs FileCheck in the
787 // llvm subdirectory of the libdir.
788 let llvm_libdir = output(Command::new(s).arg("--libdir"));
790 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", target));
791 if lib_filecheck.exists() {
794 // Return the most normal file name, even though
795 // it doesn't exist, so that any error message
801 let base = self.llvm_out(self.config.build).join("build");
802 let base = if !self.ninja() && self.config.build.contains("msvc") {
803 if self.config.llvm_optimize {
804 if self.config.llvm_release_debuginfo {
805 base.join("RelWithDebInfo")
815 base.join("bin").join(exe("FileCheck", target))
819 /// Directory for libraries built from C/C++ code and shared between stages.
820 fn native_dir(&self, target: TargetSelection) -> PathBuf {
821 self.out.join(&*target.triple).join("native")
824 /// Root output directory for rust_test_helpers library compiled for
826 fn test_helpers_out(&self, target: TargetSelection) -> PathBuf {
827 self.native_dir(target).join("rust-test-helpers")
830 /// Adds the `RUST_TEST_THREADS` env var if necessary
831 fn add_rust_test_threads(&self, cmd: &mut Command) {
832 if env::var_os("RUST_TEST_THREADS").is_none() {
833 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
837 /// Returns the libdir of the snapshot compiler.
838 fn rustc_snapshot_libdir(&self) -> PathBuf {
839 self.rustc_snapshot_sysroot().join(libdir(self.config.build))
842 /// Returns the sysroot of the snapshot compiler.
843 fn rustc_snapshot_sysroot(&self) -> &Path {
844 self.initial_rustc.parent().unwrap().parent().unwrap()
847 /// Runs a command, printing out nice contextual information if it fails.
848 fn run(&self, cmd: &mut Command) {
849 if self.config.dry_run {
852 self.verbose(&format!("running: {:?}", cmd));
853 run(cmd, self.is_verbose())
856 /// Runs a command, printing out nice contextual information if it fails.
857 fn run_quiet(&self, cmd: &mut Command) {
858 if self.config.dry_run {
861 self.verbose(&format!("running: {:?}", cmd));
865 /// Runs a command, printing out nice contextual information if it fails.
866 /// Exits if the command failed to execute at all, otherwise returns its
867 /// `status.success()`.
868 fn try_run(&self, cmd: &mut Command) -> bool {
869 if self.config.dry_run {
872 self.verbose(&format!("running: {:?}", cmd));
873 try_run(cmd, self.is_verbose())
876 /// Runs a command, printing out nice contextual information if it fails.
877 /// Exits if the command failed to execute at all, otherwise returns its
878 /// `status.success()`.
879 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
880 if self.config.dry_run {
883 self.verbose(&format!("running: {:?}", cmd));
884 try_run_suppressed(cmd)
887 pub fn is_verbose(&self) -> bool {
891 /// Prints a message if this build is configured in verbose mode.
892 fn verbose(&self, msg: &str) {
893 if self.is_verbose() {
898 pub fn is_verbose_than(&self, level: usize) -> bool {
899 self.verbosity > level
902 /// Prints a message if this build is configured in more verbose mode than `level`.
903 fn verbose_than(&self, level: usize, msg: &str) {
904 if self.is_verbose_than(level) {
909 fn info(&self, msg: &str) {
910 if self.config.dry_run {
916 /// Returns the number of parallel jobs that have been configured for this
918 fn jobs(&self) -> u32 {
919 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
922 fn debuginfo_map_to(&self, which: GitRepo) -> Option<String> {
923 if !self.config.rust_remap_debuginfo {
929 let sha = self.rust_sha().unwrap_or(&self.version);
930 Some(format!("/rustc/{}", sha))
932 GitRepo::Llvm => Some(String::from("/rustc/llvm")),
936 /// Returns the path to the C compiler for the target specified.
937 fn cc(&self, target: TargetSelection) -> &Path {
938 self.cc[&target].path()
941 /// Returns a list of flags to pass to the C compiler for the target
943 fn cflags(&self, target: TargetSelection, which: GitRepo) -> Vec<String> {
944 // Filter out -O and /O (the optimization flags) that we picked up from
945 // cc-rs because the build scripts will determine that for themselves.
946 let mut base = self.cc[&target]
949 .map(|s| s.to_string_lossy().into_owned())
950 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
951 .collect::<Vec<String>>();
953 // If we're compiling on macOS then we add a few unconditional flags
954 // indicating that we want libc++ (more filled out than libstdc++) and
955 // we want to compile for 10.7. This way we can ensure that
956 // LLVM/etc are all properly compiled.
957 if target.contains("apple-darwin") {
958 base.push("-stdlib=libc++".into());
961 // Work around an apparently bad MinGW / GCC optimization,
962 // See: https://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
963 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
964 if &*target.triple == "i686-pc-windows-gnu" {
965 base.push("-fno-omit-frame-pointer".into());
968 if let Some(map_to) = self.debuginfo_map_to(which) {
969 let map = format!("{}={}", self.src.display(), map_to);
970 let cc = self.cc(target);
971 if cc.ends_with("clang") || cc.ends_with("gcc") {
972 base.push(format!("-fdebug-prefix-map={}", map));
973 } else if cc.ends_with("clang-cl.exe") {
974 base.push("-Xclang".into());
975 base.push(format!("-fdebug-prefix-map={}", map));
981 /// Returns the path to the `ar` archive utility for the target specified.
982 fn ar(&self, target: TargetSelection) -> Option<&Path> {
983 self.ar.get(&target).map(|p| &**p)
986 /// Returns the path to the `ranlib` utility for the target specified.
987 fn ranlib(&self, target: TargetSelection) -> Option<&Path> {
988 self.ranlib.get(&target).map(|p| &**p)
991 /// Returns the path to the C++ compiler for the target specified.
992 fn cxx(&self, target: TargetSelection) -> Result<&Path, String> {
993 match self.cxx.get(&target) {
994 Some(p) => Ok(p.path()),
996 Err(format!("target `{}` is not configured as a host, only as a target", target))
1001 /// Returns the path to the linker for the given target if it needs to be overridden.
1002 fn linker(&self, target: TargetSelection) -> Option<&Path> {
1003 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
1006 } else if target.contains("vxworks") {
1007 // need to use CXX compiler as linker to resolve the exception functions
1008 // that are only existed in CXX libraries
1009 Some(self.cxx[&target].path())
1010 } else if target != self.config.build
1011 && util::use_host_linker(target)
1012 && !target.contains("msvc")
1014 Some(self.cc(target))
1015 } else if self.config.use_lld && !self.is_fuse_ld_lld(target) && self.build == target {
1016 Some(&self.initial_lld)
1022 // LLD is used through `-fuse-ld=lld` rather than directly.
1023 // Only MSVC targets use LLD directly at the moment.
1024 fn is_fuse_ld_lld(&self, target: TargetSelection) -> bool {
1025 self.config.use_lld && !target.contains("msvc")
1028 fn lld_flags(&self, target: TargetSelection) -> impl Iterator<Item = String> {
1029 let mut options = [None, None];
1031 if self.config.use_lld {
1032 if self.is_fuse_ld_lld(target) {
1033 options[0] = Some("-Clink-arg=-fuse-ld=lld".to_string());
1036 let threads = if target.contains("windows") { "/threads:1" } else { "--threads=1" };
1037 options[1] = Some(format!("-Clink-arg=-Wl,{}", threads));
1040 IntoIterator::into_iter(options).flatten()
1043 /// Returns if this target should statically link the C runtime, if specified
1044 fn crt_static(&self, target: TargetSelection) -> Option<bool> {
1045 if target.contains("pc-windows-msvc") {
1048 self.config.target_config.get(&target).and_then(|t| t.crt_static)
1052 /// Returns the "musl root" for this `target`, if defined
1053 fn musl_root(&self, target: TargetSelection) -> Option<&Path> {
1057 .and_then(|t| t.musl_root.as_ref())
1058 .or_else(|| self.config.musl_root.as_ref())
1062 /// Returns the "musl libdir" for this `target`.
1063 fn musl_libdir(&self, target: TargetSelection) -> Option<PathBuf> {
1064 let t = self.config.target_config.get(&target)?;
1065 if let libdir @ Some(_) = &t.musl_libdir {
1066 return libdir.clone();
1068 self.musl_root(target).map(|root| root.join("lib"))
1071 /// Returns the sysroot for the wasi target, if defined
1072 fn wasi_root(&self, target: TargetSelection) -> Option<&Path> {
1073 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
1076 /// Returns `true` if this is a no-std `target`, if defined
1077 fn no_std(&self, target: TargetSelection) -> Option<bool> {
1078 self.config.target_config.get(&target).map(|t| t.no_std)
1081 /// Returns `true` if the target will be tested using the `remote-test-client`
1082 /// and `remote-test-server` binaries.
1083 fn remote_tested(&self, target: TargetSelection) -> bool {
1084 self.qemu_rootfs(target).is_some()
1085 || target.contains("android")
1086 || env::var_os("TEST_DEVICE_ADDR").is_some()
1089 /// Returns the root of the "rootfs" image that this target will be using,
1090 /// if one was configured.
1092 /// If `Some` is returned then that means that tests for this target are
1093 /// emulated with QEMU and binaries will need to be shipped to the emulator.
1094 fn qemu_rootfs(&self, target: TargetSelection) -> Option<&Path> {
1095 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
1098 /// Path to the python interpreter to use
1099 fn python(&self) -> &Path {
1100 self.config.python.as_ref().unwrap()
1103 /// Temporary directory that extended error information is emitted to.
1104 fn extended_error_dir(&self) -> PathBuf {
1105 self.out.join("tmp/extended-error-metadata")
1108 /// Tests whether the `compiler` compiling for `target` should be forced to
1109 /// use a stage1 compiler instead.
1111 /// Currently, by default, the build system does not perform a "full
1112 /// bootstrap" by default where we compile the compiler three times.
1113 /// Instead, we compile the compiler two times. The final stage (stage2)
1114 /// just copies the libraries from the previous stage, which is what this
1117 /// Here we return `true` if:
1119 /// * The build isn't performing a full bootstrap
1120 /// * The `compiler` is in the final stage, 2
1121 /// * We're not cross-compiling, so the artifacts are already available in
1124 /// When all of these conditions are met the build will lift artifacts from
1125 /// the previous stage forward.
1126 fn force_use_stage1(&self, compiler: Compiler, target: TargetSelection) -> bool {
1127 !self.config.full_bootstrap
1128 && compiler.stage >= 2
1129 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
1132 /// Given `num` in the form "a.b.c" return a "release string" which
1133 /// describes the release version number.
1135 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
1136 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
1137 fn release(&self, num: &str) -> String {
1138 match &self.config.channel[..] {
1139 "stable" => num.to_string(),
1141 if self.rust_info.is_git() && !self.config.ignore_git {
1142 format!("{}-beta.{}", num, self.beta_prerelease_version())
1144 format!("{}-beta", num)
1147 "nightly" => format!("{}-nightly", num),
1148 _ => format!("{}-dev", num),
1152 fn beta_prerelease_version(&self) -> u32 {
1153 if let Some(s) = self.prerelease_version.get() {
1157 // Figure out how many merge commits happened since we branched off master.
1158 // That's our beta number!
1159 // (Note that we use a `..` range, not the `...` symmetric difference.)
1165 .arg("refs/remotes/origin/master..HEAD")
1166 .current_dir(&self.src),
1168 let n = count.trim().parse().unwrap();
1169 self.prerelease_version.set(Some(n));
1173 /// Returns the value of `release` above for Rust itself.
1174 fn rust_release(&self) -> String {
1175 self.release(&self.version)
1178 /// Returns the "package version" for a component given the `num` release
1181 /// The package version is typically what shows up in the names of tarballs.
1182 /// For channels like beta/nightly it's just the channel name, otherwise
1183 /// it's the `num` provided.
1184 fn package_vers(&self, num: &str) -> String {
1185 match &self.config.channel[..] {
1186 "stable" => num.to_string(),
1187 "beta" => "beta".to_string(),
1188 "nightly" => "nightly".to_string(),
1189 _ => format!("{}-dev", num),
1193 /// Returns the value of `package_vers` above for Rust itself.
1194 fn rust_package_vers(&self) -> String {
1195 self.package_vers(&self.version)
1198 fn llvm_link_tools_dynamically(&self, target: TargetSelection) -> bool {
1199 target.contains("linux-gnu") || target.contains("apple-darwin")
1202 /// Returns the `version` string associated with this compiler for Rust
1205 /// Note that this is a descriptive string which includes the commit date,
1206 /// sha, version, etc.
1207 fn rust_version(&self) -> String {
1208 let mut version = self.rust_info.version(self, &self.version);
1209 if let Some(ref s) = self.config.description {
1210 version.push_str(" (");
1211 version.push_str(s);
1217 /// Returns the full commit hash.
1218 fn rust_sha(&self) -> Option<&str> {
1219 self.rust_info.sha()
1222 /// Returns the `a.b.c` version that the given package is at.
1223 fn release_num(&self, package: &str) -> String {
1224 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1225 let toml = t!(fs::read_to_string(&toml_file_name));
1226 for line in toml.lines() {
1227 if let Some(stripped) =
1228 line.strip_prefix("version = \"").and_then(|s| s.strip_suffix("\""))
1230 return stripped.to_owned();
1234 panic!("failed to find version in {}'s Cargo.toml", package)
1237 /// Returns `true` if unstable features should be enabled for the compiler
1239 fn unstable_features(&self) -> bool {
1240 match &self.config.channel[..] {
1241 "stable" | "beta" => false,
1242 "nightly" | _ => true,
1246 /// Returns a Vec of all the dependencies of the given root crate,
1247 /// including transitive dependencies and the root itself. Only includes
1248 /// "local" crates (those in the local source tree, not from a registry).
1249 fn in_tree_crates(&self, root: &str, target: Option<TargetSelection>) -> Vec<&Crate> {
1250 let mut ret = Vec::new();
1251 let mut list = vec![INTERNER.intern_str(root)];
1252 let mut visited = HashSet::new();
1253 while let Some(krate) = list.pop() {
1254 let krate = &self.crates[&krate];
1256 for dep in &krate.deps {
1257 if !self.crates.contains_key(dep) {
1258 // Ignore non-workspace members.
1261 // Don't include optional deps if their features are not
1262 // enabled. Ideally this would be computed from `cargo
1263 // metadata --features …`, but that is somewhat slow. Just
1264 // skip `build_helper` since there aren't any operations we
1265 // want to perform on it. In the future, we may want to
1266 // consider just filtering all build and dev dependencies in
1268 if visited.insert(dep)
1269 && dep != "build_helper"
1270 && (dep != "profiler_builtins"
1272 .map(|t| self.config.profiler_enabled(t))
1273 .unwrap_or_else(|| self.config.any_profiler_enabled()))
1274 && (dep != "rustc_codegen_llvm" || self.config.llvm_enabled())
1283 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, DependencyType)> {
1284 if self.config.dry_run {
1288 let mut paths = Vec::new();
1289 let contents = t!(fs::read(stamp), &stamp);
1290 // This is the method we use for extracting paths from the stamp file passed to us. See
1291 // run_cargo for more information (in compile.rs).
1292 for part in contents.split(|b| *b == 0) {
1293 if part.is_empty() {
1296 let dependency_type = match part[0] as char {
1297 'h' => DependencyType::Host,
1298 's' => DependencyType::TargetSelfContained,
1299 't' => DependencyType::Target,
1300 _ => unreachable!(),
1302 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1303 paths.push((path, dependency_type));
1308 /// Copies a file from `src` to `dst`
1309 pub fn copy(&self, src: &Path, dst: &Path) {
1310 if self.config.dry_run {
1313 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1317 let _ = fs::remove_file(&dst);
1318 let metadata = t!(src.symlink_metadata());
1319 if metadata.file_type().is_symlink() {
1320 let link = t!(fs::read_link(src));
1321 t!(symlink_file(link, dst));
1322 } else if let Ok(()) = fs::hard_link(src, dst) {
1323 // Attempt to "easy copy" by creating a hard link
1324 // (symlinks don't work on windows), but if that fails
1325 // just fall back to a slow `copy` operation.
1327 if let Err(e) = fs::copy(src, dst) {
1328 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1330 t!(fs::set_permissions(dst, metadata.permissions()));
1331 let atime = FileTime::from_last_access_time(&metadata);
1332 let mtime = FileTime::from_last_modification_time(&metadata);
1333 t!(filetime::set_file_times(dst, atime, mtime));
1337 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1338 /// when this function is called.
1339 pub fn cp_r(&self, src: &Path, dst: &Path) {
1340 if self.config.dry_run {
1343 for f in self.read_dir(src) {
1344 let path = f.path();
1345 let name = path.file_name().unwrap();
1346 let dst = dst.join(name);
1347 if t!(f.file_type()).is_dir() {
1348 t!(fs::create_dir_all(&dst));
1349 self.cp_r(&path, &dst);
1351 let _ = fs::remove_file(&dst);
1352 self.copy(&path, &dst);
1357 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1358 /// when this function is called. Unwanted files or directories can be skipped
1359 /// by returning `false` from the filter function.
1360 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1361 // Immediately recurse with an empty relative path
1362 self.recurse_(src, dst, Path::new(""), filter)
1365 // Inner function does the actual work
1366 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1367 for f in self.read_dir(src) {
1368 let path = f.path();
1369 let name = path.file_name().unwrap();
1370 let dst = dst.join(name);
1371 let relative = relative.join(name);
1372 // Only copy file or directory if the filter function returns true
1373 if filter(&relative) {
1374 if t!(f.file_type()).is_dir() {
1375 let _ = fs::remove_dir_all(&dst);
1376 self.create_dir(&dst);
1377 self.recurse_(&path, &dst, &relative, filter);
1379 let _ = fs::remove_file(&dst);
1380 self.copy(&path, &dst);
1386 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1387 let file_name = src.file_name().unwrap();
1388 let dest = dest_folder.join(file_name);
1389 self.copy(src, &dest);
1392 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1393 if self.config.dry_run {
1396 let dst = dstdir.join(src.file_name().unwrap());
1397 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1398 t!(fs::create_dir_all(dstdir));
1399 drop(fs::remove_file(&dst));
1402 panic!("Error: File \"{}\" not found!", src.display());
1404 let metadata = t!(src.symlink_metadata());
1405 if let Err(e) = fs::copy(&src, &dst) {
1406 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1408 t!(fs::set_permissions(&dst, metadata.permissions()));
1409 let atime = FileTime::from_last_access_time(&metadata);
1410 let mtime = FileTime::from_last_modification_time(&metadata);
1411 t!(filetime::set_file_times(&dst, atime, mtime));
1416 fn create(&self, path: &Path, s: &str) {
1417 if self.config.dry_run {
1420 t!(fs::write(path, s));
1423 fn read(&self, path: &Path) -> String {
1424 if self.config.dry_run {
1425 return String::new();
1427 t!(fs::read_to_string(path))
1430 fn create_dir(&self, dir: &Path) {
1431 if self.config.dry_run {
1434 t!(fs::create_dir_all(dir))
1437 fn remove_dir(&self, dir: &Path) {
1438 if self.config.dry_run {
1441 t!(fs::remove_dir_all(dir))
1444 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1445 let iter = match fs::read_dir(dir) {
1447 Err(_) if self.config.dry_run => return vec![].into_iter(),
1448 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1450 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1453 fn remove(&self, f: &Path) {
1454 if self.config.dry_run {
1457 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1460 /// Returns if config.ninja is enabled, and checks for ninja existence,
1461 /// exiting with a nicer error message if not.
1462 fn ninja(&self) -> bool {
1463 let mut cmd_finder = crate::sanity::Finder::new();
1465 if self.config.ninja_in_file {
1466 // Some Linux distros rename `ninja` to `ninja-build`.
1467 // CMake can work with either binary name.
1468 if cmd_finder.maybe_have("ninja-build").is_none()
1469 && cmd_finder.maybe_have("ninja").is_none()
1473 Couldn't find required command: ninja (or ninja-build)
1475 You should install ninja as described at
1476 <https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages>,
1477 or set `ninja = false` in the `[llvm]` section of `config.toml`.
1478 Alternatively, set `download-ci-llvm = true` in that `[llvm]` section
1479 to download LLVM rather than building it.
1482 std::process::exit(1);
1486 // If ninja isn't enabled but we're building for MSVC then we try
1487 // doubly hard to enable it. It was realized in #43767 that the msbuild
1488 // CMake generator for MSVC doesn't respect configuration options like
1489 // disabling LLVM assertions, which can often be quite important!
1491 // In these cases we automatically enable Ninja if we find it in the
1493 if !self.config.ninja_in_file && self.config.build.contains("msvc") {
1494 if cmd_finder.maybe_have("ninja").is_some() {
1499 self.config.ninja_in_file
1504 fn chmod(path: &Path, perms: u32) {
1505 use std::os::unix::fs::*;
1506 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1509 fn chmod(_path: &Path, _perms: u32) {}
1512 pub fn with_stage(mut self, stage: u32) -> Compiler {
1517 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1518 pub fn is_snapshot(&self, build: &Build) -> bool {
1519 self.stage == 0 && self.host == build.build
1522 /// Returns if this compiler should be treated as a final stage one in the
1523 /// current build session.
1524 /// This takes into account whether we're performing a full bootstrap or
1525 /// not; don't directly compare the stage with `2`!
1526 pub fn is_final_stage(&self, build: &Build) -> bool {
1527 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1528 self.stage >= final_stage
1532 fn envify(s: &str) -> String {
1538 .flat_map(|c| c.to_uppercase())