1 // Copyright 2014 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"]
20 #![crate_type = "dylib"]
21 #![crate_type = "rlib"]
22 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
23 html_favicon_url = "http://www.rust-lang.org/favicon.ico",
24 html_root_url = "http://doc.rust-lang.org/nightly/")]
26 #![allow(unknown_features)]
28 #![feature(slicing_syntax, unsafe_destructor)]
29 #![feature(box_syntax)]
30 #![feature(rustc_diagnostic_macros)]
31 #![allow(unknown_features)] #![feature(int_uint)]
37 extern crate graphviz;
40 extern crate rustc_back;
41 extern crate rustc_borrowck;
42 extern crate rustc_privacy;
43 extern crate rustc_resolve;
44 extern crate rustc_trans;
45 extern crate rustc_typeck;
46 extern crate serialize;
47 extern crate "rustc_llvm" as llvm;
48 #[macro_use] extern crate log;
49 #[macro_use] extern crate syntax;
51 pub use syntax::diagnostic;
53 use driver::CompileController;
55 use rustc_resolve as resolve;
56 use rustc_trans::back::link;
57 use rustc_trans::save;
58 use rustc::session::{config, Session, build_session};
59 use rustc::session::config::{Input, PrintRequest, UnstableFeatures};
60 use rustc::lint::Lint;
63 use rustc::metadata::creader::CrateOrString::Str;
64 use rustc::util::common::time;
66 use std::cmp::Ordering::Equal;
68 use std::iter::repeat;
70 use std::sync::mpsc::channel;
73 use rustc::session::early_error;
77 use syntax::diagnostic::Emitter;
78 use syntax::diagnostics;
86 pub fn run(args: Vec<String>) -> int {
87 monitor(move |:| run_compiler(args.as_slice()));
91 static BUG_REPORT_URL: &'static str =
92 "http://doc.rust-lang.org/complement-bugreport.html";
94 fn run_compiler(args: &[String]) {
95 let matches = match handle_options(args.to_vec()) {
96 Some(matches) => matches,
100 let descriptions = diagnostics_registry();
101 match matches.opt_str("explain") {
103 match descriptions.find_description(&code[]) {
104 Some(ref description) => {
105 println!("{}", description);
108 early_error(&format!("no extended information for {}", code)[]);
116 let sopts = config::build_session_options(&matches);
117 let odir = matches.opt_str("out-dir").map(|o| Path::new(o));
118 let ofile = matches.opt_str("o").map(|o| Path::new(o));
119 let (input, input_file_path) = match matches.free.len() {
121 if sopts.describe_lints {
122 let mut ls = lint::LintStore::new();
123 ls.register_builtin(None);
124 describe_lints(&ls, false);
127 let sess = build_session(sopts, None, descriptions);
128 if print_crate_info(&sess, None, &odir, &ofile) {
131 early_error("no input filename given");
134 let ifile = &matches.free[0][];
136 let contents = io::stdin().read_to_end().unwrap();
137 let src = String::from_utf8(contents).unwrap();
138 (Input::Str(src), None)
140 (Input::File(Path::new(ifile)), Some(Path::new(ifile)))
143 _ => early_error("multiple input filenames provided")
146 let mut sopts = sopts;
147 sopts.unstable_features = get_unstable_features_setting();
149 let mut sess = build_session(sopts, input_file_path, descriptions);
151 let cfg = config::build_configuration(&sess);
152 if print_crate_info(&sess, Some(&input), &odir, &ofile) {
156 let pretty = if sess.opts.debugging_opts.unstable_options {
157 matches.opt_default("pretty", "normal").map(|a| {
158 // stable pretty-print variants only
159 pretty::parse_pretty(&sess, a.as_slice(), false)
164 let pretty = if pretty.is_none() &&
165 sess.unstable_options() {
166 matches.opt_str("xpretty").map(|a| {
167 // extended with unstable pretty-print variants
168 pretty::parse_pretty(&sess, a.as_slice(), true)
174 match pretty.into_iter().next() {
175 Some((ppm, opt_uii)) => {
176 pretty::pretty_print_input(sess, cfg, &input, ppm, opt_uii, ofile);
179 None => {/* continue */ }
182 if sess.unstable_options() {
183 sess.opts.show_span = matches.opt_str("show-span");
186 let r = matches.opt_strs("Z");
187 if r.contains(&("ls".to_string())) {
189 Input::File(ref ifile) => {
190 let mut stdout = io::stdout();
191 list_metadata(&sess, &(*ifile), &mut stdout).unwrap();
194 early_error("cannot list metadata for stdin");
200 let plugins = sess.opts.debugging_opts.extra_plugins.clone();
201 let control = build_controller(&sess);
202 driver::compile_input(sess, cfg, &input, &odir, &ofile, Some(plugins), control);
205 fn build_controller<'a>(sess: &Session) -> CompileController<'a> {
206 let mut control = CompileController::basic();
208 if sess.opts.parse_only ||
209 sess.opts.show_span.is_some() ||
210 sess.opts.debugging_opts.ast_json_noexpand {
211 control.after_parse.stop = true;
214 if sess.opts.no_analysis || sess.opts.debugging_opts.ast_json {
215 control.after_write_deps.stop = true;
218 if sess.opts.no_trans {
219 control.after_analysis.stop = true;
222 if !sess.opts.output_types.iter().any(|&i| i == config::OutputTypeExe) {
223 control.after_llvm.stop = true;
226 if sess.opts.debugging_opts.save_analysis {
227 control.after_analysis.callback = box |state| {
228 time(state.session.time_passes(), "save analysis", state.krate.unwrap(), |krate|
229 save::process_crate(state.session,
231 state.analysis.unwrap(),
234 control.make_glob_map = resolve::MakeGlobMap::Yes;
240 pub fn get_unstable_features_setting() -> UnstableFeatures {
241 // Whether this is a feature-staged build, i.e. on the beta or stable channel
242 let disable_unstable_features = option_env!("CFG_DISABLE_UNSTABLE_FEATURES").is_some();
243 // The secret key needed to get through the rustc build itself by
244 // subverting the unstable features lints
245 let bootstrap_secret_key = option_env!("CFG_BOOTSTRAP_KEY");
246 // The matching key to the above, only known by the build system
247 let bootstrap_provided_key = os::getenv("RUSTC_BOOTSTRAP_KEY");
248 match (disable_unstable_features, bootstrap_secret_key, bootstrap_provided_key) {
249 (_, Some(ref s), Some(ref p)) if s == p => UnstableFeatures::Cheat,
250 (true, _, _) => UnstableFeatures::Disallow,
251 (false, _, _) => UnstableFeatures::Default
255 /// Returns a version string such as "0.12.0-dev".
256 pub fn release_str() -> Option<&'static str> {
257 option_env!("CFG_RELEASE")
260 /// Returns the full SHA1 hash of HEAD of the Git repo from which rustc was built.
261 pub fn commit_hash_str() -> Option<&'static str> {
262 option_env!("CFG_VER_HASH")
265 /// Returns the "commit date" of HEAD of the Git repo from which rustc was built as a static string.
266 pub fn commit_date_str() -> Option<&'static str> {
267 option_env!("CFG_VER_DATE")
270 /// Prints version information and returns None on success or an error
271 /// message on panic.
272 pub fn version(binary: &str, matches: &getopts::Matches) {
273 let verbose = matches.opt_present("verbose");
275 println!("{} {}", binary, option_env!("CFG_VERSION").unwrap_or("unknown version"));
277 fn unw(x: Option<&str>) -> &str { x.unwrap_or("unknown") }
278 println!("binary: {}", binary);
279 println!("commit-hash: {}", unw(commit_hash_str()));
280 println!("commit-date: {}", unw(commit_date_str()));
281 println!("host: {}", config::host_triple());
282 println!("release: {}", unw(release_str()));
286 fn usage(verbose: bool, include_unstable_options: bool) {
287 let groups = if verbose {
288 config::rustc_optgroups()
290 config::rustc_short_optgroups()
292 let groups : Vec<_> = groups.into_iter()
293 .filter(|x| include_unstable_options || x.is_stable())
296 let message = format!("Usage: rustc [OPTIONS] INPUT");
297 let extra_help = if verbose {
300 "\n --help -v Print the full set of options rustc accepts"
304 -C help Print codegen options
305 -W help Print 'lint' options and default settings
306 -Z help Print internal options for debugging rustc{}\n",
307 getopts::usage(message.as_slice(), groups.as_slice()),
311 fn describe_lints(lint_store: &lint::LintStore, loaded_plugins: bool) {
313 Available lint options:
314 -W <foo> Warn about <foo>
317 -F <foo> Forbid <foo> (deny, and deny all overrides)
321 fn sort_lints(lints: Vec<(&'static Lint, bool)>) -> Vec<&'static Lint> {
322 let mut lints: Vec<_> = lints.into_iter().map(|(x, _)| x).collect();
323 lints.sort_by(|x: &&Lint, y: &&Lint| {
324 match x.default_level.cmp(&y.default_level) {
325 // The sort doesn't case-fold but it's doubtful we care.
326 Equal => x.name.cmp(y.name),
333 fn sort_lint_groups(lints: Vec<(&'static str, Vec<lint::LintId>, bool)>)
334 -> Vec<(&'static str, Vec<lint::LintId>)> {
335 let mut lints: Vec<_> = lints.into_iter().map(|(x, y, _)| (x, y)).collect();
336 lints.sort_by(|&(x, _): &(&'static str, Vec<lint::LintId>),
337 &(y, _): &(&'static str, Vec<lint::LintId>)| {
343 let (plugin, builtin): (Vec<_>, _) = lint_store.get_lints()
344 .iter().cloned().partition(|&(_, p)| p);
345 let plugin = sort_lints(plugin);
346 let builtin = sort_lints(builtin);
348 let (plugin_groups, builtin_groups): (Vec<_>, _) = lint_store.get_lint_groups()
349 .iter().cloned().partition(|&(_, _, p)| p);
350 let plugin_groups = sort_lint_groups(plugin_groups);
351 let builtin_groups = sort_lint_groups(builtin_groups);
353 let max_name_len = plugin.iter().chain(builtin.iter())
354 .map(|&s| s.name.width(true))
356 let padded = |&: x: &str| {
357 let mut s = repeat(" ").take(max_name_len - x.chars().count())
358 .collect::<String>();
363 println!("Lint checks provided by rustc:\n");
364 println!(" {} {:7.7} {}", padded("name"), "default", "meaning");
365 println!(" {} {:7.7} {}", padded("----"), "-------", "-------");
367 let print_lints = |&: lints: Vec<&Lint>| {
368 for lint in lints.into_iter() {
369 let name = lint.name_lower().replace("_", "-");
370 println!(" {} {:7.7} {}",
371 padded(&name[]), lint.default_level.as_str(), lint.desc);
376 print_lints(builtin);
380 let max_name_len = plugin_groups.iter().chain(builtin_groups.iter())
381 .map(|&(s, _)| s.width(true))
383 let padded = |&: x: &str| {
384 let mut s = repeat(" ").take(max_name_len - x.chars().count())
385 .collect::<String>();
390 println!("Lint groups provided by rustc:\n");
391 println!(" {} {}", padded("name"), "sub-lints");
392 println!(" {} {}", padded("----"), "---------");
394 let print_lint_groups = |&: lints: Vec<(&'static str, Vec<lint::LintId>)>| {
395 for (name, to) in lints.into_iter() {
396 let name = name.chars().map(|x| x.to_lowercase())
397 .collect::<String>().replace("_", "-");
398 let desc = to.into_iter().map(|x| x.as_str().replace("_", "-"))
399 .collect::<Vec<String>>().connect(", ");
401 padded(&name[]), desc);
406 print_lint_groups(builtin_groups);
408 match (loaded_plugins, plugin.len(), plugin_groups.len()) {
409 (false, 0, _) | (false, _, 0) => {
410 println!("Compiler plugins can provide additional lints and lint groups. To see a \
411 listing of these, re-run `rustc -W help` with a crate filename.");
413 (false, _, _) => panic!("didn't load lint plugins but got them anyway!"),
414 (true, 0, 0) => println!("This crate does not load any lint plugins or lint groups."),
417 println!("Lint checks provided by plugins loaded by this crate:\n");
421 println!("Lint groups provided by plugins loaded by this crate:\n");
422 print_lint_groups(plugin_groups);
428 fn describe_debug_flags() {
429 println!("\nAvailable debug options:\n");
430 for &(name, _, opt_type_desc, desc) in config::DB_OPTIONS.iter() {
431 let (width, extra) = match opt_type_desc {
432 Some(..) => (21, "=val"),
435 println!(" -Z {:>width$}{} -- {}", name.replace("_", "-"),
436 extra, desc, width=width);
440 fn describe_codegen_flags() {
441 println!("\nAvailable codegen options:\n");
442 for &(name, _, opt_type_desc, desc) in config::CG_OPTIONS.iter() {
443 let (width, extra) = match opt_type_desc {
444 Some(..) => (21, "=val"),
447 println!(" -C {:>width$}{} -- {}", name.replace("_", "-"),
448 extra, desc, width=width);
452 /// Process command line options. Emits messages as appropriate. If compilation
453 /// should continue, returns a getopts::Matches object parsed from args, otherwise
455 pub fn handle_options(mut args: Vec<String>) -> Option<getopts::Matches> {
456 // Throw away the first argument, the name of the binary
457 let _binary = args.remove(0);
460 // user did not write `-v` nor `-Z unstable-options`, so do not
461 // include that extra information.
467 match getopts::getopts(&args[], &config::optgroups()[]) {
469 Err(f_stable_attempt) => {
470 // redo option parsing, including unstable options this time,
471 // in anticipation that the mishandled option was one of the
473 let all_groups : Vec<getopts::OptGroup>
474 = config::rustc_optgroups().into_iter().map(|x|x.opt_group).collect();
475 match getopts::getopts(args.as_slice(), all_groups.as_slice()) {
477 let r = m_unstable.opt_strs("Z");
478 let include_unstable_options = r.iter().any(|x| *x == "unstable-options");
479 if include_unstable_options {
482 early_error(f_stable_attempt.to_string().as_slice());
486 // ignore the error from the unstable attempt; just
487 // pass the error we got from the first try.
488 early_error(f_stable_attempt.to_string().as_slice());
494 let r = matches.opt_strs("Z");
495 let include_unstable_options = r.iter().any(|x| *x == "unstable-options");
497 if matches.opt_present("h") || matches.opt_present("help") {
498 usage(matches.opt_present("verbose"), include_unstable_options);
502 // Don't handle -W help here, because we might first load plugins.
504 let r = matches.opt_strs("Z");
505 if r.iter().any(|x| *x == "help") {
506 describe_debug_flags();
510 let cg_flags = matches.opt_strs("C");
511 if cg_flags.iter().any(|x| *x == "help") {
512 describe_codegen_flags();
516 if cg_flags.contains(&"passes=list".to_string()) {
517 unsafe { ::llvm::LLVMRustPrintPasses(); }
521 if matches.opt_present("version") {
522 version("rustc", &matches);
529 fn print_crate_info(sess: &Session,
530 input: Option<&Input>,
532 ofile: &Option<Path>)
534 if sess.opts.prints.len() == 0 { return false }
536 let attrs = input.map(|input| parse_crate_attrs(sess, input));
537 for req in sess.opts.prints.iter() {
539 PrintRequest::Sysroot => println!("{}", sess.sysroot().display()),
540 PrintRequest::FileNames |
541 PrintRequest::CrateName => {
542 let input = match input {
543 Some(input) => input,
544 None => early_error("no input file provided"),
546 let attrs = attrs.as_ref().unwrap().as_slice();
547 let t_outputs = driver::build_output_filenames(input,
552 let id = link::find_crate_name(Some(sess), attrs.as_slice(),
554 if *req == PrintRequest::CrateName {
558 let crate_types = driver::collect_crate_types(sess, attrs);
559 let metadata = driver::collect_crate_metadata(sess, attrs);
560 *sess.crate_metadata.borrow_mut() = metadata;
561 for &style in crate_types.iter() {
562 let fname = link::filename_for_input(sess, style,
564 &t_outputs.with_extension(""));
565 println!("{}", fname.filename_display());
573 fn parse_crate_attrs(sess: &Session, input: &Input) ->
574 Vec<ast::Attribute> {
575 let result = match *input {
576 Input::File(ref ifile) => {
577 parse::parse_crate_attrs_from_file(ifile,
581 Input::Str(ref src) => {
582 parse::parse_crate_attrs_from_source_str(
583 driver::anon_src().to_string(),
589 result.into_iter().collect()
592 pub fn list_metadata(sess: &Session, path: &Path,
593 out: &mut io::Writer) -> io::IoResult<()> {
594 metadata::loader::list_file_metadata(sess.target.target.options.is_like_osx, path, out)
597 /// Run a procedure which will detect panics in the compiler and print nicer
598 /// error messages rather than just failing the test.
600 /// The diagnostic emitter yielded to the procedure should be used for reporting
601 /// errors of the compiler.
602 pub fn monitor<F:FnOnce()+Send>(f: F) {
603 static STACK_SIZE: uint = 8 * 1024 * 1024; // 8MB
605 let (tx, rx) = channel();
606 let w = io::ChanWriter::new(tx);
607 let mut r = io::ChanReader::new(rx);
609 let mut cfg = thread::Builder::new().name("rustc".to_string());
611 // FIXME: Hacks on hacks. If the env is trying to override the stack size
612 // then *don't* set it explicitly.
613 if os::getenv("RUST_MIN_STACK").is_none() {
614 cfg = cfg.stack_size(STACK_SIZE);
617 match cfg.scoped(move || { std::io::stdio::set_stderr(box w); f() }).join() {
618 Ok(()) => { /* fallthrough */ }
620 // Thread panicked without emitting a fatal diagnostic
621 if !value.is::<diagnostic::FatalError>() {
622 let mut emitter = diagnostic::EmitterWriter::stderr(diagnostic::Auto, None);
624 // a .span_bug or .bug call has already printed what
625 // it wants to print.
626 if !value.is::<diagnostic::ExplicitBug>() {
635 "the compiler unexpectedly panicked. this is a bug.".to_string(),
636 format!("we would appreciate a bug report: {}",
638 "run with `RUST_BACKTRACE=1` for a backtrace".to_string(),
640 for note in xs.iter() {
641 emitter.emit(None, ¬e[], None, diagnostic::Note)
644 match r.read_to_string() {
645 Ok(s) => println!("{}", s),
648 &format!("failed to read internal \
656 // Panic so the process returns a failure code, but don't pollute the
657 // output with some unnecessary panic messages, we've already
658 // printed everything that we needed to.
659 io::stdio::set_stderr(box io::util::NullWriter);
665 pub fn diagnostics_registry() -> diagnostics::registry::Registry {
666 use syntax::diagnostics::registry::Registry;
668 let all_errors = Vec::new() +
669 rustc::diagnostics::DIAGNOSTICS.as_slice() +
670 rustc_typeck::diagnostics::DIAGNOSTICS.as_slice() +
671 rustc_resolve::diagnostics::DIAGNOSTICS.as_slice();
673 Registry::new(&*all_errors)
677 let args = std::os::args();
678 let result = run(args);
679 std::os::set_exit_status(result);