src/bootstrap/compile.rs

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