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::steal::Steal;
10 use rustc_data_structures::sync::{par_iter, Lrc, OnceCell, ParallelIterator, WorkerLocal};
11 use rustc_data_structures::temp_dir::MaybeTempDir;
12 use rustc_data_structures::{box_region_allow_access, declare_box_region_type, parallel};
13 use rustc_errors::{ErrorReported, PResult};
14 use rustc_expand::base::ExtCtxt;
15 use rustc_hir::def_id::{CrateNum, LOCAL_CRATE};
16 use rustc_hir::definitions::Definitions;
18 use rustc_lint::LintStore;
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_span::{FileName, RealFileName};
39 use rustc_trait_selection::traits;
40 use rustc_typeck as typeck;
41 use tracing::{info, warn};
43 use rustc_serialize::json;
44 use tempfile::Builder as TempFileBuilder;
47 use std::cell::RefCell;
48 use std::ffi::OsString;
49 use std::io::{self, BufWriter, Write};
50 use std::lazy::SyncLazy;
51 use std::path::PathBuf;
53 use std::{env, fs, iter, mem};
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 declare_box_region_type!(
92 (&mut Resolver<'_>) -> (Result<ast::Crate>, ResolverOutputs)
95 /// Runs the "early phases" of the compiler: initial `cfg` processing, loading compiler plugins,
96 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
97 /// harness if one is to be provided, injection of a dependency on the
98 /// standard library and prelude, and name resolution.
100 /// Returns [`None`] if we're aborting after handling -W help.
101 pub fn configure_and_expand(
103 lint_store: Lrc<LintStore>,
104 metadata_loader: Box<MetadataLoaderDyn>,
107 ) -> Result<(ast::Crate, BoxedResolver)> {
108 tracing::trace!("configure_and_expand");
109 // Currently, we ignore the name resolution data structures for the purposes of dependency
110 // tracking. Instead we will run name resolution and include its output in the hash of each
111 // item, much like we do for macro expansion. In other words, the hash reflects not just
112 // its contents but the results of name resolution on those contents. Hopefully we'll push
113 // this back at some point.
114 let crate_name = crate_name.to_string();
115 let (result, resolver) = BoxedResolver::new(static move |mut action| {
118 let resolver_arenas = Resolver::arenas();
119 let res = configure_and_expand_inner(
127 let mut resolver = match res {
129 yield BoxedResolver::initial_yield(Err(v));
132 Ok((krate, resolver)) => {
133 action = yield BoxedResolver::initial_yield(Ok(krate));
137 box_region_allow_access!(for(), (&mut Resolver<'_>), (&mut resolver), action);
138 resolver.into_outputs()
140 result.map(|k| (k, resolver))
144 pub fn to_resolver_outputs(resolver: Rc<RefCell<BoxedResolver>>) -> ResolverOutputs {
145 match Rc::try_unwrap(resolver) {
146 Ok(resolver) => resolver.into_inner().complete(),
147 Err(resolver) => resolver.borrow_mut().access(|resolver| resolver.clone_outputs()),
152 pub fn register_plugins<'a>(
154 metadata_loader: &'a dyn MetadataLoader,
155 register_lints: impl Fn(&Session, &mut LintStore),
156 mut krate: ast::Crate,
158 ) -> Result<(ast::Crate, Lrc<LintStore>)> {
159 krate = sess.time("attributes_injection", || {
160 rustc_builtin_macros::cmdline_attrs::inject(
163 &sess.opts.debugging_opts.crate_attr,
167 let (krate, features) = rustc_expand::config::features(sess, krate);
168 // these need to be set "early" so that expansion sees `quote` if enabled.
169 sess.init_features(features);
171 let crate_types = util::collect_crate_types(sess, &krate.attrs);
172 sess.init_crate_types(crate_types);
174 let disambiguator = util::compute_crate_disambiguator(sess);
175 sess.crate_disambiguator.set(disambiguator).expect("not yet initialized");
176 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator);
178 if sess.opts.incremental.is_some() {
179 sess.time("incr_comp_garbage_collect_session_directories", || {
180 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
182 "Error while trying to garbage collect incremental \
183 compilation cache directory: {}",
190 sess.time("recursion_limit", || {
191 middle::limits::update_limits(sess, &krate);
194 let mut lint_store = rustc_lint::new_lint_store(
195 sess.opts.debugging_opts.no_interleave_lints,
196 sess.unstable_options(),
198 register_lints(&sess, &mut lint_store);
201 sess.time("plugin_loading", || plugin::load::load_plugins(sess, metadata_loader, &krate));
202 sess.time("plugin_registration", || {
203 let mut registry = plugin::Registry { lint_store: &mut lint_store };
204 for registrar in registrars {
205 registrar(&mut registry);
209 let lint_store = Lrc::new(lint_store);
210 sess.init_lint_store(lint_store.clone());
212 Ok((krate, lint_store))
215 fn pre_expansion_lint(
217 lint_store: &LintStore,
221 sess.prof.generic_activity_with_arg("pre_AST_expansion_lint_checks", crate_name).run(|| {
222 rustc_lint::check_ast_crate(
228 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
233 fn configure_and_expand_inner<'a>(
235 lint_store: &'a LintStore,
236 mut krate: ast::Crate,
238 resolver_arenas: &'a ResolverArenas<'a>,
239 metadata_loader: &'a MetadataLoaderDyn,
240 ) -> Result<(ast::Crate, Resolver<'a>)> {
241 tracing::trace!("configure_and_expand_inner");
242 pre_expansion_lint(sess, lint_store, &krate, crate_name);
244 let mut resolver = Resolver::new(sess, &krate, crate_name, metadata_loader, &resolver_arenas);
245 rustc_builtin_macros::register_builtin_macros(&mut resolver);
247 krate = sess.time("crate_injection", || {
248 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| Symbol::intern(s));
249 rustc_builtin_macros::standard_library_imports::inject(
257 util::check_attr_crate_type(&sess, &krate.attrs, &mut resolver.lint_buffer());
260 krate = sess.time("macro_expand_crate", || {
261 // Windows dlls do not have rpaths, so they don't know how to find their
262 // dependencies. It's up to us to tell the system where to find all the
263 // dependent dlls. Note that this uses cfg!(windows) as opposed to
264 // targ_cfg because syntax extensions are always loaded for the host
265 // compiler, not for the target.
267 // This is somewhat of an inherently racy operation, however, as
268 // multiple threads calling this function could possibly continue
269 // extending PATH far beyond what it should. To solve this for now we
270 // just don't add any new elements to PATH which are already there
271 // within PATH. This is basically a targeted fix at #17360 for rustdoc
272 // which runs rustc in parallel but has been seen (#33844) to cause
273 // problems with PATH becoming too long.
274 let mut old_path = OsString::new();
276 old_path = env::var_os("PATH").unwrap_or(old_path);
277 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
278 for path in env::split_paths(&old_path) {
279 if !new_path.contains(&path) {
286 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
292 // Create the config for macro expansion
293 let features = sess.features_untracked();
294 let cfg = rustc_expand::expand::ExpansionConfig {
295 features: Some(&features),
296 recursion_limit: sess.recursion_limit(),
297 trace_mac: sess.opts.debugging_opts.trace_macros,
298 should_test: sess.opts.test,
299 span_debug: sess.opts.debugging_opts.span_debug,
300 proc_macro_backtrace: sess.opts.debugging_opts.proc_macro_backtrace,
301 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
304 let extern_mod_loaded = |ident: Ident, attrs, items, span| {
305 let krate = ast::Crate { attrs, items, span, proc_macros: vec![] };
306 pre_expansion_lint(sess, lint_store, &krate, &ident.name.as_str());
307 (krate.attrs, krate.items)
309 let mut ecx = ExtCtxt::new(&sess, cfg, &mut resolver, Some(&extern_mod_loaded));
311 // Expand macros now!
312 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
314 // The rest is error reporting
316 sess.time("check_unused_macros", || {
317 ecx.check_unused_macros();
320 let mut missing_fragment_specifiers: Vec<_> = ecx
323 .missing_fragment_specifiers
326 .map(|(span, node_id)| (*span, *node_id))
328 missing_fragment_specifiers.sort_unstable_by_key(|(span, _)| *span);
330 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
332 for (span, node_id) in missing_fragment_specifiers {
333 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
334 let msg = "missing fragment specifier";
335 resolver.lint_buffer().buffer_lint(lint, node_id, span, msg);
338 env::set_var("PATH", &old_path);
341 if recursion_limit_hit {
342 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
350 sess.time("maybe_building_test_harness", || {
351 rustc_builtin_macros::test_harness::inject(&sess, &mut resolver, &mut krate)
354 if let Some(PpMode::Source(PpSourceMode::EveryBodyLoops)) = sess.opts.pretty {
355 tracing::debug!("replacing bodies with loop {{}}");
356 util::ReplaceBodyWithLoop::new(&mut resolver).visit_crate(&mut krate);
359 let has_proc_macro_decls = sess.time("AST_validation", || {
360 rustc_ast_passes::ast_validation::check_crate(sess, &krate, &mut resolver.lint_buffer())
363 let crate_types = sess.crate_types();
364 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
366 // For backwards compatibility, we don't try to run proc macro injection
367 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
368 // specified. This should only affect users who manually invoke 'rustdoc', as
369 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
370 // However, we do emit a warning, to let such users know that they should
371 // start passing '--crate-type proc-macro'
372 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
373 let mut msg = sess.diagnostic().struct_warn(
374 &"Trying to document proc macro crate \
375 without passing '--crate-type proc-macro to rustdoc",
378 msg.warn("The generated documentation may be incorrect");
381 krate = sess.time("maybe_create_a_macro_crate", || {
382 let num_crate_types = crate_types.len();
383 let is_test_crate = sess.opts.test;
384 rustc_builtin_macros::proc_macro_harness::inject(
389 has_proc_macro_decls,
397 // Done with macro expansion!
399 if sess.opts.debugging_opts.input_stats {
400 eprintln!("Post-expansion node count: {}", count_nodes(&krate));
403 if sess.opts.debugging_opts.hir_stats {
404 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
407 if sess.opts.debugging_opts.ast_json {
408 println!("{}", json::as_json(&krate));
411 resolver.resolve_crate(&krate);
413 // Needs to go *after* expansion to be able to check the results of macro expansion.
414 sess.time("complete_gated_feature_checking", || {
415 rustc_ast_passes::feature_gate::check_crate(&krate, sess);
418 // Add all buffered lints from the `ParseSess` to the `Session`.
419 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
420 info!("{} parse sess buffered_lints", buffered_lints.len());
421 for early_lint in buffered_lints.drain(..) {
422 resolver.lint_buffer().add_early_lint(early_lint);
426 Ok((krate, resolver))
429 pub fn lower_to_hir<'res, 'tcx>(
431 lint_store: &LintStore,
432 resolver: &'res mut Resolver<'_>,
433 dep_graph: &'res DepGraph,
434 krate: &'res ast::Crate,
435 arena: &'tcx rustc_ast_lowering::Arena<'tcx>,
437 // We're constructing the HIR here; we don't care what we will
438 // read, since we haven't even constructed the *input* to
440 dep_graph.assert_ignored();
443 let hir_crate = rustc_ast_lowering::lower_crate(
447 rustc_parse::nt_to_tokenstream,
451 if sess.opts.debugging_opts.hir_stats {
452 hir_stats::print_hir_stats(&hir_crate);
455 sess.time("early_lint_checks", || {
456 rustc_lint::check_ast_crate(
461 Some(std::mem::take(resolver.lint_buffer())),
462 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
466 // Discard hygiene data, which isn't required after lowering to HIR.
467 if !sess.opts.debugging_opts.keep_hygiene_data {
468 rustc_span::hygiene::clear_syntax_context_map();
474 // Returns all the paths that correspond to generated files.
475 fn generated_output_paths(
477 outputs: &OutputFilenames,
481 let mut out_filenames = Vec::new();
482 for output_type in sess.opts.output_types.keys() {
483 let file = outputs.path(*output_type);
485 // If the filename has been overridden using `-o`, it will not be modified
486 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
487 OutputType::Exe if !exact_name => {
488 for crate_type in sess.crate_types().iter() {
489 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
490 out_filenames.push(p);
493 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
494 // Don't add the dep-info output when omitting it from dep-info targets
497 out_filenames.push(file);
504 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
505 // returns None for every file path.
506 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
508 F: Fn(&PathBuf) -> Option<T>,
510 for output_path in output_paths {
511 if let Some(result) = f(output_path) {
518 fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
519 let input_path = input_path.canonicalize().ok();
520 if input_path.is_none() {
523 let check = |output_path: &PathBuf| {
524 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
526 check_output(output_paths, check).is_some()
529 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
530 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
531 check_output(output_paths, check)
534 fn escape_dep_filename(filename: &FileName) -> String {
535 // Apparently clang and gcc *only* escape spaces:
536 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
537 filename.to_string().replace(" ", "\\ ")
540 // Makefile comments only need escaping newlines and `\`.
541 // The result can be unescaped by anything that can unescape `escape_default` and friends.
542 fn escape_dep_env(symbol: Symbol) -> String {
543 let s = symbol.as_str();
544 let mut escaped = String::with_capacity(s.len());
547 '\n' => escaped.push_str(r"\n"),
548 '\r' => escaped.push_str(r"\r"),
549 '\\' => escaped.push_str(r"\\"),
550 _ => escaped.push(c),
558 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
559 outputs: &OutputFilenames,
560 out_filenames: &[PathBuf],
562 // Write out dependency rules to the dep-info file if requested
563 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
566 let deps_filename = outputs.path(OutputType::DepInfo);
568 let result = (|| -> io::Result<()> {
569 // Build a list of files used to compile the output and
570 // write Makefile-compatible dependency rules
571 let mut files: Vec<String> = sess
575 .filter(|fmap| fmap.is_real_file())
576 .filter(|fmap| !fmap.is_imported())
577 .map(|fmap| escape_dep_filename(&fmap.unmapped_path.as_ref().unwrap_or(&fmap.name)))
580 if let Some(ref backend) = sess.opts.debugging_opts.codegen_backend {
581 files.push(backend.to_string());
584 if sess.binary_dep_depinfo() {
585 boxed_resolver.borrow().borrow_mut().access(|resolver| {
586 for cnum in resolver.cstore().crates_untracked() {
587 let source = resolver.cstore().crate_source_untracked(cnum);
588 if let Some((path, _)) = source.dylib {
589 let file_name = FileName::Real(RealFileName::Named(path));
590 files.push(escape_dep_filename(&file_name));
592 if let Some((path, _)) = source.rlib {
593 let file_name = FileName::Real(RealFileName::Named(path));
594 files.push(escape_dep_filename(&file_name));
596 if let Some((path, _)) = source.rmeta {
597 let file_name = FileName::Real(RealFileName::Named(path));
598 files.push(escape_dep_filename(&file_name));
604 let mut file = BufWriter::new(fs::File::create(&deps_filename)?);
605 for path in out_filenames {
606 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
609 // Emit a fake target for each input file to the compilation. This
610 // prevents `make` from spitting out an error if a file is later
611 // deleted. For more info see #28735
613 writeln!(file, "{}:", path)?;
616 // Emit special comments with information about accessed environment variables.
617 let env_depinfo = sess.parse_sess.env_depinfo.borrow();
618 if !env_depinfo.is_empty() {
619 let mut envs: Vec<_> = env_depinfo
621 .map(|(k, v)| (escape_dep_env(*k), v.map(escape_dep_env)))
623 envs.sort_unstable();
626 write!(file, "# env-dep:{}", k)?;
628 write!(file, "={}", v)?;
639 if sess.opts.json_artifact_notifications {
642 .emit_artifact_notification(&deps_filename, "dep-info");
645 Err(e) => sess.fatal(&format!(
646 "error writing dependencies to `{}`: {}",
647 deps_filename.display(),
653 pub fn prepare_outputs(
657 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
659 ) -> Result<OutputFilenames> {
660 let _timer = sess.timer("prepare_outputs");
662 // FIXME: rustdoc passes &[] instead of &krate.attrs here
663 let outputs = util::build_output_filenames(
665 &compiler.output_dir,
666 &compiler.output_file,
672 generated_output_paths(sess, &outputs, compiler.output_file.is_some(), &crate_name);
674 // Ensure the source file isn't accidentally overwritten during compilation.
675 if let Some(ref input_path) = compiler.input_path {
676 if sess.opts.will_create_output_file() {
677 if output_contains_path(&output_paths, input_path) {
679 "the input file \"{}\" would be overwritten by the generated \
683 return Err(ErrorReported);
685 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
687 "the generated executable for the input file \"{}\" conflicts with the \
688 existing directory \"{}\"",
689 input_path.display(),
692 return Err(ErrorReported);
697 write_out_deps(sess, boxed_resolver, &outputs, &output_paths);
699 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
700 && sess.opts.output_types.len() == 1;
703 if let Some(ref dir) = compiler.output_dir {
704 if fs::create_dir_all(dir).is_err() {
705 sess.err("failed to find or create the directory specified by `--out-dir`");
706 return Err(ErrorReported);
714 pub static DEFAULT_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
715 let providers = &mut Providers::default();
716 providers.analysis = analysis;
717 proc_macro_decls::provide(providers);
718 plugin::build::provide(providers);
719 rustc_middle::hir::provide(providers);
720 mir::provide(providers);
721 mir_build::provide(providers);
722 rustc_privacy::provide(providers);
723 typeck::provide(providers);
724 ty::provide(providers);
725 traits::provide(providers);
726 rustc_passes::provide(providers);
727 rustc_resolve::provide(providers);
728 rustc_traits::provide(providers);
729 rustc_ty_utils::provide(providers);
730 rustc_metadata::provide(providers);
731 rustc_lint::provide(providers);
732 rustc_symbol_mangling::provide(providers);
733 rustc_codegen_ssa::provide(providers);
737 pub static DEFAULT_EXTERN_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
738 let mut extern_providers = *DEFAULT_QUERY_PROVIDERS;
739 rustc_metadata::provide_extern(&mut extern_providers);
740 rustc_codegen_ssa::provide_extern(&mut extern_providers);
744 pub struct QueryContext<'tcx> {
745 gcx: &'tcx GlobalCtxt<'tcx>,
748 impl<'tcx> QueryContext<'tcx> {
749 pub fn enter<F, R>(&mut self, f: F) -> R
751 F: FnOnce(TyCtxt<'tcx>) -> R,
753 let icx = ty::tls::ImplicitCtxt::new(self.gcx);
754 ty::tls::enter_context(&icx, |_| f(icx.tcx))
758 pub fn create_global_ctxt<'tcx>(
759 compiler: &'tcx Compiler,
760 lint_store: Lrc<LintStore>,
761 krate: &'tcx Crate<'tcx>,
763 mut resolver_outputs: ResolverOutputs,
764 outputs: OutputFilenames,
766 queries: &'tcx OnceCell<TcxQueries<'tcx>>,
767 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
768 arena: &'tcx WorkerLocal<Arena<'tcx>>,
769 ) -> QueryContext<'tcx> {
770 let sess = &compiler.session();
771 let defs: &'tcx Definitions = arena.alloc(mem::replace(
772 &mut resolver_outputs.definitions,
773 Definitions::new(crate_name, sess.local_crate_disambiguator()),
776 let query_result_on_disk_cache = rustc_incremental::load_query_result_cache(sess, defs);
778 let codegen_backend = compiler.codegen_backend();
779 let mut local_providers = *DEFAULT_QUERY_PROVIDERS;
780 codegen_backend.provide(&mut local_providers);
782 let mut extern_providers = *DEFAULT_EXTERN_QUERY_PROVIDERS;
783 codegen_backend.provide(&mut extern_providers);
784 codegen_backend.provide_extern(&mut extern_providers);
786 if let Some(callback) = compiler.override_queries {
787 callback(sess, &mut local_providers, &mut extern_providers);
790 let queries = queries.get_or_init(|| TcxQueries::new(local_providers, extern_providers));
792 let gcx = sess.time("setup_global_ctxt", || {
793 global_ctxt.get_or_init(|| {
794 TyCtxt::create_global_ctxt(
802 query_result_on_disk_cache,
813 /// Runs the resolution, type-checking, region checking and other
814 /// miscellaneous analysis passes on the crate.
815 fn analysis(tcx: TyCtxt<'_>, cnum: CrateNum) -> Result<()> {
816 assert_eq!(cnum, LOCAL_CRATE);
818 rustc_passes::hir_id_validator::check_crate(tcx);
821 let mut entry_point = None;
823 sess.time("misc_checking_1", || {
827 .time("looking_for_entry_point", || rustc_passes::entry::find_entry_point(tcx));
829 sess.time("looking_for_plugin_registrar", || {
830 plugin::build::find_plugin_registrar(tcx)
833 sess.time("looking_for_derive_registrar", || proc_macro_decls::find(tcx));
836 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
837 tcx.ensure().check_mod_loops(module);
838 tcx.ensure().check_mod_attrs(module);
839 tcx.ensure().check_mod_naked_functions(module);
840 tcx.ensure().check_mod_unstable_api_usage(module);
841 tcx.ensure().check_mod_const_bodies(module);
847 // passes are timed inside typeck
848 typeck::check_crate(tcx)?;
850 sess.time("misc_checking_2", || {
853 sess.time("match_checking", || {
854 tcx.par_body_owners(|def_id| {
855 tcx.ensure().check_match(def_id.to_def_id());
860 sess.time("liveness_and_intrinsic_checking", || {
861 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
862 // this must run before MIR dump, because
863 // "not all control paths return a value" is reported here.
865 // maybe move the check to a MIR pass?
866 tcx.ensure().check_mod_liveness(module);
867 tcx.ensure().check_mod_intrinsics(module);
874 sess.time("MIR_borrow_checking", || {
875 tcx.par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
878 sess.time("MIR_effect_checking", || {
879 for def_id in tcx.body_owners() {
880 mir::transform::check_unsafety::check_unsafety(tcx, def_id);
882 if tcx.hir().body_const_context(def_id).is_some() {
884 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::unknown(def_id));
889 sess.time("layout_testing", || layout_test::test_layout(tcx));
891 // Avoid overwhelming user with errors if borrow checking failed.
892 // I'm not sure how helpful this is, to be honest, but it avoids a
893 // lot of annoying errors in the ui tests (basically,
894 // lint warnings and so on -- kindck used to do this abort, but
895 // kindck is gone now). -nmatsakis
896 if sess.has_errors() {
897 return Err(ErrorReported);
900 sess.time("misc_checking_3", || {
903 tcx.ensure().privacy_access_levels(LOCAL_CRATE);
907 tcx.ensure().check_private_in_public(LOCAL_CRATE);
910 sess.time("death_checking", || rustc_passes::dead::check_crate(tcx));
913 sess.time("unused_lib_feature_checking", || {
914 rustc_passes::stability::check_unused_or_stable_features(tcx)
918 sess.time("lint_checking", || {
919 rustc_lint::check_crate(tcx, || {
920 rustc_lint::BuiltinCombinedLateLintPass::new()
927 sess.time("privacy_checking_modules", || {
928 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
929 tcx.ensure().check_mod_privacy(module);
939 fn encode_and_write_metadata(
941 outputs: &OutputFilenames,
942 ) -> (middle::cstore::EncodedMetadata, bool) {
943 #[derive(PartialEq, Eq, PartialOrd, Ord)]
950 let metadata_kind = tcx
954 .map(|ty| match *ty {
955 CrateType::Executable | CrateType::Staticlib | CrateType::Cdylib => MetadataKind::None,
957 CrateType::Rlib => MetadataKind::Uncompressed,
959 CrateType::Dylib | CrateType::ProcMacro => MetadataKind::Compressed,
962 .unwrap_or(MetadataKind::None);
964 let metadata = match metadata_kind {
965 MetadataKind::None => middle::cstore::EncodedMetadata::new(),
966 MetadataKind::Uncompressed | MetadataKind::Compressed => tcx.encode_metadata(),
969 let _prof_timer = tcx.sess.prof.generic_activity("write_crate_metadata");
971 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
972 if need_metadata_file {
973 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
974 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
975 // To avoid races with another rustc process scanning the output directory,
976 // we need to write the file somewhere else and atomically move it to its
977 // final destination, with an `fs::rename` call. In order for the rename to
978 // always succeed, the temporary file needs to be on the same filesystem,
979 // which is why we create it inside the output directory specifically.
980 let metadata_tmpdir = TempFileBuilder::new()
982 .tempdir_in(out_filename.parent().unwrap())
983 .unwrap_or_else(|err| tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err)));
984 let metadata_tmpdir = MaybeTempDir::new(metadata_tmpdir, tcx.sess.opts.cg.save_temps);
985 let metadata_filename = emit_metadata(tcx.sess, &metadata, &metadata_tmpdir);
986 if let Err(e) = util::non_durable_rename(&metadata_filename, &out_filename) {
987 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
989 if tcx.sess.opts.json_artifact_notifications {
993 .emit_artifact_notification(&out_filename, "metadata");
997 let need_metadata_module = metadata_kind == MetadataKind::Compressed;
999 (metadata, need_metadata_module)
1002 /// Runs the codegen backend, after which the AST and analysis can
1004 pub fn start_codegen<'tcx>(
1005 codegen_backend: &dyn CodegenBackend,
1007 outputs: &OutputFilenames,
1009 info!("Pre-codegen\n{:?}", tcx.debug_stats());
1011 let (metadata, need_metadata_module) = encode_and_write_metadata(tcx, outputs);
1013 let codegen = tcx.sess.time("codegen_crate", move || {
1014 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1017 // Don't run these test assertions when not doing codegen. Compiletest tries to build
1018 // build-fail tests in check mode first and expects it to not give an error in that case.
1019 if tcx.sess.opts.output_types.should_codegen() {
1020 rustc_incremental::assert_module_sources::assert_module_sources(tcx);
1021 rustc_symbol_mangling::test::report_symbol_names(tcx);
1024 tcx.sess.time("assert_dep_graph", || rustc_incremental::assert_dep_graph(tcx));
1025 tcx.sess.time("serialize_dep_graph", || rustc_incremental::save_dep_graph(tcx));
1027 info!("Post-codegen\n{:?}", tcx.debug_stats());
1029 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1030 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, outputs) {
1031 tcx.sess.err(&format!("could not emit MIR: {}", e));
1032 tcx.sess.abort_if_errors();