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;
55 Mode::ToolRustc => builder.ensure(compile::Rustc { compiler, target }),
56 Mode::ToolStd => builder.ensure(compile::Std { compiler, target }),
57 Mode::ToolBootstrap => {} // uses downloaded stage0 compiler libs
58 _ => panic!("unexpected Mode for tool build"),
61 let cargo = prepare_tool_cargo(
72 builder.info(&format!("Building stage{} tool {} ({})", compiler.stage, tool, target));
73 let mut duplicates = Vec::new();
74 let is_expected = compile::stream_cargo(builder, cargo, vec![], &mut |msg| {
75 // Only care about big things like the RLS/Cargo for now
77 "rls" | "cargo" | "clippy-driver" | "miri" | "rustfmt" => {}
81 let (id, features, filenames) = match msg {
82 compile::CargoMessage::CompilerArtifact {
87 } => (package_id, features, filenames),
90 let features = features.iter().map(|s| s.to_string()).collect::<Vec<_>>();
92 for path in filenames {
93 let val = (tool, PathBuf::from(&*path), features.clone());
94 // we're only interested in deduplicating rlibs for now
95 if val.1.extension().and_then(|s| s.to_str()) != Some("rlib") {
99 // Don't worry about compiles that turn out to be host
100 // dependencies or build scripts. To skip these we look for
101 // anything that goes in `.../release/deps` but *doesn't* go in
102 // `$target/release/deps`. This ensure that outputs in
103 // `$target/release` are still considered candidates for
105 if let Some(parent) = val.1.parent() {
106 if parent.ends_with("release/deps") {
107 let maybe_target = parent
109 .and_then(|p| p.parent())
110 .and_then(|p| p.file_name())
111 .and_then(|p| p.to_str())
113 if maybe_target != &*target.triple {
119 // Record that we've built an artifact for `id`, and if one was
120 // already listed then we need to see if we reused the same
121 // artifact or produced a duplicate.
122 let mut artifacts = builder.tool_artifacts.borrow_mut();
123 let prev_artifacts = artifacts.entry(target).or_default();
124 let prev = match prev_artifacts.get(&*id) {
127 prev_artifacts.insert(id.to_string(), val);
132 return; // same path, same artifact
135 // If the paths are different and one of them *isn't* inside of
136 // `release/deps`, then it means it's probably in
137 // `$target/release`, or it's some final artifact like
138 // `libcargo.rlib`. In these situations Cargo probably just
139 // copied it up from `$target/release/deps/libcargo-xxxx.rlib`,
140 // so if the features are equal we can just skip it.
141 let prev_no_hash = prev.1.parent().unwrap().ends_with("release/deps");
142 let val_no_hash = val.1.parent().unwrap().ends_with("release/deps");
143 if prev.2 == val.2 || !prev_no_hash || !val_no_hash {
147 // ... and otherwise this looks like we duplicated some sort of
148 // compilation, so record it to generate an error later.
149 duplicates.push((id.to_string(), val, prev.clone()));
153 if is_expected && !duplicates.is_empty() {
155 "duplicate artifacts found when compiling a tool, this \
156 typically means that something was recompiled because \
157 a transitive dependency has different features activated \
158 than in a previous build:\n"
161 "the following dependencies are duplicated although they \
162 have the same features enabled:"
164 let (same, different): (Vec<_>, Vec<_>) =
165 duplicates.into_iter().partition(|(_, cur, prev)| cur.2 == prev.2);
166 for (id, cur, prev) in same {
169 println!(" `{}` ({:?})\n `{}` ({:?})", cur.0, cur.1, prev.0, prev.1);
171 println!("the following dependencies have different features:");
172 for (id, cur, prev) in different {
174 let cur_features: HashSet<_> = cur.2.into_iter().collect();
175 let prev_features: HashSet<_> = prev.2.into_iter().collect();
177 " `{}` additionally enabled features {:?} at {:?}",
179 &cur_features - &prev_features,
183 " `{}` additionally enabled features {:?} at {:?}",
185 &prev_features - &cur_features,
191 "to fix this you will probably want to edit the local \
192 src/tools/rustc-workspace-hack/Cargo.toml crate, as \
193 that will update the dependency graph to ensure that \
194 these crates all share the same feature set"
196 panic!("tools should not compile multiple copies of the same crate");
199 builder.save_toolstate(
201 if is_expected { ToolState::TestFail } else { ToolState::BuildFail },
205 if !is_optional_tool {
211 // HACK(#82501): on Windows, the tools directory gets added to PATH when running tests, and
212 // compiletest confuses HTML tidy with the in-tree tidy. Name the in-tree tidy something
213 // different so the problem doesn't come up.
218 builder.cargo_out(compiler, self.mode, target).join(exe(tool, compiler.host));
219 let bin = builder.tools_dir(compiler).join(exe(tool, compiler.host));
220 builder.copy(&cargo_out, &bin);
226 pub fn prepare_tool_cargo(
227 builder: &Builder<'_>,
230 target: TargetSelection,
231 command: &'static str,
233 source_type: SourceType,
234 extra_features: &[String],
236 let mut cargo = builder.cargo(compiler, mode, source_type, target, command);
237 let dir = builder.src.join(path);
238 cargo.arg("--manifest-path").arg(dir.join("Cargo.toml"));
240 let mut features = extra_features.to_vec();
241 if builder.build.config.cargo_native_static {
242 if path.ends_with("cargo")
243 || path.ends_with("rls")
244 || path.ends_with("clippy")
245 || path.ends_with("miri")
246 || path.ends_with("rustfmt")
248 cargo.env("LIBZ_SYS_STATIC", "1");
249 features.push("rustc-workspace-hack/all-static".to_string());
253 // if tools are using lzma we want to force the build script to build its
255 cargo.env("LZMA_API_STATIC", "1");
257 // CFG_RELEASE is needed by rustfmt (and possibly other tools) which
258 // import rustc-ap-rustc_attr which requires this to be set for the
259 // `#[cfg(version(...))]` attribute.
260 cargo.env("CFG_RELEASE", builder.rust_release());
261 cargo.env("CFG_RELEASE_CHANNEL", &builder.config.channel);
262 cargo.env("CFG_VERSION", builder.rust_version());
263 cargo.env("CFG_RELEASE_NUM", &builder.version);
265 let info = GitInfo::new(builder.config.ignore_git, &dir);
266 if let Some(sha) = info.sha() {
267 cargo.env("CFG_COMMIT_HASH", sha);
269 if let Some(sha_short) = info.sha_short() {
270 cargo.env("CFG_SHORT_COMMIT_HASH", sha_short);
272 if let Some(date) = info.commit_date() {
273 cargo.env("CFG_COMMIT_DATE", date);
275 if !features.is_empty() {
276 cargo.arg("--features").arg(&features.join(", "));
281 macro_rules! bootstrap_tool {
283 $name:ident, $path:expr, $tool_name:expr
284 $(,is_external_tool = $external:expr)*
285 $(,is_unstable_tool = $unstable:expr)*
286 $(,features = $features:expr)*
289 #[derive(Copy, PartialEq, Eq, Clone)]
296 impl<'a> Builder<'a> {
297 pub fn tool_exe(&self, tool: Tool) -> PathBuf {
301 compiler: self.compiler(0, self.config.build),
302 target: self.config.build,
310 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
312 pub compiler: Compiler,
313 pub target: TargetSelection,
316 impl Step for $name {
317 type Output = PathBuf;
319 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
323 fn make_run(run: RunConfig<'_>) {
324 run.builder.ensure($name {
326 compiler: run.builder.compiler(0, run.builder.config.build),
331 fn run(self, builder: &Builder<'_>) -> PathBuf {
332 builder.ensure(ToolBuild {
333 compiler: self.compiler,
336 mode: if false $(|| $unstable)* {
337 // use in-tree libraries for unstable features
343 is_optional_tool: false,
344 source_type: if false $(|| $external)* {
345 SourceType::Submodule
350 // FIXME(#60643): avoid this lint by using `_`
351 let mut _tmp = Vec::new();
352 $(_tmp.extend($features);)*
355 }).expect("expected to build -- essential tool")
363 Rustbook, "src/tools/rustbook", "rustbook";
364 UnstableBookGen, "src/tools/unstable-book-gen", "unstable-book-gen";
365 Tidy, "src/tools/tidy", "tidy";
366 Linkchecker, "src/tools/linkchecker", "linkchecker";
367 CargoTest, "src/tools/cargotest", "cargotest";
368 Compiletest, "src/tools/compiletest", "compiletest", is_unstable_tool = true;
369 BuildManifest, "src/tools/build-manifest", "build-manifest";
370 RemoteTestClient, "src/tools/remote-test-client", "remote-test-client";
371 RustInstaller, "src/tools/rust-installer", "fabricate", is_external_tool = true;
372 RustdocTheme, "src/tools/rustdoc-themes", "rustdoc-themes";
373 ExpandYamlAnchors, "src/tools/expand-yaml-anchors", "expand-yaml-anchors";
374 LintDocs, "src/tools/lint-docs", "lint-docs";
375 JsonDocCk, "src/tools/jsondocck", "jsondocck";
378 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
379 pub struct ErrorIndex {
380 pub compiler: Compiler,
384 pub fn command(builder: &Builder<'_>) -> Command {
385 // This uses stage-1 to match the behavior of building rustdoc.
386 // Error-index-generator links with the rustdoc library, so we want to
387 // use the same librustdoc to avoid building rustdoc twice (and to
388 // avoid building the compiler an extra time). This uses
389 // saturating_sub to deal with building with stage 0. (Using stage 0
390 // isn't recommended, since it will fail if any new error index tests
391 // use new syntax, but it should work otherwise.)
392 let compiler = builder.compiler(builder.top_stage.saturating_sub(1), builder.config.build);
393 let mut cmd = Command::new(builder.ensure(ErrorIndex { compiler }));
395 vec![PathBuf::from(&builder.sysroot_libdir(compiler, compiler.host))],
402 impl Step for ErrorIndex {
403 type Output = PathBuf;
405 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
406 run.path("src/tools/error_index_generator")
409 fn make_run(run: RunConfig<'_>) {
410 // Compile the error-index in the same stage as rustdoc to avoid
411 // recompiling rustdoc twice if we can.
413 // NOTE: This `make_run` isn't used in normal situations, only if you
414 // manually build the tool with `x.py build
415 // src/tools/error-index-generator` which almost nobody does.
416 // Normally, `x.py test` or `x.py doc` will use the
417 // `ErrorIndex::command` function instead.
419 run.builder.compiler(run.builder.top_stage.saturating_sub(1), run.builder.config.build);
420 run.builder.ensure(ErrorIndex { compiler });
423 fn run(self, builder: &Builder<'_>) -> PathBuf {
426 compiler: self.compiler,
427 target: self.compiler.host,
428 tool: "error_index_generator",
429 mode: Mode::ToolRustc,
430 path: "src/tools/error_index_generator",
431 is_optional_tool: false,
432 source_type: SourceType::InTree,
433 extra_features: Vec::new(),
435 .expect("expected to build -- essential tool")
439 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
440 pub struct RemoteTestServer {
441 pub compiler: Compiler,
442 pub target: TargetSelection,
445 impl Step for RemoteTestServer {
446 type Output = PathBuf;
448 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
449 run.path("src/tools/remote-test-server")
452 fn make_run(run: RunConfig<'_>) {
453 run.builder.ensure(RemoteTestServer {
454 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
459 fn run(self, builder: &Builder<'_>) -> PathBuf {
462 compiler: self.compiler,
464 tool: "remote-test-server",
466 path: "src/tools/remote-test-server",
467 is_optional_tool: false,
468 source_type: SourceType::InTree,
469 extra_features: Vec::new(),
471 .expect("expected to build -- essential tool")
475 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
477 /// This should only ever be 0 or 2.
478 /// We sometimes want to reference the "bootstrap" rustdoc, which is why this option is here.
479 pub compiler: Compiler,
482 impl Step for Rustdoc {
483 type Output = PathBuf;
484 const DEFAULT: bool = true;
485 const ONLY_HOSTS: bool = true;
487 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
488 run.path("src/tools/rustdoc").path("src/librustdoc")
491 fn make_run(run: RunConfig<'_>) {
492 run.builder.ensure(Rustdoc {
493 // Note: this is somewhat unique in that we actually want a *target*
494 // compiler here, because rustdoc *is* a compiler. We won't be using
495 // this as the compiler to build with, but rather this is "what
496 // compiler are we producing"?
497 compiler: run.builder.compiler(run.builder.top_stage, run.target),
501 fn run(self, builder: &Builder<'_>) -> PathBuf {
502 let target_compiler = self.compiler;
503 if target_compiler.stage == 0 {
504 if !target_compiler.is_snapshot(builder) {
505 panic!("rustdoc in stage 0 must be snapshot rustdoc");
507 return builder.initial_rustc.with_file_name(exe("rustdoc", target_compiler.host));
509 let target = target_compiler.host;
510 // Similar to `compile::Assemble`, build with the previous stage's compiler. Otherwise
511 // we'd have stageN/bin/rustc and stageN/bin/rustdoc be effectively different stage
512 // compilers, which isn't what we want. Rustdoc should be linked in the same way as the
513 // rustc compiler it's paired with, so it must be built with the previous stage compiler.
514 let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
516 // When using `download-rustc` and a stage0 build_compiler, copying rustc doesn't actually
517 // build stage0 libstd (because the libstd in sysroot has the wrong ABI). Explicitly build
519 builder.ensure(compile::Std { compiler: build_compiler, target: target_compiler.host });
520 builder.ensure(compile::Rustc { compiler: build_compiler, target: target_compiler.host });
521 // NOTE: this implies that `download-rustc` is pretty useless when compiling with the stage0
522 // compiler, since you do just as much work.
523 if !builder.config.dry_run && builder.config.download_rustc && build_compiler.stage == 0 {
525 "warning: `download-rustc` does nothing when building stage1 tools; consider using `--stage 2` instead"
529 // The presence of `target_compiler` ensures that the necessary libraries (codegen backends,
530 // compiler libraries, ...) are built. Rustdoc does not require the presence of any
531 // libraries within sysroot_libdir (i.e., rustlib), though doctests may want it (since
532 // they'll be linked to those libraries). As such, don't explicitly `ensure` any additional
533 // libraries here. The intuition here is that If we've built a compiler, we should be able
536 let cargo = prepare_tool_cargo(
547 builder.info(&format!(
548 "Building rustdoc for stage{} ({})",
549 target_compiler.stage, target_compiler.host
551 builder.run(&mut cargo.into());
553 // Cargo adds a number of paths to the dylib search path on windows, which results in
554 // the wrong rustdoc being executed. To avoid the conflicting rustdocs, we name the "tool"
555 // rustdoc a different name.
556 let tool_rustdoc = builder
557 .cargo_out(build_compiler, Mode::ToolRustc, target)
558 .join(exe("rustdoc_tool_binary", target_compiler.host));
560 // don't create a stage0-sysroot/bin directory.
561 if target_compiler.stage > 0 {
562 let sysroot = builder.sysroot(target_compiler);
563 let bindir = sysroot.join("bin");
564 t!(fs::create_dir_all(&bindir));
565 let bin_rustdoc = bindir.join(exe("rustdoc", target_compiler.host));
566 let _ = fs::remove_file(&bin_rustdoc);
567 builder.copy(&tool_rustdoc, &bin_rustdoc);
575 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
577 pub compiler: Compiler,
578 pub target: TargetSelection,
581 impl Step for Cargo {
582 type Output = PathBuf;
583 const DEFAULT: bool = true;
584 const ONLY_HOSTS: bool = true;
586 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
587 let builder = run.builder;
588 run.path("src/tools/cargo").default_condition(builder.config.extended)
591 fn make_run(run: RunConfig<'_>) {
592 run.builder.ensure(Cargo {
593 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
598 fn run(self, builder: &Builder<'_>) -> PathBuf {
599 let cargo_bin_path = builder
601 compiler: self.compiler,
604 mode: Mode::ToolRustc,
605 path: "src/tools/cargo",
606 is_optional_tool: false,
607 source_type: SourceType::Submodule,
608 extra_features: Vec::new(),
610 .expect("expected to build -- essential tool");
612 let build_cred = |name, path| {
613 // These credential helpers are currently experimental.
614 // Any build failures will be ignored.
615 let _ = builder.ensure(ToolBuild {
616 compiler: self.compiler,
619 mode: Mode::ToolRustc,
621 is_optional_tool: true,
622 source_type: SourceType::Submodule,
623 extra_features: Vec::new(),
627 if self.target.contains("windows") {
629 "cargo-credential-wincred",
630 "src/tools/cargo/crates/credential/cargo-credential-wincred",
633 if self.target.contains("apple-darwin") {
635 "cargo-credential-macos-keychain",
636 "src/tools/cargo/crates/credential/cargo-credential-macos-keychain",
640 "cargo-credential-1password",
641 "src/tools/cargo/crates/credential/cargo-credential-1password",
647 macro_rules! tool_extended {
648 (($sel:ident, $builder:ident),
653 stable = $stable:expr,
654 $(in_tree = $in_tree:expr,)*
655 $extra_deps:block;)+) => {
657 #[derive(Debug, Clone, Hash, PartialEq, Eq)]
659 pub compiler: Compiler,
660 pub target: TargetSelection,
661 pub extra_features: Vec<String>,
664 impl Step for $name {
665 type Output = Option<PathBuf>;
666 const DEFAULT: bool = true; // Overwritten below
667 const ONLY_HOSTS: bool = true;
669 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
670 let builder = run.builder;
671 run.path($path).default_condition(
672 builder.config.extended
673 && builder.config.tools.as_ref().map_or(
674 // By default, on nightly/dev enable all tools, else only
675 // build stable tools.
676 $stable || builder.build.unstable_features(),
677 // If `tools` is set, search list for this tool.
679 tools.iter().any(|tool| match tool.as_ref() {
680 "clippy" => $tool_name == "clippy-driver",
681 x => $tool_name == x,
687 fn make_run(run: RunConfig<'_>) {
688 run.builder.ensure($name {
689 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
691 extra_features: Vec::new(),
696 fn run(mut $sel, $builder: &Builder<'_>) -> Option<PathBuf> {
698 $builder.ensure(ToolBuild {
699 compiler: $sel.compiler,
702 mode: Mode::ToolRustc,
704 extra_features: $sel.extra_features,
705 is_optional_tool: true,
706 source_type: if false $(|| $in_tree)* {
709 SourceType::Submodule
718 // Note: tools need to be also added to `Builder::get_step_descriptions` in `builder.rs`
719 // to make `./x.py build <tool>` work.
720 tool_extended!((self, builder),
721 Cargofmt, rustfmt, "src/tools/rustfmt", "cargo-fmt", stable=true, {};
722 CargoClippy, clippy, "src/tools/clippy", "cargo-clippy", stable=true, in_tree=true, {};
723 Clippy, clippy, "src/tools/clippy", "clippy-driver", stable=true, in_tree=true, {};
724 Miri, miri, "src/tools/miri", "miri", stable=false, {};
725 CargoMiri, miri, "src/tools/miri/cargo-miri", "cargo-miri", stable=false, {};
726 Rls, rls, "src/tools/rls", "rls", stable=true, {
727 builder.ensure(Clippy {
728 compiler: self.compiler,
730 extra_features: Vec::new(),
732 self.extra_features.push("clippy".to_owned());
734 RustDemangler, rust_demangler, "src/tools/rust-demangler", "rust-demangler", stable=false, in_tree=true, {};
735 Rustfmt, rustfmt, "src/tools/rustfmt", "rustfmt", stable=true, {};
736 RustAnalyzer, rust_analyzer, "src/tools/rust-analyzer/crates/rust-analyzer", "rust-analyzer", stable=false, {};
739 impl<'a> Builder<'a> {
740 /// Gets a `Command` which is ready to run `tool` in `stage` built for
742 pub fn tool_cmd(&self, tool: Tool) -> Command {
743 let mut cmd = Command::new(self.tool_exe(tool));
744 let compiler = self.compiler(0, self.config.build);
745 let host = &compiler.host;
746 // Prepares the `cmd` provided to be able to run the `compiler` provided.
748 // Notably this munges the dynamic library lookup path to point to the
749 // right location to run `compiler`.
750 let mut lib_paths: Vec<PathBuf> = vec![
751 self.build.rustc_snapshot_libdir(),
752 self.cargo_out(compiler, Mode::ToolBootstrap, *host).join("deps"),
755 // On MSVC a tool may invoke a C compiler (e.g., compiletest in run-make
756 // mode) and that C compiler may need some extra PATH modification. Do
758 if compiler.host.contains("msvc") {
759 let curpaths = env::var_os("PATH").unwrap_or_default();
760 let curpaths = env::split_paths(&curpaths).collect::<Vec<_>>();
761 for &(ref k, ref v) in self.cc[&compiler.host].env() {
765 for path in env::split_paths(v) {
766 if !curpaths.contains(&path) {
767 lib_paths.push(path);
773 add_dylib_path(lib_paths, &mut cmd);
775 // Provide a RUSTC for this command to use.
776 cmd.env("RUSTC", &self.initial_rustc);