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