1 use crate::interface::{Compiler, Result};
2 use crate::proc_macro_decls;
5 use rustc_ast::mut_visit::MutVisitor;
6 use rustc_ast::{self as ast, visit};
7 use rustc_codegen_ssa::back::link::emit_metadata;
8 use rustc_codegen_ssa::traits::CodegenBackend;
9 use rustc_data_structures::steal::Steal;
10 use rustc_data_structures::sync::{par_iter, Lrc, OnceCell, ParallelIterator, WorkerLocal};
11 use rustc_data_structures::temp_dir::MaybeTempDir;
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::LOCAL_CRATE;
17 use rustc_lint::LintStore;
18 use rustc_metadata::creader::CStore;
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::{self, GlobalCtxt, ResolverOutputs, TyCtxt};
26 use rustc_mir_build as mir_build;
27 use rustc_parse::{parse_crate_from_file, parse_crate_from_source_str};
28 use rustc_passes::{self, hir_stats, layout_test};
29 use rustc_plugin_impl as plugin;
30 use rustc_query_impl::Queries as TcxQueries;
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::{Ident, Symbol};
38 use rustc_trait_selection::traits;
39 use rustc_typeck as typeck;
40 use tracing::{info, warn};
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::lazy::SyncLazy;
50 use std::path::PathBuf;
52 use std::{env, fs, iter};
54 pub fn parse<'a>(sess: &'a Session, input: &Input) -> PResult<'a, ast::Crate> {
55 let krate = sess.time("parse_crate", || match input {
56 Input::File(file) => parse_crate_from_file(file, &sess.parse_sess),
57 Input::Str { input, name } => {
58 parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess)
62 if sess.opts.debugging_opts.ast_json_noexpand {
63 println!("{}", json::as_json(&krate));
66 if sess.opts.debugging_opts.input_stats {
67 eprintln!("Lines of code: {}", sess.source_map().count_lines());
68 eprintln!("Pre-expansion node count: {}", count_nodes(&krate));
71 if let Some(ref s) = sess.opts.debugging_opts.show_span {
72 rustc_ast_passes::show_span::run(sess.diagnostic(), s, &krate);
75 if sess.opts.debugging_opts.hir_stats {
76 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
82 fn count_nodes(krate: &ast::Crate) -> usize {
83 let mut counter = rustc_ast_passes::node_count::NodeCounter::new();
84 visit::walk_crate(&mut counter, krate);
88 declare_box_region_type!(
91 (&mut Resolver<'_>) -> (Result<ast::Crate>, ResolverOutputs)
94 /// Runs the "early phases" of the compiler: initial `cfg` processing, loading compiler plugins,
95 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
96 /// harness if one is to be provided, injection of a dependency on the
97 /// standard library and prelude, and name resolution.
99 /// Returns [`None`] if we're aborting after handling -W help.
100 pub fn configure_and_expand(
102 lint_store: Lrc<LintStore>,
103 metadata_loader: Box<MetadataLoaderDyn>,
106 ) -> Result<(ast::Crate, BoxedResolver)> {
107 tracing::trace!("configure_and_expand");
108 // Currently, we ignore the name resolution data structures for the purposes of dependency
109 // tracking. Instead we will run name resolution and include its output in the hash of each
110 // item, much like we do for macro expansion. In other words, the hash reflects not just
111 // its contents but the results of name resolution on those contents. Hopefully we'll push
112 // this back at some point.
113 let crate_name = crate_name.to_string();
114 let (result, resolver) = BoxedResolver::new(static move |mut action| {
117 let resolver_arenas = Resolver::arenas();
118 let res = configure_and_expand_inner(
126 let mut resolver = match res {
128 yield BoxedResolver::initial_yield(Err(v));
131 Ok((krate, resolver)) => {
132 action = yield BoxedResolver::initial_yield(Ok(krate));
136 box_region_allow_access!(for(), (&mut Resolver<'_>), (&mut resolver), action);
137 resolver.into_outputs()
139 result.map(|k| (k, resolver))
143 pub fn to_resolver_outputs(resolver: Rc<RefCell<BoxedResolver>>) -> ResolverOutputs {
144 match Rc::try_unwrap(resolver) {
145 Ok(resolver) => resolver.into_inner().complete(),
146 Err(resolver) => resolver.borrow_mut().access(|resolver| resolver.clone_outputs()),
151 pub fn register_plugins<'a>(
153 metadata_loader: &'a dyn MetadataLoader,
154 register_lints: impl Fn(&Session, &mut LintStore),
155 mut krate: ast::Crate,
157 ) -> Result<(ast::Crate, Lrc<LintStore>)> {
158 krate = sess.time("attributes_injection", || {
159 rustc_builtin_macros::cmdline_attrs::inject(
162 &sess.opts.debugging_opts.crate_attr,
166 let (krate, features) = rustc_expand::config::features(sess, krate);
167 // these need to be set "early" so that expansion sees `quote` if enabled.
168 sess.init_features(features);
170 let crate_types = util::collect_crate_types(sess, &krate.attrs);
171 sess.init_crate_types(crate_types);
173 let disambiguator = util::compute_crate_disambiguator(sess);
174 sess.crate_disambiguator.set(disambiguator).expect("not yet initialized");
175 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator)?;
177 if sess.opts.incremental.is_some() {
178 sess.time("incr_comp_garbage_collect_session_directories", || {
179 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
181 "Error while trying to garbage collect incremental \
182 compilation cache directory: {}",
189 sess.time("recursion_limit", || {
190 middle::limits::update_limits(sess, &krate);
193 let mut lint_store = rustc_lint::new_lint_store(
194 sess.opts.debugging_opts.no_interleave_lints,
195 sess.unstable_options(),
197 register_lints(&sess, &mut lint_store);
200 sess.time("plugin_loading", || plugin::load::load_plugins(sess, metadata_loader, &krate));
201 sess.time("plugin_registration", || {
202 let mut registry = plugin::Registry { lint_store: &mut lint_store };
203 for registrar in registrars {
204 registrar(&mut registry);
208 let lint_store = Lrc::new(lint_store);
209 sess.init_lint_store(lint_store.clone());
211 Ok((krate, lint_store))
214 fn pre_expansion_lint(
216 lint_store: &LintStore,
220 sess.prof.generic_activity_with_arg("pre_AST_expansion_lint_checks", crate_name).run(|| {
221 rustc_lint::check_ast_crate(
227 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
232 fn configure_and_expand_inner<'a>(
234 lint_store: &'a LintStore,
235 mut krate: ast::Crate,
237 resolver_arenas: &'a ResolverArenas<'a>,
238 metadata_loader: &'a MetadataLoaderDyn,
239 ) -> Result<(ast::Crate, Resolver<'a>)> {
240 tracing::trace!("configure_and_expand_inner");
241 pre_expansion_lint(sess, lint_store, &krate, crate_name);
243 let mut resolver = Resolver::new(sess, &krate, crate_name, metadata_loader, &resolver_arenas);
244 rustc_builtin_macros::register_builtin_macros(&mut resolver);
246 krate = sess.time("crate_injection", || {
247 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| Symbol::intern(s));
248 rustc_builtin_macros::standard_library_imports::inject(
256 util::check_attr_crate_type(&sess, &krate.attrs, &mut resolver.lint_buffer());
259 krate = sess.time("macro_expand_crate", || {
260 // Windows dlls do not have rpaths, so they don't know how to find their
261 // dependencies. It's up to us to tell the system where to find all the
262 // dependent dlls. Note that this uses cfg!(windows) as opposed to
263 // targ_cfg because syntax extensions are always loaded for the host
264 // compiler, not for the target.
266 // This is somewhat of an inherently racy operation, however, as
267 // multiple threads calling this function could possibly continue
268 // extending PATH far beyond what it should. To solve this for now we
269 // just don't add any new elements to PATH which are already there
270 // within PATH. This is basically a targeted fix at #17360 for rustdoc
271 // which runs rustc in parallel but has been seen (#33844) to cause
272 // problems with PATH becoming too long.
273 let mut old_path = OsString::new();
275 old_path = env::var_os("PATH").unwrap_or(old_path);
276 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
277 for path in env::split_paths(&old_path) {
278 if !new_path.contains(&path) {
285 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
291 // Create the config for macro expansion
292 let features = sess.features_untracked();
293 let cfg = rustc_expand::expand::ExpansionConfig {
294 features: Some(&features),
295 recursion_limit: sess.recursion_limit(),
296 trace_mac: sess.opts.debugging_opts.trace_macros,
297 should_test: sess.opts.test,
298 span_debug: sess.opts.debugging_opts.span_debug,
299 proc_macro_backtrace: sess.opts.debugging_opts.proc_macro_backtrace,
300 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
303 let extern_mod_loaded = |ident: Ident, attrs, items, span| {
304 let krate = ast::Crate { attrs, items, span, proc_macros: vec![] };
305 pre_expansion_lint(sess, lint_store, &krate, &ident.name.as_str());
306 (krate.attrs, krate.items)
308 let mut ecx = ExtCtxt::new(&sess, cfg, &mut resolver, Some(&extern_mod_loaded));
310 // Expand macros now!
311 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
313 // The rest is error reporting
315 sess.time("check_unused_macros", || {
316 ecx.check_unused_macros();
319 let mut missing_fragment_specifiers: Vec<_> = ecx
322 .missing_fragment_specifiers
325 .map(|(span, node_id)| (*span, *node_id))
327 missing_fragment_specifiers.sort_unstable_by_key(|(span, _)| *span);
329 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
331 for (span, node_id) in missing_fragment_specifiers {
332 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
333 let msg = "missing fragment specifier";
334 resolver.lint_buffer().buffer_lint(lint, node_id, span, msg);
337 env::set_var("PATH", &old_path);
340 if recursion_limit_hit {
341 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
349 sess.time("maybe_building_test_harness", || {
350 rustc_builtin_macros::test_harness::inject(&sess, &mut resolver, &mut krate)
353 if let Some(PpMode::Source(PpSourceMode::EveryBodyLoops)) = sess.opts.pretty {
354 tracing::debug!("replacing bodies with loop {{}}");
355 util::ReplaceBodyWithLoop::new(&mut resolver).visit_crate(&mut krate);
358 let has_proc_macro_decls = sess.time("AST_validation", || {
359 rustc_ast_passes::ast_validation::check_crate(sess, &krate, &mut resolver.lint_buffer())
362 let crate_types = sess.crate_types();
363 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
365 // For backwards compatibility, we don't try to run proc macro injection
366 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
367 // specified. This should only affect users who manually invoke 'rustdoc', as
368 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
369 // However, we do emit a warning, to let such users know that they should
370 // start passing '--crate-type proc-macro'
371 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
372 let mut msg = sess.diagnostic().struct_warn(
373 &"Trying to document proc macro crate \
374 without passing '--crate-type proc-macro to rustdoc",
377 msg.warn("The generated documentation may be incorrect");
380 krate = sess.time("maybe_create_a_macro_crate", || {
381 let num_crate_types = crate_types.len();
382 let is_test_crate = sess.opts.test;
383 rustc_builtin_macros::proc_macro_harness::inject(
388 has_proc_macro_decls,
396 // Done with macro expansion!
398 if sess.opts.debugging_opts.input_stats {
399 eprintln!("Post-expansion node count: {}", count_nodes(&krate));
402 if sess.opts.debugging_opts.hir_stats {
403 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
406 if sess.opts.debugging_opts.ast_json {
407 println!("{}", json::as_json(&krate));
410 resolver.resolve_crate(&krate);
412 // Needs to go *after* expansion to be able to check the results of macro expansion.
413 sess.time("complete_gated_feature_checking", || {
414 rustc_ast_passes::feature_gate::check_crate(&krate, sess);
417 // Add all buffered lints from the `ParseSess` to the `Session`.
418 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
419 info!("{} parse sess buffered_lints", buffered_lints.len());
420 for early_lint in buffered_lints.drain(..) {
421 resolver.lint_buffer().add_early_lint(early_lint);
425 Ok((krate, resolver))
428 pub fn lower_to_hir<'res, 'tcx>(
430 lint_store: &LintStore,
431 resolver: &'res mut Resolver<'_>,
432 dep_graph: &'res DepGraph,
433 krate: &'res ast::Crate,
434 arena: &'tcx rustc_ast_lowering::Arena<'tcx>,
436 // We're constructing the HIR here; we don't care what we will
437 // read, since we haven't even constructed the *input* to
439 dep_graph.assert_ignored();
442 let hir_crate = rustc_ast_lowering::lower_crate(
446 rustc_parse::nt_to_tokenstream,
450 if sess.opts.debugging_opts.hir_stats {
451 hir_stats::print_hir_stats(&hir_crate);
454 sess.time("early_lint_checks", || {
455 rustc_lint::check_ast_crate(
460 Some(std::mem::take(resolver.lint_buffer())),
461 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
465 // Discard hygiene data, which isn't required after lowering to HIR.
466 if !sess.opts.debugging_opts.keep_hygiene_data {
467 rustc_span::hygiene::clear_syntax_context_map();
473 // Returns all the paths that correspond to generated files.
474 fn generated_output_paths(
476 outputs: &OutputFilenames,
480 let mut out_filenames = Vec::new();
481 for output_type in sess.opts.output_types.keys() {
482 let file = outputs.path(*output_type);
484 // If the filename has been overridden using `-o`, it will not be modified
485 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
486 OutputType::Exe if !exact_name => {
487 for crate_type in sess.crate_types().iter() {
488 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
489 out_filenames.push(p);
492 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
493 // Don't add the dep-info output when omitting it from dep-info targets
496 out_filenames.push(file);
503 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
504 // returns None for every file path.
505 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
507 F: Fn(&PathBuf) -> Option<T>,
509 for output_path in output_paths {
510 if let Some(result) = f(output_path) {
517 fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
518 let input_path = input_path.canonicalize().ok();
519 if input_path.is_none() {
522 let check = |output_path: &PathBuf| {
523 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
525 check_output(output_paths, check).is_some()
528 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
529 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
530 check_output(output_paths, check)
533 fn escape_dep_filename(filename: &String) -> String {
534 // Apparently clang and gcc *only* escape spaces:
535 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
536 filename.replace(" ", "\\ ")
539 // Makefile comments only need escaping newlines and `\`.
540 // The result can be unescaped by anything that can unescape `escape_default` and friends.
541 fn escape_dep_env(symbol: Symbol) -> String {
542 let s = symbol.as_str();
543 let mut escaped = String::with_capacity(s.len());
546 '\n' => escaped.push_str(r"\n"),
547 '\r' => escaped.push_str(r"\r"),
548 '\\' => escaped.push_str(r"\\"),
549 _ => escaped.push(c),
557 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
558 outputs: &OutputFilenames,
559 out_filenames: &[PathBuf],
561 // Write out dependency rules to the dep-info file if requested
562 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
565 let deps_filename = outputs.path(OutputType::DepInfo);
567 let result = (|| -> io::Result<()> {
568 // Build a list of files used to compile the output and
569 // write Makefile-compatible dependency rules
570 let mut files: Vec<String> = sess
574 .filter(|fmap| fmap.is_real_file())
575 .filter(|fmap| !fmap.is_imported())
576 .map(|fmap| escape_dep_filename(&fmap.name.prefer_local().to_string()))
579 if let Some(ref backend) = sess.opts.debugging_opts.codegen_backend {
580 files.push(backend.to_string());
583 if sess.binary_dep_depinfo() {
584 boxed_resolver.borrow().borrow_mut().access(|resolver| {
585 for cnum in resolver.cstore().crates_untracked() {
586 let source = resolver.cstore().crate_source_untracked(cnum);
587 if let Some((path, _)) = source.dylib {
588 files.push(escape_dep_filename(&path.display().to_string()));
590 if let Some((path, _)) = source.rlib {
591 files.push(escape_dep_filename(&path.display().to_string()));
593 if let Some((path, _)) = source.rmeta {
594 files.push(escape_dep_filename(&path.display().to_string()));
600 let mut file = BufWriter::new(fs::File::create(&deps_filename)?);
601 for path in out_filenames {
602 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
605 // Emit a fake target for each input file to the compilation. This
606 // prevents `make` from spitting out an error if a file is later
607 // deleted. For more info see #28735
609 writeln!(file, "{}:", path)?;
612 // Emit special comments with information about accessed environment variables.
613 let env_depinfo = sess.parse_sess.env_depinfo.borrow();
614 if !env_depinfo.is_empty() {
615 let mut envs: Vec<_> = env_depinfo
617 .map(|(k, v)| (escape_dep_env(*k), v.map(escape_dep_env)))
619 envs.sort_unstable();
622 write!(file, "# env-dep:{}", k)?;
624 write!(file, "={}", v)?;
635 if sess.opts.json_artifact_notifications {
638 .emit_artifact_notification(&deps_filename, "dep-info");
641 Err(e) => sess.fatal(&format!(
642 "error writing dependencies to `{}`: {}",
643 deps_filename.display(),
649 pub fn prepare_outputs(
653 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
655 ) -> Result<OutputFilenames> {
656 let _timer = sess.timer("prepare_outputs");
658 // FIXME: rustdoc passes &[] instead of &krate.attrs here
659 let outputs = util::build_output_filenames(
661 &compiler.output_dir,
662 &compiler.output_file,
668 generated_output_paths(sess, &outputs, compiler.output_file.is_some(), &crate_name);
670 // Ensure the source file isn't accidentally overwritten during compilation.
671 if let Some(ref input_path) = compiler.input_path {
672 if sess.opts.will_create_output_file() {
673 if output_contains_path(&output_paths, input_path) {
675 "the input file \"{}\" would be overwritten by the generated \
679 return Err(ErrorReported);
681 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
683 "the generated executable for the input file \"{}\" conflicts with the \
684 existing directory \"{}\"",
685 input_path.display(),
688 return Err(ErrorReported);
693 write_out_deps(sess, boxed_resolver, &outputs, &output_paths);
695 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
696 && sess.opts.output_types.len() == 1;
699 if let Some(ref dir) = compiler.output_dir {
700 if fs::create_dir_all(dir).is_err() {
701 sess.err("failed to find or create the directory specified by `--out-dir`");
702 return Err(ErrorReported);
710 pub static DEFAULT_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
711 let providers = &mut Providers::default();
712 providers.analysis = analysis;
713 proc_macro_decls::provide(providers);
714 plugin::build::provide(providers);
715 rustc_middle::hir::provide(providers);
716 mir::provide(providers);
717 mir_build::provide(providers);
718 rustc_privacy::provide(providers);
719 typeck::provide(providers);
720 ty::provide(providers);
721 traits::provide(providers);
722 rustc_passes::provide(providers);
723 rustc_resolve::provide(providers);
724 rustc_traits::provide(providers);
725 rustc_ty_utils::provide(providers);
726 rustc_metadata::provide(providers);
727 rustc_lint::provide(providers);
728 rustc_symbol_mangling::provide(providers);
729 rustc_codegen_ssa::provide(providers);
733 pub static DEFAULT_EXTERN_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
734 let mut extern_providers = *DEFAULT_QUERY_PROVIDERS;
735 rustc_metadata::provide_extern(&mut extern_providers);
736 rustc_codegen_ssa::provide_extern(&mut extern_providers);
740 pub struct QueryContext<'tcx> {
741 gcx: &'tcx GlobalCtxt<'tcx>,
744 impl<'tcx> QueryContext<'tcx> {
745 pub fn enter<F, R>(&mut self, f: F) -> R
747 F: FnOnce(TyCtxt<'tcx>) -> R,
749 let icx = ty::tls::ImplicitCtxt::new(self.gcx);
750 ty::tls::enter_context(&icx, |_| f(icx.tcx))
754 pub fn create_global_ctxt<'tcx>(
755 compiler: &'tcx Compiler,
756 lint_store: Lrc<LintStore>,
757 krate: &'tcx Crate<'tcx>,
759 resolver_outputs: ResolverOutputs,
760 outputs: OutputFilenames,
762 queries: &'tcx OnceCell<TcxQueries<'tcx>>,
763 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
764 arena: &'tcx WorkerLocal<Arena<'tcx>>,
765 ) -> QueryContext<'tcx> {
766 let sess = &compiler.session();
768 let def_path_table = resolver_outputs.definitions.def_path_table();
769 let query_result_on_disk_cache =
770 rustc_incremental::load_query_result_cache(sess, def_path_table);
772 let codegen_backend = compiler.codegen_backend();
773 let mut local_providers = *DEFAULT_QUERY_PROVIDERS;
774 codegen_backend.provide(&mut local_providers);
776 let mut extern_providers = *DEFAULT_EXTERN_QUERY_PROVIDERS;
777 codegen_backend.provide(&mut extern_providers);
778 codegen_backend.provide_extern(&mut extern_providers);
780 if let Some(callback) = compiler.override_queries {
781 callback(sess, &mut local_providers, &mut extern_providers);
784 let queries = queries.get_or_init(|| TcxQueries::new(local_providers, extern_providers));
786 let gcx = sess.time("setup_global_ctxt", || {
787 global_ctxt.get_or_init(|| {
788 TyCtxt::create_global_ctxt(
795 query_result_on_disk_cache,
806 /// Runs the resolution, type-checking, region checking and other
807 /// miscellaneous analysis passes on the crate.
808 fn analysis(tcx: TyCtxt<'_>, (): ()) -> Result<()> {
809 rustc_passes::hir_id_validator::check_crate(tcx);
812 let mut entry_point = None;
814 sess.time("misc_checking_1", || {
817 entry_point = sess.time("looking_for_entry_point", || tcx.entry_fn(()));
819 sess.time("looking_for_plugin_registrar", || tcx.ensure().plugin_registrar_fn(()));
821 sess.time("looking_for_derive_registrar", || {
822 tcx.ensure().proc_macro_decls_static(())
827 .downcast_ref::<CStore>()
828 .expect("`tcx.cstore` is not a `CStore`");
829 cstore.report_unused_deps(tcx);
832 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
833 tcx.ensure().check_mod_loops(module);
834 tcx.ensure().check_mod_attrs(module);
835 tcx.ensure().check_mod_naked_functions(module);
836 tcx.ensure().check_mod_unstable_api_usage(module);
837 tcx.ensure().check_mod_const_bodies(module);
843 // passes are timed inside typeck
844 typeck::check_crate(tcx)?;
846 sess.time("misc_checking_2", || {
849 sess.time("match_checking", || {
850 tcx.par_body_owners(|def_id| {
851 tcx.ensure().check_match(def_id.to_def_id());
856 sess.time("liveness_and_intrinsic_checking", || {
857 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
858 // this must run before MIR dump, because
859 // "not all control paths return a value" is reported here.
861 // maybe move the check to a MIR pass?
862 tcx.ensure().check_mod_liveness(module);
863 tcx.ensure().check_mod_intrinsics(module);
870 sess.time("MIR_borrow_checking", || {
871 tcx.par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
874 sess.time("MIR_effect_checking", || {
875 for def_id in tcx.body_owners() {
876 tcx.ensure().thir_check_unsafety(def_id);
877 if !tcx.sess.opts.debugging_opts.thir_unsafeck {
878 mir::transform::check_unsafety::check_unsafety(tcx, def_id);
881 if tcx.hir().body_const_context(def_id).is_some() {
883 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::unknown(def_id));
888 sess.time("layout_testing", || layout_test::test_layout(tcx));
890 // Avoid overwhelming user with errors if borrow checking failed.
891 // I'm not sure how helpful this is, to be honest, but it avoids a
892 // lot of annoying errors in the ui tests (basically,
893 // lint warnings and so on -- kindck used to do this abort, but
894 // kindck is gone now). -nmatsakis
895 if sess.has_errors() {
896 return Err(ErrorReported);
899 sess.time("misc_checking_3", || {
902 tcx.ensure().privacy_access_levels(());
906 tcx.ensure().check_private_in_public(());
909 sess.time("death_checking", || rustc_passes::dead::check_crate(tcx));
912 sess.time("unused_lib_feature_checking", || {
913 rustc_passes::stability::check_unused_or_stable_features(tcx)
917 sess.time("lint_checking", || {
918 rustc_lint::check_crate(tcx, || {
919 rustc_lint::BuiltinCombinedLateLintPass::new()
926 sess.time("privacy_checking_modules", || {
927 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
928 tcx.ensure().check_mod_privacy(module);
938 fn encode_and_write_metadata(
940 outputs: &OutputFilenames,
941 ) -> (middle::cstore::EncodedMetadata, bool) {
942 #[derive(PartialEq, Eq, PartialOrd, Ord)]
949 let metadata_kind = tcx
953 .map(|ty| match *ty {
954 CrateType::Executable | CrateType::Staticlib | CrateType::Cdylib => MetadataKind::None,
956 CrateType::Rlib => MetadataKind::Uncompressed,
958 CrateType::Dylib | CrateType::ProcMacro => MetadataKind::Compressed,
961 .unwrap_or(MetadataKind::None);
963 let metadata = match metadata_kind {
964 MetadataKind::None => middle::cstore::EncodedMetadata::new(),
965 MetadataKind::Uncompressed | MetadataKind::Compressed => tcx.encode_metadata(),
968 let _prof_timer = tcx.sess.prof.generic_activity("write_crate_metadata");
970 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
971 if need_metadata_file {
972 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
973 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
974 // To avoid races with another rustc process scanning the output directory,
975 // we need to write the file somewhere else and atomically move it to its
976 // final destination, with an `fs::rename` call. In order for the rename to
977 // always succeed, the temporary file needs to be on the same filesystem,
978 // which is why we create it inside the output directory specifically.
979 let metadata_tmpdir = TempFileBuilder::new()
981 .tempdir_in(out_filename.parent().unwrap())
982 .unwrap_or_else(|err| tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err)));
983 let metadata_tmpdir = MaybeTempDir::new(metadata_tmpdir, tcx.sess.opts.cg.save_temps);
984 let metadata_filename = emit_metadata(tcx.sess, &metadata.raw_data, &metadata_tmpdir);
985 if let Err(e) = util::non_durable_rename(&metadata_filename, &out_filename) {
986 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
988 if tcx.sess.opts.json_artifact_notifications {
992 .emit_artifact_notification(&out_filename, "metadata");
996 let need_metadata_module = metadata_kind == MetadataKind::Compressed;
998 (metadata, need_metadata_module)
1001 /// Runs the codegen backend, after which the AST and analysis can
1003 pub fn start_codegen<'tcx>(
1004 codegen_backend: &dyn CodegenBackend,
1006 outputs: &OutputFilenames,
1008 info!("Pre-codegen\n{:?}", tcx.debug_stats());
1010 let (metadata, need_metadata_module) = encode_and_write_metadata(tcx, outputs);
1012 let codegen = tcx.sess.time("codegen_crate", move || {
1013 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1016 // Don't run these test assertions when not doing codegen. Compiletest tries to build
1017 // build-fail tests in check mode first and expects it to not give an error in that case.
1018 if tcx.sess.opts.output_types.should_codegen() {
1019 rustc_incremental::assert_module_sources::assert_module_sources(tcx);
1020 rustc_symbol_mangling::test::report_symbol_names(tcx);
1023 info!("Post-codegen\n{:?}", tcx.debug_stats());
1025 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1026 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, outputs) {
1027 tcx.sess.err(&format!("could not emit MIR: {}", e));
1028 tcx.sess.abort_if_errors();