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