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 #![feature(core_intrinsics)]
120 extern crate build_helper;
122 extern crate serde_derive;
124 extern crate lazy_static;
125 extern crate serde_json;
127 extern crate filetime;
129 extern crate getopts;
130 extern crate num_cpus;
133 extern crate petgraph;
137 extern crate pretty_assertions;
142 use std::cell::{RefCell, Cell};
143 use std::collections::{HashSet, HashMap};
145 use std::fs::{self, OpenOptions, File};
146 use std::io::{self, Seek, SeekFrom, Write, Read};
147 use std::path::{PathBuf, Path};
148 use std::process::{self, Command};
152 use build_helper::{run_silent, run_suppressed, try_run_silent, try_run_suppressed, output, mtime};
153 use filetime::FileTime;
155 use util::{exe, libdir, OutputFolder, CiEnv};
184 pub unsafe fn setup(build: &mut ::Build) {
185 if build.config.low_priority {
186 libc::setpriority(libc::PRIO_PGRP as _, 0, 10);
191 #[cfg(not(any(unix, windows)))]
193 pub unsafe fn setup(_build: &mut ::Build) {
197 pub use config::Config;
198 use flags::Subcommand;
199 use cache::{Interned, INTERNER};
200 use toolstate::ToolState;
202 /// A structure representing a Rust compiler.
204 /// Each compiler has a `stage` that it is associated with and a `host` that
205 /// corresponds to the platform the compiler runs on. This structure is used as
206 /// a parameter to many methods below.
207 #[derive(Eq, PartialOrd, Ord, PartialEq, Clone, Copy, Hash, Debug)]
208 pub struct Compiler {
210 host: Interned<String>,
213 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
214 pub enum DocTestsOption {
215 // Default, run normal tests and doc tests.
217 // Do not run any doc tests.
219 // Only run doc tests.
223 /// Global configuration for the build system.
225 /// This structure transitively contains all configuration for the build system.
226 /// All filesystem-encoded configuration is in `config`, all flags are in
227 /// `flags`, and then parsed or probed information is listed in the keys below.
229 /// This structure is a parameter of almost all methods in the build system,
230 /// although most functions are implemented as free functions rather than
231 /// methods specifically on this structure itself (to make it easier to
234 // User-specified configuration via config.toml
237 // Derived properties from the above two configurations
240 rust_info: channel::GitInfo,
241 cargo_info: channel::GitInfo,
242 rls_info: channel::GitInfo,
243 rustfmt_info: channel::GitInfo,
246 doc_tests: DocTestsOption,
249 // Targets for which to build.
250 build: Interned<String>,
251 hosts: Vec<Interned<String>>,
252 targets: Vec<Interned<String>>,
254 // Stage 0 (downloaded) compiler and cargo or their local rust equivalents.
255 initial_rustc: PathBuf,
256 initial_cargo: PathBuf,
258 // Probed tools at runtime
259 lldb_version: Option<String>,
260 lldb_python_dir: Option<String>,
262 // Runtime state filled in later on
263 // C/C++ compilers and archiver for all targets
264 cc: HashMap<Interned<String>, cc::Tool>,
265 cxx: HashMap<Interned<String>, cc::Tool>,
266 ar: HashMap<Interned<String>, PathBuf>,
268 crates: HashMap<Interned<String>, Crate>,
271 delayed_failures: RefCell<Vec<String>>,
272 prerelease_version: Cell<Option<u32>>,
273 tool_artifacts: RefCell<HashMap<
275 HashMap<String, (&'static str, PathBuf, Vec<String>)>
281 name: Interned<String>,
283 deps: Vec<Interned<String>>,
292 fn is_local(&self, build: &Build) -> bool {
293 self.path.starts_with(&build.config.src) &&
294 !self.path.to_string_lossy().ends_with("_shim")
297 fn local_path(&self, build: &Build) -> PathBuf {
298 assert!(self.is_local(build));
299 self.path.strip_prefix(&build.config.src).unwrap().into()
303 /// The various "modes" of invoking Cargo.
305 /// These entries currently correspond to the various output directories of the
306 /// build system, with each mod generating output in a different directory.
307 #[derive(Debug, Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
309 /// Build the standard library, placing output in the "stageN-std" directory.
312 /// Build libtest, placing output in the "stageN-test" directory.
315 /// Build librustc and compiler libraries, placing output in the "stageN-rustc" directory.
318 /// Build some tool, placing output in the "stageN-tools" directory.
323 /// Creates a new set of build configuration from the `flags` on the command
324 /// line and the filesystem `config`.
326 /// By default all build output will be placed in the current directory.
327 pub fn new(config: Config) -> Build {
328 let src = config.src.clone();
329 let out = config.out.clone();
331 let is_sudo = match env::var_os("SUDO_USER") {
333 match env::var_os("USER") {
334 Some(user) => user != sudo_user,
340 let rust_info = channel::GitInfo::new(&config, &src);
341 let cargo_info = channel::GitInfo::new(&config, &src.join("src/tools/cargo"));
342 let rls_info = channel::GitInfo::new(&config, &src.join("src/tools/rls"));
343 let rustfmt_info = channel::GitInfo::new(&config, &src.join("src/tools/rustfmt"));
345 let mut build = Build {
346 initial_rustc: config.initial_rustc.clone(),
347 initial_cargo: config.initial_cargo.clone(),
348 local_rebuild: config.local_rebuild,
349 fail_fast: config.cmd.fail_fast(),
350 doc_tests: config.cmd.doc_tests(),
351 verbosity: config.verbose,
354 hosts: config.hosts.clone(),
355 targets: config.targets.clone(),
368 crates: HashMap::new(),
370 lldb_python_dir: None,
372 ci_env: CiEnv::current(),
373 delayed_failures: RefCell::new(Vec::new()),
374 prerelease_version: Cell::new(None),
375 tool_artifacts: Default::default(),
378 build.verbose("finding compilers");
379 cc_detect::find(&mut build);
380 build.verbose("running sanity check");
381 sanity::check(&mut build);
383 // If local-rust is the same major.minor as the current version, then force a
385 let local_version_verbose = output(
386 Command::new(&build.initial_rustc).arg("--version").arg("--verbose"));
387 let local_release = local_version_verbose
388 .lines().filter(|x| x.starts_with("release:"))
389 .next().unwrap().trim_left_matches("release:").trim();
390 let my_version = channel::CFG_RELEASE_NUM;
391 if local_release.split('.').take(2).eq(my_version.split('.').take(2)) {
392 build.verbose(&format!("auto-detected local-rebuild {}", local_release));
393 build.local_rebuild = true;
396 build.verbose("learning about cargo");
397 metadata::build(&mut build);
402 pub fn build_triple(&self) -> &[Interned<String>] {
404 slice::from_raw_parts(&self.build, 1)
408 /// Executes the entire build, as configured by the flags and configuration.
409 pub fn build(&mut self) {
414 if let Subcommand::Clean { all } = self.config.cmd {
415 return clean::clean(self, all);
419 let builder = builder::Builder::new(&self);
420 if let Some(path) = builder.paths.get(0) {
421 if path == Path::new("nonexistent/path/to/trigger/cargo/metadata") {
427 if !self.config.dry_run {
429 self.config.dry_run = true;
430 let builder = builder::Builder::new(&self);
431 builder.execute_cli();
433 self.config.dry_run = false;
434 let builder = builder::Builder::new(&self);
435 builder.execute_cli();
437 let builder = builder::Builder::new(&self);
438 let _ = builder.execute_cli();
441 // Check for postponed failures from `test --no-fail-fast`.
442 let failures = self.delayed_failures.borrow();
443 if failures.len() > 0 {
444 println!("\n{} command(s) did not execute successfully:\n", failures.len());
445 for failure in failures.iter() {
446 println!(" - {}\n", failure);
452 /// Clear out `dir` if `input` is newer.
454 /// After this executes, it will also ensure that `dir` exists.
455 fn clear_if_dirty(&self, dir: &Path, input: &Path) -> bool {
456 let stamp = dir.join(".stamp");
457 let mut cleared = false;
458 if mtime(&stamp) < mtime(input) {
459 self.verbose(&format!("Dirty - {}", dir.display()));
460 let _ = fs::remove_dir_all(dir);
462 } else if stamp.exists() {
465 t!(fs::create_dir_all(dir));
466 t!(File::create(stamp));
470 /// Get the space-separated set of activated features for the standard
472 fn std_features(&self) -> String {
473 let mut features = "panic-unwind".to_string();
475 if self.config.debug_jemalloc {
476 features.push_str(" debug-jemalloc");
478 if self.config.use_jemalloc {
479 features.push_str(" jemalloc");
481 if self.config.backtrace {
482 features.push_str(" backtrace");
484 if self.config.profiler {
485 features.push_str(" profiler");
487 if self.config.wasm_syscall {
488 features.push_str(" wasm_syscall");
493 /// Get the space-separated set of activated features for the compiler.
494 fn rustc_features(&self) -> String {
495 let mut features = String::new();
496 if self.config.use_jemalloc {
497 features.push_str(" jemalloc");
502 /// Component directory that Cargo will produce output into (e.g.
504 fn cargo_dir(&self) -> &'static str {
505 if self.config.rust_optimize {"release"} else {"debug"}
508 fn tools_dir(&self, compiler: Compiler) -> PathBuf {
509 let out = self.out.join(&*compiler.host).join(format!("stage{}-tools-bin", compiler.stage));
510 t!(fs::create_dir_all(&out));
514 /// Returns the root directory for all output generated in a particular
515 /// stage when running with a particular host compiler.
517 /// The mode indicates what the root directory is for.
518 fn stage_out(&self, compiler: Compiler, mode: Mode) -> PathBuf {
519 let suffix = match mode {
520 Mode::Libstd => "-std",
521 Mode::Libtest => "-test",
522 Mode::Tool => "-tools",
523 Mode::Librustc => "-rustc",
525 self.out.join(&*compiler.host)
526 .join(format!("stage{}{}", compiler.stage, suffix))
529 /// Returns the root output directory for all Cargo output in a given stage,
530 /// running a particular compiler, whether or not we're building the
531 /// standard library, and targeting the specified architecture.
535 target: Interned<String>) -> PathBuf {
536 self.stage_out(compiler, mode).join(&*target).join(self.cargo_dir())
539 /// Root output directory for LLVM compiled for `target`
541 /// Note that if LLVM is configured externally then the directory returned
542 /// will likely be empty.
543 fn llvm_out(&self, target: Interned<String>) -> PathBuf {
544 self.out.join(&*target).join("llvm")
547 fn emscripten_llvm_out(&self, target: Interned<String>) -> PathBuf {
548 self.out.join(&*target).join("llvm-emscripten")
551 fn lld_out(&self, target: Interned<String>) -> PathBuf {
552 self.out.join(&*target).join("lld")
555 /// Output directory for all documentation for a target
556 fn doc_out(&self, target: Interned<String>) -> PathBuf {
557 self.out.join(&*target).join("doc")
560 /// Output directory for all documentation for a target
561 fn compiler_doc_out(&self, target: Interned<String>) -> PathBuf {
562 self.out.join(&*target).join("compiler-doc")
565 /// Output directory for some generated md crate documentation for a target (temporary)
566 fn md_doc_out(&self, target: Interned<String>) -> Interned<PathBuf> {
567 INTERNER.intern_path(self.out.join(&*target).join("md-doc"))
570 /// Output directory for all crate documentation for a target (temporary)
572 /// The artifacts here are then copied into `doc_out` above.
573 fn crate_doc_out(&self, target: Interned<String>) -> PathBuf {
574 self.out.join(&*target).join("crate-docs")
577 /// Returns true if no custom `llvm-config` is set for the specified target.
579 /// If no custom `llvm-config` was specified then Rust's llvm will be used.
580 fn is_rust_llvm(&self, target: Interned<String>) -> bool {
581 match self.config.target_config.get(&target) {
582 Some(ref c) => c.llvm_config.is_none(),
587 /// Returns the path to `FileCheck` binary for the specified target
588 fn llvm_filecheck(&self, target: Interned<String>) -> PathBuf {
589 let target_config = self.config.target_config.get(&target);
590 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
591 let llvm_bindir = output(Command::new(s).arg("--bindir"));
592 Path::new(llvm_bindir.trim()).join(exe("FileCheck", &*target))
594 let base = self.llvm_out(self.config.build).join("build");
595 let exe = exe("FileCheck", &*target);
596 if !self.config.ninja && self.config.build.contains("msvc") {
597 base.join("Release/bin").join(exe)
599 base.join("bin").join(exe)
604 /// Directory for libraries built from C/C++ code and shared between stages.
605 fn native_dir(&self, target: Interned<String>) -> PathBuf {
606 self.out.join(&*target).join("native")
609 /// Root output directory for rust_test_helpers library compiled for
611 fn test_helpers_out(&self, target: Interned<String>) -> PathBuf {
612 self.native_dir(target).join("rust-test-helpers")
615 /// Adds the `RUST_TEST_THREADS` env var if necessary
616 fn add_rust_test_threads(&self, cmd: &mut Command) {
617 if env::var_os("RUST_TEST_THREADS").is_none() {
618 cmd.env("RUST_TEST_THREADS", self.jobs().to_string());
622 /// Returns the libdir of the snapshot compiler.
623 fn rustc_snapshot_libdir(&self) -> PathBuf {
624 self.initial_rustc.parent().unwrap().parent().unwrap()
625 .join(libdir(&self.config.build))
628 /// Runs a command, printing out nice contextual information if it fails.
629 fn run(&self, cmd: &mut Command) {
630 if self.config.dry_run { return; }
631 self.verbose(&format!("running: {:?}", cmd));
635 /// Runs a command, printing out nice contextual information if it fails.
636 fn run_quiet(&self, cmd: &mut Command) {
637 if self.config.dry_run { return; }
638 self.verbose(&format!("running: {:?}", cmd));
642 /// Runs a command, printing out nice contextual information if it fails.
643 /// Exits if the command failed to execute at all, otherwise returns its
644 /// `status.success()`.
645 fn try_run(&self, cmd: &mut Command) -> bool {
646 if self.config.dry_run { return true; }
647 self.verbose(&format!("running: {:?}", cmd));
651 /// Runs a command, printing out nice contextual information if it fails.
652 /// Exits if the command failed to execute at all, otherwise returns its
653 /// `status.success()`.
654 fn try_run_quiet(&self, cmd: &mut Command) -> bool {
655 if self.config.dry_run { return true; }
656 self.verbose(&format!("running: {:?}", cmd));
657 try_run_suppressed(cmd)
660 pub fn is_verbose(&self) -> bool {
664 /// Prints a message if this build is configured in verbose mode.
665 fn verbose(&self, msg: &str) {
666 if self.is_verbose() {
671 fn info(&self, msg: &str) {
672 if self.config.dry_run { return; }
676 /// Returns the number of parallel jobs that have been configured for this
678 fn jobs(&self) -> u32 {
679 self.config.jobs.unwrap_or_else(|| num_cpus::get() as u32)
682 /// Returns the path to the C compiler for the target specified.
683 fn cc(&self, target: Interned<String>) -> &Path {
684 self.cc[&target].path()
687 /// Returns a list of flags to pass to the C compiler for the target
689 fn cflags(&self, target: Interned<String>) -> Vec<String> {
690 // Filter out -O and /O (the optimization flags) that we picked up from
691 // cc-rs because the build scripts will determine that for themselves.
692 let mut base = self.cc[&target].args().iter()
693 .map(|s| s.to_string_lossy().into_owned())
694 .filter(|s| !s.starts_with("-O") && !s.starts_with("/O"))
695 .collect::<Vec<_>>();
697 // If we're compiling on macOS then we add a few unconditional flags
698 // indicating that we want libc++ (more filled out than libstdc++) and
699 // we want to compile for 10.7. This way we can ensure that
700 // LLVM/jemalloc/etc are all properly compiled.
701 if target.contains("apple-darwin") {
702 base.push("-stdlib=libc++".into());
705 // Work around an apparently bad MinGW / GCC optimization,
706 // See: http://lists.llvm.org/pipermail/cfe-dev/2016-December/051980.html
707 // See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=78936
708 if &*target == "i686-pc-windows-gnu" {
709 base.push("-fno-omit-frame-pointer".into());
714 /// Returns the path to the `ar` archive utility for the target specified.
715 fn ar(&self, target: Interned<String>) -> Option<&Path> {
716 self.ar.get(&target).map(|p| &**p)
719 /// Returns the path to the C++ compiler for the target specified.
720 fn cxx(&self, target: Interned<String>) -> Result<&Path, String> {
721 match self.cxx.get(&target) {
722 Some(p) => Ok(p.path()),
724 "target `{}` is not configured as a host, only as a target",
729 /// Returns the path to the linker for the given target if it needs to be overridden.
730 fn linker(&self, target: Interned<String>) -> Option<&Path> {
731 if let Some(linker) = self.config.target_config.get(&target)
732 .and_then(|c| c.linker.as_ref()) {
734 } else if target != self.config.build &&
735 !target.contains("msvc") &&
736 !target.contains("emscripten") &&
737 !target.contains("wasm32") {
738 Some(self.cc(target))
744 /// Returns if this target should statically link the C runtime, if specified
745 fn crt_static(&self, target: Interned<String>) -> Option<bool> {
746 if target.contains("pc-windows-msvc") {
749 self.config.target_config.get(&target)
750 .and_then(|t| t.crt_static)
754 /// Returns the "musl root" for this `target`, if defined
755 fn musl_root(&self, target: Interned<String>) -> Option<&Path> {
756 self.config.target_config.get(&target)
757 .and_then(|t| t.musl_root.as_ref())
758 .or(self.config.musl_root.as_ref())
762 /// Returns true if this is a no-std `target`, if defined
763 fn no_std(&self, target: Interned<String>) -> Option<bool> {
764 self.config.target_config.get(&target)
768 /// Returns whether the target will be tested using the `remote-test-client`
769 /// and `remote-test-server` binaries.
770 fn remote_tested(&self, target: Interned<String>) -> bool {
771 self.qemu_rootfs(target).is_some() || target.contains("android") ||
772 env::var_os("TEST_DEVICE_ADDR").is_some()
775 /// Returns the root of the "rootfs" image that this target will be using,
776 /// if one was configured.
778 /// If `Some` is returned then that means that tests for this target are
779 /// emulated with QEMU and binaries will need to be shipped to the emulator.
780 fn qemu_rootfs(&self, target: Interned<String>) -> Option<&Path> {
781 self.config.target_config.get(&target)
782 .and_then(|t| t.qemu_rootfs.as_ref())
786 /// Path to the python interpreter to use
787 fn python(&self) -> &Path {
788 self.config.python.as_ref().unwrap()
791 /// Temporary directory that extended error information is emitted to.
792 fn extended_error_dir(&self) -> PathBuf {
793 self.out.join("tmp/extended-error-metadata")
796 /// Tests whether the `compiler` compiling for `target` should be forced to
797 /// use a stage1 compiler instead.
799 /// Currently, by default, the build system does not perform a "full
800 /// bootstrap" by default where we compile the compiler three times.
801 /// Instead, we compile the compiler two times. The final stage (stage2)
802 /// just copies the libraries from the previous stage, which is what this
805 /// Here we return `true` if:
807 /// * The build isn't performing a full bootstrap
808 /// * The `compiler` is in the final stage, 2
809 /// * We're not cross-compiling, so the artifacts are already available in
812 /// When all of these conditions are met the build will lift artifacts from
813 /// the previous stage forward.
814 fn force_use_stage1(&self, compiler: Compiler, target: Interned<String>) -> bool {
815 !self.config.full_bootstrap &&
816 compiler.stage >= 2 &&
817 (self.hosts.iter().any(|h| *h == target) || target == self.build)
820 /// Returns the directory that OpenSSL artifacts are compiled into if
821 /// configured to do so.
822 fn openssl_dir(&self, target: Interned<String>) -> Option<PathBuf> {
823 // OpenSSL not used on Windows
824 if target.contains("windows") {
826 } else if self.config.openssl_static {
827 Some(self.out.join(&*target).join("openssl"))
833 /// Returns the directory that OpenSSL artifacts are installed into if
834 /// configured as such.
835 fn openssl_install_dir(&self, target: Interned<String>) -> Option<PathBuf> {
836 self.openssl_dir(target).map(|p| p.join("install"))
839 /// Given `num` in the form "a.b.c" return a "release string" which
840 /// describes the release version number.
842 /// For example on nightly this returns "a.b.c-nightly", on beta it returns
843 /// "a.b.c-beta.1" and on stable it just returns "a.b.c".
844 fn release(&self, num: &str) -> String {
845 match &self.config.channel[..] {
846 "stable" => num.to_string(),
847 "beta" => if self.rust_info.is_git() {
848 format!("{}-beta.{}", num, self.beta_prerelease_version())
850 format!("{}-beta", num)
852 "nightly" => format!("{}-nightly", num),
853 _ => format!("{}-dev", num),
857 fn beta_prerelease_version(&self) -> u32 {
858 if let Some(s) = self.prerelease_version.get() {
867 .current_dir(&self.src)
869 let beta = beta.trim().split_whitespace().next().unwrap();
875 .current_dir(&self.src)
877 let master = master.trim().split_whitespace().next().unwrap();
879 // Figure out where the current beta branch started.
885 .current_dir(&self.src),
887 let base = base.trim();
889 // Next figure out how many merge commits happened since we branched off
890 // beta. That's our beta number!
896 .arg(format!("{}...HEAD", base))
897 .current_dir(&self.src),
899 let n = count.trim().parse().unwrap();
900 self.prerelease_version.set(Some(n));
904 /// Returns the value of `release` above for Rust itself.
905 fn rust_release(&self) -> String {
906 self.release(channel::CFG_RELEASE_NUM)
909 /// Returns the "package version" for a component given the `num` release
912 /// The package version is typically what shows up in the names of tarballs.
913 /// For channels like beta/nightly it's just the channel name, otherwise
914 /// it's the `num` provided.
915 fn package_vers(&self, num: &str) -> String {
916 match &self.config.channel[..] {
917 "stable" => num.to_string(),
918 "beta" => "beta".to_string(),
919 "nightly" => "nightly".to_string(),
920 _ => format!("{}-dev", num),
924 /// Returns the value of `package_vers` above for Rust itself.
925 fn rust_package_vers(&self) -> String {
926 self.package_vers(channel::CFG_RELEASE_NUM)
929 /// Returns the value of `package_vers` above for Cargo
930 fn cargo_package_vers(&self) -> String {
931 self.package_vers(&self.release_num("cargo"))
934 /// Returns the value of `package_vers` above for rls
935 fn rls_package_vers(&self) -> String {
936 self.package_vers(&self.release_num("rls"))
939 /// Returns the value of `package_vers` above for rustfmt
940 fn rustfmt_package_vers(&self) -> String {
941 self.package_vers(&self.release_num("rustfmt"))
944 /// Returns the `version` string associated with this compiler for Rust
947 /// Note that this is a descriptive string which includes the commit date,
948 /// sha, version, etc.
949 fn rust_version(&self) -> String {
950 self.rust_info.version(self, channel::CFG_RELEASE_NUM)
953 /// Return the full commit hash
954 fn rust_sha(&self) -> Option<&str> {
958 /// Returns the `a.b.c` version that the given package is at.
959 fn release_num(&self, package: &str) -> String {
960 let mut toml = String::new();
961 let toml_file_name = self.src.join(&format!("src/tools/{}/Cargo.toml", package));
962 t!(t!(File::open(toml_file_name)).read_to_string(&mut toml));
963 for line in toml.lines() {
964 let prefix = "version = \"";
966 if line.starts_with(prefix) && line.ends_with(suffix) {
967 return line[prefix.len()..line.len() - suffix.len()].to_string()
971 panic!("failed to find version in {}'s Cargo.toml", package)
974 /// Returns whether unstable features should be enabled for the compiler
976 fn unstable_features(&self) -> bool {
977 match &self.config.channel[..] {
978 "stable" | "beta" => false,
979 "nightly" | _ => true,
983 /// Fold the output of the commands after this method into a group. The fold
984 /// ends when the returned object is dropped. Folding can only be used in
985 /// the Travis CI environment.
986 pub fn fold_output<D, F>(&self, name: F) -> Option<OutputFolder>
987 where D: Into<String>, F: FnOnce() -> D
989 if !self.config.dry_run && self.ci_env == CiEnv::Travis {
990 Some(OutputFolder::new(name().into()))
996 /// Updates the actual toolstate of a tool.
998 /// The toolstates are saved to the file specified by the key
999 /// `rust.save-toolstates` in `config.toml`. If unspecified, nothing will be
1000 /// done. The file is updated immediately after this function completes.
1001 pub fn save_toolstate(&self, tool: &str, state: ToolState) {
1002 use std::io::{Seek, SeekFrom};
1004 if let Some(ref path) = self.config.save_toolstates {
1005 let mut file = t!(fs::OpenOptions::new()
1011 let mut current_toolstates: HashMap<Box<str>, ToolState> =
1012 serde_json::from_reader(&mut file).unwrap_or_default();
1013 current_toolstates.insert(tool.into(), state);
1014 t!(file.seek(SeekFrom::Start(0)));
1015 t!(file.set_len(0));
1016 t!(serde_json::to_writer(file, ¤t_toolstates));
1020 fn in_tree_crates(&self, root: &str) -> Vec<&Crate> {
1021 let mut ret = Vec::new();
1022 let mut list = vec![INTERNER.intern_str(root)];
1023 let mut visited = HashSet::new();
1024 while let Some(krate) = list.pop() {
1025 let krate = &self.crates[&krate];
1026 if krate.is_local(self) {
1028 for dep in &krate.deps {
1029 if visited.insert(dep) && dep != "build_helper" {
1038 fn read_stamp_file(&self, stamp: &Path) -> Vec<PathBuf> {
1039 if self.config.dry_run {
1043 let mut paths = Vec::new();
1044 let mut contents = Vec::new();
1045 t!(t!(File::open(stamp)).read_to_end(&mut contents));
1046 // This is the method we use for extracting paths from the stamp file passed to us. See
1047 // run_cargo for more information (in compile.rs).
1048 for part in contents.split(|b| *b == 0) {
1049 if part.is_empty() {
1052 let path = PathBuf::from(t!(str::from_utf8(part)));
1058 /// Copies a file from `src` to `dst`
1059 pub fn copy(&self, src: &Path, dst: &Path) {
1060 if self.config.dry_run { return; }
1061 let _ = fs::remove_file(&dst);
1062 // Attempt to "easy copy" by creating a hard link (symlinks don't work on
1063 // windows), but if that fails just fall back to a slow `copy` operation.
1064 if let Ok(()) = fs::hard_link(src, dst) {
1067 if let Err(e) = fs::copy(src, dst) {
1068 panic!("failed to copy `{}` to `{}`: {}", src.display(),
1071 let metadata = t!(src.metadata());
1072 t!(fs::set_permissions(dst, metadata.permissions()));
1073 let atime = FileTime::from_last_access_time(&metadata);
1074 let mtime = FileTime::from_last_modification_time(&metadata);
1075 t!(filetime::set_file_times(dst, atime, mtime));
1078 /// Search-and-replaces within a file. (Not maximally efficiently: allocates a
1079 /// new string for each replacement.)
1080 pub fn replace_in_file(&self, path: &Path, replacements: &[(&str, &str)]) {
1081 if self.config.dry_run { return; }
1082 let mut contents = String::new();
1083 let mut file = t!(OpenOptions::new().read(true).write(true).open(path));
1084 t!(file.read_to_string(&mut contents));
1085 for &(target, replacement) in replacements {
1086 contents = contents.replace(target, replacement);
1088 t!(file.seek(SeekFrom::Start(0)));
1089 t!(file.set_len(0));
1090 t!(file.write_all(contents.as_bytes()));
1093 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1094 /// when this function is called.
1095 pub fn cp_r(&self, src: &Path, dst: &Path) {
1096 if self.config.dry_run { return; }
1097 for f in t!(fs::read_dir(src)) {
1099 let path = f.path();
1100 let name = path.file_name().unwrap();
1101 let dst = dst.join(name);
1102 if t!(f.file_type()).is_dir() {
1103 t!(fs::create_dir_all(&dst));
1104 self.cp_r(&path, &dst);
1106 let _ = fs::remove_file(&dst);
1107 self.copy(&path, &dst);
1112 /// Copies the `src` directory recursively to `dst`. Both are assumed to exist
1113 /// when this function is called. Unwanted files or directories can be skipped
1114 /// by returning `false` from the filter function.
1115 pub fn cp_filtered(&self, src: &Path, dst: &Path, filter: &Fn(&Path) -> bool) {
1116 // Immediately recurse with an empty relative path
1117 self.recurse_(src, dst, Path::new(""), filter)
1120 // Inner function does the actual work
1121 fn recurse_(&self, src: &Path, dst: &Path, relative: &Path, filter: &Fn(&Path) -> bool) {
1122 for f in self.read_dir(src) {
1123 let path = f.path();
1124 let name = path.file_name().unwrap();
1125 let dst = dst.join(name);
1126 let relative = relative.join(name);
1127 // Only copy file or directory if the filter function returns true
1128 if filter(&relative) {
1129 if t!(f.file_type()).is_dir() {
1130 let _ = fs::remove_dir_all(&dst);
1131 self.create_dir(&dst);
1132 self.recurse_(&path, &dst, &relative, filter);
1134 let _ = fs::remove_file(&dst);
1135 self.copy(&path, &dst);
1141 fn copy_to_folder(&self, src: &Path, dest_folder: &Path) {
1142 let file_name = src.file_name().unwrap();
1143 let dest = dest_folder.join(file_name);
1144 self.copy(src, &dest);
1147 fn install(&self, src: &Path, dstdir: &Path, perms: u32) {
1148 if self.config.dry_run { return; }
1149 let dst = dstdir.join(src.file_name().unwrap());
1150 t!(fs::create_dir_all(dstdir));
1151 drop(fs::remove_file(&dst));
1153 let mut s = t!(fs::File::open(&src));
1154 let mut d = t!(fs::File::create(&dst));
1155 io::copy(&mut s, &mut d).expect("failed to copy");
1160 fn create(&self, path: &Path, s: &str) {
1161 if self.config.dry_run { return; }
1162 t!(fs::write(path, s));
1165 fn read(&self, path: &Path) -> String {
1166 if self.config.dry_run { return String::new(); }
1167 t!(fs::read_to_string(path))
1170 fn create_dir(&self, dir: &Path) {
1171 if self.config.dry_run { return; }
1172 t!(fs::create_dir_all(dir))
1175 fn remove_dir(&self, dir: &Path) {
1176 if self.config.dry_run { return; }
1177 t!(fs::remove_dir_all(dir))
1180 fn read_dir(&self, dir: &Path) -> impl Iterator<Item=fs::DirEntry> {
1181 let iter = match fs::read_dir(dir) {
1183 Err(_) if self.config.dry_run => return vec![].into_iter(),
1184 Err(err) => panic!("could not read dir {:?}: {:?}", dir, err),
1186 iter.map(|e| t!(e)).collect::<Vec<_>>().into_iter()
1189 fn remove(&self, f: &Path) {
1190 if self.config.dry_run { return; }
1191 fs::remove_file(f).unwrap_or_else(|_| panic!("failed to remove {:?}", f));
1196 fn chmod(path: &Path, perms: u32) {
1197 use std::os::unix::fs::*;
1198 t!(fs::set_permissions(path, fs::Permissions::from_mode(perms)));
1201 fn chmod(_path: &Path, _perms: u32) {}
1205 pub fn with_stage(mut self, stage: u32) -> Compiler {
1210 /// Returns whether this is a snapshot compiler for `build`'s configuration
1211 pub fn is_snapshot(&self, build: &Build) -> bool {
1212 self.stage == 0 && self.host == build.build
1215 /// Returns if this compiler should be treated as a final stage one in the
1216 /// current build session.
1217 /// This takes into account whether we're performing a full bootstrap or
1218 /// not; don't directly compare the stage with `2`!
1219 pub fn is_final_stage(&self, build: &Build) -> bool {
1220 let final_stage = if build.config.full_bootstrap { 2 } else { 1 };
1221 self.stage >= final_stage