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.
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.
11 use rustc::hir::{self, map as hir_map};
12 use rustc::hir::lowering::lower_crate;
13 use rustc::ich::Fingerprint;
14 use rustc_data_structures::stable_hasher::StableHasher;
16 use rustc::session::{Session, CompileResult};
17 use rustc::session::CompileIncomplete;
18 use rustc::session::config::{self, Input, OutputFilenames, OutputType};
19 use rustc::session::search_paths::PathKind;
21 use rustc::middle::{self, dependency_format, stability, reachable};
22 use rustc::middle::privacy::AccessLevels;
23 use rustc::mir::transform::{MIR_CONST, MIR_VALIDATED, MIR_OPTIMIZED, Passes};
24 use rustc::ty::{self, TyCtxt, Resolutions, GlobalArenas};
26 use rustc::util::common::{ErrorReported, time};
27 use rustc::util::nodemap::NodeSet;
28 use rustc_allocator as allocator;
29 use rustc_borrowck as borrowck;
30 use rustc_incremental::{self, IncrementalHashesMap};
31 use rustc_resolve::{MakeGlobMap, Resolver};
32 use rustc_metadata::creader::CrateLoader;
33 use rustc_metadata::cstore::{self, CStore};
34 #[cfg(feature="llvm")]
35 use rustc_trans::back::{link, write};
36 #[cfg(feature="llvm")]
37 use rustc_trans as trans;
38 use rustc_typeck as typeck;
40 use rustc_plugin::registry::Registry;
41 use rustc_plugin as plugin;
42 use rustc_passes::{ast_validation, no_asm, loops, consts, static_recursion, hir_stats};
43 use rustc_const_eval::{self, check_match};
44 use super::Compilation;
49 use std::ffi::{OsString, OsStr};
51 use std::io::{self, Write};
53 use std::path::{Path, PathBuf};
55 use syntax::{ast, diagnostics, visit};
57 use syntax::ext::base::ExtCtxt;
58 use syntax::parse::{self, PResult};
59 use syntax::symbol::Symbol;
60 use syntax::util::node_count::NodeCounter;
63 use arena::DroplessArena;
67 pub fn compile_input(sess: &Session,
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);
82 if control.$point.stop == Compilation::Stop {
83 // FIXME: shouldn't this return Err(CompileIncomplete::Stopped)
84 // if there are no errors?
85 return $tsess.compile_status();
90 // We need nested scopes here, because the intermediate results can keep
91 // large chunks of memory alive and we want to free them as soon as
92 // possible to keep the peak memory usage low
93 let (outputs, trans) = {
94 let krate = match phase_1_parse_input(control, sess, input) {
96 Err(mut parse_error) => {
98 return Err(CompileIncomplete::Errored(ErrorReported));
102 let (krate, registry) = {
103 let mut compile_state = CompileState::state_after_parse(input,
109 controller_entry_point!(after_parse,
114 (compile_state.krate.unwrap(), compile_state.registry)
117 let outputs = build_output_filenames(input, outdir, output, &krate.attrs, sess);
119 ::rustc_trans_utils::link::find_crate_name(Some(sess), &krate.attrs, input);
120 let ExpansionResult { expanded_crate, defs, analysis, resolutions, mut hir_forest } = {
121 phase_2_configure_and_expand(
122 sess, &cstore, krate, registry, &crate_name, addl_plugins, control.make_glob_map,
124 let mut state = CompileState::state_after_expand(
125 input, sess, outdir, output, &cstore, expanded_crate, &crate_name,
127 controller_entry_point!(after_expand, sess, state, Ok(()));
133 write_out_deps(sess, &outputs, &crate_name);
134 if sess.opts.output_types.contains_key(&OutputType::DepInfo) &&
135 sess.opts.output_types.keys().count() == 1 {
139 let arena = DroplessArena::new();
140 let arenas = GlobalArenas::new();
142 // Construct the HIR map
143 let hir_map = time(sess.time_passes(),
145 || hir_map::map_crate(&mut hir_forest, defs));
148 let _ignore = hir_map.dep_graph.in_ignore();
149 controller_entry_point!(after_hir_lowering,
151 CompileState::state_after_hir_lowering(input,
167 time(sess.time_passes(), "attribute checking", || {
168 hir::check_attr::check_crate(sess, &expanded_crate);
171 let opt_crate = if control.keep_ast {
172 Some(&expanded_crate)
174 drop(expanded_crate);
178 phase_3_run_analysis_passes(sess,
185 |tcx, analysis, incremental_hashes_map, result| {
187 // Eventually, we will want to track plugins.
188 let _ignore = tcx.dep_graph.in_ignore();
190 let mut state = CompileState::state_after_analysis(input,
199 (control.after_analysis.callback)(&mut state);
201 if control.after_analysis.stop == Compilation::Stop {
202 return result.and_then(|_| Err(CompileIncomplete::Stopped));
208 if log_enabled!(::log::LogLevel::Info) {
209 println!("Pre-trans");
210 tcx.print_debug_stats();
213 #[cfg(feature="llvm")]
214 let trans = phase_4_translate_to_llvm(tcx, analysis, incremental_hashes_map,
216 #[cfg(not(feature="llvm"))]
217 let trans = { panic!("LLVM not supported by this rustc."); () };
219 if log_enabled!(::log::LogLevel::Info) {
220 println!("Post-trans");
221 tcx.print_debug_stats();
224 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
225 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, &outputs) {
226 sess.err(&format!("could not emit MIR: {}", e));
227 sess.abort_if_errors();
235 #[cfg(not(feature="llvm"))]
238 #[cfg(feature="llvm")]
240 if sess.opts.debugging_opts.print_type_sizes {
241 sess.code_stats.borrow().print_type_sizes();
244 let (phase5_result, trans) = phase_5_run_llvm_passes(sess, trans);
246 controller_entry_point!(after_llvm,
248 CompileState::state_after_llvm(input, sess, outdir, output, &trans),
252 phase_6_link_output(sess, &trans, &outputs);
254 // Now that we won't touch anything in the incremental compilation directory
255 // any more, we can finalize it (which involves renaming it)
256 rustc_incremental::finalize_session_directory(sess, trans.link.crate_hash);
258 if sess.opts.debugging_opts.perf_stats {
259 sess.print_perf_stats();
262 controller_entry_point!(
265 CompileState::state_when_compilation_done(input, sess, outdir, output),
273 fn keep_hygiene_data(sess: &Session) -> bool {
274 sess.opts.debugging_opts.keep_hygiene_data
278 /// The name used for source code that doesn't originate in a file
279 /// (e.g. source from stdin or a string)
280 pub fn anon_src() -> String {
284 pub fn source_name(input: &Input) -> String {
286 // FIXME (#9639): This needs to handle non-utf8 paths
287 Input::File(ref ifile) => ifile.to_str().unwrap().to_string(),
288 Input::Str { ref name, .. } => name.clone(),
292 /// CompileController is used to customise compilation, it allows compilation to
293 /// be stopped and/or to call arbitrary code at various points in compilation.
294 /// It also allows for various flags to be set to influence what information gets
295 /// collected during compilation.
297 /// This is a somewhat higher level controller than a Session - the Session
298 /// controls what happens in each phase, whereas the CompileController controls
299 /// whether a phase is run at all and whether other code (from outside the
300 /// the compiler) is run between phases.
302 /// Note that if compilation is set to stop and a callback is provided for a
303 /// given entry point, the callback is called before compilation is stopped.
305 /// Expect more entry points to be added in the future.
306 pub struct CompileController<'a> {
307 pub after_parse: PhaseController<'a>,
308 pub after_expand: PhaseController<'a>,
309 pub after_hir_lowering: PhaseController<'a>,
310 pub after_analysis: PhaseController<'a>,
311 pub after_llvm: PhaseController<'a>,
312 pub compilation_done: PhaseController<'a>,
314 // FIXME we probably want to group the below options together and offer a
315 // better API, rather than this ad-hoc approach.
316 pub make_glob_map: MakeGlobMap,
317 // Whether the compiler should keep the ast beyond parsing.
319 // -Zcontinue-parse-after-error
320 pub continue_parse_after_error: bool,
323 impl<'a> CompileController<'a> {
324 pub fn basic() -> CompileController<'a> {
326 after_parse: PhaseController::basic(),
327 after_expand: PhaseController::basic(),
328 after_hir_lowering: PhaseController::basic(),
329 after_analysis: PhaseController::basic(),
330 after_llvm: PhaseController::basic(),
331 compilation_done: PhaseController::basic(),
332 make_glob_map: MakeGlobMap::No,
334 continue_parse_after_error: false,
339 pub struct PhaseController<'a> {
340 pub stop: Compilation,
341 // If true then the compiler will try to run the callback even if the phase
342 // ends with an error. Note that this is not always possible.
343 pub run_callback_on_error: bool,
344 pub callback: Box<Fn(&mut CompileState) + 'a>,
347 impl<'a> PhaseController<'a> {
348 pub fn basic() -> PhaseController<'a> {
350 stop: Compilation::Continue,
351 run_callback_on_error: false,
352 callback: box |_| {},
357 /// State that is passed to a callback. What state is available depends on when
358 /// during compilation the callback is made. See the various constructor methods
359 /// (`state_*`) in the impl to see which data is provided for any given entry point.
360 pub struct CompileState<'a, 'tcx: 'a> {
361 pub input: &'a Input,
362 pub session: &'tcx Session,
363 pub krate: Option<ast::Crate>,
364 pub registry: Option<Registry<'a>>,
365 pub cstore: Option<&'a CStore>,
366 pub crate_name: Option<&'a str>,
367 pub output_filenames: Option<&'a OutputFilenames>,
368 pub out_dir: Option<&'a Path>,
369 pub out_file: Option<&'a Path>,
370 pub arena: Option<&'tcx DroplessArena>,
371 pub arenas: Option<&'tcx GlobalArenas<'tcx>>,
372 pub expanded_crate: Option<&'a ast::Crate>,
373 pub hir_crate: Option<&'a hir::Crate>,
374 pub hir_map: Option<&'a hir_map::Map<'tcx>>,
375 pub resolutions: Option<&'a Resolutions>,
376 pub analysis: Option<&'a ty::CrateAnalysis>,
377 pub tcx: Option<TyCtxt<'a, 'tcx, 'tcx>>,
378 #[cfg(feature="llvm")]
379 pub trans: Option<&'a trans::CrateTranslation>,
382 impl<'a, 'tcx> CompileState<'a, 'tcx> {
383 fn empty(input: &'a Input,
384 session: &'tcx Session,
385 out_dir: &'a Option<PathBuf>)
390 out_dir: out_dir.as_ref().map(|s| &**s),
398 output_filenames: None,
399 expanded_crate: None,
405 #[cfg(feature="llvm")]
410 fn state_after_parse(input: &'a Input,
411 session: &'tcx Session,
412 out_dir: &'a Option<PathBuf>,
413 out_file: &'a Option<PathBuf>,
418 // Initialize the registry before moving `krate`
419 registry: Some(Registry::new(&session, krate.span)),
421 cstore: Some(cstore),
422 out_file: out_file.as_ref().map(|s| &**s),
423 ..CompileState::empty(input, session, out_dir)
427 fn state_after_expand(input: &'a Input,
428 session: &'tcx Session,
429 out_dir: &'a Option<PathBuf>,
430 out_file: &'a Option<PathBuf>,
432 expanded_crate: &'a ast::Crate,
436 crate_name: Some(crate_name),
437 cstore: Some(cstore),
438 expanded_crate: Some(expanded_crate),
439 out_file: out_file.as_ref().map(|s| &**s),
440 ..CompileState::empty(input, session, out_dir)
444 fn state_after_hir_lowering(input: &'a Input,
445 session: &'tcx Session,
446 out_dir: &'a Option<PathBuf>,
447 out_file: &'a Option<PathBuf>,
448 arena: &'tcx DroplessArena,
449 arenas: &'tcx GlobalArenas<'tcx>,
451 hir_map: &'a hir_map::Map<'tcx>,
452 analysis: &'a ty::CrateAnalysis,
453 resolutions: &'a Resolutions,
454 krate: &'a ast::Crate,
455 hir_crate: &'a hir::Crate,
459 crate_name: Some(crate_name),
461 arenas: Some(arenas),
462 cstore: Some(cstore),
463 hir_map: Some(hir_map),
464 analysis: Some(analysis),
465 resolutions: Some(resolutions),
466 expanded_crate: Some(krate),
467 hir_crate: Some(hir_crate),
468 out_file: out_file.as_ref().map(|s| &**s),
469 ..CompileState::empty(input, session, out_dir)
473 fn state_after_analysis(input: &'a Input,
474 session: &'tcx Session,
475 out_dir: &'a Option<PathBuf>,
476 out_file: &'a Option<PathBuf>,
477 krate: Option<&'a ast::Crate>,
478 hir_crate: &'a hir::Crate,
479 analysis: &'a ty::CrateAnalysis,
480 tcx: TyCtxt<'a, 'tcx, 'tcx>,
484 analysis: Some(analysis),
486 expanded_crate: krate,
487 hir_crate: Some(hir_crate),
488 crate_name: Some(crate_name),
489 out_file: out_file.as_ref().map(|s| &**s),
490 ..CompileState::empty(input, session, out_dir)
494 #[cfg(feature="llvm")]
495 fn state_after_llvm(input: &'a Input,
496 session: &'tcx Session,
497 out_dir: &'a Option<PathBuf>,
498 out_file: &'a Option<PathBuf>,
499 trans: &'a trans::CrateTranslation)
503 out_file: out_file.as_ref().map(|s| &**s),
504 ..CompileState::empty(input, session, out_dir)
508 fn state_when_compilation_done(input: &'a Input,
509 session: &'tcx Session,
510 out_dir: &'a Option<PathBuf>,
511 out_file: &'a Option<PathBuf>)
514 out_file: out_file.as_ref().map(|s| &**s),
515 ..CompileState::empty(input, session, out_dir)
520 pub fn phase_1_parse_input<'a>(control: &CompileController,
523 -> PResult<'a, ast::Crate> {
524 sess.diagnostic().set_continue_after_error(control.continue_parse_after_error);
526 let krate = time(sess.time_passes(), "parsing", || {
528 Input::File(ref file) => {
529 parse::parse_crate_from_file(file, &sess.parse_sess)
531 Input::Str { ref input, ref name } => {
532 parse::parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess)
537 sess.diagnostic().set_continue_after_error(true);
539 if sess.opts.debugging_opts.ast_json_noexpand {
540 println!("{}", json::as_json(&krate));
543 if sess.opts.debugging_opts.input_stats {
544 println!("Lines of code: {}", sess.codemap().count_lines());
545 println!("Pre-expansion node count: {}", count_nodes(&krate));
548 if let Some(ref s) = sess.opts.debugging_opts.show_span {
549 syntax::show_span::run(sess.diagnostic(), s, &krate);
552 if sess.opts.debugging_opts.hir_stats {
553 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
559 fn count_nodes(krate: &ast::Crate) -> usize {
560 let mut counter = NodeCounter::new();
561 visit::walk_crate(&mut counter, krate);
565 // For continuing compilation after a parsed crate has been
568 pub struct ExpansionResult {
569 pub expanded_crate: ast::Crate,
570 pub defs: hir_map::Definitions,
571 pub analysis: ty::CrateAnalysis,
572 pub resolutions: Resolutions,
573 pub hir_forest: hir_map::Forest,
576 /// Run the "early phases" of the compiler: initial `cfg` processing,
577 /// loading compiler plugins (including those from `addl_plugins`),
578 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
579 /// harness if one is to be provided, injection of a dependency on the
580 /// standard library and prelude, and name resolution.
582 /// Returns `None` if we're aborting after handling -W help.
583 pub fn phase_2_configure_and_expand<F>(sess: &Session,
586 registry: Option<Registry>,
588 addl_plugins: Option<Vec<String>>,
589 make_glob_map: MakeGlobMap,
591 -> Result<ExpansionResult, CompileIncomplete>
592 where F: FnOnce(&ast::Crate) -> CompileResult,
594 let time_passes = sess.time_passes();
596 let (mut krate, features) = syntax::config::features(krate, &sess.parse_sess, sess.opts.test);
597 // these need to be set "early" so that expansion sees `quote` if enabled.
598 *sess.features.borrow_mut() = features;
600 *sess.crate_types.borrow_mut() = collect_crate_types(sess, &krate.attrs);
601 *sess.crate_disambiguator.borrow_mut() = Symbol::intern(&compute_crate_disambiguator(sess));
603 time(time_passes, "recursion limit", || {
604 middle::recursion_limit::update_limits(sess, &krate);
607 krate = time(time_passes, "crate injection", || {
608 let alt_std_name = sess.opts.alt_std_name.clone();
609 syntax::std_inject::maybe_inject_crates_ref(krate, alt_std_name)
612 let mut addl_plugins = Some(addl_plugins);
613 let registrars = time(time_passes, "plugin loading", || {
614 plugin::load::load_plugins(sess,
618 addl_plugins.take().unwrap())
621 let mut registry = registry.unwrap_or(Registry::new(sess, krate.span));
623 time(time_passes, "plugin registration", || {
624 if sess.features.borrow().rustc_diagnostic_macros {
625 registry.register_macro("__diagnostic_used",
626 diagnostics::plugin::expand_diagnostic_used);
627 registry.register_macro("__register_diagnostic",
628 diagnostics::plugin::expand_register_diagnostic);
629 registry.register_macro("__build_diagnostic_array",
630 diagnostics::plugin::expand_build_diagnostic_array);
633 for registrar in registrars {
634 registry.args_hidden = Some(registrar.args);
635 (registrar.fun)(&mut registry);
639 let whitelisted_legacy_custom_derives = registry.take_whitelisted_custom_derives();
640 let Registry { syntax_exts, early_lint_passes, late_lint_passes, lint_groups,
641 llvm_passes, attributes, .. } = registry;
643 sess.track_errors(|| {
644 let mut ls = sess.lint_store.borrow_mut();
645 for pass in early_lint_passes {
646 ls.register_early_pass(Some(sess), true, pass);
648 for pass in late_lint_passes {
649 ls.register_late_pass(Some(sess), true, pass);
652 for (name, to) in lint_groups {
653 ls.register_group(Some(sess), true, name, to);
656 *sess.plugin_llvm_passes.borrow_mut() = llvm_passes;
657 *sess.plugin_attributes.borrow_mut() = attributes.clone();
660 // Lint plugins are registered; now we can process command line flags.
661 if sess.opts.describe_lints {
662 super::describe_lints(&sess.lint_store.borrow(), true);
663 return Err(CompileIncomplete::Stopped);
666 // Currently, we ignore the name resolution data structures for the purposes of dependency
667 // tracking. Instead we will run name resolution and include its output in the hash of each
668 // item, much like we do for macro expansion. In other words, the hash reflects not just
669 // its contents but the results of name resolution on those contents. Hopefully we'll push
670 // this back at some point.
671 let _ignore = sess.dep_graph.in_ignore();
672 let mut crate_loader = CrateLoader::new(sess, &cstore, crate_name);
673 crate_loader.preprocess(&krate);
674 let resolver_arenas = Resolver::arenas();
675 let mut resolver = Resolver::new(sess,
681 resolver.whitelisted_legacy_custom_derives = whitelisted_legacy_custom_derives;
682 syntax_ext::register_builtins(&mut resolver, syntax_exts, sess.features.borrow().quote);
684 krate = time(time_passes, "expansion", || {
685 // Windows dlls do not have rpaths, so they don't know how to find their
686 // dependencies. It's up to us to tell the system where to find all the
687 // dependent dlls. Note that this uses cfg!(windows) as opposed to
688 // targ_cfg because syntax extensions are always loaded for the host
689 // compiler, not for the target.
691 // This is somewhat of an inherently racy operation, however, as
692 // multiple threads calling this function could possibly continue
693 // extending PATH far beyond what it should. To solve this for now we
694 // just don't add any new elements to PATH which are already there
695 // within PATH. This is basically a targeted fix at #17360 for rustdoc
696 // which runs rustc in parallel but has been seen (#33844) to cause
697 // problems with PATH becoming too long.
698 let mut old_path = OsString::new();
700 old_path = env::var_os("PATH").unwrap_or(old_path);
701 let mut new_path = sess.host_filesearch(PathKind::All)
702 .get_dylib_search_paths();
703 for path in env::split_paths(&old_path) {
704 if !new_path.contains(&path) {
709 &env::join_paths(new_path.iter()
710 .filter(|p| env::join_paths(iter::once(p)).is_ok()))
713 let features = sess.features.borrow();
714 let cfg = syntax::ext::expand::ExpansionConfig {
715 features: Some(&features),
716 recursion_limit: sess.recursion_limit.get(),
717 trace_mac: sess.opts.debugging_opts.trace_macros,
718 should_test: sess.opts.test,
719 ..syntax::ext::expand::ExpansionConfig::default(crate_name.to_string())
722 let mut ecx = ExtCtxt::new(&sess.parse_sess, cfg, &mut resolver);
723 let err_count = ecx.parse_sess.span_diagnostic.err_count();
725 let krate = ecx.monotonic_expander().expand_crate(krate);
727 ecx.check_unused_macros();
729 let mut missing_fragment_specifiers: Vec<_> =
730 ecx.parse_sess.missing_fragment_specifiers.borrow().iter().cloned().collect();
731 missing_fragment_specifiers.sort();
732 for span in missing_fragment_specifiers {
733 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
734 let msg = "missing fragment specifier";
735 sess.buffer_lint(lint, ast::CRATE_NODE_ID, span, msg);
737 if ecx.parse_sess.span_diagnostic.err_count() - ecx.resolve_err_count > err_count {
738 ecx.parse_sess.span_diagnostic.abort_if_errors();
741 env::set_var("PATH", &old_path);
746 krate = time(time_passes, "maybe building test harness", || {
747 syntax::test::modify_for_testing(&sess.parse_sess,
754 // If we're in rustdoc we're always compiling as an rlib, but that'll trip a
755 // bunch of checks in the `modify` function below. For now just skip this
756 // step entirely if we're rustdoc as it's not too useful anyway.
757 if !sess.opts.actually_rustdoc {
758 krate = time(time_passes, "maybe creating a macro crate", || {
759 let crate_types = sess.crate_types.borrow();
760 let num_crate_types = crate_types.len();
761 let is_proc_macro_crate = crate_types.contains(&config::CrateTypeProcMacro);
762 let is_test_crate = sess.opts.test;
763 syntax_ext::proc_macro_registrar::modify(&sess.parse_sess,
773 krate = time(time_passes, "creating allocators", || {
774 allocator::expand::modify(&sess.parse_sess,
780 after_expand(&krate)?;
782 if sess.opts.debugging_opts.input_stats {
783 println!("Post-expansion node count: {}", count_nodes(&krate));
786 if sess.opts.debugging_opts.hir_stats {
787 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
790 if sess.opts.debugging_opts.ast_json {
791 println!("{}", json::as_json(&krate));
795 "checking for inline asm in case the target doesn't support it",
796 || no_asm::check_crate(sess, &krate));
800 || ast_validation::check_crate(sess, &krate));
802 time(time_passes, "name resolution", || -> CompileResult {
803 resolver.resolve_crate(&krate);
807 if resolver.found_unresolved_macro {
808 sess.parse_sess.span_diagnostic.abort_if_errors();
811 // Needs to go *after* expansion to be able to check the results of macro expansion.
812 time(time_passes, "complete gated feature checking", || {
813 sess.track_errors(|| {
814 syntax::feature_gate::check_crate(&krate,
816 &sess.features.borrow(),
818 sess.opts.unstable_features);
824 || lint::check_ast_crate(sess, &krate));
827 let hir_forest = time(time_passes, "lowering ast -> hir", || {
828 let hir_crate = lower_crate(sess, &krate, &mut resolver);
830 if sess.opts.debugging_opts.hir_stats {
831 hir_stats::print_hir_stats(&hir_crate);
834 hir_map::Forest::new(hir_crate, &sess.dep_graph)
837 // Discard hygiene data, which isn't required after lowering to HIR.
838 if !keep_hygiene_data(sess) {
839 syntax::ext::hygiene::clear_markings();
843 expanded_crate: krate,
844 defs: resolver.definitions,
845 analysis: ty::CrateAnalysis {
846 access_levels: Rc::new(AccessLevels::default()),
847 reachable: Rc::new(NodeSet()),
848 name: crate_name.to_string(),
849 glob_map: if resolver.make_glob_map { Some(resolver.glob_map) } else { None },
851 resolutions: Resolutions {
852 freevars: resolver.freevars,
853 export_map: resolver.export_map,
854 trait_map: resolver.trait_map,
855 maybe_unused_trait_imports: resolver.maybe_unused_trait_imports,
857 hir_forest: hir_forest,
861 /// Run the resolution, typechecking, region checking and other
862 /// miscellaneous analysis passes on the crate. Return various
863 /// structures carrying the results of the analysis.
864 pub fn phase_3_run_analysis_passes<'tcx, F, R>(sess: &'tcx Session,
865 hir_map: hir_map::Map<'tcx>,
866 mut analysis: ty::CrateAnalysis,
867 resolutions: Resolutions,
868 arena: &'tcx DroplessArena,
869 arenas: &'tcx GlobalArenas<'tcx>,
872 -> Result<R, CompileIncomplete>
873 where F: for<'a> FnOnce(TyCtxt<'a, 'tcx, 'tcx>,
875 IncrementalHashesMap,
878 macro_rules! try_with_f {
879 ($e: expr, ($t: expr, $a: expr, $h: expr)) => {
883 f($t, $a, $h, Err(x));
890 let time_passes = sess.time_passes();
892 let lang_items = time(time_passes, "language item collection", || {
893 sess.track_errors(|| {
894 middle::lang_items::collect_language_items(&sess, &hir_map)
898 let named_region_map = time(time_passes,
899 "lifetime resolution",
900 || middle::resolve_lifetime::krate(sess, &hir_map))?;
903 "looking for entry point",
904 || middle::entry::find_entry_point(sess, &hir_map));
906 sess.plugin_registrar_fn.set(time(time_passes, "looking for plugin registrar", || {
907 plugin::build::find_plugin_registrar(sess.diagnostic(), &hir_map)
909 sess.derive_registrar_fn.set(derive_registrar::find(&hir_map));
913 || loops::check_crate(sess, &hir_map));
916 "static item recursion checking",
917 || static_recursion::check_crate(sess, &hir_map))?;
919 let index = stability::Index::new(&sess);
921 let mut local_providers = ty::maps::Providers::default();
922 borrowck::provide(&mut local_providers);
923 mir::provide(&mut local_providers);
924 reachable::provide(&mut local_providers);
925 rustc_privacy::provide(&mut local_providers);
926 #[cfg(feature="llvm")]
927 trans::provide(&mut local_providers);
928 typeck::provide(&mut local_providers);
929 ty::provide(&mut local_providers);
930 traits::provide(&mut local_providers);
931 reachable::provide(&mut local_providers);
932 rustc_const_eval::provide(&mut local_providers);
933 middle::region::provide(&mut local_providers);
934 cstore::provide_local(&mut local_providers);
935 lint::provide(&mut local_providers);
937 let mut extern_providers = ty::maps::Providers::default();
938 cstore::provide(&mut extern_providers);
939 #[cfg(feature="llvm")]
940 trans::provide(&mut extern_providers);
941 ty::provide_extern(&mut extern_providers);
942 traits::provide_extern(&mut extern_providers);
943 // FIXME(eddyb) get rid of this once we replace const_eval with miri.
944 rustc_const_eval::provide(&mut extern_providers);
946 // Setup the MIR passes that we want to run.
947 let mut passes = Passes::new();
948 passes.push_hook(mir::transform::dump_mir::DumpMir);
950 // Remove all `EndRegion` statements that are not involved in borrows.
951 passes.push_pass(MIR_CONST, mir::transform::clean_end_regions::CleanEndRegions);
953 // What we need to do constant evaluation.
954 passes.push_pass(MIR_CONST, mir::transform::simplify::SimplifyCfg::new("initial"));
955 passes.push_pass(MIR_CONST, mir::transform::type_check::TypeckMir);
956 passes.push_pass(MIR_CONST, mir::transform::rustc_peek::SanityCheck);
958 // We compute "constant qualifications" betwen MIR_CONST and MIR_VALIDATED.
960 // What we need to run borrowck etc.
961 passes.push_pass(MIR_VALIDATED, mir::transform::qualify_consts::QualifyAndPromoteConstants);
962 passes.push_pass(MIR_VALIDATED,
963 mir::transform::simplify_branches::SimplifyBranches::new("initial"));
964 passes.push_pass(MIR_VALIDATED, mir::transform::simplify::SimplifyCfg::new("qualify-consts"));
965 passes.push_pass(MIR_VALIDATED, mir::transform::nll::NLL);
967 // borrowck runs between MIR_VALIDATED and MIR_OPTIMIZED.
969 // These next passes must be executed together
970 passes.push_pass(MIR_OPTIMIZED, mir::transform::no_landing_pads::NoLandingPads);
971 passes.push_pass(MIR_OPTIMIZED, mir::transform::add_call_guards::AddCallGuards);
972 passes.push_pass(MIR_OPTIMIZED, mir::transform::elaborate_drops::ElaborateDrops);
973 passes.push_pass(MIR_OPTIMIZED, mir::transform::no_landing_pads::NoLandingPads);
974 passes.push_pass(MIR_OPTIMIZED, mir::transform::simplify::SimplifyCfg::new("elaborate-drops"));
975 // No lifetime analysis based on borrowing can be done from here on out.
977 // AddValidation needs to run after ElaborateDrops and before EraseRegions.
978 passes.push_pass(MIR_OPTIMIZED, mir::transform::add_validation::AddValidation);
980 // From here on out, regions are gone.
981 passes.push_pass(MIR_OPTIMIZED, mir::transform::erase_regions::EraseRegions);
983 // Optimizations begin.
984 passes.push_pass(MIR_OPTIMIZED, mir::transform::inline::Inline);
985 passes.push_pass(MIR_OPTIMIZED, mir::transform::instcombine::InstCombine);
986 passes.push_pass(MIR_OPTIMIZED, mir::transform::deaggregator::Deaggregator);
987 passes.push_pass(MIR_OPTIMIZED, mir::transform::copy_prop::CopyPropagation);
988 passes.push_pass(MIR_OPTIMIZED, mir::transform::simplify::SimplifyLocals);
989 passes.push_pass(MIR_OPTIMIZED, mir::transform::add_call_guards::AddCallGuards);
990 passes.push_pass(MIR_OPTIMIZED, mir::transform::dump_mir::Marker("PreTrans"));
992 TyCtxt::create_and_enter(sess,
1005 let incremental_hashes_map =
1007 "compute_incremental_hashes_map",
1008 || rustc_incremental::compute_incremental_hashes_map(tcx));
1012 || rustc_incremental::load_dep_graph(tcx, &incremental_hashes_map));
1014 time(time_passes, "stability index", || {
1015 tcx.stability.borrow_mut().build(tcx)
1019 "stability checking",
1020 || stability::check_unstable_api_usage(tcx));
1022 // passes are timed inside typeck
1023 try_with_f!(typeck::check_crate(tcx), (tcx, analysis, incremental_hashes_map));
1027 || consts::check_crate(tcx));
1029 analysis.access_levels =
1030 time(time_passes, "privacy checking", || rustc_privacy::check_crate(tcx));
1033 "intrinsic checking",
1034 || middle::intrinsicck::check_crate(tcx));
1038 || middle::effect::check_crate(tcx));
1042 || check_match::check_crate(tcx));
1044 // this must run before MIR dump, because
1045 // "not all control paths return a value" is reported here.
1047 // maybe move the check to a MIR pass?
1049 "liveness checking",
1050 || middle::liveness::check_crate(tcx));
1054 || borrowck::check_crate(tcx));
1056 // Avoid overwhelming user with errors if type checking failed.
1057 // I'm not sure how helpful this is, to be honest, but it avoids
1059 // lot of annoying errors in the compile-fail tests (basically,
1060 // lint warnings and so on -- kindck used to do this abort, but
1061 // kindck is gone now). -nmatsakis
1062 if sess.err_count() > 0 {
1063 return Ok(f(tcx, analysis, incremental_hashes_map, sess.compile_status()));
1066 analysis.reachable =
1068 "reachability checking",
1069 || reachable::find_reachable(tcx));
1071 time(time_passes, "death checking", || middle::dead::check_crate(tcx));
1073 time(time_passes, "unused lib feature checking", || {
1074 stability::check_unused_or_stable_features(tcx)
1077 time(time_passes, "lint checking", || lint::check_crate(tcx));
1079 return Ok(f(tcx, analysis, incremental_hashes_map, tcx.sess.compile_status()));
1083 /// Run the translation phase to LLVM, after which the AST and analysis can
1085 #[cfg(feature="llvm")]
1086 pub fn phase_4_translate_to_llvm<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1087 analysis: ty::CrateAnalysis,
1088 incremental_hashes_map: IncrementalHashesMap,
1089 output_filenames: &OutputFilenames)
1090 -> write::OngoingCrateTranslation {
1091 let time_passes = tcx.sess.time_passes();
1094 "resolving dependency formats",
1095 || dependency_format::calculate(tcx));
1100 move || trans::trans_crate(tcx, analysis, incremental_hashes_map, output_filenames));
1105 /// Run LLVM itself, producing a bitcode file, assembly file or object file
1106 /// as a side effect.
1107 #[cfg(feature="llvm")]
1108 pub fn phase_5_run_llvm_passes(sess: &Session,
1109 trans: write::OngoingCrateTranslation)
1110 -> (CompileResult, trans::CrateTranslation) {
1111 let trans = trans.join(sess);
1113 if sess.opts.debugging_opts.incremental_info {
1114 write::dump_incremental_data(&trans);
1117 time(sess.time_passes(),
1118 "serialize work products",
1119 move || rustc_incremental::save_work_products(sess));
1121 (sess.compile_status(), trans)
1124 /// Run the linker on any artifacts that resulted from the LLVM run.
1125 /// This should produce either a finished executable or library.
1126 #[cfg(feature="llvm")]
1127 pub fn phase_6_link_output(sess: &Session,
1128 trans: &trans::CrateTranslation,
1129 outputs: &OutputFilenames) {
1130 time(sess.time_passes(),
1132 || link::link_binary(sess, trans, outputs, &trans.crate_name.as_str()));
1135 fn escape_dep_filename(filename: &str) -> String {
1136 // Apparently clang and gcc *only* escape spaces:
1137 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
1138 filename.replace(" ", "\\ ")
1141 fn write_out_deps(sess: &Session, outputs: &OutputFilenames, crate_name: &str) {
1142 let mut out_filenames = Vec::new();
1143 for output_type in sess.opts.output_types.keys() {
1144 let file = outputs.path(*output_type);
1145 match *output_type {
1146 OutputType::Exe => {
1147 for output in sess.crate_types.borrow().iter() {
1148 let p = ::rustc_trans_utils::link::filename_for_input(sess, *output, crate_name, outputs);
1149 out_filenames.push(p);
1153 out_filenames.push(file);
1158 // Write out dependency rules to the dep-info file if requested
1159 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
1162 let deps_filename = outputs.path(OutputType::DepInfo);
1165 (|| -> io::Result<()> {
1166 // Build a list of files used to compile the output and
1167 // write Makefile-compatible dependency rules
1168 let files: Vec<String> = sess.codemap()
1171 .filter(|fmap| fmap.is_real_file())
1172 .filter(|fmap| !fmap.is_imported())
1173 .map(|fmap| escape_dep_filename(&fmap.name))
1175 let mut file = fs::File::create(&deps_filename)?;
1176 for path in &out_filenames {
1177 write!(file, "{}: {}\n\n", path.display(), files.join(" "))?;
1180 // Emit a fake target for each input file to the compilation. This
1181 // prevents `make` from spitting out an error if a file is later
1182 // deleted. For more info see #28735
1184 writeln!(file, "{}:", path)?;
1192 sess.fatal(&format!("error writing dependencies to `{}`: {}",
1193 deps_filename.display(),
1199 pub fn collect_crate_types(session: &Session, attrs: &[ast::Attribute]) -> Vec<config::CrateType> {
1200 // Unconditionally collect crate types from attributes to make them used
1201 let attr_types: Vec<config::CrateType> =
1204 if a.check_name("crate_type") {
1205 match a.value_str() {
1206 Some(ref n) if *n == "rlib" => {
1207 Some(config::CrateTypeRlib)
1209 Some(ref n) if *n == "dylib" => {
1210 Some(config::CrateTypeDylib)
1212 Some(ref n) if *n == "cdylib" => {
1213 Some(config::CrateTypeCdylib)
1215 Some(ref n) if *n == "lib" => {
1216 Some(config::default_lib_output())
1218 Some(ref n) if *n == "staticlib" => {
1219 Some(config::CrateTypeStaticlib)
1221 Some(ref n) if *n == "proc-macro" => {
1222 Some(config::CrateTypeProcMacro)
1224 Some(ref n) if *n == "bin" => Some(config::CrateTypeExecutable),
1226 session.buffer_lint(lint::builtin::UNKNOWN_CRATE_TYPES,
1229 "invalid `crate_type` value");
1233 session.struct_span_err(a.span, "`crate_type` requires a value")
1234 .note("for example: `#![crate_type=\"lib\"]`")
1245 // If we're generating a test executable, then ignore all other output
1246 // styles at all other locations
1247 if session.opts.test {
1248 return vec![config::CrateTypeExecutable];
1251 // Only check command line flags if present. If no types are specified by
1252 // command line, then reuse the empty `base` Vec to hold the types that
1253 // will be found in crate attributes.
1254 let mut base = session.opts.crate_types.clone();
1255 if base.is_empty() {
1256 base.extend(attr_types);
1257 if base.is_empty() {
1258 base.push(::rustc_trans_utils::link::default_output_for_target(session));
1265 .filter(|crate_type| {
1266 let res = !rustc_trans_utils::link::invalid_output_for_target(session, *crate_type);
1269 session.warn(&format!("dropping unsupported crate type `{}` for target `{}`",
1271 session.opts.target_triple));
1279 pub fn compute_crate_disambiguator(session: &Session) -> String {
1280 use std::hash::Hasher;
1282 // The crate_disambiguator is a 128 bit hash. The disambiguator is fed
1283 // into various other hashes quite a bit (symbol hashes, incr. comp. hashes,
1284 // debuginfo type IDs, etc), so we don't want it to be too wide. 128 bits
1285 // should still be safe enough to avoid collisions in practice.
1286 // FIXME(mw): It seems that the crate_disambiguator is used everywhere as
1287 // a hex-string instead of raw bytes. We should really use the
1288 // smaller representation.
1289 let mut hasher = StableHasher::<Fingerprint>::new();
1291 let mut metadata = session.opts.cg.metadata.clone();
1292 // We don't want the crate_disambiguator to dependent on the order
1293 // -C metadata arguments, so sort them:
1295 // Every distinct -C metadata value is only incorporated once:
1298 hasher.write(b"metadata");
1299 for s in &metadata {
1300 // Also incorporate the length of a metadata string, so that we generate
1301 // different values for `-Cmetadata=ab -Cmetadata=c` and
1302 // `-Cmetadata=a -Cmetadata=bc`
1303 hasher.write_usize(s.len());
1304 hasher.write(s.as_bytes());
1307 // If this is an executable, add a special suffix, so that we don't get
1308 // symbol conflicts when linking against a library of the same name.
1309 let is_exe = session.crate_types.borrow().contains(&config::CrateTypeExecutable);
1311 format!("{}{}", hasher.finish().to_hex(), if is_exe { "-exe" } else {""})
1314 pub fn build_output_filenames(input: &Input,
1315 odir: &Option<PathBuf>,
1316 ofile: &Option<PathBuf>,
1317 attrs: &[ast::Attribute],
1319 -> OutputFilenames {
1322 // "-" as input file will cause the parser to read from stdin so we
1323 // have to make up a name
1324 // We want to toss everything after the final '.'
1325 let dirpath = match *odir {
1326 Some(ref d) => d.clone(),
1327 None => PathBuf::new(),
1330 // If a crate name is present, we use it as the link name
1331 let stem = sess.opts
1334 .or_else(|| attr::find_crate_name(attrs).map(|n| n.to_string()))
1335 .unwrap_or(input.filestem());
1338 out_directory: dirpath,
1340 single_output_file: None,
1341 extra: sess.opts.cg.extra_filename.clone(),
1342 outputs: sess.opts.output_types.clone(),
1346 Some(ref out_file) => {
1347 let unnamed_output_types = sess.opts
1350 .filter(|a| a.is_none())
1352 let ofile = if unnamed_output_types > 1 {
1353 sess.warn("due to multiple output types requested, the explicitly specified \
1354 output file name will be adapted for each output type");
1357 Some(out_file.clone())
1360 sess.warn("ignoring --out-dir flag due to -o flag.");
1363 let cur_dir = Path::new("");
1366 out_directory: out_file.parent().unwrap_or(cur_dir).to_path_buf(),
1367 out_filestem: out_file.file_stem()
1368 .unwrap_or(OsStr::new(""))
1372 single_output_file: ofile,
1373 extra: sess.opts.cg.extra_filename.clone(),
1374 outputs: sess.opts.output_types.clone(),