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_ast_borrowck as borrowck;
21 use rustc_codegen_ssa::back::link::emit_metadata;
22 use rustc_codegen_utils::codegen_backend::CodegenBackend;
23 use rustc_codegen_utils::link::filename_for_metadata;
24 use rustc_data_structures::{box_region_allow_access, declare_box_region_type, parallel};
25 use rustc_data_structures::sync::{Lrc, ParallelIterator, par_iter};
26 use rustc_incremental;
27 use rustc_metadata::creader::CrateLoader;
28 use rustc_metadata::cstore::{self, CStore};
30 use rustc_passes::{self, ast_validation, hir_stats, layout_test};
31 use rustc_plugin as plugin;
32 use rustc_plugin::registry::Registry;
34 use rustc_resolve::{Resolver, ResolverArenas};
36 use rustc_typeck as typeck;
37 use syntax::{self, ast, diagnostics, visit};
38 use syntax::early_buffered_lints::BufferedEarlyLint;
39 use syntax::ext::base::{NamedSyntaxExtension, ExtCtxt};
40 use syntax::mut_visit::MutVisitor;
41 use syntax::parse::{self, PResult};
42 use syntax::util::node_count::NodeCounter;
43 use syntax::symbol::Symbol;
44 use syntax::feature_gate::AttributeType;
45 use syntax_pos::FileName;
48 use rustc_serialize::json;
49 use tempfile::Builder as TempFileBuilder;
53 use std::ffi::OsString;
55 use std::io::{self, Write};
57 use std::path::PathBuf;
59 use std::cell::RefCell;
63 pub fn parse<'a>(sess: &'a Session, input: &Input) -> PResult<'a, ast::Crate> {
65 .set_continue_after_error(sess.opts.debugging_opts.continue_parse_after_error);
66 sess.profiler(|p| p.start_activity("parsing"));
67 let krate = time(sess, "parsing", || match *input {
68 Input::File(ref file) => parse::parse_crate_from_file(file, &sess.parse_sess),
72 } => parse::parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess),
74 sess.profiler(|p| p.end_activity("parsing"));
76 sess.diagnostic().set_continue_after_error(true);
78 if sess.opts.debugging_opts.ast_json_noexpand {
79 println!("{}", json::as_json(&krate));
82 if sess.opts.debugging_opts.input_stats {
85 sess.source_map().count_lines()
87 println!("Pre-expansion node count: {}", count_nodes(&krate));
90 if let Some(ref s) = sess.opts.debugging_opts.show_span {
91 syntax::show_span::run(sess.diagnostic(), s, &krate);
94 if sess.opts.debugging_opts.hir_stats {
95 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
101 fn count_nodes(krate: &ast::Crate) -> usize {
102 let mut counter = NodeCounter::new();
103 visit::walk_crate(&mut counter, krate);
107 declare_box_region_type!(
110 (&mut Resolver<'_>) -> (Result<ast::Crate>, ExpansionResult)
113 /// Runs the "early phases" of the compiler: initial `cfg` processing,
114 /// loading compiler plugins (including those from `addl_plugins`),
115 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
116 /// harness if one is to be provided, injection of a dependency on the
117 /// standard library and prelude, and name resolution.
119 /// Returns `None` if we're aborting after handling -W help.
120 pub fn configure_and_expand(
125 plugin_info: PluginInfo,
126 ) -> Result<(ast::Crate, BoxedResolver)> {
127 // Currently, we ignore the name resolution data structures for the purposes of dependency
128 // tracking. Instead we will run name resolution and include its output in the hash of each
129 // item, much like we do for macro expansion. In other words, the hash reflects not just
130 // its contents but the results of name resolution on those contents. Hopefully we'll push
131 // this back at some point.
132 let crate_name = crate_name.to_string();
133 let (result, resolver) = BoxedResolver::new(static move || {
135 let mut crate_loader = CrateLoader::new(sess, &*cstore, &crate_name);
136 let resolver_arenas = Resolver::arenas();
137 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 export_map: resolver.export_map,
175 trait_map: resolver.trait_map,
176 glob_map: resolver.glob_map,
177 maybe_unused_trait_imports: resolver.maybe_unused_trait_imports,
178 maybe_unused_extern_crates: resolver.maybe_unused_extern_crates,
179 extern_prelude: resolver.extern_prelude.iter().map(|(ident, entry)| {
180 (ident.name, entry.introduced_by_item)
186 pub fn from_resolver_ref(
187 resolver: &Resolver<'_>,
190 defs: Steal::new(resolver.definitions.clone()),
191 resolutions: Steal::new(Resolutions {
192 export_map: resolver.export_map.clone(),
193 trait_map: resolver.trait_map.clone(),
194 glob_map: resolver.glob_map.clone(),
195 maybe_unused_trait_imports: resolver.maybe_unused_trait_imports.clone(),
196 maybe_unused_extern_crates: resolver.maybe_unused_extern_crates.clone(),
197 extern_prelude: resolver.extern_prelude.iter().map(|(ident, entry)| {
198 (ident.name, entry.introduced_by_item)
206 pub fn to_expansion_result(
207 mut resolver: Rc<Option<RefCell<BoxedResolver>>>,
208 ) -> ExpansionResult {
209 if let Some(resolver) = Rc::get_mut(&mut resolver) {
210 mem::replace(resolver, None).unwrap().into_inner().complete()
212 let resolver = &*resolver;
213 resolver.as_ref().unwrap().borrow_mut().access(|resolver| {
214 ExpansionResult::from_resolver_ref(resolver)
220 pub struct PluginInfo {
221 syntax_exts: Vec<NamedSyntaxExtension>,
222 attributes: Vec<(Symbol, AttributeType)>,
225 pub fn register_plugins<'a>(
229 mut krate: ast::Crate,
231 ) -> Result<(ast::Crate, PluginInfo)> {
232 krate = time(sess, "attributes injection", || {
233 syntax::attr::inject(krate, &sess.parse_sess, &sess.opts.debugging_opts.crate_attr)
236 let (mut krate, features) = syntax::config::features(
240 &sess.opts.debugging_opts.allow_features,
242 // these need to be set "early" so that expansion sees `quote` if enabled.
243 sess.init_features(features);
245 let crate_types = util::collect_crate_types(sess, &krate.attrs);
246 sess.crate_types.set(crate_types);
248 let disambiguator = util::compute_crate_disambiguator(sess);
249 sess.crate_disambiguator.set(disambiguator);
250 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator);
252 if sess.opts.incremental.is_some() {
253 time(sess, "garbage collect incremental cache directory", || {
254 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
256 "Error while trying to garbage collect incremental \
257 compilation cache directory: {}",
264 // If necessary, compute the dependency graph (in the background).
265 compiler.dep_graph_future().ok();
267 time(sess, "recursion limit", || {
268 middle::recursion_limit::update_limits(sess, &krate);
271 krate = time(sess, "crate injection", || {
272 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| &**s);
274 syntax_ext::standard_library_imports::inject(krate, alt_std_name, sess.edition());
275 if let Some(name) = name {
276 sess.parse_sess.injected_crate_name.set(name);
281 let registrars = time(sess, "plugin loading", || {
282 plugin::load::load_plugins(
287 Some(sess.opts.debugging_opts.extra_plugins.clone()),
291 let mut registry = Registry::new(sess, krate.span);
293 time(sess, "plugin registration", || {
294 if sess.features_untracked().rustc_diagnostic_macros {
295 registry.register_macro(
297 diagnostics::plugin::expand_diagnostic_used,
299 registry.register_macro(
300 "__register_diagnostic",
301 diagnostics::plugin::expand_register_diagnostic,
303 registry.register_macro(
304 "__build_diagnostic_array",
305 diagnostics::plugin::expand_build_diagnostic_array,
309 for registrar in registrars {
310 registry.args_hidden = Some(registrar.args);
311 (registrar.fun)(&mut registry);
325 let mut ls = sess.lint_store.borrow_mut();
326 for pass in early_lint_passes {
327 ls.register_early_pass(Some(sess), true, false, pass);
329 for pass in late_lint_passes {
330 ls.register_late_pass(Some(sess), true, false, false, pass);
333 for (name, (to, deprecated_name)) in lint_groups {
334 ls.register_group(Some(sess), true, name, deprecated_name, to);
337 *sess.plugin_llvm_passes.borrow_mut() = llvm_passes;
338 *sess.plugin_attributes.borrow_mut() = attributes.clone();
340 Ok((krate, PluginInfo {
346 fn configure_and_expand_inner<'a>(
349 mut krate: ast::Crate,
351 resolver_arenas: &'a ResolverArenas<'a>,
352 crate_loader: &'a mut CrateLoader<'a>,
353 plugin_info: PluginInfo,
354 ) -> Result<(ast::Crate, Resolver<'a>)> {
355 let attributes = plugin_info.attributes;
356 time(sess, "pre ast expansion lint checks", || {
357 lint::check_ast_crate(
361 rustc_lint::BuiltinCombinedPreExpansionLintPass::new());
364 let mut resolver = Resolver::new(
372 syntax_ext::register_builtin_macros(&mut resolver, sess.edition());
373 syntax_ext::plugin_macro_defs::inject(
374 &mut krate, &mut resolver, plugin_info.syntax_exts, sess.edition()
378 sess.profiler(|p| p.start_activity("macro expansion"));
379 krate = time(sess, "expansion", || {
380 // Windows dlls do not have rpaths, so they don't know how to find their
381 // dependencies. It's up to us to tell the system where to find all the
382 // dependent dlls. Note that this uses cfg!(windows) as opposed to
383 // targ_cfg because syntax extensions are always loaded for the host
384 // compiler, not for the target.
386 // This is somewhat of an inherently racy operation, however, as
387 // multiple threads calling this function could possibly continue
388 // extending PATH far beyond what it should. To solve this for now we
389 // just don't add any new elements to PATH which are already there
390 // within PATH. This is basically a targeted fix at #17360 for rustdoc
391 // which runs rustc in parallel but has been seen (#33844) to cause
392 // problems with PATH becoming too long.
393 let mut old_path = OsString::new();
395 old_path = env::var_os("PATH").unwrap_or(old_path);
396 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
397 for path in env::split_paths(&old_path) {
398 if !new_path.contains(&path) {
407 .filter(|p| env::join_paths(iter::once(p)).is_ok()),
412 // Create the config for macro expansion
413 let features = sess.features_untracked();
414 let cfg = syntax::ext::expand::ExpansionConfig {
415 features: Some(&features),
416 recursion_limit: *sess.recursion_limit.get(),
417 trace_mac: sess.opts.debugging_opts.trace_macros,
418 should_test: sess.opts.test,
419 ..syntax::ext::expand::ExpansionConfig::default(crate_name.to_string())
422 let mut ecx = ExtCtxt::new(&sess.parse_sess, cfg, &mut resolver);
424 // Expand macros now!
425 let krate = time(sess, "expand crate", || {
426 ecx.monotonic_expander().expand_crate(krate)
429 // The rest is error reporting
431 time(sess, "check unused macros", || {
432 ecx.check_unused_macros();
435 let mut missing_fragment_specifiers: Vec<_> = ecx.parse_sess
436 .missing_fragment_specifiers
441 missing_fragment_specifiers.sort();
443 for span in missing_fragment_specifiers {
444 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
445 let msg = "missing fragment specifier";
446 sess.buffer_lint(lint, ast::CRATE_NODE_ID, span, msg);
449 env::set_var("PATH", &old_path);
453 sess.profiler(|p| p.end_activity("macro expansion"));
455 time(sess, "maybe building test harness", || {
456 syntax_ext::test_harness::inject(
462 &sess.features_untracked(),
466 // If we're actually rustdoc then there's no need to actually compile
467 // anything, so switch everything to just looping
468 if sess.opts.actually_rustdoc {
469 util::ReplaceBodyWithLoop::new(sess).visit_crate(&mut krate);
472 let has_proc_macro_decls = time(sess, "AST validation", || {
473 ast_validation::check_crate(sess, &krate)
476 // If we're in rustdoc we're always compiling as an rlib, but that'll trip a
477 // bunch of checks in the `modify` function below. For now just skip this
478 // step entirely if we're rustdoc as it's not too useful anyway.
479 if !sess.opts.actually_rustdoc {
480 krate = time(sess, "maybe creating a macro crate", || {
481 let crate_types = sess.crate_types.borrow();
482 let num_crate_types = crate_types.len();
483 let is_proc_macro_crate = crate_types.contains(&config::CrateType::ProcMacro);
484 let is_test_crate = sess.opts.test;
485 syntax_ext::proc_macro_harness::inject(
490 has_proc_macro_decls,
498 // Done with macro expansion!
500 if sess.opts.debugging_opts.input_stats {
501 println!("Post-expansion node count: {}", count_nodes(&krate));
504 if sess.opts.debugging_opts.hir_stats {
505 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
508 if sess.opts.debugging_opts.ast_json {
509 println!("{}", json::as_json(&krate));
512 time(sess, "name resolution", || {
513 resolver.resolve_crate(&krate);
516 // Needs to go *after* expansion to be able to check the results of macro expansion.
517 time(sess, "complete gated feature checking", || {
518 syntax::feature_gate::check_crate(
521 &sess.features_untracked(),
523 sess.opts.unstable_features,
527 // Add all buffered lints from the `ParseSess` to the `Session`.
528 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
529 info!("{} parse sess buffered_lints", buffered_lints.len());
530 for BufferedEarlyLint{id, span, msg, lint_id} in buffered_lints.drain(..) {
531 let lint = lint::Lint::from_parser_lint_id(lint_id);
532 sess.buffer_lint(lint, id, span, &msg);
536 Ok((krate, resolver))
542 resolver: &mut Resolver<'_>,
543 dep_graph: &DepGraph,
545 ) -> Result<hir::map::Forest> {
547 let hir_forest = time(sess, "lowering ast -> hir", || {
548 let hir_crate = lower_crate(sess, cstore, &dep_graph, &krate, resolver);
550 if sess.opts.debugging_opts.hir_stats {
551 hir_stats::print_hir_stats(&hir_crate);
554 hir::map::Forest::new(hir_crate, &dep_graph)
557 time(sess, "early lint checks", || {
558 lint::check_ast_crate(sess, &krate, false, rustc_lint::BuiltinCombinedEarlyLintPass::new())
561 // Discard hygiene data, which isn't required after lowering to HIR.
562 if !sess.opts.debugging_opts.keep_hygiene_data {
563 syntax::ext::hygiene::clear_syntax_context_map();
569 // Returns all the paths that correspond to generated files.
570 fn generated_output_paths(
572 outputs: &OutputFilenames,
576 let mut out_filenames = Vec::new();
577 for output_type in sess.opts.output_types.keys() {
578 let file = outputs.path(*output_type);
580 // If the filename has been overridden using `-o`, it will not be modified
581 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
582 OutputType::Exe if !exact_name => for crate_type in sess.crate_types.borrow().iter() {
583 let p = ::rustc_codegen_utils::link::filename_for_input(
589 out_filenames.push(p);
591 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
592 // Don't add the dep-info output when omitting it from dep-info targets
595 out_filenames.push(file);
602 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
603 // returns None for every file path.
604 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
606 F: Fn(&PathBuf) -> Option<T>,
608 for output_path in output_paths {
609 if let Some(result) = f(output_path) {
616 fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
617 let input_path = input_path.canonicalize().ok();
618 if input_path.is_none() {
621 let check = |output_path: &PathBuf| {
622 if output_path.canonicalize().ok() == input_path {
628 check_output(output_paths, check).is_some()
631 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
632 let check = |output_path: &PathBuf| {
633 if output_path.is_dir() {
634 Some(output_path.clone())
639 check_output(output_paths, check)
642 fn escape_dep_filename(filename: &FileName) -> String {
643 // Apparently clang and gcc *only* escape spaces:
644 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
645 filename.to_string().replace(" ", "\\ ")
648 fn write_out_deps(compiler: &Compiler, outputs: &OutputFilenames, out_filenames: &[PathBuf]) {
649 let sess = &compiler.sess;
650 // Write out dependency rules to the dep-info file if requested
651 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
654 let deps_filename = outputs.path(OutputType::DepInfo);
656 let result = (|| -> io::Result<()> {
657 // Build a list of files used to compile the output and
658 // write Makefile-compatible dependency rules
659 let mut files: Vec<String> = sess.source_map()
662 .filter(|fmap| fmap.is_real_file())
663 .filter(|fmap| !fmap.is_imported())
664 .map(|fmap| escape_dep_filename(&fmap.name))
667 if sess.binary_dep_depinfo() {
668 for cnum in compiler.cstore.crates_untracked() {
669 let metadata = compiler.cstore.crate_data_as_rc_any(cnum);
670 let metadata = metadata.downcast_ref::<cstore::CrateMetadata>().unwrap();
671 if let Some((path, _)) = &metadata.source.dylib {
672 files.push(escape_dep_filename(&FileName::Real(path.clone())));
674 if let Some((path, _)) = &metadata.source.rlib {
675 files.push(escape_dep_filename(&FileName::Real(path.clone())));
677 if let Some((path, _)) = &metadata.source.rmeta {
678 files.push(escape_dep_filename(&FileName::Real(path.clone())));
683 let mut file = fs::File::create(&deps_filename)?;
684 for path in out_filenames {
685 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
688 // Emit a fake target for each input file to the compilation. This
689 // prevents `make` from spitting out an error if a file is later
690 // deleted. For more info see #28735
692 writeln!(file, "{}:", path)?;
699 if sess.opts.debugging_opts.emit_artifact_notifications {
700 sess.parse_sess.span_diagnostic
701 .emit_artifact_notification(&deps_filename, "dep-info");
706 "error writing dependencies to `{}`: {}",
707 deps_filename.display(),
714 pub fn prepare_outputs(
719 ) -> Result<OutputFilenames> {
720 // FIXME: rustdoc passes &[] instead of &krate.attrs here
721 let outputs = util::build_output_filenames(
723 &compiler.output_dir,
724 &compiler.output_file,
729 let output_paths = generated_output_paths(
732 compiler.output_file.is_some(),
736 // Ensure the source file isn't accidentally overwritten during compilation.
737 if let Some(ref input_path) = compiler.input_path {
738 if sess.opts.will_create_output_file() {
739 if output_contains_path(&output_paths, input_path) {
741 "the input file \"{}\" would be overwritten by the generated \
745 return Err(ErrorReported);
747 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
749 "the generated executable for the input file \"{}\" conflicts with the \
750 existing directory \"{}\"",
751 input_path.display(),
754 return Err(ErrorReported);
759 write_out_deps(compiler, &outputs, &output_paths);
761 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
762 && sess.opts.output_types.len() == 1;
765 if let Some(ref dir) = compiler.output_dir {
766 if fs::create_dir_all(dir).is_err() {
767 sess.err("failed to find or create the directory specified by --out-dir");
768 return Err(ErrorReported);
776 pub fn default_provide(providers: &mut ty::query::Providers<'_>) {
777 providers.analysis = analysis;
778 proc_macro_decls::provide(providers);
779 plugin::build::provide(providers);
780 hir::provide(providers);
781 borrowck::provide(providers);
782 mir::provide(providers);
783 reachable::provide(providers);
784 resolve_lifetime::provide(providers);
785 rustc_privacy::provide(providers);
786 typeck::provide(providers);
787 ty::provide(providers);
788 traits::provide(providers);
789 stability::provide(providers);
790 middle::intrinsicck::provide(providers);
791 middle::liveness::provide(providers);
792 reachable::provide(providers);
793 rustc_passes::provide(providers);
794 rustc_traits::provide(providers);
795 middle::region::provide(providers);
796 middle::entry::provide(providers);
797 cstore::provide(providers);
798 lint::provide(providers);
799 rustc_lint::provide(providers);
802 pub fn default_provide_extern(providers: &mut ty::query::Providers<'_>) {
803 cstore::provide_extern(providers);
806 declare_box_region_type!(
809 (&'tcx GlobalCtxt<'tcx>) -> ((), ())
812 impl BoxedGlobalCtxt {
813 pub fn enter<F, R>(&mut self, f: F) -> R
815 F: for<'tcx> FnOnce(TyCtxt<'tcx>) -> R,
817 self.access(|gcx| ty::tls::enter_global(gcx, |tcx| f(tcx)))
821 pub fn create_global_ctxt(
823 mut hir_forest: hir::map::Forest,
824 defs: hir::map::Definitions,
825 resolutions: Resolutions,
826 outputs: OutputFilenames,
827 tx: mpsc::Sender<Box<dyn Any + Send>>,
829 ) -> BoxedGlobalCtxt {
830 let sess = compiler.session().clone();
831 let cstore = compiler.cstore.clone();
832 let codegen_backend = compiler.codegen_backend().clone();
833 let crate_name = crate_name.to_string();
835 let ((), result) = BoxedGlobalCtxt::new(static move || {
837 let cstore = &*cstore;
839 let global_ctxt: Option<GlobalCtxt<'_>>;
840 let arenas = AllArenas::new();
842 // Construct the HIR map
843 let hir_map = time(sess, "indexing hir", || {
844 hir::map::map_crate(sess, cstore, &mut hir_forest, &defs)
847 let query_result_on_disk_cache = time(sess, "load query result cache", || {
848 rustc_incremental::load_query_result_cache(sess)
851 let mut local_providers = ty::query::Providers::default();
852 default_provide(&mut local_providers);
853 codegen_backend.provide(&mut local_providers);
855 let mut extern_providers = local_providers;
856 default_provide_extern(&mut extern_providers);
857 codegen_backend.provide_extern(&mut extern_providers);
859 let gcx = TyCtxt::create_global_ctxt(
867 query_result_on_disk_cache,
873 global_ctxt = Some(gcx);
874 let gcx = global_ctxt.as_ref().unwrap();
876 ty::tls::enter_global(gcx, |tcx| {
877 // Do some initialization of the DepGraph that can only be done with the
879 time(tcx.sess, "dep graph tcx init", || rustc_incremental::dep_graph_tcx_init(tcx));
882 yield BoxedGlobalCtxt::initial_yield(());
883 box_region_allow_access!(for('tcx), (&'tcx GlobalCtxt<'tcx>), (gcx));
885 if sess.opts.debugging_opts.query_stats {
886 gcx.queries.print_stats();
893 /// Runs the resolution, type-checking, region checking and other
894 /// miscellaneous analysis passes on the crate.
895 fn analysis(tcx: TyCtxt<'_>, cnum: CrateNum) -> Result<()> {
896 assert_eq!(cnum, LOCAL_CRATE);
899 let mut entry_point = None;
901 time(sess, "misc checking 1", || {
903 entry_point = time(sess, "looking for entry point", || {
904 middle::entry::find_entry_point(tcx)
907 time(sess, "looking for plugin registrar", || {
908 plugin::build::find_plugin_registrar(tcx)
911 time(sess, "looking for derive registrar", || {
912 proc_macro_decls::find(tcx)
915 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
916 tcx.ensure().check_mod_loops(tcx.hir().local_def_id_from_node_id(module));
917 tcx.ensure().check_mod_attrs(tcx.hir().local_def_id_from_node_id(module));
918 tcx.ensure().check_mod_unstable_api_usage(
919 tcx.hir().local_def_id_from_node_id(module));
924 // passes are timed inside typeck
925 typeck::check_crate(tcx)?;
927 time(sess, "misc checking 2", || {
929 time(sess, "rvalue promotion + match checking", || {
930 tcx.par_body_owners(|def_id| {
931 tcx.ensure().const_is_rvalue_promotable_to_static(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 tcx.ensure().check_mod_liveness(tcx.hir().local_def_id_from_node_id(module));
944 tcx.ensure().check_mod_intrinsics(tcx.hir().local_def_id_from_node_id(module));
950 time(sess, "borrow checking", || {
951 if tcx.use_ast_borrowck() {
952 borrowck::check_crate(tcx);
956 time(sess, "MIR borrow checking", || {
957 tcx.par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
960 time(sess, "dumping chalk-like clauses", || {
961 rustc_traits::lowering::dump_program_clauses(tcx);
964 time(sess, "MIR effect checking", || {
965 for def_id in tcx.body_owners() {
966 mir::transform::check_unsafety::check_unsafety(tcx, def_id)
970 time(sess, "layout testing", || layout_test::test_layout(tcx));
972 // Avoid overwhelming user with errors if borrow checking failed.
973 // I'm not sure how helpful this is, to be honest, but it avoids a
974 // lot of annoying errors in the compile-fail tests (basically,
975 // lint warnings and so on -- kindck used to do this abort, but
976 // kindck is gone now). -nmatsakis
977 if sess.has_errors() {
978 return Err(ErrorReported);
981 time(sess, "misc checking 3", || {
983 time(sess, "privacy access levels", || {
984 tcx.ensure().privacy_access_levels(LOCAL_CRATE);
987 time(sess, "private in public", || {
988 tcx.ensure().check_private_in_public(LOCAL_CRATE);
991 time(sess, "death checking", || middle::dead::check_crate(tcx));
993 time(sess, "unused lib feature checking", || {
994 stability::check_unused_or_stable_features(tcx)
997 time(sess, "lint checking", || {
998 lint::check_crate(tcx, || rustc_lint::BuiltinCombinedLateLintPass::new());
1002 time(sess, "privacy checking modules", || {
1003 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
1004 tcx.ensure().check_mod_privacy(tcx.hir().local_def_id_from_node_id(module));
1013 fn encode_and_write_metadata(
1015 outputs: &OutputFilenames,
1016 ) -> (middle::cstore::EncodedMetadata, bool) {
1017 #[derive(PartialEq, Eq, PartialOrd, Ord)]
1024 let metadata_kind = tcx.sess.crate_types.borrow().iter().map(|ty| {
1026 CrateType::Executable |
1027 CrateType::Staticlib |
1028 CrateType::Cdylib => MetadataKind::None,
1030 CrateType::Rlib => MetadataKind::Uncompressed,
1033 CrateType::ProcMacro => MetadataKind::Compressed,
1035 }).max().unwrap_or(MetadataKind::None);
1037 let metadata = match metadata_kind {
1038 MetadataKind::None => middle::cstore::EncodedMetadata::new(),
1039 MetadataKind::Uncompressed |
1040 MetadataKind::Compressed => tcx.encode_metadata(),
1043 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
1044 if need_metadata_file {
1045 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
1046 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
1047 // To avoid races with another rustc process scanning the output directory,
1048 // we need to write the file somewhere else and atomically move it to its
1049 // final destination, with an `fs::rename` call. In order for the rename to
1050 // always succeed, the temporary file needs to be on the same filesystem,
1051 // which is why we create it inside the output directory specifically.
1052 let metadata_tmpdir = TempFileBuilder::new()
1054 .tempdir_in(out_filename.parent().unwrap())
1055 .unwrap_or_else(|err| {
1056 tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err))
1058 let metadata_filename = emit_metadata(tcx.sess, &metadata, &metadata_tmpdir);
1059 if let Err(e) = fs::rename(&metadata_filename, &out_filename) {
1060 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
1062 if tcx.sess.opts.debugging_opts.emit_artifact_notifications {
1063 tcx.sess.parse_sess.span_diagnostic
1064 .emit_artifact_notification(&out_filename, "metadata");
1068 let need_metadata_module = metadata_kind == MetadataKind::Compressed;
1070 (metadata, need_metadata_module)
1073 /// Runs the codegen backend, after which the AST and analysis can
1075 pub fn start_codegen<'tcx>(
1076 codegen_backend: &dyn CodegenBackend,
1078 rx: mpsc::Receiver<Box<dyn Any + Send>>,
1079 outputs: &OutputFilenames,
1081 if log_enabled!(::log::Level::Info) {
1082 println!("Pre-codegen");
1083 tcx.print_debug_stats();
1086 time(tcx.sess, "resolving dependency formats", || {
1087 middle::dependency_format::calculate(tcx)
1090 let (metadata, need_metadata_module) = time(tcx.sess, "metadata encoding and writing", || {
1091 encode_and_write_metadata(tcx, outputs)
1094 tcx.sess.profiler(|p| p.start_activity("codegen crate"));
1095 let codegen = time(tcx.sess, "codegen", move || {
1096 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module, rx)
1098 tcx.sess.profiler(|p| p.end_activity("codegen crate"));
1100 if log_enabled!(::log::Level::Info) {
1101 println!("Post-codegen");
1102 tcx.print_debug_stats();
1105 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1106 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, outputs) {
1107 tcx.sess.err(&format!("could not emit MIR: {}", e));
1108 tcx.sess.abort_if_errors();