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