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::{Cell, RefCell};
110 use std::collections::{HashMap, HashSet};
112 use std::fs::{self, File, OpenOptions};
113 use std::io::{Read, Seek, SeekFrom, Write};
114 use std::path::{Path, PathBuf};
115 use std::process::{self, Command};
120 use std::os::unix::fs::symlink as symlink_file;
122 use std::os::windows::fs::symlink_file;
124 use build_helper::{mtime, output, run, run_suppressed, t, try_run, try_run_suppressed};
125 use filetime::FileTime;
127 use crate::util::{exe, libdir, CiEnv};
153 #[cfg(all(unix, not(target_os = "haiku")))]
155 pub unsafe fn setup(build: &mut crate::Build) {
156 if build.config.low_priority {
157 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
162 #[cfg(any(target_os = "haiku", target_os = "hermit", not(any(unix, windows))))]
164 pub unsafe fn setup(_build: &mut crate::Build) {}
167 use crate::cache::{Interned, INTERNER};
168 pub use crate::config::Config;
169 use crate::flags::Subcommand;
171 const LLVM_TOOLS: &[&str] = &[
172 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
173 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
174 "llvm-objdump", // used to disassemble programs
175 "llvm-profdata", // used to inspect and merge files generated by profiles
176 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
177 "llvm-size", // used to prints the size of the linker sections of a program
178 "llvm-strip", // used to discard symbols from binary files to reduce their size
179 "llvm-ar", // used for creating and modifying archive files
182 /// A structure representing a Rust compiler.
184 /// Each compiler has a `stage` that it is associated with and a `host` that
185 /// corresponds to the platform the compiler runs on. This structure is used as
186 /// a parameter to many methods below.
187 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
188 pub struct Compiler {
190 host: Interned<String>,
193 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
195 /// Run normal tests and doc tests (default).
197 /// Do not run any doc tests.
199 /// Only run doc tests.
208 /// Global configuration for the build system.
210 /// This structure transitively contains all configuration for the build system.
211 /// All filesystem-encoded configuration is in `config`, all flags are in
212 /// `flags`, and then parsed or probed information is listed in the keys below.
214 /// This structure is a parameter of almost all methods in the build system,
215 /// although most functions are implemented as free functions rather than
216 /// methods specifically on this structure itself (to make it easier to
219 /// User-specified configuration from `config.toml`.
222 // Properties derived from the above configuration
225 rust_info: channel::GitInfo,
226 cargo_info: channel::GitInfo,
227 rls_info: channel::GitInfo,
228 clippy_info: channel::GitInfo,
229 miri_info: channel::GitInfo,
230 rustfmt_info: channel::GitInfo,
231 in_tree_llvm_info: channel::GitInfo,
237 // Targets for which to build
238 build: Interned<String>,
239 hosts: Vec<Interned<String>>,
240 targets: Vec<Interned<String>>,
242 // Stage 0 (downloaded) compiler and cargo or their local rust equivalents
243 initial_rustc: PathBuf,
244 initial_cargo: PathBuf,
246 // Runtime state filled in later on
247 // C/C++ compilers and archiver for all targets
248 cc: HashMap<Interned<String>, cc::Tool>,
249 cxx: HashMap<Interned<String>, cc::Tool>,
250 ar: HashMap<Interned<String>, PathBuf>,
251 ranlib: HashMap<Interned<String>, PathBuf>,
253 crates: HashMap<Interned<String>, Crate>,
256 delayed_failures: RefCell<Vec<String>>,
257 prerelease_version: Cell<Option<u32>>,
259 RefCell<HashMap<Interned<String>, HashMap<String, (&'static str, PathBuf, Vec<String>)>>>,
264 name: Interned<String>,
265 deps: HashSet<Interned<String>>,
271 fn is_local(&self, build: &Build) -> bool {
272 self.path.starts_with(&build.config.src) && !self.path.to_string_lossy().ends_with("_shim")
275 fn local_path(&self, build: &Build) -> PathBuf {
276 assert!(self.is_local(build));
277 self.path.strip_prefix(&build.config.src).unwrap().into()
281 /// The various "modes" of invoking Cargo.
283 /// These entries currently correspond to the various output directories of the
284 /// build system, with each mod generating output in a different directory.
285 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
287 /// Build the standard library, placing output in the "stageN-std" directory.
290 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
293 /// Build codegen libraries, placing output in the "stageN-codegen" directory
296 /// Build some tools, placing output in the "stageN-tools" directory. The
297 /// "other" here is for miscellaneous sets of tools that are built using the
298 /// bootstrap compiler in its entirety (target libraries and all).
299 /// Typically these tools compile with stable Rust.
302 /// Compile a tool which uses all libraries we compile (up to rustc).
303 /// Doesn't use the stage0 compiler libraries like "other", and includes
304 /// tools like rustdoc, cargo, rls, etc.
310 pub fn is_tool(&self) -> bool {
312 Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd => true,
319 /// Creates a new set of build configuration from the `flags` on the command
320 /// line and the filesystem `config`.
322 /// By default all build output will be placed in the current directory.
323 pub fn new(config: Config) -> Build {
324 let src = config.src.clone();
325 let out = config.out.clone();
327 let is_sudo = match env::var_os("SUDO_USER") {
328 Some(sudo_user) => match env::var_os("USER") {
329 Some(user) => user != sudo_user,
335 let ignore_git = config.ignore_git;
336 let rust_info = channel::GitInfo::new(ignore_git, &src);
337 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
338 let rls_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rls"));
339 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
340 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
341 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
343 // we always try to use git for LLVM builds
344 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
346 let mut build = Build {
347 initial_rustc: config.initial_rustc.clone(),
348 initial_cargo: config.initial_cargo.clone(),
349 local_rebuild: config.local_rebuild,
350 fail_fast: config.cmd.fail_fast(),
351 doc_tests: config.cmd.doc_tests(),
352 verbosity: config.verbose,
355 hosts: config.hosts.clone(),
356 targets: config.targets.clone(),
372 ranlib: HashMap::new(),
373 crates: HashMap::new(),
375 ci_env: CiEnv::current(),
376 delayed_failures: RefCell::new(Vec::new()),
377 prerelease_version: Cell::new(None),
378 tool_artifacts: Default::default(),
381 build.verbose("finding compilers");
382 cc_detect::find(&mut build);
383 build.verbose("running sanity check");
384 sanity::check(&mut build);
386 // If local-rust is the same major.minor as the current version, then force a
388 let local_version_verbose =
389 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
390 let local_release = local_version_verbose
392 .filter(|x| x.starts_with("release:"))
395 .trim_start_matches("release:")
397 let my_version = channel::CFG_RELEASE_NUM;
398 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
399 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
400 build.local_rebuild = true;
403 build.verbose("learning about cargo");
404 metadata::build(&mut build);
409 pub fn build_triple(&self) -> &[Interned<String>] {
410 unsafe { slice::from_raw_parts(&self.build, 1) }
413 /// Executes the entire build, as configured by the flags and configuration.
414 pub fn build(&mut self) {
419 if let Subcommand::Format { check } = self.config.cmd {
420 return format::format(self, check);
423 if let Subcommand::Clean { all } = self.config.cmd {
424 return clean::clean(self, all);
428 let builder = builder::Builder::new(&self);
429 if let Some(path) = builder.paths.get(0) {
430 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
436 if !self.config.dry_run {
438 self.config.dry_run = true;
439 let builder = builder::Builder::new(&self);
440 builder.execute_cli();
442 self.config.dry_run = false;
443 let builder = builder::Builder::new(&self);
444 builder.execute_cli();
446 let builder = builder::Builder::new(&self);
447 let _ = builder.execute_cli();
450 // Check for postponed failures from `test --no-fail-fast`.
451 let failures = self.delayed_failures.borrow();
452 if failures.len() > 0 {
453 println!("\n{} command(s) did not execute successfully:\n", failures.len());
454 for failure in failures.iter() {
455 println!(" - {}\n", failure);
461 /// Clear out `dir` if `input` is newer.
463 /// After this executes, it will also ensure that `dir` exists.
464 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
465 let stamp = dir.join(".stamp");
466 let mut cleared = false;
467 if mtime(&stamp) < mtime(input) {
468 self.verbose(&format!("Dirty - {}", dir.display()));
469 let _ = fs::remove_dir_all(dir);
471 } else if stamp.exists() {
474 t!(fs::create_dir_all(dir));
475 t!(File::create(stamp));
479 /// Gets the space-separated set of activated features for the standard
481 fn std_features(&self) -> String {
482 let mut features = "panic-unwind".to_string();
484 if self.config.llvm_libunwind {
485 features.push_str(" llvm-libunwind");
487 if self.config.backtrace {
488 features.push_str(" backtrace");
490 if self.config.profiler {
491 features.push_str(" profiler");
496 /// Gets the space-separated set of activated features for the compiler.
497 fn rustc_features(&self) -> String {
498 let mut features = String::new();
499 if self.config.jemalloc {
500 features.push_str("jemalloc");
502 if self.config.llvm_enabled() {
503 features.push_str(" llvm");
508 /// Component directory that Cargo will produce output into (e.g.
510 fn cargo_dir(&self) -> &'static str {
511 if self.config.rust_optimize { "release" } else { "debug" }
514 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
515 let out = self.out.join(&*compiler.host).join(format!("stage{}-tools-bin", compiler.stage));
516 t!(fs::create_dir_all(&out));
520 /// Returns the root directory for all output generated in a particular
521 /// stage when running with a particular host compiler.
523 /// The mode indicates what the root directory is for.
524 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
525 let suffix = match mode {
527 Mode::Rustc => "-rustc",
528 Mode::Codegen => "-codegen",
529 Mode::ToolBootstrap => "-bootstrap-tools",
530 Mode::ToolStd | Mode::ToolRustc => "-tools",
532 self.out.join(&*compiler.host).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.
538 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: Interned<String>) -> PathBuf {
539 self.stage_out(compiler, mode).join(&*target).join(self.cargo_dir())
542 /// Root output directory for LLVM compiled for `target`
544 /// Note that if LLVM is configured externally then the directory returned
545 /// will likely be empty.
546 fn llvm_out(&self, target: Interned<String>) -> PathBuf {
547 self.out.join(&*target).join("llvm")
550 fn lld_out(&self, target: Interned<String>) -> PathBuf {
551 self.out.join(&*target).join("lld")
554 /// Output directory for all documentation for a target
555 fn doc_out(&self, target: Interned<String>) -> PathBuf {
556 self.out.join(&*target).join("doc")
559 /// Output directory for all documentation for a target
560 fn compiler_doc_out(&self, target: Interned<String>) -> PathBuf {
561 self.out.join(&*target).join("compiler-doc")
564 /// Output directory for some generated md crate documentation for a target (temporary)
565 fn md_doc_out(&self, target: Interned<String>) -> Interned<PathBuf> {
566 INTERNER.intern_path(self.out.join(&*target).join("md-doc"))
569 /// Output directory for all crate documentation for a target (temporary)
571 /// The artifacts here are then copied into `doc_out` above.
572 fn crate_doc_out(&self, target: Interned<String>) -> PathBuf {
573 self.out.join(&*target).join("crate-docs")
576 /// Returns `true` if no custom `llvm-config` is set for the specified target.
578 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
579 fn is_rust_llvm(&self, target: Interned<String>) -> bool {
580 match self.config.target_config.get(&target) {
581 Some(ref c) => c.llvm_config.is_none(),
586 /// Returns the path to `FileCheck` binary for the specified target
587 fn llvm_filecheck(&self, target: Interned<String>) -> PathBuf {
588 let target_config = self.config.target_config.get(&target);
589 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
591 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
592 let llvm_bindir = output(Command::new(s).arg("--bindir"));
593 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", &*target));
594 if filecheck.exists() {
597 // On Fedora the system LLVM installs FileCheck in the
598 // llvm subdirectory of the libdir.
599 let llvm_libdir = output(Command::new(s).arg("--libdir"));
601 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", &*target));
602 if lib_filecheck.exists() {
605 // Return the most normal file name, even though
606 // it doesn't exist, so that any error message
612 let base = self.llvm_out(self.config.build).join("build");
613 let base = if !self.config.ninja && self.config.build.contains("msvc") {
614 if self.config.llvm_optimize {
615 if self.config.llvm_release_debuginfo {
616 base.join("RelWithDebInfo")
626 base.join("bin").join(exe("FileCheck", &*target))
630 /// Directory for libraries built from C/C++ code and shared between stages.
631 fn native_dir(&self, target: Interned<String>) -> PathBuf {
632 self.out.join(&*target).join("native")
635 /// Root output directory for rust_test_helpers library compiled for
637 fn test_helpers_out(&self, target: Interned<String>) -> PathBuf {
638 self.native_dir(target).join("rust-test-helpers")
641 /// Adds the `RUST_TEST_THREADS` env var if necessary
642 fn add_rust_test_threads(&self, cmd: &mut Command) {
643 if env::var_os("RUST_TEST_THREADS").is_none() {
644 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
648 /// Returns the libdir of the snapshot compiler.
649 fn rustc_snapshot_libdir(&self) -> PathBuf {
650 self.rustc_snapshot_sysroot().join(libdir(&self.config.build))
653 /// Returns the sysroot of the snapshot compiler.
654 fn rustc_snapshot_sysroot(&self) -> &Path {
655 self.initial_rustc.parent().unwrap().parent().unwrap()
658 /// Runs a command, printing out nice contextual information if it fails.
659 fn run(&self, cmd: &mut Command) {
660 if self.config.dry_run {
663 self.verbose(&format!("running: {:?}", cmd));
667 /// Runs a command, printing out nice contextual information if it fails.
668 fn run_quiet(&self, cmd: &mut Command) {
669 if self.config.dry_run {
672 self.verbose(&format!("running: {:?}", cmd));
676 /// Runs a command, printing out nice contextual information if it fails.
677 /// Exits if the command failed to execute at all, otherwise returns its
678 /// `status.success()`.
679 fn try_run(&self, cmd: &mut Command) -> bool {
680 if self.config.dry_run {
683 self.verbose(&format!("running: {:?}", cmd));
687 /// Runs a command, printing out nice contextual information if it fails.
688 /// Exits if the command failed to execute at all, otherwise returns its
689 /// `status.success()`.
690 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
691 if self.config.dry_run {
694 self.verbose(&format!("running: {:?}", cmd));
695 try_run_suppressed(cmd)
698 pub fn is_verbose(&self) -> bool {
702 /// Prints a message if this build is configured in verbose mode.
703 fn verbose(&self, msg: &str) {
704 if self.is_verbose() {
709 pub fn is_verbose_than(&self, level: usize) -> bool {
710 self.verbosity > level
713 /// Prints a message if this build is configured in more verbose mode than `level`.
714 fn verbose_than(&self, level: usize, msg: &str) {
715 if self.is_verbose_than(level) {
720 fn info(&self, msg: &str) {
721 if self.config.dry_run {
727 /// Returns the number of parallel jobs that have been configured for this
729 fn jobs(&self) -> u32 {
730 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
733 fn debuginfo_map(&self, which: GitRepo) -> Option<String> {
734 if !self.config.rust_remap_debuginfo {
738 let path = match which {
740 let sha = self.rust_sha().unwrap_or(channel::CFG_RELEASE_NUM);
741 format!("/rustc/{}", sha)
743 GitRepo::Llvm => String::from("/rustc/llvm"),
745 Some(format!("{}={}", self.src.display(), path))
748 /// Returns the path to the C compiler for the target specified.
749 fn cc(&self, target: Interned<String>) -> &Path {
750 self.cc[&target].path()
753 /// Returns a list of flags to pass to the C compiler for the target
755 fn cflags(&self, target: Interned<String>, which: GitRepo) -> Vec<String> {
756 // Filter out -O and /O (the optimization flags) that we picked up from
757 // cc-rs because the build scripts will determine that for themselves.
758 let mut base = self.cc[&target]
761 .map(|s| s.to_string_lossy().into_owned())
762 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
763 .collect::<Vec<String>>();
765 // If we're compiling on macOS then we add a few unconditional flags
766 // indicating that we want libc++ (more filled out than libstdc++) and
767 // we want to compile for 10.7. This way we can ensure that
768 // LLVM/etc are all properly compiled.
769 if target.contains("apple-darwin") {
770 base.push("-stdlib=libc++".into());
773 // Work around an apparently bad MinGW / GCC optimization,
774 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
775 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
776 if &*target == "i686-pc-windows-gnu" {
777 base.push("-fno-omit-frame-pointer".into());
780 if let Some(map) = self.debuginfo_map(which) {
781 let cc = self.cc(target);
782 if cc.ends_with("clang") || cc.ends_with("gcc") {
783 base.push(format!("-fdebug-prefix-map={}", map));
784 } else if cc.ends_with("clang-cl.exe") {
785 base.push("-Xclang".into());
786 base.push(format!("-fdebug-prefix-map={}", map));
792 /// Returns the path to the `ar` archive utility for the target specified.
793 fn ar(&self, target: Interned<String>) -> Option<&Path> {
794 self.ar.get(&target).map(|p| &**p)
797 /// Returns the path to the `ranlib` utility for the target specified.
798 fn ranlib(&self, target: Interned<String>) -> Option<&Path> {
799 self.ranlib.get(&target).map(|p| &**p)
802 /// Returns the path to the C++ compiler for the target specified.
803 fn cxx(&self, target: Interned<String>) -> Result<&Path, String> {
804 match self.cxx.get(&target) {
805 Some(p) => Ok(p.path()),
807 Err(format!("target `{}` is not configured as a host, only as a target", target))
812 /// Returns the path to the linker for the given target if it needs to be overridden.
813 fn linker(&self, target: Interned<String>) -> Option<&Path> {
814 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
817 } else if target != self.config.build
818 && util::use_host_linker(&target)
819 && !target.contains("msvc")
821 Some(self.cc(target))
827 /// Returns if this target should statically link the C runtime, if specified
828 fn crt_static(&self, target: Interned<String>) -> Option<bool> {
829 if target.contains("pc-windows-msvc") {
832 self.config.target_config.get(&target).and_then(|t| t.crt_static)
836 /// Returns the "musl root" for this `target`, if defined
837 fn musl_root(&self, target: Interned<String>) -> Option<&Path> {
841 .and_then(|t| t.musl_root.as_ref())
842 .or(self.config.musl_root.as_ref())
846 /// Returns the sysroot for the wasi target, if defined
847 fn wasi_root(&self, target: Interned<String>) -> Option<&Path> {
848 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
851 /// Returns `true` if this is a no-std `target`, if defined
852 fn no_std(&self, target: Interned<String>) -> Option<bool> {
853 self.config.target_config.get(&target).map(|t| t.no_std)
856 /// Returns `true` if the target will be tested using the `remote-test-client`
857 /// and `remote-test-server` binaries.
858 fn remote_tested(&self, target: Interned<String>) -> bool {
859 self.qemu_rootfs(target).is_some()
860 || target.contains("android")
861 || env::var_os("TEST_DEVICE_ADDR").is_some()
864 /// Returns the root of the "rootfs" image that this target will be using,
865 /// if one was configured.
867 /// If `Some` is returned then that means that tests for this target are
868 /// emulated with QEMU and binaries will need to be shipped to the emulator.
869 fn qemu_rootfs(&self, target: Interned<String>) -> Option<&Path> {
870 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
873 /// Path to the python interpreter to use
874 fn python(&self) -> &Path {
875 self.config.python.as_ref().unwrap()
878 /// Temporary directory that extended error information is emitted to.
879 fn extended_error_dir(&self) -> PathBuf {
880 self.out.join("tmp/extended-error-metadata")
883 /// Tests whether the `compiler` compiling for `target` should be forced to
884 /// use a stage1 compiler instead.
886 /// Currently, by default, the build system does not perform a "full
887 /// bootstrap" by default where we compile the compiler three times.
888 /// Instead, we compile the compiler two times. The final stage (stage2)
889 /// just copies the libraries from the previous stage, which is what this
892 /// Here we return `true` if:
894 /// * The build isn't performing a full bootstrap
895 /// * The `compiler` is in the final stage, 2
896 /// * We're not cross-compiling, so the artifacts are already available in
899 /// When all of these conditions are met the build will lift artifacts from
900 /// the previous stage forward.
901 fn force_use_stage1(&self, compiler: Compiler, target: Interned<String>) -> bool {
902 !self.config.full_bootstrap
903 && compiler.stage >= 2
904 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
907 /// Given `num` in the form "a.b.c" return a "release string" which
908 /// describes the release version number.
910 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
911 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
912 fn release(&self, num: &str) -> String {
913 match &self.config.channel[..] {
914 "stable" => num.to_string(),
916 if self.rust_info.is_git() {
917 format!("{}-beta.{}", num, self.beta_prerelease_version())
919 format!("{}-beta", num)
922 "nightly" => format!("{}-nightly", num),
923 _ => format!("{}-dev", num),
927 fn beta_prerelease_version(&self) -> u32 {
928 if let Some(s) = self.prerelease_version.get() {
933 Command::new("git").arg("ls-remote").arg("origin").arg("beta").current_dir(&self.src),
935 let beta = beta.trim().split_whitespace().next().unwrap();
937 Command::new("git").arg("ls-remote").arg("origin").arg("master").current_dir(&self.src),
939 let master = master.trim().split_whitespace().next().unwrap();
941 // Figure out where the current beta branch started.
943 Command::new("git").arg("merge-base").arg(beta).arg(master).current_dir(&self.src),
945 let base = base.trim();
947 // Next figure out how many merge commits happened since we branched off
948 // beta. That's our beta number!
954 .arg(format!("{}...HEAD", base))
955 .current_dir(&self.src),
957 let n = count.trim().parse().unwrap();
958 self.prerelease_version.set(Some(n));
962 /// Returns the value of `release` above for Rust itself.
963 fn rust_release(&self) -> String {
964 self.release(channel::CFG_RELEASE_NUM)
967 /// Returns the "package version" for a component given the `num` release
970 /// The package version is typically what shows up in the names of tarballs.
971 /// For channels like beta/nightly it's just the channel name, otherwise
972 /// it's the `num` provided.
973 fn package_vers(&self, num: &str) -> String {
974 match &self.config.channel[..] {
975 "stable" => num.to_string(),
976 "beta" => "beta".to_string(),
977 "nightly" => "nightly".to_string(),
978 _ => format!("{}-dev", num),
982 /// Returns the value of `package_vers` above for Rust itself.
983 fn rust_package_vers(&self) -> String {
984 self.package_vers(channel::CFG_RELEASE_NUM)
987 /// Returns the value of `package_vers` above for Cargo
988 fn cargo_package_vers(&self) -> String {
989 self.package_vers(&self.release_num("cargo"))
992 /// Returns the value of `package_vers` above for rls
993 fn rls_package_vers(&self) -> String {
994 self.package_vers(&self.release_num("rls"))
997 /// Returns the value of `package_vers` above for clippy
998 fn clippy_package_vers(&self) -> String {
999 self.package_vers(&self.release_num("clippy"))
1002 /// Returns the value of `package_vers` above for miri
1003 fn miri_package_vers(&self) -> String {
1004 self.package_vers(&self.release_num("miri"))
1007 /// Returns the value of `package_vers` above for rustfmt
1008 fn rustfmt_package_vers(&self) -> String {
1009 self.package_vers(&self.release_num("rustfmt"))
1012 fn llvm_tools_package_vers(&self) -> String {
1013 self.package_vers(channel::CFG_RELEASE_NUM)
1016 fn llvm_tools_vers(&self) -> String {
1020 fn lldb_package_vers(&self) -> String {
1021 self.package_vers(channel::CFG_RELEASE_NUM)
1024 fn lldb_vers(&self) -> String {
1028 fn llvm_link_tools_dynamically(&self, target: Interned<String>) -> bool {
1029 (target.contains("linux-gnu") || target.contains("apple-darwin"))
1032 /// Returns the `version` string associated with this compiler for Rust
1035 /// Note that this is a descriptive string which includes the commit date,
1036 /// sha, version, etc.
1037 fn rust_version(&self) -> String {
1038 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1041 /// Returns the full commit hash.
1042 fn rust_sha(&self) -> Option<&str> {
1043 self.rust_info.sha()
1046 /// Returns the `a.b.c` version that the given package is at.
1047 fn release_num(&self, package: &str) -> String {
1048 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1049 let toml = t!(fs::read_to_string(&toml_file_name));
1050 for line in toml.lines() {
1051 let prefix = "version = \"";
1053 if line.starts_with(prefix) && line.ends_with(suffix) {
1054 return line[prefix.len()..line.len() - suffix.len()].to_string();
1058 panic!("failed to find version in {}'s Cargo.toml", package)
1061 /// Returns `true` if unstable features should be enabled for the compiler
1063 fn unstable_features(&self) -> bool {
1064 match &self.config.channel[..] {
1065 "stable" | "beta" => false,
1066 "nightly" | _ => true,
1070 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1071 let mut ret = Vec::new();
1072 let mut list = vec![INTERNER.intern_str(root)];
1073 let mut visited = HashSet::new();
1074 while let Some(krate) = list.pop() {
1075 let krate = &self.crates[&krate];
1076 if krate.is_local(self) {
1079 for dep in &krate.deps {
1080 if visited.insert(dep) && dep != "build_helper" {
1088 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, bool)> {
1089 if self.config.dry_run {
1093 let mut paths = Vec::new();
1094 let contents = t!(fs::read(stamp), &stamp);
1095 // This is the method we use for extracting paths from the stamp file passed to us. See
1096 // run_cargo for more information (in compile.rs).
1097 for part in contents.split(|b| *b == 0) {
1098 if part.is_empty() {
1101 let host = part[0] as char == 'h';
1102 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1103 paths.push((path, host));
1108 /// Copies a file from `src` to `dst`
1109 pub fn copy(&self, src: &Path, dst: &Path) {
1110 if self.config.dry_run {
1113 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1117 let _ = fs::remove_file(&dst);
1118 let metadata = t!(src.symlink_metadata());
1119 if metadata.file_type().is_symlink() {
1120 let link = t!(fs::read_link(src));
1121 t!(symlink_file(link, dst));
1122 } else if let Ok(()) = fs::hard_link(src, dst) {
1123 // Attempt to "easy copy" by creating a hard link
1124 // (symlinks don't work on windows), but if that fails
1125 // just fall back to a slow `copy` operation.
1127 if let Err(e) = fs::copy(src, dst) {
1128 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1130 t!(fs::set_permissions(dst, metadata.permissions()));
1131 let atime = FileTime::from_last_access_time(&metadata);
1132 let mtime = FileTime::from_last_modification_time(&metadata);
1133 t!(filetime::set_file_times(dst, atime, mtime));
1137 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1138 /// new string for each replacement.)
1139 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1140 if self.config.dry_run {
1143 let mut contents = String::new();
1144 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1145 t!(file.read_to_string(&mut contents));
1146 for &(target, replacement) in replacements {
1147 contents = contents.replace(target, replacement);
1149 t!(file.seek(SeekFrom::Start(0)));
1150 t!(file.set_len(0));
1151 t!(file.write_all(contents.as_bytes()));
1154 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1155 /// when this function is called.
1156 pub fn cp_r(&self, src: &Path, dst: &Path) {
1157 if self.config.dry_run {
1160 for f in self.read_dir(src) {
1161 let path = f.path();
1162 let name = path.file_name().unwrap();
1163 let dst = dst.join(name);
1164 if t!(f.file_type()).is_dir() {
1165 t!(fs::create_dir_all(&dst));
1166 self.cp_r(&path, &dst);
1168 let _ = fs::remove_file(&dst);
1169 self.copy(&path, &dst);
1174 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1175 /// when this function is called. Unwanted files or directories can be skipped
1176 /// by returning `false` from the filter function.
1177 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1178 // Immediately recurse with an empty relative path
1179 self.recurse_(src, dst, Path::new(""), filter)
1182 // Inner function does the actual work
1183 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1184 for f in self.read_dir(src) {
1185 let path = f.path();
1186 let name = path.file_name().unwrap();
1187 let dst = dst.join(name);
1188 let relative = relative.join(name);
1189 // Only copy file or directory if the filter function returns true
1190 if filter(&relative) {
1191 if t!(f.file_type()).is_dir() {
1192 let _ = fs::remove_dir_all(&dst);
1193 self.create_dir(&dst);
1194 self.recurse_(&path, &dst, &relative, filter);
1196 let _ = fs::remove_file(&dst);
1197 self.copy(&path, &dst);
1203 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1204 let file_name = src.file_name().unwrap();
1205 let dest = dest_folder.join(file_name);
1206 self.copy(src, &dest);
1209 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1210 if self.config.dry_run {
1213 let dst = dstdir.join(src.file_name().unwrap());
1214 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1215 t!(fs::create_dir_all(dstdir));
1216 drop(fs::remove_file(&dst));
1219 panic!("Error: File \"{}\" not found!", src.display());
1221 let metadata = t!(src.symlink_metadata());
1222 if let Err(e) = fs::copy(&src, &dst) {
1223 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1225 t!(fs::set_permissions(&dst, metadata.permissions()));
1226 let atime = FileTime::from_last_access_time(&metadata);
1227 let mtime = FileTime::from_last_modification_time(&metadata);
1228 t!(filetime::set_file_times(&dst, atime, mtime));
1233 fn create(&self, path: &Path, s: &str) {
1234 if self.config.dry_run {
1237 t!(fs::write(path, s));
1240 fn read(&self, path: &Path) -> String {
1241 if self.config.dry_run {
1242 return String::new();
1244 t!(fs::read_to_string(path))
1247 fn create_dir(&self, dir: &Path) {
1248 if self.config.dry_run {
1251 t!(fs::create_dir_all(dir))
1254 fn remove_dir(&self, dir: &Path) {
1255 if self.config.dry_run {
1258 t!(fs::remove_dir_all(dir))
1261 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1262 let iter = match fs::read_dir(dir) {
1264 Err(_) if self.config.dry_run => return vec![].into_iter(),
1265 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1267 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1270 fn remove(&self, f: &Path) {
1271 if self.config.dry_run {
1274 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1279 fn chmod(path: &Path, perms: u32) {
1280 use std::os::unix::fs::*;
1281 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1284 fn chmod(_path: &Path, _perms: u32) {}
1287 pub fn with_stage(mut self, stage: u32) -> Compiler {
1292 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1293 pub fn is_snapshot(&self, build: &Build) -> bool {
1294 self.stage == 0 && self.host == build.build
1297 /// Returns if this compiler should be treated as a final stage one in the
1298 /// current build session.
1299 /// This takes into account whether we're performing a full bootstrap or
1300 /// not; don't directly compare the stage with `2`!
1301 pub fn is_final_stage(&self, build: &Build) -> bool {
1302 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1303 self.stage >= final_stage
1307 fn envify(s: &str) -> String {
1313 .flat_map(|c| c.to_uppercase())