src/bootstrap/compile.rs

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