-// Copyright 2016 The Rust Project Developers. See the COPYRIGHT
-// file at the top-level directory of this distribution and at
-// http://rust-lang.org/COPYRIGHT.
-//
-// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
-// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
-// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
-// option. This file may not be copied, modified, or distributed
-// except according to those terms.
-
//! Implementation of the install aspects of the compiler.
//!
//! This module is responsible for installing the standard library,
use std::env;
use std::fs;
-use std::path::{Path, PathBuf, Component};
+use std::path::{Component, Path, PathBuf};
use std::process::Command;
-use Build;
-use dist::{sanitize_sh, tmpdir};
+use crate::util::t;
-/// Installs everything.
-pub fn install(build: &Build, stage: u32, host: &str) {
- let prefix_default = PathBuf::from("/usr/local");
- let docdir_default = PathBuf::from("share/doc/rust");
- let mandir_default = PathBuf::from("share/man");
- let libdir_default = PathBuf::from("lib");
- let prefix = build.config.prefix.as_ref().unwrap_or(&prefix_default);
- let docdir = build.config.docdir.as_ref().unwrap_or(&docdir_default);
- let libdir = build.config.libdir.as_ref().unwrap_or(&libdir_default);
- let mandir = build.config.mandir.as_ref().unwrap_or(&mandir_default);
+use crate::dist;
+use crate::tarball::GeneratedTarball;
+use crate::Compiler;
- let docdir = prefix.join(docdir);
- let libdir = prefix.join(libdir);
- let mandir = prefix.join(mandir);
+use crate::builder::{Builder, RunConfig, ShouldRun, Step};
+use crate::config::{Config, TargetSelection};
- let destdir = env::var_os("DESTDIR").map(PathBuf::from);
+#[cfg(target_os = "illumos")]
+const SHELL: &str = "bash";
+#[cfg(not(target_os = "illumos"))]
+const SHELL: &str = "sh";
- let prefix = add_destdir(&prefix, &destdir);
- let docdir = add_destdir(&docdir, &destdir);
- let libdir = add_destdir(&libdir, &destdir);
- let mandir = add_destdir(&mandir, &destdir);
+// We have to run a few shell scripts, which choke quite a bit on both `\`
+// characters and on `C:\` paths, so normalize both of them away.
+fn sanitize_sh(path: &Path) -> String {
+ let path = path.to_str().unwrap().replace("\\", "/");
+ return change_drive(unc_to_lfs(&path)).unwrap_or(path);
- let empty_dir = build.out.join("tmp/empty_dir");
- t!(fs::create_dir_all(&empty_dir));
- if build.config.docs {
- install_sh(&build, "docs", "rust-docs", stage, host, &prefix,
- &docdir, &libdir, &mandir, &empty_dir);
+ fn unc_to_lfs(s: &str) -> &str {
+ s.strip_prefix("//?/").unwrap_or(s)
}
- for target in build.config.target.iter() {
- install_sh(&build, "std", "rust-std", stage, target, &prefix,
- &docdir, &libdir, &mandir, &empty_dir);
+ fn change_drive(s: &str) -> Option<String> {
+ let mut ch = s.chars();
+ let drive = ch.next().unwrap_or('C');
+ if ch.next() != Some(':') {
+ return None;
+ }
+ if ch.next() != Some('/') {
+ return None;
+ }
+ Some(format!("/{}/{}", drive, &s[drive.len_utf8() + 2..]))
}
+}
+
+fn install_sh(
+ builder: &Builder<'_>,
+ package: &str,
+ stage: u32,
+ host: Option<TargetSelection>,
+ tarball: &GeneratedTarball,
+) {
+ builder.info(&format!("Install {} stage{} ({:?})", package, stage, host));
- install_sh(&build, "rustc", "rustc", stage, host, &prefix,
- &docdir, &libdir, &mandir, &empty_dir);
+ let prefix = default_path(&builder.config.prefix, "/usr/local");
+ let sysconfdir = prefix.join(default_path(&builder.config.sysconfdir, "/etc"));
+ let datadir = prefix.join(default_path(&builder.config.datadir, "share"));
+ let docdir = prefix.join(default_path(&builder.config.docdir, "share/doc/rust"));
+ let mandir = prefix.join(default_path(&builder.config.mandir, "share/man"));
+ let libdir = prefix.join(default_path(&builder.config.libdir, "lib"));
+ let bindir = prefix.join(&builder.config.bindir); // Default in config.rs
+
+ let empty_dir = builder.out.join("tmp/empty_dir");
+ t!(fs::create_dir_all(&empty_dir));
+
+ let mut cmd = Command::new(SHELL);
+ cmd.current_dir(&empty_dir)
+ .arg(sanitize_sh(&tarball.decompressed_output().join("install.sh")))
+ .arg(format!("--prefix={}", prepare_dir(prefix)))
+ .arg(format!("--sysconfdir={}", prepare_dir(sysconfdir)))
+ .arg(format!("--datadir={}", prepare_dir(datadir)))
+ .arg(format!("--docdir={}", prepare_dir(docdir)))
+ .arg(format!("--bindir={}", prepare_dir(bindir)))
+ .arg(format!("--libdir={}", prepare_dir(libdir)))
+ .arg(format!("--mandir={}", prepare_dir(mandir)))
+ .arg("--disable-ldconfig");
+ builder.run(&mut cmd);
t!(fs::remove_dir_all(&empty_dir));
}
-fn install_sh(build: &Build, package: &str, name: &str, stage: u32, host: &str,
- prefix: &Path, docdir: &Path, libdir: &Path, mandir: &Path, empty_dir: &Path) {
- println!("Install {} stage{} ({})", package, stage, host);
- let package_name = format!("{}-{}-{}", name, build.rust_package_vers(), host);
-
- let mut cmd = Command::new("sh");
- cmd.current_dir(empty_dir)
- .arg(sanitize_sh(&tmpdir(build).join(&package_name).join("install.sh")))
- .arg(format!("--prefix={}", sanitize_sh(prefix)))
- .arg(format!("--docdir={}", sanitize_sh(docdir)))
- .arg(format!("--libdir={}", sanitize_sh(libdir)))
- .arg(format!("--mandir={}", sanitize_sh(mandir)))
- .arg("--disable-ldconfig");
- build.run(&mut cmd);
+fn default_path(config: &Option<PathBuf>, default: &str) -> PathBuf {
+ config.as_ref().cloned().unwrap_or_else(|| PathBuf::from(default))
+}
+
+fn prepare_dir(mut path: PathBuf) -> String {
+ // The DESTDIR environment variable is a standard way to install software in a subdirectory
+ // while keeping the original directory structure, even if the prefix or other directories
+ // contain absolute paths.
+ //
+ // More information on the environment variable is available here:
+ // https://www.gnu.org/prep/standards/html_node/DESTDIR.html
+ if let Some(destdir) = env::var_os("DESTDIR").map(PathBuf::from) {
+ let without_destdir = path.clone();
+ path = destdir;
+ // Custom .join() which ignores disk roots.
+ for part in without_destdir.components() {
+ if let Component::Normal(s) = part {
+ path.push(s)
+ }
+ }
+ }
+
+ // The installation command is not executed from the current directory, but from a temporary
+ // directory. To prevent relative paths from breaking this converts relative paths to absolute
+ // paths. std::fs::canonicalize is not used as that requires the path to actually be present.
+ if path.is_relative() {
+ path = std::env::current_dir().expect("failed to get the current directory").join(path);
+ assert!(path.is_absolute(), "could not make the path relative");
+ }
+
+ sanitize_sh(&path)
}
-fn add_destdir(path: &Path, destdir: &Option<PathBuf>) -> PathBuf {
- let mut ret = match *destdir {
- Some(ref dest) => dest.clone(),
- None => return path.to_path_buf(),
+macro_rules! install {
+ (($sel:ident, $builder:ident, $_config:ident),
+ $($name:ident,
+ $condition_name: ident = $path_or_alias: literal,
+ $default_cond:expr,
+ only_hosts: $only_hosts:expr,
+ $run_item:block $(, $c:ident)*;)+) => {
+ $(
+ #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
+ pub struct $name {
+ pub compiler: Compiler,
+ pub target: TargetSelection,
+ }
+
+ impl $name {
+ #[allow(dead_code)]
+ fn should_build(config: &Config) -> bool {
+ config.extended && config.tools.as_ref()
+ .map_or(true, |t| t.contains($path_or_alias))
+ }
+ }
+
+ impl Step for $name {
+ type Output = ();
+ const DEFAULT: bool = true;
+ const ONLY_HOSTS: bool = $only_hosts;
+ $(const $c: bool = true;)*
+
+ fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
+ let $_config = &run.builder.config;
+ run.$condition_name($path_or_alias).default_condition($default_cond)
+ }
+
+ fn make_run(run: RunConfig<'_>) {
+ run.builder.ensure($name {
+ compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
+ target: run.target,
+ });
+ }
+
+ fn run($sel, $builder: &Builder<'_>) {
+ $run_item
+ }
+ })+
+ }
+}
+
+install!((self, builder, _config),
+ Docs, path = "src/doc", _config.docs, only_hosts: false, {
+ let tarball = builder.ensure(dist::Docs { host: self.target }).expect("missing docs");
+ install_sh(builder, "docs", self.compiler.stage, Some(self.target), &tarball);
+ };
+ Std, path = "library/std", true, only_hosts: false, {
+ for target in &builder.targets {
+ // `expect` should be safe, only None when host != build, but this
+ // only runs when host == build
+ let tarball = builder.ensure(dist::Std {
+ compiler: self.compiler,
+ target: *target
+ }).expect("missing std");
+ install_sh(builder, "std", self.compiler.stage, Some(*target), &tarball);
+ }
+ };
+ Cargo, alias = "cargo", Self::should_build(_config), only_hosts: true, {
+ let tarball = builder
+ .ensure(dist::Cargo { compiler: self.compiler, target: self.target })
+ .expect("missing cargo");
+ install_sh(builder, "cargo", self.compiler.stage, Some(self.target), &tarball);
+ };
+ RustAnalyzer, alias = "rust-analyzer", Self::should_build(_config), only_hosts: true, {
+ if let Some(tarball) =
+ builder.ensure(dist::RustAnalyzer { compiler: self.compiler, target: self.target })
+ {
+ install_sh(builder, "rust-analyzer", self.compiler.stage, Some(self.target), &tarball);
+ } else {
+ builder.info(
+ &format!("skipping Install rust-analyzer stage{} ({})", self.compiler.stage, self.target),
+ );
+ }
+ };
+ Clippy, alias = "clippy", Self::should_build(_config), only_hosts: true, {
+ let tarball = builder
+ .ensure(dist::Clippy { compiler: self.compiler, target: self.target })
+ .expect("missing clippy");
+ install_sh(builder, "clippy", self.compiler.stage, Some(self.target), &tarball);
+ };
+ Miri, alias = "miri", Self::should_build(_config), only_hosts: true, {
+ if let Some(tarball) = builder.ensure(dist::Miri { compiler: self.compiler, target: self.target }) {
+ install_sh(builder, "miri", self.compiler.stage, Some(self.target), &tarball);
+ } else {
+ // Miri is only available on nightly
+ builder.info(
+ &format!("skipping Install miri stage{} ({})", self.compiler.stage, self.target),
+ );
+ }
+ };
+ Rustfmt, alias = "rustfmt", Self::should_build(_config), only_hosts: true, {
+ if let Some(tarball) = builder.ensure(dist::Rustfmt {
+ compiler: self.compiler,
+ target: self.target
+ }) {
+ install_sh(builder, "rustfmt", self.compiler.stage, Some(self.target), &tarball);
+ } else {
+ builder.info(
+ &format!("skipping Install Rustfmt stage{} ({})", self.compiler.stage, self.target),
+ );
+ }
};
- for part in path.components() {
- match part {
- Component::Normal(s) => ret.push(s),
- _ => {}
+ RustDemangler, alias = "rust-demangler", Self::should_build(_config), only_hosts: true, {
+ // Note: Even though `should_build` may return true for `extended` default tools,
+ // dist::RustDemangler may still return None, unless the target-dependent `profiler` config
+ // is also true, or the `tools` array explicitly includes "rust-demangler".
+ if let Some(tarball) = builder.ensure(dist::RustDemangler {
+ compiler: self.compiler,
+ target: self.target
+ }) {
+ install_sh(builder, "rust-demangler", self.compiler.stage, Some(self.target), &tarball);
+ } else {
+ builder.info(
+ &format!("skipping Install RustDemangler stage{} ({})",
+ self.compiler.stage, self.target),
+ );
}
+ };
+ Analysis, alias = "analysis", Self::should_build(_config), only_hosts: false, {
+ // `expect` should be safe, only None with host != build, but this
+ // only uses the `build` compiler
+ let tarball = builder.ensure(dist::Analysis {
+ // Find the actual compiler (handling the full bootstrap option) which
+ // produced the save-analysis data because that data isn't copied
+ // through the sysroot uplifting.
+ compiler: builder.compiler_for(builder.top_stage, builder.config.build, self.target),
+ target: self.target
+ }).expect("missing analysis");
+ install_sh(builder, "analysis", self.compiler.stage, Some(self.target), &tarball);
+ };
+ Rustc, path = "compiler/rustc", true, only_hosts: true, {
+ let tarball = builder.ensure(dist::Rustc {
+ compiler: builder.compiler(builder.top_stage, self.target),
+ });
+ install_sh(builder, "rustc", self.compiler.stage, Some(self.target), &tarball);
+ };
+);
+
+#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
+pub struct Src {
+ pub stage: u32,
+}
+
+impl Step for Src {
+ type Output = ();
+ const DEFAULT: bool = true;
+ const ONLY_HOSTS: bool = true;
+
+ fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
+ let config = &run.builder.config;
+ let cond = config.extended && config.tools.as_ref().map_or(true, |t| t.contains("src"));
+ run.path("src").default_condition(cond)
+ }
+
+ fn make_run(run: RunConfig<'_>) {
+ run.builder.ensure(Src { stage: run.builder.top_stage });
+ }
+
+ fn run(self, builder: &Builder<'_>) {
+ let tarball = builder.ensure(dist::Src);
+ install_sh(builder, "src", self.stage, None, &tarball);
}
- return ret
}