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-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
180 "llvm-dis", // used to disassemble LLVM bitcode
181 "llc", // used to compile LLVM bytecode
182 "opt", // used to optimize LLVM bytecode
185 pub const VERSION: usize = 2;
187 /// A structure representing a Rust compiler.
189 /// Each compiler has a `stage` that it is associated with and a `host` that
190 /// corresponds to the platform the compiler runs on. This structure is used as
191 /// a parameter to many methods below.
192 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
193 pub struct Compiler {
195 host: TargetSelection,
198 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
200 /// Run normal tests and doc tests (default).
202 /// Do not run any doc tests.
204 /// Only run doc tests.
213 /// Global configuration for the build system.
215 /// This structure transitively contains all configuration for the build system.
216 /// All filesystem-encoded configuration is in `config`, all flags are in
217 /// `flags`, and then parsed or probed information is listed in the keys below.
219 /// This structure is a parameter of almost all methods in the build system,
220 /// although most functions are implemented as free functions rather than
221 /// methods specifically on this structure itself (to make it easier to
224 /// User-specified configuration from `config.toml`.
227 // Version information
230 // Properties derived from the above configuration
233 rust_info: channel::GitInfo,
234 cargo_info: channel::GitInfo,
235 rls_info: channel::GitInfo,
236 rust_analyzer_info: channel::GitInfo,
237 clippy_info: channel::GitInfo,
238 miri_info: channel::GitInfo,
239 rustfmt_info: channel::GitInfo,
240 in_tree_llvm_info: channel::GitInfo,
246 // Targets for which to build
247 build: TargetSelection,
248 hosts: Vec<TargetSelection>,
249 targets: Vec<TargetSelection>,
251 // Stage 0 (downloaded) compiler, lld and cargo or their local rust equivalents
252 initial_rustc: PathBuf,
253 initial_cargo: PathBuf,
254 initial_lld: PathBuf,
255 initial_libdir: PathBuf,
257 // Runtime state filled in later on
258 // C/C++ compilers and archiver for all targets
259 cc: HashMap<TargetSelection, cc::Tool>,
260 cxx: HashMap<TargetSelection, cc::Tool>,
261 ar: HashMap<TargetSelection, PathBuf>,
262 ranlib: HashMap<TargetSelection, PathBuf>,
264 crates: HashMap<Interned<String>, Crate>,
267 delayed_failures: RefCell<Vec<String>>,
268 prerelease_version: Cell<Option<u32>>,
270 RefCell<HashMap<TargetSelection, HashMap<String, (&'static str, PathBuf, Vec<String>)>>>,
275 name: Interned<String>,
276 deps: HashSet<Interned<String>>,
282 fn local_path(&self, build: &Build) -> PathBuf {
283 self.path.strip_prefix(&build.config.src).unwrap().into()
287 /// When building Rust various objects are handled differently.
288 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
289 pub enum DependencyType {
290 /// Libraries originating from proc-macros.
292 /// Typical Rust libraries.
294 /// Non Rust libraries and objects shipped to ease usage of certain targets.
298 /// The various "modes" of invoking Cargo.
300 /// These entries currently correspond to the various output directories of the
301 /// build system, with each mod generating output in a different directory.
302 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
304 /// Build the standard library, placing output in the "stageN-std" directory.
307 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
310 /// Build a codegen backend for rustc, placing the output in the "stageN-codegen" directory.
313 /// Build a tool, placing output in the "stage0-bootstrap-tools"
314 /// directory. This is for miscellaneous sets of tools that are built
315 /// using the bootstrap stage0 compiler in its entirety (target libraries
316 /// and all). Typically these tools compile with stable Rust.
319 /// Build a tool which uses the locally built std, placing output in the
320 /// "stageN-tools" directory. Its usage is quite rare, mainly used by
321 /// compiletest which needs libtest.
324 /// Build a tool which uses the locally built rustc and the target std,
325 /// placing the output in the "stageN-tools" directory. This is used for
326 /// anything that needs a fully functional rustc, such as rustdoc, clippy,
327 /// cargo, rls, rustfmt, miri, etc.
332 pub fn is_tool(&self) -> bool {
333 matches!(self, Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd)
338 /// Creates a new set of build configuration from the `flags` on the command
339 /// line and the filesystem `config`.
341 /// By default all build output will be placed in the current directory.
342 pub fn new(config: Config) -> Build {
343 let src = config.src.clone();
344 let out = config.out.clone();
346 let is_sudo = match env::var_os("SUDO_USER") {
347 Some(sudo_user) => match env::var_os("USER") {
348 Some(user) => user != sudo_user,
354 let ignore_git = config.ignore_git;
355 let rust_info = channel::GitInfo::new(ignore_git, &src);
356 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
357 let rls_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rls"));
358 let rust_analyzer_info =
359 channel::GitInfo::new(ignore_git, &src.join("src/tools/rust-analyzer"));
360 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
361 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
362 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
364 // we always try to use git for LLVM builds
365 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
367 let initial_target_libdir_str = if config.dry_run {
368 "/dummy/lib/path/to/lib/".to_string()
371 Command::new(&config.initial_rustc)
373 .arg(config.build.rustc_target_arg())
375 .arg("target-libdir"),
378 let initial_target_dir = Path::new(&initial_target_libdir_str).parent().unwrap();
379 let initial_lld = initial_target_dir.join("bin").join("rust-lld");
381 let initial_sysroot = if config.dry_run {
384 output(Command::new(&config.initial_rustc).arg("--print").arg("sysroot"))
386 let initial_libdir = initial_target_dir
391 .strip_prefix(initial_sysroot.trim())
395 let version = std::fs::read_to_string(src.join("src").join("version"))
396 .expect("failed to read src/version");
397 let version = version.trim();
399 let mut build = Build {
400 initial_rustc: config.initial_rustc.clone(),
401 initial_cargo: config.initial_cargo.clone(),
404 local_rebuild: config.local_rebuild,
405 fail_fast: config.cmd.fail_fast(),
406 doc_tests: config.cmd.doc_tests(),
407 verbosity: config.verbose,
410 hosts: config.hosts.clone(),
411 targets: config.targets.clone(),
414 version: version.to_string(),
429 ranlib: HashMap::new(),
430 crates: HashMap::new(),
432 ci_env: CiEnv::current(),
433 delayed_failures: RefCell::new(Vec::new()),
434 prerelease_version: Cell::new(None),
435 tool_artifacts: Default::default(),
438 build.verbose("finding compilers");
439 cc_detect::find(&mut build);
440 build.verbose("running sanity check");
441 sanity::check(&mut build);
443 // If local-rust is the same major.minor as the current version, then force a
445 let local_version_verbose =
446 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
447 let local_release = local_version_verbose
449 .filter_map(|x| x.strip_prefix("release:"))
453 if local_release.split('.').take(2).eq(version.split('.').take(2)) {
454 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
455 build.local_rebuild = true;
458 build.verbose("learning about cargo");
459 metadata::build(&mut build);
464 pub fn build_triple(&self) -> &[Interned<String>] {
465 slice::from_ref(&self.build.triple)
468 /// Executes the entire build, as configured by the flags and configuration.
469 pub fn build(&mut self) {
474 if let Subcommand::Format { check } = self.config.cmd {
475 return format::format(self, check);
478 if let Subcommand::Clean { all } = self.config.cmd {
479 return clean::clean(self, all);
482 if let Subcommand::Setup { profile } = &self.config.cmd {
483 return setup::setup(&self.config.src, *profile);
487 let builder = builder::Builder::new(&self);
488 if let Some(path) = builder.paths.get(0) {
489 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
495 if !self.config.dry_run {
497 self.config.dry_run = true;
498 let builder = builder::Builder::new(&self);
499 builder.execute_cli();
501 self.config.dry_run = false;
502 let builder = builder::Builder::new(&self);
503 builder.execute_cli();
505 let builder = builder::Builder::new(&self);
506 builder.execute_cli();
509 // Check for postponed failures from `test --no-fail-fast`.
510 let failures = self.delayed_failures.borrow();
511 if failures.len() > 0 {
512 println!("\n{} command(s) did not execute successfully:\n", failures.len());
513 for failure in failures.iter() {
514 println!(" - {}\n", failure);
520 /// Clear out `dir` if `input` is newer.
522 /// After this executes, it will also ensure that `dir` exists.
523 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
524 let stamp = dir.join(".stamp");
525 let mut cleared = false;
526 if mtime(&stamp) < mtime(input) {
527 self.verbose(&format!("Dirty - {}", dir.display()));
528 let _ = fs::remove_dir_all(dir);
530 } else if stamp.exists() {
533 t!(fs::create_dir_all(dir));
534 t!(File::create(stamp));
538 /// Gets the space-separated set of activated features for the standard
540 fn std_features(&self) -> String {
541 let mut features = "panic-unwind".to_string();
543 match self.config.llvm_libunwind.unwrap_or_default() {
544 LlvmLibunwind::InTree => features.push_str(" llvm-libunwind"),
545 LlvmLibunwind::System => features.push_str(" system-llvm-libunwind"),
546 LlvmLibunwind::No => {}
548 if self.config.backtrace {
549 features.push_str(" backtrace");
551 if self.config.profiler {
552 features.push_str(" profiler");
557 /// Gets the space-separated set of activated features for the compiler.
558 fn rustc_features(&self) -> String {
559 let mut features = String::new();
560 if self.config.jemalloc {
561 features.push_str("jemalloc");
563 if self.config.llvm_enabled() {
564 features.push_str(" llvm");
567 // If debug logging is on, then we want the default for tracing:
568 // https://github.com/tokio-rs/tracing/blob/3dd5c03d907afdf2c39444a29931833335171554/tracing/src/level_filters.rs#L26
569 // which is everything (including debug/trace/etc.)
570 // if its unset, if debug_assertions is on, then debug_logging will also be on
571 // as well as tracing *ignoring* this feature when debug_assertions is on
572 if !self.config.rust_debug_logging {
573 features.push_str(" max_level_info");
579 /// Component directory that Cargo will produce output into (e.g.
581 fn cargo_dir(&self) -> &'static str {
582 if self.config.rust_optimize { "release" } else { "debug" }
585 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
588 .join(&*compiler.host.triple)
589 .join(format!("stage{}-tools-bin", compiler.stage));
590 t!(fs::create_dir_all(&out));
594 /// Returns the root directory for all output generated in a particular
595 /// stage when running with a particular host compiler.
597 /// The mode indicates what the root directory is for.
598 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
599 let suffix = match mode {
601 Mode::Rustc => "-rustc",
602 Mode::Codegen => "-codegen",
603 Mode::ToolBootstrap => "-bootstrap-tools",
604 Mode::ToolStd | Mode::ToolRustc => "-tools",
606 self.out.join(&*compiler.host.triple).join(format!("stage{}{}", compiler.stage, suffix))
609 /// Returns the root output directory for all Cargo output in a given stage,
610 /// running a particular compiler, whether or not we're building the
611 /// standard library, and targeting the specified architecture.
612 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: TargetSelection) -> PathBuf {
613 self.stage_out(compiler, mode).join(&*target.triple).join(self.cargo_dir())
616 /// Root output directory for LLVM compiled for `target`
618 /// Note that if LLVM is configured externally then the directory returned
619 /// will likely be empty.
620 fn llvm_out(&self, target: TargetSelection) -> PathBuf {
621 self.out.join(&*target.triple).join("llvm")
624 fn lld_out(&self, target: TargetSelection) -> PathBuf {
625 self.out.join(&*target.triple).join("lld")
628 /// Output directory for all documentation for a target
629 fn doc_out(&self, target: TargetSelection) -> PathBuf {
630 self.out.join(&*target.triple).join("doc")
633 /// Output directory for all documentation for a target
634 fn compiler_doc_out(&self, target: TargetSelection) -> PathBuf {
635 self.out.join(&*target.triple).join("compiler-doc")
638 /// Output directory for some generated md crate documentation for a target (temporary)
639 fn md_doc_out(&self, target: TargetSelection) -> Interned<PathBuf> {
640 INTERNER.intern_path(self.out.join(&*target.triple).join("md-doc"))
643 /// Returns `true` if no custom `llvm-config` is set for the specified target.
645 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
646 fn is_rust_llvm(&self, target: TargetSelection) -> bool {
647 if self.config.llvm_from_ci && target == self.config.build {
651 match self.config.target_config.get(&target) {
652 Some(ref c) => c.llvm_config.is_none(),
657 /// Returns the path to `FileCheck` binary for the specified target
658 fn llvm_filecheck(&self, target: TargetSelection) -> PathBuf {
659 let target_config = self.config.target_config.get(&target);
660 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
662 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
663 let llvm_bindir = output(Command::new(s).arg("--bindir"));
664 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", target));
665 if filecheck.exists() {
668 // On Fedora the system LLVM installs FileCheck in the
669 // llvm subdirectory of the libdir.
670 let llvm_libdir = output(Command::new(s).arg("--libdir"));
672 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", target));
673 if lib_filecheck.exists() {
676 // Return the most normal file name, even though
677 // it doesn't exist, so that any error message
683 let base = self.llvm_out(self.config.build).join("build");
684 let base = if !self.ninja() && self.config.build.contains("msvc") {
685 if self.config.llvm_optimize {
686 if self.config.llvm_release_debuginfo {
687 base.join("RelWithDebInfo")
697 base.join("bin").join(exe("FileCheck", target))
701 /// Directory for libraries built from C/C++ code and shared between stages.
702 fn native_dir(&self, target: TargetSelection) -> PathBuf {
703 self.out.join(&*target.triple).join("native")
706 /// Root output directory for rust_test_helpers library compiled for
708 fn test_helpers_out(&self, target: TargetSelection) -> PathBuf {
709 self.native_dir(target).join("rust-test-helpers")
712 /// Adds the `RUST_TEST_THREADS` env var if necessary
713 fn add_rust_test_threads(&self, cmd: &mut Command) {
714 if env::var_os("RUST_TEST_THREADS").is_none() {
715 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
719 /// Returns the libdir of the snapshot compiler.
720 fn rustc_snapshot_libdir(&self) -> PathBuf {
721 self.rustc_snapshot_sysroot().join(libdir(self.config.build))
724 /// Returns the sysroot of the snapshot compiler.
725 fn rustc_snapshot_sysroot(&self) -> &Path {
726 self.initial_rustc.parent().unwrap().parent().unwrap()
729 /// Runs a command, printing out nice contextual information if it fails.
730 fn run(&self, cmd: &mut Command) {
731 if self.config.dry_run {
734 self.verbose(&format!("running: {:?}", cmd));
738 /// Runs a command, printing out nice contextual information if it fails.
739 fn run_quiet(&self, cmd: &mut Command) {
740 if self.config.dry_run {
743 self.verbose(&format!("running: {:?}", cmd));
747 /// Runs a command, printing out nice contextual information if it fails.
748 /// Exits if the command failed to execute at all, otherwise returns its
749 /// `status.success()`.
750 fn try_run(&self, cmd: &mut Command) -> bool {
751 if self.config.dry_run {
754 self.verbose(&format!("running: {:?}", cmd));
758 /// Runs a command, printing out nice contextual information if it fails.
759 /// Exits if the command failed to execute at all, otherwise returns its
760 /// `status.success()`.
761 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
762 if self.config.dry_run {
765 self.verbose(&format!("running: {:?}", cmd));
766 try_run_suppressed(cmd)
769 pub fn is_verbose(&self) -> bool {
773 /// Prints a message if this build is configured in verbose mode.
774 fn verbose(&self, msg: &str) {
775 if self.is_verbose() {
780 pub fn is_verbose_than(&self, level: usize) -> bool {
781 self.verbosity > level
784 /// Prints a message if this build is configured in more verbose mode than `level`.
785 fn verbose_than(&self, level: usize, msg: &str) {
786 if self.is_verbose_than(level) {
791 fn info(&self, msg: &str) {
792 if self.config.dry_run {
798 /// Returns the number of parallel jobs that have been configured for this
800 fn jobs(&self) -> u32 {
801 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
804 fn debuginfo_map_to(&self, which: GitRepo) -> Option<String> {
805 if !self.config.rust_remap_debuginfo {
811 let sha = self.rust_sha().unwrap_or(&self.version);
812 Some(format!("/rustc/{}", sha))
814 GitRepo::Llvm => Some(String::from("/rustc/llvm")),
818 /// Returns the path to the C compiler for the target specified.
819 fn cc(&self, target: TargetSelection) -> &Path {
820 self.cc[&target].path()
823 /// Returns a list of flags to pass to the C compiler for the target
825 fn cflags(&self, target: TargetSelection, which: GitRepo) -> Vec<String> {
826 // Filter out -O and /O (the optimization flags) that we picked up from
827 // cc-rs because the build scripts will determine that for themselves.
828 let mut base = self.cc[&target]
831 .map(|s| s.to_string_lossy().into_owned())
832 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
833 .collect::<Vec<String>>();
835 // If we're compiling on macOS then we add a few unconditional flags
836 // indicating that we want libc++ (more filled out than libstdc++) and
837 // we want to compile for 10.7. This way we can ensure that
838 // LLVM/etc are all properly compiled.
839 if target.contains("apple-darwin") {
840 base.push("-stdlib=libc++".into());
843 // Work around an apparently bad MinGW / GCC optimization,
844 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
845 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
846 if &*target.triple == "i686-pc-windows-gnu" {
847 base.push("-fno-omit-frame-pointer".into());
850 if let Some(map_to) = self.debuginfo_map_to(which) {
851 let map = format!("{}={}", self.src.display(), map_to);
852 let cc = self.cc(target);
853 if cc.ends_with("clang") || cc.ends_with("gcc") {
854 base.push(format!("-fdebug-prefix-map={}", map));
855 } else if cc.ends_with("clang-cl.exe") {
856 base.push("-Xclang".into());
857 base.push(format!("-fdebug-prefix-map={}", map));
863 /// Returns the path to the `ar` archive utility for the target specified.
864 fn ar(&self, target: TargetSelection) -> Option<&Path> {
865 self.ar.get(&target).map(|p| &**p)
868 /// Returns the path to the `ranlib` utility for the target specified.
869 fn ranlib(&self, target: TargetSelection) -> Option<&Path> {
870 self.ranlib.get(&target).map(|p| &**p)
873 /// Returns the path to the C++ compiler for the target specified.
874 fn cxx(&self, target: TargetSelection) -> Result<&Path, String> {
875 match self.cxx.get(&target) {
876 Some(p) => Ok(p.path()),
878 Err(format!("target `{}` is not configured as a host, only as a target", target))
883 /// Returns the path to the linker for the given target if it needs to be overridden.
884 fn linker(&self, target: TargetSelection) -> Option<&Path> {
885 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
888 } else if target.contains("vxworks") {
889 // need to use CXX compiler as linker to resolve the exception functions
890 // that are only existed in CXX libraries
891 Some(self.cxx[&target].path())
892 } else if target != self.config.build
893 && util::use_host_linker(target)
894 && !target.contains("msvc")
896 Some(self.cc(target))
897 } else if self.config.use_lld && !self.is_fuse_ld_lld(target) && self.build == target {
898 Some(&self.initial_lld)
904 // LLD is used through `-fuse-ld=lld` rather than directly.
905 // Only MSVC targets use LLD directly at the moment.
906 fn is_fuse_ld_lld(&self, target: TargetSelection) -> bool {
907 self.config.use_lld && !target.contains("msvc")
910 /// Returns if this target should statically link the C runtime, if specified
911 fn crt_static(&self, target: TargetSelection) -> Option<bool> {
912 if target.contains("pc-windows-msvc") {
915 self.config.target_config.get(&target).and_then(|t| t.crt_static)
919 /// Returns the "musl root" for this `target`, if defined
920 fn musl_root(&self, target: TargetSelection) -> Option<&Path> {
924 .and_then(|t| t.musl_root.as_ref())
925 .or_else(|| self.config.musl_root.as_ref())
929 /// Returns the "musl libdir" for this `target`.
930 fn musl_libdir(&self, target: TargetSelection) -> Option<PathBuf> {
931 let t = self.config.target_config.get(&target)?;
932 if let libdir @ Some(_) = &t.musl_libdir {
933 return libdir.clone();
935 self.musl_root(target).map(|root| root.join("lib"))
938 /// Returns the sysroot for the wasi target, if defined
939 fn wasi_root(&self, target: TargetSelection) -> Option<&Path> {
940 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
943 /// Returns `true` if this is a no-std `target`, if defined
944 fn no_std(&self, target: TargetSelection) -> Option<bool> {
945 self.config.target_config.get(&target).map(|t| t.no_std)
948 /// Returns `true` if the target will be tested using the `remote-test-client`
949 /// and `remote-test-server` binaries.
950 fn remote_tested(&self, target: TargetSelection) -> bool {
951 self.qemu_rootfs(target).is_some()
952 || target.contains("android")
953 || env::var_os("TEST_DEVICE_ADDR").is_some()
956 /// Returns the root of the "rootfs" image that this target will be using,
957 /// if one was configured.
959 /// If `Some` is returned then that means that tests for this target are
960 /// emulated with QEMU and binaries will need to be shipped to the emulator.
961 fn qemu_rootfs(&self, target: TargetSelection) -> Option<&Path> {
962 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
965 /// Path to the python interpreter to use
966 fn python(&self) -> &Path {
967 self.config.python.as_ref().unwrap()
970 /// Temporary directory that extended error information is emitted to.
971 fn extended_error_dir(&self) -> PathBuf {
972 self.out.join("tmp/extended-error-metadata")
975 /// Tests whether the `compiler` compiling for `target` should be forced to
976 /// use a stage1 compiler instead.
978 /// Currently, by default, the build system does not perform a "full
979 /// bootstrap" by default where we compile the compiler three times.
980 /// Instead, we compile the compiler two times. The final stage (stage2)
981 /// just copies the libraries from the previous stage, which is what this
984 /// Here we return `true` if:
986 /// * The build isn't performing a full bootstrap
987 /// * The `compiler` is in the final stage, 2
988 /// * We're not cross-compiling, so the artifacts are already available in
991 /// When all of these conditions are met the build will lift artifacts from
992 /// the previous stage forward.
993 fn force_use_stage1(&self, compiler: Compiler, target: TargetSelection) -> bool {
994 !self.config.full_bootstrap
995 && compiler.stage >= 2
996 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
999 /// Given `num` in the form "a.b.c" return a "release string" which
1000 /// describes the release version number.
1002 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
1003 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
1004 fn release(&self, num: &str) -> String {
1005 match &self.config.channel[..] {
1006 "stable" => num.to_string(),
1008 if self.rust_info.is_git() {
1009 format!("{}-beta.{}", num, self.beta_prerelease_version())
1011 format!("{}-beta", num)
1014 "nightly" => format!("{}-nightly", num),
1015 _ => format!("{}-dev", num),
1019 fn beta_prerelease_version(&self) -> u32 {
1020 if let Some(s) = self.prerelease_version.get() {
1024 // Figure out how many merge commits happened since we branched off master.
1025 // That's our beta number!
1026 // (Note that we use a `..` range, not the `...` symmetric difference.)
1032 .arg("refs/remotes/origin/master..HEAD")
1033 .current_dir(&self.src),
1035 let n = count.trim().parse().unwrap();
1036 self.prerelease_version.set(Some(n));
1040 /// Returns the value of `release` above for Rust itself.
1041 fn rust_release(&self) -> String {
1042 self.release(&self.version)
1045 /// Returns the "package version" for a component given the `num` release
1048 /// The package version is typically what shows up in the names of tarballs.
1049 /// For channels like beta/nightly it's just the channel name, otherwise
1050 /// it's the `num` provided.
1051 fn package_vers(&self, num: &str) -> String {
1052 match &self.config.channel[..] {
1053 "stable" => num.to_string(),
1054 "beta" => "beta".to_string(),
1055 "nightly" => "nightly".to_string(),
1056 _ => format!("{}-dev", num),
1060 /// Returns the value of `package_vers` above for Rust itself.
1061 fn rust_package_vers(&self) -> String {
1062 self.package_vers(&self.version)
1065 fn llvm_tools_vers(&self) -> String {
1069 fn llvm_link_tools_dynamically(&self, target: TargetSelection) -> bool {
1070 target.contains("linux-gnu") || target.contains("apple-darwin")
1073 /// Returns the `version` string associated with this compiler for Rust
1076 /// Note that this is a descriptive string which includes the commit date,
1077 /// sha, version, etc.
1078 fn rust_version(&self) -> String {
1079 self.rust_info.version(self, &self.version)
1082 /// Returns the full commit hash.
1083 fn rust_sha(&self) -> Option<&str> {
1084 self.rust_info.sha()
1087 /// Returns the `a.b.c` version that the given package is at.
1088 fn release_num(&self, package: &str) -> String {
1089 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1090 let toml = t!(fs::read_to_string(&toml_file_name));
1091 for line in toml.lines() {
1092 if let Some(stripped) =
1093 line.strip_prefix("version = \"").and_then(|s| s.strip_suffix("\""))
1095 return stripped.to_owned();
1099 panic!("failed to find version in {}'s Cargo.toml", package)
1102 /// Returns `true` if unstable features should be enabled for the compiler
1104 fn unstable_features(&self) -> bool {
1105 match &self.config.channel[..] {
1106 "stable" | "beta" => false,
1107 "nightly" | _ => true,
1111 /// Returns a Vec of all the dependencies of the given root crate,
1112 /// including transitive dependencies and the root itself. Only includes
1113 /// "local" crates (those in the local source tree, not from a registry).
1114 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1115 let mut ret = Vec::new();
1116 let mut list = vec![INTERNER.intern_str(root)];
1117 let mut visited = HashSet::new();
1118 while let Some(krate) = list.pop() {
1119 let krate = &self.crates[&krate];
1121 for dep in &krate.deps {
1122 // Don't include optional deps if their features are not
1123 // enabled. Ideally this would be computed from `cargo
1124 // metadata --features …`, but that is somewhat slow. Just
1125 // skip `build_helper` since there aren't any operations we
1126 // want to perform on it. In the future, we may want to
1127 // consider just filtering all build and dev dependencies in
1129 if visited.insert(dep)
1130 && dep != "build_helper"
1131 && (dep != "profiler_builtins" || self.config.profiler)
1132 && (dep != "rustc_codegen_llvm" || self.config.llvm_enabled())
1141 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, DependencyType)> {
1142 if self.config.dry_run {
1146 let mut paths = Vec::new();
1147 let contents = t!(fs::read(stamp), &stamp);
1148 // This is the method we use for extracting paths from the stamp file passed to us. See
1149 // run_cargo for more information (in compile.rs).
1150 for part in contents.split(|b| *b == 0) {
1151 if part.is_empty() {
1154 let dependency_type = match part[0] as char {
1155 'h' => DependencyType::Host,
1156 's' => DependencyType::TargetSelfContained,
1157 't' => DependencyType::Target,
1158 _ => unreachable!(),
1160 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1161 paths.push((path, dependency_type));
1166 /// Copies a file from `src` to `dst`
1167 pub fn copy(&self, src: &Path, dst: &Path) {
1168 if self.config.dry_run {
1171 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1175 let _ = fs::remove_file(&dst);
1176 let metadata = t!(src.symlink_metadata());
1177 if metadata.file_type().is_symlink() {
1178 let link = t!(fs::read_link(src));
1179 t!(symlink_file(link, dst));
1180 } else if let Ok(()) = fs::hard_link(src, dst) {
1181 // Attempt to "easy copy" by creating a hard link
1182 // (symlinks don't work on windows), but if that fails
1183 // just fall back to a slow `copy` operation.
1185 if let Err(e) = fs::copy(src, dst) {
1186 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1188 t!(fs::set_permissions(dst, metadata.permissions()));
1189 let atime = FileTime::from_last_access_time(&metadata);
1190 let mtime = FileTime::from_last_modification_time(&metadata);
1191 t!(filetime::set_file_times(dst, atime, mtime));
1195 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1196 /// new string for each replacement.)
1197 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1198 if self.config.dry_run {
1201 let mut contents = String::new();
1202 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1203 t!(file.read_to_string(&mut contents));
1204 for &(target, replacement) in replacements {
1205 contents = contents.replace(target, replacement);
1207 t!(file.seek(SeekFrom::Start(0)));
1208 t!(file.set_len(0));
1209 t!(file.write_all(contents.as_bytes()));
1212 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1213 /// when this function is called.
1214 pub fn cp_r(&self, src: &Path, dst: &Path) {
1215 if self.config.dry_run {
1218 for f in self.read_dir(src) {
1219 let path = f.path();
1220 let name = path.file_name().unwrap();
1221 let dst = dst.join(name);
1222 if t!(f.file_type()).is_dir() {
1223 t!(fs::create_dir_all(&dst));
1224 self.cp_r(&path, &dst);
1226 let _ = fs::remove_file(&dst);
1227 self.copy(&path, &dst);
1232 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1233 /// when this function is called. Unwanted files or directories can be skipped
1234 /// by returning `false` from the filter function.
1235 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1236 // Immediately recurse with an empty relative path
1237 self.recurse_(src, dst, Path::new(""), filter)
1240 // Inner function does the actual work
1241 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1242 for f in self.read_dir(src) {
1243 let path = f.path();
1244 let name = path.file_name().unwrap();
1245 let dst = dst.join(name);
1246 let relative = relative.join(name);
1247 // Only copy file or directory if the filter function returns true
1248 if filter(&relative) {
1249 if t!(f.file_type()).is_dir() {
1250 let _ = fs::remove_dir_all(&dst);
1251 self.create_dir(&dst);
1252 self.recurse_(&path, &dst, &relative, filter);
1254 let _ = fs::remove_file(&dst);
1255 self.copy(&path, &dst);
1261 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1262 let file_name = src.file_name().unwrap();
1263 let dest = dest_folder.join(file_name);
1264 self.copy(src, &dest);
1267 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1268 if self.config.dry_run {
1271 let dst = dstdir.join(src.file_name().unwrap());
1272 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1273 t!(fs::create_dir_all(dstdir));
1274 drop(fs::remove_file(&dst));
1277 panic!("Error: File \"{}\" not found!", src.display());
1279 let metadata = t!(src.symlink_metadata());
1280 if let Err(e) = fs::copy(&src, &dst) {
1281 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1283 t!(fs::set_permissions(&dst, metadata.permissions()));
1284 let atime = FileTime::from_last_access_time(&metadata);
1285 let mtime = FileTime::from_last_modification_time(&metadata);
1286 t!(filetime::set_file_times(&dst, atime, mtime));
1291 fn create(&self, path: &Path, s: &str) {
1292 if self.config.dry_run {
1295 t!(fs::write(path, s));
1298 fn read(&self, path: &Path) -> String {
1299 if self.config.dry_run {
1300 return String::new();
1302 t!(fs::read_to_string(path))
1305 fn create_dir(&self, dir: &Path) {
1306 if self.config.dry_run {
1309 t!(fs::create_dir_all(dir))
1312 fn remove_dir(&self, dir: &Path) {
1313 if self.config.dry_run {
1316 t!(fs::remove_dir_all(dir))
1319 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1320 let iter = match fs::read_dir(dir) {
1322 Err(_) if self.config.dry_run => return vec![].into_iter(),
1323 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1325 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1328 fn remove(&self, f: &Path) {
1329 if self.config.dry_run {
1332 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1335 /// Returns if config.ninja is enabled, and checks for ninja existence,
1336 /// exiting with a nicer error message if not.
1337 fn ninja(&self) -> bool {
1338 let mut cmd_finder = crate::sanity::Finder::new();
1340 if self.config.ninja_in_file {
1341 // Some Linux distros rename `ninja` to `ninja-build`.
1342 // CMake can work with either binary name.
1343 if cmd_finder.maybe_have("ninja-build").is_none()
1344 && cmd_finder.maybe_have("ninja").is_none()
1348 Couldn't find required command: ninja
1349 You should install ninja, or set ninja=false in config.toml
1352 std::process::exit(1);
1356 // If ninja isn't enabled but we're building for MSVC then we try
1357 // doubly hard to enable it. It was realized in #43767 that the msbuild
1358 // CMake generator for MSVC doesn't respect configuration options like
1359 // disabling LLVM assertions, which can often be quite important!
1361 // In these cases we automatically enable Ninja if we find it in the
1363 if !self.config.ninja_in_file && self.config.build.contains("msvc") {
1364 if cmd_finder.maybe_have("ninja").is_some() {
1369 self.config.ninja_in_file
1374 fn chmod(path: &Path, perms: u32) {
1375 use std::os::unix::fs::*;
1376 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1379 fn chmod(_path: &Path, _perms: u32) {}
1382 pub fn with_stage(mut self, stage: u32) -> Compiler {
1387 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1388 pub fn is_snapshot(&self, build: &Build) -> bool {
1389 self.stage == 0 && self.host == build.build
1392 /// Returns if this compiler should be treated as a final stage one in the
1393 /// current build session.
1394 /// This takes into account whether we're performing a full bootstrap or
1395 /// not; don't directly compare the stage with `2`!
1396 pub fn is_final_stage(&self, build: &Build) -> bool {
1397 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1398 self.stage >= final_stage
1402 fn envify(s: &str) -> String {
1408 .flat_map(|c| c.to_uppercase())