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::{Command, Stdio};
19 use serde::Deserialize;
21 use crate::builder::crate_description;
22 use crate::builder::Cargo;
23 use crate::builder::{Builder, Kind, RunConfig, ShouldRun, Step};
24 use crate::cache::{Interned, INTERNER};
25 use crate::config::{LlvmLibunwind, RustcLto, TargetSelection};
28 use crate::tool::SourceType;
29 use crate::util::get_clang_cl_resource_dir;
30 use crate::util::{exe, is_debug_info, is_dylib, output, symlink_dir, t, up_to_date};
31 use crate::LLVM_TOOLS;
32 use crate::{CLang, Compiler, DependencyType, GitRepo, Mode};
34 #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
36 pub target: TargetSelection,
37 pub compiler: Compiler,
38 /// Whether to build only a subset of crates in the standard library.
40 /// This shouldn't be used from other steps; see the comment on [`Rustc`].
41 crates: Interned<Vec<String>>,
45 pub fn new(compiler: Compiler, target: TargetSelection) -> Self {
46 Self { target, compiler, crates: Default::default() }
52 const DEFAULT: bool = true;
54 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
55 // When downloading stage1, the standard library has already been copied to the sysroot, so
56 // there's no need to rebuild it.
57 let builder = run.builder;
58 run.crate_or_deps("test")
60 .lazy_default_condition(Box::new(|| !builder.download_rustc()))
63 fn make_run(run: RunConfig<'_>) {
64 // Normally, people will pass *just* library if they pass it.
65 // But it's possible (although strange) to pass something like `library std core`.
66 // Build all crates anyway, as if they hadn't passed the other args.
68 run.paths.iter().any(|set| set.assert_single_path().path.ends_with("library"));
69 let crates = if has_library { Default::default() } else { run.cargo_crates_in_set() };
70 run.builder.ensure(Std {
71 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
77 /// Builds the standard library.
79 /// This will build the standard library for a particular stage of the build
80 /// using the `compiler` targeting the `target` architecture. The artifacts
81 /// created will also be linked into the sysroot directory.
82 fn run(self, builder: &Builder<'_>) {
83 let target = self.target;
84 let compiler = self.compiler;
86 // These artifacts were already copied (in `impl Step for Sysroot`).
87 // Don't recompile them.
88 // NOTE: the ABI of the beta compiler is different from the ABI of the downloaded compiler,
89 // so its artifacts can't be reused.
90 if builder.download_rustc() && compiler.stage != 0 {
94 if builder.config.keep_stage.contains(&compiler.stage)
95 || builder.config.keep_stage_std.contains(&compiler.stage)
97 builder.info("Warning: Using a potentially old libstd. This may not behave well.");
98 builder.ensure(StdLink::from_std(self, compiler));
102 builder.update_submodule(&Path::new("library").join("stdarch"));
104 // Profiler information requires LLVM's compiler-rt
105 if builder.config.profiler {
106 builder.update_submodule(&Path::new("src/llvm-project"));
109 let mut target_deps = builder.ensure(StartupObjects { compiler, target });
111 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
112 if compiler_to_use != compiler {
113 builder.ensure(Std::new(compiler_to_use, target));
114 builder.info(&format!(
115 "Uplifting stage1 library ({} -> {})",
116 compiler_to_use.host, target
119 // Even if we're not building std this stage, the new sysroot must
120 // still contain the third party objects needed by various targets.
121 copy_third_party_objects(builder, &compiler, target);
122 copy_self_contained_objects(builder, &compiler, target);
124 builder.ensure(StdLink::from_std(self, compiler_to_use));
128 target_deps.extend(copy_third_party_objects(builder, &compiler, target));
129 target_deps.extend(copy_self_contained_objects(builder, &compiler, target));
131 let mut cargo = builder.cargo(compiler, Mode::Std, SourceType::InTree, target, "build");
132 std_cargo(builder, target, compiler.stage, &mut cargo);
133 for krate in &*self.crates {
134 cargo.arg("-p").arg(krate);
137 builder.info(&format!(
138 "Building{} stage{} library artifacts ({} -> {})",
139 crate_description(&self.crates),
144 run_cargo(builder, cargo, &libstd_stamp(builder, compiler, target), target_deps, false);
146 builder.ensure(StdLink::from_std(
148 builder.compiler(compiler.stage, builder.config.build),
154 builder: &Builder<'_>,
158 target_deps: &mut Vec<(PathBuf, DependencyType)>,
159 dependency_type: DependencyType,
161 let target = libdir.join(name);
162 builder.copy(&sourcedir.join(name), &target);
164 target_deps.push((target, dependency_type));
167 fn copy_llvm_libunwind(builder: &Builder<'_>, target: TargetSelection, libdir: &Path) -> PathBuf {
168 let libunwind_path = builder.ensure(native::Libunwind { target });
169 let libunwind_source = libunwind_path.join("libunwind.a");
170 let libunwind_target = libdir.join("libunwind.a");
171 builder.copy(&libunwind_source, &libunwind_target);
175 /// Copies third party objects needed by various targets.
176 fn copy_third_party_objects(
177 builder: &Builder<'_>,
179 target: TargetSelection,
180 ) -> Vec<(PathBuf, DependencyType)> {
181 let mut target_deps = vec![];
183 // FIXME: remove this in 2021
184 if target == "x86_64-fortanix-unknown-sgx" {
185 if env::var_os("X86_FORTANIX_SGX_LIBS").is_some() {
186 builder.info("Warning: X86_FORTANIX_SGX_LIBS environment variable is ignored, libunwind is now compiled as part of rustbuild");
190 if builder.config.sanitizers_enabled(target) && compiler.stage != 0 {
191 // The sanitizers are only copied in stage1 or above,
192 // to avoid creating dependency on LLVM.
194 copy_sanitizers(builder, &compiler, target)
196 .map(|d| (d, DependencyType::Target)),
200 if target == "x86_64-fortanix-unknown-sgx"
201 || builder.config.llvm_libunwind(target) == LlvmLibunwind::InTree
202 && (target.contains("linux") || target.contains("fuchsia"))
205 copy_llvm_libunwind(builder, target, &builder.sysroot_libdir(*compiler, target));
206 target_deps.push((libunwind_path, DependencyType::Target));
212 /// Copies third party objects needed by various targets for self-contained linkage.
213 fn copy_self_contained_objects(
214 builder: &Builder<'_>,
216 target: TargetSelection,
217 ) -> Vec<(PathBuf, DependencyType)> {
218 let libdir_self_contained = builder.sysroot_libdir(*compiler, target).join("self-contained");
219 t!(fs::create_dir_all(&libdir_self_contained));
220 let mut target_deps = vec![];
222 // Copies the libc and CRT objects.
224 // rustc historically provides a more self-contained installation for musl targets
225 // not requiring the presence of a native musl toolchain. For example, it can fall back
226 // to using gcc from a glibc-targeting toolchain for linking.
227 // To do that we have to distribute musl startup objects as a part of Rust toolchain
228 // and link with them manually in the self-contained mode.
229 if target.contains("musl") {
230 let srcdir = builder.musl_libdir(target).unwrap_or_else(|| {
231 panic!("Target {:?} does not have a \"musl-libdir\" key", target.triple)
233 for &obj in &["libc.a", "crt1.o", "Scrt1.o", "rcrt1.o", "crti.o", "crtn.o"] {
236 &libdir_self_contained,
240 DependencyType::TargetSelfContained,
243 let crt_path = builder.ensure(native::CrtBeginEnd { target });
244 for &obj in &["crtbegin.o", "crtbeginS.o", "crtend.o", "crtendS.o"] {
245 let src = crt_path.join(obj);
246 let target = libdir_self_contained.join(obj);
247 builder.copy(&src, &target);
248 target_deps.push((target, DependencyType::TargetSelfContained));
251 if !target.starts_with("s390x") {
252 let libunwind_path = copy_llvm_libunwind(builder, target, &libdir_self_contained);
253 target_deps.push((libunwind_path, DependencyType::TargetSelfContained));
255 } else if target.ends_with("-wasi") {
259 panic!("Target {:?} does not have a \"wasi-root\" key", target.triple)
261 .join("lib/wasm32-wasi");
262 for &obj in &["libc.a", "crt1-command.o", "crt1-reactor.o"] {
265 &libdir_self_contained,
269 DependencyType::TargetSelfContained,
272 } else if target.ends_with("windows-gnu") {
273 for obj in ["crt2.o", "dllcrt2.o"].iter() {
274 let src = compiler_file(builder, builder.cc(target), target, CLang::C, obj);
275 let target = libdir_self_contained.join(obj);
276 builder.copy(&src, &target);
277 target_deps.push((target, DependencyType::TargetSelfContained));
284 /// Configure cargo to compile the standard library, adding appropriate env vars
286 pub fn std_cargo(builder: &Builder<'_>, target: TargetSelection, stage: u32, cargo: &mut Cargo) {
287 if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
288 cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
291 // Determine if we're going to compile in optimized C intrinsics to
292 // the `compiler-builtins` crate. These intrinsics live in LLVM's
293 // `compiler-rt` repository, but our `src/llvm-project` submodule isn't
294 // always checked out, so we need to conditionally look for this. (e.g. if
295 // an external LLVM is used we skip the LLVM submodule checkout).
297 // Note that this shouldn't affect the correctness of `compiler-builtins`,
298 // but only its speed. Some intrinsics in C haven't been translated to Rust
299 // yet but that's pretty rare. Other intrinsics have optimized
300 // implementations in C which have only had slower versions ported to Rust,
301 // so we favor the C version where we can, but it's not critical.
303 // If `compiler-rt` is available ensure that the `c` feature of the
304 // `compiler-builtins` crate is enabled and it's configured to learn where
305 // `compiler-rt` is located.
306 let compiler_builtins_root = builder.src.join("src/llvm-project/compiler-rt");
307 let compiler_builtins_c_feature = if compiler_builtins_root.exists() {
308 // Note that `libprofiler_builtins/build.rs` also computes this so if
309 // you're changing something here please also change that.
310 cargo.env("RUST_COMPILER_RT_ROOT", &compiler_builtins_root);
311 " compiler-builtins-c"
316 let mut features = String::new();
318 // Cranelift doesn't support `asm`.
319 if stage != 0 && builder.config.default_codegen_backend().unwrap_or_default() == "cranelift" {
320 features += " compiler-builtins-no-asm";
323 if builder.no_std(target) == Some(true) {
324 features += " compiler-builtins-mem";
325 if !target.starts_with("bpf") {
326 features.push_str(compiler_builtins_c_feature);
329 // for no-std targets we only compile a few no_std crates
331 .args(&["-p", "alloc"])
332 .arg("--manifest-path")
333 .arg(builder.src.join("library/alloc/Cargo.toml"))
337 features += &builder.std_features(target);
338 features.push_str(compiler_builtins_c_feature);
343 .arg("--manifest-path")
344 .arg(builder.src.join("library/test/Cargo.toml"));
346 // Help the libc crate compile by assisting it in finding various
347 // sysroot native libraries.
348 if target.contains("musl") {
349 if let Some(p) = builder.musl_libdir(target) {
350 let root = format!("native={}", p.to_str().unwrap());
351 cargo.rustflag("-L").rustflag(&root);
355 if target.ends_with("-wasi") {
356 if let Some(p) = builder.wasi_root(target) {
357 let root = format!("native={}/lib/wasm32-wasi", p.to_str().unwrap());
358 cargo.rustflag("-L").rustflag(&root);
363 // By default, rustc uses `-Cembed-bitcode=yes`, and Cargo overrides that
364 // with `-Cembed-bitcode=no` for non-LTO builds. However, libstd must be
365 // built with bitcode so that the produced rlibs can be used for both LTO
366 // builds (which use bitcode) and non-LTO builds (which use object code).
367 // So we override the override here!
369 // But we don't bother for the stage 0 compiler because it's never used
372 cargo.rustflag("-Cembed-bitcode=yes");
375 // By default, rustc does not include unwind tables unless they are required
376 // for a particular target. They are not required by RISC-V targets, but
377 // compiling the standard library with them means that users can get
378 // backtraces without having to recompile the standard library themselves.
380 // This choice was discussed in https://github.com/rust-lang/rust/pull/69890
381 if target.contains("riscv") {
382 cargo.rustflag("-Cforce-unwind-tables=yes");
386 format!("-Zcrate-attr=doc(html_root_url=\"{}/\")", builder.doc_rust_lang_org_channel(),);
387 cargo.rustflag(&html_root);
388 cargo.rustdocflag(&html_root);
391 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
393 pub compiler: Compiler,
394 pub target_compiler: Compiler,
395 pub target: TargetSelection,
396 /// Not actually used; only present to make sure the cache invalidation is correct.
397 crates: Interned<Vec<String>>,
401 fn from_std(std: Std, host_compiler: Compiler) -> Self {
403 compiler: host_compiler,
404 target_compiler: std.compiler,
411 impl Step for StdLink {
414 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
418 /// Link all libstd rlibs/dylibs into the sysroot location.
420 /// Links those artifacts generated by `compiler` to the `stage` compiler's
421 /// sysroot for the specified `host` and `target`.
423 /// Note that this assumes that `compiler` has already generated the libstd
424 /// libraries for `target`, and this method will find them in the relevant
425 /// output directory.
426 fn run(self, builder: &Builder<'_>) {
427 let compiler = self.compiler;
428 let target_compiler = self.target_compiler;
429 let target = self.target;
430 builder.info(&format!(
431 "Copying stage{} library from stage{} ({} -> {} / {})",
432 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
434 let libdir = builder.sysroot_libdir(target_compiler, target);
435 let hostdir = builder.sysroot_libdir(target_compiler, compiler.host);
436 add_to_sysroot(builder, &libdir, &hostdir, &libstd_stamp(builder, compiler, target));
440 /// Copies sanitizer runtime libraries into target libdir.
442 builder: &Builder<'_>,
444 target: TargetSelection,
446 let runtimes: Vec<native::SanitizerRuntime> = builder.ensure(native::Sanitizers { target });
448 if builder.config.dry_run() {
452 let mut target_deps = Vec::new();
453 let libdir = builder.sysroot_libdir(*compiler, target);
455 for runtime in &runtimes {
456 let dst = libdir.join(&runtime.name);
457 builder.copy(&runtime.path, &dst);
459 if target == "x86_64-apple-darwin" || target == "aarch64-apple-darwin" {
460 // Update the library’s install name to reflect that it has been renamed.
461 apple_darwin_update_library_name(&dst, &format!("@rpath/{}", &runtime.name));
462 // Upon renaming the install name, the code signature of the file will invalidate,
463 // so we will sign it again.
464 apple_darwin_sign_file(&dst);
467 target_deps.push(dst);
473 fn apple_darwin_update_library_name(library_path: &Path, new_name: &str) {
474 let status = Command::new("install_name_tool")
479 .expect("failed to execute `install_name_tool`");
480 assert!(status.success());
483 fn apple_darwin_sign_file(file_path: &Path) {
484 let status = Command::new("codesign")
485 .arg("-f") // Force to rewrite the existing signature
490 .expect("failed to execute `codesign`");
491 assert!(status.success());
494 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
495 pub struct StartupObjects {
496 pub compiler: Compiler,
497 pub target: TargetSelection,
500 impl Step for StartupObjects {
501 type Output = Vec<(PathBuf, DependencyType)>;
503 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
504 run.path("library/rtstartup")
507 fn make_run(run: RunConfig<'_>) {
508 run.builder.ensure(StartupObjects {
509 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
514 /// Builds and prepare startup objects like rsbegin.o and rsend.o
516 /// These are primarily used on Windows right now for linking executables/dlls.
517 /// They don't require any library support as they're just plain old object
518 /// files, so we just use the nightly snapshot compiler to always build them (as
519 /// no other compilers are guaranteed to be available).
520 fn run(self, builder: &Builder<'_>) -> Vec<(PathBuf, DependencyType)> {
521 let for_compiler = self.compiler;
522 let target = self.target;
523 if !target.ends_with("windows-gnu") {
527 let mut target_deps = vec![];
529 let src_dir = &builder.src.join("library").join("rtstartup");
530 let dst_dir = &builder.native_dir(target).join("rtstartup");
531 let sysroot_dir = &builder.sysroot_libdir(for_compiler, target);
532 t!(fs::create_dir_all(dst_dir));
534 for file in &["rsbegin", "rsend"] {
535 let src_file = &src_dir.join(file.to_string() + ".rs");
536 let dst_file = &dst_dir.join(file.to_string() + ".o");
537 if !up_to_date(src_file, dst_file) {
538 let mut cmd = Command::new(&builder.initial_rustc);
539 cmd.env("RUSTC_BOOTSTRAP", "1");
540 if !builder.local_rebuild {
541 // a local_rebuild compiler already has stage1 features
542 cmd.arg("--cfg").arg("bootstrap");
546 .arg(target.rustc_target_arg())
554 let target = sysroot_dir.join((*file).to_string() + ".o");
555 builder.copy(dst_file, &target);
556 target_deps.push((target, DependencyType::Target));
563 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
565 pub target: TargetSelection,
566 pub compiler: Compiler,
567 /// Whether to build a subset of crates, rather than the whole compiler.
569 /// This should only be requested by the user, not used within rustbuild itself.
570 /// Using it within rustbuild can lead to confusing situation where lints are replayed
571 /// in two different steps.
572 crates: Interned<Vec<String>>,
576 pub fn new(compiler: Compiler, target: TargetSelection) -> Self {
577 Self { target, compiler, crates: Default::default() }
581 impl Step for Rustc {
583 const ONLY_HOSTS: bool = true;
584 const DEFAULT: bool = false;
586 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
587 let mut crates = run.builder.in_tree_crates("rustc-main", None);
588 for (i, krate) in crates.iter().enumerate() {
589 if krate.name == "rustc-main" {
590 crates.swap_remove(i);
597 fn make_run(run: RunConfig<'_>) {
598 let crates = run.cargo_crates_in_set();
599 run.builder.ensure(Rustc {
600 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
606 /// Builds the compiler.
608 /// This will build the compiler for a particular stage of the build using
609 /// the `compiler` targeting the `target` architecture. The artifacts
610 /// created will also be linked into the sysroot directory.
611 fn run(self, builder: &Builder<'_>) {
612 let compiler = self.compiler;
613 let target = self.target;
615 // NOTE: the ABI of the beta compiler is different from the ABI of the downloaded compiler,
616 // so its artifacts can't be reused.
617 if builder.download_rustc() && compiler.stage != 0 {
618 // Copy the existing artifacts instead of rebuilding them.
619 // NOTE: this path is only taken for tools linking to rustc-dev.
620 builder.ensure(Sysroot { compiler });
624 builder.ensure(Std::new(compiler, target));
626 if builder.config.keep_stage.contains(&compiler.stage) {
627 builder.info("Warning: Using a potentially old librustc. This may not behave well.");
628 builder.info("Warning: Use `--keep-stage-std` if you want to rebuild the compiler when it changes");
629 builder.ensure(RustcLink::from_rustc(self, compiler));
633 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
634 if compiler_to_use != compiler {
635 builder.ensure(Rustc::new(compiler_to_use, target));
637 .info(&format!("Uplifting stage1 rustc ({} -> {})", builder.config.build, target));
638 builder.ensure(RustcLink::from_rustc(self, compiler_to_use));
642 // Ensure that build scripts and proc macros have a std / libproc_macro to link against.
643 builder.ensure(Std::new(
644 builder.compiler(self.compiler.stage, builder.config.build),
645 builder.config.build,
648 let mut cargo = builder.cargo(compiler, Mode::Rustc, SourceType::InTree, target, "build");
649 rustc_cargo(builder, &mut cargo, target);
651 if builder.config.rust_profile_use.is_some()
652 && builder.config.rust_profile_generate.is_some()
654 panic!("Cannot use and generate PGO profiles at the same time");
657 // With LLD, we can use ICF (identical code folding) to reduce the executable size
658 // of librustc_driver/rustc and to improve i-cache utilization.
660 // -Wl,[link options] doesn't work on MSVC. However, /OPT:ICF (technically /OPT:REF,ICF)
661 // is already on by default in MSVC optimized builds, which is interpreted as --icf=all:
662 // https://github.com/llvm/llvm-project/blob/3329cec2f79185bafd678f310fafadba2a8c76d2/lld/COFF/Driver.cpp#L1746
663 // https://github.com/rust-lang/rust/blob/f22819bcce4abaff7d1246a56eec493418f9f4ee/compiler/rustc_codegen_ssa/src/back/linker.rs#L827
664 if builder.config.use_lld && !compiler.host.contains("msvc") {
665 cargo.rustflag("-Clink-args=-Wl,--icf=all");
668 let is_collecting = if let Some(path) = &builder.config.rust_profile_generate {
669 if compiler.stage == 1 {
670 cargo.rustflag(&format!("-Cprofile-generate={}", path));
671 // Apparently necessary to avoid overflowing the counters during
672 // a Cargo build profile
673 cargo.rustflag("-Cllvm-args=-vp-counters-per-site=4");
678 } else if let Some(path) = &builder.config.rust_profile_use {
679 if compiler.stage == 1 {
680 cargo.rustflag(&format!("-Cprofile-use={}", path));
681 cargo.rustflag("-Cllvm-args=-pgo-warn-missing-function");
690 // Ensure paths to Rust sources are relative, not absolute.
691 cargo.rustflag(&format!(
692 "-Cllvm-args=-static-func-strip-dirname-prefix={}",
693 builder.config.src.components().count()
697 // We currently don't support cross-crate LTO in stage0. This also isn't hugely necessary
698 // and may just be a time sink.
699 if compiler.stage != 0 {
700 match builder.config.rust_lto {
701 RustcLto::Thin | RustcLto::Fat => {
702 // Since using LTO for optimizing dylibs is currently experimental,
703 // we need to pass -Zdylib-lto.
704 cargo.rustflag("-Zdylib-lto");
705 // Cargo by default passes `-Cembed-bitcode=no` and doesn't pass `-Clto` when
706 // compiling dylibs (and their dependencies), even when LTO is enabled for the
707 // crate. Therefore, we need to override `-Clto` and `-Cembed-bitcode` here.
708 let lto_type = match builder.config.rust_lto {
709 RustcLto::Thin => "thin",
710 RustcLto::Fat => "fat",
713 cargo.rustflag(&format!("-Clto={}", lto_type));
714 cargo.rustflag("-Cembed-bitcode=yes");
716 RustcLto::ThinLocal => { /* Do nothing, this is the default */ }
720 for krate in &*self.crates {
721 cargo.arg("-p").arg(krate);
724 builder.info(&format!(
725 "Building{} stage{} compiler artifacts ({} -> {})",
726 crate_description(&self.crates),
731 run_cargo(builder, cargo, &librustc_stamp(builder, compiler, target), vec![], false);
733 builder.ensure(RustcLink::from_rustc(
735 builder.compiler(compiler.stage, builder.config.build),
740 pub fn rustc_cargo(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
743 .arg(builder.rustc_features(builder.kind))
744 .arg("--manifest-path")
745 .arg(builder.src.join("compiler/rustc/Cargo.toml"));
746 rustc_cargo_env(builder, cargo, target);
749 pub fn rustc_cargo_env(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
750 // Set some configuration variables picked up by build scripts and
751 // the compiler alike
753 .env("CFG_RELEASE", builder.rust_release())
754 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
755 .env("CFG_VERSION", builder.rust_version());
757 if let Some(backend) = builder.config.default_codegen_backend() {
758 cargo.env("CFG_DEFAULT_CODEGEN_BACKEND", backend);
761 let libdir_relative = builder.config.libdir_relative().unwrap_or_else(|| Path::new("lib"));
762 let target_config = builder.config.target_config.get(&target);
764 cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
766 if let Some(ref ver_date) = builder.rust_info().commit_date() {
767 cargo.env("CFG_VER_DATE", ver_date);
769 if let Some(ref ver_hash) = builder.rust_info().sha() {
770 cargo.env("CFG_VER_HASH", ver_hash);
772 if !builder.unstable_features() {
773 cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
776 // Prefer the current target's own default_linker, else a globally
778 if let Some(s) = target_config.and_then(|c| c.default_linker.as_ref()) {
779 cargo.env("CFG_DEFAULT_LINKER", s);
780 } else if let Some(ref s) = builder.config.rustc_default_linker {
781 cargo.env("CFG_DEFAULT_LINKER", s);
784 if builder.config.rustc_parallel {
785 // keep in sync with `bootstrap/lib.rs:Build::rustc_features`
786 // `cfg` option for rustc, `features` option for cargo, for conditional compilation
787 cargo.rustflag("--cfg=parallel_compiler");
788 cargo.rustdocflag("--cfg=parallel_compiler");
790 if builder.config.rust_verify_llvm_ir {
791 cargo.env("RUSTC_VERIFY_LLVM_IR", "1");
794 // Pass down configuration from the LLVM build into the build of
795 // rustc_llvm and rustc_codegen_llvm.
797 // Note that this is disabled if LLVM itself is disabled or we're in a check
798 // build. If we are in a check build we still go ahead here presuming we've
799 // detected that LLVM is already built and good to go which helps prevent
800 // busting caches (e.g. like #71152).
801 if builder.config.llvm_enabled()
802 && (builder.kind != Kind::Check
803 || crate::native::prebuilt_llvm_config(builder, target).is_ok())
805 if builder.is_rust_llvm(target) {
806 cargo.env("LLVM_RUSTLLVM", "1");
808 let native::LlvmResult { llvm_config, .. } = builder.ensure(native::Llvm { target });
809 cargo.env("LLVM_CONFIG", &llvm_config);
810 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
811 cargo.env("CFG_LLVM_ROOT", s);
814 // Some LLVM linker flags (-L and -l) may be needed to link `rustc_llvm`. Its build script
815 // expects these to be passed via the `LLVM_LINKER_FLAGS` env variable, separated by
819 // - on windows, when `clang-cl` is used with instrumentation, we need to manually add
820 // clang's runtime library resource directory so that the profiler runtime library can be
821 // found. This is to avoid the linker errors about undefined references to
822 // `__llvm_profile_instrument_memop` when linking `rustc_driver`.
823 let mut llvm_linker_flags = String::new();
824 if builder.config.llvm_profile_generate && target.contains("msvc") {
825 if let Some(ref clang_cl_path) = builder.config.llvm_clang_cl {
826 // Add clang's runtime library directory to the search path
827 let clang_rt_dir = get_clang_cl_resource_dir(clang_cl_path);
828 llvm_linker_flags.push_str(&format!("-L{}", clang_rt_dir.display()));
832 // The config can also specify its own llvm linker flags.
833 if let Some(ref s) = builder.config.llvm_ldflags {
834 if !llvm_linker_flags.is_empty() {
835 llvm_linker_flags.push_str(" ");
837 llvm_linker_flags.push_str(s);
840 // Set the linker flags via the env var that `rustc_llvm`'s build script will read.
841 if !llvm_linker_flags.is_empty() {
842 cargo.env("LLVM_LINKER_FLAGS", llvm_linker_flags);
845 // Building with a static libstdc++ is only supported on linux right now,
846 // not for MSVC or macOS
847 if builder.config.llvm_static_stdcpp
848 && !target.contains("freebsd")
849 && !target.contains("msvc")
850 && !target.contains("apple")
851 && !target.contains("solaris")
853 let file = compiler_file(
855 builder.cxx(target).unwrap(),
860 cargo.env("LLVM_STATIC_STDCPP", file);
862 if builder.llvm_link_shared() {
863 cargo.env("LLVM_LINK_SHARED", "1");
865 if builder.config.llvm_use_libcxx {
866 cargo.env("LLVM_USE_LIBCXX", "1");
868 if builder.config.llvm_optimize && !builder.config.llvm_release_debuginfo {
869 cargo.env("LLVM_NDEBUG", "1");
874 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
876 pub compiler: Compiler,
877 pub target_compiler: Compiler,
878 pub target: TargetSelection,
879 /// Not actually used; only present to make sure the cache invalidation is correct.
880 crates: Interned<Vec<String>>,
884 fn from_rustc(rustc: Rustc, host_compiler: Compiler) -> Self {
886 compiler: host_compiler,
887 target_compiler: rustc.compiler,
888 target: rustc.target,
889 crates: rustc.crates,
894 impl Step for RustcLink {
897 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
901 /// Same as `std_link`, only for librustc
902 fn run(self, builder: &Builder<'_>) {
903 let compiler = self.compiler;
904 let target_compiler = self.target_compiler;
905 let target = self.target;
906 builder.info(&format!(
907 "Copying stage{} rustc from stage{} ({} -> {} / {})",
908 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
912 &builder.sysroot_libdir(target_compiler, target),
913 &builder.sysroot_libdir(target_compiler, compiler.host),
914 &librustc_stamp(builder, compiler, target),
919 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
920 pub struct CodegenBackend {
921 pub target: TargetSelection,
922 pub compiler: Compiler,
923 pub backend: Interned<String>,
926 impl Step for CodegenBackend {
928 const ONLY_HOSTS: bool = true;
929 // Only the backends specified in the `codegen-backends` entry of `config.toml` are built.
930 const DEFAULT: bool = true;
932 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
933 run.paths(&["compiler/rustc_codegen_cranelift", "compiler/rustc_codegen_gcc"])
936 fn make_run(run: RunConfig<'_>) {
937 for &backend in &run.builder.config.rust_codegen_backends {
938 if backend == "llvm" {
939 continue; // Already built as part of rustc
942 run.builder.ensure(CodegenBackend {
944 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
950 fn run(self, builder: &Builder<'_>) {
951 let compiler = self.compiler;
952 let target = self.target;
953 let backend = self.backend;
955 builder.ensure(Rustc::new(compiler, target));
957 if builder.config.keep_stage.contains(&compiler.stage) {
959 "Warning: Using a potentially old codegen backend. \
960 This may not behave well.",
962 // Codegen backends are linked separately from this step today, so we don't do
967 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
968 if compiler_to_use != compiler {
969 builder.ensure(CodegenBackend { compiler: compiler_to_use, target, backend });
973 let out_dir = builder.cargo_out(compiler, Mode::Codegen, target);
975 let mut cargo = builder.cargo(compiler, Mode::Codegen, SourceType::InTree, target, "build");
977 .arg("--manifest-path")
978 .arg(builder.src.join(format!("compiler/rustc_codegen_{}/Cargo.toml", backend)));
979 rustc_cargo_env(builder, &mut cargo, target);
981 let tmp_stamp = out_dir.join(".tmp.stamp");
983 builder.info(&format!(
984 "Building stage{} codegen backend {} ({} -> {})",
985 compiler.stage, backend, &compiler.host, target
987 let files = run_cargo(builder, cargo, &tmp_stamp, vec![], false);
988 if builder.config.dry_run() {
991 let mut files = files.into_iter().filter(|f| {
992 let filename = f.file_name().unwrap().to_str().unwrap();
993 is_dylib(filename) && filename.contains("rustc_codegen_")
995 let codegen_backend = match files.next() {
997 None => panic!("no dylibs built for codegen backend?"),
999 if let Some(f) = files.next() {
1001 "codegen backend built two dylibs:\n{}\n{}",
1002 codegen_backend.display(),
1006 let stamp = codegen_backend_stamp(builder, compiler, target, backend);
1007 let codegen_backend = codegen_backend.to_str().unwrap();
1008 t!(fs::write(&stamp, &codegen_backend));
1012 /// Creates the `codegen-backends` folder for a compiler that's about to be
1013 /// assembled as a complete compiler.
1015 /// This will take the codegen artifacts produced by `compiler` and link them
1016 /// into an appropriate location for `target_compiler` to be a functional
1018 fn copy_codegen_backends_to_sysroot(
1019 builder: &Builder<'_>,
1021 target_compiler: Compiler,
1023 let target = target_compiler.host;
1025 // Note that this step is different than all the other `*Link` steps in
1026 // that it's not assembling a bunch of libraries but rather is primarily
1027 // moving the codegen backend into place. The codegen backend of rustc is
1028 // not linked into the main compiler by default but is rather dynamically
1029 // selected at runtime for inclusion.
1031 // Here we're looking for the output dylib of the `CodegenBackend` step and
1032 // we're copying that into the `codegen-backends` folder.
1033 let dst = builder.sysroot_codegen_backends(target_compiler);
1034 t!(fs::create_dir_all(&dst), dst);
1036 if builder.config.dry_run() {
1040 for backend in builder.config.rust_codegen_backends.iter() {
1041 if backend == "llvm" {
1042 continue; // Already built as part of rustc
1045 let stamp = codegen_backend_stamp(builder, compiler, target, *backend);
1046 let dylib = t!(fs::read_to_string(&stamp));
1047 let file = Path::new(&dylib);
1048 let filename = file.file_name().unwrap().to_str().unwrap();
1049 // change `librustc_codegen_cranelift-xxxxxx.so` to
1050 // `librustc_codegen_cranelift-release.so`
1051 let target_filename = {
1052 let dash = filename.find('-').unwrap();
1053 let dot = filename.find('.').unwrap();
1054 format!("{}-{}{}", &filename[..dash], builder.rust_release(), &filename[dot..])
1056 builder.copy(&file, &dst.join(target_filename));
1060 /// Cargo's output path for the standard library in a given stage, compiled
1061 /// by a particular compiler for the specified target.
1062 pub fn libstd_stamp(builder: &Builder<'_>, compiler: Compiler, target: TargetSelection) -> PathBuf {
1063 builder.cargo_out(compiler, Mode::Std, target).join(".libstd.stamp")
1066 /// Cargo's output path for librustc in a given stage, compiled by a particular
1067 /// compiler for the specified target.
1068 pub fn librustc_stamp(
1069 builder: &Builder<'_>,
1071 target: TargetSelection,
1073 builder.cargo_out(compiler, Mode::Rustc, target).join(".librustc.stamp")
1076 /// Cargo's output path for librustc_codegen_llvm in a given stage, compiled by a particular
1077 /// compiler for the specified target and backend.
1078 fn codegen_backend_stamp(
1079 builder: &Builder<'_>,
1081 target: TargetSelection,
1082 backend: Interned<String>,
1085 .cargo_out(compiler, Mode::Codegen, target)
1086 .join(format!(".librustc_codegen_{}.stamp", backend))
1089 pub fn compiler_file(
1090 builder: &Builder<'_>,
1092 target: TargetSelection,
1096 let mut cmd = Command::new(compiler);
1097 cmd.args(builder.cflags(target, GitRepo::Rustc, c));
1098 cmd.arg(format!("-print-file-name={}", file));
1099 let out = output(&mut cmd);
1100 PathBuf::from(out.trim())
1103 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1104 pub struct Sysroot {
1105 pub compiler: Compiler,
1108 impl Step for Sysroot {
1109 type Output = Interned<PathBuf>;
1111 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1115 /// Returns the sysroot for the `compiler` specified that *this build system
1118 /// That is, the sysroot for the stage0 compiler is not what the compiler
1119 /// thinks it is by default, but it's the same as the default for stages
1121 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
1122 let compiler = self.compiler;
1123 let host_dir = builder.out.join(&compiler.host.triple);
1125 let sysroot_dir = |stage| {
1127 host_dir.join("stage0-sysroot")
1128 } else if builder.download_rustc() && compiler.stage != builder.top_stage {
1129 host_dir.join("ci-rustc-sysroot")
1131 host_dir.join(format!("stage{}", stage))
1134 let sysroot = sysroot_dir(compiler.stage);
1136 let _ = fs::remove_dir_all(&sysroot);
1137 t!(fs::create_dir_all(&sysroot));
1139 // If we're downloading a compiler from CI, we can use the same compiler for all stages other than 0.
1140 if builder.download_rustc() && compiler.stage != 0 {
1142 builder.config.build, compiler.host,
1143 "Cross-compiling is not yet supported with `download-rustc`",
1146 // #102002, cleanup old toolchain folders when using download-rustc so people don't use them by accident.
1147 for stage in 0..=2 {
1148 if stage != compiler.stage {
1149 let dir = sysroot_dir(stage);
1150 if !dir.ends_with("ci-rustc-sysroot") {
1151 let _ = fs::remove_dir_all(dir);
1156 // Copy the compiler into the correct sysroot.
1158 builder.config.out.join(&*builder.config.build.triple).join("ci-rustc");
1159 builder.cp_r(&ci_rustc_dir, &sysroot);
1160 return INTERNER.intern_path(sysroot);
1163 // Symlink the source root into the same location inside the sysroot,
1164 // where `rust-src` component would go (`$sysroot/lib/rustlib/src/rust`),
1165 // so that any tools relying on `rust-src` also work for local builds,
1166 // and also for translating the virtual `/rustc/$hash` back to the real
1167 // directory (for running tests with `rust.remap-debuginfo = true`).
1168 let sysroot_lib_rustlib_src = sysroot.join("lib/rustlib/src");
1169 t!(fs::create_dir_all(&sysroot_lib_rustlib_src));
1170 let sysroot_lib_rustlib_src_rust = sysroot_lib_rustlib_src.join("rust");
1171 if let Err(e) = symlink_dir(&builder.config, &builder.src, &sysroot_lib_rustlib_src_rust) {
1173 "warning: creating symbolic link `{}` to `{}` failed with {}",
1174 sysroot_lib_rustlib_src_rust.display(),
1175 builder.src.display(),
1178 if builder.config.rust_remap_debuginfo {
1180 "warning: some `src/test/ui` tests will fail when lacking `{}`",
1181 sysroot_lib_rustlib_src_rust.display(),
1185 // Same for the rustc-src component.
1186 let sysroot_lib_rustlib_rustcsrc = sysroot.join("lib/rustlib/rustc-src");
1187 t!(fs::create_dir_all(&sysroot_lib_rustlib_rustcsrc));
1188 let sysroot_lib_rustlib_rustcsrc_rust = sysroot_lib_rustlib_rustcsrc.join("rust");
1190 symlink_dir(&builder.config, &builder.src, &sysroot_lib_rustlib_rustcsrc_rust)
1193 "warning: creating symbolic link `{}` to `{}` failed with {}",
1194 sysroot_lib_rustlib_rustcsrc_rust.display(),
1195 builder.src.display(),
1200 INTERNER.intern_path(sysroot)
1204 #[derive(Debug, Copy, PartialOrd, Ord, Clone, PartialEq, Eq, Hash)]
1205 pub struct Assemble {
1206 /// The compiler which we will produce in this step. Assemble itself will
1207 /// take care of ensuring that the necessary prerequisites to do so exist,
1208 /// that is, this target can be a stage2 compiler and Assemble will build
1209 /// previous stages for you.
1210 pub target_compiler: Compiler,
1213 impl Step for Assemble {
1214 type Output = Compiler;
1215 const ONLY_HOSTS: bool = true;
1217 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1218 run.path("compiler/rustc").path("compiler")
1221 fn make_run(run: RunConfig<'_>) {
1222 run.builder.ensure(Assemble {
1223 target_compiler: run.builder.compiler(run.builder.top_stage + 1, run.target),
1227 /// Prepare a new compiler from the artifacts in `stage`
1229 /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
1230 /// must have been previously produced by the `stage - 1` builder.build
1232 fn run(self, builder: &Builder<'_>) -> Compiler {
1233 let target_compiler = self.target_compiler;
1235 if target_compiler.stage == 0 {
1237 builder.config.build, target_compiler.host,
1238 "Cannot obtain compiler for non-native build triple at stage 0"
1240 // The stage 0 compiler for the build triple is always pre-built.
1241 return target_compiler;
1244 // Get the compiler that we'll use to bootstrap ourselves.
1246 // Note that this is where the recursive nature of the bootstrap
1247 // happens, as this will request the previous stage's compiler on
1248 // downwards to stage 0.
1250 // Also note that we're building a compiler for the host platform. We
1251 // only assume that we can run `build` artifacts, which means that to
1252 // produce some other architecture compiler we need to start from
1253 // `build` to get there.
1255 // FIXME: It may be faster if we build just a stage 1 compiler and then
1256 // use that to bootstrap this compiler forward.
1257 let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
1259 // If we're downloading a compiler from CI, we can use the same compiler for all stages other than 0.
1260 if builder.download_rustc() {
1261 builder.ensure(Sysroot { compiler: target_compiler });
1262 return target_compiler;
1265 // Build the libraries for this compiler to link to (i.e., the libraries
1266 // it uses at runtime). NOTE: Crates the target compiler compiles don't
1267 // link to these. (FIXME: Is that correct? It seems to be correct most
1268 // of the time but I think we do link to these for stage2/bin compilers
1269 // when not performing a full bootstrap).
1270 builder.ensure(Rustc::new(build_compiler, target_compiler.host));
1272 for &backend in builder.config.rust_codegen_backends.iter() {
1273 if backend == "llvm" {
1274 continue; // Already built as part of rustc
1277 builder.ensure(CodegenBackend {
1278 compiler: build_compiler,
1279 target: target_compiler.host,
1284 let lld_install = if builder.config.lld_enabled {
1285 Some(builder.ensure(native::Lld { target: target_compiler.host }))
1290 let stage = target_compiler.stage;
1291 let host = target_compiler.host;
1292 builder.info(&format!("Assembling stage{} compiler ({})", stage, host));
1294 // Link in all dylibs to the libdir
1295 let stamp = librustc_stamp(builder, build_compiler, target_compiler.host);
1296 let proc_macros = builder
1297 .read_stamp_file(&stamp)
1299 .filter_map(|(path, dependency_type)| {
1300 if dependency_type == DependencyType::Host {
1301 Some(path.file_name().unwrap().to_owned().into_string().unwrap())
1306 .collect::<HashSet<_>>();
1308 let sysroot = builder.sysroot(target_compiler);
1309 let rustc_libdir = builder.rustc_libdir(target_compiler);
1310 t!(fs::create_dir_all(&rustc_libdir));
1311 let src_libdir = builder.sysroot_libdir(build_compiler, host);
1312 for f in builder.read_dir(&src_libdir) {
1313 let filename = f.file_name().into_string().unwrap();
1314 if (is_dylib(&filename) || is_debug_info(&filename)) && !proc_macros.contains(&filename)
1316 builder.copy(&f.path(), &rustc_libdir.join(&filename));
1320 copy_codegen_backends_to_sysroot(builder, build_compiler, target_compiler);
1322 // We prepend this bin directory to the user PATH when linking Rust binaries. To
1323 // avoid shadowing the system LLD we rename the LLD we provide to `rust-lld`.
1324 let libdir = builder.sysroot_libdir(target_compiler, target_compiler.host);
1325 let libdir_bin = libdir.parent().unwrap().join("bin");
1326 t!(fs::create_dir_all(&libdir_bin));
1327 if let Some(lld_install) = lld_install {
1328 let src_exe = exe("lld", target_compiler.host);
1329 let dst_exe = exe("rust-lld", target_compiler.host);
1330 builder.copy(&lld_install.join("bin").join(&src_exe), &libdir_bin.join(&dst_exe));
1331 // for `-Z gcc-ld=lld`
1332 let gcc_ld_dir = libdir_bin.join("gcc-ld");
1333 t!(fs::create_dir(&gcc_ld_dir));
1334 let lld_wrapper_exe = builder.ensure(crate::tool::LldWrapper {
1335 compiler: build_compiler,
1336 target: target_compiler.host,
1338 for name in crate::LLD_FILE_NAMES {
1339 builder.copy(&lld_wrapper_exe, &gcc_ld_dir.join(exe(name, target_compiler.host)));
1343 if builder.config.rust_codegen_backends.contains(&INTERNER.intern_str("llvm")) {
1344 let native::LlvmResult { llvm_config, .. } =
1345 builder.ensure(native::Llvm { target: target_compiler.host });
1346 if !builder.config.dry_run() {
1347 let llvm_bin_dir = output(Command::new(llvm_config).arg("--bindir"));
1348 let llvm_bin_dir = Path::new(llvm_bin_dir.trim());
1350 // Since we've already built the LLVM tools, install them to the sysroot.
1351 // This is the equivalent of installing the `llvm-tools-preview` component via
1352 // rustup, and lets developers use a locally built toolchain to
1353 // build projects that expect llvm tools to be present in the sysroot
1354 // (e.g. the `bootimage` crate).
1355 for tool in LLVM_TOOLS {
1356 let tool_exe = exe(tool, target_compiler.host);
1357 let src_path = llvm_bin_dir.join(&tool_exe);
1358 // When using `download-ci-llvm`, some of the tools
1359 // may not exist, so skip trying to copy them.
1360 if src_path.exists() {
1361 builder.copy(&src_path, &libdir_bin.join(&tool_exe));
1367 // Ensure that `libLLVM.so` ends up in the newly build compiler directory,
1368 // so that it can be found when the newly built `rustc` is run.
1369 dist::maybe_install_llvm_runtime(builder, target_compiler.host, &sysroot);
1370 dist::maybe_install_llvm_target(builder, target_compiler.host, &sysroot);
1372 // Link the compiler binary itself into place
1373 let out_dir = builder.cargo_out(build_compiler, Mode::Rustc, host);
1374 let rustc = out_dir.join(exe("rustc-main", host));
1375 let bindir = sysroot.join("bin");
1376 t!(fs::create_dir_all(&bindir));
1377 let compiler = builder.rustc(target_compiler);
1378 builder.copy(&rustc, &compiler);
1384 /// Link some files into a rustc sysroot.
1386 /// For a particular stage this will link the file listed in `stamp` into the
1387 /// `sysroot_dst` provided.
1388 pub fn add_to_sysroot(
1389 builder: &Builder<'_>,
1391 sysroot_host_dst: &Path,
1394 let self_contained_dst = &sysroot_dst.join("self-contained");
1395 t!(fs::create_dir_all(&sysroot_dst));
1396 t!(fs::create_dir_all(&sysroot_host_dst));
1397 t!(fs::create_dir_all(&self_contained_dst));
1398 for (path, dependency_type) in builder.read_stamp_file(stamp) {
1399 let dst = match dependency_type {
1400 DependencyType::Host => sysroot_host_dst,
1401 DependencyType::Target => sysroot_dst,
1402 DependencyType::TargetSelfContained => self_contained_dst,
1404 builder.copy(&path, &dst.join(path.file_name().unwrap()));
1409 builder: &Builder<'_>,
1412 additional_target_deps: Vec<(PathBuf, DependencyType)>,
1415 if builder.config.dry_run() {
1419 // `target_root_dir` looks like $dir/$target/release
1420 let target_root_dir = stamp.parent().unwrap();
1421 // `target_deps_dir` looks like $dir/$target/release/deps
1422 let target_deps_dir = target_root_dir.join("deps");
1423 // `host_root_dir` looks like $dir/release
1424 let host_root_dir = target_root_dir
1426 .unwrap() // chop off `release`
1428 .unwrap() // chop off `$target`
1429 .join(target_root_dir.file_name().unwrap());
1431 // Spawn Cargo slurping up its JSON output. We'll start building up the
1432 // `deps` array of all files it generated along with a `toplevel` array of
1433 // files we need to probe for later.
1434 let mut deps = Vec::new();
1435 let mut toplevel = Vec::new();
1436 let ok = stream_cargo(builder, cargo, &mut |msg| {
1437 let (filenames, crate_types) = match msg {
1438 CargoMessage::CompilerArtifact {
1440 target: CargoTarget { crate_types },
1442 } => (filenames, crate_types),
1445 for filename in filenames {
1446 // Skip files like executables
1447 if !(filename.ends_with(".rlib")
1448 || filename.ends_with(".lib")
1449 || filename.ends_with(".a")
1450 || is_debug_info(&filename)
1451 || is_dylib(&filename)
1452 || (is_check && filename.ends_with(".rmeta")))
1457 let filename = Path::new(&*filename);
1459 // If this was an output file in the "host dir" we don't actually
1460 // worry about it, it's not relevant for us
1461 if filename.starts_with(&host_root_dir) {
1462 // Unless it's a proc macro used in the compiler
1463 if crate_types.iter().any(|t| t == "proc-macro") {
1464 deps.push((filename.to_path_buf(), DependencyType::Host));
1469 // If this was output in the `deps` dir then this is a precise file
1470 // name (hash included) so we start tracking it.
1471 if filename.starts_with(&target_deps_dir) {
1472 deps.push((filename.to_path_buf(), DependencyType::Target));
1476 // Otherwise this was a "top level artifact" which right now doesn't
1477 // have a hash in the name, but there's a version of this file in
1478 // the `deps` folder which *does* have a hash in the name. That's
1479 // the one we'll want to we'll probe for it later.
1481 // We do not use `Path::file_stem` or `Path::extension` here,
1482 // because some generated files may have multiple extensions e.g.
1483 // `std-<hash>.dll.lib` on Windows. The aforementioned methods only
1484 // split the file name by the last extension (`.lib`) while we need
1485 // to split by all extensions (`.dll.lib`).
1486 let expected_len = t!(filename.metadata()).len();
1487 let filename = filename.file_name().unwrap().to_str().unwrap();
1488 let mut parts = filename.splitn(2, '.');
1489 let file_stem = parts.next().unwrap().to_owned();
1490 let extension = parts.next().unwrap().to_owned();
1492 toplevel.push((file_stem, extension, expected_len));
1497 crate::detail_exit(1);
1500 // Ok now we need to actually find all the files listed in `toplevel`. We've
1501 // got a list of prefix/extensions and we basically just need to find the
1502 // most recent file in the `deps` folder corresponding to each one.
1503 let contents = t!(target_deps_dir.read_dir())
1505 .map(|e| (e.path(), e.file_name().into_string().unwrap(), t!(e.metadata())))
1506 .collect::<Vec<_>>();
1507 for (prefix, extension, expected_len) in toplevel {
1508 let candidates = contents.iter().filter(|&&(_, ref filename, ref meta)| {
1509 meta.len() == expected_len
1511 .strip_prefix(&prefix[..])
1512 .map(|s| s.starts_with('-') && s.ends_with(&extension[..]))
1515 let max = candidates.max_by_key(|&&(_, _, ref metadata)| {
1516 metadata.modified().expect("mtime should be available on all relevant OSes")
1518 let path_to_add = match max {
1519 Some(triple) => triple.0.to_str().unwrap(),
1520 None => panic!("no output generated for {:?} {:?}", prefix, extension),
1522 if is_dylib(path_to_add) {
1523 let candidate = format!("{}.lib", path_to_add);
1524 let candidate = PathBuf::from(candidate);
1525 if candidate.exists() {
1526 deps.push((candidate, DependencyType::Target));
1529 deps.push((path_to_add.into(), DependencyType::Target));
1532 deps.extend(additional_target_deps);
1534 let mut new_contents = Vec::new();
1535 for (dep, dependency_type) in deps.iter() {
1536 new_contents.extend(match *dependency_type {
1537 DependencyType::Host => b"h",
1538 DependencyType::Target => b"t",
1539 DependencyType::TargetSelfContained => b"s",
1541 new_contents.extend(dep.to_str().unwrap().as_bytes());
1542 new_contents.extend(b"\0");
1544 t!(fs::write(&stamp, &new_contents));
1545 deps.into_iter().map(|(d, _)| d).collect()
1548 pub fn stream_cargo(
1549 builder: &Builder<'_>,
1551 cb: &mut dyn FnMut(CargoMessage<'_>),
1553 let mut cargo = Command::from(cargo);
1554 if builder.config.dry_run() {
1557 // Instruct Cargo to give us json messages on stdout, critically leaving
1558 // stderr as piped so we can get those pretty colors.
1559 let mut message_format = if builder.config.json_output {
1560 String::from("json")
1562 String::from("json-render-diagnostics")
1564 if let Some(s) = &builder.config.rustc_error_format {
1565 message_format.push_str(",json-diagnostic-");
1566 message_format.push_str(s);
1568 cargo.arg("--message-format").arg(message_format).stdout(Stdio::piped());
1570 builder.verbose(&format!("running: {:?}", cargo));
1571 let mut child = match cargo.spawn() {
1573 Err(e) => panic!("failed to execute command: {:?}\nerror: {}", cargo, e),
1576 // Spawn Cargo slurping up its JSON output. We'll start building up the
1577 // `deps` array of all files it generated along with a `toplevel` array of
1578 // files we need to probe for later.
1579 let stdout = BufReader::new(child.stdout.take().unwrap());
1580 for line in stdout.lines() {
1581 let line = t!(line);
1582 match serde_json::from_str::<CargoMessage<'_>>(&line) {
1584 if builder.config.json_output {
1585 // Forward JSON to stdout.
1586 println!("{}", line);
1590 // If this was informational, just print it out and continue
1591 Err(_) => println!("{}", line),
1595 // Make sure Cargo actually succeeded after we read all of its stdout.
1596 let status = t!(child.wait());
1597 if builder.is_verbose() && !status.success() {
1599 "command did not execute successfully: {:?}\n\
1600 expected success, got: {}",
1607 #[derive(Deserialize)]
1608 pub struct CargoTarget<'a> {
1609 crate_types: Vec<Cow<'a, str>>,
1612 #[derive(Deserialize)]
1613 #[serde(tag = "reason", rename_all = "kebab-case")]
1614 pub enum CargoMessage<'a> {
1616 package_id: Cow<'a, str>,
1617 features: Vec<Cow<'a, str>>,
1618 filenames: Vec<Cow<'a, str>>,
1619 target: CargoTarget<'a>,
1621 BuildScriptExecuted {
1622 package_id: Cow<'a, str>,