src/bootstrap/tool.rs

   1 use std::collections::HashSet;
   2 use std::env;
   3 use std::fs;
   4 use std::path::{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 => {
  56                 builder.ensure(compile::Std { compiler, target: compiler.host });
  57                 builder.ensure(compile::Rustc { compiler, target });
  58             }
  59             Mode::ToolStd => builder.ensure(compile::Std { compiler, target }),
  60             Mode::ToolBootstrap => {} // uses downloaded stage0 compiler libs
  61             _ => panic!("unexpected Mode for tool build"),
  62         }
  63
  64         let cargo = prepare_tool_cargo(
  65             builder,
  66             compiler,
  67             self.mode,
  68             target,
  69             "build",
  70             path,
  71             self.source_type,
  72             &self.extra_features,
  73         );
  74
  75         builder.info(&format!("Building stage{} tool {} ({})", compiler.stage, tool, target));
  76         let mut duplicates = Vec::new();
  77         let is_expected = compile::stream_cargo(builder, cargo, vec![], &mut |msg| {
  78             // Only care about big things like the RLS/Cargo for now
  79             match tool {
  80                 "rls" | "cargo" | "clippy-driver" | "miri" | "rustfmt" => {}
  81
  82                 _ => return,
  83             }
  84             let (id, features, filenames) = match msg {
  85                 compile::CargoMessage::CompilerArtifact {
  86                     package_id,
  87                     features,
  88                     filenames,
  89                     target: _,
  90                 } => (package_id, features, filenames),
  91                 _ => return,
  92             };
  93             let features = features.iter().map(|s| s.to_string()).collect::<Vec<_>>();
  94
  95             for path in filenames {
  96                 let val = (tool, PathBuf::from(&*path), features.clone());
  97                 // we're only interested in deduplicating rlibs for now
  98                 if val.1.extension().and_then(|s| s.to_str()) != Some("rlib") {
  99                     continue;
 100                 }
 101
 102                 // Don't worry about compiles that turn out to be host
 103                 // dependencies or build scripts. To skip these we look for
 104                 // anything that goes in `.../release/deps` but *doesn't* go in
 105                 // `$target/release/deps`. This ensure that outputs in
 106                 // `$target/release` are still considered candidates for
 107                 // deduplication.
 108                 if let Some(parent) = val.1.parent() {
 109                     if parent.ends_with("release/deps") {
 110                         let maybe_target = parent
 111                             .parent()
 112                             .and_then(|p| p.parent())
 113                             .and_then(|p| p.file_name())
 114                             .and_then(|p| p.to_str())
 115                             .unwrap();
 116                         if maybe_target != &*target.triple {
 117                             continue;
 118                         }
 119                     }
 120                 }
 121
 122                 // Record that we've built an artifact for `id`, and if one was
 123                 // already listed then we need to see if we reused the same
 124                 // artifact or produced a duplicate.
 125                 let mut artifacts = builder.tool_artifacts.borrow_mut();
 126                 let prev_artifacts = artifacts.entry(target).or_default();
 127                 let prev = match prev_artifacts.get(&*id) {
 128                     Some(prev) => prev,
 129                     None => {
 130                         prev_artifacts.insert(id.to_string(), val);
 131                         continue;
 132                     }
 133                 };
 134                 if prev.1 == val.1 {
 135                     return; // same path, same artifact
 136                 }
 137
 138                 // If the paths are different and one of them *isn't* inside of
 139                 // `release/deps`, then it means it's probably in
 140                 // `$target/release`, or it's some final artifact like
 141                 // `libcargo.rlib`. In these situations Cargo probably just
 142                 // copied it up from `$target/release/deps/libcargo-xxxx.rlib`,
 143                 // so if the features are equal we can just skip it.
 144                 let prev_no_hash = prev.1.parent().unwrap().ends_with("release/deps");
 145                 let val_no_hash = val.1.parent().unwrap().ends_with("release/deps");
 146                 if prev.2 == val.2 || !prev_no_hash || !val_no_hash {
 147                     return;
 148                 }
 149
 150                 // ... and otherwise this looks like we duplicated some sort of
 151                 // compilation, so record it to generate an error later.
 152                 duplicates.push((id.to_string(), val, prev.clone()));
 153             }
 154         });
 155
 156         if is_expected && !duplicates.is_empty() {
 157             println!(
 158                 "duplicate artifacts found when compiling a tool, this \
 159                       typically means that something was recompiled because \
 160                       a transitive dependency has different features activated \
 161                       than in a previous build:\n"
 162             );
 163             println!(
 164                 "the following dependencies are duplicated although they \
 165                       have the same features enabled:"
 166             );
 167             let (same, different): (Vec<_>, Vec<_>) =
 168                 duplicates.into_iter().partition(|(_, cur, prev)| cur.2 == prev.2);
 169             for (id, cur, prev) in same {
 170                 println!("  {}", id);
 171                 // same features
 172                 println!("    `{}` ({:?})\n    `{}` ({:?})", cur.0, cur.1, prev.0, prev.1);
 173             }
 174             println!("the following dependencies have different features:");
 175             for (id, cur, prev) in different {
 176                 println!("  {}", id);
 177                 let cur_features: HashSet<_> = cur.2.into_iter().collect();
 178                 let prev_features: HashSet<_> = prev.2.into_iter().collect();
 179                 println!(
 180                     "    `{}` additionally enabled features {:?} at {:?}",
 181                     cur.0,
 182                     &cur_features - &prev_features,
 183                     cur.1
 184                 );
 185                 println!(
 186                     "    `{}` additionally enabled features {:?} at {:?}",
 187                     prev.0,
 188                     &prev_features - &cur_features,
 189                     prev.1
 190                 );
 191             }
 192             println!();
 193             println!(
 194                 "to fix this you will probably want to edit the local \
 195                       src/tools/rustc-workspace-hack/Cargo.toml crate, as \
 196                       that will update the dependency graph to ensure that \
 197                       these crates all share the same feature set"
 198             );
 199             panic!("tools should not compile multiple copies of the same crate");
 200         }
 201
 202         builder.save_toolstate(
 203             tool,
 204             if is_expected { ToolState::TestFail } else { ToolState::BuildFail },
 205         );
 206
 207         if !is_expected {
 208             if !is_optional_tool {
 209                 exit(1);
 210             } else {
 211                 None
 212             }
 213         } else {
 214             // HACK(#82501): on Windows, the tools directory gets added to PATH when running tests, and
 215             // compiletest confuses HTML tidy with the in-tree tidy. Name the in-tree tidy something
 216             // different so the problem doesn't come up.
 217             if tool == "tidy" {
 218                 tool = "rust-tidy";
 219             }
 220             let cargo_out = builder.cargo_out(compiler, self.mode, target).join(exe(tool, target));
 221             let bin = builder.tools_dir(compiler).join(exe(tool, target));
 222             builder.copy(&cargo_out, &bin);
 223             Some(bin)
 224         }
 225     }
 226 }
 227
 228 pub fn prepare_tool_cargo(
 229     builder: &Builder<'_>,
 230     compiler: Compiler,
 231     mode: Mode,
 232     target: TargetSelection,
 233     command: &'static str,
 234     path: &'static str,
 235     source_type: SourceType,
 236     extra_features: &[String],
 237 ) -> CargoCommand {
 238     let mut cargo = builder.cargo(compiler, mode, source_type, target, command);
 239     let dir = builder.src.join(path);
 240     cargo.arg("--manifest-path").arg(dir.join("Cargo.toml"));
 241
 242     let mut features = extra_features.to_vec();
 243     if builder.build.config.cargo_native_static {
 244         if path.ends_with("cargo")
 245             || path.ends_with("rls")
 246             || path.ends_with("clippy")
 247             || path.ends_with("miri")
 248             || path.ends_with("rustfmt")
 249         {
 250             cargo.env("LIBZ_SYS_STATIC", "1");
 251             features.push("rustc-workspace-hack/all-static".to_string());
 252         }
 253     }
 254
 255     // if tools are using lzma we want to force the build script to build its
 256     // own copy
 257     cargo.env("LZMA_API_STATIC", "1");
 258
 259     // CFG_RELEASE is needed by rustfmt (and possibly other tools) which
 260     // import rustc-ap-rustc_attr which requires this to be set for the
 261     // `#[cfg(version(...))]` attribute.
 262     cargo.env("CFG_RELEASE", builder.rust_release());
 263     cargo.env("CFG_RELEASE_CHANNEL", &builder.config.channel);
 264     cargo.env("CFG_VERSION", builder.rust_version());
 265     cargo.env("CFG_RELEASE_NUM", &builder.version);
 266     cargo.env("DOC_RUST_LANG_ORG_CHANNEL", builder.doc_rust_lang_org_channel());
 267
 268     let info = GitInfo::new(builder.config.ignore_git, &dir);
 269     if let Some(sha) = info.sha() {
 270         cargo.env("CFG_COMMIT_HASH", sha);
 271     }
 272     if let Some(sha_short) = info.sha_short() {
 273         cargo.env("CFG_SHORT_COMMIT_HASH", sha_short);
 274     }
 275     if let Some(date) = info.commit_date() {
 276         cargo.env("CFG_COMMIT_DATE", date);
 277     }
 278     if !features.is_empty() {
 279         cargo.arg("--features").arg(&features.join(", "));
 280     }
 281     cargo
 282 }
 283
 284 macro_rules! bootstrap_tool {
 285     ($(
 286         $name:ident, $path:expr, $tool_name:expr
 287         $(,is_external_tool = $external:expr)*
 288         $(,is_unstable_tool = $unstable:expr)*
 289         $(,features = $features:expr)*
 290         ;
 291     )+) => {
 292         #[derive(Copy, PartialEq, Eq, Clone)]
 293         pub enum Tool {
 294             $(
 295                 $name,
 296             )+
 297         }
 298
 299         impl<'a> Builder<'a> {
 300             pub fn tool_exe(&self, tool: Tool) -> PathBuf {
 301                 match tool {
 302                     $(Tool::$name =>
 303                         self.ensure($name {
 304                             compiler: self.compiler(0, self.config.build),
 305                             target: self.config.build,
 306                         }),
 307                     )+
 308                 }
 309             }
 310         }
 311
 312         $(
 313             #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 314         pub struct $name {
 315             pub compiler: Compiler,
 316             pub target: TargetSelection,
 317         }
 318
 319         impl Step for $name {
 320             type Output = PathBuf;
 321
 322             fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 323                 run.path($path)
 324             }
 325
 326             fn make_run(run: RunConfig<'_>) {
 327                 run.builder.ensure($name {
 328                     // snapshot compiler
 329                     compiler: run.builder.compiler(0, run.builder.config.build),
 330                     target: run.target,
 331                 });
 332             }
 333
 334             fn run(self, builder: &Builder<'_>) -> PathBuf {
 335                 builder.ensure(ToolBuild {
 336                     compiler: self.compiler,
 337                     target: self.target,
 338                     tool: $tool_name,
 339                     mode: if false $(|| $unstable)* {
 340                         // use in-tree libraries for unstable features
 341                         Mode::ToolStd
 342                     } else {
 343                         Mode::ToolBootstrap
 344                     },
 345                     path: $path,
 346                     is_optional_tool: false,
 347                     source_type: if false $(|| $external)* {
 348                         SourceType::Submodule
 349                     } else {
 350                         SourceType::InTree
 351                     },
 352                     extra_features: {
 353                         // FIXME(#60643): avoid this lint by using `_`
 354                         let mut _tmp = Vec::new();
 355                         $(_tmp.extend($features);)*
 356                         _tmp
 357                     },
 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", "fabricate", 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     HtmlChecker, "src/tools/html-checker", "html-checker";
 380 );
 381
 382 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
 383 pub struct ErrorIndex {
 384     pub compiler: Compiler,
 385 }
 386
 387 impl ErrorIndex {
 388     pub fn command(builder: &Builder<'_>) -> Command {
 389         // This uses stage-1 to match the behavior of building rustdoc.
 390         // Error-index-generator links with the rustdoc library, so we want to
 391         // use the same librustdoc to avoid building rustdoc twice (and to
 392         // avoid building the compiler an extra time). This uses
 393         // saturating_sub to deal with building with stage 0. (Using stage 0
 394         // isn't recommended, since it will fail if any new error index tests
 395         // use new syntax, but it should work otherwise.)
 396         let compiler = builder.compiler(builder.top_stage.saturating_sub(1), builder.config.build);
 397         let mut cmd = Command::new(builder.ensure(ErrorIndex { compiler }));
 398         add_dylib_path(
 399             vec![
 400                 PathBuf::from(&builder.sysroot_libdir(compiler, compiler.host)),
 401                 PathBuf::from(builder.rustc_libdir(compiler)),
 402             ],
 403             &mut cmd,
 404         );
 405         cmd
 406     }
 407 }
 408
 409 impl Step for ErrorIndex {
 410     type Output = PathBuf;
 411
 412     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 413         run.path("src/tools/error_index_generator")
 414     }
 415
 416     fn make_run(run: RunConfig<'_>) {
 417         // Compile the error-index in the same stage as rustdoc to avoid
 418         // recompiling rustdoc twice if we can.
 419         //
 420         // NOTE: This `make_run` isn't used in normal situations, only if you
 421         // manually build the tool with `x.py build
 422         // src/tools/error-index-generator` which almost nobody does.
 423         // Normally, `x.py test` or `x.py doc` will use the
 424         // `ErrorIndex::command` function instead.
 425         let compiler =
 426             run.builder.compiler(run.builder.top_stage.saturating_sub(1), run.builder.config.build);
 427         run.builder.ensure(ErrorIndex { compiler });
 428     }
 429
 430     fn run(self, builder: &Builder<'_>) -> PathBuf {
 431         builder
 432             .ensure(ToolBuild {
 433                 compiler: self.compiler,
 434                 target: self.compiler.host,
 435                 tool: "error_index_generator",
 436                 mode: Mode::ToolRustc,
 437                 path: "src/tools/error_index_generator",
 438                 is_optional_tool: false,
 439                 source_type: SourceType::InTree,
 440                 extra_features: Vec::new(),
 441             })
 442             .expect("expected to build -- essential tool")
 443     }
 444 }
 445
 446 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 447 pub struct RemoteTestServer {
 448     pub compiler: Compiler,
 449     pub target: TargetSelection,
 450 }
 451
 452 impl Step for RemoteTestServer {
 453     type Output = PathBuf;
 454
 455     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 456         run.path("src/tools/remote-test-server")
 457     }
 458
 459     fn make_run(run: RunConfig<'_>) {
 460         run.builder.ensure(RemoteTestServer {
 461             compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
 462             target: run.target,
 463         });
 464     }
 465
 466     fn run(self, builder: &Builder<'_>) -> PathBuf {
 467         builder
 468             .ensure(ToolBuild {
 469                 compiler: self.compiler,
 470                 target: self.target,
 471                 tool: "remote-test-server",
 472                 mode: Mode::ToolStd,
 473                 path: "src/tools/remote-test-server",
 474                 is_optional_tool: false,
 475                 source_type: SourceType::InTree,
 476                 extra_features: Vec::new(),
 477             })
 478             .expect("expected to build -- essential tool")
 479     }
 480 }
 481
 482 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
 483 pub struct Rustdoc {
 484     /// This should only ever be 0 or 2.
 485     /// We sometimes want to reference the "bootstrap" rustdoc, which is why this option is here.
 486     pub compiler: Compiler,
 487 }
 488
 489 impl Step for Rustdoc {
 490     type Output = PathBuf;
 491     const DEFAULT: bool = true;
 492     const ONLY_HOSTS: bool = true;
 493
 494     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 495         run.path("src/tools/rustdoc").path("src/librustdoc")
 496     }
 497
 498     fn make_run(run: RunConfig<'_>) {
 499         run.builder.ensure(Rustdoc {
 500             // Note: this is somewhat unique in that we actually want a *target*
 501             // compiler here, because rustdoc *is* a compiler. We won't be using
 502             // this as the compiler to build with, but rather this is "what
 503             // compiler are we producing"?
 504             compiler: run.builder.compiler(run.builder.top_stage, run.target),
 505         });
 506     }
 507
 508     fn run(self, builder: &Builder<'_>) -> PathBuf {
 509         let target_compiler = self.compiler;
 510         if target_compiler.stage == 0 {
 511             if !target_compiler.is_snapshot(builder) {
 512                 panic!("rustdoc in stage 0 must be snapshot rustdoc");
 513             }
 514             return builder.initial_rustc.with_file_name(exe("rustdoc", target_compiler.host));
 515         }
 516         let target = target_compiler.host;
 517         // Similar to `compile::Assemble`, build with the previous stage's compiler. Otherwise
 518         // we'd have stageN/bin/rustc and stageN/bin/rustdoc be effectively different stage
 519         // compilers, which isn't what we want. Rustdoc should be linked in the same way as the
 520         // rustc compiler it's paired with, so it must be built with the previous stage compiler.
 521         let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
 522
 523         // When using `download-rustc` and a stage0 build_compiler, copying rustc doesn't actually
 524         // build stage0 libstd (because the libstd in sysroot has the wrong ABI). Explicitly build
 525         // it.
 526         builder.ensure(compile::Std { compiler: build_compiler, target: target_compiler.host });
 527         builder.ensure(compile::Rustc { compiler: build_compiler, target: target_compiler.host });
 528         // NOTE: this implies that `download-rustc` is pretty useless when compiling with the stage0
 529         // compiler, since you do just as much work.
 530         if !builder.config.dry_run && builder.config.download_rustc && build_compiler.stage == 0 {
 531             println!(
 532                 "warning: `download-rustc` does nothing when building stage1 tools; consider using `--stage 2` instead"
 533             );
 534         }
 535
 536         // The presence of `target_compiler` ensures that the necessary libraries (codegen backends,
 537         // compiler libraries, ...) are built. Rustdoc does not require the presence of any
 538         // libraries within sysroot_libdir (i.e., rustlib), though doctests may want it (since
 539         // they'll be linked to those libraries). As such, don't explicitly `ensure` any additional
 540         // libraries here. The intuition here is that If we've built a compiler, we should be able
 541         // to build rustdoc.
 542         //
 543         let mut features = Vec::new();
 544         if builder.config.jemalloc {
 545             features.push("jemalloc".to_string());
 546         }
 547
 548         let cargo = prepare_tool_cargo(
 549             builder,
 550             build_compiler,
 551             Mode::ToolRustc,
 552             target,
 553             "build",
 554             "src/tools/rustdoc",
 555             SourceType::InTree,
 556             features.as_slice(),
 557         );
 558
 559         builder.info(&format!(
 560             "Building rustdoc for stage{} ({})",
 561             target_compiler.stage, target_compiler.host
 562         ));
 563         builder.run(&mut cargo.into());
 564
 565         // Cargo adds a number of paths to the dylib search path on windows, which results in
 566         // the wrong rustdoc being executed. To avoid the conflicting rustdocs, we name the "tool"
 567         // rustdoc a different name.
 568         let tool_rustdoc = builder
 569             .cargo_out(build_compiler, Mode::ToolRustc, target)
 570             .join(exe("rustdoc_tool_binary", target_compiler.host));
 571
 572         // don't create a stage0-sysroot/bin directory.
 573         if target_compiler.stage > 0 {
 574             let sysroot = builder.sysroot(target_compiler);
 575             let bindir = sysroot.join("bin");
 576             t!(fs::create_dir_all(&bindir));
 577             let bin_rustdoc = bindir.join(exe("rustdoc", target_compiler.host));
 578             let _ = fs::remove_file(&bin_rustdoc);
 579             builder.copy(&tool_rustdoc, &bin_rustdoc);
 580             bin_rustdoc
 581         } else {
 582             tool_rustdoc
 583         }
 584     }
 585 }
 586
 587 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 588 pub struct Cargo {
 589     pub compiler: Compiler,
 590     pub target: TargetSelection,
 591 }
 592
 593 impl Step for Cargo {
 594     type Output = PathBuf;
 595     const DEFAULT: bool = true;
 596     const ONLY_HOSTS: bool = true;
 597
 598     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 599         let builder = run.builder;
 600         run.path("src/tools/cargo").default_condition(
 601             builder.config.extended
 602                 && builder.config.tools.as_ref().map_or(
 603                     true,
 604                     // If `tools` is set, search list for this tool.
 605                     |tools| tools.iter().any(|tool| tool == "cargo"),
 606                 ),
 607         )
 608     }
 609
 610     fn make_run(run: RunConfig<'_>) {
 611         run.builder.ensure(Cargo {
 612             compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
 613             target: run.target,
 614         });
 615     }
 616
 617     fn run(self, builder: &Builder<'_>) -> PathBuf {
 618         let cargo_bin_path = builder
 619             .ensure(ToolBuild {
 620                 compiler: self.compiler,
 621                 target: self.target,
 622                 tool: "cargo",
 623                 mode: Mode::ToolRustc,
 624                 path: "src/tools/cargo",
 625                 is_optional_tool: false,
 626                 source_type: SourceType::Submodule,
 627                 extra_features: Vec::new(),
 628             })
 629             .expect("expected to build -- essential tool");
 630
 631         let build_cred = |name, path| {
 632             // These credential helpers are currently experimental.
 633             // Any build failures will be ignored.
 634             let _ = builder.ensure(ToolBuild {
 635                 compiler: self.compiler,
 636                 target: self.target,
 637                 tool: name,
 638                 mode: Mode::ToolRustc,
 639                 path,
 640                 is_optional_tool: true,
 641                 source_type: SourceType::Submodule,
 642                 extra_features: Vec::new(),
 643             });
 644         };
 645
 646         if self.target.contains("windows") {
 647             build_cred(
 648                 "cargo-credential-wincred",
 649                 "src/tools/cargo/crates/credential/cargo-credential-wincred",
 650             );
 651         }
 652         if self.target.contains("apple-darwin") {
 653             build_cred(
 654                 "cargo-credential-macos-keychain",
 655                 "src/tools/cargo/crates/credential/cargo-credential-macos-keychain",
 656             );
 657         }
 658         build_cred(
 659             "cargo-credential-1password",
 660             "src/tools/cargo/crates/credential/cargo-credential-1password",
 661         );
 662         cargo_bin_path
 663     }
 664 }
 665
 666 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 667 pub struct LldWrapper {
 668     pub compiler: Compiler,
 669     pub target: TargetSelection,
 670     pub flavor_feature: &'static str,
 671 }
 672
 673 impl Step for LldWrapper {
 674     type Output = PathBuf;
 675
 676     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 677         run.never()
 678     }
 679
 680     fn run(self, builder: &Builder<'_>) -> PathBuf {
 681         let src_exe = builder
 682             .ensure(ToolBuild {
 683                 compiler: self.compiler,
 684                 target: self.target,
 685                 tool: "lld-wrapper",
 686                 mode: Mode::ToolStd,
 687                 path: "src/tools/lld-wrapper",
 688                 is_optional_tool: false,
 689                 source_type: SourceType::InTree,
 690                 extra_features: vec![self.flavor_feature.to_owned()],
 691             })
 692             .expect("expected to build -- essential tool");
 693
 694         src_exe
 695     }
 696 }
 697
 698 macro_rules! tool_extended {
 699     (($sel:ident, $builder:ident),
 700        $($name:ident,
 701        $toolstate:ident,
 702        $path:expr,
 703        $tool_name:expr,
 704        stable = $stable:expr,
 705        $(in_tree = $in_tree:expr,)?
 706        $(submodule = $submodule:literal,)?
 707        $extra_deps:block;)+) => {
 708         $(
 709             #[derive(Debug, Clone, Hash, PartialEq, Eq)]
 710         pub struct $name {
 711             pub compiler: Compiler,
 712             pub target: TargetSelection,
 713             pub extra_features: Vec<String>,
 714         }
 715
 716         impl Step for $name {
 717             type Output = Option<PathBuf>;
 718             const DEFAULT: bool = true; // Overwritten below
 719             const ONLY_HOSTS: bool = true;
 720
 721             fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 722                 let builder = run.builder;
 723                 run.path($path).default_condition(
 724                     builder.config.extended
 725                         && builder.config.tools.as_ref().map_or(
 726                             // By default, on nightly/dev enable all tools, else only
 727                             // build stable tools.
 728                             $stable || builder.build.unstable_features(),
 729                             // If `tools` is set, search list for this tool.
 730                             |tools| {
 731                                 tools.iter().any(|tool| match tool.as_ref() {
 732                                     "clippy" => $tool_name == "clippy-driver",
 733                                     x => $tool_name == x,
 734                             })
 735                         }),
 736                 )
 737             }
 738
 739             fn make_run(run: RunConfig<'_>) {
 740                 run.builder.ensure($name {
 741                     compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
 742                     target: run.target,
 743                     extra_features: Vec::new(),
 744                 });
 745             }
 746
 747             #[allow(unused_mut)]
 748             fn run(mut $sel, $builder: &Builder<'_>) -> Option<PathBuf> {
 749                 $extra_deps
 750                 $( $builder.update_submodule(&Path::new("src").join("tools").join($submodule)); )?
 751                 $builder.ensure(ToolBuild {
 752                     compiler: $sel.compiler,
 753                     target: $sel.target,
 754                     tool: $tool_name,
 755                     mode: Mode::ToolRustc,
 756                     path: $path,
 757                     extra_features: $sel.extra_features,
 758                     is_optional_tool: true,
 759                     source_type: if false $(|| $in_tree)* {
 760                         SourceType::InTree
 761                     } else {
 762                         SourceType::Submodule
 763                     },
 764                 })
 765             }
 766         }
 767         )+
 768     }
 769 }
 770
 771 // Note: tools need to be also added to `Builder::get_step_descriptions` in `builder.rs`
 772 // to make `./x.py build <tool>` work.
 773 // Note: Most submodule updates for tools are handled by bootstrap.py, since they're needed just to
 774 // invoke Cargo to build bootstrap. See the comment there for more details.
 775 tool_extended!((self, builder),
 776     Cargofmt, rustfmt, "src/tools/rustfmt", "cargo-fmt", stable=true, in_tree=true, {};
 777     CargoClippy, clippy, "src/tools/clippy", "cargo-clippy", stable=true, in_tree=true, {};
 778     Clippy, clippy, "src/tools/clippy", "clippy-driver", stable=true, in_tree=true, {};
 779     Miri, miri, "src/tools/miri", "miri", stable=false, {};
 780     CargoMiri, miri, "src/tools/miri/cargo-miri", "cargo-miri", stable=false, {};
 781     Rls, rls, "src/tools/rls", "rls", stable=true, {
 782         builder.ensure(Clippy {
 783             compiler: self.compiler,
 784             target: self.target,
 785             extra_features: Vec::new(),
 786         });
 787         self.extra_features.push("clippy".to_owned());
 788     };
 789     RustDemangler, rust_demangler, "src/tools/rust-demangler", "rust-demangler", stable=false, in_tree=true, {};
 790     Rustfmt, rustfmt, "src/tools/rustfmt", "rustfmt", stable=true, in_tree=true, {};
 791     RustAnalyzer, rust_analyzer, "src/tools/rust-analyzer/crates/rust-analyzer", "rust-analyzer", stable=false, submodule="rust-analyzer", {};
 792 );
 793
 794 impl<'a> Builder<'a> {
 795     /// Gets a `Command` which is ready to run `tool` in `stage` built for
 796     /// `host`.
 797     pub fn tool_cmd(&self, tool: Tool) -> Command {
 798         let mut cmd = Command::new(self.tool_exe(tool));
 799         let compiler = self.compiler(0, self.config.build);
 800         let host = &compiler.host;
 801         // Prepares the `cmd` provided to be able to run the `compiler` provided.
 802         //
 803         // Notably this munges the dynamic library lookup path to point to the
 804         // right location to run `compiler`.
 805         let mut lib_paths: Vec<PathBuf> = vec![
 806             self.build.rustc_snapshot_libdir(),
 807             self.cargo_out(compiler, Mode::ToolBootstrap, *host).join("deps"),
 808         ];
 809
 810         // On MSVC a tool may invoke a C compiler (e.g., compiletest in run-make
 811         // mode) and that C compiler may need some extra PATH modification. Do
 812         // so here.
 813         if compiler.host.contains("msvc") {
 814             let curpaths = env::var_os("PATH").unwrap_or_default();
 815             let curpaths = env::split_paths(&curpaths).collect::<Vec<_>>();
 816             for &(ref k, ref v) in self.cc[&compiler.host].env() {
 817                 if k != "PATH" {
 818                     continue;
 819                 }
 820                 for path in env::split_paths(v) {
 821                     if !curpaths.contains(&path) {
 822                         lib_paths.push(path);
 823                     }
 824                 }
 825             }
 826         }
 827
 828         add_dylib_path(lib_paths, &mut cmd);
 829
 830         // Provide a RUSTC for this command to use.
 831         cmd.env("RUSTC", &self.initial_rustc);
 832
 833         cmd
 834     }
 835 }