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,
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,
141 include_target_in_component_name: false,
146 pub(crate) fn set_overlay(&mut self, overlay: OverlayKind) {
147 self.overlay = overlay;
150 pub(crate) fn set_product_name(&mut self, name: &str) {
151 self.product_name = name.into();
154 pub(crate) fn include_target_in_component_name(&mut self, include: bool) {
155 self.include_target_in_component_name = include;
158 pub(crate) fn is_preview(&mut self, is: bool) {
159 self.is_preview = is;
162 pub(crate) fn image_dir(&self) -> &Path {
163 t!(std::fs::create_dir_all(&self.image_dir));
167 pub(crate) fn add_file(&self, src: impl AsRef<Path>, destdir: impl AsRef<Path>, perms: u32) {
168 // create_dir_all fails to create `foo/bar/.`, so when the destination is "." this simply
169 // uses the base directory as the destination directory.
170 let destdir = if destdir.as_ref() == Path::new(".") {
171 self.image_dir.clone()
173 self.image_dir.join(destdir.as_ref())
176 t!(std::fs::create_dir_all(&destdir));
177 self.builder.install(src.as_ref(), &destdir, perms);
180 pub(crate) fn add_renamed_file(
182 src: impl AsRef<Path>,
183 destdir: impl AsRef<Path>,
186 let destdir = self.image_dir.join(destdir.as_ref());
187 t!(std::fs::create_dir_all(&destdir));
188 self.builder.copy(src.as_ref(), &destdir.join(new_name));
191 pub(crate) fn add_legal_and_readme_to(&self, destdir: impl AsRef<Path>) {
192 for file in self.overlay.legal_and_readme() {
193 self.add_file(self.builder.src.join(file), destdir.as_ref(), 0o644);
197 pub(crate) fn add_dir(&self, src: impl AsRef<Path>, dest: impl AsRef<Path>) {
198 let dest = self.image_dir.join(dest.as_ref());
200 t!(std::fs::create_dir_all(&dest));
201 self.builder.cp_r(src.as_ref(), &dest);
204 pub(crate) fn generate(self) -> GeneratedTarball {
205 let mut component_name = self.component.clone();
207 component_name.push_str("-preview");
209 if self.include_target_in_component_name {
210 component_name.push('-');
211 component_name.push_str(
215 .expect("include_target_in_component_name used in a targetless tarball"),
219 self.run(|this, cmd| {
222 .arg(&this.image_dir)
223 .arg(format!("--component-name={}", &component_name));
224 this.non_bare_args(cmd);
228 pub(crate) fn combine(self, tarballs: &[GeneratedTarball]) -> GeneratedTarball {
229 let mut input_tarballs = tarballs[0].path.as_os_str().to_os_string();
230 for tarball in &tarballs[1..] {
231 input_tarballs.push(",");
232 input_tarballs.push(&tarball.path);
235 self.run(|this, cmd| {
236 cmd.arg("combine").arg("--input-tarballs").arg(input_tarballs);
237 this.non_bare_args(cmd);
241 pub(crate) fn bare(self) -> GeneratedTarball {
242 // Bare tarballs should have the top level directory match the package
243 // name, not "image". We rename the image directory just before passing
244 // into rust-installer.
245 let dest = self.temp_dir.join(self.package_name());
246 t!(std::fs::rename(&self.image_dir, &dest));
248 self.run(|this, cmd| {
253 .arg(crate::dist::distdir(this.builder).join(this.package_name()));
257 fn package_name(&self) -> String {
258 if let Some(target) = &self.target {
259 format!("{}-{}", self.pkgname, target)
265 fn non_bare_args(&self, cmd: &mut Command) {
266 cmd.arg("--rel-manifest-dir=rustlib")
267 .arg("--legacy-manifest-dirs=rustlib,cargo")
268 .arg(format!("--product-name={}", self.product_name))
269 .arg(format!("--success-message={} installed.", self.component))
270 .arg(format!("--package-name={}", self.package_name()))
271 .arg("--non-installed-overlay")
272 .arg(&self.overlay_dir)
274 .arg(crate::dist::distdir(self.builder));
277 fn run(self, build_cli: impl FnOnce(&Tarball<'a>, &mut Command)) -> GeneratedTarball {
278 t!(std::fs::create_dir_all(&self.overlay_dir));
279 self.builder.create(&self.overlay_dir.join("version"), &self.overlay.version(self.builder));
280 if let Some(sha) = self.builder.rust_sha() {
281 self.builder.create(&self.overlay_dir.join("git-commit-hash"), &sha);
283 for file in self.overlay.legal_and_readme() {
284 self.builder.install(&self.builder.src.join(file), &self.overlay_dir, 0o644);
287 let mut cmd = self.builder.tool_cmd(crate::tool::Tool::RustInstaller);
289 let package_name = self.package_name();
290 self.builder.info(&format!("Dist {}", package_name));
291 let _time = crate::util::timeit(self.builder);
293 build_cli(&self, &mut cmd);
294 cmd.arg("--work-dir").arg(&self.temp_dir);
295 if let Some(formats) = &self.builder.config.dist_compression_formats {
296 assert!(!formats.is_empty(), "dist.compression-formats can't be empty");
297 cmd.arg("--compression-formats").arg(formats.join(","));
299 self.builder.run(&mut cmd);
301 // Use either the first compression format defined, or "gz" as the default.
305 .dist_compression_formats
307 .and_then(|formats| formats.get(0))
312 path: crate::dist::distdir(self.builder).join(format!("{}.tar.{}", package_name, ext)),
313 decompressed_output: self.temp_dir.join(package_name),
319 #[derive(Debug, Clone)]
320 pub struct GeneratedTarball {
322 decompressed_output: PathBuf,
326 impl GeneratedTarball {
327 pub(crate) fn tarball(&self) -> &Path {
331 pub(crate) fn decompressed_output(&self) -> &Path {
332 &self.decompressed_output
335 pub(crate) fn work_dir(&self) -> &Path {