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