1 //! Shim which is passed to Cargo as "rustc" when running the bootstrap.
3 //! This shim will take care of some various tasks that our build process
4 //! requires that Cargo can't quite do through normal configuration:
6 //! 1. When compiling build scripts and build dependencies, we need a guaranteed
7 //! full standard library available. The only compiler which actually has
8 //! this is the snapshot, so we detect this situation and always compile with
9 //! the snapshot compiler.
10 //! 2. We pass a bunch of `--cfg` and other flags based on what we're compiling
11 //! (and this slightly differs based on a whether we're using a snapshot or
12 //! not), so we do that all here.
14 //! This may one day be replaced by RUSTFLAGS, but the dynamic nature of
15 //! switching compilers for the bootstrap and for build scripts will probably
16 //! never get replaced.
18 include!("../dylib_util.rs");
21 use std::path::PathBuf;
22 use std::process::{Child, Command};
23 use std::str::FromStr;
24 use std::time::Instant;
27 let args = env::args_os().skip(1).collect::<Vec<_>>();
29 // Detect whether or not we're a build script depending on whether --target
30 // is passed (a bit janky...)
31 let target = args.windows(2).find(|w| &*w[0] == "--target").and_then(|w| w[1].to_str());
32 let version = args.iter().find(|w| &**w == "-vV");
34 let verbose = match env::var("RUSTC_VERBOSE") {
35 Ok(s) => usize::from_str(&s).expect("RUSTC_VERBOSE should be an integer"),
39 // Use a different compiler for build scripts, since there may not yet be a
40 // libstd for the real compiler to use. However, if Cargo is attempting to
41 // determine the version of the compiler, the real compiler needs to be
42 // used. Currently, these two states are differentiated based on whether
43 // --target and -vV is/isn't passed.
44 let (rustc, libdir) = if target.is_none() && version.is_none() {
45 ("RUSTC_SNAPSHOT", "RUSTC_SNAPSHOT_LIBDIR")
47 ("RUSTC_REAL", "RUSTC_LIBDIR")
49 let stage = env::var("RUSTC_STAGE").expect("RUSTC_STAGE was not set");
50 let sysroot = env::var_os("RUSTC_SYSROOT").expect("RUSTC_SYSROOT was not set");
51 let on_fail = env::var_os("RUSTC_ON_FAIL").map(Command::new);
53 let rustc = env::var_os(rustc).unwrap_or_else(|| panic!("{:?} was not set", rustc));
54 let libdir = env::var_os(libdir).unwrap_or_else(|| panic!("{:?} was not set", libdir));
55 let mut dylib_path = dylib_path();
56 dylib_path.insert(0, PathBuf::from(&libdir));
58 let mut cmd = Command::new(rustc);
59 cmd.args(&args).env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
61 // Get the name of the crate we're compiling, if any.
63 args.windows(2).find(|args| args[0] == "--crate-name").and_then(|args| args[1].to_str());
65 if let Some(crate_name) = crate_name {
66 if let Some(target) = env::var_os("RUSTC_TIME") {
68 || target.into_string().unwrap().split(',').any(|c| c.trim() == crate_name)
75 // Print backtrace in case of ICE
76 if env::var("RUSTC_BACKTRACE_ON_ICE").is_ok() && env::var("RUST_BACKTRACE").is_err() {
77 cmd.env("RUST_BACKTRACE", "1");
80 if let Ok(lint_flags) = env::var("RUSTC_LINT_FLAGS") {
81 cmd.args(lint_flags.split_whitespace());
85 // The stage0 compiler has a special sysroot distinct from what we
86 // actually downloaded, so we just always pass the `--sysroot` option,
87 // unless one is already set.
88 if !args.iter().any(|arg| arg == "--sysroot") {
89 cmd.arg("--sysroot").arg(&sysroot);
92 // If we're compiling specifically the `panic_abort` crate then we pass
93 // the `-C panic=abort` option. Note that we do not do this for any
94 // other crate intentionally as this is the only crate for now that we
95 // ship with panic=abort.
97 // This... is a bit of a hack how we detect this. Ideally this
98 // information should be encoded in the crate I guess? Would likely
99 // require an RFC amendment to RFC 1513, however.
101 // `compiler_builtins` are unconditionally compiled with panic=abort to
102 // workaround undefined references to `rust_eh_unwind_resume` generated
103 // otherwise, see issue https://github.com/rust-lang/rust/issues/43095.
104 if crate_name == Some("panic_abort")
105 || crate_name == Some("compiler_builtins") && stage != "0"
107 cmd.arg("-C").arg("panic=abort");
110 // FIXME(rust-lang/cargo#5754) we shouldn't be using special env vars
111 // here, but rather Cargo should know what flags to pass rustc itself.
113 // Override linker if necessary.
114 if let Ok(host_linker) = env::var("RUSTC_HOST_LINKER") {
115 cmd.arg(format!("-Clinker={}", host_linker));
117 if env::var_os("RUSTC_HOST_FUSE_LD_LLD").is_some() {
118 cmd.arg("-Clink-args=-fuse-ld=lld");
121 if let Ok(s) = env::var("RUSTC_HOST_CRT_STATIC") {
123 cmd.arg("-C").arg("target-feature=+crt-static");
126 cmd.arg("-C").arg("target-feature=-crt-static");
131 // Cargo doesn't pass RUSTFLAGS to proc_macros:
132 // https://github.com/rust-lang/cargo/issues/4423
133 // Set `--cfg=bootstrap` explicitly instead.
134 cmd.arg("--cfg=bootstrap");
138 if let Ok(map) = env::var("RUSTC_DEBUGINFO_MAP") {
139 cmd.arg("--remap-path-prefix").arg(&map);
142 // Force all crates compiled by this compiler to (a) be unstable and (b)
143 // allow the `rustc_private` feature to link to other unstable crates
144 // also in the sysroot. We also do this for host crates, since those
145 // may be proc macros, in which case we might ship them.
146 if env::var_os("RUSTC_FORCE_UNSTABLE").is_some() && (stage != "0" || target.is_some()) {
147 cmd.arg("-Z").arg("force-unstable-if-unmarked");
150 let is_test = args.iter().any(|a| a == "--test");
153 env::vars().filter(|(k, _)| k.starts_with("RUST") || k.starts_with("CARGO"));
154 let prefix = if is_test { "[RUSTC-SHIM] rustc --test" } else { "[RUSTC-SHIM] rustc" };
155 let prefix = match crate_name {
156 Some(crate_name) => format!("{} {}", prefix, crate_name),
157 None => prefix.to_string(),
159 for (i, (k, v)) in rust_env_vars.enumerate() {
160 eprintln!("{} env[{}]: {:?}={:?}", prefix, i, k, v);
162 eprintln!("{} working directory: {}", prefix, env::current_dir().unwrap().display());
164 "{} command: {:?}={:?} {:?}",
167 env::join_paths(&dylib_path).unwrap(),
170 eprintln!("{} sysroot: {:?}", prefix, sysroot);
171 eprintln!("{} libdir: {:?}", prefix, libdir);
174 let start = Instant::now();
175 let (child, status) = {
176 let errmsg = format!("\nFailed to run:\n{:?}\n-------------", cmd);
177 let mut child = cmd.spawn().expect(&errmsg);
178 let status = child.wait().expect(&errmsg);
182 if env::var_os("RUSTC_PRINT_STEP_TIMINGS").is_some()
183 || env::var_os("RUSTC_PRINT_STEP_RUSAGE").is_some()
185 if let Some(crate_name) = crate_name {
186 let dur = start.elapsed();
187 // If the user requested resource usage data, then
188 // include that in addition to the timing output.
190 env::var_os("RUSTC_PRINT_STEP_RUSAGE").and_then(|_| format_rusage_data(child));
192 "[RUSTC-TIMING] {} test:{} {}.{:03}{}{}",
197 if rusage_data.is_some() { " " } else { "" },
198 rusage_data.unwrap_or(String::new()),
203 if status.success() {
204 std::process::exit(0);
205 // note: everything below here is unreachable. do not put code that
206 // should run on success, after this block.
209 println!("\nDid not run successfully: {}\n{:?}\n-------------", status, cmd);
212 if let Some(mut on_fail) = on_fail {
213 on_fail.status().expect("Could not run the on_fail command");
216 // Preserve the exit code. In case of signal, exit with 0xfe since it's
217 // awkward to preserve this status in a cross-platform way.
218 match status.code() {
219 Some(i) => std::process::exit(i),
221 eprintln!("rustc exited with {}", status);
222 std::process::exit(0xfe);
227 #[cfg(all(not(unix), not(windows)))]
228 // In the future we can add this for more platforms
229 fn format_rusage_data(_child: Child) -> Option<String> {
234 fn format_rusage_data(child: Child) -> Option<String> {
235 use std::os::windows::io::AsRawHandle;
236 use winapi::um::{processthreadsapi, psapi, timezoneapi};
237 let handle = child.as_raw_handle();
238 macro_rules! try_bool {
246 let mut user_filetime = Default::default();
247 let mut user_time = Default::default();
248 let mut kernel_filetime = Default::default();
249 let mut kernel_time = Default::default();
250 let mut memory_counters = psapi::PROCESS_MEMORY_COUNTERS::default();
253 try_bool!(processthreadsapi::GetProcessTimes(
255 &mut Default::default(),
256 &mut Default::default(),
257 &mut kernel_filetime,
260 try_bool!(timezoneapi::FileTimeToSystemTime(&user_filetime, &mut user_time));
261 try_bool!(timezoneapi::FileTimeToSystemTime(&kernel_filetime, &mut kernel_time));
263 // Unlike on Linux with RUSAGE_CHILDREN, this will only return memory information for the process
264 // with the given handle and none of that process's children.
265 try_bool!(psapi::GetProcessMemoryInfo(
267 &mut memory_counters as *mut _ as _,
268 std::mem::size_of::<psapi::PROCESS_MEMORY_COUNTERS_EX>() as u32,
272 // Guide on interpreting these numbers:
273 // https://docs.microsoft.com/en-us/windows/win32/psapi/process-memory-usage-information
274 let peak_working_set = memory_counters.PeakWorkingSetSize / 1024;
275 let peak_page_file = memory_counters.PeakPagefileUsage / 1024;
276 let peak_paged_pool = memory_counters.QuotaPeakPagedPoolUsage / 1024;
277 let peak_nonpaged_pool = memory_counters.QuotaPeakNonPagedPoolUsage / 1024;
279 "user: {USER_SEC}.{USER_USEC:03} \
280 sys: {SYS_SEC}.{SYS_USEC:03} \
281 peak working set (kb): {PEAK_WORKING_SET} \
282 peak page file usage (kb): {PEAK_PAGE_FILE} \
283 peak paged pool usage (kb): {PEAK_PAGED_POOL} \
284 peak non-paged pool usage (kb): {PEAK_NONPAGED_POOL} \
285 page faults: {PAGE_FAULTS}",
286 USER_SEC = user_time.wSecond + (user_time.wMinute * 60),
287 USER_USEC = user_time.wMilliseconds,
288 SYS_SEC = kernel_time.wSecond + (kernel_time.wMinute * 60),
289 SYS_USEC = kernel_time.wMilliseconds,
290 PEAK_WORKING_SET = peak_working_set,
291 PEAK_PAGE_FILE = peak_page_file,
292 PEAK_PAGED_POOL = peak_paged_pool,
293 PEAK_NONPAGED_POOL = peak_nonpaged_pool,
294 PAGE_FAULTS = memory_counters.PageFaultCount,
299 /// Tries to build a string with human readable data for several of the rusage
300 /// fields. Note that we are focusing mainly on data that we believe to be
301 /// supplied on Linux (the `rusage` struct has other fields in it but they are
302 /// currently unsupported by Linux).
303 fn format_rusage_data(_child: Child) -> Option<String> {
304 let rusage: libc::rusage = unsafe {
305 let mut recv = std::mem::zeroed();
306 // -1 is RUSAGE_CHILDREN, which means to get the rusage for all children
307 // (and grandchildren, etc) processes that have respectively terminated
308 // and been waited for.
309 let retval = libc::getrusage(-1, &mut recv);
315 // Mac OS X reports the maxrss in bytes, not kb.
316 let divisor = if env::consts::OS == "macos" { 1024 } else { 1 };
317 let maxrss = (rusage.ru_maxrss + (divisor - 1)) / divisor;
319 let mut init_str = format!(
320 "user: {USER_SEC}.{USER_USEC:03} \
321 sys: {SYS_SEC}.{SYS_USEC:03} \
322 max rss (kb): {MAXRSS}",
323 USER_SEC = rusage.ru_utime.tv_sec,
324 USER_USEC = rusage.ru_utime.tv_usec,
325 SYS_SEC = rusage.ru_stime.tv_sec,
326 SYS_USEC = rusage.ru_stime.tv_usec,
330 // The remaining rusage stats vary in platform support. So we treat
331 // uniformly zero values in each category as "not worth printing", since it
332 // either means no events of that type occurred, or that the platform
333 // does not support it.
335 let minflt = rusage.ru_minflt;
336 let majflt = rusage.ru_majflt;
337 if minflt != 0 || majflt != 0 {
338 init_str.push_str(&format!(" page reclaims: {} page faults: {}", minflt, majflt));
341 let inblock = rusage.ru_inblock;
342 let oublock = rusage.ru_oublock;
343 if inblock != 0 || oublock != 0 {
344 init_str.push_str(&format!(" fs block inputs: {} fs block outputs: {}", inblock, oublock));
347 let nvcsw = rusage.ru_nvcsw;
348 let nivcsw = rusage.ru_nivcsw;
349 if nvcsw != 0 || nivcsw != 0 {
350 init_str.push_str(&format!(
351 " voluntary ctxt switches: {} involuntary ctxt switches: {}",
356 return Some(init_str);