1 //! Implementation of rustbuild, the Rust build system.
3 //! This module, and its descendants, are the implementation of the Rust build
4 //! system. Most of this build system is backed by Cargo but the outer layer
5 //! here serves as the ability to orchestrate calling Cargo, sequencing Cargo
6 //! builds, building artifacts like LLVM, etc. The goals of rustbuild are:
8 //! * To be an easily understandable, easily extensible, and maintainable build
10 //! * Leverage standard tools in the Rust ecosystem to build the compiler, aka
11 //! crates.io and Cargo.
12 //! * A standard interface to build across all platforms, including MSVC
16 //! The build system defers most of the complicated logic managing invocations
17 //! of rustc and rustdoc to Cargo itself. However, moving through various stages
18 //! and copying artifacts is still necessary for it to do. Each time rustbuild
19 //! is invoked, it will iterate through the list of predefined steps and execute
20 //! each serially in turn if it matches the paths passed or is a default rule.
21 //! For each step rustbuild relies on the step internally being incremental and
22 //! parallel. Note, though, that the `-j` parameter to rustbuild gets forwarded
23 //! to appropriate test harnesses and such.
25 //! Most of the "meaty" steps that matter are backed by Cargo, which does indeed
26 //! have its own parallelism and incremental management. Later steps, like
27 //! tests, aren't incremental and simply run the entire suite currently.
28 //! However, compiletest itself tries to avoid running tests when the artifacts
29 //! that are involved (mainly the compiler) haven't changed.
31 //! When you execute `x.py build`, the steps executed are:
33 //! * First, the python script is run. This will automatically download the
34 //! stage0 rustc and cargo according to `src/stage0.txt`, or use the cached
35 //! versions if they're available. These are then used to compile rustbuild
36 //! itself (using Cargo). Finally, control is then transferred to rustbuild.
38 //! * Rustbuild takes over, performs sanity checks, probes the environment,
39 //! reads configuration, and starts executing steps as it reads the command
40 //! line arguments (paths) or going through the default rules.
42 //! The build output will be something like the following:
44 //! Building stage0 std artifacts
45 //! Copying stage0 std
46 //! Building stage0 test artifacts
47 //! Copying stage0 test
48 //! Building stage0 compiler artifacts
49 //! Copying stage0 rustc
50 //! Assembling stage1 compiler
51 //! Building stage1 std artifacts
52 //! Copying stage1 std
53 //! Building stage1 test artifacts
54 //! Copying stage1 test
55 //! Building stage1 compiler artifacts
56 //! Copying stage1 rustc
57 //! Assembling stage2 compiler
58 //! Uplifting stage1 std
59 //! Uplifting stage1 test
60 //! Uplifting stage1 rustc
62 //! Let's disect that a little:
64 //! ## Building stage0 {std,test,compiler} artifacts
66 //! These steps use the provided (downloaded, usually) compiler to compile the
67 //! local Rust source into libraries we can use.
69 //! ## Copying stage0 {std,test,rustc}
71 //! This copies the build output from Cargo into
72 //! `build/$HOST/stage0-sysroot/lib/rustlib/$ARCH/lib`. FIXME: this step's
73 //! documentation should be expanded -- the information already here may be
76 //! ## Assembling stage1 compiler
78 //! This copies the libraries we built in "building stage0 ... artifacts" into
79 //! the stage1 compiler's lib directory. These are the host libraries that the
80 //! compiler itself uses to run. These aren't actually used by artifacts the new
81 //! compiler generates. This step also copies the rustc and rustdoc binaries we
82 //! generated into build/$HOST/stage/bin.
84 //! The stage1/bin/rustc is a fully functional compiler, but it doesn't yet have
85 //! any libraries to link built binaries or libraries to. The next 3 steps will
86 //! provide those libraries for it; they are mostly equivalent to constructing
87 //! the stage1/bin compiler so we don't go through them individually.
89 //! ## Uplifting stage1 {std,test,rustc}
91 //! This step copies the libraries from the stage1 compiler sysroot into the
92 //! stage2 compiler. This is done to avoid rebuilding the compiler; libraries
93 //! we'd build in this step should be identical (in function, if not necessarily
94 //! identical on disk) so there's no need to recompile the compiler again. Note
95 //! that if you want to, you can enable the full-bootstrap option to change this
98 //! Each step is driven by a separate Cargo project and rustbuild orchestrates
99 //! copying files between steps and otherwise preparing for Cargo to run.
101 //! ## Further information
103 //! More documentation can be found in each respective module below, and you can
104 //! also check out the `src/bootstrap/README.md` file for more information.
106 #![feature(core_intrinsics)]
107 #![feature(drain_filter)]
109 use std::cell::{RefCell, Cell};
110 use std::collections::{HashSet, HashMap};
112 use std::fs::{self, OpenOptions, File};
113 use std::io::{Seek, SeekFrom, Write, Read};
114 use std::path::{PathBuf, Path};
115 use std::process::{self, Command};
120 use std::os::unix::fs::symlink as symlink_file;
122 use std::os::windows::fs::symlink_file;
125 mtime, output, run, run_suppressed, t, try_run, try_run_suppressed,
127 use filetime::FileTime;
129 use crate::util::{exe, libdir, CiEnv};
154 #[cfg(all(unix, not(target_os = "haiku")))]
156 pub unsafe fn setup(build: &mut crate::Build) {
157 if build.config.low_priority {
158 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
163 #[cfg(any(target_os = "haiku", target_os = "hermit", not(any(unix, windows))))]
165 pub unsafe fn setup(_build: &mut crate::Build) {
169 pub use crate::config::Config;
170 use crate::flags::Subcommand;
171 use crate::cache::{Interned, INTERNER};
172 use crate::toolstate::ToolState;
174 const LLVM_TOOLS: &[&str] = &[
175 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
176 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
177 "llvm-objdump", // used to disassemble programs
178 "llvm-profdata", // used to inspect and merge files generated by profiles
179 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
180 "llvm-size", // used to prints the size of the linker sections of a program
181 "llvm-strip", // used to discard symbols from binary files to reduce their size
182 "llvm-ar" // used for creating and modifying archive files
185 /// A structure representing a Rust compiler.
187 /// Each compiler has a `stage` that it is associated with and a `host` that
188 /// corresponds to the platform the compiler runs on. This structure is used as
189 /// a parameter to many methods below.
190 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
191 pub struct Compiler {
193 host: Interned<String>,
196 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
198 /// Run normal tests and doc tests (default).
200 /// Do not run any doc tests.
202 /// Only run doc tests.
211 /// Global configuration for the build system.
213 /// This structure transitively contains all configuration for the build system.
214 /// All filesystem-encoded configuration is in `config`, all flags are in
215 /// `flags`, and then parsed or probed information is listed in the keys below.
217 /// This structure is a parameter of almost all methods in the build system,
218 /// although most functions are implemented as free functions rather than
219 /// methods specifically on this structure itself (to make it easier to
222 /// User-specified configuration from `config.toml`.
225 // Properties derived from the above configuration
228 rust_info: channel::GitInfo,
229 cargo_info: channel::GitInfo,
230 rls_info: channel::GitInfo,
231 clippy_info: channel::GitInfo,
232 miri_info: channel::GitInfo,
233 rustfmt_info: channel::GitInfo,
234 in_tree_llvm_info: channel::GitInfo,
240 // Targets for which to build
241 build: Interned<String>,
242 hosts: Vec<Interned<String>>,
243 targets: Vec<Interned<String>>,
245 // Stage 0 (downloaded) compiler and cargo or their local rust equivalents
246 initial_rustc: PathBuf,
247 initial_cargo: PathBuf,
249 // Runtime state filled in later on
250 // C/C++ compilers and archiver for all targets
251 cc: HashMap<Interned<String>, cc::Tool>,
252 cxx: HashMap<Interned<String>, cc::Tool>,
253 ar: HashMap<Interned<String>, PathBuf>,
254 ranlib: HashMap<Interned<String>, PathBuf>,
256 crates: HashMap<Interned<String>, Crate>,
259 delayed_failures: RefCell<Vec<String>>,
260 prerelease_version: Cell<Option<u32>>,
261 tool_artifacts: RefCell<HashMap<
263 HashMap<String, (&'static str, PathBuf, Vec<String>)>
269 name: Interned<String>,
270 deps: HashSet<Interned<String>>,
276 fn is_local(&self, build: &Build) -> bool {
277 self.path.starts_with(&build.config.src) &&
278 !self.path.to_string_lossy().ends_with("_shim")
281 fn local_path(&self, build: &Build) -> PathBuf {
282 assert!(self.is_local(build));
283 self.path.strip_prefix(&build.config.src).unwrap().into()
287 /// The various "modes" of invoking Cargo.
289 /// These entries currently correspond to the various output directories of the
290 /// build system, with each mod generating output in a different directory.
291 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
293 /// Build the standard library, placing output in the "stageN-std" directory.
296 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
299 /// Build codegen libraries, placing output in the "stageN-codegen" directory
302 /// Build some tools, placing output in the "stageN-tools" directory. The
303 /// "other" here is for miscellaneous sets of tools that are built using the
304 /// bootstrap compiler in its entirety (target libraries and all).
305 /// Typically these tools compile with stable Rust.
308 /// Compile a tool which uses all libraries we compile (up to rustc).
309 /// Doesn't use the stage0 compiler libraries like "other", and includes
310 /// tools like rustdoc, cargo, rls, etc.
316 pub fn is_tool(&self) -> bool {
318 Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd => true,
325 /// Creates a new set of build configuration from the `flags` on the command
326 /// line and the filesystem `config`.
328 /// By default all build output will be placed in the current directory.
329 pub fn new(config: Config) -> Build {
330 let src = config.src.clone();
331 let out = config.out.clone();
333 let is_sudo = match env::var_os("SUDO_USER") {
335 match env::var_os("USER") {
336 Some(user) => user != sudo_user,
343 let ignore_git = config.ignore_git;
344 let rust_info = channel::GitInfo::new(ignore_git, &src);
345 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
346 let rls_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rls"));
347 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
348 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
349 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
351 // we always try to use git for LLVM builds
352 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
354 let mut build = Build {
355 initial_rustc: config.initial_rustc.clone(),
356 initial_cargo: config.initial_cargo.clone(),
357 local_rebuild: config.local_rebuild,
358 fail_fast: config.cmd.fail_fast(),
359 doc_tests: config.cmd.doc_tests(),
360 verbosity: config.verbose,
363 hosts: config.hosts.clone(),
364 targets: config.targets.clone(),
380 ranlib: HashMap::new(),
381 crates: HashMap::new(),
383 ci_env: CiEnv::current(),
384 delayed_failures: RefCell::new(Vec::new()),
385 prerelease_version: Cell::new(None),
386 tool_artifacts: Default::default(),
389 build.verbose("finding compilers");
390 cc_detect::find(&mut build);
391 build.verbose("running sanity check");
392 sanity::check(&mut build);
394 // If local-rust is the same major.minor as the current version, then force a
396 let local_version_verbose = output(
397 Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
398 let local_release = local_version_verbose
399 .lines().filter(|x| x.starts_with("release:"))
400 .next().unwrap().trim_start_matches("release:").trim();
401 let my_version = channel::CFG_RELEASE_NUM;
402 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
403 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
404 build.local_rebuild = true;
407 build.verbose("learning about cargo");
408 metadata::build(&mut build);
413 pub fn build_triple(&self) -> &[Interned<String>] {
415 slice::from_raw_parts(&self.build, 1)
419 /// Executes the entire build, as configured by the flags and configuration.
420 pub fn build(&mut self) {
425 if let Subcommand::Clean { all } = self.config.cmd {
426 return clean::clean(self, all);
430 let builder = builder::Builder::new(&self);
431 if let Some(path) = builder.paths.get(0) {
432 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
438 if !self.config.dry_run {
440 self.config.dry_run = true;
441 let builder = builder::Builder::new(&self);
442 builder.execute_cli();
444 self.config.dry_run = false;
445 let builder = builder::Builder::new(&self);
446 builder.execute_cli();
448 let builder = builder::Builder::new(&self);
449 let _ = builder.execute_cli();
452 // Check for postponed failures from `test --no-fail-fast`.
453 let failures = self.delayed_failures.borrow();
454 if failures.len() > 0 {
455 println!("\n{} command(s) did not execute successfully:\n", failures.len());
456 for failure in failures.iter() {
457 println!(" - {}\n", failure);
463 /// Clear out `dir` if `input` is newer.
465 /// After this executes, it will also ensure that `dir` exists.
466 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
467 let stamp = dir.join(".stamp");
468 let mut cleared = false;
469 if mtime(&stamp) < mtime(input) {
470 self.verbose(&format!("Dirty - {}", dir.display()));
471 let _ = fs::remove_dir_all(dir);
473 } else if stamp.exists() {
476 t!(fs::create_dir_all(dir));
477 t!(File::create(stamp));
481 /// Gets the space-separated set of activated features for the standard
483 fn std_features(&self) -> String {
484 let mut features = "panic-unwind".to_string();
486 if self.config.llvm_libunwind {
487 features.push_str(" llvm-libunwind");
489 if self.config.backtrace {
490 features.push_str(" backtrace");
492 if self.config.profiler {
493 features.push_str(" profiler");
498 /// Gets the space-separated set of activated features for the compiler.
499 fn rustc_features(&self) -> String {
500 let mut features = String::new();
501 if self.config.jemalloc {
502 features.push_str("jemalloc");
507 /// Component directory that Cargo will produce output into (e.g.
509 fn cargo_dir(&self) -> &'static str {
510 if self.config.rust_optimize {"release"} else {"debug"}
513 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
514 let out = self.out.join(&*compiler.host).join(format!("stage{}-tools-bin", compiler.stage));
515 t!(fs::create_dir_all(&out));
519 /// Returns the root directory for all output generated in a particular
520 /// stage when running with a particular host compiler.
522 /// The mode indicates what the root directory is for.
523 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
524 let suffix = match mode {
526 Mode::Rustc => "-rustc",
527 Mode::Codegen => "-codegen",
528 Mode::ToolBootstrap => "-bootstrap-tools",
529 Mode::ToolStd | Mode::ToolRustc => "-tools",
531 self.out.join(&*compiler.host)
532 .join(format!("stage{}{}", compiler.stage, suffix))
535 /// Returns the root output directory for all Cargo output in a given stage,
536 /// running a particular compiler, whether or not we're building the
537 /// standard library, and targeting the specified architecture.
541 target: Interned<String>) -> PathBuf {
542 self.stage_out(compiler, mode).join(&*target).join(self.cargo_dir())
545 /// Root output directory for LLVM compiled for `target`
547 /// Note that if LLVM is configured externally then the directory returned
548 /// will likely be empty.
549 fn llvm_out(&self, target: Interned<String>) -> PathBuf {
550 self.out.join(&*target).join("llvm")
553 fn lld_out(&self, target: Interned<String>) -> PathBuf {
554 self.out.join(&*target).join("lld")
557 /// Output directory for all documentation for a target
558 fn doc_out(&self, target: Interned<String>) -> PathBuf {
559 self.out.join(&*target).join("doc")
562 /// Output directory for all documentation for a target
563 fn compiler_doc_out(&self, target: Interned<String>) -> PathBuf {
564 self.out.join(&*target).join("compiler-doc")
567 /// Output directory for some generated md crate documentation for a target (temporary)
568 fn md_doc_out(&self, target: Interned<String>) -> Interned<PathBuf> {
569 INTERNER.intern_path(self.out.join(&*target).join("md-doc"))
572 /// Output directory for all crate documentation for a target (temporary)
574 /// The artifacts here are then copied into `doc_out` above.
575 fn crate_doc_out(&self, target: Interned<String>) -> PathBuf {
576 self.out.join(&*target).join("crate-docs")
579 /// Returns `true` if no custom `llvm-config` is set for the specified target.
581 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
582 fn is_rust_llvm(&self, target: Interned<String>) -> bool {
583 match self.config.target_config.get(&target) {
584 Some(ref c) => c.llvm_config.is_none(),
589 /// Returns the path to `FileCheck` binary for the specified target
590 fn llvm_filecheck(&self, target: Interned<String>) -> PathBuf {
591 let target_config = self.config.target_config.get(&target);
592 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
594 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
595 let llvm_bindir = output(Command::new(s).arg("--bindir"));
596 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", &*target));
597 if filecheck.exists() {
600 // On Fedora the system LLVM installs FileCheck in the
601 // llvm subdirectory of the libdir.
602 let llvm_libdir = output(Command::new(s).arg("--libdir"));
603 let lib_filecheck = Path::new(llvm_libdir.trim())
604 .join("llvm").join(exe("FileCheck", &*target));
605 if lib_filecheck.exists() {
608 // Return the most normal file name, even though
609 // it doesn't exist, so that any error message
615 let base = self.llvm_out(self.config.build).join("build");
616 let base = if !self.config.ninja && self.config.build.contains("msvc") {
617 if self.config.llvm_optimize {
618 if self.config.llvm_release_debuginfo {
619 base.join("RelWithDebInfo")
629 base.join("bin").join(exe("FileCheck", &*target))
633 /// Directory for libraries built from C/C++ code and shared between stages.
634 fn native_dir(&self, target: Interned<String>) -> PathBuf {
635 self.out.join(&*target).join("native")
638 /// Root output directory for rust_test_helpers library compiled for
640 fn test_helpers_out(&self, target: Interned<String>) -> PathBuf {
641 self.native_dir(target).join("rust-test-helpers")
644 /// Adds the `RUST_TEST_THREADS` env var if necessary
645 fn add_rust_test_threads(&self, cmd: &mut Command) {
646 if env::var_os("RUST_TEST_THREADS").is_none() {
647 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
651 /// Returns the libdir of the snapshot compiler.
652 fn rustc_snapshot_libdir(&self) -> PathBuf {
653 self.rustc_snapshot_sysroot().join(libdir(&self.config.build))
656 /// Returns the sysroot of the snapshot compiler.
657 fn rustc_snapshot_sysroot(&self) -> &Path {
658 self.initial_rustc.parent().unwrap().parent().unwrap()
661 /// Runs a command, printing out nice contextual information if it fails.
662 fn run(&self, cmd: &mut Command) {
663 if self.config.dry_run { return; }
664 self.verbose(&format!("running: {:?}", cmd));
668 /// Runs a command, printing out nice contextual information if it fails.
669 fn run_quiet(&self, cmd: &mut Command) {
670 if self.config.dry_run { return; }
671 self.verbose(&format!("running: {:?}", cmd));
675 /// Runs a command, printing out nice contextual information if it fails.
676 /// Exits if the command failed to execute at all, otherwise returns its
677 /// `status.success()`.
678 fn try_run(&self, cmd: &mut Command) -> bool {
679 if self.config.dry_run { return true; }
680 self.verbose(&format!("running: {:?}", cmd));
684 /// Runs a command, printing out nice contextual information if it fails.
685 /// Exits if the command failed to execute at all, otherwise returns its
686 /// `status.success()`.
687 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
688 if self.config.dry_run { return true; }
689 self.verbose(&format!("running: {:?}", cmd));
690 try_run_suppressed(cmd)
693 pub fn is_verbose(&self) -> bool {
697 /// Prints a message if this build is configured in verbose mode.
698 fn verbose(&self, msg: &str) {
699 if self.is_verbose() {
704 pub fn is_verbose_than(&self, level: usize) -> bool {
705 self.verbosity > level
708 /// Prints a message if this build is configured in more verbose mode than `level`.
709 fn verbose_than(&self, level: usize, msg: &str) {
710 if self.is_verbose_than(level) {
715 fn info(&self, msg: &str) {
716 if self.config.dry_run { return; }
720 /// Returns the number of parallel jobs that have been configured for this
722 fn jobs(&self) -> u32 {
723 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
726 fn debuginfo_map(&self, which: GitRepo) -> Option<String> {
727 if !self.config.rust_remap_debuginfo {
731 let path = match which {
733 let sha = self.rust_sha().unwrap_or(channel::CFG_RELEASE_NUM);
734 format!("/rustc/{}", sha)
736 GitRepo::Llvm => String::from("/rustc/llvm"),
738 Some(format!("{}={}", self.src.display(), path))
741 /// Returns the path to the C compiler for the target specified.
742 fn cc(&self, target: Interned<String>) -> &Path {
743 self.cc[&target].path()
746 /// Returns a list of flags to pass to the C compiler for the target
748 fn cflags(&self, target: Interned<String>, which: GitRepo) -> Vec<String> {
749 // Filter out -O and /O (the optimization flags) that we picked up from
750 // cc-rs because the build scripts will determine that for themselves.
751 let mut base = self.cc[&target].args().iter()
752 .map(|s| s.to_string_lossy().into_owned())
753 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
754 .collect::<Vec<String>>();
756 // If we're compiling on macOS then we add a few unconditional flags
757 // indicating that we want libc++ (more filled out than libstdc++) and
758 // we want to compile for 10.7. This way we can ensure that
759 // LLVM/etc are all properly compiled.
760 if target.contains("apple-darwin") {
761 base.push("-stdlib=libc++".into());
764 // Work around an apparently bad MinGW / GCC optimization,
765 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
766 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
767 if &*target == "i686-pc-windows-gnu" {
768 base.push("-fno-omit-frame-pointer".into());
771 if let Some(map) = self.debuginfo_map(which) {
772 let cc = self.cc(target);
773 if cc.ends_with("clang") || cc.ends_with("gcc") {
774 base.push(format!("-fdebug-prefix-map={}", map));
775 } else if cc.ends_with("clang-cl.exe") {
776 base.push("-Xclang".into());
777 base.push(format!("-fdebug-prefix-map={}", map));
783 /// Returns the path to the `ar` archive utility for the target specified.
784 fn ar(&self, target: Interned<String>) -> Option<&Path> {
785 self.ar.get(&target).map(|p| &**p)
788 /// Returns the path to the `ranlib` utility for the target specified.
789 fn ranlib(&self, target: Interned<String>) -> Option<&Path> {
790 self.ranlib.get(&target).map(|p| &**p)
793 /// Returns the path to the C++ compiler for the target specified.
794 fn cxx(&self, target: Interned<String>) -> Result<&Path, String> {
795 match self.cxx.get(&target) {
796 Some(p) => Ok(p.path()),
798 "target `{}` is not configured as a host, only as a target",
803 /// Returns the path to the linker for the given target if it needs to be overridden.
804 fn linker(&self, target: Interned<String>) -> Option<&Path> {
805 if let Some(linker) = self.config.target_config.get(&target)
806 .and_then(|c| c.linker.as_ref()) {
808 } else if target != self.config.build &&
809 !target.contains("msvc") &&
810 !target.contains("emscripten") &&
811 !target.contains("wasm32") &&
812 !target.contains("nvptx") &&
813 !target.contains("fortanix") &&
814 !target.contains("fuchsia") {
815 Some(self.cc(target))
821 /// Returns if this target should statically link the C runtime, if specified
822 fn crt_static(&self, target: Interned<String>) -> Option<bool> {
823 if target.contains("pc-windows-msvc") {
826 self.config.target_config.get(&target)
827 .and_then(|t| t.crt_static)
831 /// Returns the "musl root" for this `target`, if defined
832 fn musl_root(&self, target: Interned<String>) -> Option<&Path> {
833 self.config.target_config.get(&target)
834 .and_then(|t| t.musl_root.as_ref())
835 .or(self.config.musl_root.as_ref())
839 /// Returns the sysroot for the wasi target, if defined
840 fn wasi_root(&self, target: Interned<String>) -> Option<&Path> {
841 self.config.target_config.get(&target)
842 .and_then(|t| t.wasi_root.as_ref())
846 /// Returns `true` if this is a no-std `target`, if defined
847 fn no_std(&self, target: Interned<String>) -> Option<bool> {
848 self.config.target_config.get(&target)
852 /// Returns `true` if the target will be tested using the `remote-test-client`
853 /// and `remote-test-server` binaries.
854 fn remote_tested(&self, target: Interned<String>) -> bool {
855 self.qemu_rootfs(target).is_some() || target.contains("android") ||
856 env::var_os("TEST_DEVICE_ADDR").is_some()
859 /// Returns the root of the "rootfs" image that this target will be using,
860 /// if one was configured.
862 /// If `Some` is returned then that means that tests for this target are
863 /// emulated with QEMU and binaries will need to be shipped to the emulator.
864 fn qemu_rootfs(&self, target: Interned<String>) -> Option<&Path> {
865 self.config.target_config.get(&target)
866 .and_then(|t| t.qemu_rootfs.as_ref())
870 /// Path to the python interpreter to use
871 fn python(&self) -> &Path {
872 self.config.python.as_ref().unwrap()
875 /// Temporary directory that extended error information is emitted to.
876 fn extended_error_dir(&self) -> PathBuf {
877 self.out.join("tmp/extended-error-metadata")
880 /// Tests whether the `compiler` compiling for `target` should be forced to
881 /// use a stage1 compiler instead.
883 /// Currently, by default, the build system does not perform a "full
884 /// bootstrap" by default where we compile the compiler three times.
885 /// Instead, we compile the compiler two times. The final stage (stage2)
886 /// just copies the libraries from the previous stage, which is what this
889 /// Here we return `true` if:
891 /// * The build isn't performing a full bootstrap
892 /// * The `compiler` is in the final stage, 2
893 /// * We're not cross-compiling, so the artifacts are already available in
896 /// When all of these conditions are met the build will lift artifacts from
897 /// the previous stage forward.
898 fn force_use_stage1(&self, compiler: Compiler, target: Interned<String>) -> bool {
899 !self.config.full_bootstrap &&
900 compiler.stage >= 2 &&
901 (self.hosts.iter().any(|h| *h == target) || target == self.build)
904 /// Given `num` in the form "a.b.c" return a "release string" which
905 /// describes the release version number.
907 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
908 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
909 fn release(&self, num: &str) -> String {
910 match &self.config.channel[..] {
911 "stable" => num.to_string(),
912 "beta" => if self.rust_info.is_git() {
913 format!("{}-beta.{}", num, self.beta_prerelease_version())
915 format!("{}-beta", num)
917 "nightly" => format!("{}-nightly", num),
918 _ => format!("{}-dev", num),
922 fn beta_prerelease_version(&self) -> u32 {
923 if let Some(s) = self.prerelease_version.get() {
932 .current_dir(&self.src)
934 let beta = beta.trim().split_whitespace().next().unwrap();
940 .current_dir(&self.src)
942 let master = master.trim().split_whitespace().next().unwrap();
944 // Figure out where the current beta branch started.
950 .current_dir(&self.src),
952 let base = base.trim();
954 // Next figure out how many merge commits happened since we branched off
955 // beta. That's our beta number!
961 .arg(format!("{}...HEAD", base))
962 .current_dir(&self.src),
964 let n = count.trim().parse().unwrap();
965 self.prerelease_version.set(Some(n));
969 /// Returns the value of `release` above for Rust itself.
970 fn rust_release(&self) -> String {
971 self.release(channel::CFG_RELEASE_NUM)
974 /// Returns the "package version" for a component given the `num` release
977 /// The package version is typically what shows up in the names of tarballs.
978 /// For channels like beta/nightly it's just the channel name, otherwise
979 /// it's the `num` provided.
980 fn package_vers(&self, num: &str) -> String {
981 match &self.config.channel[..] {
982 "stable" => num.to_string(),
983 "beta" => "beta".to_string(),
984 "nightly" => "nightly".to_string(),
985 _ => format!("{}-dev", num),
989 /// Returns the value of `package_vers` above for Rust itself.
990 fn rust_package_vers(&self) -> String {
991 self.package_vers(channel::CFG_RELEASE_NUM)
994 /// Returns the value of `package_vers` above for Cargo
995 fn cargo_package_vers(&self) -> String {
996 self.package_vers(&self.release_num("cargo"))
999 /// Returns the value of `package_vers` above for rls
1000 fn rls_package_vers(&self) -> String {
1001 self.package_vers(&self.release_num("rls"))
1004 /// Returns the value of `package_vers` above for clippy
1005 fn clippy_package_vers(&self) -> String {
1006 self.package_vers(&self.release_num("clippy"))
1009 /// Returns the value of `package_vers` above for miri
1010 fn miri_package_vers(&self) -> String {
1011 self.package_vers(&self.release_num("miri"))
1014 /// Returns the value of `package_vers` above for rustfmt
1015 fn rustfmt_package_vers(&self) -> String {
1016 self.package_vers(&self.release_num("rustfmt"))
1019 fn llvm_tools_package_vers(&self) -> String {
1020 self.package_vers(channel::CFG_RELEASE_NUM)
1023 fn llvm_tools_vers(&self) -> String {
1027 fn lldb_package_vers(&self) -> String {
1028 self.package_vers(channel::CFG_RELEASE_NUM)
1031 fn lldb_vers(&self) -> String {
1035 fn llvm_link_tools_dynamically(&self, target: Interned<String>) -> bool {
1036 (target.contains("linux-gnu") || target.contains("apple-darwin"))
1039 /// Returns the `version` string associated with this compiler for Rust
1042 /// Note that this is a descriptive string which includes the commit date,
1043 /// sha, version, etc.
1044 fn rust_version(&self) -> String {
1045 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1048 /// Returns the full commit hash.
1049 fn rust_sha(&self) -> Option<&str> {
1050 self.rust_info.sha()
1053 /// Returns the `a.b.c` version that the given package is at.
1054 fn release_num(&self, package: &str) -> String {
1055 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1056 let toml = t!(fs::read_to_string(&toml_file_name));
1057 for line in toml.lines() {
1058 let prefix = "version = \"";
1060 if line.starts_with(prefix) && line.ends_with(suffix) {
1061 return line[prefix.len()..line.len() - suffix.len()].to_string()
1065 panic!("failed to find version in {}'s Cargo.toml", package)
1068 /// Returns `true` if unstable features should be enabled for the compiler
1070 fn unstable_features(&self) -> bool {
1071 match &self.config.channel[..] {
1072 "stable" | "beta" => false,
1073 "nightly" | _ => true,
1077 /// Updates the actual toolstate of a tool.
1079 /// The toolstates are saved to the file specified by the key
1080 /// `rust.save-toolstates` in `config.toml`. If unspecified, nothing will be
1081 /// done. The file is updated immediately after this function completes.
1082 pub fn save_toolstate(&self, tool: &str, state: ToolState) {
1083 if let Some(ref path) = self.config.save_toolstates {
1084 if let Some(parent) = path.parent() {
1085 // Ensure the parent directory always exists
1086 t!(std::fs::create_dir_all(parent));
1088 let mut file = t!(fs::OpenOptions::new()
1094 let mut current_toolstates: HashMap<Box<str>, ToolState> =
1095 serde_json::from_reader(&mut file).unwrap_or_default();
1096 current_toolstates.insert(tool.into(), state);
1097 t!(file.seek(SeekFrom::Start(0)));
1098 t!(file.set_len(0));
1099 t!(serde_json::to_writer(file, ¤t_toolstates));
1103 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1104 let mut ret = Vec::new();
1105 let mut list = vec![INTERNER.intern_str(root)];
1106 let mut visited = HashSet::new();
1107 while let Some(krate) = list.pop() {
1108 let krate = &self.crates[&krate];
1109 if krate.is_local(self) {
1112 for dep in &krate.deps {
1113 if visited.insert(dep) && dep != "build_helper" {
1121 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, bool)> {
1122 if self.config.dry_run {
1126 let mut paths = Vec::new();
1127 let contents = t!(fs::read(stamp), &stamp);
1128 // This is the method we use for extracting paths from the stamp file passed to us. See
1129 // run_cargo for more information (in compile.rs).
1130 for part in contents.split(|b| *b == 0) {
1131 if part.is_empty() {
1134 let host = part[0] as char == 'h';
1135 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1136 paths.push((path, host));
1141 /// Copies a file from `src` to `dst`
1142 pub fn copy(&self, src: &Path, dst: &Path) {
1143 if self.config.dry_run { return; }
1144 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1145 if src == dst { return; }
1146 let _ = fs::remove_file(&dst);
1147 let metadata = t!(src.symlink_metadata());
1148 if metadata.file_type().is_symlink() {
1149 let link = t!(fs::read_link(src));
1150 t!(symlink_file(link, dst));
1151 } else if let Ok(()) = fs::hard_link(src, dst) {
1152 // Attempt to "easy copy" by creating a hard link
1153 // (symlinks don't work on windows), but if that fails
1154 // just fall back to a slow `copy` operation.
1156 if let Err(e) = fs::copy(src, dst) {
1157 panic!("failed to copy `{}` to `{}`: {}", src.display(),
1160 t!(fs::set_permissions(dst, metadata.permissions()));
1161 let atime = FileTime::from_last_access_time(&metadata);
1162 let mtime = FileTime::from_last_modification_time(&metadata);
1163 t!(filetime::set_file_times(dst, atime, mtime));
1167 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1168 /// new string for each replacement.)
1169 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1170 if self.config.dry_run { return; }
1171 let mut contents = String::new();
1172 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1173 t!(file.read_to_string(&mut contents));
1174 for &(target, replacement) in replacements {
1175 contents = contents.replace(target, replacement);
1177 t!(file.seek(SeekFrom::Start(0)));
1178 t!(file.set_len(0));
1179 t!(file.write_all(contents.as_bytes()));
1182 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1183 /// when this function is called.
1184 pub fn cp_r(&self, src: &Path, dst: &Path) {
1185 if self.config.dry_run { return; }
1186 for f in self.read_dir(src) {
1187 let path = f.path();
1188 let name = path.file_name().unwrap();
1189 let dst = dst.join(name);
1190 if t!(f.file_type()).is_dir() {
1191 t!(fs::create_dir_all(&dst));
1192 self.cp_r(&path, &dst);
1194 let _ = fs::remove_file(&dst);
1195 self.copy(&path, &dst);
1200 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1201 /// when this function is called. Unwanted files or directories can be skipped
1202 /// by returning `false` from the filter function.
1203 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1204 // Immediately recurse with an empty relative path
1205 self.recurse_(src, dst, Path::new(""), filter)
1208 // Inner function does the actual work
1209 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1210 for f in self.read_dir(src) {
1211 let path = f.path();
1212 let name = path.file_name().unwrap();
1213 let dst = dst.join(name);
1214 let relative = relative.join(name);
1215 // Only copy file or directory if the filter function returns true
1216 if filter(&relative) {
1217 if t!(f.file_type()).is_dir() {
1218 let _ = fs::remove_dir_all(&dst);
1219 self.create_dir(&dst);
1220 self.recurse_(&path, &dst, &relative, filter);
1222 let _ = fs::remove_file(&dst);
1223 self.copy(&path, &dst);
1229 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1230 let file_name = src.file_name().unwrap();
1231 let dest = dest_folder.join(file_name);
1232 self.copy(src, &dest);
1235 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1236 if self.config.dry_run { return; }
1237 let dst = dstdir.join(src.file_name().unwrap());
1238 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1239 t!(fs::create_dir_all(dstdir));
1240 drop(fs::remove_file(&dst));
1243 panic!("Error: File \"{}\" not found!", src.display());
1245 let metadata = t!(src.symlink_metadata());
1246 if let Err(e) = fs::copy(&src, &dst) {
1247 panic!("failed to copy `{}` to `{}`: {}", src.display(),
1250 t!(fs::set_permissions(&dst, metadata.permissions()));
1251 let atime = FileTime::from_last_access_time(&metadata);
1252 let mtime = FileTime::from_last_modification_time(&metadata);
1253 t!(filetime::set_file_times(&dst, atime, mtime));
1258 fn create(&self, path: &Path, s: &str) {
1259 if self.config.dry_run { return; }
1260 t!(fs::write(path, s));
1263 fn read(&self, path: &Path) -> String {
1264 if self.config.dry_run { return String::new(); }
1265 t!(fs::read_to_string(path))
1268 fn create_dir(&self, dir: &Path) {
1269 if self.config.dry_run { return; }
1270 t!(fs::create_dir_all(dir))
1273 fn remove_dir(&self, dir: &Path) {
1274 if self.config.dry_run { return; }
1275 t!(fs::remove_dir_all(dir))
1278 fn read_dir(&self, dir: &Path) -> impl Iterator<Item=fs::DirEntry> {
1279 let iter = match fs::read_dir(dir) {
1281 Err(_) if self.config.dry_run => return vec![].into_iter(),
1282 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1284 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1287 fn remove(&self, f: &Path) {
1288 if self.config.dry_run { return; }
1289 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1294 fn chmod(path: &Path, perms: u32) {
1295 use std::os::unix::fs::*;
1296 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1299 fn chmod(_path: &Path, _perms: u32) {}
1303 pub fn with_stage(mut self, stage: u32) -> Compiler {
1308 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1309 pub fn is_snapshot(&self, build: &Build) -> bool {
1310 self.stage == 0 && self.host == build.build
1313 /// Returns if this compiler should be treated as a final stage one in the
1314 /// current build session.
1315 /// This takes into account whether we're performing a full bootstrap or
1316 /// not; don't directly compare the stage with `2`!
1317 pub fn is_final_stage(&self, build: &Build) -> bool {
1318 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1319 self.stage >= final_stage
1323 fn envify(s: &str) -> String {
1329 .flat_map(|c| c.to_uppercase())