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
 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
 141             include_target_in_component_name: false,
 142             is_preview: false,
 143         }
 144     }
 145
 146     pub(crate) fn set_overlay(&mut self, overlay: OverlayKind) {
 147         self.overlay = overlay;
 148     }
 149
 150     pub(crate) fn set_product_name(&mut self, name: &str) {
 151         self.product_name = name.into();
 152     }
 153
 154     pub(crate) fn include_target_in_component_name(&mut self, include: bool) {
 155         self.include_target_in_component_name = include;
 156     }
 157
 158     pub(crate) fn is_preview(&mut self, is: bool) {
 159         self.is_preview = is;
 160     }
 161
 162     pub(crate) fn image_dir(&self) -> &Path {
 163         t!(std::fs::create_dir_all(&self.image_dir));
 164         &self.image_dir
 165     }
 166
 167     pub(crate) fn add_file(&self, src: impl AsRef<Path>, destdir: impl AsRef<Path>, perms: u32) {
 168         // create_dir_all fails to create `foo/bar/.`, so when the destination is "." this simply
 169         // uses the base directory as the destination directory.
 170         let destdir = if destdir.as_ref() == Path::new(".") {
 171             self.image_dir.clone()
 172         } else {
 173             self.image_dir.join(destdir.as_ref())
 174         };
 175
 176         t!(std::fs::create_dir_all(&destdir));
 177         self.builder.install(src.as_ref(), &destdir, perms);
 178     }
 179
 180     pub(crate) fn add_renamed_file(
 181         &self,
 182         src: impl AsRef<Path>,
 183         destdir: impl AsRef<Path>,
 184         new_name: &str,
 185     ) {
 186         let destdir = self.image_dir.join(destdir.as_ref());
 187         t!(std::fs::create_dir_all(&destdir));
 188         self.builder.copy(src.as_ref(), &destdir.join(new_name));
 189     }
 190
 191     pub(crate) fn add_legal_and_readme_to(&self, destdir: impl AsRef<Path>) {
 192         for file in self.overlay.legal_and_readme() {
 193             self.add_file(self.builder.src.join(file), destdir.as_ref(), 0o644);
 194         }
 195     }
 196
 197     pub(crate) fn add_dir(&self, src: impl AsRef<Path>, dest: impl AsRef<Path>) {
 198         let dest = self.image_dir.join(dest.as_ref());
 199
 200         t!(std::fs::create_dir_all(&dest));
 201         self.builder.cp_r(src.as_ref(), &dest);
 202     }
 203
 204     pub(crate) fn generate(self) -> GeneratedTarball {
 205         let mut component_name = self.component.clone();
 206         if self.is_preview {
 207             component_name.push_str("-preview");
 208         }
 209         if self.include_target_in_component_name {
 210             component_name.push('-');
 211             component_name.push_str(
 212                 &self
 213                     .target
 214                     .as_ref()
 215                     .expect("include_target_in_component_name used in a targetless tarball"),
 216             );
 217         }
 218
 219         self.run(|this, cmd| {
 220             cmd.arg("generate")
 221                 .arg("--image-dir")
 222                 .arg(&this.image_dir)
 223                 .arg(format!("--component-name={}", &component_name));
 224             this.non_bare_args(cmd);
 225         })
 226     }
 227
 228     pub(crate) fn combine(self, tarballs: &[GeneratedTarball]) -> GeneratedTarball {
 229         let mut input_tarballs = tarballs[0].path.as_os_str().to_os_string();
 230         for tarball in &tarballs[1..] {
 231             input_tarballs.push(",");
 232             input_tarballs.push(&tarball.path);
 233         }
 234
 235         self.run(|this, cmd| {
 236             cmd.arg("combine").arg("--input-tarballs").arg(input_tarballs);
 237             this.non_bare_args(cmd);
 238         })
 239     }
 240
 241     pub(crate) fn bare(self) -> GeneratedTarball {
 242         // Bare tarballs should have the top level directory match the package
 243         // name, not "image". We rename the image directory just before passing
 244         // into rust-installer.
 245         let dest = self.temp_dir.join(self.package_name());
 246         t!(std::fs::rename(&self.image_dir, &dest));
 247
 248         self.run(|this, cmd| {
 249             cmd.arg("tarball")
 250                 .arg("--input")
 251                 .arg(&dest)
 252                 .arg("--output")
 253                 .arg(crate::dist::distdir(this.builder).join(this.package_name()));
 254         })
 255     }
 256
 257     fn package_name(&self) -> String {
 258         if let Some(target) = &self.target {
 259             format!("{}-{}", self.pkgname, target)
 260         } else {
 261             self.pkgname.clone()
 262         }
 263     }
 264
 265     fn non_bare_args(&self, cmd: &mut Command) {
 266         cmd.arg("--rel-manifest-dir=rustlib")
 267             .arg("--legacy-manifest-dirs=rustlib,cargo")
 268             .arg(format!("--product-name={}", self.product_name))
 269             .arg(format!("--success-message={} installed.", self.component))
 270             .arg(format!("--package-name={}", self.package_name()))
 271             .arg("--non-installed-overlay")
 272             .arg(&self.overlay_dir)
 273             .arg("--output-dir")
 274             .arg(crate::dist::distdir(self.builder));
 275     }
 276
 277     fn run(self, build_cli: impl FnOnce(&Tarball<'a>, &mut Command)) -> GeneratedTarball {
 278         t!(std::fs::create_dir_all(&self.overlay_dir));
 279         self.builder.create(&self.overlay_dir.join("version"), &self.overlay.version(self.builder));
 280         if let Some(sha) = self.builder.rust_sha() {
 281             self.builder.create(&self.overlay_dir.join("git-commit-hash"), &sha);
 282         }
 283         for file in self.overlay.legal_and_readme() {
 284             self.builder.install(&self.builder.src.join(file), &self.overlay_dir, 0o644);
 285         }
 286
 287         let mut cmd = self.builder.tool_cmd(crate::tool::Tool::RustInstaller);
 288
 289         let package_name = self.package_name();
 290         self.builder.info(&format!("Dist {}", package_name));
 291         let _time = crate::util::timeit(self.builder);
 292
 293         build_cli(&self, &mut cmd);
 294         cmd.arg("--work-dir").arg(&self.temp_dir);
 295         if let Some(formats) = &self.builder.config.dist_compression_formats {
 296             assert!(!formats.is_empty(), "dist.compression-formats can't be empty");
 297             cmd.arg("--compression-formats").arg(formats.join(","));
 298         }
 299         self.builder.run(&mut cmd);
 300
 301         // Use either the first compression format defined, or "gz" as the default.
 302         let ext = self
 303             .builder
 304             .config
 305             .dist_compression_formats
 306             .as_ref()
 307             .and_then(|formats| formats.get(0))
 308             .map(|s| s.as_str())
 309             .unwrap_or("gz");
 310
 311         GeneratedTarball {
 312             path: crate::dist::distdir(self.builder).join(format!("{}.tar.{}", package_name, ext)),
 313             decompressed_output: self.temp_dir.join(package_name),
 314             work: self.temp_dir,
 315         }
 316     }
 317 }
 318
 319 #[derive(Debug, Clone)]
 320 pub struct GeneratedTarball {
 321     path: PathBuf,
 322     decompressed_output: PathBuf,
 323     work: PathBuf,
 324 }
 325
 326 impl GeneratedTarball {
 327     pub(crate) fn tarball(&self) -> &Path {
 328         &self.path
 329     }
 330
 331     pub(crate) fn decompressed_output(&self) -> &Path {
 332         &self.decompressed_output
 333     }
 334
 335     pub(crate) fn work_dir(&self) -> &Path {
 336         &self.work
 337     }
 338 }