1 // Copyright 2017 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 use serde::{Serialize, Deserialize};
13 use std::cell::RefCell;
14 use std::path::{Path, PathBuf};
15 use std::process::Command;
22 use util::{exe, libdir, add_lib_path};
24 use cache::{Cache, Key};
26 use flags::Subcommand;
31 pub struct Builder<'a> {
36 stack: RefCell<Vec<Key>>,
39 impl<'a> Deref for Builder<'a> {
42 fn deref(&self) -> &Self::Target {
47 pub trait Step<'a>: Sized {
48 type Output: Serialize + Deserialize<'a>;
50 const DEFAULT: bool = false;
52 /// Run this rule for all hosts, and just the same hosts as the targets.
53 const ONLY_HOSTS: bool = false;
55 /// Run this rule for all targets, but only with the native host.
56 const ONLY_BUILD_TARGETS: bool = false;
58 /// Only run this step with the build triple as host and target.
59 const ONLY_BUILD: bool = false;
61 fn run(self, builder: &'a Builder) -> Self::Output;
63 fn should_run(_builder: &'a Builder, _path: &Path) -> bool { false }
66 _builder: &'a Builder,
70 ) { unimplemented!() }
73 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
84 (@inner $self:ident, $rule:ty, $path:expr) => {
85 let build = $self.build;
86 let hosts = if <$rule>::ONLY_BUILD_TARGETS || <$rule>::ONLY_BUILD {
87 &build.config.host[..1]
92 // Determine the actual targets participating in this rule.
93 // NOTE: We should keep the full projection from build triple to
94 // the hosts for the dist steps, now that the hosts array above is
95 // truncated to avoid duplication of work in that case. Therefore
96 // the original non-shadowed hosts array is used below.
97 let targets = if <$rule>::ONLY_HOSTS {
98 // If --target was specified but --host wasn't specified,
99 // don't run any host-only tests. Also, respect any `--host`
100 // overrides as done for `hosts`.
101 if build.flags.host.len() > 0 {
102 &build.flags.host[..]
103 } else if build.flags.target.len() > 0 {
105 } else if <$rule>::ONLY_BUILD {
106 &build.config.host[..1]
108 &build.config.host[..]
114 build.verbose(&format!("executing {} with hosts={:?}, targets={:?}",
115 stringify!($rule), hosts, targets));
117 for target in targets {
118 <$rule>::make_run($self, $path, host, target);
122 ($self:ident, $paths:ident, $($rule:ty),+ $(,)*) => {{
124 if paths.is_empty() {
126 if <$rule>::DEFAULT {
127 check!(@inner $self, $rule, None);
133 if <$rule>::should_run($self, path) {
134 check!(@inner $self, $rule, Some(path));
142 impl<'a> Builder<'a> {
143 pub fn run(build: &Build) {
144 let (kind, paths) = match build.flags.cmd {
145 Subcommand::Build { ref paths } => (Kind::Build, &paths[..]),
146 Subcommand::Doc { ref paths } => (Kind::Doc, &paths[..]),
147 Subcommand::Test { ref paths, .. } => (Kind::Test, &paths[..]),
148 Subcommand::Bench { ref paths, .. } => (Kind::Bench, &paths[..]),
149 Subcommand::Dist { ref paths } => (Kind::Dist, &paths[..]),
150 Subcommand::Install { ref paths } => (Kind::Install, &paths[..]),
151 Subcommand::Clean => panic!(),
154 let builder = Builder {
156 top_stage: build.flags.stage.unwrap_or(2),
159 stack: RefCell::new(Vec::new()),
162 let builder = &builder;
164 Kind::Build => check!(builder, paths, compile::Std, compile::Test, compile::Rustc,
165 compile::StartupObjects),
166 Kind::Test => check!(builder, paths, check::Tidy, check::Bootstrap, check::Compiletest,
167 check::Krate, check::KrateLibrustc, check::Linkcheck, check::Cargotest,
168 check::Cargo, check::Docs, check::ErrorIndex, check::Distcheck),
169 Kind::Bench => check!(builder, paths, check::Krate, check::KrateLibrustc),
170 Kind::Doc => builder.default_doc(Some(paths)),
171 Kind::Dist => check!(builder, paths, dist::Docs, dist::Mingw, dist::Rustc,
172 dist::DebuggerScripts, dist::Std, dist::Analysis, dist::Src,
173 dist::PlainSourceTarball, dist::Cargo, dist::Rls, dist::Extended, dist::HashSign),
174 Kind::Install => check!(builder, paths, install::Docs, install::Std, install::Cargo,
175 install::Rls, install::Analysis, install::Src, install::Rustc),
179 pub fn default_doc(&self, paths: Option<&[PathBuf]>) {
180 let paths = paths.unwrap_or(&[]);
181 check!(self, paths, doc::UnstableBook, doc::UnstableBookGen, doc::Rustbook, doc::TheBook,
182 doc::Standalone, doc::Std, doc::Test, doc::Rustc, doc::ErrorIndex,
183 doc::Nomicon, doc::Reference);
186 pub fn compiler(&'a self, stage: u32, host: &'a str) -> Compiler<'a> {
187 self.ensure(compile::Assemble { target_compiler: Compiler { stage, host } })
190 pub fn sysroot(&self, compiler: Compiler<'a>) -> PathBuf {
191 self.ensure(compile::Sysroot { compiler })
194 /// Returns the libdir where the standard library and other artifacts are
195 /// found for a compiler's sysroot.
196 pub fn sysroot_libdir(&self, compiler: Compiler<'a>, target: &'a str) -> PathBuf {
199 compiler: Compiler<'a>,
202 impl<'a> Step<'a> for Libdir<'a> {
203 type Output = PathBuf;
204 fn run(self, builder: &Builder) -> PathBuf {
205 let sysroot = builder.sysroot(self.compiler)
206 .join("lib").join("rustlib").join(self.target).join("lib");
207 let _ = fs::remove_dir_all(&sysroot);
208 t!(fs::create_dir_all(&sysroot));
212 self.ensure(Libdir { compiler, target })
215 /// Returns the compiler's libdir where it stores the dynamic libraries that
216 /// it itself links against.
218 /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
220 pub fn rustc_libdir(&self, compiler: Compiler) -> PathBuf {
221 if compiler.is_snapshot(self) {
222 self.build.rustc_snapshot_libdir()
224 self.sysroot(compiler).join(libdir(compiler.host))
228 /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
229 /// library lookup path.
230 pub fn add_rustc_lib_path(&self, compiler: Compiler, cmd: &mut Command) {
231 // Windows doesn't need dylib path munging because the dlls for the
232 // compiler live next to the compiler and the system will find them
238 add_lib_path(vec![self.rustc_libdir(compiler)], cmd);
241 /// Get a path to the compiler specified.
242 pub fn rustc(&self, compiler: Compiler) -> PathBuf {
243 if compiler.is_snapshot(self) {
244 self.initial_rustc.clone()
246 self.sysroot(compiler).join("bin").join(exe("rustc", compiler.host))
250 /// Get the `rustdoc` executable next to the specified compiler
251 pub fn rustdoc(&self, compiler: Compiler) -> PathBuf {
252 let mut rustdoc = self.rustc(compiler);
254 rustdoc.push(exe("rustdoc", compiler.host));
258 /// Prepares an invocation of `cargo` to be run.
260 /// This will create a `Command` that represents a pending execution of
261 /// Cargo. This cargo will be configured to use `compiler` as the actual
262 /// rustc compiler, its output will be scoped by `mode`'s output directory,
263 /// it will pass the `--target` flag for the specified `target`, and will be
264 /// executing the Cargo command `cmd`.
269 cmd: &str) -> Command {
270 let mut cargo = Command::new(&self.initial_cargo);
271 let out_dir = self.stage_out(compiler, mode);
272 cargo.env("CARGO_TARGET_DIR", out_dir)
274 .arg("-j").arg(self.jobs().to_string())
275 .arg("--target").arg(target);
277 // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
278 // Force cargo to output binaries with disambiguating hashes in the name
279 cargo.env("__CARGO_DEFAULT_LIB_METADATA", &self.config.channel);
282 if compiler.stage == 0 && self.local_rebuild {
283 // Assume the local-rebuild rustc already has stage1 features.
286 stage = compiler.stage;
289 // Customize the compiler we're running. Specify the compiler to cargo
290 // as our shim and then pass it some various options used to configure
291 // how the actual compiler itself is called.
293 // These variables are primarily all read by
294 // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
295 cargo.env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
296 .env("RUSTC", self.out.join("bootstrap/debug/rustc"))
297 .env("RUSTC_REAL", self.rustc(compiler))
298 .env("RUSTC_STAGE", stage.to_string())
299 .env("RUSTC_CODEGEN_UNITS",
300 self.config.rust_codegen_units.to_string())
301 .env("RUSTC_DEBUG_ASSERTIONS",
302 self.config.rust_debug_assertions.to_string())
303 .env("RUSTC_SYSROOT", self.sysroot(compiler))
304 .env("RUSTC_LIBDIR", self.rustc_libdir(compiler))
305 .env("RUSTC_RPATH", self.config.rust_rpath.to_string())
306 .env("RUSTDOC", self.out.join("bootstrap/debug/rustdoc"))
307 .env("RUSTDOC_REAL", self.rustdoc(compiler))
308 .env("RUSTC_FLAGS", self.rustc_flags(target).join(" "));
310 if mode != Mode::Tool {
311 // Tools don't get debuginfo right now, e.g. cargo and rls don't
312 // get compiled with debuginfo.
313 cargo.env("RUSTC_DEBUGINFO", self.config.rust_debuginfo.to_string())
314 .env("RUSTC_DEBUGINFO_LINES", self.config.rust_debuginfo_lines.to_string())
315 .env("RUSTC_FORCE_UNSTABLE", "1");
317 // Currently the compiler depends on crates from crates.io, and
318 // then other crates can depend on the compiler (e.g. proc-macro
319 // crates). Let's say, for example that rustc itself depends on the
320 // bitflags crate. If an external crate then depends on the
321 // bitflags crate as well, we need to make sure they don't
322 // conflict, even if they pick the same verison of bitflags. We'll
323 // want to make sure that e.g. a plugin and rustc each get their
324 // own copy of bitflags.
326 // Cargo ensures that this works in general through the -C metadata
327 // flag. This flag will frob the symbols in the binary to make sure
328 // they're different, even though the source code is the exact
329 // same. To solve this problem for the compiler we extend Cargo's
330 // already-passed -C metadata flag with our own. Our rustc.rs
331 // wrapper around the actual rustc will detect -C metadata being
332 // passed and frob it with this extra string we're passing in.
333 cargo.env("RUSTC_METADATA_SUFFIX", "rustc");
336 // Enable usage of unstable features
337 cargo.env("RUSTC_BOOTSTRAP", "1");
338 self.add_rust_test_threads(&mut cargo);
340 // Almost all of the crates that we compile as part of the bootstrap may
341 // have a build script, including the standard library. To compile a
342 // build script, however, it itself needs a standard library! This
343 // introduces a bit of a pickle when we're compiling the standard
346 // To work around this we actually end up using the snapshot compiler
347 // (stage0) for compiling build scripts of the standard library itself.
348 // The stage0 compiler is guaranteed to have a libstd available for use.
350 // For other crates, however, we know that we've already got a standard
351 // library up and running, so we can use the normal compiler to compile
352 // build scripts in that situation.
353 if mode == Mode::Libstd {
354 cargo.env("RUSTC_SNAPSHOT", &self.initial_rustc)
355 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
357 cargo.env("RUSTC_SNAPSHOT", self.rustc(compiler))
358 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
361 // Ignore incremental modes except for stage0, since we're
362 // not guaranteeing correctness across builds if the compiler
363 // is changing under your feet.`
364 if self.flags.incremental && compiler.stage == 0 {
365 let incr_dir = self.incremental_dir(compiler);
366 cargo.env("RUSTC_INCREMENTAL", incr_dir);
369 if let Some(ref on_fail) = self.flags.on_fail {
370 cargo.env("RUSTC_ON_FAIL", on_fail);
373 cargo.env("RUSTC_VERBOSE", format!("{}", self.verbosity));
375 // Specify some various options for build scripts used throughout
378 // FIXME: the guard against msvc shouldn't need to be here
379 if !target.contains("msvc") {
380 cargo.env(format!("CC_{}", target), self.cc(target))
381 .env(format!("AR_{}", target), self.ar(target).unwrap()) // only msvc is None
382 .env(format!("CFLAGS_{}", target), self.cflags(target).join(" "));
384 if let Ok(cxx) = self.cxx(target) {
385 cargo.env(format!("CXX_{}", target), cxx);
389 if mode == Mode::Libstd && self.config.extended && compiler.is_final_stage(self) {
390 cargo.env("RUSTC_SAVE_ANALYSIS", "api".to_string());
393 // When being built Cargo will at some point call `nmake.exe` on Windows
394 // MSVC. Unfortunately `nmake` will read these two environment variables
395 // below and try to intepret them. We're likely being run, however, from
396 // MSYS `make` which uses the same variables.
398 // As a result, to prevent confusion and errors, we remove these
399 // variables from our environment to prevent passing MSYS make flags to
400 // nmake, causing it to blow up.
401 if cfg!(target_env = "msvc") {
402 cargo.env_remove("MAKE");
403 cargo.env_remove("MAKEFLAGS");
406 // Environment variables *required* throughout the build
408 // FIXME: should update code to not require this env var
409 cargo.env("CFG_COMPILER_HOST_TRIPLE", target);
411 if self.is_verbose() {
414 // FIXME: cargo bench does not accept `--release`
415 if self.config.rust_optimize && cmd != "bench" {
416 cargo.arg("--release");
418 if self.config.locked_deps {
419 cargo.arg("--locked");
421 if self.config.vendor || self.is_sudo {
422 cargo.arg("--frozen");
425 self.ci_env.force_coloring_in_ci(&mut cargo);
430 pub fn ensure<S: Step<'a> + Serialize>(&'a self, step: S) -> S::Output
434 let key = Cache::to_key(&step);
436 let mut stack = self.stack.borrow_mut();
437 if stack.contains(&key) {
438 let mut out = String::new();
439 out += &format!("\n\nCycle in build detected when adding {:?}\n", key);
440 for el in stack.iter().rev() {
441 out += &format!("\t{:?}\n", el);
445 if let Some(out) = self.cache.get::<S::Output>(&key) {
446 self.build.verbose(&format!("{}c {:?}", " ".repeat(stack.len()), key));
450 self.build.verbose(&format!("{}> {:?}", " ".repeat(stack.len()), key));
451 stack.push(key.clone());
453 let out = step.run(self);
455 let mut stack = self.stack.borrow_mut();
456 assert_eq!(stack.pop().as_ref(), Some(&key));
458 self.build.verbose(&format!("{}< {:?}", " ".repeat(self.stack.borrow().len()), key));
459 self.cache.put(key.clone(), &out);
460 self.cache.get::<S::Output>(&key).unwrap()