src/bootstrap/builder.rs

   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.
   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 use serde::{Serialize, Deserialize};
  12
  13 use std::cell::RefCell;
  14 use std::path::{Path, PathBuf};
  15 use std::process::Command;
  16 use std::fs;
  17 use std::ops::Deref;
  18
  19 use compile;
  20 use install;
  21 use dist;
  22 use util::{exe, libdir, add_lib_path};
  23 use {Build, Mode};
  24 use cache::{Cache, Key};
  25 use check;
  26 use flags::Subcommand;
  27 use doc;
  28
  29 pub use Compiler;
  30
  31 pub struct Builder<'a> {
  32     pub build: &'a Build,
  33     pub top_stage: u32,
  34     pub kind: Kind,
  35     cache: Cache,
  36     stack: RefCell<Vec<Key>>,
  37 }
  38
  39 impl<'a> Deref for Builder<'a> {
  40     type Target = Build;
  41
  42     fn deref(&self) -> &Self::Target {
  43         self.build
  44     }
  45 }
  46
  47 pub trait Step<'a>: Sized {
  48     type Output: Serialize + Deserialize<'a>;
  49
  50     const DEFAULT: bool = false;
  51
  52     /// Run this rule for all hosts, and just the same hosts as the targets.
  53     const ONLY_HOSTS: bool = false;
  54
  55     /// Run this rule for all targets, but only with the native host.
  56     const ONLY_BUILD_TARGETS: bool = false;
  57
  58     /// Only run this step with the build triple as host and target.
  59     const ONLY_BUILD: bool = false;
  60
  61     fn run(self, builder: &'a Builder) -> Self::Output;
  62
  63     fn should_run(_builder: &'a Builder, _path: &Path) -> bool { false }
  64
  65     fn make_run(
  66         _builder: &'a Builder,
  67         _path: Option<&Path>,
  68         _host: &'a str,
  69         _target: &'a str,
  70     ) { unimplemented!() }
  71 }
  72
  73 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
  74 pub enum Kind {
  75     Build,
  76     Test,
  77     Bench,
  78     Dist,
  79     Doc,
  80     Install,
  81 }
  82
  83 macro_rules! check {
  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]
  88         } else {
  89             &build.hosts
  90         };
  91
  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 {
 104                 &[]
 105             } else if <$rule>::ONLY_BUILD {
 106                 &build.config.host[..1]
 107             } else {
 108                 &build.config.host[..]
 109             }
 110         } else {
 111             &build.targets
 112         };
 113
 114         build.verbose(&format!("executing {} with hosts={:?}, targets={:?}",
 115             stringify!($rule), hosts, targets));
 116         for host in hosts {
 117             for target in targets {
 118                 <$rule>::make_run($self, $path, host, target);
 119             }
 120         }
 121     };
 122     ($self:ident, $paths:ident, $($rule:ty),+ $(,)*) => {{
 123         let paths = $paths;
 124         if paths.is_empty() {
 125             $({
 126                 if <$rule>::DEFAULT {
 127                     check!(@inner $self, $rule, None);
 128                 }
 129             })+
 130         } else {
 131             for path in paths {
 132                 $({
 133                     if <$rule>::should_run($self, path) {
 134                         check!(@inner $self, $rule, Some(path));
 135                     }
 136                 })+
 137             }
 138         }
 139     }};
 140 }
 141
 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!(),
 152         };
 153
 154         let builder = Builder {
 155             build: build,
 156             top_stage: build.flags.stage.unwrap_or(2),
 157             kind: kind,
 158             cache: Cache::new(),
 159             stack: RefCell::new(Vec::new()),
 160         };
 161
 162         let builder = &builder;
 163         match builder.kind {
 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),
 176         }
 177     }
 178
 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);
 184     }
 185
 186     pub fn compiler(&'a self, stage: u32, host: &'a str) -> Compiler<'a> {
 187         self.ensure(compile::Assemble { target_compiler: Compiler { stage, host } })
 188     }
 189
 190     pub fn rustc(&self, compiler: Compiler) -> PathBuf {
 191         if compiler.is_snapshot(self) {
 192             self.build.initial_rustc.clone()
 193         } else {
 194             self.compiler(compiler.stage, compiler.host);
 195             self.sysroot(compiler).join("bin").join(exe("rustc", compiler.host))
 196         }
 197     }
 198
 199     pub fn rustdoc(&self, compiler: Compiler) -> PathBuf {
 200         let mut rustdoc = self.rustc(compiler);
 201         rustdoc.pop();
 202         rustdoc.push(exe("rustdoc", compiler.host));
 203         rustdoc
 204     }
 205
 206     pub fn sysroot(&self, compiler: Compiler<'a>) -> PathBuf {
 207         self.ensure(compile::Sysroot { compiler })
 208     }
 209
 210     /// Returns the libdir where the standard library and other artifacts are
 211     /// found for a compiler's sysroot.
 212     pub fn sysroot_libdir(&self, compiler: Compiler<'a>, target: &'a str) -> PathBuf {
 213         #[derive(Serialize)]
 214         struct Libdir<'a> {
 215             compiler: Compiler<'a>,
 216             target: &'a str,
 217         }
 218         impl<'a> Step<'a> for Libdir<'a> {
 219             type Output = PathBuf;
 220             fn run(self, builder: &Builder) -> PathBuf {
 221                 let sysroot = builder.sysroot(self.compiler)
 222                     .join("lib").join("rustlib").join(self.target).join("lib");
 223                 let _ = fs::remove_dir_all(&sysroot);
 224                 t!(fs::create_dir_all(&sysroot));
 225                 sysroot
 226             }
 227         }
 228         self.ensure(Libdir { compiler, target })
 229     }
 230
 231     /// Returns the compiler's libdir where it stores the dynamic libraries that
 232     /// it itself links against.
 233     ///
 234     /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
 235     /// Windows.
 236     pub fn rustc_libdir(&self, compiler: Compiler) -> PathBuf {
 237         if compiler.is_snapshot(self) {
 238             self.build.rustc_snapshot_libdir()
 239         } else {
 240             self.sysroot(compiler).join(libdir(compiler.host))
 241         }
 242     }
 243
 244     /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
 245     /// library lookup path.
 246     pub fn add_rustc_lib_path(&self, compiler: Compiler, cmd: &mut Command) {
 247         // Windows doesn't need dylib path munging because the dlls for the
 248         // compiler live next to the compiler and the system will find them
 249         // automatically.
 250         if cfg!(windows) {
 251             return
 252         }
 253
 254         add_lib_path(vec![self.rustc_libdir(compiler)], cmd);
 255     }
 256
 257     /// Prepares an invocation of `cargo` to be run.
 258     ///
 259     /// This will create a `Command` that represents a pending execution of
 260     /// Cargo. This cargo will be configured to use `compiler` as the actual
 261     /// rustc compiler, its output will be scoped by `mode`'s output directory,
 262     /// it will pass the `--target` flag for the specified `target`, and will be
 263     /// executing the Cargo command `cmd`.
 264     pub fn cargo(&self, compiler: Compiler, mode: Mode, target: &str, cmd: &str) -> Command {
 265         let build = self.build;
 266
 267         // Clear out the output we're about to generate if our compiler changed
 268         {
 269             let out_dir = build.cargo_out(compiler, mode, target);
 270             build.clear_if_dirty(&out_dir, &self.rustc(compiler));
 271         }
 272
 273         let mut cargo = Command::new(&build.initial_cargo);
 274         let out_dir = build.stage_out(compiler, mode);
 275
 276         cargo.env("CARGO_TARGET_DIR", out_dir)
 277              .arg(cmd)
 278              .arg("-j").arg(build.jobs().to_string())
 279              .arg("--target").arg(target);
 280
 281         // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
 282         // Force cargo to output binaries with disambiguating hashes in the name
 283         cargo.env("__CARGO_DEFAULT_LIB_METADATA", &self.build.config.channel);
 284
 285         let stage;
 286         if compiler.stage == 0 && build.local_rebuild {
 287             // Assume the local-rebuild rustc already has stage1 features.
 288             stage = 1;
 289         } else {
 290             stage = compiler.stage;
 291         }
 292
 293         self.build.verbose(&format!("cargo using: {:?}", self.rustc(compiler)));
 294
 295         // Customize the compiler we're running. Specify the compiler to cargo
 296         // as our shim and then pass it some various options used to configure
 297         // how the actual compiler itbuild is called.
 298         //
 299         // These variables are primarily all read by
 300         // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
 301         cargo.env("RUSTBUILD_NATIVE_DIR", build.native_dir(target))
 302              .env("RUSTC", build.out.join("bootstrap/debug/rustc"))
 303              .env("RUSTC_REAL", self.rustc(compiler))
 304              .env("RUSTC_STAGE", stage.to_string())
 305              .env("RUSTC_CODEGEN_UNITS",
 306                   build.config.rust_codegen_units.to_string())
 307              .env("RUSTC_DEBUG_ASSERTIONS",
 308                   build.config.rust_debug_assertions.to_string())
 309              .env("RUSTC_SYSROOT", self.sysroot(compiler))
 310              .env("RUSTC_LIBDIR", self.rustc_libdir(compiler))
 311              .env("RUSTC_RPATH", build.config.rust_rpath.to_string())
 312              .env("RUSTDOC", build.out.join("bootstrap/debug/rustdoc"))
 313              .env("RUSTDOC_REAL", self.rustdoc(compiler))
 314              .env("RUSTC_FLAGS", build.rustc_flags(target).join(" "));
 315
 316         if mode != Mode::Tool {
 317             // Tools don't get debuginfo right now, e.g. cargo and rls don't
 318             // get compiled with debuginfo.
 319             cargo.env("RUSTC_DEBUGINFO", build.config.rust_debuginfo.to_string())
 320                  .env("RUSTC_DEBUGINFO_LINES", build.config.rust_debuginfo_lines.to_string())
 321                  .env("RUSTC_FORCE_UNSTABLE", "1");
 322
 323             // Currently the compiler depends on crates from crates.io, and
 324             // then other crates can depend on the compiler (e.g. proc-macro
 325             // crates). Let's say, for example that rustc itbuild depends on the
 326             // bitflags crate. If an external crate then depends on the
 327             // bitflags crate as well, we need to make sure they don't
 328             // conflict, even if they pick the same verison of bitflags. We'll
 329             // want to make sure that e.g. a plugin and rustc each get their
 330             // own copy of bitflags.
 331
 332             // Cargo ensures that this works in general through the -C metadata
 333             // flag. This flag will frob the symbols in the binary to make sure
 334             // they're different, even though the source code is the exact
 335             // same. To solve this problem for the compiler we extend Cargo's
 336             // already-passed -C metadata flag with our own. Our rustc.rs
 337             // wrapper around the actual rustc will detect -C metadata being
 338             // passed and frob it with this extra string we're passing in.
 339             cargo.env("RUSTC_METADATA_SUFFIX", "rustc");
 340         }
 341
 342         // Enable usage of unstable features
 343         cargo.env("RUSTC_BOOTSTRAP", "1");
 344         build.add_rust_test_threads(&mut cargo);
 345
 346         // Almost all of the crates that we compile as part of the bootstrap may
 347         // have a build script, including the standard library. To compile a
 348         // build script, however, it itbuild needs a standard library! This
 349         // introduces a bit of a pickle when we're compiling the standard
 350         // library itbuild.
 351         //
 352         // To work around this we actually end up using the snapshot compiler
 353         // (stage0) for compiling build scripts of the standard library itbuild.
 354         // The stage0 compiler is guaranteed to have a libstd available for use.
 355         //
 356         // For other crates, however, we know that we've already got a standard
 357         // library up and running, so we can use the normal compiler to compile
 358         // build scripts in that situation.
 359         if mode == Mode::Libstd {
 360             cargo.env("RUSTC_SNAPSHOT", &build.initial_rustc)
 361                  .env("RUSTC_SNAPSHOT_LIBDIR", build.rustc_snapshot_libdir());
 362         } else {
 363             cargo.env("RUSTC_SNAPSHOT", self.rustc(compiler))
 364                  .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
 365         }
 366
 367         // Ignore incremental modes except for stage0, since we're
 368         // not guaranteeing correctness across builds if the compiler
 369         // is changing under your feet.`
 370         if build.flags.incremental && compiler.stage == 0 {
 371             let incr_dir = build.incremental_dir(compiler);
 372             cargo.env("RUSTC_INCREMENTAL", incr_dir);
 373         }
 374
 375         if let Some(ref on_fail) = build.flags.on_fail {
 376             cargo.env("RUSTC_ON_FAIL", on_fail);
 377         }
 378
 379         cargo.env("RUSTC_VERBOSE", format!("{}", build.verbosity));
 380
 381         // Specify some various options for build scripts used throughout
 382         // the build.
 383         //
 384         // FIXME: the guard against msvc shouldn't need to be here
 385         if !target.contains("msvc") {
 386             cargo.env(format!("CC_{}", target), build.cc(target))
 387                  .env(format!("AR_{}", target), build.ar(target).unwrap()) // only msvc is None
 388                  .env(format!("CFLAGS_{}", target), build.cflags(target).join(" "));
 389
 390             if let Ok(cxx) = build.cxx(target) {
 391                  cargo.env(format!("CXX_{}", target), cxx);
 392             }
 393         }
 394
 395         if build.config.extended && compiler.is_final_stage(self) {
 396             cargo.env("RUSTC_SAVE_ANALYSIS", "api".to_string());
 397         }
 398
 399         // When being built Cargo will at some point call `nmake.exe` on Windows
 400         // MSVC. Unfortunately `nmake` will read these two environment variables
 401         // below and try to intepret them. We're likely being run, however, from
 402         // MSYS `make` which uses the same variables.
 403         //
 404         // As a result, to prevent confusion and errors, we remove these
 405         // variables from our environment to prevent passing MSYS make flags to
 406         // nmake, causing it to blow up.
 407         if cfg!(target_env = "msvc") {
 408             cargo.env_remove("MAKE");
 409             cargo.env_remove("MAKEFLAGS");
 410         }
 411
 412         // Environment variables *required* throughout the build
 413         //
 414         // FIXME: should update code to not require this env var
 415         cargo.env("CFG_COMPILER_HOST_TRIPLE", target);
 416
 417         if build.is_verbose() {
 418             cargo.arg("-v");
 419         }
 420         // FIXME: cargo bench does not accept `--release`
 421         if build.config.rust_optimize && cmd != "bench" {
 422             cargo.arg("--release");
 423         }
 424         if build.config.locked_deps {
 425             cargo.arg("--locked");
 426         }
 427         if build.config.vendor || build.is_sudo {
 428             cargo.arg("--frozen");
 429         }
 430
 431         build.ci_env.force_coloring_in_ci(&mut cargo);
 432
 433         cargo
 434     }
 435
 436     pub fn ensure<S: Step<'a> + Serialize>(&'a self, step: S) -> S::Output
 437     where
 438         S::Output: 'a
 439     {
 440         let key = Cache::to_key(&step);
 441         {
 442             let mut stack = self.stack.borrow_mut();
 443             if stack.contains(&key) {
 444                 let mut out = String::new();
 445                 out += &format!("\n\nCycle in build detected when adding {:?}\n", key);
 446                 for el in stack.iter().rev() {
 447                     out += &format!("\t{:?}\n", el);
 448                 }
 449                 panic!(out);
 450             }
 451             if let Some(out) = self.cache.get::<S::Output>(&key) {
 452                 self.build.verbose(&format!("{}c {:?}", "  ".repeat(stack.len()), key));
 453
 454                 return out;
 455             }
 456             self.build.verbose(&format!("{}> {:?}", "  ".repeat(stack.len()), key));
 457             stack.push(key.clone());
 458         }
 459         let out = step.run(self);
 460         {
 461             let mut stack = self.stack.borrow_mut();
 462             assert_eq!(stack.pop().as_ref(), Some(&key));
 463         }
 464         self.build.verbose(&format!("{}< {:?}", "  ".repeat(self.stack.borrow().len()), key));
 465         self.cache.put(key.clone(), &out);
 466         self.cache.get::<S::Output>(&key).unwrap()
 467     }
 468 }