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::{exit, Command};
   6
   7 use build_helper::t;
   8
   9 use crate::builder::{Builder, Cargo as CargoCommand, RunConfig, ShouldRun, Step};
  10 use crate::channel::GitInfo;
  11 use crate::compile;
  12 use crate::config::TargetSelection;
  13 use crate::toolstate::ToolState;
  14 use crate::util::{add_dylib_path, exe};
  15 use crate::Compiler;
  16 use crate::Mode;
  17
  18 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
  19 pub enum SourceType {
  20     InTree,
  21     Submodule,
  22 }
  23
  24 #[derive(Debug, Clone, Hash, PartialEq, Eq)]
  25 struct ToolBuild {
  26     compiler: Compiler,
  27     target: TargetSelection,
  28     tool: &'static str,
  29     path: &'static str,
  30     mode: Mode,
  31     is_optional_tool: bool,
  32     source_type: SourceType,
  33     extra_features: Vec<String>,
  34 }
  35
  36 impl Step for ToolBuild {
  37     type Output = Option<PathBuf>;
  38
  39     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
  40         run.never()
  41     }
  42
  43     /// Builds a tool in `src/tools`
  44     ///
  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;
  51         let path = self.path;
  52         let is_optional_tool = self.is_optional_tool;
  53
  54         match self.mode {
  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"),
  59         }
  60
  61         let cargo = prepare_tool_cargo(
  62             builder,
  63             compiler,
  64             self.mode,
  65             target,
  66             "build",
  67             path,
  68             self.source_type,
  69             &self.extra_features,
  70         );
  71
  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
  76             match tool {
  77                 "rls" | "cargo" | "clippy-driver" | "miri" | "rustfmt" => {}
  78
  79                 _ => return,
  80             }
  81             let (id, features, filenames) = match msg {
  82                 compile::CargoMessage::CompilerArtifact {
  83                     package_id,
  84                     features,
  85                     filenames,
  86                     target: _,
  87                 } => (package_id, features, filenames),
  88                 _ => return,
  89             };
  90             let features = features.iter().map(|s| s.to_string()).collect::<Vec<_>>();
  91
  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") {
  96                     continue;
  97                 }
  98
  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
 104                 // deduplication.
 105                 if let Some(parent) = val.1.parent() {
 106                     if parent.ends_with("release/deps") {
 107                         let maybe_target = parent
 108                             .parent()
 109                             .and_then(|p| p.parent())
 110                             .and_then(|p| p.file_name())
 111                             .and_then(|p| p.to_str())
 112                             .unwrap();
 113                         if maybe_target != &*target.triple {
 114                             continue;
 115                         }
 116                     }
 117                 }
 118
 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) {
 125                     Some(prev) => prev,
 126                     None => {
 127                         prev_artifacts.insert(id.to_string(), val);
 128                         continue;
 129                     }
 130                 };
 131                 if prev.1 == val.1 {
 132                     return; // same path, same artifact
 133                 }
 134
 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 {
 144                     return;
 145                 }
 146
 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()));
 150             }
 151         });
 152
 153         if is_expected && !duplicates.is_empty() {
 154             println!(
 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"
 159             );
 160             println!(
 161                 "the following dependencies are duplicated although they \
 162                       have the same features enabled:"
 163             );
 164             let (same, different): (Vec<_>, Vec<_>) =
 165                 duplicates.into_iter().partition(|(_, cur, prev)| cur.2 == prev.2);
 166             for (id, cur, prev) in same {
 167                 println!("  {}", id);
 168                 // same features
 169                 println!("    `{}` ({:?})\n    `{}` ({:?})", cur.0, cur.1, prev.0, prev.1);
 170             }
 171             println!("the following dependencies have different features:");
 172             for (id, cur, prev) in different {
 173                 println!("  {}", id);
 174                 let cur_features: HashSet<_> = cur.2.into_iter().collect();
 175                 let prev_features: HashSet<_> = prev.2.into_iter().collect();
 176                 println!(
 177                     "    `{}` additionally enabled features {:?} at {:?}",
 178                     cur.0,
 179                     &cur_features - &prev_features,
 180                     cur.1
 181                 );
 182                 println!(
 183                     "    `{}` additionally enabled features {:?} at {:?}",
 184                     prev.0,
 185                     &prev_features - &cur_features,
 186                     prev.1
 187                 );
 188             }
 189             println!();
 190             println!(
 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"
 195             );
 196             panic!("tools should not compile multiple copies of the same crate");
 197         }
 198
 199         builder.save_toolstate(
 200             tool,
 201             if is_expected { ToolState::TestFail } else { ToolState::BuildFail },
 202         );
 203
 204         if !is_expected {
 205             if !is_optional_tool {
 206                 exit(1);
 207             } else {
 208                 None
 209             }
 210         } else {
 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.
 214             if tool == "tidy" {
 215                 tool = "rust-tidy";
 216             }
 217             let cargo_out =
 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);
 221             Some(bin)
 222         }
 223     }
 224 }
 225
 226 pub fn prepare_tool_cargo(
 227     builder: &Builder<'_>,
 228     compiler: Compiler,
 229     mode: Mode,
 230     target: TargetSelection,
 231     command: &'static str,
 232     path: &'static str,
 233     source_type: SourceType,
 234     extra_features: &[String],
 235 ) -> CargoCommand {
 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"));
 239
 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")
 247         {
 248             cargo.env("LIBZ_SYS_STATIC", "1");
 249             features.push("rustc-workspace-hack/all-static".to_string());
 250         }
 251     }
 252
 253     // if tools are using lzma we want to force the build script to build its
 254     // own copy
 255     cargo.env("LZMA_API_STATIC", "1");
 256
 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);
 264
 265     let info = GitInfo::new(builder.config.ignore_git, &dir);
 266     if let Some(sha) = info.sha() {
 267         cargo.env("CFG_COMMIT_HASH", sha);
 268     }
 269     if let Some(sha_short) = info.sha_short() {
 270         cargo.env("CFG_SHORT_COMMIT_HASH", sha_short);
 271     }
 272     if let Some(date) = info.commit_date() {
 273         cargo.env("CFG_COMMIT_DATE", date);
 274     }
 275     if !features.is_empty() {
 276         cargo.arg("--features").arg(&features.join(", "));
 277     }
 278     cargo
 279 }
 280
 281 macro_rules! bootstrap_tool {
 282     ($(
 283         $name:ident, $path:expr, $tool_name:expr
 284         $(,is_external_tool = $external:expr)*
 285         $(,is_unstable_tool = $unstable:expr)*
 286         $(,features = $features:expr)*
 287         ;
 288     )+) => {
 289         #[derive(Copy, PartialEq, Eq, Clone)]
 290         pub enum Tool {
 291             $(
 292                 $name,
 293             )+
 294         }
 295
 296         impl<'a> Builder<'a> {
 297             pub fn tool_exe(&self, tool: Tool) -> PathBuf {
 298                 match tool {
 299                     $(Tool::$name =>
 300                         self.ensure($name {
 301                             compiler: self.compiler(0, self.config.build),
 302                             target: self.config.build,
 303                         }),
 304                     )+
 305                 }
 306             }
 307         }
 308
 309         $(
 310             #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 311         pub struct $name {
 312             pub compiler: Compiler,
 313             pub target: TargetSelection,
 314         }
 315
 316         impl Step for $name {
 317             type Output = PathBuf;
 318
 319             fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 320                 run.path($path)
 321             }
 322
 323             fn make_run(run: RunConfig<'_>) {
 324                 run.builder.ensure($name {
 325                     // snapshot compiler
 326                     compiler: run.builder.compiler(0, run.builder.config.build),
 327                     target: run.target,
 328                 });
 329             }
 330
 331             fn run(self, builder: &Builder<'_>) -> PathBuf {
 332                 builder.ensure(ToolBuild {
 333                     compiler: self.compiler,
 334                     target: self.target,
 335                     tool: $tool_name,
 336                     mode: if false $(|| $unstable)* {
 337                         // use in-tree libraries for unstable features
 338                         Mode::ToolStd
 339                     } else {
 340                         Mode::ToolBootstrap
 341                     },
 342                     path: $path,
 343                     is_optional_tool: false,
 344                     source_type: if false $(|| $external)* {
 345                         SourceType::Submodule
 346                     } else {
 347                         SourceType::InTree
 348                     },
 349                     extra_features: {
 350                         // FIXME(#60643): avoid this lint by using `_`
 351                         let mut _tmp = Vec::new();
 352                         $(_tmp.extend($features);)*
 353                         _tmp
 354                     },
 355                 }).expect("expected to build -- essential tool")
 356             }
 357         }
 358         )+
 359     }
 360 }
 361
 362 bootstrap_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     RustDemangler, "src/tools/rust-demangler", "rust-demangler";
 372     RustInstaller, "src/tools/rust-installer", "fabricate", is_external_tool = true;
 373     RustdocTheme, "src/tools/rustdoc-themes", "rustdoc-themes";
 374     ExpandYamlAnchors, "src/tools/expand-yaml-anchors", "expand-yaml-anchors";
 375     LintDocs, "src/tools/lint-docs", "lint-docs";
 376     JsonDocCk, "src/tools/jsondocck", "jsondocck";
 377 );
 378
 379 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
 380 pub struct ErrorIndex {
 381     pub compiler: Compiler,
 382 }
 383
 384 impl ErrorIndex {
 385     pub fn command(builder: &Builder<'_>) -> Command {
 386         // This uses stage-1 to match the behavior of building rustdoc.
 387         // Error-index-generator links with the rustdoc library, so we want to
 388         // use the same librustdoc to avoid building rustdoc twice (and to
 389         // avoid building the compiler an extra time). This uses
 390         // saturating_sub to deal with building with stage 0. (Using stage 0
 391         // isn't recommended, since it will fail if any new error index tests
 392         // use new syntax, but it should work otherwise.)
 393         let compiler = builder.compiler(builder.top_stage.saturating_sub(1), builder.config.build);
 394         let mut cmd = Command::new(builder.ensure(ErrorIndex { compiler }));
 395         add_dylib_path(
 396             vec![PathBuf::from(&builder.sysroot_libdir(compiler, compiler.host))],
 397             &mut cmd,
 398         );
 399         cmd
 400     }
 401 }
 402
 403 impl Step for ErrorIndex {
 404     type Output = PathBuf;
 405
 406     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 407         run.path("src/tools/error_index_generator")
 408     }
 409
 410     fn make_run(run: RunConfig<'_>) {
 411         // Compile the error-index in the same stage as rustdoc to avoid
 412         // recompiling rustdoc twice if we can.
 413         //
 414         // NOTE: This `make_run` isn't used in normal situations, only if you
 415         // manually build the tool with `x.py build
 416         // src/tools/error-index-generator` which almost nobody does.
 417         // Normally, `x.py test` or `x.py doc` will use the
 418         // `ErrorIndex::command` function instead.
 419         let compiler =
 420             run.builder.compiler(run.builder.top_stage.saturating_sub(1), run.builder.config.build);
 421         run.builder.ensure(ErrorIndex { compiler });
 422     }
 423
 424     fn run(self, builder: &Builder<'_>) -> PathBuf {
 425         builder
 426             .ensure(ToolBuild {
 427                 compiler: self.compiler,
 428                 target: self.compiler.host,
 429                 tool: "error_index_generator",
 430                 mode: Mode::ToolRustc,
 431                 path: "src/tools/error_index_generator",
 432                 is_optional_tool: false,
 433                 source_type: SourceType::InTree,
 434                 extra_features: Vec::new(),
 435             })
 436             .expect("expected to build -- essential tool")
 437     }
 438 }
 439
 440 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 441 pub struct RemoteTestServer {
 442     pub compiler: Compiler,
 443     pub target: TargetSelection,
 444 }
 445
 446 impl Step for RemoteTestServer {
 447     type Output = PathBuf;
 448
 449     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 450         run.path("src/tools/remote-test-server")
 451     }
 452
 453     fn make_run(run: RunConfig<'_>) {
 454         run.builder.ensure(RemoteTestServer {
 455             compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
 456             target: run.target,
 457         });
 458     }
 459
 460     fn run(self, builder: &Builder<'_>) -> PathBuf {
 461         builder
 462             .ensure(ToolBuild {
 463                 compiler: self.compiler,
 464                 target: self.target,
 465                 tool: "remote-test-server",
 466                 mode: Mode::ToolStd,
 467                 path: "src/tools/remote-test-server",
 468                 is_optional_tool: false,
 469                 source_type: SourceType::InTree,
 470                 extra_features: Vec::new(),
 471             })
 472             .expect("expected to build -- essential tool")
 473     }
 474 }
 475
 476 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
 477 pub struct Rustdoc {
 478     /// This should only ever be 0 or 2.
 479     /// We sometimes want to reference the "bootstrap" rustdoc, which is why this option is here.
 480     pub compiler: Compiler,
 481 }
 482
 483 impl Step for Rustdoc {
 484     type Output = PathBuf;
 485     const DEFAULT: bool = true;
 486     const ONLY_HOSTS: bool = true;
 487
 488     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 489         run.path("src/tools/rustdoc").path("src/librustdoc")
 490     }
 491
 492     fn make_run(run: RunConfig<'_>) {
 493         run.builder.ensure(Rustdoc {
 494             // Note: this is somewhat unique in that we actually want a *target*
 495             // compiler here, because rustdoc *is* a compiler. We won't be using
 496             // this as the compiler to build with, but rather this is "what
 497             // compiler are we producing"?
 498             compiler: run.builder.compiler(run.builder.top_stage, run.target),
 499         });
 500     }
 501
 502     fn run(self, builder: &Builder<'_>) -> PathBuf {
 503         let target_compiler = self.compiler;
 504         if target_compiler.stage == 0 {
 505             if !target_compiler.is_snapshot(builder) {
 506                 panic!("rustdoc in stage 0 must be snapshot rustdoc");
 507             }
 508             return builder.initial_rustc.with_file_name(exe("rustdoc", target_compiler.host));
 509         }
 510         let target = target_compiler.host;
 511         // Similar to `compile::Assemble`, build with the previous stage's compiler. Otherwise
 512         // we'd have stageN/bin/rustc and stageN/bin/rustdoc be effectively different stage
 513         // compilers, which isn't what we want. Rustdoc should be linked in the same way as the
 514         // rustc compiler it's paired with, so it must be built with the previous stage compiler.
 515         let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
 516
 517         // The presence of `target_compiler` ensures that the necessary libraries (codegen backends,
 518         // compiler libraries, ...) are built. Rustdoc does not require the presence of any
 519         // libraries within sysroot_libdir (i.e., rustlib), though doctests may want it (since
 520         // they'll be linked to those libraries). As such, don't explicitly `ensure` any additional
 521         // libraries here. The intuition here is that If we've built a compiler, we should be able
 522         // to build rustdoc.
 523
 524         let cargo = prepare_tool_cargo(
 525             builder,
 526             build_compiler,
 527             Mode::ToolRustc,
 528             target,
 529             "build",
 530             "src/tools/rustdoc",
 531             SourceType::InTree,
 532             &[],
 533         );
 534
 535         builder.info(&format!(
 536             "Building rustdoc for stage{} ({})",
 537             target_compiler.stage, target_compiler.host
 538         ));
 539         builder.run(&mut cargo.into());
 540
 541         // Cargo adds a number of paths to the dylib search path on windows, which results in
 542         // the wrong rustdoc being executed. To avoid the conflicting rustdocs, we name the "tool"
 543         // rustdoc a different name.
 544         let tool_rustdoc = builder
 545             .cargo_out(build_compiler, Mode::ToolRustc, target)
 546             .join(exe("rustdoc_tool_binary", target_compiler.host));
 547
 548         // don't create a stage0-sysroot/bin directory.
 549         if target_compiler.stage > 0 {
 550             let sysroot = builder.sysroot(target_compiler);
 551             let bindir = sysroot.join("bin");
 552             t!(fs::create_dir_all(&bindir));
 553             let bin_rustdoc = bindir.join(exe("rustdoc", target_compiler.host));
 554             let _ = fs::remove_file(&bin_rustdoc);
 555             builder.copy(&tool_rustdoc, &bin_rustdoc);
 556             bin_rustdoc
 557         } else {
 558             tool_rustdoc
 559         }
 560     }
 561 }
 562
 563 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 564 pub struct Cargo {
 565     pub compiler: Compiler,
 566     pub target: TargetSelection,
 567 }
 568
 569 impl Step for Cargo {
 570     type Output = PathBuf;
 571     const DEFAULT: bool = true;
 572     const ONLY_HOSTS: bool = true;
 573
 574     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 575         let builder = run.builder;
 576         run.path("src/tools/cargo").default_condition(builder.config.extended)
 577     }
 578
 579     fn make_run(run: RunConfig<'_>) {
 580         run.builder.ensure(Cargo {
 581             compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
 582             target: run.target,
 583         });
 584     }
 585
 586     fn run(self, builder: &Builder<'_>) -> PathBuf {
 587         let cargo_bin_path = builder
 588             .ensure(ToolBuild {
 589                 compiler: self.compiler,
 590                 target: self.target,
 591                 tool: "cargo",
 592                 mode: Mode::ToolRustc,
 593                 path: "src/tools/cargo",
 594                 is_optional_tool: false,
 595                 source_type: SourceType::Submodule,
 596                 extra_features: Vec::new(),
 597             })
 598             .expect("expected to build -- essential tool");
 599
 600         let build_cred = |name, path| {
 601             // These credential helpers are currently experimental.
 602             // Any build failures will be ignored.
 603             let _ = builder.ensure(ToolBuild {
 604                 compiler: self.compiler,
 605                 target: self.target,
 606                 tool: name,
 607                 mode: Mode::ToolRustc,
 608                 path,
 609                 is_optional_tool: true,
 610                 source_type: SourceType::Submodule,
 611                 extra_features: Vec::new(),
 612             });
 613         };
 614
 615         if self.target.contains("windows") {
 616             build_cred(
 617                 "cargo-credential-wincred",
 618                 "src/tools/cargo/crates/credential/cargo-credential-wincred",
 619             );
 620         }
 621         if self.target.contains("apple-darwin") {
 622             build_cred(
 623                 "cargo-credential-macos-keychain",
 624                 "src/tools/cargo/crates/credential/cargo-credential-macos-keychain",
 625             );
 626         }
 627         build_cred(
 628             "cargo-credential-1password",
 629             "src/tools/cargo/crates/credential/cargo-credential-1password",
 630         );
 631         cargo_bin_path
 632     }
 633 }
 634
 635 macro_rules! tool_extended {
 636     (($sel:ident, $builder:ident),
 637        $($name:ident,
 638        $toolstate:ident,
 639        $path:expr,
 640        $tool_name:expr,
 641        stable = $stable:expr,
 642        $(in_tree = $in_tree:expr,)*
 643        $extra_deps:block;)+) => {
 644         $(
 645             #[derive(Debug, Clone, Hash, PartialEq, Eq)]
 646         pub struct $name {
 647             pub compiler: Compiler,
 648             pub target: TargetSelection,
 649             pub extra_features: Vec<String>,
 650         }
 651
 652         impl Step for $name {
 653             type Output = Option<PathBuf>;
 654             const DEFAULT: bool = true; // Overwritten below
 655             const ONLY_HOSTS: bool = true;
 656
 657             fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 658                 let builder = run.builder;
 659                 run.path($path).default_condition(
 660                     builder.config.extended
 661                         && builder.config.tools.as_ref().map_or(
 662                             // By default, on nightly/dev enable all tools, else only
 663                             // build stable tools.
 664                             $stable || builder.build.unstable_features(),
 665                             // If `tools` is set, search list for this tool.
 666                             |tools| {
 667                                 tools.iter().any(|tool| match tool.as_ref() {
 668                                     "clippy" => $tool_name == "clippy-driver",
 669                                     x => $tool_name == x,
 670                             })
 671                         }),
 672                 )
 673             }
 674
 675             fn make_run(run: RunConfig<'_>) {
 676                 run.builder.ensure($name {
 677                     compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
 678                     target: run.target,
 679                     extra_features: Vec::new(),
 680                 });
 681             }
 682
 683             #[allow(unused_mut)]
 684             fn run(mut $sel, $builder: &Builder<'_>) -> Option<PathBuf> {
 685                 $extra_deps
 686                 $builder.ensure(ToolBuild {
 687                     compiler: $sel.compiler,
 688                     target: $sel.target,
 689                     tool: $tool_name,
 690                     mode: Mode::ToolRustc,
 691                     path: $path,
 692                     extra_features: $sel.extra_features,
 693                     is_optional_tool: true,
 694                     source_type: if false $(|| $in_tree)* {
 695                         SourceType::InTree
 696                     } else {
 697                         SourceType::Submodule
 698                     },
 699                 })
 700             }
 701         }
 702         )+
 703     }
 704 }
 705
 706 // Note: tools need to be also added to `Builder::get_step_descriptions` in `builder.rs`
 707 // to make `./x.py build <tool>` work.
 708 tool_extended!((self, builder),
 709     Cargofmt, rustfmt, "src/tools/rustfmt", "cargo-fmt", stable=true, {};
 710     CargoClippy, clippy, "src/tools/clippy", "cargo-clippy", stable=true, in_tree=true, {};
 711     Clippy, clippy, "src/tools/clippy", "clippy-driver", stable=true, in_tree=true, {};
 712     Miri, miri, "src/tools/miri", "miri", stable=false, {};
 713     CargoMiri, miri, "src/tools/miri/cargo-miri", "cargo-miri", stable=false, {};
 714     Rls, rls, "src/tools/rls", "rls", stable=true, {
 715         builder.ensure(Clippy {
 716             compiler: self.compiler,
 717             target: self.target,
 718             extra_features: Vec::new(),
 719         });
 720         self.extra_features.push("clippy".to_owned());
 721     };
 722     Rustfmt, rustfmt, "src/tools/rustfmt", "rustfmt", stable=true, {};
 723     RustAnalyzer, rust_analyzer, "src/tools/rust-analyzer/crates/rust-analyzer", "rust-analyzer", stable=false, {};
 724 );
 725
 726 impl<'a> Builder<'a> {
 727     /// Gets a `Command` which is ready to run `tool` in `stage` built for
 728     /// `host`.
 729     pub fn tool_cmd(&self, tool: Tool) -> Command {
 730         let mut cmd = Command::new(self.tool_exe(tool));
 731         let compiler = self.compiler(0, self.config.build);
 732         let host = &compiler.host;
 733         // Prepares the `cmd` provided to be able to run the `compiler` provided.
 734         //
 735         // Notably this munges the dynamic library lookup path to point to the
 736         // right location to run `compiler`.
 737         let mut lib_paths: Vec<PathBuf> = vec![
 738             self.build.rustc_snapshot_libdir(),
 739             self.cargo_out(compiler, Mode::ToolBootstrap, *host).join("deps"),
 740         ];
 741
 742         // On MSVC a tool may invoke a C compiler (e.g., compiletest in run-make
 743         // mode) and that C compiler may need some extra PATH modification. Do
 744         // so here.
 745         if compiler.host.contains("msvc") {
 746             let curpaths = env::var_os("PATH").unwrap_or_default();
 747             let curpaths = env::split_paths(&curpaths).collect::<Vec<_>>();
 748             for &(ref k, ref v) in self.cc[&compiler.host].env() {
 749                 if k != "PATH" {
 750                     continue;
 751                 }
 752                 for path in env::split_paths(v) {
 753                     if !curpaths.contains(&path) {
 754                         lib_paths.push(path);
 755                     }
 756                 }
 757             }
 758         }
 759
 760         add_dylib_path(lib_paths, &mut cmd);
 761
 762         // Provide a RUSTC for this command to use.
 763         cmd.env("RUSTC", &self.initial_rustc);
 764
 765         cmd
 766     }
 767 }