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 use std::cell::{Cell, RefCell};
107 use std::collections::{HashMap, HashSet};
109 use std::fs::{self, File, OpenOptions};
110 use std::io::{Read, Seek, SeekFrom, Write};
111 use std::path::{Path, PathBuf};
112 use std::process::{self, Command};
117 use std::os::unix::fs::symlink as symlink_file;
119 use std::os::windows::fs::symlink_file;
121 use build_helper::{mtime, output, run, run_suppressed, t, try_run, try_run_suppressed};
122 use filetime::FileTime;
124 use crate::config::{LlvmLibunwind, TargetSelection};
125 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 pub use crate::flags::Subcommand;
171 const LLVM_TOOLS: &[&str] = &[
172 "llvm-cov", // used to generate coverage report
173 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
174 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
175 "llvm-objdump", // used to disassemble programs
176 "llvm-profdata", // used to inspect and merge files generated by profiles
177 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
178 "llvm-size", // used to prints the size of the linker sections of a program
179 "llvm-strip", // used to discard symbols from binary files to reduce their size
180 "llvm-ar", // used for creating and modifying archive files
181 "llvm-as", // used to convert LLVM assembly to LLVM bitcode
182 "llvm-dis", // used to disassemble LLVM bitcode
183 "llc", // used to compile LLVM bytecode
184 "opt", // used to optimize LLVM bytecode
187 pub const VERSION: usize = 2;
189 /// A structure representing a Rust compiler.
191 /// Each compiler has a `stage` that it is associated with and a `host` that
192 /// corresponds to the platform the compiler runs on. This structure is used as
193 /// a parameter to many methods below.
194 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
195 pub struct Compiler {
197 host: TargetSelection,
200 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
202 /// Run normal tests and doc tests (default).
204 /// Do not run any doc tests.
206 /// Only run doc tests.
215 /// Global configuration for the build system.
217 /// This structure transitively contains all configuration for the build system.
218 /// All filesystem-encoded configuration is in `config`, all flags are in
219 /// `flags`, and then parsed or probed information is listed in the keys below.
221 /// This structure is a parameter of almost all methods in the build system,
222 /// although most functions are implemented as free functions rather than
223 /// methods specifically on this structure itself (to make it easier to
226 /// User-specified configuration from `config.toml`.
229 // Version information
232 // Properties derived from the above configuration
235 rust_info: channel::GitInfo,
236 cargo_info: channel::GitInfo,
237 rls_info: channel::GitInfo,
238 rust_analyzer_info: channel::GitInfo,
239 clippy_info: channel::GitInfo,
240 miri_info: channel::GitInfo,
241 rustfmt_info: channel::GitInfo,
242 in_tree_llvm_info: channel::GitInfo,
248 // Targets for which to build
249 build: TargetSelection,
250 hosts: Vec<TargetSelection>,
251 targets: Vec<TargetSelection>,
253 // Stage 0 (downloaded) compiler, lld and cargo or their local rust equivalents
254 initial_rustc: PathBuf,
255 initial_cargo: PathBuf,
256 initial_lld: PathBuf,
257 initial_libdir: PathBuf,
259 // Runtime state filled in later on
260 // C/C++ compilers and archiver for all targets
261 cc: HashMap<TargetSelection, cc::Tool>,
262 cxx: HashMap<TargetSelection, cc::Tool>,
263 ar: HashMap<TargetSelection, PathBuf>,
264 ranlib: HashMap<TargetSelection, PathBuf>,
266 crates: HashMap<Interned<String>, Crate>,
269 delayed_failures: RefCell<Vec<String>>,
270 prerelease_version: Cell<Option<u32>>,
272 RefCell<HashMap<TargetSelection, HashMap<String, (&'static str, PathBuf, Vec<String>)>>>,
277 name: Interned<String>,
278 deps: HashSet<Interned<String>>,
284 fn local_path(&self, build: &Build) -> PathBuf {
285 self.path.strip_prefix(&build.config.src).unwrap().into()
289 /// When building Rust various objects are handled differently.
290 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
291 pub enum DependencyType {
292 /// Libraries originating from proc-macros.
294 /// Typical Rust libraries.
296 /// Non Rust libraries and objects shipped to ease usage of certain targets.
300 /// The various "modes" of invoking Cargo.
302 /// These entries currently correspond to the various output directories of the
303 /// build system, with each mod generating output in a different directory.
304 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
306 /// Build the standard library, placing output in the "stageN-std" directory.
309 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
312 /// Build a codegen backend for rustc, placing the output in the "stageN-codegen" directory.
315 /// Build a tool, placing output in the "stage0-bootstrap-tools"
316 /// directory. This is for miscellaneous sets of tools that are built
317 /// using the bootstrap stage0 compiler in its entirety (target libraries
318 /// and all). Typically these tools compile with stable Rust.
321 /// Build a tool which uses the locally built std, placing output in the
322 /// "stageN-tools" directory. Its usage is quite rare, mainly used by
323 /// compiletest which needs libtest.
326 /// Build a tool which uses the locally built rustc and the target std,
327 /// placing the output in the "stageN-tools" directory. This is used for
328 /// anything that needs a fully functional rustc, such as rustdoc, clippy,
329 /// cargo, rls, rustfmt, miri, etc.
334 pub fn is_tool(&self) -> bool {
335 matches!(self, Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd)
338 pub fn must_support_dlopen(&self) -> bool {
339 matches!(self, Mode::Std | Mode::Codegen)
344 /// Creates a new set of build configuration from the `flags` on the command
345 /// line and the filesystem `config`.
347 /// By default all build output will be placed in the current directory.
348 pub fn new(config: Config) -> Build {
349 let src = config.src.clone();
350 let out = config.out.clone();
352 let is_sudo = match env::var_os("SUDO_USER") {
353 Some(sudo_user) => match env::var_os("USER") {
354 Some(user) => user != sudo_user,
360 let ignore_git = config.ignore_git;
361 let rust_info = channel::GitInfo::new(ignore_git, &src);
362 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
363 let rls_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rls"));
364 let rust_analyzer_info =
365 channel::GitInfo::new(ignore_git, &src.join("src/tools/rust-analyzer"));
366 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
367 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
368 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
370 // we always try to use git for LLVM builds
371 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
373 let initial_target_libdir_str = if config.dry_run {
374 "/dummy/lib/path/to/lib/".to_string()
377 Command::new(&config.initial_rustc)
379 .arg(config.build.rustc_target_arg())
381 .arg("target-libdir"),
384 let initial_target_dir = Path::new(&initial_target_libdir_str).parent().unwrap();
385 let initial_lld = initial_target_dir.join("bin").join("rust-lld");
387 let initial_sysroot = if config.dry_run {
390 output(Command::new(&config.initial_rustc).arg("--print").arg("sysroot"))
392 let initial_libdir = initial_target_dir
397 .strip_prefix(initial_sysroot.trim())
401 let version = std::fs::read_to_string(src.join("src").join("version"))
402 .expect("failed to read src/version");
403 let version = version.trim();
405 let mut build = Build {
406 initial_rustc: config.initial_rustc.clone(),
407 initial_cargo: config.initial_cargo.clone(),
410 local_rebuild: config.local_rebuild,
411 fail_fast: config.cmd.fail_fast(),
412 doc_tests: config.cmd.doc_tests(),
413 verbosity: config.verbose,
416 hosts: config.hosts.clone(),
417 targets: config.targets.clone(),
420 version: version.to_string(),
435 ranlib: HashMap::new(),
436 crates: HashMap::new(),
438 ci_env: CiEnv::current(),
439 delayed_failures: RefCell::new(Vec::new()),
440 prerelease_version: Cell::new(None),
441 tool_artifacts: Default::default(),
444 build.verbose("finding compilers");
445 cc_detect::find(&mut build);
446 build.verbose("running sanity check");
447 sanity::check(&mut build);
449 // If local-rust is the same major.minor as the current version, then force a
451 let local_version_verbose =
452 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
453 let local_release = local_version_verbose
455 .filter_map(|x| x.strip_prefix("release:"))
459 if local_release.split('.').take(2).eq(version.split('.').take(2)) {
460 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
461 build.local_rebuild = true;
464 build.verbose("learning about cargo");
465 metadata::build(&mut build);
470 pub fn build_triple(&self) -> &[Interned<String>] {
471 slice::from_ref(&self.build.triple)
474 /// Executes the entire build, as configured by the flags and configuration.
475 pub fn build(&mut self) {
480 if let Subcommand::Format { check } = self.config.cmd {
481 return format::format(self, check);
484 if let Subcommand::Clean { all } = self.config.cmd {
485 return clean::clean(self, all);
488 if let Subcommand::Setup { profile } = &self.config.cmd {
489 return setup::setup(&self.config.src, *profile);
493 let builder = builder::Builder::new(&self);
494 if let Some(path) = builder.paths.get(0) {
495 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
501 if !self.config.dry_run {
503 self.config.dry_run = true;
504 let builder = builder::Builder::new(&self);
505 builder.execute_cli();
507 self.config.dry_run = false;
508 let builder = builder::Builder::new(&self);
509 builder.execute_cli();
511 let builder = builder::Builder::new(&self);
512 builder.execute_cli();
515 // Check for postponed failures from `test --no-fail-fast`.
516 let failures = self.delayed_failures.borrow();
517 if failures.len() > 0 {
518 println!("\n{} command(s) did not execute successfully:\n", failures.len());
519 for failure in failures.iter() {
520 println!(" - {}\n", failure);
526 /// Clear out `dir` if `input` is newer.
528 /// After this executes, it will also ensure that `dir` exists.
529 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
530 let stamp = dir.join(".stamp");
531 let mut cleared = false;
532 if mtime(&stamp) < mtime(input) {
533 self.verbose(&format!("Dirty - {}", dir.display()));
534 let _ = fs::remove_dir_all(dir);
536 } else if stamp.exists() {
539 t!(fs::create_dir_all(dir));
540 t!(File::create(stamp));
544 /// Gets the space-separated set of activated features for the standard
546 fn std_features(&self, target: TargetSelection) -> String {
547 let mut features = "panic-unwind".to_string();
549 match self.config.llvm_libunwind.unwrap_or_default() {
550 LlvmLibunwind::InTree => features.push_str(" llvm-libunwind"),
551 LlvmLibunwind::System => features.push_str(" system-llvm-libunwind"),
552 LlvmLibunwind::No => {}
554 if self.config.backtrace {
555 features.push_str(" backtrace");
557 if self.config.profiler_enabled(target) {
558 features.push_str(" profiler");
563 /// Gets the space-separated set of activated features for the compiler.
564 fn rustc_features(&self) -> String {
565 let mut features = String::new();
566 if self.config.jemalloc {
567 features.push_str("jemalloc");
569 if self.config.llvm_enabled() {
570 features.push_str(" llvm");
573 // If debug logging is on, then we want the default for tracing:
574 // https://github.com/tokio-rs/tracing/blob/3dd5c03d907afdf2c39444a29931833335171554/tracing/src/level_filters.rs#L26
575 // which is everything (including debug/trace/etc.)
576 // if its unset, if debug_assertions is on, then debug_logging will also be on
577 // as well as tracing *ignoring* this feature when debug_assertions is on
578 if !self.config.rust_debug_logging {
579 features.push_str(" max_level_info");
585 /// Component directory that Cargo will produce output into (e.g.
587 fn cargo_dir(&self) -> &'static str {
588 if self.config.rust_optimize { "release" } else { "debug" }
591 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
594 .join(&*compiler.host.triple)
595 .join(format!("stage{}-tools-bin", compiler.stage));
596 t!(fs::create_dir_all(&out));
600 /// Returns the root directory for all output generated in a particular
601 /// stage when running with a particular host compiler.
603 /// The mode indicates what the root directory is for.
604 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
605 let suffix = match mode {
607 Mode::Rustc => "-rustc",
608 Mode::Codegen => "-codegen",
609 Mode::ToolBootstrap => "-bootstrap-tools",
610 Mode::ToolStd | Mode::ToolRustc => "-tools",
612 self.out.join(&*compiler.host.triple).join(format!("stage{}{}", compiler.stage, suffix))
615 /// Returns the root output directory for all Cargo output in a given stage,
616 /// running a particular compiler, whether or not we're building the
617 /// standard library, and targeting the specified architecture.
618 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: TargetSelection) -> PathBuf {
619 self.stage_out(compiler, mode).join(&*target.triple).join(self.cargo_dir())
622 /// Root output directory for LLVM compiled for `target`
624 /// Note that if LLVM is configured externally then the directory returned
625 /// will likely be empty.
626 fn llvm_out(&self, target: TargetSelection) -> PathBuf {
627 self.out.join(&*target.triple).join("llvm")
630 fn lld_out(&self, target: TargetSelection) -> PathBuf {
631 self.out.join(&*target.triple).join("lld")
634 /// Output directory for all documentation for a target
635 fn doc_out(&self, target: TargetSelection) -> PathBuf {
636 self.out.join(&*target.triple).join("doc")
639 /// Output directory for all documentation for a target
640 fn compiler_doc_out(&self, target: TargetSelection) -> PathBuf {
641 self.out.join(&*target.triple).join("compiler-doc")
644 /// Output directory for some generated md crate documentation for a target (temporary)
645 fn md_doc_out(&self, target: TargetSelection) -> Interned<PathBuf> {
646 INTERNER.intern_path(self.out.join(&*target.triple).join("md-doc"))
649 /// Returns `true` if no custom `llvm-config` is set for the specified target.
651 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
652 fn is_rust_llvm(&self, target: TargetSelection) -> bool {
653 if self.config.llvm_from_ci && target == self.config.build {
657 match self.config.target_config.get(&target) {
658 Some(ref c) => c.llvm_config.is_none(),
663 /// Returns the path to `FileCheck` binary for the specified target
664 fn llvm_filecheck(&self, target: TargetSelection) -> PathBuf {
665 let target_config = self.config.target_config.get(&target);
666 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
668 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
669 let llvm_bindir = output(Command::new(s).arg("--bindir"));
670 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", target));
671 if filecheck.exists() {
674 // On Fedora the system LLVM installs FileCheck in the
675 // llvm subdirectory of the libdir.
676 let llvm_libdir = output(Command::new(s).arg("--libdir"));
678 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", target));
679 if lib_filecheck.exists() {
682 // Return the most normal file name, even though
683 // it doesn't exist, so that any error message
689 let base = self.llvm_out(self.config.build).join("build");
690 let base = if !self.ninja() && self.config.build.contains("msvc") {
691 if self.config.llvm_optimize {
692 if self.config.llvm_release_debuginfo {
693 base.join("RelWithDebInfo")
703 base.join("bin").join(exe("FileCheck", target))
707 /// Directory for libraries built from C/C++ code and shared between stages.
708 fn native_dir(&self, target: TargetSelection) -> PathBuf {
709 self.out.join(&*target.triple).join("native")
712 /// Root output directory for rust_test_helpers library compiled for
714 fn test_helpers_out(&self, target: TargetSelection) -> PathBuf {
715 self.native_dir(target).join("rust-test-helpers")
718 /// Adds the `RUST_TEST_THREADS` env var if necessary
719 fn add_rust_test_threads(&self, cmd: &mut Command) {
720 if env::var_os("RUST_TEST_THREADS").is_none() {
721 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
725 /// Returns the libdir of the snapshot compiler.
726 fn rustc_snapshot_libdir(&self) -> PathBuf {
727 self.rustc_snapshot_sysroot().join(libdir(self.config.build))
730 /// Returns the sysroot of the snapshot compiler.
731 fn rustc_snapshot_sysroot(&self) -> &Path {
732 self.initial_rustc.parent().unwrap().parent().unwrap()
735 /// Runs a command, printing out nice contextual information if it fails.
736 fn run(&self, cmd: &mut Command) {
737 if self.config.dry_run {
740 self.verbose(&format!("running: {:?}", cmd));
744 /// Runs a command, printing out nice contextual information if it fails.
745 fn run_quiet(&self, cmd: &mut Command) {
746 if self.config.dry_run {
749 self.verbose(&format!("running: {:?}", cmd));
753 /// Runs a command, printing out nice contextual information if it fails.
754 /// Exits if the command failed to execute at all, otherwise returns its
755 /// `status.success()`.
756 fn try_run(&self, cmd: &mut Command) -> bool {
757 if self.config.dry_run {
760 self.verbose(&format!("running: {:?}", cmd));
764 /// Runs a command, printing out nice contextual information if it fails.
765 /// Exits if the command failed to execute at all, otherwise returns its
766 /// `status.success()`.
767 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
768 if self.config.dry_run {
771 self.verbose(&format!("running: {:?}", cmd));
772 try_run_suppressed(cmd)
775 pub fn is_verbose(&self) -> bool {
779 /// Prints a message if this build is configured in verbose mode.
780 fn verbose(&self, msg: &str) {
781 if self.is_verbose() {
786 pub fn is_verbose_than(&self, level: usize) -> bool {
787 self.verbosity > level
790 /// Prints a message if this build is configured in more verbose mode than `level`.
791 fn verbose_than(&self, level: usize, msg: &str) {
792 if self.is_verbose_than(level) {
797 fn info(&self, msg: &str) {
798 if self.config.dry_run {
804 /// Returns the number of parallel jobs that have been configured for this
806 fn jobs(&self) -> u32 {
807 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
810 fn debuginfo_map_to(&self, which: GitRepo) -> Option<String> {
811 if !self.config.rust_remap_debuginfo {
817 let sha = self.rust_sha().unwrap_or(&self.version);
818 Some(format!("/rustc/{}", sha))
820 GitRepo::Llvm => Some(String::from("/rustc/llvm")),
824 /// Returns the path to the C compiler for the target specified.
825 fn cc(&self, target: TargetSelection) -> &Path {
826 self.cc[&target].path()
829 /// Returns a list of flags to pass to the C compiler for the target
831 fn cflags(&self, target: TargetSelection, which: GitRepo) -> Vec<String> {
832 // Filter out -O and /O (the optimization flags) that we picked up from
833 // cc-rs because the build scripts will determine that for themselves.
834 let mut base = self.cc[&target]
837 .map(|s| s.to_string_lossy().into_owned())
838 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
839 .collect::<Vec<String>>();
841 // If we're compiling on macOS then we add a few unconditional flags
842 // indicating that we want libc++ (more filled out than libstdc++) and
843 // we want to compile for 10.7. This way we can ensure that
844 // LLVM/etc are all properly compiled.
845 if target.contains("apple-darwin") {
846 base.push("-stdlib=libc++".into());
849 // Work around an apparently bad MinGW / GCC optimization,
850 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
851 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
852 if &*target.triple == "i686-pc-windows-gnu" {
853 base.push("-fno-omit-frame-pointer".into());
856 if let Some(map_to) = self.debuginfo_map_to(which) {
857 let map = format!("{}={}", self.src.display(), map_to);
858 let cc = self.cc(target);
859 if cc.ends_with("clang") || cc.ends_with("gcc") {
860 base.push(format!("-fdebug-prefix-map={}", map));
861 } else if cc.ends_with("clang-cl.exe") {
862 base.push("-Xclang".into());
863 base.push(format!("-fdebug-prefix-map={}", map));
869 /// Returns the path to the `ar` archive utility for the target specified.
870 fn ar(&self, target: TargetSelection) -> Option<&Path> {
871 self.ar.get(&target).map(|p| &**p)
874 /// Returns the path to the `ranlib` utility for the target specified.
875 fn ranlib(&self, target: TargetSelection) -> Option<&Path> {
876 self.ranlib.get(&target).map(|p| &**p)
879 /// Returns the path to the C++ compiler for the target specified.
880 fn cxx(&self, target: TargetSelection) -> Result<&Path, String> {
881 match self.cxx.get(&target) {
882 Some(p) => Ok(p.path()),
884 Err(format!("target `{}` is not configured as a host, only as a target", target))
889 /// Returns the path to the linker for the given target if it needs to be overridden.
890 fn linker(&self, target: TargetSelection) -> Option<&Path> {
891 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
894 } else if target.contains("vxworks") {
895 // need to use CXX compiler as linker to resolve the exception functions
896 // that are only existed in CXX libraries
897 Some(self.cxx[&target].path())
898 } else if target != self.config.build
899 && util::use_host_linker(target)
900 && !target.contains("msvc")
902 Some(self.cc(target))
903 } else if self.config.use_lld && !self.is_fuse_ld_lld(target) && self.build == target {
904 Some(&self.initial_lld)
910 // LLD is used through `-fuse-ld=lld` rather than directly.
911 // Only MSVC targets use LLD directly at the moment.
912 fn is_fuse_ld_lld(&self, target: TargetSelection) -> bool {
913 self.config.use_lld && !target.contains("msvc")
916 /// Returns if this target should statically link the C runtime, if specified
917 fn crt_static(&self, target: TargetSelection) -> Option<bool> {
918 if target.contains("pc-windows-msvc") {
921 self.config.target_config.get(&target).and_then(|t| t.crt_static)
925 /// Returns the "musl root" for this `target`, if defined
926 fn musl_root(&self, target: TargetSelection) -> Option<&Path> {
930 .and_then(|t| t.musl_root.as_ref())
931 .or_else(|| self.config.musl_root.as_ref())
935 /// Returns the "musl libdir" for this `target`.
936 fn musl_libdir(&self, target: TargetSelection) -> Option<PathBuf> {
937 let t = self.config.target_config.get(&target)?;
938 if let libdir @ Some(_) = &t.musl_libdir {
939 return libdir.clone();
941 self.musl_root(target).map(|root| root.join("lib"))
944 /// Returns the sysroot for the wasi target, if defined
945 fn wasi_root(&self, target: TargetSelection) -> Option<&Path> {
946 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
949 /// Returns `true` if this is a no-std `target`, if defined
950 fn no_std(&self, target: TargetSelection) -> Option<bool> {
951 self.config.target_config.get(&target).map(|t| t.no_std)
954 /// Returns `true` if the target will be tested using the `remote-test-client`
955 /// and `remote-test-server` binaries.
956 fn remote_tested(&self, target: TargetSelection) -> bool {
957 self.qemu_rootfs(target).is_some()
958 || target.contains("android")
959 || env::var_os("TEST_DEVICE_ADDR").is_some()
962 /// Returns the root of the "rootfs" image that this target will be using,
963 /// if one was configured.
965 /// If `Some` is returned then that means that tests for this target are
966 /// emulated with QEMU and binaries will need to be shipped to the emulator.
967 fn qemu_rootfs(&self, target: TargetSelection) -> Option<&Path> {
968 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
971 /// Path to the python interpreter to use
972 fn python(&self) -> &Path {
973 self.config.python.as_ref().unwrap()
976 /// Temporary directory that extended error information is emitted to.
977 fn extended_error_dir(&self) -> PathBuf {
978 self.out.join("tmp/extended-error-metadata")
981 /// Tests whether the `compiler` compiling for `target` should be forced to
982 /// use a stage1 compiler instead.
984 /// Currently, by default, the build system does not perform a "full
985 /// bootstrap" by default where we compile the compiler three times.
986 /// Instead, we compile the compiler two times. The final stage (stage2)
987 /// just copies the libraries from the previous stage, which is what this
990 /// Here we return `true` if:
992 /// * The build isn't performing a full bootstrap
993 /// * The `compiler` is in the final stage, 2
994 /// * We're not cross-compiling, so the artifacts are already available in
997 /// When all of these conditions are met the build will lift artifacts from
998 /// the previous stage forward.
999 fn force_use_stage1(&self, compiler: Compiler, target: TargetSelection) -> bool {
1000 !self.config.full_bootstrap
1001 && compiler.stage >= 2
1002 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
1005 /// Given `num` in the form "a.b.c" return a "release string" which
1006 /// describes the release version number.
1008 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
1009 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
1010 fn release(&self, num: &str) -> String {
1011 match &self.config.channel[..] {
1012 "stable" => num.to_string(),
1014 if self.rust_info.is_git() {
1015 format!("{}-beta.{}", num, self.beta_prerelease_version())
1017 format!("{}-beta", num)
1020 "nightly" => format!("{}-nightly", num),
1021 _ => format!("{}-dev", num),
1025 fn beta_prerelease_version(&self) -> u32 {
1026 if let Some(s) = self.prerelease_version.get() {
1030 // Figure out how many merge commits happened since we branched off master.
1031 // That's our beta number!
1032 // (Note that we use a `..` range, not the `...` symmetric difference.)
1038 .arg("refs/remotes/origin/master..HEAD")
1039 .current_dir(&self.src),
1041 let n = count.trim().parse().unwrap();
1042 self.prerelease_version.set(Some(n));
1046 /// Returns the value of `release` above for Rust itself.
1047 fn rust_release(&self) -> String {
1048 self.release(&self.version)
1051 /// Returns the "package version" for a component given the `num` release
1054 /// The package version is typically what shows up in the names of tarballs.
1055 /// For channels like beta/nightly it's just the channel name, otherwise
1056 /// it's the `num` provided.
1057 fn package_vers(&self, num: &str) -> String {
1058 match &self.config.channel[..] {
1059 "stable" => num.to_string(),
1060 "beta" => "beta".to_string(),
1061 "nightly" => "nightly".to_string(),
1062 _ => format!("{}-dev", num),
1066 /// Returns the value of `package_vers` above for Rust itself.
1067 fn rust_package_vers(&self) -> String {
1068 self.package_vers(&self.version)
1071 fn llvm_tools_vers(&self) -> String {
1075 fn llvm_link_tools_dynamically(&self, target: TargetSelection) -> bool {
1076 target.contains("linux-gnu") || target.contains("apple-darwin")
1079 /// Returns the `version` string associated with this compiler for Rust
1082 /// Note that this is a descriptive string which includes the commit date,
1083 /// sha, version, etc.
1084 fn rust_version(&self) -> String {
1085 self.rust_info.version(self, &self.version)
1088 /// Returns the full commit hash.
1089 fn rust_sha(&self) -> Option<&str> {
1090 self.rust_info.sha()
1093 /// Returns the `a.b.c` version that the given package is at.
1094 fn release_num(&self, package: &str) -> String {
1095 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1096 let toml = t!(fs::read_to_string(&toml_file_name));
1097 for line in toml.lines() {
1098 if let Some(stripped) =
1099 line.strip_prefix("version = \"").and_then(|s| s.strip_suffix("\""))
1101 return stripped.to_owned();
1105 panic!("failed to find version in {}'s Cargo.toml", package)
1108 /// Returns `true` if unstable features should be enabled for the compiler
1110 fn unstable_features(&self) -> bool {
1111 match &self.config.channel[..] {
1112 "stable" | "beta" => false,
1113 "nightly" | _ => true,
1117 /// Returns a Vec of all the dependencies of the given root crate,
1118 /// including transitive dependencies and the root itself. Only includes
1119 /// "local" crates (those in the local source tree, not from a registry).
1120 fn in_tree_crates(&self, root: &str, target: Option<TargetSelection>) -> Vec<&Crate> {
1121 let mut ret = Vec::new();
1122 let mut list = vec![INTERNER.intern_str(root)];
1123 let mut visited = HashSet::new();
1124 while let Some(krate) = list.pop() {
1125 let krate = &self.crates[&krate];
1127 for dep in &krate.deps {
1128 if !self.crates.contains_key(dep) {
1129 // Ignore non-workspace members.
1132 // Don't include optional deps if their features are not
1133 // enabled. Ideally this would be computed from `cargo
1134 // metadata --features …`, but that is somewhat slow. Just
1135 // skip `build_helper` since there aren't any operations we
1136 // want to perform on it. In the future, we may want to
1137 // consider just filtering all build and dev dependencies in
1139 if visited.insert(dep)
1140 && dep != "build_helper"
1141 && (dep != "profiler_builtins"
1143 .map(|t| self.config.profiler_enabled(t))
1144 .unwrap_or(self.config.any_profiler_enabled()))
1145 && (dep != "rustc_codegen_llvm" || self.config.llvm_enabled())
1154 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, DependencyType)> {
1155 if self.config.dry_run {
1159 let mut paths = Vec::new();
1160 let contents = t!(fs::read(stamp), &stamp);
1161 // This is the method we use for extracting paths from the stamp file passed to us. See
1162 // run_cargo for more information (in compile.rs).
1163 for part in contents.split(|b| *b == 0) {
1164 if part.is_empty() {
1167 let dependency_type = match part[0] as char {
1168 'h' => DependencyType::Host,
1169 's' => DependencyType::TargetSelfContained,
1170 't' => DependencyType::Target,
1171 _ => unreachable!(),
1173 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1174 paths.push((path, dependency_type));
1179 /// Copies a file from `src` to `dst` and doesn't use links, so
1180 /// that the copy can be modified without affecting the original.
1181 pub fn really_copy(&self, src: &Path, dst: &Path) {
1182 if self.config.dry_run {
1185 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1189 let _ = fs::remove_file(&dst);
1190 let metadata = t!(src.symlink_metadata());
1191 if let Err(e) = fs::copy(src, dst) {
1192 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1194 t!(fs::set_permissions(dst, metadata.permissions()));
1195 let atime = FileTime::from_last_access_time(&metadata);
1196 let mtime = FileTime::from_last_modification_time(&metadata);
1197 t!(filetime::set_file_times(dst, atime, mtime));
1200 /// Copies a file from `src` to `dst`
1201 pub fn copy(&self, src: &Path, dst: &Path) {
1202 if self.config.dry_run {
1205 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1209 let _ = fs::remove_file(&dst);
1210 let metadata = t!(src.symlink_metadata());
1211 if metadata.file_type().is_symlink() {
1212 let link = t!(fs::read_link(src));
1213 t!(symlink_file(link, dst));
1214 } else if let Ok(()) = fs::hard_link(src, dst) {
1215 // Attempt to "easy copy" by creating a hard link
1216 // (symlinks don't work on windows), but if that fails
1217 // just fall back to a slow `copy` operation.
1219 if let Err(e) = fs::copy(src, dst) {
1220 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1222 t!(fs::set_permissions(dst, metadata.permissions()));
1223 let atime = FileTime::from_last_access_time(&metadata);
1224 let mtime = FileTime::from_last_modification_time(&metadata);
1225 t!(filetime::set_file_times(dst, atime, mtime));
1229 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1230 /// new string for each replacement.)
1231 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1232 if self.config.dry_run {
1235 let mut contents = String::new();
1236 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1237 t!(file.read_to_string(&mut contents));
1238 for &(target, replacement) in replacements {
1239 contents = contents.replace(target, replacement);
1241 t!(file.seek(SeekFrom::Start(0)));
1242 t!(file.set_len(0));
1243 t!(file.write_all(contents.as_bytes()));
1246 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1247 /// when this function is called.
1248 pub fn cp_r(&self, src: &Path, dst: &Path) {
1249 if self.config.dry_run {
1252 for f in self.read_dir(src) {
1253 let path = f.path();
1254 let name = path.file_name().unwrap();
1255 let dst = dst.join(name);
1256 if t!(f.file_type()).is_dir() {
1257 t!(fs::create_dir_all(&dst));
1258 self.cp_r(&path, &dst);
1260 let _ = fs::remove_file(&dst);
1261 self.copy(&path, &dst);
1266 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1267 /// when this function is called. Unwanted files or directories can be skipped
1268 /// by returning `false` from the filter function.
1269 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1270 // Immediately recurse with an empty relative path
1271 self.recurse_(src, dst, Path::new(""), filter)
1274 // Inner function does the actual work
1275 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1276 for f in self.read_dir(src) {
1277 let path = f.path();
1278 let name = path.file_name().unwrap();
1279 let dst = dst.join(name);
1280 let relative = relative.join(name);
1281 // Only copy file or directory if the filter function returns true
1282 if filter(&relative) {
1283 if t!(f.file_type()).is_dir() {
1284 let _ = fs::remove_dir_all(&dst);
1285 self.create_dir(&dst);
1286 self.recurse_(&path, &dst, &relative, filter);
1288 let _ = fs::remove_file(&dst);
1289 self.copy(&path, &dst);
1295 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1296 let file_name = src.file_name().unwrap();
1297 let dest = dest_folder.join(file_name);
1298 self.copy(src, &dest);
1301 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1302 if self.config.dry_run {
1305 let dst = dstdir.join(src.file_name().unwrap());
1306 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1307 t!(fs::create_dir_all(dstdir));
1308 drop(fs::remove_file(&dst));
1311 panic!("Error: File \"{}\" not found!", src.display());
1313 let metadata = t!(src.symlink_metadata());
1314 if let Err(e) = fs::copy(&src, &dst) {
1315 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1317 t!(fs::set_permissions(&dst, metadata.permissions()));
1318 let atime = FileTime::from_last_access_time(&metadata);
1319 let mtime = FileTime::from_last_modification_time(&metadata);
1320 t!(filetime::set_file_times(&dst, atime, mtime));
1325 fn create(&self, path: &Path, s: &str) {
1326 if self.config.dry_run {
1329 t!(fs::write(path, s));
1332 fn read(&self, path: &Path) -> String {
1333 if self.config.dry_run {
1334 return String::new();
1336 t!(fs::read_to_string(path))
1339 fn create_dir(&self, dir: &Path) {
1340 if self.config.dry_run {
1343 t!(fs::create_dir_all(dir))
1346 fn remove_dir(&self, dir: &Path) {
1347 if self.config.dry_run {
1350 t!(fs::remove_dir_all(dir))
1353 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1354 let iter = match fs::read_dir(dir) {
1356 Err(_) if self.config.dry_run => return vec![].into_iter(),
1357 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1359 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1362 fn remove(&self, f: &Path) {
1363 if self.config.dry_run {
1366 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1369 /// Returns if config.ninja is enabled, and checks for ninja existence,
1370 /// exiting with a nicer error message if not.
1371 fn ninja(&self) -> bool {
1372 let mut cmd_finder = crate::sanity::Finder::new();
1374 if self.config.ninja_in_file {
1375 // Some Linux distros rename `ninja` to `ninja-build`.
1376 // CMake can work with either binary name.
1377 if cmd_finder.maybe_have("ninja-build").is_none()
1378 && cmd_finder.maybe_have("ninja").is_none()
1382 Couldn't find required command: ninja
1383 You should install ninja, or set ninja=false in config.toml
1386 std::process::exit(1);
1390 // If ninja isn't enabled but we're building for MSVC then we try
1391 // doubly hard to enable it. It was realized in #43767 that the msbuild
1392 // CMake generator for MSVC doesn't respect configuration options like
1393 // disabling LLVM assertions, which can often be quite important!
1395 // In these cases we automatically enable Ninja if we find it in the
1397 if !self.config.ninja_in_file && self.config.build.contains("msvc") {
1398 if cmd_finder.maybe_have("ninja").is_some() {
1403 self.config.ninja_in_file
1408 fn chmod(path: &Path, perms: u32) {
1409 use std::os::unix::fs::*;
1410 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1413 fn chmod(_path: &Path, _perms: u32) {}
1416 pub fn with_stage(mut self, stage: u32) -> Compiler {
1421 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1422 pub fn is_snapshot(&self, build: &Build) -> bool {
1423 self.stage == 0 && self.host == build.build
1426 /// Returns if this compiler should be treated as a final stage one in the
1427 /// current build session.
1428 /// This takes into account whether we're performing a full bootstrap or
1429 /// not; don't directly compare the stage with `2`!
1430 pub fn is_final_stage(&self, build: &Build) -> bool {
1431 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1432 self.stage >= final_stage
1436 fn envify(s: &str) -> String {
1442 .flat_map(|c| c.to_uppercase())