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_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_span::{FileName, RealFileName};
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, mem};
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 println!("Lines of code: {}", sess.source_map().count_lines());
68 println!("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 declare_box_region_type!(
91 (&mut Resolver<'_>) -> (Result<ast::Crate>, ResolverOutputs)
94 /// Runs the "early phases" of the compiler: initial `cfg` processing, loading compiler plugins,
95 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
96 /// harness if one is to be provided, injection of a dependency on the
97 /// standard library and prelude, and name resolution.
99 /// Returns [`None`] if we're aborting after handling -W help.
100 pub fn configure_and_expand(
102 lint_store: Lrc<LintStore>,
103 metadata_loader: Box<MetadataLoaderDyn>,
106 ) -> Result<(ast::Crate, BoxedResolver)> {
107 tracing::trace!("configure_and_expand");
108 // Currently, we ignore the name resolution data structures for the purposes of dependency
109 // tracking. Instead we will run name resolution and include its output in the hash of each
110 // item, much like we do for macro expansion. In other words, the hash reflects not just
111 // its contents but the results of name resolution on those contents. Hopefully we'll push
112 // this back at some point.
113 let crate_name = crate_name.to_string();
114 let (result, resolver) = BoxedResolver::new(static move |mut action| {
117 let resolver_arenas = Resolver::arenas();
118 let res = configure_and_expand_inner(
126 let mut resolver = match res {
128 yield BoxedResolver::initial_yield(Err(v));
131 Ok((krate, resolver)) => {
132 action = yield BoxedResolver::initial_yield(Ok(krate));
136 box_region_allow_access!(for(), (&mut Resolver<'_>), (&mut resolver), action);
137 resolver.into_outputs()
139 result.map(|k| (k, resolver))
143 pub fn to_resolver_outputs(resolver: Rc<RefCell<BoxedResolver>>) -> ResolverOutputs {
144 match Rc::try_unwrap(resolver) {
145 Ok(resolver) => resolver.into_inner().complete(),
146 Err(resolver) => resolver.borrow_mut().access(|resolver| resolver.clone_outputs()),
151 pub fn register_plugins<'a>(
153 metadata_loader: &'a dyn MetadataLoader,
154 register_lints: impl Fn(&Session, &mut LintStore),
155 mut krate: ast::Crate,
157 ) -> Result<(ast::Crate, Lrc<LintStore>)> {
158 krate = sess.time("attributes_injection", || {
159 rustc_builtin_macros::cmdline_attrs::inject(
162 &sess.opts.debugging_opts.crate_attr,
166 let (krate, features) = rustc_expand::config::features(sess, krate);
167 // these need to be set "early" so that expansion sees `quote` if enabled.
168 sess.init_features(features);
170 let crate_types = util::collect_crate_types(sess, &krate.attrs);
171 sess.init_crate_types(crate_types);
173 let disambiguator = util::compute_crate_disambiguator(sess);
174 sess.crate_disambiguator.set(disambiguator).expect("not yet initialized");
175 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator);
177 if sess.opts.incremental.is_some() {
178 sess.time("incr_comp_garbage_collect_session_directories", || {
179 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
181 "Error while trying to garbage collect incremental \
182 compilation cache directory: {}",
189 sess.time("recursion_limit", || {
190 middle::limits::update_limits(sess, &krate);
193 let mut lint_store = rustc_lint::new_lint_store(
194 sess.opts.debugging_opts.no_interleave_lints,
195 sess.unstable_options(),
197 register_lints(&sess, &mut lint_store);
200 sess.time("plugin_loading", || plugin::load::load_plugins(sess, metadata_loader, &krate));
201 sess.time("plugin_registration", || {
202 let mut registry = plugin::Registry { lint_store: &mut lint_store };
203 for registrar in registrars {
204 registrar(&mut registry);
208 let lint_store = Lrc::new(lint_store);
209 sess.init_lint_store(lint_store.clone());
211 Ok((krate, lint_store))
214 fn pre_expansion_lint(
216 lint_store: &LintStore,
220 sess.prof.generic_activity_with_arg("pre_AST_expansion_lint_checks", crate_name).run(|| {
221 rustc_lint::check_ast_crate(
227 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
232 fn configure_and_expand_inner<'a>(
234 lint_store: &'a LintStore,
235 mut krate: ast::Crate,
237 resolver_arenas: &'a ResolverArenas<'a>,
238 metadata_loader: &'a MetadataLoaderDyn,
239 ) -> Result<(ast::Crate, Resolver<'a>)> {
240 tracing::trace!("configure_and_expand_inner");
241 pre_expansion_lint(sess, lint_store, &krate, crate_name);
243 let mut resolver = Resolver::new(sess, &krate, crate_name, metadata_loader, &resolver_arenas);
244 rustc_builtin_macros::register_builtin_macros(&mut resolver);
246 krate = sess.time("crate_injection", || {
247 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| Symbol::intern(s));
248 rustc_builtin_macros::standard_library_imports::inject(
256 util::check_attr_crate_type(&sess, &krate.attrs, &mut resolver.lint_buffer());
259 krate = sess.time("macro_expand_crate", || {
260 // Windows dlls do not have rpaths, so they don't know how to find their
261 // dependencies. It's up to us to tell the system where to find all the
262 // dependent dlls. Note that this uses cfg!(windows) as opposed to
263 // targ_cfg because syntax extensions are always loaded for the host
264 // compiler, not for the target.
266 // This is somewhat of an inherently racy operation, however, as
267 // multiple threads calling this function could possibly continue
268 // extending PATH far beyond what it should. To solve this for now we
269 // just don't add any new elements to PATH which are already there
270 // within PATH. This is basically a targeted fix at #17360 for rustdoc
271 // which runs rustc in parallel but has been seen (#33844) to cause
272 // problems with PATH becoming too long.
273 let mut old_path = OsString::new();
275 old_path = env::var_os("PATH").unwrap_or(old_path);
276 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
277 for path in env::split_paths(&old_path) {
278 if !new_path.contains(&path) {
285 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
291 // Create the config for macro expansion
292 let features = sess.features_untracked();
293 let cfg = rustc_expand::expand::ExpansionConfig {
294 features: Some(&features),
295 recursion_limit: sess.recursion_limit(),
296 trace_mac: sess.opts.debugging_opts.trace_macros,
297 should_test: sess.opts.test,
298 span_debug: sess.opts.debugging_opts.span_debug,
299 proc_macro_backtrace: sess.opts.debugging_opts.proc_macro_backtrace,
300 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
303 let extern_mod_loaded = |k: &ast::Crate, ident: Ident| {
304 pre_expansion_lint(sess, lint_store, k, &*ident.name.as_str())
306 let mut ecx = ExtCtxt::new(&sess, cfg, &mut resolver, Some(&extern_mod_loaded));
308 // Expand macros now!
309 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
311 // The rest is error reporting
313 sess.time("check_unused_macros", || {
314 ecx.check_unused_macros();
317 let mut missing_fragment_specifiers: Vec<_> = ecx
320 .missing_fragment_specifiers
323 .map(|(span, node_id)| (*span, *node_id))
325 missing_fragment_specifiers.sort_unstable_by_key(|(span, _)| *span);
327 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
329 for (span, node_id) in missing_fragment_specifiers {
330 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
331 let msg = "missing fragment specifier";
332 resolver.lint_buffer().buffer_lint(lint, node_id, span, msg);
335 env::set_var("PATH", &old_path);
338 if recursion_limit_hit {
339 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
347 sess.time("maybe_building_test_harness", || {
348 rustc_builtin_macros::test_harness::inject(&sess, &mut resolver, &mut krate)
351 if let Some(PpMode::PpmSource(PpSourceMode::PpmEveryBodyLoops)) = sess.opts.pretty {
352 tracing::debug!("replacing bodies with loop {{}}");
353 util::ReplaceBodyWithLoop::new(&mut resolver).visit_crate(&mut krate);
356 let has_proc_macro_decls = sess.time("AST_validation", || {
357 rustc_ast_passes::ast_validation::check_crate(sess, &krate, &mut resolver.lint_buffer())
360 let crate_types = sess.crate_types();
361 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
363 // For backwards compatibility, we don't try to run proc macro injection
364 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
365 // specified. This should only affect users who manually invoke 'rustdoc', as
366 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
367 // However, we do emit a warning, to let such users know that they should
368 // start passing '--crate-type proc-macro'
369 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
370 let mut msg = sess.diagnostic().struct_warn(
371 &"Trying to document proc macro crate \
372 without passing '--crate-type proc-macro to rustdoc",
375 msg.warn("The generated documentation may be incorrect");
378 krate = sess.time("maybe_create_a_macro_crate", || {
379 let num_crate_types = crate_types.len();
380 let is_test_crate = sess.opts.test;
381 rustc_builtin_macros::proc_macro_harness::inject(
386 has_proc_macro_decls,
394 // Done with macro expansion!
396 if sess.opts.debugging_opts.input_stats {
397 println!("Post-expansion node count: {}", count_nodes(&krate));
400 if sess.opts.debugging_opts.hir_stats {
401 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
404 if sess.opts.debugging_opts.ast_json {
405 println!("{}", json::as_json(&krate));
408 resolver.resolve_crate(&krate);
410 // Needs to go *after* expansion to be able to check the results of macro expansion.
411 sess.time("complete_gated_feature_checking", || {
412 rustc_ast_passes::feature_gate::check_crate(&krate, sess);
415 // Add all buffered lints from the `ParseSess` to the `Session`.
416 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
417 info!("{} parse sess buffered_lints", buffered_lints.len());
418 for early_lint in buffered_lints.drain(..) {
419 resolver.lint_buffer().add_early_lint(early_lint);
423 Ok((krate, resolver))
426 pub fn lower_to_hir<'res, 'tcx>(
428 lint_store: &LintStore,
429 resolver: &'res mut Resolver<'_>,
430 dep_graph: &'res DepGraph,
431 krate: &'res ast::Crate,
432 arena: &'tcx rustc_ast_lowering::Arena<'tcx>,
434 // We're constructing the HIR here; we don't care what we will
435 // read, since we haven't even constructed the *input* to
437 dep_graph.assert_ignored();
440 let hir_crate = rustc_ast_lowering::lower_crate(
444 rustc_parse::nt_to_tokenstream,
448 if sess.opts.debugging_opts.hir_stats {
449 hir_stats::print_hir_stats(&hir_crate);
452 sess.time("early_lint_checks", || {
453 rustc_lint::check_ast_crate(
458 Some(std::mem::take(resolver.lint_buffer())),
459 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
463 // Discard hygiene data, which isn't required after lowering to HIR.
464 if !sess.opts.debugging_opts.keep_hygiene_data {
465 rustc_span::hygiene::clear_syntax_context_map();
471 // Returns all the paths that correspond to generated files.
472 fn generated_output_paths(
474 outputs: &OutputFilenames,
478 let mut out_filenames = Vec::new();
479 for output_type in sess.opts.output_types.keys() {
480 let file = outputs.path(*output_type);
482 // If the filename has been overridden using `-o`, it will not be modified
483 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
484 OutputType::Exe if !exact_name => {
485 for crate_type in sess.crate_types().iter() {
486 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
487 out_filenames.push(p);
490 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
491 // Don't add the dep-info output when omitting it from dep-info targets
494 out_filenames.push(file);
501 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
502 // returns None for every file path.
503 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
505 F: Fn(&PathBuf) -> Option<T>,
507 for output_path in output_paths {
508 if let Some(result) = f(output_path) {
515 fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
516 let input_path = input_path.canonicalize().ok();
517 if input_path.is_none() {
520 let check = |output_path: &PathBuf| {
521 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
523 check_output(output_paths, check).is_some()
526 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
527 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
528 check_output(output_paths, check)
531 fn escape_dep_filename(filename: &FileName) -> String {
532 // Apparently clang and gcc *only* escape spaces:
533 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
534 filename.to_string().replace(" ", "\\ ")
537 // Makefile comments only need escaping newlines and `\`.
538 // The result can be unescaped by anything that can unescape `escape_default` and friends.
539 fn escape_dep_env(symbol: Symbol) -> String {
540 let s = symbol.as_str();
541 let mut escaped = String::with_capacity(s.len());
544 '\n' => escaped.push_str(r"\n"),
545 '\r' => escaped.push_str(r"\r"),
546 '\\' => escaped.push_str(r"\\"),
547 _ => escaped.push(c),
555 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
556 outputs: &OutputFilenames,
557 out_filenames: &[PathBuf],
559 // Write out dependency rules to the dep-info file if requested
560 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
563 let deps_filename = outputs.path(OutputType::DepInfo);
565 let result = (|| -> io::Result<()> {
566 // Build a list of files used to compile the output and
567 // write Makefile-compatible dependency rules
568 let mut files: Vec<String> = sess
572 .filter(|fmap| fmap.is_real_file())
573 .filter(|fmap| !fmap.is_imported())
574 .map(|fmap| escape_dep_filename(&fmap.unmapped_path.as_ref().unwrap_or(&fmap.name)))
577 if let Some(ref backend) = sess.opts.debugging_opts.codegen_backend {
578 files.push(backend.to_string());
581 if sess.binary_dep_depinfo() {
582 boxed_resolver.borrow().borrow_mut().access(|resolver| {
583 for cnum in resolver.cstore().crates_untracked() {
584 let source = resolver.cstore().crate_source_untracked(cnum);
585 if let Some((path, _)) = source.dylib {
586 let file_name = FileName::Real(RealFileName::Named(path));
587 files.push(escape_dep_filename(&file_name));
589 if let Some((path, _)) = source.rlib {
590 let file_name = FileName::Real(RealFileName::Named(path));
591 files.push(escape_dep_filename(&file_name));
593 if let Some((path, _)) = source.rmeta {
594 let file_name = FileName::Real(RealFileName::Named(path));
595 files.push(escape_dep_filename(&file_name));
601 let mut file = BufWriter::new(fs::File::create(&deps_filename)?);
602 for path in out_filenames {
603 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
606 // Emit a fake target for each input file to the compilation. This
607 // prevents `make` from spitting out an error if a file is later
608 // deleted. For more info see #28735
610 writeln!(file, "{}:", path)?;
613 // Emit special comments with information about accessed environment variables.
614 let env_depinfo = sess.parse_sess.env_depinfo.borrow();
615 if !env_depinfo.is_empty() {
616 let mut envs: Vec<_> = env_depinfo
618 .map(|(k, v)| (escape_dep_env(*k), v.map(escape_dep_env)))
620 envs.sort_unstable();
623 write!(file, "# env-dep:{}", k)?;
625 write!(file, "={}", v)?;
636 if sess.opts.json_artifact_notifications {
639 .emit_artifact_notification(&deps_filename, "dep-info");
642 Err(e) => sess.fatal(&format!(
643 "error writing dependencies to `{}`: {}",
644 deps_filename.display(),
650 pub fn prepare_outputs(
654 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
656 ) -> Result<OutputFilenames> {
657 let _timer = sess.timer("prepare_outputs");
659 // FIXME: rustdoc passes &[] instead of &krate.attrs here
660 let outputs = util::build_output_filenames(
662 &compiler.output_dir,
663 &compiler.output_file,
669 generated_output_paths(sess, &outputs, compiler.output_file.is_some(), &crate_name);
671 // Ensure the source file isn't accidentally overwritten during compilation.
672 if let Some(ref input_path) = compiler.input_path {
673 if sess.opts.will_create_output_file() {
674 if output_contains_path(&output_paths, input_path) {
676 "the input file \"{}\" would be overwritten by the generated \
680 return Err(ErrorReported);
682 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
684 "the generated executable for the input file \"{}\" conflicts with the \
685 existing directory \"{}\"",
686 input_path.display(),
689 return Err(ErrorReported);
694 write_out_deps(sess, boxed_resolver, &outputs, &output_paths);
696 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
697 && sess.opts.output_types.len() == 1;
700 if let Some(ref dir) = compiler.output_dir {
701 if fs::create_dir_all(dir).is_err() {
702 sess.err("failed to find or create the directory specified by `--out-dir`");
703 return Err(ErrorReported);
711 pub static DEFAULT_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
712 let providers = &mut Providers::default();
713 providers.analysis = analysis;
714 proc_macro_decls::provide(providers);
715 plugin::build::provide(providers);
716 rustc_middle::hir::provide(providers);
717 mir::provide(providers);
718 mir_build::provide(providers);
719 rustc_privacy::provide(providers);
720 typeck::provide(providers);
721 ty::provide(providers);
722 traits::provide(providers);
723 rustc_passes::provide(providers);
724 rustc_resolve::provide(providers);
725 rustc_traits::provide(providers);
726 rustc_ty_utils::provide(providers);
727 rustc_metadata::provide(providers);
728 rustc_lint::provide(providers);
729 rustc_symbol_mangling::provide(providers);
730 rustc_codegen_ssa::provide(providers);
734 pub static DEFAULT_EXTERN_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
735 let mut extern_providers = *DEFAULT_QUERY_PROVIDERS;
736 rustc_metadata::provide_extern(&mut extern_providers);
737 rustc_codegen_ssa::provide_extern(&mut extern_providers);
741 pub struct QueryContext<'tcx>(&'tcx GlobalCtxt<'tcx>);
743 impl<'tcx> QueryContext<'tcx> {
744 pub fn enter<F, R>(&mut self, f: F) -> R
746 F: FnOnce(TyCtxt<'tcx>) -> R,
748 let icx = ty::tls::ImplicitCtxt::new(self.0);
749 ty::tls::enter_context(&icx, |_| f(icx.tcx))
752 pub fn print_stats(&mut self) {
753 self.enter(ty::query::print_stats)
757 pub fn create_global_ctxt<'tcx>(
758 compiler: &'tcx Compiler,
759 lint_store: Lrc<LintStore>,
760 krate: &'tcx Crate<'tcx>,
762 mut resolver_outputs: ResolverOutputs,
763 outputs: OutputFilenames,
765 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
766 arena: &'tcx WorkerLocal<Arena<'tcx>>,
767 ) -> QueryContext<'tcx> {
768 let sess = &compiler.session();
769 let defs: &'tcx Definitions = arena.alloc(mem::replace(
770 &mut resolver_outputs.definitions,
771 Definitions::new(crate_name, sess.local_crate_disambiguator()),
774 let query_result_on_disk_cache = rustc_incremental::load_query_result_cache(sess, defs);
776 let codegen_backend = compiler.codegen_backend();
777 let mut local_providers = *DEFAULT_QUERY_PROVIDERS;
778 codegen_backend.provide(&mut local_providers);
780 let mut extern_providers = *DEFAULT_EXTERN_QUERY_PROVIDERS;
781 codegen_backend.provide(&mut extern_providers);
782 codegen_backend.provide_extern(&mut extern_providers);
784 if let Some(callback) = compiler.override_queries {
785 callback(sess, &mut local_providers, &mut extern_providers);
788 let gcx = sess.time("setup_global_ctxt", || {
789 global_ctxt.get_or_init(|| {
790 TyCtxt::create_global_ctxt(
800 query_result_on_disk_cache,
810 /// Runs the resolution, type-checking, region checking and other
811 /// miscellaneous analysis passes on the crate.
812 fn analysis(tcx: TyCtxt<'_>, cnum: CrateNum) -> Result<()> {
813 assert_eq!(cnum, LOCAL_CRATE);
815 rustc_passes::hir_id_validator::check_crate(tcx);
818 let mut entry_point = None;
820 sess.time("misc_checking_1", || {
824 .time("looking_for_entry_point", || rustc_passes::entry::find_entry_point(tcx));
826 sess.time("looking_for_plugin_registrar", || {
827 plugin::build::find_plugin_registrar(tcx)
830 sess.time("looking_for_derive_registrar", || proc_macro_decls::find(tcx));
833 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
834 tcx.ensure().check_mod_loops(module);
835 tcx.ensure().check_mod_attrs(module);
836 tcx.ensure().check_mod_naked_functions(module);
837 tcx.ensure().check_mod_unstable_api_usage(module);
838 tcx.ensure().check_mod_const_bodies(module);
844 // passes are timed inside typeck
845 typeck::check_crate(tcx)?;
847 sess.time("misc_checking_2", || {
850 sess.time("match_checking", || {
851 tcx.par_body_owners(|def_id| {
852 tcx.ensure().check_match(def_id.to_def_id());
857 sess.time("liveness_and_intrinsic_checking", || {
858 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
859 // this must run before MIR dump, because
860 // "not all control paths return a value" is reported here.
862 // maybe move the check to a MIR pass?
863 tcx.ensure().check_mod_liveness(module);
864 tcx.ensure().check_mod_intrinsics(module);
871 sess.time("MIR_borrow_checking", || {
872 tcx.par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
875 sess.time("MIR_effect_checking", || {
876 for def_id in tcx.body_owners() {
877 mir::transform::check_unsafety::check_unsafety(tcx, def_id);
879 if tcx.hir().body_const_context(def_id).is_some() {
881 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::unknown(def_id));
886 sess.time("layout_testing", || layout_test::test_layout(tcx));
888 // Avoid overwhelming user with errors if borrow checking failed.
889 // I'm not sure how helpful this is, to be honest, but it avoids a
890 // lot of annoying errors in the ui tests (basically,
891 // lint warnings and so on -- kindck used to do this abort, but
892 // kindck is gone now). -nmatsakis
893 if sess.has_errors() {
894 return Err(ErrorReported);
897 sess.time("misc_checking_3", || {
900 tcx.ensure().privacy_access_levels(LOCAL_CRATE);
904 tcx.ensure().check_private_in_public(LOCAL_CRATE);
907 sess.time("death_checking", || rustc_passes::dead::check_crate(tcx));
910 sess.time("unused_lib_feature_checking", || {
911 rustc_passes::stability::check_unused_or_stable_features(tcx)
915 sess.time("lint_checking", || {
916 rustc_lint::check_crate(tcx, || {
917 rustc_lint::BuiltinCombinedLateLintPass::new()
924 sess.time("privacy_checking_modules", || {
925 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
926 tcx.ensure().check_mod_privacy(module);
936 fn encode_and_write_metadata(
938 outputs: &OutputFilenames,
939 ) -> (middle::cstore::EncodedMetadata, bool) {
940 #[derive(PartialEq, Eq, PartialOrd, Ord)]
947 let metadata_kind = tcx
951 .map(|ty| match *ty {
952 CrateType::Executable | CrateType::Staticlib | CrateType::Cdylib => MetadataKind::None,
954 CrateType::Rlib => MetadataKind::Uncompressed,
956 CrateType::Dylib | CrateType::ProcMacro => MetadataKind::Compressed,
959 .unwrap_or(MetadataKind::None);
961 let metadata = match metadata_kind {
962 MetadataKind::None => middle::cstore::EncodedMetadata::new(),
963 MetadataKind::Uncompressed | MetadataKind::Compressed => tcx.encode_metadata(),
966 let _prof_timer = tcx.sess.prof.generic_activity("write_crate_metadata");
968 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
969 if need_metadata_file {
970 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
971 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
972 // To avoid races with another rustc process scanning the output directory,
973 // we need to write the file somewhere else and atomically move it to its
974 // final destination, with an `fs::rename` call. In order for the rename to
975 // always succeed, the temporary file needs to be on the same filesystem,
976 // which is why we create it inside the output directory specifically.
977 let metadata_tmpdir = TempFileBuilder::new()
979 .tempdir_in(out_filename.parent().unwrap())
980 .unwrap_or_else(|err| tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err)));
981 let metadata_tmpdir = MaybeTempDir::new(metadata_tmpdir, tcx.sess.opts.cg.save_temps);
982 let metadata_filename = emit_metadata(tcx.sess, &metadata, &metadata_tmpdir);
983 if let Err(e) = fs::rename(&metadata_filename, &out_filename) {
984 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
986 if tcx.sess.opts.json_artifact_notifications {
990 .emit_artifact_notification(&out_filename, "metadata");
994 let need_metadata_module = metadata_kind == MetadataKind::Compressed;
996 (metadata, need_metadata_module)
999 /// Runs the codegen backend, after which the AST and analysis can
1001 pub fn start_codegen<'tcx>(
1002 codegen_backend: &dyn CodegenBackend,
1004 outputs: &OutputFilenames,
1006 info!("Pre-codegen\n{:?}", tcx.debug_stats());
1008 let (metadata, need_metadata_module) = encode_and_write_metadata(tcx, outputs);
1010 let codegen = tcx.sess.time("codegen_crate", move || {
1011 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1014 // Don't run these test assertions when not doing codegen. Compiletest tries to build
1015 // build-fail tests in check mode first and expects it to not give an error in that case.
1016 if tcx.sess.opts.output_types.should_codegen() {
1017 rustc_incremental::assert_module_sources::assert_module_sources(tcx);
1018 rustc_symbol_mangling::test::report_symbol_names(tcx);
1021 tcx.sess.time("assert_dep_graph", || rustc_incremental::assert_dep_graph(tcx));
1022 tcx.sess.time("serialize_dep_graph", || rustc_incremental::save_dep_graph(tcx));
1024 info!("Post-codegen\n{:?}", tcx.debug_stats());
1026 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1027 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, outputs) {
1028 tcx.sess.err(&format!("could not emit MIR: {}", e));
1029 tcx.sess.abort_if_errors();