1 use std::collections::HashSet;
4 use std::path::PathBuf;
5 use std::process::Command;
7 use crate::builder::{Builder, Cargo as CargoCommand, RunConfig, ShouldRun, Step};
8 use crate::channel::GitInfo;
10 use crate::config::TargetSelection;
11 use crate::toolstate::ToolState;
12 use crate::util::{add_dylib_path, exe, t};
16 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
22 #[derive(Debug, Clone, Hash, PartialEq, Eq)]
25 target: TargetSelection,
29 is_optional_tool: bool,
30 source_type: SourceType,
31 extra_features: Vec<String>,
34 impl Step for ToolBuild {
35 type Output = Option<PathBuf>;
37 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
41 /// Builds a tool in `src/tools`
43 /// This will build the specified tool with the specified `host` compiler in
44 /// `stage` into the normal cargo output directory.
45 fn run(self, builder: &Builder<'_>) -> Option<PathBuf> {
46 let compiler = self.compiler;
47 let target = self.target;
48 let mut tool = self.tool;
50 let is_optional_tool = self.is_optional_tool;
54 builder.ensure(compile::Std::new(compiler, compiler.host));
55 builder.ensure(compile::Rustc::new(compiler, target));
57 Mode::ToolStd => builder.ensure(compile::Std::new(compiler, target)),
58 Mode::ToolBootstrap => {} // uses downloaded stage0 compiler libs
59 _ => panic!("unexpected Mode for tool build"),
62 let cargo = prepare_tool_cargo(
73 builder.info(&format!("Building stage{} tool {} ({})", compiler.stage, tool, target));
74 let mut duplicates = Vec::new();
75 let is_expected = compile::stream_cargo(builder, cargo, vec![], &mut |msg| {
76 // Only care about big things like the RLS/Cargo for now
78 "rls" | "cargo" | "clippy-driver" | "miri" | "rustfmt" => {}
82 let (id, features, filenames) = match msg {
83 compile::CargoMessage::CompilerArtifact {
88 } => (package_id, features, filenames),
91 let features = features.iter().map(|s| s.to_string()).collect::<Vec<_>>();
93 for path in filenames {
94 let val = (tool, PathBuf::from(&*path), features.clone());
95 // we're only interested in deduplicating rlibs for now
96 if val.1.extension().and_then(|s| s.to_str()) != Some("rlib") {
100 // Don't worry about compiles that turn out to be host
101 // dependencies or build scripts. To skip these we look for
102 // anything that goes in `.../release/deps` but *doesn't* go in
103 // `$target/release/deps`. This ensure that outputs in
104 // `$target/release` are still considered candidates for
106 if let Some(parent) = val.1.parent() {
107 if parent.ends_with("release/deps") {
108 let maybe_target = parent
110 .and_then(|p| p.parent())
111 .and_then(|p| p.file_name())
112 .and_then(|p| p.to_str())
114 if maybe_target != &*target.triple {
120 // Record that we've built an artifact for `id`, and if one was
121 // already listed then we need to see if we reused the same
122 // artifact or produced a duplicate.
123 let mut artifacts = builder.tool_artifacts.borrow_mut();
124 let prev_artifacts = artifacts.entry(target).or_default();
125 let prev = match prev_artifacts.get(&*id) {
128 prev_artifacts.insert(id.to_string(), val);
133 return; // same path, same artifact
136 // If the paths are different and one of them *isn't* inside of
137 // `release/deps`, then it means it's probably in
138 // `$target/release`, or it's some final artifact like
139 // `libcargo.rlib`. In these situations Cargo probably just
140 // copied it up from `$target/release/deps/libcargo-xxxx.rlib`,
141 // so if the features are equal we can just skip it.
142 let prev_no_hash = prev.1.parent().unwrap().ends_with("release/deps");
143 let val_no_hash = val.1.parent().unwrap().ends_with("release/deps");
144 if prev.2 == val.2 || !prev_no_hash || !val_no_hash {
148 // ... and otherwise this looks like we duplicated some sort of
149 // compilation, so record it to generate an error later.
150 duplicates.push((id.to_string(), val, prev.clone()));
154 if is_expected && !duplicates.is_empty() {
156 "duplicate artifacts found when compiling a tool, this \
157 typically means that something was recompiled because \
158 a transitive dependency has different features activated \
159 than in a previous build:\n"
161 let (same, different): (Vec<_>, Vec<_>) =
162 duplicates.into_iter().partition(|(_, cur, prev)| cur.2 == prev.2);
163 if !same.is_empty() {
165 "the following dependencies are duplicated although they \
166 have the same features enabled:"
168 for (id, cur, prev) in same {
169 eprintln!(" {}", id);
171 eprintln!(" `{}` ({:?})\n `{}` ({:?})", cur.0, cur.1, prev.0, prev.1);
174 if !different.is_empty() {
175 eprintln!("the following dependencies have different features:");
176 for (id, cur, prev) in different {
177 eprintln!(" {}", id);
178 let cur_features: HashSet<_> = cur.2.into_iter().collect();
179 let prev_features: HashSet<_> = prev.2.into_iter().collect();
181 " `{}` additionally enabled features {:?} at {:?}",
183 &cur_features - &prev_features,
187 " `{}` additionally enabled features {:?} at {:?}",
189 &prev_features - &cur_features,
196 "to fix this you will probably want to edit the local \
197 src/tools/rustc-workspace-hack/Cargo.toml crate, as \
198 that will update the dependency graph to ensure that \
199 these crates all share the same feature set"
201 panic!("tools should not compile multiple copies of the same crate");
204 builder.save_toolstate(
206 if is_expected { ToolState::TestFail } else { ToolState::BuildFail },
210 if !is_optional_tool {
211 crate::detail_exit(1);
216 // HACK(#82501): on Windows, the tools directory gets added to PATH when running tests, and
217 // compiletest confuses HTML tidy with the in-tree tidy. Name the in-tree tidy something
218 // different so the problem doesn't come up.
222 let cargo_out = builder.cargo_out(compiler, self.mode, target).join(exe(tool, target));
223 let bin = builder.tools_dir(compiler).join(exe(tool, target));
224 builder.copy(&cargo_out, &bin);
230 pub fn prepare_tool_cargo(
231 builder: &Builder<'_>,
234 target: TargetSelection,
235 command: &'static str,
237 source_type: SourceType,
238 extra_features: &[String],
240 let mut cargo = builder.cargo(compiler, mode, source_type, target, command);
241 let dir = builder.src.join(path);
242 cargo.arg("--manifest-path").arg(dir.join("Cargo.toml"));
244 let mut features = extra_features.to_vec();
245 if builder.build.config.cargo_native_static {
246 if path.ends_with("cargo")
247 || path.ends_with("rls")
248 || path.ends_with("clippy")
249 || path.ends_with("miri")
250 || path.ends_with("rustfmt")
252 cargo.env("LIBZ_SYS_STATIC", "1");
253 features.push("rustc-workspace-hack/all-static".to_string());
257 // clippy tests need to know about the stage sysroot. Set them consistently while building to
258 // avoid rebuilding when running tests.
259 cargo.env("SYSROOT", builder.sysroot(compiler));
261 // if tools are using lzma we want to force the build script to build its
263 cargo.env("LZMA_API_STATIC", "1");
265 // CFG_RELEASE is needed by rustfmt (and possibly other tools) which
266 // import rustc-ap-rustc_attr which requires this to be set for the
267 // `#[cfg(version(...))]` attribute.
268 cargo.env("CFG_RELEASE", builder.rust_release());
269 cargo.env("CFG_RELEASE_CHANNEL", &builder.config.channel);
270 cargo.env("CFG_VERSION", builder.rust_version());
271 cargo.env("CFG_RELEASE_NUM", &builder.version);
272 cargo.env("DOC_RUST_LANG_ORG_CHANNEL", builder.doc_rust_lang_org_channel());
274 let info = GitInfo::new(builder.config.ignore_git, &dir);
275 if let Some(sha) = info.sha() {
276 cargo.env("CFG_COMMIT_HASH", sha);
278 if let Some(sha_short) = info.sha_short() {
279 cargo.env("CFG_SHORT_COMMIT_HASH", sha_short);
281 if let Some(date) = info.commit_date() {
282 cargo.env("CFG_COMMIT_DATE", date);
284 if !features.is_empty() {
285 cargo.arg("--features").arg(&features.join(", "));
290 macro_rules! bootstrap_tool {
292 $name:ident, $path:expr, $tool_name:expr
293 $(,is_external_tool = $external:expr)*
294 $(,is_unstable_tool = $unstable:expr)*
297 #[derive(Copy, PartialEq, Eq, Clone)]
304 impl<'a> Builder<'a> {
305 pub fn tool_exe(&self, tool: Tool) -> PathBuf {
309 compiler: self.compiler(0, self.config.build),
310 target: self.config.build,
318 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
320 pub compiler: Compiler,
321 pub target: TargetSelection,
324 impl Step for $name {
325 type Output = PathBuf;
327 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
331 fn make_run(run: RunConfig<'_>) {
332 run.builder.ensure($name {
334 compiler: run.builder.compiler(0, run.builder.config.build),
339 fn run(self, builder: &Builder<'_>) -> PathBuf {
340 builder.ensure(ToolBuild {
341 compiler: self.compiler,
344 mode: if false $(|| $unstable)* {
345 // use in-tree libraries for unstable features
351 is_optional_tool: false,
352 source_type: if false $(|| $external)* {
353 SourceType::Submodule
357 extra_features: vec![],
358 }).expect("expected to build -- essential tool")
366 Rustbook, "src/tools/rustbook", "rustbook";
367 UnstableBookGen, "src/tools/unstable-book-gen", "unstable-book-gen";
368 Tidy, "src/tools/tidy", "tidy";
369 Linkchecker, "src/tools/linkchecker", "linkchecker";
370 CargoTest, "src/tools/cargotest", "cargotest";
371 Compiletest, "src/tools/compiletest", "compiletest", is_unstable_tool = true;
372 BuildManifest, "src/tools/build-manifest", "build-manifest";
373 RemoteTestClient, "src/tools/remote-test-client", "remote-test-client";
374 RustInstaller, "src/tools/rust-installer", "rust-installer", is_external_tool = true;
375 RustdocTheme, "src/tools/rustdoc-themes", "rustdoc-themes";
376 ExpandYamlAnchors, "src/tools/expand-yaml-anchors", "expand-yaml-anchors";
377 LintDocs, "src/tools/lint-docs", "lint-docs";
378 JsonDocCk, "src/tools/jsondocck", "jsondocck";
379 JsonDocLint, "src/tools/jsondoclint", "jsondoclint";
380 HtmlChecker, "src/tools/html-checker", "html-checker";
381 BumpStage0, "src/tools/bump-stage0", "bump-stage0";
382 ReplaceVersionPlaceholder, "src/tools/replace-version-placeholder", "replace-version-placeholder";
385 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
386 pub struct ErrorIndex {
387 pub compiler: Compiler,
391 pub fn command(builder: &Builder<'_>) -> Command {
392 // Error-index-generator links with the rustdoc library, so we need to add `rustc_lib_paths`
393 // for rustc_private and libLLVM.so, and `sysroot_lib` for libstd, etc.
394 let host = builder.config.build;
395 let compiler = builder.compiler_for(builder.top_stage, host, host);
396 let mut cmd = Command::new(builder.ensure(ErrorIndex { compiler }));
397 let mut dylib_paths = builder.rustc_lib_paths(compiler);
398 dylib_paths.push(PathBuf::from(&builder.sysroot_libdir(compiler, compiler.host)));
399 add_dylib_path(dylib_paths, &mut cmd);
404 impl Step for ErrorIndex {
405 type Output = PathBuf;
407 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
408 run.path("src/tools/error_index_generator")
411 fn make_run(run: RunConfig<'_>) {
412 // Compile the error-index in the same stage as rustdoc to avoid
413 // recompiling rustdoc twice if we can.
415 // NOTE: This `make_run` isn't used in normal situations, only if you
416 // manually build the tool with `x.py build
417 // src/tools/error-index-generator` which almost nobody does.
418 // Normally, `x.py test` or `x.py doc` will use the
419 // `ErrorIndex::command` function instead.
421 run.builder.compiler(run.builder.top_stage.saturating_sub(1), run.builder.config.build);
422 run.builder.ensure(ErrorIndex { compiler });
425 fn run(self, builder: &Builder<'_>) -> PathBuf {
428 compiler: self.compiler,
429 target: self.compiler.host,
430 tool: "error_index_generator",
431 mode: Mode::ToolRustc,
432 path: "src/tools/error_index_generator",
433 is_optional_tool: false,
434 source_type: SourceType::InTree,
435 extra_features: Vec::new(),
437 .expect("expected to build -- essential tool")
441 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
442 pub struct RemoteTestServer {
443 pub compiler: Compiler,
444 pub target: TargetSelection,
447 impl Step for RemoteTestServer {
448 type Output = PathBuf;
450 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
451 run.path("src/tools/remote-test-server")
454 fn make_run(run: RunConfig<'_>) {
455 run.builder.ensure(RemoteTestServer {
456 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
461 fn run(self, builder: &Builder<'_>) -> PathBuf {
464 compiler: self.compiler,
466 tool: "remote-test-server",
468 path: "src/tools/remote-test-server",
469 is_optional_tool: false,
470 source_type: SourceType::InTree,
471 extra_features: Vec::new(),
473 .expect("expected to build -- essential tool")
477 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
479 /// This should only ever be 0 or 2.
480 /// We sometimes want to reference the "bootstrap" rustdoc, which is why this option is here.
481 pub compiler: Compiler,
484 impl Step for Rustdoc {
485 type Output = PathBuf;
486 const DEFAULT: bool = true;
487 const ONLY_HOSTS: bool = true;
489 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
490 run.path("src/tools/rustdoc").path("src/librustdoc")
493 fn make_run(run: RunConfig<'_>) {
494 run.builder.ensure(Rustdoc {
495 // Note: this is somewhat unique in that we actually want a *target*
496 // compiler here, because rustdoc *is* a compiler. We won't be using
497 // this as the compiler to build with, but rather this is "what
498 // compiler are we producing"?
499 compiler: run.builder.compiler(run.builder.top_stage, run.target),
503 fn run(self, builder: &Builder<'_>) -> PathBuf {
504 let target_compiler = self.compiler;
505 if target_compiler.stage == 0 {
506 if !target_compiler.is_snapshot(builder) {
507 panic!("rustdoc in stage 0 must be snapshot rustdoc");
509 return builder.initial_rustc.with_file_name(exe("rustdoc", target_compiler.host));
511 let target = target_compiler.host;
512 // Similar to `compile::Assemble`, build with the previous stage's compiler. Otherwise
513 // we'd have stageN/bin/rustc and stageN/bin/rustdoc be effectively different stage
514 // compilers, which isn't what we want. Rustdoc should be linked in the same way as the
515 // rustc compiler it's paired with, so it must be built with the previous stage compiler.
516 let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
518 // When using `download-rustc` and a stage0 build_compiler, copying rustc doesn't actually
519 // build stage0 libstd (because the libstd in sysroot has the wrong ABI). Explicitly build
521 builder.ensure(compile::Std::new(build_compiler, target_compiler.host));
522 builder.ensure(compile::Rustc::new(build_compiler, target_compiler.host));
523 // NOTE: this implies that `download-rustc` is pretty useless when compiling with the stage0
524 // compiler, since you do just as much work.
525 if !builder.config.dry_run && builder.download_rustc() && build_compiler.stage == 0 {
527 "warning: `download-rustc` does nothing when building stage1 tools; consider using `--stage 2` instead"
531 // The presence of `target_compiler` ensures that the necessary libraries (codegen backends,
532 // compiler libraries, ...) are built. Rustdoc does not require the presence of any
533 // libraries within sysroot_libdir (i.e., rustlib), though doctests may want it (since
534 // they'll be linked to those libraries). As such, don't explicitly `ensure` any additional
535 // libraries here. The intuition here is that If we've built a compiler, we should be able
538 let mut features = Vec::new();
539 if builder.config.jemalloc {
540 features.push("jemalloc".to_string());
543 let cargo = prepare_tool_cargo(
554 builder.info(&format!(
555 "Building rustdoc for stage{} ({})",
556 target_compiler.stage, target_compiler.host
558 builder.run(&mut cargo.into());
560 // Cargo adds a number of paths to the dylib search path on windows, which results in
561 // the wrong rustdoc being executed. To avoid the conflicting rustdocs, we name the "tool"
562 // rustdoc a different name.
563 let tool_rustdoc = builder
564 .cargo_out(build_compiler, Mode::ToolRustc, target)
565 .join(exe("rustdoc_tool_binary", target_compiler.host));
567 // don't create a stage0-sysroot/bin directory.
568 if target_compiler.stage > 0 {
569 let sysroot = builder.sysroot(target_compiler);
570 let bindir = sysroot.join("bin");
571 t!(fs::create_dir_all(&bindir));
572 let bin_rustdoc = bindir.join(exe("rustdoc", target_compiler.host));
573 let _ = fs::remove_file(&bin_rustdoc);
574 builder.copy(&tool_rustdoc, &bin_rustdoc);
582 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
584 pub compiler: Compiler,
585 pub target: TargetSelection,
588 impl Step for Cargo {
589 type Output = PathBuf;
590 const DEFAULT: bool = true;
591 const ONLY_HOSTS: bool = true;
593 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
594 let builder = run.builder;
595 run.path("src/tools/cargo").default_condition(
596 builder.config.extended
597 && builder.config.tools.as_ref().map_or(
599 // If `tools` is set, search list for this tool.
600 |tools| tools.iter().any(|tool| tool == "cargo"),
605 fn make_run(run: RunConfig<'_>) {
606 run.builder.ensure(Cargo {
607 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
612 fn run(self, builder: &Builder<'_>) -> PathBuf {
613 let cargo_bin_path = builder
615 compiler: self.compiler,
618 mode: Mode::ToolRustc,
619 path: "src/tools/cargo",
620 is_optional_tool: false,
621 source_type: SourceType::Submodule,
622 extra_features: Vec::new(),
624 .expect("expected to build -- essential tool");
626 let build_cred = |name, path| {
627 // These credential helpers are currently experimental.
628 // Any build failures will be ignored.
629 let _ = builder.ensure(ToolBuild {
630 compiler: self.compiler,
633 mode: Mode::ToolRustc,
635 is_optional_tool: true,
636 source_type: SourceType::Submodule,
637 extra_features: Vec::new(),
641 if self.target.contains("windows") {
643 "cargo-credential-wincred",
644 "src/tools/cargo/crates/credential/cargo-credential-wincred",
647 if self.target.contains("apple-darwin") {
649 "cargo-credential-macos-keychain",
650 "src/tools/cargo/crates/credential/cargo-credential-macos-keychain",
654 "cargo-credential-1password",
655 "src/tools/cargo/crates/credential/cargo-credential-1password",
661 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
662 pub struct LldWrapper {
663 pub compiler: Compiler,
664 pub target: TargetSelection,
667 impl Step for LldWrapper {
668 type Output = PathBuf;
670 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
674 fn run(self, builder: &Builder<'_>) -> PathBuf {
675 let src_exe = builder
677 compiler: self.compiler,
681 path: "src/tools/lld-wrapper",
682 is_optional_tool: false,
683 source_type: SourceType::InTree,
684 extra_features: Vec::new(),
686 .expect("expected to build -- essential tool");
692 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
693 pub struct RustAnalyzer {
694 pub compiler: Compiler,
695 pub target: TargetSelection,
698 impl Step for RustAnalyzer {
699 type Output = Option<PathBuf>;
700 const DEFAULT: bool = true;
701 const ONLY_HOSTS: bool = false;
703 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
704 let builder = run.builder;
705 run.path("src/tools/rust-analyzer").default_condition(
706 builder.config.extended
711 .map_or(true, |tools| tools.iter().any(|tool| tool == "rust-analyzer")),
715 fn make_run(run: RunConfig<'_>) {
716 run.builder.ensure(RustAnalyzer {
717 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
722 fn run(self, builder: &Builder<'_>) -> Option<PathBuf> {
723 builder.ensure(ToolBuild {
724 compiler: self.compiler,
726 tool: "rust-analyzer",
728 path: "src/tools/rust-analyzer",
729 extra_features: vec!["rust-analyzer/in-rust-tree".to_owned()],
730 is_optional_tool: false,
731 source_type: SourceType::InTree,
736 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
737 pub struct RustAnalyzerProcMacroSrv {
738 pub compiler: Compiler,
739 pub target: TargetSelection,
742 impl Step for RustAnalyzerProcMacroSrv {
743 type Output = Option<PathBuf>;
744 const DEFAULT: bool = true;
745 const ONLY_HOSTS: bool = false;
747 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
748 let builder = run.builder;
749 run.path("src/tools/rust-analyzer").default_condition(
750 builder.config.extended
755 .map_or(true, |tools| tools.iter().any(|tool| tool == "rust-analyzer")),
759 fn make_run(run: RunConfig<'_>) {
760 run.builder.ensure(RustAnalyzerProcMacroSrv {
761 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
766 fn run(self, builder: &Builder<'_>) -> Option<PathBuf> {
767 builder.ensure(ToolBuild {
768 compiler: self.compiler,
770 tool: "rust-analyzer-proc-macro-srv",
772 path: "src/tools/rust-analyzer/crates/proc-macro-srv-cli",
773 extra_features: vec!["proc-macro-srv/sysroot-abi".to_owned()],
774 is_optional_tool: false,
775 source_type: SourceType::InTree,
780 macro_rules! tool_extended {
781 (($sel:ident, $builder:ident),
785 stable = $stable:expr,
786 $(in_tree = $in_tree:expr,)?
787 $(tool_std = $tool_std:literal,)?
788 $extra_deps:block;)+) => {
790 #[derive(Debug, Clone, Hash, PartialEq, Eq)]
792 pub compiler: Compiler,
793 pub target: TargetSelection,
794 pub extra_features: Vec<String>,
797 impl Step for $name {
798 type Output = Option<PathBuf>;
799 const DEFAULT: bool = true; // Overwritten below
800 const ONLY_HOSTS: bool = true;
802 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
803 let builder = run.builder;
804 run.path($path).default_condition(
805 builder.config.extended
806 && builder.config.tools.as_ref().map_or(
807 // By default, on nightly/dev enable all tools, else only
808 // build stable tools.
809 $stable || builder.build.unstable_features(),
810 // If `tools` is set, search list for this tool.
812 tools.iter().any(|tool| match tool.as_ref() {
813 "clippy" => $tool_name == "clippy-driver",
814 x => $tool_name == x,
820 fn make_run(run: RunConfig<'_>) {
821 run.builder.ensure($name {
822 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
824 extra_features: Vec::new(),
829 fn run(mut $sel, $builder: &Builder<'_>) -> Option<PathBuf> {
831 $builder.ensure(ToolBuild {
832 compiler: $sel.compiler,
835 mode: if false $(|| $tool_std)? { Mode::ToolStd } else { Mode::ToolRustc },
837 extra_features: $sel.extra_features,
838 is_optional_tool: true,
839 source_type: if false $(|| $in_tree)* {
842 SourceType::Submodule
851 // Note: tools need to be also added to `Builder::get_step_descriptions` in `builder.rs`
852 // to make `./x.py build <tool>` work.
853 // Note: Most submodule updates for tools are handled by bootstrap.py, since they're needed just to
854 // invoke Cargo to build bootstrap. See the comment there for more details.
855 tool_extended!((self, builder),
856 Cargofmt, "src/tools/rustfmt", "cargo-fmt", stable=true, in_tree=true, {};
857 CargoClippy, "src/tools/clippy", "cargo-clippy", stable=true, in_tree=true, {};
858 Clippy, "src/tools/clippy", "clippy-driver", stable=true, in_tree=true, {};
859 Miri, "src/tools/miri", "miri", stable=false, {};
860 CargoMiri, "src/tools/miri/cargo-miri", "cargo-miri", stable=false, {};
861 Rls, "src/tools/rls", "rls", stable=true, {};
862 // FIXME: tool_std is not quite right, we shouldn't allow nightly features.
863 // But `builder.cargo` doesn't know how to handle ToolBootstrap in stages other than 0,
864 // and this is close enough for now.
865 RustDemangler, "src/tools/rust-demangler", "rust-demangler", stable=false, in_tree=true, tool_std=true, {};
866 Rustfmt, "src/tools/rustfmt", "rustfmt", stable=true, in_tree=true, {};
869 impl<'a> Builder<'a> {
870 /// Gets a `Command` which is ready to run `tool` in `stage` built for
872 pub fn tool_cmd(&self, tool: Tool) -> Command {
873 let mut cmd = Command::new(self.tool_exe(tool));
874 let compiler = self.compiler(0, self.config.build);
875 let host = &compiler.host;
876 // Prepares the `cmd` provided to be able to run the `compiler` provided.
878 // Notably this munges the dynamic library lookup path to point to the
879 // right location to run `compiler`.
880 let mut lib_paths: Vec<PathBuf> = vec![
881 self.build.rustc_snapshot_libdir(),
882 self.cargo_out(compiler, Mode::ToolBootstrap, *host).join("deps"),
885 // On MSVC a tool may invoke a C compiler (e.g., compiletest in run-make
886 // mode) and that C compiler may need some extra PATH modification. Do
888 if compiler.host.contains("msvc") {
889 let curpaths = env::var_os("PATH").unwrap_or_default();
890 let curpaths = env::split_paths(&curpaths).collect::<Vec<_>>();
891 for &(ref k, ref v) in self.cc[&compiler.host].env() {
895 for path in env::split_paths(v) {
896 if !curpaths.contains(&path) {
897 lib_paths.push(path);
903 add_dylib_path(lib_paths, &mut cmd);
905 // Provide a RUSTC for this command to use.
906 cmd.env("RUSTC", &self.initial_rustc);