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 #![crate_name = "rustc_driver"]
18 #![crate_type = "dylib"]
19 #![crate_type = "rlib"]
20 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
21 html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
22 html_root_url = "https://doc.rust-lang.org/nightly/")]
25 #![feature(box_syntax)]
28 #![feature(rustc_diagnostic_macros)]
29 #![feature(set_stdio)]
33 extern crate graphviz;
34 extern crate env_logger;
37 extern crate rustc_allocator;
38 extern crate rustc_back;
39 extern crate rustc_borrowck;
40 extern crate rustc_const_eval;
41 extern crate rustc_data_structures;
42 extern crate rustc_errors as errors;
43 extern crate rustc_passes;
44 extern crate rustc_lint;
45 extern crate rustc_plugin;
46 extern crate rustc_privacy;
47 extern crate rustc_incremental;
48 extern crate rustc_metadata;
49 extern crate rustc_mir;
50 extern crate rustc_resolve;
51 extern crate rustc_save_analysis;
52 extern crate rustc_trans;
53 extern crate rustc_typeck;
54 extern crate serialize;
58 extern crate syntax_ext;
59 extern crate syntax_pos;
61 use driver::CompileController;
62 use pretty::{PpMode, UserIdentifiedItem};
64 use rustc_resolve as resolve;
65 use rustc_save_analysis as save;
66 use rustc_save_analysis::DumpHandler;
67 use rustc_trans::back::link;
68 use rustc_trans::back::write::{RELOC_MODEL_ARGS, CODE_GEN_MODEL_ARGS};
69 use rustc::dep_graph::DepGraph;
70 use rustc::session::{self, config, Session, build_session, CompileResult};
71 use rustc::session::CompileIncomplete;
72 use rustc::session::config::{Input, PrintRequest, OutputType, ErrorOutputType};
73 use rustc::session::config::nightly_options;
74 use rustc::session::{early_error, early_warn};
75 use rustc::lint::Lint;
77 use rustc_metadata::locator;
78 use rustc_metadata::cstore::CStore;
79 use rustc::util::common::{time, ErrorReported};
81 use serialize::json::ToJson;
85 use std::cmp::Ordering::Equal;
86 use std::default::Default;
88 use std::ffi::OsString;
89 use std::io::{self, Read, Write};
90 use std::iter::repeat;
91 use std::path::PathBuf;
92 use std::process::{self, Command, Stdio};
95 use std::sync::{Arc, Mutex};
99 use syntax::codemap::{CodeMap, FileLoader, RealFileLoader};
100 use syntax::feature_gate::{GatedCfg, UnstableFeatures};
101 use syntax::parse::{self, PResult};
102 use syntax_pos::{DUMMY_SP, MultiSpan};
109 pub mod target_features;
110 mod derive_registrar;
112 const BUG_REPORT_URL: &'static str = "https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.\
115 pub fn abort_on_err<T>(result: Result<T, CompileIncomplete>, sess: &Session) -> T {
117 Err(CompileIncomplete::Errored(ErrorReported)) => {
118 sess.abort_if_errors();
119 panic!("error reported but abort_if_errors didn't abort???");
121 Err(CompileIncomplete::Stopped) => {
122 sess.fatal("compilation terminated");
128 pub fn run<F>(run_compiler: F) -> isize
129 where F: FnOnce() -> (CompileResult, Option<Session>) + Send + 'static
132 let (result, session) = run_compiler();
133 if let Err(CompileIncomplete::Errored(_)) = result {
136 sess.abort_if_errors();
137 panic!("error reported but abort_if_errors didn't abort???");
141 errors::emitter::EmitterWriter::stderr(errors::ColorConfig::Auto, None);
142 let handler = errors::Handler::with_emitter(true, false, Box::new(emitter));
143 handler.emit(&MultiSpan::new(),
144 "aborting due to previous error(s)",
145 errors::Level::Fatal);
154 // Parse args and run the compiler. This is the primary entry point for rustc.
155 // See comments on CompilerCalls below for details about the callbacks argument.
156 // The FileLoader provides a way to load files from sources other than the file system.
157 pub fn run_compiler<'a>(args: &[String],
158 callbacks: &mut CompilerCalls<'a>,
159 file_loader: Option<Box<FileLoader + 'static>>,
160 emitter_dest: Option<Box<Write + Send>>)
161 -> (CompileResult, Option<Session>)
163 macro_rules! do_or_return {($expr: expr, $sess: expr) => {
165 Compilation::Stop => return (Ok(()), $sess),
166 Compilation::Continue => {}
170 let matches = match handle_options(args) {
171 Some(matches) => matches,
172 None => return (Ok(()), None),
175 let (sopts, cfg) = config::build_session_options_and_crate_config(&matches);
177 if sopts.debugging_opts.debug_llvm {
178 rustc_trans::enable_llvm_debug();
181 let descriptions = diagnostics_registry();
183 do_or_return!(callbacks.early_callback(&matches,
190 let (odir, ofile) = make_output(&matches);
191 let (input, input_file_path) = match make_input(&matches.free) {
192 Some((input, input_file_path)) => callbacks.some_input(input, input_file_path),
193 None => match callbacks.no_input(&matches, &sopts, &cfg, &odir, &ofile, &descriptions) {
194 Some((input, input_file_path)) => (input, input_file_path),
195 None => return (Ok(()), None),
199 let dep_graph = DepGraph::new(sopts.build_dep_graph());
200 let cstore = Rc::new(CStore::new(&dep_graph, box rustc_trans::LlvmMetadataLoader));
202 let loader = file_loader.unwrap_or(box RealFileLoader);
203 let codemap = Rc::new(CodeMap::with_file_loader(loader, sopts.file_path_mapping()));
204 let mut sess = session::build_session_with_codemap(
205 sopts, &dep_graph, input_file_path, descriptions, cstore.clone(), codemap, emitter_dest,
207 rustc_trans::init(&sess);
208 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
210 let mut cfg = config::build_configuration(&sess, cfg);
211 target_features::add_configuration(&mut cfg, &sess);
212 sess.parse_sess.config = cfg;
214 do_or_return!(callbacks.late_callback(&matches, &sess, &input, &odir, &ofile), Some(sess));
216 let plugins = sess.opts.debugging_opts.extra_plugins.clone();
217 let control = callbacks.build_controller(&sess, &matches);
218 (driver::compile_input(&sess, &cstore, &input, &odir, &ofile, Some(plugins), &control),
222 // Extract output directory and file from matches.
223 fn make_output(matches: &getopts::Matches) -> (Option<PathBuf>, Option<PathBuf>) {
224 let odir = matches.opt_str("out-dir").map(|o| PathBuf::from(&o));
225 let ofile = matches.opt_str("o").map(|o| PathBuf::from(&o));
229 // Extract input (string or file and optional path) from matches.
230 fn make_input(free_matches: &[String]) -> Option<(Input, Option<PathBuf>)> {
231 if free_matches.len() == 1 {
232 let ifile = &free_matches[0];
234 let mut src = String::new();
235 io::stdin().read_to_string(&mut src).unwrap();
236 Some((Input::Str { name: driver::anon_src(), input: src },
239 Some((Input::File(PathBuf::from(ifile)),
240 Some(PathBuf::from(ifile))))
247 fn parse_pretty(sess: &Session,
248 matches: &getopts::Matches)
249 -> Option<(PpMode, Option<UserIdentifiedItem>)> {
250 let pretty = if sess.opts.debugging_opts.unstable_options {
251 matches.opt_default("pretty", "normal").map(|a| {
252 // stable pretty-print variants only
253 pretty::parse_pretty(sess, &a, false)
258 if pretty.is_none() && sess.unstable_options() {
259 matches.opt_str("unpretty").map(|a| {
260 // extended with unstable pretty-print variants
261 pretty::parse_pretty(sess, &a, true)
268 // Whether to stop or continue compilation.
269 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
270 pub enum Compilation {
276 pub fn and_then<F: FnOnce() -> Compilation>(self, next: F) -> Compilation {
278 Compilation::Stop => Compilation::Stop,
279 Compilation::Continue => next(),
284 // A trait for customising the compilation process. Offers a number of hooks for
285 // executing custom code or customising input.
286 pub trait CompilerCalls<'a> {
287 // Hook for a callback early in the process of handling arguments. This will
288 // be called straight after options have been parsed but before anything
289 // else (e.g., selecting input and output).
290 fn early_callback(&mut self,
291 _: &getopts::Matches,
293 _: &ast::CrateConfig,
294 _: &errors::registry::Registry,
297 Compilation::Continue
300 // Hook for a callback late in the process of handling arguments. This will
301 // be called just before actual compilation starts (and before build_controller
302 // is called), after all arguments etc. have been completely handled.
303 fn late_callback(&mut self,
304 _: &getopts::Matches,
310 Compilation::Continue
313 // Called after we extract the input from the arguments. Gives the implementer
314 // an opportunity to change the inputs or to add some custom input handling.
315 // The default behaviour is to simply pass through the inputs.
316 fn some_input(&mut self,
318 input_path: Option<PathBuf>)
319 -> (Input, Option<PathBuf>) {
323 // Called after we extract the input from the arguments if there is no valid
324 // input. Gives the implementer an opportunity to supply alternate input (by
325 // returning a Some value) or to add custom behaviour for this error such as
326 // emitting error messages. Returning None will cause compilation to stop
328 fn no_input(&mut self,
329 _: &getopts::Matches,
331 _: &ast::CrateConfig,
334 _: &errors::registry::Registry)
335 -> Option<(Input, Option<PathBuf>)> {
339 // Create a CompilController struct for controlling the behaviour of
341 fn build_controller(&mut self, _: &Session, _: &getopts::Matches) -> CompileController<'a>;
344 // CompilerCalls instance for a regular rustc build.
345 #[derive(Copy, Clone)]
346 pub struct RustcDefaultCalls;
348 // FIXME remove these and use winapi 0.3 instead
349 // Duplicates: bootstrap/compile.rs, librustc_errors/emitter.rs
351 fn stdout_isatty() -> bool {
352 unsafe { libc::isatty(libc::STDOUT_FILENO) != 0 }
356 fn stdout_isatty() -> bool {
359 type HANDLE = *mut u8;
360 type LPDWORD = *mut u32;
361 const STD_OUTPUT_HANDLE: DWORD = -11i32 as DWORD;
363 fn GetStdHandle(which: DWORD) -> HANDLE;
364 fn GetConsoleMode(hConsoleHandle: HANDLE, lpMode: LPDWORD) -> BOOL;
367 let handle = GetStdHandle(STD_OUTPUT_HANDLE);
369 GetConsoleMode(handle, &mut out) != 0
373 fn handle_explain(code: &str,
374 descriptions: &errors::registry::Registry,
375 output: ErrorOutputType) {
376 let normalised = if code.starts_with("E") {
379 format!("E{0:0>4}", code)
381 match descriptions.find_description(&normalised) {
382 Some(ref description) => {
383 let mut is_in_code_block = false;
384 let mut text = String::new();
386 // Slice off the leading newline and print.
387 for line in description[1..].lines() {
388 let indent_level = line.find(|c: char| !c.is_whitespace())
389 .unwrap_or_else(|| line.len());
390 let dedented_line = &line[indent_level..];
391 if dedented_line.starts_with("```") {
392 is_in_code_block = !is_in_code_block;
393 text.push_str(&line[..(indent_level+3)]);
394 } else if is_in_code_block && dedented_line.starts_with("# ") {
403 show_content_with_pager(&text);
409 early_error(output, &format!("no extended information for {}", code));
414 fn show_content_with_pager(content: &String) {
415 let pager_name = env::var_os("PAGER").unwrap_or_else(|| if cfg!(windows) {
416 OsString::from("more.com")
418 OsString::from("less")
421 let mut fallback_to_println = false;
423 match Command::new(pager_name).stdin(Stdio::piped()).spawn() {
425 if let Some(mut pipe) = pager.stdin.as_mut() {
426 if pipe.write_all(content.as_bytes()).is_err() {
427 fallback_to_println = true;
431 if pager.wait().is_err() {
432 fallback_to_println = true;
436 fallback_to_println = true;
440 // If pager fails for whatever reason, we should still print the content
441 // to standard output
442 if fallback_to_println {
443 print!("{}", content);
447 impl<'a> CompilerCalls<'a> for RustcDefaultCalls {
448 fn early_callback(&mut self,
449 matches: &getopts::Matches,
451 _: &ast::CrateConfig,
452 descriptions: &errors::registry::Registry,
453 output: ErrorOutputType)
455 if let Some(ref code) = matches.opt_str("explain") {
456 handle_explain(code, descriptions, output);
457 return Compilation::Stop;
460 Compilation::Continue
463 fn no_input(&mut self,
464 matches: &getopts::Matches,
465 sopts: &config::Options,
466 cfg: &ast::CrateConfig,
467 odir: &Option<PathBuf>,
468 ofile: &Option<PathBuf>,
469 descriptions: &errors::registry::Registry)
470 -> Option<(Input, Option<PathBuf>)> {
471 match matches.free.len() {
473 if sopts.describe_lints {
474 let mut ls = lint::LintStore::new();
475 rustc_lint::register_builtins(&mut ls, None);
476 describe_lints(&ls, false);
479 let dep_graph = DepGraph::new(sopts.build_dep_graph());
480 let cstore = Rc::new(CStore::new(&dep_graph, box rustc_trans::LlvmMetadataLoader));
481 let mut sess = build_session(sopts.clone(),
484 descriptions.clone(),
486 rustc_trans::init(&sess);
487 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
488 let mut cfg = config::build_configuration(&sess, cfg.clone());
489 target_features::add_configuration(&mut cfg, &sess);
490 sess.parse_sess.config = cfg;
492 RustcDefaultCalls::print_crate_info(&sess, None, odir, ofile);
494 if should_stop == Compilation::Stop {
497 early_error(sopts.error_format, "no input filename given");
499 1 => panic!("make_input should have provided valid inputs"),
500 _ => early_error(sopts.error_format, "multiple input filenames provided"),
504 fn late_callback(&mut self,
505 matches: &getopts::Matches,
508 odir: &Option<PathBuf>,
509 ofile: &Option<PathBuf>)
511 RustcDefaultCalls::print_crate_info(sess, Some(input), odir, ofile)
512 .and_then(|| RustcDefaultCalls::list_metadata(sess, matches, input))
515 fn build_controller(&mut self,
517 matches: &getopts::Matches)
518 -> CompileController<'a> {
519 let mut control = CompileController::basic();
521 control.keep_ast = sess.opts.debugging_opts.keep_ast || save_analysis(sess);
523 if let Some((ppm, opt_uii)) = parse_pretty(sess, matches) {
524 if ppm.needs_ast_map(&opt_uii) {
525 control.after_hir_lowering.stop = Compilation::Stop;
527 control.after_parse.callback = box move |state| {
528 state.krate = Some(pretty::fold_crate(state.krate.take().unwrap(), ppm));
530 control.after_hir_lowering.callback = box move |state| {
531 pretty::print_after_hir_lowering(state.session,
532 state.hir_map.unwrap(),
533 state.analysis.unwrap(),
534 state.resolutions.unwrap(),
536 &state.expanded_crate.take().unwrap(),
537 state.crate_name.unwrap(),
539 state.arena.unwrap(),
540 state.arenas.unwrap(),
545 control.after_parse.stop = Compilation::Stop;
547 control.after_parse.callback = box move |state| {
548 let krate = pretty::fold_crate(state.krate.take().unwrap(), ppm);
549 pretty::print_after_parsing(state.session,
560 if sess.opts.debugging_opts.parse_only ||
561 sess.opts.debugging_opts.show_span.is_some() ||
562 sess.opts.debugging_opts.ast_json_noexpand {
563 control.after_parse.stop = Compilation::Stop;
566 if sess.opts.debugging_opts.no_analysis ||
567 sess.opts.debugging_opts.ast_json {
568 control.after_hir_lowering.stop = Compilation::Stop;
571 if !sess.opts.output_types.keys().any(|&i| i == OutputType::Exe ||
572 i == OutputType::Metadata) {
573 control.after_llvm.stop = Compilation::Stop;
576 if save_analysis(sess) {
577 control.after_analysis.callback = box |state| {
578 time(state.session.time_passes(), "save analysis", || {
579 save::process_crate(state.tcx.unwrap(),
580 state.expanded_crate.unwrap(),
581 state.analysis.unwrap(),
582 state.crate_name.unwrap(),
584 DumpHandler::new(state.out_dir,
585 state.crate_name.unwrap()))
588 control.after_analysis.run_callback_on_error = true;
589 control.make_glob_map = resolve::MakeGlobMap::Yes;
592 if sess.print_fuel_crate.is_some() {
593 let old_callback = control.compilation_done.callback;
594 control.compilation_done.callback = box move |state| {
596 let sess = state.session;
597 println!("Fuel used by {}: {}",
598 sess.print_fuel_crate.as_ref().unwrap(),
599 sess.print_fuel.get());
606 fn save_analysis(sess: &Session) -> bool {
607 sess.opts.debugging_opts.save_analysis
610 impl RustcDefaultCalls {
611 pub fn list_metadata(sess: &Session, matches: &getopts::Matches, input: &Input) -> Compilation {
612 let r = matches.opt_strs("Z");
613 if r.contains(&("ls".to_string())) {
615 &Input::File(ref ifile) => {
616 let path = &(*ifile);
617 let mut v = Vec::new();
618 locator::list_file_metadata(&sess.target.target,
620 sess.cstore.metadata_loader(),
623 println!("{}", String::from_utf8(v).unwrap());
625 &Input::Str { .. } => {
626 early_error(ErrorOutputType::default(), "cannot list metadata for stdin");
629 return Compilation::Stop;
632 return Compilation::Continue;
636 fn print_crate_info(sess: &Session,
637 input: Option<&Input>,
638 odir: &Option<PathBuf>,
639 ofile: &Option<PathBuf>)
641 if sess.opts.prints.is_empty() {
642 return Compilation::Continue;
645 let attrs = match input {
648 let result = parse_crate_attrs(sess, input);
650 Ok(attrs) => Some(attrs),
651 Err(mut parse_error) => {
653 return Compilation::Stop;
658 for req in &sess.opts.prints {
660 PrintRequest::TargetList => {
661 let mut targets = rustc_back::target::get_targets().collect::<Vec<String>>();
663 println!("{}", targets.join("\n"));
665 PrintRequest::Sysroot => println!("{}", sess.sysroot().display()),
666 PrintRequest::TargetSpec => println!("{}", sess.target.target.to_json().pretty()),
667 PrintRequest::FileNames |
668 PrintRequest::CrateName => {
669 let input = match input {
670 Some(input) => input,
671 None => early_error(ErrorOutputType::default(), "no input file provided"),
673 let attrs = attrs.as_ref().unwrap();
674 let t_outputs = driver::build_output_filenames(input, odir, ofile, attrs, sess);
675 let id = link::find_crate_name(Some(sess), attrs, input);
676 if *req == PrintRequest::CrateName {
680 let crate_types = driver::collect_crate_types(sess, attrs);
681 for &style in &crate_types {
682 let fname = link::filename_for_input(sess, style, &id, &t_outputs);
689 PrintRequest::Cfg => {
690 let allow_unstable_cfg = UnstableFeatures::from_environment()
693 let mut cfgs = Vec::new();
694 for &(name, ref value) in sess.parse_sess.config.iter() {
695 let gated_cfg = GatedCfg::gate(&ast::MetaItem {
697 node: ast::MetaItemKind::Word,
701 // Note that crt-static is a specially recognized cfg
702 // directive that's printed out here as part of
703 // rust-lang/rust#37406, but in general the
704 // `target_feature` cfg is gated under
705 // rust-lang/rust#29717. For now this is just
706 // specifically allowing the crt-static cfg and that's
707 // it, this is intended to get into Cargo and then go
708 // through to build scripts.
709 let value = value.as_ref().map(|s| s.as_str());
710 let value = value.as_ref().map(|s| s.as_ref());
711 if name != "target_feature" || value != Some("crt-static") {
712 if !allow_unstable_cfg && gated_cfg.is_some() {
717 cfgs.push(if let Some(value) = value {
718 format!("{}=\"{}\"", name, value)
729 PrintRequest::RelocationModels => {
730 println!("Available relocation models:");
731 for &(name, _) in RELOC_MODEL_ARGS.iter() {
732 println!(" {}", name);
736 PrintRequest::CodeModels => {
737 println!("Available code models:");
738 for &(name, _) in CODE_GEN_MODEL_ARGS.iter(){
739 println!(" {}", name);
743 PrintRequest::TargetCPUs | PrintRequest::TargetFeatures => {
744 rustc_trans::print(*req, sess);
748 return Compilation::Stop;
752 /// Returns a version string such as "0.12.0-dev".
753 pub fn release_str() -> Option<&'static str> {
754 option_env!("CFG_RELEASE")
757 /// Returns the full SHA1 hash of HEAD of the Git repo from which rustc was built.
758 pub fn commit_hash_str() -> Option<&'static str> {
759 option_env!("CFG_VER_HASH")
762 /// Returns the "commit date" of HEAD of the Git repo from which rustc was built as a static string.
763 pub fn commit_date_str() -> Option<&'static str> {
764 option_env!("CFG_VER_DATE")
767 /// Prints version information
768 pub fn version(binary: &str, matches: &getopts::Matches) {
769 let verbose = matches.opt_present("verbose");
773 option_env!("CFG_VERSION").unwrap_or("unknown version"));
775 fn unw(x: Option<&str>) -> &str {
776 x.unwrap_or("unknown")
778 println!("binary: {}", binary);
779 println!("commit-hash: {}", unw(commit_hash_str()));
780 println!("commit-date: {}", unw(commit_date_str()));
781 println!("host: {}", config::host_triple());
782 println!("release: {}", unw(release_str()));
783 rustc_trans::print_version();
787 fn usage(verbose: bool, include_unstable_options: bool) {
788 let groups = if verbose {
789 config::rustc_optgroups()
791 config::rustc_short_optgroups()
793 let mut options = getopts::Options::new();
794 for option in groups.iter().filter(|x| include_unstable_options || x.is_stable()) {
795 (option.apply)(&mut options);
797 let message = format!("Usage: rustc [OPTIONS] INPUT");
798 let nightly_help = if nightly_options::is_nightly_build() {
799 "\n -Z help Print internal options for debugging rustc"
803 let verbose_help = if verbose {
806 "\n --help -v Print the full set of options rustc accepts"
808 println!("{}\nAdditional help:
809 -C help Print codegen options
811 Print 'lint' options and default settings{}{}\n",
812 options.usage(&message),
817 fn describe_lints(lint_store: &lint::LintStore, loaded_plugins: bool) {
819 Available lint options:
820 -W <foo> Warn about <foo>
824 -F <foo> Forbid <foo> \
825 (deny <foo> and all attempts to override)
829 fn sort_lints(lints: Vec<(&'static Lint, bool)>) -> Vec<&'static Lint> {
830 let mut lints: Vec<_> = lints.into_iter().map(|(x, _)| x).collect();
831 lints.sort_by(|x: &&Lint, y: &&Lint| {
832 match x.default_level.cmp(&y.default_level) {
833 // The sort doesn't case-fold but it's doubtful we care.
834 Equal => x.name.cmp(y.name),
841 fn sort_lint_groups(lints: Vec<(&'static str, Vec<lint::LintId>, bool)>)
842 -> Vec<(&'static str, Vec<lint::LintId>)> {
843 let mut lints: Vec<_> = lints.into_iter().map(|(x, y, _)| (x, y)).collect();
844 lints.sort_by(|&(x, _): &(&'static str, Vec<lint::LintId>),
845 &(y, _): &(&'static str, Vec<lint::LintId>)| {
851 let (plugin, builtin): (Vec<_>, _) = lint_store.get_lints()
854 .partition(|&(_, p)| p);
855 let plugin = sort_lints(plugin);
856 let builtin = sort_lints(builtin);
858 let (plugin_groups, builtin_groups): (Vec<_>, _) = lint_store.get_lint_groups()
861 .partition(|&(.., p)| p);
862 let plugin_groups = sort_lint_groups(plugin_groups);
863 let builtin_groups = sort_lint_groups(builtin_groups);
865 let max_name_len = plugin.iter()
867 .map(|&s| s.name.chars().count())
870 let padded = |x: &str| {
871 let mut s = repeat(" ")
872 .take(max_name_len - x.chars().count())
873 .collect::<String>();
878 println!("Lint checks provided by rustc:\n");
879 println!(" {} {:7.7} {}", padded("name"), "default", "meaning");
880 println!(" {} {:7.7} {}", padded("----"), "-------", "-------");
882 let print_lints = |lints: Vec<&Lint>| {
884 let name = lint.name_lower().replace("_", "-");
885 println!(" {} {:7.7} {}",
887 lint.default_level.as_str(),
893 print_lints(builtin);
897 let max_name_len = max("warnings".len(),
899 .chain(&builtin_groups)
900 .map(|&(s, _)| s.chars().count())
904 let padded = |x: &str| {
905 let mut s = repeat(" ")
906 .take(max_name_len - x.chars().count())
907 .collect::<String>();
912 println!("Lint groups provided by rustc:\n");
913 println!(" {} {}", padded("name"), "sub-lints");
914 println!(" {} {}", padded("----"), "---------");
915 println!(" {} {}", padded("warnings"), "all built-in lints");
917 let print_lint_groups = |lints: Vec<(&'static str, Vec<lint::LintId>)>| {
918 for (name, to) in lints {
919 let name = name.to_lowercase().replace("_", "-");
920 let desc = to.into_iter()
921 .map(|x| x.to_string().replace("_", "-"))
922 .collect::<Vec<String>>()
924 println!(" {} {}", padded(&name), desc);
929 print_lint_groups(builtin_groups);
931 match (loaded_plugins, plugin.len(), plugin_groups.len()) {
932 (false, 0, _) | (false, _, 0) => {
933 println!("Compiler plugins can provide additional lints and lint groups. To see a \
934 listing of these, re-run `rustc -W help` with a crate filename.");
936 (false, ..) => panic!("didn't load lint plugins but got them anyway!"),
937 (true, 0, 0) => println!("This crate does not load any lint plugins or lint groups."),
940 println!("Lint checks provided by plugins loaded by this crate:\n");
944 println!("Lint groups provided by plugins loaded by this crate:\n");
945 print_lint_groups(plugin_groups);
951 fn describe_debug_flags() {
952 println!("\nAvailable debug options:\n");
953 print_flag_list("-Z", config::DB_OPTIONS);
956 fn describe_codegen_flags() {
957 println!("\nAvailable codegen options:\n");
958 print_flag_list("-C", config::CG_OPTIONS);
961 fn print_flag_list<T>(cmdline_opt: &str,
962 flag_list: &[(&'static str, T, Option<&'static str>, &'static str)]) {
963 let max_len = flag_list.iter()
964 .map(|&(name, _, opt_type_desc, _)| {
965 let extra_len = match opt_type_desc {
969 name.chars().count() + extra_len
974 for &(name, _, opt_type_desc, desc) in flag_list {
975 let (width, extra) = match opt_type_desc {
976 Some(..) => (max_len - 4, "=val"),
977 None => (max_len, ""),
979 println!(" {} {:>width$}{} -- {}",
981 name.replace("_", "-"),
988 /// Process command line options. Emits messages as appropriate. If compilation
989 /// should continue, returns a getopts::Matches object parsed from args,
990 /// otherwise returns None.
992 /// The compiler's handling of options is a little complicated as it ties into
993 /// our stability story, and it's even *more* complicated by historical
994 /// accidents. The current intention of each compiler option is to have one of
997 /// 1. An option is stable and can be used everywhere.
998 /// 2. An option is unstable, but was historically allowed on the stable
1000 /// 3. An option is unstable, and can only be used on nightly.
1002 /// Like unstable library and language features, however, unstable options have
1003 /// always required a form of "opt in" to indicate that you're using them. This
1004 /// provides the easy ability to scan a code base to check to see if anything
1005 /// unstable is being used. Currently, this "opt in" is the `-Z` "zed" flag.
1007 /// All options behind `-Z` are considered unstable by default. Other top-level
1008 /// options can also be considered unstable, and they were unlocked through the
1009 /// `-Z unstable-options` flag. Note that `-Z` remains to be the root of
1010 /// instability in both cases, though.
1012 /// So with all that in mind, the comments below have some more detail about the
1013 /// contortions done here to get things to work out correctly.
1014 pub fn handle_options(args: &[String]) -> Option<getopts::Matches> {
1015 // Throw away the first argument, the name of the binary
1016 let args = &args[1..];
1018 if args.is_empty() {
1019 // user did not write `-v` nor `-Z unstable-options`, so do not
1020 // include that extra information.
1021 usage(false, false);
1025 // Parse with *all* options defined in the compiler, we don't worry about
1026 // option stability here we just want to parse as much as possible.
1027 let mut options = getopts::Options::new();
1028 for option in config::rustc_optgroups() {
1029 (option.apply)(&mut options);
1031 let matches = match options.parse(args) {
1033 Err(f) => early_error(ErrorOutputType::default(), &f.to_string()),
1036 // For all options we just parsed, we check a few aspects:
1038 // * If the option is stable, we're all good
1039 // * If the option wasn't passed, we're all good
1040 // * If `-Z unstable-options` wasn't passed (and we're not a -Z option
1041 // ourselves), then we require the `-Z unstable-options` flag to unlock
1042 // this option that was passed.
1043 // * If we're a nightly compiler, then unstable options are now unlocked, so
1044 // we're good to go.
1045 // * Otherwise, if we're a truly unstable option then we generate an error
1046 // (unstable option being used on stable)
1047 // * If we're a historically stable-but-should-be-unstable option then we
1048 // emit a warning that we're going to turn this into an error soon.
1049 nightly_options::check_nightly_options(&matches, &config::rustc_optgroups());
1051 if matches.opt_present("h") || matches.opt_present("help") {
1052 // Only show unstable options in --help if we *really* accept unstable
1053 // options, which catches the case where we got `-Z unstable-options` on
1054 // the stable channel of Rust which was accidentally allowed
1056 usage(matches.opt_present("verbose"),
1057 nightly_options::is_unstable_enabled(&matches));
1061 // Don't handle -W help here, because we might first load plugins.
1062 let r = matches.opt_strs("Z");
1063 if r.iter().any(|x| *x == "help") {
1064 describe_debug_flags();
1068 let cg_flags = matches.opt_strs("C");
1069 if cg_flags.iter().any(|x| *x == "help") {
1070 describe_codegen_flags();
1074 if cg_flags.iter().any(|x| *x == "no-stack-check") {
1075 early_warn(ErrorOutputType::default(),
1076 "the --no-stack-check flag is deprecated and does nothing");
1079 if cg_flags.contains(&"passes=list".to_string()) {
1080 rustc_trans::print_passes();
1084 if matches.opt_present("version") {
1085 version("rustc", &matches);
1092 fn parse_crate_attrs<'a>(sess: &'a Session, input: &Input) -> PResult<'a, Vec<ast::Attribute>> {
1094 Input::File(ref ifile) => {
1095 parse::parse_crate_attrs_from_file(ifile, &sess.parse_sess)
1097 Input::Str { ref name, ref input } => {
1098 parse::parse_crate_attrs_from_source_str(name.clone(), input.clone(), &sess.parse_sess)
1103 /// Runs `f` in a suitable thread for running `rustc`; returns a
1104 /// `Result` with either the return value of `f` or -- if a panic
1105 /// occurs -- the panic value.
1106 pub fn in_rustc_thread<F, R>(f: F) -> Result<R, Box<Any + Send>>
1107 where F: FnOnce() -> R + Send + 'static,
1110 // Temporarily have stack size set to 16MB to deal with nom-using crates failing
1111 const STACK_SIZE: usize = 16 * 1024 * 1024; // 16MB
1113 let mut cfg = thread::Builder::new().name("rustc".to_string());
1115 // FIXME: Hacks on hacks. If the env is trying to override the stack size
1116 // then *don't* set it explicitly.
1117 if env::var_os("RUST_MIN_STACK").is_none() {
1118 cfg = cfg.stack_size(STACK_SIZE);
1121 let thread = cfg.spawn(f);
1122 thread.unwrap().join()
1125 /// Run a procedure which will detect panics in the compiler and print nicer
1126 /// error messages rather than just failing the test.
1128 /// The diagnostic emitter yielded to the procedure should be used for reporting
1129 /// errors of the compiler.
1130 pub fn monitor<F: FnOnce() + Send + 'static>(f: F) {
1131 struct Sink(Arc<Mutex<Vec<u8>>>);
1132 impl Write for Sink {
1133 fn write(&mut self, data: &[u8]) -> io::Result<usize> {
1134 Write::write(&mut *self.0.lock().unwrap(), data)
1136 fn flush(&mut self) -> io::Result<()> {
1141 let data = Arc::new(Mutex::new(Vec::new()));
1142 let err = Sink(data.clone());
1144 let result = in_rustc_thread(move || {
1145 io::set_panic(Some(box err));
1149 if let Err(value) = result {
1150 // Thread panicked without emitting a fatal diagnostic
1151 if !value.is::<errors::FatalError>() {
1153 Box::new(errors::emitter::EmitterWriter::stderr(errors::ColorConfig::Auto, None));
1154 let handler = errors::Handler::with_emitter(true, false, emitter);
1156 // a .span_bug or .bug call has already printed what
1157 // it wants to print.
1158 if !value.is::<errors::ExplicitBug>() {
1159 handler.emit(&MultiSpan::new(),
1161 errors::Level::Bug);
1164 let xs = ["the compiler unexpectedly panicked. this is a bug.".to_string(),
1165 format!("we would appreciate a bug report: {}", BUG_REPORT_URL),
1166 format!("rustc {} running on {}",
1167 option_env!("CFG_VERSION").unwrap_or("unknown_version"),
1168 config::host_triple())];
1170 handler.emit(&MultiSpan::new(),
1172 errors::Level::Note);
1174 if match env::var_os("RUST_BACKTRACE") {
1175 Some(val) => &val != "0",
1178 handler.emit(&MultiSpan::new(),
1179 "run with `RUST_BACKTRACE=1` for a backtrace",
1180 errors::Level::Note);
1183 writeln!(io::stderr(), "{}", str::from_utf8(&data.lock().unwrap()).unwrap()).unwrap();
1190 fn exit_on_err() -> ! {
1191 // Panic so the process returns a failure code, but don't pollute the
1192 // output with some unnecessary panic messages, we've already
1193 // printed everything that we needed to.
1194 io::set_panic(Some(box io::sink()));
1198 pub fn diagnostics_registry() -> errors::registry::Registry {
1199 use errors::registry::Registry;
1201 let mut all_errors = Vec::new();
1202 all_errors.extend_from_slice(&rustc::DIAGNOSTICS);
1203 all_errors.extend_from_slice(&rustc_typeck::DIAGNOSTICS);
1204 all_errors.extend_from_slice(&rustc_borrowck::DIAGNOSTICS);
1205 all_errors.extend_from_slice(&rustc_resolve::DIAGNOSTICS);
1206 all_errors.extend_from_slice(&rustc_privacy::DIAGNOSTICS);
1207 all_errors.extend_from_slice(&rustc_trans::DIAGNOSTICS);
1208 all_errors.extend_from_slice(&rustc_const_eval::DIAGNOSTICS);
1209 all_errors.extend_from_slice(&rustc_metadata::DIAGNOSTICS);
1210 all_errors.extend_from_slice(&rustc_passes::DIAGNOSTICS);
1211 all_errors.extend_from_slice(&rustc_plugin::DIAGNOSTICS);
1212 all_errors.extend_from_slice(&rustc_mir::DIAGNOSTICS);
1213 all_errors.extend_from_slice(&syntax::DIAGNOSTICS);
1215 Registry::new(&all_errors)
1218 fn get_args() -> Vec<String> {
1219 env::args_os().enumerate()
1220 .map(|(i, arg)| arg.into_string().unwrap_or_else(|arg| {
1221 early_error(ErrorOutputType::default(),
1222 &format!("Argument {} is not valid Unicode: {:?}", i, arg))
1228 env_logger::init().unwrap();
1229 let result = run(|| run_compiler(&get_args(),
1230 &mut RustcDefaultCalls,
1233 process::exit(result as i32);