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 host: TargetSelection,
91 pub target: TargetSelection,
95 struct StepDescription {
98 should_run: fn(ShouldRun<'_>) -> ShouldRun<'_>,
99 make_run: fn(RunConfig<'_>),
103 /// Collection of paths used to match a task rule.
104 #[derive(Debug, Clone, PartialOrd, Ord, PartialEq, Eq)]
106 /// A collection of individual paths.
108 /// These are generally matched as a path suffix. For example, a
109 /// command-line value of `libstd` will match if `src/libstd` is in the
111 Set(BTreeSet<PathBuf>),
112 /// A "suite" of paths.
114 /// These can match as a path suffix (like `Set`), or as a prefix. For
115 /// example, a command-line value of `src/test/ui/abi/variadic-ffi.rs`
116 /// will match `src/test/ui`. A command-line value of `ui` would also
117 /// match `src/test/ui`.
122 fn empty() -> PathSet {
123 PathSet::Set(BTreeSet::new())
126 fn one<P: Into<PathBuf>>(path: P) -> PathSet {
127 let mut set = BTreeSet::new();
128 set.insert(path.into());
132 fn has(&self, needle: &Path) -> bool {
134 PathSet::Set(set) => set.iter().any(|p| p.ends_with(needle)),
135 PathSet::Suite(suite) => suite.ends_with(needle),
139 fn path(&self, builder: &Builder<'_>) -> PathBuf {
141 PathSet::Set(set) => set.iter().next().unwrap_or(&builder.build.src).to_path_buf(),
142 PathSet::Suite(path) => PathBuf::from(path),
147 impl StepDescription {
148 fn from<S: Step>() -> StepDescription {
151 only_hosts: S::ONLY_HOSTS,
152 should_run: S::should_run,
153 make_run: S::make_run,
154 name: std::any::type_name::<S>(),
158 fn maybe_run(&self, builder: &Builder<'_>, pathset: &PathSet) {
159 if builder.config.exclude.iter().any(|e| pathset.has(e)) {
160 eprintln!("Skipping {:?} because it is excluded", pathset);
162 } else if !builder.config.exclude.is_empty() {
164 "{:?} not skipped for {:?} -- not in {:?}",
165 pathset, self.name, builder.config.exclude
168 let hosts = &builder.hosts;
170 // Determine the targets participating in this rule.
171 let targets = if self.only_hosts {
172 if builder.config.skip_only_host_steps {
173 return; // don't run anything
182 for target in targets {
183 let run = RunConfig {
185 path: pathset.path(builder),
189 (self.make_run)(run);
194 fn run(v: &[StepDescription], builder: &Builder<'_>, paths: &[PathBuf]) {
196 v.iter().map(|desc| (desc.should_run)(ShouldRun::new(builder))).collect::<Vec<_>>();
198 // sanity checks on rules
199 for (desc, should_run) in v.iter().zip(&should_runs) {
201 !should_run.paths.is_empty(),
202 "{:?} should have at least one pathset",
207 if paths.is_empty() {
208 for (desc, should_run) in v.iter().zip(should_runs) {
209 if desc.default && should_run.is_really_default {
210 for pathset in &should_run.paths {
211 desc.maybe_run(builder, pathset);
217 // strip CurDir prefix if present
218 let path = match path.strip_prefix(".") {
223 let mut attempted_run = false;
224 for (desc, should_run) in v.iter().zip(&should_runs) {
225 if let Some(suite) = should_run.is_suite_path(path) {
226 attempted_run = true;
227 desc.maybe_run(builder, suite);
228 } else if let Some(pathset) = should_run.pathset_for_path(path) {
229 attempted_run = true;
230 desc.maybe_run(builder, pathset);
235 panic!("Error: no rules matched {}.", path.display());
243 pub struct ShouldRun<'a> {
244 pub builder: &'a Builder<'a>,
245 // use a BTreeSet to maintain sort order
246 paths: BTreeSet<PathSet>,
248 // If this is a default rule, this is an additional constraint placed on
249 // its run. Generally something like compiler docs being enabled.
250 is_really_default: bool,
253 impl<'a> ShouldRun<'a> {
254 fn new(builder: &'a Builder<'_>) -> ShouldRun<'a> {
257 paths: BTreeSet::new(),
258 is_really_default: true, // by default no additional conditions
262 pub fn default_condition(mut self, cond: bool) -> Self {
263 self.is_really_default = cond;
267 /// Indicates it should run if the command-line selects the given crate or
268 /// any of its (local) dependencies.
270 /// Compared to `krate`, this treats the dependencies as aliases for the
271 /// same job. Generally it is preferred to use `krate`, and treat each
272 /// individual path separately. For example `./x.py test src/liballoc`
273 /// (which uses `krate`) will test just `liballoc`. However, `./x.py check
274 /// src/liballoc` (which uses `all_krates`) will check all of `libtest`.
275 /// `all_krates` should probably be removed at some point.
276 pub fn all_krates(mut self, name: &str) -> Self {
277 let mut set = BTreeSet::new();
278 for krate in self.builder.in_tree_crates(name) {
279 let path = krate.local_path(self.builder);
282 self.paths.insert(PathSet::Set(set));
286 /// Indicates it should run if the command-line selects the given crate or
287 /// any of its (local) dependencies.
289 /// `make_run` will be called separately for each matching command-line path.
290 pub fn krate(mut self, name: &str) -> Self {
291 for krate in self.builder.in_tree_crates(name) {
292 let path = krate.local_path(self.builder);
293 self.paths.insert(PathSet::one(path));
298 // single, non-aliased path
299 pub fn path(self, path: &str) -> Self {
303 // multiple aliases for the same job
304 pub fn paths(mut self, paths: &[&str]) -> Self {
305 self.paths.insert(PathSet::Set(paths.iter().map(PathBuf::from).collect()));
309 pub fn is_suite_path(&self, path: &Path) -> Option<&PathSet> {
310 self.paths.iter().find(|pathset| match pathset {
311 PathSet::Suite(p) => path.starts_with(p),
312 PathSet::Set(_) => false,
316 pub fn suite_path(mut self, suite: &str) -> Self {
317 self.paths.insert(PathSet::Suite(PathBuf::from(suite)));
321 // allows being more explicit about why should_run in Step returns the value passed to it
322 pub fn never(mut self) -> ShouldRun<'a> {
323 self.paths.insert(PathSet::empty());
327 fn pathset_for_path(&self, path: &Path) -> Option<&PathSet> {
328 self.paths.iter().find(|pathset| pathset.has(path))
332 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
347 impl<'a> Builder<'a> {
348 fn get_step_descriptions(kind: Kind) -> Vec<StepDescription> {
349 macro_rules! describe {
350 ($($rule:ty),+ $(,)?) => {{
351 vec![$(StepDescription::from::<$rule>()),+]
355 Kind::Build => describe!(
358 compile::StartupObjects,
362 tool::UnstableBookGen,
367 tool::RemoteTestServer,
368 tool::RemoteTestClient,
384 Kind::Check | Kind::Clippy | Kind::Fix | Kind::Format => {
385 describe!(check::Std, check::Rustc, check::Rustdoc, check::Clippy)
387 Kind::Test => describe!(
388 crate::toolstate::ToolStateCheck,
389 test::ExpandYamlAnchors,
393 test::RunPassValgrind,
412 test::RunMakeFullDeps,
426 test::CompiletestTest,
428 test::RustdocJSNotStd,
431 // Run bootstrap close to the end as it's unlikely to fail
433 // Run run-make last, since these won't pass without make on Windows
436 Kind::Bench => describe!(test::Crate, test::CrateLibrustc),
437 Kind::Doc => describe!(
439 doc::UnstableBookGen,
455 Kind::Dist => describe!(
460 dist::DebuggerScripts,
465 dist::PlainSourceTarball,
476 Kind::Install => describe!(
481 install::RustAnalyzer,
489 Kind::Run => describe!(run::ExpandYamlAnchors,),
493 pub fn get_help(build: &Build, subcommand: &str) -> Option<String> {
494 let kind = match subcommand {
495 "build" => Kind::Build,
497 "test" => Kind::Test,
498 "bench" => Kind::Bench,
499 "dist" => Kind::Dist,
500 "install" => Kind::Install,
504 let builder = Builder {
506 top_stage: build.config.stage.unwrap_or(2),
509 stack: RefCell::new(Vec::new()),
510 time_spent_on_dependencies: Cell::new(Duration::new(0, 0)),
514 let builder = &builder;
515 let mut should_run = ShouldRun::new(builder);
516 for desc in Builder::get_step_descriptions(builder.kind) {
517 should_run = (desc.should_run)(should_run);
519 let mut help = String::from("Available paths:\n");
520 let mut add_path = |path: &Path| {
521 help.push_str(&format!(" ./x.py {} {}\n", subcommand, path.display()));
523 for pathset in should_run.paths {
525 PathSet::Set(set) => {
530 PathSet::Suite(path) => {
531 add_path(&path.join("..."));
538 pub fn new(build: &Build) -> Builder<'_> {
539 let (kind, paths) = match build.config.cmd {
540 Subcommand::Build { ref paths } => (Kind::Build, &paths[..]),
541 Subcommand::Check { ref paths } => (Kind::Check, &paths[..]),
542 Subcommand::Clippy { ref paths } => (Kind::Clippy, &paths[..]),
543 Subcommand::Fix { ref paths } => (Kind::Fix, &paths[..]),
544 Subcommand::Doc { ref paths, .. } => (Kind::Doc, &paths[..]),
545 Subcommand::Test { ref paths, .. } => (Kind::Test, &paths[..]),
546 Subcommand::Bench { ref paths, .. } => (Kind::Bench, &paths[..]),
547 Subcommand::Dist { ref paths } => (Kind::Dist, &paths[..]),
548 Subcommand::Install { ref paths } => (Kind::Install, &paths[..]),
549 Subcommand::Run { ref paths } => (Kind::Run, &paths[..]),
550 Subcommand::Format { .. } | Subcommand::Clean { .. } => panic!(),
555 top_stage: build.config.stage.unwrap_or(2),
558 stack: RefCell::new(Vec::new()),
559 time_spent_on_dependencies: Cell::new(Duration::new(0, 0)),
560 paths: paths.to_owned(),
564 pub fn execute_cli(&self) {
565 self.run_step_descriptions(&Builder::get_step_descriptions(self.kind), &self.paths);
568 pub fn default_doc(&self, paths: Option<&[PathBuf]>) {
569 let paths = paths.unwrap_or(&[]);
570 self.run_step_descriptions(&Builder::get_step_descriptions(Kind::Doc), paths);
573 fn run_step_descriptions(&self, v: &[StepDescription], paths: &[PathBuf]) {
574 StepDescription::run(v, self, paths);
577 /// Obtain a compiler at a given stage and for a given host. Explicitly does
578 /// not take `Compiler` since all `Compiler` instances are meant to be
579 /// obtained through this function, since it ensures that they are valid
580 /// (i.e., built and assembled).
581 pub fn compiler(&self, stage: u32, host: TargetSelection) -> Compiler {
582 self.ensure(compile::Assemble { target_compiler: Compiler { stage, host } })
585 /// Similar to `compiler`, except handles the full-bootstrap option to
586 /// silently use the stage1 compiler instead of a stage2 compiler if one is
589 /// Note that this does *not* have the side effect of creating
590 /// `compiler(stage, host)`, unlike `compiler` above which does have such
591 /// a side effect. The returned compiler here can only be used to compile
592 /// new artifacts, it can't be used to rely on the presence of a particular
595 /// See `force_use_stage1` for documentation on what each argument is.
599 host: TargetSelection,
600 target: TargetSelection,
602 if self.build.force_use_stage1(Compiler { stage, host }, target) {
603 self.compiler(1, self.config.build)
605 self.compiler(stage, host)
609 pub fn sysroot(&self, compiler: Compiler) -> Interned<PathBuf> {
610 self.ensure(compile::Sysroot { compiler })
613 /// Returns the libdir where the standard library and other artifacts are
614 /// found for a compiler's sysroot.
615 pub fn sysroot_libdir(&self, compiler: Compiler, target: TargetSelection) -> Interned<PathBuf> {
616 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
619 target: TargetSelection,
621 impl Step for Libdir {
622 type Output = Interned<PathBuf>;
624 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
628 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
629 let lib = builder.sysroot_libdir_relative(self.compiler);
630 let sysroot = builder
631 .sysroot(self.compiler)
634 .join(self.target.triple)
636 let _ = fs::remove_dir_all(&sysroot);
637 t!(fs::create_dir_all(&sysroot));
638 INTERNER.intern_path(sysroot)
641 self.ensure(Libdir { compiler, target })
644 /// Returns the compiler's libdir where it stores the dynamic libraries that
645 /// it itself links against.
647 /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
649 pub fn rustc_libdir(&self, compiler: Compiler) -> PathBuf {
650 if compiler.is_snapshot(self) {
651 self.rustc_snapshot_libdir()
653 match self.config.libdir_relative() {
654 Some(relative_libdir) if compiler.stage >= 1 => {
655 self.sysroot(compiler).join(relative_libdir)
657 _ => self.sysroot(compiler).join(libdir(compiler.host)),
662 /// Returns the compiler's relative libdir where it stores the dynamic libraries that
663 /// it itself links against.
665 /// For example this returns `lib` on Unix and `bin` on
667 pub fn libdir_relative(&self, compiler: Compiler) -> &Path {
668 if compiler.is_snapshot(self) {
669 libdir(self.config.build).as_ref()
671 match self.config.libdir_relative() {
672 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
673 _ => libdir(compiler.host).as_ref(),
678 /// Returns the compiler's relative libdir where the standard library and other artifacts are
679 /// found for a compiler's sysroot.
681 /// For example this returns `lib` on Unix and Windows.
682 pub fn sysroot_libdir_relative(&self, compiler: Compiler) -> &Path {
683 match self.config.libdir_relative() {
684 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
685 _ if compiler.stage == 0 => &self.build.initial_libdir,
686 _ => Path::new("lib"),
690 /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
691 /// library lookup path.
692 pub fn add_rustc_lib_path(&self, compiler: Compiler, cmd: &mut Cargo) {
693 // Windows doesn't need dylib path munging because the dlls for the
694 // compiler live next to the compiler and the system will find them
700 add_dylib_path(vec![self.rustc_libdir(compiler)], &mut cmd.command);
703 /// Gets a path to the compiler specified.
704 pub fn rustc(&self, compiler: Compiler) -> PathBuf {
705 if compiler.is_snapshot(self) {
706 self.initial_rustc.clone()
708 self.sysroot(compiler).join("bin").join(exe("rustc", compiler.host))
712 pub fn rustdoc(&self, compiler: Compiler) -> PathBuf {
713 self.ensure(tool::Rustdoc { compiler })
716 pub fn rustdoc_cmd(&self, compiler: Compiler) -> Command {
717 let mut cmd = Command::new(&self.out.join("bootstrap/debug/rustdoc"));
718 cmd.env("RUSTC_STAGE", compiler.stage.to_string())
719 .env("RUSTC_SYSROOT", self.sysroot(compiler))
720 // Note that this is *not* the sysroot_libdir because rustdoc must be linked
721 // equivalently to rustc.
722 .env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler))
723 .env("CFG_RELEASE_CHANNEL", &self.config.channel)
724 .env("RUSTDOC_REAL", self.rustdoc(compiler))
725 .env("RUSTDOC_CRATE_VERSION", self.rust_version())
726 .env("RUSTC_BOOTSTRAP", "1")
727 .arg("-Winvalid_codeblock_attributes");
728 if self.config.deny_warnings {
729 cmd.arg("-Dwarnings");
732 // Remove make-related flags that can cause jobserver problems.
733 cmd.env_remove("MAKEFLAGS");
734 cmd.env_remove("MFLAGS");
736 if let Some(linker) = self.linker(compiler.host, true) {
737 cmd.env("RUSTC_TARGET_LINKER", linker);
742 /// Return the path to `llvm-config` for the target, if it exists.
744 /// Note that this returns `None` if LLVM is disabled, or if we're in a
745 /// check build or dry-run, where there's no need to build all of LLVM.
746 fn llvm_config(&self, target: TargetSelection) -> Option<PathBuf> {
747 if self.config.llvm_enabled() && self.kind != Kind::Check && !self.config.dry_run {
748 let llvm_config = self.ensure(native::Llvm { target });
749 if llvm_config.is_file() {
750 return Some(llvm_config);
756 /// Prepares an invocation of `cargo` to be run.
758 /// This will create a `Command` that represents a pending execution of
759 /// Cargo. This cargo will be configured to use `compiler` as the actual
760 /// rustc compiler, its output will be scoped by `mode`'s output directory,
761 /// it will pass the `--target` flag for the specified `target`, and will be
762 /// executing the Cargo command `cmd`.
767 source_type: SourceType,
768 target: TargetSelection,
771 let mut cargo = Command::new(&self.initial_cargo);
772 let out_dir = self.stage_out(compiler, mode);
774 if cmd == "doc" || cmd == "rustdoc" {
775 let my_out = match mode {
776 // This is the intended out directory for compiler documentation.
777 Mode::Rustc | Mode::ToolRustc | Mode::Codegen => self.compiler_doc_out(target),
778 Mode::Std => out_dir.join(target.triple).join("doc"),
779 _ => panic!("doc mode {:?} not expected", mode),
781 let rustdoc = self.rustdoc(compiler);
782 self.clear_if_dirty(&my_out, &rustdoc);
785 cargo.env("CARGO_TARGET_DIR", &out_dir).arg(cmd);
787 let profile_var = |name: &str| {
788 let profile = if self.config.rust_optimize { "RELEASE" } else { "DEV" };
789 format!("CARGO_PROFILE_{}_{}", profile, name)
792 // See comment in librustc_llvm/build.rs for why this is necessary, largely llvm-config
793 // needs to not accidentally link to libLLVM in stage0/lib.
794 cargo.env("REAL_LIBRARY_PATH_VAR", &util::dylib_path_var());
795 if let Some(e) = env::var_os(util::dylib_path_var()) {
796 cargo.env("REAL_LIBRARY_PATH", e);
799 if cmd != "install" {
800 cargo.arg("--target").arg(target.rustc_target_arg());
802 assert_eq!(target, compiler.host);
805 // Set a flag for `check`/`clippy`/`fix`, so that certain build
806 // scripts can do less work (i.e. not building/requiring LLVM).
807 if cmd == "check" || cmd == "clippy" || cmd == "fix" {
808 // If we've not yet built LLVM, or it's stale, then bust
809 // the librustc_llvm cache. That will always work, even though it
810 // may mean that on the next non-check build we'll need to rebuild
811 // librustc_llvm. But if LLVM is stale, that'll be a tiny amount
812 // of work comparitively, and we'd likely need to rebuild it anyway,
814 if crate::native::prebuilt_llvm_config(self, target).is_err() {
815 cargo.env("RUST_CHECK", "1");
819 let stage = if compiler.stage == 0 && self.local_rebuild {
820 // Assume the local-rebuild rustc already has stage1 features.
826 let mut rustflags = Rustflags::new(target);
828 if let Ok(s) = env::var("CARGOFLAGS_NOT_BOOTSTRAP") {
829 cargo.args(s.split_whitespace());
831 rustflags.env("RUSTFLAGS_NOT_BOOTSTRAP");
833 if let Ok(s) = env::var("CARGOFLAGS_BOOTSTRAP") {
834 cargo.args(s.split_whitespace());
836 rustflags.env("RUSTFLAGS_BOOTSTRAP");
837 rustflags.arg("--cfg=bootstrap");
840 // FIXME: It might be better to use the same value for both `RUSTFLAGS` and `RUSTDOCFLAGS`,
841 // but this breaks CI. At the very least, stage0 `rustdoc` needs `--cfg bootstrap`. See
843 let mut rustdocflags = rustflags.clone();
845 if let Ok(s) = env::var("CARGOFLAGS") {
846 cargo.args(s.split_whitespace());
850 Mode::Std | Mode::ToolBootstrap | Mode::ToolStd => {}
851 Mode::Rustc | Mode::Codegen | Mode::ToolRustc => {
852 // Build proc macros both for the host and the target
853 if target != compiler.host && cmd != "check" {
854 cargo.arg("-Zdual-proc-macros");
855 rustflags.arg("-Zdual-proc-macros");
860 // This tells Cargo (and in turn, rustc) to output more complete
861 // dependency information. Most importantly for rustbuild, this
862 // includes sysroot artifacts, like libstd, which means that we don't
863 // need to track those in rustbuild (an error prone process!). This
864 // feature is currently unstable as there may be some bugs and such, but
865 // it represents a big improvement in rustbuild's reliability on
866 // rebuilds, so we're using it here.
868 // For some additional context, see #63470 (the PR originally adding
869 // this), as well as #63012 which is the tracking issue for this
870 // feature on the rustc side.
871 cargo.arg("-Zbinary-dep-depinfo");
873 cargo.arg("-j").arg(self.jobs().to_string());
874 // Remove make-related flags to ensure Cargo can correctly set things up
875 cargo.env_remove("MAKEFLAGS");
876 cargo.env_remove("MFLAGS");
878 // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
879 // Force cargo to output binaries with disambiguating hashes in the name
880 let mut metadata = if compiler.stage == 0 {
881 // Treat stage0 like a special channel, whether it's a normal prior-
882 // release rustc or a local rebuild with the same version, so we
883 // never mix these libraries by accident.
884 "bootstrap".to_string()
886 self.config.channel.to_string()
888 // We want to make sure that none of the dependencies between
889 // std/test/rustc unify with one another. This is done for weird linkage
890 // reasons but the gist of the problem is that if librustc, libtest, and
891 // libstd all depend on libc from crates.io (which they actually do) we
892 // want to make sure they all get distinct versions. Things get really
893 // weird if we try to unify all these dependencies right now, namely
894 // around how many times the library is linked in dynamic libraries and
895 // such. If rustc were a static executable or if we didn't ship dylibs
896 // this wouldn't be a problem, but we do, so it is. This is in general
897 // just here to make sure things build right. If you can remove this and
898 // things still build right, please do!
900 Mode::Std => metadata.push_str("std"),
901 // When we're building rustc tools, they're built with a search path
902 // that contains things built during the rustc build. For example,
903 // bitflags is built during the rustc build, and is a dependency of
904 // rustdoc as well. We're building rustdoc in a different target
905 // directory, though, which means that Cargo will rebuild the
906 // dependency. When we go on to build rustdoc, we'll look for
907 // bitflags, and find two different copies: one built during the
908 // rustc step and one that we just built. This isn't always a
909 // problem, somehow -- not really clear why -- but we know that this
911 Mode::ToolRustc => metadata.push_str("tool-rustc"),
914 cargo.env("__CARGO_DEFAULT_LIB_METADATA", &metadata);
917 rustflags.arg("-Zforce-unstable-if-unmarked");
920 rustflags.arg("-Zmacro-backtrace");
922 let want_rustdoc = self.doc_tests != DocTests::No;
924 // We synthetically interpret a stage0 compiler used to build tools as a
925 // "raw" compiler in that it's the exact snapshot we download. Normally
926 // the stage0 build means it uses libraries build by the stage0
927 // compiler, but for tools we just use the precompiled libraries that
929 let use_snapshot = mode == Mode::ToolBootstrap;
930 assert!(!use_snapshot || stage == 0 || self.local_rebuild);
932 let maybe_sysroot = self.sysroot(compiler);
933 let sysroot = if use_snapshot { self.rustc_snapshot_sysroot() } else { &maybe_sysroot };
934 let libdir = self.rustc_libdir(compiler);
936 // Clear the output directory if the real rustc we're using has changed;
937 // Cargo cannot detect this as it thinks rustc is bootstrap/debug/rustc.
939 // Avoid doing this during dry run as that usually means the relevant
940 // compiler is not yet linked/copied properly.
942 // Only clear out the directory if we're compiling std; otherwise, we
943 // should let Cargo take care of things for us (via depdep info)
944 if !self.config.dry_run && mode == Mode::Std && cmd == "build" {
945 self.clear_if_dirty(&out_dir, &self.rustc(compiler));
948 // Customize the compiler we're running. Specify the compiler to cargo
949 // as our shim and then pass it some various options used to configure
950 // how the actual compiler itself is called.
952 // These variables are primarily all read by
953 // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
955 .env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
956 .env("RUSTC", self.out.join("bootstrap/debug/rustc"))
957 .env("RUSTC_REAL", self.rustc(compiler))
958 .env("RUSTC_STAGE", stage.to_string())
959 .env("RUSTC_SYSROOT", &sysroot)
960 .env("RUSTC_LIBDIR", &libdir)
961 .env("RUSTDOC", self.out.join("bootstrap/debug/rustdoc"))
964 if cmd == "doc" || cmd == "rustdoc" || (cmd == "test" && want_rustdoc) {
965 self.rustdoc(compiler)
967 PathBuf::from("/path/to/nowhere/rustdoc/not/required")
970 .env("RUSTC_ERROR_METADATA_DST", self.extended_error_dir())
971 .env("RUSTC_BREAK_ON_ICE", "1");
973 // Dealing with rpath here is a little special, so let's go into some
974 // detail. First off, `-rpath` is a linker option on Unix platforms
975 // which adds to the runtime dynamic loader path when looking for
976 // dynamic libraries. We use this by default on Unix platforms to ensure
977 // that our nightlies behave the same on Windows, that is they work out
978 // of the box. This can be disabled, of course, but basically that's why
979 // we're gated on RUSTC_RPATH here.
981 // Ok, so the astute might be wondering "why isn't `-C rpath` used
982 // here?" and that is indeed a good question to ask. This codegen
983 // option is the compiler's current interface to generating an rpath.
984 // Unfortunately it doesn't quite suffice for us. The flag currently
985 // takes no value as an argument, so the compiler calculates what it
986 // should pass to the linker as `-rpath`. This unfortunately is based on
987 // the **compile time** directory structure which when building with
988 // Cargo will be very different than the runtime directory structure.
990 // All that's a really long winded way of saying that if we use
991 // `-Crpath` then the executables generated have the wrong rpath of
992 // something like `$ORIGIN/deps` when in fact the way we distribute
993 // rustc requires the rpath to be `$ORIGIN/../lib`.
995 // So, all in all, to set up the correct rpath we pass the linker
996 // argument manually via `-C link-args=-Wl,-rpath,...`. Plus isn't it
997 // fun to pass a flag to a tool to pass a flag to pass a flag to a tool
998 // to change a flag in a binary?
999 if self.config.rust_rpath && util::use_host_linker(target) {
1000 let rpath = if target.contains("apple") {
1001 // Note that we need to take one extra step on macOS to also pass
1002 // `-Wl,-instal_name,@rpath/...` to get things to work right. To
1003 // do that we pass a weird flag to the compiler to get it to do
1004 // so. Note that this is definitely a hack, and we should likely
1005 // flesh out rpath support more fully in the future.
1006 rustflags.arg("-Zosx-rpath-install-name");
1007 Some("-Wl,-rpath,@loader_path/../lib")
1008 } else if !target.contains("windows") {
1009 Some("-Wl,-rpath,$ORIGIN/../lib")
1013 if let Some(rpath) = rpath {
1014 rustflags.arg(&format!("-Clink-args={}", rpath));
1018 // FIXME: Don't use LLD if we're compiling libtest, since it fails to link it.
1019 // See https://github.com/rust-lang/rust/issues/68647.
1020 let can_use_lld = mode != Mode::Std;
1022 if let Some(host_linker) = self.linker(compiler.host, can_use_lld) {
1023 cargo.env("RUSTC_HOST_LINKER", host_linker);
1026 if let Some(target_linker) = self.linker(target, can_use_lld) {
1027 let target = crate::envify(&target.triple);
1028 cargo.env(&format!("CARGO_TARGET_{}_LINKER", target), target_linker);
1030 if !(["build", "check", "clippy", "fix", "rustc"].contains(&cmd)) && want_rustdoc {
1031 cargo.env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler));
1034 let debuginfo_level = match mode {
1035 Mode::Rustc | Mode::Codegen => self.config.rust_debuginfo_level_rustc,
1036 Mode::Std => self.config.rust_debuginfo_level_std,
1037 Mode::ToolBootstrap | Mode::ToolStd | Mode::ToolRustc => {
1038 self.config.rust_debuginfo_level_tools
1041 cargo.env(profile_var("DEBUG"), debuginfo_level.to_string());
1043 profile_var("DEBUG_ASSERTIONS"),
1044 if mode == Mode::Std {
1045 self.config.rust_debug_assertions_std.to_string()
1047 self.config.rust_debug_assertions.to_string()
1051 if !mode.is_tool() {
1052 cargo.env("RUSTC_FORCE_UNSTABLE", "1");
1055 if let Some(x) = self.crt_static(target) {
1057 rustflags.arg("-Ctarget-feature=+crt-static");
1059 rustflags.arg("-Ctarget-feature=-crt-static");
1063 if let Some(x) = self.crt_static(compiler.host) {
1064 cargo.env("RUSTC_HOST_CRT_STATIC", x.to_string());
1067 if let Some(map_to) = self.build.debuginfo_map_to(GitRepo::Rustc) {
1068 let map = format!("{}={}", self.build.src.display(), map_to);
1069 cargo.env("RUSTC_DEBUGINFO_MAP", map);
1071 // `rustc` needs to know the virtual `/rustc/$hash` we're mapping to,
1072 // in order to opportunistically reverse it later.
1073 cargo.env("CFG_VIRTUAL_RUST_SOURCE_BASE_DIR", map_to);
1076 // Enable usage of unstable features
1077 cargo.env("RUSTC_BOOTSTRAP", "1");
1078 self.add_rust_test_threads(&mut cargo);
1080 // Almost all of the crates that we compile as part of the bootstrap may
1081 // have a build script, including the standard library. To compile a
1082 // build script, however, it itself needs a standard library! This
1083 // introduces a bit of a pickle when we're compiling the standard
1086 // To work around this we actually end up using the snapshot compiler
1087 // (stage0) for compiling build scripts of the standard library itself.
1088 // The stage0 compiler is guaranteed to have a libstd available for use.
1090 // For other crates, however, we know that we've already got a standard
1091 // library up and running, so we can use the normal compiler to compile
1092 // build scripts in that situation.
1093 if mode == Mode::Std {
1095 .env("RUSTC_SNAPSHOT", &self.initial_rustc)
1096 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
1099 .env("RUSTC_SNAPSHOT", self.rustc(compiler))
1100 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
1103 // Tools that use compiler libraries may inherit the `-lLLVM` link
1104 // requirement, but the `-L` library path is not propagated across
1105 // separate Cargo projects. We can add LLVM's library path to the
1106 // platform-specific environment variable as a workaround.
1107 if mode == Mode::ToolRustc {
1108 if let Some(llvm_config) = self.llvm_config(target) {
1109 let llvm_libdir = output(Command::new(&llvm_config).arg("--libdir"));
1110 add_link_lib_path(vec![llvm_libdir.trim().into()], &mut cargo);
1114 if self.config.incremental {
1115 cargo.env("CARGO_INCREMENTAL", "1");
1117 // Don't rely on any default setting for incr. comp. in Cargo
1118 cargo.env("CARGO_INCREMENTAL", "0");
1121 if let Some(ref on_fail) = self.config.on_fail {
1122 cargo.env("RUSTC_ON_FAIL", on_fail);
1125 if self.config.print_step_timings {
1126 cargo.env("RUSTC_PRINT_STEP_TIMINGS", "1");
1129 if self.config.backtrace_on_ice {
1130 cargo.env("RUSTC_BACKTRACE_ON_ICE", "1");
1133 cargo.env("RUSTC_VERBOSE", self.verbosity.to_string());
1135 if source_type == SourceType::InTree {
1136 let mut lint_flags = Vec::new();
1137 // When extending this list, add the new lints to the RUSTFLAGS of the
1138 // build_bootstrap function of src/bootstrap/bootstrap.py as well as
1139 // some code doesn't go through this `rustc` wrapper.
1140 lint_flags.push("-Wrust_2018_idioms");
1141 lint_flags.push("-Wunused_lifetimes");
1143 if self.config.deny_warnings {
1144 lint_flags.push("-Dwarnings");
1145 rustdocflags.arg("-Dwarnings");
1148 // FIXME(#58633) hide "unused attribute" errors in incremental
1149 // builds of the standard library, as the underlying checks are
1150 // not yet properly integrated with incremental recompilation.
1151 if mode == Mode::Std && compiler.stage == 0 && self.config.incremental {
1152 lint_flags.push("-Aunused-attributes");
1154 // This does not use RUSTFLAGS due to caching issues with Cargo.
1155 // Clippy is treated as an "in tree" tool, but shares the same
1156 // cache as other "submodule" tools. With these options set in
1157 // RUSTFLAGS, that causes *every* shared dependency to be rebuilt.
1158 // By injecting this into the rustc wrapper, this circumvents
1159 // Cargo's fingerprint detection. This is fine because lint flags
1160 // are always ignored in dependencies. Eventually this should be
1161 // fixed via better support from Cargo.
1162 cargo.env("RUSTC_LINT_FLAGS", lint_flags.join(" "));
1164 rustdocflags.arg("-Winvalid_codeblock_attributes");
1167 if let Mode::Rustc | Mode::Codegen = mode {
1168 rustflags.arg("-Zunstable-options");
1169 rustflags.arg("-Wrustc::internal");
1172 // Throughout the build Cargo can execute a number of build scripts
1173 // compiling C/C++ code and we need to pass compilers, archivers, flags, etc
1174 // obtained previously to those build scripts.
1175 // Build scripts use either the `cc` crate or `configure/make` so we pass
1176 // the options through environment variables that are fetched and understood by both.
1178 // FIXME: the guard against msvc shouldn't need to be here
1179 if target.contains("msvc") {
1180 if let Some(ref cl) = self.config.llvm_clang_cl {
1181 cargo.env("CC", cl).env("CXX", cl);
1184 let ccache = self.config.ccache.as_ref();
1185 let ccacheify = |s: &Path| {
1186 let ccache = match ccache {
1188 None => return s.display().to_string(),
1190 // FIXME: the cc-rs crate only recognizes the literal strings
1191 // `ccache` and `sccache` when doing caching compilations, so we
1192 // mirror that here. It should probably be fixed upstream to
1193 // accept a new env var or otherwise work with custom ccache
1196 "ccache" | "sccache" => format!("{} {}", ccache, s.display()),
1197 _ => s.display().to_string(),
1200 let cc = ccacheify(&self.cc(target));
1201 cargo.env(format!("CC_{}", target.triple), &cc);
1203 let cflags = self.cflags(target, GitRepo::Rustc).join(" ");
1204 cargo.env(format!("CFLAGS_{}", target.triple), cflags.clone());
1206 if let Some(ar) = self.ar(target) {
1207 let ranlib = format!("{} s", ar.display());
1209 .env(format!("AR_{}", target.triple), ar)
1210 .env(format!("RANLIB_{}", target.triple), ranlib);
1213 if let Ok(cxx) = self.cxx(target) {
1214 let cxx = ccacheify(&cxx);
1216 .env(format!("CXX_{}", target.triple), &cxx)
1217 .env(format!("CXXFLAGS_{}", target.triple), cflags);
1221 if mode == Mode::Std && self.config.extended && compiler.is_final_stage(self) {
1222 rustflags.arg("-Zsave-analysis");
1224 "RUST_SAVE_ANALYSIS_CONFIG",
1225 "{\"output_file\": null,\"full_docs\": false,\
1226 \"pub_only\": true,\"reachable_only\": false,\
1227 \"distro_crate\": true,\"signatures\": false,\"borrow_data\": false}",
1231 // If Control Flow Guard is enabled, pass the `control-flow-guard` flag to rustc
1232 // when compiling the standard library, since this might be linked into the final outputs
1233 // produced by rustc. Since this mitigation is only available on Windows, only enable it
1234 // for the standard library in case the compiler is run on a non-Windows platform.
1235 // This is not needed for stage 0 artifacts because these will only be used for building
1236 // the stage 1 compiler.
1238 && mode == Mode::Std
1239 && self.config.control_flow_guard
1240 && compiler.stage >= 1
1242 rustflags.arg("-Zcontrol-flow-guard");
1245 // For `cargo doc` invocations, make rustdoc print the Rust version into the docs
1246 cargo.env("RUSTDOC_CRATE_VERSION", self.rust_version());
1248 // Environment variables *required* throughout the build
1250 // FIXME: should update code to not require this env var
1251 cargo.env("CFG_COMPILER_HOST_TRIPLE", target.triple);
1253 // Set this for all builds to make sure doc builds also get it.
1254 cargo.env("CFG_RELEASE_CHANNEL", &self.config.channel);
1256 // This one's a bit tricky. As of the time of this writing the compiler
1257 // links to the `winapi` crate on crates.io. This crate provides raw
1258 // bindings to Windows system functions, sort of like libc does for
1259 // Unix. This crate also, however, provides "import libraries" for the
1260 // MinGW targets. There's an import library per dll in the windows
1261 // distribution which is what's linked to. These custom import libraries
1262 // are used because the winapi crate can reference Windows functions not
1263 // present in the MinGW import libraries.
1265 // For example MinGW may ship libdbghelp.a, but it may not have
1266 // references to all the functions in the dbghelp dll. Instead the
1267 // custom import library for dbghelp in the winapi crates has all this
1270 // Unfortunately for us though the import libraries are linked by
1271 // default via `-ldylib=winapi_foo`. That is, they're linked with the
1272 // `dylib` type with a `winapi_` prefix (so the winapi ones don't
1273 // conflict with the system MinGW ones). This consequently means that
1274 // the binaries we ship of things like rustc_codegen_llvm (aka the rustc_codegen_llvm
1275 // DLL) when linked against *again*, for example with procedural macros
1276 // or plugins, will trigger the propagation logic of `-ldylib`, passing
1277 // `-lwinapi_foo` to the linker again. This isn't actually available in
1278 // our distribution, however, so the link fails.
1280 // To solve this problem we tell winapi to not use its bundled import
1281 // libraries. This means that it will link to the system MinGW import
1282 // libraries by default, and the `-ldylib=foo` directives will still get
1283 // passed to the final linker, but they'll look like `-lfoo` which can
1284 // be resolved because MinGW has the import library. The downside is we
1285 // don't get newer functions from Windows, but we don't use any of them
1287 if !mode.is_tool() {
1288 cargo.env("WINAPI_NO_BUNDLED_LIBRARIES", "1");
1291 for _ in 1..self.verbosity {
1295 match (mode, self.config.rust_codegen_units_std, self.config.rust_codegen_units) {
1296 (Mode::Std, Some(n), _) | (_, _, Some(n)) => {
1297 cargo.env(profile_var("CODEGEN_UNITS"), n.to_string());
1300 // Don't set anything
1304 if self.config.rust_optimize {
1305 // FIXME: cargo bench/install do not accept `--release`
1306 if cmd != "bench" && cmd != "install" {
1307 cargo.arg("--release");
1311 if self.config.locked_deps {
1312 cargo.arg("--locked");
1314 if self.config.vendor || self.is_sudo {
1315 cargo.arg("--frozen");
1318 // Try to use a sysroot-relative bindir, in case it was configured absolutely.
1319 cargo.env("RUSTC_INSTALL_BINDIR", self.config.bindir_relative());
1321 self.ci_env.force_coloring_in_ci(&mut cargo);
1323 // When we build Rust dylibs they're all intended for intermediate
1324 // usage, so make sure we pass the -Cprefer-dynamic flag instead of
1325 // linking all deps statically into the dylib.
1326 if let Mode::Std | Mode::Rustc | Mode::Codegen = mode {
1327 rustflags.arg("-Cprefer-dynamic");
1330 // When building incrementally we default to a lower ThinLTO import limit
1331 // (unless explicitly specified otherwise). This will produce a somewhat
1332 // slower code but give way better compile times.
1334 let limit = match self.config.rust_thin_lto_import_instr_limit {
1335 Some(limit) => Some(limit),
1336 None if self.config.incremental => Some(10),
1340 if let Some(limit) = limit {
1341 rustflags.arg(&format!("-Cllvm-args=-import-instr-limit={}", limit));
1345 Cargo { command: cargo, rustflags, rustdocflags }
1348 /// Ensure that a given step is built, returning its output. This will
1349 /// cache the step, so it is safe (and good!) to call this as often as
1350 /// needed to ensure that all dependencies are built.
1351 pub fn ensure<S: Step>(&'a self, step: S) -> S::Output {
1353 let mut stack = self.stack.borrow_mut();
1354 for stack_step in stack.iter() {
1356 if stack_step.downcast_ref::<S>().map_or(true, |stack_step| *stack_step != step) {
1359 let mut out = String::new();
1360 out += &format!("\n\nCycle in build detected when adding {:?}\n", step);
1361 for el in stack.iter().rev() {
1362 out += &format!("\t{:?}\n", el);
1366 if let Some(out) = self.cache.get(&step) {
1367 self.verbose(&format!("{}c {:?}", " ".repeat(stack.len()), step));
1371 self.verbose(&format!("{}> {:?}", " ".repeat(stack.len()), step));
1372 stack.push(Box::new(step.clone()));
1376 let start = Instant::now();
1377 let zero = Duration::new(0, 0);
1378 let parent = self.time_spent_on_dependencies.replace(zero);
1379 let out = step.clone().run(self);
1380 let dur = start.elapsed();
1381 let deps = self.time_spent_on_dependencies.replace(parent + dur);
1385 if self.config.print_step_timings && dur > Duration::from_millis(100) {
1386 println!("[TIMING] {:?} -- {}.{:03}", step, dur.as_secs(), dur.subsec_millis());
1390 let mut stack = self.stack.borrow_mut();
1391 let cur_step = stack.pop().expect("step stack empty");
1392 assert_eq!(cur_step.downcast_ref(), Some(&step));
1394 self.verbose(&format!("{}< {:?}", " ".repeat(self.stack.borrow().len()), step));
1395 self.cache.put(step, out.clone());
1403 #[derive(Debug, Clone)]
1404 struct Rustflags(String);
1407 fn new(target: TargetSelection) -> Rustflags {
1408 let mut ret = Rustflags(String::new());
1410 // Inherit `RUSTFLAGS` by default ...
1411 ret.env("RUSTFLAGS");
1413 // ... and also handle target-specific env RUSTFLAGS if they're
1415 let target_specific = format!("CARGO_TARGET_{}_RUSTFLAGS", crate::envify(&target.triple));
1416 ret.env(&target_specific);
1421 fn env(&mut self, env: &str) {
1422 if let Ok(s) = env::var(env) {
1423 for part in s.split_whitespace() {
1429 fn arg(&mut self, arg: &str) -> &mut Self {
1430 assert_eq!(arg.split_whitespace().count(), 1);
1431 if !self.0.is_empty() {
1432 self.0.push_str(" ");
1434 self.0.push_str(arg);
1442 rustflags: Rustflags,
1443 rustdocflags: Rustflags,
1447 pub fn rustdocflag(&mut self, arg: &str) -> &mut Cargo {
1448 self.rustdocflags.arg(arg);
1451 pub fn rustflag(&mut self, arg: &str) -> &mut Cargo {
1452 self.rustflags.arg(arg);
1456 pub fn arg(&mut self, arg: impl AsRef<OsStr>) -> &mut Cargo {
1457 self.command.arg(arg.as_ref());
1461 pub fn args<I, S>(&mut self, args: I) -> &mut Cargo
1463 I: IntoIterator<Item = S>,
1467 self.arg(arg.as_ref());
1472 pub fn env(&mut self, key: impl AsRef<OsStr>, value: impl AsRef<OsStr>) -> &mut Cargo {
1473 // These are managed through rustflag/rustdocflag interfaces.
1474 assert_ne!(key.as_ref(), "RUSTFLAGS");
1475 assert_ne!(key.as_ref(), "RUSTDOCFLAGS");
1476 self.command.env(key.as_ref(), value.as_ref());
1481 impl From<Cargo> for Command {
1482 fn from(mut cargo: Cargo) -> Command {
1483 let rustflags = &cargo.rustflags.0;
1484 if !rustflags.is_empty() {
1485 cargo.command.env("RUSTFLAGS", rustflags);
1488 let rustdocflags = &cargo.rustdocflags.0;
1489 if !rustdocflags.is_empty() {
1490 cargo.command.env("RUSTDOCFLAGS", rustdocflags);