1 //! Implementation of rustbuild, the Rust build system.
3 //! This module, and its descendants, are the implementation of the Rust build
4 //! system. Most of this build system is backed by Cargo but the outer layer
5 //! here serves as the ability to orchestrate calling Cargo, sequencing Cargo
6 //! builds, building artifacts like LLVM, etc. The goals of rustbuild are:
8 //! * To be an easily understandable, easily extensible, and maintainable build
10 //! * Leverage standard tools in the Rust ecosystem to build the compiler, aka
11 //! crates.io and Cargo.
12 //! * A standard interface to build across all platforms, including MSVC
16 //! The build system defers most of the complicated logic managing invocations
17 //! of rustc and rustdoc to Cargo itself. However, moving through various stages
18 //! and copying artifacts is still necessary for it to do. Each time rustbuild
19 //! is invoked, it will iterate through the list of predefined steps and execute
20 //! each serially in turn if it matches the paths passed or is a default rule.
21 //! For each step rustbuild relies on the step internally being incremental and
22 //! parallel. Note, though, that the `-j` parameter to rustbuild gets forwarded
23 //! to appropriate test harnesses and such.
25 //! Most of the "meaty" steps that matter are backed by Cargo, which does indeed
26 //! have its own parallelism and incremental management. Later steps, like
27 //! tests, aren't incremental and simply run the entire suite currently.
28 //! However, compiletest itself tries to avoid running tests when the artifacts
29 //! that are involved (mainly the compiler) haven't changed.
31 //! When you execute `x.py build`, the steps executed are:
33 //! * First, the python script is run. This will automatically download the
34 //! stage0 rustc and cargo according to `src/stage0.txt`, or use the cached
35 //! versions if they're available. These are then used to compile rustbuild
36 //! itself (using Cargo). Finally, control is then transferred to rustbuild.
38 //! * Rustbuild takes over, performs sanity checks, probes the environment,
39 //! reads configuration, and starts executing steps as it reads the command
40 //! line arguments (paths) or going through the default rules.
42 //! The build output will be something like the following:
44 //! Building stage0 std artifacts
45 //! Copying stage0 std
46 //! Building stage0 test artifacts
47 //! Copying stage0 test
48 //! Building stage0 compiler artifacts
49 //! Copying stage0 rustc
50 //! Assembling stage1 compiler
51 //! Building stage1 std artifacts
52 //! Copying stage1 std
53 //! Building stage1 test artifacts
54 //! Copying stage1 test
55 //! Building stage1 compiler artifacts
56 //! Copying stage1 rustc
57 //! Assembling stage2 compiler
58 //! Uplifting stage1 std
59 //! Uplifting stage1 test
60 //! Uplifting stage1 rustc
62 //! Let's disect that a little:
64 //! ## Building stage0 {std,test,compiler} artifacts
66 //! These steps use the provided (downloaded, usually) compiler to compile the
67 //! local Rust source into libraries we can use.
69 //! ## Copying stage0 {std,test,rustc}
71 //! This copies the build output from Cargo into
72 //! `build/$HOST/stage0-sysroot/lib/rustlib/$ARCH/lib`. FIXME: this step's
73 //! documentation should be expanded -- the information already here may be
76 //! ## Assembling stage1 compiler
78 //! This copies the libraries we built in "building stage0 ... artifacts" into
79 //! the stage1 compiler's lib directory. These are the host libraries that the
80 //! compiler itself uses to run. These aren't actually used by artifacts the new
81 //! compiler generates. This step also copies the rustc and rustdoc binaries we
82 //! generated into build/$HOST/stage/bin.
84 //! The stage1/bin/rustc is a fully functional compiler, but it doesn't yet have
85 //! any libraries to link built binaries or libraries to. The next 3 steps will
86 //! provide those libraries for it; they are mostly equivalent to constructing
87 //! the stage1/bin compiler so we don't go through them individually.
89 //! ## Uplifting stage1 {std,test,rustc}
91 //! This step copies the libraries from the stage1 compiler sysroot into the
92 //! stage2 compiler. This is done to avoid rebuilding the compiler; libraries
93 //! we'd build in this step should be identical (in function, if not necessarily
94 //! identical on disk) so there's no need to recompile the compiler again. Note
95 //! that if you want to, you can enable the full-bootstrap option to change this
98 //! Each step is driven by a separate Cargo project and rustbuild orchestrates
99 //! copying files between steps and otherwise preparing for Cargo to run.
101 //! ## Further information
103 //! More documentation can be found in each respective module below, and you can
104 //! also check out the `src/bootstrap/README.md` file for more information.
106 #![feature(drain_filter)]
108 use std
::cell
::{Cell, RefCell}
;
109 use std
::collections
::{HashMap, HashSet}
;
111 use std
::fs
::{self, File, OpenOptions}
;
112 use std
::io
::{Read, Seek, SeekFrom, Write}
;
113 use std
::path
::{Path, PathBuf}
;
114 use std
::process
::{self, Command}
;
119 use std
::os
::unix
::fs
::symlink
as symlink_file
;
121 use std
::os
::windows
::fs
::symlink_file
;
123 use build_helper
::{mtime, output, run, run_suppressed, t, try_run, try_run_suppressed}
;
124 use filetime
::FileTime
;
126 use crate::util
::{exe, libdir, CiEnv}
;
153 #[cfg(all(unix, not(target_os = "haiku")))]
155 pub unsafe fn setup(build
: &mut crate::Build
) {
156 if build
.config
.low_priority
{
157 libc
::setpriority(libc
::PRIO_PGRP
as _
, 0, 10);
162 #[cfg(any(target_os = "haiku", target_os = "hermit", not(any(unix, windows))))]
164 pub unsafe fn setup(_build
: &mut crate::Build
) {}
167 use crate::cache
::{Interned, INTERNER}
;
168 pub use crate::config
::Config
;
169 use crate::flags
::Subcommand
;
171 const LLVM_TOOLS
: &[&str] = &[
172 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
173 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
174 "llvm-objdump", // used to disassemble programs
175 "llvm-profdata", // used to inspect and merge files generated by profiles
176 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
177 "llvm-size", // used to prints the size of the linker sections of a program
178 "llvm-strip", // used to discard symbols from binary files to reduce their size
179 "llvm-ar", // used for creating and modifying archive files
182 /// A structure representing a Rust compiler.
184 /// Each compiler has a `stage` that it is associated with and a `host` that
185 /// corresponds to the platform the compiler runs on. This structure is used as
186 /// a parameter to many methods below.
187 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
188 pub struct Compiler
{
190 host
: Interned
<String
>,
193 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
195 /// Run normal tests and doc tests (default).
197 /// Do not run any doc tests.
199 /// Only run doc tests.
208 /// Global configuration for the build system.
210 /// This structure transitively contains all configuration for the build system.
211 /// All filesystem-encoded configuration is in `config`, all flags are in
212 /// `flags`, and then parsed or probed information is listed in the keys below.
214 /// This structure is a parameter of almost all methods in the build system,
215 /// although most functions are implemented as free functions rather than
216 /// methods specifically on this structure itself (to make it easier to
219 /// User-specified configuration from `config.toml`.
222 // Properties derived from the above configuration
225 rust_info
: channel
::GitInfo
,
226 cargo_info
: channel
::GitInfo
,
227 rls_info
: channel
::GitInfo
,
228 clippy_info
: channel
::GitInfo
,
229 miri_info
: channel
::GitInfo
,
230 rustfmt_info
: channel
::GitInfo
,
231 in_tree_llvm_info
: channel
::GitInfo
,
237 // Targets for which to build
238 build
: Interned
<String
>,
239 hosts
: Vec
<Interned
<String
>>,
240 targets
: Vec
<Interned
<String
>>,
242 // Stage 0 (downloaded) compiler, lld and cargo or their local rust equivalents
243 initial_rustc
: PathBuf
,
244 initial_cargo
: PathBuf
,
245 initial_lld
: PathBuf
,
246 initial_libdir
: PathBuf
,
248 // Runtime state filled in later on
249 // C/C++ compilers and archiver for all targets
250 cc
: HashMap
<Interned
<String
>, cc
::Tool
>,
251 cxx
: HashMap
<Interned
<String
>, cc
::Tool
>,
252 ar
: HashMap
<Interned
<String
>, PathBuf
>,
253 ranlib
: HashMap
<Interned
<String
>, PathBuf
>,
255 crates
: HashMap
<Interned
<String
>, Crate
>,
258 delayed_failures
: RefCell
<Vec
<String
>>,
259 prerelease_version
: Cell
<Option
<u32>>,
261 RefCell
<HashMap
<Interned
<String
>, HashMap
<String
, (&'
static str, PathBuf
, Vec
<String
>)>>>,
266 name
: Interned
<String
>,
267 deps
: HashSet
<Interned
<String
>>,
273 fn is_local(&self, build
: &Build
) -> bool
{
274 self.path
.starts_with(&build
.config
.src
) && !self.path
.to_string_lossy().ends_with("_shim")
277 fn local_path(&self, build
: &Build
) -> PathBuf
{
278 assert
!(self.is_local(build
));
279 self.path
.strip_prefix(&build
.config
.src
).unwrap().into()
283 /// The various "modes" of invoking Cargo.
285 /// These entries currently correspond to the various output directories of the
286 /// build system, with each mod generating output in a different directory.
287 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
289 /// Build the standard library, placing output in the "stageN-std" directory.
292 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
295 /// Build codegen libraries, placing output in the "stageN-codegen" directory
298 /// Build some tools, placing output in the "stageN-tools" directory. The
299 /// "other" here is for miscellaneous sets of tools that are built using the
300 /// bootstrap compiler in its entirety (target libraries and all).
301 /// Typically these tools compile with stable Rust.
304 /// Compile a tool which uses all libraries we compile (up to rustc).
305 /// Doesn't use the stage0 compiler libraries like "other", and includes
306 /// tools like rustdoc, cargo, rls, etc.
312 pub fn is_tool(&self) -> bool
{
314 Mode
::ToolBootstrap
| Mode
::ToolRustc
| Mode
::ToolStd
=> true,
321 /// Creates a new set of build configuration from the `flags` on the command
322 /// line and the filesystem `config`.
324 /// By default all build output will be placed in the current directory.
325 pub fn new(config
: Config
) -> Build
{
326 let src
= config
.src
.clone();
327 let out
= config
.out
.clone();
329 let is_sudo
= match env
::var_os("SUDO_USER") {
330 Some(sudo_user
) => match env
::var_os("USER") {
331 Some(user
) => user
!= sudo_user
,
337 let ignore_git
= config
.ignore_git
;
338 let rust_info
= channel
::GitInfo
::new(ignore_git
, &src
);
339 let cargo_info
= channel
::GitInfo
::new(ignore_git
, &src
.join("src/tools/cargo"));
340 let rls_info
= channel
::GitInfo
::new(ignore_git
, &src
.join("src/tools/rls"));
341 let clippy_info
= channel
::GitInfo
::new(ignore_git
, &src
.join("src/tools/clippy"));
342 let miri_info
= channel
::GitInfo
::new(ignore_git
, &src
.join("src/tools/miri"));
343 let rustfmt_info
= channel
::GitInfo
::new(ignore_git
, &src
.join("src/tools/rustfmt"));
345 // we always try to use git for LLVM builds
346 let in_tree_llvm_info
= channel
::GitInfo
::new(false, &src
.join("src/llvm-project"));
348 let initial_target_libdir_str
= if config
.dry_run
{
349 "/dummy/lib/path/to/lib/".to_string()
352 Command
::new(&config
.initial_rustc
)
356 .arg("target-libdir"),
359 let initial_target_dir
= Path
::new(&initial_target_libdir_str
).parent().unwrap();
360 let initial_lld
= initial_target_dir
.join("bin").join("rust-lld");
362 let initial_sysroot
= if config
.dry_run
{
365 output(Command
::new(&config
.initial_rustc
).arg("--print").arg("sysroot"))
367 let initial_libdir
= initial_target_dir
372 .strip_prefix(initial_sysroot
.trim())
376 let mut build
= Build
{
377 initial_rustc
: config
.initial_rustc
.clone(),
378 initial_cargo
: config
.initial_cargo
.clone(),
381 local_rebuild
: config
.local_rebuild
,
382 fail_fast
: config
.cmd
.fail_fast(),
383 doc_tests
: config
.cmd
.doc_tests(),
384 verbosity
: config
.verbose
,
387 hosts
: config
.hosts
.clone(),
388 targets
: config
.targets
.clone(),
404 ranlib
: HashMap
::new(),
405 crates
: HashMap
::new(),
407 ci_env
: CiEnv
::current(),
408 delayed_failures
: RefCell
::new(Vec
::new()),
409 prerelease_version
: Cell
::new(None
),
410 tool_artifacts
: Default
::default(),
413 build
.verbose("finding compilers");
414 cc_detect
::find(&mut build
);
415 build
.verbose("running sanity check");
416 sanity
::check(&mut build
);
418 // If local-rust is the same major.minor as the current version, then force a
420 let local_version_verbose
=
421 output(Command
::new(&build
.initial_rustc
).arg("--version").arg("--verbose"));
422 let local_release
= local_version_verbose
424 .filter(|x
| x
.starts_with("release:"))
427 .trim_start_matches("release:")
429 let my_version
= channel
::CFG_RELEASE_NUM
;
430 if local_release
.split('
.'
).take(2).eq(my_version
.split('
.'
).take(2)) {
431 build
.verbose(&format
!("auto-detected local-rebuild {}", local_release
));
432 build
.local_rebuild
= true;
435 build
.verbose("learning about cargo");
436 metadata
::build(&mut build
);
441 pub fn build_triple(&self) -> &[Interned
<String
>] {
442 unsafe { slice::from_raw_parts(&self.build, 1) }
445 /// Executes the entire build, as configured by the flags and configuration.
446 pub fn build(&mut self) {
451 if let Subcommand
::Format { check }
= self.config
.cmd
{
452 return format
::format(self, check
);
455 if let Subcommand
::Clean { all }
= self.config
.cmd
{
456 return clean
::clean(self, all
);
460 let builder
= builder
::Builder
::new(&self);
461 if let Some(path
) = builder
.paths
.get(0) {
462 if path
== Path
::new("nonexistent/path/to/trigger/cargo/metadata") {
468 if !self.config
.dry_run
{
470 self.config
.dry_run
= true;
471 let builder
= builder
::Builder
::new(&self);
472 builder
.execute_cli();
474 self.config
.dry_run
= false;
475 let builder
= builder
::Builder
::new(&self);
476 builder
.execute_cli();
478 let builder
= builder
::Builder
::new(&self);
479 builder
.execute_cli();
482 // Check for postponed failures from `test --no-fail-fast`.
483 let failures
= self.delayed_failures
.borrow();
484 if failures
.len() > 0 {
485 println
!("\n{} command(s) did not execute successfully:\n", failures
.len());
486 for failure
in failures
.iter() {
487 println
!(" - {}\n", failure
);
493 /// Clear out `dir` if `input` is newer.
495 /// After this executes, it will also ensure that `dir` exists.
496 fn clear_if_dirty(&self, dir
: &Path
, input
: &Path
) -> bool
{
497 let stamp
= dir
.join(".stamp");
498 let mut cleared
= false;
499 if mtime(&stamp
) < mtime(input
) {
500 self.verbose(&format
!("Dirty - {}", dir
.display()));
501 let _
= fs
::remove_dir_all(dir
);
503 } else if stamp
.exists() {
506 t
!(fs
::create_dir_all(dir
));
507 t
!(File
::create(stamp
));
511 /// Gets the space-separated set of activated features for the standard
513 fn std_features(&self) -> String
{
514 let mut features
= "panic-unwind".to_string();
516 if self.config
.llvm_libunwind
{
517 features
.push_str(" llvm-libunwind");
519 if self.config
.backtrace
{
520 features
.push_str(" backtrace");
522 if self.config
.profiler
{
523 features
.push_str(" profiler");
528 /// Gets the space-separated set of activated features for the compiler.
529 fn rustc_features(&self) -> String
{
530 let mut features
= String
::new();
531 if self.config
.jemalloc
{
532 features
.push_str("jemalloc");
534 if self.config
.llvm_enabled() {
535 features
.push_str(" llvm");
540 /// Component directory that Cargo will produce output into (e.g.
542 fn cargo_dir(&self) -> &'
static str {
543 if self.config
.rust_optimize { "release" }
else { "debug" }
546 fn tools_dir(&self, compiler
: Compiler
) -> PathBuf
{
547 let out
= self.out
.join(&*compiler
.host
).join(format
!("stage{}-tools-bin", compiler
.stage
));
548 t
!(fs
::create_dir_all(&out
));
552 /// Returns the root directory for all output generated in a particular
553 /// stage when running with a particular host compiler.
555 /// The mode indicates what the root directory is for.
556 fn stage_out(&self, compiler
: Compiler
, mode
: Mode
) -> PathBuf
{
557 let suffix
= match mode
{
559 Mode
::Rustc
=> "-rustc",
560 Mode
::Codegen
=> "-codegen",
561 Mode
::ToolBootstrap
=> "-bootstrap-tools",
562 Mode
::ToolStd
| Mode
::ToolRustc
=> "-tools",
564 self.out
.join(&*compiler
.host
).join(format
!("stage{}{}", compiler
.stage
, suffix
))
567 /// Returns the root output directory for all Cargo output in a given stage,
568 /// running a particular compiler, whether or not we're building the
569 /// standard library, and targeting the specified architecture.
570 fn cargo_out(&self, compiler
: Compiler
, mode
: Mode
, target
: Interned
<String
>) -> PathBuf
{
571 self.stage_out(compiler
, mode
).join(&*target
).join(self.cargo_dir())
574 /// Root output directory for LLVM compiled for `target`
576 /// Note that if LLVM is configured externally then the directory returned
577 /// will likely be empty.
578 fn llvm_out(&self, target
: Interned
<String
>) -> PathBuf
{
579 self.out
.join(&*target
).join("llvm")
582 fn lld_out(&self, target
: Interned
<String
>) -> PathBuf
{
583 self.out
.join(&*target
).join("lld")
586 /// Output directory for all documentation for a target
587 fn doc_out(&self, target
: Interned
<String
>) -> PathBuf
{
588 self.out
.join(&*target
).join("doc")
591 /// Output directory for all documentation for a target
592 fn compiler_doc_out(&self, target
: Interned
<String
>) -> PathBuf
{
593 self.out
.join(&*target
).join("compiler-doc")
596 /// Output directory for some generated md crate documentation for a target (temporary)
597 fn md_doc_out(&self, target
: Interned
<String
>) -> Interned
<PathBuf
> {
598 INTERNER
.intern_path(self.out
.join(&*target
).join("md-doc"))
601 /// Output directory for all crate documentation for a target (temporary)
603 /// The artifacts here are then copied into `doc_out` above.
604 fn crate_doc_out(&self, target
: Interned
<String
>) -> PathBuf
{
605 self.out
.join(&*target
).join("crate-docs")
608 /// Returns `true` if no custom `llvm-config` is set for the specified target.
610 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
611 fn is_rust_llvm(&self, target
: Interned
<String
>) -> bool
{
612 match self.config
.target_config
.get(&target
) {
613 Some(ref c
) => c
.llvm_config
.is_none(),
618 /// Returns the path to `FileCheck` binary for the specified target
619 fn llvm_filecheck(&self, target
: Interned
<String
>) -> PathBuf
{
620 let target_config
= self.config
.target_config
.get(&target
);
621 if let Some(s
) = target_config
.and_then(|c
| c
.llvm_filecheck
.as_ref()) {
623 } else if let Some(s
) = target_config
.and_then(|c
| c
.llvm_config
.as_ref()) {
624 let llvm_bindir
= output(Command
::new(s
).arg("--bindir"));
625 let filecheck
= Path
::new(llvm_bindir
.trim()).join(exe("FileCheck", &*target
));
626 if filecheck
.exists() {
629 // On Fedora the system LLVM installs FileCheck in the
630 // llvm subdirectory of the libdir.
631 let llvm_libdir
= output(Command
::new(s
).arg("--libdir"));
633 Path
::new(llvm_libdir
.trim()).join("llvm").join(exe("FileCheck", &*target
));
634 if lib_filecheck
.exists() {
637 // Return the most normal file name, even though
638 // it doesn't exist, so that any error message
644 let base
= self.llvm_out(self.config
.build
).join("build");
645 let base
= if !self.config
.ninja
&& self.config
.build
.contains("msvc") {
646 if self.config
.llvm_optimize
{
647 if self.config
.llvm_release_debuginfo
{
648 base
.join("RelWithDebInfo")
658 base
.join("bin").join(exe("FileCheck", &*target
))
662 /// Directory for libraries built from C/C++ code and shared between stages.
663 fn native_dir(&self, target
: Interned
<String
>) -> PathBuf
{
664 self.out
.join(&*target
).join("native")
667 /// Root output directory for rust_test_helpers library compiled for
669 fn test_helpers_out(&self, target
: Interned
<String
>) -> PathBuf
{
670 self.native_dir(target
).join("rust-test-helpers")
673 /// Adds the `RUST_TEST_THREADS` env var if necessary
674 fn add_rust_test_threads(&self, cmd
: &mut Command
) {
675 if env
::var_os("RUST_TEST_THREADS").is_none() {
676 cmd
.env("RUST_TEST_THREADS", self.jobs().to_string());
680 /// Returns the libdir of the snapshot compiler.
681 fn rustc_snapshot_libdir(&self) -> PathBuf
{
682 self.rustc_snapshot_sysroot().join(libdir(&self.config
.build
))
685 /// Returns the sysroot of the snapshot compiler.
686 fn rustc_snapshot_sysroot(&self) -> &Path
{
687 self.initial_rustc
.parent().unwrap().parent().unwrap()
690 /// Runs a command, printing out nice contextual information if it fails.
691 fn run(&self, cmd
: &mut Command
) {
692 if self.config
.dry_run
{
695 self.verbose(&format
!("running: {:?}", cmd
));
699 /// Runs a command, printing out nice contextual information if it fails.
700 fn run_quiet(&self, cmd
: &mut Command
) {
701 if self.config
.dry_run
{
704 self.verbose(&format
!("running: {:?}", cmd
));
708 /// Runs a command, printing out nice contextual information if it fails.
709 /// Exits if the command failed to execute at all, otherwise returns its
710 /// `status.success()`.
711 fn try_run(&self, cmd
: &mut Command
) -> bool
{
712 if self.config
.dry_run
{
715 self.verbose(&format
!("running: {:?}", cmd
));
719 /// Runs a command, printing out nice contextual information if it fails.
720 /// Exits if the command failed to execute at all, otherwise returns its
721 /// `status.success()`.
722 fn try_run_quiet(&self, cmd
: &mut Command
) -> bool
{
723 if self.config
.dry_run
{
726 self.verbose(&format
!("running: {:?}", cmd
));
727 try_run_suppressed(cmd
)
730 pub fn is_verbose(&self) -> bool
{
734 /// Prints a message if this build is configured in verbose mode.
735 fn verbose(&self, msg
: &str) {
736 if self.is_verbose() {
741 pub fn is_verbose_than(&self, level
: usize) -> bool
{
742 self.verbosity
> level
745 /// Prints a message if this build is configured in more verbose mode than `level`.
746 fn verbose_than(&self, level
: usize, msg
: &str) {
747 if self.is_verbose_than(level
) {
752 fn info(&self, msg
: &str) {
753 if self.config
.dry_run
{
759 /// Returns the number of parallel jobs that have been configured for this
761 fn jobs(&self) -> u32 {
762 self.config
.jobs
.unwrap_or_else(|| num_cpus
::get() as u32)
765 fn debuginfo_map_to(&self, which
: GitRepo
) -> Option
<String
> {
766 if !self.config
.rust_remap_debuginfo
{
772 let sha
= self.rust_sha().unwrap_or(channel
::CFG_RELEASE_NUM
);
773 Some(format
!("/rustc/{}", sha
))
775 GitRepo
::Llvm
=> Some(String
::from("/rustc/llvm")),
779 /// Returns the path to the C compiler for the target specified.
780 fn cc(&self, target
: Interned
<String
>) -> &Path
{
781 self.cc
[&target
].path()
784 /// Returns a list of flags to pass to the C compiler for the target
786 fn cflags(&self, target
: Interned
<String
>, which
: GitRepo
) -> Vec
<String
> {
787 // Filter out -O and /O (the optimization flags) that we picked up from
788 // cc-rs because the build scripts will determine that for themselves.
789 let mut base
= self.cc
[&target
]
792 .map(|s
| s
.to_string_lossy().into_owned())
793 .filter(|s
| !s
.starts_with("-O") && !s
.starts_with("/O"))
794 .collect
::<Vec
<String
>>();
796 // If we're compiling on macOS then we add a few unconditional flags
797 // indicating that we want libc++ (more filled out than libstdc++) and
798 // we want to compile for 10.7. This way we can ensure that
799 // LLVM/etc are all properly compiled.
800 if target
.contains("apple-darwin") {
801 base
.push("-stdlib=libc++".into());
804 // Work around an apparently bad MinGW / GCC optimization,
805 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
806 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
807 if &*target
== "i686-pc-windows-gnu" {
808 base
.push("-fno-omit-frame-pointer".into());
811 if let Some(map_to
) = self.debuginfo_map_to(which
) {
812 let map
= format
!("{}={}", self.src
.display(), map_to
);
813 let cc
= self.cc(target
);
814 if cc
.ends_with("clang") || cc
.ends_with("gcc") {
815 base
.push(format
!("-fdebug-prefix-map={}", map
));
816 } else if cc
.ends_with("clang-cl.exe") {
817 base
.push("-Xclang".into());
818 base
.push(format
!("-fdebug-prefix-map={}", map
));
824 /// Returns the path to the `ar` archive utility for the target specified.
825 fn ar(&self, target
: Interned
<String
>) -> Option
<&Path
> {
826 self.ar
.get(&target
).map(|p
| &**p
)
829 /// Returns the path to the `ranlib` utility for the target specified.
830 fn ranlib(&self, target
: Interned
<String
>) -> Option
<&Path
> {
831 self.ranlib
.get(&target
).map(|p
| &**p
)
834 /// Returns the path to the C++ compiler for the target specified.
835 fn cxx(&self, target
: Interned
<String
>) -> Result
<&Path
, String
> {
836 match self.cxx
.get(&target
) {
837 Some(p
) => Ok(p
.path()),
839 Err(format
!("target `{}` is not configured as a host, only as a target", target
))
844 /// Returns the path to the linker for the given target if it needs to be overridden.
845 fn linker(&self, target
: Interned
<String
>, can_use_lld
: bool
) -> Option
<&Path
> {
846 if let Some(linker
) = self.config
.target_config
.get(&target
).and_then(|c
| c
.linker
.as_ref())
849 } else if target
!= self.config
.build
850 && util
::use_host_linker(&target
)
851 && !target
.contains("msvc")
853 Some(self.cc(target
))
854 } else if can_use_lld
&& self.config
.use_lld
&& self.build
== target
{
855 Some(&self.initial_lld
)
861 /// Returns if this target should statically link the C runtime, if specified
862 fn crt_static(&self, target
: Interned
<String
>) -> Option
<bool
> {
863 if target
.contains("pc-windows-msvc") {
866 self.config
.target_config
.get(&target
).and_then(|t
| t
.crt_static
)
870 /// Returns the "musl root" for this `target`, if defined
871 fn musl_root(&self, target
: Interned
<String
>) -> Option
<&Path
> {
875 .and_then(|t
| t
.musl_root
.as_ref())
876 .or_else(|| self.config
.musl_root
.as_ref())
880 /// Returns the sysroot for the wasi target, if defined
881 fn wasi_root(&self, target
: Interned
<String
>) -> Option
<&Path
> {
882 self.config
.target_config
.get(&target
).and_then(|t
| t
.wasi_root
.as_ref()).map(|p
| &**p
)
885 /// Returns `true` if this is a no-std `target`, if defined
886 fn no_std(&self, target
: Interned
<String
>) -> Option
<bool
> {
887 self.config
.target_config
.get(&target
).map(|t
| t
.no_std
)
890 /// Returns `true` if the target will be tested using the `remote-test-client`
891 /// and `remote-test-server` binaries.
892 fn remote_tested(&self, target
: Interned
<String
>) -> bool
{
893 self.qemu_rootfs(target
).is_some()
894 || target
.contains("android")
895 || env
::var_os("TEST_DEVICE_ADDR").is_some()
898 /// Returns the root of the "rootfs" image that this target will be using,
899 /// if one was configured.
901 /// If `Some` is returned then that means that tests for this target are
902 /// emulated with QEMU and binaries will need to be shipped to the emulator.
903 fn qemu_rootfs(&self, target
: Interned
<String
>) -> Option
<&Path
> {
904 self.config
.target_config
.get(&target
).and_then(|t
| t
.qemu_rootfs
.as_ref()).map(|p
| &**p
)
907 /// Path to the python interpreter to use
908 fn python(&self) -> &Path
{
909 self.config
.python
.as_ref().unwrap()
912 /// Temporary directory that extended error information is emitted to.
913 fn extended_error_dir(&self) -> PathBuf
{
914 self.out
.join("tmp/extended-error-metadata")
917 /// Tests whether the `compiler` compiling for `target` should be forced to
918 /// use a stage1 compiler instead.
920 /// Currently, by default, the build system does not perform a "full
921 /// bootstrap" by default where we compile the compiler three times.
922 /// Instead, we compile the compiler two times. The final stage (stage2)
923 /// just copies the libraries from the previous stage, which is what this
926 /// Here we return `true` if:
928 /// * The build isn't performing a full bootstrap
929 /// * The `compiler` is in the final stage, 2
930 /// * We're not cross-compiling, so the artifacts are already available in
933 /// When all of these conditions are met the build will lift artifacts from
934 /// the previous stage forward.
935 fn force_use_stage1(&self, compiler
: Compiler
, target
: Interned
<String
>) -> bool
{
936 !self.config
.full_bootstrap
937 && compiler
.stage
>= 2
938 && (self.hosts
.iter().any(|h
| *h
== target
) || target
== self.build
)
941 /// Given `num` in the form "a.b.c" return a "release string" which
942 /// describes the release version number.
944 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
945 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
946 fn release(&self, num
: &str) -> String
{
947 match &self.config
.channel
[..] {
948 "stable" => num
.to_string(),
950 if self.rust_info
.is_git() {
951 format
!("{}-beta.{}", num
, self.beta_prerelease_version())
953 format
!("{}-beta", num
)
956 "nightly" => format
!("{}-nightly", num
),
957 _
=> format
!("{}-dev", num
),
961 fn beta_prerelease_version(&self) -> u32 {
962 if let Some(s
) = self.prerelease_version
.get() {
967 Command
::new("git").arg("ls-remote").arg("origin").arg("beta").current_dir(&self.src
),
969 let beta
= beta
.trim().split_whitespace().next().unwrap();
971 Command
::new("git").arg("ls-remote").arg("origin").arg("master").current_dir(&self.src
),
973 let master
= master
.trim().split_whitespace().next().unwrap();
975 // Figure out where the current beta branch started.
977 Command
::new("git").arg("merge-base").arg(beta
).arg(master
).current_dir(&self.src
),
979 let base
= base
.trim();
981 // Next figure out how many merge commits happened since we branched off
982 // beta. That's our beta number!
988 .arg(format
!("{}...HEAD", base
))
989 .current_dir(&self.src
),
991 let n
= count
.trim().parse().unwrap();
992 self.prerelease_version
.set(Some(n
));
996 /// Returns the value of `release` above for Rust itself.
997 fn rust_release(&self) -> String
{
998 self.release(channel
::CFG_RELEASE_NUM
)
1001 /// Returns the "package version" for a component given the `num` release
1004 /// The package version is typically what shows up in the names of tarballs.
1005 /// For channels like beta/nightly it's just the channel name, otherwise
1006 /// it's the `num` provided.
1007 fn package_vers(&self, num
: &str) -> String
{
1008 match &self.config
.channel
[..] {
1009 "stable" => num
.to_string(),
1010 "beta" => "beta".to_string(),
1011 "nightly" => "nightly".to_string(),
1012 _
=> format
!("{}-dev", num
),
1016 /// Returns the value of `package_vers` above for Rust itself.
1017 fn rust_package_vers(&self) -> String
{
1018 self.package_vers(channel
::CFG_RELEASE_NUM
)
1021 /// Returns the value of `package_vers` above for Cargo
1022 fn cargo_package_vers(&self) -> String
{
1023 self.package_vers(&self.release_num("cargo"))
1026 /// Returns the value of `package_vers` above for rls
1027 fn rls_package_vers(&self) -> String
{
1028 self.package_vers(&self.release_num("rls"))
1031 /// Returns the value of `package_vers` above for clippy
1032 fn clippy_package_vers(&self) -> String
{
1033 self.package_vers(&self.release_num("clippy"))
1036 /// Returns the value of `package_vers` above for miri
1037 fn miri_package_vers(&self) -> String
{
1038 self.package_vers(&self.release_num("miri"))
1041 /// Returns the value of `package_vers` above for rustfmt
1042 fn rustfmt_package_vers(&self) -> String
{
1043 self.package_vers(&self.release_num("rustfmt"))
1046 fn llvm_tools_package_vers(&self) -> String
{
1047 self.package_vers(channel
::CFG_RELEASE_NUM
)
1050 fn llvm_tools_vers(&self) -> String
{
1054 fn llvm_link_tools_dynamically(&self, target
: Interned
<String
>) -> bool
{
1055 target
.contains("linux-gnu") || target
.contains("apple-darwin")
1058 /// Returns the `version` string associated with this compiler for Rust
1061 /// Note that this is a descriptive string which includes the commit date,
1062 /// sha, version, etc.
1063 fn rust_version(&self) -> String
{
1064 self.rust_info
.version(self, channel
::CFG_RELEASE_NUM
)
1067 /// Returns the full commit hash.
1068 fn rust_sha(&self) -> Option
<&str> {
1069 self.rust_info
.sha()
1072 /// Returns the `a.b.c` version that the given package is at.
1073 fn release_num(&self, package
: &str) -> String
{
1074 let toml_file_name
= self.src
.join(&format
!("src/tools/{}/Cargo.toml", package
));
1075 let toml
= t
!(fs
::read_to_string(&toml_file_name
));
1076 for line
in toml
.lines() {
1077 let prefix
= "version = \"";
1079 if line
.starts_with(prefix
) && line
.ends_with(suffix
) {
1080 return line
[prefix
.len()..line
.len() - suffix
.len()].to_string();
1084 panic
!("failed to find version in {}'s Cargo.toml", package
)
1087 /// Returns `true` if unstable features should be enabled for the compiler
1089 fn unstable_features(&self) -> bool
{
1090 match &self.config
.channel
[..] {
1091 "stable" | "beta" => false,
1092 "nightly" | _
=> true,
1096 fn in_tree_crates(&self, root
: &str) -> Vec
<&Crate
> {
1097 let mut ret
= Vec
::new();
1098 let mut list
= vec
![INTERNER
.intern_str(root
)];
1099 let mut visited
= HashSet
::new();
1100 while let Some(krate
) = list
.pop() {
1101 let krate
= &self.crates
[&krate
];
1102 if krate
.is_local(self) {
1105 for dep
in &krate
.deps
{
1106 if visited
.insert(dep
) && dep
!= "build_helper" {
1114 fn read_stamp_file(&self, stamp
: &Path
) -> Vec
<(PathBuf
, bool
)> {
1115 if self.config
.dry_run
{
1119 let mut paths
= Vec
::new();
1120 let contents
= t
!(fs
::read(stamp
), &stamp
);
1121 // This is the method we use for extracting paths from the stamp file passed to us. See
1122 // run_cargo for more information (in compile.rs).
1123 for part
in contents
.split(|b
| *b
== 0) {
1124 if part
.is_empty() {
1127 let host
= part
[0] as char == 'h'
;
1128 let path
= PathBuf
::from(t
!(str::from_utf8(&part
[1..])));
1129 paths
.push((path
, host
));
1134 /// Copies a file from `src` to `dst`
1135 pub fn copy(&self, src
: &Path
, dst
: &Path
) {
1136 if self.config
.dry_run
{
1139 self.verbose_than(1, &format
!("Copy {:?} to {:?}", src
, dst
));
1143 let _
= fs
::remove_file(&dst
);
1144 let metadata
= t
!(src
.symlink_metadata());
1145 if metadata
.file_type().is_symlink() {
1146 let link
= t
!(fs
::read_link(src
));
1147 t
!(symlink_file(link
, dst
));
1148 } else if let Ok(()) = fs
::hard_link(src
, dst
) {
1149 // Attempt to "easy copy" by creating a hard link
1150 // (symlinks don't work on windows), but if that fails
1151 // just fall back to a slow `copy` operation.
1153 if let Err(e
) = fs
::copy(src
, dst
) {
1154 panic
!("failed to copy `{}` to `{}`: {}", src
.display(), dst
.display(), e
)
1156 t
!(fs
::set_permissions(dst
, metadata
.permissions()));
1157 let atime
= FileTime
::from_last_access_time(&metadata
);
1158 let mtime
= FileTime
::from_last_modification_time(&metadata
);
1159 t
!(filetime
::set_file_times(dst
, atime
, mtime
));
1163 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1164 /// new string for each replacement.)
1165 pub fn replace_in_file(&self, path
: &Path
, replacements
: &[(&str, &str)]) {
1166 if self.config
.dry_run
{
1169 let mut contents
= String
::new();
1170 let mut file
= t
!(OpenOptions
::new().read(true).write(true).open(path
));
1171 t
!(file
.read_to_string(&mut contents
));
1172 for &(target
, replacement
) in replacements
{
1173 contents
= contents
.replace(target
, replacement
);
1175 t
!(file
.seek(SeekFrom
::Start(0)));
1176 t
!(file
.set_len(0));
1177 t
!(file
.write_all(contents
.as_bytes()));
1180 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1181 /// when this function is called.
1182 pub fn cp_r(&self, src
: &Path
, dst
: &Path
) {
1183 if self.config
.dry_run
{
1186 for f
in self.read_dir(src
) {
1187 let path
= f
.path();
1188 let name
= path
.file_name().unwrap();
1189 let dst
= dst
.join(name
);
1190 if t
!(f
.file_type()).is_dir() {
1191 t
!(fs
::create_dir_all(&dst
));
1192 self.cp_r(&path
, &dst
);
1194 let _
= fs
::remove_file(&dst
);
1195 self.copy(&path
, &dst
);
1200 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1201 /// when this function is called. Unwanted files or directories can be skipped
1202 /// by returning `false` from the filter function.
1203 pub fn cp_filtered(&self, src
: &Path
, dst
: &Path
, filter
: &dyn Fn(&Path
) -> bool
) {
1204 // Immediately recurse with an empty relative path
1205 self.recurse_(src
, dst
, Path
::new(""), filter
)
1208 // Inner function does the actual work
1209 fn recurse_(&self, src
: &Path
, dst
: &Path
, relative
: &Path
, filter
: &dyn Fn(&Path
) -> bool
) {
1210 for f
in self.read_dir(src
) {
1211 let path
= f
.path();
1212 let name
= path
.file_name().unwrap();
1213 let dst
= dst
.join(name
);
1214 let relative
= relative
.join(name
);
1215 // Only copy file or directory if the filter function returns true
1216 if filter(&relative
) {
1217 if t
!(f
.file_type()).is_dir() {
1218 let _
= fs
::remove_dir_all(&dst
);
1219 self.create_dir(&dst
);
1220 self.recurse_(&path
, &dst
, &relative
, filter
);
1222 let _
= fs
::remove_file(&dst
);
1223 self.copy(&path
, &dst
);
1229 fn copy_to_folder(&self, src
: &Path
, dest_folder
: &Path
) {
1230 let file_name
= src
.file_name().unwrap();
1231 let dest
= dest_folder
.join(file_name
);
1232 self.copy(src
, &dest
);
1235 fn install(&self, src
: &Path
, dstdir
: &Path
, perms
: u32) {
1236 if self.config
.dry_run
{
1239 let dst
= dstdir
.join(src
.file_name().unwrap());
1240 self.verbose_than(1, &format
!("Install {:?} to {:?}", src
, dst
));
1241 t
!(fs
::create_dir_all(dstdir
));
1242 drop(fs
::remove_file(&dst
));
1245 panic
!("Error: File \"{}\" not found!", src
.display());
1247 let metadata
= t
!(src
.symlink_metadata());
1248 if let Err(e
) = fs
::copy(&src
, &dst
) {
1249 panic
!("failed to copy `{}` to `{}`: {}", src
.display(), dst
.display(), e
)
1251 t
!(fs
::set_permissions(&dst
, metadata
.permissions()));
1252 let atime
= FileTime
::from_last_access_time(&metadata
);
1253 let mtime
= FileTime
::from_last_modification_time(&metadata
);
1254 t
!(filetime
::set_file_times(&dst
, atime
, mtime
));
1259 fn create(&self, path
: &Path
, s
: &str) {
1260 if self.config
.dry_run
{
1263 t
!(fs
::write(path
, s
));
1266 fn read(&self, path
: &Path
) -> String
{
1267 if self.config
.dry_run
{
1268 return String
::new();
1270 t
!(fs
::read_to_string(path
))
1273 fn create_dir(&self, dir
: &Path
) {
1274 if self.config
.dry_run
{
1277 t
!(fs
::create_dir_all(dir
))
1280 fn remove_dir(&self, dir
: &Path
) {
1281 if self.config
.dry_run
{
1284 t
!(fs
::remove_dir_all(dir
))
1287 fn read_dir(&self, dir
: &Path
) -> impl Iterator
<Item
= fs
::DirEntry
> {
1288 let iter
= match fs
::read_dir(dir
) {
1290 Err(_
) if self.config
.dry_run
=> return vec
![].into_iter(),
1291 Err(err
) => panic
!("could not read dir {:?}: {:?}", dir
, err
),
1293 iter
.map(|e
| t
!(e
)).collect
::<Vec
<_
>>().into_iter()
1296 fn remove(&self, f
: &Path
) {
1297 if self.config
.dry_run
{
1300 fs
::remove_file(f
).unwrap_or_else(|_
| panic
!("failed to remove {:?}", f
));
1305 fn chmod(path
: &Path
, perms
: u32) {
1306 use std
::os
::unix
::fs
::*;
1307 t
!(fs
::set_permissions(path
, fs
::Permissions
::from_mode(perms
)));
1310 fn chmod(_path
: &Path
, _perms
: u32) {}
1313 pub fn with_stage(mut self, stage
: u32) -> Compiler
{
1318 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1319 pub fn is_snapshot(&self, build
: &Build
) -> bool
{
1320 self.stage
== 0 && self.host
== build
.build
1323 /// Returns if this compiler should be treated as a final stage one in the
1324 /// current build session.
1325 /// This takes into account whether we're performing a full bootstrap or
1326 /// not; don't directly compare the stage with `2`!
1327 pub fn is_final_stage(&self, build
: &Build
) -> bool
{
1328 let final_stage
= if build
.config
.full_bootstrap { 2 }
else { 1 }
;
1329 self.stage
>= final_stage
1333 fn envify(s
: &str) -> String
{
1339 .flat_map(|c
| c
.to_uppercase())