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