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