src/bootstrap/compile.rs

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