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 #![deny(rust_2018_idioms)]
108 #![feature(core_intrinsics)]
109 #![feature(drain_filter)]
111 use std::cell::{RefCell, Cell};
112 use std::collections::{HashSet, HashMap};
114 use std::fs::{self, OpenOptions, File};
115 use std::io::{Seek, SeekFrom, Write, Read};
116 use std::path::{PathBuf, Path};
117 use std::process::{self, Command};
122 use std::os::unix::fs::symlink as symlink_file;
124 use std::os::windows::fs::symlink_file;
127 mtime, output, run_silent, run_suppressed, t, try_run_silent, try_run_suppressed,
129 use filetime::FileTime;
131 use crate::util::{exe, libdir, OutputFolder, CiEnv};
156 #[cfg(all(unix, not(target_os = "haiku")))]
158 pub unsafe fn setup(build: &mut crate::Build) {
159 if build.config.low_priority {
160 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
165 #[cfg(any(target_os = "haiku", not(any(unix, windows))))]
167 pub unsafe fn setup(_build: &mut crate::Build) {
171 pub use crate::config::Config;
172 use crate::flags::Subcommand;
173 use crate::cache::{Interned, INTERNER};
174 use crate::toolstate::ToolState;
176 const LLVM_TOOLS: &[&str] = &[
177 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
178 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
179 "llvm-objdump", // used to disassemble programs
180 "llvm-profdata", // used to inspect and merge files generated by profiles
181 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
182 "llvm-size", // used to prints the size of the linker sections of a program
183 "llvm-strip", // used to discard symbols from binary files to reduce their size
184 "llvm-ar" // used for creating and modifying archive files
187 /// A structure representing a Rust compiler.
189 /// Each compiler has a `stage` that it is associated with and a `host` that
190 /// corresponds to the platform the compiler runs on. This structure is used as
191 /// a parameter to many methods below.
192 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
193 pub struct Compiler {
195 host: Interned<String>,
198 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
200 // Default, run normal tests and doc tests.
202 // Do not run any doc tests.
204 // Only run doc tests.
213 /// Global configuration for the build system.
215 /// This structure transitively contains all configuration for the build system.
216 /// All filesystem-encoded configuration is in `config`, all flags are in
217 /// `flags`, and then parsed or probed information is listed in the keys below.
219 /// This structure is a parameter of almost all methods in the build system,
220 /// although most functions are implemented as free functions rather than
221 /// methods specifically on this structure itself (to make it easier to
224 // User-specified configuration via config.toml
227 // Derived properties from the above two configurations
230 rust_info: channel::GitInfo,
231 cargo_info: channel::GitInfo,
232 rls_info: channel::GitInfo,
233 clippy_info: channel::GitInfo,
234 miri_info: channel::GitInfo,
235 rustfmt_info: channel::GitInfo,
236 in_tree_llvm_info: channel::GitInfo,
237 emscripten_llvm_info: channel::GitInfo,
243 // Targets for which to build.
244 build: Interned<String>,
245 hosts: Vec<Interned<String>>,
246 targets: Vec<Interned<String>>,
248 // Stage 0 (downloaded) compiler and cargo or their local rust equivalents.
249 initial_rustc: PathBuf,
250 initial_cargo: PathBuf,
252 // Runtime state filled in later on
253 // C/C++ compilers and archiver for all targets
254 cc: HashMap<Interned<String>, cc::Tool>,
255 cxx: HashMap<Interned<String>, cc::Tool>,
256 ar: HashMap<Interned<String>, PathBuf>,
257 ranlib: HashMap<Interned<String>, PathBuf>,
259 crates: HashMap<Interned<String>, Crate>,
262 delayed_failures: RefCell<Vec<String>>,
263 prerelease_version: Cell<Option<u32>>,
264 tool_artifacts: RefCell<HashMap<
266 HashMap<String, (&'static str, PathBuf, Vec<String>)>
272 name: Interned<String>,
274 deps: HashSet<Interned<String>>,
284 fn is_local(&self, build: &Build) -> bool {
285 self.path.starts_with(&build.config.src) &&
286 !self.path.to_string_lossy().ends_with("_shim")
289 fn local_path(&self, build: &Build) -> PathBuf {
290 assert!(self.is_local(build));
291 self.path.strip_prefix(&build.config.src).unwrap().into()
295 /// The various "modes" of invoking Cargo.
297 /// These entries currently correspond to the various output directories of the
298 /// build system, with each mod generating output in a different directory.
299 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
301 /// Build the standard library, placing output in the "stageN-std" directory.
304 /// Build libtest, placing output in the "stageN-test" directory.
307 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
310 /// Build codegen libraries, placing output in the "stageN-codegen" directory
313 /// Build some tools, placing output in the "stageN-tools" directory. The
314 /// "other" here is for miscellaneous sets of tools that are built using the
315 /// bootstrap compiler in its entirety (target libraries and all).
316 /// Typically these tools compile with stable Rust.
319 /// Compile a tool which uses all libraries we compile (up to rustc).
320 /// Doesn't use the stage0 compiler libraries like "other", and includes
321 /// tools like rustdoc, cargo, rls, etc.
328 pub fn is_tool(&self) -> bool {
330 Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd => true,
337 /// Creates a new set of build configuration from the `flags` on the command
338 /// line and the filesystem `config`.
340 /// By default all build output will be placed in the current directory.
341 pub fn new(config: Config) -> Build {
342 let src = config.src.clone();
343 let out = config.out.clone();
345 let is_sudo = match env::var_os("SUDO_USER") {
347 match env::var_os("USER") {
348 Some(user) => user != sudo_user,
355 let ignore_git = config.ignore_git;
356 let rust_info = channel::GitInfo::new(ignore_git, &src);
357 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
358 let rls_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rls"));
359 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
360 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
361 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
363 // we always try to use git for LLVM builds
364 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
365 let emscripten_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-emscripten"));
367 let mut build = Build {
368 initial_rustc: config.initial_rustc.clone(),
369 initial_cargo: config.initial_cargo.clone(),
370 local_rebuild: config.local_rebuild,
371 fail_fast: config.cmd.fail_fast(),
372 doc_tests: config.cmd.doc_tests(),
373 verbosity: config.verbose,
376 hosts: config.hosts.clone(),
377 targets: config.targets.clone(),
390 emscripten_llvm_info,
394 ranlib: HashMap::new(),
395 crates: HashMap::new(),
397 ci_env: CiEnv::current(),
398 delayed_failures: RefCell::new(Vec::new()),
399 prerelease_version: Cell::new(None),
400 tool_artifacts: Default::default(),
403 build.verbose("finding compilers");
404 cc_detect::find(&mut build);
405 build.verbose("running sanity check");
406 sanity::check(&mut build);
408 // If local-rust is the same major.minor as the current version, then force a
410 let local_version_verbose = output(
411 Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
412 let local_release = local_version_verbose
413 .lines().filter(|x| x.starts_with("release:"))
414 .next().unwrap().trim_start_matches("release:").trim();
415 let my_version = channel::CFG_RELEASE_NUM;
416 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
417 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
418 build.local_rebuild = true;
421 build.verbose("learning about cargo");
422 metadata::build(&mut build);
427 pub fn build_triple(&self) -> &[Interned<String>] {
429 slice::from_raw_parts(&self.build, 1)
433 /// Executes the entire build, as configured by the flags and configuration.
434 pub fn build(&mut self) {
439 if let Subcommand::Clean { all } = self.config.cmd {
440 return clean::clean(self, all);
444 let builder = builder::Builder::new(&self);
445 if let Some(path) = builder.paths.get(0) {
446 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
452 if !self.config.dry_run {
454 self.config.dry_run = true;
455 let builder = builder::Builder::new(&self);
456 builder.execute_cli();
458 self.config.dry_run = false;
459 let builder = builder::Builder::new(&self);
460 builder.execute_cli();
462 let builder = builder::Builder::new(&self);
463 let _ = builder.execute_cli();
466 // Check for postponed failures from `test --no-fail-fast`.
467 let failures = self.delayed_failures.borrow();
468 if failures.len() > 0 {
469 println!("\n{} command(s) did not execute successfully:\n", failures.len());
470 for failure in failures.iter() {
471 println!(" - {}\n", failure);
477 /// Clear out `dir` if `input` is newer.
479 /// After this executes, it will also ensure that `dir` exists.
480 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
481 let stamp = dir.join(".stamp");
482 let mut cleared = false;
483 if mtime(&stamp) < mtime(input) {
484 self.verbose(&format!("Dirty - {}", dir.display()));
485 let _ = fs::remove_dir_all(dir);
487 } else if stamp.exists() {
490 t!(fs::create_dir_all(dir));
491 t!(File::create(stamp));
495 /// Gets the space-separated set of activated features for the standard
497 fn std_features(&self) -> String {
498 let mut features = "panic-unwind".to_string();
500 if self.config.llvm_libunwind {
501 features.push_str(" llvm-libunwind");
503 if self.config.backtrace {
504 features.push_str(" backtrace");
506 if self.config.profiler {
507 features.push_str(" profiler");
509 if self.config.wasm_syscall {
510 features.push_str(" wasm_syscall");
515 /// Gets the space-separated set of activated features for the compiler.
516 fn rustc_features(&self) -> String {
517 let mut features = String::new();
518 if self.config.jemalloc {
519 features.push_str("jemalloc");
524 /// Component directory that Cargo will produce output into (e.g.
526 fn cargo_dir(&self) -> &'static str {
527 if self.config.rust_optimize {"release"} else {"debug"}
530 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
531 let out = self.out.join(&*compiler.host).join(format!("stage{}-tools-bin", compiler.stage));
532 t!(fs::create_dir_all(&out));
536 /// Returns the root directory for all output generated in a particular
537 /// stage when running with a particular host compiler.
539 /// The mode indicates what the root directory is for.
540 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
541 let suffix = match mode {
543 Mode::Test => "-test",
544 Mode::Rustc => "-rustc",
545 Mode::Codegen => "-codegen",
546 Mode::ToolBootstrap => "-bootstrap-tools",
547 Mode::ToolStd => "-tools",
548 Mode::ToolTest => "-tools",
549 Mode::ToolRustc => "-tools",
551 self.out.join(&*compiler.host)
552 .join(format!("stage{}{}", compiler.stage, suffix))
555 /// Returns the root output directory for all Cargo output in a given stage,
556 /// running a particular compiler, whether or not we're building the
557 /// standard library, and targeting the specified architecture.
561 target: Interned<String>) -> PathBuf {
562 self.stage_out(compiler, mode).join(&*target).join(self.cargo_dir())
565 /// Root output directory for LLVM compiled for `target`
567 /// Note that if LLVM is configured externally then the directory returned
568 /// will likely be empty.
569 fn llvm_out(&self, target: Interned<String>) -> PathBuf {
570 self.out.join(&*target).join("llvm")
573 fn emscripten_llvm_out(&self, target: Interned<String>) -> PathBuf {
574 self.out.join(&*target).join("llvm-emscripten")
577 fn lld_out(&self, target: Interned<String>) -> PathBuf {
578 self.out.join(&*target).join("lld")
581 /// Output directory for all documentation for a target
582 fn doc_out(&self, target: Interned<String>) -> PathBuf {
583 self.out.join(&*target).join("doc")
586 /// Output directory for all documentation for a target
587 fn compiler_doc_out(&self, target: Interned<String>) -> PathBuf {
588 self.out.join(&*target).join("compiler-doc")
591 /// Output directory for some generated md crate documentation for a target (temporary)
592 fn md_doc_out(&self, target: Interned<String>) -> Interned<PathBuf> {
593 INTERNER.intern_path(self.out.join(&*target).join("md-doc"))
596 /// Output directory for all crate documentation for a target (temporary)
598 /// The artifacts here are then copied into `doc_out` above.
599 fn crate_doc_out(&self, target: Interned<String>) -> PathBuf {
600 self.out.join(&*target).join("crate-docs")
603 /// Returns `true` if no custom `llvm-config` is set for the specified target.
605 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
606 fn is_rust_llvm(&self, target: Interned<String>) -> bool {
607 match self.config.target_config.get(&target) {
608 Some(ref c) => c.llvm_config.is_none(),
613 /// Returns the path to `FileCheck` binary for the specified target
614 fn llvm_filecheck(&self, target: Interned<String>) -> PathBuf {
615 let target_config = self.config.target_config.get(&target);
616 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
618 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
619 let llvm_bindir = output(Command::new(s).arg("--bindir"));
620 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", &*target));
621 if filecheck.exists() {
624 // On Fedora the system LLVM installs FileCheck in the
625 // llvm subdirectory of the libdir.
626 let llvm_libdir = output(Command::new(s).arg("--libdir"));
627 let lib_filecheck = Path::new(llvm_libdir.trim())
628 .join("llvm").join(exe("FileCheck", &*target));
629 if lib_filecheck.exists() {
632 // Return the most normal file name, even though
633 // it doesn't exist, so that any error message
639 let base = self.llvm_out(self.config.build).join("build");
640 let base = if !self.config.ninja && self.config.build.contains("msvc") {
641 if self.config.llvm_optimize {
642 if self.config.llvm_release_debuginfo {
643 base.join("RelWithDebInfo")
653 base.join("bin").join(exe("FileCheck", &*target))
657 /// Directory for libraries built from C/C++ code and shared between stages.
658 fn native_dir(&self, target: Interned<String>) -> PathBuf {
659 self.out.join(&*target).join("native")
662 /// Root output directory for rust_test_helpers library compiled for
664 fn test_helpers_out(&self, target: Interned<String>) -> PathBuf {
665 self.native_dir(target).join("rust-test-helpers")
668 /// Adds the `RUST_TEST_THREADS` env var if necessary
669 fn add_rust_test_threads(&self, cmd: &mut Command) {
670 if env::var_os("RUST_TEST_THREADS").is_none() {
671 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
675 /// Returns the libdir of the snapshot compiler.
676 fn rustc_snapshot_libdir(&self) -> PathBuf {
677 self.rustc_snapshot_sysroot().join(libdir(&self.config.build))
680 /// Returns the sysroot of the snapshot compiler.
681 fn rustc_snapshot_sysroot(&self) -> &Path {
682 self.initial_rustc.parent().unwrap().parent().unwrap()
685 /// Runs a command, printing out nice contextual information if it fails.
686 fn run(&self, cmd: &mut Command) {
687 if self.config.dry_run { return; }
688 self.verbose(&format!("running: {:?}", cmd));
692 /// Runs a command, printing out nice contextual information if it fails.
693 fn run_quiet(&self, cmd: &mut Command) {
694 if self.config.dry_run { return; }
695 self.verbose(&format!("running: {:?}", cmd));
699 /// Runs a command, printing out nice contextual information if it fails.
700 /// Exits if the command failed to execute at all, otherwise returns its
701 /// `status.success()`.
702 fn try_run(&self, cmd: &mut Command) -> bool {
703 if self.config.dry_run { return true; }
704 self.verbose(&format!("running: {:?}", cmd));
708 /// Runs a command, printing out nice contextual information if it fails.
709 /// Exits if the command failed to execute at all, otherwise returns its
710 /// `status.success()`.
711 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
712 if self.config.dry_run { return true; }
713 self.verbose(&format!("running: {:?}", cmd));
714 try_run_suppressed(cmd)
717 pub fn is_verbose(&self) -> bool {
721 /// Prints a message if this build is configured in verbose mode.
722 fn verbose(&self, msg: &str) {
723 if self.is_verbose() {
728 pub fn is_verbose_than(&self, level: usize) -> bool {
729 self.verbosity > level
732 /// Prints a message if this build is configured in more verbose mode than `level`.
733 fn verbose_than(&self, level: usize, msg: &str) {
734 if self.is_verbose_than(level) {
739 fn info(&self, msg: &str) {
740 if self.config.dry_run { return; }
744 /// Returns the number of parallel jobs that have been configured for this
746 fn jobs(&self) -> u32 {
747 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
750 fn debuginfo_map(&self, which: GitRepo) -> Option<String> {
751 if !self.config.rust_remap_debuginfo {
755 let path = match which {
757 let sha = self.rust_sha().unwrap_or(channel::CFG_RELEASE_NUM);
758 format!("/rustc/{}", sha)
760 GitRepo::Llvm => String::from("/rustc/llvm"),
762 Some(format!("{}={}", self.src.display(), path))
765 /// Returns the path to the C compiler for the target specified.
766 fn cc(&self, target: Interned<String>) -> &Path {
767 self.cc[&target].path()
770 /// Returns a list of flags to pass to the C compiler for the target
772 fn cflags(&self, target: Interned<String>, which: GitRepo) -> Vec<String> {
773 // Filter out -O and /O (the optimization flags) that we picked up from
774 // cc-rs because the build scripts will determine that for themselves.
775 let mut base = self.cc[&target].args().iter()
776 .map(|s| s.to_string_lossy().into_owned())
777 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
778 .collect::<Vec<String>>();
780 // If we're compiling on macOS then we add a few unconditional flags
781 // indicating that we want libc++ (more filled out than libstdc++) and
782 // we want to compile for 10.7. This way we can ensure that
783 // LLVM/etc are all properly compiled.
784 if target.contains("apple-darwin") {
785 base.push("-stdlib=libc++".into());
788 // Work around an apparently bad MinGW / GCC optimization,
789 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
790 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
791 if &*target == "i686-pc-windows-gnu" {
792 base.push("-fno-omit-frame-pointer".into());
795 if let Some(map) = self.debuginfo_map(which) {
796 let cc = self.cc(target);
797 if cc.ends_with("clang") || cc.ends_with("gcc") {
798 base.push(format!("-fdebug-prefix-map={}", map));
799 } else if cc.ends_with("clang-cl.exe") {
800 base.push("-Xclang".into());
801 base.push(format!("-fdebug-prefix-map={}", map));
807 /// Returns the path to the `ar` archive utility for the target specified.
808 fn ar(&self, target: Interned<String>) -> Option<&Path> {
809 self.ar.get(&target).map(|p| &**p)
812 /// Returns the path to the `ranlib` utility for the target specified.
813 fn ranlib(&self, target: Interned<String>) -> Option<&Path> {
814 self.ranlib.get(&target).map(|p| &**p)
817 /// Returns the path to the C++ compiler for the target specified.
818 fn cxx(&self, target: Interned<String>) -> Result<&Path, String> {
819 match self.cxx.get(&target) {
820 Some(p) => Ok(p.path()),
822 "target `{}` is not configured as a host, only as a target",
827 /// Returns the path to the linker for the given target if it needs to be overridden.
828 fn linker(&self, target: Interned<String>) -> Option<&Path> {
829 if let Some(linker) = self.config.target_config.get(&target)
830 .and_then(|c| c.linker.as_ref()) {
832 } else if target != self.config.build &&
833 !target.contains("msvc") &&
834 !target.contains("emscripten") &&
835 !target.contains("wasm32") &&
836 !target.contains("nvptx") &&
837 !target.contains("fuchsia") {
838 Some(self.cc(target))
844 /// Returns if this target should statically link the C runtime, if specified
845 fn crt_static(&self, target: Interned<String>) -> Option<bool> {
846 if target.contains("pc-windows-msvc") {
849 self.config.target_config.get(&target)
850 .and_then(|t| t.crt_static)
854 /// Returns the "musl root" for this `target`, if defined
855 fn musl_root(&self, target: Interned<String>) -> Option<&Path> {
856 self.config.target_config.get(&target)
857 .and_then(|t| t.musl_root.as_ref())
858 .or(self.config.musl_root.as_ref())
862 /// Returns the sysroot for the wasi target, if defined
863 fn wasi_root(&self, target: Interned<String>) -> Option<&Path> {
864 self.config.target_config.get(&target)
865 .and_then(|t| t.wasi_root.as_ref())
869 /// Returns `true` if this is a no-std `target`, if defined
870 fn no_std(&self, target: Interned<String>) -> Option<bool> {
871 self.config.target_config.get(&target)
875 /// Returns `true` if the target will be tested using the `remote-test-client`
876 /// and `remote-test-server` binaries.
877 fn remote_tested(&self, target: Interned<String>) -> bool {
878 self.qemu_rootfs(target).is_some() || target.contains("android") ||
879 env::var_os("TEST_DEVICE_ADDR").is_some()
882 /// Returns the root of the "rootfs" image that this target will be using,
883 /// if one was configured.
885 /// If `Some` is returned then that means that tests for this target are
886 /// emulated with QEMU and binaries will need to be shipped to the emulator.
887 fn qemu_rootfs(&self, target: Interned<String>) -> Option<&Path> {
888 self.config.target_config.get(&target)
889 .and_then(|t| t.qemu_rootfs.as_ref())
893 /// Path to the python interpreter to use
894 fn python(&self) -> &Path {
895 self.config.python.as_ref().unwrap()
898 /// Temporary directory that extended error information is emitted to.
899 fn extended_error_dir(&self) -> PathBuf {
900 self.out.join("tmp/extended-error-metadata")
903 /// Tests whether the `compiler` compiling for `target` should be forced to
904 /// use a stage1 compiler instead.
906 /// Currently, by default, the build system does not perform a "full
907 /// bootstrap" by default where we compile the compiler three times.
908 /// Instead, we compile the compiler two times. The final stage (stage2)
909 /// just copies the libraries from the previous stage, which is what this
912 /// Here we return `true` if:
914 /// * The build isn't performing a full bootstrap
915 /// * The `compiler` is in the final stage, 2
916 /// * We're not cross-compiling, so the artifacts are already available in
919 /// When all of these conditions are met the build will lift artifacts from
920 /// the previous stage forward.
921 fn force_use_stage1(&self, compiler: Compiler, target: Interned<String>) -> bool {
922 !self.config.full_bootstrap &&
923 compiler.stage >= 2 &&
924 (self.hosts.iter().any(|h| *h == target) || target == self.build)
927 /// Given `num` in the form "a.b.c" return a "release string" which
928 /// describes the release version number.
930 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
931 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
932 fn release(&self, num: &str) -> String {
933 match &self.config.channel[..] {
934 "stable" => num.to_string(),
935 "beta" => if self.rust_info.is_git() {
936 format!("{}-beta.{}", num, self.beta_prerelease_version())
938 format!("{}-beta", num)
940 "nightly" => format!("{}-nightly", num),
941 _ => format!("{}-dev", num),
945 fn beta_prerelease_version(&self) -> u32 {
946 if let Some(s) = self.prerelease_version.get() {
955 .current_dir(&self.src)
957 let beta = beta.trim().split_whitespace().next().unwrap();
963 .current_dir(&self.src)
965 let master = master.trim().split_whitespace().next().unwrap();
967 // Figure out where the current beta branch started.
973 .current_dir(&self.src),
975 let base = base.trim();
977 // Next figure out how many merge commits happened since we branched off
978 // beta. That's our beta number!
984 .arg(format!("{}...HEAD", base))
985 .current_dir(&self.src),
987 let n = count.trim().parse().unwrap();
988 self.prerelease_version.set(Some(n));
992 /// Returns the value of `release` above for Rust itself.
993 fn rust_release(&self) -> String {
994 self.release(channel::CFG_RELEASE_NUM)
997 /// Returns the "package version" for a component given the `num` release
1000 /// The package version is typically what shows up in the names of tarballs.
1001 /// For channels like beta/nightly it's just the channel name, otherwise
1002 /// it's the `num` provided.
1003 fn package_vers(&self, num: &str) -> String {
1004 match &self.config.channel[..] {
1005 "stable" => num.to_string(),
1006 "beta" => "beta".to_string(),
1007 "nightly" => "nightly".to_string(),
1008 _ => format!("{}-dev", num),
1012 /// Returns the value of `package_vers` above for Rust itself.
1013 fn rust_package_vers(&self) -> String {
1014 self.package_vers(channel::CFG_RELEASE_NUM)
1017 /// Returns the value of `package_vers` above for Cargo
1018 fn cargo_package_vers(&self) -> String {
1019 self.package_vers(&self.release_num("cargo"))
1022 /// Returns the value of `package_vers` above for rls
1023 fn rls_package_vers(&self) -> String {
1024 self.package_vers(&self.release_num("rls"))
1027 /// Returns the value of `package_vers` above for clippy
1028 fn clippy_package_vers(&self) -> String {
1029 self.package_vers(&self.release_num("clippy"))
1032 /// Returns the value of `package_vers` above for miri
1033 fn miri_package_vers(&self) -> String {
1034 self.package_vers(&self.release_num("miri"))
1037 /// Returns the value of `package_vers` above for rustfmt
1038 fn rustfmt_package_vers(&self) -> String {
1039 self.package_vers(&self.release_num("rustfmt"))
1042 fn llvm_tools_package_vers(&self) -> String {
1043 self.package_vers(channel::CFG_RELEASE_NUM)
1046 fn llvm_tools_vers(&self) -> String {
1050 fn lldb_package_vers(&self) -> String {
1051 self.package_vers(channel::CFG_RELEASE_NUM)
1054 fn lldb_vers(&self) -> String {
1058 fn llvm_link_tools_dynamically(&self, target: Interned<String>) -> bool {
1059 (target.contains("linux-gnu") || target.contains("apple-darwin"))
1062 /// Returns the `version` string associated with this compiler for Rust
1065 /// Note that this is a descriptive string which includes the commit date,
1066 /// sha, version, etc.
1067 fn rust_version(&self) -> String {
1068 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1071 /// Returns the full commit hash.
1072 fn rust_sha(&self) -> Option<&str> {
1073 self.rust_info.sha()
1076 /// Returns the `a.b.c` version that the given package is at.
1077 fn release_num(&self, package: &str) -> String {
1078 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1079 let toml = t!(fs::read_to_string(&toml_file_name));
1080 for line in toml.lines() {
1081 let prefix = "version = \"";
1083 if line.starts_with(prefix) && line.ends_with(suffix) {
1084 return line[prefix.len()..line.len() - suffix.len()].to_string()
1088 panic!("failed to find version in {}'s Cargo.toml", package)
1091 /// Returns `true` if unstable features should be enabled for the compiler
1093 fn unstable_features(&self) -> bool {
1094 match &self.config.channel[..] {
1095 "stable" | "beta" => false,
1096 "nightly" | _ => true,
1100 /// Fold the output of the commands after this method into a group. The fold
1101 /// ends when the returned object is dropped. Folding can only be used in
1102 /// the Travis CI environment.
1103 pub fn fold_output<D, F>(&self, name: F) -> Option<OutputFolder>
1104 where D: Into<String>, F: FnOnce() -> D
1106 if !self.config.dry_run && self.ci_env == CiEnv::Travis {
1107 Some(OutputFolder::new(name().into()))
1113 /// Updates the actual toolstate of a tool.
1115 /// The toolstates are saved to the file specified by the key
1116 /// `rust.save-toolstates` in `config.toml`. If unspecified, nothing will be
1117 /// done. The file is updated immediately after this function completes.
1118 pub fn save_toolstate(&self, tool: &str, state: ToolState) {
1119 if let Some(ref path) = self.config.save_toolstates {
1120 let mut file = t!(fs::OpenOptions::new()
1126 let mut current_toolstates: HashMap<Box<str>, ToolState> =
1127 serde_json::from_reader(&mut file).unwrap_or_default();
1128 current_toolstates.insert(tool.into(), state);
1129 t!(file.seek(SeekFrom::Start(0)));
1130 t!(file.set_len(0));
1131 t!(serde_json::to_writer(file, ¤t_toolstates));
1135 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1136 let mut ret = Vec::new();
1137 let mut list = vec![INTERNER.intern_str(root)];
1138 let mut visited = HashSet::new();
1139 while let Some(krate) = list.pop() {
1140 let krate = &self.crates[&krate];
1141 if krate.is_local(self) {
1144 for dep in &krate.deps {
1145 if visited.insert(dep) && dep != "build_helper" {
1153 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, bool)> {
1154 if self.config.dry_run {
1158 let mut paths = Vec::new();
1159 let contents = t!(fs::read(stamp));
1160 // This is the method we use for extracting paths from the stamp file passed to us. See
1161 // run_cargo for more information (in compile.rs).
1162 for part in contents.split(|b| *b == 0) {
1163 if part.is_empty() {
1166 let host = part[0] as char == 'h';
1167 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1168 paths.push((path, host));
1173 /// Copies a file from `src` to `dst`
1174 pub fn copy(&self, src: &Path, dst: &Path) {
1175 if self.config.dry_run { return; }
1176 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1177 let _ = fs::remove_file(&dst);
1178 let metadata = t!(src.symlink_metadata());
1179 if metadata.file_type().is_symlink() {
1180 let link = t!(fs::read_link(src));
1181 t!(symlink_file(link, dst));
1182 } else if let Ok(()) = fs::hard_link(src, dst) {
1183 // Attempt to "easy copy" by creating a hard link
1184 // (symlinks don't work on windows), but if that fails
1185 // just fall back to a slow `copy` operation.
1187 if let Err(e) = fs::copy(src, dst) {
1188 panic!("failed to copy `{}` to `{}`: {}", src.display(),
1191 t!(fs::set_permissions(dst, metadata.permissions()));
1192 let atime = FileTime::from_last_access_time(&metadata);
1193 let mtime = FileTime::from_last_modification_time(&metadata);
1194 t!(filetime::set_file_times(dst, atime, mtime));
1198 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1199 /// new string for each replacement.)
1200 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1201 if self.config.dry_run { return; }
1202 let mut contents = String::new();
1203 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1204 t!(file.read_to_string(&mut contents));
1205 for &(target, replacement) in replacements {
1206 contents = contents.replace(target, replacement);
1208 t!(file.seek(SeekFrom::Start(0)));
1209 t!(file.set_len(0));
1210 t!(file.write_all(contents.as_bytes()));
1213 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1214 /// when this function is called.
1215 pub fn cp_r(&self, src: &Path, dst: &Path) {
1216 if self.config.dry_run { return; }
1217 for f in t!(fs::read_dir(src)) {
1219 let path = f.path();
1220 let name = path.file_name().unwrap();
1221 let dst = dst.join(name);
1222 if t!(f.file_type()).is_dir() {
1223 t!(fs::create_dir_all(&dst));
1224 self.cp_r(&path, &dst);
1226 let _ = fs::remove_file(&dst);
1227 self.copy(&path, &dst);
1232 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1233 /// when this function is called. Unwanted files or directories can be skipped
1234 /// by returning `false` from the filter function.
1235 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1236 // Immediately recurse with an empty relative path
1237 self.recurse_(src, dst, Path::new(""), filter)
1240 // Inner function does the actual work
1241 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1242 for f in self.read_dir(src) {
1243 let path = f.path();
1244 let name = path.file_name().unwrap();
1245 let dst = dst.join(name);
1246 let relative = relative.join(name);
1247 // Only copy file or directory if the filter function returns true
1248 if filter(&relative) {
1249 if t!(f.file_type()).is_dir() {
1250 let _ = fs::remove_dir_all(&dst);
1251 self.create_dir(&dst);
1252 self.recurse_(&path, &dst, &relative, filter);
1254 let _ = fs::remove_file(&dst);
1255 self.copy(&path, &dst);
1261 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1262 let file_name = src.file_name().unwrap();
1263 let dest = dest_folder.join(file_name);
1264 self.copy(src, &dest);
1267 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1268 if self.config.dry_run { return; }
1269 let dst = dstdir.join(src.file_name().unwrap());
1270 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1271 t!(fs::create_dir_all(dstdir));
1272 drop(fs::remove_file(&dst));
1275 panic!("Error: File \"{}\" not found!", src.display());
1277 let metadata = t!(src.symlink_metadata());
1278 if let Err(e) = fs::copy(&src, &dst) {
1279 panic!("failed to copy `{}` to `{}`: {}", src.display(),
1282 t!(fs::set_permissions(&dst, metadata.permissions()));
1283 let atime = FileTime::from_last_access_time(&metadata);
1284 let mtime = FileTime::from_last_modification_time(&metadata);
1285 t!(filetime::set_file_times(&dst, atime, mtime));
1290 fn create(&self, path: &Path, s: &str) {
1291 if self.config.dry_run { return; }
1292 t!(fs::write(path, s));
1295 fn read(&self, path: &Path) -> String {
1296 if self.config.dry_run { return String::new(); }
1297 t!(fs::read_to_string(path))
1300 fn create_dir(&self, dir: &Path) {
1301 if self.config.dry_run { return; }
1302 t!(fs::create_dir_all(dir))
1305 fn remove_dir(&self, dir: &Path) {
1306 if self.config.dry_run { return; }
1307 t!(fs::remove_dir_all(dir))
1310 fn read_dir(&self, dir: &Path) -> impl Iterator<Item=fs::DirEntry> {
1311 let iter = match fs::read_dir(dir) {
1313 Err(_) if self.config.dry_run => return vec![].into_iter(),
1314 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1316 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1319 fn remove(&self, f: &Path) {
1320 if self.config.dry_run { return; }
1321 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1326 fn chmod(path: &Path, perms: u32) {
1327 use std::os::unix::fs::*;
1328 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1331 fn chmod(_path: &Path, _perms: u32) {}
1335 pub fn with_stage(mut self, stage: u32) -> Compiler {
1340 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1341 pub fn is_snapshot(&self, build: &Build) -> bool {
1342 self.stage == 0 && self.host == build.build
1345 /// Returns if this compiler should be treated as a final stage one in the
1346 /// current build session.
1347 /// This takes into account whether we're performing a full bootstrap or
1348 /// not; don't directly compare the stage with `2`!
1349 pub fn is_final_stage(&self, build: &Build) -> bool {
1350 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1351 self.stage >= final_stage