1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Implementation of rustbuild, the Rust build system.
13 //! This module, and its descendants, are the implementation of the Rust build
14 //! system. Most of this build system is backed by Cargo but the outer layer
15 //! here serves as the ability to orchestrate calling Cargo, sequencing Cargo
16 //! builds, building artifacts like LLVM, etc. The goals of rustbuild are:
18 //! * To be an easily understandable, easily extensible, and maintainable build
20 //! * Leverage standard tools in the Rust ecosystem to build the compiler, aka
21 //! crates.io and Cargo.
22 //! * A standard interface to build across all platforms, including MSVC
26 //! The build system defers most of the complicated logic managing invocations
27 //! of rustc and rustdoc to Cargo itself. However, moving through various stages
28 //! and copying artifacts is still necessary for it to do. Each time rustbuild
29 //! is invoked, it will iterate through the list of predefined steps and execute
30 //! each serially in turn if it matches the paths passed or is a default rule.
31 //! For each step rustbuild relies on the step internally being incremental and
32 //! parallel. Note, though, that the `-j` parameter to rustbuild gets forwarded
33 //! to appropriate test harnesses and such.
35 //! Most of the "meaty" steps that matter are backed by Cargo, which does indeed
36 //! have its own parallelism and incremental management. Later steps, like
37 //! tests, aren't incremental and simply run the entire suite currently.
38 //! However, compiletest itself tries to avoid running tests when the artifacts
39 //! that are involved (mainly the compiler) haven't changed.
41 //! When you execute `x.py build`, the steps which are executed are:
43 //! * First, the python script is run. This will automatically download the
44 //! stage0 rustc and cargo according to `src/stage0.txt`, or use the cached
45 //! versions if they're available. These are then used to compile rustbuild
46 //! itself (using Cargo). Finally, control is then transferred to rustbuild.
48 //! * Rustbuild takes over, performs sanity checks, probes the environment,
49 //! reads configuration, and starts executing steps as it reads the command
50 //! line arguments (paths) or going through the default rules.
52 //! The build output will be something like the following:
54 //! Building stage0 std artifacts
55 //! Copying stage0 std
56 //! Building stage0 test artifacts
57 //! Copying stage0 test
58 //! Building stage0 compiler artifacts
59 //! Copying stage0 rustc
60 //! Assembling stage1 compiler
61 //! Building stage1 std artifacts
62 //! Copying stage1 std
63 //! Building stage1 test artifacts
64 //! Copying stage1 test
65 //! Building stage1 compiler artifacts
66 //! Copying stage1 rustc
67 //! Assembling stage2 compiler
68 //! Uplifting stage1 std
69 //! Uplifting stage1 test
70 //! Uplifting stage1 rustc
72 //! Let's disect that a little:
74 //! ## Building stage0 {std,test,compiler} artifacts
76 //! These steps use the provided (downloaded, usually) compiler to compile the
77 //! local Rust source into libraries we can use.
79 //! ## Copying stage0 {std,test,rustc}
81 //! This copies the build output from Cargo into
82 //! `build/$HOST/stage0-sysroot/lib/rustlib/$ARCH/lib`. FIXME: This step's
83 //! documentation should be expanded -- the information already here may be
86 //! ## Assembling stage1 compiler
88 //! This copies the libraries we built in "building stage0 ... artifacts" into
89 //! the stage1 compiler's lib directory. These are the host libraries that the
90 //! compiler itself uses to run. These aren't actually used by artifacts the new
91 //! compiler generates. This step also copies the rustc and rustdoc binaries we
92 //! generated into build/$HOST/stage/bin.
94 //! The stage1/bin/rustc is a fully functional compiler, but it doesn't yet have
95 //! any libraries to link built binaries or libraries to. The next 3 steps will
96 //! provide those libraries for it; they are mostly equivalent to constructing
97 //! the stage1/bin compiler so we don't go through them individually.
99 //! ## Uplifting stage1 {std,test,rustc}
101 //! This step copies the libraries from the stage1 compiler sysroot into the
102 //! stage2 compiler. This is done to avoid rebuilding the compiler; libraries
103 //! we'd build in this step should be identical (in function, if not necessarily
104 //! identical on disk) so there's no need to recompile the compiler again. Note
105 //! that if you want to, you can enable the full-bootstrap option to change this
108 //! Each step is driven by a separate Cargo project and rustbuild orchestrates
109 //! copying files between steps and otherwise preparing for Cargo to run.
111 //! ## Further information
113 //! More documentation can be found in each respective module below, and you can
114 //! also check out the `src/bootstrap/README.md` file for more information.
117 #![allow(stable_features)]
118 #![feature(associated_consts)]
121 extern crate build_helper;
123 extern crate serde_derive;
125 extern crate lazy_static;
126 extern crate serde_json;
128 extern crate filetime;
130 extern crate getopts;
131 extern crate num_cpus;
137 use std::cell::{RefCell, Cell};
138 use std::collections::{HashSet, HashMap};
140 use std::fs::{self, File};
142 use std::path::{PathBuf, Path};
143 use std::process::{self, Command};
146 use build_helper::{run_silent, run_suppressed, try_run_silent, try_run_suppressed, output, mtime};
148 use util::{exe, libdir, OutputFolder, CiEnv};
177 pub unsafe fn setup(build: &mut ::Build) {
178 if build.config.low_priority {
179 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
184 #[cfg(not(any(unix, windows)))]
186 pub unsafe fn setup(_build: &mut ::Build) {
190 pub use config::Config;
191 use flags::Subcommand;
192 use cache::{Interned, INTERNER};
193 use toolstate::ToolState;
195 /// A structure representing a Rust compiler.
197 /// Each compiler has a `stage` that it is associated with and a `host` that
198 /// corresponds to the platform the compiler runs on. This structure is used as
199 /// a parameter to many methods below.
200 #[derive(Eq, PartialEq, Clone, Copy, Hash, Debug)]
201 pub struct Compiler {
203 host: Interned<String>,
206 /// Global configuration for the build system.
208 /// This structure transitively contains all configuration for the build system.
209 /// All filesystem-encoded configuration is in `config`, all flags are in
210 /// `flags`, and then parsed or probed information is listed in the keys below.
212 /// This structure is a parameter of almost all methods in the build system,
213 /// although most functions are implemented as free functions rather than
214 /// methods specifically on this structure itself (to make it easier to
217 // User-specified configuration via config.toml
220 // Derived properties from the above two configurations
223 rust_info: channel::GitInfo,
224 cargo_info: channel::GitInfo,
225 rls_info: channel::GitInfo,
226 rustfmt_info: channel::GitInfo,
231 // Targets for which to build.
232 build: Interned<String>,
233 hosts: Vec<Interned<String>>,
234 targets: Vec<Interned<String>>,
236 // Stage 0 (downloaded) compiler and cargo or their local rust equivalents.
237 initial_rustc: PathBuf,
238 initial_cargo: PathBuf,
240 // Probed tools at runtime
241 lldb_version: Option<String>,
242 lldb_python_dir: Option<String>,
244 // Runtime state filled in later on
245 // C/C++ compilers and archiver for all targets
246 cc: HashMap<Interned<String>, cc::Tool>,
247 cxx: HashMap<Interned<String>, cc::Tool>,
248 ar: HashMap<Interned<String>, PathBuf>,
250 crates: HashMap<Interned<String>, Crate>,
253 delayed_failures: RefCell<Vec<String>>,
254 prerelease_version: Cell<Option<u32>>,
259 name: Interned<String>,
261 deps: Vec<Interned<String>>,
269 /// The various "modes" of invoking Cargo.
271 /// These entries currently correspond to the various output directories of the
272 /// build system, with each mod generating output in a different directory.
273 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq)]
275 /// Build the standard library, placing output in the "stageN-std" directory.
278 /// Build libtest, placing output in the "stageN-test" directory.
281 /// Build librustc and compiler libraries, placing output in the "stageN-rustc" directory.
284 /// Build some tool, placing output in the "stageN-tools" directory.
289 /// Creates a new set of build configuration from the `flags` on the command
290 /// line and the filesystem `config`.
292 /// By default all build output will be placed in the current directory.
293 pub fn new(config: Config) -> Build {
294 let cwd = t!(env::current_dir());
295 let src = config.src.clone();
296 let out = cwd.join("build");
298 let is_sudo = match env::var_os("SUDO_USER") {
300 match env::var_os("USER") {
301 Some(user) => user != sudo_user,
307 let rust_info = channel::GitInfo::new(&config, &src);
308 let cargo_info = channel::GitInfo::new(&config, &src.join("src/tools/cargo"));
309 let rls_info = channel::GitInfo::new(&config, &src.join("src/tools/rls"));
310 let rustfmt_info = channel::GitInfo::new(&config, &src.join("src/tools/rustfmt"));
313 initial_rustc: config.initial_rustc.clone(),
314 initial_cargo: config.initial_cargo.clone(),
315 local_rebuild: config.local_rebuild,
316 fail_fast: config.cmd.fail_fast(),
317 verbosity: config.verbose,
320 hosts: config.hosts.clone(),
321 targets: config.targets.clone(),
334 crates: HashMap::new(),
336 lldb_python_dir: None,
338 ci_env: CiEnv::current(),
339 delayed_failures: RefCell::new(Vec::new()),
340 prerelease_version: Cell::new(None),
344 pub fn build_triple(&self) -> &[Interned<String>] {
346 slice::from_raw_parts(&self.build, 1)
350 /// Executes the entire build, as configured by the flags and configuration.
351 pub fn build(&mut self) {
356 if let Subcommand::Clean { all } = self.config.cmd {
357 return clean::clean(self, all);
360 self.verbose("finding compilers");
361 cc_detect::find(self);
362 self.verbose("running sanity check");
364 // If local-rust is the same major.minor as the current version, then force a local-rebuild
365 let local_version_verbose = output(
366 Command::new(&self.initial_rustc).arg("--version").arg("--verbose"));
367 let local_release = local_version_verbose
368 .lines().filter(|x| x.starts_with("release:"))
369 .next().unwrap().trim_left_matches("release:").trim();
370 let my_version = channel::CFG_RELEASE_NUM;
371 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
372 self.verbose(&format!("auto-detected local-rebuild {}", local_release));
373 self.local_rebuild = true;
375 self.verbose("learning about cargo");
376 metadata::build(self);
378 builder::Builder::run(&self);
380 // Check for postponed failures from `test --no-fail-fast`.
381 let failures = self.delayed_failures.borrow();
382 if failures.len() > 0 {
383 println!("\n{} command(s) did not execute successfully:\n", failures.len());
384 for failure in failures.iter() {
385 println!(" - {}\n", failure);
391 /// Clear out `dir` if `input` is newer.
393 /// After this executes, it will also ensure that `dir` exists.
394 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
395 let stamp = dir.join(".stamp");
396 let mut cleared = false;
397 if mtime(&stamp) < mtime(input) {
398 self.verbose(&format!("Dirty - {}", dir.display()));
399 let _ = fs::remove_dir_all(dir);
401 } else if stamp.exists() {
404 t!(fs::create_dir_all(dir));
405 t!(File::create(stamp));
409 /// Get the space-separated set of activated features for the standard
411 fn std_features(&self) -> String {
412 let mut features = "panic-unwind".to_string();
414 if self.config.debug_jemalloc {
415 features.push_str(" debug-jemalloc");
417 if self.config.use_jemalloc {
418 features.push_str(" jemalloc");
420 if self.config.backtrace {
421 features.push_str(" backtrace");
423 if self.config.profiler {
424 features.push_str(" profiler");
429 /// Get the space-separated set of activated features for the compiler.
430 fn rustc_features(&self) -> String {
431 let mut features = String::new();
432 if self.config.use_jemalloc {
433 features.push_str(" jemalloc");
438 /// Component directory that Cargo will produce output into (e.g.
440 fn cargo_dir(&self) -> &'static str {
441 if self.config.rust_optimize {"release"} else {"debug"}
444 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
445 let out = self.out.join(&*compiler.host).join(format!("stage{}-tools-bin", compiler.stage));
446 t!(fs::create_dir_all(&out));
450 /// Returns the root directory for all output generated in a particular
451 /// stage when running with a particular host compiler.
453 /// The mode indicates what the root directory is for.
454 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
455 let suffix = match mode {
456 Mode::Libstd => "-std",
457 Mode::Libtest => "-test",
458 Mode::Tool => "-tools",
459 Mode::Librustc => "-rustc",
461 self.out.join(&*compiler.host)
462 .join(format!("stage{}{}", compiler.stage, suffix))
465 /// Returns the root output directory for all Cargo output in a given stage,
466 /// running a particular compiler, whether or not we're building the
467 /// standard library, and targeting the specified architecture.
471 target: Interned<String>) -> PathBuf {
472 self.stage_out(compiler, mode).join(&*target).join(self.cargo_dir())
475 /// Root output directory for LLVM compiled for `target`
477 /// Note that if LLVM is configured externally then the directory returned
478 /// will likely be empty.
479 fn llvm_out(&self, target: Interned<String>) -> PathBuf {
480 self.out.join(&*target).join("llvm")
483 /// Output directory for all documentation for a target
484 fn doc_out(&self, target: Interned<String>) -> PathBuf {
485 self.out.join(&*target).join("doc")
488 /// Output directory for some generated md crate documentation for a target (temporary)
489 fn md_doc_out(&self, target: Interned<String>) -> Interned<PathBuf> {
490 INTERNER.intern_path(self.out.join(&*target).join("md-doc"))
493 /// Output directory for all crate documentation for a target (temporary)
495 /// The artifacts here are then copied into `doc_out` above.
496 fn crate_doc_out(&self, target: Interned<String>) -> PathBuf {
497 self.out.join(&*target).join("crate-docs")
500 /// Returns true if no custom `llvm-config` is set for the specified target.
502 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
503 fn is_rust_llvm(&self, target: Interned<String>) -> bool {
504 match self.config.target_config.get(&target) {
505 Some(ref c) => c.llvm_config.is_none(),
510 /// Returns the path to `llvm-config` for the specified target.
512 /// If a custom `llvm-config` was specified for target then that's returned
514 fn llvm_config(&self, target: Interned<String>) -> PathBuf {
515 let target_config = self.config.target_config.get(&target);
516 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
519 self.llvm_out(self.config.build).join("bin")
520 .join(exe("llvm-config", &*target))
524 /// Returns the path to `FileCheck` binary for the specified target
525 fn llvm_filecheck(&self, target: Interned<String>) -> PathBuf {
526 let target_config = self.config.target_config.get(&target);
527 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
528 let llvm_bindir = output(Command::new(s).arg("--bindir"));
529 Path::new(llvm_bindir.trim()).join(exe("FileCheck", &*target))
531 let base = self.llvm_out(self.config.build).join("build");
532 let exe = exe("FileCheck", &*target);
533 if !self.config.ninja && self.config.build.contains("msvc") {
534 base.join("Release/bin").join(exe)
536 base.join("bin").join(exe)
541 /// Directory for libraries built from C/C++ code and shared between stages.
542 fn native_dir(&self, target: Interned<String>) -> PathBuf {
543 self.out.join(&*target).join("native")
546 /// Root output directory for rust_test_helpers library compiled for
548 fn test_helpers_out(&self, target: Interned<String>) -> PathBuf {
549 self.native_dir(target).join("rust-test-helpers")
552 /// Adds the `RUST_TEST_THREADS` env var if necessary
553 fn add_rust_test_threads(&self, cmd: &mut Command) {
554 if env::var_os("RUST_TEST_THREADS").is_none() {
555 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
559 /// Returns the libdir of the snapshot compiler.
560 fn rustc_snapshot_libdir(&self) -> PathBuf {
561 self.initial_rustc.parent().unwrap().parent().unwrap()
562 .join(libdir(&self.config.build))
565 /// Runs a command, printing out nice contextual information if it fails.
566 fn run(&self, cmd: &mut Command) {
567 self.verbose(&format!("running: {:?}", cmd));
571 /// Runs a command, printing out nice contextual information if it fails.
572 fn run_quiet(&self, cmd: &mut Command) {
573 self.verbose(&format!("running: {:?}", cmd));
577 /// Runs a command, printing out nice contextual information if it fails.
578 /// Exits if the command failed to execute at all, otherwise returns its
579 /// `status.success()`.
580 fn try_run(&self, cmd: &mut Command) -> bool {
581 self.verbose(&format!("running: {:?}", cmd));
585 /// Runs a command, printing out nice contextual information if it fails.
586 /// Exits if the command failed to execute at all, otherwise returns its
587 /// `status.success()`.
588 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
589 self.verbose(&format!("running: {:?}", cmd));
590 try_run_suppressed(cmd)
593 pub fn is_verbose(&self) -> bool {
597 pub fn is_very_verbose(&self) -> bool {
601 /// Prints a message if this build is configured in verbose mode.
602 fn verbose(&self, msg: &str) {
603 if self.is_verbose() {
608 /// Returns the number of parallel jobs that have been configured for this
610 fn jobs(&self) -> u32 {
611 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
614 /// Returns the path to the C compiler for the target specified.
615 fn cc(&self, target: Interned<String>) -> &Path {
616 self.cc[&target].path()
619 /// Returns a list of flags to pass to the C compiler for the target
621 fn cflags(&self, target: Interned<String>) -> Vec<String> {
622 // Filter out -O and /O (the optimization flags) that we picked up from
623 // cc-rs because the build scripts will determine that for themselves.
624 let mut base = self.cc[&target].args().iter()
625 .map(|s| s.to_string_lossy().into_owned())
626 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
627 .collect::<Vec<_>>();
629 // If we're compiling on macOS then we add a few unconditional flags
630 // indicating that we want libc++ (more filled out than libstdc++) and
631 // we want to compile for 10.7. This way we can ensure that
632 // LLVM/jemalloc/etc are all properly compiled.
633 if target.contains("apple-darwin") {
634 base.push("-stdlib=libc++".into());
637 // Work around an apparently bad MinGW / GCC optimization,
638 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
639 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
640 if &*target == "i686-pc-windows-gnu" {
641 base.push("-fno-omit-frame-pointer".into());
646 /// Returns the path to the `ar` archive utility for the target specified.
647 fn ar(&self, target: Interned<String>) -> Option<&Path> {
648 self.ar.get(&target).map(|p| &**p)
651 /// Returns the path to the C++ compiler for the target specified.
652 fn cxx(&self, target: Interned<String>) -> Result<&Path, String> {
653 match self.cxx.get(&target) {
654 Some(p) => Ok(p.path()),
656 "target `{}` is not configured as a host, only as a target",
661 /// Returns the path to the linker for the given target if it needs to be overriden.
662 fn linker(&self, target: Interned<String>) -> Option<&Path> {
663 if let Some(linker) = self.config.target_config.get(&target)
664 .and_then(|c| c.linker.as_ref()) {
666 } else if target != self.config.build &&
667 !target.contains("msvc") && !target.contains("emscripten") {
668 Some(self.cc(target))
674 /// Returns if this target should statically link the C runtime, if specified
675 fn crt_static(&self, target: Interned<String>) -> Option<bool> {
676 if target.contains("pc-windows-msvc") {
679 self.config.target_config.get(&target)
680 .and_then(|t| t.crt_static)
684 /// Returns the "musl root" for this `target`, if defined
685 fn musl_root(&self, target: Interned<String>) -> Option<&Path> {
686 self.config.target_config.get(&target)
687 .and_then(|t| t.musl_root.as_ref())
688 .or(self.config.musl_root.as_ref())
692 /// Returns whether the target will be tested using the `remote-test-client`
693 /// and `remote-test-server` binaries.
694 fn remote_tested(&self, target: Interned<String>) -> bool {
695 self.qemu_rootfs(target).is_some() || target.contains("android") ||
696 env::var_os("TEST_DEVICE_ADDR").is_some()
699 /// Returns the root of the "rootfs" image that this target will be using,
700 /// if one was configured.
702 /// If `Some` is returned then that means that tests for this target are
703 /// emulated with QEMU and binaries will need to be shipped to the emulator.
704 fn qemu_rootfs(&self, target: Interned<String>) -> Option<&Path> {
705 self.config.target_config.get(&target)
706 .and_then(|t| t.qemu_rootfs.as_ref())
710 /// Path to the python interpreter to use
711 fn python(&self) -> &Path {
712 self.config.python.as_ref().unwrap()
715 /// Temporary directory that extended error information is emitted to.
716 fn extended_error_dir(&self) -> PathBuf {
717 self.out.join("tmp/extended-error-metadata")
720 /// Tests whether the `compiler` compiling for `target` should be forced to
721 /// use a stage1 compiler instead.
723 /// Currently, by default, the build system does not perform a "full
724 /// bootstrap" by default where we compile the compiler three times.
725 /// Instead, we compile the compiler two times. The final stage (stage2)
726 /// just copies the libraries from the previous stage, which is what this
729 /// Here we return `true` if:
731 /// * The build isn't performing a full bootstrap
732 /// * The `compiler` is in the final stage, 2
733 /// * We're not cross-compiling, so the artifacts are already available in
736 /// When all of these conditions are met the build will lift artifacts from
737 /// the previous stage forward.
738 fn force_use_stage1(&self, compiler: Compiler, target: Interned<String>) -> bool {
739 !self.config.full_bootstrap &&
740 compiler.stage >= 2 &&
741 (self.hosts.iter().any(|h| *h == target) || target == self.build)
744 /// Returns the directory that OpenSSL artifacts are compiled into if
745 /// configured to do so.
746 fn openssl_dir(&self, target: Interned<String>) -> Option<PathBuf> {
747 // OpenSSL not used on Windows
748 if target.contains("windows") {
750 } else if self.config.openssl_static {
751 Some(self.out.join(&*target).join("openssl"))
757 /// Returns the directory that OpenSSL artifacts are installed into if
758 /// configured as such.
759 fn openssl_install_dir(&self, target: Interned<String>) -> Option<PathBuf> {
760 self.openssl_dir(target).map(|p| p.join("install"))
763 /// Given `num` in the form "a.b.c" return a "release string" which
764 /// describes the release version number.
766 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
767 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
768 fn release(&self, num: &str) -> String {
769 match &self.config.channel[..] {
770 "stable" => num.to_string(),
771 "beta" => if self.rust_info.is_git() {
772 format!("{}-beta.{}", num, self.beta_prerelease_version())
774 format!("{}-beta", num)
776 "nightly" => format!("{}-nightly", num),
777 _ => format!("{}-dev", num),
781 fn beta_prerelease_version(&self) -> u32 {
782 if let Some(s) = self.prerelease_version.get() {
791 .current_dir(&self.src)
793 let beta = beta.trim().split_whitespace().next().unwrap();
799 .current_dir(&self.src)
801 let master = master.trim().split_whitespace().next().unwrap();
803 // Figure out where the current beta branch started.
809 .current_dir(&self.src),
811 let base = base.trim();
813 // Next figure out how many merge commits happened since we branched off
814 // beta. That's our beta number!
820 .arg(format!("{}...HEAD", base))
821 .current_dir(&self.src),
823 let n = count.trim().parse().unwrap();
824 self.prerelease_version.set(Some(n));
828 /// Returns the value of `release` above for Rust itself.
829 fn rust_release(&self) -> String {
830 self.release(channel::CFG_RELEASE_NUM)
833 /// Returns the "package version" for a component given the `num` release
836 /// The package version is typically what shows up in the names of tarballs.
837 /// For channels like beta/nightly it's just the channel name, otherwise
838 /// it's the `num` provided.
839 fn package_vers(&self, num: &str) -> String {
840 match &self.config.channel[..] {
841 "stable" => num.to_string(),
842 "beta" => "beta".to_string(),
843 "nightly" => "nightly".to_string(),
844 _ => format!("{}-dev", num),
848 /// Returns the value of `package_vers` above for Rust itself.
849 fn rust_package_vers(&self) -> String {
850 self.package_vers(channel::CFG_RELEASE_NUM)
853 /// Returns the value of `package_vers` above for Cargo
854 fn cargo_package_vers(&self) -> String {
855 self.package_vers(&self.release_num("cargo"))
858 /// Returns the value of `package_vers` above for rls
859 fn rls_package_vers(&self) -> String {
860 self.package_vers(&self.release_num("rls"))
863 /// Returns the value of `package_vers` above for rustfmt
864 fn rustfmt_package_vers(&self) -> String {
865 self.package_vers(&self.release_num("rustfmt"))
868 /// Returns the `version` string associated with this compiler for Rust
871 /// Note that this is a descriptive string which includes the commit date,
872 /// sha, version, etc.
873 fn rust_version(&self) -> String {
874 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
877 /// Return the full commit hash
878 fn rust_sha(&self) -> Option<&str> {
882 /// Returns the `a.b.c` version that the given package is at.
883 fn release_num(&self, package: &str) -> String {
884 let mut toml = String::new();
885 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
886 t!(t!(File::open(toml_file_name)).read_to_string(&mut toml));
887 for line in toml.lines() {
888 let prefix = "version = \"";
890 if line.starts_with(prefix) && line.ends_with(suffix) {
891 return line[prefix.len()..line.len() - suffix.len()].to_string()
895 panic!("failed to find version in {}'s Cargo.toml", package)
898 /// Returns whether unstable features should be enabled for the compiler
900 fn unstable_features(&self) -> bool {
901 match &self.config.channel[..] {
902 "stable" | "beta" => false,
903 "nightly" | _ => true,
907 /// Fold the output of the commands after this method into a group. The fold
908 /// ends when the returned object is dropped. Folding can only be used in
909 /// the Travis CI environment.
910 pub fn fold_output<D, F>(&self, name: F) -> Option<OutputFolder>
911 where D: Into<String>, F: FnOnce() -> D
913 if self.ci_env == CiEnv::Travis {
914 Some(OutputFolder::new(name().into()))
920 /// Updates the actual toolstate of a tool.
922 /// The toolstates are saved to the file specified by the key
923 /// `rust.save-toolstates` in `config.toml`. If unspecified, nothing will be
924 /// done. The file is updated immediately after this function completes.
925 pub fn save_toolstate(&self, tool: &str, state: ToolState) {
926 use std::io::{Seek, SeekFrom};
928 if let Some(ref path) = self.config.save_toolstates {
929 let mut file = t!(fs::OpenOptions::new()
935 let mut current_toolstates: HashMap<Box<str>, ToolState> =
936 serde_json::from_reader(&mut file).unwrap_or_default();
937 current_toolstates.insert(tool.into(), state);
938 t!(file.seek(SeekFrom::Start(0)));
940 t!(serde_json::to_writer(file, ¤t_toolstates));
944 /// Get a list of crates from a root crate.
946 /// Returns Vec<(crate, path to crate, is_root_crate)>
947 fn crates(&self, root: &str) -> Vec<(Interned<String>, &Path)> {
948 let interned = INTERNER.intern_string(root.to_owned());
949 let mut ret = Vec::new();
950 let mut list = vec![interned];
951 let mut visited = HashSet::new();
952 while let Some(krate) = list.pop() {
953 let krate = &self.crates[&krate];
954 // If we can't strip prefix, then out-of-tree path
955 let path = krate.path.strip_prefix(&self.src).unwrap_or(&krate.path);
956 ret.push((krate.name, path));
957 for dep in &krate.deps {
958 if visited.insert(dep) && dep != "build_helper" {
968 pub fn with_stage(mut self, stage: u32) -> Compiler {
973 /// Returns whether this is a snapshot compiler for `build`'s configuration
974 pub fn is_snapshot(&self, build: &Build) -> bool {
975 self.stage == 0 && self.host == build.build
978 /// Returns if this compiler should be treated as a final stage one in the
979 /// current build session.
980 /// This takes into account whether we're performing a full bootstrap or
981 /// not; don't directly compare the stage with `2`!
982 pub fn is_final_stage(&self, build: &Build) -> bool {
983 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
984 self.stage >= final_stage