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::path::PathBuf;
52 use std::{env, fs, iter};
54 pub fn parse<'a>(sess: &'a Session, input: &Input) -> PResult<'a, ast::Crate> {
55 let krate = sess.time("parse_crate", || match input {
56 Input::File(file) => parse_crate_from_file(file, &sess.parse_sess),
57 Input::Str { input, name } => {
58 parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess)
62 if sess.opts.debugging_opts.ast_json_noexpand {
63 println!("{}", json::as_json(&krate));
66 if sess.opts.debugging_opts.input_stats {
67 eprintln!("Lines of code: {}", sess.source_map().count_lines());
68 eprintln!("Pre-expansion node count: {}", count_nodes(&krate));
71 if let Some(ref s) = sess.opts.debugging_opts.show_span {
72 rustc_ast_passes::show_span::run(sess.diagnostic(), s, &krate);
75 if sess.opts.debugging_opts.hir_stats {
76 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
82 fn count_nodes(krate: &ast::Crate) -> usize {
83 let mut counter = rustc_ast_passes::node_count::NodeCounter::new();
84 visit::walk_crate(&mut counter, krate);
88 pub struct BoxedResolver(
89 rustc_data_structures::box_region::PinnedGenerator<
91 fn(&mut Resolver<'_>),
97 fn new<T>(generator: T) -> (Result<ast::Crate>, Self)
99 T: ::std::ops::Generator<
100 rustc_data_structures::box_region::Action,
101 Yield = rustc_data_structures::box_region::YieldType<
103 fn(&mut Resolver<'_>),
105 Return = ResolverOutputs,
108 let (initial, pinned) = rustc_data_structures::box_region::PinnedGenerator::new(generator);
109 (initial, BoxedResolver(pinned))
112 pub fn access<F: FnOnce(&mut Resolver<'_>) -> R, R>(&mut self, f: F) -> R {
113 // Turn the FnOnce closure into *mut dyn FnMut()
114 // so we can pass it in to the generator
117 let mut_f: &mut dyn FnMut(&mut Resolver<'_>) = &mut |resolver| {
118 let f = f.take().unwrap();
119 r = Some(f(resolver));
121 let mut_f = mut_f as *mut dyn FnMut(&mut Resolver<'_>);
123 // Get the generator to call our closure
125 self.0.access(::std::mem::transmute(mut_f));
132 pub fn complete(mut self) -> ResolverOutputs {
137 value: Result<ast::Crate>,
138 ) -> rustc_data_structures::box_region::YieldType<Result<ast::Crate>, fn(&mut Resolver<'_>)>
140 rustc_data_structures::box_region::YieldType::Initial(value)
144 /// Runs the "early phases" of the compiler: initial `cfg` processing, loading compiler plugins,
145 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
146 /// harness if one is to be provided, injection of a dependency on the
147 /// standard library and prelude, and name resolution.
149 /// Returns [`None`] if we're aborting after handling -W help.
150 pub fn configure_and_expand(
152 lint_store: Lrc<LintStore>,
153 metadata_loader: Box<MetadataLoaderDyn>,
156 ) -> Result<(ast::Crate, BoxedResolver)> {
157 tracing::trace!("configure_and_expand");
158 // Currently, we ignore the name resolution data structures for the purposes of dependency
159 // tracking. Instead we will run name resolution and include its output in the hash of each
160 // item, much like we do for macro expansion. In other words, the hash reflects not just
161 // its contents but the results of name resolution on those contents. Hopefully we'll push
162 // this back at some point.
163 let crate_name = crate_name.to_string();
164 let (result, resolver) = BoxedResolver::new(static move |mut action| {
167 let resolver_arenas = Resolver::arenas();
168 let res = configure_and_expand_inner(
176 let mut resolver = match res {
178 yield BoxedResolver::initial_yield(Err(v));
181 Ok((krate, resolver)) => {
182 action = yield BoxedResolver::initial_yield(Ok(krate));
189 rustc_data_structures::box_region::Action::Access(accessor) => {
190 let accessor: &mut dyn FnMut(&mut Resolver<'_>) =
191 unsafe { ::std::mem::transmute(accessor.get()) };
192 (*accessor)(&mut resolver);
194 let marker = rustc_data_structures::box_region::Marker::<
195 fn(&mut Resolver<'_>),
198 yield rustc_data_structures::box_region::YieldType::Accessor(marker);
201 rustc_data_structures::box_region::Action::Complete => break,
202 rustc_data_structures::box_region::Action::Initial => {
203 panic!("unexpected box_region action: Initial")
208 resolver.into_outputs()
210 result.map(|k| (k, resolver))
214 pub fn to_resolver_outputs(resolver: Rc<RefCell<BoxedResolver>>) -> ResolverOutputs {
215 match Rc::try_unwrap(resolver) {
216 Ok(resolver) => resolver.into_inner().complete(),
217 Err(resolver) => resolver.borrow_mut().access(|resolver| resolver.clone_outputs()),
222 pub fn register_plugins<'a>(
224 metadata_loader: &'a dyn MetadataLoader,
225 register_lints: impl Fn(&Session, &mut LintStore),
226 mut krate: ast::Crate,
228 ) -> Result<(ast::Crate, Lrc<LintStore>)> {
229 krate = sess.time("attributes_injection", || {
230 rustc_builtin_macros::cmdline_attrs::inject(
233 &sess.opts.debugging_opts.crate_attr,
237 let (krate, features) = rustc_expand::config::features(sess, krate);
238 // these need to be set "early" so that expansion sees `quote` if enabled.
239 sess.init_features(features);
241 let crate_types = util::collect_crate_types(sess, &krate.attrs);
242 sess.init_crate_types(crate_types);
244 let disambiguator = util::compute_crate_disambiguator(sess);
245 sess.crate_disambiguator.set(disambiguator).expect("not yet initialized");
246 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator)?;
248 if sess.opts.incremental.is_some() {
249 sess.time("incr_comp_garbage_collect_session_directories", || {
250 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
252 "Error while trying to garbage collect incremental \
253 compilation cache directory: {}",
260 sess.time("recursion_limit", || {
261 middle::limits::update_limits(sess, &krate);
264 let mut lint_store = rustc_lint::new_lint_store(
265 sess.opts.debugging_opts.no_interleave_lints,
266 sess.unstable_options(),
268 register_lints(&sess, &mut lint_store);
271 sess.time("plugin_loading", || plugin::load::load_plugins(sess, metadata_loader, &krate));
272 sess.time("plugin_registration", || {
273 let mut registry = plugin::Registry { lint_store: &mut lint_store };
274 for registrar in registrars {
275 registrar(&mut registry);
279 let lint_store = Lrc::new(lint_store);
280 sess.init_lint_store(lint_store.clone());
282 Ok((krate, lint_store))
285 fn pre_expansion_lint(
287 lint_store: &LintStore,
291 sess.prof.generic_activity_with_arg("pre_AST_expansion_lint_checks", crate_name).run(|| {
292 rustc_lint::check_ast_crate(
298 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
303 fn configure_and_expand_inner<'a>(
305 lint_store: &'a LintStore,
306 mut krate: ast::Crate,
308 resolver_arenas: &'a ResolverArenas<'a>,
309 metadata_loader: &'a MetadataLoaderDyn,
310 ) -> Result<(ast::Crate, Resolver<'a>)> {
311 tracing::trace!("configure_and_expand_inner");
312 pre_expansion_lint(sess, lint_store, &krate, crate_name);
314 let mut resolver = Resolver::new(sess, &krate, crate_name, metadata_loader, &resolver_arenas);
315 rustc_builtin_macros::register_builtin_macros(&mut resolver);
317 krate = sess.time("crate_injection", || {
318 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| Symbol::intern(s));
319 rustc_builtin_macros::standard_library_imports::inject(
327 util::check_attr_crate_type(&sess, &krate.attrs, &mut resolver.lint_buffer());
330 krate = sess.time("macro_expand_crate", || {
331 // Windows dlls do not have rpaths, so they don't know how to find their
332 // dependencies. It's up to us to tell the system where to find all the
333 // dependent dlls. Note that this uses cfg!(windows) as opposed to
334 // targ_cfg because syntax extensions are always loaded for the host
335 // compiler, not for the target.
337 // This is somewhat of an inherently racy operation, however, as
338 // multiple threads calling this function could possibly continue
339 // extending PATH far beyond what it should. To solve this for now we
340 // just don't add any new elements to PATH which are already there
341 // within PATH. This is basically a targeted fix at #17360 for rustdoc
342 // which runs rustc in parallel but has been seen (#33844) to cause
343 // problems with PATH becoming too long.
344 let mut old_path = OsString::new();
346 old_path = env::var_os("PATH").unwrap_or(old_path);
347 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
348 for path in env::split_paths(&old_path) {
349 if !new_path.contains(&path) {
356 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
362 // Create the config for macro expansion
363 let features = sess.features_untracked();
364 let cfg = rustc_expand::expand::ExpansionConfig {
365 features: Some(&features),
366 recursion_limit: sess.recursion_limit(),
367 trace_mac: sess.opts.debugging_opts.trace_macros,
368 should_test: sess.opts.test,
369 span_debug: sess.opts.debugging_opts.span_debug,
370 proc_macro_backtrace: sess.opts.debugging_opts.proc_macro_backtrace,
371 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
374 let extern_mod_loaded = |ident: Ident, attrs, items, span| {
375 let krate = ast::Crate { attrs, items, span, proc_macros: vec![] };
376 pre_expansion_lint(sess, lint_store, &krate, &ident.name.as_str());
377 (krate.attrs, krate.items)
379 let mut ecx = ExtCtxt::new(&sess, cfg, &mut resolver, Some(&extern_mod_loaded));
381 // Expand macros now!
382 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
384 // The rest is error reporting
386 sess.time("check_unused_macros", || {
387 ecx.check_unused_macros();
390 let mut missing_fragment_specifiers: Vec<_> = ecx
393 .missing_fragment_specifiers
396 .map(|(span, node_id)| (*span, *node_id))
398 missing_fragment_specifiers.sort_unstable_by_key(|(span, _)| *span);
400 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
402 for (span, node_id) in missing_fragment_specifiers {
403 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
404 let msg = "missing fragment specifier";
405 resolver.lint_buffer().buffer_lint(lint, node_id, span, msg);
408 env::set_var("PATH", &old_path);
411 if recursion_limit_hit {
412 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
420 sess.time("maybe_building_test_harness", || {
421 rustc_builtin_macros::test_harness::inject(&sess, &mut resolver, &mut krate)
424 if let Some(PpMode::Source(PpSourceMode::EveryBodyLoops)) = sess.opts.pretty {
425 tracing::debug!("replacing bodies with loop {{}}");
426 util::ReplaceBodyWithLoop::new(&mut resolver).visit_crate(&mut krate);
429 let has_proc_macro_decls = sess.time("AST_validation", || {
430 rustc_ast_passes::ast_validation::check_crate(sess, &krate, &mut resolver.lint_buffer())
433 let crate_types = sess.crate_types();
434 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
436 // For backwards compatibility, we don't try to run proc macro injection
437 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
438 // specified. This should only affect users who manually invoke 'rustdoc', as
439 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
440 // However, we do emit a warning, to let such users know that they should
441 // start passing '--crate-type proc-macro'
442 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
443 let mut msg = sess.diagnostic().struct_warn(
444 &"Trying to document proc macro crate \
445 without passing '--crate-type proc-macro to rustdoc",
448 msg.warn("The generated documentation may be incorrect");
451 krate = sess.time("maybe_create_a_macro_crate", || {
452 let num_crate_types = crate_types.len();
453 let is_test_crate = sess.opts.test;
454 rustc_builtin_macros::proc_macro_harness::inject(
459 has_proc_macro_decls,
467 // Done with macro expansion!
469 if sess.opts.debugging_opts.input_stats {
470 eprintln!("Post-expansion node count: {}", count_nodes(&krate));
473 if sess.opts.debugging_opts.hir_stats {
474 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
477 if sess.opts.debugging_opts.ast_json {
478 println!("{}", json::as_json(&krate));
481 resolver.resolve_crate(&krate);
483 // Needs to go *after* expansion to be able to check the results of macro expansion.
484 sess.time("complete_gated_feature_checking", || {
485 rustc_ast_passes::feature_gate::check_crate(&krate, sess);
488 // Add all buffered lints from the `ParseSess` to the `Session`.
489 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
490 info!("{} parse sess buffered_lints", buffered_lints.len());
491 for early_lint in buffered_lints.drain(..) {
492 resolver.lint_buffer().add_early_lint(early_lint);
496 Ok((krate, resolver))
499 pub fn lower_to_hir<'res, 'tcx>(
501 lint_store: &LintStore,
502 resolver: &'res mut Resolver<'_>,
503 dep_graph: &'res DepGraph,
504 krate: &'res ast::Crate,
505 arena: &'tcx rustc_ast_lowering::Arena<'tcx>,
507 // We're constructing the HIR here; we don't care what we will
508 // read, since we haven't even constructed the *input* to
510 dep_graph.assert_ignored();
513 let hir_crate = rustc_ast_lowering::lower_crate(
517 rustc_parse::nt_to_tokenstream,
521 if sess.opts.debugging_opts.hir_stats {
522 hir_stats::print_hir_stats(&hir_crate);
525 sess.time("early_lint_checks", || {
526 rustc_lint::check_ast_crate(
531 Some(std::mem::take(resolver.lint_buffer())),
532 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
536 // Discard hygiene data, which isn't required after lowering to HIR.
537 if !sess.opts.debugging_opts.keep_hygiene_data {
538 rustc_span::hygiene::clear_syntax_context_map();
544 // Returns all the paths that correspond to generated files.
545 fn generated_output_paths(
547 outputs: &OutputFilenames,
551 let mut out_filenames = Vec::new();
552 for output_type in sess.opts.output_types.keys() {
553 let file = outputs.path(*output_type);
555 // If the filename has been overridden using `-o`, it will not be modified
556 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
557 OutputType::Exe if !exact_name => {
558 for crate_type in sess.crate_types().iter() {
559 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
560 out_filenames.push(p);
563 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
564 // Don't add the dep-info output when omitting it from dep-info targets
567 out_filenames.push(file);
574 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
575 // returns None for every file path.
576 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
578 F: Fn(&PathBuf) -> Option<T>,
580 for output_path in output_paths {
581 if let Some(result) = f(output_path) {
588 fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
589 let input_path = input_path.canonicalize().ok();
590 if input_path.is_none() {
593 let check = |output_path: &PathBuf| {
594 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
596 check_output(output_paths, check).is_some()
599 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
600 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
601 check_output(output_paths, check)
604 fn escape_dep_filename(filename: &String) -> String {
605 // Apparently clang and gcc *only* escape spaces:
606 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
607 filename.replace(" ", "\\ ")
610 // Makefile comments only need escaping newlines and `\`.
611 // The result can be unescaped by anything that can unescape `escape_default` and friends.
612 fn escape_dep_env(symbol: Symbol) -> String {
613 let s = symbol.as_str();
614 let mut escaped = String::with_capacity(s.len());
617 '\n' => escaped.push_str(r"\n"),
618 '\r' => escaped.push_str(r"\r"),
619 '\\' => escaped.push_str(r"\\"),
620 _ => escaped.push(c),
628 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
629 outputs: &OutputFilenames,
630 out_filenames: &[PathBuf],
632 // Write out dependency rules to the dep-info file if requested
633 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
636 let deps_filename = outputs.path(OutputType::DepInfo);
638 let result = (|| -> io::Result<()> {
639 // Build a list of files used to compile the output and
640 // write Makefile-compatible dependency rules
641 let mut files: Vec<String> = sess
645 .filter(|fmap| fmap.is_real_file())
646 .filter(|fmap| !fmap.is_imported())
647 .map(|fmap| escape_dep_filename(&fmap.name.prefer_local().to_string()))
650 if let Some(ref backend) = sess.opts.debugging_opts.codegen_backend {
651 files.push(backend.to_string());
654 if sess.binary_dep_depinfo() {
655 boxed_resolver.borrow().borrow_mut().access(|resolver| {
656 for cnum in resolver.cstore().crates_untracked() {
657 let source = resolver.cstore().crate_source_untracked(cnum);
658 if let Some((path, _)) = source.dylib {
659 files.push(escape_dep_filename(&path.display().to_string()));
661 if let Some((path, _)) = source.rlib {
662 files.push(escape_dep_filename(&path.display().to_string()));
664 if let Some((path, _)) = source.rmeta {
665 files.push(escape_dep_filename(&path.display().to_string()));
671 let mut file = BufWriter::new(fs::File::create(&deps_filename)?);
672 for path in out_filenames {
673 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
676 // Emit a fake target for each input file to the compilation. This
677 // prevents `make` from spitting out an error if a file is later
678 // deleted. For more info see #28735
680 writeln!(file, "{}:", path)?;
683 // Emit special comments with information about accessed environment variables.
684 let env_depinfo = sess.parse_sess.env_depinfo.borrow();
685 if !env_depinfo.is_empty() {
686 let mut envs: Vec<_> = env_depinfo
688 .map(|(k, v)| (escape_dep_env(*k), v.map(escape_dep_env)))
690 envs.sort_unstable();
693 write!(file, "# env-dep:{}", k)?;
695 write!(file, "={}", v)?;
706 if sess.opts.json_artifact_notifications {
709 .emit_artifact_notification(&deps_filename, "dep-info");
712 Err(e) => sess.fatal(&format!(
713 "error writing dependencies to `{}`: {}",
714 deps_filename.display(),
720 pub fn prepare_outputs(
724 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
726 ) -> Result<OutputFilenames> {
727 let _timer = sess.timer("prepare_outputs");
729 // FIXME: rustdoc passes &[] instead of &krate.attrs here
730 let outputs = util::build_output_filenames(
732 &compiler.output_dir,
733 &compiler.output_file,
739 generated_output_paths(sess, &outputs, compiler.output_file.is_some(), &crate_name);
741 // Ensure the source file isn't accidentally overwritten during compilation.
742 if let Some(ref input_path) = compiler.input_path {
743 if sess.opts.will_create_output_file() {
744 if output_contains_path(&output_paths, input_path) {
746 "the input file \"{}\" would be overwritten by the generated \
750 return Err(ErrorReported);
752 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
754 "the generated executable for the input file \"{}\" conflicts with the \
755 existing directory \"{}\"",
756 input_path.display(),
759 return Err(ErrorReported);
764 write_out_deps(sess, boxed_resolver, &outputs, &output_paths);
766 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
767 && sess.opts.output_types.len() == 1;
770 if let Some(ref dir) = compiler.output_dir {
771 if fs::create_dir_all(dir).is_err() {
772 sess.err("failed to find or create the directory specified by `--out-dir`");
773 return Err(ErrorReported);
781 pub static DEFAULT_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
782 let providers = &mut Providers::default();
783 providers.analysis = analysis;
784 proc_macro_decls::provide(providers);
785 plugin::build::provide(providers);
786 rustc_middle::hir::provide(providers);
787 mir::provide(providers);
788 mir_build::provide(providers);
789 rustc_privacy::provide(providers);
790 typeck::provide(providers);
791 ty::provide(providers);
792 traits::provide(providers);
793 rustc_passes::provide(providers);
794 rustc_resolve::provide(providers);
795 rustc_traits::provide(providers);
796 rustc_ty_utils::provide(providers);
797 rustc_metadata::provide(providers);
798 rustc_lint::provide(providers);
799 rustc_symbol_mangling::provide(providers);
800 rustc_codegen_ssa::provide(providers);
804 pub static DEFAULT_EXTERN_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
805 let mut extern_providers = *DEFAULT_QUERY_PROVIDERS;
806 rustc_metadata::provide_extern(&mut extern_providers);
807 rustc_codegen_ssa::provide_extern(&mut extern_providers);
811 pub struct QueryContext<'tcx> {
812 gcx: &'tcx GlobalCtxt<'tcx>,
815 impl<'tcx> QueryContext<'tcx> {
816 pub fn enter<F, R>(&mut self, f: F) -> R
818 F: FnOnce(TyCtxt<'tcx>) -> R,
820 let icx = ty::tls::ImplicitCtxt::new(self.gcx);
821 ty::tls::enter_context(&icx, |_| f(icx.tcx))
825 pub fn create_global_ctxt<'tcx>(
826 compiler: &'tcx Compiler,
827 lint_store: Lrc<LintStore>,
828 krate: &'tcx Crate<'tcx>,
830 resolver_outputs: ResolverOutputs,
831 outputs: OutputFilenames,
833 queries: &'tcx OnceCell<TcxQueries<'tcx>>,
834 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
835 arena: &'tcx WorkerLocal<Arena<'tcx>>,
836 ) -> QueryContext<'tcx> {
837 let sess = &compiler.session();
839 let def_path_table = resolver_outputs.definitions.def_path_table();
840 let query_result_on_disk_cache =
841 rustc_incremental::load_query_result_cache(sess, def_path_table);
843 let codegen_backend = compiler.codegen_backend();
844 let mut local_providers = *DEFAULT_QUERY_PROVIDERS;
845 codegen_backend.provide(&mut local_providers);
847 let mut extern_providers = *DEFAULT_EXTERN_QUERY_PROVIDERS;
848 codegen_backend.provide(&mut extern_providers);
849 codegen_backend.provide_extern(&mut extern_providers);
851 if let Some(callback) = compiler.override_queries {
852 callback(sess, &mut local_providers, &mut extern_providers);
855 let queries = queries.get_or_init(|| TcxQueries::new(local_providers, extern_providers));
857 let gcx = sess.time("setup_global_ctxt", || {
858 global_ctxt.get_or_init(|| {
859 TyCtxt::create_global_ctxt(
866 query_result_on_disk_cache,
877 /// Runs the resolution, type-checking, region checking and other
878 /// miscellaneous analysis passes on the crate.
879 fn analysis(tcx: TyCtxt<'_>, (): ()) -> Result<()> {
880 rustc_passes::hir_id_validator::check_crate(tcx);
883 let mut entry_point = None;
885 sess.time("misc_checking_1", || {
888 entry_point = sess.time("looking_for_entry_point", || tcx.entry_fn(()));
890 sess.time("looking_for_plugin_registrar", || tcx.ensure().plugin_registrar_fn(()));
892 sess.time("looking_for_derive_registrar", || {
893 tcx.ensure().proc_macro_decls_static(())
898 .downcast_ref::<CStore>()
899 .expect("`tcx.cstore` is not a `CStore`");
900 cstore.report_unused_deps(tcx);
903 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
904 tcx.ensure().check_mod_loops(module);
905 tcx.ensure().check_mod_attrs(module);
906 tcx.ensure().check_mod_naked_functions(module);
907 tcx.ensure().check_mod_unstable_api_usage(module);
908 tcx.ensure().check_mod_const_bodies(module);
914 // passes are timed inside typeck
915 typeck::check_crate(tcx)?;
917 sess.time("misc_checking_2", || {
920 sess.time("match_checking", || {
921 tcx.par_body_owners(|def_id| {
922 tcx.ensure().check_match(def_id.to_def_id());
927 sess.time("liveness_and_intrinsic_checking", || {
928 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
929 // this must run before MIR dump, because
930 // "not all control paths return a value" is reported here.
932 // maybe move the check to a MIR pass?
933 tcx.ensure().check_mod_liveness(module);
934 tcx.ensure().check_mod_intrinsics(module);
941 sess.time("MIR_borrow_checking", || {
942 tcx.par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
945 sess.time("MIR_effect_checking", || {
946 for def_id in tcx.body_owners() {
947 tcx.ensure().thir_check_unsafety(def_id);
948 if !tcx.sess.opts.debugging_opts.thir_unsafeck {
949 mir::transform::check_unsafety::check_unsafety(tcx, def_id);
952 if tcx.hir().body_const_context(def_id).is_some() {
954 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::unknown(def_id));
959 sess.time("layout_testing", || layout_test::test_layout(tcx));
961 // Avoid overwhelming user with errors if borrow checking failed.
962 // I'm not sure how helpful this is, to be honest, but it avoids a
963 // lot of annoying errors in the ui tests (basically,
964 // lint warnings and so on -- kindck used to do this abort, but
965 // kindck is gone now). -nmatsakis
966 if sess.has_errors() {
967 return Err(ErrorReported);
970 sess.time("misc_checking_3", || {
973 tcx.ensure().privacy_access_levels(());
977 tcx.ensure().check_private_in_public(());
980 sess.time("death_checking", || rustc_passes::dead::check_crate(tcx));
983 sess.time("unused_lib_feature_checking", || {
984 rustc_passes::stability::check_unused_or_stable_features(tcx)
988 sess.time("lint_checking", || {
989 rustc_lint::check_crate(tcx, || {
990 rustc_lint::BuiltinCombinedLateLintPass::new()
997 sess.time("privacy_checking_modules", || {
998 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
999 tcx.ensure().check_mod_privacy(module);
1009 fn encode_and_write_metadata(
1011 outputs: &OutputFilenames,
1012 ) -> (middle::cstore::EncodedMetadata, bool) {
1013 #[derive(PartialEq, Eq, PartialOrd, Ord)]
1020 let metadata_kind = tcx
1024 .map(|ty| match *ty {
1025 CrateType::Executable | CrateType::Staticlib | CrateType::Cdylib => MetadataKind::None,
1027 CrateType::Rlib => MetadataKind::Uncompressed,
1029 CrateType::Dylib | CrateType::ProcMacro => MetadataKind::Compressed,
1032 .unwrap_or(MetadataKind::None);
1034 let metadata = match metadata_kind {
1035 MetadataKind::None => middle::cstore::EncodedMetadata::new(),
1036 MetadataKind::Uncompressed | MetadataKind::Compressed => tcx.encode_metadata(),
1039 let _prof_timer = tcx.sess.prof.generic_activity("write_crate_metadata");
1041 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
1042 if need_metadata_file {
1043 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
1044 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
1045 // To avoid races with another rustc process scanning the output directory,
1046 // we need to write the file somewhere else and atomically move it to its
1047 // final destination, with an `fs::rename` call. In order for the rename to
1048 // always succeed, the temporary file needs to be on the same filesystem,
1049 // which is why we create it inside the output directory specifically.
1050 let metadata_tmpdir = TempFileBuilder::new()
1052 .tempdir_in(out_filename.parent().unwrap())
1053 .unwrap_or_else(|err| tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err)));
1054 let metadata_tmpdir = MaybeTempDir::new(metadata_tmpdir, tcx.sess.opts.cg.save_temps);
1055 let metadata_filename = emit_metadata(tcx.sess, &metadata.raw_data, &metadata_tmpdir);
1056 if let Err(e) = util::non_durable_rename(&metadata_filename, &out_filename) {
1057 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
1059 if tcx.sess.opts.json_artifact_notifications {
1063 .emit_artifact_notification(&out_filename, "metadata");
1067 let need_metadata_module = metadata_kind == MetadataKind::Compressed;
1069 (metadata, need_metadata_module)
1072 /// Runs the codegen backend, after which the AST and analysis can
1074 pub fn start_codegen<'tcx>(
1075 codegen_backend: &dyn CodegenBackend,
1077 outputs: &OutputFilenames,
1079 info!("Pre-codegen\n{:?}", tcx.debug_stats());
1081 let (metadata, need_metadata_module) = encode_and_write_metadata(tcx, outputs);
1083 let codegen = tcx.sess.time("codegen_crate", move || {
1084 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1087 // Don't run these test assertions when not doing codegen. Compiletest tries to build
1088 // build-fail tests in check mode first and expects it to not give an error in that case.
1089 if tcx.sess.opts.output_types.should_codegen() {
1090 rustc_incremental::assert_module_sources::assert_module_sources(tcx);
1091 rustc_symbol_mangling::test::report_symbol_names(tcx);
1094 info!("Post-codegen\n{:?}", tcx.debug_stats());
1096 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1097 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, outputs) {
1098 tcx.sess.err(&format!("could not emit MIR: {}", e));
1099 tcx.sess.abort_if_errors();