1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Implementation of compiling various phases of the compiler and standard
14 //! This module contains some of the real meat in the rustbuild build system
15 //! which is where Cargo is used to compiler the standard library, libtest, and
16 //! compiler. This module is also responsible for assembling the sysroot as it
17 //! goes along from the output of the previous stage.
22 use std::io::BufReader;
23 use std::io::prelude::*;
24 use std::path::{Path, PathBuf};
25 use std::process::{Command, Stdio, exit};
28 use build_helper::{output, mtime, up_to_date};
29 use filetime::FileTime;
32 use crate::util::{exe, libdir, is_dylib};
33 use crate::{Compiler, Mode, GitRepo};
36 use crate::cache::{INTERNER, Interned};
37 use crate::builder::{Step, RunConfig, ShouldRun, Builder};
39 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
41 pub target: Interned<String>,
42 pub compiler: Compiler,
47 const DEFAULT: bool = true;
49 fn should_run(run: ShouldRun) -> ShouldRun {
53 fn make_run(run: RunConfig) {
54 run.builder.ensure(Std {
55 compiler: run.builder.compiler(run.builder.top_stage, run.host),
60 /// Build the standard library.
62 /// This will build the standard library for a particular stage of the build
63 /// using the `compiler` targeting the `target` architecture. The artifacts
64 /// created will also be linked into the sysroot directory.
65 fn run(self, builder: &Builder) {
66 let target = self.target;
67 let compiler = self.compiler;
69 if builder.config.keep_stage.contains(&compiler.stage) {
70 builder.info("Warning: Using a potentially old libstd. This may not behave well.");
71 builder.ensure(StdLink {
73 target_compiler: compiler,
79 builder.ensure(StartupObjects { compiler, target });
81 if builder.force_use_stage1(compiler, target) {
82 let from = builder.compiler(1, builder.config.build);
87 builder.info(&format!("Uplifting stage1 std ({} -> {})", from.host, target));
89 // Even if we're not building std this stage, the new sysroot must
90 // still contain the musl startup objects.
91 if target.contains("musl") {
92 let libdir = builder.sysroot_libdir(compiler, target);
93 copy_musl_third_party_objects(builder, target, &libdir);
96 builder.ensure(StdLink {
98 target_compiler: compiler,
104 if target.contains("musl") {
105 let libdir = builder.sysroot_libdir(compiler, target);
106 copy_musl_third_party_objects(builder, target, &libdir);
109 let mut cargo = builder.cargo(compiler, Mode::Std, target, "build");
110 std_cargo(builder, &compiler, target, &mut cargo);
112 let _folder = builder.fold_output(|| format!("stage{}-std", compiler.stage));
113 builder.info(&format!("Building stage{} std artifacts ({} -> {})", compiler.stage,
114 &compiler.host, target));
118 &libstd_stamp(builder, compiler, target),
121 builder.ensure(StdLink {
122 compiler: builder.compiler(compiler.stage, builder.config.build),
123 target_compiler: compiler,
129 /// Copies the crt(1,i,n).o startup objects
131 /// Since musl supports fully static linking, we can cross link for it even
132 /// with a glibc-targeting toolchain, given we have the appropriate startup
133 /// files. As those shipped with glibc won't work, copy the ones provided by
134 /// musl so we have them on linux-gnu hosts.
135 fn copy_musl_third_party_objects(builder: &Builder,
136 target: Interned<String>,
138 for &obj in &["crt1.o", "crti.o", "crtn.o"] {
139 builder.copy(&builder.musl_root(target).unwrap().join("lib").join(obj), &into.join(obj));
143 /// Configure cargo to compile the standard library, adding appropriate env vars
145 pub fn std_cargo(builder: &Builder,
147 target: Interned<String>,
148 cargo: &mut Command) {
149 if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
150 cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
153 if builder.no_std(target) == Some(true) {
154 // for no-std targets we only compile a few no_std crates
156 .args(&["-p", "alloc"])
157 .arg("--manifest-path")
158 .arg(builder.src.join("src/liballoc/Cargo.toml"))
160 .arg("compiler-builtins-mem");
162 let features = builder.std_features();
164 if compiler.stage != 0 && builder.config.sanitizers {
165 // This variable is used by the sanitizer runtime crates, e.g.
166 // rustc_lsan, to build the sanitizer runtime from C code
167 // When this variable is missing, those crates won't compile the C code,
168 // so we don't set this variable during stage0 where llvm-config is
170 // We also only build the runtimes when --enable-sanitizers (or its
171 // config.toml equivalent) is used
172 let llvm_config = builder.ensure(native::Llvm {
173 target: builder.config.build,
176 cargo.env("LLVM_CONFIG", llvm_config);
179 cargo.arg("--features").arg(features)
180 .arg("--manifest-path")
181 .arg(builder.src.join("src/libstd/Cargo.toml"));
183 if target.contains("musl") {
184 if let Some(p) = builder.musl_root(target) {
185 cargo.env("MUSL_ROOT", p);
191 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
193 pub compiler: Compiler,
194 pub target_compiler: Compiler,
195 pub target: Interned<String>,
198 impl Step for StdLink {
201 fn should_run(run: ShouldRun) -> ShouldRun {
205 /// Link all libstd rlibs/dylibs into the sysroot location.
207 /// Links those artifacts generated by `compiler` to the `stage` compiler's
208 /// sysroot for the specified `host` and `target`.
210 /// Note that this assumes that `compiler` has already generated the libstd
211 /// libraries for `target`, and this method will find them in the relevant
212 /// output directory.
213 fn run(self, builder: &Builder) {
214 let compiler = self.compiler;
215 let target_compiler = self.target_compiler;
216 let target = self.target;
217 builder.info(&format!("Copying stage{} std from stage{} ({} -> {} / {})",
218 target_compiler.stage,
221 target_compiler.host,
223 let libdir = builder.sysroot_libdir(target_compiler, target);
224 add_to_sysroot(builder, &libdir, &libstd_stamp(builder, compiler, target));
226 if builder.config.sanitizers && compiler.stage != 0 && target == "x86_64-apple-darwin" {
227 // The sanitizers are only built in stage1 or above, so the dylibs will
228 // be missing in stage0 and causes panic. See the `std()` function above
229 // for reason why the sanitizers are not built in stage0.
230 copy_apple_sanitizer_dylibs(builder, &builder.native_dir(target), "osx", &libdir);
233 builder.cargo(target_compiler, Mode::ToolStd, target, "clean");
237 fn copy_apple_sanitizer_dylibs(builder: &Builder, native_dir: &Path, platform: &str, into: &Path) {
238 for &sanitizer in &["asan", "tsan"] {
239 let filename = format!("lib__rustc__clang_rt.{}_{}_dynamic.dylib", sanitizer, platform);
240 let mut src_path = native_dir.join(sanitizer);
241 src_path.push("build");
242 src_path.push("lib");
243 src_path.push("darwin");
244 src_path.push(&filename);
245 builder.copy(&src_path, &into.join(filename));
249 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
250 pub struct StartupObjects {
251 pub compiler: Compiler,
252 pub target: Interned<String>,
255 impl Step for StartupObjects {
258 fn should_run(run: ShouldRun) -> ShouldRun {
259 run.path("src/rtstartup")
262 fn make_run(run: RunConfig) {
263 run.builder.ensure(StartupObjects {
264 compiler: run.builder.compiler(run.builder.top_stage, run.host),
269 /// Build and prepare startup objects like rsbegin.o and rsend.o
271 /// These are primarily used on Windows right now for linking executables/dlls.
272 /// They don't require any library support as they're just plain old object
273 /// files, so we just use the nightly snapshot compiler to always build them (as
274 /// no other compilers are guaranteed to be available).
275 fn run(self, builder: &Builder) {
276 let for_compiler = self.compiler;
277 let target = self.target;
278 if !target.contains("pc-windows-gnu") {
282 let src_dir = &builder.src.join("src/rtstartup");
283 let dst_dir = &builder.native_dir(target).join("rtstartup");
284 let sysroot_dir = &builder.sysroot_libdir(for_compiler, target);
285 t!(fs::create_dir_all(dst_dir));
287 for file in &["rsbegin", "rsend"] {
288 let src_file = &src_dir.join(file.to_string() + ".rs");
289 let dst_file = &dst_dir.join(file.to_string() + ".o");
290 if !up_to_date(src_file, dst_file) {
291 let mut cmd = Command::new(&builder.initial_rustc);
292 builder.run(cmd.env("RUSTC_BOOTSTRAP", "1")
293 .arg("--cfg").arg("stage0")
294 .arg("--target").arg(target)
296 .arg("-o").arg(dst_file)
300 builder.copy(dst_file, &sysroot_dir.join(file.to_string() + ".o"));
303 for obj in ["crt2.o", "dllcrt2.o"].iter() {
304 let src = compiler_file(builder,
308 builder.copy(&src, &sysroot_dir.join(obj));
313 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
315 pub target: Interned<String>,
316 pub compiler: Compiler,
321 const DEFAULT: bool = true;
323 fn should_run(run: ShouldRun) -> ShouldRun {
324 run.all_krates("test")
327 fn make_run(run: RunConfig) {
328 run.builder.ensure(Test {
329 compiler: run.builder.compiler(run.builder.top_stage, run.host),
336 /// This will build libtest and supporting libraries for a particular stage of
337 /// the build using the `compiler` targeting the `target` architecture. The
338 /// artifacts created will also be linked into the sysroot directory.
339 fn run(self, builder: &Builder) {
340 let target = self.target;
341 let compiler = self.compiler;
343 builder.ensure(Std { compiler, target });
345 if builder.config.keep_stage.contains(&compiler.stage) {
346 builder.info("Warning: Using a potentially old libtest. This may not behave well.");
347 builder.ensure(TestLink {
349 target_compiler: compiler,
355 if builder.force_use_stage1(compiler, target) {
356 builder.ensure(Test {
357 compiler: builder.compiler(1, builder.config.build),
361 &format!("Uplifting stage1 test ({} -> {})", builder.config.build, target));
362 builder.ensure(TestLink {
363 compiler: builder.compiler(1, builder.config.build),
364 target_compiler: compiler,
370 let mut cargo = builder.cargo(compiler, Mode::Test, target, "build");
371 test_cargo(builder, &compiler, target, &mut cargo);
373 let _folder = builder.fold_output(|| format!("stage{}-test", compiler.stage));
374 builder.info(&format!("Building stage{} test artifacts ({} -> {})", compiler.stage,
375 &compiler.host, target));
379 &libtest_stamp(builder, compiler, target),
382 builder.ensure(TestLink {
383 compiler: builder.compiler(compiler.stage, builder.config.build),
384 target_compiler: compiler,
390 /// Same as `std_cargo`, but for libtest
391 pub fn test_cargo(builder: &Builder,
392 _compiler: &Compiler,
393 _target: Interned<String>,
394 cargo: &mut Command) {
395 if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
396 cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
398 cargo.arg("--manifest-path")
399 .arg(builder.src.join("src/libtest/Cargo.toml"));
402 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
403 pub struct TestLink {
404 pub compiler: Compiler,
405 pub target_compiler: Compiler,
406 pub target: Interned<String>,
409 impl Step for TestLink {
412 fn should_run(run: ShouldRun) -> ShouldRun {
416 /// Same as `std_link`, only for libtest
417 fn run(self, builder: &Builder) {
418 let compiler = self.compiler;
419 let target_compiler = self.target_compiler;
420 let target = self.target;
421 builder.info(&format!("Copying stage{} test from stage{} ({} -> {} / {})",
422 target_compiler.stage,
425 target_compiler.host,
427 add_to_sysroot(builder, &builder.sysroot_libdir(target_compiler, target),
428 &libtest_stamp(builder, compiler, target));
430 builder.cargo(target_compiler, Mode::ToolTest, target, "clean");
434 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
436 pub target: Interned<String>,
437 pub compiler: Compiler,
440 impl Step for Rustc {
442 const ONLY_HOSTS: bool = true;
443 const DEFAULT: bool = true;
445 fn should_run(run: ShouldRun) -> ShouldRun {
446 run.all_krates("rustc-main")
449 fn make_run(run: RunConfig) {
450 run.builder.ensure(Rustc {
451 compiler: run.builder.compiler(run.builder.top_stage, run.host),
456 /// Build the compiler.
458 /// This will build the compiler for a particular stage of the build using
459 /// the `compiler` targeting the `target` architecture. The artifacts
460 /// created will also be linked into the sysroot directory.
461 fn run(self, builder: &Builder) {
462 let compiler = self.compiler;
463 let target = self.target;
465 builder.ensure(Test { compiler, target });
467 if builder.config.keep_stage.contains(&compiler.stage) {
468 builder.info("Warning: Using a potentially old librustc. This may not behave well.");
469 builder.ensure(RustcLink {
471 target_compiler: compiler,
477 if builder.force_use_stage1(compiler, target) {
478 builder.ensure(Rustc {
479 compiler: builder.compiler(1, builder.config.build),
482 builder.info(&format!("Uplifting stage1 rustc ({} -> {})",
483 builder.config.build, target));
484 builder.ensure(RustcLink {
485 compiler: builder.compiler(1, builder.config.build),
486 target_compiler: compiler,
492 // Ensure that build scripts have a std to link against.
494 compiler: builder.compiler(self.compiler.stage, builder.config.build),
495 target: builder.config.build,
498 let mut cargo = builder.cargo(compiler, Mode::Rustc, target, "build");
499 rustc_cargo(builder, &mut cargo);
501 let _folder = builder.fold_output(|| format!("stage{}-rustc", compiler.stage));
502 builder.info(&format!("Building stage{} compiler artifacts ({} -> {})",
503 compiler.stage, &compiler.host, target));
507 &librustc_stamp(builder, compiler, target),
510 builder.ensure(RustcLink {
511 compiler: builder.compiler(compiler.stage, builder.config.build),
512 target_compiler: compiler,
518 pub fn rustc_cargo(builder: &Builder, cargo: &mut Command) {
519 cargo.arg("--features").arg(builder.rustc_features())
520 .arg("--manifest-path")
521 .arg(builder.src.join("src/rustc/Cargo.toml"));
522 rustc_cargo_env(builder, cargo);
525 pub fn rustc_cargo_env(builder: &Builder, cargo: &mut Command) {
526 // Set some configuration variables picked up by build scripts and
527 // the compiler alike
528 cargo.env("CFG_RELEASE", builder.rust_release())
529 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
530 .env("CFG_VERSION", builder.rust_version())
531 .env("CFG_PREFIX", builder.config.prefix.clone().unwrap_or_default())
532 .env("CFG_CODEGEN_BACKENDS_DIR", &builder.config.rust_codegen_backends_dir);
534 let libdir_relative = builder.config.libdir_relative().unwrap_or(Path::new("lib"));
535 cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
537 // If we're not building a compiler with debugging information then remove
538 // these two env vars which would be set otherwise.
539 if builder.config.rust_debuginfo_only_std {
540 cargo.env_remove("RUSTC_DEBUGINFO");
541 cargo.env_remove("RUSTC_DEBUGINFO_LINES");
544 if let Some(ref ver_date) = builder.rust_info.commit_date() {
545 cargo.env("CFG_VER_DATE", ver_date);
547 if let Some(ref ver_hash) = builder.rust_info.sha() {
548 cargo.env("CFG_VER_HASH", ver_hash);
550 if !builder.unstable_features() {
551 cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
553 if let Some(ref s) = builder.config.rustc_default_linker {
554 cargo.env("CFG_DEFAULT_LINKER", s);
556 if builder.config.rustc_parallel_queries {
557 cargo.env("RUSTC_PARALLEL_QUERIES", "1");
559 if builder.config.rust_verify_llvm_ir {
560 cargo.env("RUSTC_VERIFY_LLVM_IR", "1");
564 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
566 pub compiler: Compiler,
567 pub target_compiler: Compiler,
568 pub target: Interned<String>,
571 impl Step for RustcLink {
574 fn should_run(run: ShouldRun) -> ShouldRun {
578 /// Same as `std_link`, only for librustc
579 fn run(self, builder: &Builder) {
580 let compiler = self.compiler;
581 let target_compiler = self.target_compiler;
582 let target = self.target;
583 builder.info(&format!("Copying stage{} rustc from stage{} ({} -> {} / {})",
584 target_compiler.stage,
587 target_compiler.host,
589 add_to_sysroot(builder, &builder.sysroot_libdir(target_compiler, target),
590 &librustc_stamp(builder, compiler, target));
591 builder.cargo(target_compiler, Mode::ToolRustc, target, "clean");
595 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
596 pub struct CodegenBackend {
597 pub compiler: Compiler,
598 pub target: Interned<String>,
599 pub backend: Interned<String>,
602 impl Step for CodegenBackend {
604 const ONLY_HOSTS: bool = true;
605 const DEFAULT: bool = true;
607 fn should_run(run: ShouldRun) -> ShouldRun {
608 run.all_krates("rustc_codegen_llvm")
611 fn make_run(run: RunConfig) {
612 let backend = run.builder.config.rust_codegen_backends.get(0);
613 let backend = backend.cloned().unwrap_or_else(|| {
614 INTERNER.intern_str("llvm")
616 run.builder.ensure(CodegenBackend {
617 compiler: run.builder.compiler(run.builder.top_stage, run.host),
623 fn run(self, builder: &Builder) {
624 let compiler = self.compiler;
625 let target = self.target;
626 let backend = self.backend;
628 builder.ensure(Rustc { compiler, target });
630 if builder.config.keep_stage.contains(&compiler.stage) {
631 builder.info("Warning: Using a potentially old codegen backend. \
632 This may not behave well.");
633 // Codegen backends are linked separately from this step today, so we don't do
638 if builder.force_use_stage1(compiler, target) {
639 builder.ensure(CodegenBackend {
640 compiler: builder.compiler(1, builder.config.build),
647 let out_dir = builder.cargo_out(compiler, Mode::Codegen, target);
649 let mut cargo = builder.cargo(compiler, Mode::Codegen, target, "rustc");
650 cargo.arg("--manifest-path")
651 .arg(builder.src.join("src/librustc_codegen_llvm/Cargo.toml"));
652 rustc_cargo_env(builder, &mut cargo);
654 let features = build_codegen_backend(&builder, &mut cargo, &compiler, target, backend);
656 let mut cargo_tails_args = vec![];
658 if builder.config.llvm_thin_lto {
659 cargo_tails_args.push("--".to_string());
661 let num_jobs = builder.jobs();
663 if !target.contains("msvc") {
664 // Here we assume that the linker is clang. If it's not, there'll
666 cargo_tails_args.push("-Clink-arg=-fuse-ld=lld".to_string());
667 cargo_tails_args.push("-Clink-arg=-flto=thin".to_string());
669 if builder.config.llvm_optimize {
670 cargo_tails_args.push("-Clink-arg=-O2".to_string());
673 // Let's make LLD respect the `-j` option.
674 let num_jobs_arg = format!("-Clink-arg=-Wl,--thinlto-jobs={}", num_jobs);
675 cargo_tails_args.push(num_jobs_arg);
677 // Here we assume that the linker is lld-link.exe. lld-link.exe
678 // does not need the extra arguments except for num_jobs
679 let num_jobs_arg = format!("-Clink-arg=/opt:lldltojobs={}", num_jobs);
680 cargo_tails_args.push(num_jobs_arg);
684 let tmp_stamp = out_dir.join(".tmp.stamp");
686 let _folder = builder.fold_output(|| format!("stage{}-rustc_codegen_llvm", compiler.stage));
687 let files = run_cargo(builder,
688 cargo.arg("--features").arg(features),
692 if builder.config.dry_run {
695 let mut files = files.into_iter()
697 let filename = f.file_name().unwrap().to_str().unwrap();
698 is_dylib(filename) && filename.contains("rustc_codegen_llvm-")
700 let codegen_backend = match files.next() {
702 None => panic!("no dylibs built for codegen backend?"),
704 if let Some(f) = files.next() {
705 panic!("codegen backend built two dylibs:\n{}\n{}",
706 codegen_backend.display(),
709 let stamp = codegen_backend_stamp(builder, compiler, target, backend);
710 let codegen_backend = codegen_backend.to_str().unwrap();
711 t!(fs::write(&stamp, &codegen_backend));
715 pub fn build_codegen_backend(builder: &Builder,
718 target: Interned<String>,
719 backend: Interned<String>) -> String {
720 let mut features = String::new();
723 "llvm" | "emscripten" => {
724 // Build LLVM for our target. This will implicitly build the
725 // host LLVM if necessary.
726 let llvm_config = builder.ensure(native::Llvm {
728 emscripten: backend == "emscripten",
731 if backend == "emscripten" {
732 features.push_str(" emscripten");
735 builder.info(&format!("Building stage{} codegen artifacts ({} -> {}, {})",
736 compiler.stage, &compiler.host, target, backend));
738 // Pass down configuration from the LLVM build into the build of
739 // librustc_llvm and librustc_codegen_llvm.
740 if builder.is_rust_llvm(target) && backend != "emscripten" {
741 cargo.env("LLVM_RUSTLLVM", "1");
743 cargo.env("LLVM_CONFIG", &llvm_config);
744 if backend != "emscripten" {
745 let target_config = builder.config.target_config.get(&target);
746 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
747 cargo.env("CFG_LLVM_ROOT", s);
750 // Building with a static libstdc++ is only supported on linux right now,
751 // not for MSVC or macOS
752 if builder.config.llvm_static_stdcpp &&
753 !target.contains("freebsd") &&
754 !target.contains("windows") &&
755 !target.contains("apple") {
756 let file = compiler_file(builder,
757 builder.cxx(target).unwrap(),
760 cargo.env("LLVM_STATIC_STDCPP", file);
762 if builder.config.llvm_link_shared {
763 cargo.env("LLVM_LINK_SHARED", "1");
766 _ => panic!("unknown backend: {}", backend),
772 /// Creates the `codegen-backends` folder for a compiler that's about to be
773 /// assembled as a complete compiler.
775 /// This will take the codegen artifacts produced by `compiler` and link them
776 /// into an appropriate location for `target_compiler` to be a functional
778 fn copy_codegen_backends_to_sysroot(builder: &Builder,
780 target_compiler: Compiler) {
781 let target = target_compiler.host;
783 // Note that this step is different than all the other `*Link` steps in
784 // that it's not assembling a bunch of libraries but rather is primarily
785 // moving the codegen backend into place. The codegen backend of rustc is
786 // not linked into the main compiler by default but is rather dynamically
787 // selected at runtime for inclusion.
789 // Here we're looking for the output dylib of the `CodegenBackend` step and
790 // we're copying that into the `codegen-backends` folder.
791 let dst = builder.sysroot_codegen_backends(target_compiler);
792 t!(fs::create_dir_all(&dst));
794 if builder.config.dry_run {
798 for backend in builder.config.rust_codegen_backends.iter() {
799 let stamp = codegen_backend_stamp(builder, compiler, target, *backend);
800 let dylib = t!(fs::read_to_string(&stamp));
801 let file = Path::new(&dylib);
802 let filename = file.file_name().unwrap().to_str().unwrap();
803 // change `librustc_codegen_llvm-xxxxxx.so` to `librustc_codegen_llvm-llvm.so`
804 let target_filename = {
805 let dash = filename.find('-').unwrap();
806 let dot = filename.find('.').unwrap();
812 builder.copy(&file, &dst.join(target_filename));
816 fn copy_lld_to_sysroot(builder: &Builder,
817 target_compiler: Compiler,
818 lld_install_root: &Path) {
819 let target = target_compiler.host;
821 let dst = builder.sysroot_libdir(target_compiler, target)
825 t!(fs::create_dir_all(&dst));
827 let src_exe = exe("lld", &target);
828 let dst_exe = exe("rust-lld", &target);
829 // we prepend this bin directory to the user PATH when linking Rust binaries. To
830 // avoid shadowing the system LLD we rename the LLD we provide to `rust-lld`.
831 builder.copy(&lld_install_root.join("bin").join(&src_exe), &dst.join(&dst_exe));
834 /// Cargo's output path for the standard library in a given stage, compiled
835 /// by a particular compiler for the specified target.
836 pub fn libstd_stamp(builder: &Builder, compiler: Compiler, target: Interned<String>) -> PathBuf {
837 builder.cargo_out(compiler, Mode::Std, target).join(".libstd.stamp")
840 /// Cargo's output path for libtest in a given stage, compiled by a particular
841 /// compiler for the specified target.
842 pub fn libtest_stamp(builder: &Builder, compiler: Compiler, target: Interned<String>) -> PathBuf {
843 builder.cargo_out(compiler, Mode::Test, target).join(".libtest.stamp")
846 /// Cargo's output path for librustc in a given stage, compiled by a particular
847 /// compiler for the specified target.
848 pub fn librustc_stamp(builder: &Builder, compiler: Compiler, target: Interned<String>) -> PathBuf {
849 builder.cargo_out(compiler, Mode::Rustc, target).join(".librustc.stamp")
852 /// Cargo's output path for librustc_codegen_llvm in a given stage, compiled by a particular
853 /// compiler for the specified target and backend.
854 fn codegen_backend_stamp(builder: &Builder,
856 target: Interned<String>,
857 backend: Interned<String>) -> PathBuf {
858 builder.cargo_out(compiler, Mode::Codegen, target)
859 .join(format!(".librustc_codegen_llvm-{}.stamp", backend))
862 pub fn compiler_file(builder: &Builder,
864 target: Interned<String>,
865 file: &str) -> PathBuf {
866 let mut cmd = Command::new(compiler);
867 cmd.args(builder.cflags(target, GitRepo::Rustc));
868 cmd.arg(format!("-print-file-name={}", file));
869 let out = output(&mut cmd);
870 PathBuf::from(out.trim())
873 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
875 pub compiler: Compiler,
878 impl Step for Sysroot {
879 type Output = Interned<PathBuf>;
881 fn should_run(run: ShouldRun) -> ShouldRun {
885 /// Returns the sysroot for the `compiler` specified that *this build system
888 /// That is, the sysroot for the stage0 compiler is not what the compiler
889 /// thinks it is by default, but it's the same as the default for stages
891 fn run(self, builder: &Builder) -> Interned<PathBuf> {
892 let compiler = self.compiler;
893 let sysroot = if compiler.stage == 0 {
894 builder.out.join(&compiler.host).join("stage0-sysroot")
896 builder.out.join(&compiler.host).join(format!("stage{}", compiler.stage))
898 let _ = fs::remove_dir_all(&sysroot);
899 t!(fs::create_dir_all(&sysroot));
900 INTERNER.intern_path(sysroot)
904 #[derive(Debug, Copy, PartialOrd, Ord, Clone, PartialEq, Eq, Hash)]
905 pub struct Assemble {
906 /// The compiler which we will produce in this step. Assemble itself will
907 /// take care of ensuring that the necessary prerequisites to do so exist,
908 /// that is, this target can be a stage2 compiler and Assemble will build
909 /// previous stages for you.
910 pub target_compiler: Compiler,
913 impl Step for Assemble {
914 type Output = Compiler;
916 fn should_run(run: ShouldRun) -> ShouldRun {
920 /// Prepare a new compiler from the artifacts in `stage`
922 /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
923 /// must have been previously produced by the `stage - 1` builder.build
925 fn run(self, builder: &Builder) -> Compiler {
926 let target_compiler = self.target_compiler;
928 if target_compiler.stage == 0 {
929 assert_eq!(builder.config.build, target_compiler.host,
930 "Cannot obtain compiler for non-native build triple at stage 0");
931 // The stage 0 compiler for the build triple is always pre-built.
932 return target_compiler;
935 // Get the compiler that we'll use to bootstrap ourselves.
937 // Note that this is where the recursive nature of the bootstrap
938 // happens, as this will request the previous stage's compiler on
939 // downwards to stage 0.
941 // Also note that we're building a compiler for the host platform. We
942 // only assume that we can run `build` artifacts, which means that to
943 // produce some other architecture compiler we need to start from
944 // `build` to get there.
946 // FIXME: Perhaps we should download those libraries?
947 // It would make builds faster...
949 // FIXME: It may be faster if we build just a stage 1 compiler and then
950 // use that to bootstrap this compiler forward.
952 builder.compiler(target_compiler.stage - 1, builder.config.build);
954 // Build the libraries for this compiler to link to (i.e., the libraries
955 // it uses at runtime). NOTE: Crates the target compiler compiles don't
956 // link to these. (FIXME: Is that correct? It seems to be correct most
957 // of the time but I think we do link to these for stage2/bin compilers
958 // when not performing a full bootstrap).
959 builder.ensure(Rustc {
960 compiler: build_compiler,
961 target: target_compiler.host,
963 for &backend in builder.config.rust_codegen_backends.iter() {
964 builder.ensure(CodegenBackend {
965 compiler: build_compiler,
966 target: target_compiler.host,
971 let lld_install = if builder.config.lld_enabled {
972 Some(builder.ensure(native::Lld {
973 target: target_compiler.host,
979 let stage = target_compiler.stage;
980 let host = target_compiler.host;
981 builder.info(&format!("Assembling stage{} compiler ({})", stage, host));
983 // Link in all dylibs to the libdir
984 let sysroot = builder.sysroot(target_compiler);
985 let sysroot_libdir = sysroot.join(libdir(&*host));
986 t!(fs::create_dir_all(&sysroot_libdir));
987 let src_libdir = builder.sysroot_libdir(build_compiler, host);
988 for f in builder.read_dir(&src_libdir) {
989 let filename = f.file_name().into_string().unwrap();
990 if is_dylib(&filename) {
991 builder.copy(&f.path(), &sysroot_libdir.join(&filename));
995 copy_codegen_backends_to_sysroot(builder,
998 if let Some(lld_install) = lld_install {
999 copy_lld_to_sysroot(builder, target_compiler, &lld_install);
1002 // Link the compiler binary itself into place
1003 let out_dir = builder.cargo_out(build_compiler, Mode::Rustc, host);
1004 let rustc = out_dir.join(exe("rustc_binary", &*host));
1005 let bindir = sysroot.join("bin");
1006 t!(fs::create_dir_all(&bindir));
1007 let compiler = builder.rustc(target_compiler);
1008 let _ = fs::remove_file(&compiler);
1009 builder.copy(&rustc, &compiler);
1015 /// Link some files into a rustc sysroot.
1017 /// For a particular stage this will link the file listed in `stamp` into the
1018 /// `sysroot_dst` provided.
1019 pub fn add_to_sysroot(builder: &Builder, sysroot_dst: &Path, stamp: &Path) {
1020 t!(fs::create_dir_all(&sysroot_dst));
1021 for path in builder.read_stamp_file(stamp) {
1022 builder.copy(&path, &sysroot_dst.join(path.file_name().unwrap()));
1026 pub fn run_cargo(builder: &Builder,
1027 cargo: &mut Command,
1028 tail_args: Vec<String>,
1033 if builder.config.dry_run {
1037 // `target_root_dir` looks like $dir/$target/release
1038 let target_root_dir = stamp.parent().unwrap();
1039 // `target_deps_dir` looks like $dir/$target/release/deps
1040 let target_deps_dir = target_root_dir.join("deps");
1041 // `host_root_dir` looks like $dir/release
1042 let host_root_dir = target_root_dir.parent().unwrap() // chop off `release`
1043 .parent().unwrap() // chop off `$target`
1044 .join(target_root_dir.file_name().unwrap());
1046 // Spawn Cargo slurping up its JSON output. We'll start building up the
1047 // `deps` array of all files it generated along with a `toplevel` array of
1048 // files we need to probe for later.
1049 let mut deps = Vec::new();
1050 let mut toplevel = Vec::new();
1051 let ok = stream_cargo(builder, cargo, tail_args, &mut |msg| {
1052 let filenames = match msg {
1053 CargoMessage::CompilerArtifact { filenames, .. } => filenames,
1056 for filename in filenames {
1057 // Skip files like executables
1058 if !filename.ends_with(".rlib") &&
1059 !filename.ends_with(".lib") &&
1060 !is_dylib(&filename) &&
1061 !(is_check && filename.ends_with(".rmeta")) {
1065 let filename = Path::new(&*filename);
1067 // If this was an output file in the "host dir" we don't actually
1068 // worry about it, it's not relevant for us.
1069 if filename.starts_with(&host_root_dir) {
1073 // If this was output in the `deps` dir then this is a precise file
1074 // name (hash included) so we start tracking it.
1075 if filename.starts_with(&target_deps_dir) {
1076 deps.push(filename.to_path_buf());
1080 // Otherwise this was a "top level artifact" which right now doesn't
1081 // have a hash in the name, but there's a version of this file in
1082 // the `deps` folder which *does* have a hash in the name. That's
1083 // the one we'll want to we'll probe for it later.
1085 // We do not use `Path::file_stem` or `Path::extension` here,
1086 // because some generated files may have multiple extensions e.g.
1087 // `std-<hash>.dll.lib` on Windows. The aforementioned methods only
1088 // split the file name by the last extension (`.lib`) while we need
1089 // to split by all extensions (`.dll.lib`).
1090 let expected_len = t!(filename.metadata()).len();
1091 let filename = filename.file_name().unwrap().to_str().unwrap();
1092 let mut parts = filename.splitn(2, '.');
1093 let file_stem = parts.next().unwrap().to_owned();
1094 let extension = parts.next().unwrap().to_owned();
1096 toplevel.push((file_stem, extension, expected_len));
1104 // Ok now we need to actually find all the files listed in `toplevel`. We've
1105 // got a list of prefix/extensions and we basically just need to find the
1106 // most recent file in the `deps` folder corresponding to each one.
1107 let contents = t!(target_deps_dir.read_dir())
1109 .map(|e| (e.path(), e.file_name().into_string().unwrap(), t!(e.metadata())))
1110 .collect::<Vec<_>>();
1111 for (prefix, extension, expected_len) in toplevel {
1112 let candidates = contents.iter().filter(|&&(_, ref filename, ref meta)| {
1113 filename.starts_with(&prefix[..]) &&
1114 filename[prefix.len()..].starts_with("-") &&
1115 filename.ends_with(&extension[..]) &&
1116 meta.len() == expected_len
1118 let max = candidates.max_by_key(|&&(_, _, ref metadata)| {
1119 FileTime::from_last_modification_time(metadata)
1121 let path_to_add = match max {
1122 Some(triple) => triple.0.to_str().unwrap(),
1123 None => panic!("no output generated for {:?} {:?}", prefix, extension),
1125 if is_dylib(path_to_add) {
1126 let candidate = format!("{}.lib", path_to_add);
1127 let candidate = PathBuf::from(candidate);
1128 if candidate.exists() {
1129 deps.push(candidate);
1132 deps.push(path_to_add.into());
1135 // Now we want to update the contents of the stamp file, if necessary. First
1136 // we read off the previous contents along with its mtime. If our new
1137 // contents (the list of files to copy) is different or if any dep's mtime
1138 // is newer then we rewrite the stamp file.
1140 let stamp_contents = fs::read(stamp);
1141 let stamp_mtime = mtime(&stamp);
1142 let mut new_contents = Vec::new();
1144 let mut max_path = None;
1145 for dep in deps.iter() {
1146 let mtime = mtime(dep);
1147 if Some(mtime) > max {
1149 max_path = Some(dep.clone());
1151 new_contents.extend(dep.to_str().unwrap().as_bytes());
1152 new_contents.extend(b"\0");
1154 let max = max.unwrap();
1155 let max_path = max_path.unwrap();
1156 let contents_equal = stamp_contents
1157 .map(|contents| contents == new_contents)
1158 .unwrap_or_default();
1159 if contents_equal && max <= stamp_mtime {
1160 builder.verbose(&format!("not updating {:?}; contents equal and {:?} <= {:?}",
1161 stamp, max, stamp_mtime));
1164 if max > stamp_mtime {
1165 builder.verbose(&format!("updating {:?} as {:?} changed", stamp, max_path));
1167 builder.verbose(&format!("updating {:?} as deps changed", stamp));
1169 t!(fs::write(&stamp, &new_contents));
1173 pub fn stream_cargo(
1175 cargo: &mut Command,
1176 tail_args: Vec<String>,
1177 cb: &mut dyn FnMut(CargoMessage),
1179 if builder.config.dry_run {
1182 // Instruct Cargo to give us json messages on stdout, critically leaving
1183 // stderr as piped so we can get those pretty colors.
1184 cargo.arg("--message-format").arg("json")
1185 .stdout(Stdio::piped());
1187 for arg in tail_args {
1191 builder.verbose(&format!("running: {:?}", cargo));
1192 let mut child = match cargo.spawn() {
1194 Err(e) => panic!("failed to execute command: {:?}\nerror: {}", cargo, e),
1197 // Spawn Cargo slurping up its JSON output. We'll start building up the
1198 // `deps` array of all files it generated along with a `toplevel` array of
1199 // files we need to probe for later.
1200 let stdout = BufReader::new(child.stdout.take().unwrap());
1201 for line in stdout.lines() {
1202 let line = t!(line);
1203 match serde_json::from_str::<CargoMessage>(&line) {
1205 // If this was informational, just print it out and continue
1206 Err(_) => println!("{}", line)
1210 // Make sure Cargo actually succeeded after we read all of its stdout.
1211 let status = t!(child.wait());
1212 if !status.success() {
1213 eprintln!("command did not execute successfully: {:?}\n\
1214 expected success, got: {}",
1221 #[derive(Deserialize)]
1222 #[serde(tag = "reason", rename_all = "kebab-case")]
1223 pub enum CargoMessage<'a> {
1225 package_id: Cow<'a, str>,
1226 features: Vec<Cow<'a, str>>,
1227 filenames: Vec<Cow<'a, str>>,
1229 BuildScriptExecuted {
1230 package_id: Cow<'a, str>,