8 use crate::builder::Builder;
10 #[derive(Copy, Clone)]
11 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::RLS => &[
51 "src/tools/rls/README.md",
52 "src/tools/rls/LICENSE-APACHE",
53 "src/tools/rls/LICENSE-MIT",
55 OverlayKind::RustAnalyzer => &[
56 "src/tools/rust-analyzer/README.md",
57 "src/tools/rust-analyzer/LICENSE-APACHE",
58 "src/tools/rust-analyzer/LICENSE-MIT",
63 fn version(&self, builder: &Builder<'_>) -> String {
65 OverlayKind::Rust => builder.rust_version(),
66 OverlayKind::LLVM => builder.rust_version(),
67 OverlayKind::Cargo => {
68 builder.cargo_info.version(builder, &builder.release_num("cargo"))
70 OverlayKind::Clippy => {
71 builder.clippy_info.version(builder, &builder.release_num("clippy"))
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"))
77 OverlayKind::RLS => builder.rls_info.version(builder, &builder.release_num("rls")),
78 OverlayKind::RustAnalyzer => builder
80 .version(builder, &builder.release_num("rust-analyzer/crates/rust-analyzer")),
85 pub(crate) struct Tarball<'a> {
86 builder: &'a Builder<'a>,
90 target: Option<String>,
98 include_target_in_component_name: bool,
102 impl<'a> Tarball<'a> {
103 pub(crate) fn new(builder: &'a Builder<'a>, component: &str, target: &str) -> Self {
104 Self::new_inner(builder, component, Some(target.into()))
107 pub(crate) fn new_targetless(builder: &'a Builder<'a>, component: &str) -> Self {
108 Self::new_inner(builder, component, None)
111 fn new_inner(builder: &'a Builder<'a>, component: &str, target: Option<String>) -> Self {
112 let pkgname = crate::dist::pkgname(builder, component);
114 let mut temp_dir = builder.out.join("tmp").join("tarball").join(component);
115 if let Some(target) = &target {
116 temp_dir = temp_dir.join(target);
118 let _ = std::fs::remove_dir_all(&temp_dir);
120 let image_dir = temp_dir.join("image");
121 let overlay_dir = temp_dir.join("overlay");
127 component: component.into(),
129 product_name: "Rust".into(),
130 overlay: OverlayKind::Rust,
136 include_target_in_component_name: false,
141 pub(crate) fn set_overlay(&mut self, overlay: OverlayKind) {
142 self.overlay = overlay;
145 pub(crate) fn set_product_name(&mut self, name: &str) {
146 self.product_name = name.into();
149 pub(crate) fn include_target_in_component_name(&mut self, include: bool) {
150 self.include_target_in_component_name = include;
153 pub(crate) fn is_preview(&mut self, is: bool) {
154 self.is_preview = is;
157 pub(crate) fn image_dir(&self) -> &Path {
158 t!(std::fs::create_dir_all(&self.image_dir));
162 pub(crate) fn add_file(&self, src: impl AsRef<Path>, destdir: impl AsRef<Path>, perms: u32) {
163 // create_dir_all fails to create `foo/bar/.`, so when the destination is "." this simply
164 // uses the base directory as the destination directory.
165 let destdir = if destdir.as_ref() == Path::new(".") {
166 self.image_dir.clone()
168 self.image_dir.join(destdir.as_ref())
171 t!(std::fs::create_dir_all(&destdir));
172 self.builder.install(src.as_ref(), &destdir, perms);
175 pub(crate) fn add_renamed_file(
177 src: impl AsRef<Path>,
178 destdir: impl AsRef<Path>,
181 let destdir = self.image_dir.join(destdir.as_ref());
182 t!(std::fs::create_dir_all(&destdir));
183 self.builder.copy(src.as_ref(), &destdir.join(new_name));
186 pub(crate) fn add_legal_and_readme_to(&self, destdir: impl AsRef<Path>) {
187 for file in self.overlay.legal_and_readme() {
188 self.add_file(self.builder.src.join(file), destdir.as_ref(), 0o644);
192 pub(crate) fn add_dir(&self, src: impl AsRef<Path>, dest: impl AsRef<Path>) {
193 let dest = self.image_dir.join(dest.as_ref());
195 t!(std::fs::create_dir_all(&dest));
196 self.builder.cp_r(src.as_ref(), &dest);
199 pub(crate) fn generate(self) -> GeneratedTarball {
200 let mut component_name = self.component.clone();
202 component_name.push_str("-preview");
204 if self.include_target_in_component_name {
205 component_name.push('-');
206 component_name.push_str(
210 .expect("include_target_in_component_name used in a targetless tarball"),
214 self.run(|this, cmd| {
217 .arg(&this.image_dir)
218 .arg(format!("--component-name={}", &component_name));
219 this.non_bare_args(cmd);
223 pub(crate) fn combine(self, tarballs: &[GeneratedTarball]) -> GeneratedTarball {
224 let mut input_tarballs = tarballs[0].path.as_os_str().to_os_string();
225 for tarball in &tarballs[1..] {
226 input_tarballs.push(",");
227 input_tarballs.push(&tarball.path);
230 self.run(|this, cmd| {
231 cmd.arg("combine").arg("--input-tarballs").arg(input_tarballs);
232 this.non_bare_args(cmd);
236 pub(crate) fn bare(self) -> GeneratedTarball {
237 // Bare tarballs should have the top level directory match the package
238 // name, not "image". We rename the image directory just before passing
239 // into rust-installer.
240 let dest = self.temp_dir.join(self.package_name());
241 t!(std::fs::rename(&self.image_dir, &dest));
243 self.run(|this, cmd| {
248 .arg(crate::dist::distdir(this.builder).join(this.package_name()));
252 fn package_name(&self) -> String {
253 if let Some(target) = &self.target {
254 format!("{}-{}", self.pkgname, target)
260 fn non_bare_args(&self, cmd: &mut Command) {
261 cmd.arg("--rel-manifest-dir=rustlib")
262 .arg("--legacy-manifest-dirs=rustlib,cargo")
263 .arg(format!("--product-name={}", self.product_name))
264 .arg(format!("--success-message={} installed.", self.component))
265 .arg(format!("--package-name={}", self.package_name()))
266 .arg("--non-installed-overlay")
267 .arg(&self.overlay_dir)
269 .arg(crate::dist::distdir(self.builder));
272 fn run(self, build_cli: impl FnOnce(&Tarball<'a>, &mut Command)) -> GeneratedTarball {
273 t!(std::fs::create_dir_all(&self.overlay_dir));
274 self.builder.create(&self.overlay_dir.join("version"), &self.overlay.version(self.builder));
275 if let Some(sha) = self.builder.rust_sha() {
276 self.builder.create(&self.overlay_dir.join("git-commit-hash"), &sha);
278 for file in self.overlay.legal_and_readme() {
279 self.builder.install(&self.builder.src.join(file), &self.overlay_dir, 0o644);
282 let mut cmd = self.builder.tool_cmd(crate::tool::Tool::RustInstaller);
284 let package_name = self.package_name();
285 self.builder.info(&format!("Dist {}", package_name));
286 let _time = crate::util::timeit(self.builder);
288 build_cli(&self, &mut cmd);
289 cmd.arg("--work-dir").arg(&self.temp_dir);
290 if let Some(formats) = &self.builder.config.dist_compression_formats {
291 assert!(!formats.is_empty(), "dist.compression-formats can't be empty");
292 cmd.arg("--compression-formats").arg(formats.join(","));
294 self.builder.run(&mut cmd);
296 // Use either the first compression format defined, or "gz" as the default.
300 .dist_compression_formats
302 .and_then(|formats| formats.get(0))
307 path: crate::dist::distdir(self.builder).join(format!("{}.tar.{}", package_name, ext)),
308 decompressed_output: self.temp_dir.join(package_name),
314 #[derive(Debug, Clone)]
315 pub struct GeneratedTarball {
317 decompressed_output: PathBuf,
321 impl GeneratedTarball {
322 pub(crate) fn tarball(&self) -> &Path {
326 pub(crate) fn decompressed_output(&self) -> &Path {
327 &self.decompressed_output
330 pub(crate) fn work_dir(&self) -> &Path {