src/librustc/rustc.rs

   1 // Copyright 2012-2013 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 #[link(name = "rustc",
  12        vers = "0.8-pre",
  13        uuid = "0ce89b41-2f92-459e-bbc1-8f5fe32f16cf",
  14        url = "https://github.com/mozilla/rust/tree/master/src/rustc")];
  15
  16 #[comment = "The Rust compiler"];
  17 #[license = "MIT/ASL2"];
  18 #[crate_type = "lib"];
  19
  20 extern mod extra;
  21 extern mod syntax;
  22
  23 use driver::driver::{host_triple, optgroups, early_error};
  24 use driver::driver::{str_input, file_input, build_session_options};
  25 use driver::driver::{build_session, build_configuration, parse_pretty};
  26 use driver::driver::{pp_mode, pretty_print_input, list_metadata};
  27 use driver::driver::{compile_input};
  28 use driver::session;
  29 use middle::lint;
  30
  31 use std::io;
  32 use std::num;
  33 use std::os;
  34 use std::result;
  35 use std::str;
  36 use std::task;
  37 use std::vec;
  38 use extra::getopts::{groups, opt_present};
  39 use extra::getopts;
  40 use syntax::codemap;
  41 use syntax::diagnostic;
  42
  43 pub mod middle {
  44     pub mod trans;
  45     pub mod ty;
  46     pub mod subst;
  47     pub mod resolve;
  48     pub mod typeck;
  49     pub mod check_loop;
  50     pub mod check_match;
  51     pub mod check_const;
  52     pub mod lint;
  53     pub mod borrowck;
  54     pub mod dataflow;
  55     pub mod mem_categorization;
  56     pub mod liveness;
  57     pub mod kind;
  58     pub mod freevars;
  59     pub mod pat_util;
  60     pub mod region;
  61     pub mod const_eval;
  62     pub mod astencode;
  63     pub mod lang_items;
  64     pub mod privacy;
  65     pub mod moves;
  66     pub mod entry;
  67     pub mod effect;
  68     pub mod reachable;
  69     pub mod graph;
  70     pub mod cfg;
  71 }
  72
  73 pub mod front {
  74     pub mod config;
  75     pub mod test;
  76     pub mod std_inject;
  77 }
  78
  79 pub mod back {
  80     pub mod link;
  81     pub mod abi;
  82     pub mod upcall;
  83     pub mod arm;
  84     pub mod mips;
  85     pub mod x86;
  86     pub mod x86_64;
  87     pub mod rpath;
  88     pub mod target_strs;
  89     pub mod passes;
  90 }
  91
  92 pub mod metadata;
  93
  94 pub mod driver;
  95
  96 pub mod util {
  97     pub mod common;
  98     pub mod ppaux;
  99     pub mod enum_set;
 100 }
 101
 102 pub mod lib {
 103     pub mod llvm;
 104 }
 105
 106 // A curious inner module that allows ::std::foo to be available in here for
 107 // macros.
 108 /*
 109 mod std {
 110     pub use std::clone;
 111     pub use std::cmp;
 112     pub use std::os;
 113     pub use std::str;
 114     pub use std::sys;
 115     pub use std::to_bytes;
 116     pub use std::unstable;
 117     pub use extra::serialize;
 118 }
 119 */
 120
 121 pub fn version(argv0: &str) {
 122     let mut vers = ~"unknown version";
 123     let env_vers = env!("CFG_VERSION");
 124     if env_vers.len() != 0 { vers = env_vers.to_owned(); }
 125     printfln!("%s %s", argv0, vers);
 126     printfln!("host: %s", host_triple());
 127 }
 128
 129 pub fn usage(argv0: &str) {
 130     let message = fmt!("Usage: %s [OPTIONS] INPUT", argv0);
 131     printfln!("%s\
 132 Additional help:
 133     -W help             Print 'lint' options and default settings
 134     -Z help             Print internal options for debugging rustc\n",
 135               groups::usage(message, optgroups()));
 136 }
 137
 138 pub fn describe_warnings() {
 139     use extra::sort::Sort;
 140     printfln!("
 141 Available lint options:
 142     -W <foo>           Warn about <foo>
 143     -A <foo>           Allow <foo>
 144     -D <foo>           Deny <foo>
 145     -F <foo>           Forbid <foo> (deny, and deny all overrides)
 146 ");
 147
 148     let lint_dict = lint::get_lint_dict();
 149     let mut lint_dict = lint_dict.consume()
 150                                  .transform(|(k, v)| (v, k))
 151                                  .collect::<~[(lint::LintSpec, &'static str)]>();
 152     lint_dict.qsort();
 153
 154     let mut max_key = 0;
 155     for &(_, name) in lint_dict.iter() {
 156         max_key = num::max(name.len(), max_key);
 157     }
 158     fn padded(max: uint, s: &str) -> ~str {
 159         str::from_bytes(vec::from_elem(max - s.len(), ' ' as u8)) + s
 160     }
 161     printfln!("\nAvailable lint checks:\n");
 162     printfln!("    %s  %7.7s  %s",
 163               padded(max_key, "name"), "default", "meaning");
 164     printfln!("    %s  %7.7s  %s\n",
 165               padded(max_key, "----"), "-------", "-------");
 166     for (spec, name) in lint_dict.consume_iter() {
 167         let name = name.replace("_", "-");
 168         printfln!("    %s  %7.7s  %s",
 169                   padded(max_key, name),
 170                   lint::level_to_str(spec.default),
 171                   spec.desc);
 172     }
 173     io::println("");
 174 }
 175
 176 pub fn describe_debug_flags() {
 177     printfln!("\nAvailable debug options:\n");
 178     let r = session::debugging_opts_map();
 179     for tuple in r.iter() {
 180         match *tuple {
 181             (ref name, ref desc, _) => {
 182                 printfln!("    -Z %-20s -- %s", *name, *desc);
 183             }
 184         }
 185     }
 186 }
 187
 188 pub fn run_compiler(args: &~[~str], demitter: diagnostic::Emitter) {
 189     // Don't display log spew by default. Can override with RUST_LOG.
 190     ::std::logging::console_off();
 191
 192     let mut args = (*args).clone();
 193     let binary = args.shift().to_managed();
 194
 195     if args.is_empty() { usage(binary); return; }
 196
 197     let matches =
 198         &match getopts::groups::getopts(args, optgroups()) {
 199           Ok(m) => m,
 200           Err(f) => {
 201             early_error(demitter, getopts::fail_str(f));
 202           }
 203         };
 204
 205     if opt_present(matches, "h") || opt_present(matches, "help") {
 206         usage(binary);
 207         return;
 208     }
 209
 210     // Display the available lint options if "-W help" or only "-W" is given.
 211     let lint_flags = vec::append(getopts::opt_strs(matches, "W"),
 212                                  getopts::opt_strs(matches, "warn"));
 213
 214     let show_lint_options = lint_flags.iter().any(|x| x == &~"help") ||
 215         (opt_present(matches, "W") && lint_flags.is_empty());
 216
 217     if show_lint_options {
 218         describe_warnings();
 219         return;
 220     }
 221
 222     let r = getopts::opt_strs(matches, "Z");
 223     if r.iter().any(|x| x == &~"help") {
 224         describe_debug_flags();
 225         return;
 226     }
 227
 228     if getopts::opt_maybe_str(matches, "passes") == Some(~"list") {
 229         back::passes::list_passes();
 230         return;
 231     }
 232
 233     if opt_present(matches, "v") || opt_present(matches, "version") {
 234         version(binary);
 235         return;
 236     }
 237     let input = match matches.free.len() {
 238       0u => early_error(demitter, ~"no input filename given"),
 239       1u => {
 240         let ifile = matches.free[0].as_slice();
 241         if "-" == ifile {
 242             let src = str::from_bytes(io::stdin().read_whole_stream());
 243             str_input(src.to_managed())
 244         } else {
 245             file_input(Path(ifile))
 246         }
 247       }
 248       _ => early_error(demitter, ~"multiple input filenames provided")
 249     };
 250
 251     let sopts = build_session_options(binary, matches, demitter);
 252     let sess = build_session(sopts, demitter);
 253     let odir = getopts::opt_maybe_str(matches, "out-dir");
 254     let odir = odir.map(|o| Path(*o));
 255     let ofile = getopts::opt_maybe_str(matches, "o");
 256     let ofile = ofile.map(|o| Path(*o));
 257     let cfg = build_configuration(sess, binary, &input);
 258     let pretty = getopts::opt_default(matches, "pretty", "normal").map(
 259                     |a| parse_pretty(sess, *a));
 260     match pretty {
 261       Some::<pp_mode>(ppm) => {
 262         pretty_print_input(sess, cfg, &input, ppm);
 263         return;
 264       }
 265       None::<pp_mode> => {/* continue */ }
 266     }
 267     let ls = opt_present(matches, "ls");
 268     if ls {
 269         match input {
 270           file_input(ref ifile) => {
 271             list_metadata(sess, &(*ifile), io::stdout());
 272           }
 273           str_input(_) => {
 274             early_error(demitter, ~"can not list metadata for stdin");
 275           }
 276         }
 277         return;
 278     }
 279
 280     compile_input(sess, cfg, &input, &odir, &ofile);
 281 }
 282
 283 #[deriving(Eq)]
 284 pub enum monitor_msg {
 285     fatal,
 286     done,
 287 }
 288
 289 /*
 290 This is a sanity check that any failure of the compiler is performed
 291 through the diagnostic module and reported properly - we shouldn't be calling
 292 plain-old-fail on any execution path that might be taken. Since we have
 293 console logging off by default, hitting a plain fail statement would make the
 294 compiler silently exit, which would be terrible.
 295
 296 This method wraps the compiler in a subtask and injects a function into the
 297 diagnostic emitter which records when we hit a fatal error. If the task
 298 fails without recording a fatal error then we've encountered a compiler
 299 bug and need to present an error.
 300 */
 301 pub fn monitor(f: ~fn(diagnostic::Emitter)) {
 302     use std::comm::*;
 303     let (p, ch) = stream();
 304     let ch = SharedChan::new(ch);
 305     let ch_capture = ch.clone();
 306     match do task::try || {
 307         let ch = ch_capture.clone();
 308         let ch_capture = ch.clone();
 309         // The 'diagnostics emitter'. Every error, warning, etc. should
 310         // go through this function.
 311         let demitter: @fn(Option<(@codemap::CodeMap, codemap::span)>,
 312                           &str,
 313                           diagnostic::level) =
 314                           |cmsp, msg, lvl| {
 315             if lvl == diagnostic::fatal {
 316                 ch_capture.send(fatal);
 317             }
 318             diagnostic::emit(cmsp, msg, lvl);
 319         };
 320
 321         struct finally {
 322             ch: SharedChan<monitor_msg>,
 323         }
 324
 325         impl Drop for finally {
 326             fn drop(&self) { self.ch.send(done); }
 327         }
 328
 329         let _finally = finally { ch: ch };
 330
 331         f(demitter);
 332
 333         // Due reasons explain in #7732, if there was a jit execution context it
 334         // must be consumed and passed along to our parent task.
 335         back::link::jit::consume_engine()
 336     } {
 337         result::Ok(_) => { /* fallthrough */ }
 338         result::Err(_) => {
 339             // Task failed without emitting a fatal diagnostic
 340             if p.recv() == done {
 341                 diagnostic::emit(
 342                     None,
 343                     diagnostic::ice_msg("unexpected failure"),
 344                     diagnostic::error);
 345
 346                 let xs = [
 347                     ~"the compiler hit an unexpected failure path. \
 348                      this is a bug",
 349                     ~"try running with RUST_LOG=rustc=1,::rt::backtrace \
 350                      to get further details and report the results \
 351                      to github.com/mozilla/rust/issues"
 352                 ];
 353                 for note in xs.iter() {
 354                     diagnostic::emit(None, *note, diagnostic::note)
 355                 }
 356             }
 357             // Fail so the process returns a failure code
 358             fail!();
 359         }
 360     }
 361 }
 362
 363 pub fn main() {
 364     let args = os::args();
 365     do monitor |demitter| {
 366         run_compiler(&args, demitter);
 367     }
 368 }