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