src/bootstrap/tool.rs

   1 use std::collections::HashSet;
   2 use std::env;
   3 use std::fs;
   4 use std::path::PathBuf;
   5 use std::process::Command;
   6
   7 use crate::builder::{Builder, Cargo as CargoCommand, RunConfig, ShouldRun, Step};
   8 use crate::channel::GitInfo;
   9 use crate::compile;
  10 use crate::config::TargetSelection;
  11 use crate::toolstate::ToolState;
  12 use crate::util::{add_dylib_path, exe, t};
  13 use crate::Compiler;
  14 use crate::Mode;
  15
  16 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
  17 pub enum SourceType {
  18     InTree,
  19     Submodule,
  20 }
  21
  22 #[derive(Debug, Clone, Hash, PartialEq, Eq)]
  23 struct ToolBuild {
  24     compiler: Compiler,
  25     target: TargetSelection,
  26     tool: &'static str,
  27     path: &'static str,
  28     mode: Mode,
  29     is_optional_tool: bool,
  30     source_type: SourceType,
  31     extra_features: Vec<String>,
  32 }
  33
  34 impl Step for ToolBuild {
  35     type Output = Option<PathBuf>;
  36
  37     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
  38         run.never()
  39     }
  40
  41     /// Builds a tool in `src/tools`
  42     ///
  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;
  49         let path = self.path;
  50         let is_optional_tool = self.is_optional_tool;
  51
  52         match self.mode {
  53             Mode::ToolRustc => {
  54                 builder.ensure(compile::Std::new(compiler, compiler.host));
  55                 builder.ensure(compile::Rustc::new(compiler, target));
  56             }
  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"),
  60         }
  61
  62         let cargo = prepare_tool_cargo(
  63             builder,
  64             compiler,
  65             self.mode,
  66             target,
  67             "build",
  68             path,
  69             self.source_type,
  70             &self.extra_features,
  71         );
  72
  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
  77             match tool {
  78                 "rls" | "cargo" | "clippy-driver" | "miri" | "rustfmt" => {}
  79
  80                 _ => return,
  81             }
  82             let (id, features, filenames) = match msg {
  83                 compile::CargoMessage::CompilerArtifact {
  84                     package_id,
  85                     features,
  86                     filenames,
  87                     target: _,
  88                 } => (package_id, features, filenames),
  89                 _ => return,
  90             };
  91             let features = features.iter().map(|s| s.to_string()).collect::<Vec<_>>();
  92
  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") {
  97                     continue;
  98                 }
  99
 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
 105                 // deduplication.
 106                 if let Some(parent) = val.1.parent() {
 107                     if parent.ends_with("release/deps") {
 108                         let maybe_target = parent
 109                             .parent()
 110                             .and_then(|p| p.parent())
 111                             .and_then(|p| p.file_name())
 112                             .and_then(|p| p.to_str())
 113                             .unwrap();
 114                         if maybe_target != &*target.triple {
 115                             continue;
 116                         }
 117                     }
 118                 }
 119
 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) {
 126                     Some(prev) => prev,
 127                     None => {
 128                         prev_artifacts.insert(id.to_string(), val);
 129                         continue;
 130                     }
 131                 };
 132                 if prev.1 == val.1 {
 133                     return; // same path, same artifact
 134                 }
 135
 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 {
 145                     return;
 146                 }
 147
 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()));
 151             }
 152         });
 153
 154         if is_expected && !duplicates.is_empty() {
 155             eprintln!(
 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"
 160             );
 161             let (same, different): (Vec<_>, Vec<_>) =
 162                 duplicates.into_iter().partition(|(_, cur, prev)| cur.2 == prev.2);
 163             if !same.is_empty() {
 164                 eprintln!(
 165                     "the following dependencies are duplicated although they \
 166                       have the same features enabled:"
 167                 );
 168                 for (id, cur, prev) in same {
 169                     eprintln!("  {}", id);
 170                     // same features
 171                     eprintln!("    `{}` ({:?})\n    `{}` ({:?})", cur.0, cur.1, prev.0, prev.1);
 172                 }
 173             }
 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();
 180                     eprintln!(
 181                         "    `{}` additionally enabled features {:?} at {:?}",
 182                         cur.0,
 183                         &cur_features - &prev_features,
 184                         cur.1
 185                     );
 186                     eprintln!(
 187                         "    `{}` additionally enabled features {:?} at {:?}",
 188                         prev.0,
 189                         &prev_features - &cur_features,
 190                         prev.1
 191                     );
 192                 }
 193             }
 194             eprintln!();
 195             eprintln!(
 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"
 200             );
 201             panic!("tools should not compile multiple copies of the same crate");
 202         }
 203
 204         builder.save_toolstate(
 205             tool,
 206             if is_expected { ToolState::TestFail } else { ToolState::BuildFail },
 207         );
 208
 209         if !is_expected {
 210             if !is_optional_tool {
 211                 crate::detail_exit(1);
 212             } else {
 213                 None
 214             }
 215         } else {
 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.
 219             if tool == "tidy" {
 220                 tool = "rust-tidy";
 221             }
 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);
 225             Some(bin)
 226         }
 227     }
 228 }
 229
 230 pub fn prepare_tool_cargo(
 231     builder: &Builder<'_>,
 232     compiler: Compiler,
 233     mode: Mode,
 234     target: TargetSelection,
 235     command: &'static str,
 236     path: &'static str,
 237     source_type: SourceType,
 238     extra_features: &[String],
 239 ) -> CargoCommand {
 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"));
 243
 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")
 251         {
 252             cargo.env("LIBZ_SYS_STATIC", "1");
 253             features.push("rustc-workspace-hack/all-static".to_string());
 254         }
 255     }
 256
 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));
 260
 261     // if tools are using lzma we want to force the build script to build its
 262     // own copy
 263     cargo.env("LZMA_API_STATIC", "1");
 264
 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());
 273
 274     let info = GitInfo::new(builder.config.ignore_git, &dir);
 275     if let Some(sha) = info.sha() {
 276         cargo.env("CFG_COMMIT_HASH", sha);
 277     }
 278     if let Some(sha_short) = info.sha_short() {
 279         cargo.env("CFG_SHORT_COMMIT_HASH", sha_short);
 280     }
 281     if let Some(date) = info.commit_date() {
 282         cargo.env("CFG_COMMIT_DATE", date);
 283     }
 284     if !features.is_empty() {
 285         cargo.arg("--features").arg(&features.join(", "));
 286     }
 287     cargo
 288 }
 289
 290 macro_rules! bootstrap_tool {
 291     ($(
 292         $name:ident, $path:expr, $tool_name:expr
 293         $(,is_external_tool = $external:expr)*
 294         $(,is_unstable_tool = $unstable:expr)*
 295         ;
 296     )+) => {
 297         #[derive(Copy, PartialEq, Eq, Clone)]
 298         pub enum Tool {
 299             $(
 300                 $name,
 301             )+
 302         }
 303
 304         impl<'a> Builder<'a> {
 305             pub fn tool_exe(&self, tool: Tool) -> PathBuf {
 306                 match tool {
 307                     $(Tool::$name =>
 308                         self.ensure($name {
 309                             compiler: self.compiler(0, self.config.build),
 310                             target: self.config.build,
 311                         }),
 312                     )+
 313                 }
 314             }
 315         }
 316
 317         $(
 318             #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 319         pub struct $name {
 320             pub compiler: Compiler,
 321             pub target: TargetSelection,
 322         }
 323
 324         impl Step for $name {
 325             type Output = PathBuf;
 326
 327             fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 328                 run.path($path)
 329             }
 330
 331             fn make_run(run: RunConfig<'_>) {
 332                 run.builder.ensure($name {
 333                     // snapshot compiler
 334                     compiler: run.builder.compiler(0, run.builder.config.build),
 335                     target: run.target,
 336                 });
 337             }
 338
 339             fn run(self, builder: &Builder<'_>) -> PathBuf {
 340                 builder.ensure(ToolBuild {
 341                     compiler: self.compiler,
 342                     target: self.target,
 343                     tool: $tool_name,
 344                     mode: if false $(|| $unstable)* {
 345                         // use in-tree libraries for unstable features
 346                         Mode::ToolStd
 347                     } else {
 348                         Mode::ToolBootstrap
 349                     },
 350                     path: $path,
 351                     is_optional_tool: false,
 352                     source_type: if false $(|| $external)* {
 353                         SourceType::Submodule
 354                     } else {
 355                         SourceType::InTree
 356                     },
 357                     extra_features: vec![],
 358                 }).expect("expected to build -- essential tool")
 359             }
 360         }
 361         )+
 362     }
 363 }
 364
 365 bootstrap_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";
 383     CollectLicenseMetadata, "src/tools/collect-license-metadata", "collect-license-metadata";
 384     GenerateCopyright, "src/tools/generate-copyright", "generate-copyright";
 385 );
 386
 387 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
 388 pub struct ErrorIndex {
 389     pub compiler: Compiler,
 390 }
 391
 392 impl ErrorIndex {
 393     pub fn command(builder: &Builder<'_>) -> Command {
 394         // Error-index-generator links with the rustdoc library, so we need to add `rustc_lib_paths`
 395         // for rustc_private and libLLVM.so, and `sysroot_lib` for libstd, etc.
 396         let host = builder.config.build;
 397         let compiler = builder.compiler_for(builder.top_stage, host, host);
 398         let mut cmd = Command::new(builder.ensure(ErrorIndex { compiler }));
 399         let mut dylib_paths = builder.rustc_lib_paths(compiler);
 400         dylib_paths.push(PathBuf::from(&builder.sysroot_libdir(compiler, compiler.host)));
 401         add_dylib_path(dylib_paths, &mut cmd);
 402         cmd
 403     }
 404 }
 405
 406 impl Step for ErrorIndex {
 407     type Output = PathBuf;
 408
 409     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 410         run.path("src/tools/error_index_generator")
 411     }
 412
 413     fn make_run(run: RunConfig<'_>) {
 414         // Compile the error-index in the same stage as rustdoc to avoid
 415         // recompiling rustdoc twice if we can.
 416         //
 417         // NOTE: This `make_run` isn't used in normal situations, only if you
 418         // manually build the tool with `x.py build
 419         // src/tools/error-index-generator` which almost nobody does.
 420         // Normally, `x.py test` or `x.py doc` will use the
 421         // `ErrorIndex::command` function instead.
 422         let compiler =
 423             run.builder.compiler(run.builder.top_stage.saturating_sub(1), run.builder.config.build);
 424         run.builder.ensure(ErrorIndex { compiler });
 425     }
 426
 427     fn run(self, builder: &Builder<'_>) -> PathBuf {
 428         builder
 429             .ensure(ToolBuild {
 430                 compiler: self.compiler,
 431                 target: self.compiler.host,
 432                 tool: "error_index_generator",
 433                 mode: Mode::ToolRustc,
 434                 path: "src/tools/error_index_generator",
 435                 is_optional_tool: false,
 436                 source_type: SourceType::InTree,
 437                 extra_features: Vec::new(),
 438             })
 439             .expect("expected to build -- essential tool")
 440     }
 441 }
 442
 443 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 444 pub struct RemoteTestServer {
 445     pub compiler: Compiler,
 446     pub target: TargetSelection,
 447 }
 448
 449 impl Step for RemoteTestServer {
 450     type Output = PathBuf;
 451
 452     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 453         run.path("src/tools/remote-test-server")
 454     }
 455
 456     fn make_run(run: RunConfig<'_>) {
 457         run.builder.ensure(RemoteTestServer {
 458             compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
 459             target: run.target,
 460         });
 461     }
 462
 463     fn run(self, builder: &Builder<'_>) -> PathBuf {
 464         builder
 465             .ensure(ToolBuild {
 466                 compiler: self.compiler,
 467                 target: self.target,
 468                 tool: "remote-test-server",
 469                 mode: Mode::ToolStd,
 470                 path: "src/tools/remote-test-server",
 471                 is_optional_tool: false,
 472                 source_type: SourceType::InTree,
 473                 extra_features: Vec::new(),
 474             })
 475             .expect("expected to build -- essential tool")
 476     }
 477 }
 478
 479 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
 480 pub struct Rustdoc {
 481     /// This should only ever be 0 or 2.
 482     /// We sometimes want to reference the "bootstrap" rustdoc, which is why this option is here.
 483     pub compiler: Compiler,
 484 }
 485
 486 impl Step for Rustdoc {
 487     type Output = PathBuf;
 488     const DEFAULT: bool = true;
 489     const ONLY_HOSTS: bool = true;
 490
 491     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 492         run.path("src/tools/rustdoc").path("src/librustdoc")
 493     }
 494
 495     fn make_run(run: RunConfig<'_>) {
 496         run.builder.ensure(Rustdoc {
 497             // Note: this is somewhat unique in that we actually want a *target*
 498             // compiler here, because rustdoc *is* a compiler. We won't be using
 499             // this as the compiler to build with, but rather this is "what
 500             // compiler are we producing"?
 501             compiler: run.builder.compiler(run.builder.top_stage, run.target),
 502         });
 503     }
 504
 505     fn run(self, builder: &Builder<'_>) -> PathBuf {
 506         let target_compiler = self.compiler;
 507         if target_compiler.stage == 0 {
 508             if !target_compiler.is_snapshot(builder) {
 509                 panic!("rustdoc in stage 0 must be snapshot rustdoc");
 510             }
 511             return builder.initial_rustc.with_file_name(exe("rustdoc", target_compiler.host));
 512         }
 513         let target = target_compiler.host;
 514         // Similar to `compile::Assemble`, build with the previous stage's compiler. Otherwise
 515         // we'd have stageN/bin/rustc and stageN/bin/rustdoc be effectively different stage
 516         // compilers, which isn't what we want. Rustdoc should be linked in the same way as the
 517         // rustc compiler it's paired with, so it must be built with the previous stage compiler.
 518         let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
 519
 520         // When using `download-rustc` and a stage0 build_compiler, copying rustc doesn't actually
 521         // build stage0 libstd (because the libstd in sysroot has the wrong ABI). Explicitly build
 522         // it.
 523         builder.ensure(compile::Std::new(build_compiler, target_compiler.host));
 524         builder.ensure(compile::Rustc::new(build_compiler, target_compiler.host));
 525         // NOTE: this implies that `download-rustc` is pretty useless when compiling with the stage0
 526         // compiler, since you do just as much work.
 527         if !builder.config.dry_run() && builder.download_rustc() && build_compiler.stage == 0 {
 528             println!(
 529                 "warning: `download-rustc` does nothing when building stage1 tools; consider using `--stage 2` instead"
 530             );
 531         }
 532
 533         // The presence of `target_compiler` ensures that the necessary libraries (codegen backends,
 534         // compiler libraries, ...) are built. Rustdoc does not require the presence of any
 535         // libraries within sysroot_libdir (i.e., rustlib), though doctests may want it (since
 536         // they'll be linked to those libraries). As such, don't explicitly `ensure` any additional
 537         // libraries here. The intuition here is that If we've built a compiler, we should be able
 538         // to build rustdoc.
 539         //
 540         let mut features = Vec::new();
 541         if builder.config.jemalloc {
 542             features.push("jemalloc".to_string());
 543         }
 544
 545         let cargo = prepare_tool_cargo(
 546             builder,
 547             build_compiler,
 548             Mode::ToolRustc,
 549             target,
 550             "build",
 551             "src/tools/rustdoc",
 552             SourceType::InTree,
 553             features.as_slice(),
 554         );
 555
 556         builder.info(&format!(
 557             "Building rustdoc for stage{} ({})",
 558             target_compiler.stage, target_compiler.host
 559         ));
 560         builder.run(&mut cargo.into());
 561
 562         // Cargo adds a number of paths to the dylib search path on windows, which results in
 563         // the wrong rustdoc being executed. To avoid the conflicting rustdocs, we name the "tool"
 564         // rustdoc a different name.
 565         let tool_rustdoc = builder
 566             .cargo_out(build_compiler, Mode::ToolRustc, target)
 567             .join(exe("rustdoc_tool_binary", target_compiler.host));
 568
 569         // don't create a stage0-sysroot/bin directory.
 570         if target_compiler.stage > 0 {
 571             let sysroot = builder.sysroot(target_compiler);
 572             let bindir = sysroot.join("bin");
 573             t!(fs::create_dir_all(&bindir));
 574             let bin_rustdoc = bindir.join(exe("rustdoc", target_compiler.host));
 575             let _ = fs::remove_file(&bin_rustdoc);
 576             builder.copy(&tool_rustdoc, &bin_rustdoc);
 577             bin_rustdoc
 578         } else {
 579             tool_rustdoc
 580         }
 581     }
 582 }
 583
 584 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 585 pub struct Cargo {
 586     pub compiler: Compiler,
 587     pub target: TargetSelection,
 588 }
 589
 590 impl Step for Cargo {
 591     type Output = PathBuf;
 592     const DEFAULT: bool = true;
 593     const ONLY_HOSTS: bool = true;
 594
 595     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 596         let builder = run.builder;
 597         run.path("src/tools/cargo").default_condition(
 598             builder.config.extended
 599                 && builder.config.tools.as_ref().map_or(
 600                     true,
 601                     // If `tools` is set, search list for this tool.
 602                     |tools| tools.iter().any(|tool| tool == "cargo"),
 603                 ),
 604         )
 605     }
 606
 607     fn make_run(run: RunConfig<'_>) {
 608         run.builder.ensure(Cargo {
 609             compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
 610             target: run.target,
 611         });
 612     }
 613
 614     fn run(self, builder: &Builder<'_>) -> PathBuf {
 615         let cargo_bin_path = builder
 616             .ensure(ToolBuild {
 617                 compiler: self.compiler,
 618                 target: self.target,
 619                 tool: "cargo",
 620                 mode: Mode::ToolRustc,
 621                 path: "src/tools/cargo",
 622                 is_optional_tool: false,
 623                 source_type: SourceType::Submodule,
 624                 extra_features: Vec::new(),
 625             })
 626             .expect("expected to build -- essential tool");
 627
 628         let build_cred = |name, path| {
 629             // These credential helpers are currently experimental.
 630             // Any build failures will be ignored.
 631             let _ = builder.ensure(ToolBuild {
 632                 compiler: self.compiler,
 633                 target: self.target,
 634                 tool: name,
 635                 mode: Mode::ToolRustc,
 636                 path,
 637                 is_optional_tool: true,
 638                 source_type: SourceType::Submodule,
 639                 extra_features: Vec::new(),
 640             });
 641         };
 642
 643         if self.target.contains("windows") {
 644             build_cred(
 645                 "cargo-credential-wincred",
 646                 "src/tools/cargo/crates/credential/cargo-credential-wincred",
 647             );
 648         }
 649         if self.target.contains("apple-darwin") {
 650             build_cred(
 651                 "cargo-credential-macos-keychain",
 652                 "src/tools/cargo/crates/credential/cargo-credential-macos-keychain",
 653             );
 654         }
 655         build_cred(
 656             "cargo-credential-1password",
 657             "src/tools/cargo/crates/credential/cargo-credential-1password",
 658         );
 659         cargo_bin_path
 660     }
 661 }
 662
 663 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 664 pub struct LldWrapper {
 665     pub compiler: Compiler,
 666     pub target: TargetSelection,
 667 }
 668
 669 impl Step for LldWrapper {
 670     type Output = PathBuf;
 671
 672     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 673         run.never()
 674     }
 675
 676     fn run(self, builder: &Builder<'_>) -> PathBuf {
 677         let src_exe = builder
 678             .ensure(ToolBuild {
 679                 compiler: self.compiler,
 680                 target: self.target,
 681                 tool: "lld-wrapper",
 682                 mode: Mode::ToolStd,
 683                 path: "src/tools/lld-wrapper",
 684                 is_optional_tool: false,
 685                 source_type: SourceType::InTree,
 686                 extra_features: Vec::new(),
 687             })
 688             .expect("expected to build -- essential tool");
 689
 690         src_exe
 691     }
 692 }
 693
 694 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 695 pub struct RustAnalyzer {
 696     pub compiler: Compiler,
 697     pub target: TargetSelection,
 698 }
 699
 700 impl Step for RustAnalyzer {
 701     type Output = Option<PathBuf>;
 702     const DEFAULT: bool = true;
 703     const ONLY_HOSTS: bool = true;
 704
 705     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 706         let builder = run.builder;
 707         run.path("src/tools/rust-analyzer").default_condition(
 708             builder.config.extended
 709                 && builder
 710                     .config
 711                     .tools
 712                     .as_ref()
 713                     .map_or(true, |tools| tools.iter().any(|tool| tool == "rust-analyzer")),
 714         )
 715     }
 716
 717     fn make_run(run: RunConfig<'_>) {
 718         run.builder.ensure(RustAnalyzer {
 719             compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
 720             target: run.target,
 721         });
 722     }
 723
 724     fn run(self, builder: &Builder<'_>) -> Option<PathBuf> {
 725         builder.ensure(ToolBuild {
 726             compiler: self.compiler,
 727             target: self.target,
 728             tool: "rust-analyzer",
 729             mode: Mode::ToolStd,
 730             path: "src/tools/rust-analyzer",
 731             extra_features: vec!["rust-analyzer/in-rust-tree".to_owned()],
 732             is_optional_tool: false,
 733             source_type: SourceType::InTree,
 734         })
 735     }
 736 }
 737
 738 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 739 pub struct RustAnalyzerProcMacroSrv {
 740     pub compiler: Compiler,
 741     pub target: TargetSelection,
 742 }
 743
 744 impl Step for RustAnalyzerProcMacroSrv {
 745     type Output = Option<PathBuf>;
 746     const DEFAULT: bool = true;
 747     const ONLY_HOSTS: bool = true;
 748
 749     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 750         // Allow building `rust-analyzer-proc-macro-srv` both as part of the `rust-analyzer` and as a stand-alone tool.
 751         run.path("src/tools/rust-analyzer")
 752             .path("src/tools/rust-analyzer/crates/proc-macro-srv-cli")
 753     }
 754
 755     fn make_run(run: RunConfig<'_>) {
 756         run.builder.ensure(RustAnalyzerProcMacroSrv {
 757             compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
 758             target: run.target,
 759         });
 760     }
 761
 762     fn run(self, builder: &Builder<'_>) -> Option<PathBuf> {
 763         let path = builder.ensure(ToolBuild {
 764             compiler: self.compiler,
 765             target: self.target,
 766             tool: "rust-analyzer-proc-macro-srv",
 767             mode: Mode::ToolStd,
 768             path: "src/tools/rust-analyzer/crates/proc-macro-srv-cli",
 769             extra_features: vec!["proc-macro-srv/sysroot-abi".to_owned()],
 770             is_optional_tool: false,
 771             source_type: SourceType::InTree,
 772         })?;
 773
 774         // Copy `rust-analyzer-proc-macro-srv` to `<sysroot>/libexec/`
 775         // so that r-a can use it.
 776         let libexec_path = builder.sysroot(self.compiler).join("libexec");
 777         t!(fs::create_dir_all(&libexec_path));
 778         builder.copy(&path, &libexec_path.join("rust-analyzer-proc-macro-srv"));
 779
 780         Some(path)
 781     }
 782 }
 783
 784 macro_rules! tool_extended {
 785     (($sel:ident, $builder:ident),
 786        $($name:ident,
 787        $path:expr,
 788        $tool_name:expr,
 789        stable = $stable:expr
 790        $(,tool_std = $tool_std:literal)?
 791        ;)+) => {
 792         $(
 793             #[derive(Debug, Clone, Hash, PartialEq, Eq)]
 794         pub struct $name {
 795             pub compiler: Compiler,
 796             pub target: TargetSelection,
 797             pub extra_features: Vec<String>,
 798         }
 799
 800         impl Step for $name {
 801             type Output = Option<PathBuf>;
 802             const DEFAULT: bool = true; // Overwritten below
 803             const ONLY_HOSTS: bool = true;
 804
 805             fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 806                 let builder = run.builder;
 807                 run.path($path).default_condition(
 808                     builder.config.extended
 809                         && builder.config.tools.as_ref().map_or(
 810                             // By default, on nightly/dev enable all tools, else only
 811                             // build stable tools.
 812                             $stable || builder.build.unstable_features(),
 813                             // If `tools` is set, search list for this tool.
 814                             |tools| {
 815                                 tools.iter().any(|tool| match tool.as_ref() {
 816                                     "clippy" => $tool_name == "clippy-driver",
 817                                     x => $tool_name == x,
 818                             })
 819                         }),
 820                 )
 821             }
 822
 823             fn make_run(run: RunConfig<'_>) {
 824                 run.builder.ensure($name {
 825                     compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
 826                     target: run.target,
 827                     extra_features: Vec::new(),
 828                 });
 829             }
 830
 831             #[allow(unused_mut)]
 832             fn run(mut $sel, $builder: &Builder<'_>) -> Option<PathBuf> {
 833                 $builder.ensure(ToolBuild {
 834                     compiler: $sel.compiler,
 835                     target: $sel.target,
 836                     tool: $tool_name,
 837                     mode: if false $(|| $tool_std)? { Mode::ToolStd } else { Mode::ToolRustc },
 838                     path: $path,
 839                     extra_features: $sel.extra_features,
 840                     is_optional_tool: true,
 841                     source_type: SourceType::InTree,
 842                 })
 843             }
 844         }
 845         )+
 846     }
 847 }
 848
 849 // Note: tools need to be also added to `Builder::get_step_descriptions` in `builder.rs`
 850 // to make `./x.py build <tool>` work.
 851 // Note: Most submodule updates for tools are handled by bootstrap.py, since they're needed just to
 852 // invoke Cargo to build bootstrap. See the comment there for more details.
 853 tool_extended!((self, builder),
 854     Cargofmt, "src/tools/rustfmt", "cargo-fmt", stable=true;
 855     CargoClippy, "src/tools/clippy", "cargo-clippy", stable=true;
 856     Clippy, "src/tools/clippy", "clippy-driver", stable=true;
 857     Miri, "src/tools/miri", "miri", stable=false;
 858     CargoMiri, "src/tools/miri/cargo-miri", "cargo-miri", stable=true;
 859     // FIXME: tool_std is not quite right, we shouldn't allow nightly features.
 860     // But `builder.cargo` doesn't know how to handle ToolBootstrap in stages other than 0,
 861     // and this is close enough for now.
 862     Rls, "src/tools/rls", "rls", stable=true, tool_std=true;
 863     RustDemangler, "src/tools/rust-demangler", "rust-demangler", stable=false, tool_std=true;
 864     Rustfmt, "src/tools/rustfmt", "rustfmt", stable=true;
 865 );
 866
 867 impl<'a> Builder<'a> {
 868     /// Gets a `Command` which is ready to run `tool` in `stage` built for
 869     /// `host`.
 870     pub fn tool_cmd(&self, tool: Tool) -> Command {
 871         let mut cmd = Command::new(self.tool_exe(tool));
 872         let compiler = self.compiler(0, self.config.build);
 873         let host = &compiler.host;
 874         // Prepares the `cmd` provided to be able to run the `compiler` provided.
 875         //
 876         // Notably this munges the dynamic library lookup path to point to the
 877         // right location to run `compiler`.
 878         let mut lib_paths: Vec<PathBuf> = vec![
 879             self.build.rustc_snapshot_libdir(),
 880             self.cargo_out(compiler, Mode::ToolBootstrap, *host).join("deps"),
 881         ];
 882
 883         // On MSVC a tool may invoke a C compiler (e.g., compiletest in run-make
 884         // mode) and that C compiler may need some extra PATH modification. Do
 885         // so here.
 886         if compiler.host.contains("msvc") {
 887             let curpaths = env::var_os("PATH").unwrap_or_default();
 888             let curpaths = env::split_paths(&curpaths).collect::<Vec<_>>();
 889             for &(ref k, ref v) in self.cc[&compiler.host].env() {
 890                 if k != "PATH" {
 891                     continue;
 892                 }
 893                 for path in env::split_paths(v) {
 894                     if !curpaths.contains(&path) {
 895                         lib_paths.push(path);
 896                     }
 897                 }
 898             }
 899         }
 900
 901         add_dylib_path(lib_paths, &mut cmd);
 902
 903         // Provide a RUSTC for this command to use.
 904         cmd.env("RUSTC", &self.initial_rustc);
 905
 906         cmd
 907     }
 908 }