1 use crate::interface::{Compiler, Result};
3 use crate::proc_macro_decls;
5 use log::{info, warn, log_enabled};
6 use rustc::dep_graph::DepGraph;
8 use rustc::hir::lowering::lower_crate;
9 use rustc::hir::def_id::{CrateNum, LOCAL_CRATE};
11 use rustc::middle::{self, reachable, resolve_lifetime, stability};
12 use rustc::middle::cstore::CrateStore;
13 use rustc::ty::{self, AllArenas, Resolutions, TyCtxt, GlobalCtxt};
14 use rustc::ty::steal::Steal;
16 use rustc::util::common::{time, ErrorReported};
17 use rustc::session::Session;
18 use rustc::session::config::{self, CrateType, Input, OutputFilenames, OutputType};
19 use rustc::session::search_paths::PathKind;
20 use rustc_codegen_ssa::back::link::emit_metadata;
21 use rustc_codegen_utils::codegen_backend::CodegenBackend;
22 use rustc_codegen_utils::link::filename_for_metadata;
23 use rustc_data_structures::{box_region_allow_access, declare_box_region_type, parallel};
24 use rustc_data_structures::sync::{Lrc, ParallelIterator, par_iter};
25 use rustc_incremental;
26 use rustc_metadata::creader::CrateLoader;
27 use rustc_metadata::cstore::{self, CStore};
29 use rustc_passes::{self, ast_validation, hir_stats, layout_test};
30 use rustc_plugin as plugin;
31 use rustc_plugin::registry::Registry;
33 use rustc_resolve::{Resolver, ResolverArenas};
35 use rustc_typeck as typeck;
36 use syntax::{self, ast, visit};
37 use syntax::early_buffered_lints::BufferedEarlyLint;
38 use syntax::ext::base::{NamedSyntaxExtension, ExtCtxt};
39 use syntax::mut_visit::MutVisitor;
40 use syntax::parse::{self, PResult};
41 use syntax::util::node_count::NodeCounter;
42 use syntax::symbol::Symbol;
43 use syntax_pos::FileName;
46 use rustc_serialize::json;
47 use tempfile::Builder as TempFileBuilder;
51 use std::ffi::OsString;
53 use std::io::{self, Write};
55 use std::path::PathBuf;
56 use std::cell::RefCell;
59 pub fn parse<'a>(sess: &'a Session, input: &Input) -> PResult<'a, ast::Crate> {
61 .set_continue_after_error(sess.opts.debugging_opts.continue_parse_after_error);
62 let krate = time(sess, "parsing", || {
63 let _prof_timer = sess.prof.generic_activity("parse_crate");
66 Input::File(ref file) => parse::parse_crate_from_file(file, &sess.parse_sess),
70 } => parse::parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess),
74 sess.diagnostic().set_continue_after_error(true);
76 if sess.opts.debugging_opts.ast_json_noexpand {
77 println!("{}", json::as_json(&krate));
80 if sess.opts.debugging_opts.input_stats {
83 sess.source_map().count_lines()
85 println!("Pre-expansion node count: {}", count_nodes(&krate));
88 if let Some(ref s) = sess.opts.debugging_opts.show_span {
89 syntax::show_span::run(sess.diagnostic(), s, &krate);
92 if sess.opts.debugging_opts.hir_stats {
93 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
99 fn count_nodes(krate: &ast::Crate) -> usize {
100 let mut counter = NodeCounter::new();
101 visit::walk_crate(&mut counter, krate);
105 declare_box_region_type!(
108 (&mut Resolver<'_>) -> (Result<ast::Crate>, ExpansionResult)
111 /// Runs the "early phases" of the compiler: initial `cfg` processing,
112 /// loading compiler plugins (including those from `addl_plugins`),
113 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
114 /// harness if one is to be provided, injection of a dependency on the
115 /// standard library and prelude, and name resolution.
117 /// Returns `None` if we're aborting after handling -W help.
118 pub fn configure_and_expand(
123 plugin_info: PluginInfo,
124 ) -> Result<(ast::Crate, BoxedResolver)> {
125 // Currently, we ignore the name resolution data structures for the purposes of dependency
126 // tracking. Instead we will run name resolution and include its output in the hash of each
127 // item, much like we do for macro expansion. In other words, the hash reflects not just
128 // its contents but the results of name resolution on those contents. Hopefully we'll push
129 // this back at some point.
130 let crate_name = crate_name.to_string();
131 let (result, resolver) = BoxedResolver::new(static move || {
133 let mut crate_loader = CrateLoader::new(sess, &*cstore, &crate_name);
134 let resolver_arenas = Resolver::arenas();
135 let res = configure_and_expand_inner(
144 let mut resolver = match res {
146 yield BoxedResolver::initial_yield(Err(v));
149 Ok((krate, resolver)) => {
150 yield BoxedResolver::initial_yield(Ok(krate));
154 box_region_allow_access!(for(), (&mut Resolver<'_>), (&mut resolver));
155 ExpansionResult::from_owned_resolver(resolver)
157 result.map(|k| (k, resolver))
160 pub struct ExpansionResult {
161 pub defs: Steal<hir::map::Definitions>,
162 pub resolutions: Steal<Resolutions>,
165 impl ExpansionResult {
166 fn from_owned_resolver(
167 resolver: Resolver<'_>,
170 defs: Steal::new(resolver.definitions),
171 resolutions: Steal::new(Resolutions {
172 export_map: resolver.export_map,
173 trait_map: resolver.trait_map,
174 glob_map: resolver.glob_map,
175 maybe_unused_trait_imports: resolver.maybe_unused_trait_imports,
176 maybe_unused_extern_crates: resolver.maybe_unused_extern_crates,
177 extern_prelude: resolver.extern_prelude.iter().map(|(ident, entry)| {
178 (ident.name, entry.introduced_by_item)
184 pub fn from_resolver_ref(
185 resolver: &Resolver<'_>,
188 defs: Steal::new(resolver.definitions.clone()),
189 resolutions: Steal::new(Resolutions {
190 export_map: resolver.export_map.clone(),
191 trait_map: resolver.trait_map.clone(),
192 glob_map: resolver.glob_map.clone(),
193 maybe_unused_trait_imports: resolver.maybe_unused_trait_imports.clone(),
194 maybe_unused_extern_crates: resolver.maybe_unused_extern_crates.clone(),
195 extern_prelude: resolver.extern_prelude.iter().map(|(ident, entry)| {
196 (ident.name, entry.introduced_by_item)
204 pub fn to_expansion_result(
205 resolver: Rc<RefCell<BoxedResolver>>,
206 ) -> ExpansionResult {
207 match Rc::try_unwrap(resolver) {
208 Ok(resolver) => resolver.into_inner().complete(),
210 let resolver = &*resolver;
211 resolver.borrow_mut().access(|resolver| {
212 ExpansionResult::from_resolver_ref(resolver)
219 pub struct PluginInfo {
220 syntax_exts: Vec<NamedSyntaxExtension>,
223 pub fn register_plugins<'a>(
226 mut krate: ast::Crate,
228 ) -> Result<(ast::Crate, PluginInfo)> {
229 krate = time(sess, "attributes injection", || {
230 syntax_ext::cmdline_attrs::inject(
231 krate, &sess.parse_sess, &sess.opts.debugging_opts.crate_attr
235 let (krate, features) = syntax::config::features(
239 &sess.opts.debugging_opts.allow_features,
241 // these need to be set "early" so that expansion sees `quote` if enabled.
242 sess.init_features(features);
244 let crate_types = util::collect_crate_types(sess, &krate.attrs);
245 sess.crate_types.set(crate_types);
247 let disambiguator = util::compute_crate_disambiguator(sess);
248 sess.crate_disambiguator.set(disambiguator);
249 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator);
251 if sess.opts.incremental.is_some() {
252 time(sess, "garbage-collect incremental cache directory", || {
254 sess.prof.generic_activity("incr_comp_garbage_collect_session_directories");
255 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
257 "Error while trying to garbage collect incremental \
258 compilation cache directory: {}",
265 time(sess, "recursion limit", || {
266 middle::recursion_limit::update_limits(sess, &krate);
269 let registrars = time(sess, "plugin loading", || {
270 plugin::load::load_plugins(
275 Some(sess.opts.debugging_opts.extra_plugins.clone()),
279 let mut registry = Registry::new(sess, krate.span);
281 time(sess, "plugin registration", || {
282 for registrar in registrars {
283 registry.args_hidden = Some(registrar.args);
284 (registrar.fun)(&mut registry);
298 let mut ls = sess.lint_store.borrow_mut();
299 for pass in early_lint_passes {
300 ls.register_early_pass(Some(sess), true, false, pass);
302 for pass in late_lint_passes {
303 ls.register_late_pass(Some(sess), true, false, false, pass);
306 for (name, (to, deprecated_name)) in lint_groups {
307 ls.register_group(Some(sess), true, name, deprecated_name, to);
310 *sess.plugin_llvm_passes.borrow_mut() = llvm_passes;
311 *sess.plugin_attributes.borrow_mut() = attributes;
313 Ok((krate, PluginInfo { syntax_exts }))
316 fn configure_and_expand_inner<'a>(
319 mut krate: ast::Crate,
321 resolver_arenas: &'a ResolverArenas<'a>,
322 crate_loader: &'a mut CrateLoader<'a>,
323 plugin_info: PluginInfo,
324 ) -> Result<(ast::Crate, Resolver<'a>)> {
325 time(sess, "pre-AST-expansion lint checks", || {
326 lint::check_ast_crate(
330 rustc_lint::BuiltinCombinedPreExpansionLintPass::new());
333 let mut resolver = Resolver::new(
341 syntax_ext::register_builtin_macros(&mut resolver, sess.edition());
343 krate = time(sess, "crate injection", || {
344 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| Symbol::intern(s));
345 let (krate, name) = syntax_ext::standard_library_imports::inject(
351 if let Some(name) = name {
352 sess.parse_sess.injected_crate_name.set(name);
357 syntax_ext::plugin_macro_defs::inject(
358 &mut krate, &mut resolver, plugin_info.syntax_exts, sess.edition()
362 krate = time(sess, "expansion", || {
363 let _prof_timer = sess.prof.generic_activity("macro_expand_crate");
364 // Windows dlls do not have rpaths, so they don't know how to find their
365 // dependencies. It's up to us to tell the system where to find all the
366 // dependent dlls. Note that this uses cfg!(windows) as opposed to
367 // targ_cfg because syntax extensions are always loaded for the host
368 // compiler, not for the target.
370 // This is somewhat of an inherently racy operation, however, as
371 // multiple threads calling this function could possibly continue
372 // extending PATH far beyond what it should. To solve this for now we
373 // just don't add any new elements to PATH which are already there
374 // within PATH. This is basically a targeted fix at #17360 for rustdoc
375 // which runs rustc in parallel but has been seen (#33844) to cause
376 // problems with PATH becoming too long.
377 let mut old_path = OsString::new();
379 old_path = env::var_os("PATH").unwrap_or(old_path);
380 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
381 for path in env::split_paths(&old_path) {
382 if !new_path.contains(&path) {
391 .filter(|p| env::join_paths(iter::once(p)).is_ok()),
396 // Create the config for macro expansion
397 let features = sess.features_untracked();
398 let cfg = syntax::ext::expand::ExpansionConfig {
399 features: Some(&features),
400 recursion_limit: *sess.recursion_limit.get(),
401 trace_mac: sess.opts.debugging_opts.trace_macros,
402 should_test: sess.opts.test,
403 ..syntax::ext::expand::ExpansionConfig::default(crate_name.to_string())
406 let mut ecx = ExtCtxt::new(&sess.parse_sess, cfg, &mut resolver);
408 // Expand macros now!
409 let krate = time(sess, "expand crate", || {
410 ecx.monotonic_expander().expand_crate(krate)
413 // The rest is error reporting
415 time(sess, "check unused macros", || {
416 ecx.check_unused_macros();
419 let mut missing_fragment_specifiers: Vec<_> = ecx.parse_sess
420 .missing_fragment_specifiers
425 missing_fragment_specifiers.sort();
427 for span in missing_fragment_specifiers {
428 let lint = lint::builtin::MISSING_FRAGMENT_SPECIFIER;
429 let msg = "missing fragment specifier";
430 sess.buffer_lint(lint, ast::CRATE_NODE_ID, span, msg);
433 env::set_var("PATH", &old_path);
438 time(sess, "maybe building test harness", || {
439 syntax_ext::test_harness::inject(
445 &sess.features_untracked(),
446 sess.panic_strategy(),
447 sess.target.target.options.panic_strategy,
448 sess.opts.debugging_opts.panic_abort_tests,
452 // If we're actually rustdoc then there's no need to actually compile
453 // anything, so switch everything to just looping
454 if sess.opts.actually_rustdoc {
455 util::ReplaceBodyWithLoop::new(sess).visit_crate(&mut krate);
458 let has_proc_macro_decls = time(sess, "AST validation", || {
459 ast_validation::check_crate(sess, &krate)
463 let crate_types = sess.crate_types.borrow();
464 let is_proc_macro_crate = crate_types.contains(&config::CrateType::ProcMacro);
466 // For backwards compatibility, we don't try to run proc macro injection
467 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
468 // specified. This should only affect users who manually invoke 'rustdoc', as
469 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
470 // However, we do emit a warning, to let such users know that they should
471 // start passing '--crate-type proc-macro'
472 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
473 let mut msg = sess.diagnostic().struct_warn(&"Trying to document proc macro crate \
474 without passing '--crate-type proc-macro to rustdoc");
476 msg.warn("The generated documentation may be incorrect");
479 krate = time(sess, "maybe creating a macro crate", || {
480 let num_crate_types = crate_types.len();
481 let is_test_crate = sess.opts.test;
482 syntax_ext::proc_macro_harness::inject(
487 has_proc_macro_decls,
495 // Done with macro expansion!
497 if sess.opts.debugging_opts.input_stats {
498 println!("Post-expansion node count: {}", count_nodes(&krate));
501 if sess.opts.debugging_opts.hir_stats {
502 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
505 if sess.opts.debugging_opts.ast_json {
506 println!("{}", json::as_json(&krate));
509 time(sess, "name resolution", || {
510 resolver.resolve_crate(&krate);
513 // Needs to go *after* expansion to be able to check the results of macro expansion.
514 time(sess, "complete gated feature checking", || {
515 syntax::feature_gate::check_crate(
518 &sess.features_untracked(),
519 sess.opts.unstable_features,
523 // Add all buffered lints from the `ParseSess` to the `Session`.
524 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
525 info!("{} parse sess buffered_lints", buffered_lints.len());
526 for BufferedEarlyLint{id, span, msg, lint_id} in buffered_lints.drain(..) {
527 let lint = lint::Lint::from_parser_lint_id(lint_id);
528 sess.buffer_lint(lint, id, span, &msg);
532 Ok((krate, resolver))
538 resolver: &mut Resolver<'_>,
539 dep_graph: &DepGraph,
541 ) -> Result<hir::map::Forest> {
543 let hir_forest = time(sess, "lowering AST -> HIR", || {
544 let hir_crate = lower_crate(sess, cstore, &dep_graph, &krate, resolver);
546 if sess.opts.debugging_opts.hir_stats {
547 hir_stats::print_hir_stats(&hir_crate);
550 hir::map::Forest::new(hir_crate, &dep_graph)
553 time(sess, "early lint checks", || {
554 lint::check_ast_crate(sess, &krate, false, rustc_lint::BuiltinCombinedEarlyLintPass::new())
557 // Discard hygiene data, which isn't required after lowering to HIR.
558 if !sess.opts.debugging_opts.keep_hygiene_data {
559 syntax::ext::hygiene::clear_syntax_context_map();
565 // Returns all the paths that correspond to generated files.
566 fn generated_output_paths(
568 outputs: &OutputFilenames,
572 let mut out_filenames = Vec::new();
573 for output_type in sess.opts.output_types.keys() {
574 let file = outputs.path(*output_type);
576 // If the filename has been overridden using `-o`, it will not be modified
577 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
578 OutputType::Exe if !exact_name => for crate_type in sess.crate_types.borrow().iter() {
579 let p = ::rustc_codegen_utils::link::filename_for_input(
585 out_filenames.push(p);
587 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
588 // Don't add the dep-info output when omitting it from dep-info targets
591 out_filenames.push(file);
598 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
599 // returns None for every file path.
600 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
602 F: Fn(&PathBuf) -> Option<T>,
604 for output_path in output_paths {
605 if let Some(result) = f(output_path) {
612 fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
613 let input_path = input_path.canonicalize().ok();
614 if input_path.is_none() {
617 let check = |output_path: &PathBuf| {
618 if output_path.canonicalize().ok() == input_path {
624 check_output(output_paths, check).is_some()
627 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
628 let check = |output_path: &PathBuf| {
629 if output_path.is_dir() {
630 Some(output_path.clone())
635 check_output(output_paths, check)
638 fn escape_dep_filename(filename: &FileName) -> String {
639 // Apparently clang and gcc *only* escape spaces:
640 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
641 filename.to_string().replace(" ", "\\ ")
644 fn write_out_deps(compiler: &Compiler, outputs: &OutputFilenames, out_filenames: &[PathBuf]) {
645 let sess = &compiler.sess;
646 // Write out dependency rules to the dep-info file if requested
647 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
650 let deps_filename = outputs.path(OutputType::DepInfo);
652 let result = (|| -> io::Result<()> {
653 // Build a list of files used to compile the output and
654 // write Makefile-compatible dependency rules
655 let mut files: Vec<String> = sess.source_map()
658 .filter(|fmap| fmap.is_real_file())
659 .filter(|fmap| !fmap.is_imported())
660 .map(|fmap| escape_dep_filename(&fmap.unmapped_path.as_ref().unwrap_or(&fmap.name)))
663 if sess.binary_dep_depinfo() {
664 for cnum in compiler.cstore.crates_untracked() {
665 let metadata = compiler.cstore.crate_data_as_rc_any(cnum);
666 let metadata = metadata.downcast_ref::<cstore::CrateMetadata>().unwrap();
667 if let Some((path, _)) = &metadata.source.dylib {
668 files.push(escape_dep_filename(&FileName::Real(path.clone())));
670 if let Some((path, _)) = &metadata.source.rlib {
671 files.push(escape_dep_filename(&FileName::Real(path.clone())));
673 if let Some((path, _)) = &metadata.source.rmeta {
674 files.push(escape_dep_filename(&FileName::Real(path.clone())));
679 let mut file = fs::File::create(&deps_filename)?;
680 for path in out_filenames {
681 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
684 // Emit a fake target for each input file to the compilation. This
685 // prevents `make` from spitting out an error if a file is later
686 // deleted. For more info see #28735
688 writeln!(file, "{}:", path)?;
695 if sess.opts.json_artifact_notifications {
696 sess.parse_sess.span_diagnostic
697 .emit_artifact_notification(&deps_filename, "dep-info");
702 "error writing dependencies to `{}`: {}",
703 deps_filename.display(),
710 pub fn prepare_outputs(
715 ) -> Result<OutputFilenames> {
716 // FIXME: rustdoc passes &[] instead of &krate.attrs here
717 let outputs = util::build_output_filenames(
719 &compiler.output_dir,
720 &compiler.output_file,
725 let output_paths = generated_output_paths(
728 compiler.output_file.is_some(),
732 // Ensure the source file isn't accidentally overwritten during compilation.
733 if let Some(ref input_path) = compiler.input_path {
734 if sess.opts.will_create_output_file() {
735 if output_contains_path(&output_paths, input_path) {
737 "the input file \"{}\" would be overwritten by the generated \
741 return Err(ErrorReported);
743 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
745 "the generated executable for the input file \"{}\" conflicts with the \
746 existing directory \"{}\"",
747 input_path.display(),
750 return Err(ErrorReported);
755 write_out_deps(compiler, &outputs, &output_paths);
757 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
758 && sess.opts.output_types.len() == 1;
761 if let Some(ref dir) = compiler.output_dir {
762 if fs::create_dir_all(dir).is_err() {
763 sess.err("failed to find or create the directory specified by `--out-dir`");
764 return Err(ErrorReported);
772 pub fn default_provide(providers: &mut ty::query::Providers<'_>) {
773 providers.analysis = analysis;
774 proc_macro_decls::provide(providers);
775 plugin::build::provide(providers);
776 hir::provide(providers);
777 mir::provide(providers);
778 reachable::provide(providers);
779 resolve_lifetime::provide(providers);
780 rustc_privacy::provide(providers);
781 typeck::provide(providers);
782 ty::provide(providers);
783 traits::provide(providers);
784 stability::provide(providers);
785 reachable::provide(providers);
786 rustc_passes::provide(providers);
787 rustc_traits::provide(providers);
788 middle::region::provide(providers);
789 cstore::provide(providers);
790 lint::provide(providers);
791 rustc_lint::provide(providers);
792 rustc_codegen_utils::symbol_names::provide(providers);
793 rustc_codegen_ssa::back::symbol_export::provide(providers);
794 rustc_codegen_ssa::base::provide_both(providers);
797 pub fn default_provide_extern(providers: &mut ty::query::Providers<'_>) {
798 cstore::provide_extern(providers);
799 rustc_codegen_ssa::back::symbol_export::provide_extern(providers);
800 rustc_codegen_ssa::base::provide_both(providers);
803 declare_box_region_type!(
806 (&'tcx GlobalCtxt<'tcx>) -> ((), ())
809 impl BoxedGlobalCtxt {
810 pub fn enter<F, R>(&mut self, f: F) -> R
812 F: for<'tcx> FnOnce(TyCtxt<'tcx>) -> R,
814 self.access(|gcx| ty::tls::enter_global(gcx, |tcx| f(tcx)))
818 pub fn create_global_ctxt(
820 mut hir_forest: hir::map::Forest,
821 defs: hir::map::Definitions,
822 resolutions: Resolutions,
823 outputs: OutputFilenames,
825 ) -> BoxedGlobalCtxt {
826 let sess = compiler.session().clone();
827 let cstore = compiler.cstore.clone();
828 let codegen_backend = compiler.codegen_backend().clone();
829 let crate_name = crate_name.to_string();
831 let ((), result) = BoxedGlobalCtxt::new(static move || {
833 let cstore = &*cstore;
835 let global_ctxt: Option<GlobalCtxt<'_>>;
836 let arenas = AllArenas::new();
838 // Construct the HIR map.
839 let hir_map = time(sess, "indexing HIR", || {
840 hir::map::map_crate(sess, cstore, &mut hir_forest, &defs)
843 let query_result_on_disk_cache = time(sess, "load query result cache", || {
844 rustc_incremental::load_query_result_cache(sess)
847 let mut local_providers = ty::query::Providers::default();
848 default_provide(&mut local_providers);
849 codegen_backend.provide(&mut local_providers);
851 let mut extern_providers = local_providers;
852 default_provide_extern(&mut extern_providers);
853 codegen_backend.provide_extern(&mut extern_providers);
855 let gcx = TyCtxt::create_global_ctxt(
863 query_result_on_disk_cache,
868 global_ctxt = Some(gcx);
869 let gcx = global_ctxt.as_ref().unwrap();
871 ty::tls::enter_global(gcx, |tcx| {
872 // Do some initialization of the DepGraph that can only be done with the
874 time(tcx.sess, "dep graph tcx init", || rustc_incremental::dep_graph_tcx_init(tcx));
877 yield BoxedGlobalCtxt::initial_yield(());
878 box_region_allow_access!(for('tcx), (&'tcx GlobalCtxt<'tcx>), (gcx));
880 if sess.opts.debugging_opts.query_stats {
881 gcx.queries.print_stats();
888 /// Runs the resolution, type-checking, region checking and other
889 /// miscellaneous analysis passes on the crate.
890 fn analysis(tcx: TyCtxt<'_>, cnum: CrateNum) -> Result<()> {
891 assert_eq!(cnum, LOCAL_CRATE);
894 let mut entry_point = None;
896 time(sess, "misc checking 1", || {
898 entry_point = time(sess, "looking for entry point", || {
899 rustc_passes::entry::find_entry_point(tcx)
902 time(sess, "looking for plugin registrar", || {
903 plugin::build::find_plugin_registrar(tcx)
906 time(sess, "looking for derive registrar", || {
907 proc_macro_decls::find(tcx)
910 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
911 let local_def_id = tcx.hir().local_def_id(module);
912 tcx.ensure().check_mod_loops(local_def_id);
913 tcx.ensure().check_mod_attrs(local_def_id);
914 tcx.ensure().check_mod_unstable_api_usage(local_def_id);
919 // passes are timed inside typeck
920 typeck::check_crate(tcx)?;
922 time(sess, "misc checking 2", || {
924 time(sess, "match checking", || {
925 tcx.par_body_owners(|def_id| {
926 tcx.ensure().check_match(def_id);
930 time(sess, "liveness checking + intrinsic checking", || {
931 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
932 // this must run before MIR dump, because
933 // "not all control paths return a value" is reported here.
935 // maybe move the check to a MIR pass?
936 let local_def_id = tcx.hir().local_def_id(module);
938 tcx.ensure().check_mod_liveness(local_def_id);
939 tcx.ensure().check_mod_intrinsics(local_def_id);
945 time(sess, "MIR borrow checking", || {
946 tcx.par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
949 time(sess, "dumping Chalk-like clauses", || {
950 rustc_traits::lowering::dump_program_clauses(tcx);
953 time(sess, "MIR effect checking", || {
954 for def_id in tcx.body_owners() {
955 mir::transform::check_unsafety::check_unsafety(tcx, def_id)
959 time(sess, "layout testing", || layout_test::test_layout(tcx));
961 // Avoid overwhelming user with errors if borrow checking failed.
962 // I'm not sure how helpful this is, to be honest, but it avoids a
963 // lot of annoying errors in the compile-fail tests (basically,
964 // lint warnings and so on -- kindck used to do this abort, but
965 // kindck is gone now). -nmatsakis
966 if sess.has_errors() {
967 return Err(ErrorReported);
970 time(sess, "misc checking 3", || {
972 time(sess, "privacy access levels", || {
973 tcx.ensure().privacy_access_levels(LOCAL_CRATE);
976 time(sess, "private in public", || {
977 tcx.ensure().check_private_in_public(LOCAL_CRATE);
980 time(sess, "death checking", || rustc_passes::dead::check_crate(tcx));
982 time(sess, "unused lib feature checking", || {
983 stability::check_unused_or_stable_features(tcx)
986 time(sess, "lint checking", || {
987 lint::check_crate(tcx, || rustc_lint::BuiltinCombinedLateLintPass::new());
991 time(sess, "privacy checking modules", || {
992 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
993 tcx.ensure().check_mod_privacy(tcx.hir().local_def_id(module));
1002 fn encode_and_write_metadata(
1004 outputs: &OutputFilenames,
1005 ) -> (middle::cstore::EncodedMetadata, bool) {
1006 #[derive(PartialEq, Eq, PartialOrd, Ord)]
1013 let metadata_kind = tcx.sess.crate_types.borrow().iter().map(|ty| {
1015 CrateType::Executable |
1016 CrateType::Staticlib |
1017 CrateType::Cdylib => MetadataKind::None,
1019 CrateType::Rlib => MetadataKind::Uncompressed,
1022 CrateType::ProcMacro => MetadataKind::Compressed,
1024 }).max().unwrap_or(MetadataKind::None);
1026 let metadata = match metadata_kind {
1027 MetadataKind::None => middle::cstore::EncodedMetadata::new(),
1028 MetadataKind::Uncompressed |
1029 MetadataKind::Compressed => tcx.encode_metadata(),
1032 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
1033 if need_metadata_file {
1034 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
1035 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
1036 // To avoid races with another rustc process scanning the output directory,
1037 // we need to write the file somewhere else and atomically move it to its
1038 // final destination, with an `fs::rename` call. In order for the rename to
1039 // always succeed, the temporary file needs to be on the same filesystem,
1040 // which is why we create it inside the output directory specifically.
1041 let metadata_tmpdir = TempFileBuilder::new()
1043 .tempdir_in(out_filename.parent().unwrap())
1044 .unwrap_or_else(|err| {
1045 tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err))
1047 let metadata_filename = emit_metadata(tcx.sess, &metadata, &metadata_tmpdir);
1048 if let Err(e) = fs::rename(&metadata_filename, &out_filename) {
1049 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
1051 if tcx.sess.opts.json_artifact_notifications {
1052 tcx.sess.parse_sess.span_diagnostic
1053 .emit_artifact_notification(&out_filename, "metadata");
1057 let need_metadata_module = metadata_kind == MetadataKind::Compressed;
1059 (metadata, need_metadata_module)
1062 /// Runs the codegen backend, after which the AST and analysis can
1064 pub fn start_codegen<'tcx>(
1065 codegen_backend: &dyn CodegenBackend,
1067 outputs: &OutputFilenames,
1069 if log_enabled!(::log::Level::Info) {
1070 println!("Pre-codegen");
1071 tcx.print_debug_stats();
1074 let (metadata, need_metadata_module) = time(tcx.sess, "metadata encoding and writing", || {
1075 encode_and_write_metadata(tcx, outputs)
1078 let codegen = time(tcx.sess, "codegen", move || {
1079 let _prof_timer = tcx.prof.generic_activity("codegen_crate");
1080 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1083 if log_enabled!(::log::Level::Info) {
1084 println!("Post-codegen");
1085 tcx.print_debug_stats();
1088 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1089 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, outputs) {
1090 tcx.sess.err(&format!("could not emit MIR: {}", e));
1091 tcx.sess.abort_if_errors();