use crate::interface::{Compiler, Result}; use crate::passes::{self, BoxedResolver, QueryContext}; use rustc_ast as ast; use rustc_codegen_ssa::traits::CodegenBackend; use rustc_data_structures::sync::{Lrc, OnceCell, WorkerLocal}; use rustc_errors::ErrorReported; use rustc_hir::def_id::LOCAL_CRATE; use rustc_hir::Crate; use rustc_incremental::DepGraphFuture; use rustc_lint::LintStore; use rustc_middle::arena::Arena; use rustc_middle::dep_graph::DepGraph; use rustc_middle::ty::steal::Steal; use rustc_middle::ty::{GlobalCtxt, ResolverOutputs, TyCtxt}; use rustc_session::config::{OutputFilenames, OutputType}; use rustc_session::{output::find_crate_name, Session}; use rustc_span::symbol::sym; use std::any::Any; use std::cell::{Ref, RefCell, RefMut}; use std::rc::Rc; /// Represent the result of a query. /// This result can be stolen with the `take` method and generated with the `compute` method. pub struct Query { result: RefCell>>, } impl Query { fn compute Result>(&self, f: F) -> Result<&Query> { let mut result = self.result.borrow_mut(); if result.is_none() { *result = Some(f()); } result.as_ref().unwrap().as_ref().map(|_| self).map_err(|err| *err) } /// Takes ownership of the query result. Further attempts to take or peek the query /// result will panic unless it is generated by calling the `compute` method. pub fn take(&self) -> T { self.result.borrow_mut().take().expect("missing query result").unwrap() } /// Borrows the query result using the RefCell. Panics if the result is stolen. pub fn peek(&self) -> Ref<'_, T> { Ref::map(self.result.borrow(), |r| { r.as_ref().unwrap().as_ref().expect("missing query result") }) } /// Mutably borrows the query result using the RefCell. Panics if the result is stolen. pub fn peek_mut(&self) -> RefMut<'_, T> { RefMut::map(self.result.borrow_mut(), |r| { r.as_mut().unwrap().as_mut().expect("missing query result") }) } } impl Default for Query { fn default() -> Self { Query { result: RefCell::new(None) } } } pub struct Queries<'tcx> { compiler: &'tcx Compiler, gcx: OnceCell>, arena: WorkerLocal>, hir_arena: WorkerLocal>, dep_graph_future: Query>, parse: Query, crate_name: Query, register_plugins: Query<(ast::Crate, Lrc)>, expansion: Query<(ast::Crate, Steal>>, Lrc)>, dep_graph: Query, lower_to_hir: Query<(&'tcx Crate<'tcx>, Steal)>, prepare_outputs: Query, global_ctxt: Query>, ongoing_codegen: Query>, } impl<'tcx> Queries<'tcx> { pub fn new(compiler: &'tcx Compiler) -> Queries<'tcx> { Queries { compiler, gcx: OnceCell::new(), arena: WorkerLocal::new(|_| Arena::default()), hir_arena: WorkerLocal::new(|_| rustc_ast_lowering::Arena::default()), dep_graph_future: Default::default(), parse: Default::default(), crate_name: Default::default(), register_plugins: Default::default(), expansion: Default::default(), dep_graph: Default::default(), lower_to_hir: Default::default(), prepare_outputs: Default::default(), global_ctxt: Default::default(), ongoing_codegen: Default::default(), } } fn session(&self) -> &Lrc { &self.compiler.sess } fn codegen_backend(&self) -> &Lrc> { &self.compiler.codegen_backend() } pub fn dep_graph_future(&self) -> Result<&Query>> { self.dep_graph_future.compute(|| { Ok(self .session() .opts .build_dep_graph() .then(|| rustc_incremental::load_dep_graph(self.session()))) }) } pub fn parse(&self) -> Result<&Query> { self.parse.compute(|| { passes::parse(self.session(), &self.compiler.input).map_err(|mut parse_error| { parse_error.emit(); ErrorReported }) }) } pub fn register_plugins(&self) -> Result<&Query<(ast::Crate, Lrc)>> { self.register_plugins.compute(|| { let crate_name = self.crate_name()?.peek().clone(); let krate = self.parse()?.take(); let empty: &(dyn Fn(&Session, &mut LintStore) + Sync + Send) = &|_, _| {}; let result = passes::register_plugins( self.session(), &*self.codegen_backend().metadata_loader(), self.compiler.register_lints.as_deref().unwrap_or_else(|| empty), krate, &crate_name, ); // Compute the dependency graph (in the background). We want to do // this as early as possible, to give the DepGraph maximum time to // load before dep_graph() is called, but it also can't happen // until after rustc_incremental::prepare_session_directory() is // called, which happens within passes::register_plugins(). self.dep_graph_future().ok(); result }) } pub fn crate_name(&self) -> Result<&Query> { self.crate_name.compute(|| { Ok(match self.compiler.crate_name { Some(ref crate_name) => crate_name.clone(), None => { let parse_result = self.parse()?; let krate = parse_result.peek(); find_crate_name(self.session(), &krate.attrs, &self.compiler.input) } }) }) } pub fn expansion( &self, ) -> Result<&Query<(ast::Crate, Steal>>, Lrc)>> { tracing::trace!("expansion"); self.expansion.compute(|| { let crate_name = self.crate_name()?.peek().clone(); let (krate, lint_store) = self.register_plugins()?.take(); let _timer = self.session().timer("configure_and_expand"); passes::configure_and_expand( self.session().clone(), lint_store.clone(), self.codegen_backend().metadata_loader(), krate, &crate_name, ) .map(|(krate, resolver)| { (krate, Steal::new(Rc::new(RefCell::new(resolver))), lint_store) }) }) } pub fn dep_graph(&self) -> Result<&Query> { self.dep_graph.compute(|| { Ok(match self.dep_graph_future()?.take() { None => DepGraph::new_disabled(), Some(future) => { let (prev_graph, prev_work_products) = self.session().time("blocked_on_dep_graph_loading", || { future .open() .unwrap_or_else(|e| rustc_incremental::LoadResult::Error { message: format!("could not decode incremental cache: {:?}", e), }) .open(self.session()) }); DepGraph::new(prev_graph, prev_work_products) } }) }) } pub fn lower_to_hir(&'tcx self) -> Result<&Query<(&'tcx Crate<'tcx>, Steal)>> { self.lower_to_hir.compute(|| { let expansion_result = self.expansion()?; let peeked = expansion_result.peek(); let krate = &peeked.0; let resolver = peeked.1.steal(); let lint_store = &peeked.2; let hir = resolver.borrow_mut().access(|resolver| { Ok(passes::lower_to_hir( self.session(), lint_store, resolver, &*self.dep_graph()?.peek(), &krate, &self.hir_arena, )) })?; let hir = self.hir_arena.alloc(hir); Ok((hir, Steal::new(BoxedResolver::to_resolver_outputs(resolver)))) }) } pub fn prepare_outputs(&self) -> Result<&Query> { self.prepare_outputs.compute(|| { let expansion_result = self.expansion()?; let (krate, boxed_resolver, _) = &*expansion_result.peek(); let crate_name = self.crate_name()?; let crate_name = crate_name.peek(); passes::prepare_outputs( self.session(), self.compiler, &krate, &boxed_resolver, &crate_name, ) }) } pub fn global_ctxt(&'tcx self) -> Result<&Query>> { self.global_ctxt.compute(|| { let crate_name = self.crate_name()?.peek().clone(); let outputs = self.prepare_outputs()?.peek().clone(); let lint_store = self.expansion()?.peek().2.clone(); let hir = self.lower_to_hir()?.peek(); let dep_graph = self.dep_graph()?.peek().clone(); let (ref krate, ref resolver_outputs) = &*hir; let _timer = self.session().timer("create_global_ctxt"); Ok(passes::create_global_ctxt( self.compiler, lint_store, krate, dep_graph, resolver_outputs.steal(), outputs, &crate_name, &self.gcx, &self.arena, )) }) } pub fn ongoing_codegen(&'tcx self) -> Result<&Query>> { self.ongoing_codegen.compute(|| { let outputs = self.prepare_outputs()?; self.global_ctxt()?.peek_mut().enter(|tcx| { tcx.analysis(LOCAL_CRATE).ok(); // Don't do code generation if there were any errors self.session().compile_status()?; // Hook for compile-fail tests. Self::check_for_rustc_errors_attr(tcx); Ok(passes::start_codegen(&***self.codegen_backend(), tcx, &*outputs.peek())) }) }) } /// Check for the `#[rustc_error]` annotation, which forces an error in codegen. This is used /// to write compile-fail tests that actually test that compilation succeeds without reporting /// an error. fn check_for_rustc_errors_attr(tcx: TyCtxt<'_>) { let def_id = match tcx.entry_fn(LOCAL_CRATE) { Some((def_id, _)) => def_id, _ => return, }; let attrs = &*tcx.get_attrs(def_id.to_def_id()); let attrs = attrs.iter().filter(|attr| tcx.sess.check_name(attr, sym::rustc_error)); for attr in attrs { match attr.meta_item_list() { // Check if there is a `#[rustc_error(delay_span_bug_from_inside_query)]`. Some(list) if list.iter().any(|list_item| { matches!( list_item.ident().map(|i| i.name), Some(sym::delay_span_bug_from_inside_query) ) }) => { tcx.ensure().trigger_delay_span_bug(def_id); } // Bare `#[rustc_error]`. None => { tcx.sess.span_fatal( tcx.def_span(def_id), "fatal error triggered by #[rustc_error]", ); } // Some other attribute. Some(_) => { tcx.sess.span_warn( tcx.def_span(def_id), "unexpected annotation used with `#[rustc_error(...)]!", ); } } } } pub fn linker(&'tcx self) -> Result { let dep_graph = self.dep_graph()?; let prepare_outputs = self.prepare_outputs()?; let ongoing_codegen = self.ongoing_codegen()?; let sess = self.session().clone(); let codegen_backend = self.codegen_backend().clone(); Ok(Linker { sess, dep_graph: dep_graph.peek().clone(), prepare_outputs: prepare_outputs.take(), ongoing_codegen: ongoing_codegen.take(), codegen_backend, }) } } pub struct Linker { sess: Lrc, dep_graph: DepGraph, prepare_outputs: OutputFilenames, ongoing_codegen: Box, codegen_backend: Lrc>, } impl Linker { pub fn link(self) -> Result<()> { let codegen_results = self.codegen_backend.join_codegen(self.ongoing_codegen, &self.sess, &self.dep_graph)?; let prof = self.sess.prof.clone(); let dep_graph = self.dep_graph; prof.generic_activity("drop_dep_graph").run(move || drop(dep_graph)); if !self .sess .opts .output_types .keys() .any(|&i| i == OutputType::Exe || i == OutputType::Metadata) { return Ok(()); } self.codegen_backend.link(&self.sess, codegen_results, &self.prepare_outputs) } } impl Compiler { pub fn enter(&self, f: F) -> T where F: for<'tcx> FnOnce(&'tcx Queries<'tcx>) -> T, { let mut _timer = None; let queries = Queries::new(&self); let ret = f(&queries); if self.session().opts.debugging_opts.query_stats { if let Ok(gcx) = queries.global_ctxt() { gcx.peek_mut().print_stats(); } } _timer = Some(self.session().timer("free_global_ctxt")); ret } }