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.
68 #![feature(associated_consts)]
69 #![feature(core_intrinsics)]
72 extern crate build_helper;
74 extern crate serde_derive;
76 extern crate serde_json;
78 extern crate filetime;
81 extern crate num_cpus;
82 extern crate rustc_serialize;
90 use std::collections::{HashSet, HashMap};
92 use std::fs::{self, File};
94 use std::path::{PathBuf, Path};
95 use std::process::Command;
97 use build_helper::{run_silent, run_suppressed, try_run_silent, try_run_suppressed, output, mtime};
99 use util::{exe, libdir, add_lib_path, OutputFolder, CiEnv};
126 pub unsafe fn setup(build: &mut ::Build) {
127 if build.config.low_priority {
128 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
133 #[cfg(not(any(unix, windows)))]
135 pub unsafe fn setup(_build: &mut ::Build) {
139 pub use config::Config;
140 pub use flags::{Flags, Subcommand};
142 /// A structure representing a Rust compiler.
144 /// Each compiler has a `stage` that it is associated with and a `host` that
145 /// corresponds to the platform the compiler runs on. This structure is used as
146 /// a parameter to many methods below.
147 #[derive(Serialize, Deserialize, Eq, PartialEq, Clone, Copy, Hash, Debug)]
148 pub struct Compiler<'a> {
153 /// Global configuration for the build system.
155 /// This structure transitively contains all configuration for the build system.
156 /// All filesystem-encoded configuration is in `config`, all flags are in
157 /// `flags`, and then parsed or probed information is listed in the keys below.
159 /// This structure is a parameter of almost all methods in the build system,
160 /// although most functions are implemented as free functions rather than
161 /// methods specifically on this structure itself (to make it easier to
164 // User-specified configuration via config.toml
167 // User-specified configuration via CLI flags
170 // Derived properties from the above two configurations
173 rust_info: channel::GitInfo,
174 cargo_info: channel::GitInfo,
175 rls_info: channel::GitInfo,
180 // Targets for which to build.
183 targets: Vec<String>,
185 // Stage 0 (downloaded) compiler and cargo or their local rust equivalents.
186 initial_rustc: PathBuf,
187 initial_cargo: PathBuf,
189 // Probed tools at runtime
190 lldb_version: Option<String>,
191 lldb_python_dir: Option<String>,
193 // Runtime state filled in later on
194 // target -> (cc, ar)
195 cc: HashMap<String, (gcc::Tool, Option<PathBuf>)>,
197 cxx: HashMap<String, gcc::Tool>,
198 crates: HashMap<String, Crate>,
201 delayed_failures: Cell<usize>,
216 /// The various "modes" of invoking Cargo.
218 /// These entries currently correspond to the various output directories of the
219 /// build system, with each mod generating output in a different directory.
220 #[derive(Serialize, Clone, Copy, PartialEq, Eq)]
222 /// Build the standard library, placing output in the "stageN-std" directory.
225 /// Build libtest, placing output in the "stageN-test" directory.
228 /// Build librustc and compiler libraries, placing output in the "stageN-rustc" directory.
231 /// Build some tool, placing output in the "stageN-tools" directory.
236 /// Creates a new set of build configuration from the `flags` on the command
237 /// line and the filesystem `config`.
239 /// By default all build output will be placed in the current directory.
240 pub fn new(flags: Flags, config: Config) -> Build {
241 let cwd = t!(env::current_dir());
242 let src = flags.src.clone();
243 let out = cwd.join("build");
245 let is_sudo = match env::var_os("SUDO_USER") {
247 match env::var_os("USER") {
248 Some(user) => user != sudo_user,
254 let rust_info = channel::GitInfo::new(&src);
255 let cargo_info = channel::GitInfo::new(&src.join("src/tools/cargo"));
256 let rls_info = channel::GitInfo::new(&src.join("src/tools/rls"));
258 let hosts = if !flags.host.is_empty() {
259 for host in flags.host.iter() {
260 if !config.host.contains(host) {
261 panic!("specified host `{}` is not in configuration", host);
268 let targets = if !flags.target.is_empty() {
269 for target in flags.target.iter() {
270 if !config.target.contains(target) {
271 panic!("specified target `{}` is not in configuration", target);
276 config.target.clone()
280 initial_rustc: config.initial_rustc.clone(),
281 initial_cargo: config.initial_cargo.clone(),
282 local_rebuild: config.local_rebuild,
283 fail_fast: flags.cmd.fail_fast(),
284 verbosity: cmp::max(flags.verbose, config.verbose),
286 build: config.host[0].clone(),
295 rust_info: rust_info,
296 cargo_info: cargo_info,
300 crates: HashMap::new(),
302 lldb_python_dir: None,
304 ci_env: CiEnv::current(),
305 delayed_failures: Cell::new(0),
309 /// Executes the entire build, as configured by the flags and configuration.
310 pub fn build(&mut self) {
315 if let Subcommand::Clean = self.flags.cmd {
316 return clean::clean(self);
319 self.verbose("finding compilers");
321 self.verbose("running sanity check");
323 // If local-rust is the same major.minor as the current version, then force a local-rebuild
324 let local_version_verbose = output(
325 Command::new(&self.initial_rustc).arg("--version").arg("--verbose"));
326 let local_release = local_version_verbose
327 .lines().filter(|x| x.starts_with("release:"))
328 .next().unwrap().trim_left_matches("release:").trim();
329 let my_version = channel::CFG_RELEASE_NUM;
330 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
331 self.verbose(&format!("auto-detected local-rebuild {}", local_release));
332 self.local_rebuild = true;
334 self.verbose("learning about cargo");
335 metadata::build(self);
337 builder::Builder::run(&self);
340 /// Clear out `dir` if `input` is newer.
342 /// After this executes, it will also ensure that `dir` exists.
343 fn clear_if_dirty(&self, dir: &Path, input: &Path) {
344 let stamp = dir.join(".stamp");
345 if mtime(&stamp) < mtime(input) {
346 self.verbose(&format!("Dirty - {}", dir.display()));
347 let _ = fs::remove_dir_all(dir);
348 } else if stamp.exists() {
351 t!(fs::create_dir_all(dir));
352 t!(File::create(stamp));
355 /// Prepares an invocation of `cargo` to be run.
357 /// This will create a `Command` that represents a pending execution of
358 /// Cargo. This cargo will be configured to use `compiler` as the actual
359 /// rustc compiler, its output will be scoped by `mode`'s output directory,
360 /// it will pass the `--target` flag for the specified `target`, and will be
361 /// executing the Cargo command `cmd`.
366 cmd: &str) -> Command {
367 let mut cargo = Command::new(&self.initial_cargo);
368 let out_dir = self.stage_out(compiler, mode);
369 cargo.env("CARGO_TARGET_DIR", out_dir)
371 .arg("-j").arg(self.jobs().to_string())
372 .arg("--target").arg(target);
374 // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
375 // Force cargo to output binaries with disambiguating hashes in the name
376 cargo.env("__CARGO_DEFAULT_LIB_METADATA", &self.config.channel);
379 if compiler.stage == 0 && self.local_rebuild {
380 // Assume the local-rebuild rustc already has stage1 features.
383 stage = compiler.stage;
386 // Customize the compiler we're running. Specify the compiler to cargo
387 // as our shim and then pass it some various options used to configure
388 // how the actual compiler itself is called.
390 // These variables are primarily all read by
391 // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
392 cargo.env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
393 .env("RUSTC", self.out.join("bootstrap/debug/rustc"))
394 .env("RUSTC_REAL", self.compiler_path(compiler))
395 .env("RUSTC_STAGE", stage.to_string())
396 .env("RUSTC_CODEGEN_UNITS",
397 self.config.rust_codegen_units.to_string())
398 .env("RUSTC_DEBUG_ASSERTIONS",
399 self.config.rust_debug_assertions.to_string())
400 .env("RUSTC_SYSROOT", self.sysroot(compiler))
401 .env("RUSTC_LIBDIR", self.rustc_libdir(compiler))
402 .env("RUSTC_RPATH", self.config.rust_rpath.to_string())
403 .env("RUSTDOC", self.out.join("bootstrap/debug/rustdoc"))
404 .env("RUSTDOC_REAL", self.rustdoc(compiler))
405 .env("RUSTC_FLAGS", self.rustc_flags(target).join(" "));
407 if mode != Mode::Tool {
408 // Tools don't get debuginfo right now, e.g. cargo and rls don't
409 // get compiled with debuginfo.
410 cargo.env("RUSTC_DEBUGINFO", self.config.rust_debuginfo.to_string())
411 .env("RUSTC_DEBUGINFO_LINES", self.config.rust_debuginfo_lines.to_string())
412 .env("RUSTC_FORCE_UNSTABLE", "1");
414 // Currently the compiler depends on crates from crates.io, and
415 // then other crates can depend on the compiler (e.g. proc-macro
416 // crates). Let's say, for example that rustc itself depends on the
417 // bitflags crate. If an external crate then depends on the
418 // bitflags crate as well, we need to make sure they don't
419 // conflict, even if they pick the same verison of bitflags. We'll
420 // want to make sure that e.g. a plugin and rustc each get their
421 // own copy of bitflags.
423 // Cargo ensures that this works in general through the -C metadata
424 // flag. This flag will frob the symbols in the binary to make sure
425 // they're different, even though the source code is the exact
426 // same. To solve this problem for the compiler we extend Cargo's
427 // already-passed -C metadata flag with our own. Our rustc.rs
428 // wrapper around the actual rustc will detect -C metadata being
429 // passed and frob it with this extra string we're passing in.
430 cargo.env("RUSTC_METADATA_SUFFIX", "rustc");
433 // Enable usage of unstable features
434 cargo.env("RUSTC_BOOTSTRAP", "1");
435 self.add_rust_test_threads(&mut cargo);
437 // Almost all of the crates that we compile as part of the bootstrap may
438 // have a build script, including the standard library. To compile a
439 // build script, however, it itself needs a standard library! This
440 // introduces a bit of a pickle when we're compiling the standard
443 // To work around this we actually end up using the snapshot compiler
444 // (stage0) for compiling build scripts of the standard library itself.
445 // The stage0 compiler is guaranteed to have a libstd available for use.
447 // For other crates, however, we know that we've already got a standard
448 // library up and running, so we can use the normal compiler to compile
449 // build scripts in that situation.
450 if mode == Mode::Libstd {
451 cargo.env("RUSTC_SNAPSHOT", &self.initial_rustc)
452 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
454 cargo.env("RUSTC_SNAPSHOT", self.compiler_path(compiler))
455 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
458 // Ignore incremental modes except for stage0, since we're
459 // not guaranteeing correctness across builds if the compiler
460 // is changing under your feet.`
461 if self.flags.incremental && compiler.stage == 0 {
462 let incr_dir = self.incremental_dir(compiler);
463 cargo.env("RUSTC_INCREMENTAL", incr_dir);
466 if let Some(ref on_fail) = self.flags.on_fail {
467 cargo.env("RUSTC_ON_FAIL", on_fail);
470 cargo.env("RUSTC_VERBOSE", format!("{}", self.verbosity));
472 // Specify some various options for build scripts used throughout
475 // FIXME: the guard against msvc shouldn't need to be here
476 if !target.contains("msvc") {
477 cargo.env(format!("CC_{}", target), self.cc(target))
478 .env(format!("AR_{}", target), self.ar(target).unwrap()) // only msvc is None
479 .env(format!("CFLAGS_{}", target), self.cflags(target).join(" "));
481 if let Ok(cxx) = self.cxx(target) {
482 cargo.env(format!("CXX_{}", target), cxx);
486 if mode == Mode::Libstd &&
487 self.config.extended &&
488 compiler.is_final_stage(self) {
489 cargo.env("RUSTC_SAVE_ANALYSIS", "api".to_string());
492 // When being built Cargo will at some point call `nmake.exe` on Windows
493 // MSVC. Unfortunately `nmake` will read these two environment variables
494 // below and try to intepret them. We're likely being run, however, from
495 // MSYS `make` which uses the same variables.
497 // As a result, to prevent confusion and errors, we remove these
498 // variables from our environment to prevent passing MSYS make flags to
499 // nmake, causing it to blow up.
500 if cfg!(target_env = "msvc") {
501 cargo.env_remove("MAKE");
502 cargo.env_remove("MAKEFLAGS");
505 // Environment variables *required* throughout the build
507 // FIXME: should update code to not require this env var
508 cargo.env("CFG_COMPILER_HOST_TRIPLE", target);
510 if self.is_verbose() {
513 // FIXME: cargo bench does not accept `--release`
514 if self.config.rust_optimize && cmd != "bench" {
515 cargo.arg("--release");
517 if self.config.locked_deps {
518 cargo.arg("--locked");
520 if self.config.vendor || self.is_sudo {
521 cargo.arg("--frozen");
524 self.ci_env.force_coloring_in_ci(&mut cargo);
529 /// Get a path to the compiler specified.
530 fn compiler_path(&self, compiler: Compiler) -> PathBuf {
531 if compiler.is_snapshot(self) {
532 self.initial_rustc.clone()
534 self.sysroot(compiler).join("bin").join(exe("rustc", compiler.host))
538 /// Get the specified tool built by the specified compiler
539 fn tool(&self, compiler: Compiler, tool: &str) -> PathBuf {
540 self.cargo_out(compiler, Mode::Tool, compiler.host)
541 .join(exe(tool, compiler.host))
544 /// Get the `rustdoc` executable next to the specified compiler
545 fn rustdoc(&self, compiler: Compiler) -> PathBuf {
546 let mut rustdoc = self.compiler_path(compiler);
548 rustdoc.push(exe("rustdoc", compiler.host));
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 /// Get the directory for incremental by-products when using the
589 fn incremental_dir(&self, compiler: Compiler) -> PathBuf {
590 self.out.join(compiler.host).join(format!("stage{}-incremental", compiler.stage))
593 /// Returns the libdir where the standard library and other artifacts are
594 /// found for a compiler's sysroot.
595 fn sysroot_libdir(&self, compiler: &Compiler, target: &str) -> PathBuf {
596 if compiler.stage >= 2 {
597 if let Some(ref libdir_relative) = self.config.libdir_relative {
598 return self.sysroot(compiler).join(libdir_relative)
599 .join("rustlib").join(target).join("lib")
602 self.sysroot(compiler).join("lib").join("rustlib")
603 .join(target).join("lib")
606 /// Returns the root directory for all output generated in a particular
607 /// stage when running with a particular host compiler.
609 /// The mode indicates what the root directory is for.
610 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
611 let suffix = match mode {
612 Mode::Libstd => "-std",
613 Mode::Libtest => "-test",
614 Mode::Tool => "-tools",
615 Mode::Librustc => "-rustc",
617 self.out.join(compiler.host)
618 .join(format!("stage{}{}", compiler.stage, suffix))
621 /// Returns the root output directory for all Cargo output in a given stage,
622 /// running a particular compiler, wehther or not we're building the
623 /// standard library, and targeting the specified architecture.
627 target: &str) -> PathBuf {
628 self.stage_out(compiler, mode).join(target).join(self.cargo_dir())
631 /// Root output directory for LLVM compiled for `target`
633 /// Note that if LLVM is configured externally then the directory returned
634 /// will likely be empty.
635 fn llvm_out(&self, target: &str) -> PathBuf {
636 self.out.join(target).join("llvm")
639 /// Output directory for all documentation for a target
640 fn doc_out(&self, target: &str) -> PathBuf {
641 self.out.join(target).join("doc")
644 /// Output directory for some generated md crate documentation for a target (temporary)
645 fn md_doc_out(&self, target: &str) -> PathBuf {
646 self.out.join(target).join("md-doc")
649 /// Output directory for all crate documentation for a target (temporary)
651 /// The artifacts here are then copied into `doc_out` above.
652 fn crate_doc_out(&self, target: &str) -> PathBuf {
653 self.out.join(target).join("crate-docs")
656 /// Returns true if no custom `llvm-config` is set for the specified target.
658 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
659 fn is_rust_llvm(&self, target: &str) -> bool {
660 match self.config.target_config.get(target) {
661 Some(ref c) => c.llvm_config.is_none(),
666 /// Returns the path to `llvm-config` for the specified target.
668 /// If a custom `llvm-config` was specified for target then that's returned
670 fn llvm_config(&self, target: &str) -> PathBuf {
671 let target_config = self.config.target_config.get(target);
672 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
675 self.llvm_out(&self.config.build).join("bin")
676 .join(exe("llvm-config", target))
680 /// Returns the path to `FileCheck` binary for the specified target
681 fn llvm_filecheck(&self, target: &str) -> PathBuf {
682 let target_config = self.config.target_config.get(target);
683 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
684 let llvm_bindir = output(Command::new(s).arg("--bindir"));
685 Path::new(llvm_bindir.trim()).join(exe("FileCheck", target))
687 let base = self.llvm_out(&self.config.build).join("build");
688 let exe = exe("FileCheck", target);
689 if !self.config.ninja && self.config.build.contains("msvc") {
690 base.join("Release/bin").join(exe)
692 base.join("bin").join(exe)
697 /// Directory for libraries built from C/C++ code and shared between stages.
698 fn native_dir(&self, target: &str) -> PathBuf {
699 self.out.join(target).join("native")
702 /// Root output directory for rust_test_helpers library compiled for
704 fn test_helpers_out(&self, target: &str) -> PathBuf {
705 self.native_dir(target).join("rust-test-helpers")
708 /// Adds the `RUST_TEST_THREADS` env var if necessary
709 fn add_rust_test_threads(&self, cmd: &mut Command) {
710 if env::var_os("RUST_TEST_THREADS").is_none() {
711 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
715 /// Returns the compiler's libdir where it stores the dynamic libraries that
716 /// it itself links against.
718 /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
720 fn rustc_libdir(&self, compiler: Compiler) -> PathBuf {
721 if compiler.is_snapshot(self) {
722 self.rustc_snapshot_libdir()
724 self.sysroot(compiler).join(libdir(compiler.host))
728 /// Returns the libdir of the snapshot compiler.
729 fn rustc_snapshot_libdir(&self) -> PathBuf {
730 self.initial_rustc.parent().unwrap().parent().unwrap()
731 .join(libdir(&self.config.build))
734 /// Runs a command, printing out nice contextual information if it fails.
735 fn run(&self, cmd: &mut Command) {
736 self.verbose(&format!("running: {:?}", cmd));
740 /// Runs a command, printing out nice contextual information if it fails.
741 fn run_quiet(&self, cmd: &mut Command) {
742 self.verbose(&format!("running: {:?}", cmd));
746 /// Runs a command, printing out nice contextual information if it fails.
747 /// Exits if the command failed to execute at all, otherwise returns its
748 /// `status.success()`.
749 fn try_run(&self, cmd: &mut Command) -> bool {
750 self.verbose(&format!("running: {:?}", cmd));
754 /// Runs a command, printing out nice contextual information if it fails.
755 /// Exits if the command failed to execute at all, otherwise returns its
756 /// `status.success()`.
757 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
758 self.verbose(&format!("running: {:?}", cmd));
759 try_run_suppressed(cmd)
762 pub fn is_verbose(&self) -> bool {
766 pub fn is_very_verbose(&self) -> bool {
770 /// Prints a message if this build is configured in verbose mode.
771 fn verbose(&self, msg: &str) {
772 if self.is_verbose() {
777 /// Returns the number of parallel jobs that have been configured for this
779 fn jobs(&self) -> u32 {
780 self.flags.jobs.unwrap_or_else(|| num_cpus::get() as u32)
783 /// Returns the path to the C compiler for the target specified.
784 fn cc(&self, target: &str) -> &Path {
785 self.cc[target].0.path()
788 /// Returns a list of flags to pass to the C compiler for the target
790 fn cflags(&self, target: &str) -> Vec<String> {
791 // Filter out -O and /O (the optimization flags) that we picked up from
792 // gcc-rs because the build scripts will determine that for themselves.
793 let mut base = self.cc[target].0.args().iter()
794 .map(|s| s.to_string_lossy().into_owned())
795 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
796 .collect::<Vec<_>>();
798 // If we're compiling on macOS then we add a few unconditional flags
799 // indicating that we want libc++ (more filled out than libstdc++) and
800 // we want to compile for 10.7. This way we can ensure that
801 // LLVM/jemalloc/etc are all properly compiled.
802 if target.contains("apple-darwin") {
803 base.push("-stdlib=libc++".into());
806 // Work around an apparently bad MinGW / GCC optimization,
807 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
808 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
809 if target == "i686-pc-windows-gnu" {
810 base.push("-fno-omit-frame-pointer".into());
815 /// Returns the path to the `ar` archive utility for the target specified.
816 fn ar(&self, target: &str) -> Option<&Path> {
817 self.cc[target].1.as_ref().map(|p| &**p)
820 /// Returns the path to the C++ compiler for the target specified.
821 fn cxx(&self, target: &str) -> Result<&Path, String> {
822 match self.cxx.get(target) {
823 Some(p) => Ok(p.path()),
825 "target `{}` is not configured as a host, only as a target",
830 /// Returns flags to pass to the compiler to generate code for `target`.
831 fn rustc_flags(&self, target: &str) -> Vec<String> {
832 // New flags should be added here with great caution!
834 // It's quite unfortunate to **require** flags to generate code for a
835 // target, so it should only be passed here if absolutely necessary!
836 // Most default configuration should be done through target specs rather
837 // than an entry here.
839 let mut base = Vec::new();
840 if target != self.config.build && !target.contains("msvc") &&
841 !target.contains("emscripten") {
842 base.push(format!("-Clinker={}", self.cc(target).display()));
847 /// Returns the "musl root" for this `target`, if defined
848 fn musl_root(&self, target: &str) -> Option<&Path> {
849 self.config.target_config.get(target)
850 .and_then(|t| t.musl_root.as_ref())
851 .or(self.config.musl_root.as_ref())
855 /// Returns whether the target will be tested using the `remote-test-client`
856 /// and `remote-test-server` binaries.
857 fn remote_tested(&self, target: &str) -> bool {
858 self.qemu_rootfs(target).is_some() || target.contains("android") ||
859 env::var_os("TEST_DEVICE_ADDR").is_some()
862 /// Returns the root of the "rootfs" image that this target will be using,
863 /// if one was configured.
865 /// If `Some` is returned then that means that tests for this target are
866 /// emulated with QEMU and binaries will need to be shipped to the emulator.
867 fn qemu_rootfs(&self, target: &str) -> Option<&Path> {
868 self.config.target_config.get(target)
869 .and_then(|t| t.qemu_rootfs.as_ref())
873 /// Path to the python interpreter to use
874 fn python(&self) -> &Path {
875 self.config.python.as_ref().unwrap()
878 /// Tests whether the `compiler` compiling for `target` should be forced to
879 /// use a stage1 compiler instead.
881 /// Currently, by default, the build system does not perform a "full
882 /// bootstrap" by default where we compile the compiler three times.
883 /// Instead, we compile the compiler two times. The final stage (stage2)
884 /// just copies the libraries from the previous stage, which is what this
887 /// Here we return `true` if:
889 /// * The build isn't performing a full bootstrap
890 /// * The `compiler` is in the final stage, 2
891 /// * We're not cross-compiling, so the artifacts are already available in
894 /// When all of these conditions are met the build will lift artifacts from
895 /// the previous stage forward.
896 fn force_use_stage1(&self, compiler: Compiler, target: &str) -> bool {
897 !self.config.full_bootstrap &&
898 compiler.stage >= 2 &&
899 self.config.host.iter().any(|h| h == target)
902 /// Returns the directory that OpenSSL artifacts are compiled into if
903 /// configured to do so.
904 fn openssl_dir(&self, target: &str) -> Option<PathBuf> {
905 // OpenSSL not used on Windows
906 if target.contains("windows") {
908 } else if self.config.openssl_static {
909 Some(self.out.join(target).join("openssl"))
915 /// Returns the directory that OpenSSL artifacts are installed into if
916 /// configured as such.
917 fn openssl_install_dir(&self, target: &str) -> Option<PathBuf> {
918 self.openssl_dir(target).map(|p| p.join("install"))
921 /// Given `num` in the form "a.b.c" return a "release string" which
922 /// describes the release version number.
924 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
925 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
926 fn release(&self, num: &str) -> String {
927 match &self.config.channel[..] {
928 "stable" => num.to_string(),
929 "beta" => format!("{}-beta{}", num, channel::CFG_PRERELEASE_VERSION),
930 "nightly" => format!("{}-nightly", num),
931 _ => format!("{}-dev", num),
935 /// Returns the value of `release` above for Rust itself.
936 fn rust_release(&self) -> String {
937 self.release(channel::CFG_RELEASE_NUM)
940 /// Returns the "package version" for a component given the `num` release
943 /// The package version is typically what shows up in the names of tarballs.
944 /// For channels like beta/nightly it's just the channel name, otherwise
945 /// it's the `num` provided.
946 fn package_vers(&self, num: &str) -> String {
947 match &self.config.channel[..] {
948 "stable" => num.to_string(),
949 "beta" => "beta".to_string(),
950 "nightly" => "nightly".to_string(),
951 _ => format!("{}-dev", num),
955 /// Returns the value of `package_vers` above for Rust itself.
956 fn rust_package_vers(&self) -> String {
957 self.package_vers(channel::CFG_RELEASE_NUM)
960 /// Returns the value of `package_vers` above for Cargo
961 fn cargo_package_vers(&self) -> String {
962 self.package_vers(&self.release_num("cargo"))
965 /// Returns the value of `package_vers` above for rls
966 fn rls_package_vers(&self) -> String {
967 self.package_vers(&self.release_num("rls"))
970 /// Returns the `version` string associated with this compiler for Rust
973 /// Note that this is a descriptive string which includes the commit date,
974 /// sha, version, etc.
975 fn rust_version(&self) -> String {
976 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
979 /// Returns the `a.b.c` version that the given package is at.
980 fn release_num(&self, package: &str) -> String {
981 let mut toml = String::new();
982 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
983 t!(t!(File::open(toml_file_name)).read_to_string(&mut toml));
984 for line in toml.lines() {
985 let prefix = "version = \"";
987 if line.starts_with(prefix) && line.ends_with(suffix) {
988 return line[prefix.len()..line.len() - suffix.len()].to_string()
992 panic!("failed to find version in {}'s Cargo.toml", package)
995 /// Returns whether unstable features should be enabled for the compiler
997 fn unstable_features(&self) -> bool {
998 match &self.config.channel[..] {
999 "stable" | "beta" => false,
1000 "nightly" | _ => true,
1004 /// Fold the output of the commands after this method into a group. The fold
1005 /// ends when the returned object is dropped. Folding can only be used in
1006 /// the Travis CI environment.
1007 pub fn fold_output<D, F>(&self, name: F) -> Option<OutputFolder>
1008 where D: Into<String>, F: FnOnce() -> D
1010 if self.ci_env == CiEnv::Travis {
1011 Some(OutputFolder::new(name().into()))
1017 /// Get a list of crates from a root crate.
1019 /// Returns Vec<(crate, path to crate, is_root_crate)>
1020 fn crates(&self, root: &str) -> Vec<(&str, &Path)> {
1021 let mut ret = Vec::new();
1022 let mut list = vec![root];
1023 let mut visited = HashSet::new();
1024 while let Some(krate) = list.pop() {
1025 let krate = &self.crates[krate];
1026 // If we can't strip prefix, then out-of-tree path
1027 let path = krate.path.strip_prefix(&self.src).unwrap_or(&krate.path);
1028 ret.push((&*krate.name, path));
1029 for dep in &krate.deps {
1030 if visited.insert(dep) && dep != "build_helper" {
1039 impl<'a> Compiler<'a> {
1040 pub fn with_stage(mut self, stage: u32) -> Compiler<'a> {
1045 /// Returns whether this is a snapshot compiler for `build`'s configuration
1046 pub fn is_snapshot(&self, build: &Build) -> bool {
1047 self.stage == 0 && self.host == build.build
1050 /// Returns if this compiler should be treated as a final stage one in the
1051 /// current build session.
1052 /// This takes into account whether we're performing a full bootstrap or
1053 /// not; don't directly compare the stage with `2`!
1054 pub fn is_final_stage(&self, build: &Build) -> bool {
1055 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1056 self.stage >= final_stage