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;
80 use std::collections::HashMap;
82 use std::ffi::OsString;
83 use std::fs::{self, File};
85 use std::path::{Component, PathBuf, Path};
86 use std::process::Command;
88 use build_helper::{run_silent, run_suppressed, output, mtime};
90 use util::{exe, libdir, add_lib_path};
113 pub unsafe fn setup() {}
116 pub use config::Config;
117 pub use flags::{Flags, Subcommand};
119 /// A structure representing a Rust compiler.
121 /// Each compiler has a `stage` that it is associated with and a `host` that
122 /// corresponds to the platform the compiler runs on. This structure is used as
123 /// a parameter to many methods below.
124 #[derive(Eq, PartialEq, Clone, Copy, Hash, Debug)]
125 pub struct Compiler<'a> {
130 /// Global configuration for the build system.
132 /// This structure transitively contains all configuration for the build system.
133 /// All filesystem-encoded configuration is in `config`, all flags are in
134 /// `flags`, and then parsed or probed information is listed in the keys below.
136 /// This structure is a parameter of almost all methods in the build system,
137 /// although most functions are implemented as free functions rather than
138 /// methods specifically on this structure itself (to make it easier to
141 // User-specified configuration via config.toml
144 // User-specified configuration via CLI flags
147 // Derived properties from the above two configurations
152 rust_info: channel::GitInfo,
153 cargo_info: channel::GitInfo,
156 // Probed tools at runtime
157 lldb_version: Option<String>,
158 lldb_python_dir: Option<String>,
160 // Runtime state filled in later on
161 cc: HashMap<String, (gcc::Tool, Option<PathBuf>)>,
162 cxx: HashMap<String, gcc::Tool>,
163 crates: HashMap<String, Crate>,
180 /// The various "modes" of invoking Cargo.
182 /// These entries currently correspond to the various output directories of the
183 /// build system, with each mod generating output in a different directory.
184 #[derive(Clone, Copy, PartialEq, Eq)]
186 /// This cargo is going to build the standard library, placing output in the
187 /// "stageN-std" directory.
190 /// This cargo is going to build libtest, placing output in the
191 /// "stageN-test" directory.
194 /// This cargo is going to build librustc and compiler libraries, placing
195 /// output in the "stageN-rustc" directory.
198 /// This cargo is going to some build tool, placing output in the
199 /// "stageN-tools" directory.
204 /// Creates a new set of build configuration from the `flags` on the command
205 /// line and the filesystem `config`.
207 /// By default all build output will be placed in the current directory.
208 pub fn new(flags: Flags, config: Config) -> Build {
209 let cwd = t!(env::current_dir());
210 let src = flags.src.clone().or_else(|| {
211 env::var_os("SRC").map(|x| x.into())
212 }).unwrap_or(cwd.clone());
213 let out = cwd.join("build");
215 let stage0_root = out.join(&config.build).join("stage0/bin");
216 let rustc = match config.rustc {
217 Some(ref s) => PathBuf::from(s),
218 None => stage0_root.join(exe("rustc", &config.build)),
220 let cargo = match config.cargo {
221 Some(ref s) => PathBuf::from(s),
222 None => stage0_root.join(exe("cargo", &config.build)),
224 let local_rebuild = config.local_rebuild;
226 let is_sudo = match env::var_os("SUDO_USER") {
228 match env::var_os("USER") {
229 Some(user) => user != sudo_user,
235 let rust_info = channel::GitInfo::new(&src);
236 let cargo_info = channel::GitInfo::new(&src.join("cargo"));
237 let src_is_git = src.join(".git").exists();
247 rust_info: rust_info,
248 cargo_info: cargo_info,
249 local_rebuild: local_rebuild,
252 crates: HashMap::new(),
254 lldb_python_dir: None,
256 src_is_git: src_is_git,
260 /// Executes the entire build, as configured by the flags and configuration.
261 pub fn build(&mut self) {
266 if let Subcommand::Clean = self.flags.cmd {
267 return clean::clean(self);
270 self.verbose("finding compilers");
272 self.verbose("running sanity check");
274 // If local-rust is the same major.minor as the current version, then force a local-rebuild
275 let local_version_verbose = output(
276 Command::new(&self.rustc).arg("--version").arg("--verbose"));
277 let local_release = local_version_verbose
278 .lines().filter(|x| x.starts_with("release:"))
279 .next().unwrap().trim_left_matches("release:").trim();
280 let my_version = channel::CFG_RELEASE_NUM;
281 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
282 self.verbose(&format!("auto-detected local-rebuild {}", local_release));
283 self.local_rebuild = true;
285 self.verbose("updating submodules");
286 self.update_submodules();
287 self.verbose("learning about cargo");
288 metadata::build(self);
293 /// Updates all git submodules that we have.
295 /// This will detect if any submodules are out of date an run the necessary
296 /// commands to sync them all with upstream.
297 fn update_submodules(&self) {
298 struct Submodule<'a> {
304 // The submodule may have staged/unstaged changes
306 // Or could be initialized but never updated
308 // The submodule, itself, has extra commits but those changes haven't been commited to
309 // the (outer) git repository
313 if !self.src_is_git || !self.config.submodules {
317 let mut cmd = Command::new("git");
318 cmd.current_dir(&self.src);
321 let git_submodule = || {
322 let mut cmd = Command::new("git");
323 cmd.current_dir(&self.src).arg("submodule");
327 // FIXME: this takes a seriously long time to execute on Windows and a
328 // nontrivial amount of time on Unix, we should have a better way
329 // of detecting whether we need to run all the submodule commands
331 let out = output(git_submodule().arg("status"));
332 let mut submodules = vec![];
333 for line in out.lines() {
334 // NOTE `git submodule status` output looks like this:
336 // -5066b7dcab7e700844b0e2ba71b8af9dc627a59b src/liblibc
337 // +b37ef24aa82d2be3a3cc0fe89bf82292f4ca181c src/compiler-rt (remotes/origin/..)
338 // e058ca661692a8d01f8cf9d35939dfe3105ce968 src/jemalloc (3.6.0-533-ge058ca6)
340 // The first character can be '-', '+' or ' ' and denotes the `State` of the submodule
341 // Right next to this character is the SHA-1 of the submodule HEAD
342 // And after that comes the path to the submodule
343 let path = Path::new(line[1..].split(' ').skip(1).next().unwrap());
344 let state = if line.starts_with('-') {
345 State::NotInitialized
346 } else if line.starts_with('+') {
348 } else if line.starts_with(' ') {
351 panic!("unexpected git submodule state: {:?}", line.chars().next());
354 submodules.push(Submodule { path: path, state: state })
357 self.run(git_submodule().arg("sync"));
359 for submodule in submodules {
360 // If using llvm-root then don't touch the llvm submodule.
361 if submodule.path.components().any(|c| c == Component::Normal("llvm".as_ref())) &&
362 self.config.target_config.get(&self.config.build)
363 .and_then(|c| c.llvm_config.as_ref()).is_some()
368 if submodule.path.components().any(|c| c == Component::Normal("jemalloc".as_ref())) &&
369 !self.config.use_jemalloc
374 // `submodule.path` is the relative path to a submodule (from the repository root)
375 // `submodule_path` is the path to a submodule from the cwd
377 // use `submodule.path` when e.g. executing a submodule specific command from the
379 // use `submodule_path` when e.g. executing a normal git command for the submodule
380 // (set via `current_dir`)
381 let submodule_path = self.src.join(submodule.path);
383 match submodule.state {
384 State::MaybeDirty => {
385 // drop staged changes
386 self.run(git().current_dir(&submodule_path)
387 .args(&["reset", "--hard"]));
388 // drops unstaged changes
389 self.run(git().current_dir(&submodule_path)
390 .args(&["clean", "-fdx"]));
392 State::NotInitialized => {
393 self.run(git_submodule().arg("init").arg(submodule.path));
394 self.run(git_submodule().arg("update").arg(submodule.path));
396 State::OutOfSync => {
397 // drops submodule commits that weren't reported to the (outer) git repository
398 self.run(git_submodule().arg("update").arg(submodule.path));
399 self.run(git().current_dir(&submodule_path)
400 .args(&["reset", "--hard"]));
401 self.run(git().current_dir(&submodule_path)
402 .args(&["clean", "-fdx"]));
408 /// Clear out `dir` if `input` is newer.
410 /// After this executes, it will also ensure that `dir` exists.
411 fn clear_if_dirty(&self, dir: &Path, input: &Path) {
412 let stamp = dir.join(".stamp");
413 if mtime(&stamp) < mtime(input) {
414 self.verbose(&format!("Dirty - {}", dir.display()));
415 let _ = fs::remove_dir_all(dir);
416 } else if stamp.exists() {
419 t!(fs::create_dir_all(dir));
420 t!(File::create(stamp));
423 /// Prepares an invocation of `cargo` to be run.
425 /// This will create a `Command` that represents a pending execution of
426 /// Cargo. This cargo will be configured to use `compiler` as the actual
427 /// rustc compiler, its output will be scoped by `mode`'s output directory,
428 /// it will pass the `--target` flag for the specified `target`, and will be
429 /// executing the Cargo command `cmd`.
434 cmd: &str) -> Command {
435 let mut cargo = Command::new(&self.cargo);
436 let out_dir = self.stage_out(compiler, mode);
437 cargo.env("CARGO_TARGET_DIR", out_dir)
439 .arg("-j").arg(self.jobs().to_string())
440 .arg("--target").arg(target);
442 // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
443 // Force cargo to output binaries with disambiguating hashes in the name
444 cargo.env("__CARGO_DEFAULT_LIB_METADATA", "1");
447 if compiler.stage == 0 && self.local_rebuild {
448 // Assume the local-rebuild rustc already has stage1 features.
451 stage = compiler.stage;
454 // Customize the compiler we're running. Specify the compiler to cargo
455 // as our shim and then pass it some various options used to configure
456 // how the actual compiler itself is called.
458 // These variables are primarily all read by
459 // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
460 cargo.env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
461 .env("RUSTC", self.out.join("bootstrap/debug/rustc"))
462 .env("RUSTC_REAL", self.compiler_path(compiler))
463 .env("RUSTC_STAGE", stage.to_string())
464 .env("RUSTC_DEBUGINFO", self.config.rust_debuginfo.to_string())
465 .env("RUSTC_DEBUGINFO_LINES", self.config.rust_debuginfo_lines.to_string())
466 .env("RUSTC_CODEGEN_UNITS",
467 self.config.rust_codegen_units.to_string())
468 .env("RUSTC_DEBUG_ASSERTIONS",
469 self.config.rust_debug_assertions.to_string())
470 .env("RUSTC_SYSROOT", self.sysroot(compiler))
471 .env("RUSTC_LIBDIR", self.rustc_libdir(compiler))
472 .env("RUSTC_RPATH", self.config.rust_rpath.to_string())
473 .env("RUSTDOC", self.out.join("bootstrap/debug/rustdoc"))
474 .env("RUSTDOC_REAL", self.rustdoc(compiler))
475 .env("RUSTC_FLAGS", self.rustc_flags(target).join(" "));
477 // Enable usage of unstable features
478 cargo.env("RUSTC_BOOTSTRAP", "1");
479 self.add_rust_test_threads(&mut cargo);
481 // Almost all of the crates that we compile as part of the bootstrap may
482 // have a build script, including the standard library. To compile a
483 // build script, however, it itself needs a standard library! This
484 // introduces a bit of a pickle when we're compiling the standard
487 // To work around this we actually end up using the snapshot compiler
488 // (stage0) for compiling build scripts of the standard library itself.
489 // The stage0 compiler is guaranteed to have a libstd available for use.
491 // For other crates, however, we know that we've already got a standard
492 // library up and running, so we can use the normal compiler to compile
493 // build scripts in that situation.
494 if mode == Mode::Libstd {
495 cargo.env("RUSTC_SNAPSHOT", &self.rustc)
496 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
498 cargo.env("RUSTC_SNAPSHOT", self.compiler_path(compiler))
499 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
502 // There are two invariants we try must maintain:
503 // * stable crates cannot depend on unstable crates (general Rust rule),
504 // * crates that end up in the sysroot must be unstable (rustbuild rule).
506 // In order to do enforce the latter, we pass the env var
507 // `RUSTBUILD_UNSTABLE` down the line for any crates which will end up
508 // in the sysroot. We read this in bootstrap/bin/rustc.rs and if it is
509 // set, then we pass the `rustbuild` feature to rustc when building the
512 // In turn, crates that can be used here should recognise the `rustbuild`
513 // feature and opt-in to `rustc_private`.
515 // We can't always pass `rustbuild` because crates which are outside of
516 // the comipiler, libs, and tests are stable and we don't want to make
517 // their deps unstable (since this would break the first invariant
519 if mode != Mode::Tool {
520 cargo.env("RUSTBUILD_UNSTABLE", "1");
523 // Ignore incremental modes except for stage0, since we're
524 // not guaranteeing correctness acros builds if the compiler
525 // is changing under your feet.`
526 if self.flags.incremental && compiler.stage == 0 {
527 let incr_dir = self.incremental_dir(compiler);
528 cargo.env("RUSTC_INCREMENTAL", incr_dir);
531 if let Some(ref on_fail) = self.flags.on_fail {
532 cargo.env("RUSTC_ON_FAIL", on_fail);
535 let verbose = cmp::max(self.config.verbose, self.flags.verbose);
536 cargo.env("RUSTC_VERBOSE", format!("{}", verbose));
538 // Specify some various options for build scripts used throughout
541 // FIXME: the guard against msvc shouldn't need to be here
542 if !target.contains("msvc") {
543 cargo.env(format!("CC_{}", target), self.cc(target))
544 .env(format!("AR_{}", target), self.ar(target).unwrap()) // only msvc is None
545 .env(format!("CFLAGS_{}", target), self.cflags(target).join(" "));
548 if self.config.rust_save_analysis && compiler.is_final_stage(self) {
549 cargo.env("RUSTC_SAVE_ANALYSIS", "api".to_string());
552 // Environment variables *required* needed throughout the build
554 // FIXME: should update code to not require this env var
555 cargo.env("CFG_COMPILER_HOST_TRIPLE", target);
557 if self.config.verbose() || self.flags.verbose() {
560 // FIXME: cargo bench does not accept `--release`
561 if self.config.rust_optimize && cmd != "bench" {
562 cargo.arg("--release");
564 if self.config.locked_deps {
565 cargo.arg("--locked");
567 if self.config.vendor || self.is_sudo {
568 cargo.arg("--frozen");
573 /// Get a path to the compiler specified.
574 fn compiler_path(&self, compiler: &Compiler) -> PathBuf {
575 if compiler.is_snapshot(self) {
578 self.sysroot(compiler).join("bin").join(exe("rustc", compiler.host))
582 /// Get the specified tool built by the specified compiler
583 fn tool(&self, compiler: &Compiler, tool: &str) -> PathBuf {
584 self.cargo_out(compiler, Mode::Tool, compiler.host)
585 .join(exe(tool, compiler.host))
588 /// Get the `rustdoc` executable next to the specified compiler
589 fn rustdoc(&self, compiler: &Compiler) -> PathBuf {
590 let mut rustdoc = self.compiler_path(compiler);
592 rustdoc.push(exe("rustdoc", compiler.host));
596 /// Get a `Command` which is ready to run `tool` in `stage` built for
598 fn tool_cmd(&self, compiler: &Compiler, tool: &str) -> Command {
599 let mut cmd = Command::new(self.tool(&compiler, tool));
600 self.prepare_tool_cmd(compiler, &mut cmd);
604 /// Prepares the `cmd` provided to be able to run the `compiler` provided.
606 /// Notably this munges the dynamic library lookup path to point to the
607 /// right location to run `compiler`.
608 fn prepare_tool_cmd(&self, compiler: &Compiler, cmd: &mut Command) {
609 let host = compiler.host;
610 let mut paths = vec![
611 self.sysroot_libdir(compiler, compiler.host),
612 self.cargo_out(compiler, Mode::Tool, host).join("deps"),
615 // On MSVC a tool may invoke a C compiler (e.g. compiletest in run-make
616 // mode) and that C compiler may need some extra PATH modification. Do
618 if compiler.host.contains("msvc") {
619 let curpaths = env::var_os("PATH").unwrap_or(OsString::new());
620 let curpaths = env::split_paths(&curpaths).collect::<Vec<_>>();
621 for &(ref k, ref v) in self.cc[compiler.host].0.env() {
625 for path in env::split_paths(v) {
626 if !curpaths.contains(&path) {
632 add_lib_path(paths, cmd);
635 /// Get the space-separated set of activated features for the standard
637 fn std_features(&self) -> String {
638 let mut features = "panic-unwind".to_string();
640 if self.config.debug_jemalloc {
641 features.push_str(" debug-jemalloc");
643 if self.config.use_jemalloc {
644 features.push_str(" jemalloc");
646 if self.config.backtrace {
647 features.push_str(" backtrace");
652 /// Get the space-separated set of activated features for the compiler.
653 fn rustc_features(&self) -> String {
654 let mut features = String::new();
655 if self.config.use_jemalloc {
656 features.push_str(" jemalloc");
661 /// Component directory that Cargo will produce output into (e.g.
663 fn cargo_dir(&self) -> &'static str {
664 if self.config.rust_optimize {"release"} else {"debug"}
667 /// Returns the sysroot for the `compiler` specified that *this build system
670 /// That is, the sysroot for the stage0 compiler is not what the compiler
671 /// thinks it is by default, but it's the same as the default for stages
673 fn sysroot(&self, compiler: &Compiler) -> PathBuf {
674 if compiler.stage == 0 {
675 self.out.join(compiler.host).join("stage0-sysroot")
677 self.out.join(compiler.host).join(format!("stage{}", compiler.stage))
681 /// Get the directory for incremental by-products when using the
683 fn incremental_dir(&self, compiler: &Compiler) -> PathBuf {
684 self.out.join(compiler.host).join(format!("stage{}-incremental", compiler.stage))
687 /// Returns the libdir where the standard library and other artifacts are
688 /// found for a compiler's sysroot.
689 fn sysroot_libdir(&self, compiler: &Compiler, target: &str) -> PathBuf {
690 self.sysroot(compiler).join("lib").join("rustlib")
691 .join(target).join("lib")
694 /// Returns the root directory for all output generated in a particular
695 /// stage when running with a particular host compiler.
697 /// The mode indicates what the root directory is for.
698 fn stage_out(&self, compiler: &Compiler, mode: Mode) -> PathBuf {
699 let suffix = match mode {
700 Mode::Libstd => "-std",
701 Mode::Libtest => "-test",
702 Mode::Tool => "-tools",
703 Mode::Librustc => "-rustc",
705 self.out.join(compiler.host)
706 .join(format!("stage{}{}", compiler.stage, suffix))
709 /// Returns the root output directory for all Cargo output in a given stage,
710 /// running a particular comipler, wehther or not we're building the
711 /// standard library, and targeting the specified architecture.
715 target: &str) -> PathBuf {
716 self.stage_out(compiler, mode).join(target).join(self.cargo_dir())
719 /// Root output directory for LLVM compiled for `target`
721 /// Note that if LLVM is configured externally then the directory returned
722 /// will likely be empty.
723 fn llvm_out(&self, target: &str) -> PathBuf {
724 self.out.join(target).join("llvm")
727 /// Output directory for all documentation for a target
728 fn doc_out(&self, target: &str) -> PathBuf {
729 self.out.join(target).join("doc")
732 /// Output directory for all crate documentation for a target (temporary)
734 /// The artifacts here are then copied into `doc_out` above.
735 fn crate_doc_out(&self, target: &str) -> PathBuf {
736 self.out.join(target).join("crate-docs")
739 /// Returns true if no custom `llvm-config` is set for the specified target.
741 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
742 fn is_rust_llvm(&self, target: &str) -> bool {
743 match self.config.target_config.get(target) {
744 Some(ref c) => c.llvm_config.is_none(),
749 /// Returns the path to `llvm-config` for the specified target.
751 /// If a custom `llvm-config` was specified for target then that's returned
753 fn llvm_config(&self, target: &str) -> PathBuf {
754 let target_config = self.config.target_config.get(target);
755 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
758 self.llvm_out(&self.config.build).join("bin")
759 .join(exe("llvm-config", target))
763 /// Returns the path to `FileCheck` binary for the specified target
764 fn llvm_filecheck(&self, target: &str) -> PathBuf {
765 let target_config = self.config.target_config.get(target);
766 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
767 let llvm_bindir = output(Command::new(s).arg("--bindir"));
768 Path::new(llvm_bindir.trim()).join(exe("FileCheck", target))
770 let base = self.llvm_out(&self.config.build).join("build");
771 let exe = exe("FileCheck", target);
772 if !self.config.ninja && self.config.build.contains("msvc") {
773 base.join("Release/bin").join(exe)
775 base.join("bin").join(exe)
780 /// Directory for libraries built from C/C++ code and shared between stages.
781 fn native_dir(&self, target: &str) -> PathBuf {
782 self.out.join(target).join("native")
785 /// Root output directory for rust_test_helpers library compiled for
787 fn test_helpers_out(&self, target: &str) -> PathBuf {
788 self.native_dir(target).join("rust-test-helpers")
791 /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
792 /// library lookup path.
793 fn add_rustc_lib_path(&self, compiler: &Compiler, cmd: &mut Command) {
794 // Windows doesn't need dylib path munging because the dlls for the
795 // compiler live next to the compiler and the system will find them
801 add_lib_path(vec![self.rustc_libdir(compiler)], cmd);
804 /// Adds the `RUST_TEST_THREADS` env var if necessary
805 fn add_rust_test_threads(&self, cmd: &mut Command) {
806 if env::var_os("RUST_TEST_THREADS").is_none() {
807 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
811 /// Returns the compiler's libdir where it stores the dynamic libraries that
812 /// it itself links against.
814 /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
816 fn rustc_libdir(&self, compiler: &Compiler) -> PathBuf {
817 if compiler.is_snapshot(self) {
818 self.rustc_snapshot_libdir()
820 self.sysroot(compiler).join(libdir(compiler.host))
824 /// Returns the libdir of the snapshot compiler.
825 fn rustc_snapshot_libdir(&self) -> PathBuf {
826 self.rustc.parent().unwrap().parent().unwrap()
827 .join(libdir(&self.config.build))
830 /// Runs a command, printing out nice contextual information if it fails.
831 fn run(&self, cmd: &mut Command) {
832 self.verbose(&format!("running: {:?}", cmd));
836 /// Runs a command, printing out nice contextual information if it fails.
837 fn run_quiet(&self, cmd: &mut Command) {
838 self.verbose(&format!("running: {:?}", cmd));
842 /// Prints a message if this build is configured in verbose mode.
843 fn verbose(&self, msg: &str) {
844 if self.flags.verbose() || self.config.verbose() {
849 /// Returns the number of parallel jobs that have been configured for this
851 fn jobs(&self) -> u32 {
852 self.flags.jobs.unwrap_or(num_cpus::get() as u32)
855 /// Returns the path to the C compiler for the target specified.
856 fn cc(&self, target: &str) -> &Path {
857 self.cc[target].0.path()
860 /// Returns a list of flags to pass to the C compiler for the target
862 fn cflags(&self, target: &str) -> Vec<String> {
863 // Filter out -O and /O (the optimization flags) that we picked up from
864 // gcc-rs because the build scripts will determine that for themselves.
865 let mut base = self.cc[target].0.args().iter()
866 .map(|s| s.to_string_lossy().into_owned())
867 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
868 .collect::<Vec<_>>();
870 // If we're compiling on macOS then we add a few unconditional flags
871 // indicating that we want libc++ (more filled out than libstdc++) and
872 // we want to compile for 10.7. This way we can ensure that
873 // LLVM/jemalloc/etc are all properly compiled.
874 if target.contains("apple-darwin") {
875 base.push("-stdlib=libc++".into());
880 /// Returns the path to the `ar` archive utility for the target specified.
881 fn ar(&self, target: &str) -> Option<&Path> {
882 self.cc[target].1.as_ref().map(|p| &**p)
885 /// Returns the path to the C++ compiler for the target specified, may panic
886 /// if no C++ compiler was configured for the target.
887 fn cxx(&self, target: &str) -> &Path {
888 match self.cxx.get(target) {
890 None => panic!("\n\ntarget `{}` is not configured as a host,
891 only as a target\n\n", target),
895 /// Returns flags to pass to the compiler to generate code for `target`.
896 fn rustc_flags(&self, target: &str) -> Vec<String> {
897 // New flags should be added here with great caution!
899 // It's quite unfortunate to **require** flags to generate code for a
900 // target, so it should only be passed here if absolutely necessary!
901 // Most default configuration should be done through target specs rather
902 // than an entry here.
904 let mut base = Vec::new();
905 if target != self.config.build && !target.contains("msvc") &&
906 !target.contains("emscripten") {
907 base.push(format!("-Clinker={}", self.cc(target).display()));
912 /// Returns the "musl root" for this `target`, if defined
913 fn musl_root(&self, target: &str) -> Option<&Path> {
914 self.config.target_config.get(target)
915 .and_then(|t| t.musl_root.as_ref())
916 .or(self.config.musl_root.as_ref())
920 /// Returns the root of the "rootfs" image that this target will be using,
921 /// if one was configured.
923 /// If `Some` is returned then that means that tests for this target are
924 /// emulated with QEMU and binaries will need to be shipped to the emulator.
925 fn qemu_rootfs(&self, target: &str) -> Option<&Path> {
926 self.config.target_config.get(target)
927 .and_then(|t| t.qemu_rootfs.as_ref())
931 /// Path to the python interpreter to use
932 fn python(&self) -> &Path {
933 self.config.python.as_ref().unwrap()
936 /// Tests whether the `compiler` compiling for `target` should be forced to
937 /// use a stage1 compiler instead.
939 /// Currently, by default, the build system does not perform a "full
940 /// bootstrap" by default where we compile the compiler three times.
941 /// Instead, we compile the compiler two times. The final stage (stage2)
942 /// just copies the libraries from the previous stage, which is what this
945 /// Here we return `true` if:
947 /// * The build isn't performing a full bootstrap
948 /// * The `compiler` is in the final stage, 2
949 /// * We're not cross-compiling, so the artifacts are already available in
952 /// When all of these conditions are met the build will lift artifacts from
953 /// the previous stage forward.
954 fn force_use_stage1(&self, compiler: &Compiler, target: &str) -> bool {
955 !self.config.full_bootstrap &&
956 compiler.stage >= 2 &&
957 self.config.host.iter().any(|h| h == target)
960 /// Returns the directory that OpenSSL artifacts are compiled into if
961 /// configured to do so.
962 fn openssl_dir(&self, target: &str) -> Option<PathBuf> {
963 // OpenSSL not used on Windows
964 if target.contains("windows") {
966 } else if self.config.openssl_static {
967 Some(self.out.join(target).join("openssl"))
973 /// Returns the directory that OpenSSL artifacts are installed into if
974 /// configured as such.
975 fn openssl_install_dir(&self, target: &str) -> Option<PathBuf> {
976 self.openssl_dir(target).map(|p| p.join("install"))
979 /// Given `num` in the form "a.b.c" return a "release string" which
980 /// describes the release version number.
982 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
983 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
984 fn release(&self, num: &str) -> String {
985 match &self.config.channel[..] {
986 "stable" => num.to_string(),
987 "beta" => format!("{}-beta{}", num, channel::CFG_PRERELEASE_VERSION),
988 "nightly" => format!("{}-nightly", num),
989 _ => format!("{}-dev", num),
993 /// Returns the value of `release` above for Rust itself.
994 fn rust_release(&self) -> String {
995 self.release(channel::CFG_RELEASE_NUM)
998 /// Returns the "package version" for a component given the `num` release
1001 /// The package version is typically what shows up in the names of tarballs.
1002 /// For channels like beta/nightly it's just the channel name, otherwise
1003 /// it's the `num` provided.
1004 fn package_vers(&self, num: &str) -> String {
1005 match &self.config.channel[..] {
1006 "stable" => num.to_string(),
1007 "beta" => "beta".to_string(),
1008 "nightly" => "nightly".to_string(),
1009 _ => format!("{}-dev", num),
1013 /// Returns the value of `package_vers` above for Rust itself.
1014 fn rust_package_vers(&self) -> String {
1015 self.package_vers(channel::CFG_RELEASE_NUM)
1018 /// Returns the value of `package_vers` above for Cargo
1019 fn cargo_package_vers(&self) -> String {
1020 self.package_vers(&self.cargo_release_num())
1023 /// Returns the `version` string associated with this compiler for Rust
1026 /// Note that this is a descriptive string which includes the commit date,
1027 /// sha, version, etc.
1028 fn rust_version(&self) -> String {
1029 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
1032 /// Returns the `a.b.c` version that Cargo is at.
1033 fn cargo_release_num(&self) -> String {
1034 let mut toml = String::new();
1035 t!(t!(File::open(self.src.join("cargo/Cargo.toml"))).read_to_string(&mut toml));
1036 for line in toml.lines() {
1037 let prefix = "version = \"";
1039 if line.starts_with(prefix) && line.ends_with(suffix) {
1040 return line[prefix.len()..line.len() - suffix.len()].to_string()
1044 panic!("failed to find version in cargo's Cargo.toml")
1047 /// Returns whether unstable features should be enabled for the compiler
1049 fn unstable_features(&self) -> bool {
1050 match &self.config.channel[..] {
1051 "stable" | "beta" => false,
1052 "nightly" | _ => true,
1057 impl<'a> Compiler<'a> {
1058 /// Creates a new complier for the specified stage/host
1059 fn new(stage: u32, host: &'a str) -> Compiler<'a> {
1060 Compiler { stage: stage, host: host }
1063 /// Returns whether this is a snapshot compiler for `build`'s configuration
1064 fn is_snapshot(&self, build: &Build) -> bool {
1065 self.stage == 0 && self.host == build.config.build
1068 /// Returns if this compiler should be treated as a final stage one in the
1069 /// current build session.
1070 /// This takes into account whether we're performing a full bootstrap or
1071 /// not; don't directly compare the stage with `2`!
1072 fn is_final_stage(&self, build: &Build) -> bool {
1073 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1074 self.stage >= final_stage