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::steal::Steal;
11 use rustc_data_structures::sync::{par_iter, Lrc, OnceCell, ParallelIterator, 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::LOCAL_CRATE;
17 use rustc_lint::LintStore;
18 use rustc_metadata::creader::CStore;
19 use rustc_middle::arena::Arena;
20 use rustc_middle::dep_graph::DepGraph;
21 use rustc_middle::middle;
22 use rustc_middle::middle::cstore::{CrateStore, MetadataLoader, MetadataLoaderDyn};
23 use rustc_middle::ty::query::Providers;
24 use rustc_middle::ty::{self, GlobalCtxt, ResolverOutputs, TyCtxt};
26 use rustc_mir_build as mir_build;
27 use rustc_parse::{parse_crate_from_file, parse_crate_from_source_str};
28 use rustc_passes::{self, hir_stats, layout_test};
29 use rustc_plugin_impl as plugin;
30 use rustc_query_impl::Queries as TcxQueries;
31 use rustc_resolve::{Resolver, ResolverArenas};
32 use rustc_session::config::{CrateType, Input, OutputFilenames, OutputType, PpMode, PpSourceMode};
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::Session;
37 use rustc_span::symbol::{Ident, Symbol};
38 use rustc_trait_selection::traits;
39 use rustc_typeck as typeck;
40 use tracing::{info, warn};
42 use rustc_serialize::json;
43 use tempfile::Builder as TempFileBuilder;
46 use std::cell::RefCell;
47 use std::ffi::OsString;
48 use std::io::{self, BufWriter, Write};
49 use std::lazy::SyncLazy;
50 use std::marker::PhantomPinned;
51 use std::path::PathBuf;
54 use std::{env, fs, iter};
56 pub fn parse<'a>(sess: &'a Session, input: &Input) -> PResult<'a, ast::Crate> {
57 let krate = sess.time("parse_crate", || match input {
58 Input::File(file) => parse_crate_from_file(file, &sess.parse_sess),
59 Input::Str { input, name } => {
60 parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess)
64 if sess.opts.debugging_opts.ast_json_noexpand {
65 println!("{}", json::as_json(&krate));
68 if sess.opts.debugging_opts.input_stats {
69 eprintln!("Lines of code: {}", sess.source_map().count_lines());
70 eprintln!("Pre-expansion node count: {}", count_nodes(&krate));
73 if let Some(ref s) = sess.opts.debugging_opts.show_span {
74 rustc_ast_passes::show_span::run(sess.diagnostic(), s, &krate);
77 if sess.opts.debugging_opts.hir_stats {
78 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
84 fn count_nodes(krate: &ast::Crate) -> usize {
85 let mut counter = rustc_ast_passes::node_count::NodeCounter::new();
86 visit::walk_crate(&mut counter, krate);
90 pub use boxed_resolver::BoxedResolver;
94 pub struct BoxedResolver(Pin<Box<BoxedResolverInner>>);
96 // Note: Drop order is important to prevent dangling references. Resolver must be dropped first,
97 // then resolver_arenas and finally session.
98 // The drop order is defined to be from top to bottom in RFC1857, so there is no need for
99 // ManuallyDrop for as long as the fields are not reordered.
100 struct BoxedResolverInner {
101 resolver: Option<Resolver<'static>>,
102 resolver_arenas: ResolverArenas<'static>,
103 session: Lrc<Session>,
108 pub(super) fn new<F>(session: Lrc<Session>, make_resolver: F) -> Result<(ast::Crate, Self)>
112 &'a ResolverArenas<'a>,
113 ) -> Result<(ast::Crate, Resolver<'a>)>,
115 let mut boxed_resolver = Box::new(BoxedResolverInner {
117 resolver_arenas: Resolver::arenas(),
122 let (crate_, resolver) = make_resolver(
123 std::mem::transmute::<&Session, &Session>(&boxed_resolver.session),
124 std::mem::transmute::<&ResolverArenas<'_>, &ResolverArenas<'_>>(
125 &boxed_resolver.resolver_arenas,
128 boxed_resolver.resolver =
129 Some(std::mem::transmute::<Resolver<'_>, Resolver<'_>>(resolver));
130 Ok((crate_, BoxedResolver(Pin::new_unchecked(boxed_resolver))))
134 pub fn access<F: for<'a> FnOnce(&mut Resolver<'a>) -> R, R>(&mut self, f: F) -> R {
135 let mut resolver = unsafe {
136 self.0.as_mut().map_unchecked_mut(|boxed_resolver| &mut boxed_resolver.resolver)
138 f((&mut *resolver).as_mut().unwrap())
141 pub fn to_resolver_outputs(resolver: Rc<RefCell<BoxedResolver>>) -> ResolverOutputs {
142 match Rc::try_unwrap(resolver) {
144 let mut resolver = resolver.into_inner();
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 /// Runs the "early phases" of the compiler: initial `cfg` processing, loading compiler plugins,
160 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
161 /// harness if one is to be provided, injection of a dependency on the
162 /// standard library and prelude, and name resolution.
164 /// Returns [`None`] if we're aborting after handling -W help.
165 pub fn configure_and_expand(
167 lint_store: Lrc<LintStore>,
168 metadata_loader: Box<MetadataLoaderDyn>,
171 ) -> Result<(ast::Crate, BoxedResolver)> {
172 tracing::trace!("configure_and_expand");
173 // Currently, we ignore the name resolution data structures for the purposes of dependency
174 // tracking. Instead we will run name resolution and include its output in the hash of each
175 // item, much like we do for macro expansion. In other words, the hash reflects not just
176 // its contents but the results of name resolution on those contents. Hopefully we'll push
177 // this back at some point.
178 let crate_name = crate_name.to_string();
179 BoxedResolver::new(sess, move |sess, resolver_arenas| {
180 configure_and_expand_inner(
191 pub fn register_plugins<'a>(
193 metadata_loader: &'a dyn MetadataLoader,
194 register_lints: impl Fn(&Session, &mut LintStore),
195 mut krate: ast::Crate,
197 ) -> Result<(ast::Crate, Lrc<LintStore>)> {
198 krate = sess.time("attributes_injection", || {
199 rustc_builtin_macros::cmdline_attrs::inject(
202 &sess.opts.debugging_opts.crate_attr,
206 let (krate, features) = rustc_expand::config::features(sess, krate);
207 // these need to be set "early" so that expansion sees `quote` if enabled.
208 sess.init_features(features);
210 let crate_types = util::collect_crate_types(sess, &krate.attrs);
211 sess.init_crate_types(crate_types);
213 let disambiguator = util::compute_crate_disambiguator(sess);
214 sess.crate_disambiguator.set(disambiguator).expect("not yet initialized");
215 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator)?;
217 if sess.opts.incremental.is_some() {
218 sess.time("incr_comp_garbage_collect_session_directories", || {
219 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
221 "Error while trying to garbage collect incremental \
222 compilation cache directory: {}",
229 sess.time("recursion_limit", || {
230 middle::limits::update_limits(sess, &krate);
233 let mut lint_store = rustc_lint::new_lint_store(
234 sess.opts.debugging_opts.no_interleave_lints,
235 sess.unstable_options(),
237 register_lints(&sess, &mut lint_store);
240 sess.time("plugin_loading", || plugin::load::load_plugins(sess, metadata_loader, &krate));
241 sess.time("plugin_registration", || {
242 let mut registry = plugin::Registry { lint_store: &mut lint_store };
243 for registrar in registrars {
244 registrar(&mut registry);
248 let lint_store = Lrc::new(lint_store);
249 sess.init_lint_store(lint_store.clone());
251 Ok((krate, lint_store))
254 fn pre_expansion_lint(
256 lint_store: &LintStore,
260 sess.prof.generic_activity_with_arg("pre_AST_expansion_lint_checks", crate_name).run(|| {
261 rustc_lint::check_ast_crate(
267 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
272 fn configure_and_expand_inner<'a>(
274 lint_store: &'a LintStore,
275 mut krate: ast::Crate,
277 resolver_arenas: &'a ResolverArenas<'a>,
278 metadata_loader: Box<MetadataLoaderDyn>,
279 ) -> Result<(ast::Crate, Resolver<'a>)> {
280 tracing::trace!("configure_and_expand_inner");
281 pre_expansion_lint(sess, lint_store, &krate, crate_name);
283 let mut resolver = Resolver::new(sess, &krate, crate_name, metadata_loader, &resolver_arenas);
284 rustc_builtin_macros::register_builtin_macros(&mut resolver);
286 krate = sess.time("crate_injection", || {
287 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| Symbol::intern(s));
288 rustc_builtin_macros::standard_library_imports::inject(
296 util::check_attr_crate_type(&sess, &krate.attrs, &mut resolver.lint_buffer());
299 krate = sess.time("macro_expand_crate", || {
300 // Windows dlls do not have rpaths, so they don't know how to find their
301 // dependencies. It's up to us to tell the system where to find all the
302 // dependent dlls. Note that this uses cfg!(windows) as opposed to
303 // targ_cfg because syntax extensions are always loaded for the host
304 // compiler, not for the target.
306 // This is somewhat of an inherently racy operation, however, as
307 // multiple threads calling this function could possibly continue
308 // extending PATH far beyond what it should. To solve this for now we
309 // just don't add any new elements to PATH which are already there
310 // within PATH. This is basically a targeted fix at #17360 for rustdoc
311 // which runs rustc in parallel but has been seen (#33844) to cause
312 // problems with PATH becoming too long.
313 let mut old_path = OsString::new();
315 old_path = env::var_os("PATH").unwrap_or(old_path);
316 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
317 for path in env::split_paths(&old_path) {
318 if !new_path.contains(&path) {
325 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
331 // Create the config for macro expansion
332 let features = sess.features_untracked();
333 let cfg = rustc_expand::expand::ExpansionConfig {
334 features: Some(&features),
335 recursion_limit: sess.recursion_limit(),
336 trace_mac: sess.opts.debugging_opts.trace_macros,
337 should_test: sess.opts.test,
338 span_debug: sess.opts.debugging_opts.span_debug,
339 proc_macro_backtrace: sess.opts.debugging_opts.proc_macro_backtrace,
340 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
343 let extern_mod_loaded = |ident: Ident, attrs, items, span| {
344 let krate = ast::Crate { attrs, items, span, proc_macros: vec![] };
345 pre_expansion_lint(sess, lint_store, &krate, &ident.name.as_str());
346 (krate.attrs, krate.items)
348 let mut ecx = ExtCtxt::new(&sess, cfg, &mut resolver, Some(&extern_mod_loaded));
350 // Expand macros now!
351 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
353 // The rest is error reporting
355 sess.time("check_unused_macros", || {
356 ecx.check_unused_macros();
359 let mut missing_fragment_specifiers: Vec<_> = ecx
362 .missing_fragment_specifiers
365 .map(|(span, node_id)| (*span, *node_id))
367 missing_fragment_specifiers.sort_unstable_by_key(|(span, _)| *span);
369 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
371 for (span, node_id) in missing_fragment_specifiers {
372 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
373 let msg = "missing fragment specifier";
374 resolver.lint_buffer().buffer_lint(lint, node_id, span, msg);
377 env::set_var("PATH", &old_path);
380 if recursion_limit_hit {
381 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
389 sess.time("maybe_building_test_harness", || {
390 rustc_builtin_macros::test_harness::inject(&sess, &mut resolver, &mut krate)
393 if let Some(PpMode::Source(PpSourceMode::EveryBodyLoops)) = sess.opts.pretty {
394 tracing::debug!("replacing bodies with loop {{}}");
395 util::ReplaceBodyWithLoop::new(&mut resolver).visit_crate(&mut krate);
398 let has_proc_macro_decls = sess.time("AST_validation", || {
399 rustc_ast_passes::ast_validation::check_crate(sess, &krate, &mut resolver.lint_buffer())
402 let crate_types = sess.crate_types();
403 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
405 // For backwards compatibility, we don't try to run proc macro injection
406 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
407 // specified. This should only affect users who manually invoke 'rustdoc', as
408 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
409 // However, we do emit a warning, to let such users know that they should
410 // start passing '--crate-type proc-macro'
411 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
412 let mut msg = sess.diagnostic().struct_warn(
413 &"Trying to document proc macro crate \
414 without passing '--crate-type proc-macro to rustdoc",
417 msg.warn("The generated documentation may be incorrect");
420 krate = sess.time("maybe_create_a_macro_crate", || {
421 let num_crate_types = crate_types.len();
422 let is_test_crate = sess.opts.test;
423 rustc_builtin_macros::proc_macro_harness::inject(
428 has_proc_macro_decls,
436 // Done with macro expansion!
438 if sess.opts.debugging_opts.input_stats {
439 eprintln!("Post-expansion node count: {}", count_nodes(&krate));
442 if sess.opts.debugging_opts.hir_stats {
443 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
446 if sess.opts.debugging_opts.ast_json {
447 println!("{}", json::as_json(&krate));
450 resolver.resolve_crate(&krate);
452 // Needs to go *after* expansion to be able to check the results of macro expansion.
453 sess.time("complete_gated_feature_checking", || {
454 rustc_ast_passes::feature_gate::check_crate(&krate, sess);
457 // Add all buffered lints from the `ParseSess` to the `Session`.
458 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
459 info!("{} parse sess buffered_lints", buffered_lints.len());
460 for early_lint in buffered_lints.drain(..) {
461 resolver.lint_buffer().add_early_lint(early_lint);
465 Ok((krate, resolver))
468 pub fn lower_to_hir<'res, 'tcx>(
470 lint_store: &LintStore,
471 resolver: &'res mut Resolver<'_>,
472 dep_graph: &'res DepGraph,
473 krate: &'res ast::Crate,
474 arena: &'tcx rustc_ast_lowering::Arena<'tcx>,
476 // We're constructing the HIR here; we don't care what we will
477 // read, since we haven't even constructed the *input* to
479 dep_graph.assert_ignored();
482 let hir_crate = rustc_ast_lowering::lower_crate(
486 rustc_parse::nt_to_tokenstream,
490 if sess.opts.debugging_opts.hir_stats {
491 hir_stats::print_hir_stats(&hir_crate);
494 sess.time("early_lint_checks", || {
495 rustc_lint::check_ast_crate(
500 Some(std::mem::take(resolver.lint_buffer())),
501 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
505 // Discard hygiene data, which isn't required after lowering to HIR.
506 if !sess.opts.debugging_opts.keep_hygiene_data {
507 rustc_span::hygiene::clear_syntax_context_map();
513 // Returns all the paths that correspond to generated files.
514 fn generated_output_paths(
516 outputs: &OutputFilenames,
520 let mut out_filenames = Vec::new();
521 for output_type in sess.opts.output_types.keys() {
522 let file = outputs.path(*output_type);
524 // If the filename has been overridden using `-o`, it will not be modified
525 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
526 OutputType::Exe if !exact_name => {
527 for crate_type in sess.crate_types().iter() {
528 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
529 out_filenames.push(p);
532 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
533 // Don't add the dep-info output when omitting it from dep-info targets
536 out_filenames.push(file);
543 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
544 // returns None for every file path.
545 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
547 F: Fn(&PathBuf) -> Option<T>,
549 for output_path in output_paths {
550 if let Some(result) = f(output_path) {
557 fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
558 let input_path = input_path.canonicalize().ok();
559 if input_path.is_none() {
562 let check = |output_path: &PathBuf| {
563 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
565 check_output(output_paths, check).is_some()
568 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
569 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
570 check_output(output_paths, check)
573 fn escape_dep_filename(filename: &String) -> String {
574 // Apparently clang and gcc *only* escape spaces:
575 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
576 filename.replace(" ", "\\ ")
579 // Makefile comments only need escaping newlines and `\`.
580 // The result can be unescaped by anything that can unescape `escape_default` and friends.
581 fn escape_dep_env(symbol: Symbol) -> String {
582 let s = symbol.as_str();
583 let mut escaped = String::with_capacity(s.len());
586 '\n' => escaped.push_str(r"\n"),
587 '\r' => escaped.push_str(r"\r"),
588 '\\' => escaped.push_str(r"\\"),
589 _ => escaped.push(c),
597 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
598 outputs: &OutputFilenames,
599 out_filenames: &[PathBuf],
601 // Write out dependency rules to the dep-info file if requested
602 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
605 let deps_filename = outputs.path(OutputType::DepInfo);
607 let result = (|| -> io::Result<()> {
608 // Build a list of files used to compile the output and
609 // write Makefile-compatible dependency rules
610 let mut files: Vec<String> = sess
614 .filter(|fmap| fmap.is_real_file())
615 .filter(|fmap| !fmap.is_imported())
616 .map(|fmap| escape_dep_filename(&fmap.name.prefer_local().to_string()))
619 if let Some(ref backend) = sess.opts.debugging_opts.codegen_backend {
620 files.push(backend.to_string());
623 if sess.binary_dep_depinfo() {
624 boxed_resolver.borrow().borrow_mut().access(|resolver| {
625 for cnum in resolver.cstore().crates_untracked() {
626 let source = resolver.cstore().crate_source_untracked(cnum);
627 if let Some((path, _)) = source.dylib {
628 files.push(escape_dep_filename(&path.display().to_string()));
630 if let Some((path, _)) = source.rlib {
631 files.push(escape_dep_filename(&path.display().to_string()));
633 if let Some((path, _)) = source.rmeta {
634 files.push(escape_dep_filename(&path.display().to_string()));
640 let mut file = BufWriter::new(fs::File::create(&deps_filename)?);
641 for path in out_filenames {
642 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
645 // Emit a fake target for each input file to the compilation. This
646 // prevents `make` from spitting out an error if a file is later
647 // deleted. For more info see #28735
649 writeln!(file, "{}:", path)?;
652 // Emit special comments with information about accessed environment variables.
653 let env_depinfo = sess.parse_sess.env_depinfo.borrow();
654 if !env_depinfo.is_empty() {
655 let mut envs: Vec<_> = env_depinfo
657 .map(|(k, v)| (escape_dep_env(*k), v.map(escape_dep_env)))
659 envs.sort_unstable();
662 write!(file, "# env-dep:{}", k)?;
664 write!(file, "={}", v)?;
675 if sess.opts.json_artifact_notifications {
678 .emit_artifact_notification(&deps_filename, "dep-info");
681 Err(e) => sess.fatal(&format!(
682 "error writing dependencies to `{}`: {}",
683 deps_filename.display(),
689 pub fn prepare_outputs(
693 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
695 ) -> Result<OutputFilenames> {
696 let _timer = sess.timer("prepare_outputs");
698 // FIXME: rustdoc passes &[] instead of &krate.attrs here
699 let outputs = util::build_output_filenames(
701 &compiler.output_dir,
702 &compiler.output_file,
708 generated_output_paths(sess, &outputs, compiler.output_file.is_some(), &crate_name);
710 // Ensure the source file isn't accidentally overwritten during compilation.
711 if let Some(ref input_path) = compiler.input_path {
712 if sess.opts.will_create_output_file() {
713 if output_contains_path(&output_paths, input_path) {
715 "the input file \"{}\" would be overwritten by the generated \
719 return Err(ErrorReported);
721 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
723 "the generated executable for the input file \"{}\" conflicts with the \
724 existing directory \"{}\"",
725 input_path.display(),
728 return Err(ErrorReported);
733 write_out_deps(sess, boxed_resolver, &outputs, &output_paths);
735 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
736 && sess.opts.output_types.len() == 1;
739 if let Some(ref dir) = compiler.output_dir {
740 if fs::create_dir_all(dir).is_err() {
741 sess.err("failed to find or create the directory specified by `--out-dir`");
742 return Err(ErrorReported);
750 pub static DEFAULT_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
751 let providers = &mut Providers::default();
752 providers.analysis = analysis;
753 proc_macro_decls::provide(providers);
754 plugin::build::provide(providers);
755 rustc_middle::hir::provide(providers);
756 mir::provide(providers);
757 mir_build::provide(providers);
758 rustc_privacy::provide(providers);
759 typeck::provide(providers);
760 ty::provide(providers);
761 traits::provide(providers);
762 rustc_passes::provide(providers);
763 rustc_resolve::provide(providers);
764 rustc_traits::provide(providers);
765 rustc_ty_utils::provide(providers);
766 rustc_metadata::provide(providers);
767 rustc_lint::provide(providers);
768 rustc_symbol_mangling::provide(providers);
769 rustc_codegen_ssa::provide(providers);
773 pub static DEFAULT_EXTERN_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
774 let mut extern_providers = *DEFAULT_QUERY_PROVIDERS;
775 rustc_metadata::provide_extern(&mut extern_providers);
776 rustc_codegen_ssa::provide_extern(&mut extern_providers);
780 pub struct QueryContext<'tcx> {
781 gcx: &'tcx GlobalCtxt<'tcx>,
784 impl<'tcx> QueryContext<'tcx> {
785 pub fn enter<F, R>(&mut self, f: F) -> R
787 F: FnOnce(TyCtxt<'tcx>) -> R,
789 let icx = ty::tls::ImplicitCtxt::new(self.gcx);
790 ty::tls::enter_context(&icx, |_| f(icx.tcx))
794 pub fn create_global_ctxt<'tcx>(
795 compiler: &'tcx Compiler,
796 lint_store: Lrc<LintStore>,
797 krate: &'tcx Crate<'tcx>,
799 resolver_outputs: ResolverOutputs,
800 outputs: OutputFilenames,
802 queries: &'tcx OnceCell<TcxQueries<'tcx>>,
803 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
804 arena: &'tcx WorkerLocal<Arena<'tcx>>,
805 ) -> QueryContext<'tcx> {
806 let sess = &compiler.session();
808 let def_path_table = resolver_outputs.definitions.def_path_table();
809 let query_result_on_disk_cache =
810 rustc_incremental::load_query_result_cache(sess, def_path_table);
812 let codegen_backend = compiler.codegen_backend();
813 let mut local_providers = *DEFAULT_QUERY_PROVIDERS;
814 codegen_backend.provide(&mut local_providers);
816 let mut extern_providers = *DEFAULT_EXTERN_QUERY_PROVIDERS;
817 codegen_backend.provide(&mut extern_providers);
818 codegen_backend.provide_extern(&mut extern_providers);
820 if let Some(callback) = compiler.override_queries {
821 callback(sess, &mut local_providers, &mut extern_providers);
824 let queries = queries.get_or_init(|| TcxQueries::new(local_providers, extern_providers));
826 let gcx = sess.time("setup_global_ctxt", || {
827 global_ctxt.get_or_init(|| {
828 TyCtxt::create_global_ctxt(
835 query_result_on_disk_cache,
846 /// Runs the resolution, type-checking, region checking and other
847 /// miscellaneous analysis passes on the crate.
848 fn analysis(tcx: TyCtxt<'_>, (): ()) -> Result<()> {
849 rustc_passes::hir_id_validator::check_crate(tcx);
852 let mut entry_point = None;
854 sess.time("misc_checking_1", || {
857 entry_point = sess.time("looking_for_entry_point", || tcx.entry_fn(()));
859 sess.time("looking_for_plugin_registrar", || tcx.ensure().plugin_registrar_fn(()));
861 sess.time("looking_for_derive_registrar", || {
862 tcx.ensure().proc_macro_decls_static(())
867 .downcast_ref::<CStore>()
868 .expect("`tcx.cstore` is not a `CStore`");
869 cstore.report_unused_deps(tcx);
872 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
873 tcx.ensure().check_mod_loops(module);
874 tcx.ensure().check_mod_attrs(module);
875 tcx.ensure().check_mod_naked_functions(module);
876 tcx.ensure().check_mod_unstable_api_usage(module);
877 tcx.ensure().check_mod_const_bodies(module);
883 // passes are timed inside typeck
884 typeck::check_crate(tcx)?;
886 sess.time("misc_checking_2", || {
889 sess.time("match_checking", || {
890 tcx.par_body_owners(|def_id| {
891 tcx.ensure().check_match(def_id.to_def_id());
896 sess.time("liveness_and_intrinsic_checking", || {
897 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
898 // this must run before MIR dump, because
899 // "not all control paths return a value" is reported here.
901 // maybe move the check to a MIR pass?
902 tcx.ensure().check_mod_liveness(module);
903 tcx.ensure().check_mod_intrinsics(module);
910 sess.time("MIR_borrow_checking", || {
911 tcx.par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
914 sess.time("MIR_effect_checking", || {
915 for def_id in tcx.body_owners() {
916 tcx.ensure().thir_check_unsafety(def_id);
917 if !tcx.sess.opts.debugging_opts.thir_unsafeck {
918 mir::transform::check_unsafety::check_unsafety(tcx, def_id);
921 if tcx.hir().body_const_context(def_id).is_some() {
923 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::unknown(def_id));
928 sess.time("layout_testing", || layout_test::test_layout(tcx));
930 // Avoid overwhelming user with errors if borrow checking failed.
931 // I'm not sure how helpful this is, to be honest, but it avoids a
932 // lot of annoying errors in the ui tests (basically,
933 // lint warnings and so on -- kindck used to do this abort, but
934 // kindck is gone now). -nmatsakis
935 if sess.has_errors() {
936 return Err(ErrorReported);
939 sess.time("misc_checking_3", || {
942 tcx.ensure().privacy_access_levels(());
946 tcx.ensure().check_private_in_public(());
949 sess.time("death_checking", || rustc_passes::dead::check_crate(tcx));
952 sess.time("unused_lib_feature_checking", || {
953 rustc_passes::stability::check_unused_or_stable_features(tcx)
957 sess.time("lint_checking", || {
958 rustc_lint::check_crate(tcx, || {
959 rustc_lint::BuiltinCombinedLateLintPass::new()
966 sess.time("privacy_checking_modules", || {
967 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
968 tcx.ensure().check_mod_privacy(module);
978 fn encode_and_write_metadata(
980 outputs: &OutputFilenames,
981 ) -> (middle::cstore::EncodedMetadata, bool) {
982 #[derive(PartialEq, Eq, PartialOrd, Ord)]
989 let metadata_kind = tcx
993 .map(|ty| match *ty {
994 CrateType::Executable | CrateType::Staticlib | CrateType::Cdylib => MetadataKind::None,
996 CrateType::Rlib => MetadataKind::Uncompressed,
998 CrateType::Dylib | CrateType::ProcMacro => MetadataKind::Compressed,
1001 .unwrap_or(MetadataKind::None);
1003 let metadata = match metadata_kind {
1004 MetadataKind::None => middle::cstore::EncodedMetadata::new(),
1005 MetadataKind::Uncompressed | MetadataKind::Compressed => tcx.encode_metadata(),
1008 let _prof_timer = tcx.sess.prof.generic_activity("write_crate_metadata");
1010 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
1011 if need_metadata_file {
1012 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
1013 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
1014 // To avoid races with another rustc process scanning the output directory,
1015 // we need to write the file somewhere else and atomically move it to its
1016 // final destination, with an `fs::rename` call. In order for the rename to
1017 // always succeed, the temporary file needs to be on the same filesystem,
1018 // which is why we create it inside the output directory specifically.
1019 let metadata_tmpdir = TempFileBuilder::new()
1021 .tempdir_in(out_filename.parent().unwrap())
1022 .unwrap_or_else(|err| tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err)));
1023 let metadata_tmpdir = MaybeTempDir::new(metadata_tmpdir, tcx.sess.opts.cg.save_temps);
1024 let metadata_filename = emit_metadata(tcx.sess, &metadata.raw_data, &metadata_tmpdir);
1025 if let Err(e) = util::non_durable_rename(&metadata_filename, &out_filename) {
1026 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
1028 if tcx.sess.opts.json_artifact_notifications {
1032 .emit_artifact_notification(&out_filename, "metadata");
1036 let need_metadata_module = metadata_kind == MetadataKind::Compressed;
1038 (metadata, need_metadata_module)
1041 /// Runs the codegen backend, after which the AST and analysis can
1043 pub fn start_codegen<'tcx>(
1044 codegen_backend: &dyn CodegenBackend,
1046 outputs: &OutputFilenames,
1048 info!("Pre-codegen\n{:?}", tcx.debug_stats());
1050 let (metadata, need_metadata_module) = encode_and_write_metadata(tcx, outputs);
1052 let codegen = tcx.sess.time("codegen_crate", move || {
1053 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1056 // Don't run these test assertions when not doing codegen. Compiletest tries to build
1057 // build-fail tests in check mode first and expects it to not give an error in that case.
1058 if tcx.sess.opts.output_types.should_codegen() {
1059 rustc_incremental::assert_module_sources::assert_module_sources(tcx);
1060 rustc_symbol_mangling::test::report_symbol_names(tcx);
1063 info!("Post-codegen\n{:?}", tcx.debug_stats());
1065 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1066 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, outputs) {
1067 tcx.sess.err(&format!("could not emit MIR: {}", e));
1068 tcx.sess.abort_if_errors();