src/bootstrap/compile.rs

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