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.json`, 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};
110 use std::path::{Path, PathBuf};
111 use std::process::{self, Command};
115 use std::os::unix::fs::symlink as symlink_file;
117 use std::os::windows::fs::symlink_file;
119 use build_helper::{mtime, output, run, run_suppressed, t, try_run, try_run_suppressed};
120 use filetime::FileTime;
122 use crate::builder::Kind;
123 use crate::config::{LlvmLibunwind, TargetSelection};
124 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>>,
283 fn local_path(&self, build: &Build) -> PathBuf {
284 self.path.strip_prefix(&build.config.src).unwrap().into()
288 /// When building Rust various objects are handled differently.
289 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
290 pub enum DependencyType {
291 /// Libraries originating from proc-macros.
293 /// Typical Rust libraries.
295 /// Non Rust libraries and objects shipped to ease usage of certain targets.
299 /// The various "modes" of invoking Cargo.
301 /// These entries currently correspond to the various output directories of the
302 /// build system, with each mod generating output in a different directory.
303 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
305 /// Build the standard library, placing output in the "stageN-std" directory.
308 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
311 /// Build a codegen backend for rustc, placing the output in the "stageN-codegen" directory.
314 /// Build a tool, placing output in the "stage0-bootstrap-tools"
315 /// directory. This is for miscellaneous sets of tools that are built
316 /// using the bootstrap stage0 compiler in its entirety (target libraries
317 /// and all). Typically these tools compile with stable Rust.
320 /// Build a tool which uses the locally built std, placing output in the
321 /// "stageN-tools" directory. Its usage is quite rare, mainly used by
322 /// compiletest which needs libtest.
325 /// Build a tool which uses the locally built rustc and the target std,
326 /// placing the output in the "stageN-tools" directory. This is used for
327 /// anything that needs a fully functional rustc, such as rustdoc, clippy,
328 /// cargo, rls, rustfmt, miri, etc.
333 pub fn is_tool(&self) -> bool {
334 matches!(self, Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd)
337 pub fn must_support_dlopen(&self) -> bool {
338 matches!(self, Mode::Std | Mode::Codegen)
348 /// Creates a new set of build configuration from the `flags` on the command
349 /// line and the filesystem `config`.
351 /// By default all build output will be placed in the current directory.
352 pub fn new(config: Config) -> Build {
353 let src = config.src.clone();
354 let out = config.out.clone();
356 let is_sudo = match env::var_os("SUDO_USER") {
357 Some(sudo_user) => match env::var_os("USER") {
358 Some(user) => user != sudo_user,
364 let ignore_git = config.ignore_git;
365 let rust_info = channel::GitInfo::new(ignore_git, &src);
366 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
367 let rls_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rls"));
368 let rust_analyzer_info =
369 channel::GitInfo::new(ignore_git, &src.join("src/tools/rust-analyzer"));
370 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
371 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
372 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
374 // we always try to use git for LLVM builds
375 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
377 let initial_target_libdir_str = if config.dry_run {
378 "/dummy/lib/path/to/lib/".to_string()
381 Command::new(&config.initial_rustc)
383 .arg(config.build.rustc_target_arg())
385 .arg("target-libdir"),
388 let initial_target_dir = Path::new(&initial_target_libdir_str).parent().unwrap();
389 let initial_lld = initial_target_dir.join("bin").join("rust-lld");
391 let initial_sysroot = if config.dry_run {
394 output(Command::new(&config.initial_rustc).arg("--print").arg("sysroot"))
396 let initial_libdir = initial_target_dir
401 .strip_prefix(initial_sysroot.trim())
405 let version = std::fs::read_to_string(src.join("src").join("version"))
406 .expect("failed to read src/version");
407 let version = version.trim();
409 let mut build = Build {
410 initial_rustc: config.initial_rustc.clone(),
411 initial_cargo: config.initial_cargo.clone(),
414 local_rebuild: config.local_rebuild,
415 fail_fast: config.cmd.fail_fast(),
416 doc_tests: config.cmd.doc_tests(),
417 verbosity: config.verbose,
420 hosts: config.hosts.clone(),
421 targets: config.targets.clone(),
424 version: version.to_string(),
439 ranlib: HashMap::new(),
440 crates: HashMap::new(),
442 ci_env: CiEnv::current(),
443 delayed_failures: RefCell::new(Vec::new()),
444 prerelease_version: Cell::new(None),
445 tool_artifacts: Default::default(),
448 build.verbose("finding compilers");
449 cc_detect::find(&mut build);
450 // When running `setup`, the profile is about to change, so any requirements we have now may
451 // be different on the next invocation. Don't check for them until the next time x.py is
452 // run. This is ok because `setup` never runs any build commands, so it won't fail if commands are missing.
453 if !matches!(build.config.cmd, Subcommand::Setup { .. }) {
454 build.verbose("running sanity check");
455 sanity::check(&mut build);
458 // If local-rust is the same major.minor as the current version, then force a
460 let local_version_verbose =
461 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
462 let local_release = local_version_verbose
464 .filter_map(|x| x.strip_prefix("release:"))
468 if local_release.split('.').take(2).eq(version.split('.').take(2)) {
469 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
470 build.local_rebuild = true;
473 build.verbose("learning about cargo");
474 metadata::build(&mut build);
479 // modified from `check_submodule` and `update_submodule` in bootstrap.py
480 /// Given a path to the directory of a submodule, update it.
482 /// `relative_path` should be relative to the root of the git repository, not an absolute path.
483 pub(crate) fn update_submodule(&self, relative_path: &Path) {
484 fn dir_is_empty(dir: &Path) -> bool {
485 t!(std::fs::read_dir(dir)).next().is_none()
488 if !self.config.submodules(&self.rust_info) {
492 let absolute_path = self.config.src.join(relative_path);
494 // NOTE: The check for the empty directory is here because when running x.py the first time,
495 // the submodule won't be checked out. Check it out now so we can build it.
496 if !channel::GitInfo::new(false, &absolute_path).is_git() && !dir_is_empty(&absolute_path) {
501 if self.config.fast_submodules {
502 let checked_out_hash = output(
503 Command::new("git").args(&["rev-parse", "HEAD"]).current_dir(&absolute_path),
506 let recorded = output(
508 .args(&["ls-tree", "HEAD"])
510 .current_dir(&self.config.src),
512 let actual_hash = recorded
515 .unwrap_or_else(|| panic!("unexpected output `{}`", recorded));
518 if actual_hash == checked_out_hash.trim_end() {
519 // already checked out
524 println!("Updating submodule {}", relative_path.display());
527 .args(&["submodule", "-q", "sync"])
529 .current_dir(&self.config.src),
532 // Try passing `--progress` to start, then run git again without if that fails.
533 let update = |progress: bool| {
534 let mut git = Command::new("git");
535 git.args(&["submodule", "update", "--init", "--recursive", "--depth=1"]);
537 git.arg("--progress");
539 git.arg(relative_path).current_dir(&self.config.src);
542 // NOTE: doesn't use `try_run` because this shouldn't print an error if it fails.
543 if !update(true).status().map_or(false, |status| status.success()) {
544 self.run(&mut update(false));
547 self.run(Command::new("git").args(&["reset", "-q", "--hard"]).current_dir(&absolute_path));
548 self.run(Command::new("git").args(&["clean", "-qdfx"]).current_dir(absolute_path));
551 /// If any submodule has been initialized already, sync it unconditionally.
552 /// This avoids contributors checking in a submodule change by accident.
553 pub fn maybe_update_submodules(&self) {
554 // WARNING: keep this in sync with the submodules hard-coded in bootstrap.py
555 const BOOTSTRAP_SUBMODULES: &[&str] = &[
556 "src/tools/rust-installer",
563 // Avoid running git when there isn't a git checkout.
564 if !self.config.submodules(&self.rust_info) {
569 .args(&["config", "--file"])
570 .arg(&self.config.src.join(".gitmodules"))
571 .args(&["--get-regexp", "path"]),
573 for line in output.lines() {
574 // Look for `submodule.$name.path = $path`
575 // Sample output: `submodule.src/rust-installer.path src/tools/rust-installer`
576 let submodule = Path::new(line.splitn(2, ' ').nth(1).unwrap());
577 // avoid updating submodules twice
578 if !BOOTSTRAP_SUBMODULES.iter().any(|&p| Path::new(p) == submodule)
579 && channel::GitInfo::new(false, submodule).is_git()
581 self.update_submodule(submodule);
586 /// Executes the entire build, as configured by the flags and configuration.
587 pub fn build(&mut self) {
592 self.maybe_update_submodules();
594 if let Subcommand::Format { check, paths } = &self.config.cmd {
595 return format::format(self, *check, &paths);
598 if let Subcommand::Clean { all } = self.config.cmd {
599 return clean::clean(self, all);
602 if let Subcommand::Setup { profile } = &self.config.cmd {
603 return setup::setup(&self.config.src, *profile);
607 let builder = builder::Builder::new(&self);
608 if let Some(path) = builder.paths.get(0) {
609 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
615 if !self.config.dry_run {
617 self.config.dry_run = true;
618 let builder = builder::Builder::new(&self);
619 builder.execute_cli();
621 self.config.dry_run = false;
622 let builder = builder::Builder::new(&self);
623 builder.execute_cli();
625 let builder = builder::Builder::new(&self);
626 builder.execute_cli();
629 // Check for postponed failures from `test --no-fail-fast`.
630 let failures = self.delayed_failures.borrow();
631 if failures.len() > 0 {
632 println!("\n{} command(s) did not execute successfully:\n", failures.len());
633 for failure in failures.iter() {
634 println!(" - {}\n", failure);
640 /// Clear out `dir` if `input` is newer.
642 /// After this executes, it will also ensure that `dir` exists.
643 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
644 let stamp = dir.join(".stamp");
645 let mut cleared = false;
646 if mtime(&stamp) < mtime(input) {
647 self.verbose(&format!("Dirty - {}", dir.display()));
648 let _ = fs::remove_dir_all(dir);
650 } else if stamp.exists() {
653 t!(fs::create_dir_all(dir));
654 t!(File::create(stamp));
658 /// Gets the space-separated set of activated features for the standard
660 fn std_features(&self, target: TargetSelection) -> String {
661 let mut features = "panic-unwind".to_string();
663 match self.config.llvm_libunwind {
664 LlvmLibunwind::InTree => features.push_str(" llvm-libunwind"),
665 LlvmLibunwind::System => features.push_str(" system-llvm-libunwind"),
666 LlvmLibunwind::No => {}
668 if self.config.backtrace {
669 features.push_str(" backtrace");
671 if self.config.profiler_enabled(target) {
672 features.push_str(" profiler");
677 /// Gets the space-separated set of activated features for the compiler.
678 fn rustc_features(&self, kind: Kind) -> String {
679 let mut features = String::new();
680 if self.config.jemalloc {
681 features.push_str("jemalloc");
683 if self.config.llvm_enabled() || kind == Kind::Check {
684 features.push_str(" llvm");
687 // If debug logging is on, then we want the default for tracing:
688 // https://github.com/tokio-rs/tracing/blob/3dd5c03d907afdf2c39444a29931833335171554/tracing/src/level_filters.rs#L26
689 // which is everything (including debug/trace/etc.)
690 // if its unset, if debug_assertions is on, then debug_logging will also be on
691 // as well as tracing *ignoring* this feature when debug_assertions is on
692 if !self.config.rust_debug_logging {
693 features.push_str(" max_level_info");
699 /// Component directory that Cargo will produce output into (e.g.
701 fn cargo_dir(&self) -> &'static str {
702 if self.config.rust_optimize { "release" } else { "debug" }
705 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
708 .join(&*compiler.host.triple)
709 .join(format!("stage{}-tools-bin", compiler.stage));
710 t!(fs::create_dir_all(&out));
714 /// Returns the root directory for all output generated in a particular
715 /// stage when running with a particular host compiler.
717 /// The mode indicates what the root directory is for.
718 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
719 let suffix = match mode {
721 Mode::Rustc => "-rustc",
722 Mode::Codegen => "-codegen",
723 Mode::ToolBootstrap => "-bootstrap-tools",
724 Mode::ToolStd | Mode::ToolRustc => "-tools",
726 self.out.join(&*compiler.host.triple).join(format!("stage{}{}", compiler.stage, suffix))
729 /// Returns the root output directory for all Cargo output in a given stage,
730 /// running a particular compiler, whether or not we're building the
731 /// standard library, and targeting the specified architecture.
732 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: TargetSelection) -> PathBuf {
733 self.stage_out(compiler, mode).join(&*target.triple).join(self.cargo_dir())
736 /// Root output directory for LLVM compiled for `target`
738 /// Note that if LLVM is configured externally then the directory returned
739 /// will likely be empty.
740 fn llvm_out(&self, target: TargetSelection) -> PathBuf {
741 self.out.join(&*target.triple).join("llvm")
744 fn lld_out(&self, target: TargetSelection) -> PathBuf {
745 self.out.join(&*target.triple).join("lld")
748 /// Output directory for all documentation for a target
749 fn doc_out(&self, target: TargetSelection) -> PathBuf {
750 self.out.join(&*target.triple).join("doc")
753 fn test_out(&self, target: TargetSelection) -> PathBuf {
754 self.out.join(&*target.triple).join("test")
757 /// Output directory for all documentation for a target
758 fn compiler_doc_out(&self, target: TargetSelection) -> PathBuf {
759 self.out.join(&*target.triple).join("compiler-doc")
762 /// Output directory for some generated md crate documentation for a target (temporary)
763 fn md_doc_out(&self, target: TargetSelection) -> Interned<PathBuf> {
764 INTERNER.intern_path(self.out.join(&*target.triple).join("md-doc"))
767 /// Returns `true` if no custom `llvm-config` is set for the specified target.
769 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
770 fn is_rust_llvm(&self, target: TargetSelection) -> bool {
771 if self.config.llvm_from_ci && target == self.config.build {
775 match self.config.target_config.get(&target) {
776 Some(ref c) => c.llvm_config.is_none(),
781 /// Returns the path to `FileCheck` binary for the specified target
782 fn llvm_filecheck(&self, target: TargetSelection) -> PathBuf {
783 let target_config = self.config.target_config.get(&target);
784 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
786 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
787 let llvm_bindir = output(Command::new(s).arg("--bindir"));
788 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", target));
789 if filecheck.exists() {
792 // On Fedora the system LLVM installs FileCheck in the
793 // llvm subdirectory of the libdir.
794 let llvm_libdir = output(Command::new(s).arg("--libdir"));
796 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", target));
797 if lib_filecheck.exists() {
800 // Return the most normal file name, even though
801 // it doesn't exist, so that any error message
807 let base = self.llvm_out(self.config.build).join("build");
808 let base = if !self.ninja() && self.config.build.contains("msvc") {
809 if self.config.llvm_optimize {
810 if self.config.llvm_release_debuginfo {
811 base.join("RelWithDebInfo")
821 base.join("bin").join(exe("FileCheck", target))
825 /// Directory for libraries built from C/C++ code and shared between stages.
826 fn native_dir(&self, target: TargetSelection) -> PathBuf {
827 self.out.join(&*target.triple).join("native")
830 /// Root output directory for rust_test_helpers library compiled for
832 fn test_helpers_out(&self, target: TargetSelection) -> PathBuf {
833 self.native_dir(target).join("rust-test-helpers")
836 /// Adds the `RUST_TEST_THREADS` env var if necessary
837 fn add_rust_test_threads(&self, cmd: &mut Command) {
838 if env::var_os("RUST_TEST_THREADS").is_none() {
839 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
843 /// Returns the libdir of the snapshot compiler.
844 fn rustc_snapshot_libdir(&self) -> PathBuf {
845 self.rustc_snapshot_sysroot().join(libdir(self.config.build))
848 /// Returns the sysroot of the snapshot compiler.
849 fn rustc_snapshot_sysroot(&self) -> &Path {
850 self.initial_rustc.parent().unwrap().parent().unwrap()
853 /// Runs a command, printing out nice contextual information if it fails.
854 fn run(&self, cmd: &mut Command) {
855 if self.config.dry_run {
858 self.verbose(&format!("running: {:?}", cmd));
859 run(cmd, self.is_verbose())
862 /// Runs a command, printing out nice contextual information if it fails.
863 fn run_quiet(&self, cmd: &mut Command) {
864 if self.config.dry_run {
867 self.verbose(&format!("running: {:?}", cmd));
871 /// Runs a command, printing out nice contextual information if it fails.
872 /// Exits if the command failed to execute at all, otherwise returns its
873 /// `status.success()`.
874 fn try_run(&self, cmd: &mut Command) -> bool {
875 if self.config.dry_run {
878 self.verbose(&format!("running: {:?}", cmd));
879 try_run(cmd, self.is_verbose())
882 /// Runs a command, printing out nice contextual information if it fails.
883 /// Exits if the command failed to execute at all, otherwise returns its
884 /// `status.success()`.
885 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
886 if self.config.dry_run {
889 self.verbose(&format!("running: {:?}", cmd));
890 try_run_suppressed(cmd)
893 pub fn is_verbose(&self) -> bool {
897 /// Prints a message if this build is configured in verbose mode.
898 fn verbose(&self, msg: &str) {
899 if self.is_verbose() {
904 pub fn is_verbose_than(&self, level: usize) -> bool {
905 self.verbosity > level
908 /// Prints a message if this build is configured in more verbose mode than `level`.
909 fn verbose_than(&self, level: usize, msg: &str) {
910 if self.is_verbose_than(level) {
915 fn info(&self, msg: &str) {
916 if self.config.dry_run {
922 /// Returns the number of parallel jobs that have been configured for this
924 fn jobs(&self) -> u32 {
925 self.config.jobs.unwrap_or_else(|| {
926 std::thread::available_parallelism().map_or(1, std::num::NonZeroUsize::get) as u32
930 fn debuginfo_map_to(&self, which: GitRepo) -> Option<String> {
931 if !self.config.rust_remap_debuginfo {
937 let sha = self.rust_sha().unwrap_or(&self.version);
938 Some(format!("/rustc/{}", sha))
940 GitRepo::Llvm => Some(String::from("/rustc/llvm")),
944 /// Returns the path to the C compiler for the target specified.
945 fn cc(&self, target: TargetSelection) -> &Path {
946 self.cc[&target].path()
949 /// Returns a list of flags to pass to the C compiler for the target
951 fn cflags(&self, target: TargetSelection, which: GitRepo, c: CLang) -> Vec<String> {
953 CLang::C => &self.cc[&target],
954 CLang::Cxx => &self.cxx[&target],
957 // Filter out -O and /O (the optimization flags) that we picked up from
958 // cc-rs because the build scripts will determine that for themselves.
962 .map(|s| s.to_string_lossy().into_owned())
963 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
964 .collect::<Vec<String>>();
966 // If we're compiling on macOS then we add a few unconditional flags
967 // indicating that we want libc++ (more filled out than libstdc++) and
968 // we want to compile for 10.7. This way we can ensure that
969 // LLVM/etc are all properly compiled.
970 if target.contains("apple-darwin") {
971 base.push("-stdlib=libc++".into());
974 // Work around an apparently bad MinGW / GCC optimization,
975 // See: https://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
976 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
977 if &*target.triple == "i686-pc-windows-gnu" {
978 base.push("-fno-omit-frame-pointer".into());
981 if let Some(map_to) = self.debuginfo_map_to(which) {
982 let map = format!("{}={}", self.src.display(), map_to);
983 let cc = self.cc(target);
984 if cc.ends_with("clang") || cc.ends_with("gcc") {
985 base.push(format!("-fdebug-prefix-map={}", map));
986 } else if cc.ends_with("clang-cl.exe") {
987 base.push("-Xclang".into());
988 base.push(format!("-fdebug-prefix-map={}", map));
994 /// Returns the path to the `ar` archive utility for the target specified.
995 fn ar(&self, target: TargetSelection) -> Option<&Path> {
996 self.ar.get(&target).map(|p| &**p)
999 /// Returns the path to the `ranlib` utility for the target specified.
1000 fn ranlib(&self, target: TargetSelection) -> Option<&Path> {
1001 self.ranlib.get(&target).map(|p| &**p)
1004 /// Returns the path to the C++ compiler for the target specified.
1005 fn cxx(&self, target: TargetSelection) -> Result<&Path, String> {
1006 match self.cxx.get(&target) {
1007 Some(p) => Ok(p.path()),
1009 Err(format!("target `{}` is not configured as a host, only as a target", target))
1014 /// Returns the path to the linker for the given target if it needs to be overridden.
1015 fn linker(&self, target: TargetSelection) -> Option<&Path> {
1016 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
1019 } else if target.contains("vxworks") {
1020 // need to use CXX compiler as linker to resolve the exception functions
1021 // that are only existed in CXX libraries
1022 Some(self.cxx[&target].path())
1023 } else if target != self.config.build
1024 && util::use_host_linker(target)
1025 && !target.contains("msvc")
1027 Some(self.cc(target))
1028 } else if self.config.use_lld && !self.is_fuse_ld_lld(target) && self.build == target {
1029 Some(&self.initial_lld)
1035 // LLD is used through `-fuse-ld=lld` rather than directly.
1036 // Only MSVC targets use LLD directly at the moment.
1037 fn is_fuse_ld_lld(&self, target: TargetSelection) -> bool {
1038 self.config.use_lld && !target.contains("msvc")
1041 fn lld_flags(&self, target: TargetSelection) -> impl Iterator<Item = String> {
1042 let mut options = [None, None];
1044 if self.config.use_lld {
1045 if self.is_fuse_ld_lld(target) {
1046 options[0] = Some("-Clink-arg=-fuse-ld=lld".to_string());
1049 let threads = if target.contains("windows") { "/threads:1" } else { "--threads=1" };
1050 options[1] = Some(format!("-Clink-arg=-Wl,{}", threads));
1053 IntoIterator::into_iter(options).flatten()
1056 /// Returns if this target should statically link the C runtime, if specified
1057 fn crt_static(&self, target: TargetSelection) -> Option<bool> {
1058 if target.contains("pc-windows-msvc") {
1061 self.config.target_config.get(&target).and_then(|t| t.crt_static)
1065 /// Returns the "musl root" for this `target`, if defined
1066 fn musl_root(&self, target: TargetSelection) -> Option<&Path> {
1070 .and_then(|t| t.musl_root.as_ref())
1071 .or_else(|| self.config.musl_root.as_ref())
1075 /// Returns the "musl libdir" for this `target`.
1076 fn musl_libdir(&self, target: TargetSelection) -> Option<PathBuf> {
1077 let t = self.config.target_config.get(&target)?;
1078 if let libdir @ Some(_) = &t.musl_libdir {
1079 return libdir.clone();
1081 self.musl_root(target).map(|root| root.join("lib"))
1084 /// Returns the sysroot for the wasi target, if defined
1085 fn wasi_root(&self, target: TargetSelection) -> Option<&Path> {
1086 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
1089 /// Returns `true` if this is a no-std `target`, if defined
1090 fn no_std(&self, target: TargetSelection) -> Option<bool> {
1091 self.config.target_config.get(&target).map(|t| t.no_std)
1094 /// Returns `true` if the target will be tested using the `remote-test-client`
1095 /// and `remote-test-server` binaries.
1096 fn remote_tested(&self, target: TargetSelection) -> bool {
1097 self.qemu_rootfs(target).is_some()
1098 || target.contains("android")
1099 || env::var_os("TEST_DEVICE_ADDR").is_some()
1102 /// Returns the root of the "rootfs" image that this target will be using,
1103 /// if one was configured.
1105 /// If `Some` is returned then that means that tests for this target are
1106 /// emulated with QEMU and binaries will need to be shipped to the emulator.
1107 fn qemu_rootfs(&self, target: TargetSelection) -> Option<&Path> {
1108 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
1111 /// Path to the python interpreter to use
1112 fn python(&self) -> &Path {
1113 self.config.python.as_ref().unwrap()
1116 /// Temporary directory that extended error information is emitted to.
1117 fn extended_error_dir(&self) -> PathBuf {
1118 self.out.join("tmp/extended-error-metadata")
1121 /// Tests whether the `compiler` compiling for `target` should be forced to
1122 /// use a stage1 compiler instead.
1124 /// Currently, by default, the build system does not perform a "full
1125 /// bootstrap" by default where we compile the compiler three times.
1126 /// Instead, we compile the compiler two times. The final stage (stage2)
1127 /// just copies the libraries from the previous stage, which is what this
1130 /// Here we return `true` if:
1132 /// * The build isn't performing a full bootstrap
1133 /// * The `compiler` is in the final stage, 2
1134 /// * We're not cross-compiling, so the artifacts are already available in
1137 /// When all of these conditions are met the build will lift artifacts from
1138 /// the previous stage forward.
1139 fn force_use_stage1(&self, compiler: Compiler, target: TargetSelection) -> bool {
1140 !self.config.full_bootstrap
1141 && compiler.stage >= 2
1142 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
1145 /// Given `num` in the form "a.b.c" return a "release string" which
1146 /// describes the release version number.
1148 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
1149 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
1150 fn release(&self, num: &str) -> String {
1151 match &self.config.channel[..] {
1152 "stable" => num.to_string(),
1154 if self.rust_info.is_git() && !self.config.ignore_git {
1155 format!("{}-beta.{}", num, self.beta_prerelease_version())
1157 format!("{}-beta", num)
1160 "nightly" => format!("{}-nightly", num),
1161 _ => format!("{}-dev", num),
1165 fn beta_prerelease_version(&self) -> u32 {
1166 if let Some(s) = self.prerelease_version.get() {
1170 // Figure out how many merge commits happened since we branched off master.
1171 // That's our beta number!
1172 // (Note that we use a `..` range, not the `...` symmetric difference.)
1178 .arg("refs/remotes/origin/master..HEAD")
1179 .current_dir(&self.src),
1181 let n = count.trim().parse().unwrap();
1182 self.prerelease_version.set(Some(n));
1186 /// Returns the value of `release` above for Rust itself.
1187 fn rust_release(&self) -> String {
1188 self.release(&self.version)
1191 /// Returns the "package version" for a component given the `num` release
1194 /// The package version is typically what shows up in the names of tarballs.
1195 /// For channels like beta/nightly it's just the channel name, otherwise
1196 /// it's the `num` provided.
1197 fn package_vers(&self, num: &str) -> String {
1198 match &self.config.channel[..] {
1199 "stable" => num.to_string(),
1200 "beta" => "beta".to_string(),
1201 "nightly" => "nightly".to_string(),
1202 _ => format!("{}-dev", num),
1206 /// Returns the value of `package_vers` above for Rust itself.
1207 fn rust_package_vers(&self) -> String {
1208 self.package_vers(&self.version)
1211 fn llvm_link_tools_dynamically(&self, target: TargetSelection) -> bool {
1212 target.contains("linux-gnu") || target.contains("apple-darwin")
1215 /// Returns the `version` string associated with this compiler for Rust
1218 /// Note that this is a descriptive string which includes the commit date,
1219 /// sha, version, etc.
1220 fn rust_version(&self) -> String {
1221 let mut version = self.rust_info.version(self, &self.version);
1222 if let Some(ref s) = self.config.description {
1223 version.push_str(" (");
1224 version.push_str(s);
1230 /// Returns the full commit hash.
1231 fn rust_sha(&self) -> Option<&str> {
1232 self.rust_info.sha()
1235 /// Returns the `a.b.c` version that the given package is at.
1236 fn release_num(&self, package: &str) -> String {
1237 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1238 let toml = t!(fs::read_to_string(&toml_file_name));
1239 for line in toml.lines() {
1240 if let Some(stripped) =
1241 line.strip_prefix("version = \"").and_then(|s| s.strip_suffix("\""))
1243 return stripped.to_owned();
1247 panic!("failed to find version in {}'s Cargo.toml", package)
1250 /// Returns `true` if unstable features should be enabled for the compiler
1252 fn unstable_features(&self) -> bool {
1253 match &self.config.channel[..] {
1254 "stable" | "beta" => false,
1255 "nightly" | _ => true,
1259 /// Returns a Vec of all the dependencies of the given root crate,
1260 /// including transitive dependencies and the root itself. Only includes
1261 /// "local" crates (those in the local source tree, not from a registry).
1262 fn in_tree_crates(&self, root: &str, target: Option<TargetSelection>) -> Vec<&Crate> {
1263 let mut ret = Vec::new();
1264 let mut list = vec![INTERNER.intern_str(root)];
1265 let mut visited = HashSet::new();
1266 while let Some(krate) = list.pop() {
1267 let krate = &self.crates[&krate];
1269 for dep in &krate.deps {
1270 if !self.crates.contains_key(dep) {
1271 // Ignore non-workspace members.
1274 // Don't include optional deps if their features are not
1275 // enabled. Ideally this would be computed from `cargo
1276 // metadata --features …`, but that is somewhat slow. Just
1277 // skip `build_helper` since there aren't any operations we
1278 // want to perform on it. In the future, we may want to
1279 // consider just filtering all build and dev dependencies in
1281 if visited.insert(dep)
1282 && dep != "build_helper"
1283 && (dep != "profiler_builtins"
1285 .map(|t| self.config.profiler_enabled(t))
1286 .unwrap_or_else(|| self.config.any_profiler_enabled()))
1287 && (dep != "rustc_codegen_llvm" || self.config.llvm_enabled())
1296 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, DependencyType)> {
1297 if self.config.dry_run {
1301 let mut paths = Vec::new();
1302 let contents = t!(fs::read(stamp), &stamp);
1303 // This is the method we use for extracting paths from the stamp file passed to us. See
1304 // run_cargo for more information (in compile.rs).
1305 for part in contents.split(|b| *b == 0) {
1306 if part.is_empty() {
1309 let dependency_type = match part[0] as char {
1310 'h' => DependencyType::Host,
1311 's' => DependencyType::TargetSelfContained,
1312 't' => DependencyType::Target,
1313 _ => unreachable!(),
1315 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1316 paths.push((path, dependency_type));
1321 /// Copies a file from `src` to `dst`
1322 pub fn copy(&self, src: &Path, dst: &Path) {
1323 if self.config.dry_run {
1326 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1330 let _ = fs::remove_file(&dst);
1331 let metadata = t!(src.symlink_metadata());
1332 if metadata.file_type().is_symlink() {
1333 let link = t!(fs::read_link(src));
1334 t!(symlink_file(link, dst));
1335 } else if let Ok(()) = fs::hard_link(src, dst) {
1336 // Attempt to "easy copy" by creating a hard link
1337 // (symlinks don't work on windows), but if that fails
1338 // just fall back to a slow `copy` operation.
1340 if let Err(e) = fs::copy(src, dst) {
1341 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1343 t!(fs::set_permissions(dst, metadata.permissions()));
1344 let atime = FileTime::from_last_access_time(&metadata);
1345 let mtime = FileTime::from_last_modification_time(&metadata);
1346 t!(filetime::set_file_times(dst, atime, mtime));
1350 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1351 /// when this function is called.
1352 pub fn cp_r(&self, src: &Path, dst: &Path) {
1353 if self.config.dry_run {
1356 for f in self.read_dir(src) {
1357 let path = f.path();
1358 let name = path.file_name().unwrap();
1359 let dst = dst.join(name);
1360 if t!(f.file_type()).is_dir() {
1361 t!(fs::create_dir_all(&dst));
1362 self.cp_r(&path, &dst);
1364 let _ = fs::remove_file(&dst);
1365 self.copy(&path, &dst);
1370 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1371 /// when this function is called. Unwanted files or directories can be skipped
1372 /// by returning `false` from the filter function.
1373 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1374 // Immediately recurse with an empty relative path
1375 self.recurse_(src, dst, Path::new(""), filter)
1378 // Inner function does the actual work
1379 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1380 for f in self.read_dir(src) {
1381 let path = f.path();
1382 let name = path.file_name().unwrap();
1383 let dst = dst.join(name);
1384 let relative = relative.join(name);
1385 // Only copy file or directory if the filter function returns true
1386 if filter(&relative) {
1387 if t!(f.file_type()).is_dir() {
1388 let _ = fs::remove_dir_all(&dst);
1389 self.create_dir(&dst);
1390 self.recurse_(&path, &dst, &relative, filter);
1392 let _ = fs::remove_file(&dst);
1393 self.copy(&path, &dst);
1399 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1400 let file_name = src.file_name().unwrap();
1401 let dest = dest_folder.join(file_name);
1402 self.copy(src, &dest);
1405 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1406 if self.config.dry_run {
1409 let dst = dstdir.join(src.file_name().unwrap());
1410 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1411 t!(fs::create_dir_all(dstdir));
1412 drop(fs::remove_file(&dst));
1415 panic!("Error: File \"{}\" not found!", src.display());
1417 let metadata = t!(src.symlink_metadata());
1418 if let Err(e) = fs::copy(&src, &dst) {
1419 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1421 t!(fs::set_permissions(&dst, metadata.permissions()));
1422 let atime = FileTime::from_last_access_time(&metadata);
1423 let mtime = FileTime::from_last_modification_time(&metadata);
1424 t!(filetime::set_file_times(&dst, atime, mtime));
1429 fn create(&self, path: &Path, s: &str) {
1430 if self.config.dry_run {
1433 t!(fs::write(path, s));
1436 fn read(&self, path: &Path) -> String {
1437 if self.config.dry_run {
1438 return String::new();
1440 t!(fs::read_to_string(path))
1443 fn create_dir(&self, dir: &Path) {
1444 if self.config.dry_run {
1447 t!(fs::create_dir_all(dir))
1450 fn remove_dir(&self, dir: &Path) {
1451 if self.config.dry_run {
1454 t!(fs::remove_dir_all(dir))
1457 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1458 let iter = match fs::read_dir(dir) {
1460 Err(_) if self.config.dry_run => return vec![].into_iter(),
1461 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1463 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1466 fn remove(&self, f: &Path) {
1467 if self.config.dry_run {
1470 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1473 /// Returns if config.ninja is enabled, and checks for ninja existence,
1474 /// exiting with a nicer error message if not.
1475 fn ninja(&self) -> bool {
1476 let mut cmd_finder = crate::sanity::Finder::new();
1478 if self.config.ninja_in_file {
1479 // Some Linux distros rename `ninja` to `ninja-build`.
1480 // CMake can work with either binary name.
1481 if cmd_finder.maybe_have("ninja-build").is_none()
1482 && cmd_finder.maybe_have("ninja").is_none()
1486 Couldn't find required command: ninja (or ninja-build)
1488 You should install ninja as described at
1489 <https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages>,
1490 or set `ninja = false` in the `[llvm]` section of `config.toml`.
1491 Alternatively, set `download-ci-llvm = true` in that `[llvm]` section
1492 to download LLVM rather than building it.
1495 std::process::exit(1);
1499 // If ninja isn't enabled but we're building for MSVC then we try
1500 // doubly hard to enable it. It was realized in #43767 that the msbuild
1501 // CMake generator for MSVC doesn't respect configuration options like
1502 // disabling LLVM assertions, which can often be quite important!
1504 // In these cases we automatically enable Ninja if we find it in the
1506 if !self.config.ninja_in_file && self.config.build.contains("msvc") {
1507 if cmd_finder.maybe_have("ninja").is_some() {
1512 self.config.ninja_in_file
1517 fn chmod(path: &Path, perms: u32) {
1518 use std::os::unix::fs::*;
1519 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1522 fn chmod(_path: &Path, _perms: u32) {}
1525 pub fn with_stage(mut self, stage: u32) -> Compiler {
1530 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1531 pub fn is_snapshot(&self, build: &Build) -> bool {
1532 self.stage == 0 && self.host == build.build
1535 /// Returns if this compiler should be treated as a final stage one in the
1536 /// current build session.
1537 /// This takes into account whether we're performing a full bootstrap or
1538 /// not; don't directly compare the stage with `2`!
1539 pub fn is_final_stage(&self, build: &Build) -> bool {
1540 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1541 self.stage >= final_stage
1545 fn envify(s: &str) -> String {
1551 .flat_map(|c| c.to_uppercase())