src/bootstrap/compile.rs

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