1 // Copyright 2017 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
13 use std::path::PathBuf;
14 use std::process::Command;
18 use builder::{Step, RunConfig, ShouldRun, Builder};
19 use util::{copy, exe, add_lib_path};
20 use compile::{self, libtest_stamp, libstd_stamp, librustc_stamp};
25 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
26 pub struct CleanTools {
27 pub compiler: Compiler,
28 pub target: Interned<String>,
32 impl Step for CleanTools {
35 fn should_run(run: ShouldRun) -> ShouldRun {
39 /// Build a tool in `src/tools`
41 /// This will build the specified tool with the specified `host` compiler in
42 /// `stage` into the normal cargo output directory.
43 fn run(self, builder: &Builder) {
44 let build = builder.build;
45 let compiler = self.compiler;
46 let target = self.target;
49 let stamp = match mode {
50 Mode::Libstd => libstd_stamp(build, compiler, target),
51 Mode::Libtest => libtest_stamp(build, compiler, target),
52 Mode::Librustc => librustc_stamp(build, compiler, target),
55 let out_dir = build.cargo_out(compiler, Mode::Tool, target);
56 build.clear_if_dirty(&out_dir, &stamp);
60 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
63 target: Interned<String>,
68 impl Step for ToolBuild {
69 type Output = PathBuf;
71 fn should_run(run: ShouldRun) -> ShouldRun {
75 /// Build a tool in `src/tools`
77 /// This will build the specified tool with the specified `host` compiler in
78 /// `stage` into the normal cargo output directory.
79 fn run(self, builder: &Builder) -> PathBuf {
80 let build = builder.build;
81 let compiler = self.compiler;
82 let target = self.target;
86 Mode::Libstd => builder.ensure(compile::Std { compiler, target }),
87 Mode::Libtest => builder.ensure(compile::Test { compiler, target }),
88 Mode::Librustc => builder.ensure(compile::Rustc { compiler, target }),
89 Mode::Tool => panic!("unexpected Mode::Tool for tool build")
92 let _folder = build.fold_output(|| format!("stage{}-{}", compiler.stage, tool));
93 println!("Building stage{} tool {} ({})", compiler.stage, tool, target);
95 let mut cargo = prepare_tool_cargo(builder, compiler, target, tool);
96 build.run(&mut cargo);
97 build.cargo_out(compiler, Mode::Tool, target).join(exe(tool, &compiler.host))
101 fn prepare_tool_cargo(
104 target: Interned<String>,
107 let build = builder.build;
108 let mut cargo = builder.cargo(compiler, Mode::Tool, target, "build");
109 let dir = build.src.join("src/tools").join(tool);
110 cargo.arg("--manifest-path").arg(dir.join("Cargo.toml"));
112 // We don't want to build tools dynamically as they'll be running across
113 // stages and such and it's just easier if they're not dynamically linked.
114 cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
116 if let Some(dir) = build.openssl_install_dir(target) {
117 cargo.env("OPENSSL_STATIC", "1");
118 cargo.env("OPENSSL_DIR", dir);
119 cargo.env("LIBZ_SYS_STATIC", "1");
122 cargo.env("CFG_RELEASE_CHANNEL", &build.config.channel);
123 cargo.env("CFG_VERSION", build.rust_version());
125 let info = GitInfo::new(&build.config, &dir);
126 if let Some(sha) = info.sha() {
127 cargo.env("CFG_COMMIT_HASH", sha);
129 if let Some(sha_short) = info.sha_short() {
130 cargo.env("CFG_SHORT_COMMIT_HASH", sha_short);
132 if let Some(date) = info.commit_date() {
133 cargo.env("CFG_COMMIT_DATE", date);
139 ($($name:ident, $path:expr, $tool_name:expr, $mode:expr;)+) => {
140 #[derive(Copy, Clone)]
147 impl<'a> Builder<'a> {
148 pub fn tool_exe(&self, tool: Tool) -> PathBuf {
152 compiler: self.compiler(0, self.build.build),
153 target: self.build.build,
161 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
163 pub compiler: Compiler,
164 pub target: Interned<String>,
167 impl Step for $name {
168 type Output = PathBuf;
170 fn should_run(run: ShouldRun) -> ShouldRun {
174 fn make_run(run: RunConfig) {
175 run.builder.ensure($name {
176 compiler: run.builder.compiler(run.builder.top_stage, run.builder.build.build),
181 fn run(self, builder: &Builder) -> PathBuf {
182 builder.ensure(ToolBuild {
183 compiler: self.compiler,
195 Rustbook, "src/tools/rustbook", "rustbook", Mode::Librustc;
196 ErrorIndex, "src/tools/error_index_generator", "error_index_generator", Mode::Librustc;
197 UnstableBookGen, "src/tools/unstable-book-gen", "unstable-book-gen", Mode::Libstd;
198 Tidy, "src/tools/tidy", "tidy", Mode::Libstd;
199 Linkchecker, "src/tools/linkchecker", "linkchecker", Mode::Libstd;
200 CargoTest, "src/tools/cargotest", "cargotest", Mode::Libstd;
201 Compiletest, "src/tools/compiletest", "compiletest", Mode::Libtest;
202 BuildManifest, "src/tools/build-manifest", "build-manifest", Mode::Libstd;
203 RemoteTestClient, "src/tools/remote-test-client", "remote-test-client", Mode::Libstd;
204 RustInstaller, "src/tools/rust-installer", "rust-installer", Mode::Libstd;
207 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
208 pub struct RemoteTestServer {
209 pub compiler: Compiler,
210 pub target: Interned<String>,
213 impl Step for RemoteTestServer {
214 type Output = PathBuf;
216 fn should_run(run: ShouldRun) -> ShouldRun {
217 run.path("src/tools/remote-test-server")
220 fn make_run(run: RunConfig) {
221 run.builder.ensure(RemoteTestServer {
222 compiler: run.builder.compiler(run.builder.top_stage, run.builder.build.build),
227 fn run(self, builder: &Builder) -> PathBuf {
228 builder.ensure(ToolBuild {
229 compiler: self.compiler,
231 tool: "remote-test-server",
237 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
239 pub host: Interned<String>,
242 impl Step for Rustdoc {
243 type Output = PathBuf;
244 const DEFAULT: bool = true;
245 const ONLY_HOSTS: bool = true;
247 fn should_run(run: ShouldRun) -> ShouldRun {
248 run.path("src/tools/rustdoc")
251 fn make_run(run: RunConfig) {
252 run.builder.ensure(Rustdoc {
257 fn run(self, builder: &Builder) -> PathBuf {
258 let build = builder.build;
259 let target_compiler = builder.compiler(builder.top_stage, self.host);
260 let target = target_compiler.host;
261 let build_compiler = if target_compiler.stage == 0 {
262 builder.compiler(0, builder.build.build)
263 } else if target_compiler.stage >= 2 {
264 // Past stage 2, we consider the compiler to be ABI-compatible and hence capable of
265 // building rustdoc itself.
266 builder.compiler(target_compiler.stage, builder.build.build)
268 // Similar to `compile::Assemble`, build with the previous stage's compiler. Otherwise
269 // we'd have stageN/bin/rustc and stageN/bin/rustdoc be effectively different stage
270 // compilers, which isn't what we want.
271 builder.compiler(target_compiler.stage - 1, builder.build.build)
274 builder.ensure(compile::Rustc { compiler: build_compiler, target });
276 let _folder = build.fold_output(|| format!("stage{}-rustdoc", target_compiler.stage));
277 println!("Building rustdoc for stage{} ({})", target_compiler.stage, target_compiler.host);
279 let mut cargo = prepare_tool_cargo(builder, build_compiler, target, "rustdoc");
280 build.run(&mut cargo);
281 // Cargo adds a number of paths to the dylib search path on windows, which results in
282 // the wrong rustdoc being executed. To avoid the conflicting rustdocs, we name the "tool"
283 // rustdoc a different name.
284 let tool_rustdoc = build.cargo_out(build_compiler, Mode::Tool, target)
285 .join(exe("rustdoc-tool-binary", &target_compiler.host));
287 // don't create a stage0-sysroot/bin directory.
288 if target_compiler.stage > 0 {
289 let sysroot = builder.sysroot(target_compiler);
290 let bindir = sysroot.join("bin");
291 t!(fs::create_dir_all(&bindir));
292 let bin_rustdoc = bindir.join(exe("rustdoc", &*target_compiler.host));
293 let _ = fs::remove_file(&bin_rustdoc);
294 copy(&tool_rustdoc, &bin_rustdoc);
302 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
304 pub compiler: Compiler,
305 pub target: Interned<String>,
308 impl Step for Cargo {
309 type Output = PathBuf;
310 const DEFAULT: bool = true;
311 const ONLY_HOSTS: bool = true;
313 fn should_run(run: ShouldRun) -> ShouldRun {
314 let builder = run.builder;
315 run.path("src/tools/cargo").default_condition(builder.build.config.extended)
318 fn make_run(run: RunConfig) {
319 run.builder.ensure(Cargo {
320 compiler: run.builder.compiler(run.builder.top_stage, run.builder.build.build),
325 fn run(self, builder: &Builder) -> PathBuf {
326 builder.ensure(native::Openssl {
329 // Cargo depends on procedural macros, which requires a full host
330 // compiler to be available, so we need to depend on that.
331 builder.ensure(compile::Rustc {
332 compiler: self.compiler,
333 target: builder.build.build,
335 builder.ensure(ToolBuild {
336 compiler: self.compiler,
339 mode: Mode::Librustc,
344 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
346 pub compiler: Compiler,
347 pub target: Interned<String>,
350 impl Step for Clippy {
351 type Output = PathBuf;
352 const DEFAULT: bool = false;
353 const ONLY_HOSTS: bool = true;
355 fn should_run(run: ShouldRun) -> ShouldRun {
356 run.path("src/tools/clippy")
359 fn make_run(run: RunConfig) {
360 run.builder.ensure(Clippy {
361 compiler: run.builder.compiler(run.builder.top_stage, run.builder.build.build),
366 fn run(self, builder: &Builder) -> PathBuf {
367 // Clippy depends on procedural macros (serde), which requires a full host
368 // compiler to be available, so we need to depend on that.
369 builder.ensure(compile::Rustc {
370 compiler: self.compiler,
371 target: builder.build.build,
373 builder.ensure(ToolBuild {
374 compiler: self.compiler,
377 mode: Mode::Librustc,
382 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
384 pub compiler: Compiler,
385 pub target: Interned<String>,
389 type Output = PathBuf;
390 const DEFAULT: bool = true;
391 const ONLY_HOSTS: bool = true;
393 fn should_run(run: ShouldRun) -> ShouldRun {
394 let builder = run.builder;
395 run.path("src/tools/rls").default_condition(builder.build.config.extended)
398 fn make_run(run: RunConfig) {
399 run.builder.ensure(Rls {
400 compiler: run.builder.compiler(run.builder.top_stage, run.builder.build.build),
405 fn run(self, builder: &Builder) -> PathBuf {
406 builder.ensure(native::Openssl {
409 // RLS depends on procedural macros, which requires a full host
410 // compiler to be available, so we need to depend on that.
411 builder.ensure(compile::Rustc {
412 compiler: self.compiler,
413 target: builder.build.build,
415 builder.ensure(ToolBuild {
416 compiler: self.compiler,
419 mode: Mode::Librustc,
424 impl<'a> Builder<'a> {
425 /// Get a `Command` which is ready to run `tool` in `stage` built for
427 pub fn tool_cmd(&self, tool: Tool) -> Command {
428 let mut cmd = Command::new(self.tool_exe(tool));
429 let compiler = self.compiler(0, self.build.build);
430 self.prepare_tool_cmd(compiler, &mut cmd);
434 /// Prepares the `cmd` provided to be able to run the `compiler` provided.
436 /// Notably this munges the dynamic library lookup path to point to the
437 /// right location to run `compiler`.
438 fn prepare_tool_cmd(&self, compiler: Compiler, cmd: &mut Command) {
439 let host = &compiler.host;
440 let mut paths: Vec<PathBuf> = vec![
441 PathBuf::from(&self.sysroot_libdir(compiler, compiler.host)),
442 self.cargo_out(compiler, Mode::Tool, *host).join("deps"),
445 // On MSVC a tool may invoke a C compiler (e.g. compiletest in run-make
446 // mode) and that C compiler may need some extra PATH modification. Do
448 if compiler.host.contains("msvc") {
449 let curpaths = env::var_os("PATH").unwrap_or_default();
450 let curpaths = env::split_paths(&curpaths).collect::<Vec<_>>();
451 for &(ref k, ref v) in self.cc[&compiler.host].0.env() {
455 for path in env::split_paths(v) {
456 if !curpaths.contains(&path) {
462 add_lib_path(paths, cmd);