]> git.lizzy.rs Git - rust.git/blob - src/librustc_driver/lib.rs
Rollup merge of #47721 - GuillaumeGomez:experimental-color, r=QuietMisdreavus
[rust.git] / 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 #![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/")]
20 #![deny(warnings)]
21
22 #![feature(box_syntax)]
23 #![cfg_attr(unix, feature(libc))]
24 #![feature(quote)]
25 #![feature(rustc_diagnostic_macros)]
26 #![feature(set_stdio)]
27
28 extern crate arena;
29 extern crate getopts;
30 extern crate graphviz;
31 extern crate env_logger;
32 #[cfg(unix)]
33 extern crate libc;
34 extern crate rustc;
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 pub extern crate rustc_trans;
52 extern crate rustc_trans_utils;
53 extern crate rustc_typeck;
54 extern crate serialize;
55 #[macro_use]
56 extern crate log;
57 extern crate syntax;
58 extern crate syntax_ext;
59 extern crate syntax_pos;
60
61 use driver::CompileController;
62 use pretty::{PpMode, UserIdentifiedItem};
63
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, ErrorOutputType};
70 use rustc::session::config::nightly_options;
71 use rustc::session::{early_error, early_warn};
72 use rustc::lint::Lint;
73 use rustc::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;
79
80 use serialize::json::ToJson;
81
82 use std::any::Any;
83 use std::cmp::max;
84 use std::cmp::Ordering::Equal;
85 use std::default::Default;
86 use std::env;
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};
92 use std::rc::Rc;
93 use std::str;
94 use std::sync::{Arc, Mutex};
95 use std::thread;
96
97 use syntax::ast;
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, FileName};
102
103 #[cfg(test)]
104 mod test;
105
106 pub mod profile;
107 pub mod driver;
108 pub mod pretty;
109 mod derive_registrar;
110
111 pub mod target_features {
112     use syntax::ast;
113     use syntax::symbol::Symbol;
114     use rustc::session::Session;
115     use rustc_trans_utils::trans_crate::TransCrate;
116
117     /// Add `target_feature = "..."` cfgs for a variety of platform
118     /// specific features (SSE, NEON etc.).
119     ///
120     /// This is performed by checking whether a whitelisted set of
121     /// features is available on the target machine, by querying LLVM.
122     pub fn add_configuration(cfg: &mut ast::CrateConfig, sess: &Session, trans: &TransCrate) {
123         let tf = Symbol::intern("target_feature");
124
125         for feat in trans.target_features(sess) {
126             cfg.insert((tf, Some(feat)));
127         }
128
129         if sess.crt_static_feature() {
130             cfg.insert((tf, Some(Symbol::intern("crt-static"))));
131         }
132     }
133 }
134
135 const BUG_REPORT_URL: &'static str = "https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.\
136                                       md#bug-reports";
137
138 pub fn abort_on_err<T>(result: Result<T, CompileIncomplete>, sess: &Session) -> T {
139     match result {
140         Err(CompileIncomplete::Errored(ErrorReported)) => {
141             sess.abort_if_errors();
142             panic!("error reported but abort_if_errors didn't abort???");
143         }
144         Err(CompileIncomplete::Stopped) => {
145             sess.fatal("compilation terminated");
146         }
147         Ok(x) => x,
148     }
149 }
150
151 pub fn run<F>(run_compiler: F) -> isize
152     where F: FnOnce() -> (CompileResult, Option<Session>) + Send + 'static
153 {
154     monitor(move || {
155         let (result, session) = run_compiler();
156         if let Err(CompileIncomplete::Errored(_)) = result {
157             match session {
158                 Some(sess) => {
159                     sess.abort_if_errors();
160                     panic!("error reported but abort_if_errors didn't abort???");
161                 }
162                 None => {
163                     let emitter =
164                         errors::emitter::EmitterWriter::stderr(errors::ColorConfig::Auto,
165                                                                None,
166                                                                true);
167                     let handler = errors::Handler::with_emitter(true, false, Box::new(emitter));
168                     handler.emit(&MultiSpan::new(),
169                                  "aborting due to previous error(s)",
170                                  errors::Level::Fatal);
171                     exit_on_err();
172                 }
173             }
174         }
175     });
176     0
177 }
178
179 #[cfg(not(feature="llvm"))]
180 pub use rustc_trans_utils::trans_crate::MetadataOnlyTransCrate as DefaultTransCrate;
181 #[cfg(feature="llvm")]
182 pub use rustc_trans::LlvmTransCrate as DefaultTransCrate;
183
184 #[cfg(not(feature="llvm"))]
185 pub mod rustc_trans {
186     pub use rustc_trans_utils::trans_crate::MetadataOnlyTransCrate as LlvmTransCrate;
187
188     pub fn print_version() {}
189     pub fn print_passes() {}
190 }
191
192 fn load_backend_from_dylib(sess: &Session, backend_name: &str) -> Box<TransCrate> {
193     use std::path::Path;
194     use rustc_metadata::dynamic_lib::DynamicLibrary;
195
196     match DynamicLibrary::open(Some(Path::new(backend_name))) {
197         Ok(lib) => {
198             unsafe {
199                 let trans = {
200                     let __rustc_codegen_backend: unsafe fn(&Session) -> Box<TransCrate>;
201                     __rustc_codegen_backend = match lib.symbol("__rustc_codegen_backend") {
202                         Ok(f) => ::std::mem::transmute::<*mut u8, _>(f),
203                         Err(e) => sess.fatal(&format!("Couldnt load codegen backend as it\
204                         doesn't export the __rustc_backend_new symbol: {:?}", e)),
205                     };
206                     __rustc_codegen_backend(sess)
207                 };
208                 ::std::mem::forget(lib);
209                 trans
210             }
211         }
212         Err(err) => {
213             sess.fatal(&format!("Couldnt load codegen backend {:?}: {:?}", backend_name, err));
214         }
215     }
216 }
217
218 pub fn get_trans(sess: &Session) -> Box<TransCrate> {
219     let trans_name = sess.opts.debugging_opts.codegen_backend.clone();
220     match trans_name.as_ref().map(|s|&**s) {
221         None => DefaultTransCrate::new(&sess),
222         Some("llvm") => rustc_trans::LlvmTransCrate::new(&sess),
223         Some("metadata_only") => {
224             rustc_trans_utils::trans_crate::MetadataOnlyTransCrate::new(&sess)
225         }
226         Some(filename) if filename.contains(".") => {
227             load_backend_from_dylib(&sess, &filename)
228         }
229         Some(trans_name) => sess.fatal(&format!("Unknown codegen backend {}", trans_name)),
230     }
231 }
232
233 // Parse args and run the compiler. This is the primary entry point for rustc.
234 // See comments on CompilerCalls below for details about the callbacks argument.
235 // The FileLoader provides a way to load files from sources other than the file system.
236 pub fn run_compiler<'a>(args: &[String],
237                         callbacks: &mut CompilerCalls<'a>,
238                         file_loader: Option<Box<FileLoader + 'static>>,
239                         emitter_dest: Option<Box<Write + Send>>)
240                         -> (CompileResult, Option<Session>)
241 {
242     macro_rules! do_or_return {($expr: expr, $sess: expr) => {
243         match $expr {
244             Compilation::Stop => return (Ok(()), $sess),
245             Compilation::Continue => {}
246         }
247     }}
248
249     let matches = match handle_options(args) {
250         Some(matches) => matches,
251         None => return (Ok(()), None),
252     };
253
254     let (sopts, cfg) = config::build_session_options_and_crate_config(&matches);
255
256     let descriptions = diagnostics_registry();
257
258     do_or_return!(callbacks.early_callback(&matches,
259                                            &sopts,
260                                            &cfg,
261                                            &descriptions,
262                                            sopts.error_format),
263                                            None);
264
265     let (odir, ofile) = make_output(&matches);
266     let (input, input_file_path) = match make_input(&matches.free) {
267         Some((input, input_file_path)) => callbacks.some_input(input, input_file_path),
268         None => match callbacks.no_input(&matches, &sopts, &cfg, &odir, &ofile, &descriptions) {
269             Some((input, input_file_path)) => (input, input_file_path),
270             None => return (Ok(()), None),
271         },
272     };
273
274     let loader = file_loader.unwrap_or(box RealFileLoader);
275     let codemap = Rc::new(CodeMap::with_file_loader(loader, sopts.file_path_mapping()));
276     let mut sess = session::build_session_with_codemap(
277         sopts, input_file_path.clone(), descriptions, codemap, emitter_dest,
278     );
279
280     let trans = get_trans(&sess);
281
282     rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
283
284     let mut cfg = config::build_configuration(&sess, cfg);
285     target_features::add_configuration(&mut cfg, &sess, &*trans);
286     sess.parse_sess.config = cfg;
287
288     let plugins = sess.opts.debugging_opts.extra_plugins.clone();
289
290     let cstore = CStore::new(trans.metadata_loader());
291
292     do_or_return!(callbacks.late_callback(&*trans,
293                                           &matches,
294                                           &sess,
295                                           &cstore,
296                                           &input,
297                                           &odir,
298                                           &ofile), Some(sess));
299
300     let control = callbacks.build_controller(&sess, &matches);
301
302     (driver::compile_input(trans,
303                            &sess,
304                            &cstore,
305                            &input_file_path,
306                            &input,
307                            &odir,
308                            &ofile,
309                            Some(plugins),
310                            &control),
311      Some(sess))
312 }
313
314 // Extract output directory and file from matches.
315 fn make_output(matches: &getopts::Matches) -> (Option<PathBuf>, Option<PathBuf>) {
316     let odir = matches.opt_str("out-dir").map(|o| PathBuf::from(&o));
317     let ofile = matches.opt_str("o").map(|o| PathBuf::from(&o));
318     (odir, ofile)
319 }
320
321 // Extract input (string or file and optional path) from matches.
322 fn make_input(free_matches: &[String]) -> Option<(Input, Option<PathBuf>)> {
323     if free_matches.len() == 1 {
324         let ifile = &free_matches[0];
325         if ifile == "-" {
326             let mut src = String::new();
327             io::stdin().read_to_string(&mut src).unwrap();
328             Some((Input::Str { name: FileName::Anon, input: src },
329                   None))
330         } else {
331             Some((Input::File(PathBuf::from(ifile)),
332                   Some(PathBuf::from(ifile))))
333         }
334     } else {
335         None
336     }
337 }
338
339 fn parse_pretty(sess: &Session,
340                 matches: &getopts::Matches)
341                 -> Option<(PpMode, Option<UserIdentifiedItem>)> {
342     let pretty = if sess.opts.debugging_opts.unstable_options {
343         matches.opt_default("pretty", "normal").map(|a| {
344             // stable pretty-print variants only
345             pretty::parse_pretty(sess, &a, false)
346         })
347     } else {
348         None
349     };
350
351     if pretty.is_none() {
352         sess.opts.debugging_opts.unpretty.as_ref().map(|a| {
353             // extended with unstable pretty-print variants
354             pretty::parse_pretty(sess, &a, true)
355         })
356     } else {
357         pretty
358     }
359 }
360
361 // Whether to stop or continue compilation.
362 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
363 pub enum Compilation {
364     Stop,
365     Continue,
366 }
367
368 impl Compilation {
369     pub fn and_then<F: FnOnce() -> Compilation>(self, next: F) -> Compilation {
370         match self {
371             Compilation::Stop => Compilation::Stop,
372             Compilation::Continue => next(),
373         }
374     }
375 }
376
377 // A trait for customising the compilation process. Offers a number of hooks for
378 // executing custom code or customising input.
379 pub trait CompilerCalls<'a> {
380     // Hook for a callback early in the process of handling arguments. This will
381     // be called straight after options have been parsed but before anything
382     // else (e.g., selecting input and output).
383     fn early_callback(&mut self,
384                       _: &getopts::Matches,
385                       _: &config::Options,
386                       _: &ast::CrateConfig,
387                       _: &errors::registry::Registry,
388                       _: ErrorOutputType)
389                       -> Compilation {
390         Compilation::Continue
391     }
392
393     // Hook for a callback late in the process of handling arguments. This will
394     // be called just before actual compilation starts (and before build_controller
395     // is called), after all arguments etc. have been completely handled.
396     fn late_callback(&mut self,
397                      _: &TransCrate,
398                      _: &getopts::Matches,
399                      _: &Session,
400                      _: &CrateStore,
401                      _: &Input,
402                      _: &Option<PathBuf>,
403                      _: &Option<PathBuf>)
404                      -> Compilation {
405         Compilation::Continue
406     }
407
408     // Called after we extract the input from the arguments. Gives the implementer
409     // an opportunity to change the inputs or to add some custom input handling.
410     // The default behaviour is to simply pass through the inputs.
411     fn some_input(&mut self,
412                   input: Input,
413                   input_path: Option<PathBuf>)
414                   -> (Input, Option<PathBuf>) {
415         (input, input_path)
416     }
417
418     // Called after we extract the input from the arguments if there is no valid
419     // input. Gives the implementer an opportunity to supply alternate input (by
420     // returning a Some value) or to add custom behaviour for this error such as
421     // emitting error messages. Returning None will cause compilation to stop
422     // at this point.
423     fn no_input(&mut self,
424                 _: &getopts::Matches,
425                 _: &config::Options,
426                 _: &ast::CrateConfig,
427                 _: &Option<PathBuf>,
428                 _: &Option<PathBuf>,
429                 _: &errors::registry::Registry)
430                 -> Option<(Input, Option<PathBuf>)> {
431         None
432     }
433
434     // Create a CompilController struct for controlling the behaviour of
435     // compilation.
436     fn build_controller(&mut self, _: &Session, _: &getopts::Matches) -> CompileController<'a>;
437 }
438
439 // CompilerCalls instance for a regular rustc build.
440 #[derive(Copy, Clone)]
441 pub struct RustcDefaultCalls;
442
443 // FIXME remove these and use winapi 0.3 instead
444 // Duplicates: bootstrap/compile.rs, librustc_errors/emitter.rs
445 #[cfg(unix)]
446 fn stdout_isatty() -> bool {
447     unsafe { libc::isatty(libc::STDOUT_FILENO) != 0 }
448 }
449
450 #[cfg(windows)]
451 fn stdout_isatty() -> bool {
452     type DWORD = u32;
453     type BOOL = i32;
454     type HANDLE = *mut u8;
455     type LPDWORD = *mut u32;
456     const STD_OUTPUT_HANDLE: DWORD = -11i32 as DWORD;
457     extern "system" {
458         fn GetStdHandle(which: DWORD) -> HANDLE;
459         fn GetConsoleMode(hConsoleHandle: HANDLE, lpMode: LPDWORD) -> BOOL;
460     }
461     unsafe {
462         let handle = GetStdHandle(STD_OUTPUT_HANDLE);
463         let mut out = 0;
464         GetConsoleMode(handle, &mut out) != 0
465     }
466 }
467
468 fn handle_explain(code: &str,
469                   descriptions: &errors::registry::Registry,
470                   output: ErrorOutputType) {
471     let normalised = if code.starts_with("E") {
472         code.to_string()
473     } else {
474         format!("E{0:0>4}", code)
475     };
476     match descriptions.find_description(&normalised) {
477         Some(ref description) => {
478             let mut is_in_code_block = false;
479             let mut text = String::new();
480
481             // Slice off the leading newline and print.
482             for line in description[1..].lines() {
483                 let indent_level = line.find(|c: char| !c.is_whitespace())
484                     .unwrap_or_else(|| line.len());
485                 let dedented_line = &line[indent_level..];
486                 if dedented_line.starts_with("```") {
487                     is_in_code_block = !is_in_code_block;
488                     text.push_str(&line[..(indent_level+3)]);
489                 } else if is_in_code_block && dedented_line.starts_with("# ") {
490                     continue;
491                 } else {
492                     text.push_str(line);
493                 }
494                 text.push('\n');
495             }
496
497             if stdout_isatty() {
498                 show_content_with_pager(&text);
499             } else {
500                 print!("{}", text);
501             }
502         }
503         None => {
504             early_error(output, &format!("no extended information for {}", code));
505         }
506     }
507 }
508
509 fn show_content_with_pager(content: &String) {
510     let pager_name = env::var_os("PAGER").unwrap_or_else(|| if cfg!(windows) {
511         OsString::from("more.com")
512     } else {
513         OsString::from("less")
514     });
515
516     let mut fallback_to_println = false;
517
518     match Command::new(pager_name).stdin(Stdio::piped()).spawn() {
519         Ok(mut pager) => {
520             if let Some(pipe) = pager.stdin.as_mut() {
521                 if pipe.write_all(content.as_bytes()).is_err() {
522                     fallback_to_println = true;
523                 }
524             }
525
526             if pager.wait().is_err() {
527                 fallback_to_println = true;
528             }
529         }
530         Err(_) => {
531             fallback_to_println = true;
532         }
533     }
534
535     // If pager fails for whatever reason, we should still print the content
536     // to standard output
537     if fallback_to_println {
538         print!("{}", content);
539     }
540 }
541
542 impl<'a> CompilerCalls<'a> for RustcDefaultCalls {
543     fn early_callback(&mut self,
544                       matches: &getopts::Matches,
545                       _: &config::Options,
546                       _: &ast::CrateConfig,
547                       descriptions: &errors::registry::Registry,
548                       output: ErrorOutputType)
549                       -> Compilation {
550         if let Some(ref code) = matches.opt_str("explain") {
551             handle_explain(code, descriptions, output);
552             return Compilation::Stop;
553         }
554
555         Compilation::Continue
556     }
557
558     fn no_input(&mut self,
559                 matches: &getopts::Matches,
560                 sopts: &config::Options,
561                 cfg: &ast::CrateConfig,
562                 odir: &Option<PathBuf>,
563                 ofile: &Option<PathBuf>,
564                 descriptions: &errors::registry::Registry)
565                 -> Option<(Input, Option<PathBuf>)> {
566         match matches.free.len() {
567             0 => {
568                 if sopts.describe_lints {
569                     let mut ls = lint::LintStore::new();
570                     rustc_lint::register_builtins(&mut ls, None);
571                     describe_lints(&ls, false);
572                     return None;
573                 }
574                 let mut sess = build_session(sopts.clone(),
575                     None,
576                     descriptions.clone());
577                 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
578                 let mut cfg = config::build_configuration(&sess, cfg.clone());
579                 let trans = get_trans(&sess);
580                 target_features::add_configuration(&mut cfg, &sess, &*trans);
581                 sess.parse_sess.config = cfg;
582                 let should_stop = RustcDefaultCalls::print_crate_info(
583                     &*trans,
584                     &sess,
585                     None,
586                     odir,
587                     ofile
588                 );
589
590                 if should_stop == Compilation::Stop {
591                     return None;
592                 }
593                 early_error(sopts.error_format, "no input filename given");
594             }
595             1 => panic!("make_input should have provided valid inputs"),
596             _ => early_error(sopts.error_format, "multiple input filenames provided"),
597         }
598     }
599
600     fn late_callback(&mut self,
601                      trans: &TransCrate,
602                      matches: &getopts::Matches,
603                      sess: &Session,
604                      cstore: &CrateStore,
605                      input: &Input,
606                      odir: &Option<PathBuf>,
607                      ofile: &Option<PathBuf>)
608                      -> Compilation {
609         RustcDefaultCalls::print_crate_info(trans, sess, Some(input), odir, ofile)
610             .and_then(|| RustcDefaultCalls::list_metadata(sess, cstore, matches, input))
611     }
612
613     fn build_controller(&mut self,
614                         sess: &Session,
615                         matches: &getopts::Matches)
616                         -> CompileController<'a> {
617         let mut control = CompileController::basic();
618
619         control.keep_ast = sess.opts.debugging_opts.keep_ast;
620         control.continue_parse_after_error = sess.opts.debugging_opts.continue_parse_after_error;
621
622         if let Some((ppm, opt_uii)) = parse_pretty(sess, matches) {
623             if ppm.needs_ast_map(&opt_uii) {
624                 control.after_hir_lowering.stop = Compilation::Stop;
625
626                 control.after_parse.callback = box move |state| {
627                     state.krate = Some(pretty::fold_crate(state.session,
628                                                           state.krate.take().unwrap(),
629                                                           ppm));
630                 };
631                 control.after_hir_lowering.callback = box move |state| {
632                     pretty::print_after_hir_lowering(state.session,
633                                                      state.cstore.unwrap(),
634                                                      state.hir_map.unwrap(),
635                                                      state.analysis.unwrap(),
636                                                      state.resolutions.unwrap(),
637                                                      state.input,
638                                                      &state.expanded_crate.take().unwrap(),
639                                                      state.crate_name.unwrap(),
640                                                      ppm,
641                                                      state.arenas.unwrap(),
642                                                      state.output_filenames.unwrap(),
643                                                      opt_uii.clone(),
644                                                      state.out_file);
645                 };
646             } else {
647                 control.after_parse.stop = Compilation::Stop;
648
649                 control.after_parse.callback = box move |state| {
650                     let krate = pretty::fold_crate(state.session, state.krate.take().unwrap(), ppm);
651                     pretty::print_after_parsing(state.session,
652                                                 state.input,
653                                                 &krate,
654                                                 ppm,
655                                                 state.out_file);
656                 };
657             }
658
659             return control;
660         }
661
662         if sess.opts.debugging_opts.parse_only ||
663            sess.opts.debugging_opts.show_span.is_some() ||
664            sess.opts.debugging_opts.ast_json_noexpand {
665             control.after_parse.stop = Compilation::Stop;
666         }
667
668         if sess.opts.debugging_opts.no_analysis ||
669            sess.opts.debugging_opts.ast_json {
670             control.after_hir_lowering.stop = Compilation::Stop;
671         }
672
673         if sess.opts.debugging_opts.save_analysis {
674             enable_save_analysis(&mut control);
675         }
676
677         if sess.print_fuel_crate.is_some() {
678             let old_callback = control.compilation_done.callback;
679             control.compilation_done.callback = box move |state| {
680                 old_callback(state);
681                 let sess = state.session;
682                 println!("Fuel used by {}: {}",
683                     sess.print_fuel_crate.as_ref().unwrap(),
684                     sess.print_fuel.get());
685             }
686         }
687         control
688     }
689 }
690
691 pub fn enable_save_analysis(control: &mut CompileController) {
692     control.keep_ast = true;
693     control.after_analysis.callback = box |state| {
694         time(state.session.time_passes(), "save analysis", || {
695             save::process_crate(state.tcx.unwrap(),
696                                 state.expanded_crate.unwrap(),
697                                 state.analysis.unwrap(),
698                                 state.crate_name.unwrap(),
699                                 None,
700                                 DumpHandler::new(state.out_dir,
701                                                  state.crate_name.unwrap()))
702         });
703     };
704     control.after_analysis.run_callback_on_error = true;
705     control.make_glob_map = resolve::MakeGlobMap::Yes;
706 }
707
708 impl RustcDefaultCalls {
709     pub fn list_metadata(sess: &Session,
710                          cstore: &CrateStore,
711                          matches: &getopts::Matches,
712                          input: &Input)
713                          -> Compilation {
714         let r = matches.opt_strs("Z");
715         if r.contains(&("ls".to_string())) {
716             match input {
717                 &Input::File(ref ifile) => {
718                     let path = &(*ifile);
719                     let mut v = Vec::new();
720                     locator::list_file_metadata(&sess.target.target,
721                                                 path,
722                                                 cstore.metadata_loader(),
723                                                 &mut v)
724                             .unwrap();
725                     println!("{}", String::from_utf8(v).unwrap());
726                 }
727                 &Input::Str { .. } => {
728                     early_error(ErrorOutputType::default(), "cannot list metadata for stdin");
729                 }
730             }
731             return Compilation::Stop;
732         }
733
734         return Compilation::Continue;
735     }
736
737
738     fn print_crate_info(trans: &TransCrate,
739                         sess: &Session,
740                         input: Option<&Input>,
741                         odir: &Option<PathBuf>,
742                         ofile: &Option<PathBuf>)
743                         -> Compilation {
744         use rustc::session::config::PrintRequest::*;
745         // PrintRequest::NativeStaticLibs is special - printed during linking
746         // (empty iterator returns true)
747         if sess.opts.prints.iter().all(|&p| p==PrintRequest::NativeStaticLibs) {
748             return Compilation::Continue;
749         }
750
751         let attrs = match input {
752             None => None,
753             Some(input) => {
754                 let result = parse_crate_attrs(sess, input);
755                 match result {
756                     Ok(attrs) => Some(attrs),
757                     Err(mut parse_error) => {
758                         parse_error.emit();
759                         return Compilation::Stop;
760                     }
761                 }
762             }
763         };
764         for req in &sess.opts.prints {
765             match *req {
766                 TargetList => {
767                     let mut targets = rustc_back::target::get_targets().collect::<Vec<String>>();
768                     targets.sort();
769                     println!("{}", targets.join("\n"));
770                 },
771                 Sysroot => println!("{}", sess.sysroot().display()),
772                 TargetSpec => println!("{}", sess.target.target.to_json().pretty()),
773                 FileNames | CrateName => {
774                     let input = match input {
775                         Some(input) => input,
776                         None => early_error(ErrorOutputType::default(), "no input file provided"),
777                     };
778                     let attrs = attrs.as_ref().unwrap();
779                     let t_outputs = driver::build_output_filenames(input, odir, ofile, attrs, sess);
780                     let id = rustc_trans_utils::link::find_crate_name(Some(sess), attrs, input);
781                     if *req == PrintRequest::CrateName {
782                         println!("{}", id);
783                         continue;
784                     }
785                     let crate_types = driver::collect_crate_types(sess, attrs);
786                     for &style in &crate_types {
787                         let fname = rustc_trans_utils::link::filename_for_input(
788                             sess,
789                             style,
790                             &id,
791                             &t_outputs
792                         );
793                         println!("{}",
794                                  fname.file_name()
795                                       .unwrap()
796                                       .to_string_lossy());
797                     }
798                 }
799                 Cfg => {
800                     let allow_unstable_cfg = UnstableFeatures::from_environment()
801                         .is_nightly_build();
802
803                     let mut cfgs = Vec::new();
804                     for &(name, ref value) in sess.parse_sess.config.iter() {
805                         let gated_cfg = GatedCfg::gate(&ast::MetaItem {
806                             name,
807                             node: ast::MetaItemKind::Word,
808                             span: DUMMY_SP,
809                         });
810
811                         // Note that crt-static is a specially recognized cfg
812                         // directive that's printed out here as part of
813                         // rust-lang/rust#37406, but in general the
814                         // `target_feature` cfg is gated under
815                         // rust-lang/rust#29717. For now this is just
816                         // specifically allowing the crt-static cfg and that's
817                         // it, this is intended to get into Cargo and then go
818                         // through to build scripts.
819                         let value = value.as_ref().map(|s| s.as_str());
820                         let value = value.as_ref().map(|s| s.as_ref());
821                         if name != "target_feature" || value != Some("crt-static") {
822                             if !allow_unstable_cfg && gated_cfg.is_some() {
823                                 continue;
824                             }
825                         }
826
827                         cfgs.push(if let Some(value) = value {
828                             format!("{}=\"{}\"", name, value)
829                         } else {
830                             format!("{}", name)
831                         });
832                     }
833
834                     cfgs.sort();
835                     for cfg in cfgs {
836                         println!("{}", cfg);
837                     }
838                 }
839                 RelocationModels | CodeModels | TlsModels | TargetCPUs | TargetFeatures => {
840                     trans.print(*req, sess);
841                 }
842                 // Any output here interferes with Cargo's parsing of other printed output
843                 PrintRequest::NativeStaticLibs => {}
844             }
845         }
846         return Compilation::Stop;
847     }
848 }
849
850 /// Returns a version string such as "0.12.0-dev".
851 fn release_str() -> Option<&'static str> {
852     option_env!("CFG_RELEASE")
853 }
854
855 /// Returns the full SHA1 hash of HEAD of the Git repo from which rustc was built.
856 fn commit_hash_str() -> Option<&'static str> {
857     option_env!("CFG_VER_HASH")
858 }
859
860 /// Returns the "commit date" of HEAD of the Git repo from which rustc was built as a static string.
861 fn commit_date_str() -> Option<&'static str> {
862     option_env!("CFG_VER_DATE")
863 }
864
865 /// Prints version information
866 pub fn version(binary: &str, matches: &getopts::Matches) {
867     let verbose = matches.opt_present("verbose");
868
869     println!("{} {}",
870              binary,
871              option_env!("CFG_VERSION").unwrap_or("unknown version"));
872     if verbose {
873         fn unw(x: Option<&str>) -> &str {
874             x.unwrap_or("unknown")
875         }
876         println!("binary: {}", binary);
877         println!("commit-hash: {}", unw(commit_hash_str()));
878         println!("commit-date: {}", unw(commit_date_str()));
879         println!("host: {}", config::host_triple());
880         println!("release: {}", unw(release_str()));
881         rustc_trans::print_version();
882     }
883 }
884
885 fn usage(verbose: bool, include_unstable_options: bool) {
886     let groups = if verbose {
887         config::rustc_optgroups()
888     } else {
889         config::rustc_short_optgroups()
890     };
891     let mut options = getopts::Options::new();
892     for option in groups.iter().filter(|x| include_unstable_options || x.is_stable()) {
893         (option.apply)(&mut options);
894     }
895     let message = format!("Usage: rustc [OPTIONS] INPUT");
896     let nightly_help = if nightly_options::is_nightly_build() {
897         "\n    -Z help             Print internal options for debugging rustc"
898     } else {
899         ""
900     };
901     let verbose_help = if verbose {
902         ""
903     } else {
904         "\n    --help -v           Print the full set of options rustc accepts"
905     };
906     println!("{}\nAdditional help:
907     -C help             Print codegen options
908     -W help             \
909               Print 'lint' options and default settings{}{}\n",
910              options.usage(&message),
911              nightly_help,
912              verbose_help);
913 }
914
915 fn describe_lints(lint_store: &lint::LintStore, loaded_plugins: bool) {
916     println!("
917 Available lint options:
918     -W <foo>           Warn about <foo>
919     -A <foo>           \
920               Allow <foo>
921     -D <foo>           Deny <foo>
922     -F <foo>           Forbid <foo> \
923               (deny <foo> and all attempts to override)
924
925 ");
926
927     fn sort_lints(lints: Vec<(&'static Lint, bool)>) -> Vec<&'static Lint> {
928         let mut lints: Vec<_> = lints.into_iter().map(|(x, _)| x).collect();
929         lints.sort_by(|x: &&Lint, y: &&Lint| {
930             match x.default_level.cmp(&y.default_level) {
931                 // The sort doesn't case-fold but it's doubtful we care.
932                 Equal => x.name.cmp(y.name),
933                 r => r,
934             }
935         });
936         lints
937     }
938
939     fn sort_lint_groups(lints: Vec<(&'static str, Vec<lint::LintId>, bool)>)
940                         -> Vec<(&'static str, Vec<lint::LintId>)> {
941         let mut lints: Vec<_> = lints.into_iter().map(|(x, y, _)| (x, y)).collect();
942         lints.sort_by(|&(x, _): &(&'static str, Vec<lint::LintId>),
943                        &(y, _): &(&'static str, Vec<lint::LintId>)| {
944             x.cmp(y)
945         });
946         lints
947     }
948
949     let (plugin, builtin): (Vec<_>, _) = lint_store.get_lints()
950                                                    .iter()
951                                                    .cloned()
952                                                    .partition(|&(_, p)| p);
953     let plugin = sort_lints(plugin);
954     let builtin = sort_lints(builtin);
955
956     let (plugin_groups, builtin_groups): (Vec<_>, _) = lint_store.get_lint_groups()
957                                                                  .iter()
958                                                                  .cloned()
959                                                                  .partition(|&(.., p)| p);
960     let plugin_groups = sort_lint_groups(plugin_groups);
961     let builtin_groups = sort_lint_groups(builtin_groups);
962
963     let max_name_len = plugin.iter()
964                              .chain(&builtin)
965                              .map(|&s| s.name.chars().count())
966                              .max()
967                              .unwrap_or(0);
968     let padded = |x: &str| {
969         let mut s = repeat(" ")
970                         .take(max_name_len - x.chars().count())
971                         .collect::<String>();
972         s.push_str(x);
973         s
974     };
975
976     println!("Lint checks provided by rustc:\n");
977     println!("    {}  {:7.7}  {}", padded("name"), "default", "meaning");
978     println!("    {}  {:7.7}  {}", padded("----"), "-------", "-------");
979
980     let print_lints = |lints: Vec<&Lint>| {
981         for lint in lints {
982             let name = lint.name_lower().replace("_", "-");
983             println!("    {}  {:7.7}  {}",
984                      padded(&name),
985                      lint.default_level.as_str(),
986                      lint.desc);
987         }
988         println!("\n");
989     };
990
991     print_lints(builtin);
992
993
994
995     let max_name_len = max("warnings".len(),
996                            plugin_groups.iter()
997                                         .chain(&builtin_groups)
998                                         .map(|&(s, _)| s.chars().count())
999                                         .max()
1000                                         .unwrap_or(0));
1001
1002     let padded = |x: &str| {
1003         let mut s = repeat(" ")
1004                         .take(max_name_len - x.chars().count())
1005                         .collect::<String>();
1006         s.push_str(x);
1007         s
1008     };
1009
1010     println!("Lint groups provided by rustc:\n");
1011     println!("    {}  {}", padded("name"), "sub-lints");
1012     println!("    {}  {}", padded("----"), "---------");
1013     println!("    {}  {}", padded("warnings"), "all lints that are set to issue warnings");
1014
1015     let print_lint_groups = |lints: Vec<(&'static str, Vec<lint::LintId>)>| {
1016         for (name, to) in lints {
1017             let name = name.to_lowercase().replace("_", "-");
1018             let desc = to.into_iter()
1019                          .map(|x| x.to_string().replace("_", "-"))
1020                          .collect::<Vec<String>>()
1021                          .join(", ");
1022             println!("    {}  {}", padded(&name), desc);
1023         }
1024         println!("\n");
1025     };
1026
1027     print_lint_groups(builtin_groups);
1028
1029     match (loaded_plugins, plugin.len(), plugin_groups.len()) {
1030         (false, 0, _) | (false, _, 0) => {
1031             println!("Compiler plugins can provide additional lints and lint groups. To see a \
1032                       listing of these, re-run `rustc -W help` with a crate filename.");
1033         }
1034         (false, ..) => panic!("didn't load lint plugins but got them anyway!"),
1035         (true, 0, 0) => println!("This crate does not load any lint plugins or lint groups."),
1036         (true, l, g) => {
1037             if l > 0 {
1038                 println!("Lint checks provided by plugins loaded by this crate:\n");
1039                 print_lints(plugin);
1040             }
1041             if g > 0 {
1042                 println!("Lint groups provided by plugins loaded by this crate:\n");
1043                 print_lint_groups(plugin_groups);
1044             }
1045         }
1046     }
1047 }
1048
1049 fn describe_debug_flags() {
1050     println!("\nAvailable debug options:\n");
1051     print_flag_list("-Z", config::DB_OPTIONS);
1052 }
1053
1054 fn describe_codegen_flags() {
1055     println!("\nAvailable codegen options:\n");
1056     print_flag_list("-C", config::CG_OPTIONS);
1057 }
1058
1059 fn print_flag_list<T>(cmdline_opt: &str,
1060                       flag_list: &[(&'static str, T, Option<&'static str>, &'static str)]) {
1061     let max_len = flag_list.iter()
1062                            .map(|&(name, _, opt_type_desc, _)| {
1063                                let extra_len = match opt_type_desc {
1064                                    Some(..) => 4,
1065                                    None => 0,
1066                                };
1067                                name.chars().count() + extra_len
1068                            })
1069                            .max()
1070                            .unwrap_or(0);
1071
1072     for &(name, _, opt_type_desc, desc) in flag_list {
1073         let (width, extra) = match opt_type_desc {
1074             Some(..) => (max_len - 4, "=val"),
1075             None => (max_len, ""),
1076         };
1077         println!("    {} {:>width$}{} -- {}",
1078                  cmdline_opt,
1079                  name.replace("_", "-"),
1080                  extra,
1081                  desc,
1082                  width = width);
1083     }
1084 }
1085
1086 /// Process command line options. Emits messages as appropriate. If compilation
1087 /// should continue, returns a getopts::Matches object parsed from args,
1088 /// otherwise returns None.
1089 ///
1090 /// The compiler's handling of options is a little complicated as it ties into
1091 /// our stability story, and it's even *more* complicated by historical
1092 /// accidents. The current intention of each compiler option is to have one of
1093 /// three modes:
1094 ///
1095 /// 1. An option is stable and can be used everywhere.
1096 /// 2. An option is unstable, but was historically allowed on the stable
1097 ///    channel.
1098 /// 3. An option is unstable, and can only be used on nightly.
1099 ///
1100 /// Like unstable library and language features, however, unstable options have
1101 /// always required a form of "opt in" to indicate that you're using them. This
1102 /// provides the easy ability to scan a code base to check to see if anything
1103 /// unstable is being used. Currently, this "opt in" is the `-Z` "zed" flag.
1104 ///
1105 /// All options behind `-Z` are considered unstable by default. Other top-level
1106 /// options can also be considered unstable, and they were unlocked through the
1107 /// `-Z unstable-options` flag. Note that `-Z` remains to be the root of
1108 /// instability in both cases, though.
1109 ///
1110 /// So with all that in mind, the comments below have some more detail about the
1111 /// contortions done here to get things to work out correctly.
1112 pub fn handle_options(args: &[String]) -> Option<getopts::Matches> {
1113     // Throw away the first argument, the name of the binary
1114     let args = &args[1..];
1115
1116     if args.is_empty() {
1117         // user did not write `-v` nor `-Z unstable-options`, so do not
1118         // include that extra information.
1119         usage(false, false);
1120         return None;
1121     }
1122
1123     // Parse with *all* options defined in the compiler, we don't worry about
1124     // option stability here we just want to parse as much as possible.
1125     let mut options = getopts::Options::new();
1126     for option in config::rustc_optgroups() {
1127         (option.apply)(&mut options);
1128     }
1129     let matches = match options.parse(args) {
1130         Ok(m) => m,
1131         Err(f) => early_error(ErrorOutputType::default(), &f.to_string()),
1132     };
1133
1134     // For all options we just parsed, we check a few aspects:
1135     //
1136     // * If the option is stable, we're all good
1137     // * If the option wasn't passed, we're all good
1138     // * If `-Z unstable-options` wasn't passed (and we're not a -Z option
1139     //   ourselves), then we require the `-Z unstable-options` flag to unlock
1140     //   this option that was passed.
1141     // * If we're a nightly compiler, then unstable options are now unlocked, so
1142     //   we're good to go.
1143     // * Otherwise, if we're a truly unstable option then we generate an error
1144     //   (unstable option being used on stable)
1145     // * If we're a historically stable-but-should-be-unstable option then we
1146     //   emit a warning that we're going to turn this into an error soon.
1147     nightly_options::check_nightly_options(&matches, &config::rustc_optgroups());
1148
1149     if matches.opt_present("h") || matches.opt_present("help") {
1150         // Only show unstable options in --help if we *really* accept unstable
1151         // options, which catches the case where we got `-Z unstable-options` on
1152         // the stable channel of Rust which was accidentally allowed
1153         // historically.
1154         usage(matches.opt_present("verbose"),
1155               nightly_options::is_unstable_enabled(&matches));
1156         return None;
1157     }
1158
1159     // Don't handle -W help here, because we might first load plugins.
1160     let r = matches.opt_strs("Z");
1161     if r.iter().any(|x| *x == "help") {
1162         describe_debug_flags();
1163         return None;
1164     }
1165
1166     let cg_flags = matches.opt_strs("C");
1167     if cg_flags.iter().any(|x| *x == "help") {
1168         describe_codegen_flags();
1169         return None;
1170     }
1171
1172     if cg_flags.iter().any(|x| *x == "no-stack-check") {
1173         early_warn(ErrorOutputType::default(),
1174                    "the --no-stack-check flag is deprecated and does nothing");
1175     }
1176
1177     if cg_flags.contains(&"passes=list".to_string()) {
1178         rustc_trans::print_passes();
1179         return None;
1180     }
1181
1182     if matches.opt_present("version") {
1183         version("rustc", &matches);
1184         return None;
1185     }
1186
1187     Some(matches)
1188 }
1189
1190 fn parse_crate_attrs<'a>(sess: &'a Session, input: &Input) -> PResult<'a, Vec<ast::Attribute>> {
1191     match *input {
1192         Input::File(ref ifile) => {
1193             parse::parse_crate_attrs_from_file(ifile, &sess.parse_sess)
1194         }
1195         Input::Str { ref name, ref input } => {
1196             parse::parse_crate_attrs_from_source_str(name.clone(),
1197                                                      input.clone(),
1198                                                      &sess.parse_sess)
1199         }
1200     }
1201 }
1202
1203 /// Runs `f` in a suitable thread for running `rustc`; returns a
1204 /// `Result` with either the return value of `f` or -- if a panic
1205 /// occurs -- the panic value.
1206 pub fn in_rustc_thread<F, R>(f: F) -> Result<R, Box<Any + Send>>
1207     where F: FnOnce() -> R + Send + 'static,
1208           R: Send + 'static,
1209 {
1210     // Temporarily have stack size set to 16MB to deal with nom-using crates failing
1211     const STACK_SIZE: usize = 16 * 1024 * 1024; // 16MB
1212
1213     let mut cfg = thread::Builder::new().name("rustc".to_string());
1214
1215     // FIXME: Hacks on hacks. If the env is trying to override the stack size
1216     // then *don't* set it explicitly.
1217     if env::var_os("RUST_MIN_STACK").is_none() {
1218         cfg = cfg.stack_size(STACK_SIZE);
1219     }
1220
1221     let thread = cfg.spawn(f);
1222     thread.unwrap().join()
1223 }
1224
1225 /// Run a procedure which will detect panics in the compiler and print nicer
1226 /// error messages rather than just failing the test.
1227 ///
1228 /// The diagnostic emitter yielded to the procedure should be used for reporting
1229 /// errors of the compiler.
1230 pub fn monitor<F: FnOnce() + Send + 'static>(f: F) {
1231     struct Sink(Arc<Mutex<Vec<u8>>>);
1232     impl Write for Sink {
1233         fn write(&mut self, data: &[u8]) -> io::Result<usize> {
1234             Write::write(&mut *self.0.lock().unwrap(), data)
1235         }
1236         fn flush(&mut self) -> io::Result<()> {
1237             Ok(())
1238         }
1239     }
1240
1241     let data = Arc::new(Mutex::new(Vec::new()));
1242     let err = Sink(data.clone());
1243
1244     let result = in_rustc_thread(move || {
1245         io::set_panic(Some(box err));
1246         f()
1247     });
1248
1249     if let Err(value) = result {
1250         // Thread panicked without emitting a fatal diagnostic
1251         if !value.is::<errors::FatalError>() {
1252             let emitter =
1253                 Box::new(errors::emitter::EmitterWriter::stderr(errors::ColorConfig::Auto,
1254                                                                 None,
1255                                                                 false));
1256             let handler = errors::Handler::with_emitter(true, false, emitter);
1257
1258             // a .span_bug or .bug call has already printed what
1259             // it wants to print.
1260             if !value.is::<errors::ExplicitBug>() {
1261                 handler.emit(&MultiSpan::new(),
1262                              "unexpected panic",
1263                              errors::Level::Bug);
1264             }
1265
1266             let xs = ["the compiler unexpectedly panicked. this is a bug.".to_string(),
1267                       format!("we would appreciate a bug report: {}", BUG_REPORT_URL),
1268                       format!("rustc {} running on {}",
1269                               option_env!("CFG_VERSION").unwrap_or("unknown_version"),
1270                               config::host_triple())];
1271             for note in &xs {
1272                 handler.emit(&MultiSpan::new(),
1273                              &note,
1274                              errors::Level::Note);
1275             }
1276
1277             eprintln!("{}", str::from_utf8(&data.lock().unwrap()).unwrap());
1278         }
1279
1280         exit_on_err();
1281     }
1282 }
1283
1284 fn exit_on_err() -> ! {
1285     // Panic so the process returns a failure code, but don't pollute the
1286     // output with some unnecessary panic messages, we've already
1287     // printed everything that we needed to.
1288     io::set_panic(Some(box io::sink()));
1289     panic!();
1290 }
1291
1292 #[cfg(stage0)]
1293 pub fn diagnostics_registry() -> errors::registry::Registry {
1294     use errors::registry::Registry;
1295
1296     Registry::new(&[])
1297 }
1298
1299 #[cfg(not(stage0))]
1300 pub fn diagnostics_registry() -> errors::registry::Registry {
1301     use errors::registry::Registry;
1302
1303     let mut all_errors = Vec::new();
1304     all_errors.extend_from_slice(&rustc::DIAGNOSTICS);
1305     all_errors.extend_from_slice(&rustc_typeck::DIAGNOSTICS);
1306     all_errors.extend_from_slice(&rustc_resolve::DIAGNOSTICS);
1307     all_errors.extend_from_slice(&rustc_privacy::DIAGNOSTICS);
1308     #[cfg(feature="llvm")]
1309     all_errors.extend_from_slice(&rustc_trans::DIAGNOSTICS);
1310     all_errors.extend_from_slice(&rustc_trans_utils::DIAGNOSTICS);
1311     all_errors.extend_from_slice(&rustc_const_eval::DIAGNOSTICS);
1312     all_errors.extend_from_slice(&rustc_metadata::DIAGNOSTICS);
1313     all_errors.extend_from_slice(&rustc_passes::DIAGNOSTICS);
1314     all_errors.extend_from_slice(&rustc_plugin::DIAGNOSTICS);
1315     all_errors.extend_from_slice(&rustc_mir::DIAGNOSTICS);
1316     all_errors.extend_from_slice(&syntax::DIAGNOSTICS);
1317
1318     Registry::new(&all_errors)
1319 }
1320
1321 pub fn main() {
1322     env_logger::init().unwrap();
1323     let result = run(|| {
1324         let args = env::args_os().enumerate()
1325             .map(|(i, arg)| arg.into_string().unwrap_or_else(|arg| {
1326                 early_error(ErrorOutputType::default(),
1327                             &format!("Argument {} is not valid Unicode: {:?}", i, arg))
1328             }))
1329             .collect::<Vec<_>>();
1330         run_compiler(&args,
1331                      &mut RustcDefaultCalls,
1332                      None,
1333                      None)
1334     });
1335     process::exit(result as i32);
1336 }