]> git.lizzy.rs Git - rust.git/blob - src/bootstrap/compile.rs
rustc: Load the `rustc_trans` crate at runtime
[rust.git] / src / bootstrap / compile.rs
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.
4 //
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.
10
11 //! Implementation of compiling various phases of the compiler and standard
12 //! library.
13 //!
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.
18
19 use std::env;
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};
25 use std::str;
26 use std::cmp::min;
27
28 use build_helper::{output, mtime, up_to_date};
29 use filetime::FileTime;
30 use serde_json;
31
32 use util::{exe, libdir, is_dylib, copy, read_stamp_file, CiEnv};
33 use {Build, Compiler, Mode};
34 use native;
35 use tool;
36
37 use cache::{INTERNER, Interned};
38 use builder::{Step, RunConfig, ShouldRun, Builder};
39
40 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
41 pub struct Std {
42     pub target: Interned<String>,
43     pub compiler: Compiler,
44 }
45
46 impl Step for Std {
47     type Output = ();
48     const DEFAULT: bool = true;
49
50     fn should_run(run: ShouldRun) -> ShouldRun {
51         run.path("src/libstd").krate("std")
52     }
53
54     fn make_run(run: RunConfig) {
55         run.builder.ensure(Std {
56             compiler: run.builder.compiler(run.builder.top_stage, run.host),
57             target: run.target,
58         });
59     }
60
61     /// Build the standard library.
62     ///
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;
70
71         builder.ensure(StartupObjects { compiler, target });
72
73         if build.force_use_stage1(compiler, target) {
74             let from = builder.compiler(1, build.build);
75             builder.ensure(Std {
76                 compiler: from,
77                 target,
78             });
79             println!("Uplifting stage1 std ({} -> {})", from.host, target);
80
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") && !target.contains("mips") {
84                 let libdir = builder.sysroot_libdir(compiler, target);
85                 copy_musl_third_party_objects(build, target, &libdir);
86             }
87
88             builder.ensure(StdLink {
89                 compiler: from,
90                 target_compiler: compiler,
91                 target,
92             });
93             return;
94         }
95
96         let _folder = build.fold_output(|| format!("stage{}-std", compiler.stage));
97         println!("Building stage{} std artifacts ({} -> {})", compiler.stage,
98                 &compiler.host, target);
99
100         if target.contains("musl") && !target.contains("mips") {
101             let libdir = builder.sysroot_libdir(compiler, target);
102             copy_musl_third_party_objects(build, target, &libdir);
103         }
104
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);
109         run_cargo(build,
110                   &mut cargo,
111                   &libstd_stamp(build, compiler, target),
112                   false);
113
114         builder.ensure(StdLink {
115             compiler: builder.compiler(compiler.stage, build.build),
116             target_compiler: compiler,
117             target,
118         });
119     }
120 }
121
122 /// Copies the crt(1,i,n).o startup objects
123 ///
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>,
130                                  into: &Path) {
131     for &obj in &["crt1.o", "crti.o", "crtn.o"] {
132         copy(&build.musl_root(target).unwrap().join("lib").join(obj), &into.join(obj));
133     }
134 }
135
136 /// Configure cargo to compile the standard library, adding appropriate env vars
137 /// and such.
138 pub fn std_cargo(build: &Build,
139                  compiler: &Compiler,
140                  target: Interned<String>,
141                  cargo: &mut Command) {
142     let mut features = build.std_features();
143
144     if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
145         cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
146     }
147
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");
155     }
156
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
162         // missing
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));
166     }
167
168     cargo.arg("--features").arg(features)
169         .arg("--manifest-path")
170         .arg(build.src.join("src/libstd/Cargo.toml"));
171
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);
175         }
176     }
177     if target.contains("musl") {
178         if let Some(p) = build.musl_root(target) {
179             cargo.env("MUSL_ROOT", p);
180         }
181     }
182 }
183
184 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
185 struct StdLink {
186     pub compiler: Compiler,
187     pub target_compiler: Compiler,
188     pub target: Interned<String>,
189 }
190
191 impl Step for StdLink {
192     type Output = ();
193
194     fn should_run(run: ShouldRun) -> ShouldRun {
195         run.never()
196     }
197
198     /// Link all libstd rlibs/dylibs into the sysroot location.
199     ///
200     /// Links those artifacts generated by `compiler` to a the `stage` compiler's
201     /// sysroot for the specified `host` and `target`.
202     ///
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,
213                 compiler.stage,
214                 &compiler.host,
215                 target_compiler.host,
216                 target);
217         let libdir = builder.sysroot_libdir(target_compiler, target);
218         add_to_sysroot(&libdir, &libstd_stamp(build, compiler, target));
219
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);
225         }
226
227         builder.ensure(tool::CleanTools {
228             compiler: target_compiler,
229             target,
230             mode: Mode::Libstd,
231         });
232     }
233 }
234
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));
244     }
245 }
246
247 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
248 pub struct StartupObjects {
249     pub compiler: Compiler,
250     pub target: Interned<String>,
251 }
252
253 impl Step for StartupObjects {
254     type Output = ();
255
256     fn should_run(run: ShouldRun) -> ShouldRun {
257         run.path("src/rtstartup")
258     }
259
260     fn make_run(run: RunConfig) {
261         run.builder.ensure(StartupObjects {
262             compiler: run.builder.compiler(run.builder.top_stage, run.host),
263             target: run.target,
264         });
265     }
266
267     /// Build and prepare startup objects like rsbegin.o and rsend.o
268     ///
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") {
278             return
279         }
280
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));
285
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)
294                             .arg("--emit=obj")
295                             .arg("-o").arg(dst_file)
296                             .arg(src_file));
297             }
298
299             copy(dst_file, &sysroot_dir.join(file.to_string() + ".o"));
300         }
301
302         for obj in ["crt2.o", "dllcrt2.o"].iter() {
303             let src = compiler_file(build,
304                                     build.cc(target),
305                                     target,
306                                     obj);
307             copy(&src, &sysroot_dir.join(obj));
308         }
309     }
310 }
311
312 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
313 pub struct Test {
314     pub compiler: Compiler,
315     pub target: Interned<String>,
316 }
317
318 impl Step for Test {
319     type Output = ();
320     const DEFAULT: bool = true;
321
322     fn should_run(run: ShouldRun) -> ShouldRun {
323         run.path("src/libtest").krate("test")
324     }
325
326     fn make_run(run: RunConfig) {
327         run.builder.ensure(Test {
328             compiler: run.builder.compiler(run.builder.top_stage, run.host),
329             target: run.target,
330         });
331     }
332
333     /// Build libtest.
334     ///
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;
342
343         builder.ensure(Std { compiler, target });
344
345         if build.force_use_stage1(compiler, target) {
346             builder.ensure(Test {
347                 compiler: builder.compiler(1, build.build),
348                 target,
349             });
350             println!("Uplifting stage1 test ({} -> {})", &build.build, target);
351             builder.ensure(TestLink {
352                 compiler: builder.compiler(1, build.build),
353                 target_compiler: compiler,
354                 target,
355             });
356             return;
357         }
358
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);
366         run_cargo(build,
367                   &mut cargo,
368                   &libtest_stamp(build, compiler, target),
369                   false);
370
371         builder.ensure(TestLink {
372             compiler: builder.compiler(compiler.stage, build.build),
373             target_compiler: compiler,
374             target,
375         });
376     }
377 }
378
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);
386     }
387     cargo.arg("--manifest-path")
388         .arg(build.src.join("src/libtest/Cargo.toml"));
389 }
390
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>,
396 }
397
398 impl Step for TestLink {
399     type Output = ();
400
401     fn should_run(run: ShouldRun) -> ShouldRun {
402         run.never()
403     }
404
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,
413                 compiler.stage,
414                 &compiler.host,
415                 target_compiler.host,
416                 target);
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,
421             target,
422             mode: Mode::Libtest,
423         });
424     }
425 }
426
427 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
428 pub struct Rustc {
429     pub compiler: Compiler,
430     pub target: Interned<String>,
431 }
432
433 impl Step for Rustc {
434     type Output = ();
435     const ONLY_HOSTS: bool = true;
436     const DEFAULT: bool = true;
437
438     fn should_run(run: ShouldRun) -> ShouldRun {
439         run.path("src/librustc").krate("rustc-main")
440     }
441
442     fn make_run(run: RunConfig) {
443         run.builder.ensure(Rustc {
444             compiler: run.builder.compiler(run.builder.top_stage, run.host),
445             target: run.target,
446         });
447     }
448
449     /// Build the compiler.
450     ///
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;
458
459         builder.ensure(Test { compiler, target });
460
461         if build.force_use_stage1(compiler, target) {
462             builder.ensure(Rustc {
463                 compiler: builder.compiler(1, build.build),
464                 target,
465             });
466             println!("Uplifting stage1 rustc ({} -> {})", &build.build, target);
467             builder.ensure(RustcLink {
468                 compiler: builder.compiler(1, build.build),
469                 target_compiler: compiler,
470                 target,
471             });
472             return;
473         }
474
475         // Ensure that build scripts have a std to link against.
476         builder.ensure(Std {
477             compiler: builder.compiler(self.compiler.stage, build.build),
478             target: build.build,
479         });
480
481         let _folder = build.fold_output(|| format!("stage{}-rustc", compiler.stage));
482         println!("Building stage{} compiler artifacts ({} -> {})",
483                  compiler.stage, &compiler.host, target);
484
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));
488
489         let mut cargo = builder.cargo(compiler, Mode::Librustc, target, "build");
490         rustc_cargo(build, &mut cargo);
491         run_cargo(build,
492                   &mut cargo,
493                   &librustc_stamp(build, compiler, target),
494                   false);
495
496         builder.ensure(RustcLink {
497             compiler: builder.compiler(compiler.stage, build.build),
498             target_compiler: compiler,
499             target,
500         });
501     }
502 }
503
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);
509 }
510
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());
518
519     let libdir_relative =
520         build.config.libdir.clone().unwrap_or(PathBuf::from("lib"));
521     cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
522
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");
528     }
529
530     if let Some(ref ver_date) = build.rust_info.commit_date() {
531         cargo.env("CFG_VER_DATE", ver_date);
532     }
533     if let Some(ref ver_hash) = build.rust_info.sha() {
534         cargo.env("CFG_VER_HASH", ver_hash);
535     }
536     if !build.unstable_features() {
537         cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
538     }
539     if let Some(ref s) = build.config.rustc_default_linker {
540         cargo.env("CFG_DEFAULT_LINKER", s);
541     }
542     if build.config.rustc_parallel_queries {
543         cargo.env("RUSTC_PARALLEL_QUERIES", "1");
544     }
545 }
546
547 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
548 struct RustcLink {
549     pub compiler: Compiler,
550     pub target_compiler: Compiler,
551     pub target: Interned<String>,
552 }
553
554 impl Step for RustcLink {
555     type Output = ();
556
557     fn should_run(run: ShouldRun) -> ShouldRun {
558         run.never()
559     }
560
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,
569                  compiler.stage,
570                  &compiler.host,
571                  target_compiler.host,
572                  target);
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,
577             target,
578             mode: Mode::Librustc,
579         });
580     }
581 }
582
583 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
584 pub struct RustcTrans {
585     pub compiler: Compiler,
586     pub target: Interned<String>,
587 }
588
589 impl Step for RustcTrans {
590     type Output = ();
591     const ONLY_HOSTS: bool = true;
592     const DEFAULT: bool = true;
593
594     fn should_run(run: ShouldRun) -> ShouldRun {
595         run.path("src/librustc_trans").krate("rustc_trans")
596     }
597
598     fn make_run(run: RunConfig) {
599         run.builder.ensure(RustcTrans {
600             compiler: run.builder.compiler(run.builder.top_stage, run.host),
601             target: run.target,
602         });
603     }
604
605     fn run(self, builder: &Builder) {
606         let build = builder.build;
607         let compiler = self.compiler;
608         let target = self.target;
609
610         builder.ensure(Rustc { compiler, target });
611
612         // Build LLVM for our target. This will implicitly build the host LLVM
613         // if necessary.
614         builder.ensure(native::Llvm { target });
615
616         if build.force_use_stage1(compiler, target) {
617             builder.ensure(RustcTrans {
618                 compiler: builder.compiler(1, build.build),
619                 target,
620             });
621             return;
622         }
623
624         let _folder = build.fold_output(|| format!("stage{}-rustc_trans", compiler.stage));
625         println!("Building stage{} trans artifacts ({} -> {})",
626                  compiler.stage, &compiler.host, target);
627
628         let mut cargo = builder.cargo(compiler, Mode::Librustc, target, "build");
629         cargo.arg("--manifest-path")
630             .arg(build.src.join("src/librustc_trans/Cargo.toml"))
631             .arg("--features").arg(build.rustc_features());
632         rustc_cargo_env(build, &mut cargo);
633
634         // Pass down configuration from the LLVM build into the build of
635         // librustc_llvm and librustc_trans.
636         if build.is_rust_llvm(target) {
637             cargo.env("LLVM_RUSTLLVM", "1");
638         }
639         cargo.env("LLVM_CONFIG", build.llvm_config(target));
640         let target_config = build.config.target_config.get(&target);
641         if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
642             cargo.env("CFG_LLVM_ROOT", s);
643         }
644         // Building with a static libstdc++ is only supported on linux right now,
645         // not for MSVC or macOS
646         if build.config.llvm_static_stdcpp &&
647            !target.contains("freebsd") &&
648            !target.contains("windows") &&
649            !target.contains("apple") {
650             let file = compiler_file(build,
651                                      build.cxx(target).unwrap(),
652                                      target,
653                                      "libstdc++.a");
654             cargo.env("LLVM_STATIC_STDCPP", file);
655         }
656         if build.config.llvm_link_shared {
657             cargo.env("LLVM_LINK_SHARED", "1");
658         }
659
660         run_cargo(build,
661                   &mut cargo,
662                   &librustc_trans_stamp(build, compiler, target),
663                   false);
664     }
665 }
666
667 /// Creates the `codegen-backends` folder for a compiler that's about to be
668 /// assembled as a complete compiler.
669 ///
670 /// This will take the codegen artifacts produced by `compiler` and link them
671 /// into an appropriate location for `target_compiler` to be a functional
672 /// compiler.
673 fn copy_codegen_backends_to_sysroot(builder: &Builder,
674                                     compiler: Compiler,
675                                     target_compiler: Compiler) {
676     let build = builder.build;
677     let target = target_compiler.host;
678
679     // Note that this step is different than all the other `*Link` steps in
680     // that it's not assembling a bunch of libraries but rather is primarily
681     // moving the codegen backend into place. The codegen backend of rustc is
682     // not linked into the main compiler by default but is rather dynamically
683     // selected at runtime for inclusion.
684     //
685     // Here we're looking for the output dylib of the `RustcTrans` step and
686     // we're copying that into the `codegen-backends` folder.
687     let libdir = builder.sysroot_libdir(target_compiler, target);
688     let dst = libdir.join("codegen-backends");
689     t!(fs::create_dir_all(&dst));
690     let stamp = librustc_trans_stamp(build, compiler, target);
691
692     let mut copied = None;
693     for file in read_stamp_file(&stamp) {
694         let filename = match file.file_name().and_then(|s| s.to_str()) {
695             Some(s) => s,
696             None => continue,
697         };
698         if !is_dylib(filename) || !filename.contains("rustc_trans-") {
699             continue
700         }
701         match copied {
702             None => copied = Some(file.clone()),
703             Some(ref s) => {
704                 panic!("copied two codegen backends:\n{}\n{}",
705                        s.display(),
706                        file.display());
707             }
708         }
709         copy(&file, &dst.join(filename));
710     }
711     assert!(copied.is_some(), "failed to find a codegen backend to copy");
712 }
713
714 /// Cargo's output path for the standard library in a given stage, compiled
715 /// by a particular compiler for the specified target.
716 pub fn libstd_stamp(build: &Build, compiler: Compiler, target: Interned<String>) -> PathBuf {
717     build.cargo_out(compiler, Mode::Libstd, target).join(".libstd.stamp")
718 }
719
720 /// Cargo's output path for libtest in a given stage, compiled by a particular
721 /// compiler for the specified target.
722 pub fn libtest_stamp(build: &Build, compiler: Compiler, target: Interned<String>) -> PathBuf {
723     build.cargo_out(compiler, Mode::Libtest, target).join(".libtest.stamp")
724 }
725
726 /// Cargo's output path for librustc in a given stage, compiled by a particular
727 /// compiler for the specified target.
728 pub fn librustc_stamp(build: &Build, compiler: Compiler, target: Interned<String>) -> PathBuf {
729     build.cargo_out(compiler, Mode::Librustc, target).join(".librustc.stamp")
730 }
731
732 pub fn librustc_trans_stamp(build: &Build,
733                             compiler: Compiler,
734                             target: Interned<String>) -> PathBuf {
735     build.cargo_out(compiler, Mode::Librustc, target).join(".librustc_trans.stamp")
736 }
737
738 fn compiler_file(build: &Build,
739                  compiler: &Path,
740                  target: Interned<String>,
741                  file: &str) -> PathBuf {
742     let mut cmd = Command::new(compiler);
743     cmd.args(build.cflags(target));
744     cmd.arg(format!("-print-file-name={}", file));
745     let out = output(&mut cmd);
746     PathBuf::from(out.trim())
747 }
748
749 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
750 pub struct Sysroot {
751     pub compiler: Compiler,
752 }
753
754 impl Step for Sysroot {
755     type Output = Interned<PathBuf>;
756
757     fn should_run(run: ShouldRun) -> ShouldRun {
758         run.never()
759     }
760
761     /// Returns the sysroot for the `compiler` specified that *this build system
762     /// generates*.
763     ///
764     /// That is, the sysroot for the stage0 compiler is not what the compiler
765     /// thinks it is by default, but it's the same as the default for stages
766     /// 1-3.
767     fn run(self, builder: &Builder) -> Interned<PathBuf> {
768         let build = builder.build;
769         let compiler = self.compiler;
770         let sysroot = if compiler.stage == 0 {
771             build.out.join(&compiler.host).join("stage0-sysroot")
772         } else {
773             build.out.join(&compiler.host).join(format!("stage{}", compiler.stage))
774         };
775         let _ = fs::remove_dir_all(&sysroot);
776         t!(fs::create_dir_all(&sysroot));
777         INTERNER.intern_path(sysroot)
778     }
779 }
780
781 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
782 pub struct Assemble {
783     /// The compiler which we will produce in this step. Assemble itself will
784     /// take care of ensuring that the necessary prerequisites to do so exist,
785     /// that is, this target can be a stage2 compiler and Assemble will build
786     /// previous stages for you.
787     pub target_compiler: Compiler,
788 }
789
790 impl Step for Assemble {
791     type Output = Compiler;
792
793     fn should_run(run: ShouldRun) -> ShouldRun {
794         run.path("src/rustc")
795     }
796
797     /// Prepare a new compiler from the artifacts in `stage`
798     ///
799     /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
800     /// must have been previously produced by the `stage - 1` build.build
801     /// compiler.
802     fn run(self, builder: &Builder) -> Compiler {
803         let build = builder.build;
804         let target_compiler = self.target_compiler;
805
806         if target_compiler.stage == 0 {
807             assert_eq!(build.build, target_compiler.host,
808                 "Cannot obtain compiler for non-native build triple at stage 0");
809             // The stage 0 compiler for the build triple is always pre-built.
810             return target_compiler;
811         }
812
813         // Get the compiler that we'll use to bootstrap ourselves.
814         //
815         // Note that this is where the recursive nature of the bootstrap
816         // happens, as this will request the previous stage's compiler on
817         // downwards to stage 0.
818         //
819         // Also note that we're building a compiler for the host platform. We
820         // only assume that we can run `build` artifacts, which means that to
821         // produce some other architecture compiler we need to start from
822         // `build` to get there.
823         //
824         // FIXME: Perhaps we should download those libraries?
825         //        It would make builds faster...
826         //
827         // FIXME: It may be faster if we build just a stage 1 compiler and then
828         //        use that to bootstrap this compiler forward.
829         let build_compiler =
830             builder.compiler(target_compiler.stage - 1, build.build);
831
832         // Build the libraries for this compiler to link to (i.e., the libraries
833         // it uses at runtime). NOTE: Crates the target compiler compiles don't
834         // link to these. (FIXME: Is that correct? It seems to be correct most
835         // of the time but I think we do link to these for stage2/bin compilers
836         // when not performing a full bootstrap).
837         if builder.build.config.keep_stage.map_or(false, |s| target_compiler.stage <= s) {
838             builder.verbose("skipping compilation of compiler due to --keep-stage");
839             let compiler = build_compiler;
840             for stage in 0..min(target_compiler.stage, builder.config.keep_stage.unwrap()) {
841                 let target_compiler = builder.compiler(stage, target_compiler.host);
842                 let target = target_compiler.host;
843                 builder.ensure(StdLink { compiler, target_compiler, target });
844                 builder.ensure(TestLink { compiler, target_compiler, target });
845                 builder.ensure(RustcLink { compiler, target_compiler, target });
846             }
847         } else {
848             builder.ensure(Rustc {
849                 compiler: build_compiler,
850                 target: target_compiler.host,
851             });
852             builder.ensure(RustcTrans {
853                 compiler: build_compiler,
854                 target: target_compiler.host,
855             });
856         }
857
858         let stage = target_compiler.stage;
859         let host = target_compiler.host;
860         println!("Assembling stage{} compiler ({})", stage, host);
861
862         // Link in all dylibs to the libdir
863         let sysroot = builder.sysroot(target_compiler);
864         let sysroot_libdir = sysroot.join(libdir(&*host));
865         t!(fs::create_dir_all(&sysroot_libdir));
866         let src_libdir = builder.sysroot_libdir(build_compiler, host);
867         for f in t!(fs::read_dir(&src_libdir)).map(|f| t!(f)) {
868             let filename = f.file_name().into_string().unwrap();
869             if is_dylib(&filename) {
870                 copy(&f.path(), &sysroot_libdir.join(&filename));
871             }
872         }
873
874         copy_codegen_backends_to_sysroot(builder,
875                                          build_compiler,
876                                          target_compiler);
877
878         // Link the compiler binary itself into place
879         let out_dir = build.cargo_out(build_compiler, Mode::Librustc, host);
880         let rustc = out_dir.join(exe("rustc", &*host));
881         let bindir = sysroot.join("bin");
882         t!(fs::create_dir_all(&bindir));
883         let compiler = builder.rustc(target_compiler);
884         let _ = fs::remove_file(&compiler);
885         copy(&rustc, &compiler);
886
887         target_compiler
888     }
889 }
890
891 /// Link some files into a rustc sysroot.
892 ///
893 /// For a particular stage this will link the file listed in `stamp` into the
894 /// `sysroot_dst` provided.
895 pub fn add_to_sysroot(sysroot_dst: &Path, stamp: &Path) {
896     t!(fs::create_dir_all(&sysroot_dst));
897     for path in read_stamp_file(stamp) {
898         copy(&path, &sysroot_dst.join(path.file_name().unwrap()));
899     }
900 }
901
902 // Avoiding a dependency on winapi to keep compile times down
903 #[cfg(unix)]
904 fn stderr_isatty() -> bool {
905     use libc;
906     unsafe { libc::isatty(libc::STDERR_FILENO) != 0 }
907 }
908 #[cfg(windows)]
909 fn stderr_isatty() -> bool {
910     type DWORD = u32;
911     type BOOL = i32;
912     type HANDLE = *mut u8;
913     const STD_ERROR_HANDLE: DWORD = -12i32 as DWORD;
914     extern "system" {
915         fn GetStdHandle(which: DWORD) -> HANDLE;
916         fn GetConsoleMode(hConsoleHandle: HANDLE, lpMode: *mut DWORD) -> BOOL;
917     }
918     unsafe {
919         let handle = GetStdHandle(STD_ERROR_HANDLE);
920         let mut out = 0;
921         GetConsoleMode(handle, &mut out) != 0
922     }
923 }
924
925 pub fn run_cargo(build: &Build, cargo: &mut Command, stamp: &Path, is_check: bool) {
926     // Instruct Cargo to give us json messages on stdout, critically leaving
927     // stderr as piped so we can get those pretty colors.
928     cargo.arg("--message-format").arg("json")
929          .stdout(Stdio::piped());
930
931     if stderr_isatty() && build.ci_env == CiEnv::None {
932         // since we pass message-format=json to cargo, we need to tell the rustc
933         // wrapper to give us colored output if necessary. This is because we
934         // only want Cargo's JSON output, not rustcs.
935         cargo.env("RUSTC_COLOR", "1");
936     }
937
938     build.verbose(&format!("running: {:?}", cargo));
939     let mut child = match cargo.spawn() {
940         Ok(child) => child,
941         Err(e) => panic!("failed to execute command: {:?}\nerror: {}", cargo, e),
942     };
943
944     // `target_root_dir` looks like $dir/$target/release
945     let target_root_dir = stamp.parent().unwrap();
946     // `target_deps_dir` looks like $dir/$target/release/deps
947     let target_deps_dir = target_root_dir.join("deps");
948     // `host_root_dir` looks like $dir/release
949     let host_root_dir = target_root_dir.parent().unwrap() // chop off `release`
950                                        .parent().unwrap() // chop off `$target`
951                                        .join(target_root_dir.file_name().unwrap());
952
953     // Spawn Cargo slurping up its JSON output. We'll start building up the
954     // `deps` array of all files it generated along with a `toplevel` array of
955     // files we need to probe for later.
956     let mut deps = Vec::new();
957     let mut toplevel = Vec::new();
958     let stdout = BufReader::new(child.stdout.take().unwrap());
959     for line in stdout.lines() {
960         let line = t!(line);
961         let json: serde_json::Value = if line.starts_with("{") {
962             t!(serde_json::from_str(&line))
963         } else {
964             // If this was informational, just print it out and continue
965             println!("{}", line);
966             continue
967         };
968         if json["reason"].as_str() != Some("compiler-artifact") {
969             continue
970         }
971         for filename in json["filenames"].as_array().unwrap() {
972             let filename = filename.as_str().unwrap();
973             // Skip files like executables
974             if !filename.ends_with(".rlib") &&
975                !filename.ends_with(".lib") &&
976                !is_dylib(&filename) &&
977                !(is_check && filename.ends_with(".rmeta")) {
978                 continue
979             }
980
981             let filename = Path::new(filename);
982
983             // If this was an output file in the "host dir" we don't actually
984             // worry about it, it's not relevant for us.
985             if filename.starts_with(&host_root_dir) {
986                 continue;
987             }
988
989             // If this was output in the `deps` dir then this is a precise file
990             // name (hash included) so we start tracking it.
991             if filename.starts_with(&target_deps_dir) {
992                 deps.push(filename.to_path_buf());
993                 continue;
994             }
995
996             // Otherwise this was a "top level artifact" which right now doesn't
997             // have a hash in the name, but there's a version of this file in
998             // the `deps` folder which *does* have a hash in the name. That's
999             // the one we'll want to we'll probe for it later.
1000             //
1001             // We do not use `Path::file_stem` or `Path::extension` here,
1002             // because some generated files may have multiple extensions e.g.
1003             // `std-<hash>.dll.lib` on Windows. The aforementioned methods only
1004             // split the file name by the last extension (`.lib`) while we need
1005             // to split by all extensions (`.dll.lib`).
1006             let expected_len = t!(filename.metadata()).len();
1007             let filename = filename.file_name().unwrap().to_str().unwrap();
1008             let mut parts = filename.splitn(2, '.');
1009             let file_stem = parts.next().unwrap().to_owned();
1010             let extension = parts.next().unwrap().to_owned();
1011
1012             toplevel.push((file_stem, extension, expected_len));
1013         }
1014     }
1015
1016     // Make sure Cargo actually succeeded after we read all of its stdout.
1017     let status = t!(child.wait());
1018     if !status.success() {
1019         panic!("command did not execute successfully: {:?}\n\
1020                 expected success, got: {}",
1021                cargo,
1022                status);
1023     }
1024
1025     // Ok now we need to actually find all the files listed in `toplevel`. We've
1026     // got a list of prefix/extensions and we basically just need to find the
1027     // most recent file in the `deps` folder corresponding to each one.
1028     let contents = t!(target_deps_dir.read_dir())
1029         .map(|e| t!(e))
1030         .map(|e| (e.path(), e.file_name().into_string().unwrap(), t!(e.metadata())))
1031         .collect::<Vec<_>>();
1032     for (prefix, extension, expected_len) in toplevel {
1033         let candidates = contents.iter().filter(|&&(_, ref filename, ref meta)| {
1034             filename.starts_with(&prefix[..]) &&
1035                 filename[prefix.len()..].starts_with("-") &&
1036                 filename.ends_with(&extension[..]) &&
1037                 meta.len() == expected_len
1038         });
1039         let max = candidates.max_by_key(|&&(_, _, ref metadata)| {
1040             FileTime::from_last_modification_time(metadata)
1041         });
1042         let path_to_add = match max {
1043             Some(triple) => triple.0.to_str().unwrap(),
1044             None => panic!("no output generated for {:?} {:?}", prefix, extension),
1045         };
1046         if is_dylib(path_to_add) {
1047             let candidate = format!("{}.lib", path_to_add);
1048             let candidate = PathBuf::from(candidate);
1049             if candidate.exists() {
1050                 deps.push(candidate);
1051             }
1052         }
1053         deps.push(path_to_add.into());
1054     }
1055
1056     // Now we want to update the contents of the stamp file, if necessary. First
1057     // we read off the previous contents along with its mtime. If our new
1058     // contents (the list of files to copy) is different or if any dep's mtime
1059     // is newer then we rewrite the stamp file.
1060     deps.sort();
1061     let mut stamp_contents = Vec::new();
1062     if let Ok(mut f) = File::open(stamp) {
1063         t!(f.read_to_end(&mut stamp_contents));
1064     }
1065     let stamp_mtime = mtime(&stamp);
1066     let mut new_contents = Vec::new();
1067     let mut max = None;
1068     let mut max_path = None;
1069     for dep in deps {
1070         let mtime = mtime(&dep);
1071         if Some(mtime) > max {
1072             max = Some(mtime);
1073             max_path = Some(dep.clone());
1074         }
1075         new_contents.extend(dep.to_str().unwrap().as_bytes());
1076         new_contents.extend(b"\0");
1077     }
1078     let max = max.unwrap();
1079     let max_path = max_path.unwrap();
1080     if stamp_contents == new_contents && max <= stamp_mtime {
1081         build.verbose(&format!("not updating {:?}; contents equal and {} <= {}",
1082                 stamp, max, stamp_mtime));
1083         return
1084     }
1085     if max > stamp_mtime {
1086         build.verbose(&format!("updating {:?} as {:?} changed", stamp, max_path));
1087     } else {
1088         build.verbose(&format!("updating {:?} as deps changed", stamp));
1089     }
1090     t!(t!(File::create(stamp)).write_all(&new_contents));
1091 }