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