1 use crate::interface::{Compiler, Result};
2 use crate::proc_macro_decls;
5 use rustc_ast::mut_visit::MutVisitor;
6 use rustc_ast::{self as ast, visit};
7 use rustc_codegen_ssa::back::link::emit_metadata;
8 use rustc_codegen_ssa::traits::CodegenBackend;
9 use rustc_data_structures::parallel;
10 use rustc_data_structures::sync::{par_iter, Lrc, OnceCell, ParallelIterator, WorkerLocal};
11 use rustc_data_structures::temp_dir::MaybeTempDir;
12 use rustc_errors::{ErrorReported, PResult};
13 use rustc_expand::base::ExtCtxt;
14 use rustc_hir::def_id::LOCAL_CRATE;
16 use rustc_lint::LintStore;
17 use rustc_metadata::creader::CStore;
18 use rustc_middle::arena::Arena;
19 use rustc_middle::dep_graph::DepGraph;
20 use rustc_middle::middle;
21 use rustc_middle::middle::cstore::{CrateStore, MetadataLoader, MetadataLoaderDyn};
22 use rustc_middle::ty::query::Providers;
23 use rustc_middle::ty::{self, GlobalCtxt, ResolverOutputs, TyCtxt};
25 use rustc_mir_build as mir_build;
26 use rustc_parse::{parse_crate_from_file, parse_crate_from_source_str};
27 use rustc_passes::{self, hir_stats, layout_test};
28 use rustc_plugin_impl as plugin;
29 use rustc_query_impl::Queries as TcxQueries;
30 use rustc_resolve::{Resolver, ResolverArenas};
31 use rustc_session::config::{CrateType, Input, OutputFilenames, OutputType, PpMode, PpSourceMode};
32 use rustc_session::lint;
33 use rustc_session::output::{filename_for_input, filename_for_metadata};
34 use rustc_session::search_paths::PathKind;
35 use rustc_session::Session;
36 use rustc_span::symbol::{Ident, Symbol};
37 use rustc_trait_selection::traits;
38 use rustc_typeck as typeck;
39 use tracing::{info, warn};
41 use rustc_serialize::json;
42 use tempfile::Builder as TempFileBuilder;
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::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 struct BoxedResolver(Pin<Box<BoxedResolverInner>>);
91 // Note: Drop order is important to prevent dangling references. Resolver must be dropped first,
92 // then resolver_arenas and finally session.
93 // The drop order is defined to be from top to bottom in RFC1857, so there is no need for
94 // ManuallyDrop for as long as the fields are not reordered.
95 struct BoxedResolverInner {
96 resolver: Option<Resolver<'static>>,
97 resolver_arenas: ResolverArenas<'static>,
98 session: Lrc<Session>,
103 fn new<F>(session: Lrc<Session>, make_resolver: F) -> Result<(ast::Crate, Self)>
107 &'a ResolverArenas<'a>,
108 ) -> Result<(ast::Crate, Resolver<'a>)>,
110 let mut boxed_resolver = Box::new(BoxedResolverInner {
112 resolver_arenas: Resolver::arenas(),
117 let (crate_, resolver) = make_resolver(
118 std::mem::transmute::<&Session, &Session>(&boxed_resolver.session),
119 std::mem::transmute::<&ResolverArenas<'_>, &ResolverArenas<'_>>(
120 &boxed_resolver.resolver_arenas,
123 boxed_resolver.resolver =
124 Some(std::mem::transmute::<Resolver<'_>, Resolver<'_>>(resolver));
125 Ok((crate_, BoxedResolver(Pin::new_unchecked(boxed_resolver))))
129 pub fn access<F: for<'a> FnOnce(&mut Resolver<'a>) -> R, R>(&mut self, f: F) -> R {
130 let mut resolver = unsafe {
131 self.0.as_mut().map_unchecked_mut(|boxed_resolver| &mut boxed_resolver.resolver)
133 f((&mut *resolver).as_mut().unwrap())
136 pub fn to_resolver_outputs(resolver: Rc<RefCell<BoxedResolver>>) -> ResolverOutputs {
137 match Rc::try_unwrap(resolver) {
139 let mut resolver = resolver.into_inner();
140 let mut resolver = unsafe {
144 .map_unchecked_mut(|boxed_resolver| &mut boxed_resolver.resolver)
146 resolver.take().unwrap().into_outputs()
148 Err(resolver) => resolver.borrow_mut().access(|resolver| resolver.clone_outputs()),
153 /// Runs the "early phases" of the compiler: initial `cfg` processing, loading compiler plugins,
154 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
155 /// harness if one is to be provided, injection of a dependency on the
156 /// standard library and prelude, and name resolution.
158 /// Returns [`None`] if we're aborting after handling -W help.
159 pub fn configure_and_expand(
161 lint_store: Lrc<LintStore>,
162 metadata_loader: Box<MetadataLoaderDyn>,
165 ) -> Result<(ast::Crate, BoxedResolver)> {
166 tracing::trace!("configure_and_expand");
167 // Currently, we ignore the name resolution data structures for the purposes of dependency
168 // tracking. Instead we will run name resolution and include its output in the hash of each
169 // item, much like we do for macro expansion. In other words, the hash reflects not just
170 // its contents but the results of name resolution on those contents. Hopefully we'll push
171 // this back at some point.
172 let crate_name = crate_name.to_string();
173 BoxedResolver::new(sess, move |sess, resolver_arenas| {
174 configure_and_expand_inner(
185 pub fn register_plugins<'a>(
187 metadata_loader: &'a dyn MetadataLoader,
188 register_lints: impl Fn(&Session, &mut LintStore),
189 mut krate: ast::Crate,
191 ) -> Result<(ast::Crate, Lrc<LintStore>)> {
192 krate = sess.time("attributes_injection", || {
193 rustc_builtin_macros::cmdline_attrs::inject(
196 &sess.opts.debugging_opts.crate_attr,
200 let (krate, features) = rustc_expand::config::features(sess, krate);
201 // these need to be set "early" so that expansion sees `quote` if enabled.
202 sess.init_features(features);
204 let crate_types = util::collect_crate_types(sess, &krate.attrs);
205 sess.init_crate_types(crate_types);
207 let disambiguator = util::compute_crate_disambiguator(sess);
208 sess.crate_disambiguator.set(disambiguator).expect("not yet initialized");
209 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator)?;
211 if sess.opts.incremental.is_some() {
212 sess.time("incr_comp_garbage_collect_session_directories", || {
213 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
215 "Error while trying to garbage collect incremental \
216 compilation cache directory: {}",
223 sess.time("recursion_limit", || {
224 middle::limits::update_limits(sess, &krate);
227 let mut lint_store = rustc_lint::new_lint_store(
228 sess.opts.debugging_opts.no_interleave_lints,
229 sess.unstable_options(),
231 register_lints(&sess, &mut lint_store);
234 sess.time("plugin_loading", || plugin::load::load_plugins(sess, metadata_loader, &krate));
235 sess.time("plugin_registration", || {
236 let mut registry = plugin::Registry { lint_store: &mut lint_store };
237 for registrar in registrars {
238 registrar(&mut registry);
242 let lint_store = Lrc::new(lint_store);
243 sess.init_lint_store(lint_store.clone());
245 Ok((krate, lint_store))
248 fn pre_expansion_lint(
250 lint_store: &LintStore,
254 sess.prof.generic_activity_with_arg("pre_AST_expansion_lint_checks", crate_name).run(|| {
255 rustc_lint::check_ast_crate(
261 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
266 fn configure_and_expand_inner<'a>(
268 lint_store: &LintStore,
269 mut krate: ast::Crate,
271 resolver_arenas: &'a ResolverArenas<'a>,
272 metadata_loader: Box<MetadataLoaderDyn>,
273 ) -> Result<(ast::Crate, Resolver<'a>)> {
274 tracing::trace!("configure_and_expand_inner");
275 pre_expansion_lint(sess, lint_store, &krate, crate_name);
277 let mut resolver = Resolver::new(sess, &krate, crate_name, metadata_loader, &resolver_arenas);
278 rustc_builtin_macros::register_builtin_macros(&mut resolver);
280 krate = sess.time("crate_injection", || {
281 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| Symbol::intern(s));
282 rustc_builtin_macros::standard_library_imports::inject(
290 util::check_attr_crate_type(&sess, &krate.attrs, &mut resolver.lint_buffer());
293 krate = sess.time("macro_expand_crate", || {
294 // Windows dlls do not have rpaths, so they don't know how to find their
295 // dependencies. It's up to us to tell the system where to find all the
296 // dependent dlls. Note that this uses cfg!(windows) as opposed to
297 // targ_cfg because syntax extensions are always loaded for the host
298 // compiler, not for the target.
300 // This is somewhat of an inherently racy operation, however, as
301 // multiple threads calling this function could possibly continue
302 // extending PATH far beyond what it should. To solve this for now we
303 // just don't add any new elements to PATH which are already there
304 // within PATH. This is basically a targeted fix at #17360 for rustdoc
305 // which runs rustc in parallel but has been seen (#33844) to cause
306 // problems with PATH becoming too long.
307 let mut old_path = OsString::new();
309 old_path = env::var_os("PATH").unwrap_or(old_path);
310 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
311 for path in env::split_paths(&old_path) {
312 if !new_path.contains(&path) {
319 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
325 // Create the config for macro expansion
326 let features = sess.features_untracked();
327 let cfg = rustc_expand::expand::ExpansionConfig {
328 features: Some(&features),
329 recursion_limit: sess.recursion_limit(),
330 trace_mac: sess.opts.debugging_opts.trace_macros,
331 should_test: sess.opts.test,
332 span_debug: sess.opts.debugging_opts.span_debug,
333 proc_macro_backtrace: sess.opts.debugging_opts.proc_macro_backtrace,
334 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
337 let extern_mod_loaded = |ident: Ident, attrs, items, span| {
338 let krate = ast::Crate { attrs, items, span, proc_macros: vec![] };
339 pre_expansion_lint(sess, lint_store, &krate, &ident.name.as_str());
340 (krate.attrs, krate.items)
342 let mut ecx = ExtCtxt::new(&sess, cfg, &mut resolver, Some(&extern_mod_loaded));
344 // Expand macros now!
345 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
347 // The rest is error reporting
349 sess.time("check_unused_macros", || {
350 ecx.check_unused_macros();
353 let mut missing_fragment_specifiers: Vec<_> = ecx
356 .missing_fragment_specifiers
359 .map(|(span, node_id)| (*span, *node_id))
361 missing_fragment_specifiers.sort_unstable_by_key(|(span, _)| *span);
363 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
365 for (span, node_id) in missing_fragment_specifiers {
366 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
367 let msg = "missing fragment specifier";
368 resolver.lint_buffer().buffer_lint(lint, node_id, span, msg);
371 env::set_var("PATH", &old_path);
374 if recursion_limit_hit {
375 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
383 sess.time("maybe_building_test_harness", || {
384 rustc_builtin_macros::test_harness::inject(&sess, &mut resolver, &mut krate)
387 if let Some(PpMode::Source(PpSourceMode::EveryBodyLoops)) = sess.opts.pretty {
388 tracing::debug!("replacing bodies with loop {{}}");
389 util::ReplaceBodyWithLoop::new(&mut resolver).visit_crate(&mut krate);
392 let has_proc_macro_decls = sess.time("AST_validation", || {
393 rustc_ast_passes::ast_validation::check_crate(sess, &krate, &mut resolver.lint_buffer())
396 let crate_types = sess.crate_types();
397 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
399 // For backwards compatibility, we don't try to run proc macro injection
400 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
401 // specified. This should only affect users who manually invoke 'rustdoc', as
402 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
403 // However, we do emit a warning, to let such users know that they should
404 // start passing '--crate-type proc-macro'
405 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
406 let mut msg = sess.diagnostic().struct_warn(
407 &"Trying to document proc macro crate \
408 without passing '--crate-type proc-macro to rustdoc",
411 msg.warn("The generated documentation may be incorrect");
414 krate = sess.time("maybe_create_a_macro_crate", || {
415 let num_crate_types = crate_types.len();
416 let is_test_crate = sess.opts.test;
417 rustc_builtin_macros::proc_macro_harness::inject(
422 has_proc_macro_decls,
430 // Done with macro expansion!
432 if sess.opts.debugging_opts.input_stats {
433 eprintln!("Post-expansion node count: {}", count_nodes(&krate));
436 if sess.opts.debugging_opts.hir_stats {
437 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
440 if sess.opts.debugging_opts.ast_json {
441 println!("{}", json::as_json(&krate));
444 resolver.resolve_crate(&krate);
446 // Needs to go *after* expansion to be able to check the results of macro expansion.
447 sess.time("complete_gated_feature_checking", || {
448 rustc_ast_passes::feature_gate::check_crate(&krate, sess);
451 // Add all buffered lints from the `ParseSess` to the `Session`.
452 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
453 info!("{} parse sess buffered_lints", buffered_lints.len());
454 for early_lint in buffered_lints.drain(..) {
455 resolver.lint_buffer().add_early_lint(early_lint);
459 Ok((krate, resolver))
462 pub fn lower_to_hir<'res, 'tcx>(
464 lint_store: &LintStore,
465 resolver: &'res mut Resolver<'_>,
466 dep_graph: &'res DepGraph,
467 krate: &'res ast::Crate,
468 arena: &'tcx rustc_ast_lowering::Arena<'tcx>,
470 // We're constructing the HIR here; we don't care what we will
471 // read, since we haven't even constructed the *input* to
473 dep_graph.assert_ignored();
476 let hir_crate = rustc_ast_lowering::lower_crate(
480 rustc_parse::nt_to_tokenstream,
484 if sess.opts.debugging_opts.hir_stats {
485 hir_stats::print_hir_stats(&hir_crate);
488 sess.time("early_lint_checks", || {
489 rustc_lint::check_ast_crate(
494 Some(std::mem::take(resolver.lint_buffer())),
495 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
499 // Discard hygiene data, which isn't required after lowering to HIR.
500 if !sess.opts.debugging_opts.keep_hygiene_data {
501 rustc_span::hygiene::clear_syntax_context_map();
507 // Returns all the paths that correspond to generated files.
508 fn generated_output_paths(
510 outputs: &OutputFilenames,
514 let mut out_filenames = Vec::new();
515 for output_type in sess.opts.output_types.keys() {
516 let file = outputs.path(*output_type);
518 // If the filename has been overridden using `-o`, it will not be modified
519 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
520 OutputType::Exe if !exact_name => {
521 for crate_type in sess.crate_types().iter() {
522 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
523 out_filenames.push(p);
526 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
527 // Don't add the dep-info output when omitting it from dep-info targets
530 out_filenames.push(file);
537 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
538 // returns None for every file path.
539 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
541 F: Fn(&PathBuf) -> Option<T>,
543 for output_path in output_paths {
544 if let Some(result) = f(output_path) {
551 fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
552 let input_path = input_path.canonicalize().ok();
553 if input_path.is_none() {
556 let check = |output_path: &PathBuf| {
557 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
559 check_output(output_paths, check).is_some()
562 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
563 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
564 check_output(output_paths, check)
567 fn escape_dep_filename(filename: &String) -> String {
568 // Apparently clang and gcc *only* escape spaces:
569 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
570 filename.replace(" ", "\\ ")
573 // Makefile comments only need escaping newlines and `\`.
574 // The result can be unescaped by anything that can unescape `escape_default` and friends.
575 fn escape_dep_env(symbol: Symbol) -> String {
576 let s = symbol.as_str();
577 let mut escaped = String::with_capacity(s.len());
580 '\n' => escaped.push_str(r"\n"),
581 '\r' => escaped.push_str(r"\r"),
582 '\\' => escaped.push_str(r"\\"),
583 _ => escaped.push(c),
591 resolver: &Resolver<'_>,
592 outputs: &OutputFilenames,
593 out_filenames: &[PathBuf],
595 // Write out dependency rules to the dep-info file if requested
596 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
599 let deps_filename = outputs.path(OutputType::DepInfo);
601 let result = (|| -> io::Result<()> {
602 // Build a list of files used to compile the output and
603 // write Makefile-compatible dependency rules
604 let mut files: Vec<String> = sess
608 .filter(|fmap| fmap.is_real_file())
609 .filter(|fmap| !fmap.is_imported())
610 .map(|fmap| escape_dep_filename(&fmap.name.prefer_local().to_string()))
613 if let Some(ref backend) = sess.opts.debugging_opts.codegen_backend {
614 files.push(backend.to_string());
617 if sess.binary_dep_depinfo() {
618 for cnum in resolver.cstore().crates_untracked() {
619 let source = resolver.cstore().crate_source_untracked(cnum);
620 if let Some((path, _)) = source.dylib {
621 files.push(escape_dep_filename(&path.display().to_string()));
623 if let Some((path, _)) = source.rlib {
624 files.push(escape_dep_filename(&path.display().to_string()));
626 if let Some((path, _)) = source.rmeta {
627 files.push(escape_dep_filename(&path.display().to_string()));
632 let mut file = BufWriter::new(fs::File::create(&deps_filename)?);
633 for path in out_filenames {
634 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
637 // Emit a fake target for each input file to the compilation. This
638 // prevents `make` from spitting out an error if a file is later
639 // deleted. For more info see #28735
641 writeln!(file, "{}:", path)?;
644 // Emit special comments with information about accessed environment variables.
645 let env_depinfo = sess.parse_sess.env_depinfo.borrow();
646 if !env_depinfo.is_empty() {
647 let mut envs: Vec<_> = env_depinfo
649 .map(|(k, v)| (escape_dep_env(*k), v.map(escape_dep_env)))
651 envs.sort_unstable();
654 write!(file, "# env-dep:{}", k)?;
656 write!(file, "={}", v)?;
667 if sess.opts.json_artifact_notifications {
670 .emit_artifact_notification(&deps_filename, "dep-info");
673 Err(e) => sess.fatal(&format!(
674 "error writing dependencies to `{}`: {}",
675 deps_filename.display(),
681 pub fn prepare_outputs(
685 resolver: &Resolver<'_>,
687 ) -> Result<OutputFilenames> {
688 let _timer = sess.timer("prepare_outputs");
690 // FIXME: rustdoc passes &[] instead of &krate.attrs here
691 let outputs = util::build_output_filenames(
693 &compiler.output_dir,
694 &compiler.output_file,
700 generated_output_paths(sess, &outputs, compiler.output_file.is_some(), &crate_name);
702 // Ensure the source file isn't accidentally overwritten during compilation.
703 if let Some(ref input_path) = compiler.input_path {
704 if sess.opts.will_create_output_file() {
705 if output_contains_path(&output_paths, input_path) {
707 "the input file \"{}\" would be overwritten by the generated \
711 return Err(ErrorReported);
713 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
715 "the generated executable for the input file \"{}\" conflicts with the \
716 existing directory \"{}\"",
717 input_path.display(),
720 return Err(ErrorReported);
725 write_out_deps(sess, resolver, &outputs, &output_paths);
727 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
728 && sess.opts.output_types.len() == 1;
731 if let Some(ref dir) = compiler.output_dir {
732 if fs::create_dir_all(dir).is_err() {
733 sess.err("failed to find or create the directory specified by `--out-dir`");
734 return Err(ErrorReported);
742 pub static DEFAULT_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
743 let providers = &mut Providers::default();
744 providers.analysis = analysis;
745 proc_macro_decls::provide(providers);
746 plugin::build::provide(providers);
747 rustc_middle::hir::provide(providers);
748 mir::provide(providers);
749 mir_build::provide(providers);
750 rustc_privacy::provide(providers);
751 typeck::provide(providers);
752 ty::provide(providers);
753 traits::provide(providers);
754 rustc_passes::provide(providers);
755 rustc_resolve::provide(providers);
756 rustc_traits::provide(providers);
757 rustc_ty_utils::provide(providers);
758 rustc_metadata::provide(providers);
759 rustc_lint::provide(providers);
760 rustc_symbol_mangling::provide(providers);
761 rustc_codegen_ssa::provide(providers);
765 pub static DEFAULT_EXTERN_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
766 let mut extern_providers = *DEFAULT_QUERY_PROVIDERS;
767 rustc_metadata::provide_extern(&mut extern_providers);
768 rustc_codegen_ssa::provide_extern(&mut extern_providers);
772 pub struct QueryContext<'tcx> {
773 gcx: &'tcx GlobalCtxt<'tcx>,
776 impl<'tcx> QueryContext<'tcx> {
777 pub fn enter<F, R>(&mut self, f: F) -> R
779 F: FnOnce(TyCtxt<'tcx>) -> R,
781 let icx = ty::tls::ImplicitCtxt::new(self.gcx);
782 ty::tls::enter_context(&icx, |_| f(icx.tcx))
786 pub fn create_global_ctxt<'tcx>(
787 compiler: &'tcx Compiler,
788 lint_store: Lrc<LintStore>,
789 krate: &'tcx Crate<'tcx>,
791 resolver_outputs: ResolverOutputs,
792 outputs: OutputFilenames,
794 queries: &'tcx OnceCell<TcxQueries<'tcx>>,
795 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
796 arena: &'tcx WorkerLocal<Arena<'tcx>>,
797 ) -> QueryContext<'tcx> {
798 let sess = &compiler.session();
800 let def_path_table = resolver_outputs.definitions.def_path_table();
801 let query_result_on_disk_cache =
802 rustc_incremental::load_query_result_cache(sess, def_path_table);
804 let codegen_backend = compiler.codegen_backend();
805 let mut local_providers = *DEFAULT_QUERY_PROVIDERS;
806 codegen_backend.provide(&mut local_providers);
808 let mut extern_providers = *DEFAULT_EXTERN_QUERY_PROVIDERS;
809 codegen_backend.provide(&mut extern_providers);
810 codegen_backend.provide_extern(&mut extern_providers);
812 if let Some(callback) = compiler.override_queries {
813 callback(sess, &mut local_providers, &mut extern_providers);
816 let queries = queries.get_or_init(|| TcxQueries::new(local_providers, extern_providers));
818 let gcx = sess.time("setup_global_ctxt", || {
819 global_ctxt.get_or_init(|| {
820 TyCtxt::create_global_ctxt(
827 query_result_on_disk_cache,
838 /// Runs the resolution, type-checking, region checking and other
839 /// miscellaneous analysis passes on the crate.
840 fn analysis(tcx: TyCtxt<'_>, (): ()) -> Result<()> {
841 rustc_passes::hir_id_validator::check_crate(tcx);
844 let mut entry_point = None;
846 sess.time("misc_checking_1", || {
849 entry_point = sess.time("looking_for_entry_point", || tcx.entry_fn(()));
851 sess.time("looking_for_plugin_registrar", || tcx.ensure().plugin_registrar_fn(()));
853 sess.time("looking_for_derive_registrar", || {
854 tcx.ensure().proc_macro_decls_static(())
859 .downcast_ref::<CStore>()
860 .expect("`tcx.cstore` is not a `CStore`");
861 cstore.report_unused_deps(tcx);
864 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
865 tcx.ensure().check_mod_loops(module);
866 tcx.ensure().check_mod_attrs(module);
867 tcx.ensure().check_mod_naked_functions(module);
868 tcx.ensure().check_mod_unstable_api_usage(module);
869 tcx.ensure().check_mod_const_bodies(module);
875 // passes are timed inside typeck
876 typeck::check_crate(tcx)?;
878 sess.time("misc_checking_2", || {
881 sess.time("match_checking", || {
882 tcx.par_body_owners(|def_id| {
883 tcx.ensure().check_match(def_id.to_def_id());
888 sess.time("liveness_and_intrinsic_checking", || {
889 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
890 // this must run before MIR dump, because
891 // "not all control paths return a value" is reported here.
893 // maybe move the check to a MIR pass?
894 tcx.ensure().check_mod_liveness(module);
895 tcx.ensure().check_mod_intrinsics(module);
902 sess.time("MIR_borrow_checking", || {
903 tcx.par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
906 sess.time("MIR_effect_checking", || {
907 for def_id in tcx.body_owners() {
908 tcx.ensure().thir_check_unsafety(def_id);
909 if !tcx.sess.opts.debugging_opts.thir_unsafeck {
910 mir::transform::check_unsafety::check_unsafety(tcx, def_id);
913 if tcx.hir().body_const_context(def_id).is_some() {
915 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::unknown(def_id));
920 sess.time("layout_testing", || layout_test::test_layout(tcx));
922 // Avoid overwhelming user with errors if borrow checking failed.
923 // I'm not sure how helpful this is, to be honest, but it avoids a
924 // lot of annoying errors in the ui tests (basically,
925 // lint warnings and so on -- kindck used to do this abort, but
926 // kindck is gone now). -nmatsakis
927 if sess.has_errors() {
928 return Err(ErrorReported);
931 sess.time("misc_checking_3", || {
934 tcx.ensure().privacy_access_levels(());
938 tcx.ensure().check_private_in_public(());
941 sess.time("death_checking", || rustc_passes::dead::check_crate(tcx));
944 sess.time("unused_lib_feature_checking", || {
945 rustc_passes::stability::check_unused_or_stable_features(tcx)
949 sess.time("lint_checking", || {
950 rustc_lint::check_crate(tcx, || {
951 rustc_lint::BuiltinCombinedLateLintPass::new()
958 sess.time("privacy_checking_modules", || {
959 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
960 tcx.ensure().check_mod_privacy(module);
970 fn encode_and_write_metadata(
972 outputs: &OutputFilenames,
973 ) -> (middle::cstore::EncodedMetadata, bool) {
974 #[derive(PartialEq, Eq, PartialOrd, Ord)]
981 let metadata_kind = tcx
985 .map(|ty| match *ty {
986 CrateType::Executable | CrateType::Staticlib | CrateType::Cdylib => MetadataKind::None,
988 CrateType::Rlib => MetadataKind::Uncompressed,
990 CrateType::Dylib | CrateType::ProcMacro => MetadataKind::Compressed,
993 .unwrap_or(MetadataKind::None);
995 let metadata = match metadata_kind {
996 MetadataKind::None => middle::cstore::EncodedMetadata::new(),
997 MetadataKind::Uncompressed | MetadataKind::Compressed => tcx.encode_metadata(),
1000 let _prof_timer = tcx.sess.prof.generic_activity("write_crate_metadata");
1002 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
1003 if need_metadata_file {
1004 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
1005 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
1006 // To avoid races with another rustc process scanning the output directory,
1007 // we need to write the file somewhere else and atomically move it to its
1008 // final destination, with an `fs::rename` call. In order for the rename to
1009 // always succeed, the temporary file needs to be on the same filesystem,
1010 // which is why we create it inside the output directory specifically.
1011 let metadata_tmpdir = TempFileBuilder::new()
1013 .tempdir_in(out_filename.parent().unwrap())
1014 .unwrap_or_else(|err| tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err)));
1015 let metadata_tmpdir = MaybeTempDir::new(metadata_tmpdir, tcx.sess.opts.cg.save_temps);
1016 let metadata_filename = emit_metadata(tcx.sess, &metadata.raw_data, &metadata_tmpdir);
1017 if let Err(e) = util::non_durable_rename(&metadata_filename, &out_filename) {
1018 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
1020 if tcx.sess.opts.json_artifact_notifications {
1024 .emit_artifact_notification(&out_filename, "metadata");
1028 let need_metadata_module = metadata_kind == MetadataKind::Compressed;
1030 (metadata, need_metadata_module)
1033 /// Runs the codegen backend, after which the AST and analysis can
1035 pub fn start_codegen<'tcx>(
1036 codegen_backend: &dyn CodegenBackend,
1038 outputs: &OutputFilenames,
1040 info!("Pre-codegen\n{:?}", tcx.debug_stats());
1042 let (metadata, need_metadata_module) = encode_and_write_metadata(tcx, outputs);
1044 let codegen = tcx.sess.time("codegen_crate", move || {
1045 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1048 // Don't run these test assertions when not doing codegen. Compiletest tries to build
1049 // build-fail tests in check mode first and expects it to not give an error in that case.
1050 if tcx.sess.opts.output_types.should_codegen() {
1051 rustc_incremental::assert_module_sources::assert_module_sources(tcx);
1052 rustc_symbol_mangling::test::report_symbol_names(tcx);
1055 info!("Post-codegen\n{:?}", tcx.debug_stats());
1057 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1058 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, outputs) {
1059 tcx.sess.err(&format!("could not emit MIR: {}", e));
1060 tcx.sess.abort_if_errors();