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