src/librustc_driver/driver.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 use rustc::session::Session;
  12 use rustc::session::config::{self, Input, OutputFilenames};
  13 use rustc::session::search_paths::PathKind;
  14 use rustc::lint;
  15 use rustc::metadata::creader::CrateReader;
  16 use rustc::middle::{stability, ty, reachable};
  17 use rustc::middle::dependency_format;
  18 use rustc::middle;
  19 use rustc::plugin::load::Plugins;
  20 use rustc::plugin::registry::Registry;
  21 use rustc::plugin;
  22 use rustc::util::common::time;
  23 use rustc_borrowck as borrowck;
  24 use rustc_resolve as resolve;
  25 use rustc_trans::back::link;
  26 use rustc_trans::back::write;
  27 use rustc_trans::trans;
  28 use rustc_typeck as typeck;
  29 use rustc_privacy;
  30
  31 use serialize::json;
  32
  33 use std::old_io;
  34 use std::old_io::fs;
  35 use std::os;
  36 use syntax::ast;
  37 use syntax::ast_map;
  38 use syntax::attr;
  39 use syntax::attr::{AttrMetaMethods};
  40 use syntax::diagnostics;
  41 use syntax::parse;
  42 use syntax::parse::token;
  43 use syntax;
  44
  45 pub fn compile_input(sess: Session,
  46                      cfg: ast::CrateConfig,
  47                      input: &Input,
  48                      outdir: &Option<Path>,
  49                      output: &Option<Path>,
  50                      addl_plugins: Option<Vec<String>>,
  51                      control: CompileController) {
  52     macro_rules! controller_entry_point{($point: ident, $make_state: expr) => ({
  53         {
  54             let state = $make_state;
  55             (control.$point.callback)(state);
  56         }
  57         if control.$point.stop {
  58             return;
  59         }
  60     })}
  61
  62     // We need nested scopes here, because the intermediate results can keep
  63     // large chunks of memory alive and we want to free them as soon as
  64     // possible to keep the peak memory usage low
  65     let (outputs, trans, sess) = {
  66         let (outputs, expanded_crate, id) = {
  67             let krate = phase_1_parse_input(&sess, cfg, input);
  68
  69             controller_entry_point!(after_parse,
  70                                     CompileState::state_after_parse(input,
  71                                                                     &sess,
  72                                                                     outdir,
  73                                                                     &krate));
  74
  75             let outputs = build_output_filenames(input,
  76                                                  outdir,
  77                                                  output,
  78                                                  &krate.attrs[],
  79                                                  &sess);
  80             let id = link::find_crate_name(Some(&sess),
  81                                            &krate.attrs[],
  82                                            input);
  83             let expanded_crate
  84                 = match phase_2_configure_and_expand(&sess,
  85                                                      krate,
  86                                                      &id[],
  87                                                      addl_plugins) {
  88                     None => return,
  89                     Some(k) => k
  90                 };
  91
  92             (outputs, expanded_crate, id)
  93         };
  94
  95         controller_entry_point!(after_expand,
  96                                 CompileState::state_after_expand(input,
  97                                                                  &sess,
  98                                                                  outdir,
  99                                                                  &expanded_crate,
 100                                                                  &id[]));
 101
 102         let mut forest = ast_map::Forest::new(expanded_crate);
 103         let arenas = ty::CtxtArenas::new();
 104         let ast_map = assign_node_ids_and_map(&sess, &mut forest);
 105
 106         write_out_deps(&sess, input, &outputs, &id[]);
 107
 108         controller_entry_point!(after_write_deps,
 109                                 CompileState::state_after_write_deps(input,
 110                                                                      &sess,
 111                                                                      outdir,
 112                                                                      &ast_map,
 113                                                                      &id[]));
 114
 115         let analysis = phase_3_run_analysis_passes(sess,
 116                                                    ast_map,
 117                                                    &arenas,
 118                                                    id,
 119                                                    control.make_glob_map);
 120
 121         controller_entry_point!(after_analysis,
 122                                 CompileState::state_after_analysis(input,
 123                                                                    &analysis.ty_cx.sess,
 124                                                                    outdir,
 125                                                                    analysis.ty_cx.map.krate(),
 126                                                                    &analysis,
 127                                                                    &analysis.ty_cx));
 128
 129         if log_enabled!(::log::INFO) {
 130             println!("Pre-trans");
 131             analysis.ty_cx.print_debug_stats();
 132         }
 133         let (tcx, trans) = phase_4_translate_to_llvm(analysis);
 134
 135         if log_enabled!(::log::INFO) {
 136             println!("Post-trans");
 137             tcx.print_debug_stats();
 138         }
 139
 140         // Discard interned strings as they are no longer required.
 141         token::get_ident_interner().clear();
 142
 143         (outputs, trans, tcx.sess)
 144     };
 145     phase_5_run_llvm_passes(&sess, &trans, &outputs);
 146
 147     controller_entry_point!(after_llvm,
 148                             CompileState::state_after_llvm(input,
 149                                                            &sess,
 150                                                            outdir,
 151                                                            &trans));
 152
 153     phase_6_link_output(&sess, &trans, &outputs);
 154 }
 155
 156 /// The name used for source code that doesn't originate in a file
 157 /// (e.g. source from stdin or a string)
 158 pub fn anon_src() -> String {
 159     "<anon>".to_string()
 160 }
 161
 162 pub fn source_name(input: &Input) -> String {
 163     match *input {
 164         // FIXME (#9639): This needs to handle non-utf8 paths
 165         Input::File(ref ifile) => ifile.as_str().unwrap().to_string(),
 166         Input::Str(_) => anon_src()
 167     }
 168 }
 169
 170 /// CompileController is used to customise compilation, it allows compilation to
 171 /// be stopped and/or to call arbitrary code at various points in compilation.
 172 /// It also allows for various flags to be set to influence what information gets
 173 /// colelcted during compilation.
 174 ///
 175 /// This is a somewhat higher level controller than a Session - the Session
 176 /// controls what happens in each phase, whereas the CompileController controls
 177 /// whether a phase is run at all and whether other code (from outside the
 178 /// the compiler) is run between phases.
 179 ///
 180 /// Note that if compilation is set to stop and a callback is provided for a
 181 /// given entry point, the callback is called before compilation is stopped.
 182 ///
 183 /// Expect more entry points to be added in the future.
 184 pub struct CompileController<'a> {
 185     pub after_parse: PhaseController<'a>,
 186     pub after_expand: PhaseController<'a>,
 187     pub after_write_deps: PhaseController<'a>,
 188     pub after_analysis: PhaseController<'a>,
 189     pub after_llvm: PhaseController<'a>,
 190
 191     pub make_glob_map: resolve::MakeGlobMap,
 192 }
 193
 194 impl<'a> CompileController<'a> {
 195     pub fn basic() -> CompileController<'a> {
 196         CompileController {
 197             after_parse: PhaseController::basic(),
 198             after_expand: PhaseController::basic(),
 199             after_write_deps:  PhaseController::basic(),
 200             after_analysis: PhaseController::basic(),
 201             after_llvm: PhaseController::basic(),
 202             make_glob_map: resolve::MakeGlobMap::No,
 203         }
 204     }
 205 }
 206
 207 pub struct PhaseController<'a> {
 208     pub stop: bool,
 209     pub callback: Box<Fn(CompileState) -> () + 'a>,
 210 }
 211
 212 impl<'a> PhaseController<'a> {
 213     pub fn basic() -> PhaseController<'a> {
 214         PhaseController {
 215             stop: false,
 216             callback: box |&: _| {},
 217         }
 218     }
 219 }
 220
 221 /// State that is passed to a callback. What state is available depends on when
 222 /// during compilation the callback is made. See the various constructor methods
 223 /// (`state_*`) in the impl to see which data is provided for any given entry point.
 224 pub struct CompileState<'a, 'ast: 'a, 'tcx: 'a> {
 225     pub input: &'a Input,
 226     pub session: &'a Session,
 227     pub cfg: Option<&'a ast::CrateConfig>,
 228     pub krate: Option<&'a ast::Crate>,
 229     pub crate_name: Option<&'a str>,
 230     pub output_filenames: Option<&'a OutputFilenames>,
 231     pub out_dir: Option<&'a Path>,
 232     pub expanded_crate: Option<&'a ast::Crate>,
 233     pub ast_map: Option<&'a ast_map::Map<'ast>>,
 234     pub analysis: Option<&'a ty::CrateAnalysis<'tcx>>,
 235     pub tcx: Option<&'a ty::ctxt<'tcx>>,
 236     pub trans: Option<&'a trans::CrateTranslation>,
 237 }
 238
 239 impl<'a, 'ast, 'tcx> CompileState<'a, 'ast, 'tcx> {
 240     fn empty(input: &'a Input,
 241              session: &'a Session,
 242              out_dir: &'a Option<Path>)
 243              -> CompileState<'a, 'ast, 'tcx> {
 244         CompileState {
 245             input: input,
 246             session: session,
 247             out_dir: out_dir.as_ref(),
 248             cfg: None,
 249             krate: None,
 250             crate_name: None,
 251             output_filenames: None,
 252             expanded_crate: None,
 253             ast_map: None,
 254             analysis: None,
 255             tcx: None,
 256             trans: None,
 257         }
 258     }
 259
 260     fn state_after_parse(input: &'a Input,
 261                          session: &'a Session,
 262                          out_dir: &'a Option<Path>,
 263                          krate: &'a ast::Crate)
 264                          -> CompileState<'a, 'ast, 'tcx> {
 265         CompileState {
 266             krate: Some(krate),
 267             .. CompileState::empty(input, session, out_dir)
 268         }
 269     }
 270
 271     fn state_after_expand(input: &'a Input,
 272                           session: &'a Session,
 273                           out_dir: &'a Option<Path>,
 274                           expanded_crate: &'a ast::Crate,
 275                           crate_name: &'a str)
 276                           -> CompileState<'a, 'ast, 'tcx> {
 277         CompileState {
 278             crate_name: Some(crate_name),
 279             expanded_crate: Some(expanded_crate),
 280             .. CompileState::empty(input, session, out_dir)
 281         }
 282     }
 283
 284     fn state_after_write_deps(input: &'a Input,
 285                               session: &'a Session,
 286                               out_dir: &'a Option<Path>,
 287                               ast_map: &'a ast_map::Map<'ast>,
 288                               crate_name: &'a str)
 289                               -> CompileState<'a, 'ast, 'tcx> {
 290         CompileState {
 291             crate_name: Some(crate_name),
 292             ast_map: Some(ast_map),
 293             .. CompileState::empty(input, session, out_dir)
 294         }
 295     }
 296
 297     fn state_after_analysis(input: &'a Input,
 298                             session: &'a Session,
 299                             out_dir: &'a Option<Path>,
 300                             krate: &'a ast::Crate,
 301                             analysis: &'a ty::CrateAnalysis<'tcx>,
 302                             tcx: &'a ty::ctxt<'tcx>)
 303                             -> CompileState<'a, 'ast, 'tcx> {
 304         CompileState {
 305             analysis: Some(analysis),
 306             tcx: Some(tcx),
 307             krate: Some(krate),
 308             .. CompileState::empty(input, session, out_dir)
 309         }
 310     }
 311
 312
 313     fn state_after_llvm(input: &'a Input,
 314                         session: &'a Session,
 315                         out_dir: &'a Option<Path>,
 316                         trans: &'a trans::CrateTranslation)
 317                         -> CompileState<'a, 'ast, 'tcx> {
 318         CompileState {
 319             trans: Some(trans),
 320             .. CompileState::empty(input, session, out_dir)
 321         }
 322     }
 323 }
 324
 325 pub fn phase_1_parse_input(sess: &Session, cfg: ast::CrateConfig, input: &Input)
 326     -> ast::Crate {
 327     // These may be left in an incoherent state after a previous compile.
 328     // `clear_tables` and `get_ident_interner().clear()` can be used to free
 329     // memory, but they do not restore the initial state.
 330     syntax::ext::mtwt::reset_tables();
 331     token::reset_ident_interner();
 332
 333     let krate = time(sess.time_passes(), "parsing", (), |_| {
 334         match *input {
 335             Input::File(ref file) => {
 336                 parse::parse_crate_from_file(&(*file), cfg.clone(), &sess.parse_sess)
 337             }
 338             Input::Str(ref src) => {
 339                 parse::parse_crate_from_source_str(anon_src().to_string(),
 340                                                    src.to_string(),
 341                                                    cfg.clone(),
 342                                                    &sess.parse_sess)
 343             }
 344         }
 345     });
 346
 347     if sess.opts.debugging_opts.ast_json_noexpand {
 348         println!("{}", json::as_json(&krate));
 349     }
 350
 351     if let Some(ref s) = sess.opts.show_span {
 352         syntax::show_span::run(sess.diagnostic(), s.as_slice(), &krate);
 353     }
 354
 355     krate
 356 }
 357
 358 // For continuing compilation after a parsed crate has been
 359 // modified
 360
 361 /// Run the "early phases" of the compiler: initial `cfg` processing,
 362 /// loading compiler plugins (including those from `addl_plugins`),
 363 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
 364 /// harness if one is to be provided and injection of a dependency on the
 365 /// standard library and prelude.
 366 ///
 367 /// Returns `None` if we're aborting after handling -W help.
 368 pub fn phase_2_configure_and_expand(sess: &Session,
 369                                     mut krate: ast::Crate,
 370                                     crate_name: &str,
 371                                     addl_plugins: Option<Vec<String>>)
 372                                     -> Option<ast::Crate> {
 373     let time_passes = sess.time_passes();
 374
 375     *sess.crate_types.borrow_mut() =
 376         collect_crate_types(sess, &krate.attrs[]);
 377     *sess.crate_metadata.borrow_mut() =
 378         collect_crate_metadata(sess, &krate.attrs[]);
 379
 380     time(time_passes, "recursion limit", (), |_| {
 381         middle::recursion_limit::update_recursion_limit(sess, &krate);
 382     });
 383
 384     // strip before expansion to allow macros to depend on
 385     // configuration variables e.g/ in
 386     //
 387     //   #[macro_use] #[cfg(foo)]
 388     //   mod bar { macro_rules! baz!(() => {{}}) }
 389     //
 390     // baz! should not use this definition unless foo is enabled.
 391
 392     time(time_passes, "gated macro checking", (), |_| {
 393         let (features, unknown_features) =
 394             syntax::feature_gate::check_crate_macros(sess.codemap(),
 395                                                      &sess.parse_sess.span_diagnostic,
 396                                                      &krate);
 397         for uf in unknown_features.iter() {
 398             sess.add_lint(lint::builtin::UNKNOWN_FEATURES,
 399                           ast::CRATE_NODE_ID,
 400                           *uf,
 401                           "unknown feature".to_string());
 402         }
 403
 404         // these need to be set "early" so that expansion sees `quote` if enabled.
 405         *sess.features.borrow_mut() = features;
 406         sess.abort_if_errors();
 407     });
 408
 409     krate = time(time_passes, "configuration 1", krate, |krate|
 410                  syntax::config::strip_unconfigured_items(sess.diagnostic(), krate));
 411
 412     krate = time(time_passes, "crate injection", krate, |krate|
 413                  syntax::std_inject::maybe_inject_crates_ref(krate,
 414                                                              sess.opts.alt_std_name.clone()));
 415
 416     let mut addl_plugins = Some(addl_plugins);
 417     let Plugins { macros, registrars }
 418         = time(time_passes, "plugin loading", (), |_|
 419                plugin::load::load_plugins(sess, &krate, addl_plugins.take().unwrap()));
 420
 421     let mut registry = Registry::new(sess, &krate);
 422
 423     time(time_passes, "plugin registration", registrars, |registrars| {
 424         if sess.features.borrow().rustc_diagnostic_macros {
 425             registry.register_macro("__diagnostic_used",
 426                 diagnostics::plugin::expand_diagnostic_used);
 427             registry.register_macro("__register_diagnostic",
 428                 diagnostics::plugin::expand_register_diagnostic);
 429             registry.register_macro("__build_diagnostic_array",
 430                 diagnostics::plugin::expand_build_diagnostic_array);
 431         }
 432
 433         for registrar in registrars.into_iter() {
 434             registry.args_hidden = Some(registrar.args);
 435             (registrar.fun)(&mut registry);
 436         }
 437     });
 438
 439     let Registry { syntax_exts, lint_passes, lint_groups, .. } = registry;
 440
 441     {
 442         let mut ls = sess.lint_store.borrow_mut();
 443         for pass in lint_passes.into_iter() {
 444             ls.register_pass(Some(sess), true, pass);
 445         }
 446
 447         for (name, to) in lint_groups.into_iter() {
 448             ls.register_group(Some(sess), true, name, to);
 449         }
 450     }
 451
 452     // Lint plugins are registered; now we can process command line flags.
 453     if sess.opts.describe_lints {
 454         super::describe_lints(&*sess.lint_store.borrow(), true);
 455         return None;
 456     }
 457     sess.lint_store.borrow_mut().process_command_line(sess);
 458
 459     // Abort if there are errors from lint processing or a plugin registrar.
 460     sess.abort_if_errors();
 461
 462     krate = time(time_passes, "expansion", (krate, macros, syntax_exts),
 463         |(krate, macros, syntax_exts)| {
 464             // Windows dlls do not have rpaths, so they don't know how to find their
 465             // dependencies. It's up to us to tell the system where to find all the
 466             // dependent dlls. Note that this uses cfg!(windows) as opposed to
 467             // targ_cfg because syntax extensions are always loaded for the host
 468             // compiler, not for the target.
 469             let mut _old_path = String::new();
 470             if cfg!(windows) {
 471                 _old_path = os::getenv("PATH").unwrap_or(_old_path);
 472                 let mut new_path = sess.host_filesearch(PathKind::All).get_dylib_search_paths();
 473                 new_path.extend(os::split_paths(&_old_path[]).into_iter());
 474                 os::setenv("PATH", os::join_paths(&new_path[]).unwrap());
 475             }
 476             let cfg = syntax::ext::expand::ExpansionConfig {
 477                 crate_name: crate_name.to_string(),
 478                 enable_quotes: sess.features.borrow().quote,
 479                 recursion_limit: sess.recursion_limit.get(),
 480             };
 481             let ret = syntax::ext::expand::expand_crate(&sess.parse_sess,
 482                                               cfg,
 483                                               macros,
 484                                               syntax_exts,
 485                                               krate);
 486             if cfg!(windows) {
 487                 os::setenv("PATH", _old_path);
 488             }
 489             ret
 490         }
 491     );
 492
 493     // Needs to go *after* expansion to be able to check the results of macro expansion.
 494     time(time_passes, "complete gated feature checking", (), |_| {
 495         syntax::feature_gate::check_crate(sess.codemap(),
 496                                           &sess.parse_sess.span_diagnostic,
 497                                           &krate);
 498         sess.abort_if_errors();
 499     });
 500
 501     // JBC: make CFG processing part of expansion to avoid this problem:
 502
 503     // strip again, in case expansion added anything with a #[cfg].
 504     krate = time(time_passes, "configuration 2", krate, |krate|
 505                  syntax::config::strip_unconfigured_items(sess.diagnostic(), krate));
 506
 507     krate = time(time_passes, "maybe building test harness", krate, |krate|
 508                  syntax::test::modify_for_testing(&sess.parse_sess,
 509                                                   &sess.opts.cfg,
 510                                                   krate,
 511                                                   sess.diagnostic()));
 512
 513     krate = time(time_passes, "prelude injection", krate, |krate|
 514                  syntax::std_inject::maybe_inject_prelude(krate));
 515
 516     time(time_passes, "checking that all macro invocations are gone", &krate, |krate|
 517          syntax::ext::expand::check_for_macros(&sess.parse_sess, krate));
 518
 519     Some(krate)
 520 }
 521
 522 pub fn assign_node_ids_and_map<'ast>(sess: &Session,
 523                                      forest: &'ast mut ast_map::Forest)
 524                                      -> ast_map::Map<'ast> {
 525     struct NodeIdAssigner<'a> {
 526         sess: &'a Session
 527     }
 528
 529     impl<'a> ast_map::FoldOps for NodeIdAssigner<'a> {
 530         fn new_id(&self, old_id: ast::NodeId) -> ast::NodeId {
 531             assert_eq!(old_id, ast::DUMMY_NODE_ID);
 532             self.sess.next_node_id()
 533         }
 534     }
 535
 536     let map = time(sess.time_passes(), "assigning node ids and indexing ast", forest, |forest|
 537                    ast_map::map_crate(forest, NodeIdAssigner { sess: sess }));
 538
 539     if sess.opts.debugging_opts.ast_json {
 540         println!("{}", json::as_json(map.krate()));
 541     }
 542
 543     map
 544 }
 545
 546 /// Run the resolution, typechecking, region checking and other
 547 /// miscellaneous analysis passes on the crate. Return various
 548 /// structures carrying the results of the analysis.
 549 pub fn phase_3_run_analysis_passes<'tcx>(sess: Session,
 550                                          ast_map: ast_map::Map<'tcx>,
 551                                          arenas: &'tcx ty::CtxtArenas<'tcx>,
 552                                          name: String,
 553                                          make_glob_map: resolve::MakeGlobMap)
 554                                          -> ty::CrateAnalysis<'tcx> {
 555     let time_passes = sess.time_passes();
 556     let krate = ast_map.krate();
 557
 558     time(time_passes, "external crate/lib resolution", (), |_|
 559          CrateReader::new(&sess).read_crates(krate));
 560
 561     let lang_items = time(time_passes, "language item collection", (), |_|
 562                           middle::lang_items::collect_language_items(krate, &sess));
 563
 564     let resolve::CrateMap {
 565         def_map,
 566         freevars,
 567         capture_mode_map,
 568         export_map,
 569         trait_map,
 570         external_exports,
 571         last_private_map,
 572         glob_map,
 573     } =
 574         time(time_passes, "resolution", (),
 575              |_| resolve::resolve_crate(&sess,
 576                                         &ast_map,
 577                                         &lang_items,
 578                                         krate,
 579                                         make_glob_map));
 580
 581     // Discard MTWT tables that aren't required past resolution.
 582     syntax::ext::mtwt::clear_tables();
 583
 584     let named_region_map = time(time_passes, "lifetime resolution", (),
 585                                 |_| middle::resolve_lifetime::krate(&sess, krate, &def_map));
 586
 587     time(time_passes, "looking for entry point", (),
 588          |_| middle::entry::find_entry_point(&sess, &ast_map));
 589
 590     sess.plugin_registrar_fn.set(
 591         time(time_passes, "looking for plugin registrar", (), |_|
 592             plugin::build::find_plugin_registrar(
 593                 sess.diagnostic(), krate)));
 594
 595     let region_map = time(time_passes, "region resolution", (), |_|
 596                           middle::region::resolve_crate(&sess, krate));
 597
 598     time(time_passes, "loop checking", (), |_|
 599          middle::check_loop::check_crate(&sess, krate));
 600
 601     let stability_index = time(time_passes, "stability index", (), |_|
 602                                stability::Index::build(krate));
 603
 604     time(time_passes, "static item recursion checking", (), |_|
 605          middle::check_static_recursion::check_crate(&sess, krate, &def_map, &ast_map));
 606
 607     let ty_cx = ty::mk_ctxt(sess,
 608                             arenas,
 609                             def_map,
 610                             named_region_map,
 611                             ast_map,
 612                             freevars,
 613                             capture_mode_map,
 614                             region_map,
 615                             lang_items,
 616                             stability_index);
 617
 618     // passes are timed inside typeck
 619     typeck::check_crate(&ty_cx, trait_map);
 620
 621     time(time_passes, "check static items", (), |_|
 622          middle::check_static::check_crate(&ty_cx));
 623
 624     // These next two const passes can probably be merged
 625     time(time_passes, "const marking", (), |_|
 626          middle::const_eval::process_crate(&ty_cx));
 627
 628     time(time_passes, "const checking", (), |_|
 629          middle::check_const::check_crate(&ty_cx));
 630
 631     let maps = (external_exports, last_private_map);
 632     let (exported_items, public_items) =
 633             time(time_passes, "privacy checking", maps, |(a, b)|
 634                  rustc_privacy::check_crate(&ty_cx, &export_map, a, b));
 635
 636     time(time_passes, "intrinsic checking", (), |_|
 637          middle::intrinsicck::check_crate(&ty_cx));
 638
 639     time(time_passes, "effect checking", (), |_|
 640          middle::effect::check_crate(&ty_cx));
 641
 642     time(time_passes, "match checking", (), |_|
 643          middle::check_match::check_crate(&ty_cx));
 644
 645     time(time_passes, "liveness checking", (), |_|
 646          middle::liveness::check_crate(&ty_cx));
 647
 648     time(time_passes, "borrow checking", (), |_|
 649          borrowck::check_crate(&ty_cx));
 650
 651     time(time_passes, "rvalue checking", (), |_|
 652          middle::check_rvalues::check_crate(&ty_cx, krate));
 653
 654     // Avoid overwhelming user with errors if type checking failed.
 655     // I'm not sure how helpful this is, to be honest, but it avoids a
 656     // lot of annoying errors in the compile-fail tests (basically,
 657     // lint warnings and so on -- kindck used to do this abort, but
 658     // kindck is gone now). -nmatsakis
 659     ty_cx.sess.abort_if_errors();
 660
 661     let reachable_map =
 662         time(time_passes, "reachability checking", (), |_|
 663              reachable::find_reachable(&ty_cx, &exported_items));
 664
 665     time(time_passes, "death checking", (), |_| {
 666         middle::dead::check_crate(&ty_cx,
 667                                   &exported_items,
 668                                   &reachable_map)
 669     });
 670
 671     time(time_passes, "lint checking", (), |_|
 672          lint::check_crate(&ty_cx, &exported_items));
 673
 674     ty::CrateAnalysis {
 675         export_map: export_map,
 676         ty_cx: ty_cx,
 677         exported_items: exported_items,
 678         public_items: public_items,
 679         reachable: reachable_map,
 680         name: name,
 681         glob_map: glob_map,
 682     }
 683 }
 684
 685 /// Run the translation phase to LLVM, after which the AST and analysis can
 686 /// be discarded.
 687 pub fn phase_4_translate_to_llvm<'tcx>(analysis: ty::CrateAnalysis<'tcx>)
 688                                        -> (ty::ctxt<'tcx>, trans::CrateTranslation) {
 689     let time_passes = analysis.ty_cx.sess.time_passes();
 690
 691     time(time_passes, "resolving dependency formats", (), |_|
 692          dependency_format::calculate(&analysis.ty_cx));
 693
 694     // Option dance to work around the lack of stack once closures.
 695     time(time_passes, "translation", analysis, |analysis|
 696          trans::trans_crate(analysis))
 697 }
 698
 699 /// Run LLVM itself, producing a bitcode file, assembly file or object file
 700 /// as a side effect.
 701 pub fn phase_5_run_llvm_passes(sess: &Session,
 702                                trans: &trans::CrateTranslation,
 703                                outputs: &OutputFilenames) {
 704     if sess.opts.cg.no_integrated_as {
 705         let output_type = config::OutputTypeAssembly;
 706
 707         time(sess.time_passes(), "LLVM passes", (), |_|
 708             write::run_passes(sess, trans, &[output_type], outputs));
 709
 710         write::run_assembler(sess, outputs);
 711
 712         // Remove assembly source, unless --save-temps was specified
 713         if !sess.opts.cg.save_temps {
 714             fs::unlink(&outputs.temp_path(config::OutputTypeAssembly)).unwrap();
 715         }
 716     } else {
 717         time(sess.time_passes(), "LLVM passes", (), |_|
 718             write::run_passes(sess,
 719                               trans,
 720                               &sess.opts.output_types[],
 721                               outputs));
 722     }
 723
 724     sess.abort_if_errors();
 725 }
 726
 727 /// Run the linker on any artifacts that resulted from the LLVM run.
 728 /// This should produce either a finished executable or library.
 729 pub fn phase_6_link_output(sess: &Session,
 730                            trans: &trans::CrateTranslation,
 731                            outputs: &OutputFilenames) {
 732     let old_path = os::getenv("PATH").unwrap_or_else(||String::new());
 733     let mut new_path = sess.host_filesearch(PathKind::All).get_tools_search_paths();
 734     new_path.extend(os::split_paths(&old_path[]).into_iter());
 735     os::setenv("PATH", os::join_paths(&new_path[]).unwrap());
 736
 737     time(sess.time_passes(), "linking", (), |_|
 738          link::link_binary(sess,
 739                            trans,
 740                            outputs,
 741                            &trans.link.crate_name[]));
 742
 743     os::setenv("PATH", old_path);
 744 }
 745
 746 fn escape_dep_filename(filename: &str) -> String {
 747     // Apparently clang and gcc *only* escape spaces:
 748     // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
 749     filename.replace(" ", "\\ ")
 750 }
 751
 752 fn write_out_deps(sess: &Session,
 753                   input: &Input,
 754                   outputs: &OutputFilenames,
 755                   id: &str) {
 756
 757     let mut out_filenames = Vec::new();
 758     for output_type in sess.opts.output_types.iter() {
 759         let file = outputs.path(*output_type);
 760         match *output_type {
 761             config::OutputTypeExe => {
 762                 for output in sess.crate_types.borrow().iter() {
 763                     let p = link::filename_for_input(sess, *output,
 764                                                      id, &file);
 765                     out_filenames.push(p);
 766                 }
 767             }
 768             _ => { out_filenames.push(file); }
 769         }
 770     }
 771
 772     // Write out dependency rules to the dep-info file if requested with
 773     // --dep-info
 774     let deps_filename = match sess.opts.write_dependency_info {
 775         // Use filename from --dep-file argument if given
 776         (true, Some(ref filename)) => filename.clone(),
 777         // Use default filename: crate source filename with extension replaced
 778         // by ".d"
 779         (true, None) => match *input {
 780             Input::File(..) => outputs.with_extension("d"),
 781             Input::Str(..) => {
 782                 sess.warn("can not write --dep-info without a filename \
 783                            when compiling stdin.");
 784                 return
 785             },
 786         },
 787         _ => return,
 788     };
 789
 790     let result = (|&:| -> old_io::IoResult<()> {
 791         // Build a list of files used to compile the output and
 792         // write Makefile-compatible dependency rules
 793         let files: Vec<String> = sess.codemap().files.borrow()
 794                                    .iter().filter(|fmap| fmap.is_real_file())
 795                                    .map(|fmap| escape_dep_filename(&fmap.name[]))
 796                                    .collect();
 797         let mut file = try!(old_io::File::create(&deps_filename));
 798         for path in out_filenames.iter() {
 799             try!(write!(&mut file as &mut Writer,
 800                           "{}: {}\n\n", path.display(), files.connect(" ")));
 801         }
 802         Ok(())
 803     })();
 804
 805     match result {
 806         Ok(()) => {}
 807         Err(e) => {
 808             sess.fatal(&format!("error writing dependencies to `{}`: {}",
 809                                deps_filename.display(), e)[]);
 810         }
 811     }
 812 }
 813
 814 pub fn collect_crate_types(session: &Session,
 815                            attrs: &[ast::Attribute]) -> Vec<config::CrateType> {
 816     // Unconditionally collect crate types from attributes to make them used
 817     let attr_types: Vec<config::CrateType> = attrs.iter().filter_map(|a| {
 818         if a.check_name("crate_type") {
 819             match a.value_str() {
 820                 Some(ref n) if *n == "rlib" => {
 821                     Some(config::CrateTypeRlib)
 822                 }
 823                 Some(ref n) if *n == "dylib" => {
 824                     Some(config::CrateTypeDylib)
 825                 }
 826                 Some(ref n) if *n == "lib" => {
 827                     Some(config::default_lib_output())
 828                 }
 829                 Some(ref n) if *n == "staticlib" => {
 830                     Some(config::CrateTypeStaticlib)
 831                 }
 832                 Some(ref n) if *n == "bin" => Some(config::CrateTypeExecutable),
 833                 Some(_) => {
 834                     session.add_lint(lint::builtin::UNKNOWN_CRATE_TYPES,
 835                                      ast::CRATE_NODE_ID,
 836                                      a.span,
 837                                      "invalid `crate_type` \
 838                                       value".to_string());
 839                     None
 840                 }
 841                 _ => {
 842                     session.add_lint(lint::builtin::UNKNOWN_CRATE_TYPES,
 843                                      ast::CRATE_NODE_ID,
 844                                      a.span,
 845                                      "`crate_type` requires a \
 846                                       value".to_string());
 847                     None
 848                 }
 849             }
 850         } else {
 851             None
 852         }
 853     }).collect();
 854
 855     // If we're generating a test executable, then ignore all other output
 856     // styles at all other locations
 857     if session.opts.test {
 858         return vec!(config::CrateTypeExecutable)
 859     }
 860
 861     // Only check command line flags if present. If no types are specified by
 862     // command line, then reuse the empty `base` Vec to hold the types that
 863     // will be found in crate attributes.
 864     let mut base = session.opts.crate_types.clone();
 865     if base.len() == 0 {
 866         base.extend(attr_types.into_iter());
 867         if base.len() == 0 {
 868             base.push(link::default_output_for_target(session));
 869         }
 870         base.sort();
 871         base.dedup();
 872     }
 873
 874     base.into_iter().filter(|crate_type| {
 875         let res = !link::invalid_output_for_target(session, *crate_type);
 876
 877         if !res {
 878             session.warn(&format!("dropping unsupported crate type `{:?}` \
 879                                    for target `{}`",
 880                                  *crate_type, session.opts.target_triple)[]);
 881         }
 882
 883         res
 884     }).collect()
 885 }
 886
 887 pub fn collect_crate_metadata(session: &Session,
 888                               _attrs: &[ast::Attribute]) -> Vec<String> {
 889     session.opts.cg.metadata.clone()
 890 }
 891
 892 pub fn build_output_filenames(input: &Input,
 893                               odir: &Option<Path>,
 894                               ofile: &Option<Path>,
 895                               attrs: &[ast::Attribute],
 896                               sess: &Session)
 897                            -> OutputFilenames {
 898     match *ofile {
 899         None => {
 900             // "-" as input file will cause the parser to read from stdin so we
 901             // have to make up a name
 902             // We want to toss everything after the final '.'
 903             let dirpath = match *odir {
 904                 Some(ref d) => d.clone(),
 905                 None => Path::new(".")
 906             };
 907
 908             // If a crate name is present, we use it as the link name
 909             let stem = sess.opts.crate_name.clone().or_else(|| {
 910                 attr::find_crate_name(attrs).map(|n| n.get().to_string())
 911             }).unwrap_or(input.filestem());
 912
 913             OutputFilenames {
 914                 out_directory: dirpath,
 915                 out_filestem: stem,
 916                 single_output_file: None,
 917                 extra: sess.opts.cg.extra_filename.clone(),
 918             }
 919         }
 920
 921         Some(ref out_file) => {
 922             let ofile = if sess.opts.output_types.len() > 1 {
 923                 sess.warn("ignoring specified output filename because multiple \
 924                            outputs were requested");
 925                 None
 926             } else {
 927                 Some(out_file.clone())
 928             };
 929             if *odir != None {
 930                 sess.warn("ignoring --out-dir flag due to -o flag.");
 931             }
 932             OutputFilenames {
 933                 out_directory: out_file.dir_path(),
 934                 out_filestem: out_file.filestem_str().unwrap().to_string(),
 935                 single_output_file: ofile,
 936                 extra: sess.opts.cg.extra_filename.clone(),
 937             }
 938         }
 939     }
 940 }