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::LLVM_TOOLS;
32 use crate::{Compiler, DependencyType, GitRepo, Mode};
34 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
36 pub target: TargetSelection,
37 pub compiler: Compiler,
42 const DEFAULT: bool = true;
44 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
45 // When downloading stage1, the standard library has already been copied to the sysroot, so
46 // there's no need to rebuild it.
47 let download_rustc = run.builder.config.download_rustc;
48 run.all_krates("test").default_condition(!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.config.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 || builder.config.llvm_libunwind == LlvmLibunwind::InTree
181 && (target.contains("linux") || target.contains("fuchsia"))
184 copy_llvm_libunwind(builder, target, &builder.sysroot_libdir(*compiler, target));
185 target_deps.push((libunwind_path, DependencyType::Target));
191 /// Copies third party objects needed by various targets for self-contained linkage.
192 fn copy_self_contained_objects(
193 builder: &Builder<'_>,
195 target: TargetSelection,
196 ) -> Vec<(PathBuf, DependencyType)> {
197 let libdir_self_contained = builder.sysroot_libdir(*compiler, target).join("self-contained");
198 t!(fs::create_dir_all(&libdir_self_contained));
199 let mut target_deps = vec![];
201 // Copies the libc and CRT objects.
203 // rustc historically provides a more self-contained installation for musl targets
204 // not requiring the presence of a native musl toolchain. For example, it can fall back
205 // to using gcc from a glibc-targeting toolchain for linking.
206 // To do that we have to distribute musl startup objects as a part of Rust toolchain
207 // and link with them manually in the self-contained mode.
208 if target.contains("musl") {
209 let srcdir = builder.musl_libdir(target).unwrap_or_else(|| {
210 panic!("Target {:?} does not have a \"musl-libdir\" key", target.triple)
212 for &obj in &["libc.a", "crt1.o", "Scrt1.o", "rcrt1.o", "crti.o", "crtn.o"] {
215 &libdir_self_contained,
219 DependencyType::TargetSelfContained,
222 let crt_path = builder.ensure(native::CrtBeginEnd { target });
223 for &obj in &["crtbegin.o", "crtbeginS.o", "crtend.o", "crtendS.o"] {
224 let src = crt_path.join(obj);
225 let target = libdir_self_contained.join(obj);
226 builder.copy(&src, &target);
227 target_deps.push((target, DependencyType::TargetSelfContained));
230 let libunwind_path = copy_llvm_libunwind(builder, target, &libdir_self_contained);
231 target_deps.push((libunwind_path, DependencyType::TargetSelfContained));
232 } else if target.ends_with("-wasi") {
236 panic!("Target {:?} does not have a \"wasi-root\" key", target.triple)
238 .join("lib/wasm32-wasi");
239 for &obj in &["libc.a", "crt1-command.o", "crt1-reactor.o"] {
242 &libdir_self_contained,
246 DependencyType::TargetSelfContained,
249 } else if target.contains("windows-gnu") {
250 for obj in ["crt2.o", "dllcrt2.o"].iter() {
251 let src = compiler_file(builder, builder.cc(target), target, obj);
252 let target = libdir_self_contained.join(obj);
253 builder.copy(&src, &target);
254 target_deps.push((target, DependencyType::TargetSelfContained));
261 /// Configure cargo to compile the standard library, adding appropriate env vars
263 pub fn std_cargo(builder: &Builder<'_>, target: TargetSelection, stage: u32, cargo: &mut Cargo) {
264 if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
265 cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
268 // Determine if we're going to compile in optimized C intrinsics to
269 // the `compiler-builtins` crate. These intrinsics live in LLVM's
270 // `compiler-rt` repository, but our `src/llvm-project` submodule isn't
271 // always checked out, so we need to conditionally look for this. (e.g. if
272 // an external LLVM is used we skip the LLVM submodule checkout).
274 // Note that this shouldn't affect the correctness of `compiler-builtins`,
275 // but only its speed. Some intrinsics in C haven't been translated to Rust
276 // yet but that's pretty rare. Other intrinsics have optimized
277 // implementations in C which have only had slower versions ported to Rust,
278 // so we favor the C version where we can, but it's not critical.
280 // If `compiler-rt` is available ensure that the `c` feature of the
281 // `compiler-builtins` crate is enabled and it's configured to learn where
282 // `compiler-rt` is located.
283 let compiler_builtins_root = builder.src.join("src/llvm-project/compiler-rt");
284 let compiler_builtins_c_feature = if compiler_builtins_root.exists() {
285 // Note that `libprofiler_builtins/build.rs` also computes this so if
286 // you're changing something here please also change that.
287 cargo.env("RUST_COMPILER_RT_ROOT", &compiler_builtins_root);
288 " compiler-builtins-c"
293 if builder.no_std(target) == Some(true) {
294 let mut features = "compiler-builtins-mem".to_string();
295 if !target.starts_with("bpf") {
296 features.push_str(compiler_builtins_c_feature);
299 // for no-std targets we only compile a few no_std crates
301 .args(&["-p", "alloc"])
302 .arg("--manifest-path")
303 .arg(builder.src.join("library/alloc/Cargo.toml"))
307 let mut features = builder.std_features(target);
308 features.push_str(compiler_builtins_c_feature);
313 .arg("--manifest-path")
314 .arg(builder.src.join("library/test/Cargo.toml"));
316 // Help the libc crate compile by assisting it in finding various
317 // sysroot native libraries.
318 if target.contains("musl") {
319 if let Some(p) = builder.musl_libdir(target) {
320 let root = format!("native={}", p.to_str().unwrap());
321 cargo.rustflag("-L").rustflag(&root);
325 if target.ends_with("-wasi") {
326 if let Some(p) = builder.wasi_root(target) {
327 let root = format!("native={}/lib/wasm32-wasi", p.to_str().unwrap());
328 cargo.rustflag("-L").rustflag(&root);
333 // By default, rustc uses `-Cembed-bitcode=yes`, and Cargo overrides that
334 // with `-Cembed-bitcode=no` for non-LTO builds. However, libstd must be
335 // built with bitcode so that the produced rlibs can be used for both LTO
336 // builds (which use bitcode) and non-LTO builds (which use object code).
337 // So we override the override here!
339 // But we don't bother for the stage 0 compiler because it's never used
342 cargo.rustflag("-Cembed-bitcode=yes");
345 // By default, rustc does not include unwind tables unless they are required
346 // for a particular target. They are not required by RISC-V targets, but
347 // compiling the standard library with them means that users can get
348 // backtraces without having to recompile the standard library themselves.
350 // This choice was discussed in https://github.com/rust-lang/rust/pull/69890
351 if target.contains("riscv") {
352 cargo.rustflag("-Cforce-unwind-tables=yes");
356 format!("-Zcrate-attr=doc(html_root_url=\"{}/\")", builder.doc_rust_lang_org_channel(),);
357 cargo.rustflag(&html_root);
358 cargo.rustdocflag(&html_root);
361 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
363 pub compiler: Compiler,
364 pub target_compiler: Compiler,
365 pub target: TargetSelection,
368 impl Step for StdLink {
371 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
375 /// Link all libstd rlibs/dylibs into the sysroot location.
377 /// Links those artifacts generated by `compiler` to the `stage` compiler's
378 /// sysroot for the specified `host` and `target`.
380 /// Note that this assumes that `compiler` has already generated the libstd
381 /// libraries for `target`, and this method will find them in the relevant
382 /// output directory.
383 fn run(self, builder: &Builder<'_>) {
384 let compiler = self.compiler;
385 let target_compiler = self.target_compiler;
386 let target = self.target;
387 builder.info(&format!(
388 "Copying stage{} std from stage{} ({} -> {} / {})",
389 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
391 let libdir = builder.sysroot_libdir(target_compiler, target);
392 let hostdir = builder.sysroot_libdir(target_compiler, compiler.host);
393 add_to_sysroot(builder, &libdir, &hostdir, &libstd_stamp(builder, compiler, target));
397 /// Copies sanitizer runtime libraries into target libdir.
399 builder: &Builder<'_>,
401 target: TargetSelection,
403 let runtimes: Vec<native::SanitizerRuntime> = builder.ensure(native::Sanitizers { target });
405 if builder.config.dry_run {
409 let mut target_deps = Vec::new();
410 let libdir = builder.sysroot_libdir(*compiler, target);
412 for runtime in &runtimes {
413 let dst = libdir.join(&runtime.name);
414 builder.copy(&runtime.path, &dst);
416 if target == "x86_64-apple-darwin" || target == "aarch64-apple-darwin" {
417 // Update the library’s install name to reflect that it has has been renamed.
418 apple_darwin_update_library_name(&dst, &format!("@rpath/{}", &runtime.name));
419 // Upon renaming the install name, the code signature of the file will invalidate,
420 // so we will sign it again.
421 apple_darwin_sign_file(&dst);
424 target_deps.push(dst);
430 fn apple_darwin_update_library_name(library_path: &Path, new_name: &str) {
431 let status = Command::new("install_name_tool")
436 .expect("failed to execute `install_name_tool`");
437 assert!(status.success());
440 fn apple_darwin_sign_file(file_path: &Path) {
441 let status = Command::new("codesign")
442 .arg("-f") // Force to rewrite the existing signature
447 .expect("failed to execute `codesign`");
448 assert!(status.success());
451 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
452 pub struct StartupObjects {
453 pub compiler: Compiler,
454 pub target: TargetSelection,
457 impl Step for StartupObjects {
458 type Output = Vec<(PathBuf, DependencyType)>;
460 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
461 run.path("library/rtstartup")
464 fn make_run(run: RunConfig<'_>) {
465 run.builder.ensure(StartupObjects {
466 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
471 /// Builds and prepare startup objects like rsbegin.o and rsend.o
473 /// These are primarily used on Windows right now for linking executables/dlls.
474 /// They don't require any library support as they're just plain old object
475 /// files, so we just use the nightly snapshot compiler to always build them (as
476 /// no other compilers are guaranteed to be available).
477 fn run(self, builder: &Builder<'_>) -> Vec<(PathBuf, DependencyType)> {
478 let for_compiler = self.compiler;
479 let target = self.target;
480 if !target.contains("windows-gnu") {
484 let mut target_deps = vec![];
486 let src_dir = &builder.src.join("library").join("rtstartup");
487 let dst_dir = &builder.native_dir(target).join("rtstartup");
488 let sysroot_dir = &builder.sysroot_libdir(for_compiler, target);
489 t!(fs::create_dir_all(dst_dir));
491 for file in &["rsbegin", "rsend"] {
492 let src_file = &src_dir.join(file.to_string() + ".rs");
493 let dst_file = &dst_dir.join(file.to_string() + ".o");
494 if !up_to_date(src_file, dst_file) {
495 let mut cmd = Command::new(&builder.initial_rustc);
496 cmd.env("RUSTC_BOOTSTRAP", "1");
497 if !builder.local_rebuild {
498 // a local_rebuild compiler already has stage1 features
499 cmd.arg("--cfg").arg("bootstrap");
503 .arg(target.rustc_target_arg())
511 let target = sysroot_dir.join((*file).to_string() + ".o");
512 builder.copy(dst_file, &target);
513 target_deps.push((target, DependencyType::Target));
520 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
522 pub target: TargetSelection,
523 pub compiler: Compiler,
526 impl Step for Rustc {
528 const ONLY_HOSTS: bool = true;
529 const DEFAULT: bool = false;
531 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
535 fn make_run(run: RunConfig<'_>) {
536 run.builder.ensure(Rustc {
537 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
542 /// Builds the compiler.
544 /// This will build the compiler for a particular stage of the build using
545 /// the `compiler` targeting the `target` architecture. The artifacts
546 /// created will also be linked into the sysroot directory.
547 fn run(self, builder: &Builder<'_>) {
548 let compiler = self.compiler;
549 let target = self.target;
551 // NOTE: the ABI of the beta compiler is different from the ABI of the downloaded compiler,
552 // so its artifacts can't be reused.
553 if builder.config.download_rustc && compiler.stage != 0 {
554 // Copy the existing artifacts instead of rebuilding them.
555 // NOTE: this path is only taken for tools linking to rustc-dev.
556 builder.ensure(Sysroot { compiler });
560 builder.ensure(Std { compiler, target });
562 if builder.config.keep_stage.contains(&compiler.stage) {
563 builder.info("Warning: Using a potentially old librustc. This may not behave well.");
564 builder.info("Warning: Use `--keep-stage-std` if you want to rebuild the compiler when it changes");
565 builder.ensure(RustcLink { compiler, target_compiler: compiler, target });
569 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
570 if compiler_to_use != compiler {
571 builder.ensure(Rustc { compiler: compiler_to_use, target });
573 .info(&format!("Uplifting stage1 rustc ({} -> {})", builder.config.build, target));
574 builder.ensure(RustcLink {
575 compiler: compiler_to_use,
576 target_compiler: compiler,
582 // Ensure that build scripts and proc macros have a std / libproc_macro to link against.
584 compiler: builder.compiler(self.compiler.stage, builder.config.build),
585 target: builder.config.build,
588 let mut cargo = builder.cargo(compiler, Mode::Rustc, SourceType::InTree, target, "build");
589 rustc_cargo(builder, &mut cargo, target);
591 if builder.config.rust_profile_use.is_some()
592 && builder.config.rust_profile_generate.is_some()
594 panic!("Cannot use and generate PGO profiles at the same time");
597 let is_collecting = if let Some(path) = &builder.config.rust_profile_generate {
598 if compiler.stage == 1 {
599 cargo.rustflag(&format!("-Cprofile-generate={}", path));
600 // Apparently necessary to avoid overflowing the counters during
601 // a Cargo build profile
602 cargo.rustflag("-Cllvm-args=-vp-counters-per-site=4");
607 } else if let Some(path) = &builder.config.rust_profile_use {
608 if compiler.stage == 1 {
609 cargo.rustflag(&format!("-Cprofile-use={}", path));
610 cargo.rustflag("-Cllvm-args=-pgo-warn-missing-function");
619 // Ensure paths to Rust sources are relative, not absolute.
620 cargo.rustflag(&format!(
621 "-Cllvm-args=-static-func-strip-dirname-prefix={}",
622 builder.config.src.components().count()
626 builder.info(&format!(
627 "Building stage{} compiler artifacts ({} -> {})",
628 compiler.stage, &compiler.host, target
634 &librustc_stamp(builder, compiler, target),
639 builder.ensure(RustcLink {
640 compiler: builder.compiler(compiler.stage, builder.config.build),
641 target_compiler: compiler,
647 pub fn rustc_cargo(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
650 .arg(builder.rustc_features())
651 .arg("--manifest-path")
652 .arg(builder.src.join("compiler/rustc/Cargo.toml"));
653 rustc_cargo_env(builder, cargo, target);
656 pub fn rustc_cargo_env(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
657 // Set some configuration variables picked up by build scripts and
658 // the compiler alike
660 .env("CFG_RELEASE", builder.rust_release())
661 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
662 .env("CFG_VERSION", builder.rust_version());
664 let libdir_relative = builder.config.libdir_relative().unwrap_or_else(|| Path::new("lib"));
665 cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
667 if let Some(ref ver_date) = builder.rust_info.commit_date() {
668 cargo.env("CFG_VER_DATE", ver_date);
670 if let Some(ref ver_hash) = builder.rust_info.sha() {
671 cargo.env("CFG_VER_HASH", ver_hash);
673 if !builder.unstable_features() {
674 cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
676 if let Some(ref s) = builder.config.rustc_default_linker {
677 cargo.env("CFG_DEFAULT_LINKER", s);
679 if builder.config.rustc_parallel {
680 cargo.rustflag("--cfg=parallel_compiler");
681 cargo.rustdocflag("--cfg=parallel_compiler");
683 if builder.config.rust_verify_llvm_ir {
684 cargo.env("RUSTC_VERIFY_LLVM_IR", "1");
687 // Pass down configuration from the LLVM build into the build of
688 // rustc_llvm and rustc_codegen_llvm.
690 // Note that this is disabled if LLVM itself is disabled or we're in a check
691 // build. If we are in a check build we still go ahead here presuming we've
692 // detected that LLVM is alreay built and good to go which helps prevent
693 // busting caches (e.g. like #71152).
694 if builder.config.llvm_enabled()
695 && (builder.kind != Kind::Check
696 || crate::native::prebuilt_llvm_config(builder, target).is_ok())
698 if builder.is_rust_llvm(target) {
699 cargo.env("LLVM_RUSTLLVM", "1");
701 let llvm_config = builder.ensure(native::Llvm { target });
702 cargo.env("LLVM_CONFIG", &llvm_config);
703 let target_config = builder.config.target_config.get(&target);
704 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
705 cargo.env("CFG_LLVM_ROOT", s);
707 // Some LLVM linker flags (-L and -l) may be needed to link rustc_llvm.
708 if let Some(ref s) = builder.config.llvm_ldflags {
709 cargo.env("LLVM_LINKER_FLAGS", s);
711 // Building with a static libstdc++ is only supported on linux right now,
712 // not for MSVC or macOS
713 if builder.config.llvm_static_stdcpp
714 && !target.contains("freebsd")
715 && !target.contains("msvc")
716 && !target.contains("apple")
718 let file = compiler_file(builder, builder.cxx(target).unwrap(), target, "libstdc++.a");
719 cargo.env("LLVM_STATIC_STDCPP", file);
721 if builder.config.llvm_link_shared {
722 cargo.env("LLVM_LINK_SHARED", "1");
724 if builder.config.llvm_use_libcxx {
725 cargo.env("LLVM_USE_LIBCXX", "1");
727 if builder.config.llvm_optimize && !builder.config.llvm_release_debuginfo {
728 cargo.env("LLVM_NDEBUG", "1");
733 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
735 pub compiler: Compiler,
736 pub target_compiler: Compiler,
737 pub target: TargetSelection,
740 impl Step for RustcLink {
743 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
747 /// Same as `std_link`, only for librustc
748 fn run(self, builder: &Builder<'_>) {
749 let compiler = self.compiler;
750 let target_compiler = self.target_compiler;
751 let target = self.target;
752 builder.info(&format!(
753 "Copying stage{} rustc from stage{} ({} -> {} / {})",
754 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
758 &builder.sysroot_libdir(target_compiler, target),
759 &builder.sysroot_libdir(target_compiler, compiler.host),
760 &librustc_stamp(builder, compiler, target),
765 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
766 pub struct CodegenBackend {
767 pub target: TargetSelection,
768 pub compiler: Compiler,
769 pub backend: Interned<String>,
772 impl Step for CodegenBackend {
774 const ONLY_HOSTS: bool = true;
775 // Only the backends specified in the `codegen-backends` entry of `config.toml` are built.
776 const DEFAULT: bool = true;
778 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
779 run.path("compiler/rustc_codegen_cranelift")
782 fn make_run(run: RunConfig<'_>) {
783 for &backend in &run.builder.config.rust_codegen_backends {
784 if backend == "llvm" {
785 continue; // Already built as part of rustc
788 run.builder.ensure(CodegenBackend {
790 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
796 fn run(self, builder: &Builder<'_>) {
797 let compiler = self.compiler;
798 let target = self.target;
799 let backend = self.backend;
801 builder.ensure(Rustc { compiler, target });
803 if builder.config.keep_stage.contains(&compiler.stage) {
805 "Warning: Using a potentially old codegen backend. \
806 This may not behave well.",
808 // Codegen backends are linked separately from this step today, so we don't do
813 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
814 if compiler_to_use != compiler {
815 builder.ensure(CodegenBackend { compiler: compiler_to_use, target, backend });
819 let out_dir = builder.cargo_out(compiler, Mode::Codegen, target);
821 let mut cargo = builder.cargo(compiler, Mode::Codegen, SourceType::InTree, target, "build");
823 .arg("--manifest-path")
824 .arg(builder.src.join(format!("compiler/rustc_codegen_{}/Cargo.toml", backend)));
825 rustc_cargo_env(builder, &mut cargo, target);
827 let tmp_stamp = out_dir.join(".tmp.stamp");
829 builder.info(&format!(
830 "Building stage{} codegen backend {} ({} -> {})",
831 compiler.stage, backend, &compiler.host, target
833 let files = run_cargo(builder, cargo, vec![], &tmp_stamp, vec![], false);
834 if builder.config.dry_run {
837 let mut files = files.into_iter().filter(|f| {
838 let filename = f.file_name().unwrap().to_str().unwrap();
839 is_dylib(filename) && filename.contains("rustc_codegen_")
841 let codegen_backend = match files.next() {
843 None => panic!("no dylibs built for codegen backend?"),
845 if let Some(f) = files.next() {
847 "codegen backend built two dylibs:\n{}\n{}",
848 codegen_backend.display(),
852 let stamp = codegen_backend_stamp(builder, compiler, target, backend);
853 let codegen_backend = codegen_backend.to_str().unwrap();
854 t!(fs::write(&stamp, &codegen_backend));
858 /// Creates the `codegen-backends` folder for a compiler that's about to be
859 /// assembled as a complete compiler.
861 /// This will take the codegen artifacts produced by `compiler` and link them
862 /// into an appropriate location for `target_compiler` to be a functional
864 fn copy_codegen_backends_to_sysroot(
865 builder: &Builder<'_>,
867 target_compiler: Compiler,
869 let target = target_compiler.host;
871 // Note that this step is different than all the other `*Link` steps in
872 // that it's not assembling a bunch of libraries but rather is primarily
873 // moving the codegen backend into place. The codegen backend of rustc is
874 // not linked into the main compiler by default but is rather dynamically
875 // selected at runtime for inclusion.
877 // Here we're looking for the output dylib of the `CodegenBackend` step and
878 // we're copying that into the `codegen-backends` folder.
879 let dst = builder.sysroot_codegen_backends(target_compiler);
880 t!(fs::create_dir_all(&dst), dst);
882 if builder.config.dry_run {
886 for backend in builder.config.rust_codegen_backends.iter() {
887 if backend == "llvm" {
888 continue; // Already built as part of rustc
891 let stamp = codegen_backend_stamp(builder, compiler, target, *backend);
892 let dylib = t!(fs::read_to_string(&stamp));
893 let file = Path::new(&dylib);
894 let filename = file.file_name().unwrap().to_str().unwrap();
895 // change `librustc_codegen_cranelift-xxxxxx.so` to
896 // `librustc_codegen_cranelift-release.so`
897 let target_filename = {
898 let dash = filename.find('-').unwrap();
899 let dot = filename.find('.').unwrap();
900 format!("{}-{}{}", &filename[..dash], builder.rust_release(), &filename[dot..])
902 builder.copy(&file, &dst.join(target_filename));
906 /// Cargo's output path for the standard library in a given stage, compiled
907 /// by a particular compiler for the specified target.
908 pub fn libstd_stamp(builder: &Builder<'_>, compiler: Compiler, target: TargetSelection) -> PathBuf {
909 builder.cargo_out(compiler, Mode::Std, target).join(".libstd.stamp")
912 /// Cargo's output path for librustc in a given stage, compiled by a particular
913 /// compiler for the specified target.
914 pub fn librustc_stamp(
915 builder: &Builder<'_>,
917 target: TargetSelection,
919 builder.cargo_out(compiler, Mode::Rustc, target).join(".librustc.stamp")
922 /// Cargo's output path for librustc_codegen_llvm in a given stage, compiled by a particular
923 /// compiler for the specified target and backend.
924 fn codegen_backend_stamp(
925 builder: &Builder<'_>,
927 target: TargetSelection,
928 backend: Interned<String>,
931 .cargo_out(compiler, Mode::Codegen, target)
932 .join(format!(".librustc_codegen_{}.stamp", backend))
935 pub fn compiler_file(
936 builder: &Builder<'_>,
938 target: TargetSelection,
941 let mut cmd = Command::new(compiler);
942 cmd.args(builder.cflags(target, GitRepo::Rustc));
943 cmd.arg(format!("-print-file-name={}", file));
944 let out = output(&mut cmd);
945 PathBuf::from(out.trim())
948 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
950 pub compiler: Compiler,
953 impl Step for Sysroot {
954 type Output = Interned<PathBuf>;
956 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
960 /// Returns the sysroot for the `compiler` specified that *this build system
963 /// That is, the sysroot for the stage0 compiler is not what the compiler
964 /// thinks it is by default, but it's the same as the default for stages
966 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
967 let compiler = self.compiler;
968 let sysroot = if compiler.stage == 0 {
969 builder.out.join(&compiler.host.triple).join("stage0-sysroot")
971 builder.out.join(&compiler.host.triple).join(format!("stage{}", compiler.stage))
973 let _ = fs::remove_dir_all(&sysroot);
974 t!(fs::create_dir_all(&sysroot));
976 // If we're downloading a compiler from CI, we can use the same compiler for all stages other than 0.
977 if builder.config.download_rustc && compiler.stage != 0 {
979 builder.config.build, compiler.host,
980 "Cross-compiling is not yet supported with `download-rustc`",
982 // Copy the compiler into the correct sysroot.
984 builder.config.out.join(&*builder.config.build.triple).join("ci-rustc");
985 builder.cp_r(&ci_rustc_dir, &sysroot);
986 return INTERNER.intern_path(sysroot);
989 // Symlink the source root into the same location inside the sysroot,
990 // where `rust-src` component would go (`$sysroot/lib/rustlib/src/rust`),
991 // so that any tools relying on `rust-src` also work for local builds,
992 // and also for translating the virtual `/rustc/$hash` back to the real
993 // directory (for running tests with `rust.remap-debuginfo = true`).
994 let sysroot_lib_rustlib_src = sysroot.join("lib/rustlib/src");
995 t!(fs::create_dir_all(&sysroot_lib_rustlib_src));
996 let sysroot_lib_rustlib_src_rust = sysroot_lib_rustlib_src.join("rust");
997 if let Err(e) = symlink_dir(&builder.config, &builder.src, &sysroot_lib_rustlib_src_rust) {
999 "warning: creating symbolic link `{}` to `{}` failed with {}",
1000 sysroot_lib_rustlib_src_rust.display(),
1001 builder.src.display(),
1004 if builder.config.rust_remap_debuginfo {
1006 "warning: some `src/test/ui` tests will fail when lacking `{}`",
1007 sysroot_lib_rustlib_src_rust.display(),
1012 INTERNER.intern_path(sysroot)
1016 #[derive(Debug, Copy, PartialOrd, Ord, Clone, PartialEq, Eq, Hash)]
1017 pub struct Assemble {
1018 /// The compiler which we will produce in this step. Assemble itself will
1019 /// take care of ensuring that the necessary prerequisites to do so exist,
1020 /// that is, this target can be a stage2 compiler and Assemble will build
1021 /// previous stages for you.
1022 pub target_compiler: Compiler,
1025 impl Step for Assemble {
1026 type Output = Compiler;
1027 const ONLY_HOSTS: bool = true;
1029 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1030 run.path("compiler/rustc")
1033 fn make_run(run: RunConfig<'_>) {
1034 run.builder.ensure(Assemble {
1035 target_compiler: run.builder.compiler(run.builder.top_stage + 1, run.target),
1039 /// Prepare a new compiler from the artifacts in `stage`
1041 /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
1042 /// must have been previously produced by the `stage - 1` builder.build
1044 fn run(self, builder: &Builder<'_>) -> Compiler {
1045 let target_compiler = self.target_compiler;
1047 if target_compiler.stage == 0 {
1049 builder.config.build, target_compiler.host,
1050 "Cannot obtain compiler for non-native build triple at stage 0"
1052 // The stage 0 compiler for the build triple is always pre-built.
1053 return target_compiler;
1056 // Get the compiler that we'll use to bootstrap ourselves.
1058 // Note that this is where the recursive nature of the bootstrap
1059 // happens, as this will request the previous stage's compiler on
1060 // downwards to stage 0.
1062 // Also note that we're building a compiler for the host platform. We
1063 // only assume that we can run `build` artifacts, which means that to
1064 // produce some other architecture compiler we need to start from
1065 // `build` to get there.
1067 // FIXME: It may be faster if we build just a stage 1 compiler and then
1068 // use that to bootstrap this compiler forward.
1069 let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
1071 // If we're downloading a compiler from CI, we can use the same compiler for all stages other than 0.
1072 if builder.config.download_rustc {
1073 builder.ensure(Sysroot { compiler: target_compiler });
1074 return target_compiler;
1077 // Build the libraries for this compiler to link to (i.e., the libraries
1078 // it uses at runtime). NOTE: Crates the target compiler compiles don't
1079 // link to these. (FIXME: Is that correct? It seems to be correct most
1080 // of the time but I think we do link to these for stage2/bin compilers
1081 // when not performing a full bootstrap).
1082 builder.ensure(Rustc { compiler: build_compiler, target: target_compiler.host });
1084 for &backend in builder.config.rust_codegen_backends.iter() {
1085 if backend == "llvm" {
1086 continue; // Already built as part of rustc
1089 builder.ensure(CodegenBackend {
1090 compiler: build_compiler,
1091 target: target_compiler.host,
1096 let lld_install = if builder.config.lld_enabled {
1097 Some(builder.ensure(native::Lld { target: target_compiler.host }))
1102 let stage = target_compiler.stage;
1103 let host = target_compiler.host;
1104 builder.info(&format!("Assembling stage{} compiler ({})", stage, host));
1106 // Link in all dylibs to the libdir
1107 let stamp = librustc_stamp(builder, build_compiler, target_compiler.host);
1108 let proc_macros = builder
1109 .read_stamp_file(&stamp)
1111 .filter_map(|(path, dependency_type)| {
1112 if dependency_type == DependencyType::Host {
1113 Some(path.file_name().unwrap().to_owned().into_string().unwrap())
1118 .collect::<HashSet<_>>();
1120 let sysroot = builder.sysroot(target_compiler);
1121 let rustc_libdir = builder.rustc_libdir(target_compiler);
1122 t!(fs::create_dir_all(&rustc_libdir));
1123 let src_libdir = builder.sysroot_libdir(build_compiler, host);
1124 for f in builder.read_dir(&src_libdir) {
1125 let filename = f.file_name().into_string().unwrap();
1126 if (is_dylib(&filename) || is_debug_info(&filename)) && !proc_macros.contains(&filename)
1128 builder.copy(&f.path(), &rustc_libdir.join(&filename));
1132 copy_codegen_backends_to_sysroot(builder, build_compiler, target_compiler);
1134 // We prepend this bin directory to the user PATH when linking Rust binaries. To
1135 // avoid shadowing the system LLD we rename the LLD we provide to `rust-lld`.
1136 let libdir = builder.sysroot_libdir(target_compiler, target_compiler.host);
1137 let libdir_bin = libdir.parent().unwrap().join("bin");
1138 t!(fs::create_dir_all(&libdir_bin));
1140 if let Some(lld_install) = lld_install {
1141 let src_exe = exe("lld", target_compiler.host);
1142 let dst_exe = exe("rust-lld", target_compiler.host);
1143 builder.copy(&lld_install.join("bin").join(&src_exe), &libdir_bin.join(&dst_exe));
1144 // for `-Z gcc-ld=lld`
1145 let gcc_ld_dir = libdir_bin.join("gcc-ld");
1146 t!(fs::create_dir(&gcc_ld_dir));
1147 for flavor in ["ld", "ld64"] {
1148 let lld_wrapper_exe = builder.ensure(crate::tool::LldWrapper {
1149 compiler: build_compiler,
1150 target: target_compiler.host,
1151 flavor_feature: flavor,
1153 builder.copy(&lld_wrapper_exe, &gcc_ld_dir.join(exe(flavor, target_compiler.host)));
1157 // Similarly, copy `llvm-dwp` into libdir for Split DWARF. Only copy it when the LLVM
1158 // backend is used to avoid unnecessarily building LLVM and because LLVM is not checked
1159 // out by default when the LLVM backend is not enabled.
1160 if builder.config.rust_codegen_backends.contains(&INTERNER.intern_str("llvm")) {
1161 let src_exe = exe("llvm-dwp", target_compiler.host);
1162 let dst_exe = exe("rust-llvm-dwp", target_compiler.host);
1163 let llvm_config_bin = builder.ensure(native::Llvm { target: target_compiler.host });
1164 if !builder.config.dry_run {
1165 let llvm_bin_dir = output(Command::new(llvm_config_bin).arg("--bindir"));
1166 let llvm_bin_dir = Path::new(llvm_bin_dir.trim());
1167 builder.copy(&llvm_bin_dir.join(&src_exe), &libdir_bin.join(&dst_exe));
1169 // Since we've already built the LLVM tools, install them to the sysroot.
1170 // This is the equivalent of installing the `llvm-tools-preview` component via
1171 // rustup, and lets developers use a locally built toolchain to
1172 // build projects that expect llvm tools to be present in the sysroot
1173 // (e.g. the `bootimage` crate).
1174 for tool in LLVM_TOOLS {
1175 let tool_exe = exe(tool, target_compiler.host);
1176 let src_path = llvm_bin_dir.join(&tool_exe);
1177 // When using `donwload-ci-llvm`, some of the tools
1178 // may not exist, so skip trying to copy them.
1179 if src_path.exists() {
1180 builder.copy(&src_path, &libdir_bin.join(&tool_exe));
1186 // Ensure that `libLLVM.so` ends up in the newly build compiler directory,
1187 // so that it can be found when the newly built `rustc` is run.
1188 dist::maybe_install_llvm_runtime(builder, target_compiler.host, &sysroot);
1189 dist::maybe_install_llvm_target(builder, target_compiler.host, &sysroot);
1191 // Link the compiler binary itself into place
1192 let out_dir = builder.cargo_out(build_compiler, Mode::Rustc, host);
1193 let rustc = out_dir.join(exe("rustc-main", host));
1194 let bindir = sysroot.join("bin");
1195 t!(fs::create_dir_all(&bindir));
1196 let compiler = builder.rustc(target_compiler);
1197 builder.copy(&rustc, &compiler);
1203 /// Link some files into a rustc sysroot.
1205 /// For a particular stage this will link the file listed in `stamp` into the
1206 /// `sysroot_dst` provided.
1207 pub fn add_to_sysroot(
1208 builder: &Builder<'_>,
1210 sysroot_host_dst: &Path,
1213 let self_contained_dst = &sysroot_dst.join("self-contained");
1214 t!(fs::create_dir_all(&sysroot_dst));
1215 t!(fs::create_dir_all(&sysroot_host_dst));
1216 t!(fs::create_dir_all(&self_contained_dst));
1217 for (path, dependency_type) in builder.read_stamp_file(stamp) {
1218 let dst = match dependency_type {
1219 DependencyType::Host => sysroot_host_dst,
1220 DependencyType::Target => sysroot_dst,
1221 DependencyType::TargetSelfContained => self_contained_dst,
1223 builder.copy(&path, &dst.join(path.file_name().unwrap()));
1228 builder: &Builder<'_>,
1230 tail_args: Vec<String>,
1232 additional_target_deps: Vec<(PathBuf, DependencyType)>,
1235 if builder.config.dry_run {
1239 // `target_root_dir` looks like $dir/$target/release
1240 let target_root_dir = stamp.parent().unwrap();
1241 // `target_deps_dir` looks like $dir/$target/release/deps
1242 let target_deps_dir = target_root_dir.join("deps");
1243 // `host_root_dir` looks like $dir/release
1244 let host_root_dir = target_root_dir
1246 .unwrap() // chop off `release`
1248 .unwrap() // chop off `$target`
1249 .join(target_root_dir.file_name().unwrap());
1251 // Spawn Cargo slurping up its JSON output. We'll start building up the
1252 // `deps` array of all files it generated along with a `toplevel` array of
1253 // files we need to probe for later.
1254 let mut deps = Vec::new();
1255 let mut toplevel = Vec::new();
1256 let ok = stream_cargo(builder, cargo, tail_args, &mut |msg| {
1257 let (filenames, crate_types) = match msg {
1258 CargoMessage::CompilerArtifact {
1260 target: CargoTarget { crate_types },
1262 } => (filenames, crate_types),
1265 for filename in filenames {
1266 // Skip files like executables
1267 if !(filename.ends_with(".rlib")
1268 || filename.ends_with(".lib")
1269 || filename.ends_with(".a")
1270 || is_debug_info(&filename)
1271 || is_dylib(&filename)
1272 || (is_check && filename.ends_with(".rmeta")))
1277 let filename = Path::new(&*filename);
1279 // If this was an output file in the "host dir" we don't actually
1280 // worry about it, it's not relevant for us
1281 if filename.starts_with(&host_root_dir) {
1282 // Unless it's a proc macro used in the compiler
1283 if crate_types.iter().any(|t| t == "proc-macro") {
1284 deps.push((filename.to_path_buf(), DependencyType::Host));
1289 // If this was output in the `deps` dir then this is a precise file
1290 // name (hash included) so we start tracking it.
1291 if filename.starts_with(&target_deps_dir) {
1292 deps.push((filename.to_path_buf(), DependencyType::Target));
1296 // Otherwise this was a "top level artifact" which right now doesn't
1297 // have a hash in the name, but there's a version of this file in
1298 // the `deps` folder which *does* have a hash in the name. That's
1299 // the one we'll want to we'll probe for it later.
1301 // We do not use `Path::file_stem` or `Path::extension` here,
1302 // because some generated files may have multiple extensions e.g.
1303 // `std-<hash>.dll.lib` on Windows. The aforementioned methods only
1304 // split the file name by the last extension (`.lib`) while we need
1305 // to split by all extensions (`.dll.lib`).
1306 let expected_len = t!(filename.metadata()).len();
1307 let filename = filename.file_name().unwrap().to_str().unwrap();
1308 let mut parts = filename.splitn(2, '.');
1309 let file_stem = parts.next().unwrap().to_owned();
1310 let extension = parts.next().unwrap().to_owned();
1312 toplevel.push((file_stem, extension, expected_len));
1320 // Ok now we need to actually find all the files listed in `toplevel`. We've
1321 // got a list of prefix/extensions and we basically just need to find the
1322 // most recent file in the `deps` folder corresponding to each one.
1323 let contents = t!(target_deps_dir.read_dir())
1325 .map(|e| (e.path(), e.file_name().into_string().unwrap(), t!(e.metadata())))
1326 .collect::<Vec<_>>();
1327 for (prefix, extension, expected_len) in toplevel {
1328 let candidates = contents.iter().filter(|&&(_, ref filename, ref meta)| {
1329 meta.len() == expected_len
1331 .strip_prefix(&prefix[..])
1332 .map(|s| s.starts_with('-') && s.ends_with(&extension[..]))
1335 let max = candidates
1336 .max_by_key(|&&(_, _, ref metadata)| FileTime::from_last_modification_time(metadata));
1337 let path_to_add = match max {
1338 Some(triple) => triple.0.to_str().unwrap(),
1339 None => panic!("no output generated for {:?} {:?}", prefix, extension),
1341 if is_dylib(path_to_add) {
1342 let candidate = format!("{}.lib", path_to_add);
1343 let candidate = PathBuf::from(candidate);
1344 if candidate.exists() {
1345 deps.push((candidate, DependencyType::Target));
1348 deps.push((path_to_add.into(), DependencyType::Target));
1351 deps.extend(additional_target_deps);
1353 let mut new_contents = Vec::new();
1354 for (dep, dependency_type) in deps.iter() {
1355 new_contents.extend(match *dependency_type {
1356 DependencyType::Host => b"h",
1357 DependencyType::Target => b"t",
1358 DependencyType::TargetSelfContained => b"s",
1360 new_contents.extend(dep.to_str().unwrap().as_bytes());
1361 new_contents.extend(b"\0");
1363 t!(fs::write(&stamp, &new_contents));
1364 deps.into_iter().map(|(d, _)| d).collect()
1367 pub fn stream_cargo(
1368 builder: &Builder<'_>,
1370 tail_args: Vec<String>,
1371 cb: &mut dyn FnMut(CargoMessage<'_>),
1373 let mut cargo = Command::from(cargo);
1374 if builder.config.dry_run {
1377 // Instruct Cargo to give us json messages on stdout, critically leaving
1378 // stderr as piped so we can get those pretty colors.
1379 let mut message_format = if builder.config.json_output {
1380 String::from("json")
1382 String::from("json-render-diagnostics")
1384 if let Some(s) = &builder.config.rustc_error_format {
1385 message_format.push_str(",json-diagnostic-");
1386 message_format.push_str(s);
1388 cargo.arg("--message-format").arg(message_format).stdout(Stdio::piped());
1390 for arg in tail_args {
1394 builder.verbose(&format!("running: {:?}", cargo));
1395 let mut child = match cargo.spawn() {
1397 Err(e) => panic!("failed to execute command: {:?}\nerror: {}", cargo, e),
1400 // Spawn Cargo slurping up its JSON output. We'll start building up the
1401 // `deps` array of all files it generated along with a `toplevel` array of
1402 // files we need to probe for later.
1403 let stdout = BufReader::new(child.stdout.take().unwrap());
1404 for line in stdout.lines() {
1405 let line = t!(line);
1406 match serde_json::from_str::<CargoMessage<'_>>(&line) {
1408 if builder.config.json_output {
1409 // Forward JSON to stdout.
1410 println!("{}", line);
1414 // If this was informational, just print it out and continue
1415 Err(_) => println!("{}", line),
1419 // Make sure Cargo actually succeeded after we read all of its stdout.
1420 let status = t!(child.wait());
1421 if builder.is_verbose() && !status.success() {
1423 "command did not execute successfully: {:?}\n\
1424 expected success, got: {}",
1431 #[derive(Deserialize)]
1432 pub struct CargoTarget<'a> {
1433 crate_types: Vec<Cow<'a, str>>,
1436 #[derive(Deserialize)]
1437 #[serde(tag = "reason", rename_all = "kebab-case")]
1438 pub enum CargoMessage<'a> {
1440 package_id: Cow<'a, str>,
1441 features: Vec<Cow<'a, str>>,
1442 filenames: Vec<Cow<'a, str>>,
1443 target: CargoTarget<'a>,
1445 BuildScriptExecuted {
1446 package_id: Cow<'a, str>,