1 use crate::creader::{CStore, LoadedMacro};
2 use crate::foreign_modules;
3 use crate::native_libs;
4 use crate::rmeta::encoder;
7 use rustc_data_structures::stable_map::FxHashMap;
8 use rustc_data_structures::svh::Svh;
10 use rustc_hir::def::{CtorKind, DefKind};
11 use rustc_hir::def_id::{CrateNum, DefId, DefIdMap, CRATE_DEF_INDEX, LOCAL_CRATE};
12 use rustc_hir::definitions::{DefKey, DefPath, DefPathHash};
13 use rustc_middle::hir::exports::Export;
14 use rustc_middle::middle::cstore::ForeignModule;
15 use rustc_middle::middle::cstore::{CrateSource, CrateStore, EncodedMetadata};
16 use rustc_middle::middle::exported_symbols::ExportedSymbol;
17 use rustc_middle::middle::stability::DeprecationEntry;
18 use rustc_middle::ty::query::Providers;
19 use rustc_middle::ty::{self, TyCtxt, Visibility};
20 use rustc_session::utils::NativeLibKind;
21 use rustc_session::{CrateDisambiguator, Session};
22 use rustc_span::source_map::{Span, Spanned};
23 use rustc_span::symbol::Symbol;
25 use rustc_data_structures::sync::Lrc;
26 use rustc_span::ExpnId;
27 use smallvec::SmallVec;
30 macro_rules! provide {
31 (<$lt:tt> $tcx:ident, $def_id:ident, $other:ident, $cdata:ident,
32 $($name:ident => $compute:block)*) => {
33 pub fn provide_extern(providers: &mut Providers) {
36 def_id_arg: ty::query::query_keys::$name<$lt>,
37 ) -> ty::query::query_values::$name<$lt> {
39 $tcx.prof.generic_activity(concat!("metadata_decode_entry_", stringify!($name)));
41 #[allow(unused_variables)]
42 let ($def_id, $other) = def_id_arg.into_args();
43 assert!(!$def_id.is_local());
45 // External query providers call `crate_hash` in order to register a dependency
46 // on the crate metadata. The exception is `crate_hash` itself, which obviously
47 // doesn't need to do this (and can't, as it would cause a query cycle).
48 use rustc_middle::dep_graph::DepKind;
49 if DepKind::$name != DepKind::crate_hash && $tcx.dep_graph.is_fully_enabled() {
50 $tcx.ensure().crate_hash($def_id.krate);
53 let $cdata = CStore::from_tcx($tcx).get_crate_data($def_id.krate);
58 *providers = Providers {
66 // small trait to work around different signature queries all being defined via
69 fn into_args(self) -> (DefId, DefId);
72 impl IntoArgs for DefId {
73 fn into_args(self) -> (DefId, DefId) {
78 impl IntoArgs for CrateNum {
79 fn into_args(self) -> (DefId, DefId) {
80 (self.as_def_id(), self.as_def_id())
84 impl IntoArgs for (CrateNum, DefId) {
85 fn into_args(self) -> (DefId, DefId) {
86 (self.0.as_def_id(), self.1)
90 provide! { <'tcx> tcx, def_id, other, cdata,
91 type_of => { cdata.get_type(def_id.index, tcx) }
92 generics_of => { cdata.get_generics(def_id.index, tcx.sess) }
93 explicit_predicates_of => { cdata.get_explicit_predicates(def_id.index, tcx) }
94 inferred_outlives_of => { cdata.get_inferred_outlives(def_id.index, tcx) }
95 super_predicates_of => { cdata.get_super_predicates(def_id.index, tcx) }
96 explicit_item_bounds => { cdata.get_explicit_item_bounds(def_id.index, tcx) }
97 trait_def => { cdata.get_trait_def(def_id.index, tcx.sess) }
98 adt_def => { cdata.get_adt_def(def_id.index, tcx) }
101 tcx.calculate_dtor(def_id, |_,_| Ok(()))
103 variances_of => { tcx.arena.alloc_from_iter(cdata.get_item_variances(def_id.index)) }
104 associated_item_def_ids => {
105 let mut result = SmallVec::<[_; 8]>::new();
106 cdata.each_child_of_item(def_id.index,
107 |child| result.push(child.res.def_id()), tcx.sess);
108 tcx.arena.alloc_slice(&result)
110 associated_item => { cdata.get_associated_item(def_id.index, tcx.sess) }
111 impl_trait_ref => { cdata.get_impl_trait(def_id.index, tcx) }
112 impl_polarity => { cdata.get_impl_polarity(def_id.index) }
113 coerce_unsized_info => {
114 cdata.get_coerce_unsized_info(def_id.index).unwrap_or_else(|| {
115 bug!("coerce_unsized_info: `{:?}` is missing its info", def_id);
118 optimized_mir => { tcx.arena.alloc(cdata.get_optimized_mir(tcx, def_id.index)) }
119 mir_for_ctfe => { tcx.arena.alloc(cdata.get_mir_for_ctfe(tcx, def_id.index)) }
120 promoted_mir => { tcx.arena.alloc(cdata.get_promoted_mir(tcx, def_id.index)) }
121 mir_abstract_const => { cdata.get_mir_abstract_const(tcx, def_id.index) }
122 unused_generic_params => { cdata.get_unused_generic_params(def_id.index) }
123 const_param_default => { tcx.mk_const(cdata.get_const_param_default(tcx, def_id.index)) }
124 mir_const_qualif => { cdata.mir_const_qualif(def_id.index) }
125 fn_sig => { cdata.fn_sig(def_id.index, tcx) }
126 inherent_impls => { cdata.get_inherent_implementations_for_type(tcx, def_id.index) }
127 is_const_fn_raw => { cdata.is_const_fn_raw(def_id.index) }
128 asyncness => { cdata.asyncness(def_id.index) }
129 is_foreign_item => { cdata.is_foreign_item(def_id.index) }
130 static_mutability => { cdata.static_mutability(def_id.index) }
131 generator_kind => { cdata.generator_kind(def_id.index) }
132 opt_def_kind => { Some(cdata.def_kind(def_id.index)) }
133 def_span => { cdata.get_span(def_id.index, &tcx.sess) }
135 cdata.try_item_ident(def_id.index, &tcx.sess).ok().map(|ident| ident.span)
137 lookup_stability => {
138 cdata.get_stability(def_id.index).map(|s| tcx.intern_stability(s))
140 lookup_const_stability => {
141 cdata.get_const_stability(def_id.index).map(|s| tcx.intern_const_stability(s))
143 lookup_deprecation_entry => {
144 cdata.get_deprecation(def_id.index).map(DeprecationEntry::external)
146 item_attrs => { tcx.arena.alloc_from_iter(
147 cdata.get_item_attrs(def_id.index, tcx.sess)
149 fn_arg_names => { cdata.get_fn_param_names(tcx, def_id.index) }
150 rendered_const => { cdata.get_rendered_const(def_id.index) }
151 impl_parent => { cdata.get_parent_impl(def_id.index) }
152 trait_of_item => { cdata.get_trait_of_item(def_id.index) }
153 is_mir_available => { cdata.is_item_mir_available(def_id.index) }
154 is_ctfe_mir_available => { cdata.is_ctfe_mir_available(def_id.index) }
156 dylib_dependency_formats => { cdata.get_dylib_dependency_formats(tcx) }
157 is_private_dep => { cdata.private_dep }
158 is_panic_runtime => { cdata.root.panic_runtime }
159 is_compiler_builtins => { cdata.root.compiler_builtins }
160 has_global_allocator => { cdata.root.has_global_allocator }
161 has_panic_handler => { cdata.root.has_panic_handler }
162 is_profiler_runtime => { cdata.root.profiler_runtime }
163 panic_strategy => { cdata.root.panic_strategy }
165 let r = *cdata.extern_crate.lock();
166 r.map(|c| &*tcx.arena.alloc(c))
168 is_no_builtins => { cdata.root.no_builtins }
169 symbol_mangling_version => { cdata.root.symbol_mangling_version }
170 impl_defaultness => { cdata.get_impl_defaultness(def_id.index) }
171 reachable_non_generics => {
172 let reachable_non_generics = tcx
173 .exported_symbols(cdata.cnum)
175 .filter_map(|&(exported_symbol, export_level)| {
176 if let ExportedSymbol::NonGeneric(def_id) = exported_symbol {
177 Some((def_id, export_level))
184 reachable_non_generics
186 native_libraries => { Lrc::new(cdata.get_native_libraries(tcx.sess)) }
187 foreign_modules => { cdata.get_foreign_modules(tcx) }
188 crate_disambiguator => { cdata.root.disambiguator }
189 crate_hash => { cdata.root.hash }
190 crate_host_hash => { cdata.host_hash }
191 crate_name => { cdata.root.name }
193 extra_filename => { cdata.root.extra_filename.clone() }
195 implementations_of_trait => {
196 cdata.get_implementations_for_trait(tcx, Some(other))
199 all_trait_implementations => {
200 cdata.get_implementations_for_trait(tcx, None)
203 visibility => { cdata.get_visibility(def_id.index) }
205 let r = *cdata.dep_kind.lock();
209 let mut result = SmallVec::<[_; 8]>::new();
210 cdata.each_child_of_item(def_id.index, |child| result.push(child), tcx.sess);
211 tcx.arena.alloc_slice(&result)
213 defined_lib_features => { cdata.get_lib_features(tcx) }
214 defined_lang_items => { cdata.get_lang_items(tcx) }
215 diagnostic_items => { cdata.get_diagnostic_items() }
216 missing_lang_items => { cdata.get_missing_lang_items(tcx) }
218 missing_extern_crate_item => {
219 let r = matches!(*cdata.extern_crate.borrow(), Some(extern_crate) if !extern_crate.is_direct());
223 used_crate_source => { Lrc::new(cdata.source.clone()) }
225 exported_symbols => {
226 let syms = cdata.exported_symbols(tcx);
228 // FIXME rust-lang/rust#64319, rust-lang/rust#64872: We want
229 // to block export of generics from dylibs, but we must fix
230 // rust-lang/rust#65890 before we can do that robustly.
235 crate_extern_paths => { cdata.source().paths().cloned().collect() }
236 expn_that_defined => { cdata.get_expn_that_defined(def_id.index, tcx.sess) }
239 pub fn provide(providers: &mut Providers) {
240 // FIXME(#44234) - almost all of these queries have no sub-queries and
241 // therefore no actual inputs, they're just reading tables calculated in
242 // resolve! Does this work? Unsure! That's what the issue is about
243 *providers = Providers {
244 allocator_kind: |tcx, ()| CStore::from_tcx(tcx).allocator_kind(),
245 is_dllimport_foreign_item: |tcx, id| match tcx.native_library_kind(id) {
247 NativeLibKind::Dylib { .. } | NativeLibKind::RawDylib | NativeLibKind::Unspecified,
251 is_statically_included_foreign_item: |tcx, id| {
252 matches!(tcx.native_library_kind(id), Some(NativeLibKind::Static { .. }))
254 is_private_dep: |_tcx, cnum| {
255 assert_eq!(cnum, LOCAL_CRATE);
258 native_library_kind: |tcx, id| {
259 tcx.native_libraries(id.krate)
261 .filter(|lib| native_libs::relevant_lib(&tcx.sess, lib))
263 let fm_id = match lib.foreign_module {
265 None => return false,
267 let map = tcx.foreign_modules(id.krate);
269 .expect("failed to find foreign module")
275 native_libraries: |tcx, cnum| {
276 assert_eq!(cnum, LOCAL_CRATE);
277 Lrc::new(native_libs::collect(tcx))
279 foreign_modules: |tcx, cnum| {
280 assert_eq!(cnum, LOCAL_CRATE);
281 let modules: FxHashMap<DefId, ForeignModule> =
282 foreign_modules::collect(tcx).into_iter().map(|m| (m.def_id, m)).collect();
286 // Returns a map from a sufficiently visible external item (i.e., an
287 // external item that is visible from at least one local module) to a
288 // sufficiently visible parent (considering modules that re-export the
289 // external item to be parents).
290 visible_parent_map: |tcx, ()| {
291 use std::collections::hash_map::Entry;
292 use std::collections::vec_deque::VecDeque;
294 let mut visible_parent_map: DefIdMap<DefId> = Default::default();
296 // Issue 46112: We want the map to prefer the shortest
297 // paths when reporting the path to an item. Therefore we
298 // build up the map via a breadth-first search (BFS),
299 // which naturally yields minimal-length paths.
301 // Note that it needs to be a BFS over the whole forest of
302 // crates, not just each individual crate; otherwise you
303 // only get paths that are locally minimal with respect to
304 // whatever crate we happened to encounter first in this
305 // traversal, but not globally minimal across all crates.
306 let bfs_queue = &mut VecDeque::new();
308 // Preferring shortest paths alone does not guarantee a
309 // deterministic result; so sort by crate num to avoid
310 // hashtable iteration non-determinism. This only makes
311 // things as deterministic as crate-nums assignment is,
312 // which is to say, its not deterministic in general. But
313 // we believe that libstd is consistently assigned crate
314 // num 1, so it should be enough to resolve #46112.
315 let mut crates: Vec<CrateNum> = (*tcx.crates(())).to_owned();
318 for &cnum in crates.iter() {
319 // Ignore crates without a corresponding local `extern crate` item.
320 if tcx.missing_extern_crate_item(cnum) {
324 bfs_queue.push_back(DefId { krate: cnum, index: CRATE_DEF_INDEX });
327 // (restrict scope of mutable-borrow of `visible_parent_map`)
329 let visible_parent_map = &mut visible_parent_map;
331 |bfs_queue: &mut VecDeque<_>, child: &Export<hir::HirId>, parent: DefId| {
332 if child.vis != ty::Visibility::Public {
336 if let Some(child) = child.res.opt_def_id() {
337 match visible_parent_map.entry(child) {
338 Entry::Occupied(mut entry) => {
339 // If `child` is defined in crate `cnum`, ensure
340 // that it is mapped to a parent in `cnum`.
341 if child.is_local() && entry.get().is_local() {
342 entry.insert(parent);
345 Entry::Vacant(entry) => {
346 entry.insert(parent);
347 bfs_queue.push_back(child);
353 while let Some(def) = bfs_queue.pop_front() {
354 for child in tcx.item_children(def).iter() {
355 add_child(bfs_queue, child, def);
363 dependency_formats: |tcx, ()| Lrc::new(crate::dependency_format::calculate(tcx)),
364 has_global_allocator: |tcx, cnum| {
365 assert_eq!(cnum, LOCAL_CRATE);
366 CStore::from_tcx(tcx).has_global_allocator()
368 postorder_cnums: |tcx, ()| {
370 .alloc_slice(&CStore::from_tcx(tcx).crate_dependencies_in_postorder(LOCAL_CRATE))
378 pub fn struct_field_names_untracked(&self, def: DefId, sess: &Session) -> Vec<Spanned<Symbol>> {
379 self.get_crate_data(def.krate).get_struct_field_names(def.index, sess)
382 pub fn struct_field_visibilities_untracked(&self, def: DefId) -> Vec<Visibility> {
383 self.get_crate_data(def.krate).get_struct_field_visibilities(def.index)
386 pub fn ctor_def_id_and_kind_untracked(&self, def: DefId) -> Option<(DefId, CtorKind)> {
387 self.get_crate_data(def.krate).get_ctor_def_id(def.index).map(|ctor_def_id| {
388 (ctor_def_id, self.get_crate_data(def.krate).get_ctor_kind(def.index))
392 pub fn visibility_untracked(&self, def: DefId) -> Visibility {
393 self.get_crate_data(def.krate).get_visibility(def.index)
396 pub fn item_children_untracked(
400 ) -> Vec<Export<hir::HirId>> {
401 let mut result = vec![];
402 self.get_crate_data(def_id.krate).each_child_of_item(
404 |child| result.push(child),
410 pub fn load_macro_untracked(&self, id: DefId, sess: &Session) -> LoadedMacro {
411 let _prof_timer = sess.prof.generic_activity("metadata_load_macro");
413 let data = self.get_crate_data(id.krate);
414 if data.root.is_proc_macro_crate() {
415 return LoadedMacro::ProcMacro(data.load_proc_macro(id, sess));
418 let span = data.get_span(id.index, sess);
420 let attrs = data.get_item_attrs(id.index, sess).collect();
422 let ident = data.item_ident(id.index, sess);
424 LoadedMacro::MacroDef(
427 id: ast::DUMMY_NODE_ID,
430 kind: ast::ItemKind::MacroDef(data.get_macro(id.index, sess)),
431 vis: ast::Visibility {
432 span: span.shrink_to_lo(),
433 kind: ast::VisibilityKind::Inherited,
442 pub fn associated_item_cloned_untracked(&self, def: DefId, sess: &Session) -> ty::AssocItem {
443 self.get_crate_data(def.krate).get_associated_item(def.index, sess)
446 pub fn crate_source_untracked(&self, cnum: CrateNum) -> CrateSource {
447 self.get_crate_data(cnum).source.clone()
450 pub fn get_span_untracked(&self, def_id: DefId, sess: &Session) -> Span {
451 self.get_crate_data(def_id.krate).get_span(def_id.index, sess)
454 pub fn item_generics_num_lifetimes(&self, def_id: DefId, sess: &Session) -> usize {
455 self.get_crate_data(def_id.krate).get_generics(def_id.index, sess).own_counts().lifetimes
458 pub fn module_expansion_untracked(&self, def_id: DefId, sess: &Session) -> ExpnId {
459 self.get_crate_data(def_id.krate).module_expansion(def_id.index, sess)
462 /// Only public-facing way to traverse all the definitions in a non-local crate.
463 /// Critically useful for this third-party project: <https://github.com/hacspec/hacspec>.
464 /// See <https://github.com/rust-lang/rust/pull/85889> for context.
465 pub fn num_def_ids_untracked(&self, cnum: CrateNum) -> usize {
466 self.get_crate_data(cnum).num_def_ids()
469 pub fn item_attrs(&self, def_id: DefId, sess: &Session) -> Vec<ast::Attribute> {
470 self.get_crate_data(def_id.krate).get_item_attrs(def_id.index, sess).collect()
473 pub fn get_proc_macro_quoted_span_untracked(
479 self.get_crate_data(cnum).get_proc_macro_quoted_span(id, sess)
483 impl CrateStore for CStore {
484 fn as_any(&self) -> &dyn Any {
488 fn crate_name_untracked(&self, cnum: CrateNum) -> Symbol {
489 self.get_crate_data(cnum).root.name
492 fn crate_disambiguator_untracked(&self, cnum: CrateNum) -> CrateDisambiguator {
493 self.get_crate_data(cnum).root.disambiguator
496 fn crate_hash_untracked(&self, cnum: CrateNum) -> Svh {
497 self.get_crate_data(cnum).root.hash
500 /// Returns the `DefKey` for a given `DefId`. This indicates the
501 /// parent `DefId` as well as some idea of what kind of data the
502 /// `DefId` refers to.
503 fn def_key(&self, def: DefId) -> DefKey {
504 self.get_crate_data(def.krate).def_key(def.index)
507 fn def_kind(&self, def: DefId) -> DefKind {
508 self.get_crate_data(def.krate).def_kind(def.index)
511 fn def_path(&self, def: DefId) -> DefPath {
512 self.get_crate_data(def.krate).def_path(def.index)
515 fn def_path_hash(&self, def: DefId) -> DefPathHash {
516 self.get_crate_data(def.krate).def_path_hash(def.index)
519 // See `CrateMetadataRef::def_path_hash_to_def_id` for more details
520 fn def_path_hash_to_def_id(
526 self.get_crate_data(cnum).def_path_hash_to_def_id(cnum, index_guess, hash)
529 fn crates_untracked(&self) -> Vec<CrateNum> {
530 let mut result = vec![];
531 self.iter_crate_data(|cnum, _| result.push(cnum));
535 fn encode_metadata(&self, tcx: TyCtxt<'_>) -> EncodedMetadata {
536 encoder::encode_metadata(tcx)