1 use crate::interface::{Compiler, Result};
2 use crate::proc_macro_decls;
5 use log::{info, log_enabled, warn};
6 use rustc_ast::mut_visit::MutVisitor;
7 use rustc_ast::{self, ast, visit};
8 use rustc_codegen_ssa::back::link::emit_metadata;
9 use rustc_codegen_ssa::traits::CodegenBackend;
10 use rustc_data_structures::sync::{par_iter, Lrc, OnceCell, ParallelIterator, WorkerLocal};
11 use rustc_data_structures::{box_region_allow_access, declare_box_region_type, parallel};
12 use rustc_errors::{ErrorReported, PResult};
13 use rustc_expand::base::ExtCtxt;
14 use rustc_hir::def_id::{CrateNum, LOCAL_CRATE};
15 use rustc_hir::definitions::Definitions;
17 use rustc_lint::LintStore;
18 use rustc_middle::arena::Arena;
19 use rustc_middle::dep_graph::DepGraph;
20 use rustc_middle::middle;
21 use rustc_middle::middle::cstore::{CrateStore, MetadataLoader, MetadataLoaderDyn};
22 use rustc_middle::ty::steal::Steal;
23 use rustc_middle::ty::{self, GlobalCtxt, ResolverOutputs, TyCtxt};
25 use rustc_mir_build as mir_build;
26 use rustc_parse::{parse_crate_from_file, parse_crate_from_source_str};
27 use rustc_passes::{self, hir_stats, layout_test};
28 use rustc_plugin_impl as plugin;
29 use rustc_resolve::{Resolver, ResolverArenas};
30 use rustc_session::config::{CrateType, Input, OutputFilenames, OutputType, PpMode, PpSourceMode};
31 use rustc_session::lint;
32 use rustc_session::output::{filename_for_input, filename_for_metadata};
33 use rustc_session::search_paths::PathKind;
34 use rustc_session::Session;
35 use rustc_span::symbol::Symbol;
36 use rustc_span::{FileName, RealFileName};
37 use rustc_trait_selection::traits;
38 use rustc_typeck as typeck;
40 use rustc_serialize::json;
41 use tempfile::Builder as TempFileBuilder;
44 use std::cell::RefCell;
45 use std::ffi::OsString;
46 use std::io::{self, BufWriter, Write};
47 use std::path::PathBuf;
49 use std::{env, fs, iter, mem};
51 pub fn parse<'a>(sess: &'a Session, input: &Input) -> PResult<'a, ast::Crate> {
52 let krate = sess.time("parse_crate", || match input {
53 Input::File(file) => parse_crate_from_file(file, &sess.parse_sess),
54 Input::Str { input, name } => {
55 parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess)
59 if sess.opts.debugging_opts.ast_json_noexpand {
60 println!("{}", json::as_json(&krate));
63 if sess.opts.debugging_opts.input_stats {
64 println!("Lines of code: {}", sess.source_map().count_lines());
65 println!("Pre-expansion node count: {}", count_nodes(&krate));
68 if let Some(ref s) = sess.opts.debugging_opts.show_span {
69 rustc_ast_passes::show_span::run(sess.diagnostic(), s, &krate);
72 if sess.opts.debugging_opts.hir_stats {
73 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
79 fn count_nodes(krate: &ast::Crate) -> usize {
80 let mut counter = rustc_ast_passes::node_count::NodeCounter::new();
81 visit::walk_crate(&mut counter, krate);
85 declare_box_region_type!(
88 (&mut Resolver<'_>) -> (Result<ast::Crate>, ResolverOutputs)
91 /// Runs the "early phases" of the compiler: initial `cfg` processing, loading compiler plugins,
92 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
93 /// harness if one is to be provided, injection of a dependency on the
94 /// standard library and prelude, and name resolution.
96 /// Returns `None` if we're aborting after handling -W help.
97 pub fn configure_and_expand(
99 lint_store: Lrc<LintStore>,
100 metadata_loader: Box<MetadataLoaderDyn>,
103 ) -> Result<(ast::Crate, BoxedResolver)> {
104 log::trace!("configure_and_expand");
105 // Currently, we ignore the name resolution data structures for the purposes of dependency
106 // tracking. Instead we will run name resolution and include its output in the hash of each
107 // item, much like we do for macro expansion. In other words, the hash reflects not just
108 // its contents but the results of name resolution on those contents. Hopefully we'll push
109 // this back at some point.
110 let crate_name = crate_name.to_string();
111 let (result, resolver) = BoxedResolver::new(static move |mut action| {
114 let resolver_arenas = Resolver::arenas();
115 let res = configure_and_expand_inner(
123 let mut resolver = match res {
125 yield BoxedResolver::initial_yield(Err(v));
128 Ok((krate, resolver)) => {
129 action = yield BoxedResolver::initial_yield(Ok(krate));
133 box_region_allow_access!(for(), (&mut Resolver<'_>), (&mut resolver), action);
134 resolver.into_outputs()
136 result.map(|k| (k, resolver))
140 pub fn to_resolver_outputs(resolver: Rc<RefCell<BoxedResolver>>) -> ResolverOutputs {
141 match Rc::try_unwrap(resolver) {
142 Ok(resolver) => resolver.into_inner().complete(),
143 Err(resolver) => resolver.borrow_mut().access(|resolver| resolver.clone_outputs()),
148 pub fn register_plugins<'a>(
150 metadata_loader: &'a dyn MetadataLoader,
151 register_lints: impl Fn(&Session, &mut LintStore),
152 mut krate: ast::Crate,
154 ) -> Result<(ast::Crate, Lrc<LintStore>)> {
155 krate = sess.time("attributes_injection", || {
156 rustc_builtin_macros::cmdline_attrs::inject(
159 &sess.opts.debugging_opts.crate_attr,
163 let (krate, features) = rustc_expand::config::features(
167 &sess.opts.debugging_opts.allow_features,
169 // these need to be set "early" so that expansion sees `quote` if enabled.
170 sess.init_features(features);
172 let crate_types = util::collect_crate_types(sess, &krate.attrs);
173 sess.init_crate_types(crate_types);
175 let disambiguator = util::compute_crate_disambiguator(sess);
176 sess.crate_disambiguator.set(disambiguator).expect("not yet initialized");
177 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator);
179 if sess.opts.incremental.is_some() {
180 sess.time("incr_comp_garbage_collect_session_directories", || {
181 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
183 "Error while trying to garbage collect incremental \
184 compilation cache directory: {}",
191 sess.time("recursion_limit", || {
192 middle::limits::update_limits(sess, &krate);
195 let mut lint_store = rustc_lint::new_lint_store(
196 sess.opts.debugging_opts.no_interleave_lints,
197 sess.unstable_options(),
199 register_lints(&sess, &mut lint_store);
202 sess.time("plugin_loading", || plugin::load::load_plugins(sess, metadata_loader, &krate));
203 sess.time("plugin_registration", || {
204 let mut registry = plugin::Registry { lint_store: &mut lint_store };
205 for registrar in registrars {
206 registrar(&mut registry);
210 Ok((krate, Lrc::new(lint_store)))
213 fn pre_expansion_lint(sess: &Session, lint_store: &LintStore, krate: &ast::Crate) {
214 sess.time("pre_AST_expansion_lint_checks", || {
215 rustc_lint::check_ast_crate(
221 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
226 fn configure_and_expand_inner<'a>(
228 lint_store: &'a LintStore,
229 mut krate: ast::Crate,
231 resolver_arenas: &'a ResolverArenas<'a>,
232 metadata_loader: &'a MetadataLoaderDyn,
233 ) -> Result<(ast::Crate, Resolver<'a>)> {
234 log::trace!("configure_and_expand_inner");
235 pre_expansion_lint(sess, lint_store, &krate);
237 let mut resolver = Resolver::new(sess, &krate, crate_name, metadata_loader, &resolver_arenas);
238 rustc_builtin_macros::register_builtin_macros(&mut resolver, sess.edition());
240 krate = sess.time("crate_injection", || {
241 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| Symbol::intern(s));
242 let (krate, name) = rustc_builtin_macros::standard_library_imports::inject(
248 if let Some(name) = name {
249 sess.parse_sess.injected_crate_name.set(name).expect("not yet initialized");
254 util::check_attr_crate_type(&krate.attrs, &mut resolver.lint_buffer());
257 krate = sess.time("macro_expand_crate", || {
258 // Windows dlls do not have rpaths, so they don't know how to find their
259 // dependencies. It's up to us to tell the system where to find all the
260 // dependent dlls. Note that this uses cfg!(windows) as opposed to
261 // targ_cfg because syntax extensions are always loaded for the host
262 // compiler, not for the target.
264 // This is somewhat of an inherently racy operation, however, as
265 // multiple threads calling this function could possibly continue
266 // extending PATH far beyond what it should. To solve this for now we
267 // just don't add any new elements to PATH which are already there
268 // within PATH. This is basically a targeted fix at #17360 for rustdoc
269 // which runs rustc in parallel but has been seen (#33844) to cause
270 // problems with PATH becoming too long.
271 let mut old_path = OsString::new();
273 old_path = env::var_os("PATH").unwrap_or(old_path);
274 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
275 for path in env::split_paths(&old_path) {
276 if !new_path.contains(&path) {
283 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
289 // Create the config for macro expansion
290 let features = sess.features_untracked();
291 let cfg = rustc_expand::expand::ExpansionConfig {
292 features: Some(&features),
293 recursion_limit: sess.recursion_limit(),
294 trace_mac: sess.opts.debugging_opts.trace_macros,
295 should_test: sess.opts.test,
296 span_debug: sess.opts.debugging_opts.span_debug,
297 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
300 let extern_mod_loaded = |k: &ast::Crate| pre_expansion_lint(sess, lint_store, k);
301 let mut ecx = ExtCtxt::new(&sess.parse_sess, cfg, &mut resolver, Some(&extern_mod_loaded));
303 // Expand macros now!
304 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
306 // The rest is error reporting
308 sess.time("check_unused_macros", || {
309 ecx.check_unused_macros();
312 let mut missing_fragment_specifiers: Vec<_> = ecx
314 .missing_fragment_specifiers
317 .map(|(span, node_id)| (*span, *node_id))
319 missing_fragment_specifiers.sort_unstable_by_key(|(span, _)| *span);
321 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
323 for (span, node_id) in missing_fragment_specifiers {
324 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
325 let msg = "missing fragment specifier";
326 resolver.lint_buffer().buffer_lint(lint, node_id, span, msg);
329 env::set_var("PATH", &old_path);
332 if recursion_limit_hit {
333 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
341 sess.time("maybe_building_test_harness", || {
342 rustc_builtin_macros::test_harness::inject(
348 &sess.features_untracked(),
349 sess.panic_strategy(),
350 sess.target.target.options.panic_strategy,
351 sess.opts.debugging_opts.panic_abort_tests,
355 // If we're actually rustdoc then there's no need to actually compile
356 // anything, so switch everything to just looping
357 let mut should_loop = sess.opts.actually_rustdoc;
358 if let Some(PpMode::PpmSource(PpSourceMode::PpmEveryBodyLoops)) = sess.opts.pretty {
362 log::debug!("replacing bodies with loop {{}}");
363 util::ReplaceBodyWithLoop::new(&mut resolver).visit_crate(&mut krate);
366 let has_proc_macro_decls = sess.time("AST_validation", || {
367 rustc_ast_passes::ast_validation::check_crate(sess, &krate, &mut resolver.lint_buffer())
370 let crate_types = sess.crate_types();
371 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
373 // For backwards compatibility, we don't try to run proc macro injection
374 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
375 // specified. This should only affect users who manually invoke 'rustdoc', as
376 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
377 // However, we do emit a warning, to let such users know that they should
378 // start passing '--crate-type proc-macro'
379 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
380 let mut msg = sess.diagnostic().struct_warn(
381 &"Trying to document proc macro crate \
382 without passing '--crate-type proc-macro to rustdoc",
385 msg.warn("The generated documentation may be incorrect");
388 krate = sess.time("maybe_create_a_macro_crate", || {
389 let num_crate_types = crate_types.len();
390 let is_test_crate = sess.opts.test;
391 rustc_builtin_macros::proc_macro_harness::inject(
396 has_proc_macro_decls,
404 // Done with macro expansion!
406 if sess.opts.debugging_opts.input_stats {
407 println!("Post-expansion node count: {}", count_nodes(&krate));
410 if sess.opts.debugging_opts.hir_stats {
411 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
414 if sess.opts.debugging_opts.ast_json {
415 println!("{}", json::as_json(&krate));
418 resolver.resolve_crate(&krate);
420 // Needs to go *after* expansion to be able to check the results of macro expansion.
421 sess.time("complete_gated_feature_checking", || {
422 rustc_ast_passes::feature_gate::check_crate(
425 &sess.features_untracked(),
426 sess.opts.unstable_features,
430 // Add all buffered lints from the `ParseSess` to the `Session`.
431 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
432 info!("{} parse sess buffered_lints", buffered_lints.len());
433 for early_lint in buffered_lints.drain(..) {
434 resolver.lint_buffer().add_early_lint(early_lint);
438 Ok((krate, resolver))
441 pub fn lower_to_hir<'res, 'tcx>(
443 lint_store: &LintStore,
444 resolver: &'res mut Resolver<'_>,
445 dep_graph: &'res DepGraph,
446 krate: &'res ast::Crate,
447 arena: &'tcx rustc_ast_lowering::Arena<'tcx>,
449 // We're constructing the HIR here; we don't care what we will
450 // read, since we haven't even constructed the *input* to
452 dep_graph.assert_ignored();
455 let hir_crate = rustc_ast_lowering::lower_crate(
459 rustc_parse::nt_to_tokenstream,
463 if sess.opts.debugging_opts.hir_stats {
464 hir_stats::print_hir_stats(&hir_crate);
467 sess.time("early_lint_checks", || {
468 rustc_lint::check_ast_crate(
473 Some(std::mem::take(resolver.lint_buffer())),
474 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
478 // Discard hygiene data, which isn't required after lowering to HIR.
479 if !sess.opts.debugging_opts.keep_hygiene_data {
480 rustc_span::hygiene::clear_syntax_context_map();
486 // Returns all the paths that correspond to generated files.
487 fn generated_output_paths(
489 outputs: &OutputFilenames,
493 let mut out_filenames = Vec::new();
494 for output_type in sess.opts.output_types.keys() {
495 let file = outputs.path(*output_type);
497 // If the filename has been overridden using `-o`, it will not be modified
498 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
499 OutputType::Exe if !exact_name => {
500 for crate_type in sess.crate_types().iter() {
501 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
502 out_filenames.push(p);
505 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
506 // Don't add the dep-info output when omitting it from dep-info targets
509 out_filenames.push(file);
516 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
517 // returns None for every file path.
518 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
520 F: Fn(&PathBuf) -> Option<T>,
522 for output_path in output_paths {
523 if let Some(result) = f(output_path) {
530 fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
531 let input_path = input_path.canonicalize().ok();
532 if input_path.is_none() {
535 let check = |output_path: &PathBuf| {
536 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
538 check_output(output_paths, check).is_some()
541 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
542 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
543 check_output(output_paths, check)
546 fn escape_dep_filename(filename: &FileName) -> String {
547 // Apparently clang and gcc *only* escape spaces:
548 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
549 filename.to_string().replace(" ", "\\ ")
552 // Makefile comments only need escaping newlines and `\`.
553 // The result can be unescaped by anything that can unescape `escape_default` and friends.
554 fn escape_dep_env(symbol: Symbol) -> String {
555 let s = symbol.as_str();
556 let mut escaped = String::with_capacity(s.len());
559 '\n' => escaped.push_str(r"\n"),
560 '\r' => escaped.push_str(r"\r"),
561 '\\' => escaped.push_str(r"\\"),
562 _ => escaped.push(c),
570 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
571 outputs: &OutputFilenames,
572 out_filenames: &[PathBuf],
574 // Write out dependency rules to the dep-info file if requested
575 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
578 let deps_filename = outputs.path(OutputType::DepInfo);
580 let result = (|| -> io::Result<()> {
581 // Build a list of files used to compile the output and
582 // write Makefile-compatible dependency rules
583 let mut files: Vec<String> = sess
587 .filter(|fmap| fmap.is_real_file())
588 .filter(|fmap| !fmap.is_imported())
589 .map(|fmap| escape_dep_filename(&fmap.unmapped_path.as_ref().unwrap_or(&fmap.name)))
592 if sess.binary_dep_depinfo() {
593 boxed_resolver.borrow().borrow_mut().access(|resolver| {
594 for cnum in resolver.cstore().crates_untracked() {
595 let source = resolver.cstore().crate_source_untracked(cnum);
596 if let Some((path, _)) = source.dylib {
597 let file_name = FileName::Real(RealFileName::Named(path));
598 files.push(escape_dep_filename(&file_name));
600 if let Some((path, _)) = source.rlib {
601 let file_name = FileName::Real(RealFileName::Named(path));
602 files.push(escape_dep_filename(&file_name));
604 if let Some((path, _)) = source.rmeta {
605 let file_name = FileName::Real(RealFileName::Named(path));
606 files.push(escape_dep_filename(&file_name));
612 let mut file = BufWriter::new(fs::File::create(&deps_filename)?);
613 for path in out_filenames {
614 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
617 // Emit a fake target for each input file to the compilation. This
618 // prevents `make` from spitting out an error if a file is later
619 // deleted. For more info see #28735
621 writeln!(file, "{}:", path)?;
624 // Emit special comments with information about accessed environment variables.
625 let env_depinfo = sess.parse_sess.env_depinfo.borrow();
626 if !env_depinfo.is_empty() {
627 let mut envs: Vec<_> = env_depinfo
629 .map(|(k, v)| (escape_dep_env(*k), v.map(escape_dep_env)))
631 envs.sort_unstable();
634 write!(file, "# env-dep:{}", k)?;
636 write!(file, "={}", v)?;
647 if sess.opts.json_artifact_notifications {
650 .emit_artifact_notification(&deps_filename, "dep-info");
653 Err(e) => sess.fatal(&format!(
654 "error writing dependencies to `{}`: {}",
655 deps_filename.display(),
661 pub fn prepare_outputs(
665 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
667 ) -> Result<OutputFilenames> {
668 let _timer = sess.timer("prepare_outputs");
670 // FIXME: rustdoc passes &[] instead of &krate.attrs here
671 let outputs = util::build_output_filenames(
673 &compiler.output_dir,
674 &compiler.output_file,
680 generated_output_paths(sess, &outputs, compiler.output_file.is_some(), &crate_name);
682 // Ensure the source file isn't accidentally overwritten during compilation.
683 if let Some(ref input_path) = compiler.input_path {
684 if sess.opts.will_create_output_file() {
685 if output_contains_path(&output_paths, input_path) {
687 "the input file \"{}\" would be overwritten by the generated \
691 return Err(ErrorReported);
693 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
695 "the generated executable for the input file \"{}\" conflicts with the \
696 existing directory \"{}\"",
697 input_path.display(),
700 return Err(ErrorReported);
705 write_out_deps(sess, boxed_resolver, &outputs, &output_paths);
707 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
708 && sess.opts.output_types.len() == 1;
711 if let Some(ref dir) = compiler.output_dir {
712 if fs::create_dir_all(dir).is_err() {
713 sess.err("failed to find or create the directory specified by `--out-dir`");
714 return Err(ErrorReported);
722 pub fn default_provide(providers: &mut ty::query::Providers) {
723 providers.analysis = analysis;
724 proc_macro_decls::provide(providers);
725 plugin::build::provide(providers);
726 rustc_middle::hir::provide(providers);
727 mir::provide(providers);
728 mir_build::provide(providers);
729 rustc_privacy::provide(providers);
730 typeck::provide(providers);
731 ty::provide(providers);
732 traits::provide(providers);
733 rustc_passes::provide(providers);
734 rustc_resolve::provide(providers);
735 rustc_traits::provide(providers);
736 rustc_ty::provide(providers);
737 rustc_metadata::provide(providers);
738 rustc_lint::provide(providers);
739 rustc_symbol_mangling::provide(providers);
740 rustc_codegen_ssa::provide(providers);
743 pub fn default_provide_extern(providers: &mut ty::query::Providers) {
744 rustc_metadata::provide_extern(providers);
745 rustc_codegen_ssa::provide_extern(providers);
748 pub struct QueryContext<'tcx>(&'tcx GlobalCtxt<'tcx>);
750 impl<'tcx> QueryContext<'tcx> {
751 pub fn enter<F, R>(&mut self, f: F) -> R
753 F: FnOnce(TyCtxt<'tcx>) -> R,
755 ty::tls::enter_global(self.0, f)
758 pub fn print_stats(&mut self) {
759 self.enter(ty::query::print_stats)
763 pub fn create_global_ctxt<'tcx>(
764 compiler: &'tcx Compiler,
765 lint_store: Lrc<LintStore>,
766 krate: &'tcx Crate<'tcx>,
768 mut resolver_outputs: ResolverOutputs,
769 outputs: OutputFilenames,
771 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
772 arena: &'tcx WorkerLocal<Arena<'tcx>>,
773 ) -> QueryContext<'tcx> {
774 let sess = &compiler.session();
775 let defs: &'tcx Definitions = arena.alloc(mem::replace(
776 &mut resolver_outputs.definitions,
777 Definitions::new(crate_name, sess.local_crate_disambiguator()),
780 let query_result_on_disk_cache = rustc_incremental::load_query_result_cache(sess);
782 let codegen_backend = compiler.codegen_backend();
783 let mut local_providers = ty::query::Providers::default();
784 default_provide(&mut local_providers);
785 codegen_backend.provide(&mut local_providers);
787 let mut extern_providers = local_providers;
788 default_provide_extern(&mut extern_providers);
789 codegen_backend.provide_extern(&mut extern_providers);
791 if let Some(callback) = compiler.override_queries {
792 callback(sess, &mut local_providers, &mut extern_providers);
795 let gcx = sess.time("setup_global_ctxt", || {
796 global_ctxt.get_or_init(|| {
797 TyCtxt::create_global_ctxt(
807 query_result_on_disk_cache,
814 // Do some initialization of the DepGraph that can only be done with the tcx available.
815 ty::tls::enter_global(&gcx, |tcx| {
816 tcx.sess.time("dep_graph_tcx_init", || rustc_incremental::dep_graph_tcx_init(tcx));
822 /// Runs the resolution, type-checking, region checking and other
823 /// miscellaneous analysis passes on the crate.
824 fn analysis(tcx: TyCtxt<'_>, cnum: CrateNum) -> Result<()> {
825 assert_eq!(cnum, LOCAL_CRATE);
827 rustc_passes::hir_id_validator::check_crate(tcx);
830 let mut entry_point = None;
832 sess.time("misc_checking_1", || {
836 .time("looking_for_entry_point", || rustc_passes::entry::find_entry_point(tcx));
838 sess.time("looking_for_plugin_registrar", || {
839 plugin::build::find_plugin_registrar(tcx)
842 sess.time("looking_for_derive_registrar", || proc_macro_decls::find(tcx));
845 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
846 let local_def_id = tcx.hir().local_def_id(module);
847 tcx.ensure().check_mod_loops(local_def_id);
848 tcx.ensure().check_mod_attrs(local_def_id);
849 tcx.ensure().check_mod_unstable_api_usage(local_def_id);
850 tcx.ensure().check_mod_const_bodies(local_def_id);
856 // passes are timed inside typeck
857 typeck::check_crate(tcx)?;
859 sess.time("misc_checking_2", || {
862 sess.time("match_checking", || {
863 tcx.par_body_owners(|def_id| {
864 tcx.ensure().check_match(def_id.to_def_id());
869 sess.time("liveness_and_intrinsic_checking", || {
870 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
871 // this must run before MIR dump, because
872 // "not all control paths return a value" is reported here.
874 // maybe move the check to a MIR pass?
875 let local_def_id = tcx.hir().local_def_id(module);
877 tcx.ensure().check_mod_liveness(local_def_id);
878 tcx.ensure().check_mod_intrinsics(local_def_id);
885 sess.time("MIR_borrow_checking", || {
886 tcx.par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
889 sess.time("MIR_effect_checking", || {
890 for def_id in tcx.body_owners() {
891 mir::transform::check_unsafety::check_unsafety(tcx, def_id);
893 if tcx.hir().body_const_context(def_id).is_some() {
895 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::dummy(def_id));
900 sess.time("layout_testing", || layout_test::test_layout(tcx));
902 // Avoid overwhelming user with errors if borrow checking failed.
903 // I'm not sure how helpful this is, to be honest, but it avoids a
904 // lot of annoying errors in the compile-fail tests (basically,
905 // lint warnings and so on -- kindck used to do this abort, but
906 // kindck is gone now). -nmatsakis
907 if sess.has_errors() {
908 return Err(ErrorReported);
911 sess.time("misc_checking_3", || {
914 tcx.ensure().privacy_access_levels(LOCAL_CRATE);
918 tcx.ensure().check_private_in_public(LOCAL_CRATE);
921 sess.time("death_checking", || rustc_passes::dead::check_crate(tcx));
924 sess.time("unused_lib_feature_checking", || {
925 rustc_passes::stability::check_unused_or_stable_features(tcx)
929 sess.time("lint_checking", || {
930 rustc_lint::check_crate(tcx, || {
931 rustc_lint::BuiltinCombinedLateLintPass::new()
938 sess.time("privacy_checking_modules", || {
939 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
940 tcx.ensure().check_mod_privacy(tcx.hir().local_def_id(module));
950 fn encode_and_write_metadata(
952 outputs: &OutputFilenames,
953 ) -> (middle::cstore::EncodedMetadata, bool) {
954 #[derive(PartialEq, Eq, PartialOrd, Ord)]
961 let metadata_kind = tcx
965 .map(|ty| match *ty {
966 CrateType::Executable | CrateType::Staticlib | CrateType::Cdylib => MetadataKind::None,
968 CrateType::Rlib => MetadataKind::Uncompressed,
970 CrateType::Dylib | CrateType::ProcMacro => MetadataKind::Compressed,
973 .unwrap_or(MetadataKind::None);
975 let metadata = match metadata_kind {
976 MetadataKind::None => middle::cstore::EncodedMetadata::new(),
977 MetadataKind::Uncompressed | MetadataKind::Compressed => tcx.encode_metadata(),
980 let _prof_timer = tcx.sess.prof.generic_activity("write_crate_metadata");
982 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
983 if need_metadata_file {
984 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
985 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
986 // To avoid races with another rustc process scanning the output directory,
987 // we need to write the file somewhere else and atomically move it to its
988 // final destination, with an `fs::rename` call. In order for the rename to
989 // always succeed, the temporary file needs to be on the same filesystem,
990 // which is why we create it inside the output directory specifically.
991 let metadata_tmpdir = TempFileBuilder::new()
993 .tempdir_in(out_filename.parent().unwrap())
994 .unwrap_or_else(|err| tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err)));
995 let metadata_filename = emit_metadata(tcx.sess, &metadata, &metadata_tmpdir);
996 if let Err(e) = fs::rename(&metadata_filename, &out_filename) {
997 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
999 if tcx.sess.opts.json_artifact_notifications {
1003 .emit_artifact_notification(&out_filename, "metadata");
1007 let need_metadata_module = metadata_kind == MetadataKind::Compressed;
1009 (metadata, need_metadata_module)
1012 /// Runs the codegen backend, after which the AST and analysis can
1014 pub fn start_codegen<'tcx>(
1015 codegen_backend: &dyn CodegenBackend,
1017 outputs: &OutputFilenames,
1019 if log_enabled!(::log::Level::Info) {
1020 println!("Pre-codegen");
1021 tcx.print_debug_stats();
1024 let (metadata, need_metadata_module) = encode_and_write_metadata(tcx, outputs);
1026 let codegen = tcx.sess.time("codegen_crate", move || {
1027 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1030 if log_enabled!(::log::Level::Info) {
1031 println!("Post-codegen");
1032 tcx.print_debug_stats();
1035 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1036 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, outputs) {
1037 tcx.sess.err(&format!("could not emit MIR: {}", e));
1038 tcx.sess.abort_if_errors();