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 // Properties derived from the above configuration
224 rust_info: channel::GitInfo,
225 cargo_info: channel::GitInfo,
226 rls_info: channel::GitInfo,
227 rust_analyzer_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: TargetSelection,
239 hosts: Vec<TargetSelection>,
240 targets: Vec<TargetSelection>,
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<TargetSelection, cc::Tool>,
251 cxx: HashMap<TargetSelection, cc::Tool>,
252 ar: HashMap<TargetSelection, PathBuf>,
253 ranlib: HashMap<TargetSelection, PathBuf>,
255 crates: HashMap<Interned<String>, Crate>,
258 delayed_failures: RefCell<Vec<String>>,
259 prerelease_version: Cell<Option<u32>>,
261 RefCell<HashMap<TargetSelection, HashMap<String, (&'static str, PathBuf, Vec<String>)>>>,
266 name: Interned<String>,
267 deps: HashSet<Interned<String>>,
273 fn local_path(&self, build: &Build) -> PathBuf {
274 self.path.strip_prefix(&build.config.src).unwrap().into()
278 /// When building Rust various objects are handled differently.
279 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
280 pub enum DependencyType {
281 /// Libraries originating from proc-macros.
283 /// Typical Rust libraries.
285 /// Non Rust libraries and objects shipped to ease usage of certain targets.
289 /// The various "modes" of invoking Cargo.
291 /// These entries currently correspond to the various output directories of the
292 /// build system, with each mod generating output in a different directory.
293 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
295 /// Build the standard library, placing output in the "stageN-std" directory.
298 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
301 /// Build a tool, placing output in the "stage0-bootstrap-tools"
302 /// directory. This is for miscellaneous sets of tools that are built
303 /// using the bootstrap stage0 compiler in its entirety (target libraries
304 /// and all). Typically these tools compile with stable Rust.
307 /// Build a tool which uses the locally built std, placing output in the
308 /// "stageN-tools" directory. Its usage is quite rare, mainly used by
309 /// compiletest which needs libtest.
312 /// Build a tool which uses the locally built rustc and the target std,
313 /// placing the output in the "stageN-tools" directory. This is used for
314 /// anything that needs a fully functional rustc, such as rustdoc, clippy,
315 /// cargo, rls, rustfmt, miri, etc.
320 pub fn is_tool(&self) -> bool {
321 matches!(self, Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd)
326 /// Creates a new set of build configuration from the `flags` on the command
327 /// line and the filesystem `config`.
329 /// By default all build output will be placed in the current directory.
330 pub fn new(config: Config) -> Build {
331 let src = config.src.clone();
332 let out = config.out.clone();
334 let is_sudo = match env::var_os("SUDO_USER") {
335 Some(sudo_user) => match env::var_os("USER") {
336 Some(user) => user != sudo_user,
342 let ignore_git = config.ignore_git;
343 let rust_info = channel::GitInfo::new(ignore_git, &src);
344 let cargo_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/cargo"));
345 let rls_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rls"));
346 let rust_analyzer_info =
347 channel::GitInfo::new(ignore_git, &src.join("src/tools/rust-analyzer"));
348 let clippy_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/clippy"));
349 let miri_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/miri"));
350 let rustfmt_info = channel::GitInfo::new(ignore_git, &src.join("src/tools/rustfmt"));
352 // we always try to use git for LLVM builds
353 let in_tree_llvm_info = channel::GitInfo::new(false, &src.join("src/llvm-project"));
355 let initial_target_libdir_str = if config.dry_run {
356 "/dummy/lib/path/to/lib/".to_string()
359 Command::new(&config.initial_rustc)
361 .arg(config.build.rustc_target_arg())
363 .arg("target-libdir"),
366 let initial_target_dir = Path::new(&initial_target_libdir_str).parent().unwrap();
367 let initial_lld = initial_target_dir.join("bin").join("rust-lld");
369 let initial_sysroot = if config.dry_run {
372 output(Command::new(&config.initial_rustc).arg("--print").arg("sysroot"))
374 let initial_libdir = initial_target_dir
379 .strip_prefix(initial_sysroot.trim())
383 let mut build = Build {
384 initial_rustc: config.initial_rustc.clone(),
385 initial_cargo: config.initial_cargo.clone(),
388 local_rebuild: config.local_rebuild,
389 fail_fast: config.cmd.fail_fast(),
390 doc_tests: config.cmd.doc_tests(),
391 verbosity: config.verbose,
394 hosts: config.hosts.clone(),
395 targets: config.targets.clone(),
412 ranlib: HashMap::new(),
413 crates: HashMap::new(),
415 ci_env: CiEnv::current(),
416 delayed_failures: RefCell::new(Vec::new()),
417 prerelease_version: Cell::new(None),
418 tool_artifacts: Default::default(),
421 build.verbose("finding compilers");
422 cc_detect::find(&mut build);
423 build.verbose("running sanity check");
424 sanity::check(&mut build);
426 // If local-rust is the same major.minor as the current version, then force a
428 let local_version_verbose =
429 output(Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
430 let local_release = local_version_verbose
432 .filter_map(|x| x.strip_prefix("release:"))
436 let my_version = channel::CFG_RELEASE_NUM;
437 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
438 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
439 build.local_rebuild = true;
442 build.verbose("learning about cargo");
443 metadata::build(&mut build);
448 pub fn build_triple(&self) -> &[Interned<String>] {
449 slice::from_ref(&self.build.triple)
452 /// Executes the entire build, as configured by the flags and configuration.
453 pub fn build(&mut self) {
458 if let Subcommand::Format { check } = self.config.cmd {
459 return format::format(self, check);
462 if let Subcommand::Clean { all } = self.config.cmd {
463 return clean::clean(self, all);
467 let builder = builder::Builder::new(&self);
468 if let Some(path) = builder.paths.get(0) {
469 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
475 if !self.config.dry_run {
477 self.config.dry_run = true;
478 let builder = builder::Builder::new(&self);
479 builder.execute_cli();
481 self.config.dry_run = false;
482 let builder = builder::Builder::new(&self);
483 builder.execute_cli();
485 let builder = builder::Builder::new(&self);
486 builder.execute_cli();
489 // Check for postponed failures from `test --no-fail-fast`.
490 let failures = self.delayed_failures.borrow();
491 if failures.len() > 0 {
492 println!("\n{} command(s) did not execute successfully:\n", failures.len());
493 for failure in failures.iter() {
494 println!(" - {}\n", failure);
500 /// Clear out `dir` if `input` is newer.
502 /// After this executes, it will also ensure that `dir` exists.
503 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
504 let stamp = dir.join(".stamp");
505 let mut cleared = false;
506 if mtime(&stamp) < mtime(input) {
507 self.verbose(&format!("Dirty - {}", dir.display()));
508 let _ = fs::remove_dir_all(dir);
510 } else if stamp.exists() {
513 t!(fs::create_dir_all(dir));
514 t!(File::create(stamp));
518 /// Gets the space-separated set of activated features for the standard
520 fn std_features(&self) -> String {
521 let mut features = "panic-unwind".to_string();
523 if self.config.llvm_libunwind {
524 features.push_str(" llvm-libunwind");
526 if self.config.backtrace {
527 features.push_str(" backtrace");
529 if self.config.profiler {
530 features.push_str(" profiler");
535 /// Gets the space-separated set of activated features for the compiler.
536 fn rustc_features(&self) -> String {
537 let mut features = String::new();
538 if self.config.jemalloc {
539 features.push_str("jemalloc");
541 if self.config.llvm_enabled() {
542 features.push_str(" llvm");
545 // If debug logging is on, then we want the default for tracing:
546 // https://github.com/tokio-rs/tracing/blob/3dd5c03d907afdf2c39444a29931833335171554/tracing/src/level_filters.rs#L26
547 // which is everything (including debug/trace/etc.)
548 // if its unset, if debug_assertions is on, then debug_logging will also be on
549 // as well as tracing *ignoring* this feature when debug_assertions is on
550 if !self.config.rust_debug_logging {
551 features.push_str(" max_level_info");
557 /// Component directory that Cargo will produce output into (e.g.
559 fn cargo_dir(&self) -> &'static str {
560 if self.config.rust_optimize { "release" } else { "debug" }
563 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
566 .join(&*compiler.host.triple)
567 .join(format!("stage{}-tools-bin", compiler.stage));
568 t!(fs::create_dir_all(&out));
572 /// Returns the root directory for all output generated in a particular
573 /// stage when running with a particular host compiler.
575 /// The mode indicates what the root directory is for.
576 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
577 let suffix = match mode {
579 Mode::Rustc => "-rustc",
580 Mode::ToolBootstrap => "-bootstrap-tools",
581 Mode::ToolStd | Mode::ToolRustc => "-tools",
583 self.out.join(&*compiler.host.triple).join(format!("stage{}{}", compiler.stage, suffix))
586 /// Returns the root output directory for all Cargo output in a given stage,
587 /// running a particular compiler, whether or not we're building the
588 /// standard library, and targeting the specified architecture.
589 fn cargo_out(&self, compiler: Compiler, mode: Mode, target: TargetSelection) -> PathBuf {
590 self.stage_out(compiler, mode).join(&*target.triple).join(self.cargo_dir())
593 /// Root output directory for LLVM compiled for `target`
595 /// Note that if LLVM is configured externally then the directory returned
596 /// will likely be empty.
597 fn llvm_out(&self, target: TargetSelection) -> PathBuf {
598 self.out.join(&*target.triple).join("llvm")
601 fn lld_out(&self, target: TargetSelection) -> PathBuf {
602 self.out.join(&*target.triple).join("lld")
605 /// Output directory for all documentation for a target
606 fn doc_out(&self, target: TargetSelection) -> PathBuf {
607 self.out.join(&*target.triple).join("doc")
610 /// Output directory for all documentation for a target
611 fn compiler_doc_out(&self, target: TargetSelection) -> PathBuf {
612 self.out.join(&*target.triple).join("compiler-doc")
615 /// Output directory for some generated md crate documentation for a target (temporary)
616 fn md_doc_out(&self, target: TargetSelection) -> Interned<PathBuf> {
617 INTERNER.intern_path(self.out.join(&*target.triple).join("md-doc"))
620 /// Returns `true` if no custom `llvm-config` is set for the specified target.
622 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
623 fn is_rust_llvm(&self, target: TargetSelection) -> bool {
624 if self.config.llvm_from_ci && target == self.config.build {
628 match self.config.target_config.get(&target) {
629 Some(ref c) => c.llvm_config.is_none(),
634 /// Returns the path to `FileCheck` binary for the specified target
635 fn llvm_filecheck(&self, target: TargetSelection) -> PathBuf {
636 let target_config = self.config.target_config.get(&target);
637 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
639 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
640 let llvm_bindir = output(Command::new(s).arg("--bindir"));
641 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", target));
642 if filecheck.exists() {
645 // On Fedora the system LLVM installs FileCheck in the
646 // llvm subdirectory of the libdir.
647 let llvm_libdir = output(Command::new(s).arg("--libdir"));
649 Path::new(llvm_libdir.trim()).join("llvm").join(exe("FileCheck", target));
650 if lib_filecheck.exists() {
653 // Return the most normal file name, even though
654 // it doesn't exist, so that any error message
660 let base = self.llvm_out(self.config.build).join("build");
661 let base = if !self.ninja() && self.config.build.contains("msvc") {
662 if self.config.llvm_optimize {
663 if self.config.llvm_release_debuginfo {
664 base.join("RelWithDebInfo")
674 base.join("bin").join(exe("FileCheck", target))
678 /// Directory for libraries built from C/C++ code and shared between stages.
679 fn native_dir(&self, target: TargetSelection) -> PathBuf {
680 self.out.join(&*target.triple).join("native")
683 /// Root output directory for rust_test_helpers library compiled for
685 fn test_helpers_out(&self, target: TargetSelection) -> PathBuf {
686 self.native_dir(target).join("rust-test-helpers")
689 /// Adds the `RUST_TEST_THREADS` env var if necessary
690 fn add_rust_test_threads(&self, cmd: &mut Command) {
691 if env::var_os("RUST_TEST_THREADS").is_none() {
692 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
696 /// Returns the libdir of the snapshot compiler.
697 fn rustc_snapshot_libdir(&self) -> PathBuf {
698 self.rustc_snapshot_sysroot().join(libdir(self.config.build))
701 /// Returns the sysroot of the snapshot compiler.
702 fn rustc_snapshot_sysroot(&self) -> &Path {
703 self.initial_rustc.parent().unwrap().parent().unwrap()
706 /// Runs a command, printing out nice contextual information if it fails.
707 fn run(&self, cmd: &mut Command) {
708 if self.config.dry_run {
711 self.verbose(&format!("running: {:?}", cmd));
715 /// Runs a command, printing out nice contextual information if it fails.
716 fn run_quiet(&self, cmd: &mut Command) {
717 if self.config.dry_run {
720 self.verbose(&format!("running: {:?}", cmd));
724 /// Runs a command, printing out nice contextual information if it fails.
725 /// Exits if the command failed to execute at all, otherwise returns its
726 /// `status.success()`.
727 fn try_run(&self, cmd: &mut Command) -> bool {
728 if self.config.dry_run {
731 self.verbose(&format!("running: {:?}", cmd));
735 /// Runs a command, printing out nice contextual information if it fails.
736 /// Exits if the command failed to execute at all, otherwise returns its
737 /// `status.success()`.
738 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
739 if self.config.dry_run {
742 self.verbose(&format!("running: {:?}", cmd));
743 try_run_suppressed(cmd)
746 pub fn is_verbose(&self) -> bool {
750 /// Prints a message if this build is configured in verbose mode.
751 fn verbose(&self, msg: &str) {
752 if self.is_verbose() {
757 pub fn is_verbose_than(&self, level: usize) -> bool {
758 self.verbosity > level
761 /// Prints a message if this build is configured in more verbose mode than `level`.
762 fn verbose_than(&self, level: usize, msg: &str) {
763 if self.is_verbose_than(level) {
768 fn info(&self, msg: &str) {
769 if self.config.dry_run {
775 /// Returns the number of parallel jobs that have been configured for this
777 fn jobs(&self) -> u32 {
778 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
781 fn debuginfo_map_to(&self, which: GitRepo) -> Option<String> {
782 if !self.config.rust_remap_debuginfo {
788 let sha = self.rust_sha().unwrap_or(channel::CFG_RELEASE_NUM);
789 Some(format!("/rustc/{}", sha))
791 GitRepo::Llvm => Some(String::from("/rustc/llvm")),
795 /// Returns the path to the C compiler for the target specified.
796 fn cc(&self, target: TargetSelection) -> &Path {
797 self.cc[&target].path()
800 /// Returns a list of flags to pass to the C compiler for the target
802 fn cflags(&self, target: TargetSelection, which: GitRepo) -> Vec<String> {
803 // Filter out -O and /O (the optimization flags) that we picked up from
804 // cc-rs because the build scripts will determine that for themselves.
805 let mut base = self.cc[&target]
808 .map(|s| s.to_string_lossy().into_owned())
809 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
810 .collect::<Vec<String>>();
812 // If we're compiling on macOS then we add a few unconditional flags
813 // indicating that we want libc++ (more filled out than libstdc++) and
814 // we want to compile for 10.7. This way we can ensure that
815 // LLVM/etc are all properly compiled.
816 if target.contains("apple-darwin") {
817 base.push("-stdlib=libc++".into());
820 // Work around an apparently bad MinGW / GCC optimization,
821 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
822 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
823 if &*target.triple == "i686-pc-windows-gnu" {
824 base.push("-fno-omit-frame-pointer".into());
827 if let Some(map_to) = self.debuginfo_map_to(which) {
828 let map = format!("{}={}", self.src.display(), map_to);
829 let cc = self.cc(target);
830 if cc.ends_with("clang") || cc.ends_with("gcc") {
831 base.push(format!("-fdebug-prefix-map={}", map));
832 } else if cc.ends_with("clang-cl.exe") {
833 base.push("-Xclang".into());
834 base.push(format!("-fdebug-prefix-map={}", map));
840 /// Returns the path to the `ar` archive utility for the target specified.
841 fn ar(&self, target: TargetSelection) -> Option<&Path> {
842 self.ar.get(&target).map(|p| &**p)
845 /// Returns the path to the `ranlib` utility for the target specified.
846 fn ranlib(&self, target: TargetSelection) -> Option<&Path> {
847 self.ranlib.get(&target).map(|p| &**p)
850 /// Returns the path to the C++ compiler for the target specified.
851 fn cxx(&self, target: TargetSelection) -> Result<&Path, String> {
852 match self.cxx.get(&target) {
853 Some(p) => Ok(p.path()),
855 Err(format!("target `{}` is not configured as a host, only as a target", target))
860 /// Returns the path to the linker for the given target if it needs to be overridden.
861 fn linker(&self, target: TargetSelection) -> Option<&Path> {
862 if let Some(linker) = self.config.target_config.get(&target).and_then(|c| c.linker.as_ref())
865 } else if target.contains("vxworks") {
866 // need to use CXX compiler as linker to resolve the exception functions
867 // that are only existed in CXX libraries
868 Some(self.cxx[&target].path())
869 } else if target != self.config.build
870 && util::use_host_linker(target)
871 && !target.contains("msvc")
873 Some(self.cc(target))
874 } else if self.config.use_lld && !self.is_fuse_ld_lld(target) && self.build == target {
875 Some(&self.initial_lld)
881 // LLD is used through `-fuse-ld=lld` rather than directly.
882 // Only MSVC targets use LLD directly at the moment.
883 fn is_fuse_ld_lld(&self, target: TargetSelection) -> bool {
884 self.config.use_lld && !target.contains("msvc")
887 /// Returns if this target should statically link the C runtime, if specified
888 fn crt_static(&self, target: TargetSelection) -> Option<bool> {
889 if target.contains("pc-windows-msvc") {
892 self.config.target_config.get(&target).and_then(|t| t.crt_static)
896 /// Returns the "musl root" for this `target`, if defined
897 fn musl_root(&self, target: TargetSelection) -> Option<&Path> {
901 .and_then(|t| t.musl_root.as_ref())
902 .or_else(|| self.config.musl_root.as_ref())
906 /// Returns the "musl libdir" for this `target`.
907 fn musl_libdir(&self, target: TargetSelection) -> Option<PathBuf> {
908 let t = self.config.target_config.get(&target)?;
909 if let libdir @ Some(_) = &t.musl_libdir {
910 return libdir.clone();
912 self.musl_root(target).map(|root| root.join("lib"))
915 /// Returns the sysroot for the wasi target, if defined
916 fn wasi_root(&self, target: TargetSelection) -> Option<&Path> {
917 self.config.target_config.get(&target).and_then(|t| t.wasi_root.as_ref()).map(|p| &**p)
920 /// Returns `true` if this is a no-std `target`, if defined
921 fn no_std(&self, target: TargetSelection) -> Option<bool> {
922 self.config.target_config.get(&target).map(|t| t.no_std)
925 /// Returns `true` if the target will be tested using the `remote-test-client`
926 /// and `remote-test-server` binaries.
927 fn remote_tested(&self, target: TargetSelection) -> bool {
928 self.qemu_rootfs(target).is_some()
929 || target.contains("android")
930 || env::var_os("TEST_DEVICE_ADDR").is_some()
933 /// Returns the root of the "rootfs" image that this target will be using,
934 /// if one was configured.
936 /// If `Some` is returned then that means that tests for this target are
937 /// emulated with QEMU and binaries will need to be shipped to the emulator.
938 fn qemu_rootfs(&self, target: TargetSelection) -> Option<&Path> {
939 self.config.target_config.get(&target).and_then(|t| t.qemu_rootfs.as_ref()).map(|p| &**p)
942 /// Path to the python interpreter to use
943 fn python(&self) -> &Path {
944 self.config.python.as_ref().unwrap()
947 /// Temporary directory that extended error information is emitted to.
948 fn extended_error_dir(&self) -> PathBuf {
949 self.out.join("tmp/extended-error-metadata")
952 /// Tests whether the `compiler` compiling for `target` should be forced to
953 /// use a stage1 compiler instead.
955 /// Currently, by default, the build system does not perform a "full
956 /// bootstrap" by default where we compile the compiler three times.
957 /// Instead, we compile the compiler two times. The final stage (stage2)
958 /// just copies the libraries from the previous stage, which is what this
961 /// Here we return `true` if:
963 /// * The build isn't performing a full bootstrap
964 /// * The `compiler` is in the final stage, 2
965 /// * We're not cross-compiling, so the artifacts are already available in
968 /// When all of these conditions are met the build will lift artifacts from
969 /// the previous stage forward.
970 fn force_use_stage1(&self, compiler: Compiler, target: TargetSelection) -> bool {
971 !self.config.full_bootstrap
972 && compiler.stage >= 2
973 && (self.hosts.iter().any(|h| *h == target) || target == self.build)
976 /// Given `num` in the form "a.b.c" return a "release string" which
977 /// describes the release version number.
979 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
980 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
981 fn release(&self, num: &str) -> String {
982 match &self.config.channel[..] {
983 "stable" => num.to_string(),
985 if self.rust_info.is_git() {
986 format!("{}-beta.{}", num, self.beta_prerelease_version())
988 format!("{}-beta", num)
991 "nightly" => format!("{}-nightly", num),
992 _ => format!("{}-dev", num),
996 fn beta_prerelease_version(&self) -> u32 {
997 if let Some(s) = self.prerelease_version.get() {
1001 // Figure out how many merge commits happened since we branched off master.
1002 // That's our beta number!
1003 // (Note that we use a `..` range, not the `...` symmetric difference.)
1009 .arg("refs/remotes/origin/master..HEAD")
1010 .current_dir(&self.src),
1012 let n = count.trim().parse().unwrap();
1013 self.prerelease_version.set(Some(n));
1017 /// Returns the value of `release` above for Rust itself.
1018 fn rust_release(&self) -> String {
1019 self.release(channel::CFG_RELEASE_NUM)
1022 /// Returns the "package version" for a component given the `num` release
1025 /// The package version is typically what shows up in the names of tarballs.
1026 /// For channels like beta/nightly it's just the channel name, otherwise
1027 /// it's the `num` provided.
1028 fn package_vers(&self, num: &str) -> String {
1029 match &self.config.channel[..] {
1030 "stable" => num.to_string(),
1031 "beta" => "beta".to_string(),
1032 "nightly" => "nightly".to_string(),
1033 _ => format!("{}-dev", num),
1037 /// Returns the value of `package_vers` above for Rust itself.
1038 fn rust_package_vers(&self) -> String {
1039 self.package_vers(channel::CFG_RELEASE_NUM)
1042 /// Returns the value of `package_vers` above for Cargo
1043 fn cargo_package_vers(&self) -> String {
1044 self.package_vers(&self.release_num("cargo"))
1047 /// Returns the value of `package_vers` above for rls
1048 fn rls_package_vers(&self) -> String {
1049 self.package_vers(&self.release_num("rls"))
1052 /// Returns the value of `package_vers` above for rust-analyzer
1053 fn rust_analyzer_package_vers(&self) -> String {
1054 self.package_vers(&self.release_num("rust-analyzer/crates/rust-analyzer"))
1057 /// Returns the value of `package_vers` above for clippy
1058 fn clippy_package_vers(&self) -> String {
1059 self.package_vers(&self.release_num("clippy"))
1062 /// Returns the value of `package_vers` above for miri
1063 fn miri_package_vers(&self) -> String {
1064 self.package_vers(&self.release_num("miri"))
1067 /// Returns the value of `package_vers` above for rustfmt
1068 fn rustfmt_package_vers(&self) -> String {
1069 self.package_vers(&self.release_num("rustfmt"))
1072 fn llvm_tools_package_vers(&self) -> String {
1073 self.package_vers(channel::CFG_RELEASE_NUM)
1076 fn llvm_tools_vers(&self) -> String {
1080 fn llvm_link_tools_dynamically(&self, target: TargetSelection) -> bool {
1081 target.contains("linux-gnu") || target.contains("apple-darwin")
1084 /// Returns the `version` string associated with this compiler for Rust
1087 /// Note that this is a descriptive string which includes the commit date,
1088 /// sha, version, etc.
1089 fn rust_version(&self) -> String {
1090 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1093 /// Returns the full commit hash.
1094 fn rust_sha(&self) -> Option<&str> {
1095 self.rust_info.sha()
1098 /// Returns the `a.b.c` version that the given package is at.
1099 fn release_num(&self, package: &str) -> String {
1100 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1101 let toml = t!(fs::read_to_string(&toml_file_name));
1102 for line in toml.lines() {
1103 if let Some(stripped) =
1104 line.strip_prefix("version = \"").and_then(|s| s.strip_suffix("\""))
1106 return stripped.to_owned();
1110 panic!("failed to find version in {}'s Cargo.toml", package)
1113 /// Returns `true` if unstable features should be enabled for the compiler
1115 fn unstable_features(&self) -> bool {
1116 match &self.config.channel[..] {
1117 "stable" | "beta" => false,
1118 "nightly" | _ => true,
1122 /// Returns a Vec of all the dependencies of the given root crate,
1123 /// including transitive dependencies and the root itself. Only includes
1124 /// "local" crates (those in the local source tree, not from a registry).
1125 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1126 let mut ret = Vec::new();
1127 let mut list = vec![INTERNER.intern_str(root)];
1128 let mut visited = HashSet::new();
1129 while let Some(krate) = list.pop() {
1130 let krate = &self.crates[&krate];
1132 for dep in &krate.deps {
1133 // Don't include optional deps if their features are not
1134 // enabled. Ideally this would be computed from `cargo
1135 // metadata --features …`, but that is somewhat slow. Just
1136 // skip `build_helper` since there aren't any operations we
1137 // want to perform on it. In the future, we may want to
1138 // consider just filtering all build and dev dependencies in
1140 if visited.insert(dep)
1141 && dep != "build_helper"
1142 && (dep != "profiler_builtins" || self.config.profiler)
1143 && (dep != "rustc_codegen_llvm" || self.config.llvm_enabled())
1152 fn read_stamp_file(&self, stamp: &Path) -> Vec<(PathBuf, DependencyType)> {
1153 if self.config.dry_run {
1157 let mut paths = Vec::new();
1158 let contents = t!(fs::read(stamp), &stamp);
1159 // This is the method we use for extracting paths from the stamp file passed to us. See
1160 // run_cargo for more information (in compile.rs).
1161 for part in contents.split(|b| *b == 0) {
1162 if part.is_empty() {
1165 let dependency_type = match part[0] as char {
1166 'h' => DependencyType::Host,
1167 's' => DependencyType::TargetSelfContained,
1168 't' => DependencyType::Target,
1169 _ => unreachable!(),
1171 let path = PathBuf::from(t!(str::from_utf8(&part[1..])));
1172 paths.push((path, dependency_type));
1177 /// Copies a file from `src` to `dst`
1178 pub fn copy(&self, src: &Path, dst: &Path) {
1179 if self.config.dry_run {
1182 self.verbose_than(1, &format!("Copy {:?} to {:?}", src, dst));
1186 let _ = fs::remove_file(&dst);
1187 let metadata = t!(src.symlink_metadata());
1188 if metadata.file_type().is_symlink() {
1189 let link = t!(fs::read_link(src));
1190 t!(symlink_file(link, dst));
1191 } else if let Ok(()) = fs::hard_link(src, dst) {
1192 // Attempt to "easy copy" by creating a hard link
1193 // (symlinks don't work on windows), but if that fails
1194 // just fall back to a slow `copy` operation.
1196 if let Err(e) = fs::copy(src, dst) {
1197 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1199 t!(fs::set_permissions(dst, metadata.permissions()));
1200 let atime = FileTime::from_last_access_time(&metadata);
1201 let mtime = FileTime::from_last_modification_time(&metadata);
1202 t!(filetime::set_file_times(dst, atime, mtime));
1206 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1207 /// new string for each replacement.)
1208 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1209 if self.config.dry_run {
1212 let mut contents = String::new();
1213 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1214 t!(file.read_to_string(&mut contents));
1215 for &(target, replacement) in replacements {
1216 contents = contents.replace(target, replacement);
1218 t!(file.seek(SeekFrom::Start(0)));
1219 t!(file.set_len(0));
1220 t!(file.write_all(contents.as_bytes()));
1223 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1224 /// when this function is called.
1225 pub fn cp_r(&self, src: &Path, dst: &Path) {
1226 if self.config.dry_run {
1229 for f in self.read_dir(src) {
1230 let path = f.path();
1231 let name = path.file_name().unwrap();
1232 let dst = dst.join(name);
1233 if t!(f.file_type()).is_dir() {
1234 t!(fs::create_dir_all(&dst));
1235 self.cp_r(&path, &dst);
1237 let _ = fs::remove_file(&dst);
1238 self.copy(&path, &dst);
1243 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1244 /// when this function is called. Unwanted files or directories can be skipped
1245 /// by returning `false` from the filter function.
1246 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1247 // Immediately recurse with an empty relative path
1248 self.recurse_(src, dst, Path::new(""), filter)
1251 // Inner function does the actual work
1252 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1253 for f in self.read_dir(src) {
1254 let path = f.path();
1255 let name = path.file_name().unwrap();
1256 let dst = dst.join(name);
1257 let relative = relative.join(name);
1258 // Only copy file or directory if the filter function returns true
1259 if filter(&relative) {
1260 if t!(f.file_type()).is_dir() {
1261 let _ = fs::remove_dir_all(&dst);
1262 self.create_dir(&dst);
1263 self.recurse_(&path, &dst, &relative, filter);
1265 let _ = fs::remove_file(&dst);
1266 self.copy(&path, &dst);
1272 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1273 let file_name = src.file_name().unwrap();
1274 let dest = dest_folder.join(file_name);
1275 self.copy(src, &dest);
1278 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1279 if self.config.dry_run {
1282 let dst = dstdir.join(src.file_name().unwrap());
1283 self.verbose_than(1, &format!("Install {:?} to {:?}", src, dst));
1284 t!(fs::create_dir_all(dstdir));
1285 drop(fs::remove_file(&dst));
1288 panic!("Error: File \"{}\" not found!", src.display());
1290 let metadata = t!(src.symlink_metadata());
1291 if let Err(e) = fs::copy(&src, &dst) {
1292 panic!("failed to copy `{}` to `{}`: {}", src.display(), dst.display(), e)
1294 t!(fs::set_permissions(&dst, metadata.permissions()));
1295 let atime = FileTime::from_last_access_time(&metadata);
1296 let mtime = FileTime::from_last_modification_time(&metadata);
1297 t!(filetime::set_file_times(&dst, atime, mtime));
1302 fn create(&self, path: &Path, s: &str) {
1303 if self.config.dry_run {
1306 t!(fs::write(path, s));
1309 fn read(&self, path: &Path) -> String {
1310 if self.config.dry_run {
1311 return String::new();
1313 t!(fs::read_to_string(path))
1316 fn create_dir(&self, dir: &Path) {
1317 if self.config.dry_run {
1320 t!(fs::create_dir_all(dir))
1323 fn remove_dir(&self, dir: &Path) {
1324 if self.config.dry_run {
1327 t!(fs::remove_dir_all(dir))
1330 fn read_dir(&self, dir: &Path) -> impl Iterator<Item = fs::DirEntry> {
1331 let iter = match fs::read_dir(dir) {
1333 Err(_) if self.config.dry_run => return vec![].into_iter(),
1334 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1336 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1339 fn remove(&self, f: &Path) {
1340 if self.config.dry_run {
1343 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1346 /// Returns if config.ninja is enabled, and checks for ninja existence,
1347 /// exiting with a nicer error message if not.
1348 fn ninja(&self) -> bool {
1349 let mut cmd_finder = crate::sanity::Finder::new();
1351 if self.config.ninja_in_file {
1352 // Some Linux distros rename `ninja` to `ninja-build`.
1353 // CMake can work with either binary name.
1354 if cmd_finder.maybe_have("ninja-build").is_none()
1355 && cmd_finder.maybe_have("ninja").is_none()
1359 Couldn't find required command: ninja
1360 You should install ninja, or set ninja=false in config.toml
1363 std::process::exit(1);
1367 // If ninja isn't enabled but we're building for MSVC then we try
1368 // doubly hard to enable it. It was realized in #43767 that the msbuild
1369 // CMake generator for MSVC doesn't respect configuration options like
1370 // disabling LLVM assertions, which can often be quite important!
1372 // In these cases we automatically enable Ninja if we find it in the
1374 if !self.config.ninja_in_file && self.config.build.contains("msvc") {
1375 if cmd_finder.maybe_have("ninja").is_some() {
1380 self.config.ninja_in_file
1385 fn chmod(path: &Path, perms: u32) {
1386 use std::os::unix::fs::*;
1387 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1390 fn chmod(_path: &Path, _perms: u32) {}
1393 pub fn with_stage(mut self, stage: u32) -> Compiler {
1398 /// Returns `true` if this is a snapshot compiler for `build`'s configuration
1399 pub fn is_snapshot(&self, build: &Build) -> bool {
1400 self.stage == 0 && self.host == build.build
1403 /// Returns if this compiler should be treated as a final stage one in the
1404 /// current build session.
1405 /// This takes into account whether we're performing a full bootstrap or
1406 /// not; don't directly compare the stage with `2`!
1407 pub fn is_final_stage(&self, build: &Build) -> bool {
1408 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1409 self.stage >= final_stage
1413 fn envify(s: &str) -> String {
1419 .flat_map(|c| c.to_uppercase())