src/librustc/ty/query/plumbing.rs

   1 //! The implementation of the query system itself. This defines the macros that
   2 //! generate the actual methods on tcx which find and execute the provider,
   3 //! manage the caches, and so forth.
   4
   5 use crate::dep_graph::{DepNodeIndex, DepNode, DepKind, SerializedDepNodeIndex};
   6 use crate::ty::tls;
   7 use crate::ty::{self, TyCtxt};
   8 use crate::ty::query::Query;
   9 use crate::ty::query::config::{QueryConfig, QueryDescription};
  10 use crate::ty::query::job::{QueryJob, QueryResult, QueryInfo};
  11
  12 use crate::util::common::{profq_msg, ProfileQueriesMsg, QueryMsg};
  13
  14 use errors::DiagnosticBuilder;
  15 use errors::Level;
  16 use errors::Diagnostic;
  17 use errors::FatalError;
  18 use rustc_data_structures::fx::{FxHashMap};
  19 use rustc_data_structures::sync::{Lrc, Lock};
  20 use rustc_data_structures::thin_vec::ThinVec;
  21 #[cfg(not(parallel_compiler))]
  22 use rustc_data_structures::cold_path;
  23 use std::mem;
  24 use std::ptr;
  25 use std::collections::hash_map::Entry;
  26 use syntax_pos::Span;
  27 use syntax::source_map::DUMMY_SP;
  28
  29 pub struct QueryCache<'tcx, D: QueryConfig<'tcx> + ?Sized> {
  30     pub(super) results: FxHashMap<D::Key, QueryValue<D::Value>>,
  31     pub(super) active: FxHashMap<D::Key, QueryResult<'tcx>>,
  32     #[cfg(debug_assertions)]
  33     pub(super) cache_hits: usize,
  34 }
  35
  36 pub(super) struct QueryValue<T> {
  37     pub(super) value: T,
  38     pub(super) index: DepNodeIndex,
  39 }
  40
  41 impl<T> QueryValue<T> {
  42     pub(super) fn new(value: T,
  43                       dep_node_index: DepNodeIndex)
  44                       -> QueryValue<T> {
  45         QueryValue {
  46             value,
  47             index: dep_node_index,
  48         }
  49     }
  50 }
  51
  52 impl<'tcx, M: QueryConfig<'tcx>> Default for QueryCache<'tcx, M> {
  53     fn default() -> QueryCache<'tcx, M> {
  54         QueryCache {
  55             results: FxHashMap::default(),
  56             active: FxHashMap::default(),
  57             #[cfg(debug_assertions)]
  58             cache_hits: 0,
  59         }
  60     }
  61 }
  62
  63 // If enabled, send a message to the profile-queries thread
  64 macro_rules! profq_msg {
  65     ($tcx:expr, $msg:expr) => {
  66         if cfg!(debug_assertions) {
  67             if $tcx.sess.profile_queries() {
  68                 profq_msg($tcx.sess, $msg)
  69             }
  70         }
  71     }
  72 }
  73
  74 // If enabled, format a key using its debug string, which can be
  75 // expensive to compute (in terms of time).
  76 macro_rules! profq_query_msg {
  77     ($query:expr, $tcx:expr, $key:expr) => {{
  78         let msg = if cfg!(debug_assertions) {
  79             if $tcx.sess.profile_queries_and_keys() {
  80                 Some(format!("{:?}", $key))
  81             } else { None }
  82         } else { None };
  83         QueryMsg {
  84             query: $query,
  85             msg,
  86         }
  87     }}
  88 }
  89
  90 /// A type representing the responsibility to execute the job in the `job` field.
  91 /// This will poison the relevant query if dropped.
  92 pub(super) struct JobOwner<'a, 'tcx: 'a, Q: QueryDescription<'tcx> + 'a> {
  93     cache: &'a Lock<QueryCache<'tcx, Q>>,
  94     key: Q::Key,
  95     job: Lrc<QueryJob<'tcx>>,
  96 }
  97
  98 impl<'a, 'tcx, Q: QueryDescription<'tcx>> JobOwner<'a, 'tcx, Q> {
  99     /// Either gets a JobOwner corresponding the query, allowing us to
 100     /// start executing the query, or it returns with the result of the query.
 101     /// If the query is executing elsewhere, this will wait for it.
 102     /// If the query panicked, this will silently panic.
 103     ///
 104     /// This function is inlined because that results in a noticeable speedup
 105     /// for some compile-time benchmarks.
 106     #[inline(always)]
 107     pub(super) fn try_get(
 108         tcx: TyCtxt<'a, 'tcx, '_>,
 109         span: Span,
 110         key: &Q::Key,
 111     ) -> TryGetJob<'a, 'tcx, Q> {
 112         let cache = Q::query_cache(tcx);
 113         loop {
 114             let mut lock = cache.borrow_mut();
 115             if let Some(value) = lock.results.get(key) {
 116                 profq_msg!(tcx, ProfileQueriesMsg::CacheHit);
 117                 tcx.sess.profiler(|p| p.record_query_hit(Q::NAME, Q::CATEGORY));
 118                 let result = (value.value.clone(), value.index);
 119                 #[cfg(debug_assertions)]
 120                 {
 121                     lock.cache_hits += 1;
 122                 }
 123                 return TryGetJob::JobCompleted(result);
 124             }
 125             let job = match lock.active.entry((*key).clone()) {
 126                 Entry::Occupied(entry) => {
 127                     match *entry.get() {
 128                         QueryResult::Started(ref job) => {
 129                             //For parallel queries, we'll block and wait until the query running
 130                             //in another thread has completed. Record how long we wait in the
 131                             //self-profiler
 132                             #[cfg(parallel_compiler)]
 133                             tcx.sess.profiler(|p| p.query_blocked_start(Q::NAME, Q::CATEGORY));
 134
 135                             job.clone()
 136                         },
 137                         QueryResult::Poisoned => FatalError.raise(),
 138                     }
 139                 }
 140                 Entry::Vacant(entry) => {
 141                     // No job entry for this query. Return a new one to be started later
 142                     return tls::with_related_context(tcx, |icx| {
 143                         // Create the `parent` variable before `info`. This allows LLVM
 144                         // to elide the move of `info`
 145                         let parent = icx.query.clone();
 146                         let info = QueryInfo {
 147                             span,
 148                             query: Q::query(key.clone()),
 149                         };
 150                         let job = Lrc::new(QueryJob::new(info, parent));
 151                         let owner = JobOwner {
 152                             cache,
 153                             job: job.clone(),
 154                             key: (*key).clone(),
 155                         };
 156                         entry.insert(QueryResult::Started(job));
 157                         TryGetJob::NotYetStarted(owner)
 158                     })
 159                 }
 160             };
 161             mem::drop(lock);
 162
 163             // If we are single-threaded we know that we have cycle error,
 164             // so we just return the error
 165             #[cfg(not(parallel_compiler))]
 166             return TryGetJob::Cycle(cold_path(|| {
 167                 Q::handle_cycle_error(tcx, job.find_cycle_in_stack(tcx, span))
 168             }));
 169
 170             // With parallel queries we might just have to wait on some other
 171             // thread
 172             #[cfg(parallel_compiler)]
 173             {
 174                 let result = job.r#await(tcx, span);
 175                 tcx.sess.profiler(|p| p.query_blocked_end(Q::NAME, Q::CATEGORY));
 176
 177                 if let Err(cycle) = result {
 178                     return TryGetJob::Cycle(Q::handle_cycle_error(tcx, cycle));
 179                 }
 180             }
 181         }
 182     }
 183
 184     /// Completes the query by updating the query cache with the `result`,
 185     /// signals the waiter and forgets the JobOwner, so it won't poison the query
 186     #[inline(always)]
 187     pub(super) fn complete(self, result: &Q::Value, dep_node_index: DepNodeIndex) {
 188         // We can move out of `self` here because we `mem::forget` it below
 189         let key = unsafe { ptr::read(&self.key) };
 190         let job = unsafe { ptr::read(&self.job) };
 191         let cache = self.cache;
 192
 193         // Forget ourself so our destructor won't poison the query
 194         mem::forget(self);
 195
 196         let value = QueryValue::new(result.clone(), dep_node_index);
 197         {
 198             let mut lock = cache.borrow_mut();
 199             lock.active.remove(&key);
 200             lock.results.insert(key, value);
 201         }
 202
 203         job.signal_complete();
 204     }
 205 }
 206
 207 #[inline(always)]
 208 fn with_diagnostics<F, R>(f: F) -> (R, ThinVec<Diagnostic>)
 209 where
 210     F: FnOnce(Option<&Lock<ThinVec<Diagnostic>>>) -> R
 211 {
 212     let diagnostics = Lock::new(ThinVec::new());
 213     let result = f(Some(&diagnostics));
 214     (result, diagnostics.into_inner())
 215 }
 216
 217 impl<'a, 'tcx, Q: QueryDescription<'tcx>> Drop for JobOwner<'a, 'tcx, Q> {
 218     #[inline(never)]
 219     #[cold]
 220     fn drop(&mut self) {
 221         // Poison the query so jobs waiting on it panic
 222         self.cache.borrow_mut().active.insert(self.key.clone(), QueryResult::Poisoned);
 223         // Also signal the completion of the job, so waiters
 224         // will continue execution
 225         self.job.signal_complete();
 226     }
 227 }
 228
 229 #[derive(Clone)]
 230 pub struct CycleError<'tcx> {
 231     /// The query and related span which uses the cycle
 232     pub(super) usage: Option<(Span, Query<'tcx>)>,
 233     pub(super) cycle: Vec<QueryInfo<'tcx>>,
 234 }
 235
 236 /// The result of `try_get_lock`
 237 pub(super) enum TryGetJob<'a, 'tcx: 'a, D: QueryDescription<'tcx> + 'a> {
 238     /// The query is not yet started. Contains a guard to the cache eventually used to start it.
 239     NotYetStarted(JobOwner<'a, 'tcx, D>),
 240
 241     /// The query was already completed.
 242     /// Returns the result of the query and its dep node index
 243     /// if it succeeded or a cycle error if it failed
 244     JobCompleted((D::Value, DepNodeIndex)),
 245
 246     /// Trying to execute the query resulted in a cycle.
 247     Cycle(D::Value),
 248 }
 249
 250 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
 251     /// Executes a job by changing the ImplicitCtxt to point to the
 252     /// new query job while it executes. It returns the diagnostics
 253     /// captured during execution and the actual result.
 254     #[inline(always)]
 255     pub(super) fn start_query<F, R>(
 256         self,
 257         job: Lrc<QueryJob<'gcx>>,
 258         diagnostics: Option<&Lock<ThinVec<Diagnostic>>>,
 259         compute: F)
 260     -> R
 261     where
 262         F: for<'b, 'lcx> FnOnce(TyCtxt<'b, 'gcx, 'lcx>) -> R
 263     {
 264         // The TyCtxt stored in TLS has the same global interner lifetime
 265         // as `self`, so we use `with_related_context` to relate the 'gcx lifetimes
 266         // when accessing the ImplicitCtxt
 267         tls::with_related_context(self, move |current_icx| {
 268             // Update the ImplicitCtxt to point to our new query job
 269             let new_icx = tls::ImplicitCtxt {
 270                 tcx: self.global_tcx(),
 271                 query: Some(job),
 272                 diagnostics,
 273                 layout_depth: current_icx.layout_depth,
 274                 task_deps: current_icx.task_deps,
 275             };
 276
 277             // Use the ImplicitCtxt while we execute the query
 278             tls::enter_context(&new_icx, |_| {
 279                 compute(self.global_tcx())
 280             })
 281         })
 282     }
 283
 284     #[inline(never)]
 285     #[cold]
 286     pub(super) fn report_cycle(
 287         self,
 288         CycleError { usage, cycle: stack }: CycleError<'gcx>
 289     ) -> DiagnosticBuilder<'a>
 290     {
 291         assert!(!stack.is_empty());
 292
 293         let fix_span = |span: Span, query: &Query<'gcx>| {
 294             self.sess.source_map().def_span(query.default_span(self, span))
 295         };
 296
 297         // Disable naming impls with types in this path, since that
 298         // sometimes cycles itself, leading to extra cycle errors.
 299         // (And cycle errors around impls tend to occur during the
 300         // collect/coherence phases anyhow.)
 301         ty::print::with_forced_impl_filename_line(|| {
 302             let span = fix_span(stack[1 % stack.len()].span, &stack[0].query);
 303             let mut err = struct_span_err!(self.sess,
 304                                            span,
 305                                            E0391,
 306                                            "cycle detected when {}",
 307                                            stack[0].query.describe(self));
 308
 309             for i in 1..stack.len() {
 310                 let query = &stack[i].query;
 311                 let span = fix_span(stack[(i + 1) % stack.len()].span, query);
 312                 err.span_note(span, &format!("...which requires {}...", query.describe(self)));
 313             }
 314
 315             err.note(&format!("...which again requires {}, completing the cycle",
 316                               stack[0].query.describe(self)));
 317
 318             if let Some((span, query)) = usage {
 319                 err.span_note(fix_span(span, &query),
 320                               &format!("cycle used when {}", query.describe(self)));
 321             }
 322
 323             err
 324         })
 325     }
 326
 327     pub fn try_print_query_stack() {
 328         eprintln!("query stack during panic:");
 329
 330         tls::with_context_opt(|icx| {
 331             if let Some(icx) = icx {
 332                 let mut current_query = icx.query.clone();
 333                 let mut i = 0;
 334
 335                 while let Some(query) = current_query {
 336                     let mut db = DiagnosticBuilder::new(icx.tcx.sess.diagnostic(),
 337                         Level::FailureNote,
 338                         &format!("#{} [{}] {}",
 339                                  i,
 340                                  query.info.query.name(),
 341                                  query.info.query.describe(icx.tcx)));
 342                     db.set_span(icx.tcx.sess.source_map().def_span(query.info.span));
 343                     icx.tcx.sess.diagnostic().force_print_db(db);
 344
 345                     current_query = query.parent.clone();
 346                     i += 1;
 347                 }
 348             }
 349         });
 350
 351         eprintln!("end of query stack");
 352     }
 353
 354     #[inline(never)]
 355     pub(super) fn get_query<Q: QueryDescription<'gcx>>(
 356         self,
 357         span: Span,
 358         key: Q::Key)
 359     -> Q::Value {
 360         debug!("ty::query::get_query<{}>(key={:?}, span={:?})",
 361                Q::NAME,
 362                key,
 363                span);
 364
 365         profq_msg!(self,
 366             ProfileQueriesMsg::QueryBegin(
 367                 span.data(),
 368                 profq_query_msg!(Q::NAME, self, key),
 369             )
 370         );
 371
 372         let job = match JobOwner::try_get(self, span, &key) {
 373             TryGetJob::NotYetStarted(job) => job,
 374             TryGetJob::Cycle(result) => return result,
 375             TryGetJob::JobCompleted((v, index)) => {
 376                 self.dep_graph.read_index(index);
 377                 return v
 378             }
 379         };
 380
 381         // Fast path for when incr. comp. is off. `to_dep_node` is
 382         // expensive for some DepKinds.
 383         if !self.dep_graph.is_fully_enabled() {
 384             let null_dep_node = DepNode::new_no_params(crate::dep_graph::DepKind::Null);
 385             return self.force_query_with_job::<Q>(key, job, null_dep_node).0;
 386         }
 387
 388         let dep_node = Q::to_dep_node(self, &key);
 389
 390         if dep_node.kind.is_anon() {
 391             profq_msg!(self, ProfileQueriesMsg::ProviderBegin);
 392             self.sess.profiler(|p| p.start_query(Q::NAME, Q::CATEGORY));
 393
 394             let ((result, dep_node_index), diagnostics) = with_diagnostics(|diagnostics| {
 395                 self.start_query(job.job.clone(), diagnostics, |tcx| {
 396                     tcx.dep_graph.with_anon_task(dep_node.kind, || {
 397                         Q::compute(tcx.global_tcx(), key)
 398                     })
 399                 })
 400             });
 401
 402             self.sess.profiler(|p| p.end_query(Q::NAME, Q::CATEGORY));
 403             profq_msg!(self, ProfileQueriesMsg::ProviderEnd);
 404
 405             self.dep_graph.read_index(dep_node_index);
 406
 407             if unlikely!(!diagnostics.is_empty()) {
 408                 self.queries.on_disk_cache
 409                     .store_diagnostics_for_anon_node(dep_node_index, diagnostics);
 410             }
 411
 412             job.complete(&result, dep_node_index);
 413
 414             return result;
 415         }
 416
 417         if !dep_node.kind.is_eval_always() {
 418             // The diagnostics for this query will be
 419             // promoted to the current session during
 420             // try_mark_green(), so we can ignore them here.
 421             let loaded = self.start_query(job.job.clone(), None, |tcx| {
 422                 let marked = tcx.dep_graph.try_mark_green_and_read(tcx, &dep_node);
 423                 marked.map(|(prev_dep_node_index, dep_node_index)| {
 424                     (tcx.load_from_disk_and_cache_in_memory::<Q>(
 425                         key.clone(),
 426                         prev_dep_node_index,
 427                         dep_node_index,
 428                         &dep_node
 429                     ), dep_node_index)
 430                 })
 431             });
 432             if let Some((result, dep_node_index)) = loaded {
 433                 job.complete(&result, dep_node_index);
 434                 return result;
 435             }
 436         }
 437
 438         let (result, dep_node_index) = self.force_query_with_job::<Q>(key, job, dep_node);
 439         self.dep_graph.read_index(dep_node_index);
 440         result
 441     }
 442
 443     fn load_from_disk_and_cache_in_memory<Q: QueryDescription<'gcx>>(
 444         self,
 445         key: Q::Key,
 446         prev_dep_node_index: SerializedDepNodeIndex,
 447         dep_node_index: DepNodeIndex,
 448         dep_node: &DepNode
 449     ) -> Q::Value
 450     {
 451         // Note this function can be called concurrently from the same query
 452         // We must ensure that this is handled correctly
 453
 454         debug_assert!(self.dep_graph.is_green(dep_node));
 455
 456         // First we try to load the result from the on-disk cache
 457         let result = if Q::cache_on_disk(self.global_tcx(), key.clone()) &&
 458                         self.sess.opts.debugging_opts.incremental_queries {
 459             self.sess.profiler(|p| p.incremental_load_result_start(Q::NAME));
 460             let result = Q::try_load_from_disk(self.global_tcx(), prev_dep_node_index);
 461             self.sess.profiler(|p| p.incremental_load_result_end(Q::NAME));
 462
 463             // We always expect to find a cached result for things that
 464             // can be forced from DepNode.
 465             debug_assert!(!dep_node.kind.can_reconstruct_query_key() ||
 466                           result.is_some(),
 467                           "Missing on-disk cache entry for {:?}",
 468                           dep_node);
 469             result
 470         } else {
 471             // Some things are never cached on disk.
 472             None
 473         };
 474
 475         let result = if let Some(result) = result {
 476             profq_msg!(self, ProfileQueriesMsg::CacheHit);
 477             self.sess.profiler(|p| p.record_query_hit(Q::NAME, Q::CATEGORY));
 478
 479             result
 480         } else {
 481             // We could not load a result from the on-disk cache, so
 482             // recompute.
 483
 484             self.sess.profiler(|p| p.start_query(Q::NAME, Q::CATEGORY));
 485
 486             // The dep-graph for this computation is already in
 487             // place
 488             let result = self.dep_graph.with_ignore(|| {
 489                 Q::compute(self, key)
 490             });
 491
 492             self.sess.profiler(|p| p.end_query(Q::NAME, Q::CATEGORY));
 493             result
 494         };
 495
 496         // If -Zincremental-verify-ich is specified, re-hash results from
 497         // the cache and make sure that they have the expected fingerprint.
 498         if unlikely!(self.sess.opts.debugging_opts.incremental_verify_ich) {
 499             self.incremental_verify_ich::<Q>(&result, dep_node, dep_node_index);
 500         }
 501
 502         if unlikely!(self.sess.opts.debugging_opts.query_dep_graph) {
 503             self.dep_graph.mark_loaded_from_cache(dep_node_index, true);
 504         }
 505
 506         result
 507     }
 508
 509     #[inline(never)]
 510     #[cold]
 511     fn incremental_verify_ich<Q: QueryDescription<'gcx>>(
 512         self,
 513         result: &Q::Value,
 514         dep_node: &DepNode,
 515         dep_node_index: DepNodeIndex,
 516     ) {
 517         use crate::ich::Fingerprint;
 518
 519         assert!(Some(self.dep_graph.fingerprint_of(dep_node_index)) ==
 520                 self.dep_graph.prev_fingerprint_of(dep_node),
 521                 "Fingerprint for green query instance not loaded \
 522                     from cache: {:?}", dep_node);
 523
 524         debug!("BEGIN verify_ich({:?})", dep_node);
 525         let mut hcx = self.create_stable_hashing_context();
 526
 527         let new_hash = Q::hash_result(&mut hcx, result).unwrap_or(Fingerprint::ZERO);
 528         debug!("END verify_ich({:?})", dep_node);
 529
 530         let old_hash = self.dep_graph.fingerprint_of(dep_node_index);
 531
 532         assert!(new_hash == old_hash, "Found unstable fingerprints \
 533             for {:?}", dep_node);
 534     }
 535
 536     #[inline(always)]
 537     fn force_query_with_job<Q: QueryDescription<'gcx>>(
 538         self,
 539         key: Q::Key,
 540         job: JobOwner<'_, 'gcx, Q>,
 541         dep_node: DepNode)
 542     -> (Q::Value, DepNodeIndex) {
 543         // If the following assertion triggers, it can have two reasons:
 544         // 1. Something is wrong with DepNode creation, either here or
 545         //    in DepGraph::try_mark_green()
 546         // 2. Two distinct query keys get mapped to the same DepNode
 547         //    (see for example #48923)
 548         assert!(!self.dep_graph.dep_node_exists(&dep_node),
 549                 "Forcing query with already existing DepNode.\n\
 550                  - query-key: {:?}\n\
 551                  - dep-node: {:?}",
 552                 key, dep_node);
 553
 554         profq_msg!(self, ProfileQueriesMsg::ProviderBegin);
 555         self.sess.profiler(|p| p.start_query(Q::NAME, Q::CATEGORY));
 556
 557         let ((result, dep_node_index), diagnostics) = with_diagnostics(|diagnostics| {
 558             self.start_query(job.job.clone(), diagnostics, |tcx| {
 559                 if dep_node.kind.is_eval_always() {
 560                     tcx.dep_graph.with_eval_always_task(dep_node,
 561                                                         tcx,
 562                                                         key,
 563                                                         Q::compute,
 564                                                         Q::hash_result)
 565                 } else {
 566                     tcx.dep_graph.with_task(dep_node,
 567                                             tcx,
 568                                             key,
 569                                             Q::compute,
 570                                             Q::hash_result)
 571                 }
 572             })
 573         });
 574
 575         self.sess.profiler(|p| p.end_query(Q::NAME, Q::CATEGORY));
 576         profq_msg!(self, ProfileQueriesMsg::ProviderEnd);
 577
 578         if unlikely!(self.sess.opts.debugging_opts.query_dep_graph) {
 579             self.dep_graph.mark_loaded_from_cache(dep_node_index, false);
 580         }
 581
 582         if dep_node.kind != crate::dep_graph::DepKind::Null {
 583             if unlikely!(!diagnostics.is_empty()) {
 584                 self.queries.on_disk_cache
 585                     .store_diagnostics(dep_node_index, diagnostics);
 586             }
 587         }
 588
 589         job.complete(&result, dep_node_index);
 590
 591         (result, dep_node_index)
 592     }
 593
 594     /// Ensure that either this query has all green inputs or been executed.
 595     /// Executing query::ensure(D) is considered a read of the dep-node D.
 596     ///
 597     /// This function is particularly useful when executing passes for their
 598     /// side-effects -- e.g., in order to report errors for erroneous programs.
 599     ///
 600     /// Note: The optimization is only available during incr. comp.
 601     pub(super) fn ensure_query<Q: QueryDescription<'gcx>>(self, key: Q::Key) -> () {
 602         let dep_node = Q::to_dep_node(self, &key);
 603
 604         if dep_node.kind.is_eval_always() {
 605             let _ = self.get_query::<Q>(DUMMY_SP, key);
 606             return;
 607         }
 608
 609         // Ensuring an anonymous query makes no sense
 610         assert!(!dep_node.kind.is_anon());
 611         if self.dep_graph.try_mark_green_and_read(self, &dep_node).is_none() {
 612             // A None return from `try_mark_green_and_read` means that this is either
 613             // a new dep node or that the dep node has already been marked red.
 614             // Either way, we can't call `dep_graph.read()` as we don't have the
 615             // DepNodeIndex. We must invoke the query itself. The performance cost
 616             // this introduces should be negligible as we'll immediately hit the
 617             // in-memory cache, or another query down the line will.
 618
 619             let _ = self.get_query::<Q>(DUMMY_SP, key);
 620         } else {
 621             profq_msg!(self, ProfileQueriesMsg::CacheHit);
 622             self.sess.profiler(|p| p.record_query_hit(Q::NAME, Q::CATEGORY));
 623         }
 624     }
 625
 626     #[allow(dead_code)]
 627     fn force_query<Q: QueryDescription<'gcx>>(
 628         self,
 629         key: Q::Key,
 630         span: Span,
 631         dep_node: DepNode
 632     ) {
 633         profq_msg!(
 634             self,
 635             ProfileQueriesMsg::QueryBegin(span.data(), profq_query_msg!(Q::NAME, self, key))
 636         );
 637
 638         // We may be concurrently trying both execute and force a query
 639         // Ensure that only one of them runs the query
 640         let job = match JobOwner::try_get(self, span, &key) {
 641             TryGetJob::NotYetStarted(job) => job,
 642             TryGetJob::Cycle(_) |
 643             TryGetJob::JobCompleted(_) => {
 644                 return
 645             }
 646         };
 647         self.force_query_with_job::<Q>(key, job, dep_node);
 648     }
 649 }
 650
 651 macro_rules! handle_cycle_error {
 652     ([][$tcx: expr, $error:expr]) => {{
 653         $tcx.report_cycle($error).emit();
 654         Value::from_cycle_error($tcx.global_tcx())
 655     }};
 656     ([fatal_cycle$(, $modifiers:ident)*][$tcx:expr, $error:expr]) => {{
 657         $tcx.report_cycle($error).emit();
 658         $tcx.sess.abort_if_errors();
 659         unreachable!()
 660     }};
 661     ([cycle_delay_bug$(, $modifiers:ident)*][$tcx:expr, $error:expr]) => {{
 662         $tcx.report_cycle($error).delay_as_bug();
 663         Value::from_cycle_error($tcx.global_tcx())
 664     }};
 665     ([$other:ident$(, $modifiers:ident)*][$($args:tt)*]) => {
 666         handle_cycle_error!([$($modifiers),*][$($args)*])
 667     };
 668 }
 669
 670 macro_rules! hash_result {
 671     ([][$hcx:expr, $result:expr]) => {{
 672         dep_graph::hash_result($hcx, &$result)
 673     }};
 674     ([no_hash$(, $modifiers:ident)*][$hcx:expr, $result:expr]) => {{
 675         None
 676     }};
 677     ([$other:ident$(, $modifiers:ident)*][$($args:tt)*]) => {
 678         hash_result!([$($modifiers),*][$($args)*])
 679     };
 680 }
 681
 682 macro_rules! define_queries {
 683     (<$tcx:tt> $($category:tt {
 684         $($(#[$attr:meta])* [$($modifiers:tt)*] fn $name:ident: $node:ident($K:ty) -> $V:ty,)*
 685     },)*) => {
 686         define_queries_inner! { <$tcx>
 687             $($( $(#[$attr])* category<$category> [$($modifiers)*] fn $name: $node($K) -> $V,)*)*
 688         }
 689     }
 690 }
 691
 692 macro_rules! define_queries_inner {
 693     (<$tcx:tt>
 694      $($(#[$attr:meta])* category<$category:tt>
 695         [$($modifiers:tt)*] fn $name:ident: $node:ident($K:ty) -> $V:ty,)*) => {
 696
 697         use std::mem;
 698         #[cfg(parallel_compiler)]
 699         use ty::query::job::QueryResult;
 700         use rustc_data_structures::sync::Lock;
 701         use crate::{
 702             rustc_data_structures::stable_hasher::HashStable,
 703             rustc_data_structures::stable_hasher::StableHasherResult,
 704             rustc_data_structures::stable_hasher::StableHasher,
 705             ich::StableHashingContext
 706         };
 707         use crate::util::profiling::ProfileCategory;
 708
 709         define_queries_struct! {
 710             tcx: $tcx,
 711             input: ($(([$($modifiers)*] [$($attr)*] [$name]))*)
 712         }
 713
 714         impl<$tcx> Queries<$tcx> {
 715             pub fn new(
 716                 providers: IndexVec<CrateNum, Providers<$tcx>>,
 717                 fallback_extern_providers: Providers<$tcx>,
 718                 on_disk_cache: OnDiskCache<'tcx>,
 719             ) -> Self {
 720                 Queries {
 721                     providers,
 722                     fallback_extern_providers: Box::new(fallback_extern_providers),
 723                     on_disk_cache,
 724                     $($name: Default::default()),*
 725                 }
 726             }
 727
 728             pub fn record_computed_queries(&self, sess: &Session) {
 729                 sess.profiler(|p| {
 730                     $(
 731                         p.record_computed_queries(
 732                             <queries::$name<'_> as QueryConfig<'_>>::NAME,
 733                             <queries::$name<'_> as QueryConfig<'_>>::CATEGORY,
 734                             self.$name.lock().results.len()
 735                         );
 736                     )*
 737                 });
 738             }
 739
 740             #[cfg(parallel_compiler)]
 741             pub fn collect_active_jobs(&self) -> Vec<Lrc<QueryJob<$tcx>>> {
 742                 let mut jobs = Vec::new();
 743
 744                 // We use try_lock here since we are only called from the
 745                 // deadlock handler, and this shouldn't be locked
 746                 $(
 747                     jobs.extend(
 748                         self.$name.try_lock().unwrap().active.values().filter_map(|v|
 749                             if let QueryResult::Started(ref job) = *v {
 750                                 Some(job.clone())
 751                             } else {
 752                                 None
 753                             }
 754                         )
 755                     );
 756                 )*
 757
 758                 jobs
 759             }
 760
 761             pub fn print_stats(&self) {
 762                 let mut queries = Vec::new();
 763
 764                 #[derive(Clone)]
 765                 struct QueryStats {
 766                     name: &'static str,
 767                     cache_hits: usize,
 768                     key_size: usize,
 769                     key_type: &'static str,
 770                     value_size: usize,
 771                     value_type: &'static str,
 772                     entry_count: usize,
 773                 }
 774
 775                 fn stats<'tcx, Q: QueryConfig<'tcx>>(
 776                     name: &'static str,
 777                     map: &QueryCache<'tcx, Q>
 778                 ) -> QueryStats {
 779                     QueryStats {
 780                         name,
 781                         #[cfg(debug_assertions)]
 782                         cache_hits: map.cache_hits,
 783                         #[cfg(not(debug_assertions))]
 784                         cache_hits: 0,
 785                         key_size: mem::size_of::<Q::Key>(),
 786                         key_type: unsafe { type_name::<Q::Key>() },
 787                         value_size: mem::size_of::<Q::Value>(),
 788                         value_type: unsafe { type_name::<Q::Value>() },
 789                         entry_count: map.results.len(),
 790                     }
 791                 }
 792
 793                 $(
 794                     queries.push(stats::<queries::$name<'_>>(
 795                         stringify!($name),
 796                         &*self.$name.lock()
 797                     ));
 798                 )*
 799
 800                 if cfg!(debug_assertions) {
 801                     let hits: usize = queries.iter().map(|s| s.cache_hits).sum();
 802                     let results: usize = queries.iter().map(|s| s.entry_count).sum();
 803                     println!("\nQuery cache hit rate: {}", hits as f64 / (hits + results) as f64);
 804                 }
 805
 806                 let mut query_key_sizes = queries.clone();
 807                 query_key_sizes.sort_by_key(|q| q.key_size);
 808                 println!("\nLarge query keys:");
 809                 for q in query_key_sizes.iter().rev()
 810                                         .filter(|q| q.key_size > 8) {
 811                     println!(
 812                         "   {} - {} x {} - {}",
 813                         q.name,
 814                         q.key_size,
 815                         q.entry_count,
 816                         q.key_type
 817                     );
 818                 }
 819
 820                 let mut query_value_sizes = queries.clone();
 821                 query_value_sizes.sort_by_key(|q| q.value_size);
 822                 println!("\nLarge query values:");
 823                 for q in query_value_sizes.iter().rev()
 824                                           .filter(|q| q.value_size > 8) {
 825                     println!(
 826                         "   {} - {} x {} - {}",
 827                         q.name,
 828                         q.value_size,
 829                         q.entry_count,
 830                         q.value_type
 831                     );
 832                 }
 833
 834                 if cfg!(debug_assertions) {
 835                     let mut query_cache_hits = queries.clone();
 836                     query_cache_hits.sort_by_key(|q| q.cache_hits);
 837                     println!("\nQuery cache hits:");
 838                     for q in query_cache_hits.iter().rev() {
 839                         println!(
 840                             "   {} - {} ({}%)",
 841                             q.name,
 842                             q.cache_hits,
 843                             q.cache_hits as f64 / (q.cache_hits + q.entry_count) as f64
 844                         );
 845                     }
 846                 }
 847
 848                 let mut query_value_count = queries.clone();
 849                 query_value_count.sort_by_key(|q| q.entry_count);
 850                 println!("\nQuery value count:");
 851                 for q in query_value_count.iter().rev() {
 852                     println!("   {} - {}", q.name, q.entry_count);
 853                 }
 854             }
 855         }
 856
 857         #[allow(nonstandard_style)]
 858         #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
 859         pub enum Query<$tcx> {
 860             $($(#[$attr])* $name($K)),*
 861         }
 862
 863         impl<$tcx> Query<$tcx> {
 864             pub fn name(&self) -> &'static str {
 865                 match *self {
 866                     $(Query::$name(_) => stringify!($name),)*
 867                 }
 868             }
 869
 870             pub fn describe(&self, tcx: TyCtxt<'_, '_, '_>) -> Cow<'static, str> {
 871                 let (r, name) = match *self {
 872                     $(Query::$name(key) => {
 873                         (queries::$name::describe(tcx, key), stringify!($name))
 874                     })*
 875                 };
 876                 if tcx.sess.verbose() {
 877                     format!("{} [{}]", r, name).into()
 878                 } else {
 879                     r
 880                 }
 881             }
 882
 883             // FIXME(eddyb) Get more valid Span's on queries.
 884             pub fn default_span(&self, tcx: TyCtxt<'_, $tcx, '_>, span: Span) -> Span {
 885                 if !span.is_dummy() {
 886                     return span;
 887                 }
 888                 // The def_span query is used to calculate default_span,
 889                 // so exit to avoid infinite recursion
 890                 if let Query::def_span(..) = *self {
 891                     return span
 892                 }
 893                 match *self {
 894                     $(Query::$name(key) => key.default_span(tcx),)*
 895                 }
 896             }
 897         }
 898
 899         impl<'a, $tcx> HashStable<StableHashingContext<'a>> for Query<$tcx> {
 900             fn hash_stable<W: StableHasherResult>(&self,
 901                                                 hcx: &mut StableHashingContext<'a>,
 902                                                 hasher: &mut StableHasher<W>) {
 903                 mem::discriminant(self).hash_stable(hcx, hasher);
 904                 match *self {
 905                     $(Query::$name(key) => key.hash_stable(hcx, hasher),)*
 906                 }
 907             }
 908         }
 909
 910         pub mod queries {
 911             use std::marker::PhantomData;
 912
 913             $(#[allow(nonstandard_style)]
 914             pub struct $name<$tcx> {
 915                 data: PhantomData<&$tcx ()>
 916             })*
 917         }
 918
 919         // This module and the functions in it exist only to provide a
 920         // predictable symbol name prefix for query providers. This is helpful
 921         // for analyzing queries in profilers.
 922         pub(super) mod __query_compute {
 923             $(#[inline(never)]
 924             pub fn $name<F: FnOnce() -> R, R>(f: F) -> R {
 925                 f()
 926             })*
 927         }
 928
 929         $(impl<$tcx> QueryConfig<$tcx> for queries::$name<$tcx> {
 930             type Key = $K;
 931             type Value = $V;
 932
 933             const NAME: &'static str = stringify!($name);
 934             const CATEGORY: ProfileCategory = $category;
 935         }
 936
 937         impl<$tcx> QueryAccessors<$tcx> for queries::$name<$tcx> {
 938             #[inline(always)]
 939             fn query(key: Self::Key) -> Query<'tcx> {
 940                 Query::$name(key)
 941             }
 942
 943             #[inline(always)]
 944             fn query_cache<'a>(tcx: TyCtxt<'a, $tcx, '_>) -> &'a Lock<QueryCache<$tcx, Self>> {
 945                 &tcx.queries.$name
 946             }
 947
 948             #[allow(unused)]
 949             #[inline(always)]
 950             fn to_dep_node(tcx: TyCtxt<'_, $tcx, '_>, key: &Self::Key) -> DepNode {
 951                 use crate::dep_graph::DepConstructor::*;
 952
 953                 DepNode::new(tcx, $node(*key))
 954             }
 955
 956             #[inline]
 957             fn compute(tcx: TyCtxt<'_, 'tcx, '_>, key: Self::Key) -> Self::Value {
 958                 __query_compute::$name(move || {
 959                     let provider = tcx.queries.providers.get(key.query_crate())
 960                         // HACK(eddyb) it's possible crates may be loaded after
 961                         // the query engine is created, and because crate loading
 962                         // is not yet integrated with the query engine, such crates
 963                         // would be missing appropriate entries in `providers`.
 964                         .unwrap_or(&tcx.queries.fallback_extern_providers)
 965                         .$name;
 966                     provider(tcx.global_tcx(), key)
 967                 })
 968             }
 969
 970             fn hash_result(
 971                 _hcx: &mut StableHashingContext<'_>,
 972                 _result: &Self::Value
 973             ) -> Option<Fingerprint> {
 974                 hash_result!([$($modifiers)*][_hcx, _result])
 975             }
 976
 977             fn handle_cycle_error(
 978                 tcx: TyCtxt<'_, 'tcx, '_>,
 979                 error: CycleError<'tcx>
 980             ) -> Self::Value {
 981                 handle_cycle_error!([$($modifiers)*][tcx, error])
 982             }
 983         })*
 984
 985         #[derive(Copy, Clone)]
 986         pub struct TyCtxtEnsure<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
 987             pub tcx: TyCtxt<'a, 'gcx, 'tcx>,
 988         }
 989
 990         impl<'a, $tcx, 'lcx> TyCtxtEnsure<'a, $tcx, 'lcx> {
 991             $($(#[$attr])*
 992             #[inline(always)]
 993             pub fn $name(self, key: $K) {
 994                 self.tcx.ensure_query::<queries::$name<'_>>(key)
 995             })*
 996         }
 997
 998         #[derive(Copy, Clone)]
 999         pub struct TyCtxtAt<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
1000             pub tcx: TyCtxt<'a, 'gcx, 'tcx>,
1001             pub span: Span,
1002         }
1003
1004         impl<'a, 'gcx, 'tcx> Deref for TyCtxtAt<'a, 'gcx, 'tcx> {
1005             type Target = TyCtxt<'a, 'gcx, 'tcx>;
1006             #[inline(always)]
1007             fn deref(&self) -> &Self::Target {
1008                 &self.tcx
1009             }
1010         }
1011
1012         impl<'a, $tcx, 'lcx> TyCtxt<'a, $tcx, 'lcx> {
1013             /// Returns a transparent wrapper for `TyCtxt`, which ensures queries
1014             /// are executed instead of just returing their results.
1015             #[inline(always)]
1016             pub fn ensure(self) -> TyCtxtEnsure<'a, $tcx, 'lcx> {
1017                 TyCtxtEnsure {
1018                     tcx: self,
1019                 }
1020             }
1021
1022             /// Returns a transparent wrapper for `TyCtxt` which uses
1023             /// `span` as the location of queries performed through it.
1024             #[inline(always)]
1025             pub fn at(self, span: Span) -> TyCtxtAt<'a, $tcx, 'lcx> {
1026                 TyCtxtAt {
1027                     tcx: self,
1028                     span
1029                 }
1030             }
1031
1032             $($(#[$attr])*
1033             #[inline(always)]
1034             pub fn $name(self, key: $K) -> $V {
1035                 self.at(DUMMY_SP).$name(key)
1036             })*
1037         }
1038
1039         impl<'a, $tcx, 'lcx> TyCtxtAt<'a, $tcx, 'lcx> {
1040             $($(#[$attr])*
1041             #[inline(always)]
1042             pub fn $name(self, key: $K) -> $V {
1043                 self.tcx.get_query::<queries::$name<'_>>(self.span, key)
1044             })*
1045         }
1046
1047         define_provider_struct! {
1048             tcx: $tcx,
1049             input: ($(([$($modifiers)*] [$name] [$K] [$V]))*)
1050         }
1051
1052         impl<$tcx> Copy for Providers<$tcx> {}
1053         impl<$tcx> Clone for Providers<$tcx> {
1054             fn clone(&self) -> Self { *self }
1055         }
1056     }
1057 }
1058
1059 macro_rules! define_queries_struct {
1060     (tcx: $tcx:tt,
1061      input: ($(([$($modifiers:tt)*] [$($attr:tt)*] [$name:ident]))*)) => {
1062         pub struct Queries<$tcx> {
1063             /// This provides access to the incrimental comilation on-disk cache for query results.
1064             /// Do not access this directly. It is only meant to be used by
1065             /// `DepGraph::try_mark_green()` and the query infrastructure.
1066             pub(crate) on_disk_cache: OnDiskCache<'tcx>,
1067
1068             providers: IndexVec<CrateNum, Providers<$tcx>>,
1069             fallback_extern_providers: Box<Providers<$tcx>>,
1070
1071             $($(#[$attr])*  $name: Lock<QueryCache<$tcx, queries::$name<$tcx>>>,)*
1072         }
1073     };
1074 }
1075
1076 macro_rules! define_provider_struct {
1077     (tcx: $tcx:tt,
1078      input: ($(([$($modifiers:tt)*] [$name:ident] [$K:ty] [$R:ty]))*)) => {
1079         pub struct Providers<$tcx> {
1080             $(pub $name: for<'a> fn(TyCtxt<'a, $tcx, $tcx>, $K) -> $R,)*
1081         }
1082
1083         impl<$tcx> Default for Providers<$tcx> {
1084             fn default() -> Self {
1085                 $(fn $name<'a, $tcx>(_: TyCtxt<'a, $tcx, $tcx>, key: $K) -> $R {
1086                     bug!("tcx.{}({:?}) unsupported by its crate",
1087                          stringify!($name), key);
1088                 })*
1089                 Providers { $($name),* }
1090             }
1091         }
1092     };
1093 }
1094
1095
1096 /// The red/green evaluation system will try to mark a specific DepNode in the
1097 /// dependency graph as green by recursively trying to mark the dependencies of
1098 /// that DepNode as green. While doing so, it will sometimes encounter a DepNode
1099 /// where we don't know if it is red or green and we therefore actually have
1100 /// to recompute its value in order to find out. Since the only piece of
1101 /// information that we have at that point is the DepNode we are trying to
1102 /// re-evaluate, we need some way to re-run a query from just that. This is what
1103 /// `force_from_dep_node()` implements.
1104 ///
1105 /// In the general case, a DepNode consists of a DepKind and an opaque
1106 /// GUID/fingerprint that will uniquely identify the node. This GUID/fingerprint
1107 /// is usually constructed by computing a stable hash of the query-key that the
1108 /// DepNode corresponds to. Consequently, it is not in general possible to go
1109 /// back from hash to query-key (since hash functions are not reversible). For
1110 /// this reason `force_from_dep_node()` is expected to fail from time to time
1111 /// because we just cannot find out, from the DepNode alone, what the
1112 /// corresponding query-key is and therefore cannot re-run the query.
1113 ///
1114 /// The system deals with this case letting `try_mark_green` fail which forces
1115 /// the root query to be re-evaluated.
1116 ///
1117 /// Now, if force_from_dep_node() would always fail, it would be pretty useless.
1118 /// Fortunately, we can use some contextual information that will allow us to
1119 /// reconstruct query-keys for certain kinds of `DepNode`s. In particular, we
1120 /// enforce by construction that the GUID/fingerprint of certain `DepNode`s is a
1121 /// valid `DefPathHash`. Since we also always build a huge table that maps every
1122 /// `DefPathHash` in the current codebase to the corresponding `DefId`, we have
1123 /// everything we need to re-run the query.
1124 ///
1125 /// Take the `mir_validated` query as an example. Like many other queries, it
1126 /// just has a single parameter: the `DefId` of the item it will compute the
1127 /// validated MIR for. Now, when we call `force_from_dep_node()` on a `DepNode`
1128 /// with kind `MirValidated`, we know that the GUID/fingerprint of the `DepNode`
1129 /// is actually a `DefPathHash`, and can therefore just look up the corresponding
1130 /// `DefId` in `tcx.def_path_hash_to_def_id`.
1131 ///
1132 /// When you implement a new query, it will likely have a corresponding new
1133 /// `DepKind`, and you'll have to support it here in `force_from_dep_node()`. As
1134 /// a rule of thumb, if your query takes a `DefId` or `DefIndex` as sole parameter,
1135 /// then `force_from_dep_node()` should not fail for it. Otherwise, you can just
1136 /// add it to the "We don't have enough information to reconstruct..." group in
1137 /// the match below.
1138 pub fn force_from_dep_node<'tcx>(
1139     tcx: TyCtxt<'_, 'tcx, 'tcx>,
1140     dep_node: &DepNode
1141 ) -> bool {
1142     use crate::hir::def_id::LOCAL_CRATE;
1143     use crate::dep_graph::RecoverKey;
1144
1145     // We must avoid ever having to call force_from_dep_node() for a
1146     // DepNode::CodegenUnit:
1147     // Since we cannot reconstruct the query key of a DepNode::CodegenUnit, we
1148     // would always end up having to evaluate the first caller of the
1149     // `codegen_unit` query that *is* reconstructible. This might very well be
1150     // the `compile_codegen_unit` query, thus re-codegenning the whole CGU just
1151     // to re-trigger calling the `codegen_unit` query with the right key. At
1152     // that point we would already have re-done all the work we are trying to
1153     // avoid doing in the first place.
1154     // The solution is simple: Just explicitly call the `codegen_unit` query for
1155     // each CGU, right after partitioning. This way `try_mark_green` will always
1156     // hit the cache instead of having to go through `force_from_dep_node`.
1157     // This assertion makes sure, we actually keep applying the solution above.
1158     debug_assert!(dep_node.kind != DepKind::CodegenUnit,
1159                   "calling force_from_dep_node() on DepKind::CodegenUnit");
1160
1161     if !dep_node.kind.can_reconstruct_query_key() {
1162         return false
1163     }
1164
1165     macro_rules! def_id {
1166         () => {
1167             if let Some(def_id) = dep_node.extract_def_id(tcx) {
1168                 def_id
1169             } else {
1170                 // return from the whole function
1171                 return false
1172             }
1173         }
1174     };
1175
1176     macro_rules! krate {
1177         () => { (def_id!()).krate }
1178     };
1179
1180     macro_rules! force_ex {
1181         ($tcx:expr, $query:ident, $key:expr) => {
1182             {
1183                 $tcx.force_query::<crate::ty::query::queries::$query<'_>>(
1184                     $key,
1185                     DUMMY_SP,
1186                     *dep_node
1187                 );
1188             }
1189         }
1190     };
1191
1192     macro_rules! force {
1193         ($query:ident, $key:expr) => { force_ex!(tcx, $query, $key) }
1194     };
1195
1196     // FIXME(#45015): We should try move this boilerplate code into a macro
1197     //                somehow.
1198
1199     rustc_dep_node_force!([dep_node, tcx]
1200         // These are inputs that are expected to be pre-allocated and that
1201         // should therefore always be red or green already
1202         DepKind::AllLocalTraitImpls |
1203         DepKind::Krate |
1204         DepKind::CrateMetadata |
1205         DepKind::HirBody |
1206         DepKind::Hir |
1207
1208         // This are anonymous nodes
1209         DepKind::TraitSelect |
1210
1211         // We don't have enough information to reconstruct the query key of
1212         // these
1213         DepKind::IsCopy |
1214         DepKind::IsSized |
1215         DepKind::IsFreeze |
1216         DepKind::NeedsDrop |
1217         DepKind::Layout |
1218         DepKind::ConstEval |
1219         DepKind::ConstEvalRaw |
1220         DepKind::SymbolName |
1221         DepKind::MirShim |
1222         DepKind::BorrowCheckKrate |
1223         DepKind::Specializes |
1224         DepKind::ImplementationsOfTrait |
1225         DepKind::TypeParamPredicates |
1226         DepKind::CodegenUnit |
1227         DepKind::CompileCodegenUnit |
1228         DepKind::FulfillObligation |
1229         DepKind::VtableMethods |
1230         DepKind::NormalizeProjectionTy |
1231         DepKind::NormalizeTyAfterErasingRegions |
1232         DepKind::ImpliedOutlivesBounds |
1233         DepKind::DropckOutlives |
1234         DepKind::EvaluateObligation |
1235         DepKind::EvaluateGoal |
1236         DepKind::TypeOpAscribeUserType |
1237         DepKind::TypeOpEq |
1238         DepKind::TypeOpSubtype |
1239         DepKind::TypeOpProvePredicate |
1240         DepKind::TypeOpNormalizeTy |
1241         DepKind::TypeOpNormalizePredicate |
1242         DepKind::TypeOpNormalizePolyFnSig |
1243         DepKind::TypeOpNormalizeFnSig |
1244         DepKind::SubstituteNormalizeAndTestPredicates |
1245         DepKind::MethodAutoderefSteps |
1246         DepKind::InstanceDefSizeEstimate => {
1247             bug!("force_from_dep_node() - Encountered {:?}", dep_node)
1248         }
1249
1250         // These are not queries
1251         DepKind::CoherenceCheckTrait |
1252         DepKind::ItemVarianceConstraints => {
1253             return false
1254         }
1255
1256         DepKind::RegionScopeTree => { force!(region_scope_tree, def_id!()); }
1257
1258         DepKind::Coherence => { force!(crate_inherent_impls, LOCAL_CRATE); }
1259         DepKind::CoherenceInherentImplOverlapCheck => {
1260             force!(crate_inherent_impls_overlap_check, LOCAL_CRATE)
1261         },
1262         DepKind::PrivacyAccessLevels => { force!(privacy_access_levels, LOCAL_CRATE); }
1263         DepKind::CheckPrivateInPublic => { force!(check_private_in_public, LOCAL_CRATE); }
1264
1265         DepKind::BorrowCheck => { force!(borrowck, def_id!()); }
1266         DepKind::MirBorrowCheck => { force!(mir_borrowck, def_id!()); }
1267         DepKind::UnsafetyCheckResult => { force!(unsafety_check_result, def_id!()); }
1268         DepKind::UnsafeDeriveOnReprPacked => { force!(unsafe_derive_on_repr_packed, def_id!()); }
1269         DepKind::LintMod => { force!(lint_mod, def_id!()); }
1270         DepKind::CheckModAttrs => { force!(check_mod_attrs, def_id!()); }
1271         DepKind::CheckModLoops => { force!(check_mod_loops, def_id!()); }
1272         DepKind::CheckModUnstableApiUsage => { force!(check_mod_unstable_api_usage, def_id!()); }
1273         DepKind::CheckModItemTypes => { force!(check_mod_item_types, def_id!()); }
1274         DepKind::CheckModPrivacy => { force!(check_mod_privacy, def_id!()); }
1275         DepKind::CheckModIntrinsics => { force!(check_mod_intrinsics, def_id!()); }
1276         DepKind::CheckModLiveness => { force!(check_mod_liveness, def_id!()); }
1277         DepKind::CheckModImplWf => { force!(check_mod_impl_wf, def_id!()); }
1278         DepKind::CollectModItemTypes => { force!(collect_mod_item_types, def_id!()); }
1279         DepKind::Reachability => { force!(reachable_set, LOCAL_CRATE); }
1280         DepKind::CrateVariances => { force!(crate_variances, LOCAL_CRATE); }
1281         DepKind::AssociatedItems => { force!(associated_item, def_id!()); }
1282         DepKind::PredicatesDefinedOnItem => { force!(predicates_defined_on, def_id!()); }
1283         DepKind::ExplicitPredicatesOfItem => { force!(explicit_predicates_of, def_id!()); }
1284         DepKind::InferredOutlivesOf => { force!(inferred_outlives_of, def_id!()); }
1285         DepKind::InferredOutlivesCrate => { force!(inferred_outlives_crate, LOCAL_CRATE); }
1286         DepKind::SuperPredicatesOfItem => { force!(super_predicates_of, def_id!()); }
1287         DepKind::TraitDefOfItem => { force!(trait_def, def_id!()); }
1288         DepKind::AdtDefOfItem => { force!(adt_def, def_id!()); }
1289         DepKind::ImplTraitRef => { force!(impl_trait_ref, def_id!()); }
1290         DepKind::ImplPolarity => { force!(impl_polarity, def_id!()); }
1291         DepKind::Issue33140SelfTy => { force!(issue33140_self_ty, def_id!()); }
1292         DepKind::FnSignature => { force!(fn_sig, def_id!()); }
1293         DepKind::CoerceUnsizedInfo => { force!(coerce_unsized_info, def_id!()); }
1294         DepKind::ItemVariances => { force!(variances_of, def_id!()); }
1295         DepKind::IsConstFn => { force!(is_const_fn_raw, def_id!()); }
1296         DepKind::IsPromotableConstFn => { force!(is_promotable_const_fn, def_id!()); }
1297         DepKind::IsForeignItem => { force!(is_foreign_item, def_id!()); }
1298         DepKind::SizedConstraint => { force!(adt_sized_constraint, def_id!()); }
1299         DepKind::DtorckConstraint => { force!(adt_dtorck_constraint, def_id!()); }
1300         DepKind::AdtDestructor => { force!(adt_destructor, def_id!()); }
1301         DepKind::AssociatedItemDefIds => { force!(associated_item_def_ids, def_id!()); }
1302         DepKind::InherentImpls => { force!(inherent_impls, def_id!()); }
1303         DepKind::TypeckBodiesKrate => { force!(typeck_item_bodies, LOCAL_CRATE); }
1304         DepKind::TypeckTables => { force!(typeck_tables_of, def_id!()); }
1305         DepKind::UsedTraitImports => { force!(used_trait_imports, def_id!()); }
1306         DepKind::HasTypeckTables => { force!(has_typeck_tables, def_id!()); }
1307         DepKind::SpecializationGraph => { force!(specialization_graph_of, def_id!()); }
1308         DepKind::ObjectSafety => { force!(is_object_safe, def_id!()); }
1309         DepKind::TraitImpls => { force!(trait_impls_of, def_id!()); }
1310         DepKind::CheckMatch => { force!(check_match, def_id!()); }
1311
1312         DepKind::ParamEnv => { force!(param_env, def_id!()); }
1313         DepKind::DescribeDef => { force!(describe_def, def_id!()); }
1314         DepKind::DefSpan => { force!(def_span, def_id!()); }
1315         DepKind::LookupStability => { force!(lookup_stability, def_id!()); }
1316         DepKind::LookupDeprecationEntry => {
1317             force!(lookup_deprecation_entry, def_id!());
1318         }
1319         DepKind::ConstIsRvaluePromotableToStatic => {
1320             force!(const_is_rvalue_promotable_to_static, def_id!());
1321         }
1322         DepKind::RvaluePromotableMap => { force!(rvalue_promotable_map, def_id!()); }
1323         DepKind::ImplParent => { force!(impl_parent, def_id!()); }
1324         DepKind::TraitOfItem => { force!(trait_of_item, def_id!()); }
1325         DepKind::IsReachableNonGeneric => { force!(is_reachable_non_generic, def_id!()); }
1326         DepKind::IsUnreachableLocalDefinition => {
1327             force!(is_unreachable_local_definition, def_id!());
1328         }
1329         DepKind::IsMirAvailable => { force!(is_mir_available, def_id!()); }
1330         DepKind::ItemAttrs => { force!(item_attrs, def_id!()); }
1331         DepKind::CodegenFnAttrs => { force!(codegen_fn_attrs, def_id!()); }
1332         DepKind::FnArgNames => { force!(fn_arg_names, def_id!()); }
1333         DepKind::RenderedConst => { force!(rendered_const, def_id!()); }
1334         DepKind::DylibDepFormats => { force!(dylib_dependency_formats, krate!()); }
1335         DepKind::IsCompilerBuiltins => { force!(is_compiler_builtins, krate!()); }
1336         DepKind::HasGlobalAllocator => { force!(has_global_allocator, krate!()); }
1337         DepKind::HasPanicHandler => { force!(has_panic_handler, krate!()); }
1338         DepKind::ExternCrate => { force!(extern_crate, def_id!()); }
1339         DepKind::InScopeTraits => { force!(in_scope_traits_map, def_id!().index); }
1340         DepKind::ModuleExports => { force!(module_exports, def_id!()); }
1341         DepKind::IsSanitizerRuntime => { force!(is_sanitizer_runtime, krate!()); }
1342         DepKind::IsProfilerRuntime => { force!(is_profiler_runtime, krate!()); }
1343         DepKind::GetPanicStrategy => { force!(panic_strategy, krate!()); }
1344         DepKind::IsNoBuiltins => { force!(is_no_builtins, krate!()); }
1345         DepKind::ImplDefaultness => { force!(impl_defaultness, def_id!()); }
1346         DepKind::CheckItemWellFormed => { force!(check_item_well_formed, def_id!()); }
1347         DepKind::CheckTraitItemWellFormed => { force!(check_trait_item_well_formed, def_id!()); }
1348         DepKind::CheckImplItemWellFormed => { force!(check_impl_item_well_formed, def_id!()); }
1349         DepKind::ReachableNonGenerics => { force!(reachable_non_generics, krate!()); }
1350         DepKind::EntryFn => { force!(entry_fn, krate!()); }
1351         DepKind::PluginRegistrarFn => { force!(plugin_registrar_fn, krate!()); }
1352         DepKind::ProcMacroDeclsStatic => { force!(proc_macro_decls_static, krate!()); }
1353         DepKind::CrateDisambiguator => { force!(crate_disambiguator, krate!()); }
1354         DepKind::CrateHash => { force!(crate_hash, krate!()); }
1355         DepKind::OriginalCrateName => { force!(original_crate_name, krate!()); }
1356         DepKind::ExtraFileName => { force!(extra_filename, krate!()); }
1357         DepKind::Analysis => { force!(analysis, krate!()); }
1358
1359         DepKind::AllTraitImplementations => {
1360             force!(all_trait_implementations, krate!());
1361         }
1362
1363         DepKind::DllimportForeignItems => {
1364             force!(dllimport_foreign_items, krate!());
1365         }
1366         DepKind::IsDllimportForeignItem => {
1367             force!(is_dllimport_foreign_item, def_id!());
1368         }
1369         DepKind::IsStaticallyIncludedForeignItem => {
1370             force!(is_statically_included_foreign_item, def_id!());
1371         }
1372         DepKind::NativeLibraryKind => { force!(native_library_kind, def_id!()); }
1373         DepKind::LinkArgs => { force!(link_args, LOCAL_CRATE); }
1374
1375         DepKind::ResolveLifetimes => { force!(resolve_lifetimes, krate!()); }
1376         DepKind::NamedRegion => { force!(named_region_map, def_id!().index); }
1377         DepKind::IsLateBound => { force!(is_late_bound_map, def_id!().index); }
1378         DepKind::ObjectLifetimeDefaults => {
1379             force!(object_lifetime_defaults_map, def_id!().index);
1380         }
1381
1382         DepKind::Visibility => { force!(visibility, def_id!()); }
1383         DepKind::DepKind => { force!(dep_kind, krate!()); }
1384         DepKind::CrateName => { force!(crate_name, krate!()); }
1385         DepKind::ItemChildren => { force!(item_children, def_id!()); }
1386         DepKind::ExternModStmtCnum => { force!(extern_mod_stmt_cnum, def_id!()); }
1387         DepKind::GetLibFeatures => { force!(get_lib_features, LOCAL_CRATE); }
1388         DepKind::DefinedLibFeatures => { force!(defined_lib_features, krate!()); }
1389         DepKind::GetLangItems => { force!(get_lang_items, LOCAL_CRATE); }
1390         DepKind::DefinedLangItems => { force!(defined_lang_items, krate!()); }
1391         DepKind::MissingLangItems => { force!(missing_lang_items, krate!()); }
1392         DepKind::VisibleParentMap => { force!(visible_parent_map, LOCAL_CRATE); }
1393         DepKind::MissingExternCrateItem => {
1394             force!(missing_extern_crate_item, krate!());
1395         }
1396         DepKind::UsedCrateSource => { force!(used_crate_source, krate!()); }
1397         DepKind::PostorderCnums => { force!(postorder_cnums, LOCAL_CRATE); }
1398
1399         DepKind::Freevars => { force!(freevars, def_id!()); }
1400         DepKind::MaybeUnusedTraitImport => {
1401             force!(maybe_unused_trait_import, def_id!());
1402         }
1403         DepKind::NamesImportedByGlobUse => { force!(names_imported_by_glob_use, def_id!()); }
1404         DepKind::MaybeUnusedExternCrates => { force!(maybe_unused_extern_crates, LOCAL_CRATE); }
1405         DepKind::StabilityIndex => { force!(stability_index, LOCAL_CRATE); }
1406         DepKind::AllTraits => { force!(all_traits, LOCAL_CRATE); }
1407         DepKind::AllCrateNums => { force!(all_crate_nums, LOCAL_CRATE); }
1408         DepKind::ExportedSymbols => { force!(exported_symbols, krate!()); }
1409         DepKind::CollectAndPartitionMonoItems => {
1410             force!(collect_and_partition_mono_items, LOCAL_CRATE);
1411         }
1412         DepKind::IsCodegenedItem => { force!(is_codegened_item, def_id!()); }
1413         DepKind::OutputFilenames => { force!(output_filenames, LOCAL_CRATE); }
1414
1415         DepKind::TargetFeaturesWhitelist => { force!(target_features_whitelist, LOCAL_CRATE); }
1416
1417         DepKind::Features => { force!(features_query, LOCAL_CRATE); }
1418
1419         DepKind::ForeignModules => { force!(foreign_modules, krate!()); }
1420
1421         DepKind::UpstreamMonomorphizations => {
1422             force!(upstream_monomorphizations, krate!());
1423         }
1424         DepKind::UpstreamMonomorphizationsFor => {
1425             force!(upstream_monomorphizations_for, def_id!());
1426         }
1427         DepKind::BackendOptimizationLevel => {
1428             force!(backend_optimization_level, krate!());
1429         }
1430     );
1431
1432     true
1433 }
1434
1435
1436 // FIXME(#45015): Another piece of boilerplate code that could be generated in
1437 //                a combined define_dep_nodes!()/define_queries!() macro.
1438 macro_rules! impl_load_from_cache {
1439     ($($dep_kind:ident => $query_name:ident,)*) => {
1440         impl DepNode {
1441             // Check whether the query invocation corresponding to the given
1442             // DepNode is eligible for on-disk-caching.
1443             pub fn cache_on_disk(&self, tcx: TyCtxt<'_, '_, '_>) -> bool {
1444                 use crate::ty::query::queries;
1445                 use crate::ty::query::QueryDescription;
1446
1447                 match self.kind {
1448                     $(DepKind::$dep_kind => {
1449                         let def_id = self.extract_def_id(tcx).unwrap();
1450                         queries::$query_name::cache_on_disk(tcx.global_tcx(), def_id)
1451                     })*
1452                     _ => false
1453                 }
1454             }
1455
1456             // This is method will execute the query corresponding to the given
1457             // DepNode. It is only expected to work for DepNodes where the
1458             // above `cache_on_disk` methods returns true.
1459             // Also, as a sanity check, it expects that the corresponding query
1460             // invocation has been marked as green already.
1461             pub fn load_from_on_disk_cache(&self, tcx: TyCtxt<'_, '_, '_>) {
1462                 match self.kind {
1463                     $(DepKind::$dep_kind => {
1464                         debug_assert!(tcx.dep_graph
1465                                          .node_color(self)
1466                                          .map(|c| c.is_green())
1467                                          .unwrap_or(false));
1468
1469                         let def_id = self.extract_def_id(tcx).unwrap();
1470                         let _ = tcx.$query_name(def_id);
1471                     })*
1472                     _ => {
1473                         bug!()
1474                     }
1475                 }
1476             }
1477         }
1478     }
1479 }
1480
1481 impl_load_from_cache!(
1482     TypeckTables => typeck_tables_of,
1483     optimized_mir => optimized_mir,
1484     UnsafetyCheckResult => unsafety_check_result,
1485     BorrowCheck => borrowck,
1486     MirBorrowCheck => mir_borrowck,
1487     mir_const_qualif => mir_const_qualif,
1488     ConstIsRvaluePromotableToStatic => const_is_rvalue_promotable_to_static,
1489     CheckMatch => check_match,
1490     type_of => type_of,
1491     generics_of => generics_of,
1492     predicates_of => predicates_of,
1493     UsedTraitImports => used_trait_imports,
1494     CodegenFnAttrs => codegen_fn_attrs,
1495     SpecializationGraph => specialization_graph_of,
1496 );