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::TargetSelection;
125 use crate::util::{exe, libdir, CiEnv};
152 #[cfg(all(unix, not(target_os = "haiku")))]
154 pub unsafe fn setup(build: &mut crate::Build) {
155 if build.config.low_priority {
156 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
161 #[cfg(any(target_os = "haiku", target_os = "hermit", not(any(unix, windows))))]
163 pub unsafe fn setup(_build: &mut crate::Build) {}
166 use crate::cache::{Interned, INTERNER};
167 pub use crate::config::Config;
168 use crate::flags::Subcommand;
170 const LLVM_TOOLS: &[&str] = &[
171 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
172 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
173 "llvm-objdump", // used to disassemble programs
174 "llvm-profdata", // used to inspect and merge files generated by profiles
175 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
176 "llvm-size", // used to prints the size of the linker sections of a program
177 "llvm-strip", // used to discard symbols from binary files to reduce their size
178 "llvm-ar", // used for creating and modifying archive files
181 /// A structure representing a Rust compiler.
183 /// Each compiler has a `stage` that it is associated with and a `host` that
184 /// corresponds to the platform the compiler runs on. This structure is used as
185 /// a parameter to many methods below.
186 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
187 pub struct Compiler {
189 host: TargetSelection,
192 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
194 /// Run normal tests and doc tests (default).
196 /// Do not run any doc tests.
198 /// Only run doc tests.
207 /// Global configuration for the build system.
209 /// This structure transitively contains all configuration for the build system.
210 /// All filesystem-encoded configuration is in `config`, all flags are in
211 /// `flags`, and then parsed or probed information is listed in the keys below.
213 /// This structure is a parameter of almost all methods in the build system,
214 /// although most functions are implemented as free functions rather than
215 /// methods specifically on this structure itself (to make it easier to
218 /// User-specified configuration from `config.toml`.
221 // Version information
224 // Properties derived from the above configuration
227 rust_info: channel::GitInfo,
228 cargo_info: channel::GitInfo,
229 rls_info: channel::GitInfo,
230 rust_analyzer_info: channel::GitInfo,
231 clippy_info: channel::GitInfo,
232 miri_info: channel::GitInfo,
233 rustfmt_info: channel::GitInfo,
234 in_tree_llvm_info: channel::GitInfo,
240 // Targets for which to build
241 build: TargetSelection,
242 hosts: Vec<TargetSelection>,
243 targets: Vec<TargetSelection>,
245 // Stage 0 (downloaded) compiler, lld and cargo or their local rust equivalents
246 initial_rustc: PathBuf,
247 initial_cargo: PathBuf,
248 initial_lld: PathBuf,
249 initial_libdir: PathBuf,
251 // Runtime state filled in later on
252 // C/C++ compilers and archiver for all targets
253 cc: HashMap<TargetSelection, cc::Tool>,
254 cxx: HashMap<TargetSelection, cc::Tool>,
255 ar: HashMap<TargetSelection, PathBuf>,
256 ranlib: HashMap<TargetSelection, PathBuf>,
258 crates: HashMap<Interned<String>, Crate>,
261 delayed_failures: RefCell<Vec<String>>,
262 prerelease_version: Cell<Option<u32>>,
264 RefCell<HashMap<TargetSelection, HashMap<String, (&'static str, PathBuf, Vec<String>)>>>,
269 name: Interned<String>,
270 deps: HashSet<Interned<String>>,
276 fn local_path(&self, build: &Build) -> PathBuf {
277 self.path.strip_prefix(&build.config.src).unwrap().into()
281 /// When building Rust various objects are handled differently.
282 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
283 pub enum DependencyType {
284 /// Libraries originating from proc-macros.
286 /// Typical Rust libraries.
288 /// Non Rust libraries and objects shipped to ease usage of certain targets.
292 /// The various "modes" of invoking Cargo.
294 /// These entries currently correspond to the various output directories of the
295 /// build system, with each mod generating output in a different directory.
296 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
298 /// Build the standard library, placing output in the "stageN-std" directory.
301 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
304 /// Build a tool, placing output in the "stage0-bootstrap-tools"
305 /// directory. This is for miscellaneous sets of tools that are built
306 /// using the bootstrap stage0 compiler in its entirety (target libraries
307 /// and all). Typically these tools compile with stable Rust.
310 /// Build a tool which uses the locally built std, placing output in the
311 /// "stageN-tools" directory. Its usage is quite rare, mainly used by
312 /// compiletest which needs libtest.
315 /// Build a tool which uses the locally built rustc and the target std,
316 /// placing the output in the "stageN-tools" directory. This is used for
317 /// anything that needs a fully functional rustc, such as rustdoc, clippy,
318 /// cargo, rls, rustfmt, miri, etc.
323 pub fn is_tool(&self) -> bool {
324 matches!(self, Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd)
329 /// Creates a new set of build configuration from the `flags` on the command
330 /// line and the filesystem `config`.
332 /// By default all build output will be placed in the current directory.
333 pub fn new(config: Config) -> Build {
334 let src = config.src.clone();
335 let out = config.out.clone();
337 let is_sudo = match env::var_os("SUDO_USER") {
338 Some(sudo_user) => match env::var_os("USER") {
339 Some(user) => user != sudo_user,
345 let ignore_git = config.ignore_git;
346 let rust_info = channel::GitInfo::new(ignore_git, &src);
347 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
348 let rls_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rls"));
349 let rust_analyzer_info =
350 channel::GitInfo::new(ignore_git, &src.join("src/tools/rust-analyzer"));
351 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
352 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
353 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
355 // we always try to use git for LLVM builds
356 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
358 let initial_target_libdir_str = if config.dry_run {
359 "/dummy/lib/path/to/lib/".to_string()
362 Command::new(&config.initial_rustc)
364 .arg(config.build.rustc_target_arg())
366 .arg("target-libdir"),
369 let initial_target_dir = Path::new(&initial_target_libdir_str).parent().unwrap();
370 let initial_lld = initial_target_dir.join("bin").join("rust-lld");
372 let initial_sysroot = if config.dry_run {
375 output(Command::new(&config.initial_rustc).arg("--print").arg("sysroot"))
377 let initial_libdir = initial_target_dir
382 .strip_prefix(initial_sysroot.trim())
386 let version = std::fs::read_to_string(src.join("src").join("version"))
387 .expect("failed to read src/version");
388 let version = version.trim();
390 let mut build = Build {
391 initial_rustc: config.initial_rustc.clone(),
392 initial_cargo: config.initial_cargo.clone(),
395 local_rebuild: config.local_rebuild,
396 fail_fast: config.cmd.fail_fast(),
397 doc_tests: config.cmd.doc_tests(),
398 verbosity: config.verbose,
401 hosts: config.hosts.clone(),
402 targets: config.targets.clone(),
405 version: version.to_string(),
420 ranlib: HashMap::new(),
421 crates: HashMap::new(),
423 ci_env: CiEnv::current(),
424 delayed_failures: RefCell::new(Vec::new()),
425 prerelease_version: Cell::new(None),
426 tool_artifacts: Default::default(),
429 build.verbose("finding compilers");
430 cc_detect::find(&mut build);
431 build.verbose("running sanity check");
432 sanity::check(&mut build);
434 // If local-rust is the same major.minor as the current version, then force a
436 let local_version_verbose =
437 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
438 let local_release = local_version_verbose
440 .filter_map(|x| x.strip_prefix("release:"))
444 if local_release.split('.').take(2).eq(version.split('.').take(2)) {
445 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
446 build.local_rebuild = true;
449 build.verbose("learning about cargo");
450 metadata::build(&mut build);
455 pub fn build_triple(&self) -> &[Interned<String>] {
456 slice::from_ref(&self.build.triple)
459 /// Executes the entire build, as configured by the flags and configuration.
460 pub fn build(&mut self) {
465 if let Subcommand::Format { check } = self.config.cmd {
466 return format::format(self, check);
469 if let Subcommand::Clean { all } = self.config.cmd {
470 return clean::clean(self, all);
474 let builder = builder::Builder::new(&self);
475 if let Some(path) = builder.paths.get(0) {
476 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
482 if !self.config.dry_run {
484 self.config.dry_run = true;
485 let builder = builder::Builder::new(&self);
486 builder.execute_cli();
488 self.config.dry_run = false;
489 let builder = builder::Builder::new(&self);
490 builder.execute_cli();
492 let builder = builder::Builder::new(&self);
493 builder.execute_cli();
496 // Check for postponed failures from `test --no-fail-fast`.
497 let failures = self.delayed_failures.borrow();
498 if failures.len() > 0 {
499 println!("\n{} command(s) did not execute successfully:\n", failures.len());
500 for failure in failures.iter() {
501 println!(" - {}\n", failure);
507 /// Clear out `dir` if `input` is newer.
509 /// After this executes, it will also ensure that `dir` exists.
510 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
511 let stamp = dir.join(".stamp");
512 let mut cleared = false;
513 if mtime(&stamp) < mtime(input) {
514 self.verbose(&format!("Dirty - {}", dir.display()));
515 let _ = fs::remove_dir_all(dir);
517 } else if stamp.exists() {
520 t!(fs::create_dir_all(dir));
521 t!(File::create(stamp));
525 /// Gets the space-separated set of activated features for the standard
527 fn std_features(&self) -> String {
528 let mut features = "panic-unwind".to_string();
530 if self.config.llvm_libunwind {
531 features.push_str(" llvm-libunwind");
533 if self.config.backtrace {
534 features.push_str(" backtrace");
536 if self.config.profiler {
537 features.push_str(" profiler");
542 /// Gets the space-separated set of activated features for the compiler.
543 fn rustc_features(&self) -> String {
544 let mut features = String::new();
545 if self.config.jemalloc {
546 features.push_str("jemalloc");
548 if self.config.llvm_enabled() {
549 features.push_str(" llvm");
552 // If debug logging is on, then we want the default for tracing:
553 // https://github.com/tokio-rs/tracing/blob/3dd5c03d907afdf2c39444a29931833335171554/tracing/src/level_filters.rs#L26
554 // which is everything (including debug/trace/etc.)
555 // if its unset, if debug_assertions is on, then debug_logging will also be on
556 // as well as tracing *ignoring* this feature when debug_assertions is on
557 if !self.config.rust_debug_logging {
558 features.push_str(" max_level_info");
564 /// Component directory that Cargo will produce output into (e.g.
566 fn cargo_dir(&self) -> &'static str {
567 if self.config.rust_optimize { "release" } else { "debug" }
570 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
573 .join(&*compiler.host.triple)
574 .join(format!("stage{}-tools-bin", compiler.stage));
575 t!(fs::create_dir_all(&out));
579 /// Returns the root directory for all output generated in a particular
580 /// stage when running with a particular host compiler.
582 /// The mode indicates what the root directory is for.
583 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
584 let suffix = match mode {
586 Mode::Rustc => "-rustc",
587 Mode::ToolBootstrap => "-bootstrap-tools",
588 Mode::ToolStd | Mode::ToolRustc => "-tools",
590 self.out.join(&*compiler.host.triple).join(format!("stage{}{}", compiler.stage, suffix))
593 /// Returns the root output directory for all Cargo output in a given stage,
594 /// running a particular compiler, whether or not we're building the
595 /// standard library, and targeting the specified architecture.
596 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: TargetSelection) -> PathBuf {
597 self.stage_out(compiler, mode).join(&*target.triple).join(self.cargo_dir())
600 /// Root output directory for LLVM compiled for `target`
602 /// Note that if LLVM is configured externally then the directory returned
603 /// will likely be empty.
604 fn llvm_out(&self, target: TargetSelection) -> PathBuf {
605 self.out.join(&*target.triple).join("llvm")
608 fn lld_out(&self, target: TargetSelection) -> PathBuf {
609 self.out.join(&*target.triple).join("lld")
612 /// Output directory for all documentation for a target
613 fn doc_out(&self, target: TargetSelection) -> PathBuf {
614 self.out.join(&*target.triple).join("doc")
617 /// Output directory for all documentation for a target
618 fn compiler_doc_out(&self, target: TargetSelection) -> PathBuf {
619 self.out.join(&*target.triple).join("compiler-doc")
622 /// Output directory for some generated md crate documentation for a target (temporary)
623 fn md_doc_out(&self, target: TargetSelection) -> Interned<PathBuf> {
624 INTERNER.intern_path(self.out.join(&*target.triple).join("md-doc"))
627 /// Returns `true` if no custom `llvm-config` is set for the specified target.
629 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
630 fn is_rust_llvm(&self, target: TargetSelection) -> bool {
631 if self.config.llvm_from_ci && target == self.config.build {
635 match self.config.target_config.get(&target) {
636 Some(ref c) => c.llvm_config.is_none(),
641 /// Returns the path to `FileCheck` binary for the specified target
642 fn llvm_filecheck(&self, target: TargetSelection) -> PathBuf {
643 let target_config = self.config.target_config.get(&target);
644 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
646 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
647 let llvm_bindir = output(Command::new(s).arg("--bindir"));
648 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", target));
649 if filecheck.exists() {
652 // On Fedora the system LLVM installs FileCheck in the
653 // llvm subdirectory of the libdir.
654 let llvm_libdir = output(Command::new(s).arg("--libdir"));
656 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", target));
657 if lib_filecheck.exists() {
660 // Return the most normal file name, even though
661 // it doesn't exist, so that any error message
667 let base = self.llvm_out(self.config.build).join("build");
668 let base = if !self.ninja() && self.config.build.contains("msvc") {
669 if self.config.llvm_optimize {
670 if self.config.llvm_release_debuginfo {
671 base.join("RelWithDebInfo")
681 base.join("bin").join(exe("FileCheck", target))
685 /// Directory for libraries built from C/C++ code and shared between stages.
686 fn native_dir(&self, target: TargetSelection) -> PathBuf {
687 self.out.join(&*target.triple).join("native")
690 /// Root output directory for rust_test_helpers library compiled for
692 fn test_helpers_out(&self, target: TargetSelection) -> PathBuf {
693 self.native_dir(target).join("rust-test-helpers")
696 /// Adds the `RUST_TEST_THREADS` env var if necessary
697 fn add_rust_test_threads(&self, cmd: &mut Command) {
698 if env::var_os("RUST_TEST_THREADS").is_none() {
699 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
703 /// Returns the libdir of the snapshot compiler.
704 fn rustc_snapshot_libdir(&self) -> PathBuf {
705 self.rustc_snapshot_sysroot().join(libdir(self.config.build))
708 /// Returns the sysroot of the snapshot compiler.
709 fn rustc_snapshot_sysroot(&self) -> &Path {
710 self.initial_rustc.parent().unwrap().parent().unwrap()
713 /// Runs a command, printing out nice contextual information if it fails.
714 fn run(&self, cmd: &mut Command) {
715 if self.config.dry_run {
718 self.verbose(&format!("running: {:?}", cmd));
722 /// Runs a command, printing out nice contextual information if it fails.
723 fn run_quiet(&self, cmd: &mut Command) {
724 if self.config.dry_run {
727 self.verbose(&format!("running: {:?}", cmd));
731 /// Runs a command, printing out nice contextual information if it fails.
732 /// Exits if the command failed to execute at all, otherwise returns its
733 /// `status.success()`.
734 fn try_run(&self, cmd: &mut Command) -> bool {
735 if self.config.dry_run {
738 self.verbose(&format!("running: {:?}", cmd));
742 /// Runs a command, printing out nice contextual information if it fails.
743 /// Exits if the command failed to execute at all, otherwise returns its
744 /// `status.success()`.
745 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
746 if self.config.dry_run {
749 self.verbose(&format!("running: {:?}", cmd));
750 try_run_suppressed(cmd)
753 pub fn is_verbose(&self) -> bool {
757 /// Prints a message if this build is configured in verbose mode.
758 fn verbose(&self, msg: &str) {
759 if self.is_verbose() {
764 pub fn is_verbose_than(&self, level: usize) -> bool {
765 self.verbosity > level
768 /// Prints a message if this build is configured in more verbose mode than `level`.
769 fn verbose_than(&self, level: usize, msg: &str) {
770 if self.is_verbose_than(level) {
775 fn info(&self, msg: &str) {
776 if self.config.dry_run {
782 /// Returns the number of parallel jobs that have been configured for this
784 fn jobs(&self) -> u32 {
785 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
788 fn debuginfo_map_to(&self, which: GitRepo) -> Option<String> {
789 if !self.config.rust_remap_debuginfo {
795 let sha = self.rust_sha().unwrap_or(&self.version);
796 Some(format!("/rustc/{}", sha))
798 GitRepo::Llvm => Some(String::from("/rustc/llvm")),
802 /// Returns the path to the C compiler for the target specified.
803 fn cc(&self, target: TargetSelection) -> &Path {
804 self.cc[&target].path()
807 /// Returns a list of flags to pass to the C compiler for the target
809 fn cflags(&self, target: TargetSelection, which: GitRepo) -> Vec<String> {
810 // Filter out -O and /O (the optimization flags) that we picked up from
811 // cc-rs because the build scripts will determine that for themselves.
812 let mut base = self.cc[&target]
815 .map(|s| s.to_string_lossy().into_owned())
816 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
817 .collect::<Vec<String>>();
819 // If we're compiling on macOS then we add a few unconditional flags
820 // indicating that we want libc++ (more filled out than libstdc++) and
821 // we want to compile for 10.7. This way we can ensure that
822 // LLVM/etc are all properly compiled.
823 if target.contains("apple-darwin") {
824 base.push("-stdlib=libc++".into());
827 // Work around an apparently bad MinGW / GCC optimization,
828 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
829 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
830 if &*target.triple == "i686-pc-windows-gnu" {
831 base.push("-fno-omit-frame-pointer".into());
834 if let Some(map_to) = self.debuginfo_map_to(which) {
835 let map = format!("{}={}", self.src.display(), map_to);
836 let cc = self.cc(target);
837 if cc.ends_with("clang") || cc.ends_with("gcc") {
838 base.push(format!("-fdebug-prefix-map={}", map));
839 } else if cc.ends_with("clang-cl.exe") {
840 base.push("-Xclang".into());
841 base.push(format!("-fdebug-prefix-map={}", map));
847 /// Returns the path to the `ar` archive utility for the target specified.
848 fn ar(&self, target: TargetSelection) -> Option<&Path> {
849 self.ar.get(&target).map(|p| &**p)
852 /// Returns the path to the `ranlib` utility for the target specified.
853 fn ranlib(&self, target: TargetSelection) -> Option<&Path> {
854 self.ranlib.get(&target).map(|p| &**p)
857 /// Returns the path to the C++ compiler for the target specified.
858 fn cxx(&self, target: TargetSelection) -> Result<&Path, String> {
859 match self.cxx.get(&target) {
860 Some(p) => Ok(p.path()),
862 Err(format!("target `{}` is not configured as a host, only as a target", target))
867 /// Returns the path to the linker for the given target if it needs to be overridden.
868 fn linker(&self, target: TargetSelection) -> Option<&Path> {
869 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
872 } else if target.contains("vxworks") {
873 // need to use CXX compiler as linker to resolve the exception functions
874 // that are only existed in CXX libraries
875 Some(self.cxx[&target].path())
876 } else if target != self.config.build
877 && util::use_host_linker(target)
878 && !target.contains("msvc")
880 Some(self.cc(target))
881 } else if self.config.use_lld && !self.is_fuse_ld_lld(target) && self.build == target {
882 Some(&self.initial_lld)
888 // LLD is used through `-fuse-ld=lld` rather than directly.
889 // Only MSVC targets use LLD directly at the moment.
890 fn is_fuse_ld_lld(&self, target: TargetSelection) -> bool {
891 self.config.use_lld && !target.contains("msvc")
894 /// Returns if this target should statically link the C runtime, if specified
895 fn crt_static(&self, target: TargetSelection) -> Option<bool> {
896 if target.contains("pc-windows-msvc") {
899 self.config.target_config.get(&target).and_then(|t| t.crt_static)
903 /// Returns the "musl root" for this `target`, if defined
904 fn musl_root(&self, target: TargetSelection) -> Option<&Path> {
908 .and_then(|t| t.musl_root.as_ref())
909 .or_else(|| self.config.musl_root.as_ref())
913 /// Returns the "musl libdir" for this `target`.
914 fn musl_libdir(&self, target: TargetSelection) -> Option<PathBuf> {
915 let t = self.config.target_config.get(&target)?;
916 if let libdir @ Some(_) = &t.musl_libdir {
917 return libdir.clone();
919 self.musl_root(target).map(|root| root.join("lib"))
922 /// Returns the sysroot for the wasi target, if defined
923 fn wasi_root(&self, target: TargetSelection) -> Option<&Path> {
924 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
927 /// Returns `true` if this is a no-std `target`, if defined
928 fn no_std(&self, target: TargetSelection) -> Option<bool> {
929 self.config.target_config.get(&target).map(|t| t.no_std)
932 /// Returns `true` if the target will be tested using the `remote-test-client`
933 /// and `remote-test-server` binaries.
934 fn remote_tested(&self, target: TargetSelection) -> bool {
935 self.qemu_rootfs(target).is_some()
936 || target.contains("android")
937 || env::var_os("TEST_DEVICE_ADDR").is_some()
940 /// Returns the root of the "rootfs" image that this target will be using,
941 /// if one was configured.
943 /// If `Some` is returned then that means that tests for this target are
944 /// emulated with QEMU and binaries will need to be shipped to the emulator.
945 fn qemu_rootfs(&self, target: TargetSelection) -> Option<&Path> {
946 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
949 /// Path to the python interpreter to use
950 fn python(&self) -> &Path {
951 self.config.python.as_ref().unwrap()
954 /// Temporary directory that extended error information is emitted to.
955 fn extended_error_dir(&self) -> PathBuf {
956 self.out.join("tmp/extended-error-metadata")
959 /// Tests whether the `compiler` compiling for `target` should be forced to
960 /// use a stage1 compiler instead.
962 /// Currently, by default, the build system does not perform a "full
963 /// bootstrap" by default where we compile the compiler three times.
964 /// Instead, we compile the compiler two times. The final stage (stage2)
965 /// just copies the libraries from the previous stage, which is what this
968 /// Here we return `true` if:
970 /// * The build isn't performing a full bootstrap
971 /// * The `compiler` is in the final stage, 2
972 /// * We're not cross-compiling, so the artifacts are already available in
975 /// When all of these conditions are met the build will lift artifacts from
976 /// the previous stage forward.
977 fn force_use_stage1(&self, compiler: Compiler, target: TargetSelection) -> bool {
978 !self.config.full_bootstrap
979 && compiler.stage >= 2
980 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
983 /// Given `num` in the form "a.b.c" return a "release string" which
984 /// describes the release version number.
986 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
987 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
988 fn release(&self, num: &str) -> String {
989 match &self.config.channel[..] {
990 "stable" => num.to_string(),
992 if self.rust_info.is_git() {
993 format!("{}-beta.{}", num, self.beta_prerelease_version())
995 format!("{}-beta", num)
998 "nightly" => format!("{}-nightly", num),
999 _ => format!("{}-dev", num),
1003 fn beta_prerelease_version(&self) -> u32 {
1004 if let Some(s) = self.prerelease_version.get() {
1008 // Figure out how many merge commits happened since we branched off master.
1009 // That's our beta number!
1010 // (Note that we use a `..` range, not the `...` symmetric difference.)
1016 .arg("refs/remotes/origin/master..HEAD")
1017 .current_dir(&self.src),
1019 let n = count.trim().parse().unwrap();
1020 self.prerelease_version.set(Some(n));
1024 /// Returns the value of `release` above for Rust itself.
1025 fn rust_release(&self) -> String {
1026 self.release(&self.version)
1029 /// Returns the "package version" for a component given the `num` release
1032 /// The package version is typically what shows up in the names of tarballs.
1033 /// For channels like beta/nightly it's just the channel name, otherwise
1034 /// it's the `num` provided.
1035 fn package_vers(&self, num: &str) -> String {
1036 match &self.config.channel[..] {
1037 "stable" => num.to_string(),
1038 "beta" => "beta".to_string(),
1039 "nightly" => "nightly".to_string(),
1040 _ => format!("{}-dev", num),
1044 /// Returns the value of `package_vers` above for Rust itself.
1045 fn rust_package_vers(&self) -> String {
1046 self.package_vers(&self.version)
1049 /// Returns the value of `package_vers` above for Cargo
1050 fn cargo_package_vers(&self) -> String {
1051 self.package_vers(&self.release_num("cargo"))
1054 /// Returns the value of `package_vers` above for rls
1055 fn rls_package_vers(&self) -> String {
1056 self.package_vers(&self.release_num("rls"))
1059 /// Returns the value of `package_vers` above for rust-analyzer
1060 fn rust_analyzer_package_vers(&self) -> String {
1061 self.package_vers(&self.release_num("rust-analyzer/crates/rust-analyzer"))
1064 /// Returns the value of `package_vers` above for clippy
1065 fn clippy_package_vers(&self) -> String {
1066 self.package_vers(&self.release_num("clippy"))
1069 /// Returns the value of `package_vers` above for miri
1070 fn miri_package_vers(&self) -> String {
1071 self.package_vers(&self.release_num("miri"))
1074 /// Returns the value of `package_vers` above for rustfmt
1075 fn rustfmt_package_vers(&self) -> String {
1076 self.package_vers(&self.release_num("rustfmt"))
1079 fn llvm_tools_package_vers(&self) -> String {
1080 self.package_vers(&self.version)
1083 fn llvm_tools_vers(&self) -> String {
1087 fn llvm_link_tools_dynamically(&self, target: TargetSelection) -> bool {
1088 target.contains("linux-gnu") || target.contains("apple-darwin")
1091 /// Returns the `version` string associated with this compiler for Rust
1094 /// Note that this is a descriptive string which includes the commit date,
1095 /// sha, version, etc.
1096 fn rust_version(&self) -> String {
1097 self.rust_info.version(self, &self.version)
1100 /// Returns the full commit hash.
1101 fn rust_sha(&self) -> Option<&str> {
1102 self.rust_info.sha()
1105 /// Returns the `a.b.c` version that the given package is at.
1106 fn release_num(&self, package: &str) -> String {
1107 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1108 let toml = t!(fs::read_to_string(&toml_file_name));
1109 for line in toml.lines() {
1110 if let Some(stripped) =
1111 line.strip_prefix("version = \"").and_then(|s| s.strip_suffix("\""))
1113 return stripped.to_owned();
1117 panic!("failed to find version in {}'s Cargo.toml", package)
1120 /// Returns `true` if unstable features should be enabled for the compiler
1122 fn unstable_features(&self) -> bool {
1123 match &self.config.channel[..] {
1124 "stable" | "beta" => false,
1125 "nightly" | _ => true,
1129 /// Returns a Vec of all the dependencies of the given root crate,
1130 /// including transitive dependencies and the root itself. Only includes
1131 /// "local" crates (those in the local source tree, not from a registry).
1132 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1133 let mut ret = Vec::new();
1134 let mut list = vec![INTERNER.intern_str(root)];
1135 let mut visited = HashSet::new();
1136 while let Some(krate) = list.pop() {
1137 let krate = &self.crates[&krate];
1139 for dep in &krate.deps {
1140 // Don't include optional deps if their features are not
1141 // enabled. Ideally this would be computed from `cargo
1142 // metadata --features …`, but that is somewhat slow. Just
1143 // skip `build_helper` since there aren't any operations we
1144 // want to perform on it. In the future, we may want to
1145 // consider just filtering all build and dev dependencies in
1147 if visited.insert(dep)
1148 && dep != "build_helper"
1149 && (dep != "profiler_builtins" || self.config.profiler)
1150 && (dep != "rustc_codegen_llvm" || self.config.llvm_enabled())
1159 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, DependencyType)> {
1160 if self.config.dry_run {
1164 let mut paths = Vec::new();
1165 let contents = t!(fs::read(stamp), &stamp);
1166 // This is the method we use for extracting paths from the stamp file passed to us. See
1167 // run_cargo for more information (in compile.rs).
1168 for part in contents.split(|b| *b == 0) {
1169 if part.is_empty() {
1172 let dependency_type = match part[0] as char {
1173 'h' => DependencyType::Host,
1174 's' => DependencyType::TargetSelfContained,
1175 't' => DependencyType::Target,
1176 _ => unreachable!(),
1178 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1179 paths.push((path, dependency_type));
1184 /// Copies a file from `src` to `dst`
1185 pub fn copy(&self, src: &Path, dst: &Path) {
1186 if self.config.dry_run {
1189 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1193 let _ = fs::remove_file(&dst);
1194 let metadata = t!(src.symlink_metadata());
1195 if metadata.file_type().is_symlink() {
1196 let link = t!(fs::read_link(src));
1197 t!(symlink_file(link, dst));
1198 } else if let Ok(()) = fs::hard_link(src, dst) {
1199 // Attempt to "easy copy" by creating a hard link
1200 // (symlinks don't work on windows), but if that fails
1201 // just fall back to a slow `copy` operation.
1203 if let Err(e) = fs::copy(src, dst) {
1204 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1206 t!(fs::set_permissions(dst, metadata.permissions()));
1207 let atime = FileTime::from_last_access_time(&metadata);
1208 let mtime = FileTime::from_last_modification_time(&metadata);
1209 t!(filetime::set_file_times(dst, atime, mtime));
1213 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1214 /// new string for each replacement.)
1215 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1216 if self.config.dry_run {
1219 let mut contents = String::new();
1220 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1221 t!(file.read_to_string(&mut contents));
1222 for &(target, replacement) in replacements {
1223 contents = contents.replace(target, replacement);
1225 t!(file.seek(SeekFrom::Start(0)));
1226 t!(file.set_len(0));
1227 t!(file.write_all(contents.as_bytes()));
1230 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1231 /// when this function is called.
1232 pub fn cp_r(&self, src: &Path, dst: &Path) {
1233 if self.config.dry_run {
1236 for f in self.read_dir(src) {
1237 let path = f.path();
1238 let name = path.file_name().unwrap();
1239 let dst = dst.join(name);
1240 if t!(f.file_type()).is_dir() {
1241 t!(fs::create_dir_all(&dst));
1242 self.cp_r(&path, &dst);
1244 let _ = fs::remove_file(&dst);
1245 self.copy(&path, &dst);
1250 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1251 /// when this function is called. Unwanted files or directories can be skipped
1252 /// by returning `false` from the filter function.
1253 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1254 // Immediately recurse with an empty relative path
1255 self.recurse_(src, dst, Path::new(""), filter)
1258 // Inner function does the actual work
1259 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1260 for f in self.read_dir(src) {
1261 let path = f.path();
1262 let name = path.file_name().unwrap();
1263 let dst = dst.join(name);
1264 let relative = relative.join(name);
1265 // Only copy file or directory if the filter function returns true
1266 if filter(&relative) {
1267 if t!(f.file_type()).is_dir() {
1268 let _ = fs::remove_dir_all(&dst);
1269 self.create_dir(&dst);
1270 self.recurse_(&path, &dst, &relative, filter);
1272 let _ = fs::remove_file(&dst);
1273 self.copy(&path, &dst);
1279 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1280 let file_name = src.file_name().unwrap();
1281 let dest = dest_folder.join(file_name);
1282 self.copy(src, &dest);
1285 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1286 if self.config.dry_run {
1289 let dst = dstdir.join(src.file_name().unwrap());
1290 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1291 t!(fs::create_dir_all(dstdir));
1292 drop(fs::remove_file(&dst));
1295 panic!("Error: File \"{}\" not found!", src.display());
1297 let metadata = t!(src.symlink_metadata());
1298 if let Err(e) = fs::copy(&src, &dst) {
1299 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1301 t!(fs::set_permissions(&dst, metadata.permissions()));
1302 let atime = FileTime::from_last_access_time(&metadata);
1303 let mtime = FileTime::from_last_modification_time(&metadata);
1304 t!(filetime::set_file_times(&dst, atime, mtime));
1309 fn create(&self, path: &Path, s: &str) {
1310 if self.config.dry_run {
1313 t!(fs::write(path, s));
1316 fn read(&self, path: &Path) -> String {
1317 if self.config.dry_run {
1318 return String::new();
1320 t!(fs::read_to_string(path))
1323 fn create_dir(&self, dir: &Path) {
1324 if self.config.dry_run {
1327 t!(fs::create_dir_all(dir))
1330 fn remove_dir(&self, dir: &Path) {
1331 if self.config.dry_run {
1334 t!(fs::remove_dir_all(dir))
1337 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1338 let iter = match fs::read_dir(dir) {
1340 Err(_) if self.config.dry_run => return vec![].into_iter(),
1341 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1343 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1346 fn remove(&self, f: &Path) {
1347 if self.config.dry_run {
1350 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1353 /// Returns if config.ninja is enabled, and checks for ninja existence,
1354 /// exiting with a nicer error message if not.
1355 fn ninja(&self) -> bool {
1356 let mut cmd_finder = crate::sanity::Finder::new();
1358 if self.config.ninja_in_file {
1359 // Some Linux distros rename `ninja` to `ninja-build`.
1360 // CMake can work with either binary name.
1361 if cmd_finder.maybe_have("ninja-build").is_none()
1362 && cmd_finder.maybe_have("ninja").is_none()
1366 Couldn't find required command: ninja
1367 You should install ninja, or set ninja=false in config.toml
1370 std::process::exit(1);
1374 // If ninja isn't enabled but we're building for MSVC then we try
1375 // doubly hard to enable it. It was realized in #43767 that the msbuild
1376 // CMake generator for MSVC doesn't respect configuration options like
1377 // disabling LLVM assertions, which can often be quite important!
1379 // In these cases we automatically enable Ninja if we find it in the
1381 if !self.config.ninja_in_file && self.config.build.contains("msvc") {
1382 if cmd_finder.maybe_have("ninja").is_some() {
1387 self.config.ninja_in_file
1392 fn chmod(path: &Path, perms: u32) {
1393 use std::os::unix::fs::*;
1394 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1397 fn chmod(_path: &Path, _perms: u32) {}
1400 pub fn with_stage(mut self, stage: u32) -> Compiler {
1405 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1406 pub fn is_snapshot(&self, build: &Build) -> bool {
1407 self.stage == 0 && self.host == build.build
1410 /// Returns if this compiler should be treated as a final stage one in the
1411 /// current build session.
1412 /// This takes into account whether we're performing a full bootstrap or
1413 /// not; don't directly compare the stage with `2`!
1414 pub fn is_final_stage(&self, build: &Build) -> bool {
1415 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1416 self.stage >= final_stage
1420 fn envify(s: &str) -> String {
1426 .flat_map(|c| c.to_uppercase())