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,
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()))
112 pub(crate) fn new_targetless(builder: &'a Builder<'a>, component: &str) -> Self {
113 Self::new_inner(builder, component, None)
116 fn new_inner(builder: &'a Builder<'a>, component: &str, target: Option<String>) -> Self {
117 let pkgname = crate::dist::pkgname(builder, component);
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);
123 let _ = std::fs::remove_dir_all(&temp_dir);
125 let image_dir = temp_dir.join("image");
126 let overlay_dir = temp_dir.join("overlay");
132 component: component.into(),
134 product_name: "Rust".into(),
135 overlay: OverlayKind::Rust,
140 bulk_dirs: Vec::new(),
142 include_target_in_component_name: false,
147 pub(crate) fn set_overlay(&mut self, overlay: OverlayKind) {
148 self.overlay = overlay;
151 pub(crate) fn set_product_name(&mut self, name: &str) {
152 self.product_name = name.into();
155 pub(crate) fn include_target_in_component_name(&mut self, include: bool) {
156 self.include_target_in_component_name = include;
159 pub(crate) fn is_preview(&mut self, is: bool) {
160 self.is_preview = is;
163 pub(crate) fn image_dir(&self) -> &Path {
164 t!(std::fs::create_dir_all(&self.image_dir));
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()
174 self.image_dir.join(destdir.as_ref())
177 t!(std::fs::create_dir_all(&destdir));
178 self.builder.install(src.as_ref(), &destdir, perms);
181 pub(crate) fn add_renamed_file(
183 src: impl AsRef<Path>,
184 destdir: impl AsRef<Path>,
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));
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);
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());
201 t!(std::fs::create_dir_all(&dest));
202 self.builder.cp_r(src.as_ref(), &dest);
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);
210 pub(crate) fn generate(self) -> GeneratedTarball {
211 let mut component_name = self.component.clone();
213 component_name.push_str("-preview");
215 if self.include_target_in_component_name {
216 component_name.push('-');
217 component_name.push_str(
221 .expect("include_target_in_component_name used in a targetless tarball"),
225 self.run(|this, cmd| {
228 .arg(&this.image_dir)
229 .arg(format!("--component-name={}", &component_name));
231 if let Some((dir, dirs)) = this.bulk_dirs.split_first() {
232 let mut arg = dir.as_os_str().to_os_string();
237 cmd.arg("--bulk-dirs").arg(&arg);
240 this.non_bare_args(cmd);
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);
251 self.run(|this, cmd| {
252 cmd.arg("combine").arg("--input-tarballs").arg(input_tarballs);
253 this.non_bare_args(cmd);
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));
264 self.run(|this, cmd| {
265 let distdir = crate::dist::distdir(this.builder);
266 t!(std::fs::create_dir_all(&distdir));
271 .arg(distdir.join(this.package_name()));
275 fn package_name(&self) -> String {
276 if let Some(target) = &self.target {
277 format!("{}-{}", self.pkgname, target)
283 fn non_bare_args(&self, cmd: &mut Command) {
284 cmd.arg("--rel-manifest-dir=rustlib")
285 .arg("--legacy-manifest-dirs=rustlib,cargo")
286 .arg(format!("--product-name={}", self.product_name))
287 .arg(format!("--success-message={} installed.", self.component))
288 .arg(format!("--package-name={}", self.package_name()))
289 .arg("--non-installed-overlay")
290 .arg(&self.overlay_dir)
292 .arg(crate::dist::distdir(self.builder));
295 fn run(self, build_cli: impl FnOnce(&Tarball<'a>, &mut Command)) -> GeneratedTarball {
296 t!(std::fs::create_dir_all(&self.overlay_dir));
297 self.builder.create(&self.overlay_dir.join("version"), &self.overlay.version(self.builder));
298 if let Some(sha) = self.builder.rust_sha() {
299 self.builder.create(&self.overlay_dir.join("git-commit-hash"), &sha);
301 for file in self.overlay.legal_and_readme() {
302 self.builder.install(&self.builder.src.join(file), &self.overlay_dir, 0o644);
305 let mut cmd = self.builder.tool_cmd(crate::tool::Tool::RustInstaller);
307 let package_name = self.package_name();
308 self.builder.info(&format!("Dist {}", package_name));
309 let _time = crate::util::timeit(self.builder);
311 build_cli(&self, &mut cmd);
312 cmd.arg("--work-dir").arg(&self.temp_dir);
313 if let Some(formats) = &self.builder.config.dist_compression_formats {
314 assert!(!formats.is_empty(), "dist.compression-formats can't be empty");
315 cmd.arg("--compression-formats").arg(formats.join(","));
317 self.builder.run(&mut cmd);
319 // Use either the first compression format defined, or "gz" as the default.
323 .dist_compression_formats
325 .and_then(|formats| formats.get(0))
330 path: crate::dist::distdir(self.builder).join(format!("{}.tar.{}", package_name, ext)),
331 decompressed_output: self.temp_dir.join(package_name),
337 #[derive(Debug, Clone)]
338 pub struct GeneratedTarball {
340 decompressed_output: PathBuf,
344 impl GeneratedTarball {
345 pub(crate) fn tarball(&self) -> &Path {
349 pub(crate) fn decompressed_output(&self) -> &Path {
350 &self.decompressed_output
353 pub(crate) fn work_dir(&self) -> &Path {