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.
20 use std::fs::{self, File};
21 use std::io::BufReader;
22 use std::io::prelude::*;
23 use std::path::{Path, PathBuf};
24 use std::process::{Command, Stdio};
28 use build_helper::{output, mtime, up_to_date};
29 use filetime::FileTime;
32 use util::{exe, libdir, is_dylib, copy, read_stamp_file, CiEnv};
33 use {Build, Compiler, Mode};
37 use cache::{INTERNER, Interned};
38 use builder::{Step, RunConfig, ShouldRun, Builder};
40 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
42 pub target: Interned<String>,
43 pub compiler: Compiler,
48 const DEFAULT: bool = true;
50 fn should_run(run: ShouldRun) -> ShouldRun {
51 run.path("src/libstd").krate("std")
54 fn make_run(run: RunConfig) {
55 run.builder.ensure(Std {
56 compiler: run.builder.compiler(run.builder.top_stage, run.host),
61 /// Build the standard library.
63 /// This will build the standard library for a particular stage of the build
64 /// using the `compiler` targeting the `target` architecture. The artifacts
65 /// created will also be linked into the sysroot directory.
66 fn run(self, builder: &Builder) {
67 let build = builder.build;
68 let target = self.target;
69 let compiler = self.compiler;
71 builder.ensure(StartupObjects { compiler, target });
73 if build.force_use_stage1(compiler, target) {
74 let from = builder.compiler(1, build.build);
79 println!("Uplifting stage1 std ({} -> {})", from.host, target);
81 // Even if we're not building std this stage, the new sysroot must
82 // still contain the musl startup objects.
83 if target.contains("musl") {
84 let libdir = builder.sysroot_libdir(compiler, target);
85 copy_musl_third_party_objects(build, target, &libdir);
88 builder.ensure(StdLink {
90 target_compiler: compiler,
96 let _folder = build.fold_output(|| format!("stage{}-std", compiler.stage));
97 println!("Building stage{} std artifacts ({} -> {})", compiler.stage,
98 &compiler.host, target);
100 if target.contains("musl") {
101 let libdir = builder.sysroot_libdir(compiler, target);
102 copy_musl_third_party_objects(build, target, &libdir);
105 let out_dir = build.stage_out(compiler, Mode::Libstd);
106 build.clear_if_dirty(&out_dir, &builder.rustc(compiler));
107 let mut cargo = builder.cargo(compiler, Mode::Libstd, target, "build");
108 std_cargo(build, &compiler, target, &mut cargo);
111 &libstd_stamp(build, compiler, target),
114 builder.ensure(StdLink {
115 compiler: builder.compiler(compiler.stage, build.build),
116 target_compiler: compiler,
122 /// Copies the crt(1,i,n).o startup objects
124 /// Since musl supports fully static linking, we can cross link for it even
125 /// with a glibc-targeting toolchain, given we have the appropriate startup
126 /// files. As those shipped with glibc won't work, copy the ones provided by
127 /// musl so we have them on linux-gnu hosts.
128 fn copy_musl_third_party_objects(build: &Build,
129 target: Interned<String>,
131 for &obj in &["crt1.o", "crti.o", "crtn.o"] {
132 copy(&build.musl_root(target).unwrap().join("lib").join(obj), &into.join(obj));
136 /// Configure cargo to compile the standard library, adding appropriate env vars
138 pub fn std_cargo(build: &Build,
140 target: Interned<String>,
141 cargo: &mut Command) {
142 let mut features = build.std_features();
144 if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
145 cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
148 // When doing a local rebuild we tell cargo that we're stage1 rather than
149 // stage0. This works fine if the local rust and being-built rust have the
150 // same view of what the default allocator is, but fails otherwise. Since
151 // we don't have a way to express an allocator preference yet, work
152 // around the issue in the case of a local rebuild with jemalloc disabled.
153 if compiler.stage == 0 && build.local_rebuild && !build.config.use_jemalloc {
154 features.push_str(" force_alloc_system");
157 if compiler.stage != 0 && build.config.sanitizers {
158 // This variable is used by the sanitizer runtime crates, e.g.
159 // rustc_lsan, to build the sanitizer runtime from C code
160 // When this variable is missing, those crates won't compile the C code,
161 // so we don't set this variable during stage0 where llvm-config is
163 // We also only build the runtimes when --enable-sanitizers (or its
164 // config.toml equivalent) is used
165 cargo.env("LLVM_CONFIG", build.llvm_config(target));
168 cargo.arg("--features").arg(features)
169 .arg("--manifest-path")
170 .arg(build.src.join("src/libstd/Cargo.toml"));
172 if let Some(target) = build.config.target_config.get(&target) {
173 if let Some(ref jemalloc) = target.jemalloc {
174 cargo.env("JEMALLOC_OVERRIDE", jemalloc);
177 if target.contains("musl") {
178 if let Some(p) = build.musl_root(target) {
179 cargo.env("MUSL_ROOT", p);
184 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
186 pub compiler: Compiler,
187 pub target_compiler: Compiler,
188 pub target: Interned<String>,
191 impl Step for StdLink {
194 fn should_run(run: ShouldRun) -> ShouldRun {
198 /// Link all libstd rlibs/dylibs into the sysroot location.
200 /// Links those artifacts generated by `compiler` to a the `stage` compiler's
201 /// sysroot for the specified `host` and `target`.
203 /// Note that this assumes that `compiler` has already generated the libstd
204 /// libraries for `target`, and this method will find them in the relevant
205 /// output directory.
206 fn run(self, builder: &Builder) {
207 let build = builder.build;
208 let compiler = self.compiler;
209 let target_compiler = self.target_compiler;
210 let target = self.target;
211 println!("Copying stage{} std from stage{} ({} -> {} / {})",
212 target_compiler.stage,
215 target_compiler.host,
217 let libdir = builder.sysroot_libdir(target_compiler, target);
218 add_to_sysroot(&libdir, &libstd_stamp(build, compiler, target));
220 if build.config.sanitizers && compiler.stage != 0 && target == "x86_64-apple-darwin" {
221 // The sanitizers are only built in stage1 or above, so the dylibs will
222 // be missing in stage0 and causes panic. See the `std()` function above
223 // for reason why the sanitizers are not built in stage0.
224 copy_apple_sanitizer_dylibs(&build.native_dir(target), "osx", &libdir);
227 builder.ensure(tool::CleanTools {
228 compiler: target_compiler,
235 fn copy_apple_sanitizer_dylibs(native_dir: &Path, platform: &str, into: &Path) {
236 for &sanitizer in &["asan", "tsan"] {
237 let filename = format!("libclang_rt.{}_{}_dynamic.dylib", sanitizer, platform);
238 let mut src_path = native_dir.join(sanitizer);
239 src_path.push("build");
240 src_path.push("lib");
241 src_path.push("darwin");
242 src_path.push(&filename);
243 copy(&src_path, &into.join(filename));
247 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
248 pub struct StartupObjects {
249 pub compiler: Compiler,
250 pub target: Interned<String>,
253 impl Step for StartupObjects {
256 fn should_run(run: ShouldRun) -> ShouldRun {
257 run.path("src/rtstartup")
260 fn make_run(run: RunConfig) {
261 run.builder.ensure(StartupObjects {
262 compiler: run.builder.compiler(run.builder.top_stage, run.host),
267 /// Build and prepare startup objects like rsbegin.o and rsend.o
269 /// These are primarily used on Windows right now for linking executables/dlls.
270 /// They don't require any library support as they're just plain old object
271 /// files, so we just use the nightly snapshot compiler to always build them (as
272 /// no other compilers are guaranteed to be available).
273 fn run(self, builder: &Builder) {
274 let build = builder.build;
275 let for_compiler = self.compiler;
276 let target = self.target;
277 if !target.contains("pc-windows-gnu") {
281 let src_dir = &build.src.join("src/rtstartup");
282 let dst_dir = &build.native_dir(target).join("rtstartup");
283 let sysroot_dir = &builder.sysroot_libdir(for_compiler, target);
284 t!(fs::create_dir_all(dst_dir));
286 for file in &["rsbegin", "rsend"] {
287 let src_file = &src_dir.join(file.to_string() + ".rs");
288 let dst_file = &dst_dir.join(file.to_string() + ".o");
289 if !up_to_date(src_file, dst_file) {
290 let mut cmd = Command::new(&build.initial_rustc);
291 build.run(cmd.env("RUSTC_BOOTSTRAP", "1")
292 .arg("--cfg").arg("stage0")
293 .arg("--target").arg(target)
295 .arg("-o").arg(dst_file)
299 copy(dst_file, &sysroot_dir.join(file.to_string() + ".o"));
302 for obj in ["crt2.o", "dllcrt2.o"].iter() {
303 let src = compiler_file(build,
307 copy(&src, &sysroot_dir.join(obj));
312 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
314 pub compiler: Compiler,
315 pub target: Interned<String>,
320 const DEFAULT: bool = true;
322 fn should_run(run: ShouldRun) -> ShouldRun {
323 run.path("src/libtest").krate("test")
326 fn make_run(run: RunConfig) {
327 run.builder.ensure(Test {
328 compiler: run.builder.compiler(run.builder.top_stage, run.host),
335 /// This will build libtest and supporting libraries for a particular stage of
336 /// the build using the `compiler` targeting the `target` architecture. The
337 /// artifacts created will also be linked into the sysroot directory.
338 fn run(self, builder: &Builder) {
339 let build = builder.build;
340 let target = self.target;
341 let compiler = self.compiler;
343 builder.ensure(Std { compiler, target });
345 if build.force_use_stage1(compiler, target) {
346 builder.ensure(Test {
347 compiler: builder.compiler(1, build.build),
350 println!("Uplifting stage1 test ({} -> {})", &build.build, target);
351 builder.ensure(TestLink {
352 compiler: builder.compiler(1, build.build),
353 target_compiler: compiler,
359 let _folder = build.fold_output(|| format!("stage{}-test", compiler.stage));
360 println!("Building stage{} test artifacts ({} -> {})", compiler.stage,
361 &compiler.host, target);
362 let out_dir = build.stage_out(compiler, Mode::Libtest);
363 build.clear_if_dirty(&out_dir, &libstd_stamp(build, compiler, target));
364 let mut cargo = builder.cargo(compiler, Mode::Libtest, target, "build");
365 test_cargo(build, &compiler, target, &mut cargo);
368 &libtest_stamp(build, compiler, target),
371 builder.ensure(TestLink {
372 compiler: builder.compiler(compiler.stage, build.build),
373 target_compiler: compiler,
379 /// Same as `std_cargo`, but for libtest
380 pub fn test_cargo(build: &Build,
381 _compiler: &Compiler,
382 _target: Interned<String>,
383 cargo: &mut Command) {
384 if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
385 cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
387 cargo.arg("--manifest-path")
388 .arg(build.src.join("src/libtest/Cargo.toml"));
391 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
392 pub struct TestLink {
393 pub compiler: Compiler,
394 pub target_compiler: Compiler,
395 pub target: Interned<String>,
398 impl Step for TestLink {
401 fn should_run(run: ShouldRun) -> ShouldRun {
405 /// Same as `std_link`, only for libtest
406 fn run(self, builder: &Builder) {
407 let build = builder.build;
408 let compiler = self.compiler;
409 let target_compiler = self.target_compiler;
410 let target = self.target;
411 println!("Copying stage{} test from stage{} ({} -> {} / {})",
412 target_compiler.stage,
415 target_compiler.host,
417 add_to_sysroot(&builder.sysroot_libdir(target_compiler, target),
418 &libtest_stamp(build, compiler, target));
419 builder.ensure(tool::CleanTools {
420 compiler: target_compiler,
427 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
429 pub compiler: Compiler,
430 pub target: Interned<String>,
433 impl Step for Rustc {
435 const ONLY_HOSTS: bool = true;
436 const DEFAULT: bool = true;
438 fn should_run(run: ShouldRun) -> ShouldRun {
439 run.path("src/librustc").krate("rustc-main")
442 fn make_run(run: RunConfig) {
443 run.builder.ensure(Rustc {
444 compiler: run.builder.compiler(run.builder.top_stage, run.host),
449 /// Build the compiler.
451 /// This will build the compiler for a particular stage of the build using
452 /// the `compiler` targeting the `target` architecture. The artifacts
453 /// created will also be linked into the sysroot directory.
454 fn run(self, builder: &Builder) {
455 let build = builder.build;
456 let compiler = self.compiler;
457 let target = self.target;
459 builder.ensure(Test { compiler, target });
461 if build.force_use_stage1(compiler, target) {
462 builder.ensure(Rustc {
463 compiler: builder.compiler(1, build.build),
466 println!("Uplifting stage1 rustc ({} -> {})", &build.build, target);
467 builder.ensure(RustcLink {
468 compiler: builder.compiler(1, build.build),
469 target_compiler: compiler,
475 // Ensure that build scripts have a std to link against.
477 compiler: builder.compiler(self.compiler.stage, build.build),
481 let _folder = build.fold_output(|| format!("stage{}-rustc", compiler.stage));
482 println!("Building stage{} compiler artifacts ({} -> {})",
483 compiler.stage, &compiler.host, target);
485 let stage_out = builder.stage_out(compiler, Mode::Librustc);
486 build.clear_if_dirty(&stage_out, &libstd_stamp(build, compiler, target));
487 build.clear_if_dirty(&stage_out, &libtest_stamp(build, compiler, target));
489 let mut cargo = builder.cargo(compiler, Mode::Librustc, target, "build");
490 rustc_cargo(build, &mut cargo);
493 &librustc_stamp(build, compiler, target),
496 builder.ensure(RustcLink {
497 compiler: builder.compiler(compiler.stage, build.build),
498 target_compiler: compiler,
504 pub fn rustc_cargo(build: &Build, cargo: &mut Command) {
505 cargo.arg("--features").arg(build.rustc_features())
506 .arg("--manifest-path")
507 .arg(build.src.join("src/rustc/Cargo.toml"));
508 rustc_cargo_env(build, cargo);
511 fn rustc_cargo_env(build: &Build, cargo: &mut Command) {
512 // Set some configuration variables picked up by build scripts and
513 // the compiler alike
514 cargo.env("CFG_RELEASE", build.rust_release())
515 .env("CFG_RELEASE_CHANNEL", &build.config.channel)
516 .env("CFG_VERSION", build.rust_version())
517 .env("CFG_PREFIX", build.config.prefix.clone().unwrap_or_default());
519 let libdir_relative =
520 build.config.libdir.clone().unwrap_or(PathBuf::from("lib"));
521 cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
523 // If we're not building a compiler with debugging information then remove
524 // these two env vars which would be set otherwise.
525 if build.config.rust_debuginfo_only_std {
526 cargo.env_remove("RUSTC_DEBUGINFO");
527 cargo.env_remove("RUSTC_DEBUGINFO_LINES");
530 if let Some(ref ver_date) = build.rust_info.commit_date() {
531 cargo.env("CFG_VER_DATE", ver_date);
533 if let Some(ref ver_hash) = build.rust_info.sha() {
534 cargo.env("CFG_VER_HASH", ver_hash);
536 if !build.unstable_features() {
537 cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
539 if let Some(ref s) = build.config.rustc_default_linker {
540 cargo.env("CFG_DEFAULT_LINKER", s);
542 if build.config.rustc_parallel_queries {
543 cargo.env("RUSTC_PARALLEL_QUERIES", "1");
547 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
549 pub compiler: Compiler,
550 pub target_compiler: Compiler,
551 pub target: Interned<String>,
554 impl Step for RustcLink {
557 fn should_run(run: ShouldRun) -> ShouldRun {
561 /// Same as `std_link`, only for librustc
562 fn run(self, builder: &Builder) {
563 let build = builder.build;
564 let compiler = self.compiler;
565 let target_compiler = self.target_compiler;
566 let target = self.target;
567 println!("Copying stage{} rustc from stage{} ({} -> {} / {})",
568 target_compiler.stage,
571 target_compiler.host,
573 add_to_sysroot(&builder.sysroot_libdir(target_compiler, target),
574 &librustc_stamp(build, compiler, target));
575 builder.ensure(tool::CleanTools {
576 compiler: target_compiler,
578 mode: Mode::Librustc,
583 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
584 pub struct CodegenBackend {
585 pub compiler: Compiler,
586 pub target: Interned<String>,
587 pub backend: Interned<String>,
590 impl Step for CodegenBackend {
592 const ONLY_HOSTS: bool = true;
593 const DEFAULT: bool = true;
595 fn should_run(run: ShouldRun) -> ShouldRun {
596 run.path("src/librustc_trans")
599 fn make_run(run: RunConfig) {
600 let backend = run.builder.config.rust_codegen_backends.get(0);
601 let backend = backend.cloned().unwrap_or_else(|| {
602 INTERNER.intern_str("llvm")
604 run.builder.ensure(CodegenBackend {
605 compiler: run.builder.compiler(run.builder.top_stage, run.host),
611 fn run(self, builder: &Builder) {
612 let build = builder.build;
613 let compiler = self.compiler;
614 let target = self.target;
616 builder.ensure(Rustc { compiler, target });
618 if build.force_use_stage1(compiler, target) {
619 builder.ensure(CodegenBackend {
620 compiler: builder.compiler(1, build.build),
622 backend: self.backend,
627 let mut cargo = builder.cargo(compiler, Mode::Librustc, target, "build");
628 let mut features = build.rustc_features().to_string();
629 cargo.arg("--manifest-path")
630 .arg(build.src.join("src/librustc_trans/Cargo.toml"));
631 rustc_cargo_env(build, &mut cargo);
633 match &*self.backend {
634 "llvm" | "emscripten" => {
635 // Build LLVM for our target. This will implicitly build the
636 // host LLVM if necessary.
637 let llvm_config = builder.ensure(native::Llvm {
639 emscripten: self.backend == "emscripten",
642 if self.backend == "emscripten" {
643 features.push_str(" emscripten");
646 let _folder = build.fold_output(|| format!("stage{}-rustc_trans", compiler.stage));
647 println!("Building stage{} codegen artifacts ({} -> {}, {})",
648 compiler.stage, &compiler.host, target, self.backend);
650 // Pass down configuration from the LLVM build into the build of
651 // librustc_llvm and librustc_trans.
652 if build.is_rust_llvm(target) {
653 cargo.env("LLVM_RUSTLLVM", "1");
655 cargo.env("LLVM_CONFIG", &llvm_config);
656 if self.backend != "emscripten" {
657 let target_config = build.config.target_config.get(&target);
658 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
659 cargo.env("CFG_LLVM_ROOT", s);
662 // Building with a static libstdc++ is only supported on linux right now,
663 // not for MSVC or macOS
664 if build.config.llvm_static_stdcpp &&
665 !target.contains("freebsd") &&
666 !target.contains("windows") &&
667 !target.contains("apple") {
668 let file = compiler_file(build,
669 build.cxx(target).unwrap(),
672 cargo.env("LLVM_STATIC_STDCPP", file);
674 if build.config.llvm_link_shared {
675 cargo.env("LLVM_LINK_SHARED", "1");
678 _ => panic!("unknown backend: {}", self.backend),
681 let tmp_stamp = build.cargo_out(compiler, Mode::Librustc, target)
683 let files = run_cargo(build,
684 cargo.arg("--features").arg(features),
687 let mut files = files.into_iter()
689 let filename = f.file_name().unwrap().to_str().unwrap();
690 is_dylib(filename) && filename.contains("rustc_trans-")
692 let codegen_backend = match files.next() {
694 None => panic!("no dylibs built for codegen backend?"),
696 if let Some(f) = files.next() {
697 panic!("codegen backend built two dylibs:\n{}\n{}",
698 codegen_backend.display(),
701 let stamp = codegen_backend_stamp(build, compiler, target, self.backend);
702 let codegen_backend = codegen_backend.to_str().unwrap();
703 t!(t!(File::create(&stamp)).write_all(codegen_backend.as_bytes()));
707 /// Creates the `codegen-backends` folder for a compiler that's about to be
708 /// assembled as a complete compiler.
710 /// This will take the codegen artifacts produced by `compiler` and link them
711 /// into an appropriate location for `target_compiler` to be a functional
713 fn copy_codegen_backends_to_sysroot(builder: &Builder,
715 target_compiler: Compiler) {
716 let build = builder.build;
717 let target = target_compiler.host;
719 // Note that this step is different than all the other `*Link` steps in
720 // that it's not assembling a bunch of libraries but rather is primarily
721 // moving the codegen backend into place. The codegen backend of rustc is
722 // not linked into the main compiler by default but is rather dynamically
723 // selected at runtime for inclusion.
725 // Here we're looking for the output dylib of the `CodegenBackend` step and
726 // we're copying that into the `codegen-backends` folder.
727 let dst = builder.sysroot_codegen_backends(target_compiler);
728 t!(fs::create_dir_all(&dst));
730 for backend in builder.config.rust_codegen_backends.iter() {
731 let stamp = codegen_backend_stamp(build, compiler, target, *backend);
732 let mut dylib = String::new();
733 t!(t!(File::open(&stamp)).read_to_string(&mut dylib));
734 let file = Path::new(&dylib);
735 let filename = file.file_name().unwrap().to_str().unwrap();
736 // change `librustc_trans-xxxxxx.so` to `librustc_trans-llvm.so`
737 let target_filename = {
738 let dash = filename.find("-").unwrap();
739 let dot = filename.find(".").unwrap();
745 copy(&file, &dst.join(target_filename));
749 /// Cargo's output path for the standard library in a given stage, compiled
750 /// by a particular compiler for the specified target.
751 pub fn libstd_stamp(build: &Build, compiler: Compiler, target: Interned<String>) -> PathBuf {
752 build.cargo_out(compiler, Mode::Libstd, target).join(".libstd.stamp")
755 /// Cargo's output path for libtest in a given stage, compiled by a particular
756 /// compiler for the specified target.
757 pub fn libtest_stamp(build: &Build, compiler: Compiler, target: Interned<String>) -> PathBuf {
758 build.cargo_out(compiler, Mode::Libtest, target).join(".libtest.stamp")
761 /// Cargo's output path for librustc in a given stage, compiled by a particular
762 /// compiler for the specified target.
763 pub fn librustc_stamp(build: &Build, compiler: Compiler, target: Interned<String>) -> PathBuf {
764 build.cargo_out(compiler, Mode::Librustc, target).join(".librustc.stamp")
767 fn codegen_backend_stamp(build: &Build,
769 target: Interned<String>,
770 backend: Interned<String>) -> PathBuf {
771 build.cargo_out(compiler, Mode::Librustc, target)
772 .join(format!(".librustc_trans-{}.stamp", backend))
775 fn compiler_file(build: &Build,
777 target: Interned<String>,
778 file: &str) -> PathBuf {
779 let mut cmd = Command::new(compiler);
780 cmd.args(build.cflags(target));
781 cmd.arg(format!("-print-file-name={}", file));
782 let out = output(&mut cmd);
783 PathBuf::from(out.trim())
786 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
788 pub compiler: Compiler,
791 impl Step for Sysroot {
792 type Output = Interned<PathBuf>;
794 fn should_run(run: ShouldRun) -> ShouldRun {
798 /// Returns the sysroot for the `compiler` specified that *this build system
801 /// That is, the sysroot for the stage0 compiler is not what the compiler
802 /// thinks it is by default, but it's the same as the default for stages
804 fn run(self, builder: &Builder) -> Interned<PathBuf> {
805 let build = builder.build;
806 let compiler = self.compiler;
807 let sysroot = if compiler.stage == 0 {
808 build.out.join(&compiler.host).join("stage0-sysroot")
810 build.out.join(&compiler.host).join(format!("stage{}", compiler.stage))
812 let _ = fs::remove_dir_all(&sysroot);
813 t!(fs::create_dir_all(&sysroot));
814 INTERNER.intern_path(sysroot)
818 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
819 pub struct Assemble {
820 /// The compiler which we will produce in this step. Assemble itself will
821 /// take care of ensuring that the necessary prerequisites to do so exist,
822 /// that is, this target can be a stage2 compiler and Assemble will build
823 /// previous stages for you.
824 pub target_compiler: Compiler,
827 impl Step for Assemble {
828 type Output = Compiler;
830 fn should_run(run: ShouldRun) -> ShouldRun {
831 run.path("src/rustc")
834 /// Prepare a new compiler from the artifacts in `stage`
836 /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
837 /// must have been previously produced by the `stage - 1` build.build
839 fn run(self, builder: &Builder) -> Compiler {
840 let build = builder.build;
841 let target_compiler = self.target_compiler;
843 if target_compiler.stage == 0 {
844 assert_eq!(build.build, target_compiler.host,
845 "Cannot obtain compiler for non-native build triple at stage 0");
846 // The stage 0 compiler for the build triple is always pre-built.
847 return target_compiler;
850 // Get the compiler that we'll use to bootstrap ourselves.
852 // Note that this is where the recursive nature of the bootstrap
853 // happens, as this will request the previous stage's compiler on
854 // downwards to stage 0.
856 // Also note that we're building a compiler for the host platform. We
857 // only assume that we can run `build` artifacts, which means that to
858 // produce some other architecture compiler we need to start from
859 // `build` to get there.
861 // FIXME: Perhaps we should download those libraries?
862 // It would make builds faster...
864 // FIXME: It may be faster if we build just a stage 1 compiler and then
865 // use that to bootstrap this compiler forward.
867 builder.compiler(target_compiler.stage - 1, build.build);
869 // Build the libraries for this compiler to link to (i.e., the libraries
870 // it uses at runtime). NOTE: Crates the target compiler compiles don't
871 // link to these. (FIXME: Is that correct? It seems to be correct most
872 // of the time but I think we do link to these for stage2/bin compilers
873 // when not performing a full bootstrap).
874 if builder.build.config.keep_stage.map_or(false, |s| target_compiler.stage <= s) {
875 builder.verbose("skipping compilation of compiler due to --keep-stage");
876 let compiler = build_compiler;
877 for stage in 0..min(target_compiler.stage, builder.config.keep_stage.unwrap()) {
878 let target_compiler = builder.compiler(stage, target_compiler.host);
879 let target = target_compiler.host;
880 builder.ensure(StdLink { compiler, target_compiler, target });
881 builder.ensure(TestLink { compiler, target_compiler, target });
882 builder.ensure(RustcLink { compiler, target_compiler, target });
885 builder.ensure(Rustc {
886 compiler: build_compiler,
887 target: target_compiler.host,
889 for &backend in build.config.rust_codegen_backends.iter() {
890 builder.ensure(CodegenBackend {
891 compiler: build_compiler,
892 target: target_compiler.host,
898 let stage = target_compiler.stage;
899 let host = target_compiler.host;
900 println!("Assembling stage{} compiler ({})", stage, host);
902 // Link in all dylibs to the libdir
903 let sysroot = builder.sysroot(target_compiler);
904 let sysroot_libdir = sysroot.join(libdir(&*host));
905 t!(fs::create_dir_all(&sysroot_libdir));
906 let src_libdir = builder.sysroot_libdir(build_compiler, host);
907 for f in t!(fs::read_dir(&src_libdir)).map(|f| t!(f)) {
908 let filename = f.file_name().into_string().unwrap();
909 if is_dylib(&filename) {
910 copy(&f.path(), &sysroot_libdir.join(&filename));
914 copy_codegen_backends_to_sysroot(builder,
918 // Link the compiler binary itself into place
919 let out_dir = build.cargo_out(build_compiler, Mode::Librustc, host);
920 let rustc = out_dir.join(exe("rustc", &*host));
921 let bindir = sysroot.join("bin");
922 t!(fs::create_dir_all(&bindir));
923 let compiler = builder.rustc(target_compiler);
924 let _ = fs::remove_file(&compiler);
925 copy(&rustc, &compiler);
931 /// Link some files into a rustc sysroot.
933 /// For a particular stage this will link the file listed in `stamp` into the
934 /// `sysroot_dst` provided.
935 pub fn add_to_sysroot(sysroot_dst: &Path, stamp: &Path) {
936 t!(fs::create_dir_all(&sysroot_dst));
937 for path in read_stamp_file(stamp) {
938 copy(&path, &sysroot_dst.join(path.file_name().unwrap()));
942 // Avoiding a dependency on winapi to keep compile times down
944 fn stderr_isatty() -> bool {
946 unsafe { libc::isatty(libc::STDERR_FILENO) != 0 }
949 fn stderr_isatty() -> bool {
952 type HANDLE = *mut u8;
953 const STD_ERROR_HANDLE: DWORD = -12i32 as DWORD;
955 fn GetStdHandle(which: DWORD) -> HANDLE;
956 fn GetConsoleMode(hConsoleHandle: HANDLE, lpMode: *mut DWORD) -> BOOL;
959 let handle = GetStdHandle(STD_ERROR_HANDLE);
961 GetConsoleMode(handle, &mut out) != 0
965 pub fn run_cargo(build: &Build, cargo: &mut Command, stamp: &Path, is_check: bool)
968 // Instruct Cargo to give us json messages on stdout, critically leaving
969 // stderr as piped so we can get those pretty colors.
970 cargo.arg("--message-format").arg("json")
971 .stdout(Stdio::piped());
973 if stderr_isatty() && build.ci_env == CiEnv::None {
974 // since we pass message-format=json to cargo, we need to tell the rustc
975 // wrapper to give us colored output if necessary. This is because we
976 // only want Cargo's JSON output, not rustcs.
977 cargo.env("RUSTC_COLOR", "1");
980 build.verbose(&format!("running: {:?}", cargo));
981 let mut child = match cargo.spawn() {
983 Err(e) => panic!("failed to execute command: {:?}\nerror: {}", cargo, e),
986 // `target_root_dir` looks like $dir/$target/release
987 let target_root_dir = stamp.parent().unwrap();
988 // `target_deps_dir` looks like $dir/$target/release/deps
989 let target_deps_dir = target_root_dir.join("deps");
990 // `host_root_dir` looks like $dir/release
991 let host_root_dir = target_root_dir.parent().unwrap() // chop off `release`
992 .parent().unwrap() // chop off `$target`
993 .join(target_root_dir.file_name().unwrap());
995 // Spawn Cargo slurping up its JSON output. We'll start building up the
996 // `deps` array of all files it generated along with a `toplevel` array of
997 // files we need to probe for later.
998 let mut deps = Vec::new();
999 let mut toplevel = Vec::new();
1000 let stdout = BufReader::new(child.stdout.take().unwrap());
1001 for line in stdout.lines() {
1002 let line = t!(line);
1003 let json: serde_json::Value = if line.starts_with("{") {
1004 t!(serde_json::from_str(&line))
1006 // If this was informational, just print it out and continue
1007 println!("{}", line);
1010 if json["reason"].as_str() != Some("compiler-artifact") {
1013 for filename in json["filenames"].as_array().unwrap() {
1014 let filename = filename.as_str().unwrap();
1015 // Skip files like executables
1016 if !filename.ends_with(".rlib") &&
1017 !filename.ends_with(".lib") &&
1018 !is_dylib(&filename) &&
1019 !(is_check && filename.ends_with(".rmeta")) {
1023 let filename = Path::new(filename);
1025 // If this was an output file in the "host dir" we don't actually
1026 // worry about it, it's not relevant for us.
1027 if filename.starts_with(&host_root_dir) {
1031 // If this was output in the `deps` dir then this is a precise file
1032 // name (hash included) so we start tracking it.
1033 if filename.starts_with(&target_deps_dir) {
1034 deps.push(filename.to_path_buf());
1038 // Otherwise this was a "top level artifact" which right now doesn't
1039 // have a hash in the name, but there's a version of this file in
1040 // the `deps` folder which *does* have a hash in the name. That's
1041 // the one we'll want to we'll probe for it later.
1043 // We do not use `Path::file_stem` or `Path::extension` here,
1044 // because some generated files may have multiple extensions e.g.
1045 // `std-<hash>.dll.lib` on Windows. The aforementioned methods only
1046 // split the file name by the last extension (`.lib`) while we need
1047 // to split by all extensions (`.dll.lib`).
1048 let expected_len = t!(filename.metadata()).len();
1049 let filename = filename.file_name().unwrap().to_str().unwrap();
1050 let mut parts = filename.splitn(2, '.');
1051 let file_stem = parts.next().unwrap().to_owned();
1052 let extension = parts.next().unwrap().to_owned();
1054 toplevel.push((file_stem, extension, expected_len));
1058 // Make sure Cargo actually succeeded after we read all of its stdout.
1059 let status = t!(child.wait());
1060 if !status.success() {
1061 panic!("command did not execute successfully: {:?}\n\
1062 expected success, got: {}",
1067 // Ok now we need to actually find all the files listed in `toplevel`. We've
1068 // got a list of prefix/extensions and we basically just need to find the
1069 // most recent file in the `deps` folder corresponding to each one.
1070 let contents = t!(target_deps_dir.read_dir())
1072 .map(|e| (e.path(), e.file_name().into_string().unwrap(), t!(e.metadata())))
1073 .collect::<Vec<_>>();
1074 for (prefix, extension, expected_len) in toplevel {
1075 let candidates = contents.iter().filter(|&&(_, ref filename, ref meta)| {
1076 filename.starts_with(&prefix[..]) &&
1077 filename[prefix.len()..].starts_with("-") &&
1078 filename.ends_with(&extension[..]) &&
1079 meta.len() == expected_len
1081 let max = candidates.max_by_key(|&&(_, _, ref metadata)| {
1082 FileTime::from_last_modification_time(metadata)
1084 let path_to_add = match max {
1085 Some(triple) => triple.0.to_str().unwrap(),
1086 None => panic!("no output generated for {:?} {:?}", prefix, extension),
1088 if is_dylib(path_to_add) {
1089 let candidate = format!("{}.lib", path_to_add);
1090 let candidate = PathBuf::from(candidate);
1091 if candidate.exists() {
1092 deps.push(candidate);
1095 deps.push(path_to_add.into());
1098 // Now we want to update the contents of the stamp file, if necessary. First
1099 // we read off the previous contents along with its mtime. If our new
1100 // contents (the list of files to copy) is different or if any dep's mtime
1101 // is newer then we rewrite the stamp file.
1103 let mut stamp_contents = Vec::new();
1104 if let Ok(mut f) = File::open(stamp) {
1105 t!(f.read_to_end(&mut stamp_contents));
1107 let stamp_mtime = mtime(&stamp);
1108 let mut new_contents = Vec::new();
1110 let mut max_path = None;
1111 for dep in deps.iter() {
1112 let mtime = mtime(dep);
1113 if Some(mtime) > max {
1115 max_path = Some(dep.clone());
1117 new_contents.extend(dep.to_str().unwrap().as_bytes());
1118 new_contents.extend(b"\0");
1120 let max = max.unwrap();
1121 let max_path = max_path.unwrap();
1122 if stamp_contents == new_contents && max <= stamp_mtime {
1123 build.verbose(&format!("not updating {:?}; contents equal and {} <= {}",
1124 stamp, max, stamp_mtime));
1127 if max > stamp_mtime {
1128 build.verbose(&format!("updating {:?} as {:?} changed", stamp, max_path));
1130 build.verbose(&format!("updating {:?} as deps changed", stamp));
1132 t!(t!(File::create(stamp)).write_all(&new_contents));