src/bootstrap/tarball.rs

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