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