1 use crate::interface::{Compiler, Result};
3 use crate::proc_macro_decls;
5 use log::{info, warn, log_enabled};
6 use rustc::dep_graph::DepGraph;
8 use rustc::hir::lowering::lower_crate;
9 use rustc::hir::def_id::{CrateNum, LOCAL_CRATE};
11 use rustc::middle::{self, reachable, resolve_lifetime, stability};
12 use rustc::middle::cstore::CrateStore;
13 use rustc::ty::{self, AllArenas, Resolutions, TyCtxt, GlobalCtxt};
14 use rustc::ty::steal::Steal;
16 use rustc::util::common::{time, ErrorReported};
17 use rustc::session::Session;
18 use rustc::session::config::{self, CrateType, Input, OutputFilenames, OutputType};
19 use rustc::session::search_paths::PathKind;
20 use rustc_codegen_ssa::back::link::emit_metadata;
21 use rustc_codegen_utils::codegen_backend::CodegenBackend;
22 use rustc_codegen_utils::link::filename_for_metadata;
23 use rustc_data_structures::{box_region_allow_access, declare_box_region_type, parallel};
24 use rustc_data_structures::sync::{Lrc, ParallelIterator, par_iter};
25 use rustc_incremental;
26 use rustc_metadata::creader::CrateLoader;
27 use rustc_metadata::cstore::{self, CStore};
29 use rustc_passes::{self, ast_validation, hir_stats, layout_test};
30 use rustc_plugin as plugin;
31 use rustc_plugin::registry::Registry;
33 use rustc_resolve::{Resolver, ResolverArenas};
35 use rustc_typeck as typeck;
36 use syntax::{self, ast, visit};
37 use syntax::early_buffered_lints::BufferedEarlyLint;
38 use syntax_expand::base::{NamedSyntaxExtension, ExtCtxt};
39 use syntax::mut_visit::MutVisitor;
40 use syntax::parse::{self, PResult};
41 use syntax::util::node_count::NodeCounter;
42 use syntax::symbol::Symbol;
43 use syntax_pos::FileName;
46 use rustc_serialize::json;
47 use tempfile::Builder as TempFileBuilder;
51 use std::ffi::OsString;
53 use std::io::{self, Write};
55 use std::path::PathBuf;
56 use std::cell::RefCell;
59 pub fn parse<'a>(sess: &'a Session, input: &Input) -> PResult<'a, ast::Crate> {
61 .set_continue_after_error(sess.opts.debugging_opts.continue_parse_after_error);
62 let krate = time(sess, "parsing", || {
63 let _prof_timer = sess.prof.generic_activity("parse_crate");
66 Input::File(ref file) => parse::parse_crate_from_file(file, &sess.parse_sess),
70 } => parse::parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess),
74 sess.diagnostic().set_continue_after_error(true);
76 if sess.opts.debugging_opts.ast_json_noexpand {
77 println!("{}", json::as_json(&krate));
80 if sess.opts.debugging_opts.input_stats {
83 sess.source_map().count_lines()
85 println!("Pre-expansion node count: {}", count_nodes(&krate));
88 if let Some(ref s) = sess.opts.debugging_opts.show_span {
89 syntax::show_span::run(sess.diagnostic(), s, &krate);
92 if sess.opts.debugging_opts.hir_stats {
93 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
99 fn count_nodes(krate: &ast::Crate) -> usize {
100 let mut counter = NodeCounter::new();
101 visit::walk_crate(&mut counter, krate);
105 declare_box_region_type!(
108 (&mut Resolver<'_>) -> (Result<ast::Crate>, ExpansionResult)
111 /// Runs the "early phases" of the compiler: initial `cfg` processing,
112 /// loading compiler plugins (including those from `addl_plugins`),
113 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
114 /// harness if one is to be provided, injection of a dependency on the
115 /// standard library and prelude, and name resolution.
117 /// Returns `None` if we're aborting after handling -W help.
118 pub fn configure_and_expand(
120 lint_store: Lrc<lint::LintStore>,
124 plugin_info: PluginInfo,
125 ) -> Result<(ast::Crate, BoxedResolver)> {
126 // Currently, we ignore the name resolution data structures for the purposes of dependency
127 // tracking. Instead we will run name resolution and include its output in the hash of each
128 // item, much like we do for macro expansion. In other words, the hash reflects not just
129 // its contents but the results of name resolution on those contents. Hopefully we'll push
130 // this back at some point.
131 let crate_name = crate_name.to_string();
132 let (result, resolver) = BoxedResolver::new(static move || {
134 let crate_loader = CrateLoader::new(sess, &*cstore, &crate_name);
135 let resolver_arenas = Resolver::arenas();
136 let res = configure_and_expand_inner(
146 let mut resolver = match res {
148 yield BoxedResolver::initial_yield(Err(v));
151 Ok((krate, resolver)) => {
152 yield BoxedResolver::initial_yield(Ok(krate));
156 box_region_allow_access!(for(), (&mut Resolver<'_>), (&mut resolver));
157 ExpansionResult::from_owned_resolver(resolver)
159 result.map(|k| (k, resolver))
162 pub struct ExpansionResult {
163 pub defs: Steal<hir::map::Definitions>,
164 pub resolutions: Steal<Resolutions>,
167 impl ExpansionResult {
168 fn from_owned_resolver(
169 resolver: Resolver<'_>,
172 defs: Steal::new(resolver.definitions),
173 resolutions: Steal::new(Resolutions {
174 extern_crate_map: resolver.extern_crate_map,
175 export_map: resolver.export_map,
176 trait_map: resolver.trait_map,
177 glob_map: resolver.glob_map,
178 maybe_unused_trait_imports: resolver.maybe_unused_trait_imports,
179 maybe_unused_extern_crates: resolver.maybe_unused_extern_crates,
180 extern_prelude: resolver.extern_prelude.iter().map(|(ident, entry)| {
181 (ident.name, entry.introduced_by_item)
187 pub fn from_resolver_ref(
188 resolver: &Resolver<'_>,
191 defs: Steal::new(resolver.definitions.clone()),
192 resolutions: Steal::new(Resolutions {
193 extern_crate_map: resolver.extern_crate_map.clone(),
194 export_map: resolver.export_map.clone(),
195 trait_map: resolver.trait_map.clone(),
196 glob_map: resolver.glob_map.clone(),
197 maybe_unused_trait_imports: resolver.maybe_unused_trait_imports.clone(),
198 maybe_unused_extern_crates: resolver.maybe_unused_extern_crates.clone(),
199 extern_prelude: resolver.extern_prelude.iter().map(|(ident, entry)| {
200 (ident.name, entry.introduced_by_item)
208 pub fn to_expansion_result(
209 resolver: Rc<RefCell<BoxedResolver>>,
210 ) -> ExpansionResult {
211 match Rc::try_unwrap(resolver) {
212 Ok(resolver) => resolver.into_inner().complete(),
214 let resolver = &*resolver;
215 resolver.borrow_mut().access(|resolver| {
216 ExpansionResult::from_resolver_ref(resolver)
223 pub struct PluginInfo {
224 syntax_exts: Vec<NamedSyntaxExtension>,
227 pub fn register_plugins<'a>(
230 register_lints: impl Fn(&Session, &mut lint::LintStore),
231 mut krate: ast::Crate,
233 ) -> Result<(ast::Crate, PluginInfo, Lrc<lint::LintStore>)> {
234 krate = time(sess, "attributes injection", || {
235 syntax_ext::cmdline_attrs::inject(
236 krate, &sess.parse_sess, &sess.opts.debugging_opts.crate_attr
240 let (krate, features) = syntax::config::features(
244 &sess.opts.debugging_opts.allow_features,
246 // these need to be set "early" so that expansion sees `quote` if enabled.
247 sess.init_features(features);
249 let crate_types = util::collect_crate_types(sess, &krate.attrs);
250 sess.crate_types.set(crate_types);
252 let disambiguator = util::compute_crate_disambiguator(sess);
253 sess.crate_disambiguator.set(disambiguator);
254 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator);
256 if sess.opts.incremental.is_some() {
257 time(sess, "garbage-collect incremental cache directory", || {
259 sess.prof.generic_activity("incr_comp_garbage_collect_session_directories");
260 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
262 "Error while trying to garbage collect incremental \
263 compilation cache directory: {}",
270 time(sess, "recursion limit", || {
271 middle::recursion_limit::update_limits(sess, &krate);
274 let registrars = time(sess, "plugin loading", || {
275 plugin::load::load_plugins(
280 Some(sess.opts.debugging_opts.extra_plugins.clone()),
284 let mut lint_store = rustc_lint::new_lint_store(
285 sess.opts.debugging_opts.no_interleave_lints,
286 sess.unstable_options(),
289 (register_lints)(&sess, &mut lint_store);
291 let mut registry = Registry::new(sess, &mut lint_store, krate.span);
293 time(sess, "plugin registration", || {
294 for registrar in registrars {
295 registry.args_hidden = Some(registrar.args);
296 (registrar.fun)(&mut registry);
307 *sess.plugin_llvm_passes.borrow_mut() = llvm_passes;
308 *sess.plugin_attributes.borrow_mut() = attributes;
310 Ok((krate, PluginInfo { syntax_exts }, Lrc::new(lint_store)))
313 fn configure_and_expand_inner<'a>(
315 lint_store: &'a lint::LintStore,
317 mut krate: ast::Crate,
319 resolver_arenas: &'a ResolverArenas<'a>,
320 crate_loader: &'a CrateLoader<'a>,
321 plugin_info: PluginInfo,
322 ) -> Result<(ast::Crate, Resolver<'a>)> {
323 time(sess, "pre-AST-expansion lint checks", || {
324 lint::check_ast_crate(
329 rustc_lint::BuiltinCombinedPreExpansionLintPass::new());
332 let mut resolver = Resolver::new(
340 syntax_ext::register_builtin_macros(&mut resolver, sess.edition());
342 krate = time(sess, "crate injection", || {
343 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| Symbol::intern(s));
344 let (krate, name) = syntax_ext::standard_library_imports::inject(
350 if let Some(name) = name {
351 sess.parse_sess.injected_crate_name.set(name);
356 syntax_ext::plugin_macro_defs::inject(
357 &mut krate, &mut resolver, plugin_info.syntax_exts, sess.edition()
361 krate = time(sess, "expansion", || {
362 let _prof_timer = sess.prof.generic_activity("macro_expand_crate");
363 // Windows dlls do not have rpaths, so they don't know how to find their
364 // dependencies. It's up to us to tell the system where to find all the
365 // dependent dlls. Note that this uses cfg!(windows) as opposed to
366 // targ_cfg because syntax extensions are always loaded for the host
367 // compiler, not for the target.
369 // This is somewhat of an inherently racy operation, however, as
370 // multiple threads calling this function could possibly continue
371 // extending PATH far beyond what it should. To solve this for now we
372 // just don't add any new elements to PATH which are already there
373 // within PATH. This is basically a targeted fix at #17360 for rustdoc
374 // which runs rustc in parallel but has been seen (#33844) to cause
375 // problems with PATH becoming too long.
376 let mut old_path = OsString::new();
378 old_path = env::var_os("PATH").unwrap_or(old_path);
379 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
380 for path in env::split_paths(&old_path) {
381 if !new_path.contains(&path) {
390 .filter(|p| env::join_paths(iter::once(p)).is_ok()),
395 // Create the config for macro expansion
396 let features = sess.features_untracked();
397 let cfg = syntax_expand::expand::ExpansionConfig {
398 features: Some(&features),
399 recursion_limit: *sess.recursion_limit.get(),
400 trace_mac: sess.opts.debugging_opts.trace_macros,
401 should_test: sess.opts.test,
402 ..syntax_expand::expand::ExpansionConfig::default(crate_name.to_string())
405 let mut ecx = ExtCtxt::new(&sess.parse_sess, cfg, &mut resolver);
407 // Expand macros now!
408 let krate = time(sess, "expand crate", || {
409 ecx.monotonic_expander().expand_crate(krate)
412 // The rest is error reporting
414 time(sess, "check unused macros", || {
415 ecx.check_unused_macros();
418 let mut missing_fragment_specifiers: Vec<_> = ecx.parse_sess
419 .missing_fragment_specifiers
424 missing_fragment_specifiers.sort();
426 for span in missing_fragment_specifiers {
427 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
428 let msg = "missing fragment specifier";
429 sess.buffer_lint(lint, ast::CRATE_NODE_ID, span, msg);
432 env::set_var("PATH", &old_path);
437 time(sess, "maybe building test harness", || {
438 syntax_ext::test_harness::inject(
444 &sess.features_untracked(),
445 sess.panic_strategy(),
446 sess.target.target.options.panic_strategy,
447 sess.opts.debugging_opts.panic_abort_tests,
451 // If we're actually rustdoc then there's no need to actually compile
452 // anything, so switch everything to just looping
453 if sess.opts.actually_rustdoc {
454 util::ReplaceBodyWithLoop::new(sess).visit_crate(&mut krate);
457 let has_proc_macro_decls = time(sess, "AST validation", || {
458 ast_validation::check_crate(sess, &krate)
462 let crate_types = sess.crate_types.borrow();
463 let is_proc_macro_crate = crate_types.contains(&config::CrateType::ProcMacro);
465 // For backwards compatibility, we don't try to run proc macro injection
466 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
467 // specified. This should only affect users who manually invoke 'rustdoc', as
468 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
469 // However, we do emit a warning, to let such users know that they should
470 // start passing '--crate-type proc-macro'
471 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
472 let mut msg = sess.diagnostic().struct_warn(&"Trying to document proc macro crate \
473 without passing '--crate-type proc-macro to rustdoc");
475 msg.warn("The generated documentation may be incorrect");
478 krate = time(sess, "maybe creating a macro crate", || {
479 let num_crate_types = crate_types.len();
480 let is_test_crate = sess.opts.test;
481 syntax_ext::proc_macro_harness::inject(
486 has_proc_macro_decls,
494 // Done with macro expansion!
496 if sess.opts.debugging_opts.input_stats {
497 println!("Post-expansion node count: {}", count_nodes(&krate));
500 if sess.opts.debugging_opts.hir_stats {
501 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
504 if sess.opts.debugging_opts.ast_json {
505 println!("{}", json::as_json(&krate));
508 time(sess, "name resolution", || {
509 resolver.resolve_crate(&krate);
512 // Needs to go *after* expansion to be able to check the results of macro expansion.
513 time(sess, "complete gated feature checking", || {
514 syntax::feature_gate::check_crate(
517 &sess.features_untracked(),
518 sess.opts.unstable_features,
522 // Add all buffered lints from the `ParseSess` to the `Session`.
523 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
524 info!("{} parse sess buffered_lints", buffered_lints.len());
525 for BufferedEarlyLint{id, span, msg, lint_id} in buffered_lints.drain(..) {
526 let lint = lint::Lint::from_parser_lint_id(lint_id);
527 sess.buffer_lint(lint, id, span, &msg);
531 Ok((krate, resolver))
536 lint_store: &lint::LintStore,
538 resolver: &mut Resolver<'_>,
539 dep_graph: &DepGraph,
541 ) -> Result<hir::map::Forest> {
543 let hir_forest = time(sess, "lowering AST -> HIR", || {
544 let nt_to_tokenstream = syntax::parse::nt_to_tokenstream;
545 let hir_crate = lower_crate(sess, cstore, &dep_graph, &krate, resolver, nt_to_tokenstream);
547 if sess.opts.debugging_opts.hir_stats {
548 hir_stats::print_hir_stats(&hir_crate);
551 hir::map::Forest::new(hir_crate, &dep_graph)
554 time(sess, "early lint checks", || {
555 lint::check_ast_crate(
560 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
564 // Discard hygiene data, which isn't required after lowering to HIR.
565 if !sess.opts.debugging_opts.keep_hygiene_data {
566 syntax_expand::hygiene::clear_syntax_context_map();
572 // Returns all the paths that correspond to generated files.
573 fn generated_output_paths(
575 outputs: &OutputFilenames,
579 let mut out_filenames = Vec::new();
580 for output_type in sess.opts.output_types.keys() {
581 let file = outputs.path(*output_type);
583 // If the filename has been overridden using `-o`, it will not be modified
584 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
585 OutputType::Exe if !exact_name => for crate_type in sess.crate_types.borrow().iter() {
586 let p = ::rustc_codegen_utils::link::filename_for_input(
592 out_filenames.push(p);
594 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
595 // Don't add the dep-info output when omitting it from dep-info targets
598 out_filenames.push(file);
605 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
606 // returns None for every file path.
607 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
609 F: Fn(&PathBuf) -> Option<T>,
611 for output_path in output_paths {
612 if let Some(result) = f(output_path) {
619 fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
620 let input_path = input_path.canonicalize().ok();
621 if input_path.is_none() {
624 let check = |output_path: &PathBuf| {
625 if output_path.canonicalize().ok() == input_path {
631 check_output(output_paths, check).is_some()
634 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
635 let check = |output_path: &PathBuf| {
636 if output_path.is_dir() {
637 Some(output_path.clone())
642 check_output(output_paths, check)
645 fn escape_dep_filename(filename: &FileName) -> String {
646 // Apparently clang and gcc *only* escape spaces:
647 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
648 filename.to_string().replace(" ", "\\ ")
651 fn write_out_deps(compiler: &Compiler, outputs: &OutputFilenames, out_filenames: &[PathBuf]) {
652 let sess = &compiler.sess;
653 // Write out dependency rules to the dep-info file if requested
654 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
657 let deps_filename = outputs.path(OutputType::DepInfo);
659 let result = (|| -> io::Result<()> {
660 // Build a list of files used to compile the output and
661 // write Makefile-compatible dependency rules
662 let mut files: Vec<String> = sess.source_map()
665 .filter(|fmap| fmap.is_real_file())
666 .filter(|fmap| !fmap.is_imported())
667 .map(|fmap| escape_dep_filename(&fmap.unmapped_path.as_ref().unwrap_or(&fmap.name)))
670 if sess.binary_dep_depinfo() {
671 for cnum in compiler.cstore.crates_untracked() {
672 let source = compiler.cstore.crate_source_untracked(cnum);
673 if let Some((path, _)) = source.dylib {
674 files.push(escape_dep_filename(&FileName::Real(path)));
676 if let Some((path, _)) = source.rlib {
677 files.push(escape_dep_filename(&FileName::Real(path)));
679 if let Some((path, _)) = source.rmeta {
680 files.push(escape_dep_filename(&FileName::Real(path)));
685 let mut file = fs::File::create(&deps_filename)?;
686 for path in out_filenames {
687 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
690 // Emit a fake target for each input file to the compilation. This
691 // prevents `make` from spitting out an error if a file is later
692 // deleted. For more info see #28735
694 writeln!(file, "{}:", path)?;
701 if sess.opts.json_artifact_notifications {
702 sess.parse_sess.span_diagnostic
703 .emit_artifact_notification(&deps_filename, "dep-info");
708 "error writing dependencies to `{}`: {}",
709 deps_filename.display(),
716 pub fn prepare_outputs(
721 ) -> Result<OutputFilenames> {
722 // FIXME: rustdoc passes &[] instead of &krate.attrs here
723 let outputs = util::build_output_filenames(
725 &compiler.output_dir,
726 &compiler.output_file,
731 let output_paths = generated_output_paths(
734 compiler.output_file.is_some(),
738 // Ensure the source file isn't accidentally overwritten during compilation.
739 if let Some(ref input_path) = compiler.input_path {
740 if sess.opts.will_create_output_file() {
741 if output_contains_path(&output_paths, input_path) {
743 "the input file \"{}\" would be overwritten by the generated \
747 return Err(ErrorReported);
749 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
751 "the generated executable for the input file \"{}\" conflicts with the \
752 existing directory \"{}\"",
753 input_path.display(),
756 return Err(ErrorReported);
761 write_out_deps(compiler, &outputs, &output_paths);
763 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
764 && sess.opts.output_types.len() == 1;
767 if let Some(ref dir) = compiler.output_dir {
768 if fs::create_dir_all(dir).is_err() {
769 sess.err("failed to find or create the directory specified by `--out-dir`");
770 return Err(ErrorReported);
778 pub fn default_provide(providers: &mut ty::query::Providers<'_>) {
779 providers.analysis = analysis;
780 proc_macro_decls::provide(providers);
781 plugin::build::provide(providers);
782 hir::provide(providers);
783 mir::provide(providers);
784 reachable::provide(providers);
785 resolve_lifetime::provide(providers);
786 rustc_privacy::provide(providers);
787 typeck::provide(providers);
788 ty::provide(providers);
789 traits::provide(providers);
790 stability::provide(providers);
791 reachable::provide(providers);
792 rustc_passes::provide(providers);
793 rustc_traits::provide(providers);
794 middle::region::provide(providers);
795 cstore::provide(providers);
796 lint::provide(providers);
797 rustc_lint::provide(providers);
798 rustc_codegen_utils::provide(providers);
799 rustc_codegen_ssa::provide(providers);
802 pub fn default_provide_extern(providers: &mut ty::query::Providers<'_>) {
803 cstore::provide_extern(providers);
804 rustc_codegen_ssa::provide_extern(providers);
807 declare_box_region_type!(
810 (&'tcx GlobalCtxt<'tcx>) -> ((), ())
813 impl BoxedGlobalCtxt {
814 pub fn enter<F, R>(&mut self, f: F) -> R
816 F: for<'tcx> FnOnce(TyCtxt<'tcx>) -> R,
818 self.access(|gcx| ty::tls::enter_global(gcx, |tcx| f(tcx)))
822 pub fn create_global_ctxt(
824 lint_store: Lrc<lint::LintStore>,
825 mut hir_forest: hir::map::Forest,
826 defs: hir::map::Definitions,
827 resolutions: Resolutions,
828 outputs: OutputFilenames,
830 ) -> BoxedGlobalCtxt {
831 let sess = compiler.session().clone();
832 let cstore = compiler.cstore.clone();
833 let codegen_backend = compiler.codegen_backend().clone();
834 let crate_name = crate_name.to_string();
836 let ((), result) = BoxedGlobalCtxt::new(static move || {
838 let cstore = &*cstore;
840 let global_ctxt: Option<GlobalCtxt<'_>>;
841 let arenas = AllArenas::new();
843 // Construct the HIR map.
844 let hir_map = time(sess, "indexing HIR", || {
845 hir::map::map_crate(sess, cstore, &mut hir_forest, &defs)
848 let query_result_on_disk_cache = time(sess, "load query result cache", || {
849 rustc_incremental::load_query_result_cache(sess)
852 let mut local_providers = ty::query::Providers::default();
853 default_provide(&mut local_providers);
854 codegen_backend.provide(&mut local_providers);
856 let mut extern_providers = local_providers;
857 default_provide_extern(&mut extern_providers);
858 codegen_backend.provide_extern(&mut extern_providers);
860 let gcx = TyCtxt::create_global_ctxt(
869 query_result_on_disk_cache,
874 global_ctxt = Some(gcx);
875 let gcx = global_ctxt.as_ref().unwrap();
877 ty::tls::enter_global(gcx, |tcx| {
878 // Do some initialization of the DepGraph that can only be done with the
880 time(tcx.sess, "dep graph tcx init", || rustc_incremental::dep_graph_tcx_init(tcx));
883 yield BoxedGlobalCtxt::initial_yield(());
884 box_region_allow_access!(for('tcx), (&'tcx GlobalCtxt<'tcx>), (gcx));
886 if sess.opts.debugging_opts.query_stats {
887 gcx.queries.print_stats();
894 /// Runs the resolution, type-checking, region checking and other
895 /// miscellaneous analysis passes on the crate.
896 fn analysis(tcx: TyCtxt<'_>, cnum: CrateNum) -> Result<()> {
897 assert_eq!(cnum, LOCAL_CRATE);
900 let mut entry_point = None;
902 time(sess, "misc checking 1", || {
904 entry_point = time(sess, "looking for entry point", || {
905 rustc_passes::entry::find_entry_point(tcx)
908 time(sess, "looking for plugin registrar", || {
909 plugin::build::find_plugin_registrar(tcx)
912 time(sess, "looking for derive registrar", || {
913 proc_macro_decls::find(tcx)
916 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
917 let local_def_id = tcx.hir().local_def_id(module);
918 tcx.ensure().check_mod_loops(local_def_id);
919 tcx.ensure().check_mod_attrs(local_def_id);
920 tcx.ensure().check_mod_unstable_api_usage(local_def_id);
925 // passes are timed inside typeck
926 typeck::check_crate(tcx)?;
928 time(sess, "misc checking 2", || {
930 time(sess, "match checking", || {
931 tcx.par_body_owners(|def_id| {
932 tcx.ensure().check_match(def_id);
936 time(sess, "liveness checking + intrinsic checking", || {
937 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
938 // this must run before MIR dump, because
939 // "not all control paths return a value" is reported here.
941 // maybe move the check to a MIR pass?
942 let local_def_id = tcx.hir().local_def_id(module);
944 tcx.ensure().check_mod_liveness(local_def_id);
945 tcx.ensure().check_mod_intrinsics(local_def_id);
951 time(sess, "MIR borrow checking", || {
952 tcx.par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
955 time(sess, "dumping Chalk-like clauses", || {
956 rustc_traits::lowering::dump_program_clauses(tcx);
959 time(sess, "MIR effect checking", || {
960 for def_id in tcx.body_owners() {
961 mir::transform::check_unsafety::check_unsafety(tcx, def_id)
965 time(sess, "layout testing", || layout_test::test_layout(tcx));
967 // Avoid overwhelming user with errors if borrow checking failed.
968 // I'm not sure how helpful this is, to be honest, but it avoids a
969 // lot of annoying errors in the compile-fail tests (basically,
970 // lint warnings and so on -- kindck used to do this abort, but
971 // kindck is gone now). -nmatsakis
972 if sess.has_errors() {
973 return Err(ErrorReported);
976 time(sess, "misc checking 3", || {
978 time(sess, "privacy access levels", || {
979 tcx.ensure().privacy_access_levels(LOCAL_CRATE);
982 time(sess, "private in public", || {
983 tcx.ensure().check_private_in_public(LOCAL_CRATE);
986 time(sess, "death checking", || rustc_passes::dead::check_crate(tcx));
988 time(sess, "unused lib feature checking", || {
989 stability::check_unused_or_stable_features(tcx)
992 time(sess, "lint checking", || {
993 lint::check_crate(tcx, || rustc_lint::BuiltinCombinedLateLintPass::new());
997 time(sess, "privacy checking modules", || {
998 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
999 tcx.ensure().check_mod_privacy(tcx.hir().local_def_id(module));
1008 fn encode_and_write_metadata(
1010 outputs: &OutputFilenames,
1011 ) -> (middle::cstore::EncodedMetadata, bool) {
1012 #[derive(PartialEq, Eq, PartialOrd, Ord)]
1019 let metadata_kind = tcx.sess.crate_types.borrow().iter().map(|ty| {
1021 CrateType::Executable |
1022 CrateType::Staticlib |
1023 CrateType::Cdylib => MetadataKind::None,
1025 CrateType::Rlib => MetadataKind::Uncompressed,
1028 CrateType::ProcMacro => MetadataKind::Compressed,
1030 }).max().unwrap_or(MetadataKind::None);
1032 let metadata = match metadata_kind {
1033 MetadataKind::None => middle::cstore::EncodedMetadata::new(),
1034 MetadataKind::Uncompressed |
1035 MetadataKind::Compressed => tcx.encode_metadata(),
1038 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
1039 if need_metadata_file {
1040 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
1041 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
1042 // To avoid races with another rustc process scanning the output directory,
1043 // we need to write the file somewhere else and atomically move it to its
1044 // final destination, with an `fs::rename` call. In order for the rename to
1045 // always succeed, the temporary file needs to be on the same filesystem,
1046 // which is why we create it inside the output directory specifically.
1047 let metadata_tmpdir = TempFileBuilder::new()
1049 .tempdir_in(out_filename.parent().unwrap())
1050 .unwrap_or_else(|err| {
1051 tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err))
1053 let metadata_filename = emit_metadata(tcx.sess, &metadata, &metadata_tmpdir);
1054 if let Err(e) = fs::rename(&metadata_filename, &out_filename) {
1055 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
1057 if tcx.sess.opts.json_artifact_notifications {
1058 tcx.sess.parse_sess.span_diagnostic
1059 .emit_artifact_notification(&out_filename, "metadata");
1063 let need_metadata_module = metadata_kind == MetadataKind::Compressed;
1065 (metadata, need_metadata_module)
1068 /// Runs the codegen backend, after which the AST and analysis can
1070 pub fn start_codegen<'tcx>(
1071 codegen_backend: &dyn CodegenBackend,
1073 outputs: &OutputFilenames,
1075 if log_enabled!(::log::Level::Info) {
1076 println!("Pre-codegen");
1077 tcx.print_debug_stats();
1080 let (metadata, need_metadata_module) = time(tcx.sess, "metadata encoding and writing", || {
1081 encode_and_write_metadata(tcx, outputs)
1084 let codegen = time(tcx.sess, "codegen", move || {
1085 let _prof_timer = tcx.prof.generic_activity("codegen_crate");
1086 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1089 if log_enabled!(::log::Level::Info) {
1090 println!("Post-codegen");
1091 tcx.print_debug_stats();
1094 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1095 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, outputs) {
1096 tcx.sess.err(&format!("could not emit MIR: {}", e));
1097 tcx.sess.abort_if_errors();