1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Implementation of compiling various phases of the compiler and standard
14 //! This module contains some of the real meat in the rustbuild build system
15 //! which is where Cargo is used to compiler the standard library, libtest, and
16 //! compiler. This module is also responsible for assembling the sysroot as it
17 //! goes along from the output of the previous stage.
19 use std::collections::HashMap;
20 use std::fs::{self, File};
21 use std::path::{Path, PathBuf};
22 use std::process::Command;
25 use build_helper::{output, mtime, up_to_date};
26 use filetime::FileTime;
29 use util::{exe, libdir, is_dylib, copy};
30 use {Build, Compiler, Mode};
32 /// Build the standard library.
34 /// This will build the standard library for a particular stage of the build
35 /// using the `compiler` targeting the `target` architecture. The artifacts
36 /// created will also be linked into the sysroot directory.
37 pub fn std(build: &Build, target: &str, compiler: &Compiler) {
38 let libdir = build.sysroot_libdir(compiler, target);
39 t!(fs::create_dir_all(&libdir));
41 println!("Building stage{} std artifacts ({} -> {})", compiler.stage,
42 compiler.host, target);
44 let out_dir = build.cargo_out(compiler, Mode::Libstd, target);
45 build.clear_if_dirty(&out_dir, &build.compiler_path(compiler));
46 let mut cargo = build.cargo(compiler, Mode::Libstd, target, "build");
47 let mut features = build.std_features();
49 if let Ok(target) = env::var("MACOSX_STD_DEPLOYMENT_TARGET") {
50 cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
53 // When doing a local rebuild we tell cargo that we're stage1 rather than
54 // stage0. This works fine if the local rust and being-built rust have the
55 // same view of what the default allocator is, but fails otherwise. Since
56 // we don't have a way to express an allocator preference yet, work
57 // around the issue in the case of a local rebuild with jemalloc disabled.
58 if compiler.stage == 0 && build.local_rebuild && !build.config.use_jemalloc {
59 features.push_str(" force_alloc_system");
62 if compiler.stage != 0 && build.config.sanitizers {
63 // This variable is used by the sanitizer runtime crates, e.g.
64 // rustc_lsan, to build the sanitizer runtime from C code
65 // When this variable is missing, those crates won't compile the C code,
66 // so we don't set this variable during stage0 where llvm-config is
68 // We also only build the runtimes when --enable-sanitizers (or its
69 // config.toml equivalent) is used
70 cargo.env("LLVM_CONFIG", build.llvm_config(target));
72 cargo.arg("--features").arg(features)
73 .arg("--manifest-path")
74 .arg(build.src.join("src/libstd/Cargo.toml"));
76 if let Some(target) = build.config.target_config.get(target) {
77 if let Some(ref jemalloc) = target.jemalloc {
78 cargo.env("JEMALLOC_OVERRIDE", jemalloc);
81 if target.contains("musl") {
82 if let Some(p) = build.musl_root(target) {
83 cargo.env("MUSL_ROOT", p);
87 build.run(&mut cargo);
88 update_mtime(build, &libstd_stamp(build, &compiler, target));
91 /// Link all libstd rlibs/dylibs into the sysroot location.
93 /// Links those artifacts generated by `compiler` to a the `stage` compiler's
94 /// sysroot for the specified `host` and `target`.
96 /// Note that this assumes that `compiler` has already generated the libstd
97 /// libraries for `target`, and this method will find them in the relevant
99 pub fn std_link(build: &Build,
101 target_compiler: &Compiler,
103 println!("Copying stage{} std from stage{} ({} -> {} / {})",
104 target_compiler.stage,
107 target_compiler.host,
109 let libdir = build.sysroot_libdir(&target_compiler, target);
110 let out_dir = build.cargo_out(&compiler, Mode::Libstd, target);
112 t!(fs::create_dir_all(&libdir));
113 add_to_sysroot(&out_dir, &libdir);
115 if target.contains("musl") && !target.contains("mips") {
116 copy_musl_third_party_objects(build, target, &libdir);
120 /// Copies the crt(1,i,n).o startup objects
122 /// Only required for musl targets that statically link to libc
123 fn copy_musl_third_party_objects(build: &Build, target: &str, into: &Path) {
124 for &obj in &["crt1.o", "crti.o", "crtn.o"] {
125 copy(&build.musl_root(target).unwrap().join("lib").join(obj), &into.join(obj));
129 /// Build and prepare startup objects like rsbegin.o and rsend.o
131 /// These are primarily used on Windows right now for linking executables/dlls.
132 /// They don't require any library support as they're just plain old object
133 /// files, so we just use the nightly snapshot compiler to always build them (as
134 /// no other compilers are guaranteed to be available).
135 pub fn build_startup_objects(build: &Build, for_compiler: &Compiler, target: &str) {
136 if !target.contains("pc-windows-gnu") {
140 let compiler = Compiler::new(0, &build.config.build);
141 let compiler_path = build.compiler_path(&compiler);
142 let src_dir = &build.src.join("src/rtstartup");
143 let dst_dir = &build.native_dir(target).join("rtstartup");
144 let sysroot_dir = &build.sysroot_libdir(for_compiler, target);
145 t!(fs::create_dir_all(dst_dir));
146 t!(fs::create_dir_all(sysroot_dir));
148 for file in &["rsbegin", "rsend"] {
149 let src_file = &src_dir.join(file.to_string() + ".rs");
150 let dst_file = &dst_dir.join(file.to_string() + ".o");
151 if !up_to_date(src_file, dst_file) {
152 let mut cmd = Command::new(&compiler_path);
153 build.run(cmd.env("RUSTC_BOOTSTRAP", "1")
154 .arg("--target").arg(target)
156 .arg("--out-dir").arg(dst_dir)
160 copy(dst_file, &sysroot_dir.join(file.to_string() + ".o"));
163 for obj in ["crt2.o", "dllcrt2.o"].iter() {
164 copy(&compiler_file(build.cc(target), obj), &sysroot_dir.join(obj));
170 /// This will build libtest and supporting libraries for a particular stage of
171 /// the build using the `compiler` targeting the `target` architecture. The
172 /// artifacts created will also be linked into the sysroot directory.
173 pub fn test(build: &Build, target: &str, compiler: &Compiler) {
174 println!("Building stage{} test artifacts ({} -> {})", compiler.stage,
175 compiler.host, target);
176 let out_dir = build.cargo_out(compiler, Mode::Libtest, target);
177 build.clear_if_dirty(&out_dir, &libstd_stamp(build, compiler, target));
178 let mut cargo = build.cargo(compiler, Mode::Libtest, target, "build");
179 if let Ok(target) = env::var("MACOSX_STD_DEPLOYMENT_TARGET") {
180 cargo.env("MACOSX_DEPLOYMENT_TARGET", target);
182 cargo.arg("--manifest-path")
183 .arg(build.src.join("src/libtest/Cargo.toml"));
184 build.run(&mut cargo);
185 update_mtime(build, &libtest_stamp(build, compiler, target));
188 /// Same as `std_link`, only for libtest
189 pub fn test_link(build: &Build,
191 target_compiler: &Compiler,
193 println!("Copying stage{} test from stage{} ({} -> {} / {})",
194 target_compiler.stage,
197 target_compiler.host,
199 let libdir = build.sysroot_libdir(&target_compiler, target);
200 let out_dir = build.cargo_out(&compiler, Mode::Libtest, target);
201 add_to_sysroot(&out_dir, &libdir);
204 /// Build the compiler.
206 /// This will build the compiler for a particular stage of the build using
207 /// the `compiler` targeting the `target` architecture. The artifacts
208 /// created will also be linked into the sysroot directory.
209 pub fn rustc(build: &Build, target: &str, compiler: &Compiler) {
210 println!("Building stage{} compiler artifacts ({} -> {})",
211 compiler.stage, compiler.host, target);
213 let out_dir = build.cargo_out(compiler, Mode::Librustc, target);
214 build.clear_if_dirty(&out_dir, &libtest_stamp(build, compiler, target));
216 let mut cargo = build.cargo(compiler, Mode::Librustc, target, "build");
217 cargo.arg("--features").arg(build.rustc_features())
218 .arg("--manifest-path")
219 .arg(build.src.join("src/rustc/Cargo.toml"));
221 // Set some configuration variables picked up by build scripts and
222 // the compiler alike
223 cargo.env("CFG_RELEASE", build.rust_release())
224 .env("CFG_RELEASE_CHANNEL", &build.config.channel)
225 .env("CFG_VERSION", build.rust_version())
226 .env("CFG_PREFIX", build.config.prefix.clone().unwrap_or(PathBuf::new()));
228 if compiler.stage == 0 {
229 cargo.env("CFG_LIBDIR_RELATIVE", "lib");
231 let libdir_relative = build.config.libdir_relative.clone().unwrap_or(PathBuf::from("lib"));
232 cargo.env("CFG_LIBDIR_RELATIVE", libdir_relative);
235 // If we're not building a compiler with debugging information then remove
236 // these two env vars which would be set otherwise.
237 if build.config.rust_debuginfo_only_std {
238 cargo.env_remove("RUSTC_DEBUGINFO");
239 cargo.env_remove("RUSTC_DEBUGINFO_LINES");
242 if let Some(ref ver_date) = build.rust_info.commit_date() {
243 cargo.env("CFG_VER_DATE", ver_date);
245 if let Some(ref ver_hash) = build.rust_info.sha() {
246 cargo.env("CFG_VER_HASH", ver_hash);
248 if !build.unstable_features() {
249 cargo.env("CFG_DISABLE_UNSTABLE_FEATURES", "1");
251 // Flag that rust llvm is in use
252 if build.is_rust_llvm(target) {
253 cargo.env("LLVM_RUSTLLVM", "1");
255 cargo.env("LLVM_CONFIG", build.llvm_config(target));
256 let target_config = build.config.target_config.get(target);
257 if let Some(s) = target_config.and_then(|c| c.llvm_config.as_ref()) {
258 cargo.env("CFG_LLVM_ROOT", s);
260 // Building with a static libstdc++ is only supported on linux right now,
261 // not for MSVC or macOS
262 if build.config.llvm_static_stdcpp &&
263 !target.contains("windows") &&
264 !target.contains("apple") {
265 cargo.env("LLVM_STATIC_STDCPP",
266 compiler_file(build.cxx(target), "libstdc++.a"));
268 if build.config.llvm_link_shared {
269 cargo.env("LLVM_LINK_SHARED", "1");
271 if let Some(ref s) = build.config.rustc_default_linker {
272 cargo.env("CFG_DEFAULT_LINKER", s);
274 if let Some(ref s) = build.config.rustc_default_ar {
275 cargo.env("CFG_DEFAULT_AR", s);
277 build.run(&mut cargo);
278 update_mtime(build, &librustc_stamp(build, compiler, target));
281 /// Same as `std_link`, only for librustc
282 pub fn rustc_link(build: &Build,
284 target_compiler: &Compiler,
286 println!("Copying stage{} rustc from stage{} ({} -> {} / {})",
287 target_compiler.stage,
290 target_compiler.host,
292 let libdir = build.sysroot_libdir(&target_compiler, target);
293 let out_dir = build.cargo_out(&compiler, Mode::Librustc, target);
294 add_to_sysroot(&out_dir, &libdir);
297 /// Cargo's output path for the standard library in a given stage, compiled
298 /// by a particular compiler for the specified target.
299 fn libstd_stamp(build: &Build, compiler: &Compiler, target: &str) -> PathBuf {
300 build.cargo_out(compiler, Mode::Libstd, target).join(".libstd.stamp")
303 /// Cargo's output path for libtest in a given stage, compiled by a particular
304 /// compiler for the specified target.
305 fn libtest_stamp(build: &Build, compiler: &Compiler, target: &str) -> PathBuf {
306 build.cargo_out(compiler, Mode::Libtest, target).join(".libtest.stamp")
309 /// Cargo's output path for librustc in a given stage, compiled by a particular
310 /// compiler for the specified target.
311 fn librustc_stamp(build: &Build, compiler: &Compiler, target: &str) -> PathBuf {
312 build.cargo_out(compiler, Mode::Librustc, target).join(".librustc.stamp")
315 fn compiler_file(compiler: &Path, file: &str) -> PathBuf {
316 let out = output(Command::new(compiler)
317 .arg(format!("-print-file-name={}", file)));
318 PathBuf::from(out.trim())
321 pub fn create_sysroot(build: &Build, compiler: &Compiler) {
322 let sysroot = build.sysroot(compiler);
323 let _ = fs::remove_dir_all(&sysroot);
324 t!(fs::create_dir_all(&sysroot));
327 /// Prepare a new compiler from the artifacts in `stage`
329 /// This will assemble a compiler in `build/$host/stage$stage`. The compiler
330 /// must have been previously produced by the `stage - 1` build.config.build
332 pub fn assemble_rustc(build: &Build, stage: u32, host: &str) {
333 // nothing to do in stage0
338 println!("Copying stage{} compiler ({})", stage, host);
340 // The compiler that we're assembling
341 let target_compiler = Compiler::new(stage, host);
343 // The compiler that compiled the compiler we're assembling
344 let build_compiler = Compiler::new(stage - 1, &build.config.build);
346 // Link in all dylibs to the libdir
347 let sysroot = build.sysroot(&target_compiler);
348 let sysroot_libdir = sysroot.join(libdir(host));
349 t!(fs::create_dir_all(&sysroot_libdir));
350 let src_libdir = build.sysroot_libdir(&build_compiler, host);
351 for f in t!(fs::read_dir(&src_libdir)).map(|f| t!(f)) {
352 let filename = f.file_name().into_string().unwrap();
353 if is_dylib(&filename) {
354 copy(&f.path(), &sysroot_libdir.join(&filename));
358 let out_dir = build.cargo_out(&build_compiler, Mode::Librustc, host);
360 // Link the compiler binary itself into place
361 let rustc = out_dir.join(exe("rustc", host));
362 let bindir = sysroot.join("bin");
363 t!(fs::create_dir_all(&bindir));
364 let compiler = build.compiler_path(&Compiler::new(stage, host));
365 let _ = fs::remove_file(&compiler);
366 copy(&rustc, &compiler);
368 // See if rustdoc exists to link it into place
369 let rustdoc = exe("rustdoc", host);
370 let rustdoc_src = out_dir.join(&rustdoc);
371 let rustdoc_dst = bindir.join(&rustdoc);
372 if fs::metadata(&rustdoc_src).is_ok() {
373 let _ = fs::remove_file(&rustdoc_dst);
374 copy(&rustdoc_src, &rustdoc_dst);
378 /// Link some files into a rustc sysroot.
380 /// For a particular stage this will link all of the contents of `out_dir`
381 /// into the sysroot of the `host` compiler, assuming the artifacts are
382 /// compiled for the specified `target`.
383 fn add_to_sysroot(out_dir: &Path, sysroot_dst: &Path) {
384 // Collect the set of all files in the dependencies directory, keyed
385 // off the name of the library. We assume everything is of the form
386 // `foo-<hash>.{rlib,so,...}`, and there could be multiple different
387 // `<hash>` values for the same name (of old builds).
388 let mut map = HashMap::new();
389 for file in t!(fs::read_dir(out_dir.join("deps"))).map(|f| t!(f)) {
390 let filename = file.file_name().into_string().unwrap();
392 // We're only interested in linking rlibs + dylibs, other things like
393 // unit tests don't get linked in
394 if !filename.ends_with(".rlib") &&
395 !filename.ends_with(".lib") &&
396 !is_dylib(&filename) {
399 let file = file.path();
400 let dash = filename.find("-").unwrap();
401 let key = (filename[..dash].to_string(),
402 file.extension().unwrap().to_owned());
403 map.entry(key).or_insert(Vec::new())
407 // For all hash values found, pick the most recent one to move into the
408 // sysroot, that should be the one we just built.
409 for (_, paths) in map {
410 let (_, path) = paths.iter().map(|path| {
411 (mtime(&path).seconds(), path)
413 copy(&path, &sysroot_dst.join(path.file_name().unwrap()));
417 /// Build a tool in `src/tools`
419 /// This will build the specified tool with the specified `host` compiler in
420 /// `stage` into the normal cargo output directory.
421 pub fn maybe_clean_tools(build: &Build, stage: u32, target: &str, mode: Mode) {
422 let compiler = Compiler::new(stage, &build.config.build);
424 let stamp = match mode {
425 Mode::Libstd => libstd_stamp(build, &compiler, target),
426 Mode::Libtest => libtest_stamp(build, &compiler, target),
427 Mode::Librustc => librustc_stamp(build, &compiler, target),
430 let out_dir = build.cargo_out(&compiler, Mode::Tool, target);
431 build.clear_if_dirty(&out_dir, &stamp);
434 /// Build a tool in `src/tools`
436 /// This will build the specified tool with the specified `host` compiler in
437 /// `stage` into the normal cargo output directory.
438 pub fn tool(build: &Build, stage: u32, target: &str, tool: &str) {
439 println!("Building stage{} tool {} ({})", stage, tool, target);
441 let compiler = Compiler::new(stage, &build.config.build);
443 let mut cargo = build.cargo(&compiler, Mode::Tool, target, "build");
444 let mut dir = build.src.join(tool);
446 dir = build.src.join("src/tools").join(tool);
448 cargo.arg("--manifest-path").arg(dir.join("Cargo.toml"));
450 // We don't want to build tools dynamically as they'll be running across
451 // stages and such and it's just easier if they're not dynamically linked.
452 cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
454 if let Some(dir) = build.openssl_install_dir(target) {
455 cargo.env("OPENSSL_STATIC", "1");
456 cargo.env("OPENSSL_DIR", dir);
457 cargo.env("LIBZ_SYS_STATIC", "1");
460 cargo.env("CFG_RELEASE_CHANNEL", &build.config.channel);
462 let info = GitInfo::new(&dir);
463 if let Some(sha) = info.sha() {
464 cargo.env("CFG_COMMIT_HASH", sha);
466 if let Some(sha_short) = info.sha_short() {
467 cargo.env("CFG_SHORT_COMMIT_HASH", sha_short);
469 if let Some(date) = info.commit_date() {
470 cargo.env("CFG_COMMIT_DATE", date);
473 build.run(&mut cargo);
476 /// Updates the mtime of a stamp file if necessary, only changing it if it's
477 /// older than some other library file in the same directory.
479 /// We don't know what file Cargo is going to output (because there's a hash in
480 /// the file name) but we know where it's going to put it. We use this helper to
481 /// detect changes to that output file by looking at the modification time for
482 /// all files in a directory and updating the stamp if any are newer.
484 /// Note that we only consider Rust libraries as that's what we're interested in
485 /// propagating changes from. Files like executables are tracked elsewhere.
486 fn update_mtime(build: &Build, path: &Path) {
487 let entries = match path.parent().unwrap().join("deps").read_dir() {
488 Ok(entries) => entries,
491 let files = entries.map(|e| t!(e)).filter(|e| t!(e.file_type()).is_file());
492 let files = files.filter(|e| {
493 let filename = e.file_name();
494 let filename = filename.to_str().unwrap();
495 filename.ends_with(".rlib") ||
496 filename.ends_with(".lib") ||
499 let max = files.max_by_key(|entry| {
500 let meta = t!(entry.metadata());
501 FileTime::from_last_modification_time(&meta)
503 let max = match max {
508 if mtime(&max.path()) > mtime(path) {
509 build.verbose(&format!("updating {:?} as {:?} changed", path, max.path()));
510 t!(File::create(path));