8 use crate::builder::Builder;
10 #[derive(Copy, Clone)]
11 pub(crate) enum OverlayKind {
24 fn legal_and_readme(&self) -> &[&str] {
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"]
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",
36 OverlayKind::Clippy => &[
37 "src/tools/clippy/README.md",
38 "src/tools/clippy/LICENSE-APACHE",
39 "src/tools/clippy/LICENSE-MIT",
41 OverlayKind::Miri => &[
42 "src/tools/miri/README.md",
43 "src/tools/miri/LICENSE-APACHE",
44 "src/tools/miri/LICENSE-MIT",
46 OverlayKind::Rustfmt => &[
47 "src/tools/rustfmt/README.md",
48 "src/tools/rustfmt/LICENSE-APACHE",
49 "src/tools/rustfmt/LICENSE-MIT",
51 OverlayKind::RustDemangler => {
52 &["src/tools/rust-demangler/README.md", "LICENSE-APACHE", "LICENSE-MIT"]
54 OverlayKind::RLS => &[
55 "src/tools/rls/README.md",
56 "src/tools/rls/LICENSE-APACHE",
57 "src/tools/rls/LICENSE-MIT",
59 OverlayKind::RustAnalyzer => &[
60 "src/tools/rust-analyzer/README.md",
61 "src/tools/rust-analyzer/LICENSE-APACHE",
62 "src/tools/rust-analyzer/LICENSE-MIT",
67 fn version(&self, builder: &Builder<'_>) -> String {
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"))
75 OverlayKind::Clippy => {
76 builder.clippy_info.version(builder, &builder.release_num("clippy"))
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"))
82 OverlayKind::RLS => builder.rls_info.version(builder, &builder.release_num("rls")),
83 OverlayKind::RustAnalyzer => builder
85 .version(builder, &builder.release_num("rust-analyzer/crates/rust-analyzer")),
90 pub(crate) struct Tarball<'a> {
91 builder: &'a Builder<'a>,
95 target: Option<String>,
101 overlay_dir: PathBuf,
102 bulk_dirs: Vec<PathBuf>,
104 include_target_in_component_name: 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,
148 pub(crate) fn set_overlay(&mut self, overlay: OverlayKind) {
149 self.overlay = overlay;
152 pub(crate) fn set_product_name(&mut self, name: &str) {
153 self.product_name = name.into();
156 pub(crate) fn include_target_in_component_name(&mut self, include: bool) {
157 self.include_target_in_component_name = include;
160 pub(crate) fn is_preview(&mut self, is: bool) {
161 self.is_preview = is;
164 pub(crate) fn image_dir(&self) -> &Path {
165 t!(std::fs::create_dir_all(&self.image_dir));
169 pub(crate) fn add_file(&self, src: impl AsRef<Path>, destdir: impl AsRef<Path>, perms: u32) {
170 // create_dir_all fails to create `foo/bar/.`, so when the destination is "." this simply
171 // uses the base directory as the destination directory.
172 let destdir = if destdir.as_ref() == Path::new(".") {
173 self.image_dir.clone()
175 self.image_dir.join(destdir.as_ref())
178 t!(std::fs::create_dir_all(&destdir));
179 self.builder.install(src.as_ref(), &destdir, perms);
182 pub(crate) fn add_renamed_file(
184 src: impl AsRef<Path>,
185 destdir: impl AsRef<Path>,
188 let destdir = self.image_dir.join(destdir.as_ref());
189 t!(std::fs::create_dir_all(&destdir));
190 self.builder.copy(src.as_ref(), &destdir.join(new_name));
193 pub(crate) fn add_legal_and_readme_to(&self, destdir: impl AsRef<Path>) {
194 for file in self.overlay.legal_and_readme() {
195 self.add_file(self.builder.src.join(file), destdir.as_ref(), 0o644);
199 pub(crate) fn add_dir(&self, src: impl AsRef<Path>, dest: impl AsRef<Path>) {
200 let dest = self.image_dir.join(dest.as_ref());
202 t!(std::fs::create_dir_all(&dest));
203 self.builder.cp_r(src.as_ref(), &dest);
206 pub(crate) fn add_bulk_dir(&mut self, src: impl AsRef<Path>, dest: impl AsRef<Path>) {
207 self.bulk_dirs.push(dest.as_ref().to_path_buf());
208 self.add_dir(src, dest);
211 pub(crate) fn generate(self) -> GeneratedTarball {
212 let mut component_name = self.component.clone();
214 component_name.push_str("-preview");
216 if self.include_target_in_component_name {
217 component_name.push('-');
218 component_name.push_str(
222 .expect("include_target_in_component_name used in a targetless tarball"),
226 self.run(|this, cmd| {
229 .arg(&this.image_dir)
230 .arg(format!("--component-name={}", &component_name));
232 if let Some((dir, dirs)) = this.bulk_dirs.split_first() {
233 let mut arg = dir.as_os_str().to_os_string();
238 cmd.arg("--bulk-dirs").arg(&arg);
241 this.non_bare_args(cmd);
245 pub(crate) fn combine(self, tarballs: &[GeneratedTarball]) -> GeneratedTarball {
246 let mut input_tarballs = tarballs[0].path.as_os_str().to_os_string();
247 for tarball in &tarballs[1..] {
248 input_tarballs.push(",");
249 input_tarballs.push(&tarball.path);
252 self.run(|this, cmd| {
253 cmd.arg("combine").arg("--input-tarballs").arg(input_tarballs);
254 this.non_bare_args(cmd);
258 pub(crate) fn bare(self) -> GeneratedTarball {
259 // Bare tarballs should have the top level directory match the package
260 // name, not "image". We rename the image directory just before passing
261 // into rust-installer.
262 let dest = self.temp_dir.join(self.package_name());
263 t!(std::fs::rename(&self.image_dir, &dest));
265 self.run(|this, cmd| {
270 .arg(crate::dist::distdir(this.builder).join(this.package_name()));
274 fn package_name(&self) -> String {
275 if let Some(target) = &self.target {
276 format!("{}-{}", self.pkgname, target)
282 fn non_bare_args(&self, cmd: &mut Command) {
283 cmd.arg("--rel-manifest-dir=rustlib")
284 .arg("--legacy-manifest-dirs=rustlib,cargo")
285 .arg(format!("--product-name={}", self.product_name))
286 .arg(format!("--success-message={} installed.", self.component))
287 .arg(format!("--package-name={}", self.package_name()))
288 .arg("--non-installed-overlay")
289 .arg(&self.overlay_dir)
291 .arg(crate::dist::distdir(self.builder));
294 fn run(self, build_cli: impl FnOnce(&Tarball<'a>, &mut Command)) -> GeneratedTarball {
295 t!(std::fs::create_dir_all(&self.overlay_dir));
296 self.builder.create(&self.overlay_dir.join("version"), &self.overlay.version(self.builder));
297 if let Some(sha) = self.builder.rust_sha() {
298 self.builder.create(&self.overlay_dir.join("git-commit-hash"), &sha);
300 for file in self.overlay.legal_and_readme() {
301 self.builder.install(&self.builder.src.join(file), &self.overlay_dir, 0o644);
304 let mut cmd = self.builder.tool_cmd(crate::tool::Tool::RustInstaller);
306 let package_name = self.package_name();
307 self.builder.info(&format!("Dist {}", package_name));
308 let _time = crate::util::timeit(self.builder);
310 build_cli(&self, &mut cmd);
311 cmd.arg("--work-dir").arg(&self.temp_dir);
312 if let Some(formats) = &self.builder.config.dist_compression_formats {
313 assert!(!formats.is_empty(), "dist.compression-formats can't be empty");
314 cmd.arg("--compression-formats").arg(formats.join(","));
316 self.builder.run(&mut cmd);
318 // Use either the first compression format defined, or "gz" as the default.
322 .dist_compression_formats
324 .and_then(|formats| formats.get(0))
329 path: crate::dist::distdir(self.builder).join(format!("{}.tar.{}", package_name, ext)),
330 decompressed_output: self.temp_dir.join(package_name),
336 #[derive(Debug, Clone)]
337 pub struct GeneratedTarball {
339 decompressed_output: PathBuf,
343 impl GeneratedTarball {
344 pub(crate) fn tarball(&self) -> &Path {
348 pub(crate) fn decompressed_output(&self) -> &Path {
349 &self.decompressed_output
352 pub(crate) fn work_dir(&self) -> &Path {