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::{Color, 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;
32 // FIXME: replace with std::lazy after it gets stabilized and reaches beta
33 use once_cell::sync::Lazy;
35 pub struct Builder<'a> {
40 stack: RefCell<Vec<Box<dyn Any>>>,
41 time_spent_on_dependencies: Cell<Duration>,
42 pub paths: Vec<PathBuf>,
45 impl<'a> Deref for Builder<'a> {
48 fn deref(&self) -> &Self::Target {
53 pub trait Step: 'static + Clone + Debug + PartialEq + Eq + Hash {
54 /// `PathBuf` when directories are created or to return a `Compiler` once
55 /// it's been assembled.
58 /// Whether this step is run by default as part of its respective phase.
59 /// `true` here can still be overwritten by `should_run` calling `default_condition`.
60 const DEFAULT: bool = false;
62 /// If true, then this rule should be skipped if --target was specified, but --host was not
63 const ONLY_HOSTS: bool = false;
65 /// Primary function to execute this rule. Can call `builder.ensure()`
66 /// with other steps to run those.
67 fn run(self, builder: &Builder<'_>) -> Self::Output;
69 /// When bootstrap is passed a set of paths, this controls whether this rule
70 /// will execute. However, it does not get called in a "default" context
71 /// when we are not passed any paths; in that case, `make_run` is called
73 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_>;
75 /// Builds up a "root" rule, either as a default rule or from a path passed
78 /// When path is `None`, we are executing in a context where no paths were
79 /// passed. When `./x.py build` is run, for example, this rule could get
80 /// called if it is in the correct list below with a path of `None`.
81 fn make_run(_run: RunConfig<'_>) {
82 // It is reasonable to not have an implementation of make_run for rules
83 // who do not want to get called from the root context. This means that
84 // they are likely dependencies (e.g., sysroot creation) or similar, and
85 // as such calling them from ./x.py isn't logical.
90 pub struct RunConfig<'a> {
91 pub builder: &'a Builder<'a>,
92 pub target: TargetSelection,
97 pub fn build_triple(&self) -> TargetSelection {
98 self.builder.build.build
102 struct StepDescription {
105 should_run: fn(ShouldRun<'_>) -> ShouldRun<'_>,
106 make_run: fn(RunConfig<'_>),
110 /// Collection of paths used to match a task rule.
111 #[derive(Debug, Clone, PartialOrd, Ord, PartialEq, Eq)]
113 /// A collection of individual paths.
115 /// These are generally matched as a path suffix. For example, a
116 /// command-line value of `libstd` will match if `src/libstd` is in the
118 Set(BTreeSet<PathBuf>),
119 /// A "suite" of paths.
121 /// These can match as a path suffix (like `Set`), or as a prefix. For
122 /// example, a command-line value of `src/test/ui/abi/variadic-ffi.rs`
123 /// will match `src/test/ui`. A command-line value of `ui` would also
124 /// match `src/test/ui`.
129 fn empty() -> PathSet {
130 PathSet::Set(BTreeSet::new())
133 fn one<P: Into<PathBuf>>(path: P) -> PathSet {
134 let mut set = BTreeSet::new();
135 set.insert(path.into());
139 fn has(&self, needle: &Path) -> bool {
141 PathSet::Set(set) => set.iter().any(|p| p.ends_with(needle)),
142 PathSet::Suite(suite) => suite.ends_with(needle),
146 fn path(&self, builder: &Builder<'_>) -> PathBuf {
148 PathSet::Set(set) => set.iter().next().unwrap_or(&builder.build.src).to_path_buf(),
149 PathSet::Suite(path) => PathBuf::from(path),
154 impl StepDescription {
155 fn from<S: Step>() -> StepDescription {
158 only_hosts: S::ONLY_HOSTS,
159 should_run: S::should_run,
160 make_run: S::make_run,
161 name: std::any::type_name::<S>(),
165 fn maybe_run(&self, builder: &Builder<'_>, pathset: &PathSet) {
166 if builder.config.exclude.iter().any(|e| pathset.has(e)) {
167 eprintln!("Skipping {:?} because it is excluded", pathset);
169 } else if !builder.config.exclude.is_empty() {
171 "{:?} not skipped for {:?} -- not in {:?}",
172 pathset, self.name, builder.config.exclude
176 // Determine the targets participating in this rule.
177 let targets = if self.only_hosts { &builder.hosts } else { &builder.targets };
179 for target in targets {
180 let run = RunConfig { builder, path: pathset.path(builder), target: *target };
181 (self.make_run)(run);
185 fn run(v: &[StepDescription], builder: &Builder<'_>, paths: &[PathBuf]) {
187 v.iter().map(|desc| (desc.should_run)(ShouldRun::new(builder))).collect::<Vec<_>>();
189 // sanity checks on rules
190 for (desc, should_run) in v.iter().zip(&should_runs) {
192 !should_run.paths.is_empty(),
193 "{:?} should have at least one pathset",
198 if paths.is_empty() || builder.config.include_default_paths {
199 for (desc, should_run) in v.iter().zip(&should_runs) {
200 if desc.default && should_run.is_really_default() {
201 for pathset in &should_run.paths {
202 desc.maybe_run(builder, pathset);
209 // strip CurDir prefix if present
210 let path = match path.strip_prefix(".") {
215 let mut attempted_run = false;
216 for (desc, should_run) in v.iter().zip(&should_runs) {
217 if let Some(suite) = should_run.is_suite_path(path) {
218 attempted_run = true;
219 desc.maybe_run(builder, suite);
220 } else if let Some(pathset) = should_run.pathset_for_path(path) {
221 attempted_run = true;
222 desc.maybe_run(builder, pathset);
227 panic!("error: no rules matched {}", path.display());
233 enum ReallyDefault<'a> {
235 Lazy(Lazy<bool, Box<dyn Fn() -> bool + 'a>>),
238 pub struct ShouldRun<'a> {
239 pub builder: &'a Builder<'a>,
240 // use a BTreeSet to maintain sort order
241 paths: BTreeSet<PathSet>,
243 // If this is a default rule, this is an additional constraint placed on
244 // its run. Generally something like compiler docs being enabled.
245 is_really_default: ReallyDefault<'a>,
248 impl<'a> ShouldRun<'a> {
249 fn new(builder: &'a Builder<'_>) -> ShouldRun<'a> {
252 paths: BTreeSet::new(),
253 is_really_default: ReallyDefault::Bool(true), // by default no additional conditions
257 pub fn default_condition(mut self, cond: bool) -> Self {
258 self.is_really_default = ReallyDefault::Bool(cond);
262 pub fn lazy_default_condition(mut self, lazy_cond: Box<dyn Fn() -> bool + 'a>) -> Self {
263 self.is_really_default = ReallyDefault::Lazy(Lazy::new(lazy_cond));
267 pub fn is_really_default(&self) -> bool {
268 match &self.is_really_default {
269 ReallyDefault::Bool(val) => *val,
270 ReallyDefault::Lazy(lazy) => *lazy.deref(),
274 /// Indicates it should run if the command-line selects the given crate or
275 /// any of its (local) dependencies.
277 /// Compared to `krate`, this treats the dependencies as aliases for the
278 /// same job. Generally it is preferred to use `krate`, and treat each
279 /// individual path separately. For example `./x.py test src/liballoc`
280 /// (which uses `krate`) will test just `liballoc`. However, `./x.py check
281 /// src/liballoc` (which uses `all_krates`) will check all of `libtest`.
282 /// `all_krates` should probably be removed at some point.
283 pub fn all_krates(mut self, name: &str) -> Self {
284 let mut set = BTreeSet::new();
285 for krate in self.builder.in_tree_crates(name, None) {
286 let path = krate.local_path(self.builder);
289 self.paths.insert(PathSet::Set(set));
293 /// Indicates it should run if the command-line selects the given crate or
294 /// any of its (local) dependencies.
296 /// `make_run` will be called separately for each matching command-line path.
297 pub fn krate(mut self, name: &str) -> Self {
298 for krate in self.builder.in_tree_crates(name, None) {
299 let path = krate.local_path(self.builder);
300 self.paths.insert(PathSet::one(path));
305 // single, non-aliased path
306 pub fn path(self, path: &str) -> Self {
310 // multiple aliases for the same job
311 pub fn paths(mut self, paths: &[&str]) -> Self {
312 self.paths.insert(PathSet::Set(paths.iter().map(PathBuf::from).collect()));
316 pub fn is_suite_path(&self, path: &Path) -> Option<&PathSet> {
317 self.paths.iter().find(|pathset| match pathset {
318 PathSet::Suite(p) => path.starts_with(p),
319 PathSet::Set(_) => false,
323 pub fn suite_path(mut self, suite: &str) -> Self {
324 self.paths.insert(PathSet::Suite(PathBuf::from(suite)));
328 // allows being more explicit about why should_run in Step returns the value passed to it
329 pub fn never(mut self) -> ShouldRun<'a> {
330 self.paths.insert(PathSet::empty());
334 fn pathset_for_path(&self, path: &Path) -> Option<&PathSet> {
335 self.paths.iter().find(|pathset| pathset.has(path))
339 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
354 impl<'a> Builder<'a> {
355 fn get_step_descriptions(kind: Kind) -> Vec<StepDescription> {
356 macro_rules! describe {
357 ($($rule:ty),+ $(,)?) => {{
358 vec![$(StepDescription::from::<$rule>()),+]
362 Kind::Build => describe!(
365 compile::CodegenBackend,
366 compile::StartupObjects,
370 tool::UnstableBookGen,
375 tool::RemoteTestServer,
376 tool::RemoteTestClient,
393 Kind::Check | Kind::Clippy { .. } | Kind::Fix | Kind::Format => describe!(
397 check::CodegenBackend,
404 Kind::Test => describe!(
405 crate::toolstate::ToolStateCheck,
406 test::ExpandYamlAnchors,
409 test::RunPassValgrind,
422 test::CrateRustdocJsonTypes,
430 test::RunMakeFullDeps,
446 test::CompiletestTest,
448 test::RustdocJSNotStd,
454 // Run bootstrap close to the end as it's unlikely to fail
456 // Run run-make last, since these won't pass without make on Windows
459 Kind::Bench => describe!(test::Crate, test::CrateLibrustc),
460 Kind::Doc => describe!(
462 doc::UnstableBookGen,
478 Kind::Dist => describe!(
483 dist::DebuggerScripts,
488 dist::PlainSourceTarball,
500 dist::ReproducibleArtifacts,
502 Kind::Install => describe!(
507 install::RustAnalyzer,
509 install::RustDemangler,
516 Kind::Run => describe!(run::ExpandYamlAnchors, run::BuildManifest),
520 pub fn get_help(build: &Build, subcommand: &str) -> Option<String> {
521 let kind = match subcommand {
522 "build" => Kind::Build,
524 "test" => Kind::Test,
525 "bench" => Kind::Bench,
526 "dist" => Kind::Dist,
527 "install" => Kind::Install,
531 let builder = Self::new_internal(build, kind, vec![]);
532 let builder = &builder;
533 let mut should_run = ShouldRun::new(builder);
534 for desc in Builder::get_step_descriptions(builder.kind) {
535 should_run = (desc.should_run)(should_run);
537 let mut help = String::from("Available paths:\n");
538 let mut add_path = |path: &Path| {
539 help.push_str(&format!(" ./x.py {} {}\n", subcommand, path.display()));
541 for pathset in should_run.paths {
543 PathSet::Set(set) => {
548 PathSet::Suite(path) => {
549 add_path(&path.join("..."));
556 fn new_internal(build: &Build, kind: Kind, paths: Vec<PathBuf>) -> Builder<'_> {
559 top_stage: build.config.stage,
562 stack: RefCell::new(Vec::new()),
563 time_spent_on_dependencies: Cell::new(Duration::new(0, 0)),
568 pub fn new(build: &Build) -> Builder<'_> {
569 let (kind, paths) = match build.config.cmd {
570 Subcommand::Build { ref paths } => (Kind::Build, &paths[..]),
571 Subcommand::Check { ref paths, all_targets: _ } => (Kind::Check, &paths[..]),
572 Subcommand::Clippy { ref paths, .. } => (Kind::Clippy, &paths[..]),
573 Subcommand::Fix { ref paths } => (Kind::Fix, &paths[..]),
574 Subcommand::Doc { ref paths, .. } => (Kind::Doc, &paths[..]),
575 Subcommand::Test { ref paths, .. } => (Kind::Test, &paths[..]),
576 Subcommand::Bench { ref paths, .. } => (Kind::Bench, &paths[..]),
577 Subcommand::Dist { ref paths } => (Kind::Dist, &paths[..]),
578 Subcommand::Install { ref paths } => (Kind::Install, &paths[..]),
579 Subcommand::Run { ref paths } => (Kind::Run, &paths[..]),
580 Subcommand::Format { .. } | Subcommand::Clean { .. } | Subcommand::Setup { .. } => {
585 Self::new_internal(build, kind, paths.to_owned())
588 pub fn execute_cli(&self) {
589 self.run_step_descriptions(&Builder::get_step_descriptions(self.kind), &self.paths);
592 pub fn default_doc(&self, paths: &[PathBuf]) {
593 self.run_step_descriptions(&Builder::get_step_descriptions(Kind::Doc), paths);
596 /// NOTE: keep this in sync with `rustdoc::clean::utils::doc_rust_lang_org_channel`, or tests will fail on beta/stable.
597 pub fn doc_rust_lang_org_channel(&self) -> String {
598 let channel = match &*self.config.channel {
599 "stable" => &self.version,
601 "nightly" | "dev" => "nightly",
602 // custom build of rustdoc maybe? link to the latest stable docs just in case
605 "https://doc.rust-lang.org/".to_owned() + channel
608 fn run_step_descriptions(&self, v: &[StepDescription], paths: &[PathBuf]) {
609 StepDescription::run(v, self, paths);
612 /// Obtain a compiler at a given stage and for a given host. Explicitly does
613 /// not take `Compiler` since all `Compiler` instances are meant to be
614 /// obtained through this function, since it ensures that they are valid
615 /// (i.e., built and assembled).
616 pub fn compiler(&self, stage: u32, host: TargetSelection) -> Compiler {
617 self.ensure(compile::Assemble { target_compiler: Compiler { stage, host } })
620 /// Similar to `compiler`, except handles the full-bootstrap option to
621 /// silently use the stage1 compiler instead of a stage2 compiler if one is
624 /// Note that this does *not* have the side effect of creating
625 /// `compiler(stage, host)`, unlike `compiler` above which does have such
626 /// a side effect. The returned compiler here can only be used to compile
627 /// new artifacts, it can't be used to rely on the presence of a particular
630 /// See `force_use_stage1` for documentation on what each argument is.
634 host: TargetSelection,
635 target: TargetSelection,
637 if self.build.force_use_stage1(Compiler { stage, host }, target) {
638 self.compiler(1, self.config.build)
640 self.compiler(stage, host)
644 pub fn sysroot(&self, compiler: Compiler) -> Interned<PathBuf> {
645 self.ensure(compile::Sysroot { compiler })
648 /// Returns the libdir where the standard library and other artifacts are
649 /// found for a compiler's sysroot.
650 pub fn sysroot_libdir(&self, compiler: Compiler, target: TargetSelection) -> Interned<PathBuf> {
651 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
654 target: TargetSelection,
656 impl Step for Libdir {
657 type Output = Interned<PathBuf>;
659 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
663 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
664 let lib = builder.sysroot_libdir_relative(self.compiler);
665 let sysroot = builder
666 .sysroot(self.compiler)
669 .join(self.target.triple)
671 // Avoid deleting the rustlib/ directory we just copied
672 // (in `impl Step for Sysroot`).
673 if !builder.config.download_rustc {
674 let _ = fs::remove_dir_all(&sysroot);
675 t!(fs::create_dir_all(&sysroot));
677 INTERNER.intern_path(sysroot)
680 self.ensure(Libdir { compiler, target })
683 pub fn sysroot_codegen_backends(&self, compiler: Compiler) -> PathBuf {
684 self.sysroot_libdir(compiler, compiler.host).with_file_name("codegen-backends")
687 /// Returns the compiler's libdir where it stores the dynamic libraries that
688 /// it itself links against.
690 /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
692 pub fn rustc_libdir(&self, compiler: Compiler) -> PathBuf {
693 if compiler.is_snapshot(self) {
694 self.rustc_snapshot_libdir()
696 match self.config.libdir_relative() {
697 Some(relative_libdir) if compiler.stage >= 1 => {
698 self.sysroot(compiler).join(relative_libdir)
700 _ => self.sysroot(compiler).join(libdir(compiler.host)),
705 /// Returns the compiler's relative libdir where it stores the dynamic libraries that
706 /// it itself links against.
708 /// For example this returns `lib` on Unix and `bin` on
710 pub fn libdir_relative(&self, compiler: Compiler) -> &Path {
711 if compiler.is_snapshot(self) {
712 libdir(self.config.build).as_ref()
714 match self.config.libdir_relative() {
715 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
716 _ => libdir(compiler.host).as_ref(),
721 /// Returns the compiler's relative libdir where the standard library and other artifacts are
722 /// found for a compiler's sysroot.
724 /// For example this returns `lib` on Unix and Windows.
725 pub fn sysroot_libdir_relative(&self, compiler: Compiler) -> &Path {
726 match self.config.libdir_relative() {
727 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
728 _ if compiler.stage == 0 => &self.build.initial_libdir,
729 _ => Path::new("lib"),
733 /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
734 /// library lookup path.
735 pub fn add_rustc_lib_path(&self, compiler: Compiler, cmd: &mut Command) {
736 // Windows doesn't need dylib path munging because the dlls for the
737 // compiler live next to the compiler and the system will find them
743 let mut dylib_dirs = vec![self.rustc_libdir(compiler)];
745 // Ensure that the downloaded LLVM libraries can be found.
746 if self.config.llvm_from_ci {
747 let ci_llvm_lib = self.out.join(&*compiler.host.triple).join("ci-llvm").join("lib");
748 dylib_dirs.push(ci_llvm_lib);
751 add_dylib_path(dylib_dirs, cmd);
754 /// Gets a path to the compiler specified.
755 pub fn rustc(&self, compiler: Compiler) -> PathBuf {
756 if compiler.is_snapshot(self) {
757 self.initial_rustc.clone()
759 self.sysroot(compiler).join("bin").join(exe("rustc", compiler.host))
763 /// Gets the paths to all of the compiler's codegen backends.
764 fn codegen_backends(&self, compiler: Compiler) -> impl Iterator<Item = PathBuf> {
765 fs::read_dir(self.sysroot_codegen_backends(compiler))
768 .filter_map(Result::ok)
769 .map(|entry| entry.path())
772 pub fn rustdoc(&self, compiler: Compiler) -> PathBuf {
773 self.ensure(tool::Rustdoc { compiler })
776 pub fn rustdoc_cmd(&self, compiler: Compiler) -> Command {
777 let mut cmd = Command::new(&self.out.join("bootstrap/debug/rustdoc"));
778 cmd.env("RUSTC_STAGE", compiler.stage.to_string())
779 .env("RUSTC_SYSROOT", self.sysroot(compiler))
780 // Note that this is *not* the sysroot_libdir because rustdoc must be linked
781 // equivalently to rustc.
782 .env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler))
783 .env("CFG_RELEASE_CHANNEL", &self.config.channel)
784 .env("RUSTDOC_REAL", self.rustdoc(compiler))
785 .env("RUSTC_BOOTSTRAP", "1");
787 cmd.arg("-Wrustdoc::invalid_codeblock_attributes");
789 if self.config.deny_warnings {
790 cmd.arg("-Dwarnings");
792 cmd.arg("-Znormalize-docs");
794 // Remove make-related flags that can cause jobserver problems.
795 cmd.env_remove("MAKEFLAGS");
796 cmd.env_remove("MFLAGS");
798 if let Some(linker) = self.linker(compiler.host) {
799 cmd.env("RUSTDOC_LINKER", linker);
801 if self.is_fuse_ld_lld(compiler.host) {
802 cmd.env("RUSTDOC_FUSE_LD_LLD", "1");
807 /// Return the path to `llvm-config` for the target, if it exists.
809 /// Note that this returns `None` if LLVM is disabled, or if we're in a
810 /// check build or dry-run, where there's no need to build all of LLVM.
811 fn llvm_config(&self, target: TargetSelection) -> Option<PathBuf> {
812 if self.config.llvm_enabled() && self.kind != Kind::Check && !self.config.dry_run {
813 let llvm_config = self.ensure(native::Llvm { target });
814 if llvm_config.is_file() {
815 return Some(llvm_config);
821 /// Prepares an invocation of `cargo` to be run.
823 /// This will create a `Command` that represents a pending execution of
824 /// Cargo. This cargo will be configured to use `compiler` as the actual
825 /// rustc compiler, its output will be scoped by `mode`'s output directory,
826 /// it will pass the `--target` flag for the specified `target`, and will be
827 /// executing the Cargo command `cmd`.
832 source_type: SourceType,
833 target: TargetSelection,
836 let mut cargo = Command::new(&self.initial_cargo);
837 let out_dir = self.stage_out(compiler, mode);
839 // Codegen backends are not yet tracked by -Zbinary-dep-depinfo,
840 // so we need to explicitly clear out if they've been updated.
841 for backend in self.codegen_backends(compiler) {
842 self.clear_if_dirty(&out_dir, &backend);
845 if cmd == "doc" || cmd == "rustdoc" {
846 let my_out = match mode {
847 // This is the intended out directory for compiler documentation.
848 Mode::Rustc | Mode::ToolRustc => self.compiler_doc_out(target),
849 Mode::Std => out_dir.join(target.triple).join("doc"),
850 _ => panic!("doc mode {:?} not expected", mode),
852 let rustdoc = self.rustdoc(compiler);
853 self.clear_if_dirty(&my_out, &rustdoc);
856 cargo.env("CARGO_TARGET_DIR", &out_dir).arg(cmd);
858 let profile_var = |name: &str| {
859 let profile = if self.config.rust_optimize { "RELEASE" } else { "DEV" };
860 format!("CARGO_PROFILE_{}_{}", profile, name)
863 // See comment in rustc_llvm/build.rs for why this is necessary, largely llvm-config
864 // needs to not accidentally link to libLLVM in stage0/lib.
865 cargo.env("REAL_LIBRARY_PATH_VAR", &util::dylib_path_var());
866 if let Some(e) = env::var_os(util::dylib_path_var()) {
867 cargo.env("REAL_LIBRARY_PATH", e);
870 // Found with `rg "init_env_logger\("`. If anyone uses `init_env_logger`
871 // from out of tree it shouldn't matter, since x.py is only used for
873 let color_logs = ["RUSTDOC_LOG_COLOR", "RUSTC_LOG_COLOR", "RUST_LOG_COLOR"];
874 match self.build.config.color {
876 cargo.arg("--color=always");
877 for log in &color_logs {
878 cargo.env(log, "always");
882 cargo.arg("--color=never");
883 for log in &color_logs {
884 cargo.env(log, "never");
887 Color::Auto => {} // nothing to do
890 if cmd != "install" {
891 cargo.arg("--target").arg(target.rustc_target_arg());
893 assert_eq!(target, compiler.host);
896 // Set a flag for `check`/`clippy`/`fix`, so that certain build
897 // scripts can do less work (i.e. not building/requiring LLVM).
898 if cmd == "check" || cmd == "clippy" || cmd == "fix" {
899 // If we've not yet built LLVM, or it's stale, then bust
900 // the rustc_llvm cache. That will always work, even though it
901 // may mean that on the next non-check build we'll need to rebuild
902 // rustc_llvm. But if LLVM is stale, that'll be a tiny amount
903 // of work comparitively, and we'd likely need to rebuild it anyway,
905 if crate::native::prebuilt_llvm_config(self, target).is_err() {
906 cargo.env("RUST_CHECK", "1");
910 let stage = if compiler.stage == 0 && self.local_rebuild {
911 // Assume the local-rebuild rustc already has stage1 features.
917 let mut rustflags = Rustflags::new(target);
919 if let Ok(s) = env::var("CARGOFLAGS_NOT_BOOTSTRAP") {
920 cargo.args(s.split_whitespace());
922 rustflags.env("RUSTFLAGS_NOT_BOOTSTRAP");
924 if let Ok(s) = env::var("CARGOFLAGS_BOOTSTRAP") {
925 cargo.args(s.split_whitespace());
927 rustflags.env("RUSTFLAGS_BOOTSTRAP");
929 // clippy overwrites sysroot if we pass it to cargo.
930 // Pass it directly to clippy instead.
931 // NOTE: this can't be fixed in clippy because we explicitly don't set `RUSTC`,
932 // so it has no way of knowing the sysroot.
933 rustflags.arg("--sysroot");
935 self.sysroot(compiler)
938 .expect("sysroot must be valid UTF-8"),
940 // Only run clippy on a very limited subset of crates (in particular, not build scripts).
941 cargo.arg("-Zunstable-options");
942 // Explicitly does *not* set `--cfg=bootstrap`, since we're using a nightly clippy.
943 let host_version = Command::new("rustc").arg("--version").output().map_err(|_| ());
944 let output = host_version.and_then(|output| {
945 if output.status.success() {
950 }).unwrap_or_else(|_| {
952 "error: `x.py clippy` requires a host `rustc` toolchain with the `clippy` component"
954 eprintln!("help: try `rustup component add clippy`");
955 std::process::exit(1);
957 if !t!(std::str::from_utf8(&output.stdout)).contains("nightly") {
958 rustflags.arg("--cfg=bootstrap");
961 rustflags.arg("--cfg=bootstrap");
965 if self.config.rust_new_symbol_mangling {
966 rustflags.arg("-Zsymbol-mangling-version=v0");
969 // FIXME: It might be better to use the same value for both `RUSTFLAGS` and `RUSTDOCFLAGS`,
970 // but this breaks CI. At the very least, stage0 `rustdoc` needs `--cfg bootstrap`. See
972 let mut rustdocflags = rustflags.clone();
973 rustdocflags.propagate_cargo_env("RUSTDOCFLAGS");
975 rustdocflags.env("RUSTDOCFLAGS_BOOTSTRAP");
977 rustdocflags.env("RUSTDOCFLAGS_NOT_BOOTSTRAP");
980 if let Ok(s) = env::var("CARGOFLAGS") {
981 cargo.args(s.split_whitespace());
985 Mode::Std | Mode::ToolBootstrap | Mode::ToolStd => {}
986 Mode::Rustc | Mode::Codegen | Mode::ToolRustc => {
987 // Build proc macros both for the host and the target
988 if target != compiler.host && cmd != "check" {
989 cargo.arg("-Zdual-proc-macros");
990 rustflags.arg("-Zdual-proc-macros");
995 // This tells Cargo (and in turn, rustc) to output more complete
996 // dependency information. Most importantly for rustbuild, this
997 // includes sysroot artifacts, like libstd, which means that we don't
998 // need to track those in rustbuild (an error prone process!). This
999 // feature is currently unstable as there may be some bugs and such, but
1000 // it represents a big improvement in rustbuild's reliability on
1001 // rebuilds, so we're using it here.
1003 // For some additional context, see #63470 (the PR originally adding
1004 // this), as well as #63012 which is the tracking issue for this
1005 // feature on the rustc side.
1006 cargo.arg("-Zbinary-dep-depinfo");
1008 cargo.arg("-j").arg(self.jobs().to_string());
1009 // Remove make-related flags to ensure Cargo can correctly set things up
1010 cargo.env_remove("MAKEFLAGS");
1011 cargo.env_remove("MFLAGS");
1013 // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
1014 // Force cargo to output binaries with disambiguating hashes in the name
1015 let mut metadata = if compiler.stage == 0 {
1016 // Treat stage0 like a special channel, whether it's a normal prior-
1017 // release rustc or a local rebuild with the same version, so we
1018 // never mix these libraries by accident.
1019 "bootstrap".to_string()
1021 self.config.channel.to_string()
1023 // We want to make sure that none of the dependencies between
1024 // std/test/rustc unify with one another. This is done for weird linkage
1025 // reasons but the gist of the problem is that if librustc, libtest, and
1026 // libstd all depend on libc from crates.io (which they actually do) we
1027 // want to make sure they all get distinct versions. Things get really
1028 // weird if we try to unify all these dependencies right now, namely
1029 // around how many times the library is linked in dynamic libraries and
1030 // such. If rustc were a static executable or if we didn't ship dylibs
1031 // this wouldn't be a problem, but we do, so it is. This is in general
1032 // just here to make sure things build right. If you can remove this and
1033 // things still build right, please do!
1035 Mode::Std => metadata.push_str("std"),
1036 // When we're building rustc tools, they're built with a search path
1037 // that contains things built during the rustc build. For example,
1038 // bitflags is built during the rustc build, and is a dependency of
1039 // rustdoc as well. We're building rustdoc in a different target
1040 // directory, though, which means that Cargo will rebuild the
1041 // dependency. When we go on to build rustdoc, we'll look for
1042 // bitflags, and find two different copies: one built during the
1043 // rustc step and one that we just built. This isn't always a
1044 // problem, somehow -- not really clear why -- but we know that this
1046 Mode::ToolRustc => metadata.push_str("tool-rustc"),
1047 // Same for codegen backends.
1048 Mode::Codegen => metadata.push_str("codegen"),
1051 cargo.env("__CARGO_DEFAULT_LIB_METADATA", &metadata);
1053 if cmd == "clippy" {
1054 rustflags.arg("-Zforce-unstable-if-unmarked");
1057 rustflags.arg("-Zmacro-backtrace");
1059 let want_rustdoc = self.doc_tests != DocTests::No;
1061 // We synthetically interpret a stage0 compiler used to build tools as a
1062 // "raw" compiler in that it's the exact snapshot we download. Normally
1063 // the stage0 build means it uses libraries build by the stage0
1064 // compiler, but for tools we just use the precompiled libraries that
1066 let use_snapshot = mode == Mode::ToolBootstrap;
1067 assert!(!use_snapshot || stage == 0 || self.local_rebuild);
1069 let maybe_sysroot = self.sysroot(compiler);
1070 let sysroot = if use_snapshot { self.rustc_snapshot_sysroot() } else { &maybe_sysroot };
1071 let libdir = self.rustc_libdir(compiler);
1073 // Clear the output directory if the real rustc we're using has changed;
1074 // Cargo cannot detect this as it thinks rustc is bootstrap/debug/rustc.
1076 // Avoid doing this during dry run as that usually means the relevant
1077 // compiler is not yet linked/copied properly.
1079 // Only clear out the directory if we're compiling std; otherwise, we
1080 // should let Cargo take care of things for us (via depdep info)
1081 if !self.config.dry_run && mode == Mode::Std && cmd == "build" {
1082 self.clear_if_dirty(&out_dir, &self.rustc(compiler));
1085 // Customize the compiler we're running. Specify the compiler to cargo
1086 // as our shim and then pass it some various options used to configure
1087 // how the actual compiler itself is called.
1089 // These variables are primarily all read by
1090 // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
1092 .env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
1093 .env("RUSTC_REAL", self.rustc(compiler))
1094 .env("RUSTC_STAGE", stage.to_string())
1095 .env("RUSTC_SYSROOT", &sysroot)
1096 .env("RUSTC_LIBDIR", &libdir)
1097 .env("RUSTDOC", self.out.join("bootstrap/debug/rustdoc"))
1100 if cmd == "doc" || cmd == "rustdoc" || (cmd == "test" && want_rustdoc) {
1101 self.rustdoc(compiler)
1103 PathBuf::from("/path/to/nowhere/rustdoc/not/required")
1106 .env("RUSTC_ERROR_METADATA_DST", self.extended_error_dir())
1107 .env("RUSTC_BREAK_ON_ICE", "1");
1108 // Clippy support is a hack and uses the default `cargo-clippy` in path.
1109 // Don't override RUSTC so that the `cargo-clippy` in path will be run.
1110 if cmd != "clippy" {
1111 cargo.env("RUSTC", self.out.join("bootstrap/debug/rustc"));
1114 // Dealing with rpath here is a little special, so let's go into some
1115 // detail. First off, `-rpath` is a linker option on Unix platforms
1116 // which adds to the runtime dynamic loader path when looking for
1117 // dynamic libraries. We use this by default on Unix platforms to ensure
1118 // that our nightlies behave the same on Windows, that is they work out
1119 // of the box. This can be disabled, of course, but basically that's why
1120 // we're gated on RUSTC_RPATH here.
1122 // Ok, so the astute might be wondering "why isn't `-C rpath` used
1123 // here?" and that is indeed a good question to ask. This codegen
1124 // option is the compiler's current interface to generating an rpath.
1125 // Unfortunately it doesn't quite suffice for us. The flag currently
1126 // takes no value as an argument, so the compiler calculates what it
1127 // should pass to the linker as `-rpath`. This unfortunately is based on
1128 // the **compile time** directory structure which when building with
1129 // Cargo will be very different than the runtime directory structure.
1131 // All that's a really long winded way of saying that if we use
1132 // `-Crpath` then the executables generated have the wrong rpath of
1133 // something like `$ORIGIN/deps` when in fact the way we distribute
1134 // rustc requires the rpath to be `$ORIGIN/../lib`.
1136 // So, all in all, to set up the correct rpath we pass the linker
1137 // argument manually via `-C link-args=-Wl,-rpath,...`. Plus isn't it
1138 // fun to pass a flag to a tool to pass a flag to pass a flag to a tool
1139 // to change a flag in a binary?
1140 if self.config.rust_rpath && util::use_host_linker(target) {
1141 let rpath = if target.contains("apple") {
1142 // Note that we need to take one extra step on macOS to also pass
1143 // `-Wl,-instal_name,@rpath/...` to get things to work right. To
1144 // do that we pass a weird flag to the compiler to get it to do
1145 // so. Note that this is definitely a hack, and we should likely
1146 // flesh out rpath support more fully in the future.
1147 rustflags.arg("-Zosx-rpath-install-name");
1148 Some("-Wl,-rpath,@loader_path/../lib")
1149 } else if !target.contains("windows") {
1150 Some("-Wl,-rpath,$ORIGIN/../lib")
1154 if let Some(rpath) = rpath {
1155 rustflags.arg(&format!("-Clink-args={}", rpath));
1159 if let Some(host_linker) = self.linker(compiler.host) {
1160 cargo.env("RUSTC_HOST_LINKER", host_linker);
1162 if self.is_fuse_ld_lld(compiler.host) {
1163 cargo.env("RUSTC_HOST_FUSE_LD_LLD", "1");
1164 cargo.env("RUSTDOC_FUSE_LD_LLD", "1");
1167 if let Some(target_linker) = self.linker(target) {
1168 let target = crate::envify(&target.triple);
1169 cargo.env(&format!("CARGO_TARGET_{}_LINKER", target), target_linker);
1171 if self.is_fuse_ld_lld(target) {
1172 rustflags.arg("-Clink-args=-fuse-ld=lld");
1174 self.lld_flags(target).for_each(|flag| {
1175 rustdocflags.arg(&flag);
1178 if !(["build", "check", "clippy", "fix", "rustc"].contains(&cmd)) && want_rustdoc {
1179 cargo.env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler));
1182 let debuginfo_level = match mode {
1183 Mode::Rustc | Mode::Codegen => self.config.rust_debuginfo_level_rustc,
1184 Mode::Std => self.config.rust_debuginfo_level_std,
1185 Mode::ToolBootstrap | Mode::ToolStd | Mode::ToolRustc => {
1186 self.config.rust_debuginfo_level_tools
1189 cargo.env(profile_var("DEBUG"), debuginfo_level.to_string());
1191 profile_var("DEBUG_ASSERTIONS"),
1192 if mode == Mode::Std {
1193 self.config.rust_debug_assertions_std.to_string()
1195 self.config.rust_debug_assertions.to_string()
1199 // `dsymutil` adds time to builds on Apple platforms for no clear benefit, and also makes
1200 // it more difficult for debuggers to find debug info. The compiler currently defaults to
1201 // running `dsymutil` to preserve its historical default, but when compiling the compiler
1202 // itself, we skip it by default since we know it's safe to do so in that case.
1203 // See https://github.com/rust-lang/rust/issues/79361 for more info on this flag.
1204 if target.contains("apple") {
1205 if self.config.rust_run_dsymutil {
1206 rustflags.arg("-Csplit-debuginfo=packed");
1208 rustflags.arg("-Csplit-debuginfo=unpacked");
1212 if self.config.cmd.bless() {
1213 // Bless `expect!` tests.
1214 cargo.env("UPDATE_EXPECT", "1");
1217 if !mode.is_tool() {
1218 cargo.env("RUSTC_FORCE_UNSTABLE", "1");
1221 if let Some(x) = self.crt_static(target) {
1223 rustflags.arg("-Ctarget-feature=+crt-static");
1225 rustflags.arg("-Ctarget-feature=-crt-static");
1229 if let Some(x) = self.crt_static(compiler.host) {
1230 cargo.env("RUSTC_HOST_CRT_STATIC", x.to_string());
1233 if let Some(map_to) = self.build.debuginfo_map_to(GitRepo::Rustc) {
1234 let map = format!("{}={}", self.build.src.display(), map_to);
1235 cargo.env("RUSTC_DEBUGINFO_MAP", map);
1237 // `rustc` needs to know the virtual `/rustc/$hash` we're mapping to,
1238 // in order to opportunistically reverse it later.
1239 cargo.env("CFG_VIRTUAL_RUST_SOURCE_BASE_DIR", map_to);
1242 // Enable usage of unstable features
1243 cargo.env("RUSTC_BOOTSTRAP", "1");
1244 self.add_rust_test_threads(&mut cargo);
1246 // Almost all of the crates that we compile as part of the bootstrap may
1247 // have a build script, including the standard library. To compile a
1248 // build script, however, it itself needs a standard library! This
1249 // introduces a bit of a pickle when we're compiling the standard
1252 // To work around this we actually end up using the snapshot compiler
1253 // (stage0) for compiling build scripts of the standard library itself.
1254 // The stage0 compiler is guaranteed to have a libstd available for use.
1256 // For other crates, however, we know that we've already got a standard
1257 // library up and running, so we can use the normal compiler to compile
1258 // build scripts in that situation.
1259 if mode == Mode::Std {
1261 .env("RUSTC_SNAPSHOT", &self.initial_rustc)
1262 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
1265 .env("RUSTC_SNAPSHOT", self.rustc(compiler))
1266 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
1269 // Tools that use compiler libraries may inherit the `-lLLVM` link
1270 // requirement, but the `-L` library path is not propagated across
1271 // separate Cargo projects. We can add LLVM's library path to the
1272 // platform-specific environment variable as a workaround.
1273 if mode == Mode::ToolRustc {
1274 if let Some(llvm_config) = self.llvm_config(target) {
1275 let llvm_libdir = output(Command::new(&llvm_config).arg("--libdir"));
1276 add_link_lib_path(vec![llvm_libdir.trim().into()], &mut cargo);
1280 // Compile everything except libraries and proc macros with the more
1281 // efficient initial-exec TLS model. This doesn't work with `dlopen`,
1282 // so we can't use it by default in general, but we can use it for tools
1283 // and our own internal libraries.
1284 if !mode.must_support_dlopen() {
1285 rustflags.arg("-Ztls-model=initial-exec");
1288 if self.config.incremental {
1289 cargo.env("CARGO_INCREMENTAL", "1");
1291 // Don't rely on any default setting for incr. comp. in Cargo
1292 cargo.env("CARGO_INCREMENTAL", "0");
1295 if let Some(ref on_fail) = self.config.on_fail {
1296 cargo.env("RUSTC_ON_FAIL", on_fail);
1299 if self.config.print_step_timings {
1300 cargo.env("RUSTC_PRINT_STEP_TIMINGS", "1");
1303 if self.config.print_step_rusage {
1304 cargo.env("RUSTC_PRINT_STEP_RUSAGE", "1");
1307 if self.config.backtrace_on_ice {
1308 cargo.env("RUSTC_BACKTRACE_ON_ICE", "1");
1311 cargo.env("RUSTC_VERBOSE", self.verbosity.to_string());
1313 if source_type == SourceType::InTree {
1314 let mut lint_flags = Vec::new();
1315 // When extending this list, add the new lints to the RUSTFLAGS of the
1316 // build_bootstrap function of src/bootstrap/bootstrap.py as well as
1317 // some code doesn't go through this `rustc` wrapper.
1318 lint_flags.push("-Wrust_2018_idioms");
1319 lint_flags.push("-Wunused_lifetimes");
1320 lint_flags.push("-Wsemicolon_in_expressions_from_macros");
1322 if self.config.deny_warnings {
1323 lint_flags.push("-Dwarnings");
1324 rustdocflags.arg("-Dwarnings");
1327 // FIXME(#58633) hide "unused attribute" errors in incremental
1328 // builds of the standard library, as the underlying checks are
1329 // not yet properly integrated with incremental recompilation.
1330 if mode == Mode::Std && compiler.stage == 0 && self.config.incremental {
1331 lint_flags.push("-Aunused-attributes");
1333 // This does not use RUSTFLAGS due to caching issues with Cargo.
1334 // Clippy is treated as an "in tree" tool, but shares the same
1335 // cache as other "submodule" tools. With these options set in
1336 // RUSTFLAGS, that causes *every* shared dependency to be rebuilt.
1337 // By injecting this into the rustc wrapper, this circumvents
1338 // Cargo's fingerprint detection. This is fine because lint flags
1339 // are always ignored in dependencies. Eventually this should be
1340 // fixed via better support from Cargo.
1341 cargo.env("RUSTC_LINT_FLAGS", lint_flags.join(" "));
1343 rustdocflags.arg("-Wrustdoc::invalid_codeblock_attributes");
1346 if mode == Mode::Rustc {
1347 rustflags.arg("-Zunstable-options");
1348 rustflags.arg("-Wrustc::internal");
1351 // Throughout the build Cargo can execute a number of build scripts
1352 // compiling C/C++ code and we need to pass compilers, archivers, flags, etc
1353 // obtained previously to those build scripts.
1354 // Build scripts use either the `cc` crate or `configure/make` so we pass
1355 // the options through environment variables that are fetched and understood by both.
1357 // FIXME: the guard against msvc shouldn't need to be here
1358 if target.contains("msvc") {
1359 if let Some(ref cl) = self.config.llvm_clang_cl {
1360 cargo.env("CC", cl).env("CXX", cl);
1363 let ccache = self.config.ccache.as_ref();
1364 let ccacheify = |s: &Path| {
1365 let ccache = match ccache {
1367 None => return s.display().to_string(),
1369 // FIXME: the cc-rs crate only recognizes the literal strings
1370 // `ccache` and `sccache` when doing caching compilations, so we
1371 // mirror that here. It should probably be fixed upstream to
1372 // accept a new env var or otherwise work with custom ccache
1375 "ccache" | "sccache" => format!("{} {}", ccache, s.display()),
1376 _ => s.display().to_string(),
1379 let cc = ccacheify(&self.cc(target));
1380 cargo.env(format!("CC_{}", target.triple), &cc);
1382 let cflags = self.cflags(target, GitRepo::Rustc).join(" ");
1383 cargo.env(format!("CFLAGS_{}", target.triple), &cflags);
1385 if let Some(ar) = self.ar(target) {
1386 let ranlib = format!("{} s", ar.display());
1388 .env(format!("AR_{}", target.triple), ar)
1389 .env(format!("RANLIB_{}", target.triple), ranlib);
1392 if let Ok(cxx) = self.cxx(target) {
1393 let cxx = ccacheify(&cxx);
1395 .env(format!("CXX_{}", target.triple), &cxx)
1396 .env(format!("CXXFLAGS_{}", target.triple), cflags);
1400 if mode == Mode::Std && self.config.extended && compiler.is_final_stage(self) {
1401 rustflags.arg("-Zsave-analysis");
1403 "RUST_SAVE_ANALYSIS_CONFIG",
1404 "{\"output_file\": null,\"full_docs\": false,\
1405 \"pub_only\": true,\"reachable_only\": false,\
1406 \"distro_crate\": true,\"signatures\": false,\"borrow_data\": false}",
1410 // If Control Flow Guard is enabled, pass the `control-flow-guard` flag to rustc
1411 // when compiling the standard library, since this might be linked into the final outputs
1412 // produced by rustc. Since this mitigation is only available on Windows, only enable it
1413 // for the standard library in case the compiler is run on a non-Windows platform.
1414 // This is not needed for stage 0 artifacts because these will only be used for building
1415 // the stage 1 compiler.
1417 && mode == Mode::Std
1418 && self.config.control_flow_guard
1419 && compiler.stage >= 1
1421 rustflags.arg("-Ccontrol-flow-guard");
1424 // For `cargo doc` invocations, make rustdoc print the Rust version into the docs
1425 // This replaces spaces with newlines because RUSTDOCFLAGS does not
1426 // support arguments with regular spaces. Hopefully someday Cargo will
1427 // have space support.
1428 let rust_version = self.rust_version().replace(' ', "\n");
1429 rustdocflags.arg("--crate-version").arg(&rust_version);
1431 // Environment variables *required* throughout the build
1433 // FIXME: should update code to not require this env var
1434 cargo.env("CFG_COMPILER_HOST_TRIPLE", target.triple);
1436 // Set this for all builds to make sure doc builds also get it.
1437 cargo.env("CFG_RELEASE_CHANNEL", &self.config.channel);
1439 // This one's a bit tricky. As of the time of this writing the compiler
1440 // links to the `winapi` crate on crates.io. This crate provides raw
1441 // bindings to Windows system functions, sort of like libc does for
1442 // Unix. This crate also, however, provides "import libraries" for the
1443 // MinGW targets. There's an import library per dll in the windows
1444 // distribution which is what's linked to. These custom import libraries
1445 // are used because the winapi crate can reference Windows functions not
1446 // present in the MinGW import libraries.
1448 // For example MinGW may ship libdbghelp.a, but it may not have
1449 // references to all the functions in the dbghelp dll. Instead the
1450 // custom import library for dbghelp in the winapi crates has all this
1453 // Unfortunately for us though the import libraries are linked by
1454 // default via `-ldylib=winapi_foo`. That is, they're linked with the
1455 // `dylib` type with a `winapi_` prefix (so the winapi ones don't
1456 // conflict with the system MinGW ones). This consequently means that
1457 // the binaries we ship of things like rustc_codegen_llvm (aka the rustc_codegen_llvm
1458 // DLL) when linked against *again*, for example with procedural macros
1459 // or plugins, will trigger the propagation logic of `-ldylib`, passing
1460 // `-lwinapi_foo` to the linker again. This isn't actually available in
1461 // our distribution, however, so the link fails.
1463 // To solve this problem we tell winapi to not use its bundled import
1464 // libraries. This means that it will link to the system MinGW import
1465 // libraries by default, and the `-ldylib=foo` directives will still get
1466 // passed to the final linker, but they'll look like `-lfoo` which can
1467 // be resolved because MinGW has the import library. The downside is we
1468 // don't get newer functions from Windows, but we don't use any of them
1470 if !mode.is_tool() {
1471 cargo.env("WINAPI_NO_BUNDLED_LIBRARIES", "1");
1474 for _ in 1..self.verbosity {
1478 match (mode, self.config.rust_codegen_units_std, self.config.rust_codegen_units) {
1479 (Mode::Std, Some(n), _) | (_, _, Some(n)) => {
1480 cargo.env(profile_var("CODEGEN_UNITS"), n.to_string());
1483 // Don't set anything
1487 if self.config.rust_optimize {
1488 // FIXME: cargo bench/install do not accept `--release`
1489 if cmd != "bench" && cmd != "install" {
1490 cargo.arg("--release");
1494 if self.config.locked_deps {
1495 cargo.arg("--locked");
1497 if self.config.vendor || self.is_sudo {
1498 cargo.arg("--frozen");
1501 // Try to use a sysroot-relative bindir, in case it was configured absolutely.
1502 cargo.env("RUSTC_INSTALL_BINDIR", self.config.bindir_relative());
1504 self.ci_env.force_coloring_in_ci(&mut cargo);
1506 // When we build Rust dylibs they're all intended for intermediate
1507 // usage, so make sure we pass the -Cprefer-dynamic flag instead of
1508 // linking all deps statically into the dylib.
1509 if matches!(mode, Mode::Std | Mode::Rustc) {
1510 rustflags.arg("-Cprefer-dynamic");
1513 // When building incrementally we default to a lower ThinLTO import limit
1514 // (unless explicitly specified otherwise). This will produce a somewhat
1515 // slower code but give way better compile times.
1517 let limit = match self.config.rust_thin_lto_import_instr_limit {
1518 Some(limit) => Some(limit),
1519 None if self.config.incremental => Some(10),
1523 if let Some(limit) = limit {
1524 rustflags.arg(&format!("-Cllvm-args=-import-instr-limit={}", limit));
1528 Cargo { command: cargo, rustflags, rustdocflags }
1531 /// Ensure that a given step is built, returning its output. This will
1532 /// cache the step, so it is safe (and good!) to call this as often as
1533 /// needed to ensure that all dependencies are built.
1534 pub fn ensure<S: Step>(&'a self, step: S) -> S::Output {
1536 let mut stack = self.stack.borrow_mut();
1537 for stack_step in stack.iter() {
1539 if stack_step.downcast_ref::<S>().map_or(true, |stack_step| *stack_step != step) {
1542 let mut out = String::new();
1543 out += &format!("\n\nCycle in build detected when adding {:?}\n", step);
1544 for el in stack.iter().rev() {
1545 out += &format!("\t{:?}\n", el);
1549 if let Some(out) = self.cache.get(&step) {
1550 self.verbose(&format!("{}c {:?}", " ".repeat(stack.len()), step));
1554 self.verbose(&format!("{}> {:?}", " ".repeat(stack.len()), step));
1555 stack.push(Box::new(step.clone()));
1559 let start = Instant::now();
1560 let zero = Duration::new(0, 0);
1561 let parent = self.time_spent_on_dependencies.replace(zero);
1562 let out = step.clone().run(self);
1563 let dur = start.elapsed();
1564 let deps = self.time_spent_on_dependencies.replace(parent + dur);
1568 if self.config.print_step_timings && !self.config.dry_run {
1569 println!("[TIMING] {:?} -- {}.{:03}", step, dur.as_secs(), dur.subsec_millis());
1573 let mut stack = self.stack.borrow_mut();
1574 let cur_step = stack.pop().expect("step stack empty");
1575 assert_eq!(cur_step.downcast_ref(), Some(&step));
1577 self.verbose(&format!("{}< {:?}", " ".repeat(self.stack.borrow().len()), step));
1578 self.cache.put(step, out.clone());
1586 #[derive(Debug, Clone)]
1587 struct Rustflags(String, TargetSelection);
1590 fn new(target: TargetSelection) -> Rustflags {
1591 let mut ret = Rustflags(String::new(), target);
1592 ret.propagate_cargo_env("RUSTFLAGS");
1596 /// By default, cargo will pick up on various variables in the environment. However, bootstrap
1597 /// reuses those variables to pass additional flags to rustdoc, so by default they get overriden.
1598 /// Explicitly add back any previous value in the environment.
1600 /// `prefix` is usually `RUSTFLAGS` or `RUSTDOCFLAGS`.
1601 fn propagate_cargo_env(&mut self, prefix: &str) {
1602 // Inherit `RUSTFLAGS` by default ...
1605 // ... and also handle target-specific env RUSTFLAGS if they're configured.
1606 let target_specific = format!("CARGO_TARGET_{}_{}", crate::envify(&self.1.triple), prefix);
1607 self.env(&target_specific);
1610 fn env(&mut self, env: &str) {
1611 if let Ok(s) = env::var(env) {
1612 for part in s.split(' ') {
1618 fn arg(&mut self, arg: &str) -> &mut Self {
1619 assert_eq!(arg.split(' ').count(), 1);
1620 if !self.0.is_empty() {
1623 self.0.push_str(arg);
1631 rustflags: Rustflags,
1632 rustdocflags: Rustflags,
1636 pub fn rustdocflag(&mut self, arg: &str) -> &mut Cargo {
1637 self.rustdocflags.arg(arg);
1640 pub fn rustflag(&mut self, arg: &str) -> &mut Cargo {
1641 self.rustflags.arg(arg);
1645 pub fn arg(&mut self, arg: impl AsRef<OsStr>) -> &mut Cargo {
1646 self.command.arg(arg.as_ref());
1650 pub fn args<I, S>(&mut self, args: I) -> &mut Cargo
1652 I: IntoIterator<Item = S>,
1656 self.arg(arg.as_ref());
1661 pub fn env(&mut self, key: impl AsRef<OsStr>, value: impl AsRef<OsStr>) -> &mut Cargo {
1662 // These are managed through rustflag/rustdocflag interfaces.
1663 assert_ne!(key.as_ref(), "RUSTFLAGS");
1664 assert_ne!(key.as_ref(), "RUSTDOCFLAGS");
1665 self.command.env(key.as_ref(), value.as_ref());
1669 pub fn add_rustc_lib_path(&mut self, builder: &Builder<'_>, compiler: Compiler) {
1670 builder.add_rustc_lib_path(compiler, &mut self.command);
1673 pub fn current_dir(&mut self, dir: &Path) -> &mut Cargo {
1674 self.command.current_dir(dir);
1679 impl From<Cargo> for Command {
1680 fn from(mut cargo: Cargo) -> Command {
1681 let rustflags = &cargo.rustflags.0;
1682 if !rustflags.is_empty() {
1683 cargo.command.env("RUSTFLAGS", rustflags);
1686 let rustdocflags = &cargo.rustdocflags.0;
1687 if !rustdocflags.is_empty() {
1688 cargo.command.env("RUSTDOCFLAGS", rustdocflags);