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 {
327 Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd => true,
334 /// Creates a new set of build configuration from the `flags` on the command
335 /// line and the filesystem `config`.
337 /// By default all build output will be placed in the current directory.
338 pub fn new(config: Config) -> Build {
339 let src = config.src.clone();
340 let out = config.out.clone();
342 let is_sudo = match env::var_os("SUDO_USER") {
343 Some(sudo_user) => match env::var_os("USER") {
344 Some(user) => user != sudo_user,
350 let ignore_git = config.ignore_git;
351 let rust_info = channel::GitInfo::new(ignore_git, &src);
352 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
353 let rls_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rls"));
354 let rust_analyzer_info =
355 channel::GitInfo::new(ignore_git, &src.join("src/tools/rust-analyzer"));
356 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
357 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
358 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
360 // we always try to use git for LLVM builds
361 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
363 let initial_target_libdir_str = if config.dry_run {
364 "/dummy/lib/path/to/lib/".to_string()
367 Command::new(&config.initial_rustc)
369 .arg(config.build.rustc_target_arg())
371 .arg("target-libdir"),
374 let initial_target_dir = Path::new(&initial_target_libdir_str).parent().unwrap();
375 let initial_lld = initial_target_dir.join("bin").join("rust-lld");
377 let initial_sysroot = if config.dry_run {
380 output(Command::new(&config.initial_rustc).arg("--print").arg("sysroot"))
382 let initial_libdir = initial_target_dir
387 .strip_prefix(initial_sysroot.trim())
391 let mut build = Build {
392 initial_rustc: config.initial_rustc.clone(),
393 initial_cargo: config.initial_cargo.clone(),
396 local_rebuild: config.local_rebuild,
397 fail_fast: config.cmd.fail_fast(),
398 doc_tests: config.cmd.doc_tests(),
399 verbosity: config.verbose,
402 hosts: config.hosts.clone(),
403 targets: config.targets.clone(),
420 ranlib: HashMap::new(),
421 crates: HashMap::new(),
423 ci_env: CiEnv::current(),
424 delayed_failures: RefCell::new(Vec::new()),
425 prerelease_version: Cell::new(None),
426 tool_artifacts: Default::default(),
429 build.verbose("finding compilers");
430 cc_detect::find(&mut build);
431 build.verbose("running sanity check");
432 sanity::check(&mut build);
434 // If local-rust is the same major.minor as the current version, then force a
436 let local_version_verbose =
437 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
438 let local_release = local_version_verbose
440 .filter_map(|x| x.strip_prefix("release:"))
444 let my_version = channel::CFG_RELEASE_NUM;
445 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
446 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
447 build.local_rebuild = true;
450 build.verbose("learning about cargo");
451 metadata::build(&mut build);
456 pub fn build_triple(&self) -> &[Interned<String>] {
457 slice::from_ref(&self.build.triple)
460 /// Executes the entire build, as configured by the flags and configuration.
461 pub fn build(&mut self) {
466 if let Subcommand::Format { check } = self.config.cmd {
467 return format::format(self, check);
470 if let Subcommand::Clean { all } = self.config.cmd {
471 return clean::clean(self, all);
475 let builder = builder::Builder::new(&self);
476 if let Some(path) = builder.paths.get(0) {
477 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
483 if !self.config.dry_run {
485 self.config.dry_run = true;
486 let builder = builder::Builder::new(&self);
487 builder.execute_cli();
489 self.config.dry_run = false;
490 let builder = builder::Builder::new(&self);
491 builder.execute_cli();
493 let builder = builder::Builder::new(&self);
494 builder.execute_cli();
497 // Check for postponed failures from `test --no-fail-fast`.
498 let failures = self.delayed_failures.borrow();
499 if failures.len() > 0 {
500 println!("\n{} command(s) did not execute successfully:\n", failures.len());
501 for failure in failures.iter() {
502 println!(" - {}\n", failure);
508 /// Clear out `dir` if `input` is newer.
510 /// After this executes, it will also ensure that `dir` exists.
511 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
512 let stamp = dir.join(".stamp");
513 let mut cleared = false;
514 if mtime(&stamp) < mtime(input) {
515 self.verbose(&format!("Dirty - {}", dir.display()));
516 let _ = fs::remove_dir_all(dir);
518 } else if stamp.exists() {
521 t!(fs::create_dir_all(dir));
522 t!(File::create(stamp));
526 /// Gets the space-separated set of activated features for the standard
528 fn std_features(&self) -> String {
529 let mut features = "panic-unwind".to_string();
531 if self.config.llvm_libunwind {
532 features.push_str(" llvm-libunwind");
534 if self.config.backtrace {
535 features.push_str(" backtrace");
537 if self.config.profiler {
538 features.push_str(" profiler");
543 /// Gets the space-separated set of activated features for the compiler.
544 fn rustc_features(&self) -> String {
545 let mut features = String::new();
546 if self.config.jemalloc {
547 features.push_str("jemalloc");
549 if self.config.llvm_enabled() {
550 features.push_str(" llvm");
555 /// Component directory that Cargo will produce output into (e.g.
557 fn cargo_dir(&self) -> &'static str {
558 if self.config.rust_optimize { "release" } else { "debug" }
561 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
564 .join(&*compiler.host.triple)
565 .join(format!("stage{}-tools-bin", compiler.stage));
566 t!(fs::create_dir_all(&out));
570 /// Returns the root directory for all output generated in a particular
571 /// stage when running with a particular host compiler.
573 /// The mode indicates what the root directory is for.
574 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
575 let suffix = match mode {
577 Mode::Rustc => "-rustc",
578 Mode::Codegen => "-codegen",
579 Mode::ToolBootstrap => "-bootstrap-tools",
580 Mode::ToolStd | Mode::ToolRustc => "-tools",
582 self.out.join(&*compiler.host.triple).join(format!("stage{}{}", compiler.stage, suffix))
585 /// Returns the root output directory for all Cargo output in a given stage,
586 /// running a particular compiler, whether or not we're building the
587 /// standard library, and targeting the specified architecture.
588 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: TargetSelection) -> PathBuf {
589 self.stage_out(compiler, mode).join(&*target.triple).join(self.cargo_dir())
592 /// Root output directory for LLVM compiled for `target`
594 /// Note that if LLVM is configured externally then the directory returned
595 /// will likely be empty.
596 fn llvm_out(&self, target: TargetSelection) -> PathBuf {
597 self.out.join(&*target.triple).join("llvm")
600 fn lld_out(&self, target: TargetSelection) -> PathBuf {
601 self.out.join(&*target.triple).join("lld")
604 /// Output directory for all documentation for a target
605 fn doc_out(&self, target: TargetSelection) -> PathBuf {
606 self.out.join(&*target.triple).join("doc")
609 /// Output directory for all documentation for a target
610 fn compiler_doc_out(&self, target: TargetSelection) -> PathBuf {
611 self.out.join(&*target.triple).join("compiler-doc")
614 /// Output directory for some generated md crate documentation for a target (temporary)
615 fn md_doc_out(&self, target: TargetSelection) -> Interned<PathBuf> {
616 INTERNER.intern_path(self.out.join(&*target.triple).join("md-doc"))
619 /// Returns `true` if no custom `llvm-config` is set for the specified target.
621 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
622 fn is_rust_llvm(&self, target: TargetSelection) -> bool {
623 match self.config.target_config.get(&target) {
624 Some(ref c) => c.llvm_config.is_none(),
629 /// Returns the path to `FileCheck` binary for the specified target
630 fn llvm_filecheck(&self, target: TargetSelection) -> PathBuf {
631 let target_config = self.config.target_config.get(&target);
632 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
634 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
635 let llvm_bindir = output(Command::new(s).arg("--bindir"));
636 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", target));
637 if filecheck.exists() {
640 // On Fedora the system LLVM installs FileCheck in the
641 // llvm subdirectory of the libdir.
642 let llvm_libdir = output(Command::new(s).arg("--libdir"));
644 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", target));
645 if lib_filecheck.exists() {
648 // Return the most normal file name, even though
649 // it doesn't exist, so that any error message
655 let base = self.llvm_out(self.config.build).join("build");
656 let base = if !self.config.ninja && self.config.build.contains("msvc") {
657 if self.config.llvm_optimize {
658 if self.config.llvm_release_debuginfo {
659 base.join("RelWithDebInfo")
669 base.join("bin").join(exe("FileCheck", target))
673 /// Directory for libraries built from C/C++ code and shared between stages.
674 fn native_dir(&self, target: TargetSelection) -> PathBuf {
675 self.out.join(&*target.triple).join("native")
678 /// Root output directory for rust_test_helpers library compiled for
680 fn test_helpers_out(&self, target: TargetSelection) -> PathBuf {
681 self.native_dir(target).join("rust-test-helpers")
684 /// Adds the `RUST_TEST_THREADS` env var if necessary
685 fn add_rust_test_threads(&self, cmd: &mut Command) {
686 if env::var_os("RUST_TEST_THREADS").is_none() {
687 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
691 /// Returns the libdir of the snapshot compiler.
692 fn rustc_snapshot_libdir(&self) -> PathBuf {
693 self.rustc_snapshot_sysroot().join(libdir(self.config.build))
696 /// Returns the sysroot of the snapshot compiler.
697 fn rustc_snapshot_sysroot(&self) -> &Path {
698 self.initial_rustc.parent().unwrap().parent().unwrap()
701 /// Runs a command, printing out nice contextual information if it fails.
702 fn run(&self, cmd: &mut Command) {
703 if self.config.dry_run {
706 self.verbose(&format!("running: {:?}", cmd));
710 /// Runs a command, printing out nice contextual information if it fails.
711 fn run_quiet(&self, cmd: &mut Command) {
712 if self.config.dry_run {
715 self.verbose(&format!("running: {:?}", cmd));
719 /// Runs a command, printing out nice contextual information if it fails.
720 /// Exits if the command failed to execute at all, otherwise returns its
721 /// `status.success()`.
722 fn try_run(&self, cmd: &mut Command) -> bool {
723 if self.config.dry_run {
726 self.verbose(&format!("running: {:?}", cmd));
730 /// Runs a command, printing out nice contextual information if it fails.
731 /// Exits if the command failed to execute at all, otherwise returns its
732 /// `status.success()`.
733 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
734 if self.config.dry_run {
737 self.verbose(&format!("running: {:?}", cmd));
738 try_run_suppressed(cmd)
741 pub fn is_verbose(&self) -> bool {
745 /// Prints a message if this build is configured in verbose mode.
746 fn verbose(&self, msg: &str) {
747 if self.is_verbose() {
752 pub fn is_verbose_than(&self, level: usize) -> bool {
753 self.verbosity > level
756 /// Prints a message if this build is configured in more verbose mode than `level`.
757 fn verbose_than(&self, level: usize, msg: &str) {
758 if self.is_verbose_than(level) {
763 fn info(&self, msg: &str) {
764 if self.config.dry_run {
770 /// Returns the number of parallel jobs that have been configured for this
772 fn jobs(&self) -> u32 {
773 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
776 fn debuginfo_map_to(&self, which: GitRepo) -> Option<String> {
777 if !self.config.rust_remap_debuginfo {
783 let sha = self.rust_sha().unwrap_or(channel::CFG_RELEASE_NUM);
784 Some(format!("/rustc/{}", sha))
786 GitRepo::Llvm => Some(String::from("/rustc/llvm")),
790 /// Returns the path to the C compiler for the target specified.
791 fn cc(&self, target: TargetSelection) -> &Path {
792 self.cc[&target].path()
795 /// Returns a list of flags to pass to the C compiler for the target
797 fn cflags(&self, target: TargetSelection, which: GitRepo) -> Vec<String> {
798 // Filter out -O and /O (the optimization flags) that we picked up from
799 // cc-rs because the build scripts will determine that for themselves.
800 let mut base = self.cc[&target]
803 .map(|s| s.to_string_lossy().into_owned())
804 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
805 .collect::<Vec<String>>();
807 // If we're compiling on macOS then we add a few unconditional flags
808 // indicating that we want libc++ (more filled out than libstdc++) and
809 // we want to compile for 10.7. This way we can ensure that
810 // LLVM/etc are all properly compiled.
811 if target.contains("apple-darwin") {
812 base.push("-stdlib=libc++".into());
815 // Work around an apparently bad MinGW / GCC optimization,
816 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
817 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
818 if &*target.triple == "i686-pc-windows-gnu" {
819 base.push("-fno-omit-frame-pointer".into());
822 if let Some(map_to) = self.debuginfo_map_to(which) {
823 let map = format!("{}={}", self.src.display(), map_to);
824 let cc = self.cc(target);
825 if cc.ends_with("clang") || cc.ends_with("gcc") {
826 base.push(format!("-fdebug-prefix-map={}", map));
827 } else if cc.ends_with("clang-cl.exe") {
828 base.push("-Xclang".into());
829 base.push(format!("-fdebug-prefix-map={}", map));
835 /// Returns the path to the `ar` archive utility for the target specified.
836 fn ar(&self, target: TargetSelection) -> Option<&Path> {
837 self.ar.get(&target).map(|p| &**p)
840 /// Returns the path to the `ranlib` utility for the target specified.
841 fn ranlib(&self, target: TargetSelection) -> Option<&Path> {
842 self.ranlib.get(&target).map(|p| &**p)
845 /// Returns the path to the C++ compiler for the target specified.
846 fn cxx(&self, target: TargetSelection) -> Result<&Path, String> {
847 match self.cxx.get(&target) {
848 Some(p) => Ok(p.path()),
850 Err(format!("target `{}` is not configured as a host, only as a target", target))
855 /// Returns the path to the linker for the given target if it needs to be overridden.
856 fn linker(&self, target: TargetSelection, can_use_lld: bool) -> Option<&Path> {
857 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
860 } else if target != self.config.build
861 && util::use_host_linker(target)
862 && !target.contains("msvc")
864 Some(self.cc(target))
865 } else if can_use_lld && self.config.use_lld && self.build == target {
866 Some(&self.initial_lld)
872 /// Returns if this target should statically link the C runtime, if specified
873 fn crt_static(&self, target: TargetSelection) -> Option<bool> {
874 if target.contains("pc-windows-msvc") {
877 self.config.target_config.get(&target).and_then(|t| t.crt_static)
881 /// Returns the "musl root" for this `target`, if defined
882 fn musl_root(&self, target: TargetSelection) -> Option<&Path> {
886 .and_then(|t| t.musl_root.as_ref())
887 .or_else(|| self.config.musl_root.as_ref())
891 /// Returns the "musl libdir" for this `target`.
892 fn musl_libdir(&self, target: TargetSelection) -> Option<PathBuf> {
893 let t = self.config.target_config.get(&target)?;
894 if let libdir @ Some(_) = &t.musl_libdir {
895 return libdir.clone();
897 self.musl_root(target).map(|root| root.join("lib"))
900 /// Returns the sysroot for the wasi target, if defined
901 fn wasi_root(&self, target: TargetSelection) -> Option<&Path> {
902 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
905 /// Returns `true` if this is a no-std `target`, if defined
906 fn no_std(&self, target: TargetSelection) -> Option<bool> {
907 self.config.target_config.get(&target).map(|t| t.no_std)
910 /// Returns `true` if the target will be tested using the `remote-test-client`
911 /// and `remote-test-server` binaries.
912 fn remote_tested(&self, target: TargetSelection) -> bool {
913 self.qemu_rootfs(target).is_some()
914 || target.contains("android")
915 || env::var_os("TEST_DEVICE_ADDR").is_some()
918 /// Returns the root of the "rootfs" image that this target will be using,
919 /// if one was configured.
921 /// If `Some` is returned then that means that tests for this target are
922 /// emulated with QEMU and binaries will need to be shipped to the emulator.
923 fn qemu_rootfs(&self, target: TargetSelection) -> Option<&Path> {
924 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
927 /// Path to the python interpreter to use
928 fn python(&self) -> &Path {
929 self.config.python.as_ref().unwrap()
932 /// Temporary directory that extended error information is emitted to.
933 fn extended_error_dir(&self) -> PathBuf {
934 self.out.join("tmp/extended-error-metadata")
937 /// Tests whether the `compiler` compiling for `target` should be forced to
938 /// use a stage1 compiler instead.
940 /// Currently, by default, the build system does not perform a "full
941 /// bootstrap" by default where we compile the compiler three times.
942 /// Instead, we compile the compiler two times. The final stage (stage2)
943 /// just copies the libraries from the previous stage, which is what this
946 /// Here we return `true` if:
948 /// * The build isn't performing a full bootstrap
949 /// * The `compiler` is in the final stage, 2
950 /// * We're not cross-compiling, so the artifacts are already available in
953 /// When all of these conditions are met the build will lift artifacts from
954 /// the previous stage forward.
955 fn force_use_stage1(&self, compiler: Compiler, target: TargetSelection) -> bool {
956 !self.config.full_bootstrap
957 && compiler.stage >= 2
958 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
961 /// Given `num` in the form "a.b.c" return a "release string" which
962 /// describes the release version number.
964 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
965 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
966 fn release(&self, num: &str) -> String {
967 match &self.config.channel[..] {
968 "stable" => num.to_string(),
970 if self.rust_info.is_git() {
971 format!("{}-beta.{}", num, self.beta_prerelease_version())
973 format!("{}-beta", num)
976 "nightly" => format!("{}-nightly", num),
977 _ => format!("{}-dev", num),
981 fn beta_prerelease_version(&self) -> u32 {
982 if let Some(s) = self.prerelease_version.get() {
986 // Figure out how many merge commits happened since we branched off master.
987 // That's our beta number!
988 // (Note that we use a `..` range, not the `...` symmetric difference.)
994 .arg("refs/remotes/origin/master..HEAD")
995 .current_dir(&self.src),
997 let n = count.trim().parse().unwrap();
998 self.prerelease_version.set(Some(n));
1002 /// Returns the value of `release` above for Rust itself.
1003 fn rust_release(&self) -> String {
1004 self.release(channel::CFG_RELEASE_NUM)
1007 /// Returns the "package version" for a component given the `num` release
1010 /// The package version is typically what shows up in the names of tarballs.
1011 /// For channels like beta/nightly it's just the channel name, otherwise
1012 /// it's the `num` provided.
1013 fn package_vers(&self, num: &str) -> String {
1014 match &self.config.channel[..] {
1015 "stable" => num.to_string(),
1016 "beta" => "beta".to_string(),
1017 "nightly" => "nightly".to_string(),
1018 _ => format!("{}-dev", num),
1022 /// Returns the value of `package_vers` above for Rust itself.
1023 fn rust_package_vers(&self) -> String {
1024 self.package_vers(channel::CFG_RELEASE_NUM)
1027 /// Returns the value of `package_vers` above for Cargo
1028 fn cargo_package_vers(&self) -> String {
1029 self.package_vers(&self.release_num("cargo"))
1032 /// Returns the value of `package_vers` above for rls
1033 fn rls_package_vers(&self) -> String {
1034 self.package_vers(&self.release_num("rls"))
1037 /// Returns the value of `package_vers` above for rust-analyzer
1038 fn rust_analyzer_package_vers(&self) -> String {
1039 self.package_vers(&self.release_num("rust-analyzer/crates/rust-analyzer"))
1042 /// Returns the value of `package_vers` above for clippy
1043 fn clippy_package_vers(&self) -> String {
1044 self.package_vers(&self.release_num("clippy"))
1047 /// Returns the value of `package_vers` above for miri
1048 fn miri_package_vers(&self) -> String {
1049 self.package_vers(&self.release_num("miri"))
1052 /// Returns the value of `package_vers` above for rustfmt
1053 fn rustfmt_package_vers(&self) -> String {
1054 self.package_vers(&self.release_num("rustfmt"))
1057 fn llvm_tools_package_vers(&self) -> String {
1058 self.package_vers(channel::CFG_RELEASE_NUM)
1061 fn llvm_tools_vers(&self) -> String {
1065 fn llvm_link_tools_dynamically(&self, target: TargetSelection) -> bool {
1066 target.contains("linux-gnu") || target.contains("apple-darwin")
1069 /// Returns the `version` string associated with this compiler for Rust
1072 /// Note that this is a descriptive string which includes the commit date,
1073 /// sha, version, etc.
1074 fn rust_version(&self) -> String {
1075 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1078 /// Returns the full commit hash.
1079 fn rust_sha(&self) -> Option<&str> {
1080 self.rust_info.sha()
1083 /// Returns the `a.b.c` version that the given package is at.
1084 fn release_num(&self, package: &str) -> String {
1085 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1086 let toml = t!(fs::read_to_string(&toml_file_name));
1087 for line in toml.lines() {
1088 if let Some(stripped) =
1089 line.strip_prefix("version = \"").and_then(|s| s.strip_suffix("\""))
1091 return stripped.to_owned();
1095 panic!("failed to find version in {}'s Cargo.toml", package)
1098 /// Returns `true` if unstable features should be enabled for the compiler
1100 fn unstable_features(&self) -> bool {
1101 match &self.config.channel[..] {
1102 "stable" | "beta" => false,
1103 "nightly" | _ => true,
1107 /// Returns a Vec of all the dependencies of the given root crate,
1108 /// including transitive dependencies and the root itself. Only includes
1109 /// "local" crates (those in the local source tree, not from a registry).
1110 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1111 let mut ret = Vec::new();
1112 let mut list = vec![INTERNER.intern_str(root)];
1113 let mut visited = HashSet::new();
1114 while let Some(krate) = list.pop() {
1115 let krate = &self.crates[&krate];
1117 for dep in &krate.deps {
1118 // Don't include optional deps if their features are not
1119 // enabled. Ideally this would be computed from `cargo
1120 // metadata --features …`, but that is somewhat slow. Just
1121 // skip `build_helper` since there aren't any operations we
1122 // want to perform on it. In the future, we may want to
1123 // consider just filtering all build and dev dependencies in
1125 if visited.insert(dep)
1126 && dep != "build_helper"
1127 && (dep != "profiler_builtins" || self.config.profiler)
1128 && (dep != "rustc_codegen_llvm" || self.config.llvm_enabled())
1137 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, DependencyType)> {
1138 if self.config.dry_run {
1142 let mut paths = Vec::new();
1143 let contents = t!(fs::read(stamp), &stamp);
1144 // This is the method we use for extracting paths from the stamp file passed to us. See
1145 // run_cargo for more information (in compile.rs).
1146 for part in contents.split(|b| *b == 0) {
1147 if part.is_empty() {
1150 let dependency_type = match part[0] as char {
1151 'h' => DependencyType::Host,
1152 's' => DependencyType::TargetSelfContained,
1153 't' => DependencyType::Target,
1154 _ => unreachable!(),
1156 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1157 paths.push((path, dependency_type));
1162 /// Copies a file from `src` to `dst`
1163 pub fn copy(&self, src: &Path, dst: &Path) {
1164 if self.config.dry_run {
1167 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1171 let _ = fs::remove_file(&dst);
1172 let metadata = t!(src.symlink_metadata());
1173 if metadata.file_type().is_symlink() {
1174 let link = t!(fs::read_link(src));
1175 t!(symlink_file(link, dst));
1176 } else if let Ok(()) = fs::hard_link(src, dst) {
1177 // Attempt to "easy copy" by creating a hard link
1178 // (symlinks don't work on windows), but if that fails
1179 // just fall back to a slow `copy` operation.
1181 if let Err(e) = fs::copy(src, dst) {
1182 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1184 t!(fs::set_permissions(dst, metadata.permissions()));
1185 let atime = FileTime::from_last_access_time(&metadata);
1186 let mtime = FileTime::from_last_modification_time(&metadata);
1187 t!(filetime::set_file_times(dst, atime, mtime));
1191 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1192 /// new string for each replacement.)
1193 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1194 if self.config.dry_run {
1197 let mut contents = String::new();
1198 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1199 t!(file.read_to_string(&mut contents));
1200 for &(target, replacement) in replacements {
1201 contents = contents.replace(target, replacement);
1203 t!(file.seek(SeekFrom::Start(0)));
1204 t!(file.set_len(0));
1205 t!(file.write_all(contents.as_bytes()));
1208 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1209 /// when this function is called.
1210 pub fn cp_r(&self, src: &Path, dst: &Path) {
1211 if self.config.dry_run {
1214 for f in self.read_dir(src) {
1215 let path = f.path();
1216 let name = path.file_name().unwrap();
1217 let dst = dst.join(name);
1218 if t!(f.file_type()).is_dir() {
1219 t!(fs::create_dir_all(&dst));
1220 self.cp_r(&path, &dst);
1222 let _ = fs::remove_file(&dst);
1223 self.copy(&path, &dst);
1228 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1229 /// when this function is called. Unwanted files or directories can be skipped
1230 /// by returning `false` from the filter function.
1231 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1232 // Immediately recurse with an empty relative path
1233 self.recurse_(src, dst, Path::new(""), filter)
1236 // Inner function does the actual work
1237 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1238 for f in self.read_dir(src) {
1239 let path = f.path();
1240 let name = path.file_name().unwrap();
1241 let dst = dst.join(name);
1242 let relative = relative.join(name);
1243 // Only copy file or directory if the filter function returns true
1244 if filter(&relative) {
1245 if t!(f.file_type()).is_dir() {
1246 let _ = fs::remove_dir_all(&dst);
1247 self.create_dir(&dst);
1248 self.recurse_(&path, &dst, &relative, filter);
1250 let _ = fs::remove_file(&dst);
1251 self.copy(&path, &dst);
1257 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1258 let file_name = src.file_name().unwrap();
1259 let dest = dest_folder.join(file_name);
1260 self.copy(src, &dest);
1263 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1264 if self.config.dry_run {
1267 let dst = dstdir.join(src.file_name().unwrap());
1268 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1269 t!(fs::create_dir_all(dstdir));
1270 drop(fs::remove_file(&dst));
1273 panic!("Error: File \"{}\" not found!", src.display());
1275 let metadata = t!(src.symlink_metadata());
1276 if let Err(e) = fs::copy(&src, &dst) {
1277 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1279 t!(fs::set_permissions(&dst, metadata.permissions()));
1280 let atime = FileTime::from_last_access_time(&metadata);
1281 let mtime = FileTime::from_last_modification_time(&metadata);
1282 t!(filetime::set_file_times(&dst, atime, mtime));
1287 fn create(&self, path: &Path, s: &str) {
1288 if self.config.dry_run {
1291 t!(fs::write(path, s));
1294 fn read(&self, path: &Path) -> String {
1295 if self.config.dry_run {
1296 return String::new();
1298 t!(fs::read_to_string(path))
1301 fn create_dir(&self, dir: &Path) {
1302 if self.config.dry_run {
1305 t!(fs::create_dir_all(dir))
1308 fn remove_dir(&self, dir: &Path) {
1309 if self.config.dry_run {
1312 t!(fs::remove_dir_all(dir))
1315 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1316 let iter = match fs::read_dir(dir) {
1318 Err(_) if self.config.dry_run => return vec![].into_iter(),
1319 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1321 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1324 fn remove(&self, f: &Path) {
1325 if self.config.dry_run {
1328 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1333 fn chmod(path: &Path, perms: u32) {
1334 use std::os::unix::fs::*;
1335 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1338 fn chmod(_path: &Path, _perms: u32) {}
1341 pub fn with_stage(mut self, stage: u32) -> Compiler {
1346 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1347 pub fn is_snapshot(&self, build: &Build) -> bool {
1348 self.stage == 0 && self.host == build.build
1351 /// Returns if this compiler should be treated as a final stage one in the
1352 /// current build session.
1353 /// This takes into account whether we're performing a full bootstrap or
1354 /// not; don't directly compare the stage with `2`!
1355 pub fn is_final_stage(&self, build: &Build) -> bool {
1356 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1357 self.stage >= final_stage
1361 fn envify(s: &str) -> String {
1367 .flat_map(|c| c.to_uppercase())