src/bootstrap/compile.rs

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