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