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_borrowck as mir_borrowck;
8 use rustc_codegen_ssa::back::link::emit_metadata;
9 use rustc_codegen_ssa::traits::CodegenBackend;
10 use rustc_data_structures::parallel;
11 use rustc_data_structures::sync::{Lrc, OnceCell, WorkerLocal};
12 use rustc_data_structures::temp_dir::MaybeTempDir;
13 use rustc_errors::{ErrorReported, PResult};
14 use rustc_expand::base::ExtCtxt;
15 use rustc_hir::def_id::{StableCrateId, LOCAL_CRATE};
17 use rustc_lint::LintStore;
18 use rustc_metadata::creader::CStore;
19 use rustc_metadata::{encode_metadata, EncodedMetadata};
20 use rustc_middle::arena::Arena;
21 use rustc_middle::dep_graph::DepGraph;
22 use rustc_middle::ty::query::{ExternProviders, Providers};
23 use rustc_middle::ty::{self, GlobalCtxt, ResolverOutputs, TyCtxt};
24 use rustc_mir_build as mir_build;
25 use rustc_parse::{parse_crate_from_file, parse_crate_from_source_str, validate_attr};
26 use rustc_passes::{self, hir_stats, layout_test};
27 use rustc_plugin_impl as plugin;
28 use rustc_query_impl::{OnDiskCache, Queries as TcxQueries};
29 use rustc_resolve::{Resolver, ResolverArenas};
30 use rustc_serialize::json;
31 use rustc_session::config::{CrateType, Input, OutputFilenames, OutputType, PpMode, PpSourceMode};
32 use rustc_session::cstore::{MetadataLoader, MetadataLoaderDyn};
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::{Limit, Session};
37 use rustc_span::symbol::{sym, Ident, Symbol};
38 use rustc_span::{FileName, MultiSpan};
39 use rustc_trait_selection::traits;
40 use rustc_typeck as typeck;
41 use tempfile::Builder as TempFileBuilder;
42 use tracing::{info, warn};
45 use std::cell::RefCell;
46 use std::ffi::OsString;
47 use std::io::{self, BufWriter, Write};
48 use std::lazy::SyncLazy;
49 use std::marker::PhantomPinned;
50 use std::path::{Path, PathBuf};
53 use std::{env, fs, iter};
55 pub fn parse<'a>(sess: &'a Session, input: &Input) -> PResult<'a, ast::Crate> {
56 let krate = sess.time("parse_crate", || match input {
57 Input::File(file) => parse_crate_from_file(file, &sess.parse_sess),
58 Input::Str { input, name } => {
59 parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess)
63 if sess.opts.debugging_opts.ast_json_noexpand {
64 println!("{}", json::as_json(&krate));
67 if sess.opts.debugging_opts.input_stats {
68 eprintln!("Lines of code: {}", sess.source_map().count_lines());
69 eprintln!("Pre-expansion node count: {}", count_nodes(&krate));
72 if let Some(ref s) = sess.opts.debugging_opts.show_span {
73 rustc_ast_passes::show_span::run(sess.diagnostic(), s, &krate);
76 if sess.opts.debugging_opts.hir_stats {
77 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
83 fn count_nodes(krate: &ast::Crate) -> usize {
84 let mut counter = rustc_ast_passes::node_count::NodeCounter::new();
85 visit::walk_crate(&mut counter, krate);
89 pub use boxed_resolver::BoxedResolver;
93 pub struct BoxedResolver(Pin<Box<BoxedResolverInner>>);
95 struct BoxedResolverInner {
96 session: Lrc<Session>,
97 resolver_arenas: Option<ResolverArenas<'static>>,
98 resolver: Option<Resolver<'static>>,
102 // Note: Drop order is important to prevent dangling references. Resolver must be dropped first,
103 // then resolver_arenas and session.
104 impl Drop for BoxedResolverInner {
106 self.resolver.take();
107 self.resolver_arenas.take();
113 session: Lrc<Session>,
114 make_resolver: impl for<'a> FnOnce(&'a Session, &'a ResolverArenas<'a>) -> Resolver<'a>,
116 let mut boxed_resolver = Box::new(BoxedResolverInner {
118 resolver_arenas: Some(Resolver::arenas()),
122 // SAFETY: `make_resolver` takes a resolver arena with an arbitrary lifetime and
123 // returns a resolver with the same lifetime as the arena. We ensure that the arena
124 // outlives the resolver in the drop impl and elsewhere so these transmutes are sound.
126 let resolver = make_resolver(
127 std::mem::transmute::<&Session, &Session>(&boxed_resolver.session),
128 std::mem::transmute::<&ResolverArenas<'_>, &ResolverArenas<'_>>(
129 boxed_resolver.resolver_arenas.as_ref().unwrap(),
132 boxed_resolver.resolver = Some(resolver);
133 BoxedResolver(Pin::new_unchecked(boxed_resolver))
137 pub fn access<F: for<'a> FnOnce(&mut Resolver<'a>) -> R, R>(&mut self, f: F) -> R {
138 // SAFETY: The resolver doesn't need to be pinned.
139 let mut resolver = unsafe {
140 self.0.as_mut().map_unchecked_mut(|boxed_resolver| &mut boxed_resolver.resolver)
142 f((&mut *resolver).as_mut().unwrap())
145 pub fn to_resolver_outputs(resolver: Rc<RefCell<BoxedResolver>>) -> ResolverOutputs {
146 match Rc::try_unwrap(resolver) {
148 let mut resolver = resolver.into_inner();
149 // SAFETY: The resolver doesn't need to be pinned.
150 let mut resolver = unsafe {
154 .map_unchecked_mut(|boxed_resolver| &mut boxed_resolver.resolver)
156 resolver.take().unwrap().into_outputs()
158 Err(resolver) => resolver.borrow_mut().access(|resolver| resolver.clone_outputs()),
164 pub fn create_resolver(
166 metadata_loader: Box<MetadataLoaderDyn>,
170 tracing::trace!("create_resolver");
171 BoxedResolver::new(sess, move |sess, resolver_arenas| {
172 Resolver::new(sess, krate, crate_name, metadata_loader, resolver_arenas)
176 pub fn register_plugins<'a>(
178 metadata_loader: &'a dyn MetadataLoader,
179 register_lints: impl Fn(&Session, &mut LintStore),
180 mut krate: ast::Crate,
182 ) -> Result<(ast::Crate, LintStore)> {
183 krate = sess.time("attributes_injection", || {
184 rustc_builtin_macros::cmdline_attrs::inject(
187 &sess.opts.debugging_opts.crate_attr,
191 let (krate, features) = rustc_expand::config::features(sess, krate);
192 // these need to be set "early" so that expansion sees `quote` if enabled.
193 sess.init_features(features);
195 let crate_types = util::collect_crate_types(sess, &krate.attrs);
196 sess.init_crate_types(crate_types);
198 let stable_crate_id = StableCrateId::new(
200 sess.crate_types().contains(&CrateType::Executable),
201 sess.opts.cg.metadata.clone(),
203 sess.stable_crate_id.set(stable_crate_id).expect("not yet initialized");
204 rustc_incremental::prepare_session_directory(sess, crate_name, stable_crate_id)?;
206 if sess.opts.incremental.is_some() {
207 sess.time("incr_comp_garbage_collect_session_directories", || {
208 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
210 "Error while trying to garbage collect incremental \
211 compilation cache directory: {}",
218 let mut lint_store = rustc_lint::new_lint_store(
219 sess.opts.debugging_opts.no_interleave_lints,
220 sess.unstable_options(),
222 register_lints(sess, &mut lint_store);
225 sess.time("plugin_loading", || plugin::load::load_plugins(sess, metadata_loader, &krate));
226 sess.time("plugin_registration", || {
227 let mut registry = plugin::Registry { lint_store: &mut lint_store };
228 for registrar in registrars {
229 registrar(&mut registry);
233 Ok((krate, lint_store))
236 fn pre_expansion_lint(
238 lint_store: &LintStore,
240 crate_attrs: &[ast::Attribute],
243 sess.prof.generic_activity_with_arg("pre_AST_expansion_lint_checks", crate_name).run(|| {
244 rustc_lint::check_ast_crate(
251 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
256 /// Runs the "early phases" of the compiler: initial `cfg` processing, loading compiler plugins,
257 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
258 /// harness if one is to be provided, injection of a dependency on the
259 /// standard library and prelude, and name resolution.
260 pub fn configure_and_expand(
262 lint_store: &LintStore,
263 mut krate: ast::Crate,
265 resolver: &mut Resolver<'_>,
266 ) -> Result<ast::Crate> {
267 tracing::trace!("configure_and_expand");
268 pre_expansion_lint(sess, lint_store, &krate, &krate.attrs, crate_name);
269 rustc_builtin_macros::register_builtin_macros(resolver);
271 krate = sess.time("crate_injection", || {
272 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| Symbol::intern(s));
273 rustc_builtin_macros::standard_library_imports::inject(krate, resolver, sess, alt_std_name)
276 util::check_attr_crate_type(sess, &krate.attrs, &mut resolver.lint_buffer());
279 krate = sess.time("macro_expand_crate", || {
280 // Windows dlls do not have rpaths, so they don't know how to find their
281 // dependencies. It's up to us to tell the system where to find all the
282 // dependent dlls. Note that this uses cfg!(windows) as opposed to
283 // targ_cfg because syntax extensions are always loaded for the host
284 // compiler, not for the target.
286 // This is somewhat of an inherently racy operation, however, as
287 // multiple threads calling this function could possibly continue
288 // extending PATH far beyond what it should. To solve this for now we
289 // just don't add any new elements to PATH which are already there
290 // within PATH. This is basically a targeted fix at #17360 for rustdoc
291 // which runs rustc in parallel but has been seen (#33844) to cause
292 // problems with PATH becoming too long.
293 let mut old_path = OsString::new();
295 old_path = env::var_os("PATH").unwrap_or(old_path);
296 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
297 for path in env::split_paths(&old_path) {
298 if !new_path.contains(&path) {
305 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
311 // Create the config for macro expansion
312 let features = sess.features_untracked();
313 let recursion_limit = get_recursion_limit(&krate.attrs, sess);
314 let cfg = rustc_expand::expand::ExpansionConfig {
315 features: Some(features),
317 trace_mac: sess.opts.debugging_opts.trace_macros,
318 should_test: sess.opts.test,
319 span_debug: sess.opts.debugging_opts.span_debug,
320 proc_macro_backtrace: sess.opts.debugging_opts.proc_macro_backtrace,
321 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
324 let crate_attrs = krate.attrs.clone();
325 let extern_mod_loaded = |ident: Ident, attrs, items, span| {
326 let krate = ast::Crate { attrs, items, span, is_placeholder: None };
327 pre_expansion_lint(sess, lint_store, &krate, &crate_attrs, &ident.name.as_str());
328 (krate.attrs, krate.items)
330 let mut ecx = ExtCtxt::new(sess, cfg, resolver, Some(&extern_mod_loaded));
332 // Expand macros now!
333 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
335 // The rest is error reporting
337 sess.time("check_unused_macros", || {
338 ecx.check_unused_macros();
341 let mut missing_fragment_specifiers: Vec<_> = ecx
344 .missing_fragment_specifiers
347 .map(|(span, node_id)| (*span, *node_id))
349 missing_fragment_specifiers.sort_unstable_by_key(|(span, _)| *span);
351 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
353 for (span, node_id) in missing_fragment_specifiers {
354 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
355 let msg = "missing fragment specifier";
356 resolver.lint_buffer().buffer_lint(lint, node_id, span, msg);
359 env::set_var("PATH", &old_path);
362 if recursion_limit_hit {
363 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
371 sess.time("maybe_building_test_harness", || {
372 rustc_builtin_macros::test_harness::inject(sess, resolver, &mut krate)
375 if let Some(PpMode::Source(PpSourceMode::EveryBodyLoops)) = sess.opts.pretty {
376 tracing::debug!("replacing bodies with loop {{}}");
377 util::ReplaceBodyWithLoop::new(resolver).visit_crate(&mut krate);
380 let has_proc_macro_decls = sess.time("AST_validation", || {
381 rustc_ast_passes::ast_validation::check_crate(sess, &krate, resolver.lint_buffer())
384 let crate_types = sess.crate_types();
385 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
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 let mut msg = sess.diagnostic().struct_warn(
395 "Trying to document proc macro crate \
396 without passing '--crate-type proc-macro to rustdoc",
399 msg.warn("The generated documentation may be incorrect");
402 krate = sess.time("maybe_create_a_macro_crate", || {
403 let num_crate_types = crate_types.len();
404 let is_test_crate = sess.opts.test;
405 rustc_builtin_macros::proc_macro_harness::inject(
410 has_proc_macro_decls,
418 // Done with macro expansion!
420 if sess.opts.debugging_opts.input_stats {
421 eprintln!("Post-expansion node count: {}", count_nodes(&krate));
424 if sess.opts.debugging_opts.hir_stats {
425 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
428 if sess.opts.debugging_opts.ast_json {
429 println!("{}", json::as_json(&krate));
432 resolver.resolve_crate(&krate);
434 // Needs to go *after* expansion to be able to check the results of macro expansion.
435 sess.time("complete_gated_feature_checking", || {
436 rustc_ast_passes::feature_gate::check_crate(&krate, sess);
439 // Add all buffered lints from the `ParseSess` to the `Session`.
440 // The ReplaceBodyWithLoop pass may have deleted some AST nodes, potentially
441 // causing a delay_span_bug later if a buffered lint refers to such a deleted
442 // AST node (issue #87308). Since everybody_loops is for pretty-printing only,
443 // anyway, we simply skip all buffered lints here.
444 if !matches!(sess.opts.pretty, Some(PpMode::Source(PpSourceMode::EveryBodyLoops))) {
445 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
446 info!("{} parse sess buffered_lints", buffered_lints.len());
447 for early_lint in buffered_lints.drain(..) {
448 resolver.lint_buffer().add_early_lint(early_lint);
453 // Gate identifiers containing invalid Unicode codepoints that were recovered during lexing.
454 sess.parse_sess.bad_unicode_identifiers.with_lock(|identifiers| {
455 let mut identifiers: Vec<_> = identifiers.drain().collect();
456 identifiers.sort_by_key(|&(key, _)| key);
457 for (ident, mut spans) in identifiers.into_iter() {
459 sess.diagnostic().span_err(
460 MultiSpan::from(spans),
461 &format!("identifiers cannot contain emoji: `{}`", ident),
469 pub fn lower_to_hir<'res, 'tcx>(
471 lint_store: &LintStore,
472 resolver: &'res mut Resolver<'_>,
473 krate: Rc<ast::Crate>,
474 arena: &'tcx rustc_ast_lowering::Arena<'tcx>,
475 ) -> &'tcx Crate<'tcx> {
477 let hir_crate = rustc_ast_lowering::lower_crate(
481 rustc_parse::nt_to_tokenstream,
485 sess.time("early_lint_checks", || {
486 rustc_lint::check_ast_crate(
492 Some(std::mem::take(resolver.lint_buffer())),
493 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
497 // Drop AST to free memory
498 sess.time("drop_ast", || std::mem::drop(krate));
500 // Discard hygiene data, which isn't required after lowering to HIR.
501 if !sess.opts.debugging_opts.keep_hygiene_data {
502 rustc_span::hygiene::clear_syntax_context_map();
508 // Returns all the paths that correspond to generated files.
509 fn generated_output_paths(
511 outputs: &OutputFilenames,
515 let mut out_filenames = Vec::new();
516 for output_type in sess.opts.output_types.keys() {
517 let file = outputs.path(*output_type);
519 // If the filename has been overridden using `-o`, it will not be modified
520 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
521 OutputType::Exe if !exact_name => {
522 for crate_type in sess.crate_types().iter() {
523 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
524 out_filenames.push(p);
527 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
528 // Don't add the dep-info output when omitting it from dep-info targets
531 out_filenames.push(file);
538 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
539 // returns None for every file path.
540 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
542 F: Fn(&PathBuf) -> Option<T>,
544 for output_path in output_paths {
545 if let Some(result) = f(output_path) {
552 fn output_contains_path(output_paths: &[PathBuf], input_path: &Path) -> bool {
553 let input_path = input_path.canonicalize().ok();
554 if input_path.is_none() {
557 let check = |output_path: &PathBuf| {
558 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
560 check_output(output_paths, check).is_some()
563 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
564 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
565 check_output(output_paths, check)
568 fn escape_dep_filename(filename: &str) -> String {
569 // Apparently clang and gcc *only* escape spaces:
570 // https://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
571 filename.replace(" ", "\\ ")
574 // Makefile comments only need escaping newlines and `\`.
575 // The result can be unescaped by anything that can unescape `escape_default` and friends.
576 fn escape_dep_env(symbol: Symbol) -> String {
577 let s = symbol.as_str();
578 let mut escaped = String::with_capacity(s.len());
581 '\n' => escaped.push_str(r"\n"),
582 '\r' => escaped.push_str(r"\r"),
583 '\\' => escaped.push_str(r"\\"),
584 _ => escaped.push(c),
592 boxed_resolver: &RefCell<BoxedResolver>,
593 outputs: &OutputFilenames,
594 out_filenames: &[PathBuf],
596 // Write out dependency rules to the dep-info file if requested
597 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
600 let deps_filename = outputs.path(OutputType::DepInfo);
602 let result = (|| -> io::Result<()> {
603 // Build a list of files used to compile the output and
604 // write Makefile-compatible dependency rules
605 let mut files: Vec<String> = sess
609 .filter(|fmap| fmap.is_real_file())
610 .filter(|fmap| !fmap.is_imported())
611 .map(|fmap| escape_dep_filename(&fmap.name.prefer_local().to_string()))
614 // Account for explicitly marked-to-track files
615 // (e.g. accessed in proc macros).
616 let file_depinfo = sess.parse_sess.file_depinfo.borrow();
617 let extra_tracked_files = file_depinfo.iter().map(|path_sym| {
618 let path = PathBuf::from(&*path_sym.as_str());
619 let file = FileName::from(path);
620 escape_dep_filename(&file.prefer_local().to_string())
622 files.extend(extra_tracked_files);
624 if let Some(ref backend) = sess.opts.debugging_opts.codegen_backend {
625 files.push(backend.to_string());
628 if sess.binary_dep_depinfo() {
629 boxed_resolver.borrow_mut().access(|resolver| {
630 for cnum in resolver.cstore().crates_untracked() {
631 let source = resolver.cstore().crate_source_untracked(cnum);
632 if let Some((path, _)) = source.dylib {
633 files.push(escape_dep_filename(&path.display().to_string()));
635 if let Some((path, _)) = source.rlib {
636 files.push(escape_dep_filename(&path.display().to_string()));
638 if let Some((path, _)) = source.rmeta {
639 files.push(escape_dep_filename(&path.display().to_string()));
645 let mut file = BufWriter::new(fs::File::create(&deps_filename)?);
646 for path in out_filenames {
647 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
650 // Emit a fake target for each input file to the compilation. This
651 // prevents `make` from spitting out an error if a file is later
652 // deleted. For more info see #28735
654 writeln!(file, "{}:", path)?;
657 // Emit special comments with information about accessed environment variables.
658 let env_depinfo = sess.parse_sess.env_depinfo.borrow();
659 if !env_depinfo.is_empty() {
660 let mut envs: Vec<_> = env_depinfo
662 .map(|(k, v)| (escape_dep_env(*k), v.map(escape_dep_env)))
664 envs.sort_unstable();
667 write!(file, "# env-dep:{}", k)?;
669 write!(file, "={}", v)?;
680 if sess.opts.json_artifact_notifications {
683 .emit_artifact_notification(&deps_filename, "dep-info");
686 Err(e) => sess.fatal(&format!(
687 "error writing dependencies to `{}`: {}",
688 deps_filename.display(),
694 pub fn prepare_outputs(
698 boxed_resolver: &RefCell<BoxedResolver>,
700 ) -> Result<OutputFilenames> {
701 let _timer = sess.timer("prepare_outputs");
703 // FIXME: rustdoc passes &[] instead of &krate.attrs here
704 let outputs = util::build_output_filenames(
706 &compiler.output_dir,
707 &compiler.output_file,
714 generated_output_paths(sess, &outputs, compiler.output_file.is_some(), crate_name);
716 // Ensure the source file isn't accidentally overwritten during compilation.
717 if let Some(ref input_path) = compiler.input_path {
718 if sess.opts.will_create_output_file() {
719 if output_contains_path(&output_paths, input_path) {
721 "the input file \"{}\" would be overwritten by the generated \
725 return Err(ErrorReported);
727 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
729 "the generated executable for the input file \"{}\" conflicts with the \
730 existing directory \"{}\"",
731 input_path.display(),
734 return Err(ErrorReported);
739 if let Some(ref dir) = compiler.temps_dir {
740 if fs::create_dir_all(dir).is_err() {
741 sess.err("failed to find or create the directory specified by `--temps-dir`");
742 return Err(ErrorReported);
746 write_out_deps(sess, boxed_resolver, &outputs, &output_paths);
748 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
749 && sess.opts.output_types.len() == 1;
752 if let Some(ref dir) = compiler.output_dir {
753 if fs::create_dir_all(dir).is_err() {
754 sess.err("failed to find or create the directory specified by `--out-dir`");
755 return Err(ErrorReported);
763 pub static DEFAULT_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
764 let providers = &mut Providers::default();
765 providers.analysis = analysis;
766 proc_macro_decls::provide(providers);
767 rustc_const_eval::provide(providers);
768 rustc_middle::hir::provide(providers);
769 mir_borrowck::provide(providers);
770 mir_build::provide(providers);
771 rustc_mir_transform::provide(providers);
772 rustc_monomorphize::provide(providers);
773 rustc_privacy::provide(providers);
774 typeck::provide(providers);
775 ty::provide(providers);
776 traits::provide(providers);
777 rustc_passes::provide(providers);
778 rustc_resolve::provide(providers);
779 rustc_traits::provide(providers);
780 rustc_ty_utils::provide(providers);
781 rustc_metadata::provide(providers);
782 rustc_lint::provide(providers);
783 rustc_symbol_mangling::provide(providers);
784 rustc_codegen_ssa::provide(providers);
788 pub static DEFAULT_EXTERN_QUERY_PROVIDERS: SyncLazy<ExternProviders> = SyncLazy::new(|| {
789 let mut extern_providers = ExternProviders::default();
790 rustc_metadata::provide_extern(&mut extern_providers);
791 rustc_codegen_ssa::provide_extern(&mut extern_providers);
795 pub struct QueryContext<'tcx> {
796 gcx: &'tcx GlobalCtxt<'tcx>,
799 impl<'tcx> QueryContext<'tcx> {
800 pub fn enter<F, R>(&mut self, f: F) -> R
802 F: FnOnce(TyCtxt<'tcx>) -> R,
804 let icx = ty::tls::ImplicitCtxt::new(self.gcx);
805 ty::tls::enter_context(&icx, |_| f(icx.tcx))
809 pub fn create_global_ctxt<'tcx>(
810 compiler: &'tcx Compiler,
811 lint_store: Lrc<LintStore>,
812 krate: Rc<ast::Crate>,
814 resolver: Rc<RefCell<BoxedResolver>>,
815 outputs: OutputFilenames,
817 queries: &'tcx OnceCell<TcxQueries<'tcx>>,
818 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
819 arena: &'tcx WorkerLocal<Arena<'tcx>>,
820 hir_arena: &'tcx WorkerLocal<rustc_ast_lowering::Arena<'tcx>>,
821 ) -> QueryContext<'tcx> {
822 // We're constructing the HIR here; we don't care what we will
823 // read, since we haven't even constructed the *input* to
825 dep_graph.assert_ignored();
827 let sess = &compiler.session();
830 .access(|resolver| lower_to_hir(sess, &lint_store, resolver, krate, hir_arena));
831 let resolver_outputs = BoxedResolver::to_resolver_outputs(resolver);
833 let query_result_on_disk_cache = rustc_incremental::load_query_result_cache(sess);
835 let codegen_backend = compiler.codegen_backend();
836 let mut local_providers = *DEFAULT_QUERY_PROVIDERS;
837 codegen_backend.provide(&mut local_providers);
839 let mut extern_providers = *DEFAULT_EXTERN_QUERY_PROVIDERS;
840 codegen_backend.provide_extern(&mut extern_providers);
842 if let Some(callback) = compiler.override_queries {
843 callback(sess, &mut local_providers, &mut extern_providers);
846 let queries = queries.get_or_init(|| {
847 TcxQueries::new(local_providers, extern_providers, query_result_on_disk_cache)
850 let gcx = sess.time("setup_global_ctxt", || {
851 global_ctxt.get_or_init(move || {
852 TyCtxt::create_global_ctxt(
859 queries.on_disk_cache.as_ref().map(OnDiskCache::as_dyn),
861 rustc_query_impl::query_callbacks(arena),
871 /// Runs the resolution, type-checking, region checking and other
872 /// miscellaneous analysis passes on the crate.
873 fn analysis(tcx: TyCtxt<'_>, (): ()) -> Result<()> {
874 rustc_passes::hir_id_validator::check_crate(tcx);
877 let mut entry_point = None;
879 sess.time("misc_checking_1", || {
882 entry_point = sess.time("looking_for_entry_point", || tcx.entry_fn(()));
884 sess.time("looking_for_derive_registrar", || {
885 tcx.ensure().proc_macro_decls_static(())
888 CStore::from_tcx(tcx).report_unused_deps(tcx);
891 tcx.hir().par_for_each_module(|module| {
892 tcx.ensure().check_mod_loops(module);
893 tcx.ensure().check_mod_attrs(module);
894 tcx.ensure().check_mod_naked_functions(module);
895 tcx.ensure().check_mod_unstable_api_usage(module);
896 tcx.ensure().check_mod_const_bodies(module);
900 // We force these querie to run,
901 // since they might not otherwise get called.
902 // This marks the corresponding crate-level attributes
903 // as used, and ensures that their values are valid.
904 tcx.ensure().limits(());
909 // passes are timed inside typeck
910 typeck::check_crate(tcx)?;
912 sess.time("misc_checking_2", || {
915 sess.time("match_checking", || {
916 tcx.hir().par_body_owners(|def_id| tcx.ensure().check_match(def_id.to_def_id()))
920 sess.time("liveness_and_intrinsic_checking", || {
921 tcx.hir().par_for_each_module(|module| {
922 // this must run before MIR dump, because
923 // "not all control paths return a value" is reported here.
925 // maybe move the check to a MIR pass?
926 tcx.ensure().check_mod_liveness(module);
927 tcx.ensure().check_mod_intrinsics(module);
934 sess.time("MIR_borrow_checking", || {
935 tcx.hir().par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
938 sess.time("MIR_effect_checking", || {
939 for def_id in tcx.hir().body_owners() {
940 tcx.ensure().thir_check_unsafety(def_id);
941 if !tcx.sess.opts.debugging_opts.thir_unsafeck {
942 rustc_mir_transform::check_unsafety::check_unsafety(tcx, def_id);
945 if tcx.hir().body_const_context(def_id).is_some() {
947 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::unknown(def_id));
952 sess.time("layout_testing", || layout_test::test_layout(tcx));
954 // Avoid overwhelming user with errors if borrow checking failed.
955 // I'm not sure how helpful this is, to be honest, but it avoids a
956 // lot of annoying errors in the ui tests (basically,
957 // lint warnings and so on -- kindck used to do this abort, but
958 // kindck is gone now). -nmatsakis
959 if sess.has_errors() {
960 return Err(ErrorReported);
963 sess.time("misc_checking_3", || {
966 tcx.ensure().privacy_access_levels(());
970 tcx.ensure().check_private_in_public(());
973 sess.time("death_checking", || rustc_passes::dead::check_crate(tcx));
976 sess.time("unused_lib_feature_checking", || {
977 rustc_passes::stability::check_unused_or_stable_features(tcx)
981 sess.time("lint_checking", || {
982 rustc_lint::check_crate(tcx, || {
983 rustc_lint::BuiltinCombinedLateLintPass::new()
990 sess.time("privacy_checking_modules", || {
991 tcx.hir().par_for_each_module(|module| {
992 tcx.ensure().check_mod_privacy(module);
1002 fn encode_and_write_metadata(
1004 outputs: &OutputFilenames,
1005 ) -> (EncodedMetadata, bool) {
1006 #[derive(PartialEq, Eq, PartialOrd, Ord)]
1013 let metadata_kind = tcx
1017 .map(|ty| match *ty {
1018 CrateType::Executable | CrateType::Staticlib | CrateType::Cdylib => MetadataKind::None,
1020 CrateType::Rlib => MetadataKind::Uncompressed,
1022 CrateType::Dylib | CrateType::ProcMacro => MetadataKind::Compressed,
1025 .unwrap_or(MetadataKind::None);
1027 let metadata = match metadata_kind {
1028 MetadataKind::None => EncodedMetadata::new(),
1029 MetadataKind::Uncompressed | MetadataKind::Compressed => encode_metadata(tcx),
1032 let _prof_timer = tcx.sess.prof.generic_activity("write_crate_metadata");
1034 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
1035 if need_metadata_file {
1036 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
1037 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
1038 // To avoid races with another rustc process scanning the output directory,
1039 // we need to write the file somewhere else and atomically move it to its
1040 // final destination, with an `fs::rename` call. In order for the rename to
1041 // always succeed, the temporary file needs to be on the same filesystem,
1042 // which is why we create it inside the output directory specifically.
1043 let metadata_tmpdir = TempFileBuilder::new()
1045 .tempdir_in(out_filename.parent().unwrap())
1046 .unwrap_or_else(|err| tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err)));
1047 let metadata_tmpdir = MaybeTempDir::new(metadata_tmpdir, tcx.sess.opts.cg.save_temps);
1048 let metadata_filename = emit_metadata(tcx.sess, metadata.raw_data(), &metadata_tmpdir);
1049 if let Err(e) = util::non_durable_rename(&metadata_filename, &out_filename) {
1050 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
1052 if tcx.sess.opts.json_artifact_notifications {
1056 .emit_artifact_notification(&out_filename, "metadata");
1060 let need_metadata_module = metadata_kind == MetadataKind::Compressed;
1062 (metadata, need_metadata_module)
1065 /// Runs the codegen backend, after which the AST and analysis can
1067 pub fn start_codegen<'tcx>(
1068 codegen_backend: &dyn CodegenBackend,
1070 outputs: &OutputFilenames,
1072 info!("Pre-codegen\n{:?}", tcx.debug_stats());
1074 let (metadata, need_metadata_module) = encode_and_write_metadata(tcx, outputs);
1076 let codegen = tcx.sess.time("codegen_crate", move || {
1077 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1080 // Don't run these test assertions when not doing codegen. Compiletest tries to build
1081 // build-fail tests in check mode first and expects it to not give an error in that case.
1082 if tcx.sess.opts.output_types.should_codegen() {
1083 rustc_incremental::assert_module_sources::assert_module_sources(tcx);
1084 rustc_symbol_mangling::test::report_symbol_names(tcx);
1087 info!("Post-codegen\n{:?}", tcx.debug_stats());
1089 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1090 if let Err(e) = rustc_mir_transform::dump_mir::emit_mir(tcx, outputs) {
1091 tcx.sess.err(&format!("could not emit MIR: {}", e));
1092 tcx.sess.abort_if_errors();
1099 fn get_recursion_limit(krate_attrs: &[ast::Attribute], sess: &Session) -> Limit {
1100 if let Some(attr) = krate_attrs
1102 .find(|attr| attr.has_name(sym::recursion_limit) && attr.value_str().is_none())
1104 // This is here mainly to check for using a macro, such as
1105 // #![recursion_limit = foo!()]. That is not supported since that
1106 // would require expanding this while in the middle of expansion,
1107 // which needs to know the limit before expanding. Otherwise,
1108 // validation would normally be caught in AstValidator (via
1109 // `check_builtin_attribute`), but by the time that runs the macro
1110 // is expanded, and it doesn't give an error.
1111 validate_attr::emit_fatal_malformed_builtin_attribute(
1114 sym::recursion_limit,
1117 rustc_middle::middle::limits::get_recursion_limit(krate_attrs, sess)