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 #![feature(drain_filter)]
108 use std::cell::{Cell, RefCell};
109 use std::collections::{HashMap, HashSet};
111 use std::fs::{self, File, OpenOptions};
112 use std::io::{Read, Seek, SeekFrom, Write};
113 use std::path::{Path, PathBuf};
114 use std::process::{self, Command};
119 use std::os::unix::fs::symlink as symlink_file;
121 use std::os::windows::fs::symlink_file;
123 use build_helper::{mtime, output, run, run_suppressed, t, try_run, try_run_suppressed};
124 use filetime::FileTime;
126 use crate::config::TargetSelection;
127 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 use crate::flags::Subcommand;
172 const LLVM_TOOLS: &[&str] = &[
173 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
174 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
175 "llvm-objdump", // used to disassemble programs
176 "llvm-profdata", // used to inspect and merge files generated by profiles
177 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
178 "llvm-size", // used to prints the size of the linker sections of a program
179 "llvm-strip", // used to discard symbols from binary files to reduce their size
180 "llvm-ar", // used for creating and modifying archive files
183 /// A structure representing a Rust compiler.
185 /// Each compiler has a `stage` that it is associated with and a `host` that
186 /// corresponds to the platform the compiler runs on. This structure is used as
187 /// a parameter to many methods below.
188 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
189 pub struct Compiler {
191 host: TargetSelection,
194 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
196 /// Run normal tests and doc tests (default).
198 /// Do not run any doc tests.
200 /// Only run doc tests.
209 /// Global configuration for the build system.
211 /// This structure transitively contains all configuration for the build system.
212 /// All filesystem-encoded configuration is in `config`, all flags are in
213 /// `flags`, and then parsed or probed information is listed in the keys below.
215 /// This structure is a parameter of almost all methods in the build system,
216 /// although most functions are implemented as free functions rather than
217 /// methods specifically on this structure itself (to make it easier to
220 /// User-specified configuration from `config.toml`.
223 // Properties derived from the above configuration
226 rust_info: channel::GitInfo,
227 cargo_info: channel::GitInfo,
228 rls_info: channel::GitInfo,
229 rust_analyzer_info: channel::GitInfo,
230 clippy_info: channel::GitInfo,
231 miri_info: channel::GitInfo,
232 rustfmt_info: channel::GitInfo,
233 in_tree_llvm_info: channel::GitInfo,
239 // Targets for which to build
240 build: TargetSelection,
241 hosts: Vec<TargetSelection>,
242 targets: Vec<TargetSelection>,
244 // Stage 0 (downloaded) compiler, lld and cargo or their local rust equivalents
245 initial_rustc: PathBuf,
246 initial_cargo: PathBuf,
247 initial_lld: PathBuf,
248 initial_libdir: PathBuf,
250 // Runtime state filled in later on
251 // C/C++ compilers and archiver for all targets
252 cc: HashMap<TargetSelection, cc::Tool>,
253 cxx: HashMap<TargetSelection, cc::Tool>,
254 ar: HashMap<TargetSelection, PathBuf>,
255 ranlib: HashMap<TargetSelection, PathBuf>,
257 crates: HashMap<Interned<String>, Crate>,
260 delayed_failures: RefCell<Vec<String>>,
261 prerelease_version: Cell<Option<u32>>,
263 RefCell<HashMap<TargetSelection, HashMap<String, (&'static str, PathBuf, Vec<String>)>>>,
268 name: Interned<String>,
269 deps: HashSet<Interned<String>>,
275 fn local_path(&self, build: &Build) -> PathBuf {
276 self.path.strip_prefix(&build.config.src).unwrap().into()
280 /// When building Rust various objects are handled differently.
281 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
282 pub enum DependencyType {
283 /// Libraries originating from proc-macros.
285 /// Typical Rust libraries.
287 /// Non Rust libraries and objects shipped to ease usage of certain targets.
291 /// The various "modes" of invoking Cargo.
293 /// These entries currently correspond to the various output directories of the
294 /// build system, with each mod generating output in a different directory.
295 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
297 /// Build the standard library, placing output in the "stageN-std" directory.
300 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
303 /// Build codegen libraries, placing output in the "stageN-codegen" directory
306 /// Build a tool, placing output in the "stage0-bootstrap-tools"
307 /// directory. This is for miscellaneous sets of tools that are built
308 /// using the bootstrap stage0 compiler in its entirety (target libraries
309 /// and all). Typically these tools compile with stable Rust.
312 /// Build a tool which uses the locally built std, placing output in the
313 /// "stageN-tools" directory. Its usage is quite rare, mainly used by
314 /// compiletest which needs libtest.
317 /// Build a tool which uses the locally built rustc and the target std,
318 /// placing the output in the "stageN-tools" directory. This is used for
319 /// anything that needs a fully functional rustc, such as rustdoc, clippy,
320 /// cargo, rls, rustfmt, miri, etc.
325 pub fn is_tool(&self) -> bool {
326 matches!(self, Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd)
331 /// Creates a new set of build configuration from the `flags` on the command
332 /// line and the filesystem `config`.
334 /// By default all build output will be placed in the current directory.
335 pub fn new(config: Config) -> Build {
336 let src = config.src.clone();
337 let out = config.out.clone();
339 let is_sudo = match env::var_os("SUDO_USER") {
340 Some(sudo_user) => match env::var_os("USER") {
341 Some(user) => user != sudo_user,
347 let ignore_git = config.ignore_git;
348 let rust_info = channel::GitInfo::new(ignore_git, &src);
349 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
350 let rls_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rls"));
351 let rust_analyzer_info =
352 channel::GitInfo::new(ignore_git, &src.join("src/tools/rust-analyzer"));
353 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
354 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
355 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
357 // we always try to use git for LLVM builds
358 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
360 let initial_target_libdir_str = if config.dry_run {
361 "/dummy/lib/path/to/lib/".to_string()
364 Command::new(&config.initial_rustc)
366 .arg(config.build.rustc_target_arg())
368 .arg("target-libdir"),
371 let initial_target_dir = Path::new(&initial_target_libdir_str).parent().unwrap();
372 let initial_lld = initial_target_dir.join("bin").join("rust-lld");
374 let initial_sysroot = if config.dry_run {
377 output(Command::new(&config.initial_rustc).arg("--print").arg("sysroot"))
379 let initial_libdir = initial_target_dir
384 .strip_prefix(initial_sysroot.trim())
388 let mut build = Build {
389 initial_rustc: config.initial_rustc.clone(),
390 initial_cargo: config.initial_cargo.clone(),
393 local_rebuild: config.local_rebuild,
394 fail_fast: config.cmd.fail_fast(),
395 doc_tests: config.cmd.doc_tests(),
396 verbosity: config.verbose,
399 hosts: config.hosts.clone(),
400 targets: config.targets.clone(),
417 ranlib: HashMap::new(),
418 crates: HashMap::new(),
420 ci_env: CiEnv::current(),
421 delayed_failures: RefCell::new(Vec::new()),
422 prerelease_version: Cell::new(None),
423 tool_artifacts: Default::default(),
426 build.verbose("finding compilers");
427 cc_detect::find(&mut build);
428 build.verbose("running sanity check");
429 sanity::check(&mut build);
431 // If local-rust is the same major.minor as the current version, then force a
433 let local_version_verbose =
434 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
435 let local_release = local_version_verbose
437 .filter_map(|x| x.strip_prefix("release:"))
441 let my_version = channel::CFG_RELEASE_NUM;
442 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
443 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
444 build.local_rebuild = true;
447 build.verbose("learning about cargo");
448 metadata::build(&mut build);
453 pub fn build_triple(&self) -> &[Interned<String>] {
454 slice::from_ref(&self.build.triple)
457 /// Executes the entire build, as configured by the flags and configuration.
458 pub fn build(&mut self) {
463 if let Subcommand::Format { check } = self.config.cmd {
464 return format::format(self, check);
467 if let Subcommand::Clean { all } = self.config.cmd {
468 return clean::clean(self, all);
472 let builder = builder::Builder::new(&self);
473 if let Some(path) = builder.paths.get(0) {
474 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
480 if !self.config.dry_run {
482 self.config.dry_run = true;
483 let builder = builder::Builder::new(&self);
484 builder.execute_cli();
486 self.config.dry_run = false;
487 let builder = builder::Builder::new(&self);
488 builder.execute_cli();
490 let builder = builder::Builder::new(&self);
491 builder.execute_cli();
494 // Check for postponed failures from `test --no-fail-fast`.
495 let failures = self.delayed_failures.borrow();
496 if failures.len() > 0 {
497 println!("\n{} command(s) did not execute successfully:\n", failures.len());
498 for failure in failures.iter() {
499 println!(" - {}\n", failure);
505 /// Clear out `dir` if `input` is newer.
507 /// After this executes, it will also ensure that `dir` exists.
508 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
509 let stamp = dir.join(".stamp");
510 let mut cleared = false;
511 if mtime(&stamp) < mtime(input) {
512 self.verbose(&format!("Dirty - {}", dir.display()));
513 let _ = fs::remove_dir_all(dir);
515 } else if stamp.exists() {
518 t!(fs::create_dir_all(dir));
519 t!(File::create(stamp));
523 /// Gets the space-separated set of activated features for the standard
525 fn std_features(&self) -> String {
526 let mut features = "panic-unwind".to_string();
528 if self.config.llvm_libunwind {
529 features.push_str(" llvm-libunwind");
531 if self.config.backtrace {
532 features.push_str(" backtrace");
534 if self.config.profiler {
535 features.push_str(" profiler");
540 /// Gets the space-separated set of activated features for the compiler.
541 fn rustc_features(&self) -> String {
542 let mut features = String::new();
543 if self.config.jemalloc {
544 features.push_str("jemalloc");
546 if self.config.llvm_enabled() {
547 features.push_str(" llvm");
552 /// Component directory that Cargo will produce output into (e.g.
554 fn cargo_dir(&self) -> &'static str {
555 if self.config.rust_optimize { "release" } else { "debug" }
558 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
561 .join(&*compiler.host.triple)
562 .join(format!("stage{}-tools-bin", compiler.stage));
563 t!(fs::create_dir_all(&out));
567 /// Returns the root directory for all output generated in a particular
568 /// stage when running with a particular host compiler.
570 /// The mode indicates what the root directory is for.
571 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
572 let suffix = match mode {
574 Mode::Rustc => "-rustc",
575 Mode::Codegen => "-codegen",
576 Mode::ToolBootstrap => "-bootstrap-tools",
577 Mode::ToolStd | Mode::ToolRustc => "-tools",
579 self.out.join(&*compiler.host.triple).join(format!("stage{}{}", compiler.stage, suffix))
582 /// Returns the root output directory for all Cargo output in a given stage,
583 /// running a particular compiler, whether or not we're building the
584 /// standard library, and targeting the specified architecture.
585 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: TargetSelection) -> PathBuf {
586 self.stage_out(compiler, mode).join(&*target.triple).join(self.cargo_dir())
589 /// Root output directory for LLVM compiled for `target`
591 /// Note that if LLVM is configured externally then the directory returned
592 /// will likely be empty.
593 fn llvm_out(&self, target: TargetSelection) -> PathBuf {
594 self.out.join(&*target.triple).join("llvm")
597 fn lld_out(&self, target: TargetSelection) -> PathBuf {
598 self.out.join(&*target.triple).join("lld")
601 /// Output directory for all documentation for a target
602 fn doc_out(&self, target: TargetSelection) -> PathBuf {
603 self.out.join(&*target.triple).join("doc")
606 /// Output directory for all documentation for a target
607 fn compiler_doc_out(&self, target: TargetSelection) -> PathBuf {
608 self.out.join(&*target.triple).join("compiler-doc")
611 /// Output directory for some generated md crate documentation for a target (temporary)
612 fn md_doc_out(&self, target: TargetSelection) -> Interned<PathBuf> {
613 INTERNER.intern_path(self.out.join(&*target.triple).join("md-doc"))
616 /// Returns `true` if no custom `llvm-config` is set for the specified target.
618 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
619 fn is_rust_llvm(&self, target: TargetSelection) -> bool {
620 match self.config.target_config.get(&target) {
621 Some(ref c) => c.llvm_config.is_none(),
626 /// Returns the path to `FileCheck` binary for the specified target
627 fn llvm_filecheck(&self, target: TargetSelection) -> PathBuf {
628 let target_config = self.config.target_config.get(&target);
629 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
631 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
632 let llvm_bindir = output(Command::new(s).arg("--bindir"));
633 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", target));
634 if filecheck.exists() {
637 // On Fedora the system LLVM installs FileCheck in the
638 // llvm subdirectory of the libdir.
639 let llvm_libdir = output(Command::new(s).arg("--libdir"));
641 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", target));
642 if lib_filecheck.exists() {
645 // Return the most normal file name, even though
646 // it doesn't exist, so that any error message
652 let base = self.llvm_out(self.config.build).join("build");
653 let base = if !self.config.ninja && self.config.build.contains("msvc") {
654 if self.config.llvm_optimize {
655 if self.config.llvm_release_debuginfo {
656 base.join("RelWithDebInfo")
666 base.join("bin").join(exe("FileCheck", target))
670 /// Directory for libraries built from C/C++ code and shared between stages.
671 fn native_dir(&self, target: TargetSelection) -> PathBuf {
672 self.out.join(&*target.triple).join("native")
675 /// Root output directory for rust_test_helpers library compiled for
677 fn test_helpers_out(&self, target: TargetSelection) -> PathBuf {
678 self.native_dir(target).join("rust-test-helpers")
681 /// Adds the `RUST_TEST_THREADS` env var if necessary
682 fn add_rust_test_threads(&self, cmd: &mut Command) {
683 if env::var_os("RUST_TEST_THREADS").is_none() {
684 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
688 /// Returns the libdir of the snapshot compiler.
689 fn rustc_snapshot_libdir(&self) -> PathBuf {
690 self.rustc_snapshot_sysroot().join(libdir(self.config.build))
693 /// Returns the sysroot of the snapshot compiler.
694 fn rustc_snapshot_sysroot(&self) -> &Path {
695 self.initial_rustc.parent().unwrap().parent().unwrap()
698 /// Runs a command, printing out nice contextual information if it fails.
699 fn run(&self, cmd: &mut Command) {
700 if self.config.dry_run {
703 self.verbose(&format!("running: {:?}", cmd));
707 /// Runs a command, printing out nice contextual information if it fails.
708 fn run_quiet(&self, cmd: &mut Command) {
709 if self.config.dry_run {
712 self.verbose(&format!("running: {:?}", cmd));
716 /// Runs a command, printing out nice contextual information if it fails.
717 /// Exits if the command failed to execute at all, otherwise returns its
718 /// `status.success()`.
719 fn try_run(&self, cmd: &mut Command) -> bool {
720 if self.config.dry_run {
723 self.verbose(&format!("running: {:?}", cmd));
727 /// Runs a command, printing out nice contextual information if it fails.
728 /// Exits if the command failed to execute at all, otherwise returns its
729 /// `status.success()`.
730 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
731 if self.config.dry_run {
734 self.verbose(&format!("running: {:?}", cmd));
735 try_run_suppressed(cmd)
738 pub fn is_verbose(&self) -> bool {
742 /// Prints a message if this build is configured in verbose mode.
743 fn verbose(&self, msg: &str) {
744 if self.is_verbose() {
749 pub fn is_verbose_than(&self, level: usize) -> bool {
750 self.verbosity > level
753 /// Prints a message if this build is configured in more verbose mode than `level`.
754 fn verbose_than(&self, level: usize, msg: &str) {
755 if self.is_verbose_than(level) {
760 fn info(&self, msg: &str) {
761 if self.config.dry_run {
767 /// Returns the number of parallel jobs that have been configured for this
769 fn jobs(&self) -> u32 {
770 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
773 fn debuginfo_map_to(&self, which: GitRepo) -> Option<String> {
774 if !self.config.rust_remap_debuginfo {
780 let sha = self.rust_sha().unwrap_or(channel::CFG_RELEASE_NUM);
781 Some(format!("/rustc/{}", sha))
783 GitRepo::Llvm => Some(String::from("/rustc/llvm")),
787 /// Returns the path to the C compiler for the target specified.
788 fn cc(&self, target: TargetSelection) -> &Path {
789 self.cc[&target].path()
792 /// Returns a list of flags to pass to the C compiler for the target
794 fn cflags(&self, target: TargetSelection, which: GitRepo) -> Vec<String> {
795 // Filter out -O and /O (the optimization flags) that we picked up from
796 // cc-rs because the build scripts will determine that for themselves.
797 let mut base = self.cc[&target]
800 .map(|s| s.to_string_lossy().into_owned())
801 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
802 .collect::<Vec<String>>();
804 // If we're compiling on macOS then we add a few unconditional flags
805 // indicating that we want libc++ (more filled out than libstdc++) and
806 // we want to compile for 10.7. This way we can ensure that
807 // LLVM/etc are all properly compiled.
808 if target.contains("apple-darwin") {
809 base.push("-stdlib=libc++".into());
812 // Work around an apparently bad MinGW / GCC optimization,
813 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
814 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
815 if &*target.triple == "i686-pc-windows-gnu" {
816 base.push("-fno-omit-frame-pointer".into());
819 if let Some(map_to) = self.debuginfo_map_to(which) {
820 let map = format!("{}={}", self.src.display(), map_to);
821 let cc = self.cc(target);
822 if cc.ends_with("clang") || cc.ends_with("gcc") {
823 base.push(format!("-fdebug-prefix-map={}", map));
824 } else if cc.ends_with("clang-cl.exe") {
825 base.push("-Xclang".into());
826 base.push(format!("-fdebug-prefix-map={}", map));
832 /// Returns the path to the `ar` archive utility for the target specified.
833 fn ar(&self, target: TargetSelection) -> Option<&Path> {
834 self.ar.get(&target).map(|p| &**p)
837 /// Returns the path to the `ranlib` utility for the target specified.
838 fn ranlib(&self, target: TargetSelection) -> Option<&Path> {
839 self.ranlib.get(&target).map(|p| &**p)
842 /// Returns the path to the C++ compiler for the target specified.
843 fn cxx(&self, target: TargetSelection) -> Result<&Path, String> {
844 match self.cxx.get(&target) {
845 Some(p) => Ok(p.path()),
847 Err(format!("target `{}` is not configured as a host, only as a target", target))
852 /// Returns the path to the linker for the given target if it needs to be overridden.
853 fn linker(&self, target: TargetSelection, can_use_lld: bool) -> Option<&Path> {
854 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
857 } else if target.contains("vxworks") {
858 // need to use CXX compiler as linker to resolve the exception functions
859 // that are only existed in CXX libraries
860 Some(self.cxx[&target].path())
861 } else if target != self.config.build
862 && util::use_host_linker(target)
863 && !target.contains("msvc")
865 Some(self.cc(target))
866 } else if can_use_lld && self.config.use_lld && self.build == target {
867 Some(&self.initial_lld)
873 /// Returns if this target should statically link the C runtime, if specified
874 fn crt_static(&self, target: TargetSelection) -> Option<bool> {
875 if target.contains("pc-windows-msvc") {
878 self.config.target_config.get(&target).and_then(|t| t.crt_static)
882 /// Returns the "musl root" for this `target`, if defined
883 fn musl_root(&self, target: TargetSelection) -> Option<&Path> {
887 .and_then(|t| t.musl_root.as_ref())
888 .or_else(|| self.config.musl_root.as_ref())
892 /// Returns the "musl libdir" for this `target`.
893 fn musl_libdir(&self, target: TargetSelection) -> Option<PathBuf> {
894 let t = self.config.target_config.get(&target)?;
895 if let libdir @ Some(_) = &t.musl_libdir {
896 return libdir.clone();
898 self.musl_root(target).map(|root| root.join("lib"))
901 /// Returns the sysroot for the wasi target, if defined
902 fn wasi_root(&self, target: TargetSelection) -> Option<&Path> {
903 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
906 /// Returns `true` if this is a no-std `target`, if defined
907 fn no_std(&self, target: TargetSelection) -> Option<bool> {
908 self.config.target_config.get(&target).map(|t| t.no_std)
911 /// Returns `true` if the target will be tested using the `remote-test-client`
912 /// and `remote-test-server` binaries.
913 fn remote_tested(&self, target: TargetSelection) -> bool {
914 self.qemu_rootfs(target).is_some()
915 || target.contains("android")
916 || env::var_os("TEST_DEVICE_ADDR").is_some()
919 /// Returns the root of the "rootfs" image that this target will be using,
920 /// if one was configured.
922 /// If `Some` is returned then that means that tests for this target are
923 /// emulated with QEMU and binaries will need to be shipped to the emulator.
924 fn qemu_rootfs(&self, target: TargetSelection) -> Option<&Path> {
925 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
928 /// Path to the python interpreter to use
929 fn python(&self) -> &Path {
930 self.config.python.as_ref().unwrap()
933 /// Temporary directory that extended error information is emitted to.
934 fn extended_error_dir(&self) -> PathBuf {
935 self.out.join("tmp/extended-error-metadata")
938 /// Tests whether the `compiler` compiling for `target` should be forced to
939 /// use a stage1 compiler instead.
941 /// Currently, by default, the build system does not perform a "full
942 /// bootstrap" by default where we compile the compiler three times.
943 /// Instead, we compile the compiler two times. The final stage (stage2)
944 /// just copies the libraries from the previous stage, which is what this
947 /// Here we return `true` if:
949 /// * The build isn't performing a full bootstrap
950 /// * The `compiler` is in the final stage, 2
951 /// * We're not cross-compiling, so the artifacts are already available in
954 /// When all of these conditions are met the build will lift artifacts from
955 /// the previous stage forward.
956 fn force_use_stage1(&self, compiler: Compiler, target: TargetSelection) -> bool {
957 !self.config.full_bootstrap
958 && compiler.stage >= 2
959 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
962 /// Given `num` in the form "a.b.c" return a "release string" which
963 /// describes the release version number.
965 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
966 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
967 fn release(&self, num: &str) -> String {
968 match &self.config.channel[..] {
969 "stable" => num.to_string(),
971 if self.rust_info.is_git() {
972 format!("{}-beta.{}", num, self.beta_prerelease_version())
974 format!("{}-beta", num)
977 "nightly" => format!("{}-nightly", num),
978 _ => format!("{}-dev", num),
982 fn beta_prerelease_version(&self) -> u32 {
983 if let Some(s) = self.prerelease_version.get() {
987 // Figure out how many merge commits happened since we branched off master.
988 // That's our beta number!
989 // (Note that we use a `..` range, not the `...` symmetric difference.)
995 .arg("refs/remotes/origin/master..HEAD")
996 .current_dir(&self.src),
998 let n = count.trim().parse().unwrap();
999 self.prerelease_version.set(Some(n));
1003 /// Returns the value of `release` above for Rust itself.
1004 fn rust_release(&self) -> String {
1005 self.release(channel::CFG_RELEASE_NUM)
1008 /// Returns the "package version" for a component given the `num` release
1011 /// The package version is typically what shows up in the names of tarballs.
1012 /// For channels like beta/nightly it's just the channel name, otherwise
1013 /// it's the `num` provided.
1014 fn package_vers(&self, num: &str) -> String {
1015 match &self.config.channel[..] {
1016 "stable" => num.to_string(),
1017 "beta" => "beta".to_string(),
1018 "nightly" => "nightly".to_string(),
1019 _ => format!("{}-dev", num),
1023 /// Returns the value of `package_vers` above for Rust itself.
1024 fn rust_package_vers(&self) -> String {
1025 self.package_vers(channel::CFG_RELEASE_NUM)
1028 /// Returns the value of `package_vers` above for Cargo
1029 fn cargo_package_vers(&self) -> String {
1030 self.package_vers(&self.release_num("cargo"))
1033 /// Returns the value of `package_vers` above for rls
1034 fn rls_package_vers(&self) -> String {
1035 self.package_vers(&self.release_num("rls"))
1038 /// Returns the value of `package_vers` above for rust-analyzer
1039 fn rust_analyzer_package_vers(&self) -> String {
1040 self.package_vers(&self.release_num("rust-analyzer/crates/rust-analyzer"))
1043 /// Returns the value of `package_vers` above for clippy
1044 fn clippy_package_vers(&self) -> String {
1045 self.package_vers(&self.release_num("clippy"))
1048 /// Returns the value of `package_vers` above for miri
1049 fn miri_package_vers(&self) -> String {
1050 self.package_vers(&self.release_num("miri"))
1053 /// Returns the value of `package_vers` above for rustfmt
1054 fn rustfmt_package_vers(&self) -> String {
1055 self.package_vers(&self.release_num("rustfmt"))
1058 fn llvm_tools_package_vers(&self) -> String {
1059 self.package_vers(channel::CFG_RELEASE_NUM)
1062 fn llvm_tools_vers(&self) -> String {
1066 fn llvm_link_tools_dynamically(&self, target: TargetSelection) -> bool {
1067 target.contains("linux-gnu") || target.contains("apple-darwin")
1070 /// Returns the `version` string associated with this compiler for Rust
1073 /// Note that this is a descriptive string which includes the commit date,
1074 /// sha, version, etc.
1075 fn rust_version(&self) -> String {
1076 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1079 /// Returns the full commit hash.
1080 fn rust_sha(&self) -> Option<&str> {
1081 self.rust_info.sha()
1084 /// Returns the `a.b.c` version that the given package is at.
1085 fn release_num(&self, package: &str) -> String {
1086 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1087 let toml = t!(fs::read_to_string(&toml_file_name));
1088 for line in toml.lines() {
1089 if let Some(stripped) =
1090 line.strip_prefix("version = \"").and_then(|s| s.strip_suffix("\""))
1092 return stripped.to_owned();
1096 panic!("failed to find version in {}'s Cargo.toml", package)
1099 /// Returns `true` if unstable features should be enabled for the compiler
1101 fn unstable_features(&self) -> bool {
1102 match &self.config.channel[..] {
1103 "stable" | "beta" => false,
1104 "nightly" | _ => true,
1108 /// Returns a Vec of all the dependencies of the given root crate,
1109 /// including transitive dependencies and the root itself. Only includes
1110 /// "local" crates (those in the local source tree, not from a registry).
1111 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1112 let mut ret = Vec::new();
1113 let mut list = vec![INTERNER.intern_str(root)];
1114 let mut visited = HashSet::new();
1115 while let Some(krate) = list.pop() {
1116 let krate = &self.crates[&krate];
1118 for dep in &krate.deps {
1119 // Don't include optional deps if their features are not
1120 // enabled. Ideally this would be computed from `cargo
1121 // metadata --features …`, but that is somewhat slow. Just
1122 // skip `build_helper` since there aren't any operations we
1123 // want to perform on it. In the future, we may want to
1124 // consider just filtering all build and dev dependencies in
1126 if visited.insert(dep)
1127 && dep != "build_helper"
1128 && (dep != "profiler_builtins" || self.config.profiler)
1129 && (dep != "rustc_codegen_llvm" || self.config.llvm_enabled())
1138 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, DependencyType)> {
1139 if self.config.dry_run {
1143 let mut paths = Vec::new();
1144 let contents = t!(fs::read(stamp), &stamp);
1145 // This is the method we use for extracting paths from the stamp file passed to us. See
1146 // run_cargo for more information (in compile.rs).
1147 for part in contents.split(|b| *b == 0) {
1148 if part.is_empty() {
1151 let dependency_type = match part[0] as char {
1152 'h' => DependencyType::Host,
1153 's' => DependencyType::TargetSelfContained,
1154 't' => DependencyType::Target,
1155 _ => unreachable!(),
1157 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1158 paths.push((path, dependency_type));
1163 /// Copies a file from `src` to `dst`
1164 pub fn copy(&self, src: &Path, dst: &Path) {
1165 if self.config.dry_run {
1168 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1172 let _ = fs::remove_file(&dst);
1173 let metadata = t!(src.symlink_metadata());
1174 if metadata.file_type().is_symlink() {
1175 let link = t!(fs::read_link(src));
1176 t!(symlink_file(link, dst));
1177 } else if let Ok(()) = fs::hard_link(src, dst) {
1178 // Attempt to "easy copy" by creating a hard link
1179 // (symlinks don't work on windows), but if that fails
1180 // just fall back to a slow `copy` operation.
1182 if let Err(e) = fs::copy(src, dst) {
1183 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1185 t!(fs::set_permissions(dst, metadata.permissions()));
1186 let atime = FileTime::from_last_access_time(&metadata);
1187 let mtime = FileTime::from_last_modification_time(&metadata);
1188 t!(filetime::set_file_times(dst, atime, mtime));
1192 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1193 /// new string for each replacement.)
1194 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1195 if self.config.dry_run {
1198 let mut contents = String::new();
1199 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1200 t!(file.read_to_string(&mut contents));
1201 for &(target, replacement) in replacements {
1202 contents = contents.replace(target, replacement);
1204 t!(file.seek(SeekFrom::Start(0)));
1205 t!(file.set_len(0));
1206 t!(file.write_all(contents.as_bytes()));
1209 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1210 /// when this function is called.
1211 pub fn cp_r(&self, src: &Path, dst: &Path) {
1212 if self.config.dry_run {
1215 for f in self.read_dir(src) {
1216 let path = f.path();
1217 let name = path.file_name().unwrap();
1218 let dst = dst.join(name);
1219 if t!(f.file_type()).is_dir() {
1220 t!(fs::create_dir_all(&dst));
1221 self.cp_r(&path, &dst);
1223 let _ = fs::remove_file(&dst);
1224 self.copy(&path, &dst);
1229 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1230 /// when this function is called. Unwanted files or directories can be skipped
1231 /// by returning `false` from the filter function.
1232 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1233 // Immediately recurse with an empty relative path
1234 self.recurse_(src, dst, Path::new(""), filter)
1237 // Inner function does the actual work
1238 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1239 for f in self.read_dir(src) {
1240 let path = f.path();
1241 let name = path.file_name().unwrap();
1242 let dst = dst.join(name);
1243 let relative = relative.join(name);
1244 // Only copy file or directory if the filter function returns true
1245 if filter(&relative) {
1246 if t!(f.file_type()).is_dir() {
1247 let _ = fs::remove_dir_all(&dst);
1248 self.create_dir(&dst);
1249 self.recurse_(&path, &dst, &relative, filter);
1251 let _ = fs::remove_file(&dst);
1252 self.copy(&path, &dst);
1258 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1259 let file_name = src.file_name().unwrap();
1260 let dest = dest_folder.join(file_name);
1261 self.copy(src, &dest);
1264 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1265 if self.config.dry_run {
1268 let dst = dstdir.join(src.file_name().unwrap());
1269 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1270 t!(fs::create_dir_all(dstdir));
1271 drop(fs::remove_file(&dst));
1274 panic!("Error: File \"{}\" not found!", src.display());
1276 let metadata = t!(src.symlink_metadata());
1277 if let Err(e) = fs::copy(&src, &dst) {
1278 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1280 t!(fs::set_permissions(&dst, metadata.permissions()));
1281 let atime = FileTime::from_last_access_time(&metadata);
1282 let mtime = FileTime::from_last_modification_time(&metadata);
1283 t!(filetime::set_file_times(&dst, atime, mtime));
1288 fn create(&self, path: &Path, s: &str) {
1289 if self.config.dry_run {
1292 t!(fs::write(path, s));
1295 fn read(&self, path: &Path) -> String {
1296 if self.config.dry_run {
1297 return String::new();
1299 t!(fs::read_to_string(path))
1302 fn create_dir(&self, dir: &Path) {
1303 if self.config.dry_run {
1306 t!(fs::create_dir_all(dir))
1309 fn remove_dir(&self, dir: &Path) {
1310 if self.config.dry_run {
1313 t!(fs::remove_dir_all(dir))
1316 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1317 let iter = match fs::read_dir(dir) {
1319 Err(_) if self.config.dry_run => return vec![].into_iter(),
1320 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1322 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1325 fn remove(&self, f: &Path) {
1326 if self.config.dry_run {
1329 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1334 fn chmod(path: &Path, perms: u32) {
1335 use std::os::unix::fs::*;
1336 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1339 fn chmod(_path: &Path, _perms: u32) {}
1342 pub fn with_stage(mut self, stage: u32) -> Compiler {
1347 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1348 pub fn is_snapshot(&self, build: &Build) -> bool {
1349 self.stage == 0 && self.host == build.build
1352 /// Returns if this compiler should be treated as a final stage one in the
1353 /// current build session.
1354 /// This takes into account whether we're performing a full bootstrap or
1355 /// not; don't directly compare the stage with `2`!
1356 pub fn is_final_stage(&self, build: &Build) -> bool {
1357 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1358 self.stage >= final_stage
1362 fn envify(s: &str) -> String {
1368 .flat_map(|c| c.to_uppercase())