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