]> git.lizzy.rs Git - rust.git/blob - src/bootstrap/compile.rs
Auto merge of #53002 - QuietMisdreavus:brother-may-i-have-some-loops, r=pnkfelix
[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::borrow::Cow;
20 use std::env;
21 use std::fs::{self, File};
22 use std::io::BufReader;
23 use std::io::prelude::*;
24 use std::path::{Path, PathBuf};
25 use std::process::{Command, Stdio};
26 use std::str;
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, CiEnv};
33 use {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, PartialOrd, Ord, 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.all_krates("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 target = self.target;
68         let compiler = self.compiler;
69
70         if builder.config.keep_stage.contains(&compiler.stage) {
71             builder.info("Warning: Using a potentially old libstd. This may not behave well.");
72             builder.ensure(StdLink {
73                 compiler: compiler,
74                 target_compiler: compiler,
75                 target,
76             });
77             return;
78         }
79
80         builder.ensure(StartupObjects { compiler, target });
81
82         if builder.force_use_stage1(compiler, target) {
83             let from = builder.compiler(1, builder.config.build);
84             builder.ensure(Std {
85                 compiler: from,
86                 target,
87             });
88             builder.info(&format!("Uplifting stage1 std ({} -> {})", from.host, target));
89
90             // Even if we're not building std this stage, the new sysroot must
91             // still contain the musl startup objects.
92             if target.contains("musl") {
93                 let libdir = builder.sysroot_libdir(compiler, target);
94                 copy_musl_third_party_objects(builder, target, &libdir);
95             }
96
97             builder.ensure(StdLink {
98                 compiler: from,
99                 target_compiler: compiler,
100                 target,
101             });
102             return;
103         }
104
105         if target.contains("musl") {
106             let libdir = builder.sysroot_libdir(compiler, target);
107             copy_musl_third_party_objects(builder, target, &libdir);
108         }
109
110         let out_dir = builder.cargo_out(compiler, Mode::Std, target);
111         builder.clear_if_dirty(&out_dir, &builder.rustc(compiler));
112         let mut cargo = builder.cargo(compiler, Mode::Std, target, "build");
113         std_cargo(builder, &compiler, target, &mut cargo);
114
115         let _folder = builder.fold_output(|| format!("stage{}-std", compiler.stage));
116         builder.info(&format!("Building stage{} std artifacts ({} -> {})", compiler.stage,
117                 &compiler.host, target));
118         run_cargo(builder,
119                   &mut cargo,
120                   &libstd_stamp(builder, compiler, target),
121                   false);
122
123         builder.ensure(StdLink {
124             compiler: builder.compiler(compiler.stage, builder.config.build),
125             target_compiler: compiler,
126             target,
127         });
128     }
129 }
130
131 /// Copies the crt(1,i,n).o startup objects
132 ///
133 /// Since musl supports fully static linking, we can cross link for it even
134 /// with a glibc-targeting toolchain, given we have the appropriate startup
135 /// files. As those shipped with glibc won't work, copy the ones provided by
136 /// musl so we have them on linux-gnu hosts.
137 fn copy_musl_third_party_objects(builder: &Builder,
138                                  target: Interned<String>,
139                                  into: &Path) {
140     for &obj in &["crt1.o", "crti.o", "crtn.o"] {
141         builder.copy(&builder.musl_root(target).unwrap().join("lib").join(obj), &into.join(obj));
142     }
143 }
144
145 /// Configure cargo to compile the standard library, adding appropriate env vars
146 /// and such.
147 pub fn std_cargo(builder: &Builder,
148                  compiler: &Compiler,
149                  target: Interned<String>,
150                  cargo: &mut Command) {
151     if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
152         cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
153     }
154
155     if builder.no_std(target) == Some(true) {
156         // for no-std targets we only compile a few no_std crates
157         cargo.arg("--features").arg("c mem")
158             .args(&["-p", "alloc"])
159             .args(&["-p", "compiler_builtins"])
160             .arg("--manifest-path")
161             .arg(builder.src.join("src/rustc/compiler_builtins_shim/Cargo.toml"));
162     } else {
163         let mut features = builder.std_features();
164
165         // When doing a local rebuild we tell cargo that we're stage1 rather than
166         // stage0. This works fine if the local rust and being-built rust have the
167         // same view of what the default allocator is, but fails otherwise. Since
168         // we don't have a way to express an allocator preference yet, work
169         // around the issue in the case of a local rebuild with jemalloc disabled.
170         if compiler.stage == 0 && builder.local_rebuild && !builder.config.use_jemalloc {
171             features.push_str(" force_alloc_system");
172         }
173
174         if compiler.stage != 0 && builder.config.sanitizers {
175             // This variable is used by the sanitizer runtime crates, e.g.
176             // rustc_lsan, to build the sanitizer runtime from C code
177             // When this variable is missing, those crates won't compile the C code,
178             // so we don't set this variable during stage0 where llvm-config is
179             // missing
180             // We also only build the runtimes when --enable-sanitizers (or its
181             // config.toml equivalent) is used
182             let llvm_config = builder.ensure(native::Llvm {
183                 target: builder.config.build,
184                 emscripten: false,
185             });
186             cargo.env("LLVM_CONFIG", llvm_config);
187         }
188
189         cargo.arg("--features").arg(features)
190             .arg("--manifest-path")
191             .arg(builder.src.join("src/libstd/Cargo.toml"));
192
193         if let Some(target) = builder.config.target_config.get(&target) {
194             if let Some(ref jemalloc) = target.jemalloc {
195                 cargo.env("JEMALLOC_OVERRIDE", jemalloc);
196             }
197         }
198         if target.contains("musl") {
199             if let Some(p) = builder.musl_root(target) {
200                 cargo.env("MUSL_ROOT", p);
201             }
202         }
203     }
204 }
205
206 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
207 struct StdLink {
208     pub compiler: Compiler,
209     pub target_compiler: Compiler,
210     pub target: Interned<String>,
211 }
212
213 impl Step for StdLink {
214     type Output = ();
215
216     fn should_run(run: ShouldRun) -> ShouldRun {
217         run.never()
218     }
219
220     /// Link all libstd rlibs/dylibs into the sysroot location.
221     ///
222     /// Links those artifacts generated by `compiler` to a the `stage` compiler's
223     /// sysroot for the specified `host` and `target`.
224     ///
225     /// Note that this assumes that `compiler` has already generated the libstd
226     /// libraries for `target`, and this method will find them in the relevant
227     /// output directory.
228     fn run(self, builder: &Builder) {
229         let compiler = self.compiler;
230         let target_compiler = self.target_compiler;
231         let target = self.target;
232         builder.info(&format!("Copying stage{} std from stage{} ({} -> {} / {})",
233                 target_compiler.stage,
234                 compiler.stage,
235                 &compiler.host,
236                 target_compiler.host,
237                 target));
238         let libdir = builder.sysroot_libdir(target_compiler, target);
239         add_to_sysroot(builder, &libdir, &libstd_stamp(builder, compiler, target));
240
241         if builder.config.sanitizers && compiler.stage != 0 && target == "x86_64-apple-darwin" {
242             // The sanitizers are only built in stage1 or above, so the dylibs will
243             // be missing in stage0 and causes panic. See the `std()` function above
244             // for reason why the sanitizers are not built in stage0.
245             copy_apple_sanitizer_dylibs(builder, &builder.native_dir(target), "osx", &libdir);
246         }
247
248         builder.ensure(tool::CleanTools {
249             compiler: target_compiler,
250             target,
251             cause: Mode::Std,
252         });
253     }
254 }
255
256 fn copy_apple_sanitizer_dylibs(builder: &Builder, native_dir: &Path, platform: &str, into: &Path) {
257     for &sanitizer in &["asan", "tsan"] {
258         let filename = format!("libclang_rt.{}_{}_dynamic.dylib", sanitizer, platform);
259         let mut src_path = native_dir.join(sanitizer);
260         src_path.push("build");
261         src_path.push("lib");
262         src_path.push("darwin");
263         src_path.push(&filename);
264         builder.copy(&src_path, &into.join(filename));
265     }
266 }
267
268 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
269 pub struct StartupObjects {
270     pub compiler: Compiler,
271     pub target: Interned<String>,
272 }
273
274 impl Step for StartupObjects {
275     type Output = ();
276
277     fn should_run(run: ShouldRun) -> ShouldRun {
278         run.path("src/rtstartup")
279     }
280
281     fn make_run(run: RunConfig) {
282         run.builder.ensure(StartupObjects {
283             compiler: run.builder.compiler(run.builder.top_stage, run.host),
284             target: run.target,
285         });
286     }
287
288     /// Build and prepare startup objects like rsbegin.o and rsend.o
289     ///
290     /// These are primarily used on Windows right now for linking executables/dlls.
291     /// They don't require any library support as they're just plain old object
292     /// files, so we just use the nightly snapshot compiler to always build them (as
293     /// no other compilers are guaranteed to be available).
294     fn run(self, builder: &Builder) {
295         let for_compiler = self.compiler;
296         let target = self.target;
297         if !target.contains("pc-windows-gnu") {
298             return
299         }
300
301         let src_dir = &builder.src.join("src/rtstartup");
302         let dst_dir = &builder.native_dir(target).join("rtstartup");
303         let sysroot_dir = &builder.sysroot_libdir(for_compiler, target);
304         t!(fs::create_dir_all(dst_dir));
305
306         for file in &["rsbegin", "rsend"] {
307             let src_file = &src_dir.join(file.to_string() + ".rs");
308             let dst_file = &dst_dir.join(file.to_string() + ".o");
309             if !up_to_date(src_file, dst_file) {
310                 let mut cmd = Command::new(&builder.initial_rustc);
311                 builder.run(cmd.env("RUSTC_BOOTSTRAP", "1")
312                             .arg("--cfg").arg("stage0")
313                             .arg("--target").arg(target)
314                             .arg("--emit=obj")
315                             .arg("-o").arg(dst_file)
316                             .arg(src_file));
317             }
318
319             builder.copy(dst_file, &sysroot_dir.join(file.to_string() + ".o"));
320         }
321
322         for obj in ["crt2.o", "dllcrt2.o"].iter() {
323             let src = compiler_file(builder,
324                                     builder.cc(target),
325                                     target,
326                                     obj);
327             builder.copy(&src, &sysroot_dir.join(obj));
328         }
329     }
330 }
331
332 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
333 pub struct Test {
334     pub target: Interned<String>,
335     pub compiler: Compiler,
336 }
337
338 impl Step for Test {
339     type Output = ();
340     const DEFAULT: bool = true;
341
342     fn should_run(run: ShouldRun) -> ShouldRun {
343         run.all_krates("test")
344     }
345
346     fn make_run(run: RunConfig) {
347         run.builder.ensure(Test {
348             compiler: run.builder.compiler(run.builder.top_stage, run.host),
349             target: run.target,
350         });
351     }
352
353     /// Build libtest.
354     ///
355     /// This will build libtest and supporting libraries for a particular stage of
356     /// the build using the `compiler` targeting the `target` architecture. The
357     /// artifacts created will also be linked into the sysroot directory.
358     fn run(self, builder: &Builder) {
359         let target = self.target;
360         let compiler = self.compiler;
361
362         builder.ensure(Std { compiler, target });
363
364         if builder.config.keep_stage.contains(&compiler.stage) {
365             builder.info("Warning: Using a potentially old libtest. This may not behave well.");
366             builder.ensure(TestLink {
367                 compiler: compiler,
368                 target_compiler: compiler,
369                 target,
370             });
371             return;
372         }
373
374         if builder.force_use_stage1(compiler, target) {
375             builder.ensure(Test {
376                 compiler: builder.compiler(1, builder.config.build),
377                 target,
378             });
379             builder.info(
380                 &format!("Uplifting stage1 test ({} -> {})", builder.config.build, target));
381             builder.ensure(TestLink {
382                 compiler: builder.compiler(1, builder.config.build),
383                 target_compiler: compiler,
384                 target,
385             });
386             return;
387         }
388
389         let out_dir = builder.cargo_out(compiler, Mode::Test, target);
390         builder.clear_if_dirty(&out_dir, &libstd_stamp(builder, compiler, target));
391         let mut cargo = builder.cargo(compiler, Mode::Test, target, "build");
392         test_cargo(builder, &compiler, target, &mut cargo);
393
394         let _folder = builder.fold_output(|| format!("stage{}-test", compiler.stage));
395         builder.info(&format!("Building stage{} test artifacts ({} -> {})", compiler.stage,
396                 &compiler.host, target));
397         run_cargo(builder,
398                   &mut cargo,
399                   &libtest_stamp(builder, compiler, target),
400                   false);
401
402         builder.ensure(TestLink {
403             compiler: builder.compiler(compiler.stage, builder.config.build),
404             target_compiler: compiler,
405             target,
406         });
407     }
408 }
409
410 /// Same as `std_cargo`, but for libtest
411 pub fn test_cargo(builder: &Builder,
412                   _compiler: &Compiler,
413                   _target: Interned<String>,
414                   cargo: &mut Command) {
415     if let Some(target) = env::var_os("MACOSX_STD_DEPLOYMENT_TARGET") {
416         cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
417     }
418     cargo.arg("--manifest-path")
419         .arg(builder.src.join("src/libtest/Cargo.toml"));
420 }
421
422 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
423 pub struct TestLink {
424     pub compiler: Compiler,
425     pub target_compiler: Compiler,
426     pub target: Interned<String>,
427 }
428
429 impl Step for TestLink {
430     type Output = ();
431
432     fn should_run(run: ShouldRun) -> ShouldRun {
433         run.never()
434     }
435
436     /// Same as `std_link`, only for libtest
437     fn run(self, builder: &Builder) {
438         let compiler = self.compiler;
439         let target_compiler = self.target_compiler;
440         let target = self.target;
441         builder.info(&format!("Copying stage{} test from stage{} ({} -> {} / {})",
442                 target_compiler.stage,
443                 compiler.stage,
444                 &compiler.host,
445                 target_compiler.host,
446                 target));
447         add_to_sysroot(builder, &builder.sysroot_libdir(target_compiler, target),
448                     &libtest_stamp(builder, compiler, target));
449         builder.ensure(tool::CleanTools {
450             compiler: target_compiler,
451             target,
452             cause: Mode::Test,
453         });
454     }
455 }
456
457 #[derive(Debug, PartialOrd, Ord, Copy, Clone, PartialEq, Eq, Hash)]
458 pub struct Rustc {
459     pub target: Interned<String>,
460     pub compiler: Compiler,
461 }
462
463 impl Step for Rustc {
464     type Output = ();
465     const ONLY_HOSTS: bool = true;
466     const DEFAULT: bool = true;
467
468     fn should_run(run: ShouldRun) -> ShouldRun {
469         run.all_krates("rustc-main")
470     }
471
472     fn make_run(run: RunConfig) {
473         run.builder.ensure(Rustc {
474             compiler: run.builder.compiler(run.builder.top_stage, run.host),
475             target: run.target,
476         });
477     }
478
479     /// Build the compiler.
480     ///
481     /// This will build the compiler for a particular stage of the build using
482     /// the `compiler` targeting the `target` architecture. The artifacts
483     /// created will also be linked into the sysroot directory.
484     fn run(self, builder: &Builder) {
485         let compiler = self.compiler;
486         let target = self.target;
487
488         builder.ensure(Test { compiler, target });
489
490         if builder.config.keep_stage.contains(&compiler.stage) {
491             builder.info("Warning: Using a potentially old librustc. This may not behave well.");
492             builder.ensure(RustcLink {
493                 compiler: compiler,
494                 target_compiler: compiler,
495                 target,
496             });
497             return;
498         }
499
500         if builder.force_use_stage1(compiler, target) {
501             builder.ensure(Rustc {
502                 compiler: builder.compiler(1, builder.config.build),
503                 target,
504             });
505             builder.info(&format!("Uplifting stage1 rustc ({} -> {})",
506                 builder.config.build, target));
507             builder.ensure(RustcLink {
508                 compiler: builder.compiler(1, builder.config.build),
509                 target_compiler: compiler,
510                 target,
511             });
512             return;
513         }
514
515         // Ensure that build scripts have a std to link against.
516         builder.ensure(Std {
517             compiler: builder.compiler(self.compiler.stage, builder.config.build),
518             target: builder.config.build,
519         });
520         let cargo_out = builder.cargo_out(compiler, Mode::Rustc, target);
521         builder.clear_if_dirty(&cargo_out, &libstd_stamp(builder, compiler, target));
522         builder.clear_if_dirty(&cargo_out, &libtest_stamp(builder, compiler, target));
523
524         let mut cargo = builder.cargo(compiler, Mode::Rustc, target, "build");
525         rustc_cargo(builder, &mut cargo);
526
527         let _folder = builder.fold_output(|| format!("stage{}-rustc", compiler.stage));
528         builder.info(&format!("Building stage{} compiler artifacts ({} -> {})",
529                  compiler.stage, &compiler.host, target));
530         run_cargo(builder,
531                   &mut cargo,
532                   &librustc_stamp(builder, compiler, target),
533                   false);
534
535         builder.ensure(RustcLink {
536             compiler: builder.compiler(compiler.stage, builder.config.build),
537             target_compiler: compiler,
538             target,
539         });
540     }
541 }
542
543 pub fn rustc_cargo(builder: &Builder, cargo: &mut Command) {
544     cargo.arg("--features").arg(builder.rustc_features())
545          .arg("--manifest-path")
546          .arg(builder.src.join("src/rustc/Cargo.toml"));
547     rustc_cargo_env(builder, cargo);
548 }
549
550 pub fn rustc_cargo_env(builder: &Builder, cargo: &mut Command) {
551     // Set some configuration variables picked up by build scripts and
552     // the compiler alike
553     cargo.env("CFG_RELEASE", builder.rust_release())
554          .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
555          .env("CFG_VERSION", builder.rust_version())
556          .env("CFG_PREFIX", builder.config.prefix.clone().unwrap_or_default())
557          .env("CFG_CODEGEN_BACKENDS_DIR", &builder.config.rust_codegen_backends_dir);
558
559     let libdir_relative = builder.config.libdir_relative().unwrap_or(Path::new("lib"));
560     cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
561
562     // If we're not building a compiler with debugging information then remove
563     // these two env vars which would be set otherwise.
564     if builder.config.rust_debuginfo_only_std {
565         cargo.env_remove("RUSTC_DEBUGINFO");
566         cargo.env_remove("RUSTC_DEBUGINFO_LINES");
567     }
568
569     if let Some(ref ver_date) = builder.rust_info.commit_date() {
570         cargo.env("CFG_VER_DATE", ver_date);
571     }
572     if let Some(ref ver_hash) = builder.rust_info.sha() {
573         cargo.env("CFG_VER_HASH", ver_hash);
574     }
575     if !builder.unstable_features() {
576         cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
577     }
578     if let Some(ref s) = builder.config.rustc_default_linker {
579         cargo.env("CFG_DEFAULT_LINKER", s);
580     }
581     if builder.config.rustc_parallel_queries {
582         cargo.env("RUSTC_PARALLEL_QUERIES", "1");
583     }
584 }
585
586 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
587 struct RustcLink {
588     pub compiler: Compiler,
589     pub target_compiler: Compiler,
590     pub target: Interned<String>,
591 }
592
593 impl Step for RustcLink {
594     type Output = ();
595
596     fn should_run(run: ShouldRun) -> ShouldRun {
597         run.never()
598     }
599
600     /// Same as `std_link`, only for librustc
601     fn run(self, builder: &Builder) {
602         let compiler = self.compiler;
603         let target_compiler = self.target_compiler;
604         let target = self.target;
605         builder.info(&format!("Copying stage{} rustc from stage{} ({} -> {} / {})",
606                  target_compiler.stage,
607                  compiler.stage,
608                  &compiler.host,
609                  target_compiler.host,
610                  target));
611         add_to_sysroot(builder, &builder.sysroot_libdir(target_compiler, target),
612                        &librustc_stamp(builder, compiler, target));
613         builder.ensure(tool::CleanTools {
614             compiler: target_compiler,
615             target,
616             cause: Mode::Rustc,
617         });
618     }
619 }
620
621 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
622 pub struct CodegenBackend {
623     pub compiler: Compiler,
624     pub target: Interned<String>,
625     pub backend: Interned<String>,
626 }
627
628 impl Step for CodegenBackend {
629     type Output = ();
630     const ONLY_HOSTS: bool = true;
631     const DEFAULT: bool = true;
632
633     fn should_run(run: ShouldRun) -> ShouldRun {
634         run.all_krates("rustc_codegen_llvm")
635     }
636
637     fn make_run(run: RunConfig) {
638         let backend = run.builder.config.rust_codegen_backends.get(0);
639         let backend = backend.cloned().unwrap_or_else(|| {
640             INTERNER.intern_str("llvm")
641         });
642         run.builder.ensure(CodegenBackend {
643             compiler: run.builder.compiler(run.builder.top_stage, run.host),
644             target: run.target,
645             backend,
646         });
647     }
648
649     fn run(self, builder: &Builder) {
650         let compiler = self.compiler;
651         let target = self.target;
652         let backend = self.backend;
653
654         builder.ensure(Rustc { compiler, target });
655
656         if builder.config.keep_stage.contains(&compiler.stage) {
657             builder.info("Warning: Using a potentially old codegen backend. \
658                 This may not behave well.");
659             // Codegen backends are linked separately from this step today, so we don't do
660             // anything here.
661             return;
662         }
663
664         if builder.force_use_stage1(compiler, target) {
665             builder.ensure(CodegenBackend {
666                 compiler: builder.compiler(1, builder.config.build),
667                 target,
668                 backend,
669             });
670             return;
671         }
672
673         let mut cargo = builder.cargo(compiler, Mode::Codegen, target, "build");
674         let mut features = builder.rustc_features().to_string();
675         cargo.arg("--manifest-path")
676             .arg(builder.src.join("src/librustc_codegen_llvm/Cargo.toml"));
677         rustc_cargo_env(builder, &mut cargo);
678
679         features += &build_codegen_backend(&builder, &mut cargo, &compiler, target, backend);
680
681         let tmp_stamp = builder.cargo_out(compiler, Mode::Codegen, target)
682             .join(".tmp.stamp");
683
684         let _folder = builder.fold_output(|| format!("stage{}-rustc_codegen_llvm", compiler.stage));
685         let files = run_cargo(builder,
686                               cargo.arg("--features").arg(features),
687                               &tmp_stamp,
688                               false);
689         if builder.config.dry_run {
690             return;
691         }
692         let mut files = files.into_iter()
693             .filter(|f| {
694                 let filename = f.file_name().unwrap().to_str().unwrap();
695                 is_dylib(filename) && filename.contains("rustc_codegen_llvm-")
696             });
697         let codegen_backend = match files.next() {
698             Some(f) => f,
699             None => panic!("no dylibs built for codegen backend?"),
700         };
701         if let Some(f) = files.next() {
702             panic!("codegen backend built two dylibs:\n{}\n{}",
703                    codegen_backend.display(),
704                    f.display());
705         }
706         let stamp = codegen_backend_stamp(builder, compiler, target, backend);
707         let codegen_backend = codegen_backend.to_str().unwrap();
708         t!(t!(File::create(&stamp)).write_all(codegen_backend.as_bytes()));
709     }
710 }
711
712 pub fn build_codegen_backend(builder: &Builder,
713                              cargo: &mut Command,
714                              compiler: &Compiler,
715                              target: Interned<String>,
716                              backend: Interned<String>) -> String {
717     let mut features = String::new();
718
719     match &*backend {
720         "llvm" | "emscripten" => {
721             // Build LLVM for our target. This will implicitly build the
722             // host LLVM if necessary.
723             let llvm_config = builder.ensure(native::Llvm {
724                 target,
725                 emscripten: backend == "emscripten",
726             });
727
728             if backend == "emscripten" {
729                 features.push_str(" emscripten");
730             }
731
732             builder.info(&format!("Building stage{} codegen artifacts ({} -> {}, {})",
733                      compiler.stage, &compiler.host, target, backend));
734
735             // Pass down configuration from the LLVM build into the build of
736             // librustc_llvm and librustc_codegen_llvm.
737             if builder.is_rust_llvm(target) {
738                 cargo.env("LLVM_RUSTLLVM", "1");
739             }
740             cargo.env("LLVM_CONFIG", &llvm_config);
741             if backend != "emscripten" {
742                 let target_config = builder.config.target_config.get(&target);
743                 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
744                     cargo.env("CFG_LLVM_ROOT", s);
745                 }
746             }
747             // Building with a static libstdc++ is only supported on linux right now,
748             // not for MSVC or macOS
749             if builder.config.llvm_static_stdcpp &&
750                !target.contains("freebsd") &&
751                !target.contains("windows") &&
752                !target.contains("apple") {
753                 let file = compiler_file(builder,
754                                          builder.cxx(target).unwrap(),
755                                          target,
756                                          "libstdc++.a");
757                 cargo.env("LLVM_STATIC_STDCPP", file);
758             }
759             if builder.config.llvm_link_shared {
760                 cargo.env("LLVM_LINK_SHARED", "1");
761             }
762         }
763         _ => panic!("unknown backend: {}", backend),
764     }
765
766     features
767 }
768
769 /// Creates the `codegen-backends` folder for a compiler that's about to be
770 /// assembled as a complete compiler.
771 ///
772 /// This will take the codegen artifacts produced by `compiler` and link them
773 /// into an appropriate location for `target_compiler` to be a functional
774 /// compiler.
775 fn copy_codegen_backends_to_sysroot(builder: &Builder,
776                                     compiler: Compiler,
777                                     target_compiler: Compiler) {
778     let target = target_compiler.host;
779
780     // Note that this step is different than all the other `*Link` steps in
781     // that it's not assembling a bunch of libraries but rather is primarily
782     // moving the codegen backend into place. The codegen backend of rustc is
783     // not linked into the main compiler by default but is rather dynamically
784     // selected at runtime for inclusion.
785     //
786     // Here we're looking for the output dylib of the `CodegenBackend` step and
787     // we're copying that into the `codegen-backends` folder.
788     let dst = builder.sysroot_codegen_backends(target_compiler);
789     t!(fs::create_dir_all(&dst));
790
791     if builder.config.dry_run {
792         return;
793     }
794
795     for backend in builder.config.rust_codegen_backends.iter() {
796         let stamp = codegen_backend_stamp(builder, compiler, target, *backend);
797         let mut dylib = String::new();
798         t!(t!(File::open(&stamp)).read_to_string(&mut dylib));
799         let file = Path::new(&dylib);
800         let filename = file.file_name().unwrap().to_str().unwrap();
801         // change `librustc_codegen_llvm-xxxxxx.so` to `librustc_codegen_llvm-llvm.so`
802         let target_filename = {
803             let dash = filename.find("-").unwrap();
804             let dot = filename.find(".").unwrap();
805             format!("{}-{}{}",
806                     &filename[..dash],
807                     backend,
808                     &filename[dot..])
809         };
810         builder.copy(&file, &dst.join(target_filename));
811     }
812 }
813
814 fn copy_lld_to_sysroot(builder: &Builder,
815                        target_compiler: Compiler,
816                        lld_install_root: &Path) {
817     let target = target_compiler.host;
818
819     let dst = builder.sysroot_libdir(target_compiler, target)
820         .parent()
821         .unwrap()
822         .join("bin");
823     t!(fs::create_dir_all(&dst));
824
825     let src_exe = exe("lld", &target);
826     let dst_exe = exe("rust-lld", &target);
827     // we prepend this bin directory to the user PATH when linking Rust binaries. To
828     // avoid shadowing the system LLD we rename the LLD we provide to `rust-lld`.
829     builder.copy(&lld_install_root.join("bin").join(&src_exe), &dst.join(&dst_exe));
830 }
831
832 /// Cargo's output path for the standard library in a given stage, compiled
833 /// by a particular compiler for the specified target.
834 pub fn libstd_stamp(builder: &Builder, compiler: Compiler, target: Interned<String>) -> PathBuf {
835     builder.cargo_out(compiler, Mode::Std, target).join(".libstd.stamp")
836 }
837
838 /// Cargo's output path for libtest in a given stage, compiled by a particular
839 /// compiler for the specified target.
840 pub fn libtest_stamp(builder: &Builder, compiler: Compiler, target: Interned<String>) -> PathBuf {
841     builder.cargo_out(compiler, Mode::Test, target).join(".libtest.stamp")
842 }
843
844 /// Cargo's output path for librustc in a given stage, compiled by a particular
845 /// compiler for the specified target.
846 pub fn librustc_stamp(builder: &Builder, compiler: Compiler, target: Interned<String>) -> PathBuf {
847     builder.cargo_out(compiler, Mode::Rustc, target).join(".librustc.stamp")
848 }
849
850 /// Cargo's output path for librustc_codegen_llvm in a given stage, compiled by a particular
851 /// compiler for the specified target and backend.
852 fn codegen_backend_stamp(builder: &Builder,
853                          compiler: Compiler,
854                          target: Interned<String>,
855                          backend: Interned<String>) -> PathBuf {
856     builder.cargo_out(compiler, Mode::Codegen, target)
857         .join(format!(".librustc_codegen_llvm-{}.stamp", backend))
858 }
859
860 pub fn compiler_file(builder: &Builder,
861                  compiler: &Path,
862                  target: Interned<String>,
863                  file: &str) -> PathBuf {
864     let mut cmd = Command::new(compiler);
865     cmd.args(builder.cflags(target));
866     cmd.arg(format!("-print-file-name={}", file));
867     let out = output(&mut cmd);
868     PathBuf::from(out.trim())
869 }
870
871 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
872 pub struct Sysroot {
873     pub compiler: Compiler,
874 }
875
876 impl Step for Sysroot {
877     type Output = Interned<PathBuf>;
878
879     fn should_run(run: ShouldRun) -> ShouldRun {
880         run.never()
881     }
882
883     /// Returns the sysroot for the `compiler` specified that *this build system
884     /// generates*.
885     ///
886     /// That is, the sysroot for the stage0 compiler is not what the compiler
887     /// thinks it is by default, but it's the same as the default for stages
888     /// 1-3.
889     fn run(self, builder: &Builder) -> Interned<PathBuf> {
890         let compiler = self.compiler;
891         let sysroot = if compiler.stage == 0 {
892             builder.out.join(&compiler.host).join("stage0-sysroot")
893         } else {
894             builder.out.join(&compiler.host).join(format!("stage{}", compiler.stage))
895         };
896         let _ = fs::remove_dir_all(&sysroot);
897         t!(fs::create_dir_all(&sysroot));
898         INTERNER.intern_path(sysroot)
899     }
900 }
901
902 #[derive(Debug, Copy, PartialOrd, Ord, Clone, PartialEq, Eq, Hash)]
903 pub struct Assemble {
904     /// The compiler which we will produce in this step. Assemble itself will
905     /// take care of ensuring that the necessary prerequisites to do so exist,
906     /// that is, this target can be a stage2 compiler and Assemble will build
907     /// previous stages for you.
908     pub target_compiler: Compiler,
909 }
910
911 impl Step for Assemble {
912     type Output = Compiler;
913
914     fn should_run(run: ShouldRun) -> ShouldRun {
915         run.never()
916     }
917
918     /// Prepare a new compiler from the artifacts in `stage`
919     ///
920     /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
921     /// must have been previously produced by the `stage - 1` builder.build
922     /// compiler.
923     fn run(self, builder: &Builder) -> Compiler {
924         let target_compiler = self.target_compiler;
925
926         if target_compiler.stage == 0 {
927             assert_eq!(builder.config.build, target_compiler.host,
928                 "Cannot obtain compiler for non-native build triple at stage 0");
929             // The stage 0 compiler for the build triple is always pre-built.
930             return target_compiler;
931         }
932
933         // Get the compiler that we'll use to bootstrap ourselves.
934         //
935         // Note that this is where the recursive nature of the bootstrap
936         // happens, as this will request the previous stage's compiler on
937         // downwards to stage 0.
938         //
939         // Also note that we're building a compiler for the host platform. We
940         // only assume that we can run `build` artifacts, which means that to
941         // produce some other architecture compiler we need to start from
942         // `build` to get there.
943         //
944         // FIXME: Perhaps we should download those libraries?
945         //        It would make builds faster...
946         //
947         // FIXME: It may be faster if we build just a stage 1 compiler and then
948         //        use that to bootstrap this compiler forward.
949         let build_compiler =
950             builder.compiler(target_compiler.stage - 1, builder.config.build);
951
952         // Build the libraries for this compiler to link to (i.e., the libraries
953         // it uses at runtime). NOTE: Crates the target compiler compiles don't
954         // link to these. (FIXME: Is that correct? It seems to be correct most
955         // of the time but I think we do link to these for stage2/bin compilers
956         // when not performing a full bootstrap).
957         builder.ensure(Rustc {
958             compiler: build_compiler,
959             target: target_compiler.host,
960         });
961         for &backend in builder.config.rust_codegen_backends.iter() {
962             builder.ensure(CodegenBackend {
963                 compiler: build_compiler,
964                 target: target_compiler.host,
965                 backend,
966             });
967         }
968
969         let lld_install = if builder.config.lld_enabled {
970             Some(builder.ensure(native::Lld {
971                 target: target_compiler.host,
972             }))
973         } else {
974             None
975         };
976
977         let stage = target_compiler.stage;
978         let host = target_compiler.host;
979         builder.info(&format!("Assembling stage{} compiler ({})", stage, host));
980
981         // Link in all dylibs to the libdir
982         let sysroot = builder.sysroot(target_compiler);
983         let sysroot_libdir = sysroot.join(libdir(&*host));
984         t!(fs::create_dir_all(&sysroot_libdir));
985         let src_libdir = builder.sysroot_libdir(build_compiler, host);
986         for f in builder.read_dir(&src_libdir) {
987             let filename = f.file_name().into_string().unwrap();
988             if is_dylib(&filename) {
989                 builder.copy(&f.path(), &sysroot_libdir.join(&filename));
990             }
991         }
992
993         copy_codegen_backends_to_sysroot(builder,
994                                          build_compiler,
995                                          target_compiler);
996         if let Some(lld_install) = lld_install {
997             copy_lld_to_sysroot(builder, target_compiler, &lld_install);
998         }
999
1000         // Link the compiler binary itself into place
1001         let out_dir = builder.cargo_out(build_compiler, Mode::Rustc, host);
1002         let rustc = out_dir.join(exe("rustc_binary", &*host));
1003         let bindir = sysroot.join("bin");
1004         t!(fs::create_dir_all(&bindir));
1005         let compiler = builder.rustc(target_compiler);
1006         let _ = fs::remove_file(&compiler);
1007         builder.copy(&rustc, &compiler);
1008
1009         target_compiler
1010     }
1011 }
1012
1013 /// Link some files into a rustc sysroot.
1014 ///
1015 /// For a particular stage this will link the file listed in `stamp` into the
1016 /// `sysroot_dst` provided.
1017 pub fn add_to_sysroot(builder: &Builder, sysroot_dst: &Path, stamp: &Path) {
1018     t!(fs::create_dir_all(&sysroot_dst));
1019     for path in builder.read_stamp_file(stamp) {
1020         builder.copy(&path, &sysroot_dst.join(path.file_name().unwrap()));
1021     }
1022 }
1023
1024 // Avoiding a dependency on winapi to keep compile times down
1025 #[cfg(unix)]
1026 fn stderr_isatty() -> bool {
1027     use libc;
1028     unsafe { libc::isatty(libc::STDERR_FILENO) != 0 }
1029 }
1030 #[cfg(windows)]
1031 fn stderr_isatty() -> bool {
1032     type DWORD = u32;
1033     type BOOL = i32;
1034     type HANDLE = *mut u8;
1035     const STD_ERROR_HANDLE: DWORD = -12i32 as DWORD;
1036     extern "system" {
1037         fn GetStdHandle(which: DWORD) -> HANDLE;
1038         fn GetConsoleMode(hConsoleHandle: HANDLE, lpMode: *mut DWORD) -> BOOL;
1039     }
1040     unsafe {
1041         let handle = GetStdHandle(STD_ERROR_HANDLE);
1042         let mut out = 0;
1043         GetConsoleMode(handle, &mut out) != 0
1044     }
1045 }
1046
1047 pub fn run_cargo(builder: &Builder, cargo: &mut Command, stamp: &Path, is_check: bool)
1048     -> Vec<PathBuf>
1049 {
1050     if builder.config.dry_run {
1051         return Vec::new();
1052     }
1053
1054     // `target_root_dir` looks like $dir/$target/release
1055     let target_root_dir = stamp.parent().unwrap();
1056     // `target_deps_dir` looks like $dir/$target/release/deps
1057     let target_deps_dir = target_root_dir.join("deps");
1058     // `host_root_dir` looks like $dir/release
1059     let host_root_dir = target_root_dir.parent().unwrap() // chop off `release`
1060                                        .parent().unwrap() // chop off `$target`
1061                                        .join(target_root_dir.file_name().unwrap());
1062
1063     // Spawn Cargo slurping up its JSON output. We'll start building up the
1064     // `deps` array of all files it generated along with a `toplevel` array of
1065     // files we need to probe for later.
1066     let mut deps = Vec::new();
1067     let mut toplevel = Vec::new();
1068     let ok = stream_cargo(builder, cargo, &mut |msg| {
1069         let filenames = match msg {
1070             CargoMessage::CompilerArtifact { filenames, .. } => filenames,
1071             _ => return,
1072         };
1073         for filename in filenames {
1074             // Skip files like executables
1075             if !filename.ends_with(".rlib") &&
1076                !filename.ends_with(".lib") &&
1077                !is_dylib(&filename) &&
1078                !(is_check && filename.ends_with(".rmeta")) {
1079                 continue;
1080             }
1081
1082             let filename = Path::new(&*filename);
1083
1084             // If this was an output file in the "host dir" we don't actually
1085             // worry about it, it's not relevant for us.
1086             if filename.starts_with(&host_root_dir) {
1087                 continue;
1088             }
1089
1090             // If this was output in the `deps` dir then this is a precise file
1091             // name (hash included) so we start tracking it.
1092             if filename.starts_with(&target_deps_dir) {
1093                 deps.push(filename.to_path_buf());
1094                 continue;
1095             }
1096
1097             // Otherwise this was a "top level artifact" which right now doesn't
1098             // have a hash in the name, but there's a version of this file in
1099             // the `deps` folder which *does* have a hash in the name. That's
1100             // the one we'll want to we'll probe for it later.
1101             //
1102             // We do not use `Path::file_stem` or `Path::extension` here,
1103             // because some generated files may have multiple extensions e.g.
1104             // `std-<hash>.dll.lib` on Windows. The aforementioned methods only
1105             // split the file name by the last extension (`.lib`) while we need
1106             // to split by all extensions (`.dll.lib`).
1107             let expected_len = t!(filename.metadata()).len();
1108             let filename = filename.file_name().unwrap().to_str().unwrap();
1109             let mut parts = filename.splitn(2, '.');
1110             let file_stem = parts.next().unwrap().to_owned();
1111             let extension = parts.next().unwrap().to_owned();
1112
1113             toplevel.push((file_stem, extension, expected_len));
1114         }
1115     });
1116
1117     if !ok {
1118         panic!("cargo must succeed");
1119     }
1120
1121     // Ok now we need to actually find all the files listed in `toplevel`. We've
1122     // got a list of prefix/extensions and we basically just need to find the
1123     // most recent file in the `deps` folder corresponding to each one.
1124     let contents = t!(target_deps_dir.read_dir())
1125         .map(|e| t!(e))
1126         .map(|e| (e.path(), e.file_name().into_string().unwrap(), t!(e.metadata())))
1127         .collect::<Vec<_>>();
1128     for (prefix, extension, expected_len) in toplevel {
1129         let candidates = contents.iter().filter(|&&(_, ref filename, ref meta)| {
1130             filename.starts_with(&prefix[..]) &&
1131                 filename[prefix.len()..].starts_with("-") &&
1132                 filename.ends_with(&extension[..]) &&
1133                 meta.len() == expected_len
1134         });
1135         let max = candidates.max_by_key(|&&(_, _, ref metadata)| {
1136             FileTime::from_last_modification_time(metadata)
1137         });
1138         let path_to_add = match max {
1139             Some(triple) => triple.0.to_str().unwrap(),
1140             None => panic!("no output generated for {:?} {:?}", prefix, extension),
1141         };
1142         if is_dylib(path_to_add) {
1143             let candidate = format!("{}.lib", path_to_add);
1144             let candidate = PathBuf::from(candidate);
1145             if candidate.exists() {
1146                 deps.push(candidate);
1147             }
1148         }
1149         deps.push(path_to_add.into());
1150     }
1151
1152     // Now we want to update the contents of the stamp file, if necessary. First
1153     // we read off the previous contents along with its mtime. If our new
1154     // contents (the list of files to copy) is different or if any dep's mtime
1155     // is newer then we rewrite the stamp file.
1156     deps.sort();
1157     let mut stamp_contents = Vec::new();
1158     if let Ok(mut f) = File::open(stamp) {
1159         t!(f.read_to_end(&mut stamp_contents));
1160     }
1161     let stamp_mtime = mtime(&stamp);
1162     let mut new_contents = Vec::new();
1163     let mut max = None;
1164     let mut max_path = None;
1165     for dep in deps.iter() {
1166         let mtime = mtime(dep);
1167         if Some(mtime) > max {
1168             max = Some(mtime);
1169             max_path = Some(dep.clone());
1170         }
1171         new_contents.extend(dep.to_str().unwrap().as_bytes());
1172         new_contents.extend(b"\0");
1173     }
1174     let max = max.unwrap();
1175     let max_path = max_path.unwrap();
1176     if stamp_contents == new_contents && max <= stamp_mtime {
1177         builder.verbose(&format!("not updating {:?}; contents equal and {:?} <= {:?}",
1178                 stamp, max, stamp_mtime));
1179         return deps
1180     }
1181     if max > stamp_mtime {
1182         builder.verbose(&format!("updating {:?} as {:?} changed", stamp, max_path));
1183     } else {
1184         builder.verbose(&format!("updating {:?} as deps changed", stamp));
1185     }
1186     t!(t!(File::create(stamp)).write_all(&new_contents));
1187     deps
1188 }
1189
1190 pub fn stream_cargo(
1191     builder: &Builder,
1192     cargo: &mut Command,
1193     cb: &mut dyn FnMut(CargoMessage),
1194 ) -> bool {
1195     if builder.config.dry_run {
1196         return true;
1197     }
1198     // Instruct Cargo to give us json messages on stdout, critically leaving
1199     // stderr as piped so we can get those pretty colors.
1200     cargo.arg("--message-format").arg("json")
1201          .stdout(Stdio::piped());
1202
1203     if stderr_isatty() && builder.ci_env == CiEnv::None &&
1204         // if the terminal is reported as dumb, then we don't want to enable color for rustc
1205         env::var_os("TERM").map(|t| t != *"dumb").unwrap_or(true) {
1206         // since we pass message-format=json to cargo, we need to tell the rustc
1207         // wrapper to give us colored output if necessary. This is because we
1208         // only want Cargo's JSON output, not rustcs.
1209         cargo.env("RUSTC_COLOR", "1");
1210     }
1211
1212     builder.verbose(&format!("running: {:?}", cargo));
1213     let mut child = match cargo.spawn() {
1214         Ok(child) => child,
1215         Err(e) => panic!("failed to execute command: {:?}\nerror: {}", cargo, e),
1216     };
1217
1218     // Spawn Cargo slurping up its JSON output. We'll start building up the
1219     // `deps` array of all files it generated along with a `toplevel` array of
1220     // files we need to probe for later.
1221     let stdout = BufReader::new(child.stdout.take().unwrap());
1222     for line in stdout.lines() {
1223         let line = t!(line);
1224         match serde_json::from_str::<CargoMessage>(&line) {
1225             Ok(msg) => cb(msg),
1226             // If this was informational, just print it out and continue
1227             Err(_) => println!("{}", line)
1228         }
1229     }
1230
1231     // Make sure Cargo actually succeeded after we read all of its stdout.
1232     let status = t!(child.wait());
1233     if !status.success() {
1234         eprintln!("command did not execute successfully: {:?}\n\
1235                   expected success, got: {}",
1236                  cargo,
1237                  status);
1238     }
1239     status.success()
1240 }
1241
1242 #[derive(Deserialize)]
1243 #[serde(tag = "reason", rename_all = "kebab-case")]
1244 pub enum CargoMessage<'a> {
1245     CompilerArtifact {
1246         package_id: Cow<'a, str>,
1247         features: Vec<Cow<'a, str>>,
1248         filenames: Vec<Cow<'a, str>>,
1249     },
1250     BuildScriptExecuted {
1251         package_id: Cow<'a, str>,
1252     }
1253 }