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::dep_graph::DepGraph;
12 use rustc::hir::{self, map as hir_map};
13 use rustc::hir::lowering::lower_crate;
14 use rustc_data_structures::fingerprint::Fingerprint;
15 use rustc_data_structures::stable_hasher::StableHasher;
17 use rustc::session::{CompileResult, CrateDisambiguator, Session};
18 use rustc::session::CompileIncomplete;
19 use rustc::session::config::{self, Input, OutputFilenames, OutputType};
20 use rustc::session::search_paths::PathKind;
22 use rustc::middle::{self, reachable, resolve_lifetime, stability};
23 use rustc::middle::privacy::AccessLevels;
24 use rustc::ty::{self, AllArenas, Resolutions, TyCtxt};
26 use rustc::util::common::{install_panic_hook, time, ErrorReported};
27 use rustc::util::profiling::ProfileCategory;
28 use rustc_allocator as allocator;
29 use rustc_borrowck as borrowck;
30 use rustc_incremental;
31 use rustc_resolve::{MakeGlobMap, Resolver, ResolverArenas};
32 use rustc_metadata::creader::CrateLoader;
33 use rustc_metadata::cstore::{self, CStore};
35 use rustc_codegen_utils::codegen_backend::CodegenBackend;
36 use rustc_typeck as typeck;
38 use rustc_plugin::registry::Registry;
39 use rustc_plugin as plugin;
40 use rustc_passes::{self, ast_validation, hir_stats, loops, rvalue_promotion};
41 use super::Compilation;
47 use std::ffi::{OsStr, OsString};
49 use std::io::{self, Write};
51 use std::path::{Path, PathBuf};
52 use rustc_data_structures::sync::{self, Lrc, Lock};
54 use syntax::{self, ast, attr, diagnostics, visit};
55 use syntax::early_buffered_lints::BufferedEarlyLint;
56 use syntax::ext::base::ExtCtxt;
57 use syntax::fold::Folder;
58 use syntax::parse::{self, PResult};
59 use syntax::util::node_count::NodeCounter;
60 use syntax::util::lev_distance::find_best_match_for_name;
61 use syntax::symbol::Symbol;
62 use syntax_pos::{FileName, hygiene};
66 use pretty::ReplaceBodyWithLoop;
70 #[cfg(not(parallel_queries))]
71 pub fn spawn_thread_pool<F: FnOnce(config::Options) -> R + sync::Send, R: sync::Send>(
72 opts: config::Options,
75 ty::tls::GCX_PTR.set(&Lock::new(0), || {
80 #[cfg(parallel_queries)]
81 pub fn spawn_thread_pool<F: FnOnce(config::Options) -> R + sync::Send, R: sync::Send>(
82 opts: config::Options,
87 use rayon::{ThreadPoolBuilder, ThreadPool};
89 let gcx_ptr = &Lock::new(0);
91 let config = ThreadPoolBuilder::new()
92 .num_threads(Session::query_threads_from_opts(&opts))
93 .deadlock_handler(|| unsafe { ty::query::handle_deadlock() })
94 .stack_size(16 * 1024 * 1024);
96 let with_pool = move |pool: &ThreadPool| {
97 pool.install(move || f(opts))
100 syntax::GLOBALS.with(|syntax_globals| {
101 syntax_pos::GLOBALS.with(|syntax_pos_globals| {
102 // The main handler run for each Rayon worker thread and sets up
103 // the thread local rustc uses. syntax_globals and syntax_pos_globals are
104 // captured and set on the new threads. ty::tls::with_thread_locals sets up
105 // thread local callbacks from libsyntax
106 let main_handler = move |worker: &mut dyn FnMut()| {
107 syntax::GLOBALS.set(syntax_globals, || {
108 syntax_pos::GLOBALS.set(syntax_pos_globals, || {
109 ty::tls::with_thread_locals(|| {
110 ty::tls::GCX_PTR.set(gcx_ptr, || {
118 ThreadPool::scoped_pool(config, main_handler, with_pool).unwrap()
123 pub fn compile_input(
124 codegen_backend: Box<dyn CodegenBackend>,
127 input_path: &Option<PathBuf>,
129 outdir: &Option<PathBuf>,
130 output: &Option<PathBuf>,
131 addl_plugins: Option<Vec<String>>,
132 control: &CompileController,
134 macro_rules! controller_entry_point {
135 ($point: ident, $tsess: expr, $make_state: expr, $phase_result: expr) => {{
136 let state = &mut $make_state;
137 let phase_result: &CompileResult = &$phase_result;
138 if phase_result.is_ok() || control.$point.run_callback_on_error {
139 (control.$point.callback)(state);
142 if control.$point.stop == Compilation::Stop {
143 // FIXME: shouldn't this return Err(CompileIncomplete::Stopped)
144 // if there are no errors?
145 return $tsess.compile_status();
150 if sess.profile_queries() {
151 profile::begin(sess);
154 // We need nested scopes here, because the intermediate results can keep
155 // large chunks of memory alive and we want to free them as soon as
156 // possible to keep the peak memory usage low
157 let (outputs, ongoing_codegen, dep_graph) = {
158 let krate = match phase_1_parse_input(control, sess, input) {
160 Err(mut parse_error) => {
162 return Err(CompileIncomplete::Errored(ErrorReported));
166 let (krate, registry) = {
167 let mut compile_state =
168 CompileState::state_after_parse(input, sess, outdir, output, krate, &cstore);
169 controller_entry_point!(after_parse, sess, compile_state, Ok(()));
171 (compile_state.krate.unwrap(), compile_state.registry)
174 let outputs = build_output_filenames(input, outdir, output, &krate.attrs, sess);
176 ::rustc_codegen_utils::link::find_crate_name(Some(sess), &krate.attrs, input);
177 install_panic_hook();
179 let ExpansionResult {
186 phase_2_configure_and_expand(
193 control.make_glob_map,
195 let mut state = CompileState::state_after_expand(
204 controller_entry_point!(after_expand, sess, state, Ok(()));
210 let output_paths = generated_output_paths(sess, &outputs, output.is_some(), &crate_name);
212 // Ensure the source file isn't accidentally overwritten during compilation.
213 if let Some(ref input_path) = *input_path {
214 if sess.opts.will_create_output_file() {
215 if output_contains_path(&output_paths, input_path) {
217 "the input file \"{}\" would be overwritten by the generated \
221 return Err(CompileIncomplete::Stopped);
223 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
225 "the generated executable for the input file \"{}\" conflicts with the \
226 existing directory \"{}\"",
227 input_path.display(),
230 return Err(CompileIncomplete::Stopped);
235 write_out_deps(sess, &outputs, &output_paths);
236 if sess.opts.output_types.contains_key(&OutputType::DepInfo)
237 && sess.opts.output_types.len() == 1
242 if let &Some(ref dir) = outdir {
243 if fs::create_dir_all(dir).is_err() {
244 sess.err("failed to find or create the directory specified by --out-dir");
245 return Err(CompileIncomplete::Stopped);
249 let arenas = AllArenas::new();
251 // Construct the HIR map
252 let hir_map = time(sess, "indexing hir", || {
253 hir_map::map_crate(sess, cstore, &mut hir_forest, &defs)
257 hir_map.dep_graph.assert_ignored();
258 controller_entry_point!(
261 CompileState::state_after_hir_lowering(
280 let opt_crate = if control.keep_ast {
281 Some(&expanded_crate)
283 drop(expanded_crate);
287 phase_3_run_analysis_passes(
298 |tcx, analysis, rx, result| {
300 // Eventually, we will want to track plugins.
301 tcx.dep_graph.with_ignore(|| {
302 let mut state = CompileState::state_after_analysis(
313 (control.after_analysis.callback)(&mut state);
316 if control.after_analysis.stop == Compilation::Stop {
317 return result.and_then(|_| Err(CompileIncomplete::Stopped));
323 if log_enabled!(::log::Level::Info) {
324 println!("Pre-codegen");
325 tcx.print_debug_stats();
328 let ongoing_codegen = phase_4_codegen(&*codegen_backend, tcx, rx);
330 if log_enabled!(::log::Level::Info) {
331 println!("Post-codegen");
332 tcx.print_debug_stats();
335 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
336 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, &outputs) {
337 sess.err(&format!("could not emit MIR: {}", e));
338 sess.abort_if_errors();
342 Ok((outputs.clone(), ongoing_codegen, tcx.dep_graph.clone()))
347 if sess.opts.debugging_opts.print_type_sizes {
348 sess.code_stats.borrow().print_type_sizes();
351 codegen_backend.join_codegen_and_link(ongoing_codegen, sess, &dep_graph, &outputs)?;
353 if sess.opts.debugging_opts.perf_stats {
354 sess.print_perf_stats();
357 if sess.opts.debugging_opts.self_profile {
358 sess.print_profiler_results();
360 if sess.opts.debugging_opts.profile_json {
361 sess.save_json_results();
365 controller_entry_point!(
368 CompileState::state_when_compilation_done(input, sess, outdir, output),
375 pub fn source_name(input: &Input) -> FileName {
377 Input::File(ref ifile) => ifile.clone().into(),
378 Input::Str { ref name, .. } => name.clone(),
382 /// CompileController is used to customize compilation, it allows compilation to
383 /// be stopped and/or to call arbitrary code at various points in compilation.
384 /// It also allows for various flags to be set to influence what information gets
385 /// collected during compilation.
387 /// This is a somewhat higher level controller than a Session - the Session
388 /// controls what happens in each phase, whereas the CompileController controls
389 /// whether a phase is run at all and whether other code (from outside the
390 /// compiler) is run between phases.
392 /// Note that if compilation is set to stop and a callback is provided for a
393 /// given entry point, the callback is called before compilation is stopped.
395 /// Expect more entry points to be added in the future.
396 pub struct CompileController<'a> {
397 pub after_parse: PhaseController<'a>,
398 pub after_expand: PhaseController<'a>,
399 pub after_hir_lowering: PhaseController<'a>,
400 pub after_analysis: PhaseController<'a>,
401 pub compilation_done: PhaseController<'a>,
403 // FIXME we probably want to group the below options together and offer a
404 // better API, rather than this ad-hoc approach.
405 pub make_glob_map: MakeGlobMap,
406 // Whether the compiler should keep the ast beyond parsing.
408 // -Zcontinue-parse-after-error
409 pub continue_parse_after_error: bool,
411 /// Allows overriding default rustc query providers,
412 /// after `default_provide` has installed them.
413 pub provide: Box<dyn Fn(&mut ty::query::Providers) + 'a>,
414 /// Same as `provide`, but only for non-local crates,
415 /// applied after `default_provide_extern`.
416 pub provide_extern: Box<dyn Fn(&mut ty::query::Providers) + 'a>,
419 impl<'a> CompileController<'a> {
420 pub fn basic() -> CompileController<'a> {
422 after_parse: PhaseController::basic(),
423 after_expand: PhaseController::basic(),
424 after_hir_lowering: PhaseController::basic(),
425 after_analysis: PhaseController::basic(),
426 compilation_done: PhaseController::basic(),
427 make_glob_map: MakeGlobMap::No,
429 continue_parse_after_error: false,
431 provide_extern: box |_| {},
436 /// This implementation makes it easier to create a custom driver when you only want to hook
437 /// into callbacks from `CompileController`.
442 /// # extern crate rustc_driver;
443 /// # use rustc_driver::driver::CompileController;
444 /// let mut controller = CompileController::basic();
445 /// controller.after_analysis.callback = Box::new(move |_state| {});
446 /// rustc_driver::run_compiler(&[], Box::new(controller), None, None);
448 impl<'a> ::CompilerCalls<'a> for CompileController<'a> {
451 matches: &::getopts::Matches,
452 sopts: &config::Options,
453 cfg: &ast::CrateConfig,
454 descriptions: &::errors::registry::Registry,
455 output: ::ErrorOutputType,
457 ::RustcDefaultCalls.early_callback(
467 matches: &::getopts::Matches,
468 sopts: &config::Options,
469 cfg: &ast::CrateConfig,
470 odir: &Option<PathBuf>,
471 ofile: &Option<PathBuf>,
472 descriptions: &::errors::registry::Registry,
473 ) -> Option<(Input, Option<PathBuf>)> {
474 ::RustcDefaultCalls.no_input(
485 codegen_backend: &dyn (::CodegenBackend),
486 matches: &::getopts::Matches,
490 odir: &Option<PathBuf>,
491 ofile: &Option<PathBuf>,
494 .late_callback(codegen_backend, matches, sess, cstore, input, odir, ofile)
499 _: &::getopts::Matches
500 ) -> CompileController<'a> {
505 pub struct PhaseController<'a> {
506 pub stop: Compilation,
507 // If true then the compiler will try to run the callback even if the phase
508 // ends with an error. Note that this is not always possible.
509 pub run_callback_on_error: bool,
510 pub callback: Box<dyn Fn(&mut CompileState) + 'a>,
513 impl<'a> PhaseController<'a> {
514 pub fn basic() -> PhaseController<'a> {
516 stop: Compilation::Continue,
517 run_callback_on_error: false,
518 callback: box |_| {},
523 /// State that is passed to a callback. What state is available depends on when
524 /// during compilation the callback is made. See the various constructor methods
525 /// (`state_*`) in the impl to see which data is provided for any given entry point.
526 pub struct CompileState<'a, 'tcx: 'a> {
527 pub input: &'a Input,
528 pub session: &'tcx Session,
529 pub krate: Option<ast::Crate>,
530 pub registry: Option<Registry<'a>>,
531 pub cstore: Option<&'tcx CStore>,
532 pub crate_name: Option<&'a str>,
533 pub output_filenames: Option<&'a OutputFilenames>,
534 pub out_dir: Option<&'a Path>,
535 pub out_file: Option<&'a Path>,
536 pub arenas: Option<&'tcx AllArenas<'tcx>>,
537 pub expanded_crate: Option<&'a ast::Crate>,
538 pub hir_crate: Option<&'a hir::Crate>,
539 pub hir_map: Option<&'a hir_map::Map<'tcx>>,
540 pub resolutions: Option<&'a Resolutions>,
541 pub analysis: Option<&'a ty::CrateAnalysis>,
542 pub tcx: Option<TyCtxt<'a, 'tcx, 'tcx>>,
545 impl<'a, 'tcx> CompileState<'a, 'tcx> {
546 fn empty(input: &'a Input, session: &'tcx Session, out_dir: &'a Option<PathBuf>) -> Self {
550 out_dir: out_dir.as_ref().map(|s| &**s),
557 output_filenames: None,
558 expanded_crate: None,
567 fn state_after_parse(
569 session: &'tcx Session,
570 out_dir: &'a Option<PathBuf>,
571 out_file: &'a Option<PathBuf>,
573 cstore: &'tcx CStore,
576 // Initialize the registry before moving `krate`
577 registry: Some(Registry::new(&session, krate.span)),
579 cstore: Some(cstore),
580 out_file: out_file.as_ref().map(|s| &**s),
581 ..CompileState::empty(input, session, out_dir)
585 fn state_after_expand(
587 session: &'tcx Session,
588 out_dir: &'a Option<PathBuf>,
589 out_file: &'a Option<PathBuf>,
590 cstore: &'tcx CStore,
591 expanded_crate: &'a ast::Crate,
595 crate_name: Some(crate_name),
596 cstore: Some(cstore),
597 expanded_crate: Some(expanded_crate),
598 out_file: out_file.as_ref().map(|s| &**s),
599 ..CompileState::empty(input, session, out_dir)
603 fn state_after_hir_lowering(
605 session: &'tcx Session,
606 out_dir: &'a Option<PathBuf>,
607 out_file: &'a Option<PathBuf>,
608 arenas: &'tcx AllArenas<'tcx>,
609 cstore: &'tcx CStore,
610 hir_map: &'a hir_map::Map<'tcx>,
611 analysis: &'a ty::CrateAnalysis,
612 resolutions: &'a Resolutions,
613 krate: &'a ast::Crate,
614 hir_crate: &'a hir::Crate,
615 output_filenames: &'a OutputFilenames,
619 crate_name: Some(crate_name),
620 arenas: Some(arenas),
621 cstore: Some(cstore),
622 hir_map: Some(hir_map),
623 analysis: Some(analysis),
624 resolutions: Some(resolutions),
625 expanded_crate: Some(krate),
626 hir_crate: Some(hir_crate),
627 output_filenames: Some(output_filenames),
628 out_file: out_file.as_ref().map(|s| &**s),
629 ..CompileState::empty(input, session, out_dir)
633 fn state_after_analysis(
635 session: &'tcx Session,
636 out_dir: &'a Option<PathBuf>,
637 out_file: &'a Option<PathBuf>,
638 krate: Option<&'a ast::Crate>,
639 hir_crate: &'a hir::Crate,
640 analysis: &'a ty::CrateAnalysis,
641 tcx: TyCtxt<'a, 'tcx, 'tcx>,
645 analysis: Some(analysis),
647 expanded_crate: krate,
648 hir_crate: Some(hir_crate),
649 crate_name: Some(crate_name),
650 out_file: out_file.as_ref().map(|s| &**s),
651 ..CompileState::empty(input, session, out_dir)
655 fn state_when_compilation_done(
657 session: &'tcx Session,
658 out_dir: &'a Option<PathBuf>,
659 out_file: &'a Option<PathBuf>,
662 out_file: out_file.as_ref().map(|s| &**s),
663 ..CompileState::empty(input, session, out_dir)
668 pub fn phase_1_parse_input<'a>(
669 control: &CompileController,
672 ) -> PResult<'a, ast::Crate> {
674 .set_continue_after_error(control.continue_parse_after_error);
675 hygiene::set_default_edition(sess.edition());
677 if sess.profile_queries() {
678 profile::begin(sess);
681 sess.profiler(|p| p.start_activity(ProfileCategory::Parsing));
682 let krate = time(sess, "parsing", || match *input {
683 Input::File(ref file) => parse::parse_crate_from_file(file, &sess.parse_sess),
687 } => parse::parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess),
689 sess.profiler(|p| p.end_activity(ProfileCategory::Parsing));
691 sess.diagnostic().set_continue_after_error(true);
693 if sess.opts.debugging_opts.ast_json_noexpand {
694 println!("{}", json::as_json(&krate));
697 if sess.opts.debugging_opts.input_stats {
700 sess.source_map().count_lines()
702 println!("Pre-expansion node count: {}", count_nodes(&krate));
705 if let Some(ref s) = sess.opts.debugging_opts.show_span {
706 syntax::show_span::run(sess.diagnostic(), s, &krate);
709 if sess.opts.debugging_opts.hir_stats {
710 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
716 fn count_nodes(krate: &ast::Crate) -> usize {
717 let mut counter = NodeCounter::new();
718 visit::walk_crate(&mut counter, krate);
722 // For continuing compilation after a parsed crate has been
725 pub struct ExpansionResult {
726 pub expanded_crate: ast::Crate,
727 pub defs: hir_map::Definitions,
728 pub analysis: ty::CrateAnalysis,
729 pub resolutions: Resolutions,
730 pub hir_forest: hir_map::Forest,
733 pub struct InnerExpansionResult<'a, 'b: 'a> {
734 pub expanded_crate: ast::Crate,
735 pub resolver: Resolver<'a, 'b>,
736 pub hir_forest: hir_map::Forest,
739 /// Run the "early phases" of the compiler: initial `cfg` processing,
740 /// loading compiler plugins (including those from `addl_plugins`),
741 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
742 /// harness if one is to be provided, injection of a dependency on the
743 /// standard library and prelude, and name resolution.
745 /// Returns `None` if we're aborting after handling -W help.
746 pub fn phase_2_configure_and_expand<F>(
750 registry: Option<Registry>,
752 addl_plugins: Option<Vec<String>>,
753 make_glob_map: MakeGlobMap,
755 ) -> Result<ExpansionResult, CompileIncomplete>
757 F: FnOnce(&ast::Crate) -> CompileResult,
759 // Currently, we ignore the name resolution data structures for the purposes of dependency
760 // tracking. Instead we will run name resolution and include its output in the hash of each
761 // item, much like we do for macro expansion. In other words, the hash reflects not just
762 // its contents but the results of name resolution on those contents. Hopefully we'll push
763 // this back at some point.
764 let mut crate_loader = CrateLoader::new(sess, &cstore, &crate_name);
765 let resolver_arenas = Resolver::arenas();
766 let result = phase_2_configure_and_expand_inner(
779 Ok(InnerExpansionResult {
783 }) => Ok(ExpansionResult {
785 defs: resolver.definitions,
787 resolutions: Resolutions {
788 freevars: resolver.freevars,
789 export_map: resolver.export_map,
790 trait_map: resolver.trait_map,
791 maybe_unused_trait_imports: resolver.maybe_unused_trait_imports,
792 maybe_unused_extern_crates: resolver.maybe_unused_extern_crates,
795 analysis: ty::CrateAnalysis {
796 access_levels: Lrc::new(AccessLevels::default()),
797 name: crate_name.to_string(),
798 glob_map: if resolver.make_glob_map {
799 Some(resolver.glob_map)
809 /// Same as phase_2_configure_and_expand, but doesn't let you keep the resolver
811 pub fn phase_2_configure_and_expand_inner<'a, 'b: 'a, F>(
814 mut krate: ast::Crate,
815 registry: Option<Registry>,
817 addl_plugins: Option<Vec<String>>,
818 make_glob_map: MakeGlobMap,
819 resolver_arenas: &'a ResolverArenas<'a>,
820 crate_loader: &'a mut CrateLoader<'b>,
822 ) -> Result<InnerExpansionResult<'a, 'b>, CompileIncomplete>
824 F: FnOnce(&ast::Crate) -> CompileResult,
826 krate = time(sess, "attributes injection", || {
827 syntax::attr::inject(krate, &sess.parse_sess, &sess.opts.debugging_opts.crate_attr)
830 let (mut krate, features) = syntax::config::features(
835 // these need to be set "early" so that expansion sees `quote` if enabled.
836 sess.init_features(features);
838 let crate_types = collect_crate_types(sess, &krate.attrs);
839 sess.crate_types.set(crate_types);
841 let disambiguator = compute_crate_disambiguator(sess);
842 sess.crate_disambiguator.set(disambiguator);
843 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator);
845 if sess.opts.incremental.is_some() {
846 time(sess, "garbage collect incremental cache directory", || {
847 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
849 "Error while trying to garbage collect incremental \
850 compilation cache directory: {}",
857 // If necessary, compute the dependency graph (in the background).
858 let future_dep_graph = if sess.opts.build_dep_graph() {
859 Some(rustc_incremental::load_dep_graph(sess))
864 time(sess, "recursion limit", || {
865 middle::recursion_limit::update_limits(sess, &krate);
868 krate = time(sess, "crate injection", || {
869 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| &**s);
870 syntax::std_inject::maybe_inject_crates_ref(krate, alt_std_name, sess.edition())
873 let mut addl_plugins = Some(addl_plugins);
874 let registrars = time(sess, "plugin loading", || {
875 plugin::load::load_plugins(
880 addl_plugins.take().unwrap(),
884 let mut registry = registry.unwrap_or(Registry::new(sess, krate.span));
886 time(sess, "plugin registration", || {
887 if sess.features_untracked().rustc_diagnostic_macros {
888 registry.register_macro(
890 diagnostics::plugin::expand_diagnostic_used,
892 registry.register_macro(
893 "__register_diagnostic",
894 diagnostics::plugin::expand_register_diagnostic,
896 registry.register_macro(
897 "__build_diagnostic_array",
898 diagnostics::plugin::expand_build_diagnostic_array,
902 for registrar in registrars {
903 registry.args_hidden = Some(registrar.args);
904 (registrar.fun)(&mut registry);
908 let whitelisted_legacy_custom_derives = registry.take_whitelisted_custom_derives();
919 sess.track_errors(|| {
920 let mut ls = sess.lint_store.borrow_mut();
921 for pass in early_lint_passes {
922 ls.register_early_pass(Some(sess), true, pass);
924 for pass in late_lint_passes {
925 ls.register_late_pass(Some(sess), true, pass);
928 for (name, (to, deprecated_name)) in lint_groups {
929 ls.register_group(Some(sess), true, name, deprecated_name, to);
932 *sess.plugin_llvm_passes.borrow_mut() = llvm_passes;
933 *sess.plugin_attributes.borrow_mut() = attributes.clone();
936 // Lint plugins are registered; now we can process command line flags.
937 if sess.opts.describe_lints {
938 super::describe_lints(&sess, &sess.lint_store.borrow(), true);
939 return Err(CompileIncomplete::Stopped);
942 time(sess, "pre ast expansion lint checks", || {
943 lint::check_ast_crate(sess, &krate, true)
946 let mut resolver = Resolver::new(
955 resolver.whitelisted_legacy_custom_derives = whitelisted_legacy_custom_derives;
956 syntax_ext::register_builtins(&mut resolver, syntax_exts, sess.features_untracked().quote);
959 sess.profiler(|p| p.start_activity(ProfileCategory::Expansion));
960 krate = time(sess, "expansion", || {
961 // Windows dlls do not have rpaths, so they don't know how to find their
962 // dependencies. It's up to us to tell the system where to find all the
963 // dependent dlls. Note that this uses cfg!(windows) as opposed to
964 // targ_cfg because syntax extensions are always loaded for the host
965 // compiler, not for the target.
967 // This is somewhat of an inherently racy operation, however, as
968 // multiple threads calling this function could possibly continue
969 // extending PATH far beyond what it should. To solve this for now we
970 // just don't add any new elements to PATH which are already there
971 // within PATH. This is basically a targeted fix at #17360 for rustdoc
972 // which runs rustc in parallel but has been seen (#33844) to cause
973 // problems with PATH becoming too long.
974 let mut old_path = OsString::new();
976 old_path = env::var_os("PATH").unwrap_or(old_path);
977 let mut new_path = sess.host_filesearch(PathKind::All).get_dylib_search_paths();
978 for path in env::split_paths(&old_path) {
979 if !new_path.contains(&path) {
988 .filter(|p| env::join_paths(iter::once(p)).is_ok()),
993 // Create the config for macro expansion
994 let features = sess.features_untracked();
995 let cfg = syntax::ext::expand::ExpansionConfig {
996 features: Some(&features),
997 recursion_limit: *sess.recursion_limit.get(),
998 trace_mac: sess.opts.debugging_opts.trace_macros,
999 should_test: sess.opts.test,
1000 ..syntax::ext::expand::ExpansionConfig::default(crate_name.to_string())
1003 let mut ecx = ExtCtxt::new(&sess.parse_sess, cfg, &mut resolver);
1004 let err_count = ecx.parse_sess.span_diagnostic.err_count();
1006 // Expand macros now!
1007 let krate = time(sess, "expand crate", || {
1008 ecx.monotonic_expander().expand_crate(krate)
1011 // The rest is error reporting
1013 time(sess, "check unused macros", || {
1014 ecx.check_unused_macros();
1017 let mut missing_fragment_specifiers: Vec<_> = ecx.parse_sess
1018 .missing_fragment_specifiers
1023 missing_fragment_specifiers.sort();
1024 for span in missing_fragment_specifiers {
1025 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
1026 let msg = "missing fragment specifier";
1027 sess.buffer_lint(lint, ast::CRATE_NODE_ID, span, msg);
1029 if ecx.parse_sess.span_diagnostic.err_count() - ecx.resolve_err_count > err_count {
1030 ecx.parse_sess.span_diagnostic.abort_if_errors();
1033 env::set_var("PATH", &old_path);
1037 sess.profiler(|p| p.end_activity(ProfileCategory::Expansion));
1039 krate = time(sess, "maybe building test harness", || {
1040 syntax::test::modify_for_testing(
1046 &sess.features_untracked(),
1050 // If we're actually rustdoc then there's no need to actually compile
1051 // anything, so switch everything to just looping
1052 if sess.opts.actually_rustdoc {
1053 krate = ReplaceBodyWithLoop::new(sess).fold_crate(krate);
1056 // If we're in rustdoc we're always compiling as an rlib, but that'll trip a
1057 // bunch of checks in the `modify` function below. For now just skip this
1058 // step entirely if we're rustdoc as it's not too useful anyway.
1059 if !sess.opts.actually_rustdoc {
1060 krate = time(sess, "maybe creating a macro crate", || {
1061 let crate_types = sess.crate_types.borrow();
1062 let num_crate_types = crate_types.len();
1063 let is_proc_macro_crate = crate_types.contains(&config::CrateType::ProcMacro);
1064 let is_test_crate = sess.opts.test;
1065 syntax_ext::proc_macro_registrar::modify(
1069 is_proc_macro_crate,
1077 // Expand global allocators, which are treated as an in-tree proc macro
1078 krate = time(sess, "creating allocators", || {
1079 allocator::expand::modify(
1083 crate_name.to_string(),
1088 // Add all buffered lints from the `ParseSess` to the `Session`.
1089 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
1090 info!("{} parse sess buffered_lints", buffered_lints.len());
1091 for BufferedEarlyLint{id, span, msg, lint_id} in buffered_lints.drain(..) {
1092 let lint = lint::Lint::from_parser_lint_id(lint_id);
1093 sess.buffer_lint(lint, id, span, &msg);
1097 // Done with macro expansion!
1099 after_expand(&krate)?;
1101 if sess.opts.debugging_opts.input_stats {
1102 println!("Post-expansion node count: {}", count_nodes(&krate));
1105 if sess.opts.debugging_opts.hir_stats {
1106 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
1109 if sess.opts.debugging_opts.ast_json {
1110 println!("{}", json::as_json(&krate));
1113 time(sess, "AST validation", || {
1114 ast_validation::check_crate(sess, &krate)
1117 time(sess, "name resolution", || -> CompileResult {
1118 resolver.resolve_crate(&krate);
1122 // Needs to go *after* expansion to be able to check the results of macro expansion.
1123 time(sess, "complete gated feature checking", || {
1124 sess.track_errors(|| {
1125 syntax::feature_gate::check_crate(
1128 &sess.features_untracked(),
1130 sess.opts.unstable_features,
1135 // Unresolved macros might be due to mistyped `#[macro_use]`,
1136 // so abort after checking for unknown attributes. (#49074)
1137 if resolver.found_unresolved_macro {
1138 sess.diagnostic().abort_if_errors();
1141 // Lower ast -> hir.
1142 // First, we need to collect the dep_graph.
1143 let dep_graph = match future_dep_graph {
1144 None => DepGraph::new_disabled(),
1146 let (prev_graph, prev_work_products) =
1147 time(sess, "blocked while dep-graph loading finishes", || {
1150 .unwrap_or_else(|e| rustc_incremental::LoadResult::Error {
1151 message: format!("could not decode incremental cache: {:?}", e),
1155 DepGraph::new(prev_graph, prev_work_products)
1158 let hir_forest = time(sess, "lowering ast -> hir", || {
1159 let hir_crate = lower_crate(sess, cstore, &dep_graph, &krate, &mut resolver);
1161 if sess.opts.debugging_opts.hir_stats {
1162 hir_stats::print_hir_stats(&hir_crate);
1165 hir_map::Forest::new(hir_crate, &dep_graph)
1168 time(sess, "early lint checks", || {
1169 lint::check_ast_crate(sess, &krate, false)
1172 // Discard hygiene data, which isn't required after lowering to HIR.
1173 if !sess.opts.debugging_opts.keep_hygiene_data {
1174 syntax::ext::hygiene::clear_markings();
1177 Ok(InnerExpansionResult {
1178 expanded_crate: krate,
1184 pub fn default_provide(providers: &mut ty::query::Providers) {
1185 hir::provide(providers);
1186 borrowck::provide(providers);
1187 mir::provide(providers);
1188 reachable::provide(providers);
1189 resolve_lifetime::provide(providers);
1190 rustc_privacy::provide(providers);
1191 typeck::provide(providers);
1192 ty::provide(providers);
1193 traits::provide(providers);
1194 reachable::provide(providers);
1195 rustc_passes::provide(providers);
1196 rustc_traits::provide(providers);
1197 middle::region::provide(providers);
1198 cstore::provide(providers);
1199 lint::provide(providers);
1202 pub fn default_provide_extern(providers: &mut ty::query::Providers) {
1203 cstore::provide_extern(providers);
1206 /// Run the resolution, typechecking, region checking and other
1207 /// miscellaneous analysis passes on the crate. Return various
1208 /// structures carrying the results of the analysis.
1209 pub fn phase_3_run_analysis_passes<'tcx, F, R>(
1210 codegen_backend: &dyn CodegenBackend,
1211 control: &CompileController,
1212 sess: &'tcx Session,
1213 cstore: &'tcx CStore,
1214 hir_map: hir_map::Map<'tcx>,
1215 mut analysis: ty::CrateAnalysis,
1216 resolutions: Resolutions,
1217 arenas: &'tcx AllArenas<'tcx>,
1219 output_filenames: &OutputFilenames,
1221 ) -> Result<R, CompileIncomplete>
1224 TyCtxt<'a, 'tcx, 'tcx>,
1226 mpsc::Receiver<Box<dyn Any + Send>>,
1230 let query_result_on_disk_cache = time(sess, "load query result cache", || {
1231 rustc_incremental::load_query_result_cache(sess)
1234 time(sess, "looking for entry point", || {
1235 middle::entry::find_entry_point(sess, &hir_map, name)
1238 sess.plugin_registrar_fn
1239 .set(time(sess, "looking for plugin registrar", || {
1240 plugin::build::find_plugin_registrar(sess.diagnostic(), &hir_map)
1242 sess.derive_registrar_fn
1243 .set(derive_registrar::find(&hir_map));
1245 time(sess, "loop checking", || loops::check_crate(sess, &hir_map));
1247 let mut local_providers = ty::query::Providers::default();
1248 default_provide(&mut local_providers);
1249 codegen_backend.provide(&mut local_providers);
1250 (control.provide)(&mut local_providers);
1252 let mut extern_providers = local_providers;
1253 default_provide_extern(&mut extern_providers);
1254 codegen_backend.provide_extern(&mut extern_providers);
1255 (control.provide_extern)(&mut extern_providers);
1257 let (tx, rx) = mpsc::channel();
1259 TyCtxt::create_and_enter(
1267 query_result_on_disk_cache,
1272 // Do some initialization of the DepGraph that can only be done with the
1274 rustc_incremental::dep_graph_tcx_init(tcx);
1276 time(sess, "attribute checking", || {
1277 hir::check_attr::check_crate(tcx)
1280 time(sess, "stability checking", || {
1281 stability::check_unstable_api_usage(tcx)
1284 // passes are timed inside typeck
1285 match typeck::check_crate(tcx) {
1288 f(tcx, analysis, rx, Err(x));
1293 time(sess, "rvalue promotion", || {
1294 rvalue_promotion::check_crate(tcx)
1297 analysis.access_levels =
1298 time(sess, "privacy checking", || rustc_privacy::check_crate(tcx));
1300 time(sess, "intrinsic checking", || {
1301 middle::intrinsicck::check_crate(tcx)
1304 time(sess, "match checking", || mir::matchck_crate(tcx));
1306 // this must run before MIR dump, because
1307 // "not all control paths return a value" is reported here.
1309 // maybe move the check to a MIR pass?
1310 time(sess, "liveness checking", || {
1311 middle::liveness::check_crate(tcx)
1314 time(sess, "borrow checking", || {
1315 if tcx.use_ast_borrowck() {
1316 borrowck::check_crate(tcx);
1321 "MIR borrow checking",
1322 || tcx.par_body_owners(|def_id| { tcx.mir_borrowck(def_id); }));
1324 time(sess, "dumping chalk-like clauses", || {
1325 rustc_traits::lowering::dump_program_clauses(tcx);
1328 time(sess, "MIR effect checking", || {
1329 for def_id in tcx.body_owners() {
1330 mir::transform::check_unsafety::check_unsafety(tcx, def_id)
1333 // Avoid overwhelming user with errors if type checking failed.
1334 // I'm not sure how helpful this is, to be honest, but it avoids
1336 // lot of annoying errors in the compile-fail tests (basically,
1337 // lint warnings and so on -- kindck used to do this abort, but
1338 // kindck is gone now). -nmatsakis
1339 if sess.err_count() > 0 {
1340 return Ok(f(tcx, analysis, rx, sess.compile_status()));
1343 time(sess, "death checking", || middle::dead::check_crate(tcx));
1345 time(sess, "unused lib feature checking", || {
1346 stability::check_unused_or_stable_features(tcx)
1349 time(sess, "lint checking", || lint::check_crate(tcx));
1351 return Ok(f(tcx, analysis, rx, tcx.sess.compile_status()));
1356 /// Run the codegen backend, after which the AST and analysis can
1358 pub fn phase_4_codegen<'a, 'tcx>(
1359 codegen_backend: &dyn CodegenBackend,
1360 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1361 rx: mpsc::Receiver<Box<dyn Any + Send>>,
1363 time(tcx.sess, "resolving dependency formats", || {
1364 ::rustc::middle::dependency_format::calculate(tcx)
1367 tcx.sess.profiler(|p| p.start_activity(ProfileCategory::Codegen));
1368 let codegen = time(tcx.sess, "codegen", move || codegen_backend.codegen_crate(tcx, rx));
1369 tcx.sess.profiler(|p| p.end_activity(ProfileCategory::Codegen));
1370 if tcx.sess.profile_queries() {
1371 profile::dump(&tcx.sess, "profile_queries".to_string())
1377 fn escape_dep_filename(filename: &FileName) -> String {
1378 // Apparently clang and gcc *only* escape spaces:
1379 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
1380 filename.to_string().replace(" ", "\\ ")
1383 // Returns all the paths that correspond to generated files.
1384 fn generated_output_paths(
1386 outputs: &OutputFilenames,
1390 let mut out_filenames = Vec::new();
1391 for output_type in sess.opts.output_types.keys() {
1392 let file = outputs.path(*output_type);
1393 match *output_type {
1394 // If the filename has been overridden using `-o`, it will not be modified
1395 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
1396 OutputType::Exe if !exact_name => for crate_type in sess.crate_types.borrow().iter() {
1397 let p = ::rustc_codegen_utils::link::filename_for_input(
1403 out_filenames.push(p);
1405 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
1406 // Don't add the dep-info output when omitting it from dep-info targets
1409 out_filenames.push(file);
1416 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
1417 // returns None for every file path.
1418 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
1420 F: Fn(&PathBuf) -> Option<T>,
1422 for output_path in output_paths {
1423 if let Some(result) = f(output_path) {
1424 return Some(result);
1430 pub fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
1431 let input_path = input_path.canonicalize().ok();
1432 if input_path.is_none() {
1435 let check = |output_path: &PathBuf| {
1436 if output_path.canonicalize().ok() == input_path {
1442 check_output(output_paths, check).is_some()
1445 pub fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
1446 let check = |output_path: &PathBuf| {
1447 if output_path.is_dir() {
1448 Some(output_path.clone())
1453 check_output(output_paths, check)
1456 fn write_out_deps(sess: &Session, outputs: &OutputFilenames, out_filenames: &[PathBuf]) {
1457 // Write out dependency rules to the dep-info file if requested
1458 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
1461 let deps_filename = outputs.path(OutputType::DepInfo);
1463 let result = (|| -> io::Result<()> {
1464 // Build a list of files used to compile the output and
1465 // write Makefile-compatible dependency rules
1466 let files: Vec<String> = sess.source_map()
1469 .filter(|fmap| fmap.is_real_file())
1470 .filter(|fmap| !fmap.is_imported())
1471 .map(|fmap| escape_dep_filename(&fmap.name))
1473 let mut file = fs::File::create(&deps_filename)?;
1474 for path in out_filenames {
1475 write!(file, "{}: {}\n\n", path.display(), files.join(" "))?;
1478 // Emit a fake target for each input file to the compilation. This
1479 // prevents `make` from spitting out an error if a file is later
1480 // deleted. For more info see #28735
1482 writeln!(file, "{}:", path)?;
1490 sess.fatal(&format!(
1491 "error writing dependencies to `{}`: {}",
1492 deps_filename.display(),
1499 pub fn collect_crate_types(session: &Session, attrs: &[ast::Attribute]) -> Vec<config::CrateType> {
1500 // Unconditionally collect crate types from attributes to make them used
1501 let attr_types: Vec<config::CrateType> = attrs
1504 if a.check_name("crate_type") {
1505 match a.value_str() {
1506 Some(ref n) if *n == "rlib" => Some(config::CrateType::Rlib),
1507 Some(ref n) if *n == "dylib" => Some(config::CrateType::Dylib),
1508 Some(ref n) if *n == "cdylib" => Some(config::CrateType::Cdylib),
1509 Some(ref n) if *n == "lib" => Some(config::default_lib_output()),
1510 Some(ref n) if *n == "staticlib" => Some(config::CrateType::Staticlib),
1511 Some(ref n) if *n == "proc-macro" => Some(config::CrateType::ProcMacro),
1512 Some(ref n) if *n == "bin" => Some(config::CrateType::Executable),
1514 let crate_types = vec![
1515 Symbol::intern("rlib"),
1516 Symbol::intern("dylib"),
1517 Symbol::intern("cdylib"),
1518 Symbol::intern("lib"),
1519 Symbol::intern("staticlib"),
1520 Symbol::intern("proc-macro"),
1521 Symbol::intern("bin")
1523 if let ast::MetaItemKind::NameValue(spanned) = a.meta().unwrap().node {
1524 let span = spanned.span;
1525 let lev_candidate = find_best_match_for_name(
1530 if let Some(candidate) = lev_candidate {
1531 session.buffer_lint_with_diagnostic(
1532 lint::builtin::UNKNOWN_CRATE_TYPES,
1535 "invalid `crate_type` value",
1536 lint::builtin::BuiltinLintDiagnostics::
1539 "did you mean".to_string(),
1540 format!("\"{}\"", candidate)
1544 session.buffer_lint(
1545 lint::builtin::UNKNOWN_CRATE_TYPES,
1548 "invalid `crate_type` value"
1556 .struct_span_err(a.span, "`crate_type` requires a value")
1557 .note("for example: `#![crate_type=\"lib\"]`")
1568 // If we're generating a test executable, then ignore all other output
1569 // styles at all other locations
1570 if session.opts.test {
1571 return vec![config::CrateType::Executable];
1574 // Only check command line flags if present. If no types are specified by
1575 // command line, then reuse the empty `base` Vec to hold the types that
1576 // will be found in crate attributes.
1577 let mut base = session.opts.crate_types.clone();
1578 if base.is_empty() {
1579 base.extend(attr_types);
1580 if base.is_empty() {
1581 base.push(::rustc_codegen_utils::link::default_output_for_target(
1590 .filter(|crate_type| {
1591 let res = !::rustc_codegen_utils::link::invalid_output_for_target(session, *crate_type);
1594 session.warn(&format!(
1595 "dropping unsupported crate type `{}` for target `{}`",
1596 *crate_type, session.opts.target_triple
1605 pub fn compute_crate_disambiguator(session: &Session) -> CrateDisambiguator {
1606 use std::hash::Hasher;
1608 // The crate_disambiguator is a 128 bit hash. The disambiguator is fed
1609 // into various other hashes quite a bit (symbol hashes, incr. comp. hashes,
1610 // debuginfo type IDs, etc), so we don't want it to be too wide. 128 bits
1611 // should still be safe enough to avoid collisions in practice.
1612 let mut hasher = StableHasher::<Fingerprint>::new();
1614 let mut metadata = session.opts.cg.metadata.clone();
1615 // We don't want the crate_disambiguator to dependent on the order
1616 // -C metadata arguments, so sort them:
1618 // Every distinct -C metadata value is only incorporated once:
1621 hasher.write(b"metadata");
1622 for s in &metadata {
1623 // Also incorporate the length of a metadata string, so that we generate
1624 // different values for `-Cmetadata=ab -Cmetadata=c` and
1625 // `-Cmetadata=a -Cmetadata=bc`
1626 hasher.write_usize(s.len());
1627 hasher.write(s.as_bytes());
1630 // Also incorporate crate type, so that we don't get symbol conflicts when
1631 // linking against a library of the same name, if this is an executable.
1632 let is_exe = session
1635 .contains(&config::CrateType::Executable);
1636 hasher.write(if is_exe { b"exe" } else { b"lib" });
1638 CrateDisambiguator::from(hasher.finish())
1641 pub fn build_output_filenames(
1643 odir: &Option<PathBuf>,
1644 ofile: &Option<PathBuf>,
1645 attrs: &[ast::Attribute],
1647 ) -> OutputFilenames {
1650 // "-" as input file will cause the parser to read from stdin so we
1651 // have to make up a name
1652 // We want to toss everything after the final '.'
1653 let dirpath = match *odir {
1654 Some(ref d) => d.clone(),
1655 None => PathBuf::new(),
1658 // If a crate name is present, we use it as the link name
1659 let stem = sess.opts
1662 .or_else(|| attr::find_crate_name(attrs).map(|n| n.to_string()))
1663 .unwrap_or(input.filestem());
1666 out_directory: dirpath,
1668 single_output_file: None,
1669 extra: sess.opts.cg.extra_filename.clone(),
1670 outputs: sess.opts.output_types.clone(),
1674 Some(ref out_file) => {
1675 let unnamed_output_types = sess.opts
1678 .filter(|a| a.is_none())
1680 let ofile = if unnamed_output_types > 1 {
1682 "due to multiple output types requested, the explicitly specified \
1683 output file name will be adapted for each output type",
1687 Some(out_file.clone())
1690 sess.warn("ignoring --out-dir flag due to -o flag");
1692 if !sess.opts.cg.extra_filename.is_empty() {
1693 sess.warn("ignoring -C extra-filename flag due to -o flag");
1696 let cur_dir = Path::new("");
1699 out_directory: out_file.parent().unwrap_or(cur_dir).to_path_buf(),
1700 out_filestem: out_file
1702 .unwrap_or(OsStr::new(""))
1706 single_output_file: ofile,
1707 extra: sess.opts.cg.extra_filename.clone(),
1708 outputs: sess.opts.output_types.clone(),