src/bootstrap/builder.rs

   1 use std::any::Any;
   2 use std::cell::{Cell, RefCell};
   3 use std::collections::BTreeSet;
   4 use std::env;
   5 use std::ffi::OsStr;
   6 use std::fmt::Debug;
   7 use std::fs;
   8 use std::hash::Hash;
   9 use std::ops::Deref;
  10 use std::path::{Path, PathBuf};
  11 use std::process::Command;
  12 use std::time::{Duration, Instant};
  13
  14 use build_helper::t;
  15
  16 use crate::cache::{Cache, Interned, INTERNER};
  17 use crate::check;
  18 use crate::compile;
  19 use crate::dist;
  20 use crate::doc;
  21 use crate::flags::Subcommand;
  22 use crate::install;
  23 use crate::native;
  24 use crate::test;
  25 use crate::tool;
  26 use crate::util::{self, add_lib_path, exe, libdir};
  27 use crate::{Build, DocTests, GitRepo, Mode};
  28
  29 pub use crate::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<Box<dyn Any>>>,
  37     time_spent_on_dependencies: Cell<Duration>,
  38     pub paths: Vec<PathBuf>,
  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     /// If true, then this rule should be skipped if --target was specified, but --host was not
  57     const ONLY_HOSTS: bool = false;
  58
  59     /// Primary function to execute this rule. Can call `builder.ensure()`
  60     /// with other steps to run those.
  61     fn run(self, builder: &Builder<'_>) -> Self::Output;
  62
  63     /// When bootstrap is passed a set of paths, this controls whether this rule
  64     /// will execute. However, it does not get called in a "default" context
  65     /// when we are not passed any paths; in that case, `make_run` is called
  66     /// directly.
  67     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_>;
  68
  69     /// Builds up a "root" rule, either as a default rule or from a path passed
  70     /// to us.
  71     ///
  72     /// When path is `None`, we are executing in a context where no paths were
  73     /// passed. When `./x.py build` is run, for example, this rule could get
  74     /// called if it is in the correct list below with a path of `None`.
  75     fn make_run(_run: RunConfig<'_>) {
  76         // It is reasonable to not have an implementation of make_run for rules
  77         // who do not want to get called from the root context. This means that
  78         // they are likely dependencies (e.g., sysroot creation) or similar, and
  79         // as such calling them from ./x.py isn't logical.
  80         unimplemented!()
  81     }
  82 }
  83
  84 pub struct RunConfig<'a> {
  85     pub builder: &'a Builder<'a>,
  86     pub host: Interned<String>,
  87     pub target: Interned<String>,
  88     pub path: PathBuf,
  89 }
  90
  91 struct StepDescription {
  92     default: bool,
  93     only_hosts: bool,
  94     should_run: fn(ShouldRun<'_>) -> ShouldRun<'_>,
  95     make_run: fn(RunConfig<'_>),
  96     name: &'static str,
  97 }
  98
  99 #[derive(Debug, Clone, PartialOrd, Ord, PartialEq, Eq)]
 100 pub enum PathSet {
 101     Set(BTreeSet<PathBuf>),
 102     Suite(PathBuf),
 103 }
 104
 105 impl PathSet {
 106     fn empty() -> PathSet {
 107         PathSet::Set(BTreeSet::new())
 108     }
 109
 110     fn one<P: Into<PathBuf>>(path: P) -> PathSet {
 111         let mut set = BTreeSet::new();
 112         set.insert(path.into());
 113         PathSet::Set(set)
 114     }
 115
 116     fn has(&self, needle: &Path) -> bool {
 117         match self {
 118             PathSet::Set(set) => set.iter().any(|p| p.ends_with(needle)),
 119             PathSet::Suite(suite) => suite.ends_with(needle),
 120         }
 121     }
 122
 123     fn path(&self, builder: &Builder<'_>) -> PathBuf {
 124         match self {
 125             PathSet::Set(set) => set.iter().next().unwrap_or(&builder.build.src).to_path_buf(),
 126             PathSet::Suite(path) => PathBuf::from(path),
 127         }
 128     }
 129 }
 130
 131 impl StepDescription {
 132     fn from<S: Step>() -> StepDescription {
 133         StepDescription {
 134             default: S::DEFAULT,
 135             only_hosts: S::ONLY_HOSTS,
 136             should_run: S::should_run,
 137             make_run: S::make_run,
 138             name: std::any::type_name::<S>(),
 139         }
 140     }
 141
 142     fn maybe_run(&self, builder: &Builder<'_>, pathset: &PathSet) {
 143         if builder.config.exclude.iter().any(|e| pathset.has(e)) {
 144             eprintln!("Skipping {:?} because it is excluded", pathset);
 145             return;
 146         } else if !builder.config.exclude.is_empty() {
 147             eprintln!(
 148                 "{:?} not skipped for {:?} -- not in {:?}",
 149                 pathset, self.name, builder.config.exclude
 150             );
 151         }
 152         let hosts = &builder.hosts;
 153
 154         // Determine the targets participating in this rule.
 155         let targets = if self.only_hosts {
 156             if builder.config.skip_only_host_steps {
 157                 return; // don't run anything
 158             } else {
 159                 &builder.hosts
 160             }
 161         } else {
 162             &builder.targets
 163         };
 164
 165         for host in hosts {
 166             for target in targets {
 167                 let run = RunConfig {
 168                     builder,
 169                     path: pathset.path(builder),
 170                     host: *host,
 171                     target: *target,
 172                 };
 173                 (self.make_run)(run);
 174             }
 175         }
 176     }
 177
 178     fn run(v: &[StepDescription], builder: &Builder<'_>, paths: &[PathBuf]) {
 179         let should_runs =
 180             v.iter().map(|desc| (desc.should_run)(ShouldRun::new(builder))).collect::<Vec<_>>();
 181
 182         // sanity checks on rules
 183         for (desc, should_run) in v.iter().zip(&should_runs) {
 184             assert!(
 185                 !should_run.paths.is_empty(),
 186                 "{:?} should have at least one pathset",
 187                 desc.name
 188             );
 189         }
 190
 191         if paths.is_empty() {
 192             for (desc, should_run) in v.iter().zip(should_runs) {
 193                 if desc.default && should_run.is_really_default {
 194                     for pathset in &should_run.paths {
 195                         desc.maybe_run(builder, pathset);
 196                     }
 197                 }
 198             }
 199         } else {
 200             for path in paths {
 201                 // strip CurDir prefix if present
 202                 let path = match path.strip_prefix(".") {
 203                     Ok(p) => p,
 204                     Err(_) => path,
 205                 };
 206
 207                 let mut attempted_run = false;
 208                 for (desc, should_run) in v.iter().zip(&should_runs) {
 209                     if let Some(suite) = should_run.is_suite_path(path) {
 210                         attempted_run = true;
 211                         desc.maybe_run(builder, suite);
 212                     } else if let Some(pathset) = should_run.pathset_for_path(path) {
 213                         attempted_run = true;
 214                         desc.maybe_run(builder, pathset);
 215                     }
 216                 }
 217
 218                 if !attempted_run {
 219                     panic!("Error: no rules matched {}.", path.display());
 220                 }
 221             }
 222         }
 223     }
 224 }
 225
 226 #[derive(Clone)]
 227 pub struct ShouldRun<'a> {
 228     pub builder: &'a Builder<'a>,
 229     // use a BTreeSet to maintain sort order
 230     paths: BTreeSet<PathSet>,
 231
 232     // If this is a default rule, this is an additional constraint placed on
 233     // its run. Generally something like compiler docs being enabled.
 234     is_really_default: bool,
 235 }
 236
 237 impl<'a> ShouldRun<'a> {
 238     fn new(builder: &'a Builder<'_>) -> ShouldRun<'a> {
 239         ShouldRun {
 240             builder,
 241             paths: BTreeSet::new(),
 242             is_really_default: true, // by default no additional conditions
 243         }
 244     }
 245
 246     pub fn default_condition(mut self, cond: bool) -> Self {
 247         self.is_really_default = cond;
 248         self
 249     }
 250
 251     // Unlike `krate` this will create just one pathset. As such, it probably shouldn't actually
 252     // ever be used, but as we transition to having all rules properly handle passing krate(...) by
 253     // actually doing something different for every crate passed.
 254     pub fn all_krates(mut self, name: &str) -> Self {
 255         let mut set = BTreeSet::new();
 256         for krate in self.builder.in_tree_crates(name) {
 257             set.insert(PathBuf::from(&krate.path));
 258         }
 259         self.paths.insert(PathSet::Set(set));
 260         self
 261     }
 262
 263     pub fn krate(mut self, name: &str) -> Self {
 264         for krate in self.builder.in_tree_crates(name) {
 265             self.paths.insert(PathSet::one(&krate.path));
 266         }
 267         self
 268     }
 269
 270     // single, non-aliased path
 271     pub fn path(self, path: &str) -> Self {
 272         self.paths(&[path])
 273     }
 274
 275     // multiple aliases for the same job
 276     pub fn paths(mut self, paths: &[&str]) -> Self {
 277         self.paths.insert(PathSet::Set(paths.iter().map(PathBuf::from).collect()));
 278         self
 279     }
 280
 281     pub fn is_suite_path(&self, path: &Path) -> Option<&PathSet> {
 282         self.paths.iter().find(|pathset| match pathset {
 283             PathSet::Suite(p) => path.starts_with(p),
 284             PathSet::Set(_) => false,
 285         })
 286     }
 287
 288     pub fn suite_path(mut self, suite: &str) -> Self {
 289         self.paths.insert(PathSet::Suite(PathBuf::from(suite)));
 290         self
 291     }
 292
 293     // allows being more explicit about why should_run in Step returns the value passed to it
 294     pub fn never(mut self) -> ShouldRun<'a> {
 295         self.paths.insert(PathSet::empty());
 296         self
 297     }
 298
 299     fn pathset_for_path(&self, path: &Path) -> Option<&PathSet> {
 300         self.paths.iter().find(|pathset| pathset.has(path))
 301     }
 302 }
 303
 304 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
 305 pub enum Kind {
 306     Build,
 307     Check,
 308     Clippy,
 309     Fix,
 310     Format,
 311     Test,
 312     Bench,
 313     Dist,
 314     Doc,
 315     Install,
 316 }
 317
 318 impl<'a> Builder<'a> {
 319     fn get_step_descriptions(kind: Kind) -> Vec<StepDescription> {
 320         macro_rules! describe {
 321             ($($rule:ty),+ $(,)?) => {{
 322                 vec![$(StepDescription::from::<$rule>()),+]
 323             }};
 324         }
 325         match kind {
 326             Kind::Build => describe!(
 327                 compile::Std,
 328                 compile::Rustc,
 329                 compile::StartupObjects,
 330                 tool::BuildManifest,
 331                 tool::Rustbook,
 332                 tool::ErrorIndex,
 333                 tool::UnstableBookGen,
 334                 tool::Tidy,
 335                 tool::Linkchecker,
 336                 tool::CargoTest,
 337                 tool::Compiletest,
 338                 tool::RemoteTestServer,
 339                 tool::RemoteTestClient,
 340                 tool::RustInstaller,
 341                 tool::Cargo,
 342                 tool::Rls,
 343                 tool::Rustdoc,
 344                 tool::Clippy,
 345                 native::Llvm,
 346                 tool::Rustfmt,
 347                 tool::Miri,
 348                 native::Lld
 349             ),
 350             Kind::Check | Kind::Clippy | Kind::Fix | Kind::Format => {
 351                 describe!(check::Std, check::Rustc, check::Rustdoc)
 352             }
 353             Kind::Test => describe!(
 354                 crate::toolstate::ToolStateCheck,
 355                 test::Tidy,
 356                 test::Ui,
 357                 test::CompileFail,
 358                 test::RunFail,
 359                 test::RunPassValgrind,
 360                 test::MirOpt,
 361                 test::Codegen,
 362                 test::CodegenUnits,
 363                 test::Assembly,
 364                 test::Incremental,
 365                 test::Debuginfo,
 366                 test::UiFullDeps,
 367                 test::Rustdoc,
 368                 test::Pretty,
 369                 test::RunFailPretty,
 370                 test::RunPassValgrindPretty,
 371                 test::Crate,
 372                 test::CrateLibrustc,
 373                 test::CrateRustdoc,
 374                 test::Linkcheck,
 375                 test::Cargotest,
 376                 test::Cargo,
 377                 test::Rls,
 378                 test::ErrorIndex,
 379                 test::Distcheck,
 380                 test::RunMakeFullDeps,
 381                 test::Nomicon,
 382                 test::Reference,
 383                 test::RustdocBook,
 384                 test::RustByExample,
 385                 test::TheBook,
 386                 test::UnstableBook,
 387                 test::RustcBook,
 388                 test::RustcGuide,
 389                 test::EmbeddedBook,
 390                 test::EditionGuide,
 391                 test::Rustfmt,
 392                 test::Miri,
 393                 test::Clippy,
 394                 test::CompiletestTest,
 395                 test::RustdocJSStd,
 396                 test::RustdocJSNotStd,
 397                 test::RustdocTheme,
 398                 test::RustdocUi,
 399                 // Run bootstrap close to the end as it's unlikely to fail
 400                 test::Bootstrap,
 401                 // Run run-make last, since these won't pass without make on Windows
 402                 test::RunMake,
 403             ),
 404             Kind::Bench => describe!(test::Crate, test::CrateLibrustc),
 405             Kind::Doc => describe!(
 406                 doc::UnstableBook,
 407                 doc::UnstableBookGen,
 408                 doc::TheBook,
 409                 doc::Standalone,
 410                 doc::Std,
 411                 doc::Rustc,
 412                 doc::Rustdoc,
 413                 doc::ErrorIndex,
 414                 doc::Nomicon,
 415                 doc::Reference,
 416                 doc::RustdocBook,
 417                 doc::RustByExample,
 418                 doc::RustcBook,
 419                 doc::CargoBook,
 420                 doc::EmbeddedBook,
 421                 doc::EditionGuide,
 422             ),
 423             Kind::Dist => describe!(
 424                 dist::Docs,
 425                 dist::RustcDocs,
 426                 dist::Mingw,
 427                 dist::Rustc,
 428                 dist::DebuggerScripts,
 429                 dist::Std,
 430                 dist::RustcDev,
 431                 dist::Analysis,
 432                 dist::Src,
 433                 dist::PlainSourceTarball,
 434                 dist::Cargo,
 435                 dist::Rls,
 436                 dist::Rustfmt,
 437                 dist::Clippy,
 438                 dist::Miri,
 439                 dist::LlvmTools,
 440                 dist::Lldb,
 441                 dist::Extended,
 442                 dist::HashSign
 443             ),
 444             Kind::Install => describe!(
 445                 install::Docs,
 446                 install::Std,
 447                 install::Cargo,
 448                 install::Rls,
 449                 install::Rustfmt,
 450                 install::Clippy,
 451                 install::Miri,
 452                 install::Analysis,
 453                 install::Src,
 454                 install::Rustc
 455             ),
 456         }
 457     }
 458
 459     pub fn get_help(build: &Build, subcommand: &str) -> Option<String> {
 460         let kind = match subcommand {
 461             "build" => Kind::Build,
 462             "doc" => Kind::Doc,
 463             "test" => Kind::Test,
 464             "bench" => Kind::Bench,
 465             "dist" => Kind::Dist,
 466             "install" => Kind::Install,
 467             _ => return None,
 468         };
 469
 470         let builder = Builder {
 471             build,
 472             top_stage: build.config.stage.unwrap_or(2),
 473             kind,
 474             cache: Cache::new(),
 475             stack: RefCell::new(Vec::new()),
 476             time_spent_on_dependencies: Cell::new(Duration::new(0, 0)),
 477             paths: vec![],
 478         };
 479
 480         let builder = &builder;
 481         let mut should_run = ShouldRun::new(builder);
 482         for desc in Builder::get_step_descriptions(builder.kind) {
 483             should_run = (desc.should_run)(should_run);
 484         }
 485         let mut help = String::from("Available paths:\n");
 486         for pathset in should_run.paths {
 487             if let PathSet::Set(set) = pathset {
 488                 set.iter().for_each(|path| {
 489                     help.push_str(
 490                         format!("    ./x.py {} {}\n", subcommand, path.display()).as_str(),
 491                     )
 492                 })
 493             }
 494         }
 495         Some(help)
 496     }
 497
 498     pub fn new(build: &Build) -> Builder<'_> {
 499         let (kind, paths) = match build.config.cmd {
 500             Subcommand::Build { ref paths } => (Kind::Build, &paths[..]),
 501             Subcommand::Check { ref paths } => (Kind::Check, &paths[..]),
 502             Subcommand::Clippy { ref paths } => (Kind::Clippy, &paths[..]),
 503             Subcommand::Fix { ref paths } => (Kind::Fix, &paths[..]),
 504             Subcommand::Doc { ref paths } => (Kind::Doc, &paths[..]),
 505             Subcommand::Test { ref paths, .. } => (Kind::Test, &paths[..]),
 506             Subcommand::Bench { ref paths, .. } => (Kind::Bench, &paths[..]),
 507             Subcommand::Dist { ref paths } => (Kind::Dist, &paths[..]),
 508             Subcommand::Install { ref paths } => (Kind::Install, &paths[..]),
 509             Subcommand::Format { .. } | Subcommand::Clean { .. } => panic!(),
 510         };
 511
 512         let builder = Builder {
 513             build,
 514             top_stage: build.config.stage.unwrap_or(2),
 515             kind,
 516             cache: Cache::new(),
 517             stack: RefCell::new(Vec::new()),
 518             time_spent_on_dependencies: Cell::new(Duration::new(0, 0)),
 519             paths: paths.to_owned(),
 520         };
 521
 522         builder
 523     }
 524
 525     pub fn execute_cli(&self) {
 526         self.run_step_descriptions(&Builder::get_step_descriptions(self.kind), &self.paths);
 527     }
 528
 529     pub fn default_doc(&self, paths: Option<&[PathBuf]>) {
 530         let paths = paths.unwrap_or(&[]);
 531         self.run_step_descriptions(&Builder::get_step_descriptions(Kind::Doc), paths);
 532     }
 533
 534     fn run_step_descriptions(&self, v: &[StepDescription], paths: &[PathBuf]) {
 535         StepDescription::run(v, self, paths);
 536     }
 537
 538     /// Obtain a compiler at a given stage and for a given host. Explicitly does
 539     /// not take `Compiler` since all `Compiler` instances are meant to be
 540     /// obtained through this function, since it ensures that they are valid
 541     /// (i.e., built and assembled).
 542     pub fn compiler(&self, stage: u32, host: Interned<String>) -> Compiler {
 543         self.ensure(compile::Assemble { target_compiler: Compiler { stage, host } })
 544     }
 545
 546     /// Similar to `compiler`, except handles the full-bootstrap option to
 547     /// silently use the stage1 compiler instead of a stage2 compiler if one is
 548     /// requested.
 549     ///
 550     /// Note that this does *not* have the side effect of creating
 551     /// `compiler(stage, host)`, unlike `compiler` above which does have such
 552     /// a side effect. The returned compiler here can only be used to compile
 553     /// new artifacts, it can't be used to rely on the presence of a particular
 554     /// sysroot.
 555     ///
 556     /// See `force_use_stage1` for documentation on what each argument is.
 557     pub fn compiler_for(
 558         &self,
 559         stage: u32,
 560         host: Interned<String>,
 561         target: Interned<String>,
 562     ) -> Compiler {
 563         if self.build.force_use_stage1(Compiler { stage, host }, target) {
 564             self.compiler(1, self.config.build)
 565         } else {
 566             self.compiler(stage, host)
 567         }
 568     }
 569
 570     pub fn sysroot(&self, compiler: Compiler) -> Interned<PathBuf> {
 571         self.ensure(compile::Sysroot { compiler })
 572     }
 573
 574     /// Returns the libdir where the standard library and other artifacts are
 575     /// found for a compiler's sysroot.
 576     pub fn sysroot_libdir(
 577         &self,
 578         compiler: Compiler,
 579         target: Interned<String>,
 580     ) -> Interned<PathBuf> {
 581         #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 582         struct Libdir {
 583             compiler: Compiler,
 584             target: Interned<String>,
 585         }
 586         impl Step for Libdir {
 587             type Output = Interned<PathBuf>;
 588
 589             fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 590                 run.never()
 591             }
 592
 593             fn run(self, builder: &Builder<'_>) -> Interned<PathBuf> {
 594                 let lib = builder.sysroot_libdir_relative(self.compiler);
 595                 let sysroot = builder
 596                     .sysroot(self.compiler)
 597                     .join(lib)
 598                     .join("rustlib")
 599                     .join(self.target)
 600                     .join("lib");
 601                 let _ = fs::remove_dir_all(&sysroot);
 602                 t!(fs::create_dir_all(&sysroot));
 603                 INTERNER.intern_path(sysroot)
 604             }
 605         }
 606         self.ensure(Libdir { compiler, target })
 607     }
 608
 609     /// Returns the compiler's libdir where it stores the dynamic libraries that
 610     /// it itself links against.
 611     ///
 612     /// For example this returns `<sysroot>/lib` on Unix and `<sysroot>/bin` on
 613     /// Windows.
 614     pub fn rustc_libdir(&self, compiler: Compiler) -> PathBuf {
 615         if compiler.is_snapshot(self) {
 616             self.rustc_snapshot_libdir()
 617         } else {
 618             match self.config.libdir_relative() {
 619                 Some(relative_libdir) if compiler.stage >= 1 => {
 620                     self.sysroot(compiler).join(relative_libdir)
 621                 }
 622                 _ => self.sysroot(compiler).join(libdir(&compiler.host)),
 623             }
 624         }
 625     }
 626
 627     /// Returns the compiler's relative libdir where it stores the dynamic libraries that
 628     /// it itself links against.
 629     ///
 630     /// For example this returns `lib` on Unix and `bin` on
 631     /// Windows.
 632     pub fn libdir_relative(&self, compiler: Compiler) -> &Path {
 633         if compiler.is_snapshot(self) {
 634             libdir(&self.config.build).as_ref()
 635         } else {
 636             match self.config.libdir_relative() {
 637                 Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
 638                 _ => libdir(&compiler.host).as_ref(),
 639             }
 640         }
 641     }
 642
 643     /// Returns the compiler's relative libdir where the standard library and other artifacts are
 644     /// found for a compiler's sysroot.
 645     ///
 646     /// For example this returns `lib` on Unix and Windows.
 647     pub fn sysroot_libdir_relative(&self, compiler: Compiler) -> &Path {
 648         match self.config.libdir_relative() {
 649             Some(relative_libdir) if compiler.stage >= 1 => relative_libdir,
 650             _ => Path::new("lib"),
 651         }
 652     }
 653
 654     /// Adds the compiler's directory of dynamic libraries to `cmd`'s dynamic
 655     /// library lookup path.
 656     pub fn add_rustc_lib_path(&self, compiler: Compiler, cmd: &mut Cargo) {
 657         // Windows doesn't need dylib path munging because the dlls for the
 658         // compiler live next to the compiler and the system will find them
 659         // automatically.
 660         if cfg!(windows) {
 661             return;
 662         }
 663
 664         add_lib_path(vec![self.rustc_libdir(compiler)], &mut cmd.command);
 665     }
 666
 667     /// Gets a path to the compiler specified.
 668     pub fn rustc(&self, compiler: Compiler) -> PathBuf {
 669         if compiler.is_snapshot(self) {
 670             self.initial_rustc.clone()
 671         } else {
 672             self.sysroot(compiler).join("bin").join(exe("rustc", &compiler.host))
 673         }
 674     }
 675
 676     pub fn rustdoc(&self, compiler: Compiler) -> PathBuf {
 677         self.ensure(tool::Rustdoc { compiler })
 678     }
 679
 680     pub fn rustdoc_cmd(&self, compiler: Compiler) -> Command {
 681         let mut cmd = Command::new(&self.out.join("bootstrap/debug/rustdoc"));
 682         cmd.env("RUSTC_STAGE", compiler.stage.to_string())
 683             .env("RUSTC_SYSROOT", self.sysroot(compiler))
 684             // Note that this is *not* the sysroot_libdir because rustdoc must be linked
 685             // equivalently to rustc.
 686             .env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler))
 687             .env("CFG_RELEASE_CHANNEL", &self.config.channel)
 688             .env("RUSTDOC_REAL", self.rustdoc(compiler))
 689             .env("RUSTDOC_CRATE_VERSION", self.rust_version())
 690             .env("RUSTC_BOOTSTRAP", "1");
 691
 692         // Remove make-related flags that can cause jobserver problems.
 693         cmd.env_remove("MAKEFLAGS");
 694         cmd.env_remove("MFLAGS");
 695
 696         if let Some(linker) = self.linker(compiler.host) {
 697             cmd.env("RUSTC_TARGET_LINKER", linker);
 698         }
 699         cmd
 700     }
 701
 702     /// Prepares an invocation of `cargo` to be run.
 703     ///
 704     /// This will create a `Command` that represents a pending execution of
 705     /// Cargo. This cargo will be configured to use `compiler` as the actual
 706     /// rustc compiler, its output will be scoped by `mode`'s output directory,
 707     /// it will pass the `--target` flag for the specified `target`, and will be
 708     /// executing the Cargo command `cmd`.
 709     pub fn cargo(
 710         &self,
 711         compiler: Compiler,
 712         mode: Mode,
 713         target: Interned<String>,
 714         cmd: &str,
 715     ) -> Cargo {
 716         let mut cargo = Command::new(&self.initial_cargo);
 717         let out_dir = self.stage_out(compiler, mode);
 718
 719         if cmd == "doc" || cmd == "rustdoc" {
 720             let my_out = match mode {
 721                 // This is the intended out directory for compiler documentation.
 722                 Mode::Rustc | Mode::ToolRustc | Mode::Codegen => self.compiler_doc_out(target),
 723                 _ => self.crate_doc_out(target),
 724             };
 725             let rustdoc = self.rustdoc(compiler);
 726             self.clear_if_dirty(&my_out, &rustdoc);
 727         }
 728
 729         cargo.env("CARGO_TARGET_DIR", out_dir).arg(cmd).arg("-Zconfig-profile");
 730
 731         let profile_var = |name: &str| {
 732             let profile = if self.config.rust_optimize { "RELEASE" } else { "DEV" };
 733             format!("CARGO_PROFILE_{}_{}", profile, name)
 734         };
 735
 736         // See comment in librustc_llvm/build.rs for why this is necessary, largely llvm-config
 737         // needs to not accidentally link to libLLVM in stage0/lib.
 738         cargo.env("REAL_LIBRARY_PATH_VAR", &util::dylib_path_var());
 739         if let Some(e) = env::var_os(util::dylib_path_var()) {
 740             cargo.env("REAL_LIBRARY_PATH", e);
 741         }
 742
 743         if cmd != "install" {
 744             cargo.arg("--target").arg(target);
 745         } else {
 746             assert_eq!(target, compiler.host);
 747         }
 748
 749         // Set a flag for `check`/`clippy`/`fix`, so that certain build
 750         // scripts can do less work (e.g. not building/requiring LLVM).
 751         if cmd == "check" || cmd == "clippy" || cmd == "fix" {
 752             cargo.env("RUST_CHECK", "1");
 753         }
 754
 755         let stage;
 756         if compiler.stage == 0 && self.local_rebuild {
 757             // Assume the local-rebuild rustc already has stage1 features.
 758             stage = 1;
 759         } else {
 760             stage = compiler.stage;
 761         }
 762
 763         let mut rustflags = Rustflags::new(&target);
 764         if stage != 0 {
 765             if let Ok(s) = env::var("CARGOFLAGS_NOT_BOOTSTRAP") {
 766                 cargo.args(s.split_whitespace());
 767             }
 768             rustflags.env("RUSTFLAGS_NOT_BOOTSTRAP");
 769         } else {
 770             if let Ok(s) = env::var("CARGOFLAGS_BOOTSTRAP") {
 771                 cargo.args(s.split_whitespace());
 772             }
 773             rustflags.env("RUSTFLAGS_BOOTSTRAP");
 774             rustflags.arg("--cfg=bootstrap");
 775         }
 776
 777         if let Ok(s) = env::var("CARGOFLAGS") {
 778             cargo.args(s.split_whitespace());
 779         }
 780
 781         match mode {
 782             Mode::Std | Mode::ToolBootstrap | Mode::ToolStd => {}
 783             Mode::Rustc | Mode::Codegen | Mode::ToolRustc => {
 784                 // Build proc macros both for the host and the target
 785                 if target != compiler.host && cmd != "check" {
 786                     cargo.arg("-Zdual-proc-macros");
 787                     rustflags.arg("-Zdual-proc-macros");
 788                 }
 789             }
 790         }
 791
 792         // This tells Cargo (and in turn, rustc) to output more complete
 793         // dependency information.  Most importantly for rustbuild, this
 794         // includes sysroot artifacts, like libstd, which means that we don't
 795         // need to track those in rustbuild (an error prone process!). This
 796         // feature is currently unstable as there may be some bugs and such, but
 797         // it represents a big improvement in rustbuild's reliability on
 798         // rebuilds, so we're using it here.
 799         //
 800         // For some additional context, see #63470 (the PR originally adding
 801         // this), as well as #63012 which is the tracking issue for this
 802         // feature on the rustc side.
 803         cargo.arg("-Zbinary-dep-depinfo");
 804
 805         cargo.arg("-j").arg(self.jobs().to_string());
 806         // Remove make-related flags to ensure Cargo can correctly set things up
 807         cargo.env_remove("MAKEFLAGS");
 808         cargo.env_remove("MFLAGS");
 809
 810         // FIXME: Temporary fix for https://github.com/rust-lang/cargo/issues/3005
 811         // Force cargo to output binaries with disambiguating hashes in the name
 812         let mut metadata = if compiler.stage == 0 {
 813             // Treat stage0 like a special channel, whether it's a normal prior-
 814             // release rustc or a local rebuild with the same version, so we
 815             // never mix these libraries by accident.
 816             "bootstrap".to_string()
 817         } else {
 818             self.config.channel.to_string()
 819         };
 820         // We want to make sure that none of the dependencies between
 821         // std/test/rustc unify with one another. This is done for weird linkage
 822         // reasons but the gist of the problem is that if librustc, libtest, and
 823         // libstd all depend on libc from crates.io (which they actually do) we
 824         // want to make sure they all get distinct versions. Things get really
 825         // weird if we try to unify all these dependencies right now, namely
 826         // around how many times the library is linked in dynamic libraries and
 827         // such. If rustc were a static executable or if we didn't ship dylibs
 828         // this wouldn't be a problem, but we do, so it is. This is in general
 829         // just here to make sure things build right. If you can remove this and
 830         // things still build right, please do!
 831         match mode {
 832             Mode::Std => metadata.push_str("std"),
 833             // When we're building rustc tools, they're built with a search path
 834             // that contains things built during the rustc build. For example,
 835             // bitflags is built during the rustc build, and is a dependency of
 836             // rustdoc as well. We're building rustdoc in a different target
 837             // directory, though, which means that Cargo will rebuild the
 838             // dependency. When we go on to build rustdoc, we'll look for
 839             // bitflags, and find two different copies: one built during the
 840             // rustc step and one that we just built. This isn't always a
 841             // problem, somehow -- not really clear why -- but we know that this
 842             // fixes things.
 843             Mode::ToolRustc => metadata.push_str("tool-rustc"),
 844             _ => {}
 845         }
 846         cargo.env("__CARGO_DEFAULT_LIB_METADATA", &metadata);
 847
 848         if cmd == "clippy" {
 849             rustflags.arg("-Zforce-unstable-if-unmarked");
 850         }
 851
 852         rustflags.arg("-Zexternal-macro-backtrace");
 853
 854         let want_rustdoc = self.doc_tests != DocTests::No;
 855
 856         // We synthetically interpret a stage0 compiler used to build tools as a
 857         // "raw" compiler in that it's the exact snapshot we download. Normally
 858         // the stage0 build means it uses libraries build by the stage0
 859         // compiler, but for tools we just use the precompiled libraries that
 860         // we've downloaded
 861         let use_snapshot = mode == Mode::ToolBootstrap;
 862         assert!(!use_snapshot || stage == 0 || self.local_rebuild);
 863
 864         let maybe_sysroot = self.sysroot(compiler);
 865         let sysroot = if use_snapshot { self.rustc_snapshot_sysroot() } else { &maybe_sysroot };
 866         let libdir = self.rustc_libdir(compiler);
 867
 868         // Customize the compiler we're running. Specify the compiler to cargo
 869         // as our shim and then pass it some various options used to configure
 870         // how the actual compiler itself is called.
 871         //
 872         // These variables are primarily all read by
 873         // src/bootstrap/bin/{rustc.rs,rustdoc.rs}
 874         cargo
 875             .env("RUSTBUILD_NATIVE_DIR", self.native_dir(target))
 876             .env("RUSTC", self.out.join("bootstrap/debug/rustc"))
 877             .env("RUSTC_REAL", self.rustc(compiler))
 878             .env("RUSTC_STAGE", stage.to_string())
 879             .env("RUSTC_DEBUG_ASSERTIONS", self.config.rust_debug_assertions.to_string())
 880             .env("RUSTC_SYSROOT", &sysroot)
 881             .env("RUSTC_LIBDIR", &libdir)
 882             .env("RUSTDOC", self.out.join("bootstrap/debug/rustdoc"))
 883             .env(
 884                 "RUSTDOC_REAL",
 885                 if cmd == "doc" || cmd == "rustdoc" || (cmd == "test" && want_rustdoc) {
 886                     self.rustdoc(compiler)
 887                 } else {
 888                     PathBuf::from("/path/to/nowhere/rustdoc/not/required")
 889                 },
 890             )
 891             .env("RUSTC_ERROR_METADATA_DST", self.extended_error_dir())
 892             .env("RUSTC_BREAK_ON_ICE", "1");
 893
 894         // Dealing with rpath here is a little special, so let's go into some
 895         // detail. First off, `-rpath` is a linker option on Unix platforms
 896         // which adds to the runtime dynamic loader path when looking for
 897         // dynamic libraries. We use this by default on Unix platforms to ensure
 898         // that our nightlies behave the same on Windows, that is they work out
 899         // of the box. This can be disabled, of course, but basically that's why
 900         // we're gated on RUSTC_RPATH here.
 901         //
 902         // Ok, so the astute might be wondering "why isn't `-C rpath` used
 903         // here?" and that is indeed a good question to task. This codegen
 904         // option is the compiler's current interface to generating an rpath.
 905         // Unfortunately it doesn't quite suffice for us. The flag currently
 906         // takes no value as an argument, so the compiler calculates what it
 907         // should pass to the linker as `-rpath`. This unfortunately is based on
 908         // the **compile time** directory structure which when building with
 909         // Cargo will be very different than the runtime directory structure.
 910         //
 911         // All that's a really long winded way of saying that if we use
 912         // `-Crpath` then the executables generated have the wrong rpath of
 913         // something like `$ORIGIN/deps` when in fact the way we distribute
 914         // rustc requires the rpath to be `$ORIGIN/../lib`.
 915         //
 916         // So, all in all, to set up the correct rpath we pass the linker
 917         // argument manually via `-C link-args=-Wl,-rpath,...`. Plus isn't it
 918         // fun to pass a flag to a tool to pass a flag to pass a flag to a tool
 919         // to change a flag in a binary?
 920         if self.config.rust_rpath && util::use_host_linker(&target) {
 921             let rpath = if target.contains("apple") {
 922                 // Note that we need to take one extra step on macOS to also pass
 923                 // `-Wl,-instal_name,@rpath/...` to get things to work right. To
 924                 // do that we pass a weird flag to the compiler to get it to do
 925                 // so. Note that this is definitely a hack, and we should likely
 926                 // flesh out rpath support more fully in the future.
 927                 rustflags.arg("-Zosx-rpath-install-name");
 928                 Some("-Wl,-rpath,@loader_path/../lib")
 929             } else if !target.contains("windows") {
 930                 Some("-Wl,-rpath,$ORIGIN/../lib")
 931             } else {
 932                 None
 933             };
 934             if let Some(rpath) = rpath {
 935                 rustflags.arg(&format!("-Clink-args={}", rpath));
 936             }
 937         }
 938
 939         if let Some(host_linker) = self.linker(compiler.host) {
 940             cargo.env("RUSTC_HOST_LINKER", host_linker);
 941         }
 942         if let Some(target_linker) = self.linker(target) {
 943             let target = crate::envify(&target);
 944             cargo.env(&format!("CARGO_TARGET_{}_LINKER", target), target_linker);
 945         }
 946         if !(["build", "check", "clippy", "fix", "rustc"].contains(&cmd)) && want_rustdoc {
 947             cargo.env("RUSTDOC_LIBDIR", self.rustc_libdir(compiler));
 948         }
 949
 950         let debuginfo_level = match mode {
 951             Mode::Rustc | Mode::Codegen => self.config.rust_debuginfo_level_rustc,
 952             Mode::Std => self.config.rust_debuginfo_level_std,
 953             Mode::ToolBootstrap | Mode::ToolStd | Mode::ToolRustc => {
 954                 self.config.rust_debuginfo_level_tools
 955             }
 956         };
 957         cargo.env(profile_var("DEBUG"), debuginfo_level.to_string());
 958
 959         if !mode.is_tool() {
 960             cargo.env("RUSTC_FORCE_UNSTABLE", "1");
 961         }
 962
 963         if let Some(x) = self.crt_static(target) {
 964             if x {
 965                 rustflags.arg("-Ctarget-feature=+crt-static");
 966             } else {
 967                 rustflags.arg("-Ctarget-feature=-crt-static");
 968             }
 969         }
 970
 971         if let Some(x) = self.crt_static(compiler.host) {
 972             cargo.env("RUSTC_HOST_CRT_STATIC", x.to_string());
 973         }
 974
 975         if let Some(map) = self.build.debuginfo_map(GitRepo::Rustc) {
 976             cargo.env("RUSTC_DEBUGINFO_MAP", map);
 977         }
 978
 979         // Enable usage of unstable features
 980         cargo.env("RUSTC_BOOTSTRAP", "1");
 981         self.add_rust_test_threads(&mut cargo);
 982
 983         // Almost all of the crates that we compile as part of the bootstrap may
 984         // have a build script, including the standard library. To compile a
 985         // build script, however, it itself needs a standard library! This
 986         // introduces a bit of a pickle when we're compiling the standard
 987         // library itself.
 988         //
 989         // To work around this we actually end up using the snapshot compiler
 990         // (stage0) for compiling build scripts of the standard library itself.
 991         // The stage0 compiler is guaranteed to have a libstd available for use.
 992         //
 993         // For other crates, however, we know that we've already got a standard
 994         // library up and running, so we can use the normal compiler to compile
 995         // build scripts in that situation.
 996         if mode == Mode::Std {
 997             cargo
 998                 .env("RUSTC_SNAPSHOT", &self.initial_rustc)
 999                 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_snapshot_libdir());
1000         } else {
1001             cargo
1002                 .env("RUSTC_SNAPSHOT", self.rustc(compiler))
1003                 .env("RUSTC_SNAPSHOT_LIBDIR", self.rustc_libdir(compiler));
1004         }
1005
1006         if self.config.incremental {
1007             cargo.env("CARGO_INCREMENTAL", "1");
1008         } else {
1009             // Don't rely on any default setting for incr. comp. in Cargo
1010             cargo.env("CARGO_INCREMENTAL", "0");
1011         }
1012
1013         if let Some(ref on_fail) = self.config.on_fail {
1014             cargo.env("RUSTC_ON_FAIL", on_fail);
1015         }
1016
1017         if self.config.print_step_timings {
1018             cargo.env("RUSTC_PRINT_STEP_TIMINGS", "1");
1019         }
1020
1021         if self.config.backtrace_on_ice {
1022             cargo.env("RUSTC_BACKTRACE_ON_ICE", "1");
1023         }
1024
1025         cargo.env("RUSTC_VERBOSE", self.verbosity.to_string());
1026
1027         if !mode.is_tool() {
1028             // When extending this list, add the new lints to the RUSTFLAGS of the
1029             // build_bootstrap function of src/bootstrap/bootstrap.py as well as
1030             // some code doesn't go through this `rustc` wrapper.
1031             rustflags.arg("-Wrust_2018_idioms");
1032             rustflags.arg("-Wunused_lifetimes");
1033
1034             if self.config.deny_warnings {
1035                 rustflags.arg("-Dwarnings");
1036             }
1037         }
1038
1039         if let Mode::Rustc | Mode::Codegen = mode {
1040             rustflags.arg("-Zunstable-options");
1041             rustflags.arg("-Wrustc::internal");
1042         }
1043
1044         // Throughout the build Cargo can execute a number of build scripts
1045         // compiling C/C++ code and we need to pass compilers, archivers, flags, etc
1046         // obtained previously to those build scripts.
1047         // Build scripts use either the `cc` crate or `configure/make` so we pass
1048         // the options through environment variables that are fetched and understood by both.
1049         //
1050         // FIXME: the guard against msvc shouldn't need to be here
1051         if target.contains("msvc") {
1052             if let Some(ref cl) = self.config.llvm_clang_cl {
1053                 cargo.env("CC", cl).env("CXX", cl);
1054             }
1055         } else {
1056             let ccache = self.config.ccache.as_ref();
1057             let ccacheify = |s: &Path| {
1058                 let ccache = match ccache {
1059                     Some(ref s) => s,
1060                     None => return s.display().to_string(),
1061                 };
1062                 // FIXME: the cc-rs crate only recognizes the literal strings
1063                 // `ccache` and `sccache` when doing caching compilations, so we
1064                 // mirror that here. It should probably be fixed upstream to
1065                 // accept a new env var or otherwise work with custom ccache
1066                 // vars.
1067                 match &ccache[..] {
1068                     "ccache" | "sccache" => format!("{} {}", ccache, s.display()),
1069                     _ => s.display().to_string(),
1070                 }
1071             };
1072             let cc = ccacheify(&self.cc(target));
1073             cargo.env(format!("CC_{}", target), &cc);
1074
1075             let cflags = self.cflags(target, GitRepo::Rustc).join(" ");
1076             cargo.env(format!("CFLAGS_{}", target), cflags.clone());
1077
1078             if let Some(ar) = self.ar(target) {
1079                 let ranlib = format!("{} s", ar.display());
1080                 cargo.env(format!("AR_{}", target), ar).env(format!("RANLIB_{}", target), ranlib);
1081             }
1082
1083             if let Ok(cxx) = self.cxx(target) {
1084                 let cxx = ccacheify(&cxx);
1085                 cargo
1086                     .env(format!("CXX_{}", target), &cxx)
1087                     .env(format!("CXXFLAGS_{}", target), cflags);
1088             }
1089         }
1090
1091         if mode == Mode::Std && self.config.extended && compiler.is_final_stage(self) {
1092             rustflags.arg("-Zsave-analysis");
1093             cargo.env(
1094                 "RUST_SAVE_ANALYSIS_CONFIG",
1095                 "{\"output_file\": null,\"full_docs\": false,\
1096                        \"pub_only\": true,\"reachable_only\": false,\
1097                        \"distro_crate\": true,\"signatures\": false,\"borrow_data\": false}",
1098             );
1099         }
1100
1101         // For `cargo doc` invocations, make rustdoc print the Rust version into the docs
1102         cargo.env("RUSTDOC_CRATE_VERSION", self.rust_version());
1103
1104         // Environment variables *required* throughout the build
1105         //
1106         // FIXME: should update code to not require this env var
1107         cargo.env("CFG_COMPILER_HOST_TRIPLE", target);
1108
1109         // Set this for all builds to make sure doc builds also get it.
1110         cargo.env("CFG_RELEASE_CHANNEL", &self.config.channel);
1111
1112         // This one's a bit tricky. As of the time of this writing the compiler
1113         // links to the `winapi` crate on crates.io. This crate provides raw
1114         // bindings to Windows system functions, sort of like libc does for
1115         // Unix. This crate also, however, provides "import libraries" for the
1116         // MinGW targets. There's an import library per dll in the windows
1117         // distribution which is what's linked to. These custom import libraries
1118         // are used because the winapi crate can reference Windows functions not
1119         // present in the MinGW import libraries.
1120         //
1121         // For example MinGW may ship libdbghelp.a, but it may not have
1122         // references to all the functions in the dbghelp dll. Instead the
1123         // custom import library for dbghelp in the winapi crates has all this
1124         // information.
1125         //
1126         // Unfortunately for us though the import libraries are linked by
1127         // default via `-ldylib=winapi_foo`. That is, they're linked with the
1128         // `dylib` type with a `winapi_` prefix (so the winapi ones don't
1129         // conflict with the system MinGW ones). This consequently means that
1130         // the binaries we ship of things like rustc_codegen_llvm (aka the rustc_codegen_llvm
1131         // DLL) when linked against *again*, for example with procedural macros
1132         // or plugins, will trigger the propagation logic of `-ldylib`, passing
1133         // `-lwinapi_foo` to the linker again. This isn't actually available in
1134         // our distribution, however, so the link fails.
1135         //
1136         // To solve this problem we tell winapi to not use its bundled import
1137         // libraries. This means that it will link to the system MinGW import
1138         // libraries by default, and the `-ldylib=foo` directives will still get
1139         // passed to the final linker, but they'll look like `-lfoo` which can
1140         // be resolved because MinGW has the import library. The downside is we
1141         // don't get newer functions from Windows, but we don't use any of them
1142         // anyway.
1143         if !mode.is_tool() {
1144             cargo.env("WINAPI_NO_BUNDLED_LIBRARIES", "1");
1145         }
1146
1147         for _ in 1..self.verbosity {
1148             cargo.arg("-v");
1149         }
1150
1151         match (mode, self.config.rust_codegen_units_std, self.config.rust_codegen_units) {
1152             (Mode::Std, Some(n), _) | (_, _, Some(n)) => {
1153                 cargo.env(profile_var("CODEGEN_UNITS"), n.to_string());
1154             }
1155             _ => {
1156                 // Don't set anything
1157             }
1158         }
1159
1160         if self.config.rust_optimize {
1161             // FIXME: cargo bench/install do not accept `--release`
1162             if cmd != "bench" && cmd != "install" {
1163                 cargo.arg("--release");
1164             }
1165         }
1166
1167         if self.config.locked_deps {
1168             cargo.arg("--locked");
1169         }
1170         if self.config.vendor || self.is_sudo {
1171             cargo.arg("--frozen");
1172         }
1173
1174         // Try to use a sysroot-relative bindir, in case it was configured absolutely.
1175         cargo.env("RUSTC_INSTALL_BINDIR", self.config.bindir_relative());
1176
1177         self.ci_env.force_coloring_in_ci(&mut cargo);
1178
1179         // When we build Rust dylibs they're all intended for intermediate
1180         // usage, so make sure we pass the -Cprefer-dynamic flag instead of
1181         // linking all deps statically into the dylib.
1182         if let Mode::Std | Mode::Rustc | Mode::Codegen = mode {
1183             rustflags.arg("-Cprefer-dynamic");
1184         }
1185
1186         // When building incrementally we default to a lower ThinLTO import limit
1187         // (unless explicitly specified otherwise). This will produce a somewhat
1188         // slower code but give way better compile times.
1189         {
1190             let limit = match self.config.rust_thin_lto_import_instr_limit {
1191                 Some(limit) => Some(limit),
1192                 None if self.config.incremental => Some(10),
1193                 _ => None,
1194             };
1195
1196             if let Some(limit) = limit {
1197                 rustflags.arg(&format!("-Cllvm-args=-import-instr-limit={}", limit));
1198             }
1199         }
1200
1201         Cargo { command: cargo, rustflags }
1202     }
1203
1204     /// Ensure that a given step is built, returning its output. This will
1205     /// cache the step, so it is safe (and good!) to call this as often as
1206     /// needed to ensure that all dependencies are built.
1207     pub fn ensure<S: Step>(&'a self, step: S) -> S::Output {
1208         {
1209             let mut stack = self.stack.borrow_mut();
1210             for stack_step in stack.iter() {
1211                 // should skip
1212                 if stack_step.downcast_ref::<S>().map_or(true, |stack_step| *stack_step != step) {
1213                     continue;
1214                 }
1215                 let mut out = String::new();
1216                 out += &format!("\n\nCycle in build detected when adding {:?}\n", step);
1217                 for el in stack.iter().rev() {
1218                     out += &format!("\t{:?}\n", el);
1219                 }
1220                 panic!(out);
1221             }
1222             if let Some(out) = self.cache.get(&step) {
1223                 self.verbose(&format!("{}c {:?}", "  ".repeat(stack.len()), step));
1224
1225                 return out;
1226             }
1227             self.verbose(&format!("{}> {:?}", "  ".repeat(stack.len()), step));
1228             stack.push(Box::new(step.clone()));
1229         }
1230
1231         let (out, dur) = {
1232             let start = Instant::now();
1233             let zero = Duration::new(0, 0);
1234             let parent = self.time_spent_on_dependencies.replace(zero);
1235             let out = step.clone().run(self);
1236             let dur = start.elapsed();
1237             let deps = self.time_spent_on_dependencies.replace(parent + dur);
1238             (out, dur - deps)
1239         };
1240
1241         if self.config.print_step_timings && dur > Duration::from_millis(100) {
1242             println!(
1243                 "[TIMING] {:?} -- {}.{:03}",
1244                 step,
1245                 dur.as_secs(),
1246                 dur.subsec_nanos() / 1_000_000
1247             );
1248         }
1249
1250         {
1251             let mut stack = self.stack.borrow_mut();
1252             let cur_step = stack.pop().expect("step stack empty");
1253             assert_eq!(cur_step.downcast_ref(), Some(&step));
1254         }
1255         self.verbose(&format!("{}< {:?}", "  ".repeat(self.stack.borrow().len()), step));
1256         self.cache.put(step, out.clone());
1257         out
1258     }
1259 }
1260
1261 #[cfg(test)]
1262 mod tests;
1263
1264 #[derive(Debug)]
1265 struct Rustflags(String);
1266
1267 impl Rustflags {
1268     fn new(target: &str) -> Rustflags {
1269         let mut ret = Rustflags(String::new());
1270
1271         // Inherit `RUSTFLAGS` by default ...
1272         ret.env("RUSTFLAGS");
1273
1274         // ... and also handle target-specific env RUSTFLAGS if they're
1275         // configured.
1276         let target_specific = format!("CARGO_TARGET_{}_RUSTFLAGS", crate::envify(target));
1277         ret.env(&target_specific);
1278
1279         ret
1280     }
1281
1282     fn env(&mut self, env: &str) {
1283         if let Ok(s) = env::var(env) {
1284             for part in s.split_whitespace() {
1285                 self.arg(part);
1286             }
1287         }
1288     }
1289
1290     fn arg(&mut self, arg: &str) -> &mut Self {
1291         assert_eq!(arg.split_whitespace().count(), 1);
1292         if self.0.len() > 0 {
1293             self.0.push_str(" ");
1294         }
1295         self.0.push_str(arg);
1296         self
1297     }
1298 }
1299
1300 #[derive(Debug)]
1301 pub struct Cargo {
1302     command: Command,
1303     rustflags: Rustflags,
1304 }
1305
1306 impl Cargo {
1307     pub fn rustflag(&mut self, arg: &str) -> &mut Cargo {
1308         self.rustflags.arg(arg);
1309         self
1310     }
1311
1312     pub fn arg(&mut self, arg: impl AsRef<OsStr>) -> &mut Cargo {
1313         self.command.arg(arg.as_ref());
1314         self
1315     }
1316
1317     pub fn args<I, S>(&mut self, args: I) -> &mut Cargo
1318     where
1319         I: IntoIterator<Item = S>,
1320         S: AsRef<OsStr>,
1321     {
1322         for arg in args {
1323             self.arg(arg.as_ref());
1324         }
1325         self
1326     }
1327
1328     pub fn env(&mut self, key: impl AsRef<OsStr>, value: impl AsRef<OsStr>) -> &mut Cargo {
1329         self.command.env(key.as_ref(), value.as_ref());
1330         self
1331     }
1332 }
1333
1334 impl From<Cargo> for Command {
1335     fn from(mut cargo: Cargo) -> Command {
1336         cargo.command.env("RUSTFLAGS", &cargo.rustflags.0);
1337         cargo.command
1338     }
1339 }