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