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-size", // used to prints the size of the linker sections of a program
215 "llvm-strip", // used to discard symbols from binary files to reduce their size
216 "llvm-readobj", // used to get information from ELFs/objects that the other tools don't provide
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>,
286 crates: HashMap<Interned<String>, Crate>,
289 delayed_failures: RefCell<Vec<String>>,
290 prerelease_version: Cell<Option<u32>>,
291 tool_artifacts: RefCell<HashMap<
293 HashMap<String, (&'static str, PathBuf, Vec<String>)>
299 name: Interned<String>,
301 deps: HashSet<Interned<String>>,
311 fn is_local(&self, build: &Build) -> bool {
312 self.path.starts_with(&build.config.src) &&
313 !self.path.to_string_lossy().ends_with("_shim")
316 fn local_path(&self, build: &Build) -> PathBuf {
317 assert!(self.is_local(build));
318 self.path.strip_prefix(&build.config.src).unwrap().into()
322 /// The various "modes" of invoking Cargo.
324 /// These entries currently correspond to the various output directories of the
325 /// build system, with each mod generating output in a different directory.
326 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
328 /// Build the standard library, placing output in the "stageN-std" directory.
331 /// Build libtest, placing output in the "stageN-test" directory.
334 /// Build librustc, and compiler libraries, placing output in the "stageN-rustc" directory.
337 /// Build codegen libraries, placing output in the "stageN-codegen" directory
340 /// Build some tools, placing output in the "stageN-tools" directory. The
341 /// "other" here is for miscellaneous sets of tools that are built using the
342 /// bootstrap compiler in its entirety (target libraries and all).
343 /// Typically these tools compile with stable Rust.
346 /// Compile a tool which uses all libraries we compile (up to rustc).
347 /// Doesn't use the stage0 compiler libraries like "other", and includes
348 /// tools like rustdoc, cargo, rls, etc.
354 pub fn is_tool(&self) -> bool {
356 Mode::ToolBootstrap | Mode::ToolRustc | Mode::ToolStd => true,
363 /// Creates a new set of build configuration from the `flags` on the command
364 /// line and the filesystem `config`.
366 /// By default all build output will be placed in the current directory.
367 pub fn new(config: Config) -> Build {
368 let src = config.src.clone();
369 let out = config.out.clone();
371 let is_sudo = match env::var_os("SUDO_USER") {
373 match env::var_os("USER") {
374 Some(user) => user != sudo_user,
380 let rust_info = channel::GitInfo::new(&config, &src);
381 let cargo_info = channel::GitInfo::new(&config, &src.join("src/tools/cargo"));
382 let rls_info = channel::GitInfo::new(&config, &src.join("src/tools/rls"));
383 let clippy_info = channel::GitInfo::new(&config, &src.join("src/tools/clippy"));
384 let rustfmt_info = channel::GitInfo::new(&config, &src.join("src/tools/rustfmt"));
386 let mut build = Build {
387 initial_rustc: config.initial_rustc.clone(),
388 initial_cargo: config.initial_cargo.clone(),
389 local_rebuild: config.local_rebuild,
390 fail_fast: config.cmd.fail_fast(),
391 doc_tests: config.cmd.doc_tests(),
392 verbosity: config.verbose,
395 hosts: config.hosts.clone(),
396 targets: config.targets.clone(),
410 crates: HashMap::new(),
412 lldb_python_dir: None,
414 ci_env: CiEnv::current(),
415 delayed_failures: RefCell::new(Vec::new()),
416 prerelease_version: Cell::new(None),
417 tool_artifacts: Default::default(),
420 build.verbose("finding compilers");
421 cc_detect::find(&mut build);
422 build.verbose("running sanity check");
423 sanity::check(&mut build);
425 // If local-rust is the same major.minor as the current version, then force a
427 let local_version_verbose = output(
428 Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
429 let local_release = local_version_verbose
430 .lines().filter(|x| x.starts_with("release:"))
431 .next().unwrap().trim_left_matches("release:").trim();
432 let my_version = channel::CFG_RELEASE_NUM;
433 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
434 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
435 build.local_rebuild = true;
438 build.verbose("learning about cargo");
439 metadata::build(&mut build);
444 pub fn build_triple(&self) -> &[Interned<String>] {
446 slice::from_raw_parts(&self.build, 1)
450 /// Executes the entire build, as configured by the flags and configuration.
451 pub fn build(&mut self) {
456 if let Subcommand::Clean { all } = self.config.cmd {
457 return clean::clean(self, all);
461 let builder = builder::Builder::new(&self);
462 if let Some(path) = builder.paths.get(0) {
463 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
469 if !self.config.dry_run {
471 self.config.dry_run = true;
472 let builder = builder::Builder::new(&self);
473 builder.execute_cli();
475 self.config.dry_run = false;
476 let builder = builder::Builder::new(&self);
477 builder.execute_cli();
479 let builder = builder::Builder::new(&self);
480 let _ = builder.execute_cli();
483 // Check for postponed failures from `test --no-fail-fast`.
484 let failures = self.delayed_failures.borrow();
485 if failures.len() > 0 {
486 println!("\n{} command(s) did not execute successfully:\n", failures.len());
487 for failure in failures.iter() {
488 println!(" - {}\n", failure);
494 /// Clear out `dir` if `input` is newer.
496 /// After this executes, it will also ensure that `dir` exists.
497 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
498 let stamp = dir.join(".stamp");
499 let mut cleared = false;
500 if mtime(&stamp) < mtime(input) {
501 self.verbose(&format!("Dirty - {}", dir.display()));
502 let _ = fs::remove_dir_all(dir);
504 } else if stamp.exists() {
507 t!(fs::create_dir_all(dir));
508 t!(File::create(stamp));
512 /// Get the space-separated set of activated features for the standard
514 fn std_features(&self) -> String {
515 let mut features = "panic-unwind".to_string();
517 if self.config.debug_jemalloc {
518 features.push_str(" debug-jemalloc");
520 if self.config.use_jemalloc {
521 features.push_str(" jemalloc");
523 if self.config.backtrace {
524 features.push_str(" backtrace");
526 if self.config.profiler {
527 features.push_str(" profiler");
529 if self.config.wasm_syscall {
530 features.push_str(" wasm_syscall");
535 /// Get 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.use_jemalloc {
539 features.push_str(" jemalloc");
544 /// Component directory that Cargo will produce output into (e.g.
546 fn cargo_dir(&self) -> &'static str {
547 if self.config.rust_optimize {"release"} else {"debug"}
550 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
551 let out = self.out.join(&*compiler.host).join(format!("stage{}-tools-bin", compiler.stage));
552 t!(fs::create_dir_all(&out));
556 /// Returns the root directory for all output generated in a particular
557 /// stage when running with a particular host compiler.
559 /// The mode indicates what the root directory is for.
560 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
561 let suffix = match mode {
563 Mode::Test => "-test",
564 Mode::Rustc => "-rustc",
565 Mode::Codegen => "-codegen",
566 Mode::ToolBootstrap => "-bootstrap-tools",
567 Mode::ToolStd => "-tools",
568 Mode::ToolRustc => "-tools",
570 self.out.join(&*compiler.host)
571 .join(format!("stage{}{}", compiler.stage, suffix))
574 /// Returns the root output directory for all Cargo output in a given stage,
575 /// running a particular compiler, whether or not we're building the
576 /// standard library, and targeting the specified architecture.
580 target: Interned<String>) -> PathBuf {
581 self.stage_out(compiler, mode).join(&*target).join(self.cargo_dir())
584 /// Root output directory for LLVM compiled for `target`
586 /// Note that if LLVM is configured externally then the directory returned
587 /// will likely be empty.
588 fn llvm_out(&self, target: Interned<String>) -> PathBuf {
589 self.out.join(&*target).join("llvm")
592 fn emscripten_llvm_out(&self, target: Interned<String>) -> PathBuf {
593 self.out.join(&*target).join("llvm-emscripten")
596 fn lld_out(&self, target: Interned<String>) -> PathBuf {
597 self.out.join(&*target).join("lld")
600 /// Output directory for all documentation for a target
601 fn doc_out(&self, target: Interned<String>) -> PathBuf {
602 self.out.join(&*target).join("doc")
605 /// Output directory for all documentation for a target
606 fn compiler_doc_out(&self, target: Interned<String>) -> PathBuf {
607 self.out.join(&*target).join("compiler-doc")
610 /// Output directory for some generated md crate documentation for a target (temporary)
611 fn md_doc_out(&self, target: Interned<String>) -> Interned<PathBuf> {
612 INTERNER.intern_path(self.out.join(&*target).join("md-doc"))
615 /// Output directory for all crate documentation for a target (temporary)
617 /// The artifacts here are then copied into `doc_out` above.
618 fn crate_doc_out(&self, target: Interned<String>) -> PathBuf {
619 self.out.join(&*target).join("crate-docs")
622 /// Returns true if no custom `llvm-config` is set for the specified target.
624 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
625 fn is_rust_llvm(&self, target: Interned<String>) -> bool {
626 match self.config.target_config.get(&target) {
627 Some(ref c) => c.llvm_config.is_none(),
632 /// Returns the path to `FileCheck` binary for the specified target
633 fn llvm_filecheck(&self, target: Interned<String>) -> PathBuf {
634 let target_config = self.config.target_config.get(&target);
635 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
636 let llvm_bindir = output(Command::new(s).arg("--bindir"));
637 Path::new(llvm_bindir.trim()).join(exe("FileCheck", &*target))
639 let base = self.llvm_out(self.config.build).join("build");
640 let base = if !self.config.ninja && self.config.build.contains("msvc") {
641 if self.config.llvm_optimize {
642 if self.config.llvm_release_debuginfo {
643 base.join("RelWithDebInfo")
653 base.join("bin").join(exe("FileCheck", &*target))
657 /// Directory for libraries built from C/C++ code and shared between stages.
658 fn native_dir(&self, target: Interned<String>) -> PathBuf {
659 self.out.join(&*target).join("native")
662 /// Root output directory for rust_test_helpers library compiled for
664 fn test_helpers_out(&self, target: Interned<String>) -> PathBuf {
665 self.native_dir(target).join("rust-test-helpers")
668 /// Adds the `RUST_TEST_THREADS` env var if necessary
669 fn add_rust_test_threads(&self, cmd: &mut Command) {
670 if env::var_os("RUST_TEST_THREADS").is_none() {
671 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
675 /// Returns the libdir of the snapshot compiler.
676 fn rustc_snapshot_libdir(&self) -> PathBuf {
677 self.rustc_snapshot_sysroot().join(libdir(&self.config.build))
680 /// Returns the sysroot of the snapshot compiler.
681 fn rustc_snapshot_sysroot(&self) -> &Path {
682 self.initial_rustc.parent().unwrap().parent().unwrap()
685 /// Runs a command, printing out nice contextual information if it fails.
686 fn run(&self, cmd: &mut Command) {
687 if self.config.dry_run { return; }
688 self.verbose(&format!("running: {:?}", cmd));
692 /// Runs a command, printing out nice contextual information if it fails.
693 fn run_quiet(&self, cmd: &mut Command) {
694 if self.config.dry_run { return; }
695 self.verbose(&format!("running: {:?}", cmd));
699 /// Runs a command, printing out nice contextual information if it fails.
700 /// Exits if the command failed to execute at all, otherwise returns its
701 /// `status.success()`.
702 fn try_run(&self, cmd: &mut Command) -> bool {
703 if self.config.dry_run { return true; }
704 self.verbose(&format!("running: {:?}", cmd));
708 /// Runs a command, printing out nice contextual information if it fails.
709 /// Exits if the command failed to execute at all, otherwise returns its
710 /// `status.success()`.
711 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
712 if self.config.dry_run { return true; }
713 self.verbose(&format!("running: {:?}", cmd));
714 try_run_suppressed(cmd)
717 pub fn is_verbose(&self) -> bool {
721 /// Prints a message if this build is configured in verbose mode.
722 fn verbose(&self, msg: &str) {
723 if self.is_verbose() {
728 fn info(&self, msg: &str) {
729 if self.config.dry_run { return; }
733 /// Returns the number of parallel jobs that have been configured for this
735 fn jobs(&self) -> u32 {
736 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
739 /// Returns the path to the C compiler for the target specified.
740 fn cc(&self, target: Interned<String>) -> &Path {
741 self.cc[&target].path()
744 /// Returns a list of flags to pass to the C compiler for the target
746 fn cflags(&self, target: Interned<String>) -> Vec<String> {
747 // Filter out -O and /O (the optimization flags) that we picked up from
748 // cc-rs because the build scripts will determine that for themselves.
749 let mut base = self.cc[&target].args().iter()
750 .map(|s| s.to_string_lossy().into_owned())
751 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
752 .collect::<Vec<_>>();
754 // If we're compiling on macOS then we add a few unconditional flags
755 // indicating that we want libc++ (more filled out than libstdc++) and
756 // we want to compile for 10.7. This way we can ensure that
757 // LLVM/jemalloc/etc are all properly compiled.
758 if target.contains("apple-darwin") {
759 base.push("-stdlib=libc++".into());
762 // Work around an apparently bad MinGW / GCC optimization,
763 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
764 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
765 if &*target == "i686-pc-windows-gnu" {
766 base.push("-fno-omit-frame-pointer".into());
771 /// Returns the path to the `ar` archive utility for the target specified.
772 fn ar(&self, target: Interned<String>) -> Option<&Path> {
773 self.ar.get(&target).map(|p| &**p)
776 /// Returns the path to the C++ compiler for the target specified.
777 fn cxx(&self, target: Interned<String>) -> Result<&Path, String> {
778 match self.cxx.get(&target) {
779 Some(p) => Ok(p.path()),
781 "target `{}` is not configured as a host, only as a target",
786 /// Returns the path to the linker for the given target if it needs to be overridden.
787 fn linker(&self, target: Interned<String>) -> Option<&Path> {
788 if let Some(linker) = self.config.target_config.get(&target)
789 .and_then(|c| c.linker.as_ref()) {
791 } else if target != self.config.build &&
792 !target.contains("msvc") &&
793 !target.contains("emscripten") &&
794 !target.contains("wasm32") {
795 Some(self.cc(target))
801 /// Returns if this target should statically link the C runtime, if specified
802 fn crt_static(&self, target: Interned<String>) -> Option<bool> {
803 if target.contains("pc-windows-msvc") {
806 self.config.target_config.get(&target)
807 .and_then(|t| t.crt_static)
811 /// Returns the "musl root" for this `target`, if defined
812 fn musl_root(&self, target: Interned<String>) -> Option<&Path> {
813 self.config.target_config.get(&target)
814 .and_then(|t| t.musl_root.as_ref())
815 .or(self.config.musl_root.as_ref())
819 /// Returns true if this is a no-std `target`, if defined
820 fn no_std(&self, target: Interned<String>) -> Option<bool> {
821 self.config.target_config.get(&target)
825 /// Returns whether the target will be tested using the `remote-test-client`
826 /// and `remote-test-server` binaries.
827 fn remote_tested(&self, target: Interned<String>) -> bool {
828 self.qemu_rootfs(target).is_some() || target.contains("android") ||
829 env::var_os("TEST_DEVICE_ADDR").is_some()
832 /// Returns the root of the "rootfs" image that this target will be using,
833 /// if one was configured.
835 /// If `Some` is returned then that means that tests for this target are
836 /// emulated with QEMU and binaries will need to be shipped to the emulator.
837 fn qemu_rootfs(&self, target: Interned<String>) -> Option<&Path> {
838 self.config.target_config.get(&target)
839 .and_then(|t| t.qemu_rootfs.as_ref())
843 /// Path to the python interpreter to use
844 fn python(&self) -> &Path {
845 self.config.python.as_ref().unwrap()
848 /// Temporary directory that extended error information is emitted to.
849 fn extended_error_dir(&self) -> PathBuf {
850 self.out.join("tmp/extended-error-metadata")
853 /// Tests whether the `compiler` compiling for `target` should be forced to
854 /// use a stage1 compiler instead.
856 /// Currently, by default, the build system does not perform a "full
857 /// bootstrap" by default where we compile the compiler three times.
858 /// Instead, we compile the compiler two times. The final stage (stage2)
859 /// just copies the libraries from the previous stage, which is what this
862 /// Here we return `true` if:
864 /// * The build isn't performing a full bootstrap
865 /// * The `compiler` is in the final stage, 2
866 /// * We're not cross-compiling, so the artifacts are already available in
869 /// When all of these conditions are met the build will lift artifacts from
870 /// the previous stage forward.
871 fn force_use_stage1(&self, compiler: Compiler, target: Interned<String>) -> bool {
872 !self.config.full_bootstrap &&
873 compiler.stage >= 2 &&
874 (self.hosts.iter().any(|h| *h == target) || target == self.build)
877 /// Returns the directory that OpenSSL artifacts are compiled into if
878 /// configured to do so.
879 fn openssl_dir(&self, target: Interned<String>) -> Option<PathBuf> {
880 // OpenSSL not used on Windows
881 if target.contains("windows") {
883 } else if self.config.openssl_static {
884 Some(self.out.join(&*target).join("openssl"))
890 /// Returns the directory that OpenSSL artifacts are installed into if
891 /// configured as such.
892 fn openssl_install_dir(&self, target: Interned<String>) -> Option<PathBuf> {
893 self.openssl_dir(target).map(|p| p.join("install"))
896 /// Given `num` in the form "a.b.c" return a "release string" which
897 /// describes the release version number.
899 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
900 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
901 fn release(&self, num: &str) -> String {
902 match &self.config.channel[..] {
903 "stable" => num.to_string(),
904 "beta" => if self.rust_info.is_git() {
905 format!("{}-beta.{}", num, self.beta_prerelease_version())
907 format!("{}-beta", num)
909 "nightly" => format!("{}-nightly", num),
910 _ => format!("{}-dev", num),
914 fn beta_prerelease_version(&self) -> u32 {
915 if let Some(s) = self.prerelease_version.get() {
924 .current_dir(&self.src)
926 let beta = beta.trim().split_whitespace().next().unwrap();
932 .current_dir(&self.src)
934 let master = master.trim().split_whitespace().next().unwrap();
936 // Figure out where the current beta branch started.
942 .current_dir(&self.src),
944 let base = base.trim();
946 // Next figure out how many merge commits happened since we branched off
947 // beta. That's our beta number!
953 .arg(format!("{}...HEAD", base))
954 .current_dir(&self.src),
956 let n = count.trim().parse().unwrap();
957 self.prerelease_version.set(Some(n));
961 /// Returns the value of `release` above for Rust itself.
962 fn rust_release(&self) -> String {
963 self.release(channel::CFG_RELEASE_NUM)
966 /// Returns the "package version" for a component given the `num` release
969 /// The package version is typically what shows up in the names of tarballs.
970 /// For channels like beta/nightly it's just the channel name, otherwise
971 /// it's the `num` provided.
972 fn package_vers(&self, num: &str) -> String {
973 match &self.config.channel[..] {
974 "stable" => num.to_string(),
975 "beta" => "beta".to_string(),
976 "nightly" => "nightly".to_string(),
977 _ => format!("{}-dev", num),
981 /// Returns the value of `package_vers` above for Rust itself.
982 fn rust_package_vers(&self) -> String {
983 self.package_vers(channel::CFG_RELEASE_NUM)
986 /// Returns the value of `package_vers` above for Cargo
987 fn cargo_package_vers(&self) -> String {
988 self.package_vers(&self.release_num("cargo"))
991 /// Returns the value of `package_vers` above for rls
992 fn rls_package_vers(&self) -> String {
993 self.package_vers(&self.release_num("rls"))
996 /// Returns the value of `package_vers` above for clippy
997 fn clippy_package_vers(&self) -> String {
998 self.package_vers(&self.release_num("clippy"))
1001 /// Returns the value of `package_vers` above for rustfmt
1002 fn rustfmt_package_vers(&self) -> String {
1003 self.package_vers(&self.release_num("rustfmt"))
1006 fn llvm_tools_package_vers(&self) -> String {
1007 self.package_vers(&self.rust_version())
1010 fn llvm_tools_vers(&self) -> String {
1014 fn lldb_package_vers(&self) -> String {
1015 self.package_vers(&self.rust_version())
1018 fn lldb_vers(&self) -> String {
1022 /// Returns the `version` string associated with this compiler for Rust
1025 /// Note that this is a descriptive string which includes the commit date,
1026 /// sha, version, etc.
1027 fn rust_version(&self) -> String {
1028 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1031 /// Return the full commit hash
1032 fn rust_sha(&self) -> Option<&str> {
1033 self.rust_info.sha()
1036 /// Returns the `a.b.c` version that the given package is at.
1037 fn release_num(&self, package: &str) -> String {
1038 let mut toml = String::new();
1039 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1040 t!(t!(File::open(toml_file_name)).read_to_string(&mut toml));
1041 for line in toml.lines() {
1042 let prefix = "version = \"";
1044 if line.starts_with(prefix) && line.ends_with(suffix) {
1045 return line[prefix.len()..line.len() - suffix.len()].to_string()
1049 panic!("failed to find version in {}'s Cargo.toml", package)
1052 /// Returns whether unstable features should be enabled for the compiler
1054 fn unstable_features(&self) -> bool {
1055 match &self.config.channel[..] {
1056 "stable" | "beta" => false,
1057 "nightly" | _ => true,
1061 /// Fold the output of the commands after this method into a group. The fold
1062 /// ends when the returned object is dropped. Folding can only be used in
1063 /// the Travis CI environment.
1064 pub fn fold_output<D, F>(&self, name: F) -> Option<OutputFolder>
1065 where D: Into<String>, F: FnOnce() -> D
1067 if !self.config.dry_run && self.ci_env == CiEnv::Travis {
1068 Some(OutputFolder::new(name().into()))
1074 /// Updates the actual toolstate of a tool.
1076 /// The toolstates are saved to the file specified by the key
1077 /// `rust.save-toolstates` in `config.toml`. If unspecified, nothing will be
1078 /// done. The file is updated immediately after this function completes.
1079 pub fn save_toolstate(&self, tool: &str, state: ToolState) {
1080 use std::io::{Seek, SeekFrom};
1082 if let Some(ref path) = self.config.save_toolstates {
1083 let mut file = t!(fs::OpenOptions::new()
1089 let mut current_toolstates: HashMap<Box<str>, ToolState> =
1090 serde_json::from_reader(&mut file).unwrap_or_default();
1091 current_toolstates.insert(tool.into(), state);
1092 t!(file.seek(SeekFrom::Start(0)));
1093 t!(file.set_len(0));
1094 t!(serde_json::to_writer(file, ¤t_toolstates));
1098 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1099 let mut ret = Vec::new();
1100 let mut list = vec![INTERNER.intern_str(root)];
1101 let mut visited = HashSet::new();
1102 while let Some(krate) = list.pop() {
1103 let krate = &self.crates[&krate];
1104 if krate.is_local(self) {
1106 for dep in &krate.deps {
1107 if visited.insert(dep) && dep != "build_helper" {
1116 fn read_stamp_file(&self, stamp: &Path) -> Vec<PathBuf> {
1117 if self.config.dry_run {
1121 let mut paths = Vec::new();
1122 let mut contents = Vec::new();
1123 t!(t!(File::open(stamp)).read_to_end(&mut contents));
1124 // This is the method we use for extracting paths from the stamp file passed to us. See
1125 // run_cargo for more information (in compile.rs).
1126 for part in contents.split(|b| *b == 0) {
1127 if part.is_empty() {
1130 let path = PathBuf::from(t!(str::from_utf8(part)));
1136 /// Copies a file from `src` to `dst`
1137 pub fn copy(&self, src: &Path, dst: &Path) {
1138 if self.config.dry_run { return; }
1139 let _ = fs::remove_file(&dst);
1140 let metadata = t!(src.symlink_metadata());
1141 if metadata.file_type().is_symlink() {
1142 let link = t!(fs::read_link(src));
1143 t!(symlink_file(link, dst));
1144 } else if let Ok(()) = fs::hard_link(src, dst) {
1145 // Attempt to "easy copy" by creating a hard link
1146 // (symlinks don't work on windows), but if that fails
1147 // just fall back to a slow `copy` operation.
1149 if let Err(e) = fs::copy(src, dst) {
1150 panic!("failed to copy `{}` to `{}`: {}", src.display(),
1153 t!(fs::set_permissions(dst, metadata.permissions()));
1154 let atime = FileTime::from_last_access_time(&metadata);
1155 let mtime = FileTime::from_last_modification_time(&metadata);
1156 t!(filetime::set_file_times(dst, atime, mtime));
1160 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1161 /// new string for each replacement.)
1162 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1163 if self.config.dry_run { return; }
1164 let mut contents = String::new();
1165 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1166 t!(file.read_to_string(&mut contents));
1167 for &(target, replacement) in replacements {
1168 contents = contents.replace(target, replacement);
1170 t!(file.seek(SeekFrom::Start(0)));
1171 t!(file.set_len(0));
1172 t!(file.write_all(contents.as_bytes()));
1175 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1176 /// when this function is called.
1177 pub fn cp_r(&self, src: &Path, dst: &Path) {
1178 if self.config.dry_run { return; }
1179 for f in t!(fs::read_dir(src)) {
1181 let path = f.path();
1182 let name = path.file_name().unwrap();
1183 let dst = dst.join(name);
1184 if t!(f.file_type()).is_dir() {
1185 t!(fs::create_dir_all(&dst));
1186 self.cp_r(&path, &dst);
1188 let _ = fs::remove_file(&dst);
1189 self.copy(&path, &dst);
1194 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1195 /// when this function is called. Unwanted files or directories can be skipped
1196 /// by returning `false` from the filter function.
1197 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &dyn Fn(&Path) -> bool) {
1198 // Immediately recurse with an empty relative path
1199 self.recurse_(src, dst, Path::new(""), filter)
1202 // Inner function does the actual work
1203 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &dyn Fn(&Path) -> bool) {
1204 for f in self.read_dir(src) {
1205 let path = f.path();
1206 let name = path.file_name().unwrap();
1207 let dst = dst.join(name);
1208 let relative = relative.join(name);
1209 // Only copy file or directory if the filter function returns true
1210 if filter(&relative) {
1211 if t!(f.file_type()).is_dir() {
1212 let _ = fs::remove_dir_all(&dst);
1213 self.create_dir(&dst);
1214 self.recurse_(&path, &dst, &relative, filter);
1216 let _ = fs::remove_file(&dst);
1217 self.copy(&path, &dst);
1223 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1224 let file_name = src.file_name().unwrap();
1225 let dest = dest_folder.join(file_name);
1226 self.copy(src, &dest);
1229 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1230 if self.config.dry_run { return; }
1231 let dst = dstdir.join(src.file_name().unwrap());
1232 t!(fs::create_dir_all(dstdir));
1233 drop(fs::remove_file(&dst));
1235 let mut s = t!(fs::File::open(&src));
1236 let mut d = t!(fs::File::create(&dst));
1237 io::copy(&mut s, &mut d).expect("failed to copy");
1242 fn create(&self, path: &Path, s: &str) {
1243 if self.config.dry_run { return; }
1244 t!(fs::write(path, s));
1247 fn read(&self, path: &Path) -> String {
1248 if self.config.dry_run { return String::new(); }
1249 t!(fs::read_to_string(path))
1252 fn create_dir(&self, dir: &Path) {
1253 if self.config.dry_run { return; }
1254 t!(fs::create_dir_all(dir))
1257 fn remove_dir(&self, dir: &Path) {
1258 if self.config.dry_run { return; }
1259 t!(fs::remove_dir_all(dir))
1262 fn read_dir(&self, dir: &Path) -> impl Iterator<Item=fs::DirEntry> {
1263 let iter = match fs::read_dir(dir) {
1265 Err(_) if self.config.dry_run => return vec![].into_iter(),
1266 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1268 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1271 fn remove(&self, f: &Path) {
1272 if self.config.dry_run { return; }
1273 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1278 fn chmod(path: &Path, perms: u32) {
1279 use std::os::unix::fs::*;
1280 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1283 fn chmod(_path: &Path, _perms: u32) {}
1287 pub fn with_stage(mut self, stage: u32) -> Compiler {
1292 /// Returns whether this is a snapshot compiler for `build`'s configuration
1293 pub fn is_snapshot(&self, build: &Build) -> bool {
1294 self.stage == 0 && self.host == build.build
1297 /// Returns if this compiler should be treated as a final stage one in the
1298 /// current build session.
1299 /// This takes into account whether we're performing a full bootstrap or
1300 /// not; don't directly compare the stage with `2`!
1301 pub fn is_final_stage(&self, build: &Build) -> bool {
1302 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1303 self.stage >= final_stage