1 use std::collections::HashSet;
4 use std::path::PathBuf;
5 use std::process::{exit, Command};
9 use crate::builder::{Builder, Cargo as CargoCommand, RunConfig, ShouldRun, Step};
10 use crate::channel::GitInfo;
12 use crate::config::TargetSelection;
13 use crate::toolstate::ToolState;
14 use crate::util::{add_dylib_path, exe};
18 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
24 #[derive(Debug, Clone, Hash, PartialEq, Eq)]
27 target: TargetSelection,
31 is_optional_tool: bool,
32 source_type: SourceType,
33 extra_features: Vec<String>,
36 impl Step for ToolBuild {
37 type Output = Option<PathBuf>;
39 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
43 /// Builds a tool in `src/tools`
45 /// This will build the specified tool with the specified `host` compiler in
46 /// `stage` into the normal cargo output directory.
47 fn run(self, builder: &Builder<'_>) -> Option<PathBuf> {
48 let compiler = self.compiler;
49 let target = self.target;
50 let mut tool = self.tool;
52 let is_optional_tool = self.is_optional_tool;
56 builder.ensure(compile::Std { compiler, target: compiler.host });
57 builder.ensure(compile::Rustc { compiler, target });
59 Mode::ToolStd => builder.ensure(compile::Std { compiler, target }),
60 Mode::ToolBootstrap => {} // uses downloaded stage0 compiler libs
61 _ => panic!("unexpected Mode for tool build"),
64 let cargo = prepare_tool_cargo(
75 builder.info(&format!("Building stage{} tool {} ({})", compiler.stage, tool, target));
76 let mut duplicates = Vec::new();
77 let is_expected = compile::stream_cargo(builder, cargo, vec![], &mut |msg| {
78 // Only care about big things like the RLS/Cargo for now
80 "rls" | "cargo" | "clippy-driver" | "miri" | "rustfmt" => {}
84 let (id, features, filenames) = match msg {
85 compile::CargoMessage::CompilerArtifact {
90 } => (package_id, features, filenames),
93 let features = features.iter().map(|s| s.to_string()).collect::<Vec<_>>();
95 for path in filenames {
96 let val = (tool, PathBuf::from(&*path), features.clone());
97 // we're only interested in deduplicating rlibs for now
98 if val.1.extension().and_then(|s| s.to_str()) != Some("rlib") {
102 // Don't worry about compiles that turn out to be host
103 // dependencies or build scripts. To skip these we look for
104 // anything that goes in `.../release/deps` but *doesn't* go in
105 // `$target/release/deps`. This ensure that outputs in
106 // `$target/release` are still considered candidates for
108 if let Some(parent) = val.1.parent() {
109 if parent.ends_with("release/deps") {
110 let maybe_target = parent
112 .and_then(|p| p.parent())
113 .and_then(|p| p.file_name())
114 .and_then(|p| p.to_str())
116 if maybe_target != &*target.triple {
122 // Record that we've built an artifact for `id`, and if one was
123 // already listed then we need to see if we reused the same
124 // artifact or produced a duplicate.
125 let mut artifacts = builder.tool_artifacts.borrow_mut();
126 let prev_artifacts = artifacts.entry(target).or_default();
127 let prev = match prev_artifacts.get(&*id) {
130 prev_artifacts.insert(id.to_string(), val);
135 return; // same path, same artifact
138 // If the paths are different and one of them *isn't* inside of
139 // `release/deps`, then it means it's probably in
140 // `$target/release`, or it's some final artifact like
141 // `libcargo.rlib`. In these situations Cargo probably just
142 // copied it up from `$target/release/deps/libcargo-xxxx.rlib`,
143 // so if the features are equal we can just skip it.
144 let prev_no_hash = prev.1.parent().unwrap().ends_with("release/deps");
145 let val_no_hash = val.1.parent().unwrap().ends_with("release/deps");
146 if prev.2 == val.2 || !prev_no_hash || !val_no_hash {
150 // ... and otherwise this looks like we duplicated some sort of
151 // compilation, so record it to generate an error later.
152 duplicates.push((id.to_string(), val, prev.clone()));
156 if is_expected && !duplicates.is_empty() {
158 "duplicate artifacts found when compiling a tool, this \
159 typically means that something was recompiled because \
160 a transitive dependency has different features activated \
161 than in a previous build:\n"
164 "the following dependencies are duplicated although they \
165 have the same features enabled:"
167 let (same, different): (Vec<_>, Vec<_>) =
168 duplicates.into_iter().partition(|(_, cur, prev)| cur.2 == prev.2);
169 for (id, cur, prev) in same {
172 println!(" `{}` ({:?})\n `{}` ({:?})", cur.0, cur.1, prev.0, prev.1);
174 println!("the following dependencies have different features:");
175 for (id, cur, prev) in different {
177 let cur_features: HashSet<_> = cur.2.into_iter().collect();
178 let prev_features: HashSet<_> = prev.2.into_iter().collect();
180 " `{}` additionally enabled features {:?} at {:?}",
182 &cur_features - &prev_features,
186 " `{}` additionally enabled features {:?} at {:?}",
188 &prev_features - &cur_features,
194 "to fix this you will probably want to edit the local \
195 src/tools/rustc-workspace-hack/Cargo.toml crate, as \
196 that will update the dependency graph to ensure that \
197 these crates all share the same feature set"
199 panic!("tools should not compile multiple copies of the same crate");
202 builder.save_toolstate(
204 if is_expected { ToolState::TestFail } else { ToolState::BuildFail },
208 if !is_optional_tool {
214 // HACK(#82501): on Windows, the tools directory gets added to PATH when running tests, and
215 // compiletest confuses HTML tidy with the in-tree tidy. Name the in-tree tidy something
216 // different so the problem doesn't come up.
220 let cargo_out = builder.cargo_out(compiler, self.mode, target).join(exe(tool, target));
221 let bin = builder.tools_dir(compiler).join(exe(tool, target));
222 builder.copy(&cargo_out, &bin);
228 pub fn prepare_tool_cargo(
229 builder: &Builder<'_>,
232 target: TargetSelection,
233 command: &'static str,
235 source_type: SourceType,
236 extra_features: &[String],
238 let mut cargo = builder.cargo(compiler, mode, source_type, target, command);
239 let dir = builder.src.join(path);
240 cargo.arg("--manifest-path").arg(dir.join("Cargo.toml"));
242 let mut features = extra_features.to_vec();
243 if builder.build.config.cargo_native_static {
244 if path.ends_with("cargo")
245 || path.ends_with("rls")
246 || path.ends_with("clippy")
247 || path.ends_with("miri")
248 || path.ends_with("rustfmt")
250 cargo.env("LIBZ_SYS_STATIC", "1");
251 features.push("rustc-workspace-hack/all-static".to_string());
255 // if tools are using lzma we want to force the build script to build its
257 cargo.env("LZMA_API_STATIC", "1");
259 // CFG_RELEASE is needed by rustfmt (and possibly other tools) which
260 // import rustc-ap-rustc_attr which requires this to be set for the
261 // `#[cfg(version(...))]` attribute.
262 cargo.env("CFG_RELEASE", builder.rust_release());
263 cargo.env("CFG_RELEASE_CHANNEL", &builder.config.channel);
264 cargo.env("CFG_VERSION", builder.rust_version());
265 cargo.env("CFG_RELEASE_NUM", &builder.version);
267 let info = GitInfo::new(builder.config.ignore_git, &dir);
268 if let Some(sha) = info.sha() {
269 cargo.env("CFG_COMMIT_HASH", sha);
271 if let Some(sha_short) = info.sha_short() {
272 cargo.env("CFG_SHORT_COMMIT_HASH", sha_short);
274 if let Some(date) = info.commit_date() {
275 cargo.env("CFG_COMMIT_DATE", date);
277 if !features.is_empty() {
278 cargo.arg("--features").arg(&features.join(", "));
283 macro_rules! bootstrap_tool {
285 $name:ident, $path:expr, $tool_name:expr
286 $(,is_external_tool = $external:expr)*
287 $(,is_unstable_tool = $unstable:expr)*
288 $(,features = $features:expr)*
291 #[derive(Copy, PartialEq, Eq, Clone)]
298 impl<'a> Builder<'a> {
299 pub fn tool_exe(&self, tool: Tool) -> PathBuf {
303 compiler: self.compiler(0, self.config.build),
304 target: self.config.build,
312 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
314 pub compiler: Compiler,
315 pub target: TargetSelection,
318 impl Step for $name {
319 type Output = PathBuf;
321 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
325 fn make_run(run: RunConfig<'_>) {
326 run.builder.ensure($name {
328 compiler: run.builder.compiler(0, run.builder.config.build),
333 fn run(self, builder: &Builder<'_>) -> PathBuf {
334 builder.ensure(ToolBuild {
335 compiler: self.compiler,
338 mode: if false $(|| $unstable)* {
339 // use in-tree libraries for unstable features
345 is_optional_tool: false,
346 source_type: if false $(|| $external)* {
347 SourceType::Submodule
352 // FIXME(#60643): avoid this lint by using `_`
353 let mut _tmp = Vec::new();
354 $(_tmp.extend($features);)*
357 }).expect("expected to build -- essential tool")
365 Rustbook, "src/tools/rustbook", "rustbook";
366 UnstableBookGen, "src/tools/unstable-book-gen", "unstable-book-gen";
367 Tidy, "src/tools/tidy", "tidy";
368 Linkchecker, "src/tools/linkchecker", "linkchecker";
369 CargoTest, "src/tools/cargotest", "cargotest";
370 Compiletest, "src/tools/compiletest", "compiletest", is_unstable_tool = true;
371 BuildManifest, "src/tools/build-manifest", "build-manifest";
372 RemoteTestClient, "src/tools/remote-test-client", "remote-test-client";
373 RustInstaller, "src/tools/rust-installer", "fabricate", is_external_tool = true;
374 RustdocTheme, "src/tools/rustdoc-themes", "rustdoc-themes";
375 ExpandYamlAnchors, "src/tools/expand-yaml-anchors", "expand-yaml-anchors";
376 LintDocs, "src/tools/lint-docs", "lint-docs";
377 JsonDocCk, "src/tools/jsondocck", "jsondocck";
380 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
381 pub struct ErrorIndex {
382 pub compiler: Compiler,
386 pub fn command(builder: &Builder<'_>) -> Command {
387 // This uses stage-1 to match the behavior of building rustdoc.
388 // Error-index-generator links with the rustdoc library, so we want to
389 // use the same librustdoc to avoid building rustdoc twice (and to
390 // avoid building the compiler an extra time). This uses
391 // saturating_sub to deal with building with stage 0. (Using stage 0
392 // isn't recommended, since it will fail if any new error index tests
393 // use new syntax, but it should work otherwise.)
394 let compiler = builder.compiler(builder.top_stage.saturating_sub(1), builder.config.build);
395 let mut cmd = Command::new(builder.ensure(ErrorIndex { compiler }));
398 PathBuf::from(&builder.sysroot_libdir(compiler, compiler.host)),
399 PathBuf::from(builder.rustc_libdir(compiler)),
407 impl Step for ErrorIndex {
408 type Output = PathBuf;
410 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
411 run.path("src/tools/error_index_generator")
414 fn make_run(run: RunConfig<'_>) {
415 // Compile the error-index in the same stage as rustdoc to avoid
416 // recompiling rustdoc twice if we can.
418 // NOTE: This `make_run` isn't used in normal situations, only if you
419 // manually build the tool with `x.py build
420 // src/tools/error-index-generator` which almost nobody does.
421 // Normally, `x.py test` or `x.py doc` will use the
422 // `ErrorIndex::command` function instead.
424 run.builder.compiler(run.builder.top_stage.saturating_sub(1), run.builder.config.build);
425 run.builder.ensure(ErrorIndex { compiler });
428 fn run(self, builder: &Builder<'_>) -> PathBuf {
431 compiler: self.compiler,
432 target: self.compiler.host,
433 tool: "error_index_generator",
434 mode: Mode::ToolRustc,
435 path: "src/tools/error_index_generator",
436 is_optional_tool: false,
437 source_type: SourceType::InTree,
438 extra_features: Vec::new(),
440 .expect("expected to build -- essential tool")
444 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
445 pub struct RemoteTestServer {
446 pub compiler: Compiler,
447 pub target: TargetSelection,
450 impl Step for RemoteTestServer {
451 type Output = PathBuf;
453 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
454 run.path("src/tools/remote-test-server")
457 fn make_run(run: RunConfig<'_>) {
458 run.builder.ensure(RemoteTestServer {
459 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
464 fn run(self, builder: &Builder<'_>) -> PathBuf {
467 compiler: self.compiler,
469 tool: "remote-test-server",
471 path: "src/tools/remote-test-server",
472 is_optional_tool: false,
473 source_type: SourceType::InTree,
474 extra_features: Vec::new(),
476 .expect("expected to build -- essential tool")
480 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
482 /// This should only ever be 0 or 2.
483 /// We sometimes want to reference the "bootstrap" rustdoc, which is why this option is here.
484 pub compiler: Compiler,
487 impl Step for Rustdoc {
488 type Output = PathBuf;
489 const DEFAULT: bool = true;
490 const ONLY_HOSTS: bool = true;
492 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
493 run.path("src/tools/rustdoc").path("src/librustdoc")
496 fn make_run(run: RunConfig<'_>) {
497 run.builder.ensure(Rustdoc {
498 // Note: this is somewhat unique in that we actually want a *target*
499 // compiler here, because rustdoc *is* a compiler. We won't be using
500 // this as the compiler to build with, but rather this is "what
501 // compiler are we producing"?
502 compiler: run.builder.compiler(run.builder.top_stage, run.target),
506 fn run(self, builder: &Builder<'_>) -> PathBuf {
507 let target_compiler = self.compiler;
508 if target_compiler.stage == 0 {
509 if !target_compiler.is_snapshot(builder) {
510 panic!("rustdoc in stage 0 must be snapshot rustdoc");
512 return builder.initial_rustc.with_file_name(exe("rustdoc", target_compiler.host));
514 let target = target_compiler.host;
515 // Similar to `compile::Assemble`, build with the previous stage's compiler. Otherwise
516 // we'd have stageN/bin/rustc and stageN/bin/rustdoc be effectively different stage
517 // compilers, which isn't what we want. Rustdoc should be linked in the same way as the
518 // rustc compiler it's paired with, so it must be built with the previous stage compiler.
519 let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
521 // When using `download-rustc` and a stage0 build_compiler, copying rustc doesn't actually
522 // build stage0 libstd (because the libstd in sysroot has the wrong ABI). Explicitly build
524 builder.ensure(compile::Std { compiler: build_compiler, target: target_compiler.host });
525 builder.ensure(compile::Rustc { compiler: build_compiler, target: target_compiler.host });
526 // NOTE: this implies that `download-rustc` is pretty useless when compiling with the stage0
527 // compiler, since you do just as much work.
528 if !builder.config.dry_run && builder.config.download_rustc && build_compiler.stage == 0 {
530 "warning: `download-rustc` does nothing when building stage1 tools; consider using `--stage 2` instead"
534 // The presence of `target_compiler` ensures that the necessary libraries (codegen backends,
535 // compiler libraries, ...) are built. Rustdoc does not require the presence of any
536 // libraries within sysroot_libdir (i.e., rustlib), though doctests may want it (since
537 // they'll be linked to those libraries). As such, don't explicitly `ensure` any additional
538 // libraries here. The intuition here is that If we've built a compiler, we should be able
541 let mut features = Vec::new();
542 if builder.config.jemalloc {
543 features.push("jemalloc".to_string());
546 let cargo = prepare_tool_cargo(
557 builder.info(&format!(
558 "Building rustdoc for stage{} ({})",
559 target_compiler.stage, target_compiler.host
561 builder.run(&mut cargo.into());
563 // Cargo adds a number of paths to the dylib search path on windows, which results in
564 // the wrong rustdoc being executed. To avoid the conflicting rustdocs, we name the "tool"
565 // rustdoc a different name.
566 let tool_rustdoc = builder
567 .cargo_out(build_compiler, Mode::ToolRustc, target)
568 .join(exe("rustdoc_tool_binary", target_compiler.host));
570 // don't create a stage0-sysroot/bin directory.
571 if target_compiler.stage > 0 {
572 let sysroot = builder.sysroot(target_compiler);
573 let bindir = sysroot.join("bin");
574 t!(fs::create_dir_all(&bindir));
575 let bin_rustdoc = bindir.join(exe("rustdoc", target_compiler.host));
576 let _ = fs::remove_file(&bin_rustdoc);
577 builder.copy(&tool_rustdoc, &bin_rustdoc);
585 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
587 pub compiler: Compiler,
588 pub target: TargetSelection,
591 impl Step for Cargo {
592 type Output = PathBuf;
593 const DEFAULT: bool = true;
594 const ONLY_HOSTS: bool = true;
596 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
597 let builder = run.builder;
598 run.path("src/tools/cargo").default_condition(
599 builder.config.extended
600 && builder.config.tools.as_ref().map_or(
602 // If `tools` is set, search list for this tool.
603 |tools| tools.iter().any(|tool| tool == "cargo"),
608 fn make_run(run: RunConfig<'_>) {
609 run.builder.ensure(Cargo {
610 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
615 fn run(self, builder: &Builder<'_>) -> PathBuf {
616 let cargo_bin_path = builder
618 compiler: self.compiler,
621 mode: Mode::ToolRustc,
622 path: "src/tools/cargo",
623 is_optional_tool: false,
624 source_type: SourceType::Submodule,
625 extra_features: Vec::new(),
627 .expect("expected to build -- essential tool");
629 let build_cred = |name, path| {
630 // These credential helpers are currently experimental.
631 // Any build failures will be ignored.
632 let _ = builder.ensure(ToolBuild {
633 compiler: self.compiler,
636 mode: Mode::ToolRustc,
638 is_optional_tool: true,
639 source_type: SourceType::Submodule,
640 extra_features: Vec::new(),
644 if self.target.contains("windows") {
646 "cargo-credential-wincred",
647 "src/tools/cargo/crates/credential/cargo-credential-wincred",
650 if self.target.contains("apple-darwin") {
652 "cargo-credential-macos-keychain",
653 "src/tools/cargo/crates/credential/cargo-credential-macos-keychain",
657 "cargo-credential-1password",
658 "src/tools/cargo/crates/credential/cargo-credential-1password",
664 macro_rules! tool_extended {
665 (($sel:ident, $builder:ident),
670 stable = $stable:expr,
671 $(in_tree = $in_tree:expr,)*
672 $extra_deps:block;)+) => {
674 #[derive(Debug, Clone, Hash, PartialEq, Eq)]
676 pub compiler: Compiler,
677 pub target: TargetSelection,
678 pub extra_features: Vec<String>,
681 impl Step for $name {
682 type Output = Option<PathBuf>;
683 const DEFAULT: bool = true; // Overwritten below
684 const ONLY_HOSTS: bool = true;
686 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
687 let builder = run.builder;
688 run.path($path).default_condition(
689 builder.config.extended
690 && builder.config.tools.as_ref().map_or(
691 // By default, on nightly/dev enable all tools, else only
692 // build stable tools.
693 $stable || builder.build.unstable_features(),
694 // If `tools` is set, search list for this tool.
696 tools.iter().any(|tool| match tool.as_ref() {
697 "clippy" => $tool_name == "clippy-driver",
698 x => $tool_name == x,
704 fn make_run(run: RunConfig<'_>) {
705 run.builder.ensure($name {
706 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
708 extra_features: Vec::new(),
713 fn run(mut $sel, $builder: &Builder<'_>) -> Option<PathBuf> {
715 $builder.ensure(ToolBuild {
716 compiler: $sel.compiler,
719 mode: Mode::ToolRustc,
721 extra_features: $sel.extra_features,
722 is_optional_tool: true,
723 source_type: if false $(|| $in_tree)* {
726 SourceType::Submodule
735 // Note: tools need to be also added to `Builder::get_step_descriptions` in `builder.rs`
736 // to make `./x.py build <tool>` work.
737 tool_extended!((self, builder),
738 Cargofmt, rustfmt, "src/tools/rustfmt", "cargo-fmt", stable=true, in_tree=true, {};
739 CargoClippy, clippy, "src/tools/clippy", "cargo-clippy", stable=true, in_tree=true, {};
740 Clippy, clippy, "src/tools/clippy", "clippy-driver", stable=true, in_tree=true, {};
741 Miri, miri, "src/tools/miri", "miri", stable=false, {};
742 CargoMiri, miri, "src/tools/miri/cargo-miri", "cargo-miri", stable=false, {};
743 Rls, rls, "src/tools/rls", "rls", stable=true, {
744 builder.ensure(Clippy {
745 compiler: self.compiler,
747 extra_features: Vec::new(),
749 self.extra_features.push("clippy".to_owned());
751 RustDemangler, rust_demangler, "src/tools/rust-demangler", "rust-demangler", stable=false, in_tree=true, {};
752 Rustfmt, rustfmt, "src/tools/rustfmt", "rustfmt", stable=true, in_tree=true, {};
753 RustAnalyzer, rust_analyzer, "src/tools/rust-analyzer/crates/rust-analyzer", "rust-analyzer", stable=false, {};
756 impl<'a> Builder<'a> {
757 /// Gets a `Command` which is ready to run `tool` in `stage` built for
759 pub fn tool_cmd(&self, tool: Tool) -> Command {
760 let mut cmd = Command::new(self.tool_exe(tool));
761 let compiler = self.compiler(0, self.config.build);
762 let host = &compiler.host;
763 // Prepares the `cmd` provided to be able to run the `compiler` provided.
765 // Notably this munges the dynamic library lookup path to point to the
766 // right location to run `compiler`.
767 let mut lib_paths: Vec<PathBuf> = vec![
768 self.build.rustc_snapshot_libdir(),
769 self.cargo_out(compiler, Mode::ToolBootstrap, *host).join("deps"),
772 // On MSVC a tool may invoke a C compiler (e.g., compiletest in run-make
773 // mode) and that C compiler may need some extra PATH modification. Do
775 if compiler.host.contains("msvc") {
776 let curpaths = env::var_os("PATH").unwrap_or_default();
777 let curpaths = env::split_paths(&curpaths).collect::<Vec<_>>();
778 for &(ref k, ref v) in self.cc[&compiler.host].env() {
782 for path in env::split_paths(v) {
783 if !curpaths.contains(&path) {
784 lib_paths.push(path);
790 add_dylib_path(lib_paths, &mut cmd);
792 // Provide a RUSTC for this command to use.
793 cmd.env("RUSTC", &self.initial_rustc);