1 use std::any::{type_name, Any};
2 use std::cell::{Cell, RefCell};
3 use std::collections::BTreeSet;
6 use std::fmt::{Debug, Write};
10 use std::path::{Component, Path, PathBuf};
11 use std::process::Command;
12 use std::time::{Duration, Instant};
14 use crate::cache::{Cache, Interned, INTERNER};
16 use crate::config::{SplitDebuginfo, TargetSelection};
19 use crate::flags::{Color, Subcommand};
24 use crate::tool::{self, SourceType};
25 use crate::util::{self, add_dylib_path, add_link_lib_path, exe, libdir, output, t};
26 use crate::EXTRA_CHECK_CFGS;
27 use crate::{check, Config};
28 use crate::{Build, CLang, DocTests, GitRepo, Mode};
30 pub use crate::Compiler;
31 // FIXME: replace with std::lazy after it gets stabilized and reaches beta
32 use once_cell::sync::Lazy;
34 pub struct Builder<'a> {
39 stack: RefCell<Vec<Box<dyn Any>>>,
40 time_spent_on_dependencies: Cell<Duration>,
41 pub paths: Vec<PathBuf>,
44 impl<'a> Deref for Builder<'a> {
47 fn deref(&self) -> &Self::Target {
52 pub trait Step: 'static + Clone + Debug + PartialEq + Eq + Hash {
53 /// `PathBuf` when directories are created or to return a `Compiler` once
54 /// it's been assembled.
57 /// Whether this step is run by default as part of its respective phase.
58 /// `true` here can still be overwritten by `should_run` calling `default_condition`.
59 const DEFAULT: bool = false;
61 /// If true, then this rule should be skipped if --target was specified, but --host was not
62 const ONLY_HOSTS: bool = false;
64 /// Primary function to execute this rule. Can call `builder.ensure()`
65 /// with other steps to run those.
66 fn run(self, builder: &Builder<'_>) -> Self::Output;
68 /// When bootstrap is passed a set of paths, this controls whether this rule
69 /// will execute. However, it does not get called in a "default" context
70 /// when we are not passed any paths; in that case, `make_run` is called
72 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_>;
74 /// Builds up a "root" rule, either as a default rule or from a path passed
77 /// When path is `None`, we are executing in a context where no paths were
78 /// passed. When `./x.py build` is run, for example, this rule could get
79 /// called if it is in the correct list below with a path of `None`.
80 fn make_run(_run: RunConfig<'_>) {
81 // It is reasonable to not have an implementation of make_run for rules
82 // who do not want to get called from the root context. This means that
83 // they are likely dependencies (e.g., sysroot creation) or similar, and
84 // as such calling them from ./x.py isn't logical.
89 pub struct RunConfig<'a> {
90 pub builder: &'a Builder<'a>,
91 pub target: TargetSelection,
96 pub fn build_triple(&self) -> TargetSelection {
97 self.builder.build.build
101 struct StepDescription {
104 should_run: fn(ShouldRun<'_>) -> ShouldRun<'_>,
105 make_run: fn(RunConfig<'_>),
110 #[derive(Clone, PartialOrd, Ord, PartialEq, Eq)]
111 pub struct TaskPath {
113 pub kind: Option<Kind>,
117 pub fn parse(path: impl Into<PathBuf>) -> TaskPath {
119 let mut path = path.into();
121 let mut components = path.components();
122 if let Some(Component::Normal(os_str)) = components.next() {
123 if let Some(str) = os_str.to_str() {
124 if let Some((found_kind, found_prefix)) = str.split_once("::") {
125 if found_kind.is_empty() {
126 panic!("empty kind in task path {}", path.display());
128 kind = Kind::parse(found_kind);
129 assert!(kind.is_some());
130 path = Path::new(found_prefix).join(components.as_path());
135 TaskPath { path, kind }
139 impl Debug for TaskPath {
140 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
141 if let Some(kind) = &self.kind {
142 write!(f, "{}::", kind.as_str())?;
144 write!(f, "{}", self.path.display())
148 /// Collection of paths used to match a task rule.
149 #[derive(Debug, Clone, PartialOrd, Ord, PartialEq, Eq)]
151 /// A collection of individual paths.
153 /// These are generally matched as a path suffix. For example, a
154 /// command-line value of `libstd` will match if `src/libstd` is in the
156 Set(BTreeSet<TaskPath>),
157 /// A "suite" of paths.
159 /// These can match as a path suffix (like `Set`), or as a prefix. For
160 /// example, a command-line value of `src/test/ui/abi/variadic-ffi.rs`
161 /// will match `src/test/ui`. A command-line value of `ui` would also
162 /// match `src/test/ui`.
167 fn empty() -> PathSet {
168 PathSet::Set(BTreeSet::new())
171 fn one<P: Into<PathBuf>>(path: P, kind: Kind) -> PathSet {
172 let mut set = BTreeSet::new();
173 set.insert(TaskPath { path: path.into(), kind: Some(kind) });
177 fn has(&self, needle: &Path, module: Option<Kind>) -> bool {
178 let check = |p: &TaskPath| {
179 if let (Some(p_kind), Some(kind)) = (&p.kind, module) {
180 p.path.ends_with(needle) && *p_kind == kind
182 p.path.ends_with(needle)
187 PathSet::Set(set) => set.iter().any(check),
188 PathSet::Suite(suite) => check(suite),
192 fn path(&self, builder: &Builder<'_>) -> PathBuf {
194 PathSet::Set(set) => {
195 set.iter().next().map(|p| &p.path).unwrap_or(&builder.build.src).clone()
197 PathSet::Suite(path) => path.path.clone(),
202 impl StepDescription {
203 fn from<S: Step>(kind: Kind) -> StepDescription {
206 only_hosts: S::ONLY_HOSTS,
207 should_run: S::should_run,
208 make_run: S::make_run,
209 name: std::any::type_name::<S>(),
214 fn maybe_run(&self, builder: &Builder<'_>, pathset: &PathSet) {
215 if self.is_excluded(builder, pathset) {
219 // Determine the targets participating in this rule.
220 let targets = if self.only_hosts { &builder.hosts } else { &builder.targets };
222 for target in targets {
223 let run = RunConfig { builder, path: pathset.path(builder), target: *target };
224 (self.make_run)(run);
228 fn is_excluded(&self, builder: &Builder<'_>, pathset: &PathSet) -> bool {
229 if builder.config.exclude.iter().any(|e| pathset.has(&e.path, e.kind)) {
230 eprintln!("Skipping {:?} because it is excluded", pathset);
234 if !builder.config.exclude.is_empty() {
235 builder.verbose(&format!(
236 "{:?} not skipped for {:?} -- not in {:?}",
237 pathset, self.name, builder.config.exclude
243 fn run(v: &[StepDescription], builder: &Builder<'_>, paths: &[PathBuf]) {
246 .map(|desc| (desc.should_run)(ShouldRun::new(builder, desc.kind)))
247 .collect::<Vec<_>>();
249 // sanity checks on rules
250 for (desc, should_run) in v.iter().zip(&should_runs) {
252 !should_run.paths.is_empty(),
253 "{:?} should have at least one pathset",
258 if paths.is_empty() || builder.config.include_default_paths {
259 for (desc, should_run) in v.iter().zip(&should_runs) {
260 if desc.default && should_run.is_really_default() {
261 for pathset in &should_run.paths {
262 desc.maybe_run(builder, pathset);
269 // strip CurDir prefix if present
270 let path = match path.strip_prefix(".") {
275 let mut attempted_run = false;
276 for (desc, should_run) in v.iter().zip(&should_runs) {
277 if let Some(suite) = should_run.is_suite_path(path) {
278 attempted_run = true;
279 desc.maybe_run(builder, suite);
280 } else if let Some(pathset) = should_run.pathset_for_path(path, desc.kind) {
281 attempted_run = true;
282 desc.maybe_run(builder, pathset);
287 panic!("error: no rules matched {}", path.display());
293 enum ReallyDefault<'a> {
295 Lazy(Lazy<bool, Box<dyn Fn() -> bool + 'a>>),
298 pub struct ShouldRun<'a> {
299 pub builder: &'a Builder<'a>,
302 // use a BTreeSet to maintain sort order
303 paths: BTreeSet<PathSet>,
305 // If this is a default rule, this is an additional constraint placed on
306 // its run. Generally something like compiler docs being enabled.
307 is_really_default: ReallyDefault<'a>,
310 impl<'a> ShouldRun<'a> {
311 fn new(builder: &'a Builder<'_>, kind: Kind) -> ShouldRun<'a> {
315 paths: BTreeSet::new(),
316 is_really_default: ReallyDefault::Bool(true), // by default no additional conditions
320 pub fn default_condition(mut self, cond: bool) -> Self {
321 self.is_really_default = ReallyDefault::Bool(cond);
325 pub fn lazy_default_condition(mut self, lazy_cond: Box<dyn Fn() -> bool + 'a>) -> Self {
326 self.is_really_default = ReallyDefault::Lazy(Lazy::new(lazy_cond));
330 pub fn is_really_default(&self) -> bool {
331 match &self.is_really_default {
332 ReallyDefault::Bool(val) => *val,
333 ReallyDefault::Lazy(lazy) => *lazy.deref(),
337 /// Indicates it should run if the command-line selects the given crate or
338 /// any of its (local) dependencies.
340 /// Compared to `krate`, this treats the dependencies as aliases for the
341 /// same job. Generally it is preferred to use `krate`, and treat each
342 /// individual path separately. For example `./x.py test src/liballoc`
343 /// (which uses `krate`) will test just `liballoc`. However, `./x.py check
344 /// src/liballoc` (which uses `all_krates`) will check all of `libtest`.
345 /// `all_krates` should probably be removed at some point.
346 pub fn all_krates(mut self, name: &str) -> Self {
347 let mut set = BTreeSet::new();
348 for krate in self.builder.in_tree_crates(name, None) {
349 let path = krate.local_path(self.builder);
350 set.insert(TaskPath { path, kind: Some(self.kind) });
352 self.paths.insert(PathSet::Set(set));
356 /// Indicates it should run if the command-line selects the given crate or
357 /// any of its (local) dependencies.
359 /// `make_run` will be called separately for each matching command-line path.
360 pub fn krate(mut self, name: &str) -> Self {
361 for krate in self.builder.in_tree_crates(name, None) {
362 let path = krate.local_path(self.builder);
363 self.paths.insert(PathSet::one(path, self.kind));
368 // single alias, which does not correspond to any on-disk path
369 pub fn alias(mut self, alias: &str) -> Self {
371 !self.builder.src.join(alias).exists(),
372 "use `builder.path()` for real paths: {}",
375 self.paths.insert(PathSet::Set(
376 std::iter::once(TaskPath { path: alias.into(), kind: Some(self.kind) }).collect(),
381 // single, non-aliased path
382 pub fn path(self, path: &str) -> Self {
386 // multiple aliases for the same job
387 pub fn paths(mut self, paths: &[&str]) -> Self {
388 self.paths.insert(PathSet::Set(
392 // FIXME(#96188): make sure this is actually a path.
393 // This currently breaks for paths within submodules.
395 // self.builder.src.join(p).exists(),
396 // "`should_run.paths` should correspond to real on-disk paths - use `alias` if there is no relevant path: {}",
399 TaskPath { path: p.into(), kind: Some(self.kind) }
406 pub fn is_suite_path(&self, path: &Path) -> Option<&PathSet> {
407 self.paths.iter().find(|pathset| match pathset {
408 PathSet::Suite(p) => path.starts_with(&p.path),
409 PathSet::Set(_) => false,
413 pub fn suite_path(mut self, suite: &str) -> Self {
414 self.paths.insert(PathSet::Suite(TaskPath { path: suite.into(), kind: Some(self.kind) }));
418 // allows being more explicit about why should_run in Step returns the value passed to it
419 pub fn never(mut self) -> ShouldRun<'a> {
420 self.paths.insert(PathSet::empty());
424 fn pathset_for_path(&self, path: &Path, kind: Kind) -> Option<&PathSet> {
425 self.paths.iter().find(|pathset| pathset.has(path, Some(kind)))
429 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug)]
447 pub fn parse(string: &str) -> Option<Kind> {
448 // these strings, including the one-letter aliases, must match the x.py help text
450 "build" | "b" => Kind::Build,
451 "check" | "c" => Kind::Check,
452 "clippy" => Kind::Clippy,
454 "fmt" => Kind::Format,
455 "test" | "t" => Kind::Test,
456 "bench" => Kind::Bench,
457 "doc" | "d" => Kind::Doc,
458 "clean" => Kind::Clean,
459 "dist" => Kind::Dist,
460 "install" => Kind::Install,
461 "run" | "r" => Kind::Run,
462 "setup" => Kind::Setup,
467 pub fn as_str(&self) -> &'static str {
469 Kind::Build => "build",
470 Kind::Check => "check",
471 Kind::Clippy => "clippy",
473 Kind::Format => "fmt",
474 Kind::Test => "test",
475 Kind::Bench => "bench",
477 Kind::Clean => "clean",
478 Kind::Dist => "dist",
479 Kind::Install => "install",
481 Kind::Setup => "setup",
486 impl<'a> Builder<'a> {
487 fn get_step_descriptions(kind: Kind) -> Vec<StepDescription> {
488 macro_rules! describe {
489 ($($rule:ty),+ $(,)?) => {{
490 vec![$(StepDescription::from::<$rule>(kind)),+]
494 Kind::Build => describe!(
497 compile::CodegenBackend,
498 compile::StartupObjects,
502 tool::UnstableBookGen,
507 tool::RemoteTestServer,
508 tool::RemoteTestClient,
525 Kind::Check => describe!(
529 check::CodegenBackend,
536 Kind::Test => describe!(
537 crate::toolstate::ToolStateCheck,
538 test::ExpandYamlAnchors,
541 test::RunPassValgrind,
554 test::CrateRustdocJsonTypes,
562 test::RunMakeFullDeps,
578 test::CompiletestTest,
580 test::RustdocJSNotStd,
586 // Run bootstrap close to the end as it's unlikely to fail
588 // Run run-make last, since these won't pass without make on Windows
591 Kind::Bench => describe!(test::Crate, test::CrateLibrustc),
592 Kind::Doc => describe!(
594 doc::UnstableBookGen,
612 Kind::Dist => describe!(
631 // It seems that PlainSourceTarball somehow changes how some of the tools
632 // perceive their dependencies (see #93033) which would invalidate fingerprints
633 // and force us to rebuild tools after vendoring dependencies.
634 // To work around this, create the Tarball after building all the tools.
635 dist::PlainSourceTarball,
637 dist::ReproducibleArtifacts,
639 Kind::Install => describe!(
644 install::RustAnalyzer,
646 install::RustDemangler,
653 Kind::Run => describe!(run::ExpandYamlAnchors, run::BuildManifest, run::BumpStage0),
654 // These commands either don't use paths, or they're special-cased in Build::build()
655 Kind::Clean | Kind::Clippy | Kind::Fix | Kind::Format | Kind::Setup => vec![],
659 pub fn get_help(build: &Build, kind: Kind) -> Option<String> {
660 let step_descriptions = Builder::get_step_descriptions(kind);
661 if step_descriptions.is_empty() {
665 let builder = Self::new_internal(build, kind, vec![]);
666 let builder = &builder;
667 // The "build" kind here is just a placeholder, it will be replaced with something else in
668 // the following statement.
669 let mut should_run = ShouldRun::new(builder, Kind::Build);
670 for desc in step_descriptions {
671 should_run.kind = desc.kind;
672 should_run = (desc.should_run)(should_run);
674 let mut help = String::from("Available paths:\n");
675 let mut add_path = |path: &Path| {
676 t!(write!(help, " ./x.py {} {}\n", kind.as_str(), path.display()));
678 for pathset in should_run.paths {
680 PathSet::Set(set) => {
682 add_path(&path.path);
685 PathSet::Suite(path) => {
686 add_path(&path.path.join("..."));
693 fn new_internal(build: &Build, kind: Kind, paths: Vec<PathBuf>) -> Builder<'_> {
696 top_stage: build.config.stage,
699 stack: RefCell::new(Vec::new()),
700 time_spent_on_dependencies: Cell::new(Duration::new(0, 0)),
705 pub fn new(build: &Build) -> Builder<'_> {
706 let (kind, paths) = match build.config.cmd {
707 Subcommand::Build { ref paths } => (Kind::Build, &paths[..]),
708 Subcommand::Check { ref paths } => (Kind::Check, &paths[..]),
709 Subcommand::Clippy { ref paths, .. } => (Kind::Clippy, &paths[..]),
710 Subcommand::Fix { ref paths } => (Kind::Fix, &paths[..]),
711 Subcommand::Doc { ref paths, .. } => (Kind::Doc, &paths[..]),
712 Subcommand::Test { ref paths, .. } => (Kind::Test, &paths[..]),
713 Subcommand::Bench { ref paths, .. } => (Kind::Bench, &paths[..]),
714 Subcommand::Dist { ref paths } => (Kind::Dist, &paths[..]),
715 Subcommand::Install { ref paths } => (Kind::Install, &paths[..]),
716 Subcommand::Run { ref paths } => (Kind::Run, &paths[..]),
717 Subcommand::Format { .. } | Subcommand::Clean { .. } | Subcommand::Setup { .. } => {
722 Self::new_internal(build, kind, paths.to_owned())
725 pub fn execute_cli(&self) {
726 self.run_step_descriptions(&Builder::get_step_descriptions(self.kind), &self.paths);
729 pub fn default_doc(&self, paths: &[PathBuf]) {
730 self.run_step_descriptions(&Builder::get_step_descriptions(Kind::Doc), paths);
733 /// NOTE: keep this in sync with `rustdoc::clean::utils::doc_rust_lang_org_channel`, or tests will fail on beta/stable.
734 pub fn doc_rust_lang_org_channel(&self) -> String {
735 let channel = match &*self.config.channel {
736 "stable" => &self.version,
738 "nightly" | "dev" => "nightly",
739 // custom build of rustdoc maybe? link to the latest stable docs just in case
742 "https://doc.rust-lang.org/".to_owned() + channel
745 fn run_step_descriptions(&self, v: &[StepDescription], paths: &[PathBuf]) {
746 StepDescription::run(v, self, paths);
749 /// Obtain a compiler at a given stage and for a given host. Explicitly does
750 /// not take `Compiler` since all `Compiler` instances are meant to be
751 /// obtained through this function, since it ensures that they are valid
752 /// (i.e., built and assembled).
753 pub fn compiler(&self, stage: u32, host: TargetSelection) -> Compiler {
754 self.ensure(compile::Assemble { target_compiler: Compiler { stage, host } })
757 /// Similar to `compiler`, except handles the full-bootstrap option to
758 /// silently use the stage1 compiler instead of a stage2 compiler if one is
761 /// Note that this does *not* have the side effect of creating
762 /// `compiler(stage, host)`, unlike `compiler` above which does have such
763 /// a side effect. The returned compiler here can only be used to compile
764 /// new artifacts, it can't be used to rely on the presence of a particular
767 /// See `force_use_stage1` for documentation on what each argument is.
771 host: TargetSelection,
772 target: TargetSelection,
774 if self.build.force_use_stage1(Compiler { stage, host }, target) {
775 self.compiler(1, self.config.build)
777 self.compiler(stage, host)
781 pub fn sysroot(&self, compiler: Compiler) -> Interned<PathBuf> {
782 self.ensure(compile::Sysroot { compiler })
785 /// Returns the libdir where the standard library and other artifacts are
786 /// found for a compiler's sysroot.
787 pub fn sysroot_libdir(&self, compiler: Compiler, target: TargetSelection) -> Interned<PathBuf> {
788 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
791 target: TargetSelection,
793 impl Step for Libdir {
794 type Output = Interned<PathBuf>;
796 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
800 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
801 let lib = builder.sysroot_libdir_relative(self.compiler);
802 let sysroot = builder
803 .sysroot(self.compiler)
806 .join(self.target.triple)
808 // Avoid deleting the rustlib/ directory we just copied
809 // (in `impl Step for Sysroot`).
810 if !builder.config.download_rustc {
811 let _ = fs::remove_dir_all(&sysroot);
812 t!(fs::create_dir_all(&sysroot));
814 INTERNER.intern_path(sysroot)
817 self.ensure(Libdir { compiler, target })
820 pub fn sysroot_codegen_backends(&self, compiler: Compiler) -> PathBuf {
821 self.sysroot_libdir(compiler, compiler.host).with_file_name("codegen-backends")
824 /// Returns the compiler's libdir where it stores the dynamic libraries that
825 /// it itself links against.
827 /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
829 pub fn rustc_libdir(&self, compiler: Compiler) -> PathBuf {
830 if compiler.is_snapshot(self) {
831 self.rustc_snapshot_libdir()
833 match self.config.libdir_relative() {
834 Some(relative_libdir) if compiler.stage >= 1 => {
835 self.sysroot(compiler).join(relative_libdir)
837 _ => self.sysroot(compiler).join(libdir(compiler.host)),
842 /// Returns the compiler's relative libdir where it stores the dynamic libraries that
843 /// it itself links against.
845 /// For example this returns `lib` on Unix and `bin` on
847 pub fn libdir_relative(&self, compiler: Compiler) -> &Path {
848 if compiler.is_snapshot(self) {
849 libdir(self.config.build).as_ref()
851 match self.config.libdir_relative() {
852 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
853 _ => libdir(compiler.host).as_ref(),
858 /// Returns the compiler's relative libdir where the standard library and other artifacts are
859 /// found for a compiler's sysroot.
861 /// For example this returns `lib` on Unix and Windows.
862 pub fn sysroot_libdir_relative(&self, compiler: Compiler) -> &Path {
863 match self.config.libdir_relative() {
864 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
865 _ if compiler.stage == 0 => &self.build.initial_libdir,
866 _ => Path::new("lib"),
870 pub fn rustc_lib_paths(&self, compiler: Compiler) -> Vec<PathBuf> {
871 let mut dylib_dirs = vec![self.rustc_libdir(compiler)];
873 // Ensure that the downloaded LLVM libraries can be found.
874 if self.config.llvm_from_ci {
875 let ci_llvm_lib = self.out.join(&*compiler.host.triple).join("ci-llvm").join("lib");
876 dylib_dirs.push(ci_llvm_lib);
882 /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
883 /// library lookup path.
884 pub fn add_rustc_lib_path(&self, compiler: Compiler, cmd: &mut Command) {
885 // Windows doesn't need dylib path munging because the dlls for the
886 // compiler live next to the compiler and the system will find them
892 add_dylib_path(self.rustc_lib_paths(compiler), cmd);
895 /// Gets a path to the compiler specified.
896 pub fn rustc(&self, compiler: Compiler) -> PathBuf {
897 if compiler.is_snapshot(self) {
898 self.initial_rustc.clone()
900 self.sysroot(compiler).join("bin").join(exe("rustc", compiler.host))
904 /// Gets the paths to all of the compiler's codegen backends.
905 fn codegen_backends(&self, compiler: Compiler) -> impl Iterator<Item = PathBuf> {
906 fs::read_dir(self.sysroot_codegen_backends(compiler))
909 .filter_map(Result::ok)
910 .map(|entry| entry.path())
913 pub fn rustdoc(&self, compiler: Compiler) -> PathBuf {
914 self.ensure(tool::Rustdoc { compiler })
917 pub fn rustdoc_cmd(&self, compiler: Compiler) -> Command {
918 let mut cmd = Command::new(&self.bootstrap_out.join("rustdoc"));
919 cmd.env("RUSTC_STAGE", compiler.stage.to_string())
920 .env("RUSTC_SYSROOT", self.sysroot(compiler))
921 // Note that this is *not* the sysroot_libdir because rustdoc must be linked
922 // equivalently to rustc.
923 .env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler))
924 .env("CFG_RELEASE_CHANNEL", &self.config.channel)
925 .env("RUSTDOC_REAL", self.rustdoc(compiler))
926 .env("RUSTC_BOOTSTRAP", "1");
928 cmd.arg("-Wrustdoc::invalid_codeblock_attributes");
930 if self.config.deny_warnings {
931 cmd.arg("-Dwarnings");
933 cmd.arg("-Znormalize-docs");
935 // Remove make-related flags that can cause jobserver problems.
936 cmd.env_remove("MAKEFLAGS");
937 cmd.env_remove("MFLAGS");
939 if let Some(linker) = self.linker(compiler.host) {
940 cmd.env("RUSTDOC_LINKER", linker);
942 if self.is_fuse_ld_lld(compiler.host) {
943 cmd.env("RUSTDOC_FUSE_LD_LLD", "1");
948 /// Return the path to `llvm-config` for the target, if it exists.
950 /// Note that this returns `None` if LLVM is disabled, or if we're in a
951 /// check build or dry-run, where there's no need to build all of LLVM.
952 fn llvm_config(&self, target: TargetSelection) -> Option<PathBuf> {
953 if self.config.llvm_enabled() && self.kind != Kind::Check && !self.config.dry_run {
954 let llvm_config = self.ensure(native::Llvm { target });
955 if llvm_config.is_file() {
956 return Some(llvm_config);
962 /// Convenience wrapper to allow `builder.llvm_link_shared()` instead of `builder.config.llvm_link_shared(&builder)`.
963 pub(crate) fn llvm_link_shared(&self) -> bool {
964 Config::llvm_link_shared(self)
967 /// Prepares an invocation of `cargo` to be run.
969 /// This will create a `Command` that represents a pending execution of
970 /// Cargo. This cargo will be configured to use `compiler` as the actual
971 /// rustc compiler, its output will be scoped by `mode`'s output directory,
972 /// it will pass the `--target` flag for the specified `target`, and will be
973 /// executing the Cargo command `cmd`.
978 source_type: SourceType,
979 target: TargetSelection,
982 let mut cargo = Command::new(&self.initial_cargo);
983 let out_dir = self.stage_out(compiler, mode);
985 // Codegen backends are not yet tracked by -Zbinary-dep-depinfo,
986 // so we need to explicitly clear out if they've been updated.
987 for backend in self.codegen_backends(compiler) {
988 self.clear_if_dirty(&out_dir, &backend);
991 if cmd == "doc" || cmd == "rustdoc" {
992 let my_out = match mode {
993 // This is the intended out directory for compiler documentation.
994 Mode::Rustc | Mode::ToolRustc => self.compiler_doc_out(target),
995 Mode::Std => out_dir.join(target.triple).join("doc"),
996 _ => panic!("doc mode {:?} not expected", mode),
998 let rustdoc = self.rustdoc(compiler);
999 self.clear_if_dirty(&my_out, &rustdoc);
1002 cargo.env("CARGO_TARGET_DIR", &out_dir).arg(cmd);
1004 let profile_var = |name: &str| {
1005 let profile = if self.config.rust_optimize { "RELEASE" } else { "DEV" };
1006 format!("CARGO_PROFILE_{}_{}", profile, name)
1009 // See comment in rustc_llvm/build.rs for why this is necessary, largely llvm-config
1010 // needs to not accidentally link to libLLVM in stage0/lib.
1011 cargo.env("REAL_LIBRARY_PATH_VAR", &util::dylib_path_var());
1012 if let Some(e) = env::var_os(util::dylib_path_var()) {
1013 cargo.env("REAL_LIBRARY_PATH", e);
1016 // Found with `rg "init_env_logger\("`. If anyone uses `init_env_logger`
1017 // from out of tree it shouldn't matter, since x.py is only used for
1018 // building in-tree.
1019 let color_logs = ["RUSTDOC_LOG_COLOR", "RUSTC_LOG_COLOR", "RUST_LOG_COLOR"];
1020 match self.build.config.color {
1022 cargo.arg("--color=always");
1023 for log in &color_logs {
1024 cargo.env(log, "always");
1028 cargo.arg("--color=never");
1029 for log in &color_logs {
1030 cargo.env(log, "never");
1033 Color::Auto => {} // nothing to do
1036 if cmd != "install" {
1037 cargo.arg("--target").arg(target.rustc_target_arg());
1039 assert_eq!(target, compiler.host);
1042 // Set a flag for `check`/`clippy`/`fix`, so that certain build
1043 // scripts can do less work (i.e. not building/requiring LLVM).
1044 if cmd == "check" || cmd == "clippy" || cmd == "fix" {
1045 // If we've not yet built LLVM, or it's stale, then bust
1046 // the rustc_llvm cache. That will always work, even though it
1047 // may mean that on the next non-check build we'll need to rebuild
1048 // rustc_llvm. But if LLVM is stale, that'll be a tiny amount
1049 // of work comparatively, and we'd likely need to rebuild it anyway,
1051 if crate::native::prebuilt_llvm_config(self, target).is_err() {
1052 cargo.env("RUST_CHECK", "1");
1056 let stage = if compiler.stage == 0 && self.local_rebuild {
1057 // Assume the local-rebuild rustc already has stage1 features.
1063 let mut rustflags = Rustflags::new(target);
1065 if let Ok(s) = env::var("CARGOFLAGS_NOT_BOOTSTRAP") {
1066 cargo.args(s.split_whitespace());
1068 rustflags.env("RUSTFLAGS_NOT_BOOTSTRAP");
1070 if let Ok(s) = env::var("CARGOFLAGS_BOOTSTRAP") {
1071 cargo.args(s.split_whitespace());
1073 rustflags.env("RUSTFLAGS_BOOTSTRAP");
1074 if cmd == "clippy" {
1075 // clippy overwrites sysroot if we pass it to cargo.
1076 // Pass it directly to clippy instead.
1077 // NOTE: this can't be fixed in clippy because we explicitly don't set `RUSTC`,
1078 // so it has no way of knowing the sysroot.
1079 rustflags.arg("--sysroot");
1081 self.sysroot(compiler)
1084 .expect("sysroot must be valid UTF-8"),
1086 // Only run clippy on a very limited subset of crates (in particular, not build scripts).
1087 cargo.arg("-Zunstable-options");
1088 // Explicitly does *not* set `--cfg=bootstrap`, since we're using a nightly clippy.
1089 let host_version = Command::new("rustc").arg("--version").output().map_err(|_| ());
1090 let output = host_version.and_then(|output| {
1091 if output.status.success() {
1096 }).unwrap_or_else(|_| {
1098 "error: `x.py clippy` requires a host `rustc` toolchain with the `clippy` component"
1100 eprintln!("help: try `rustup component add clippy`");
1101 std::process::exit(1);
1103 if !t!(std::str::from_utf8(&output.stdout)).contains("nightly") {
1104 rustflags.arg("--cfg=bootstrap");
1107 rustflags.arg("--cfg=bootstrap");
1111 let use_new_symbol_mangling = match self.config.rust_new_symbol_mangling {
1113 // If an explicit setting is given, use that
1117 if mode == Mode::Std {
1118 // The standard library defaults to the legacy scheme
1121 // The compiler and tools default to the new scheme
1127 if use_new_symbol_mangling {
1128 rustflags.arg("-Csymbol-mangling-version=v0");
1130 rustflags.arg("-Csymbol-mangling-version=legacy");
1131 rustflags.arg("-Zunstable-options");
1134 // FIXME(Urgau): This a hack as it shouldn't be gated on stage 0 but until `rustc_llvm`
1135 // is made to work with `--check-cfg` which is currently not easly possible until cargo
1136 // get some support for setting `--check-cfg` within build script, it's the least invasive
1137 // hack that still let's us have cfg checking for the vast majority of the codebase.
1139 // Enable cfg checking of cargo features for everything but std.
1141 // Note: `std`, `alloc` and `core` imports some dependencies by #[path] (like
1142 // backtrace, core_simd, std_float, ...), those dependencies have their own features
1143 // but cargo isn't involved in the #[path] and so cannot pass the complete list of
1144 // features, so for that reason we don't enable checking of features for std.
1145 if mode != Mode::Std {
1146 cargo.arg("-Zcheck-cfg-features");
1149 // Enable cfg checking of well known names/values
1151 .arg("-Zunstable-options")
1152 // Enable checking of well known names
1153 .arg("--check-cfg=names()")
1154 // Enable checking of well known values
1155 .arg("--check-cfg=values()");
1157 // Add extra cfg not defined in rustc
1158 for (restricted_mode, name, values) in EXTRA_CHECK_CFGS {
1159 if *restricted_mode == None || *restricted_mode == Some(mode) {
1160 // Creating a string of the values by concatenating each value:
1161 // ',"tvos","watchos"' or '' (nothing) when there are no values
1162 let values = match values {
1163 Some(values) => values
1165 .map(|val| [",", "\"", val, "\""])
1167 .collect::<String>(),
1168 None => String::new(),
1170 rustflags.arg(&format!("--check-cfg=values({name}{values})"));
1175 // FIXME: It might be better to use the same value for both `RUSTFLAGS` and `RUSTDOCFLAGS`,
1176 // but this breaks CI. At the very least, stage0 `rustdoc` needs `--cfg bootstrap`. See
1178 let mut rustdocflags = rustflags.clone();
1179 rustdocflags.propagate_cargo_env("RUSTDOCFLAGS");
1181 rustdocflags.env("RUSTDOCFLAGS_BOOTSTRAP");
1183 rustdocflags.env("RUSTDOCFLAGS_NOT_BOOTSTRAP");
1186 if let Ok(s) = env::var("CARGOFLAGS") {
1187 cargo.args(s.split_whitespace());
1191 Mode::Std | Mode::ToolBootstrap | Mode::ToolStd => {}
1192 Mode::Rustc | Mode::Codegen | Mode::ToolRustc => {
1193 // Build proc macros both for the host and the target
1194 if target != compiler.host && cmd != "check" {
1195 cargo.arg("-Zdual-proc-macros");
1196 rustflags.arg("-Zdual-proc-macros");
1201 // This tells Cargo (and in turn, rustc) to output more complete
1202 // dependency information. Most importantly for rustbuild, this
1203 // includes sysroot artifacts, like libstd, which means that we don't
1204 // need to track those in rustbuild (an error prone process!). This
1205 // feature is currently unstable as there may be some bugs and such, but
1206 // it represents a big improvement in rustbuild's reliability on
1207 // rebuilds, so we're using it here.
1209 // For some additional context, see #63470 (the PR originally adding
1210 // this), as well as #63012 which is the tracking issue for this
1211 // feature on the rustc side.
1212 cargo.arg("-Zbinary-dep-depinfo");
1214 cargo.arg("-j").arg(self.jobs().to_string());
1215 // Remove make-related flags to ensure Cargo can correctly set things up
1216 cargo.env_remove("MAKEFLAGS");
1217 cargo.env_remove("MFLAGS");
1219 // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
1220 // Force cargo to output binaries with disambiguating hashes in the name
1221 let mut metadata = if compiler.stage == 0 {
1222 // Treat stage0 like a special channel, whether it's a normal prior-
1223 // release rustc or a local rebuild with the same version, so we
1224 // never mix these libraries by accident.
1225 "bootstrap".to_string()
1227 self.config.channel.to_string()
1229 // We want to make sure that none of the dependencies between
1230 // std/test/rustc unify with one another. This is done for weird linkage
1231 // reasons but the gist of the problem is that if librustc, libtest, and
1232 // libstd all depend on libc from crates.io (which they actually do) we
1233 // want to make sure they all get distinct versions. Things get really
1234 // weird if we try to unify all these dependencies right now, namely
1235 // around how many times the library is linked in dynamic libraries and
1236 // such. If rustc were a static executable or if we didn't ship dylibs
1237 // this wouldn't be a problem, but we do, so it is. This is in general
1238 // just here to make sure things build right. If you can remove this and
1239 // things still build right, please do!
1241 Mode::Std => metadata.push_str("std"),
1242 // When we're building rustc tools, they're built with a search path
1243 // that contains things built during the rustc build. For example,
1244 // bitflags is built during the rustc build, and is a dependency of
1245 // rustdoc as well. We're building rustdoc in a different target
1246 // directory, though, which means that Cargo will rebuild the
1247 // dependency. When we go on to build rustdoc, we'll look for
1248 // bitflags, and find two different copies: one built during the
1249 // rustc step and one that we just built. This isn't always a
1250 // problem, somehow -- not really clear why -- but we know that this
1252 Mode::ToolRustc => metadata.push_str("tool-rustc"),
1253 // Same for codegen backends.
1254 Mode::Codegen => metadata.push_str("codegen"),
1257 cargo.env("__CARGO_DEFAULT_LIB_METADATA", &metadata);
1259 if cmd == "clippy" {
1260 rustflags.arg("-Zforce-unstable-if-unmarked");
1263 rustflags.arg("-Zmacro-backtrace");
1265 let want_rustdoc = self.doc_tests != DocTests::No;
1267 // We synthetically interpret a stage0 compiler used to build tools as a
1268 // "raw" compiler in that it's the exact snapshot we download. Normally
1269 // the stage0 build means it uses libraries build by the stage0
1270 // compiler, but for tools we just use the precompiled libraries that
1272 let use_snapshot = mode == Mode::ToolBootstrap;
1273 assert!(!use_snapshot || stage == 0 || self.local_rebuild);
1275 let maybe_sysroot = self.sysroot(compiler);
1276 let sysroot = if use_snapshot { self.rustc_snapshot_sysroot() } else { &maybe_sysroot };
1277 let libdir = self.rustc_libdir(compiler);
1279 // Clear the output directory if the real rustc we're using has changed;
1280 // Cargo cannot detect this as it thinks rustc is bootstrap/debug/rustc.
1282 // Avoid doing this during dry run as that usually means the relevant
1283 // compiler is not yet linked/copied properly.
1285 // Only clear out the directory if we're compiling std; otherwise, we
1286 // should let Cargo take care of things for us (via depdep info)
1287 if !self.config.dry_run && mode == Mode::Std && cmd == "build" {
1288 self.clear_if_dirty(&out_dir, &self.rustc(compiler));
1291 // Customize the compiler we're running. Specify the compiler to cargo
1292 // as our shim and then pass it some various options used to configure
1293 // how the actual compiler itself is called.
1295 // These variables are primarily all read by
1296 // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
1298 .env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
1299 .env("RUSTC_REAL", self.rustc(compiler))
1300 .env("RUSTC_STAGE", stage.to_string())
1301 .env("RUSTC_SYSROOT", &sysroot)
1302 .env("RUSTC_LIBDIR", &libdir)
1303 .env("RUSTDOC", self.bootstrap_out.join("rustdoc"))
1306 if cmd == "doc" || cmd == "rustdoc" || (cmd == "test" && want_rustdoc) {
1307 self.rustdoc(compiler)
1309 PathBuf::from("/path/to/nowhere/rustdoc/not/required")
1312 .env("RUSTC_ERROR_METADATA_DST", self.extended_error_dir())
1313 .env("RUSTC_BREAK_ON_ICE", "1");
1314 // Clippy support is a hack and uses the default `cargo-clippy` in path.
1315 // Don't override RUSTC so that the `cargo-clippy` in path will be run.
1316 if cmd != "clippy" {
1317 cargo.env("RUSTC", self.bootstrap_out.join("rustc"));
1320 // Dealing with rpath here is a little special, so let's go into some
1321 // detail. First off, `-rpath` is a linker option on Unix platforms
1322 // which adds to the runtime dynamic loader path when looking for
1323 // dynamic libraries. We use this by default on Unix platforms to ensure
1324 // that our nightlies behave the same on Windows, that is they work out
1325 // of the box. This can be disabled, of course, but basically that's why
1326 // we're gated on RUSTC_RPATH here.
1328 // Ok, so the astute might be wondering "why isn't `-C rpath` used
1329 // here?" and that is indeed a good question to ask. This codegen
1330 // option is the compiler's current interface to generating an rpath.
1331 // Unfortunately it doesn't quite suffice for us. The flag currently
1332 // takes no value as an argument, so the compiler calculates what it
1333 // should pass to the linker as `-rpath`. This unfortunately is based on
1334 // the **compile time** directory structure which when building with
1335 // Cargo will be very different than the runtime directory structure.
1337 // All that's a really long winded way of saying that if we use
1338 // `-Crpath` then the executables generated have the wrong rpath of
1339 // something like `$ORIGIN/deps` when in fact the way we distribute
1340 // rustc requires the rpath to be `$ORIGIN/../lib`.
1342 // So, all in all, to set up the correct rpath we pass the linker
1343 // argument manually via `-C link-args=-Wl,-rpath,...`. Plus isn't it
1344 // fun to pass a flag to a tool to pass a flag to pass a flag to a tool
1345 // to change a flag in a binary?
1346 if self.config.rust_rpath && util::use_host_linker(target) {
1347 let rpath = if target.contains("apple") {
1348 // Note that we need to take one extra step on macOS to also pass
1349 // `-Wl,-instal_name,@rpath/...` to get things to work right. To
1350 // do that we pass a weird flag to the compiler to get it to do
1351 // so. Note that this is definitely a hack, and we should likely
1352 // flesh out rpath support more fully in the future.
1353 rustflags.arg("-Zosx-rpath-install-name");
1354 Some("-Wl,-rpath,@loader_path/../lib")
1355 } else if !target.contains("windows") {
1356 rustflags.arg("-Clink-args=-Wl,-z,origin");
1357 Some("-Wl,-rpath,$ORIGIN/../lib")
1361 if let Some(rpath) = rpath {
1362 rustflags.arg(&format!("-Clink-args={}", rpath));
1366 if let Some(host_linker) = self.linker(compiler.host) {
1367 cargo.env("RUSTC_HOST_LINKER", host_linker);
1369 if self.is_fuse_ld_lld(compiler.host) {
1370 cargo.env("RUSTC_HOST_FUSE_LD_LLD", "1");
1371 cargo.env("RUSTDOC_FUSE_LD_LLD", "1");
1374 if let Some(target_linker) = self.linker(target) {
1375 let target = crate::envify(&target.triple);
1376 cargo.env(&format!("CARGO_TARGET_{}_LINKER", target), target_linker);
1378 if self.is_fuse_ld_lld(target) {
1379 rustflags.arg("-Clink-args=-fuse-ld=lld");
1381 self.lld_flags(target).for_each(|flag| {
1382 rustdocflags.arg(&flag);
1385 if !(["build", "check", "clippy", "fix", "rustc"].contains(&cmd)) && want_rustdoc {
1386 cargo.env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler));
1389 let debuginfo_level = match mode {
1390 Mode::Rustc | Mode::Codegen => self.config.rust_debuginfo_level_rustc,
1391 Mode::Std => self.config.rust_debuginfo_level_std,
1392 Mode::ToolBootstrap | Mode::ToolStd | Mode::ToolRustc => {
1393 self.config.rust_debuginfo_level_tools
1396 cargo.env(profile_var("DEBUG"), debuginfo_level.to_string());
1398 profile_var("DEBUG_ASSERTIONS"),
1399 if mode == Mode::Std {
1400 self.config.rust_debug_assertions_std.to_string()
1402 self.config.rust_debug_assertions.to_string()
1406 profile_var("OVERFLOW_CHECKS"),
1407 if mode == Mode::Std {
1408 self.config.rust_overflow_checks_std.to_string()
1410 self.config.rust_overflow_checks.to_string()
1414 // FIXME(davidtwco): #[cfg(not(bootstrap))] - #95612 needs to be in the bootstrap compiler
1415 // for this conditional to be removed.
1416 if !target.contains("windows") || compiler.stage >= 1 {
1417 if target.contains("linux") || target.contains("windows") {
1418 rustflags.arg("-Zunstable-options");
1420 match self.config.rust_split_debuginfo {
1421 SplitDebuginfo::Packed => rustflags.arg("-Csplit-debuginfo=packed"),
1422 SplitDebuginfo::Unpacked => rustflags.arg("-Csplit-debuginfo=unpacked"),
1423 SplitDebuginfo::Off => rustflags.arg("-Csplit-debuginfo=off"),
1427 if self.config.cmd.bless() {
1428 // Bless `expect!` tests.
1429 cargo.env("UPDATE_EXPECT", "1");
1432 if !mode.is_tool() {
1433 cargo.env("RUSTC_FORCE_UNSTABLE", "1");
1436 if let Some(x) = self.crt_static(target) {
1438 rustflags.arg("-Ctarget-feature=+crt-static");
1440 rustflags.arg("-Ctarget-feature=-crt-static");
1444 if let Some(x) = self.crt_static(compiler.host) {
1445 cargo.env("RUSTC_HOST_CRT_STATIC", x.to_string());
1448 if let Some(map_to) = self.build.debuginfo_map_to(GitRepo::Rustc) {
1449 let map = format!("{}={}", self.build.src.display(), map_to);
1450 cargo.env("RUSTC_DEBUGINFO_MAP", map);
1452 // `rustc` needs to know the virtual `/rustc/$hash` we're mapping to,
1453 // in order to opportunistically reverse it later.
1454 cargo.env("CFG_VIRTUAL_RUST_SOURCE_BASE_DIR", map_to);
1457 // Enable usage of unstable features
1458 cargo.env("RUSTC_BOOTSTRAP", "1");
1459 self.add_rust_test_threads(&mut cargo);
1461 // Almost all of the crates that we compile as part of the bootstrap may
1462 // have a build script, including the standard library. To compile a
1463 // build script, however, it itself needs a standard library! This
1464 // introduces a bit of a pickle when we're compiling the standard
1467 // To work around this we actually end up using the snapshot compiler
1468 // (stage0) for compiling build scripts of the standard library itself.
1469 // The stage0 compiler is guaranteed to have a libstd available for use.
1471 // For other crates, however, we know that we've already got a standard
1472 // library up and running, so we can use the normal compiler to compile
1473 // build scripts in that situation.
1474 if mode == Mode::Std {
1476 .env("RUSTC_SNAPSHOT", &self.initial_rustc)
1477 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
1480 .env("RUSTC_SNAPSHOT", self.rustc(compiler))
1481 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
1484 // Tools that use compiler libraries may inherit the `-lLLVM` link
1485 // requirement, but the `-L` library path is not propagated across
1486 // separate Cargo projects. We can add LLVM's library path to the
1487 // platform-specific environment variable as a workaround.
1488 if mode == Mode::ToolRustc || mode == Mode::Codegen {
1489 if let Some(llvm_config) = self.llvm_config(target) {
1490 let llvm_libdir = output(Command::new(&llvm_config).arg("--libdir"));
1491 add_link_lib_path(vec![llvm_libdir.trim().into()], &mut cargo);
1495 // Compile everything except libraries and proc macros with the more
1496 // efficient initial-exec TLS model. This doesn't work with `dlopen`,
1497 // so we can't use it by default in general, but we can use it for tools
1498 // and our own internal libraries.
1499 if !mode.must_support_dlopen() && !target.triple.starts_with("powerpc-") {
1500 rustflags.arg("-Ztls-model=initial-exec");
1503 if self.config.incremental {
1504 cargo.env("CARGO_INCREMENTAL", "1");
1506 // Don't rely on any default setting for incr. comp. in Cargo
1507 cargo.env("CARGO_INCREMENTAL", "0");
1510 if let Some(ref on_fail) = self.config.on_fail {
1511 cargo.env("RUSTC_ON_FAIL", on_fail);
1514 if self.config.print_step_timings {
1515 cargo.env("RUSTC_PRINT_STEP_TIMINGS", "1");
1518 if self.config.print_step_rusage {
1519 cargo.env("RUSTC_PRINT_STEP_RUSAGE", "1");
1522 if self.config.backtrace_on_ice {
1523 cargo.env("RUSTC_BACKTRACE_ON_ICE", "1");
1526 cargo.env("RUSTC_VERBOSE", self.verbosity.to_string());
1528 if source_type == SourceType::InTree {
1529 let mut lint_flags = Vec::new();
1530 // When extending this list, add the new lints to the RUSTFLAGS of the
1531 // build_bootstrap function of src/bootstrap/bootstrap.py as well as
1532 // some code doesn't go through this `rustc` wrapper.
1533 lint_flags.push("-Wrust_2018_idioms");
1534 lint_flags.push("-Wunused_lifetimes");
1535 lint_flags.push("-Wsemicolon_in_expressions_from_macros");
1537 if self.config.deny_warnings {
1538 lint_flags.push("-Dwarnings");
1539 rustdocflags.arg("-Dwarnings");
1542 // This does not use RUSTFLAGS due to caching issues with Cargo.
1543 // Clippy is treated as an "in tree" tool, but shares the same
1544 // cache as other "submodule" tools. With these options set in
1545 // RUSTFLAGS, that causes *every* shared dependency to be rebuilt.
1546 // By injecting this into the rustc wrapper, this circumvents
1547 // Cargo's fingerprint detection. This is fine because lint flags
1548 // are always ignored in dependencies. Eventually this should be
1549 // fixed via better support from Cargo.
1550 cargo.env("RUSTC_LINT_FLAGS", lint_flags.join(" "));
1552 rustdocflags.arg("-Wrustdoc::invalid_codeblock_attributes");
1555 if mode == Mode::Rustc {
1556 rustflags.arg("-Zunstable-options");
1557 rustflags.arg("-Wrustc::internal");
1560 // Throughout the build Cargo can execute a number of build scripts
1561 // compiling C/C++ code and we need to pass compilers, archivers, flags, etc
1562 // obtained previously to those build scripts.
1563 // Build scripts use either the `cc` crate or `configure/make` so we pass
1564 // the options through environment variables that are fetched and understood by both.
1566 // FIXME: the guard against msvc shouldn't need to be here
1567 if target.contains("msvc") {
1568 if let Some(ref cl) = self.config.llvm_clang_cl {
1569 cargo.env("CC", cl).env("CXX", cl);
1572 let ccache = self.config.ccache.as_ref();
1573 let ccacheify = |s: &Path| {
1574 let ccache = match ccache {
1576 None => return s.display().to_string(),
1578 // FIXME: the cc-rs crate only recognizes the literal strings
1579 // `ccache` and `sccache` when doing caching compilations, so we
1580 // mirror that here. It should probably be fixed upstream to
1581 // accept a new env var or otherwise work with custom ccache
1584 "ccache" | "sccache" => format!("{} {}", ccache, s.display()),
1585 _ => s.display().to_string(),
1588 let cc = ccacheify(&self.cc(target));
1589 cargo.env(format!("CC_{}", target.triple), &cc);
1591 let cflags = self.cflags(target, GitRepo::Rustc, CLang::C).join(" ");
1592 cargo.env(format!("CFLAGS_{}", target.triple), &cflags);
1594 if let Some(ar) = self.ar(target) {
1595 let ranlib = format!("{} s", ar.display());
1597 .env(format!("AR_{}", target.triple), ar)
1598 .env(format!("RANLIB_{}", target.triple), ranlib);
1601 if let Ok(cxx) = self.cxx(target) {
1602 let cxx = ccacheify(&cxx);
1603 let cxxflags = self.cflags(target, GitRepo::Rustc, CLang::Cxx).join(" ");
1605 .env(format!("CXX_{}", target.triple), &cxx)
1606 .env(format!("CXXFLAGS_{}", target.triple), cxxflags);
1610 if mode == Mode::Std && self.config.extended && compiler.is_final_stage(self) {
1611 rustflags.arg("-Zsave-analysis");
1613 "RUST_SAVE_ANALYSIS_CONFIG",
1614 "{\"output_file\": null,\"full_docs\": false,\
1615 \"pub_only\": true,\"reachable_only\": false,\
1616 \"distro_crate\": true,\"signatures\": false,\"borrow_data\": false}",
1620 // If Control Flow Guard is enabled, pass the `control-flow-guard` flag to rustc
1621 // when compiling the standard library, since this might be linked into the final outputs
1622 // produced by rustc. Since this mitigation is only available on Windows, only enable it
1623 // for the standard library in case the compiler is run on a non-Windows platform.
1624 // This is not needed for stage 0 artifacts because these will only be used for building
1625 // the stage 1 compiler.
1627 && mode == Mode::Std
1628 && self.config.control_flow_guard
1629 && compiler.stage >= 1
1631 rustflags.arg("-Ccontrol-flow-guard");
1634 // For `cargo doc` invocations, make rustdoc print the Rust version into the docs
1635 // This replaces spaces with newlines because RUSTDOCFLAGS does not
1636 // support arguments with regular spaces. Hopefully someday Cargo will
1637 // have space support.
1638 let rust_version = self.rust_version().replace(' ', "\n");
1639 rustdocflags.arg("--crate-version").arg(&rust_version);
1641 // Environment variables *required* throughout the build
1643 // FIXME: should update code to not require this env var
1644 cargo.env("CFG_COMPILER_HOST_TRIPLE", target.triple);
1646 // Set this for all builds to make sure doc builds also get it.
1647 cargo.env("CFG_RELEASE_CHANNEL", &self.config.channel);
1649 // This one's a bit tricky. As of the time of this writing the compiler
1650 // links to the `winapi` crate on crates.io. This crate provides raw
1651 // bindings to Windows system functions, sort of like libc does for
1652 // Unix. This crate also, however, provides "import libraries" for the
1653 // MinGW targets. There's an import library per dll in the windows
1654 // distribution which is what's linked to. These custom import libraries
1655 // are used because the winapi crate can reference Windows functions not
1656 // present in the MinGW import libraries.
1658 // For example MinGW may ship libdbghelp.a, but it may not have
1659 // references to all the functions in the dbghelp dll. Instead the
1660 // custom import library for dbghelp in the winapi crates has all this
1663 // Unfortunately for us though the import libraries are linked by
1664 // default via `-ldylib=winapi_foo`. That is, they're linked with the
1665 // `dylib` type with a `winapi_` prefix (so the winapi ones don't
1666 // conflict with the system MinGW ones). This consequently means that
1667 // the binaries we ship of things like rustc_codegen_llvm (aka the rustc_codegen_llvm
1668 // DLL) when linked against *again*, for example with procedural macros
1669 // or plugins, will trigger the propagation logic of `-ldylib`, passing
1670 // `-lwinapi_foo` to the linker again. This isn't actually available in
1671 // our distribution, however, so the link fails.
1673 // To solve this problem we tell winapi to not use its bundled import
1674 // libraries. This means that it will link to the system MinGW import
1675 // libraries by default, and the `-ldylib=foo` directives will still get
1676 // passed to the final linker, but they'll look like `-lfoo` which can
1677 // be resolved because MinGW has the import library. The downside is we
1678 // don't get newer functions from Windows, but we don't use any of them
1680 if !mode.is_tool() {
1681 cargo.env("WINAPI_NO_BUNDLED_LIBRARIES", "1");
1684 for _ in 0..self.verbosity {
1688 match (mode, self.config.rust_codegen_units_std, self.config.rust_codegen_units) {
1689 (Mode::Std, Some(n), _) | (_, _, Some(n)) => {
1690 cargo.env(profile_var("CODEGEN_UNITS"), n.to_string());
1693 // Don't set anything
1697 if self.config.rust_optimize {
1698 // FIXME: cargo bench/install do not accept `--release`
1699 if cmd != "bench" && cmd != "install" {
1700 cargo.arg("--release");
1704 if self.config.locked_deps {
1705 cargo.arg("--locked");
1707 if self.config.vendor || self.is_sudo {
1708 cargo.arg("--frozen");
1711 // Try to use a sysroot-relative bindir, in case it was configured absolutely.
1712 cargo.env("RUSTC_INSTALL_BINDIR", self.config.bindir_relative());
1714 self.ci_env.force_coloring_in_ci(&mut cargo);
1716 // When we build Rust dylibs they're all intended for intermediate
1717 // usage, so make sure we pass the -Cprefer-dynamic flag instead of
1718 // linking all deps statically into the dylib.
1719 if matches!(mode, Mode::Std | Mode::Rustc) {
1720 rustflags.arg("-Cprefer-dynamic");
1723 // When building incrementally we default to a lower ThinLTO import limit
1724 // (unless explicitly specified otherwise). This will produce a somewhat
1725 // slower code but give way better compile times.
1727 let limit = match self.config.rust_thin_lto_import_instr_limit {
1728 Some(limit) => Some(limit),
1729 None if self.config.incremental => Some(10),
1733 if let Some(limit) = limit {
1734 rustflags.arg(&format!("-Cllvm-args=-import-instr-limit={}", limit));
1738 Cargo { command: cargo, rustflags, rustdocflags }
1741 /// Ensure that a given step is built, returning its output. This will
1742 /// cache the step, so it is safe (and good!) to call this as often as
1743 /// needed to ensure that all dependencies are built.
1744 pub fn ensure<S: Step>(&'a self, step: S) -> S::Output {
1746 let mut stack = self.stack.borrow_mut();
1747 for stack_step in stack.iter() {
1749 if stack_step.downcast_ref::<S>().map_or(true, |stack_step| *stack_step != step) {
1752 let mut out = String::new();
1753 out += &format!("\n\nCycle in build detected when adding {:?}\n", step);
1754 for el in stack.iter().rev() {
1755 out += &format!("\t{:?}\n", el);
1759 if let Some(out) = self.cache.get(&step) {
1760 self.verbose_than(1, &format!("{}c {:?}", " ".repeat(stack.len()), step));
1764 self.verbose_than(1, &format!("{}> {:?}", " ".repeat(stack.len()), step));
1765 stack.push(Box::new(step.clone()));
1769 let start = Instant::now();
1770 let zero = Duration::new(0, 0);
1771 let parent = self.time_spent_on_dependencies.replace(zero);
1772 let out = step.clone().run(self);
1773 let dur = start.elapsed();
1774 let deps = self.time_spent_on_dependencies.replace(parent + dur);
1778 if self.config.print_step_timings && !self.config.dry_run {
1779 let step_string = format!("{:?}", step);
1780 let brace_index = step_string.find("{").unwrap_or(0);
1781 let type_string = type_name::<S>();
1783 "[TIMING] {} {} -- {}.{:03}",
1784 &type_string.strip_prefix("bootstrap::").unwrap_or(type_string),
1785 &step_string[brace_index..],
1792 let mut stack = self.stack.borrow_mut();
1793 let cur_step = stack.pop().expect("step stack empty");
1794 assert_eq!(cur_step.downcast_ref(), Some(&step));
1796 self.verbose_than(1, &format!("{}< {:?}", " ".repeat(self.stack.borrow().len()), step));
1797 self.cache.put(step, out.clone());
1801 /// Ensure that a given step is built *only if it's supposed to be built by default*, returning
1802 /// its output. This will cache the step, so it's safe (and good!) to call this as often as
1803 /// needed to ensure that all dependencies are build.
1804 pub(crate) fn ensure_if_default<T, S: Step<Output = Option<T>>>(
1809 let desc = StepDescription::from::<S>(kind);
1810 let should_run = (desc.should_run)(ShouldRun::new(self, desc.kind));
1812 // Avoid running steps contained in --exclude
1813 for pathset in &should_run.paths {
1814 if desc.is_excluded(self, pathset) {
1819 // Only execute if it's supposed to run as default
1820 if desc.default && should_run.is_really_default() { self.ensure(step) } else { None }
1823 /// Checks if any of the "should_run" paths is in the `Builder` paths.
1824 pub(crate) fn was_invoked_explicitly<S: Step>(&'a self, kind: Kind) -> bool {
1825 let desc = StepDescription::from::<S>(kind);
1826 let should_run = (desc.should_run)(ShouldRun::new(self, desc.kind));
1828 for path in &self.paths {
1829 if should_run.paths.iter().any(|s| s.has(path, Some(desc.kind)))
1830 && !desc.is_excluded(
1832 &PathSet::Suite(TaskPath { path: path.clone(), kind: Some(desc.kind) }),
1846 #[derive(Debug, Clone)]
1847 struct Rustflags(String, TargetSelection);
1850 fn new(target: TargetSelection) -> Rustflags {
1851 let mut ret = Rustflags(String::new(), target);
1852 ret.propagate_cargo_env("RUSTFLAGS");
1856 /// By default, cargo will pick up on various variables in the environment. However, bootstrap
1857 /// reuses those variables to pass additional flags to rustdoc, so by default they get overridden.
1858 /// Explicitly add back any previous value in the environment.
1860 /// `prefix` is usually `RUSTFLAGS` or `RUSTDOCFLAGS`.
1861 fn propagate_cargo_env(&mut self, prefix: &str) {
1862 // Inherit `RUSTFLAGS` by default ...
1865 // ... and also handle target-specific env RUSTFLAGS if they're configured.
1866 let target_specific = format!("CARGO_TARGET_{}_{}", crate::envify(&self.1.triple), prefix);
1867 self.env(&target_specific);
1870 fn env(&mut self, env: &str) {
1871 if let Ok(s) = env::var(env) {
1872 for part in s.split(' ') {
1878 fn arg(&mut self, arg: &str) -> &mut Self {
1879 assert_eq!(arg.split(' ').count(), 1);
1880 if !self.0.is_empty() {
1883 self.0.push_str(arg);
1891 rustflags: Rustflags,
1892 rustdocflags: Rustflags,
1896 pub fn rustdocflag(&mut self, arg: &str) -> &mut Cargo {
1897 self.rustdocflags.arg(arg);
1900 pub fn rustflag(&mut self, arg: &str) -> &mut Cargo {
1901 self.rustflags.arg(arg);
1905 pub fn arg(&mut self, arg: impl AsRef<OsStr>) -> &mut Cargo {
1906 self.command.arg(arg.as_ref());
1910 pub fn args<I, S>(&mut self, args: I) -> &mut Cargo
1912 I: IntoIterator<Item = S>,
1916 self.arg(arg.as_ref());
1921 pub fn env(&mut self, key: impl AsRef<OsStr>, value: impl AsRef<OsStr>) -> &mut Cargo {
1922 // These are managed through rustflag/rustdocflag interfaces.
1923 assert_ne!(key.as_ref(), "RUSTFLAGS");
1924 assert_ne!(key.as_ref(), "RUSTDOCFLAGS");
1925 self.command.env(key.as_ref(), value.as_ref());
1929 pub fn add_rustc_lib_path(&mut self, builder: &Builder<'_>, compiler: Compiler) {
1930 builder.add_rustc_lib_path(compiler, &mut self.command);
1933 pub fn current_dir(&mut self, dir: &Path) -> &mut Cargo {
1934 self.command.current_dir(dir);
1939 impl From<Cargo> for Command {
1940 fn from(mut cargo: Cargo) -> Command {
1941 let rustflags = &cargo.rustflags.0;
1942 if !rustflags.is_empty() {
1943 cargo.command.env("RUSTFLAGS", rustflags);
1946 let rustdocflags = &cargo.rustdocflags.0;
1947 if !rustdocflags.is_empty() {
1948 cargo.command.env("RUSTDOCFLAGS", rustdocflags);