2 CantEmitMIR, EmojiIdentifier, ErrorWritingDependencies, FerrisIdentifier,
3 GeneratedFileConflictsWithDirectory, InputFileWouldBeOverWritten, MixedBinCrate,
4 MixedProcMacroCrate, OutDirError, ProcMacroCratePanicAbort, ProcMacroDocWithoutArg,
7 use crate::interface::{Compiler, Result};
8 use crate::proc_macro_decls;
11 use ast::CRATE_NODE_ID;
12 use rustc_ast::{self as ast, visit};
13 use rustc_borrowck as mir_borrowck;
14 use rustc_codegen_ssa::traits::CodegenBackend;
15 use rustc_data_structures::parallel;
16 use rustc_data_structures::sync::{Lrc, OnceCell, WorkerLocal};
17 use rustc_errors::{ErrorGuaranteed, PResult};
18 use rustc_expand::base::{ExtCtxt, LintStoreExpand, ResolverExpand};
19 use rustc_hir::def_id::{StableCrateId, LOCAL_CRATE};
20 use rustc_lint::{BufferedEarlyLint, EarlyCheckNode, LintStore};
21 use rustc_metadata::creader::CStore;
22 use rustc_middle::arena::Arena;
23 use rustc_middle::dep_graph::DepGraph;
24 use rustc_middle::ty::query::{ExternProviders, Providers};
25 use rustc_middle::ty::{self, GlobalCtxt, RegisteredTools, TyCtxt};
26 use rustc_mir_build as mir_build;
27 use rustc_parse::{parse_crate_from_file, parse_crate_from_source_str, validate_attr};
28 use rustc_passes::{self, hir_stats, layout_test};
29 use rustc_plugin_impl as plugin;
30 use rustc_query_impl::{OnDiskCache, Queries as TcxQueries};
31 use rustc_resolve::{Resolver, ResolverArenas};
32 use rustc_session::config::{CrateType, Input, OutputFilenames, OutputType};
33 use rustc_session::cstore::{CrateStoreDyn, MetadataLoader, MetadataLoaderDyn, Untracked};
34 use rustc_session::output::filename_for_input;
35 use rustc_session::search_paths::PathKind;
36 use rustc_session::{Limit, Session};
37 use rustc_span::symbol::{sym, Symbol};
38 use rustc_span::FileName;
39 use rustc_target::spec::PanicStrategy;
40 use rustc_trait_selection::traits;
43 use std::cell::RefCell;
44 use std::ffi::OsString;
45 use std::io::{self, BufWriter, Write};
46 use std::marker::PhantomPinned;
47 use std::path::{Path, PathBuf};
50 use std::sync::{Arc, LazyLock};
51 use std::{env, fs, iter};
53 pub fn parse<'a>(sess: &'a Session) -> PResult<'a, ast::Crate> {
54 let krate = sess.time("parse_crate", || match &sess.io.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.unstable_opts.input_stats {
62 eprintln!("Lines of code: {}", sess.source_map().count_lines());
63 eprintln!("Pre-expansion node count: {}", count_nodes(&krate));
66 if let Some(ref s) = sess.opts.unstable_opts.show_span {
67 rustc_ast_passes::show_span::run(sess.diagnostic(), s, &krate);
70 if sess.opts.unstable_opts.hir_stats {
71 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS", "ast-stats-1");
77 fn count_nodes(krate: &ast::Crate) -> usize {
78 let mut counter = rustc_ast_passes::node_count::NodeCounter::new();
79 visit::walk_crate(&mut counter, krate);
83 pub use boxed_resolver::BoxedResolver;
87 pub struct BoxedResolver(Pin<Box<BoxedResolverInner>>);
89 struct BoxedResolverInner {
90 session: Lrc<Session>,
91 resolver_arenas: Option<ResolverArenas<'static>>,
92 resolver: Option<Resolver<'static>>,
96 // Note: Drop order is important to prevent dangling references. Resolver must be dropped first,
97 // then resolver_arenas and session.
98 impl Drop for BoxedResolverInner {
100 self.resolver.take();
101 self.resolver_arenas.take();
107 session: Lrc<Session>,
108 make_resolver: impl for<'a> FnOnce(&'a Session, &'a ResolverArenas<'a>) -> Resolver<'a>,
110 let mut boxed_resolver = Box::new(BoxedResolverInner {
112 resolver_arenas: Some(Resolver::arenas()),
116 // SAFETY: `make_resolver` takes a resolver arena with an arbitrary lifetime and
117 // returns a resolver with the same lifetime as the arena. We ensure that the arena
118 // outlives the resolver in the drop impl and elsewhere so these transmutes are sound.
120 let resolver = make_resolver(
121 std::mem::transmute::<&Session, &Session>(&boxed_resolver.session),
122 std::mem::transmute::<&ResolverArenas<'_>, &ResolverArenas<'_>>(
123 boxed_resolver.resolver_arenas.as_ref().unwrap(),
126 boxed_resolver.resolver = Some(resolver);
127 BoxedResolver(Pin::new_unchecked(boxed_resolver))
131 pub fn access<F: for<'a> FnOnce(&mut Resolver<'a>) -> R, R>(&mut self, f: F) -> R {
132 // SAFETY: The resolver doesn't need to be pinned.
133 let mut resolver = unsafe {
134 self.0.as_mut().map_unchecked_mut(|boxed_resolver| &mut boxed_resolver.resolver)
136 f((&mut *resolver).as_mut().unwrap())
139 pub fn to_resolver_outputs(resolver: Rc<RefCell<BoxedResolver>>) -> ty::ResolverOutputs {
140 match Rc::try_unwrap(resolver) {
142 let mut resolver = resolver.into_inner();
143 // SAFETY: The resolver doesn't need to be pinned.
144 let mut resolver = unsafe {
148 .map_unchecked_mut(|boxed_resolver| &mut boxed_resolver.resolver)
150 resolver.take().unwrap().into_outputs()
152 Err(resolver) => resolver.borrow_mut().access(|resolver| resolver.clone_outputs()),
158 pub fn create_resolver(
160 metadata_loader: Box<MetadataLoaderDyn>,
164 trace!("create_resolver");
165 BoxedResolver::new(sess, move |sess, resolver_arenas| {
166 Resolver::new(sess, krate, crate_name, metadata_loader, resolver_arenas)
170 pub fn register_plugins<'a>(
172 metadata_loader: &'a dyn MetadataLoader,
173 register_lints: impl Fn(&Session, &mut LintStore),
174 mut krate: ast::Crate,
176 ) -> Result<(ast::Crate, LintStore)> {
177 krate = sess.time("attributes_injection", || {
178 rustc_builtin_macros::cmdline_attrs::inject(
181 &sess.opts.unstable_opts.crate_attr,
185 let (krate, features) = rustc_expand::config::features(sess, krate, CRATE_NODE_ID);
186 // these need to be set "early" so that expansion sees `quote` if enabled.
187 sess.init_features(features);
189 let crate_types = util::collect_crate_types(sess, &krate.attrs);
190 sess.init_crate_types(crate_types);
192 let stable_crate_id = StableCrateId::new(
194 sess.crate_types().contains(&CrateType::Executable),
195 sess.opts.cg.metadata.clone(),
197 sess.stable_crate_id.set(stable_crate_id).expect("not yet initialized");
198 rustc_incremental::prepare_session_directory(sess, crate_name, stable_crate_id)?;
200 if sess.opts.incremental.is_some() {
201 sess.time("incr_comp_garbage_collect_session_directories", || {
202 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
204 "Error while trying to garbage collect incremental \
205 compilation cache directory: {}",
212 let mut lint_store = rustc_lint::new_lint_store(sess.enable_internal_lints());
213 register_lints(sess, &mut lint_store);
216 sess.time("plugin_loading", || plugin::load::load_plugins(sess, metadata_loader, &krate));
217 sess.time("plugin_registration", || {
218 let mut registry = plugin::Registry { lint_store: &mut lint_store };
219 for registrar in registrars {
220 registrar(&mut registry);
224 Ok((krate, lint_store))
227 fn pre_expansion_lint<'a>(
229 lint_store: &LintStore,
230 registered_tools: &RegisteredTools,
231 check_node: impl EarlyCheckNode<'a>,
234 sess.prof.generic_activity_with_arg("pre_AST_expansion_lint_checks", node_name.as_str()).run(
236 rustc_lint::check_ast_node(
242 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
249 // Cannot implement directly for `LintStore` due to trait coherence.
250 struct LintStoreExpandImpl<'a>(&'a LintStore);
252 impl LintStoreExpand for LintStoreExpandImpl<'_> {
253 fn pre_expansion_lint(
256 registered_tools: &RegisteredTools,
257 node_id: ast::NodeId,
258 attrs: &[ast::Attribute],
259 items: &[rustc_ast::ptr::P<ast::Item>],
262 pre_expansion_lint(sess, self.0, registered_tools, (node_id, attrs, items), name);
266 /// Runs the "early phases" of the compiler: initial `cfg` processing, loading compiler plugins,
267 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
268 /// harness if one is to be provided, injection of a dependency on the
269 /// standard library and prelude, and name resolution.
270 pub fn configure_and_expand(
272 lint_store: &LintStore,
273 mut krate: ast::Crate,
275 resolver: &mut Resolver<'_>,
276 ) -> Result<ast::Crate> {
277 trace!("configure_and_expand");
278 pre_expansion_lint(sess, lint_store, resolver.registered_tools(), &krate, crate_name);
279 rustc_builtin_macros::register_builtin_macros(resolver);
281 krate = sess.time("crate_injection", || {
282 rustc_builtin_macros::standard_library_imports::inject(krate, resolver, sess)
285 util::check_attr_crate_type(sess, &krate.attrs, &mut resolver.lint_buffer());
288 krate = sess.time("macro_expand_crate", || {
289 // Windows dlls do not have rpaths, so they don't know how to find their
290 // dependencies. It's up to us to tell the system where to find all the
291 // dependent dlls. Note that this uses cfg!(windows) as opposed to
292 // targ_cfg because syntax extensions are always loaded for the host
293 // compiler, not for the target.
295 // This is somewhat of an inherently racy operation, however, as
296 // multiple threads calling this function could possibly continue
297 // extending PATH far beyond what it should. To solve this for now we
298 // just don't add any new elements to PATH which are already there
299 // within PATH. This is basically a targeted fix at #17360 for rustdoc
300 // which runs rustc in parallel but has been seen (#33844) to cause
301 // problems with PATH becoming too long.
302 let mut old_path = OsString::new();
304 old_path = env::var_os("PATH").unwrap_or(old_path);
305 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
306 for path in env::split_paths(&old_path) {
307 if !new_path.contains(&path) {
314 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
320 // Create the config for macro expansion
321 let features = sess.features_untracked();
322 let recursion_limit = get_recursion_limit(&krate.attrs, sess);
323 let cfg = rustc_expand::expand::ExpansionConfig {
324 features: Some(features),
326 trace_mac: sess.opts.unstable_opts.trace_macros,
327 should_test: sess.opts.test,
328 span_debug: sess.opts.unstable_opts.span_debug,
329 proc_macro_backtrace: sess.opts.unstable_opts.proc_macro_backtrace,
330 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
333 let lint_store = LintStoreExpandImpl(lint_store);
334 let mut ecx = ExtCtxt::new(sess, cfg, resolver, Some(&lint_store));
335 // Expand macros now!
336 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
338 // The rest is error reporting
340 sess.parse_sess.buffered_lints.with_lock(|buffered_lints: &mut Vec<BufferedEarlyLint>| {
341 buffered_lints.append(&mut ecx.buffered_early_lint);
344 sess.time("check_unused_macros", || {
345 ecx.check_unused_macros();
348 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
351 env::set_var("PATH", &old_path);
354 if recursion_limit_hit {
355 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
357 Err(ErrorGuaranteed::unchecked_claim_error_was_emitted())
363 sess.time("maybe_building_test_harness", || {
364 rustc_builtin_macros::test_harness::inject(sess, resolver, &mut krate)
367 let has_proc_macro_decls = sess.time("AST_validation", || {
368 rustc_ast_passes::ast_validation::check_crate(sess, &krate, resolver.lint_buffer())
371 let crate_types = sess.crate_types();
372 let is_executable_crate = crate_types.contains(&CrateType::Executable);
373 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
375 if crate_types.len() > 1 {
376 if is_executable_crate {
377 sess.emit_err(MixedBinCrate);
379 if is_proc_macro_crate {
380 sess.emit_err(MixedProcMacroCrate);
384 if is_proc_macro_crate && sess.panic_strategy() == PanicStrategy::Abort {
385 sess.emit_warning(ProcMacroCratePanicAbort);
388 // For backwards compatibility, we don't try to run proc macro injection
389 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
390 // specified. This should only affect users who manually invoke 'rustdoc', as
391 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
392 // However, we do emit a warning, to let such users know that they should
393 // start passing '--crate-type proc-macro'
394 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
395 sess.emit_warning(ProcMacroDocWithoutArg);
397 krate = sess.time("maybe_create_a_macro_crate", || {
398 let is_test_crate = sess.opts.test;
399 rustc_builtin_macros::proc_macro_harness::inject(
404 has_proc_macro_decls,
411 // Done with macro expansion!
413 if sess.opts.unstable_opts.input_stats {
414 eprintln!("Post-expansion node count: {}", count_nodes(&krate));
417 if sess.opts.unstable_opts.hir_stats {
418 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS", "ast-stats-2");
421 resolver.resolve_crate(&krate);
423 // Needs to go *after* expansion to be able to check the results of macro expansion.
424 sess.time("complete_gated_feature_checking", || {
425 rustc_ast_passes::feature_gate::check_crate(&krate, sess);
428 // Add all buffered lints from the `ParseSess` to the `Session`.
429 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
430 info!("{} parse sess buffered_lints", buffered_lints.len());
431 for early_lint in buffered_lints.drain(..) {
432 resolver.lint_buffer().add_early_lint(early_lint);
436 // Gate identifiers containing invalid Unicode codepoints that were recovered during lexing.
437 sess.parse_sess.bad_unicode_identifiers.with_lock(|identifiers| {
438 let mut identifiers: Vec<_> = identifiers.drain().collect();
439 identifiers.sort_by_key(|&(key, _)| key);
440 for (ident, mut spans) in identifiers.into_iter() {
442 if ident == sym::ferris {
443 let first_span = spans[0];
444 sess.emit_err(FerrisIdentifier { spans, first_span });
446 sess.emit_err(EmojiIdentifier { spans, ident });
451 sess.time("early_lint_checks", || {
452 let lint_buffer = Some(std::mem::take(resolver.lint_buffer()));
453 rustc_lint::check_ast_node(
457 resolver.registered_tools(),
459 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
467 // Returns all the paths that correspond to generated files.
468 fn generated_output_paths(
470 outputs: &OutputFilenames,
474 let mut out_filenames = Vec::new();
475 for output_type in sess.opts.output_types.keys() {
476 let file = outputs.path(*output_type);
478 // If the filename has been overridden using `-o`, it will not be modified
479 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
480 OutputType::Exe if !exact_name => {
481 for crate_type in sess.crate_types().iter() {
482 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
483 out_filenames.push(p);
486 OutputType::DepInfo if sess.opts.unstable_opts.dep_info_omit_d_target => {
487 // Don't add the dep-info output when omitting it from dep-info targets
490 out_filenames.push(file);
497 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
498 // returns None for every file path.
499 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
501 F: Fn(&PathBuf) -> Option<T>,
503 for output_path in output_paths {
504 if let Some(result) = f(output_path) {
511 fn output_contains_path(output_paths: &[PathBuf], input_path: &Path) -> bool {
512 let input_path = input_path.canonicalize().ok();
513 if input_path.is_none() {
516 let check = |output_path: &PathBuf| {
517 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
519 check_output(output_paths, check).is_some()
522 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
523 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
524 check_output(output_paths, check)
527 fn escape_dep_filename(filename: &str) -> String {
528 // Apparently clang and gcc *only* escape spaces:
529 // https://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
530 filename.replace(' ', "\\ ")
533 // Makefile comments only need escaping newlines and `\`.
534 // The result can be unescaped by anything that can unescape `escape_default` and friends.
535 fn escape_dep_env(symbol: Symbol) -> String {
536 let s = symbol.as_str();
537 let mut escaped = String::with_capacity(s.len());
540 '\n' => escaped.push_str(r"\n"),
541 '\r' => escaped.push_str(r"\r"),
542 '\\' => escaped.push_str(r"\\"),
543 _ => escaped.push(c),
551 cstore: &CrateStoreDyn,
552 outputs: &OutputFilenames,
553 out_filenames: &[PathBuf],
555 // Write out dependency rules to the dep-info file if requested
556 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
559 let deps_filename = outputs.path(OutputType::DepInfo);
561 let result: io::Result<()> = try {
562 // Build a list of files used to compile the output and
563 // write Makefile-compatible dependency rules
564 let mut files: Vec<String> = sess
568 .filter(|fmap| fmap.is_real_file())
569 .filter(|fmap| !fmap.is_imported())
570 .map(|fmap| escape_dep_filename(&fmap.name.prefer_local().to_string()))
573 // Account for explicitly marked-to-track files
574 // (e.g. accessed in proc macros).
575 let file_depinfo = sess.parse_sess.file_depinfo.borrow();
577 let normalize_path = |path: PathBuf| {
578 let file = FileName::from(path);
579 escape_dep_filename(&file.prefer_local().to_string())
582 let extra_tracked_files =
583 file_depinfo.iter().map(|path_sym| normalize_path(PathBuf::from(path_sym.as_str())));
584 files.extend(extra_tracked_files);
586 // We also need to track used PGO profile files
587 if let Some(ref profile_instr) = sess.opts.cg.profile_use {
588 files.push(normalize_path(profile_instr.as_path().to_path_buf()));
590 if let Some(ref profile_sample) = sess.opts.unstable_opts.profile_sample_use {
591 files.push(normalize_path(profile_sample.as_path().to_path_buf()));
594 if sess.binary_dep_depinfo() {
595 if let Some(ref backend) = sess.opts.unstable_opts.codegen_backend {
596 if backend.contains('.') {
597 // If the backend name contain a `.`, it is the path to an external dynamic
598 // library. If not, it is not a path.
599 files.push(backend.to_string());
603 let cstore = cstore.as_any().downcast_ref::<CStore>().unwrap();
604 for cnum in cstore.crates_untracked() {
605 let source = cstore.crate_source_untracked(cnum);
606 if let Some((path, _)) = &source.dylib {
607 files.push(escape_dep_filename(&path.display().to_string()));
609 if let Some((path, _)) = &source.rlib {
610 files.push(escape_dep_filename(&path.display().to_string()));
612 if let Some((path, _)) = &source.rmeta {
613 files.push(escape_dep_filename(&path.display().to_string()));
618 let mut file = BufWriter::new(fs::File::create(&deps_filename)?);
619 for path in out_filenames {
620 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
623 // Emit a fake target for each input file to the compilation. This
624 // prevents `make` from spitting out an error if a file is later
625 // deleted. For more info see #28735
627 writeln!(file, "{path}:")?;
630 // Emit special comments with information about accessed environment variables.
631 let env_depinfo = sess.parse_sess.env_depinfo.borrow();
632 if !env_depinfo.is_empty() {
633 let mut envs: Vec<_> = env_depinfo
635 .map(|(k, v)| (escape_dep_env(*k), v.map(escape_dep_env)))
637 envs.sort_unstable();
640 write!(file, "# env-dep:{k}")?;
642 write!(file, "={v}")?;
651 if sess.opts.json_artifact_notifications {
654 .emit_artifact_notification(&deps_filename, "dep-info");
658 sess.emit_fatal(ErrorWritingDependencies { path: &deps_filename, error });
663 fn output_filenames(tcx: TyCtxt<'_>, (): ()) -> Arc<OutputFilenames> {
665 let _timer = sess.timer("prepare_outputs");
666 let (_, krate) = &*tcx.resolver_for_lowering(()).borrow();
667 let crate_name = tcx.crate_name(LOCAL_CRATE);
669 // FIXME: rustdoc passes &[] instead of &krate.attrs here
670 let outputs = util::build_output_filenames(&krate.attrs, sess);
673 generated_output_paths(sess, &outputs, sess.io.output_file.is_some(), crate_name);
675 // Ensure the source file isn't accidentally overwritten during compilation.
676 if let Some(ref input_path) = sess.io.input.opt_path() {
677 if sess.opts.will_create_output_file() {
678 if output_contains_path(&output_paths, input_path) {
679 sess.emit_fatal(InputFileWouldBeOverWritten { path: input_path });
681 if let Some(ref dir_path) = output_conflicts_with_dir(&output_paths) {
682 sess.emit_fatal(GeneratedFileConflictsWithDirectory { input_path, dir_path });
687 if let Some(ref dir) = sess.io.temps_dir {
688 if fs::create_dir_all(dir).is_err() {
689 sess.emit_fatal(TempsDirError);
693 write_out_deps(sess, tcx.cstore_untracked(), &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) = sess.io.output_dir {
700 if fs::create_dir_all(dir).is_err() {
701 sess.emit_fatal(OutDirError);
709 pub static DEFAULT_QUERY_PROVIDERS: LazyLock<Providers> = LazyLock::new(|| {
710 let providers = &mut Providers::default();
711 providers.analysis = analysis;
712 providers.hir_crate = rustc_ast_lowering::lower_to_hir;
713 providers.output_filenames = output_filenames;
714 proc_macro_decls::provide(providers);
715 rustc_const_eval::provide(providers);
716 rustc_middle::hir::provide(providers);
717 mir_borrowck::provide(providers);
718 mir_build::provide(providers);
719 rustc_mir_transform::provide(providers);
720 rustc_monomorphize::provide(providers);
721 rustc_privacy::provide(providers);
722 rustc_hir_analysis::provide(providers);
723 rustc_hir_typeck::provide(providers);
724 ty::provide(providers);
725 traits::provide(providers);
726 rustc_passes::provide(providers);
727 rustc_traits::provide(providers);
728 rustc_ty_utils::provide(providers);
729 rustc_metadata::provide(providers);
730 rustc_lint::provide(providers);
731 rustc_symbol_mangling::provide(providers);
732 rustc_codegen_ssa::provide(providers);
736 pub static DEFAULT_EXTERN_QUERY_PROVIDERS: LazyLock<ExternProviders> = LazyLock::new(|| {
737 let mut extern_providers = ExternProviders::default();
738 rustc_metadata::provide_extern(&mut extern_providers);
739 rustc_codegen_ssa::provide_extern(&mut extern_providers);
743 pub struct QueryContext<'tcx> {
744 gcx: &'tcx GlobalCtxt<'tcx>,
747 impl<'tcx> QueryContext<'tcx> {
748 pub fn enter<F, R>(&mut self, f: F) -> R
750 F: FnOnce(TyCtxt<'tcx>) -> R,
752 let icx = ty::tls::ImplicitCtxt::new(self.gcx);
753 ty::tls::enter_context(&icx, |_| f(icx.tcx))
757 pub fn create_global_ctxt<'tcx>(
758 compiler: &'tcx Compiler,
759 lint_store: Lrc<LintStore>,
761 untracked: Untracked,
762 queries: &'tcx OnceCell<TcxQueries<'tcx>>,
763 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
764 arena: &'tcx WorkerLocal<Arena<'tcx>>,
765 hir_arena: &'tcx WorkerLocal<rustc_hir::Arena<'tcx>>,
766 ) -> QueryContext<'tcx> {
767 // We're constructing the HIR here; we don't care what we will
768 // read, since we haven't even constructed the *input* to
770 dep_graph.assert_ignored();
772 let sess = &compiler.session();
773 let query_result_on_disk_cache = rustc_incremental::load_query_result_cache(sess);
775 let codegen_backend = compiler.codegen_backend();
776 let mut local_providers = *DEFAULT_QUERY_PROVIDERS;
777 codegen_backend.provide(&mut local_providers);
779 let mut extern_providers = *DEFAULT_EXTERN_QUERY_PROVIDERS;
780 codegen_backend.provide_extern(&mut extern_providers);
782 if let Some(callback) = compiler.override_queries {
783 callback(sess, &mut local_providers, &mut extern_providers);
786 let queries = queries.get_or_init(|| {
787 TcxQueries::new(local_providers, extern_providers, query_result_on_disk_cache)
790 let gcx = sess.time("setup_global_ctxt", || {
791 global_ctxt.get_or_init(move || {
792 TyCtxt::create_global_ctxt(
799 queries.on_disk_cache.as_ref().map(OnDiskCache::as_dyn),
801 rustc_query_impl::query_callbacks(arena),
809 /// Runs the resolution, type-checking, region checking and other
810 /// miscellaneous analysis passes on the crate.
811 fn analysis(tcx: TyCtxt<'_>, (): ()) -> Result<()> {
812 rustc_passes::hir_id_validator::check_crate(tcx);
815 let mut entry_point = None;
817 sess.time("misc_checking_1", || {
820 entry_point = sess.time("looking_for_entry_point", || tcx.entry_fn(()));
822 sess.time("looking_for_derive_registrar", || {
823 tcx.ensure().proc_macro_decls_static(())
826 CStore::from_tcx(tcx).report_unused_deps(tcx);
829 tcx.hir().par_for_each_module(|module| {
830 tcx.ensure().check_mod_loops(module);
831 tcx.ensure().check_mod_attrs(module);
832 tcx.ensure().check_mod_naked_functions(module);
833 tcx.ensure().check_mod_unstable_api_usage(module);
834 tcx.ensure().check_mod_const_bodies(module);
838 sess.time("unused_lib_feature_checking", || {
839 rustc_passes::stability::check_unused_or_stable_features(tcx)
843 // We force these queries to run,
844 // since they might not otherwise get called.
845 // This marks the corresponding crate-level attributes
846 // as used, and ensures that their values are valid.
847 tcx.ensure().limits(());
848 tcx.ensure().stability_index(());
853 // passes are timed inside typeck
854 rustc_hir_analysis::check_crate(tcx)?;
856 sess.time("misc_checking_2", || {
859 sess.time("match_checking", || {
860 tcx.hir().par_body_owners(|def_id| tcx.ensure().check_match(def_id.to_def_id()))
864 sess.time("liveness_checking", || {
865 tcx.hir().par_body_owners(|def_id| {
866 // this must run before MIR dump, because
867 // "not all control paths return a value" is reported here.
869 // maybe move the check to a MIR pass?
870 tcx.ensure().check_liveness(def_id.to_def_id());
877 sess.time("MIR_borrow_checking", || {
878 tcx.hir().par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
881 sess.time("MIR_effect_checking", || {
882 for def_id in tcx.hir().body_owners() {
883 tcx.ensure().thir_check_unsafety(def_id);
884 if !tcx.sess.opts.unstable_opts.thir_unsafeck {
885 rustc_mir_transform::check_unsafety::check_unsafety(tcx, def_id);
887 tcx.ensure().has_ffi_unwind_calls(def_id);
889 if tcx.hir().body_const_context(def_id).is_some() {
891 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::unknown(def_id));
896 if tcx.sess.opts.unstable_opts.drop_tracking_mir {
897 tcx.hir().par_body_owners(|def_id| {
898 if let rustc_hir::def::DefKind::Generator = tcx.def_kind(def_id) {
899 tcx.ensure().mir_generator_witnesses(def_id);
900 tcx.ensure().check_generator_obligations(def_id);
905 sess.time("layout_testing", || layout_test::test_layout(tcx));
907 // Avoid overwhelming user with errors if borrow checking failed.
908 // I'm not sure how helpful this is, to be honest, but it avoids a
909 // lot of annoying errors in the ui tests (basically,
910 // lint warnings and so on -- kindck used to do this abort, but
911 // kindck is gone now). -nmatsakis
912 if let Some(reported) = sess.has_errors() {
913 return Err(reported);
916 sess.time("misc_checking_3", || {
919 tcx.ensure().effective_visibilities(());
923 tcx.ensure().check_private_in_public(());
927 .par_for_each_module(|module| tcx.ensure().check_mod_deathness(module));
930 sess.time("lint_checking", || {
931 rustc_lint::check_crate(tcx, || {
932 rustc_lint::BuiltinCombinedLateLintPass::new()
939 sess.time("privacy_checking_modules", || {
940 tcx.hir().par_for_each_module(|module| {
941 tcx.ensure().check_mod_privacy(module);
947 // This check has to be run after all lints are done processing. We don't
948 // define a lint filter, as all lint checks should have finished at this point.
949 sess.time("check_lint_expectations", || tcx.check_expectations(None));
955 /// Runs the codegen backend, after which the AST and analysis can
957 pub fn start_codegen<'tcx>(
958 codegen_backend: &dyn CodegenBackend,
961 info!("Pre-codegen\n{:?}", tcx.debug_stats());
963 let (metadata, need_metadata_module) = rustc_metadata::fs::encode_and_write_metadata(tcx);
965 let codegen = tcx.sess.time("codegen_crate", move || {
966 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
969 // Don't run these test assertions when not doing codegen. Compiletest tries to build
970 // build-fail tests in check mode first and expects it to not give an error in that case.
971 if tcx.sess.opts.output_types.should_codegen() {
972 rustc_incremental::assert_module_sources::assert_module_sources(tcx);
973 rustc_symbol_mangling::test::report_symbol_names(tcx);
976 info!("Post-codegen\n{:?}", tcx.debug_stats());
978 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
979 if let Err(error) = rustc_mir_transform::dump_mir::emit_mir(tcx) {
980 tcx.sess.emit_err(CantEmitMIR { error });
981 tcx.sess.abort_if_errors();
988 fn get_recursion_limit(krate_attrs: &[ast::Attribute], sess: &Session) -> Limit {
989 if let Some(attr) = krate_attrs
991 .find(|attr| attr.has_name(sym::recursion_limit) && attr.value_str().is_none())
993 // This is here mainly to check for using a macro, such as
994 // #![recursion_limit = foo!()]. That is not supported since that
995 // would require expanding this while in the middle of expansion,
996 // which needs to know the limit before expanding. Otherwise,
997 // validation would normally be caught in AstValidator (via
998 // `check_builtin_attribute`), but by the time that runs the macro
999 // is expanded, and it doesn't give an error.
1000 validate_attr::emit_fatal_malformed_builtin_attribute(
1003 sym::recursion_limit,
1006 rustc_middle::middle::limits::get_recursion_limit(krate_attrs, sess)