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