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)]
30 extern crate graphviz;
31 extern crate env_logger;
35 extern crate rustc_allocator;
36 extern crate rustc_back;
37 extern crate rustc_borrowck;
38 extern crate rustc_const_eval;
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 #[cfg(feature="llvm")]
51 extern crate rustc_trans;
52 extern crate rustc_trans_utils;
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::session::{self, config, Session, build_session, CompileResult};
68 use rustc::session::CompileIncomplete;
69 use rustc::session::config::{Input, PrintRequest, OutputType, ErrorOutputType};
70 use rustc::session::config::nightly_options;
71 use rustc::session::{early_error, early_warn};
72 use rustc::lint::Lint;
74 use rustc::middle::cstore::CrateStore;
75 use rustc_metadata::locator;
76 use rustc_metadata::cstore::CStore;
77 use rustc::util::common::{time, ErrorReported};
78 use rustc_trans_utils::trans_crate::TransCrate;
80 use serialize::json::ToJson;
84 use std::cmp::Ordering::Equal;
85 use std::default::Default;
87 use std::ffi::OsString;
88 use std::io::{self, Read, Write};
89 use std::iter::repeat;
90 use std::path::PathBuf;
91 use std::process::{self, Command, Stdio};
94 use std::sync::{Arc, Mutex};
98 use syntax::codemap::{CodeMap, FileLoader, RealFileLoader};
99 use syntax::feature_gate::{GatedCfg, UnstableFeatures};
100 use syntax::parse::{self, PResult};
101 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,
144 let handler = errors::Handler::with_emitter(true, false, Box::new(emitter));
145 handler.emit(&MultiSpan::new(),
146 "aborting due to previous error(s)",
147 errors::Level::Fatal);
156 #[cfg(not(feature="llvm"))]
157 pub use rustc_trans_utils::trans_crate::MetadataOnlyTransCrate as DefaultTransCrate;
158 #[cfg(feature="llvm")]
159 pub use rustc_trans::LlvmTransCrate as DefaultTransCrate;
161 #[cfg(not(feature="llvm"))]
163 use syntax_pos::symbol::Symbol;
164 use rustc::session::Session;
165 use rustc::session::config::PrintRequest;
166 pub use rustc_trans_utils::trans_crate::MetadataOnlyTransCrate as LlvmTransCrate;
167 pub use rustc_trans_utils::trans_crate::TranslatedCrate as CrateTranslation;
169 pub fn init(_sess: &Session) {}
170 pub fn enable_llvm_debug() {}
171 pub fn print_version() {}
172 pub fn print_passes() {}
173 pub fn print(_req: PrintRequest, _sess: &Session) {}
174 pub fn target_features(_sess: &Session) -> Vec<Symbol> { vec![] }
178 pub const RELOC_MODEL_ARGS: [(&'static str, ()); 0] = [];
179 pub const CODE_GEN_MODEL_ARGS: [(&'static str, ()); 0] = [];
180 pub const TLS_MODEL_ARGS: [(&'static str, ()); 0] = [];
185 // Parse args and run the compiler. This is the primary entry point for rustc.
186 // See comments on CompilerCalls below for details about the callbacks argument.
187 // The FileLoader provides a way to load files from sources other than the file system.
188 pub fn run_compiler<'a>(args: &[String],
189 callbacks: &mut CompilerCalls<'a>,
190 file_loader: Option<Box<FileLoader + 'static>>,
191 emitter_dest: Option<Box<Write + Send>>)
192 -> (CompileResult, Option<Session>)
194 macro_rules! do_or_return {($expr: expr, $sess: expr) => {
196 Compilation::Stop => return (Ok(()), $sess),
197 Compilation::Continue => {}
201 let matches = match handle_options(args) {
202 Some(matches) => matches,
203 None => return (Ok(()), None),
206 let (sopts, cfg) = config::build_session_options_and_crate_config(&matches);
208 if sopts.debugging_opts.debug_llvm {
209 rustc_trans::enable_llvm_debug();
212 let descriptions = diagnostics_registry();
214 do_or_return!(callbacks.early_callback(&matches,
221 let (odir, ofile) = make_output(&matches);
222 let (input, input_file_path) = match make_input(&matches.free) {
223 Some((input, input_file_path)) => callbacks.some_input(input, input_file_path),
224 None => match callbacks.no_input(&matches, &sopts, &cfg, &odir, &ofile, &descriptions) {
225 Some((input, input_file_path)) => (input, input_file_path),
226 None => return (Ok(()), None),
230 let cstore = Rc::new(CStore::new(DefaultTransCrate::metadata_loader()));
232 let loader = file_loader.unwrap_or(box RealFileLoader);
233 let codemap = Rc::new(CodeMap::with_file_loader(loader, sopts.file_path_mapping()));
234 let mut sess = session::build_session_with_codemap(
235 sopts, input_file_path, descriptions, codemap, emitter_dest,
237 rustc_trans::init(&sess);
238 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
240 let mut cfg = config::build_configuration(&sess, cfg);
241 target_features::add_configuration(&mut cfg, &sess);
242 sess.parse_sess.config = cfg;
244 do_or_return!(callbacks.late_callback(&matches,
249 &ofile), Some(sess));
251 let plugins = sess.opts.debugging_opts.extra_plugins.clone();
252 let control = callbacks.build_controller(&sess, &matches);
253 (driver::compile_input(&sess,
263 // Extract output directory and file from matches.
264 fn make_output(matches: &getopts::Matches) -> (Option<PathBuf>, Option<PathBuf>) {
265 let odir = matches.opt_str("out-dir").map(|o| PathBuf::from(&o));
266 let ofile = matches.opt_str("o").map(|o| PathBuf::from(&o));
270 // Extract input (string or file and optional path) from matches.
271 fn make_input(free_matches: &[String]) -> Option<(Input, Option<PathBuf>)> {
272 if free_matches.len() == 1 {
273 let ifile = &free_matches[0];
275 let mut src = String::new();
276 io::stdin().read_to_string(&mut src).unwrap();
277 Some((Input::Str { name: driver::anon_src(), input: src },
280 Some((Input::File(PathBuf::from(ifile)),
281 Some(PathBuf::from(ifile))))
288 fn parse_pretty(sess: &Session,
289 matches: &getopts::Matches)
290 -> Option<(PpMode, Option<UserIdentifiedItem>)> {
291 let pretty = if sess.opts.debugging_opts.unstable_options {
292 matches.opt_default("pretty", "normal").map(|a| {
293 // stable pretty-print variants only
294 pretty::parse_pretty(sess, &a, false)
299 if pretty.is_none() && sess.unstable_options() {
300 matches.opt_str("unpretty").map(|a| {
301 // extended with unstable pretty-print variants
302 pretty::parse_pretty(sess, &a, true)
309 // Whether to stop or continue compilation.
310 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
311 pub enum Compilation {
317 pub fn and_then<F: FnOnce() -> Compilation>(self, next: F) -> Compilation {
319 Compilation::Stop => Compilation::Stop,
320 Compilation::Continue => next(),
325 // A trait for customising the compilation process. Offers a number of hooks for
326 // executing custom code or customising input.
327 pub trait CompilerCalls<'a> {
328 // Hook for a callback early in the process of handling arguments. This will
329 // be called straight after options have been parsed but before anything
330 // else (e.g., selecting input and output).
331 fn early_callback(&mut self,
332 _: &getopts::Matches,
334 _: &ast::CrateConfig,
335 _: &errors::registry::Registry,
338 Compilation::Continue
341 // Hook for a callback late in the process of handling arguments. This will
342 // be called just before actual compilation starts (and before build_controller
343 // is called), after all arguments etc. have been completely handled.
344 fn late_callback(&mut self,
345 _: &getopts::Matches,
352 Compilation::Continue
355 // Called after we extract the input from the arguments. Gives the implementer
356 // an opportunity to change the inputs or to add some custom input handling.
357 // The default behaviour is to simply pass through the inputs.
358 fn some_input(&mut self,
360 input_path: Option<PathBuf>)
361 -> (Input, Option<PathBuf>) {
365 // Called after we extract the input from the arguments if there is no valid
366 // input. Gives the implementer an opportunity to supply alternate input (by
367 // returning a Some value) or to add custom behaviour for this error such as
368 // emitting error messages. Returning None will cause compilation to stop
370 fn no_input(&mut self,
371 _: &getopts::Matches,
373 _: &ast::CrateConfig,
376 _: &errors::registry::Registry)
377 -> Option<(Input, Option<PathBuf>)> {
381 // Create a CompilController struct for controlling the behaviour of
383 fn build_controller(&mut self, _: &Session, _: &getopts::Matches) -> CompileController<'a>;
386 // CompilerCalls instance for a regular rustc build.
387 #[derive(Copy, Clone)]
388 pub struct RustcDefaultCalls;
390 // FIXME remove these and use winapi 0.3 instead
391 // Duplicates: bootstrap/compile.rs, librustc_errors/emitter.rs
393 fn stdout_isatty() -> bool {
394 unsafe { libc::isatty(libc::STDOUT_FILENO) != 0 }
398 fn stdout_isatty() -> bool {
401 type HANDLE = *mut u8;
402 type LPDWORD = *mut u32;
403 const STD_OUTPUT_HANDLE: DWORD = -11i32 as DWORD;
405 fn GetStdHandle(which: DWORD) -> HANDLE;
406 fn GetConsoleMode(hConsoleHandle: HANDLE, lpMode: LPDWORD) -> BOOL;
409 let handle = GetStdHandle(STD_OUTPUT_HANDLE);
411 GetConsoleMode(handle, &mut out) != 0
415 fn handle_explain(code: &str,
416 descriptions: &errors::registry::Registry,
417 output: ErrorOutputType) {
418 let normalised = if code.starts_with("E") {
421 format!("E{0:0>4}", code)
423 match descriptions.find_description(&normalised) {
424 Some(ref description) => {
425 let mut is_in_code_block = false;
426 let mut text = String::new();
428 // Slice off the leading newline and print.
429 for line in description[1..].lines() {
430 let indent_level = line.find(|c: char| !c.is_whitespace())
431 .unwrap_or_else(|| line.len());
432 let dedented_line = &line[indent_level..];
433 if dedented_line.starts_with("```") {
434 is_in_code_block = !is_in_code_block;
435 text.push_str(&line[..(indent_level+3)]);
436 } else if is_in_code_block && dedented_line.starts_with("# ") {
445 show_content_with_pager(&text);
451 early_error(output, &format!("no extended information for {}", code));
456 fn show_content_with_pager(content: &String) {
457 let pager_name = env::var_os("PAGER").unwrap_or_else(|| if cfg!(windows) {
458 OsString::from("more.com")
460 OsString::from("less")
463 let mut fallback_to_println = false;
465 match Command::new(pager_name).stdin(Stdio::piped()).spawn() {
467 if let Some(pipe) = pager.stdin.as_mut() {
468 if pipe.write_all(content.as_bytes()).is_err() {
469 fallback_to_println = true;
473 if pager.wait().is_err() {
474 fallback_to_println = true;
478 fallback_to_println = true;
482 // If pager fails for whatever reason, we should still print the content
483 // to standard output
484 if fallback_to_println {
485 print!("{}", content);
489 impl<'a> CompilerCalls<'a> for RustcDefaultCalls {
490 fn early_callback(&mut self,
491 matches: &getopts::Matches,
493 _: &ast::CrateConfig,
494 descriptions: &errors::registry::Registry,
495 output: ErrorOutputType)
497 if let Some(ref code) = matches.opt_str("explain") {
498 handle_explain(code, descriptions, output);
499 return Compilation::Stop;
502 Compilation::Continue
505 fn no_input(&mut self,
506 matches: &getopts::Matches,
507 sopts: &config::Options,
508 cfg: &ast::CrateConfig,
509 odir: &Option<PathBuf>,
510 ofile: &Option<PathBuf>,
511 descriptions: &errors::registry::Registry)
512 -> Option<(Input, Option<PathBuf>)> {
513 match matches.free.len() {
515 if sopts.describe_lints {
516 let mut ls = lint::LintStore::new();
517 rustc_lint::register_builtins(&mut ls, None);
518 describe_lints(&ls, false);
521 let mut sess = build_session(sopts.clone(),
523 descriptions.clone());
524 rustc_trans::init(&sess);
525 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
526 let mut cfg = config::build_configuration(&sess, cfg.clone());
527 target_features::add_configuration(&mut cfg, &sess);
528 sess.parse_sess.config = cfg;
530 RustcDefaultCalls::print_crate_info(&sess, None, odir, ofile);
532 if should_stop == Compilation::Stop {
535 early_error(sopts.error_format, "no input filename given");
537 1 => panic!("make_input should have provided valid inputs"),
538 _ => early_error(sopts.error_format, "multiple input filenames provided"),
542 fn late_callback(&mut self,
543 matches: &getopts::Matches,
547 odir: &Option<PathBuf>,
548 ofile: &Option<PathBuf>)
550 RustcDefaultCalls::print_crate_info(sess, Some(input), odir, ofile)
551 .and_then(|| RustcDefaultCalls::list_metadata(sess, cstore, matches, input))
554 fn build_controller(&mut self,
556 matches: &getopts::Matches)
557 -> CompileController<'a> {
558 let mut control = CompileController::basic();
560 control.keep_ast = sess.opts.debugging_opts.keep_ast;
561 control.continue_parse_after_error = sess.opts.debugging_opts.continue_parse_after_error;
563 if let Some((ppm, opt_uii)) = parse_pretty(sess, matches) {
564 if ppm.needs_ast_map(&opt_uii) {
565 control.after_hir_lowering.stop = Compilation::Stop;
567 control.after_parse.callback = box move |state| {
568 state.krate = Some(pretty::fold_crate(state.krate.take().unwrap(), ppm));
570 control.after_hir_lowering.callback = box move |state| {
571 pretty::print_after_hir_lowering(state.session,
572 state.cstore.unwrap(),
573 state.hir_map.unwrap(),
574 state.analysis.unwrap(),
575 state.resolutions.unwrap(),
577 &state.expanded_crate.take().unwrap(),
578 state.crate_name.unwrap(),
580 state.arena.unwrap(),
581 state.arenas.unwrap(),
582 state.output_filenames.unwrap(),
587 control.after_parse.stop = Compilation::Stop;
589 control.after_parse.callback = box move |state| {
590 let krate = pretty::fold_crate(state.krate.take().unwrap(), ppm);
591 pretty::print_after_parsing(state.session,
602 if sess.opts.debugging_opts.parse_only ||
603 sess.opts.debugging_opts.show_span.is_some() ||
604 sess.opts.debugging_opts.ast_json_noexpand {
605 control.after_parse.stop = Compilation::Stop;
608 if sess.opts.debugging_opts.no_analysis ||
609 sess.opts.debugging_opts.ast_json {
610 control.after_hir_lowering.stop = Compilation::Stop;
613 if !sess.opts.output_types.keys().any(|&i| i == OutputType::Exe ||
614 i == OutputType::Metadata) {
615 control.after_llvm.stop = Compilation::Stop;
618 if save_analysis(sess) {
619 enable_save_analysis(&mut control);
622 if sess.print_fuel_crate.is_some() {
623 let old_callback = control.compilation_done.callback;
624 control.compilation_done.callback = box move |state| {
626 let sess = state.session;
627 println!("Fuel used by {}: {}",
628 sess.print_fuel_crate.as_ref().unwrap(),
629 sess.print_fuel.get());
636 pub fn enable_save_analysis(control: &mut CompileController) {
637 control.keep_ast = true;
638 control.after_analysis.callback = box |state| {
639 time(state.session.time_passes(), "save analysis", || {
640 save::process_crate(state.tcx.unwrap(),
641 state.expanded_crate.unwrap(),
642 state.analysis.unwrap(),
643 state.crate_name.unwrap(),
645 DumpHandler::new(state.out_dir,
646 state.crate_name.unwrap()))
649 control.after_analysis.run_callback_on_error = true;
650 control.make_glob_map = resolve::MakeGlobMap::Yes;
653 fn save_analysis(sess: &Session) -> bool {
654 sess.opts.debugging_opts.save_analysis
657 impl RustcDefaultCalls {
658 pub fn list_metadata(sess: &Session,
660 matches: &getopts::Matches,
663 let r = matches.opt_strs("Z");
664 if r.contains(&("ls".to_string())) {
666 &Input::File(ref ifile) => {
667 let path = &(*ifile);
668 let mut v = Vec::new();
669 locator::list_file_metadata(&sess.target.target,
671 cstore.metadata_loader(),
674 println!("{}", String::from_utf8(v).unwrap());
676 &Input::Str { .. } => {
677 early_error(ErrorOutputType::default(), "cannot list metadata for stdin");
680 return Compilation::Stop;
683 return Compilation::Continue;
687 fn print_crate_info(sess: &Session,
688 input: Option<&Input>,
689 odir: &Option<PathBuf>,
690 ofile: &Option<PathBuf>)
692 // PrintRequest::NativeStaticLibs is special - printed during linking
693 // (empty iterator returns true)
694 if sess.opts.prints.iter().all(|&p| p==PrintRequest::NativeStaticLibs) {
695 return Compilation::Continue;
698 let attrs = match input {
701 let result = parse_crate_attrs(sess, input);
703 Ok(attrs) => Some(attrs),
704 Err(mut parse_error) => {
706 return Compilation::Stop;
711 for req in &sess.opts.prints {
713 PrintRequest::TargetList => {
714 let mut targets = rustc_back::target::get_targets().collect::<Vec<String>>();
716 println!("{}", targets.join("\n"));
718 PrintRequest::Sysroot => println!("{}", sess.sysroot().display()),
719 PrintRequest::TargetSpec => println!("{}", sess.target.target.to_json().pretty()),
720 PrintRequest::FileNames |
721 PrintRequest::CrateName => {
722 let input = match input {
723 Some(input) => input,
724 None => early_error(ErrorOutputType::default(), "no input file provided"),
726 let attrs = attrs.as_ref().unwrap();
727 let t_outputs = driver::build_output_filenames(input, odir, ofile, attrs, sess);
728 let id = rustc_trans_utils::link::find_crate_name(Some(sess), attrs, input);
729 if *req == PrintRequest::CrateName {
733 let crate_types = driver::collect_crate_types(sess, attrs);
734 for &style in &crate_types {
735 let fname = rustc_trans_utils::link::filename_for_input(
747 PrintRequest::Cfg => {
748 let allow_unstable_cfg = UnstableFeatures::from_environment()
751 let mut cfgs = Vec::new();
752 for &(name, ref value) in sess.parse_sess.config.iter() {
753 let gated_cfg = GatedCfg::gate(&ast::MetaItem {
755 node: ast::MetaItemKind::Word,
759 // Note that crt-static is a specially recognized cfg
760 // directive that's printed out here as part of
761 // rust-lang/rust#37406, but in general the
762 // `target_feature` cfg is gated under
763 // rust-lang/rust#29717. For now this is just
764 // specifically allowing the crt-static cfg and that's
765 // it, this is intended to get into Cargo and then go
766 // through to build scripts.
767 let value = value.as_ref().map(|s| s.as_str());
768 let value = value.as_ref().map(|s| s.as_ref());
769 if name != "target_feature" || value != Some("crt-static") {
770 if !allow_unstable_cfg && gated_cfg.is_some() {
775 cfgs.push(if let Some(value) = value {
776 format!("{}=\"{}\"", name, value)
787 PrintRequest::RelocationModels => {
788 println!("Available relocation models:");
789 for &(name, _) in rustc_trans::back::write::RELOC_MODEL_ARGS.iter() {
790 println!(" {}", name);
794 PrintRequest::CodeModels => {
795 println!("Available code models:");
796 for &(name, _) in rustc_trans::back::write::CODE_GEN_MODEL_ARGS.iter(){
797 println!(" {}", name);
801 PrintRequest::TlsModels => {
802 println!("Available TLS models:");
803 for &(name, _) in rustc_trans::back::write::TLS_MODEL_ARGS.iter(){
804 println!(" {}", name);
808 PrintRequest::TargetCPUs | PrintRequest::TargetFeatures => {
809 rustc_trans::print(*req, sess);
811 PrintRequest::NativeStaticLibs => {
812 println!("Native static libs can be printed only during linking");
816 return Compilation::Stop;
820 /// Returns a version string such as "0.12.0-dev".
821 fn release_str() -> Option<&'static str> {
822 option_env!("CFG_RELEASE")
825 /// Returns the full SHA1 hash of HEAD of the Git repo from which rustc was built.
826 fn commit_hash_str() -> Option<&'static str> {
827 option_env!("CFG_VER_HASH")
830 /// Returns the "commit date" of HEAD of the Git repo from which rustc was built as a static string.
831 fn commit_date_str() -> Option<&'static str> {
832 option_env!("CFG_VER_DATE")
835 /// Prints version information
836 pub fn version(binary: &str, matches: &getopts::Matches) {
837 let verbose = matches.opt_present("verbose");
841 option_env!("CFG_VERSION").unwrap_or("unknown version"));
843 fn unw(x: Option<&str>) -> &str {
844 x.unwrap_or("unknown")
846 println!("binary: {}", binary);
847 println!("commit-hash: {}", unw(commit_hash_str()));
848 println!("commit-date: {}", unw(commit_date_str()));
849 println!("host: {}", config::host_triple());
850 println!("release: {}", unw(release_str()));
851 rustc_trans::print_version();
855 fn usage(verbose: bool, include_unstable_options: bool) {
856 let groups = if verbose {
857 config::rustc_optgroups()
859 config::rustc_short_optgroups()
861 let mut options = getopts::Options::new();
862 for option in groups.iter().filter(|x| include_unstable_options || x.is_stable()) {
863 (option.apply)(&mut options);
865 let message = format!("Usage: rustc [OPTIONS] INPUT");
866 let nightly_help = if nightly_options::is_nightly_build() {
867 "\n -Z help Print internal options for debugging rustc"
871 let verbose_help = if verbose {
874 "\n --help -v Print the full set of options rustc accepts"
876 println!("{}\nAdditional help:
877 -C help Print codegen options
879 Print 'lint' options and default settings{}{}\n",
880 options.usage(&message),
885 fn describe_lints(lint_store: &lint::LintStore, loaded_plugins: bool) {
887 Available lint options:
888 -W <foo> Warn about <foo>
892 -F <foo> Forbid <foo> \
893 (deny <foo> and all attempts to override)
897 fn sort_lints(lints: Vec<(&'static Lint, bool)>) -> Vec<&'static Lint> {
898 let mut lints: Vec<_> = lints.into_iter().map(|(x, _)| x).collect();
899 lints.sort_by(|x: &&Lint, y: &&Lint| {
900 match x.default_level.cmp(&y.default_level) {
901 // The sort doesn't case-fold but it's doubtful we care.
902 Equal => x.name.cmp(y.name),
909 fn sort_lint_groups(lints: Vec<(&'static str, Vec<lint::LintId>, bool)>)
910 -> Vec<(&'static str, Vec<lint::LintId>)> {
911 let mut lints: Vec<_> = lints.into_iter().map(|(x, y, _)| (x, y)).collect();
912 lints.sort_by(|&(x, _): &(&'static str, Vec<lint::LintId>),
913 &(y, _): &(&'static str, Vec<lint::LintId>)| {
919 let (plugin, builtin): (Vec<_>, _) = lint_store.get_lints()
922 .partition(|&(_, p)| p);
923 let plugin = sort_lints(plugin);
924 let builtin = sort_lints(builtin);
926 let (plugin_groups, builtin_groups): (Vec<_>, _) = lint_store.get_lint_groups()
929 .partition(|&(.., p)| p);
930 let plugin_groups = sort_lint_groups(plugin_groups);
931 let builtin_groups = sort_lint_groups(builtin_groups);
933 let max_name_len = plugin.iter()
935 .map(|&s| s.name.chars().count())
938 let padded = |x: &str| {
939 let mut s = repeat(" ")
940 .take(max_name_len - x.chars().count())
941 .collect::<String>();
946 println!("Lint checks provided by rustc:\n");
947 println!(" {} {:7.7} {}", padded("name"), "default", "meaning");
948 println!(" {} {:7.7} {}", padded("----"), "-------", "-------");
950 let print_lints = |lints: Vec<&Lint>| {
952 let name = lint.name_lower().replace("_", "-");
953 println!(" {} {:7.7} {}",
955 lint.default_level.as_str(),
961 print_lints(builtin);
965 let max_name_len = max("warnings".len(),
967 .chain(&builtin_groups)
968 .map(|&(s, _)| s.chars().count())
972 let padded = |x: &str| {
973 let mut s = repeat(" ")
974 .take(max_name_len - x.chars().count())
975 .collect::<String>();
980 println!("Lint groups provided by rustc:\n");
981 println!(" {} {}", padded("name"), "sub-lints");
982 println!(" {} {}", padded("----"), "---------");
983 println!(" {} {}", padded("warnings"), "all lints activated to the warning level");
985 let print_lint_groups = |lints: Vec<(&'static str, Vec<lint::LintId>)>| {
986 for (name, to) in lints {
987 let name = name.to_lowercase().replace("_", "-");
988 let desc = to.into_iter()
989 .map(|x| x.to_string().replace("_", "-"))
990 .collect::<Vec<String>>()
992 println!(" {} {}", padded(&name), desc);
997 print_lint_groups(builtin_groups);
999 match (loaded_plugins, plugin.len(), plugin_groups.len()) {
1000 (false, 0, _) | (false, _, 0) => {
1001 println!("Compiler plugins can provide additional lints and lint groups. To see a \
1002 listing of these, re-run `rustc -W help` with a crate filename.");
1004 (false, ..) => panic!("didn't load lint plugins but got them anyway!"),
1005 (true, 0, 0) => println!("This crate does not load any lint plugins or lint groups."),
1008 println!("Lint checks provided by plugins loaded by this crate:\n");
1009 print_lints(plugin);
1012 println!("Lint groups provided by plugins loaded by this crate:\n");
1013 print_lint_groups(plugin_groups);
1019 fn describe_debug_flags() {
1020 println!("\nAvailable debug options:\n");
1021 print_flag_list("-Z", config::DB_OPTIONS);
1024 fn describe_codegen_flags() {
1025 println!("\nAvailable codegen options:\n");
1026 print_flag_list("-C", config::CG_OPTIONS);
1029 fn print_flag_list<T>(cmdline_opt: &str,
1030 flag_list: &[(&'static str, T, Option<&'static str>, &'static str)]) {
1031 let max_len = flag_list.iter()
1032 .map(|&(name, _, opt_type_desc, _)| {
1033 let extra_len = match opt_type_desc {
1037 name.chars().count() + extra_len
1042 for &(name, _, opt_type_desc, desc) in flag_list {
1043 let (width, extra) = match opt_type_desc {
1044 Some(..) => (max_len - 4, "=val"),
1045 None => (max_len, ""),
1047 println!(" {} {:>width$}{} -- {}",
1049 name.replace("_", "-"),
1056 /// Process command line options. Emits messages as appropriate. If compilation
1057 /// should continue, returns a getopts::Matches object parsed from args,
1058 /// otherwise returns None.
1060 /// The compiler's handling of options is a little complicated as it ties into
1061 /// our stability story, and it's even *more* complicated by historical
1062 /// accidents. The current intention of each compiler option is to have one of
1065 /// 1. An option is stable and can be used everywhere.
1066 /// 2. An option is unstable, but was historically allowed on the stable
1068 /// 3. An option is unstable, and can only be used on nightly.
1070 /// Like unstable library and language features, however, unstable options have
1071 /// always required a form of "opt in" to indicate that you're using them. This
1072 /// provides the easy ability to scan a code base to check to see if anything
1073 /// unstable is being used. Currently, this "opt in" is the `-Z` "zed" flag.
1075 /// All options behind `-Z` are considered unstable by default. Other top-level
1076 /// options can also be considered unstable, and they were unlocked through the
1077 /// `-Z unstable-options` flag. Note that `-Z` remains to be the root of
1078 /// instability in both cases, though.
1080 /// So with all that in mind, the comments below have some more detail about the
1081 /// contortions done here to get things to work out correctly.
1082 pub fn handle_options(args: &[String]) -> Option<getopts::Matches> {
1083 // Throw away the first argument, the name of the binary
1084 let args = &args[1..];
1086 if args.is_empty() {
1087 // user did not write `-v` nor `-Z unstable-options`, so do not
1088 // include that extra information.
1089 usage(false, false);
1093 // Parse with *all* options defined in the compiler, we don't worry about
1094 // option stability here we just want to parse as much as possible.
1095 let mut options = getopts::Options::new();
1096 for option in config::rustc_optgroups() {
1097 (option.apply)(&mut options);
1099 let matches = match options.parse(args) {
1101 Err(f) => early_error(ErrorOutputType::default(), &f.to_string()),
1104 // For all options we just parsed, we check a few aspects:
1106 // * If the option is stable, we're all good
1107 // * If the option wasn't passed, we're all good
1108 // * If `-Z unstable-options` wasn't passed (and we're not a -Z option
1109 // ourselves), then we require the `-Z unstable-options` flag to unlock
1110 // this option that was passed.
1111 // * If we're a nightly compiler, then unstable options are now unlocked, so
1112 // we're good to go.
1113 // * Otherwise, if we're a truly unstable option then we generate an error
1114 // (unstable option being used on stable)
1115 // * If we're a historically stable-but-should-be-unstable option then we
1116 // emit a warning that we're going to turn this into an error soon.
1117 nightly_options::check_nightly_options(&matches, &config::rustc_optgroups());
1119 if matches.opt_present("h") || matches.opt_present("help") {
1120 // Only show unstable options in --help if we *really* accept unstable
1121 // options, which catches the case where we got `-Z unstable-options` on
1122 // the stable channel of Rust which was accidentally allowed
1124 usage(matches.opt_present("verbose"),
1125 nightly_options::is_unstable_enabled(&matches));
1129 // Don't handle -W help here, because we might first load plugins.
1130 let r = matches.opt_strs("Z");
1131 if r.iter().any(|x| *x == "help") {
1132 describe_debug_flags();
1136 let cg_flags = matches.opt_strs("C");
1137 if cg_flags.iter().any(|x| *x == "help") {
1138 describe_codegen_flags();
1142 if cg_flags.iter().any(|x| *x == "no-stack-check") {
1143 early_warn(ErrorOutputType::default(),
1144 "the --no-stack-check flag is deprecated and does nothing");
1147 if cg_flags.contains(&"passes=list".to_string()) {
1148 rustc_trans::print_passes();
1152 if matches.opt_present("version") {
1153 version("rustc", &matches);
1160 fn parse_crate_attrs<'a>(sess: &'a Session, input: &Input) -> PResult<'a, Vec<ast::Attribute>> {
1162 Input::File(ref ifile) => {
1163 parse::parse_crate_attrs_from_file(ifile, &sess.parse_sess)
1165 Input::Str { ref name, ref input } => {
1166 parse::parse_crate_attrs_from_source_str(name.clone(), input.clone(), &sess.parse_sess)
1171 /// Runs `f` in a suitable thread for running `rustc`; returns a
1172 /// `Result` with either the return value of `f` or -- if a panic
1173 /// occurs -- the panic value.
1174 pub fn in_rustc_thread<F, R>(f: F) -> Result<R, Box<Any + Send>>
1175 where F: FnOnce() -> R + Send + 'static,
1178 // Temporarily have stack size set to 16MB to deal with nom-using crates failing
1179 const STACK_SIZE: usize = 16 * 1024 * 1024; // 16MB
1181 let mut cfg = thread::Builder::new().name("rustc".to_string());
1183 // FIXME: Hacks on hacks. If the env is trying to override the stack size
1184 // then *don't* set it explicitly.
1185 if env::var_os("RUST_MIN_STACK").is_none() {
1186 cfg = cfg.stack_size(STACK_SIZE);
1189 let thread = cfg.spawn(f);
1190 thread.unwrap().join()
1193 /// Run a procedure which will detect panics in the compiler and print nicer
1194 /// error messages rather than just failing the test.
1196 /// The diagnostic emitter yielded to the procedure should be used for reporting
1197 /// errors of the compiler.
1198 pub fn monitor<F: FnOnce() + Send + 'static>(f: F) {
1199 struct Sink(Arc<Mutex<Vec<u8>>>);
1200 impl Write for Sink {
1201 fn write(&mut self, data: &[u8]) -> io::Result<usize> {
1202 Write::write(&mut *self.0.lock().unwrap(), data)
1204 fn flush(&mut self) -> io::Result<()> {
1209 let data = Arc::new(Mutex::new(Vec::new()));
1210 let err = Sink(data.clone());
1212 let result = in_rustc_thread(move || {
1213 io::set_panic(Some(box err));
1217 if let Err(value) = result {
1218 // Thread panicked without emitting a fatal diagnostic
1219 if !value.is::<errors::FatalError>() {
1221 Box::new(errors::emitter::EmitterWriter::stderr(errors::ColorConfig::Auto,
1224 let handler = errors::Handler::with_emitter(true, false, emitter);
1226 // a .span_bug or .bug call has already printed what
1227 // it wants to print.
1228 if !value.is::<errors::ExplicitBug>() {
1229 handler.emit(&MultiSpan::new(),
1231 errors::Level::Bug);
1234 let xs = ["the compiler unexpectedly panicked. this is a bug.".to_string(),
1235 format!("we would appreciate a bug report: {}", BUG_REPORT_URL),
1236 format!("rustc {} running on {}",
1237 option_env!("CFG_VERSION").unwrap_or("unknown_version"),
1238 config::host_triple())];
1240 handler.emit(&MultiSpan::new(),
1242 errors::Level::Note);
1244 if match env::var_os("RUST_BACKTRACE") {
1245 Some(val) => &val != "0",
1248 handler.emit(&MultiSpan::new(),
1249 "run with `RUST_BACKTRACE=1` for a backtrace",
1250 errors::Level::Note);
1253 eprintln!("{}", str::from_utf8(&data.lock().unwrap()).unwrap());
1260 fn exit_on_err() -> ! {
1261 // Panic so the process returns a failure code, but don't pollute the
1262 // output with some unnecessary panic messages, we've already
1263 // printed everything that we needed to.
1264 io::set_panic(Some(box io::sink()));
1268 pub fn diagnostics_registry() -> errors::registry::Registry {
1269 use errors::registry::Registry;
1271 let mut all_errors = Vec::new();
1272 all_errors.extend_from_slice(&rustc::DIAGNOSTICS);
1273 all_errors.extend_from_slice(&rustc_typeck::DIAGNOSTICS);
1274 all_errors.extend_from_slice(&rustc_resolve::DIAGNOSTICS);
1275 all_errors.extend_from_slice(&rustc_privacy::DIAGNOSTICS);
1276 #[cfg(feature="llvm")]
1277 all_errors.extend_from_slice(&rustc_trans::DIAGNOSTICS);
1278 all_errors.extend_from_slice(&rustc_const_eval::DIAGNOSTICS);
1279 all_errors.extend_from_slice(&rustc_metadata::DIAGNOSTICS);
1280 all_errors.extend_from_slice(&rustc_passes::DIAGNOSTICS);
1281 all_errors.extend_from_slice(&rustc_plugin::DIAGNOSTICS);
1282 all_errors.extend_from_slice(&rustc_mir::DIAGNOSTICS);
1283 all_errors.extend_from_slice(&syntax::DIAGNOSTICS);
1285 Registry::new(&all_errors)
1288 pub fn get_args() -> Vec<String> {
1289 env::args_os().enumerate()
1290 .map(|(i, arg)| arg.into_string().unwrap_or_else(|arg| {
1291 early_error(ErrorOutputType::default(),
1292 &format!("Argument {} is not valid Unicode: {:?}", i, arg))
1298 env_logger::init().unwrap();
1299 let result = run(|| run_compiler(&get_args(),
1300 &mut RustcDefaultCalls,
1303 process::exit(result as i32);