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(bare_trait_objects)]
108 #![feature(core_intrinsics)]
109 #![feature(drain_filter)]
112 extern crate build_helper;
114 extern crate serde_derive;
116 extern crate lazy_static;
117 extern crate serde_json;
119 extern crate filetime;
121 extern crate getopts;
122 extern crate num_cpus;
125 extern crate petgraph;
129 extern crate pretty_assertions;
134 use std::cell::{RefCell, Cell};
135 use std::collections::{HashSet, HashMap};
137 use std::fs::{self, OpenOptions, File};
138 use std::io::{self, Seek, SeekFrom, Write, Read};
139 use std::path::{PathBuf, Path};
140 use std::process::{self, Command};
145 use std::os::unix::fs::symlink as symlink_file;
147 use std::os::windows::fs::symlink_file;
149 use build_helper::{run_silent, run_suppressed, try_run_silent, try_run_suppressed, output, mtime};
150 use filetime::FileTime;
152 use crate::util::{exe, libdir, OutputFolder, CiEnv};
177 #[cfg(all(unix, not(target_os = "haiku")))]
181 pub unsafe fn setup(build: &mut crate::Build) {
182 if build.config.low_priority {
183 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
188 #[cfg(any(target_os = "haiku", not(any(unix, windows))))]
190 pub unsafe fn setup(_build: &mut crate::Build) {
194 pub use crate::config::Config;
195 use crate::flags::Subcommand;
196 use crate::cache::{Interned, INTERNER};
197 use crate::toolstate::ToolState;
199 const LLVM_TOOLS: &[&str] = &[
200 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
201 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
202 "llvm-objdump", // used to disassemble programs
203 "llvm-profdata", // used to inspect and merge files generated by profiles
204 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
205 "llvm-size", // used to prints the size of the linker sections of a program
206 "llvm-strip", // used to discard symbols from binary files to reduce their size
209 /// A structure representing a Rust compiler.
211 /// Each compiler has a `stage` that it is associated with and a `host` that
212 /// corresponds to the platform the compiler runs on. This structure is used as
213 /// a parameter to many methods below.
214 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
215 pub struct Compiler {
217 host: Interned<String>,
220 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
222 // Default, run normal tests and doc tests.
224 // Do not run any doc tests.
226 // Only run doc tests.
235 /// Global configuration for the build system.
237 /// This structure transitively contains all configuration for the build system.
238 /// All filesystem-encoded configuration is in `config`, all flags are in
239 /// `flags`, and then parsed or probed information is listed in the keys below.
241 /// This structure is a parameter of almost all methods in the build system,
242 /// although most functions are implemented as free functions rather than
243 /// methods specifically on this structure itself (to make it easier to
246 // User-specified configuration via config.toml
249 // Derived properties from the above two configurations
252 rust_info: channel::GitInfo,
253 cargo_info: channel::GitInfo,
254 rls_info: channel::GitInfo,
255 clippy_info: channel::GitInfo,
256 miri_info: channel::GitInfo,
257 rustfmt_info: channel::GitInfo,
263 // Targets for which to build.
264 build: Interned<String>,
265 hosts: Vec<Interned<String>>,
266 targets: Vec<Interned<String>>,
268 // Stage 0 (downloaded) compiler and cargo or their local rust equivalents.
269 initial_rustc: PathBuf,
270 initial_cargo: PathBuf,
272 // Runtime state filled in later on
273 // C/C++ compilers and archiver for all targets
274 cc: HashMap<Interned<String>, cc::Tool>,
275 cxx: HashMap<Interned<String>, cc::Tool>,
276 ar: HashMap<Interned<String>, PathBuf>,
277 ranlib: HashMap<Interned<String>, PathBuf>,
279 crates: HashMap<Interned<String>, Crate>,
282 delayed_failures: RefCell<Vec<String>>,
283 prerelease_version: Cell<Option<u32>>,
284 tool_artifacts: RefCell<HashMap<
286 HashMap<String, (&'static str, PathBuf, Vec<String>)>
292 name: Interned<String>,
294 deps: HashSet<Interned<String>>,
304 fn is_local(&self, build: &Build) -> bool {
305 self.path.starts_with(&build.config.src) &&
306 !self.path.to_string_lossy().ends_with("_shim")
309 fn local_path(&self, build: &Build) -> PathBuf {
310 assert!(self.is_local(build));
311 self.path.strip_prefix(&build.config.src).unwrap().into()
315 /// The various "modes" of invoking Cargo.
317 /// These entries currently correspond to the various output directories of the
318 /// build system, with each mod generating output in a different directory.
319 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
321 /// Build the standard library, placing output in the "stageN-std" directory.
324 /// Build libtest, placing output in the "stageN-test" directory.
327 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
330 /// Build codegen libraries, placing output in the "stageN-codegen" directory
333 /// Build some tools, placing output in the "stageN-tools" directory. The
334 /// "other" here is for miscellaneous sets of tools that are built using the
335 /// bootstrap compiler in its entirety (target libraries and all).
336 /// Typically these tools compile with stable Rust.
339 /// Compile a tool which uses all libraries we compile (up to rustc).
340 /// Doesn't use the stage0 compiler libraries like "other", and includes
341 /// tools like rustdoc, cargo, rls, etc.
348 pub fn is_tool(&self) -> bool {
350 Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd => true,
357 /// Creates a new set of build configuration from the `flags` on the command
358 /// line and the filesystem `config`.
360 /// By default all build output will be placed in the current directory.
361 pub fn new(config: Config) -> Build {
362 let src = config.src.clone();
363 let out = config.out.clone();
365 let is_sudo = match env::var_os("SUDO_USER") {
367 match env::var_os("USER") {
368 Some(user) => user != sudo_user,
374 let rust_info = channel::GitInfo::new(&config, &src);
375 let cargo_info = channel::GitInfo::new(&config, &src.join("src/tools/cargo"));
376 let rls_info = channel::GitInfo::new(&config, &src.join("src/tools/rls"));
377 let clippy_info = channel::GitInfo::new(&config, &src.join("src/tools/clippy"));
378 let miri_info = channel::GitInfo::new(&config, &src.join("src/tools/miri"));
379 let rustfmt_info = channel::GitInfo::new(&config, &src.join("src/tools/rustfmt"));
381 let mut build = Build {
382 initial_rustc: config.initial_rustc.clone(),
383 initial_cargo: config.initial_cargo.clone(),
384 local_rebuild: config.local_rebuild,
385 fail_fast: config.cmd.fail_fast(),
386 doc_tests: config.cmd.doc_tests(),
387 verbosity: config.verbose,
390 hosts: config.hosts.clone(),
391 targets: config.targets.clone(),
406 ranlib: HashMap::new(),
407 crates: HashMap::new(),
409 ci_env: CiEnv::current(),
410 delayed_failures: RefCell::new(Vec::new()),
411 prerelease_version: Cell::new(None),
412 tool_artifacts: Default::default(),
415 build.verbose("finding compilers");
416 cc_detect::find(&mut build);
417 build.verbose("running sanity check");
418 sanity::check(&mut build);
420 // If local-rust is the same major.minor as the current version, then force a
422 let local_version_verbose = output(
423 Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
424 let local_release = local_version_verbose
425 .lines().filter(|x| x.starts_with("release:"))
426 .next().unwrap().trim_left_matches("release:").trim();
427 let my_version = channel::CFG_RELEASE_NUM;
428 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
429 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
430 build.local_rebuild = true;
433 build.verbose("learning about cargo");
434 metadata::build(&mut build);
439 pub fn build_triple(&self) -> &[Interned<String>] {
441 slice::from_raw_parts(&self.build, 1)
445 /// Executes the entire build, as configured by the flags and configuration.
446 pub fn build(&mut self) {
451 if let Subcommand::Clean { all } = self.config.cmd {
452 return clean::clean(self, all);
456 let builder = builder::Builder::new(&self);
457 if let Some(path) = builder.paths.get(0) {
458 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
464 if !self.config.dry_run {
466 self.config.dry_run = true;
467 let builder = builder::Builder::new(&self);
468 builder.execute_cli();
470 self.config.dry_run = false;
471 let builder = builder::Builder::new(&self);
472 builder.execute_cli();
474 let builder = builder::Builder::new(&self);
475 let _ = builder.execute_cli();
478 // Check for postponed failures from `test --no-fail-fast`.
479 let failures = self.delayed_failures.borrow();
480 if failures.len() > 0 {
481 println!("\n{} command(s) did not execute successfully:\n", failures.len());
482 for failure in failures.iter() {
483 println!(" - {}\n", failure);
489 /// Clear out `dir` if `input` is newer.
491 /// After this executes, it will also ensure that `dir` exists.
492 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
493 let stamp = dir.join(".stamp");
494 let mut cleared = false;
495 if mtime(&stamp) < mtime(input) {
496 self.verbose(&format!("Dirty - {}", dir.display()));
497 let _ = fs::remove_dir_all(dir);
499 } else if stamp.exists() {
502 t!(fs::create_dir_all(dir));
503 t!(File::create(stamp));
507 /// Get the space-separated set of activated features for the standard
509 fn std_features(&self) -> String {
510 let mut features = "panic-unwind".to_string();
512 if self.config.backtrace {
513 features.push_str(" backtrace");
515 if self.config.profiler {
516 features.push_str(" profiler");
518 if self.config.wasm_syscall {
519 features.push_str(" wasm_syscall");
524 /// Get the space-separated set of activated features for the compiler.
525 fn rustc_features(&self) -> String {
526 let mut features = String::new();
527 if self.config.jemalloc {
528 features.push_str("jemalloc");
533 /// Component directory that Cargo will produce output into (e.g.
535 fn cargo_dir(&self) -> &'static str {
536 if self.config.rust_optimize {"release"} else {"debug"}
539 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
540 let out = self.out.join(&*compiler.host).join(format!("stage{}-tools-bin", compiler.stage));
541 t!(fs::create_dir_all(&out));
545 /// Returns the root directory for all output generated in a particular
546 /// stage when running with a particular host compiler.
548 /// The mode indicates what the root directory is for.
549 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
550 let suffix = match mode {
552 Mode::Test => "-test",
553 Mode::Rustc => "-rustc",
554 Mode::Codegen => "-codegen",
555 Mode::ToolBootstrap => "-bootstrap-tools",
556 Mode::ToolStd => "-tools",
557 Mode::ToolTest => "-tools",
558 Mode::ToolRustc => "-tools",
560 self.out.join(&*compiler.host)
561 .join(format!("stage{}{}", compiler.stage, suffix))
564 /// Returns the root output directory for all Cargo output in a given stage,
565 /// running a particular compiler, whether or not we're building the
566 /// standard library, and targeting the specified architecture.
570 target: Interned<String>) -> PathBuf {
571 self.stage_out(compiler, mode).join(&*target).join(self.cargo_dir())
574 /// Root output directory for LLVM compiled for `target`
576 /// Note that if LLVM is configured externally then the directory returned
577 /// will likely be empty.
578 fn llvm_out(&self, target: Interned<String>) -> PathBuf {
579 self.out.join(&*target).join("llvm")
582 fn emscripten_llvm_out(&self, target: Interned<String>) -> PathBuf {
583 self.out.join(&*target).join("llvm-emscripten")
586 fn lld_out(&self, target: Interned<String>) -> PathBuf {
587 self.out.join(&*target).join("lld")
590 /// Output directory for all documentation for a target
591 fn doc_out(&self, target: Interned<String>) -> PathBuf {
592 self.out.join(&*target).join("doc")
595 /// Output directory for all documentation for a target
596 fn compiler_doc_out(&self, target: Interned<String>) -> PathBuf {
597 self.out.join(&*target).join("compiler-doc")
600 /// Output directory for some generated md crate documentation for a target (temporary)
601 fn md_doc_out(&self, target: Interned<String>) -> Interned<PathBuf> {
602 INTERNER.intern_path(self.out.join(&*target).join("md-doc"))
605 /// Output directory for all crate documentation for a target (temporary)
607 /// The artifacts here are then copied into `doc_out` above.
608 fn crate_doc_out(&self, target: Interned<String>) -> PathBuf {
609 self.out.join(&*target).join("crate-docs")
612 /// Returns true if no custom `llvm-config` is set for the specified target.
614 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
615 fn is_rust_llvm(&self, target: Interned<String>) -> bool {
616 match self.config.target_config.get(&target) {
617 Some(ref c) => c.llvm_config.is_none(),
622 /// Returns the path to `FileCheck` binary for the specified target
623 fn llvm_filecheck(&self, target: Interned<String>) -> PathBuf {
624 let target_config = self.config.target_config.get(&target);
625 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
627 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
628 let llvm_bindir = output(Command::new(s).arg("--bindir"));
629 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", &*target));
630 if filecheck.exists() {
633 // On Fedora the system LLVM installs FileCheck in the
634 // llvm subdirectory of the libdir.
635 let llvm_libdir = output(Command::new(s).arg("--libdir"));
636 let lib_filecheck = Path::new(llvm_libdir.trim())
637 .join("llvm").join(exe("FileCheck", &*target));
638 if lib_filecheck.exists() {
641 // Return the most normal file name, even though
642 // it doesn't exist, so that any error message
648 let base = self.llvm_out(self.config.build).join("build");
649 let base = if !self.config.ninja && self.config.build.contains("msvc") {
650 if self.config.llvm_optimize {
651 if self.config.llvm_release_debuginfo {
652 base.join("RelWithDebInfo")
662 base.join("bin").join(exe("FileCheck", &*target))
666 /// Directory for libraries built from C/C++ code and shared between stages.
667 fn native_dir(&self, target: Interned<String>) -> PathBuf {
668 self.out.join(&*target).join("native")
671 /// Root output directory for rust_test_helpers library compiled for
673 fn test_helpers_out(&self, target: Interned<String>) -> PathBuf {
674 self.native_dir(target).join("rust-test-helpers")
677 /// Adds the `RUST_TEST_THREADS` env var if necessary
678 fn add_rust_test_threads(&self, cmd: &mut Command) {
679 if env::var_os("RUST_TEST_THREADS").is_none() {
680 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
684 /// Returns the libdir of the snapshot compiler.
685 fn rustc_snapshot_libdir(&self) -> PathBuf {
686 self.rustc_snapshot_sysroot().join(libdir(&self.config.build))
689 /// Returns the sysroot of the snapshot compiler.
690 fn rustc_snapshot_sysroot(&self) -> &Path {
691 self.initial_rustc.parent().unwrap().parent().unwrap()
694 /// Runs a command, printing out nice contextual information if it fails.
695 fn run(&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 fn run_quiet(&self, cmd: &mut Command) {
703 if self.config.dry_run { return; }
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(&self, cmd: &mut Command) -> bool {
712 if self.config.dry_run { return true; }
713 self.verbose(&format!("running: {:?}", cmd));
717 /// Runs a command, printing out nice contextual information if it fails.
718 /// Exits if the command failed to execute at all, otherwise returns its
719 /// `status.success()`.
720 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
721 if self.config.dry_run { return true; }
722 self.verbose(&format!("running: {:?}", cmd));
723 try_run_suppressed(cmd)
726 pub fn is_verbose(&self) -> bool {
730 /// Prints a message if this build is configured in verbose mode.
731 fn verbose(&self, msg: &str) {
732 if self.is_verbose() {
737 fn info(&self, msg: &str) {
738 if self.config.dry_run { return; }
742 /// Returns the number of parallel jobs that have been configured for this
744 fn jobs(&self) -> u32 {
745 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
748 fn debuginfo_map(&self, which: GitRepo) -> Option<String> {
749 if !self.config.rust_remap_debuginfo {
753 let path = match which {
755 let sha = self.rust_sha().unwrap_or(channel::CFG_RELEASE_NUM);
756 format!("/rustc/{}", sha)
758 GitRepo::Llvm => String::from("/rustc/llvm"),
760 Some(format!("{}={}", self.src.display(), path))
763 /// Returns the path to the C compiler for the target specified.
764 fn cc(&self, target: Interned<String>) -> &Path {
765 self.cc[&target].path()
768 /// Returns a list of flags to pass to the C compiler for the target
770 fn cflags(&self, target: Interned<String>, which: GitRepo) -> Vec<String> {
771 // Filter out -O and /O (the optimization flags) that we picked up from
772 // cc-rs because the build scripts will determine that for themselves.
773 let mut base = self.cc[&target].args().iter()
774 .map(|s| s.to_string_lossy().into_owned())
775 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
776 .collect::<Vec<String>>();
778 // If we're compiling on macOS then we add a few unconditional flags
779 // indicating that we want libc++ (more filled out than libstdc++) and
780 // we want to compile for 10.7. This way we can ensure that
781 // LLVM/etc are all properly compiled.
782 if target.contains("apple-darwin") {
783 base.push("-stdlib=libc++".into());
786 // Work around an apparently bad MinGW / GCC optimization,
787 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
788 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
789 if &*target == "i686-pc-windows-gnu" {
790 base.push("-fno-omit-frame-pointer".into());
793 if let Some(map) = self.debuginfo_map(which) {
794 let cc = self.cc(target);
795 if cc.ends_with("clang") || cc.ends_with("gcc") {
796 base.push(format!("-fdebug-prefix-map={}", map));
797 } else if cc.ends_with("clang-cl.exe") {
798 base.push("-Xclang".into());
799 base.push(format!("-fdebug-prefix-map={}", map));
805 /// Returns the path to the `ar` archive utility for the target specified.
806 fn ar(&self, target: Interned<String>) -> Option<&Path> {
807 self.ar.get(&target).map(|p| &**p)
810 /// Returns the path to the `ranlib` utility for the target specified.
811 fn ranlib(&self, target: Interned<String>) -> Option<&Path> {
812 self.ranlib.get(&target).map(|p| &**p)
815 /// Returns the path to the C++ compiler for the target specified.
816 fn cxx(&self, target: Interned<String>) -> Result<&Path, String> {
817 match self.cxx.get(&target) {
818 Some(p) => Ok(p.path()),
820 "target `{}` is not configured as a host, only as a target",
825 /// Returns the path to the linker for the given target if it needs to be overridden.
826 fn linker(&self, target: Interned<String>) -> Option<&Path> {
827 if let Some(linker) = self.config.target_config.get(&target)
828 .and_then(|c| c.linker.as_ref()) {
830 } else if target != self.config.build &&
831 !target.contains("msvc") &&
832 !target.contains("emscripten") &&
833 !target.contains("wasm32") &&
834 !target.contains("fuchsia") {
835 Some(self.cc(target))
841 /// Returns if this target should statically link the C runtime, if specified
842 fn crt_static(&self, target: Interned<String>) -> Option<bool> {
843 if target.contains("pc-windows-msvc") {
846 self.config.target_config.get(&target)
847 .and_then(|t| t.crt_static)
851 /// Returns the "musl root" for this `target`, if defined
852 fn musl_root(&self, target: Interned<String>) -> Option<&Path> {
853 self.config.target_config.get(&target)
854 .and_then(|t| t.musl_root.as_ref())
855 .or(self.config.musl_root.as_ref())
859 /// Returns true if this is a no-std `target`, if defined
860 fn no_std(&self, target: Interned<String>) -> Option<bool> {
861 self.config.target_config.get(&target)
865 /// Returns whether the target will be tested using the `remote-test-client`
866 /// and `remote-test-server` binaries.
867 fn remote_tested(&self, target: Interned<String>) -> bool {
868 self.qemu_rootfs(target).is_some() || target.contains("android") ||
869 env::var_os("TEST_DEVICE_ADDR").is_some()
872 /// Returns the root of the "rootfs" image that this target will be using,
873 /// if one was configured.
875 /// If `Some` is returned then that means that tests for this target are
876 /// emulated with QEMU and binaries will need to be shipped to the emulator.
877 fn qemu_rootfs(&self, target: Interned<String>) -> Option<&Path> {
878 self.config.target_config.get(&target)
879 .and_then(|t| t.qemu_rootfs.as_ref())
883 /// Path to the python interpreter to use
884 fn python(&self) -> &Path {
885 self.config.python.as_ref().unwrap()
888 /// Temporary directory that extended error information is emitted to.
889 fn extended_error_dir(&self) -> PathBuf {
890 self.out.join("tmp/extended-error-metadata")
893 /// Tests whether the `compiler` compiling for `target` should be forced to
894 /// use a stage1 compiler instead.
896 /// Currently, by default, the build system does not perform a "full
897 /// bootstrap" by default where we compile the compiler three times.
898 /// Instead, we compile the compiler two times. The final stage (stage2)
899 /// just copies the libraries from the previous stage, which is what this
902 /// Here we return `true` if:
904 /// * The build isn't performing a full bootstrap
905 /// * The `compiler` is in the final stage, 2
906 /// * We're not cross-compiling, so the artifacts are already available in
909 /// When all of these conditions are met the build will lift artifacts from
910 /// the previous stage forward.
911 fn force_use_stage1(&self, compiler: Compiler, target: Interned<String>) -> bool {
912 !self.config.full_bootstrap &&
913 compiler.stage >= 2 &&
914 (self.hosts.iter().any(|h| *h == target) || target == self.build)
917 /// Given `num` in the form "a.b.c" return a "release string" which
918 /// describes the release version number.
920 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
921 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
922 fn release(&self, num: &str) -> String {
923 match &self.config.channel[..] {
924 "stable" => num.to_string(),
925 "beta" => if self.rust_info.is_git() {
926 format!("{}-beta.{}", num, self.beta_prerelease_version())
928 format!("{}-beta", num)
930 "nightly" => format!("{}-nightly", num),
931 _ => format!("{}-dev", num),
935 fn beta_prerelease_version(&self) -> u32 {
936 if let Some(s) = self.prerelease_version.get() {
945 .current_dir(&self.src)
947 let beta = beta.trim().split_whitespace().next().unwrap();
953 .current_dir(&self.src)
955 let master = master.trim().split_whitespace().next().unwrap();
957 // Figure out where the current beta branch started.
963 .current_dir(&self.src),
965 let base = base.trim();
967 // Next figure out how many merge commits happened since we branched off
968 // beta. That's our beta number!
974 .arg(format!("{}...HEAD", base))
975 .current_dir(&self.src),
977 let n = count.trim().parse().unwrap();
978 self.prerelease_version.set(Some(n));
982 /// Returns the value of `release` above for Rust itself.
983 fn rust_release(&self) -> String {
984 self.release(channel::CFG_RELEASE_NUM)
987 /// Returns the "package version" for a component given the `num` release
990 /// The package version is typically what shows up in the names of tarballs.
991 /// For channels like beta/nightly it's just the channel name, otherwise
992 /// it's the `num` provided.
993 fn package_vers(&self, num: &str) -> String {
994 match &self.config.channel[..] {
995 "stable" => num.to_string(),
996 "beta" => "beta".to_string(),
997 "nightly" => "nightly".to_string(),
998 _ => format!("{}-dev", num),
1002 /// Returns the value of `package_vers` above for Rust itself.
1003 fn rust_package_vers(&self) -> String {
1004 self.package_vers(channel::CFG_RELEASE_NUM)
1007 /// Returns the value of `package_vers` above for Cargo
1008 fn cargo_package_vers(&self) -> String {
1009 self.package_vers(&self.release_num("cargo"))
1012 /// Returns the value of `package_vers` above for rls
1013 fn rls_package_vers(&self) -> String {
1014 self.package_vers(&self.release_num("rls"))
1017 /// Returns the value of `package_vers` above for clippy
1018 fn clippy_package_vers(&self) -> String {
1019 self.package_vers(&self.release_num("clippy"))
1022 /// Returns the value of `package_vers` above for rustfmt
1023 fn rustfmt_package_vers(&self) -> String {
1024 self.package_vers(&self.release_num("rustfmt"))
1027 fn llvm_tools_package_vers(&self) -> String {
1028 self.package_vers(&self.rust_version())
1031 fn llvm_tools_vers(&self) -> String {
1035 fn lldb_package_vers(&self) -> String {
1036 self.package_vers(&self.rust_version())
1039 fn lldb_vers(&self) -> String {
1043 fn llvm_link_tools_dynamically(&self, target: Interned<String>) -> bool {
1044 (target.contains("linux-gnu") || target.contains("apple-darwin"))
1047 /// Returns the `version` string associated with this compiler for Rust
1050 /// Note that this is a descriptive string which includes the commit date,
1051 /// sha, version, etc.
1052 fn rust_version(&self) -> String {
1053 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1056 /// Return the full commit hash
1057 fn rust_sha(&self) -> Option<&str> {
1058 self.rust_info.sha()
1061 /// Returns the `a.b.c` version that the given package is at.
1062 fn release_num(&self, package: &str) -> String {
1063 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1064 let toml = t!(fs::read_to_string(&toml_file_name));
1065 for line in toml.lines() {
1066 let prefix = "version = \"";
1068 if line.starts_with(prefix) && line.ends_with(suffix) {
1069 return line[prefix.len()..line.len() - suffix.len()].to_string()
1073 panic!("failed to find version in {}'s Cargo.toml", package)
1076 /// Returns whether unstable features should be enabled for the compiler
1078 fn unstable_features(&self) -> bool {
1079 match &self.config.channel[..] {
1080 "stable" | "beta" => false,
1081 "nightly" | _ => true,
1085 /// Fold the output of the commands after this method into a group. The fold
1086 /// ends when the returned object is dropped. Folding can only be used in
1087 /// the Travis CI environment.
1088 pub fn fold_output<D, F>(&self, name: F) -> Option<OutputFolder>
1089 where D: Into<String>, F: FnOnce() -> D
1091 if !self.config.dry_run && self.ci_env == CiEnv::Travis {
1092 Some(OutputFolder::new(name().into()))
1098 /// Updates the actual toolstate of a tool.
1100 /// The toolstates are saved to the file specified by the key
1101 /// `rust.save-toolstates` in `config.toml`. If unspecified, nothing will be
1102 /// done. The file is updated immediately after this function completes.
1103 pub fn save_toolstate(&self, tool: &str, state: ToolState) {
1104 use std::io::{Seek, SeekFrom};
1106 if let Some(ref path) = self.config.save_toolstates {
1107 let mut file = t!(fs::OpenOptions::new()
1113 let mut current_toolstates: HashMap<Box<str>, ToolState> =
1114 serde_json::from_reader(&mut file).unwrap_or_default();
1115 current_toolstates.insert(tool.into(), state);
1116 t!(file.seek(SeekFrom::Start(0)));
1117 t!(file.set_len(0));
1118 t!(serde_json::to_writer(file, ¤t_toolstates));
1122 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1123 let mut ret = Vec::new();
1124 let mut list = vec![INTERNER.intern_str(root)];
1125 let mut visited = HashSet::new();
1126 while let Some(krate) = list.pop() {
1127 let krate = &self.crates[&krate];
1128 if krate.is_local(self) {
1131 for dep in &krate.deps {
1132 if visited.insert(dep) && dep != "build_helper" {
1140 fn read_stamp_file(&self, stamp: &Path) -> Vec<PathBuf> {
1141 if self.config.dry_run {
1145 let mut paths = Vec::new();
1146 let contents = t!(fs::read(stamp));
1147 // This is the method we use for extracting paths from the stamp file passed to us. See
1148 // run_cargo for more information (in compile.rs).
1149 for part in contents.split(|b| *b == 0) {
1150 if part.is_empty() {
1153 let path = PathBuf::from(t!(str::from_utf8(part)));
1159 /// Copies a file from `src` to `dst`
1160 pub fn copy(&self, src: &Path, dst: &Path) {
1161 if self.config.dry_run { return; }
1162 let _ = fs::remove_file(&dst);
1163 let metadata = t!(src.symlink_metadata());
1164 if metadata.file_type().is_symlink() {
1165 let link = t!(fs::read_link(src));
1166 t!(symlink_file(link, dst));
1167 } else if let Ok(()) = fs::hard_link(src, dst) {
1168 // Attempt to "easy copy" by creating a hard link
1169 // (symlinks don't work on windows), but if that fails
1170 // just fall back to a slow `copy` operation.
1172 if let Err(e) = fs::copy(src, dst) {
1173 panic!("failed to copy `{}` to `{}`: {}", src.display(),
1176 t!(fs::set_permissions(dst, metadata.permissions()));
1177 let atime = FileTime::from_last_access_time(&metadata);
1178 let mtime = FileTime::from_last_modification_time(&metadata);
1179 t!(filetime::set_file_times(dst, atime, mtime));
1183 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1184 /// new string for each replacement.)
1185 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1186 if self.config.dry_run { return; }
1187 let mut contents = String::new();
1188 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1189 t!(file.read_to_string(&mut contents));
1190 for &(target, replacement) in replacements {
1191 contents = contents.replace(target, replacement);
1193 t!(file.seek(SeekFrom::Start(0)));
1194 t!(file.set_len(0));
1195 t!(file.write_all(contents.as_bytes()));
1198 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1199 /// when this function is called.
1200 pub fn cp_r(&self, src: &Path, dst: &Path) {
1201 if self.config.dry_run { return; }
1202 for f in t!(fs::read_dir(src)) {
1204 let path = f.path();
1205 let name = path.file_name().unwrap();
1206 let dst = dst.join(name);
1207 if t!(f.file_type()).is_dir() {
1208 t!(fs::create_dir_all(&dst));
1209 self.cp_r(&path, &dst);
1211 let _ = fs::remove_file(&dst);
1212 self.copy(&path, &dst);
1217 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1218 /// when this function is called. Unwanted files or directories can be skipped
1219 /// by returning `false` from the filter function.
1220 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1221 // Immediately recurse with an empty relative path
1222 self.recurse_(src, dst, Path::new(""), filter)
1225 // Inner function does the actual work
1226 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1227 for f in self.read_dir(src) {
1228 let path = f.path();
1229 let name = path.file_name().unwrap();
1230 let dst = dst.join(name);
1231 let relative = relative.join(name);
1232 // Only copy file or directory if the filter function returns true
1233 if filter(&relative) {
1234 if t!(f.file_type()).is_dir() {
1235 let _ = fs::remove_dir_all(&dst);
1236 self.create_dir(&dst);
1237 self.recurse_(&path, &dst, &relative, filter);
1239 let _ = fs::remove_file(&dst);
1240 self.copy(&path, &dst);
1246 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1247 let file_name = src.file_name().unwrap();
1248 let dest = dest_folder.join(file_name);
1249 self.copy(src, &dest);
1252 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1253 if self.config.dry_run { return; }
1254 let dst = dstdir.join(src.file_name().unwrap());
1255 t!(fs::create_dir_all(dstdir));
1256 drop(fs::remove_file(&dst));
1259 panic!("Error: File \"{}\" not found!", src.display());
1261 let mut s = t!(fs::File::open(&src));
1262 let mut d = t!(fs::File::create(&dst));
1263 io::copy(&mut s, &mut d).expect("failed to copy");
1268 fn create(&self, path: &Path, s: &str) {
1269 if self.config.dry_run { return; }
1270 t!(fs::write(path, s));
1273 fn read(&self, path: &Path) -> String {
1274 if self.config.dry_run { return String::new(); }
1275 t!(fs::read_to_string(path))
1278 fn create_dir(&self, dir: &Path) {
1279 if self.config.dry_run { return; }
1280 t!(fs::create_dir_all(dir))
1283 fn remove_dir(&self, dir: &Path) {
1284 if self.config.dry_run { return; }
1285 t!(fs::remove_dir_all(dir))
1288 fn read_dir(&self, dir: &Path) -> impl Iterator<Item=fs::DirEntry> {
1289 let iter = match fs::read_dir(dir) {
1291 Err(_) if self.config.dry_run => return vec![].into_iter(),
1292 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1294 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1297 fn remove(&self, f: &Path) {
1298 if self.config.dry_run { return; }
1299 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1304 fn chmod(path: &Path, perms: u32) {
1305 use std::os::unix::fs::*;
1306 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1309 fn chmod(_path: &Path, _perms: u32) {}
1313 pub fn with_stage(mut self, stage: u32) -> Compiler {
1318 /// Returns whether this is a snapshot compiler for `build`'s configuration
1319 pub fn is_snapshot(&self, build: &Build) -> bool {
1320 self.stage == 0 && self.host == build.build
1323 /// Returns if this compiler should be treated as a final stage one in the
1324 /// current build session.
1325 /// This takes into account whether we're performing a full bootstrap or
1326 /// not; don't directly compare the stage with `2`!
1327 pub fn is_final_stage(&self, build: &Build) -> bool {
1328 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1329 self.stage >= final_stage