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};
121 pub unsafe fn setup(build: &mut ::Build) {
122 if build.config.low_priority {
123 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
128 #[cfg(not(any(unix, windows)))]
130 pub unsafe fn setup(_build: &mut ::Build) {
134 pub use config::Config;
135 pub use flags::{Flags, Subcommand};
137 /// A structure representing a Rust compiler.
139 /// Each compiler has a `stage` that it is associated with and a `host` that
140 /// corresponds to the platform the compiler runs on. This structure is used as
141 /// a parameter to many methods below.
142 #[derive(Eq, PartialEq, Clone, Copy, Hash, Debug)]
143 pub struct Compiler<'a> {
148 /// Global configuration for the build system.
150 /// This structure transitively contains all configuration for the build system.
151 /// All filesystem-encoded configuration is in `config`, all flags are in
152 /// `flags`, and then parsed or probed information is listed in the keys below.
154 /// This structure is a parameter of almost all methods in the build system,
155 /// although most functions are implemented as free functions rather than
156 /// methods specifically on this structure itself (to make it easier to
159 // User-specified configuration via config.toml
162 // User-specified configuration via CLI flags
165 // Derived properties from the above two configurations
168 rust_info: channel::GitInfo,
169 cargo_info: channel::GitInfo,
170 rls_info: channel::GitInfo,
175 // Targets for which to build.
178 targets: Vec<String>,
180 // Stage 0 (downloaded) compiler and cargo or their local rust equivalents.
181 initial_rustc: PathBuf,
182 initial_cargo: PathBuf,
184 // Probed tools at runtime
185 lldb_version: Option<String>,
186 lldb_python_dir: Option<String>,
188 // Runtime state filled in later on
189 // target -> (cc, ar)
190 cc: HashMap<String, (gcc::Tool, Option<PathBuf>)>,
192 cxx: HashMap<String, gcc::Tool>,
193 crates: HashMap<String, Crate>,
196 delayed_failures: Cell<usize>,
211 /// The various "modes" of invoking Cargo.
213 /// These entries currently correspond to the various output directories of the
214 /// build system, with each mod generating output in a different directory.
215 #[derive(Clone, Copy, PartialEq, Eq)]
217 /// Build the standard library, placing output in the "stageN-std" directory.
220 /// Build libtest, placing output in the "stageN-test" directory.
223 /// Build librustc and compiler libraries, placing output in the "stageN-rustc" directory.
226 /// Build some tool, placing output in the "stageN-tools" directory.
231 /// Creates a new set of build configuration from the `flags` on the command
232 /// line and the filesystem `config`.
234 /// By default all build output will be placed in the current directory.
235 pub fn new(flags: Flags, config: Config) -> Build {
236 let cwd = t!(env::current_dir());
237 let src = flags.src.clone();
238 let out = cwd.join("build");
240 let is_sudo = match env::var_os("SUDO_USER") {
242 match env::var_os("USER") {
243 Some(user) => user != sudo_user,
249 let rust_info = channel::GitInfo::new(&src);
250 let cargo_info = channel::GitInfo::new(&src.join("src/tools/cargo"));
251 let rls_info = channel::GitInfo::new(&src.join("src/tools/rls"));
253 let hosts = if !flags.host.is_empty() {
254 for host in flags.host.iter() {
255 if !config.host.contains(host) {
256 panic!("specified host `{}` is not in configuration", host);
263 let targets = if !flags.target.is_empty() {
264 for target in flags.target.iter() {
265 if !config.target.contains(target) {
266 panic!("specified target `{}` is not in configuration", target);
271 config.target.clone()
275 initial_rustc: config.initial_rustc.clone(),
276 initial_cargo: config.initial_cargo.clone(),
277 local_rebuild: config.local_rebuild,
278 fail_fast: flags.cmd.fail_fast(),
279 verbosity: cmp::max(flags.verbose, config.verbose),
281 build: config.host[0].clone(),
290 rust_info: rust_info,
291 cargo_info: cargo_info,
295 crates: HashMap::new(),
297 lldb_python_dir: None,
299 ci_env: CiEnv::current(),
300 delayed_failures: Cell::new(0),
304 fn build_slice(&self) -> &[String] {
306 std::slice::from_raw_parts(&self.build, 1)
310 /// Executes the entire build, as configured by the flags and configuration.
311 pub fn build(&mut self) {
316 if let Subcommand::Clean = self.flags.cmd {
317 return clean::clean(self);
320 self.verbose("finding compilers");
322 self.verbose("running sanity check");
324 // If local-rust is the same major.minor as the current version, then force a local-rebuild
325 let local_version_verbose = output(
326 Command::new(&self.initial_rustc).arg("--version").arg("--verbose"));
327 let local_release = local_version_verbose
328 .lines().filter(|x| x.starts_with("release:"))
329 .next().unwrap().trim_left_matches("release:").trim();
330 let my_version = channel::CFG_RELEASE_NUM;
331 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
332 self.verbose(&format!("auto-detected local-rebuild {}", local_release));
333 self.local_rebuild = true;
335 self.verbose("learning about cargo");
336 metadata::build(self);
341 /// Clear out `dir` if `input` is newer.
343 /// After this executes, it will also ensure that `dir` exists.
344 fn clear_if_dirty(&self, dir: &Path, input: &Path) {
345 let stamp = dir.join(".stamp");
346 if mtime(&stamp) < mtime(input) {
347 self.verbose(&format!("Dirty - {}", dir.display()));
348 let _ = fs::remove_dir_all(dir);
349 } else if stamp.exists() {
352 t!(fs::create_dir_all(dir));
353 t!(File::create(stamp));
356 /// Prepares an invocation of `cargo` to be run.
358 /// This will create a `Command` that represents a pending execution of
359 /// Cargo. This cargo will be configured to use `compiler` as the actual
360 /// rustc compiler, its output will be scoped by `mode`'s output directory,
361 /// it will pass the `--target` flag for the specified `target`, and will be
362 /// executing the Cargo command `cmd`.
367 cmd: &str) -> Command {
368 let mut cargo = Command::new(&self.initial_cargo);
369 let out_dir = self.stage_out(compiler, mode);
370 cargo.env("CARGO_TARGET_DIR", out_dir)
372 .arg("-j").arg(self.jobs().to_string())
373 .arg("--target").arg(target);
375 // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
376 // Force cargo to output binaries with disambiguating hashes in the name
377 cargo.env("__CARGO_DEFAULT_LIB_METADATA", &self.config.channel);
380 if compiler.stage == 0 && self.local_rebuild {
381 // Assume the local-rebuild rustc already has stage1 features.
384 stage = compiler.stage;
387 // Customize the compiler we're running. Specify the compiler to cargo
388 // as our shim and then pass it some various options used to configure
389 // how the actual compiler itself is called.
391 // These variables are primarily all read by
392 // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
393 cargo.env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
394 .env("RUSTC", self.out.join("bootstrap/debug/rustc"))
395 .env("RUSTC_REAL", self.compiler_path(compiler))
396 .env("RUSTC_STAGE", stage.to_string())
397 .env("RUSTC_CODEGEN_UNITS",
398 self.config.rust_codegen_units.to_string())
399 .env("RUSTC_DEBUG_ASSERTIONS",
400 self.config.rust_debug_assertions.to_string())
401 .env("RUSTC_SYSROOT", self.sysroot(compiler))
402 .env("RUSTC_LIBDIR", self.rustc_libdir(compiler))
403 .env("RUSTC_RPATH", self.config.rust_rpath.to_string())
404 .env("RUSTDOC", self.out.join("bootstrap/debug/rustdoc"))
405 .env("RUSTDOC_REAL", self.rustdoc(compiler))
406 .env("RUSTC_FLAGS", self.rustc_flags(target).join(" "));
408 if mode != Mode::Tool {
409 // Tools don't get debuginfo right now, e.g. cargo and rls don't
410 // get compiled with debuginfo.
411 cargo.env("RUSTC_DEBUGINFO", self.config.rust_debuginfo.to_string())
412 .env("RUSTC_DEBUGINFO_LINES", self.config.rust_debuginfo_lines.to_string())
413 .env("RUSTC_FORCE_UNSTABLE", "1");
415 // Currently the compiler depends on crates from crates.io, and
416 // then other crates can depend on the compiler (e.g. proc-macro
417 // crates). Let's say, for example that rustc itself depends on the
418 // bitflags crate. If an external crate then depends on the
419 // bitflags crate as well, we need to make sure they don't
420 // conflict, even if they pick the same verison of bitflags. We'll
421 // want to make sure that e.g. a plugin and rustc each get their
422 // own copy of bitflags.
424 // Cargo ensures that this works in general through the -C metadata
425 // flag. This flag will frob the symbols in the binary to make sure
426 // they're different, even though the source code is the exact
427 // same. To solve this problem for the compiler we extend Cargo's
428 // already-passed -C metadata flag with our own. Our rustc.rs
429 // wrapper around the actual rustc will detect -C metadata being
430 // passed and frob it with this extra string we're passing in.
431 cargo.env("RUSTC_METADATA_SUFFIX", "rustc");
434 // Enable usage of unstable features
435 cargo.env("RUSTC_BOOTSTRAP", "1");
436 self.add_rust_test_threads(&mut cargo);
438 // Almost all of the crates that we compile as part of the bootstrap may
439 // have a build script, including the standard library. To compile a
440 // build script, however, it itself needs a standard library! This
441 // introduces a bit of a pickle when we're compiling the standard
444 // To work around this we actually end up using the snapshot compiler
445 // (stage0) for compiling build scripts of the standard library itself.
446 // The stage0 compiler is guaranteed to have a libstd available for use.
448 // For other crates, however, we know that we've already got a standard
449 // library up and running, so we can use the normal compiler to compile
450 // build scripts in that situation.
451 if mode == Mode::Libstd {
452 cargo.env("RUSTC_SNAPSHOT", &self.initial_rustc)
453 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
455 cargo.env("RUSTC_SNAPSHOT", self.compiler_path(compiler))
456 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
459 // Ignore incremental modes except for stage0, since we're
460 // not guaranteeing correctness across builds if the compiler
461 // is changing under your feet.`
462 if self.flags.incremental && compiler.stage == 0 {
463 let incr_dir = self.incremental_dir(compiler);
464 cargo.env("RUSTC_INCREMENTAL", incr_dir);
467 if let Some(ref on_fail) = self.flags.on_fail {
468 cargo.env("RUSTC_ON_FAIL", on_fail);
471 cargo.env("RUSTC_VERBOSE", format!("{}", self.verbosity));
473 // Specify some various options for build scripts used throughout
476 // FIXME: the guard against msvc shouldn't need to be here
477 if !target.contains("msvc") {
478 cargo.env(format!("CC_{}", target), self.cc(target))
479 .env(format!("AR_{}", target), self.ar(target).unwrap()) // only msvc is None
480 .env(format!("CFLAGS_{}", target), self.cflags(target).join(" "));
482 if let Ok(cxx) = self.cxx(target) {
483 cargo.env(format!("CXX_{}", target), cxx);
487 if mode == Mode::Libstd &&
488 self.config.extended &&
489 compiler.is_final_stage(self) {
490 cargo.env("RUSTC_SAVE_ANALYSIS", "api".to_string());
493 // When being built Cargo will at some point call `nmake.exe` on Windows
494 // MSVC. Unfortunately `nmake` will read these two environment variables
495 // below and try to intepret them. We're likely being run, however, from
496 // MSYS `make` which uses the same variables.
498 // As a result, to prevent confusion and errors, we remove these
499 // variables from our environment to prevent passing MSYS make flags to
500 // nmake, causing it to blow up.
501 if cfg!(target_env = "msvc") {
502 cargo.env_remove("MAKE");
503 cargo.env_remove("MAKEFLAGS");
506 // Environment variables *required* throughout the build
508 // FIXME: should update code to not require this env var
509 cargo.env("CFG_COMPILER_HOST_TRIPLE", target);
511 if self.is_verbose() {
514 // FIXME: cargo bench does not accept `--release`
515 if self.config.rust_optimize && cmd != "bench" {
516 cargo.arg("--release");
518 if self.config.locked_deps {
519 cargo.arg("--locked");
521 if self.config.vendor || self.is_sudo {
522 cargo.arg("--frozen");
525 self.ci_env.force_coloring_in_ci(&mut cargo);
530 /// Get a path to the compiler specified.
531 fn compiler_path(&self, compiler: &Compiler) -> PathBuf {
532 if compiler.is_snapshot(self) {
533 self.initial_rustc.clone()
535 self.sysroot(compiler).join("bin").join(exe("rustc", compiler.host))
539 /// Get the specified tool built by the specified compiler
540 fn tool(&self, compiler: &Compiler, tool: &str) -> PathBuf {
541 self.cargo_out(compiler, Mode::Tool, compiler.host)
542 .join(exe(tool, compiler.host))
545 /// Get the `rustdoc` executable next to the specified compiler
546 fn rustdoc(&self, compiler: &Compiler) -> PathBuf {
547 let mut rustdoc = self.compiler_path(compiler);
549 rustdoc.push(exe("rustdoc", compiler.host));
553 /// Get a `Command` which is ready to run `tool` in `stage` built for
555 fn tool_cmd(&self, compiler: &Compiler, tool: &str) -> Command {
556 let mut cmd = Command::new(self.tool(&compiler, tool));
557 self.prepare_tool_cmd(compiler, &mut cmd);
561 /// Prepares the `cmd` provided to be able to run the `compiler` provided.
563 /// Notably this munges the dynamic library lookup path to point to the
564 /// right location to run `compiler`.
565 fn prepare_tool_cmd(&self, compiler: &Compiler, cmd: &mut Command) {
566 let host = compiler.host;
567 let mut paths = vec![
568 self.sysroot_libdir(compiler, compiler.host),
569 self.cargo_out(compiler, Mode::Tool, host).join("deps"),
572 // On MSVC a tool may invoke a C compiler (e.g. compiletest in run-make
573 // mode) and that C compiler may need some extra PATH modification. Do
575 if compiler.host.contains("msvc") {
576 let curpaths = env::var_os("PATH").unwrap_or(OsString::new());
577 let curpaths = env::split_paths(&curpaths).collect::<Vec<_>>();
578 for &(ref k, ref v) in self.cc[compiler.host].0.env() {
582 for path in env::split_paths(v) {
583 if !curpaths.contains(&path) {
589 add_lib_path(paths, cmd);
592 /// Get the space-separated set of activated features for the standard
594 fn std_features(&self) -> String {
595 let mut features = "panic-unwind".to_string();
597 if self.config.debug_jemalloc {
598 features.push_str(" debug-jemalloc");
600 if self.config.use_jemalloc {
601 features.push_str(" jemalloc");
603 if self.config.backtrace {
604 features.push_str(" backtrace");
606 if self.config.profiler {
607 features.push_str(" profiler");
612 /// Get the space-separated set of activated features for the compiler.
613 fn rustc_features(&self) -> String {
614 let mut features = String::new();
615 if self.config.use_jemalloc {
616 features.push_str(" jemalloc");
621 /// Component directory that Cargo will produce output into (e.g.
623 fn cargo_dir(&self) -> &'static str {
624 if self.config.rust_optimize {"release"} else {"debug"}
627 /// Returns the sysroot for the `compiler` specified that *this build system
630 /// That is, the sysroot for the stage0 compiler is not what the compiler
631 /// thinks it is by default, but it's the same as the default for stages
633 fn sysroot(&self, compiler: &Compiler) -> PathBuf {
634 if compiler.stage == 0 {
635 self.out.join(compiler.host).join("stage0-sysroot")
637 self.out.join(compiler.host).join(format!("stage{}", compiler.stage))
641 /// Get the directory for incremental by-products when using the
643 fn incremental_dir(&self, compiler: &Compiler) -> PathBuf {
644 self.out.join(compiler.host).join(format!("stage{}-incremental", compiler.stage))
647 /// Returns the libdir where the standard library and other artifacts are
648 /// found for a compiler's sysroot.
649 fn sysroot_libdir(&self, compiler: &Compiler, target: &str) -> PathBuf {
650 if compiler.stage >= 2 {
651 if let Some(ref libdir_relative) = self.config.libdir_relative {
652 return self.sysroot(compiler).join(libdir_relative)
653 .join("rustlib").join(target).join("lib")
656 self.sysroot(compiler).join("lib").join("rustlib")
657 .join(target).join("lib")
660 /// Returns the root directory for all output generated in a particular
661 /// stage when running with a particular host compiler.
663 /// The mode indicates what the root directory is for.
664 fn stage_out(&self, compiler: &Compiler, mode: Mode) -> PathBuf {
665 let suffix = match mode {
666 Mode::Libstd => "-std",
667 Mode::Libtest => "-test",
668 Mode::Tool => "-tools",
669 Mode::Librustc => "-rustc",
671 self.out.join(compiler.host)
672 .join(format!("stage{}{}", compiler.stage, suffix))
675 /// Returns the root output directory for all Cargo output in a given stage,
676 /// running a particular compiler, wehther or not we're building the
677 /// standard library, and targeting the specified architecture.
681 target: &str) -> PathBuf {
682 self.stage_out(compiler, mode).join(target).join(self.cargo_dir())
685 /// Root output directory for LLVM compiled for `target`
687 /// Note that if LLVM is configured externally then the directory returned
688 /// will likely be empty.
689 fn llvm_out(&self, target: &str) -> PathBuf {
690 self.out.join(target).join("llvm")
693 /// Output directory for all documentation for a target
694 fn doc_out(&self, target: &str) -> PathBuf {
695 self.out.join(target).join("doc")
698 /// Output directory for some generated md crate documentation for a target (temporary)
699 fn md_doc_out(&self, target: &str) -> PathBuf {
700 self.out.join(target).join("md-doc")
703 /// Output directory for all crate documentation for a target (temporary)
705 /// The artifacts here are then copied into `doc_out` above.
706 fn crate_doc_out(&self, target: &str) -> PathBuf {
707 self.out.join(target).join("crate-docs")
710 /// Returns true if no custom `llvm-config` is set for the specified target.
712 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
713 fn is_rust_llvm(&self, target: &str) -> bool {
714 match self.config.target_config.get(target) {
715 Some(ref c) => c.llvm_config.is_none(),
720 /// Returns the path to `llvm-config` for the specified target.
722 /// If a custom `llvm-config` was specified for target then that's returned
724 fn llvm_config(&self, target: &str) -> PathBuf {
725 let target_config = self.config.target_config.get(target);
726 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
729 self.llvm_out(&self.config.build).join("bin")
730 .join(exe("llvm-config", target))
734 /// Returns the path to `FileCheck` binary for the specified target
735 fn llvm_filecheck(&self, target: &str) -> PathBuf {
736 let target_config = self.config.target_config.get(target);
737 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
738 let llvm_bindir = output(Command::new(s).arg("--bindir"));
739 Path::new(llvm_bindir.trim()).join(exe("FileCheck", target))
741 let base = self.llvm_out(&self.config.build).join("build");
742 let exe = exe("FileCheck", target);
743 if !self.config.ninja && self.config.build.contains("msvc") {
744 base.join("Release/bin").join(exe)
746 base.join("bin").join(exe)
751 /// Directory for libraries built from C/C++ code and shared between stages.
752 fn native_dir(&self, target: &str) -> PathBuf {
753 self.out.join(target).join("native")
756 /// Root output directory for rust_test_helpers library compiled for
758 fn test_helpers_out(&self, target: &str) -> PathBuf {
759 self.native_dir(target).join("rust-test-helpers")
762 /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
763 /// library lookup path.
764 fn add_rustc_lib_path(&self, compiler: &Compiler, cmd: &mut Command) {
765 // Windows doesn't need dylib path munging because the dlls for the
766 // compiler live next to the compiler and the system will find them
772 add_lib_path(vec![self.rustc_libdir(compiler)], cmd);
775 /// Adds the `RUST_TEST_THREADS` env var if necessary
776 fn add_rust_test_threads(&self, cmd: &mut Command) {
777 if env::var_os("RUST_TEST_THREADS").is_none() {
778 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
782 /// Returns the compiler's libdir where it stores the dynamic libraries that
783 /// it itself links against.
785 /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
787 fn rustc_libdir(&self, compiler: &Compiler) -> PathBuf {
788 if compiler.is_snapshot(self) {
789 self.rustc_snapshot_libdir()
791 self.sysroot(compiler).join(libdir(compiler.host))
795 /// Returns the libdir of the snapshot compiler.
796 fn rustc_snapshot_libdir(&self) -> PathBuf {
797 self.initial_rustc.parent().unwrap().parent().unwrap()
798 .join(libdir(&self.config.build))
801 /// Runs a command, printing out nice contextual information if it fails.
802 fn run(&self, cmd: &mut Command) {
803 self.verbose(&format!("running: {:?}", cmd));
807 /// Runs a command, printing out nice contextual information if it fails.
808 fn run_quiet(&self, cmd: &mut Command) {
809 self.verbose(&format!("running: {:?}", cmd));
813 /// Runs a command, printing out nice contextual information if it fails.
814 /// Exits if the command failed to execute at all, otherwise returns its
815 /// `status.success()`.
816 fn try_run(&self, cmd: &mut Command) -> bool {
817 self.verbose(&format!("running: {:?}", cmd));
821 /// Runs a command, printing out nice contextual information if it fails.
822 /// Exits if the command failed to execute at all, otherwise returns its
823 /// `status.success()`.
824 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
825 self.verbose(&format!("running: {:?}", cmd));
826 try_run_suppressed(cmd)
829 pub fn is_verbose(&self) -> bool {
833 pub fn is_very_verbose(&self) -> bool {
837 /// Prints a message if this build is configured in verbose mode.
838 fn verbose(&self, msg: &str) {
839 if self.is_verbose() {
844 /// Returns the number of parallel jobs that have been configured for this
846 fn jobs(&self) -> u32 {
847 self.flags.jobs.unwrap_or_else(|| num_cpus::get() as u32)
850 /// Returns the path to the C compiler for the target specified.
851 fn cc(&self, target: &str) -> &Path {
852 self.cc[target].0.path()
855 /// Returns a list of flags to pass to the C compiler for the target
857 fn cflags(&self, target: &str) -> Vec<String> {
858 // Filter out -O and /O (the optimization flags) that we picked up from
859 // gcc-rs because the build scripts will determine that for themselves.
860 let mut base = self.cc[target].0.args().iter()
861 .map(|s| s.to_string_lossy().into_owned())
862 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
863 .collect::<Vec<_>>();
865 // If we're compiling on macOS then we add a few unconditional flags
866 // indicating that we want libc++ (more filled out than libstdc++) and
867 // we want to compile for 10.7. This way we can ensure that
868 // LLVM/jemalloc/etc are all properly compiled.
869 if target.contains("apple-darwin") {
870 base.push("-stdlib=libc++".into());
873 // Work around an apparently bad MinGW / GCC optimization,
874 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
875 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
876 if target == "i686-pc-windows-gnu" {
877 base.push("-fno-omit-frame-pointer".into());
882 /// Returns the path to the `ar` archive utility for the target specified.
883 fn ar(&self, target: &str) -> Option<&Path> {
884 self.cc[target].1.as_ref().map(|p| &**p)
887 /// Returns the path to the C++ compiler for the target specified.
888 fn cxx(&self, target: &str) -> Result<&Path, String> {
889 match self.cxx.get(target) {
890 Some(p) => Ok(p.path()),
892 "target `{}` is not configured as a host, only as a target",
897 /// Returns flags to pass to the compiler to generate code for `target`.
898 fn rustc_flags(&self, target: &str) -> Vec<String> {
899 // New flags should be added here with great caution!
901 // It's quite unfortunate to **require** flags to generate code for a
902 // target, so it should only be passed here if absolutely necessary!
903 // Most default configuration should be done through target specs rather
904 // than an entry here.
906 let mut base = Vec::new();
907 if target != self.config.build && !target.contains("msvc") &&
908 !target.contains("emscripten") {
909 base.push(format!("-Clinker={}", self.cc(target).display()));
914 /// Returns the "musl root" for this `target`, if defined
915 fn musl_root(&self, target: &str) -> Option<&Path> {
916 self.config.target_config.get(target)
917 .and_then(|t| t.musl_root.as_ref())
918 .or(self.config.musl_root.as_ref())
922 /// Returns whether the target will be tested using the `remote-test-client`
923 /// and `remote-test-server` binaries.
924 fn remote_tested(&self, target: &str) -> bool {
925 self.qemu_rootfs(target).is_some() || target.contains("android") ||
926 env::var_os("TEST_DEVICE_ADDR").is_some()
929 /// Returns the root of the "rootfs" image that this target will be using,
930 /// if one was configured.
932 /// If `Some` is returned then that means that tests for this target are
933 /// emulated with QEMU and binaries will need to be shipped to the emulator.
934 fn qemu_rootfs(&self, target: &str) -> Option<&Path> {
935 self.config.target_config.get(target)
936 .and_then(|t| t.qemu_rootfs.as_ref())
940 /// Path to the python interpreter to use
941 fn python(&self) -> &Path {
942 self.config.python.as_ref().unwrap()
945 /// Tests whether the `compiler` compiling for `target` should be forced to
946 /// use a stage1 compiler instead.
948 /// Currently, by default, the build system does not perform a "full
949 /// bootstrap" by default where we compile the compiler three times.
950 /// Instead, we compile the compiler two times. The final stage (stage2)
951 /// just copies the libraries from the previous stage, which is what this
954 /// Here we return `true` if:
956 /// * The build isn't performing a full bootstrap
957 /// * The `compiler` is in the final stage, 2
958 /// * We're not cross-compiling, so the artifacts are already available in
961 /// When all of these conditions are met the build will lift artifacts from
962 /// the previous stage forward.
963 fn force_use_stage1(&self, compiler: &Compiler, target: &str) -> bool {
964 !self.config.full_bootstrap &&
965 compiler.stage >= 2 &&
966 self.config.host.iter().any(|h| h == target)
969 /// Returns the directory that OpenSSL artifacts are compiled into if
970 /// configured to do so.
971 fn openssl_dir(&self, target: &str) -> Option<PathBuf> {
972 // OpenSSL not used on Windows
973 if target.contains("windows") {
975 } else if self.config.openssl_static {
976 Some(self.out.join(target).join("openssl"))
982 /// Returns the directory that OpenSSL artifacts are installed into if
983 /// configured as such.
984 fn openssl_install_dir(&self, target: &str) -> Option<PathBuf> {
985 self.openssl_dir(target).map(|p| p.join("install"))
988 /// Given `num` in the form "a.b.c" return a "release string" which
989 /// describes the release version number.
991 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
992 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
993 fn release(&self, num: &str) -> String {
994 match &self.config.channel[..] {
995 "stable" => num.to_string(),
996 "beta" => format!("{}-beta{}", num, channel::CFG_PRERELEASE_VERSION),
997 "nightly" => format!("{}-nightly", num),
998 _ => format!("{}-dev", num),
1002 /// Returns the value of `release` above for Rust itself.
1003 fn rust_release(&self) -> String {
1004 self.release(channel::CFG_RELEASE_NUM)
1007 /// Returns the "package version" for a component given the `num` release
1010 /// The package version is typically what shows up in the names of tarballs.
1011 /// For channels like beta/nightly it's just the channel name, otherwise
1012 /// it's the `num` provided.
1013 fn package_vers(&self, num: &str) -> String {
1014 match &self.config.channel[..] {
1015 "stable" => num.to_string(),
1016 "beta" => "beta".to_string(),
1017 "nightly" => "nightly".to_string(),
1018 _ => format!("{}-dev", num),
1022 /// Returns the value of `package_vers` above for Rust itself.
1023 fn rust_package_vers(&self) -> String {
1024 self.package_vers(channel::CFG_RELEASE_NUM)
1027 /// Returns the value of `package_vers` above for Cargo
1028 fn cargo_package_vers(&self) -> String {
1029 self.package_vers(&self.release_num("cargo"))
1032 /// Returns the value of `package_vers` above for rls
1033 fn rls_package_vers(&self) -> String {
1034 self.package_vers(&self.release_num("rls"))
1037 /// Returns the `version` string associated with this compiler for Rust
1040 /// Note that this is a descriptive string which includes the commit date,
1041 /// sha, version, etc.
1042 fn rust_version(&self) -> String {
1043 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1046 /// Returns the `a.b.c` version that the given package is at.
1047 fn release_num(&self, package: &str) -> String {
1048 let mut toml = String::new();
1049 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
1050 t!(t!(File::open(toml_file_name)).read_to_string(&mut toml));
1051 for line in toml.lines() {
1052 let prefix = "version = \"";
1054 if line.starts_with(prefix) && line.ends_with(suffix) {
1055 return line[prefix.len()..line.len() - suffix.len()].to_string()
1059 panic!("failed to find version in {}'s Cargo.toml", package)
1062 /// Returns whether unstable features should be enabled for the compiler
1064 fn unstable_features(&self) -> bool {
1065 match &self.config.channel[..] {
1066 "stable" | "beta" => false,
1067 "nightly" | _ => true,
1071 /// Fold the output of the commands after this method into a group. The fold
1072 /// ends when the returned object is dropped. Folding can only be used in
1073 /// the Travis CI environment.
1074 pub fn fold_output<D, F>(&self, name: F) -> Option<OutputFolder>
1075 where D: Into<String>, F: FnOnce() -> D
1077 if self.ci_env == CiEnv::Travis {
1078 Some(OutputFolder::new(name().into()))
1084 /// Get a list of crates from a root crate.
1086 /// Returns Vec<(crate, path to crate, is_root_crate)>
1087 fn crates(&self, root: &str) -> Vec<(&str, &Path)> {
1088 let mut ret = Vec::new();
1089 let mut list = vec![root];
1090 let mut visited = HashSet::new();
1091 while let Some(krate) = list.pop() {
1092 let krate = &self.crates[krate];
1093 // If we can't strip prefix, then out-of-tree path
1094 let path = krate.path.strip_prefix(&self.src).unwrap_or(&krate.path);
1095 ret.push((&*krate.name, path));
1096 for dep in &krate.deps {
1097 if visited.insert(dep) && dep != "build_helper" {
1106 impl<'a> Compiler<'a> {
1107 pub fn with_stage(mut self, stage: u32) -> Compiler<'a> {
1112 /// Returns whether this is a snapshot compiler for `build`'s configuration
1113 pub fn is_snapshot(&self, builder: &Build) -> bool {
1114 self.stage == 0 && self.host == build.build
1117 /// Returns if this compiler should be treated as a final stage one in the
1118 /// current build session.
1119 /// This takes into account whether we're performing a full bootstrap or
1120 /// not; don't directly compare the stage with `2`!
1121 pub fn is_final_stage(&self, build: &Build) -> bool {
1122 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1123 self.stage >= final_stage