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 }
 100
 101 pub mod lib {
 102     pub mod llvm;
 103 }
 104
 105 // A curious inner module that allows ::std::foo to be available in here for
 106 // macros.
 107 /*
 108 mod std {
 109     pub use std::clone;
 110     pub use std::cmp;
 111     pub use std::os;
 112     pub use std::str;
 113     pub use std::sys;
 114     pub use std::to_bytes;
 115     pub use std::unstable;
 116     pub use extra::serialize;
 117 }
 118 */
 119
 120 #[cfg(stage0)]
 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 #[cfg(not(stage0))]
 130 pub fn version(argv0: &str) {
 131     let vers = match option_env!("CFG_VERSION") {
 132         Some(vers) => vers,
 133         None => "unknown version"
 134     };
 135     printfln!("%s %s", argv0, vers);
 136     printfln!("host: %s", host_triple());
 137 }
 138
 139 pub fn usage(argv0: &str) {
 140     let message = fmt!("Usage: %s [OPTIONS] INPUT", argv0);
 141     printfln!("%s\
 142 Additional help:
 143     -W help             Print 'lint' options and default settings
 144     -Z help             Print internal options for debugging rustc\n",
 145               groups::usage(message, optgroups()));
 146 }
 147
 148 pub fn describe_warnings() {
 149     use extra::sort::Sort;
 150     println("
 151 Available lint options:
 152     -W <foo>           Warn about <foo>
 153     -A <foo>           Allow <foo>
 154     -D <foo>           Deny <foo>
 155     -F <foo>           Forbid <foo> (deny, and deny all overrides)
 156 ");
 157
 158     let lint_dict = lint::get_lint_dict();
 159     let mut lint_dict = lint_dict.move_iter()
 160                                  .map(|(k, v)| (v, k))
 161                                  .collect::<~[(lint::LintSpec, &'static str)]>();
 162     lint_dict.qsort();
 163
 164     let mut max_key = 0;
 165     for &(_, name) in lint_dict.iter() {
 166         max_key = num::max(name.len(), max_key);
 167     }
 168     fn padded(max: uint, s: &str) -> ~str {
 169         str::from_bytes(vec::from_elem(max - s.len(), ' ' as u8)) + s
 170     }
 171     println("\nAvailable lint checks:\n");
 172     printfln!("    %s  %7.7s  %s",
 173               padded(max_key, "name"), "default", "meaning");
 174     printfln!("    %s  %7.7s  %s\n",
 175               padded(max_key, "----"), "-------", "-------");
 176     for (spec, name) in lint_dict.move_iter() {
 177         let name = name.replace("_", "-");
 178         printfln!("    %s  %7.7s  %s",
 179                   padded(max_key, name),
 180                   lint::level_to_str(spec.default),
 181                   spec.desc);
 182     }
 183     io::println("");
 184 }
 185
 186 pub fn describe_debug_flags() {
 187     println("\nAvailable debug options:\n");
 188     let r = session::debugging_opts_map();
 189     for tuple in r.iter() {
 190         match *tuple {
 191             (ref name, ref desc, _) => {
 192                 printfln!("    -Z %-20s -- %s", *name, *desc);
 193             }
 194         }
 195     }
 196 }
 197
 198 pub fn run_compiler(args: &~[~str], demitter: diagnostic::Emitter) {
 199     // Don't display log spew by default. Can override with RUST_LOG.
 200     ::std::logging::console_off();
 201
 202     let mut args = (*args).clone();
 203     let binary = args.shift().to_managed();
 204
 205     if args.is_empty() { usage(binary); return; }
 206
 207     let matches =
 208         &match getopts::groups::getopts(args, optgroups()) {
 209           Ok(m) => m,
 210           Err(f) => {
 211             early_error(demitter, getopts::fail_str(f));
 212           }
 213         };
 214
 215     if opt_present(matches, "h") || opt_present(matches, "help") {
 216         usage(binary);
 217         return;
 218     }
 219
 220     // Display the available lint options if "-W help" or only "-W" is given.
 221     let lint_flags = vec::append(getopts::opt_strs(matches, "W"),
 222                                  getopts::opt_strs(matches, "warn"));
 223
 224     let show_lint_options = lint_flags.iter().any(|x| x == &~"help") ||
 225         (opt_present(matches, "W") && lint_flags.is_empty());
 226
 227     if show_lint_options {
 228         describe_warnings();
 229         return;
 230     }
 231
 232     let r = getopts::opt_strs(matches, "Z");
 233     if r.iter().any(|x| x == &~"help") {
 234         describe_debug_flags();
 235         return;
 236     }
 237
 238     if getopts::opt_maybe_str(matches, "passes") == Some(~"list") {
 239         back::passes::list_passes();
 240         return;
 241     }
 242
 243     if opt_present(matches, "v") || opt_present(matches, "version") {
 244         version(binary);
 245         return;
 246     }
 247     let input = match matches.free.len() {
 248       0u => early_error(demitter, ~"no input filename given"),
 249       1u => {
 250         let ifile = matches.free[0].as_slice();
 251         if "-" == ifile {
 252             let src = str::from_bytes(io::stdin().read_whole_stream());
 253             str_input(src.to_managed())
 254         } else {
 255             file_input(Path(ifile))
 256         }
 257       }
 258       _ => early_error(demitter, ~"multiple input filenames provided")
 259     };
 260
 261     let sopts = build_session_options(binary, matches, demitter);
 262     let sess = build_session(sopts, demitter);
 263     let odir = getopts::opt_maybe_str(matches, "out-dir").map_move(|o| Path(o));
 264     let ofile = getopts::opt_maybe_str(matches, "o").map_move(|o| Path(o));
 265     let cfg = build_configuration(sess, binary, &input);
 266     let pretty = do getopts::opt_default(matches, "pretty", "normal").map_move |a| {
 267         parse_pretty(sess, a)
 268     };
 269     match pretty {
 270       Some::<pp_mode>(ppm) => {
 271         pretty_print_input(sess, cfg, &input, ppm);
 272         return;
 273       }
 274       None::<pp_mode> => {/* continue */ }
 275     }
 276     let ls = opt_present(matches, "ls");
 277     if ls {
 278         match input {
 279           file_input(ref ifile) => {
 280             list_metadata(sess, &(*ifile), io::stdout());
 281           }
 282           str_input(_) => {
 283             early_error(demitter, ~"can not list metadata for stdin");
 284           }
 285         }
 286         return;
 287     }
 288
 289     compile_input(sess, cfg, &input, &odir, &ofile);
 290 }
 291
 292 #[deriving(Eq)]
 293 pub enum monitor_msg {
 294     fatal,
 295     done,
 296 }
 297
 298 /*
 299 This is a sanity check that any failure of the compiler is performed
 300 through the diagnostic module and reported properly - we shouldn't be calling
 301 plain-old-fail on any execution path that might be taken. Since we have
 302 console logging off by default, hitting a plain fail statement would make the
 303 compiler silently exit, which would be terrible.
 304
 305 This method wraps the compiler in a subtask and injects a function into the
 306 diagnostic emitter which records when we hit a fatal error. If the task
 307 fails without recording a fatal error then we've encountered a compiler
 308 bug and need to present an error.
 309 */
 310 pub fn monitor(f: ~fn(diagnostic::Emitter)) {
 311     use std::comm::*;
 312
 313     // XXX: This is a hack for newsched since it doesn't support split stacks.
 314     // rustc needs a lot of stack!
 315     static STACK_SIZE: uint = 6000000;
 316
 317     let (p, ch) = stream();
 318     let ch = SharedChan::new(ch);
 319     let ch_capture = ch.clone();
 320     let mut task_builder = task::task();
 321     task_builder.supervised();
 322
 323     // XXX: Hacks on hacks. If the env is trying to override the stack size
 324     // then *don't* set it explicitly.
 325     if os::getenv("RUST_MIN_STACK").is_none() {
 326         task_builder.opts.stack_size = Some(STACK_SIZE);
 327     }
 328
 329     match do task_builder.try {
 330         let ch = ch_capture.clone();
 331         let ch_capture = ch.clone();
 332         // The 'diagnostics emitter'. Every error, warning, etc. should
 333         // go through this function.
 334         let demitter: @fn(Option<(@codemap::CodeMap, codemap::span)>,
 335                           &str,
 336                           diagnostic::level) =
 337                           |cmsp, msg, lvl| {
 338             if lvl == diagnostic::fatal {
 339                 ch_capture.send(fatal);
 340             }
 341             diagnostic::emit(cmsp, msg, lvl);
 342         };
 343
 344         struct finally {
 345             ch: SharedChan<monitor_msg>,
 346         }
 347
 348         impl Drop for finally {
 349             fn drop(&self) { self.ch.send(done); }
 350         }
 351
 352         let _finally = finally { ch: ch };
 353
 354         f(demitter);
 355
 356         // Due reasons explain in #7732, if there was a jit execution context it
 357         // must be consumed and passed along to our parent task.
 358         back::link::jit::consume_engine()
 359     } {
 360         result::Ok(_) => { /* fallthrough */ }
 361         result::Err(_) => {
 362             // Task failed without emitting a fatal diagnostic
 363             if p.recv() == done {
 364                 diagnostic::emit(
 365                     None,
 366                     diagnostic::ice_msg("unexpected failure"),
 367                     diagnostic::error);
 368
 369                 let xs = [
 370                     ~"the compiler hit an unexpected failure path. \
 371                      this is a bug",
 372                     ~"try running with RUST_LOG=rustc=1,::rt::backtrace \
 373                      to get further details and report the results \
 374                      to github.com/mozilla/rust/issues"
 375                 ];
 376                 for note in xs.iter() {
 377                     diagnostic::emit(None, *note, diagnostic::note)
 378                 }
 379             }
 380             // Fail so the process returns a failure code
 381             fail!();
 382         }
 383     }
 384 }
 385
 386 pub fn main() {
 387     let args = os::args();
 388     do monitor |demitter| {
 389         run_compiler(&args, demitter);
 390     }
 391 }