1 use std::any::{type_name, Any};
2 use std::cell::{Cell, RefCell};
3 use std::collections::BTreeSet;
5 use std::ffi::{OsStr, OsString};
6 use std::fmt::{Debug, Write};
7 use std::fs::{self, File};
9 use std::io::{BufRead, BufReader, ErrorKind};
11 use std::path::{Component, Path, PathBuf};
12 use std::process::{Command, Stdio};
13 use std::time::{Duration, Instant};
15 use crate::cache::{Cache, Interned, INTERNER};
17 use crate::config::{SplitDebuginfo, TargetSelection};
20 use crate::flags::{Color, Subcommand};
25 use crate::tool::{self, SourceType};
26 use crate::util::{self, add_dylib_path, add_link_lib_path, exe, libdir, output, t};
27 use crate::EXTRA_CHECK_CFGS;
28 use crate::{check, Config};
29 use crate::{Build, CLang, DocTests, GitRepo, Mode};
31 pub use crate::Compiler;
32 // FIXME: replace with std::lazy after it gets stabilized and reaches beta
33 use once_cell::sync::{Lazy, OnceCell};
34 use xz2::bufread::XzDecoder;
36 pub struct Builder<'a> {
41 stack: RefCell<Vec<Box<dyn Any>>>,
42 time_spent_on_dependencies: Cell<Duration>,
43 pub paths: Vec<PathBuf>,
46 impl<'a> Deref for Builder<'a> {
49 fn deref(&self) -> &Self::Target {
54 pub trait Step: 'static + Clone + Debug + PartialEq + Eq + Hash {
55 /// `PathBuf` when directories are created or to return a `Compiler` once
56 /// it's been assembled.
59 /// Whether this step is run by default as part of its respective phase.
60 /// `true` here can still be overwritten by `should_run` calling `default_condition`.
61 const DEFAULT: bool = false;
63 /// If true, then this rule should be skipped if --target was specified, but --host was not
64 const ONLY_HOSTS: bool = false;
66 /// Primary function to execute this rule. Can call `builder.ensure()`
67 /// with other steps to run those.
68 fn run(self, builder: &Builder<'_>) -> Self::Output;
70 /// When bootstrap is passed a set of paths, this controls whether this rule
71 /// will execute. However, it does not get called in a "default" context
72 /// when we are not passed any paths; in that case, `make_run` is called
74 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_>;
76 /// Builds up a "root" rule, either as a default rule or from a path passed
79 /// When path is `None`, we are executing in a context where no paths were
80 /// passed. When `./x.py build` is run, for example, this rule could get
81 /// called if it is in the correct list below with a path of `None`.
82 fn make_run(_run: RunConfig<'_>) {
83 // It is reasonable to not have an implementation of make_run for rules
84 // who do not want to get called from the root context. This means that
85 // they are likely dependencies (e.g., sysroot creation) or similar, and
86 // as such calling them from ./x.py isn't logical.
91 pub struct RunConfig<'a> {
92 pub builder: &'a Builder<'a>,
93 pub target: TargetSelection,
98 pub fn build_triple(&self) -> TargetSelection {
99 self.builder.build.build
103 struct StepDescription {
106 should_run: fn(ShouldRun<'_>) -> ShouldRun<'_>,
107 make_run: fn(RunConfig<'_>),
112 #[derive(Clone, PartialOrd, Ord, PartialEq, Eq)]
113 pub struct TaskPath {
115 pub kind: Option<Kind>,
119 pub fn parse(path: impl Into<PathBuf>) -> TaskPath {
121 let mut path = path.into();
123 let mut components = path.components();
124 if let Some(Component::Normal(os_str)) = components.next() {
125 if let Some(str) = os_str.to_str() {
126 if let Some((found_kind, found_prefix)) = str.split_once("::") {
127 if found_kind.is_empty() {
128 panic!("empty kind in task path {}", path.display());
130 kind = Kind::parse(found_kind);
131 assert!(kind.is_some());
132 path = Path::new(found_prefix).join(components.as_path());
137 TaskPath { path, kind }
141 impl Debug for TaskPath {
142 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
143 if let Some(kind) = &self.kind {
144 write!(f, "{}::", kind.as_str())?;
146 write!(f, "{}", self.path.display())
150 /// Collection of paths used to match a task rule.
151 #[derive(Debug, Clone, PartialOrd, Ord, PartialEq, Eq)]
153 /// A collection of individual paths.
155 /// These are generally matched as a path suffix. For example, a
156 /// command-line value of `libstd` will match if `src/libstd` is in the
158 Set(BTreeSet<TaskPath>),
159 /// A "suite" of paths.
161 /// These can match as a path suffix (like `Set`), or as a prefix. For
162 /// example, a command-line value of `src/test/ui/abi/variadic-ffi.rs`
163 /// will match `src/test/ui`. A command-line value of `ui` would also
164 /// match `src/test/ui`.
169 fn empty() -> PathSet {
170 PathSet::Set(BTreeSet::new())
173 fn one<P: Into<PathBuf>>(path: P, kind: Kind) -> PathSet {
174 let mut set = BTreeSet::new();
175 set.insert(TaskPath { path: path.into(), kind: Some(kind) });
179 fn has(&self, needle: &Path, module: Option<Kind>) -> bool {
180 let check = |p: &TaskPath| {
181 if let (Some(p_kind), Some(kind)) = (&p.kind, module) {
182 p.path.ends_with(needle) && *p_kind == kind
184 p.path.ends_with(needle)
189 PathSet::Set(set) => set.iter().any(check),
190 PathSet::Suite(suite) => check(suite),
194 fn path(&self, builder: &Builder<'_>) -> PathBuf {
196 PathSet::Set(set) => {
197 set.iter().next().map(|p| &p.path).unwrap_or(&builder.build.src).clone()
199 PathSet::Suite(path) => path.path.clone(),
204 impl StepDescription {
205 fn from<S: Step>(kind: Kind) -> StepDescription {
208 only_hosts: S::ONLY_HOSTS,
209 should_run: S::should_run,
210 make_run: S::make_run,
211 name: std::any::type_name::<S>(),
216 fn maybe_run(&self, builder: &Builder<'_>, pathset: &PathSet) {
217 if self.is_excluded(builder, pathset) {
221 // Determine the targets participating in this rule.
222 let targets = if self.only_hosts { &builder.hosts } else { &builder.targets };
224 for target in targets {
225 let run = RunConfig { builder, path: pathset.path(builder), target: *target };
226 (self.make_run)(run);
230 fn is_excluded(&self, builder: &Builder<'_>, pathset: &PathSet) -> bool {
231 if builder.config.exclude.iter().any(|e| pathset.has(&e.path, e.kind)) {
232 println!("Skipping {:?} because it is excluded", pathset);
236 if !builder.config.exclude.is_empty() {
237 builder.verbose(&format!(
238 "{:?} not skipped for {:?} -- not in {:?}",
239 pathset, self.name, builder.config.exclude
245 fn run(v: &[StepDescription], builder: &Builder<'_>, paths: &[PathBuf]) {
248 .map(|desc| (desc.should_run)(ShouldRun::new(builder, desc.kind)))
249 .collect::<Vec<_>>();
251 // sanity checks on rules
252 for (desc, should_run) in v.iter().zip(&should_runs) {
254 !should_run.paths.is_empty(),
255 "{:?} should have at least one pathset",
260 if paths.is_empty() || builder.config.include_default_paths {
261 for (desc, should_run) in v.iter().zip(&should_runs) {
262 if desc.default && should_run.is_really_default() {
263 for pathset in &should_run.paths {
264 desc.maybe_run(builder, pathset);
271 // strip CurDir prefix if present
272 let path = match path.strip_prefix(".") {
277 let mut attempted_run = false;
278 for (desc, should_run) in v.iter().zip(&should_runs) {
279 if let Some(suite) = should_run.is_suite_path(path) {
280 attempted_run = true;
281 desc.maybe_run(builder, suite);
282 } else if let Some(pathset) = should_run.pathset_for_path(path, desc.kind) {
283 attempted_run = true;
284 desc.maybe_run(builder, pathset);
290 "error: no `{}` rules matched '{}'",
291 builder.kind.as_str(),
295 "help: run `x.py {} --help --verbose` to show a list of available paths",
296 builder.kind.as_str()
299 "note: if you are adding a new Step to bootstrap itself, make sure you register it with `describe!`"
301 std::process::exit(1);
307 enum ReallyDefault<'a> {
309 Lazy(Lazy<bool, Box<dyn Fn() -> bool + 'a>>),
312 pub struct ShouldRun<'a> {
313 pub builder: &'a Builder<'a>,
316 // use a BTreeSet to maintain sort order
317 paths: BTreeSet<PathSet>,
319 // If this is a default rule, this is an additional constraint placed on
320 // its run. Generally something like compiler docs being enabled.
321 is_really_default: ReallyDefault<'a>,
324 impl<'a> ShouldRun<'a> {
325 fn new(builder: &'a Builder<'_>, kind: Kind) -> ShouldRun<'a> {
329 paths: BTreeSet::new(),
330 is_really_default: ReallyDefault::Bool(true), // by default no additional conditions
334 pub fn default_condition(mut self, cond: bool) -> Self {
335 self.is_really_default = ReallyDefault::Bool(cond);
339 pub fn lazy_default_condition(mut self, lazy_cond: Box<dyn Fn() -> bool + 'a>) -> Self {
340 self.is_really_default = ReallyDefault::Lazy(Lazy::new(lazy_cond));
344 pub fn is_really_default(&self) -> bool {
345 match &self.is_really_default {
346 ReallyDefault::Bool(val) => *val,
347 ReallyDefault::Lazy(lazy) => *lazy.deref(),
351 /// Indicates it should run if the command-line selects the given crate or
352 /// any of its (local) dependencies.
354 /// Compared to `krate`, this treats the dependencies as aliases for the
355 /// same job. Generally it is preferred to use `krate`, and treat each
356 /// individual path separately. For example `./x.py test src/liballoc`
357 /// (which uses `krate`) will test just `liballoc`. However, `./x.py check
358 /// src/liballoc` (which uses `all_krates`) will check all of `libtest`.
359 /// `all_krates` should probably be removed at some point.
360 pub fn all_krates(mut self, name: &str) -> Self {
361 let mut set = BTreeSet::new();
362 for krate in self.builder.in_tree_crates(name, None) {
363 let path = krate.local_path(self.builder);
364 set.insert(TaskPath { path, kind: Some(self.kind) });
366 self.paths.insert(PathSet::Set(set));
370 /// Indicates it should run if the command-line selects the given crate or
371 /// any of its (local) dependencies.
373 /// `make_run` will be called separately for each matching command-line path.
374 pub fn krate(mut self, name: &str) -> Self {
375 for krate in self.builder.in_tree_crates(name, None) {
376 let path = krate.local_path(self.builder);
377 self.paths.insert(PathSet::one(path, self.kind));
382 // single alias, which does not correspond to any on-disk path
383 pub fn alias(mut self, alias: &str) -> Self {
385 !self.builder.src.join(alias).exists(),
386 "use `builder.path()` for real paths: {}",
389 self.paths.insert(PathSet::Set(
390 std::iter::once(TaskPath { path: alias.into(), kind: Some(self.kind) }).collect(),
395 // single, non-aliased path
396 pub fn path(self, path: &str) -> Self {
400 // multiple aliases for the same job
401 pub fn paths(mut self, paths: &[&str]) -> Self {
402 self.paths.insert(PathSet::Set(
406 // FIXME(#96188): make sure this is actually a path.
407 // This currently breaks for paths within submodules.
409 // self.builder.src.join(p).exists(),
410 // "`should_run.paths` should correspond to real on-disk paths - use `alias` if there is no relevant path: {}",
413 TaskPath { path: p.into(), kind: Some(self.kind) }
420 pub fn is_suite_path(&self, path: &Path) -> Option<&PathSet> {
421 self.paths.iter().find(|pathset| match pathset {
422 PathSet::Suite(p) => path.starts_with(&p.path),
423 PathSet::Set(_) => false,
427 pub fn suite_path(mut self, suite: &str) -> Self {
428 self.paths.insert(PathSet::Suite(TaskPath { path: suite.into(), kind: Some(self.kind) }));
432 // allows being more explicit about why should_run in Step returns the value passed to it
433 pub fn never(mut self) -> ShouldRun<'a> {
434 self.paths.insert(PathSet::empty());
438 fn pathset_for_path(&self, path: &Path, kind: Kind) -> Option<&PathSet> {
439 self.paths.iter().find(|pathset| pathset.has(path, Some(kind)))
443 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug)]
461 pub fn parse(string: &str) -> Option<Kind> {
462 // these strings, including the one-letter aliases, must match the x.py help text
464 "build" | "b" => Kind::Build,
465 "check" | "c" => Kind::Check,
466 "clippy" => Kind::Clippy,
468 "fmt" => Kind::Format,
469 "test" | "t" => Kind::Test,
470 "bench" => Kind::Bench,
471 "doc" | "d" => Kind::Doc,
472 "clean" => Kind::Clean,
473 "dist" => Kind::Dist,
474 "install" => Kind::Install,
475 "run" | "r" => Kind::Run,
476 "setup" => Kind::Setup,
481 pub fn as_str(&self) -> &'static str {
483 Kind::Build => "build",
484 Kind::Check => "check",
485 Kind::Clippy => "clippy",
487 Kind::Format => "fmt",
488 Kind::Test => "test",
489 Kind::Bench => "bench",
491 Kind::Clean => "clean",
492 Kind::Dist => "dist",
493 Kind::Install => "install",
495 Kind::Setup => "setup",
500 impl<'a> Builder<'a> {
501 fn get_step_descriptions(kind: Kind) -> Vec<StepDescription> {
502 macro_rules! describe {
503 ($($rule:ty),+ $(,)?) => {{
504 vec![$(StepDescription::from::<$rule>(kind)),+]
508 Kind::Build => describe!(
511 compile::CodegenBackend,
512 compile::StartupObjects,
516 tool::UnstableBookGen,
521 tool::RemoteTestServer,
522 tool::RemoteTestClient,
539 Kind::Check | Kind::Clippy | Kind::Fix => describe!(
543 check::CodegenBackend,
550 Kind::Test => describe!(
551 crate::toolstate::ToolStateCheck,
552 test::ExpandYamlAnchors,
555 test::RunPassValgrind,
568 test::CrateRustdocJsonTypes,
576 test::RunMakeFullDeps,
592 test::CompiletestTest,
594 test::RustdocJSNotStd,
600 // Run bootstrap close to the end as it's unlikely to fail
602 // Run run-make last, since these won't pass without make on Windows
605 Kind::Bench => describe!(test::Crate, test::CrateLibrustc),
606 Kind::Doc => describe!(
608 doc::UnstableBookGen,
626 Kind::Dist => describe!(
645 // It seems that PlainSourceTarball somehow changes how some of the tools
646 // perceive their dependencies (see #93033) which would invalidate fingerprints
647 // and force us to rebuild tools after vendoring dependencies.
648 // To work around this, create the Tarball after building all the tools.
649 dist::PlainSourceTarball,
651 dist::ReproducibleArtifacts,
653 Kind::Install => describe!(
658 install::RustAnalyzer,
660 install::RustDemangler,
667 Kind::Run => describe!(run::ExpandYamlAnchors, run::BuildManifest, run::BumpStage0),
668 // These commands either don't use paths, or they're special-cased in Build::build()
669 Kind::Clean | Kind::Format | Kind::Setup => vec![],
673 pub fn get_help(build: &Build, kind: Kind) -> Option<String> {
674 let step_descriptions = Builder::get_step_descriptions(kind);
675 if step_descriptions.is_empty() {
679 let builder = Self::new_internal(build, kind, vec![]);
680 let builder = &builder;
681 // The "build" kind here is just a placeholder, it will be replaced with something else in
682 // the following statement.
683 let mut should_run = ShouldRun::new(builder, Kind::Build);
684 for desc in step_descriptions {
685 should_run.kind = desc.kind;
686 should_run = (desc.should_run)(should_run);
688 let mut help = String::from("Available paths:\n");
689 let mut add_path = |path: &Path| {
690 t!(write!(help, " ./x.py {} {}\n", kind.as_str(), path.display()));
692 for pathset in should_run.paths {
694 PathSet::Set(set) => {
696 add_path(&path.path);
699 PathSet::Suite(path) => {
700 add_path(&path.path.join("..."));
707 fn new_internal(build: &Build, kind: Kind, paths: Vec<PathBuf>) -> Builder<'_> {
710 top_stage: build.config.stage,
713 stack: RefCell::new(Vec::new()),
714 time_spent_on_dependencies: Cell::new(Duration::new(0, 0)),
719 pub fn new(build: &Build) -> Builder<'_> {
720 let (kind, paths) = match build.config.cmd {
721 Subcommand::Build { ref paths } => (Kind::Build, &paths[..]),
722 Subcommand::Check { ref paths } => (Kind::Check, &paths[..]),
723 Subcommand::Clippy { ref paths, .. } => (Kind::Clippy, &paths[..]),
724 Subcommand::Fix { ref paths } => (Kind::Fix, &paths[..]),
725 Subcommand::Doc { ref paths, .. } => (Kind::Doc, &paths[..]),
726 Subcommand::Test { ref paths, .. } => (Kind::Test, &paths[..]),
727 Subcommand::Bench { ref paths, .. } => (Kind::Bench, &paths[..]),
728 Subcommand::Dist { ref paths } => (Kind::Dist, &paths[..]),
729 Subcommand::Install { ref paths } => (Kind::Install, &paths[..]),
730 Subcommand::Run { ref paths } => (Kind::Run, &paths[..]),
731 Subcommand::Format { .. } => (Kind::Format, &[][..]),
732 Subcommand::Clean { .. } | Subcommand::Setup { .. } => {
737 Self::new_internal(build, kind, paths.to_owned())
740 pub fn execute_cli(&self) {
741 self.run_step_descriptions(&Builder::get_step_descriptions(self.kind), &self.paths);
744 pub fn default_doc(&self, paths: &[PathBuf]) {
745 self.run_step_descriptions(&Builder::get_step_descriptions(Kind::Doc), paths);
748 /// NOTE: keep this in sync with `rustdoc::clean::utils::doc_rust_lang_org_channel`, or tests will fail on beta/stable.
749 pub fn doc_rust_lang_org_channel(&self) -> String {
750 let channel = match &*self.config.channel {
751 "stable" => &self.version,
753 "nightly" | "dev" => "nightly",
754 // custom build of rustdoc maybe? link to the latest stable docs just in case
757 "https://doc.rust-lang.org/".to_owned() + channel
760 fn run_step_descriptions(&self, v: &[StepDescription], paths: &[PathBuf]) {
761 StepDescription::run(v, self, paths);
764 /// Modifies the interpreter section of 'fname' to fix the dynamic linker,
765 /// or the RPATH section, to fix the dynamic library search path
767 /// This is only required on NixOS and uses the PatchELF utility to
768 /// change the interpreter/RPATH of ELF executables.
770 /// Please see https://nixos.org/patchelf.html for more information
771 pub(crate) fn fix_bin_or_dylib(&self, fname: &Path) {
772 // FIXME: cache NixOS detection?
773 match Command::new("uname").arg("-s").stderr(Stdio::inherit()).output() {
775 Ok(output) if !output.status.success() => return,
777 let mut s = output.stdout;
778 if s.last() == Some(&b'\n') {
787 // If the user has asked binaries to be patched for Nix, then
788 // don't check for NixOS or `/lib`, just continue to the patching.
789 // NOTE: this intentionally comes after the Linux check:
790 // - patchelf only works with ELF files, so no need to run it on Mac or Windows
791 // - On other Unix systems, there is no stable syscall interface, so Nix doesn't manage the global libc.
792 if !self.config.patch_binaries_for_nix {
793 // Use `/etc/os-release` instead of `/etc/NIXOS`.
794 // The latter one does not exist on NixOS when using tmpfs as root.
795 const NIX_IDS: &[&str] = &["ID=nixos", "ID='nixos'", "ID=\"nixos\""];
796 let os_release = match File::open("/etc/os-release") {
797 Err(e) if e.kind() == ErrorKind::NotFound => return,
798 Err(e) => panic!("failed to access /etc/os-release: {}", e),
801 if !BufReader::new(os_release).lines().any(|l| NIX_IDS.contains(&t!(l).trim())) {
804 if Path::new("/lib").exists() {
809 // At this point we're pretty sure the user is running NixOS or using Nix
810 println!("info: you seem to be using Nix. Attempting to patch {}", fname.display());
812 // Only build `.nix-deps` once.
813 static NIX_DEPS_DIR: OnceCell<PathBuf> = OnceCell::new();
814 let mut nix_build_succeeded = true;
815 let nix_deps_dir = NIX_DEPS_DIR.get_or_init(|| {
816 // Run `nix-build` to "build" each dependency (which will likely reuse
817 // the existing `/nix/store` copy, or at most download a pre-built copy).
819 // Importantly, we create a gc-root called `.nix-deps` in the `build/`
820 // directory, but still reference the actual `/nix/store` path in the rpath
821 // as it makes it significantly more robust against changes to the location of
822 // the `.nix-deps` location.
824 // bintools: Needed for the path of `ld-linux.so` (via `nix-support/dynamic-linker`).
825 // zlib: Needed as a system dependency of `libLLVM-*.so`.
826 // patchelf: Needed for patching ELF binaries (see doc comment above).
827 let nix_deps_dir = self.out.join(".nix-deps");
828 const NIX_EXPR: &str = "
829 with (import <nixpkgs> {});
831 name = \"rust-stage0-dependencies\";
839 nix_build_succeeded = self.try_run(Command::new("nix-build").args(&[
847 if !nix_build_succeeded {
851 let mut patchelf = Command::new(nix_deps_dir.join("bin/patchelf"));
852 let rpath_entries = {
853 // ORIGIN is a relative default, all binary and dynamic libraries we ship
854 // appear to have this (even when `../lib` is redundant).
855 // NOTE: there are only two paths here, delimited by a `:`
856 let mut entries = OsString::from("$ORIGIN/../lib:");
857 entries.push(t!(fs::canonicalize(nix_deps_dir)));
858 entries.push("/lib");
861 patchelf.args(&[OsString::from("--set-rpath"), rpath_entries]);
862 if !fname.extension().map_or(false, |ext| ext == "so") {
863 // Finally, set the corret .interp for binaries
864 let dynamic_linker_path = nix_deps_dir.join("nix-support/dynamic-linker");
865 // FIXME: can we support utf8 here? `args` doesn't accept Vec<u8>, only OsString ...
866 let dynamic_linker = t!(String::from_utf8(t!(fs::read(dynamic_linker_path))));
867 patchelf.args(&["--set-interpreter", dynamic_linker.trim_end()]);
870 self.try_run(patchelf.arg(fname));
873 pub(crate) fn download_component(
880 // Use a temporary file in case we crash while downloading, to avoid a corrupt download in cache/.
881 let tempfile = self.tempdir().join(dest_path.file_name().unwrap());
882 self.download_with_retries(&tempfile, &format!("{}/{}", base, url), help_on_error);
883 t!(std::fs::rename(&tempfile, dest_path));
886 fn download_with_retries(&self, tempfile: &Path, url: &str, help_on_error: &str) {
887 println!("downloading {}", url);
888 // Try curl. If that fails and we are on windows, fallback to PowerShell.
889 let mut curl = Command::new("curl");
895 "10", // timeout if speed is < 10 bytes/sec for > 30 seconds
897 "30", // timeout if cannot connect within 30 seconds
905 if !self.check_run(&mut curl) {
906 if self.build.build.contains("windows-msvc") {
907 println!("Fallback to PowerShell");
909 if self.try_run(Command::new("PowerShell.exe").args(&[
912 "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12;",
914 "(New-Object System.Net.WebClient).DownloadFile('{}', '{}')",
915 url, tempfile.to_str().expect("invalid UTF-8 not supported with powershell downloads"),
920 println!("\nspurious failure, trying again");
923 if !help_on_error.is_empty() {
924 eprintln!("{}", help_on_error);
926 std::process::exit(1);
930 pub(crate) fn unpack(&self, tarball: &Path, dst: &Path, pattern: &str) {
931 println!("extracting {} to {}", tarball.display(), dst.display());
933 t!(fs::create_dir_all(dst));
936 // `tarball` ends with `.tar.xz`; strip that suffix
937 // example: `rust-dev-nightly-x86_64-unknown-linux-gnu`
938 let uncompressed_filename =
939 Path::new(tarball.file_name().expect("missing tarball filename")).file_stem().unwrap();
940 let directory_prefix = Path::new(Path::new(uncompressed_filename).file_stem().unwrap());
942 // decompress the file
943 let data = t!(File::open(tarball));
944 let decompressor = XzDecoder::new(BufReader::new(data));
946 let mut tar = tar::Archive::new(decompressor);
947 for member in t!(tar.entries()) {
948 let mut member = t!(member);
949 let original_path = t!(member.path()).into_owned();
950 // skip the top-level directory
951 if original_path == directory_prefix {
954 let mut short_path = t!(original_path.strip_prefix(directory_prefix));
955 if !short_path.starts_with(pattern) {
958 short_path = t!(short_path.strip_prefix(pattern));
959 let dst_path = dst.join(short_path);
960 self.verbose(&format!("extracting {} to {}", original_path.display(), dst.display()));
961 if !t!(member.unpack_in(dst)) {
962 panic!("path traversal attack ??");
964 let src_path = dst.join(original_path);
965 if src_path.is_dir() && dst_path.exists() {
968 t!(fs::rename(src_path, dst_path));
970 t!(fs::remove_dir_all(dst.join(directory_prefix)));
973 /// Returns whether the SHA256 checksum of `path` matches `expected`.
974 pub(crate) fn verify(&self, path: &Path, expected: &str) -> bool {
977 self.verbose(&format!("verifying {}", path.display()));
978 let mut hasher = sha2::Sha256::new();
979 // FIXME: this is ok for rustfmt (4.1 MB large at time of writing), but it seems memory-intensive for rustc and larger components.
980 // Consider using streaming IO instead?
981 let contents = if self.config.dry_run { vec![] } else { t!(fs::read(path)) };
982 hasher.update(&contents);
983 let found = hex::encode(hasher.finalize().as_slice());
984 let verified = found == expected;
985 if !verified && !self.config.dry_run {
987 "invalid checksum: \n\
989 expected: {expected}",
995 /// Obtain a compiler at a given stage and for a given host. Explicitly does
996 /// not take `Compiler` since all `Compiler` instances are meant to be
997 /// obtained through this function, since it ensures that they are valid
998 /// (i.e., built and assembled).
999 pub fn compiler(&self, stage: u32, host: TargetSelection) -> Compiler {
1000 self.ensure(compile::Assemble { target_compiler: Compiler { stage, host } })
1003 /// Similar to `compiler`, except handles the full-bootstrap option to
1004 /// silently use the stage1 compiler instead of a stage2 compiler if one is
1007 /// Note that this does *not* have the side effect of creating
1008 /// `compiler(stage, host)`, unlike `compiler` above which does have such
1009 /// a side effect. The returned compiler here can only be used to compile
1010 /// new artifacts, it can't be used to rely on the presence of a particular
1013 /// See `force_use_stage1` for documentation on what each argument is.
1014 pub fn compiler_for(
1017 host: TargetSelection,
1018 target: TargetSelection,
1020 if self.build.force_use_stage1(Compiler { stage, host }, target) {
1021 self.compiler(1, self.config.build)
1023 self.compiler(stage, host)
1027 pub fn sysroot(&self, compiler: Compiler) -> Interned<PathBuf> {
1028 self.ensure(compile::Sysroot { compiler })
1031 /// Returns the libdir where the standard library and other artifacts are
1032 /// found for a compiler's sysroot.
1033 pub fn sysroot_libdir(&self, compiler: Compiler, target: TargetSelection) -> Interned<PathBuf> {
1034 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
1037 target: TargetSelection,
1039 impl Step for Libdir {
1040 type Output = Interned<PathBuf>;
1042 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1046 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
1047 let lib = builder.sysroot_libdir_relative(self.compiler);
1048 let sysroot = builder
1049 .sysroot(self.compiler)
1052 .join(self.target.triple)
1054 // Avoid deleting the rustlib/ directory we just copied
1055 // (in `impl Step for Sysroot`).
1056 if !builder.download_rustc() {
1057 let _ = fs::remove_dir_all(&sysroot);
1058 t!(fs::create_dir_all(&sysroot));
1060 INTERNER.intern_path(sysroot)
1063 self.ensure(Libdir { compiler, target })
1066 pub fn sysroot_codegen_backends(&self, compiler: Compiler) -> PathBuf {
1067 self.sysroot_libdir(compiler, compiler.host).with_file_name("codegen-backends")
1070 /// Returns the compiler's libdir where it stores the dynamic libraries that
1071 /// it itself links against.
1073 /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
1075 pub fn rustc_libdir(&self, compiler: Compiler) -> PathBuf {
1076 if compiler.is_snapshot(self) {
1077 self.rustc_snapshot_libdir()
1079 match self.config.libdir_relative() {
1080 Some(relative_libdir) if compiler.stage >= 1 => {
1081 self.sysroot(compiler).join(relative_libdir)
1083 _ => self.sysroot(compiler).join(libdir(compiler.host)),
1088 /// Returns the compiler's relative libdir where it stores the dynamic libraries that
1089 /// it itself links against.
1091 /// For example this returns `lib` on Unix and `bin` on
1093 pub fn libdir_relative(&self, compiler: Compiler) -> &Path {
1094 if compiler.is_snapshot(self) {
1095 libdir(self.config.build).as_ref()
1097 match self.config.libdir_relative() {
1098 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
1099 _ => libdir(compiler.host).as_ref(),
1104 /// Returns the compiler's relative libdir where the standard library and other artifacts are
1105 /// found for a compiler's sysroot.
1107 /// For example this returns `lib` on Unix and Windows.
1108 pub fn sysroot_libdir_relative(&self, compiler: Compiler) -> &Path {
1109 match self.config.libdir_relative() {
1110 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
1111 _ if compiler.stage == 0 => &self.build.initial_libdir,
1112 _ => Path::new("lib"),
1116 pub fn rustc_lib_paths(&self, compiler: Compiler) -> Vec<PathBuf> {
1117 let mut dylib_dirs = vec![self.rustc_libdir(compiler)];
1119 // Ensure that the downloaded LLVM libraries can be found.
1120 if self.config.llvm_from_ci {
1121 let ci_llvm_lib = self.out.join(&*compiler.host.triple).join("ci-llvm").join("lib");
1122 dylib_dirs.push(ci_llvm_lib);
1128 /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
1129 /// library lookup path.
1130 pub fn add_rustc_lib_path(&self, compiler: Compiler, cmd: &mut Command) {
1131 // Windows doesn't need dylib path munging because the dlls for the
1132 // compiler live next to the compiler and the system will find them
1138 add_dylib_path(self.rustc_lib_paths(compiler), cmd);
1141 /// Gets a path to the compiler specified.
1142 pub fn rustc(&self, compiler: Compiler) -> PathBuf {
1143 if compiler.is_snapshot(self) {
1144 self.initial_rustc.clone()
1146 self.sysroot(compiler).join("bin").join(exe("rustc", compiler.host))
1150 /// Gets the paths to all of the compiler's codegen backends.
1151 fn codegen_backends(&self, compiler: Compiler) -> impl Iterator<Item = PathBuf> {
1152 fs::read_dir(self.sysroot_codegen_backends(compiler))
1155 .filter_map(Result::ok)
1156 .map(|entry| entry.path())
1159 pub fn rustdoc(&self, compiler: Compiler) -> PathBuf {
1160 self.ensure(tool::Rustdoc { compiler })
1163 pub fn rustdoc_cmd(&self, compiler: Compiler) -> Command {
1164 let mut cmd = Command::new(&self.bootstrap_out.join("rustdoc"));
1165 cmd.env("RUSTC_STAGE", compiler.stage.to_string())
1166 .env("RUSTC_SYSROOT", self.sysroot(compiler))
1167 // Note that this is *not* the sysroot_libdir because rustdoc must be linked
1168 // equivalently to rustc.
1169 .env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler))
1170 .env("CFG_RELEASE_CHANNEL", &self.config.channel)
1171 .env("RUSTDOC_REAL", self.rustdoc(compiler))
1172 .env("RUSTC_BOOTSTRAP", "1");
1174 cmd.arg("-Wrustdoc::invalid_codeblock_attributes");
1176 if self.config.deny_warnings {
1177 cmd.arg("-Dwarnings");
1179 cmd.arg("-Znormalize-docs");
1181 // Remove make-related flags that can cause jobserver problems.
1182 cmd.env_remove("MAKEFLAGS");
1183 cmd.env_remove("MFLAGS");
1185 if let Some(linker) = self.linker(compiler.host) {
1186 cmd.env("RUSTDOC_LINKER", linker);
1188 if self.is_fuse_ld_lld(compiler.host) {
1189 cmd.env("RUSTDOC_FUSE_LD_LLD", "1");
1194 /// Return the path to `llvm-config` for the target, if it exists.
1196 /// Note that this returns `None` if LLVM is disabled, or if we're in a
1197 /// check build or dry-run, where there's no need to build all of LLVM.
1198 fn llvm_config(&self, target: TargetSelection) -> Option<PathBuf> {
1199 if self.config.llvm_enabled() && self.kind != Kind::Check && !self.config.dry_run {
1200 let llvm_config = self.ensure(native::Llvm { target });
1201 if llvm_config.is_file() {
1202 return Some(llvm_config);
1208 /// Convenience wrapper to allow `builder.llvm_link_shared()` instead of `builder.config.llvm_link_shared(&builder)`.
1209 pub(crate) fn llvm_link_shared(&self) -> bool {
1210 Config::llvm_link_shared(self)
1213 pub(crate) fn download_rustc(&self) -> bool {
1214 Config::download_rustc(self)
1217 pub(crate) fn initial_rustfmt(&self) -> Option<PathBuf> {
1218 Config::initial_rustfmt(self)
1221 /// Prepares an invocation of `cargo` to be run.
1223 /// This will create a `Command` that represents a pending execution of
1224 /// Cargo. This cargo will be configured to use `compiler` as the actual
1225 /// rustc compiler, its output will be scoped by `mode`'s output directory,
1226 /// it will pass the `--target` flag for the specified `target`, and will be
1227 /// executing the Cargo command `cmd`.
1232 source_type: SourceType,
1233 target: TargetSelection,
1236 let mut cargo = Command::new(&self.initial_cargo);
1237 let out_dir = self.stage_out(compiler, mode);
1239 // Codegen backends are not yet tracked by -Zbinary-dep-depinfo,
1240 // so we need to explicitly clear out if they've been updated.
1241 for backend in self.codegen_backends(compiler) {
1242 self.clear_if_dirty(&out_dir, &backend);
1245 if cmd == "doc" || cmd == "rustdoc" {
1246 let my_out = match mode {
1247 // This is the intended out directory for compiler documentation.
1248 Mode::Rustc | Mode::ToolRustc => self.compiler_doc_out(target),
1249 Mode::Std => out_dir.join(target.triple).join("doc"),
1250 _ => panic!("doc mode {:?} not expected", mode),
1252 let rustdoc = self.rustdoc(compiler);
1253 self.clear_if_dirty(&my_out, &rustdoc);
1256 cargo.env("CARGO_TARGET_DIR", &out_dir).arg(cmd);
1258 let profile_var = |name: &str| {
1259 let profile = if self.config.rust_optimize { "RELEASE" } else { "DEV" };
1260 format!("CARGO_PROFILE_{}_{}", profile, name)
1263 // See comment in rustc_llvm/build.rs for why this is necessary, largely llvm-config
1264 // needs to not accidentally link to libLLVM in stage0/lib.
1265 cargo.env("REAL_LIBRARY_PATH_VAR", &util::dylib_path_var());
1266 if let Some(e) = env::var_os(util::dylib_path_var()) {
1267 cargo.env("REAL_LIBRARY_PATH", e);
1270 // Found with `rg "init_env_logger\("`. If anyone uses `init_env_logger`
1271 // from out of tree it shouldn't matter, since x.py is only used for
1272 // building in-tree.
1273 let color_logs = ["RUSTDOC_LOG_COLOR", "RUSTC_LOG_COLOR", "RUST_LOG_COLOR"];
1274 match self.build.config.color {
1276 cargo.arg("--color=always");
1277 for log in &color_logs {
1278 cargo.env(log, "always");
1282 cargo.arg("--color=never");
1283 for log in &color_logs {
1284 cargo.env(log, "never");
1287 Color::Auto => {} // nothing to do
1290 if cmd != "install" {
1291 cargo.arg("--target").arg(target.rustc_target_arg());
1293 assert_eq!(target, compiler.host);
1296 // Set a flag for `check`/`clippy`/`fix`, so that certain build
1297 // scripts can do less work (i.e. not building/requiring LLVM).
1298 if cmd == "check" || cmd == "clippy" || cmd == "fix" {
1299 // If we've not yet built LLVM, or it's stale, then bust
1300 // the rustc_llvm cache. That will always work, even though it
1301 // may mean that on the next non-check build we'll need to rebuild
1302 // rustc_llvm. But if LLVM is stale, that'll be a tiny amount
1303 // of work comparatively, and we'd likely need to rebuild it anyway,
1305 if crate::native::prebuilt_llvm_config(self, target).is_err() {
1306 cargo.env("RUST_CHECK", "1");
1310 let stage = if compiler.stage == 0 && self.local_rebuild {
1311 // Assume the local-rebuild rustc already has stage1 features.
1317 let mut rustflags = Rustflags::new(target);
1319 if let Ok(s) = env::var("CARGOFLAGS_NOT_BOOTSTRAP") {
1320 cargo.args(s.split_whitespace());
1322 rustflags.env("RUSTFLAGS_NOT_BOOTSTRAP");
1324 if let Ok(s) = env::var("CARGOFLAGS_BOOTSTRAP") {
1325 cargo.args(s.split_whitespace());
1327 rustflags.env("RUSTFLAGS_BOOTSTRAP");
1328 if cmd == "clippy" {
1329 // clippy overwrites sysroot if we pass it to cargo.
1330 // Pass it directly to clippy instead.
1331 // NOTE: this can't be fixed in clippy because we explicitly don't set `RUSTC`,
1332 // so it has no way of knowing the sysroot.
1333 rustflags.arg("--sysroot");
1335 self.sysroot(compiler)
1338 .expect("sysroot must be valid UTF-8"),
1340 // Only run clippy on a very limited subset of crates (in particular, not build scripts).
1341 cargo.arg("-Zunstable-options");
1342 // Explicitly does *not* set `--cfg=bootstrap`, since we're using a nightly clippy.
1343 let host_version = Command::new("rustc").arg("--version").output().map_err(|_| ());
1344 let output = host_version.and_then(|output| {
1345 if output.status.success() {
1350 }).unwrap_or_else(|_| {
1352 "error: `x.py clippy` requires a host `rustc` toolchain with the `clippy` component"
1354 eprintln!("help: try `rustup component add clippy`");
1355 std::process::exit(1);
1357 if !t!(std::str::from_utf8(&output.stdout)).contains("nightly") {
1358 rustflags.arg("--cfg=bootstrap");
1361 rustflags.arg("--cfg=bootstrap");
1365 let use_new_symbol_mangling = match self.config.rust_new_symbol_mangling {
1367 // If an explicit setting is given, use that
1371 if mode == Mode::Std {
1372 // The standard library defaults to the legacy scheme
1375 // The compiler and tools default to the new scheme
1381 if use_new_symbol_mangling {
1382 rustflags.arg("-Csymbol-mangling-version=v0");
1384 rustflags.arg("-Csymbol-mangling-version=legacy");
1385 rustflags.arg("-Zunstable-options");
1388 // FIXME(Urgau): This a hack as it shouldn't be gated on stage 0 but until `rustc_llvm`
1389 // is made to work with `--check-cfg` which is currently not easly possible until cargo
1390 // get some support for setting `--check-cfg` within build script, it's the least invasive
1391 // hack that still let's us have cfg checking for the vast majority of the codebase.
1393 // Enable cfg checking of cargo features for everything but std and also enable cfg
1394 // checking of names and values.
1396 // Note: `std`, `alloc` and `core` imports some dependencies by #[path] (like
1397 // backtrace, core_simd, std_float, ...), those dependencies have their own
1398 // features but cargo isn't involved in the #[path] process and so cannot pass the
1399 // complete list of features, so for that reason we don't enable checking of
1400 // features for std crates.
1401 cargo.arg(if mode != Mode::Std {
1402 "-Zcheck-cfg=names,values,features"
1404 "-Zcheck-cfg=names,values"
1407 // Add extra cfg not defined in/by rustc
1409 // Note: Altrough it would seems that "-Zunstable-options" to `rustflags` is useless as
1410 // cargo would implicitly add it, it was discover that sometimes bootstrap only use
1411 // `rustflags` without `cargo` making it required.
1412 rustflags.arg("-Zunstable-options");
1413 for (restricted_mode, name, values) in EXTRA_CHECK_CFGS {
1414 if *restricted_mode == None || *restricted_mode == Some(mode) {
1415 // Creating a string of the values by concatenating each value:
1416 // ',"tvos","watchos"' or '' (nothing) when there are no values
1417 let values = match values {
1418 Some(values) => values
1420 .map(|val| [",", "\"", val, "\""])
1422 .collect::<String>(),
1423 None => String::new(),
1425 rustflags.arg(&format!("--check-cfg=values({name}{values})"));
1430 // FIXME: It might be better to use the same value for both `RUSTFLAGS` and `RUSTDOCFLAGS`,
1431 // but this breaks CI. At the very least, stage0 `rustdoc` needs `--cfg bootstrap`. See
1433 let mut rustdocflags = rustflags.clone();
1434 rustdocflags.propagate_cargo_env("RUSTDOCFLAGS");
1436 rustdocflags.env("RUSTDOCFLAGS_BOOTSTRAP");
1438 rustdocflags.env("RUSTDOCFLAGS_NOT_BOOTSTRAP");
1441 if let Ok(s) = env::var("CARGOFLAGS") {
1442 cargo.args(s.split_whitespace());
1446 Mode::Std | Mode::ToolBootstrap | Mode::ToolStd => {}
1447 Mode::Rustc | Mode::Codegen | Mode::ToolRustc => {
1448 // Build proc macros both for the host and the target
1449 if target != compiler.host && cmd != "check" {
1450 cargo.arg("-Zdual-proc-macros");
1451 rustflags.arg("-Zdual-proc-macros");
1456 // This tells Cargo (and in turn, rustc) to output more complete
1457 // dependency information. Most importantly for rustbuild, this
1458 // includes sysroot artifacts, like libstd, which means that we don't
1459 // need to track those in rustbuild (an error prone process!). This
1460 // feature is currently unstable as there may be some bugs and such, but
1461 // it represents a big improvement in rustbuild's reliability on
1462 // rebuilds, so we're using it here.
1464 // For some additional context, see #63470 (the PR originally adding
1465 // this), as well as #63012 which is the tracking issue for this
1466 // feature on the rustc side.
1467 cargo.arg("-Zbinary-dep-depinfo");
1469 Mode::ToolBootstrap => {
1470 // Restrict the allowed features to those passed by rustbuild, so we don't depend on nightly accidentally.
1471 // HACK: because anyhow does feature detection in build.rs, we need to allow the backtrace feature too.
1472 rustflags.arg("-Zallow-features=binary-dep-depinfo,backtrace");
1475 // Right now this is just compiletest and a few other tools that build on stable.
1476 // Allow them to use `feature(test)`, but nothing else.
1477 rustflags.arg("-Zallow-features=binary-dep-depinfo,test,backtrace");
1479 Mode::Std | Mode::Rustc | Mode::Codegen | Mode::ToolRustc => {}
1482 cargo.arg("-j").arg(self.jobs().to_string());
1483 // Remove make-related flags to ensure Cargo can correctly set things up
1484 cargo.env_remove("MAKEFLAGS");
1485 cargo.env_remove("MFLAGS");
1487 // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
1488 // Force cargo to output binaries with disambiguating hashes in the name
1489 let mut metadata = if compiler.stage == 0 {
1490 // Treat stage0 like a special channel, whether it's a normal prior-
1491 // release rustc or a local rebuild with the same version, so we
1492 // never mix these libraries by accident.
1493 "bootstrap".to_string()
1495 self.config.channel.to_string()
1497 // We want to make sure that none of the dependencies between
1498 // std/test/rustc unify with one another. This is done for weird linkage
1499 // reasons but the gist of the problem is that if librustc, libtest, and
1500 // libstd all depend on libc from crates.io (which they actually do) we
1501 // want to make sure they all get distinct versions. Things get really
1502 // weird if we try to unify all these dependencies right now, namely
1503 // around how many times the library is linked in dynamic libraries and
1504 // such. If rustc were a static executable or if we didn't ship dylibs
1505 // this wouldn't be a problem, but we do, so it is. This is in general
1506 // just here to make sure things build right. If you can remove this and
1507 // things still build right, please do!
1509 Mode::Std => metadata.push_str("std"),
1510 // When we're building rustc tools, they're built with a search path
1511 // that contains things built during the rustc build. For example,
1512 // bitflags is built during the rustc build, and is a dependency of
1513 // rustdoc as well. We're building rustdoc in a different target
1514 // directory, though, which means that Cargo will rebuild the
1515 // dependency. When we go on to build rustdoc, we'll look for
1516 // bitflags, and find two different copies: one built during the
1517 // rustc step and one that we just built. This isn't always a
1518 // problem, somehow -- not really clear why -- but we know that this
1520 Mode::ToolRustc => metadata.push_str("tool-rustc"),
1521 // Same for codegen backends.
1522 Mode::Codegen => metadata.push_str("codegen"),
1525 cargo.env("__CARGO_DEFAULT_LIB_METADATA", &metadata);
1527 if cmd == "clippy" {
1528 rustflags.arg("-Zforce-unstable-if-unmarked");
1531 rustflags.arg("-Zmacro-backtrace");
1533 let want_rustdoc = self.doc_tests != DocTests::No;
1535 // We synthetically interpret a stage0 compiler used to build tools as a
1536 // "raw" compiler in that it's the exact snapshot we download. Normally
1537 // the stage0 build means it uses libraries build by the stage0
1538 // compiler, but for tools we just use the precompiled libraries that
1540 let use_snapshot = mode == Mode::ToolBootstrap;
1541 assert!(!use_snapshot || stage == 0 || self.local_rebuild);
1543 let maybe_sysroot = self.sysroot(compiler);
1544 let sysroot = if use_snapshot { self.rustc_snapshot_sysroot() } else { &maybe_sysroot };
1545 let libdir = self.rustc_libdir(compiler);
1547 // Clear the output directory if the real rustc we're using has changed;
1548 // Cargo cannot detect this as it thinks rustc is bootstrap/debug/rustc.
1550 // Avoid doing this during dry run as that usually means the relevant
1551 // compiler is not yet linked/copied properly.
1553 // Only clear out the directory if we're compiling std; otherwise, we
1554 // should let Cargo take care of things for us (via depdep info)
1555 if !self.config.dry_run && mode == Mode::Std && cmd == "build" {
1556 self.clear_if_dirty(&out_dir, &self.rustc(compiler));
1559 // Customize the compiler we're running. Specify the compiler to cargo
1560 // as our shim and then pass it some various options used to configure
1561 // how the actual compiler itself is called.
1563 // These variables are primarily all read by
1564 // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
1566 .env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
1567 .env("RUSTC_REAL", self.rustc(compiler))
1568 .env("RUSTC_STAGE", stage.to_string())
1569 .env("RUSTC_SYSROOT", &sysroot)
1570 .env("RUSTC_LIBDIR", &libdir)
1571 .env("RUSTDOC", self.bootstrap_out.join("rustdoc"))
1574 if cmd == "doc" || cmd == "rustdoc" || (cmd == "test" && want_rustdoc) {
1575 self.rustdoc(compiler)
1577 PathBuf::from("/path/to/nowhere/rustdoc/not/required")
1580 .env("RUSTC_ERROR_METADATA_DST", self.extended_error_dir())
1581 .env("RUSTC_BREAK_ON_ICE", "1");
1582 // Clippy support is a hack and uses the default `cargo-clippy` in path.
1583 // Don't override RUSTC so that the `cargo-clippy` in path will be run.
1584 if cmd != "clippy" {
1585 cargo.env("RUSTC", self.bootstrap_out.join("rustc"));
1588 // Dealing with rpath here is a little special, so let's go into some
1589 // detail. First off, `-rpath` is a linker option on Unix platforms
1590 // which adds to the runtime dynamic loader path when looking for
1591 // dynamic libraries. We use this by default on Unix platforms to ensure
1592 // that our nightlies behave the same on Windows, that is they work out
1593 // of the box. This can be disabled, of course, but basically that's why
1594 // we're gated on RUSTC_RPATH here.
1596 // Ok, so the astute might be wondering "why isn't `-C rpath` used
1597 // here?" and that is indeed a good question to ask. This codegen
1598 // option is the compiler's current interface to generating an rpath.
1599 // Unfortunately it doesn't quite suffice for us. The flag currently
1600 // takes no value as an argument, so the compiler calculates what it
1601 // should pass to the linker as `-rpath`. This unfortunately is based on
1602 // the **compile time** directory structure which when building with
1603 // Cargo will be very different than the runtime directory structure.
1605 // All that's a really long winded way of saying that if we use
1606 // `-Crpath` then the executables generated have the wrong rpath of
1607 // something like `$ORIGIN/deps` when in fact the way we distribute
1608 // rustc requires the rpath to be `$ORIGIN/../lib`.
1610 // So, all in all, to set up the correct rpath we pass the linker
1611 // argument manually via `-C link-args=-Wl,-rpath,...`. Plus isn't it
1612 // fun to pass a flag to a tool to pass a flag to pass a flag to a tool
1613 // to change a flag in a binary?
1614 if self.config.rust_rpath && util::use_host_linker(target) {
1615 let rpath = if target.contains("apple") {
1616 // Note that we need to take one extra step on macOS to also pass
1617 // `-Wl,-instal_name,@rpath/...` to get things to work right. To
1618 // do that we pass a weird flag to the compiler to get it to do
1619 // so. Note that this is definitely a hack, and we should likely
1620 // flesh out rpath support more fully in the future.
1621 rustflags.arg("-Zosx-rpath-install-name");
1622 Some("-Wl,-rpath,@loader_path/../lib")
1623 } else if !target.contains("windows") {
1624 rustflags.arg("-Clink-args=-Wl,-z,origin");
1625 Some("-Wl,-rpath,$ORIGIN/../lib")
1629 if let Some(rpath) = rpath {
1630 rustflags.arg(&format!("-Clink-args={}", rpath));
1634 if let Some(host_linker) = self.linker(compiler.host) {
1635 cargo.env("RUSTC_HOST_LINKER", host_linker);
1637 if self.is_fuse_ld_lld(compiler.host) {
1638 cargo.env("RUSTC_HOST_FUSE_LD_LLD", "1");
1639 cargo.env("RUSTDOC_FUSE_LD_LLD", "1");
1642 if let Some(target_linker) = self.linker(target) {
1643 let target = crate::envify(&target.triple);
1644 cargo.env(&format!("CARGO_TARGET_{}_LINKER", target), target_linker);
1646 if self.is_fuse_ld_lld(target) {
1647 rustflags.arg("-Clink-args=-fuse-ld=lld");
1649 self.lld_flags(target).for_each(|flag| {
1650 rustdocflags.arg(&flag);
1653 if !(["build", "check", "clippy", "fix", "rustc"].contains(&cmd)) && want_rustdoc {
1654 cargo.env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler));
1657 let debuginfo_level = match mode {
1658 Mode::Rustc | Mode::Codegen => self.config.rust_debuginfo_level_rustc,
1659 Mode::Std => self.config.rust_debuginfo_level_std,
1660 Mode::ToolBootstrap | Mode::ToolStd | Mode::ToolRustc => {
1661 self.config.rust_debuginfo_level_tools
1664 cargo.env(profile_var("DEBUG"), debuginfo_level.to_string());
1666 profile_var("DEBUG_ASSERTIONS"),
1667 if mode == Mode::Std {
1668 self.config.rust_debug_assertions_std.to_string()
1670 self.config.rust_debug_assertions.to_string()
1674 profile_var("OVERFLOW_CHECKS"),
1675 if mode == Mode::Std {
1676 self.config.rust_overflow_checks_std.to_string()
1678 self.config.rust_overflow_checks.to_string()
1682 if !target.contains("windows") {
1683 let needs_unstable_opts = target.contains("linux")
1684 || target.contains("windows")
1685 || target.contains("bsd")
1686 || target.contains("dragonfly");
1688 if needs_unstable_opts {
1689 rustflags.arg("-Zunstable-options");
1691 match self.config.rust_split_debuginfo {
1692 SplitDebuginfo::Packed => rustflags.arg("-Csplit-debuginfo=packed"),
1693 SplitDebuginfo::Unpacked => rustflags.arg("-Csplit-debuginfo=unpacked"),
1694 SplitDebuginfo::Off => rustflags.arg("-Csplit-debuginfo=off"),
1698 if self.config.cmd.bless() {
1699 // Bless `expect!` tests.
1700 cargo.env("UPDATE_EXPECT", "1");
1703 if !mode.is_tool() {
1704 cargo.env("RUSTC_FORCE_UNSTABLE", "1");
1707 if let Some(x) = self.crt_static(target) {
1709 rustflags.arg("-Ctarget-feature=+crt-static");
1711 rustflags.arg("-Ctarget-feature=-crt-static");
1715 if let Some(x) = self.crt_static(compiler.host) {
1716 cargo.env("RUSTC_HOST_CRT_STATIC", x.to_string());
1719 if let Some(map_to) = self.build.debuginfo_map_to(GitRepo::Rustc) {
1720 let map = format!("{}={}", self.build.src.display(), map_to);
1721 cargo.env("RUSTC_DEBUGINFO_MAP", map);
1723 // `rustc` needs to know the virtual `/rustc/$hash` we're mapping to,
1724 // in order to opportunistically reverse it later.
1725 cargo.env("CFG_VIRTUAL_RUST_SOURCE_BASE_DIR", map_to);
1728 // Enable usage of unstable features
1729 cargo.env("RUSTC_BOOTSTRAP", "1");
1730 self.add_rust_test_threads(&mut cargo);
1732 // Almost all of the crates that we compile as part of the bootstrap may
1733 // have a build script, including the standard library. To compile a
1734 // build script, however, it itself needs a standard library! This
1735 // introduces a bit of a pickle when we're compiling the standard
1738 // To work around this we actually end up using the snapshot compiler
1739 // (stage0) for compiling build scripts of the standard library itself.
1740 // The stage0 compiler is guaranteed to have a libstd available for use.
1742 // For other crates, however, we know that we've already got a standard
1743 // library up and running, so we can use the normal compiler to compile
1744 // build scripts in that situation.
1745 if mode == Mode::Std {
1747 .env("RUSTC_SNAPSHOT", &self.initial_rustc)
1748 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
1751 .env("RUSTC_SNAPSHOT", self.rustc(compiler))
1752 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
1755 // Tools that use compiler libraries may inherit the `-lLLVM` link
1756 // requirement, but the `-L` library path is not propagated across
1757 // separate Cargo projects. We can add LLVM's library path to the
1758 // platform-specific environment variable as a workaround.
1759 if mode == Mode::ToolRustc || mode == Mode::Codegen {
1760 if let Some(llvm_config) = self.llvm_config(target) {
1761 let llvm_libdir = output(Command::new(&llvm_config).arg("--libdir"));
1762 add_link_lib_path(vec![llvm_libdir.trim().into()], &mut cargo);
1766 // Compile everything except libraries and proc macros with the more
1767 // efficient initial-exec TLS model. This doesn't work with `dlopen`,
1768 // so we can't use it by default in general, but we can use it for tools
1769 // and our own internal libraries.
1770 if !mode.must_support_dlopen() && !target.triple.starts_with("powerpc-") {
1771 rustflags.arg("-Ztls-model=initial-exec");
1774 if self.config.incremental {
1775 cargo.env("CARGO_INCREMENTAL", "1");
1777 // Don't rely on any default setting for incr. comp. in Cargo
1778 cargo.env("CARGO_INCREMENTAL", "0");
1781 if let Some(ref on_fail) = self.config.on_fail {
1782 cargo.env("RUSTC_ON_FAIL", on_fail);
1785 if self.config.print_step_timings {
1786 cargo.env("RUSTC_PRINT_STEP_TIMINGS", "1");
1789 if self.config.print_step_rusage {
1790 cargo.env("RUSTC_PRINT_STEP_RUSAGE", "1");
1793 if self.config.backtrace_on_ice {
1794 cargo.env("RUSTC_BACKTRACE_ON_ICE", "1");
1797 cargo.env("RUSTC_VERBOSE", self.verbosity.to_string());
1799 if source_type == SourceType::InTree {
1800 let mut lint_flags = Vec::new();
1801 // When extending this list, add the new lints to the RUSTFLAGS of the
1802 // build_bootstrap function of src/bootstrap/bootstrap.py as well as
1803 // some code doesn't go through this `rustc` wrapper.
1804 lint_flags.push("-Wrust_2018_idioms");
1805 lint_flags.push("-Wunused_lifetimes");
1806 lint_flags.push("-Wsemicolon_in_expressions_from_macros");
1808 if self.config.deny_warnings {
1809 lint_flags.push("-Dwarnings");
1810 rustdocflags.arg("-Dwarnings");
1813 // This does not use RUSTFLAGS due to caching issues with Cargo.
1814 // Clippy is treated as an "in tree" tool, but shares the same
1815 // cache as other "submodule" tools. With these options set in
1816 // RUSTFLAGS, that causes *every* shared dependency to be rebuilt.
1817 // By injecting this into the rustc wrapper, this circumvents
1818 // Cargo's fingerprint detection. This is fine because lint flags
1819 // are always ignored in dependencies. Eventually this should be
1820 // fixed via better support from Cargo.
1821 cargo.env("RUSTC_LINT_FLAGS", lint_flags.join(" "));
1823 rustdocflags.arg("-Wrustdoc::invalid_codeblock_attributes");
1826 if mode == Mode::Rustc {
1827 rustflags.arg("-Zunstable-options");
1828 rustflags.arg("-Wrustc::internal");
1831 // Throughout the build Cargo can execute a number of build scripts
1832 // compiling C/C++ code and we need to pass compilers, archivers, flags, etc
1833 // obtained previously to those build scripts.
1834 // Build scripts use either the `cc` crate or `configure/make` so we pass
1835 // the options through environment variables that are fetched and understood by both.
1837 // FIXME: the guard against msvc shouldn't need to be here
1838 if target.contains("msvc") {
1839 if let Some(ref cl) = self.config.llvm_clang_cl {
1840 cargo.env("CC", cl).env("CXX", cl);
1843 let ccache = self.config.ccache.as_ref();
1844 let ccacheify = |s: &Path| {
1845 let ccache = match ccache {
1847 None => return s.display().to_string(),
1849 // FIXME: the cc-rs crate only recognizes the literal strings
1850 // `ccache` and `sccache` when doing caching compilations, so we
1851 // mirror that here. It should probably be fixed upstream to
1852 // accept a new env var or otherwise work with custom ccache
1855 "ccache" | "sccache" => format!("{} {}", ccache, s.display()),
1856 _ => s.display().to_string(),
1859 let cc = ccacheify(&self.cc(target));
1860 cargo.env(format!("CC_{}", target.triple), &cc);
1862 let cflags = self.cflags(target, GitRepo::Rustc, CLang::C).join(" ");
1863 cargo.env(format!("CFLAGS_{}", target.triple), &cflags);
1865 if let Some(ar) = self.ar(target) {
1866 let ranlib = format!("{} s", ar.display());
1868 .env(format!("AR_{}", target.triple), ar)
1869 .env(format!("RANLIB_{}", target.triple), ranlib);
1872 if let Ok(cxx) = self.cxx(target) {
1873 let cxx = ccacheify(&cxx);
1874 let cxxflags = self.cflags(target, GitRepo::Rustc, CLang::Cxx).join(" ");
1876 .env(format!("CXX_{}", target.triple), &cxx)
1877 .env(format!("CXXFLAGS_{}", target.triple), cxxflags);
1881 if mode == Mode::Std && self.config.extended && compiler.is_final_stage(self) {
1882 rustflags.arg("-Zsave-analysis");
1884 "RUST_SAVE_ANALYSIS_CONFIG",
1885 "{\"output_file\": null,\"full_docs\": false,\
1886 \"pub_only\": true,\"reachable_only\": false,\
1887 \"distro_crate\": true,\"signatures\": false,\"borrow_data\": false}",
1891 // If Control Flow Guard is enabled, pass the `control-flow-guard` flag to rustc
1892 // when compiling the standard library, since this might be linked into the final outputs
1893 // produced by rustc. Since this mitigation is only available on Windows, only enable it
1894 // for the standard library in case the compiler is run on a non-Windows platform.
1895 // This is not needed for stage 0 artifacts because these will only be used for building
1896 // the stage 1 compiler.
1898 && mode == Mode::Std
1899 && self.config.control_flow_guard
1900 && compiler.stage >= 1
1902 rustflags.arg("-Ccontrol-flow-guard");
1905 // For `cargo doc` invocations, make rustdoc print the Rust version into the docs
1906 // This replaces spaces with newlines because RUSTDOCFLAGS does not
1907 // support arguments with regular spaces. Hopefully someday Cargo will
1908 // have space support.
1909 let rust_version = self.rust_version().replace(' ', "\n");
1910 rustdocflags.arg("--crate-version").arg(&rust_version);
1912 // Environment variables *required* throughout the build
1914 // FIXME: should update code to not require this env var
1915 cargo.env("CFG_COMPILER_HOST_TRIPLE", target.triple);
1917 // Set this for all builds to make sure doc builds also get it.
1918 cargo.env("CFG_RELEASE_CHANNEL", &self.config.channel);
1920 // This one's a bit tricky. As of the time of this writing the compiler
1921 // links to the `winapi` crate on crates.io. This crate provides raw
1922 // bindings to Windows system functions, sort of like libc does for
1923 // Unix. This crate also, however, provides "import libraries" for the
1924 // MinGW targets. There's an import library per dll in the windows
1925 // distribution which is what's linked to. These custom import libraries
1926 // are used because the winapi crate can reference Windows functions not
1927 // present in the MinGW import libraries.
1929 // For example MinGW may ship libdbghelp.a, but it may not have
1930 // references to all the functions in the dbghelp dll. Instead the
1931 // custom import library for dbghelp in the winapi crates has all this
1934 // Unfortunately for us though the import libraries are linked by
1935 // default via `-ldylib=winapi_foo`. That is, they're linked with the
1936 // `dylib` type with a `winapi_` prefix (so the winapi ones don't
1937 // conflict with the system MinGW ones). This consequently means that
1938 // the binaries we ship of things like rustc_codegen_llvm (aka the rustc_codegen_llvm
1939 // DLL) when linked against *again*, for example with procedural macros
1940 // or plugins, will trigger the propagation logic of `-ldylib`, passing
1941 // `-lwinapi_foo` to the linker again. This isn't actually available in
1942 // our distribution, however, so the link fails.
1944 // To solve this problem we tell winapi to not use its bundled import
1945 // libraries. This means that it will link to the system MinGW import
1946 // libraries by default, and the `-ldylib=foo` directives will still get
1947 // passed to the final linker, but they'll look like `-lfoo` which can
1948 // be resolved because MinGW has the import library. The downside is we
1949 // don't get newer functions from Windows, but we don't use any of them
1951 if !mode.is_tool() {
1952 cargo.env("WINAPI_NO_BUNDLED_LIBRARIES", "1");
1955 for _ in 0..self.verbosity {
1959 match (mode, self.config.rust_codegen_units_std, self.config.rust_codegen_units) {
1960 (Mode::Std, Some(n), _) | (_, _, Some(n)) => {
1961 cargo.env(profile_var("CODEGEN_UNITS"), n.to_string());
1964 // Don't set anything
1968 if self.config.rust_optimize {
1969 // FIXME: cargo bench/install do not accept `--release`
1970 if cmd != "bench" && cmd != "install" {
1971 cargo.arg("--release");
1975 if self.config.locked_deps {
1976 cargo.arg("--locked");
1978 if self.config.vendor || self.is_sudo {
1979 cargo.arg("--frozen");
1982 // Try to use a sysroot-relative bindir, in case it was configured absolutely.
1983 cargo.env("RUSTC_INSTALL_BINDIR", self.config.bindir_relative());
1985 self.ci_env.force_coloring_in_ci(&mut cargo);
1987 // When we build Rust dylibs they're all intended for intermediate
1988 // usage, so make sure we pass the -Cprefer-dynamic flag instead of
1989 // linking all deps statically into the dylib.
1990 if matches!(mode, Mode::Std | Mode::Rustc) {
1991 rustflags.arg("-Cprefer-dynamic");
1994 // When building incrementally we default to a lower ThinLTO import limit
1995 // (unless explicitly specified otherwise). This will produce a somewhat
1996 // slower code but give way better compile times.
1998 let limit = match self.config.rust_thin_lto_import_instr_limit {
1999 Some(limit) => Some(limit),
2000 None if self.config.incremental => Some(10),
2004 if let Some(limit) = limit {
2005 rustflags.arg(&format!("-Cllvm-args=-import-instr-limit={}", limit));
2009 Cargo { command: cargo, rustflags, rustdocflags }
2012 /// Ensure that a given step is built, returning its output. This will
2013 /// cache the step, so it is safe (and good!) to call this as often as
2014 /// needed to ensure that all dependencies are built.
2015 pub fn ensure<S: Step>(&'a self, step: S) -> S::Output {
2017 let mut stack = self.stack.borrow_mut();
2018 for stack_step in stack.iter() {
2020 if stack_step.downcast_ref::<S>().map_or(true, |stack_step| *stack_step != step) {
2023 let mut out = String::new();
2024 out += &format!("\n\nCycle in build detected when adding {:?}\n", step);
2025 for el in stack.iter().rev() {
2026 out += &format!("\t{:?}\n", el);
2030 if let Some(out) = self.cache.get(&step) {
2031 self.verbose_than(1, &format!("{}c {:?}", " ".repeat(stack.len()), step));
2035 self.verbose_than(1, &format!("{}> {:?}", " ".repeat(stack.len()), step));
2036 stack.push(Box::new(step.clone()));
2039 #[cfg(feature = "build-metrics")]
2040 self.metrics.enter_step(&step);
2043 let start = Instant::now();
2044 let zero = Duration::new(0, 0);
2045 let parent = self.time_spent_on_dependencies.replace(zero);
2046 let out = step.clone().run(self);
2047 let dur = start.elapsed();
2048 let deps = self.time_spent_on_dependencies.replace(parent + dur);
2052 if self.config.print_step_timings && !self.config.dry_run {
2053 let step_string = format!("{:?}", step);
2054 let brace_index = step_string.find("{").unwrap_or(0);
2055 let type_string = type_name::<S>();
2057 "[TIMING] {} {} -- {}.{:03}",
2058 &type_string.strip_prefix("bootstrap::").unwrap_or(type_string),
2059 &step_string[brace_index..],
2065 #[cfg(feature = "build-metrics")]
2066 self.metrics.exit_step();
2069 let mut stack = self.stack.borrow_mut();
2070 let cur_step = stack.pop().expect("step stack empty");
2071 assert_eq!(cur_step.downcast_ref(), Some(&step));
2073 self.verbose_than(1, &format!("{}< {:?}", " ".repeat(self.stack.borrow().len()), step));
2074 self.cache.put(step, out.clone());
2078 /// Ensure that a given step is built *only if it's supposed to be built by default*, returning
2079 /// its output. This will cache the step, so it's safe (and good!) to call this as often as
2080 /// needed to ensure that all dependencies are build.
2081 pub(crate) fn ensure_if_default<T, S: Step<Output = Option<T>>>(
2086 let desc = StepDescription::from::<S>(kind);
2087 let should_run = (desc.should_run)(ShouldRun::new(self, desc.kind));
2089 // Avoid running steps contained in --exclude
2090 for pathset in &should_run.paths {
2091 if desc.is_excluded(self, pathset) {
2096 // Only execute if it's supposed to run as default
2097 if desc.default && should_run.is_really_default() { self.ensure(step) } else { None }
2100 /// Checks if any of the "should_run" paths is in the `Builder` paths.
2101 pub(crate) fn was_invoked_explicitly<S: Step>(&'a self, kind: Kind) -> bool {
2102 let desc = StepDescription::from::<S>(kind);
2103 let should_run = (desc.should_run)(ShouldRun::new(self, desc.kind));
2105 for path in &self.paths {
2106 if should_run.paths.iter().any(|s| s.has(path, Some(desc.kind)))
2107 && !desc.is_excluded(
2109 &PathSet::Suite(TaskPath { path: path.clone(), kind: Some(desc.kind) }),
2123 #[derive(Debug, Clone)]
2124 struct Rustflags(String, TargetSelection);
2127 fn new(target: TargetSelection) -> Rustflags {
2128 let mut ret = Rustflags(String::new(), target);
2129 ret.propagate_cargo_env("RUSTFLAGS");
2133 /// By default, cargo will pick up on various variables in the environment. However, bootstrap
2134 /// reuses those variables to pass additional flags to rustdoc, so by default they get overridden.
2135 /// Explicitly add back any previous value in the environment.
2137 /// `prefix` is usually `RUSTFLAGS` or `RUSTDOCFLAGS`.
2138 fn propagate_cargo_env(&mut self, prefix: &str) {
2139 // Inherit `RUSTFLAGS` by default ...
2142 // ... and also handle target-specific env RUSTFLAGS if they're configured.
2143 let target_specific = format!("CARGO_TARGET_{}_{}", crate::envify(&self.1.triple), prefix);
2144 self.env(&target_specific);
2147 fn env(&mut self, env: &str) {
2148 if let Ok(s) = env::var(env) {
2149 for part in s.split(' ') {
2155 fn arg(&mut self, arg: &str) -> &mut Self {
2156 assert_eq!(arg.split(' ').count(), 1);
2157 if !self.0.is_empty() {
2160 self.0.push_str(arg);
2168 rustflags: Rustflags,
2169 rustdocflags: Rustflags,
2173 pub fn rustdocflag(&mut self, arg: &str) -> &mut Cargo {
2174 self.rustdocflags.arg(arg);
2177 pub fn rustflag(&mut self, arg: &str) -> &mut Cargo {
2178 self.rustflags.arg(arg);
2182 pub fn arg(&mut self, arg: impl AsRef<OsStr>) -> &mut Cargo {
2183 self.command.arg(arg.as_ref());
2187 pub fn args<I, S>(&mut self, args: I) -> &mut Cargo
2189 I: IntoIterator<Item = S>,
2193 self.arg(arg.as_ref());
2198 pub fn env(&mut self, key: impl AsRef<OsStr>, value: impl AsRef<OsStr>) -> &mut Cargo {
2199 // These are managed through rustflag/rustdocflag interfaces.
2200 assert_ne!(key.as_ref(), "RUSTFLAGS");
2201 assert_ne!(key.as_ref(), "RUSTDOCFLAGS");
2202 self.command.env(key.as_ref(), value.as_ref());
2206 pub fn add_rustc_lib_path(&mut self, builder: &Builder<'_>, compiler: Compiler) {
2207 builder.add_rustc_lib_path(compiler, &mut self.command);
2210 pub fn current_dir(&mut self, dir: &Path) -> &mut Cargo {
2211 self.command.current_dir(dir);
2216 impl From<Cargo> for Command {
2217 fn from(mut cargo: Cargo) -> Command {
2218 let rustflags = &cargo.rustflags.0;
2219 if !rustflags.is_empty() {
2220 cargo.command.env("RUSTFLAGS", rustflags);
2223 let rustdocflags = &cargo.rustdocflags.0;
2224 if !rustdocflags.is_empty() {
2225 cargo.command.env("RUSTDOCFLAGS", rustdocflags);