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)]
112 extern crate build_helper;
114 extern crate serde_derive;
116 extern crate lazy_static;
120 extern crate pretty_assertions;
122 use std::cell::{RefCell, Cell};
123 use std::collections::{HashSet, HashMap};
125 use std::fs::{self, OpenOptions, File};
126 use std::io::{Seek, SeekFrom, Write, Read};
127 use std::path::{PathBuf, Path};
128 use std::process::{self, Command};
133 use std::os::unix::fs::symlink as symlink_file;
135 use std::os::windows::fs::symlink_file;
137 use build_helper::{run_silent, run_suppressed, try_run_silent, try_run_suppressed, output, mtime};
138 use filetime::FileTime;
140 use crate::util::{exe, libdir, OutputFolder, CiEnv};
165 #[cfg(all(unix, not(target_os = "haiku")))]
167 pub unsafe fn setup(build: &mut crate::Build) {
168 if build.config.low_priority {
169 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
174 #[cfg(any(target_os = "haiku", not(any(unix, windows))))]
176 pub unsafe fn setup(_build: &mut crate::Build) {
180 pub use crate::config::Config;
181 use crate::flags::Subcommand;
182 use crate::cache::{Interned, INTERNER};
183 use crate::toolstate::ToolState;
185 const LLVM_TOOLS: &[&str] = &[
186 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
187 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
188 "llvm-objdump", // used to disassemble programs
189 "llvm-profdata", // used to inspect and merge files generated by profiles
190 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
191 "llvm-size", // used to prints the size of the linker sections of a program
192 "llvm-strip", // used to discard symbols from binary files to reduce their size
193 "llvm-ar" // used for creating and modifying archive files
196 /// A structure representing a Rust compiler.
198 /// Each compiler has a `stage` that it is associated with and a `host` that
199 /// corresponds to the platform the compiler runs on. This structure is used as
200 /// a parameter to many methods below.
201 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
202 pub struct Compiler {
204 host: Interned<String>,
207 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
209 // Default, run normal tests and doc tests.
211 // Do not run any doc tests.
213 // Only run doc tests.
222 /// Global configuration for the build system.
224 /// This structure transitively contains all configuration for the build system.
225 /// All filesystem-encoded configuration is in `config`, all flags are in
226 /// `flags`, and then parsed or probed information is listed in the keys below.
228 /// This structure is a parameter of almost all methods in the build system,
229 /// although most functions are implemented as free functions rather than
230 /// methods specifically on this structure itself (to make it easier to
233 // User-specified configuration via config.toml
236 // Derived properties from the above two configurations
239 rust_info: channel::GitInfo,
240 cargo_info: channel::GitInfo,
241 rls_info: channel::GitInfo,
242 clippy_info: channel::GitInfo,
243 miri_info: channel::GitInfo,
244 rustfmt_info: channel::GitInfo,
245 in_tree_llvm_info: channel::GitInfo,
246 emscripten_llvm_info: channel::GitInfo,
252 // Targets for which to build.
253 build: Interned<String>,
254 hosts: Vec<Interned<String>>,
255 targets: Vec<Interned<String>>,
257 // Stage 0 (downloaded) compiler and cargo or their local rust equivalents.
258 initial_rustc: PathBuf,
259 initial_cargo: PathBuf,
261 // Runtime state filled in later on
262 // C/C++ compilers and archiver for all targets
263 cc: HashMap<Interned<String>, cc::Tool>,
264 cxx: HashMap<Interned<String>, cc::Tool>,
265 ar: HashMap<Interned<String>, PathBuf>,
266 ranlib: HashMap<Interned<String>, PathBuf>,
268 crates: HashMap<Interned<String>, Crate>,
271 delayed_failures: RefCell<Vec<String>>,
272 prerelease_version: Cell<Option<u32>>,
273 tool_artifacts: RefCell<HashMap<
275 HashMap<String, (&'static str, PathBuf, Vec<String>)>
281 name: Interned<String>,
283 deps: HashSet<Interned<String>>,
293 fn is_local(&self, build: &Build) -> bool {
294 self.path.starts_with(&build.config.src) &&
295 !self.path.to_string_lossy().ends_with("_shim")
298 fn local_path(&self, build: &Build) -> PathBuf {
299 assert!(self.is_local(build));
300 self.path.strip_prefix(&build.config.src).unwrap().into()
304 /// The various "modes" of invoking Cargo.
306 /// These entries currently correspond to the various output directories of the
307 /// build system, with each mod generating output in a different directory.
308 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
310 /// Build the standard library, placing output in the "stageN-std" directory.
313 /// Build libtest, placing output in the "stageN-test" directory.
316 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
319 /// Build codegen libraries, placing output in the "stageN-codegen" directory
322 /// Build some tools, placing output in the "stageN-tools" directory. The
323 /// "other" here is for miscellaneous sets of tools that are built using the
324 /// bootstrap compiler in its entirety (target libraries and all).
325 /// Typically these tools compile with stable Rust.
328 /// Compile a tool which uses all libraries we compile (up to rustc).
329 /// Doesn't use the stage0 compiler libraries like "other", and includes
330 /// tools like rustdoc, cargo, rls, etc.
337 pub fn is_tool(&self) -> bool {
339 Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd => true,
346 /// Creates a new set of build configuration from the `flags` on the command
347 /// line and the filesystem `config`.
349 /// By default all build output will be placed in the current directory.
350 pub fn new(config: Config) -> Build {
351 let src = config.src.clone();
352 let out = config.out.clone();
354 let is_sudo = match env::var_os("SUDO_USER") {
356 match env::var_os("USER") {
357 Some(user) => user != sudo_user,
363 let rust_info = channel::GitInfo::new(&config, &src);
364 let cargo_info = channel::GitInfo::new(&config, &src.join("src/tools/cargo"));
365 let rls_info = channel::GitInfo::new(&config, &src.join("src/tools/rls"));
366 let clippy_info = channel::GitInfo::new(&config, &src.join("src/tools/clippy"));
367 let miri_info = channel::GitInfo::new(&config, &src.join("src/tools/miri"));
368 let rustfmt_info = channel::GitInfo::new(&config, &src.join("src/tools/rustfmt"));
369 let in_tree_llvm_info = channel::GitInfo::new(&config, &src.join("src/llvm-project"));
370 let emscripten_llvm_info = channel::GitInfo::new(&config, &src.join("src/llvm-emscripten"));
372 let mut build = Build {
373 initial_rustc: config.initial_rustc.clone(),
374 initial_cargo: config.initial_cargo.clone(),
375 local_rebuild: config.local_rebuild,
376 fail_fast: config.cmd.fail_fast(),
377 doc_tests: config.cmd.doc_tests(),
378 verbosity: config.verbose,
381 hosts: config.hosts.clone(),
382 targets: config.targets.clone(),
395 emscripten_llvm_info,
399 ranlib: HashMap::new(),
400 crates: HashMap::new(),
402 ci_env: CiEnv::current(),
403 delayed_failures: RefCell::new(Vec::new()),
404 prerelease_version: Cell::new(None),
405 tool_artifacts: Default::default(),
408 build.verbose("finding compilers");
409 cc_detect::find(&mut build);
410 build.verbose("running sanity check");
411 sanity::check(&mut build);
413 // If local-rust is the same major.minor as the current version, then force a
415 let local_version_verbose = output(
416 Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
417 let local_release = local_version_verbose
418 .lines().filter(|x| x.starts_with("release:"))
419 .next().unwrap().trim_start_matches("release:").trim();
420 let my_version = channel::CFG_RELEASE_NUM;
421 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
422 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
423 build.local_rebuild = true;
426 build.verbose("learning about cargo");
427 metadata::build(&mut build);
432 pub fn build_triple(&self) -> &[Interned<String>] {
434 slice::from_raw_parts(&self.build, 1)
438 /// Executes the entire build, as configured by the flags and configuration.
439 pub fn build(&mut self) {
444 if let Subcommand::Clean { all } = self.config.cmd {
445 return clean::clean(self, all);
449 let builder = builder::Builder::new(&self);
450 if let Some(path) = builder.paths.get(0) {
451 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
457 if !self.config.dry_run {
459 self.config.dry_run = true;
460 let builder = builder::Builder::new(&self);
461 builder.execute_cli();
463 self.config.dry_run = false;
464 let builder = builder::Builder::new(&self);
465 builder.execute_cli();
467 let builder = builder::Builder::new(&self);
468 let _ = builder.execute_cli();
471 // Check for postponed failures from `test --no-fail-fast`.
472 let failures = self.delayed_failures.borrow();
473 if failures.len() > 0 {
474 println!("\n{} command(s) did not execute successfully:\n", failures.len());
475 for failure in failures.iter() {
476 println!(" - {}\n", failure);
482 /// Clear out `dir` if `input` is newer.
484 /// After this executes, it will also ensure that `dir` exists.
485 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
486 let stamp = dir.join(".stamp");
487 let mut cleared = false;
488 if mtime(&stamp) < mtime(input) {
489 self.verbose(&format!("Dirty - {}", dir.display()));
490 let _ = fs::remove_dir_all(dir);
492 } else if stamp.exists() {
495 t!(fs::create_dir_all(dir));
496 t!(File::create(stamp));
500 /// Gets the space-separated set of activated features for the standard
502 fn std_features(&self) -> String {
503 let mut features = "panic-unwind".to_string();
505 if self.config.backtrace {
506 features.push_str(" backtrace");
508 if self.config.profiler {
509 features.push_str(" profiler");
511 if self.config.wasm_syscall {
512 features.push_str(" wasm_syscall");
517 /// Gets the space-separated set of activated features for the compiler.
518 fn rustc_features(&self) -> String {
519 let mut features = String::new();
520 if self.config.jemalloc {
521 features.push_str("jemalloc");
526 /// Component directory that Cargo will produce output into (e.g.
528 fn cargo_dir(&self) -> &'static str {
529 if self.config.rust_optimize {"release"} else {"debug"}
532 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
533 let out = self.out.join(&*compiler.host).join(format!("stage{}-tools-bin", compiler.stage));
534 t!(fs::create_dir_all(&out));
538 /// Returns the root directory for all output generated in a particular
539 /// stage when running with a particular host compiler.
541 /// The mode indicates what the root directory is for.
542 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
543 let suffix = match mode {
545 Mode::Test => "-test",
546 Mode::Rustc => "-rustc",
547 Mode::Codegen => "-codegen",
548 Mode::ToolBootstrap => "-bootstrap-tools",
549 Mode::ToolStd => "-tools",
550 Mode::ToolTest => "-tools",
551 Mode::ToolRustc => "-tools",
553 self.out.join(&*compiler.host)
554 .join(format!("stage{}{}", compiler.stage, suffix))
557 /// Returns the root output directory for all Cargo output in a given stage,
558 /// running a particular compiler, whether or not we're building the
559 /// standard library, and targeting the specified architecture.
563 target: Interned<String>) -> PathBuf {
564 self.stage_out(compiler, mode).join(&*target).join(self.cargo_dir())
567 /// Root output directory for LLVM compiled for `target`
569 /// Note that if LLVM is configured externally then the directory returned
570 /// will likely be empty.
571 fn llvm_out(&self, target: Interned<String>) -> PathBuf {
572 self.out.join(&*target).join("llvm")
575 fn emscripten_llvm_out(&self, target: Interned<String>) -> PathBuf {
576 self.out.join(&*target).join("llvm-emscripten")
579 fn lld_out(&self, target: Interned<String>) -> PathBuf {
580 self.out.join(&*target).join("lld")
583 /// Output directory for all documentation for a target
584 fn doc_out(&self, target: Interned<String>) -> PathBuf {
585 self.out.join(&*target).join("doc")
588 /// Output directory for all documentation for a target
589 fn compiler_doc_out(&self, target: Interned<String>) -> PathBuf {
590 self.out.join(&*target).join("compiler-doc")
593 /// Output directory for some generated md crate documentation for a target (temporary)
594 fn md_doc_out(&self, target: Interned<String>) -> Interned<PathBuf> {
595 INTERNER.intern_path(self.out.join(&*target).join("md-doc"))
598 /// Output directory for all crate documentation for a target (temporary)
600 /// The artifacts here are then copied into `doc_out` above.
601 fn crate_doc_out(&self, target: Interned<String>) -> PathBuf {
602 self.out.join(&*target).join("crate-docs")
605 /// Returns `true` if no custom `llvm-config` is set for the specified target.
607 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
608 fn is_rust_llvm(&self, target: Interned<String>) -> bool {
609 match self.config.target_config.get(&target) {
610 Some(ref c) => c.llvm_config.is_none(),
615 /// Returns the path to `FileCheck` binary for the specified target
616 fn llvm_filecheck(&self, target: Interned<String>) -> PathBuf {
617 let target_config = self.config.target_config.get(&target);
618 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
620 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
621 let llvm_bindir = output(Command::new(s).arg("--bindir"));
622 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", &*target));
623 if filecheck.exists() {
626 // On Fedora the system LLVM installs FileCheck in the
627 // llvm subdirectory of the libdir.
628 let llvm_libdir = output(Command::new(s).arg("--libdir"));
629 let lib_filecheck = Path::new(llvm_libdir.trim())
630 .join("llvm").join(exe("FileCheck", &*target));
631 if lib_filecheck.exists() {
634 // Return the most normal file name, even though
635 // it doesn't exist, so that any error message
641 let base = self.llvm_out(self.config.build).join("build");
642 let base = if !self.config.ninja && self.config.build.contains("msvc") {
643 if self.config.llvm_optimize {
644 if self.config.llvm_release_debuginfo {
645 base.join("RelWithDebInfo")
655 base.join("bin").join(exe("FileCheck", &*target))
659 /// Directory for libraries built from C/C++ code and shared between stages.
660 fn native_dir(&self, target: Interned<String>) -> PathBuf {
661 self.out.join(&*target).join("native")
664 /// Root output directory for rust_test_helpers library compiled for
666 fn test_helpers_out(&self, target: Interned<String>) -> PathBuf {
667 self.native_dir(target).join("rust-test-helpers")
670 /// Adds the `RUST_TEST_THREADS` env var if necessary
671 fn add_rust_test_threads(&self, cmd: &mut Command) {
672 if env::var_os("RUST_TEST_THREADS").is_none() {
673 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
677 /// Returns the libdir of the snapshot compiler.
678 fn rustc_snapshot_libdir(&self) -> PathBuf {
679 self.rustc_snapshot_sysroot().join(libdir(&self.config.build))
682 /// Returns the sysroot of the snapshot compiler.
683 fn rustc_snapshot_sysroot(&self) -> &Path {
684 self.initial_rustc.parent().unwrap().parent().unwrap()
687 /// Runs a command, printing out nice contextual information if it fails.
688 fn run(&self, cmd: &mut Command) {
689 if self.config.dry_run { return; }
690 self.verbose(&format!("running: {:?}", cmd));
694 /// Runs a command, printing out nice contextual information if it fails.
695 fn run_quiet(&self, cmd: &mut Command) {
696 if self.config.dry_run { return; }
697 self.verbose(&format!("running: {:?}", cmd));
701 /// Runs a command, printing out nice contextual information if it fails.
702 /// Exits if the command failed to execute at all, otherwise returns its
703 /// `status.success()`.
704 fn try_run(&self, cmd: &mut Command) -> bool {
705 if self.config.dry_run { return true; }
706 self.verbose(&format!("running: {:?}", cmd));
710 /// Runs a command, printing out nice contextual information if it fails.
711 /// Exits if the command failed to execute at all, otherwise returns its
712 /// `status.success()`.
713 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
714 if self.config.dry_run { return true; }
715 self.verbose(&format!("running: {:?}", cmd));
716 try_run_suppressed(cmd)
719 pub fn is_verbose(&self) -> bool {
723 /// Prints a message if this build is configured in verbose mode.
724 fn verbose(&self, msg: &str) {
725 if self.is_verbose() {
730 pub fn is_verbose_than(&self, level: usize) -> bool {
731 self.verbosity > level
734 /// Prints a message if this build is configured in more verbose mode than `level`.
735 fn verbose_than(&self, level: usize, msg: &str) {
736 if self.is_verbose_than(level) {
741 fn info(&self, msg: &str) {
742 if self.config.dry_run { return; }
746 /// Returns the number of parallel jobs that have been configured for this
748 fn jobs(&self) -> u32 {
749 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
752 fn debuginfo_map(&self, which: GitRepo) -> Option<String> {
753 if !self.config.rust_remap_debuginfo {
757 let path = match which {
759 let sha = self.rust_sha().unwrap_or(channel::CFG_RELEASE_NUM);
760 format!("/rustc/{}", sha)
762 GitRepo::Llvm => String::from("/rustc/llvm"),
764 Some(format!("{}={}", self.src.display(), path))
767 /// Returns the path to the C compiler for the target specified.
768 fn cc(&self, target: Interned<String>) -> &Path {
769 self.cc[&target].path()
772 /// Returns a list of flags to pass to the C compiler for the target
774 fn cflags(&self, target: Interned<String>, which: GitRepo) -> Vec<String> {
775 // Filter out -O and /O (the optimization flags) that we picked up from
776 // cc-rs because the build scripts will determine that for themselves.
777 let mut base = self.cc[&target].args().iter()
778 .map(|s| s.to_string_lossy().into_owned())
779 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
780 .collect::<Vec<String>>();
782 // If we're compiling on macOS then we add a few unconditional flags
783 // indicating that we want libc++ (more filled out than libstdc++) and
784 // we want to compile for 10.7. This way we can ensure that
785 // LLVM/etc are all properly compiled.
786 if target.contains("apple-darwin") {
787 base.push("-stdlib=libc++".into());
790 // Work around an apparently bad MinGW / GCC optimization,
791 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
792 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
793 if &*target == "i686-pc-windows-gnu" {
794 base.push("-fno-omit-frame-pointer".into());
797 if let Some(map) = self.debuginfo_map(which) {
798 let cc = self.cc(target);
799 if cc.ends_with("clang") || cc.ends_with("gcc") {
800 base.push(format!("-fdebug-prefix-map={}", map));
801 } else if cc.ends_with("clang-cl.exe") {
802 base.push("-Xclang".into());
803 base.push(format!("-fdebug-prefix-map={}", map));
809 /// Returns the path to the `ar` archive utility for the target specified.
810 fn ar(&self, target: Interned<String>) -> Option<&Path> {
811 self.ar.get(&target).map(|p| &**p)
814 /// Returns the path to the `ranlib` utility for the target specified.
815 fn ranlib(&self, target: Interned<String>) -> Option<&Path> {
816 self.ranlib.get(&target).map(|p| &**p)
819 /// Returns the path to the C++ compiler for the target specified.
820 fn cxx(&self, target: Interned<String>) -> Result<&Path, String> {
821 match self.cxx.get(&target) {
822 Some(p) => Ok(p.path()),
824 "target `{}` is not configured as a host, only as a target",
829 /// Returns the path to the linker for the given target if it needs to be overridden.
830 fn linker(&self, target: Interned<String>) -> Option<&Path> {
831 if let Some(linker) = self.config.target_config.get(&target)
832 .and_then(|c| c.linker.as_ref()) {
834 } else if target != self.config.build &&
835 !target.contains("msvc") &&
836 !target.contains("emscripten") &&
837 !target.contains("wasm32") &&
838 !target.contains("nvptx") &&
839 !target.contains("fuchsia") {
840 Some(self.cc(target))
846 /// Returns if this target should statically link the C runtime, if specified
847 fn crt_static(&self, target: Interned<String>) -> Option<bool> {
848 if target.contains("pc-windows-msvc") {
851 self.config.target_config.get(&target)
852 .and_then(|t| t.crt_static)
856 /// Returns the "musl root" for this `target`, if defined
857 fn musl_root(&self, target: Interned<String>) -> Option<&Path> {
858 self.config.target_config.get(&target)
859 .and_then(|t| t.musl_root.as_ref())
860 .or(self.config.musl_root.as_ref())
864 /// Returns `true` if this is a no-std `target`, if defined
865 fn no_std(&self, target: Interned<String>) -> Option<bool> {
866 self.config.target_config.get(&target)
870 /// Returns `true` if the target will be tested using the `remote-test-client`
871 /// and `remote-test-server` binaries.
872 fn remote_tested(&self, target: Interned<String>) -> bool {
873 self.qemu_rootfs(target).is_some() || target.contains("android") ||
874 env::var_os("TEST_DEVICE_ADDR").is_some()
877 /// Returns the root of the "rootfs" image that this target will be using,
878 /// if one was configured.
880 /// If `Some` is returned then that means that tests for this target are
881 /// emulated with QEMU and binaries will need to be shipped to the emulator.
882 fn qemu_rootfs(&self, target: Interned<String>) -> Option<&Path> {
883 self.config.target_config.get(&target)
884 .and_then(|t| t.qemu_rootfs.as_ref())
888 /// Path to the python interpreter to use
889 fn python(&self) -> &Path {
890 self.config.python.as_ref().unwrap()
893 /// Temporary directory that extended error information is emitted to.
894 fn extended_error_dir(&self) -> PathBuf {
895 self.out.join("tmp/extended-error-metadata")
898 /// Tests whether the `compiler` compiling for `target` should be forced to
899 /// use a stage1 compiler instead.
901 /// Currently, by default, the build system does not perform a "full
902 /// bootstrap" by default where we compile the compiler three times.
903 /// Instead, we compile the compiler two times. The final stage (stage2)
904 /// just copies the libraries from the previous stage, which is what this
907 /// Here we return `true` if:
909 /// * The build isn't performing a full bootstrap
910 /// * The `compiler` is in the final stage, 2
911 /// * We're not cross-compiling, so the artifacts are already available in
914 /// When all of these conditions are met the build will lift artifacts from
915 /// the previous stage forward.
916 fn force_use_stage1(&self, compiler: Compiler, target: Interned<String>) -> bool {
917 !self.config.full_bootstrap &&
918 compiler.stage >= 2 &&
919 (self.hosts.iter().any(|h| *h == target) || target == self.build)
922 /// Given `num` in the form "a.b.c" return a "release string" which
923 /// describes the release version number.
925 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
926 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
927 fn release(&self, num: &str) -> String {
928 match &self.config.channel[..] {
929 "stable" => num.to_string(),
930 "beta" => if self.rust_info.is_git() {
931 format!("{}-beta.{}", num, self.beta_prerelease_version())
933 format!("{}-beta", num)
935 "nightly" => format!("{}-nightly", num),
936 _ => format!("{}-dev", num),
940 fn beta_prerelease_version(&self) -> u32 {
941 if let Some(s) = self.prerelease_version.get() {
950 .current_dir(&self.src)
952 let beta = beta.trim().split_whitespace().next().unwrap();
958 .current_dir(&self.src)
960 let master = master.trim().split_whitespace().next().unwrap();
962 // Figure out where the current beta branch started.
968 .current_dir(&self.src),
970 let base = base.trim();
972 // Next figure out how many merge commits happened since we branched off
973 // beta. That's our beta number!
979 .arg(format!("{}...HEAD", base))
980 .current_dir(&self.src),
982 let n = count.trim().parse().unwrap();
983 self.prerelease_version.set(Some(n));
987 /// Returns the value of `release` above for Rust itself.
988 fn rust_release(&self) -> String {
989 self.release(channel::CFG_RELEASE_NUM)
992 /// Returns the "package version" for a component given the `num` release
995 /// The package version is typically what shows up in the names of tarballs.
996 /// For channels like beta/nightly it's just the channel name, otherwise
997 /// it's the `num` provided.
998 fn package_vers(&self, num: &str) -> String {
999 match &self.config.channel[..] {
1000 "stable" => num.to_string(),
1001 "beta" => "beta".to_string(),
1002 "nightly" => "nightly".to_string(),
1003 _ => format!("{}-dev", num),
1007 /// Returns the value of `package_vers` above for Rust itself.
1008 fn rust_package_vers(&self) -> String {
1009 self.package_vers(channel::CFG_RELEASE_NUM)
1012 /// Returns the value of `package_vers` above for Cargo
1013 fn cargo_package_vers(&self) -> String {
1014 self.package_vers(&self.release_num("cargo"))
1017 /// Returns the value of `package_vers` above for rls
1018 fn rls_package_vers(&self) -> String {
1019 self.package_vers(&self.release_num("rls"))
1022 /// Returns the value of `package_vers` above for clippy
1023 fn clippy_package_vers(&self) -> String {
1024 self.package_vers(&self.release_num("clippy"))
1027 /// Returns the value of `package_vers` above for miri
1028 fn miri_package_vers(&self) -> String {
1029 self.package_vers(&self.release_num("miri"))
1032 /// Returns the value of `package_vers` above for rustfmt
1033 fn rustfmt_package_vers(&self) -> String {
1034 self.package_vers(&self.release_num("rustfmt"))
1037 fn llvm_tools_package_vers(&self) -> String {
1038 self.package_vers(&self.rust_version())
1041 fn llvm_tools_vers(&self) -> String {
1045 fn lldb_package_vers(&self) -> String {
1046 self.package_vers(&self.rust_version())
1049 fn lldb_vers(&self) -> String {
1053 fn llvm_link_tools_dynamically(&self, target: Interned<String>) -> bool {
1054 (target.contains("linux-gnu") || target.contains("apple-darwin"))
1057 /// Returns the `version` string associated with this compiler for Rust
1060 /// Note that this is a descriptive string which includes the commit date,
1061 /// sha, version, etc.
1062 fn rust_version(&self) -> String {
1063 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1066 /// Returns the full commit hash.
1067 fn rust_sha(&self) -> Option<&str> {
1068 self.rust_info.sha()
1071 /// Returns the `a.b.c` version that the given package is at.
1072 fn release_num(&self, package: &str) -> String {
1073 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1074 let toml = t!(fs::read_to_string(&toml_file_name));
1075 for line in toml.lines() {
1076 let prefix = "version = \"";
1078 if line.starts_with(prefix) && line.ends_with(suffix) {
1079 return line[prefix.len()..line.len() - suffix.len()].to_string()
1083 panic!("failed to find version in {}'s Cargo.toml", package)
1086 /// Returns `true` if unstable features should be enabled for the compiler
1088 fn unstable_features(&self) -> bool {
1089 match &self.config.channel[..] {
1090 "stable" | "beta" => false,
1091 "nightly" | _ => true,
1095 /// Fold the output of the commands after this method into a group. The fold
1096 /// ends when the returned object is dropped. Folding can only be used in
1097 /// the Travis CI environment.
1098 pub fn fold_output<D, F>(&self, name: F) -> Option<OutputFolder>
1099 where D: Into<String>, F: FnOnce() -> D
1101 if !self.config.dry_run && self.ci_env == CiEnv::Travis {
1102 Some(OutputFolder::new(name().into()))
1108 /// Updates the actual toolstate of a tool.
1110 /// The toolstates are saved to the file specified by the key
1111 /// `rust.save-toolstates` in `config.toml`. If unspecified, nothing will be
1112 /// done. The file is updated immediately after this function completes.
1113 pub fn save_toolstate(&self, tool: &str, state: ToolState) {
1114 use std::io::{Seek, SeekFrom};
1116 if let Some(ref path) = self.config.save_toolstates {
1117 let mut file = t!(fs::OpenOptions::new()
1123 let mut current_toolstates: HashMap<Box<str>, ToolState> =
1124 serde_json::from_reader(&mut file).unwrap_or_default();
1125 current_toolstates.insert(tool.into(), state);
1126 t!(file.seek(SeekFrom::Start(0)));
1127 t!(file.set_len(0));
1128 t!(serde_json::to_writer(file, ¤t_toolstates));
1132 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1133 let mut ret = Vec::new();
1134 let mut list = vec![INTERNER.intern_str(root)];
1135 let mut visited = HashSet::new();
1136 while let Some(krate) = list.pop() {
1137 let krate = &self.crates[&krate];
1138 if krate.is_local(self) {
1141 for dep in &krate.deps {
1142 if visited.insert(dep) && dep != "build_helper" {
1150 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, bool)> {
1151 if self.config.dry_run {
1155 let mut paths = Vec::new();
1156 let contents = t!(fs::read(stamp));
1157 // This is the method we use for extracting paths from the stamp file passed to us. See
1158 // run_cargo for more information (in compile.rs).
1159 for part in contents.split(|b| *b == 0) {
1160 if part.is_empty() {
1163 let host = part[0] as char == 'h';
1164 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1165 paths.push((path, host));
1170 /// Copies a file from `src` to `dst`
1171 pub fn copy(&self, src: &Path, dst: &Path) {
1172 if self.config.dry_run { return; }
1173 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1174 let _ = fs::remove_file(&dst);
1175 let metadata = t!(src.symlink_metadata());
1176 if metadata.file_type().is_symlink() {
1177 let link = t!(fs::read_link(src));
1178 t!(symlink_file(link, dst));
1179 } else if let Ok(()) = fs::hard_link(src, dst) {
1180 // Attempt to "easy copy" by creating a hard link
1181 // (symlinks don't work on windows), but if that fails
1182 // just fall back to a slow `copy` operation.
1184 if let Err(e) = fs::copy(src, dst) {
1185 panic!("failed to copy `{}` to `{}`: {}", src.display(),
1188 t!(fs::set_permissions(dst, metadata.permissions()));
1189 let atime = FileTime::from_last_access_time(&metadata);
1190 let mtime = FileTime::from_last_modification_time(&metadata);
1191 t!(filetime::set_file_times(dst, atime, mtime));
1195 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1196 /// new string for each replacement.)
1197 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1198 if self.config.dry_run { return; }
1199 let mut contents = String::new();
1200 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1201 t!(file.read_to_string(&mut contents));
1202 for &(target, replacement) in replacements {
1203 contents = contents.replace(target, replacement);
1205 t!(file.seek(SeekFrom::Start(0)));
1206 t!(file.set_len(0));
1207 t!(file.write_all(contents.as_bytes()));
1210 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1211 /// when this function is called.
1212 pub fn cp_r(&self, src: &Path, dst: &Path) {
1213 if self.config.dry_run { return; }
1214 for f in t!(fs::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 { return; }
1266 let dst = dstdir.join(src.file_name().unwrap());
1267 t!(fs::create_dir_all(dstdir));
1268 drop(fs::remove_file(&dst));
1271 panic!("Error: File \"{}\" not found!", src.display());
1273 let metadata = t!(src.symlink_metadata());
1274 if let Err(e) = fs::copy(&src, &dst) {
1275 panic!("failed to copy `{}` to `{}`: {}", src.display(),
1278 t!(fs::set_permissions(&dst, metadata.permissions()));
1279 let atime = FileTime::from_last_access_time(&metadata);
1280 let mtime = FileTime::from_last_modification_time(&metadata);
1281 t!(filetime::set_file_times(&dst, atime, mtime));
1286 fn create(&self, path: &Path, s: &str) {
1287 if self.config.dry_run { return; }
1288 t!(fs::write(path, s));
1291 fn read(&self, path: &Path) -> String {
1292 if self.config.dry_run { return String::new(); }
1293 t!(fs::read_to_string(path))
1296 fn create_dir(&self, dir: &Path) {
1297 if self.config.dry_run { return; }
1298 t!(fs::create_dir_all(dir))
1301 fn remove_dir(&self, dir: &Path) {
1302 if self.config.dry_run { return; }
1303 t!(fs::remove_dir_all(dir))
1306 fn read_dir(&self, dir: &Path) -> impl Iterator<Item=fs::DirEntry> {
1307 let iter = match fs::read_dir(dir) {
1309 Err(_) if self.config.dry_run => return vec![].into_iter(),
1310 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1312 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1315 fn remove(&self, f: &Path) {
1316 if self.config.dry_run { return; }
1317 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1322 fn chmod(path: &Path, perms: u32) {
1323 use std::os::unix::fs::*;
1324 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1327 fn chmod(_path: &Path, _perms: u32) {}
1331 pub fn with_stage(mut self, stage: u32) -> Compiler {
1336 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1337 pub fn is_snapshot(&self, build: &Build) -> bool {
1338 self.stage == 0 && self.host == build.build
1341 /// Returns if this compiler should be treated as a final stage one in the
1342 /// current build session.
1343 /// This takes into account whether we're performing a full bootstrap or
1344 /// not; don't directly compare the stage with `2`!
1345 pub fn is_final_stage(&self, build: &Build) -> bool {
1346 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1347 self.stage >= final_stage