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