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 build_helper::{output, t, up_to_date};
20 use filetime::FileTime;
21 use serde::Deserialize;
23 use crate::builder::Cargo;
24 use crate::builder::{Builder, Kind, RunConfig, ShouldRun, Step};
25 use crate::cache::{Interned, INTERNER};
26 use crate::config::{LlvmLibunwind, TargetSelection};
29 use crate::tool::SourceType;
30 use crate::util::{exe, is_debug_info, is_dylib, symlink_dir};
31 use crate::{Compiler, DependencyType, GitRepo, Mode};
33 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
35 pub target: TargetSelection,
36 pub compiler: Compiler,
41 const DEFAULT: bool = true;
43 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
44 // When downloading stage1, the standard library has already been copied to the sysroot, so
45 // there's no need to rebuild it.
46 let download_rustc = run.builder.config.download_rustc;
47 run.all_krates("test").default_condition(!download_rustc)
50 fn make_run(run: RunConfig<'_>) {
51 run.builder.ensure(Std {
52 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
57 /// Builds the standard library.
59 /// This will build the standard library for a particular stage of the build
60 /// using the `compiler` targeting the `target` architecture. The artifacts
61 /// created will also be linked into the sysroot directory.
62 fn run(self, builder: &Builder<'_>) {
63 let target = self.target;
64 let compiler = self.compiler;
66 // These artifacts were already copied (in `impl Step for Sysroot`).
67 // Don't recompile them.
68 // NOTE: the ABI of the beta compiler is different from the ABI of the downloaded compiler,
69 // so its artifacts can't be reused.
70 if builder.config.download_rustc && compiler.stage != 0 {
74 if builder.config.keep_stage.contains(&compiler.stage)
75 || builder.config.keep_stage_std.contains(&compiler.stage)
77 builder.info("Warning: Using a potentially old libstd. This may not behave well.");
78 builder.ensure(StdLink { compiler, target_compiler: compiler, target });
82 builder.update_submodule(&Path::new("library").join("stdarch"));
84 let mut target_deps = builder.ensure(StartupObjects { compiler, target });
86 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
87 if compiler_to_use != compiler {
88 builder.ensure(Std { compiler: compiler_to_use, target });
89 builder.info(&format!("Uplifting stage1 std ({} -> {})", compiler_to_use.host, target));
91 // Even if we're not building std this stage, the new sysroot must
92 // still contain the third party objects needed by various targets.
93 copy_third_party_objects(builder, &compiler, target);
94 copy_self_contained_objects(builder, &compiler, target);
96 builder.ensure(StdLink {
97 compiler: compiler_to_use,
98 target_compiler: compiler,
104 target_deps.extend(copy_third_party_objects(builder, &compiler, target));
105 target_deps.extend(copy_self_contained_objects(builder, &compiler, target));
107 let mut cargo = builder.cargo(compiler, Mode::Std, SourceType::InTree, target, "build");
108 std_cargo(builder, target, compiler.stage, &mut cargo);
110 builder.info(&format!(
111 "Building stage{} std artifacts ({} -> {})",
112 compiler.stage, &compiler.host, target
118 &libstd_stamp(builder, compiler, target),
123 builder.ensure(StdLink {
124 compiler: builder.compiler(compiler.stage, builder.config.build),
125 target_compiler: compiler,
132 builder: &Builder<'_>,
136 target_deps: &mut Vec<(PathBuf, DependencyType)>,
137 dependency_type: DependencyType,
139 let target = libdir.join(name);
140 builder.copy(&sourcedir.join(name), &target);
142 target_deps.push((target, dependency_type));
145 fn copy_llvm_libunwind(builder: &Builder<'_>, target: TargetSelection, libdir: &Path) -> PathBuf {
146 let libunwind_path = builder.ensure(native::Libunwind { target });
147 let libunwind_source = libunwind_path.join("libunwind.a");
148 let libunwind_target = libdir.join("libunwind.a");
149 builder.copy(&libunwind_source, &libunwind_target);
153 /// Copies third party objects needed by various targets.
154 fn copy_third_party_objects(
155 builder: &Builder<'_>,
157 target: TargetSelection,
158 ) -> Vec<(PathBuf, DependencyType)> {
159 let mut target_deps = vec![];
161 // FIXME: remove this in 2021
162 if target == "x86_64-fortanix-unknown-sgx" {
163 if env::var_os("X86_FORTANIX_SGX_LIBS").is_some() {
164 builder.info("Warning: X86_FORTANIX_SGX_LIBS environment variable is ignored, libunwind is now compiled as part of rustbuild");
168 if builder.config.sanitizers_enabled(target) && compiler.stage != 0 {
169 // The sanitizers are only copied in stage1 or above,
170 // to avoid creating dependency on LLVM.
172 copy_sanitizers(builder, &compiler, target)
174 .map(|d| (d, DependencyType::Target)),
178 if target == "x86_64-fortanix-unknown-sgx"
179 || builder.config.llvm_libunwind == LlvmLibunwind::InTree
180 && (target.contains("linux") || target.contains("fuchsia"))
183 copy_llvm_libunwind(builder, target, &builder.sysroot_libdir(*compiler, target));
184 target_deps.push((libunwind_path, DependencyType::Target));
190 /// Copies third party objects needed by various targets for self-contained linkage.
191 fn copy_self_contained_objects(
192 builder: &Builder<'_>,
194 target: TargetSelection,
195 ) -> Vec<(PathBuf, DependencyType)> {
196 let libdir_self_contained = builder.sysroot_libdir(*compiler, target).join("self-contained");
197 t!(fs::create_dir_all(&libdir_self_contained));
198 let mut target_deps = vec![];
200 // Copies the CRT objects.
202 // rustc historically provides a more self-contained installation for musl targets
203 // not requiring the presence of a native musl toolchain. For example, it can fall back
204 // to using gcc from a glibc-targeting toolchain for linking.
205 // To do that we have to distribute musl startup objects as a part of Rust toolchain
206 // and link with them manually in the self-contained mode.
207 if target.contains("musl") {
208 let srcdir = builder.musl_libdir(target).unwrap_or_else(|| {
209 panic!("Target {:?} does not have a \"musl-libdir\" key", target.triple)
211 for &obj in &["crt1.o", "Scrt1.o", "rcrt1.o", "crti.o", "crtn.o"] {
214 &libdir_self_contained,
218 DependencyType::TargetSelfContained,
221 let crt_path = builder.ensure(native::CrtBeginEnd { target });
222 for &obj in &["crtbegin.o", "crtbeginS.o", "crtend.o", "crtendS.o"] {
223 let src = crt_path.join(obj);
224 let target = libdir_self_contained.join(obj);
225 builder.copy(&src, &target);
226 target_deps.push((target, DependencyType::TargetSelfContained));
229 let libunwind_path = copy_llvm_libunwind(builder, target, &libdir_self_contained);
230 target_deps.push((libunwind_path, DependencyType::TargetSelfContained));
231 } else if target.ends_with("-wasi") {
235 panic!("Target {:?} does not have a \"wasi-root\" key", target.triple)
237 .join("lib/wasm32-wasi");
238 for &obj in &["crt1-command.o", "crt1-reactor.o"] {
241 &libdir_self_contained,
245 DependencyType::TargetSelfContained,
248 } else if target.contains("windows-gnu") {
249 for obj in ["crt2.o", "dllcrt2.o"].iter() {
250 let src = compiler_file(builder, builder.cc(target), target, obj);
251 let target = libdir_self_contained.join(obj);
252 builder.copy(&src, &target);
253 target_deps.push((target, DependencyType::TargetSelfContained));
260 /// Configure cargo to compile the standard library, adding appropriate env vars
262 pub fn std_cargo(builder: &Builder<'_>, target: TargetSelection, stage: u32, cargo: &mut Cargo) {
263 if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
264 cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
267 // Determine if we're going to compile in optimized C intrinsics to
268 // the `compiler-builtins` crate. These intrinsics live in LLVM's
269 // `compiler-rt` repository, but our `src/llvm-project` submodule isn't
270 // always checked out, so we need to conditionally look for this. (e.g. if
271 // an external LLVM is used we skip the LLVM submodule checkout).
273 // Note that this shouldn't affect the correctness of `compiler-builtins`,
274 // but only its speed. Some intrinsics in C haven't been translated to Rust
275 // yet but that's pretty rare. Other intrinsics have optimized
276 // implementations in C which have only had slower versions ported to Rust,
277 // so we favor the C version where we can, but it's not critical.
279 // If `compiler-rt` is available ensure that the `c` feature of the
280 // `compiler-builtins` crate is enabled and it's configured to learn where
281 // `compiler-rt` is located.
282 let compiler_builtins_root = builder.src.join("src/llvm-project/compiler-rt");
283 let compiler_builtins_c_feature = if compiler_builtins_root.exists() {
284 // Note that `libprofiler_builtins/build.rs` also computes this so if
285 // you're changing something here please also change that.
286 cargo.env("RUST_COMPILER_RT_ROOT", &compiler_builtins_root);
287 " compiler-builtins-c"
292 if builder.no_std(target) == Some(true) {
293 let mut features = "compiler-builtins-mem".to_string();
294 if !target.starts_with("bpf") {
295 features.push_str(compiler_builtins_c_feature);
298 // for no-std targets we only compile a few no_std crates
300 .args(&["-p", "alloc"])
301 .arg("--manifest-path")
302 .arg(builder.src.join("library/alloc/Cargo.toml"))
306 let mut features = builder.std_features(target);
307 features.push_str(compiler_builtins_c_feature);
312 .arg("--manifest-path")
313 .arg(builder.src.join("library/test/Cargo.toml"));
315 // Help the libc crate compile by assisting it in finding various
316 // sysroot native libraries.
317 if target.contains("musl") {
318 if let Some(p) = builder.musl_libdir(target) {
319 let root = format!("native={}", p.to_str().unwrap());
320 cargo.rustflag("-L").rustflag(&root);
324 if target.ends_with("-wasi") {
325 if let Some(p) = builder.wasi_root(target) {
326 let root = format!("native={}/lib/wasm32-wasi", p.to_str().unwrap());
327 cargo.rustflag("-L").rustflag(&root);
332 // By default, rustc uses `-Cembed-bitcode=yes`, and Cargo overrides that
333 // with `-Cembed-bitcode=no` for non-LTO builds. However, libstd must be
334 // built with bitcode so that the produced rlibs can be used for both LTO
335 // builds (which use bitcode) and non-LTO builds (which use object code).
336 // So we override the override here!
338 // But we don't bother for the stage 0 compiler because it's never used
341 cargo.rustflag("-Cembed-bitcode=yes");
344 // By default, rustc does not include unwind tables unless they are required
345 // for a particular target. They are not required by RISC-V targets, but
346 // compiling the standard library with them means that users can get
347 // backtraces without having to recompile the standard library themselves.
349 // This choice was discussed in https://github.com/rust-lang/rust/pull/69890
350 if target.contains("riscv") {
351 cargo.rustflag("-Cforce-unwind-tables=yes");
355 format!("-Zcrate-attr=doc(html_root_url=\"{}/\")", builder.doc_rust_lang_org_channel(),);
356 cargo.rustflag(&html_root);
357 cargo.rustdocflag(&html_root);
360 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
362 pub compiler: Compiler,
363 pub target_compiler: Compiler,
364 pub target: TargetSelection,
367 impl Step for StdLink {
370 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
374 /// Link all libstd rlibs/dylibs into the sysroot location.
376 /// Links those artifacts generated by `compiler` to the `stage` compiler's
377 /// sysroot for the specified `host` and `target`.
379 /// Note that this assumes that `compiler` has already generated the libstd
380 /// libraries for `target`, and this method will find them in the relevant
381 /// output directory.
382 fn run(self, builder: &Builder<'_>) {
383 let compiler = self.compiler;
384 let target_compiler = self.target_compiler;
385 let target = self.target;
386 builder.info(&format!(
387 "Copying stage{} std from stage{} ({} -> {} / {})",
388 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
390 let libdir = builder.sysroot_libdir(target_compiler, target);
391 let hostdir = builder.sysroot_libdir(target_compiler, compiler.host);
392 add_to_sysroot(builder, &libdir, &hostdir, &libstd_stamp(builder, compiler, target));
396 /// Copies sanitizer runtime libraries into target libdir.
398 builder: &Builder<'_>,
400 target: TargetSelection,
402 let runtimes: Vec<native::SanitizerRuntime> = builder.ensure(native::Sanitizers { target });
404 if builder.config.dry_run {
408 let mut target_deps = Vec::new();
409 let libdir = builder.sysroot_libdir(*compiler, target);
411 for runtime in &runtimes {
412 let dst = libdir.join(&runtime.name);
413 builder.copy(&runtime.path, &dst);
415 if target == "x86_64-apple-darwin" || target == "aarch64-apple-darwin" {
416 // Update the library’s install name to reflect that it has has been renamed.
417 apple_darwin_update_library_name(&dst, &format!("@rpath/{}", &runtime.name));
418 // Upon renaming the install name, the code signature of the file will invalidate,
419 // so we will sign it again.
420 apple_darwin_sign_file(&dst);
423 target_deps.push(dst);
429 fn apple_darwin_update_library_name(library_path: &Path, new_name: &str) {
430 let status = Command::new("install_name_tool")
435 .expect("failed to execute `install_name_tool`");
436 assert!(status.success());
439 fn apple_darwin_sign_file(file_path: &Path) {
440 let status = Command::new("codesign")
441 .arg("-f") // Force to rewrite the existing signature
446 .expect("failed to execute `codesign`");
447 assert!(status.success());
450 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
451 pub struct StartupObjects {
452 pub compiler: Compiler,
453 pub target: TargetSelection,
456 impl Step for StartupObjects {
457 type Output = Vec<(PathBuf, DependencyType)>;
459 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
460 run.path("library/rtstartup")
463 fn make_run(run: RunConfig<'_>) {
464 run.builder.ensure(StartupObjects {
465 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
470 /// Builds and prepare startup objects like rsbegin.o and rsend.o
472 /// These are primarily used on Windows right now for linking executables/dlls.
473 /// They don't require any library support as they're just plain old object
474 /// files, so we just use the nightly snapshot compiler to always build them (as
475 /// no other compilers are guaranteed to be available).
476 fn run(self, builder: &Builder<'_>) -> Vec<(PathBuf, DependencyType)> {
477 let for_compiler = self.compiler;
478 let target = self.target;
479 if !target.contains("windows-gnu") {
483 let mut target_deps = vec![];
485 let src_dir = &builder.src.join("library").join("rtstartup");
486 let dst_dir = &builder.native_dir(target).join("rtstartup");
487 let sysroot_dir = &builder.sysroot_libdir(for_compiler, target);
488 t!(fs::create_dir_all(dst_dir));
490 for file in &["rsbegin", "rsend"] {
491 let src_file = &src_dir.join(file.to_string() + ".rs");
492 let dst_file = &dst_dir.join(file.to_string() + ".o");
493 if !up_to_date(src_file, dst_file) {
494 let mut cmd = Command::new(&builder.initial_rustc);
495 cmd.env("RUSTC_BOOTSTRAP", "1");
496 if !builder.local_rebuild {
497 // a local_rebuild compiler already has stage1 features
498 cmd.arg("--cfg").arg("bootstrap");
502 .arg(target.rustc_target_arg())
510 let target = sysroot_dir.join((*file).to_string() + ".o");
511 builder.copy(dst_file, &target);
512 target_deps.push((target, DependencyType::Target));
519 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
521 pub target: TargetSelection,
522 pub compiler: Compiler,
525 impl Step for Rustc {
527 const ONLY_HOSTS: bool = true;
528 const DEFAULT: bool = false;
530 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
531 run.path("compiler/rustc")
534 fn make_run(run: RunConfig<'_>) {
535 run.builder.ensure(Rustc {
536 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
541 /// Builds the compiler.
543 /// This will build the compiler for a particular stage of the build using
544 /// the `compiler` targeting the `target` architecture. The artifacts
545 /// created will also be linked into the sysroot directory.
546 fn run(self, builder: &Builder<'_>) {
547 let compiler = self.compiler;
548 let target = self.target;
550 // NOTE: the ABI of the beta compiler is different from the ABI of the downloaded compiler,
551 // so its artifacts can't be reused.
552 if builder.config.download_rustc && compiler.stage != 0 {
553 // Copy the existing artifacts instead of rebuilding them.
554 // NOTE: this path is only taken for tools linking to rustc-dev.
555 builder.ensure(Sysroot { compiler });
559 builder.ensure(Std { compiler, target });
561 if builder.config.keep_stage.contains(&compiler.stage) {
562 builder.info("Warning: Using a potentially old librustc. This may not behave well.");
563 builder.info("Warning: Use `--keep-stage-std` if you want to rebuild the compiler when it changes");
564 builder.ensure(RustcLink { compiler, target_compiler: compiler, target });
568 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
569 if compiler_to_use != compiler {
570 builder.ensure(Rustc { compiler: compiler_to_use, target });
572 .info(&format!("Uplifting stage1 rustc ({} -> {})", builder.config.build, target));
573 builder.ensure(RustcLink {
574 compiler: compiler_to_use,
575 target_compiler: compiler,
581 // Ensure that build scripts and proc macros have a std / libproc_macro to link against.
583 compiler: builder.compiler(self.compiler.stage, builder.config.build),
584 target: builder.config.build,
587 let mut cargo = builder.cargo(compiler, Mode::Rustc, SourceType::InTree, target, "build");
588 rustc_cargo(builder, &mut cargo, target);
590 if builder.config.rust_profile_use.is_some()
591 && builder.config.rust_profile_generate.is_some()
593 panic!("Cannot use and generate PGO profiles at the same time");
596 let is_collecting = if let Some(path) = &builder.config.rust_profile_generate {
597 if compiler.stage == 1 {
598 cargo.rustflag(&format!("-Cprofile-generate={}", path));
599 // Apparently necessary to avoid overflowing the counters during
600 // a Cargo build profile
601 cargo.rustflag("-Cllvm-args=-vp-counters-per-site=4");
606 } else if let Some(path) = &builder.config.rust_profile_use {
607 if compiler.stage == 1 {
608 cargo.rustflag(&format!("-Cprofile-use={}", path));
609 cargo.rustflag("-Cllvm-args=-pgo-warn-missing-function");
618 // Ensure paths to Rust sources are relative, not absolute.
619 cargo.rustflag(&format!(
620 "-Cllvm-args=-static-func-strip-dirname-prefix={}",
621 builder.config.src.components().count()
625 builder.info(&format!(
626 "Building stage{} compiler artifacts ({} -> {})",
627 compiler.stage, &compiler.host, target
633 &librustc_stamp(builder, compiler, target),
638 builder.ensure(RustcLink {
639 compiler: builder.compiler(compiler.stage, builder.config.build),
640 target_compiler: compiler,
646 pub fn rustc_cargo(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
649 .arg(builder.rustc_features())
650 .arg("--manifest-path")
651 .arg(builder.src.join("compiler/rustc/Cargo.toml"));
652 rustc_cargo_env(builder, cargo, target);
655 pub fn rustc_cargo_env(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
656 // Set some configuration variables picked up by build scripts and
657 // the compiler alike
659 .env("CFG_RELEASE", builder.rust_release())
660 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
661 .env("CFG_VERSION", builder.rust_version());
663 let libdir_relative = builder.config.libdir_relative().unwrap_or_else(|| Path::new("lib"));
664 cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
666 if let Some(ref ver_date) = builder.rust_info.commit_date() {
667 cargo.env("CFG_VER_DATE", ver_date);
669 if let Some(ref ver_hash) = builder.rust_info.sha() {
670 cargo.env("CFG_VER_HASH", ver_hash);
672 if !builder.unstable_features() {
673 cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
675 if let Some(ref s) = builder.config.rustc_default_linker {
676 cargo.env("CFG_DEFAULT_LINKER", s);
678 if builder.config.rustc_parallel {
679 cargo.rustflag("--cfg=parallel_compiler");
680 cargo.rustdocflag("--cfg=parallel_compiler");
682 if builder.config.rust_verify_llvm_ir {
683 cargo.env("RUSTC_VERIFY_LLVM_IR", "1");
686 // Pass down configuration from the LLVM build into the build of
687 // rustc_llvm and rustc_codegen_llvm.
689 // Note that this is disabled if LLVM itself is disabled or we're in a check
690 // build. If we are in a check build we still go ahead here presuming we've
691 // detected that LLVM is alreay built and good to go which helps prevent
692 // busting caches (e.g. like #71152).
693 if builder.config.llvm_enabled()
694 && (builder.kind != Kind::Check
695 || crate::native::prebuilt_llvm_config(builder, target).is_ok())
697 if builder.is_rust_llvm(target) {
698 cargo.env("LLVM_RUSTLLVM", "1");
700 let llvm_config = builder.ensure(native::Llvm { target });
701 cargo.env("LLVM_CONFIG", &llvm_config);
702 let target_config = builder.config.target_config.get(&target);
703 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
704 cargo.env("CFG_LLVM_ROOT", s);
706 // Some LLVM linker flags (-L and -l) may be needed to link rustc_llvm.
707 if let Some(ref s) = builder.config.llvm_ldflags {
708 cargo.env("LLVM_LINKER_FLAGS", s);
710 // Building with a static libstdc++ is only supported on linux right now,
711 // not for MSVC or macOS
712 if builder.config.llvm_static_stdcpp
713 && !target.contains("freebsd")
714 && !target.contains("msvc")
715 && !target.contains("apple")
717 let file = compiler_file(builder, builder.cxx(target).unwrap(), target, "libstdc++.a");
718 cargo.env("LLVM_STATIC_STDCPP", file);
720 if builder.config.llvm_link_shared {
721 cargo.env("LLVM_LINK_SHARED", "1");
723 if builder.config.llvm_use_libcxx {
724 cargo.env("LLVM_USE_LIBCXX", "1");
726 if builder.config.llvm_optimize && !builder.config.llvm_release_debuginfo {
727 cargo.env("LLVM_NDEBUG", "1");
732 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
734 pub compiler: Compiler,
735 pub target_compiler: Compiler,
736 pub target: TargetSelection,
739 impl Step for RustcLink {
742 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
746 /// Same as `std_link`, only for librustc
747 fn run(self, builder: &Builder<'_>) {
748 let compiler = self.compiler;
749 let target_compiler = self.target_compiler;
750 let target = self.target;
751 builder.info(&format!(
752 "Copying stage{} rustc from stage{} ({} -> {} / {})",
753 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
757 &builder.sysroot_libdir(target_compiler, target),
758 &builder.sysroot_libdir(target_compiler, compiler.host),
759 &librustc_stamp(builder, compiler, target),
764 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
765 pub struct CodegenBackend {
766 pub target: TargetSelection,
767 pub compiler: Compiler,
768 pub backend: Interned<String>,
771 impl Step for CodegenBackend {
773 const ONLY_HOSTS: bool = true;
774 // Only the backends specified in the `codegen-backends` entry of `config.toml` are built.
775 const DEFAULT: bool = true;
777 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
778 run.path("compiler/rustc_codegen_cranelift")
781 fn make_run(run: RunConfig<'_>) {
782 for &backend in &run.builder.config.rust_codegen_backends {
783 if backend == "llvm" {
784 continue; // Already built as part of rustc
787 run.builder.ensure(CodegenBackend {
789 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
795 fn run(self, builder: &Builder<'_>) {
796 let compiler = self.compiler;
797 let target = self.target;
798 let backend = self.backend;
800 builder.ensure(Rustc { compiler, target });
802 if builder.config.keep_stage.contains(&compiler.stage) {
804 "Warning: Using a potentially old codegen backend. \
805 This may not behave well.",
807 // Codegen backends are linked separately from this step today, so we don't do
812 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
813 if compiler_to_use != compiler {
814 builder.ensure(CodegenBackend { compiler: compiler_to_use, target, backend });
818 let out_dir = builder.cargo_out(compiler, Mode::Codegen, target);
820 let mut cargo = builder.cargo(compiler, Mode::Codegen, SourceType::InTree, target, "build");
822 .arg("--manifest-path")
823 .arg(builder.src.join(format!("compiler/rustc_codegen_{}/Cargo.toml", backend)));
824 rustc_cargo_env(builder, &mut cargo, target);
826 let tmp_stamp = out_dir.join(".tmp.stamp");
828 builder.info(&format!(
829 "Building stage{} codegen backend {} ({} -> {})",
830 compiler.stage, backend, &compiler.host, target
832 let files = run_cargo(builder, cargo, vec![], &tmp_stamp, vec![], false);
833 if builder.config.dry_run {
836 let mut files = files.into_iter().filter(|f| {
837 let filename = f.file_name().unwrap().to_str().unwrap();
838 is_dylib(filename) && filename.contains("rustc_codegen_")
840 let codegen_backend = match files.next() {
842 None => panic!("no dylibs built for codegen backend?"),
844 if let Some(f) = files.next() {
846 "codegen backend built two dylibs:\n{}\n{}",
847 codegen_backend.display(),
851 let stamp = codegen_backend_stamp(builder, compiler, target, backend);
852 let codegen_backend = codegen_backend.to_str().unwrap();
853 t!(fs::write(&stamp, &codegen_backend));
857 /// Creates the `codegen-backends` folder for a compiler that's about to be
858 /// assembled as a complete compiler.
860 /// This will take the codegen artifacts produced by `compiler` and link them
861 /// into an appropriate location for `target_compiler` to be a functional
863 fn copy_codegen_backends_to_sysroot(
864 builder: &Builder<'_>,
866 target_compiler: Compiler,
868 let target = target_compiler.host;
870 // Note that this step is different than all the other `*Link` steps in
871 // that it's not assembling a bunch of libraries but rather is primarily
872 // moving the codegen backend into place. The codegen backend of rustc is
873 // not linked into the main compiler by default but is rather dynamically
874 // selected at runtime for inclusion.
876 // Here we're looking for the output dylib of the `CodegenBackend` step and
877 // we're copying that into the `codegen-backends` folder.
878 let dst = builder.sysroot_codegen_backends(target_compiler);
879 t!(fs::create_dir_all(&dst), dst);
881 if builder.config.dry_run {
885 for backend in builder.config.rust_codegen_backends.iter() {
886 if backend == "llvm" {
887 continue; // Already built as part of rustc
890 let stamp = codegen_backend_stamp(builder, compiler, target, *backend);
891 let dylib = t!(fs::read_to_string(&stamp));
892 let file = Path::new(&dylib);
893 let filename = file.file_name().unwrap().to_str().unwrap();
894 // change `librustc_codegen_cranelift-xxxxxx.so` to
895 // `librustc_codegen_cranelift-release.so`
896 let target_filename = {
897 let dash = filename.find('-').unwrap();
898 let dot = filename.find('.').unwrap();
899 format!("{}-{}{}", &filename[..dash], builder.rust_release(), &filename[dot..])
901 builder.copy(&file, &dst.join(target_filename));
905 /// Cargo's output path for the standard library in a given stage, compiled
906 /// by a particular compiler for the specified target.
907 pub fn libstd_stamp(builder: &Builder<'_>, compiler: Compiler, target: TargetSelection) -> PathBuf {
908 builder.cargo_out(compiler, Mode::Std, target).join(".libstd.stamp")
911 /// Cargo's output path for librustc in a given stage, compiled by a particular
912 /// compiler for the specified target.
913 pub fn librustc_stamp(
914 builder: &Builder<'_>,
916 target: TargetSelection,
918 builder.cargo_out(compiler, Mode::Rustc, target).join(".librustc.stamp")
921 /// Cargo's output path for librustc_codegen_llvm in a given stage, compiled by a particular
922 /// compiler for the specified target and backend.
923 fn codegen_backend_stamp(
924 builder: &Builder<'_>,
926 target: TargetSelection,
927 backend: Interned<String>,
930 .cargo_out(compiler, Mode::Codegen, target)
931 .join(format!(".librustc_codegen_{}.stamp", backend))
934 pub fn compiler_file(
935 builder: &Builder<'_>,
937 target: TargetSelection,
940 let mut cmd = Command::new(compiler);
941 cmd.args(builder.cflags(target, GitRepo::Rustc));
942 cmd.arg(format!("-print-file-name={}", file));
943 let out = output(&mut cmd);
944 PathBuf::from(out.trim())
947 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
949 pub compiler: Compiler,
952 impl Step for Sysroot {
953 type Output = Interned<PathBuf>;
955 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
959 /// Returns the sysroot for the `compiler` specified that *this build system
962 /// That is, the sysroot for the stage0 compiler is not what the compiler
963 /// thinks it is by default, but it's the same as the default for stages
965 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
966 let compiler = self.compiler;
967 let sysroot = if compiler.stage == 0 {
968 builder.out.join(&compiler.host.triple).join("stage0-sysroot")
970 builder.out.join(&compiler.host.triple).join(format!("stage{}", compiler.stage))
972 let _ = fs::remove_dir_all(&sysroot);
973 t!(fs::create_dir_all(&sysroot));
975 // If we're downloading a compiler from CI, we can use the same compiler for all stages other than 0.
976 if builder.config.download_rustc && compiler.stage != 0 {
978 builder.config.build, compiler.host,
979 "Cross-compiling is not yet supported with `download-rustc`",
981 // Copy the compiler into the correct sysroot.
983 builder.config.out.join(&*builder.config.build.triple).join("ci-rustc");
984 builder.cp_r(&ci_rustc_dir, &sysroot);
985 return INTERNER.intern_path(sysroot);
988 // Symlink the source root into the same location inside the sysroot,
989 // where `rust-src` component would go (`$sysroot/lib/rustlib/src/rust`),
990 // so that any tools relying on `rust-src` also work for local builds,
991 // and also for translating the virtual `/rustc/$hash` back to the real
992 // directory (for running tests with `rust.remap-debuginfo = true`).
993 let sysroot_lib_rustlib_src = sysroot.join("lib/rustlib/src");
994 t!(fs::create_dir_all(&sysroot_lib_rustlib_src));
995 let sysroot_lib_rustlib_src_rust = sysroot_lib_rustlib_src.join("rust");
996 if let Err(e) = symlink_dir(&builder.config, &builder.src, &sysroot_lib_rustlib_src_rust) {
998 "warning: creating symbolic link `{}` to `{}` failed with {}",
999 sysroot_lib_rustlib_src_rust.display(),
1000 builder.src.display(),
1003 if builder.config.rust_remap_debuginfo {
1005 "warning: some `src/test/ui` tests will fail when lacking `{}`",
1006 sysroot_lib_rustlib_src_rust.display(),
1011 INTERNER.intern_path(sysroot)
1015 #[derive(Debug, Copy, PartialOrd, Ord, Clone, PartialEq, Eq, Hash)]
1016 pub struct Assemble {
1017 /// The compiler which we will produce in this step. Assemble itself will
1018 /// take care of ensuring that the necessary prerequisites to do so exist,
1019 /// that is, this target can be a stage2 compiler and Assemble will build
1020 /// previous stages for you.
1021 pub target_compiler: Compiler,
1024 impl Step for Assemble {
1025 type Output = Compiler;
1027 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1031 /// Prepare a new compiler from the artifacts in `stage`
1033 /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
1034 /// must have been previously produced by the `stage - 1` builder.build
1036 fn run(self, builder: &Builder<'_>) -> Compiler {
1037 let target_compiler = self.target_compiler;
1039 if target_compiler.stage == 0 {
1041 builder.config.build, target_compiler.host,
1042 "Cannot obtain compiler for non-native build triple at stage 0"
1044 // The stage 0 compiler for the build triple is always pre-built.
1045 return target_compiler;
1048 // Get the compiler that we'll use to bootstrap ourselves.
1050 // Note that this is where the recursive nature of the bootstrap
1051 // happens, as this will request the previous stage's compiler on
1052 // downwards to stage 0.
1054 // Also note that we're building a compiler for the host platform. We
1055 // only assume that we can run `build` artifacts, which means that to
1056 // produce some other architecture compiler we need to start from
1057 // `build` to get there.
1059 // FIXME: It may be faster if we build just a stage 1 compiler and then
1060 // use that to bootstrap this compiler forward.
1061 let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
1063 // If we're downloading a compiler from CI, we can use the same compiler for all stages other than 0.
1064 if builder.config.download_rustc {
1065 builder.ensure(Sysroot { compiler: target_compiler });
1066 return target_compiler;
1069 // Build the libraries for this compiler to link to (i.e., the libraries
1070 // it uses at runtime). NOTE: Crates the target compiler compiles don't
1071 // link to these. (FIXME: Is that correct? It seems to be correct most
1072 // of the time but I think we do link to these for stage2/bin compilers
1073 // when not performing a full bootstrap).
1074 builder.ensure(Rustc { compiler: build_compiler, target: target_compiler.host });
1076 for &backend in builder.config.rust_codegen_backends.iter() {
1077 if backend == "llvm" {
1078 continue; // Already built as part of rustc
1081 builder.ensure(CodegenBackend {
1082 compiler: build_compiler,
1083 target: target_compiler.host,
1088 let lld_install = if builder.config.lld_enabled {
1089 Some(builder.ensure(native::Lld { target: target_compiler.host }))
1094 let stage = target_compiler.stage;
1095 let host = target_compiler.host;
1096 builder.info(&format!("Assembling stage{} compiler ({})", stage, host));
1098 // Link in all dylibs to the libdir
1099 let stamp = librustc_stamp(builder, build_compiler, target_compiler.host);
1100 let proc_macros = builder
1101 .read_stamp_file(&stamp)
1103 .filter_map(|(path, dependency_type)| {
1104 if dependency_type == DependencyType::Host {
1105 Some(path.file_name().unwrap().to_owned().into_string().unwrap())
1110 .collect::<HashSet<_>>();
1112 let sysroot = builder.sysroot(target_compiler);
1113 let rustc_libdir = builder.rustc_libdir(target_compiler);
1114 t!(fs::create_dir_all(&rustc_libdir));
1115 let src_libdir = builder.sysroot_libdir(build_compiler, host);
1116 for f in builder.read_dir(&src_libdir) {
1117 let filename = f.file_name().into_string().unwrap();
1118 if (is_dylib(&filename) || is_debug_info(&filename)) && !proc_macros.contains(&filename)
1120 builder.copy(&f.path(), &rustc_libdir.join(&filename));
1124 copy_codegen_backends_to_sysroot(builder, build_compiler, target_compiler);
1126 // We prepend this bin directory to the user PATH when linking Rust binaries. To
1127 // avoid shadowing the system LLD we rename the LLD we provide to `rust-lld`.
1128 let libdir = builder.sysroot_libdir(target_compiler, target_compiler.host);
1129 let libdir_bin = libdir.parent().unwrap().join("bin");
1130 t!(fs::create_dir_all(&libdir_bin));
1132 if let Some(lld_install) = lld_install {
1133 let src_exe = exe("lld", target_compiler.host);
1134 let dst_exe = exe("rust-lld", target_compiler.host);
1135 builder.copy(&lld_install.join("bin").join(&src_exe), &libdir_bin.join(&dst_exe));
1136 // for `-Z gcc-ld=lld`
1137 let gcc_ld_dir = libdir_bin.join("gcc-ld");
1138 t!(fs::create_dir(&gcc_ld_dir));
1139 for flavor in ["ld", "ld64"] {
1140 let lld_wrapper_exe = builder.ensure(crate::tool::LldWrapper {
1141 compiler: build_compiler,
1142 target: target_compiler.host,
1143 flavor_feature: flavor,
1145 builder.copy(&lld_wrapper_exe, &gcc_ld_dir.join(exe(flavor, target_compiler.host)));
1149 // Similarly, copy `llvm-dwp` into libdir for Split DWARF. Only copy it when the LLVM
1150 // backend is used to avoid unnecessarily building LLVM and because LLVM is not checked
1151 // out by default when the LLVM backend is not enabled.
1152 if builder.config.rust_codegen_backends.contains(&INTERNER.intern_str("llvm")) {
1153 let src_exe = exe("llvm-dwp", target_compiler.host);
1154 let dst_exe = exe("rust-llvm-dwp", target_compiler.host);
1155 let llvm_config_bin = builder.ensure(native::Llvm { target: target_compiler.host });
1156 if !builder.config.dry_run {
1157 let llvm_bin_dir = output(Command::new(llvm_config_bin).arg("--bindir"));
1158 let llvm_bin_dir = Path::new(llvm_bin_dir.trim());
1159 builder.copy(&llvm_bin_dir.join(&src_exe), &libdir_bin.join(&dst_exe));
1163 // Ensure that `libLLVM.so` ends up in the newly build compiler directory,
1164 // so that it can be found when the newly built `rustc` is run.
1165 dist::maybe_install_llvm_runtime(builder, target_compiler.host, &sysroot);
1166 dist::maybe_install_llvm_target(builder, target_compiler.host, &sysroot);
1168 // Link the compiler binary itself into place
1169 let out_dir = builder.cargo_out(build_compiler, Mode::Rustc, host);
1170 let rustc = out_dir.join(exe("rustc-main", host));
1171 let bindir = sysroot.join("bin");
1172 t!(fs::create_dir_all(&bindir));
1173 let compiler = builder.rustc(target_compiler);
1174 builder.copy(&rustc, &compiler);
1180 /// Link some files into a rustc sysroot.
1182 /// For a particular stage this will link the file listed in `stamp` into the
1183 /// `sysroot_dst` provided.
1184 pub fn add_to_sysroot(
1185 builder: &Builder<'_>,
1187 sysroot_host_dst: &Path,
1190 let self_contained_dst = &sysroot_dst.join("self-contained");
1191 t!(fs::create_dir_all(&sysroot_dst));
1192 t!(fs::create_dir_all(&sysroot_host_dst));
1193 t!(fs::create_dir_all(&self_contained_dst));
1194 for (path, dependency_type) in builder.read_stamp_file(stamp) {
1195 let dst = match dependency_type {
1196 DependencyType::Host => sysroot_host_dst,
1197 DependencyType::Target => sysroot_dst,
1198 DependencyType::TargetSelfContained => self_contained_dst,
1200 builder.copy(&path, &dst.join(path.file_name().unwrap()));
1205 builder: &Builder<'_>,
1207 tail_args: Vec<String>,
1209 additional_target_deps: Vec<(PathBuf, DependencyType)>,
1212 if builder.config.dry_run {
1216 // `target_root_dir` looks like $dir/$target/release
1217 let target_root_dir = stamp.parent().unwrap();
1218 // `target_deps_dir` looks like $dir/$target/release/deps
1219 let target_deps_dir = target_root_dir.join("deps");
1220 // `host_root_dir` looks like $dir/release
1221 let host_root_dir = target_root_dir
1223 .unwrap() // chop off `release`
1225 .unwrap() // chop off `$target`
1226 .join(target_root_dir.file_name().unwrap());
1228 // Spawn Cargo slurping up its JSON output. We'll start building up the
1229 // `deps` array of all files it generated along with a `toplevel` array of
1230 // files we need to probe for later.
1231 let mut deps = Vec::new();
1232 let mut toplevel = Vec::new();
1233 let ok = stream_cargo(builder, cargo, tail_args, &mut |msg| {
1234 let (filenames, crate_types) = match msg {
1235 CargoMessage::CompilerArtifact {
1237 target: CargoTarget { crate_types },
1239 } => (filenames, crate_types),
1242 for filename in filenames {
1243 // Skip files like executables
1244 if !(filename.ends_with(".rlib")
1245 || filename.ends_with(".lib")
1246 || filename.ends_with(".a")
1247 || is_debug_info(&filename)
1248 || is_dylib(&filename)
1249 || (is_check && filename.ends_with(".rmeta")))
1254 let filename = Path::new(&*filename);
1256 // If this was an output file in the "host dir" we don't actually
1257 // worry about it, it's not relevant for us
1258 if filename.starts_with(&host_root_dir) {
1259 // Unless it's a proc macro used in the compiler
1260 if crate_types.iter().any(|t| t == "proc-macro") {
1261 deps.push((filename.to_path_buf(), DependencyType::Host));
1266 // If this was output in the `deps` dir then this is a precise file
1267 // name (hash included) so we start tracking it.
1268 if filename.starts_with(&target_deps_dir) {
1269 deps.push((filename.to_path_buf(), DependencyType::Target));
1273 // Otherwise this was a "top level artifact" which right now doesn't
1274 // have a hash in the name, but there's a version of this file in
1275 // the `deps` folder which *does* have a hash in the name. That's
1276 // the one we'll want to we'll probe for it later.
1278 // We do not use `Path::file_stem` or `Path::extension` here,
1279 // because some generated files may have multiple extensions e.g.
1280 // `std-<hash>.dll.lib` on Windows. The aforementioned methods only
1281 // split the file name by the last extension (`.lib`) while we need
1282 // to split by all extensions (`.dll.lib`).
1283 let expected_len = t!(filename.metadata()).len();
1284 let filename = filename.file_name().unwrap().to_str().unwrap();
1285 let mut parts = filename.splitn(2, '.');
1286 let file_stem = parts.next().unwrap().to_owned();
1287 let extension = parts.next().unwrap().to_owned();
1289 toplevel.push((file_stem, extension, expected_len));
1297 // Ok now we need to actually find all the files listed in `toplevel`. We've
1298 // got a list of prefix/extensions and we basically just need to find the
1299 // most recent file in the `deps` folder corresponding to each one.
1300 let contents = t!(target_deps_dir.read_dir())
1302 .map(|e| (e.path(), e.file_name().into_string().unwrap(), t!(e.metadata())))
1303 .collect::<Vec<_>>();
1304 for (prefix, extension, expected_len) in toplevel {
1305 let candidates = contents.iter().filter(|&&(_, ref filename, ref meta)| {
1306 meta.len() == expected_len
1308 .strip_prefix(&prefix[..])
1309 .map(|s| s.starts_with('-') && s.ends_with(&extension[..]))
1312 let max = candidates
1313 .max_by_key(|&&(_, _, ref metadata)| FileTime::from_last_modification_time(metadata));
1314 let path_to_add = match max {
1315 Some(triple) => triple.0.to_str().unwrap(),
1316 None => panic!("no output generated for {:?} {:?}", prefix, extension),
1318 if is_dylib(path_to_add) {
1319 let candidate = format!("{}.lib", path_to_add);
1320 let candidate = PathBuf::from(candidate);
1321 if candidate.exists() {
1322 deps.push((candidate, DependencyType::Target));
1325 deps.push((path_to_add.into(), DependencyType::Target));
1328 deps.extend(additional_target_deps);
1330 let mut new_contents = Vec::new();
1331 for (dep, dependency_type) in deps.iter() {
1332 new_contents.extend(match *dependency_type {
1333 DependencyType::Host => b"h",
1334 DependencyType::Target => b"t",
1335 DependencyType::TargetSelfContained => b"s",
1337 new_contents.extend(dep.to_str().unwrap().as_bytes());
1338 new_contents.extend(b"\0");
1340 t!(fs::write(&stamp, &new_contents));
1341 deps.into_iter().map(|(d, _)| d).collect()
1344 pub fn stream_cargo(
1345 builder: &Builder<'_>,
1347 tail_args: Vec<String>,
1348 cb: &mut dyn FnMut(CargoMessage<'_>),
1350 let mut cargo = Command::from(cargo);
1351 if builder.config.dry_run {
1354 // Instruct Cargo to give us json messages on stdout, critically leaving
1355 // stderr as piped so we can get those pretty colors.
1356 let mut message_format = if builder.config.json_output {
1357 String::from("json")
1359 String::from("json-render-diagnostics")
1361 if let Some(s) = &builder.config.rustc_error_format {
1362 message_format.push_str(",json-diagnostic-");
1363 message_format.push_str(s);
1365 cargo.arg("--message-format").arg(message_format).stdout(Stdio::piped());
1367 for arg in tail_args {
1371 builder.verbose(&format!("running: {:?}", cargo));
1372 let mut child = match cargo.spawn() {
1374 Err(e) => panic!("failed to execute command: {:?}\nerror: {}", cargo, e),
1377 // Spawn Cargo slurping up its JSON output. We'll start building up the
1378 // `deps` array of all files it generated along with a `toplevel` array of
1379 // files we need to probe for later.
1380 let stdout = BufReader::new(child.stdout.take().unwrap());
1381 for line in stdout.lines() {
1382 let line = t!(line);
1383 match serde_json::from_str::<CargoMessage<'_>>(&line) {
1385 if builder.config.json_output {
1386 // Forward JSON to stdout.
1387 println!("{}", line);
1391 // If this was informational, just print it out and continue
1392 Err(_) => println!("{}", line),
1396 // Make sure Cargo actually succeeded after we read all of its stdout.
1397 let status = t!(child.wait());
1398 if builder.is_verbose() && !status.success() {
1400 "command did not execute successfully: {:?}\n\
1401 expected success, got: {}",
1408 #[derive(Deserialize)]
1409 pub struct CargoTarget<'a> {
1410 crate_types: Vec<Cow<'a, str>>,
1413 #[derive(Deserialize)]
1414 #[serde(tag = "reason", rename_all = "kebab-case")]
1415 pub enum CargoMessage<'a> {
1417 package_id: Cow<'a, str>,
1418 features: Vec<Cow<'a, str>>,
1419 filenames: Vec<Cow<'a, str>>,
1420 target: CargoTarget<'a>,
1422 BuildScriptExecuted {
1423 package_id: Cow<'a, str>,