6 use crate::builder::Builder;
10 pub(crate) enum OverlayKind {
23 fn legal_and_readme(&self) -> &[&str] {
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"]
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",
35 OverlayKind::Clippy => &[
36 "src/tools/clippy/README.md",
37 "src/tools/clippy/LICENSE-APACHE",
38 "src/tools/clippy/LICENSE-MIT",
40 OverlayKind::Miri => &[
41 "src/tools/miri/README.md",
42 "src/tools/miri/LICENSE-APACHE",
43 "src/tools/miri/LICENSE-MIT",
45 OverlayKind::Rustfmt => &[
46 "src/tools/rustfmt/README.md",
47 "src/tools/rustfmt/LICENSE-APACHE",
48 "src/tools/rustfmt/LICENSE-MIT",
50 OverlayKind::RustDemangler => {
51 &["src/tools/rust-demangler/README.md", "LICENSE-APACHE", "LICENSE-MIT"]
53 OverlayKind::RLS => &[
54 "src/tools/rls/README.md",
55 "src/tools/rls/LICENSE-APACHE",
56 "src/tools/rls/LICENSE-MIT",
58 OverlayKind::RustAnalyzer => &[
59 "src/tools/rust-analyzer/README.md",
60 "src/tools/rust-analyzer/LICENSE-APACHE",
61 "src/tools/rust-analyzer/LICENSE-MIT",
66 fn version(&self, builder: &Builder<'_>) -> String {
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"))
74 OverlayKind::Clippy => {
75 builder.clippy_info.version(builder, &builder.release_num("clippy"))
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"))
81 OverlayKind::RLS => builder.rls_info.version(builder, &builder.release_num("rls")),
82 OverlayKind::RustAnalyzer => builder
84 .version(builder, &builder.release_num("rust-analyzer/crates/rust-analyzer")),
89 pub(crate) struct Tarball<'a> {
90 builder: &'a Builder<'a>,
94 target: Option<String>,
100 overlay_dir: PathBuf,
101 bulk_dirs: Vec<PathBuf>,
103 include_target_in_component_name: bool,
105 permit_symlinks: bool,
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()))
113 pub(crate) fn new_targetless(builder: &'a Builder<'a>, component: &str) -> Self {
114 Self::new_inner(builder, component, None)
117 fn new_inner(builder: &'a Builder<'a>, component: &str, target: Option<String>) -> Self {
118 let pkgname = crate::dist::pkgname(builder, component);
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);
124 let _ = std::fs::remove_dir_all(&temp_dir);
126 let image_dir = temp_dir.join("image");
127 let overlay_dir = temp_dir.join("overlay");
133 component: component.into(),
135 product_name: "Rust".into(),
136 overlay: OverlayKind::Rust,
141 bulk_dirs: Vec::new(),
143 include_target_in_component_name: false,
145 permit_symlinks: false,
149 pub(crate) fn set_overlay(&mut self, overlay: OverlayKind) {
150 self.overlay = overlay;
153 pub(crate) fn set_product_name(&mut self, name: &str) {
154 self.product_name = name.into();
157 pub(crate) fn include_target_in_component_name(&mut self, include: bool) {
158 self.include_target_in_component_name = include;
161 pub(crate) fn is_preview(&mut self, is: bool) {
162 self.is_preview = is;
165 pub(crate) fn permit_symlinks(&mut self, flag: bool) {
166 self.permit_symlinks = flag;
169 pub(crate) fn image_dir(&self) -> &Path {
170 t!(std::fs::create_dir_all(&self.image_dir));
174 pub(crate) fn add_file(&self, src: impl AsRef<Path>, destdir: impl AsRef<Path>, perms: u32) {
175 // create_dir_all fails to create `foo/bar/.`, so when the destination is "." this simply
176 // uses the base directory as the destination directory.
177 let destdir = if destdir.as_ref() == Path::new(".") {
178 self.image_dir.clone()
180 self.image_dir.join(destdir.as_ref())
183 t!(std::fs::create_dir_all(&destdir));
184 self.builder.install(src.as_ref(), &destdir, perms);
187 pub(crate) fn add_renamed_file(
189 src: impl AsRef<Path>,
190 destdir: impl AsRef<Path>,
193 let destdir = self.image_dir.join(destdir.as_ref());
194 t!(std::fs::create_dir_all(&destdir));
195 self.builder.copy(src.as_ref(), &destdir.join(new_name));
198 pub(crate) fn add_legal_and_readme_to(&self, destdir: impl AsRef<Path>) {
199 for file in self.overlay.legal_and_readme() {
200 self.add_file(self.builder.src.join(file), destdir.as_ref(), 0o644);
204 pub(crate) fn add_dir(&self, src: impl AsRef<Path>, dest: impl AsRef<Path>) {
205 let dest = self.image_dir.join(dest.as_ref());
207 t!(std::fs::create_dir_all(&dest));
208 self.builder.cp_r(src.as_ref(), &dest);
211 pub(crate) fn add_bulk_dir(&mut self, src: impl AsRef<Path>, dest: impl AsRef<Path>) {
212 self.bulk_dirs.push(dest.as_ref().to_path_buf());
213 self.add_dir(src, dest);
216 pub(crate) fn generate(self) -> GeneratedTarball {
217 let mut component_name = self.component.clone();
219 component_name.push_str("-preview");
221 if self.include_target_in_component_name {
222 component_name.push('-');
223 component_name.push_str(
227 .expect("include_target_in_component_name used in a targetless tarball"),
231 self.run(|this, cmd| {
234 .arg(&this.image_dir)
235 .arg(format!("--component-name={}", &component_name));
237 if let Some((dir, dirs)) = this.bulk_dirs.split_first() {
238 let mut arg = dir.as_os_str().to_os_string();
243 cmd.arg("--bulk-dirs").arg(&arg);
246 this.non_bare_args(cmd);
250 pub(crate) fn combine(self, tarballs: &[GeneratedTarball]) -> GeneratedTarball {
251 let mut input_tarballs = tarballs[0].path.as_os_str().to_os_string();
252 for tarball in &tarballs[1..] {
253 input_tarballs.push(",");
254 input_tarballs.push(&tarball.path);
257 self.run(|this, cmd| {
258 cmd.arg("combine").arg("--input-tarballs").arg(input_tarballs);
259 this.non_bare_args(cmd);
263 pub(crate) fn bare(self) -> GeneratedTarball {
264 // Bare tarballs should have the top level directory match the package
265 // name, not "image". We rename the image directory just before passing
266 // into rust-installer.
267 let dest = self.temp_dir.join(self.package_name());
268 t!(std::fs::rename(&self.image_dir, &dest));
270 self.run(|this, cmd| {
271 let distdir = crate::dist::distdir(this.builder);
272 t!(std::fs::create_dir_all(&distdir));
277 .arg(distdir.join(this.package_name()));
281 fn package_name(&self) -> String {
282 if let Some(target) = &self.target {
283 format!("{}-{}", self.pkgname, target)
289 fn non_bare_args(&self, cmd: &mut Command) {
290 cmd.arg("--rel-manifest-dir=rustlib")
291 .arg("--legacy-manifest-dirs=rustlib,cargo")
292 .arg(format!("--product-name={}", self.product_name))
293 .arg(format!("--success-message={} installed.", self.component))
294 .arg(format!("--package-name={}", self.package_name()))
295 .arg("--non-installed-overlay")
296 .arg(&self.overlay_dir)
298 .arg(crate::dist::distdir(self.builder));
301 fn run(self, build_cli: impl FnOnce(&Tarball<'a>, &mut Command)) -> GeneratedTarball {
302 t!(std::fs::create_dir_all(&self.overlay_dir));
303 self.builder.create(&self.overlay_dir.join("version"), &self.overlay.version(self.builder));
304 if let Some(sha) = self.builder.rust_sha() {
305 self.builder.create(&self.overlay_dir.join("git-commit-hash"), &sha);
307 for file in self.overlay.legal_and_readme() {
308 self.builder.install(&self.builder.src.join(file), &self.overlay_dir, 0o644);
311 let mut cmd = self.builder.tool_cmd(crate::tool::Tool::RustInstaller);
313 let package_name = self.package_name();
314 self.builder.info(&format!("Dist {}", package_name));
315 let _time = crate::util::timeit(self.builder);
317 build_cli(&self, &mut cmd);
318 cmd.arg("--work-dir").arg(&self.temp_dir);
319 if let Some(formats) = &self.builder.config.dist_compression_formats {
320 assert!(!formats.is_empty(), "dist.compression-formats can't be empty");
321 cmd.arg("--compression-formats").arg(formats.join(","));
323 self.builder.run(&mut cmd);
325 // Ensure there are no symbolic links in the tarball. In particular,
326 // rustup-toolchain-install-master and most versions of Windows can't handle symbolic links.
327 let decompressed_output = self.temp_dir.join(&package_name);
328 if !self.builder.config.dry_run && !self.permit_symlinks {
329 for entry in walkdir::WalkDir::new(&decompressed_output) {
330 let entry = t!(entry);
331 if entry.path_is_symlink() {
332 panic!("generated a symlink in a tarball: {}", entry.path().display());
337 // Use either the first compression format defined, or "gz" as the default.
341 .dist_compression_formats
343 .and_then(|formats| formats.get(0))
348 path: crate::dist::distdir(self.builder).join(format!("{}.tar.{}", package_name, ext)),
355 #[derive(Debug, Clone)]
356 pub struct GeneratedTarball {
358 decompressed_output: PathBuf,
362 impl GeneratedTarball {
363 pub(crate) fn tarball(&self) -> &Path {
367 pub(crate) fn decompressed_output(&self) -> &Path {
368 &self.decompressed_output
371 pub(crate) fn work_dir(&self) -> &Path {