compiler/rustc_interface/src/queries.rs

   1 use crate::interface::{Compiler, Result};
   2 use crate::passes::{self, BoxedResolver, QueryContext};
   3
   4 use rustc_ast as ast;
   5 use rustc_codegen_ssa::traits::CodegenBackend;
   6 use rustc_data_structures::steal::Steal;
   7 use rustc_data_structures::svh::Svh;
   8 use rustc_data_structures::sync::{Lrc, OnceCell, WorkerLocal};
   9 use rustc_errors::ErrorReported;
  10 use rustc_hir::def_id::LOCAL_CRATE;
  11 use rustc_hir::Crate;
  12 use rustc_incremental::DepGraphFuture;
  13 use rustc_lint::LintStore;
  14 use rustc_middle::arena::Arena;
  15 use rustc_middle::dep_graph::DepGraph;
  16 use rustc_middle::ty::{GlobalCtxt, ResolverOutputs, TyCtxt};
  17 use rustc_serialize::json;
  18 use rustc_session::config::{self, OutputFilenames, OutputType};
  19 use rustc_session::{output::find_crate_name, Session};
  20 use rustc_span::symbol::sym;
  21 use std::any::Any;
  22 use std::cell::{Ref, RefCell, RefMut};
  23 use std::rc::Rc;
  24
  25 /// Represent the result of a query.
  26 /// This result can be stolen with the `take` method and generated with the `compute` method.
  27 pub struct Query<T> {
  28     result: RefCell<Option<Result<T>>>,
  29 }
  30
  31 impl<T> Query<T> {
  32     fn compute<F: FnOnce() -> Result<T>>(&self, f: F) -> Result<&Query<T>> {
  33         let mut result = self.result.borrow_mut();
  34         if result.is_none() {
  35             *result = Some(f());
  36         }
  37         result.as_ref().unwrap().as_ref().map(|_| self).map_err(|err| *err)
  38     }
  39
  40     /// Takes ownership of the query result. Further attempts to take or peek the query
  41     /// result will panic unless it is generated by calling the `compute` method.
  42     pub fn take(&self) -> T {
  43         self.result.borrow_mut().take().expect("missing query result").unwrap()
  44     }
  45
  46     /// Borrows the query result using the RefCell. Panics if the result is stolen.
  47     pub fn peek(&self) -> Ref<'_, T> {
  48         Ref::map(self.result.borrow(), |r| {
  49             r.as_ref().unwrap().as_ref().expect("missing query result")
  50         })
  51     }
  52
  53     /// Mutably borrows the query result using the RefCell. Panics if the result is stolen.
  54     pub fn peek_mut(&self) -> RefMut<'_, T> {
  55         RefMut::map(self.result.borrow_mut(), |r| {
  56             r.as_mut().unwrap().as_mut().expect("missing query result")
  57         })
  58     }
  59 }
  60
  61 impl<T> Default for Query<T> {
  62     fn default() -> Self {
  63         Query { result: RefCell::new(None) }
  64     }
  65 }
  66
  67 pub struct Queries<'tcx> {
  68     compiler: &'tcx Compiler,
  69     gcx: OnceCell<GlobalCtxt<'tcx>>,
  70
  71     arena: WorkerLocal<Arena<'tcx>>,
  72     hir_arena: WorkerLocal<rustc_ast_lowering::Arena<'tcx>>,
  73
  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<(ast::Crate, Steal<Rc<RefCell<BoxedResolver>>>, Lrc<LintStore>)>,
  79     dep_graph: Query<DepGraph>,
  80     lower_to_hir: Query<(&'tcx Crate<'tcx>, Steal<ResolverOutputs>)>,
  81     prepare_outputs: Query<OutputFilenames>,
  82     global_ctxt: Query<QueryContext<'tcx>>,
  83     ongoing_codegen: Query<Box<dyn Any>>,
  84 }
  85
  86 impl<'tcx> Queries<'tcx> {
  87     pub fn new(compiler: &'tcx Compiler) -> Queries<'tcx> {
  88         Queries {
  89             compiler,
  90             gcx: OnceCell::new(),
  91             arena: WorkerLocal::new(|_| Arena::default()),
  92             hir_arena: WorkerLocal::new(|_| rustc_ast_lowering::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             lower_to_hir: Default::default(),
 100             prepare_outputs: Default::default(),
 101             global_ctxt: Default::default(),
 102             ongoing_codegen: Default::default(),
 103         }
 104     }
 105
 106     fn session(&self) -> &Lrc<Session> {
 107         &self.compiler.sess
 108     }
 109     fn codegen_backend(&self) -> &Lrc<Box<dyn CodegenBackend>> {
 110         &self.compiler.codegen_backend()
 111     }
 112
 113     pub fn dep_graph_future(&self) -> Result<&Query<Option<DepGraphFuture>>> {
 114         self.dep_graph_future.compute(|| {
 115             Ok(self
 116                 .session()
 117                 .opts
 118                 .build_dep_graph()
 119                 .then(|| rustc_incremental::load_dep_graph(self.session())))
 120         })
 121     }
 122
 123     pub fn parse(&self) -> Result<&Query<ast::Crate>> {
 124         self.parse.compute(|| {
 125             passes::parse(self.session(), &self.compiler.input).map_err(|mut parse_error| {
 126                 parse_error.emit();
 127                 ErrorReported
 128             })
 129         })
 130     }
 131
 132     pub fn register_plugins(&self) -> Result<&Query<(ast::Crate, Lrc<LintStore>)>> {
 133         self.register_plugins.compute(|| {
 134             let crate_name = self.crate_name()?.peek().clone();
 135             let krate = self.parse()?.take();
 136
 137             let empty: &(dyn Fn(&Session, &mut LintStore) + Sync + Send) = &|_, _| {};
 138             let result = passes::register_plugins(
 139                 self.session(),
 140                 &*self.codegen_backend().metadata_loader(),
 141                 self.compiler.register_lints.as_deref().unwrap_or_else(|| empty),
 142                 krate,
 143                 &crate_name,
 144             );
 145
 146             // Compute the dependency graph (in the background). We want to do
 147             // this as early as possible, to give the DepGraph maximum time to
 148             // load before dep_graph() is called, but it also can't happen
 149             // until after rustc_incremental::prepare_session_directory() is
 150             // called, which happens within passes::register_plugins().
 151             self.dep_graph_future().ok();
 152
 153             result
 154         })
 155     }
 156
 157     pub fn crate_name(&self) -> Result<&Query<String>> {
 158         self.crate_name.compute(|| {
 159             Ok({
 160                 let parse_result = self.parse()?;
 161                 let krate = parse_result.peek();
 162                 // parse `#[crate_name]` even if `--crate-name` was passed, to make sure it matches.
 163                 find_crate_name(self.session(), &krate.attrs, &self.compiler.input)
 164             })
 165         })
 166     }
 167
 168     pub fn expansion(
 169         &self,
 170     ) -> Result<&Query<(ast::Crate, Steal<Rc<RefCell<BoxedResolver>>>, Lrc<LintStore>)>> {
 171         tracing::trace!("expansion");
 172         self.expansion.compute(|| {
 173             let crate_name = self.crate_name()?.peek().clone();
 174             let (krate, lint_store) = self.register_plugins()?.take();
 175             let _timer = self.session().timer("configure_and_expand");
 176             passes::configure_and_expand(
 177                 self.session().clone(),
 178                 lint_store.clone(),
 179                 self.codegen_backend().metadata_loader(),
 180                 krate,
 181                 &crate_name,
 182             )
 183             .map(|(krate, resolver)| {
 184                 (krate, Steal::new(Rc::new(RefCell::new(resolver))), lint_store)
 185             })
 186         })
 187     }
 188
 189     pub fn dep_graph(&self) -> Result<&Query<DepGraph>> {
 190         self.dep_graph.compute(|| {
 191             Ok(match self.dep_graph_future()?.take() {
 192                 None => DepGraph::new_disabled(),
 193                 Some(future) => {
 194                     let (prev_graph, prev_work_products) =
 195                         self.session().time("blocked_on_dep_graph_loading", || {
 196                             future
 197                                 .open()
 198                                 .unwrap_or_else(|e| rustc_incremental::LoadResult::Error {
 199                                     message: format!("could not decode incremental cache: {:?}", e),
 200                                 })
 201                                 .open(self.session())
 202                         });
 203                     DepGraph::new(prev_graph, prev_work_products)
 204                 }
 205             })
 206         })
 207     }
 208
 209     pub fn lower_to_hir(&'tcx self) -> Result<&Query<(&'tcx Crate<'tcx>, Steal<ResolverOutputs>)>> {
 210         self.lower_to_hir.compute(|| {
 211             let expansion_result = self.expansion()?;
 212             let peeked = expansion_result.peek();
 213             let krate = &peeked.0;
 214             let resolver = peeked.1.steal();
 215             let lint_store = &peeked.2;
 216             let hir = resolver.borrow_mut().access(|resolver| {
 217                 Ok(passes::lower_to_hir(
 218                     self.session(),
 219                     lint_store,
 220                     resolver,
 221                     &*self.dep_graph()?.peek(),
 222                     &krate,
 223                     &self.hir_arena,
 224                 ))
 225             })?;
 226             let hir = self.hir_arena.alloc(hir);
 227             Ok((hir, Steal::new(BoxedResolver::to_resolver_outputs(resolver))))
 228         })
 229     }
 230
 231     pub fn prepare_outputs(&self) -> Result<&Query<OutputFilenames>> {
 232         self.prepare_outputs.compute(|| {
 233             let expansion_result = self.expansion()?;
 234             let (krate, boxed_resolver, _) = &*expansion_result.peek();
 235             let crate_name = self.crate_name()?;
 236             let crate_name = crate_name.peek();
 237             passes::prepare_outputs(
 238                 self.session(),
 239                 self.compiler,
 240                 &krate,
 241                 &boxed_resolver,
 242                 &crate_name,
 243             )
 244         })
 245     }
 246
 247     pub fn global_ctxt(&'tcx self) -> Result<&Query<QueryContext<'tcx>>> {
 248         self.global_ctxt.compute(|| {
 249             let crate_name = self.crate_name()?.peek().clone();
 250             let outputs = self.prepare_outputs()?.peek().clone();
 251             let lint_store = self.expansion()?.peek().2.clone();
 252             let hir = self.lower_to_hir()?.peek();
 253             let dep_graph = self.dep_graph()?.peek().clone();
 254             let (ref krate, ref resolver_outputs) = &*hir;
 255             let _timer = self.session().timer("create_global_ctxt");
 256             Ok(passes::create_global_ctxt(
 257                 self.compiler,
 258                 lint_store,
 259                 krate,
 260                 dep_graph,
 261                 resolver_outputs.steal(),
 262                 outputs,
 263                 &crate_name,
 264                 &self.gcx,
 265                 &self.arena,
 266             ))
 267         })
 268     }
 269
 270     pub fn ongoing_codegen(&'tcx self) -> Result<&Query<Box<dyn Any>>> {
 271         self.ongoing_codegen.compute(|| {
 272             let outputs = self.prepare_outputs()?;
 273             self.global_ctxt()?.peek_mut().enter(|tcx| {
 274                 tcx.analysis(LOCAL_CRATE).ok();
 275
 276                 // Don't do code generation if there were any errors
 277                 self.session().compile_status()?;
 278
 279                 // Hook for compile-fail tests.
 280                 Self::check_for_rustc_errors_attr(tcx);
 281
 282                 Ok(passes::start_codegen(&***self.codegen_backend(), tcx, &*outputs.peek()))
 283             })
 284         })
 285     }
 286
 287     /// Check for the `#[rustc_error]` annotation, which forces an error in codegen. This is used
 288     /// to write compile-fail tests that actually test that compilation succeeds without reporting
 289     /// an error.
 290     fn check_for_rustc_errors_attr(tcx: TyCtxt<'_>) {
 291         let def_id = match tcx.entry_fn(LOCAL_CRATE) {
 292             Some((def_id, _)) => def_id,
 293             _ => return,
 294         };
 295
 296         let attrs = &*tcx.get_attrs(def_id.to_def_id());
 297         let attrs = attrs.iter().filter(|attr| tcx.sess.check_name(attr, sym::rustc_error));
 298         for attr in attrs {
 299             match attr.meta_item_list() {
 300                 // Check if there is a `#[rustc_error(delay_span_bug_from_inside_query)]`.
 301                 Some(list)
 302                     if list.iter().any(|list_item| {
 303                         matches!(
 304                             list_item.ident().map(|i| i.name),
 305                             Some(sym::delay_span_bug_from_inside_query)
 306                         )
 307                     }) =>
 308                 {
 309                     tcx.ensure().trigger_delay_span_bug(def_id);
 310                 }
 311
 312                 // Bare `#[rustc_error]`.
 313                 None => {
 314                     tcx.sess.span_fatal(
 315                         tcx.def_span(def_id),
 316                         "fatal error triggered by #[rustc_error]",
 317                     );
 318                 }
 319
 320                 // Some other attribute.
 321                 Some(_) => {
 322                     tcx.sess.span_warn(
 323                         tcx.def_span(def_id),
 324                         "unexpected annotation used with `#[rustc_error(...)]!",
 325                     );
 326                 }
 327             }
 328         }
 329     }
 330
 331     pub fn linker(&'tcx self) -> Result<Linker> {
 332         let dep_graph = self.dep_graph()?;
 333         let prepare_outputs = self.prepare_outputs()?;
 334         let crate_hash = self.global_ctxt()?.peek_mut().enter(|tcx| tcx.crate_hash(LOCAL_CRATE));
 335         let ongoing_codegen = self.ongoing_codegen()?;
 336
 337         let sess = self.session().clone();
 338         let codegen_backend = self.codegen_backend().clone();
 339
 340         Ok(Linker {
 341             sess,
 342             dep_graph: dep_graph.peek().clone(),
 343             prepare_outputs: prepare_outputs.take(),
 344             crate_hash,
 345             ongoing_codegen: ongoing_codegen.take(),
 346             codegen_backend,
 347         })
 348     }
 349 }
 350
 351 pub struct Linker {
 352     sess: Lrc<Session>,
 353     dep_graph: DepGraph,
 354     prepare_outputs: OutputFilenames,
 355     crate_hash: Svh,
 356     ongoing_codegen: Box<dyn Any>,
 357     codegen_backend: Lrc<Box<dyn CodegenBackend>>,
 358 }
 359
 360 impl Linker {
 361     pub fn link(self) -> Result<()> {
 362         let (codegen_results, work_products) =
 363             self.codegen_backend.join_codegen(self.ongoing_codegen, &self.sess)?;
 364
 365         self.sess.compile_status()?;
 366
 367         let sess = &self.sess;
 368         let dep_graph = self.dep_graph;
 369         sess.time("serialize_work_products", || {
 370             rustc_incremental::save_work_product_index(&sess, &dep_graph, work_products)
 371         });
 372
 373         let prof = self.sess.prof.clone();
 374         prof.generic_activity("drop_dep_graph").run(move || drop(dep_graph));
 375
 376         // Now that we won't touch anything in the incremental compilation directory
 377         // any more, we can finalize it (which involves renaming it)
 378         rustc_incremental::finalize_session_directory(&self.sess, self.crate_hash);
 379
 380         if !self
 381             .sess
 382             .opts
 383             .output_types
 384             .keys()
 385             .any(|&i| i == OutputType::Exe || i == OutputType::Metadata)
 386         {
 387             return Ok(());
 388         }
 389
 390         if sess.opts.debugging_opts.no_link {
 391             // FIXME: use a binary format to encode the `.rlink` file
 392             let rlink_data = json::encode(&codegen_results).map_err(|err| {
 393                 sess.fatal(&format!("failed to encode rlink: {}", err));
 394             })?;
 395             let rlink_file = self.prepare_outputs.with_extension(config::RLINK_EXT);
 396             std::fs::write(&rlink_file, rlink_data).map_err(|err| {
 397                 sess.fatal(&format!("failed to write file {}: {}", rlink_file.display(), err));
 398             })?;
 399             return Ok(());
 400         }
 401
 402         self.codegen_backend.link(&self.sess, codegen_results, &self.prepare_outputs)
 403     }
 404 }
 405
 406 impl Compiler {
 407     pub fn enter<F, T>(&self, f: F) -> T
 408     where
 409         F: for<'tcx> FnOnce(&'tcx Queries<'tcx>) -> T,
 410     {
 411         let mut _timer = None;
 412         let queries = Queries::new(&self);
 413         let ret = f(&queries);
 414
 415         if self.session().opts.debugging_opts.query_stats {
 416             if let Ok(gcx) = queries.global_ctxt() {
 417                 gcx.peek_mut().print_stats();
 418             }
 419         }
 420
 421         _timer = Some(self.session().timer("free_global_ctxt"));
 422
 423         ret
 424     }
 425 }