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 which are 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 util::{exe, libdir, OutputFolder, CiEnv};
187 #[cfg(all(unix, not(target_os = "haiku")))]
191 pub unsafe fn setup(build: &mut ::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 ::Build) {
204 pub use config::Config;
205 use flags::Subcommand;
206 use cache::{Interned, INTERNER};
207 use 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.
240 /// Global configuration for the build system.
242 /// This structure transitively contains all configuration for the build system.
243 /// All filesystem-encoded configuration is in `config`, all flags are in
244 /// `flags`, and then parsed or probed information is listed in the keys below.
246 /// This structure is a parameter of almost all methods in the build system,
247 /// although most functions are implemented as free functions rather than
248 /// methods specifically on this structure itself (to make it easier to
251 // User-specified configuration via config.toml
254 // Derived properties from the above two configurations
257 rust_info: channel::GitInfo,
258 cargo_info: channel::GitInfo,
259 rls_info: channel::GitInfo,
260 clippy_info: channel::GitInfo,
261 rustfmt_info: channel::GitInfo,
267 // Targets for which to build.
268 build: Interned<String>,
269 hosts: Vec<Interned<String>>,
270 targets: Vec<Interned<String>>,
272 // Stage 0 (downloaded) compiler and cargo or their local rust equivalents.
273 initial_rustc: PathBuf,
274 initial_cargo: PathBuf,
276 // Probed tools at runtime
277 lldb_version: Option<String>,
278 lldb_python_dir: Option<String>,
280 // Runtime state filled in later on
281 // C/C++ compilers and archiver for all targets
282 cc: HashMap<Interned<String>, cc::Tool>,
283 cxx: HashMap<Interned<String>, cc::Tool>,
284 ar: HashMap<Interned<String>, PathBuf>,
285 ranlib: HashMap<Interned<String>, PathBuf>,
287 crates: HashMap<Interned<String>, Crate>,
290 delayed_failures: RefCell<Vec<String>>,
291 prerelease_version: Cell<Option<u32>>,
292 tool_artifacts: RefCell<HashMap<
294 HashMap<String, (&'static str, PathBuf, Vec<String>)>
300 name: Interned<String>,
302 deps: HashSet<Interned<String>>,
312 fn is_local(&self, build: &Build) -> bool {
313 self.path.starts_with(&build.config.src) &&
314 !self.path.to_string_lossy().ends_with("_shim")
317 fn local_path(&self, build: &Build) -> PathBuf {
318 assert!(self.is_local(build));
319 self.path.strip_prefix(&build.config.src).unwrap().into()
323 /// The various "modes" of invoking Cargo.
325 /// These entries currently correspond to the various output directories of the
326 /// build system, with each mod generating output in a different directory.
327 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
329 /// Build the standard library, placing output in the "stageN-std" directory.
332 /// Build libtest, placing output in the "stageN-test" directory.
335 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
338 /// Build codegen libraries, placing output in the "stageN-codegen" directory
341 /// Build some tools, placing output in the "stageN-tools" directory. The
342 /// "other" here is for miscellaneous sets of tools that are built using the
343 /// bootstrap compiler in its entirety (target libraries and all).
344 /// Typically these tools compile with stable Rust.
347 /// Compile a tool which uses all libraries we compile (up to rustc).
348 /// Doesn't use the stage0 compiler libraries like "other", and includes
349 /// tools like rustdoc, cargo, rls, etc.
355 pub fn is_tool(&self) -> bool {
357 Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd => true,
364 /// Creates a new set of build configuration from the `flags` on the command
365 /// line and the filesystem `config`.
367 /// By default all build output will be placed in the current directory.
368 pub fn new(config: Config) -> Build {
369 let src = config.src.clone();
370 let out = config.out.clone();
372 let is_sudo = match env::var_os("SUDO_USER") {
374 match env::var_os("USER") {
375 Some(user) => user != sudo_user,
381 let rust_info = channel::GitInfo::new(&config, &src);
382 let cargo_info = channel::GitInfo::new(&config, &src.join("src/tools/cargo"));
383 let rls_info = channel::GitInfo::new(&config, &src.join("src/tools/rls"));
384 let clippy_info = channel::GitInfo::new(&config, &src.join("src/tools/clippy"));
385 let rustfmt_info = channel::GitInfo::new(&config, &src.join("src/tools/rustfmt"));
387 let mut build = Build {
388 initial_rustc: config.initial_rustc.clone(),
389 initial_cargo: config.initial_cargo.clone(),
390 local_rebuild: config.local_rebuild,
391 fail_fast: config.cmd.fail_fast(),
392 doc_tests: config.cmd.doc_tests(),
393 verbosity: config.verbose,
396 hosts: config.hosts.clone(),
397 targets: config.targets.clone(),
411 ranlib: HashMap::new(),
412 crates: HashMap::new(),
414 lldb_python_dir: None,
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.debug_jemalloc {
520 features.push_str(" debug-jemalloc");
522 if self.config.use_jemalloc {
523 features.push_str(" jemalloc");
525 if self.config.backtrace {
526 features.push_str(" backtrace");
528 if self.config.profiler {
529 features.push_str(" profiler");
531 if self.config.wasm_syscall {
532 features.push_str(" wasm_syscall");
537 /// Get the space-separated set of activated features for the compiler.
538 fn rustc_features(&self) -> String {
539 let mut features = String::new();
540 if self.config.use_jemalloc {
541 features.push_str(" jemalloc");
546 /// Component directory that Cargo will produce output into (e.g.
548 fn cargo_dir(&self) -> &'static str {
549 if self.config.rust_optimize {"release"} else {"debug"}
552 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
553 let out = self.out.join(&*compiler.host).join(format!("stage{}-tools-bin", compiler.stage));
554 t!(fs::create_dir_all(&out));
558 /// Returns the root directory for all output generated in a particular
559 /// stage when running with a particular host compiler.
561 /// The mode indicates what the root directory is for.
562 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
563 let suffix = match mode {
565 Mode::Test => "-test",
566 Mode::Rustc => "-rustc",
567 Mode::Codegen => "-codegen",
568 Mode::ToolBootstrap => "-bootstrap-tools",
569 Mode::ToolStd => "-tools",
570 Mode::ToolRustc => "-tools",
572 self.out.join(&*compiler.host)
573 .join(format!("stage{}{}", compiler.stage, suffix))
576 /// Returns the root output directory for all Cargo output in a given stage,
577 /// running a particular compiler, whether or not we're building the
578 /// standard library, and targeting the specified architecture.
582 target: Interned<String>) -> PathBuf {
583 self.stage_out(compiler, mode).join(&*target).join(self.cargo_dir())
586 /// Root output directory for LLVM compiled for `target`
588 /// Note that if LLVM is configured externally then the directory returned
589 /// will likely be empty.
590 fn llvm_out(&self, target: Interned<String>) -> PathBuf {
591 self.out.join(&*target).join("llvm")
594 fn emscripten_llvm_out(&self, target: Interned<String>) -> PathBuf {
595 self.out.join(&*target).join("llvm-emscripten")
598 fn lld_out(&self, target: Interned<String>) -> PathBuf {
599 self.out.join(&*target).join("lld")
602 /// Output directory for all documentation for a target
603 fn doc_out(&self, target: Interned<String>) -> PathBuf {
604 self.out.join(&*target).join("doc")
607 /// Output directory for all documentation for a target
608 fn compiler_doc_out(&self, target: Interned<String>) -> PathBuf {
609 self.out.join(&*target).join("compiler-doc")
612 /// Output directory for some generated md crate documentation for a target (temporary)
613 fn md_doc_out(&self, target: Interned<String>) -> Interned<PathBuf> {
614 INTERNER.intern_path(self.out.join(&*target).join("md-doc"))
617 /// Output directory for all crate documentation for a target (temporary)
619 /// The artifacts here are then copied into `doc_out` above.
620 fn crate_doc_out(&self, target: Interned<String>) -> PathBuf {
621 self.out.join(&*target).join("crate-docs")
624 /// Returns true if no custom `llvm-config` is set for the specified target.
626 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
627 fn is_rust_llvm(&self, target: Interned<String>) -> bool {
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: Interned<String>) -> PathBuf {
636 let target_config = self.config.target_config.get(&target);
637 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
638 let llvm_bindir = output(Command::new(s).arg("--bindir"));
639 Path::new(llvm_bindir.trim()).join(exe("FileCheck", &*target))
641 let base = self.llvm_out(self.config.build).join("build");
642 let base = if !self.config.ninja && self.config.build.contains("msvc") {
643 if self.config.llvm_optimize {
644 if self.config.llvm_release_debuginfo {
645 base.join("RelWithDebInfo")
655 base.join("bin").join(exe("FileCheck", &*target))
659 /// Directory for libraries built from C/C++ code and shared between stages.
660 fn native_dir(&self, target: Interned<String>) -> PathBuf {
661 self.out.join(&*target).join("native")
664 /// Root output directory for rust_test_helpers library compiled for
666 fn test_helpers_out(&self, target: Interned<String>) -> PathBuf {
667 self.native_dir(target).join("rust-test-helpers")
670 /// Adds the `RUST_TEST_THREADS` env var if necessary
671 fn add_rust_test_threads(&self, cmd: &mut Command) {
672 if env::var_os("RUST_TEST_THREADS").is_none() {
673 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
677 /// Returns the libdir of the snapshot compiler.
678 fn rustc_snapshot_libdir(&self) -> PathBuf {
679 self.rustc_snapshot_sysroot().join(libdir(&self.config.build))
682 /// Returns the sysroot of the snapshot compiler.
683 fn rustc_snapshot_sysroot(&self) -> &Path {
684 self.initial_rustc.parent().unwrap().parent().unwrap()
687 /// Runs a command, printing out nice contextual information if it fails.
688 fn run(&self, cmd: &mut Command) {
689 if self.config.dry_run { return; }
690 self.verbose(&format!("running: {:?}", cmd));
694 /// Runs a command, printing out nice contextual information if it fails.
695 fn run_quiet(&self, cmd: &mut Command) {
696 if self.config.dry_run { return; }
697 self.verbose(&format!("running: {:?}", cmd));
701 /// Runs a command, printing out nice contextual information if it fails.
702 /// Exits if the command failed to execute at all, otherwise returns its
703 /// `status.success()`.
704 fn try_run(&self, cmd: &mut Command) -> bool {
705 if self.config.dry_run { return true; }
706 self.verbose(&format!("running: {:?}", cmd));
710 /// Runs a command, printing out nice contextual information if it fails.
711 /// Exits if the command failed to execute at all, otherwise returns its
712 /// `status.success()`.
713 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
714 if self.config.dry_run { return true; }
715 self.verbose(&format!("running: {:?}", cmd));
716 try_run_suppressed(cmd)
719 pub fn is_verbose(&self) -> bool {
723 /// Prints a message if this build is configured in verbose mode.
724 fn verbose(&self, msg: &str) {
725 if self.is_verbose() {
730 fn info(&self, msg: &str) {
731 if self.config.dry_run { return; }
735 /// Returns the number of parallel jobs that have been configured for this
737 fn jobs(&self) -> u32 {
738 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
741 /// Returns the path to the C compiler for the target specified.
742 fn cc(&self, target: Interned<String>) -> &Path {
743 self.cc[&target].path()
746 /// Returns a list of flags to pass to the C compiler for the target
748 fn cflags(&self, target: Interned<String>) -> Vec<String> {
749 // Filter out -O and /O (the optimization flags) that we picked up from
750 // cc-rs because the build scripts will determine that for themselves.
751 let mut base = self.cc[&target].args().iter()
752 .map(|s| s.to_string_lossy().into_owned())
753 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
754 .collect::<Vec<_>>();
756 // If we're compiling on macOS then we add a few unconditional flags
757 // indicating that we want libc++ (more filled out than libstdc++) and
758 // we want to compile for 10.7. This way we can ensure that
759 // LLVM/jemalloc/etc are all properly compiled.
760 if target.contains("apple-darwin") {
761 base.push("-stdlib=libc++".into());
764 // Work around an apparently bad MinGW / GCC optimization,
765 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
766 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
767 if &*target == "i686-pc-windows-gnu" {
768 base.push("-fno-omit-frame-pointer".into());
773 /// Returns the path to the `ar` archive utility for the target specified.
774 fn ar(&self, target: Interned<String>) -> Option<&Path> {
775 self.ar.get(&target).map(|p| &**p)
778 /// Returns the path to the `ranlib` utility for the target specified.
779 fn ranlib(&self, target: Interned<String>) -> Option<&Path> {
780 self.ranlib.get(&target).map(|p| &**p)
783 /// Returns the path to the C++ compiler for the target specified.
784 fn cxx(&self, target: Interned<String>) -> Result<&Path, String> {
785 match self.cxx.get(&target) {
786 Some(p) => Ok(p.path()),
788 "target `{}` is not configured as a host, only as a target",
793 /// Returns the path to the linker for the given target if it needs to be overridden.
794 fn linker(&self, target: Interned<String>) -> Option<&Path> {
795 if let Some(linker) = self.config.target_config.get(&target)
796 .and_then(|c| c.linker.as_ref()) {
798 } else if target != self.config.build &&
799 !target.contains("msvc") &&
800 !target.contains("emscripten") &&
801 !target.contains("wasm32") {
802 Some(self.cc(target))
808 /// Returns if this target should statically link the C runtime, if specified
809 fn crt_static(&self, target: Interned<String>) -> Option<bool> {
810 if target.contains("pc-windows-msvc") {
813 self.config.target_config.get(&target)
814 .and_then(|t| t.crt_static)
818 /// Returns the "musl root" for this `target`, if defined
819 fn musl_root(&self, target: Interned<String>) -> Option<&Path> {
820 self.config.target_config.get(&target)
821 .and_then(|t| t.musl_root.as_ref())
822 .or(self.config.musl_root.as_ref())
826 /// Returns true if this is a no-std `target`, if defined
827 fn no_std(&self, target: Interned<String>) -> Option<bool> {
828 self.config.target_config.get(&target)
832 /// Returns whether the target will be tested using the `remote-test-client`
833 /// and `remote-test-server` binaries.
834 fn remote_tested(&self, target: Interned<String>) -> bool {
835 self.qemu_rootfs(target).is_some() || target.contains("android") ||
836 env::var_os("TEST_DEVICE_ADDR").is_some()
839 /// Returns the root of the "rootfs" image that this target will be using,
840 /// if one was configured.
842 /// If `Some` is returned then that means that tests for this target are
843 /// emulated with QEMU and binaries will need to be shipped to the emulator.
844 fn qemu_rootfs(&self, target: Interned<String>) -> Option<&Path> {
845 self.config.target_config.get(&target)
846 .and_then(|t| t.qemu_rootfs.as_ref())
850 /// Path to the python interpreter to use
851 fn python(&self) -> &Path {
852 self.config.python.as_ref().unwrap()
855 /// Temporary directory that extended error information is emitted to.
856 fn extended_error_dir(&self) -> PathBuf {
857 self.out.join("tmp/extended-error-metadata")
860 /// Tests whether the `compiler` compiling for `target` should be forced to
861 /// use a stage1 compiler instead.
863 /// Currently, by default, the build system does not perform a "full
864 /// bootstrap" by default where we compile the compiler three times.
865 /// Instead, we compile the compiler two times. The final stage (stage2)
866 /// just copies the libraries from the previous stage, which is what this
869 /// Here we return `true` if:
871 /// * The build isn't performing a full bootstrap
872 /// * The `compiler` is in the final stage, 2
873 /// * We're not cross-compiling, so the artifacts are already available in
876 /// When all of these conditions are met the build will lift artifacts from
877 /// the previous stage forward.
878 fn force_use_stage1(&self, compiler: Compiler, target: Interned<String>) -> bool {
879 !self.config.full_bootstrap &&
880 compiler.stage >= 2 &&
881 (self.hosts.iter().any(|h| *h == target) || target == self.build)
884 /// Returns the directory that OpenSSL artifacts are compiled into if
885 /// configured to do so.
886 fn openssl_dir(&self, target: Interned<String>) -> Option<PathBuf> {
887 // OpenSSL not used on Windows
888 if target.contains("windows") {
890 } else if self.config.openssl_static {
891 Some(self.out.join(&*target).join("openssl"))
897 /// Returns the directory that OpenSSL artifacts are installed into if
898 /// configured as such.
899 fn openssl_install_dir(&self, target: Interned<String>) -> Option<PathBuf> {
900 self.openssl_dir(target).map(|p| p.join("install"))
903 /// Given `num` in the form "a.b.c" return a "release string" which
904 /// describes the release version number.
906 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
907 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
908 fn release(&self, num: &str) -> String {
909 match &self.config.channel[..] {
910 "stable" => num.to_string(),
911 "beta" => if self.rust_info.is_git() {
912 format!("{}-beta.{}", num, self.beta_prerelease_version())
914 format!("{}-beta", num)
916 "nightly" => format!("{}-nightly", num),
917 _ => format!("{}-dev", num),
921 fn beta_prerelease_version(&self) -> u32 {
922 if let Some(s) = self.prerelease_version.get() {
931 .current_dir(&self.src)
933 let beta = beta.trim().split_whitespace().next().unwrap();
939 .current_dir(&self.src)
941 let master = master.trim().split_whitespace().next().unwrap();
943 // Figure out where the current beta branch started.
949 .current_dir(&self.src),
951 let base = base.trim();
953 // Next figure out how many merge commits happened since we branched off
954 // beta. That's our beta number!
960 .arg(format!("{}...HEAD", base))
961 .current_dir(&self.src),
963 let n = count.trim().parse().unwrap();
964 self.prerelease_version.set(Some(n));
968 /// Returns the value of `release` above for Rust itself.
969 fn rust_release(&self) -> String {
970 self.release(channel::CFG_RELEASE_NUM)
973 /// Returns the "package version" for a component given the `num` release
976 /// The package version is typically what shows up in the names of tarballs.
977 /// For channels like beta/nightly it's just the channel name, otherwise
978 /// it's the `num` provided.
979 fn package_vers(&self, num: &str) -> String {
980 match &self.config.channel[..] {
981 "stable" => num.to_string(),
982 "beta" => "beta".to_string(),
983 "nightly" => "nightly".to_string(),
984 _ => format!("{}-dev", num),
988 /// Returns the value of `package_vers` above for Rust itself.
989 fn rust_package_vers(&self) -> String {
990 self.package_vers(channel::CFG_RELEASE_NUM)
993 /// Returns the value of `package_vers` above for Cargo
994 fn cargo_package_vers(&self) -> String {
995 self.package_vers(&self.release_num("cargo"))
998 /// Returns the value of `package_vers` above for rls
999 fn rls_package_vers(&self) -> String {
1000 self.package_vers(&self.release_num("rls"))
1003 /// Returns the value of `package_vers` above for clippy
1004 fn clippy_package_vers(&self) -> String {
1005 self.package_vers(&self.release_num("clippy"))
1008 /// Returns the value of `package_vers` above for rustfmt
1009 fn rustfmt_package_vers(&self) -> String {
1010 self.package_vers(&self.release_num("rustfmt"))
1013 fn llvm_tools_package_vers(&self) -> String {
1014 self.package_vers(&self.rust_version())
1017 fn llvm_tools_vers(&self) -> String {
1021 fn lldb_package_vers(&self) -> String {
1022 self.package_vers(&self.rust_version())
1025 fn lldb_vers(&self) -> String {
1029 fn llvm_link_tools_dynamically(&self, target: Interned<String>) -> bool {
1030 (target.contains("linux-gnu") || target.contains("apple-darwin"))
1033 /// Returns the `version` string associated with this compiler for Rust
1036 /// Note that this is a descriptive string which includes the commit date,
1037 /// sha, version, etc.
1038 fn rust_version(&self) -> String {
1039 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1042 /// Return the full commit hash
1043 fn rust_sha(&self) -> Option<&str> {
1044 self.rust_info.sha()
1047 /// Returns the `a.b.c` version that the given package is at.
1048 fn release_num(&self, package: &str) -> String {
1049 let mut toml = String::new();
1050 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1051 t!(t!(File::open(toml_file_name)).read_to_string(&mut toml));
1052 for line in toml.lines() {
1053 let prefix = "version = \"";
1055 if line.starts_with(prefix) && line.ends_with(suffix) {
1056 return line[prefix.len()..line.len() - suffix.len()].to_string()
1060 panic!("failed to find version in {}'s Cargo.toml", package)
1063 /// Returns whether unstable features should be enabled for the compiler
1065 fn unstable_features(&self) -> bool {
1066 match &self.config.channel[..] {
1067 "stable" | "beta" => false,
1068 "nightly" | _ => true,
1072 /// Fold the output of the commands after this method into a group. The fold
1073 /// ends when the returned object is dropped. Folding can only be used in
1074 /// the Travis CI environment.
1075 pub fn fold_output<D, F>(&self, name: F) -> Option<OutputFolder>
1076 where D: Into<String>, F: FnOnce() -> D
1078 if !self.config.dry_run && self.ci_env == CiEnv::Travis {
1079 Some(OutputFolder::new(name().into()))
1085 /// Updates the actual toolstate of a tool.
1087 /// The toolstates are saved to the file specified by the key
1088 /// `rust.save-toolstates` in `config.toml`. If unspecified, nothing will be
1089 /// done. The file is updated immediately after this function completes.
1090 pub fn save_toolstate(&self, tool: &str, state: ToolState) {
1091 use std::io::{Seek, SeekFrom};
1093 if let Some(ref path) = self.config.save_toolstates {
1094 let mut file = t!(fs::OpenOptions::new()
1100 let mut current_toolstates: HashMap<Box<str>, ToolState> =
1101 serde_json::from_reader(&mut file).unwrap_or_default();
1102 current_toolstates.insert(tool.into(), state);
1103 t!(file.seek(SeekFrom::Start(0)));
1104 t!(file.set_len(0));
1105 t!(serde_json::to_writer(file, ¤t_toolstates));
1109 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1110 let mut ret = Vec::new();
1111 let mut list = vec![INTERNER.intern_str(root)];
1112 let mut visited = HashSet::new();
1113 while let Some(krate) = list.pop() {
1114 let krate = &self.crates[&krate];
1115 if krate.is_local(self) {
1117 for dep in &krate.deps {
1118 if visited.insert(dep) && dep != "build_helper" {
1127 fn read_stamp_file(&self, stamp: &Path) -> Vec<PathBuf> {
1128 if self.config.dry_run {
1132 let mut paths = Vec::new();
1133 let mut contents = Vec::new();
1134 t!(t!(File::open(stamp)).read_to_end(&mut contents));
1135 // This is the method we use for extracting paths from the stamp file passed to us. See
1136 // run_cargo for more information (in compile.rs).
1137 for part in contents.split(|b| *b == 0) {
1138 if part.is_empty() {
1141 let path = PathBuf::from(t!(str::from_utf8(part)));
1147 /// Copies a file from `src` to `dst`
1148 pub fn copy(&self, src: &Path, dst: &Path) {
1149 if self.config.dry_run { return; }
1150 let _ = fs::remove_file(&dst);
1151 let metadata = t!(src.symlink_metadata());
1152 if metadata.file_type().is_symlink() {
1153 let link = t!(fs::read_link(src));
1154 t!(symlink_file(link, dst));
1155 } else if let Ok(()) = fs::hard_link(src, dst) {
1156 // Attempt to "easy copy" by creating a hard link
1157 // (symlinks don't work on windows), but if that fails
1158 // just fall back to a slow `copy` operation.
1160 if let Err(e) = fs::copy(src, dst) {
1161 panic!("failed to copy `{}` to `{}`: {}", src.display(),
1164 t!(fs::set_permissions(dst, metadata.permissions()));
1165 let atime = FileTime::from_last_access_time(&metadata);
1166 let mtime = FileTime::from_last_modification_time(&metadata);
1167 t!(filetime::set_file_times(dst, atime, mtime));
1171 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1172 /// new string for each replacement.)
1173 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1174 if self.config.dry_run { return; }
1175 let mut contents = String::new();
1176 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1177 t!(file.read_to_string(&mut contents));
1178 for &(target, replacement) in replacements {
1179 contents = contents.replace(target, replacement);
1181 t!(file.seek(SeekFrom::Start(0)));
1182 t!(file.set_len(0));
1183 t!(file.write_all(contents.as_bytes()));
1186 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1187 /// when this function is called.
1188 pub fn cp_r(&self, src: &Path, dst: &Path) {
1189 if self.config.dry_run { return; }
1190 for f in t!(fs::read_dir(src)) {
1192 let path = f.path();
1193 let name = path.file_name().unwrap();
1194 let dst = dst.join(name);
1195 if t!(f.file_type()).is_dir() {
1196 t!(fs::create_dir_all(&dst));
1197 self.cp_r(&path, &dst);
1199 let _ = fs::remove_file(&dst);
1200 self.copy(&path, &dst);
1205 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1206 /// when this function is called. Unwanted files or directories can be skipped
1207 /// by returning `false` from the filter function.
1208 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1209 // Immediately recurse with an empty relative path
1210 self.recurse_(src, dst, Path::new(""), filter)
1213 // Inner function does the actual work
1214 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1215 for f in self.read_dir(src) {
1216 let path = f.path();
1217 let name = path.file_name().unwrap();
1218 let dst = dst.join(name);
1219 let relative = relative.join(name);
1220 // Only copy file or directory if the filter function returns true
1221 if filter(&relative) {
1222 if t!(f.file_type()).is_dir() {
1223 let _ = fs::remove_dir_all(&dst);
1224 self.create_dir(&dst);
1225 self.recurse_(&path, &dst, &relative, filter);
1227 let _ = fs::remove_file(&dst);
1228 self.copy(&path, &dst);
1234 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1235 let file_name = src.file_name().unwrap();
1236 let dest = dest_folder.join(file_name);
1237 self.copy(src, &dest);
1240 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1241 if self.config.dry_run { return; }
1242 let dst = dstdir.join(src.file_name().unwrap());
1243 t!(fs::create_dir_all(dstdir));
1244 drop(fs::remove_file(&dst));
1246 let mut s = t!(fs::File::open(&src));
1247 let mut d = t!(fs::File::create(&dst));
1248 io::copy(&mut s, &mut d).expect("failed to copy");
1253 fn create(&self, path: &Path, s: &str) {
1254 if self.config.dry_run { return; }
1255 t!(fs::write(path, s));
1258 fn read(&self, path: &Path) -> String {
1259 if self.config.dry_run { return String::new(); }
1260 t!(fs::read_to_string(path))
1263 fn create_dir(&self, dir: &Path) {
1264 if self.config.dry_run { return; }
1265 t!(fs::create_dir_all(dir))
1268 fn remove_dir(&self, dir: &Path) {
1269 if self.config.dry_run { return; }
1270 t!(fs::remove_dir_all(dir))
1273 fn read_dir(&self, dir: &Path) -> impl Iterator<Item=fs::DirEntry> {
1274 let iter = match fs::read_dir(dir) {
1276 Err(_) if self.config.dry_run => return vec![].into_iter(),
1277 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1279 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1282 fn remove(&self, f: &Path) {
1283 if self.config.dry_run { return; }
1284 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1289 fn chmod(path: &Path, perms: u32) {
1290 use std::os::unix::fs::*;
1291 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1294 fn chmod(_path: &Path, _perms: u32) {}
1298 pub fn with_stage(mut self, stage: u32) -> Compiler {
1303 /// Returns whether this is a snapshot compiler for `build`'s configuration
1304 pub fn is_snapshot(&self, build: &Build) -> bool {
1305 self.stage == 0 && self.host == build.build
1308 /// Returns if this compiler should be treated as a final stage one in the
1309 /// current build session.
1310 /// This takes into account whether we're performing a full bootstrap or
1311 /// not; don't directly compare the stage with `2`!
1312 pub fn is_final_stage(&self, build: &Build) -> bool {
1313 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1314 self.stage >= final_stage