1 use crate::interface::{Compiler, Result};
2 use crate::proc_macro_decls;
5 use rustc_ast::mut_visit::{self, MutVisitor};
7 use rustc_ast::{self as ast, token, 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::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::steal::Steal;
25 use rustc_middle::ty::{self, GlobalCtxt, ResolverOutputs, TyCtxt};
27 use rustc_mir_build as mir_build;
28 use rustc_parse::{parse_crate_from_file, parse_crate_from_source_str};
29 use rustc_passes::{self, hir_stats, layout_test};
30 use rustc_plugin_impl as plugin;
31 use rustc_resolve::{Resolver, ResolverArenas};
32 use rustc_session::config::{CrateType, Input, OutputFilenames, OutputType, PpMode, PpSourceMode};
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::Symbol;
37 use rustc_span::{FileName, RealFileName};
38 use rustc_trait_selection::traits;
39 use rustc_typeck as typeck;
40 use smallvec::SmallVec;
41 use tracing::{info, warn};
43 use rustc_serialize::json;
44 use tempfile::Builder as TempFileBuilder;
47 use std::cell::RefCell;
48 use std::ffi::OsString;
49 use std::io::{self, BufWriter, Write};
50 use std::lazy::SyncLazy;
51 use std::path::PathBuf;
53 use std::{env, fs, iter, mem};
55 /// Remove alls `LazyTokenStreams` from an AST struct
56 /// Normally, this is done during AST lowering. However,
57 /// printing the AST JSON requires us to serialize
58 /// the entire AST, and we don't want to serialize
59 /// a `LazyTokenStream`.
61 impl mut_visit::MutVisitor for TokenStripper {
62 fn flat_map_item(&mut self, mut i: P<ast::Item>) -> SmallVec<[P<ast::Item>; 1]> {
64 mut_visit::noop_flat_map_item(i, self)
66 fn flat_map_foreign_item(
68 mut i: P<ast::ForeignItem>,
69 ) -> SmallVec<[P<ast::ForeignItem>; 1]> {
71 mut_visit::noop_flat_map_foreign_item(i, self)
73 fn visit_block(&mut self, b: &mut P<ast::Block>) {
75 mut_visit::noop_visit_block(b, self);
77 fn flat_map_stmt(&mut self, mut stmt: ast::Stmt) -> SmallVec<[ast::Stmt; 1]> {
79 mut_visit::noop_flat_map_stmt(stmt, self)
81 fn visit_pat(&mut self, p: &mut P<ast::Pat>) {
83 mut_visit::noop_visit_pat(p, self);
85 fn visit_ty(&mut self, ty: &mut P<ast::Ty>) {
87 mut_visit::noop_visit_ty(ty, self);
89 fn visit_attribute(&mut self, attr: &mut ast::Attribute) {
91 if let ast::AttrKind::Normal(ast::AttrItem { tokens, .. }) = &mut attr.kind {
94 mut_visit::noop_visit_attribute(attr, self);
97 fn visit_interpolated(&mut self, nt: &mut token::Nonterminal) {
98 if let token::Nonterminal::NtMeta(meta) = nt {
101 // Handles all of the other cases
102 mut_visit::noop_visit_interpolated(nt, self);
105 fn visit_path(&mut self, p: &mut ast::Path) {
107 mut_visit::noop_visit_path(p, self);
109 fn visit_vis(&mut self, vis: &mut ast::Visibility) {
111 mut_visit::noop_visit_vis(vis, self);
113 fn visit_expr(&mut self, e: &mut P<ast::Expr>) {
115 mut_visit::noop_visit_expr(e, self);
117 fn visit_mac(&mut self, _mac: &mut ast::MacCall) {}
120 pub fn parse<'a>(sess: &'a Session, input: &Input) -> PResult<'a, ast::Crate> {
121 let krate = sess.time("parse_crate", || match input {
122 Input::File(file) => parse_crate_from_file(file, &sess.parse_sess),
123 Input::Str { input, name } => {
124 parse_crate_from_source_str(name.clone(), input.clone(), &sess.parse_sess)
128 if sess.opts.debugging_opts.ast_json_noexpand {
129 // Set any `token` fields to `None` before
130 // we display the AST.
131 let mut krate = krate.clone();
132 TokenStripper.visit_crate(&mut krate);
133 println!("{}", json::as_json(&krate));
136 if sess.opts.debugging_opts.input_stats {
137 println!("Lines of code: {}", sess.source_map().count_lines());
138 println!("Pre-expansion node count: {}", count_nodes(&krate));
141 if let Some(ref s) = sess.opts.debugging_opts.show_span {
142 rustc_ast_passes::show_span::run(sess.diagnostic(), s, &krate);
145 if sess.opts.debugging_opts.hir_stats {
146 hir_stats::print_ast_stats(&krate, "PRE EXPANSION AST STATS");
152 fn count_nodes(krate: &ast::Crate) -> usize {
153 let mut counter = rustc_ast_passes::node_count::NodeCounter::new();
154 visit::walk_crate(&mut counter, krate);
158 declare_box_region_type!(
161 (&mut Resolver<'_>) -> (Result<ast::Crate>, ResolverOutputs)
164 /// Runs the "early phases" of the compiler: initial `cfg` processing, loading compiler plugins,
165 /// syntax expansion, secondary `cfg` expansion, synthesis of a test
166 /// harness if one is to be provided, injection of a dependency on the
167 /// standard library and prelude, and name resolution.
169 /// Returns `None` if we're aborting after handling -W help.
170 pub fn configure_and_expand(
172 lint_store: Lrc<LintStore>,
173 metadata_loader: Box<MetadataLoaderDyn>,
176 ) -> Result<(ast::Crate, BoxedResolver)> {
177 tracing::trace!("configure_and_expand");
178 // Currently, we ignore the name resolution data structures for the purposes of dependency
179 // tracking. Instead we will run name resolution and include its output in the hash of each
180 // item, much like we do for macro expansion. In other words, the hash reflects not just
181 // its contents but the results of name resolution on those contents. Hopefully we'll push
182 // this back at some point.
183 let crate_name = crate_name.to_string();
184 let (result, resolver) = BoxedResolver::new(static move |mut action| {
187 let resolver_arenas = Resolver::arenas();
188 let res = configure_and_expand_inner(
196 let mut resolver = match res {
198 yield BoxedResolver::initial_yield(Err(v));
201 Ok((krate, resolver)) => {
202 action = yield BoxedResolver::initial_yield(Ok(krate));
206 box_region_allow_access!(for(), (&mut Resolver<'_>), (&mut resolver), action);
207 resolver.into_outputs()
209 result.map(|k| (k, resolver))
213 pub fn to_resolver_outputs(resolver: Rc<RefCell<BoxedResolver>>) -> ResolverOutputs {
214 match Rc::try_unwrap(resolver) {
215 Ok(resolver) => resolver.into_inner().complete(),
216 Err(resolver) => resolver.borrow_mut().access(|resolver| resolver.clone_outputs()),
221 pub fn register_plugins<'a>(
223 metadata_loader: &'a dyn MetadataLoader,
224 register_lints: impl Fn(&Session, &mut LintStore),
225 mut krate: ast::Crate,
227 ) -> Result<(ast::Crate, Lrc<LintStore>)> {
228 krate = sess.time("attributes_injection", || {
229 rustc_builtin_macros::cmdline_attrs::inject(
232 &sess.opts.debugging_opts.crate_attr,
236 let (krate, features) = rustc_expand::config::features(sess, krate);
237 // these need to be set "early" so that expansion sees `quote` if enabled.
238 sess.init_features(features);
240 let crate_types = util::collect_crate_types(sess, &krate.attrs);
241 sess.init_crate_types(crate_types);
243 let disambiguator = util::compute_crate_disambiguator(sess);
244 sess.crate_disambiguator.set(disambiguator).expect("not yet initialized");
245 rustc_incremental::prepare_session_directory(sess, &crate_name, disambiguator);
247 if sess.opts.incremental.is_some() {
248 sess.time("incr_comp_garbage_collect_session_directories", || {
249 if let Err(e) = rustc_incremental::garbage_collect_session_directories(sess) {
251 "Error while trying to garbage collect incremental \
252 compilation cache directory: {}",
259 sess.time("recursion_limit", || {
260 middle::limits::update_limits(sess, &krate);
263 let mut lint_store = rustc_lint::new_lint_store(
264 sess.opts.debugging_opts.no_interleave_lints,
265 sess.unstable_options(),
267 register_lints(&sess, &mut lint_store);
270 sess.time("plugin_loading", || plugin::load::load_plugins(sess, metadata_loader, &krate));
271 sess.time("plugin_registration", || {
272 let mut registry = plugin::Registry { lint_store: &mut lint_store };
273 for registrar in registrars {
274 registrar(&mut registry);
278 let lint_store = Lrc::new(lint_store);
279 sess.init_lint_store(lint_store.clone());
281 Ok((krate, lint_store))
284 fn pre_expansion_lint(sess: &Session, lint_store: &LintStore, krate: &ast::Crate) {
285 sess.time("pre_AST_expansion_lint_checks", || {
286 rustc_lint::check_ast_crate(
292 rustc_lint::BuiltinCombinedPreExpansionLintPass::new(),
297 fn configure_and_expand_inner<'a>(
299 lint_store: &'a LintStore,
300 mut krate: ast::Crate,
302 resolver_arenas: &'a ResolverArenas<'a>,
303 metadata_loader: &'a MetadataLoaderDyn,
304 ) -> Result<(ast::Crate, Resolver<'a>)> {
305 tracing::trace!("configure_and_expand_inner");
306 pre_expansion_lint(sess, lint_store, &krate);
308 let mut resolver = Resolver::new(sess, &krate, crate_name, metadata_loader, &resolver_arenas);
309 rustc_builtin_macros::register_builtin_macros(&mut resolver, sess.edition());
311 krate = sess.time("crate_injection", || {
312 let alt_std_name = sess.opts.alt_std_name.as_ref().map(|s| Symbol::intern(s));
313 let (krate, name) = rustc_builtin_macros::standard_library_imports::inject(
319 if let Some(name) = name {
320 sess.parse_sess.injected_crate_name.set(name).expect("not yet initialized");
325 util::check_attr_crate_type(&sess, &krate.attrs, &mut resolver.lint_buffer());
328 krate = sess.time("macro_expand_crate", || {
329 // Windows dlls do not have rpaths, so they don't know how to find their
330 // dependencies. It's up to us to tell the system where to find all the
331 // dependent dlls. Note that this uses cfg!(windows) as opposed to
332 // targ_cfg because syntax extensions are always loaded for the host
333 // compiler, not for the target.
335 // This is somewhat of an inherently racy operation, however, as
336 // multiple threads calling this function could possibly continue
337 // extending PATH far beyond what it should. To solve this for now we
338 // just don't add any new elements to PATH which are already there
339 // within PATH. This is basically a targeted fix at #17360 for rustdoc
340 // which runs rustc in parallel but has been seen (#33844) to cause
341 // problems with PATH becoming too long.
342 let mut old_path = OsString::new();
344 old_path = env::var_os("PATH").unwrap_or(old_path);
345 let mut new_path = sess.host_filesearch(PathKind::All).search_path_dirs();
346 for path in env::split_paths(&old_path) {
347 if !new_path.contains(&path) {
354 new_path.iter().filter(|p| env::join_paths(iter::once(p)).is_ok()),
360 // Create the config for macro expansion
361 let features = sess.features_untracked();
362 let cfg = rustc_expand::expand::ExpansionConfig {
363 features: Some(&features),
364 recursion_limit: sess.recursion_limit(),
365 trace_mac: sess.opts.debugging_opts.trace_macros,
366 should_test: sess.opts.test,
367 span_debug: sess.opts.debugging_opts.span_debug,
368 proc_macro_backtrace: sess.opts.debugging_opts.proc_macro_backtrace,
369 ..rustc_expand::expand::ExpansionConfig::default(crate_name.to_string())
372 let extern_mod_loaded = |k: &ast::Crate| pre_expansion_lint(sess, lint_store, k);
373 let mut ecx = ExtCtxt::new(&sess, cfg, &mut resolver, Some(&extern_mod_loaded));
375 // Expand macros now!
376 let krate = sess.time("expand_crate", || ecx.monotonic_expander().expand_crate(krate));
378 // The rest is error reporting
380 sess.time("check_unused_macros", || {
381 ecx.check_unused_macros();
385 env::set_var("PATH", &old_path);
388 let recursion_limit_hit = ecx.reduced_recursion_limit.is_some();
389 if recursion_limit_hit {
390 // If we hit a recursion limit, exit early to avoid later passes getting overwhelmed
398 sess.time("maybe_building_test_harness", || {
399 rustc_builtin_macros::test_harness::inject(&sess, &mut resolver, &mut krate)
402 if let Some(PpMode::PpmSource(PpSourceMode::PpmEveryBodyLoops)) = sess.opts.pretty {
403 tracing::debug!("replacing bodies with loop {{}}");
404 util::ReplaceBodyWithLoop::new(&mut resolver).visit_crate(&mut krate);
407 let has_proc_macro_decls = sess.time("AST_validation", || {
408 rustc_ast_passes::ast_validation::check_crate(sess, &krate, &mut resolver.lint_buffer())
411 let crate_types = sess.crate_types();
412 let is_proc_macro_crate = crate_types.contains(&CrateType::ProcMacro);
414 // For backwards compatibility, we don't try to run proc macro injection
415 // if rustdoc is run on a proc macro crate without '--crate-type proc-macro' being
416 // specified. This should only affect users who manually invoke 'rustdoc', as
417 // 'cargo doc' will automatically pass the proper '--crate-type' flags.
418 // However, we do emit a warning, to let such users know that they should
419 // start passing '--crate-type proc-macro'
420 if has_proc_macro_decls && sess.opts.actually_rustdoc && !is_proc_macro_crate {
421 let mut msg = sess.diagnostic().struct_warn(
422 &"Trying to document proc macro crate \
423 without passing '--crate-type proc-macro to rustdoc",
426 msg.warn("The generated documentation may be incorrect");
429 krate = sess.time("maybe_create_a_macro_crate", || {
430 let num_crate_types = crate_types.len();
431 let is_test_crate = sess.opts.test;
432 rustc_builtin_macros::proc_macro_harness::inject(
437 has_proc_macro_decls,
445 // Done with macro expansion!
447 if sess.opts.debugging_opts.input_stats {
448 println!("Post-expansion node count: {}", count_nodes(&krate));
451 if sess.opts.debugging_opts.hir_stats {
452 hir_stats::print_ast_stats(&krate, "POST EXPANSION AST STATS");
455 if sess.opts.debugging_opts.ast_json {
456 // Set any `token` fields to `None` before
457 // we display the AST.
458 let mut krate = krate.clone();
459 TokenStripper.visit_crate(&mut krate);
460 println!("{}", json::as_json(&krate));
463 resolver.resolve_crate(&krate);
465 // Needs to go *after* expansion to be able to check the results of macro expansion.
466 sess.time("complete_gated_feature_checking", || {
467 rustc_ast_passes::feature_gate::check_crate(&krate, sess);
470 // Add all buffered lints from the `ParseSess` to the `Session`.
471 sess.parse_sess.buffered_lints.with_lock(|buffered_lints| {
472 info!("{} parse sess buffered_lints", buffered_lints.len());
473 for early_lint in buffered_lints.drain(..) {
474 resolver.lint_buffer().add_early_lint(early_lint);
478 Ok((krate, resolver))
481 pub fn lower_to_hir<'res, 'tcx>(
483 lint_store: &LintStore,
484 resolver: &'res mut Resolver<'_>,
485 dep_graph: &'res DepGraph,
486 krate: &'res ast::Crate,
487 arena: &'tcx rustc_ast_lowering::Arena<'tcx>,
489 // We're constructing the HIR here; we don't care what we will
490 // read, since we haven't even constructed the *input* to
492 dep_graph.assert_ignored();
495 let hir_crate = rustc_ast_lowering::lower_crate(
499 rustc_parse::nt_to_tokenstream,
503 if sess.opts.debugging_opts.hir_stats {
504 hir_stats::print_hir_stats(&hir_crate);
507 sess.time("early_lint_checks", || {
508 rustc_lint::check_ast_crate(
513 Some(std::mem::take(resolver.lint_buffer())),
514 rustc_lint::BuiltinCombinedEarlyLintPass::new(),
518 // Discard hygiene data, which isn't required after lowering to HIR.
519 if !sess.opts.debugging_opts.keep_hygiene_data {
520 rustc_span::hygiene::clear_syntax_context_map();
526 // Returns all the paths that correspond to generated files.
527 fn generated_output_paths(
529 outputs: &OutputFilenames,
533 let mut out_filenames = Vec::new();
534 for output_type in sess.opts.output_types.keys() {
535 let file = outputs.path(*output_type);
537 // If the filename has been overridden using `-o`, it will not be modified
538 // by appending `.rlib`, `.exe`, etc., so we can skip this transformation.
539 OutputType::Exe if !exact_name => {
540 for crate_type in sess.crate_types().iter() {
541 let p = filename_for_input(sess, *crate_type, crate_name, outputs);
542 out_filenames.push(p);
545 OutputType::DepInfo if sess.opts.debugging_opts.dep_info_omit_d_target => {
546 // Don't add the dep-info output when omitting it from dep-info targets
549 out_filenames.push(file);
556 // Runs `f` on every output file path and returns the first non-None result, or None if `f`
557 // returns None for every file path.
558 fn check_output<F, T>(output_paths: &[PathBuf], f: F) -> Option<T>
560 F: Fn(&PathBuf) -> Option<T>,
562 for output_path in output_paths {
563 if let Some(result) = f(output_path) {
570 fn output_contains_path(output_paths: &[PathBuf], input_path: &PathBuf) -> bool {
571 let input_path = input_path.canonicalize().ok();
572 if input_path.is_none() {
575 let check = |output_path: &PathBuf| {
576 if output_path.canonicalize().ok() == input_path { Some(()) } else { None }
578 check_output(output_paths, check).is_some()
581 fn output_conflicts_with_dir(output_paths: &[PathBuf]) -> Option<PathBuf> {
582 let check = |output_path: &PathBuf| output_path.is_dir().then(|| output_path.clone());
583 check_output(output_paths, check)
586 fn escape_dep_filename(filename: &FileName) -> String {
587 // Apparently clang and gcc *only* escape spaces:
588 // http://llvm.org/klaus/clang/commit/9d50634cfc268ecc9a7250226dd5ca0e945240d4
589 filename.to_string().replace(" ", "\\ ")
592 // Makefile comments only need escaping newlines and `\`.
593 // The result can be unescaped by anything that can unescape `escape_default` and friends.
594 fn escape_dep_env(symbol: Symbol) -> String {
595 let s = symbol.as_str();
596 let mut escaped = String::with_capacity(s.len());
599 '\n' => escaped.push_str(r"\n"),
600 '\r' => escaped.push_str(r"\r"),
601 '\\' => escaped.push_str(r"\\"),
602 _ => escaped.push(c),
610 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
611 outputs: &OutputFilenames,
612 out_filenames: &[PathBuf],
614 // Write out dependency rules to the dep-info file if requested
615 if !sess.opts.output_types.contains_key(&OutputType::DepInfo) {
618 let deps_filename = outputs.path(OutputType::DepInfo);
620 let result = (|| -> io::Result<()> {
621 // Build a list of files used to compile the output and
622 // write Makefile-compatible dependency rules
623 let mut files: Vec<String> = sess
627 .filter(|fmap| fmap.is_real_file())
628 .filter(|fmap| !fmap.is_imported())
629 .map(|fmap| escape_dep_filename(&fmap.unmapped_path.as_ref().unwrap_or(&fmap.name)))
632 if let Some(ref backend) = sess.opts.debugging_opts.codegen_backend {
633 files.push(backend.to_string());
636 if sess.binary_dep_depinfo() {
637 boxed_resolver.borrow().borrow_mut().access(|resolver| {
638 for cnum in resolver.cstore().crates_untracked() {
639 let source = resolver.cstore().crate_source_untracked(cnum);
640 if let Some((path, _)) = source.dylib {
641 let file_name = FileName::Real(RealFileName::Named(path));
642 files.push(escape_dep_filename(&file_name));
644 if let Some((path, _)) = source.rlib {
645 let file_name = FileName::Real(RealFileName::Named(path));
646 files.push(escape_dep_filename(&file_name));
648 if let Some((path, _)) = source.rmeta {
649 let file_name = FileName::Real(RealFileName::Named(path));
650 files.push(escape_dep_filename(&file_name));
656 let mut file = BufWriter::new(fs::File::create(&deps_filename)?);
657 for path in out_filenames {
658 writeln!(file, "{}: {}\n", path.display(), files.join(" "))?;
661 // Emit a fake target for each input file to the compilation. This
662 // prevents `make` from spitting out an error if a file is later
663 // deleted. For more info see #28735
665 writeln!(file, "{}:", path)?;
668 // Emit special comments with information about accessed environment variables.
669 let env_depinfo = sess.parse_sess.env_depinfo.borrow();
670 if !env_depinfo.is_empty() {
671 let mut envs: Vec<_> = env_depinfo
673 .map(|(k, v)| (escape_dep_env(*k), v.map(escape_dep_env)))
675 envs.sort_unstable();
678 write!(file, "# env-dep:{}", k)?;
680 write!(file, "={}", v)?;
691 if sess.opts.json_artifact_notifications {
694 .emit_artifact_notification(&deps_filename, "dep-info");
697 Err(e) => sess.fatal(&format!(
698 "error writing dependencies to `{}`: {}",
699 deps_filename.display(),
705 pub fn prepare_outputs(
709 boxed_resolver: &Steal<Rc<RefCell<BoxedResolver>>>,
711 ) -> Result<OutputFilenames> {
712 let _timer = sess.timer("prepare_outputs");
714 // FIXME: rustdoc passes &[] instead of &krate.attrs here
715 let outputs = util::build_output_filenames(
717 &compiler.output_dir,
718 &compiler.output_file,
724 generated_output_paths(sess, &outputs, compiler.output_file.is_some(), &crate_name);
726 // Ensure the source file isn't accidentally overwritten during compilation.
727 if let Some(ref input_path) = compiler.input_path {
728 if sess.opts.will_create_output_file() {
729 if output_contains_path(&output_paths, input_path) {
731 "the input file \"{}\" would be overwritten by the generated \
735 return Err(ErrorReported);
737 if let Some(dir_path) = output_conflicts_with_dir(&output_paths) {
739 "the generated executable for the input file \"{}\" conflicts with the \
740 existing directory \"{}\"",
741 input_path.display(),
744 return Err(ErrorReported);
749 write_out_deps(sess, boxed_resolver, &outputs, &output_paths);
751 let only_dep_info = sess.opts.output_types.contains_key(&OutputType::DepInfo)
752 && sess.opts.output_types.len() == 1;
755 if let Some(ref dir) = compiler.output_dir {
756 if fs::create_dir_all(dir).is_err() {
757 sess.err("failed to find or create the directory specified by `--out-dir`");
758 return Err(ErrorReported);
766 pub static DEFAULT_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
767 let providers = &mut Providers::default();
768 providers.analysis = analysis;
769 proc_macro_decls::provide(providers);
770 plugin::build::provide(providers);
771 rustc_middle::hir::provide(providers);
772 mir::provide(providers);
773 mir_build::provide(providers);
774 rustc_privacy::provide(providers);
775 typeck::provide(providers);
776 ty::provide(providers);
777 traits::provide(providers);
778 rustc_passes::provide(providers);
779 rustc_resolve::provide(providers);
780 rustc_traits::provide(providers);
781 rustc_ty::provide(providers);
782 rustc_metadata::provide(providers);
783 rustc_lint::provide(providers);
784 rustc_symbol_mangling::provide(providers);
785 rustc_codegen_ssa::provide(providers);
789 pub static DEFAULT_EXTERN_QUERY_PROVIDERS: SyncLazy<Providers> = SyncLazy::new(|| {
790 let mut extern_providers = *DEFAULT_QUERY_PROVIDERS;
791 rustc_metadata::provide_extern(&mut extern_providers);
792 rustc_codegen_ssa::provide_extern(&mut extern_providers);
796 pub struct QueryContext<'tcx>(&'tcx GlobalCtxt<'tcx>);
798 impl<'tcx> QueryContext<'tcx> {
799 pub fn enter<F, R>(&mut self, f: F) -> R
801 F: FnOnce(TyCtxt<'tcx>) -> R,
803 let icx = ty::tls::ImplicitCtxt::new(self.0);
804 ty::tls::enter_context(&icx, |_| f(icx.tcx))
807 pub fn print_stats(&mut self) {
808 self.enter(ty::query::print_stats)
812 pub fn create_global_ctxt<'tcx>(
813 compiler: &'tcx Compiler,
814 lint_store: Lrc<LintStore>,
815 krate: &'tcx Crate<'tcx>,
817 mut resolver_outputs: ResolverOutputs,
818 outputs: OutputFilenames,
820 global_ctxt: &'tcx OnceCell<GlobalCtxt<'tcx>>,
821 arena: &'tcx WorkerLocal<Arena<'tcx>>,
822 ) -> QueryContext<'tcx> {
823 let sess = &compiler.session();
824 let defs: &'tcx Definitions = arena.alloc(mem::replace(
825 &mut resolver_outputs.definitions,
826 Definitions::new(crate_name, sess.local_crate_disambiguator()),
829 let query_result_on_disk_cache = rustc_incremental::load_query_result_cache(sess);
831 let codegen_backend = compiler.codegen_backend();
832 let mut local_providers = *DEFAULT_QUERY_PROVIDERS;
833 codegen_backend.provide(&mut local_providers);
835 let mut extern_providers = *DEFAULT_EXTERN_QUERY_PROVIDERS;
836 codegen_backend.provide(&mut extern_providers);
837 codegen_backend.provide_extern(&mut extern_providers);
839 if let Some(callback) = compiler.override_queries {
840 callback(sess, &mut local_providers, &mut extern_providers);
843 let gcx = sess.time("setup_global_ctxt", || {
844 global_ctxt.get_or_init(|| {
845 TyCtxt::create_global_ctxt(
855 query_result_on_disk_cache,
862 // Do some initialization of the DepGraph that can only be done with the tcx available.
863 let icx = ty::tls::ImplicitCtxt::new(&gcx);
864 ty::tls::enter_context(&icx, |_| {
865 icx.tcx.sess.time("dep_graph_tcx_init", || rustc_incremental::dep_graph_tcx_init(icx.tcx));
871 /// Runs the resolution, type-checking, region checking and other
872 /// miscellaneous analysis passes on the crate.
873 fn analysis(tcx: TyCtxt<'_>, cnum: CrateNum) -> Result<()> {
874 assert_eq!(cnum, LOCAL_CRATE);
876 rustc_passes::hir_id_validator::check_crate(tcx);
879 let mut entry_point = None;
881 sess.time("misc_checking_1", || {
885 .time("looking_for_entry_point", || rustc_passes::entry::find_entry_point(tcx));
887 sess.time("looking_for_plugin_registrar", || {
888 plugin::build::find_plugin_registrar(tcx)
891 sess.time("looking_for_derive_registrar", || proc_macro_decls::find(tcx));
894 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
895 let local_def_id = tcx.hir().local_def_id(module);
896 tcx.ensure().check_mod_loops(local_def_id);
897 tcx.ensure().check_mod_attrs(local_def_id);
898 tcx.ensure().check_mod_unstable_api_usage(local_def_id);
899 tcx.ensure().check_mod_const_bodies(local_def_id);
905 // passes are timed inside typeck
906 typeck::check_crate(tcx)?;
908 sess.time("misc_checking_2", || {
911 sess.time("match_checking", || {
912 tcx.par_body_owners(|def_id| {
913 tcx.ensure().check_match(def_id.to_def_id());
918 sess.time("liveness_and_intrinsic_checking", || {
919 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
920 // this must run before MIR dump, because
921 // "not all control paths return a value" is reported here.
923 // maybe move the check to a MIR pass?
924 let local_def_id = tcx.hir().local_def_id(module);
926 tcx.ensure().check_mod_liveness(local_def_id);
927 tcx.ensure().check_mod_intrinsics(local_def_id);
934 sess.time("MIR_borrow_checking", || {
935 tcx.par_body_owners(|def_id| tcx.ensure().mir_borrowck(def_id));
938 sess.time("MIR_effect_checking", || {
939 for def_id in tcx.body_owners() {
940 mir::transform::check_unsafety::check_unsafety(tcx, def_id);
942 if tcx.hir().body_const_context(def_id).is_some() {
944 .mir_drops_elaborated_and_const_checked(ty::WithOptConstParam::unknown(def_id));
949 sess.time("layout_testing", || layout_test::test_layout(tcx));
951 // Avoid overwhelming user with errors if borrow checking failed.
952 // I'm not sure how helpful this is, to be honest, but it avoids a
953 // lot of annoying errors in the compile-fail tests (basically,
954 // lint warnings and so on -- kindck used to do this abort, but
955 // kindck is gone now). -nmatsakis
956 if sess.has_errors() {
957 return Err(ErrorReported);
960 sess.time("misc_checking_3", || {
963 tcx.ensure().privacy_access_levels(LOCAL_CRATE);
967 tcx.ensure().check_private_in_public(LOCAL_CRATE);
970 sess.time("death_checking", || rustc_passes::dead::check_crate(tcx));
973 sess.time("unused_lib_feature_checking", || {
974 rustc_passes::stability::check_unused_or_stable_features(tcx)
978 sess.time("lint_checking", || {
979 rustc_lint::check_crate(tcx, || {
980 rustc_lint::BuiltinCombinedLateLintPass::new()
987 sess.time("privacy_checking_modules", || {
988 par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| {
989 tcx.ensure().check_mod_privacy(tcx.hir().local_def_id(module));
999 fn encode_and_write_metadata(
1001 outputs: &OutputFilenames,
1002 ) -> (middle::cstore::EncodedMetadata, bool) {
1003 #[derive(PartialEq, Eq, PartialOrd, Ord)]
1010 let metadata_kind = tcx
1014 .map(|ty| match *ty {
1015 CrateType::Executable | CrateType::Staticlib | CrateType::Cdylib => MetadataKind::None,
1017 CrateType::Rlib => MetadataKind::Uncompressed,
1019 CrateType::Dylib | CrateType::ProcMacro => MetadataKind::Compressed,
1022 .unwrap_or(MetadataKind::None);
1024 let metadata = match metadata_kind {
1025 MetadataKind::None => middle::cstore::EncodedMetadata::new(),
1026 MetadataKind::Uncompressed | MetadataKind::Compressed => tcx.encode_metadata(),
1029 let _prof_timer = tcx.sess.prof.generic_activity("write_crate_metadata");
1031 let need_metadata_file = tcx.sess.opts.output_types.contains_key(&OutputType::Metadata);
1032 if need_metadata_file {
1033 let crate_name = &tcx.crate_name(LOCAL_CRATE).as_str();
1034 let out_filename = filename_for_metadata(tcx.sess, crate_name, outputs);
1035 // To avoid races with another rustc process scanning the output directory,
1036 // we need to write the file somewhere else and atomically move it to its
1037 // final destination, with an `fs::rename` call. In order for the rename to
1038 // always succeed, the temporary file needs to be on the same filesystem,
1039 // which is why we create it inside the output directory specifically.
1040 let metadata_tmpdir = TempFileBuilder::new()
1042 .tempdir_in(out_filename.parent().unwrap())
1043 .unwrap_or_else(|err| tcx.sess.fatal(&format!("couldn't create a temp dir: {}", err)));
1044 let metadata_tmpdir = MaybeTempDir::new(metadata_tmpdir, tcx.sess.opts.cg.save_temps);
1045 let metadata_filename = emit_metadata(tcx.sess, &metadata, &metadata_tmpdir);
1046 if let Err(e) = fs::rename(&metadata_filename, &out_filename) {
1047 tcx.sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
1049 if tcx.sess.opts.json_artifact_notifications {
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 info!("Pre-codegen\n{:?}", tcx.debug_stats());
1071 let (metadata, need_metadata_module) = encode_and_write_metadata(tcx, outputs);
1073 let codegen = tcx.sess.time("codegen_crate", move || {
1074 codegen_backend.codegen_crate(tcx, metadata, need_metadata_module)
1077 info!("Post-codegen\n{:?}", tcx.debug_stats());
1079 if tcx.sess.opts.output_types.contains_key(&OutputType::Mir) {
1080 if let Err(e) = mir::transform::dump_mir::emit_mir(tcx, outputs) {
1081 tcx.sess.err(&format!("could not emit MIR: {}", e));
1082 tcx.sess.abort_if_errors();