]> git.lizzy.rs Git - rust.git/blob - src/librustc_driver/driver.rs
Partial rewrite/expansion of `Vec::truncate` documentation.
[rust.git] / src / librustc_driver / driver.rs
1 // Copyright 2012-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 use rustc::hir;
12 use rustc::hir::{map as hir_map, FreevarMap, TraitMap};
13 use rustc::hir::def::DefMap;
14 use rustc::hir::lowering::lower_crate;
15 use rustc_mir as mir;
16 use rustc::mir::mir_map::MirMap;
17 use rustc::session::{Session, CompileResult, compile_result_from_err_count};
18 use rustc::session::config::{self, Input, OutputFilenames, OutputType};
19 use rustc::session::search_paths::PathKind;
20 use rustc::lint;
21 use rustc::middle::{self, dependency_format, stability, reachable};
22 use rustc::middle::privacy::AccessLevels;
23 use rustc::ty::{self, TyCtxt};
24 use rustc::util::common::time;
25 use rustc::util::nodemap::NodeSet;
26 use rustc_back::sha2::{Sha256, Digest};
27 use rustc_borrowck as borrowck;
28 use rustc_incremental;
29 use rustc_resolve::{MakeGlobMap, Resolver};
30 use rustc_metadata::macro_import;
31 use rustc_metadata::creader::read_local_crates;
32 use rustc_metadata::cstore::CStore;
33 use rustc_trans::back::{link, write};
34 use rustc_trans as trans;
35 use rustc_typeck as typeck;
36 use rustc_privacy;
37 use rustc_plugin::registry::Registry;
38 use rustc_plugin as plugin;
39 use rustc_passes::{ast_validation, no_asm, loops, consts, rvalues, static_recursion};
40 use rustc_const_eval::check_match;
41 use super::Compilation;
42
43 use serialize::json;
44
45 use std::collections::HashMap;
46 use std::env;
47 use std::ffi::{OsString, OsStr};
48 use std::fs;
49 use std::io::{self, Write};
50 use std::path::{Path, PathBuf};
51 use syntax::{ast, diagnostics, visit};
52 use syntax::attr::{self, AttrMetaMethods};
53 use syntax::parse::{self, PResult, token};
54 use syntax::util::node_count::NodeCounter;
55 use syntax;
56 use syntax_ext;
57
58 #[derive(Clone)]
59 pub struct Resolutions {
60     pub def_map: DefMap,
61     pub freevars: FreevarMap,
62     pub trait_map: TraitMap,
63     pub maybe_unused_trait_imports: NodeSet,
64 }
65
66 pub fn compile_input(sess: &Session,
67                      cstore: &CStore,
68                      cfg: ast::CrateConfig,
69                      input: &Input,
70                      outdir: &Option<PathBuf>,
71                      output: &Option<PathBuf>,
72                      addl_plugins: Option<Vec<String>>,
73                      control: &CompileController) -> CompileResult {
74     macro_rules! controller_entry_point {
75         ($point: ident, $tsess: expr, $make_state: expr, $phase_result: expr) => {{
76             let state = &mut $make_state;
77             let phase_result: &CompileResult = &$phase_result;
78             if phase_result.is_ok() || control.$point.run_callback_on_error {
79                 (control.$point.callback)(state);
80             }
81
82             if control.$point.stop == Compilation::Stop {
83                 return compile_result_from_err_count($tsess.err_count());
84             }
85         }}
86     }
87
88     // We need nested scopes here, because the intermediate results can keep
89     // large chunks of memory alive and we want to free them as soon as
90     // possible to keep the peak memory usage low
91     let (outputs, trans) = {
92         let krate = match phase_1_parse_input(sess, cfg, input) {
93             Ok(krate) => krate,
94             Err(mut parse_error) => {
95                 parse_error.emit();
96                 return Err(1);
97             }
98         };
99
100         let krate = {
101             let mut compile_state = CompileState::state_after_parse(input,
102                                                                     sess,
103                                                                     outdir,
104                                                                     output,
105                                                                     krate,
106                                                                     &cstore);
107             controller_entry_point!(after_parse,
108                                     sess,
109                                     compile_state,
110                                     Ok(()));
111
112             compile_state.krate.unwrap()
113         };
114
115         let outputs = build_output_filenames(input, outdir, output, &krate.attrs, sess);
116         let id = link::find_crate_name(Some(sess), &krate.attrs, input);
117         let ExpansionResult { expanded_crate, defs, analysis, resolutions, mut hir_forest } = {
118             phase_2_configure_and_expand(
119                 sess, &cstore, krate, &id, addl_plugins, control.make_glob_map,
120                 |expanded_crate| {
121                     let mut state = CompileState::state_after_expand(
122                         input, sess, outdir, output, &cstore, expanded_crate, &id,
123                     );
124                     controller_entry_point!(after_expand, sess, state, Ok(()));
125                     Ok(())
126                 }
127             )?
128         };
129
130         write_out_deps(sess, &outputs, &id);
131
132         let arenas = ty::CtxtArenas::new();
133
134         // Construct the HIR map
135         let hir_map = time(sess.time_passes(),
136                            "indexing hir",
137                            || hir_map::map_crate(&mut hir_forest, defs));
138
139         {
140             let _ignore = hir_map.dep_graph.in_ignore();
141             controller_entry_point!(after_hir_lowering,
142                                     sess,
143                                     CompileState::state_after_hir_lowering(input,
144                                                                   sess,
145                                                                   outdir,
146                                                                   output,
147                                                                   &arenas,
148                                                                   &cstore,
149                                                                   &hir_map,
150                                                                   &analysis,
151                                                                   &resolutions,
152                                                                   &expanded_crate,
153                                                                   &hir_map.krate(),
154                                                                   &id),
155                                     Ok(()));
156         }
157
158         time(sess.time_passes(), "attribute checking", || {
159             hir::check_attr::check_crate(sess, &expanded_crate);
160         });
161
162         let opt_crate = if keep_ast(sess) {
163             Some(&expanded_crate)
164         } else {
165             drop(expanded_crate);
166             None
167         };
168
169         phase_3_run_analysis_passes(sess,
170                                     hir_map,
171                                     analysis,
172                                     resolutions,
173                                     &arenas,
174                                     &id,
175                                     |tcx, mir_map, analysis, result| {
176             {
177                 // Eventually, we will want to track plugins.
178                 let _ignore = tcx.dep_graph.in_ignore();
179
180                 let mut state = CompileState::state_after_analysis(input,
181                                                                    sess,
182                                                                    outdir,
183                                                                    output,
184                                                                    opt_crate,
185                                                                    tcx.map.krate(),
186                                                                    &analysis,
187                                                                    mir_map.as_ref(),
188                                                                    tcx,
189                                                                    &id);
190                 (control.after_analysis.callback)(&mut state);
191
192                 if control.after_analysis.stop == Compilation::Stop {
193                     return result.and_then(|_| Err(0usize));
194                 }
195             }
196
197             result?;
198
199             if log_enabled!(::log::INFO) {
200                 println!("Pre-trans");
201                 tcx.print_debug_stats();
202             }
203             let trans = phase_4_translate_to_llvm(tcx,
204                                                   mir_map.unwrap(),
205                                                   analysis);
206
207             if log_enabled!(::log::INFO) {
208                 println!("Post-trans");
209                 tcx.print_debug_stats();
210             }
211
212             // Discard interned strings as they are no longer required.
213             token::clear_ident_interner();
214
215             Ok((outputs, trans))
216         })??
217     };
218
219     let phase5_result = phase_5_run_llvm_passes(sess, &trans, &outputs);
220
221     controller_entry_point!(after_llvm,
222                             sess,
223                             CompileState::state_after_llvm(input, sess, outdir, output, &trans),
224                             phase5_result);
225     phase5_result?;
226
227     write::cleanup_llvm(&trans);
228
229     phase_6_link_output(sess, &trans, &outputs);
230
231     controller_entry_point!(compilation_done,
232                             sess,
233                             CompileState::state_when_compilation_done(input, sess, outdir, output),
234                             Ok(()));
235
236     Ok(())
237 }
238
239 fn keep_mtwt_tables(sess: &Session) -> bool {
240     sess.opts.debugging_opts.keep_mtwt_tables
241 }
242
243 fn keep_ast(sess: &Session) -> bool {
244     sess.opts.debugging_opts.keep_ast ||
245     sess.opts.debugging_opts.save_analysis ||
246     sess.opts.debugging_opts.save_analysis_csv
247 }
248
249 /// The name used for source code that doesn't originate in a file
250 /// (e.g. source from stdin or a string)
251 pub fn anon_src() -> String {
252     "<anon>".to_string()
253 }
254
255 pub fn source_name(input: &Input) -> String {
256     match *input {
257         // FIXME (#9639): This needs to handle non-utf8 paths
258         Input::File(ref ifile) => ifile.to_str().unwrap().to_string(),
259         Input::Str { ref name, .. } => name.clone(),
260     }
261 }
262
263 /// CompileController is used to customise compilation, it allows compilation to
264 /// be stopped and/or to call arbitrary code at various points in compilation.
265 /// It also allows for various flags to be set to influence what information gets
266 /// collected during compilation.
267 ///
268 /// This is a somewhat higher level controller than a Session - the Session
269 /// controls what happens in each phase, whereas the CompileController controls
270 /// whether a phase is run at all and whether other code (from outside the
271 /// the compiler) is run between phases.
272 ///
273 /// Note that if compilation is set to stop and a callback is provided for a
274 /// given entry point, the callback is called before compilation is stopped.
275 ///
276 /// Expect more entry points to be added in the future.
277 pub struct CompileController<'a> {
278     pub after_parse: PhaseController<'a>,
279     pub after_expand: PhaseController<'a>,
280     pub after_hir_lowering: PhaseController<'a>,
281     pub after_analysis: PhaseController<'a>,
282     pub after_llvm: PhaseController<'a>,
283     pub compilation_done: PhaseController<'a>,
284
285     pub make_glob_map: MakeGlobMap,
286 }
287
288 impl<'a> CompileController<'a> {
289     pub fn basic() -> CompileController<'a> {
290         CompileController {
291             after_parse: PhaseController::basic(),
292             after_expand: PhaseController::basic(),
293             after_hir_lowering: PhaseController::basic(),
294             after_analysis: PhaseController::basic(),
295             after_llvm: PhaseController::basic(),
296             compilation_done: PhaseController::basic(),
297             make_glob_map: MakeGlobMap::No,
298         }
299     }
300 }
301
302 pub struct PhaseController<'a> {
303     pub stop: Compilation,
304     // If true then the compiler will try to run the callback even if the phase
305     // ends with an error. Note that this is not always possible.
306     pub run_callback_on_error: bool,
307     pub callback: Box<Fn(&mut CompileState) + 'a>,
308 }
309
310 impl<'a> PhaseController<'a> {
311     pub fn basic() -> PhaseController<'a> {
312         PhaseController {
313             stop: Compilation::Continue,
314             run_callback_on_error: false,
315             callback: box |_| {},
316         }
317     }
318 }
319
320 /// State that is passed to a callback. What state is available depends on when
321 /// during compilation the callback is made. See the various constructor methods
322 /// (`state_*`) in the impl to see which data is provided for any given entry point.
323 pub struct CompileState<'a, 'b, 'ast: 'a, 'tcx: 'b> where 'ast: 'tcx {
324     pub input: &'a Input,
325     pub session: &'ast Session,
326     pub krate: Option<ast::Crate>,
327     pub cstore: Option<&'a CStore>,
328     pub crate_name: Option<&'a str>,
329     pub output_filenames: Option<&'a OutputFilenames>,
330     pub out_dir: Option<&'a Path>,
331     pub out_file: Option<&'a Path>,
332     pub arenas: Option<&'ast ty::CtxtArenas<'ast>>,
333     pub expanded_crate: Option<&'a ast::Crate>,
334     pub hir_crate: Option<&'a hir::Crate>,
335     pub ast_map: Option<&'a hir_map::Map<'ast>>,
336     pub resolutions: Option<&'a Resolutions>,
337     pub mir_map: Option<&'b MirMap<'tcx>>,
338     pub analysis: Option<&'a ty::CrateAnalysis<'a>>,
339     pub tcx: Option<TyCtxt<'b, 'tcx, 'tcx>>,
340     pub trans: Option<&'a trans::CrateTranslation>,
341 }
342
343 impl<'a, 'b, 'ast, 'tcx> CompileState<'a, 'b, 'ast, 'tcx> {
344     fn empty(input: &'a Input,
345              session: &'ast Session,
346              out_dir: &'a Option<PathBuf>)
347              -> CompileState<'a, 'b, 'ast, 'tcx> {
348         CompileState {
349             input: input,
350             session: session,
351             out_dir: out_dir.as_ref().map(|s| &**s),
352             out_file: None,
353             arenas: None,
354             krate: None,
355             cstore: None,
356             crate_name: None,
357             output_filenames: None,
358             expanded_crate: None,
359             hir_crate: None,
360             ast_map: None,
361             resolutions: None,
362             analysis: None,
363             mir_map: None,
364             tcx: None,
365             trans: None,
366         }
367     }
368
369     fn state_after_parse(input: &'a Input,
370                          session: &'ast Session,
371                          out_dir: &'a Option<PathBuf>,
372                          out_file: &'a Option<PathBuf>,
373                          krate: ast::Crate,
374                          cstore: &'a CStore)
375                          -> CompileState<'a, 'b, 'ast, 'tcx> {
376         CompileState {
377             krate: Some(krate),
378             cstore: Some(cstore),
379             out_file: out_file.as_ref().map(|s| &**s),
380             ..CompileState::empty(input, session, out_dir)
381         }
382     }
383
384     fn state_after_expand(input: &'a Input,
385                           session: &'ast Session,
386                           out_dir: &'a Option<PathBuf>,
387                           out_file: &'a Option<PathBuf>,
388                           cstore: &'a CStore,
389                           expanded_crate: &'a ast::Crate,
390                           crate_name: &'a str)
391                           -> CompileState<'a, 'b, 'ast, 'tcx> {
392         CompileState {
393             crate_name: Some(crate_name),
394             cstore: Some(cstore),
395             expanded_crate: Some(expanded_crate),
396             out_file: out_file.as_ref().map(|s| &**s),
397             ..CompileState::empty(input, session, out_dir)
398         }
399     }
400
401     fn state_after_hir_lowering(input: &'a Input,
402                                 session: &'ast Session,
403                                 out_dir: &'a Option<PathBuf>,
404                                 out_file: &'a Option<PathBuf>,
405                                 arenas: &'ast ty::CtxtArenas<'ast>,
406                                 cstore: &'a CStore,
407                                 hir_map: &'a hir_map::Map<'ast>,
408                                 analysis: &'a ty::CrateAnalysis,
409                                 resolutions: &'a Resolutions,
410                                 krate: &'a ast::Crate,
411                                 hir_crate: &'a hir::Crate,
412                                 crate_name: &'a str)
413                                 -> CompileState<'a, 'b, 'ast, 'tcx> {
414         CompileState {
415             crate_name: Some(crate_name),
416             arenas: Some(arenas),
417             cstore: Some(cstore),
418             ast_map: Some(hir_map),
419             analysis: Some(analysis),
420             resolutions: Some(resolutions),
421             expanded_crate: Some(krate),
422             hir_crate: Some(hir_crate),
423             out_file: out_file.as_ref().map(|s| &**s),
424             ..CompileState::empty(input, session, out_dir)
425         }
426     }
427
428     fn state_after_analysis(input: &'a Input,
429                             session: &'ast Session,
430                             out_dir: &'a Option<PathBuf>,
431                             out_file: &'a Option<PathBuf>,
432                             krate: Option<&'a ast::Crate>,
433                             hir_crate: &'a hir::Crate,
434                             analysis: &'a ty::CrateAnalysis<'a>,
435                             mir_map: Option<&'b MirMap<'tcx>>,
436                             tcx: TyCtxt<'b, 'tcx, 'tcx>,
437                             crate_name: &'a str)
438                             -> CompileState<'a, 'b, 'ast, 'tcx> {
439         CompileState {
440             analysis: Some(analysis),
441             mir_map: mir_map,
442             tcx: Some(tcx),
443             expanded_crate: krate,
444             hir_crate: Some(hir_crate),
445             crate_name: Some(crate_name),
446             out_file: out_file.as_ref().map(|s| &**s),
447             ..CompileState::empty(input, session, out_dir)
448         }
449     }
450
451
452     fn state_after_llvm(input: &'a Input,
453                         session: &'ast Session,
454                         out_dir: &'a Option<PathBuf>,
455                         out_file: &'a Option<PathBuf>,
456                         trans: &'a trans::CrateTranslation)
457                         -> CompileState<'a, 'b, 'ast, 'tcx> {
458         CompileState {
459             trans: Some(trans),
460             out_file: out_file.as_ref().map(|s| &**s),
461             ..CompileState::empty(input, session, out_dir)
462         }
463     }
464
465     fn state_when_compilation_done(input: &'a Input,
466                                     session: &'ast Session,
467                                     out_dir: &'a Option<PathBuf>,
468                                     out_file: &'a Option<PathBuf>)
469                                     -> CompileState<'a, 'b, 'ast, 'tcx> {
470         CompileState {
471             out_file: out_file.as_ref().map(|s| &**s),
472             ..CompileState::empty(input, session, out_dir)
473         }
474     }
475 }
476
477 pub fn phase_1_parse_input<'a>(sess: &'a Session,
478                                cfg: ast::CrateConfig,
479                                input: &Input)
480                                -> PResult<'a, ast::Crate> {
481     // These may be left in an incoherent state after a previous compile.
482     // `clear_tables` and `clear_ident_interner` can be used to free
483     // memory, but they do not restore the initial state.
484     syntax::ext::mtwt::reset_tables();
485     token::reset_ident_interner();
486     let continue_after_error = sess.opts.continue_parse_after_error;
487     sess.diagnostic().set_continue_after_error(continue_after_error);
488
489     let krate = time(sess.time_passes(), "parsing", || {
490         match *input {
491             Input::File(ref file) => {
492                 parse::parse_crate_from_file(file, cfg.clone(), &sess.parse_sess)
493             }
494             Input::Str { ref input, ref name } => {
495                 parse::parse_crate_from_source_str(name.clone(),
496                                                    input.clone(),
497                                                    cfg.clone(),
498                                                    &sess.parse_sess)
499             }
500         }
501     })?;
502
503     sess.diagnostic().set_continue_after_error(true);
504
505     if sess.opts.debugging_opts.ast_json_noexpand {
506         println!("{}", json::as_json(&krate));
507     }
508
509     if sess.opts.debugging_opts.input_stats {
510         println!("Lines of code:             {}", sess.codemap().count_lines());
511         println!("Pre-expansion node count:  {}", count_nodes(&krate));
512     }
513
514     if let Some(ref s) = sess.opts.debugging_opts.show_span {
515         syntax::show_span::run(sess.diagnostic(), s, &krate);
516     }
517
518     Ok(krate)
519 }
520
521 fn count_nodes(krate: &ast::Crate) -> usize {
522     let mut counter = NodeCounter::new();
523     visit::walk_crate(&mut counter, krate);
524     counter.count
525 }
526
527 // For continuing compilation after a parsed crate has been
528 // modified
529
530 pub struct ExpansionResult<'a> {
531     pub expanded_crate: ast::Crate,
532     pub defs: hir_map::Definitions,
533     pub analysis: ty::CrateAnalysis<'a>,
534     pub resolutions: Resolutions,
535     pub hir_forest: hir_map::Forest,
536 }
537
538 /// Run the "early phases" of the compiler: initial `cfg` processing,
539 /// loading compiler plugins (including those from `addl_plugins`),
540 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
541 /// harness if one is to be provided, injection of a dependency on the
542 /// standard library and prelude, and name resolution.
543 ///
544 /// Returns `None` if we're aborting after handling -W help.
545 pub fn phase_2_configure_and_expand<'a, F>(sess: &Session,
546                                            cstore: &CStore,
547                                            mut krate: ast::Crate,
548                                            crate_name: &'a str,
549                                            addl_plugins: Option<Vec<String>>,
550                                            make_glob_map: MakeGlobMap,
551                                            after_expand: F)
552                                            -> Result<ExpansionResult<'a>, usize>
553     where F: FnOnce(&ast::Crate) -> CompileResult,
554 {
555     let time_passes = sess.time_passes();
556
557     // strip before anything else because crate metadata may use #[cfg_attr]
558     // and so macros can depend on configuration variables, such as
559     //
560     //   #[macro_use] #[cfg(foo)]
561     //   mod bar { macro_rules! baz!(() => {{}}) }
562     //
563     // baz! should not use this definition unless foo is enabled.
564
565     krate = time(time_passes, "configuration", || {
566         let (krate, features) =
567             syntax::config::strip_unconfigured_items(krate, &sess.parse_sess, sess.opts.test);
568         // these need to be set "early" so that expansion sees `quote` if enabled.
569         *sess.features.borrow_mut() = features;
570         krate
571     });
572
573     *sess.crate_types.borrow_mut() = collect_crate_types(sess, &krate.attrs);
574     sess.crate_disambiguator.set(token::intern(&compute_crate_disambiguator(sess)));
575
576     time(time_passes, "recursion limit", || {
577         middle::recursion_limit::update_recursion_limit(sess, &krate);
578     });
579
580     krate = time(time_passes, "crate injection", || {
581         let alt_std_name = sess.opts.alt_std_name.clone();
582         syntax::std_inject::maybe_inject_crates_ref(&sess.parse_sess, krate, alt_std_name)
583     });
584
585     let mut addl_plugins = Some(addl_plugins);
586     let registrars = time(time_passes, "plugin loading", || {
587         plugin::load::load_plugins(sess,
588                                    &cstore,
589                                    &krate,
590                                    crate_name,
591                                    addl_plugins.take().unwrap())
592     });
593
594     let mut registry = Registry::new(sess, &krate);
595
596     time(time_passes, "plugin registration", || {
597         if sess.features.borrow().rustc_diagnostic_macros {
598             registry.register_macro("__diagnostic_used",
599                                     diagnostics::plugin::expand_diagnostic_used);
600             registry.register_macro("__register_diagnostic",
601                                     diagnostics::plugin::expand_register_diagnostic);
602             registry.register_macro("__build_diagnostic_array",
603                                     diagnostics::plugin::expand_build_diagnostic_array);
604         }
605
606         for registrar in registrars {
607             registry.args_hidden = Some(registrar.args);
608             (registrar.fun)(&mut registry);
609         }
610     });
611
612     let Registry { syntax_exts, early_lint_passes, late_lint_passes, lint_groups,
613                    llvm_passes, attributes, mir_passes, .. } = registry;
614
615     sess.track_errors(|| {
616         let mut ls = sess.lint_store.borrow_mut();
617         for pass in early_lint_passes {
618             ls.register_early_pass(Some(sess), true, pass);
619         }
620         for pass in late_lint_passes {
621             ls.register_late_pass(Some(sess), true, pass);
622         }
623
624         for (name, to) in lint_groups {
625             ls.register_group(Some(sess), true, name, to);
626         }
627
628         *sess.plugin_llvm_passes.borrow_mut() = llvm_passes;
629         sess.mir_passes.borrow_mut().extend(mir_passes);
630         *sess.plugin_attributes.borrow_mut() = attributes.clone();
631     })?;
632
633     // Lint plugins are registered; now we can process command line flags.
634     if sess.opts.describe_lints {
635         super::describe_lints(&sess.lint_store.borrow(), true);
636         return Err(0);
637     }
638     sess.track_errors(|| sess.lint_store.borrow_mut().process_command_line(sess))?;
639
640     krate = time(time_passes, "expansion", || {
641         // Windows dlls do not have rpaths, so they don't know how to find their
642         // dependencies. It's up to us to tell the system where to find all the
643         // dependent dlls. Note that this uses cfg!(windows) as opposed to
644         // targ_cfg because syntax extensions are always loaded for the host
645         // compiler, not for the target.
646         //
647         // This is somewhat of an inherently racy operation, however, as
648         // multiple threads calling this function could possibly continue
649         // extending PATH far beyond what it should. To solve this for now we
650         // just don't add any new elements to PATH which are already there
651         // within PATH. This is basically a targeted fix at #17360 for rustdoc
652         // which runs rustc in parallel but has been seen (#33844) to cause
653         // problems with PATH becoming too long.
654         let mut old_path = OsString::new();
655         if cfg!(windows) {
656             old_path = env::var_os("PATH").unwrap_or(old_path);
657             let mut new_path = sess.host_filesearch(PathKind::All)
658                                    .get_dylib_search_paths();
659             for path in env::split_paths(&old_path) {
660                 if !new_path.contains(&path) {
661                     new_path.push(path);
662                 }
663             }
664             env::set_var("PATH", &env::join_paths(new_path).unwrap());
665         }
666         let features = sess.features.borrow();
667         let cfg = syntax::ext::expand::ExpansionConfig {
668             crate_name: crate_name.to_string(),
669             features: Some(&features),
670             recursion_limit: sess.recursion_limit.get(),
671             trace_mac: sess.opts.debugging_opts.trace_macros,
672             should_test: sess.opts.test,
673         };
674         let mut loader = macro_import::MacroLoader::new(sess, &cstore, crate_name);
675         let mut ecx = syntax::ext::base::ExtCtxt::new(&sess.parse_sess,
676                                                       krate.config.clone(),
677                                                       cfg,
678                                                       &mut loader);
679         syntax_ext::register_builtins(&mut ecx.syntax_env);
680         let (ret, macro_names) = syntax::ext::expand::expand_crate(ecx,
681                                                                    syntax_exts,
682                                                                    krate);
683         if cfg!(windows) {
684             env::set_var("PATH", &old_path);
685         }
686         *sess.available_macros.borrow_mut() = macro_names;
687         ret
688     });
689
690     krate = time(time_passes, "maybe building test harness", || {
691         syntax::test::modify_for_testing(&sess.parse_sess,
692                                          sess.opts.test,
693                                          krate,
694                                          sess.diagnostic())
695     });
696
697     let resolver_arenas = Resolver::arenas();
698     let mut resolver = Resolver::new(sess, make_glob_map, &resolver_arenas);
699
700     let krate = time(sess.time_passes(), "assigning node ids", || resolver.assign_node_ids(krate));
701
702     if sess.opts.debugging_opts.input_stats {
703         println!("Post-expansion node count: {}", count_nodes(&krate));
704     }
705
706     if sess.opts.debugging_opts.ast_json {
707         println!("{}", json::as_json(&krate));
708     }
709
710     time(time_passes,
711          "checking for inline asm in case the target doesn't support it",
712          || no_asm::check_crate(sess, &krate));
713
714     // Needs to go *after* expansion to be able to check the results of macro expansion.
715     time(time_passes, "complete gated feature checking", || {
716         sess.track_errors(|| {
717             syntax::feature_gate::check_crate(&krate,
718                                               &sess.parse_sess,
719                                               &sess.features.borrow(),
720                                               &attributes,
721                                               sess.opts.unstable_features);
722         })
723     })?;
724
725     // Collect defintions for def ids.
726     time(sess.time_passes(), "collecting defs", || resolver.definitions.collect(&krate));
727
728     time(sess.time_passes(), "external crate/lib resolution", || {
729         let defs = &resolver.definitions;
730         read_local_crates(sess, &cstore, defs, &krate, crate_name, &sess.dep_graph)
731     });
732
733     time(sess.time_passes(),
734          "early lint checks",
735          || lint::check_ast_crate(sess, &krate));
736
737     time(sess.time_passes(),
738          "AST validation",
739          || ast_validation::check_crate(sess, &krate));
740
741     time(sess.time_passes(), "name resolution", || -> CompileResult {
742         // Currently, we ignore the name resolution data structures for the purposes of dependency
743         // tracking. Instead we will run name resolution and include its output in the hash of each
744         // item, much like we do for macro expansion. In other words, the hash reflects not just
745         // its contents but the results of name resolution on those contents. Hopefully we'll push
746         // this back at some point.
747         let _ignore = sess.dep_graph.in_ignore();
748         resolver.build_reduced_graph(&krate);
749         resolver.resolve_imports();
750
751         // Since import resolution will eventually happen in expansion,
752         // don't perform `after_expand` until after import resolution.
753         after_expand(&krate)?;
754
755         resolver.resolve_crate(&krate);
756         Ok(())
757     })?;
758
759     // Lower ast -> hir.
760     let hir_forest = time(sess.time_passes(), "lowering ast -> hir", || {
761         hir_map::Forest::new(lower_crate(sess, &krate, &mut resolver), &sess.dep_graph)
762     });
763
764     // Discard MTWT tables that aren't required past lowering to HIR.
765     if !keep_mtwt_tables(sess) {
766         syntax::ext::mtwt::clear_tables();
767     }
768
769     Ok(ExpansionResult {
770         expanded_crate: krate,
771         defs: resolver.definitions,
772         analysis: ty::CrateAnalysis {
773             export_map: resolver.export_map,
774             access_levels: AccessLevels::default(),
775             reachable: NodeSet(),
776             name: crate_name,
777             glob_map: if resolver.make_glob_map { Some(resolver.glob_map) } else { None },
778         },
779         resolutions: Resolutions {
780             def_map: resolver.def_map,
781             freevars: resolver.freevars,
782             trait_map: resolver.trait_map,
783             maybe_unused_trait_imports: resolver.maybe_unused_trait_imports,
784         },
785         hir_forest: hir_forest
786     })
787 }
788
789 /// Run the resolution, typechecking, region checking and other
790 /// miscellaneous analysis passes on the crate. Return various
791 /// structures carrying the results of the analysis.
792 pub fn phase_3_run_analysis_passes<'tcx, F, R>(sess: &'tcx Session,
793                                                hir_map: hir_map::Map<'tcx>,
794                                                mut analysis: ty::CrateAnalysis,
795                                                resolutions: Resolutions,
796                                                arenas: &'tcx ty::CtxtArenas<'tcx>,
797                                                name: &str,
798                                                f: F)
799                                                -> Result<R, usize>
800     where F: for<'a> FnOnce(TyCtxt<'a, 'tcx, 'tcx>,
801                             Option<MirMap<'tcx>>,
802                             ty::CrateAnalysis,
803                             CompileResult) -> R
804 {
805     macro_rules! try_with_f {
806         ($e: expr, ($t: expr, $m: expr, $a: expr)) => {
807             match $e {
808                 Ok(x) => x,
809                 Err(x) => {
810                     f($t, $m, $a, Err(x));
811                     return Err(x);
812                 }
813             }
814         }
815     }
816
817     let time_passes = sess.time_passes();
818
819     let lang_items = time(time_passes, "language item collection", || {
820         sess.track_errors(|| {
821             middle::lang_items::collect_language_items(&sess, &hir_map)
822         })
823     })?;
824
825     let named_region_map = time(time_passes,
826                                 "lifetime resolution",
827                                 || middle::resolve_lifetime::krate(sess,
828                                                                    &hir_map,
829                                                                    &resolutions.def_map))?;
830
831     time(time_passes,
832          "looking for entry point",
833          || middle::entry::find_entry_point(sess, &hir_map));
834
835     sess.plugin_registrar_fn.set(time(time_passes, "looking for plugin registrar", || {
836         plugin::build::find_plugin_registrar(sess.diagnostic(), &hir_map)
837     }));
838
839     let region_map = time(time_passes,
840                           "region resolution",
841                           || middle::region::resolve_crate(sess, &hir_map));
842
843     time(time_passes,
844          "loop checking",
845          || loops::check_crate(sess, &hir_map));
846
847     time(time_passes,
848               "static item recursion checking",
849               || static_recursion::check_crate(sess, &resolutions.def_map, &hir_map))?;
850
851     let index = stability::Index::new(&hir_map);
852
853     let trait_map = resolutions.trait_map;
854     TyCtxt::create_and_enter(sess,
855                              arenas,
856                              resolutions.def_map,
857                              named_region_map,
858                              hir_map,
859                              resolutions.freevars,
860                              resolutions.maybe_unused_trait_imports,
861                              region_map,
862                              lang_items,
863                              index,
864                              name,
865                              |tcx| {
866         time(time_passes,
867              "load_dep_graph",
868              || rustc_incremental::load_dep_graph(tcx));
869
870         // passes are timed inside typeck
871         try_with_f!(typeck::check_crate(tcx, trait_map), (tcx, None, analysis));
872
873         time(time_passes,
874              "const checking",
875              || consts::check_crate(tcx));
876
877         analysis.access_levels =
878             time(time_passes, "privacy checking", || {
879                 rustc_privacy::check_crate(tcx, &analysis.export_map)
880             });
881
882         // Do not move this check past lint
883         time(time_passes, "stability index", || {
884             tcx.stability.borrow_mut().build(tcx, &analysis.access_levels)
885         });
886
887         time(time_passes,
888              "intrinsic checking",
889              || middle::intrinsicck::check_crate(tcx));
890
891         time(time_passes,
892              "effect checking",
893              || middle::effect::check_crate(tcx));
894
895         time(time_passes,
896              "match checking",
897              || check_match::check_crate(tcx));
898
899         // this must run before MIR dump, because
900         // "not all control paths return a value" is reported here.
901         //
902         // maybe move the check to a MIR pass?
903         time(time_passes,
904              "liveness checking",
905              || middle::liveness::check_crate(tcx));
906
907         time(time_passes,
908              "rvalue checking",
909              || rvalues::check_crate(tcx));
910
911         let mut mir_map =
912             time(time_passes,
913                  "MIR dump",
914                  || mir::mir_map::build_mir_for_crate(tcx));
915
916         time(time_passes, "MIR passes", || {
917             let mut passes = sess.mir_passes.borrow_mut();
918             // Push all the built-in passes.
919             passes.push_hook(box mir::transform::dump_mir::DumpMir);
920             passes.push_pass(box mir::transform::simplify_cfg::SimplifyCfg::new("initial"));
921             passes.push_pass(box mir::transform::qualify_consts::QualifyAndPromoteConstants);
922             passes.push_pass(box mir::transform::type_check::TypeckMir);
923             passes.push_pass(
924                 box mir::transform::simplify_branches::SimplifyBranches::new("initial"));
925             passes.push_pass(box mir::transform::simplify_cfg::SimplifyCfg::new("qualify-consts"));
926             // And run everything.
927             passes.run_passes(tcx, &mut mir_map);
928         });
929
930         time(time_passes,
931              "borrow checking",
932              || borrowck::check_crate(tcx, &mir_map));
933
934         // Avoid overwhelming user with errors if type checking failed.
935         // I'm not sure how helpful this is, to be honest, but it avoids
936         // a
937         // lot of annoying errors in the compile-fail tests (basically,
938         // lint warnings and so on -- kindck used to do this abort, but
939         // kindck is gone now). -nmatsakis
940         if sess.err_count() > 0 {
941             return Ok(f(tcx, Some(mir_map), analysis, Err(sess.err_count())));
942         }
943
944         analysis.reachable =
945             time(time_passes,
946                  "reachability checking",
947                  || reachable::find_reachable(tcx, &analysis.access_levels));
948
949         time(time_passes, "death checking", || {
950             middle::dead::check_crate(tcx, &analysis.access_levels);
951         });
952
953         let ref lib_features_used =
954             time(time_passes,
955                  "stability checking",
956                  || stability::check_unstable_api_usage(tcx));
957
958         time(time_passes, "unused lib feature checking", || {
959             stability::check_unused_or_stable_features(&tcx.sess,
960                                                        lib_features_used)
961         });
962
963         time(time_passes,
964              "lint checking",
965              || lint::check_crate(tcx, &analysis.access_levels));
966
967         // The above three passes generate errors w/o aborting
968         if sess.err_count() > 0 {
969             return Ok(f(tcx, Some(mir_map), analysis, Err(sess.err_count())));
970         }
971
972         Ok(f(tcx, Some(mir_map), analysis, Ok(())))
973     })
974 }
975
976 /// Run the translation phase to LLVM, after which the AST and analysis can
977 pub fn phase_4_translate_to_llvm<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
978                                            mut mir_map: MirMap<'tcx>,
979                                            analysis: ty::CrateAnalysis)
980                                            -> trans::CrateTranslation {
981     let time_passes = tcx.sess.time_passes();
982
983     time(time_passes,
984          "resolving dependency formats",
985          || dependency_format::calculate(&tcx.sess));
986
987     // Run the passes that transform the MIR into a more suitable for translation
988     // to LLVM code.
989     time(time_passes, "Prepare MIR codegen passes", || {
990         let mut passes = ::rustc::mir::transform::Passes::new();
991         passes.push_hook(box mir::transform::dump_mir::DumpMir);
992         passes.push_pass(box mir::transform::no_landing_pads::NoLandingPads);
993         passes.push_pass(box mir::transform::simplify_cfg::SimplifyCfg::new("no-landing-pads"));
994
995         passes.push_pass(box mir::transform::erase_regions::EraseRegions);
996
997         passes.push_pass(box mir::transform::add_call_guards::AddCallGuards);
998         passes.push_pass(box borrowck::ElaborateDrops);
999         passes.push_pass(box mir::transform::no_landing_pads::NoLandingPads);
1000         passes.push_pass(box mir::transform::simplify_cfg::SimplifyCfg::new("elaborate-drops"));
1001
1002         passes.push_pass(box mir::transform::add_call_guards::AddCallGuards);
1003         passes.push_pass(box mir::transform::dump_mir::Marker("PreTrans"));
1004
1005         passes.run_passes(tcx, &mut mir_map);
1006     });
1007
1008     let translation =
1009         time(time_passes,
1010              "translation",
1011              move || trans::trans_crate(tcx, &mir_map, analysis));
1012
1013     time(time_passes,
1014          "assert dep graph",
1015          move || rustc_incremental::assert_dep_graph(tcx));
1016
1017     time(time_passes,
1018          "serialize dep graph",
1019          move || rustc_incremental::save_dep_graph(tcx));
1020
1021     translation
1022 }
1023
1024 /// Run LLVM itself, producing a bitcode file, assembly file or object file
1025 /// as a side effect.
1026 pub fn phase_5_run_llvm_passes(sess: &Session,
1027                                trans: &trans::CrateTranslation,
1028                                outputs: &OutputFilenames) -> CompileResult {
1029     if sess.opts.cg.no_integrated_as {
1030         let mut map = HashMap::new();
1031         map.insert(OutputType::Assembly, None);
1032         time(sess.time_passes(),
1033              "LLVM passes",
1034              || write::run_passes(sess, trans, &map, outputs));
1035
1036         write::run_assembler(sess, outputs);
1037
1038         // Remove assembly source, unless --save-temps was specified
1039         if !sess.opts.cg.save_temps {
1040             fs::remove_file(&outputs.temp_path(OutputType::Assembly, None)).unwrap();
1041         }
1042     } else {
1043         time(sess.time_passes(),
1044              "LLVM passes",
1045              || write::run_passes(sess, trans, &sess.opts.output_types, outputs));
1046     }
1047
1048     if sess.err_count() > 0 {
1049         Err(sess.err_count())
1050     } else {
1051         Ok(())
1052     }
1053 }
1054
1055 /// Run the linker on any artifacts that resulted from the LLVM run.
1056 /// This should produce either a finished executable or library.
1057 pub fn phase_6_link_output(sess: &Session,
1058                            trans: &trans::CrateTranslation,
1059                            outputs: &OutputFilenames) {
1060     time(sess.time_passes(),
1061          "linking",
1062          || link::link_binary(sess, trans, outputs, &trans.link.crate_name));
1063 }
1064
1065 fn escape_dep_filename(filename: &str) -> String {
1066     // Apparently clang and gcc *only* escape spaces:
1067     // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
1068     filename.replace(" ", "\\ ")
1069 }
1070
1071 fn write_out_deps(sess: &Session, outputs: &OutputFilenames, id: &str) {
1072     let mut out_filenames = Vec::new();
1073     for output_type in sess.opts.output_types.keys() {
1074         let file = outputs.path(*output_type);
1075         match *output_type {
1076             OutputType::Exe => {
1077                 for output in sess.crate_types.borrow().iter() {
1078                     let p = link::filename_for_input(sess, *output, id, outputs);
1079                     out_filenames.push(p);
1080                 }
1081             }
1082             _ => {
1083                 out_filenames.push(file);
1084             }
1085         }
1086     }
1087
1088     // Write out dependency rules to the dep-info file if requested
1089     if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
1090         return;
1091     }
1092     let deps_filename = outputs.path(OutputType::DepInfo);
1093
1094     let result =
1095         (|| -> io::Result<()> {
1096             // Build a list of files used to compile the output and
1097             // write Makefile-compatible dependency rules
1098             let files: Vec<String> = sess.codemap()
1099                                          .files
1100                                          .borrow()
1101                                          .iter()
1102                                          .filter(|fmap| fmap.is_real_file())
1103                                          .filter(|fmap| !fmap.is_imported())
1104                                          .map(|fmap| escape_dep_filename(&fmap.name))
1105                                          .collect();
1106             let mut file = fs::File::create(&deps_filename)?;
1107             for path in &out_filenames {
1108                 write!(file, "{}: {}\n\n", path.display(), files.join(" "))?;
1109             }
1110
1111             // Emit a fake target for each input file to the compilation. This
1112             // prevents `make` from spitting out an error if a file is later
1113             // deleted. For more info see #28735
1114             for path in files {
1115                 writeln!(file, "{}:", path)?;
1116             }
1117             Ok(())
1118         })();
1119
1120     match result {
1121         Ok(()) => {}
1122         Err(e) => {
1123             sess.fatal(&format!("error writing dependencies to `{}`: {}",
1124                                 deps_filename.display(),
1125                                 e));
1126         }
1127     }
1128 }
1129
1130 pub fn collect_crate_types(session: &Session, attrs: &[ast::Attribute]) -> Vec<config::CrateType> {
1131     // Unconditionally collect crate types from attributes to make them used
1132     let attr_types: Vec<config::CrateType> =
1133         attrs.iter()
1134              .filter_map(|a| {
1135                  if a.check_name("crate_type") {
1136                      match a.value_str() {
1137                          Some(ref n) if *n == "rlib" => {
1138                              Some(config::CrateTypeRlib)
1139                          }
1140                          Some(ref n) if *n == "dylib" => {
1141                              Some(config::CrateTypeDylib)
1142                          }
1143                          Some(ref n) if *n == "cdylib" => {
1144                              Some(config::CrateTypeCdylib)
1145                          }
1146                          Some(ref n) if *n == "lib" => {
1147                              Some(config::default_lib_output())
1148                          }
1149                          Some(ref n) if *n == "staticlib" => {
1150                              Some(config::CrateTypeStaticlib)
1151                          }
1152                          Some(ref n) if *n == "bin" => Some(config::CrateTypeExecutable),
1153                          Some(_) => {
1154                              session.add_lint(lint::builtin::UNKNOWN_CRATE_TYPES,
1155                                               ast::CRATE_NODE_ID,
1156                                               a.span,
1157                                               "invalid `crate_type` value".to_string());
1158                              None
1159                          }
1160                          _ => {
1161                              session.struct_span_err(a.span, "`crate_type` requires a value")
1162                                  .note("for example: `#![crate_type=\"lib\"]`")
1163                                  .emit();
1164                              None
1165                          }
1166                      }
1167                  } else {
1168                      None
1169                  }
1170              })
1171              .collect();
1172
1173     // If we're generating a test executable, then ignore all other output
1174     // styles at all other locations
1175     if session.opts.test {
1176         return vec![config::CrateTypeExecutable];
1177     }
1178
1179     // Only check command line flags if present. If no types are specified by
1180     // command line, then reuse the empty `base` Vec to hold the types that
1181     // will be found in crate attributes.
1182     let mut base = session.opts.crate_types.clone();
1183     if base.is_empty() {
1184         base.extend(attr_types);
1185         if base.is_empty() {
1186             base.push(link::default_output_for_target(session));
1187         }
1188         base.sort();
1189         base.dedup();
1190     }
1191
1192     base.into_iter()
1193         .filter(|crate_type| {
1194             let res = !link::invalid_output_for_target(session, *crate_type);
1195
1196             if !res {
1197                 session.warn(&format!("dropping unsupported crate type `{}` for target `{}`",
1198                                       *crate_type,
1199                                       session.opts.target_triple));
1200             }
1201
1202             res
1203         })
1204         .collect()
1205 }
1206
1207 pub fn compute_crate_disambiguator(session: &Session) -> String {
1208     let mut hasher = Sha256::new();
1209
1210     let mut metadata = session.opts.cg.metadata.clone();
1211     // We don't want the crate_disambiguator to dependent on the order
1212     // -C metadata arguments, so sort them:
1213     metadata.sort();
1214     // Every distinct -C metadata value is only incorporated once:
1215     metadata.dedup();
1216
1217     hasher.input_str("metadata");
1218     for s in &metadata {
1219         // Also incorporate the length of a metadata string, so that we generate
1220         // different values for `-Cmetadata=ab -Cmetadata=c` and
1221         // `-Cmetadata=a -Cmetadata=bc`
1222         hasher.input_str(&format!("{}", s.len())[..]);
1223         hasher.input_str(&s[..]);
1224     }
1225
1226     let mut hash = hasher.result_str();
1227
1228     // If this is an executable, add a special suffix, so that we don't get
1229     // symbol conflicts when linking against a library of the same name.
1230     if session.crate_types.borrow().contains(&config::CrateTypeExecutable) {
1231        hash.push_str("-exe");
1232     }
1233
1234     hash
1235 }
1236
1237 pub fn build_output_filenames(input: &Input,
1238                               odir: &Option<PathBuf>,
1239                               ofile: &Option<PathBuf>,
1240                               attrs: &[ast::Attribute],
1241                               sess: &Session)
1242                               -> OutputFilenames {
1243     match *ofile {
1244         None => {
1245             // "-" as input file will cause the parser to read from stdin so we
1246             // have to make up a name
1247             // We want to toss everything after the final '.'
1248             let dirpath = match *odir {
1249                 Some(ref d) => d.clone(),
1250                 None => PathBuf::new(),
1251             };
1252
1253             // If a crate name is present, we use it as the link name
1254             let stem = sess.opts
1255                            .crate_name
1256                            .clone()
1257                            .or_else(|| attr::find_crate_name(attrs).map(|n| n.to_string()))
1258                            .unwrap_or(input.filestem());
1259
1260             OutputFilenames {
1261                 out_directory: dirpath,
1262                 out_filestem: stem,
1263                 single_output_file: None,
1264                 extra: sess.opts.cg.extra_filename.clone(),
1265                 outputs: sess.opts.output_types.clone(),
1266             }
1267         }
1268
1269         Some(ref out_file) => {
1270             let unnamed_output_types = sess.opts
1271                                            .output_types
1272                                            .values()
1273                                            .filter(|a| a.is_none())
1274                                            .count();
1275             let ofile = if unnamed_output_types > 1 {
1276                 sess.warn("ignoring specified output filename because multiple outputs were \
1277                            requested");
1278                 None
1279             } else {
1280                 Some(out_file.clone())
1281             };
1282             if *odir != None {
1283                 sess.warn("ignoring --out-dir flag due to -o flag.");
1284             }
1285
1286             let cur_dir = Path::new("");
1287
1288             OutputFilenames {
1289                 out_directory: out_file.parent().unwrap_or(cur_dir).to_path_buf(),
1290                 out_filestem: out_file.file_stem()
1291                                       .unwrap_or(OsStr::new(""))
1292                                       .to_str()
1293                                       .unwrap()
1294                                       .to_string(),
1295                 single_output_file: ofile,
1296                 extra: sess.opts.cg.extra_filename.clone(),
1297                 outputs: sess.opts.output_types.clone(),
1298             }
1299         }
1300     }
1301 }