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::steal::Steal;
17 use rustc_data_structures::sync::{Lrc, OnceCell, WorkerLocal};
18 use rustc_errors::{ErrorGuaranteed, PResult};
19 use rustc_expand::base::{ExtCtxt, LintStoreExpand, ResolverExpand};
20 use rustc_hir::def_id::StableCrateId;
21 use rustc_lint::{BufferedEarlyLint, EarlyCheckNode, LintStore};
22 use rustc_metadata::creader::CStore;
23 use rustc_middle::arena::Arena;
24 use rustc_middle::dep_graph::DepGraph;
25 use rustc_middle::ty::query::{ExternProviders, Providers};
26 use rustc_middle::ty::{self, GlobalCtxt, RegisteredTools, TyCtxt};
27 use rustc_mir_build as mir_build;
28 use rustc_parse::{parse_crate_from_file, parse_crate_from_source_str, validate_attr};
29 use rustc_passes::{self, hir_stats, layout_test};
30 use rustc_plugin_impl as plugin;
31 use rustc_query_impl::{OnDiskCache, Queries as TcxQueries};
32 use rustc_resolve::{Resolver, ResolverArenas};
33 use rustc_session::config::{CrateType, Input, OutputFilenames, OutputType};
34 use rustc_session::cstore::{MetadataLoader, MetadataLoaderDyn};
35 use rustc_session::output::filename_for_input;
36 use rustc_session::search_paths::PathKind;
37 use rustc_session::{Limit, Session};
38 use rustc_span::symbol::{sym, Symbol};
39 use rustc_span::FileName;
40 use rustc_target::spec::PanicStrategy;
41 use rustc_trait_selection::traits;
44 use std::cell::RefCell;
45 use std::ffi::OsString;
46 use std::io::{self, BufWriter, Write};
47 use std::marker::PhantomPinned;
48 use std::path::{Path, PathBuf};
51 use std::sync::LazyLock;
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.unstable_opts.input_stats {
63 eprintln!("Lines of code: {}", sess.source_map().count_lines());
64 eprintln!("Pre-expansion node count: {}", count_nodes(&krate));
67 if let Some(ref s) = sess.opts.unstable_opts.show_span {
68 rustc_ast_passes::show_span::run(sess.diagnostic(), s, &krate);
71 if sess.opts.unstable_opts.hir_stats {
72 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS", "ast-stats-1");
78 fn count_nodes(krate: &ast::Crate) -> usize {
79 let mut counter = rustc_ast_passes::node_count::NodeCounter::new();
80 visit::walk_crate(&mut counter, krate);
84 pub use boxed_resolver::BoxedResolver;
88 pub struct BoxedResolver(Pin<Box<BoxedResolverInner>>);
90 struct BoxedResolverInner {
91 session: Lrc<Session>,
92 resolver_arenas: Option<ResolverArenas<'static>>,
93 resolver: Option<Resolver<'static>>,
97 // Note: Drop order is important to prevent dangling references. Resolver must be dropped first,
98 // then resolver_arenas and session.
99 impl Drop for BoxedResolverInner {
101 self.resolver.take();
102 self.resolver_arenas.take();
108 session: Lrc<Session>,
109 make_resolver: impl for<'a> FnOnce(&'a Session, &'a ResolverArenas<'a>) -> Resolver<'a>,
111 let mut boxed_resolver = Box::new(BoxedResolverInner {
113 resolver_arenas: Some(Resolver::arenas()),
117 // SAFETY: `make_resolver` takes a resolver arena with an arbitrary lifetime and
118 // returns a resolver with the same lifetime as the arena. We ensure that the arena
119 // outlives the resolver in the drop impl and elsewhere so these transmutes are sound.
121 let resolver = make_resolver(
122 std::mem::transmute::<&Session, &Session>(&boxed_resolver.session),
123 std::mem::transmute::<&ResolverArenas<'_>, &ResolverArenas<'_>>(
124 boxed_resolver.resolver_arenas.as_ref().unwrap(),
127 boxed_resolver.resolver = Some(resolver);
128 BoxedResolver(Pin::new_unchecked(boxed_resolver))
132 pub fn access<F: for<'a> FnOnce(&mut Resolver<'a>) -> R, R>(&mut self, f: F) -> R {
133 // SAFETY: The resolver doesn't need to be pinned.
134 let mut resolver = unsafe {
135 self.0.as_mut().map_unchecked_mut(|boxed_resolver| &mut boxed_resolver.resolver)
137 f((&mut *resolver).as_mut().unwrap())
140 pub fn to_resolver_outputs(resolver: Rc<RefCell<BoxedResolver>>) -> ty::ResolverOutputs {
141 match Rc::try_unwrap(resolver) {
143 let mut resolver = resolver.into_inner();
144 // SAFETY: The resolver doesn't need to be pinned.
145 let mut resolver = unsafe {
149 .map_unchecked_mut(|boxed_resolver| &mut boxed_resolver.resolver)
151 resolver.take().unwrap().into_outputs()
153 Err(resolver) => resolver.borrow_mut().access(|resolver| resolver.clone_outputs()),
159 pub fn create_resolver(
161 metadata_loader: Box<MetadataLoaderDyn>,
165 trace!("create_resolver");
166 BoxedResolver::new(sess, move |sess, resolver_arenas| {
167 Resolver::new(sess, krate, crate_name, metadata_loader, resolver_arenas)
171 pub fn register_plugins<'a>(
173 metadata_loader: &'a dyn MetadataLoader,
174 register_lints: impl Fn(&Session, &mut LintStore),
175 mut krate: ast::Crate,
177 ) -> Result<(ast::Crate, LintStore)> {
178 krate = sess.time("attributes_injection", || {
179 rustc_builtin_macros::cmdline_attrs::inject(
182 &sess.opts.unstable_opts.crate_attr,
186 let (krate, features) = rustc_expand::config::features(sess, krate, CRATE_NODE_ID);
187 // these need to be set "early" so that expansion sees `quote` if enabled.
188 sess.init_features(features);
190 let crate_types = util::collect_crate_types(sess, &krate.attrs);
191 sess.init_crate_types(crate_types);
193 let stable_crate_id = StableCrateId::new(
195 sess.crate_types().contains(&CrateType::Executable),
196 sess.opts.cg.metadata.clone(),
198 sess.stable_crate_id.set(stable_crate_id).expect("not yet initialized");
199 rustc_incremental::prepare_session_directory(sess, crate_name, stable_crate_id)?;
201 if sess.opts.incremental.is_some() {
202 sess.time("incr_comp_garbage_collect_session_directories", || {
203 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
205 "Error while trying to garbage collect incremental \
206 compilation cache directory: {}",
213 let mut lint_store = rustc_lint::new_lint_store(sess.enable_internal_lints());
214 register_lints(sess, &mut lint_store);
217 sess.time("plugin_loading", || plugin::load::load_plugins(sess, metadata_loader, &krate));
218 sess.time("plugin_registration", || {
219 let mut registry = plugin::Registry { lint_store: &mut lint_store };
220 for registrar in registrars {
221 registrar(&mut registry);
225 Ok((krate, lint_store))
228 fn pre_expansion_lint<'a>(
230 lint_store: &LintStore,
231 registered_tools: &RegisteredTools,
232 check_node: impl EarlyCheckNode<'a>,
235 sess.prof.generic_activity_with_arg("pre_AST_expansion_lint_checks", node_name.as_str()).run(
237 rustc_lint::check_ast_node(
243 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
250 // Cannot implement directly for `LintStore` due to trait coherence.
251 struct LintStoreExpandImpl<'a>(&'a LintStore);
253 impl LintStoreExpand for LintStoreExpandImpl<'_> {
254 fn pre_expansion_lint(
257 registered_tools: &RegisteredTools,
258 node_id: ast::NodeId,
259 attrs: &[ast::Attribute],
260 items: &[rustc_ast::ptr::P<ast::Item>],
263 pre_expansion_lint(sess, self.0, registered_tools, (node_id, attrs, items), name);
267 /// Runs the "early phases" of the compiler: initial `cfg` processing, loading compiler plugins,
268 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
269 /// harness if one is to be provided, injection of a dependency on the
270 /// standard library and prelude, and name resolution.
271 pub fn configure_and_expand(
273 lint_store: &LintStore,
274 mut krate: ast::Crate,
276 resolver: &mut Resolver<'_>,
277 ) -> Result<ast::Crate> {
278 trace!("configure_and_expand");
279 pre_expansion_lint(sess, lint_store, resolver.registered_tools(), &krate, crate_name);
280 rustc_builtin_macros::register_builtin_macros(resolver);
282 krate = sess.time("crate_injection", || {
283 rustc_builtin_macros::standard_library_imports::inject(krate, resolver, sess)
286 util::check_attr_crate_type(sess, &krate.attrs, &mut resolver.lint_buffer());
289 krate = sess.time("macro_expand_crate", || {
290 // Windows dlls do not have rpaths, so they don't know how to find their
291 // dependencies. It's up to us to tell the system where to find all the
292 // dependent dlls. Note that this uses cfg!(windows) as opposed to
293 // targ_cfg because syntax extensions are always loaded for the host
294 // compiler, not for the target.
296 // This is somewhat of an inherently racy operation, however, as
297 // multiple threads calling this function could possibly continue
298 // extending PATH far beyond what it should. To solve this for now we
299 // just don't add any new elements to PATH which are already there
300 // within PATH. This is basically a targeted fix at #17360 for rustdoc
301 // which runs rustc in parallel but has been seen (#33844) to cause
302 // problems with PATH becoming too long.
303 let mut old_path = OsString::new();
305 old_path = env::var_os("PATH").unwrap_or(old_path);
306 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
307 for path in env::split_paths(&old_path) {
308 if !new_path.contains(&path) {
315 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
321 // Create the config for macro expansion
322 let features = sess.features_untracked();
323 let recursion_limit = get_recursion_limit(&krate.attrs, sess);
324 let cfg = rustc_expand::expand::ExpansionConfig {
325 features: Some(features),
327 trace_mac: sess.opts.unstable_opts.trace_macros,
328 should_test: sess.opts.test,
329 span_debug: sess.opts.unstable_opts.span_debug,
330 proc_macro_backtrace: sess.opts.unstable_opts.proc_macro_backtrace,
331 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
334 let lint_store = LintStoreExpandImpl(lint_store);
335 let mut ecx = ExtCtxt::new(sess, cfg, resolver, Some(&lint_store));
336 // Expand macros now!
337 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
339 // The rest is error reporting
341 sess.parse_sess.buffered_lints.with_lock(|buffered_lints: &mut Vec<BufferedEarlyLint>| {
342 buffered_lints.append(&mut ecx.buffered_early_lint);
345 sess.time("check_unused_macros", || {
346 ecx.check_unused_macros();
349 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
352 env::set_var("PATH", &old_path);
355 if recursion_limit_hit {
356 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
358 Err(ErrorGuaranteed::unchecked_claim_error_was_emitted())
364 sess.time("maybe_building_test_harness", || {
365 rustc_builtin_macros::test_harness::inject(sess, resolver, &mut krate)
368 let has_proc_macro_decls = sess.time("AST_validation", || {
369 rustc_ast_passes::ast_validation::check_crate(sess, &krate, resolver.lint_buffer())
372 let crate_types = sess.crate_types();
373 let is_executable_crate = crate_types.contains(&CrateType::Executable);
374 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
376 if crate_types.len() > 1 {
377 if is_executable_crate {
378 sess.emit_err(MixedBinCrate);
380 if is_proc_macro_crate {
381 sess.emit_err(MixedProcMacroCrate);
385 if is_proc_macro_crate && sess.panic_strategy() == PanicStrategy::Abort {
386 sess.emit_warning(ProcMacroCratePanicAbort);
389 // For backwards compatibility, we don't try to run proc macro injection
390 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
391 // specified. This should only affect users who manually invoke 'rustdoc', as
392 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
393 // However, we do emit a warning, to let such users know that they should
394 // start passing '--crate-type proc-macro'
395 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
396 sess.emit_warning(ProcMacroDocWithoutArg);
398 krate = sess.time("maybe_create_a_macro_crate", || {
399 let is_test_crate = sess.opts.test;
400 rustc_builtin_macros::proc_macro_harness::inject(
405 has_proc_macro_decls,
412 // Done with macro expansion!
414 if sess.opts.unstable_opts.input_stats {
415 eprintln!("Post-expansion node count: {}", count_nodes(&krate));
418 if sess.opts.unstable_opts.hir_stats {
419 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS", "ast-stats-2");
422 resolver.resolve_crate(&krate);
424 // Needs to go *after* expansion to be able to check the results of macro expansion.
425 sess.time("complete_gated_feature_checking", || {
426 rustc_ast_passes::feature_gate::check_crate(&krate, sess);
429 // Add all buffered lints from the `ParseSess` to the `Session`.
430 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
431 info!("{} parse sess buffered_lints", buffered_lints.len());
432 for early_lint in buffered_lints.drain(..) {
433 resolver.lint_buffer().add_early_lint(early_lint);
437 // Gate identifiers containing invalid Unicode codepoints that were recovered during lexing.
438 sess.parse_sess.bad_unicode_identifiers.with_lock(|identifiers| {
439 let mut identifiers: Vec<_> = identifiers.drain().collect();
440 identifiers.sort_by_key(|&(key, _)| key);
441 for (ident, mut spans) in identifiers.into_iter() {
443 if ident == sym::ferris {
444 let first_span = spans[0];
445 sess.emit_err(FerrisIdentifier { spans, first_span });
447 sess.emit_err(EmojiIdentifier { spans, ident });
452 sess.time("early_lint_checks", || {
453 let lint_buffer = Some(std::mem::take(resolver.lint_buffer()));
454 rustc_lint::check_ast_node(
458 resolver.registered_tools(),
460 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
468 // Returns all the paths that correspond to generated files.
469 fn generated_output_paths(
471 outputs: &OutputFilenames,
475 let mut out_filenames = Vec::new();
476 for output_type in sess.opts.output_types.keys() {
477 let file = outputs.path(*output_type);
479 // If the filename has been overridden using `-o`, it will not be modified
480 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
481 OutputType::Exe if !exact_name => {
482 for crate_type in sess.crate_types().iter() {
483 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
484 out_filenames.push(p);
487 OutputType::DepInfo if sess.opts.unstable_opts.dep_info_omit_d_target => {
488 // Don't add the dep-info output when omitting it from dep-info targets
491 out_filenames.push(file);
498 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
499 // returns None for every file path.
500 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
502 F: Fn(&PathBuf) -> Option<T>,
504 for output_path in output_paths {
505 if let Some(result) = f(output_path) {
512 fn output_contains_path(output_paths: &[PathBuf], input_path: &Path) -> bool {
513 let input_path = input_path.canonicalize().ok();
514 if input_path.is_none() {
517 let check = |output_path: &PathBuf| {
518 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
520 check_output(output_paths, check).is_some()
523 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
524 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
525 check_output(output_paths, check)
528 fn escape_dep_filename(filename: &str) -> String {
529 // Apparently clang and gcc *only* escape spaces:
530 // https://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
531 filename.replace(' ', "\\ ")
534 // Makefile comments only need escaping newlines and `\`.
535 // The result can be unescaped by anything that can unescape `escape_default` and friends.
536 fn escape_dep_env(symbol: Symbol) -> String {
537 let s = symbol.as_str();
538 let mut escaped = String::with_capacity(s.len());
541 '\n' => escaped.push_str(r"\n"),
542 '\r' => escaped.push_str(r"\r"),
543 '\\' => escaped.push_str(r"\\"),
544 _ => escaped.push(c),
552 boxed_resolver: &RefCell<BoxedResolver>,
553 outputs: &OutputFilenames,
554 out_filenames: &[PathBuf],
556 // Write out dependency rules to the dep-info file if requested
557 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
560 let deps_filename = outputs.path(OutputType::DepInfo);
562 let result = (|| -> io::Result<()> {
563 // Build a list of files used to compile the output and
564 // write Makefile-compatible dependency rules
565 let mut files: Vec<String> = sess
569 .filter(|fmap| fmap.is_real_file())
570 .filter(|fmap| !fmap.is_imported())
571 .map(|fmap| escape_dep_filename(&fmap.name.prefer_local().to_string()))
574 // Account for explicitly marked-to-track files
575 // (e.g. accessed in proc macros).
576 let file_depinfo = sess.parse_sess.file_depinfo.borrow();
578 let normalize_path = |path: PathBuf| {
579 let file = FileName::from(path);
580 escape_dep_filename(&file.prefer_local().to_string())
583 let extra_tracked_files =
584 file_depinfo.iter().map(|path_sym| normalize_path(PathBuf::from(path_sym.as_str())));
585 files.extend(extra_tracked_files);
587 // We also need to track used PGO profile files
588 if let Some(ref profile_instr) = sess.opts.cg.profile_use {
589 files.push(normalize_path(profile_instr.as_path().to_path_buf()));
591 if let Some(ref profile_sample) = sess.opts.unstable_opts.profile_sample_use {
592 files.push(normalize_path(profile_sample.as_path().to_path_buf()));
595 if sess.binary_dep_depinfo() {
596 if let Some(ref backend) = sess.opts.unstable_opts.codegen_backend {
597 if backend.contains('.') {
598 // If the backend name contain a `.`, it is the path to an external dynamic
599 // library. If not, it is not a path.
600 files.push(backend.to_string());
604 boxed_resolver.borrow_mut().access(|resolver| {
605 for cnum in resolver.cstore().crates_untracked() {
606 let source = resolver.cstore().crate_source_untracked(cnum);
607 if let Some((path, _)) = &source.dylib {
608 files.push(escape_dep_filename(&path.display().to_string()));
610 if let Some((path, _)) = &source.rlib {
611 files.push(escape_dep_filename(&path.display().to_string()));
613 if let Some((path, _)) = &source.rmeta {
614 files.push(escape_dep_filename(&path.display().to_string()));
620 let mut file = BufWriter::new(fs::File::create(&deps_filename)?);
621 for path in out_filenames {
622 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
625 // Emit a fake target for each input file to the compilation. This
626 // prevents `make` from spitting out an error if a file is later
627 // deleted. For more info see #28735
629 writeln!(file, "{path}:")?;
632 // Emit special comments with information about accessed environment variables.
633 let env_depinfo = sess.parse_sess.env_depinfo.borrow();
634 if !env_depinfo.is_empty() {
635 let mut envs: Vec<_> = env_depinfo
637 .map(|(k, v)| (escape_dep_env(*k), v.map(escape_dep_env)))
639 envs.sort_unstable();
642 write!(file, "# env-dep:{k}")?;
644 write!(file, "={v}")?;
655 if sess.opts.json_artifact_notifications {
658 .emit_artifact_notification(&deps_filename, "dep-info");
662 sess.emit_fatal(ErrorWritingDependencies { path: &deps_filename, error });
667 pub fn prepare_outputs(
671 boxed_resolver: &RefCell<BoxedResolver>,
673 ) -> Result<OutputFilenames> {
674 let _timer = sess.timer("prepare_outputs");
676 // FIXME: rustdoc passes &[] instead of &krate.attrs here
677 let outputs = util::build_output_filenames(
679 &compiler.output_dir,
680 &compiler.output_file,
687 generated_output_paths(sess, &outputs, compiler.output_file.is_some(), crate_name);
689 // Ensure the source file isn't accidentally overwritten during compilation.
690 if let Some(ref input_path) = compiler.input_path {
691 if sess.opts.will_create_output_file() {
692 if output_contains_path(&output_paths, input_path) {
693 let reported = sess.emit_err(InputFileWouldBeOverWritten { path: input_path });
694 return Err(reported);
696 if let Some(ref dir_path) = output_conflicts_with_dir(&output_paths) {
698 sess.emit_err(GeneratedFileConflictsWithDirectory { input_path, dir_path });
699 return Err(reported);
704 if let Some(ref dir) = compiler.temps_dir {
705 if fs::create_dir_all(dir).is_err() {
706 let reported = sess.emit_err(TempsDirError);
707 return Err(reported);
711 write_out_deps(sess, boxed_resolver, &outputs, &output_paths);
713 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
714 && sess.opts.output_types.len() == 1;
717 if let Some(ref dir) = compiler.output_dir {
718 if fs::create_dir_all(dir).is_err() {
719 let reported = sess.emit_err(OutDirError);
720 return Err(reported);
728 pub static DEFAULT_QUERY_PROVIDERS: LazyLock<Providers> = LazyLock::new(|| {
729 let providers = &mut Providers::default();
730 providers.analysis = analysis;
731 providers.hir_crate = rustc_ast_lowering::lower_to_hir;
732 proc_macro_decls::provide(providers);
733 rustc_const_eval::provide(providers);
734 rustc_middle::hir::provide(providers);
735 mir_borrowck::provide(providers);
736 mir_build::provide(providers);
737 rustc_mir_transform::provide(providers);
738 rustc_monomorphize::provide(providers);
739 rustc_privacy::provide(providers);
740 rustc_hir_analysis::provide(providers);
741 rustc_hir_typeck::provide(providers);
742 ty::provide(providers);
743 traits::provide(providers);
744 rustc_passes::provide(providers);
745 rustc_traits::provide(providers);
746 rustc_ty_utils::provide(providers);
747 rustc_metadata::provide(providers);
748 rustc_lint::provide(providers);
749 rustc_symbol_mangling::provide(providers);
750 rustc_codegen_ssa::provide(providers);
754 pub static DEFAULT_EXTERN_QUERY_PROVIDERS: LazyLock<ExternProviders> = LazyLock::new(|| {
755 let mut extern_providers = ExternProviders::default();
756 rustc_metadata::provide_extern(&mut extern_providers);
757 rustc_codegen_ssa::provide_extern(&mut extern_providers);
761 pub struct QueryContext<'tcx> {
762 gcx: &'tcx GlobalCtxt<'tcx>,
765 impl<'tcx> QueryContext<'tcx> {
766 pub fn enter<F, R>(&mut self, f: F) -> R
768 F: FnOnce(TyCtxt<'tcx>) -> R,
770 let icx = ty::tls::ImplicitCtxt::new(self.gcx);
771 ty::tls::enter_context(&icx, |_| f(icx.tcx))
775 pub fn create_global_ctxt<'tcx>(
776 compiler: &'tcx Compiler,
777 lint_store: Lrc<LintStore>,
778 krate: Lrc<ast::Crate>,
780 resolver: Rc<RefCell<BoxedResolver>>,
781 outputs: OutputFilenames,
783 queries: &'tcx OnceCell<TcxQueries<'tcx>>,
784 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
785 arena: &'tcx WorkerLocal<Arena<'tcx>>,
786 hir_arena: &'tcx WorkerLocal<rustc_hir::Arena<'tcx>>,
787 ) -> QueryContext<'tcx> {
788 // We're constructing the HIR here; we don't care what we will
789 // read, since we haven't even constructed the *input* to
791 dep_graph.assert_ignored();
793 let resolver_outputs = BoxedResolver::to_resolver_outputs(resolver);
795 let sess = &compiler.session();
796 let query_result_on_disk_cache = rustc_incremental::load_query_result_cache(sess);
798 let codegen_backend = compiler.codegen_backend();
799 let mut local_providers = *DEFAULT_QUERY_PROVIDERS;
800 codegen_backend.provide(&mut local_providers);
802 let mut extern_providers = *DEFAULT_EXTERN_QUERY_PROVIDERS;
803 codegen_backend.provide_extern(&mut extern_providers);
805 if let Some(callback) = compiler.override_queries {
806 callback(sess, &mut local_providers, &mut extern_providers);
809 let queries = queries.get_or_init(|| {
810 TcxQueries::new(local_providers, extern_providers, query_result_on_disk_cache)
813 let ty::ResolverOutputs {
814 global_ctxt: untracked_resolutions,
815 ast_lowering: untracked_resolver_for_lowering,
817 } = resolver_outputs;
819 let gcx = sess.time("setup_global_ctxt", || {
820 global_ctxt.get_or_init(move || {
821 TyCtxt::create_global_ctxt(
828 queries.on_disk_cache.as_ref().map(OnDiskCache::as_dyn),
830 rustc_query_impl::query_callbacks(arena),
835 let mut qcx = QueryContext { gcx };
837 let feed = tcx.feed_unit_query();
838 feed.resolver_for_lowering(
839 tcx.arena.alloc(Steal::new((untracked_resolver_for_lowering, krate))),
841 feed.resolutions(tcx.arena.alloc(untracked_resolutions));
842 feed.output_filenames(tcx.arena.alloc(std::sync::Arc::new(outputs)));
843 feed.features_query(sess.features_untracked());
844 let feed = tcx.feed_local_crate();
845 feed.crate_name(crate_name);
850 /// Runs the resolution, type-checking, region checking and other
851 /// miscellaneous analysis passes on the crate.
852 fn analysis(tcx: TyCtxt<'_>, (): ()) -> Result<()> {
853 rustc_passes::hir_id_validator::check_crate(tcx);
856 let mut entry_point = None;
858 sess.time("misc_checking_1", || {
861 entry_point = sess.time("looking_for_entry_point", || tcx.entry_fn(()));
863 sess.time("looking_for_derive_registrar", || {
864 tcx.ensure().proc_macro_decls_static(())
867 CStore::from_tcx(tcx).report_unused_deps(tcx);
870 tcx.hir().par_for_each_module(|module| {
871 tcx.ensure().check_mod_loops(module);
872 tcx.ensure().check_mod_attrs(module);
873 tcx.ensure().check_mod_naked_functions(module);
874 tcx.ensure().check_mod_unstable_api_usage(module);
875 tcx.ensure().check_mod_const_bodies(module);
879 sess.time("unused_lib_feature_checking", || {
880 rustc_passes::stability::check_unused_or_stable_features(tcx)
884 // We force these queries to run,
885 // since they might not otherwise get called.
886 // This marks the corresponding crate-level attributes
887 // as used, and ensures that their values are valid.
888 tcx.ensure().limits(());
889 tcx.ensure().stability_index(());
894 // passes are timed inside typeck
895 rustc_hir_analysis::check_crate(tcx)?;
897 sess.time("misc_checking_2", || {
900 sess.time("match_checking", || {
901 tcx.hir().par_body_owners(|def_id| tcx.ensure().check_match(def_id.to_def_id()))
905 sess.time("liveness_checking", || {
906 tcx.hir().par_body_owners(|def_id| {
907 // this must run before MIR dump, because
908 // "not all control paths return a value" is reported here.
910 // maybe move the check to a MIR pass?
911 tcx.ensure().check_liveness(def_id.to_def_id());
918 sess.time("MIR_borrow_checking", || {
919 tcx.hir().par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
922 sess.time("MIR_effect_checking", || {
923 for def_id in tcx.hir().body_owners() {
924 tcx.ensure().thir_check_unsafety(def_id);
925 if !tcx.sess.opts.unstable_opts.thir_unsafeck {
926 rustc_mir_transform::check_unsafety::check_unsafety(tcx, def_id);
928 tcx.ensure().has_ffi_unwind_calls(def_id);
930 if tcx.hir().body_const_context(def_id).is_some() {
932 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::unknown(def_id));
937 sess.time("layout_testing", || layout_test::test_layout(tcx));
939 // Avoid overwhelming user with errors if borrow checking failed.
940 // I'm not sure how helpful this is, to be honest, but it avoids a
941 // lot of annoying errors in the ui tests (basically,
942 // lint warnings and so on -- kindck used to do this abort, but
943 // kindck is gone now). -nmatsakis
944 if let Some(reported) = sess.has_errors() {
945 return Err(reported);
948 sess.time("misc_checking_3", || {
951 tcx.ensure().effective_visibilities(());
955 tcx.ensure().check_private_in_public(());
959 .par_for_each_module(|module| tcx.ensure().check_mod_deathness(module));
962 sess.time("lint_checking", || {
963 rustc_lint::check_crate(tcx, || {
964 rustc_lint::BuiltinCombinedLateLintPass::new()
971 sess.time("privacy_checking_modules", || {
972 tcx.hir().par_for_each_module(|module| {
973 tcx.ensure().check_mod_privacy(module);
979 // This check has to be run after all lints are done processing. We don't
980 // define a lint filter, as all lint checks should have finished at this point.
981 sess.time("check_lint_expectations", || tcx.check_expectations(None));
987 /// Runs the codegen backend, after which the AST and analysis can
989 pub fn start_codegen<'tcx>(
990 codegen_backend: &dyn CodegenBackend,
993 info!("Pre-codegen\n{:?}", tcx.debug_stats());
995 let (metadata, need_metadata_module) = rustc_metadata::fs::encode_and_write_metadata(tcx);
997 let codegen = tcx.sess.time("codegen_crate", move || {
998 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1001 // Don't run these test assertions when not doing codegen. Compiletest tries to build
1002 // build-fail tests in check mode first and expects it to not give an error in that case.
1003 if tcx.sess.opts.output_types.should_codegen() {
1004 rustc_incremental::assert_module_sources::assert_module_sources(tcx);
1005 rustc_symbol_mangling::test::report_symbol_names(tcx);
1008 info!("Post-codegen\n{:?}", tcx.debug_stats());
1010 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1011 if let Err(error) = rustc_mir_transform::dump_mir::emit_mir(tcx) {
1012 tcx.sess.emit_err(CantEmitMIR { error });
1013 tcx.sess.abort_if_errors();
1020 fn get_recursion_limit(krate_attrs: &[ast::Attribute], sess: &Session) -> Limit {
1021 if let Some(attr) = krate_attrs
1023 .find(|attr| attr.has_name(sym::recursion_limit) && attr.value_str().is_none())
1025 // This is here mainly to check for using a macro, such as
1026 // #![recursion_limit = foo!()]. That is not supported since that
1027 // would require expanding this while in the middle of expansion,
1028 // which needs to know the limit before expanding. Otherwise,
1029 // validation would normally be caught in AstValidator (via
1030 // `check_builtin_attribute`), but by the time that runs the macro
1031 // is expanded, and it doesn't give an error.
1032 validate_attr::emit_fatal_malformed_builtin_attribute(
1035 sym::recursion_limit,
1038 rustc_middle::middle::limits::get_recursion_limit(krate_attrs, sess)