1 // Copyright 2014-2015 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.
11 //! The Rust compiler.
15 //! This API is completely unstable and subject to change.
17 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
18 html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
19 html_root_url = "https://doc.rust-lang.org/nightly/")]
21 #![feature(box_syntax)]
22 #![cfg_attr(unix, feature(libc))]
24 #![feature(rustc_diagnostic_macros)]
25 #![feature(slice_sort_by_cached_key)]
26 #![feature(set_stdio)]
27 #![feature(rustc_stack_internals)]
31 extern crate graphviz;
32 extern crate env_logger;
36 extern crate rustc_allocator;
37 extern crate rustc_back;
38 extern crate rustc_borrowck;
39 extern crate rustc_data_structures;
40 extern crate rustc_errors as errors;
41 extern crate rustc_passes;
42 extern crate rustc_lint;
43 extern crate rustc_plugin;
44 extern crate rustc_privacy;
45 extern crate rustc_incremental;
46 extern crate rustc_metadata;
47 extern crate rustc_mir;
48 extern crate rustc_resolve;
49 extern crate rustc_save_analysis;
50 extern crate rustc_traits;
51 extern crate rustc_trans_utils;
52 extern crate rustc_typeck;
53 extern crate serialize;
57 extern crate syntax_ext;
58 extern crate syntax_pos;
60 use driver::CompileController;
61 use pretty::{PpMode, UserIdentifiedItem};
63 use rustc_resolve as resolve;
64 use rustc_save_analysis as save;
65 use rustc_save_analysis::DumpHandler;
66 use rustc_data_structures::sync::Lrc;
67 use rustc_data_structures::OnDrop;
68 use rustc::session::{self, config, Session, build_session, CompileResult};
69 use rustc::session::CompileIncomplete;
70 use rustc::session::config::{Input, PrintRequest, ErrorOutputType};
71 use rustc::session::config::nightly_options;
72 use rustc::session::filesearch;
73 use rustc::session::{early_error, early_warn};
74 use rustc::lint::Lint;
76 use rustc::middle::cstore::CrateStore;
77 use rustc_metadata::locator;
78 use rustc_metadata::cstore::CStore;
79 use rustc_metadata::dynamic_lib::DynamicLibrary;
80 use rustc::util::common::{time, ErrorReported};
81 use rustc_trans_utils::trans_crate::TransCrate;
83 use serialize::json::ToJson;
87 use std::default::Default;
88 use std::env::consts::{DLL_PREFIX, DLL_SUFFIX};
90 use std::ffi::OsString;
91 use std::io::{self, Read, Write};
92 use std::iter::repeat;
95 use std::path::{PathBuf, Path};
96 use std::process::{self, Command, Stdio};
98 use std::sync::atomic::{AtomicBool, ATOMIC_BOOL_INIT, Ordering};
99 use std::sync::{Once, ONCE_INIT};
103 use syntax::codemap::{CodeMap, FileLoader, RealFileLoader};
104 use syntax::feature_gate::{GatedCfg, UnstableFeatures};
105 use syntax::parse::{self, PResult};
106 use syntax_pos::{DUMMY_SP, MultiSpan, FileName};
114 mod derive_registrar;
116 pub mod target_features {
118 use syntax::symbol::Symbol;
119 use rustc::session::Session;
120 use rustc_trans_utils::trans_crate::TransCrate;
122 /// Add `target_feature = "..."` cfgs for a variety of platform
123 /// specific features (SSE, NEON etc.).
125 /// This is performed by checking whether a whitelisted set of
126 /// features is available on the target machine, by querying LLVM.
127 pub fn add_configuration(cfg: &mut ast::CrateConfig, sess: &Session, trans: &TransCrate) {
128 let tf = Symbol::intern("target_feature");
130 for feat in trans.target_features(sess) {
131 cfg.insert((tf, Some(feat)));
134 if sess.crt_static_feature() {
135 cfg.insert((tf, Some(Symbol::intern("crt-static"))));
140 const BUG_REPORT_URL: &'static str = "https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.\
143 const ICE_REPORT_COMPILER_FLAGS: &'static [&'static str] = &[
148 const ICE_REPORT_COMPILER_FLAGS_EXCLUDE: &'static [&'static str] = &[
152 const ICE_REPORT_COMPILER_FLAGS_STRIP_VALUE: &'static [&'static str] = &[
156 pub fn abort_on_err<T>(result: Result<T, CompileIncomplete>, sess: &Session) -> T {
158 Err(CompileIncomplete::Errored(ErrorReported)) => {
159 sess.abort_if_errors();
160 panic!("error reported but abort_if_errors didn't abort???");
162 Err(CompileIncomplete::Stopped) => {
163 sess.fatal("compilation terminated");
169 pub fn run<F>(run_compiler: F) -> isize
170 where F: FnOnce() -> (CompileResult, Option<Session>) + Send + 'static
173 let (result, session) = run_compiler();
174 if let Err(CompileIncomplete::Errored(_)) = result {
177 sess.abort_if_errors();
178 panic!("error reported but abort_if_errors didn't abort???");
182 errors::emitter::EmitterWriter::stderr(errors::ColorConfig::Auto,
186 let handler = errors::Handler::with_emitter(true, false, Box::new(emitter));
187 handler.emit(&MultiSpan::new(),
188 "aborting due to previous error(s)",
189 errors::Level::Fatal);
190 panic::resume_unwind(Box::new(errors::FatalErrorMarker));
198 fn load_backend_from_dylib(path: &Path) -> fn() -> Box<TransCrate> {
199 // Note that we're specifically using `open_global_now` here rather than
200 // `open`, namely we want the behavior on Unix of RTLD_GLOBAL and RTLD_NOW,
201 // where NOW means "bind everything right now" because we don't want
202 // surprises later on and RTLD_GLOBAL allows the symbols to be made
203 // available for future dynamic libraries opened. This is currently used by
204 // loading LLVM and then making its symbols available for other dynamic
206 let lib = match DynamicLibrary::open_global_now(path) {
209 let err = format!("couldn't load codegen backend {:?}: {:?}",
212 early_error(ErrorOutputType::default(), &err);
216 match lib.symbol("__rustc_codegen_backend") {
219 mem::transmute::<*mut u8, _>(f)
222 let err = format!("couldn't load codegen backend as it \
223 doesn't export the `__rustc_codegen_backend` \
225 early_error(ErrorOutputType::default(), &err);
231 pub fn get_trans(sess: &Session) -> Box<TransCrate> {
232 static INIT: Once = ONCE_INIT;
233 static mut LOAD: fn() -> Box<TransCrate> = || unreachable!();
236 let trans_name = sess.opts.debugging_opts.codegen_backend.as_ref()
237 .unwrap_or(&sess.target.target.options.codegen_backend);
238 let backend = match &trans_name[..] {
240 rustc_trans_utils::trans_crate::MetadataOnlyTransCrate::new
242 filename if filename.contains(".") => {
243 load_backend_from_dylib(filename.as_ref())
245 trans_name => get_trans_sysroot(trans_name),
252 let backend = unsafe { LOAD() };
257 fn get_trans_sysroot(backend_name: &str) -> fn() -> Box<TransCrate> {
258 // For now we only allow this function to be called once as it'll dlopen a
259 // few things, which seems to work best if we only do that once. In
260 // general this assertion never trips due to the once guard in `get_trans`,
261 // but there's a few manual calls to this function in this file we protect
263 static LOADED: AtomicBool = ATOMIC_BOOL_INIT;
264 assert!(!LOADED.fetch_or(true, Ordering::SeqCst),
265 "cannot load the default trans backend twice");
267 // When we're compiling this library with `--test` it'll run as a binary but
268 // not actually exercise much functionality. As a result most of the logic
269 // here is defunkt (it assumes we're a dynamic library in a sysroot) so
270 // let's just return a dummy creation function which won't be used in
273 return rustc_trans_utils::trans_crate::MetadataOnlyTransCrate::new
276 let target = session::config::host_triple();
277 let mut sysroot_candidates = vec![filesearch::get_or_default_sysroot()];
278 let path = current_dll_path()
279 .and_then(|s| s.canonicalize().ok());
280 if let Some(dll) = path {
281 // use `parent` twice to chop off the file name and then also the
282 // directory containing the dll which should be either `lib` or `bin`.
283 if let Some(path) = dll.parent().and_then(|p| p.parent()) {
284 // The original `path` pointed at the `rustc_driver` crate's dll.
285 // Now that dll should only be in one of two locations. The first is
286 // in the compiler's libdir, for example `$sysroot/lib/*.dll`. The
287 // other is the target's libdir, for example
288 // `$sysroot/lib/rustlib/$target/lib/*.dll`.
290 // We don't know which, so let's assume that if our `path` above
291 // ends in `$target` we *could* be in the target libdir, and always
292 // assume that we may be in the main libdir.
293 sysroot_candidates.push(path.to_owned());
295 if path.ends_with(target) {
296 sysroot_candidates.extend(path.parent() // chop off `$target`
297 .and_then(|p| p.parent()) // chop off `rustlib`
298 .and_then(|p| p.parent()) // chop off `lib`
299 .map(|s| s.to_owned()));
304 let sysroot = sysroot_candidates.iter()
306 let libdir = filesearch::relative_target_lib_path(&sysroot, &target);
308 .with_file_name(option_env!("CFG_CODEGEN_BACKENDS_DIR")
309 .unwrap_or("codegen-backends"))
312 info!("codegen backend candidate: {}", f.display());
316 let sysroot = match sysroot {
319 let candidates = sysroot_candidates.iter()
320 .map(|p| p.display().to_string())
323 let err = format!("failed to find a `codegen-backends` folder \
324 in the sysroot candidates:\n* {}", candidates);
325 early_error(ErrorOutputType::default(), &err);
328 info!("probing {} for a codegen backend", sysroot.display());
330 let d = match sysroot.read_dir() {
333 let err = format!("failed to load default codegen backend, couldn't \
334 read `{}`: {}", sysroot.display(), e);
335 early_error(ErrorOutputType::default(), &err);
339 let mut file: Option<PathBuf> = None;
341 let expected_name = format!("rustc_trans-{}", backend_name);
342 for entry in d.filter_map(|e| e.ok()) {
343 let path = entry.path();
344 let filename = match path.file_name().and_then(|s| s.to_str()) {
348 if !(filename.starts_with(DLL_PREFIX) && filename.ends_with(DLL_SUFFIX)) {
351 let name = &filename[DLL_PREFIX.len() .. filename.len() - DLL_SUFFIX.len()];
352 if name != expected_name {
355 if let Some(ref prev) = file {
356 let err = format!("duplicate codegen backends found\n\
359 ", prev.display(), path.display());
360 early_error(ErrorOutputType::default(), &err);
362 file = Some(path.clone());
366 Some(ref s) => return load_backend_from_dylib(s),
368 let err = format!("failed to load default codegen backend for `{}`, \
369 no appropriate codegen dylib found in `{}`",
370 backend_name, sysroot.display());
371 early_error(ErrorOutputType::default(), &err);
376 fn current_dll_path() -> Option<PathBuf> {
377 use std::ffi::{OsStr, CStr};
378 use std::os::unix::prelude::*;
381 let addr = current_dll_path as usize as *mut _;
382 let mut info = mem::zeroed();
383 if libc::dladdr(addr, &mut info) == 0 {
384 info!("dladdr failed");
387 if info.dli_fname.is_null() {
388 info!("dladdr returned null pointer");
391 let bytes = CStr::from_ptr(info.dli_fname).to_bytes();
392 let os = OsStr::from_bytes(bytes);
393 Some(PathBuf::from(os))
398 fn current_dll_path() -> Option<PathBuf> {
399 use std::ffi::OsString;
400 use std::os::windows::prelude::*;
403 fn GetModuleHandleExW(dwFlags: u32,
405 phModule: *mut usize) -> i32;
406 fn GetModuleFileNameW(hModule: usize,
407 lpFilename: *mut u16,
411 const GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS: u32 = 0x00000004;
415 let r = GetModuleHandleExW(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
416 current_dll_path as usize,
419 info!("GetModuleHandleExW failed: {}", io::Error::last_os_error());
422 let mut space = Vec::with_capacity(1024);
423 let r = GetModuleFileNameW(module,
425 space.capacity() as u32);
427 info!("GetModuleFileNameW failed: {}", io::Error::last_os_error());
431 if r >= space.capacity() {
432 info!("our buffer was too small? {}",
433 io::Error::last_os_error());
437 let os = OsString::from_wide(&space);
438 Some(PathBuf::from(os))
443 // Parse args and run the compiler. This is the primary entry point for rustc.
444 // See comments on CompilerCalls below for details about the callbacks argument.
445 // The FileLoader provides a way to load files from sources other than the file system.
446 pub fn run_compiler<'a>(args: &[String],
447 callbacks: &mut CompilerCalls<'a>,
448 file_loader: Option<Box<FileLoader + Send + Sync + 'static>>,
449 emitter_dest: Option<Box<Write + Send>>)
450 -> (CompileResult, Option<Session>)
452 syntax::with_globals(|| {
453 run_compiler_impl(args, callbacks, file_loader, emitter_dest)
457 fn run_compiler_impl<'a>(args: &[String],
458 callbacks: &mut CompilerCalls<'a>,
459 file_loader: Option<Box<FileLoader + Send + Sync + 'static>>,
460 emitter_dest: Option<Box<Write + Send>>)
461 -> (CompileResult, Option<Session>)
463 macro_rules! do_or_return {($expr: expr, $sess: expr) => {
465 Compilation::Stop => return (Ok(()), $sess),
466 Compilation::Continue => {}
470 let matches = match handle_options(args) {
471 Some(matches) => matches,
472 None => return (Ok(()), None),
475 let (sopts, cfg) = config::build_session_options_and_crate_config(&matches);
477 let descriptions = diagnostics_registry();
479 do_or_return!(callbacks.early_callback(&matches,
486 let (odir, ofile) = make_output(&matches);
487 let (input, input_file_path, input_err) = match make_input(&matches.free) {
488 Some((input, input_file_path, input_err)) => {
489 let (input, input_file_path) = callbacks.some_input(input, input_file_path);
490 (input, input_file_path, input_err)
492 None => match callbacks.no_input(&matches, &sopts, &cfg, &odir, &ofile, &descriptions) {
493 Some((input, input_file_path)) => (input, input_file_path, None),
494 None => return (Ok(()), None),
498 let loader = file_loader.unwrap_or(box RealFileLoader);
499 let codemap = Lrc::new(CodeMap::with_file_loader(loader, sopts.file_path_mapping()));
500 let mut sess = session::build_session_with_codemap(
501 sopts, input_file_path.clone(), descriptions, codemap, emitter_dest,
504 if let Some(err) = input_err {
505 // Immediately stop compilation if there was an issue reading
506 // the input (for example if the input stream is not UTF-8).
507 sess.err(&format!("{}", err));
508 return (Err(CompileIncomplete::Stopped), Some(sess));
511 let trans = get_trans(&sess);
513 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
515 let mut cfg = config::build_configuration(&sess, cfg);
516 target_features::add_configuration(&mut cfg, &sess, &*trans);
517 sess.parse_sess.config = cfg;
520 let plugins = sess.opts.debugging_opts.extra_plugins.clone();
522 let cstore = CStore::new(trans.metadata_loader());
524 do_or_return!(callbacks.late_callback(&*trans,
530 &ofile), Some(sess));
532 let _sess_abort_error = OnDrop(|| sess.diagnostic().print_error_count());
534 let control = callbacks.build_controller(&sess, &matches);
536 driver::compile_input(trans,
550 // Extract output directory and file from matches.
551 fn make_output(matches: &getopts::Matches) -> (Option<PathBuf>, Option<PathBuf>) {
552 let odir = matches.opt_str("out-dir").map(|o| PathBuf::from(&o));
553 let ofile = matches.opt_str("o").map(|o| PathBuf::from(&o));
557 // Extract input (string or file and optional path) from matches.
558 fn make_input(free_matches: &[String]) -> Option<(Input, Option<PathBuf>, Option<io::Error>)> {
559 if free_matches.len() == 1 {
560 let ifile = &free_matches[0];
562 let mut src = String::new();
563 let err = if io::stdin().read_to_string(&mut src).is_err() {
564 Some(io::Error::new(io::ErrorKind::InvalidData,
565 "couldn't read from stdin, as it did not contain valid UTF-8"))
569 Some((Input::Str { name: FileName::Anon, input: src },
572 Some((Input::File(PathBuf::from(ifile)),
573 Some(PathBuf::from(ifile)), None))
580 fn parse_pretty(sess: &Session,
581 matches: &getopts::Matches)
582 -> Option<(PpMode, Option<UserIdentifiedItem>)> {
583 let pretty = if sess.opts.debugging_opts.unstable_options {
584 matches.opt_default("pretty", "normal").map(|a| {
585 // stable pretty-print variants only
586 pretty::parse_pretty(sess, &a, false)
592 if pretty.is_none() {
593 sess.opts.debugging_opts.unpretty.as_ref().map(|a| {
594 // extended with unstable pretty-print variants
595 pretty::parse_pretty(sess, &a, true)
602 // Whether to stop or continue compilation.
603 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
604 pub enum Compilation {
610 pub fn and_then<F: FnOnce() -> Compilation>(self, next: F) -> Compilation {
612 Compilation::Stop => Compilation::Stop,
613 Compilation::Continue => next(),
618 // A trait for customising the compilation process. Offers a number of hooks for
619 // executing custom code or customising input.
620 pub trait CompilerCalls<'a> {
621 // Hook for a callback early in the process of handling arguments. This will
622 // be called straight after options have been parsed but before anything
623 // else (e.g., selecting input and output).
624 fn early_callback(&mut self,
625 _: &getopts::Matches,
627 _: &ast::CrateConfig,
628 _: &errors::registry::Registry,
631 Compilation::Continue
634 // Hook for a callback late in the process of handling arguments. This will
635 // be called just before actual compilation starts (and before build_controller
636 // is called), after all arguments etc. have been completely handled.
637 fn late_callback(&mut self,
639 _: &getopts::Matches,
646 Compilation::Continue
649 // Called after we extract the input from the arguments. Gives the implementer
650 // an opportunity to change the inputs or to add some custom input handling.
651 // The default behaviour is to simply pass through the inputs.
652 fn some_input(&mut self,
654 input_path: Option<PathBuf>)
655 -> (Input, Option<PathBuf>) {
659 // Called after we extract the input from the arguments if there is no valid
660 // input. Gives the implementer an opportunity to supply alternate input (by
661 // returning a Some value) or to add custom behaviour for this error such as
662 // emitting error messages. Returning None will cause compilation to stop
664 fn no_input(&mut self,
665 _: &getopts::Matches,
667 _: &ast::CrateConfig,
670 _: &errors::registry::Registry)
671 -> Option<(Input, Option<PathBuf>)> {
675 // Create a CompilController struct for controlling the behaviour of
677 fn build_controller(&mut self, _: &Session, _: &getopts::Matches) -> CompileController<'a>;
680 // CompilerCalls instance for a regular rustc build.
681 #[derive(Copy, Clone)]
682 pub struct RustcDefaultCalls;
684 // FIXME remove these and use winapi 0.3 instead
685 // Duplicates: bootstrap/compile.rs, librustc_errors/emitter.rs
687 fn stdout_isatty() -> bool {
688 unsafe { libc::isatty(libc::STDOUT_FILENO) != 0 }
692 fn stdout_isatty() -> bool {
695 type HANDLE = *mut u8;
696 type LPDWORD = *mut u32;
697 const STD_OUTPUT_HANDLE: DWORD = -11i32 as DWORD;
699 fn GetStdHandle(which: DWORD) -> HANDLE;
700 fn GetConsoleMode(hConsoleHandle: HANDLE, lpMode: LPDWORD) -> BOOL;
703 let handle = GetStdHandle(STD_OUTPUT_HANDLE);
705 GetConsoleMode(handle, &mut out) != 0
709 fn handle_explain(code: &str,
710 descriptions: &errors::registry::Registry,
711 output: ErrorOutputType) {
712 let normalised = if code.starts_with("E") {
715 format!("E{0:0>4}", code)
717 match descriptions.find_description(&normalised) {
718 Some(ref description) => {
719 let mut is_in_code_block = false;
720 let mut text = String::new();
722 // Slice off the leading newline and print.
723 for line in description[1..].lines() {
724 let indent_level = line.find(|c: char| !c.is_whitespace())
725 .unwrap_or_else(|| line.len());
726 let dedented_line = &line[indent_level..];
727 if dedented_line.starts_with("```") {
728 is_in_code_block = !is_in_code_block;
729 text.push_str(&line[..(indent_level+3)]);
730 } else if is_in_code_block && dedented_line.starts_with("# ") {
739 show_content_with_pager(&text);
745 early_error(output, &format!("no extended information for {}", code));
750 fn show_content_with_pager(content: &String) {
751 let pager_name = env::var_os("PAGER").unwrap_or_else(|| if cfg!(windows) {
752 OsString::from("more.com")
754 OsString::from("less")
757 let mut fallback_to_println = false;
759 match Command::new(pager_name).stdin(Stdio::piped()).spawn() {
761 if let Some(pipe) = pager.stdin.as_mut() {
762 if pipe.write_all(content.as_bytes()).is_err() {
763 fallback_to_println = true;
767 if pager.wait().is_err() {
768 fallback_to_println = true;
772 fallback_to_println = true;
776 // If pager fails for whatever reason, we should still print the content
777 // to standard output
778 if fallback_to_println {
779 print!("{}", content);
783 impl<'a> CompilerCalls<'a> for RustcDefaultCalls {
784 fn early_callback(&mut self,
785 matches: &getopts::Matches,
787 _: &ast::CrateConfig,
788 descriptions: &errors::registry::Registry,
789 output: ErrorOutputType)
791 if let Some(ref code) = matches.opt_str("explain") {
792 handle_explain(code, descriptions, output);
793 return Compilation::Stop;
796 Compilation::Continue
799 fn no_input(&mut self,
800 matches: &getopts::Matches,
801 sopts: &config::Options,
802 cfg: &ast::CrateConfig,
803 odir: &Option<PathBuf>,
804 ofile: &Option<PathBuf>,
805 descriptions: &errors::registry::Registry)
806 -> Option<(Input, Option<PathBuf>)> {
807 match matches.free.len() {
809 let mut sess = build_session(sopts.clone(),
811 descriptions.clone());
812 if sopts.describe_lints {
813 let mut ls = lint::LintStore::new();
814 rustc_lint::register_builtins(&mut ls, Some(&sess));
815 describe_lints(&sess, &ls, false);
818 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
819 let mut cfg = config::build_configuration(&sess, cfg.clone());
820 let trans = get_trans(&sess);
821 target_features::add_configuration(&mut cfg, &sess, &*trans);
822 sess.parse_sess.config = cfg;
823 let should_stop = RustcDefaultCalls::print_crate_info(
831 if should_stop == Compilation::Stop {
834 early_error(sopts.error_format, "no input filename given");
836 1 => panic!("make_input should have provided valid inputs"),
837 _ => early_error(sopts.error_format, "multiple input filenames provided"),
841 fn late_callback(&mut self,
843 matches: &getopts::Matches,
847 odir: &Option<PathBuf>,
848 ofile: &Option<PathBuf>)
850 RustcDefaultCalls::print_crate_info(trans, sess, Some(input), odir, ofile)
851 .and_then(|| RustcDefaultCalls::list_metadata(sess, cstore, matches, input))
854 fn build_controller(&mut self,
856 matches: &getopts::Matches)
857 -> CompileController<'a> {
858 let mut control = CompileController::basic();
860 control.keep_ast = sess.opts.debugging_opts.keep_ast;
861 control.continue_parse_after_error = sess.opts.debugging_opts.continue_parse_after_error;
863 if let Some((ppm, opt_uii)) = parse_pretty(sess, matches) {
864 if ppm.needs_ast_map(&opt_uii) {
865 control.after_hir_lowering.stop = Compilation::Stop;
867 control.after_parse.callback = box move |state| {
868 state.krate = Some(pretty::fold_crate(state.session,
869 state.krate.take().unwrap(),
872 control.after_hir_lowering.callback = box move |state| {
873 pretty::print_after_hir_lowering(state.session,
874 state.cstore.unwrap(),
875 state.hir_map.unwrap(),
876 state.analysis.unwrap(),
877 state.resolutions.unwrap(),
879 &state.expanded_crate.take().unwrap(),
880 state.crate_name.unwrap(),
882 state.arenas.unwrap(),
883 state.output_filenames.unwrap(),
888 control.after_parse.stop = Compilation::Stop;
890 control.after_parse.callback = box move |state| {
891 let krate = pretty::fold_crate(state.session, state.krate.take().unwrap(), ppm);
892 pretty::print_after_parsing(state.session,
903 if sess.opts.debugging_opts.parse_only ||
904 sess.opts.debugging_opts.show_span.is_some() ||
905 sess.opts.debugging_opts.ast_json_noexpand {
906 control.after_parse.stop = Compilation::Stop;
909 if sess.opts.debugging_opts.no_analysis ||
910 sess.opts.debugging_opts.ast_json {
911 control.after_hir_lowering.stop = Compilation::Stop;
914 if sess.opts.debugging_opts.save_analysis {
915 enable_save_analysis(&mut control);
918 if sess.print_fuel_crate.is_some() {
919 let old_callback = control.compilation_done.callback;
920 control.compilation_done.callback = box move |state| {
922 let sess = state.session;
923 println!("Fuel used by {}: {}",
924 sess.print_fuel_crate.as_ref().unwrap(),
925 sess.print_fuel.get());
932 pub fn enable_save_analysis(control: &mut CompileController) {
933 control.keep_ast = true;
934 control.after_analysis.callback = box |state| {
935 time(state.session, "save analysis", || {
936 save::process_crate(state.tcx.unwrap(),
937 state.expanded_crate.unwrap(),
938 state.analysis.unwrap(),
939 state.crate_name.unwrap(),
941 DumpHandler::new(state.out_dir,
942 state.crate_name.unwrap()))
945 control.after_analysis.run_callback_on_error = true;
946 control.make_glob_map = resolve::MakeGlobMap::Yes;
949 impl RustcDefaultCalls {
950 pub fn list_metadata(sess: &Session,
952 matches: &getopts::Matches,
955 let r = matches.opt_strs("Z");
956 if r.contains(&("ls".to_string())) {
958 &Input::File(ref ifile) => {
959 let path = &(*ifile);
960 let mut v = Vec::new();
961 locator::list_file_metadata(&sess.target.target,
963 cstore.metadata_loader(),
966 println!("{}", String::from_utf8(v).unwrap());
968 &Input::Str { .. } => {
969 early_error(ErrorOutputType::default(), "cannot list metadata for stdin");
972 return Compilation::Stop;
975 return Compilation::Continue;
979 fn print_crate_info(trans: &TransCrate,
981 input: Option<&Input>,
982 odir: &Option<PathBuf>,
983 ofile: &Option<PathBuf>)
985 use rustc::session::config::PrintRequest::*;
986 // PrintRequest::NativeStaticLibs is special - printed during linking
987 // (empty iterator returns true)
988 if sess.opts.prints.iter().all(|&p| p==PrintRequest::NativeStaticLibs) {
989 return Compilation::Continue;
992 let attrs = match input {
995 let result = parse_crate_attrs(sess, input);
997 Ok(attrs) => Some(attrs),
998 Err(mut parse_error) => {
1000 return Compilation::Stop;
1005 for req in &sess.opts.prints {
1008 let mut targets = rustc_back::target::get_targets().collect::<Vec<String>>();
1010 println!("{}", targets.join("\n"));
1012 Sysroot => println!("{}", sess.sysroot().display()),
1013 TargetSpec => println!("{}", sess.target.target.to_json().pretty()),
1014 FileNames | CrateName => {
1015 let input = match input {
1016 Some(input) => input,
1017 None => early_error(ErrorOutputType::default(), "no input file provided"),
1019 let attrs = attrs.as_ref().unwrap();
1020 let t_outputs = driver::build_output_filenames(input, odir, ofile, attrs, sess);
1021 let id = rustc_trans_utils::link::find_crate_name(Some(sess), attrs, input);
1022 if *req == PrintRequest::CrateName {
1026 let crate_types = driver::collect_crate_types(sess, attrs);
1027 for &style in &crate_types {
1028 let fname = rustc_trans_utils::link::filename_for_input(
1037 .to_string_lossy());
1041 let allow_unstable_cfg = UnstableFeatures::from_environment()
1042 .is_nightly_build();
1044 let mut cfgs = Vec::new();
1045 for &(name, ref value) in sess.parse_sess.config.iter() {
1046 let gated_cfg = GatedCfg::gate(&ast::MetaItem {
1047 ident: ast::Ident::with_empty_ctxt(name),
1048 node: ast::MetaItemKind::Word,
1052 // Note that crt-static is a specially recognized cfg
1053 // directive that's printed out here as part of
1054 // rust-lang/rust#37406, but in general the
1055 // `target_feature` cfg is gated under
1056 // rust-lang/rust#29717. For now this is just
1057 // specifically allowing the crt-static cfg and that's
1058 // it, this is intended to get into Cargo and then go
1059 // through to build scripts.
1060 let value = value.as_ref().map(|s| s.as_str());
1061 let value = value.as_ref().map(|s| s.as_ref());
1062 if name != "target_feature" || value != Some("crt-static") {
1063 if !allow_unstable_cfg && gated_cfg.is_some() {
1068 cfgs.push(if let Some(value) = value {
1069 format!("{}=\"{}\"", name, value)
1077 println!("{}", cfg);
1080 RelocationModels | CodeModels | TlsModels | TargetCPUs | TargetFeatures => {
1081 trans.print(*req, sess);
1083 // Any output here interferes with Cargo's parsing of other printed output
1084 PrintRequest::NativeStaticLibs => {}
1087 return Compilation::Stop;
1091 /// Returns a version string such as "0.12.0-dev".
1092 fn release_str() -> Option<&'static str> {
1093 option_env!("CFG_RELEASE")
1096 /// Returns the full SHA1 hash of HEAD of the Git repo from which rustc was built.
1097 fn commit_hash_str() -> Option<&'static str> {
1098 option_env!("CFG_VER_HASH")
1101 /// Returns the "commit date" of HEAD of the Git repo from which rustc was built as a static string.
1102 fn commit_date_str() -> Option<&'static str> {
1103 option_env!("CFG_VER_DATE")
1106 /// Prints version information
1107 pub fn version(binary: &str, matches: &getopts::Matches) {
1108 let verbose = matches.opt_present("verbose");
1112 option_env!("CFG_VERSION").unwrap_or("unknown version"));
1114 fn unw(x: Option<&str>) -> &str {
1115 x.unwrap_or("unknown")
1117 println!("binary: {}", binary);
1118 println!("commit-hash: {}", unw(commit_hash_str()));
1119 println!("commit-date: {}", unw(commit_date_str()));
1120 println!("host: {}", config::host_triple());
1121 println!("release: {}", unw(release_str()));
1122 get_trans_sysroot("llvm")().print_version();
1126 fn usage(verbose: bool, include_unstable_options: bool) {
1127 let groups = if verbose {
1128 config::rustc_optgroups()
1130 config::rustc_short_optgroups()
1132 let mut options = getopts::Options::new();
1133 for option in groups.iter().filter(|x| include_unstable_options || x.is_stable()) {
1134 (option.apply)(&mut options);
1136 let message = format!("Usage: rustc [OPTIONS] INPUT");
1137 let nightly_help = if nightly_options::is_nightly_build() {
1138 "\n -Z help Print internal options for debugging rustc"
1142 let verbose_help = if verbose {
1145 "\n --help -v Print the full set of options rustc accepts"
1147 println!("{}\nAdditional help:
1148 -C help Print codegen options
1150 Print 'lint' options and default settings{}{}\n",
1151 options.usage(&message),
1156 fn print_wall_help() {
1158 The flag `-Wall` does not exist in `rustc`. Most useful lints are enabled by
1159 default. Use `rustc -W help` to see all available lints. It's more common to put
1160 warning settings in the crate root using `#![warn(LINT_NAME)]` instead of using
1161 the command line flag directly.
1165 fn describe_lints(sess: &Session, lint_store: &lint::LintStore, loaded_plugins: bool) {
1167 Available lint options:
1168 -W <foo> Warn about <foo>
1172 -F <foo> Forbid <foo> \
1173 (deny <foo> and all attempts to override)
1177 fn sort_lints(sess: &Session, lints: Vec<(&'static Lint, bool)>) -> Vec<&'static Lint> {
1178 let mut lints: Vec<_> = lints.into_iter().map(|(x, _)| x).collect();
1179 // The sort doesn't case-fold but it's doubtful we care.
1180 lints.sort_by_cached_key(|x: &&Lint| (x.default_level(sess), x.name));
1184 fn sort_lint_groups(lints: Vec<(&'static str, Vec<lint::LintId>, bool)>)
1185 -> Vec<(&'static str, Vec<lint::LintId>)> {
1186 let mut lints: Vec<_> = lints.into_iter().map(|(x, y, _)| (x, y)).collect();
1187 lints.sort_by(|&(x, _): &(&'static str, Vec<lint::LintId>),
1188 &(y, _): &(&'static str, Vec<lint::LintId>)| {
1194 let (plugin, builtin): (Vec<_>, _) = lint_store.get_lints()
1197 .partition(|&(_, p)| p);
1198 let plugin = sort_lints(sess, plugin);
1199 let builtin = sort_lints(sess, builtin);
1201 let (plugin_groups, builtin_groups): (Vec<_>, _) = lint_store.get_lint_groups()
1204 .partition(|&(.., p)| p);
1205 let plugin_groups = sort_lint_groups(plugin_groups);
1206 let builtin_groups = sort_lint_groups(builtin_groups);
1208 let max_name_len = plugin.iter()
1210 .map(|&s| s.name.chars().count())
1213 let padded = |x: &str| {
1214 let mut s = repeat(" ")
1215 .take(max_name_len - x.chars().count())
1216 .collect::<String>();
1221 println!("Lint checks provided by rustc:\n");
1222 println!(" {} {:7.7} {}", padded("name"), "default", "meaning");
1223 println!(" {} {:7.7} {}", padded("----"), "-------", "-------");
1225 let print_lints = |lints: Vec<&Lint>| {
1227 let name = lint.name_lower().replace("_", "-");
1228 println!(" {} {:7.7} {}",
1230 lint.default_level.as_str(),
1236 print_lints(builtin);
1240 let max_name_len = max("warnings".len(),
1241 plugin_groups.iter()
1242 .chain(&builtin_groups)
1243 .map(|&(s, _)| s.chars().count())
1247 let padded = |x: &str| {
1248 let mut s = repeat(" ")
1249 .take(max_name_len - x.chars().count())
1250 .collect::<String>();
1255 println!("Lint groups provided by rustc:\n");
1256 println!(" {} {}", padded("name"), "sub-lints");
1257 println!(" {} {}", padded("----"), "---------");
1258 println!(" {} {}", padded("warnings"), "all lints that are set to issue warnings");
1260 let print_lint_groups = |lints: Vec<(&'static str, Vec<lint::LintId>)>| {
1261 for (name, to) in lints {
1262 let name = name.to_lowercase().replace("_", "-");
1263 let desc = to.into_iter()
1264 .map(|x| x.to_string().replace("_", "-"))
1265 .collect::<Vec<String>>()
1267 println!(" {} {}", padded(&name), desc);
1272 print_lint_groups(builtin_groups);
1274 match (loaded_plugins, plugin.len(), plugin_groups.len()) {
1275 (false, 0, _) | (false, _, 0) => {
1276 println!("Compiler plugins can provide additional lints and lint groups. To see a \
1277 listing of these, re-run `rustc -W help` with a crate filename.");
1279 (false, ..) => panic!("didn't load lint plugins but got them anyway!"),
1280 (true, 0, 0) => println!("This crate does not load any lint plugins or lint groups."),
1283 println!("Lint checks provided by plugins loaded by this crate:\n");
1284 print_lints(plugin);
1287 println!("Lint groups provided by plugins loaded by this crate:\n");
1288 print_lint_groups(plugin_groups);
1294 fn describe_debug_flags() {
1295 println!("\nAvailable debug options:\n");
1296 print_flag_list("-Z", config::DB_OPTIONS);
1299 fn describe_codegen_flags() {
1300 println!("\nAvailable codegen options:\n");
1301 print_flag_list("-C", config::CG_OPTIONS);
1304 fn print_flag_list<T>(cmdline_opt: &str,
1305 flag_list: &[(&'static str, T, Option<&'static str>, &'static str)]) {
1306 let max_len = flag_list.iter()
1307 .map(|&(name, _, opt_type_desc, _)| {
1308 let extra_len = match opt_type_desc {
1312 name.chars().count() + extra_len
1317 for &(name, _, opt_type_desc, desc) in flag_list {
1318 let (width, extra) = match opt_type_desc {
1319 Some(..) => (max_len - 4, "=val"),
1320 None => (max_len, ""),
1322 println!(" {} {:>width$}{} -- {}",
1324 name.replace("_", "-"),
1331 /// Process command line options. Emits messages as appropriate. If compilation
1332 /// should continue, returns a getopts::Matches object parsed from args,
1333 /// otherwise returns None.
1335 /// The compiler's handling of options is a little complicated as it ties into
1336 /// our stability story, and it's even *more* complicated by historical
1337 /// accidents. The current intention of each compiler option is to have one of
1340 /// 1. An option is stable and can be used everywhere.
1341 /// 2. An option is unstable, but was historically allowed on the stable
1343 /// 3. An option is unstable, and can only be used on nightly.
1345 /// Like unstable library and language features, however, unstable options have
1346 /// always required a form of "opt in" to indicate that you're using them. This
1347 /// provides the easy ability to scan a code base to check to see if anything
1348 /// unstable is being used. Currently, this "opt in" is the `-Z` "zed" flag.
1350 /// All options behind `-Z` are considered unstable by default. Other top-level
1351 /// options can also be considered unstable, and they were unlocked through the
1352 /// `-Z unstable-options` flag. Note that `-Z` remains to be the root of
1353 /// instability in both cases, though.
1355 /// So with all that in mind, the comments below have some more detail about the
1356 /// contortions done here to get things to work out correctly.
1357 pub fn handle_options(args: &[String]) -> Option<getopts::Matches> {
1358 // Throw away the first argument, the name of the binary
1359 let args = &args[1..];
1361 if args.is_empty() {
1362 // user did not write `-v` nor `-Z unstable-options`, so do not
1363 // include that extra information.
1364 usage(false, false);
1368 // Parse with *all* options defined in the compiler, we don't worry about
1369 // option stability here we just want to parse as much as possible.
1370 let mut options = getopts::Options::new();
1371 for option in config::rustc_optgroups() {
1372 (option.apply)(&mut options);
1374 let matches = match options.parse(args) {
1376 Err(f) => early_error(ErrorOutputType::default(), &f.to_string()),
1379 // For all options we just parsed, we check a few aspects:
1381 // * If the option is stable, we're all good
1382 // * If the option wasn't passed, we're all good
1383 // * If `-Z unstable-options` wasn't passed (and we're not a -Z option
1384 // ourselves), then we require the `-Z unstable-options` flag to unlock
1385 // this option that was passed.
1386 // * If we're a nightly compiler, then unstable options are now unlocked, so
1387 // we're good to go.
1388 // * Otherwise, if we're a truly unstable option then we generate an error
1389 // (unstable option being used on stable)
1390 // * If we're a historically stable-but-should-be-unstable option then we
1391 // emit a warning that we're going to turn this into an error soon.
1392 nightly_options::check_nightly_options(&matches, &config::rustc_optgroups());
1394 if matches.opt_present("h") || matches.opt_present("help") {
1395 // Only show unstable options in --help if we *really* accept unstable
1396 // options, which catches the case where we got `-Z unstable-options` on
1397 // the stable channel of Rust which was accidentally allowed
1399 usage(matches.opt_present("verbose"),
1400 nightly_options::is_unstable_enabled(&matches));
1404 // Handle the special case of -Wall.
1405 let wall = matches.opt_strs("W");
1406 if wall.iter().any(|x| *x == "all") {
1411 // Don't handle -W help here, because we might first load plugins.
1412 let r = matches.opt_strs("Z");
1413 if r.iter().any(|x| *x == "help") {
1414 describe_debug_flags();
1418 let cg_flags = matches.opt_strs("C");
1419 if cg_flags.iter().any(|x| *x == "help") {
1420 describe_codegen_flags();
1424 if cg_flags.iter().any(|x| *x == "no-stack-check") {
1425 early_warn(ErrorOutputType::default(),
1426 "the --no-stack-check flag is deprecated and does nothing");
1429 if cg_flags.contains(&"passes=list".to_string()) {
1430 get_trans_sysroot("llvm")().print_passes();
1434 if matches.opt_present("version") {
1435 version("rustc", &matches);
1442 fn parse_crate_attrs<'a>(sess: &'a Session, input: &Input) -> PResult<'a, Vec<ast::Attribute>> {
1444 Input::File(ref ifile) => {
1445 parse::parse_crate_attrs_from_file(ifile, &sess.parse_sess)
1447 Input::Str { ref name, ref input } => {
1448 parse::parse_crate_attrs_from_source_str(name.clone(),
1455 /// Runs `f` in a suitable thread for running `rustc`; returns a
1456 /// `Result` with either the return value of `f` or -- if a panic
1457 /// occurs -- the panic value.
1458 pub fn in_rustc_thread<F, R>(f: F) -> Result<R, Box<Any + Send>>
1459 where F: FnOnce() -> R + Send + 'static,
1462 // Temporarily have stack size set to 16MB to deal with nom-using crates failing
1463 const STACK_SIZE: usize = 16 * 1024 * 1024; // 16MB
1466 let spawn_thread = unsafe {
1467 // Fetch the current resource limits
1468 let mut rlim = libc::rlimit {
1472 if libc::getrlimit(libc::RLIMIT_STACK, &mut rlim) != 0 {
1473 let err = io::Error::last_os_error();
1474 error!("in_rustc_thread: error calling getrlimit: {}", err);
1476 } else if rlim.rlim_max < STACK_SIZE as libc::rlim_t {
1479 std::rt::deinit_stack_guard();
1480 rlim.rlim_cur = STACK_SIZE as libc::rlim_t;
1481 if libc::setrlimit(libc::RLIMIT_STACK, &mut rlim) != 0 {
1482 let err = io::Error::last_os_error();
1483 error!("in_rustc_thread: error calling setrlimit: {}", err);
1484 std::rt::update_stack_guard();
1487 std::rt::update_stack_guard();
1493 // We set the stack size at link time. See src/rustc/rustc.rs.
1495 let spawn_thread = false;
1497 #[cfg(not(any(windows,unix)))]
1498 let spawn_thread = true;
1500 // The or condition is added from backward compatibility.
1501 if spawn_thread || env::var_os("RUST_MIN_STACK").is_some() {
1502 let mut cfg = thread::Builder::new().name("rustc".to_string());
1504 // FIXME: Hacks on hacks. If the env is trying to override the stack size
1505 // then *don't* set it explicitly.
1506 if env::var_os("RUST_MIN_STACK").is_none() {
1507 cfg = cfg.stack_size(STACK_SIZE);
1510 let thread = cfg.spawn(f);
1511 thread.unwrap().join()
1517 /// Get a list of extra command-line flags provided by the user, as strings.
1519 /// This function is used during ICEs to show more information useful for
1520 /// debugging, since some ICEs only happens with non-default compiler flags
1521 /// (and the users don't always report them).
1522 fn extra_compiler_flags() -> Option<(Vec<String>, bool)> {
1523 let mut args = Vec::new();
1524 for arg in env::args_os() {
1525 args.push(arg.to_string_lossy().to_string());
1528 // Avoid printing help because of empty args. This can suggest the compiler
1529 // itself is not the program root (consider RLS).
1534 let matches = if let Some(matches) = handle_options(&args) {
1540 let mut result = Vec::new();
1541 let mut excluded_cargo_defaults = false;
1542 for flag in ICE_REPORT_COMPILER_FLAGS {
1543 let prefix = if flag.len() == 1 { "-" } else { "--" };
1545 for content in &matches.opt_strs(flag) {
1546 // Split always returns the first element
1547 let name = if let Some(first) = content.split('=').next() {
1553 let content = if ICE_REPORT_COMPILER_FLAGS_STRIP_VALUE.contains(&name) {
1559 if !ICE_REPORT_COMPILER_FLAGS_EXCLUDE.contains(&name) {
1560 result.push(format!("{}{} {}", prefix, flag, content));
1562 excluded_cargo_defaults = true;
1567 if result.len() > 0 {
1568 Some((result, excluded_cargo_defaults))
1574 /// Run a procedure which will detect panics in the compiler and print nicer
1575 /// error messages rather than just failing the test.
1577 /// The diagnostic emitter yielded to the procedure should be used for reporting
1578 /// errors of the compiler.
1579 pub fn monitor<F: FnOnce() + Send + 'static>(f: F) {
1580 let result = in_rustc_thread(move || {
1584 if let Err(value) = result {
1585 // Thread panicked without emitting a fatal diagnostic
1586 if !value.is::<errors::FatalErrorMarker>() {
1591 Box::new(errors::emitter::EmitterWriter::stderr(errors::ColorConfig::Auto,
1595 let handler = errors::Handler::with_emitter(true, false, emitter);
1597 // a .span_bug or .bug call has already printed what
1598 // it wants to print.
1599 if !value.is::<errors::ExplicitBug>() {
1600 handler.emit(&MultiSpan::new(),
1602 errors::Level::Bug);
1606 "the compiler unexpectedly panicked. this is a bug.".to_string(),
1607 format!("we would appreciate a bug report: {}", BUG_REPORT_URL),
1608 format!("rustc {} running on {}",
1609 option_env!("CFG_VERSION").unwrap_or("unknown_version"),
1610 config::host_triple()),
1613 if let Some((flags, excluded_cargo_defaults)) = extra_compiler_flags() {
1614 xs.push(format!("compiler flags: {}", flags.join(" ")));
1616 if excluded_cargo_defaults {
1617 xs.push("some of the compiler flags provided by cargo are hidden".to_string());
1622 handler.emit(&MultiSpan::new(),
1624 errors::Level::Note);
1628 panic::resume_unwind(Box::new(errors::FatalErrorMarker));
1632 pub fn diagnostics_registry() -> errors::registry::Registry {
1633 use errors::registry::Registry;
1635 let mut all_errors = Vec::new();
1636 all_errors.extend_from_slice(&rustc::DIAGNOSTICS);
1637 all_errors.extend_from_slice(&rustc_typeck::DIAGNOSTICS);
1638 all_errors.extend_from_slice(&rustc_resolve::DIAGNOSTICS);
1639 all_errors.extend_from_slice(&rustc_privacy::DIAGNOSTICS);
1640 // FIXME: need to figure out a way to get these back in here
1641 // all_errors.extend_from_slice(get_trans(sess).diagnostics());
1642 all_errors.extend_from_slice(&rustc_trans_utils::DIAGNOSTICS);
1643 all_errors.extend_from_slice(&rustc_metadata::DIAGNOSTICS);
1644 all_errors.extend_from_slice(&rustc_passes::DIAGNOSTICS);
1645 all_errors.extend_from_slice(&rustc_plugin::DIAGNOSTICS);
1646 all_errors.extend_from_slice(&rustc_mir::DIAGNOSTICS);
1647 all_errors.extend_from_slice(&syntax::DIAGNOSTICS);
1649 Registry::new(&all_errors)
1652 /// This allows tools to enable rust logging without having to magically match rustc's
1653 /// log crate version
1654 pub fn init_rustc_env_logger() {
1659 init_rustc_env_logger();
1660 let result = run(|| {
1661 let args = env::args_os().enumerate()
1662 .map(|(i, arg)| arg.into_string().unwrap_or_else(|arg| {
1663 early_error(ErrorOutputType::default(),
1664 &format!("Argument {} is not valid Unicode: {:?}", i, arg))
1666 .collect::<Vec<_>>();
1668 &mut RustcDefaultCalls,
1672 process::exit(result as i32);