1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Implementation of rustbuild, the Rust build system.
13 //! This module, and its descendants, are the implementation of the Rust build
14 //! system. Most of this build system is backed by Cargo but the outer layer
15 //! here serves as the ability to orchestrate calling Cargo, sequencing Cargo
16 //! builds, building artifacts like LLVM, etc. The goals of rustbuild are:
18 //! * To be an easily understandable, easily extensible, and maintainable build
20 //! * Leverage standard tools in the Rust ecosystem to build the compiler, aka
21 //! crates.io and Cargo.
22 //! * A standard interface to build across all platforms, including MSVC
26 //! The build system defers most of the complicated logic managing invocations
27 //! of rustc and rustdoc to Cargo itself. However, moving through various stages
28 //! and copying artifacts is still necessary for it to do. Each time rustbuild
29 //! is invoked, it will iterate through the list of predefined steps and execute
30 //! each serially in turn if it matches the paths passed or is a default rule.
31 //! For each step rustbuild relies on the step internally being incremental and
32 //! parallel. Note, though, that the `-j` parameter to rustbuild gets forwarded
33 //! to appropriate test harnesses and such.
35 //! Most of the "meaty" steps that matter are backed by Cargo, which does indeed
36 //! have its own parallelism and incremental management. Later steps, like
37 //! tests, aren't incremental and simply run the entire suite currently.
38 //! However, compiletest itself tries to avoid running tests when the artifacts
39 //! that are involved (mainly the compiler) haven't changed.
41 //! When you execute `x.py build`, the steps executed are:
43 //! * First, the python script is run. This will automatically download the
44 //! stage0 rustc and cargo according to `src/stage0.txt`, or use the cached
45 //! versions if they're available. These are then used to compile rustbuild
46 //! itself (using Cargo). Finally, control is then transferred to rustbuild.
48 //! * Rustbuild takes over, performs sanity checks, probes the environment,
49 //! reads configuration, and starts executing steps as it reads the command
50 //! line arguments (paths) or going through the default rules.
52 //! The build output will be something like the following:
54 //! Building stage0 std artifacts
55 //! Copying stage0 std
56 //! Building stage0 test artifacts
57 //! Copying stage0 test
58 //! Building stage0 compiler artifacts
59 //! Copying stage0 rustc
60 //! Assembling stage1 compiler
61 //! Building stage1 std artifacts
62 //! Copying stage1 std
63 //! Building stage1 test artifacts
64 //! Copying stage1 test
65 //! Building stage1 compiler artifacts
66 //! Copying stage1 rustc
67 //! Assembling stage2 compiler
68 //! Uplifting stage1 std
69 //! Uplifting stage1 test
70 //! Uplifting stage1 rustc
72 //! Let's disect that a little:
74 //! ## Building stage0 {std,test,compiler} artifacts
76 //! These steps use the provided (downloaded, usually) compiler to compile the
77 //! local Rust source into libraries we can use.
79 //! ## Copying stage0 {std,test,rustc}
81 //! This copies the build output from Cargo into
82 //! `build/$HOST/stage0-sysroot/lib/rustlib/$ARCH/lib`. FIXME: This step's
83 //! documentation should be expanded -- the information already here may be
86 //! ## Assembling stage1 compiler
88 //! This copies the libraries we built in "building stage0 ... artifacts" into
89 //! the stage1 compiler's lib directory. These are the host libraries that the
90 //! compiler itself uses to run. These aren't actually used by artifacts the new
91 //! compiler generates. This step also copies the rustc and rustdoc binaries we
92 //! generated into build/$HOST/stage/bin.
94 //! The stage1/bin/rustc is a fully functional compiler, but it doesn't yet have
95 //! any libraries to link built binaries or libraries to. The next 3 steps will
96 //! provide those libraries for it; they are mostly equivalent to constructing
97 //! the stage1/bin compiler so we don't go through them individually.
99 //! ## Uplifting stage1 {std,test,rustc}
101 //! This step copies the libraries from the stage1 compiler sysroot into the
102 //! stage2 compiler. This is done to avoid rebuilding the compiler; libraries
103 //! we'd build in this step should be identical (in function, if not necessarily
104 //! identical on disk) so there's no need to recompile the compiler again. Note
105 //! that if you want to, you can enable the full-bootstrap option to change this
108 //! Each step is driven by a separate Cargo project and rustbuild orchestrates
109 //! copying files between steps and otherwise preparing for Cargo to run.
111 //! ## Further information
113 //! More documentation can be found in each respective module below, and you can
114 //! also check out the `src/bootstrap/README.md` file for more information.
116 #![deny(bare_trait_objects)]
118 #![feature(core_intrinsics)]
119 #![feature(drain_filter)]
122 extern crate build_helper;
124 extern crate serde_derive;
126 extern crate lazy_static;
127 extern crate serde_json;
129 extern crate filetime;
131 extern crate getopts;
132 extern crate num_cpus;
135 extern crate petgraph;
139 extern crate pretty_assertions;
144 use std::cell::{RefCell, Cell};
145 use std::collections::{HashSet, HashMap};
147 use std::fs::{self, OpenOptions, File};
148 use std::io::{self, Seek, SeekFrom, Write, Read};
149 use std::path::{PathBuf, Path};
150 use std::process::{self, Command};
155 use std::os::unix::fs::symlink as symlink_file;
157 use std::os::windows::fs::symlink_file;
159 use build_helper::{run_silent, run_suppressed, try_run_silent, try_run_suppressed, output, mtime};
160 use filetime::FileTime;
162 use crate::util::{exe, libdir, OutputFolder, CiEnv};
187 #[cfg(all(unix, not(target_os = "haiku")))]
191 pub unsafe fn setup(build: &mut crate::Build) {
192 if build.config.low_priority {
193 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
198 #[cfg(any(target_os = "haiku", not(any(unix, windows))))]
200 pub unsafe fn setup(_build: &mut crate::Build) {
204 pub use crate::config::Config;
205 use crate::flags::Subcommand;
206 use crate::cache::{Interned, INTERNER};
207 use crate::toolstate::ToolState;
209 const LLVM_TOOLS: &[&str] = &[
210 "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
211 "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
212 "llvm-objdump", // used to disassemble programs
213 "llvm-profdata", // used to inspect and merge files generated by profiles
214 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
215 "llvm-size", // used to prints the size of the linker sections of a program
216 "llvm-strip", // used to discard symbols from binary files to reduce their size
219 /// A structure representing a Rust compiler.
221 /// Each compiler has a `stage` that it is associated with and a `host` that
222 /// corresponds to the platform the compiler runs on. This structure is used as
223 /// a parameter to many methods below.
224 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
225 pub struct Compiler {
227 host: Interned<String>,
230 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
232 // Default, run normal tests and doc tests.
234 // Do not run any doc tests.
236 // Only run doc tests.
245 /// Global configuration for the build system.
247 /// This structure transitively contains all configuration for the build system.
248 /// All filesystem-encoded configuration is in `config`, all flags are in
249 /// `flags`, and then parsed or probed information is listed in the keys below.
251 /// This structure is a parameter of almost all methods in the build system,
252 /// although most functions are implemented as free functions rather than
253 /// methods specifically on this structure itself (to make it easier to
256 // User-specified configuration via config.toml
259 // Derived properties from the above two configurations
262 rust_info: channel::GitInfo,
263 cargo_info: channel::GitInfo,
264 rls_info: channel::GitInfo,
265 clippy_info: channel::GitInfo,
266 rustfmt_info: channel::GitInfo,
272 // Targets for which to build.
273 build: Interned<String>,
274 hosts: Vec<Interned<String>>,
275 targets: Vec<Interned<String>>,
277 // Stage 0 (downloaded) compiler and cargo or their local rust equivalents.
278 initial_rustc: PathBuf,
279 initial_cargo: PathBuf,
281 // Runtime state filled in later on
282 // C/C++ compilers and archiver for all targets
283 cc: HashMap<Interned<String>, cc::Tool>,
284 cxx: HashMap<Interned<String>, cc::Tool>,
285 ar: HashMap<Interned<String>, PathBuf>,
286 ranlib: HashMap<Interned<String>, PathBuf>,
288 crates: HashMap<Interned<String>, Crate>,
291 delayed_failures: RefCell<Vec<String>>,
292 prerelease_version: Cell<Option<u32>>,
293 tool_artifacts: RefCell<HashMap<
295 HashMap<String, (&'static str, PathBuf, Vec<String>)>
301 name: Interned<String>,
303 deps: HashSet<Interned<String>>,
313 fn is_local(&self, build: &Build) -> bool {
314 self.path.starts_with(&build.config.src) &&
315 !self.path.to_string_lossy().ends_with("_shim")
318 fn local_path(&self, build: &Build) -> PathBuf {
319 assert!(self.is_local(build));
320 self.path.strip_prefix(&build.config.src).unwrap().into()
324 /// The various "modes" of invoking Cargo.
326 /// These entries currently correspond to the various output directories of the
327 /// build system, with each mod generating output in a different directory.
328 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
330 /// Build the standard library, placing output in the "stageN-std" directory.
333 /// Build libtest, placing output in the "stageN-test" directory.
336 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
339 /// Build codegen libraries, placing output in the "stageN-codegen" directory
342 /// Build some tools, placing output in the "stageN-tools" directory. The
343 /// "other" here is for miscellaneous sets of tools that are built using the
344 /// bootstrap compiler in its entirety (target libraries and all).
345 /// Typically these tools compile with stable Rust.
348 /// Compile a tool which uses all libraries we compile (up to rustc).
349 /// Doesn't use the stage0 compiler libraries like "other", and includes
350 /// tools like rustdoc, cargo, rls, etc.
357 pub fn is_tool(&self) -> bool {
359 Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd => true,
366 /// Creates a new set of build configuration from the `flags` on the command
367 /// line and the filesystem `config`.
369 /// By default all build output will be placed in the current directory.
370 pub fn new(config: Config) -> Build {
371 let src = config.src.clone();
372 let out = config.out.clone();
374 let is_sudo = match env::var_os("SUDO_USER") {
376 match env::var_os("USER") {
377 Some(user) => user != sudo_user,
383 let rust_info = channel::GitInfo::new(&config, &src);
384 let cargo_info = channel::GitInfo::new(&config, &src.join("src/tools/cargo"));
385 let rls_info = channel::GitInfo::new(&config, &src.join("src/tools/rls"));
386 let clippy_info = channel::GitInfo::new(&config, &src.join("src/tools/clippy"));
387 let rustfmt_info = channel::GitInfo::new(&config, &src.join("src/tools/rustfmt"));
389 let mut build = Build {
390 initial_rustc: config.initial_rustc.clone(),
391 initial_cargo: config.initial_cargo.clone(),
392 local_rebuild: config.local_rebuild,
393 fail_fast: config.cmd.fail_fast(),
394 doc_tests: config.cmd.doc_tests(),
395 verbosity: config.verbose,
398 hosts: config.hosts.clone(),
399 targets: config.targets.clone(),
413 ranlib: HashMap::new(),
414 crates: HashMap::new(),
416 ci_env: CiEnv::current(),
417 delayed_failures: RefCell::new(Vec::new()),
418 prerelease_version: Cell::new(None),
419 tool_artifacts: Default::default(),
422 build.verbose("finding compilers");
423 cc_detect::find(&mut build);
424 build.verbose("running sanity check");
425 sanity::check(&mut build);
427 // If local-rust is the same major.minor as the current version, then force a
429 let local_version_verbose = output(
430 Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
431 let local_release = local_version_verbose
432 .lines().filter(|x| x.starts_with("release:"))
433 .next().unwrap().trim_left_matches("release:").trim();
434 let my_version = channel::CFG_RELEASE_NUM;
435 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
436 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
437 build.local_rebuild = true;
440 build.verbose("learning about cargo");
441 metadata::build(&mut build);
446 pub fn build_triple(&self) -> &[Interned<String>] {
448 slice::from_raw_parts(&self.build, 1)
452 /// Executes the entire build, as configured by the flags and configuration.
453 pub fn build(&mut self) {
458 if let Subcommand::Clean { all } = self.config.cmd {
459 return clean::clean(self, all);
463 let builder = builder::Builder::new(&self);
464 if let Some(path) = builder.paths.get(0) {
465 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
471 if !self.config.dry_run {
473 self.config.dry_run = true;
474 let builder = builder::Builder::new(&self);
475 builder.execute_cli();
477 self.config.dry_run = false;
478 let builder = builder::Builder::new(&self);
479 builder.execute_cli();
481 let builder = builder::Builder::new(&self);
482 let _ = builder.execute_cli();
485 // Check for postponed failures from `test --no-fail-fast`.
486 let failures = self.delayed_failures.borrow();
487 if failures.len() > 0 {
488 println!("\n{} command(s) did not execute successfully:\n", failures.len());
489 for failure in failures.iter() {
490 println!(" - {}\n", failure);
496 /// Clear out `dir` if `input` is newer.
498 /// After this executes, it will also ensure that `dir` exists.
499 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
500 let stamp = dir.join(".stamp");
501 let mut cleared = false;
502 if mtime(&stamp) < mtime(input) {
503 self.verbose(&format!("Dirty - {}", dir.display()));
504 let _ = fs::remove_dir_all(dir);
506 } else if stamp.exists() {
509 t!(fs::create_dir_all(dir));
510 t!(File::create(stamp));
514 /// Get the space-separated set of activated features for the standard
516 fn std_features(&self) -> String {
517 let mut features = "panic-unwind".to_string();
519 if self.config.backtrace {
520 features.push_str(" backtrace");
522 if self.config.profiler {
523 features.push_str(" profiler");
525 if self.config.wasm_syscall {
526 features.push_str(" wasm_syscall");
531 /// Get the space-separated set of activated features for the compiler.
532 fn rustc_features(&self) -> String {
533 let mut features = String::new();
534 if self.config.jemalloc {
535 features.push_str("jemalloc");
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::Test => "-test",
560 Mode::Rustc => "-rustc",
561 Mode::Codegen => "-codegen",
562 Mode::ToolBootstrap => "-bootstrap-tools",
563 Mode::ToolStd => "-tools",
564 Mode::ToolTest => "-tools",
565 Mode::ToolRustc => "-tools",
567 self.out.join(&*compiler.host)
568 .join(format!("stage{}{}", compiler.stage, suffix))
571 /// Returns the root output directory for all Cargo output in a given stage,
572 /// running a particular compiler, whether or not we're building the
573 /// standard library, and targeting the specified architecture.
577 target: Interned<String>) -> PathBuf {
578 self.stage_out(compiler, mode).join(&*target).join(self.cargo_dir())
581 /// Root output directory for LLVM compiled for `target`
583 /// Note that if LLVM is configured externally then the directory returned
584 /// will likely be empty.
585 fn llvm_out(&self, target: Interned<String>) -> PathBuf {
586 self.out.join(&*target).join("llvm")
589 fn emscripten_llvm_out(&self, target: Interned<String>) -> PathBuf {
590 self.out.join(&*target).join("llvm-emscripten")
593 fn lld_out(&self, target: Interned<String>) -> PathBuf {
594 self.out.join(&*target).join("lld")
597 /// Output directory for all documentation for a target
598 fn doc_out(&self, target: Interned<String>) -> PathBuf {
599 self.out.join(&*target).join("doc")
602 /// Output directory for all documentation for a target
603 fn compiler_doc_out(&self, target: Interned<String>) -> PathBuf {
604 self.out.join(&*target).join("compiler-doc")
607 /// Output directory for some generated md crate documentation for a target (temporary)
608 fn md_doc_out(&self, target: Interned<String>) -> Interned<PathBuf> {
609 INTERNER.intern_path(self.out.join(&*target).join("md-doc"))
612 /// Output directory for all crate documentation for a target (temporary)
614 /// The artifacts here are then copied into `doc_out` above.
615 fn crate_doc_out(&self, target: Interned<String>) -> PathBuf {
616 self.out.join(&*target).join("crate-docs")
619 /// Returns true if no custom `llvm-config` is set for the specified target.
621 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
622 fn is_rust_llvm(&self, target: Interned<String>) -> bool {
623 match self.config.target_config.get(&target) {
624 Some(ref c) => c.llvm_config.is_none(),
629 /// Returns the path to `FileCheck` binary for the specified target
630 fn llvm_filecheck(&self, target: Interned<String>) -> PathBuf {
631 let target_config = self.config.target_config.get(&target);
632 if let Some(s) = target_config.and_then(|c| c.llvm_filecheck.as_ref()) {
634 } else if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
635 let llvm_bindir = output(Command::new(s).arg("--bindir"));
636 let filecheck = Path::new(llvm_bindir.trim()).join(exe("FileCheck", &*target));
637 if filecheck.exists() {
640 // On Fedora the system LLVM installs FileCheck in the
641 // llvm subdirectory of the libdir.
642 let llvm_libdir = output(Command::new(s).arg("--libdir"));
643 let lib_filecheck = Path::new(llvm_libdir.trim())
644 .join("llvm").join(exe("FileCheck", &*target));
645 if lib_filecheck.exists() {
648 // Return the most normal file name, even though
649 // it doesn't exist, so that any error message
655 let base = self.llvm_out(self.config.build).join("build");
656 let base = if !self.config.ninja && self.config.build.contains("msvc") {
657 if self.config.llvm_optimize {
658 if self.config.llvm_release_debuginfo {
659 base.join("RelWithDebInfo")
669 base.join("bin").join(exe("FileCheck", &*target))
673 /// Directory for libraries built from C/C++ code and shared between stages.
674 fn native_dir(&self, target: Interned<String>) -> PathBuf {
675 self.out.join(&*target).join("native")
678 /// Root output directory for rust_test_helpers library compiled for
680 fn test_helpers_out(&self, target: Interned<String>) -> PathBuf {
681 self.native_dir(target).join("rust-test-helpers")
684 /// Adds the `RUST_TEST_THREADS` env var if necessary
685 fn add_rust_test_threads(&self, cmd: &mut Command) {
686 if env::var_os("RUST_TEST_THREADS").is_none() {
687 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
691 /// Returns the libdir of the snapshot compiler.
692 fn rustc_snapshot_libdir(&self) -> PathBuf {
693 self.rustc_snapshot_sysroot().join(libdir(&self.config.build))
696 /// Returns the sysroot of the snapshot compiler.
697 fn rustc_snapshot_sysroot(&self) -> &Path {
698 self.initial_rustc.parent().unwrap().parent().unwrap()
701 /// Runs a command, printing out nice contextual information if it fails.
702 fn run(&self, cmd: &mut Command) {
703 if self.config.dry_run { return; }
704 self.verbose(&format!("running: {:?}", cmd));
708 /// Runs a command, printing out nice contextual information if it fails.
709 fn run_quiet(&self, cmd: &mut Command) {
710 if self.config.dry_run { return; }
711 self.verbose(&format!("running: {:?}", cmd));
715 /// Runs a command, printing out nice contextual information if it fails.
716 /// Exits if the command failed to execute at all, otherwise returns its
717 /// `status.success()`.
718 fn try_run(&self, cmd: &mut Command) -> bool {
719 if self.config.dry_run { return true; }
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_quiet(&self, cmd: &mut Command) -> bool {
728 if self.config.dry_run { return true; }
729 self.verbose(&format!("running: {:?}", cmd));
730 try_run_suppressed(cmd)
733 pub fn is_verbose(&self) -> bool {
737 /// Prints a message if this build is configured in verbose mode.
738 fn verbose(&self, msg: &str) {
739 if self.is_verbose() {
744 fn info(&self, msg: &str) {
745 if self.config.dry_run { return; }
749 /// Returns the number of parallel jobs that have been configured for this
751 fn jobs(&self) -> u32 {
752 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
755 fn debuginfo_map(&self, which: GitRepo) -> Option<String> {
756 if !self.config.rust_remap_debuginfo {
760 let path = match which {
762 let sha = self.rust_sha().unwrap_or(channel::CFG_RELEASE_NUM);
763 format!("/rustc/{}", sha)
765 GitRepo::Llvm => String::from("/rustc/llvm"),
767 Some(format!("{}={}", self.src.display(), path))
770 /// Returns the path to the C compiler for the target specified.
771 fn cc(&self, target: Interned<String>) -> &Path {
772 self.cc[&target].path()
775 /// Returns a list of flags to pass to the C compiler for the target
777 fn cflags(&self, target: Interned<String>, which: GitRepo) -> Vec<String> {
778 // Filter out -O and /O (the optimization flags) that we picked up from
779 // cc-rs because the build scripts will determine that for themselves.
780 let mut base = self.cc[&target].args().iter()
781 .map(|s| s.to_string_lossy().into_owned())
782 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
783 .collect::<Vec<String>>();
785 // If we're compiling on macOS then we add a few unconditional flags
786 // indicating that we want libc++ (more filled out than libstdc++) and
787 // we want to compile for 10.7. This way we can ensure that
788 // LLVM/etc are all properly compiled.
789 if target.contains("apple-darwin") {
790 base.push("-stdlib=libc++".into());
793 // Work around an apparently bad MinGW / GCC optimization,
794 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
795 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
796 if &*target == "i686-pc-windows-gnu" {
797 base.push("-fno-omit-frame-pointer".into());
800 if let Some(map) = self.debuginfo_map(which) {
801 let cc = self.cc(target);
802 if cc.ends_with("clang") || cc.ends_with("gcc") {
803 base.push(format!("-fdebug-prefix-map={}", map));
804 } else if cc.ends_with("clang-cl.exe") {
805 base.push("-Xclang".into());
806 base.push(format!("-fdebug-prefix-map={}", map));
812 /// Returns the path to the `ar` archive utility for the target specified.
813 fn ar(&self, target: Interned<String>) -> Option<&Path> {
814 self.ar.get(&target).map(|p| &**p)
817 /// Returns the path to the `ranlib` utility for the target specified.
818 fn ranlib(&self, target: Interned<String>) -> Option<&Path> {
819 self.ranlib.get(&target).map(|p| &**p)
822 /// Returns the path to the C++ compiler for the target specified.
823 fn cxx(&self, target: Interned<String>) -> Result<&Path, String> {
824 match self.cxx.get(&target) {
825 Some(p) => Ok(p.path()),
827 "target `{}` is not configured as a host, only as a target",
832 /// Returns the path to the linker for the given target if it needs to be overridden.
833 fn linker(&self, target: Interned<String>) -> Option<&Path> {
834 if let Some(linker) = self.config.target_config.get(&target)
835 .and_then(|c| c.linker.as_ref()) {
837 } else if target != self.config.build &&
838 !target.contains("msvc") &&
839 !target.contains("emscripten") &&
840 !target.contains("wasm32") &&
841 !target.contains("fuchsia") {
842 Some(self.cc(target))
848 /// Returns if this target should statically link the C runtime, if specified
849 fn crt_static(&self, target: Interned<String>) -> Option<bool> {
850 if target.contains("pc-windows-msvc") {
853 self.config.target_config.get(&target)
854 .and_then(|t| t.crt_static)
858 /// Returns the "musl root" for this `target`, if defined
859 fn musl_root(&self, target: Interned<String>) -> Option<&Path> {
860 self.config.target_config.get(&target)
861 .and_then(|t| t.musl_root.as_ref())
862 .or(self.config.musl_root.as_ref())
866 /// Returns true if this is a no-std `target`, if defined
867 fn no_std(&self, target: Interned<String>) -> Option<bool> {
868 self.config.target_config.get(&target)
872 /// Returns whether the target will be tested using the `remote-test-client`
873 /// and `remote-test-server` binaries.
874 fn remote_tested(&self, target: Interned<String>) -> bool {
875 self.qemu_rootfs(target).is_some() || target.contains("android") ||
876 env::var_os("TEST_DEVICE_ADDR").is_some()
879 /// Returns the root of the "rootfs" image that this target will be using,
880 /// if one was configured.
882 /// If `Some` is returned then that means that tests for this target are
883 /// emulated with QEMU and binaries will need to be shipped to the emulator.
884 fn qemu_rootfs(&self, target: Interned<String>) -> Option<&Path> {
885 self.config.target_config.get(&target)
886 .and_then(|t| t.qemu_rootfs.as_ref())
890 /// Path to the python interpreter to use
891 fn python(&self) -> &Path {
892 self.config.python.as_ref().unwrap()
895 /// Temporary directory that extended error information is emitted to.
896 fn extended_error_dir(&self) -> PathBuf {
897 self.out.join("tmp/extended-error-metadata")
900 /// Tests whether the `compiler` compiling for `target` should be forced to
901 /// use a stage1 compiler instead.
903 /// Currently, by default, the build system does not perform a "full
904 /// bootstrap" by default where we compile the compiler three times.
905 /// Instead, we compile the compiler two times. The final stage (stage2)
906 /// just copies the libraries from the previous stage, which is what this
909 /// Here we return `true` if:
911 /// * The build isn't performing a full bootstrap
912 /// * The `compiler` is in the final stage, 2
913 /// * We're not cross-compiling, so the artifacts are already available in
916 /// When all of these conditions are met the build will lift artifacts from
917 /// the previous stage forward.
918 fn force_use_stage1(&self, compiler: Compiler, target: Interned<String>) -> bool {
919 !self.config.full_bootstrap &&
920 compiler.stage >= 2 &&
921 (self.hosts.iter().any(|h| *h == target) || target == self.build)
924 /// Given `num` in the form "a.b.c" return a "release string" which
925 /// describes the release version number.
927 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
928 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
929 fn release(&self, num: &str) -> String {
930 match &self.config.channel[..] {
931 "stable" => num.to_string(),
932 "beta" => if self.rust_info.is_git() {
933 format!("{}-beta.{}", num, self.beta_prerelease_version())
935 format!("{}-beta", num)
937 "nightly" => format!("{}-nightly", num),
938 _ => format!("{}-dev", num),
942 fn beta_prerelease_version(&self) -> u32 {
943 if let Some(s) = self.prerelease_version.get() {
952 .current_dir(&self.src)
954 let beta = beta.trim().split_whitespace().next().unwrap();
960 .current_dir(&self.src)
962 let master = master.trim().split_whitespace().next().unwrap();
964 // Figure out where the current beta branch started.
970 .current_dir(&self.src),
972 let base = base.trim();
974 // Next figure out how many merge commits happened since we branched off
975 // beta. That's our beta number!
981 .arg(format!("{}...HEAD", base))
982 .current_dir(&self.src),
984 let n = count.trim().parse().unwrap();
985 self.prerelease_version.set(Some(n));
989 /// Returns the value of `release` above for Rust itself.
990 fn rust_release(&self) -> String {
991 self.release(channel::CFG_RELEASE_NUM)
994 /// Returns the "package version" for a component given the `num` release
997 /// The package version is typically what shows up in the names of tarballs.
998 /// For channels like beta/nightly it's just the channel name, otherwise
999 /// it's the `num` provided.
1000 fn package_vers(&self, num: &str) -> String {
1001 match &self.config.channel[..] {
1002 "stable" => num.to_string(),
1003 "beta" => "beta".to_string(),
1004 "nightly" => "nightly".to_string(),
1005 _ => format!("{}-dev", num),
1009 /// Returns the value of `package_vers` above for Rust itself.
1010 fn rust_package_vers(&self) -> String {
1011 self.package_vers(channel::CFG_RELEASE_NUM)
1014 /// Returns the value of `package_vers` above for Cargo
1015 fn cargo_package_vers(&self) -> String {
1016 self.package_vers(&self.release_num("cargo"))
1019 /// Returns the value of `package_vers` above for rls
1020 fn rls_package_vers(&self) -> String {
1021 self.package_vers(&self.release_num("rls"))
1024 /// Returns the value of `package_vers` above for clippy
1025 fn clippy_package_vers(&self) -> String {
1026 self.package_vers(&self.release_num("clippy"))
1029 /// Returns the value of `package_vers` above for rustfmt
1030 fn rustfmt_package_vers(&self) -> String {
1031 self.package_vers(&self.release_num("rustfmt"))
1034 fn llvm_tools_package_vers(&self) -> String {
1035 self.package_vers(&self.rust_version())
1038 fn llvm_tools_vers(&self) -> String {
1042 fn lldb_package_vers(&self) -> String {
1043 self.package_vers(&self.rust_version())
1046 fn lldb_vers(&self) -> String {
1050 fn llvm_link_tools_dynamically(&self, target: Interned<String>) -> bool {
1051 (target.contains("linux-gnu") || target.contains("apple-darwin"))
1054 /// Returns the `version` string associated with this compiler for Rust
1057 /// Note that this is a descriptive string which includes the commit date,
1058 /// sha, version, etc.
1059 fn rust_version(&self) -> String {
1060 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1063 /// Return the full commit hash
1064 fn rust_sha(&self) -> Option<&str> {
1065 self.rust_info.sha()
1068 /// Returns the `a.b.c` version that the given package is at.
1069 fn release_num(&self, package: &str) -> String {
1070 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1071 let toml = t!(fs::read_to_string(&toml_file_name));
1072 for line in toml.lines() {
1073 let prefix = "version = \"";
1075 if line.starts_with(prefix) && line.ends_with(suffix) {
1076 return line[prefix.len()..line.len() - suffix.len()].to_string()
1080 panic!("failed to find version in {}'s Cargo.toml", package)
1083 /// Returns whether unstable features should be enabled for the compiler
1085 fn unstable_features(&self) -> bool {
1086 match &self.config.channel[..] {
1087 "stable" | "beta" => false,
1088 "nightly" | _ => true,
1092 /// Fold the output of the commands after this method into a group. The fold
1093 /// ends when the returned object is dropped. Folding can only be used in
1094 /// the Travis CI environment.
1095 pub fn fold_output<D, F>(&self, name: F) -> Option<OutputFolder>
1096 where D: Into<String>, F: FnOnce() -> D
1098 if !self.config.dry_run && self.ci_env == CiEnv::Travis {
1099 Some(OutputFolder::new(name().into()))
1105 /// Updates the actual toolstate of a tool.
1107 /// The toolstates are saved to the file specified by the key
1108 /// `rust.save-toolstates` in `config.toml`. If unspecified, nothing will be
1109 /// done. The file is updated immediately after this function completes.
1110 pub fn save_toolstate(&self, tool: &str, state: ToolState) {
1111 use std::io::{Seek, SeekFrom};
1113 if let Some(ref path) = self.config.save_toolstates {
1114 let mut file = t!(fs::OpenOptions::new()
1120 let mut current_toolstates: HashMap<Box<str>, ToolState> =
1121 serde_json::from_reader(&mut file).unwrap_or_default();
1122 current_toolstates.insert(tool.into(), state);
1123 t!(file.seek(SeekFrom::Start(0)));
1124 t!(file.set_len(0));
1125 t!(serde_json::to_writer(file, ¤t_toolstates));
1129 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1130 let mut ret = Vec::new();
1131 let mut list = vec![INTERNER.intern_str(root)];
1132 let mut visited = HashSet::new();
1133 while let Some(krate) = list.pop() {
1134 let krate = &self.crates[&krate];
1135 if krate.is_local(self) {
1138 for dep in &krate.deps {
1139 if visited.insert(dep) && dep != "build_helper" {
1147 fn read_stamp_file(&self, stamp: &Path) -> Vec<PathBuf> {
1148 if self.config.dry_run {
1152 let mut paths = Vec::new();
1153 let contents = t!(fs::read(stamp));
1154 // This is the method we use for extracting paths from the stamp file passed to us. See
1155 // run_cargo for more information (in compile.rs).
1156 for part in contents.split(|b| *b == 0) {
1157 if part.is_empty() {
1160 let path = PathBuf::from(t!(str::from_utf8(part)));
1166 /// Copies a file from `src` to `dst`
1167 pub fn copy(&self, src: &Path, dst: &Path) {
1168 if self.config.dry_run { return; }
1169 let _ = fs::remove_file(&dst);
1170 let metadata = t!(src.symlink_metadata());
1171 if metadata.file_type().is_symlink() {
1172 let link = t!(fs::read_link(src));
1173 t!(symlink_file(link, dst));
1174 } else if let Ok(()) = fs::hard_link(src, dst) {
1175 // Attempt to "easy copy" by creating a hard link
1176 // (symlinks don't work on windows), but if that fails
1177 // just fall back to a slow `copy` operation.
1179 if let Err(e) = fs::copy(src, dst) {
1180 panic!("failed to copy `{}` to `{}`: {}", src.display(),
1183 t!(fs::set_permissions(dst, metadata.permissions()));
1184 let atime = FileTime::from_last_access_time(&metadata);
1185 let mtime = FileTime::from_last_modification_time(&metadata);
1186 t!(filetime::set_file_times(dst, atime, mtime));
1190 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1191 /// new string for each replacement.)
1192 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1193 if self.config.dry_run { return; }
1194 let mut contents = String::new();
1195 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1196 t!(file.read_to_string(&mut contents));
1197 for &(target, replacement) in replacements {
1198 contents = contents.replace(target, replacement);
1200 t!(file.seek(SeekFrom::Start(0)));
1201 t!(file.set_len(0));
1202 t!(file.write_all(contents.as_bytes()));
1205 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1206 /// when this function is called.
1207 pub fn cp_r(&self, src: &Path, dst: &Path) {
1208 if self.config.dry_run { return; }
1209 for f in t!(fs::read_dir(src)) {
1211 let path = f.path();
1212 let name = path.file_name().unwrap();
1213 let dst = dst.join(name);
1214 if t!(f.file_type()).is_dir() {
1215 t!(fs::create_dir_all(&dst));
1216 self.cp_r(&path, &dst);
1218 let _ = fs::remove_file(&dst);
1219 self.copy(&path, &dst);
1224 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1225 /// when this function is called. Unwanted files or directories can be skipped
1226 /// by returning `false` from the filter function.
1227 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1228 // Immediately recurse with an empty relative path
1229 self.recurse_(src, dst, Path::new(""), filter)
1232 // Inner function does the actual work
1233 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1234 for f in self.read_dir(src) {
1235 let path = f.path();
1236 let name = path.file_name().unwrap();
1237 let dst = dst.join(name);
1238 let relative = relative.join(name);
1239 // Only copy file or directory if the filter function returns true
1240 if filter(&relative) {
1241 if t!(f.file_type()).is_dir() {
1242 let _ = fs::remove_dir_all(&dst);
1243 self.create_dir(&dst);
1244 self.recurse_(&path, &dst, &relative, filter);
1246 let _ = fs::remove_file(&dst);
1247 self.copy(&path, &dst);
1253 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1254 let file_name = src.file_name().unwrap();
1255 let dest = dest_folder.join(file_name);
1256 self.copy(src, &dest);
1259 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1260 if self.config.dry_run { return; }
1261 let dst = dstdir.join(src.file_name().unwrap());
1262 t!(fs::create_dir_all(dstdir));
1263 drop(fs::remove_file(&dst));
1266 panic!("Error: File \"{}\" not found!", src.display());
1268 let mut s = t!(fs::File::open(&src));
1269 let mut d = t!(fs::File::create(&dst));
1270 io::copy(&mut s, &mut d).expect("failed to copy");
1275 fn create(&self, path: &Path, s: &str) {
1276 if self.config.dry_run { return; }
1277 t!(fs::write(path, s));
1280 fn read(&self, path: &Path) -> String {
1281 if self.config.dry_run { return String::new(); }
1282 t!(fs::read_to_string(path))
1285 fn create_dir(&self, dir: &Path) {
1286 if self.config.dry_run { return; }
1287 t!(fs::create_dir_all(dir))
1290 fn remove_dir(&self, dir: &Path) {
1291 if self.config.dry_run { return; }
1292 t!(fs::remove_dir_all(dir))
1295 fn read_dir(&self, dir: &Path) -> impl Iterator<Item=fs::DirEntry> {
1296 let iter = match fs::read_dir(dir) {
1298 Err(_) if self.config.dry_run => return vec![].into_iter(),
1299 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1301 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1304 fn remove(&self, f: &Path) {
1305 if self.config.dry_run { return; }
1306 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1311 fn chmod(path: &Path, perms: u32) {
1312 use std::os::unix::fs::*;
1313 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1316 fn chmod(_path: &Path, _perms: u32) {}
1320 pub fn with_stage(mut self, stage: u32) -> Compiler {
1325 /// Returns whether this is a snapshot compiler for `build`'s configuration
1326 pub fn is_snapshot(&self, build: &Build) -> bool {
1327 self.stage == 0 && self.host == build.build
1330 /// Returns if this compiler should be treated as a final stage one in the
1331 /// current build session.
1332 /// This takes into account whether we're performing a full bootstrap or
1333 /// not; don't directly compare the stage with `2`!
1334 pub fn is_final_stage(&self, build: &Build) -> bool {
1335 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1336 self.stage >= final_stage