src/bootstrap/install.rs

   1 //! Implementation of the install aspects of the compiler.
   2 //!
   3 //! This module is responsible for installing the standard library,
   4 //! compiler, and documentation.
   5
   6 use std::env;
   7 use std::fs;
   8 use std::path::{Component, Path, PathBuf};
   9 use std::process::Command;
  10
  11 use build_helper::t;
  12
  13 use crate::dist::{self, pkgname, sanitize_sh, tmpdir};
  14 use crate::Compiler;
  15
  16 use crate::builder::{Builder, RunConfig, ShouldRun, Step};
  17 use crate::cache::Interned;
  18 use crate::config::Config;
  19
  20 pub fn install_docs(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
  21     install_sh(builder, "docs", "rust-docs", stage, Some(host));
  22 }
  23
  24 pub fn install_std(builder: &Builder<'_>, stage: u32, target: Interned<String>) {
  25     install_sh(builder, "std", "rust-std", stage, Some(target));
  26 }
  27
  28 pub fn install_cargo(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
  29     install_sh(builder, "cargo", "cargo", stage, Some(host));
  30 }
  31
  32 pub fn install_rls(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
  33     install_sh(builder, "rls", "rls", stage, Some(host));
  34 }
  35 pub fn install_clippy(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
  36     install_sh(builder, "clippy", "clippy", stage, Some(host));
  37 }
  38 pub fn install_miri(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
  39     install_sh(builder, "miri", "miri", stage, Some(host));
  40 }
  41
  42 pub fn install_rustfmt(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
  43     install_sh(builder, "rustfmt", "rustfmt", stage, Some(host));
  44 }
  45
  46 pub fn install_analysis(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
  47     install_sh(builder, "analysis", "rust-analysis", stage, Some(host));
  48 }
  49
  50 pub fn install_src(builder: &Builder<'_>, stage: u32) {
  51     install_sh(builder, "src", "rust-src", stage, None);
  52 }
  53 pub fn install_rustc(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
  54     install_sh(builder, "rustc", "rustc", stage, Some(host));
  55 }
  56
  57 fn install_sh(
  58     builder: &Builder<'_>,
  59     package: &str,
  60     name: &str,
  61     stage: u32,
  62     host: Option<Interned<String>>,
  63 ) {
  64     builder.info(&format!("Install {} stage{} ({:?})", package, stage, host));
  65
  66     let prefix_default = PathBuf::from("/usr/local");
  67     let sysconfdir_default = PathBuf::from("/etc");
  68     let datadir_default = PathBuf::from("share");
  69     let docdir_default = datadir_default.join("doc/rust");
  70     let bindir_default = PathBuf::from("bin");
  71     let libdir_default = PathBuf::from("lib");
  72     let mandir_default = datadir_default.join("man");
  73     let prefix = builder.config.prefix.as_ref().map_or(prefix_default, |p| {
  74         fs::canonicalize(p).unwrap_or_else(|_| panic!("could not canonicalize {}", p.display()))
  75     });
  76     let sysconfdir = builder.config.sysconfdir.as_ref().unwrap_or(&sysconfdir_default);
  77     let datadir = builder.config.datadir.as_ref().unwrap_or(&datadir_default);
  78     let docdir = builder.config.docdir.as_ref().unwrap_or(&docdir_default);
  79     let bindir = builder.config.bindir.as_ref().unwrap_or(&bindir_default);
  80     let libdir = builder.config.libdir.as_ref().unwrap_or(&libdir_default);
  81     let mandir = builder.config.mandir.as_ref().unwrap_or(&mandir_default);
  82
  83     let sysconfdir = prefix.join(sysconfdir);
  84     let datadir = prefix.join(datadir);
  85     let docdir = prefix.join(docdir);
  86     let bindir = prefix.join(bindir);
  87     let libdir = prefix.join(libdir);
  88     let mandir = prefix.join(mandir);
  89
  90     let destdir = env::var_os("DESTDIR").map(PathBuf::from);
  91
  92     let prefix = add_destdir(&prefix, &destdir);
  93     let sysconfdir = add_destdir(&sysconfdir, &destdir);
  94     let datadir = add_destdir(&datadir, &destdir);
  95     let docdir = add_destdir(&docdir, &destdir);
  96     let bindir = add_destdir(&bindir, &destdir);
  97     let libdir = add_destdir(&libdir, &destdir);
  98     let mandir = add_destdir(&mandir, &destdir);
  99
 100     let empty_dir = builder.out.join("tmp/empty_dir");
 101
 102     t!(fs::create_dir_all(&empty_dir));
 103     let package_name = if let Some(host) = host {
 104         format!("{}-{}", pkgname(builder, name), host)
 105     } else {
 106         pkgname(builder, name)
 107     };
 108
 109     let mut cmd = Command::new("sh");
 110     cmd.current_dir(&empty_dir)
 111         .arg(sanitize_sh(&tmpdir(builder).join(&package_name).join("install.sh")))
 112         .arg(format!("--prefix={}", sanitize_sh(&prefix)))
 113         .arg(format!("--sysconfdir={}", sanitize_sh(&sysconfdir)))
 114         .arg(format!("--datadir={}", sanitize_sh(&datadir)))
 115         .arg(format!("--docdir={}", sanitize_sh(&docdir)))
 116         .arg(format!("--bindir={}", sanitize_sh(&bindir)))
 117         .arg(format!("--libdir={}", sanitize_sh(&libdir)))
 118         .arg(format!("--mandir={}", sanitize_sh(&mandir)))
 119         .arg("--disable-ldconfig");
 120     builder.run(&mut cmd);
 121     t!(fs::remove_dir_all(&empty_dir));
 122 }
 123
 124 fn add_destdir(path: &Path, destdir: &Option<PathBuf>) -> PathBuf {
 125     let mut ret = match *destdir {
 126         Some(ref dest) => dest.clone(),
 127         None => return path.to_path_buf(),
 128     };
 129     for part in path.components() {
 130         match part {
 131             Component::Normal(s) => ret.push(s),
 132             _ => {}
 133         }
 134     }
 135     ret
 136 }
 137
 138 macro_rules! install {
 139     (($sel:ident, $builder:ident, $_config:ident),
 140        $($name:ident,
 141        $path:expr,
 142        $default_cond:expr,
 143        only_hosts: $only_hosts:expr,
 144        $run_item:block $(, $c:ident)*;)+) => {
 145         $(
 146             #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 147         pub struct $name {
 148             pub compiler: Compiler,
 149             pub target: Interned<String>,
 150         }
 151
 152         impl $name {
 153             #[allow(dead_code)]
 154             fn should_build(config: &Config) -> bool {
 155                 config.extended && config.tools.as_ref()
 156                     .map_or(true, |t| t.contains($path))
 157             }
 158
 159             #[allow(dead_code)]
 160             fn should_install(builder: &Builder<'_>) -> bool {
 161                 builder.config.tools.as_ref().map_or(false, |t| t.contains($path))
 162             }
 163         }
 164
 165         impl Step for $name {
 166             type Output = ();
 167             const DEFAULT: bool = true;
 168             const ONLY_HOSTS: bool = $only_hosts;
 169             $(const $c: bool = true;)*
 170
 171             fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 172                 let $_config = &run.builder.config;
 173                 run.path($path).default_condition($default_cond)
 174             }
 175
 176             fn make_run(run: RunConfig<'_>) {
 177                 run.builder.ensure($name {
 178                     compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
 179                     target: run.target,
 180                 });
 181             }
 182
 183             fn run($sel, $builder: &Builder<'_>) {
 184                 $run_item
 185             }
 186         })+
 187     }
 188 }
 189
 190 install!((self, builder, _config),
 191     Docs, "src/doc", _config.docs, only_hosts: false, {
 192         builder.ensure(dist::Docs { host: self.target });
 193         install_docs(builder, self.compiler.stage, self.target);
 194     };
 195     Std, "src/libstd", true, only_hosts: true, {
 196         for target in &builder.targets {
 197             builder.ensure(dist::Std {
 198                 compiler: self.compiler,
 199                 target: *target
 200             });
 201             install_std(builder, self.compiler.stage, *target);
 202         }
 203     };
 204     Cargo, "cargo", Self::should_build(_config), only_hosts: true, {
 205         builder.ensure(dist::Cargo { compiler: self.compiler, target: self.target });
 206         install_cargo(builder, self.compiler.stage, self.target);
 207     };
 208     Rls, "rls", Self::should_build(_config), only_hosts: true, {
 209         if builder.ensure(dist::Rls { compiler: self.compiler, target: self.target }).is_some() ||
 210             Self::should_install(builder) {
 211             install_rls(builder, self.compiler.stage, self.target);
 212         } else {
 213             builder.info(
 214                 &format!("skipping Install RLS stage{} ({})", self.compiler.stage, self.target),
 215             );
 216         }
 217     };
 218     Clippy, "clippy", Self::should_build(_config), only_hosts: true, {
 219         if builder.ensure(dist::Clippy {
 220             compiler: self.compiler,
 221             target: self.target,
 222         }).is_some() || Self::should_install(builder) {
 223             install_clippy(builder, self.compiler.stage, self.target);
 224         } else {
 225             builder.info(
 226                 &format!("skipping Install clippy stage{} ({})", self.compiler.stage, self.target),
 227             );
 228         }
 229     };
 230     Miri, "miri", Self::should_build(_config), only_hosts: true, {
 231         if builder.ensure(dist::Miri { compiler: self.compiler, target: self.target }).is_some() ||
 232             Self::should_install(builder) {
 233             install_miri(builder, self.compiler.stage, self.target);
 234         } else {
 235             builder.info(
 236                 &format!("skipping Install miri stage{} ({})", self.compiler.stage, self.target),
 237             );
 238         }
 239     };
 240     Rustfmt, "rustfmt", Self::should_build(_config), only_hosts: true, {
 241         if builder.ensure(dist::Rustfmt {
 242             compiler: self.compiler,
 243             target: self.target
 244         }).is_some() || Self::should_install(builder) {
 245             install_rustfmt(builder, self.compiler.stage, self.target);
 246         } else {
 247             builder.info(
 248                 &format!("skipping Install Rustfmt stage{} ({})", self.compiler.stage, self.target),
 249             );
 250         }
 251     };
 252     Analysis, "analysis", Self::should_build(_config), only_hosts: false, {
 253         builder.ensure(dist::Analysis {
 254             compiler: self.compiler,
 255             target: self.target
 256         });
 257         install_analysis(builder, self.compiler.stage, self.target);
 258     };
 259     Rustc, "src/librustc", true, only_hosts: true, {
 260         builder.ensure(dist::Rustc {
 261             compiler: self.compiler,
 262         });
 263         install_rustc(builder, self.compiler.stage, self.target);
 264     };
 265 );
 266
 267 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 268 pub struct Src {
 269     pub stage: u32,
 270 }
 271
 272 impl Step for Src {
 273     type Output = ();
 274     const DEFAULT: bool = true;
 275     const ONLY_HOSTS: bool = true;
 276
 277     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 278         let config = &run.builder.config;
 279         let cond = config.extended && config.tools.as_ref().map_or(true, |t| t.contains("src"));
 280         run.path("src").default_condition(cond)
 281     }
 282
 283     fn make_run(run: RunConfig<'_>) {
 284         run.builder.ensure(Src { stage: run.builder.top_stage });
 285     }
 286
 287     fn run(self, builder: &Builder<'_>) {
 288         builder.ensure(dist::Src);
 289         install_src(builder, self.stage);
 290     }
 291 }