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