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 download_rustc = run.builder.config.download_rustc;
  46         run.all_krates("test").path("library").default_condition(!download_rustc)
  47     }
  48
  49     fn make_run(run: RunConfig<'_>) {
  50         run.builder.ensure(Std {
  51             compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
  52             target: run.target,
  53         });
  54     }
  55
  56     /// Builds the standard library.
  57     ///
  58     /// This will build the standard library for a particular stage of the build
  59     /// using the `compiler` targeting the `target` architecture. The artifacts
  60     /// created will also be linked into the sysroot directory.
  61     fn run(self, builder: &Builder<'_>) {
  62         let target = self.target;
  63         let compiler = self.compiler;
  64
  65         // These artifacts were already copied (in `impl Step for Sysroot`).
  66         // Don't recompile them.
  67         // NOTE: the ABI of the beta compiler is different from the ABI of the downloaded compiler,
  68         // so its artifacts can't be reused.
  69         if builder.config.download_rustc && compiler.stage != 0 {
  70             return;
  71         }
  72
  73         if builder.config.keep_stage.contains(&compiler.stage)
  74             || builder.config.keep_stage_std.contains(&compiler.stage)
  75         {
  76             builder.info("Warning: Using a potentially old libstd. This may not behave well.");
  77             builder.ensure(StdLink { compiler, target_compiler: compiler, target });
  78             return;
  79         }
  80
  81         builder.update_submodule(&Path::new("library").join("stdarch"));
  82
  83         let mut target_deps = builder.ensure(StartupObjects { compiler, target });
  84
  85         let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
  86         if compiler_to_use != compiler {
  87             builder.ensure(Std { compiler: compiler_to_use, target });
  88             builder.info(&format!("Uplifting stage1 std ({} -> {})", compiler_to_use.host, target));
  89
  90             // Even if we're not building std this stage, the new sysroot must
  91             // still contain the third party objects needed by various targets.
  92             copy_third_party_objects(builder, &compiler, target);
  93             copy_self_contained_objects(builder, &compiler, target);
  94
  95             builder.ensure(StdLink {
  96                 compiler: compiler_to_use,
  97                 target_compiler: compiler,
  98                 target,
  99             });
 100             return;
 101         }
 102
 103         target_deps.extend(copy_third_party_objects(builder, &compiler, target));
 104         target_deps.extend(copy_self_contained_objects(builder, &compiler, target));
 105
 106         let mut cargo = builder.cargo(compiler, Mode::Std, SourceType::InTree, target, "build");
 107         std_cargo(builder, target, compiler.stage, &mut cargo);
 108
 109         builder.info(&format!(
 110             "Building stage{} std artifacts ({} -> {})",
 111             compiler.stage, &compiler.host, target
 112         ));
 113         run_cargo(
 114             builder,
 115             cargo,
 116             vec![],
 117             &libstd_stamp(builder, compiler, target),
 118             target_deps,
 119             false,
 120         );
 121
 122         builder.ensure(StdLink {
 123             compiler: builder.compiler(compiler.stage, builder.config.build),
 124             target_compiler: compiler,
 125             target,
 126         });
 127     }
 128 }
 129
 130 fn copy_and_stamp(
 131     builder: &Builder<'_>,
 132     libdir: &Path,
 133     sourcedir: &Path,
 134     name: &str,
 135     target_deps: &mut Vec<(PathBuf, DependencyType)>,
 136     dependency_type: DependencyType,
 137 ) {
 138     let target = libdir.join(name);
 139     builder.copy(&sourcedir.join(name), &target);
 140
 141     target_deps.push((target, dependency_type));
 142 }
 143
 144 fn copy_llvm_libunwind(builder: &Builder<'_>, target: TargetSelection, libdir: &Path) -> PathBuf {
 145     let libunwind_path = builder.ensure(native::Libunwind { target });
 146     let libunwind_source = libunwind_path.join("libunwind.a");
 147     let libunwind_target = libdir.join("libunwind.a");
 148     builder.copy(&libunwind_source, &libunwind_target);
 149     libunwind_target
 150 }
 151
 152 /// Copies third party objects needed by various targets.
 153 fn copy_third_party_objects(
 154     builder: &Builder<'_>,
 155     compiler: &Compiler,
 156     target: TargetSelection,
 157 ) -> Vec<(PathBuf, DependencyType)> {
 158     let mut target_deps = vec![];
 159
 160     // FIXME: remove this in 2021
 161     if target == "x86_64-fortanix-unknown-sgx" {
 162         if env::var_os("X86_FORTANIX_SGX_LIBS").is_some() {
 163             builder.info("Warning: X86_FORTANIX_SGX_LIBS environment variable is ignored, libunwind is now compiled as part of rustbuild");
 164         }
 165     }
 166
 167     if builder.config.sanitizers_enabled(target) && compiler.stage != 0 {
 168         // The sanitizers are only copied in stage1 or above,
 169         // to avoid creating dependency on LLVM.
 170         target_deps.extend(
 171             copy_sanitizers(builder, &compiler, target)
 172                 .into_iter()
 173                 .map(|d| (d, DependencyType::Target)),
 174         );
 175     }
 176
 177     if target == "x86_64-fortanix-unknown-sgx"
 178         || builder.config.llvm_libunwind == LlvmLibunwind::InTree
 179             && (target.contains("linux") || target.contains("fuchsia"))
 180     {
 181         let libunwind_path =
 182             copy_llvm_libunwind(builder, target, &builder.sysroot_libdir(*compiler, target));
 183         target_deps.push((libunwind_path, DependencyType::Target));
 184     }
 185
 186     target_deps
 187 }
 188
 189 /// Copies third party objects needed by various targets for self-contained linkage.
 190 fn copy_self_contained_objects(
 191     builder: &Builder<'_>,
 192     compiler: &Compiler,
 193     target: TargetSelection,
 194 ) -> Vec<(PathBuf, DependencyType)> {
 195     let libdir_self_contained = builder.sysroot_libdir(*compiler, target).join("self-contained");
 196     t!(fs::create_dir_all(&libdir_self_contained));
 197     let mut target_deps = vec![];
 198
 199     // Copies the libc and CRT objects.
 200     //
 201     // rustc historically provides a more self-contained installation for musl targets
 202     // not requiring the presence of a native musl toolchain. For example, it can fall back
 203     // to using gcc from a glibc-targeting toolchain for linking.
 204     // To do that we have to distribute musl startup objects as a part of Rust toolchain
 205     // and link with them manually in the self-contained mode.
 206     if target.contains("musl") {
 207         let srcdir = builder.musl_libdir(target).unwrap_or_else(|| {
 208             panic!("Target {:?} does not have a \"musl-libdir\" key", target.triple)
 209         });
 210         for &obj in &["libc.a", "crt1.o", "Scrt1.o", "rcrt1.o", "crti.o", "crtn.o"] {
 211             copy_and_stamp(
 212                 builder,
 213                 &libdir_self_contained,
 214                 &srcdir,
 215                 obj,
 216                 &mut target_deps,
 217                 DependencyType::TargetSelfContained,
 218             );
 219         }
 220         let crt_path = builder.ensure(native::CrtBeginEnd { target });
 221         for &obj in &["crtbegin.o", "crtbeginS.o", "crtend.o", "crtendS.o"] {
 222             let src = crt_path.join(obj);
 223             let target = libdir_self_contained.join(obj);
 224             builder.copy(&src, &target);
 225             target_deps.push((target, DependencyType::TargetSelfContained));
 226         }
 227
 228         if !target.starts_with("s390x") {
 229             let libunwind_path = copy_llvm_libunwind(builder, target, &libdir_self_contained);
 230             target_deps.push((libunwind_path, DependencyType::TargetSelfContained));
 231         }
 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, CLang::C, 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(builder.kind))
 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     if let Some(backend) = builder.config.rust_codegen_backends.get(0) {
 665         cargo.env("CFG_DEFAULT_CODEGEN_BACKEND", backend);
 666     }
 667
 668     let libdir_relative = builder.config.libdir_relative().unwrap_or_else(|| Path::new("lib"));
 669     let target_config = builder.config.target_config.get(&target);
 670
 671     cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
 672
 673     if let Some(ref ver_date) = builder.rust_info.commit_date() {
 674         cargo.env("CFG_VER_DATE", ver_date);
 675     }
 676     if let Some(ref ver_hash) = builder.rust_info.sha() {
 677         cargo.env("CFG_VER_HASH", ver_hash);
 678     }
 679     if !builder.unstable_features() {
 680         cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
 681     }
 682
 683     // Prefer the current target's own default_linker, else a globally
 684     // specified one.
 685     if let Some(s) = target_config.and_then(|c| c.default_linker.as_ref()) {
 686         cargo.env("CFG_DEFAULT_LINKER", s);
 687     } else if let Some(ref s) = builder.config.rustc_default_linker {
 688         cargo.env("CFG_DEFAULT_LINKER", s);
 689     }
 690
 691     if builder.config.rustc_parallel {
 692         // keep in sync with `bootstrap/lib.rs:Build::rustc_features`
 693         // `cfg` option for rustc, `features` option for cargo, for conditional compilation
 694         cargo.rustflag("--cfg=parallel_compiler");
 695         cargo.rustdocflag("--cfg=parallel_compiler");
 696     }
 697     if builder.config.rust_verify_llvm_ir {
 698         cargo.env("RUSTC_VERIFY_LLVM_IR", "1");
 699     }
 700
 701     // Pass down configuration from the LLVM build into the build of
 702     // rustc_llvm and rustc_codegen_llvm.
 703     //
 704     // Note that this is disabled if LLVM itself is disabled or we're in a check
 705     // build. If we are in a check build we still go ahead here presuming we've
 706     // detected that LLVM is already built and good to go which helps prevent
 707     // busting caches (e.g. like #71152).
 708     if builder.config.llvm_enabled()
 709         && (builder.kind != Kind::Check
 710             || crate::native::prebuilt_llvm_config(builder, target).is_ok())
 711     {
 712         if builder.is_rust_llvm(target) {
 713             cargo.env("LLVM_RUSTLLVM", "1");
 714         }
 715         let llvm_config = builder.ensure(native::Llvm { target });
 716         cargo.env("LLVM_CONFIG", &llvm_config);
 717         if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
 718             cargo.env("CFG_LLVM_ROOT", s);
 719         }
 720         // Some LLVM linker flags (-L and -l) may be needed to link rustc_llvm.
 721         if let Some(ref s) = builder.config.llvm_ldflags {
 722             cargo.env("LLVM_LINKER_FLAGS", s);
 723         }
 724         // Building with a static libstdc++ is only supported on linux right now,
 725         // not for MSVC or macOS
 726         if builder.config.llvm_static_stdcpp
 727             && !target.contains("freebsd")
 728             && !target.contains("msvc")
 729             && !target.contains("apple")
 730         {
 731             let file = compiler_file(
 732                 builder,
 733                 builder.cxx(target).unwrap(),
 734                 target,
 735                 CLang::Cxx,
 736                 "libstdc++.a",
 737             );
 738             cargo.env("LLVM_STATIC_STDCPP", file);
 739         }
 740         if builder.llvm_link_shared() {
 741             cargo.env("LLVM_LINK_SHARED", "1");
 742         }
 743         if builder.config.llvm_use_libcxx {
 744             cargo.env("LLVM_USE_LIBCXX", "1");
 745         }
 746         if builder.config.llvm_optimize && !builder.config.llvm_release_debuginfo {
 747             cargo.env("LLVM_NDEBUG", "1");
 748         }
 749     }
 750 }
 751
 752 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 753 struct RustcLink {
 754     pub compiler: Compiler,
 755     pub target_compiler: Compiler,
 756     pub target: TargetSelection,
 757 }
 758
 759 impl Step for RustcLink {
 760     type Output = ();
 761
 762     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 763         run.never()
 764     }
 765
 766     /// Same as `std_link`, only for librustc
 767     fn run(self, builder: &Builder<'_>) {
 768         let compiler = self.compiler;
 769         let target_compiler = self.target_compiler;
 770         let target = self.target;
 771         builder.info(&format!(
 772             "Copying stage{} rustc from stage{} ({} -> {} / {})",
 773             target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
 774         ));
 775         add_to_sysroot(
 776             builder,
 777             &builder.sysroot_libdir(target_compiler, target),
 778             &builder.sysroot_libdir(target_compiler, compiler.host),
 779             &librustc_stamp(builder, compiler, target),
 780         );
 781     }
 782 }
 783
 784 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 785 pub struct CodegenBackend {
 786     pub target: TargetSelection,
 787     pub compiler: Compiler,
 788     pub backend: Interned<String>,
 789 }
 790
 791 impl Step for CodegenBackend {
 792     type Output = ();
 793     const ONLY_HOSTS: bool = true;
 794     // Only the backends specified in the `codegen-backends` entry of `config.toml` are built.
 795     const DEFAULT: bool = true;
 796
 797     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 798         run.paths(&["compiler/rustc_codegen_cranelift", "compiler/rustc_codegen_gcc"])
 799     }
 800
 801     fn make_run(run: RunConfig<'_>) {
 802         for &backend in &run.builder.config.rust_codegen_backends {
 803             if backend == "llvm" {
 804                 continue; // Already built as part of rustc
 805             }
 806
 807             run.builder.ensure(CodegenBackend {
 808                 target: run.target,
 809                 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
 810                 backend,
 811             });
 812         }
 813     }
 814
 815     fn run(self, builder: &Builder<'_>) {
 816         let compiler = self.compiler;
 817         let target = self.target;
 818         let backend = self.backend;
 819
 820         builder.ensure(Rustc { compiler, target });
 821
 822         if builder.config.keep_stage.contains(&compiler.stage) {
 823             builder.info(
 824                 "Warning: Using a potentially old codegen backend. \
 825                 This may not behave well.",
 826             );
 827             // Codegen backends are linked separately from this step today, so we don't do
 828             // anything here.
 829             return;
 830         }
 831
 832         let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
 833         if compiler_to_use != compiler {
 834             builder.ensure(CodegenBackend { compiler: compiler_to_use, target, backend });
 835             return;
 836         }
 837
 838         let out_dir = builder.cargo_out(compiler, Mode::Codegen, target);
 839
 840         let mut cargo = builder.cargo(compiler, Mode::Codegen, SourceType::InTree, target, "build");
 841         cargo
 842             .arg("--manifest-path")
 843             .arg(builder.src.join(format!("compiler/rustc_codegen_{}/Cargo.toml", backend)));
 844         rustc_cargo_env(builder, &mut cargo, target);
 845
 846         let tmp_stamp = out_dir.join(".tmp.stamp");
 847
 848         builder.info(&format!(
 849             "Building stage{} codegen backend {} ({} -> {})",
 850             compiler.stage, backend, &compiler.host, target
 851         ));
 852         let files = run_cargo(builder, cargo, vec![], &tmp_stamp, vec![], false);
 853         if builder.config.dry_run {
 854             return;
 855         }
 856         let mut files = files.into_iter().filter(|f| {
 857             let filename = f.file_name().unwrap().to_str().unwrap();
 858             is_dylib(filename) && filename.contains("rustc_codegen_")
 859         });
 860         let codegen_backend = match files.next() {
 861             Some(f) => f,
 862             None => panic!("no dylibs built for codegen backend?"),
 863         };
 864         if let Some(f) = files.next() {
 865             panic!(
 866                 "codegen backend built two dylibs:\n{}\n{}",
 867                 codegen_backend.display(),
 868                 f.display()
 869             );
 870         }
 871         let stamp = codegen_backend_stamp(builder, compiler, target, backend);
 872         let codegen_backend = codegen_backend.to_str().unwrap();
 873         t!(fs::write(&stamp, &codegen_backend));
 874     }
 875 }
 876
 877 /// Creates the `codegen-backends` folder for a compiler that's about to be
 878 /// assembled as a complete compiler.
 879 ///
 880 /// This will take the codegen artifacts produced by `compiler` and link them
 881 /// into an appropriate location for `target_compiler` to be a functional
 882 /// compiler.
 883 fn copy_codegen_backends_to_sysroot(
 884     builder: &Builder<'_>,
 885     compiler: Compiler,
 886     target_compiler: Compiler,
 887 ) {
 888     let target = target_compiler.host;
 889
 890     // Note that this step is different than all the other `*Link` steps in
 891     // that it's not assembling a bunch of libraries but rather is primarily
 892     // moving the codegen backend into place. The codegen backend of rustc is
 893     // not linked into the main compiler by default but is rather dynamically
 894     // selected at runtime for inclusion.
 895     //
 896     // Here we're looking for the output dylib of the `CodegenBackend` step and
 897     // we're copying that into the `codegen-backends` folder.
 898     let dst = builder.sysroot_codegen_backends(target_compiler);
 899     t!(fs::create_dir_all(&dst), dst);
 900
 901     if builder.config.dry_run {
 902         return;
 903     }
 904
 905     for backend in builder.config.rust_codegen_backends.iter() {
 906         if backend == "llvm" {
 907             continue; // Already built as part of rustc
 908         }
 909
 910         let stamp = codegen_backend_stamp(builder, compiler, target, *backend);
 911         let dylib = t!(fs::read_to_string(&stamp));
 912         let file = Path::new(&dylib);
 913         let filename = file.file_name().unwrap().to_str().unwrap();
 914         // change `librustc_codegen_cranelift-xxxxxx.so` to
 915         // `librustc_codegen_cranelift-release.so`
 916         let target_filename = {
 917             let dash = filename.find('-').unwrap();
 918             let dot = filename.find('.').unwrap();
 919             format!("{}-{}{}", &filename[..dash], builder.rust_release(), &filename[dot..])
 920         };
 921         builder.copy(&file, &dst.join(target_filename));
 922     }
 923 }
 924
 925 /// Cargo's output path for the standard library in a given stage, compiled
 926 /// by a particular compiler for the specified target.
 927 pub fn libstd_stamp(builder: &Builder<'_>, compiler: Compiler, target: TargetSelection) -> PathBuf {
 928     builder.cargo_out(compiler, Mode::Std, target).join(".libstd.stamp")
 929 }
 930
 931 /// Cargo's output path for librustc in a given stage, compiled by a particular
 932 /// compiler for the specified target.
 933 pub fn librustc_stamp(
 934     builder: &Builder<'_>,
 935     compiler: Compiler,
 936     target: TargetSelection,
 937 ) -> PathBuf {
 938     builder.cargo_out(compiler, Mode::Rustc, target).join(".librustc.stamp")
 939 }
 940
 941 /// Cargo's output path for librustc_codegen_llvm in a given stage, compiled by a particular
 942 /// compiler for the specified target and backend.
 943 fn codegen_backend_stamp(
 944     builder: &Builder<'_>,
 945     compiler: Compiler,
 946     target: TargetSelection,
 947     backend: Interned<String>,
 948 ) -> PathBuf {
 949     builder
 950         .cargo_out(compiler, Mode::Codegen, target)
 951         .join(format!(".librustc_codegen_{}.stamp", backend))
 952 }
 953
 954 pub fn compiler_file(
 955     builder: &Builder<'_>,
 956     compiler: &Path,
 957     target: TargetSelection,
 958     c: CLang,
 959     file: &str,
 960 ) -> PathBuf {
 961     let mut cmd = Command::new(compiler);
 962     cmd.args(builder.cflags(target, GitRepo::Rustc, c));
 963     cmd.arg(format!("-print-file-name={}", file));
 964     let out = output(&mut cmd);
 965     PathBuf::from(out.trim())
 966 }
 967
 968 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 969 pub struct Sysroot {
 970     pub compiler: Compiler,
 971 }
 972
 973 impl Step for Sysroot {
 974     type Output = Interned<PathBuf>;
 975
 976     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 977         run.never()
 978     }
 979
 980     /// Returns the sysroot for the `compiler` specified that *this build system
 981     /// generates*.
 982     ///
 983     /// That is, the sysroot for the stage0 compiler is not what the compiler
 984     /// thinks it is by default, but it's the same as the default for stages
 985     /// 1-3.
 986     fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
 987         let compiler = self.compiler;
 988         let sysroot = if compiler.stage == 0 {
 989             builder.out.join(&compiler.host.triple).join("stage0-sysroot")
 990         } else {
 991             builder.out.join(&compiler.host.triple).join(format!("stage{}", compiler.stage))
 992         };
 993         let _ = fs::remove_dir_all(&sysroot);
 994         t!(fs::create_dir_all(&sysroot));
 995
 996         // If we're downloading a compiler from CI, we can use the same compiler for all stages other than 0.
 997         if builder.config.download_rustc && compiler.stage != 0 {
 998             assert_eq!(
 999                 builder.config.build, compiler.host,
1000                 "Cross-compiling is not yet supported with `download-rustc`",
1001             );
1002             // Copy the compiler into the correct sysroot.
1003             let ci_rustc_dir =
1004                 builder.config.out.join(&*builder.config.build.triple).join("ci-rustc");
1005             builder.cp_r(&ci_rustc_dir, &sysroot);
1006             return INTERNER.intern_path(sysroot);
1007         }
1008
1009         // Symlink the source root into the same location inside the sysroot,
1010         // where `rust-src` component would go (`$sysroot/lib/rustlib/src/rust`),
1011         // so that any tools relying on `rust-src` also work for local builds,
1012         // and also for translating the virtual `/rustc/$hash` back to the real
1013         // directory (for running tests with `rust.remap-debuginfo = true`).
1014         let sysroot_lib_rustlib_src = sysroot.join("lib/rustlib/src");
1015         t!(fs::create_dir_all(&sysroot_lib_rustlib_src));
1016         let sysroot_lib_rustlib_src_rust = sysroot_lib_rustlib_src.join("rust");
1017         if let Err(e) = symlink_dir(&builder.config, &builder.src, &sysroot_lib_rustlib_src_rust) {
1018             eprintln!(
1019                 "warning: creating symbolic link `{}` to `{}` failed with {}",
1020                 sysroot_lib_rustlib_src_rust.display(),
1021                 builder.src.display(),
1022                 e,
1023             );
1024             if builder.config.rust_remap_debuginfo {
1025                 eprintln!(
1026                     "warning: some `src/test/ui` tests will fail when lacking `{}`",
1027                     sysroot_lib_rustlib_src_rust.display(),
1028                 );
1029             }
1030         }
1031
1032         INTERNER.intern_path(sysroot)
1033     }
1034 }
1035
1036 #[derive(Debug, Copy, PartialOrd, Ord, Clone, PartialEq, Eq, Hash)]
1037 pub struct Assemble {
1038     /// The compiler which we will produce in this step. Assemble itself will
1039     /// take care of ensuring that the necessary prerequisites to do so exist,
1040     /// that is, this target can be a stage2 compiler and Assemble will build
1041     /// previous stages for you.
1042     pub target_compiler: Compiler,
1043 }
1044
1045 impl Step for Assemble {
1046     type Output = Compiler;
1047     const ONLY_HOSTS: bool = true;
1048
1049     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1050         run.path("compiler/rustc").path("compiler")
1051     }
1052
1053     fn make_run(run: RunConfig<'_>) {
1054         run.builder.ensure(Assemble {
1055             target_compiler: run.builder.compiler(run.builder.top_stage + 1, run.target),
1056         });
1057     }
1058
1059     /// Prepare a new compiler from the artifacts in `stage`
1060     ///
1061     /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
1062     /// must have been previously produced by the `stage - 1` builder.build
1063     /// compiler.
1064     fn run(self, builder: &Builder<'_>) -> Compiler {
1065         let target_compiler = self.target_compiler;
1066
1067         if target_compiler.stage == 0 {
1068             assert_eq!(
1069                 builder.config.build, target_compiler.host,
1070                 "Cannot obtain compiler for non-native build triple at stage 0"
1071             );
1072             // The stage 0 compiler for the build triple is always pre-built.
1073             return target_compiler;
1074         }
1075
1076         // Get the compiler that we'll use to bootstrap ourselves.
1077         //
1078         // Note that this is where the recursive nature of the bootstrap
1079         // happens, as this will request the previous stage's compiler on
1080         // downwards to stage 0.
1081         //
1082         // Also note that we're building a compiler for the host platform. We
1083         // only assume that we can run `build` artifacts, which means that to
1084         // produce some other architecture compiler we need to start from
1085         // `build` to get there.
1086         //
1087         // FIXME: It may be faster if we build just a stage 1 compiler and then
1088         //        use that to bootstrap this compiler forward.
1089         let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
1090
1091         // If we're downloading a compiler from CI, we can use the same compiler for all stages other than 0.
1092         if builder.config.download_rustc {
1093             builder.ensure(Sysroot { compiler: target_compiler });
1094             return target_compiler;
1095         }
1096
1097         // Build the libraries for this compiler to link to (i.e., the libraries
1098         // it uses at runtime). NOTE: Crates the target compiler compiles don't
1099         // link to these. (FIXME: Is that correct? It seems to be correct most
1100         // of the time but I think we do link to these for stage2/bin compilers
1101         // when not performing a full bootstrap).
1102         builder.ensure(Rustc { compiler: build_compiler, target: target_compiler.host });
1103
1104         for &backend in builder.config.rust_codegen_backends.iter() {
1105             if backend == "llvm" {
1106                 continue; // Already built as part of rustc
1107             }
1108
1109             builder.ensure(CodegenBackend {
1110                 compiler: build_compiler,
1111                 target: target_compiler.host,
1112                 backend,
1113             });
1114         }
1115
1116         let lld_install = if builder.config.lld_enabled {
1117             Some(builder.ensure(native::Lld { target: target_compiler.host }))
1118         } else {
1119             None
1120         };
1121
1122         let stage = target_compiler.stage;
1123         let host = target_compiler.host;
1124         builder.info(&format!("Assembling stage{} compiler ({})", stage, host));
1125
1126         // Link in all dylibs to the libdir
1127         let stamp = librustc_stamp(builder, build_compiler, target_compiler.host);
1128         let proc_macros = builder
1129             .read_stamp_file(&stamp)
1130             .into_iter()
1131             .filter_map(|(path, dependency_type)| {
1132                 if dependency_type == DependencyType::Host {
1133                     Some(path.file_name().unwrap().to_owned().into_string().unwrap())
1134                 } else {
1135                     None
1136                 }
1137             })
1138             .collect::<HashSet<_>>();
1139
1140         let sysroot = builder.sysroot(target_compiler);
1141         let rustc_libdir = builder.rustc_libdir(target_compiler);
1142         t!(fs::create_dir_all(&rustc_libdir));
1143         let src_libdir = builder.sysroot_libdir(build_compiler, host);
1144         for f in builder.read_dir(&src_libdir) {
1145             let filename = f.file_name().into_string().unwrap();
1146             if (is_dylib(&filename) || is_debug_info(&filename)) && !proc_macros.contains(&filename)
1147             {
1148                 builder.copy(&f.path(), &rustc_libdir.join(&filename));
1149             }
1150         }
1151
1152         copy_codegen_backends_to_sysroot(builder, build_compiler, target_compiler);
1153
1154         // We prepend this bin directory to the user PATH when linking Rust binaries. To
1155         // avoid shadowing the system LLD we rename the LLD we provide to `rust-lld`.
1156         let libdir = builder.sysroot_libdir(target_compiler, target_compiler.host);
1157         let libdir_bin = libdir.parent().unwrap().join("bin");
1158         t!(fs::create_dir_all(&libdir_bin));
1159         if let Some(lld_install) = lld_install {
1160             let src_exe = exe("lld", target_compiler.host);
1161             let dst_exe = exe("rust-lld", target_compiler.host);
1162             builder.copy(&lld_install.join("bin").join(&src_exe), &libdir_bin.join(&dst_exe));
1163             // for `-Z gcc-ld=lld`
1164             let gcc_ld_dir = libdir_bin.join("gcc-ld");
1165             t!(fs::create_dir(&gcc_ld_dir));
1166             for flavor in ["ld", "ld64"] {
1167                 let lld_wrapper_exe = builder.ensure(crate::tool::LldWrapper {
1168                     compiler: build_compiler,
1169                     target: target_compiler.host,
1170                     flavor_feature: flavor,
1171                 });
1172                 builder.copy(&lld_wrapper_exe, &gcc_ld_dir.join(exe(flavor, target_compiler.host)));
1173             }
1174         }
1175
1176         if builder.config.rust_codegen_backends.contains(&INTERNER.intern_str("llvm")) {
1177             let llvm_config_bin = builder.ensure(native::Llvm { target: target_compiler.host });
1178             if !builder.config.dry_run {
1179                 let llvm_bin_dir = output(Command::new(llvm_config_bin).arg("--bindir"));
1180                 let llvm_bin_dir = Path::new(llvm_bin_dir.trim());
1181
1182                 // Since we've already built the LLVM tools, install them to the sysroot.
1183                 // This is the equivalent of installing the `llvm-tools-preview` component via
1184                 // rustup, and lets developers use a locally built toolchain to
1185                 // build projects that expect llvm tools to be present in the sysroot
1186                 // (e.g. the `bootimage` crate).
1187                 for tool in LLVM_TOOLS {
1188                     let tool_exe = exe(tool, target_compiler.host);
1189                     let src_path = llvm_bin_dir.join(&tool_exe);
1190                     // When using `download-ci-llvm`, some of the tools
1191                     // may not exist, so skip trying to copy them.
1192                     if src_path.exists() {
1193                         builder.copy(&src_path, &libdir_bin.join(&tool_exe));
1194                     }
1195                 }
1196             }
1197         }
1198
1199         // Ensure that `libLLVM.so` ends up in the newly build compiler directory,
1200         // so that it can be found when the newly built `rustc` is run.
1201         dist::maybe_install_llvm_runtime(builder, target_compiler.host, &sysroot);
1202         dist::maybe_install_llvm_target(builder, target_compiler.host, &sysroot);
1203
1204         // Link the compiler binary itself into place
1205         let out_dir = builder.cargo_out(build_compiler, Mode::Rustc, host);
1206         let rustc = out_dir.join(exe("rustc-main", host));
1207         let bindir = sysroot.join("bin");
1208         t!(fs::create_dir_all(&bindir));
1209         let compiler = builder.rustc(target_compiler);
1210         builder.copy(&rustc, &compiler);
1211
1212         target_compiler
1213     }
1214 }
1215
1216 /// Link some files into a rustc sysroot.
1217 ///
1218 /// For a particular stage this will link the file listed in `stamp` into the
1219 /// `sysroot_dst` provided.
1220 pub fn add_to_sysroot(
1221     builder: &Builder<'_>,
1222     sysroot_dst: &Path,
1223     sysroot_host_dst: &Path,
1224     stamp: &Path,
1225 ) {
1226     let self_contained_dst = &sysroot_dst.join("self-contained");
1227     t!(fs::create_dir_all(&sysroot_dst));
1228     t!(fs::create_dir_all(&sysroot_host_dst));
1229     t!(fs::create_dir_all(&self_contained_dst));
1230     for (path, dependency_type) in builder.read_stamp_file(stamp) {
1231         let dst = match dependency_type {
1232             DependencyType::Host => sysroot_host_dst,
1233             DependencyType::Target => sysroot_dst,
1234             DependencyType::TargetSelfContained => self_contained_dst,
1235         };
1236         builder.copy(&path, &dst.join(path.file_name().unwrap()));
1237     }
1238 }
1239
1240 pub fn run_cargo(
1241     builder: &Builder<'_>,
1242     cargo: Cargo,
1243     tail_args: Vec<String>,
1244     stamp: &Path,
1245     additional_target_deps: Vec<(PathBuf, DependencyType)>,
1246     is_check: bool,
1247 ) -> Vec<PathBuf> {
1248     if builder.config.dry_run {
1249         return Vec::new();
1250     }
1251
1252     // `target_root_dir` looks like $dir/$target/release
1253     let target_root_dir = stamp.parent().unwrap();
1254     // `target_deps_dir` looks like $dir/$target/release/deps
1255     let target_deps_dir = target_root_dir.join("deps");
1256     // `host_root_dir` looks like $dir/release
1257     let host_root_dir = target_root_dir
1258         .parent()
1259         .unwrap() // chop off `release`
1260         .parent()
1261         .unwrap() // chop off `$target`
1262         .join(target_root_dir.file_name().unwrap());
1263
1264     // Spawn Cargo slurping up its JSON output. We'll start building up the
1265     // `deps` array of all files it generated along with a `toplevel` array of
1266     // files we need to probe for later.
1267     let mut deps = Vec::new();
1268     let mut toplevel = Vec::new();
1269     let ok = stream_cargo(builder, cargo, tail_args, &mut |msg| {
1270         let (filenames, crate_types) = match msg {
1271             CargoMessage::CompilerArtifact {
1272                 filenames,
1273                 target: CargoTarget { crate_types },
1274                 ..
1275             } => (filenames, crate_types),
1276             _ => return,
1277         };
1278         for filename in filenames {
1279             // Skip files like executables
1280             if !(filename.ends_with(".rlib")
1281                 || filename.ends_with(".lib")
1282                 || filename.ends_with(".a")
1283                 || is_debug_info(&filename)
1284                 || is_dylib(&filename)
1285                 || (is_check && filename.ends_with(".rmeta")))
1286             {
1287                 continue;
1288             }
1289
1290             let filename = Path::new(&*filename);
1291
1292             // If this was an output file in the "host dir" we don't actually
1293             // worry about it, it's not relevant for us
1294             if filename.starts_with(&host_root_dir) {
1295                 // Unless it's a proc macro used in the compiler
1296                 if crate_types.iter().any(|t| t == "proc-macro") {
1297                     deps.push((filename.to_path_buf(), DependencyType::Host));
1298                 }
1299                 continue;
1300             }
1301
1302             // If this was output in the `deps` dir then this is a precise file
1303             // name (hash included) so we start tracking it.
1304             if filename.starts_with(&target_deps_dir) {
1305                 deps.push((filename.to_path_buf(), DependencyType::Target));
1306                 continue;
1307             }
1308
1309             // Otherwise this was a "top level artifact" which right now doesn't
1310             // have a hash in the name, but there's a version of this file in
1311             // the `deps` folder which *does* have a hash in the name. That's
1312             // the one we'll want to we'll probe for it later.
1313             //
1314             // We do not use `Path::file_stem` or `Path::extension` here,
1315             // because some generated files may have multiple extensions e.g.
1316             // `std-<hash>.dll.lib` on Windows. The aforementioned methods only
1317             // split the file name by the last extension (`.lib`) while we need
1318             // to split by all extensions (`.dll.lib`).
1319             let expected_len = t!(filename.metadata()).len();
1320             let filename = filename.file_name().unwrap().to_str().unwrap();
1321             let mut parts = filename.splitn(2, '.');
1322             let file_stem = parts.next().unwrap().to_owned();
1323             let extension = parts.next().unwrap().to_owned();
1324
1325             toplevel.push((file_stem, extension, expected_len));
1326         }
1327     });
1328
1329     if !ok {
1330         exit(1);
1331     }
1332
1333     // Ok now we need to actually find all the files listed in `toplevel`. We've
1334     // got a list of prefix/extensions and we basically just need to find the
1335     // most recent file in the `deps` folder corresponding to each one.
1336     let contents = t!(target_deps_dir.read_dir())
1337         .map(|e| t!(e))
1338         .map(|e| (e.path(), e.file_name().into_string().unwrap(), t!(e.metadata())))
1339         .collect::<Vec<_>>();
1340     for (prefix, extension, expected_len) in toplevel {
1341         let candidates = contents.iter().filter(|&&(_, ref filename, ref meta)| {
1342             meta.len() == expected_len
1343                 && filename
1344                     .strip_prefix(&prefix[..])
1345                     .map(|s| s.starts_with('-') && s.ends_with(&extension[..]))
1346                     .unwrap_or(false)
1347         });
1348         let max = candidates.max_by_key(|&&(_, _, ref metadata)| {
1349             metadata.modified().expect("mtime should be available on all relevant OSes")
1350         });
1351         let path_to_add = match max {
1352             Some(triple) => triple.0.to_str().unwrap(),
1353             None => panic!("no output generated for {:?} {:?}", prefix, extension),
1354         };
1355         if is_dylib(path_to_add) {
1356             let candidate = format!("{}.lib", path_to_add);
1357             let candidate = PathBuf::from(candidate);
1358             if candidate.exists() {
1359                 deps.push((candidate, DependencyType::Target));
1360             }
1361         }
1362         deps.push((path_to_add.into(), DependencyType::Target));
1363     }
1364
1365     deps.extend(additional_target_deps);
1366     deps.sort();
1367     let mut new_contents = Vec::new();
1368     for (dep, dependency_type) in deps.iter() {
1369         new_contents.extend(match *dependency_type {
1370             DependencyType::Host => b"h",
1371             DependencyType::Target => b"t",
1372             DependencyType::TargetSelfContained => b"s",
1373         });
1374         new_contents.extend(dep.to_str().unwrap().as_bytes());
1375         new_contents.extend(b"\0");
1376     }
1377     t!(fs::write(&stamp, &new_contents));
1378     deps.into_iter().map(|(d, _)| d).collect()
1379 }
1380
1381 pub fn stream_cargo(
1382     builder: &Builder<'_>,
1383     cargo: Cargo,
1384     tail_args: Vec<String>,
1385     cb: &mut dyn FnMut(CargoMessage<'_>),
1386 ) -> bool {
1387     let mut cargo = Command::from(cargo);
1388     if builder.config.dry_run {
1389         return true;
1390     }
1391     // Instruct Cargo to give us json messages on stdout, critically leaving
1392     // stderr as piped so we can get those pretty colors.
1393     let mut message_format = if builder.config.json_output {
1394         String::from("json")
1395     } else {
1396         String::from("json-render-diagnostics")
1397     };
1398     if let Some(s) = &builder.config.rustc_error_format {
1399         message_format.push_str(",json-diagnostic-");
1400         message_format.push_str(s);
1401     }
1402     cargo.arg("--message-format").arg(message_format).stdout(Stdio::piped());
1403
1404     for arg in tail_args {
1405         cargo.arg(arg);
1406     }
1407
1408     builder.verbose(&format!("running: {:?}", cargo));
1409     let mut child = match cargo.spawn() {
1410         Ok(child) => child,
1411         Err(e) => panic!("failed to execute command: {:?}\nerror: {}", cargo, e),
1412     };
1413
1414     // Spawn Cargo slurping up its JSON output. We'll start building up the
1415     // `deps` array of all files it generated along with a `toplevel` array of
1416     // files we need to probe for later.
1417     let stdout = BufReader::new(child.stdout.take().unwrap());
1418     for line in stdout.lines() {
1419         let line = t!(line);
1420         match serde_json::from_str::<CargoMessage<'_>>(&line) {
1421             Ok(msg) => {
1422                 if builder.config.json_output {
1423                     // Forward JSON to stdout.
1424                     println!("{}", line);
1425                 }
1426                 cb(msg)
1427             }
1428             // If this was informational, just print it out and continue
1429             Err(_) => println!("{}", line),
1430         }
1431     }
1432
1433     // Make sure Cargo actually succeeded after we read all of its stdout.
1434     let status = t!(child.wait());
1435     if builder.is_verbose() && !status.success() {
1436         eprintln!(
1437             "command did not execute successfully: {:?}\n\
1438                   expected success, got: {}",
1439             cargo, status
1440         );
1441     }
1442     status.success()
1443 }
1444
1445 #[derive(Deserialize)]
1446 pub struct CargoTarget<'a> {
1447     crate_types: Vec<Cow<'a, str>>,
1448 }
1449
1450 #[derive(Deserialize)]
1451 #[serde(tag = "reason", rename_all = "kebab-case")]
1452 pub enum CargoMessage<'a> {
1453     CompilerArtifact {
1454         package_id: Cow<'a, str>,
1455         features: Vec<Cow<'a, str>>,
1456         filenames: Vec<Cow<'a, str>>,
1457         target: CargoTarget<'a>,
1458     },
1459     BuildScriptExecuted {
1460         package_id: Cow<'a, str>,
1461     },
1462     BuildFinished {
1463         success: bool,
1464     },
1465 }