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::Cargo;
22 use crate::builder::{Builder, Kind, RunConfig, ShouldRun, Step};
23 use crate::cache::{Interned, INTERNER};
24 use crate::config::{LlvmLibunwind, TargetSelection};
27 use crate::tool::SourceType;
28 use crate::util::{exe, is_debug_info, is_dylib, output, symlink_dir, t, up_to_date};
29 use crate::LLVM_TOOLS;
30 use crate::{CLang, Compiler, DependencyType, GitRepo, Mode};
32 #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
34 pub target: TargetSelection,
35 pub compiler: Compiler,
36 /// Whether to build only a subset of crates in the standard library.
38 /// This shouldn't be used from other steps; see the comment on [`Rustc`].
39 crates: Interned<Vec<String>>,
43 pub fn new(compiler: Compiler, target: TargetSelection) -> Self {
44 Self { target, compiler, crates: Default::default() }
48 /// Return a `-p=x -p=y` string suitable for passing to a cargo invocation.
49 fn build_crates_in_set(run: &RunConfig<'_>) -> Interned<Vec<String>> {
50 let mut crates = Vec::new();
51 for krate in &run.paths {
52 let path = krate.assert_single_path();
53 let crate_name = run.builder.crate_paths[&path.path];
54 crates.push(format!("-p={crate_name}"));
56 INTERNER.intern_list(crates)
61 const DEFAULT: bool = true;
63 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
64 // When downloading stage1, the standard library has already been copied to the sysroot, so
65 // there's no need to rebuild it.
66 let builder = run.builder;
67 run.crate_or_deps("test")
69 .lazy_default_condition(Box::new(|| !builder.download_rustc()))
72 fn make_run(run: RunConfig<'_>) {
73 // Normally, people will pass *just* library if they pass it.
74 // But it's possible (although strange) to pass something like `library std core`.
75 // Build all crates anyway, as if they hadn't passed the other args.
77 run.paths.iter().any(|set| set.assert_single_path().path.ends_with("library"));
78 let crates = if has_library { Default::default() } else { build_crates_in_set(&run) };
79 run.builder.ensure(Std {
80 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
86 /// Builds the standard library.
88 /// This will build the standard library for a particular stage of the build
89 /// using the `compiler` targeting the `target` architecture. The artifacts
90 /// created will also be linked into the sysroot directory.
91 fn run(self, builder: &Builder<'_>) {
92 let target = self.target;
93 let compiler = self.compiler;
95 // These artifacts were already copied (in `impl Step for Sysroot`).
96 // Don't recompile them.
97 // NOTE: the ABI of the beta compiler is different from the ABI of the downloaded compiler,
98 // so its artifacts can't be reused.
99 if builder.download_rustc() && compiler.stage != 0 {
103 if builder.config.keep_stage.contains(&compiler.stage)
104 || builder.config.keep_stage_std.contains(&compiler.stage)
106 builder.info("Warning: Using a potentially old libstd. This may not behave well.");
107 builder.ensure(StdLink::from_std(self, compiler));
111 builder.update_submodule(&Path::new("library").join("stdarch"));
113 let mut target_deps = builder.ensure(StartupObjects { compiler, target });
115 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
116 if compiler_to_use != compiler {
117 builder.ensure(Std::new(compiler_to_use, target));
118 builder.info(&format!("Uplifting stage1 std ({} -> {})", compiler_to_use.host, target));
120 // Even if we're not building std this stage, the new sysroot must
121 // still contain the third party objects needed by various targets.
122 copy_third_party_objects(builder, &compiler, target);
123 copy_self_contained_objects(builder, &compiler, target);
125 builder.ensure(StdLink::from_std(self, compiler_to_use));
129 target_deps.extend(copy_third_party_objects(builder, &compiler, target));
130 target_deps.extend(copy_self_contained_objects(builder, &compiler, target));
132 let mut cargo = builder.cargo(compiler, Mode::Std, SourceType::InTree, target, "build");
133 std_cargo(builder, target, compiler.stage, &mut cargo);
135 builder.info(&format!(
136 "Building stage{} std artifacts ({} -> {})",
137 compiler.stage, &compiler.host, target
142 self.crates.to_vec(),
143 &libstd_stamp(builder, compiler, target),
148 builder.ensure(StdLink::from_std(
150 builder.compiler(compiler.stage, builder.config.build),
156 builder: &Builder<'_>,
160 target_deps: &mut Vec<(PathBuf, DependencyType)>,
161 dependency_type: DependencyType,
163 let target = libdir.join(name);
164 builder.copy(&sourcedir.join(name), &target);
166 target_deps.push((target, dependency_type));
169 fn copy_llvm_libunwind(builder: &Builder<'_>, target: TargetSelection, libdir: &Path) -> PathBuf {
170 let libunwind_path = builder.ensure(native::Libunwind { target });
171 let libunwind_source = libunwind_path.join("libunwind.a");
172 let libunwind_target = libdir.join("libunwind.a");
173 builder.copy(&libunwind_source, &libunwind_target);
177 /// Copies third party objects needed by various targets.
178 fn copy_third_party_objects(
179 builder: &Builder<'_>,
181 target: TargetSelection,
182 ) -> Vec<(PathBuf, DependencyType)> {
183 let mut target_deps = vec![];
185 // FIXME: remove this in 2021
186 if target == "x86_64-fortanix-unknown-sgx" {
187 if env::var_os("X86_FORTANIX_SGX_LIBS").is_some() {
188 builder.info("Warning: X86_FORTANIX_SGX_LIBS environment variable is ignored, libunwind is now compiled as part of rustbuild");
192 if builder.config.sanitizers_enabled(target) && compiler.stage != 0 {
193 // The sanitizers are only copied in stage1 or above,
194 // to avoid creating dependency on LLVM.
196 copy_sanitizers(builder, &compiler, target)
198 .map(|d| (d, DependencyType::Target)),
202 if target == "x86_64-fortanix-unknown-sgx"
203 || target.contains("pc-windows-gnullvm")
204 || builder.config.llvm_libunwind(target) == LlvmLibunwind::InTree
205 && (target.contains("linux") || target.contains("fuchsia"))
208 copy_llvm_libunwind(builder, target, &builder.sysroot_libdir(*compiler, target));
209 target_deps.push((libunwind_path, DependencyType::Target));
215 /// Copies third party objects needed by various targets for self-contained linkage.
216 fn copy_self_contained_objects(
217 builder: &Builder<'_>,
219 target: TargetSelection,
220 ) -> Vec<(PathBuf, DependencyType)> {
221 let libdir_self_contained = builder.sysroot_libdir(*compiler, target).join("self-contained");
222 t!(fs::create_dir_all(&libdir_self_contained));
223 let mut target_deps = vec![];
225 // Copies the libc and CRT objects.
227 // rustc historically provides a more self-contained installation for musl targets
228 // not requiring the presence of a native musl toolchain. For example, it can fall back
229 // to using gcc from a glibc-targeting toolchain for linking.
230 // To do that we have to distribute musl startup objects as a part of Rust toolchain
231 // and link with them manually in the self-contained mode.
232 if target.contains("musl") {
233 let srcdir = builder.musl_libdir(target).unwrap_or_else(|| {
234 panic!("Target {:?} does not have a \"musl-libdir\" key", target.triple)
236 for &obj in &["libc.a", "crt1.o", "Scrt1.o", "rcrt1.o", "crti.o", "crtn.o"] {
239 &libdir_self_contained,
243 DependencyType::TargetSelfContained,
246 let crt_path = builder.ensure(native::CrtBeginEnd { target });
247 for &obj in &["crtbegin.o", "crtbeginS.o", "crtend.o", "crtendS.o"] {
248 let src = crt_path.join(obj);
249 let target = libdir_self_contained.join(obj);
250 builder.copy(&src, &target);
251 target_deps.push((target, DependencyType::TargetSelfContained));
254 if !target.starts_with("s390x") {
255 let libunwind_path = copy_llvm_libunwind(builder, target, &libdir_self_contained);
256 target_deps.push((libunwind_path, DependencyType::TargetSelfContained));
258 } else if target.ends_with("-wasi") {
262 panic!("Target {:?} does not have a \"wasi-root\" key", target.triple)
264 .join("lib/wasm32-wasi");
265 for &obj in &["libc.a", "crt1-command.o", "crt1-reactor.o"] {
268 &libdir_self_contained,
272 DependencyType::TargetSelfContained,
275 } else if target.ends_with("windows-gnu") {
276 for obj in ["crt2.o", "dllcrt2.o"].iter() {
277 let src = compiler_file(builder, builder.cc(target), target, CLang::C, obj);
278 let target = libdir_self_contained.join(obj);
279 builder.copy(&src, &target);
280 target_deps.push((target, DependencyType::TargetSelfContained));
287 /// Configure cargo to compile the standard library, adding appropriate env vars
289 pub fn std_cargo(builder: &Builder<'_>, target: TargetSelection, stage: u32, cargo: &mut Cargo) {
290 if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
291 cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
294 // Determine if we're going to compile in optimized C intrinsics to
295 // the `compiler-builtins` crate. These intrinsics live in LLVM's
296 // `compiler-rt` repository, but our `src/llvm-project` submodule isn't
297 // always checked out, so we need to conditionally look for this. (e.g. if
298 // an external LLVM is used we skip the LLVM submodule checkout).
300 // Note that this shouldn't affect the correctness of `compiler-builtins`,
301 // but only its speed. Some intrinsics in C haven't been translated to Rust
302 // yet but that's pretty rare. Other intrinsics have optimized
303 // implementations in C which have only had slower versions ported to Rust,
304 // so we favor the C version where we can, but it's not critical.
306 // If `compiler-rt` is available ensure that the `c` feature of the
307 // `compiler-builtins` crate is enabled and it's configured to learn where
308 // `compiler-rt` is located.
309 let compiler_builtins_root = builder.src.join("src/llvm-project/compiler-rt");
310 let compiler_builtins_c_feature = if compiler_builtins_root.exists() {
311 // Note that `libprofiler_builtins/build.rs` also computes this so if
312 // you're changing something here please also change that.
313 cargo.env("RUST_COMPILER_RT_ROOT", &compiler_builtins_root);
314 " compiler-builtins-c"
319 if builder.no_std(target) == Some(true) {
320 let mut features = "compiler-builtins-mem".to_string();
321 if !target.starts_with("bpf") {
322 features.push_str(compiler_builtins_c_feature);
325 // for no-std targets we only compile a few no_std crates
327 .args(&["-p", "alloc"])
328 .arg("--manifest-path")
329 .arg(builder.src.join("library/alloc/Cargo.toml"))
333 let mut features = builder.std_features(target);
334 features.push_str(compiler_builtins_c_feature);
339 .arg("--manifest-path")
340 .arg(builder.src.join("library/test/Cargo.toml"));
342 // Help the libc crate compile by assisting it in finding various
343 // sysroot native libraries.
344 if target.contains("musl") {
345 if let Some(p) = builder.musl_libdir(target) {
346 let root = format!("native={}", p.to_str().unwrap());
347 cargo.rustflag("-L").rustflag(&root);
351 if target.ends_with("-wasi") {
352 if let Some(p) = builder.wasi_root(target) {
353 let root = format!("native={}/lib/wasm32-wasi", p.to_str().unwrap());
354 cargo.rustflag("-L").rustflag(&root);
359 // By default, rustc uses `-Cembed-bitcode=yes`, and Cargo overrides that
360 // with `-Cembed-bitcode=no` for non-LTO builds. However, libstd must be
361 // built with bitcode so that the produced rlibs can be used for both LTO
362 // builds (which use bitcode) and non-LTO builds (which use object code).
363 // So we override the override here!
365 // But we don't bother for the stage 0 compiler because it's never used
368 cargo.rustflag("-Cembed-bitcode=yes");
371 // By default, rustc does not include unwind tables unless they are required
372 // for a particular target. They are not required by RISC-V targets, but
373 // compiling the standard library with them means that users can get
374 // backtraces without having to recompile the standard library themselves.
376 // This choice was discussed in https://github.com/rust-lang/rust/pull/69890
377 if target.contains("riscv") {
378 cargo.rustflag("-Cforce-unwind-tables=yes");
382 format!("-Zcrate-attr=doc(html_root_url=\"{}/\")", builder.doc_rust_lang_org_channel(),);
383 cargo.rustflag(&html_root);
384 cargo.rustdocflag(&html_root);
387 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
389 pub compiler: Compiler,
390 pub target_compiler: Compiler,
391 pub target: TargetSelection,
392 /// Not actually used; only present to make sure the cache invalidation is correct.
393 crates: Interned<Vec<String>>,
397 fn from_std(std: Std, host_compiler: Compiler) -> Self {
399 compiler: host_compiler,
400 target_compiler: std.compiler,
407 impl Step for StdLink {
410 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
414 /// Link all libstd rlibs/dylibs into the sysroot location.
416 /// Links those artifacts generated by `compiler` to the `stage` compiler's
417 /// sysroot for the specified `host` and `target`.
419 /// Note that this assumes that `compiler` has already generated the libstd
420 /// libraries for `target`, and this method will find them in the relevant
421 /// output directory.
422 fn run(self, builder: &Builder<'_>) {
423 let compiler = self.compiler;
424 let target_compiler = self.target_compiler;
425 let target = self.target;
426 builder.info(&format!(
427 "Copying stage{} std from stage{} ({} -> {} / {})",
428 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
430 let libdir = builder.sysroot_libdir(target_compiler, target);
431 let hostdir = builder.sysroot_libdir(target_compiler, compiler.host);
432 add_to_sysroot(builder, &libdir, &hostdir, &libstd_stamp(builder, compiler, target));
436 /// Copies sanitizer runtime libraries into target libdir.
438 builder: &Builder<'_>,
440 target: TargetSelection,
442 let runtimes: Vec<native::SanitizerRuntime> = builder.ensure(native::Sanitizers { target });
444 if builder.config.dry_run {
448 let mut target_deps = Vec::new();
449 let libdir = builder.sysroot_libdir(*compiler, target);
451 for runtime in &runtimes {
452 let dst = libdir.join(&runtime.name);
453 builder.copy(&runtime.path, &dst);
455 if target == "x86_64-apple-darwin" || target == "aarch64-apple-darwin" {
456 // Update the library’s install name to reflect that it has has been renamed.
457 apple_darwin_update_library_name(&dst, &format!("@rpath/{}", &runtime.name));
458 // Upon renaming the install name, the code signature of the file will invalidate,
459 // so we will sign it again.
460 apple_darwin_sign_file(&dst);
463 target_deps.push(dst);
469 fn apple_darwin_update_library_name(library_path: &Path, new_name: &str) {
470 let status = Command::new("install_name_tool")
475 .expect("failed to execute `install_name_tool`");
476 assert!(status.success());
479 fn apple_darwin_sign_file(file_path: &Path) {
480 let status = Command::new("codesign")
481 .arg("-f") // Force to rewrite the existing signature
486 .expect("failed to execute `codesign`");
487 assert!(status.success());
490 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
491 pub struct StartupObjects {
492 pub compiler: Compiler,
493 pub target: TargetSelection,
496 impl Step for StartupObjects {
497 type Output = Vec<(PathBuf, DependencyType)>;
499 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
500 run.path("library/rtstartup")
503 fn make_run(run: RunConfig<'_>) {
504 run.builder.ensure(StartupObjects {
505 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
510 /// Builds and prepare startup objects like rsbegin.o and rsend.o
512 /// These are primarily used on Windows right now for linking executables/dlls.
513 /// They don't require any library support as they're just plain old object
514 /// files, so we just use the nightly snapshot compiler to always build them (as
515 /// no other compilers are guaranteed to be available).
516 fn run(self, builder: &Builder<'_>) -> Vec<(PathBuf, DependencyType)> {
517 let for_compiler = self.compiler;
518 let target = self.target;
519 if !target.ends_with("windows-gnu") {
523 let mut target_deps = vec![];
525 let src_dir = &builder.src.join("library").join("rtstartup");
526 let dst_dir = &builder.native_dir(target).join("rtstartup");
527 let sysroot_dir = &builder.sysroot_libdir(for_compiler, target);
528 t!(fs::create_dir_all(dst_dir));
530 for file in &["rsbegin", "rsend"] {
531 let src_file = &src_dir.join(file.to_string() + ".rs");
532 let dst_file = &dst_dir.join(file.to_string() + ".o");
533 if !up_to_date(src_file, dst_file) {
534 let mut cmd = Command::new(&builder.initial_rustc);
535 cmd.env("RUSTC_BOOTSTRAP", "1");
536 if !builder.local_rebuild {
537 // a local_rebuild compiler already has stage1 features
538 cmd.arg("--cfg").arg("bootstrap");
542 .arg(target.rustc_target_arg())
550 let target = sysroot_dir.join((*file).to_string() + ".o");
551 builder.copy(dst_file, &target);
552 target_deps.push((target, DependencyType::Target));
559 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
561 pub target: TargetSelection,
562 pub compiler: Compiler,
563 /// Whether to build a subset of crates, rather than the whole compiler.
565 /// This should only be requested by the user, not used within rustbuild itself.
566 /// Using it within rustbuild can lead to confusing situation where lints are replayed
567 /// in two different steps.
568 crates: Interned<Vec<String>>,
572 pub fn new(compiler: Compiler, target: TargetSelection) -> Self {
573 Self { target, compiler, crates: Default::default() }
577 impl Step for Rustc {
579 const ONLY_HOSTS: bool = true;
580 const DEFAULT: bool = false;
582 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
583 let mut crates = run.builder.in_tree_crates("rustc-main", None);
584 for (i, krate) in crates.iter().enumerate() {
585 if krate.name == "rustc-main" {
586 crates.swap_remove(i);
593 fn make_run(run: RunConfig<'_>) {
594 let crates = build_crates_in_set(&run);
595 run.builder.ensure(Rustc {
596 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
602 /// Builds the compiler.
604 /// This will build the compiler for a particular stage of the build using
605 /// the `compiler` targeting the `target` architecture. The artifacts
606 /// created will also be linked into the sysroot directory.
607 fn run(self, builder: &Builder<'_>) {
608 let compiler = self.compiler;
609 let target = self.target;
611 // NOTE: the ABI of the beta compiler is different from the ABI of the downloaded compiler,
612 // so its artifacts can't be reused.
613 if builder.download_rustc() && compiler.stage != 0 {
614 // Copy the existing artifacts instead of rebuilding them.
615 // NOTE: this path is only taken for tools linking to rustc-dev.
616 builder.ensure(Sysroot { compiler });
620 builder.ensure(Std::new(compiler, target));
622 if builder.config.keep_stage.contains(&compiler.stage) {
623 builder.info("Warning: Using a potentially old librustc. This may not behave well.");
624 builder.info("Warning: Use `--keep-stage-std` if you want to rebuild the compiler when it changes");
625 builder.ensure(RustcLink::from_rustc(self, compiler));
629 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
630 if compiler_to_use != compiler {
631 builder.ensure(Rustc::new(compiler_to_use, target));
633 .info(&format!("Uplifting stage1 rustc ({} -> {})", builder.config.build, target));
634 builder.ensure(RustcLink::from_rustc(self, compiler_to_use));
638 // Ensure that build scripts and proc macros have a std / libproc_macro to link against.
639 builder.ensure(Std::new(
640 builder.compiler(self.compiler.stage, builder.config.build),
641 builder.config.build,
644 let mut cargo = builder.cargo(compiler, Mode::Rustc, SourceType::InTree, target, "build");
645 rustc_cargo(builder, &mut cargo, target);
647 if builder.config.rust_profile_use.is_some()
648 && builder.config.rust_profile_generate.is_some()
650 panic!("Cannot use and generate PGO profiles at the same time");
653 let is_collecting = if let Some(path) = &builder.config.rust_profile_generate {
654 if compiler.stage == 1 {
655 cargo.rustflag(&format!("-Cprofile-generate={}", path));
656 // Apparently necessary to avoid overflowing the counters during
657 // a Cargo build profile
658 cargo.rustflag("-Cllvm-args=-vp-counters-per-site=4");
663 } else if let Some(path) = &builder.config.rust_profile_use {
664 if compiler.stage == 1 {
665 cargo.rustflag(&format!("-Cprofile-use={}", path));
666 cargo.rustflag("-Cllvm-args=-pgo-warn-missing-function");
675 // Ensure paths to Rust sources are relative, not absolute.
676 cargo.rustflag(&format!(
677 "-Cllvm-args=-static-func-strip-dirname-prefix={}",
678 builder.config.src.components().count()
682 builder.info(&format!(
683 "Building stage{} compiler artifacts ({} -> {})",
684 compiler.stage, &compiler.host, target
689 self.crates.to_vec(),
690 &librustc_stamp(builder, compiler, target),
695 builder.ensure(RustcLink::from_rustc(
697 builder.compiler(compiler.stage, builder.config.build),
702 pub fn rustc_cargo(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
705 .arg(builder.rustc_features(builder.kind))
706 .arg("--manifest-path")
707 .arg(builder.src.join("compiler/rustc/Cargo.toml"));
708 rustc_cargo_env(builder, cargo, target);
711 pub fn rustc_cargo_env(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
712 // Set some configuration variables picked up by build scripts and
713 // the compiler alike
715 .env("CFG_RELEASE", builder.rust_release())
716 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
717 .env("CFG_VERSION", builder.rust_version());
719 if let Some(backend) = builder.config.rust_codegen_backends.get(0) {
720 cargo.env("CFG_DEFAULT_CODEGEN_BACKEND", backend);
723 let libdir_relative = builder.config.libdir_relative().unwrap_or_else(|| Path::new("lib"));
724 let target_config = builder.config.target_config.get(&target);
726 cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
728 if let Some(ref ver_date) = builder.rust_info.commit_date() {
729 cargo.env("CFG_VER_DATE", ver_date);
731 if let Some(ref ver_hash) = builder.rust_info.sha() {
732 cargo.env("CFG_VER_HASH", ver_hash);
734 if !builder.unstable_features() {
735 cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
738 // Prefer the current target's own default_linker, else a globally
740 if let Some(s) = target_config.and_then(|c| c.default_linker.as_ref()) {
741 cargo.env("CFG_DEFAULT_LINKER", s);
742 } else if let Some(ref s) = builder.config.rustc_default_linker {
743 cargo.env("CFG_DEFAULT_LINKER", s);
746 if builder.config.rustc_parallel {
747 // keep in sync with `bootstrap/lib.rs:Build::rustc_features`
748 // `cfg` option for rustc, `features` option for cargo, for conditional compilation
749 cargo.rustflag("--cfg=parallel_compiler");
750 cargo.rustdocflag("--cfg=parallel_compiler");
752 if builder.config.rust_verify_llvm_ir {
753 cargo.env("RUSTC_VERIFY_LLVM_IR", "1");
756 // Pass down configuration from the LLVM build into the build of
757 // rustc_llvm and rustc_codegen_llvm.
759 // Note that this is disabled if LLVM itself is disabled or we're in a check
760 // build. If we are in a check build we still go ahead here presuming we've
761 // detected that LLVM is already built and good to go which helps prevent
762 // busting caches (e.g. like #71152).
763 if builder.config.llvm_enabled()
764 && (builder.kind != Kind::Check
765 || crate::native::prebuilt_llvm_config(builder, target).is_ok())
767 if builder.is_rust_llvm(target) {
768 cargo.env("LLVM_RUSTLLVM", "1");
770 let llvm_config = builder.ensure(native::Llvm { target });
771 cargo.env("LLVM_CONFIG", &llvm_config);
772 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
773 cargo.env("CFG_LLVM_ROOT", s);
775 // Some LLVM linker flags (-L and -l) may be needed to link rustc_llvm.
776 if let Some(ref s) = builder.config.llvm_ldflags {
777 cargo.env("LLVM_LINKER_FLAGS", s);
779 // Building with a static libstdc++ is only supported on linux right now,
780 // not for MSVC or macOS
781 if builder.config.llvm_static_stdcpp
782 && !target.contains("freebsd")
783 && !target.contains("msvc")
784 && !target.contains("apple")
785 && !target.contains("solaris")
787 let file = compiler_file(
789 builder.cxx(target).unwrap(),
794 cargo.env("LLVM_STATIC_STDCPP", file);
796 if builder.llvm_link_shared() {
797 cargo.env("LLVM_LINK_SHARED", "1");
799 if builder.config.llvm_use_libcxx {
800 cargo.env("LLVM_USE_LIBCXX", "1");
802 if builder.config.llvm_optimize && !builder.config.llvm_release_debuginfo {
803 cargo.env("LLVM_NDEBUG", "1");
808 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
810 pub compiler: Compiler,
811 pub target_compiler: Compiler,
812 pub target: TargetSelection,
813 /// Not actually used; only present to make sure the cache invalidation is correct.
814 crates: Interned<Vec<String>>,
818 fn from_rustc(rustc: Rustc, host_compiler: Compiler) -> Self {
820 compiler: host_compiler,
821 target_compiler: rustc.compiler,
822 target: rustc.target,
823 crates: rustc.crates,
828 impl Step for RustcLink {
831 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
835 /// Same as `std_link`, only for librustc
836 fn run(self, builder: &Builder<'_>) {
837 let compiler = self.compiler;
838 let target_compiler = self.target_compiler;
839 let target = self.target;
840 builder.info(&format!(
841 "Copying stage{} rustc from stage{} ({} -> {} / {})",
842 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
846 &builder.sysroot_libdir(target_compiler, target),
847 &builder.sysroot_libdir(target_compiler, compiler.host),
848 &librustc_stamp(builder, compiler, target),
853 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
854 pub struct CodegenBackend {
855 pub target: TargetSelection,
856 pub compiler: Compiler,
857 pub backend: Interned<String>,
860 impl Step for CodegenBackend {
862 const ONLY_HOSTS: bool = true;
863 // Only the backends specified in the `codegen-backends` entry of `config.toml` are built.
864 const DEFAULT: bool = true;
866 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
867 run.paths(&["compiler/rustc_codegen_cranelift", "compiler/rustc_codegen_gcc"])
870 fn make_run(run: RunConfig<'_>) {
871 for &backend in &run.builder.config.rust_codegen_backends {
872 if backend == "llvm" {
873 continue; // Already built as part of rustc
876 run.builder.ensure(CodegenBackend {
878 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
884 fn run(self, builder: &Builder<'_>) {
885 let compiler = self.compiler;
886 let target = self.target;
887 let backend = self.backend;
889 builder.ensure(Rustc::new(compiler, target));
891 if builder.config.keep_stage.contains(&compiler.stage) {
893 "Warning: Using a potentially old codegen backend. \
894 This may not behave well.",
896 // Codegen backends are linked separately from this step today, so we don't do
901 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
902 if compiler_to_use != compiler {
903 builder.ensure(CodegenBackend { compiler: compiler_to_use, target, backend });
907 let out_dir = builder.cargo_out(compiler, Mode::Codegen, target);
909 let mut cargo = builder.cargo(compiler, Mode::Codegen, SourceType::InTree, target, "build");
911 .arg("--manifest-path")
912 .arg(builder.src.join(format!("compiler/rustc_codegen_{}/Cargo.toml", backend)));
913 rustc_cargo_env(builder, &mut cargo, target);
915 let tmp_stamp = out_dir.join(".tmp.stamp");
917 builder.info(&format!(
918 "Building stage{} codegen backend {} ({} -> {})",
919 compiler.stage, backend, &compiler.host, target
921 let files = run_cargo(builder, cargo, vec![], &tmp_stamp, vec![], false);
922 if builder.config.dry_run {
925 let mut files = files.into_iter().filter(|f| {
926 let filename = f.file_name().unwrap().to_str().unwrap();
927 is_dylib(filename) && filename.contains("rustc_codegen_")
929 let codegen_backend = match files.next() {
931 None => panic!("no dylibs built for codegen backend?"),
933 if let Some(f) = files.next() {
935 "codegen backend built two dylibs:\n{}\n{}",
936 codegen_backend.display(),
940 let stamp = codegen_backend_stamp(builder, compiler, target, backend);
941 let codegen_backend = codegen_backend.to_str().unwrap();
942 t!(fs::write(&stamp, &codegen_backend));
946 /// Creates the `codegen-backends` folder for a compiler that's about to be
947 /// assembled as a complete compiler.
949 /// This will take the codegen artifacts produced by `compiler` and link them
950 /// into an appropriate location for `target_compiler` to be a functional
952 fn copy_codegen_backends_to_sysroot(
953 builder: &Builder<'_>,
955 target_compiler: Compiler,
957 let target = target_compiler.host;
959 // Note that this step is different than all the other `*Link` steps in
960 // that it's not assembling a bunch of libraries but rather is primarily
961 // moving the codegen backend into place. The codegen backend of rustc is
962 // not linked into the main compiler by default but is rather dynamically
963 // selected at runtime for inclusion.
965 // Here we're looking for the output dylib of the `CodegenBackend` step and
966 // we're copying that into the `codegen-backends` folder.
967 let dst = builder.sysroot_codegen_backends(target_compiler);
968 t!(fs::create_dir_all(&dst), dst);
970 if builder.config.dry_run {
974 for backend in builder.config.rust_codegen_backends.iter() {
975 if backend == "llvm" {
976 continue; // Already built as part of rustc
979 let stamp = codegen_backend_stamp(builder, compiler, target, *backend);
980 let dylib = t!(fs::read_to_string(&stamp));
981 let file = Path::new(&dylib);
982 let filename = file.file_name().unwrap().to_str().unwrap();
983 // change `librustc_codegen_cranelift-xxxxxx.so` to
984 // `librustc_codegen_cranelift-release.so`
985 let target_filename = {
986 let dash = filename.find('-').unwrap();
987 let dot = filename.find('.').unwrap();
988 format!("{}-{}{}", &filename[..dash], builder.rust_release(), &filename[dot..])
990 builder.copy(&file, &dst.join(target_filename));
994 /// Cargo's output path for the standard library in a given stage, compiled
995 /// by a particular compiler for the specified target.
996 pub fn libstd_stamp(builder: &Builder<'_>, compiler: Compiler, target: TargetSelection) -> PathBuf {
997 builder.cargo_out(compiler, Mode::Std, target).join(".libstd.stamp")
1000 /// Cargo's output path for librustc in a given stage, compiled by a particular
1001 /// compiler for the specified target.
1002 pub fn librustc_stamp(
1003 builder: &Builder<'_>,
1005 target: TargetSelection,
1007 builder.cargo_out(compiler, Mode::Rustc, target).join(".librustc.stamp")
1010 /// Cargo's output path for librustc_codegen_llvm in a given stage, compiled by a particular
1011 /// compiler for the specified target and backend.
1012 fn codegen_backend_stamp(
1013 builder: &Builder<'_>,
1015 target: TargetSelection,
1016 backend: Interned<String>,
1019 .cargo_out(compiler, Mode::Codegen, target)
1020 .join(format!(".librustc_codegen_{}.stamp", backend))
1023 pub fn compiler_file(
1024 builder: &Builder<'_>,
1026 target: TargetSelection,
1030 let mut cmd = Command::new(compiler);
1031 cmd.args(builder.cflags(target, GitRepo::Rustc, c));
1032 cmd.arg(format!("-print-file-name={}", file));
1033 let out = output(&mut cmd);
1034 PathBuf::from(out.trim())
1037 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1038 pub struct Sysroot {
1039 pub compiler: Compiler,
1042 impl Step for Sysroot {
1043 type Output = Interned<PathBuf>;
1045 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1049 /// Returns the sysroot for the `compiler` specified that *this build system
1052 /// That is, the sysroot for the stage0 compiler is not what the compiler
1053 /// thinks it is by default, but it's the same as the default for stages
1055 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
1056 let compiler = self.compiler;
1057 let sysroot = if compiler.stage == 0 {
1058 builder.out.join(&compiler.host.triple).join("stage0-sysroot")
1060 builder.out.join(&compiler.host.triple).join(format!("stage{}", compiler.stage))
1062 let _ = fs::remove_dir_all(&sysroot);
1063 t!(fs::create_dir_all(&sysroot));
1065 // If we're downloading a compiler from CI, we can use the same compiler for all stages other than 0.
1066 if builder.download_rustc() && compiler.stage != 0 {
1068 builder.config.build, compiler.host,
1069 "Cross-compiling is not yet supported with `download-rustc`",
1071 // Copy the compiler into the correct sysroot.
1073 builder.config.out.join(&*builder.config.build.triple).join("ci-rustc");
1074 builder.cp_r(&ci_rustc_dir, &sysroot);
1075 return INTERNER.intern_path(sysroot);
1078 // Symlink the source root into the same location inside the sysroot,
1079 // where `rust-src` component would go (`$sysroot/lib/rustlib/src/rust`),
1080 // so that any tools relying on `rust-src` also work for local builds,
1081 // and also for translating the virtual `/rustc/$hash` back to the real
1082 // directory (for running tests with `rust.remap-debuginfo = true`).
1083 let sysroot_lib_rustlib_src = sysroot.join("lib/rustlib/src");
1084 t!(fs::create_dir_all(&sysroot_lib_rustlib_src));
1085 let sysroot_lib_rustlib_src_rust = sysroot_lib_rustlib_src.join("rust");
1086 if let Err(e) = symlink_dir(&builder.config, &builder.src, &sysroot_lib_rustlib_src_rust) {
1088 "warning: creating symbolic link `{}` to `{}` failed with {}",
1089 sysroot_lib_rustlib_src_rust.display(),
1090 builder.src.display(),
1093 if builder.config.rust_remap_debuginfo {
1095 "warning: some `src/test/ui` tests will fail when lacking `{}`",
1096 sysroot_lib_rustlib_src_rust.display(),
1101 INTERNER.intern_path(sysroot)
1105 #[derive(Debug, Copy, PartialOrd, Ord, Clone, PartialEq, Eq, Hash)]
1106 pub struct Assemble {
1107 /// The compiler which we will produce in this step. Assemble itself will
1108 /// take care of ensuring that the necessary prerequisites to do so exist,
1109 /// that is, this target can be a stage2 compiler and Assemble will build
1110 /// previous stages for you.
1111 pub target_compiler: Compiler,
1114 impl Step for Assemble {
1115 type Output = Compiler;
1116 const ONLY_HOSTS: bool = true;
1118 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1119 run.path("compiler/rustc").path("compiler")
1122 fn make_run(run: RunConfig<'_>) {
1123 run.builder.ensure(Assemble {
1124 target_compiler: run.builder.compiler(run.builder.top_stage + 1, run.target),
1128 /// Prepare a new compiler from the artifacts in `stage`
1130 /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
1131 /// must have been previously produced by the `stage - 1` builder.build
1133 fn run(self, builder: &Builder<'_>) -> Compiler {
1134 let target_compiler = self.target_compiler;
1136 if target_compiler.stage == 0 {
1138 builder.config.build, target_compiler.host,
1139 "Cannot obtain compiler for non-native build triple at stage 0"
1141 // The stage 0 compiler for the build triple is always pre-built.
1142 return target_compiler;
1145 // Get the compiler that we'll use to bootstrap ourselves.
1147 // Note that this is where the recursive nature of the bootstrap
1148 // happens, as this will request the previous stage's compiler on
1149 // downwards to stage 0.
1151 // Also note that we're building a compiler for the host platform. We
1152 // only assume that we can run `build` artifacts, which means that to
1153 // produce some other architecture compiler we need to start from
1154 // `build` to get there.
1156 // FIXME: It may be faster if we build just a stage 1 compiler and then
1157 // use that to bootstrap this compiler forward.
1158 let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
1160 // If we're downloading a compiler from CI, we can use the same compiler for all stages other than 0.
1161 if builder.download_rustc() {
1162 builder.ensure(Sysroot { compiler: target_compiler });
1163 return target_compiler;
1166 // Build the libraries for this compiler to link to (i.e., the libraries
1167 // it uses at runtime). NOTE: Crates the target compiler compiles don't
1168 // link to these. (FIXME: Is that correct? It seems to be correct most
1169 // of the time but I think we do link to these for stage2/bin compilers
1170 // when not performing a full bootstrap).
1171 builder.ensure(Rustc::new(build_compiler, target_compiler.host));
1173 for &backend in builder.config.rust_codegen_backends.iter() {
1174 if backend == "llvm" {
1175 continue; // Already built as part of rustc
1178 builder.ensure(CodegenBackend {
1179 compiler: build_compiler,
1180 target: target_compiler.host,
1185 let lld_install = if builder.config.lld_enabled {
1186 Some(builder.ensure(native::Lld { target: target_compiler.host }))
1191 let stage = target_compiler.stage;
1192 let host = target_compiler.host;
1193 builder.info(&format!("Assembling stage{} compiler ({})", stage, host));
1195 // Link in all dylibs to the libdir
1196 let stamp = librustc_stamp(builder, build_compiler, target_compiler.host);
1197 let proc_macros = builder
1198 .read_stamp_file(&stamp)
1200 .filter_map(|(path, dependency_type)| {
1201 if dependency_type == DependencyType::Host {
1202 Some(path.file_name().unwrap().to_owned().into_string().unwrap())
1207 .collect::<HashSet<_>>();
1209 let sysroot = builder.sysroot(target_compiler);
1210 let rustc_libdir = builder.rustc_libdir(target_compiler);
1211 t!(fs::create_dir_all(&rustc_libdir));
1212 let src_libdir = builder.sysroot_libdir(build_compiler, host);
1213 for f in builder.read_dir(&src_libdir) {
1214 let filename = f.file_name().into_string().unwrap();
1215 if (is_dylib(&filename) || is_debug_info(&filename)) && !proc_macros.contains(&filename)
1217 builder.copy(&f.path(), &rustc_libdir.join(&filename));
1221 copy_codegen_backends_to_sysroot(builder, build_compiler, target_compiler);
1223 // We prepend this bin directory to the user PATH when linking Rust binaries. To
1224 // avoid shadowing the system LLD we rename the LLD we provide to `rust-lld`.
1225 let libdir = builder.sysroot_libdir(target_compiler, target_compiler.host);
1226 let libdir_bin = libdir.parent().unwrap().join("bin");
1227 t!(fs::create_dir_all(&libdir_bin));
1228 if let Some(lld_install) = lld_install {
1229 let src_exe = exe("lld", target_compiler.host);
1230 let dst_exe = exe("rust-lld", target_compiler.host);
1231 builder.copy(&lld_install.join("bin").join(&src_exe), &libdir_bin.join(&dst_exe));
1232 // for `-Z gcc-ld=lld`
1233 let gcc_ld_dir = libdir_bin.join("gcc-ld");
1234 t!(fs::create_dir(&gcc_ld_dir));
1235 let lld_wrapper_exe = builder.ensure(crate::tool::LldWrapper {
1236 compiler: build_compiler,
1237 target: target_compiler.host,
1239 builder.copy(&lld_wrapper_exe, &gcc_ld_dir.join(exe("ld", target_compiler.host)));
1242 if builder.config.rust_codegen_backends.contains(&INTERNER.intern_str("llvm")) {
1243 let llvm_config_bin = builder.ensure(native::Llvm { target: target_compiler.host });
1244 if !builder.config.dry_run {
1245 let llvm_bin_dir = output(Command::new(llvm_config_bin).arg("--bindir"));
1246 let llvm_bin_dir = Path::new(llvm_bin_dir.trim());
1248 // Since we've already built the LLVM tools, install them to the sysroot.
1249 // This is the equivalent of installing the `llvm-tools-preview` component via
1250 // rustup, and lets developers use a locally built toolchain to
1251 // build projects that expect llvm tools to be present in the sysroot
1252 // (e.g. the `bootimage` crate).
1253 for tool in LLVM_TOOLS {
1254 let tool_exe = exe(tool, target_compiler.host);
1255 let src_path = llvm_bin_dir.join(&tool_exe);
1256 // When using `download-ci-llvm`, some of the tools
1257 // may not exist, so skip trying to copy them.
1258 if src_path.exists() {
1259 builder.copy(&src_path, &libdir_bin.join(&tool_exe));
1265 // Ensure that `libLLVM.so` ends up in the newly build compiler directory,
1266 // so that it can be found when the newly built `rustc` is run.
1267 dist::maybe_install_llvm_runtime(builder, target_compiler.host, &sysroot);
1268 dist::maybe_install_llvm_target(builder, target_compiler.host, &sysroot);
1270 // Link the compiler binary itself into place
1271 let out_dir = builder.cargo_out(build_compiler, Mode::Rustc, host);
1272 let rustc = out_dir.join(exe("rustc-main", host));
1273 let bindir = sysroot.join("bin");
1274 t!(fs::create_dir_all(&bindir));
1275 let compiler = builder.rustc(target_compiler);
1276 builder.copy(&rustc, &compiler);
1282 /// Link some files into a rustc sysroot.
1284 /// For a particular stage this will link the file listed in `stamp` into the
1285 /// `sysroot_dst` provided.
1286 pub fn add_to_sysroot(
1287 builder: &Builder<'_>,
1289 sysroot_host_dst: &Path,
1292 let self_contained_dst = &sysroot_dst.join("self-contained");
1293 t!(fs::create_dir_all(&sysroot_dst));
1294 t!(fs::create_dir_all(&sysroot_host_dst));
1295 t!(fs::create_dir_all(&self_contained_dst));
1296 for (path, dependency_type) in builder.read_stamp_file(stamp) {
1297 let dst = match dependency_type {
1298 DependencyType::Host => sysroot_host_dst,
1299 DependencyType::Target => sysroot_dst,
1300 DependencyType::TargetSelfContained => self_contained_dst,
1302 builder.copy(&path, &dst.join(path.file_name().unwrap()));
1307 builder: &Builder<'_>,
1309 tail_args: Vec<String>,
1311 additional_target_deps: Vec<(PathBuf, DependencyType)>,
1314 if builder.config.dry_run {
1318 // `target_root_dir` looks like $dir/$target/release
1319 let target_root_dir = stamp.parent().unwrap();
1320 // `target_deps_dir` looks like $dir/$target/release/deps
1321 let target_deps_dir = target_root_dir.join("deps");
1322 // `host_root_dir` looks like $dir/release
1323 let host_root_dir = target_root_dir
1325 .unwrap() // chop off `release`
1327 .unwrap() // chop off `$target`
1328 .join(target_root_dir.file_name().unwrap());
1330 // Spawn Cargo slurping up its JSON output. We'll start building up the
1331 // `deps` array of all files it generated along with a `toplevel` array of
1332 // files we need to probe for later.
1333 let mut deps = Vec::new();
1334 let mut toplevel = Vec::new();
1335 let ok = stream_cargo(builder, cargo, tail_args, &mut |msg| {
1336 let (filenames, crate_types) = match msg {
1337 CargoMessage::CompilerArtifact {
1339 target: CargoTarget { crate_types },
1341 } => (filenames, crate_types),
1344 for filename in filenames {
1345 // Skip files like executables
1346 if !(filename.ends_with(".rlib")
1347 || filename.ends_with(".lib")
1348 || filename.ends_with(".a")
1349 || is_debug_info(&filename)
1350 || is_dylib(&filename)
1351 || (is_check && filename.ends_with(".rmeta")))
1356 let filename = Path::new(&*filename);
1358 // If this was an output file in the "host dir" we don't actually
1359 // worry about it, it's not relevant for us
1360 if filename.starts_with(&host_root_dir) {
1361 // Unless it's a proc macro used in the compiler
1362 if crate_types.iter().any(|t| t == "proc-macro") {
1363 deps.push((filename.to_path_buf(), DependencyType::Host));
1368 // If this was output in the `deps` dir then this is a precise file
1369 // name (hash included) so we start tracking it.
1370 if filename.starts_with(&target_deps_dir) {
1371 deps.push((filename.to_path_buf(), DependencyType::Target));
1375 // Otherwise this was a "top level artifact" which right now doesn't
1376 // have a hash in the name, but there's a version of this file in
1377 // the `deps` folder which *does* have a hash in the name. That's
1378 // the one we'll want to we'll probe for it later.
1380 // We do not use `Path::file_stem` or `Path::extension` here,
1381 // because some generated files may have multiple extensions e.g.
1382 // `std-<hash>.dll.lib` on Windows. The aforementioned methods only
1383 // split the file name by the last extension (`.lib`) while we need
1384 // to split by all extensions (`.dll.lib`).
1385 let expected_len = t!(filename.metadata()).len();
1386 let filename = filename.file_name().unwrap().to_str().unwrap();
1387 let mut parts = filename.splitn(2, '.');
1388 let file_stem = parts.next().unwrap().to_owned();
1389 let extension = parts.next().unwrap().to_owned();
1391 toplevel.push((file_stem, extension, expected_len));
1396 crate::detail_exit(1);
1399 // Ok now we need to actually find all the files listed in `toplevel`. We've
1400 // got a list of prefix/extensions and we basically just need to find the
1401 // most recent file in the `deps` folder corresponding to each one.
1402 let contents = t!(target_deps_dir.read_dir())
1404 .map(|e| (e.path(), e.file_name().into_string().unwrap(), t!(e.metadata())))
1405 .collect::<Vec<_>>();
1406 for (prefix, extension, expected_len) in toplevel {
1407 let candidates = contents.iter().filter(|&&(_, ref filename, ref meta)| {
1408 meta.len() == expected_len
1410 .strip_prefix(&prefix[..])
1411 .map(|s| s.starts_with('-') && s.ends_with(&extension[..]))
1414 let max = candidates.max_by_key(|&&(_, _, ref metadata)| {
1415 metadata.modified().expect("mtime should be available on all relevant OSes")
1417 let path_to_add = match max {
1418 Some(triple) => triple.0.to_str().unwrap(),
1419 None => panic!("no output generated for {:?} {:?}", prefix, extension),
1421 if is_dylib(path_to_add) {
1422 let candidate = format!("{}.lib", path_to_add);
1423 let candidate = PathBuf::from(candidate);
1424 if candidate.exists() {
1425 deps.push((candidate, DependencyType::Target));
1428 deps.push((path_to_add.into(), DependencyType::Target));
1431 deps.extend(additional_target_deps);
1433 let mut new_contents = Vec::new();
1434 for (dep, dependency_type) in deps.iter() {
1435 new_contents.extend(match *dependency_type {
1436 DependencyType::Host => b"h",
1437 DependencyType::Target => b"t",
1438 DependencyType::TargetSelfContained => b"s",
1440 new_contents.extend(dep.to_str().unwrap().as_bytes());
1441 new_contents.extend(b"\0");
1443 t!(fs::write(&stamp, &new_contents));
1444 deps.into_iter().map(|(d, _)| d).collect()
1447 pub fn stream_cargo(
1448 builder: &Builder<'_>,
1450 tail_args: Vec<String>,
1451 cb: &mut dyn FnMut(CargoMessage<'_>),
1453 let mut cargo = Command::from(cargo);
1454 if builder.config.dry_run {
1457 // Instruct Cargo to give us json messages on stdout, critically leaving
1458 // stderr as piped so we can get those pretty colors.
1459 let mut message_format = if builder.config.json_output {
1460 String::from("json")
1462 String::from("json-render-diagnostics")
1464 if let Some(s) = &builder.config.rustc_error_format {
1465 message_format.push_str(",json-diagnostic-");
1466 message_format.push_str(s);
1468 cargo.arg("--message-format").arg(message_format).stdout(Stdio::piped());
1470 for arg in tail_args {
1474 builder.verbose(&format!("running: {:?}", cargo));
1475 let mut child = match cargo.spawn() {
1477 Err(e) => panic!("failed to execute command: {:?}\nerror: {}", cargo, e),
1480 // Spawn Cargo slurping up its JSON output. We'll start building up the
1481 // `deps` array of all files it generated along with a `toplevel` array of
1482 // files we need to probe for later.
1483 let stdout = BufReader::new(child.stdout.take().unwrap());
1484 for line in stdout.lines() {
1485 let line = t!(line);
1486 match serde_json::from_str::<CargoMessage<'_>>(&line) {
1488 if builder.config.json_output {
1489 // Forward JSON to stdout.
1490 println!("{}", line);
1494 // If this was informational, just print it out and continue
1495 Err(_) => println!("{}", line),
1499 // Make sure Cargo actually succeeded after we read all of its stdout.
1500 let status = t!(child.wait());
1501 if builder.is_verbose() && !status.success() {
1503 "command did not execute successfully: {:?}\n\
1504 expected success, got: {}",
1511 #[derive(Deserialize)]
1512 pub struct CargoTarget<'a> {
1513 crate_types: Vec<Cow<'a, str>>,
1516 #[derive(Deserialize)]
1517 #[serde(tag = "reason", rename_all = "kebab-case")]
1518 pub enum CargoMessage<'a> {
1520 package_id: Cow<'a, str>,
1521 features: Vec<Cow<'a, str>>,
1522 filenames: Vec<Cow<'a, str>>,
1523 target: CargoTarget<'a>,
1525 BuildScriptExecuted {
1526 package_id: Cow<'a, str>,