1 use crate::interface::{Compiler, Result};
2 use crate::proc_macro_decls;
6 use once_cell::sync::Lazy;
7 use rustc_ast::mut_visit::MutVisitor;
8 use rustc_ast::{self, ast, visit};
9 use rustc_codegen_ssa::back::link::emit_metadata;
10 use rustc_codegen_ssa::traits::CodegenBackend;
11 use rustc_data_structures::sync::{par_iter, Lrc, OnceCell, ParallelIterator, WorkerLocal};
12 use rustc_data_structures::temp_dir::MaybeTempDir;
13 use rustc_data_structures::{box_region_allow_access, declare_box_region_type, parallel};
14 use rustc_errors::{ErrorReported, PResult};
15 use rustc_expand::base::ExtCtxt;
16 use rustc_hir::def_id::{CrateNum, LOCAL_CRATE};
17 use rustc_hir::definitions::Definitions;
19 use rustc_lint::LintStore;
20 use rustc_middle::arena::Arena;
21 use rustc_middle::dep_graph::DepGraph;
22 use rustc_middle::middle;
23 use rustc_middle::middle::cstore::{CrateStore, MetadataLoader, MetadataLoaderDyn};
24 use rustc_middle::ty::query::Providers;
25 use rustc_middle::ty::steal::Steal;
26 use rustc_middle::ty::{self, GlobalCtxt, ResolverOutputs, TyCtxt};
28 use rustc_mir_build as mir_build;
29 use rustc_parse::{parse_crate_from_file, parse_crate_from_source_str};
30 use rustc_passes::{self, hir_stats, layout_test};
31 use rustc_plugin_impl as plugin;
32 use rustc_resolve::{Resolver, ResolverArenas};
33 use rustc_session::config::{CrateType, Input, OutputFilenames, OutputType, PpMode, PpSourceMode};
34 use rustc_session::lint;
35 use rustc_session::output::{filename_for_input, filename_for_metadata};
36 use rustc_session::search_paths::PathKind;
37 use rustc_session::Session;
38 use rustc_span::symbol::Symbol;
39 use rustc_span::{FileName, RealFileName};
40 use rustc_trait_selection::traits;
41 use rustc_typeck as typeck;
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::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 log::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 Ok((krate, Lrc::new(lint_store)))
211 fn pre_expansion_lint(sess: &Session, lint_store: &LintStore, krate: &ast::Crate) {
212 sess.time("pre_AST_expansion_lint_checks", || {
213 rustc_lint::check_ast_crate(
219 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
224 fn configure_and_expand_inner<'a>(
226 lint_store: &'a LintStore,
227 mut krate: ast::Crate,
229 resolver_arenas: &'a ResolverArenas<'a>,
230 metadata_loader: &'a MetadataLoaderDyn,
231 ) -> Result<(ast::Crate, Resolver<'a>)> {
232 log::trace!("configure_and_expand_inner");
233 pre_expansion_lint(sess, lint_store, &krate);
235 let mut resolver = Resolver::new(sess, &krate, crate_name, metadata_loader, &resolver_arenas);
236 rustc_builtin_macros::register_builtin_macros(&mut resolver, sess.edition());
238 krate = sess.time("crate_injection", || {
239 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| Symbol::intern(s));
240 let (krate, name) = rustc_builtin_macros::standard_library_imports::inject(
246 if let Some(name) = name {
247 sess.parse_sess.injected_crate_name.set(name).expect("not yet initialized");
252 util::check_attr_crate_type(&sess, &krate.attrs, &mut resolver.lint_buffer());
255 krate = sess.time("macro_expand_crate", || {
256 // Windows dlls do not have rpaths, so they don't know how to find their
257 // dependencies. It's up to us to tell the system where to find all the
258 // dependent dlls. Note that this uses cfg!(windows) as opposed to
259 // targ_cfg because syntax extensions are always loaded for the host
260 // compiler, not for the target.
262 // This is somewhat of an inherently racy operation, however, as
263 // multiple threads calling this function could possibly continue
264 // extending PATH far beyond what it should. To solve this for now we
265 // just don't add any new elements to PATH which are already there
266 // within PATH. This is basically a targeted fix at #17360 for rustdoc
267 // which runs rustc in parallel but has been seen (#33844) to cause
268 // problems with PATH becoming too long.
269 let mut old_path = OsString::new();
271 old_path = env::var_os("PATH").unwrap_or(old_path);
272 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
273 for path in env::split_paths(&old_path) {
274 if !new_path.contains(&path) {
281 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
287 // Create the config for macro expansion
288 let features = sess.features_untracked();
289 let cfg = rustc_expand::expand::ExpansionConfig {
290 features: Some(&features),
291 recursion_limit: sess.recursion_limit(),
292 trace_mac: sess.opts.debugging_opts.trace_macros,
293 should_test: sess.opts.test,
294 span_debug: sess.opts.debugging_opts.span_debug,
295 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
298 let extern_mod_loaded = |k: &ast::Crate| pre_expansion_lint(sess, lint_store, k);
299 let mut ecx = ExtCtxt::new(&sess, cfg, &mut resolver, Some(&extern_mod_loaded));
301 // Expand macros now!
302 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
304 // The rest is error reporting
306 sess.time("check_unused_macros", || {
307 ecx.check_unused_macros();
310 let mut missing_fragment_specifiers: Vec<_> = ecx
313 .missing_fragment_specifiers
316 .map(|(span, node_id)| (*span, *node_id))
318 missing_fragment_specifiers.sort_unstable_by_key(|(span, _)| *span);
320 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
322 for (span, node_id) in missing_fragment_specifiers {
323 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
324 let msg = "missing fragment specifier";
325 resolver.lint_buffer().buffer_lint(lint, node_id, span, msg);
328 env::set_var("PATH", &old_path);
331 if recursion_limit_hit {
332 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
340 sess.time("maybe_building_test_harness", || {
341 rustc_builtin_macros::test_harness::inject(&sess, &mut resolver, &mut krate)
344 if let Some(PpMode::PpmSource(PpSourceMode::PpmEveryBodyLoops)) = sess.opts.pretty {
345 log::debug!("replacing bodies with loop {{}}");
346 util::ReplaceBodyWithLoop::new(&mut resolver).visit_crate(&mut krate);
349 let has_proc_macro_decls = sess.time("AST_validation", || {
350 rustc_ast_passes::ast_validation::check_crate(sess, &krate, &mut resolver.lint_buffer())
353 let crate_types = sess.crate_types();
354 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
356 // For backwards compatibility, we don't try to run proc macro injection
357 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
358 // specified. This should only affect users who manually invoke 'rustdoc', as
359 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
360 // However, we do emit a warning, to let such users know that they should
361 // start passing '--crate-type proc-macro'
362 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
363 let mut msg = sess.diagnostic().struct_warn(
364 &"Trying to document proc macro crate \
365 without passing '--crate-type proc-macro to rustdoc",
368 msg.warn("The generated documentation may be incorrect");
371 krate = sess.time("maybe_create_a_macro_crate", || {
372 let num_crate_types = crate_types.len();
373 let is_test_crate = sess.opts.test;
374 rustc_builtin_macros::proc_macro_harness::inject(
379 has_proc_macro_decls,
387 // Done with macro expansion!
389 if sess.opts.debugging_opts.input_stats {
390 println!("Post-expansion node count: {}", count_nodes(&krate));
393 if sess.opts.debugging_opts.hir_stats {
394 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
397 if sess.opts.debugging_opts.ast_json {
398 println!("{}", json::as_json(&krate));
401 resolver.resolve_crate(&krate);
403 // Needs to go *after* expansion to be able to check the results of macro expansion.
404 sess.time("complete_gated_feature_checking", || {
405 rustc_ast_passes::feature_gate::check_crate(&krate, sess);
408 // Add all buffered lints from the `ParseSess` to the `Session`.
409 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
410 info!("{} parse sess buffered_lints", buffered_lints.len());
411 for early_lint in buffered_lints.drain(..) {
412 resolver.lint_buffer().add_early_lint(early_lint);
416 Ok((krate, resolver))
419 pub fn lower_to_hir<'res, 'tcx>(
421 lint_store: &LintStore,
422 resolver: &'res mut Resolver<'_>,
423 dep_graph: &'res DepGraph,
424 krate: &'res ast::Crate,
425 arena: &'tcx rustc_ast_lowering::Arena<'tcx>,
427 // We're constructing the HIR here; we don't care what we will
428 // read, since we haven't even constructed the *input* to
430 dep_graph.assert_ignored();
433 let hir_crate = rustc_ast_lowering::lower_crate(
437 rustc_parse::nt_to_tokenstream,
441 if sess.opts.debugging_opts.hir_stats {
442 hir_stats::print_hir_stats(&hir_crate);
445 sess.time("early_lint_checks", || {
446 rustc_lint::check_ast_crate(
451 Some(std::mem::take(resolver.lint_buffer())),
452 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
456 // Discard hygiene data, which isn't required after lowering to HIR.
457 if !sess.opts.debugging_opts.keep_hygiene_data {
458 rustc_span::hygiene::clear_syntax_context_map();
464 // Returns all the paths that correspond to generated files.
465 fn generated_output_paths(
467 outputs: &OutputFilenames,
471 let mut out_filenames = Vec::new();
472 for output_type in sess.opts.output_types.keys() {
473 let file = outputs.path(*output_type);
475 // If the filename has been overridden using `-o`, it will not be modified
476 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
477 OutputType::Exe if !exact_name => {
478 for crate_type in sess.crate_types().iter() {
479 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
480 out_filenames.push(p);
483 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
484 // Don't add the dep-info output when omitting it from dep-info targets
487 out_filenames.push(file);
494 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
495 // returns None for every file path.
496 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
498 F: Fn(&PathBuf) -> Option<T>,
500 for output_path in output_paths {
501 if let Some(result) = f(output_path) {
508 fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
509 let input_path = input_path.canonicalize().ok();
510 if input_path.is_none() {
513 let check = |output_path: &PathBuf| {
514 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
516 check_output(output_paths, check).is_some()
519 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
520 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
521 check_output(output_paths, check)
524 fn escape_dep_filename(filename: &FileName) -> String {
525 // Apparently clang and gcc *only* escape spaces:
526 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
527 filename.to_string().replace(" ", "\\ ")
530 // Makefile comments only need escaping newlines and `\`.
531 // The result can be unescaped by anything that can unescape `escape_default` and friends.
532 fn escape_dep_env(symbol: Symbol) -> String {
533 let s = symbol.as_str();
534 let mut escaped = String::with_capacity(s.len());
537 '\n' => escaped.push_str(r"\n"),
538 '\r' => escaped.push_str(r"\r"),
539 '\\' => escaped.push_str(r"\\"),
540 _ => escaped.push(c),
548 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
549 outputs: &OutputFilenames,
550 out_filenames: &[PathBuf],
552 // Write out dependency rules to the dep-info file if requested
553 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
556 let deps_filename = outputs.path(OutputType::DepInfo);
558 let result = (|| -> io::Result<()> {
559 // Build a list of files used to compile the output and
560 // write Makefile-compatible dependency rules
561 let mut files: Vec<String> = sess
565 .filter(|fmap| fmap.is_real_file())
566 .filter(|fmap| !fmap.is_imported())
567 .map(|fmap| escape_dep_filename(&fmap.unmapped_path.as_ref().unwrap_or(&fmap.name)))
570 if sess.binary_dep_depinfo() {
571 boxed_resolver.borrow().borrow_mut().access(|resolver| {
572 for cnum in resolver.cstore().crates_untracked() {
573 let source = resolver.cstore().crate_source_untracked(cnum);
574 if let Some((path, _)) = source.dylib {
575 let file_name = FileName::Real(RealFileName::Named(path));
576 files.push(escape_dep_filename(&file_name));
578 if let Some((path, _)) = source.rlib {
579 let file_name = FileName::Real(RealFileName::Named(path));
580 files.push(escape_dep_filename(&file_name));
582 if let Some((path, _)) = source.rmeta {
583 let file_name = FileName::Real(RealFileName::Named(path));
584 files.push(escape_dep_filename(&file_name));
590 let mut file = BufWriter::new(fs::File::create(&deps_filename)?);
591 for path in out_filenames {
592 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
595 // Emit a fake target for each input file to the compilation. This
596 // prevents `make` from spitting out an error if a file is later
597 // deleted. For more info see #28735
599 writeln!(file, "{}:", path)?;
602 // Emit special comments with information about accessed environment variables.
603 let env_depinfo = sess.parse_sess.env_depinfo.borrow();
604 if !env_depinfo.is_empty() {
605 let mut envs: Vec<_> = env_depinfo
607 .map(|(k, v)| (escape_dep_env(*k), v.map(escape_dep_env)))
609 envs.sort_unstable();
612 write!(file, "# env-dep:{}", k)?;
614 write!(file, "={}", v)?;
625 if sess.opts.json_artifact_notifications {
628 .emit_artifact_notification(&deps_filename, "dep-info");
631 Err(e) => sess.fatal(&format!(
632 "error writing dependencies to `{}`: {}",
633 deps_filename.display(),
639 pub fn prepare_outputs(
643 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
645 ) -> Result<OutputFilenames> {
646 let _timer = sess.timer("prepare_outputs");
648 // FIXME: rustdoc passes &[] instead of &krate.attrs here
649 let outputs = util::build_output_filenames(
651 &compiler.output_dir,
652 &compiler.output_file,
658 generated_output_paths(sess, &outputs, compiler.output_file.is_some(), &crate_name);
660 // Ensure the source file isn't accidentally overwritten during compilation.
661 if let Some(ref input_path) = compiler.input_path {
662 if sess.opts.will_create_output_file() {
663 if output_contains_path(&output_paths, input_path) {
665 "the input file \"{}\" would be overwritten by the generated \
669 return Err(ErrorReported);
671 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
673 "the generated executable for the input file \"{}\" conflicts with the \
674 existing directory \"{}\"",
675 input_path.display(),
678 return Err(ErrorReported);
683 write_out_deps(sess, boxed_resolver, &outputs, &output_paths);
685 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
686 && sess.opts.output_types.len() == 1;
689 if let Some(ref dir) = compiler.output_dir {
690 if fs::create_dir_all(dir).is_err() {
691 sess.err("failed to find or create the directory specified by `--out-dir`");
692 return Err(ErrorReported);
700 pub static DEFAULT_QUERY_PROVIDERS: Lazy<Providers> = Lazy::new(|| {
701 let providers = &mut Providers::default();
702 providers.analysis = analysis;
703 proc_macro_decls::provide(providers);
704 plugin::build::provide(providers);
705 rustc_middle::hir::provide(providers);
706 mir::provide(providers);
707 mir_build::provide(providers);
708 rustc_privacy::provide(providers);
709 typeck::provide(providers);
710 ty::provide(providers);
711 traits::provide(providers);
712 rustc_passes::provide(providers);
713 rustc_resolve::provide(providers);
714 rustc_traits::provide(providers);
715 rustc_ty::provide(providers);
716 rustc_metadata::provide(providers);
717 rustc_lint::provide(providers);
718 rustc_symbol_mangling::provide(providers);
719 rustc_codegen_ssa::provide(providers);
723 pub static DEFAULT_EXTERN_QUERY_PROVIDERS: Lazy<Providers> = Lazy::new(|| {
724 let mut extern_providers = *DEFAULT_QUERY_PROVIDERS;
725 rustc_metadata::provide_extern(&mut extern_providers);
726 rustc_codegen_ssa::provide_extern(&mut extern_providers);
730 pub struct QueryContext<'tcx>(&'tcx GlobalCtxt<'tcx>);
732 impl<'tcx> QueryContext<'tcx> {
733 pub fn enter<F, R>(&mut self, f: F) -> R
735 F: FnOnce(TyCtxt<'tcx>) -> R,
737 let icx = ty::tls::ImplicitCtxt::new(self.0);
738 ty::tls::enter_context(&icx, |_| f(icx.tcx))
741 pub fn print_stats(&mut self) {
742 self.enter(ty::query::print_stats)
746 pub fn create_global_ctxt<'tcx>(
747 compiler: &'tcx Compiler,
748 lint_store: Lrc<LintStore>,
749 krate: &'tcx Crate<'tcx>,
751 mut resolver_outputs: ResolverOutputs,
752 outputs: OutputFilenames,
754 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
755 arena: &'tcx WorkerLocal<Arena<'tcx>>,
756 ) -> QueryContext<'tcx> {
757 let sess = &compiler.session();
758 let defs: &'tcx Definitions = arena.alloc(mem::replace(
759 &mut resolver_outputs.definitions,
760 Definitions::new(crate_name, sess.local_crate_disambiguator()),
763 let query_result_on_disk_cache = rustc_incremental::load_query_result_cache(sess);
765 let codegen_backend = compiler.codegen_backend();
766 let mut local_providers = *DEFAULT_QUERY_PROVIDERS;
767 codegen_backend.provide(&mut local_providers);
769 let mut extern_providers = *DEFAULT_EXTERN_QUERY_PROVIDERS;
770 codegen_backend.provide(&mut extern_providers);
771 codegen_backend.provide_extern(&mut extern_providers);
773 if let Some(callback) = compiler.override_queries {
774 callback(sess, &mut local_providers, &mut extern_providers);
777 let gcx = sess.time("setup_global_ctxt", || {
778 global_ctxt.get_or_init(|| {
779 TyCtxt::create_global_ctxt(
789 query_result_on_disk_cache,
796 // Do some initialization of the DepGraph that can only be done with the tcx available.
797 let icx = ty::tls::ImplicitCtxt::new(&gcx);
798 ty::tls::enter_context(&icx, |_| {
799 icx.tcx.sess.time("dep_graph_tcx_init", || rustc_incremental::dep_graph_tcx_init(icx.tcx));
805 /// Runs the resolution, type-checking, region checking and other
806 /// miscellaneous analysis passes on the crate.
807 fn analysis(tcx: TyCtxt<'_>, cnum: CrateNum) -> Result<()> {
808 assert_eq!(cnum, LOCAL_CRATE);
810 rustc_passes::hir_id_validator::check_crate(tcx);
813 let mut entry_point = None;
815 sess.time("misc_checking_1", || {
819 .time("looking_for_entry_point", || rustc_passes::entry::find_entry_point(tcx));
821 sess.time("looking_for_plugin_registrar", || {
822 plugin::build::find_plugin_registrar(tcx)
825 sess.time("looking_for_derive_registrar", || proc_macro_decls::find(tcx));
828 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
829 let local_def_id = tcx.hir().local_def_id(module);
830 tcx.ensure().check_mod_loops(local_def_id);
831 tcx.ensure().check_mod_attrs(local_def_id);
832 tcx.ensure().check_mod_unstable_api_usage(local_def_id);
833 tcx.ensure().check_mod_const_bodies(local_def_id);
839 // passes are timed inside typeck
840 typeck::check_crate(tcx)?;
842 sess.time("misc_checking_2", || {
845 sess.time("match_checking", || {
846 tcx.par_body_owners(|def_id| {
847 tcx.ensure().check_match(def_id.to_def_id());
852 sess.time("liveness_and_intrinsic_checking", || {
853 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
854 // this must run before MIR dump, because
855 // "not all control paths return a value" is reported here.
857 // maybe move the check to a MIR pass?
858 let local_def_id = tcx.hir().local_def_id(module);
860 tcx.ensure().check_mod_liveness(local_def_id);
861 tcx.ensure().check_mod_intrinsics(local_def_id);
868 sess.time("MIR_borrow_checking", || {
869 tcx.par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
872 sess.time("MIR_effect_checking", || {
873 for def_id in tcx.body_owners() {
874 mir::transform::check_unsafety::check_unsafety(tcx, def_id);
876 if tcx.hir().body_const_context(def_id).is_some() {
878 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::unknown(def_id));
883 sess.time("layout_testing", || layout_test::test_layout(tcx));
885 // Avoid overwhelming user with errors if borrow checking failed.
886 // I'm not sure how helpful this is, to be honest, but it avoids a
887 // lot of annoying errors in the compile-fail tests (basically,
888 // lint warnings and so on -- kindck used to do this abort, but
889 // kindck is gone now). -nmatsakis
890 if sess.has_errors() {
891 return Err(ErrorReported);
894 sess.time("misc_checking_3", || {
897 tcx.ensure().privacy_access_levels(LOCAL_CRATE);
901 tcx.ensure().check_private_in_public(LOCAL_CRATE);
904 sess.time("death_checking", || rustc_passes::dead::check_crate(tcx));
907 sess.time("unused_lib_feature_checking", || {
908 rustc_passes::stability::check_unused_or_stable_features(tcx)
912 sess.time("lint_checking", || {
913 rustc_lint::check_crate(tcx, || {
914 rustc_lint::BuiltinCombinedLateLintPass::new()
921 sess.time("privacy_checking_modules", || {
922 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
923 tcx.ensure().check_mod_privacy(tcx.hir().local_def_id(module));
933 fn encode_and_write_metadata(
935 outputs: &OutputFilenames,
936 ) -> (middle::cstore::EncodedMetadata, bool) {
937 #[derive(PartialEq, Eq, PartialOrd, Ord)]
944 let metadata_kind = tcx
948 .map(|ty| match *ty {
949 CrateType::Executable | CrateType::Staticlib | CrateType::Cdylib => MetadataKind::None,
951 CrateType::Rlib => MetadataKind::Uncompressed,
953 CrateType::Dylib | CrateType::ProcMacro => MetadataKind::Compressed,
956 .unwrap_or(MetadataKind::None);
958 let metadata = match metadata_kind {
959 MetadataKind::None => middle::cstore::EncodedMetadata::new(),
960 MetadataKind::Uncompressed | MetadataKind::Compressed => tcx.encode_metadata(),
963 let _prof_timer = tcx.sess.prof.generic_activity("write_crate_metadata");
965 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
966 if need_metadata_file {
967 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
968 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
969 // To avoid races with another rustc process scanning the output directory,
970 // we need to write the file somewhere else and atomically move it to its
971 // final destination, with an `fs::rename` call. In order for the rename to
972 // always succeed, the temporary file needs to be on the same filesystem,
973 // which is why we create it inside the output directory specifically.
974 let metadata_tmpdir = TempFileBuilder::new()
976 .tempdir_in(out_filename.parent().unwrap())
977 .unwrap_or_else(|err| tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err)));
978 let metadata_tmpdir = MaybeTempDir::new(metadata_tmpdir, tcx.sess.opts.cg.save_temps);
979 let metadata_filename = emit_metadata(tcx.sess, &metadata, &metadata_tmpdir);
980 if let Err(e) = fs::rename(&metadata_filename, &out_filename) {
981 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
983 if tcx.sess.opts.json_artifact_notifications {
987 .emit_artifact_notification(&out_filename, "metadata");
991 let need_metadata_module = metadata_kind == MetadataKind::Compressed;
993 (metadata, need_metadata_module)
996 /// Runs the codegen backend, after which the AST and analysis can
998 pub fn start_codegen<'tcx>(
999 codegen_backend: &dyn CodegenBackend,
1001 outputs: &OutputFilenames,
1003 info!("Pre-codegen\n{:?}", tcx.debug_stats());
1005 let (metadata, need_metadata_module) = encode_and_write_metadata(tcx, outputs);
1007 let codegen = tcx.sess.time("codegen_crate", move || {
1008 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1011 info!("Post-codegen\n{:?}", tcx.debug_stats());
1013 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1014 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, outputs) {
1015 tcx.sess.err(&format!("could not emit MIR: {}", e));
1016 tcx.sess.abort_if_errors();