1 //! Implementation of compiling various phases of the compiler and standard
4 //! This module contains some of the real meat in the rustbuild build system
5 //! which is where Cargo is used to compiler the standard library, libtest, and
6 //! compiler. This module is also responsible for assembling the sysroot as it
7 //! goes along from the output of the previous stage.
12 use std::io::prelude::*;
13 use std::io::BufReader;
14 use std::path::{Path, PathBuf};
15 use std::process::{exit, Command, Stdio};
18 use build_helper::{output, t, up_to_date};
19 use filetime::FileTime;
20 use serde::Deserialize;
22 use crate::builder::Cargo;
23 use crate::builder::{Builder, Kind, RunConfig, ShouldRun, Step};
24 use crate::cache::{Interned, INTERNER};
25 use crate::config::TargetSelection;
28 use crate::tool::SourceType;
29 use crate::util::{exe, is_dylib, symlink_dir};
30 use crate::{Compiler, DependencyType, GitRepo, Mode};
32 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
34 pub target: TargetSelection,
35 pub compiler: Compiler,
40 const DEFAULT: bool = true;
42 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
43 run.all_krates("test")
46 fn make_run(run: RunConfig<'_>) {
47 run.builder.ensure(Std {
48 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
53 /// Builds the standard library.
55 /// This will build the standard library for a particular stage of the build
56 /// using the `compiler` targeting the `target` architecture. The artifacts
57 /// created will also be linked into the sysroot directory.
58 fn run(self, builder: &Builder<'_>) {
59 let target = self.target;
60 let compiler = self.compiler;
62 if builder.config.keep_stage.contains(&compiler.stage)
63 || builder.config.keep_stage_std.contains(&compiler.stage)
65 builder.info("Warning: Using a potentially old libstd. This may not behave well.");
66 builder.ensure(StdLink { compiler, target_compiler: compiler, target });
70 let mut target_deps = builder.ensure(StartupObjects { compiler, target });
72 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
73 if compiler_to_use != compiler {
74 builder.ensure(Std { compiler: compiler_to_use, target });
75 builder.info(&format!("Uplifting stage1 std ({} -> {})", compiler_to_use.host, target));
77 // Even if we're not building std this stage, the new sysroot must
78 // still contain the third party objects needed by various targets.
79 copy_third_party_objects(builder, &compiler, target);
80 copy_self_contained_objects(builder, &compiler, target);
82 builder.ensure(StdLink {
83 compiler: compiler_to_use,
84 target_compiler: compiler,
90 target_deps.extend(copy_third_party_objects(builder, &compiler, target));
91 target_deps.extend(copy_self_contained_objects(builder, &compiler, target));
93 let mut cargo = builder.cargo(compiler, Mode::Std, SourceType::InTree, target, "build");
94 std_cargo(builder, target, compiler.stage, &mut cargo);
96 builder.info(&format!(
97 "Building stage{} std artifacts ({} -> {})",
98 compiler.stage, &compiler.host, target
104 &libstd_stamp(builder, compiler, target),
109 builder.ensure(StdLink {
110 compiler: builder.compiler(compiler.stage, builder.config.build),
111 target_compiler: compiler,
118 builder: &Builder<'_>,
122 target_deps: &mut Vec<(PathBuf, DependencyType)>,
123 dependency_type: DependencyType,
125 let target = libdir.join(name);
126 builder.copy(&sourcedir.join(name), &target);
128 target_deps.push((target, dependency_type));
131 /// Copies third party objects needed by various targets.
132 fn copy_third_party_objects(
133 builder: &Builder<'_>,
135 target: TargetSelection,
136 ) -> Vec<(PathBuf, DependencyType)> {
137 let mut target_deps = vec![];
139 // FIXME: remove this in 2021
140 if target == "x86_64-fortanix-unknown-sgx" {
141 if env::var_os("X86_FORTANIX_SGX_LIBS").is_some() {
142 builder.info("Warning: X86_FORTANIX_SGX_LIBS environment variable is ignored, libunwind is now compiled as part of rustbuild");
146 if builder.config.sanitizers && compiler.stage != 0 {
147 // The sanitizers are only copied in stage1 or above,
148 // to avoid creating dependency on LLVM.
150 copy_sanitizers(builder, &compiler, target)
152 .map(|d| (d, DependencyType::Target)),
159 /// Copies third party objects needed by various targets for self-contained linkage.
160 fn copy_self_contained_objects(
161 builder: &Builder<'_>,
163 target: TargetSelection,
164 ) -> Vec<(PathBuf, DependencyType)> {
165 let libdir_self_contained = builder.sysroot_libdir(*compiler, target).join("self-contained");
166 t!(fs::create_dir_all(&libdir_self_contained));
167 let mut target_deps = vec![];
169 // Copies the CRT objects.
171 // rustc historically provides a more self-contained installation for musl targets
172 // not requiring the presence of a native musl toolchain. For example, it can fall back
173 // to using gcc from a glibc-targeting toolchain for linking.
174 // To do that we have to distribute musl startup objects as a part of Rust toolchain
175 // and link with them manually in the self-contained mode.
176 if target.contains("musl") {
177 let srcdir = builder.musl_libdir(target).unwrap();
178 for &obj in &["crt1.o", "Scrt1.o", "rcrt1.o", "crti.o", "crtn.o"] {
181 &libdir_self_contained,
185 DependencyType::TargetSelfContained,
188 } else if target.ends_with("-wasi") {
189 let srcdir = builder.wasi_root(target).unwrap().join("lib/wasm32-wasi");
192 &libdir_self_contained,
196 DependencyType::TargetSelfContained,
198 } else if target.contains("windows-gnu") {
199 for obj in ["crt2.o", "dllcrt2.o"].iter() {
200 let src = compiler_file(builder, builder.cc(target), target, obj);
201 let target = libdir_self_contained.join(obj);
202 builder.copy(&src, &target);
203 target_deps.push((target, DependencyType::TargetSelfContained));
210 /// Configure cargo to compile the standard library, adding appropriate env vars
212 pub fn std_cargo(builder: &Builder<'_>, target: TargetSelection, stage: u32, cargo: &mut Cargo) {
213 if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
214 cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
217 // Determine if we're going to compile in optimized C intrinsics to
218 // the `compiler-builtins` crate. These intrinsics live in LLVM's
219 // `compiler-rt` repository, but our `src/llvm-project` submodule isn't
220 // always checked out, so we need to conditionally look for this. (e.g. if
221 // an external LLVM is used we skip the LLVM submodule checkout).
223 // Note that this shouldn't affect the correctness of `compiler-builtins`,
224 // but only its speed. Some intrinsics in C haven't been translated to Rust
225 // yet but that's pretty rare. Other intrinsics have optimized
226 // implementations in C which have only had slower versions ported to Rust,
227 // so we favor the C version where we can, but it's not critical.
229 // If `compiler-rt` is available ensure that the `c` feature of the
230 // `compiler-builtins` crate is enabled and it's configured to learn where
231 // `compiler-rt` is located.
232 let compiler_builtins_root = builder.src.join("src/llvm-project/compiler-rt");
233 let compiler_builtins_c_feature = if compiler_builtins_root.exists() {
234 // Note that `libprofiler_builtins/build.rs` also computes this so if
235 // you're changing something here please also change that.
236 cargo.env("RUST_COMPILER_RT_ROOT", &compiler_builtins_root);
237 " compiler-builtins-c"
242 if builder.no_std(target) == Some(true) {
243 let mut features = "compiler-builtins-mem".to_string();
244 features.push_str(compiler_builtins_c_feature);
246 // for no-std targets we only compile a few no_std crates
248 .args(&["-p", "alloc"])
249 .arg("--manifest-path")
250 .arg(builder.src.join("library/alloc/Cargo.toml"))
254 let mut features = builder.std_features();
255 features.push_str(compiler_builtins_c_feature);
260 .arg("--manifest-path")
261 .arg(builder.src.join("library/test/Cargo.toml"));
263 // Help the libc crate compile by assisting it in finding various
264 // sysroot native libraries.
265 if target.contains("musl") {
266 if let Some(p) = builder.musl_libdir(target) {
267 let root = format!("native={}", p.to_str().unwrap());
268 cargo.rustflag("-L").rustflag(&root);
272 if target.ends_with("-wasi") {
273 if let Some(p) = builder.wasi_root(target) {
274 let root = format!("native={}/lib/wasm32-wasi", p.to_str().unwrap());
275 cargo.rustflag("-L").rustflag(&root);
280 // By default, rustc uses `-Cembed-bitcode=yes`, and Cargo overrides that
281 // with `-Cembed-bitcode=no` for non-LTO builds. However, libstd must be
282 // built with bitcode so that the produced rlibs can be used for both LTO
283 // builds (which use bitcode) and non-LTO builds (which use object code).
284 // So we override the override here!
286 // But we don't bother for the stage 0 compiler because it's never used
289 cargo.rustflag("-Cembed-bitcode=yes");
292 // By default, rustc does not include unwind tables unless they are required
293 // for a particular target. They are not required by RISC-V targets, but
294 // compiling the standard library with them means that users can get
295 // backtraces without having to recompile the standard library themselves.
297 // This choice was discussed in https://github.com/rust-lang/rust/pull/69890
298 if target.contains("riscv") {
299 cargo.rustflag("-Cforce-unwind-tables=yes");
303 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
305 pub compiler: Compiler,
306 pub target_compiler: Compiler,
307 pub target: TargetSelection,
310 impl Step for StdLink {
313 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
317 /// Link all libstd rlibs/dylibs into the sysroot location.
319 /// Links those artifacts generated by `compiler` to the `stage` compiler's
320 /// sysroot for the specified `host` and `target`.
322 /// Note that this assumes that `compiler` has already generated the libstd
323 /// libraries for `target`, and this method will find them in the relevant
324 /// output directory.
325 fn run(self, builder: &Builder<'_>) {
326 let compiler = self.compiler;
327 let target_compiler = self.target_compiler;
328 let target = self.target;
329 builder.info(&format!(
330 "Copying stage{} std from stage{} ({} -> {} / {})",
331 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
333 let libdir = builder.sysroot_libdir(target_compiler, target);
334 let hostdir = builder.sysroot_libdir(target_compiler, compiler.host);
335 add_to_sysroot(builder, &libdir, &hostdir, &libstd_stamp(builder, compiler, target));
339 /// Copies sanitizer runtime libraries into target libdir.
341 builder: &Builder<'_>,
343 target: TargetSelection,
345 let runtimes: Vec<native::SanitizerRuntime> = builder.ensure(native::Sanitizers { target });
347 if builder.config.dry_run {
351 let mut target_deps = Vec::new();
352 let libdir = builder.sysroot_libdir(*compiler, target);
354 for runtime in &runtimes {
355 let dst = libdir.join(&runtime.name);
356 builder.copy(&runtime.path, &dst);
358 if target == "x86_64-apple-darwin" {
359 // Update the library install name reflect the fact it has been renamed.
360 let status = Command::new("install_name_tool")
362 .arg(format!("@rpath/{}", runtime.name))
365 .expect("failed to execute `install_name_tool`");
366 assert!(status.success());
369 target_deps.push(dst);
375 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
376 pub struct StartupObjects {
377 pub compiler: Compiler,
378 pub target: TargetSelection,
381 impl Step for StartupObjects {
382 type Output = Vec<(PathBuf, DependencyType)>;
384 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
385 run.path("library/rtstartup")
388 fn make_run(run: RunConfig<'_>) {
389 run.builder.ensure(StartupObjects {
390 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
395 /// Builds and prepare startup objects like rsbegin.o and rsend.o
397 /// These are primarily used on Windows right now for linking executables/dlls.
398 /// They don't require any library support as they're just plain old object
399 /// files, so we just use the nightly snapshot compiler to always build them (as
400 /// no other compilers are guaranteed to be available).
401 fn run(self, builder: &Builder<'_>) -> Vec<(PathBuf, DependencyType)> {
402 let for_compiler = self.compiler;
403 let target = self.target;
404 if !target.contains("windows-gnu") {
408 let mut target_deps = vec![];
410 let src_dir = &builder.src.join("library").join("rtstartup");
411 let dst_dir = &builder.native_dir(target).join("rtstartup");
412 let sysroot_dir = &builder.sysroot_libdir(for_compiler, target);
413 t!(fs::create_dir_all(dst_dir));
415 for file in &["rsbegin", "rsend"] {
416 let src_file = &src_dir.join(file.to_string() + ".rs");
417 let dst_file = &dst_dir.join(file.to_string() + ".o");
418 if !up_to_date(src_file, dst_file) {
419 let mut cmd = Command::new(&builder.initial_rustc);
421 cmd.env("RUSTC_BOOTSTRAP", "1")
425 .arg(target.rustc_target_arg())
433 let target = sysroot_dir.join((*file).to_string() + ".o");
434 builder.copy(dst_file, &target);
435 target_deps.push((target, DependencyType::Target));
442 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
444 pub target: TargetSelection,
445 pub compiler: Compiler,
448 impl Step for Rustc {
450 const ONLY_HOSTS: bool = true;
451 const DEFAULT: bool = false;
453 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
454 run.path("compiler/rustc")
457 fn make_run(run: RunConfig<'_>) {
458 run.builder.ensure(Rustc {
459 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
464 /// Builds the compiler.
466 /// This will build the compiler for a particular stage of the build using
467 /// the `compiler` targeting the `target` architecture. The artifacts
468 /// created will also be linked into the sysroot directory.
469 fn run(self, builder: &Builder<'_>) {
470 let compiler = self.compiler;
471 let target = self.target;
473 builder.ensure(Std { compiler, target });
475 if builder.config.keep_stage.contains(&compiler.stage) {
476 builder.info("Warning: Using a potentially old librustc. This may not behave well.");
477 builder.info("Warning: Use `--keep-stage-std` if you want to rebuild the compiler when it changes");
478 builder.ensure(RustcLink { compiler, target_compiler: compiler, target });
482 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
483 if compiler_to_use != compiler {
484 builder.ensure(Rustc { compiler: compiler_to_use, target });
486 .info(&format!("Uplifting stage1 rustc ({} -> {})", builder.config.build, target));
487 builder.ensure(RustcLink {
488 compiler: compiler_to_use,
489 target_compiler: compiler,
495 // Ensure that build scripts and proc macros have a std / libproc_macro to link against.
497 compiler: builder.compiler(self.compiler.stage, builder.config.build),
498 target: builder.config.build,
501 let mut cargo = builder.cargo(compiler, Mode::Rustc, SourceType::InTree, target, "build");
502 rustc_cargo(builder, &mut cargo, target);
504 builder.info(&format!(
505 "Building stage{} compiler artifacts ({} -> {})",
506 compiler.stage, &compiler.host, target
512 &librustc_stamp(builder, compiler, target),
517 builder.ensure(RustcLink {
518 compiler: builder.compiler(compiler.stage, builder.config.build),
519 target_compiler: compiler,
525 pub fn rustc_cargo(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
528 .arg(builder.rustc_features())
529 .arg("--manifest-path")
530 .arg(builder.src.join("compiler/rustc/Cargo.toml"));
531 rustc_cargo_env(builder, cargo, target);
534 pub fn rustc_cargo_env(builder: &Builder<'_>, cargo: &mut Cargo, target: TargetSelection) {
535 // Set some configuration variables picked up by build scripts and
536 // the compiler alike
538 .env("CFG_RELEASE", builder.rust_release())
539 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
540 .env("CFG_VERSION", builder.rust_version())
541 .env("CFG_PREFIX", builder.config.prefix.clone().unwrap_or_default());
543 let libdir_relative = builder.config.libdir_relative().unwrap_or_else(|| Path::new("lib"));
544 cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
546 if let Some(ref ver_date) = builder.rust_info.commit_date() {
547 cargo.env("CFG_VER_DATE", ver_date);
549 if let Some(ref ver_hash) = builder.rust_info.sha() {
550 cargo.env("CFG_VER_HASH", ver_hash);
552 if !builder.unstable_features() {
553 cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
555 if let Some(ref s) = builder.config.rustc_default_linker {
556 cargo.env("CFG_DEFAULT_LINKER", s);
558 if builder.config.rustc_parallel {
559 cargo.rustflag("--cfg=parallel_compiler");
561 if builder.config.rust_verify_llvm_ir {
562 cargo.env("RUSTC_VERIFY_LLVM_IR", "1");
565 // Pass down configuration from the LLVM build into the build of
566 // rustc_llvm and rustc_codegen_llvm.
568 // Note that this is disabled if LLVM itself is disabled or we're in a check
569 // build. If we are in a check build we still go ahead here presuming we've
570 // detected that LLVM is alreay built and good to go which helps prevent
571 // busting caches (e.g. like #71152).
572 if builder.config.llvm_enabled()
573 && (builder.kind != Kind::Check
574 || crate::native::prebuilt_llvm_config(builder, target).is_ok())
576 if builder.is_rust_llvm(target) {
577 cargo.env("LLVM_RUSTLLVM", "1");
579 let llvm_config = builder.ensure(native::Llvm { target });
580 cargo.env("LLVM_CONFIG", &llvm_config);
581 let target_config = builder.config.target_config.get(&target);
582 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
583 cargo.env("CFG_LLVM_ROOT", s);
585 // Some LLVM linker flags (-L and -l) may be needed to link rustc_llvm.
586 if let Some(ref s) = builder.config.llvm_ldflags {
587 cargo.env("LLVM_LINKER_FLAGS", s);
589 // Building with a static libstdc++ is only supported on linux right now,
590 // not for MSVC or macOS
591 if builder.config.llvm_static_stdcpp
592 && !target.contains("freebsd")
593 && !target.contains("msvc")
594 && !target.contains("apple")
596 let file = compiler_file(builder, builder.cxx(target).unwrap(), target, "libstdc++.a");
597 cargo.env("LLVM_STATIC_STDCPP", file);
599 if builder.config.llvm_link_shared {
600 cargo.env("LLVM_LINK_SHARED", "1");
602 if builder.config.llvm_use_libcxx {
603 cargo.env("LLVM_USE_LIBCXX", "1");
605 if builder.config.llvm_optimize && !builder.config.llvm_release_debuginfo {
606 cargo.env("LLVM_NDEBUG", "1");
611 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
613 pub compiler: Compiler,
614 pub target_compiler: Compiler,
615 pub target: TargetSelection,
618 impl Step for RustcLink {
621 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
625 /// Same as `std_link`, only for librustc
626 fn run(self, builder: &Builder<'_>) {
627 let compiler = self.compiler;
628 let target_compiler = self.target_compiler;
629 let target = self.target;
630 builder.info(&format!(
631 "Copying stage{} rustc from stage{} ({} -> {} / {})",
632 target_compiler.stage, compiler.stage, &compiler.host, target_compiler.host, target
636 &builder.sysroot_libdir(target_compiler, target),
637 &builder.sysroot_libdir(target_compiler, compiler.host),
638 &librustc_stamp(builder, compiler, target),
643 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
644 pub struct CodegenBackend {
645 pub target: TargetSelection,
646 pub compiler: Compiler,
647 pub backend: Interned<String>,
650 impl Step for CodegenBackend {
652 const ONLY_HOSTS: bool = true;
653 // Only the backends specified in the `codegen-backends` entry of `config.toml` are built.
654 const DEFAULT: bool = true;
656 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
657 run.path("compiler/rustc_codegen_cranelift")
660 fn make_run(run: RunConfig<'_>) {
661 for &backend in &run.builder.config.rust_codegen_backends {
662 if backend == "llvm" {
663 continue; // Already built as part of rustc
666 run.builder.ensure(CodegenBackend {
668 compiler: run.builder.compiler(run.builder.top_stage, run.build_triple()),
674 fn run(self, builder: &Builder<'_>) {
675 let compiler = self.compiler;
676 let target = self.target;
677 let backend = self.backend;
679 builder.ensure(Rustc { compiler, target });
681 if builder.config.keep_stage.contains(&compiler.stage) {
683 "Warning: Using a potentially old codegen backend. \
684 This may not behave well.",
686 // Codegen backends are linked separately from this step today, so we don't do
691 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
692 if compiler_to_use != compiler {
693 builder.ensure(CodegenBackend { compiler: compiler_to_use, target, backend });
697 let out_dir = builder.cargo_out(compiler, Mode::Codegen, target);
700 builder.cargo(compiler, Mode::Codegen, SourceType::Submodule, target, "build");
702 .arg("--manifest-path")
703 .arg(builder.src.join(format!("compiler/rustc_codegen_{}/Cargo.toml", backend)));
704 rustc_cargo_env(builder, &mut cargo, target);
706 let tmp_stamp = out_dir.join(".tmp.stamp");
708 let files = run_cargo(builder, cargo, vec![], &tmp_stamp, vec![], false);
709 if builder.config.dry_run {
712 let mut files = files.into_iter().filter(|f| {
713 let filename = f.file_name().unwrap().to_str().unwrap();
714 is_dylib(filename) && filename.contains("rustc_codegen_")
716 let codegen_backend = match files.next() {
718 None => panic!("no dylibs built for codegen backend?"),
720 if let Some(f) = files.next() {
722 "codegen backend built two dylibs:\n{}\n{}",
723 codegen_backend.display(),
727 let stamp = codegen_backend_stamp(builder, compiler, target, backend);
728 let codegen_backend = codegen_backend.to_str().unwrap();
729 t!(fs::write(&stamp, &codegen_backend));
733 /// Creates the `codegen-backends` folder for a compiler that's about to be
734 /// assembled as a complete compiler.
736 /// This will take the codegen artifacts produced by `compiler` and link them
737 /// into an appropriate location for `target_compiler` to be a functional
739 fn copy_codegen_backends_to_sysroot(
740 builder: &Builder<'_>,
742 target_compiler: Compiler,
744 let target = target_compiler.host;
746 // Note that this step is different than all the other `*Link` steps in
747 // that it's not assembling a bunch of libraries but rather is primarily
748 // moving the codegen backend into place. The codegen backend of rustc is
749 // not linked into the main compiler by default but is rather dynamically
750 // selected at runtime for inclusion.
752 // Here we're looking for the output dylib of the `CodegenBackend` step and
753 // we're copying that into the `codegen-backends` folder.
754 let dst = builder.sysroot_codegen_backends(target_compiler);
755 t!(fs::create_dir_all(&dst));
757 if builder.config.dry_run {
761 for backend in builder.config.rust_codegen_backends.iter() {
762 if backend == "llvm" {
763 continue; // Already built as part of rustc
766 let stamp = codegen_backend_stamp(builder, compiler, target, *backend);
767 let dylib = t!(fs::read_to_string(&stamp));
768 let file = Path::new(&dylib);
769 let filename = file.file_name().unwrap().to_str().unwrap();
770 // change `librustc_codegen_cranelift-xxxxxx.so` to
771 // `librustc_codegen_cranelift-release.so`
772 let target_filename = {
773 let dash = filename.find('-').unwrap();
774 let dot = filename.find('.').unwrap();
775 format!("{}-{}{}", &filename[..dash], builder.rust_release(), &filename[dot..])
777 builder.copy(&file, &dst.join(target_filename));
781 /// Cargo's output path for the standard library in a given stage, compiled
782 /// by a particular compiler for the specified target.
783 pub fn libstd_stamp(builder: &Builder<'_>, compiler: Compiler, target: TargetSelection) -> PathBuf {
784 builder.cargo_out(compiler, Mode::Std, target).join(".libstd.stamp")
787 /// Cargo's output path for librustc in a given stage, compiled by a particular
788 /// compiler for the specified target.
789 pub fn librustc_stamp(
790 builder: &Builder<'_>,
792 target: TargetSelection,
794 builder.cargo_out(compiler, Mode::Rustc, target).join(".librustc.stamp")
797 /// Cargo's output path for librustc_codegen_llvm in a given stage, compiled by a particular
798 /// compiler for the specified target and backend.
799 fn codegen_backend_stamp(
800 builder: &Builder<'_>,
802 target: TargetSelection,
803 backend: Interned<String>,
806 .cargo_out(compiler, Mode::Codegen, target)
807 .join(format!(".librustc_codegen_{}.stamp", backend))
810 pub fn compiler_file(
811 builder: &Builder<'_>,
813 target: TargetSelection,
816 let mut cmd = Command::new(compiler);
817 cmd.args(builder.cflags(target, GitRepo::Rustc));
818 cmd.arg(format!("-print-file-name={}", file));
819 let out = output(&mut cmd);
820 PathBuf::from(out.trim())
823 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
825 pub compiler: Compiler,
828 impl Step for Sysroot {
829 type Output = Interned<PathBuf>;
831 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
835 /// Returns the sysroot for the `compiler` specified that *this build system
838 /// That is, the sysroot for the stage0 compiler is not what the compiler
839 /// thinks it is by default, but it's the same as the default for stages
841 fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
842 let compiler = self.compiler;
843 let sysroot = if compiler.stage == 0 {
844 builder.out.join(&compiler.host.triple).join("stage0-sysroot")
846 builder.out.join(&compiler.host.triple).join(format!("stage{}", compiler.stage))
848 let _ = fs::remove_dir_all(&sysroot);
849 t!(fs::create_dir_all(&sysroot));
851 // Symlink the source root into the same location inside the sysroot,
852 // where `rust-src` component would go (`$sysroot/lib/rustlib/src/rust`),
853 // so that any tools relying on `rust-src` also work for local builds,
854 // and also for translating the virtual `/rustc/$hash` back to the real
855 // directory (for running tests with `rust.remap-debuginfo = true`).
856 let sysroot_lib_rustlib_src = sysroot.join("lib/rustlib/src");
857 t!(fs::create_dir_all(&sysroot_lib_rustlib_src));
858 let sysroot_lib_rustlib_src_rust = sysroot_lib_rustlib_src.join("rust");
859 if let Err(e) = symlink_dir(&builder.config, &builder.src, &sysroot_lib_rustlib_src_rust) {
861 "warning: creating symbolic link `{}` to `{}` failed with {}",
862 sysroot_lib_rustlib_src_rust.display(),
863 builder.src.display(),
866 if builder.config.rust_remap_debuginfo {
868 "warning: some `src/test/ui` tests will fail when lacking `{}`",
869 sysroot_lib_rustlib_src_rust.display(),
874 INTERNER.intern_path(sysroot)
878 #[derive(Debug, Copy, PartialOrd, Ord, Clone, PartialEq, Eq, Hash)]
879 pub struct Assemble {
880 /// The compiler which we will produce in this step. Assemble itself will
881 /// take care of ensuring that the necessary prerequisites to do so exist,
882 /// that is, this target can be a stage2 compiler and Assemble will build
883 /// previous stages for you.
884 pub target_compiler: Compiler,
887 impl Step for Assemble {
888 type Output = Compiler;
890 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
894 /// Prepare a new compiler from the artifacts in `stage`
896 /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
897 /// must have been previously produced by the `stage - 1` builder.build
899 fn run(self, builder: &Builder<'_>) -> Compiler {
900 let target_compiler = self.target_compiler;
902 if target_compiler.stage == 0 {
904 builder.config.build, target_compiler.host,
905 "Cannot obtain compiler for non-native build triple at stage 0"
907 // The stage 0 compiler for the build triple is always pre-built.
908 return target_compiler;
911 // Get the compiler that we'll use to bootstrap ourselves.
913 // Note that this is where the recursive nature of the bootstrap
914 // happens, as this will request the previous stage's compiler on
915 // downwards to stage 0.
917 // Also note that we're building a compiler for the host platform. We
918 // only assume that we can run `build` artifacts, which means that to
919 // produce some other architecture compiler we need to start from
920 // `build` to get there.
922 // FIXME: Perhaps we should download those libraries?
923 // It would make builds faster...
925 // FIXME: It may be faster if we build just a stage 1 compiler and then
926 // use that to bootstrap this compiler forward.
927 let build_compiler = builder.compiler(target_compiler.stage - 1, builder.config.build);
929 // Build the libraries for this compiler to link to (i.e., the libraries
930 // it uses at runtime). NOTE: Crates the target compiler compiles don't
931 // link to these. (FIXME: Is that correct? It seems to be correct most
932 // of the time but I think we do link to these for stage2/bin compilers
933 // when not performing a full bootstrap).
934 builder.ensure(Rustc { compiler: build_compiler, target: target_compiler.host });
936 for &backend in builder.config.rust_codegen_backends.iter() {
937 if backend == "llvm" {
938 continue; // Already built as part of rustc
941 builder.ensure(CodegenBackend {
942 compiler: build_compiler,
943 target: target_compiler.host,
948 let lld_install = if builder.config.lld_enabled {
949 Some(builder.ensure(native::Lld { target: target_compiler.host }))
954 let stage = target_compiler.stage;
955 let host = target_compiler.host;
956 builder.info(&format!("Assembling stage{} compiler ({})", stage, host));
958 // Link in all dylibs to the libdir
959 let sysroot = builder.sysroot(target_compiler);
960 let rustc_libdir = builder.rustc_libdir(target_compiler);
961 t!(fs::create_dir_all(&rustc_libdir));
962 let src_libdir = builder.sysroot_libdir(build_compiler, host);
963 for f in builder.read_dir(&src_libdir) {
964 let filename = f.file_name().into_string().unwrap();
965 if is_dylib(&filename) {
966 builder.copy(&f.path(), &rustc_libdir.join(&filename));
970 copy_codegen_backends_to_sysroot(builder, build_compiler, target_compiler);
972 let libdir = builder.sysroot_libdir(target_compiler, target_compiler.host);
973 if let Some(lld_install) = lld_install {
974 let src_exe = exe("lld", target_compiler.host);
975 let dst_exe = exe("rust-lld", target_compiler.host);
976 // we prepend this bin directory to the user PATH when linking Rust binaries. To
977 // avoid shadowing the system LLD we rename the LLD we provide to `rust-lld`.
978 let dst = libdir.parent().unwrap().join("bin");
979 t!(fs::create_dir_all(&dst));
980 builder.copy(&lld_install.join("bin").join(&src_exe), &dst.join(&dst_exe));
983 // Ensure that `libLLVM.so` ends up in the newly build compiler directory,
984 // so that it can be found when the newly built `rustc` is run.
985 dist::maybe_install_llvm_runtime(builder, target_compiler.host, &sysroot);
986 dist::maybe_install_llvm_target(builder, target_compiler.host, &sysroot);
988 // Link the compiler binary itself into place
989 let out_dir = builder.cargo_out(build_compiler, Mode::Rustc, host);
990 let rustc = out_dir.join(exe("rustc-main", host));
991 let bindir = sysroot.join("bin");
992 t!(fs::create_dir_all(&bindir));
993 let compiler = builder.rustc(target_compiler);
994 builder.copy(&rustc, &compiler);
1000 /// Link some files into a rustc sysroot.
1002 /// For a particular stage this will link the file listed in `stamp` into the
1003 /// `sysroot_dst` provided.
1004 pub fn add_to_sysroot(
1005 builder: &Builder<'_>,
1007 sysroot_host_dst: &Path,
1010 let self_contained_dst = &sysroot_dst.join("self-contained");
1011 t!(fs::create_dir_all(&sysroot_dst));
1012 t!(fs::create_dir_all(&sysroot_host_dst));
1013 t!(fs::create_dir_all(&self_contained_dst));
1014 for (path, dependency_type) in builder.read_stamp_file(stamp) {
1015 let dst = match dependency_type {
1016 DependencyType::Host => sysroot_host_dst,
1017 DependencyType::Target => sysroot_dst,
1018 DependencyType::TargetSelfContained => self_contained_dst,
1020 builder.copy(&path, &dst.join(path.file_name().unwrap()));
1025 builder: &Builder<'_>,
1027 tail_args: Vec<String>,
1029 additional_target_deps: Vec<(PathBuf, DependencyType)>,
1032 if builder.config.dry_run {
1036 // `target_root_dir` looks like $dir/$target/release
1037 let target_root_dir = stamp.parent().unwrap();
1038 // `target_deps_dir` looks like $dir/$target/release/deps
1039 let target_deps_dir = target_root_dir.join("deps");
1040 // `host_root_dir` looks like $dir/release
1041 let host_root_dir = target_root_dir
1043 .unwrap() // chop off `release`
1045 .unwrap() // chop off `$target`
1046 .join(target_root_dir.file_name().unwrap());
1048 // Spawn Cargo slurping up its JSON output. We'll start building up the
1049 // `deps` array of all files it generated along with a `toplevel` array of
1050 // files we need to probe for later.
1051 let mut deps = Vec::new();
1052 let mut toplevel = Vec::new();
1053 let ok = stream_cargo(builder, cargo, tail_args, &mut |msg| {
1054 let (filenames, crate_types) = match msg {
1055 CargoMessage::CompilerArtifact {
1057 target: CargoTarget { crate_types },
1059 } => (filenames, crate_types),
1062 for filename in filenames {
1063 // Skip files like executables
1064 if !(filename.ends_with(".rlib")
1065 || filename.ends_with(".lib")
1066 || filename.ends_with(".a")
1067 || is_dylib(&filename)
1068 || (is_check && filename.ends_with(".rmeta")))
1073 let filename = Path::new(&*filename);
1075 // If this was an output file in the "host dir" we don't actually
1076 // worry about it, it's not relevant for us
1077 if filename.starts_with(&host_root_dir) {
1078 // Unless it's a proc macro used in the compiler
1079 if crate_types.iter().any(|t| t == "proc-macro") {
1080 deps.push((filename.to_path_buf(), DependencyType::Host));
1085 // If this was output in the `deps` dir then this is a precise file
1086 // name (hash included) so we start tracking it.
1087 if filename.starts_with(&target_deps_dir) {
1088 deps.push((filename.to_path_buf(), DependencyType::Target));
1092 // Otherwise this was a "top level artifact" which right now doesn't
1093 // have a hash in the name, but there's a version of this file in
1094 // the `deps` folder which *does* have a hash in the name. That's
1095 // the one we'll want to we'll probe for it later.
1097 // We do not use `Path::file_stem` or `Path::extension` here,
1098 // because some generated files may have multiple extensions e.g.
1099 // `std-<hash>.dll.lib` on Windows. The aforementioned methods only
1100 // split the file name by the last extension (`.lib`) while we need
1101 // to split by all extensions (`.dll.lib`).
1102 let expected_len = t!(filename.metadata()).len();
1103 let filename = filename.file_name().unwrap().to_str().unwrap();
1104 let mut parts = filename.splitn(2, '.');
1105 let file_stem = parts.next().unwrap().to_owned();
1106 let extension = parts.next().unwrap().to_owned();
1108 toplevel.push((file_stem, extension, expected_len));
1116 // Ok now we need to actually find all the files listed in `toplevel`. We've
1117 // got a list of prefix/extensions and we basically just need to find the
1118 // most recent file in the `deps` folder corresponding to each one.
1119 let contents = t!(target_deps_dir.read_dir())
1121 .map(|e| (e.path(), e.file_name().into_string().unwrap(), t!(e.metadata())))
1122 .collect::<Vec<_>>();
1123 for (prefix, extension, expected_len) in toplevel {
1124 let candidates = contents.iter().filter(|&&(_, ref filename, ref meta)| {
1125 meta.len() == expected_len
1127 .strip_prefix(&prefix[..])
1128 .map(|s| s.starts_with('-') && s.ends_with(&extension[..]))
1131 let max = candidates
1132 .max_by_key(|&&(_, _, ref metadata)| FileTime::from_last_modification_time(metadata));
1133 let path_to_add = match max {
1134 Some(triple) => triple.0.to_str().unwrap(),
1135 None => panic!("no output generated for {:?} {:?}", prefix, extension),
1137 if is_dylib(path_to_add) {
1138 let candidate = format!("{}.lib", path_to_add);
1139 let candidate = PathBuf::from(candidate);
1140 if candidate.exists() {
1141 deps.push((candidate, DependencyType::Target));
1144 deps.push((path_to_add.into(), DependencyType::Target));
1147 deps.extend(additional_target_deps);
1149 let mut new_contents = Vec::new();
1150 for (dep, dependency_type) in deps.iter() {
1151 new_contents.extend(match *dependency_type {
1152 DependencyType::Host => b"h",
1153 DependencyType::Target => b"t",
1154 DependencyType::TargetSelfContained => b"s",
1156 new_contents.extend(dep.to_str().unwrap().as_bytes());
1157 new_contents.extend(b"\0");
1159 t!(fs::write(&stamp, &new_contents));
1160 deps.into_iter().map(|(d, _)| d).collect()
1163 pub fn stream_cargo(
1164 builder: &Builder<'_>,
1166 tail_args: Vec<String>,
1167 cb: &mut dyn FnMut(CargoMessage<'_>),
1169 let mut cargo = Command::from(cargo);
1170 if builder.config.dry_run {
1173 // Instruct Cargo to give us json messages on stdout, critically leaving
1174 // stderr as piped so we can get those pretty colors.
1175 let mut message_format = if builder.config.json_output {
1176 String::from("json")
1178 String::from("json-render-diagnostics")
1180 if let Some(s) = &builder.config.rustc_error_format {
1181 message_format.push_str(",json-diagnostic-");
1182 message_format.push_str(s);
1184 cargo.arg("--message-format").arg(message_format).stdout(Stdio::piped());
1186 for arg in tail_args {
1190 builder.verbose(&format!("running: {:?}", cargo));
1191 let mut child = match cargo.spawn() {
1193 Err(e) => panic!("failed to execute command: {:?}\nerror: {}", cargo, e),
1196 // Spawn Cargo slurping up its JSON output. We'll start building up the
1197 // `deps` array of all files it generated along with a `toplevel` array of
1198 // files we need to probe for later.
1199 let stdout = BufReader::new(child.stdout.take().unwrap());
1200 for line in stdout.lines() {
1201 let line = t!(line);
1202 match serde_json::from_str::<CargoMessage<'_>>(&line) {
1204 if builder.config.json_output {
1205 // Forward JSON to stdout.
1206 println!("{}", line);
1210 // If this was informational, just print it out and continue
1211 Err(_) => println!("{}", line),
1215 // Make sure Cargo actually succeeded after we read all of its stdout.
1216 let status = t!(child.wait());
1217 if !status.success() {
1219 "command did not execute successfully: {:?}\n\
1220 expected success, got: {}",
1227 #[derive(Deserialize)]
1228 pub struct CargoTarget<'a> {
1229 crate_types: Vec<Cow<'a, str>>,
1232 #[derive(Deserialize)]
1233 #[serde(tag = "reason", rename_all = "kebab-case")]
1234 pub enum CargoMessage<'a> {
1236 package_id: Cow<'a, str>,
1237 features: Vec<Cow<'a, str>>,
1238 filenames: Vec<Cow<'a, str>>,
1239 target: CargoTarget<'a>,
1241 BuildScriptExecuted {
1242 package_id: Cow<'a, str>,