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