1 use crate::errors::{FailedWritingFile, RustcErrorFatal, RustcErrorUnexpectedAnnotation};
2 use crate::interface::{Compiler, Result};
3 use crate::passes::{self, BoxedResolver, QueryContext};
6 use rustc_codegen_ssa::traits::CodegenBackend;
7 use rustc_codegen_ssa::CodegenResults;
8 use rustc_data_structures::svh::Svh;
9 use rustc_data_structures::sync::{Lrc, OnceCell, WorkerLocal};
10 use rustc_hir::def_id::LOCAL_CRATE;
11 use rustc_incremental::DepGraphFuture;
12 use rustc_lint::LintStore;
13 use rustc_middle::arena::Arena;
14 use rustc_middle::dep_graph::DepGraph;
15 use rustc_middle::ty::{GlobalCtxt, TyCtxt};
16 use rustc_query_impl::Queries as TcxQueries;
17 use rustc_session::config::{self, OutputFilenames, OutputType};
18 use rustc_session::{output::find_crate_name, Session};
19 use rustc_span::symbol::sym;
21 use std::cell::{Ref, RefCell, RefMut};
24 /// Represent the result of a query.
26 /// This result can be stolen with the [`take`] method and generated with the [`compute`] method.
28 /// [`take`]: Self::take
29 /// [`compute`]: Self::compute
31 result: RefCell<Option<Result<T>>>,
35 fn compute<F: FnOnce() -> Result<T>>(&self, f: F) -> Result<&Query<T>> {
36 let mut result = self.result.borrow_mut();
40 result.as_ref().unwrap().as_ref().map(|_| self).map_err(|err| *err)
43 /// Takes ownership of the query result. Further attempts to take or peek the query
44 /// result will panic unless it is generated by calling the `compute` method.
45 pub fn take(&self) -> T {
46 self.result.borrow_mut().take().expect("missing query result").unwrap()
49 /// Borrows the query result using the RefCell. Panics if the result is stolen.
50 pub fn peek(&self) -> Ref<'_, T> {
51 Ref::map(self.result.borrow(), |r| {
52 r.as_ref().unwrap().as_ref().expect("missing query result")
56 /// Mutably borrows the query result using the RefCell. Panics if the result is stolen.
57 pub fn peek_mut(&self) -> RefMut<'_, T> {
58 RefMut::map(self.result.borrow_mut(), |r| {
59 r.as_mut().unwrap().as_mut().expect("missing query result")
64 impl<T> Default for Query<T> {
65 fn default() -> Self {
66 Query { result: RefCell::new(None) }
70 pub struct Queries<'tcx> {
71 compiler: &'tcx Compiler,
72 gcx: OnceCell<GlobalCtxt<'tcx>>,
73 queries: OnceCell<TcxQueries<'tcx>>,
75 arena: WorkerLocal<Arena<'tcx>>,
76 hir_arena: WorkerLocal<rustc_hir::Arena<'tcx>>,
78 dep_graph_future: Query<Option<DepGraphFuture>>,
79 parse: Query<ast::Crate>,
80 crate_name: Query<String>,
81 register_plugins: Query<(ast::Crate, Lrc<LintStore>)>,
82 expansion: Query<(Lrc<ast::Crate>, Rc<RefCell<BoxedResolver>>, Lrc<LintStore>)>,
83 dep_graph: Query<DepGraph>,
84 prepare_outputs: Query<OutputFilenames>,
85 global_ctxt: Query<QueryContext<'tcx>>,
86 ongoing_codegen: Query<Box<dyn Any>>,
89 impl<'tcx> Queries<'tcx> {
90 pub fn new(compiler: &'tcx Compiler) -> Queries<'tcx> {
94 queries: OnceCell::new(),
95 arena: WorkerLocal::new(|_| Arena::default()),
96 hir_arena: WorkerLocal::new(|_| rustc_hir::Arena::default()),
97 dep_graph_future: Default::default(),
98 parse: Default::default(),
99 crate_name: Default::default(),
100 register_plugins: Default::default(),
101 expansion: Default::default(),
102 dep_graph: Default::default(),
103 prepare_outputs: Default::default(),
104 global_ctxt: Default::default(),
105 ongoing_codegen: Default::default(),
109 fn session(&self) -> &Lrc<Session> {
112 fn codegen_backend(&self) -> &Lrc<Box<dyn CodegenBackend>> {
113 self.compiler.codegen_backend()
116 fn dep_graph_future(&self) -> Result<&Query<Option<DepGraphFuture>>> {
117 self.dep_graph_future.compute(|| {
118 let sess = self.session();
119 Ok(sess.opts.build_dep_graph().then(|| rustc_incremental::load_dep_graph(sess)))
123 pub fn parse(&self) -> Result<&Query<ast::Crate>> {
124 self.parse.compute(|| {
125 passes::parse(self.session(), &self.compiler.input)
126 .map_err(|mut parse_error| parse_error.emit())
130 pub fn register_plugins(&self) -> Result<&Query<(ast::Crate, Lrc<LintStore>)>> {
131 self.register_plugins.compute(|| {
132 let crate_name = self.crate_name()?.peek().clone();
133 let krate = self.parse()?.take();
135 let empty: &(dyn Fn(&Session, &mut LintStore) + Sync + Send) = &|_, _| {};
136 let (krate, lint_store) = passes::register_plugins(
138 &*self.codegen_backend().metadata_loader(),
139 self.compiler.register_lints.as_deref().unwrap_or_else(|| empty),
144 // Compute the dependency graph (in the background). We want to do
145 // this as early as possible, to give the DepGraph maximum time to
146 // load before dep_graph() is called, but it also can't happen
147 // until after rustc_incremental::prepare_session_directory() is
148 // called, which happens within passes::register_plugins().
149 self.dep_graph_future().ok();
151 Ok((krate, Lrc::new(lint_store)))
155 pub fn crate_name(&self) -> Result<&Query<String>> {
156 self.crate_name.compute(|| {
158 let parse_result = self.parse()?;
159 let krate = parse_result.peek();
160 // parse `#[crate_name]` even if `--crate-name` was passed, to make sure it matches.
161 find_crate_name(self.session(), &krate.attrs, &self.compiler.input)
168 ) -> Result<&Query<(Lrc<ast::Crate>, Rc<RefCell<BoxedResolver>>, Lrc<LintStore>)>> {
170 self.expansion.compute(|| {
171 let crate_name = self.crate_name()?.peek().clone();
172 let (krate, lint_store) = self.register_plugins()?.take();
173 let _timer = self.session().timer("configure_and_expand");
174 let sess = self.session();
175 let mut resolver = passes::create_resolver(
177 self.codegen_backend().metadata_loader(),
181 let krate = resolver.access(|resolver| {
182 passes::configure_and_expand(sess, &lint_store, krate, &crate_name, resolver)
184 Ok((Lrc::new(krate), Rc::new(RefCell::new(resolver)), lint_store))
188 fn dep_graph(&self) -> Result<&Query<DepGraph>> {
189 self.dep_graph.compute(|| {
190 let sess = self.session();
191 let future_opt = self.dep_graph_future()?.take();
192 let dep_graph = future_opt
194 let (prev_graph, prev_work_products) =
195 sess.time("blocked_on_dep_graph_loading", || future.open().open(sess));
197 rustc_incremental::build_dep_graph(sess, prev_graph, prev_work_products)
199 .unwrap_or_else(DepGraph::new_disabled);
204 pub fn prepare_outputs(&self) -> Result<&Query<OutputFilenames>> {
205 self.prepare_outputs.compute(|| {
206 let (krate, boxed_resolver, _) = &*self.expansion()?.peek();
207 let crate_name = self.crate_name()?.peek();
208 passes::prepare_outputs(
218 pub fn global_ctxt(&'tcx self) -> Result<&Query<QueryContext<'tcx>>> {
219 self.global_ctxt.compute(|| {
220 let crate_name = self.crate_name()?.peek().clone();
221 let outputs = self.prepare_outputs()?.peek().clone();
222 let dep_graph = self.dep_graph()?.peek().clone();
223 let (krate, resolver, lint_store) = self.expansion()?.take();
224 Ok(passes::create_global_ctxt(
240 pub fn ongoing_codegen(&'tcx self) -> Result<&Query<Box<dyn Any>>> {
241 self.ongoing_codegen.compute(|| {
242 let outputs = self.prepare_outputs()?;
243 self.global_ctxt()?.peek_mut().enter(|tcx| {
244 tcx.analysis(()).ok();
246 // Don't do code generation if there were any errors
247 self.session().compile_status()?;
249 self.session().diagnostic().flush_delayed();
251 // Hook for UI tests.
252 Self::check_for_rustc_errors_attr(tcx);
254 Ok(passes::start_codegen(&***self.codegen_backend(), tcx, &*outputs.peek()))
259 /// Check for the `#[rustc_error]` annotation, which forces an error in codegen. This is used
260 /// to write UI tests that actually test that compilation succeeds without reporting
262 fn check_for_rustc_errors_attr(tcx: TyCtxt<'_>) {
263 let Some((def_id, _)) = tcx.entry_fn(()) else { return };
264 for attr in tcx.get_attrs(def_id, sym::rustc_error) {
265 match attr.meta_item_list() {
266 // Check if there is a `#[rustc_error(delay_span_bug_from_inside_query)]`.
268 if list.iter().any(|list_item| {
270 list_item.ident().map(|i| i.name),
271 Some(sym::delay_span_bug_from_inside_query)
275 tcx.ensure().trigger_delay_span_bug(def_id);
278 // Bare `#[rustc_error]`.
280 tcx.sess.emit_fatal(RustcErrorFatal { span: tcx.def_span(def_id) });
283 // Some other attribute.
285 tcx.sess.emit_warning(RustcErrorUnexpectedAnnotation {
286 span: tcx.def_span(def_id),
293 pub fn linker(&'tcx self) -> Result<Linker> {
294 let sess = self.session().clone();
295 let codegen_backend = self.codegen_backend().clone();
297 let dep_graph = self.dep_graph()?.peek().clone();
298 let prepare_outputs = self.prepare_outputs()?.take();
299 let crate_hash = self.global_ctxt()?.peek_mut().enter(|tcx| tcx.crate_hash(LOCAL_CRATE));
300 let ongoing_codegen = self.ongoing_codegen()?.take();
315 // compilation inputs
317 codegen_backend: Lrc<Box<dyn CodegenBackend>>,
319 // compilation outputs
321 prepare_outputs: OutputFilenames,
323 ongoing_codegen: Box<dyn Any>,
327 pub fn link(self) -> Result<()> {
328 let (codegen_results, work_products) = self.codegen_backend.join_codegen(
329 self.ongoing_codegen,
331 &self.prepare_outputs,
334 self.sess.compile_status()?;
336 let sess = &self.sess;
337 let dep_graph = self.dep_graph;
338 sess.time("serialize_work_products", || {
339 rustc_incremental::save_work_product_index(sess, &dep_graph, work_products)
342 let prof = self.sess.prof.clone();
343 prof.generic_activity("drop_dep_graph").run(move || drop(dep_graph));
345 // Now that we won't touch anything in the incremental compilation directory
346 // any more, we can finalize it (which involves renaming it)
347 rustc_incremental::finalize_session_directory(&self.sess, self.crate_hash);
354 .any(|&i| i == OutputType::Exe || i == OutputType::Metadata)
359 if sess.opts.unstable_opts.no_link {
360 let encoded = CodegenResults::serialize_rlink(&codegen_results);
361 let rlink_file = self.prepare_outputs.with_extension(config::RLINK_EXT);
362 std::fs::write(&rlink_file, encoded)
363 .map_err(|error| sess.emit_fatal(FailedWritingFile { path: &rlink_file, error }))?;
367 let _timer = sess.prof.verbose_generic_activity("link_crate");
368 self.codegen_backend.link(&self.sess, codegen_results, &self.prepare_outputs)
373 pub fn enter<F, T>(&self, f: F) -> T
375 F: for<'tcx> FnOnce(&'tcx Queries<'tcx>) -> T,
377 let mut _timer = None;
378 let queries = Queries::new(self);
379 let ret = f(&queries);
381 // NOTE: intentionally does not compute the global context if it hasn't been built yet,
382 // since that likely means there was a parse error.
383 if let Some(Ok(gcx)) = &mut *queries.global_ctxt.result.borrow_mut() {
384 // We assume that no queries are run past here. If there are new queries
385 // after this point, they'll show up as "<unknown>" in self-profiling data.
388 queries.session().prof.generic_activity("self_profile_alloc_query_strings");
389 gcx.enter(rustc_query_impl::alloc_self_profile_query_strings);
393 .time("serialize_dep_graph", || gcx.enter(rustc_incremental::save_dep_graph));
396 _timer = Some(self.session().timer("free_global_ctxt"));