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