1 use rustc::dep_graph::DepGraph;
3 use rustc::hir::lowering::lower_crate;
4 use rustc::hir::map as hir_map;
6 use rustc::middle::{self, reachable, resolve_lifetime, stability};
7 use rustc::ty::{self, AllArenas, Resolutions, TyCtxt};
9 use rustc::util::common::{install_panic_hook, time, ErrorReported};
10 use rustc::util::profiling::ProfileCategory;
11 use rustc::session::{CompileResult, CrateDisambiguator, Session};
12 use rustc::session::CompileIncomplete;
13 use rustc::session::config::{self, Input, OutputFilenames, OutputType};
14 use rustc::session::search_paths::PathKind;
15 use rustc_allocator as allocator;
16 use rustc_borrowck as borrowck;
17 use rustc_codegen_utils::codegen_backend::CodegenBackend;
18 use rustc_data_structures::fingerprint::Fingerprint;
19 use rustc_data_structures::stable_hasher::StableHasher;
20 use rustc_data_structures::sync::{self, Lock};
21 use rustc_incremental;
22 use rustc_metadata::creader::CrateLoader;
23 use rustc_metadata::cstore::{self, CStore};
25 use rustc_passes::{self, ast_validation, hir_stats, loops, rvalue_promotion};
26 use rustc_plugin as plugin;
27 use rustc_plugin::registry::Registry;
29 use rustc_resolve::{MakeGlobMap, Resolver, ResolverArenas};
31 use rustc_typeck as typeck;
32 use syntax::{self, ast, attr, diagnostics, visit};
33 use syntax::early_buffered_lints::BufferedEarlyLint;
34 use syntax::ext::base::ExtCtxt;
35 use syntax::fold::Folder;
36 use syntax::parse::{self, PResult};
37 use syntax::util::node_count::NodeCounter;
38 use syntax::util::lev_distance::find_best_match_for_name;
39 use syntax::symbol::Symbol;
40 use syntax_pos::{FileName, hygiene};
47 use std::ffi::OsString;
49 use std::io::{self, Write};
51 use std::path::{Path, PathBuf};
54 use pretty::ReplaceBodyWithLoop;
57 use super::Compilation;
59 #[cfg(not(parallel_queries))]
60 pub fn spawn_thread_pool<F: FnOnce(config::Options) -> R + sync::Send, R: sync::Send>(
61 opts: config::Options,
64 ty::tls::GCX_PTR.set(&Lock::new(0), || {
69 #[cfg(parallel_queries)]
70 pub fn spawn_thread_pool<F: FnOnce(config::Options) -> R + sync::Send, R: sync::Send>(
71 opts: config::Options,
76 use rayon::{ThreadPoolBuilder, ThreadPool};
78 let gcx_ptr = &Lock::new(0);
80 let config = ThreadPoolBuilder::new()
81 .num_threads(Session::query_threads_from_opts(&opts))
82 .deadlock_handler(|| unsafe { ty::query::handle_deadlock() })
83 .stack_size(::STACK_SIZE);
85 let with_pool = move |pool: &ThreadPool| {
86 pool.install(move || f(opts))
89 syntax::GLOBALS.with(|syntax_globals| {
90 syntax_pos::GLOBALS.with(|syntax_pos_globals| {
91 // The main handler run for each Rayon worker thread and sets up
92 // the thread local rustc uses. syntax_globals and syntax_pos_globals are
93 // captured and set on the new threads. ty::tls::with_thread_locals sets up
94 // thread local callbacks from libsyntax
95 let main_handler = move |worker: &mut dyn FnMut()| {
96 syntax::GLOBALS.set(syntax_globals, || {
97 syntax_pos::GLOBALS.set(syntax_pos_globals, || {
98 ty::tls::with_thread_locals(|| {
99 ty::tls::GCX_PTR.set(gcx_ptr, || {
107 ThreadPool::scoped_pool(config, main_handler, with_pool).unwrap()
112 pub fn compile_input(
113 codegen_backend: Box<dyn CodegenBackend>,
116 input_path: &Option<PathBuf>,
118 outdir: &Option<PathBuf>,
119 output: &Option<PathBuf>,
120 addl_plugins: Option<Vec<String>>,
121 control: &CompileController,
123 macro_rules! controller_entry_point {
124 ($point: ident, $tsess: expr, $make_state: expr, $phase_result: expr) => {{
125 let state = &mut $make_state;
126 let phase_result: &CompileResult = &$phase_result;
127 if phase_result.is_ok() || control.$point.run_callback_on_error {
128 (control.$point.callback)(state);
131 if control.$point.stop == Compilation::Stop {
132 // FIXME: shouldn't this return Err(CompileIncomplete::Stopped)
133 // if there are no errors?
134 return $tsess.compile_status();
139 if sess.profile_queries() {
140 profile::begin(sess);
143 // We need nested scopes here, because the intermediate results can keep
144 // large chunks of memory alive and we want to free them as soon as
145 // possible to keep the peak memory usage low
146 let (outputs, ongoing_codegen, dep_graph) = {
147 let krate = match phase_1_parse_input(control, sess, input) {
149 Err(mut parse_error) => {
151 return Err(CompileIncomplete::Errored(ErrorReported));
155 let (krate, registry) = {
156 let mut compile_state =
157 CompileState::state_after_parse(input, sess, outdir, output, krate, &cstore);
158 controller_entry_point!(after_parse, sess, compile_state, Ok(()));
160 (compile_state.krate.unwrap(), compile_state.registry)
163 let outputs = build_output_filenames(input, outdir, output, &krate.attrs, sess);
165 ::rustc_codegen_utils::link::find_crate_name(Some(sess), &krate.attrs, input);
166 install_panic_hook();
168 let ExpansionResult {
175 phase_2_configure_and_expand(
182 control.make_glob_map,
184 let mut state = CompileState::state_after_expand(
193 controller_entry_point!(after_expand, sess, state, Ok(()));
199 let output_paths = generated_output_paths(sess, &outputs, output.is_some(), &crate_name);
201 // Ensure the source file isn't accidentally overwritten during compilation.
202 if let Some(ref input_path) = *input_path {
203 if sess.opts.will_create_output_file() {
204 if output_contains_path(&output_paths, input_path) {
206 "the input file \"{}\" would be overwritten by the generated \
210 return Err(CompileIncomplete::Stopped);
212 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
214 "the generated executable for the input file \"{}\" conflicts with the \
215 existing directory \"{}\"",
216 input_path.display(),
219 return Err(CompileIncomplete::Stopped);
224 write_out_deps(sess, &outputs, &output_paths);
225 if sess.opts.output_types.contains_key(&OutputType::DepInfo)
226 && sess.opts.output_types.len() == 1
231 if let &Some(ref dir) = outdir {
232 if fs::create_dir_all(dir).is_err() {
233 sess.err("failed to find or create the directory specified by --out-dir");
234 return Err(CompileIncomplete::Stopped);
238 // Construct the HIR map
239 let hir_map = time(sess, "indexing hir", || {
240 hir_map::map_crate(sess, cstore, &mut hir_forest, &defs)
244 hir_map.dep_graph.assert_ignored();
245 controller_entry_point!(
248 CompileState::state_after_hir_lowering(
266 let opt_crate = if control.keep_ast {
267 Some(&expanded_crate)
269 drop(expanded_crate);
273 let mut arenas = AllArenas::new();
275 phase_3_run_analysis_passes(
286 |tcx, analysis, rx, result| {
288 // Eventually, we will want to track plugins.
289 tcx.dep_graph.with_ignore(|| {
290 let mut state = CompileState::state_after_analysis(
301 (control.after_analysis.callback)(&mut state);
304 if control.after_analysis.stop == Compilation::Stop {
305 return result.and_then(|_| Err(CompileIncomplete::Stopped));
311 if log_enabled!(::log::Level::Info) {
312 println!("Pre-codegen");
313 tcx.print_debug_stats();
316 let ongoing_codegen = phase_4_codegen(&*codegen_backend, tcx, rx);
318 if log_enabled!(::log::Level::Info) {
319 println!("Post-codegen");
320 tcx.print_debug_stats();
323 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
324 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, &outputs) {
325 sess.err(&format!("could not emit MIR: {}", e));
326 sess.abort_if_errors();
330 if tcx.sess.opts.debugging_opts.query_stats {
331 tcx.queries.print_stats();
334 Ok((outputs.clone(), ongoing_codegen, tcx.dep_graph.clone()))
339 if sess.opts.debugging_opts.print_type_sizes {
340 sess.code_stats.borrow().print_type_sizes();
343 codegen_backend.join_codegen_and_link(ongoing_codegen, sess, &dep_graph, &outputs)?;
345 if sess.opts.debugging_opts.perf_stats {
346 sess.print_perf_stats();
349 if sess.opts.debugging_opts.self_profile {
350 sess.print_profiler_results();
353 if sess.opts.debugging_opts.profile_json {
354 sess.save_json_results();
357 controller_entry_point!(
360 CompileState::state_when_compilation_done(input, sess, outdir, output),
367 pub fn source_name(input: &Input) -> FileName {
369 Input::File(ref ifile) => ifile.clone().into(),
370 Input::Str { ref name, .. } => name.clone(),
374 /// CompileController is used to customize compilation, it allows compilation to
375 /// be stopped and/or to call arbitrary code at various points in compilation.
376 /// It also allows for various flags to be set to influence what information gets
377 /// collected during compilation.
379 /// This is a somewhat higher level controller than a Session - the Session
380 /// controls what happens in each phase, whereas the CompileController controls
381 /// whether a phase is run at all and whether other code (from outside the
382 /// compiler) is run between phases.
384 /// Note that if compilation is set to stop and a callback is provided for a
385 /// given entry point, the callback is called before compilation is stopped.
387 /// Expect more entry points to be added in the future.
388 pub struct CompileController<'a> {
389 pub after_parse: PhaseController<'a>,
390 pub after_expand: PhaseController<'a>,
391 pub after_hir_lowering: PhaseController<'a>,
392 pub after_analysis: PhaseController<'a>,
393 pub compilation_done: PhaseController<'a>,
395 // FIXME we probably want to group the below options together and offer a
396 // better API, rather than this ad-hoc approach.
397 pub make_glob_map: MakeGlobMap,
398 // Whether the compiler should keep the ast beyond parsing.
400 // -Zcontinue-parse-after-error
401 pub continue_parse_after_error: bool,
403 /// Allows overriding default rustc query providers,
404 /// after `default_provide` has installed them.
405 pub provide: Box<dyn Fn(&mut ty::query::Providers) + 'a + sync::Send>,
406 /// Same as `provide`, but only for non-local crates,
407 /// applied after `default_provide_extern`.
408 pub provide_extern: Box<dyn Fn(&mut ty::query::Providers) + 'a + sync::Send>,
411 impl<'a> CompileController<'a> {
412 pub fn basic() -> CompileController<'a> {
413 sync::assert_send::<Self>();
415 after_parse: PhaseController::basic(),
416 after_expand: PhaseController::basic(),
417 after_hir_lowering: PhaseController::basic(),
418 after_analysis: PhaseController::basic(),
419 compilation_done: PhaseController::basic(),
420 make_glob_map: MakeGlobMap::No,
422 continue_parse_after_error: false,
424 provide_extern: box |_| {},
429 /// This implementation makes it easier to create a custom driver when you only want to hook
430 /// into callbacks from `CompileController`.
435 /// # extern crate rustc_driver;
436 /// # use rustc_driver::driver::CompileController;
437 /// let mut controller = CompileController::basic();
438 /// controller.after_analysis.callback = Box::new(move |_state| {});
439 /// rustc_driver::run_compiler(&[], Box::new(controller), None, None);
441 impl<'a> ::CompilerCalls<'a> for CompileController<'a> {
444 matches: &::getopts::Matches,
445 sopts: &config::Options,
446 cfg: &ast::CrateConfig,
447 descriptions: &::errors::registry::Registry,
448 output: ::ErrorOutputType,
450 ::RustcDefaultCalls.early_callback(
460 matches: &::getopts::Matches,
461 sopts: &config::Options,
462 cfg: &ast::CrateConfig,
463 odir: &Option<PathBuf>,
464 ofile: &Option<PathBuf>,
465 descriptions: &::errors::registry::Registry,
466 ) -> Option<(Input, Option<PathBuf>)> {
467 ::RustcDefaultCalls.no_input(
478 codegen_backend: &dyn (::CodegenBackend),
479 matches: &::getopts::Matches,
483 odir: &Option<PathBuf>,
484 ofile: &Option<PathBuf>,
487 .late_callback(codegen_backend, matches, sess, cstore, input, odir, ofile)
492 _: &::getopts::Matches
493 ) -> CompileController<'a> {
498 pub struct PhaseController<'a> {
499 pub stop: Compilation,
500 // If true then the compiler will try to run the callback even if the phase
501 // ends with an error. Note that this is not always possible.
502 pub run_callback_on_error: bool,
503 pub callback: Box<dyn Fn(&mut CompileState) + 'a + sync::Send>,
506 impl<'a> PhaseController<'a> {
507 pub fn basic() -> PhaseController<'a> {
509 stop: Compilation::Continue,
510 run_callback_on_error: false,
511 callback: box |_| {},
516 /// State that is passed to a callback. What state is available depends on when
517 /// during compilation the callback is made. See the various constructor methods
518 /// (`state_*`) in the impl to see which data is provided for any given entry point.
519 pub struct CompileState<'a, 'tcx: 'a> {
520 pub input: &'a Input,
521 pub session: &'tcx Session,
522 pub krate: Option<ast::Crate>,
523 pub registry: Option<Registry<'a>>,
524 pub cstore: Option<&'tcx CStore>,
525 pub crate_name: Option<&'a str>,
526 pub output_filenames: Option<&'a OutputFilenames>,
527 pub out_dir: Option<&'a Path>,
528 pub out_file: Option<&'a Path>,
529 pub expanded_crate: Option<&'a ast::Crate>,
530 pub hir_crate: Option<&'a hir::Crate>,
531 pub hir_map: Option<&'a hir_map::Map<'tcx>>,
532 pub resolutions: Option<&'a Resolutions>,
533 pub analysis: Option<&'a ty::CrateAnalysis>,
534 pub tcx: Option<TyCtxt<'a, 'tcx, 'tcx>>,
537 impl<'a, 'tcx> CompileState<'a, 'tcx> {
538 fn empty(input: &'a Input, session: &'tcx Session, out_dir: &'a Option<PathBuf>) -> Self {
542 out_dir: out_dir.as_ref().map(|s| &**s),
548 output_filenames: None,
549 expanded_crate: None,
558 fn state_after_parse(
560 session: &'tcx Session,
561 out_dir: &'a Option<PathBuf>,
562 out_file: &'a Option<PathBuf>,
564 cstore: &'tcx CStore,
567 // Initialize the registry before moving `krate`
568 registry: Some(Registry::new(&session, krate.span)),
570 cstore: Some(cstore),
571 out_file: out_file.as_ref().map(|s| &**s),
572 ..CompileState::empty(input, session, out_dir)
576 fn state_after_expand(
578 session: &'tcx Session,
579 out_dir: &'a Option<PathBuf>,
580 out_file: &'a Option<PathBuf>,
581 cstore: &'tcx CStore,
582 expanded_crate: &'a ast::Crate,
586 crate_name: Some(crate_name),
587 cstore: Some(cstore),
588 expanded_crate: Some(expanded_crate),
589 out_file: out_file.as_ref().map(|s| &**s),
590 ..CompileState::empty(input, session, out_dir)
594 fn state_after_hir_lowering(
596 session: &'tcx Session,
597 out_dir: &'a Option<PathBuf>,
598 out_file: &'a Option<PathBuf>,
599 cstore: &'tcx CStore,
600 hir_map: &'a hir_map::Map<'tcx>,
601 analysis: &'a ty::CrateAnalysis,
602 resolutions: &'a Resolutions,
603 krate: &'a ast::Crate,
604 hir_crate: &'a hir::Crate,
605 output_filenames: &'a OutputFilenames,
609 crate_name: Some(crate_name),
610 cstore: Some(cstore),
611 hir_map: Some(hir_map),
612 analysis: Some(analysis),
613 resolutions: Some(resolutions),
614 expanded_crate: Some(krate),
615 hir_crate: Some(hir_crate),
616 output_filenames: Some(output_filenames),
617 out_file: out_file.as_ref().map(|s| &**s),
618 ..CompileState::empty(input, session, out_dir)
622 fn state_after_analysis(
624 session: &'tcx Session,
625 out_dir: &'a Option<PathBuf>,
626 out_file: &'a Option<PathBuf>,
627 krate: Option<&'a ast::Crate>,
628 hir_crate: &'a hir::Crate,
629 analysis: &'a ty::CrateAnalysis,
630 tcx: TyCtxt<'a, 'tcx, 'tcx>,
634 analysis: Some(analysis),
636 expanded_crate: krate,
637 hir_crate: Some(hir_crate),
638 crate_name: Some(crate_name),
639 out_file: out_file.as_ref().map(|s| &**s),
640 ..CompileState::empty(input, session, out_dir)
644 fn state_when_compilation_done(
646 session: &'tcx Session,
647 out_dir: &'a Option<PathBuf>,
648 out_file: &'a Option<PathBuf>,
651 out_file: out_file.as_ref().map(|s| &**s),
652 ..CompileState::empty(input, session, out_dir)
657 pub fn phase_1_parse_input<'a>(
658 control: &CompileController,
661 ) -> PResult<'a, ast::Crate> {
663 .set_continue_after_error(control.continue_parse_after_error);
664 hygiene::set_default_edition(sess.edition());
666 if sess.profile_queries() {
667 profile::begin(sess);
670 sess.profiler(|p| p.start_activity(ProfileCategory::Parsing));
671 let krate = time(sess, "parsing", || match *input {
672 Input::File(ref file) => parse::parse_crate_from_file(file, &sess.parse_sess),
676 } => parse::parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess),
678 sess.profiler(|p| p.end_activity(ProfileCategory::Parsing));
680 sess.diagnostic().set_continue_after_error(true);
682 if sess.opts.debugging_opts.ast_json_noexpand {
683 println!("{}", json::as_json(&krate));
686 if sess.opts.debugging_opts.input_stats {
689 sess.source_map().count_lines()
691 println!("Pre-expansion node count: {}", count_nodes(&krate));
694 if let Some(ref s) = sess.opts.debugging_opts.show_span {
695 syntax::show_span::run(sess.diagnostic(), s, &krate);
698 if sess.opts.debugging_opts.hir_stats {
699 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
705 fn count_nodes(krate: &ast::Crate) -> usize {
706 let mut counter = NodeCounter::new();
707 visit::walk_crate(&mut counter, krate);
711 // For continuing compilation after a parsed crate has been
714 pub struct ExpansionResult {
715 pub expanded_crate: ast::Crate,
716 pub defs: hir_map::Definitions,
717 pub analysis: ty::CrateAnalysis,
718 pub resolutions: Resolutions,
719 pub hir_forest: hir_map::Forest,
722 pub struct InnerExpansionResult<'a> {
723 pub expanded_crate: ast::Crate,
724 pub resolver: Resolver<'a>,
725 pub hir_forest: hir_map::Forest,
728 /// Run the "early phases" of the compiler: initial `cfg` processing,
729 /// loading compiler plugins (including those from `addl_plugins`),
730 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
731 /// harness if one is to be provided, injection of a dependency on the
732 /// standard library and prelude, and name resolution.
734 /// Returns `None` if we're aborting after handling -W help.
735 pub fn phase_2_configure_and_expand<F>(
739 registry: Option<Registry>,
741 addl_plugins: Option<Vec<String>>,
742 make_glob_map: MakeGlobMap,
744 ) -> Result<ExpansionResult, CompileIncomplete>
746 F: FnOnce(&ast::Crate) -> CompileResult,
748 // Currently, we ignore the name resolution data structures for the purposes of dependency
749 // tracking. Instead we will run name resolution and include its output in the hash of each
750 // item, much like we do for macro expansion. In other words, the hash reflects not just
751 // its contents but the results of name resolution on those contents. Hopefully we'll push
752 // this back at some point.
753 let mut crate_loader = CrateLoader::new(sess, &cstore, &crate_name);
754 let resolver_arenas = Resolver::arenas();
755 let result = phase_2_configure_and_expand_inner(
768 Ok(InnerExpansionResult {
772 }) => Ok(ExpansionResult {
774 defs: resolver.definitions,
776 resolutions: Resolutions {
777 freevars: resolver.freevars,
778 export_map: resolver.export_map,
779 trait_map: resolver.trait_map,
780 maybe_unused_trait_imports: resolver.maybe_unused_trait_imports,
781 maybe_unused_extern_crates: resolver.maybe_unused_extern_crates,
782 extern_prelude: resolver.extern_prelude.iter().map(|(ident, entry)| {
783 (ident.name, entry.introduced_by_item)
787 analysis: ty::CrateAnalysis {
788 glob_map: if resolver.make_glob_map {
789 Some(resolver.glob_map)
799 /// Same as phase_2_configure_and_expand, but doesn't let you keep the resolver
801 pub fn phase_2_configure_and_expand_inner<'a, F>(
804 mut krate: ast::Crate,
805 registry: Option<Registry>,
807 addl_plugins: Option<Vec<String>>,
808 make_glob_map: MakeGlobMap,
809 resolver_arenas: &'a ResolverArenas<'a>,
810 crate_loader: &'a mut CrateLoader<'a>,
812 ) -> Result<InnerExpansionResult<'a>, CompileIncomplete>
814 F: FnOnce(&ast::Crate) -> CompileResult,
816 krate = time(sess, "attributes injection", || {
817 syntax::attr::inject(krate, &sess.parse_sess, &sess.opts.debugging_opts.crate_attr)
820 let (mut krate, features) = syntax::config::features(
825 // these need to be set "early" so that expansion sees `quote` if enabled.
826 sess.init_features(features);
828 let crate_types = collect_crate_types(sess, &krate.attrs);
829 sess.crate_types.set(crate_types);
831 let disambiguator = compute_crate_disambiguator(sess);
832 sess.crate_disambiguator.set(disambiguator);
833 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator);
835 if sess.opts.incremental.is_some() {
836 time(sess, "garbage collect incremental cache directory", || {
837 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
839 "Error while trying to garbage collect incremental \
840 compilation cache directory: {}",
847 // If necessary, compute the dependency graph (in the background).
848 let future_dep_graph = if sess.opts.build_dep_graph() {
849 Some(rustc_incremental::load_dep_graph(sess))
854 time(sess, "recursion limit", || {
855 middle::recursion_limit::update_limits(sess, &krate);
858 krate = time(sess, "crate injection", || {
859 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| &**s);
860 syntax::std_inject::maybe_inject_crates_ref(krate, alt_std_name, sess.edition())
863 let mut addl_plugins = Some(addl_plugins);
864 let registrars = time(sess, "plugin loading", || {
865 plugin::load::load_plugins(
870 addl_plugins.take().unwrap(),
874 let mut registry = registry.unwrap_or_else(|| Registry::new(sess, krate.span));
876 time(sess, "plugin registration", || {
877 if sess.features_untracked().rustc_diagnostic_macros {
878 registry.register_macro(
880 diagnostics::plugin::expand_diagnostic_used,
882 registry.register_macro(
883 "__register_diagnostic",
884 diagnostics::plugin::expand_register_diagnostic,
886 registry.register_macro(
887 "__build_diagnostic_array",
888 diagnostics::plugin::expand_build_diagnostic_array,
892 for registrar in registrars {
893 registry.args_hidden = Some(registrar.args);
894 (registrar.fun)(&mut registry);
908 sess.track_errors(|| {
909 let mut ls = sess.lint_store.borrow_mut();
910 for pass in early_lint_passes {
911 ls.register_early_pass(Some(sess), true, pass);
913 for pass in late_lint_passes {
914 ls.register_late_pass(Some(sess), true, pass);
917 for (name, (to, deprecated_name)) in lint_groups {
918 ls.register_group(Some(sess), true, name, deprecated_name, to);
921 *sess.plugin_llvm_passes.borrow_mut() = llvm_passes;
922 *sess.plugin_attributes.borrow_mut() = attributes.clone();
925 // Lint plugins are registered; now we can process command line flags.
926 if sess.opts.describe_lints {
927 super::describe_lints(&sess, &sess.lint_store.borrow(), true);
928 return Err(CompileIncomplete::Stopped);
931 time(sess, "pre ast expansion lint checks", || {
932 lint::check_ast_crate(sess, &krate, true)
935 let mut resolver = Resolver::new(
944 syntax_ext::register_builtins(&mut resolver, syntax_exts, sess.features_untracked().quote);
947 sess.profiler(|p| p.start_activity(ProfileCategory::Expansion));
948 krate = time(sess, "expansion", || {
949 // Windows dlls do not have rpaths, so they don't know how to find their
950 // dependencies. It's up to us to tell the system where to find all the
951 // dependent dlls. Note that this uses cfg!(windows) as opposed to
952 // targ_cfg because syntax extensions are always loaded for the host
953 // compiler, not for the target.
955 // This is somewhat of an inherently racy operation, however, as
956 // multiple threads calling this function could possibly continue
957 // extending PATH far beyond what it should. To solve this for now we
958 // just don't add any new elements to PATH which are already there
959 // within PATH. This is basically a targeted fix at #17360 for rustdoc
960 // which runs rustc in parallel but has been seen (#33844) to cause
961 // problems with PATH becoming too long.
962 let mut old_path = OsString::new();
964 old_path = env::var_os("PATH").unwrap_or(old_path);
965 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
966 for path in env::split_paths(&old_path) {
967 if !new_path.contains(&path) {
976 .filter(|p| env::join_paths(iter::once(p)).is_ok()),
981 // Create the config for macro expansion
982 let features = sess.features_untracked();
983 let cfg = syntax::ext::expand::ExpansionConfig {
984 features: Some(&features),
985 recursion_limit: *sess.recursion_limit.get(),
986 trace_mac: sess.opts.debugging_opts.trace_macros,
987 should_test: sess.opts.test,
988 ..syntax::ext::expand::ExpansionConfig::default(crate_name.to_string())
991 let mut ecx = ExtCtxt::new(&sess.parse_sess, cfg, &mut resolver);
993 // Expand macros now!
994 let krate = time(sess, "expand crate", || {
995 ecx.monotonic_expander().expand_crate(krate)
998 // The rest is error reporting
1000 time(sess, "check unused macros", || {
1001 ecx.check_unused_macros();
1004 let mut missing_fragment_specifiers: Vec<_> = ecx.parse_sess
1005 .missing_fragment_specifiers
1010 missing_fragment_specifiers.sort();
1012 for span in missing_fragment_specifiers {
1013 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
1014 let msg = "missing fragment specifier";
1015 sess.buffer_lint(lint, ast::CRATE_NODE_ID, span, msg);
1018 env::set_var("PATH", &old_path);
1022 sess.profiler(|p| p.end_activity(ProfileCategory::Expansion));
1024 krate = time(sess, "maybe building test harness", || {
1025 syntax::test::modify_for_testing(
1031 &sess.features_untracked(),
1035 // If we're actually rustdoc then there's no need to actually compile
1036 // anything, so switch everything to just looping
1037 if sess.opts.actually_rustdoc {
1038 krate = ReplaceBodyWithLoop::new(sess).fold_crate(krate);
1041 // If we're in rustdoc we're always compiling as an rlib, but that'll trip a
1042 // bunch of checks in the `modify` function below. For now just skip this
1043 // step entirely if we're rustdoc as it's not too useful anyway.
1044 if !sess.opts.actually_rustdoc {
1045 krate = time(sess, "maybe creating a macro crate", || {
1046 let crate_types = sess.crate_types.borrow();
1047 let num_crate_types = crate_types.len();
1048 let is_proc_macro_crate = crate_types.contains(&config::CrateType::ProcMacro);
1049 let is_test_crate = sess.opts.test;
1050 syntax_ext::proc_macro_decls::modify(
1054 is_proc_macro_crate,
1062 // Expand global allocators, which are treated as an in-tree proc macro
1063 krate = time(sess, "creating allocators", || {
1064 allocator::expand::modify(
1068 crate_name.to_string(),
1073 // Add all buffered lints from the `ParseSess` to the `Session`.
1074 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
1075 info!("{} parse sess buffered_lints", buffered_lints.len());
1076 for BufferedEarlyLint{id, span, msg, lint_id} in buffered_lints.drain(..) {
1077 let lint = lint::Lint::from_parser_lint_id(lint_id);
1078 sess.buffer_lint(lint, id, span, &msg);
1082 // Done with macro expansion!
1084 after_expand(&krate)?;
1086 if sess.opts.debugging_opts.input_stats {
1087 println!("Post-expansion node count: {}", count_nodes(&krate));
1090 if sess.opts.debugging_opts.hir_stats {
1091 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
1094 if sess.opts.debugging_opts.ast_json {
1095 println!("{}", json::as_json(&krate));
1098 time(sess, "AST validation", || {
1099 ast_validation::check_crate(sess, &krate)
1102 time(sess, "name resolution", || {
1103 resolver.resolve_crate(&krate);
1106 // Needs to go *after* expansion to be able to check the results of macro expansion.
1107 time(sess, "complete gated feature checking", || {
1108 syntax::feature_gate::check_crate(
1111 &sess.features_untracked(),
1113 sess.opts.unstable_features,
1117 // Lower ast -> hir.
1118 // First, we need to collect the dep_graph.
1119 let dep_graph = match future_dep_graph {
1120 None => DepGraph::new_disabled(),
1122 let (prev_graph, prev_work_products) =
1123 time(sess, "blocked while dep-graph loading finishes", || {
1126 .unwrap_or_else(|e| rustc_incremental::LoadResult::Error {
1127 message: format!("could not decode incremental cache: {:?}", e),
1131 DepGraph::new(prev_graph, prev_work_products)
1134 let hir_forest = time(sess, "lowering ast -> hir", || {
1135 let hir_crate = lower_crate(sess, cstore, &dep_graph, &krate, &mut resolver);
1137 if sess.opts.debugging_opts.hir_stats {
1138 hir_stats::print_hir_stats(&hir_crate);
1141 hir_map::Forest::new(hir_crate, &dep_graph)
1144 time(sess, "early lint checks", || {
1145 lint::check_ast_crate(sess, &krate, false)
1148 // Discard hygiene data, which isn't required after lowering to HIR.
1149 if !sess.opts.debugging_opts.keep_hygiene_data {
1150 syntax::ext::hygiene::clear_markings();
1153 Ok(InnerExpansionResult {
1154 expanded_crate: krate,
1160 pub fn default_provide(providers: &mut ty::query::Providers) {
1161 hir::provide(providers);
1162 borrowck::provide(providers);
1163 mir::provide(providers);
1164 reachable::provide(providers);
1165 resolve_lifetime::provide(providers);
1166 rustc_privacy::provide(providers);
1167 typeck::provide(providers);
1168 ty::provide(providers);
1169 traits::provide(providers);
1170 reachable::provide(providers);
1171 rustc_passes::provide(providers);
1172 rustc_traits::provide(providers);
1173 middle::region::provide(providers);
1174 cstore::provide(providers);
1175 lint::provide(providers);
1178 pub fn default_provide_extern(providers: &mut ty::query::Providers) {
1179 cstore::provide_extern(providers);
1182 /// Run the resolution, typechecking, region checking and other
1183 /// miscellaneous analysis passes on the crate. Return various
1184 /// structures carrying the results of the analysis.
1185 pub fn phase_3_run_analysis_passes<'tcx, F, R>(
1186 codegen_backend: &dyn CodegenBackend,
1187 control: &CompileController,
1188 sess: &'tcx Session,
1189 cstore: &'tcx CStore,
1190 hir_map: hir_map::Map<'tcx>,
1191 analysis: ty::CrateAnalysis,
1192 resolutions: Resolutions,
1193 arenas: &'tcx mut AllArenas<'tcx>,
1195 output_filenames: &OutputFilenames,
1197 ) -> Result<R, CompileIncomplete>
1200 TyCtxt<'a, 'tcx, 'tcx>,
1202 mpsc::Receiver<Box<dyn Any + Send>>,
1206 let query_result_on_disk_cache = time(sess, "load query result cache", || {
1207 rustc_incremental::load_query_result_cache(sess)
1210 time(sess, "looking for entry point", || {
1211 middle::entry::find_entry_point(sess, &hir_map, name)
1214 sess.plugin_registrar_fn
1215 .set(time(sess, "looking for plugin registrar", || {
1216 plugin::build::find_plugin_registrar(sess.diagnostic(), &hir_map)
1218 sess.proc_macro_decls_static
1219 .set(proc_macro_decls::find(&hir_map));
1221 time(sess, "loop checking", || loops::check_crate(sess, &hir_map));
1223 let mut local_providers = ty::query::Providers::default();
1224 default_provide(&mut local_providers);
1225 codegen_backend.provide(&mut local_providers);
1226 (control.provide)(&mut local_providers);
1228 let mut extern_providers = local_providers;
1229 default_provide_extern(&mut extern_providers);
1230 codegen_backend.provide_extern(&mut extern_providers);
1231 (control.provide_extern)(&mut extern_providers);
1233 let (tx, rx) = mpsc::channel();
1235 TyCtxt::create_and_enter(
1243 query_result_on_disk_cache,
1248 // Do some initialization of the DepGraph that can only be done with the
1250 rustc_incremental::dep_graph_tcx_init(tcx);
1252 time(sess, "attribute checking", || {
1253 hir::check_attr::check_crate(tcx)
1256 time(sess, "stability checking", || {
1257 stability::check_unstable_api_usage(tcx)
1260 // passes are timed inside typeck
1261 match typeck::check_crate(tcx) {
1264 f(tcx, analysis, rx, Err(x));
1269 time(sess, "rvalue promotion", || {
1270 rvalue_promotion::check_crate(tcx)
1273 time(sess, "privacy checking", || {
1274 rustc_privacy::check_crate(tcx)
1277 time(sess, "intrinsic checking", || {
1278 middle::intrinsicck::check_crate(tcx)
1281 time(sess, "match checking", || mir::matchck_crate(tcx));
1283 // this must run before MIR dump, because
1284 // "not all control paths return a value" is reported here.
1286 // maybe move the check to a MIR pass?
1287 time(sess, "liveness checking", || {
1288 middle::liveness::check_crate(tcx)
1291 time(sess, "borrow checking", || {
1292 if tcx.use_ast_borrowck() {
1293 borrowck::check_crate(tcx);
1298 "MIR borrow checking",
1299 || tcx.par_body_owners(|def_id| { tcx.mir_borrowck(def_id); }));
1301 time(sess, "dumping chalk-like clauses", || {
1302 rustc_traits::lowering::dump_program_clauses(tcx);
1305 time(sess, "MIR effect checking", || {
1306 for def_id in tcx.body_owners() {
1307 mir::transform::check_unsafety::check_unsafety(tcx, def_id)
1310 // Avoid overwhelming user with errors if type checking failed.
1311 // I'm not sure how helpful this is, to be honest, but it avoids
1313 // lot of annoying errors in the compile-fail tests (basically,
1314 // lint warnings and so on -- kindck used to do this abort, but
1315 // kindck is gone now). -nmatsakis
1316 if sess.err_count() > 0 {
1317 return Ok(f(tcx, analysis, rx, sess.compile_status()));
1320 time(sess, "death checking", || middle::dead::check_crate(tcx));
1322 time(sess, "unused lib feature checking", || {
1323 stability::check_unused_or_stable_features(tcx)
1326 time(sess, "lint checking", || lint::check_crate(tcx));
1328 return Ok(f(tcx, analysis, rx, tcx.sess.compile_status()));
1333 /// Run the codegen backend, after which the AST and analysis can
1335 pub fn phase_4_codegen<'a, 'tcx>(
1336 codegen_backend: &dyn CodegenBackend,
1337 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1338 rx: mpsc::Receiver<Box<dyn Any + Send>>,
1340 time(tcx.sess, "resolving dependency formats", || {
1341 ::rustc::middle::dependency_format::calculate(tcx)
1344 tcx.sess.profiler(|p| p.start_activity(ProfileCategory::Codegen));
1345 let codegen = time(tcx.sess, "codegen", move || codegen_backend.codegen_crate(tcx, rx));
1346 tcx.sess.profiler(|p| p.end_activity(ProfileCategory::Codegen));
1347 if tcx.sess.profile_queries() {
1348 profile::dump(&tcx.sess, "profile_queries".to_string())
1354 fn escape_dep_filename(filename: &FileName) -> String {
1355 // Apparently clang and gcc *only* escape spaces:
1356 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
1357 filename.to_string().replace(" ", "\\ ")
1360 // Returns all the paths that correspond to generated files.
1361 fn generated_output_paths(
1363 outputs: &OutputFilenames,
1367 let mut out_filenames = Vec::new();
1368 for output_type in sess.opts.output_types.keys() {
1369 let file = outputs.path(*output_type);
1370 match *output_type {
1371 // If the filename has been overridden using `-o`, it will not be modified
1372 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
1373 OutputType::Exe if !exact_name => for crate_type in sess.crate_types.borrow().iter() {
1374 let p = ::rustc_codegen_utils::link::filename_for_input(
1380 out_filenames.push(p);
1382 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
1383 // Don't add the dep-info output when omitting it from dep-info targets
1386 out_filenames.push(file);
1393 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
1394 // returns None for every file path.
1395 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
1397 F: Fn(&PathBuf) -> Option<T>,
1399 for output_path in output_paths {
1400 if let Some(result) = f(output_path) {
1401 return Some(result);
1407 pub fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
1408 let input_path = input_path.canonicalize().ok();
1409 if input_path.is_none() {
1412 let check = |output_path: &PathBuf| {
1413 if output_path.canonicalize().ok() == input_path {
1419 check_output(output_paths, check).is_some()
1422 pub fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
1423 let check = |output_path: &PathBuf| {
1424 if output_path.is_dir() {
1425 Some(output_path.clone())
1430 check_output(output_paths, check)
1433 fn write_out_deps(sess: &Session, outputs: &OutputFilenames, out_filenames: &[PathBuf]) {
1434 // Write out dependency rules to the dep-info file if requested
1435 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
1438 let deps_filename = outputs.path(OutputType::DepInfo);
1440 let result = (|| -> io::Result<()> {
1441 // Build a list of files used to compile the output and
1442 // write Makefile-compatible dependency rules
1443 let files: Vec<String> = sess.source_map()
1446 .filter(|fmap| fmap.is_real_file())
1447 .filter(|fmap| !fmap.is_imported())
1448 .map(|fmap| escape_dep_filename(&fmap.name))
1450 let mut file = fs::File::create(&deps_filename)?;
1451 for path in out_filenames {
1452 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
1455 // Emit a fake target for each input file to the compilation. This
1456 // prevents `make` from spitting out an error if a file is later
1457 // deleted. For more info see #28735
1459 writeln!(file, "{}:", path)?;
1464 if let Err(e) = result {
1465 sess.fatal(&format!(
1466 "error writing dependencies to `{}`: {}",
1467 deps_filename.display(),
1473 pub fn collect_crate_types(session: &Session, attrs: &[ast::Attribute]) -> Vec<config::CrateType> {
1474 // Unconditionally collect crate types from attributes to make them used
1475 let attr_types: Vec<config::CrateType> = attrs
1478 if a.check_name("crate_type") {
1479 match a.value_str() {
1480 Some(ref n) if *n == "rlib" => Some(config::CrateType::Rlib),
1481 Some(ref n) if *n == "dylib" => Some(config::CrateType::Dylib),
1482 Some(ref n) if *n == "cdylib" => Some(config::CrateType::Cdylib),
1483 Some(ref n) if *n == "lib" => Some(config::default_lib_output()),
1484 Some(ref n) if *n == "staticlib" => Some(config::CrateType::Staticlib),
1485 Some(ref n) if *n == "proc-macro" => Some(config::CrateType::ProcMacro),
1486 Some(ref n) if *n == "bin" => Some(config::CrateType::Executable),
1488 let crate_types = vec![
1489 Symbol::intern("rlib"),
1490 Symbol::intern("dylib"),
1491 Symbol::intern("cdylib"),
1492 Symbol::intern("lib"),
1493 Symbol::intern("staticlib"),
1494 Symbol::intern("proc-macro"),
1495 Symbol::intern("bin")
1498 if let ast::MetaItemKind::NameValue(spanned) = a.meta().unwrap().node {
1499 let span = spanned.span;
1500 let lev_candidate = find_best_match_for_name(
1505 if let Some(candidate) = lev_candidate {
1506 session.buffer_lint_with_diagnostic(
1507 lint::builtin::UNKNOWN_CRATE_TYPES,
1510 "invalid `crate_type` value",
1511 lint::builtin::BuiltinLintDiagnostics::
1514 "did you mean".to_string(),
1515 format!("\"{}\"", candidate)
1519 session.buffer_lint(
1520 lint::builtin::UNKNOWN_CRATE_TYPES,
1523 "invalid `crate_type` value"
1531 .struct_span_err(a.span, "`crate_type` requires a value")
1532 .note("for example: `#![crate_type=\"lib\"]`")
1543 // If we're generating a test executable, then ignore all other output
1544 // styles at all other locations
1545 if session.opts.test {
1546 return vec![config::CrateType::Executable];
1549 // Only check command line flags if present. If no types are specified by
1550 // command line, then reuse the empty `base` Vec to hold the types that
1551 // will be found in crate attributes.
1552 let mut base = session.opts.crate_types.clone();
1553 if base.is_empty() {
1554 base.extend(attr_types);
1555 if base.is_empty() {
1556 base.push(::rustc_codegen_utils::link::default_output_for_target(
1565 base.retain(|crate_type| {
1566 let res = !::rustc_codegen_utils::link::invalid_output_for_target(session, *crate_type);
1569 session.warn(&format!(
1570 "dropping unsupported crate type `{}` for target `{}`",
1571 *crate_type, session.opts.target_triple
1581 pub fn compute_crate_disambiguator(session: &Session) -> CrateDisambiguator {
1582 use std::hash::Hasher;
1584 // The crate_disambiguator is a 128 bit hash. The disambiguator is fed
1585 // into various other hashes quite a bit (symbol hashes, incr. comp. hashes,
1586 // debuginfo type IDs, etc), so we don't want it to be too wide. 128 bits
1587 // should still be safe enough to avoid collisions in practice.
1588 let mut hasher = StableHasher::<Fingerprint>::new();
1590 let mut metadata = session.opts.cg.metadata.clone();
1591 // We don't want the crate_disambiguator to dependent on the order
1592 // -C metadata arguments, so sort them:
1594 // Every distinct -C metadata value is only incorporated once:
1597 hasher.write(b"metadata");
1598 for s in &metadata {
1599 // Also incorporate the length of a metadata string, so that we generate
1600 // different values for `-Cmetadata=ab -Cmetadata=c` and
1601 // `-Cmetadata=a -Cmetadata=bc`
1602 hasher.write_usize(s.len());
1603 hasher.write(s.as_bytes());
1606 // Also incorporate crate type, so that we don't get symbol conflicts when
1607 // linking against a library of the same name, if this is an executable.
1608 let is_exe = session
1611 .contains(&config::CrateType::Executable);
1612 hasher.write(if is_exe { b"exe" } else { b"lib" });
1614 CrateDisambiguator::from(hasher.finish())
1617 pub fn build_output_filenames(
1619 odir: &Option<PathBuf>,
1620 ofile: &Option<PathBuf>,
1621 attrs: &[ast::Attribute],
1623 ) -> OutputFilenames {
1626 // "-" as input file will cause the parser to read from stdin so we
1627 // have to make up a name
1628 // We want to toss everything after the final '.'
1629 let dirpath = (*odir).as_ref().cloned().unwrap_or_default();
1631 // If a crate name is present, we use it as the link name
1632 let stem = sess.opts
1635 .or_else(|| attr::find_crate_name(attrs).map(|n| n.to_string()))
1636 .unwrap_or_else(|| input.filestem().to_owned());
1639 out_directory: dirpath,
1641 single_output_file: None,
1642 extra: sess.opts.cg.extra_filename.clone(),
1643 outputs: sess.opts.output_types.clone(),
1647 Some(ref out_file) => {
1648 let unnamed_output_types = sess.opts
1651 .filter(|a| a.is_none())
1653 let ofile = if unnamed_output_types > 1 {
1655 "due to multiple output types requested, the explicitly specified \
1656 output file name will be adapted for each output type",
1660 Some(out_file.clone())
1663 sess.warn("ignoring --out-dir flag due to -o flag");
1665 if !sess.opts.cg.extra_filename.is_empty() {
1666 sess.warn("ignoring -C extra-filename flag due to -o flag");
1670 out_directory: out_file.parent().unwrap_or_else(|| Path::new("")).to_path_buf(),
1671 out_filestem: out_file
1673 .unwrap_or_default()
1677 single_output_file: ofile,
1678 extra: sess.opts.cg.extra_filename.clone(),
1679 outputs: sess.opts.output_types.clone(),