2 use std::cell::{Cell, RefCell};
3 use std::collections::BTreeSet;
10 use std::path::{Path, PathBuf};
11 use std::process::Command;
12 use std::time::{Duration, Instant};
16 use crate::cache::{Cache, Interned, INTERNER};
21 use crate::flags::Subcommand;
26 use crate::util::{self, add_lib_path, exe, libdir};
27 use crate::{Build, DocTests, GitRepo, Mode};
29 pub use crate::Compiler;
31 pub struct Builder<'a> {
36 stack: RefCell<Vec<Box<dyn Any>>>,
37 time_spent_on_dependencies: Cell<Duration>,
38 pub paths: Vec<PathBuf>,
41 impl<'a> Deref for Builder<'a> {
44 fn deref(&self) -> &Self::Target {
49 pub trait Step: 'static + Clone + Debug + PartialEq + Eq + Hash {
50 /// `PathBuf` when directories are created or to return a `Compiler` once
51 /// it's been assembled.
54 const DEFAULT: bool = false;
56 /// If true, then this rule should be skipped if --target was specified, but --host was not
57 const ONLY_HOSTS: bool = false;
59 /// Primary function to execute this rule. Can call `builder.ensure()`
60 /// with other steps to run those.
61 fn run(self, builder: &Builder<'_>) -> Self::Output;
63 /// When bootstrap is passed a set of paths, this controls whether this rule
64 /// will execute. However, it does not get called in a "default" context
65 /// when we are not passed any paths; in that case, `make_run` is called
67 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_>;
69 /// Builds up a "root" rule, either as a default rule or from a path passed
72 /// When path is `None`, we are executing in a context where no paths were
73 /// passed. When `./x.py build` is run, for example, this rule could get
74 /// called if it is in the correct list below with a path of `None`.
75 fn make_run(_run: RunConfig<'_>) {
76 // It is reasonable to not have an implementation of make_run for rules
77 // who do not want to get called from the root context. This means that
78 // they are likely dependencies (e.g., sysroot creation) or similar, and
79 // as such calling them from ./x.py isn't logical.
84 pub struct RunConfig<'a> {
85 pub builder: &'a Builder<'a>,
86 pub host: Interned<String>,
87 pub target: Interned<String>,
91 struct StepDescription {
94 should_run: fn(ShouldRun<'_>) -> ShouldRun<'_>,
95 make_run: fn(RunConfig<'_>),
99 #[derive(Debug, Clone, PartialOrd, Ord, PartialEq, Eq)]
101 Set(BTreeSet<PathBuf>),
106 fn empty() -> PathSet {
107 PathSet::Set(BTreeSet::new())
110 fn one<P: Into<PathBuf>>(path: P) -> PathSet {
111 let mut set = BTreeSet::new();
112 set.insert(path.into());
116 fn has(&self, needle: &Path) -> bool {
118 PathSet::Set(set) => set.iter().any(|p| p.ends_with(needle)),
119 PathSet::Suite(suite) => suite.ends_with(needle),
123 fn path(&self, builder: &Builder<'_>) -> PathBuf {
125 PathSet::Set(set) => set.iter().next().unwrap_or(&builder.build.src).to_path_buf(),
126 PathSet::Suite(path) => PathBuf::from(path),
131 impl StepDescription {
132 fn from<S: Step>() -> StepDescription {
135 only_hosts: S::ONLY_HOSTS,
136 should_run: S::should_run,
137 make_run: S::make_run,
138 name: std::any::type_name::<S>(),
142 fn maybe_run(&self, builder: &Builder<'_>, pathset: &PathSet) {
143 if builder.config.exclude.iter().any(|e| pathset.has(e)) {
144 eprintln!("Skipping {:?} because it is excluded", pathset);
146 } else if !builder.config.exclude.is_empty() {
148 "{:?} not skipped for {:?} -- not in {:?}",
149 pathset, self.name, builder.config.exclude
152 let hosts = &builder.hosts;
154 // Determine the targets participating in this rule.
155 let targets = if self.only_hosts {
156 if builder.config.skip_only_host_steps {
157 return; // don't run anything
166 for target in targets {
167 let run = RunConfig {
169 path: pathset.path(builder),
173 (self.make_run)(run);
178 fn run(v: &[StepDescription], builder: &Builder<'_>, paths: &[PathBuf]) {
180 v.iter().map(|desc| (desc.should_run)(ShouldRun::new(builder))).collect::<Vec<_>>();
182 // sanity checks on rules
183 for (desc, should_run) in v.iter().zip(&should_runs) {
185 !should_run.paths.is_empty(),
186 "{:?} should have at least one pathset",
191 if paths.is_empty() {
192 for (desc, should_run) in v.iter().zip(should_runs) {
193 if desc.default && should_run.is_really_default {
194 for pathset in &should_run.paths {
195 desc.maybe_run(builder, pathset);
201 // strip CurDir prefix if present
202 let path = match path.strip_prefix(".") {
207 let mut attempted_run = false;
208 for (desc, should_run) in v.iter().zip(&should_runs) {
209 if let Some(suite) = should_run.is_suite_path(path) {
210 attempted_run = true;
211 desc.maybe_run(builder, suite);
212 } else if let Some(pathset) = should_run.pathset_for_path(path) {
213 attempted_run = true;
214 desc.maybe_run(builder, pathset);
219 panic!("Error: no rules matched {}.", path.display());
227 pub struct ShouldRun<'a> {
228 pub builder: &'a Builder<'a>,
229 // use a BTreeSet to maintain sort order
230 paths: BTreeSet<PathSet>,
232 // If this is a default rule, this is an additional constraint placed on
233 // its run. Generally something like compiler docs being enabled.
234 is_really_default: bool,
237 impl<'a> ShouldRun<'a> {
238 fn new(builder: &'a Builder<'_>) -> ShouldRun<'a> {
241 paths: BTreeSet::new(),
242 is_really_default: true, // by default no additional conditions
246 pub fn default_condition(mut self, cond: bool) -> Self {
247 self.is_really_default = cond;
251 // Unlike `krate` this will create just one pathset. As such, it probably shouldn't actually
252 // ever be used, but as we transition to having all rules properly handle passing krate(...) by
253 // actually doing something different for every crate passed.
254 pub fn all_krates(mut self, name: &str) -> Self {
255 let mut set = BTreeSet::new();
256 for krate in self.builder.in_tree_crates(name) {
257 set.insert(PathBuf::from(&krate.path));
259 self.paths.insert(PathSet::Set(set));
263 pub fn krate(mut self, name: &str) -> Self {
264 for krate in self.builder.in_tree_crates(name) {
265 self.paths.insert(PathSet::one(&krate.path));
270 // single, non-aliased path
271 pub fn path(self, path: &str) -> Self {
275 // multiple aliases for the same job
276 pub fn paths(mut self, paths: &[&str]) -> Self {
277 self.paths.insert(PathSet::Set(paths.iter().map(PathBuf::from).collect()));
281 pub fn is_suite_path(&self, path: &Path) -> Option<&PathSet> {
282 self.paths.iter().find(|pathset| match pathset {
283 PathSet::Suite(p) => path.starts_with(p),
284 PathSet::Set(_) => false,
288 pub fn suite_path(mut self, suite: &str) -> Self {
289 self.paths.insert(PathSet::Suite(PathBuf::from(suite)));
293 // allows being more explicit about why should_run in Step returns the value passed to it
294 pub fn never(mut self) -> ShouldRun<'a> {
295 self.paths.insert(PathSet::empty());
299 fn pathset_for_path(&self, path: &Path) -> Option<&PathSet> {
300 self.paths.iter().find(|pathset| pathset.has(path))
304 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
318 impl<'a> Builder<'a> {
319 fn get_step_descriptions(kind: Kind) -> Vec<StepDescription> {
320 macro_rules! describe {
321 ($($rule:ty),+ $(,)?) => {{
322 vec![$(StepDescription::from::<$rule>()),+]
326 Kind::Build => describe!(
329 compile::StartupObjects,
333 tool::UnstableBookGen,
338 tool::RemoteTestServer,
339 tool::RemoteTestClient,
351 Kind::Check | Kind::Clippy | Kind::Fix | Kind::Format => {
352 describe!(check::Std, check::Rustc, check::Rustdoc)
354 Kind::Test => describe!(
355 crate::toolstate::ToolStateCheck,
360 test::RunPassValgrind,
371 test::RunPassValgrindPretty,
381 test::RunMakeFullDeps,
395 test::CompiletestTest,
397 test::RustdocJSNotStd,
400 // Run bootstrap close to the end as it's unlikely to fail
402 // Run run-make last, since these won't pass without make on Windows
405 Kind::Bench => describe!(test::Crate, test::CrateLibrustc),
406 Kind::Doc => describe!(
408 doc::UnstableBookGen,
424 Kind::Dist => describe!(
429 dist::DebuggerScripts,
434 dist::PlainSourceTarball,
445 Kind::Install => describe!(
460 pub fn get_help(build: &Build, subcommand: &str) -> Option<String> {
461 let kind = match subcommand {
462 "build" => Kind::Build,
464 "test" => Kind::Test,
465 "bench" => Kind::Bench,
466 "dist" => Kind::Dist,
467 "install" => Kind::Install,
471 let builder = Builder {
473 top_stage: build.config.stage.unwrap_or(2),
476 stack: RefCell::new(Vec::new()),
477 time_spent_on_dependencies: Cell::new(Duration::new(0, 0)),
481 let builder = &builder;
482 let mut should_run = ShouldRun::new(builder);
483 for desc in Builder::get_step_descriptions(builder.kind) {
484 should_run = (desc.should_run)(should_run);
486 let mut help = String::from("Available paths:\n");
487 for pathset in should_run.paths {
488 if let PathSet::Set(set) = pathset {
489 set.iter().for_each(|path| {
491 format!(" ./x.py {} {}\n", subcommand, path.display()).as_str(),
499 pub fn new(build: &Build) -> Builder<'_> {
500 let (kind, paths) = match build.config.cmd {
501 Subcommand::Build { ref paths } => (Kind::Build, &paths[..]),
502 Subcommand::Check { ref paths } => (Kind::Check, &paths[..]),
503 Subcommand::Clippy { ref paths } => (Kind::Clippy, &paths[..]),
504 Subcommand::Fix { ref paths } => (Kind::Fix, &paths[..]),
505 Subcommand::Doc { ref paths } => (Kind::Doc, &paths[..]),
506 Subcommand::Test { ref paths, .. } => (Kind::Test, &paths[..]),
507 Subcommand::Bench { ref paths, .. } => (Kind::Bench, &paths[..]),
508 Subcommand::Dist { ref paths } => (Kind::Dist, &paths[..]),
509 Subcommand::Install { ref paths } => (Kind::Install, &paths[..]),
510 Subcommand::Format { .. } | Subcommand::Clean { .. } => panic!(),
515 top_stage: build.config.stage.unwrap_or(2),
518 stack: RefCell::new(Vec::new()),
519 time_spent_on_dependencies: Cell::new(Duration::new(0, 0)),
520 paths: paths.to_owned(),
524 pub fn execute_cli(&self) {
525 self.run_step_descriptions(&Builder::get_step_descriptions(self.kind), &self.paths);
528 pub fn default_doc(&self, paths: Option<&[PathBuf]>) {
529 let paths = paths.unwrap_or(&[]);
530 self.run_step_descriptions(&Builder::get_step_descriptions(Kind::Doc), paths);
533 fn run_step_descriptions(&self, v: &[StepDescription], paths: &[PathBuf]) {
534 StepDescription::run(v, self, paths);
537 /// Obtain a compiler at a given stage and for a given host. Explicitly does
538 /// not take `Compiler` since all `Compiler` instances are meant to be
539 /// obtained through this function, since it ensures that they are valid
540 /// (i.e., built and assembled).
541 pub fn compiler(&self, stage: u32, host: Interned<String>) -> Compiler {
542 self.ensure(compile::Assemble { target_compiler: Compiler { stage, host } })
545 /// Similar to `compiler`, except handles the full-bootstrap option to
546 /// silently use the stage1 compiler instead of a stage2 compiler if one is
549 /// Note that this does *not* have the side effect of creating
550 /// `compiler(stage, host)`, unlike `compiler` above which does have such
551 /// a side effect. The returned compiler here can only be used to compile
552 /// new artifacts, it can't be used to rely on the presence of a particular
555 /// See `force_use_stage1` for documentation on what each argument is.
559 host: Interned<String>,
560 target: Interned<String>,
562 if self.build.force_use_stage1(Compiler { stage, host }, target) {
563 self.compiler(1, self.config.build)
565 self.compiler(stage, host)
569 pub fn sysroot(&self, compiler: Compiler) -> Interned<PathBuf> {
570 self.ensure(compile::Sysroot { compiler })
573 /// Returns the libdir where the standard library and other artifacts are
574 /// found for a compiler's sysroot.
575 pub fn sysroot_libdir(
578 target: Interned<String>,
579 ) -> Interned<PathBuf> {
580 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
583 target: Interned<String>,
585 impl Step for Libdir {
586 type Output = Interned<PathBuf>;
588 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
592 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
593 let lib = builder.sysroot_libdir_relative(self.compiler);
594 let sysroot = builder
595 .sysroot(self.compiler)
600 let _ = fs::remove_dir_all(&sysroot);
601 t!(fs::create_dir_all(&sysroot));
602 INTERNER.intern_path(sysroot)
605 self.ensure(Libdir { compiler, target })
608 /// Returns the compiler's libdir where it stores the dynamic libraries that
609 /// it itself links against.
611 /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
613 pub fn rustc_libdir(&self, compiler: Compiler) -> PathBuf {
614 if compiler.is_snapshot(self) {
615 self.rustc_snapshot_libdir()
617 match self.config.libdir_relative() {
618 Some(relative_libdir) if compiler.stage >= 1 => {
619 self.sysroot(compiler).join(relative_libdir)
621 _ => self.sysroot(compiler).join(libdir(&compiler.host)),
626 /// Returns the compiler's relative libdir where it stores the dynamic libraries that
627 /// it itself links against.
629 /// For example this returns `lib` on Unix and `bin` on
631 pub fn libdir_relative(&self, compiler: Compiler) -> &Path {
632 if compiler.is_snapshot(self) {
633 libdir(&self.config.build).as_ref()
635 match self.config.libdir_relative() {
636 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
637 _ => libdir(&compiler.host).as_ref(),
642 /// Returns the compiler's relative libdir where the standard library and other artifacts are
643 /// found for a compiler's sysroot.
645 /// For example this returns `lib` on Unix and Windows.
646 pub fn sysroot_libdir_relative(&self, compiler: Compiler) -> &Path {
647 match self.config.libdir_relative() {
648 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
649 _ => Path::new("lib"),
653 /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
654 /// library lookup path.
655 pub fn add_rustc_lib_path(&self, compiler: Compiler, cmd: &mut Cargo) {
656 // Windows doesn't need dylib path munging because the dlls for the
657 // compiler live next to the compiler and the system will find them
663 add_lib_path(vec![self.rustc_libdir(compiler)], &mut cmd.command);
666 /// Gets a path to the compiler specified.
667 pub fn rustc(&self, compiler: Compiler) -> PathBuf {
668 if compiler.is_snapshot(self) {
669 self.initial_rustc.clone()
671 self.sysroot(compiler).join("bin").join(exe("rustc", &compiler.host))
675 pub fn rustdoc(&self, compiler: Compiler) -> PathBuf {
676 self.ensure(tool::Rustdoc { compiler })
679 pub fn rustdoc_cmd(&self, compiler: Compiler) -> Command {
680 let mut cmd = Command::new(&self.out.join("bootstrap/debug/rustdoc"));
681 cmd.env("RUSTC_STAGE", compiler.stage.to_string())
682 .env("RUSTC_SYSROOT", self.sysroot(compiler))
683 // Note that this is *not* the sysroot_libdir because rustdoc must be linked
684 // equivalently to rustc.
685 .env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler))
686 .env("CFG_RELEASE_CHANNEL", &self.config.channel)
687 .env("RUSTDOC_REAL", self.rustdoc(compiler))
688 .env("RUSTDOC_CRATE_VERSION", self.rust_version())
689 .env("RUSTC_BOOTSTRAP", "1");
691 // Remove make-related flags that can cause jobserver problems.
692 cmd.env_remove("MAKEFLAGS");
693 cmd.env_remove("MFLAGS");
695 if let Some(linker) = self.linker(compiler.host, true) {
696 cmd.env("RUSTC_TARGET_LINKER", linker);
701 /// Prepares an invocation of `cargo` to be run.
703 /// This will create a `Command` that represents a pending execution of
704 /// Cargo. This cargo will be configured to use `compiler` as the actual
705 /// rustc compiler, its output will be scoped by `mode`'s output directory,
706 /// it will pass the `--target` flag for the specified `target`, and will be
707 /// executing the Cargo command `cmd`.
712 target: Interned<String>,
715 let mut cargo = Command::new(&self.initial_cargo);
716 let out_dir = self.stage_out(compiler, mode);
718 if cmd == "doc" || cmd == "rustdoc" {
719 let my_out = match mode {
720 // This is the intended out directory for compiler documentation.
721 Mode::Rustc | Mode::ToolRustc | Mode::Codegen => self.compiler_doc_out(target),
722 _ => self.crate_doc_out(target),
724 let rustdoc = self.rustdoc(compiler);
725 self.clear_if_dirty(&my_out, &rustdoc);
728 cargo.env("CARGO_TARGET_DIR", &out_dir).arg(cmd).arg("-Zconfig-profile");
730 let profile_var = |name: &str| {
731 let profile = if self.config.rust_optimize { "RELEASE" } else { "DEV" };
732 format!("CARGO_PROFILE_{}_{}", profile, name)
735 // See comment in librustc_llvm/build.rs for why this is necessary, largely llvm-config
736 // needs to not accidentally link to libLLVM in stage0/lib.
737 cargo.env("REAL_LIBRARY_PATH_VAR", &util::dylib_path_var());
738 if let Some(e) = env::var_os(util::dylib_path_var()) {
739 cargo.env("REAL_LIBRARY_PATH", e);
742 if cmd != "install" {
743 cargo.arg("--target").arg(target);
745 assert_eq!(target, compiler.host);
748 // Set a flag for `check`/`clippy`/`fix`, so that certain build
749 // scripts can do less work (e.g. not building/requiring LLVM).
750 if cmd == "check" || cmd == "clippy" || cmd == "fix" {
751 cargo.env("RUST_CHECK", "1");
754 let stage = if compiler.stage == 0 && self.local_rebuild {
755 // Assume the local-rebuild rustc already has stage1 features.
761 let mut rustflags = Rustflags::new(&target);
763 if let Ok(s) = env::var("CARGOFLAGS_NOT_BOOTSTRAP") {
764 cargo.args(s.split_whitespace());
766 rustflags.env("RUSTFLAGS_NOT_BOOTSTRAP");
768 if let Ok(s) = env::var("CARGOFLAGS_BOOTSTRAP") {
769 cargo.args(s.split_whitespace());
771 rustflags.env("RUSTFLAGS_BOOTSTRAP");
772 rustflags.arg("--cfg=bootstrap");
775 if let Ok(s) = env::var("CARGOFLAGS") {
776 cargo.args(s.split_whitespace());
780 Mode::Std | Mode::ToolBootstrap | Mode::ToolStd => {}
781 Mode::Rustc | Mode::Codegen | Mode::ToolRustc => {
782 // Build proc macros both for the host and the target
783 if target != compiler.host && cmd != "check" {
784 cargo.arg("-Zdual-proc-macros");
785 rustflags.arg("-Zdual-proc-macros");
790 // This tells Cargo (and in turn, rustc) to output more complete
791 // dependency information. Most importantly for rustbuild, this
792 // includes sysroot artifacts, like libstd, which means that we don't
793 // need to track those in rustbuild (an error prone process!). This
794 // feature is currently unstable as there may be some bugs and such, but
795 // it represents a big improvement in rustbuild's reliability on
796 // rebuilds, so we're using it here.
798 // For some additional context, see #63470 (the PR originally adding
799 // this), as well as #63012 which is the tracking issue for this
800 // feature on the rustc side.
801 cargo.arg("-Zbinary-dep-depinfo");
803 cargo.arg("-j").arg(self.jobs().to_string());
804 // Remove make-related flags to ensure Cargo can correctly set things up
805 cargo.env_remove("MAKEFLAGS");
806 cargo.env_remove("MFLAGS");
808 // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
809 // Force cargo to output binaries with disambiguating hashes in the name
810 let mut metadata = if compiler.stage == 0 {
811 // Treat stage0 like a special channel, whether it's a normal prior-
812 // release rustc or a local rebuild with the same version, so we
813 // never mix these libraries by accident.
814 "bootstrap".to_string()
816 self.config.channel.to_string()
818 // We want to make sure that none of the dependencies between
819 // std/test/rustc unify with one another. This is done for weird linkage
820 // reasons but the gist of the problem is that if librustc, libtest, and
821 // libstd all depend on libc from crates.io (which they actually do) we
822 // want to make sure they all get distinct versions. Things get really
823 // weird if we try to unify all these dependencies right now, namely
824 // around how many times the library is linked in dynamic libraries and
825 // such. If rustc were a static executable or if we didn't ship dylibs
826 // this wouldn't be a problem, but we do, so it is. This is in general
827 // just here to make sure things build right. If you can remove this and
828 // things still build right, please do!
830 Mode::Std => metadata.push_str("std"),
831 // When we're building rustc tools, they're built with a search path
832 // that contains things built during the rustc build. For example,
833 // bitflags is built during the rustc build, and is a dependency of
834 // rustdoc as well. We're building rustdoc in a different target
835 // directory, though, which means that Cargo will rebuild the
836 // dependency. When we go on to build rustdoc, we'll look for
837 // bitflags, and find two different copies: one built during the
838 // rustc step and one that we just built. This isn't always a
839 // problem, somehow -- not really clear why -- but we know that this
841 Mode::ToolRustc => metadata.push_str("tool-rustc"),
844 cargo.env("__CARGO_DEFAULT_LIB_METADATA", &metadata);
847 rustflags.arg("-Zforce-unstable-if-unmarked");
850 // cfg(bootstrap): the flag was renamed from `-Zexternal-macro-backtrace`
851 // to `-Zmacro-backtrace`, keep only the latter after beta promotion.
853 rustflags.arg("-Zexternal-macro-backtrace");
855 rustflags.arg("-Zmacro-backtrace");
858 let want_rustdoc = self.doc_tests != DocTests::No;
860 // We synthetically interpret a stage0 compiler used to build tools as a
861 // "raw" compiler in that it's the exact snapshot we download. Normally
862 // the stage0 build means it uses libraries build by the stage0
863 // compiler, but for tools we just use the precompiled libraries that
865 let use_snapshot = mode == Mode::ToolBootstrap;
866 assert!(!use_snapshot || stage == 0 || self.local_rebuild);
868 let maybe_sysroot = self.sysroot(compiler);
869 let sysroot = if use_snapshot { self.rustc_snapshot_sysroot() } else { &maybe_sysroot };
870 let libdir = self.rustc_libdir(compiler);
872 // Clear the output directory if the real rustc we're using has changed;
873 // Cargo cannot detect this as it thinks rustc is bootstrap/debug/rustc.
875 // Avoid doing this during dry run as that usually means the relevant
876 // compiler is not yet linked/copied properly.
878 // Only clear out the directory if we're compiling std; otherwise, we
879 // should let Cargo take care of things for us (via depdep info)
880 if !self.config.dry_run && mode == Mode::Std && cmd == "build" {
881 self.clear_if_dirty(&out_dir, &self.rustc(compiler));
884 // Customize the compiler we're running. Specify the compiler to cargo
885 // as our shim and then pass it some various options used to configure
886 // how the actual compiler itself is called.
888 // These variables are primarily all read by
889 // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
891 .env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
892 .env("RUSTC", self.out.join("bootstrap/debug/rustc"))
893 .env("RUSTC_REAL", self.rustc(compiler))
894 .env("RUSTC_STAGE", stage.to_string())
895 .env("RUSTC_DEBUG_ASSERTIONS", self.config.rust_debug_assertions.to_string())
896 .env("RUSTC_SYSROOT", &sysroot)
897 .env("RUSTC_LIBDIR", &libdir)
898 .env("RUSTDOC", self.out.join("bootstrap/debug/rustdoc"))
901 if cmd == "doc" || cmd == "rustdoc" || (cmd == "test" && want_rustdoc) {
902 self.rustdoc(compiler)
904 PathBuf::from("/path/to/nowhere/rustdoc/not/required")
907 .env("RUSTC_ERROR_METADATA_DST", self.extended_error_dir())
908 .env("RUSTC_BREAK_ON_ICE", "1");
910 // Dealing with rpath here is a little special, so let's go into some
911 // detail. First off, `-rpath` is a linker option on Unix platforms
912 // which adds to the runtime dynamic loader path when looking for
913 // dynamic libraries. We use this by default on Unix platforms to ensure
914 // that our nightlies behave the same on Windows, that is they work out
915 // of the box. This can be disabled, of course, but basically that's why
916 // we're gated on RUSTC_RPATH here.
918 // Ok, so the astute might be wondering "why isn't `-C rpath` used
919 // here?" and that is indeed a good question to task. This codegen
920 // option is the compiler's current interface to generating an rpath.
921 // Unfortunately it doesn't quite suffice for us. The flag currently
922 // takes no value as an argument, so the compiler calculates what it
923 // should pass to the linker as `-rpath`. This unfortunately is based on
924 // the **compile time** directory structure which when building with
925 // Cargo will be very different than the runtime directory structure.
927 // All that's a really long winded way of saying that if we use
928 // `-Crpath` then the executables generated have the wrong rpath of
929 // something like `$ORIGIN/deps` when in fact the way we distribute
930 // rustc requires the rpath to be `$ORIGIN/../lib`.
932 // So, all in all, to set up the correct rpath we pass the linker
933 // argument manually via `-C link-args=-Wl,-rpath,...`. Plus isn't it
934 // fun to pass a flag to a tool to pass a flag to pass a flag to a tool
935 // to change a flag in a binary?
936 if self.config.rust_rpath && util::use_host_linker(&target) {
937 let rpath = if target.contains("apple") {
938 // Note that we need to take one extra step on macOS to also pass
939 // `-Wl,-instal_name,@rpath/...` to get things to work right. To
940 // do that we pass a weird flag to the compiler to get it to do
941 // so. Note that this is definitely a hack, and we should likely
942 // flesh out rpath support more fully in the future.
943 rustflags.arg("-Zosx-rpath-install-name");
944 Some("-Wl,-rpath,@loader_path/../lib")
945 } else if !target.contains("windows") {
946 Some("-Wl,-rpath,$ORIGIN/../lib")
950 if let Some(rpath) = rpath {
951 rustflags.arg(&format!("-Clink-args={}", rpath));
955 // FIXME: Don't use LLD if we're compiling libtest, since it fails to link it.
956 // See https://github.com/rust-lang/rust/issues/68647.
957 let can_use_lld = mode != Mode::Std;
959 // FIXME: The beta compiler doesn't pick the `lld-link` flavor for `*-pc-windows-msvc`
960 // Remove `RUSTC_HOST_LINKER_FLAVOR` when this is fixed
961 let lld_linker_flavor = |linker: &Path, target: Interned<String>| {
963 && linker.file_name() == Some(OsStr::new("rust-lld"))
964 && target.contains("pc-windows-msvc")
967 if let Some(host_linker) = self.linker(compiler.host, can_use_lld) {
968 if lld_linker_flavor(host_linker, compiler.host) {
969 cargo.env("RUSTC_HOST_LINKER_FLAVOR", "lld-link");
972 cargo.env("RUSTC_HOST_LINKER", host_linker);
975 if let Some(target_linker) = self.linker(target, can_use_lld) {
976 if lld_linker_flavor(target_linker, target) {
977 rustflags.arg("-Clinker-flavor=lld-link");
980 let target = crate::envify(&target);
981 cargo.env(&format!("CARGO_TARGET_{}_LINKER", target), target_linker);
983 if !(["build", "check", "clippy", "fix", "rustc"].contains(&cmd)) && want_rustdoc {
984 cargo.env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler));
987 let debuginfo_level = match mode {
988 Mode::Rustc | Mode::Codegen => self.config.rust_debuginfo_level_rustc,
989 Mode::Std => self.config.rust_debuginfo_level_std,
990 Mode::ToolBootstrap | Mode::ToolStd | Mode::ToolRustc => {
991 self.config.rust_debuginfo_level_tools
994 cargo.env(profile_var("DEBUG"), debuginfo_level.to_string());
997 cargo.env("RUSTC_FORCE_UNSTABLE", "1");
1000 if let Some(x) = self.crt_static(target) {
1002 rustflags.arg("-Ctarget-feature=+crt-static");
1004 rustflags.arg("-Ctarget-feature=-crt-static");
1008 if let Some(x) = self.crt_static(compiler.host) {
1009 cargo.env("RUSTC_HOST_CRT_STATIC", x.to_string());
1012 if let Some(map) = self.build.debuginfo_map(GitRepo::Rustc) {
1013 cargo.env("RUSTC_DEBUGINFO_MAP", map);
1016 // Enable usage of unstable features
1017 cargo.env("RUSTC_BOOTSTRAP", "1");
1018 self.add_rust_test_threads(&mut cargo);
1020 // Almost all of the crates that we compile as part of the bootstrap may
1021 // have a build script, including the standard library. To compile a
1022 // build script, however, it itself needs a standard library! This
1023 // introduces a bit of a pickle when we're compiling the standard
1026 // To work around this we actually end up using the snapshot compiler
1027 // (stage0) for compiling build scripts of the standard library itself.
1028 // The stage0 compiler is guaranteed to have a libstd available for use.
1030 // For other crates, however, we know that we've already got a standard
1031 // library up and running, so we can use the normal compiler to compile
1032 // build scripts in that situation.
1033 if mode == Mode::Std {
1035 .env("RUSTC_SNAPSHOT", &self.initial_rustc)
1036 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
1039 .env("RUSTC_SNAPSHOT", self.rustc(compiler))
1040 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
1043 if self.config.incremental {
1044 cargo.env("CARGO_INCREMENTAL", "1");
1046 // Don't rely on any default setting for incr. comp. in Cargo
1047 cargo.env("CARGO_INCREMENTAL", "0");
1050 if let Some(ref on_fail) = self.config.on_fail {
1051 cargo.env("RUSTC_ON_FAIL", on_fail);
1054 if self.config.print_step_timings {
1055 cargo.env("RUSTC_PRINT_STEP_TIMINGS", "1");
1058 if self.config.backtrace_on_ice {
1059 cargo.env("RUSTC_BACKTRACE_ON_ICE", "1");
1062 cargo.env("RUSTC_VERBOSE", self.verbosity.to_string());
1064 if !mode.is_tool() {
1065 // When extending this list, add the new lints to the RUSTFLAGS of the
1066 // build_bootstrap function of src/bootstrap/bootstrap.py as well as
1067 // some code doesn't go through this `rustc` wrapper.
1068 rustflags.arg("-Wrust_2018_idioms");
1069 rustflags.arg("-Wunused_lifetimes");
1071 if self.config.deny_warnings {
1072 rustflags.arg("-Dwarnings");
1076 if let Mode::Rustc | Mode::Codegen = mode {
1077 rustflags.arg("-Zunstable-options");
1078 rustflags.arg("-Wrustc::internal");
1081 // Throughout the build Cargo can execute a number of build scripts
1082 // compiling C/C++ code and we need to pass compilers, archivers, flags, etc
1083 // obtained previously to those build scripts.
1084 // Build scripts use either the `cc` crate or `configure/make` so we pass
1085 // the options through environment variables that are fetched and understood by both.
1087 // FIXME: the guard against msvc shouldn't need to be here
1088 if target.contains("msvc") {
1089 if let Some(ref cl) = self.config.llvm_clang_cl {
1090 cargo.env("CC", cl).env("CXX", cl);
1093 let ccache = self.config.ccache.as_ref();
1094 let ccacheify = |s: &Path| {
1095 let ccache = match ccache {
1097 None => return s.display().to_string(),
1099 // FIXME: the cc-rs crate only recognizes the literal strings
1100 // `ccache` and `sccache` when doing caching compilations, so we
1101 // mirror that here. It should probably be fixed upstream to
1102 // accept a new env var or otherwise work with custom ccache
1105 "ccache" | "sccache" => format!("{} {}", ccache, s.display()),
1106 _ => s.display().to_string(),
1109 let cc = ccacheify(&self.cc(target));
1110 cargo.env(format!("CC_{}", target), &cc);
1112 let cflags = self.cflags(target, GitRepo::Rustc).join(" ");
1113 cargo.env(format!("CFLAGS_{}", target), cflags.clone());
1115 if let Some(ar) = self.ar(target) {
1116 let ranlib = format!("{} s", ar.display());
1117 cargo.env(format!("AR_{}", target), ar).env(format!("RANLIB_{}", target), ranlib);
1120 if let Ok(cxx) = self.cxx(target) {
1121 let cxx = ccacheify(&cxx);
1123 .env(format!("CXX_{}", target), &cxx)
1124 .env(format!("CXXFLAGS_{}", target), cflags);
1128 if mode == Mode::Std && self.config.extended && compiler.is_final_stage(self) {
1129 rustflags.arg("-Zsave-analysis");
1131 "RUST_SAVE_ANALYSIS_CONFIG",
1132 "{\"output_file\": null,\"full_docs\": false,\
1133 \"pub_only\": true,\"reachable_only\": false,\
1134 \"distro_crate\": true,\"signatures\": false,\"borrow_data\": false}",
1138 // If Control Flow Guard is enabled, pass the `control_flow_guard=checks` flag to rustc
1139 // when compiling the standard library, since this might be linked into the final outputs
1140 // produced by rustc. Since this mitigation is only available on Windows, only enable it
1141 // for the standard library in case the compiler is run on a non-Windows platform.
1142 // This is not needed for stage 0 artifacts because these will only be used for building
1143 // the stage 1 compiler.
1145 && mode == Mode::Std
1146 && self.config.control_flow_guard
1147 && compiler.stage >= 1
1149 rustflags.arg("-Zcontrol_flow_guard=checks");
1152 // For `cargo doc` invocations, make rustdoc print the Rust version into the docs
1153 cargo.env("RUSTDOC_CRATE_VERSION", self.rust_version());
1155 // Environment variables *required* throughout the build
1157 // FIXME: should update code to not require this env var
1158 cargo.env("CFG_COMPILER_HOST_TRIPLE", target);
1160 // Set this for all builds to make sure doc builds also get it.
1161 cargo.env("CFG_RELEASE_CHANNEL", &self.config.channel);
1163 // This one's a bit tricky. As of the time of this writing the compiler
1164 // links to the `winapi` crate on crates.io. This crate provides raw
1165 // bindings to Windows system functions, sort of like libc does for
1166 // Unix. This crate also, however, provides "import libraries" for the
1167 // MinGW targets. There's an import library per dll in the windows
1168 // distribution which is what's linked to. These custom import libraries
1169 // are used because the winapi crate can reference Windows functions not
1170 // present in the MinGW import libraries.
1172 // For example MinGW may ship libdbghelp.a, but it may not have
1173 // references to all the functions in the dbghelp dll. Instead the
1174 // custom import library for dbghelp in the winapi crates has all this
1177 // Unfortunately for us though the import libraries are linked by
1178 // default via `-ldylib=winapi_foo`. That is, they're linked with the
1179 // `dylib` type with a `winapi_` prefix (so the winapi ones don't
1180 // conflict with the system MinGW ones). This consequently means that
1181 // the binaries we ship of things like rustc_codegen_llvm (aka the rustc_codegen_llvm
1182 // DLL) when linked against *again*, for example with procedural macros
1183 // or plugins, will trigger the propagation logic of `-ldylib`, passing
1184 // `-lwinapi_foo` to the linker again. This isn't actually available in
1185 // our distribution, however, so the link fails.
1187 // To solve this problem we tell winapi to not use its bundled import
1188 // libraries. This means that it will link to the system MinGW import
1189 // libraries by default, and the `-ldylib=foo` directives will still get
1190 // passed to the final linker, but they'll look like `-lfoo` which can
1191 // be resolved because MinGW has the import library. The downside is we
1192 // don't get newer functions from Windows, but we don't use any of them
1194 if !mode.is_tool() {
1195 cargo.env("WINAPI_NO_BUNDLED_LIBRARIES", "1");
1198 for _ in 1..self.verbosity {
1202 match (mode, self.config.rust_codegen_units_std, self.config.rust_codegen_units) {
1203 (Mode::Std, Some(n), _) | (_, _, Some(n)) => {
1204 cargo.env(profile_var("CODEGEN_UNITS"), n.to_string());
1207 // Don't set anything
1211 if self.config.rust_optimize {
1212 // FIXME: cargo bench/install do not accept `--release`
1213 if cmd != "bench" && cmd != "install" {
1214 cargo.arg("--release");
1218 if self.config.locked_deps {
1219 cargo.arg("--locked");
1221 if self.config.vendor || self.is_sudo {
1222 cargo.arg("--frozen");
1225 // Try to use a sysroot-relative bindir, in case it was configured absolutely.
1226 cargo.env("RUSTC_INSTALL_BINDIR", self.config.bindir_relative());
1228 self.ci_env.force_coloring_in_ci(&mut cargo);
1230 // When we build Rust dylibs they're all intended for intermediate
1231 // usage, so make sure we pass the -Cprefer-dynamic flag instead of
1232 // linking all deps statically into the dylib.
1233 if let Mode::Std | Mode::Rustc | Mode::Codegen = mode {
1234 rustflags.arg("-Cprefer-dynamic");
1237 // When building incrementally we default to a lower ThinLTO import limit
1238 // (unless explicitly specified otherwise). This will produce a somewhat
1239 // slower code but give way better compile times.
1241 let limit = match self.config.rust_thin_lto_import_instr_limit {
1242 Some(limit) => Some(limit),
1243 None if self.config.incremental => Some(10),
1247 if let Some(limit) = limit {
1248 rustflags.arg(&format!("-Cllvm-args=-import-instr-limit={}", limit));
1252 Cargo { command: cargo, rustflags }
1255 /// Ensure that a given step is built, returning its output. This will
1256 /// cache the step, so it is safe (and good!) to call this as often as
1257 /// needed to ensure that all dependencies are built.
1258 pub fn ensure<S: Step>(&'a self, step: S) -> S::Output {
1260 let mut stack = self.stack.borrow_mut();
1261 for stack_step in stack.iter() {
1263 if stack_step.downcast_ref::<S>().map_or(true, |stack_step| *stack_step != step) {
1266 let mut out = String::new();
1267 out += &format!("\n\nCycle in build detected when adding {:?}\n", step);
1268 for el in stack.iter().rev() {
1269 out += &format!("\t{:?}\n", el);
1273 if let Some(out) = self.cache.get(&step) {
1274 self.verbose(&format!("{}c {:?}", " ".repeat(stack.len()), step));
1278 self.verbose(&format!("{}> {:?}", " ".repeat(stack.len()), step));
1279 stack.push(Box::new(step.clone()));
1283 let start = Instant::now();
1284 let zero = Duration::new(0, 0);
1285 let parent = self.time_spent_on_dependencies.replace(zero);
1286 let out = step.clone().run(self);
1287 let dur = start.elapsed();
1288 let deps = self.time_spent_on_dependencies.replace(parent + dur);
1292 if self.config.print_step_timings && dur > Duration::from_millis(100) {
1293 println!("[TIMING] {:?} -- {}.{:03}", step, dur.as_secs(), dur.subsec_millis());
1297 let mut stack = self.stack.borrow_mut();
1298 let cur_step = stack.pop().expect("step stack empty");
1299 assert_eq!(cur_step.downcast_ref(), Some(&step));
1301 self.verbose(&format!("{}< {:?}", " ".repeat(self.stack.borrow().len()), step));
1302 self.cache.put(step, out.clone());
1311 struct Rustflags(String);
1314 fn new(target: &str) -> Rustflags {
1315 let mut ret = Rustflags(String::new());
1317 // Inherit `RUSTFLAGS` by default ...
1318 ret.env("RUSTFLAGS");
1320 // ... and also handle target-specific env RUSTFLAGS if they're
1322 let target_specific = format!("CARGO_TARGET_{}_RUSTFLAGS", crate::envify(target));
1323 ret.env(&target_specific);
1328 fn env(&mut self, env: &str) {
1329 if let Ok(s) = env::var(env) {
1330 for part in s.split_whitespace() {
1336 fn arg(&mut self, arg: &str) -> &mut Self {
1337 assert_eq!(arg.split_whitespace().count(), 1);
1338 if !self.0.is_empty() {
1339 self.0.push_str(" ");
1341 self.0.push_str(arg);
1349 rustflags: Rustflags,
1353 pub fn rustflag(&mut self, arg: &str) -> &mut Cargo {
1354 self.rustflags.arg(arg);
1358 pub fn arg(&mut self, arg: impl AsRef<OsStr>) -> &mut Cargo {
1359 self.command.arg(arg.as_ref());
1363 pub fn args<I, S>(&mut self, args: I) -> &mut Cargo
1365 I: IntoIterator<Item = S>,
1369 self.arg(arg.as_ref());
1374 pub fn env(&mut self, key: impl AsRef<OsStr>, value: impl AsRef<OsStr>) -> &mut Cargo {
1375 self.command.env(key.as_ref(), value.as_ref());
1380 impl From<Cargo> for Command {
1381 fn from(mut cargo: Cargo) -> Command {
1382 cargo.command.env("RUSTFLAGS", &cargo.rustflags.0);