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;
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 {
212 builder.cargo_out(compiler, self.mode, target).join(exe(tool, compiler.host));
213 let bin = builder.tools_dir(compiler).join(exe(tool, compiler.host));
214 builder.copy(&cargo_out, &bin);
220 pub fn prepare_tool_cargo(
221 builder: &Builder<'_>,
224 target: TargetSelection,
225 command: &'static str,
227 source_type: SourceType,
228 extra_features: &[String],
230 let mut cargo = builder.cargo(compiler, mode, source_type, target, command);
231 let dir = builder.src.join(path);
232 cargo.arg("--manifest-path").arg(dir.join("Cargo.toml"));
234 let mut features = extra_features.to_vec();
235 if builder.build.config.cargo_native_static {
236 if path.ends_with("cargo")
237 || path.ends_with("rls")
238 || path.ends_with("clippy")
239 || path.ends_with("miri")
240 || path.ends_with("rustfmt")
242 cargo.env("LIBZ_SYS_STATIC", "1");
243 features.push("rustc-workspace-hack/all-static".to_string());
247 // if tools are using lzma we want to force the build script to build its
249 cargo.env("LZMA_API_STATIC", "1");
251 // CFG_RELEASE is needed by rustfmt (and possibly other tools) which
252 // import rustc-ap-rustc_attr which requires this to be set for the
253 // `#[cfg(version(...))]` attribute.
254 cargo.env("CFG_RELEASE", builder.rust_release());
255 cargo.env("CFG_RELEASE_CHANNEL", &builder.config.channel);
256 cargo.env("CFG_VERSION", builder.rust_version());
257 cargo.env("CFG_RELEASE_NUM", &builder.version);
259 let info = GitInfo::new(builder.config.ignore_git, &dir);
260 if let Some(sha) = info.sha() {
261 cargo.env("CFG_COMMIT_HASH", sha);
263 if let Some(sha_short) = info.sha_short() {
264 cargo.env("CFG_SHORT_COMMIT_HASH", sha_short);
266 if let Some(date) = info.commit_date() {
267 cargo.env("CFG_COMMIT_DATE", date);
269 if !features.is_empty() {
270 cargo.arg("--features").arg(&features.join(", "));
275 macro_rules! bootstrap_tool {
277 $name:ident, $path:expr, $tool_name:expr
278 $(,is_external_tool = $external:expr)*
279 $(,is_unstable_tool = $unstable:expr)*
280 $(,features = $features:expr)*
283 #[derive(Copy, PartialEq, Eq, Clone)]
290 impl<'a> Builder<'a> {
291 pub fn tool_exe(&self, tool: Tool) -> PathBuf {
295 compiler: self.compiler(0, self.config.build),
296 target: self.config.build,
304 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
306 pub compiler: Compiler,
307 pub target: TargetSelection,
310 impl Step for $name {
311 type Output = PathBuf;
313 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
317 fn make_run(run: RunConfig<'_>) {
318 run.builder.ensure($name {
320 compiler: run.builder.compiler(0, run.builder.config.build),
325 fn run(self, builder: &Builder<'_>) -> PathBuf {
326 builder.ensure(ToolBuild {
327 compiler: self.compiler,
330 mode: if false $(|| $unstable)* {
331 // use in-tree libraries for unstable features
337 is_optional_tool: false,
338 source_type: if false $(|| $external)* {
339 SourceType::Submodule
344 // FIXME(#60643): avoid this lint by using `_`
345 let mut _tmp = Vec::new();
346 $(_tmp.extend($features);)*
349 }).expect("expected to build -- essential tool")
357 Rustbook, "src/tools/rustbook", "rustbook";
358 UnstableBookGen, "src/tools/unstable-book-gen", "unstable-book-gen";
359 Tidy, "src/tools/tidy", "tidy";
360 Linkchecker, "src/tools/linkchecker", "linkchecker";
361 CargoTest, "src/tools/cargotest", "cargotest";
362 Compiletest, "src/tools/compiletest", "compiletest", is_unstable_tool = true;
363 BuildManifest, "src/tools/build-manifest", "build-manifest";
364 RemoteTestClient, "src/tools/remote-test-client", "remote-test-client";
365 RustDemangler, "src/tools/rust-demangler", "rust-demangler";
366 RustInstaller, "src/tools/rust-installer", "fabricate", is_external_tool = true;
367 RustdocTheme, "src/tools/rustdoc-themes", "rustdoc-themes";
368 ExpandYamlAnchors, "src/tools/expand-yaml-anchors", "expand-yaml-anchors";
369 LintDocs, "src/tools/lint-docs", "lint-docs";
370 JsonDocCk, "src/tools/jsondocck", "jsondocck";
373 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
374 pub struct ErrorIndex {
375 pub compiler: Compiler,
379 pub fn command(builder: &Builder<'_>) -> Command {
380 // This uses stage-1 to match the behavior of building rustdoc.
381 // Error-index-generator links with the rustdoc library, so we want to
382 // use the same librustdoc to avoid building rustdoc twice (and to
383 // avoid building the compiler an extra time). This uses
384 // saturating_sub to deal with building with stage 0. (Using stage 0
385 // isn't recommended, since it will fail if any new error index tests
386 // use new syntax, but it should work otherwise.)
387 let compiler = builder.compiler(builder.top_stage.saturating_sub(1), builder.config.build);
388 let mut cmd = Command::new(builder.ensure(ErrorIndex { compiler }));
390 vec![PathBuf::from(&builder.sysroot_libdir(compiler, compiler.host))],
397 impl Step for ErrorIndex {
398 type Output = PathBuf;
400 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
401 run.path("src/tools/error_index_generator")
404 fn make_run(run: RunConfig<'_>) {
405 // Compile the error-index in the same stage as rustdoc to avoid
406 // recompiling rustdoc twice if we can.
408 // NOTE: This `make_run` isn't used in normal situations, only if you
409 // manually build the tool with `x.py build
410 // src/tools/error-index-generator` which almost nobody does.
411 // Normally, `x.py test` or `x.py doc` will use the
412 // `ErrorIndex::command` function instead.
414 run.builder.compiler(run.builder.top_stage.saturating_sub(1), run.builder.config.build);
415 run.builder.ensure(ErrorIndex { compiler });
418 fn run(self, builder: &Builder<'_>) -> PathBuf {
421 compiler: self.compiler,
422 target: self.compiler.host,
423 tool: "error_index_generator",
424 mode: Mode::ToolRustc,
425 path: "src/tools/error_index_generator",
426 is_optional_tool: false,
427 source_type: SourceType::InTree,
428 extra_features: Vec::new(),
430 .expect("expected to build -- essential tool")
434 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
435 pub struct RemoteTestServer {
436 pub compiler: Compiler,
437 pub target: TargetSelection,
440 impl Step for RemoteTestServer {
441 type Output = PathBuf;
443 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
444 run.path("src/tools/remote-test-server")
447 fn make_run(run: RunConfig<'_>) {
448 run.builder.ensure(RemoteTestServer {
449 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
454 fn run(self, builder: &Builder<'_>) -> PathBuf {
457 compiler: self.compiler,
459 tool: "remote-test-server",
461 path: "src/tools/remote-test-server",
462 is_optional_tool: false,
463 source_type: SourceType::InTree,
464 extra_features: Vec::new(),
466 .expect("expected to build -- essential tool")
470 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
472 /// This should only ever be 0 or 2.
473 /// We sometimes want to reference the "bootstrap" rustdoc, which is why this option is here.
474 pub compiler: Compiler,
477 impl Step for Rustdoc {
478 type Output = PathBuf;
479 const DEFAULT: bool = true;
480 const ENABLE_DOWNLOAD_RUSTC: bool = true;
481 const ONLY_HOSTS: bool = true;
483 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
484 run.path("src/tools/rustdoc").path("src/librustdoc")
487 fn make_run(run: RunConfig<'_>) {
488 run.builder.ensure(Rustdoc {
489 // Note: this is somewhat unique in that we actually want a *target*
490 // compiler here, because rustdoc *is* a compiler. We won't be using
491 // this as the compiler to build with, but rather this is "what
492 // compiler are we producing"?
493 compiler: run.builder.compiler(run.builder.top_stage, run.target),
497 fn run(self, builder: &Builder<'_>) -> PathBuf {
498 let target_compiler = self.compiler;
499 if target_compiler.stage == 0 {
500 if !target_compiler.is_snapshot(builder) {
501 panic!("rustdoc in stage 0 must be snapshot rustdoc");
503 return builder.initial_rustc.with_file_name(exe("rustdoc", target_compiler.host));
505 let target = target_compiler.host;
506 // Similar to `compile::Assemble`, build with the previous stage's compiler. Otherwise
507 // we'd have stageN/bin/rustc and stageN/bin/rustdoc be effectively different stage
508 // compilers, which isn't what we want. Rustdoc should be linked in the same way as the
509 // rustc compiler it's paired with, so it must be built with the previous stage compiler.
510 let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
512 // The presence of `target_compiler` ensures that the necessary libraries (codegen backends,
513 // compiler libraries, ...) are built. Rustdoc does not require the presence of any
514 // libraries within sysroot_libdir (i.e., rustlib), though doctests may want it (since
515 // they'll be linked to those libraries). As such, don't explicitly `ensure` any additional
516 // libraries here. The intuition here is that If we've built a compiler, we should be able
519 let cargo = prepare_tool_cargo(
530 builder.info(&format!(
531 "Building rustdoc for stage{} ({})",
532 target_compiler.stage, target_compiler.host
534 builder.run(&mut cargo.into());
536 // Cargo adds a number of paths to the dylib search path on windows, which results in
537 // the wrong rustdoc being executed. To avoid the conflicting rustdocs, we name the "tool"
538 // rustdoc a different name.
539 let tool_rustdoc = builder
540 .cargo_out(build_compiler, Mode::ToolRustc, target)
541 .join(exe("rustdoc_tool_binary", target_compiler.host));
543 // don't create a stage0-sysroot/bin directory.
544 if target_compiler.stage > 0 {
545 let sysroot = builder.sysroot(target_compiler);
546 let bindir = sysroot.join("bin");
547 t!(fs::create_dir_all(&bindir));
548 let bin_rustdoc = bindir.join(exe("rustdoc", target_compiler.host));
549 let _ = fs::remove_file(&bin_rustdoc);
550 builder.copy(&tool_rustdoc, &bin_rustdoc);
558 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
560 pub compiler: Compiler,
561 pub target: TargetSelection,
564 impl Step for Cargo {
565 type Output = PathBuf;
566 const DEFAULT: bool = true;
567 const ONLY_HOSTS: bool = true;
569 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
570 let builder = run.builder;
571 run.path("src/tools/cargo").default_condition(builder.config.extended)
574 fn make_run(run: RunConfig<'_>) {
575 run.builder.ensure(Cargo {
576 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
581 fn run(self, builder: &Builder<'_>) -> PathBuf {
582 let cargo_bin_path = builder
584 compiler: self.compiler,
587 mode: Mode::ToolRustc,
588 path: "src/tools/cargo",
589 is_optional_tool: false,
590 source_type: SourceType::Submodule,
591 extra_features: Vec::new(),
593 .expect("expected to build -- essential tool");
595 let build_cred = |name, path| {
596 // These credential helpers are currently experimental.
597 // Any build failures will be ignored.
598 let _ = builder.ensure(ToolBuild {
599 compiler: self.compiler,
602 mode: Mode::ToolRustc,
604 is_optional_tool: true,
605 source_type: SourceType::Submodule,
606 extra_features: Vec::new(),
610 if self.target.contains("windows") {
612 "cargo-credential-wincred",
613 "src/tools/cargo/crates/credential/cargo-credential-wincred",
616 if self.target.contains("apple-darwin") {
618 "cargo-credential-macos-keychain",
619 "src/tools/cargo/crates/credential/cargo-credential-macos-keychain",
623 "cargo-credential-1password",
624 "src/tools/cargo/crates/credential/cargo-credential-1password",
630 macro_rules! tool_extended {
631 (($sel:ident, $builder:ident),
636 stable = $stable:expr,
637 $(in_tree = $in_tree:expr,)*
638 $extra_deps:block;)+) => {
640 #[derive(Debug, Clone, Hash, PartialEq, Eq)]
642 pub compiler: Compiler,
643 pub target: TargetSelection,
644 pub extra_features: Vec<String>,
647 impl Step for $name {
648 type Output = Option<PathBuf>;
649 const DEFAULT: bool = true; // Overwritten below
650 const ONLY_HOSTS: bool = true;
652 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
653 let builder = run.builder;
654 run.path($path).default_condition(
655 builder.config.extended
656 && builder.config.tools.as_ref().map_or(
657 // By default, on nightly/dev enable all tools, else only
658 // build stable tools.
659 $stable || builder.build.unstable_features(),
660 // If `tools` is set, search list for this tool.
662 tools.iter().any(|tool| match tool.as_ref() {
663 "clippy" => $tool_name == "clippy-driver",
664 x => $tool_name == x,
670 fn make_run(run: RunConfig<'_>) {
671 run.builder.ensure($name {
672 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
674 extra_features: Vec::new(),
679 fn run(mut $sel, $builder: &Builder<'_>) -> Option<PathBuf> {
681 $builder.ensure(ToolBuild {
682 compiler: $sel.compiler,
685 mode: Mode::ToolRustc,
687 extra_features: $sel.extra_features,
688 is_optional_tool: true,
689 source_type: if false $(|| $in_tree)* {
692 SourceType::Submodule
701 // Note: tools need to be also added to `Builder::get_step_descriptions` in `builder.rs`
702 // to make `./x.py build <tool>` work.
703 tool_extended!((self, builder),
704 Cargofmt, rustfmt, "src/tools/rustfmt", "cargo-fmt", stable=true, {};
705 CargoClippy, clippy, "src/tools/clippy", "cargo-clippy", stable=true, in_tree=true, {};
706 Clippy, clippy, "src/tools/clippy", "clippy-driver", stable=true, in_tree=true, {};
707 Miri, miri, "src/tools/miri", "miri", stable=false, {};
708 CargoMiri, miri, "src/tools/miri/cargo-miri", "cargo-miri", stable=false, {};
709 Rls, rls, "src/tools/rls", "rls", stable=true, {
710 builder.ensure(Clippy {
711 compiler: self.compiler,
713 extra_features: Vec::new(),
715 self.extra_features.push("clippy".to_owned());
717 Rustfmt, rustfmt, "src/tools/rustfmt", "rustfmt", stable=true, {};
718 RustAnalyzer, rust_analyzer, "src/tools/rust-analyzer/crates/rust-analyzer", "rust-analyzer", stable=false, {};
721 impl<'a> Builder<'a> {
722 /// Gets a `Command` which is ready to run `tool` in `stage` built for
724 pub fn tool_cmd(&self, tool: Tool) -> Command {
725 let mut cmd = Command::new(self.tool_exe(tool));
726 let compiler = self.compiler(0, self.config.build);
727 let host = &compiler.host;
728 // Prepares the `cmd` provided to be able to run the `compiler` provided.
730 // Notably this munges the dynamic library lookup path to point to the
731 // right location to run `compiler`.
732 let mut lib_paths: Vec<PathBuf> = vec![
733 self.build.rustc_snapshot_libdir(),
734 self.cargo_out(compiler, Mode::ToolBootstrap, *host).join("deps"),
737 // On MSVC a tool may invoke a C compiler (e.g., compiletest in run-make
738 // mode) and that C compiler may need some extra PATH modification. Do
740 if compiler.host.contains("msvc") {
741 let curpaths = env::var_os("PATH").unwrap_or_default();
742 let curpaths = env::split_paths(&curpaths).collect::<Vec<_>>();
743 for &(ref k, ref v) in self.cc[&compiler.host].env() {
747 for path in env::split_paths(v) {
748 if !curpaths.contains(&path) {
749 lib_paths.push(path);
755 add_dylib_path(lib_paths, &mut cmd);
757 // Provide a RUSTC for this command to use.
758 cmd.env("RUSTC", &self.initial_rustc);