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, compile_result_from_err_count};
17 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};
24 use rustc::ty::{self, TyCtxt, Resolutions, GlobalArenas};
25 use rustc::util::common::time;
26 use rustc::util::nodemap::NodeSet;
27 use rustc::util::fs::rename_or_copy_remove;
28 use rustc_borrowck as borrowck;
29 use rustc_incremental::{self, IncrementalHashesMap};
30 use rustc_resolve::{MakeGlobMap, Resolver};
31 use rustc_metadata::creader::CrateLoader;
32 use rustc_metadata::cstore::{self, CStore};
33 use rustc_trans::back::{link, write};
34 use rustc_trans as trans;
35 use rustc_typeck as typeck;
37 use rustc_plugin::registry::Registry;
38 use rustc_plugin as plugin;
39 use rustc_passes::{ast_validation, no_asm, loops, consts,
40 static_recursion, hir_stats, mir_stats};
41 use rustc_const_eval::{self, check_match};
42 use super::Compilation;
47 use std::ffi::{OsString, OsStr};
49 use std::io::{self, Write};
51 use std::path::{Path, PathBuf};
53 use syntax::{ast, diagnostics, visit};
55 use syntax::ext::base::ExtCtxt;
56 use syntax::parse::{self, PResult};
57 use syntax::symbol::Symbol;
58 use syntax::util::node_count::NodeCounter;
61 use arena::DroplessArena;
65 pub fn compile_input(sess: &Session,
68 outdir: &Option<PathBuf>,
69 output: &Option<PathBuf>,
70 addl_plugins: Option<Vec<String>>,
71 control: &CompileController) -> CompileResult {
72 macro_rules! controller_entry_point {
73 ($point: ident, $tsess: expr, $make_state: expr, $phase_result: expr) => {{
74 let state = &mut $make_state;
75 let phase_result: &CompileResult = &$phase_result;
76 if phase_result.is_ok() || control.$point.run_callback_on_error {
77 (control.$point.callback)(state);
80 if control.$point.stop == Compilation::Stop {
81 return compile_result_from_err_count($tsess.err_count());
86 // We need nested scopes here, because the intermediate results can keep
87 // large chunks of memory alive and we want to free them as soon as
88 // possible to keep the peak memory usage low
89 let (outputs, trans) = {
90 let krate = match phase_1_parse_input(sess, input) {
92 Err(mut parse_error) => {
98 let (krate, registry) = {
99 let mut compile_state = CompileState::state_after_parse(input,
105 controller_entry_point!(after_parse,
110 (compile_state.krate.unwrap(), compile_state.registry)
113 let outputs = build_output_filenames(input, outdir, output, &krate.attrs, sess);
114 let crate_name = link::find_crate_name(Some(sess), &krate.attrs, input);
115 let ExpansionResult { expanded_crate, defs, analysis, resolutions, mut hir_forest } = {
116 phase_2_configure_and_expand(
117 sess, &cstore, krate, registry, &crate_name, addl_plugins, control.make_glob_map,
119 let mut state = CompileState::state_after_expand(
120 input, sess, outdir, output, &cstore, expanded_crate, &crate_name,
122 controller_entry_point!(after_expand, sess, state, Ok(()));
128 write_out_deps(sess, &outputs, &crate_name);
129 if sess.opts.output_types.contains_key(&OutputType::DepInfo) &&
130 sess.opts.output_types.keys().count() == 1 {
134 let arena = DroplessArena::new();
135 let arenas = GlobalArenas::new();
137 // Construct the HIR map
138 let hir_map = time(sess.time_passes(),
140 || hir_map::map_crate(&mut hir_forest, defs));
143 let _ignore = hir_map.dep_graph.in_ignore();
144 controller_entry_point!(after_hir_lowering,
146 CompileState::state_after_hir_lowering(input,
162 time(sess.time_passes(), "attribute checking", || {
163 hir::check_attr::check_crate(sess, &expanded_crate);
166 let opt_crate = if keep_ast(sess) {
167 Some(&expanded_crate)
169 drop(expanded_crate);
173 phase_3_run_analysis_passes(sess,
180 |tcx, analysis, incremental_hashes_map, result| {
182 // Eventually, we will want to track plugins.
183 let _ignore = tcx.dep_graph.in_ignore();
185 let mut state = CompileState::state_after_analysis(input,
194 (control.after_analysis.callback)(&mut state);
196 if control.after_analysis.stop == Compilation::Stop {
197 return result.and_then(|_| Err(0usize));
203 if log_enabled!(::log::LogLevel::Info) {
204 println!("Pre-trans");
205 tcx.print_debug_stats();
207 let trans = phase_4_translate_to_llvm(tcx, analysis, &incremental_hashes_map);
209 if log_enabled!(::log::LogLevel::Info) {
210 println!("Post-trans");
211 tcx.print_debug_stats();
214 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
215 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, &outputs) {
216 sess.err(&format!("could not emit MIR: {}", e));
217 sess.abort_if_errors();
225 if sess.opts.debugging_opts.print_type_sizes {
226 sess.code_stats.borrow().print_type_sizes();
229 let phase5_result = phase_5_run_llvm_passes(sess, &trans, &outputs);
231 controller_entry_point!(after_llvm,
233 CompileState::state_after_llvm(input, sess, outdir, output, &trans),
237 write::cleanup_llvm(&trans);
239 phase_6_link_output(sess, &trans, &outputs);
241 // Now that we won't touch anything in the incremental compilation directory
242 // any more, we can finalize it (which involves renaming it)
243 rustc_incremental::finalize_session_directory(sess, trans.link.crate_hash);
245 if sess.opts.debugging_opts.perf_stats {
246 sess.print_perf_stats();
249 controller_entry_point!(compilation_done,
251 CompileState::state_when_compilation_done(input, sess, outdir, output),
257 fn keep_hygiene_data(sess: &Session) -> bool {
258 sess.opts.debugging_opts.keep_hygiene_data
261 fn keep_ast(sess: &Session) -> bool {
262 sess.opts.debugging_opts.keep_ast || ::save_analysis(sess)
265 /// The name used for source code that doesn't originate in a file
266 /// (e.g. source from stdin or a string)
267 pub fn anon_src() -> String {
271 pub fn source_name(input: &Input) -> String {
273 // FIXME (#9639): This needs to handle non-utf8 paths
274 Input::File(ref ifile) => ifile.to_str().unwrap().to_string(),
275 Input::Str { ref name, .. } => name.clone(),
279 /// CompileController is used to customise compilation, it allows compilation to
280 /// be stopped and/or to call arbitrary code at various points in compilation.
281 /// It also allows for various flags to be set to influence what information gets
282 /// collected during compilation.
284 /// This is a somewhat higher level controller than a Session - the Session
285 /// controls what happens in each phase, whereas the CompileController controls
286 /// whether a phase is run at all and whether other code (from outside the
287 /// the compiler) is run between phases.
289 /// Note that if compilation is set to stop and a callback is provided for a
290 /// given entry point, the callback is called before compilation is stopped.
292 /// Expect more entry points to be added in the future.
293 pub struct CompileController<'a> {
294 pub after_parse: PhaseController<'a>,
295 pub after_expand: PhaseController<'a>,
296 pub after_hir_lowering: PhaseController<'a>,
297 pub after_analysis: PhaseController<'a>,
298 pub after_llvm: PhaseController<'a>,
299 pub compilation_done: PhaseController<'a>,
301 pub make_glob_map: MakeGlobMap,
304 impl<'a> CompileController<'a> {
305 pub fn basic() -> CompileController<'a> {
307 after_parse: PhaseController::basic(),
308 after_expand: PhaseController::basic(),
309 after_hir_lowering: PhaseController::basic(),
310 after_analysis: PhaseController::basic(),
311 after_llvm: PhaseController::basic(),
312 compilation_done: PhaseController::basic(),
313 make_glob_map: MakeGlobMap::No,
318 pub struct PhaseController<'a> {
319 pub stop: Compilation,
320 // If true then the compiler will try to run the callback even if the phase
321 // ends with an error. Note that this is not always possible.
322 pub run_callback_on_error: bool,
323 pub callback: Box<Fn(&mut CompileState) + 'a>,
326 impl<'a> PhaseController<'a> {
327 pub fn basic() -> PhaseController<'a> {
329 stop: Compilation::Continue,
330 run_callback_on_error: false,
331 callback: box |_| {},
336 /// State that is passed to a callback. What state is available depends on when
337 /// during compilation the callback is made. See the various constructor methods
338 /// (`state_*`) in the impl to see which data is provided for any given entry point.
339 pub struct CompileState<'a, 'tcx: 'a> {
340 pub input: &'a Input,
341 pub session: &'tcx Session,
342 pub krate: Option<ast::Crate>,
343 pub registry: Option<Registry<'a>>,
344 pub cstore: Option<&'a CStore>,
345 pub crate_name: Option<&'a str>,
346 pub output_filenames: Option<&'a OutputFilenames>,
347 pub out_dir: Option<&'a Path>,
348 pub out_file: Option<&'a Path>,
349 pub arena: Option<&'tcx DroplessArena>,
350 pub arenas: Option<&'tcx GlobalArenas<'tcx>>,
351 pub expanded_crate: Option<&'a ast::Crate>,
352 pub hir_crate: Option<&'a hir::Crate>,
353 pub hir_map: Option<&'a hir_map::Map<'tcx>>,
354 pub resolutions: Option<&'a Resolutions>,
355 pub analysis: Option<&'a ty::CrateAnalysis>,
356 pub tcx: Option<TyCtxt<'a, 'tcx, 'tcx>>,
357 pub trans: Option<&'a trans::CrateTranslation>,
360 impl<'a, 'tcx> CompileState<'a, 'tcx> {
361 fn empty(input: &'a Input,
362 session: &'tcx Session,
363 out_dir: &'a Option<PathBuf>)
368 out_dir: out_dir.as_ref().map(|s| &**s),
376 output_filenames: None,
377 expanded_crate: None,
387 fn state_after_parse(input: &'a Input,
388 session: &'tcx Session,
389 out_dir: &'a Option<PathBuf>,
390 out_file: &'a Option<PathBuf>,
395 // Initialize the registry before moving `krate`
396 registry: Some(Registry::new(&session, krate.span)),
398 cstore: Some(cstore),
399 out_file: out_file.as_ref().map(|s| &**s),
400 ..CompileState::empty(input, session, out_dir)
404 fn state_after_expand(input: &'a Input,
405 session: &'tcx Session,
406 out_dir: &'a Option<PathBuf>,
407 out_file: &'a Option<PathBuf>,
409 expanded_crate: &'a ast::Crate,
413 crate_name: Some(crate_name),
414 cstore: Some(cstore),
415 expanded_crate: Some(expanded_crate),
416 out_file: out_file.as_ref().map(|s| &**s),
417 ..CompileState::empty(input, session, out_dir)
421 fn state_after_hir_lowering(input: &'a Input,
422 session: &'tcx Session,
423 out_dir: &'a Option<PathBuf>,
424 out_file: &'a Option<PathBuf>,
425 arena: &'tcx DroplessArena,
426 arenas: &'tcx GlobalArenas<'tcx>,
428 hir_map: &'a hir_map::Map<'tcx>,
429 analysis: &'a ty::CrateAnalysis,
430 resolutions: &'a Resolutions,
431 krate: &'a ast::Crate,
432 hir_crate: &'a hir::Crate,
436 crate_name: Some(crate_name),
438 arenas: Some(arenas),
439 cstore: Some(cstore),
440 hir_map: Some(hir_map),
441 analysis: Some(analysis),
442 resolutions: Some(resolutions),
443 expanded_crate: Some(krate),
444 hir_crate: Some(hir_crate),
445 out_file: out_file.as_ref().map(|s| &**s),
446 ..CompileState::empty(input, session, out_dir)
450 fn state_after_analysis(input: &'a Input,
451 session: &'tcx Session,
452 out_dir: &'a Option<PathBuf>,
453 out_file: &'a Option<PathBuf>,
454 krate: Option<&'a ast::Crate>,
455 hir_crate: &'a hir::Crate,
456 analysis: &'a ty::CrateAnalysis,
457 tcx: TyCtxt<'a, 'tcx, 'tcx>,
461 analysis: Some(analysis),
463 expanded_crate: krate,
464 hir_crate: Some(hir_crate),
465 crate_name: Some(crate_name),
466 out_file: out_file.as_ref().map(|s| &**s),
467 ..CompileState::empty(input, session, out_dir)
472 fn state_after_llvm(input: &'a Input,
473 session: &'tcx Session,
474 out_dir: &'a Option<PathBuf>,
475 out_file: &'a Option<PathBuf>,
476 trans: &'a trans::CrateTranslation)
480 out_file: out_file.as_ref().map(|s| &**s),
481 ..CompileState::empty(input, session, out_dir)
485 fn state_when_compilation_done(input: &'a Input,
486 session: &'tcx Session,
487 out_dir: &'a Option<PathBuf>,
488 out_file: &'a Option<PathBuf>)
491 out_file: out_file.as_ref().map(|s| &**s),
492 ..CompileState::empty(input, session, out_dir)
497 pub fn phase_1_parse_input<'a>(sess: &'a Session, input: &Input) -> PResult<'a, ast::Crate> {
498 let continue_after_error = sess.opts.debugging_opts.continue_parse_after_error;
499 sess.diagnostic().set_continue_after_error(continue_after_error);
501 let krate = time(sess.time_passes(), "parsing", || {
503 Input::File(ref file) => {
504 parse::parse_crate_from_file(file, &sess.parse_sess)
506 Input::Str { ref input, ref name } => {
507 parse::parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess)
512 sess.diagnostic().set_continue_after_error(true);
514 if sess.opts.debugging_opts.ast_json_noexpand {
515 println!("{}", json::as_json(&krate));
518 if sess.opts.debugging_opts.input_stats {
519 println!("Lines of code: {}", sess.codemap().count_lines());
520 println!("Pre-expansion node count: {}", count_nodes(&krate));
523 if let Some(ref s) = sess.opts.debugging_opts.show_span {
524 syntax::show_span::run(sess.diagnostic(), s, &krate);
527 if sess.opts.debugging_opts.hir_stats {
528 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
534 fn count_nodes(krate: &ast::Crate) -> usize {
535 let mut counter = NodeCounter::new();
536 visit::walk_crate(&mut counter, krate);
540 // For continuing compilation after a parsed crate has been
543 pub struct ExpansionResult {
544 pub expanded_crate: ast::Crate,
545 pub defs: hir_map::Definitions,
546 pub analysis: ty::CrateAnalysis,
547 pub resolutions: Resolutions,
548 pub hir_forest: hir_map::Forest,
551 /// Run the "early phases" of the compiler: initial `cfg` processing,
552 /// loading compiler plugins (including those from `addl_plugins`),
553 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
554 /// harness if one is to be provided, injection of a dependency on the
555 /// standard library and prelude, and name resolution.
557 /// Returns `None` if we're aborting after handling -W help.
558 pub fn phase_2_configure_and_expand<F>(sess: &Session,
561 registry: Option<Registry>,
563 addl_plugins: Option<Vec<String>>,
564 make_glob_map: MakeGlobMap,
566 -> Result<ExpansionResult, usize>
567 where F: FnOnce(&ast::Crate) -> CompileResult,
569 let time_passes = sess.time_passes();
571 let (mut krate, features) = syntax::config::features(krate, &sess.parse_sess, sess.opts.test);
572 // these need to be set "early" so that expansion sees `quote` if enabled.
573 *sess.features.borrow_mut() = features;
575 *sess.crate_types.borrow_mut() = collect_crate_types(sess, &krate.attrs);
576 *sess.crate_disambiguator.borrow_mut() = Symbol::intern(&compute_crate_disambiguator(sess));
578 time(time_passes, "recursion limit", || {
579 middle::recursion_limit::update_limits(sess, &krate);
582 krate = time(time_passes, "crate injection", || {
583 let alt_std_name = sess.opts.alt_std_name.clone();
584 syntax::std_inject::maybe_inject_crates_ref(krate, alt_std_name)
587 let mut addl_plugins = Some(addl_plugins);
588 let registrars = time(time_passes, "plugin loading", || {
589 plugin::load::load_plugins(sess,
593 addl_plugins.take().unwrap())
596 let mut registry = registry.unwrap_or(Registry::new(sess, krate.span));
598 time(time_passes, "plugin registration", || {
599 if sess.features.borrow().rustc_diagnostic_macros {
600 registry.register_macro("__diagnostic_used",
601 diagnostics::plugin::expand_diagnostic_used);
602 registry.register_macro("__register_diagnostic",
603 diagnostics::plugin::expand_register_diagnostic);
604 registry.register_macro("__build_diagnostic_array",
605 diagnostics::plugin::expand_build_diagnostic_array);
608 for registrar in registrars {
609 registry.args_hidden = Some(registrar.args);
610 (registrar.fun)(&mut registry);
614 let whitelisted_legacy_custom_derives = registry.take_whitelisted_custom_derives();
615 let Registry { syntax_exts, early_lint_passes, late_lint_passes, lint_groups,
616 llvm_passes, attributes, .. } = registry;
618 sess.track_errors(|| {
619 let mut ls = sess.lint_store.borrow_mut();
620 for pass in early_lint_passes {
621 ls.register_early_pass(Some(sess), true, pass);
623 for pass in late_lint_passes {
624 ls.register_late_pass(Some(sess), true, pass);
627 for (name, to) in lint_groups {
628 ls.register_group(Some(sess), true, name, to);
631 *sess.plugin_llvm_passes.borrow_mut() = llvm_passes;
632 *sess.plugin_attributes.borrow_mut() = attributes.clone();
635 // Lint plugins are registered; now we can process command line flags.
636 if sess.opts.describe_lints {
637 super::describe_lints(&sess.lint_store.borrow(), true);
640 sess.track_errors(|| sess.lint_store.borrow_mut().process_command_line(sess))?;
642 // Currently, we ignore the name resolution data structures for the purposes of dependency
643 // tracking. Instead we will run name resolution and include its output in the hash of each
644 // item, much like we do for macro expansion. In other words, the hash reflects not just
645 // its contents but the results of name resolution on those contents. Hopefully we'll push
646 // this back at some point.
647 let _ignore = sess.dep_graph.in_ignore();
648 let mut crate_loader = CrateLoader::new(sess, &cstore, crate_name);
649 crate_loader.preprocess(&krate);
650 let resolver_arenas = Resolver::arenas();
651 let mut resolver = Resolver::new(sess,
657 resolver.whitelisted_legacy_custom_derives = whitelisted_legacy_custom_derives;
658 syntax_ext::register_builtins(&mut resolver, syntax_exts, sess.features.borrow().quote);
660 krate = time(time_passes, "expansion", || {
661 // Windows dlls do not have rpaths, so they don't know how to find their
662 // dependencies. It's up to us to tell the system where to find all the
663 // dependent dlls. Note that this uses cfg!(windows) as opposed to
664 // targ_cfg because syntax extensions are always loaded for the host
665 // compiler, not for the target.
667 // This is somewhat of an inherently racy operation, however, as
668 // multiple threads calling this function could possibly continue
669 // extending PATH far beyond what it should. To solve this for now we
670 // just don't add any new elements to PATH which are already there
671 // within PATH. This is basically a targeted fix at #17360 for rustdoc
672 // which runs rustc in parallel but has been seen (#33844) to cause
673 // problems with PATH becoming too long.
674 let mut old_path = OsString::new();
676 old_path = env::var_os("PATH").unwrap_or(old_path);
677 let mut new_path = sess.host_filesearch(PathKind::All)
678 .get_dylib_search_paths();
679 for path in env::split_paths(&old_path) {
680 if !new_path.contains(&path) {
685 &env::join_paths(new_path.iter()
686 .filter(|p| env::join_paths(iter::once(p)).is_ok()))
689 let features = sess.features.borrow();
690 let cfg = syntax::ext::expand::ExpansionConfig {
691 features: Some(&features),
692 recursion_limit: sess.recursion_limit.get(),
693 trace_mac: sess.opts.debugging_opts.trace_macros,
694 should_test: sess.opts.test,
695 ..syntax::ext::expand::ExpansionConfig::default(crate_name.to_string())
698 let mut ecx = ExtCtxt::new(&sess.parse_sess, cfg, &mut resolver);
699 let err_count = ecx.parse_sess.span_diagnostic.err_count();
701 let krate = ecx.monotonic_expander().expand_crate(krate);
703 let mut missing_fragment_specifiers: Vec<_> =
704 ecx.parse_sess.missing_fragment_specifiers.borrow().iter().cloned().collect();
705 missing_fragment_specifiers.sort();
706 for span in missing_fragment_specifiers {
707 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
708 let msg = "missing fragment specifier".to_string();
709 sess.add_lint(lint, ast::CRATE_NODE_ID, span, msg);
711 if ecx.parse_sess.span_diagnostic.err_count() - ecx.resolve_err_count > err_count {
712 ecx.parse_sess.span_diagnostic.abort_if_errors();
715 env::set_var("PATH", &old_path);
720 krate = time(time_passes, "maybe building test harness", || {
721 syntax::test::modify_for_testing(&sess.parse_sess,
728 // If we're in rustdoc we're always compiling as an rlib, but that'll trip a
729 // bunch of checks in the `modify` function below. For now just skip this
730 // step entirely if we're rustdoc as it's not too useful anyway.
731 if !sess.opts.actually_rustdoc {
732 krate = time(time_passes, "maybe creating a macro crate", || {
733 let crate_types = sess.crate_types.borrow();
734 let num_crate_types = crate_types.len();
735 let is_proc_macro_crate = crate_types.contains(&config::CrateTypeProcMacro);
736 let is_test_crate = sess.opts.test;
737 syntax_ext::proc_macro_registrar::modify(&sess.parse_sess,
747 after_expand(&krate)?;
749 if sess.opts.debugging_opts.input_stats {
750 println!("Post-expansion node count: {}", count_nodes(&krate));
753 if sess.opts.debugging_opts.hir_stats {
754 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
757 if sess.opts.debugging_opts.ast_json {
758 println!("{}", json::as_json(&krate));
762 "checking for inline asm in case the target doesn't support it",
763 || no_asm::check_crate(sess, &krate));
767 || lint::check_ast_crate(sess, &krate));
771 || ast_validation::check_crate(sess, &krate));
773 time(time_passes, "name resolution", || -> CompileResult {
774 resolver.resolve_crate(&krate);
778 if resolver.found_unresolved_macro {
779 sess.parse_sess.span_diagnostic.abort_if_errors();
782 // Needs to go *after* expansion to be able to check the results of macro expansion.
783 time(time_passes, "complete gated feature checking", || {
784 sess.track_errors(|| {
785 syntax::feature_gate::check_crate(&krate,
787 &sess.features.borrow(),
789 sess.opts.unstable_features);
794 let hir_forest = time(time_passes, "lowering ast -> hir", || {
795 let hir_crate = lower_crate(sess, &krate, &mut resolver);
797 if sess.opts.debugging_opts.hir_stats {
798 hir_stats::print_hir_stats(&hir_crate);
801 hir_map::Forest::new(hir_crate, &sess.dep_graph)
804 // Discard hygiene data, which isn't required after lowering to HIR.
805 if !keep_hygiene_data(sess) {
806 syntax::ext::hygiene::clear_markings();
810 expanded_crate: krate,
811 defs: resolver.definitions,
812 analysis: ty::CrateAnalysis {
813 access_levels: Rc::new(AccessLevels::default()),
814 reachable: Rc::new(NodeSet()),
815 name: crate_name.to_string(),
816 glob_map: if resolver.make_glob_map { Some(resolver.glob_map) } else { None },
818 resolutions: Resolutions {
819 freevars: resolver.freevars,
820 export_map: resolver.export_map,
821 trait_map: resolver.trait_map,
822 maybe_unused_trait_imports: resolver.maybe_unused_trait_imports,
824 hir_forest: hir_forest,
828 /// Run the resolution, typechecking, region checking and other
829 /// miscellaneous analysis passes on the crate. Return various
830 /// structures carrying the results of the analysis.
831 pub fn phase_3_run_analysis_passes<'tcx, F, R>(sess: &'tcx Session,
832 hir_map: hir_map::Map<'tcx>,
833 mut analysis: ty::CrateAnalysis,
834 resolutions: Resolutions,
835 arena: &'tcx DroplessArena,
836 arenas: &'tcx GlobalArenas<'tcx>,
840 where F: for<'a> FnOnce(TyCtxt<'a, 'tcx, 'tcx>,
842 IncrementalHashesMap,
845 macro_rules! try_with_f {
846 ($e: expr, ($t: expr, $a: expr, $h: expr)) => {
850 f($t, $a, $h, Err(x));
857 let time_passes = sess.time_passes();
859 let lang_items = time(time_passes, "language item collection", || {
860 sess.track_errors(|| {
861 middle::lang_items::collect_language_items(&sess, &hir_map)
865 let named_region_map = time(time_passes,
866 "lifetime resolution",
867 || middle::resolve_lifetime::krate(sess, &hir_map))?;
870 "looking for entry point",
871 || middle::entry::find_entry_point(sess, &hir_map));
873 sess.plugin_registrar_fn.set(time(time_passes, "looking for plugin registrar", || {
874 plugin::build::find_plugin_registrar(sess.diagnostic(), &hir_map)
876 sess.derive_registrar_fn.set(derive_registrar::find(&hir_map));
880 || loops::check_crate(sess, &hir_map));
883 "static item recursion checking",
884 || static_recursion::check_crate(sess, &hir_map))?;
886 let index = stability::Index::new(&hir_map);
888 let mut local_providers = ty::maps::Providers::default();
889 borrowck::provide(&mut local_providers);
890 mir::provide(&mut local_providers);
891 reachable::provide(&mut local_providers);
892 rustc_privacy::provide(&mut local_providers);
893 trans::provide(&mut local_providers);
894 typeck::provide(&mut local_providers);
895 ty::provide(&mut local_providers);
896 reachable::provide(&mut local_providers);
897 rustc_const_eval::provide(&mut local_providers);
898 middle::region::provide(&mut local_providers);
900 let mut extern_providers = ty::maps::Providers::default();
901 cstore::provide(&mut extern_providers);
902 trans::provide(&mut extern_providers);
903 ty::provide_extern(&mut extern_providers);
904 // FIXME(eddyb) get rid of this once we replace const_eval with miri.
905 rustc_const_eval::provide(&mut extern_providers);
907 // Setup the MIR passes that we want to run.
908 let mut passes = sess.mir_passes.borrow().clone();
909 passes.push_hook(mir::transform::dump_mir::DumpMir);
911 // What we need to do constant evaluation.
912 passes.push_pass(MIR_CONST, mir::transform::simplify::SimplifyCfg::new("initial"));
913 passes.push_pass(MIR_CONST, mir::transform::type_check::TypeckMir);
915 // What we need to run borrowck etc.
916 passes.push_pass(MIR_VALIDATED, mir::transform::qualify_consts::QualifyAndPromoteConstants);
917 passes.push_pass(MIR_VALIDATED, mir::transform::simplify_branches::SimplifyBranches::new("initial"));
918 passes.push_pass(MIR_VALIDATED, mir::transform::simplify::SimplifyCfg::new("qualify-consts"));
920 // Optimizations begin.
921 passes.push_pass(MIR_OPTIMIZED, mir::transform::no_landing_pads::NoLandingPads);
922 passes.push_pass(MIR_OPTIMIZED, mir::transform::simplify::SimplifyCfg::new("no-landing-pads"));
924 // From here on out, regions are gone.
925 passes.push_pass(MIR_OPTIMIZED, mir::transform::erase_regions::EraseRegions);
926 passes.push_pass(MIR_OPTIMIZED, mir::transform::add_call_guards::AddCallGuards);
927 passes.push_pass(MIR_OPTIMIZED, borrowck::ElaborateDrops);
928 passes.push_pass(MIR_OPTIMIZED, mir::transform::no_landing_pads::NoLandingPads);
929 passes.push_pass(MIR_OPTIMIZED, mir::transform::simplify::SimplifyCfg::new("elaborate-drops"));
931 // No lifetime analysis based on borrowing can be done from here on out.
932 // passes.push_pass(MIR_OPTIMIZED, mir::transform::inline::Inline); // TODO re-enable
933 passes.push_pass(MIR_OPTIMIZED, mir::transform::instcombine::InstCombine);
934 passes.push_pass(MIR_OPTIMIZED, mir::transform::deaggregator::Deaggregator);
935 passes.push_pass(MIR_OPTIMIZED, mir::transform::copy_prop::CopyPropagation);
936 passes.push_pass(MIR_OPTIMIZED, mir::transform::simplify::SimplifyLocals);
937 passes.push_pass(MIR_OPTIMIZED, mir::transform::add_call_guards::AddCallGuards);
938 passes.push_pass(MIR_OPTIMIZED, mir::transform::dump_mir::Marker("PreTrans"));
940 TyCtxt::create_and_enter(sess,
953 let incremental_hashes_map =
955 "compute_incremental_hashes_map",
956 || rustc_incremental::compute_incremental_hashes_map(tcx));
960 || rustc_incremental::load_dep_graph(tcx, &incremental_hashes_map));
962 time(time_passes, "stability index", || {
963 tcx.stability.borrow_mut().build(tcx)
967 "stability checking",
968 || stability::check_unstable_api_usage(tcx));
970 // passes are timed inside typeck
971 try_with_f!(typeck::check_crate(tcx), (tcx, analysis, incremental_hashes_map));
975 || consts::check_crate(tcx));
977 analysis.access_levels =
978 time(time_passes, "privacy checking", || rustc_privacy::check_crate(tcx));
981 "intrinsic checking",
982 || middle::intrinsicck::check_crate(tcx));
986 || middle::effect::check_crate(tcx));
990 || check_match::check_crate(tcx));
992 // this must run before MIR dump, because
993 // "not all control paths return a value" is reported here.
995 // maybe move the check to a MIR pass?
998 || middle::liveness::check_crate(tcx));
1002 || mir::mir_map::build_mir_for_crate(tcx));
1004 if sess.opts.debugging_opts.mir_stats {
1005 mir_stats::print_mir_stats(tcx, "PRE CLEANUP MIR STATS");
1008 time(time_passes, "MIR cleanup and validation", || {
1009 tcx.mir_passes.run_passes(tcx, MIR_CONST);
1010 tcx.mir_passes.run_passes(tcx, MIR_VALIDATED);
1015 || borrowck::check_crate(tcx));
1017 // Avoid overwhelming user with errors if type checking failed.
1018 // I'm not sure how helpful this is, to be honest, but it avoids
1020 // lot of annoying errors in the compile-fail tests (basically,
1021 // lint warnings and so on -- kindck used to do this abort, but
1022 // kindck is gone now). -nmatsakis
1023 if sess.err_count() > 0 {
1024 return Ok(f(tcx, analysis, incremental_hashes_map, Err(sess.err_count())));
1027 analysis.reachable =
1029 "reachability checking",
1030 || reachable::find_reachable(tcx));
1032 time(time_passes, "death checking", || middle::dead::check_crate(tcx));
1034 time(time_passes, "unused lib feature checking", || {
1035 stability::check_unused_or_stable_features(tcx)
1038 time(time_passes, "lint checking", || lint::check_crate(tcx));
1040 // The above three passes generate errors w/o aborting
1041 if sess.err_count() > 0 {
1042 return Ok(f(tcx, analysis, incremental_hashes_map, Err(sess.err_count())));
1045 Ok(f(tcx, analysis, incremental_hashes_map, Ok(())))
1049 /// Run the translation phase to LLVM, after which the AST and analysis can
1051 pub fn phase_4_translate_to_llvm<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1052 analysis: ty::CrateAnalysis,
1053 incremental_hashes_map: &IncrementalHashesMap)
1054 -> trans::CrateTranslation {
1055 let time_passes = tcx.sess.time_passes();
1058 "resolving dependency formats",
1059 || dependency_format::calculate(&tcx.sess));
1061 if tcx.sess.opts.debugging_opts.mir_stats {
1062 mir_stats::print_mir_stats(tcx, "PRE OPTIMISATION MIR STATS");
1065 // Run the passes that transform the MIR into a more suitable form for translation to LLVM
1067 time(time_passes, "MIR optimisations", || {
1068 tcx.mir_passes.run_passes(tcx, MIR_OPTIMIZED);
1071 if tcx.sess.opts.debugging_opts.mir_stats {
1072 mir_stats::print_mir_stats(tcx, "POST OPTIMISATION MIR STATS");
1078 move || trans::trans_crate(tcx, analysis, &incremental_hashes_map));
1082 || rustc_incremental::assert_dep_graph(tcx));
1085 "serialize dep graph",
1086 || rustc_incremental::save_dep_graph(tcx,
1087 &incremental_hashes_map,
1088 &translation.metadata.hashes,
1089 translation.link.crate_hash));
1093 /// Run LLVM itself, producing a bitcode file, assembly file or object file
1094 /// as a side effect.
1095 pub fn phase_5_run_llvm_passes(sess: &Session,
1096 trans: &trans::CrateTranslation,
1097 outputs: &OutputFilenames) -> CompileResult {
1098 if sess.opts.cg.no_integrated_as ||
1099 (sess.target.target.options.no_integrated_as &&
1100 (outputs.outputs.contains_key(&OutputType::Object) ||
1101 outputs.outputs.contains_key(&OutputType::Exe)))
1103 let output_types = OutputTypes::new(&[(OutputType::Assembly, None)]);
1104 time(sess.time_passes(),
1106 || write::run_passes(sess, trans, &output_types, outputs));
1108 write::run_assembler(sess, outputs);
1110 // HACK the linker expects the object file to be named foo.0.o but
1111 // `run_assembler` produces an object named just foo.o. Rename it if we
1112 // are going to build an executable
1113 if sess.opts.output_types.contains_key(&OutputType::Exe) {
1114 let f = outputs.path(OutputType::Object);
1115 rename_or_copy_remove(&f,
1116 f.with_file_name(format!("{}.0.o",
1117 f.file_stem().unwrap().to_string_lossy()))).unwrap();
1120 // Remove assembly source, unless --save-temps was specified
1121 if !sess.opts.cg.save_temps {
1122 fs::remove_file(&outputs.temp_path(OutputType::Assembly, None)).unwrap();
1125 time(sess.time_passes(),
1127 || write::run_passes(sess, trans, &sess.opts.output_types, outputs));
1130 time(sess.time_passes(),
1131 "serialize work products",
1132 move || rustc_incremental::save_work_products(sess));
1134 if sess.err_count() > 0 {
1135 Err(sess.err_count())
1141 /// Run the linker on any artifacts that resulted from the LLVM run.
1142 /// This should produce either a finished executable or library.
1143 pub fn phase_6_link_output(sess: &Session,
1144 trans: &trans::CrateTranslation,
1145 outputs: &OutputFilenames) {
1146 time(sess.time_passes(),
1148 || link::link_binary(sess, trans, outputs, &trans.crate_name.as_str()));
1151 fn escape_dep_filename(filename: &str) -> String {
1152 // Apparently clang and gcc *only* escape spaces:
1153 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
1154 filename.replace(" ", "\\ ")
1157 fn write_out_deps(sess: &Session, outputs: &OutputFilenames, crate_name: &str) {
1158 let mut out_filenames = Vec::new();
1159 for output_type in sess.opts.output_types.keys() {
1160 let file = outputs.path(*output_type);
1161 match *output_type {
1162 OutputType::Exe => {
1163 for output in sess.crate_types.borrow().iter() {
1164 let p = link::filename_for_input(sess, *output, crate_name, outputs);
1165 out_filenames.push(p);
1169 out_filenames.push(file);
1174 // Write out dependency rules to the dep-info file if requested
1175 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
1178 let deps_filename = outputs.path(OutputType::DepInfo);
1181 (|| -> io::Result<()> {
1182 // Build a list of files used to compile the output and
1183 // write Makefile-compatible dependency rules
1184 let files: Vec<String> = sess.codemap()
1188 .filter(|fmap| fmap.is_real_file())
1189 .filter(|fmap| !fmap.is_imported())
1190 .map(|fmap| escape_dep_filename(&fmap.name))
1192 let mut file = fs::File::create(&deps_filename)?;
1193 for path in &out_filenames {
1194 write!(file, "{}: {}\n\n", path.display(), files.join(" "))?;
1197 // Emit a fake target for each input file to the compilation. This
1198 // prevents `make` from spitting out an error if a file is later
1199 // deleted. For more info see #28735
1201 writeln!(file, "{}:", path)?;
1209 sess.fatal(&format!("error writing dependencies to `{}`: {}",
1210 deps_filename.display(),
1216 pub fn collect_crate_types(session: &Session, attrs: &[ast::Attribute]) -> Vec<config::CrateType> {
1217 // Unconditionally collect crate types from attributes to make them used
1218 let attr_types: Vec<config::CrateType> =
1221 if a.check_name("crate_type") {
1222 match a.value_str() {
1223 Some(ref n) if *n == "rlib" => {
1224 Some(config::CrateTypeRlib)
1226 Some(ref n) if *n == "dylib" => {
1227 Some(config::CrateTypeDylib)
1229 Some(ref n) if *n == "cdylib" => {
1230 Some(config::CrateTypeCdylib)
1232 Some(ref n) if *n == "lib" => {
1233 Some(config::default_lib_output())
1235 Some(ref n) if *n == "staticlib" => {
1236 Some(config::CrateTypeStaticlib)
1238 Some(ref n) if *n == "proc-macro" => {
1239 Some(config::CrateTypeProcMacro)
1241 Some(ref n) if *n == "bin" => Some(config::CrateTypeExecutable),
1243 session.add_lint(lint::builtin::UNKNOWN_CRATE_TYPES,
1246 "invalid `crate_type` value".to_string());
1250 session.struct_span_err(a.span, "`crate_type` requires a value")
1251 .note("for example: `#![crate_type=\"lib\"]`")
1262 // If we're generating a test executable, then ignore all other output
1263 // styles at all other locations
1264 if session.opts.test {
1265 return vec![config::CrateTypeExecutable];
1268 // Only check command line flags if present. If no types are specified by
1269 // command line, then reuse the empty `base` Vec to hold the types that
1270 // will be found in crate attributes.
1271 let mut base = session.opts.crate_types.clone();
1272 if base.is_empty() {
1273 base.extend(attr_types);
1274 if base.is_empty() {
1275 base.push(link::default_output_for_target(session));
1282 .filter(|crate_type| {
1283 let res = !link::invalid_output_for_target(session, *crate_type);
1286 session.warn(&format!("dropping unsupported crate type `{}` for target `{}`",
1288 session.opts.target_triple));
1296 pub fn compute_crate_disambiguator(session: &Session) -> String {
1297 use std::hash::Hasher;
1299 // The crate_disambiguator is a 128 bit hash. The disambiguator is fed
1300 // into various other hashes quite a bit (symbol hashes, incr. comp. hashes,
1301 // debuginfo type IDs, etc), so we don't want it to be too wide. 128 bits
1302 // should still be safe enough to avoid collisions in practice.
1303 // FIXME(mw): It seems that the crate_disambiguator is used everywhere as
1304 // a hex-string instead of raw bytes. We should really use the
1305 // smaller representation.
1306 let mut hasher = StableHasher::<Fingerprint>::new();
1308 let mut metadata = session.opts.cg.metadata.clone();
1309 // We don't want the crate_disambiguator to dependent on the order
1310 // -C metadata arguments, so sort them:
1312 // Every distinct -C metadata value is only incorporated once:
1315 hasher.write(b"metadata");
1316 for s in &metadata {
1317 // Also incorporate the length of a metadata string, so that we generate
1318 // different values for `-Cmetadata=ab -Cmetadata=c` and
1319 // `-Cmetadata=a -Cmetadata=bc`
1320 hasher.write_usize(s.len());
1321 hasher.write(s.as_bytes());
1324 // If this is an executable, add a special suffix, so that we don't get
1325 // symbol conflicts when linking against a library of the same name.
1326 let is_exe = session.crate_types.borrow().contains(&config::CrateTypeExecutable);
1328 format!("{}{}", hasher.finish().to_hex(), if is_exe { "-exe" } else {""})
1331 pub fn build_output_filenames(input: &Input,
1332 odir: &Option<PathBuf>,
1333 ofile: &Option<PathBuf>,
1334 attrs: &[ast::Attribute],
1336 -> OutputFilenames {
1339 // "-" as input file will cause the parser to read from stdin so we
1340 // have to make up a name
1341 // We want to toss everything after the final '.'
1342 let dirpath = match *odir {
1343 Some(ref d) => d.clone(),
1344 None => PathBuf::new(),
1347 // If a crate name is present, we use it as the link name
1348 let stem = sess.opts
1351 .or_else(|| attr::find_crate_name(attrs).map(|n| n.to_string()))
1352 .unwrap_or(input.filestem());
1355 out_directory: dirpath,
1357 single_output_file: None,
1358 extra: sess.opts.cg.extra_filename.clone(),
1359 outputs: sess.opts.output_types.clone(),
1363 Some(ref out_file) => {
1364 let unnamed_output_types = sess.opts
1367 .filter(|a| a.is_none())
1369 let ofile = if unnamed_output_types > 1 {
1370 sess.warn("due to multiple output types requested, the explicitly specified \
1371 output file name will be adapted for each output type");
1374 Some(out_file.clone())
1377 sess.warn("ignoring --out-dir flag due to -o flag.");
1380 let cur_dir = Path::new("");
1383 out_directory: out_file.parent().unwrap_or(cur_dir).to_path_buf(),
1384 out_filestem: out_file.file_stem()
1385 .unwrap_or(OsStr::new(""))
1389 single_output_file: ofile,
1390 extra: sess.opts.cg.extra_filename.clone(),
1391 outputs: sess.opts.output_types.clone(),