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};
15 use crate::config::{SplitDebuginfo, TargetSelection};
18 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, compile, Crate};
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,
92 pub paths: Vec<PathSet>,
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 or aliases.
153 /// These are generally matched as a path suffix. For example, a
154 /// command-line value of `std` will match if `library/std` is in the
157 /// NOTE: the paths within a set should always be aliases of one another.
158 /// For example, `src/librustdoc` and `src/tools/rustdoc` should be in the same set,
159 /// but `library/core` and `library/std` generally should not, unless there's no way (for that Step)
160 /// to build them separately.
161 Set(BTreeSet<TaskPath>),
162 /// A "suite" of paths.
164 /// These can match as a path suffix (like `Set`), or as a prefix. For
165 /// example, a command-line value of `src/test/ui/abi/variadic-ffi.rs`
166 /// will match `src/test/ui`. A command-line value of `ui` would also
167 /// match `src/test/ui`.
172 fn empty() -> PathSet {
173 PathSet::Set(BTreeSet::new())
176 fn one<P: Into<PathBuf>>(path: P, kind: Kind) -> PathSet {
177 let mut set = BTreeSet::new();
178 set.insert(TaskPath { path: path.into(), kind: Some(kind) });
182 fn has(&self, needle: &Path, module: Option<Kind>) -> bool {
184 PathSet::Set(set) => set.iter().any(|p| Self::check(p, needle, module)),
185 PathSet::Suite(suite) => Self::check(suite, needle, module),
190 fn check(p: &TaskPath, needle: &Path, module: Option<Kind>) -> bool {
191 if let (Some(p_kind), Some(kind)) = (&p.kind, module) {
192 p.path.ends_with(needle) && *p_kind == kind
194 p.path.ends_with(needle)
198 /// Return all `TaskPath`s in `Self` that contain any of the `needles`, removing the
201 /// This is used for `StepDescription::krate`, which passes all matching crates at once to
202 /// `Step::make_run`, rather than calling it many times with a single crate.
203 /// See `tests.rs` for examples.
204 fn intersection_removing_matches(
206 needles: &mut Vec<&Path>,
207 module: Option<Kind>,
209 let mut check = |p| {
210 for (i, n) in needles.iter().enumerate() {
211 let matched = Self::check(p, n, module);
220 PathSet::Set(set) => PathSet::Set(set.iter().filter(|&p| check(p)).cloned().collect()),
221 PathSet::Suite(suite) => {
231 /// A convenience wrapper for Steps which know they have no aliases and all their sets contain only a single path.
233 /// This can be used with [`ShouldRun::krate`], [`ShouldRun::path`], or [`ShouldRun::alias`].
235 pub fn assert_single_path(&self) -> &TaskPath {
237 PathSet::Set(set) => {
238 assert_eq!(set.len(), 1, "called assert_single_path on multiple paths");
239 set.iter().next().unwrap()
241 PathSet::Suite(_) => unreachable!("called assert_single_path on a Suite path"),
246 impl StepDescription {
247 fn from<S: Step>(kind: Kind) -> StepDescription {
250 only_hosts: S::ONLY_HOSTS,
251 should_run: S::should_run,
252 make_run: S::make_run,
253 name: std::any::type_name::<S>(),
258 fn maybe_run(&self, builder: &Builder<'_>, pathsets: Vec<PathSet>) {
259 if pathsets.iter().any(|set| self.is_excluded(builder, set)) {
263 // Determine the targets participating in this rule.
264 let targets = if self.only_hosts { &builder.hosts } else { &builder.targets };
266 for target in targets {
267 let run = RunConfig { builder, paths: pathsets.clone(), target: *target };
268 (self.make_run)(run);
272 fn is_excluded(&self, builder: &Builder<'_>, pathset: &PathSet) -> bool {
273 if builder.config.exclude.iter().any(|e| pathset.has(&e.path, e.kind)) {
274 println!("Skipping {:?} because it is excluded", pathset);
278 if !builder.config.exclude.is_empty() {
279 builder.verbose(&format!(
280 "{:?} not skipped for {:?} -- not in {:?}",
281 pathset, self.name, builder.config.exclude
287 fn run(v: &[StepDescription], builder: &Builder<'_>, paths: &[PathBuf]) {
290 .map(|desc| (desc.should_run)(ShouldRun::new(builder, desc.kind)))
291 .collect::<Vec<_>>();
293 // sanity checks on rules
294 for (desc, should_run) in v.iter().zip(&should_runs) {
296 !should_run.paths.is_empty(),
297 "{:?} should have at least one pathset",
302 if paths.is_empty() || builder.config.include_default_paths {
303 for (desc, should_run) in v.iter().zip(&should_runs) {
304 if desc.default && should_run.is_really_default() {
305 desc.maybe_run(builder, should_run.paths.iter().cloned().collect());
310 // strip CurDir prefix if present
311 let mut paths: Vec<_> =
312 paths.into_iter().map(|p| p.strip_prefix(".").unwrap_or(p)).collect();
314 // Handle all test suite paths.
315 // (This is separate from the loop below to avoid having to handle multiple paths in `is_suite_path` somehow.)
316 paths.retain(|path| {
317 for (desc, should_run) in v.iter().zip(&should_runs) {
318 if let Some(suite) = should_run.is_suite_path(&path) {
319 desc.maybe_run(builder, vec![suite.clone()]);
326 if paths.is_empty() {
330 // Handle all PathSets.
331 for (desc, should_run) in v.iter().zip(&should_runs) {
332 let pathsets = should_run.pathset_for_paths_removing_matches(&mut paths, desc.kind);
333 if !pathsets.is_empty() {
334 desc.maybe_run(builder, pathsets);
338 if !paths.is_empty() {
339 eprintln!("error: no `{}` rules matched {:?}", builder.kind.as_str(), paths,);
341 "help: run `x.py {} --help --verbose` to show a list of available paths",
342 builder.kind.as_str()
345 "note: if you are adding a new Step to bootstrap itself, make sure you register it with `describe!`"
347 crate::detail_exit(1);
352 enum ReallyDefault<'a> {
354 Lazy(Lazy<bool, Box<dyn Fn() -> bool + 'a>>),
357 pub struct ShouldRun<'a> {
358 pub builder: &'a Builder<'a>,
361 // use a BTreeSet to maintain sort order
362 paths: BTreeSet<PathSet>,
364 // If this is a default rule, this is an additional constraint placed on
365 // its run. Generally something like compiler docs being enabled.
366 is_really_default: ReallyDefault<'a>,
369 impl<'a> ShouldRun<'a> {
370 fn new(builder: &'a Builder<'_>, kind: Kind) -> ShouldRun<'a> {
374 paths: BTreeSet::new(),
375 is_really_default: ReallyDefault::Bool(true), // by default no additional conditions
379 pub fn default_condition(mut self, cond: bool) -> Self {
380 self.is_really_default = ReallyDefault::Bool(cond);
384 pub fn lazy_default_condition(mut self, lazy_cond: Box<dyn Fn() -> bool + 'a>) -> Self {
385 self.is_really_default = ReallyDefault::Lazy(Lazy::new(lazy_cond));
389 pub fn is_really_default(&self) -> bool {
390 match &self.is_really_default {
391 ReallyDefault::Bool(val) => *val,
392 ReallyDefault::Lazy(lazy) => *lazy.deref(),
396 /// Indicates it should run if the command-line selects the given crate or
397 /// any of its (local) dependencies.
399 /// Compared to `krate`, this treats the dependencies as aliases for the
400 /// same job. Generally it is preferred to use `krate`, and treat each
401 /// individual path separately. For example `./x.py test src/liballoc`
402 /// (which uses `krate`) will test just `liballoc`. However, `./x.py check
403 /// src/liballoc` (which uses `all_krates`) will check all of `libtest`.
404 /// `all_krates` should probably be removed at some point.
405 pub fn all_krates(mut self, name: &str) -> Self {
406 let mut set = BTreeSet::new();
407 for krate in self.builder.in_tree_crates(name, None) {
408 let path = krate.local_path(self.builder);
409 set.insert(TaskPath { path, kind: Some(self.kind) });
411 self.paths.insert(PathSet::Set(set));
415 /// Indicates it should run if the command-line selects the given crate or
416 /// any of its (local) dependencies.
418 /// `make_run` will be called a single time with all matching command-line paths.
419 pub fn crate_or_deps(self, name: &str) -> Self {
420 let crates = self.builder.in_tree_crates(name, None);
424 /// Indicates it should run if the command-line selects any of the given crates.
426 /// `make_run` will be called a single time with all matching command-line paths.
427 pub(crate) fn crates(mut self, crates: Vec<&Crate>) -> Self {
428 for krate in crates {
429 let path = krate.local_path(self.builder);
430 self.paths.insert(PathSet::one(path, self.kind));
435 // single alias, which does not correspond to any on-disk path
436 pub fn alias(mut self, alias: &str) -> Self {
437 // exceptional case for `Kind::Setup` because its `library`
438 // and `compiler` options would otherwise naively match with
439 // `compiler` and `library` folders respectively.
441 self.kind == Kind::Setup || !self.builder.src.join(alias).exists(),
442 "use `builder.path()` for real paths: {}",
445 self.paths.insert(PathSet::Set(
446 std::iter::once(TaskPath { path: alias.into(), kind: Some(self.kind) }).collect(),
451 // single, non-aliased path
452 pub fn path(self, path: &str) -> Self {
456 // multiple aliases for the same job
457 pub fn paths(mut self, paths: &[&str]) -> Self {
458 self.paths.insert(PathSet::Set(
462 // FIXME(#96188): make sure this is actually a path.
463 // This currently breaks for paths within submodules.
465 // self.builder.src.join(p).exists(),
466 // "`should_run.paths` should correspond to real on-disk paths - use `alias` if there is no relevant path: {}",
469 TaskPath { path: p.into(), kind: Some(self.kind) }
476 /// Handles individual files (not directories) within a test suite.
477 fn is_suite_path(&self, requested_path: &Path) -> Option<&PathSet> {
478 self.paths.iter().find(|pathset| match pathset {
479 PathSet::Suite(suite) => requested_path.starts_with(&suite.path),
480 PathSet::Set(_) => false,
484 pub fn suite_path(mut self, suite: &str) -> Self {
485 self.paths.insert(PathSet::Suite(TaskPath { path: suite.into(), kind: Some(self.kind) }));
489 // allows being more explicit about why should_run in Step returns the value passed to it
490 pub fn never(mut self) -> ShouldRun<'a> {
491 self.paths.insert(PathSet::empty());
495 /// Given a set of requested paths, return the subset which match the Step for this `ShouldRun`,
496 /// removing the matches from `paths`.
498 /// NOTE: this returns multiple PathSets to allow for the possibility of multiple units of work
499 /// within the same step. For example, `test::Crate` allows testing multiple crates in the same
500 /// cargo invocation, which are put into separate sets because they aren't aliases.
502 /// The reason we return PathSet instead of PathBuf is to allow for aliases that mean the same thing
503 /// (for now, just `all_krates` and `paths`, but we may want to add an `aliases` function in the future?)
504 fn pathset_for_paths_removing_matches(
506 paths: &mut Vec<&Path>,
509 let mut sets = vec![];
510 for pathset in &self.paths {
511 let subset = pathset.intersection_removing_matches(paths, Some(kind));
512 if subset != PathSet::empty() {
520 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug)]
538 pub fn parse(string: &str) -> Option<Kind> {
539 // these strings, including the one-letter aliases, must match the x.py help text
541 "build" | "b" => Kind::Build,
542 "check" | "c" => Kind::Check,
543 "clippy" => Kind::Clippy,
545 "fmt" => Kind::Format,
546 "test" | "t" => Kind::Test,
547 "bench" => Kind::Bench,
548 "doc" | "d" => Kind::Doc,
549 "clean" => Kind::Clean,
550 "dist" => Kind::Dist,
551 "install" => Kind::Install,
552 "run" | "r" => Kind::Run,
553 "setup" => Kind::Setup,
558 pub fn as_str(&self) -> &'static str {
560 Kind::Build => "build",
561 Kind::Check => "check",
562 Kind::Clippy => "clippy",
564 Kind::Format => "fmt",
565 Kind::Test => "test",
566 Kind::Bench => "bench",
568 Kind::Clean => "clean",
569 Kind::Dist => "dist",
570 Kind::Install => "install",
572 Kind::Setup => "setup",
577 impl<'a> Builder<'a> {
578 fn get_step_descriptions(kind: Kind) -> Vec<StepDescription> {
579 macro_rules! describe {
580 ($($rule:ty),+ $(,)?) => {{
581 vec![$(StepDescription::from::<$rule>(kind)),+]
585 Kind::Build => describe!(
589 compile::CodegenBackend,
590 compile::StartupObjects,
594 tool::UnstableBookGen,
599 tool::RemoteTestServer,
600 tool::RemoteTestClient,
605 tool::RustAnalyzerProcMacroSrv,
618 Kind::Check | Kind::Clippy | Kind::Fix => describe!(
622 check::CodegenBackend,
626 check::MiroptTestTools,
632 Kind::Test => describe!(
633 crate::toolstate::ToolStateCheck,
634 test::ExpandYamlAnchors,
637 test::RunPassValgrind,
650 test::CrateRustdocJsonTypes,
651 test::CrateJsonDocLint,
654 test::ReplacePlaceholderTest,
660 test::RunMakeFullDeps,
676 test::CompiletestTest,
678 test::RustdocJSNotStd,
684 // Run bootstrap close to the end as it's unlikely to fail
686 // Run run-make last, since these won't pass without make on Windows
689 Kind::Bench => describe!(test::Crate, test::CrateLibrustc),
690 Kind::Doc => describe!(
692 doc::UnstableBookGen,
713 Kind::Dist => describe!(
734 // It seems that PlainSourceTarball somehow changes how some of the tools
735 // perceive their dependencies (see #93033) which would invalidate fingerprints
736 // and force us to rebuild tools after vendoring dependencies.
737 // To work around this, create the Tarball after building all the tools.
738 dist::PlainSourceTarball,
740 dist::ReproducibleArtifacts,
742 Kind::Install => describe!(
746 install::RustAnalyzer,
748 install::RustDemangler,
756 Kind::Run => describe!(
757 run::ExpandYamlAnchors,
760 run::ReplaceVersionPlaceholder,
762 run::CollectLicenseMetadata,
763 run::GenerateCopyright,
765 Kind::Setup => describe!(setup::Profile),
766 // These commands either don't use paths, or they're special-cased in Build::build()
767 Kind::Clean | Kind::Format => vec![],
771 pub fn get_help(build: &Build, kind: Kind) -> Option<String> {
772 let step_descriptions = Builder::get_step_descriptions(kind);
773 if step_descriptions.is_empty() {
777 let builder = Self::new_internal(build, kind, vec![]);
778 let builder = &builder;
779 // The "build" kind here is just a placeholder, it will be replaced with something else in
780 // the following statement.
781 let mut should_run = ShouldRun::new(builder, Kind::Build);
782 for desc in step_descriptions {
783 should_run.kind = desc.kind;
784 should_run = (desc.should_run)(should_run);
786 let mut help = String::from("Available paths:\n");
787 let mut add_path = |path: &Path| {
788 t!(write!(help, " ./x.py {} {}\n", kind.as_str(), path.display()));
790 for pathset in should_run.paths {
792 PathSet::Set(set) => {
794 add_path(&path.path);
797 PathSet::Suite(path) => {
798 add_path(&path.path.join("..."));
805 fn new_internal(build: &Build, kind: Kind, paths: Vec<PathBuf>) -> Builder<'_> {
808 top_stage: build.config.stage,
811 stack: RefCell::new(Vec::new()),
812 time_spent_on_dependencies: Cell::new(Duration::new(0, 0)),
817 pub fn new(build: &Build) -> Builder<'_> {
818 let (kind, paths) = match build.config.cmd {
819 Subcommand::Build { ref paths } => (Kind::Build, &paths[..]),
820 Subcommand::Check { ref paths } => (Kind::Check, &paths[..]),
821 Subcommand::Clippy { ref paths, .. } => (Kind::Clippy, &paths[..]),
822 Subcommand::Fix { ref paths } => (Kind::Fix, &paths[..]),
823 Subcommand::Doc { ref paths, .. } => (Kind::Doc, &paths[..]),
824 Subcommand::Test { ref paths, .. } => (Kind::Test, &paths[..]),
825 Subcommand::Bench { ref paths, .. } => (Kind::Bench, &paths[..]),
826 Subcommand::Dist { ref paths } => (Kind::Dist, &paths[..]),
827 Subcommand::Install { ref paths } => (Kind::Install, &paths[..]),
828 Subcommand::Run { ref paths, .. } => (Kind::Run, &paths[..]),
829 Subcommand::Format { .. } => (Kind::Format, &[][..]),
830 Subcommand::Setup { profile: ref path } => (
832 path.as_ref().map_or([].as_slice(), |path| std::slice::from_ref(path)),
834 Subcommand::Clean { .. } => {
839 Self::new_internal(build, kind, paths.to_owned())
842 pub fn execute_cli(&self) {
843 self.run_step_descriptions(&Builder::get_step_descriptions(self.kind), &self.paths);
846 pub fn default_doc(&self, paths: &[PathBuf]) {
847 self.run_step_descriptions(&Builder::get_step_descriptions(Kind::Doc), paths);
850 /// NOTE: keep this in sync with `rustdoc::clean::utils::doc_rust_lang_org_channel`, or tests will fail on beta/stable.
851 pub fn doc_rust_lang_org_channel(&self) -> String {
852 let channel = match &*self.config.channel {
853 "stable" => &self.version,
855 "nightly" | "dev" => "nightly",
856 // custom build of rustdoc maybe? link to the latest stable docs just in case
859 "https://doc.rust-lang.org/".to_owned() + channel
862 fn run_step_descriptions(&self, v: &[StepDescription], paths: &[PathBuf]) {
863 StepDescription::run(v, self, paths);
866 /// Obtain a compiler at a given stage and for a given host. Explicitly does
867 /// not take `Compiler` since all `Compiler` instances are meant to be
868 /// obtained through this function, since it ensures that they are valid
869 /// (i.e., built and assembled).
870 pub fn compiler(&self, stage: u32, host: TargetSelection) -> Compiler {
871 self.ensure(compile::Assemble { target_compiler: Compiler { stage, host } })
874 /// Similar to `compiler`, except handles the full-bootstrap option to
875 /// silently use the stage1 compiler instead of a stage2 compiler if one is
878 /// Note that this does *not* have the side effect of creating
879 /// `compiler(stage, host)`, unlike `compiler` above which does have such
880 /// a side effect. The returned compiler here can only be used to compile
881 /// new artifacts, it can't be used to rely on the presence of a particular
884 /// See `force_use_stage1` for documentation on what each argument is.
888 host: TargetSelection,
889 target: TargetSelection,
891 if self.build.force_use_stage1(Compiler { stage, host }, target) {
892 self.compiler(1, self.config.build)
894 self.compiler(stage, host)
898 pub fn sysroot(&self, compiler: Compiler) -> Interned<PathBuf> {
899 self.ensure(compile::Sysroot { compiler })
902 /// Returns the libdir where the standard library and other artifacts are
903 /// found for a compiler's sysroot.
904 pub fn sysroot_libdir(&self, compiler: Compiler, target: TargetSelection) -> Interned<PathBuf> {
905 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
908 target: TargetSelection,
910 impl Step for Libdir {
911 type Output = Interned<PathBuf>;
913 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
917 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
918 let lib = builder.sysroot_libdir_relative(self.compiler);
919 let sysroot = builder
920 .sysroot(self.compiler)
923 .join(self.target.triple)
925 // Avoid deleting the rustlib/ directory we just copied
926 // (in `impl Step for Sysroot`).
927 if !builder.download_rustc() {
928 let _ = fs::remove_dir_all(&sysroot);
929 t!(fs::create_dir_all(&sysroot));
931 INTERNER.intern_path(sysroot)
934 self.ensure(Libdir { compiler, target })
937 pub fn sysroot_codegen_backends(&self, compiler: Compiler) -> PathBuf {
938 self.sysroot_libdir(compiler, compiler.host).with_file_name("codegen-backends")
941 /// Returns the compiler's libdir where it stores the dynamic libraries that
942 /// it itself links against.
944 /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
946 pub fn rustc_libdir(&self, compiler: Compiler) -> PathBuf {
947 if compiler.is_snapshot(self) {
948 self.rustc_snapshot_libdir()
950 match self.config.libdir_relative() {
951 Some(relative_libdir) if compiler.stage >= 1 => {
952 self.sysroot(compiler).join(relative_libdir)
954 _ => self.sysroot(compiler).join(libdir(compiler.host)),
959 /// Returns the compiler's relative libdir where it stores the dynamic libraries that
960 /// it itself links against.
962 /// For example this returns `lib` on Unix and `bin` on
964 pub fn libdir_relative(&self, compiler: Compiler) -> &Path {
965 if compiler.is_snapshot(self) {
966 libdir(self.config.build).as_ref()
968 match self.config.libdir_relative() {
969 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
970 _ => libdir(compiler.host).as_ref(),
975 /// Returns the compiler's relative libdir where the standard library and other artifacts are
976 /// found for a compiler's sysroot.
978 /// For example this returns `lib` on Unix and Windows.
979 pub fn sysroot_libdir_relative(&self, compiler: Compiler) -> &Path {
980 match self.config.libdir_relative() {
981 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
982 _ if compiler.stage == 0 => &self.build.initial_libdir,
983 _ => Path::new("lib"),
987 pub fn rustc_lib_paths(&self, compiler: Compiler) -> Vec<PathBuf> {
988 let mut dylib_dirs = vec![self.rustc_libdir(compiler)];
990 // Ensure that the downloaded LLVM libraries can be found.
991 if self.config.llvm_from_ci {
992 let ci_llvm_lib = self.out.join(&*compiler.host.triple).join("ci-llvm").join("lib");
993 dylib_dirs.push(ci_llvm_lib);
999 /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
1000 /// library lookup path.
1001 pub fn add_rustc_lib_path(&self, compiler: Compiler, cmd: &mut Command) {
1002 // Windows doesn't need dylib path munging because the dlls for the
1003 // compiler live next to the compiler and the system will find them
1009 add_dylib_path(self.rustc_lib_paths(compiler), cmd);
1012 /// Gets a path to the compiler specified.
1013 pub fn rustc(&self, compiler: Compiler) -> PathBuf {
1014 if compiler.is_snapshot(self) {
1015 self.initial_rustc.clone()
1017 self.sysroot(compiler).join("bin").join(exe("rustc", compiler.host))
1021 /// Gets the paths to all of the compiler's codegen backends.
1022 fn codegen_backends(&self, compiler: Compiler) -> impl Iterator<Item = PathBuf> {
1023 fs::read_dir(self.sysroot_codegen_backends(compiler))
1026 .filter_map(Result::ok)
1027 .map(|entry| entry.path())
1030 pub fn rustdoc(&self, compiler: Compiler) -> PathBuf {
1031 self.ensure(tool::Rustdoc { compiler })
1034 pub fn rustdoc_cmd(&self, compiler: Compiler) -> Command {
1035 let mut cmd = Command::new(&self.bootstrap_out.join("rustdoc"));
1036 cmd.env("RUSTC_STAGE", compiler.stage.to_string())
1037 .env("RUSTC_SYSROOT", self.sysroot(compiler))
1038 // Note that this is *not* the sysroot_libdir because rustdoc must be linked
1039 // equivalently to rustc.
1040 .env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler))
1041 .env("CFG_RELEASE_CHANNEL", &self.config.channel)
1042 .env("RUSTDOC_REAL", self.rustdoc(compiler))
1043 .env("RUSTC_BOOTSTRAP", "1");
1045 cmd.arg("-Wrustdoc::invalid_codeblock_attributes");
1047 if self.config.deny_warnings {
1048 cmd.arg("-Dwarnings");
1050 cmd.arg("-Znormalize-docs");
1052 // Remove make-related flags that can cause jobserver problems.
1053 cmd.env_remove("MAKEFLAGS");
1054 cmd.env_remove("MFLAGS");
1056 if let Some(linker) = self.linker(compiler.host) {
1057 cmd.env("RUSTDOC_LINKER", linker);
1059 if self.is_fuse_ld_lld(compiler.host) {
1060 cmd.env("RUSTDOC_FUSE_LD_LLD", "1");
1065 /// Return the path to `llvm-config` for the target, if it exists.
1067 /// Note that this returns `None` if LLVM is disabled, or if we're in a
1068 /// check build or dry-run, where there's no need to build all of LLVM.
1069 fn llvm_config(&self, target: TargetSelection) -> Option<PathBuf> {
1070 if self.config.llvm_enabled() && self.kind != Kind::Check && !self.config.dry_run() {
1071 let llvm_config = self.ensure(native::Llvm { target });
1072 if llvm_config.is_file() {
1073 return Some(llvm_config);
1079 /// Prepares an invocation of `cargo` to be run.
1081 /// This will create a `Command` that represents a pending execution of
1082 /// Cargo. This cargo will be configured to use `compiler` as the actual
1083 /// rustc compiler, its output will be scoped by `mode`'s output directory,
1084 /// it will pass the `--target` flag for the specified `target`, and will be
1085 /// executing the Cargo command `cmd`.
1090 source_type: SourceType,
1091 target: TargetSelection,
1094 let mut cargo = Command::new(&self.initial_cargo);
1095 let out_dir = self.stage_out(compiler, mode);
1096 // Run cargo from the source root so it can find .cargo/config.
1097 // This matters when using vendoring and the working directory is outside the repository.
1098 cargo.current_dir(&self.src);
1100 // Codegen backends are not yet tracked by -Zbinary-dep-depinfo,
1101 // so we need to explicitly clear out if they've been updated.
1102 for backend in self.codegen_backends(compiler) {
1103 self.clear_if_dirty(&out_dir, &backend);
1106 if cmd == "doc" || cmd == "rustdoc" {
1107 let my_out = match mode {
1108 // This is the intended out directory for compiler documentation.
1109 Mode::Rustc | Mode::ToolRustc => self.compiler_doc_out(target),
1111 if self.config.cmd.json() {
1112 out_dir.join(target.triple).join("json-doc")
1114 out_dir.join(target.triple).join("doc")
1117 _ => panic!("doc mode {:?} not expected", mode),
1119 let rustdoc = self.rustdoc(compiler);
1120 self.clear_if_dirty(&my_out, &rustdoc);
1123 cargo.env("CARGO_TARGET_DIR", &out_dir).arg(cmd);
1125 let profile_var = |name: &str| {
1126 let profile = if self.config.rust_optimize { "RELEASE" } else { "DEV" };
1127 format!("CARGO_PROFILE_{}_{}", profile, name)
1130 // See comment in rustc_llvm/build.rs for why this is necessary, largely llvm-config
1131 // needs to not accidentally link to libLLVM in stage0/lib.
1132 cargo.env("REAL_LIBRARY_PATH_VAR", &util::dylib_path_var());
1133 if let Some(e) = env::var_os(util::dylib_path_var()) {
1134 cargo.env("REAL_LIBRARY_PATH", e);
1137 // Found with `rg "init_env_logger\("`. If anyone uses `init_env_logger`
1138 // from out of tree it shouldn't matter, since x.py is only used for
1139 // building in-tree.
1140 let color_logs = ["RUSTDOC_LOG_COLOR", "RUSTC_LOG_COLOR", "RUST_LOG_COLOR"];
1141 match self.build.config.color {
1143 cargo.arg("--color=always");
1144 for log in &color_logs {
1145 cargo.env(log, "always");
1149 cargo.arg("--color=never");
1150 for log in &color_logs {
1151 cargo.env(log, "never");
1154 Color::Auto => {} // nothing to do
1157 if cmd != "install" {
1158 cargo.arg("--target").arg(target.rustc_target_arg());
1160 assert_eq!(target, compiler.host);
1163 // Set a flag for `check`/`clippy`/`fix`, so that certain build
1164 // scripts can do less work (i.e. not building/requiring LLVM).
1165 if cmd == "check" || cmd == "clippy" || cmd == "fix" {
1166 // If we've not yet built LLVM, or it's stale, then bust
1167 // the rustc_llvm cache. That will always work, even though it
1168 // may mean that on the next non-check build we'll need to rebuild
1169 // rustc_llvm. But if LLVM is stale, that'll be a tiny amount
1170 // of work comparatively, and we'd likely need to rebuild it anyway,
1172 if crate::native::prebuilt_llvm_config(self, target).is_err() {
1173 cargo.env("RUST_CHECK", "1");
1177 let stage = if compiler.stage == 0 && self.local_rebuild {
1178 // Assume the local-rebuild rustc already has stage1 features.
1184 let mut rustflags = Rustflags::new(target);
1186 if let Ok(s) = env::var("CARGOFLAGS_NOT_BOOTSTRAP") {
1187 cargo.args(s.split_whitespace());
1189 rustflags.env("RUSTFLAGS_NOT_BOOTSTRAP");
1191 if let Ok(s) = env::var("CARGOFLAGS_BOOTSTRAP") {
1192 cargo.args(s.split_whitespace());
1194 rustflags.env("RUSTFLAGS_BOOTSTRAP");
1195 if cmd == "clippy" {
1196 // clippy overwrites sysroot if we pass it to cargo.
1197 // Pass it directly to clippy instead.
1198 // NOTE: this can't be fixed in clippy because we explicitly don't set `RUSTC`,
1199 // so it has no way of knowing the sysroot.
1200 rustflags.arg("--sysroot");
1202 self.sysroot(compiler)
1205 .expect("sysroot must be valid UTF-8"),
1207 // Only run clippy on a very limited subset of crates (in particular, not build scripts).
1208 cargo.arg("-Zunstable-options");
1209 // Explicitly does *not* set `--cfg=bootstrap`, since we're using a nightly clippy.
1210 let host_version = Command::new("rustc").arg("--version").output().map_err(|_| ());
1211 let output = host_version.and_then(|output| {
1212 if output.status.success() {
1217 }).unwrap_or_else(|_| {
1219 "error: `x.py clippy` requires a host `rustc` toolchain with the `clippy` component"
1221 eprintln!("help: try `rustup component add clippy`");
1222 crate::detail_exit(1);
1224 if !t!(std::str::from_utf8(&output.stdout)).contains("nightly") {
1225 rustflags.arg("--cfg=bootstrap");
1228 rustflags.arg("--cfg=bootstrap");
1232 let use_new_symbol_mangling = match self.config.rust_new_symbol_mangling {
1234 // If an explicit setting is given, use that
1238 if mode == Mode::Std {
1239 // The standard library defaults to the legacy scheme
1242 // The compiler and tools default to the new scheme
1248 if use_new_symbol_mangling {
1249 rustflags.arg("-Csymbol-mangling-version=v0");
1251 rustflags.arg("-Csymbol-mangling-version=legacy");
1252 rustflags.arg("-Zunstable-options");
1255 // Enable cfg checking of cargo features for everything but std and also enable cfg
1256 // checking of names and values.
1258 // Note: `std`, `alloc` and `core` imports some dependencies by #[path] (like
1259 // backtrace, core_simd, std_float, ...), those dependencies have their own
1260 // features but cargo isn't involved in the #[path] process and so cannot pass the
1261 // complete list of features, so for that reason we don't enable checking of
1262 // features for std crates.
1263 cargo.arg(if mode != Mode::Std {
1264 "-Zcheck-cfg=names,values,output,features"
1266 "-Zcheck-cfg=names,values,output"
1269 // Add extra cfg not defined in/by rustc
1271 // Note: Altrough it would seems that "-Zunstable-options" to `rustflags` is useless as
1272 // cargo would implicitly add it, it was discover that sometimes bootstrap only use
1273 // `rustflags` without `cargo` making it required.
1274 rustflags.arg("-Zunstable-options");
1275 for (restricted_mode, name, values) in EXTRA_CHECK_CFGS {
1276 if *restricted_mode == None || *restricted_mode == Some(mode) {
1277 // Creating a string of the values by concatenating each value:
1278 // ',"tvos","watchos"' or '' (nothing) when there are no values
1279 let values = match values {
1280 Some(values) => values
1282 .map(|val| [",", "\"", val, "\""])
1284 .collect::<String>(),
1285 None => String::new(),
1287 rustflags.arg(&format!("--check-cfg=values({name}{values})"));
1291 // FIXME: It might be better to use the same value for both `RUSTFLAGS` and `RUSTDOCFLAGS`,
1292 // but this breaks CI. At the very least, stage0 `rustdoc` needs `--cfg bootstrap`. See
1294 let mut rustdocflags = rustflags.clone();
1295 rustdocflags.propagate_cargo_env("RUSTDOCFLAGS");
1297 rustdocflags.env("RUSTDOCFLAGS_BOOTSTRAP");
1299 rustdocflags.env("RUSTDOCFLAGS_NOT_BOOTSTRAP");
1302 if let Ok(s) = env::var("CARGOFLAGS") {
1303 cargo.args(s.split_whitespace());
1307 Mode::Std | Mode::ToolBootstrap | Mode::ToolStd => {}
1308 Mode::Rustc | Mode::Codegen | Mode::ToolRustc => {
1309 // Build proc macros both for the host and the target
1310 if target != compiler.host && cmd != "check" {
1311 cargo.arg("-Zdual-proc-macros");
1312 rustflags.arg("-Zdual-proc-macros");
1317 // This tells Cargo (and in turn, rustc) to output more complete
1318 // dependency information. Most importantly for rustbuild, this
1319 // includes sysroot artifacts, like libstd, which means that we don't
1320 // need to track those in rustbuild (an error prone process!). This
1321 // feature is currently unstable as there may be some bugs and such, but
1322 // it represents a big improvement in rustbuild's reliability on
1323 // rebuilds, so we're using it here.
1325 // For some additional context, see #63470 (the PR originally adding
1326 // this), as well as #63012 which is the tracking issue for this
1327 // feature on the rustc side.
1328 cargo.arg("-Zbinary-dep-depinfo");
1330 Mode::ToolBootstrap => {
1331 // Restrict the allowed features to those passed by rustbuild, so we don't depend on nightly accidentally.
1332 rustflags.arg("-Zallow-features=binary-dep-depinfo");
1335 // Right now this is just compiletest and a few other tools that build on stable.
1336 // Allow them to use `feature(test)`, but nothing else.
1337 rustflags.arg("-Zallow-features=binary-dep-depinfo,test,proc_macro_internals,proc_macro_diagnostic,proc_macro_span");
1339 Mode::Std | Mode::Rustc | Mode::Codegen | Mode::ToolRustc => {}
1342 cargo.arg("-j").arg(self.jobs().to_string());
1343 // Remove make-related flags to ensure Cargo can correctly set things up
1344 cargo.env_remove("MAKEFLAGS");
1345 cargo.env_remove("MFLAGS");
1347 // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
1348 // Force cargo to output binaries with disambiguating hashes in the name
1349 let mut metadata = if compiler.stage == 0 {
1350 // Treat stage0 like a special channel, whether it's a normal prior-
1351 // release rustc or a local rebuild with the same version, so we
1352 // never mix these libraries by accident.
1353 "bootstrap".to_string()
1355 self.config.channel.to_string()
1357 // We want to make sure that none of the dependencies between
1358 // std/test/rustc unify with one another. This is done for weird linkage
1359 // reasons but the gist of the problem is that if librustc, libtest, and
1360 // libstd all depend on libc from crates.io (which they actually do) we
1361 // want to make sure they all get distinct versions. Things get really
1362 // weird if we try to unify all these dependencies right now, namely
1363 // around how many times the library is linked in dynamic libraries and
1364 // such. If rustc were a static executable or if we didn't ship dylibs
1365 // this wouldn't be a problem, but we do, so it is. This is in general
1366 // just here to make sure things build right. If you can remove this and
1367 // things still build right, please do!
1369 Mode::Std => metadata.push_str("std"),
1370 // When we're building rustc tools, they're built with a search path
1371 // that contains things built during the rustc build. For example,
1372 // bitflags is built during the rustc build, and is a dependency of
1373 // rustdoc as well. We're building rustdoc in a different target
1374 // directory, though, which means that Cargo will rebuild the
1375 // dependency. When we go on to build rustdoc, we'll look for
1376 // bitflags, and find two different copies: one built during the
1377 // rustc step and one that we just built. This isn't always a
1378 // problem, somehow -- not really clear why -- but we know that this
1380 Mode::ToolRustc => metadata.push_str("tool-rustc"),
1381 // Same for codegen backends.
1382 Mode::Codegen => metadata.push_str("codegen"),
1385 cargo.env("__CARGO_DEFAULT_LIB_METADATA", &metadata);
1387 if cmd == "clippy" {
1388 rustflags.arg("-Zforce-unstable-if-unmarked");
1391 rustflags.arg("-Zmacro-backtrace");
1393 let want_rustdoc = self.doc_tests != DocTests::No;
1395 // We synthetically interpret a stage0 compiler used to build tools as a
1396 // "raw" compiler in that it's the exact snapshot we download. Normally
1397 // the stage0 build means it uses libraries build by the stage0
1398 // compiler, but for tools we just use the precompiled libraries that
1400 let use_snapshot = mode == Mode::ToolBootstrap;
1401 assert!(!use_snapshot || stage == 0 || self.local_rebuild);
1403 let maybe_sysroot = self.sysroot(compiler);
1404 let sysroot = if use_snapshot { self.rustc_snapshot_sysroot() } else { &maybe_sysroot };
1405 let libdir = self.rustc_libdir(compiler);
1407 // Clear the output directory if the real rustc we're using has changed;
1408 // Cargo cannot detect this as it thinks rustc is bootstrap/debug/rustc.
1410 // Avoid doing this during dry run as that usually means the relevant
1411 // compiler is not yet linked/copied properly.
1413 // Only clear out the directory if we're compiling std; otherwise, we
1414 // should let Cargo take care of things for us (via depdep info)
1415 if !self.config.dry_run() && mode == Mode::Std && cmd == "build" {
1416 self.clear_if_dirty(&out_dir, &self.rustc(compiler));
1419 // Customize the compiler we're running. Specify the compiler to cargo
1420 // as our shim and then pass it some various options used to configure
1421 // how the actual compiler itself is called.
1423 // These variables are primarily all read by
1424 // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
1426 .env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
1427 .env("RUSTC_REAL", self.rustc(compiler))
1428 .env("RUSTC_STAGE", stage.to_string())
1429 .env("RUSTC_SYSROOT", &sysroot)
1430 .env("RUSTC_LIBDIR", &libdir)
1431 .env("RUSTDOC", self.bootstrap_out.join("rustdoc"))
1434 if cmd == "doc" || cmd == "rustdoc" || (cmd == "test" && want_rustdoc) {
1435 self.rustdoc(compiler)
1437 PathBuf::from("/path/to/nowhere/rustdoc/not/required")
1440 .env("RUSTC_ERROR_METADATA_DST", self.extended_error_dir())
1441 .env("RUSTC_BREAK_ON_ICE", "1");
1442 // Clippy support is a hack and uses the default `cargo-clippy` in path.
1443 // Don't override RUSTC so that the `cargo-clippy` in path will be run.
1444 if cmd != "clippy" {
1445 cargo.env("RUSTC", self.bootstrap_out.join("rustc"));
1448 // Dealing with rpath here is a little special, so let's go into some
1449 // detail. First off, `-rpath` is a linker option on Unix platforms
1450 // which adds to the runtime dynamic loader path when looking for
1451 // dynamic libraries. We use this by default on Unix platforms to ensure
1452 // that our nightlies behave the same on Windows, that is they work out
1453 // of the box. This can be disabled, of course, but basically that's why
1454 // we're gated on RUSTC_RPATH here.
1456 // Ok, so the astute might be wondering "why isn't `-C rpath` used
1457 // here?" and that is indeed a good question to ask. This codegen
1458 // option is the compiler's current interface to generating an rpath.
1459 // Unfortunately it doesn't quite suffice for us. The flag currently
1460 // takes no value as an argument, so the compiler calculates what it
1461 // should pass to the linker as `-rpath`. This unfortunately is based on
1462 // the **compile time** directory structure which when building with
1463 // Cargo will be very different than the runtime directory structure.
1465 // All that's a really long winded way of saying that if we use
1466 // `-Crpath` then the executables generated have the wrong rpath of
1467 // something like `$ORIGIN/deps` when in fact the way we distribute
1468 // rustc requires the rpath to be `$ORIGIN/../lib`.
1470 // So, all in all, to set up the correct rpath we pass the linker
1471 // argument manually via `-C link-args=-Wl,-rpath,...`. Plus isn't it
1472 // fun to pass a flag to a tool to pass a flag to pass a flag to a tool
1473 // to change a flag in a binary?
1474 if self.config.rust_rpath && util::use_host_linker(target) {
1475 let rpath = if target.contains("apple") {
1476 // Note that we need to take one extra step on macOS to also pass
1477 // `-Wl,-instal_name,@rpath/...` to get things to work right. To
1478 // do that we pass a weird flag to the compiler to get it to do
1479 // so. Note that this is definitely a hack, and we should likely
1480 // flesh out rpath support more fully in the future.
1481 rustflags.arg("-Zosx-rpath-install-name");
1482 Some("-Wl,-rpath,@loader_path/../lib")
1483 } else if !target.contains("windows") {
1484 rustflags.arg("-Clink-args=-Wl,-z,origin");
1485 Some("-Wl,-rpath,$ORIGIN/../lib")
1489 if let Some(rpath) = rpath {
1490 rustflags.arg(&format!("-Clink-args={}", rpath));
1494 if let Some(host_linker) = self.linker(compiler.host) {
1495 cargo.env("RUSTC_HOST_LINKER", host_linker);
1497 if self.is_fuse_ld_lld(compiler.host) {
1498 cargo.env("RUSTC_HOST_FUSE_LD_LLD", "1");
1499 cargo.env("RUSTDOC_FUSE_LD_LLD", "1");
1502 if let Some(target_linker) = self.linker(target) {
1503 let target = crate::envify(&target.triple);
1504 cargo.env(&format!("CARGO_TARGET_{}_LINKER", target), target_linker);
1506 if self.is_fuse_ld_lld(target) {
1507 rustflags.arg("-Clink-args=-fuse-ld=lld");
1509 self.lld_flags(target).for_each(|flag| {
1510 rustdocflags.arg(&flag);
1513 if !(["build", "check", "clippy", "fix", "rustc"].contains(&cmd)) && want_rustdoc {
1514 cargo.env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler));
1517 let debuginfo_level = match mode {
1518 Mode::Rustc | Mode::Codegen => self.config.rust_debuginfo_level_rustc,
1519 Mode::Std => self.config.rust_debuginfo_level_std,
1520 Mode::ToolBootstrap | Mode::ToolStd | Mode::ToolRustc => {
1521 self.config.rust_debuginfo_level_tools
1524 cargo.env(profile_var("DEBUG"), debuginfo_level.to_string());
1526 profile_var("DEBUG_ASSERTIONS"),
1527 if mode == Mode::Std {
1528 self.config.rust_debug_assertions_std.to_string()
1530 self.config.rust_debug_assertions.to_string()
1534 profile_var("OVERFLOW_CHECKS"),
1535 if mode == Mode::Std {
1536 self.config.rust_overflow_checks_std.to_string()
1538 self.config.rust_overflow_checks.to_string()
1542 let split_debuginfo_is_stable = target.contains("linux")
1543 || target.contains("apple")
1544 || (target.contains("msvc")
1545 && self.config.rust_split_debuginfo == SplitDebuginfo::Packed)
1546 || (target.contains("windows")
1547 && self.config.rust_split_debuginfo == SplitDebuginfo::Off);
1549 if !split_debuginfo_is_stable {
1550 rustflags.arg("-Zunstable-options");
1552 match self.config.rust_split_debuginfo {
1553 SplitDebuginfo::Packed => rustflags.arg("-Csplit-debuginfo=packed"),
1554 SplitDebuginfo::Unpacked => rustflags.arg("-Csplit-debuginfo=unpacked"),
1555 SplitDebuginfo::Off => rustflags.arg("-Csplit-debuginfo=off"),
1558 if self.config.cmd.bless() {
1559 // Bless `expect!` tests.
1560 cargo.env("UPDATE_EXPECT", "1");
1563 if !mode.is_tool() {
1564 cargo.env("RUSTC_FORCE_UNSTABLE", "1");
1567 if let Some(x) = self.crt_static(target) {
1569 rustflags.arg("-Ctarget-feature=+crt-static");
1571 rustflags.arg("-Ctarget-feature=-crt-static");
1575 if let Some(x) = self.crt_static(compiler.host) {
1576 cargo.env("RUSTC_HOST_CRT_STATIC", x.to_string());
1579 if let Some(map_to) = self.build.debuginfo_map_to(GitRepo::Rustc) {
1580 let map = format!("{}={}", self.build.src.display(), map_to);
1581 cargo.env("RUSTC_DEBUGINFO_MAP", map);
1583 // `rustc` needs to know the virtual `/rustc/$hash` we're mapping to,
1584 // in order to opportunistically reverse it later.
1585 cargo.env("CFG_VIRTUAL_RUST_SOURCE_BASE_DIR", map_to);
1588 // Enable usage of unstable features
1589 cargo.env("RUSTC_BOOTSTRAP", "1");
1590 self.add_rust_test_threads(&mut cargo);
1592 // Almost all of the crates that we compile as part of the bootstrap may
1593 // have a build script, including the standard library. To compile a
1594 // build script, however, it itself needs a standard library! This
1595 // introduces a bit of a pickle when we're compiling the standard
1598 // To work around this we actually end up using the snapshot compiler
1599 // (stage0) for compiling build scripts of the standard library itself.
1600 // The stage0 compiler is guaranteed to have a libstd available for use.
1602 // For other crates, however, we know that we've already got a standard
1603 // library up and running, so we can use the normal compiler to compile
1604 // build scripts in that situation.
1605 if mode == Mode::Std {
1607 .env("RUSTC_SNAPSHOT", &self.initial_rustc)
1608 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
1611 .env("RUSTC_SNAPSHOT", self.rustc(compiler))
1612 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
1615 // Tools that use compiler libraries may inherit the `-lLLVM` link
1616 // requirement, but the `-L` library path is not propagated across
1617 // separate Cargo projects. We can add LLVM's library path to the
1618 // platform-specific environment variable as a workaround.
1619 if mode == Mode::ToolRustc || mode == Mode::Codegen {
1620 if let Some(llvm_config) = self.llvm_config(target) {
1621 let llvm_libdir = output(Command::new(&llvm_config).arg("--libdir"));
1622 add_link_lib_path(vec![llvm_libdir.trim().into()], &mut cargo);
1626 // Compile everything except libraries and proc macros with the more
1627 // efficient initial-exec TLS model. This doesn't work with `dlopen`,
1628 // so we can't use it by default in general, but we can use it for tools
1629 // and our own internal libraries.
1630 if !mode.must_support_dlopen() && !target.triple.starts_with("powerpc-") {
1631 cargo.env("RUSTC_TLS_MODEL_INITIAL_EXEC", "1");
1634 if self.config.incremental {
1635 cargo.env("CARGO_INCREMENTAL", "1");
1637 // Don't rely on any default setting for incr. comp. in Cargo
1638 cargo.env("CARGO_INCREMENTAL", "0");
1641 if let Some(ref on_fail) = self.config.on_fail {
1642 cargo.env("RUSTC_ON_FAIL", on_fail);
1645 if self.config.print_step_timings {
1646 cargo.env("RUSTC_PRINT_STEP_TIMINGS", "1");
1649 if self.config.print_step_rusage {
1650 cargo.env("RUSTC_PRINT_STEP_RUSAGE", "1");
1653 if self.config.backtrace_on_ice {
1654 cargo.env("RUSTC_BACKTRACE_ON_ICE", "1");
1657 cargo.env("RUSTC_VERBOSE", self.verbosity.to_string());
1659 if source_type == SourceType::InTree {
1660 let mut lint_flags = Vec::new();
1661 // When extending this list, add the new lints to the RUSTFLAGS of the
1662 // build_bootstrap function of src/bootstrap/bootstrap.py as well as
1663 // some code doesn't go through this `rustc` wrapper.
1664 lint_flags.push("-Wrust_2018_idioms");
1665 lint_flags.push("-Wunused_lifetimes");
1666 lint_flags.push("-Wsemicolon_in_expressions_from_macros");
1668 if self.config.deny_warnings {
1669 lint_flags.push("-Dwarnings");
1670 rustdocflags.arg("-Dwarnings");
1673 // This does not use RUSTFLAGS due to caching issues with Cargo.
1674 // Clippy is treated as an "in tree" tool, but shares the same
1675 // cache as other "submodule" tools. With these options set in
1676 // RUSTFLAGS, that causes *every* shared dependency to be rebuilt.
1677 // By injecting this into the rustc wrapper, this circumvents
1678 // Cargo's fingerprint detection. This is fine because lint flags
1679 // are always ignored in dependencies. Eventually this should be
1680 // fixed via better support from Cargo.
1681 cargo.env("RUSTC_LINT_FLAGS", lint_flags.join(" "));
1683 rustdocflags.arg("-Wrustdoc::invalid_codeblock_attributes");
1686 if mode == Mode::Rustc {
1687 rustflags.arg("-Zunstable-options");
1688 rustflags.arg("-Wrustc::internal");
1691 // Throughout the build Cargo can execute a number of build scripts
1692 // compiling C/C++ code and we need to pass compilers, archivers, flags, etc
1693 // obtained previously to those build scripts.
1694 // Build scripts use either the `cc` crate or `configure/make` so we pass
1695 // the options through environment variables that are fetched and understood by both.
1697 // FIXME: the guard against msvc shouldn't need to be here
1698 if target.contains("msvc") {
1699 if let Some(ref cl) = self.config.llvm_clang_cl {
1700 cargo.env("CC", cl).env("CXX", cl);
1703 let ccache = self.config.ccache.as_ref();
1704 let ccacheify = |s: &Path| {
1705 let ccache = match ccache {
1707 None => return s.display().to_string(),
1709 // FIXME: the cc-rs crate only recognizes the literal strings
1710 // `ccache` and `sccache` when doing caching compilations, so we
1711 // mirror that here. It should probably be fixed upstream to
1712 // accept a new env var or otherwise work with custom ccache
1715 "ccache" | "sccache" => format!("{} {}", ccache, s.display()),
1716 _ => s.display().to_string(),
1719 let triple_underscored = target.triple.replace("-", "_");
1720 let cc = ccacheify(&self.cc(target));
1721 cargo.env(format!("CC_{}", triple_underscored), &cc);
1723 let cflags = self.cflags(target, GitRepo::Rustc, CLang::C).join(" ");
1724 cargo.env(format!("CFLAGS_{}", triple_underscored), &cflags);
1726 if let Some(ar) = self.ar(target) {
1727 let ranlib = format!("{} s", ar.display());
1729 .env(format!("AR_{}", triple_underscored), ar)
1730 .env(format!("RANLIB_{}", triple_underscored), ranlib);
1733 if let Ok(cxx) = self.cxx(target) {
1734 let cxx = ccacheify(&cxx);
1735 let cxxflags = self.cflags(target, GitRepo::Rustc, CLang::Cxx).join(" ");
1737 .env(format!("CXX_{}", triple_underscored), &cxx)
1738 .env(format!("CXXFLAGS_{}", triple_underscored), cxxflags);
1742 if mode == Mode::Std && self.config.extended && compiler.is_final_stage(self) {
1743 rustflags.arg("-Zsave-analysis");
1745 "RUST_SAVE_ANALYSIS_CONFIG",
1746 "{\"output_file\": null,\"full_docs\": false,\
1747 \"pub_only\": true,\"reachable_only\": false,\
1748 \"distro_crate\": true,\"signatures\": false,\"borrow_data\": false}",
1752 // If Control Flow Guard is enabled, pass the `control-flow-guard` flag to rustc
1753 // when compiling the standard library, since this might be linked into the final outputs
1754 // produced by rustc. Since this mitigation is only available on Windows, only enable it
1755 // for the standard library in case the compiler is run on a non-Windows platform.
1756 // This is not needed for stage 0 artifacts because these will only be used for building
1757 // the stage 1 compiler.
1759 && mode == Mode::Std
1760 && self.config.control_flow_guard
1761 && compiler.stage >= 1
1763 rustflags.arg("-Ccontrol-flow-guard");
1766 // For `cargo doc` invocations, make rustdoc print the Rust version into the docs
1767 // This replaces spaces with newlines because RUSTDOCFLAGS does not
1768 // support arguments with regular spaces. Hopefully someday Cargo will
1769 // have space support.
1770 let rust_version = self.rust_version().replace(' ', "\n");
1771 rustdocflags.arg("--crate-version").arg(&rust_version);
1773 // Environment variables *required* throughout the build
1775 // FIXME: should update code to not require this env var
1776 cargo.env("CFG_COMPILER_HOST_TRIPLE", target.triple);
1778 // Set this for all builds to make sure doc builds also get it.
1779 cargo.env("CFG_RELEASE_CHANNEL", &self.config.channel);
1781 // This one's a bit tricky. As of the time of this writing the compiler
1782 // links to the `winapi` crate on crates.io. This crate provides raw
1783 // bindings to Windows system functions, sort of like libc does for
1784 // Unix. This crate also, however, provides "import libraries" for the
1785 // MinGW targets. There's an import library per dll in the windows
1786 // distribution which is what's linked to. These custom import libraries
1787 // are used because the winapi crate can reference Windows functions not
1788 // present in the MinGW import libraries.
1790 // For example MinGW may ship libdbghelp.a, but it may not have
1791 // references to all the functions in the dbghelp dll. Instead the
1792 // custom import library for dbghelp in the winapi crates has all this
1795 // Unfortunately for us though the import libraries are linked by
1796 // default via `-ldylib=winapi_foo`. That is, they're linked with the
1797 // `dylib` type with a `winapi_` prefix (so the winapi ones don't
1798 // conflict with the system MinGW ones). This consequently means that
1799 // the binaries we ship of things like rustc_codegen_llvm (aka the rustc_codegen_llvm
1800 // DLL) when linked against *again*, for example with procedural macros
1801 // or plugins, will trigger the propagation logic of `-ldylib`, passing
1802 // `-lwinapi_foo` to the linker again. This isn't actually available in
1803 // our distribution, however, so the link fails.
1805 // To solve this problem we tell winapi to not use its bundled import
1806 // libraries. This means that it will link to the system MinGW import
1807 // libraries by default, and the `-ldylib=foo` directives will still get
1808 // passed to the final linker, but they'll look like `-lfoo` which can
1809 // be resolved because MinGW has the import library. The downside is we
1810 // don't get newer functions from Windows, but we don't use any of them
1812 if !mode.is_tool() {
1813 cargo.env("WINAPI_NO_BUNDLED_LIBRARIES", "1");
1816 for _ in 0..self.verbosity {
1820 match (mode, self.config.rust_codegen_units_std, self.config.rust_codegen_units) {
1821 (Mode::Std, Some(n), _) | (_, _, Some(n)) => {
1822 cargo.env(profile_var("CODEGEN_UNITS"), n.to_string());
1825 // Don't set anything
1829 if self.config.rust_optimize {
1830 // FIXME: cargo bench/install do not accept `--release`
1831 if cmd != "bench" && cmd != "install" {
1832 cargo.arg("--release");
1836 if self.config.locked_deps {
1837 cargo.arg("--locked");
1839 if self.config.vendor || self.is_sudo {
1840 cargo.arg("--frozen");
1843 // Try to use a sysroot-relative bindir, in case it was configured absolutely.
1844 cargo.env("RUSTC_INSTALL_BINDIR", self.config.bindir_relative());
1846 self.ci_env.force_coloring_in_ci(&mut cargo);
1848 // When we build Rust dylibs they're all intended for intermediate
1849 // usage, so make sure we pass the -Cprefer-dynamic flag instead of
1850 // linking all deps statically into the dylib.
1851 if matches!(mode, Mode::Std | Mode::Rustc) {
1852 rustflags.arg("-Cprefer-dynamic");
1855 // When building incrementally we default to a lower ThinLTO import limit
1856 // (unless explicitly specified otherwise). This will produce a somewhat
1857 // slower code but give way better compile times.
1859 let limit = match self.config.rust_thin_lto_import_instr_limit {
1860 Some(limit) => Some(limit),
1861 None if self.config.incremental => Some(10),
1865 if let Some(limit) = limit {
1866 rustflags.arg(&format!("-Cllvm-args=-import-instr-limit={}", limit));
1870 Cargo { command: cargo, rustflags, rustdocflags }
1873 /// Ensure that a given step is built, returning its output. This will
1874 /// cache the step, so it is safe (and good!) to call this as often as
1875 /// needed to ensure that all dependencies are built.
1876 pub fn ensure<S: Step>(&'a self, step: S) -> S::Output {
1878 let mut stack = self.stack.borrow_mut();
1879 for stack_step in stack.iter() {
1881 if stack_step.downcast_ref::<S>().map_or(true, |stack_step| *stack_step != step) {
1884 let mut out = String::new();
1885 out += &format!("\n\nCycle in build detected when adding {:?}\n", step);
1886 for el in stack.iter().rev() {
1887 out += &format!("\t{:?}\n", el);
1891 if let Some(out) = self.cache.get(&step) {
1892 self.verbose_than(1, &format!("{}c {:?}", " ".repeat(stack.len()), step));
1896 self.verbose_than(1, &format!("{}> {:?}", " ".repeat(stack.len()), step));
1897 stack.push(Box::new(step.clone()));
1900 #[cfg(feature = "build-metrics")]
1901 self.metrics.enter_step(&step);
1904 let start = Instant::now();
1905 let zero = Duration::new(0, 0);
1906 let parent = self.time_spent_on_dependencies.replace(zero);
1907 let out = step.clone().run(self);
1908 let dur = start.elapsed();
1909 let deps = self.time_spent_on_dependencies.replace(parent + dur);
1913 if self.config.print_step_timings && !self.config.dry_run() {
1914 let step_string = format!("{:?}", step);
1915 let brace_index = step_string.find("{").unwrap_or(0);
1916 let type_string = type_name::<S>();
1918 "[TIMING] {} {} -- {}.{:03}",
1919 &type_string.strip_prefix("bootstrap::").unwrap_or(type_string),
1920 &step_string[brace_index..],
1926 #[cfg(feature = "build-metrics")]
1927 self.metrics.exit_step();
1930 let mut stack = self.stack.borrow_mut();
1931 let cur_step = stack.pop().expect("step stack empty");
1932 assert_eq!(cur_step.downcast_ref(), Some(&step));
1934 self.verbose_than(1, &format!("{}< {:?}", " ".repeat(self.stack.borrow().len()), step));
1935 self.cache.put(step, out.clone());
1939 /// Ensure that a given step is built *only if it's supposed to be built by default*, returning
1940 /// its output. This will cache the step, so it's safe (and good!) to call this as often as
1941 /// needed to ensure that all dependencies are build.
1942 pub(crate) fn ensure_if_default<T, S: Step<Output = Option<T>>>(
1947 let desc = StepDescription::from::<S>(kind);
1948 let should_run = (desc.should_run)(ShouldRun::new(self, desc.kind));
1950 // Avoid running steps contained in --exclude
1951 for pathset in &should_run.paths {
1952 if desc.is_excluded(self, pathset) {
1957 // Only execute if it's supposed to run as default
1958 if desc.default && should_run.is_really_default() { self.ensure(step) } else { None }
1961 /// Checks if any of the "should_run" paths is in the `Builder` paths.
1962 pub(crate) fn was_invoked_explicitly<S: Step>(&'a self, kind: Kind) -> bool {
1963 let desc = StepDescription::from::<S>(kind);
1964 let should_run = (desc.should_run)(ShouldRun::new(self, desc.kind));
1966 for path in &self.paths {
1967 if should_run.paths.iter().any(|s| s.has(path, Some(desc.kind)))
1968 && !desc.is_excluded(
1970 &PathSet::Suite(TaskPath { path: path.clone(), kind: Some(desc.kind) }),
1980 pub(crate) fn maybe_open_in_browser<S: Step>(&self, path: impl AsRef<Path>) {
1981 if self.was_invoked_explicitly::<S>(Kind::Doc) {
1982 self.open_in_browser(path);
1986 pub(crate) fn open_in_browser(&self, path: impl AsRef<Path>) {
1987 if self.config.dry_run() || !self.config.cmd.open() {
1991 let path = path.as_ref();
1992 self.info(&format!("Opening doc {}", path.display()));
1993 if let Err(err) = opener::open(path) {
1994 self.info(&format!("{}\n", err));
2002 #[derive(Debug, Clone)]
2003 struct Rustflags(String, TargetSelection);
2006 fn new(target: TargetSelection) -> Rustflags {
2007 let mut ret = Rustflags(String::new(), target);
2008 ret.propagate_cargo_env("RUSTFLAGS");
2012 /// By default, cargo will pick up on various variables in the environment. However, bootstrap
2013 /// reuses those variables to pass additional flags to rustdoc, so by default they get overridden.
2014 /// Explicitly add back any previous value in the environment.
2016 /// `prefix` is usually `RUSTFLAGS` or `RUSTDOCFLAGS`.
2017 fn propagate_cargo_env(&mut self, prefix: &str) {
2018 // Inherit `RUSTFLAGS` by default ...
2021 // ... and also handle target-specific env RUSTFLAGS if they're configured.
2022 let target_specific = format!("CARGO_TARGET_{}_{}", crate::envify(&self.1.triple), prefix);
2023 self.env(&target_specific);
2026 fn env(&mut self, env: &str) {
2027 if let Ok(s) = env::var(env) {
2028 for part in s.split(' ') {
2034 fn arg(&mut self, arg: &str) -> &mut Self {
2035 assert_eq!(arg.split(' ').count(), 1);
2036 if !self.0.is_empty() {
2039 self.0.push_str(arg);
2047 rustflags: Rustflags,
2048 rustdocflags: Rustflags,
2052 pub fn rustdocflag(&mut self, arg: &str) -> &mut Cargo {
2053 self.rustdocflags.arg(arg);
2056 pub fn rustflag(&mut self, arg: &str) -> &mut Cargo {
2057 self.rustflags.arg(arg);
2061 pub fn arg(&mut self, arg: impl AsRef<OsStr>) -> &mut Cargo {
2062 self.command.arg(arg.as_ref());
2066 pub fn args<I, S>(&mut self, args: I) -> &mut Cargo
2068 I: IntoIterator<Item = S>,
2072 self.arg(arg.as_ref());
2077 pub fn env(&mut self, key: impl AsRef<OsStr>, value: impl AsRef<OsStr>) -> &mut Cargo {
2078 // These are managed through rustflag/rustdocflag interfaces.
2079 assert_ne!(key.as_ref(), "RUSTFLAGS");
2080 assert_ne!(key.as_ref(), "RUSTDOCFLAGS");
2081 self.command.env(key.as_ref(), value.as_ref());
2085 pub fn add_rustc_lib_path(&mut self, builder: &Builder<'_>, compiler: Compiler) {
2086 builder.add_rustc_lib_path(compiler, &mut self.command);
2089 pub fn current_dir(&mut self, dir: &Path) -> &mut Cargo {
2090 self.command.current_dir(dir);
2095 impl From<Cargo> for Command {
2096 fn from(mut cargo: Cargo) -> Command {
2097 let rustflags = &cargo.rustflags.0;
2098 if !rustflags.is_empty() {
2099 cargo.command.env("RUSTFLAGS", rustflags);
2102 let rustdocflags = &cargo.rustdocflags.0;
2103 if !rustdocflags.is_empty() {
2104 cargo.command.env("RUSTDOCFLAGS", rustdocflags);