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 self.result.borrow_mut().get_or_insert_with(f).as_ref().map(|_| self).map_err(|&err| err)
39 /// Takes ownership of the query result. Further attempts to take or peek the query
40 /// result will panic unless it is generated by calling the `compute` method.
41 pub fn take(&self) -> T {
42 self.result.borrow_mut().take().expect("missing query result").unwrap()
45 /// Borrows the query result using the RefCell. Panics if the result is stolen.
46 pub fn peek(&self) -> Ref<'_, T> {
47 Ref::map(self.result.borrow(), |r| {
48 r.as_ref().unwrap().as_ref().expect("missing query result")
52 /// Mutably borrows the query result using the RefCell. Panics if the result is stolen.
53 pub fn peek_mut(&self) -> RefMut<'_, T> {
54 RefMut::map(self.result.borrow_mut(), |r| {
55 r.as_mut().unwrap().as_mut().expect("missing query result")
60 impl<T> Default for Query<T> {
61 fn default() -> Self {
62 Query { result: RefCell::new(None) }
66 pub struct Queries<'tcx> {
67 compiler: &'tcx Compiler,
68 gcx: OnceCell<GlobalCtxt<'tcx>>,
69 queries: OnceCell<TcxQueries<'tcx>>,
71 arena: WorkerLocal<Arena<'tcx>>,
72 hir_arena: WorkerLocal<rustc_hir::Arena<'tcx>>,
74 dep_graph_future: Query<Option<DepGraphFuture>>,
75 parse: Query<ast::Crate>,
76 crate_name: Query<String>,
77 register_plugins: Query<(ast::Crate, Lrc<LintStore>)>,
78 expansion: Query<(Lrc<ast::Crate>, Rc<RefCell<BoxedResolver>>, Lrc<LintStore>)>,
79 dep_graph: Query<DepGraph>,
80 prepare_outputs: Query<OutputFilenames>,
81 global_ctxt: Query<QueryContext<'tcx>>,
82 ongoing_codegen: Query<Box<dyn Any>>,
85 impl<'tcx> Queries<'tcx> {
86 pub fn new(compiler: &'tcx Compiler) -> Queries<'tcx> {
90 queries: OnceCell::new(),
91 arena: WorkerLocal::new(|_| Arena::default()),
92 hir_arena: WorkerLocal::new(|_| rustc_hir::Arena::default()),
93 dep_graph_future: Default::default(),
94 parse: Default::default(),
95 crate_name: Default::default(),
96 register_plugins: Default::default(),
97 expansion: Default::default(),
98 dep_graph: Default::default(),
99 prepare_outputs: Default::default(),
100 global_ctxt: Default::default(),
101 ongoing_codegen: Default::default(),
105 fn session(&self) -> &Lrc<Session> {
108 fn codegen_backend(&self) -> &Lrc<Box<dyn CodegenBackend>> {
109 self.compiler.codegen_backend()
112 fn dep_graph_future(&self) -> Result<&Query<Option<DepGraphFuture>>> {
113 self.dep_graph_future.compute(|| {
114 let sess = self.session();
115 Ok(sess.opts.build_dep_graph().then(|| rustc_incremental::load_dep_graph(sess)))
119 pub fn parse(&self) -> Result<&Query<ast::Crate>> {
120 self.parse.compute(|| {
121 passes::parse(self.session(), &self.compiler.input)
122 .map_err(|mut parse_error| parse_error.emit())
126 pub fn register_plugins(&self) -> Result<&Query<(ast::Crate, Lrc<LintStore>)>> {
127 self.register_plugins.compute(|| {
128 let crate_name = self.crate_name()?.peek().clone();
129 let krate = self.parse()?.take();
131 let empty: &(dyn Fn(&Session, &mut LintStore) + Sync + Send) = &|_, _| {};
132 let (krate, lint_store) = passes::register_plugins(
134 &*self.codegen_backend().metadata_loader(),
135 self.compiler.register_lints.as_deref().unwrap_or_else(|| empty),
140 // Compute the dependency graph (in the background). We want to do
141 // this as early as possible, to give the DepGraph maximum time to
142 // load before dep_graph() is called, but it also can't happen
143 // until after rustc_incremental::prepare_session_directory() is
144 // called, which happens within passes::register_plugins().
145 self.dep_graph_future().ok();
147 Ok((krate, Lrc::new(lint_store)))
151 pub fn crate_name(&self) -> Result<&Query<String>> {
152 self.crate_name.compute(|| {
154 let parse_result = self.parse()?;
155 let krate = parse_result.peek();
156 // parse `#[crate_name]` even if `--crate-name` was passed, to make sure it matches.
157 find_crate_name(self.session(), &krate.attrs, &self.compiler.input)
164 ) -> Result<&Query<(Lrc<ast::Crate>, Rc<RefCell<BoxedResolver>>, Lrc<LintStore>)>> {
166 self.expansion.compute(|| {
167 let crate_name = self.crate_name()?.peek().clone();
168 let (krate, lint_store) = self.register_plugins()?.take();
169 let _timer = self.session().timer("configure_and_expand");
170 let sess = self.session();
171 let mut resolver = passes::create_resolver(
173 self.codegen_backend().metadata_loader(),
177 let krate = resolver.access(|resolver| {
178 passes::configure_and_expand(sess, &lint_store, krate, &crate_name, resolver)
180 Ok((Lrc::new(krate), Rc::new(RefCell::new(resolver)), lint_store))
184 fn dep_graph(&self) -> Result<&Query<DepGraph>> {
185 self.dep_graph.compute(|| {
186 let sess = self.session();
187 let future_opt = self.dep_graph_future()?.take();
188 let dep_graph = future_opt
190 let (prev_graph, prev_work_products) =
191 sess.time("blocked_on_dep_graph_loading", || future.open().open(sess));
193 rustc_incremental::build_dep_graph(sess, prev_graph, prev_work_products)
195 .unwrap_or_else(DepGraph::new_disabled);
200 pub fn prepare_outputs(&self) -> Result<&Query<OutputFilenames>> {
201 self.prepare_outputs.compute(|| {
202 let (krate, boxed_resolver, _) = &*self.expansion()?.peek();
203 let crate_name = self.crate_name()?.peek();
204 passes::prepare_outputs(
214 pub fn global_ctxt(&'tcx self) -> Result<&Query<QueryContext<'tcx>>> {
215 self.global_ctxt.compute(|| {
216 let crate_name = self.crate_name()?.peek().clone();
217 let outputs = self.prepare_outputs()?.peek().clone();
218 let dep_graph = self.dep_graph()?.peek().clone();
219 let (krate, resolver, lint_store) = self.expansion()?.take();
220 Ok(passes::create_global_ctxt(
236 pub fn ongoing_codegen(&'tcx self) -> Result<&Query<Box<dyn Any>>> {
237 self.ongoing_codegen.compute(|| {
238 let outputs = self.prepare_outputs()?;
239 self.global_ctxt()?.peek_mut().enter(|tcx| {
240 tcx.analysis(()).ok();
242 // Don't do code generation if there were any errors
243 self.session().compile_status()?;
245 // If we have any delayed bugs, for example because we created TyKind::Error earlier,
246 // it's likely that codegen will only cause more ICEs, obscuring the original problem
247 self.session().diagnostic().flush_delayed();
249 // Hook for UI tests.
250 Self::check_for_rustc_errors_attr(tcx);
252 Ok(passes::start_codegen(&***self.codegen_backend(), tcx, &*outputs.peek()))
257 /// Check for the `#[rustc_error]` annotation, which forces an error in codegen. This is used
258 /// to write UI tests that actually test that compilation succeeds without reporting
260 fn check_for_rustc_errors_attr(tcx: TyCtxt<'_>) {
261 let Some((def_id, _)) = tcx.entry_fn(()) else { return };
262 for attr in tcx.get_attrs(def_id, sym::rustc_error) {
263 match attr.meta_item_list() {
264 // Check if there is a `#[rustc_error(delay_span_bug_from_inside_query)]`.
266 if list.iter().any(|list_item| {
268 list_item.ident().map(|i| i.name),
269 Some(sym::delay_span_bug_from_inside_query)
273 tcx.ensure().trigger_delay_span_bug(def_id);
276 // Bare `#[rustc_error]`.
278 tcx.sess.emit_fatal(RustcErrorFatal { span: tcx.def_span(def_id) });
281 // Some other attribute.
283 tcx.sess.emit_warning(RustcErrorUnexpectedAnnotation {
284 span: tcx.def_span(def_id),
291 pub fn linker(&'tcx self) -> Result<Linker> {
292 let sess = self.session().clone();
293 let codegen_backend = self.codegen_backend().clone();
295 let dep_graph = self.dep_graph()?.peek().clone();
296 let prepare_outputs = self.prepare_outputs()?.take();
297 let crate_hash = self.global_ctxt()?.peek_mut().enter(|tcx| tcx.crate_hash(LOCAL_CRATE));
298 let ongoing_codegen = self.ongoing_codegen()?.take();
313 // compilation inputs
315 codegen_backend: Lrc<Box<dyn CodegenBackend>>,
317 // compilation outputs
319 prepare_outputs: OutputFilenames,
321 ongoing_codegen: Box<dyn Any>,
325 pub fn link(self) -> Result<()> {
326 let (codegen_results, work_products) = self.codegen_backend.join_codegen(
327 self.ongoing_codegen,
329 &self.prepare_outputs,
332 self.sess.compile_status()?;
334 let sess = &self.sess;
335 let dep_graph = self.dep_graph;
336 sess.time("serialize_work_products", || {
337 rustc_incremental::save_work_product_index(sess, &dep_graph, work_products)
340 let prof = self.sess.prof.clone();
341 prof.generic_activity("drop_dep_graph").run(move || drop(dep_graph));
343 // Now that we won't touch anything in the incremental compilation directory
344 // any more, we can finalize it (which involves renaming it)
345 rustc_incremental::finalize_session_directory(&self.sess, self.crate_hash);
352 .any(|&i| i == OutputType::Exe || i == OutputType::Metadata)
357 if sess.opts.unstable_opts.no_link {
358 let encoded = CodegenResults::serialize_rlink(&codegen_results);
359 let rlink_file = self.prepare_outputs.with_extension(config::RLINK_EXT);
360 std::fs::write(&rlink_file, encoded)
361 .map_err(|error| sess.emit_fatal(FailedWritingFile { path: &rlink_file, error }))?;
365 let _timer = sess.prof.verbose_generic_activity("link_crate");
366 self.codegen_backend.link(&self.sess, codegen_results, &self.prepare_outputs)
371 pub fn enter<F, T>(&self, f: F) -> T
373 F: for<'tcx> FnOnce(&'tcx Queries<'tcx>) -> T,
375 let mut _timer = None;
376 let queries = Queries::new(self);
377 let ret = f(&queries);
379 // NOTE: intentionally does not compute the global context if it hasn't been built yet,
380 // since that likely means there was a parse error.
381 if let Some(Ok(gcx)) = &mut *queries.global_ctxt.result.borrow_mut() {
382 // We assume that no queries are run past here. If there are new queries
383 // after this point, they'll show up as "<unknown>" in self-profiling data.
386 queries.session().prof.generic_activity("self_profile_alloc_query_strings");
387 gcx.enter(rustc_query_impl::alloc_self_profile_query_strings);
391 .time("serialize_dep_graph", || gcx.enter(rustc_incremental::save_dep_graph));
394 _timer = Some(self.session().timer("free_global_ctxt"));