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/")]
22 #![feature(box_syntax)]
23 #![cfg_attr(unix, feature(libc))]
25 #![feature(rustc_diagnostic_macros)]
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;
86 use std::cmp::Ordering::Equal;
88 use std::default::Default;
89 use std::env::consts::{DLL_PREFIX, DLL_SUFFIX};
91 use std::ffi::OsString;
92 use std::io::{self, Read, Write};
93 use std::iter::repeat;
96 use std::path::{PathBuf, Path};
97 use std::process::{self, Command, Stdio};
99 use std::sync::atomic::{AtomicBool, ATOMIC_BOOL_INIT, Ordering};
100 use std::sync::{Once, ONCE_INIT};
104 use syntax::codemap::{CodeMap, FileLoader, RealFileLoader};
105 use syntax::feature_gate::{GatedCfg, UnstableFeatures};
106 use syntax::parse::{self, PResult};
107 use syntax_pos::{DUMMY_SP, MultiSpan, FileName};
115 mod derive_registrar;
117 pub mod target_features {
119 use syntax::symbol::Symbol;
120 use rustc::session::Session;
121 use rustc_trans_utils::trans_crate::TransCrate;
123 /// Add `target_feature = "..."` cfgs for a variety of platform
124 /// specific features (SSE, NEON etc.).
126 /// This is performed by checking whether a whitelisted set of
127 /// features is available on the target machine, by querying LLVM.
128 pub fn add_configuration(cfg: &mut ast::CrateConfig, sess: &Session, trans: &TransCrate) {
129 let tf = Symbol::intern("target_feature");
131 for feat in trans.target_features(sess) {
132 cfg.insert((tf, Some(feat)));
135 if sess.crt_static_feature() {
136 cfg.insert((tf, Some(Symbol::intern("crt-static"))));
141 const BUG_REPORT_URL: &'static str = "https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.\
144 const ICE_REPORT_COMPILER_FLAGS: &'static [&'static str] = &[
149 const ICE_REPORT_COMPILER_FLAGS_EXCLUDE: &'static [&'static str] = &[
153 const ICE_REPORT_COMPILER_FLAGS_STRIP_VALUE: &'static [&'static str] = &[
157 pub fn abort_on_err<T>(result: Result<T, CompileIncomplete>, sess: &Session) -> T {
159 Err(CompileIncomplete::Errored(ErrorReported)) => {
160 sess.abort_if_errors();
161 panic!("error reported but abort_if_errors didn't abort???");
163 Err(CompileIncomplete::Stopped) => {
164 sess.fatal("compilation terminated");
170 pub fn run<F>(run_compiler: F) -> isize
171 where F: FnOnce() -> (CompileResult, Option<Session>) + Send + 'static
174 let (result, session) = run_compiler();
175 if let Err(CompileIncomplete::Errored(_)) = result {
178 sess.abort_if_errors();
179 panic!("error reported but abort_if_errors didn't abort???");
183 errors::emitter::EmitterWriter::stderr(errors::ColorConfig::Auto,
187 let handler = errors::Handler::with_emitter(true, false, Box::new(emitter));
188 handler.emit(&MultiSpan::new(),
189 "aborting due to previous error(s)",
190 errors::Level::Fatal);
191 panic::resume_unwind(Box::new(errors::FatalErrorMarker));
199 fn load_backend_from_dylib(path: &Path) -> fn() -> Box<TransCrate> {
200 // Note that we're specifically using `open_global_now` here rather than
201 // `open`, namely we want the behavior on Unix of RTLD_GLOBAL and RTLD_NOW,
202 // where NOW means "bind everything right now" because we don't want
203 // surprises later on and RTLD_GLOBAL allows the symbols to be made
204 // available for future dynamic libraries opened. This is currently used by
205 // loading LLVM and then making its symbols available for other dynamic
207 let lib = match DynamicLibrary::open_global_now(path) {
210 let err = format!("couldn't load codegen backend {:?}: {:?}",
213 early_error(ErrorOutputType::default(), &err);
217 match lib.symbol("__rustc_codegen_backend") {
220 mem::transmute::<*mut u8, _>(f)
223 let err = format!("couldn't load codegen backend as it \
224 doesn't export the `__rustc_codegen_backend` \
226 early_error(ErrorOutputType::default(), &err);
232 pub fn get_trans(sess: &Session) -> Box<TransCrate> {
233 static INIT: Once = ONCE_INIT;
234 static mut LOAD: fn() -> Box<TransCrate> = || unreachable!();
237 let trans_name = sess.opts.debugging_opts.codegen_backend.as_ref()
238 .unwrap_or(&sess.target.target.options.codegen_backend);
239 let backend = match &trans_name[..] {
241 rustc_trans_utils::trans_crate::MetadataOnlyTransCrate::new
243 filename if filename.contains(".") => {
244 load_backend_from_dylib(filename.as_ref())
246 trans_name => get_trans_sysroot(trans_name),
253 let backend = unsafe { LOAD() };
258 fn get_trans_sysroot(backend_name: &str) -> fn() -> Box<TransCrate> {
259 // For now we only allow this function to be called once as it'll dlopen a
260 // few things, which seems to work best if we only do that once. In
261 // general this assertion never trips due to the once guard in `get_trans`,
262 // but there's a few manual calls to this function in this file we protect
264 static LOADED: AtomicBool = ATOMIC_BOOL_INIT;
265 assert!(!LOADED.fetch_or(true, Ordering::SeqCst),
266 "cannot load the default trans backend twice");
268 // When we're compiling this library with `--test` it'll run as a binary but
269 // not actually exercise much functionality. As a result most of the logic
270 // here is defunkt (it assumes we're a dynamic library in a sysroot) so
271 // let's just return a dummy creation function which won't be used in
274 return rustc_trans_utils::trans_crate::MetadataOnlyTransCrate::new
277 let target = session::config::host_triple();
278 let mut sysroot_candidates = vec![filesearch::get_or_default_sysroot()];
279 let path = current_dll_path()
280 .and_then(|s| s.canonicalize().ok());
281 if let Some(dll) = path {
282 // use `parent` twice to chop off the file name and then also the
283 // directory containing the dll which should be either `lib` or `bin`.
284 if let Some(path) = dll.parent().and_then(|p| p.parent()) {
285 // The original `path` pointed at the `rustc_driver` crate's dll.
286 // Now that dll should only be in one of two locations. The first is
287 // in the compiler's libdir, for example `$sysroot/lib/*.dll`. The
288 // other is the target's libdir, for example
289 // `$sysroot/lib/rustlib/$target/lib/*.dll`.
291 // We don't know which, so let's assume that if our `path` above
292 // ends in `$target` we *could* be in the target libdir, and always
293 // assume that we may be in the main libdir.
294 sysroot_candidates.push(path.to_owned());
296 if path.ends_with(target) {
297 sysroot_candidates.extend(path.parent() // chop off `$target`
298 .and_then(|p| p.parent()) // chop off `rustlib`
299 .and_then(|p| p.parent()) // chop off `lib`
300 .map(|s| s.to_owned()));
305 let sysroot = sysroot_candidates.iter()
307 let libdir = filesearch::relative_target_lib_path(&sysroot, &target);
309 .with_file_name(option_env!("CFG_CODEGEN_BACKENDS_DIR")
310 .unwrap_or("codegen-backends"))
313 info!("codegen backend candidate: {}", f.display());
317 let sysroot = match sysroot {
320 let candidates = sysroot_candidates.iter()
321 .map(|p| p.display().to_string())
324 let err = format!("failed to find a `codegen-backends` folder \
325 in the sysroot candidates:\n* {}", candidates);
326 early_error(ErrorOutputType::default(), &err);
329 info!("probing {} for a codegen backend", sysroot.display());
331 let d = match sysroot.read_dir() {
334 let err = format!("failed to load default codegen backend, couldn't \
335 read `{}`: {}", sysroot.display(), e);
336 early_error(ErrorOutputType::default(), &err);
340 let mut file: Option<PathBuf> = None;
342 let expected_name = format!("rustc_trans-{}", backend_name);
343 for entry in d.filter_map(|e| e.ok()) {
344 let path = entry.path();
345 let filename = match path.file_name().and_then(|s| s.to_str()) {
349 if !(filename.starts_with(DLL_PREFIX) && filename.ends_with(DLL_SUFFIX)) {
352 let name = &filename[DLL_PREFIX.len() .. filename.len() - DLL_SUFFIX.len()];
353 if name != expected_name {
356 if let Some(ref prev) = file {
357 let err = format!("duplicate codegen backends found\n\
360 ", prev.display(), path.display());
361 early_error(ErrorOutputType::default(), &err);
363 file = Some(path.clone());
367 Some(ref s) => return load_backend_from_dylib(s),
369 let err = format!("failed to load default codegen backend for `{}`, \
370 no appropriate codegen dylib found in `{}`",
371 backend_name, sysroot.display());
372 early_error(ErrorOutputType::default(), &err);
377 fn current_dll_path() -> Option<PathBuf> {
378 use std::ffi::{OsStr, CStr};
379 use std::os::unix::prelude::*;
382 let addr = current_dll_path as usize as *mut _;
383 let mut info = mem::zeroed();
384 if libc::dladdr(addr, &mut info) == 0 {
385 info!("dladdr failed");
388 if info.dli_fname.is_null() {
389 info!("dladdr returned null pointer");
392 let bytes = CStr::from_ptr(info.dli_fname).to_bytes();
393 let os = OsStr::from_bytes(bytes);
394 Some(PathBuf::from(os))
399 fn current_dll_path() -> Option<PathBuf> {
400 use std::ffi::OsString;
401 use std::os::windows::prelude::*;
404 fn GetModuleHandleExW(dwFlags: u32,
406 phModule: *mut usize) -> i32;
407 fn GetModuleFileNameW(hModule: usize,
408 lpFilename: *mut u16,
412 const GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS: u32 = 0x00000004;
416 let r = GetModuleHandleExW(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
417 current_dll_path as usize,
420 info!("GetModuleHandleExW failed: {}", io::Error::last_os_error());
423 let mut space = Vec::with_capacity(1024);
424 let r = GetModuleFileNameW(module,
426 space.capacity() as u32);
428 info!("GetModuleFileNameW failed: {}", io::Error::last_os_error());
432 if r >= space.capacity() {
433 info!("our buffer was too small? {}",
434 io::Error::last_os_error());
438 let os = OsString::from_wide(&space);
439 Some(PathBuf::from(os))
444 // Parse args and run the compiler. This is the primary entry point for rustc.
445 // See comments on CompilerCalls below for details about the callbacks argument.
446 // The FileLoader provides a way to load files from sources other than the file system.
447 pub fn run_compiler<'a>(args: &[String],
448 callbacks: &mut CompilerCalls<'a>,
449 file_loader: Option<Box<FileLoader + Send + Sync + 'static>>,
450 emitter_dest: Option<Box<Write + Send>>)
451 -> (CompileResult, Option<Session>)
453 syntax::with_globals(|| {
454 run_compiler_impl(args, callbacks, file_loader, emitter_dest)
458 fn run_compiler_impl<'a>(args: &[String],
459 callbacks: &mut CompilerCalls<'a>,
460 file_loader: Option<Box<FileLoader + Send + Sync + 'static>>,
461 emitter_dest: Option<Box<Write + Send>>)
462 -> (CompileResult, Option<Session>)
464 macro_rules! do_or_return {($expr: expr, $sess: expr) => {
466 Compilation::Stop => return (Ok(()), $sess),
467 Compilation::Continue => {}
471 let matches = match handle_options(args) {
472 Some(matches) => matches,
473 None => return (Ok(()), None),
476 let (sopts, cfg) = config::build_session_options_and_crate_config(&matches);
478 let descriptions = diagnostics_registry();
480 do_or_return!(callbacks.early_callback(&matches,
487 let (odir, ofile) = make_output(&matches);
488 let (input, input_file_path, input_err) = match make_input(&matches.free) {
489 Some((input, input_file_path, input_err)) => {
490 let (input, input_file_path) = callbacks.some_input(input, input_file_path);
491 (input, input_file_path, input_err)
493 None => match callbacks.no_input(&matches, &sopts, &cfg, &odir, &ofile, &descriptions) {
494 Some((input, input_file_path)) => (input, input_file_path, None),
495 None => return (Ok(()), None),
499 let loader = file_loader.unwrap_or(box RealFileLoader);
500 let codemap = Lrc::new(CodeMap::with_file_loader(loader, sopts.file_path_mapping()));
501 let mut sess = session::build_session_with_codemap(
502 sopts, input_file_path.clone(), descriptions, codemap, emitter_dest,
505 if let Some(err) = input_err {
506 // Immediately stop compilation if there was an issue reading
507 // the input (for example if the input stream is not UTF-8).
508 sess.err(&format!("{}", err));
509 return (Err(CompileIncomplete::Stopped), Some(sess));
512 let trans = get_trans(&sess);
514 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
516 let mut cfg = config::build_configuration(&sess, cfg);
517 target_features::add_configuration(&mut cfg, &sess, &*trans);
518 sess.parse_sess.config = cfg;
521 let plugins = sess.opts.debugging_opts.extra_plugins.clone();
523 let cstore = CStore::new(trans.metadata_loader());
525 do_or_return!(callbacks.late_callback(&*trans,
531 &ofile), Some(sess));
533 let _sess_abort_error = OnDrop(|| sess.diagnostic().print_error_count());
535 let control = callbacks.build_controller(&sess, &matches);
537 driver::compile_input(trans,
552 pub fn set_sigpipe_handler() {
554 // Set the SIGPIPE signal handler, so that an EPIPE
555 // will cause rustc to terminate, as expected.
556 assert!(libc::signal(libc::SIGPIPE, libc::SIG_DFL) != libc::SIG_ERR);
561 pub fn set_sigpipe_handler() {}
563 // Extract output directory and file from matches.
564 fn make_output(matches: &getopts::Matches) -> (Option<PathBuf>, Option<PathBuf>) {
565 let odir = matches.opt_str("out-dir").map(|o| PathBuf::from(&o));
566 let ofile = matches.opt_str("o").map(|o| PathBuf::from(&o));
570 // Extract input (string or file and optional path) from matches.
571 fn make_input(free_matches: &[String]) -> Option<(Input, Option<PathBuf>, Option<io::Error>)> {
572 if free_matches.len() == 1 {
573 let ifile = &free_matches[0];
575 let mut src = String::new();
576 let err = if io::stdin().read_to_string(&mut src).is_err() {
577 Some(io::Error::new(io::ErrorKind::InvalidData,
578 "couldn't read from stdin, as it did not contain valid UTF-8"))
582 Some((Input::Str { name: FileName::Anon, input: src },
585 Some((Input::File(PathBuf::from(ifile)),
586 Some(PathBuf::from(ifile)), None))
593 fn parse_pretty(sess: &Session,
594 matches: &getopts::Matches)
595 -> Option<(PpMode, Option<UserIdentifiedItem>)> {
596 let pretty = if sess.opts.debugging_opts.unstable_options {
597 matches.opt_default("pretty", "normal").map(|a| {
598 // stable pretty-print variants only
599 pretty::parse_pretty(sess, &a, false)
605 if pretty.is_none() {
606 sess.opts.debugging_opts.unpretty.as_ref().map(|a| {
607 // extended with unstable pretty-print variants
608 pretty::parse_pretty(sess, &a, true)
615 // Whether to stop or continue compilation.
616 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
617 pub enum Compilation {
623 pub fn and_then<F: FnOnce() -> Compilation>(self, next: F) -> Compilation {
625 Compilation::Stop => Compilation::Stop,
626 Compilation::Continue => next(),
631 // A trait for customising the compilation process. Offers a number of hooks for
632 // executing custom code or customising input.
633 pub trait CompilerCalls<'a> {
634 // Hook for a callback early in the process of handling arguments. This will
635 // be called straight after options have been parsed but before anything
636 // else (e.g., selecting input and output).
637 fn early_callback(&mut self,
638 _: &getopts::Matches,
640 _: &ast::CrateConfig,
641 _: &errors::registry::Registry,
644 Compilation::Continue
647 // Hook for a callback late in the process of handling arguments. This will
648 // be called just before actual compilation starts (and before build_controller
649 // is called), after all arguments etc. have been completely handled.
650 fn late_callback(&mut self,
652 _: &getopts::Matches,
659 Compilation::Continue
662 // Called after we extract the input from the arguments. Gives the implementer
663 // an opportunity to change the inputs or to add some custom input handling.
664 // The default behaviour is to simply pass through the inputs.
665 fn some_input(&mut self,
667 input_path: Option<PathBuf>)
668 -> (Input, Option<PathBuf>) {
672 // Called after we extract the input from the arguments if there is no valid
673 // input. Gives the implementer an opportunity to supply alternate input (by
674 // returning a Some value) or to add custom behaviour for this error such as
675 // emitting error messages. Returning None will cause compilation to stop
677 fn no_input(&mut self,
678 _: &getopts::Matches,
680 _: &ast::CrateConfig,
683 _: &errors::registry::Registry)
684 -> Option<(Input, Option<PathBuf>)> {
688 // Create a CompilController struct for controlling the behaviour of
690 fn build_controller(&mut self, _: &Session, _: &getopts::Matches) -> CompileController<'a>;
693 // CompilerCalls instance for a regular rustc build.
694 #[derive(Copy, Clone)]
695 pub struct RustcDefaultCalls;
697 // FIXME remove these and use winapi 0.3 instead
698 // Duplicates: bootstrap/compile.rs, librustc_errors/emitter.rs
700 fn stdout_isatty() -> bool {
701 unsafe { libc::isatty(libc::STDOUT_FILENO) != 0 }
705 fn stdout_isatty() -> bool {
708 type HANDLE = *mut u8;
709 type LPDWORD = *mut u32;
710 const STD_OUTPUT_HANDLE: DWORD = -11i32 as DWORD;
712 fn GetStdHandle(which: DWORD) -> HANDLE;
713 fn GetConsoleMode(hConsoleHandle: HANDLE, lpMode: LPDWORD) -> BOOL;
716 let handle = GetStdHandle(STD_OUTPUT_HANDLE);
718 GetConsoleMode(handle, &mut out) != 0
722 fn handle_explain(code: &str,
723 descriptions: &errors::registry::Registry,
724 output: ErrorOutputType) {
725 let normalised = if code.starts_with("E") {
728 format!("E{0:0>4}", code)
730 match descriptions.find_description(&normalised) {
731 Some(ref description) => {
732 let mut is_in_code_block = false;
733 let mut text = String::new();
735 // Slice off the leading newline and print.
736 for line in description[1..].lines() {
737 let indent_level = line.find(|c: char| !c.is_whitespace())
738 .unwrap_or_else(|| line.len());
739 let dedented_line = &line[indent_level..];
740 if dedented_line.starts_with("```") {
741 is_in_code_block = !is_in_code_block;
742 text.push_str(&line[..(indent_level+3)]);
743 } else if is_in_code_block && dedented_line.starts_with("# ") {
752 show_content_with_pager(&text);
758 early_error(output, &format!("no extended information for {}", code));
763 fn show_content_with_pager(content: &String) {
764 let pager_name = env::var_os("PAGER").unwrap_or_else(|| if cfg!(windows) {
765 OsString::from("more.com")
767 OsString::from("less")
770 let mut fallback_to_println = false;
772 match Command::new(pager_name).stdin(Stdio::piped()).spawn() {
774 if let Some(pipe) = pager.stdin.as_mut() {
775 if pipe.write_all(content.as_bytes()).is_err() {
776 fallback_to_println = true;
780 if pager.wait().is_err() {
781 fallback_to_println = true;
785 fallback_to_println = true;
789 // If pager fails for whatever reason, we should still print the content
790 // to standard output
791 if fallback_to_println {
792 print!("{}", content);
796 impl<'a> CompilerCalls<'a> for RustcDefaultCalls {
797 fn early_callback(&mut self,
798 matches: &getopts::Matches,
800 _: &ast::CrateConfig,
801 descriptions: &errors::registry::Registry,
802 output: ErrorOutputType)
804 if let Some(ref code) = matches.opt_str("explain") {
805 handle_explain(code, descriptions, output);
806 return Compilation::Stop;
809 Compilation::Continue
812 fn no_input(&mut self,
813 matches: &getopts::Matches,
814 sopts: &config::Options,
815 cfg: &ast::CrateConfig,
816 odir: &Option<PathBuf>,
817 ofile: &Option<PathBuf>,
818 descriptions: &errors::registry::Registry)
819 -> Option<(Input, Option<PathBuf>)> {
820 match matches.free.len() {
822 let mut sess = build_session(sopts.clone(),
824 descriptions.clone());
825 if sopts.describe_lints {
826 let mut ls = lint::LintStore::new();
827 rustc_lint::register_builtins(&mut ls, Some(&sess));
828 describe_lints(&sess, &ls, false);
831 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
832 let mut cfg = config::build_configuration(&sess, cfg.clone());
833 let trans = get_trans(&sess);
834 target_features::add_configuration(&mut cfg, &sess, &*trans);
835 sess.parse_sess.config = cfg;
836 let should_stop = RustcDefaultCalls::print_crate_info(
844 if should_stop == Compilation::Stop {
847 early_error(sopts.error_format, "no input filename given");
849 1 => panic!("make_input should have provided valid inputs"),
850 _ => early_error(sopts.error_format, "multiple input filenames provided"),
854 fn late_callback(&mut self,
856 matches: &getopts::Matches,
860 odir: &Option<PathBuf>,
861 ofile: &Option<PathBuf>)
863 RustcDefaultCalls::print_crate_info(trans, sess, Some(input), odir, ofile)
864 .and_then(|| RustcDefaultCalls::list_metadata(sess, cstore, matches, input))
867 fn build_controller(&mut self,
869 matches: &getopts::Matches)
870 -> CompileController<'a> {
871 let mut control = CompileController::basic();
873 control.keep_ast = sess.opts.debugging_opts.keep_ast;
874 control.continue_parse_after_error = sess.opts.debugging_opts.continue_parse_after_error;
876 if let Some((ppm, opt_uii)) = parse_pretty(sess, matches) {
877 if ppm.needs_ast_map(&opt_uii) {
878 control.after_hir_lowering.stop = Compilation::Stop;
880 control.after_parse.callback = box move |state| {
881 state.krate = Some(pretty::fold_crate(state.session,
882 state.krate.take().unwrap(),
885 control.after_hir_lowering.callback = box move |state| {
886 pretty::print_after_hir_lowering(state.session,
887 state.cstore.unwrap(),
888 state.hir_map.unwrap(),
889 state.analysis.unwrap(),
890 state.resolutions.unwrap(),
892 &state.expanded_crate.take().unwrap(),
893 state.crate_name.unwrap(),
895 state.arenas.unwrap(),
896 state.output_filenames.unwrap(),
901 control.after_parse.stop = Compilation::Stop;
903 control.after_parse.callback = box move |state| {
904 let krate = pretty::fold_crate(state.session, state.krate.take().unwrap(), ppm);
905 pretty::print_after_parsing(state.session,
916 if sess.opts.debugging_opts.parse_only ||
917 sess.opts.debugging_opts.show_span.is_some() ||
918 sess.opts.debugging_opts.ast_json_noexpand {
919 control.after_parse.stop = Compilation::Stop;
922 if sess.opts.debugging_opts.no_analysis ||
923 sess.opts.debugging_opts.ast_json {
924 control.after_hir_lowering.stop = Compilation::Stop;
927 if sess.opts.debugging_opts.save_analysis {
928 enable_save_analysis(&mut control);
931 if sess.print_fuel_crate.is_some() {
932 let old_callback = control.compilation_done.callback;
933 control.compilation_done.callback = box move |state| {
935 let sess = state.session;
936 println!("Fuel used by {}: {}",
937 sess.print_fuel_crate.as_ref().unwrap(),
938 sess.print_fuel.get());
945 pub fn enable_save_analysis(control: &mut CompileController) {
946 control.keep_ast = true;
947 control.after_analysis.callback = box |state| {
948 time(state.session, "save analysis", || {
949 save::process_crate(state.tcx.unwrap(),
950 state.expanded_crate.unwrap(),
951 state.analysis.unwrap(),
952 state.crate_name.unwrap(),
954 DumpHandler::new(state.out_dir,
955 state.crate_name.unwrap()))
958 control.after_analysis.run_callback_on_error = true;
959 control.make_glob_map = resolve::MakeGlobMap::Yes;
962 impl RustcDefaultCalls {
963 pub fn list_metadata(sess: &Session,
965 matches: &getopts::Matches,
968 let r = matches.opt_strs("Z");
969 if r.contains(&("ls".to_string())) {
971 &Input::File(ref ifile) => {
972 let path = &(*ifile);
973 let mut v = Vec::new();
974 locator::list_file_metadata(&sess.target.target,
976 cstore.metadata_loader(),
979 println!("{}", String::from_utf8(v).unwrap());
981 &Input::Str { .. } => {
982 early_error(ErrorOutputType::default(), "cannot list metadata for stdin");
985 return Compilation::Stop;
988 return Compilation::Continue;
992 fn print_crate_info(trans: &TransCrate,
994 input: Option<&Input>,
995 odir: &Option<PathBuf>,
996 ofile: &Option<PathBuf>)
998 use rustc::session::config::PrintRequest::*;
999 // PrintRequest::NativeStaticLibs is special - printed during linking
1000 // (empty iterator returns true)
1001 if sess.opts.prints.iter().all(|&p| p==PrintRequest::NativeStaticLibs) {
1002 return Compilation::Continue;
1005 let attrs = match input {
1008 let result = parse_crate_attrs(sess, input);
1010 Ok(attrs) => Some(attrs),
1011 Err(mut parse_error) => {
1013 return Compilation::Stop;
1018 for req in &sess.opts.prints {
1021 let mut targets = rustc_back::target::get_targets().collect::<Vec<String>>();
1023 println!("{}", targets.join("\n"));
1025 Sysroot => println!("{}", sess.sysroot().display()),
1026 TargetSpec => println!("{}", sess.target.target.to_json().pretty()),
1027 FileNames | CrateName => {
1028 let input = match input {
1029 Some(input) => input,
1030 None => early_error(ErrorOutputType::default(), "no input file provided"),
1032 let attrs = attrs.as_ref().unwrap();
1033 let t_outputs = driver::build_output_filenames(input, odir, ofile, attrs, sess);
1034 let id = rustc_trans_utils::link::find_crate_name(Some(sess), attrs, input);
1035 if *req == PrintRequest::CrateName {
1039 let crate_types = driver::collect_crate_types(sess, attrs);
1040 for &style in &crate_types {
1041 let fname = rustc_trans_utils::link::filename_for_input(
1050 .to_string_lossy());
1054 let allow_unstable_cfg = UnstableFeatures::from_environment()
1055 .is_nightly_build();
1057 let mut cfgs = Vec::new();
1058 for &(name, ref value) in sess.parse_sess.config.iter() {
1059 let gated_cfg = GatedCfg::gate(&ast::MetaItem {
1060 ident: ast::Ident::with_empty_ctxt(name),
1061 node: ast::MetaItemKind::Word,
1065 // Note that crt-static is a specially recognized cfg
1066 // directive that's printed out here as part of
1067 // rust-lang/rust#37406, but in general the
1068 // `target_feature` cfg is gated under
1069 // rust-lang/rust#29717. For now this is just
1070 // specifically allowing the crt-static cfg and that's
1071 // it, this is intended to get into Cargo and then go
1072 // through to build scripts.
1073 let value = value.as_ref().map(|s| s.as_str());
1074 let value = value.as_ref().map(|s| s.as_ref());
1075 if name != "target_feature" || value != Some("crt-static") {
1076 if !allow_unstable_cfg && gated_cfg.is_some() {
1081 cfgs.push(if let Some(value) = value {
1082 format!("{}=\"{}\"", name, value)
1090 println!("{}", cfg);
1093 RelocationModels | CodeModels | TlsModels | TargetCPUs | TargetFeatures => {
1094 trans.print(*req, sess);
1096 // Any output here interferes with Cargo's parsing of other printed output
1097 PrintRequest::NativeStaticLibs => {}
1100 return Compilation::Stop;
1104 /// Returns a version string such as "0.12.0-dev".
1105 fn release_str() -> Option<&'static str> {
1106 option_env!("CFG_RELEASE")
1109 /// Returns the full SHA1 hash of HEAD of the Git repo from which rustc was built.
1110 fn commit_hash_str() -> Option<&'static str> {
1111 option_env!("CFG_VER_HASH")
1114 /// Returns the "commit date" of HEAD of the Git repo from which rustc was built as a static string.
1115 fn commit_date_str() -> Option<&'static str> {
1116 option_env!("CFG_VER_DATE")
1119 /// Prints version information
1120 pub fn version(binary: &str, matches: &getopts::Matches) {
1121 let verbose = matches.opt_present("verbose");
1125 option_env!("CFG_VERSION").unwrap_or("unknown version"));
1127 fn unw(x: Option<&str>) -> &str {
1128 x.unwrap_or("unknown")
1130 println!("binary: {}", binary);
1131 println!("commit-hash: {}", unw(commit_hash_str()));
1132 println!("commit-date: {}", unw(commit_date_str()));
1133 println!("host: {}", config::host_triple());
1134 println!("release: {}", unw(release_str()));
1135 get_trans_sysroot("llvm")().print_version();
1139 fn usage(verbose: bool, include_unstable_options: bool) {
1140 let groups = if verbose {
1141 config::rustc_optgroups()
1143 config::rustc_short_optgroups()
1145 let mut options = getopts::Options::new();
1146 for option in groups.iter().filter(|x| include_unstable_options || x.is_stable()) {
1147 (option.apply)(&mut options);
1149 let message = format!("Usage: rustc [OPTIONS] INPUT");
1150 let nightly_help = if nightly_options::is_nightly_build() {
1151 "\n -Z help Print internal options for debugging rustc"
1155 let verbose_help = if verbose {
1158 "\n --help -v Print the full set of options rustc accepts"
1160 println!("{}\nAdditional help:
1161 -C help Print codegen options
1163 Print 'lint' options and default settings{}{}\n",
1164 options.usage(&message),
1169 fn print_wall_help() {
1171 The flag `-Wall` does not exist in `rustc`. Most useful lints are enabled by
1172 default. Use `rustc -W help` to see all available lints. It's more common to put
1173 warning settings in the crate root using `#![warn(LINT_NAME)]` instead of using
1174 the command line flag directly.
1178 fn describe_lints(sess: &Session, lint_store: &lint::LintStore, loaded_plugins: bool) {
1180 Available lint options:
1181 -W <foo> Warn about <foo>
1185 -F <foo> Forbid <foo> \
1186 (deny <foo> and all attempts to override)
1190 fn sort_lints(sess: &Session, lints: Vec<(&'static Lint, bool)>) -> Vec<&'static Lint> {
1191 let mut lints: Vec<_> = lints.into_iter().map(|(x, _)| x).collect();
1192 lints.sort_by(|x: &&Lint, y: &&Lint| {
1193 match x.default_level(sess).cmp(&y.default_level(sess)) {
1194 // The sort doesn't case-fold but it's doubtful we care.
1195 Equal => x.name.cmp(y.name),
1202 fn sort_lint_groups(lints: Vec<(&'static str, Vec<lint::LintId>, bool)>)
1203 -> Vec<(&'static str, Vec<lint::LintId>)> {
1204 let mut lints: Vec<_> = lints.into_iter().map(|(x, y, _)| (x, y)).collect();
1205 lints.sort_by(|&(x, _): &(&'static str, Vec<lint::LintId>),
1206 &(y, _): &(&'static str, Vec<lint::LintId>)| {
1212 let (plugin, builtin): (Vec<_>, _) = lint_store.get_lints()
1215 .partition(|&(_, p)| p);
1216 let plugin = sort_lints(sess, plugin);
1217 let builtin = sort_lints(sess, builtin);
1219 let (plugin_groups, builtin_groups): (Vec<_>, _) = lint_store.get_lint_groups()
1222 .partition(|&(.., p)| p);
1223 let plugin_groups = sort_lint_groups(plugin_groups);
1224 let builtin_groups = sort_lint_groups(builtin_groups);
1226 let max_name_len = plugin.iter()
1228 .map(|&s| s.name.chars().count())
1231 let padded = |x: &str| {
1232 let mut s = repeat(" ")
1233 .take(max_name_len - x.chars().count())
1234 .collect::<String>();
1239 println!("Lint checks provided by rustc:\n");
1240 println!(" {} {:7.7} {}", padded("name"), "default", "meaning");
1241 println!(" {} {:7.7} {}", padded("----"), "-------", "-------");
1243 let print_lints = |lints: Vec<&Lint>| {
1245 let name = lint.name_lower().replace("_", "-");
1246 println!(" {} {:7.7} {}",
1248 lint.default_level.as_str(),
1254 print_lints(builtin);
1258 let max_name_len = max("warnings".len(),
1259 plugin_groups.iter()
1260 .chain(&builtin_groups)
1261 .map(|&(s, _)| s.chars().count())
1265 let padded = |x: &str| {
1266 let mut s = repeat(" ")
1267 .take(max_name_len - x.chars().count())
1268 .collect::<String>();
1273 println!("Lint groups provided by rustc:\n");
1274 println!(" {} {}", padded("name"), "sub-lints");
1275 println!(" {} {}", padded("----"), "---------");
1276 println!(" {} {}", padded("warnings"), "all lints that are set to issue warnings");
1278 let print_lint_groups = |lints: Vec<(&'static str, Vec<lint::LintId>)>| {
1279 for (name, to) in lints {
1280 let name = name.to_lowercase().replace("_", "-");
1281 let desc = to.into_iter()
1282 .map(|x| x.to_string().replace("_", "-"))
1283 .collect::<Vec<String>>()
1285 println!(" {} {}", padded(&name), desc);
1290 print_lint_groups(builtin_groups);
1292 match (loaded_plugins, plugin.len(), plugin_groups.len()) {
1293 (false, 0, _) | (false, _, 0) => {
1294 println!("Compiler plugins can provide additional lints and lint groups. To see a \
1295 listing of these, re-run `rustc -W help` with a crate filename.");
1297 (false, ..) => panic!("didn't load lint plugins but got them anyway!"),
1298 (true, 0, 0) => println!("This crate does not load any lint plugins or lint groups."),
1301 println!("Lint checks provided by plugins loaded by this crate:\n");
1302 print_lints(plugin);
1305 println!("Lint groups provided by plugins loaded by this crate:\n");
1306 print_lint_groups(plugin_groups);
1312 fn describe_debug_flags() {
1313 println!("\nAvailable debug options:\n");
1314 print_flag_list("-Z", config::DB_OPTIONS);
1317 fn describe_codegen_flags() {
1318 println!("\nAvailable codegen options:\n");
1319 print_flag_list("-C", config::CG_OPTIONS);
1322 fn print_flag_list<T>(cmdline_opt: &str,
1323 flag_list: &[(&'static str, T, Option<&'static str>, &'static str)]) {
1324 let max_len = flag_list.iter()
1325 .map(|&(name, _, opt_type_desc, _)| {
1326 let extra_len = match opt_type_desc {
1330 name.chars().count() + extra_len
1335 for &(name, _, opt_type_desc, desc) in flag_list {
1336 let (width, extra) = match opt_type_desc {
1337 Some(..) => (max_len - 4, "=val"),
1338 None => (max_len, ""),
1340 println!(" {} {:>width$}{} -- {}",
1342 name.replace("_", "-"),
1349 /// Process command line options. Emits messages as appropriate. If compilation
1350 /// should continue, returns a getopts::Matches object parsed from args,
1351 /// otherwise returns None.
1353 /// The compiler's handling of options is a little complicated as it ties into
1354 /// our stability story, and it's even *more* complicated by historical
1355 /// accidents. The current intention of each compiler option is to have one of
1358 /// 1. An option is stable and can be used everywhere.
1359 /// 2. An option is unstable, but was historically allowed on the stable
1361 /// 3. An option is unstable, and can only be used on nightly.
1363 /// Like unstable library and language features, however, unstable options have
1364 /// always required a form of "opt in" to indicate that you're using them. This
1365 /// provides the easy ability to scan a code base to check to see if anything
1366 /// unstable is being used. Currently, this "opt in" is the `-Z` "zed" flag.
1368 /// All options behind `-Z` are considered unstable by default. Other top-level
1369 /// options can also be considered unstable, and they were unlocked through the
1370 /// `-Z unstable-options` flag. Note that `-Z` remains to be the root of
1371 /// instability in both cases, though.
1373 /// So with all that in mind, the comments below have some more detail about the
1374 /// contortions done here to get things to work out correctly.
1375 pub fn handle_options(args: &[String]) -> Option<getopts::Matches> {
1376 // Throw away the first argument, the name of the binary
1377 let args = &args[1..];
1379 if args.is_empty() {
1380 // user did not write `-v` nor `-Z unstable-options`, so do not
1381 // include that extra information.
1382 usage(false, false);
1386 // Parse with *all* options defined in the compiler, we don't worry about
1387 // option stability here we just want to parse as much as possible.
1388 let mut options = getopts::Options::new();
1389 for option in config::rustc_optgroups() {
1390 (option.apply)(&mut options);
1392 let matches = match options.parse(args) {
1394 Err(f) => early_error(ErrorOutputType::default(), &f.to_string()),
1397 // For all options we just parsed, we check a few aspects:
1399 // * If the option is stable, we're all good
1400 // * If the option wasn't passed, we're all good
1401 // * If `-Z unstable-options` wasn't passed (and we're not a -Z option
1402 // ourselves), then we require the `-Z unstable-options` flag to unlock
1403 // this option that was passed.
1404 // * If we're a nightly compiler, then unstable options are now unlocked, so
1405 // we're good to go.
1406 // * Otherwise, if we're a truly unstable option then we generate an error
1407 // (unstable option being used on stable)
1408 // * If we're a historically stable-but-should-be-unstable option then we
1409 // emit a warning that we're going to turn this into an error soon.
1410 nightly_options::check_nightly_options(&matches, &config::rustc_optgroups());
1412 if matches.opt_present("h") || matches.opt_present("help") {
1413 // Only show unstable options in --help if we *really* accept unstable
1414 // options, which catches the case where we got `-Z unstable-options` on
1415 // the stable channel of Rust which was accidentally allowed
1417 usage(matches.opt_present("verbose"),
1418 nightly_options::is_unstable_enabled(&matches));
1422 // Handle the special case of -Wall.
1423 let wall = matches.opt_strs("W");
1424 if wall.iter().any(|x| *x == "all") {
1429 // Don't handle -W help here, because we might first load plugins.
1430 let r = matches.opt_strs("Z");
1431 if r.iter().any(|x| *x == "help") {
1432 describe_debug_flags();
1436 let cg_flags = matches.opt_strs("C");
1437 if cg_flags.iter().any(|x| *x == "help") {
1438 describe_codegen_flags();
1442 if cg_flags.iter().any(|x| *x == "no-stack-check") {
1443 early_warn(ErrorOutputType::default(),
1444 "the --no-stack-check flag is deprecated and does nothing");
1447 if cg_flags.contains(&"passes=list".to_string()) {
1448 get_trans_sysroot("llvm")().print_passes();
1452 if matches.opt_present("version") {
1453 version("rustc", &matches);
1460 fn parse_crate_attrs<'a>(sess: &'a Session, input: &Input) -> PResult<'a, Vec<ast::Attribute>> {
1462 Input::File(ref ifile) => {
1463 parse::parse_crate_attrs_from_file(ifile, &sess.parse_sess)
1465 Input::Str { ref name, ref input } => {
1466 parse::parse_crate_attrs_from_source_str(name.clone(),
1473 /// Runs `f` in a suitable thread for running `rustc`; returns a
1474 /// `Result` with either the return value of `f` or -- if a panic
1475 /// occurs -- the panic value.
1476 pub fn in_rustc_thread<F, R>(f: F) -> Result<R, Box<Any + Send>>
1477 where F: FnOnce() -> R + Send + 'static,
1480 // Temporarily have stack size set to 16MB to deal with nom-using crates failing
1481 const STACK_SIZE: usize = 16 * 1024 * 1024; // 16MB
1484 let spawn_thread = unsafe {
1485 // Fetch the current resource limits
1486 let mut rlim = libc::rlimit {
1490 if libc::getrlimit(libc::RLIMIT_STACK, &mut rlim) != 0 {
1491 let err = io::Error::last_os_error();
1492 error!("in_rustc_thread: error calling getrlimit: {}", err);
1494 } else if rlim.rlim_max < STACK_SIZE as libc::rlim_t {
1497 std::rt::deinit_stack_guard();
1498 rlim.rlim_cur = STACK_SIZE as libc::rlim_t;
1499 if libc::setrlimit(libc::RLIMIT_STACK, &mut rlim) != 0 {
1500 let err = io::Error::last_os_error();
1501 error!("in_rustc_thread: error calling setrlimit: {}", err);
1502 std::rt::update_stack_guard();
1505 std::rt::update_stack_guard();
1511 // We set the stack size at link time. See src/rustc/rustc.rs.
1513 let spawn_thread = false;
1515 #[cfg(not(any(windows,unix)))]
1516 let spawn_thread = true;
1518 // The or condition is added from backward compatibility.
1519 if spawn_thread || env::var_os("RUST_MIN_STACK").is_some() {
1520 let mut cfg = thread::Builder::new().name("rustc".to_string());
1522 // FIXME: Hacks on hacks. If the env is trying to override the stack size
1523 // then *don't* set it explicitly.
1524 if env::var_os("RUST_MIN_STACK").is_none() {
1525 cfg = cfg.stack_size(STACK_SIZE);
1528 let thread = cfg.spawn(f);
1529 thread.unwrap().join()
1535 /// Get a list of extra command-line flags provided by the user, as strings.
1537 /// This function is used during ICEs to show more information useful for
1538 /// debugging, since some ICEs only happens with non-default compiler flags
1539 /// (and the users don't always report them).
1540 fn extra_compiler_flags() -> Option<(Vec<String>, bool)> {
1541 let mut args = Vec::new();
1542 for arg in env::args_os() {
1543 args.push(arg.to_string_lossy().to_string());
1546 // Avoid printing help because of empty args. This can suggest the compiler
1547 // itself is not the program root (consider RLS).
1552 let matches = if let Some(matches) = handle_options(&args) {
1558 let mut result = Vec::new();
1559 let mut excluded_cargo_defaults = false;
1560 for flag in ICE_REPORT_COMPILER_FLAGS {
1561 let prefix = if flag.len() == 1 { "-" } else { "--" };
1563 for content in &matches.opt_strs(flag) {
1564 // Split always returns the first element
1565 let name = if let Some(first) = content.split('=').next() {
1571 let content = if ICE_REPORT_COMPILER_FLAGS_STRIP_VALUE.contains(&name) {
1577 if !ICE_REPORT_COMPILER_FLAGS_EXCLUDE.contains(&name) {
1578 result.push(format!("{}{} {}", prefix, flag, content));
1580 excluded_cargo_defaults = true;
1585 if result.len() > 0 {
1586 Some((result, excluded_cargo_defaults))
1592 /// Run a procedure which will detect panics in the compiler and print nicer
1593 /// error messages rather than just failing the test.
1595 /// The diagnostic emitter yielded to the procedure should be used for reporting
1596 /// errors of the compiler.
1597 pub fn monitor<F: FnOnce() + Send + 'static>(f: F) {
1598 let result = in_rustc_thread(move || {
1602 if let Err(value) = result {
1603 // Thread panicked without emitting a fatal diagnostic
1604 if !value.is::<errors::FatalErrorMarker>() {
1609 Box::new(errors::emitter::EmitterWriter::stderr(errors::ColorConfig::Auto,
1613 let handler = errors::Handler::with_emitter(true, false, emitter);
1615 // a .span_bug or .bug call has already printed what
1616 // it wants to print.
1617 if !value.is::<errors::ExplicitBug>() {
1618 handler.emit(&MultiSpan::new(),
1620 errors::Level::Bug);
1624 "the compiler unexpectedly panicked. this is a bug.".to_string(),
1625 format!("we would appreciate a bug report: {}", BUG_REPORT_URL),
1626 format!("rustc {} running on {}",
1627 option_env!("CFG_VERSION").unwrap_or("unknown_version"),
1628 config::host_triple()),
1631 if let Some((flags, excluded_cargo_defaults)) = extra_compiler_flags() {
1632 xs.push(format!("compiler flags: {}", flags.join(" ")));
1634 if excluded_cargo_defaults {
1635 xs.push("some of the compiler flags provided by cargo are hidden".to_string());
1640 handler.emit(&MultiSpan::new(),
1642 errors::Level::Note);
1646 panic::resume_unwind(Box::new(errors::FatalErrorMarker));
1650 pub fn diagnostics_registry() -> errors::registry::Registry {
1651 use errors::registry::Registry;
1653 let mut all_errors = Vec::new();
1654 all_errors.extend_from_slice(&rustc::DIAGNOSTICS);
1655 all_errors.extend_from_slice(&rustc_typeck::DIAGNOSTICS);
1656 all_errors.extend_from_slice(&rustc_resolve::DIAGNOSTICS);
1657 all_errors.extend_from_slice(&rustc_privacy::DIAGNOSTICS);
1658 // FIXME: need to figure out a way to get these back in here
1659 // all_errors.extend_from_slice(get_trans(sess).diagnostics());
1660 all_errors.extend_from_slice(&rustc_trans_utils::DIAGNOSTICS);
1661 all_errors.extend_from_slice(&rustc_metadata::DIAGNOSTICS);
1662 all_errors.extend_from_slice(&rustc_passes::DIAGNOSTICS);
1663 all_errors.extend_from_slice(&rustc_plugin::DIAGNOSTICS);
1664 all_errors.extend_from_slice(&rustc_mir::DIAGNOSTICS);
1665 all_errors.extend_from_slice(&syntax::DIAGNOSTICS);
1667 Registry::new(&all_errors)
1670 /// This allows tools to enable rust logging without having to magically match rustc's
1671 /// log crate version
1672 pub fn init_rustc_env_logger() {
1677 init_rustc_env_logger();
1678 let result = run(|| {
1679 let args = env::args_os().enumerate()
1680 .map(|(i, arg)| arg.into_string().unwrap_or_else(|arg| {
1681 early_error(ErrorOutputType::default(),
1682 &format!("Argument {} is not valid Unicode: {:?}", i, arg))
1684 .collect::<Vec<_>>();
1686 &mut RustcDefaultCalls,
1690 process::exit(result as i32);