src/bootstrap/compile.rs

   1 //! Implementation of compiling various phases of the compiler and standard
   2 //! library.
   3 //!
   4 //! This module contains some of the real meat in the rustbuild build system
   5 //! which is where Cargo is used to compiler the standard library, libtest, and
   6 //! compiler. This module is also responsible for assembling the sysroot as it
   7 //! goes along from the output of the previous stage.
   8
   9 use std::borrow::Cow;
  10 use std::collections::HashSet;
  11 use std::env;
  12 use std::fs;
  13 use std::io::prelude::*;
  14 use std::io::BufReader;
  15 use std::path::{Path, PathBuf};
  16 use std::process::{exit, Command, Stdio};
  17 use std::str;
  18
  19 use build_helper::{output, t, up_to_date};
  20 use filetime::FileTime;
  21 use serde::Deserialize;
  22
  23 use crate::builder::Cargo;
  24 use crate::builder::{Builder, Kind, RunConfig, ShouldRun, Step};
  25 use crate::cache::{Interned, INTERNER};
  26 use crate::config::TargetSelection;
  27 use crate::dist;
  28 use crate::native;
  29 use crate::tool::SourceType;
  30 use crate::util::{exe, is_dylib, symlink_dir};
  31 use crate::{Compiler, DependencyType, GitRepo, Mode};
  32
  33 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
  34 pub struct Std {
  35     pub target: TargetSelection,
  36     pub compiler: Compiler,
  37 }
  38
  39 impl Step for Std {
  40     type Output = ();
  41     const DEFAULT: bool = true;
  42
  43     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
  44         run.all_krates("test")
  45     }
  46
  47     fn make_run(run: RunConfig<'_>) {
  48         run.builder.ensure(Std {
  49             compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
  50             target: run.target,
  51         });
  52     }
  53
  54     /// Builds the standard library.
  55     ///
  56     /// This will build the standard library for a particular stage of the build
  57     /// using the `compiler` targeting the `target` architecture. The artifacts
  58     /// created will also be linked into the sysroot directory.
  59     fn run(self, builder: &Builder<'_>) {
  60         let target = self.target;
  61         let compiler = self.compiler;
  62
  63         if builder.config.keep_stage.contains(&compiler.stage)
  64             || builder.config.keep_stage_std.contains(&compiler.stage)
  65         {
  66             builder.info("Warning: Using a potentially old libstd. This may not behave well.");
  67             builder.ensure(StdLink { compiler, target_compiler: compiler, target });
  68             return;
  69         }
  70
  71         let mut target_deps = builder.ensure(StartupObjects { compiler, target });
  72
  73         let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
  74         if compiler_to_use != compiler {
  75             builder.ensure(Std { compiler: compiler_to_use, target });
  76             builder.info(&format!("Uplifting stage1 std ({} -> {})", compiler_to_use.host, target));
  77
  78             // Even if we're not building std this stage, the new sysroot must
  79             // still contain the third party objects needed by various targets.
  80             copy_third_party_objects(builder, &compiler, target);
  81             copy_self_contained_objects(builder, &compiler, target);
  82
  83             builder.ensure(StdLink {
  84                 compiler: compiler_to_use,
  85                 target_compiler: compiler,
  86                 target,
  87             });
  88             return;
  89         }
  90
  91         target_deps.extend(copy_third_party_objects(builder, &compiler, target));
  92         target_deps.extend(copy_self_contained_objects(builder, &compiler, target));
  93
  94         let mut cargo = builder.cargo(compiler, Mode::Std, SourceType::InTree, target, "build");
  95         std_cargo(builder, target, compiler.stage, &mut cargo);
  96
  97         builder.info(&format!(
  98             "Building stage{} std artifacts ({} -> {})",
  99             compiler.stage, &compiler.host, target
 100         ));
 101         run_cargo(
 102             builder,
 103             cargo,
 104             vec![],
 105             &libstd_stamp(builder, compiler, target),
 106             target_deps,
 107             false,
 108         );
 109
 110         builder.ensure(StdLink {
 111             compiler: builder.compiler(compiler.stage, builder.config.build),
 112             target_compiler: compiler,
 113             target,
 114         });
 115     }
 116 }
 117
 118 fn copy_and_stamp(
 119     builder: &Builder<'_>,
 120     libdir: &Path,
 121     sourcedir: &Path,
 122     name: &str,
 123     target_deps: &mut Vec<(PathBuf, DependencyType)>,
 124     dependency_type: DependencyType,
 125 ) {
 126     let target = libdir.join(name);
 127     builder.copy(&sourcedir.join(name), &target);
 128
 129     target_deps.push((target, dependency_type));
 130 }
 131
 132 /// Copies third party objects needed by various targets.
 133 fn copy_third_party_objects(
 134     builder: &Builder<'_>,
 135     compiler: &Compiler,
 136     target: TargetSelection,
 137 ) -> Vec<(PathBuf, DependencyType)> {
 138     let mut target_deps = vec![];
 139
 140     // FIXME: remove this in 2021
 141     if target == "x86_64-fortanix-unknown-sgx" {
 142         if env::var_os("X86_FORTANIX_SGX_LIBS").is_some() {
 143             builder.info("Warning: X86_FORTANIX_SGX_LIBS environment variable is ignored, libunwind is now compiled as part of rustbuild");
 144         }
 145     }
 146
 147     if builder.config.sanitizers_enabled(target) && compiler.stage != 0 {
 148         // The sanitizers are only copied in stage1 or above,
 149         // to avoid creating dependency on LLVM.
 150         target_deps.extend(
 151             copy_sanitizers(builder, &compiler, target)
 152                 .into_iter()
 153                 .map(|d| (d, DependencyType::Target)),
 154         );
 155     }
 156
 157     target_deps
 158 }
 159
 160 /// Copies third party objects needed by various targets for self-contained linkage.
 161 fn copy_self_contained_objects(
 162     builder: &Builder<'_>,
 163     compiler: &Compiler,
 164     target: TargetSelection,
 165 ) -> Vec<(PathBuf, DependencyType)> {
 166     let libdir_self_contained = builder.sysroot_libdir(*compiler, target).join("self-contained");
 167     t!(fs::create_dir_all(&libdir_self_contained));
 168     let mut target_deps = vec![];
 169
 170     // Copies the CRT objects.
 171     //
 172     // rustc historically provides a more self-contained installation for musl targets
 173     // not requiring the presence of a native musl toolchain. For example, it can fall back
 174     // to using gcc from a glibc-targeting toolchain for linking.
 175     // To do that we have to distribute musl startup objects as a part of Rust toolchain
 176     // and link with them manually in the self-contained mode.
 177     if target.contains("musl") {
 178         let srcdir = builder.musl_libdir(target).unwrap();
 179         for &obj in &["crt1.o", "Scrt1.o", "rcrt1.o", "crti.o", "crtn.o"] {
 180             copy_and_stamp(
 181                 builder,
 182                 &libdir_self_contained,
 183                 &srcdir,
 184                 obj,
 185                 &mut target_deps,
 186                 DependencyType::TargetSelfContained,
 187             );
 188         }
 189     } else if target.ends_with("-wasi") {
 190         let srcdir = builder.wasi_root(target).unwrap().join("lib/wasm32-wasi");
 191         copy_and_stamp(
 192             builder,
 193             &libdir_self_contained,
 194             &srcdir,
 195             "crt1.o",
 196             &mut target_deps,
 197             DependencyType::TargetSelfContained,
 198         );
 199     } else if target.contains("windows-gnu") {
 200         for obj in ["crt2.o", "dllcrt2.o"].iter() {
 201             let src = compiler_file(builder, builder.cc(target), target, obj);
 202             let target = libdir_self_contained.join(obj);
 203             builder.copy(&src, &target);
 204             target_deps.push((target, DependencyType::TargetSelfContained));
 205         }
 206     }
 207
 208     target_deps
 209 }
 210
 211 /// Configure cargo to compile the standard library, adding appropriate env vars
 212 /// and such.
 213 pub fn std_cargo(builder: &Builder<'_>, target: TargetSelection, stage: u32, cargo: &mut Cargo) {
 214     if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
 215         cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
 216     }
 217
 218     // Determine if we're going to compile in optimized C intrinsics to
 219     // the `compiler-builtins` crate. These intrinsics live in LLVM's
 220     // `compiler-rt` repository, but our `src/llvm-project` submodule isn't
 221     // always checked out, so we need to conditionally look for this. (e.g. if
 222     // an external LLVM is used we skip the LLVM submodule checkout).
 223     //
 224     // Note that this shouldn't affect the correctness of `compiler-builtins`,
 225     // but only its speed. Some intrinsics in C haven't been translated to Rust
 226     // yet but that's pretty rare. Other intrinsics have optimized
 227     // implementations in C which have only had slower versions ported to Rust,
 228     // so we favor the C version where we can, but it's not critical.
 229     //
 230     // If `compiler-rt` is available ensure that the `c` feature of the
 231     // `compiler-builtins` crate is enabled and it's configured to learn where
 232     // `compiler-rt` is located.
 233     let compiler_builtins_root = builder.src.join("src/llvm-project/compiler-rt");
 234     let compiler_builtins_c_feature = if compiler_builtins_root.exists() {
 235         // Note that `libprofiler_builtins/build.rs` also computes this so if
 236         // you're changing something here please also change that.
 237         cargo.env("RUST_COMPILER_RT_ROOT", &compiler_builtins_root);
 238         " compiler-builtins-c"
 239     } else {
 240         ""
 241     };
 242
 243     if builder.no_std(target) == Some(true) {
 244         let mut features = "compiler-builtins-mem".to_string();
 245         features.push_str(compiler_builtins_c_feature);
 246
 247         // for no-std targets we only compile a few no_std crates
 248         cargo
 249             .args(&["-p", "alloc"])
 250             .arg("--manifest-path")
 251             .arg(builder.src.join("library/alloc/Cargo.toml"))
 252             .arg("--features")
 253             .arg(features);
 254     } else {
 255         let mut features = builder.std_features(target);
 256         features.push_str(compiler_builtins_c_feature);
 257
 258         cargo
 259             .arg("--features")
 260             .arg(features)
 261             .arg("--manifest-path")
 262             .arg(builder.src.join("library/test/Cargo.toml"));
 263
 264         // Help the libc crate compile by assisting it in finding various
 265         // sysroot native libraries.
 266         if target.contains("musl") {
 267             if let Some(p) = builder.musl_libdir(target) {
 268                 let root = format!("native={}", p.to_str().unwrap());
 269                 cargo.rustflag("-L").rustflag(&root);
 270             }
 271         }
 272
 273         if target.ends_with("-wasi") {
 274             if let Some(p) = builder.wasi_root(target) {
 275                 let root = format!("native={}/lib/wasm32-wasi", p.to_str().unwrap());
 276                 cargo.rustflag("-L").rustflag(&root);
 277             }
 278         }
 279     }
 280
 281     // By default, rustc uses `-Cembed-bitcode=yes`, and Cargo overrides that
 282     // with `-Cembed-bitcode=no` for non-LTO builds. However, libstd must be
 283     // built with bitcode so that the produced rlibs can be used for both LTO
 284     // builds (which use bitcode) and non-LTO builds (which use object code).
 285     // So we override the override here!
 286     //
 287     // But we don't bother for the stage 0 compiler because it's never used
 288     // with LTO.
 289     if stage >= 1 {
 290         cargo.rustflag("-Cembed-bitcode=yes");
 291     }
 292
 293     // By default, rustc does not include unwind tables unless they are required
 294     // for a particular target. They are not required by RISC-V targets, but
 295     // compiling the standard library with them means that users can get
 296     // backtraces without having to recompile the standard library themselves.
 297     //
 298     // This choice was discussed in https://github.com/rust-lang/rust/pull/69890
 299     if target.contains("riscv") {
 300         cargo.rustflag("-Cforce-unwind-tables=yes");
 301     }
 302 }
 303
 304 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 305 struct StdLink {
 306     pub compiler: Compiler,
 307     pub target_compiler: Compiler,
 308     pub target: TargetSelection,
 309 }
 310
 311 impl Step for StdLink {
 312     type Output = ();
 313
 314     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 315         run.never()
 316     }
 317
 318     /// Link all libstd rlibs/dylibs into the sysroot location.
 319     ///
 320     /// Links those artifacts generated by `compiler` to the `stage` compiler's
 321     /// sysroot for the specified `host` and `target`.
 322     ///
 323     /// Note that this assumes that `compiler` has already generated the libstd
 324     /// libraries for `target`, and this method will find them in the relevant
 325     /// output directory.
 326     fn run(self, builder: &Builder<'_>) {
 327         let compiler = self.compiler;
 328         let target_compiler = self.target_compiler;
 329         let target = self.target;
 330         builder.info(&format!(
 331             "Copying stage{} std from stage{} ({} -> {} / {})",
 332             target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
 333         ));
 334         let libdir = builder.sysroot_libdir(target_compiler, target);
 335         let hostdir = builder.sysroot_libdir(target_compiler, compiler.host);
 336         add_to_sysroot(builder, &libdir, &hostdir, &libstd_stamp(builder, compiler, target));
 337     }
 338 }
 339
 340 /// Copies sanitizer runtime libraries into target libdir.
 341 fn copy_sanitizers(
 342     builder: &Builder<'_>,
 343     compiler: &Compiler,
 344     target: TargetSelection,
 345 ) -> Vec<PathBuf> {
 346     let runtimes: Vec<native::SanitizerRuntime> = builder.ensure(native::Sanitizers { target });
 347
 348     if builder.config.dry_run {
 349         return Vec::new();
 350     }
 351
 352     let mut target_deps = Vec::new();
 353     let libdir = builder.sysroot_libdir(*compiler, target);
 354
 355     for runtime in &runtimes {
 356         let dst = libdir.join(&runtime.name);
 357         builder.copy(&runtime.path, &dst);
 358
 359         if target == "x86_64-apple-darwin" || target == "aarch64-apple-darwin" {
 360             // Update the library’s install name to reflect that it has has been renamed.
 361             apple_darwin_update_library_name(&dst, &format!("@rpath/{}", &runtime.name));
 362             // Upon renaming the install name, the code signature of the file will invalidate,
 363             // so we will sign it again.
 364             apple_darwin_sign_file(&dst);
 365         }
 366
 367         target_deps.push(dst);
 368     }
 369
 370     target_deps
 371 }
 372
 373 fn apple_darwin_update_library_name(library_path: &Path, new_name: &str) {
 374     let status = Command::new("install_name_tool")
 375         .arg("-id")
 376         .arg(new_name)
 377         .arg(library_path)
 378         .status()
 379         .expect("failed to execute `install_name_tool`");
 380     assert!(status.success());
 381 }
 382
 383 fn apple_darwin_sign_file(file_path: &Path) {
 384     let status = Command::new("codesign")
 385         .arg("-f") // Force to rewrite the existing signature
 386         .arg("-s")
 387         .arg("-")
 388         .arg(file_path)
 389         .status()
 390         .expect("failed to execute `codesign`");
 391     assert!(status.success());
 392 }
 393
 394 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 395 pub struct StartupObjects {
 396     pub compiler: Compiler,
 397     pub target: TargetSelection,
 398 }
 399
 400 impl Step for StartupObjects {
 401     type Output = Vec<(PathBuf, DependencyType)>;
 402
 403     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 404         run.path("library/rtstartup")
 405     }
 406
 407     fn make_run(run: RunConfig<'_>) {
 408         run.builder.ensure(StartupObjects {
 409             compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
 410             target: run.target,
 411         });
 412     }
 413
 414     /// Builds and prepare startup objects like rsbegin.o and rsend.o
 415     ///
 416     /// These are primarily used on Windows right now for linking executables/dlls.
 417     /// They don't require any library support as they're just plain old object
 418     /// files, so we just use the nightly snapshot compiler to always build them (as
 419     /// no other compilers are guaranteed to be available).
 420     fn run(self, builder: &Builder<'_>) -> Vec<(PathBuf, DependencyType)> {
 421         let for_compiler = self.compiler;
 422         let target = self.target;
 423         if !target.contains("windows-gnu") {
 424             return vec![];
 425         }
 426
 427         let mut target_deps = vec![];
 428
 429         let src_dir = &builder.src.join("library").join("rtstartup");
 430         let dst_dir = &builder.native_dir(target).join("rtstartup");
 431         let sysroot_dir = &builder.sysroot_libdir(for_compiler, target);
 432         t!(fs::create_dir_all(dst_dir));
 433
 434         for file in &["rsbegin", "rsend"] {
 435             let src_file = &src_dir.join(file.to_string() + ".rs");
 436             let dst_file = &dst_dir.join(file.to_string() + ".o");
 437             if !up_to_date(src_file, dst_file) {
 438                 let mut cmd = Command::new(&builder.initial_rustc);
 439                 builder.run(
 440                     cmd.env("RUSTC_BOOTSTRAP", "1")
 441                         .arg("--cfg")
 442                         .arg("bootstrap")
 443                         .arg("--target")
 444                         .arg(target.rustc_target_arg())
 445                         .arg("--emit=obj")
 446                         .arg("-o")
 447                         .arg(dst_file)
 448                         .arg(src_file),
 449                 );
 450             }
 451
 452             let target = sysroot_dir.join((*file).to_string() + ".o");
 453             builder.copy(dst_file, &target);
 454             target_deps.push((target, DependencyType::Target));
 455         }
 456
 457         target_deps
 458     }
 459 }
 460
 461 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
 462 pub struct Rustc {
 463     pub target: TargetSelection,
 464     pub compiler: Compiler,
 465 }
 466
 467 impl Step for Rustc {
 468     type Output = ();
 469     const ONLY_HOSTS: bool = true;
 470     const DEFAULT: bool = false;
 471
 472     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 473         run.path("compiler/rustc")
 474     }
 475
 476     fn make_run(run: RunConfig<'_>) {
 477         run.builder.ensure(Rustc {
 478             compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
 479             target: run.target,
 480         });
 481     }
 482
 483     /// Builds the compiler.
 484     ///
 485     /// This will build the compiler for a particular stage of the build using
 486     /// the `compiler` targeting the `target` architecture. The artifacts
 487     /// created will also be linked into the sysroot directory.
 488     fn run(self, builder: &Builder<'_>) {
 489         let compiler = self.compiler;
 490         let target = self.target;
 491
 492         builder.ensure(Std { compiler, target });
 493
 494         if builder.config.keep_stage.contains(&compiler.stage) {
 495             builder.info("Warning: Using a potentially old librustc. This may not behave well.");
 496             builder.info("Warning: Use `--keep-stage-std` if you want to rebuild the compiler when it changes");
 497             builder.ensure(RustcLink { compiler, target_compiler: compiler, target });
 498             return;
 499         }
 500
 501         let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
 502         if compiler_to_use != compiler {
 503             builder.ensure(Rustc { compiler: compiler_to_use, target });
 504             builder
 505                 .info(&format!("Uplifting stage1 rustc ({} -> {})", builder.config.build, target));
 506             builder.ensure(RustcLink {
 507                 compiler: compiler_to_use,
 508                 target_compiler: compiler,
 509                 target,
 510             });
 511             return;
 512         }
 513
 514         // Ensure that build scripts and proc macros have a std / libproc_macro to link against.
 515         builder.ensure(Std {
 516             compiler: builder.compiler(self.compiler.stage, builder.config.build),
 517             target: builder.config.build,
 518         });
 519
 520         let mut cargo = builder.cargo(compiler, Mode::Rustc, SourceType::InTree, target, "build");
 521         rustc_cargo(builder, &mut cargo, target);
 522
 523         if builder.config.rust_profile_use.is_some()
 524             && builder.config.rust_profile_generate.is_some()
 525         {
 526             panic!("Cannot use and generate PGO profiles at the same time");
 527         }
 528
 529         let is_collecting = if let Some(path) = &builder.config.rust_profile_generate {
 530             if compiler.stage == 1 {
 531                 cargo.rustflag(&format!("-Cprofile-generate={}", path));
 532                 // Apparently necessary to avoid overflowing the counters during
 533                 // a Cargo build profile
 534                 cargo.rustflag("-Cllvm-args=-vp-counters-per-site=4");
 535                 true
 536             } else {
 537                 false
 538             }
 539         } else if let Some(path) = &builder.config.rust_profile_use {
 540             if compiler.stage == 1 {
 541                 cargo.rustflag(&format!("-Cprofile-use={}", path));
 542                 cargo.rustflag("-Cllvm-args=-pgo-warn-missing-function");
 543                 true
 544             } else {
 545                 false
 546             }
 547         } else {
 548             false
 549         };
 550         if is_collecting {
 551             // Ensure paths to Rust sources are relative, not absolute.
 552             cargo.rustflag(&format!(
 553                 "-Cllvm-args=-static-func-strip-dirname-prefix={}",
 554                 builder.config.src.components().count()
 555             ));
 556         }
 557
 558         builder.info(&format!(
 559             "Building stage{} compiler artifacts ({} -> {})",
 560             compiler.stage, &compiler.host, target
 561         ));
 562         run_cargo(
 563             builder,
 564             cargo,
 565             vec![],
 566             &librustc_stamp(builder, compiler, target),
 567             vec![],
 568             false,
 569         );
 570
 571         builder.ensure(RustcLink {
 572             compiler: builder.compiler(compiler.stage, builder.config.build),
 573             target_compiler: compiler,
 574             target,
 575         });
 576     }
 577 }
 578
 579 pub fn rustc_cargo(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
 580     cargo
 581         .arg("--features")
 582         .arg(builder.rustc_features())
 583         .arg("--manifest-path")
 584         .arg(builder.src.join("compiler/rustc/Cargo.toml"));
 585     rustc_cargo_env(builder, cargo, target);
 586 }
 587
 588 pub fn rustc_cargo_env(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
 589     // Set some configuration variables picked up by build scripts and
 590     // the compiler alike
 591     cargo
 592         .env("CFG_RELEASE", builder.rust_release())
 593         .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
 594         .env("CFG_VERSION", builder.rust_version())
 595         .env("CFG_PREFIX", builder.config.prefix.clone().unwrap_or_default());
 596
 597     let libdir_relative = builder.config.libdir_relative().unwrap_or_else(|| Path::new("lib"));
 598     cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
 599
 600     if let Some(ref ver_date) = builder.rust_info.commit_date() {
 601         cargo.env("CFG_VER_DATE", ver_date);
 602     }
 603     if let Some(ref ver_hash) = builder.rust_info.sha() {
 604         cargo.env("CFG_VER_HASH", ver_hash);
 605     }
 606     if !builder.unstable_features() {
 607         cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
 608     }
 609     if let Some(ref s) = builder.config.rustc_default_linker {
 610         cargo.env("CFG_DEFAULT_LINKER", s);
 611     }
 612     if builder.config.rustc_parallel {
 613         cargo.rustflag("--cfg=parallel_compiler");
 614     }
 615     if builder.config.rust_verify_llvm_ir {
 616         cargo.env("RUSTC_VERIFY_LLVM_IR", "1");
 617     }
 618
 619     // Pass down configuration from the LLVM build into the build of
 620     // rustc_llvm and rustc_codegen_llvm.
 621     //
 622     // Note that this is disabled if LLVM itself is disabled or we're in a check
 623     // build. If we are in a check build we still go ahead here presuming we've
 624     // detected that LLVM is alreay built and good to go which helps prevent
 625     // busting caches (e.g. like #71152).
 626     if builder.config.llvm_enabled()
 627         && (builder.kind != Kind::Check
 628             || crate::native::prebuilt_llvm_config(builder, target).is_ok())
 629     {
 630         if builder.is_rust_llvm(target) {
 631             cargo.env("LLVM_RUSTLLVM", "1");
 632         }
 633         let llvm_config = builder.ensure(native::Llvm { target });
 634         cargo.env("LLVM_CONFIG", &llvm_config);
 635         let target_config = builder.config.target_config.get(&target);
 636         if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
 637             cargo.env("CFG_LLVM_ROOT", s);
 638         }
 639         // Some LLVM linker flags (-L and -l) may be needed to link rustc_llvm.
 640         if let Some(ref s) = builder.config.llvm_ldflags {
 641             cargo.env("LLVM_LINKER_FLAGS", s);
 642         }
 643         // Building with a static libstdc++ is only supported on linux right now,
 644         // not for MSVC or macOS
 645         if builder.config.llvm_static_stdcpp
 646             && !target.contains("freebsd")
 647             && !target.contains("msvc")
 648             && !target.contains("apple")
 649         {
 650             let file = compiler_file(builder, builder.cxx(target).unwrap(), target, "libstdc++.a");
 651             cargo.env("LLVM_STATIC_STDCPP", file);
 652         }
 653         if builder.config.llvm_link_shared {
 654             cargo.env("LLVM_LINK_SHARED", "1");
 655         }
 656         if builder.config.llvm_use_libcxx {
 657             cargo.env("LLVM_USE_LIBCXX", "1");
 658         }
 659         if builder.config.llvm_optimize && !builder.config.llvm_release_debuginfo {
 660             cargo.env("LLVM_NDEBUG", "1");
 661         }
 662     }
 663 }
 664
 665 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 666 struct RustcLink {
 667     pub compiler: Compiler,
 668     pub target_compiler: Compiler,
 669     pub target: TargetSelection,
 670 }
 671
 672 impl Step for RustcLink {
 673     type Output = ();
 674
 675     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 676         run.never()
 677     }
 678
 679     /// Same as `std_link`, only for librustc
 680     fn run(self, builder: &Builder<'_>) {
 681         let compiler = self.compiler;
 682         let target_compiler = self.target_compiler;
 683         let target = self.target;
 684         builder.info(&format!(
 685             "Copying stage{} rustc from stage{} ({} -> {} / {})",
 686             target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
 687         ));
 688         add_to_sysroot(
 689             builder,
 690             &builder.sysroot_libdir(target_compiler, target),
 691             &builder.sysroot_libdir(target_compiler, compiler.host),
 692             &librustc_stamp(builder, compiler, target),
 693         );
 694     }
 695 }
 696
 697 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 698 pub struct CodegenBackend {
 699     pub target: TargetSelection,
 700     pub compiler: Compiler,
 701     pub backend: Interned<String>,
 702 }
 703
 704 impl Step for CodegenBackend {
 705     type Output = ();
 706     const ONLY_HOSTS: bool = true;
 707     // Only the backends specified in the `codegen-backends` entry of `config.toml` are built.
 708     const DEFAULT: bool = true;
 709
 710     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 711         run.path("compiler/rustc_codegen_cranelift")
 712     }
 713
 714     fn make_run(run: RunConfig<'_>) {
 715         for &backend in &run.builder.config.rust_codegen_backends {
 716             if backend == "llvm" {
 717                 continue; // Already built as part of rustc
 718             }
 719
 720             run.builder.ensure(CodegenBackend {
 721                 target: run.target,
 722                 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
 723                 backend,
 724             });
 725         }
 726     }
 727
 728     fn run(self, builder: &Builder<'_>) {
 729         let compiler = self.compiler;
 730         let target = self.target;
 731         let backend = self.backend;
 732
 733         builder.ensure(Rustc { compiler, target });
 734
 735         if builder.config.keep_stage.contains(&compiler.stage) {
 736             builder.info(
 737                 "Warning: Using a potentially old codegen backend. \
 738                 This may not behave well.",
 739             );
 740             // Codegen backends are linked separately from this step today, so we don't do
 741             // anything here.
 742             return;
 743         }
 744
 745         let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
 746         if compiler_to_use != compiler {
 747             builder.ensure(CodegenBackend { compiler: compiler_to_use, target, backend });
 748             return;
 749         }
 750
 751         let out_dir = builder.cargo_out(compiler, Mode::Codegen, target);
 752
 753         let mut cargo =
 754             builder.cargo(compiler, Mode::Codegen, SourceType::Submodule, target, "build");
 755         cargo
 756             .arg("--manifest-path")
 757             .arg(builder.src.join(format!("compiler/rustc_codegen_{}/Cargo.toml", backend)));
 758         rustc_cargo_env(builder, &mut cargo, target);
 759
 760         let tmp_stamp = out_dir.join(".tmp.stamp");
 761
 762         let files = run_cargo(builder, cargo, vec![], &tmp_stamp, vec![], false);
 763         if builder.config.dry_run {
 764             return;
 765         }
 766         let mut files = files.into_iter().filter(|f| {
 767             let filename = f.file_name().unwrap().to_str().unwrap();
 768             is_dylib(filename) && filename.contains("rustc_codegen_")
 769         });
 770         let codegen_backend = match files.next() {
 771             Some(f) => f,
 772             None => panic!("no dylibs built for codegen backend?"),
 773         };
 774         if let Some(f) = files.next() {
 775             panic!(
 776                 "codegen backend built two dylibs:\n{}\n{}",
 777                 codegen_backend.display(),
 778                 f.display()
 779             );
 780         }
 781         let stamp = codegen_backend_stamp(builder, compiler, target, backend);
 782         let codegen_backend = codegen_backend.to_str().unwrap();
 783         t!(fs::write(&stamp, &codegen_backend));
 784     }
 785 }
 786
 787 /// Creates the `codegen-backends` folder for a compiler that's about to be
 788 /// assembled as a complete compiler.
 789 ///
 790 /// This will take the codegen artifacts produced by `compiler` and link them
 791 /// into an appropriate location for `target_compiler` to be a functional
 792 /// compiler.
 793 fn copy_codegen_backends_to_sysroot(
 794     builder: &Builder<'_>,
 795     compiler: Compiler,
 796     target_compiler: Compiler,
 797 ) {
 798     let target = target_compiler.host;
 799
 800     // Note that this step is different than all the other `*Link` steps in
 801     // that it's not assembling a bunch of libraries but rather is primarily
 802     // moving the codegen backend into place. The codegen backend of rustc is
 803     // not linked into the main compiler by default but is rather dynamically
 804     // selected at runtime for inclusion.
 805     //
 806     // Here we're looking for the output dylib of the `CodegenBackend` step and
 807     // we're copying that into the `codegen-backends` folder.
 808     let dst = builder.sysroot_codegen_backends(target_compiler);
 809     t!(fs::create_dir_all(&dst), dst);
 810
 811     if builder.config.dry_run {
 812         return;
 813     }
 814
 815     for backend in builder.config.rust_codegen_backends.iter() {
 816         if backend == "llvm" {
 817             continue; // Already built as part of rustc
 818         }
 819
 820         let stamp = codegen_backend_stamp(builder, compiler, target, *backend);
 821         let dylib = t!(fs::read_to_string(&stamp));
 822         let file = Path::new(&dylib);
 823         let filename = file.file_name().unwrap().to_str().unwrap();
 824         // change `librustc_codegen_cranelift-xxxxxx.so` to
 825         // `librustc_codegen_cranelift-release.so`
 826         let target_filename = {
 827             let dash = filename.find('-').unwrap();
 828             let dot = filename.find('.').unwrap();
 829             format!("{}-{}{}", &filename[..dash], builder.rust_release(), &filename[dot..])
 830         };
 831         builder.copy(&file, &dst.join(target_filename));
 832     }
 833 }
 834
 835 /// Cargo's output path for the standard library in a given stage, compiled
 836 /// by a particular compiler for the specified target.
 837 pub fn libstd_stamp(builder: &Builder<'_>, compiler: Compiler, target: TargetSelection) -> PathBuf {
 838     builder.cargo_out(compiler, Mode::Std, target).join(".libstd.stamp")
 839 }
 840
 841 /// Cargo's output path for librustc in a given stage, compiled by a particular
 842 /// compiler for the specified target.
 843 pub fn librustc_stamp(
 844     builder: &Builder<'_>,
 845     compiler: Compiler,
 846     target: TargetSelection,
 847 ) -> PathBuf {
 848     builder.cargo_out(compiler, Mode::Rustc, target).join(".librustc.stamp")
 849 }
 850
 851 /// Cargo's output path for librustc_codegen_llvm in a given stage, compiled by a particular
 852 /// compiler for the specified target and backend.
 853 fn codegen_backend_stamp(
 854     builder: &Builder<'_>,
 855     compiler: Compiler,
 856     target: TargetSelection,
 857     backend: Interned<String>,
 858 ) -> PathBuf {
 859     builder
 860         .cargo_out(compiler, Mode::Codegen, target)
 861         .join(format!(".librustc_codegen_{}.stamp", backend))
 862 }
 863
 864 pub fn compiler_file(
 865     builder: &Builder<'_>,
 866     compiler: &Path,
 867     target: TargetSelection,
 868     file: &str,
 869 ) -> PathBuf {
 870     let mut cmd = Command::new(compiler);
 871     cmd.args(builder.cflags(target, GitRepo::Rustc));
 872     cmd.arg(format!("-print-file-name={}", file));
 873     let out = output(&mut cmd);
 874     PathBuf::from(out.trim())
 875 }
 876
 877 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 878 pub struct Sysroot {
 879     pub compiler: Compiler,
 880 }
 881
 882 impl Step for Sysroot {
 883     type Output = Interned<PathBuf>;
 884
 885     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 886         run.never()
 887     }
 888
 889     /// Returns the sysroot for the `compiler` specified that *this build system
 890     /// generates*.
 891     ///
 892     /// That is, the sysroot for the stage0 compiler is not what the compiler
 893     /// thinks it is by default, but it's the same as the default for stages
 894     /// 1-3.
 895     fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
 896         let compiler = self.compiler;
 897         let sysroot = if compiler.stage == 0 {
 898             builder.out.join(&compiler.host.triple).join("stage0-sysroot")
 899         } else {
 900             builder.out.join(&compiler.host.triple).join(format!("stage{}", compiler.stage))
 901         };
 902         let _ = fs::remove_dir_all(&sysroot);
 903         t!(fs::create_dir_all(&sysroot));
 904
 905         // Symlink the source root into the same location inside the sysroot,
 906         // where `rust-src` component would go (`$sysroot/lib/rustlib/src/rust`),
 907         // so that any tools relying on `rust-src` also work for local builds,
 908         // and also for translating the virtual `/rustc/$hash` back to the real
 909         // directory (for running tests with `rust.remap-debuginfo = true`).
 910         let sysroot_lib_rustlib_src = sysroot.join("lib/rustlib/src");
 911         t!(fs::create_dir_all(&sysroot_lib_rustlib_src));
 912         let sysroot_lib_rustlib_src_rust = sysroot_lib_rustlib_src.join("rust");
 913         if let Err(e) = symlink_dir(&builder.config, &builder.src, &sysroot_lib_rustlib_src_rust) {
 914             eprintln!(
 915                 "warning: creating symbolic link `{}` to `{}` failed with {}",
 916                 sysroot_lib_rustlib_src_rust.display(),
 917                 builder.src.display(),
 918                 e,
 919             );
 920             if builder.config.rust_remap_debuginfo {
 921                 eprintln!(
 922                     "warning: some `src/test/ui` tests will fail when lacking `{}`",
 923                     sysroot_lib_rustlib_src_rust.display(),
 924                 );
 925             }
 926         }
 927
 928         INTERNER.intern_path(sysroot)
 929     }
 930 }
 931
 932 #[derive(Debug, Copy, PartialOrd, Ord, Clone, PartialEq, Eq, Hash)]
 933 pub struct Assemble {
 934     /// The compiler which we will produce in this step. Assemble itself will
 935     /// take care of ensuring that the necessary prerequisites to do so exist,
 936     /// that is, this target can be a stage2 compiler and Assemble will build
 937     /// previous stages for you.
 938     pub target_compiler: Compiler,
 939 }
 940
 941 impl Step for Assemble {
 942     type Output = Compiler;
 943
 944     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 945         run.never()
 946     }
 947
 948     /// Prepare a new compiler from the artifacts in `stage`
 949     ///
 950     /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
 951     /// must have been previously produced by the `stage - 1` builder.build
 952     /// compiler.
 953     fn run(self, builder: &Builder<'_>) -> Compiler {
 954         let target_compiler = self.target_compiler;
 955
 956         if target_compiler.stage == 0 {
 957             assert_eq!(
 958                 builder.config.build, target_compiler.host,
 959                 "Cannot obtain compiler for non-native build triple at stage 0"
 960             );
 961             // The stage 0 compiler for the build triple is always pre-built.
 962             return target_compiler;
 963         }
 964
 965         // Get the compiler that we'll use to bootstrap ourselves.
 966         //
 967         // Note that this is where the recursive nature of the bootstrap
 968         // happens, as this will request the previous stage's compiler on
 969         // downwards to stage 0.
 970         //
 971         // Also note that we're building a compiler for the host platform. We
 972         // only assume that we can run `build` artifacts, which means that to
 973         // produce some other architecture compiler we need to start from
 974         // `build` to get there.
 975         //
 976         // FIXME: Perhaps we should download those libraries?
 977         //        It would make builds faster...
 978         //
 979         // FIXME: It may be faster if we build just a stage 1 compiler and then
 980         //        use that to bootstrap this compiler forward.
 981         let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
 982
 983         // Build the libraries for this compiler to link to (i.e., the libraries
 984         // it uses at runtime). NOTE: Crates the target compiler compiles don't
 985         // link to these. (FIXME: Is that correct? It seems to be correct most
 986         // of the time but I think we do link to these for stage2/bin compilers
 987         // when not performing a full bootstrap).
 988         builder.ensure(Rustc { compiler: build_compiler, target: target_compiler.host });
 989
 990         for &backend in builder.config.rust_codegen_backends.iter() {
 991             if backend == "llvm" {
 992                 continue; // Already built as part of rustc
 993             }
 994
 995             builder.ensure(CodegenBackend {
 996                 compiler: build_compiler,
 997                 target: target_compiler.host,
 998                 backend,
 999             });
1000         }
1001
1002         let lld_install = if builder.config.lld_enabled {
1003             Some(builder.ensure(native::Lld { target: target_compiler.host }))
1004         } else {
1005             None
1006         };
1007
1008         let stage = target_compiler.stage;
1009         let host = target_compiler.host;
1010         builder.info(&format!("Assembling stage{} compiler ({})", stage, host));
1011
1012         // Link in all dylibs to the libdir
1013         let stamp = librustc_stamp(builder, build_compiler, target_compiler.host);
1014         let proc_macros = builder
1015             .read_stamp_file(&stamp)
1016             .into_iter()
1017             .filter_map(|(path, dependency_type)| {
1018                 if dependency_type == DependencyType::Host {
1019                     Some(path.file_name().unwrap().to_owned().into_string().unwrap())
1020                 } else {
1021                     None
1022                 }
1023             })
1024             .collect::<HashSet<_>>();
1025
1026         let sysroot = builder.sysroot(target_compiler);
1027         let rustc_libdir = builder.rustc_libdir(target_compiler);
1028         t!(fs::create_dir_all(&rustc_libdir));
1029         let src_libdir = builder.sysroot_libdir(build_compiler, host);
1030         for f in builder.read_dir(&src_libdir) {
1031             let filename = f.file_name().into_string().unwrap();
1032             if is_dylib(&filename) && !proc_macros.contains(&filename) {
1033                 builder.copy(&f.path(), &rustc_libdir.join(&filename));
1034             }
1035         }
1036
1037         copy_codegen_backends_to_sysroot(builder, build_compiler, target_compiler);
1038
1039         // We prepend this bin directory to the user PATH when linking Rust binaries. To
1040         // avoid shadowing the system LLD we rename the LLD we provide to `rust-lld`.
1041         let libdir = builder.sysroot_libdir(target_compiler, target_compiler.host);
1042         let libdir_bin = libdir.parent().unwrap().join("bin");
1043         t!(fs::create_dir_all(&libdir_bin));
1044
1045         if let Some(lld_install) = lld_install {
1046             let src_exe = exe("lld", target_compiler.host);
1047             let dst_exe = exe("rust-lld", target_compiler.host);
1048             builder.copy(&lld_install.join("bin").join(&src_exe), &libdir_bin.join(&dst_exe));
1049         }
1050
1051         // Similarly, copy `llvm-dwp` into libdir for Split DWARF.
1052         {
1053             let src_exe = exe("llvm-dwp", target_compiler.host);
1054             let dst_exe = exe("rust-llvm-dwp", target_compiler.host);
1055             let llvm_config_bin = builder.ensure(native::Llvm { target: target_compiler.host });
1056             let llvm_bin_dir = llvm_config_bin.parent().unwrap();
1057             builder.copy(&llvm_bin_dir.join(&src_exe), &libdir_bin.join(&dst_exe));
1058         }
1059
1060         // Ensure that `libLLVM.so` ends up in the newly build compiler directory,
1061         // so that it can be found when the newly built `rustc` is run.
1062         dist::maybe_install_llvm_runtime(builder, target_compiler.host, &sysroot);
1063         dist::maybe_install_llvm_target(builder, target_compiler.host, &sysroot);
1064
1065         // Link the compiler binary itself into place
1066         let out_dir = builder.cargo_out(build_compiler, Mode::Rustc, host);
1067         let rustc = out_dir.join(exe("rustc-main", host));
1068         let bindir = sysroot.join("bin");
1069         t!(fs::create_dir_all(&bindir));
1070         let compiler = builder.rustc(target_compiler);
1071         builder.copy(&rustc, &compiler);
1072
1073         target_compiler
1074     }
1075 }
1076
1077 /// Link some files into a rustc sysroot.
1078 ///
1079 /// For a particular stage this will link the file listed in `stamp` into the
1080 /// `sysroot_dst` provided.
1081 pub fn add_to_sysroot(
1082     builder: &Builder<'_>,
1083     sysroot_dst: &Path,
1084     sysroot_host_dst: &Path,
1085     stamp: &Path,
1086 ) {
1087     let self_contained_dst = &sysroot_dst.join("self-contained");
1088     t!(fs::create_dir_all(&sysroot_dst));
1089     t!(fs::create_dir_all(&sysroot_host_dst));
1090     t!(fs::create_dir_all(&self_contained_dst));
1091     for (path, dependency_type) in builder.read_stamp_file(stamp) {
1092         let dst = match dependency_type {
1093             DependencyType::Host => sysroot_host_dst,
1094             DependencyType::Target => sysroot_dst,
1095             DependencyType::TargetSelfContained => self_contained_dst,
1096         };
1097         builder.copy(&path, &dst.join(path.file_name().unwrap()));
1098     }
1099 }
1100
1101 pub fn run_cargo(
1102     builder: &Builder<'_>,
1103     cargo: Cargo,
1104     tail_args: Vec<String>,
1105     stamp: &Path,
1106     additional_target_deps: Vec<(PathBuf, DependencyType)>,
1107     is_check: bool,
1108 ) -> Vec<PathBuf> {
1109     if builder.config.dry_run {
1110         return Vec::new();
1111     }
1112
1113     // `target_root_dir` looks like $dir/$target/release
1114     let target_root_dir = stamp.parent().unwrap();
1115     // `target_deps_dir` looks like $dir/$target/release/deps
1116     let target_deps_dir = target_root_dir.join("deps");
1117     // `host_root_dir` looks like $dir/release
1118     let host_root_dir = target_root_dir
1119         .parent()
1120         .unwrap() // chop off `release`
1121         .parent()
1122         .unwrap() // chop off `$target`
1123         .join(target_root_dir.file_name().unwrap());
1124
1125     // Spawn Cargo slurping up its JSON output. We'll start building up the
1126     // `deps` array of all files it generated along with a `toplevel` array of
1127     // files we need to probe for later.
1128     let mut deps = Vec::new();
1129     let mut toplevel = Vec::new();
1130     let ok = stream_cargo(builder, cargo, tail_args, &mut |msg| {
1131         let (filenames, crate_types) = match msg {
1132             CargoMessage::CompilerArtifact {
1133                 filenames,
1134                 target: CargoTarget { crate_types },
1135                 ..
1136             } => (filenames, crate_types),
1137             _ => return,
1138         };
1139         for filename in filenames {
1140             // Skip files like executables
1141             if !(filename.ends_with(".rlib")
1142                 || filename.ends_with(".lib")
1143                 || filename.ends_with(".a")
1144                 || is_dylib(&filename)
1145                 || (is_check && filename.ends_with(".rmeta")))
1146             {
1147                 continue;
1148             }
1149
1150             let filename = Path::new(&*filename);
1151
1152             // If this was an output file in the "host dir" we don't actually
1153             // worry about it, it's not relevant for us
1154             if filename.starts_with(&host_root_dir) {
1155                 // Unless it's a proc macro used in the compiler
1156                 if crate_types.iter().any(|t| t == "proc-macro") {
1157                     deps.push((filename.to_path_buf(), DependencyType::Host));
1158                 }
1159                 continue;
1160             }
1161
1162             // If this was output in the `deps` dir then this is a precise file
1163             // name (hash included) so we start tracking it.
1164             if filename.starts_with(&target_deps_dir) {
1165                 deps.push((filename.to_path_buf(), DependencyType::Target));
1166                 continue;
1167             }
1168
1169             // Otherwise this was a "top level artifact" which right now doesn't
1170             // have a hash in the name, but there's a version of this file in
1171             // the `deps` folder which *does* have a hash in the name. That's
1172             // the one we'll want to we'll probe for it later.
1173             //
1174             // We do not use `Path::file_stem` or `Path::extension` here,
1175             // because some generated files may have multiple extensions e.g.
1176             // `std-<hash>.dll.lib` on Windows. The aforementioned methods only
1177             // split the file name by the last extension (`.lib`) while we need
1178             // to split by all extensions (`.dll.lib`).
1179             let expected_len = t!(filename.metadata()).len();
1180             let filename = filename.file_name().unwrap().to_str().unwrap();
1181             let mut parts = filename.splitn(2, '.');
1182             let file_stem = parts.next().unwrap().to_owned();
1183             let extension = parts.next().unwrap().to_owned();
1184
1185             toplevel.push((file_stem, extension, expected_len));
1186         }
1187     });
1188
1189     if !ok {
1190         exit(1);
1191     }
1192
1193     // Ok now we need to actually find all the files listed in `toplevel`. We've
1194     // got a list of prefix/extensions and we basically just need to find the
1195     // most recent file in the `deps` folder corresponding to each one.
1196     let contents = t!(target_deps_dir.read_dir())
1197         .map(|e| t!(e))
1198         .map(|e| (e.path(), e.file_name().into_string().unwrap(), t!(e.metadata())))
1199         .collect::<Vec<_>>();
1200     for (prefix, extension, expected_len) in toplevel {
1201         let candidates = contents.iter().filter(|&&(_, ref filename, ref meta)| {
1202             meta.len() == expected_len
1203                 && filename
1204                     .strip_prefix(&prefix[..])
1205                     .map(|s| s.starts_with('-') && s.ends_with(&extension[..]))
1206                     .unwrap_or(false)
1207         });
1208         let max = candidates
1209             .max_by_key(|&&(_, _, ref metadata)| FileTime::from_last_modification_time(metadata));
1210         let path_to_add = match max {
1211             Some(triple) => triple.0.to_str().unwrap(),
1212             None => panic!("no output generated for {:?} {:?}", prefix, extension),
1213         };
1214         if is_dylib(path_to_add) {
1215             let candidate = format!("{}.lib", path_to_add);
1216             let candidate = PathBuf::from(candidate);
1217             if candidate.exists() {
1218                 deps.push((candidate, DependencyType::Target));
1219             }
1220         }
1221         deps.push((path_to_add.into(), DependencyType::Target));
1222     }
1223
1224     deps.extend(additional_target_deps);
1225     deps.sort();
1226     let mut new_contents = Vec::new();
1227     for (dep, dependency_type) in deps.iter() {
1228         new_contents.extend(match *dependency_type {
1229             DependencyType::Host => b"h",
1230             DependencyType::Target => b"t",
1231             DependencyType::TargetSelfContained => b"s",
1232         });
1233         new_contents.extend(dep.to_str().unwrap().as_bytes());
1234         new_contents.extend(b"\0");
1235     }
1236     t!(fs::write(&stamp, &new_contents));
1237     deps.into_iter().map(|(d, _)| d).collect()
1238 }
1239
1240 pub fn stream_cargo(
1241     builder: &Builder<'_>,
1242     cargo: Cargo,
1243     tail_args: Vec<String>,
1244     cb: &mut dyn FnMut(CargoMessage<'_>),
1245 ) -> bool {
1246     let mut cargo = Command::from(cargo);
1247     if builder.config.dry_run {
1248         return true;
1249     }
1250     // Instruct Cargo to give us json messages on stdout, critically leaving
1251     // stderr as piped so we can get those pretty colors.
1252     let mut message_format = if builder.config.json_output {
1253         String::from("json")
1254     } else {
1255         String::from("json-render-diagnostics")
1256     };
1257     if let Some(s) = &builder.config.rustc_error_format {
1258         message_format.push_str(",json-diagnostic-");
1259         message_format.push_str(s);
1260     }
1261     cargo.arg("--message-format").arg(message_format).stdout(Stdio::piped());
1262
1263     for arg in tail_args {
1264         cargo.arg(arg);
1265     }
1266
1267     builder.verbose(&format!("running: {:?}", cargo));
1268     let mut child = match cargo.spawn() {
1269         Ok(child) => child,
1270         Err(e) => panic!("failed to execute command: {:?}\nerror: {}", cargo, e),
1271     };
1272
1273     // Spawn Cargo slurping up its JSON output. We'll start building up the
1274     // `deps` array of all files it generated along with a `toplevel` array of
1275     // files we need to probe for later.
1276     let stdout = BufReader::new(child.stdout.take().unwrap());
1277     for line in stdout.lines() {
1278         let line = t!(line);
1279         match serde_json::from_str::<CargoMessage<'_>>(&line) {
1280             Ok(msg) => {
1281                 if builder.config.json_output {
1282                     // Forward JSON to stdout.
1283                     println!("{}", line);
1284                 }
1285                 cb(msg)
1286             }
1287             // If this was informational, just print it out and continue
1288             Err(_) => println!("{}", line),
1289         }
1290     }
1291
1292     // Make sure Cargo actually succeeded after we read all of its stdout.
1293     let status = t!(child.wait());
1294     if !status.success() {
1295         eprintln!(
1296             "command did not execute successfully: {:?}\n\
1297                   expected success, got: {}",
1298             cargo, status
1299         );
1300     }
1301     status.success()
1302 }
1303
1304 #[derive(Deserialize)]
1305 pub struct CargoTarget<'a> {
1306     crate_types: Vec<Cow<'a, str>>,
1307 }
1308
1309 #[derive(Deserialize)]
1310 #[serde(tag = "reason", rename_all = "kebab-case")]
1311 pub enum CargoMessage<'a> {
1312     CompilerArtifact {
1313         package_id: Cow<'a, str>,
1314         features: Vec<Cow<'a, str>>,
1315         filenames: Vec<Cow<'a, str>>,
1316         target: CargoTarget<'a>,
1317     },
1318     BuildScriptExecuted {
1319         package_id: Cow<'a, str>,
1320     },
1321     BuildFinished {
1322         success: bool,
1323     },
1324 }