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 //! Although this build system defers most of the complicated logic to Cargo
27 //! itself, it still needs to maintain a list of targets and dependencies which
28 //! it can itself perform. Rustbuild is made up of a list of rules with
29 //! dependencies amongst them (created in the `step` module) and then knows how
30 //! to execute each in sequence. Each time rustbuild is invoked, it will simply
31 //! iterate through this list of steps and execute each serially in turn. For
32 //! each step rustbuild relies on the step internally being incremental and
33 //! parallel. Note, though, that the `-j` parameter to rustbuild gets forwarded
34 //! to appropriate test harnesses and such.
36 //! Most of the "meaty" steps that matter are backed by Cargo, which does indeed
37 //! have its own parallelism and incremental management. Later steps, like
38 //! tests, aren't incremental and simply run the entire suite currently.
40 //! When you execute `x.py build`, the steps which are executed are:
42 //! * First, the python script is run. This will automatically download the
43 //! stage0 rustc and cargo according to `src/stage0.txt`, or using the cached
44 //! versions if they're available. These are then used to compile rustbuild
45 //! itself (using Cargo). Finally, control is then transferred to rustbuild.
47 //! * Rustbuild takes over, performs sanity checks, probes the environment,
48 //! reads configuration, builds up a list of steps, and then starts executing
51 //! * The stage0 libstd is compiled
52 //! * The stage0 libtest is compiled
53 //! * The stage0 librustc is compiled
54 //! * The stage1 compiler is assembled
55 //! * The stage1 libstd, libtest, librustc are compiled
56 //! * The stage2 compiler is assembled
57 //! * The stage2 libstd, libtest, librustc are compiled
59 //! Each step is driven by a separate Cargo project and rustbuild orchestrates
60 //! copying files between steps and otherwise preparing for Cargo to run.
62 //! ## Further information
64 //! More documentation can be found in each respective module below, and you can
65 //! also check out the `src/bootstrap/README.md` file for more information.
70 extern crate build_helper;
72 extern crate filetime;
75 extern crate num_cpus;
76 extern crate rustc_serialize;
84 use std::collections::HashMap;
86 use std::ffi::OsString;
87 use std::fs::{self, File};
89 use std::path::{PathBuf, Path};
90 use std::process::Command;
92 use build_helper::{run_silent, run_suppressed, try_run_silent, try_run_suppressed, output, mtime};
94 use util::{exe, libdir, add_lib_path, OutputFolder, CiEnv};
119 pub unsafe fn setup(build: &mut ::Build) {
120 if build.config.low_priority {
121 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
126 #[cfg(not(any(unix, windows)))]
128 pub unsafe fn setup(_build: &mut ::Build) {
132 pub use config::Config;
133 pub use flags::{Flags, Subcommand};
135 /// A structure representing a Rust compiler.
137 /// Each compiler has a `stage` that it is associated with and a `host` that
138 /// corresponds to the platform the compiler runs on. This structure is used as
139 /// a parameter to many methods below.
140 #[derive(Eq, PartialEq, Clone, Copy, Hash, Debug)]
141 pub struct Compiler<'a> {
146 /// Global configuration for the build system.
148 /// This structure transitively contains all configuration for the build system.
149 /// All filesystem-encoded configuration is in `config`, all flags are in
150 /// `flags`, and then parsed or probed information is listed in the keys below.
152 /// This structure is a parameter of almost all methods in the build system,
153 /// although most functions are implemented as free functions rather than
154 /// methods specifically on this structure itself (to make it easier to
157 // User-specified configuration via config.toml
160 // User-specified configuration via CLI flags
163 // Derived properties from the above two configurations
166 rust_info: channel::GitInfo,
167 cargo_info: channel::GitInfo,
168 rls_info: channel::GitInfo,
171 // Stage 0 (downloaded) compiler and cargo or their local rust equivalents.
172 initial_rustc: PathBuf,
173 initial_cargo: PathBuf,
175 // Probed tools at runtime
176 lldb_version: Option<String>,
177 lldb_python_dir: Option<String>,
179 // Runtime state filled in later on
180 // target -> (cc, ar)
181 cc: HashMap<String, (gcc::Tool, Option<PathBuf>)>,
183 cxx: HashMap<String, gcc::Tool>,
184 crates: HashMap<String, Crate>,
188 delayed_failures: Cell<usize>,
203 /// The various "modes" of invoking Cargo.
205 /// These entries currently correspond to the various output directories of the
206 /// build system, with each mod generating output in a different directory.
207 #[derive(Clone, Copy, PartialEq, Eq)]
209 /// Build the standard library, placing output in the "stageN-std" directory.
212 /// Build libtest, placing output in the "stageN-test" directory.
215 /// Build librustc and compiler libraries, placing output in the "stageN-rustc" directory.
218 /// Build some tool, placing output in the "stageN-tools" directory.
223 /// Creates a new set of build configuration from the `flags` on the command
224 /// line and the filesystem `config`.
226 /// By default all build output will be placed in the current directory.
227 pub fn new(flags: Flags, config: Config) -> Build {
228 let cwd = t!(env::current_dir());
229 let src = flags.src.clone();
230 let out = cwd.join("build");
232 let is_sudo = match env::var_os("SUDO_USER") {
234 match env::var_os("USER") {
235 Some(user) => user != sudo_user,
241 let rust_info = channel::GitInfo::new(&src);
242 let cargo_info = channel::GitInfo::new(&src.join("src/tools/cargo"));
243 let rls_info = channel::GitInfo::new(&src.join("src/tools/rls"));
244 let src_is_git = src.join(".git").exists();
247 initial_rustc: config.initial_rustc.clone(),
248 initial_cargo: config.initial_cargo.clone(),
249 local_rebuild: config.local_rebuild,
256 rust_info: rust_info,
257 cargo_info: cargo_info,
261 crates: HashMap::new(),
263 lldb_python_dir: None,
265 src_is_git: src_is_git,
266 ci_env: CiEnv::current(),
267 delayed_failures: Cell::new(0),
271 /// Executes the entire build, as configured by the flags and configuration.
272 pub fn build(&mut self) {
277 if let Subcommand::Clean = self.flags.cmd {
278 return clean::clean(self);
281 self.verbose("finding compilers");
283 self.verbose("running sanity check");
285 // If local-rust is the same major.minor as the current version, then force a local-rebuild
286 let local_version_verbose = output(
287 Command::new(&self.initial_rustc).arg("--version").arg("--verbose"));
288 let local_release = local_version_verbose
289 .lines().filter(|x| x.starts_with("release:"))
290 .next().unwrap().trim_left_matches("release:").trim();
291 let my_version = channel::CFG_RELEASE_NUM;
292 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
293 self.verbose(&format!("auto-detected local-rebuild {}", local_release));
294 self.local_rebuild = true;
296 self.verbose("learning about cargo");
297 metadata::build(self);
302 /// Clear out `dir` if `input` is newer.
304 /// After this executes, it will also ensure that `dir` exists.
305 fn clear_if_dirty(&self, dir: &Path, input: &Path) {
306 let stamp = dir.join(".stamp");
307 if mtime(&stamp) < mtime(input) {
308 self.verbose(&format!("Dirty - {}", dir.display()));
309 let _ = fs::remove_dir_all(dir);
310 } else if stamp.exists() {
313 t!(fs::create_dir_all(dir));
314 t!(File::create(stamp));
317 /// Prepares an invocation of `cargo` to be run.
319 /// This will create a `Command` that represents a pending execution of
320 /// Cargo. This cargo will be configured to use `compiler` as the actual
321 /// rustc compiler, its output will be scoped by `mode`'s output directory,
322 /// it will pass the `--target` flag for the specified `target`, and will be
323 /// executing the Cargo command `cmd`.
328 cmd: &str) -> Command {
329 let mut cargo = Command::new(&self.initial_cargo);
330 let out_dir = self.stage_out(compiler, mode);
331 cargo.env("CARGO_TARGET_DIR", out_dir)
333 .arg("-j").arg(self.jobs().to_string())
334 .arg("--target").arg(target);
336 // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
337 // Force cargo to output binaries with disambiguating hashes in the name
338 cargo.env("__CARGO_DEFAULT_LIB_METADATA", &self.config.channel);
341 if compiler.stage == 0 && self.local_rebuild {
342 // Assume the local-rebuild rustc already has stage1 features.
345 stage = compiler.stage;
348 // Customize the compiler we're running. Specify the compiler to cargo
349 // as our shim and then pass it some various options used to configure
350 // how the actual compiler itself is called.
352 // These variables are primarily all read by
353 // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
354 cargo.env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
355 .env("RUSTC", self.out.join("bootstrap/debug/rustc"))
356 .env("RUSTC_REAL", self.compiler_path(compiler))
357 .env("RUSTC_STAGE", stage.to_string())
358 .env("RUSTC_CODEGEN_UNITS",
359 self.config.rust_codegen_units.to_string())
360 .env("RUSTC_DEBUG_ASSERTIONS",
361 self.config.rust_debug_assertions.to_string())
362 .env("RUSTC_SYSROOT", self.sysroot(compiler))
363 .env("RUSTC_LIBDIR", self.rustc_libdir(compiler))
364 .env("RUSTC_RPATH", self.config.rust_rpath.to_string())
365 .env("RUSTDOC", self.out.join("bootstrap/debug/rustdoc"))
366 .env("RUSTDOC_REAL", self.rustdoc(compiler))
367 .env("RUSTC_FLAGS", self.rustc_flags(target).join(" "));
369 if mode != Mode::Tool {
370 // Tools don't get debuginfo right now, e.g. cargo and rls don't
371 // get compiled with debuginfo.
372 cargo.env("RUSTC_DEBUGINFO", self.config.rust_debuginfo.to_string())
373 .env("RUSTC_DEBUGINFO_LINES", self.config.rust_debuginfo_lines.to_string())
374 .env("RUSTC_FORCE_UNSTABLE", "1");
376 // Currently the compiler depends on crates from crates.io, and
377 // then other crates can depend on the compiler (e.g. proc-macro
378 // crates). Let's say, for example that rustc itself depends on the
379 // bitflags crate. If an external crate then depends on the
380 // bitflags crate as well, we need to make sure they don't
381 // conflict, even if they pick the same verison of bitflags. We'll
382 // want to make sure that e.g. a plugin and rustc each get their
383 // own copy of bitflags.
385 // Cargo ensures that this works in general through the -C metadata
386 // flag. This flag will frob the symbols in the binary to make sure
387 // they're different, even though the source code is the exact
388 // same. To solve this problem for the compiler we extend Cargo's
389 // already-passed -C metadata flag with our own. Our rustc.rs
390 // wrapper around the actual rustc will detect -C metadata being
391 // passed and frob it with this extra string we're passing in.
392 cargo.env("RUSTC_METADATA_SUFFIX", "rustc");
395 // Enable usage of unstable features
396 cargo.env("RUSTC_BOOTSTRAP", "1");
397 self.add_rust_test_threads(&mut cargo);
399 // Almost all of the crates that we compile as part of the bootstrap may
400 // have a build script, including the standard library. To compile a
401 // build script, however, it itself needs a standard library! This
402 // introduces a bit of a pickle when we're compiling the standard
405 // To work around this we actually end up using the snapshot compiler
406 // (stage0) for compiling build scripts of the standard library itself.
407 // The stage0 compiler is guaranteed to have a libstd available for use.
409 // For other crates, however, we know that we've already got a standard
410 // library up and running, so we can use the normal compiler to compile
411 // build scripts in that situation.
412 if mode == Mode::Libstd {
413 cargo.env("RUSTC_SNAPSHOT", &self.initial_rustc)
414 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
416 cargo.env("RUSTC_SNAPSHOT", self.compiler_path(compiler))
417 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
420 // Ignore incremental modes except for stage0, since we're
421 // not guaranteeing correctness across builds if the compiler
422 // is changing under your feet.`
423 if self.flags.incremental && compiler.stage == 0 {
424 let incr_dir = self.incremental_dir(compiler);
425 cargo.env("RUSTC_INCREMENTAL", incr_dir);
428 if let Some(ref on_fail) = self.flags.on_fail {
429 cargo.env("RUSTC_ON_FAIL", on_fail);
432 let verbose = cmp::max(self.config.verbose, self.flags.verbose);
433 cargo.env("RUSTC_VERBOSE", format!("{}", verbose));
435 // Specify some various options for build scripts used throughout
438 // FIXME: the guard against msvc shouldn't need to be here
439 if !target.contains("msvc") {
440 cargo.env(format!("CC_{}", target), self.cc(target))
441 .env(format!("AR_{}", target), self.ar(target).unwrap()) // only msvc is None
442 .env(format!("CFLAGS_{}", target), self.cflags(target).join(" "));
444 if let Ok(cxx) = self.cxx(target) {
445 cargo.env(format!("CXX_{}", target), cxx);
449 if self.config.extended && compiler.is_final_stage(self) {
450 cargo.env("RUSTC_SAVE_ANALYSIS", "api".to_string());
453 // When being built Cargo will at some point call `nmake.exe` on Windows
454 // MSVC. Unfortunately `nmake` will read these two environment variables
455 // below and try to intepret them. We're likely being run, however, from
456 // MSYS `make` which uses the same variables.
458 // As a result, to prevent confusion and errors, we remove these
459 // variables from our environment to prevent passing MSYS make flags to
460 // nmake, causing it to blow up.
461 if cfg!(target_env = "msvc") {
462 cargo.env_remove("MAKE");
463 cargo.env_remove("MAKEFLAGS");
466 // Environment variables *required* throughout the build
468 // FIXME: should update code to not require this env var
469 cargo.env("CFG_COMPILER_HOST_TRIPLE", target);
471 if self.config.verbose() || self.flags.verbose() {
474 // FIXME: cargo bench does not accept `--release`
475 if self.config.rust_optimize && cmd != "bench" {
476 cargo.arg("--release");
478 if self.config.locked_deps {
479 cargo.arg("--locked");
481 if self.config.vendor || self.is_sudo {
482 cargo.arg("--frozen");
485 self.ci_env.force_coloring_in_ci(&mut cargo);
490 /// Get a path to the compiler specified.
491 fn compiler_path(&self, compiler: &Compiler) -> PathBuf {
492 if compiler.is_snapshot(self) {
493 self.initial_rustc.clone()
495 self.sysroot(compiler).join("bin").join(exe("rustc", compiler.host))
499 /// Get the specified tool built by the specified compiler
500 fn tool(&self, compiler: &Compiler, tool: &str) -> PathBuf {
501 self.cargo_out(compiler, Mode::Tool, compiler.host)
502 .join(exe(tool, compiler.host))
505 /// Get the `rustdoc` executable next to the specified compiler
506 fn rustdoc(&self, compiler: &Compiler) -> PathBuf {
507 let mut rustdoc = self.compiler_path(compiler);
509 rustdoc.push(exe("rustdoc", compiler.host));
513 /// Get a `Command` which is ready to run `tool` in `stage` built for
515 fn tool_cmd(&self, compiler: &Compiler, tool: &str) -> Command {
516 let mut cmd = Command::new(self.tool(&compiler, tool));
517 self.prepare_tool_cmd(compiler, &mut cmd);
521 /// Prepares the `cmd` provided to be able to run the `compiler` provided.
523 /// Notably this munges the dynamic library lookup path to point to the
524 /// right location to run `compiler`.
525 fn prepare_tool_cmd(&self, compiler: &Compiler, cmd: &mut Command) {
526 let host = compiler.host;
527 let mut paths = vec![
528 self.sysroot_libdir(compiler, compiler.host),
529 self.cargo_out(compiler, Mode::Tool, host).join("deps"),
532 // On MSVC a tool may invoke a C compiler (e.g. compiletest in run-make
533 // mode) and that C compiler may need some extra PATH modification. Do
535 if compiler.host.contains("msvc") {
536 let curpaths = env::var_os("PATH").unwrap_or(OsString::new());
537 let curpaths = env::split_paths(&curpaths).collect::<Vec<_>>();
538 for &(ref k, ref v) in self.cc[compiler.host].0.env() {
542 for path in env::split_paths(v) {
543 if !curpaths.contains(&path) {
549 add_lib_path(paths, cmd);
552 /// Get the space-separated set of activated features for the standard
554 fn std_features(&self) -> String {
555 let mut features = "panic-unwind".to_string();
557 if self.config.debug_jemalloc {
558 features.push_str(" debug-jemalloc");
560 if self.config.use_jemalloc {
561 features.push_str(" jemalloc");
563 if self.config.backtrace {
564 features.push_str(" backtrace");
566 if self.config.profiler {
567 features.push_str(" profiler");
572 /// Get the space-separated set of activated features for the compiler.
573 fn rustc_features(&self) -> String {
574 let mut features = String::new();
575 if self.config.use_jemalloc {
576 features.push_str(" jemalloc");
581 /// Component directory that Cargo will produce output into (e.g.
583 fn cargo_dir(&self) -> &'static str {
584 if self.config.rust_optimize {"release"} else {"debug"}
587 /// Returns the sysroot for the `compiler` specified that *this build system
590 /// That is, the sysroot for the stage0 compiler is not what the compiler
591 /// thinks it is by default, but it's the same as the default for stages
593 fn sysroot(&self, compiler: &Compiler) -> PathBuf {
594 if compiler.stage == 0 {
595 self.out.join(compiler.host).join("stage0-sysroot")
597 self.out.join(compiler.host).join(format!("stage{}", compiler.stage))
601 /// Get the directory for incremental by-products when using the
603 fn incremental_dir(&self, compiler: &Compiler) -> PathBuf {
604 self.out.join(compiler.host).join(format!("stage{}-incremental", compiler.stage))
607 /// Returns the libdir where the standard library and other artifacts are
608 /// found for a compiler's sysroot.
609 fn sysroot_libdir(&self, compiler: &Compiler, target: &str) -> PathBuf {
610 self.sysroot(compiler).join("lib").join("rustlib")
611 .join(target).join("lib")
614 /// Returns the root directory for all output generated in a particular
615 /// stage when running with a particular host compiler.
617 /// The mode indicates what the root directory is for.
618 fn stage_out(&self, compiler: &Compiler, mode: Mode) -> PathBuf {
619 let suffix = match mode {
620 Mode::Libstd => "-std",
621 Mode::Libtest => "-test",
622 Mode::Tool => "-tools",
623 Mode::Librustc => "-rustc",
625 self.out.join(compiler.host)
626 .join(format!("stage{}{}", compiler.stage, suffix))
629 /// Returns the root output directory for all Cargo output in a given stage,
630 /// running a particular compiler, wehther or not we're building the
631 /// standard library, and targeting the specified architecture.
635 target: &str) -> PathBuf {
636 self.stage_out(compiler, mode).join(target).join(self.cargo_dir())
639 /// Root output directory for LLVM compiled for `target`
641 /// Note that if LLVM is configured externally then the directory returned
642 /// will likely be empty.
643 fn llvm_out(&self, target: &str) -> PathBuf {
644 self.out.join(target).join("llvm")
647 /// Output directory for all documentation for a target
648 fn doc_out(&self, target: &str) -> PathBuf {
649 self.out.join(target).join("doc")
652 /// Output directory for some generated md crate documentation for a target (temporary)
653 fn md_doc_out(&self, target: &str) -> PathBuf {
654 self.out.join(target).join("md-doc")
657 /// Output directory for all crate documentation for a target (temporary)
659 /// The artifacts here are then copied into `doc_out` above.
660 fn crate_doc_out(&self, target: &str) -> PathBuf {
661 self.out.join(target).join("crate-docs")
664 /// Returns true if no custom `llvm-config` is set for the specified target.
666 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
667 fn is_rust_llvm(&self, target: &str) -> bool {
668 match self.config.target_config.get(target) {
669 Some(ref c) => c.llvm_config.is_none(),
674 /// Returns the path to `llvm-config` for the specified target.
676 /// If a custom `llvm-config` was specified for target then that's returned
678 fn llvm_config(&self, target: &str) -> PathBuf {
679 let target_config = self.config.target_config.get(target);
680 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
683 self.llvm_out(&self.config.build).join("bin")
684 .join(exe("llvm-config", target))
688 /// Returns the path to `FileCheck` binary for the specified target
689 fn llvm_filecheck(&self, target: &str) -> PathBuf {
690 let target_config = self.config.target_config.get(target);
691 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
692 let llvm_bindir = output(Command::new(s).arg("--bindir"));
693 Path::new(llvm_bindir.trim()).join(exe("FileCheck", target))
695 let base = self.llvm_out(&self.config.build).join("build");
696 let exe = exe("FileCheck", target);
697 if !self.config.ninja && self.config.build.contains("msvc") {
698 base.join("Release/bin").join(exe)
700 base.join("bin").join(exe)
705 /// Directory for libraries built from C/C++ code and shared between stages.
706 fn native_dir(&self, target: &str) -> PathBuf {
707 self.out.join(target).join("native")
710 /// Root output directory for rust_test_helpers library compiled for
712 fn test_helpers_out(&self, target: &str) -> PathBuf {
713 self.native_dir(target).join("rust-test-helpers")
716 /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
717 /// library lookup path.
718 fn add_rustc_lib_path(&self, compiler: &Compiler, cmd: &mut Command) {
719 // Windows doesn't need dylib path munging because the dlls for the
720 // compiler live next to the compiler and the system will find them
726 add_lib_path(vec![self.rustc_libdir(compiler)], cmd);
729 /// Adds the `RUST_TEST_THREADS` env var if necessary
730 fn add_rust_test_threads(&self, cmd: &mut Command) {
731 if env::var_os("RUST_TEST_THREADS").is_none() {
732 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
736 /// Returns the compiler's libdir where it stores the dynamic libraries that
737 /// it itself links against.
739 /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
741 fn rustc_libdir(&self, compiler: &Compiler) -> PathBuf {
742 if compiler.is_snapshot(self) {
743 self.rustc_snapshot_libdir()
745 self.sysroot(compiler).join(libdir(compiler.host))
749 /// Returns the libdir of the snapshot compiler.
750 fn rustc_snapshot_libdir(&self) -> PathBuf {
751 self.initial_rustc.parent().unwrap().parent().unwrap()
752 .join(libdir(&self.config.build))
755 /// Runs a command, printing out nice contextual information if it fails.
756 fn run(&self, cmd: &mut Command) {
757 self.verbose(&format!("running: {:?}", cmd));
761 /// Runs a command, printing out nice contextual information if it fails.
762 fn run_quiet(&self, cmd: &mut Command) {
763 self.verbose(&format!("running: {:?}", cmd));
767 /// Runs a command, printing out nice contextual information if it fails.
768 /// Exits if the command failed to execute at all, otherwise returns its
769 /// `status.success()`.
770 fn try_run(&self, cmd: &mut Command) -> bool {
771 self.verbose(&format!("running: {:?}", cmd));
775 /// Runs a command, printing out nice contextual information if it fails.
776 /// Exits if the command failed to execute at all, otherwise returns its
777 /// `status.success()`.
778 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
779 self.verbose(&format!("running: {:?}", cmd));
780 try_run_suppressed(cmd)
783 /// Prints a message if this build is configured in verbose mode.
784 fn verbose(&self, msg: &str) {
785 if self.flags.verbose() || self.config.verbose() {
790 /// Returns the number of parallel jobs that have been configured for this
792 fn jobs(&self) -> u32 {
793 self.flags.jobs.unwrap_or(num_cpus::get() as u32)
796 /// Returns the path to the C compiler for the target specified.
797 fn cc(&self, target: &str) -> &Path {
798 self.cc[target].0.path()
801 /// Returns a list of flags to pass to the C compiler for the target
803 fn cflags(&self, target: &str) -> Vec<String> {
804 // Filter out -O and /O (the optimization flags) that we picked up from
805 // gcc-rs because the build scripts will determine that for themselves.
806 let mut base = self.cc[target].0.args().iter()
807 .map(|s| s.to_string_lossy().into_owned())
808 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
809 .collect::<Vec<_>>();
811 // If we're compiling on macOS then we add a few unconditional flags
812 // indicating that we want libc++ (more filled out than libstdc++) and
813 // we want to compile for 10.7. This way we can ensure that
814 // LLVM/jemalloc/etc are all properly compiled.
815 if target.contains("apple-darwin") {
816 base.push("-stdlib=libc++".into());
819 // Work around an apparently bad MinGW / GCC optimization,
820 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
821 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
822 if target == "i686-pc-windows-gnu" {
823 base.push("-fno-omit-frame-pointer".into());
828 /// Returns the path to the `ar` archive utility for the target specified.
829 fn ar(&self, target: &str) -> Option<&Path> {
830 self.cc[target].1.as_ref().map(|p| &**p)
833 /// Returns the path to the C++ compiler for the target specified.
834 fn cxx(&self, target: &str) -> Result<&Path, String> {
835 match self.cxx.get(target) {
836 Some(p) => Ok(p.path()),
838 "target `{}` is not configured as a host, only as a target",
843 /// Returns flags to pass to the compiler to generate code for `target`.
844 fn rustc_flags(&self, target: &str) -> Vec<String> {
845 // New flags should be added here with great caution!
847 // It's quite unfortunate to **require** flags to generate code for a
848 // target, so it should only be passed here if absolutely necessary!
849 // Most default configuration should be done through target specs rather
850 // than an entry here.
852 let mut base = Vec::new();
853 if target != self.config.build && !target.contains("msvc") &&
854 !target.contains("emscripten") {
855 base.push(format!("-Clinker={}", self.cc(target).display()));
860 /// Returns the "musl root" for this `target`, if defined
861 fn musl_root(&self, target: &str) -> Option<&Path> {
862 self.config.target_config.get(target)
863 .and_then(|t| t.musl_root.as_ref())
864 .or(self.config.musl_root.as_ref())
868 /// Returns whether the target will be tested using the `remote-test-client`
869 /// and `remote-test-server` binaries.
870 fn remote_tested(&self, target: &str) -> bool {
871 self.qemu_rootfs(target).is_some() || target.contains("android")
874 /// Returns the root of the "rootfs" image that this target will be using,
875 /// if one was configured.
877 /// If `Some` is returned then that means that tests for this target are
878 /// emulated with QEMU and binaries will need to be shipped to the emulator.
879 fn qemu_rootfs(&self, target: &str) -> Option<&Path> {
880 self.config.target_config.get(target)
881 .and_then(|t| t.qemu_rootfs.as_ref())
885 /// Path to the python interpreter to use
886 fn python(&self) -> &Path {
887 self.config.python.as_ref().unwrap()
890 /// Tests whether the `compiler` compiling for `target` should be forced to
891 /// use a stage1 compiler instead.
893 /// Currently, by default, the build system does not perform a "full
894 /// bootstrap" by default where we compile the compiler three times.
895 /// Instead, we compile the compiler two times. The final stage (stage2)
896 /// just copies the libraries from the previous stage, which is what this
899 /// Here we return `true` if:
901 /// * The build isn't performing a full bootstrap
902 /// * The `compiler` is in the final stage, 2
903 /// * We're not cross-compiling, so the artifacts are already available in
906 /// When all of these conditions are met the build will lift artifacts from
907 /// the previous stage forward.
908 fn force_use_stage1(&self, compiler: &Compiler, target: &str) -> bool {
909 !self.config.full_bootstrap &&
910 compiler.stage >= 2 &&
911 self.config.host.iter().any(|h| h == target)
914 /// Returns the directory that OpenSSL artifacts are compiled into if
915 /// configured to do so.
916 fn openssl_dir(&self, target: &str) -> Option<PathBuf> {
917 // OpenSSL not used on Windows
918 if target.contains("windows") {
920 } else if self.config.openssl_static {
921 Some(self.out.join(target).join("openssl"))
927 /// Returns the directory that OpenSSL artifacts are installed into if
928 /// configured as such.
929 fn openssl_install_dir(&self, target: &str) -> Option<PathBuf> {
930 self.openssl_dir(target).map(|p| p.join("install"))
933 /// Given `num` in the form "a.b.c" return a "release string" which
934 /// describes the release version number.
936 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
937 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
938 fn release(&self, num: &str) -> String {
939 match &self.config.channel[..] {
940 "stable" => num.to_string(),
941 "beta" => format!("{}-beta{}", num, channel::CFG_PRERELEASE_VERSION),
942 "nightly" => format!("{}-nightly", num),
943 _ => format!("{}-dev", num),
947 /// Returns the value of `release` above for Rust itself.
948 fn rust_release(&self) -> String {
949 self.release(channel::CFG_RELEASE_NUM)
952 /// Returns the "package version" for a component given the `num` release
955 /// The package version is typically what shows up in the names of tarballs.
956 /// For channels like beta/nightly it's just the channel name, otherwise
957 /// it's the `num` provided.
958 fn package_vers(&self, num: &str) -> String {
959 match &self.config.channel[..] {
960 "stable" => num.to_string(),
961 "beta" => "beta".to_string(),
962 "nightly" => "nightly".to_string(),
963 _ => format!("{}-dev", num),
967 /// Returns the value of `package_vers` above for Rust itself.
968 fn rust_package_vers(&self) -> String {
969 self.package_vers(channel::CFG_RELEASE_NUM)
972 /// Returns the value of `package_vers` above for Cargo
973 fn cargo_package_vers(&self) -> String {
974 self.package_vers(&self.release_num("cargo"))
977 /// Returns the value of `package_vers` above for rls
978 fn rls_package_vers(&self) -> String {
979 self.package_vers(&self.release_num("rls"))
982 /// Returns the `version` string associated with this compiler for Rust
985 /// Note that this is a descriptive string which includes the commit date,
986 /// sha, version, etc.
987 fn rust_version(&self) -> String {
988 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
991 /// Returns the `a.b.c` version that the given package is at.
992 fn release_num(&self, package: &str) -> String {
993 let mut toml = String::new();
994 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
995 t!(t!(File::open(toml_file_name)).read_to_string(&mut toml));
996 for line in toml.lines() {
997 let prefix = "version = \"";
999 if line.starts_with(prefix) && line.ends_with(suffix) {
1000 return line[prefix.len()..line.len() - suffix.len()].to_string()
1004 panic!("failed to find version in {}'s Cargo.toml", package)
1007 /// Returns whether unstable features should be enabled for the compiler
1009 fn unstable_features(&self) -> bool {
1010 match &self.config.channel[..] {
1011 "stable" | "beta" => false,
1012 "nightly" | _ => true,
1016 /// Fold the output of the commands after this method into a group. The fold
1017 /// ends when the returned object is dropped. Folding can only be used in
1018 /// the Travis CI environment.
1019 pub fn fold_output<D, F>(&self, name: F) -> Option<OutputFolder>
1020 where D: Into<String>, F: FnOnce() -> D
1022 if self.ci_env == CiEnv::Travis {
1023 Some(OutputFolder::new(name().into()))
1030 impl<'a> Compiler<'a> {
1031 /// Creates a new complier for the specified stage/host
1032 fn new(stage: u32, host: &'a str) -> Compiler<'a> {
1033 Compiler { stage: stage, host: host }
1036 /// Returns whether this is a snapshot compiler for `build`'s configuration
1037 fn is_snapshot(&self, build: &Build) -> bool {
1038 self.stage == 0 && self.host == build.config.build
1041 /// Returns if this compiler should be treated as a final stage one in the
1042 /// current build session.
1043 /// This takes into account whether we're performing a full bootstrap or
1044 /// not; don't directly compare the stage with `2`!
1045 fn is_final_stage(&self, build: &Build) -> bool {
1046 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1047 self.stage >= final_stage