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, Passes};
24 use rustc::ty::{self, TyCtxt, Resolutions, GlobalArenas};
26 use rustc::util::common::time;
27 use rustc::util::nodemap::NodeSet;
28 use rustc::util::fs::rename_or_copy_remove;
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 use rustc_trans::back::{link, write};
35 use rustc_trans as trans;
36 use rustc_typeck as typeck;
38 use rustc_plugin::registry::Registry;
39 use rustc_plugin as plugin;
40 use rustc_passes::{ast_validation, no_asm, loops, consts, static_recursion, hir_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 ecx.check_unused_macros();
705 let mut missing_fragment_specifiers: Vec<_> =
706 ecx.parse_sess.missing_fragment_specifiers.borrow().iter().cloned().collect();
707 missing_fragment_specifiers.sort();
708 for span in missing_fragment_specifiers {
709 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
710 let msg = "missing fragment specifier".to_string();
711 sess.add_lint(lint, ast::CRATE_NODE_ID, span, msg);
713 if ecx.parse_sess.span_diagnostic.err_count() - ecx.resolve_err_count > err_count {
714 ecx.parse_sess.span_diagnostic.abort_if_errors();
717 env::set_var("PATH", &old_path);
722 krate = time(time_passes, "maybe building test harness", || {
723 syntax::test::modify_for_testing(&sess.parse_sess,
730 // If we're in rustdoc we're always compiling as an rlib, but that'll trip a
731 // bunch of checks in the `modify` function below. For now just skip this
732 // step entirely if we're rustdoc as it's not too useful anyway.
733 if !sess.opts.actually_rustdoc {
734 krate = time(time_passes, "maybe creating a macro crate", || {
735 let crate_types = sess.crate_types.borrow();
736 let num_crate_types = crate_types.len();
737 let is_proc_macro_crate = crate_types.contains(&config::CrateTypeProcMacro);
738 let is_test_crate = sess.opts.test;
739 syntax_ext::proc_macro_registrar::modify(&sess.parse_sess,
749 after_expand(&krate)?;
751 if sess.opts.debugging_opts.input_stats {
752 println!("Post-expansion node count: {}", count_nodes(&krate));
755 if sess.opts.debugging_opts.hir_stats {
756 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
759 if sess.opts.debugging_opts.ast_json {
760 println!("{}", json::as_json(&krate));
764 "checking for inline asm in case the target doesn't support it",
765 || no_asm::check_crate(sess, &krate));
769 || lint::check_ast_crate(sess, &krate));
773 || ast_validation::check_crate(sess, &krate));
775 time(time_passes, "name resolution", || -> CompileResult {
776 resolver.resolve_crate(&krate);
780 if resolver.found_unresolved_macro {
781 sess.parse_sess.span_diagnostic.abort_if_errors();
784 // Needs to go *after* expansion to be able to check the results of macro expansion.
785 time(time_passes, "complete gated feature checking", || {
786 sess.track_errors(|| {
787 syntax::feature_gate::check_crate(&krate,
789 &sess.features.borrow(),
791 sess.opts.unstable_features);
796 let hir_forest = time(time_passes, "lowering ast -> hir", || {
797 let hir_crate = lower_crate(sess, &krate, &mut resolver);
799 if sess.opts.debugging_opts.hir_stats {
800 hir_stats::print_hir_stats(&hir_crate);
803 hir_map::Forest::new(hir_crate, &sess.dep_graph)
806 // Discard hygiene data, which isn't required after lowering to HIR.
807 if !keep_hygiene_data(sess) {
808 syntax::ext::hygiene::clear_markings();
812 expanded_crate: krate,
813 defs: resolver.definitions,
814 analysis: ty::CrateAnalysis {
815 access_levels: Rc::new(AccessLevels::default()),
816 reachable: Rc::new(NodeSet()),
817 name: crate_name.to_string(),
818 glob_map: if resolver.make_glob_map { Some(resolver.glob_map) } else { None },
820 resolutions: Resolutions {
821 freevars: resolver.freevars,
822 export_map: resolver.export_map,
823 trait_map: resolver.trait_map,
824 maybe_unused_trait_imports: resolver.maybe_unused_trait_imports,
826 hir_forest: hir_forest,
830 /// Run the resolution, typechecking, region checking and other
831 /// miscellaneous analysis passes on the crate. Return various
832 /// structures carrying the results of the analysis.
833 pub fn phase_3_run_analysis_passes<'tcx, F, R>(sess: &'tcx Session,
834 hir_map: hir_map::Map<'tcx>,
835 mut analysis: ty::CrateAnalysis,
836 resolutions: Resolutions,
837 arena: &'tcx DroplessArena,
838 arenas: &'tcx GlobalArenas<'tcx>,
842 where F: for<'a> FnOnce(TyCtxt<'a, 'tcx, 'tcx>,
844 IncrementalHashesMap,
847 macro_rules! try_with_f {
848 ($e: expr, ($t: expr, $a: expr, $h: expr)) => {
852 f($t, $a, $h, Err(x));
859 let time_passes = sess.time_passes();
861 let lang_items = time(time_passes, "language item collection", || {
862 sess.track_errors(|| {
863 middle::lang_items::collect_language_items(&sess, &hir_map)
867 let named_region_map = time(time_passes,
868 "lifetime resolution",
869 || middle::resolve_lifetime::krate(sess, &hir_map))?;
872 "looking for entry point",
873 || middle::entry::find_entry_point(sess, &hir_map));
875 sess.plugin_registrar_fn.set(time(time_passes, "looking for plugin registrar", || {
876 plugin::build::find_plugin_registrar(sess.diagnostic(), &hir_map)
878 sess.derive_registrar_fn.set(derive_registrar::find(&hir_map));
882 || loops::check_crate(sess, &hir_map));
885 "static item recursion checking",
886 || static_recursion::check_crate(sess, &hir_map))?;
888 let index = stability::Index::new(&sess);
890 let mut local_providers = ty::maps::Providers::default();
891 borrowck::provide(&mut local_providers);
892 mir::provide(&mut local_providers);
893 reachable::provide(&mut local_providers);
894 rustc_privacy::provide(&mut local_providers);
895 trans::provide(&mut local_providers);
896 typeck::provide(&mut local_providers);
897 ty::provide(&mut local_providers);
898 traits::provide(&mut local_providers);
899 reachable::provide(&mut local_providers);
900 rustc_const_eval::provide(&mut local_providers);
901 middle::region::provide(&mut local_providers);
903 let mut extern_providers = ty::maps::Providers::default();
904 cstore::provide(&mut extern_providers);
905 trans::provide(&mut extern_providers);
906 ty::provide_extern(&mut extern_providers);
907 traits::provide_extern(&mut extern_providers);
908 // FIXME(eddyb) get rid of this once we replace const_eval with miri.
909 rustc_const_eval::provide(&mut extern_providers);
911 // Setup the MIR passes that we want to run.
912 let mut passes = Passes::new();
913 passes.push_hook(mir::transform::dump_mir::DumpMir);
915 // What we need to do constant evaluation.
916 passes.push_pass(MIR_CONST, mir::transform::simplify::SimplifyCfg::new("initial"));
917 passes.push_pass(MIR_CONST, mir::transform::type_check::TypeckMir);
919 // What we need to run borrowck etc.
920 passes.push_pass(MIR_VALIDATED, mir::transform::qualify_consts::QualifyAndPromoteConstants);
921 passes.push_pass(MIR_VALIDATED,
922 mir::transform::simplify_branches::SimplifyBranches::new("initial"));
923 passes.push_pass(MIR_VALIDATED, mir::transform::simplify::SimplifyCfg::new("qualify-consts"));
925 // Optimizations begin.
926 passes.push_pass(MIR_OPTIMIZED, mir::transform::no_landing_pads::NoLandingPads);
927 passes.push_pass(MIR_OPTIMIZED, mir::transform::simplify::SimplifyCfg::new("no-landing-pads"));
929 // From here on out, regions are gone.
930 passes.push_pass(MIR_OPTIMIZED, mir::transform::erase_regions::EraseRegions);
931 passes.push_pass(MIR_OPTIMIZED, mir::transform::add_call_guards::AddCallGuards);
932 passes.push_pass(MIR_OPTIMIZED, borrowck::ElaborateDrops);
933 passes.push_pass(MIR_OPTIMIZED, mir::transform::no_landing_pads::NoLandingPads);
934 passes.push_pass(MIR_OPTIMIZED, mir::transform::simplify::SimplifyCfg::new("elaborate-drops"));
936 // No lifetime analysis based on borrowing can be done from here on out.
937 passes.push_pass(MIR_OPTIMIZED, mir::transform::inline::Inline);
938 passes.push_pass(MIR_OPTIMIZED, mir::transform::instcombine::InstCombine);
939 passes.push_pass(MIR_OPTIMIZED, mir::transform::deaggregator::Deaggregator);
940 passes.push_pass(MIR_OPTIMIZED, mir::transform::copy_prop::CopyPropagation);
941 passes.push_pass(MIR_OPTIMIZED, mir::transform::simplify::SimplifyLocals);
942 passes.push_pass(MIR_OPTIMIZED, mir::transform::add_call_guards::AddCallGuards);
943 passes.push_pass(MIR_OPTIMIZED, mir::transform::dump_mir::Marker("PreTrans"));
945 TyCtxt::create_and_enter(sess,
958 let incremental_hashes_map =
960 "compute_incremental_hashes_map",
961 || rustc_incremental::compute_incremental_hashes_map(tcx));
965 || rustc_incremental::load_dep_graph(tcx, &incremental_hashes_map));
967 time(time_passes, "stability index", || {
968 tcx.stability.borrow_mut().build(tcx)
972 "stability checking",
973 || stability::check_unstable_api_usage(tcx));
975 // passes are timed inside typeck
976 try_with_f!(typeck::check_crate(tcx), (tcx, analysis, incremental_hashes_map));
980 || consts::check_crate(tcx));
982 analysis.access_levels =
983 time(time_passes, "privacy checking", || rustc_privacy::check_crate(tcx));
986 "intrinsic checking",
987 || middle::intrinsicck::check_crate(tcx));
991 || middle::effect::check_crate(tcx));
995 || check_match::check_crate(tcx));
997 // this must run before MIR dump, because
998 // "not all control paths return a value" is reported here.
1000 // maybe move the check to a MIR pass?
1002 "liveness checking",
1003 || middle::liveness::check_crate(tcx));
1007 || borrowck::check_crate(tcx));
1009 // Avoid overwhelming user with errors if type checking failed.
1010 // I'm not sure how helpful this is, to be honest, but it avoids
1012 // lot of annoying errors in the compile-fail tests (basically,
1013 // lint warnings and so on -- kindck used to do this abort, but
1014 // kindck is gone now). -nmatsakis
1015 if sess.err_count() > 0 {
1016 return Ok(f(tcx, analysis, incremental_hashes_map, Err(sess.err_count())));
1019 analysis.reachable =
1021 "reachability checking",
1022 || reachable::find_reachable(tcx));
1024 time(time_passes, "death checking", || middle::dead::check_crate(tcx));
1026 time(time_passes, "unused lib feature checking", || {
1027 stability::check_unused_or_stable_features(tcx)
1030 time(time_passes, "lint checking", || lint::check_crate(tcx));
1032 // The above three passes generate errors w/o aborting
1033 if sess.err_count() > 0 {
1034 return Ok(f(tcx, analysis, incremental_hashes_map, Err(sess.err_count())));
1037 Ok(f(tcx, analysis, incremental_hashes_map, Ok(())))
1041 /// Run the translation phase to LLVM, after which the AST and analysis can
1043 pub fn phase_4_translate_to_llvm<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1044 analysis: ty::CrateAnalysis,
1045 incremental_hashes_map: &IncrementalHashesMap)
1046 -> trans::CrateTranslation {
1047 let time_passes = tcx.sess.time_passes();
1050 "resolving dependency formats",
1051 || dependency_format::calculate(&tcx.sess));
1056 move || trans::trans_crate(tcx, analysis, &incremental_hashes_map));
1060 || rustc_incremental::assert_dep_graph(tcx));
1063 "serialize dep graph",
1064 || rustc_incremental::save_dep_graph(tcx,
1065 &incremental_hashes_map,
1066 &translation.metadata.hashes,
1067 translation.link.crate_hash));
1071 /// Run LLVM itself, producing a bitcode file, assembly file or object file
1072 /// as a side effect.
1073 pub fn phase_5_run_llvm_passes(sess: &Session,
1074 trans: &trans::CrateTranslation,
1075 outputs: &OutputFilenames) -> CompileResult {
1076 if sess.opts.cg.no_integrated_as ||
1077 (sess.target.target.options.no_integrated_as &&
1078 (outputs.outputs.contains_key(&OutputType::Object) ||
1079 outputs.outputs.contains_key(&OutputType::Exe)))
1081 let output_types = OutputTypes::new(&[(OutputType::Assembly, None)]);
1082 time(sess.time_passes(),
1084 || write::run_passes(sess, trans, &output_types, outputs));
1086 write::run_assembler(sess, outputs);
1088 // HACK the linker expects the object file to be named foo.0.o but
1089 // `run_assembler` produces an object named just foo.o. Rename it if we
1090 // are going to build an executable
1091 if sess.opts.output_types.contains_key(&OutputType::Exe) {
1092 let f = outputs.path(OutputType::Object);
1093 rename_or_copy_remove(&f,
1094 f.with_file_name(format!("{}.0.o",
1095 f.file_stem().unwrap().to_string_lossy()))).unwrap();
1098 // Remove assembly source, unless --save-temps was specified
1099 if !sess.opts.cg.save_temps {
1100 fs::remove_file(&outputs.temp_path(OutputType::Assembly, None)).unwrap();
1103 time(sess.time_passes(),
1105 || write::run_passes(sess, trans, &sess.opts.output_types, outputs));
1108 time(sess.time_passes(),
1109 "serialize work products",
1110 move || rustc_incremental::save_work_products(sess));
1112 if sess.err_count() > 0 {
1113 Err(sess.err_count())
1119 /// Run the linker on any artifacts that resulted from the LLVM run.
1120 /// This should produce either a finished executable or library.
1121 pub fn phase_6_link_output(sess: &Session,
1122 trans: &trans::CrateTranslation,
1123 outputs: &OutputFilenames) {
1124 time(sess.time_passes(),
1126 || link::link_binary(sess, trans, outputs, &trans.crate_name.as_str()));
1129 fn escape_dep_filename(filename: &str) -> String {
1130 // Apparently clang and gcc *only* escape spaces:
1131 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
1132 filename.replace(" ", "\\ ")
1135 fn write_out_deps(sess: &Session, outputs: &OutputFilenames, crate_name: &str) {
1136 let mut out_filenames = Vec::new();
1137 for output_type in sess.opts.output_types.keys() {
1138 let file = outputs.path(*output_type);
1139 match *output_type {
1140 OutputType::Exe => {
1141 for output in sess.crate_types.borrow().iter() {
1142 let p = link::filename_for_input(sess, *output, crate_name, outputs);
1143 out_filenames.push(p);
1147 out_filenames.push(file);
1152 // Write out dependency rules to the dep-info file if requested
1153 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
1156 let deps_filename = outputs.path(OutputType::DepInfo);
1159 (|| -> io::Result<()> {
1160 // Build a list of files used to compile the output and
1161 // write Makefile-compatible dependency rules
1162 let files: Vec<String> = sess.codemap()
1165 .filter(|fmap| fmap.is_real_file())
1166 .filter(|fmap| !fmap.is_imported())
1167 .map(|fmap| escape_dep_filename(&fmap.name))
1169 let mut file = fs::File::create(&deps_filename)?;
1170 for path in &out_filenames {
1171 write!(file, "{}: {}\n\n", path.display(), files.join(" "))?;
1174 // Emit a fake target for each input file to the compilation. This
1175 // prevents `make` from spitting out an error if a file is later
1176 // deleted. For more info see #28735
1178 writeln!(file, "{}:", path)?;
1186 sess.fatal(&format!("error writing dependencies to `{}`: {}",
1187 deps_filename.display(),
1193 pub fn collect_crate_types(session: &Session, attrs: &[ast::Attribute]) -> Vec<config::CrateType> {
1194 // Unconditionally collect crate types from attributes to make them used
1195 let attr_types: Vec<config::CrateType> =
1198 if a.check_name("crate_type") {
1199 match a.value_str() {
1200 Some(ref n) if *n == "rlib" => {
1201 Some(config::CrateTypeRlib)
1203 Some(ref n) if *n == "dylib" => {
1204 Some(config::CrateTypeDylib)
1206 Some(ref n) if *n == "cdylib" => {
1207 Some(config::CrateTypeCdylib)
1209 Some(ref n) if *n == "lib" => {
1210 Some(config::default_lib_output())
1212 Some(ref n) if *n == "staticlib" => {
1213 Some(config::CrateTypeStaticlib)
1215 Some(ref n) if *n == "proc-macro" => {
1216 Some(config::CrateTypeProcMacro)
1218 Some(ref n) if *n == "bin" => Some(config::CrateTypeExecutable),
1220 session.add_lint(lint::builtin::UNKNOWN_CRATE_TYPES,
1223 "invalid `crate_type` value".to_string());
1227 session.struct_span_err(a.span, "`crate_type` requires a value")
1228 .note("for example: `#![crate_type=\"lib\"]`")
1239 // If we're generating a test executable, then ignore all other output
1240 // styles at all other locations
1241 if session.opts.test {
1242 return vec![config::CrateTypeExecutable];
1245 // Only check command line flags if present. If no types are specified by
1246 // command line, then reuse the empty `base` Vec to hold the types that
1247 // will be found in crate attributes.
1248 let mut base = session.opts.crate_types.clone();
1249 if base.is_empty() {
1250 base.extend(attr_types);
1251 if base.is_empty() {
1252 base.push(link::default_output_for_target(session));
1259 .filter(|crate_type| {
1260 let res = !link::invalid_output_for_target(session, *crate_type);
1263 session.warn(&format!("dropping unsupported crate type `{}` for target `{}`",
1265 session.opts.target_triple));
1273 pub fn compute_crate_disambiguator(session: &Session) -> String {
1274 use std::hash::Hasher;
1276 // The crate_disambiguator is a 128 bit hash. The disambiguator is fed
1277 // into various other hashes quite a bit (symbol hashes, incr. comp. hashes,
1278 // debuginfo type IDs, etc), so we don't want it to be too wide. 128 bits
1279 // should still be safe enough to avoid collisions in practice.
1280 // FIXME(mw): It seems that the crate_disambiguator is used everywhere as
1281 // a hex-string instead of raw bytes. We should really use the
1282 // smaller representation.
1283 let mut hasher = StableHasher::<Fingerprint>::new();
1285 let mut metadata = session.opts.cg.metadata.clone();
1286 // We don't want the crate_disambiguator to dependent on the order
1287 // -C metadata arguments, so sort them:
1289 // Every distinct -C metadata value is only incorporated once:
1292 hasher.write(b"metadata");
1293 for s in &metadata {
1294 // Also incorporate the length of a metadata string, so that we generate
1295 // different values for `-Cmetadata=ab -Cmetadata=c` and
1296 // `-Cmetadata=a -Cmetadata=bc`
1297 hasher.write_usize(s.len());
1298 hasher.write(s.as_bytes());
1301 // If this is an executable, add a special suffix, so that we don't get
1302 // symbol conflicts when linking against a library of the same name.
1303 let is_exe = session.crate_types.borrow().contains(&config::CrateTypeExecutable);
1305 format!("{}{}", hasher.finish().to_hex(), if is_exe { "-exe" } else {""})
1308 pub fn build_output_filenames(input: &Input,
1309 odir: &Option<PathBuf>,
1310 ofile: &Option<PathBuf>,
1311 attrs: &[ast::Attribute],
1313 -> OutputFilenames {
1316 // "-" as input file will cause the parser to read from stdin so we
1317 // have to make up a name
1318 // We want to toss everything after the final '.'
1319 let dirpath = match *odir {
1320 Some(ref d) => d.clone(),
1321 None => PathBuf::new(),
1324 // If a crate name is present, we use it as the link name
1325 let stem = sess.opts
1328 .or_else(|| attr::find_crate_name(attrs).map(|n| n.to_string()))
1329 .unwrap_or(input.filestem());
1332 out_directory: dirpath,
1334 single_output_file: None,
1335 extra: sess.opts.cg.extra_filename.clone(),
1336 outputs: sess.opts.output_types.clone(),
1340 Some(ref out_file) => {
1341 let unnamed_output_types = sess.opts
1344 .filter(|a| a.is_none())
1346 let ofile = if unnamed_output_types > 1 {
1347 sess.warn("due to multiple output types requested, the explicitly specified \
1348 output file name will be adapted for each output type");
1351 Some(out_file.clone())
1354 sess.warn("ignoring --out-dir flag due to -o flag.");
1357 let cur_dir = Path::new("");
1360 out_directory: out_file.parent().unwrap_or(cur_dir).to_path_buf(),
1361 out_filestem: out_file.file_stem()
1362 .unwrap_or(OsStr::new(""))
1366 single_output_file: ofile,
1367 extra: sess.opts.cg.extra_filename.clone(),
1368 outputs: sess.opts.output_types.clone(),