1 //! Implementation of compiling various phases of the compiler and standard
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.
10 use std::collections::HashSet;
13 use std::io::prelude::*;
14 use std::io::BufReader;
15 use std::path::{Path, PathBuf};
16 use std::process::{exit, Command, Stdio};
19 use serde::Deserialize;
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};
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};
32 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
34 pub target: TargetSelection,
35 pub compiler: Compiler,
40 const DEFAULT: bool = true;
42 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
43 // When downloading stage1, the standard library has already been copied to the sysroot, so
44 // there's no need to rebuild it.
45 let builder = run.builder;
46 run.all_krates("test")
48 .lazy_default_condition(Box::new(|| !builder.download_rustc()))
51 fn make_run(run: RunConfig<'_>) {
52 run.builder.ensure(Std {
53 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
58 /// Builds the standard library.
60 /// This will build the standard library for a particular stage of the build
61 /// using the `compiler` targeting the `target` architecture. The artifacts
62 /// created will also be linked into the sysroot directory.
63 fn run(self, builder: &Builder<'_>) {
64 let target = self.target;
65 let compiler = self.compiler;
67 // These artifacts were already copied (in `impl Step for Sysroot`).
68 // Don't recompile them.
69 // NOTE: the ABI of the beta compiler is different from the ABI of the downloaded compiler,
70 // so its artifacts can't be reused.
71 if builder.download_rustc() && compiler.stage != 0 {
75 if builder.config.keep_stage.contains(&compiler.stage)
76 || builder.config.keep_stage_std.contains(&compiler.stage)
78 builder.info("Warning: Using a potentially old libstd. This may not behave well.");
79 builder.ensure(StdLink { compiler, target_compiler: compiler, target });
83 builder.update_submodule(&Path::new("library").join("stdarch"));
85 let mut target_deps = builder.ensure(StartupObjects { compiler, target });
87 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
88 if compiler_to_use != compiler {
89 builder.ensure(Std { compiler: compiler_to_use, target });
90 builder.info(&format!("Uplifting stage1 std ({} -> {})", compiler_to_use.host, target));
92 // Even if we're not building std this stage, the new sysroot must
93 // still contain the third party objects needed by various targets.
94 copy_third_party_objects(builder, &compiler, target);
95 copy_self_contained_objects(builder, &compiler, target);
97 builder.ensure(StdLink {
98 compiler: compiler_to_use,
99 target_compiler: compiler,
105 target_deps.extend(copy_third_party_objects(builder, &compiler, target));
106 target_deps.extend(copy_self_contained_objects(builder, &compiler, target));
108 let mut cargo = builder.cargo(compiler, Mode::Std, SourceType::InTree, target, "build");
109 std_cargo(builder, target, compiler.stage, &mut cargo);
111 builder.info(&format!(
112 "Building stage{} std artifacts ({} -> {})",
113 compiler.stage, &compiler.host, target
119 &libstd_stamp(builder, compiler, target),
124 builder.ensure(StdLink {
125 compiler: builder.compiler(compiler.stage, builder.config.build),
126 target_compiler: compiler,
133 builder: &Builder<'_>,
137 target_deps: &mut Vec<(PathBuf, DependencyType)>,
138 dependency_type: DependencyType,
140 let target = libdir.join(name);
141 builder.copy(&sourcedir.join(name), &target);
143 target_deps.push((target, dependency_type));
146 fn copy_llvm_libunwind(builder: &Builder<'_>, target: TargetSelection, libdir: &Path) -> PathBuf {
147 let libunwind_path = builder.ensure(native::Libunwind { target });
148 let libunwind_source = libunwind_path.join("libunwind.a");
149 let libunwind_target = libdir.join("libunwind.a");
150 builder.copy(&libunwind_source, &libunwind_target);
154 /// Copies third party objects needed by various targets.
155 fn copy_third_party_objects(
156 builder: &Builder<'_>,
158 target: TargetSelection,
159 ) -> Vec<(PathBuf, DependencyType)> {
160 let mut target_deps = vec![];
162 // FIXME: remove this in 2021
163 if target == "x86_64-fortanix-unknown-sgx" {
164 if env::var_os("X86_FORTANIX_SGX_LIBS").is_some() {
165 builder.info("Warning: X86_FORTANIX_SGX_LIBS environment variable is ignored, libunwind is now compiled as part of rustbuild");
169 if builder.config.sanitizers_enabled(target) && compiler.stage != 0 {
170 // The sanitizers are only copied in stage1 or above,
171 // to avoid creating dependency on LLVM.
173 copy_sanitizers(builder, &compiler, target)
175 .map(|d| (d, DependencyType::Target)),
179 if target == "x86_64-fortanix-unknown-sgx"
180 || target.contains("pc-windows-gnullvm")
181 || builder.config.llvm_libunwind(target) == LlvmLibunwind::InTree
182 && (target.contains("linux") || target.contains("fuchsia"))
185 copy_llvm_libunwind(builder, target, &builder.sysroot_libdir(*compiler, target));
186 target_deps.push((libunwind_path, DependencyType::Target));
192 /// Copies third party objects needed by various targets for self-contained linkage.
193 fn copy_self_contained_objects(
194 builder: &Builder<'_>,
196 target: TargetSelection,
197 ) -> Vec<(PathBuf, DependencyType)> {
198 let libdir_self_contained = builder.sysroot_libdir(*compiler, target).join("self-contained");
199 t!(fs::create_dir_all(&libdir_self_contained));
200 let mut target_deps = vec![];
202 // Copies the libc and CRT objects.
204 // rustc historically provides a more self-contained installation for musl targets
205 // not requiring the presence of a native musl toolchain. For example, it can fall back
206 // to using gcc from a glibc-targeting toolchain for linking.
207 // To do that we have to distribute musl startup objects as a part of Rust toolchain
208 // and link with them manually in the self-contained mode.
209 if target.contains("musl") {
210 let srcdir = builder.musl_libdir(target).unwrap_or_else(|| {
211 panic!("Target {:?} does not have a \"musl-libdir\" key", target.triple)
213 for &obj in &["libc.a", "crt1.o", "Scrt1.o", "rcrt1.o", "crti.o", "crtn.o"] {
216 &libdir_self_contained,
220 DependencyType::TargetSelfContained,
223 let crt_path = builder.ensure(native::CrtBeginEnd { target });
224 for &obj in &["crtbegin.o", "crtbeginS.o", "crtend.o", "crtendS.o"] {
225 let src = crt_path.join(obj);
226 let target = libdir_self_contained.join(obj);
227 builder.copy(&src, &target);
228 target_deps.push((target, DependencyType::TargetSelfContained));
231 if !target.starts_with("s390x") {
232 let libunwind_path = copy_llvm_libunwind(builder, target, &libdir_self_contained);
233 target_deps.push((libunwind_path, DependencyType::TargetSelfContained));
235 } else if target.ends_with("-wasi") {
239 panic!("Target {:?} does not have a \"wasi-root\" key", target.triple)
241 .join("lib/wasm32-wasi");
242 for &obj in &["libc.a", "crt1-command.o", "crt1-reactor.o"] {
245 &libdir_self_contained,
249 DependencyType::TargetSelfContained,
252 } else if target.ends_with("windows-gnu") {
253 for obj in ["crt2.o", "dllcrt2.o"].iter() {
254 let src = compiler_file(builder, builder.cc(target), target, CLang::C, obj);
255 let target = libdir_self_contained.join(obj);
256 builder.copy(&src, &target);
257 target_deps.push((target, DependencyType::TargetSelfContained));
264 /// Configure cargo to compile the standard library, adding appropriate env vars
266 pub fn std_cargo(builder: &Builder<'_>, target: TargetSelection, stage: u32, cargo: &mut Cargo) {
267 if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
268 cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
271 // Determine if we're going to compile in optimized C intrinsics to
272 // the `compiler-builtins` crate. These intrinsics live in LLVM's
273 // `compiler-rt` repository, but our `src/llvm-project` submodule isn't
274 // always checked out, so we need to conditionally look for this. (e.g. if
275 // an external LLVM is used we skip the LLVM submodule checkout).
277 // Note that this shouldn't affect the correctness of `compiler-builtins`,
278 // but only its speed. Some intrinsics in C haven't been translated to Rust
279 // yet but that's pretty rare. Other intrinsics have optimized
280 // implementations in C which have only had slower versions ported to Rust,
281 // so we favor the C version where we can, but it's not critical.
283 // If `compiler-rt` is available ensure that the `c` feature of the
284 // `compiler-builtins` crate is enabled and it's configured to learn where
285 // `compiler-rt` is located.
286 let compiler_builtins_root = builder.src.join("src/llvm-project/compiler-rt");
287 let compiler_builtins_c_feature = if compiler_builtins_root.exists() {
288 // Note that `libprofiler_builtins/build.rs` also computes this so if
289 // you're changing something here please also change that.
290 cargo.env("RUST_COMPILER_RT_ROOT", &compiler_builtins_root);
291 " compiler-builtins-c"
296 if builder.no_std(target) == Some(true) {
297 let mut features = "compiler-builtins-mem".to_string();
298 if !target.starts_with("bpf") {
299 features.push_str(compiler_builtins_c_feature);
302 // for no-std targets we only compile a few no_std crates
304 .args(&["-p", "alloc"])
305 .arg("--manifest-path")
306 .arg(builder.src.join("library/alloc/Cargo.toml"))
310 let mut features = builder.std_features(target);
311 features.push_str(compiler_builtins_c_feature);
316 .arg("--manifest-path")
317 .arg(builder.src.join("library/test/Cargo.toml"));
319 // Help the libc crate compile by assisting it in finding various
320 // sysroot native libraries.
321 if target.contains("musl") {
322 if let Some(p) = builder.musl_libdir(target) {
323 let root = format!("native={}", p.to_str().unwrap());
324 cargo.rustflag("-L").rustflag(&root);
328 if target.ends_with("-wasi") {
329 if let Some(p) = builder.wasi_root(target) {
330 let root = format!("native={}/lib/wasm32-wasi", p.to_str().unwrap());
331 cargo.rustflag("-L").rustflag(&root);
336 // By default, rustc uses `-Cembed-bitcode=yes`, and Cargo overrides that
337 // with `-Cembed-bitcode=no` for non-LTO builds. However, libstd must be
338 // built with bitcode so that the produced rlibs can be used for both LTO
339 // builds (which use bitcode) and non-LTO builds (which use object code).
340 // So we override the override here!
342 // But we don't bother for the stage 0 compiler because it's never used
345 cargo.rustflag("-Cembed-bitcode=yes");
348 // By default, rustc does not include unwind tables unless they are required
349 // for a particular target. They are not required by RISC-V targets, but
350 // compiling the standard library with them means that users can get
351 // backtraces without having to recompile the standard library themselves.
353 // This choice was discussed in https://github.com/rust-lang/rust/pull/69890
354 if target.contains("riscv") {
355 cargo.rustflag("-Cforce-unwind-tables=yes");
359 format!("-Zcrate-attr=doc(html_root_url=\"{}/\")", builder.doc_rust_lang_org_channel(),);
360 cargo.rustflag(&html_root);
361 cargo.rustdocflag(&html_root);
364 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
366 pub compiler: Compiler,
367 pub target_compiler: Compiler,
368 pub target: TargetSelection,
371 impl Step for StdLink {
374 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
378 /// Link all libstd rlibs/dylibs into the sysroot location.
380 /// Links those artifacts generated by `compiler` to the `stage` compiler's
381 /// sysroot for the specified `host` and `target`.
383 /// Note that this assumes that `compiler` has already generated the libstd
384 /// libraries for `target`, and this method will find them in the relevant
385 /// output directory.
386 fn run(self, builder: &Builder<'_>) {
387 let compiler = self.compiler;
388 let target_compiler = self.target_compiler;
389 let target = self.target;
390 builder.info(&format!(
391 "Copying stage{} std from stage{} ({} -> {} / {})",
392 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
394 let libdir = builder.sysroot_libdir(target_compiler, target);
395 let hostdir = builder.sysroot_libdir(target_compiler, compiler.host);
396 add_to_sysroot(builder, &libdir, &hostdir, &libstd_stamp(builder, compiler, target));
400 /// Copies sanitizer runtime libraries into target libdir.
402 builder: &Builder<'_>,
404 target: TargetSelection,
406 let runtimes: Vec<native::SanitizerRuntime> = builder.ensure(native::Sanitizers { target });
408 if builder.config.dry_run {
412 let mut target_deps = Vec::new();
413 let libdir = builder.sysroot_libdir(*compiler, target);
415 for runtime in &runtimes {
416 let dst = libdir.join(&runtime.name);
417 builder.copy(&runtime.path, &dst);
419 if target == "x86_64-apple-darwin" || target == "aarch64-apple-darwin" {
420 // Update the library’s install name to reflect that it has has been renamed.
421 apple_darwin_update_library_name(&dst, &format!("@rpath/{}", &runtime.name));
422 // Upon renaming the install name, the code signature of the file will invalidate,
423 // so we will sign it again.
424 apple_darwin_sign_file(&dst);
427 target_deps.push(dst);
433 fn apple_darwin_update_library_name(library_path: &Path, new_name: &str) {
434 let status = Command::new("install_name_tool")
439 .expect("failed to execute `install_name_tool`");
440 assert!(status.success());
443 fn apple_darwin_sign_file(file_path: &Path) {
444 let status = Command::new("codesign")
445 .arg("-f") // Force to rewrite the existing signature
450 .expect("failed to execute `codesign`");
451 assert!(status.success());
454 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
455 pub struct StartupObjects {
456 pub compiler: Compiler,
457 pub target: TargetSelection,
460 impl Step for StartupObjects {
461 type Output = Vec<(PathBuf, DependencyType)>;
463 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
464 run.path("library/rtstartup")
467 fn make_run(run: RunConfig<'_>) {
468 run.builder.ensure(StartupObjects {
469 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
474 /// Builds and prepare startup objects like rsbegin.o and rsend.o
476 /// These are primarily used on Windows right now for linking executables/dlls.
477 /// They don't require any library support as they're just plain old object
478 /// files, so we just use the nightly snapshot compiler to always build them (as
479 /// no other compilers are guaranteed to be available).
480 fn run(self, builder: &Builder<'_>) -> Vec<(PathBuf, DependencyType)> {
481 let for_compiler = self.compiler;
482 let target = self.target;
483 if !target.ends_with("windows-gnu") {
487 let mut target_deps = vec![];
489 let src_dir = &builder.src.join("library").join("rtstartup");
490 let dst_dir = &builder.native_dir(target).join("rtstartup");
491 let sysroot_dir = &builder.sysroot_libdir(for_compiler, target);
492 t!(fs::create_dir_all(dst_dir));
494 for file in &["rsbegin", "rsend"] {
495 let src_file = &src_dir.join(file.to_string() + ".rs");
496 let dst_file = &dst_dir.join(file.to_string() + ".o");
497 if !up_to_date(src_file, dst_file) {
498 let mut cmd = Command::new(&builder.initial_rustc);
499 cmd.env("RUSTC_BOOTSTRAP", "1");
500 if !builder.local_rebuild {
501 // a local_rebuild compiler already has stage1 features
502 cmd.arg("--cfg").arg("bootstrap");
506 .arg(target.rustc_target_arg())
514 let target = sysroot_dir.join((*file).to_string() + ".o");
515 builder.copy(dst_file, &target);
516 target_deps.push((target, DependencyType::Target));
523 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
525 pub target: TargetSelection,
526 pub compiler: Compiler,
529 impl Step for Rustc {
531 const ONLY_HOSTS: bool = true;
532 const DEFAULT: bool = false;
534 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
538 fn make_run(run: RunConfig<'_>) {
539 run.builder.ensure(Rustc {
540 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
545 /// Builds the compiler.
547 /// This will build the compiler for a particular stage of the build using
548 /// the `compiler` targeting the `target` architecture. The artifacts
549 /// created will also be linked into the sysroot directory.
550 fn run(self, builder: &Builder<'_>) {
551 let compiler = self.compiler;
552 let target = self.target;
554 // NOTE: the ABI of the beta compiler is different from the ABI of the downloaded compiler,
555 // so its artifacts can't be reused.
556 if builder.download_rustc() && compiler.stage != 0 {
557 // Copy the existing artifacts instead of rebuilding them.
558 // NOTE: this path is only taken for tools linking to rustc-dev.
559 builder.ensure(Sysroot { compiler });
563 builder.ensure(Std { compiler, target });
565 if builder.config.keep_stage.contains(&compiler.stage) {
566 builder.info("Warning: Using a potentially old librustc. This may not behave well.");
567 builder.info("Warning: Use `--keep-stage-std` if you want to rebuild the compiler when it changes");
568 builder.ensure(RustcLink { compiler, target_compiler: compiler, target });
572 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
573 if compiler_to_use != compiler {
574 builder.ensure(Rustc { compiler: compiler_to_use, target });
576 .info(&format!("Uplifting stage1 rustc ({} -> {})", builder.config.build, target));
577 builder.ensure(RustcLink {
578 compiler: compiler_to_use,
579 target_compiler: compiler,
585 // Ensure that build scripts and proc macros have a std / libproc_macro to link against.
587 compiler: builder.compiler(self.compiler.stage, builder.config.build),
588 target: builder.config.build,
591 let mut cargo = builder.cargo(compiler, Mode::Rustc, SourceType::InTree, target, "build");
592 rustc_cargo(builder, &mut cargo, target);
594 if builder.config.rust_profile_use.is_some()
595 && builder.config.rust_profile_generate.is_some()
597 panic!("Cannot use and generate PGO profiles at the same time");
600 let is_collecting = if let Some(path) = &builder.config.rust_profile_generate {
601 if compiler.stage == 1 {
602 cargo.rustflag(&format!("-Cprofile-generate={}", path));
603 // Apparently necessary to avoid overflowing the counters during
604 // a Cargo build profile
605 cargo.rustflag("-Cllvm-args=-vp-counters-per-site=4");
610 } else if let Some(path) = &builder.config.rust_profile_use {
611 if compiler.stage == 1 {
612 cargo.rustflag(&format!("-Cprofile-use={}", path));
613 cargo.rustflag("-Cllvm-args=-pgo-warn-missing-function");
622 // Ensure paths to Rust sources are relative, not absolute.
623 cargo.rustflag(&format!(
624 "-Cllvm-args=-static-func-strip-dirname-prefix={}",
625 builder.config.src.components().count()
629 builder.info(&format!(
630 "Building stage{} compiler artifacts ({} -> {})",
631 compiler.stage, &compiler.host, target
637 &librustc_stamp(builder, compiler, target),
642 builder.ensure(RustcLink {
643 compiler: builder.compiler(compiler.stage, builder.config.build),
644 target_compiler: compiler,
650 pub fn rustc_cargo(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
653 .arg(builder.rustc_features(builder.kind))
654 .arg("--manifest-path")
655 .arg(builder.src.join("compiler/rustc/Cargo.toml"));
656 rustc_cargo_env(builder, cargo, target);
659 pub fn rustc_cargo_env(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
660 // Set some configuration variables picked up by build scripts and
661 // the compiler alike
663 .env("CFG_RELEASE", builder.rust_release())
664 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
665 .env("CFG_VERSION", builder.rust_version());
667 if let Some(backend) = builder.config.rust_codegen_backends.get(0) {
668 cargo.env("CFG_DEFAULT_CODEGEN_BACKEND", backend);
671 let libdir_relative = builder.config.libdir_relative().unwrap_or_else(|| Path::new("lib"));
672 let target_config = builder.config.target_config.get(&target);
674 cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
676 if let Some(ref ver_date) = builder.rust_info.commit_date() {
677 cargo.env("CFG_VER_DATE", ver_date);
679 if let Some(ref ver_hash) = builder.rust_info.sha() {
680 cargo.env("CFG_VER_HASH", ver_hash);
682 if !builder.unstable_features() {
683 cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
686 // Prefer the current target's own default_linker, else a globally
688 if let Some(s) = target_config.and_then(|c| c.default_linker.as_ref()) {
689 cargo.env("CFG_DEFAULT_LINKER", s);
690 } else if let Some(ref s) = builder.config.rustc_default_linker {
691 cargo.env("CFG_DEFAULT_LINKER", s);
694 if builder.config.rustc_parallel {
695 // keep in sync with `bootstrap/lib.rs:Build::rustc_features`
696 // `cfg` option for rustc, `features` option for cargo, for conditional compilation
697 cargo.rustflag("--cfg=parallel_compiler");
698 cargo.rustdocflag("--cfg=parallel_compiler");
700 if builder.config.rust_verify_llvm_ir {
701 cargo.env("RUSTC_VERIFY_LLVM_IR", "1");
704 // Pass down configuration from the LLVM build into the build of
705 // rustc_llvm and rustc_codegen_llvm.
707 // Note that this is disabled if LLVM itself is disabled or we're in a check
708 // build. If we are in a check build we still go ahead here presuming we've
709 // detected that LLVM is already built and good to go which helps prevent
710 // busting caches (e.g. like #71152).
711 if builder.config.llvm_enabled()
712 && (builder.kind != Kind::Check
713 || crate::native::prebuilt_llvm_config(builder, target).is_ok())
715 if builder.is_rust_llvm(target) {
716 cargo.env("LLVM_RUSTLLVM", "1");
718 let llvm_config = builder.ensure(native::Llvm { target });
719 cargo.env("LLVM_CONFIG", &llvm_config);
720 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
721 cargo.env("CFG_LLVM_ROOT", s);
723 // Some LLVM linker flags (-L and -l) may be needed to link rustc_llvm.
724 if let Some(ref s) = builder.config.llvm_ldflags {
725 cargo.env("LLVM_LINKER_FLAGS", s);
727 // Building with a static libstdc++ is only supported on linux right now,
728 // not for MSVC or macOS
729 if builder.config.llvm_static_stdcpp
730 && !target.contains("freebsd")
731 && !target.contains("msvc")
732 && !target.contains("apple")
734 let file = compiler_file(
736 builder.cxx(target).unwrap(),
741 cargo.env("LLVM_STATIC_STDCPP", file);
743 if builder.llvm_link_shared() {
744 cargo.env("LLVM_LINK_SHARED", "1");
746 if builder.config.llvm_use_libcxx {
747 cargo.env("LLVM_USE_LIBCXX", "1");
749 if builder.config.llvm_optimize && !builder.config.llvm_release_debuginfo {
750 cargo.env("LLVM_NDEBUG", "1");
755 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
757 pub compiler: Compiler,
758 pub target_compiler: Compiler,
759 pub target: TargetSelection,
762 impl Step for RustcLink {
765 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
769 /// Same as `std_link`, only for librustc
770 fn run(self, builder: &Builder<'_>) {
771 let compiler = self.compiler;
772 let target_compiler = self.target_compiler;
773 let target = self.target;
774 builder.info(&format!(
775 "Copying stage{} rustc from stage{} ({} -> {} / {})",
776 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
780 &builder.sysroot_libdir(target_compiler, target),
781 &builder.sysroot_libdir(target_compiler, compiler.host),
782 &librustc_stamp(builder, compiler, target),
787 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
788 pub struct CodegenBackend {
789 pub target: TargetSelection,
790 pub compiler: Compiler,
791 pub backend: Interned<String>,
794 impl Step for CodegenBackend {
796 const ONLY_HOSTS: bool = true;
797 // Only the backends specified in the `codegen-backends` entry of `config.toml` are built.
798 const DEFAULT: bool = true;
800 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
801 run.paths(&["compiler/rustc_codegen_cranelift", "compiler/rustc_codegen_gcc"])
804 fn make_run(run: RunConfig<'_>) {
805 for &backend in &run.builder.config.rust_codegen_backends {
806 if backend == "llvm" {
807 continue; // Already built as part of rustc
810 run.builder.ensure(CodegenBackend {
812 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
818 fn run(self, builder: &Builder<'_>) {
819 let compiler = self.compiler;
820 let target = self.target;
821 let backend = self.backend;
823 builder.ensure(Rustc { compiler, target });
825 if builder.config.keep_stage.contains(&compiler.stage) {
827 "Warning: Using a potentially old codegen backend. \
828 This may not behave well.",
830 // Codegen backends are linked separately from this step today, so we don't do
835 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
836 if compiler_to_use != compiler {
837 builder.ensure(CodegenBackend { compiler: compiler_to_use, target, backend });
841 let out_dir = builder.cargo_out(compiler, Mode::Codegen, target);
843 let mut cargo = builder.cargo(compiler, Mode::Codegen, SourceType::InTree, target, "build");
845 .arg("--manifest-path")
846 .arg(builder.src.join(format!("compiler/rustc_codegen_{}/Cargo.toml", backend)));
847 rustc_cargo_env(builder, &mut cargo, target);
849 let tmp_stamp = out_dir.join(".tmp.stamp");
851 builder.info(&format!(
852 "Building stage{} codegen backend {} ({} -> {})",
853 compiler.stage, backend, &compiler.host, target
855 let files = run_cargo(builder, cargo, vec![], &tmp_stamp, vec![], false);
856 if builder.config.dry_run {
859 let mut files = files.into_iter().filter(|f| {
860 let filename = f.file_name().unwrap().to_str().unwrap();
861 is_dylib(filename) && filename.contains("rustc_codegen_")
863 let codegen_backend = match files.next() {
865 None => panic!("no dylibs built for codegen backend?"),
867 if let Some(f) = files.next() {
869 "codegen backend built two dylibs:\n{}\n{}",
870 codegen_backend.display(),
874 let stamp = codegen_backend_stamp(builder, compiler, target, backend);
875 let codegen_backend = codegen_backend.to_str().unwrap();
876 t!(fs::write(&stamp, &codegen_backend));
880 /// Creates the `codegen-backends` folder for a compiler that's about to be
881 /// assembled as a complete compiler.
883 /// This will take the codegen artifacts produced by `compiler` and link them
884 /// into an appropriate location for `target_compiler` to be a functional
886 fn copy_codegen_backends_to_sysroot(
887 builder: &Builder<'_>,
889 target_compiler: Compiler,
891 let target = target_compiler.host;
893 // Note that this step is different than all the other `*Link` steps in
894 // that it's not assembling a bunch of libraries but rather is primarily
895 // moving the codegen backend into place. The codegen backend of rustc is
896 // not linked into the main compiler by default but is rather dynamically
897 // selected at runtime for inclusion.
899 // Here we're looking for the output dylib of the `CodegenBackend` step and
900 // we're copying that into the `codegen-backends` folder.
901 let dst = builder.sysroot_codegen_backends(target_compiler);
902 t!(fs::create_dir_all(&dst), dst);
904 if builder.config.dry_run {
908 for backend in builder.config.rust_codegen_backends.iter() {
909 if backend == "llvm" {
910 continue; // Already built as part of rustc
913 let stamp = codegen_backend_stamp(builder, compiler, target, *backend);
914 let dylib = t!(fs::read_to_string(&stamp));
915 let file = Path::new(&dylib);
916 let filename = file.file_name().unwrap().to_str().unwrap();
917 // change `librustc_codegen_cranelift-xxxxxx.so` to
918 // `librustc_codegen_cranelift-release.so`
919 let target_filename = {
920 let dash = filename.find('-').unwrap();
921 let dot = filename.find('.').unwrap();
922 format!("{}-{}{}", &filename[..dash], builder.rust_release(), &filename[dot..])
924 builder.copy(&file, &dst.join(target_filename));
928 /// Cargo's output path for the standard library in a given stage, compiled
929 /// by a particular compiler for the specified target.
930 pub fn libstd_stamp(builder: &Builder<'_>, compiler: Compiler, target: TargetSelection) -> PathBuf {
931 builder.cargo_out(compiler, Mode::Std, target).join(".libstd.stamp")
934 /// Cargo's output path for librustc in a given stage, compiled by a particular
935 /// compiler for the specified target.
936 pub fn librustc_stamp(
937 builder: &Builder<'_>,
939 target: TargetSelection,
941 builder.cargo_out(compiler, Mode::Rustc, target).join(".librustc.stamp")
944 /// Cargo's output path for librustc_codegen_llvm in a given stage, compiled by a particular
945 /// compiler for the specified target and backend.
946 fn codegen_backend_stamp(
947 builder: &Builder<'_>,
949 target: TargetSelection,
950 backend: Interned<String>,
953 .cargo_out(compiler, Mode::Codegen, target)
954 .join(format!(".librustc_codegen_{}.stamp", backend))
957 pub fn compiler_file(
958 builder: &Builder<'_>,
960 target: TargetSelection,
964 let mut cmd = Command::new(compiler);
965 cmd.args(builder.cflags(target, GitRepo::Rustc, c));
966 cmd.arg(format!("-print-file-name={}", file));
967 let out = output(&mut cmd);
968 PathBuf::from(out.trim())
971 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
973 pub compiler: Compiler,
976 impl Step for Sysroot {
977 type Output = Interned<PathBuf>;
979 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
983 /// Returns the sysroot for the `compiler` specified that *this build system
986 /// That is, the sysroot for the stage0 compiler is not what the compiler
987 /// thinks it is by default, but it's the same as the default for stages
989 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
990 let compiler = self.compiler;
991 let sysroot = if compiler.stage == 0 {
992 builder.out.join(&compiler.host.triple).join("stage0-sysroot")
994 builder.out.join(&compiler.host.triple).join(format!("stage{}", compiler.stage))
996 let _ = fs::remove_dir_all(&sysroot);
997 t!(fs::create_dir_all(&sysroot));
999 // If we're downloading a compiler from CI, we can use the same compiler for all stages other than 0.
1000 if builder.download_rustc() && compiler.stage != 0 {
1002 builder.config.build, compiler.host,
1003 "Cross-compiling is not yet supported with `download-rustc`",
1005 // Copy the compiler into the correct sysroot.
1007 builder.config.out.join(&*builder.config.build.triple).join("ci-rustc");
1008 builder.cp_r(&ci_rustc_dir, &sysroot);
1009 return INTERNER.intern_path(sysroot);
1012 // Symlink the source root into the same location inside the sysroot,
1013 // where `rust-src` component would go (`$sysroot/lib/rustlib/src/rust`),
1014 // so that any tools relying on `rust-src` also work for local builds,
1015 // and also for translating the virtual `/rustc/$hash` back to the real
1016 // directory (for running tests with `rust.remap-debuginfo = true`).
1017 let sysroot_lib_rustlib_src = sysroot.join("lib/rustlib/src");
1018 t!(fs::create_dir_all(&sysroot_lib_rustlib_src));
1019 let sysroot_lib_rustlib_src_rust = sysroot_lib_rustlib_src.join("rust");
1020 if let Err(e) = symlink_dir(&builder.config, &builder.src, &sysroot_lib_rustlib_src_rust) {
1022 "warning: creating symbolic link `{}` to `{}` failed with {}",
1023 sysroot_lib_rustlib_src_rust.display(),
1024 builder.src.display(),
1027 if builder.config.rust_remap_debuginfo {
1029 "warning: some `src/test/ui` tests will fail when lacking `{}`",
1030 sysroot_lib_rustlib_src_rust.display(),
1035 INTERNER.intern_path(sysroot)
1039 #[derive(Debug, Copy, PartialOrd, Ord, Clone, PartialEq, Eq, Hash)]
1040 pub struct Assemble {
1041 /// The compiler which we will produce in this step. Assemble itself will
1042 /// take care of ensuring that the necessary prerequisites to do so exist,
1043 /// that is, this target can be a stage2 compiler and Assemble will build
1044 /// previous stages for you.
1045 pub target_compiler: Compiler,
1048 impl Step for Assemble {
1049 type Output = Compiler;
1050 const ONLY_HOSTS: bool = true;
1052 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1053 run.path("compiler/rustc").path("compiler")
1056 fn make_run(run: RunConfig<'_>) {
1057 run.builder.ensure(Assemble {
1058 target_compiler: run.builder.compiler(run.builder.top_stage + 1, run.target),
1062 /// Prepare a new compiler from the artifacts in `stage`
1064 /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
1065 /// must have been previously produced by the `stage - 1` builder.build
1067 fn run(self, builder: &Builder<'_>) -> Compiler {
1068 let target_compiler = self.target_compiler;
1070 if target_compiler.stage == 0 {
1072 builder.config.build, target_compiler.host,
1073 "Cannot obtain compiler for non-native build triple at stage 0"
1075 // The stage 0 compiler for the build triple is always pre-built.
1076 return target_compiler;
1079 // Get the compiler that we'll use to bootstrap ourselves.
1081 // Note that this is where the recursive nature of the bootstrap
1082 // happens, as this will request the previous stage's compiler on
1083 // downwards to stage 0.
1085 // Also note that we're building a compiler for the host platform. We
1086 // only assume that we can run `build` artifacts, which means that to
1087 // produce some other architecture compiler we need to start from
1088 // `build` to get there.
1090 // FIXME: It may be faster if we build just a stage 1 compiler and then
1091 // use that to bootstrap this compiler forward.
1092 let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
1094 // If we're downloading a compiler from CI, we can use the same compiler for all stages other than 0.
1095 if builder.download_rustc() {
1096 builder.ensure(Sysroot { compiler: target_compiler });
1097 return target_compiler;
1100 // Build the libraries for this compiler to link to (i.e., the libraries
1101 // it uses at runtime). NOTE: Crates the target compiler compiles don't
1102 // link to these. (FIXME: Is that correct? It seems to be correct most
1103 // of the time but I think we do link to these for stage2/bin compilers
1104 // when not performing a full bootstrap).
1105 builder.ensure(Rustc { compiler: build_compiler, target: target_compiler.host });
1107 for &backend in builder.config.rust_codegen_backends.iter() {
1108 if backend == "llvm" {
1109 continue; // Already built as part of rustc
1112 builder.ensure(CodegenBackend {
1113 compiler: build_compiler,
1114 target: target_compiler.host,
1119 let lld_install = if builder.config.lld_enabled {
1120 Some(builder.ensure(native::Lld { target: target_compiler.host }))
1125 let stage = target_compiler.stage;
1126 let host = target_compiler.host;
1127 builder.info(&format!("Assembling stage{} compiler ({})", stage, host));
1129 // Link in all dylibs to the libdir
1130 let stamp = librustc_stamp(builder, build_compiler, target_compiler.host);
1131 let proc_macros = builder
1132 .read_stamp_file(&stamp)
1134 .filter_map(|(path, dependency_type)| {
1135 if dependency_type == DependencyType::Host {
1136 Some(path.file_name().unwrap().to_owned().into_string().unwrap())
1141 .collect::<HashSet<_>>();
1143 let sysroot = builder.sysroot(target_compiler);
1144 let rustc_libdir = builder.rustc_libdir(target_compiler);
1145 t!(fs::create_dir_all(&rustc_libdir));
1146 let src_libdir = builder.sysroot_libdir(build_compiler, host);
1147 for f in builder.read_dir(&src_libdir) {
1148 let filename = f.file_name().into_string().unwrap();
1149 if (is_dylib(&filename) || is_debug_info(&filename)) && !proc_macros.contains(&filename)
1151 builder.copy(&f.path(), &rustc_libdir.join(&filename));
1155 copy_codegen_backends_to_sysroot(builder, build_compiler, target_compiler);
1157 // We prepend this bin directory to the user PATH when linking Rust binaries. To
1158 // avoid shadowing the system LLD we rename the LLD we provide to `rust-lld`.
1159 let libdir = builder.sysroot_libdir(target_compiler, target_compiler.host);
1160 let libdir_bin = libdir.parent().unwrap().join("bin");
1161 t!(fs::create_dir_all(&libdir_bin));
1162 if let Some(lld_install) = lld_install {
1163 let src_exe = exe("lld", target_compiler.host);
1164 let dst_exe = exe("rust-lld", target_compiler.host);
1165 builder.copy(&lld_install.join("bin").join(&src_exe), &libdir_bin.join(&dst_exe));
1166 // for `-Z gcc-ld=lld`
1167 let gcc_ld_dir = libdir_bin.join("gcc-ld");
1168 t!(fs::create_dir(&gcc_ld_dir));
1169 let lld_wrapper_exe = builder.ensure(crate::tool::LldWrapper {
1170 compiler: build_compiler,
1171 target: target_compiler.host,
1173 builder.copy(&lld_wrapper_exe, &gcc_ld_dir.join(exe("ld", target_compiler.host)));
1176 if builder.config.rust_codegen_backends.contains(&INTERNER.intern_str("llvm")) {
1177 let llvm_config_bin = builder.ensure(native::Llvm { target: target_compiler.host });
1178 if !builder.config.dry_run {
1179 let llvm_bin_dir = output(Command::new(llvm_config_bin).arg("--bindir"));
1180 let llvm_bin_dir = Path::new(llvm_bin_dir.trim());
1182 // Since we've already built the LLVM tools, install them to the sysroot.
1183 // This is the equivalent of installing the `llvm-tools-preview` component via
1184 // rustup, and lets developers use a locally built toolchain to
1185 // build projects that expect llvm tools to be present in the sysroot
1186 // (e.g. the `bootimage` crate).
1187 for tool in LLVM_TOOLS {
1188 let tool_exe = exe(tool, target_compiler.host);
1189 let src_path = llvm_bin_dir.join(&tool_exe);
1190 // When using `download-ci-llvm`, some of the tools
1191 // may not exist, so skip trying to copy them.
1192 if src_path.exists() {
1193 builder.copy(&src_path, &libdir_bin.join(&tool_exe));
1199 // Ensure that `libLLVM.so` ends up in the newly build compiler directory,
1200 // so that it can be found when the newly built `rustc` is run.
1201 dist::maybe_install_llvm_runtime(builder, target_compiler.host, &sysroot);
1202 dist::maybe_install_llvm_target(builder, target_compiler.host, &sysroot);
1204 // Link the compiler binary itself into place
1205 let out_dir = builder.cargo_out(build_compiler, Mode::Rustc, host);
1206 let rustc = out_dir.join(exe("rustc-main", host));
1207 let bindir = sysroot.join("bin");
1208 t!(fs::create_dir_all(&bindir));
1209 let compiler = builder.rustc(target_compiler);
1210 builder.copy(&rustc, &compiler);
1216 /// Link some files into a rustc sysroot.
1218 /// For a particular stage this will link the file listed in `stamp` into the
1219 /// `sysroot_dst` provided.
1220 pub fn add_to_sysroot(
1221 builder: &Builder<'_>,
1223 sysroot_host_dst: &Path,
1226 let self_contained_dst = &sysroot_dst.join("self-contained");
1227 t!(fs::create_dir_all(&sysroot_dst));
1228 t!(fs::create_dir_all(&sysroot_host_dst));
1229 t!(fs::create_dir_all(&self_contained_dst));
1230 for (path, dependency_type) in builder.read_stamp_file(stamp) {
1231 let dst = match dependency_type {
1232 DependencyType::Host => sysroot_host_dst,
1233 DependencyType::Target => sysroot_dst,
1234 DependencyType::TargetSelfContained => self_contained_dst,
1236 builder.copy(&path, &dst.join(path.file_name().unwrap()));
1241 builder: &Builder<'_>,
1243 tail_args: Vec<String>,
1245 additional_target_deps: Vec<(PathBuf, DependencyType)>,
1248 if builder.config.dry_run {
1252 // `target_root_dir` looks like $dir/$target/release
1253 let target_root_dir = stamp.parent().unwrap();
1254 // `target_deps_dir` looks like $dir/$target/release/deps
1255 let target_deps_dir = target_root_dir.join("deps");
1256 // `host_root_dir` looks like $dir/release
1257 let host_root_dir = target_root_dir
1259 .unwrap() // chop off `release`
1261 .unwrap() // chop off `$target`
1262 .join(target_root_dir.file_name().unwrap());
1264 // Spawn Cargo slurping up its JSON output. We'll start building up the
1265 // `deps` array of all files it generated along with a `toplevel` array of
1266 // files we need to probe for later.
1267 let mut deps = Vec::new();
1268 let mut toplevel = Vec::new();
1269 let ok = stream_cargo(builder, cargo, tail_args, &mut |msg| {
1270 let (filenames, crate_types) = match msg {
1271 CargoMessage::CompilerArtifact {
1273 target: CargoTarget { crate_types },
1275 } => (filenames, crate_types),
1278 for filename in filenames {
1279 // Skip files like executables
1280 if !(filename.ends_with(".rlib")
1281 || filename.ends_with(".lib")
1282 || filename.ends_with(".a")
1283 || is_debug_info(&filename)
1284 || is_dylib(&filename)
1285 || (is_check && filename.ends_with(".rmeta")))
1290 let filename = Path::new(&*filename);
1292 // If this was an output file in the "host dir" we don't actually
1293 // worry about it, it's not relevant for us
1294 if filename.starts_with(&host_root_dir) {
1295 // Unless it's a proc macro used in the compiler
1296 if crate_types.iter().any(|t| t == "proc-macro") {
1297 deps.push((filename.to_path_buf(), DependencyType::Host));
1302 // If this was output in the `deps` dir then this is a precise file
1303 // name (hash included) so we start tracking it.
1304 if filename.starts_with(&target_deps_dir) {
1305 deps.push((filename.to_path_buf(), DependencyType::Target));
1309 // Otherwise this was a "top level artifact" which right now doesn't
1310 // have a hash in the name, but there's a version of this file in
1311 // the `deps` folder which *does* have a hash in the name. That's
1312 // the one we'll want to we'll probe for it later.
1314 // We do not use `Path::file_stem` or `Path::extension` here,
1315 // because some generated files may have multiple extensions e.g.
1316 // `std-<hash>.dll.lib` on Windows. The aforementioned methods only
1317 // split the file name by the last extension (`.lib`) while we need
1318 // to split by all extensions (`.dll.lib`).
1319 let expected_len = t!(filename.metadata()).len();
1320 let filename = filename.file_name().unwrap().to_str().unwrap();
1321 let mut parts = filename.splitn(2, '.');
1322 let file_stem = parts.next().unwrap().to_owned();
1323 let extension = parts.next().unwrap().to_owned();
1325 toplevel.push((file_stem, extension, expected_len));
1333 // Ok now we need to actually find all the files listed in `toplevel`. We've
1334 // got a list of prefix/extensions and we basically just need to find the
1335 // most recent file in the `deps` folder corresponding to each one.
1336 let contents = t!(target_deps_dir.read_dir())
1338 .map(|e| (e.path(), e.file_name().into_string().unwrap(), t!(e.metadata())))
1339 .collect::<Vec<_>>();
1340 for (prefix, extension, expected_len) in toplevel {
1341 let candidates = contents.iter().filter(|&&(_, ref filename, ref meta)| {
1342 meta.len() == expected_len
1344 .strip_prefix(&prefix[..])
1345 .map(|s| s.starts_with('-') && s.ends_with(&extension[..]))
1348 let max = candidates.max_by_key(|&&(_, _, ref metadata)| {
1349 metadata.modified().expect("mtime should be available on all relevant OSes")
1351 let path_to_add = match max {
1352 Some(triple) => triple.0.to_str().unwrap(),
1353 None => panic!("no output generated for {:?} {:?}", prefix, extension),
1355 if is_dylib(path_to_add) {
1356 let candidate = format!("{}.lib", path_to_add);
1357 let candidate = PathBuf::from(candidate);
1358 if candidate.exists() {
1359 deps.push((candidate, DependencyType::Target));
1362 deps.push((path_to_add.into(), DependencyType::Target));
1365 deps.extend(additional_target_deps);
1367 let mut new_contents = Vec::new();
1368 for (dep, dependency_type) in deps.iter() {
1369 new_contents.extend(match *dependency_type {
1370 DependencyType::Host => b"h",
1371 DependencyType::Target => b"t",
1372 DependencyType::TargetSelfContained => b"s",
1374 new_contents.extend(dep.to_str().unwrap().as_bytes());
1375 new_contents.extend(b"\0");
1377 t!(fs::write(&stamp, &new_contents));
1378 deps.into_iter().map(|(d, _)| d).collect()
1381 pub fn stream_cargo(
1382 builder: &Builder<'_>,
1384 tail_args: Vec<String>,
1385 cb: &mut dyn FnMut(CargoMessage<'_>),
1387 let mut cargo = Command::from(cargo);
1388 if builder.config.dry_run {
1391 // Instruct Cargo to give us json messages on stdout, critically leaving
1392 // stderr as piped so we can get those pretty colors.
1393 let mut message_format = if builder.config.json_output {
1394 String::from("json")
1396 String::from("json-render-diagnostics")
1398 if let Some(s) = &builder.config.rustc_error_format {
1399 message_format.push_str(",json-diagnostic-");
1400 message_format.push_str(s);
1402 cargo.arg("--message-format").arg(message_format).stdout(Stdio::piped());
1404 for arg in tail_args {
1408 builder.verbose(&format!("running: {:?}", cargo));
1409 let mut child = match cargo.spawn() {
1411 Err(e) => panic!("failed to execute command: {:?}\nerror: {}", cargo, e),
1414 // Spawn Cargo slurping up its JSON output. We'll start building up the
1415 // `deps` array of all files it generated along with a `toplevel` array of
1416 // files we need to probe for later.
1417 let stdout = BufReader::new(child.stdout.take().unwrap());
1418 for line in stdout.lines() {
1419 let line = t!(line);
1420 match serde_json::from_str::<CargoMessage<'_>>(&line) {
1422 if builder.config.json_output {
1423 // Forward JSON to stdout.
1424 println!("{}", line);
1428 // If this was informational, just print it out and continue
1429 Err(_) => println!("{}", line),
1433 // Make sure Cargo actually succeeded after we read all of its stdout.
1434 let status = t!(child.wait());
1435 if builder.is_verbose() && !status.success() {
1437 "command did not execute successfully: {:?}\n\
1438 expected success, got: {}",
1445 #[derive(Deserialize)]
1446 pub struct CargoTarget<'a> {
1447 crate_types: Vec<Cow<'a, str>>,
1450 #[derive(Deserialize)]
1451 #[serde(tag = "reason", rename_all = "kebab-case")]
1452 pub enum CargoMessage<'a> {
1454 package_id: Cow<'a, str>,
1455 features: Vec<Cow<'a, str>>,
1456 filenames: Vec<Cow<'a, str>>,
1457 target: CargoTarget<'a>,
1459 BuildScriptExecuted {
1460 package_id: Cow<'a, str>,