1 //! Implementation of the various distribution aspects of the compiler.
3 //! This module is responsible for creating tarballs of the standard library,
4 //! compiler, and documentation. This ends up being what we distribute to
7 //! No tarball is actually created literally in this file, but rather we shell
8 //! out to `rust-installer` still. This may one day be replaced with bits and
9 //! pieces of `rustup.rs`!
11 use std::collections::HashSet;
14 use std::path::{Path, PathBuf};
15 use std::process::Command;
17 use build_helper::{output, t};
19 use crate::builder::{Builder, RunConfig, ShouldRun, Step};
20 use crate::cache::{Interned, INTERNER};
22 use crate::config::TargetSelection;
23 use crate::tarball::{GeneratedTarball, OverlayKind, Tarball};
24 use crate::tool::{self, Tool};
25 use crate::util::{exe, is_dylib, timeit};
26 use crate::{Compiler, DependencyType, Mode, LLVM_TOOLS};
27 use time::{self, Timespec};
29 pub fn pkgname(builder: &Builder<'_>, component: &str) -> String {
30 format!("{}-{}", component, builder.rust_package_vers())
33 pub(crate) fn distdir(builder: &Builder<'_>) -> PathBuf {
34 builder.out.join("dist")
37 pub fn tmpdir(builder: &Builder<'_>) -> PathBuf {
38 builder.out.join("tmp/dist")
41 fn missing_tool(tool_name: &str, skip: bool) {
43 println!("Unable to build {}, skipping dist", tool_name)
45 panic!("Unable to build {}", tool_name)
49 fn should_build_extended_tool(builder: &Builder<'_>, tool: &str) -> bool {
50 if !builder.config.extended {
53 builder.config.tools.as_ref().map_or(true, |tools| tools.contains(tool))
56 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
58 pub host: TargetSelection,
62 type Output = Option<GeneratedTarball>;
63 const DEFAULT: bool = true;
65 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
66 let default = run.builder.config.docs;
67 run.path("rust-docs").default_condition(default)
70 fn make_run(run: RunConfig<'_>) {
71 run.builder.ensure(Docs { host: run.target });
74 /// Builds the `rust-docs` installer component.
75 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
77 builder.default_doc(&[]);
79 let dest = "share/doc/rust/html";
81 let mut tarball = Tarball::new(builder, "rust-docs", &host.triple);
82 tarball.set_product_name("Rust Documentation");
83 tarball.add_bulk_dir(&builder.doc_out(host), dest);
84 tarball.add_file(&builder.src.join("src/doc/robots.txt"), dest, 0o644);
85 Some(tarball.generate())
89 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
90 pub struct RustcDocs {
91 pub host: TargetSelection,
94 impl Step for RustcDocs {
95 type Output = Option<GeneratedTarball>;
96 const DEFAULT: bool = true;
98 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
99 let builder = run.builder;
100 run.path("rustc-docs").default_condition(builder.config.compiler_docs)
103 fn make_run(run: RunConfig<'_>) {
104 run.builder.ensure(RustcDocs { host: run.target });
107 /// Builds the `rustc-docs` installer component.
108 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
109 let host = self.host;
110 builder.default_doc(&[]);
112 let mut tarball = Tarball::new(builder, "rustc-docs", &host.triple);
113 tarball.set_product_name("Rustc Documentation");
114 tarball.add_bulk_dir(&builder.compiler_doc_out(host), "share/doc/rust/html/rustc");
115 Some(tarball.generate())
119 fn find_files(files: &[&str], path: &[PathBuf]) -> Vec<PathBuf> {
120 let mut found = Vec::with_capacity(files.len());
123 let file_path = path.iter().map(|dir| dir.join(file)).find(|p| p.exists());
125 if let Some(file_path) = file_path {
126 found.push(file_path);
128 panic!("Could not find '{}' in {:?}", file, path);
138 target: TargetSelection,
139 builder: &Builder<'_>,
141 //Ask gcc where it keeps its stuff
142 let mut cmd = Command::new(builder.cc(target));
143 cmd.arg("-print-search-dirs");
144 let gcc_out = output(&mut cmd);
146 let mut bin_path: Vec<_> = env::split_paths(&env::var_os("PATH").unwrap_or_default()).collect();
147 let mut lib_path = Vec::new();
149 for line in gcc_out.lines() {
150 let idx = line.find(':').unwrap();
151 let key = &line[..idx];
152 let trim_chars: &[_] = &[' ', '='];
153 let value = env::split_paths(line[(idx + 1)..].trim_start_matches(trim_chars));
155 if key == "programs" {
156 bin_path.extend(value);
157 } else if key == "libraries" {
158 lib_path.extend(value);
162 let compiler = if target == "i686-pc-windows-gnu" {
163 "i686-w64-mingw32-gcc.exe"
164 } else if target == "x86_64-pc-windows-gnu" {
165 "x86_64-w64-mingw32-gcc.exe"
169 let target_tools = [compiler, "ld.exe", "dlltool.exe", "libwinpthread-1.dll"];
170 let mut rustc_dlls = vec!["libwinpthread-1.dll"];
171 if target.starts_with("i686-") {
172 rustc_dlls.push("libgcc_s_dw2-1.dll");
174 rustc_dlls.push("libgcc_s_seh-1.dll");
189 //Windows import libs
212 "libsynchronization.a",
223 //Find mingw artifacts we want to bundle
224 let target_tools = find_files(&target_tools, &bin_path);
225 let rustc_dlls = find_files(&rustc_dlls, &bin_path);
226 let target_libs = find_files(&target_libs, &lib_path);
228 // Copy runtime dlls next to rustc.exe
229 let dist_bin_dir = rust_root.join("bin/");
230 fs::create_dir_all(&dist_bin_dir).expect("creating dist_bin_dir failed");
231 for src in rustc_dlls {
232 builder.copy_to_folder(&src, &dist_bin_dir);
235 //Copy platform tools to platform-specific bin directory
236 let target_bin_dir = plat_root
241 .join("self-contained");
242 fs::create_dir_all(&target_bin_dir).expect("creating target_bin_dir failed");
243 for src in target_tools {
244 builder.copy_to_folder(&src, &target_bin_dir);
247 // Warn windows-gnu users that the bundled GCC cannot compile C files
249 &target_bin_dir.join("GCC-WARNING.txt"),
250 "gcc.exe contained in this folder cannot be used for compiling C files - it is only \
251 used as a linker. In order to be able to compile projects containing C code use \
252 the GCC provided by MinGW or Cygwin.",
255 //Copy platform libs to platform-specific lib directory
256 let target_lib_dir = plat_root
261 .join("self-contained");
262 fs::create_dir_all(&target_lib_dir).expect("creating target_lib_dir failed");
263 for src in target_libs {
264 builder.copy_to_folder(&src, &target_lib_dir);
268 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
270 pub host: TargetSelection,
273 impl Step for Mingw {
274 type Output = Option<GeneratedTarball>;
275 const DEFAULT: bool = true;
277 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
278 run.path("rust-mingw")
281 fn make_run(run: RunConfig<'_>) {
282 run.builder.ensure(Mingw { host: run.target });
285 /// Builds the `rust-mingw` installer component.
287 /// This contains all the bits and pieces to run the MinGW Windows targets
288 /// without any extra installed software (e.g., we bundle gcc, libraries, etc).
289 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
290 let host = self.host;
291 if !host.contains("pc-windows-gnu") {
295 let mut tarball = Tarball::new(builder, "rust-mingw", &host.triple);
296 tarball.set_product_name("Rust MinGW");
298 // The first argument is a "temporary directory" which is just
299 // thrown away (this contains the runtime DLLs included in the rustc package
300 // above) and the second argument is where to place all the MinGW components
301 // (which is what we want).
302 make_win_dist(&tmpdir(builder), tarball.image_dir(), host, &builder);
304 Some(tarball.generate())
308 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
310 pub compiler: Compiler,
313 impl Step for Rustc {
314 type Output = GeneratedTarball;
315 const DEFAULT: bool = true;
316 const ONLY_HOSTS: bool = true;
318 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
322 fn make_run(run: RunConfig<'_>) {
324 .ensure(Rustc { compiler: run.builder.compiler(run.builder.top_stage, run.target) });
327 /// Creates the `rustc` installer component.
328 fn run(self, builder: &Builder<'_>) -> GeneratedTarball {
329 let compiler = self.compiler;
330 let host = self.compiler.host;
332 let tarball = Tarball::new(builder, "rustc", &host.triple);
334 // Prepare the rustc "image", what will actually end up getting installed
335 prepare_image(builder, compiler, tarball.image_dir());
337 // On MinGW we've got a few runtime DLL dependencies that we need to
338 // include. The first argument to this script is where to put these DLLs
339 // (the image we're creating), and the second argument is a junk directory
340 // to ignore all other MinGW stuff the script creates.
342 // On 32-bit MinGW we're always including a DLL which needs some extra
343 // licenses to distribute. On 64-bit MinGW we don't actually distribute
344 // anything requiring us to distribute a license, but it's likely the
345 // install will *also* include the rust-mingw package, which also needs
346 // licenses, so to be safe we just include it here in all MinGW packages.
347 if host.contains("pc-windows-gnu") {
348 make_win_dist(tarball.image_dir(), &tmpdir(builder), host, builder);
349 tarball.add_dir(builder.src.join("src/etc/third-party"), "share/doc");
352 return tarball.generate();
354 fn prepare_image(builder: &Builder<'_>, compiler: Compiler, image: &Path) {
355 let host = compiler.host;
356 let src = builder.sysroot(compiler);
358 // Copy rustc/rustdoc binaries
359 t!(fs::create_dir_all(image.join("bin")));
360 builder.cp_r(&src.join("bin"), &image.join("bin"));
362 builder.install(&builder.rustdoc(compiler), &image.join("bin"), 0o755);
364 let libdir_relative = builder.libdir_relative(compiler);
366 // Copy runtime DLLs needed by the compiler
367 if libdir_relative.to_str() != Some("bin") {
368 let libdir = builder.rustc_libdir(compiler);
369 for entry in builder.read_dir(&libdir) {
370 let name = entry.file_name();
371 if let Some(s) = name.to_str() {
373 // Don't use custom libdir here because ^lib/ will be resolved again
375 builder.install(&entry.path(), &image.join("lib"), 0o644);
381 // Copy over the codegen backends
382 let backends_src = builder.sysroot_codegen_backends(compiler);
383 let backends_rel = backends_src
386 .strip_prefix(builder.sysroot_libdir_relative(compiler))
388 // Don't use custom libdir here because ^lib/ will be resolved again with installer
389 let backends_dst = image.join("lib").join(&backends_rel);
391 t!(fs::create_dir_all(&backends_dst));
392 builder.cp_r(&backends_src, &backends_dst);
394 // Copy libLLVM.so to the lib dir as well, if needed. While not
395 // technically needed by rustc itself it's needed by lots of other
396 // components like the llvm tools and LLD. LLD is included below and
397 // tools/LLDB come later, so let's just throw it in the rustc
398 // component for now.
399 maybe_install_llvm_runtime(builder, host, image);
401 let src_dir = builder.sysroot_libdir(compiler, host).parent().unwrap().join("bin");
402 let dst_dir = image.join("lib/rustlib").join(&*host.triple).join("bin");
403 t!(fs::create_dir_all(&dst_dir));
405 // Copy over lld if it's there
406 if builder.config.lld_enabled {
407 let rust_lld = exe("rust-lld", compiler.host);
408 builder.copy(&src_dir.join(&rust_lld), &dst_dir.join(&rust_lld));
409 // for `-Z gcc-ld=lld`
410 let gcc_lld_src_dir = src_dir.join("gcc-ld");
411 let gcc_lld_dst_dir = dst_dir.join("gcc-ld");
412 t!(fs::create_dir(&gcc_lld_dst_dir));
413 for flavor in ["ld", "ld64"] {
414 let exe_name = exe(flavor, compiler.host);
416 .copy(&gcc_lld_src_dir.join(&exe_name), &gcc_lld_dst_dir.join(&exe_name));
420 // Copy over llvm-dwp if it's there
421 let exe = exe("rust-llvm-dwp", compiler.host);
422 builder.copy(&src_dir.join(&exe), &dst_dir.join(&exe));
425 t!(fs::create_dir_all(image.join("share/man/man1")));
426 let man_src = builder.src.join("src/doc/man");
427 let man_dst = image.join("share/man/man1");
429 // Reproducible builds: If SOURCE_DATE_EPOCH is set, use that as the time.
430 let time = env::var("SOURCE_DATE_EPOCH")
432 let epoch = timestamp
434 .map_err(|err| format!("could not parse SOURCE_DATE_EPOCH: {}", err))
437 time::at(Timespec::new(epoch, 0))
439 .unwrap_or_else(|_| time::now());
441 let month_year = t!(time::strftime("%B %Y", &time));
442 // don't use our `bootstrap::util::{copy, cp_r}`, because those try
443 // to hardlink, and we don't want to edit the source templates
444 for file_entry in builder.read_dir(&man_src) {
445 let page_src = file_entry.path();
446 let page_dst = man_dst.join(file_entry.file_name());
447 t!(fs::copy(&page_src, &page_dst));
448 // template in month/year and version number
449 builder.replace_in_file(
452 ("<INSERT DATE HERE>", &month_year),
453 ("<INSERT VERSION HERE>", &builder.version),
460 .ensure(DebuggerScripts { sysroot: INTERNER.intern_path(image.to_owned()), host });
463 let cp = |file: &str| {
464 builder.install(&builder.src.join(file), &image.join("share/doc/rust"), 0o644);
467 cp("LICENSE-APACHE");
474 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
475 pub struct DebuggerScripts {
476 pub sysroot: Interned<PathBuf>,
477 pub host: TargetSelection,
480 impl Step for DebuggerScripts {
483 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
484 run.path("src/lldb_batchmode.py")
487 fn make_run(run: RunConfig<'_>) {
488 run.builder.ensure(DebuggerScripts {
491 .sysroot(run.builder.compiler(run.builder.top_stage, run.build_triple())),
496 /// Copies debugger scripts for `target` into the `sysroot` specified.
497 fn run(self, builder: &Builder<'_>) {
498 let host = self.host;
499 let sysroot = self.sysroot;
500 let dst = sysroot.join("lib/rustlib/etc");
501 t!(fs::create_dir_all(&dst));
502 let cp_debugger_script = |file: &str| {
503 builder.install(&builder.src.join("src/etc/").join(file), &dst, 0o644);
505 if host.contains("windows-msvc") {
506 // windbg debugger scripts
508 &builder.src.join("src/etc/rust-windbg.cmd"),
509 &sysroot.join("bin"),
513 cp_debugger_script("natvis/intrinsic.natvis");
514 cp_debugger_script("natvis/liballoc.natvis");
515 cp_debugger_script("natvis/libcore.natvis");
516 cp_debugger_script("natvis/libstd.natvis");
518 cp_debugger_script("rust_types.py");
520 // gdb debugger scripts
521 builder.install(&builder.src.join("src/etc/rust-gdb"), &sysroot.join("bin"), 0o755);
522 builder.install(&builder.src.join("src/etc/rust-gdbgui"), &sysroot.join("bin"), 0o755);
524 cp_debugger_script("gdb_load_rust_pretty_printers.py");
525 cp_debugger_script("gdb_lookup.py");
526 cp_debugger_script("gdb_providers.py");
528 // lldb debugger scripts
529 builder.install(&builder.src.join("src/etc/rust-lldb"), &sysroot.join("bin"), 0o755);
531 cp_debugger_script("lldb_lookup.py");
532 cp_debugger_script("lldb_providers.py");
533 cp_debugger_script("lldb_commands")
538 fn skip_host_target_lib(builder: &Builder<'_>, compiler: Compiler) -> bool {
539 // The only true set of target libraries came from the build triple, so
540 // let's reduce redundant work by only producing archives from that host.
541 if compiler.host != builder.config.build {
542 builder.info("\tskipping, not a build host");
549 /// Copy stamped files into an image's `target/lib` directory.
550 fn copy_target_libs(builder: &Builder<'_>, target: TargetSelection, image: &Path, stamp: &Path) {
551 let dst = image.join("lib/rustlib").join(target.triple).join("lib");
552 let self_contained_dst = dst.join("self-contained");
553 t!(fs::create_dir_all(&dst));
554 t!(fs::create_dir_all(&self_contained_dst));
555 for (path, dependency_type) in builder.read_stamp_file(stamp) {
556 if dependency_type == DependencyType::TargetSelfContained {
557 builder.copy(&path, &self_contained_dst.join(path.file_name().unwrap()));
558 } else if dependency_type == DependencyType::Target || builder.config.build == target {
559 builder.copy(&path, &dst.join(path.file_name().unwrap()));
564 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
566 pub compiler: Compiler,
567 pub target: TargetSelection,
571 type Output = Option<GeneratedTarball>;
572 const DEFAULT: bool = true;
574 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
578 fn make_run(run: RunConfig<'_>) {
579 run.builder.ensure(Std {
580 compiler: run.builder.compiler_for(
581 run.builder.top_stage,
582 run.builder.config.build,
589 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
590 let compiler = self.compiler;
591 let target = self.target;
593 if skip_host_target_lib(builder, compiler) {
597 builder.ensure(compile::Std { compiler, target });
599 let mut tarball = Tarball::new(builder, "rust-std", &target.triple);
600 tarball.include_target_in_component_name(true);
602 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
603 let stamp = compile::libstd_stamp(builder, compiler_to_use, target);
604 copy_target_libs(builder, target, &tarball.image_dir(), &stamp);
606 Some(tarball.generate())
610 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
611 pub struct RustcDev {
612 pub compiler: Compiler,
613 pub target: TargetSelection,
616 impl Step for RustcDev {
617 type Output = Option<GeneratedTarball>;
618 const DEFAULT: bool = true;
619 const ONLY_HOSTS: bool = true;
621 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
622 run.path("rustc-dev")
625 fn make_run(run: RunConfig<'_>) {
626 run.builder.ensure(RustcDev {
627 compiler: run.builder.compiler_for(
628 run.builder.top_stage,
629 run.builder.config.build,
636 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
637 let compiler = self.compiler;
638 let target = self.target;
639 if skip_host_target_lib(builder, compiler) {
643 builder.ensure(compile::Rustc { compiler, target });
645 let tarball = Tarball::new(builder, "rustc-dev", &target.triple);
647 let compiler_to_use = builder.compiler_for(compiler.stage, compiler.host, target);
648 let stamp = compile::librustc_stamp(builder, compiler_to_use, target);
649 copy_target_libs(builder, target, tarball.image_dir(), &stamp);
651 let src_files = &["Cargo.lock"];
652 // This is the reduced set of paths which will become the rustc-dev component
653 // (essentially the compiler crates and all of their path dependencies).
659 &tarball.image_dir().join("lib/rustlib/rustc-src/rust"),
661 // This particular crate is used as a build dependency of the above.
665 &["src/build_helper"],
667 &tarball.image_dir().join("lib/rustlib/rustc-src/rust"),
669 for file in src_files {
670 tarball.add_file(builder.src.join(file), "lib/rustlib/rustc-src/rust", 0o644);
673 Some(tarball.generate())
677 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
678 pub struct Analysis {
679 pub compiler: Compiler,
680 pub target: TargetSelection,
683 impl Step for Analysis {
684 type Output = Option<GeneratedTarball>;
685 const DEFAULT: bool = true;
687 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
688 let default = should_build_extended_tool(&run.builder, "analysis");
689 run.path("rust-analysis").default_condition(default)
692 fn make_run(run: RunConfig<'_>) {
693 run.builder.ensure(Analysis {
694 // Find the actual compiler (handling the full bootstrap option) which
695 // produced the save-analysis data because that data isn't copied
696 // through the sysroot uplifting.
697 compiler: run.builder.compiler_for(
698 run.builder.top_stage,
699 run.builder.config.build,
706 /// Creates a tarball of save-analysis metadata, if available.
707 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
708 let compiler = self.compiler;
709 let target = self.target;
710 if compiler.host != builder.config.build {
714 builder.ensure(compile::Std { compiler, target });
716 .stage_out(compiler, Mode::Std)
718 .join(builder.cargo_dir())
720 .join("save-analysis");
722 let mut tarball = Tarball::new(builder, "rust-analysis", &target.triple);
723 tarball.include_target_in_component_name(true);
724 tarball.add_dir(src, format!("lib/rustlib/{}/analysis", target.triple));
725 Some(tarball.generate())
729 /// Use the `builder` to make a filtered copy of `base`/X for X in (`src_dirs` - `exclude_dirs`) to
732 builder: &Builder<'_>,
735 exclude_dirs: &[&str],
738 fn filter_fn(exclude_dirs: &[&str], dir: &str, path: &Path) -> bool {
739 let spath = match path.to_str() {
741 None => return false,
743 if spath.ends_with('~') || spath.ends_with(".pyc") {
747 const LLVM_PROJECTS: &[&str] = &[
748 "llvm-project/clang",
749 "llvm-project\\clang",
750 "llvm-project/libunwind",
751 "llvm-project\\libunwind",
755 "llvm-project\\lldb",
757 "llvm-project\\llvm",
758 "llvm-project/compiler-rt",
759 "llvm-project\\compiler-rt",
761 if spath.contains("llvm-project")
762 && !spath.ends_with("llvm-project")
763 && !LLVM_PROJECTS.iter().any(|path| spath.contains(path))
768 const LLVM_TEST: &[&str] = &["llvm-project/llvm/test", "llvm-project\\llvm\\test"];
769 if LLVM_TEST.iter().any(|path| spath.contains(path))
770 && (spath.ends_with(".ll") || spath.ends_with(".td") || spath.ends_with(".s"))
775 let full_path = Path::new(dir).join(path);
776 if exclude_dirs.iter().any(|excl| full_path == Path::new(excl)) {
803 !path.iter().map(|s| s.to_str().unwrap()).any(|s| excludes.contains(&s))
806 // Copy the directories using our filter
807 for item in src_dirs {
808 let dst = &dst_dir.join(item);
809 t!(fs::create_dir_all(dst));
810 builder.cp_filtered(&base.join(item), dst, &|path| filter_fn(exclude_dirs, item, path));
814 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
818 /// The output path of the src installer tarball
819 type Output = GeneratedTarball;
820 const DEFAULT: bool = true;
821 const ONLY_HOSTS: bool = true;
823 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
827 fn make_run(run: RunConfig<'_>) {
828 run.builder.ensure(Src);
831 /// Creates the `rust-src` installer component
832 fn run(self, builder: &Builder<'_>) -> GeneratedTarball {
833 let tarball = Tarball::new_targetless(builder, "rust-src");
835 // A lot of tools expect the rust-src component to be entirely in this directory, so if you
836 // change that (e.g. by adding another directory `lib/rustlib/src/foo` or
837 // `lib/rustlib/src/rust/foo`), you will need to go around hunting for implicit assumptions
840 // NOTE: if you update the paths here, you also should update the "virtual" path
841 // translation code in `imported_source_files` in `src/librustc_metadata/rmeta/decoder.rs`
842 let dst_src = tarball.image_dir().join("lib/rustlib/src/rust");
844 let src_files = ["Cargo.lock"];
845 // This is the reduced set of paths which will become the rust-src component
846 // (essentially libstd and all of its path dependencies).
850 &["library", "src/llvm-project/libunwind"],
852 // not needed and contains symlinks which rustup currently
853 // chokes on when unpacking.
854 "library/backtrace/crates",
858 for file in src_files.iter() {
859 builder.copy(&builder.src.join(file), &dst_src.join(file));
866 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
867 pub struct PlainSourceTarball;
869 impl Step for PlainSourceTarball {
870 /// Produces the location of the tarball generated
871 type Output = GeneratedTarball;
872 const DEFAULT: bool = true;
873 const ONLY_HOSTS: bool = true;
875 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
876 let builder = run.builder;
877 run.path("rustc-src").default_condition(builder.config.rust_dist_src)
880 fn make_run(run: RunConfig<'_>) {
881 run.builder.ensure(PlainSourceTarball);
884 /// Creates the plain source tarball
885 fn run(self, builder: &Builder<'_>) -> GeneratedTarball {
886 let tarball = Tarball::new(builder, "rustc", "src");
887 let plain_dst_src = tarball.image_dir();
889 // This is the set of root paths which will become part of the source package
899 "config.toml.example",
903 let src_dirs = ["src", "compiler", "library"];
905 copy_src_dirs(builder, &builder.src, &src_dirs, &[], &plain_dst_src);
907 // Copy the files normally
908 for item in &src_files {
909 builder.copy(&builder.src.join(item), &plain_dst_src.join(item));
912 // Create the version file
913 builder.create(&plain_dst_src.join("version"), &builder.rust_version());
914 if let Some(sha) = builder.rust_sha() {
915 builder.create(&plain_dst_src.join("git-commit-hash"), &sha);
918 // If we're building from git sources, we need to vendor a complete distribution.
919 if builder.rust_info.is_git() {
920 // Vendor all Cargo dependencies
921 let mut cmd = Command::new(&builder.initial_cargo);
924 .arg(builder.src.join("./src/tools/rust-analyzer/Cargo.toml"))
925 .arg(builder.src.join("./compiler/rustc_codegen_cranelift/Cargo.toml"))
926 .current_dir(&plain_dst_src);
927 builder.run(&mut cmd);
934 // We have to run a few shell scripts, which choke quite a bit on both `\`
935 // characters and on `C:\` paths, so normalize both of them away.
936 pub fn sanitize_sh(path: &Path) -> String {
937 let path = path.to_str().unwrap().replace("\\", "/");
938 return change_drive(unc_to_lfs(&path)).unwrap_or(path);
940 fn unc_to_lfs(s: &str) -> &str {
941 s.strip_prefix("//?/").unwrap_or(s)
944 fn change_drive(s: &str) -> Option<String> {
945 let mut ch = s.chars();
946 let drive = ch.next().unwrap_or('C');
947 if ch.next() != Some(':') {
950 if ch.next() != Some('/') {
953 Some(format!("/{}/{}", drive, &s[drive.len_utf8() + 2..]))
957 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
959 pub compiler: Compiler,
960 pub target: TargetSelection,
963 impl Step for Cargo {
964 type Output = Option<GeneratedTarball>;
965 const DEFAULT: bool = true;
966 const ONLY_HOSTS: bool = true;
968 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
969 let default = should_build_extended_tool(&run.builder, "cargo");
970 run.path("cargo").default_condition(default)
973 fn make_run(run: RunConfig<'_>) {
974 run.builder.ensure(Cargo {
975 compiler: run.builder.compiler_for(
976 run.builder.top_stage,
977 run.builder.config.build,
984 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
985 let compiler = self.compiler;
986 let target = self.target;
988 let cargo = builder.ensure(tool::Cargo { compiler, target });
989 let src = builder.src.join("src/tools/cargo");
990 let etc = src.join("src/etc");
992 // Prepare the image directory
993 let mut tarball = Tarball::new(builder, "cargo", &target.triple);
994 tarball.set_overlay(OverlayKind::Cargo);
996 tarball.add_file(&cargo, "bin", 0o755);
997 tarball.add_file(etc.join("_cargo"), "share/zsh/site-functions", 0o644);
998 tarball.add_renamed_file(etc.join("cargo.bashcomp.sh"), "etc/bash_completion.d", "cargo");
999 tarball.add_dir(etc.join("man"), "share/man/man1");
1000 tarball.add_legal_and_readme_to("share/doc/cargo");
1002 for dirent in fs::read_dir(cargo.parent().unwrap()).expect("read_dir") {
1003 let dirent = dirent.expect("read dir entry");
1004 if dirent.file_name().to_str().expect("utf8").starts_with("cargo-credential-") {
1005 tarball.add_file(&dirent.path(), "libexec", 0o755);
1009 Some(tarball.generate())
1013 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
1015 pub compiler: Compiler,
1016 pub target: TargetSelection,
1020 type Output = Option<GeneratedTarball>;
1021 const ONLY_HOSTS: bool = true;
1022 const DEFAULT: bool = true;
1024 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1025 let default = should_build_extended_tool(&run.builder, "rls");
1026 run.path("rls").default_condition(default)
1029 fn make_run(run: RunConfig<'_>) {
1030 run.builder.ensure(Rls {
1031 compiler: run.builder.compiler_for(
1032 run.builder.top_stage,
1033 run.builder.config.build,
1040 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
1041 let compiler = self.compiler;
1042 let target = self.target;
1045 .ensure(tool::Rls { compiler, target, extra_features: Vec::new() })
1047 missing_tool("RLS", builder.build.config.missing_tools);
1051 let mut tarball = Tarball::new(builder, "rls", &target.triple);
1052 tarball.set_overlay(OverlayKind::RLS);
1053 tarball.is_preview(true);
1054 tarball.add_file(rls, "bin", 0o755);
1055 tarball.add_legal_and_readme_to("share/doc/rls");
1056 Some(tarball.generate())
1060 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
1061 pub struct RustAnalyzer {
1062 pub compiler: Compiler,
1063 pub target: TargetSelection,
1066 impl Step for RustAnalyzer {
1067 type Output = Option<GeneratedTarball>;
1068 const DEFAULT: bool = true;
1069 const ONLY_HOSTS: bool = true;
1071 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1072 let default = should_build_extended_tool(&run.builder, "rust-analyzer");
1073 run.path("rust-analyzer").default_condition(default)
1076 fn make_run(run: RunConfig<'_>) {
1077 run.builder.ensure(RustAnalyzer {
1078 compiler: run.builder.compiler_for(
1079 run.builder.top_stage,
1080 run.builder.config.build,
1087 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
1088 // This prevents rust-analyzer from being built for "dist" or "install"
1089 // on the stable/beta channels. It is a nightly-only tool and should
1091 if !builder.build.unstable_features() {
1094 let compiler = self.compiler;
1095 let target = self.target;
1097 if target.contains("riscv64") {
1098 // riscv64 currently has an LLVM bug that makes rust-analyzer unable
1099 // to build. See #74813 for details.
1103 let rust_analyzer = builder
1104 .ensure(tool::RustAnalyzer { compiler, target, extra_features: Vec::new() })
1105 .expect("rust-analyzer always builds");
1107 let mut tarball = Tarball::new(builder, "rust-analyzer", &target.triple);
1108 tarball.set_overlay(OverlayKind::RustAnalyzer);
1109 tarball.is_preview(true);
1110 tarball.add_file(rust_analyzer, "bin", 0o755);
1111 tarball.add_legal_and_readme_to("share/doc/rust-analyzer");
1112 Some(tarball.generate())
1116 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
1118 pub compiler: Compiler,
1119 pub target: TargetSelection,
1122 impl Step for Clippy {
1123 type Output = Option<GeneratedTarball>;
1124 const DEFAULT: bool = true;
1125 const ONLY_HOSTS: bool = true;
1127 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1128 let default = should_build_extended_tool(&run.builder, "clippy");
1129 run.path("clippy").default_condition(default)
1132 fn make_run(run: RunConfig<'_>) {
1133 run.builder.ensure(Clippy {
1134 compiler: run.builder.compiler_for(
1135 run.builder.top_stage,
1136 run.builder.config.build,
1143 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
1144 let compiler = self.compiler;
1145 let target = self.target;
1147 // Prepare the image directory
1148 // We expect clippy to build, because we've exited this step above if tool
1149 // state for clippy isn't testing.
1150 let clippy = builder
1151 .ensure(tool::Clippy { compiler, target, extra_features: Vec::new() })
1152 .expect("clippy expected to build - essential tool");
1153 let cargoclippy = builder
1154 .ensure(tool::CargoClippy { compiler, target, extra_features: Vec::new() })
1155 .expect("clippy expected to build - essential tool");
1157 let mut tarball = Tarball::new(builder, "clippy", &target.triple);
1158 tarball.set_overlay(OverlayKind::Clippy);
1159 tarball.is_preview(true);
1160 tarball.add_file(clippy, "bin", 0o755);
1161 tarball.add_file(cargoclippy, "bin", 0o755);
1162 tarball.add_legal_and_readme_to("share/doc/clippy");
1163 Some(tarball.generate())
1167 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
1169 pub compiler: Compiler,
1170 pub target: TargetSelection,
1173 impl Step for Miri {
1174 type Output = Option<GeneratedTarball>;
1175 const DEFAULT: bool = true;
1176 const ONLY_HOSTS: bool = true;
1178 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1179 let default = should_build_extended_tool(&run.builder, "miri");
1180 run.path("miri").default_condition(default)
1183 fn make_run(run: RunConfig<'_>) {
1184 run.builder.ensure(Miri {
1185 compiler: run.builder.compiler_for(
1186 run.builder.top_stage,
1187 run.builder.config.build,
1194 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
1195 // This prevents miri from being built for "dist" or "install"
1196 // on the stable/beta channels. It is a nightly-only tool and should
1198 if !builder.build.unstable_features() {
1201 let compiler = self.compiler;
1202 let target = self.target;
1205 .ensure(tool::Miri { compiler, target, extra_features: Vec::new() })
1207 missing_tool("miri", builder.build.config.missing_tools);
1210 let cargomiri = builder
1211 .ensure(tool::CargoMiri { compiler, target, extra_features: Vec::new() })
1213 missing_tool("cargo miri", builder.build.config.missing_tools);
1217 let mut tarball = Tarball::new(builder, "miri", &target.triple);
1218 tarball.set_overlay(OverlayKind::Miri);
1219 tarball.is_preview(true);
1220 tarball.add_file(miri, "bin", 0o755);
1221 tarball.add_file(cargomiri, "bin", 0o755);
1222 tarball.add_legal_and_readme_to("share/doc/miri");
1223 Some(tarball.generate())
1227 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
1228 pub struct Rustfmt {
1229 pub compiler: Compiler,
1230 pub target: TargetSelection,
1233 impl Step for Rustfmt {
1234 type Output = Option<GeneratedTarball>;
1235 const DEFAULT: bool = true;
1236 const ONLY_HOSTS: bool = true;
1238 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1239 let default = should_build_extended_tool(&run.builder, "rustfmt");
1240 run.path("rustfmt").default_condition(default)
1243 fn make_run(run: RunConfig<'_>) {
1244 run.builder.ensure(Rustfmt {
1245 compiler: run.builder.compiler_for(
1246 run.builder.top_stage,
1247 run.builder.config.build,
1254 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
1255 let compiler = self.compiler;
1256 let target = self.target;
1258 let rustfmt = builder
1259 .ensure(tool::Rustfmt { compiler, target, extra_features: Vec::new() })
1261 missing_tool("Rustfmt", builder.build.config.missing_tools);
1264 let cargofmt = builder
1265 .ensure(tool::Cargofmt { compiler, target, extra_features: Vec::new() })
1267 missing_tool("Cargofmt", builder.build.config.missing_tools);
1271 let mut tarball = Tarball::new(builder, "rustfmt", &target.triple);
1272 tarball.set_overlay(OverlayKind::Rustfmt);
1273 tarball.is_preview(true);
1274 tarball.add_file(rustfmt, "bin", 0o755);
1275 tarball.add_file(cargofmt, "bin", 0o755);
1276 tarball.add_legal_and_readme_to("share/doc/rustfmt");
1277 Some(tarball.generate())
1281 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
1282 pub struct RustDemangler {
1283 pub compiler: Compiler,
1284 pub target: TargetSelection,
1287 impl Step for RustDemangler {
1288 type Output = Option<GeneratedTarball>;
1289 const DEFAULT: bool = true;
1290 const ONLY_HOSTS: bool = true;
1292 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1293 // While other tools use `should_build_extended_tool` to decide whether to be run by
1294 // default or not, `rust-demangler` must be build when *either* it's enabled as a tool like
1295 // the other ones or if `profiler = true`. Because we don't know the target at this stage
1296 // we run the step by default when only `extended = true`, and decide whether to actually
1297 // run it or not later.
1298 let default = run.builder.config.extended;
1299 run.path("rust-demangler").default_condition(default)
1302 fn make_run(run: RunConfig<'_>) {
1303 run.builder.ensure(RustDemangler {
1304 compiler: run.builder.compiler_for(
1305 run.builder.top_stage,
1306 run.builder.config.build,
1313 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
1314 let compiler = self.compiler;
1315 let target = self.target;
1317 // Only build this extended tool if explicitly included in `tools`, or if `profiler = true`
1318 let condition = should_build_extended_tool(builder, "rust-demangler")
1319 || builder.config.profiler_enabled(target);
1320 if builder.config.extended && !condition {
1324 let rust_demangler = builder
1325 .ensure(tool::RustDemangler { compiler, target, extra_features: Vec::new() })
1326 .expect("rust-demangler expected to build - in-tree tool");
1328 // Prepare the image directory
1329 let mut tarball = Tarball::new(builder, "rust-demangler", &target.triple);
1330 tarball.set_overlay(OverlayKind::RustDemangler);
1331 tarball.is_preview(true);
1332 tarball.add_file(&rust_demangler, "bin", 0o755);
1333 tarball.add_legal_and_readme_to("share/doc/rust-demangler");
1334 Some(tarball.generate())
1338 #[derive(Debug, PartialOrd, Ord, Copy, Clone, Hash, PartialEq, Eq)]
1339 pub struct Extended {
1341 host: TargetSelection,
1342 target: TargetSelection,
1345 impl Step for Extended {
1347 const DEFAULT: bool = true;
1348 const ONLY_HOSTS: bool = true;
1350 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1351 let builder = run.builder;
1352 run.path("extended").default_condition(builder.config.extended)
1355 fn make_run(run: RunConfig<'_>) {
1356 run.builder.ensure(Extended {
1357 stage: run.builder.top_stage,
1358 host: run.builder.config.build,
1363 /// Creates a combined installer for the specified target in the provided stage.
1364 fn run(self, builder: &Builder<'_>) {
1365 let target = self.target;
1366 let stage = self.stage;
1367 let compiler = builder.compiler_for(self.stage, self.host, self.target);
1369 builder.info(&format!("Dist extended stage{} ({})", compiler.stage, target));
1371 let mut tarballs = Vec::new();
1372 let mut built_tools = HashSet::new();
1373 macro_rules! add_component {
1374 ($name:expr => $step:expr) => {
1375 if let Some(tarball) = builder.ensure_if_default($step) {
1376 tarballs.push(tarball);
1377 built_tools.insert($name);
1382 // When rust-std package split from rustc, we needed to ensure that during
1383 // upgrades rustc was upgraded before rust-std. To avoid rustc clobbering
1384 // the std files during uninstall. To do this ensure that rustc comes
1385 // before rust-std in the list below.
1386 tarballs.push(builder.ensure(Rustc { compiler: builder.compiler(stage, target) }));
1387 tarballs.push(builder.ensure(Std { compiler, target }).expect("missing std"));
1389 if target.contains("windows-gnu") {
1390 tarballs.push(builder.ensure(Mingw { host: target }).expect("missing mingw"));
1393 add_component!("rust-docs" => Docs { host: target });
1394 add_component!("rust-demangler"=> RustDemangler { compiler, target });
1395 add_component!("cargo" => Cargo { compiler, target });
1396 add_component!("rustfmt" => Rustfmt { compiler, target });
1397 add_component!("rls" => Rls { compiler, target });
1398 add_component!("rust-analyzer" => RustAnalyzer { compiler, target });
1399 add_component!("llvm-components" => LlvmTools { target });
1400 add_component!("clippy" => Clippy { compiler, target });
1401 add_component!("miri" => Miri { compiler, target });
1402 add_component!("analysis" => Analysis { compiler, target });
1404 let etc = builder.src.join("src/etc/installer");
1406 // Avoid producing tarballs during a dry run.
1407 if builder.config.dry_run {
1411 let tarball = Tarball::new(builder, "rust", &target.triple);
1412 let generated = tarball.combine(&tarballs);
1414 let tmp = tmpdir(builder).join("combined-tarball");
1415 let work = generated.work_dir();
1417 let mut license = String::new();
1418 license += &builder.read(&builder.src.join("COPYRIGHT"));
1419 license += &builder.read(&builder.src.join("LICENSE-APACHE"));
1420 license += &builder.read(&builder.src.join("LICENSE-MIT"));
1424 let rtf = r"{\rtf1\ansi\deff0{\fonttbl{\f0\fnil\fcharset0 Arial;}}\nowwrap\fs18";
1425 let mut rtf = rtf.to_string();
1427 for line in license.lines() {
1429 rtf.push_str("\\line ");
1433 fn filter(contents: &str, marker: &str) -> String {
1434 let start = format!("tool-{}-start", marker);
1435 let end = format!("tool-{}-end", marker);
1436 let mut lines = Vec::new();
1437 let mut omitted = false;
1438 for line in contents.lines() {
1439 if line.contains(&start) {
1441 } else if line.contains(&end) {
1443 } else if !omitted {
1451 let xform = |p: &Path| {
1452 let mut contents = t!(fs::read_to_string(p));
1453 for tool in &["rust-demangler", "rls", "rust-analyzer", "miri", "rustfmt"] {
1454 if !built_tools.contains(tool) {
1455 contents = filter(&contents, tool);
1458 let ret = tmp.join(p.file_name().unwrap());
1459 t!(fs::write(&ret, &contents));
1463 if target.contains("apple-darwin") {
1464 builder.info("building pkg installer");
1465 let pkg = tmp.join("pkg");
1466 let _ = fs::remove_dir_all(&pkg);
1468 let pkgbuild = |component: &str| {
1469 let mut cmd = Command::new("pkgbuild");
1470 cmd.arg("--identifier")
1471 .arg(format!("org.rust-lang.{}", component))
1473 .arg(pkg.join(component))
1475 .arg(pkg.join(component).with_extension("pkg"));
1476 builder.run(&mut cmd);
1479 let prepare = |name: &str| {
1480 builder.create_dir(&pkg.join(name));
1482 &work.join(&format!("{}-{}", pkgname(builder, name), target.triple)),
1485 builder.install(&etc.join("pkg/postinstall"), &pkg.join(name), 0o755);
1490 prepare("rust-docs");
1491 prepare("rust-std");
1492 prepare("rust-analysis");
1494 for tool in &["rust-demangler", "rls", "rust-analyzer", "miri"] {
1495 if built_tools.contains(tool) {
1499 // create an 'uninstall' package
1500 builder.install(&etc.join("pkg/postinstall"), &pkg.join("uninstall"), 0o755);
1501 pkgbuild("uninstall");
1503 builder.create_dir(&pkg.join("res"));
1504 builder.create(&pkg.join("res/LICENSE.txt"), &license);
1505 builder.install(&etc.join("gfx/rust-logo.png"), &pkg.join("res"), 0o644);
1506 let mut cmd = Command::new("productbuild");
1507 cmd.arg("--distribution")
1508 .arg(xform(&etc.join("pkg/Distribution.xml")))
1510 .arg(pkg.join("res"))
1511 .arg(distdir(builder).join(format!(
1513 pkgname(builder, "rust"),
1516 .arg("--package-path")
1518 let _time = timeit(builder);
1519 builder.run(&mut cmd);
1522 if target.contains("windows") {
1523 let exe = tmp.join("exe");
1524 let _ = fs::remove_dir_all(&exe);
1526 let prepare = |name: &str| {
1527 builder.create_dir(&exe.join(name));
1528 let dir = if name == "rust-std" || name == "rust-analysis" {
1529 format!("{}-{}", name, target.triple)
1530 } else if name == "rls" {
1531 "rls-preview".to_string()
1532 } else if name == "rust-analyzer" {
1533 "rust-analyzer-preview".to_string()
1534 } else if name == "clippy" {
1535 "clippy-preview".to_string()
1536 } else if name == "rust-demangler" {
1537 "rust-demangler-preview".to_string()
1538 } else if name == "miri" {
1539 "miri-preview".to_string()
1544 &work.join(&format!("{}-{}", pkgname(builder, name), target.triple)).join(dir),
1547 builder.remove(&exe.join(name).join("manifest.in"));
1551 prepare("rust-analysis");
1552 prepare("rust-docs");
1553 prepare("rust-std");
1555 for tool in &["rust-demangler", "rls", "rust-analyzer", "miri"] {
1556 if built_tools.contains(tool) {
1560 if target.contains("windows-gnu") {
1561 prepare("rust-mingw");
1564 builder.install(&etc.join("gfx/rust-logo.ico"), &exe, 0o644);
1566 // Generate msi installer
1567 let wix = PathBuf::from(env::var_os("WIX").unwrap());
1568 let heat = wix.join("bin/heat.exe");
1569 let candle = wix.join("bin/candle.exe");
1570 let light = wix.join("bin/light.exe");
1572 let heat_flags = ["-nologo", "-gg", "-sfrag", "-srd", "-sreg"];
1584 .arg("var.RustcDir")
1586 .arg(exe.join("RustcGroup.wxs")),
1601 .arg(exe.join("DocsGroup.wxs"))
1603 .arg(etc.join("msi/squash-components.xsl")),
1616 .arg("var.CargoDir")
1618 .arg(exe.join("CargoGroup.wxs"))
1620 .arg(etc.join("msi/remove-duplicates.xsl")),
1635 .arg(exe.join("StdGroup.wxs")),
1637 if built_tools.contains("rls") {
1651 .arg(exe.join("RlsGroup.wxs"))
1653 .arg(etc.join("msi/remove-duplicates.xsl")),
1656 if built_tools.contains("rust-analyzer") {
1661 .arg("rust-analyzer")
1664 .arg("RustAnalyzerGroup")
1666 .arg("RustAnalyzer")
1668 .arg("var.RustAnalyzerDir")
1670 .arg(exe.join("RustAnalyzerGroup.wxs"))
1672 .arg(etc.join("msi/remove-duplicates.xsl")),
1686 .arg("var.ClippyDir")
1688 .arg(exe.join("ClippyGroup.wxs"))
1690 .arg(etc.join("msi/remove-duplicates.xsl")),
1692 if built_tools.contains("rust-demangler") {
1697 .arg("rust-demangler")
1700 .arg("RustDemanglerGroup")
1702 .arg("RustDemangler")
1704 .arg("var.RustDemanglerDir")
1706 .arg(exe.join("RustDemanglerGroup.wxs"))
1708 .arg(etc.join("msi/remove-duplicates.xsl")),
1711 if built_tools.contains("miri") {
1725 .arg(exe.join("MiriGroup.wxs"))
1727 .arg(etc.join("msi/remove-duplicates.xsl")),
1734 .arg("rust-analysis")
1737 .arg("AnalysisGroup")
1741 .arg("var.AnalysisDir")
1743 .arg(exe.join("AnalysisGroup.wxs"))
1745 .arg(etc.join("msi/remove-duplicates.xsl")),
1747 if target.contains("windows-gnu") {
1761 .arg(exe.join("GccGroup.wxs")),
1765 let candle = |input: &Path| {
1766 let output = exe.join(input.file_stem().unwrap()).with_extension("wixobj");
1767 let arch = if target.contains("x86_64") { "x64" } else { "x86" };
1768 let mut cmd = Command::new(&candle);
1769 cmd.current_dir(&exe)
1771 .arg("-dRustcDir=rustc")
1772 .arg("-dDocsDir=rust-docs")
1773 .arg("-dCargoDir=cargo")
1774 .arg("-dStdDir=rust-std")
1775 .arg("-dAnalysisDir=rust-analysis")
1776 .arg("-dClippyDir=clippy")
1782 add_env(builder, &mut cmd, target);
1784 if built_tools.contains("rust-demangler") {
1785 cmd.arg("-dRustDemanglerDir=rust-demangler");
1787 if built_tools.contains("rls") {
1788 cmd.arg("-dRlsDir=rls");
1790 if built_tools.contains("rust-analyzer") {
1791 cmd.arg("-dRustAnalyzerDir=rust-analyzer");
1793 if built_tools.contains("miri") {
1794 cmd.arg("-dMiriDir=miri");
1796 if target.contains("windows-gnu") {
1797 cmd.arg("-dGccDir=rust-mingw");
1799 builder.run(&mut cmd);
1801 candle(&xform(&etc.join("msi/rust.wxs")));
1802 candle(&etc.join("msi/ui.wxs"));
1803 candle(&etc.join("msi/rustwelcomedlg.wxs"));
1804 candle("RustcGroup.wxs".as_ref());
1805 candle("DocsGroup.wxs".as_ref());
1806 candle("CargoGroup.wxs".as_ref());
1807 candle("StdGroup.wxs".as_ref());
1808 candle("ClippyGroup.wxs".as_ref());
1809 if built_tools.contains("rust-demangler") {
1810 candle("RustDemanglerGroup.wxs".as_ref());
1812 if built_tools.contains("rls") {
1813 candle("RlsGroup.wxs".as_ref());
1815 if built_tools.contains("rust-analyzer") {
1816 candle("RustAnalyzerGroup.wxs".as_ref());
1818 if built_tools.contains("miri") {
1819 candle("MiriGroup.wxs".as_ref());
1821 candle("AnalysisGroup.wxs".as_ref());
1823 if target.contains("windows-gnu") {
1824 candle("GccGroup.wxs".as_ref());
1827 builder.create(&exe.join("LICENSE.rtf"), &rtf);
1828 builder.install(&etc.join("gfx/banner.bmp"), &exe, 0o644);
1829 builder.install(&etc.join("gfx/dialogbg.bmp"), &exe, 0o644);
1831 builder.info(&format!("building `msi` installer with {:?}", light));
1832 let filename = format!("{}-{}.msi", pkgname(builder, "rust"), target.triple);
1833 let mut cmd = Command::new(&light);
1836 .arg("WixUIExtension")
1838 .arg("WixUtilExtension")
1840 .arg(exe.join(&filename))
1843 .arg("rustwelcomedlg.wixobj")
1844 .arg("RustcGroup.wixobj")
1845 .arg("DocsGroup.wixobj")
1846 .arg("CargoGroup.wixobj")
1847 .arg("StdGroup.wixobj")
1848 .arg("AnalysisGroup.wixobj")
1849 .arg("ClippyGroup.wixobj")
1852 if built_tools.contains("rls") {
1853 cmd.arg("RlsGroup.wixobj");
1855 if built_tools.contains("rust-analyzer") {
1856 cmd.arg("RustAnalyzerGroup.wixobj");
1858 if built_tools.contains("rust-demangler") {
1859 cmd.arg("RustDemanglerGroup.wixobj");
1861 if built_tools.contains("miri") {
1862 cmd.arg("MiriGroup.wixobj");
1865 if target.contains("windows-gnu") {
1866 cmd.arg("GccGroup.wixobj");
1868 // ICE57 wrongly complains about the shortcuts
1869 cmd.arg("-sice:ICE57");
1871 let _time = timeit(builder);
1872 builder.run(&mut cmd);
1874 if !builder.config.dry_run {
1875 t!(fs::rename(exe.join(&filename), distdir(builder).join(&filename)));
1881 fn add_env(builder: &Builder<'_>, cmd: &mut Command, target: TargetSelection) {
1882 let mut parts = builder.version.split('.');
1883 cmd.env("CFG_RELEASE_INFO", builder.rust_version())
1884 .env("CFG_RELEASE_NUM", &builder.version)
1885 .env("CFG_RELEASE", builder.rust_release())
1886 .env("CFG_VER_MAJOR", parts.next().unwrap())
1887 .env("CFG_VER_MINOR", parts.next().unwrap())
1888 .env("CFG_VER_PATCH", parts.next().unwrap())
1889 .env("CFG_VER_BUILD", "0") // just needed to build
1890 .env("CFG_PACKAGE_VERS", builder.rust_package_vers())
1891 .env("CFG_PACKAGE_NAME", pkgname(builder, "rust"))
1892 .env("CFG_BUILD", target.triple)
1893 .env("CFG_CHANNEL", &builder.config.channel);
1895 if target.contains("windows-gnu") {
1896 cmd.env("CFG_MINGW", "1").env("CFG_ABI", "GNU");
1898 cmd.env("CFG_MINGW", "0").env("CFG_ABI", "MSVC");
1901 if target.contains("x86_64") {
1902 cmd.env("CFG_PLATFORM", "x64");
1904 cmd.env("CFG_PLATFORM", "x86");
1908 /// Maybe add LLVM object files to the given destination lib-dir. Allows either static or dynamic linking.
1911 /// Returns whether the files were actually copied.
1912 fn maybe_install_llvm(builder: &Builder<'_>, target: TargetSelection, dst_libdir: &Path) -> bool {
1913 if let Some(config) = builder.config.target_config.get(&target) {
1914 if config.llvm_config.is_some() && !builder.config.llvm_from_ci {
1915 // If the LLVM was externally provided, then we don't currently copy
1916 // artifacts into the sysroot. This is not necessarily the right
1917 // choice (in particular, it will require the LLVM dylib to be in
1918 // the linker's load path at runtime), but the common use case for
1919 // external LLVMs is distribution provided LLVMs, and in that case
1920 // they're usually in the standard search path (e.g., /usr/lib) and
1921 // copying them here is going to cause problems as we may end up
1922 // with the wrong files and isn't what distributions want.
1924 // This behavior may be revisited in the future though.
1926 // If the LLVM is coming from ourselves (just from CI) though, we
1927 // still want to install it, as it otherwise won't be available.
1932 // On macOS, rustc (and LLVM tools) link to an unversioned libLLVM.dylib
1933 // instead of libLLVM-11-rust-....dylib, as on linux. It's not entirely
1934 // clear why this is the case, though. llvm-config will emit the versioned
1935 // paths and we don't want those in the sysroot (as we're expecting
1936 // unversioned paths).
1937 if target.contains("apple-darwin") && builder.config.llvm_link_shared {
1938 let src_libdir = builder.llvm_out(target).join("lib");
1939 let llvm_dylib_path = src_libdir.join("libLLVM.dylib");
1940 if llvm_dylib_path.exists() {
1941 builder.install(&llvm_dylib_path, dst_libdir, 0o644);
1943 !builder.config.dry_run
1944 } else if let Ok(llvm_config) = crate::native::prebuilt_llvm_config(builder, target) {
1945 let mut cmd = Command::new(llvm_config);
1946 cmd.arg("--libfiles");
1947 builder.verbose(&format!("running {:?}", cmd));
1948 let files = output(&mut cmd);
1949 let build_llvm_out = &builder.llvm_out(builder.config.build);
1950 let target_llvm_out = &builder.llvm_out(target);
1951 for file in files.trim_end().split(' ') {
1952 // If we're not using a custom LLVM, make sure we package for the target.
1953 let file = if let Ok(relative_path) = Path::new(file).strip_prefix(build_llvm_out) {
1954 target_llvm_out.join(relative_path)
1958 builder.install(&file, dst_libdir, 0o644);
1960 !builder.config.dry_run
1966 /// Maybe add libLLVM.so to the target lib-dir for linking.
1967 pub fn maybe_install_llvm_target(builder: &Builder<'_>, target: TargetSelection, sysroot: &Path) {
1968 let dst_libdir = sysroot.join("lib/rustlib").join(&*target.triple).join("lib");
1969 // We do not need to copy LLVM files into the sysroot if it is not
1970 // dynamically linked; it is already included into librustc_llvm
1972 if builder.config.llvm_link_shared {
1973 maybe_install_llvm(builder, target, &dst_libdir);
1977 /// Maybe add libLLVM.so to the runtime lib-dir for rustc itself.
1978 pub fn maybe_install_llvm_runtime(builder: &Builder<'_>, target: TargetSelection, sysroot: &Path) {
1980 sysroot.join(builder.sysroot_libdir_relative(Compiler { stage: 1, host: target }));
1981 // We do not need to copy LLVM files into the sysroot if it is not
1982 // dynamically linked; it is already included into librustc_llvm
1984 if builder.config.llvm_link_shared {
1985 maybe_install_llvm(builder, target, &dst_libdir);
1989 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
1990 pub struct LlvmTools {
1991 pub target: TargetSelection,
1994 impl Step for LlvmTools {
1995 type Output = Option<GeneratedTarball>;
1996 const ONLY_HOSTS: bool = true;
1997 const DEFAULT: bool = true;
1999 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2000 let default = should_build_extended_tool(&run.builder, "llvm-tools");
2001 run.path("llvm-tools").default_condition(default)
2004 fn make_run(run: RunConfig<'_>) {
2005 run.builder.ensure(LlvmTools { target: run.target });
2008 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
2009 let target = self.target;
2011 /* run only if llvm-config isn't used */
2012 if let Some(config) = builder.config.target_config.get(&target) {
2013 if let Some(ref _s) = config.llvm_config {
2014 builder.info(&format!("Skipping LlvmTools ({}): external LLVM", target));
2019 let mut tarball = Tarball::new(builder, "llvm-tools", &target.triple);
2020 tarball.set_overlay(OverlayKind::LLVM);
2021 tarball.is_preview(true);
2023 // Prepare the image directory
2024 let src_bindir = builder.llvm_out(target).join("bin");
2025 let dst_bindir = format!("lib/rustlib/{}/bin", target.triple);
2026 for tool in LLVM_TOOLS {
2027 let exe = src_bindir.join(exe(tool, target));
2028 tarball.add_file(&exe, &dst_bindir, 0o755);
2031 // Copy libLLVM.so to the target lib dir as well, so the RPATH like
2032 // `$ORIGIN/../lib` can find it. It may also be used as a dependency
2033 // of `rustc-dev` to support the inherited `-lLLVM` when using the
2034 // compiler libraries.
2035 maybe_install_llvm_target(builder, target, tarball.image_dir());
2037 Some(tarball.generate())
2041 // Tarball intended for internal consumption to ease rustc/std development.
2043 // Should not be considered stable by end users.
2044 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
2045 pub struct RustDev {
2046 pub target: TargetSelection,
2049 impl Step for RustDev {
2050 type Output = Option<GeneratedTarball>;
2051 const DEFAULT: bool = true;
2052 const ONLY_HOSTS: bool = true;
2054 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2055 run.path("rust-dev")
2058 fn make_run(run: RunConfig<'_>) {
2059 run.builder.ensure(RustDev { target: run.target });
2062 fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
2063 let target = self.target;
2065 /* run only if llvm-config isn't used */
2066 if let Some(config) = builder.config.target_config.get(&target) {
2067 if let Some(ref _s) = config.llvm_config {
2068 builder.info(&format!("Skipping RustDev ({}): external LLVM", target));
2073 let mut tarball = Tarball::new(builder, "rust-dev", &target.triple);
2074 tarball.set_overlay(OverlayKind::LLVM);
2076 let src_bindir = builder.llvm_out(target).join("bin");
2086 tarball.add_file(src_bindir.join(exe(bin, target)), "bin", 0o755);
2089 // We don't build LLD on some platforms, so only add it if it exists
2090 let lld_path = builder.lld_out(target).join("bin").join(exe("lld", target));
2091 if lld_path.exists() {
2092 tarball.add_file(lld_path, "bin", 0o755);
2095 tarball.add_file(&builder.llvm_filecheck(target), "bin", 0o755);
2097 // Copy the include directory as well; needed mostly to build
2098 // librustc_llvm properly (e.g., llvm-config.h is in here). But also
2099 // just broadly useful to be able to link against the bundled LLVM.
2100 tarball.add_dir(&builder.llvm_out(target).join("include"), "include");
2102 // Copy libLLVM.so to the target lib dir as well, so the RPATH like
2103 // `$ORIGIN/../lib` can find it. It may also be used as a dependency
2104 // of `rustc-dev` to support the inherited `-lLLVM` when using the
2105 // compiler libraries.
2106 let dst_libdir = tarball.image_dir().join("lib");
2107 maybe_install_llvm(builder, target, &dst_libdir);
2108 let link_type = if builder.config.llvm_link_shared { "dynamic" } else { "static" };
2109 t!(std::fs::write(tarball.image_dir().join("link-type.txt"), link_type), dst_libdir);
2111 Some(tarball.generate())
2115 /// Tarball containing a prebuilt version of the build-manifest tool, intented to be used by the
2116 /// release process to avoid cloning the monorepo and building stuff.
2118 /// Should not be considered stable by end users.
2119 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
2120 pub struct BuildManifest {
2121 pub target: TargetSelection,
2124 impl Step for BuildManifest {
2125 type Output = GeneratedTarball;
2126 const DEFAULT: bool = false;
2127 const ONLY_HOSTS: bool = true;
2129 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2130 run.path("build-manifest")
2133 fn make_run(run: RunConfig<'_>) {
2134 run.builder.ensure(BuildManifest { target: run.target });
2137 fn run(self, builder: &Builder<'_>) -> GeneratedTarball {
2138 let build_manifest = builder.tool_exe(Tool::BuildManifest);
2140 let tarball = Tarball::new(builder, "build-manifest", &self.target.triple);
2141 tarball.add_file(&build_manifest, "bin", 0o755);
2146 /// Tarball containing artifacts necessary to reproduce the build of rustc.
2148 /// Currently this is the PGO profile data.
2150 /// Should not be considered stable by end users.
2151 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
2152 pub struct ReproducibleArtifacts {
2153 pub target: TargetSelection,
2156 impl Step for ReproducibleArtifacts {
2157 type Output = Option<GeneratedTarball>;
2158 const DEFAULT: bool = true;
2159 const ONLY_HOSTS: bool = true;
2161 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2162 run.path("reproducible-artifacts")
2165 fn make_run(run: RunConfig<'_>) {
2166 run.builder.ensure(ReproducibleArtifacts { target: run.target });
2169 fn run(self, builder: &Builder<'_>) -> Self::Output {
2170 let mut added_anything = false;
2171 let tarball = Tarball::new(builder, "reproducible-artifacts", &self.target.triple);
2172 if let Some(path) = builder.config.rust_profile_use.as_ref() {
2173 tarball.add_file(path, ".", 0o644);
2174 added_anything = true;
2176 if let Some(path) = builder.config.llvm_profile_use.as_ref() {
2177 tarball.add_file(path, ".", 0o644);
2178 added_anything = true;
2180 if added_anything { Some(tarball.generate()) } else { None }