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};
14 use build_helper::{output, t};
16 use crate::cache::{Cache, Interned, INTERNER};
19 use crate::config::TargetSelection;
22 use crate::flags::Subcommand;
27 use crate::tool::{self, SourceType};
28 use crate::util::{self, add_dylib_path, add_link_lib_path, exe, libdir};
29 use crate::{Build, DocTests, GitRepo, Mode};
31 pub use crate::Compiler;
33 pub struct Builder<'a> {
38 stack: RefCell<Vec<Box<dyn Any>>>,
39 time_spent_on_dependencies: Cell<Duration>,
40 pub paths: Vec<PathBuf>,
43 impl<'a> Deref for Builder<'a> {
46 fn deref(&self) -> &Self::Target {
51 pub trait Step: 'static + Clone + Debug + PartialEq + Eq + Hash {
52 /// `PathBuf` when directories are created or to return a `Compiler` once
53 /// it's been assembled.
56 /// Whether this step is run by default as part of its respective phase.
57 /// `true` here can still be overwritten by `should_run` calling `default_condition`.
58 const DEFAULT: bool = false;
60 /// If true, then this rule should be skipped if --target was specified, but --host was not
61 const ONLY_HOSTS: bool = false;
63 /// Primary function to execute this rule. Can call `builder.ensure()`
64 /// with other steps to run those.
65 fn run(self, builder: &Builder<'_>) -> Self::Output;
67 /// When bootstrap is passed a set of paths, this controls whether this rule
68 /// will execute. However, it does not get called in a "default" context
69 /// when we are not passed any paths; in that case, `make_run` is called
71 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_>;
73 /// Builds up a "root" rule, either as a default rule or from a path passed
76 /// When path is `None`, we are executing in a context where no paths were
77 /// passed. When `./x.py build` is run, for example, this rule could get
78 /// called if it is in the correct list below with a path of `None`.
79 fn make_run(_run: RunConfig<'_>) {
80 // It is reasonable to not have an implementation of make_run for rules
81 // who do not want to get called from the root context. This means that
82 // they are likely dependencies (e.g., sysroot creation) or similar, and
83 // as such calling them from ./x.py isn't logical.
88 pub struct RunConfig<'a> {
89 pub builder: &'a Builder<'a>,
90 pub target: TargetSelection,
95 pub fn build_triple(&self) -> TargetSelection {
96 self.builder.build.build
100 struct StepDescription {
103 should_run: fn(ShouldRun<'_>) -> ShouldRun<'_>,
104 make_run: fn(RunConfig<'_>),
108 /// Collection of paths used to match a task rule.
109 #[derive(Debug, Clone, PartialOrd, Ord, PartialEq, Eq)]
111 /// A collection of individual paths.
113 /// These are generally matched as a path suffix. For example, a
114 /// command-line value of `libstd` will match if `src/libstd` is in the
116 Set(BTreeSet<PathBuf>),
117 /// A "suite" of paths.
119 /// These can match as a path suffix (like `Set`), or as a prefix. For
120 /// example, a command-line value of `src/test/ui/abi/variadic-ffi.rs`
121 /// will match `src/test/ui`. A command-line value of `ui` would also
122 /// match `src/test/ui`.
127 fn empty() -> PathSet {
128 PathSet::Set(BTreeSet::new())
131 fn one<P: Into<PathBuf>>(path: P) -> PathSet {
132 let mut set = BTreeSet::new();
133 set.insert(path.into());
137 fn has(&self, needle: &Path) -> bool {
139 PathSet::Set(set) => set.iter().any(|p| p.ends_with(needle)),
140 PathSet::Suite(suite) => suite.ends_with(needle),
144 fn path(&self, builder: &Builder<'_>) -> PathBuf {
146 PathSet::Set(set) => set.iter().next().unwrap_or(&builder.build.src).to_path_buf(),
147 PathSet::Suite(path) => PathBuf::from(path),
152 impl StepDescription {
153 fn from<S: Step>() -> StepDescription {
156 only_hosts: S::ONLY_HOSTS,
157 should_run: S::should_run,
158 make_run: S::make_run,
159 name: std::any::type_name::<S>(),
163 fn maybe_run(&self, builder: &Builder<'_>, pathset: &PathSet) {
164 if builder.config.exclude.iter().any(|e| pathset.has(e)) {
165 eprintln!("Skipping {:?} because it is excluded", pathset);
167 } else if !builder.config.exclude.is_empty() {
169 "{:?} not skipped for {:?} -- not in {:?}",
170 pathset, self.name, builder.config.exclude
174 // Determine the targets participating in this rule.
175 let targets = if self.only_hosts { &builder.hosts } else { &builder.targets };
177 for target in targets {
178 let run = RunConfig { builder, path: pathset.path(builder), target: *target };
179 (self.make_run)(run);
183 fn run(v: &[StepDescription], builder: &Builder<'_>, paths: &[PathBuf]) {
185 v.iter().map(|desc| (desc.should_run)(ShouldRun::new(builder))).collect::<Vec<_>>();
187 // sanity checks on rules
188 for (desc, should_run) in v.iter().zip(&should_runs) {
190 !should_run.paths.is_empty(),
191 "{:?} should have at least one pathset",
196 if paths.is_empty() || builder.config.include_default_paths {
197 for (desc, should_run) in v.iter().zip(&should_runs) {
198 if desc.default && should_run.is_really_default {
199 for pathset in &should_run.paths {
200 desc.maybe_run(builder, pathset);
207 // strip CurDir prefix if present
208 let path = match path.strip_prefix(".") {
213 let mut attempted_run = false;
214 for (desc, should_run) in v.iter().zip(&should_runs) {
215 if let Some(suite) = should_run.is_suite_path(path) {
216 attempted_run = true;
217 desc.maybe_run(builder, suite);
218 } else if let Some(pathset) = should_run.pathset_for_path(path) {
219 attempted_run = true;
220 desc.maybe_run(builder, pathset);
225 panic!("error: no rules matched {}", path.display());
232 pub struct ShouldRun<'a> {
233 pub builder: &'a Builder<'a>,
234 // use a BTreeSet to maintain sort order
235 paths: BTreeSet<PathSet>,
237 // If this is a default rule, this is an additional constraint placed on
238 // its run. Generally something like compiler docs being enabled.
239 is_really_default: bool,
242 impl<'a> ShouldRun<'a> {
243 fn new(builder: &'a Builder<'_>) -> ShouldRun<'a> {
246 paths: BTreeSet::new(),
247 is_really_default: true, // by default no additional conditions
251 pub fn default_condition(mut self, cond: bool) -> Self {
252 self.is_really_default = cond;
256 /// Indicates it should run if the command-line selects the given crate or
257 /// any of its (local) dependencies.
259 /// Compared to `krate`, this treats the dependencies as aliases for the
260 /// same job. Generally it is preferred to use `krate`, and treat each
261 /// individual path separately. For example `./x.py test src/liballoc`
262 /// (which uses `krate`) will test just `liballoc`. However, `./x.py check
263 /// src/liballoc` (which uses `all_krates`) will check all of `libtest`.
264 /// `all_krates` should probably be removed at some point.
265 pub fn all_krates(mut self, name: &str) -> Self {
266 let mut set = BTreeSet::new();
267 for krate in self.builder.in_tree_crates(name) {
268 let path = krate.local_path(self.builder);
271 self.paths.insert(PathSet::Set(set));
275 /// Indicates it should run if the command-line selects the given crate or
276 /// any of its (local) dependencies.
278 /// `make_run` will be called separately for each matching command-line path.
279 pub fn krate(mut self, name: &str) -> Self {
280 for krate in self.builder.in_tree_crates(name) {
281 let path = krate.local_path(self.builder);
282 self.paths.insert(PathSet::one(path));
287 // single, non-aliased path
288 pub fn path(self, path: &str) -> Self {
292 // multiple aliases for the same job
293 pub fn paths(mut self, paths: &[&str]) -> Self {
294 self.paths.insert(PathSet::Set(paths.iter().map(PathBuf::from).collect()));
298 pub fn is_suite_path(&self, path: &Path) -> Option<&PathSet> {
299 self.paths.iter().find(|pathset| match pathset {
300 PathSet::Suite(p) => path.starts_with(p),
301 PathSet::Set(_) => false,
305 pub fn suite_path(mut self, suite: &str) -> Self {
306 self.paths.insert(PathSet::Suite(PathBuf::from(suite)));
310 // allows being more explicit about why should_run in Step returns the value passed to it
311 pub fn never(mut self) -> ShouldRun<'a> {
312 self.paths.insert(PathSet::empty());
316 fn pathset_for_path(&self, path: &Path) -> Option<&PathSet> {
317 self.paths.iter().find(|pathset| pathset.has(path))
321 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
336 impl<'a> Builder<'a> {
337 fn get_step_descriptions(kind: Kind) -> Vec<StepDescription> {
338 macro_rules! describe {
339 ($($rule:ty),+ $(,)?) => {{
340 vec![$(StepDescription::from::<$rule>()),+]
344 Kind::Build => describe!(
347 compile::CodegenBackend,
348 compile::StartupObjects,
352 tool::UnstableBookGen,
357 tool::RemoteTestServer,
358 tool::RemoteTestClient,
374 Kind::Check | Kind::Clippy | Kind::Fix | Kind::Format => describe!(
378 check::CodegenBackend,
382 Kind::Test => describe!(
383 crate::toolstate::ToolStateCheck,
384 test::ExpandYamlAnchors,
388 test::RunPassValgrind,
408 test::RunMakeFullDeps,
422 test::CompiletestTest,
424 test::RustdocJSNotStd,
427 // Run bootstrap close to the end as it's unlikely to fail
429 // Run run-make last, since these won't pass without make on Windows
432 Kind::Bench => describe!(test::Crate, test::CrateLibrustc),
433 Kind::Doc => describe!(
435 doc::UnstableBookGen,
451 Kind::Dist => describe!(
456 dist::DebuggerScripts,
461 dist::PlainSourceTarball,
474 Kind::Install => describe!(
479 install::RustAnalyzer,
487 Kind::Run => describe!(run::ExpandYamlAnchors, run::BuildManifest),
491 pub fn get_help(build: &Build, subcommand: &str) -> Option<String> {
492 let kind = match subcommand {
493 "build" => Kind::Build,
495 "test" => Kind::Test,
496 "bench" => Kind::Bench,
497 "dist" => Kind::Dist,
498 "install" => Kind::Install,
502 let builder = Self::new_internal(build, kind, vec![]);
503 let builder = &builder;
504 let mut should_run = ShouldRun::new(builder);
505 for desc in Builder::get_step_descriptions(builder.kind) {
506 should_run = (desc.should_run)(should_run);
508 let mut help = String::from("Available paths:\n");
509 let mut add_path = |path: &Path| {
510 help.push_str(&format!(" ./x.py {} {}\n", subcommand, path.display()));
512 for pathset in should_run.paths {
514 PathSet::Set(set) => {
519 PathSet::Suite(path) => {
520 add_path(&path.join("..."));
527 fn new_internal(build: &Build, kind: Kind, paths: Vec<PathBuf>) -> Builder<'_> {
530 top_stage: build.config.stage,
533 stack: RefCell::new(Vec::new()),
534 time_spent_on_dependencies: Cell::new(Duration::new(0, 0)),
539 pub fn new(build: &Build) -> Builder<'_> {
540 let (kind, paths) = match build.config.cmd {
541 Subcommand::Build { ref paths } => (Kind::Build, &paths[..]),
542 Subcommand::Check { ref paths, all_targets: _ } => (Kind::Check, &paths[..]),
543 Subcommand::Clippy { ref paths } => (Kind::Clippy, &paths[..]),
544 Subcommand::Fix { ref paths } => (Kind::Fix, &paths[..]),
545 Subcommand::Doc { ref paths, .. } => (Kind::Doc, &paths[..]),
546 Subcommand::Test { ref paths, .. } => (Kind::Test, &paths[..]),
547 Subcommand::Bench { ref paths, .. } => (Kind::Bench, &paths[..]),
548 Subcommand::Dist { ref paths } => (Kind::Dist, &paths[..]),
549 Subcommand::Install { ref paths } => (Kind::Install, &paths[..]),
550 Subcommand::Run { ref paths } => (Kind::Run, &paths[..]),
551 Subcommand::Format { .. } | Subcommand::Clean { .. } | Subcommand::Setup { .. } => {
556 Self::new_internal(build, kind, paths.to_owned())
559 pub fn execute_cli(&self) {
560 self.run_step_descriptions(&Builder::get_step_descriptions(self.kind), &self.paths);
563 pub fn default_doc(&self, paths: Option<&[PathBuf]>) {
564 let paths = paths.unwrap_or(&[]);
565 self.run_step_descriptions(&Builder::get_step_descriptions(Kind::Doc), paths);
568 fn run_step_descriptions(&self, v: &[StepDescription], paths: &[PathBuf]) {
569 StepDescription::run(v, self, paths);
572 /// Obtain a compiler at a given stage and for a given host. Explicitly does
573 /// not take `Compiler` since all `Compiler` instances are meant to be
574 /// obtained through this function, since it ensures that they are valid
575 /// (i.e., built and assembled).
576 pub fn compiler(&self, stage: u32, host: TargetSelection) -> Compiler {
577 self.ensure(compile::Assemble { target_compiler: Compiler { stage, host } })
580 /// Similar to `compiler`, except handles the full-bootstrap option to
581 /// silently use the stage1 compiler instead of a stage2 compiler if one is
584 /// Note that this does *not* have the side effect of creating
585 /// `compiler(stage, host)`, unlike `compiler` above which does have such
586 /// a side effect. The returned compiler here can only be used to compile
587 /// new artifacts, it can't be used to rely on the presence of a particular
590 /// See `force_use_stage1` for documentation on what each argument is.
594 host: TargetSelection,
595 target: TargetSelection,
597 if self.build.force_use_stage1(Compiler { stage, host }, target) {
598 self.compiler(1, self.config.build)
600 self.compiler(stage, host)
604 pub fn sysroot(&self, compiler: Compiler) -> Interned<PathBuf> {
605 self.ensure(compile::Sysroot { compiler })
608 /// Returns the libdir where the standard library and other artifacts are
609 /// found for a compiler's sysroot.
610 pub fn sysroot_libdir(&self, compiler: Compiler, target: TargetSelection) -> Interned<PathBuf> {
611 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
614 target: TargetSelection,
616 impl Step for Libdir {
617 type Output = Interned<PathBuf>;
619 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
623 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
624 let lib = builder.sysroot_libdir_relative(self.compiler);
625 let sysroot = builder
626 .sysroot(self.compiler)
629 .join(self.target.triple)
631 let _ = fs::remove_dir_all(&sysroot);
632 t!(fs::create_dir_all(&sysroot));
633 INTERNER.intern_path(sysroot)
636 self.ensure(Libdir { compiler, target })
639 pub fn sysroot_codegen_backends(&self, compiler: Compiler) -> PathBuf {
640 self.sysroot_libdir(compiler, compiler.host).with_file_name("codegen-backends")
643 /// Returns the compiler's libdir where it stores the dynamic libraries that
644 /// it itself links against.
646 /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
648 pub fn rustc_libdir(&self, compiler: Compiler) -> PathBuf {
649 if compiler.is_snapshot(self) {
650 self.rustc_snapshot_libdir()
652 match self.config.libdir_relative() {
653 Some(relative_libdir) if compiler.stage >= 1 => {
654 self.sysroot(compiler).join(relative_libdir)
656 _ => self.sysroot(compiler).join(libdir(compiler.host)),
661 /// Returns the compiler's relative libdir where it stores the dynamic libraries that
662 /// it itself links against.
664 /// For example this returns `lib` on Unix and `bin` on
666 pub fn libdir_relative(&self, compiler: Compiler) -> &Path {
667 if compiler.is_snapshot(self) {
668 libdir(self.config.build).as_ref()
670 match self.config.libdir_relative() {
671 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
672 _ => libdir(compiler.host).as_ref(),
677 /// Returns the compiler's relative libdir where the standard library and other artifacts are
678 /// found for a compiler's sysroot.
680 /// For example this returns `lib` on Unix and Windows.
681 pub fn sysroot_libdir_relative(&self, compiler: Compiler) -> &Path {
682 match self.config.libdir_relative() {
683 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
684 _ if compiler.stage == 0 => &self.build.initial_libdir,
685 _ => Path::new("lib"),
689 /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
690 /// library lookup path.
691 pub fn add_rustc_lib_path(&self, compiler: Compiler, cmd: &mut Command) {
692 // Windows doesn't need dylib path munging because the dlls for the
693 // compiler live next to the compiler and the system will find them
699 add_dylib_path(vec![self.rustc_libdir(compiler)], cmd);
702 /// Gets a path to the compiler specified.
703 pub fn rustc(&self, compiler: Compiler) -> PathBuf {
704 if compiler.is_snapshot(self) {
705 self.initial_rustc.clone()
707 self.sysroot(compiler).join("bin").join(exe("rustc", compiler.host))
711 /// Gets the paths to all of the compiler's codegen backends.
712 fn codegen_backends(&self, compiler: Compiler) -> impl Iterator<Item = PathBuf> {
713 fs::read_dir(self.sysroot_codegen_backends(compiler))
716 .filter_map(Result::ok)
717 .map(|entry| entry.path())
720 pub fn rustdoc(&self, compiler: Compiler) -> PathBuf {
721 self.ensure(tool::Rustdoc { compiler })
724 pub fn rustdoc_cmd(&self, compiler: Compiler) -> Command {
725 let mut cmd = Command::new(&self.out.join("bootstrap/debug/rustdoc"));
726 cmd.env("RUSTC_STAGE", compiler.stage.to_string())
727 .env("RUSTC_SYSROOT", self.sysroot(compiler))
728 // Note that this is *not* the sysroot_libdir because rustdoc must be linked
729 // equivalently to rustc.
730 .env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler))
731 .env("CFG_RELEASE_CHANNEL", &self.config.channel)
732 .env("RUSTDOC_REAL", self.rustdoc(compiler))
733 .env("RUSTC_BOOTSTRAP", "1")
734 .arg("-Winvalid_codeblock_attributes");
735 if self.config.deny_warnings {
736 cmd.arg("-Dwarnings");
739 // Remove make-related flags that can cause jobserver problems.
740 cmd.env_remove("MAKEFLAGS");
741 cmd.env_remove("MFLAGS");
743 if let Some(linker) = self.linker(compiler.host) {
744 cmd.env("RUSTDOC_LINKER", linker);
746 if self.is_fuse_ld_lld(compiler.host) {
747 cmd.env("RUSTDOC_FUSE_LD_LLD", "1");
752 /// Return the path to `llvm-config` for the target, if it exists.
754 /// Note that this returns `None` if LLVM is disabled, or if we're in a
755 /// check build or dry-run, where there's no need to build all of LLVM.
756 fn llvm_config(&self, target: TargetSelection) -> Option<PathBuf> {
757 if self.config.llvm_enabled() && self.kind != Kind::Check && !self.config.dry_run {
758 let llvm_config = self.ensure(native::Llvm { target });
759 if llvm_config.is_file() {
760 return Some(llvm_config);
766 /// Prepares an invocation of `cargo` to be run.
768 /// This will create a `Command` that represents a pending execution of
769 /// Cargo. This cargo will be configured to use `compiler` as the actual
770 /// rustc compiler, its output will be scoped by `mode`'s output directory,
771 /// it will pass the `--target` flag for the specified `target`, and will be
772 /// executing the Cargo command `cmd`.
777 source_type: SourceType,
778 target: TargetSelection,
781 let mut cargo = Command::new(&self.initial_cargo);
782 let out_dir = self.stage_out(compiler, mode);
784 // Codegen backends are not yet tracked by -Zbinary-dep-depinfo,
785 // so we need to explicitly clear out if they've been updated.
786 for backend in self.codegen_backends(compiler) {
787 self.clear_if_dirty(&out_dir, &backend);
790 if cmd == "doc" || cmd == "rustdoc" {
791 let my_out = match mode {
792 // This is the intended out directory for compiler documentation.
793 Mode::Rustc | Mode::ToolRustc => self.compiler_doc_out(target),
794 Mode::Std => out_dir.join(target.triple).join("doc"),
795 _ => panic!("doc mode {:?} not expected", mode),
797 let rustdoc = self.rustdoc(compiler);
798 self.clear_if_dirty(&my_out, &rustdoc);
801 cargo.env("CARGO_TARGET_DIR", &out_dir).arg(cmd);
803 let profile_var = |name: &str| {
804 let profile = if self.config.rust_optimize { "RELEASE" } else { "DEV" };
805 format!("CARGO_PROFILE_{}_{}", profile, name)
808 // See comment in rustc_llvm/build.rs for why this is necessary, largely llvm-config
809 // needs to not accidentally link to libLLVM in stage0/lib.
810 cargo.env("REAL_LIBRARY_PATH_VAR", &util::dylib_path_var());
811 if let Some(e) = env::var_os(util::dylib_path_var()) {
812 cargo.env("REAL_LIBRARY_PATH", e);
815 if cmd != "install" {
816 cargo.arg("--target").arg(target.rustc_target_arg());
818 assert_eq!(target, compiler.host);
821 // Set a flag for `check`/`clippy`/`fix`, so that certain build
822 // scripts can do less work (i.e. not building/requiring LLVM).
823 if cmd == "check" || cmd == "clippy" || cmd == "fix" {
824 // If we've not yet built LLVM, or it's stale, then bust
825 // the rustc_llvm cache. That will always work, even though it
826 // may mean that on the next non-check build we'll need to rebuild
827 // rustc_llvm. But if LLVM is stale, that'll be a tiny amount
828 // of work comparitively, and we'd likely need to rebuild it anyway,
830 if crate::native::prebuilt_llvm_config(self, target).is_err() {
831 cargo.env("RUST_CHECK", "1");
835 let stage = if compiler.stage == 0 && self.local_rebuild {
836 // Assume the local-rebuild rustc already has stage1 features.
842 let mut rustflags = Rustflags::new(target);
844 if let Ok(s) = env::var("CARGOFLAGS_NOT_BOOTSTRAP") {
845 cargo.args(s.split_whitespace());
847 rustflags.env("RUSTFLAGS_NOT_BOOTSTRAP");
849 if let Ok(s) = env::var("CARGOFLAGS_BOOTSTRAP") {
850 cargo.args(s.split_whitespace());
852 rustflags.env("RUSTFLAGS_BOOTSTRAP");
853 rustflags.arg("--cfg=bootstrap");
856 if self.config.rust_new_symbol_mangling {
857 rustflags.arg("-Zsymbol-mangling-version=v0");
860 // FIXME: It might be better to use the same value for both `RUSTFLAGS` and `RUSTDOCFLAGS`,
861 // but this breaks CI. At the very least, stage0 `rustdoc` needs `--cfg bootstrap`. See
863 let mut rustdocflags = rustflags.clone();
865 if let Ok(s) = env::var("CARGOFLAGS") {
866 cargo.args(s.split_whitespace());
870 Mode::Std | Mode::ToolBootstrap | Mode::ToolStd => {}
871 Mode::Rustc | Mode::Codegen | Mode::ToolRustc => {
872 // Build proc macros both for the host and the target
873 if target != compiler.host && cmd != "check" {
874 cargo.arg("-Zdual-proc-macros");
875 rustflags.arg("-Zdual-proc-macros");
880 // This tells Cargo (and in turn, rustc) to output more complete
881 // dependency information. Most importantly for rustbuild, this
882 // includes sysroot artifacts, like libstd, which means that we don't
883 // need to track those in rustbuild (an error prone process!). This
884 // feature is currently unstable as there may be some bugs and such, but
885 // it represents a big improvement in rustbuild's reliability on
886 // rebuilds, so we're using it here.
888 // For some additional context, see #63470 (the PR originally adding
889 // this), as well as #63012 which is the tracking issue for this
890 // feature on the rustc side.
891 cargo.arg("-Zbinary-dep-depinfo");
893 cargo.arg("-j").arg(self.jobs().to_string());
894 // Remove make-related flags to ensure Cargo can correctly set things up
895 cargo.env_remove("MAKEFLAGS");
896 cargo.env_remove("MFLAGS");
898 // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
899 // Force cargo to output binaries with disambiguating hashes in the name
900 let mut metadata = if compiler.stage == 0 {
901 // Treat stage0 like a special channel, whether it's a normal prior-
902 // release rustc or a local rebuild with the same version, so we
903 // never mix these libraries by accident.
904 "bootstrap".to_string()
906 self.config.channel.to_string()
908 // We want to make sure that none of the dependencies between
909 // std/test/rustc unify with one another. This is done for weird linkage
910 // reasons but the gist of the problem is that if librustc, libtest, and
911 // libstd all depend on libc from crates.io (which they actually do) we
912 // want to make sure they all get distinct versions. Things get really
913 // weird if we try to unify all these dependencies right now, namely
914 // around how many times the library is linked in dynamic libraries and
915 // such. If rustc were a static executable or if we didn't ship dylibs
916 // this wouldn't be a problem, but we do, so it is. This is in general
917 // just here to make sure things build right. If you can remove this and
918 // things still build right, please do!
920 Mode::Std => metadata.push_str("std"),
921 // When we're building rustc tools, they're built with a search path
922 // that contains things built during the rustc build. For example,
923 // bitflags is built during the rustc build, and is a dependency of
924 // rustdoc as well. We're building rustdoc in a different target
925 // directory, though, which means that Cargo will rebuild the
926 // dependency. When we go on to build rustdoc, we'll look for
927 // bitflags, and find two different copies: one built during the
928 // rustc step and one that we just built. This isn't always a
929 // problem, somehow -- not really clear why -- but we know that this
931 Mode::ToolRustc => metadata.push_str("tool-rustc"),
932 // Same for codegen backends.
933 Mode::Codegen => metadata.push_str("codegen"),
936 cargo.env("__CARGO_DEFAULT_LIB_METADATA", &metadata);
939 rustflags.arg("-Zforce-unstable-if-unmarked");
942 rustflags.arg("-Zmacro-backtrace");
944 let want_rustdoc = self.doc_tests != DocTests::No;
946 // We synthetically interpret a stage0 compiler used to build tools as a
947 // "raw" compiler in that it's the exact snapshot we download. Normally
948 // the stage0 build means it uses libraries build by the stage0
949 // compiler, but for tools we just use the precompiled libraries that
951 let use_snapshot = mode == Mode::ToolBootstrap;
952 assert!(!use_snapshot || stage == 0 || self.local_rebuild);
954 let maybe_sysroot = self.sysroot(compiler);
955 let sysroot = if use_snapshot { self.rustc_snapshot_sysroot() } else { &maybe_sysroot };
956 let libdir = self.rustc_libdir(compiler);
958 // Clear the output directory if the real rustc we're using has changed;
959 // Cargo cannot detect this as it thinks rustc is bootstrap/debug/rustc.
961 // Avoid doing this during dry run as that usually means the relevant
962 // compiler is not yet linked/copied properly.
964 // Only clear out the directory if we're compiling std; otherwise, we
965 // should let Cargo take care of things for us (via depdep info)
966 if !self.config.dry_run && mode == Mode::Std && cmd == "build" {
967 self.clear_if_dirty(&out_dir, &self.rustc(compiler));
970 // Customize the compiler we're running. Specify the compiler to cargo
971 // as our shim and then pass it some various options used to configure
972 // how the actual compiler itself is called.
974 // These variables are primarily all read by
975 // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
977 .env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
978 .env("RUSTC", self.out.join("bootstrap/debug/rustc"))
979 .env("RUSTC_REAL", self.rustc(compiler))
980 .env("RUSTC_STAGE", stage.to_string())
981 .env("RUSTC_SYSROOT", &sysroot)
982 .env("RUSTC_LIBDIR", &libdir)
983 .env("RUSTDOC", self.out.join("bootstrap/debug/rustdoc"))
986 if cmd == "doc" || cmd == "rustdoc" || (cmd == "test" && want_rustdoc) {
987 self.rustdoc(compiler)
989 PathBuf::from("/path/to/nowhere/rustdoc/not/required")
992 .env("RUSTC_ERROR_METADATA_DST", self.extended_error_dir())
993 .env("RUSTC_BREAK_ON_ICE", "1");
995 // Dealing with rpath here is a little special, so let's go into some
996 // detail. First off, `-rpath` is a linker option on Unix platforms
997 // which adds to the runtime dynamic loader path when looking for
998 // dynamic libraries. We use this by default on Unix platforms to ensure
999 // that our nightlies behave the same on Windows, that is they work out
1000 // of the box. This can be disabled, of course, but basically that's why
1001 // we're gated on RUSTC_RPATH here.
1003 // Ok, so the astute might be wondering "why isn't `-C rpath` used
1004 // here?" and that is indeed a good question to ask. This codegen
1005 // option is the compiler's current interface to generating an rpath.
1006 // Unfortunately it doesn't quite suffice for us. The flag currently
1007 // takes no value as an argument, so the compiler calculates what it
1008 // should pass to the linker as `-rpath`. This unfortunately is based on
1009 // the **compile time** directory structure which when building with
1010 // Cargo will be very different than the runtime directory structure.
1012 // All that's a really long winded way of saying that if we use
1013 // `-Crpath` then the executables generated have the wrong rpath of
1014 // something like `$ORIGIN/deps` when in fact the way we distribute
1015 // rustc requires the rpath to be `$ORIGIN/../lib`.
1017 // So, all in all, to set up the correct rpath we pass the linker
1018 // argument manually via `-C link-args=-Wl,-rpath,...`. Plus isn't it
1019 // fun to pass a flag to a tool to pass a flag to pass a flag to a tool
1020 // to change a flag in a binary?
1021 if self.config.rust_rpath && util::use_host_linker(target) {
1022 let rpath = if target.contains("apple") {
1023 // Note that we need to take one extra step on macOS to also pass
1024 // `-Wl,-instal_name,@rpath/...` to get things to work right. To
1025 // do that we pass a weird flag to the compiler to get it to do
1026 // so. Note that this is definitely a hack, and we should likely
1027 // flesh out rpath support more fully in the future.
1028 rustflags.arg("-Zosx-rpath-install-name");
1029 Some("-Wl,-rpath,@loader_path/../lib")
1030 } else if !target.contains("windows") {
1031 Some("-Wl,-rpath,$ORIGIN/../lib")
1035 if let Some(rpath) = rpath {
1036 rustflags.arg(&format!("-Clink-args={}", rpath));
1040 if let Some(host_linker) = self.linker(compiler.host) {
1041 cargo.env("RUSTC_HOST_LINKER", host_linker);
1043 if self.is_fuse_ld_lld(compiler.host) {
1044 cargo.env("RUSTC_HOST_FUSE_LD_LLD", "1");
1047 if let Some(target_linker) = self.linker(target) {
1048 let target = crate::envify(&target.triple);
1049 cargo.env(&format!("CARGO_TARGET_{}_LINKER", target), target_linker);
1051 if self.is_fuse_ld_lld(target) {
1052 rustflags.arg("-Clink-args=-fuse-ld=lld");
1055 if !(["build", "check", "clippy", "fix", "rustc"].contains(&cmd)) && want_rustdoc {
1056 cargo.env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler));
1059 let debuginfo_level = match mode {
1060 Mode::Rustc | Mode::Codegen => self.config.rust_debuginfo_level_rustc,
1061 Mode::Std => self.config.rust_debuginfo_level_std,
1062 Mode::ToolBootstrap | Mode::ToolStd | Mode::ToolRustc => {
1063 self.config.rust_debuginfo_level_tools
1066 cargo.env(profile_var("DEBUG"), debuginfo_level.to_string());
1068 profile_var("DEBUG_ASSERTIONS"),
1069 if mode == Mode::Std {
1070 self.config.rust_debug_assertions_std.to_string()
1072 self.config.rust_debug_assertions.to_string()
1076 if self.config.cmd.bless() {
1077 // Bless `expect!` tests.
1078 cargo.env("UPDATE_EXPECT", "1");
1081 if !mode.is_tool() {
1082 cargo.env("RUSTC_FORCE_UNSTABLE", "1");
1085 if let Some(x) = self.crt_static(target) {
1087 rustflags.arg("-Ctarget-feature=+crt-static");
1089 rustflags.arg("-Ctarget-feature=-crt-static");
1093 if let Some(x) = self.crt_static(compiler.host) {
1094 cargo.env("RUSTC_HOST_CRT_STATIC", x.to_string());
1097 if let Some(map_to) = self.build.debuginfo_map_to(GitRepo::Rustc) {
1098 let map = format!("{}={}", self.build.src.display(), map_to);
1099 cargo.env("RUSTC_DEBUGINFO_MAP", map);
1101 // `rustc` needs to know the virtual `/rustc/$hash` we're mapping to,
1102 // in order to opportunistically reverse it later.
1103 cargo.env("CFG_VIRTUAL_RUST_SOURCE_BASE_DIR", map_to);
1106 // Enable usage of unstable features
1107 cargo.env("RUSTC_BOOTSTRAP", "1");
1108 self.add_rust_test_threads(&mut cargo);
1110 // Almost all of the crates that we compile as part of the bootstrap may
1111 // have a build script, including the standard library. To compile a
1112 // build script, however, it itself needs a standard library! This
1113 // introduces a bit of a pickle when we're compiling the standard
1116 // To work around this we actually end up using the snapshot compiler
1117 // (stage0) for compiling build scripts of the standard library itself.
1118 // The stage0 compiler is guaranteed to have a libstd available for use.
1120 // For other crates, however, we know that we've already got a standard
1121 // library up and running, so we can use the normal compiler to compile
1122 // build scripts in that situation.
1123 if mode == Mode::Std {
1125 .env("RUSTC_SNAPSHOT", &self.initial_rustc)
1126 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
1129 .env("RUSTC_SNAPSHOT", self.rustc(compiler))
1130 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
1133 // Tools that use compiler libraries may inherit the `-lLLVM` link
1134 // requirement, but the `-L` library path is not propagated across
1135 // separate Cargo projects. We can add LLVM's library path to the
1136 // platform-specific environment variable as a workaround.
1137 if mode == Mode::ToolRustc {
1138 if let Some(llvm_config) = self.llvm_config(target) {
1139 let llvm_libdir = output(Command::new(&llvm_config).arg("--libdir"));
1140 add_link_lib_path(vec![llvm_libdir.trim().into()], &mut cargo);
1144 if self.config.incremental {
1145 cargo.env("CARGO_INCREMENTAL", "1");
1147 // Don't rely on any default setting for incr. comp. in Cargo
1148 cargo.env("CARGO_INCREMENTAL", "0");
1151 if let Some(ref on_fail) = self.config.on_fail {
1152 cargo.env("RUSTC_ON_FAIL", on_fail);
1155 if self.config.print_step_timings {
1156 cargo.env("RUSTC_PRINT_STEP_TIMINGS", "1");
1159 if self.config.backtrace_on_ice {
1160 cargo.env("RUSTC_BACKTRACE_ON_ICE", "1");
1163 cargo.env("RUSTC_VERBOSE", self.verbosity.to_string());
1165 if source_type == SourceType::InTree {
1166 let mut lint_flags = Vec::new();
1167 // When extending this list, add the new lints to the RUSTFLAGS of the
1168 // build_bootstrap function of src/bootstrap/bootstrap.py as well as
1169 // some code doesn't go through this `rustc` wrapper.
1170 lint_flags.push("-Wrust_2018_idioms");
1171 lint_flags.push("-Wunused_lifetimes");
1173 if self.config.deny_warnings {
1174 lint_flags.push("-Dwarnings");
1175 rustdocflags.arg("-Dwarnings");
1178 // FIXME(#58633) hide "unused attribute" errors in incremental
1179 // builds of the standard library, as the underlying checks are
1180 // not yet properly integrated with incremental recompilation.
1181 if mode == Mode::Std && compiler.stage == 0 && self.config.incremental {
1182 lint_flags.push("-Aunused-attributes");
1184 // This does not use RUSTFLAGS due to caching issues with Cargo.
1185 // Clippy is treated as an "in tree" tool, but shares the same
1186 // cache as other "submodule" tools. With these options set in
1187 // RUSTFLAGS, that causes *every* shared dependency to be rebuilt.
1188 // By injecting this into the rustc wrapper, this circumvents
1189 // Cargo's fingerprint detection. This is fine because lint flags
1190 // are always ignored in dependencies. Eventually this should be
1191 // fixed via better support from Cargo.
1192 cargo.env("RUSTC_LINT_FLAGS", lint_flags.join(" "));
1194 rustdocflags.arg("-Winvalid_codeblock_attributes");
1197 if mode == Mode::Rustc {
1198 rustflags.arg("-Zunstable-options");
1199 rustflags.arg("-Wrustc::internal");
1202 // Throughout the build Cargo can execute a number of build scripts
1203 // compiling C/C++ code and we need to pass compilers, archivers, flags, etc
1204 // obtained previously to those build scripts.
1205 // Build scripts use either the `cc` crate or `configure/make` so we pass
1206 // the options through environment variables that are fetched and understood by both.
1208 // FIXME: the guard against msvc shouldn't need to be here
1209 if target.contains("msvc") {
1210 if let Some(ref cl) = self.config.llvm_clang_cl {
1211 cargo.env("CC", cl).env("CXX", cl);
1214 let ccache = self.config.ccache.as_ref();
1215 let ccacheify = |s: &Path| {
1216 let ccache = match ccache {
1218 None => return s.display().to_string(),
1220 // FIXME: the cc-rs crate only recognizes the literal strings
1221 // `ccache` and `sccache` when doing caching compilations, so we
1222 // mirror that here. It should probably be fixed upstream to
1223 // accept a new env var or otherwise work with custom ccache
1226 "ccache" | "sccache" => format!("{} {}", ccache, s.display()),
1227 _ => s.display().to_string(),
1230 let cc = ccacheify(&self.cc(target));
1231 cargo.env(format!("CC_{}", target.triple), &cc);
1233 let cflags = self.cflags(target, GitRepo::Rustc).join(" ");
1234 cargo.env(format!("CFLAGS_{}", target.triple), &cflags);
1236 if let Some(ar) = self.ar(target) {
1237 let ranlib = format!("{} s", ar.display());
1239 .env(format!("AR_{}", target.triple), ar)
1240 .env(format!("RANLIB_{}", target.triple), ranlib);
1243 if let Ok(cxx) = self.cxx(target) {
1244 let cxx = ccacheify(&cxx);
1246 .env(format!("CXX_{}", target.triple), &cxx)
1247 .env(format!("CXXFLAGS_{}", target.triple), cflags);
1251 if mode == Mode::Std && self.config.extended && compiler.is_final_stage(self) {
1252 rustflags.arg("-Zsave-analysis");
1254 "RUST_SAVE_ANALYSIS_CONFIG",
1255 "{\"output_file\": null,\"full_docs\": false,\
1256 \"pub_only\": true,\"reachable_only\": false,\
1257 \"distro_crate\": true,\"signatures\": false,\"borrow_data\": false}",
1261 // If Control Flow Guard is enabled, pass the `control-flow-guard` flag to rustc
1262 // when compiling the standard library, since this might be linked into the final outputs
1263 // produced by rustc. Since this mitigation is only available on Windows, only enable it
1264 // for the standard library in case the compiler is run on a non-Windows platform.
1265 // This is not needed for stage 0 artifacts because these will only be used for building
1266 // the stage 1 compiler.
1268 && mode == Mode::Std
1269 && self.config.control_flow_guard
1270 && compiler.stage >= 1
1272 rustflags.arg("-Ccontrol-flow-guard");
1275 // For `cargo doc` invocations, make rustdoc print the Rust version into the docs
1276 // This replaces spaces with newlines because RUSTDOCFLAGS does not
1277 // support arguments with regular spaces. Hopefully someday Cargo will
1278 // have space support.
1279 let rust_version = self.rust_version().replace(' ', "\n");
1280 rustdocflags.arg("--crate-version").arg(&rust_version);
1282 // Environment variables *required* throughout the build
1284 // FIXME: should update code to not require this env var
1285 cargo.env("CFG_COMPILER_HOST_TRIPLE", target.triple);
1287 // Set this for all builds to make sure doc builds also get it.
1288 cargo.env("CFG_RELEASE_CHANNEL", &self.config.channel);
1290 // This one's a bit tricky. As of the time of this writing the compiler
1291 // links to the `winapi` crate on crates.io. This crate provides raw
1292 // bindings to Windows system functions, sort of like libc does for
1293 // Unix. This crate also, however, provides "import libraries" for the
1294 // MinGW targets. There's an import library per dll in the windows
1295 // distribution which is what's linked to. These custom import libraries
1296 // are used because the winapi crate can reference Windows functions not
1297 // present in the MinGW import libraries.
1299 // For example MinGW may ship libdbghelp.a, but it may not have
1300 // references to all the functions in the dbghelp dll. Instead the
1301 // custom import library for dbghelp in the winapi crates has all this
1304 // Unfortunately for us though the import libraries are linked by
1305 // default via `-ldylib=winapi_foo`. That is, they're linked with the
1306 // `dylib` type with a `winapi_` prefix (so the winapi ones don't
1307 // conflict with the system MinGW ones). This consequently means that
1308 // the binaries we ship of things like rustc_codegen_llvm (aka the rustc_codegen_llvm
1309 // DLL) when linked against *again*, for example with procedural macros
1310 // or plugins, will trigger the propagation logic of `-ldylib`, passing
1311 // `-lwinapi_foo` to the linker again. This isn't actually available in
1312 // our distribution, however, so the link fails.
1314 // To solve this problem we tell winapi to not use its bundled import
1315 // libraries. This means that it will link to the system MinGW import
1316 // libraries by default, and the `-ldylib=foo` directives will still get
1317 // passed to the final linker, but they'll look like `-lfoo` which can
1318 // be resolved because MinGW has the import library. The downside is we
1319 // don't get newer functions from Windows, but we don't use any of them
1321 if !mode.is_tool() {
1322 cargo.env("WINAPI_NO_BUNDLED_LIBRARIES", "1");
1325 for _ in 1..self.verbosity {
1329 match (mode, self.config.rust_codegen_units_std, self.config.rust_codegen_units) {
1330 (Mode::Std, Some(n), _) | (_, _, Some(n)) => {
1331 cargo.env(profile_var("CODEGEN_UNITS"), n.to_string());
1334 // Don't set anything
1338 if self.config.rust_optimize {
1339 // FIXME: cargo bench/install do not accept `--release`
1340 if cmd != "bench" && cmd != "install" {
1341 cargo.arg("--release");
1345 if self.config.locked_deps {
1346 cargo.arg("--locked");
1348 if self.config.vendor || self.is_sudo {
1349 cargo.arg("--frozen");
1352 // Try to use a sysroot-relative bindir, in case it was configured absolutely.
1353 cargo.env("RUSTC_INSTALL_BINDIR", self.config.bindir_relative());
1355 self.ci_env.force_coloring_in_ci(&mut cargo);
1357 // When we build Rust dylibs they're all intended for intermediate
1358 // usage, so make sure we pass the -Cprefer-dynamic flag instead of
1359 // linking all deps statically into the dylib.
1360 if matches!(mode, Mode::Std | Mode::Rustc) {
1361 rustflags.arg("-Cprefer-dynamic");
1364 // When building incrementally we default to a lower ThinLTO import limit
1365 // (unless explicitly specified otherwise). This will produce a somewhat
1366 // slower code but give way better compile times.
1368 let limit = match self.config.rust_thin_lto_import_instr_limit {
1369 Some(limit) => Some(limit),
1370 None if self.config.incremental => Some(10),
1374 if let Some(limit) = limit {
1375 rustflags.arg(&format!("-Cllvm-args=-import-instr-limit={}", limit));
1379 Cargo { command: cargo, rustflags, rustdocflags }
1382 /// Ensure that a given step is built, returning its output. This will
1383 /// cache the step, so it is safe (and good!) to call this as often as
1384 /// needed to ensure that all dependencies are built.
1385 pub fn ensure<S: Step>(&'a self, step: S) -> S::Output {
1387 let mut stack = self.stack.borrow_mut();
1388 for stack_step in stack.iter() {
1390 if stack_step.downcast_ref::<S>().map_or(true, |stack_step| *stack_step != step) {
1393 let mut out = String::new();
1394 out += &format!("\n\nCycle in build detected when adding {:?}\n", step);
1395 for el in stack.iter().rev() {
1396 out += &format!("\t{:?}\n", el);
1400 if let Some(out) = self.cache.get(&step) {
1401 self.verbose(&format!("{}c {:?}", " ".repeat(stack.len()), step));
1405 self.verbose(&format!("{}> {:?}", " ".repeat(stack.len()), step));
1406 stack.push(Box::new(step.clone()));
1410 let start = Instant::now();
1411 let zero = Duration::new(0, 0);
1412 let parent = self.time_spent_on_dependencies.replace(zero);
1413 let out = step.clone().run(self);
1414 let dur = start.elapsed();
1415 let deps = self.time_spent_on_dependencies.replace(parent + dur);
1419 if self.config.print_step_timings && !self.config.dry_run {
1420 println!("[TIMING] {:?} -- {}.{:03}", step, dur.as_secs(), dur.subsec_millis());
1424 let mut stack = self.stack.borrow_mut();
1425 let cur_step = stack.pop().expect("step stack empty");
1426 assert_eq!(cur_step.downcast_ref(), Some(&step));
1428 self.verbose(&format!("{}< {:?}", " ".repeat(self.stack.borrow().len()), step));
1429 self.cache.put(step, out.clone());
1437 #[derive(Debug, Clone)]
1438 struct Rustflags(String);
1441 fn new(target: TargetSelection) -> Rustflags {
1442 let mut ret = Rustflags(String::new());
1444 // Inherit `RUSTFLAGS` by default ...
1445 ret.env("RUSTFLAGS");
1447 // ... and also handle target-specific env RUSTFLAGS if they're
1449 let target_specific = format!("CARGO_TARGET_{}_RUSTFLAGS", crate::envify(&target.triple));
1450 ret.env(&target_specific);
1455 fn env(&mut self, env: &str) {
1456 if let Ok(s) = env::var(env) {
1457 for part in s.split(' ') {
1463 fn arg(&mut self, arg: &str) -> &mut Self {
1464 assert_eq!(arg.split(' ').count(), 1);
1465 if !self.0.is_empty() {
1466 self.0.push_str(" ");
1468 self.0.push_str(arg);
1476 rustflags: Rustflags,
1477 rustdocflags: Rustflags,
1481 pub fn rustdocflag(&mut self, arg: &str) -> &mut Cargo {
1482 self.rustdocflags.arg(arg);
1485 pub fn rustflag(&mut self, arg: &str) -> &mut Cargo {
1486 self.rustflags.arg(arg);
1490 pub fn arg(&mut self, arg: impl AsRef<OsStr>) -> &mut Cargo {
1491 self.command.arg(arg.as_ref());
1495 pub fn args<I, S>(&mut self, args: I) -> &mut Cargo
1497 I: IntoIterator<Item = S>,
1501 self.arg(arg.as_ref());
1506 pub fn env(&mut self, key: impl AsRef<OsStr>, value: impl AsRef<OsStr>) -> &mut Cargo {
1507 // These are managed through rustflag/rustdocflag interfaces.
1508 assert_ne!(key.as_ref(), "RUSTFLAGS");
1509 assert_ne!(key.as_ref(), "RUSTDOCFLAGS");
1510 self.command.env(key.as_ref(), value.as_ref());
1514 pub fn add_rustc_lib_path(&mut self, builder: &Builder<'_>, compiler: Compiler) {
1515 builder.add_rustc_lib_path(compiler, &mut self.command);
1519 impl From<Cargo> for Command {
1520 fn from(mut cargo: Cargo) -> Command {
1521 let rustflags = &cargo.rustflags.0;
1522 if !rustflags.is_empty() {
1523 cargo.command.env("RUSTFLAGS", rustflags);
1526 let rustdocflags = &cargo.rustdocflags.0;
1527 if !rustdocflags.is_empty() {
1528 cargo.command.env("RUSTDOCFLAGS", rustdocflags);