1 //! Implementation of the install aspects of the compiler.
3 //! This module is responsible for installing the standard library,
4 //! compiler, and documentation.
8 use std::path::{Component, Path, PathBuf};
9 use std::process::Command;
13 use crate::dist::{self, pkgname, sanitize_sh, tmpdir};
16 use crate::builder::{Builder, RunConfig, ShouldRun, Step};
17 use crate::cache::Interned;
18 use crate::config::Config;
20 pub fn install_docs(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
21 install_sh(builder, "docs", "rust-docs", stage, Some(host));
24 pub fn install_std(builder: &Builder<'_>, stage: u32, target: Interned<String>) {
25 install_sh(builder, "std", "rust-std", stage, Some(target));
28 pub fn install_cargo(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
29 install_sh(builder, "cargo", "cargo", stage, Some(host));
32 pub fn install_rls(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
33 install_sh(builder, "rls", "rls", stage, Some(host));
35 pub fn install_clippy(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
36 install_sh(builder, "clippy", "clippy", stage, Some(host));
38 pub fn install_miri(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
39 install_sh(builder, "miri", "miri", stage, Some(host));
42 pub fn install_rustfmt(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
43 install_sh(builder, "rustfmt", "rustfmt", stage, Some(host));
46 pub fn install_analysis(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
47 install_sh(builder, "analysis", "rust-analysis", stage, Some(host));
50 pub fn install_src(builder: &Builder<'_>, stage: u32) {
51 install_sh(builder, "src", "rust-src", stage, None);
53 pub fn install_rustc(builder: &Builder<'_>, stage: u32, host: Interned<String>) {
54 install_sh(builder, "rustc", "rustc", stage, Some(host));
58 builder: &Builder<'_>,
62 host: Option<Interned<String>>,
64 builder.info(&format!("Install {} stage{} ({:?})", package, stage, host));
66 let prefix_default = PathBuf::from("/usr/local");
67 let sysconfdir_default = PathBuf::from("/etc");
68 let datadir_default = PathBuf::from("share");
69 let docdir_default = datadir_default.join("doc/rust");
70 let libdir_default = PathBuf::from("lib");
71 let mandir_default = datadir_default.join("man");
72 let prefix = builder.config.prefix.as_ref().map_or(prefix_default, |p| {
74 .unwrap_or_else(|err| panic!("could not create {}: {}", p.display(), err));
76 .unwrap_or_else(|err| panic!("could not canonicalize {}: {}", p.display(), err))
78 let sysconfdir = builder.config.sysconfdir.as_ref().unwrap_or(&sysconfdir_default);
79 let datadir = builder.config.datadir.as_ref().unwrap_or(&datadir_default);
80 let docdir = builder.config.docdir.as_ref().unwrap_or(&docdir_default);
81 let bindir = &builder.config.bindir;
82 let libdir = builder.config.libdir.as_ref().unwrap_or(&libdir_default);
83 let mandir = builder.config.mandir.as_ref().unwrap_or(&mandir_default);
85 let sysconfdir = prefix.join(sysconfdir);
86 let datadir = prefix.join(datadir);
87 let docdir = prefix.join(docdir);
88 let bindir = prefix.join(bindir);
89 let libdir = prefix.join(libdir);
90 let mandir = prefix.join(mandir);
92 let destdir = env::var_os("DESTDIR").map(PathBuf::from);
94 let prefix = add_destdir(&prefix, &destdir);
95 let sysconfdir = add_destdir(&sysconfdir, &destdir);
96 let datadir = add_destdir(&datadir, &destdir);
97 let docdir = add_destdir(&docdir, &destdir);
98 let bindir = add_destdir(&bindir, &destdir);
99 let libdir = add_destdir(&libdir, &destdir);
100 let mandir = add_destdir(&mandir, &destdir);
102 let empty_dir = builder.out.join("tmp/empty_dir");
104 t!(fs::create_dir_all(&empty_dir));
105 let package_name = if let Some(host) = host {
106 format!("{}-{}", pkgname(builder, name), host)
108 pkgname(builder, name)
111 let mut cmd = Command::new("sh");
112 cmd.current_dir(&empty_dir)
113 .arg(sanitize_sh(&tmpdir(builder).join(&package_name).join("install.sh")))
114 .arg(format!("--prefix={}", sanitize_sh(&prefix)))
115 .arg(format!("--sysconfdir={}", sanitize_sh(&sysconfdir)))
116 .arg(format!("--datadir={}", sanitize_sh(&datadir)))
117 .arg(format!("--docdir={}", sanitize_sh(&docdir)))
118 .arg(format!("--bindir={}", sanitize_sh(&bindir)))
119 .arg(format!("--libdir={}", sanitize_sh(&libdir)))
120 .arg(format!("--mandir={}", sanitize_sh(&mandir)))
121 .arg("--disable-ldconfig");
122 builder.run(&mut cmd);
123 t!(fs::remove_dir_all(&empty_dir));
126 fn add_destdir(path: &Path, destdir: &Option<PathBuf>) -> PathBuf {
127 let mut ret = match *destdir {
128 Some(ref dest) => dest.clone(),
129 None => return path.to_path_buf(),
131 for part in path.components() {
132 if let Component::Normal(s) = part {
139 macro_rules! install {
140 (($sel:ident, $builder:ident, $_config:ident),
144 only_hosts: $only_hosts:expr,
145 $run_item:block $(, $c:ident)*;)+) => {
147 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
149 pub compiler: Compiler,
150 pub target: Interned<String>,
155 fn should_build(config: &Config) -> bool {
156 config.extended && config.tools.as_ref()
157 .map_or(true, |t| t.contains($path))
161 fn should_install(builder: &Builder<'_>) -> bool {
162 builder.config.tools.as_ref().map_or(false, |t| t.contains($path))
166 impl Step for $name {
168 const DEFAULT: bool = true;
169 const ONLY_HOSTS: bool = $only_hosts;
170 $(const $c: bool = true;)*
172 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
173 let $_config = &run.builder.config;
174 run.path($path).default_condition($default_cond)
177 fn make_run(run: RunConfig<'_>) {
178 run.builder.ensure($name {
179 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
184 fn run($sel, $builder: &Builder<'_>) {
191 install!((self, builder, _config),
192 Docs, "src/doc", _config.docs, only_hosts: false, {
193 builder.ensure(dist::Docs { host: self.target });
194 install_docs(builder, self.compiler.stage, self.target);
196 Std, "src/libstd", true, only_hosts: true, {
197 for target in &builder.targets {
198 builder.ensure(dist::Std {
199 compiler: self.compiler,
202 install_std(builder, self.compiler.stage, *target);
205 Cargo, "cargo", Self::should_build(_config), only_hosts: true, {
206 builder.ensure(dist::Cargo { compiler: self.compiler, target: self.target });
207 install_cargo(builder, self.compiler.stage, self.target);
209 Rls, "rls", Self::should_build(_config), only_hosts: true, {
210 if builder.ensure(dist::Rls { compiler: self.compiler, target: self.target }).is_some() ||
211 Self::should_install(builder) {
212 install_rls(builder, self.compiler.stage, self.target);
215 &format!("skipping Install RLS stage{} ({})", self.compiler.stage, self.target),
219 Clippy, "clippy", Self::should_build(_config), only_hosts: true, {
220 builder.ensure(dist::Clippy { compiler: self.compiler, target: self.target });
221 if Self::should_install(builder) {
222 install_clippy(builder, self.compiler.stage, self.target);
225 &format!("skipping Install clippy stage{} ({})", self.compiler.stage, self.target),
229 Miri, "miri", Self::should_build(_config), only_hosts: true, {
230 if builder.ensure(dist::Miri { compiler: self.compiler, target: self.target }).is_some() ||
231 Self::should_install(builder) {
232 install_miri(builder, self.compiler.stage, self.target);
235 &format!("skipping Install miri stage{} ({})", self.compiler.stage, self.target),
239 Rustfmt, "rustfmt", Self::should_build(_config), only_hosts: true, {
240 if builder.ensure(dist::Rustfmt {
241 compiler: self.compiler,
243 }).is_some() || Self::should_install(builder) {
244 install_rustfmt(builder, self.compiler.stage, self.target);
247 &format!("skipping Install Rustfmt stage{} ({})", self.compiler.stage, self.target),
251 Analysis, "analysis", Self::should_build(_config), only_hosts: false, {
252 builder.ensure(dist::Analysis {
253 // Find the actual compiler (handling the full bootstrap option) which
254 // produced the save-analysis data because that data isn't copied
255 // through the sysroot uplifting.
256 compiler: builder.compiler_for(builder.top_stage, builder.config.build, self.target),
259 install_analysis(builder, self.compiler.stage, self.target);
261 Rustc, "src/librustc", true, only_hosts: true, {
262 builder.ensure(dist::Rustc {
263 compiler: builder.compiler(builder.top_stage, self.target),
265 install_rustc(builder, self.compiler.stage, self.target);
269 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
276 const DEFAULT: bool = true;
277 const ONLY_HOSTS: bool = true;
279 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
280 let config = &run.builder.config;
281 let cond = config.extended && config.tools.as_ref().map_or(true, |t| t.contains("src"));
282 run.path("src").default_condition(cond)
285 fn make_run(run: RunConfig<'_>) {
286 run.builder.ensure(Src { stage: run.builder.top_stage });
289 fn run(self, builder: &Builder<'_>) {
290 builder.ensure(dist::Src);
291 install_src(builder, self.stage);