src/bootstrap/tarball.rs

   1 use std::{
   2     path::{Path, PathBuf},
   3     process::Command,
   4 };
   5
   6 use build_helper::t;
   7
   8 use crate::builder::Builder;
   9
  10 #[derive(Copy, Clone)]
  11 pub(crate) enum OverlayKind {
  12     Rust,
  13     LLVM,
  14     Cargo,
  15     Clippy,
  16     Miri,
  17     Rustfmt,
  18     RLS,
  19     RustAnalyzer,
  20 }
  21
  22 impl OverlayKind {
  23     fn legal_and_readme(&self) -> &[&str] {
  24         match self {
  25             OverlayKind::Rust => &["COPYRIGHT", "LICENSE-APACHE", "LICENSE-MIT", "README.md"],
  26             OverlayKind::LLVM => {
  27                 &["src/llvm-project/llvm/LICENSE.TXT", "src/llvm-project/llvm/README.txt"]
  28             }
  29             OverlayKind::Cargo => &[
  30                 "src/tools/cargo/README.md",
  31                 "src/tools/cargo/LICENSE-MIT",
  32                 "src/tools/cargo/LICENSE-APACHE",
  33                 "src/tools/cargo/LICENSE-THIRD-PARTY",
  34             ],
  35             OverlayKind::Clippy => &[
  36                 "src/tools/clippy/README.md",
  37                 "src/tools/clippy/LICENSE-APACHE",
  38                 "src/tools/clippy/LICENSE-MIT",
  39             ],
  40             OverlayKind::Miri => &[
  41                 "src/tools/miri/README.md",
  42                 "src/tools/miri/LICENSE-APACHE",
  43                 "src/tools/miri/LICENSE-MIT",
  44             ],
  45             OverlayKind::Rustfmt => &[
  46                 "src/tools/rustfmt/README.md",
  47                 "src/tools/rustfmt/LICENSE-APACHE",
  48                 "src/tools/rustfmt/LICENSE-MIT",
  49             ],
  50             OverlayKind::RLS => &[
  51                 "src/tools/rls/README.md",
  52                 "src/tools/rls/LICENSE-APACHE",
  53                 "src/tools/rls/LICENSE-MIT",
  54             ],
  55             OverlayKind::RustAnalyzer => &[
  56                 "src/tools/rust-analyzer/README.md",
  57                 "src/tools/rust-analyzer/LICENSE-APACHE",
  58                 "src/tools/rust-analyzer/LICENSE-MIT",
  59             ],
  60         }
  61     }
  62
  63     fn version(&self, builder: &Builder<'_>) -> String {
  64         match self {
  65             OverlayKind::Rust => builder.rust_version(),
  66             OverlayKind::LLVM => builder.rust_version(),
  67             OverlayKind::Cargo => {
  68                 builder.cargo_info.version(builder, &builder.release_num("cargo"))
  69             }
  70             OverlayKind::Clippy => {
  71                 builder.clippy_info.version(builder, &builder.release_num("clippy"))
  72             }
  73             OverlayKind::Miri => builder.miri_info.version(builder, &builder.release_num("miri")),
  74             OverlayKind::Rustfmt => {
  75                 builder.rustfmt_info.version(builder, &builder.release_num("rustfmt"))
  76             }
  77             OverlayKind::RLS => builder.rls_info.version(builder, &builder.release_num("rls")),
  78             OverlayKind::RustAnalyzer => builder
  79                 .rust_analyzer_info
  80                 .version(builder, &builder.release_num("rust-analyzer/crates/rust-analyzer")),
  81         }
  82     }
  83 }
  84
  85 pub(crate) struct Tarball<'a> {
  86     builder: &'a Builder<'a>,
  87
  88     pkgname: String,
  89     component: String,
  90     target: Option<String>,
  91     product_name: String,
  92     overlay: OverlayKind,
  93
  94     temp_dir: PathBuf,
  95     image_dir: PathBuf,
  96     overlay_dir: PathBuf,
  97
  98     include_target_in_component_name: bool,
  99     is_preview: bool,
 100 }
 101
 102 impl<'a> Tarball<'a> {
 103     pub(crate) fn new(builder: &'a Builder<'a>, component: &str, target: &str) -> Self {
 104         Self::new_inner(builder, component, Some(target.into()))
 105     }
 106
 107     pub(crate) fn new_targetless(builder: &'a Builder<'a>, component: &str) -> Self {
 108         Self::new_inner(builder, component, None)
 109     }
 110
 111     fn new_inner(builder: &'a Builder<'a>, component: &str, target: Option<String>) -> Self {
 112         let pkgname = crate::dist::pkgname(builder, component);
 113
 114         let mut temp_dir = builder.out.join("tmp").join("tarball").join(component);
 115         if let Some(target) = &target {
 116             temp_dir = temp_dir.join(target);
 117         }
 118         let _ = std::fs::remove_dir_all(&temp_dir);
 119
 120         let image_dir = temp_dir.join("image");
 121         let overlay_dir = temp_dir.join("overlay");
 122
 123         Self {
 124             builder,
 125
 126             pkgname,
 127             component: component.into(),
 128             target,
 129             product_name: "Rust".into(),
 130             overlay: OverlayKind::Rust,
 131
 132             temp_dir,
 133             image_dir,
 134             overlay_dir,
 135
 136             include_target_in_component_name: false,
 137             is_preview: false,
 138         }
 139     }
 140
 141     pub(crate) fn set_overlay(&mut self, overlay: OverlayKind) {
 142         self.overlay = overlay;
 143     }
 144
 145     pub(crate) fn set_product_name(&mut self, name: &str) {
 146         self.product_name = name.into();
 147     }
 148
 149     pub(crate) fn include_target_in_component_name(&mut self, include: bool) {
 150         self.include_target_in_component_name = include;
 151     }
 152
 153     pub(crate) fn is_preview(&mut self, is: bool) {
 154         self.is_preview = is;
 155     }
 156
 157     pub(crate) fn image_dir(&self) -> &Path {
 158         t!(std::fs::create_dir_all(&self.image_dir));
 159         &self.image_dir
 160     }
 161
 162     pub(crate) fn add_file(&self, src: impl AsRef<Path>, destdir: impl AsRef<Path>, perms: u32) {
 163         // create_dir_all fails to create `foo/bar/.`, so when the destination is "." this simply
 164         // uses the base directory as the destination directory.
 165         let destdir = if destdir.as_ref() == Path::new(".") {
 166             self.image_dir.clone()
 167         } else {
 168             self.image_dir.join(destdir.as_ref())
 169         };
 170
 171         t!(std::fs::create_dir_all(&destdir));
 172         self.builder.install(src.as_ref(), &destdir, perms);
 173     }
 174
 175     pub(crate) fn add_renamed_file(
 176         &self,
 177         src: impl AsRef<Path>,
 178         destdir: impl AsRef<Path>,
 179         new_name: &str,
 180     ) {
 181         let destdir = self.image_dir.join(destdir.as_ref());
 182         t!(std::fs::create_dir_all(&destdir));
 183         self.builder.copy(src.as_ref(), &destdir.join(new_name));
 184     }
 185
 186     pub(crate) fn add_legal_and_readme_to(&self, destdir: impl AsRef<Path>) {
 187         for file in self.overlay.legal_and_readme() {
 188             self.add_file(self.builder.src.join(file), destdir.as_ref(), 0o644);
 189         }
 190     }
 191
 192     pub(crate) fn add_dir(&self, src: impl AsRef<Path>, dest: impl AsRef<Path>) {
 193         let dest = self.image_dir.join(dest.as_ref());
 194
 195         t!(std::fs::create_dir_all(&dest));
 196         self.builder.cp_r(src.as_ref(), &dest);
 197     }
 198
 199     pub(crate) fn generate(self) -> GeneratedTarball {
 200         let mut component_name = self.component.clone();
 201         if self.is_preview {
 202             component_name.push_str("-preview");
 203         }
 204         if self.include_target_in_component_name {
 205             component_name.push('-');
 206             component_name.push_str(
 207                 &self
 208                     .target
 209                     .as_ref()
 210                     .expect("include_target_in_component_name used in a targetless tarball"),
 211             );
 212         }
 213
 214         self.run(|this, cmd| {
 215             cmd.arg("generate")
 216                 .arg("--image-dir")
 217                 .arg(&this.image_dir)
 218                 .arg(format!("--component-name={}", &component_name));
 219             this.non_bare_args(cmd);
 220         })
 221     }
 222
 223     pub(crate) fn combine(self, tarballs: &[GeneratedTarball]) -> GeneratedTarball {
 224         let mut input_tarballs = tarballs[0].path.as_os_str().to_os_string();
 225         for tarball in &tarballs[1..] {
 226             input_tarballs.push(",");
 227             input_tarballs.push(&tarball.path);
 228         }
 229
 230         self.run(|this, cmd| {
 231             cmd.arg("combine").arg("--input-tarballs").arg(input_tarballs);
 232             this.non_bare_args(cmd);
 233         })
 234     }
 235
 236     pub(crate) fn bare(self) -> GeneratedTarball {
 237         // Bare tarballs should have the top level directory match the package
 238         // name, not "image". We rename the image directory just before passing
 239         // into rust-installer.
 240         let dest = self.temp_dir.join(self.package_name());
 241         t!(std::fs::rename(&self.image_dir, &dest));
 242
 243         self.run(|this, cmd| {
 244             cmd.arg("tarball")
 245                 .arg("--input")
 246                 .arg(&dest)
 247                 .arg("--output")
 248                 .arg(crate::dist::distdir(this.builder).join(this.package_name()));
 249         })
 250     }
 251
 252     fn package_name(&self) -> String {
 253         if let Some(target) = &self.target {
 254             format!("{}-{}", self.pkgname, target)
 255         } else {
 256             self.pkgname.clone()
 257         }
 258     }
 259
 260     fn non_bare_args(&self, cmd: &mut Command) {
 261         cmd.arg("--rel-manifest-dir=rustlib")
 262             .arg("--legacy-manifest-dirs=rustlib,cargo")
 263             .arg(format!("--product-name={}", self.product_name))
 264             .arg(format!("--success-message={} installed.", self.component))
 265             .arg(format!("--package-name={}", self.package_name()))
 266             .arg("--non-installed-overlay")
 267             .arg(&self.overlay_dir)
 268             .arg("--output-dir")
 269             .arg(crate::dist::distdir(self.builder));
 270     }
 271
 272     fn run(self, build_cli: impl FnOnce(&Tarball<'a>, &mut Command)) -> GeneratedTarball {
 273         t!(std::fs::create_dir_all(&self.overlay_dir));
 274         self.builder.create(&self.overlay_dir.join("version"), &self.overlay.version(self.builder));
 275         if let Some(sha) = self.builder.rust_sha() {
 276             self.builder.create(&self.overlay_dir.join("git-commit-hash"), &sha);
 277         }
 278         for file in self.overlay.legal_and_readme() {
 279             self.builder.install(&self.builder.src.join(file), &self.overlay_dir, 0o644);
 280         }
 281
 282         let mut cmd = self.builder.tool_cmd(crate::tool::Tool::RustInstaller);
 283
 284         let package_name = self.package_name();
 285         self.builder.info(&format!("Dist {}", package_name));
 286         let _time = crate::util::timeit(self.builder);
 287
 288         build_cli(&self, &mut cmd);
 289         cmd.arg("--work-dir").arg(&self.temp_dir);
 290         if let Some(formats) = &self.builder.config.dist_compression_formats {
 291             assert!(!formats.is_empty(), "dist.compression-formats can't be empty");
 292             cmd.arg("--compression-formats").arg(formats.join(","));
 293         }
 294         self.builder.run(&mut cmd);
 295
 296         // Use either the first compression format defined, or "gz" as the default.
 297         let ext = self
 298             .builder
 299             .config
 300             .dist_compression_formats
 301             .as_ref()
 302             .and_then(|formats| formats.get(0))
 303             .map(|s| s.as_str())
 304             .unwrap_or("gz");
 305
 306         GeneratedTarball {
 307             path: crate::dist::distdir(self.builder).join(format!("{}.tar.{}", package_name, ext)),
 308             decompressed_output: self.temp_dir.join(package_name),
 309             work: self.temp_dir,
 310         }
 311     }
 312 }
 313
 314 #[derive(Debug, Clone)]
 315 pub struct GeneratedTarball {
 316     path: PathBuf,
 317     decompressed_output: PathBuf,
 318     work: PathBuf,
 319 }
 320
 321 impl GeneratedTarball {
 322     pub(crate) fn tarball(&self) -> &Path {
 323         &self.path
 324     }
 325
 326     pub(crate) fn decompressed_output(&self) -> &Path {
 327         &self.decompressed_output
 328     }
 329
 330     pub(crate) fn work_dir(&self) -> &Path {
 331         &self.work
 332     }
 333 }