2 CantEmitMIR, EmojiIdentifier, ErrorWritingDependencies, FerrisIdentifier,
3 GeneratedFileConflictsWithDirectory, InputFileWouldBeOverWritten, MixedBinCrate,
4 MixedProcMacroCrate, OutDirError, ProcMacroDocWithoutArg, TempsDirError,
6 use crate::interface::{Compiler, Result};
7 use crate::proc_macro_decls;
10 use ast::CRATE_NODE_ID;
11 use rustc_ast::{self as ast, visit};
12 use rustc_borrowck as mir_borrowck;
13 use rustc_codegen_ssa::traits::CodegenBackend;
14 use rustc_data_structures::parallel;
15 use rustc_data_structures::sync::{Lrc, OnceCell, WorkerLocal};
16 use rustc_errors::{ErrorGuaranteed, PResult};
17 use rustc_expand::base::{ExtCtxt, LintStoreExpand, ResolverExpand};
18 use rustc_hir::def_id::StableCrateId;
19 use rustc_hir::definitions::Definitions;
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};
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_trait_selection::traits;
42 use std::cell::RefCell;
43 use std::ffi::OsString;
44 use std::io::{self, BufWriter, Write};
45 use std::marker::PhantomPinned;
46 use std::path::{Path, PathBuf};
49 use std::sync::LazyLock;
50 use std::{env, fs, iter};
52 pub fn parse<'a>(sess: &'a Session, input: &Input) -> PResult<'a, ast::Crate> {
53 let krate = sess.time("parse_crate", || match input {
54 Input::File(file) => parse_crate_from_file(file, &sess.parse_sess),
55 Input::Str { input, name } => {
56 parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess)
60 if sess.opts.unstable_opts.input_stats {
61 eprintln!("Lines of code: {}", sess.source_map().count_lines());
62 eprintln!("Pre-expansion node count: {}", count_nodes(&krate));
65 if let Some(ref s) = sess.opts.unstable_opts.show_span {
66 rustc_ast_passes::show_span::run(sess.diagnostic(), s, &krate);
69 if sess.opts.unstable_opts.hir_stats {
70 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS", "ast-stats-1");
76 fn count_nodes(krate: &ast::Crate) -> usize {
77 let mut counter = rustc_ast_passes::node_count::NodeCounter::new();
78 visit::walk_crate(&mut counter, krate);
82 pub use boxed_resolver::BoxedResolver;
86 pub struct BoxedResolver(Pin<Box<BoxedResolverInner>>);
88 struct BoxedResolverInner {
89 session: Lrc<Session>,
90 resolver_arenas: Option<ResolverArenas<'static>>,
91 resolver: Option<Resolver<'static>>,
95 // Note: Drop order is important to prevent dangling references. Resolver must be dropped first,
96 // then resolver_arenas and session.
97 impl Drop for BoxedResolverInner {
100 self.resolver_arenas.take();
106 session: Lrc<Session>,
107 make_resolver: impl for<'a> FnOnce(&'a Session, &'a ResolverArenas<'a>) -> Resolver<'a>,
109 let mut boxed_resolver = Box::new(BoxedResolverInner {
111 resolver_arenas: Some(Resolver::arenas()),
115 // SAFETY: `make_resolver` takes a resolver arena with an arbitrary lifetime and
116 // returns a resolver with the same lifetime as the arena. We ensure that the arena
117 // outlives the resolver in the drop impl and elsewhere so these transmutes are sound.
119 let resolver = make_resolver(
120 std::mem::transmute::<&Session, &Session>(&boxed_resolver.session),
121 std::mem::transmute::<&ResolverArenas<'_>, &ResolverArenas<'_>>(
122 boxed_resolver.resolver_arenas.as_ref().unwrap(),
125 boxed_resolver.resolver = Some(resolver);
126 BoxedResolver(Pin::new_unchecked(boxed_resolver))
130 pub fn access<F: for<'a> FnOnce(&mut Resolver<'a>) -> R, R>(&mut self, f: F) -> R {
131 // SAFETY: The resolver doesn't need to be pinned.
132 let mut resolver = unsafe {
133 self.0.as_mut().map_unchecked_mut(|boxed_resolver| &mut boxed_resolver.resolver)
135 f((&mut *resolver).as_mut().unwrap())
138 pub fn to_resolver_outputs(
139 resolver: Rc<RefCell<BoxedResolver>>,
140 ) -> (Definitions, Box<CrateStoreDyn>, ty::ResolverOutputs, ty::ResolverAstLowering)
142 match Rc::try_unwrap(resolver) {
144 let mut resolver = resolver.into_inner();
145 // SAFETY: The resolver doesn't need to be pinned.
146 let mut resolver = unsafe {
150 .map_unchecked_mut(|boxed_resolver| &mut boxed_resolver.resolver)
152 resolver.take().unwrap().into_outputs()
154 Err(resolver) => resolver.borrow_mut().access(|resolver| resolver.clone_outputs()),
160 pub fn create_resolver(
162 metadata_loader: Box<MetadataLoaderDyn>,
166 trace!("create_resolver");
167 BoxedResolver::new(sess, move |sess, resolver_arenas| {
168 Resolver::new(sess, krate, crate_name, metadata_loader, resolver_arenas)
172 pub fn register_plugins<'a>(
174 metadata_loader: &'a dyn MetadataLoader,
175 register_lints: impl Fn(&Session, &mut LintStore),
176 mut krate: ast::Crate,
178 ) -> Result<(ast::Crate, LintStore)> {
179 krate = sess.time("attributes_injection", || {
180 rustc_builtin_macros::cmdline_attrs::inject(
183 &sess.opts.unstable_opts.crate_attr,
187 let (krate, features) = rustc_expand::config::features(sess, krate, CRATE_NODE_ID);
188 // these need to be set "early" so that expansion sees `quote` if enabled.
189 sess.init_features(features);
191 let crate_types = util::collect_crate_types(sess, &krate.attrs);
192 sess.init_crate_types(crate_types);
194 let stable_crate_id = StableCrateId::new(
196 sess.crate_types().contains(&CrateType::Executable),
197 sess.opts.cg.metadata.clone(),
199 sess.stable_crate_id.set(stable_crate_id).expect("not yet initialized");
200 rustc_incremental::prepare_session_directory(sess, crate_name, stable_crate_id)?;
202 if sess.opts.incremental.is_some() {
203 sess.time("incr_comp_garbage_collect_session_directories", || {
204 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
206 "Error while trying to garbage collect incremental \
207 compilation cache directory: {}",
214 let mut lint_store = rustc_lint::new_lint_store(
215 sess.opts.unstable_opts.no_interleave_lints,
216 sess.enable_internal_lints(),
218 register_lints(sess, &mut lint_store);
221 sess.time("plugin_loading", || plugin::load::load_plugins(sess, metadata_loader, &krate));
222 sess.time("plugin_registration", || {
223 let mut registry = plugin::Registry { lint_store: &mut lint_store };
224 for registrar in registrars {
225 registrar(&mut registry);
229 Ok((krate, lint_store))
232 fn pre_expansion_lint<'a>(
234 lint_store: &LintStore,
235 registered_tools: &RegisteredTools,
236 check_node: impl EarlyCheckNode<'a>,
239 sess.prof.generic_activity_with_arg("pre_AST_expansion_lint_checks", node_name).run(|| {
240 rustc_lint::check_ast_node(
246 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
252 // Cannot implement directly for `LintStore` due to trait coherence.
253 struct LintStoreExpandImpl<'a>(&'a LintStore);
255 impl LintStoreExpand for LintStoreExpandImpl<'_> {
256 fn pre_expansion_lint(
259 registered_tools: &RegisteredTools,
260 node_id: ast::NodeId,
261 attrs: &[ast::Attribute],
262 items: &[rustc_ast::ptr::P<ast::Item>],
265 pre_expansion_lint(sess, self.0, registered_tools, (node_id, attrs, items), name);
269 /// Runs the "early phases" of the compiler: initial `cfg` processing, loading compiler plugins,
270 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
271 /// harness if one is to be provided, injection of a dependency on the
272 /// standard library and prelude, and name resolution.
273 pub fn configure_and_expand(
275 lint_store: &LintStore,
276 mut krate: ast::Crate,
278 resolver: &mut Resolver<'_>,
279 ) -> Result<ast::Crate> {
280 trace!("configure_and_expand");
281 pre_expansion_lint(sess, lint_store, resolver.registered_tools(), &krate, crate_name);
282 rustc_builtin_macros::register_builtin_macros(resolver);
284 krate = sess.time("crate_injection", || {
285 rustc_builtin_macros::standard_library_imports::inject(krate, resolver, sess)
288 util::check_attr_crate_type(sess, &krate.attrs, &mut resolver.lint_buffer());
291 krate = sess.time("macro_expand_crate", || {
292 // Windows dlls do not have rpaths, so they don't know how to find their
293 // dependencies. It's up to us to tell the system where to find all the
294 // dependent dlls. Note that this uses cfg!(windows) as opposed to
295 // targ_cfg because syntax extensions are always loaded for the host
296 // compiler, not for the target.
298 // This is somewhat of an inherently racy operation, however, as
299 // multiple threads calling this function could possibly continue
300 // extending PATH far beyond what it should. To solve this for now we
301 // just don't add any new elements to PATH which are already there
302 // within PATH. This is basically a targeted fix at #17360 for rustdoc
303 // which runs rustc in parallel but has been seen (#33844) to cause
304 // problems with PATH becoming too long.
305 let mut old_path = OsString::new();
307 old_path = env::var_os("PATH").unwrap_or(old_path);
308 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
309 for path in env::split_paths(&old_path) {
310 if !new_path.contains(&path) {
317 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
323 // Create the config for macro expansion
324 let features = sess.features_untracked();
325 let recursion_limit = get_recursion_limit(&krate.attrs, sess);
326 let cfg = rustc_expand::expand::ExpansionConfig {
327 features: Some(features),
329 trace_mac: sess.opts.unstable_opts.trace_macros,
330 should_test: sess.opts.test,
331 span_debug: sess.opts.unstable_opts.span_debug,
332 proc_macro_backtrace: sess.opts.unstable_opts.proc_macro_backtrace,
333 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
336 let lint_store = LintStoreExpandImpl(lint_store);
337 let mut ecx = ExtCtxt::new(sess, cfg, resolver, Some(&lint_store));
338 // Expand macros now!
339 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
341 // The rest is error reporting
343 sess.parse_sess.buffered_lints.with_lock(|buffered_lints: &mut Vec<BufferedEarlyLint>| {
344 buffered_lints.append(&mut ecx.buffered_early_lint);
347 sess.time("check_unused_macros", || {
348 ecx.check_unused_macros();
351 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
354 env::set_var("PATH", &old_path);
357 if recursion_limit_hit {
358 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
360 Err(ErrorGuaranteed::unchecked_claim_error_was_emitted())
366 sess.time("maybe_building_test_harness", || {
367 rustc_builtin_macros::test_harness::inject(sess, resolver, &mut krate)
370 let has_proc_macro_decls = sess.time("AST_validation", || {
371 rustc_ast_passes::ast_validation::check_crate(sess, &krate, resolver.lint_buffer())
374 let crate_types = sess.crate_types();
375 let is_executable_crate = crate_types.contains(&CrateType::Executable);
376 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
378 if crate_types.len() > 1 {
379 if is_executable_crate {
380 sess.emit_err(MixedBinCrate);
382 if is_proc_macro_crate {
383 sess.emit_err(MixedProcMacroCrate);
387 // For backwards compatibility, we don't try to run proc macro injection
388 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
389 // specified. This should only affect users who manually invoke 'rustdoc', as
390 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
391 // However, we do emit a warning, to let such users know that they should
392 // start passing '--crate-type proc-macro'
393 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
394 sess.emit_warning(ProcMacroDocWithoutArg);
396 krate = sess.time("maybe_create_a_macro_crate", || {
397 let is_test_crate = sess.opts.test;
398 rustc_builtin_macros::proc_macro_harness::inject(
403 has_proc_macro_decls,
410 // Done with macro expansion!
412 if sess.opts.unstable_opts.input_stats {
413 eprintln!("Post-expansion node count: {}", count_nodes(&krate));
416 if sess.opts.unstable_opts.hir_stats {
417 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS", "ast-stats-2");
420 resolver.resolve_crate(&krate);
422 // Needs to go *after* expansion to be able to check the results of macro expansion.
423 sess.time("complete_gated_feature_checking", || {
424 rustc_ast_passes::feature_gate::check_crate(&krate, sess);
427 // Add all buffered lints from the `ParseSess` to the `Session`.
428 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
429 info!("{} parse sess buffered_lints", buffered_lints.len());
430 for early_lint in buffered_lints.drain(..) {
431 resolver.lint_buffer().add_early_lint(early_lint);
435 // Gate identifiers containing invalid Unicode codepoints that were recovered during lexing.
436 sess.parse_sess.bad_unicode_identifiers.with_lock(|identifiers| {
437 let mut identifiers: Vec<_> = identifiers.drain().collect();
438 identifiers.sort_by_key(|&(key, _)| key);
439 for (ident, mut spans) in identifiers.into_iter() {
441 if ident == sym::ferris {
442 let first_span = spans[0];
443 sess.emit_err(FerrisIdentifier { spans, first_span });
445 sess.emit_err(EmojiIdentifier { spans, ident });
450 sess.time("early_lint_checks", || {
451 let lint_buffer = Some(std::mem::take(resolver.lint_buffer()));
452 rustc_lint::check_ast_node(
456 resolver.registered_tools(),
458 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
466 // Returns all the paths that correspond to generated files.
467 fn generated_output_paths(
469 outputs: &OutputFilenames,
473 let mut out_filenames = Vec::new();
474 for output_type in sess.opts.output_types.keys() {
475 let file = outputs.path(*output_type);
477 // If the filename has been overridden using `-o`, it will not be modified
478 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
479 OutputType::Exe if !exact_name => {
480 for crate_type in sess.crate_types().iter() {
481 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
482 out_filenames.push(p);
485 OutputType::DepInfo if sess.opts.unstable_opts.dep_info_omit_d_target => {
486 // Don't add the dep-info output when omitting it from dep-info targets
489 out_filenames.push(file);
496 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
497 // returns None for every file path.
498 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
500 F: Fn(&PathBuf) -> Option<T>,
502 for output_path in output_paths {
503 if let Some(result) = f(output_path) {
510 fn output_contains_path(output_paths: &[PathBuf], input_path: &Path) -> bool {
511 let input_path = input_path.canonicalize().ok();
512 if input_path.is_none() {
515 let check = |output_path: &PathBuf| {
516 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
518 check_output(output_paths, check).is_some()
521 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
522 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
523 check_output(output_paths, check)
526 fn escape_dep_filename(filename: &str) -> String {
527 // Apparently clang and gcc *only* escape spaces:
528 // https://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
529 filename.replace(' ', "\\ ")
532 // Makefile comments only need escaping newlines and `\`.
533 // The result can be unescaped by anything that can unescape `escape_default` and friends.
534 fn escape_dep_env(symbol: Symbol) -> String {
535 let s = symbol.as_str();
536 let mut escaped = String::with_capacity(s.len());
539 '\n' => escaped.push_str(r"\n"),
540 '\r' => escaped.push_str(r"\r"),
541 '\\' => escaped.push_str(r"\\"),
542 _ => escaped.push(c),
550 boxed_resolver: &RefCell<BoxedResolver>,
551 outputs: &OutputFilenames,
552 out_filenames: &[PathBuf],
554 // Write out dependency rules to the dep-info file if requested
555 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
558 let deps_filename = outputs.path(OutputType::DepInfo);
560 let result = (|| -> io::Result<()> {
561 // Build a list of files used to compile the output and
562 // write Makefile-compatible dependency rules
563 let mut files: Vec<String> = sess
567 .filter(|fmap| fmap.is_real_file())
568 .filter(|fmap| !fmap.is_imported())
569 .map(|fmap| escape_dep_filename(&fmap.name.prefer_local().to_string()))
572 // Account for explicitly marked-to-track files
573 // (e.g. accessed in proc macros).
574 let file_depinfo = sess.parse_sess.file_depinfo.borrow();
576 let normalize_path = |path: PathBuf| {
577 let file = FileName::from(path);
578 escape_dep_filename(&file.prefer_local().to_string())
581 let extra_tracked_files =
582 file_depinfo.iter().map(|path_sym| normalize_path(PathBuf::from(path_sym.as_str())));
583 files.extend(extra_tracked_files);
585 // We also need to track used PGO profile files
586 if let Some(ref profile_instr) = sess.opts.cg.profile_use {
587 files.push(normalize_path(profile_instr.as_path().to_path_buf()));
589 if let Some(ref profile_sample) = sess.opts.unstable_opts.profile_sample_use {
590 files.push(normalize_path(profile_sample.as_path().to_path_buf()));
593 if sess.binary_dep_depinfo() {
594 if let Some(ref backend) = sess.opts.unstable_opts.codegen_backend {
595 if backend.contains('.') {
596 // If the backend name contain a `.`, it is the path to an external dynamic
597 // library. If not, it is not a path.
598 files.push(backend.to_string());
602 boxed_resolver.borrow_mut().access(|resolver| {
603 for cnum in resolver.cstore().crates_untracked() {
604 let source = resolver.cstore().crate_source_untracked(cnum);
605 if let Some((path, _)) = &source.dylib {
606 files.push(escape_dep_filename(&path.display().to_string()));
608 if let Some((path, _)) = &source.rlib {
609 files.push(escape_dep_filename(&path.display().to_string()));
611 if let Some((path, _)) = &source.rmeta {
612 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)?;
653 if sess.opts.json_artifact_notifications {
656 .emit_artifact_notification(&deps_filename, "dep-info");
660 sess.emit_fatal(ErrorWritingDependencies { path: &deps_filename, error });
665 pub fn prepare_outputs(
669 boxed_resolver: &RefCell<BoxedResolver>,
671 ) -> Result<OutputFilenames> {
672 let _timer = sess.timer("prepare_outputs");
674 // FIXME: rustdoc passes &[] instead of &krate.attrs here
675 let outputs = util::build_output_filenames(
677 &compiler.output_dir,
678 &compiler.output_file,
685 generated_output_paths(sess, &outputs, compiler.output_file.is_some(), crate_name);
687 // Ensure the source file isn't accidentally overwritten during compilation.
688 if let Some(ref input_path) = compiler.input_path {
689 if sess.opts.will_create_output_file() {
690 if output_contains_path(&output_paths, input_path) {
691 let reported = sess.emit_err(InputFileWouldBeOverWritten { path: input_path });
692 return Err(reported);
694 if let Some(ref dir_path) = output_conflicts_with_dir(&output_paths) {
696 sess.emit_err(GeneratedFileConflictsWithDirectory { input_path, dir_path });
697 return Err(reported);
702 if let Some(ref dir) = compiler.temps_dir {
703 if fs::create_dir_all(dir).is_err() {
704 let reported = sess.emit_err(TempsDirError);
705 return Err(reported);
709 write_out_deps(sess, boxed_resolver, &outputs, &output_paths);
711 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
712 && sess.opts.output_types.len() == 1;
715 if let Some(ref dir) = compiler.output_dir {
716 if fs::create_dir_all(dir).is_err() {
717 let reported = sess.emit_err(OutDirError);
718 return Err(reported);
726 pub static DEFAULT_QUERY_PROVIDERS: LazyLock<Providers> = LazyLock::new(|| {
727 let providers = &mut Providers::default();
728 providers.analysis = analysis;
729 providers.hir_crate = rustc_ast_lowering::lower_to_hir;
730 proc_macro_decls::provide(providers);
731 rustc_const_eval::provide(providers);
732 rustc_middle::hir::provide(providers);
733 mir_borrowck::provide(providers);
734 mir_build::provide(providers);
735 rustc_mir_transform::provide(providers);
736 rustc_monomorphize::provide(providers);
737 rustc_privacy::provide(providers);
738 rustc_hir_analysis::provide(providers);
739 ty::provide(providers);
740 traits::provide(providers);
741 rustc_passes::provide(providers);
742 rustc_traits::provide(providers);
743 rustc_ty_utils::provide(providers);
744 rustc_metadata::provide(providers);
745 rustc_lint::provide(providers);
746 rustc_symbol_mangling::provide(providers);
747 rustc_codegen_ssa::provide(providers);
751 pub static DEFAULT_EXTERN_QUERY_PROVIDERS: LazyLock<ExternProviders> = LazyLock::new(|| {
752 let mut extern_providers = ExternProviders::default();
753 rustc_metadata::provide_extern(&mut extern_providers);
754 rustc_codegen_ssa::provide_extern(&mut extern_providers);
758 pub struct QueryContext<'tcx> {
759 gcx: &'tcx GlobalCtxt<'tcx>,
762 impl<'tcx> QueryContext<'tcx> {
763 pub fn enter<F, R>(&mut self, f: F) -> R
765 F: FnOnce(TyCtxt<'tcx>) -> R,
767 let icx = ty::tls::ImplicitCtxt::new(self.gcx);
768 ty::tls::enter_context(&icx, |_| f(icx.tcx))
772 pub fn create_global_ctxt<'tcx>(
773 compiler: &'tcx Compiler,
774 lint_store: Lrc<LintStore>,
775 krate: Lrc<ast::Crate>,
777 resolver: Rc<RefCell<BoxedResolver>>,
778 outputs: OutputFilenames,
780 queries: &'tcx OnceCell<TcxQueries<'tcx>>,
781 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
782 arena: &'tcx WorkerLocal<Arena<'tcx>>,
783 hir_arena: &'tcx WorkerLocal<rustc_hir::Arena<'tcx>>,
784 ) -> QueryContext<'tcx> {
785 // We're constructing the HIR here; we don't care what we will
786 // read, since we haven't even constructed the *input* to
788 dep_graph.assert_ignored();
790 let (definitions, cstore, resolver_outputs, resolver_for_lowering) =
791 BoxedResolver::to_resolver_outputs(resolver);
793 let sess = &compiler.session();
794 let query_result_on_disk_cache = rustc_incremental::load_query_result_cache(sess);
796 let codegen_backend = compiler.codegen_backend();
797 let mut local_providers = *DEFAULT_QUERY_PROVIDERS;
798 codegen_backend.provide(&mut local_providers);
800 let mut extern_providers = *DEFAULT_EXTERN_QUERY_PROVIDERS;
801 codegen_backend.provide_extern(&mut extern_providers);
803 if let Some(callback) = compiler.override_queries {
804 callback(sess, &mut local_providers, &mut extern_providers);
807 let queries = queries.get_or_init(|| {
808 TcxQueries::new(local_providers, extern_providers, query_result_on_disk_cache)
811 let gcx = sess.time("setup_global_ctxt", || {
812 global_ctxt.get_or_init(move || {
813 TyCtxt::create_global_ctxt(
821 resolver_for_lowering,
824 queries.on_disk_cache.as_ref().map(OnDiskCache::as_dyn),
826 rustc_query_impl::query_callbacks(arena),
836 /// Runs the resolution, type-checking, region checking and other
837 /// miscellaneous analysis passes on the crate.
838 fn analysis(tcx: TyCtxt<'_>, (): ()) -> Result<()> {
839 rustc_passes::hir_id_validator::check_crate(tcx);
842 let mut entry_point = None;
844 sess.time("misc_checking_1", || {
847 entry_point = sess.time("looking_for_entry_point", || tcx.entry_fn(()));
849 sess.time("looking_for_derive_registrar", || {
850 tcx.ensure().proc_macro_decls_static(())
853 CStore::from_tcx(tcx).report_unused_deps(tcx);
856 tcx.hir().par_for_each_module(|module| {
857 tcx.ensure().check_mod_loops(module);
858 tcx.ensure().check_mod_attrs(module);
859 tcx.ensure().check_mod_naked_functions(module);
860 tcx.ensure().check_mod_unstable_api_usage(module);
861 tcx.ensure().check_mod_const_bodies(module);
865 sess.time("unused_lib_feature_checking", || {
866 rustc_passes::stability::check_unused_or_stable_features(tcx)
870 // We force these queries to run,
871 // since they might not otherwise get called.
872 // This marks the corresponding crate-level attributes
873 // as used, and ensures that their values are valid.
874 tcx.ensure().limits(());
875 tcx.ensure().stability_index(());
880 // passes are timed inside typeck
881 rustc_hir_analysis::check_crate(tcx)?;
883 sess.time("misc_checking_2", || {
886 sess.time("match_checking", || {
887 tcx.hir().par_body_owners(|def_id| tcx.ensure().check_match(def_id.to_def_id()))
891 sess.time("liveness_checking", || {
892 tcx.hir().par_body_owners(|def_id| {
893 // this must run before MIR dump, because
894 // "not all control paths return a value" is reported here.
896 // maybe move the check to a MIR pass?
897 tcx.ensure().check_liveness(def_id.to_def_id());
904 sess.time("MIR_borrow_checking", || {
905 tcx.hir().par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
908 sess.time("MIR_effect_checking", || {
909 for def_id in tcx.hir().body_owners() {
910 tcx.ensure().thir_check_unsafety(def_id);
911 if !tcx.sess.opts.unstable_opts.thir_unsafeck {
912 rustc_mir_transform::check_unsafety::check_unsafety(tcx, def_id);
914 tcx.ensure().has_ffi_unwind_calls(def_id);
916 if tcx.hir().body_const_context(def_id).is_some() {
918 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::unknown(def_id));
923 sess.time("layout_testing", || layout_test::test_layout(tcx));
925 // Avoid overwhelming user with errors if borrow checking failed.
926 // I'm not sure how helpful this is, to be honest, but it avoids a
927 // lot of annoying errors in the ui tests (basically,
928 // lint warnings and so on -- kindck used to do this abort, but
929 // kindck is gone now). -nmatsakis
930 if let Some(reported) = sess.has_errors() {
931 return Err(reported);
934 sess.time("misc_checking_3", || {
937 tcx.ensure().privacy_access_levels(());
941 tcx.ensure().check_private_in_public(());
945 .par_for_each_module(|module| tcx.ensure().check_mod_deathness(module));
948 sess.time("lint_checking", || {
949 rustc_lint::check_crate(tcx, || {
950 rustc_lint::BuiltinCombinedLateLintPass::new()
957 sess.time("privacy_checking_modules", || {
958 tcx.hir().par_for_each_module(|module| {
959 tcx.ensure().check_mod_privacy(module);
965 // This check has to be run after all lints are done processing. We don't
966 // define a lint filter, as all lint checks should have finished at this point.
967 sess.time("check_lint_expectations", || tcx.check_expectations(None));
973 /// Runs the codegen backend, after which the AST and analysis can
975 pub fn start_codegen<'tcx>(
976 codegen_backend: &dyn CodegenBackend,
978 outputs: &OutputFilenames,
980 info!("Pre-codegen\n{:?}", tcx.debug_stats());
982 let (metadata, need_metadata_module) =
983 rustc_metadata::fs::encode_and_write_metadata(tcx, outputs);
985 let codegen = tcx.sess.time("codegen_crate", move || {
986 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
989 // Don't run these test assertions when not doing codegen. Compiletest tries to build
990 // build-fail tests in check mode first and expects it to not give an error in that case.
991 if tcx.sess.opts.output_types.should_codegen() {
992 rustc_incremental::assert_module_sources::assert_module_sources(tcx);
993 rustc_symbol_mangling::test::report_symbol_names(tcx);
996 info!("Post-codegen\n{:?}", tcx.debug_stats());
998 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
999 if let Err(error) = rustc_mir_transform::dump_mir::emit_mir(tcx, outputs) {
1000 tcx.sess.emit_err(CantEmitMIR { error });
1001 tcx.sess.abort_if_errors();
1008 fn get_recursion_limit(krate_attrs: &[ast::Attribute], sess: &Session) -> Limit {
1009 if let Some(attr) = krate_attrs
1011 .find(|attr| attr.has_name(sym::recursion_limit) && attr.value_str().is_none())
1013 // This is here mainly to check for using a macro, such as
1014 // #![recursion_limit = foo!()]. That is not supported since that
1015 // would require expanding this while in the middle of expansion,
1016 // which needs to know the limit before expanding. Otherwise,
1017 // validation would normally be caught in AstValidator (via
1018 // `check_builtin_attribute`), but by the time that runs the macro
1019 // is expanded, and it doesn't give an error.
1020 validate_attr::emit_fatal_malformed_builtin_attribute(
1023 sym::recursion_limit,
1026 rustc_middle::middle::limits::get_recursion_limit(krate_attrs, sess)