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     ($self:ident, $paths:ident, $($rule:ty),+ $(,)*) => {{
  85         let paths = $paths;
  86         if paths.is_empty() {
  87             $({
  88                 if <$rule>::DEFAULT {
  89                     $self.maybe_run::<$rule>(None);
  90                 }
  91             })+
  92         } else {
  93             for path in paths {
  94                 $({
  95                     if <$rule>::should_run($self, path) {
  96                         $self.maybe_run::<$rule>(Some(path));
  97                     }
  98                 })+
  99             }
 100         }
 101     }};
 102 }
 103
 104 impl<'a> Builder<'a> {
 105     pub fn run(build: &Build) {
 106         let (kind, paths) = match build.flags.cmd {
 107             Subcommand::Build { ref paths } => (Kind::Build, &paths[..]),
 108             Subcommand::Doc { ref paths } => (Kind::Doc, &paths[..]),
 109             Subcommand::Test { ref paths, .. } => (Kind::Test, &paths[..]),
 110             Subcommand::Bench { ref paths, .. } => (Kind::Bench, &paths[..]),
 111             Subcommand::Dist { ref paths } => (Kind::Dist, &paths[..]),
 112             Subcommand::Install { ref paths } => (Kind::Install, &paths[..]),
 113             Subcommand::Clean => panic!(),
 114         };
 115
 116         let builder = Builder {
 117             build: build,
 118             top_stage: build.flags.stage.unwrap_or(2),
 119             kind: kind,
 120             cache: Cache::new(),
 121             stack: RefCell::new(Vec::new()),
 122         };
 123
 124         let builder = &builder;
 125         match builder.kind {
 126             Kind::Build => check!(builder, paths, compile::Std, compile::Test, compile::Rustc,
 127                 compile::StartupObjects),
 128             Kind::Test => check!(builder, paths, check::Tidy, check::Bootstrap, check::Compiletest,
 129                 check::Krate, check::KrateLibrustc, check::Linkcheck, check::Cargotest,
 130                 check::Cargo, check::Docs, check::ErrorIndex, check::Distcheck),
 131             Kind::Bench => check!(builder, paths, check::Krate, check::KrateLibrustc),
 132             Kind::Doc => builder.default_doc(Some(paths)),
 133             Kind::Dist => check!(builder, paths, dist::Docs, dist::Mingw, dist::Rustc,
 134                 dist::DebuggerScripts, dist::Std, dist::Analysis, dist::Src,
 135                 dist::PlainSourceTarball, dist::Cargo, dist::Rls, dist::Extended, dist::HashSign),
 136             Kind::Install => check!(builder, paths, install::Docs, install::Std, install::Cargo,
 137                 install::Rls, install::Analysis, install::Src, install::Rustc),
 138         }
 139     }
 140
 141     pub fn default_doc(&self, paths: Option<&[PathBuf]>) {
 142         let paths = paths.unwrap_or(&[]);
 143         check!(self, paths, doc::UnstableBook, doc::UnstableBookGen, doc::Rustbook, doc::TheBook,
 144             doc::Standalone, doc::Std, doc::Test, doc::Rustc, doc::ErrorIndex,
 145             doc::Nomicon, doc::Reference);
 146     }
 147
 148     pub fn compiler(&'a self, stage: u32, host: &'a str) -> Compiler<'a> {
 149         self.ensure(compile::Assemble { target_compiler: Compiler { stage, host } })
 150     }
 151
 152     pub fn sysroot(&self, compiler: Compiler<'a>) -> PathBuf {
 153         self.ensure(compile::Sysroot { compiler })
 154     }
 155
 156     /// Returns the libdir where the standard library and other artifacts are
 157     /// found for a compiler's sysroot.
 158     pub fn sysroot_libdir(&self, compiler: Compiler<'a>, target: &'a str) -> PathBuf {
 159         #[derive(Serialize)]
 160         struct Libdir<'a> {
 161             compiler: Compiler<'a>,
 162             target: &'a str,
 163         }
 164         impl<'a> Step<'a> for Libdir<'a> {
 165             type Output = PathBuf;
 166             fn run(self, builder: &Builder) -> PathBuf {
 167                 let sysroot = builder.sysroot(self.compiler)
 168                     .join("lib").join("rustlib").join(self.target).join("lib");
 169                 let _ = fs::remove_dir_all(&sysroot);
 170                 t!(fs::create_dir_all(&sysroot));
 171                 sysroot
 172             }
 173         }
 174         self.ensure(Libdir { compiler, target })
 175     }
 176
 177     /// Returns the compiler's libdir where it stores the dynamic libraries that
 178     /// it itself links against.
 179     ///
 180     /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
 181     /// Windows.
 182     pub fn rustc_libdir(&self, compiler: Compiler) -> PathBuf {
 183         if compiler.is_snapshot(self) {
 184             self.build.rustc_snapshot_libdir()
 185         } else {
 186             self.sysroot(compiler).join(libdir(compiler.host))
 187         }
 188     }
 189
 190     /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
 191     /// library lookup path.
 192     pub fn add_rustc_lib_path(&self, compiler: Compiler, cmd: &mut Command) {
 193         // Windows doesn't need dylib path munging because the dlls for the
 194         // compiler live next to the compiler and the system will find them
 195         // automatically.
 196         if cfg!(windows) {
 197             return
 198         }
 199
 200         add_lib_path(vec![self.rustc_libdir(compiler)], cmd);
 201     }
 202
 203     /// Get a path to the compiler specified.
 204     pub fn rustc(&self, compiler: Compiler) -> PathBuf {
 205         if compiler.is_snapshot(self) {
 206             self.initial_rustc.clone()
 207         } else {
 208             self.sysroot(compiler).join("bin").join(exe("rustc", compiler.host))
 209         }
 210     }
 211
 212     /// Get the `rustdoc` executable next to the specified compiler
 213     pub fn rustdoc(&self, compiler: Compiler) -> PathBuf {
 214         let mut rustdoc = self.rustc(compiler);
 215         rustdoc.pop();
 216         rustdoc.push(exe("rustdoc", compiler.host));
 217         rustdoc
 218     }
 219
 220     /// Prepares an invocation of `cargo` to be run.
 221     ///
 222     /// This will create a `Command` that represents a pending execution of
 223     /// Cargo. This cargo will be configured to use `compiler` as the actual
 224     /// rustc compiler, its output will be scoped by `mode`'s output directory,
 225     /// it will pass the `--target` flag for the specified `target`, and will be
 226     /// executing the Cargo command `cmd`.
 227     pub fn cargo(&self,
 228              compiler: Compiler,
 229              mode: Mode,
 230              target: &str,
 231              cmd: &str) -> Command {
 232         let mut cargo = Command::new(&self.initial_cargo);
 233         let out_dir = self.stage_out(compiler, mode);
 234         cargo.env("CARGO_TARGET_DIR", out_dir)
 235              .arg(cmd)
 236              .arg("-j").arg(self.jobs().to_string())
 237              .arg("--target").arg(target);
 238
 239         // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
 240         // Force cargo to output binaries with disambiguating hashes in the name
 241         cargo.env("__CARGO_DEFAULT_LIB_METADATA", &self.config.channel);
 242
 243         let stage;
 244         if compiler.stage == 0 && self.local_rebuild {
 245             // Assume the local-rebuild rustc already has stage1 features.
 246             stage = 1;
 247         } else {
 248             stage = compiler.stage;
 249         }
 250
 251         // Customize the compiler we're running. Specify the compiler to cargo
 252         // as our shim and then pass it some various options used to configure
 253         // how the actual compiler itself is called.
 254         //
 255         // These variables are primarily all read by
 256         // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
 257         cargo.env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
 258              .env("RUSTC", self.out.join("bootstrap/debug/rustc"))
 259              .env("RUSTC_REAL", self.rustc(compiler))
 260              .env("RUSTC_STAGE", stage.to_string())
 261              .env("RUSTC_CODEGEN_UNITS",
 262                   self.config.rust_codegen_units.to_string())
 263              .env("RUSTC_DEBUG_ASSERTIONS",
 264                   self.config.rust_debug_assertions.to_string())
 265              .env("RUSTC_SYSROOT", self.sysroot(compiler))
 266              .env("RUSTC_LIBDIR", self.rustc_libdir(compiler))
 267              .env("RUSTC_RPATH", self.config.rust_rpath.to_string())
 268              .env("RUSTDOC", self.out.join("bootstrap/debug/rustdoc"))
 269              .env("RUSTDOC_REAL", self.rustdoc(compiler))
 270              .env("RUSTC_FLAGS", self.rustc_flags(target).join(" "));
 271
 272         if mode != Mode::Tool {
 273             // Tools don't get debuginfo right now, e.g. cargo and rls don't
 274             // get compiled with debuginfo.
 275             cargo.env("RUSTC_DEBUGINFO", self.config.rust_debuginfo.to_string())
 276                  .env("RUSTC_DEBUGINFO_LINES", self.config.rust_debuginfo_lines.to_string())
 277                  .env("RUSTC_FORCE_UNSTABLE", "1");
 278
 279             // Currently the compiler depends on crates from crates.io, and
 280             // then other crates can depend on the compiler (e.g. proc-macro
 281             // crates). Let's say, for example that rustc itself depends on the
 282             // bitflags crate. If an external crate then depends on the
 283             // bitflags crate as well, we need to make sure they don't
 284             // conflict, even if they pick the same verison of bitflags. We'll
 285             // want to make sure that e.g. a plugin and rustc each get their
 286             // own copy of bitflags.
 287
 288             // Cargo ensures that this works in general through the -C metadata
 289             // flag. This flag will frob the symbols in the binary to make sure
 290             // they're different, even though the source code is the exact
 291             // same. To solve this problem for the compiler we extend Cargo's
 292             // already-passed -C metadata flag with our own. Our rustc.rs
 293             // wrapper around the actual rustc will detect -C metadata being
 294             // passed and frob it with this extra string we're passing in.
 295             cargo.env("RUSTC_METADATA_SUFFIX", "rustc");
 296         }
 297
 298         // Enable usage of unstable features
 299         cargo.env("RUSTC_BOOTSTRAP", "1");
 300         self.add_rust_test_threads(&mut cargo);
 301
 302         // Almost all of the crates that we compile as part of the bootstrap may
 303         // have a build script, including the standard library. To compile a
 304         // build script, however, it itself needs a standard library! This
 305         // introduces a bit of a pickle when we're compiling the standard
 306         // library itself.
 307         //
 308         // To work around this we actually end up using the snapshot compiler
 309         // (stage0) for compiling build scripts of the standard library itself.
 310         // The stage0 compiler is guaranteed to have a libstd available for use.
 311         //
 312         // For other crates, however, we know that we've already got a standard
 313         // library up and running, so we can use the normal compiler to compile
 314         // build scripts in that situation.
 315         if mode == Mode::Libstd {
 316             cargo.env("RUSTC_SNAPSHOT", &self.initial_rustc)
 317                  .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
 318         } else {
 319             cargo.env("RUSTC_SNAPSHOT", self.rustc(compiler))
 320                  .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
 321         }
 322
 323         // Ignore incremental modes except for stage0, since we're
 324         // not guaranteeing correctness across builds if the compiler
 325         // is changing under your feet.`
 326         if self.flags.incremental && compiler.stage == 0 {
 327             let incr_dir = self.incremental_dir(compiler);
 328             cargo.env("RUSTC_INCREMENTAL", incr_dir);
 329         }
 330
 331         if let Some(ref on_fail) = self.flags.on_fail {
 332             cargo.env("RUSTC_ON_FAIL", on_fail);
 333         }
 334
 335         cargo.env("RUSTC_VERBOSE", format!("{}", self.verbosity));
 336
 337         // Specify some various options for build scripts used throughout
 338         // the build.
 339         //
 340         // FIXME: the guard against msvc shouldn't need to be here
 341         if !target.contains("msvc") {
 342             cargo.env(format!("CC_{}", target), self.cc(target))
 343                  .env(format!("AR_{}", target), self.ar(target).unwrap()) // only msvc is None
 344                  .env(format!("CFLAGS_{}", target), self.cflags(target).join(" "));
 345
 346             if let Ok(cxx) = self.cxx(target) {
 347                  cargo.env(format!("CXX_{}", target), cxx);
 348             }
 349         }
 350
 351         if mode == Mode::Libstd && self.config.extended && compiler.is_final_stage(self) {
 352             cargo.env("RUSTC_SAVE_ANALYSIS", "api".to_string());
 353         }
 354
 355         // When being built Cargo will at some point call `nmake.exe` on Windows
 356         // MSVC. Unfortunately `nmake` will read these two environment variables
 357         // below and try to intepret them. We're likely being run, however, from
 358         // MSYS `make` which uses the same variables.
 359         //
 360         // As a result, to prevent confusion and errors, we remove these
 361         // variables from our environment to prevent passing MSYS make flags to
 362         // nmake, causing it to blow up.
 363         if cfg!(target_env = "msvc") {
 364             cargo.env_remove("MAKE");
 365             cargo.env_remove("MAKEFLAGS");
 366         }
 367
 368         // Environment variables *required* throughout the build
 369         //
 370         // FIXME: should update code to not require this env var
 371         cargo.env("CFG_COMPILER_HOST_TRIPLE", target);
 372
 373         if self.is_verbose() {
 374             cargo.arg("-v");
 375         }
 376         // FIXME: cargo bench does not accept `--release`
 377         if self.config.rust_optimize && cmd != "bench" {
 378             cargo.arg("--release");
 379         }
 380         if self.config.locked_deps {
 381             cargo.arg("--locked");
 382         }
 383         if self.config.vendor || self.is_sudo {
 384             cargo.arg("--frozen");
 385         }
 386
 387         self.ci_env.force_coloring_in_ci(&mut cargo);
 388
 389         cargo
 390     }
 391
 392     fn maybe_run<S: Step<'a>>(&'a self, path: Option<&Path>) {
 393         let build = self.build;
 394         let hosts = if S::ONLY_BUILD_TARGETS || S::ONLY_BUILD {
 395             &build.config.host[..1]
 396         } else {
 397             &build.hosts
 398         };
 399
 400         // Determine the actual targets participating in this rule.
 401         // NOTE: We should keep the full projection from build triple to
 402         // the hosts for the dist steps, now that the hosts array above is
 403         // truncated to avoid duplication of work in that case. Therefore
 404         // the original non-shadowed hosts array is used below.
 405         let targets = if S::ONLY_HOSTS {
 406             // If --target was specified but --host wasn't specified,
 407             // don't run any host-only tests. Also, respect any `--host`
 408             // overrides as done for `hosts`.
 409             if build.flags.host.len() > 0 {
 410                 &build.flags.host[..]
 411             } else if build.flags.target.len() > 0 {
 412                 &[]
 413             } else if S::ONLY_BUILD {
 414                 &build.config.host[..1]
 415             } else {
 416                 &build.config.host[..]
 417             }
 418         } else {
 419             &build.targets
 420         };
 421
 422         for host in hosts {
 423             for target in targets {
 424                 S::make_run(self, path, host, target);
 425             }
 426         }
 427     }
 428
 429     pub fn ensure<S: Step<'a> + Serialize>(&'a self, step: S) -> S::Output
 430     where
 431         S::Output: 'a
 432     {
 433         let key = Cache::to_key(&step);
 434         {
 435             let mut stack = self.stack.borrow_mut();
 436             if stack.contains(&key) {
 437                 let mut out = String::new();
 438                 out += &format!("\n\nCycle in build detected when adding {:?}\n", key);
 439                 for el in stack.iter().rev() {
 440                     out += &format!("\t{:?}\n", el);
 441                 }
 442                 panic!(out);
 443             }
 444             if let Some(out) = self.cache.get::<S::Output>(&key) {
 445                 self.build.verbose(&format!("{}c {:?}", "  ".repeat(stack.len()), key));
 446
 447                 return out;
 448             }
 449             self.build.verbose(&format!("{}> {:?}", "  ".repeat(stack.len()), key));
 450             stack.push(key.clone());
 451         }
 452         let out = step.run(self);
 453         {
 454             let mut stack = self.stack.borrow_mut();
 455             assert_eq!(stack.pop().as_ref(), Some(&key));
 456         }
 457         self.build.verbose(&format!("{}< {:?}", "  ".repeat(self.stack.borrow().len()), key));
 458         self.cache.put(key.clone(), &out);
 459         self.cache.get::<S::Output>(&key).unwrap()
 460     }
 461 }