src/librustc_driver/lib.rs

   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.
   4 //
   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.
  10
  11 //! The Rust compiler.
  12 //!
  13 //! # Note
  14 //!
  15 //! This API is completely unstable and subject to change.
  16
  17 // Do not remove on snapshot creation. Needed for bootstrap. (Issue #22364)
  18 #![cfg_attr(stage0, feature(custom_attribute))]
  19 #![crate_name = "rustc_driver"]
  20 #![unstable(feature = "rustc_private")]
  21 #![staged_api]
  22 #![crate_type = "dylib"]
  23 #![crate_type = "rlib"]
  24 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  25       html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  26       html_root_url = "http://doc.rust-lang.org/nightly/")]
  27
  28 #![feature(box_syntax)]
  29 #![feature(libc)]
  30 #![feature(quote)]
  31 #![feature(rustc_diagnostic_macros)]
  32 #![feature(rustc_private)]
  33 #![feature(set_stdio)]
  34 #![feature(staged_api)]
  35 #![feature(vec_push_all)]
  36
  37 extern crate arena;
  38 extern crate flate;
  39 extern crate getopts;
  40 extern crate graphviz;
  41 extern crate libc;
  42 extern crate rustc;
  43 extern crate rustc_back;
  44 extern crate rustc_borrowck;
  45 extern crate rustc_lint;
  46 extern crate rustc_privacy;
  47 extern crate rustc_resolve;
  48 extern crate rustc_trans;
  49 extern crate rustc_typeck;
  50 extern crate serialize;
  51 extern crate rustc_llvm as llvm;
  52 #[macro_use] extern crate log;
  53 #[macro_use] extern crate syntax;
  54
  55 pub use syntax::diagnostic;
  56
  57 use driver::CompileController;
  58 use pretty::{PpMode, UserIdentifiedItem};
  59
  60 use rustc_resolve as resolve;
  61 use rustc_trans::back::link;
  62 use rustc_trans::save;
  63 use rustc::session::{config, Session, build_session};
  64 use rustc::session::config::{Input, PrintRequest};
  65 use rustc::lint::Lint;
  66 use rustc::lint;
  67 use rustc::metadata;
  68 use rustc::util::common::time;
  69
  70 use std::cmp::Ordering::Equal;
  71 use std::env;
  72 use std::io::{self, Read, Write};
  73 use std::iter::repeat;
  74 use std::path::PathBuf;
  75 use std::process;
  76 use std::str;
  77 use std::sync::{Arc, Mutex};
  78 use std::thread;
  79
  80 use rustc::session::early_error;
  81
  82 use syntax::ast;
  83 use syntax::parse;
  84 use syntax::diagnostic::Emitter;
  85 use syntax::diagnostics;
  86
  87 #[cfg(test)]
  88 pub mod test;
  89
  90 pub mod driver;
  91 pub mod pretty;
  92
  93
  94 const BUG_REPORT_URL: &'static str =
  95     "https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md#bug-reports";
  96
  97
  98 pub fn run(args: Vec<String>) -> isize {
  99     monitor(move || run_compiler(&args, &mut RustcDefaultCalls));
 100     0
 101 }
 102
 103 // Parse args and run the compiler. This is the primary entry point for rustc.
 104 // See comments on CompilerCalls below for details about the callbacks argument.
 105 pub fn run_compiler<'a>(args: &[String],
 106                         callbacks: &mut CompilerCalls<'a>) {
 107     macro_rules! do_or_return {($expr: expr) => {
 108         match $expr {
 109             Compilation::Stop => return,
 110             Compilation::Continue => {}
 111         }
 112     }}
 113
 114     let matches = match handle_options(args.to_vec()) {
 115         Some(matches) => matches,
 116         None => return
 117     };
 118
 119     let descriptions = diagnostics_registry();
 120
 121     do_or_return!(callbacks.early_callback(&matches, &descriptions));
 122
 123     let sopts = config::build_session_options(&matches);
 124
 125     let (odir, ofile) = make_output(&matches);
 126     let (input, input_file_path) = match make_input(&matches.free) {
 127         Some((input, input_file_path)) => callbacks.some_input(input, input_file_path),
 128         None => match callbacks.no_input(&matches, &sopts, &odir, &ofile, &descriptions) {
 129             Some((input, input_file_path)) => (input, input_file_path),
 130             None => return
 131         }
 132     };
 133
 134     let mut sess = build_session(sopts, input_file_path, descriptions);
 135     rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
 136     if sess.unstable_options() {
 137         sess.opts.show_span = matches.opt_str("show-span");
 138     }
 139     let cfg = config::build_configuration(&sess);
 140
 141     do_or_return!(callbacks.late_callback(&matches, &sess, &input, &odir, &ofile));
 142
 143     // It is somewhat unfortunate that this is hardwired in - this is forced by
 144     // the fact that pretty_print_input requires the session by value.
 145     let pretty = callbacks.parse_pretty(&sess, &matches);
 146     match pretty {
 147         Some((ppm, opt_uii)) => {
 148             pretty::pretty_print_input(sess, cfg, &input, ppm, opt_uii, ofile);
 149             return;
 150         }
 151         None => {/* continue */ }
 152     }
 153
 154     let plugins = sess.opts.debugging_opts.extra_plugins.clone();
 155     let control = callbacks.build_controller(&sess);
 156     driver::compile_input(sess, cfg, &input, &odir, &ofile, Some(plugins), control);
 157 }
 158
 159 // Extract output directory and file from matches.
 160 fn make_output(matches: &getopts::Matches) -> (Option<PathBuf>, Option<PathBuf>) {
 161     let odir = matches.opt_str("out-dir").map(|o| PathBuf::from(&o));
 162     let ofile = matches.opt_str("o").map(|o| PathBuf::from(&o));
 163     (odir, ofile)
 164 }
 165
 166 // Extract input (string or file and optional path) from matches.
 167 fn make_input(free_matches: &[String]) -> Option<(Input, Option<PathBuf>)> {
 168     if free_matches.len() == 1 {
 169         let ifile = &free_matches[0][..];
 170         if ifile == "-" {
 171             let mut src = String::new();
 172             io::stdin().read_to_string(&mut src).unwrap();
 173             Some((Input::Str(src), None))
 174         } else {
 175             Some((Input::File(PathBuf::from(ifile)), Some(PathBuf::from(ifile))))
 176         }
 177     } else {
 178         None
 179     }
 180 }
 181
 182 // Whether to stop or continue compilation.
 183 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
 184 pub enum Compilation {
 185     Stop,
 186     Continue,
 187 }
 188
 189 impl Compilation {
 190     pub fn and_then<F: FnOnce() -> Compilation>(self, next: F) -> Compilation {
 191         match self {
 192             Compilation::Stop => Compilation::Stop,
 193             Compilation::Continue => next()
 194         }
 195     }
 196 }
 197
 198 // A trait for customising the compilation process. Offers a number of hooks for
 199 // executing custom code or customising input.
 200 pub trait CompilerCalls<'a> {
 201     // Hook for a callback early in the process of handling arguments. This will
 202     // be called straight after options have been parsed but before anything
 203     // else (e.g., selecting input and output).
 204     fn early_callback(&mut self,
 205                       &getopts::Matches,
 206                       &diagnostics::registry::Registry)
 207                       -> Compilation;
 208
 209     // Hook for a callback late in the process of handling arguments. This will
 210     // be called just before actual compilation starts (and before build_controller
 211     // is called), after all arguments etc. have been completely handled.
 212     fn late_callback(&mut self,
 213                      &getopts::Matches,
 214                      &Session,
 215                      &Input,
 216                      &Option<PathBuf>,
 217                      &Option<PathBuf>)
 218                      -> Compilation;
 219
 220     // Called after we extract the input from the arguments. Gives the implementer
 221     // an opportunity to change the inputs or to add some custom input handling.
 222     // The default behaviour is to simply pass through the inputs.
 223     fn some_input(&mut self, input: Input, input_path: Option<PathBuf>)
 224                   -> (Input, Option<PathBuf>) {
 225         (input, input_path)
 226     }
 227
 228     // Called after we extract the input from the arguments if there is no valid
 229     // input. Gives the implementer an opportunity to supply alternate input (by
 230     // returning a Some value) or to add custom behaviour for this error such as
 231     // emitting error messages. Returning None will cause compilation to stop
 232     // at this point.
 233     fn no_input(&mut self,
 234                 &getopts::Matches,
 235                 &config::Options,
 236                 &Option<PathBuf>,
 237                 &Option<PathBuf>,
 238                 &diagnostics::registry::Registry)
 239                 -> Option<(Input, Option<PathBuf>)>;
 240
 241     // Parse pretty printing information from the arguments. The implementer can
 242     // choose to ignore this (the default will return None) which will skip pretty
 243     // printing. If you do want to pretty print, it is recommended to use the
 244     // implementation of this method from RustcDefaultCalls.
 245     // FIXME, this is a terrible bit of API. Parsing of pretty printing stuff
 246     // should be done as part of the framework and the implementor should customise
 247     // handling of it. However, that is not possible atm because pretty printing
 248     // essentially goes off and takes another path through the compiler which
 249     // means the session is either moved or not depending on what parse_pretty
 250     // returns (we could fix this by cloning, but it's another hack). The proper
 251     // solution is to handle pretty printing as if it were a compiler extension,
 252     // extending CompileController to make this work (see for example the treatment
 253     // of save-analysis in RustcDefaultCalls::build_controller).
 254     fn parse_pretty(&mut self,
 255                     _sess: &Session,
 256                     _matches: &getopts::Matches)
 257                     -> Option<(PpMode, Option<UserIdentifiedItem>)> {
 258         None
 259     }
 260
 261     // Create a CompilController struct for controlling the behaviour of compilation.
 262     fn build_controller(&mut self, &Session) -> CompileController<'a>;
 263 }
 264
 265 // CompilerCalls instance for a regular rustc build.
 266 #[derive(Copy, Clone)]
 267 pub struct RustcDefaultCalls;
 268
 269 impl<'a> CompilerCalls<'a> for RustcDefaultCalls {
 270     fn early_callback(&mut self,
 271                       matches: &getopts::Matches,
 272                       descriptions: &diagnostics::registry::Registry)
 273                       -> Compilation {
 274         match matches.opt_str("explain") {
 275             Some(ref code) => {
 276                 match descriptions.find_description(&code[..]) {
 277                     Some(ref description) => {
 278                         // Slice off the leading newline and print.
 279                         print!("{}", &description[1..]);
 280                     }
 281                     None => {
 282                         early_error(&format!("no extended information for {}", code));
 283                     }
 284                 }
 285                 return Compilation::Stop;
 286             },
 287             None => ()
 288         }
 289
 290         return Compilation::Continue;
 291     }
 292
 293     fn no_input(&mut self,
 294                 matches: &getopts::Matches,
 295                 sopts: &config::Options,
 296                 odir: &Option<PathBuf>,
 297                 ofile: &Option<PathBuf>,
 298                 descriptions: &diagnostics::registry::Registry)
 299                 -> Option<(Input, Option<PathBuf>)> {
 300         match matches.free.len() {
 301             0 => {
 302                 if sopts.describe_lints {
 303                     let mut ls = lint::LintStore::new();
 304                     rustc_lint::register_builtins(&mut ls, None);
 305                     describe_lints(&ls, false);
 306                     return None;
 307                 }
 308                 let sess = build_session(sopts.clone(), None, descriptions.clone());
 309                 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
 310                 let should_stop = RustcDefaultCalls::print_crate_info(&sess, None, odir, ofile);
 311                 if should_stop == Compilation::Stop {
 312                     return None;
 313                 }
 314                 early_error("no input filename given");
 315             }
 316             1 => panic!("make_input should have provided valid inputs"),
 317             _ => early_error("multiple input filenames provided")
 318         }
 319
 320         None
 321     }
 322
 323     fn parse_pretty(&mut self,
 324                     sess: &Session,
 325                     matches: &getopts::Matches)
 326                     -> Option<(PpMode, Option<UserIdentifiedItem>)> {
 327         let pretty = if sess.opts.debugging_opts.unstable_options {
 328             matches.opt_default("pretty", "normal").map(|a| {
 329                 // stable pretty-print variants only
 330                 pretty::parse_pretty(sess, &a, false)
 331             })
 332         } else {
 333             None
 334         };
 335         if pretty.is_none() && sess.unstable_options() {
 336             matches.opt_str("xpretty").map(|a| {
 337                 // extended with unstable pretty-print variants
 338                 pretty::parse_pretty(sess, &a, true)
 339             })
 340         } else {
 341             pretty
 342         }
 343     }
 344
 345     fn late_callback(&mut self,
 346                      matches: &getopts::Matches,
 347                      sess: &Session,
 348                      input: &Input,
 349                      odir: &Option<PathBuf>,
 350                      ofile: &Option<PathBuf>)
 351                      -> Compilation {
 352         RustcDefaultCalls::print_crate_info(sess, Some(input), odir, ofile).and_then(
 353             || RustcDefaultCalls::list_metadata(sess, matches, input))
 354     }
 355
 356     fn build_controller(&mut self, sess: &Session) -> CompileController<'a> {
 357         let mut control = CompileController::basic();
 358
 359         if sess.opts.parse_only ||
 360            sess.opts.show_span.is_some() ||
 361            sess.opts.debugging_opts.ast_json_noexpand {
 362             control.after_parse.stop = Compilation::Stop;
 363         }
 364
 365         if sess.opts.no_analysis || sess.opts.debugging_opts.ast_json {
 366             control.after_write_deps.stop = Compilation::Stop;
 367         }
 368
 369         if sess.opts.no_trans {
 370             control.after_analysis.stop = Compilation::Stop;
 371         }
 372
 373         if !sess.opts.output_types.iter().any(|&i| i == config::OutputTypeExe) {
 374             control.after_llvm.stop = Compilation::Stop;
 375         }
 376
 377         if sess.opts.debugging_opts.save_analysis {
 378             control.after_analysis.callback = box |state| {
 379                 time(state.session.time_passes(),
 380                      "save analysis", (),
 381                      |_| save::process_crate(state.tcx.unwrap(),
 382                                              state.analysis.unwrap(),
 383                                              state.out_dir));
 384             };
 385             control.make_glob_map = resolve::MakeGlobMap::Yes;
 386         }
 387
 388         control
 389     }
 390 }
 391
 392 impl RustcDefaultCalls {
 393     pub fn list_metadata(sess: &Session,
 394                          matches: &getopts::Matches,
 395                          input: &Input)
 396                          -> Compilation {
 397         let r = matches.opt_strs("Z");
 398         if r.contains(&("ls".to_string())) {
 399             match input {
 400                 &Input::File(ref ifile) => {
 401                     let path = &(*ifile);
 402                     let mut v = Vec::new();
 403                     metadata::loader::list_file_metadata(&sess.target.target,
 404                                                          path,
 405                                                          &mut v).unwrap();
 406                     println!("{}", String::from_utf8(v).unwrap());
 407                 }
 408                 &Input::Str(_) => {
 409                     early_error("cannot list metadata for stdin");
 410                 }
 411             }
 412             return Compilation::Stop;
 413         }
 414
 415         return Compilation::Continue;
 416     }
 417
 418
 419     fn print_crate_info(sess: &Session,
 420                         input: Option<&Input>,
 421                         odir: &Option<PathBuf>,
 422                         ofile: &Option<PathBuf>)
 423                         -> Compilation {
 424         if sess.opts.prints.is_empty() {
 425             return Compilation::Continue;
 426         }
 427
 428         let attrs = input.map(|input| parse_crate_attrs(sess, input));
 429         for req in &sess.opts.prints {
 430             match *req {
 431                 PrintRequest::Sysroot => println!("{}", sess.sysroot().display()),
 432                 PrintRequest::FileNames |
 433                 PrintRequest::CrateName => {
 434                     let input = match input {
 435                         Some(input) => input,
 436                         None => early_error("no input file provided"),
 437                     };
 438                     let attrs = attrs.as_ref().unwrap();
 439                     let t_outputs = driver::build_output_filenames(input,
 440                                                                    odir,
 441                                                                    ofile,
 442                                                                    attrs,
 443                                                                    sess);
 444                     let id = link::find_crate_name(Some(sess),
 445                                                    attrs,
 446                                                    input);
 447                     if *req == PrintRequest::CrateName {
 448                         println!("{}", id);
 449                         continue
 450                     }
 451                     let crate_types = driver::collect_crate_types(sess, attrs);
 452                     let metadata = driver::collect_crate_metadata(sess, attrs);
 453                     *sess.crate_metadata.borrow_mut() = metadata;
 454                     for &style in &crate_types {
 455                         let fname = link::filename_for_input(sess, style, &id,
 456                                                              &t_outputs);
 457                         println!("{}", fname.file_name().unwrap()
 458                                             .to_string_lossy());
 459                     }
 460                 }
 461             }
 462         }
 463         return Compilation::Stop;
 464     }
 465 }
 466
 467 /// Returns a version string such as "0.12.0-dev".
 468 pub fn release_str() -> Option<&'static str> {
 469     option_env!("CFG_RELEASE")
 470 }
 471
 472 /// Returns the full SHA1 hash of HEAD of the Git repo from which rustc was built.
 473 pub fn commit_hash_str() -> Option<&'static str> {
 474     option_env!("CFG_VER_HASH")
 475 }
 476
 477 /// Returns the "commit date" of HEAD of the Git repo from which rustc was built as a static string.
 478 pub fn commit_date_str() -> Option<&'static str> {
 479     option_env!("CFG_VER_DATE")
 480 }
 481
 482 /// Prints version information
 483 pub fn version(binary: &str, matches: &getopts::Matches) {
 484     let verbose = matches.opt_present("verbose");
 485
 486     println!("{} {}", binary, option_env!("CFG_VERSION").unwrap_or("unknown version"));
 487     if verbose {
 488         fn unw(x: Option<&str>) -> &str { x.unwrap_or("unknown") }
 489         println!("binary: {}", binary);
 490         println!("commit-hash: {}", unw(commit_hash_str()));
 491         println!("commit-date: {}", unw(commit_date_str()));
 492         println!("host: {}", config::host_triple());
 493         println!("release: {}", unw(release_str()));
 494     }
 495 }
 496
 497 fn usage(verbose: bool, include_unstable_options: bool) {
 498     let groups = if verbose {
 499         config::rustc_optgroups()
 500     } else {
 501         config::rustc_short_optgroups()
 502     };
 503     let groups : Vec<_> = groups.into_iter()
 504         .filter(|x| include_unstable_options || x.is_stable())
 505         .map(|x|x.opt_group)
 506         .collect();
 507     let message = format!("Usage: rustc [OPTIONS] INPUT");
 508     let extra_help = if verbose {
 509         ""
 510     } else {
 511         "\n    --help -v           Print the full set of options rustc accepts"
 512     };
 513     println!("{}\n\
 514 Additional help:
 515     -C help             Print codegen options
 516     -W help             Print 'lint' options and default settings
 517     -Z help             Print internal options for debugging rustc{}\n",
 518               getopts::usage(&message, &groups),
 519               extra_help);
 520 }
 521
 522 fn describe_lints(lint_store: &lint::LintStore, loaded_plugins: bool) {
 523     println!("
 524 Available lint options:
 525     -W <foo>           Warn about <foo>
 526     -A <foo>           Allow <foo>
 527     -D <foo>           Deny <foo>
 528     -F <foo>           Forbid <foo> (deny, and deny all overrides)
 529
 530 ");
 531
 532     fn sort_lints(lints: Vec<(&'static Lint, bool)>) -> Vec<&'static Lint> {
 533         let mut lints: Vec<_> = lints.into_iter().map(|(x, _)| x).collect();
 534         lints.sort_by(|x: &&Lint, y: &&Lint| {
 535             match x.default_level.cmp(&y.default_level) {
 536                 // The sort doesn't case-fold but it's doubtful we care.
 537                 Equal => x.name.cmp(y.name),
 538                 r => r,
 539             }
 540         });
 541         lints
 542     }
 543
 544     fn sort_lint_groups(lints: Vec<(&'static str, Vec<lint::LintId>, bool)>)
 545                      -> Vec<(&'static str, Vec<lint::LintId>)> {
 546         let mut lints: Vec<_> = lints.into_iter().map(|(x, y, _)| (x, y)).collect();
 547         lints.sort_by(|&(x, _): &(&'static str, Vec<lint::LintId>),
 548                        &(y, _): &(&'static str, Vec<lint::LintId>)| {
 549             x.cmp(y)
 550         });
 551         lints
 552     }
 553
 554     let (plugin, builtin): (Vec<_>, _) = lint_store.get_lints()
 555         .iter().cloned().partition(|&(_, p)| p);
 556     let plugin = sort_lints(plugin);
 557     let builtin = sort_lints(builtin);
 558
 559     let (plugin_groups, builtin_groups): (Vec<_>, _) = lint_store.get_lint_groups()
 560         .iter().cloned().partition(|&(_, _, p)| p);
 561     let plugin_groups = sort_lint_groups(plugin_groups);
 562     let builtin_groups = sort_lint_groups(builtin_groups);
 563
 564     let max_name_len = plugin.iter().chain(&builtin)
 565         .map(|&s| s.name.chars().count())
 566         .max().unwrap_or(0);
 567     let padded = |x: &str| {
 568         let mut s = repeat(" ").take(max_name_len - x.chars().count())
 569                                .collect::<String>();
 570         s.push_str(x);
 571         s
 572     };
 573
 574     println!("Lint checks provided by rustc:\n");
 575     println!("    {}  {:7.7}  {}", padded("name"), "default", "meaning");
 576     println!("    {}  {:7.7}  {}", padded("----"), "-------", "-------");
 577
 578     let print_lints = |lints: Vec<&Lint>| {
 579         for lint in lints {
 580             let name = lint.name_lower().replace("_", "-");
 581             println!("    {}  {:7.7}  {}",
 582                      padded(&name[..]), lint.default_level.as_str(), lint.desc);
 583         }
 584         println!("\n");
 585     };
 586
 587     print_lints(builtin);
 588
 589
 590
 591     let max_name_len = plugin_groups.iter().chain(&builtin_groups)
 592         .map(|&(s, _)| s.chars().count())
 593         .max().unwrap_or(0);
 594     let padded = |x: &str| {
 595         let mut s = repeat(" ").take(max_name_len - x.chars().count())
 596                                .collect::<String>();
 597         s.push_str(x);
 598         s
 599     };
 600
 601     println!("Lint groups provided by rustc:\n");
 602     println!("    {}  {}", padded("name"), "sub-lints");
 603     println!("    {}  {}", padded("----"), "---------");
 604
 605     let print_lint_groups = |lints: Vec<(&'static str, Vec<lint::LintId>)>| {
 606         for (name, to) in lints {
 607             let name = name.to_lowercase().replace("_", "-");
 608             let desc = to.into_iter().map(|x| x.as_str().replace("_", "-"))
 609                          .collect::<Vec<String>>().join(", ");
 610             println!("    {}  {}",
 611                      padded(&name[..]), desc);
 612         }
 613         println!("\n");
 614     };
 615
 616     print_lint_groups(builtin_groups);
 617
 618     match (loaded_plugins, plugin.len(), plugin_groups.len()) {
 619         (false, 0, _) | (false, _, 0) => {
 620             println!("Compiler plugins can provide additional lints and lint groups. To see a \
 621                       listing of these, re-run `rustc -W help` with a crate filename.");
 622         }
 623         (false, _, _) => panic!("didn't load lint plugins but got them anyway!"),
 624         (true, 0, 0) => println!("This crate does not load any lint plugins or lint groups."),
 625         (true, l, g) => {
 626             if l > 0 {
 627                 println!("Lint checks provided by plugins loaded by this crate:\n");
 628                 print_lints(plugin);
 629             }
 630             if g > 0 {
 631                 println!("Lint groups provided by plugins loaded by this crate:\n");
 632                 print_lint_groups(plugin_groups);
 633             }
 634         }
 635     }
 636 }
 637
 638 fn describe_debug_flags() {
 639     println!("\nAvailable debug options:\n");
 640     for &(name, _, opt_type_desc, desc) in config::DB_OPTIONS {
 641         let (width, extra) = match opt_type_desc {
 642             Some(..) => (21, "=val"),
 643             None => (25, "")
 644         };
 645         println!("    -Z {:>width$}{} -- {}", name.replace("_", "-"),
 646                  extra, desc, width=width);
 647     }
 648 }
 649
 650 fn describe_codegen_flags() {
 651     println!("\nAvailable codegen options:\n");
 652     for &(name, _, opt_type_desc, desc) in config::CG_OPTIONS {
 653         let (width, extra) = match opt_type_desc {
 654             Some(..) => (21, "=val"),
 655             None => (25, "")
 656         };
 657         println!("    -C {:>width$}{} -- {}", name.replace("_", "-"),
 658                  extra, desc, width=width);
 659     }
 660 }
 661
 662 /// Process command line options. Emits messages as appropriate. If compilation
 663 /// should continue, returns a getopts::Matches object parsed from args, otherwise
 664 /// returns None.
 665 pub fn handle_options(mut args: Vec<String>) -> Option<getopts::Matches> {
 666     // Throw away the first argument, the name of the binary
 667     let _binary = args.remove(0);
 668
 669     if args.is_empty() {
 670         // user did not write `-v` nor `-Z unstable-options`, so do not
 671         // include that extra information.
 672         usage(false, false);
 673         return None;
 674     }
 675
 676     fn allows_unstable_options(matches: &getopts::Matches) -> bool {
 677         let r = matches.opt_strs("Z");
 678         r.iter().any(|x| *x == "unstable-options")
 679     }
 680
 681     fn parse_all_options(args: &Vec<String>) -> getopts::Matches {
 682         let all_groups : Vec<getopts::OptGroup>
 683             = config::rustc_optgroups().into_iter().map(|x|x.opt_group).collect();
 684         match getopts::getopts(&args[..], &all_groups) {
 685             Ok(m) => {
 686                 if !allows_unstable_options(&m) {
 687                     // If -Z unstable-options was not specified, verify that
 688                     // no unstable options were present.
 689                     for opt in config::rustc_optgroups().into_iter().filter(|x| !x.is_stable()) {
 690                         let opt_name = if !opt.opt_group.long_name.is_empty() {
 691                             &opt.opt_group.long_name
 692                         } else {
 693                             &opt.opt_group.short_name
 694                         };
 695                         if m.opt_present(opt_name) {
 696                             early_error(&format!("use of unstable option '{}' requires \
 697                                                   -Z unstable-options", opt_name));
 698                         }
 699                     }
 700                 }
 701                 m
 702             }
 703             Err(f) => early_error(&f.to_string())
 704         }
 705     }
 706
 707     // As a speed optimization, first try to parse the command-line using just
 708     // the stable options.
 709     let matches = match getopts::getopts(&args[..], &config::optgroups()) {
 710         Ok(ref m) if allows_unstable_options(m) => {
 711             // If -Z unstable-options was specified, redo parsing with the
 712             // unstable options to ensure that unstable options are defined
 713             // in the returned getopts::Matches.
 714             parse_all_options(&args)
 715         }
 716         Ok(m) => m,
 717         Err(_) => {
 718             // redo option parsing, including unstable options this time,
 719             // in anticipation that the mishandled option was one of the
 720             // unstable ones.
 721             parse_all_options(&args)
 722         }
 723     };
 724
 725     if matches.opt_present("h") || matches.opt_present("help") {
 726         usage(matches.opt_present("verbose"), allows_unstable_options(&matches));
 727         return None;
 728     }
 729
 730     // Don't handle -W help here, because we might first load plugins.
 731
 732     let r = matches.opt_strs("Z");
 733     if r.iter().any(|x| *x == "help") {
 734         describe_debug_flags();
 735         return None;
 736     }
 737
 738     let cg_flags = matches.opt_strs("C");
 739     if cg_flags.iter().any(|x| *x == "help") {
 740         describe_codegen_flags();
 741         return None;
 742     }
 743
 744     if cg_flags.contains(&"passes=list".to_string()) {
 745         unsafe { ::llvm::LLVMRustPrintPasses(); }
 746         return None;
 747     }
 748
 749     if matches.opt_present("version") {
 750         version("rustc", &matches);
 751         return None;
 752     }
 753
 754     Some(matches)
 755 }
 756
 757 fn parse_crate_attrs(sess: &Session, input: &Input) ->
 758                      Vec<ast::Attribute> {
 759     let result = match *input {
 760         Input::File(ref ifile) => {
 761             parse::parse_crate_attrs_from_file(ifile,
 762                                                Vec::new(),
 763                                                &sess.parse_sess)
 764         }
 765         Input::Str(ref src) => {
 766             parse::parse_crate_attrs_from_source_str(
 767                 driver::anon_src().to_string(),
 768                 src.to_string(),
 769                 Vec::new(),
 770                 &sess.parse_sess)
 771         }
 772     };
 773     result.into_iter().collect()
 774 }
 775
 776 /// Run a procedure which will detect panics in the compiler and print nicer
 777 /// error messages rather than just failing the test.
 778 ///
 779 /// The diagnostic emitter yielded to the procedure should be used for reporting
 780 /// errors of the compiler.
 781 pub fn monitor<F:FnOnce()+Send+'static>(f: F) {
 782     const STACK_SIZE: usize = 8 * 1024 * 1024; // 8MB
 783
 784     struct Sink(Arc<Mutex<Vec<u8>>>);
 785     impl Write for Sink {
 786         fn write(&mut self, data: &[u8]) -> io::Result<usize> {
 787             Write::write(&mut *self.0.lock().unwrap(), data)
 788         }
 789         fn flush(&mut self) -> io::Result<()> { Ok(()) }
 790     }
 791
 792     let data = Arc::new(Mutex::new(Vec::new()));
 793     let err = Sink(data.clone());
 794
 795     let mut cfg = thread::Builder::new().name("rustc".to_string());
 796
 797     // FIXME: Hacks on hacks. If the env is trying to override the stack size
 798     // then *don't* set it explicitly.
 799     if env::var_os("RUST_MIN_STACK").is_none() {
 800         cfg = cfg.stack_size(STACK_SIZE);
 801     }
 802
 803     match cfg.spawn(move || { io::set_panic(box err); f() }).unwrap().join() {
 804         Ok(()) => { /* fallthrough */ }
 805         Err(value) => {
 806             // Thread panicked without emitting a fatal diagnostic
 807             if !value.is::<diagnostic::FatalError>() {
 808                 let mut emitter = diagnostic::EmitterWriter::stderr(diagnostic::Auto, None);
 809
 810                 // a .span_bug or .bug call has already printed what
 811                 // it wants to print.
 812                 if !value.is::<diagnostic::ExplicitBug>() {
 813                     emitter.emit(
 814                         None,
 815                         "unexpected panic",
 816                         None,
 817                         diagnostic::Bug);
 818                 }
 819
 820                 let xs = [
 821                     "the compiler unexpectedly panicked. this is a bug.".to_string(),
 822                     format!("we would appreciate a bug report: {}",
 823                             BUG_REPORT_URL),
 824                 ];
 825                 for note in &xs {
 826                     emitter.emit(None, &note[..], None, diagnostic::Note)
 827                 }
 828                 if let None = env::var_os("RUST_BACKTRACE") {
 829                     emitter.emit(None, "run with `RUST_BACKTRACE=1` for a backtrace",
 830                                  None, diagnostic::Note);
 831                 }
 832
 833                 println!("{}", str::from_utf8(&data.lock().unwrap()).unwrap());
 834             }
 835
 836             // Panic so the process returns a failure code, but don't pollute the
 837             // output with some unnecessary panic messages, we've already
 838             // printed everything that we needed to.
 839             io::set_panic(box io::sink());
 840             panic!();
 841         }
 842     }
 843 }
 844
 845 pub fn diagnostics_registry() -> diagnostics::registry::Registry {
 846     use syntax::diagnostics::registry::Registry;
 847
 848     let mut all_errors = Vec::new();
 849     all_errors.push_all(&rustc::DIAGNOSTICS);
 850     all_errors.push_all(&rustc_typeck::DIAGNOSTICS);
 851     all_errors.push_all(&rustc_borrowck::DIAGNOSTICS);
 852     all_errors.push_all(&rustc_resolve::DIAGNOSTICS);
 853
 854     Registry::new(&*all_errors)
 855 }
 856
 857 pub fn main() {
 858     let result = run(env::args().collect());
 859     process::exit(result as i32);
 860 }