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 compiler the standard library, libtest, and
6 //! 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::TargetSelection;
29 use crate::tool::SourceType;
30 use crate::util::{exe, 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 run.all_krates("test")
47 fn make_run(run: RunConfig<'_>) {
48 run.builder.ensure(Std {
49 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
54 /// Builds the standard library.
56 /// This will build the standard library for a particular stage of the build
57 /// using the `compiler` targeting the `target` architecture. The artifacts
58 /// created will also be linked into the sysroot directory.
59 fn run(self, builder: &Builder<'_>) {
60 let target = self.target;
61 let compiler = self.compiler;
63 if builder.config.keep_stage.contains(&compiler.stage)
64 || builder.config.keep_stage_std.contains(&compiler.stage)
66 builder.info("Warning: Using a potentially old libstd. This may not behave well.");
67 builder.ensure(StdLink { compiler, target_compiler: compiler, target });
71 let mut target_deps = builder.ensure(StartupObjects { compiler, target });
73 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
74 if compiler_to_use != compiler {
75 builder.ensure(Std { compiler: compiler_to_use, target });
76 builder.info(&format!("Uplifting stage1 std ({} -> {})", compiler_to_use.host, target));
78 // Even if we're not building std this stage, the new sysroot must
79 // still contain the third party objects needed by various targets.
80 copy_third_party_objects(builder, &compiler, target);
81 copy_self_contained_objects(builder, &compiler, target);
83 builder.ensure(StdLink {
84 compiler: compiler_to_use,
85 target_compiler: compiler,
91 target_deps.extend(copy_third_party_objects(builder, &compiler, target));
92 target_deps.extend(copy_self_contained_objects(builder, &compiler, target));
94 let mut cargo = builder.cargo(compiler, Mode::Std, SourceType::InTree, target, "build");
95 std_cargo(builder, target, compiler.stage, &mut cargo);
97 builder.info(&format!(
98 "Building stage{} std artifacts ({} -> {})",
99 compiler.stage, &compiler.host, target
105 &libstd_stamp(builder, compiler, target),
110 builder.ensure(StdLink {
111 compiler: builder.compiler(compiler.stage, builder.config.build),
112 target_compiler: compiler,
119 builder: &Builder<'_>,
123 target_deps: &mut Vec<(PathBuf, DependencyType)>,
124 dependency_type: DependencyType,
126 let target = libdir.join(name);
127 builder.copy(&sourcedir.join(name), &target);
129 target_deps.push((target, dependency_type));
132 /// Copies third party objects needed by various targets.
133 fn copy_third_party_objects(
134 builder: &Builder<'_>,
136 target: TargetSelection,
137 ) -> Vec<(PathBuf, DependencyType)> {
138 let mut target_deps = vec![];
140 // FIXME: remove this in 2021
141 if target == "x86_64-fortanix-unknown-sgx" {
142 if env::var_os("X86_FORTANIX_SGX_LIBS").is_some() {
143 builder.info("Warning: X86_FORTANIX_SGX_LIBS environment variable is ignored, libunwind is now compiled as part of rustbuild");
147 if builder.config.sanitizers_enabled(target) && compiler.stage != 0 {
148 // The sanitizers are only copied in stage1 or above,
149 // to avoid creating dependency on LLVM.
151 copy_sanitizers(builder, &compiler, target)
153 .map(|d| (d, DependencyType::Target)),
160 /// Copies third party objects needed by various targets for self-contained linkage.
161 fn copy_self_contained_objects(
162 builder: &Builder<'_>,
164 target: TargetSelection,
165 ) -> Vec<(PathBuf, DependencyType)> {
166 let libdir_self_contained = builder.sysroot_libdir(*compiler, target).join("self-contained");
167 t!(fs::create_dir_all(&libdir_self_contained));
168 let mut target_deps = vec![];
170 // Copies the CRT objects.
172 // rustc historically provides a more self-contained installation for musl targets
173 // not requiring the presence of a native musl toolchain. For example, it can fall back
174 // to using gcc from a glibc-targeting toolchain for linking.
175 // To do that we have to distribute musl startup objects as a part of Rust toolchain
176 // and link with them manually in the self-contained mode.
177 if target.contains("musl") {
178 let srcdir = builder.musl_libdir(target).unwrap();
179 for &obj in &["crt1.o", "Scrt1.o", "rcrt1.o", "crti.o", "crtn.o"] {
182 &libdir_self_contained,
186 DependencyType::TargetSelfContained,
189 } else if target.ends_with("-wasi") {
190 let srcdir = builder.wasi_root(target).unwrap().join("lib/wasm32-wasi");
191 for &obj in &["crt1.o", "crt1-reactor.o"] {
194 &libdir_self_contained,
198 DependencyType::TargetSelfContained,
201 } else if target.contains("windows-gnu") {
202 for obj in ["crt2.o", "dllcrt2.o"].iter() {
203 let src = compiler_file(builder, builder.cc(target), target, obj);
204 let target = libdir_self_contained.join(obj);
205 builder.copy(&src, &target);
206 target_deps.push((target, DependencyType::TargetSelfContained));
213 /// Configure cargo to compile the standard library, adding appropriate env vars
215 pub fn std_cargo(builder: &Builder<'_>, target: TargetSelection, stage: u32, cargo: &mut Cargo) {
216 if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
217 cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
220 // Determine if we're going to compile in optimized C intrinsics to
221 // the `compiler-builtins` crate. These intrinsics live in LLVM's
222 // `compiler-rt` repository, but our `src/llvm-project` submodule isn't
223 // always checked out, so we need to conditionally look for this. (e.g. if
224 // an external LLVM is used we skip the LLVM submodule checkout).
226 // Note that this shouldn't affect the correctness of `compiler-builtins`,
227 // but only its speed. Some intrinsics in C haven't been translated to Rust
228 // yet but that's pretty rare. Other intrinsics have optimized
229 // implementations in C which have only had slower versions ported to Rust,
230 // so we favor the C version where we can, but it's not critical.
232 // If `compiler-rt` is available ensure that the `c` feature of the
233 // `compiler-builtins` crate is enabled and it's configured to learn where
234 // `compiler-rt` is located.
235 let compiler_builtins_root = builder.src.join("src/llvm-project/compiler-rt");
236 let compiler_builtins_c_feature = if compiler_builtins_root.exists() {
237 // Note that `libprofiler_builtins/build.rs` also computes this so if
238 // you're changing something here please also change that.
239 cargo.env("RUST_COMPILER_RT_ROOT", &compiler_builtins_root);
240 " compiler-builtins-c"
245 if builder.no_std(target) == Some(true) {
246 let mut features = "compiler-builtins-mem".to_string();
247 features.push_str(compiler_builtins_c_feature);
249 // for no-std targets we only compile a few no_std crates
251 .args(&["-p", "alloc"])
252 .arg("--manifest-path")
253 .arg(builder.src.join("library/alloc/Cargo.toml"))
257 let mut features = builder.std_features(target);
258 features.push_str(compiler_builtins_c_feature);
263 .arg("--manifest-path")
264 .arg(builder.src.join("library/test/Cargo.toml"));
266 // Help the libc crate compile by assisting it in finding various
267 // sysroot native libraries.
268 if target.contains("musl") {
269 if let Some(p) = builder.musl_libdir(target) {
270 let root = format!("native={}", p.to_str().unwrap());
271 cargo.rustflag("-L").rustflag(&root);
275 if target.ends_with("-wasi") {
276 if let Some(p) = builder.wasi_root(target) {
277 let root = format!("native={}/lib/wasm32-wasi", p.to_str().unwrap());
278 cargo.rustflag("-L").rustflag(&root);
283 // By default, rustc uses `-Cembed-bitcode=yes`, and Cargo overrides that
284 // with `-Cembed-bitcode=no` for non-LTO builds. However, libstd must be
285 // built with bitcode so that the produced rlibs can be used for both LTO
286 // builds (which use bitcode) and non-LTO builds (which use object code).
287 // So we override the override here!
289 // But we don't bother for the stage 0 compiler because it's never used
292 cargo.rustflag("-Cembed-bitcode=yes");
295 // By default, rustc does not include unwind tables unless they are required
296 // for a particular target. They are not required by RISC-V targets, but
297 // compiling the standard library with them means that users can get
298 // backtraces without having to recompile the standard library themselves.
300 // This choice was discussed in https://github.com/rust-lang/rust/pull/69890
301 if target.contains("riscv") {
302 cargo.rustflag("-Cforce-unwind-tables=yes");
306 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
308 pub compiler: Compiler,
309 pub target_compiler: Compiler,
310 pub target: TargetSelection,
313 impl Step for StdLink {
316 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
320 /// Link all libstd rlibs/dylibs into the sysroot location.
322 /// Links those artifacts generated by `compiler` to the `stage` compiler's
323 /// sysroot for the specified `host` and `target`.
325 /// Note that this assumes that `compiler` has already generated the libstd
326 /// libraries for `target`, and this method will find them in the relevant
327 /// output directory.
328 fn run(self, builder: &Builder<'_>) {
329 let compiler = self.compiler;
330 let target_compiler = self.target_compiler;
331 let target = self.target;
332 builder.info(&format!(
333 "Copying stage{} std from stage{} ({} -> {} / {})",
334 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
336 let libdir = builder.sysroot_libdir(target_compiler, target);
337 let hostdir = builder.sysroot_libdir(target_compiler, compiler.host);
338 add_to_sysroot(builder, &libdir, &hostdir, &libstd_stamp(builder, compiler, target));
342 /// Copies sanitizer runtime libraries into target libdir.
344 builder: &Builder<'_>,
346 target: TargetSelection,
348 let runtimes: Vec<native::SanitizerRuntime> = builder.ensure(native::Sanitizers { target });
350 if builder.config.dry_run {
354 let mut target_deps = Vec::new();
355 let libdir = builder.sysroot_libdir(*compiler, target);
357 for runtime in &runtimes {
358 let dst = libdir.join(&runtime.name);
359 builder.copy(&runtime.path, &dst);
361 if target == "x86_64-apple-darwin" || target == "aarch64-apple-darwin" {
362 // Update the library’s install name to reflect that it has has been renamed.
363 apple_darwin_update_library_name(&dst, &format!("@rpath/{}", &runtime.name));
364 // Upon renaming the install name, the code signature of the file will invalidate,
365 // so we will sign it again.
366 apple_darwin_sign_file(&dst);
369 target_deps.push(dst);
375 fn apple_darwin_update_library_name(library_path: &Path, new_name: &str) {
376 let status = Command::new("install_name_tool")
381 .expect("failed to execute `install_name_tool`");
382 assert!(status.success());
385 fn apple_darwin_sign_file(file_path: &Path) {
386 let status = Command::new("codesign")
387 .arg("-f") // Force to rewrite the existing signature
392 .expect("failed to execute `codesign`");
393 assert!(status.success());
396 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
397 pub struct StartupObjects {
398 pub compiler: Compiler,
399 pub target: TargetSelection,
402 impl Step for StartupObjects {
403 type Output = Vec<(PathBuf, DependencyType)>;
405 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
406 run.path("library/rtstartup")
409 fn make_run(run: RunConfig<'_>) {
410 run.builder.ensure(StartupObjects {
411 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
416 /// Builds and prepare startup objects like rsbegin.o and rsend.o
418 /// These are primarily used on Windows right now for linking executables/dlls.
419 /// They don't require any library support as they're just plain old object
420 /// files, so we just use the nightly snapshot compiler to always build them (as
421 /// no other compilers are guaranteed to be available).
422 fn run(self, builder: &Builder<'_>) -> Vec<(PathBuf, DependencyType)> {
423 let for_compiler = self.compiler;
424 let target = self.target;
425 if !target.contains("windows-gnu") {
429 let mut target_deps = vec![];
431 let src_dir = &builder.src.join("library").join("rtstartup");
432 let dst_dir = &builder.native_dir(target).join("rtstartup");
433 let sysroot_dir = &builder.sysroot_libdir(for_compiler, target);
434 t!(fs::create_dir_all(dst_dir));
436 for file in &["rsbegin", "rsend"] {
437 let src_file = &src_dir.join(file.to_string() + ".rs");
438 let dst_file = &dst_dir.join(file.to_string() + ".o");
439 if !up_to_date(src_file, dst_file) {
440 let mut cmd = Command::new(&builder.initial_rustc);
442 cmd.env("RUSTC_BOOTSTRAP", "1")
446 .arg(target.rustc_target_arg())
454 let target = sysroot_dir.join((*file).to_string() + ".o");
455 builder.copy(dst_file, &target);
456 target_deps.push((target, DependencyType::Target));
463 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
465 pub target: TargetSelection,
466 pub compiler: Compiler,
469 impl Step for Rustc {
471 const ONLY_HOSTS: bool = true;
472 const DEFAULT: bool = false;
474 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
475 run.path("compiler/rustc")
478 fn make_run(run: RunConfig<'_>) {
479 run.builder.ensure(Rustc {
480 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
485 /// Builds the compiler.
487 /// This will build the compiler for a particular stage of the build using
488 /// the `compiler` targeting the `target` architecture. The artifacts
489 /// created will also be linked into the sysroot directory.
490 fn run(self, builder: &Builder<'_>) {
491 let compiler = self.compiler;
492 let target = self.target;
494 builder.ensure(Std { compiler, target });
496 if builder.config.keep_stage.contains(&compiler.stage) {
497 builder.info("Warning: Using a potentially old librustc. This may not behave well.");
498 builder.info("Warning: Use `--keep-stage-std` if you want to rebuild the compiler when it changes");
499 builder.ensure(RustcLink { compiler, target_compiler: compiler, target });
503 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
504 if compiler_to_use != compiler {
505 builder.ensure(Rustc { compiler: compiler_to_use, target });
507 .info(&format!("Uplifting stage1 rustc ({} -> {})", builder.config.build, target));
508 builder.ensure(RustcLink {
509 compiler: compiler_to_use,
510 target_compiler: compiler,
516 // Ensure that build scripts and proc macros have a std / libproc_macro to link against.
518 compiler: builder.compiler(self.compiler.stage, builder.config.build),
519 target: builder.config.build,
522 let mut cargo = builder.cargo(compiler, Mode::Rustc, SourceType::InTree, target, "build");
523 rustc_cargo(builder, &mut cargo, target);
525 if builder.config.rust_profile_use.is_some()
526 && builder.config.rust_profile_generate.is_some()
528 panic!("Cannot use and generate PGO profiles at the same time");
531 let is_collecting = if let Some(path) = &builder.config.rust_profile_generate {
532 if compiler.stage == 1 {
533 cargo.rustflag(&format!("-Cprofile-generate={}", path));
534 // Apparently necessary to avoid overflowing the counters during
535 // a Cargo build profile
536 cargo.rustflag("-Cllvm-args=-vp-counters-per-site=4");
541 } else if let Some(path) = &builder.config.rust_profile_use {
542 if compiler.stage == 1 {
543 cargo.rustflag(&format!("-Cprofile-use={}", path));
544 cargo.rustflag("-Cllvm-args=-pgo-warn-missing-function");
553 // Ensure paths to Rust sources are relative, not absolute.
554 cargo.rustflag(&format!(
555 "-Cllvm-args=-static-func-strip-dirname-prefix={}",
556 builder.config.src.components().count()
560 builder.info(&format!(
561 "Building stage{} compiler artifacts ({} -> {})",
562 compiler.stage, &compiler.host, target
568 &librustc_stamp(builder, compiler, target),
573 builder.ensure(RustcLink {
574 compiler: builder.compiler(compiler.stage, builder.config.build),
575 target_compiler: compiler,
581 pub fn rustc_cargo(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
584 .arg(builder.rustc_features())
585 .arg("--manifest-path")
586 .arg(builder.src.join("compiler/rustc/Cargo.toml"));
587 rustc_cargo_env(builder, cargo, target);
590 pub fn rustc_cargo_env(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
591 // Set some configuration variables picked up by build scripts and
592 // the compiler alike
594 .env("CFG_RELEASE", builder.rust_release())
595 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
596 .env("CFG_VERSION", builder.rust_version())
597 .env("CFG_PREFIX", builder.config.prefix.clone().unwrap_or_default());
599 let libdir_relative = builder.config.libdir_relative().unwrap_or_else(|| Path::new("lib"));
600 cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
602 if let Some(ref ver_date) = builder.rust_info.commit_date() {
603 cargo.env("CFG_VER_DATE", ver_date);
605 if let Some(ref ver_hash) = builder.rust_info.sha() {
606 cargo.env("CFG_VER_HASH", ver_hash);
608 if !builder.unstable_features() {
609 cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
611 if let Some(ref s) = builder.config.rustc_default_linker {
612 cargo.env("CFG_DEFAULT_LINKER", s);
614 if builder.config.rustc_parallel {
615 cargo.rustflag("--cfg=parallel_compiler");
617 if builder.config.rust_verify_llvm_ir {
618 cargo.env("RUSTC_VERIFY_LLVM_IR", "1");
621 // Pass down configuration from the LLVM build into the build of
622 // rustc_llvm and rustc_codegen_llvm.
624 // Note that this is disabled if LLVM itself is disabled or we're in a check
625 // build. If we are in a check build we still go ahead here presuming we've
626 // detected that LLVM is alreay built and good to go which helps prevent
627 // busting caches (e.g. like #71152).
628 if builder.config.llvm_enabled()
629 && (builder.kind != Kind::Check
630 || crate::native::prebuilt_llvm_config(builder, target).is_ok())
632 if builder.is_rust_llvm(target) {
633 cargo.env("LLVM_RUSTLLVM", "1");
635 let llvm_config = builder.ensure(native::Llvm { target });
636 cargo.env("LLVM_CONFIG", &llvm_config);
637 let target_config = builder.config.target_config.get(&target);
638 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
639 cargo.env("CFG_LLVM_ROOT", s);
641 // Some LLVM linker flags (-L and -l) may be needed to link rustc_llvm.
642 if let Some(ref s) = builder.config.llvm_ldflags {
643 cargo.env("LLVM_LINKER_FLAGS", s);
645 // Building with a static libstdc++ is only supported on linux right now,
646 // not for MSVC or macOS
647 if builder.config.llvm_static_stdcpp
648 && !target.contains("freebsd")
649 && !target.contains("msvc")
650 && !target.contains("apple")
652 let file = compiler_file(builder, builder.cxx(target).unwrap(), target, "libstdc++.a");
653 cargo.env("LLVM_STATIC_STDCPP", file);
655 if builder.config.llvm_link_shared {
656 cargo.env("LLVM_LINK_SHARED", "1");
658 if builder.config.llvm_use_libcxx {
659 cargo.env("LLVM_USE_LIBCXX", "1");
661 if builder.config.llvm_optimize && !builder.config.llvm_release_debuginfo {
662 cargo.env("LLVM_NDEBUG", "1");
667 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
669 pub compiler: Compiler,
670 pub target_compiler: Compiler,
671 pub target: TargetSelection,
674 impl Step for RustcLink {
677 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
681 /// Same as `std_link`, only for librustc
682 fn run(self, builder: &Builder<'_>) {
683 let compiler = self.compiler;
684 let target_compiler = self.target_compiler;
685 let target = self.target;
686 builder.info(&format!(
687 "Copying stage{} rustc from stage{} ({} -> {} / {})",
688 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
692 &builder.sysroot_libdir(target_compiler, target),
693 &builder.sysroot_libdir(target_compiler, compiler.host),
694 &librustc_stamp(builder, compiler, target),
699 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
700 pub struct CodegenBackend {
701 pub target: TargetSelection,
702 pub compiler: Compiler,
703 pub backend: Interned<String>,
706 impl Step for CodegenBackend {
708 const ONLY_HOSTS: bool = true;
709 // Only the backends specified in the `codegen-backends` entry of `config.toml` are built.
710 const DEFAULT: bool = true;
712 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
713 run.path("compiler/rustc_codegen_cranelift")
716 fn make_run(run: RunConfig<'_>) {
717 for &backend in &run.builder.config.rust_codegen_backends {
718 if backend == "llvm" {
719 continue; // Already built as part of rustc
722 run.builder.ensure(CodegenBackend {
724 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
730 fn run(self, builder: &Builder<'_>) {
731 let compiler = self.compiler;
732 let target = self.target;
733 let backend = self.backend;
735 builder.ensure(Rustc { compiler, target });
737 if builder.config.keep_stage.contains(&compiler.stage) {
739 "Warning: Using a potentially old codegen backend. \
740 This may not behave well.",
742 // Codegen backends are linked separately from this step today, so we don't do
747 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
748 if compiler_to_use != compiler {
749 builder.ensure(CodegenBackend { compiler: compiler_to_use, target, backend });
753 let out_dir = builder.cargo_out(compiler, Mode::Codegen, target);
756 builder.cargo(compiler, Mode::Codegen, SourceType::Submodule, target, "build");
758 .arg("--manifest-path")
759 .arg(builder.src.join(format!("compiler/rustc_codegen_{}/Cargo.toml", backend)));
760 rustc_cargo_env(builder, &mut cargo, target);
762 let tmp_stamp = out_dir.join(".tmp.stamp");
764 let files = run_cargo(builder, cargo, vec![], &tmp_stamp, vec![], false);
765 if builder.config.dry_run {
768 let mut files = files.into_iter().filter(|f| {
769 let filename = f.file_name().unwrap().to_str().unwrap();
770 is_dylib(filename) && filename.contains("rustc_codegen_")
772 let codegen_backend = match files.next() {
774 None => panic!("no dylibs built for codegen backend?"),
776 if let Some(f) = files.next() {
778 "codegen backend built two dylibs:\n{}\n{}",
779 codegen_backend.display(),
783 let stamp = codegen_backend_stamp(builder, compiler, target, backend);
784 let codegen_backend = codegen_backend.to_str().unwrap();
785 t!(fs::write(&stamp, &codegen_backend));
789 /// Creates the `codegen-backends` folder for a compiler that's about to be
790 /// assembled as a complete compiler.
792 /// This will take the codegen artifacts produced by `compiler` and link them
793 /// into an appropriate location for `target_compiler` to be a functional
795 fn copy_codegen_backends_to_sysroot(
796 builder: &Builder<'_>,
798 target_compiler: Compiler,
800 let target = target_compiler.host;
802 // Note that this step is different than all the other `*Link` steps in
803 // that it's not assembling a bunch of libraries but rather is primarily
804 // moving the codegen backend into place. The codegen backend of rustc is
805 // not linked into the main compiler by default but is rather dynamically
806 // selected at runtime for inclusion.
808 // Here we're looking for the output dylib of the `CodegenBackend` step and
809 // we're copying that into the `codegen-backends` folder.
810 let dst = builder.sysroot_codegen_backends(target_compiler);
811 t!(fs::create_dir_all(&dst), dst);
813 if builder.config.dry_run {
817 for backend in builder.config.rust_codegen_backends.iter() {
818 if backend == "llvm" {
819 continue; // Already built as part of rustc
822 let stamp = codegen_backend_stamp(builder, compiler, target, *backend);
823 let dylib = t!(fs::read_to_string(&stamp));
824 let file = Path::new(&dylib);
825 let filename = file.file_name().unwrap().to_str().unwrap();
826 // change `librustc_codegen_cranelift-xxxxxx.so` to
827 // `librustc_codegen_cranelift-release.so`
828 let target_filename = {
829 let dash = filename.find('-').unwrap();
830 let dot = filename.find('.').unwrap();
831 format!("{}-{}{}", &filename[..dash], builder.rust_release(), &filename[dot..])
833 builder.copy(&file, &dst.join(target_filename));
837 /// Cargo's output path for the standard library in a given stage, compiled
838 /// by a particular compiler for the specified target.
839 pub fn libstd_stamp(builder: &Builder<'_>, compiler: Compiler, target: TargetSelection) -> PathBuf {
840 builder.cargo_out(compiler, Mode::Std, target).join(".libstd.stamp")
843 /// Cargo's output path for librustc in a given stage, compiled by a particular
844 /// compiler for the specified target.
845 pub fn librustc_stamp(
846 builder: &Builder<'_>,
848 target: TargetSelection,
850 builder.cargo_out(compiler, Mode::Rustc, target).join(".librustc.stamp")
853 /// Cargo's output path for librustc_codegen_llvm in a given stage, compiled by a particular
854 /// compiler for the specified target and backend.
855 fn codegen_backend_stamp(
856 builder: &Builder<'_>,
858 target: TargetSelection,
859 backend: Interned<String>,
862 .cargo_out(compiler, Mode::Codegen, target)
863 .join(format!(".librustc_codegen_{}.stamp", backend))
866 pub fn compiler_file(
867 builder: &Builder<'_>,
869 target: TargetSelection,
872 let mut cmd = Command::new(compiler);
873 cmd.args(builder.cflags(target, GitRepo::Rustc));
874 cmd.arg(format!("-print-file-name={}", file));
875 let out = output(&mut cmd);
876 PathBuf::from(out.trim())
879 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
881 pub compiler: Compiler,
884 impl Step for Sysroot {
885 type Output = Interned<PathBuf>;
887 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
891 /// Returns the sysroot for the `compiler` specified that *this build system
894 /// That is, the sysroot for the stage0 compiler is not what the compiler
895 /// thinks it is by default, but it's the same as the default for stages
897 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
898 let compiler = self.compiler;
899 let sysroot = if compiler.stage == 0 {
900 builder.out.join(&compiler.host.triple).join("stage0-sysroot")
902 builder.out.join(&compiler.host.triple).join(format!("stage{}", compiler.stage))
904 let _ = fs::remove_dir_all(&sysroot);
905 t!(fs::create_dir_all(&sysroot));
907 // Symlink the source root into the same location inside the sysroot,
908 // where `rust-src` component would go (`$sysroot/lib/rustlib/src/rust`),
909 // so that any tools relying on `rust-src` also work for local builds,
910 // and also for translating the virtual `/rustc/$hash` back to the real
911 // directory (for running tests with `rust.remap-debuginfo = true`).
912 let sysroot_lib_rustlib_src = sysroot.join("lib/rustlib/src");
913 t!(fs::create_dir_all(&sysroot_lib_rustlib_src));
914 let sysroot_lib_rustlib_src_rust = sysroot_lib_rustlib_src.join("rust");
915 if let Err(e) = symlink_dir(&builder.config, &builder.src, &sysroot_lib_rustlib_src_rust) {
917 "warning: creating symbolic link `{}` to `{}` failed with {}",
918 sysroot_lib_rustlib_src_rust.display(),
919 builder.src.display(),
922 if builder.config.rust_remap_debuginfo {
924 "warning: some `src/test/ui` tests will fail when lacking `{}`",
925 sysroot_lib_rustlib_src_rust.display(),
930 INTERNER.intern_path(sysroot)
934 #[derive(Debug, Copy, PartialOrd, Ord, Clone, PartialEq, Eq, Hash)]
935 pub struct Assemble {
936 /// The compiler which we will produce in this step. Assemble itself will
937 /// take care of ensuring that the necessary prerequisites to do so exist,
938 /// that is, this target can be a stage2 compiler and Assemble will build
939 /// previous stages for you.
940 pub target_compiler: Compiler,
943 impl Step for Assemble {
944 type Output = Compiler;
946 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
950 /// Prepare a new compiler from the artifacts in `stage`
952 /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
953 /// must have been previously produced by the `stage - 1` builder.build
955 fn run(self, builder: &Builder<'_>) -> Compiler {
956 let target_compiler = self.target_compiler;
958 if target_compiler.stage == 0 {
960 builder.config.build, target_compiler.host,
961 "Cannot obtain compiler for non-native build triple at stage 0"
963 // The stage 0 compiler for the build triple is always pre-built.
964 return target_compiler;
967 // Get the compiler that we'll use to bootstrap ourselves.
969 // Note that this is where the recursive nature of the bootstrap
970 // happens, as this will request the previous stage's compiler on
971 // downwards to stage 0.
973 // Also note that we're building a compiler for the host platform. We
974 // only assume that we can run `build` artifacts, which means that to
975 // produce some other architecture compiler we need to start from
976 // `build` to get there.
978 // FIXME: Perhaps we should download those libraries?
979 // It would make builds faster...
981 // FIXME: It may be faster if we build just a stage 1 compiler and then
982 // use that to bootstrap this compiler forward.
983 let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
985 // Build the libraries for this compiler to link to (i.e., the libraries
986 // it uses at runtime). NOTE: Crates the target compiler compiles don't
987 // link to these. (FIXME: Is that correct? It seems to be correct most
988 // of the time but I think we do link to these for stage2/bin compilers
989 // when not performing a full bootstrap).
990 builder.ensure(Rustc { compiler: build_compiler, target: target_compiler.host });
992 for &backend in builder.config.rust_codegen_backends.iter() {
993 if backend == "llvm" {
994 continue; // Already built as part of rustc
997 builder.ensure(CodegenBackend {
998 compiler: build_compiler,
999 target: target_compiler.host,
1004 let lld_install = if builder.config.lld_enabled {
1005 Some(builder.ensure(native::Lld { target: target_compiler.host }))
1010 let stage = target_compiler.stage;
1011 let host = target_compiler.host;
1012 builder.info(&format!("Assembling stage{} compiler ({})", stage, host));
1014 // Link in all dylibs to the libdir
1015 let stamp = librustc_stamp(builder, build_compiler, target_compiler.host);
1016 let proc_macros = builder
1017 .read_stamp_file(&stamp)
1019 .filter_map(|(path, dependency_type)| {
1020 if dependency_type == DependencyType::Host {
1021 Some(path.file_name().unwrap().to_owned().into_string().unwrap())
1026 .collect::<HashSet<_>>();
1028 let sysroot = builder.sysroot(target_compiler);
1029 let rustc_libdir = builder.rustc_libdir(target_compiler);
1030 t!(fs::create_dir_all(&rustc_libdir));
1031 let src_libdir = builder.sysroot_libdir(build_compiler, host);
1032 for f in builder.read_dir(&src_libdir) {
1033 let filename = f.file_name().into_string().unwrap();
1034 if is_dylib(&filename) && !proc_macros.contains(&filename) {
1035 builder.copy(&f.path(), &rustc_libdir.join(&filename));
1039 copy_codegen_backends_to_sysroot(builder, build_compiler, target_compiler);
1041 // We prepend this bin directory to the user PATH when linking Rust binaries. To
1042 // avoid shadowing the system LLD we rename the LLD we provide to `rust-lld`.
1043 let libdir = builder.sysroot_libdir(target_compiler, target_compiler.host);
1044 let libdir_bin = libdir.parent().unwrap().join("bin");
1045 t!(fs::create_dir_all(&libdir_bin));
1047 if let Some(lld_install) = lld_install {
1048 let src_exe = exe("lld", target_compiler.host);
1049 let dst_exe = exe("rust-lld", target_compiler.host);
1050 builder.copy(&lld_install.join("bin").join(&src_exe), &libdir_bin.join(&dst_exe));
1053 // Similarly, copy `llvm-dwp` into libdir for Split DWARF.
1055 let src_exe = exe("llvm-dwp", target_compiler.host);
1056 let dst_exe = exe("rust-llvm-dwp", target_compiler.host);
1057 let llvm_config_bin = builder.ensure(native::Llvm { target: target_compiler.host });
1058 let llvm_bin_dir = llvm_config_bin.parent().unwrap();
1059 builder.copy(&llvm_bin_dir.join(&src_exe), &libdir_bin.join(&dst_exe));
1062 // Ensure that `libLLVM.so` ends up in the newly build compiler directory,
1063 // so that it can be found when the newly built `rustc` is run.
1064 dist::maybe_install_llvm_runtime(builder, target_compiler.host, &sysroot);
1065 dist::maybe_install_llvm_target(builder, target_compiler.host, &sysroot);
1067 // Link the compiler binary itself into place
1068 let out_dir = builder.cargo_out(build_compiler, Mode::Rustc, host);
1069 let rustc = out_dir.join(exe("rustc-main", host));
1070 let bindir = sysroot.join("bin");
1071 t!(fs::create_dir_all(&bindir));
1072 let compiler = builder.rustc(target_compiler);
1073 builder.copy(&rustc, &compiler);
1079 /// Link some files into a rustc sysroot.
1081 /// For a particular stage this will link the file listed in `stamp` into the
1082 /// `sysroot_dst` provided.
1083 pub fn add_to_sysroot(
1084 builder: &Builder<'_>,
1086 sysroot_host_dst: &Path,
1089 let self_contained_dst = &sysroot_dst.join("self-contained");
1090 t!(fs::create_dir_all(&sysroot_dst));
1091 t!(fs::create_dir_all(&sysroot_host_dst));
1092 t!(fs::create_dir_all(&self_contained_dst));
1093 for (path, dependency_type) in builder.read_stamp_file(stamp) {
1094 let dst = match dependency_type {
1095 DependencyType::Host => sysroot_host_dst,
1096 DependencyType::Target => sysroot_dst,
1097 DependencyType::TargetSelfContained => self_contained_dst,
1099 builder.copy(&path, &dst.join(path.file_name().unwrap()));
1104 builder: &Builder<'_>,
1106 tail_args: Vec<String>,
1108 additional_target_deps: Vec<(PathBuf, DependencyType)>,
1111 if builder.config.dry_run {
1115 // `target_root_dir` looks like $dir/$target/release
1116 let target_root_dir = stamp.parent().unwrap();
1117 // `target_deps_dir` looks like $dir/$target/release/deps
1118 let target_deps_dir = target_root_dir.join("deps");
1119 // `host_root_dir` looks like $dir/release
1120 let host_root_dir = target_root_dir
1122 .unwrap() // chop off `release`
1124 .unwrap() // chop off `$target`
1125 .join(target_root_dir.file_name().unwrap());
1127 // Spawn Cargo slurping up its JSON output. We'll start building up the
1128 // `deps` array of all files it generated along with a `toplevel` array of
1129 // files we need to probe for later.
1130 let mut deps = Vec::new();
1131 let mut toplevel = Vec::new();
1132 let ok = stream_cargo(builder, cargo, tail_args, &mut |msg| {
1133 let (filenames, crate_types) = match msg {
1134 CargoMessage::CompilerArtifact {
1136 target: CargoTarget { crate_types },
1138 } => (filenames, crate_types),
1141 for filename in filenames {
1142 // Skip files like executables
1143 if !(filename.ends_with(".rlib")
1144 || filename.ends_with(".lib")
1145 || filename.ends_with(".a")
1146 || is_dylib(&filename)
1147 || (is_check && filename.ends_with(".rmeta")))
1152 let filename = Path::new(&*filename);
1154 // If this was an output file in the "host dir" we don't actually
1155 // worry about it, it's not relevant for us
1156 if filename.starts_with(&host_root_dir) {
1157 // Unless it's a proc macro used in the compiler
1158 if crate_types.iter().any(|t| t == "proc-macro") {
1159 deps.push((filename.to_path_buf(), DependencyType::Host));
1164 // If this was output in the `deps` dir then this is a precise file
1165 // name (hash included) so we start tracking it.
1166 if filename.starts_with(&target_deps_dir) {
1167 deps.push((filename.to_path_buf(), DependencyType::Target));
1171 // Otherwise this was a "top level artifact" which right now doesn't
1172 // have a hash in the name, but there's a version of this file in
1173 // the `deps` folder which *does* have a hash in the name. That's
1174 // the one we'll want to we'll probe for it later.
1176 // We do not use `Path::file_stem` or `Path::extension` here,
1177 // because some generated files may have multiple extensions e.g.
1178 // `std-<hash>.dll.lib` on Windows. The aforementioned methods only
1179 // split the file name by the last extension (`.lib`) while we need
1180 // to split by all extensions (`.dll.lib`).
1181 let expected_len = t!(filename.metadata()).len();
1182 let filename = filename.file_name().unwrap().to_str().unwrap();
1183 let mut parts = filename.splitn(2, '.');
1184 let file_stem = parts.next().unwrap().to_owned();
1185 let extension = parts.next().unwrap().to_owned();
1187 toplevel.push((file_stem, extension, expected_len));
1195 // Ok now we need to actually find all the files listed in `toplevel`. We've
1196 // got a list of prefix/extensions and we basically just need to find the
1197 // most recent file in the `deps` folder corresponding to each one.
1198 let contents = t!(target_deps_dir.read_dir())
1200 .map(|e| (e.path(), e.file_name().into_string().unwrap(), t!(e.metadata())))
1201 .collect::<Vec<_>>();
1202 for (prefix, extension, expected_len) in toplevel {
1203 let candidates = contents.iter().filter(|&&(_, ref filename, ref meta)| {
1204 meta.len() == expected_len
1206 .strip_prefix(&prefix[..])
1207 .map(|s| s.starts_with('-') && s.ends_with(&extension[..]))
1210 let max = candidates
1211 .max_by_key(|&&(_, _, ref metadata)| FileTime::from_last_modification_time(metadata));
1212 let path_to_add = match max {
1213 Some(triple) => triple.0.to_str().unwrap(),
1214 None => panic!("no output generated for {:?} {:?}", prefix, extension),
1216 if is_dylib(path_to_add) {
1217 let candidate = format!("{}.lib", path_to_add);
1218 let candidate = PathBuf::from(candidate);
1219 if candidate.exists() {
1220 deps.push((candidate, DependencyType::Target));
1223 deps.push((path_to_add.into(), DependencyType::Target));
1226 deps.extend(additional_target_deps);
1228 let mut new_contents = Vec::new();
1229 for (dep, dependency_type) in deps.iter() {
1230 new_contents.extend(match *dependency_type {
1231 DependencyType::Host => b"h",
1232 DependencyType::Target => b"t",
1233 DependencyType::TargetSelfContained => b"s",
1235 new_contents.extend(dep.to_str().unwrap().as_bytes());
1236 new_contents.extend(b"\0");
1238 t!(fs::write(&stamp, &new_contents));
1239 deps.into_iter().map(|(d, _)| d).collect()
1242 pub fn stream_cargo(
1243 builder: &Builder<'_>,
1245 tail_args: Vec<String>,
1246 cb: &mut dyn FnMut(CargoMessage<'_>),
1248 let mut cargo = Command::from(cargo);
1249 if builder.config.dry_run {
1252 // Instruct Cargo to give us json messages on stdout, critically leaving
1253 // stderr as piped so we can get those pretty colors.
1254 let mut message_format = if builder.config.json_output {
1255 String::from("json")
1257 String::from("json-render-diagnostics")
1259 if let Some(s) = &builder.config.rustc_error_format {
1260 message_format.push_str(",json-diagnostic-");
1261 message_format.push_str(s);
1263 cargo.arg("--message-format").arg(message_format).stdout(Stdio::piped());
1265 for arg in tail_args {
1269 builder.verbose(&format!("running: {:?}", cargo));
1270 let mut child = match cargo.spawn() {
1272 Err(e) => panic!("failed to execute command: {:?}\nerror: {}", cargo, e),
1275 // Spawn Cargo slurping up its JSON output. We'll start building up the
1276 // `deps` array of all files it generated along with a `toplevel` array of
1277 // files we need to probe for later.
1278 let stdout = BufReader::new(child.stdout.take().unwrap());
1279 for line in stdout.lines() {
1280 let line = t!(line);
1281 match serde_json::from_str::<CargoMessage<'_>>(&line) {
1283 if builder.config.json_output {
1284 // Forward JSON to stdout.
1285 println!("{}", line);
1289 // If this was informational, just print it out and continue
1290 Err(_) => println!("{}", line),
1294 // Make sure Cargo actually succeeded after we read all of its stdout.
1295 let status = t!(child.wait());
1296 if !status.success() {
1298 "command did not execute successfully: {:?}\n\
1299 expected success, got: {}",
1306 #[derive(Deserialize)]
1307 pub struct CargoTarget<'a> {
1308 crate_types: Vec<Cow<'a, str>>,
1311 #[derive(Deserialize)]
1312 #[serde(tag = "reason", rename_all = "kebab-case")]
1313 pub enum CargoMessage<'a> {
1315 package_id: Cow<'a, str>,
1316 features: Vec<Cow<'a, str>>,
1317 filenames: Vec<Cow<'a, str>>,
1318 target: CargoTarget<'a>,
1320 BuildScriptExecuted {
1321 package_id: Cow<'a, str>,