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