1 use crate::interface::{Compiler, Result};
2 use crate::proc_macro_decls;
6 use once_cell::sync::Lazy;
7 use rustc_ast::mut_visit::MutVisitor;
8 use rustc_ast::{self, ast, visit};
9 use rustc_codegen_ssa::back::link::emit_metadata;
10 use rustc_codegen_ssa::traits::CodegenBackend;
11 use rustc_data_structures::sync::{par_iter, Lrc, OnceCell, ParallelIterator, WorkerLocal};
12 use rustc_data_structures::{box_region_allow_access, declare_box_region_type, parallel};
13 use rustc_errors::{ErrorReported, PResult};
14 use rustc_expand::base::ExtCtxt;
15 use rustc_hir::def_id::{CrateNum, LOCAL_CRATE};
16 use rustc_hir::definitions::Definitions;
18 use rustc_lint::LintStore;
19 use rustc_middle::arena::Arena;
20 use rustc_middle::dep_graph::DepGraph;
21 use rustc_middle::middle;
22 use rustc_middle::middle::cstore::{CrateStore, MetadataLoader, MetadataLoaderDyn};
23 use rustc_middle::ty::query::Providers;
24 use rustc_middle::ty::steal::Steal;
25 use rustc_middle::ty::{self, GlobalCtxt, ResolverOutputs, TyCtxt};
27 use rustc_mir_build as mir_build;
28 use rustc_parse::{parse_crate_from_file, parse_crate_from_source_str};
29 use rustc_passes::{self, hir_stats, layout_test};
30 use rustc_plugin_impl as plugin;
31 use rustc_resolve::{Resolver, ResolverArenas};
32 use rustc_session::config::{CrateType, Input, OutputFilenames, OutputType, PpMode, PpSourceMode};
33 use rustc_session::lint;
34 use rustc_session::output::{filename_for_input, filename_for_metadata};
35 use rustc_session::search_paths::PathKind;
36 use rustc_session::Session;
37 use rustc_span::symbol::Symbol;
38 use rustc_span::{FileName, RealFileName};
39 use rustc_trait_selection::traits;
40 use rustc_typeck as typeck;
42 use rustc_serialize::json;
43 use tempfile::Builder as TempFileBuilder;
46 use std::cell::RefCell;
47 use std::ffi::OsString;
48 use std::io::{self, BufWriter, Write};
49 use std::path::PathBuf;
51 use std::{env, fs, iter, mem};
53 pub fn parse<'a>(sess: &'a Session, input: &Input) -> PResult<'a, ast::Crate> {
54 let krate = sess.time("parse_crate", || match input {
55 Input::File(file) => parse_crate_from_file(file, &sess.parse_sess),
56 Input::Str { input, name } => {
57 parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess)
61 if sess.opts.debugging_opts.ast_json_noexpand {
62 println!("{}", json::as_json(&krate));
65 if sess.opts.debugging_opts.input_stats {
66 println!("Lines of code: {}", sess.source_map().count_lines());
67 println!("Pre-expansion node count: {}", count_nodes(&krate));
70 if let Some(ref s) = sess.opts.debugging_opts.show_span {
71 rustc_ast_passes::show_span::run(sess.diagnostic(), s, &krate);
74 if sess.opts.debugging_opts.hir_stats {
75 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
81 fn count_nodes(krate: &ast::Crate) -> usize {
82 let mut counter = rustc_ast_passes::node_count::NodeCounter::new();
83 visit::walk_crate(&mut counter, krate);
87 declare_box_region_type!(
90 (&mut Resolver<'_>) -> (Result<ast::Crate>, ResolverOutputs)
93 /// Runs the "early phases" of the compiler: initial `cfg` processing, loading compiler plugins,
94 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
95 /// harness if one is to be provided, injection of a dependency on the
96 /// standard library and prelude, and name resolution.
98 /// Returns `None` if we're aborting after handling -W help.
99 pub fn configure_and_expand(
101 lint_store: Lrc<LintStore>,
102 metadata_loader: Box<MetadataLoaderDyn>,
105 ) -> Result<(ast::Crate, BoxedResolver)> {
106 log::trace!("configure_and_expand");
107 // Currently, we ignore the name resolution data structures for the purposes of dependency
108 // tracking. Instead we will run name resolution and include its output in the hash of each
109 // item, much like we do for macro expansion. In other words, the hash reflects not just
110 // its contents but the results of name resolution on those contents. Hopefully we'll push
111 // this back at some point.
112 let crate_name = crate_name.to_string();
113 let (result, resolver) = BoxedResolver::new(static move |mut action| {
116 let resolver_arenas = Resolver::arenas();
117 let res = configure_and_expand_inner(
125 let mut resolver = match res {
127 yield BoxedResolver::initial_yield(Err(v));
130 Ok((krate, resolver)) => {
131 action = yield BoxedResolver::initial_yield(Ok(krate));
135 box_region_allow_access!(for(), (&mut Resolver<'_>), (&mut resolver), action);
136 resolver.into_outputs()
138 result.map(|k| (k, resolver))
142 pub fn to_resolver_outputs(resolver: Rc<RefCell<BoxedResolver>>) -> ResolverOutputs {
143 match Rc::try_unwrap(resolver) {
144 Ok(resolver) => resolver.into_inner().complete(),
145 Err(resolver) => resolver.borrow_mut().access(|resolver| resolver.clone_outputs()),
150 pub fn register_plugins<'a>(
152 metadata_loader: &'a dyn MetadataLoader,
153 register_lints: impl Fn(&Session, &mut LintStore),
154 mut krate: ast::Crate,
156 ) -> Result<(ast::Crate, Lrc<LintStore>)> {
157 krate = sess.time("attributes_injection", || {
158 rustc_builtin_macros::cmdline_attrs::inject(
161 &sess.opts.debugging_opts.crate_attr,
165 let (krate, features) = rustc_expand::config::features(sess, krate);
166 // these need to be set "early" so that expansion sees `quote` if enabled.
167 sess.init_features(features);
169 let crate_types = util::collect_crate_types(sess, &krate.attrs);
170 sess.init_crate_types(crate_types);
172 let disambiguator = util::compute_crate_disambiguator(sess);
173 sess.crate_disambiguator.set(disambiguator).expect("not yet initialized");
174 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator);
176 if sess.opts.incremental.is_some() {
177 sess.time("incr_comp_garbage_collect_session_directories", || {
178 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
180 "Error while trying to garbage collect incremental \
181 compilation cache directory: {}",
188 sess.time("recursion_limit", || {
189 middle::limits::update_limits(sess, &krate);
192 let mut lint_store = rustc_lint::new_lint_store(
193 sess.opts.debugging_opts.no_interleave_lints,
194 sess.unstable_options(),
196 register_lints(&sess, &mut lint_store);
199 sess.time("plugin_loading", || plugin::load::load_plugins(sess, metadata_loader, &krate));
200 sess.time("plugin_registration", || {
201 let mut registry = plugin::Registry { lint_store: &mut lint_store };
202 for registrar in registrars {
203 registrar(&mut registry);
207 Ok((krate, Lrc::new(lint_store)))
210 fn pre_expansion_lint(sess: &Session, lint_store: &LintStore, krate: &ast::Crate) {
211 sess.time("pre_AST_expansion_lint_checks", || {
212 rustc_lint::check_ast_crate(
218 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
223 fn configure_and_expand_inner<'a>(
225 lint_store: &'a LintStore,
226 mut krate: ast::Crate,
228 resolver_arenas: &'a ResolverArenas<'a>,
229 metadata_loader: &'a MetadataLoaderDyn,
230 ) -> Result<(ast::Crate, Resolver<'a>)> {
231 log::trace!("configure_and_expand_inner");
232 pre_expansion_lint(sess, lint_store, &krate);
234 let mut resolver = Resolver::new(sess, &krate, crate_name, metadata_loader, &resolver_arenas);
235 rustc_builtin_macros::register_builtin_macros(&mut resolver, sess.edition());
237 krate = sess.time("crate_injection", || {
238 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| Symbol::intern(s));
239 let (krate, name) = rustc_builtin_macros::standard_library_imports::inject(
245 if let Some(name) = name {
246 sess.parse_sess.injected_crate_name.set(name).expect("not yet initialized");
251 util::check_attr_crate_type(&sess, &krate.attrs, &mut resolver.lint_buffer());
254 krate = sess.time("macro_expand_crate", || {
255 // Windows dlls do not have rpaths, so they don't know how to find their
256 // dependencies. It's up to us to tell the system where to find all the
257 // dependent dlls. Note that this uses cfg!(windows) as opposed to
258 // targ_cfg because syntax extensions are always loaded for the host
259 // compiler, not for the target.
261 // This is somewhat of an inherently racy operation, however, as
262 // multiple threads calling this function could possibly continue
263 // extending PATH far beyond what it should. To solve this for now we
264 // just don't add any new elements to PATH which are already there
265 // within PATH. This is basically a targeted fix at #17360 for rustdoc
266 // which runs rustc in parallel but has been seen (#33844) to cause
267 // problems with PATH becoming too long.
268 let mut old_path = OsString::new();
270 old_path = env::var_os("PATH").unwrap_or(old_path);
271 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
272 for path in env::split_paths(&old_path) {
273 if !new_path.contains(&path) {
280 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
286 // Create the config for macro expansion
287 let features = sess.features_untracked();
288 let cfg = rustc_expand::expand::ExpansionConfig {
289 features: Some(&features),
290 recursion_limit: sess.recursion_limit(),
291 trace_mac: sess.opts.debugging_opts.trace_macros,
292 should_test: sess.opts.test,
293 span_debug: sess.opts.debugging_opts.span_debug,
294 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
297 let extern_mod_loaded = |k: &ast::Crate| pre_expansion_lint(sess, lint_store, k);
298 let mut ecx = ExtCtxt::new(&sess, cfg, &mut resolver, Some(&extern_mod_loaded));
300 // Expand macros now!
301 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
303 // The rest is error reporting
305 sess.time("check_unused_macros", || {
306 ecx.check_unused_macros();
309 let mut missing_fragment_specifiers: Vec<_> = ecx
312 .missing_fragment_specifiers
315 .map(|(span, node_id)| (*span, *node_id))
317 missing_fragment_specifiers.sort_unstable_by_key(|(span, _)| *span);
319 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
321 for (span, node_id) in missing_fragment_specifiers {
322 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
323 let msg = "missing fragment specifier";
324 resolver.lint_buffer().buffer_lint(lint, node_id, span, msg);
327 env::set_var("PATH", &old_path);
330 if recursion_limit_hit {
331 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
339 sess.time("maybe_building_test_harness", || {
340 rustc_builtin_macros::test_harness::inject(&sess, &mut resolver, &mut krate)
343 if let Some(PpMode::PpmSource(PpSourceMode::PpmEveryBodyLoops)) = sess.opts.pretty {
344 log::debug!("replacing bodies with loop {{}}");
345 util::ReplaceBodyWithLoop::new(&mut resolver).visit_crate(&mut krate);
348 let has_proc_macro_decls = sess.time("AST_validation", || {
349 rustc_ast_passes::ast_validation::check_crate(sess, &krate, &mut resolver.lint_buffer())
352 let crate_types = sess.crate_types();
353 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
355 // For backwards compatibility, we don't try to run proc macro injection
356 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
357 // specified. This should only affect users who manually invoke 'rustdoc', as
358 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
359 // However, we do emit a warning, to let such users know that they should
360 // start passing '--crate-type proc-macro'
361 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
362 let mut msg = sess.diagnostic().struct_warn(
363 &"Trying to document proc macro crate \
364 without passing '--crate-type proc-macro to rustdoc",
367 msg.warn("The generated documentation may be incorrect");
370 krate = sess.time("maybe_create_a_macro_crate", || {
371 let num_crate_types = crate_types.len();
372 let is_test_crate = sess.opts.test;
373 rustc_builtin_macros::proc_macro_harness::inject(
378 has_proc_macro_decls,
386 // Done with macro expansion!
388 if sess.opts.debugging_opts.input_stats {
389 println!("Post-expansion node count: {}", count_nodes(&krate));
392 if sess.opts.debugging_opts.hir_stats {
393 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
396 if sess.opts.debugging_opts.ast_json {
397 println!("{}", json::as_json(&krate));
400 resolver.resolve_crate(&krate);
402 // Needs to go *after* expansion to be able to check the results of macro expansion.
403 sess.time("complete_gated_feature_checking", || {
404 rustc_ast_passes::feature_gate::check_crate(&krate, sess);
407 // Add all buffered lints from the `ParseSess` to the `Session`.
408 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
409 info!("{} parse sess buffered_lints", buffered_lints.len());
410 for early_lint in buffered_lints.drain(..) {
411 resolver.lint_buffer().add_early_lint(early_lint);
415 Ok((krate, resolver))
418 pub fn lower_to_hir<'res, 'tcx>(
420 lint_store: &LintStore,
421 resolver: &'res mut Resolver<'_>,
422 dep_graph: &'res DepGraph,
423 krate: &'res ast::Crate,
424 arena: &'tcx rustc_ast_lowering::Arena<'tcx>,
426 // We're constructing the HIR here; we don't care what we will
427 // read, since we haven't even constructed the *input* to
429 dep_graph.assert_ignored();
432 let hir_crate = rustc_ast_lowering::lower_crate(
436 rustc_parse::nt_to_tokenstream,
440 if sess.opts.debugging_opts.hir_stats {
441 hir_stats::print_hir_stats(&hir_crate);
444 sess.time("early_lint_checks", || {
445 rustc_lint::check_ast_crate(
450 Some(std::mem::take(resolver.lint_buffer())),
451 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
455 // Discard hygiene data, which isn't required after lowering to HIR.
456 if !sess.opts.debugging_opts.keep_hygiene_data {
457 rustc_span::hygiene::clear_syntax_context_map();
463 // Returns all the paths that correspond to generated files.
464 fn generated_output_paths(
466 outputs: &OutputFilenames,
470 let mut out_filenames = Vec::new();
471 for output_type in sess.opts.output_types.keys() {
472 let file = outputs.path(*output_type);
474 // If the filename has been overridden using `-o`, it will not be modified
475 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
476 OutputType::Exe if !exact_name => {
477 for crate_type in sess.crate_types().iter() {
478 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
479 out_filenames.push(p);
482 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
483 // Don't add the dep-info output when omitting it from dep-info targets
486 out_filenames.push(file);
493 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
494 // returns None for every file path.
495 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
497 F: Fn(&PathBuf) -> Option<T>,
499 for output_path in output_paths {
500 if let Some(result) = f(output_path) {
507 fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
508 let input_path = input_path.canonicalize().ok();
509 if input_path.is_none() {
512 let check = |output_path: &PathBuf| {
513 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
515 check_output(output_paths, check).is_some()
518 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
519 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
520 check_output(output_paths, check)
523 fn escape_dep_filename(filename: &FileName) -> String {
524 // Apparently clang and gcc *only* escape spaces:
525 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
526 filename.to_string().replace(" ", "\\ ")
529 // Makefile comments only need escaping newlines and `\`.
530 // The result can be unescaped by anything that can unescape `escape_default` and friends.
531 fn escape_dep_env(symbol: Symbol) -> String {
532 let s = symbol.as_str();
533 let mut escaped = String::with_capacity(s.len());
536 '\n' => escaped.push_str(r"\n"),
537 '\r' => escaped.push_str(r"\r"),
538 '\\' => escaped.push_str(r"\\"),
539 _ => escaped.push(c),
547 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
548 outputs: &OutputFilenames,
549 out_filenames: &[PathBuf],
551 // Write out dependency rules to the dep-info file if requested
552 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
555 let deps_filename = outputs.path(OutputType::DepInfo);
557 let result = (|| -> io::Result<()> {
558 // Build a list of files used to compile the output and
559 // write Makefile-compatible dependency rules
560 let mut files: Vec<String> = sess
564 .filter(|fmap| fmap.is_real_file())
565 .filter(|fmap| !fmap.is_imported())
566 .map(|fmap| escape_dep_filename(&fmap.unmapped_path.as_ref().unwrap_or(&fmap.name)))
569 if sess.binary_dep_depinfo() {
570 boxed_resolver.borrow().borrow_mut().access(|resolver| {
571 for cnum in resolver.cstore().crates_untracked() {
572 let source = resolver.cstore().crate_source_untracked(cnum);
573 if let Some((path, _)) = source.dylib {
574 let file_name = FileName::Real(RealFileName::Named(path));
575 files.push(escape_dep_filename(&file_name));
577 if let Some((path, _)) = source.rlib {
578 let file_name = FileName::Real(RealFileName::Named(path));
579 files.push(escape_dep_filename(&file_name));
581 if let Some((path, _)) = source.rmeta {
582 let file_name = FileName::Real(RealFileName::Named(path));
583 files.push(escape_dep_filename(&file_name));
589 let mut file = BufWriter::new(fs::File::create(&deps_filename)?);
590 for path in out_filenames {
591 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
594 // Emit a fake target for each input file to the compilation. This
595 // prevents `make` from spitting out an error if a file is later
596 // deleted. For more info see #28735
598 writeln!(file, "{}:", path)?;
601 // Emit special comments with information about accessed environment variables.
602 let env_depinfo = sess.parse_sess.env_depinfo.borrow();
603 if !env_depinfo.is_empty() {
604 let mut envs: Vec<_> = env_depinfo
606 .map(|(k, v)| (escape_dep_env(*k), v.map(escape_dep_env)))
608 envs.sort_unstable();
611 write!(file, "# env-dep:{}", k)?;
613 write!(file, "={}", v)?;
624 if sess.opts.json_artifact_notifications {
627 .emit_artifact_notification(&deps_filename, "dep-info");
630 Err(e) => sess.fatal(&format!(
631 "error writing dependencies to `{}`: {}",
632 deps_filename.display(),
638 pub fn prepare_outputs(
642 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
644 ) -> Result<OutputFilenames> {
645 let _timer = sess.timer("prepare_outputs");
647 // FIXME: rustdoc passes &[] instead of &krate.attrs here
648 let outputs = util::build_output_filenames(
650 &compiler.output_dir,
651 &compiler.output_file,
657 generated_output_paths(sess, &outputs, compiler.output_file.is_some(), &crate_name);
659 // Ensure the source file isn't accidentally overwritten during compilation.
660 if let Some(ref input_path) = compiler.input_path {
661 if sess.opts.will_create_output_file() {
662 if output_contains_path(&output_paths, input_path) {
664 "the input file \"{}\" would be overwritten by the generated \
668 return Err(ErrorReported);
670 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
672 "the generated executable for the input file \"{}\" conflicts with the \
673 existing directory \"{}\"",
674 input_path.display(),
677 return Err(ErrorReported);
682 write_out_deps(sess, boxed_resolver, &outputs, &output_paths);
684 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
685 && sess.opts.output_types.len() == 1;
688 if let Some(ref dir) = compiler.output_dir {
689 if fs::create_dir_all(dir).is_err() {
690 sess.err("failed to find or create the directory specified by `--out-dir`");
691 return Err(ErrorReported);
699 pub static DEFAULT_QUERY_PROVIDERS: Lazy<Providers> = Lazy::new(|| {
700 let providers = &mut Providers::default();
701 providers.analysis = analysis;
702 proc_macro_decls::provide(providers);
703 plugin::build::provide(providers);
704 rustc_middle::hir::provide(providers);
705 mir::provide(providers);
706 mir_build::provide(providers);
707 rustc_privacy::provide(providers);
708 typeck::provide(providers);
709 ty::provide(providers);
710 traits::provide(providers);
711 rustc_passes::provide(providers);
712 rustc_resolve::provide(providers);
713 rustc_traits::provide(providers);
714 rustc_ty::provide(providers);
715 rustc_metadata::provide(providers);
716 rustc_lint::provide(providers);
717 rustc_symbol_mangling::provide(providers);
718 rustc_codegen_ssa::provide(providers);
722 pub static DEFAULT_EXTERN_QUERY_PROVIDERS: Lazy<Providers> = Lazy::new(|| {
723 let mut extern_providers = *DEFAULT_QUERY_PROVIDERS;
724 rustc_metadata::provide_extern(&mut extern_providers);
725 rustc_codegen_ssa::provide_extern(&mut extern_providers);
729 pub struct QueryContext<'tcx>(&'tcx GlobalCtxt<'tcx>);
731 impl<'tcx> QueryContext<'tcx> {
732 pub fn enter<F, R>(&mut self, f: F) -> R
734 F: FnOnce(TyCtxt<'tcx>) -> R,
736 let icx = ty::tls::ImplicitCtxt::new(self.0);
737 ty::tls::enter_context(&icx, |_| f(icx.tcx))
740 pub fn print_stats(&mut self) {
741 self.enter(ty::query::print_stats)
745 pub fn create_global_ctxt<'tcx>(
746 compiler: &'tcx Compiler,
747 lint_store: Lrc<LintStore>,
748 krate: &'tcx Crate<'tcx>,
750 mut resolver_outputs: ResolverOutputs,
751 outputs: OutputFilenames,
753 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
754 arena: &'tcx WorkerLocal<Arena<'tcx>>,
755 ) -> QueryContext<'tcx> {
756 let sess = &compiler.session();
757 let defs: &'tcx Definitions = arena.alloc(mem::replace(
758 &mut resolver_outputs.definitions,
759 Definitions::new(crate_name, sess.local_crate_disambiguator()),
762 let query_result_on_disk_cache = rustc_incremental::load_query_result_cache(sess);
764 let codegen_backend = compiler.codegen_backend();
765 let mut local_providers = *DEFAULT_QUERY_PROVIDERS;
766 codegen_backend.provide(&mut local_providers);
768 let mut extern_providers = *DEFAULT_EXTERN_QUERY_PROVIDERS;
769 codegen_backend.provide(&mut extern_providers);
770 codegen_backend.provide_extern(&mut extern_providers);
772 if let Some(callback) = compiler.override_queries {
773 callback(sess, &mut local_providers, &mut extern_providers);
776 let gcx = sess.time("setup_global_ctxt", || {
777 global_ctxt.get_or_init(|| {
778 TyCtxt::create_global_ctxt(
788 query_result_on_disk_cache,
795 // Do some initialization of the DepGraph that can only be done with the tcx available.
796 let icx = ty::tls::ImplicitCtxt::new(&gcx);
797 ty::tls::enter_context(&icx, |_| {
798 icx.tcx.sess.time("dep_graph_tcx_init", || rustc_incremental::dep_graph_tcx_init(icx.tcx));
804 /// Runs the resolution, type-checking, region checking and other
805 /// miscellaneous analysis passes on the crate.
806 fn analysis(tcx: TyCtxt<'_>, cnum: CrateNum) -> Result<()> {
807 assert_eq!(cnum, LOCAL_CRATE);
809 rustc_passes::hir_id_validator::check_crate(tcx);
812 let mut entry_point = None;
814 sess.time("misc_checking_1", || {
818 .time("looking_for_entry_point", || rustc_passes::entry::find_entry_point(tcx));
820 sess.time("looking_for_plugin_registrar", || {
821 plugin::build::find_plugin_registrar(tcx)
824 sess.time("looking_for_derive_registrar", || proc_macro_decls::find(tcx));
827 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
828 let local_def_id = tcx.hir().local_def_id(module);
829 tcx.ensure().check_mod_loops(local_def_id);
830 tcx.ensure().check_mod_attrs(local_def_id);
831 tcx.ensure().check_mod_unstable_api_usage(local_def_id);
832 tcx.ensure().check_mod_const_bodies(local_def_id);
838 // passes are timed inside typeck
839 typeck::check_crate(tcx)?;
841 sess.time("misc_checking_2", || {
844 sess.time("match_checking", || {
845 tcx.par_body_owners(|def_id| {
846 tcx.ensure().check_match(def_id.to_def_id());
851 sess.time("liveness_and_intrinsic_checking", || {
852 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
853 // this must run before MIR dump, because
854 // "not all control paths return a value" is reported here.
856 // maybe move the check to a MIR pass?
857 let local_def_id = tcx.hir().local_def_id(module);
859 tcx.ensure().check_mod_liveness(local_def_id);
860 tcx.ensure().check_mod_intrinsics(local_def_id);
867 sess.time("MIR_borrow_checking", || {
868 tcx.par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
871 sess.time("MIR_effect_checking", || {
872 for def_id in tcx.body_owners() {
873 mir::transform::check_unsafety::check_unsafety(tcx, def_id);
875 if tcx.hir().body_const_context(def_id).is_some() {
877 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::unknown(def_id));
882 sess.time("layout_testing", || layout_test::test_layout(tcx));
884 // Avoid overwhelming user with errors if borrow checking failed.
885 // I'm not sure how helpful this is, to be honest, but it avoids a
886 // lot of annoying errors in the compile-fail tests (basically,
887 // lint warnings and so on -- kindck used to do this abort, but
888 // kindck is gone now). -nmatsakis
889 if sess.has_errors() {
890 return Err(ErrorReported);
893 sess.time("misc_checking_3", || {
896 tcx.ensure().privacy_access_levels(LOCAL_CRATE);
900 tcx.ensure().check_private_in_public(LOCAL_CRATE);
903 sess.time("death_checking", || rustc_passes::dead::check_crate(tcx));
906 sess.time("unused_lib_feature_checking", || {
907 rustc_passes::stability::check_unused_or_stable_features(tcx)
911 sess.time("lint_checking", || {
912 rustc_lint::check_crate(tcx, || {
913 rustc_lint::BuiltinCombinedLateLintPass::new()
920 sess.time("privacy_checking_modules", || {
921 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
922 tcx.ensure().check_mod_privacy(tcx.hir().local_def_id(module));
932 fn encode_and_write_metadata(
934 outputs: &OutputFilenames,
935 ) -> (middle::cstore::EncodedMetadata, bool) {
936 #[derive(PartialEq, Eq, PartialOrd, Ord)]
943 let metadata_kind = tcx
947 .map(|ty| match *ty {
948 CrateType::Executable | CrateType::Staticlib | CrateType::Cdylib => MetadataKind::None,
950 CrateType::Rlib => MetadataKind::Uncompressed,
952 CrateType::Dylib | CrateType::ProcMacro => MetadataKind::Compressed,
955 .unwrap_or(MetadataKind::None);
957 let metadata = match metadata_kind {
958 MetadataKind::None => middle::cstore::EncodedMetadata::new(),
959 MetadataKind::Uncompressed | MetadataKind::Compressed => tcx.encode_metadata(),
962 let _prof_timer = tcx.sess.prof.generic_activity("write_crate_metadata");
964 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
965 if need_metadata_file {
966 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
967 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
968 // To avoid races with another rustc process scanning the output directory,
969 // we need to write the file somewhere else and atomically move it to its
970 // final destination, with an `fs::rename` call. In order for the rename to
971 // always succeed, the temporary file needs to be on the same filesystem,
972 // which is why we create it inside the output directory specifically.
973 let metadata_tmpdir = TempFileBuilder::new()
975 .tempdir_in(out_filename.parent().unwrap())
976 .unwrap_or_else(|err| tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err)));
977 let metadata_filename = emit_metadata(tcx.sess, &metadata, &metadata_tmpdir);
978 if let Err(e) = fs::rename(&metadata_filename, &out_filename) {
979 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
981 if tcx.sess.opts.json_artifact_notifications {
985 .emit_artifact_notification(&out_filename, "metadata");
989 let need_metadata_module = metadata_kind == MetadataKind::Compressed;
991 (metadata, need_metadata_module)
994 /// Runs the codegen backend, after which the AST and analysis can
996 pub fn start_codegen<'tcx>(
997 codegen_backend: &dyn CodegenBackend,
999 outputs: &OutputFilenames,
1001 info!("Pre-codegen\n{:?}", tcx.debug_stats());
1003 let (metadata, need_metadata_module) = encode_and_write_metadata(tcx, outputs);
1005 let codegen = tcx.sess.time("codegen_crate", move || {
1006 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1009 info!("Post-codegen\n{:?}", tcx.debug_stats());
1011 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1012 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, outputs) {
1013 tcx.sess.err(&format!("could not emit MIR: {}", e));
1014 tcx.sess.abort_if_errors();