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
195 /// A structure representing a Rust compiler.
197 /// Each compiler has a `stage` that it is associated with and a `host` that
198 /// corresponds to the platform the compiler runs on. This structure is used as
199 /// a parameter to many methods below.
200 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
201 pub struct Compiler {
203 host: Interned<String>,
206 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
208 // Default, run normal tests and doc tests.
210 // Do not run any doc tests.
212 // Only run doc tests.
221 /// Global configuration for the build system.
223 /// This structure transitively contains all configuration for the build system.
224 /// All filesystem-encoded configuration is in `config`, all flags are in
225 /// `flags`, and then parsed or probed information is listed in the keys below.
227 /// This structure is a parameter of almost all methods in the build system,
228 /// although most functions are implemented as free functions rather than
229 /// methods specifically on this structure itself (to make it easier to
232 // User-specified configuration via config.toml
235 // Derived properties from the above two configurations
238 rust_info: channel::GitInfo,
239 cargo_info: channel::GitInfo,
240 rls_info: channel::GitInfo,
241 clippy_info: channel::GitInfo,
242 miri_info: channel::GitInfo,
243 rustfmt_info: channel::GitInfo,
244 in_tree_llvm_info: channel::GitInfo,
245 emscripten_llvm_info: channel::GitInfo,
251 // Targets for which to build.
252 build: Interned<String>,
253 hosts: Vec<Interned<String>>,
254 targets: Vec<Interned<String>>,
256 // Stage 0 (downloaded) compiler and cargo or their local rust equivalents.
257 initial_rustc: PathBuf,
258 initial_cargo: PathBuf,
260 // Runtime state filled in later on
261 // C/C++ compilers and archiver for all targets
262 cc: HashMap<Interned<String>, cc::Tool>,
263 cxx: HashMap<Interned<String>, cc::Tool>,
264 ar: HashMap<Interned<String>, PathBuf>,
265 ranlib: HashMap<Interned<String>, PathBuf>,
267 crates: HashMap<Interned<String>, Crate>,
270 delayed_failures: RefCell<Vec<String>>,
271 prerelease_version: Cell<Option<u32>>,
272 tool_artifacts: RefCell<HashMap<
274 HashMap<String, (&'static str, PathBuf, Vec<String>)>
280 name: Interned<String>,
282 deps: HashSet<Interned<String>>,
292 fn is_local(&self, build: &Build) -> bool {
293 self.path.starts_with(&build.config.src) &&
294 !self.path.to_string_lossy().ends_with("_shim")
297 fn local_path(&self, build: &Build) -> PathBuf {
298 assert!(self.is_local(build));
299 self.path.strip_prefix(&build.config.src).unwrap().into()
303 /// The various "modes" of invoking Cargo.
305 /// These entries currently correspond to the various output directories of the
306 /// build system, with each mod generating output in a different directory.
307 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
309 /// Build the standard library, placing output in the "stageN-std" directory.
312 /// Build libtest, placing output in the "stageN-test" directory.
315 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
318 /// Build codegen libraries, placing output in the "stageN-codegen" directory
321 /// Build some tools, placing output in the "stageN-tools" directory. The
322 /// "other" here is for miscellaneous sets of tools that are built using the
323 /// bootstrap compiler in its entirety (target libraries and all).
324 /// Typically these tools compile with stable Rust.
327 /// Compile a tool which uses all libraries we compile (up to rustc).
328 /// Doesn't use the stage0 compiler libraries like "other", and includes
329 /// tools like rustdoc, cargo, rls, etc.
336 pub fn is_tool(&self) -> bool {
338 Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd => true,
345 /// Creates a new set of build configuration from the `flags` on the command
346 /// line and the filesystem `config`.
348 /// By default all build output will be placed in the current directory.
349 pub fn new(config: Config) -> Build {
350 let src = config.src.clone();
351 let out = config.out.clone();
353 let is_sudo = match env::var_os("SUDO_USER") {
355 match env::var_os("USER") {
356 Some(user) => user != sudo_user,
362 let rust_info = channel::GitInfo::new(&config, &src);
363 let cargo_info = channel::GitInfo::new(&config, &src.join("src/tools/cargo"));
364 let rls_info = channel::GitInfo::new(&config, &src.join("src/tools/rls"));
365 let clippy_info = channel::GitInfo::new(&config, &src.join("src/tools/clippy"));
366 let miri_info = channel::GitInfo::new(&config, &src.join("src/tools/miri"));
367 let rustfmt_info = channel::GitInfo::new(&config, &src.join("src/tools/rustfmt"));
368 let in_tree_llvm_info = channel::GitInfo::new(&config, &src.join("src/llvm-project"));
369 let emscripten_llvm_info = channel::GitInfo::new(&config, &src.join("src/llvm-emscripten"));
371 let mut build = Build {
372 initial_rustc: config.initial_rustc.clone(),
373 initial_cargo: config.initial_cargo.clone(),
374 local_rebuild: config.local_rebuild,
375 fail_fast: config.cmd.fail_fast(),
376 doc_tests: config.cmd.doc_tests(),
377 verbosity: config.verbose,
380 hosts: config.hosts.clone(),
381 targets: config.targets.clone(),
394 emscripten_llvm_info,
398 ranlib: HashMap::new(),
399 crates: HashMap::new(),
401 ci_env: CiEnv::current(),
402 delayed_failures: RefCell::new(Vec::new()),
403 prerelease_version: Cell::new(None),
404 tool_artifacts: Default::default(),
407 build.verbose("finding compilers");
408 cc_detect::find(&mut build);
409 build.verbose("running sanity check");
410 sanity::check(&mut build);
412 // If local-rust is the same major.minor as the current version, then force a
414 let local_version_verbose = output(
415 Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
416 let local_release = local_version_verbose
417 .lines().filter(|x| x.starts_with("release:"))
418 .next().unwrap().trim_start_matches("release:").trim();
419 let my_version = channel::CFG_RELEASE_NUM;
420 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
421 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
422 build.local_rebuild = true;
425 build.verbose("learning about cargo");
426 metadata::build(&mut build);
431 pub fn build_triple(&self) -> &[Interned<String>] {
433 slice::from_raw_parts(&self.build, 1)
437 /// Executes the entire build, as configured by the flags and configuration.
438 pub fn build(&mut self) {
443 if let Subcommand::Clean { all } = self.config.cmd {
444 return clean::clean(self, all);
448 let builder = builder::Builder::new(&self);
449 if let Some(path) = builder.paths.get(0) {
450 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
456 if !self.config.dry_run {
458 self.config.dry_run = true;
459 let builder = builder::Builder::new(&self);
460 builder.execute_cli();
462 self.config.dry_run = false;
463 let builder = builder::Builder::new(&self);
464 builder.execute_cli();
466 let builder = builder::Builder::new(&self);
467 let _ = builder.execute_cli();
470 // Check for postponed failures from `test --no-fail-fast`.
471 let failures = self.delayed_failures.borrow();
472 if failures.len() > 0 {
473 println!("\n{} command(s) did not execute successfully:\n", failures.len());
474 for failure in failures.iter() {
475 println!(" - {}\n", failure);
481 /// Clear out `dir` if `input` is newer.
483 /// After this executes, it will also ensure that `dir` exists.
484 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
485 let stamp = dir.join(".stamp");
486 let mut cleared = false;
487 if mtime(&stamp) < mtime(input) {
488 self.verbose(&format!("Dirty - {}", dir.display()));
489 let _ = fs::remove_dir_all(dir);
491 } else if stamp.exists() {
494 t!(fs::create_dir_all(dir));
495 t!(File::create(stamp));
499 /// Gets the space-separated set of activated features for the standard
501 fn std_features(&self) -> String {
502 let mut features = "panic-unwind".to_string();
504 if self.config.backtrace {
505 features.push_str(" backtrace");
507 if self.config.profiler {
508 features.push_str(" profiler");
510 if self.config.wasm_syscall {
511 features.push_str(" wasm_syscall");
516 /// Gets the space-separated set of activated features for the compiler.
517 fn rustc_features(&self) -> String {
518 let mut features = String::new();
519 if self.config.jemalloc {
520 features.push_str("jemalloc");
525 /// Component directory that Cargo will produce output into (e.g.
527 fn cargo_dir(&self) -> &'static str {
528 if self.config.rust_optimize {"release"} else {"debug"}
531 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
532 let out = self.out.join(&*compiler.host).join(format!("stage{}-tools-bin", compiler.stage));
533 t!(fs::create_dir_all(&out));
537 /// Returns the root directory for all output generated in a particular
538 /// stage when running with a particular host compiler.
540 /// The mode indicates what the root directory is for.
541 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
542 let suffix = match mode {
544 Mode::Test => "-test",
545 Mode::Rustc => "-rustc",
546 Mode::Codegen => "-codegen",
547 Mode::ToolBootstrap => "-bootstrap-tools",
548 Mode::ToolStd => "-tools",
549 Mode::ToolTest => "-tools",
550 Mode::ToolRustc => "-tools",
552 self.out.join(&*compiler.host)
553 .join(format!("stage{}{}", compiler.stage, suffix))
556 /// Returns the root output directory for all Cargo output in a given stage,
557 /// running a particular compiler, whether or not we're building the
558 /// standard library, and targeting the specified architecture.
562 target: Interned<String>) -> PathBuf {
563 self.stage_out(compiler, mode).join(&*target).join(self.cargo_dir())
566 /// Root output directory for LLVM compiled for `target`
568 /// Note that if LLVM is configured externally then the directory returned
569 /// will likely be empty.
570 fn llvm_out(&self, target: Interned<String>) -> PathBuf {
571 self.out.join(&*target).join("llvm")
574 fn emscripten_llvm_out(&self, target: Interned<String>) -> PathBuf {
575 self.out.join(&*target).join("llvm-emscripten")
578 fn lld_out(&self, target: Interned<String>) -> PathBuf {
579 self.out.join(&*target).join("lld")
582 /// Output directory for all documentation for a target
583 fn doc_out(&self, target: Interned<String>) -> PathBuf {
584 self.out.join(&*target).join("doc")
587 /// Output directory for all documentation for a target
588 fn compiler_doc_out(&self, target: Interned<String>) -> PathBuf {
589 self.out.join(&*target).join("compiler-doc")
592 /// Output directory for some generated md crate documentation for a target (temporary)
593 fn md_doc_out(&self, target: Interned<String>) -> Interned<PathBuf> {
594 INTERNER.intern_path(self.out.join(&*target).join("md-doc"))
597 /// Output directory for all crate documentation for a target (temporary)
599 /// The artifacts here are then copied into `doc_out` above.
600 fn crate_doc_out(&self, target: Interned<String>) -> PathBuf {
601 self.out.join(&*target).join("crate-docs")
604 /// Returns `true` if no custom `llvm-config` is set for the specified target.
606 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
607 fn is_rust_llvm(&self, target: Interned<String>) -> bool {
608 match self.config.target_config.get(&target) {
609 Some(ref c) => c.llvm_config.is_none(),
614 /// Returns the path to `FileCheck` binary for the specified target
615 fn llvm_filecheck(&self, target: Interned<String>) -> PathBuf {
616 let target_config = self.config.target_config.get(&target);
617 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
619 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
620 let llvm_bindir = output(Command::new(s).arg("--bindir"));
621 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", &*target));
622 if filecheck.exists() {
625 // On Fedora the system LLVM installs FileCheck in the
626 // llvm subdirectory of the libdir.
627 let llvm_libdir = output(Command::new(s).arg("--libdir"));
628 let lib_filecheck = Path::new(llvm_libdir.trim())
629 .join("llvm").join(exe("FileCheck", &*target));
630 if lib_filecheck.exists() {
633 // Return the most normal file name, even though
634 // it doesn't exist, so that any error message
640 let base = self.llvm_out(self.config.build).join("build");
641 let base = if !self.config.ninja && self.config.build.contains("msvc") {
642 if self.config.llvm_optimize {
643 if self.config.llvm_release_debuginfo {
644 base.join("RelWithDebInfo")
654 base.join("bin").join(exe("FileCheck", &*target))
658 /// Directory for libraries built from C/C++ code and shared between stages.
659 fn native_dir(&self, target: Interned<String>) -> PathBuf {
660 self.out.join(&*target).join("native")
663 /// Root output directory for rust_test_helpers library compiled for
665 fn test_helpers_out(&self, target: Interned<String>) -> PathBuf {
666 self.native_dir(target).join("rust-test-helpers")
669 /// Adds the `RUST_TEST_THREADS` env var if necessary
670 fn add_rust_test_threads(&self, cmd: &mut Command) {
671 if env::var_os("RUST_TEST_THREADS").is_none() {
672 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
676 /// Returns the libdir of the snapshot compiler.
677 fn rustc_snapshot_libdir(&self) -> PathBuf {
678 self.rustc_snapshot_sysroot().join(libdir(&self.config.build))
681 /// Returns the sysroot of the snapshot compiler.
682 fn rustc_snapshot_sysroot(&self) -> &Path {
683 self.initial_rustc.parent().unwrap().parent().unwrap()
686 /// Runs a command, printing out nice contextual information if it fails.
687 fn run(&self, cmd: &mut Command) {
688 if self.config.dry_run { return; }
689 self.verbose(&format!("running: {:?}", cmd));
693 /// Runs a command, printing out nice contextual information if it fails.
694 fn run_quiet(&self, cmd: &mut Command) {
695 if self.config.dry_run { return; }
696 self.verbose(&format!("running: {:?}", cmd));
700 /// Runs a command, printing out nice contextual information if it fails.
701 /// Exits if the command failed to execute at all, otherwise returns its
702 /// `status.success()`.
703 fn try_run(&self, cmd: &mut Command) -> bool {
704 if self.config.dry_run { return true; }
705 self.verbose(&format!("running: {:?}", cmd));
709 /// Runs a command, printing out nice contextual information if it fails.
710 /// Exits if the command failed to execute at all, otherwise returns its
711 /// `status.success()`.
712 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
713 if self.config.dry_run { return true; }
714 self.verbose(&format!("running: {:?}", cmd));
715 try_run_suppressed(cmd)
718 pub fn is_verbose(&self) -> bool {
722 /// Prints a message if this build is configured in verbose mode.
723 fn verbose(&self, msg: &str) {
724 if self.is_verbose() {
729 fn info(&self, msg: &str) {
730 if self.config.dry_run { return; }
734 /// Returns the number of parallel jobs that have been configured for this
736 fn jobs(&self) -> u32 {
737 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
740 fn debuginfo_map(&self, which: GitRepo) -> Option<String> {
741 if !self.config.rust_remap_debuginfo {
745 let path = match which {
747 let sha = self.rust_sha().unwrap_or(channel::CFG_RELEASE_NUM);
748 format!("/rustc/{}", sha)
750 GitRepo::Llvm => String::from("/rustc/llvm"),
752 Some(format!("{}={}", self.src.display(), path))
755 /// Returns the path to the C compiler for the target specified.
756 fn cc(&self, target: Interned<String>) -> &Path {
757 self.cc[&target].path()
760 /// Returns a list of flags to pass to the C compiler for the target
762 fn cflags(&self, target: Interned<String>, which: GitRepo) -> Vec<String> {
763 // Filter out -O and /O (the optimization flags) that we picked up from
764 // cc-rs because the build scripts will determine that for themselves.
765 let mut base = self.cc[&target].args().iter()
766 .map(|s| s.to_string_lossy().into_owned())
767 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
768 .collect::<Vec<String>>();
770 // If we're compiling on macOS then we add a few unconditional flags
771 // indicating that we want libc++ (more filled out than libstdc++) and
772 // we want to compile for 10.7. This way we can ensure that
773 // LLVM/etc are all properly compiled.
774 if target.contains("apple-darwin") {
775 base.push("-stdlib=libc++".into());
778 // Work around an apparently bad MinGW / GCC optimization,
779 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
780 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
781 if &*target == "i686-pc-windows-gnu" {
782 base.push("-fno-omit-frame-pointer".into());
785 if let Some(map) = self.debuginfo_map(which) {
786 let cc = self.cc(target);
787 if cc.ends_with("clang") || cc.ends_with("gcc") {
788 base.push(format!("-fdebug-prefix-map={}", map));
789 } else if cc.ends_with("clang-cl.exe") {
790 base.push("-Xclang".into());
791 base.push(format!("-fdebug-prefix-map={}", map));
797 /// Returns the path to the `ar` archive utility for the target specified.
798 fn ar(&self, target: Interned<String>) -> Option<&Path> {
799 self.ar.get(&target).map(|p| &**p)
802 /// Returns the path to the `ranlib` utility for the target specified.
803 fn ranlib(&self, target: Interned<String>) -> Option<&Path> {
804 self.ranlib.get(&target).map(|p| &**p)
807 /// Returns the path to the C++ compiler for the target specified.
808 fn cxx(&self, target: Interned<String>) -> Result<&Path, String> {
809 match self.cxx.get(&target) {
810 Some(p) => Ok(p.path()),
812 "target `{}` is not configured as a host, only as a target",
817 /// Returns the path to the linker for the given target if it needs to be overridden.
818 fn linker(&self, target: Interned<String>) -> Option<&Path> {
819 if let Some(linker) = self.config.target_config.get(&target)
820 .and_then(|c| c.linker.as_ref()) {
822 } else if target != self.config.build &&
823 !target.contains("msvc") &&
824 !target.contains("emscripten") &&
825 !target.contains("wasm32") &&
826 !target.contains("nvptx") &&
827 !target.contains("fuchsia") {
828 Some(self.cc(target))
834 /// Returns if this target should statically link the C runtime, if specified
835 fn crt_static(&self, target: Interned<String>) -> Option<bool> {
836 if target.contains("pc-windows-msvc") {
839 self.config.target_config.get(&target)
840 .and_then(|t| t.crt_static)
844 /// Returns the "musl root" for this `target`, if defined
845 fn musl_root(&self, target: Interned<String>) -> Option<&Path> {
846 self.config.target_config.get(&target)
847 .and_then(|t| t.musl_root.as_ref())
848 .or(self.config.musl_root.as_ref())
852 /// Returns `true` if this is a no-std `target`, if defined
853 fn no_std(&self, target: Interned<String>) -> Option<bool> {
854 self.config.target_config.get(&target)
858 /// Returns `true` if the target will be tested using the `remote-test-client`
859 /// and `remote-test-server` binaries.
860 fn remote_tested(&self, target: Interned<String>) -> bool {
861 self.qemu_rootfs(target).is_some() || target.contains("android") ||
862 env::var_os("TEST_DEVICE_ADDR").is_some()
865 /// Returns the root of the "rootfs" image that this target will be using,
866 /// if one was configured.
868 /// If `Some` is returned then that means that tests for this target are
869 /// emulated with QEMU and binaries will need to be shipped to the emulator.
870 fn qemu_rootfs(&self, target: Interned<String>) -> Option<&Path> {
871 self.config.target_config.get(&target)
872 .and_then(|t| t.qemu_rootfs.as_ref())
876 /// Path to the python interpreter to use
877 fn python(&self) -> &Path {
878 self.config.python.as_ref().unwrap()
881 /// Temporary directory that extended error information is emitted to.
882 fn extended_error_dir(&self) -> PathBuf {
883 self.out.join("tmp/extended-error-metadata")
886 /// Tests whether the `compiler` compiling for `target` should be forced to
887 /// use a stage1 compiler instead.
889 /// Currently, by default, the build system does not perform a "full
890 /// bootstrap" by default where we compile the compiler three times.
891 /// Instead, we compile the compiler two times. The final stage (stage2)
892 /// just copies the libraries from the previous stage, which is what this
895 /// Here we return `true` if:
897 /// * The build isn't performing a full bootstrap
898 /// * The `compiler` is in the final stage, 2
899 /// * We're not cross-compiling, so the artifacts are already available in
902 /// When all of these conditions are met the build will lift artifacts from
903 /// the previous stage forward.
904 fn force_use_stage1(&self, compiler: Compiler, target: Interned<String>) -> bool {
905 !self.config.full_bootstrap &&
906 compiler.stage >= 2 &&
907 (self.hosts.iter().any(|h| *h == target) || target == self.build)
910 /// Given `num` in the form "a.b.c" return a "release string" which
911 /// describes the release version number.
913 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
914 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
915 fn release(&self, num: &str) -> String {
916 match &self.config.channel[..] {
917 "stable" => num.to_string(),
918 "beta" => if self.rust_info.is_git() {
919 format!("{}-beta.{}", num, self.beta_prerelease_version())
921 format!("{}-beta", num)
923 "nightly" => format!("{}-nightly", num),
924 _ => format!("{}-dev", num),
928 fn beta_prerelease_version(&self) -> u32 {
929 if let Some(s) = self.prerelease_version.get() {
938 .current_dir(&self.src)
940 let beta = beta.trim().split_whitespace().next().unwrap();
946 .current_dir(&self.src)
948 let master = master.trim().split_whitespace().next().unwrap();
950 // Figure out where the current beta branch started.
956 .current_dir(&self.src),
958 let base = base.trim();
960 // Next figure out how many merge commits happened since we branched off
961 // beta. That's our beta number!
967 .arg(format!("{}...HEAD", base))
968 .current_dir(&self.src),
970 let n = count.trim().parse().unwrap();
971 self.prerelease_version.set(Some(n));
975 /// Returns the value of `release` above for Rust itself.
976 fn rust_release(&self) -> String {
977 self.release(channel::CFG_RELEASE_NUM)
980 /// Returns the "package version" for a component given the `num` release
983 /// The package version is typically what shows up in the names of tarballs.
984 /// For channels like beta/nightly it's just the channel name, otherwise
985 /// it's the `num` provided.
986 fn package_vers(&self, num: &str) -> String {
987 match &self.config.channel[..] {
988 "stable" => num.to_string(),
989 "beta" => "beta".to_string(),
990 "nightly" => "nightly".to_string(),
991 _ => format!("{}-dev", num),
995 /// Returns the value of `package_vers` above for Rust itself.
996 fn rust_package_vers(&self) -> String {
997 self.package_vers(channel::CFG_RELEASE_NUM)
1000 /// Returns the value of `package_vers` above for Cargo
1001 fn cargo_package_vers(&self) -> String {
1002 self.package_vers(&self.release_num("cargo"))
1005 /// Returns the value of `package_vers` above for rls
1006 fn rls_package_vers(&self) -> String {
1007 self.package_vers(&self.release_num("rls"))
1010 /// Returns the value of `package_vers` above for clippy
1011 fn clippy_package_vers(&self) -> String {
1012 self.package_vers(&self.release_num("clippy"))
1015 /// Returns the value of `package_vers` above for miri
1016 fn miri_package_vers(&self) -> String {
1017 self.package_vers(&self.release_num("miri"))
1020 /// Returns the value of `package_vers` above for rustfmt
1021 fn rustfmt_package_vers(&self) -> String {
1022 self.package_vers(&self.release_num("rustfmt"))
1025 fn llvm_tools_package_vers(&self) -> String {
1026 self.package_vers(&self.rust_version())
1029 fn llvm_tools_vers(&self) -> String {
1033 fn lldb_package_vers(&self) -> String {
1034 self.package_vers(&self.rust_version())
1037 fn lldb_vers(&self) -> String {
1041 fn llvm_link_tools_dynamically(&self, target: Interned<String>) -> bool {
1042 (target.contains("linux-gnu") || target.contains("apple-darwin"))
1045 /// Returns the `version` string associated with this compiler for Rust
1048 /// Note that this is a descriptive string which includes the commit date,
1049 /// sha, version, etc.
1050 fn rust_version(&self) -> String {
1051 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1054 /// Returns the full commit hash.
1055 fn rust_sha(&self) -> Option<&str> {
1056 self.rust_info.sha()
1059 /// Returns the `a.b.c` version that the given package is at.
1060 fn release_num(&self, package: &str) -> String {
1061 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1062 let toml = t!(fs::read_to_string(&toml_file_name));
1063 for line in toml.lines() {
1064 let prefix = "version = \"";
1066 if line.starts_with(prefix) && line.ends_with(suffix) {
1067 return line[prefix.len()..line.len() - suffix.len()].to_string()
1071 panic!("failed to find version in {}'s Cargo.toml", package)
1074 /// Returns `true` if unstable features should be enabled for the compiler
1076 fn unstable_features(&self) -> bool {
1077 match &self.config.channel[..] {
1078 "stable" | "beta" => false,
1079 "nightly" | _ => true,
1083 /// Fold the output of the commands after this method into a group. The fold
1084 /// ends when the returned object is dropped. Folding can only be used in
1085 /// the Travis CI environment.
1086 pub fn fold_output<D, F>(&self, name: F) -> Option<OutputFolder>
1087 where D: Into<String>, F: FnOnce() -> D
1089 if !self.config.dry_run && self.ci_env == CiEnv::Travis {
1090 Some(OutputFolder::new(name().into()))
1096 /// Updates the actual toolstate of a tool.
1098 /// The toolstates are saved to the file specified by the key
1099 /// `rust.save-toolstates` in `config.toml`. If unspecified, nothing will be
1100 /// done. The file is updated immediately after this function completes.
1101 pub fn save_toolstate(&self, tool: &str, state: ToolState) {
1102 use std::io::{Seek, SeekFrom};
1104 if let Some(ref path) = self.config.save_toolstates {
1105 let mut file = t!(fs::OpenOptions::new()
1111 let mut current_toolstates: HashMap<Box<str>, ToolState> =
1112 serde_json::from_reader(&mut file).unwrap_or_default();
1113 current_toolstates.insert(tool.into(), state);
1114 t!(file.seek(SeekFrom::Start(0)));
1115 t!(file.set_len(0));
1116 t!(serde_json::to_writer(file, ¤t_toolstates));
1120 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1121 let mut ret = Vec::new();
1122 let mut list = vec![INTERNER.intern_str(root)];
1123 let mut visited = HashSet::new();
1124 while let Some(krate) = list.pop() {
1125 let krate = &self.crates[&krate];
1126 if krate.is_local(self) {
1129 for dep in &krate.deps {
1130 if visited.insert(dep) && dep != "build_helper" {
1138 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, bool)> {
1139 if self.config.dry_run {
1143 let mut paths = Vec::new();
1144 let contents = t!(fs::read(stamp));
1145 // This is the method we use for extracting paths from the stamp file passed to us. See
1146 // run_cargo for more information (in compile.rs).
1147 for part in contents.split(|b| *b == 0) {
1148 if part.is_empty() {
1151 let host = part[0] as char == 'h';
1152 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1153 paths.push((path, host));
1158 /// Copies a file from `src` to `dst`
1159 pub fn copy(&self, src: &Path, dst: &Path) {
1160 if self.config.dry_run { return; }
1161 let _ = fs::remove_file(&dst);
1162 let metadata = t!(src.symlink_metadata());
1163 if metadata.file_type().is_symlink() {
1164 let link = t!(fs::read_link(src));
1165 t!(symlink_file(link, dst));
1166 } else if let Ok(()) = fs::hard_link(src, dst) {
1167 // Attempt to "easy copy" by creating a hard link
1168 // (symlinks don't work on windows), but if that fails
1169 // just fall back to a slow `copy` operation.
1171 if let Err(e) = fs::copy(src, dst) {
1172 panic!("failed to copy `{}` to `{}`: {}", src.display(),
1175 t!(fs::set_permissions(dst, metadata.permissions()));
1176 let atime = FileTime::from_last_access_time(&metadata);
1177 let mtime = FileTime::from_last_modification_time(&metadata);
1178 t!(filetime::set_file_times(dst, atime, mtime));
1182 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1183 /// new string for each replacement.)
1184 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1185 if self.config.dry_run { return; }
1186 let mut contents = String::new();
1187 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1188 t!(file.read_to_string(&mut contents));
1189 for &(target, replacement) in replacements {
1190 contents = contents.replace(target, replacement);
1192 t!(file.seek(SeekFrom::Start(0)));
1193 t!(file.set_len(0));
1194 t!(file.write_all(contents.as_bytes()));
1197 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1198 /// when this function is called.
1199 pub fn cp_r(&self, src: &Path, dst: &Path) {
1200 if self.config.dry_run { return; }
1201 for f in t!(fs::read_dir(src)) {
1203 let path = f.path();
1204 let name = path.file_name().unwrap();
1205 let dst = dst.join(name);
1206 if t!(f.file_type()).is_dir() {
1207 t!(fs::create_dir_all(&dst));
1208 self.cp_r(&path, &dst);
1210 let _ = fs::remove_file(&dst);
1211 self.copy(&path, &dst);
1216 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1217 /// when this function is called. Unwanted files or directories can be skipped
1218 /// by returning `false` from the filter function.
1219 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1220 // Immediately recurse with an empty relative path
1221 self.recurse_(src, dst, Path::new(""), filter)
1224 // Inner function does the actual work
1225 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1226 for f in self.read_dir(src) {
1227 let path = f.path();
1228 let name = path.file_name().unwrap();
1229 let dst = dst.join(name);
1230 let relative = relative.join(name);
1231 // Only copy file or directory if the filter function returns true
1232 if filter(&relative) {
1233 if t!(f.file_type()).is_dir() {
1234 let _ = fs::remove_dir_all(&dst);
1235 self.create_dir(&dst);
1236 self.recurse_(&path, &dst, &relative, filter);
1238 let _ = fs::remove_file(&dst);
1239 self.copy(&path, &dst);
1245 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1246 let file_name = src.file_name().unwrap();
1247 let dest = dest_folder.join(file_name);
1248 self.copy(src, &dest);
1251 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1252 if self.config.dry_run { return; }
1253 let dst = dstdir.join(src.file_name().unwrap());
1254 t!(fs::create_dir_all(dstdir));
1255 drop(fs::remove_file(&dst));
1258 panic!("Error: File \"{}\" not found!", src.display());
1260 let metadata = t!(src.symlink_metadata());
1261 if let Err(e) = fs::copy(&src, &dst) {
1262 panic!("failed to copy `{}` to `{}`: {}", src.display(),
1265 t!(fs::set_permissions(&dst, metadata.permissions()));
1266 let atime = FileTime::from_last_access_time(&metadata);
1267 let mtime = FileTime::from_last_modification_time(&metadata);
1268 t!(filetime::set_file_times(&dst, atime, mtime));
1273 fn create(&self, path: &Path, s: &str) {
1274 if self.config.dry_run { return; }
1275 t!(fs::write(path, s));
1278 fn read(&self, path: &Path) -> String {
1279 if self.config.dry_run { return String::new(); }
1280 t!(fs::read_to_string(path))
1283 fn create_dir(&self, dir: &Path) {
1284 if self.config.dry_run { return; }
1285 t!(fs::create_dir_all(dir))
1288 fn remove_dir(&self, dir: &Path) {
1289 if self.config.dry_run { return; }
1290 t!(fs::remove_dir_all(dir))
1293 fn read_dir(&self, dir: &Path) -> impl Iterator<Item=fs::DirEntry> {
1294 let iter = match fs::read_dir(dir) {
1296 Err(_) if self.config.dry_run => return vec![].into_iter(),
1297 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1299 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1302 fn remove(&self, f: &Path) {
1303 if self.config.dry_run { return; }
1304 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1309 fn chmod(path: &Path, perms: u32) {
1310 use std::os::unix::fs::*;
1311 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1314 fn chmod(_path: &Path, _perms: u32) {}
1318 pub fn with_stage(mut self, stage: u32) -> Compiler {
1323 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1324 pub fn is_snapshot(&self, build: &Build) -> bool {
1325 self.stage == 0 && self.host == build.build
1328 /// Returns if this compiler should be treated as a final stage one in the
1329 /// current build session.
1330 /// This takes into account whether we're performing a full bootstrap or
1331 /// not; don't directly compare the stage with `2`!
1332 pub fn is_final_stage(&self, build: &Build) -> bool {
1333 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1334 self.stage >= final_stage