1 use crate::creader::{CStore, LoadedMacro};
2 use crate::foreign_modules;
3 use crate::native_libs;
6 use rustc_data_structures::stable_map::FxHashMap;
7 use rustc_hir::def::{CtorKind, DefKind};
8 use rustc_hir::def_id::{CrateNum, DefId, DefIdMap, CRATE_DEF_INDEX, LOCAL_CRATE};
9 use rustc_hir::definitions::{DefKey, DefPath, DefPathHash};
10 use rustc_middle::hir::exports::Export;
11 use rustc_middle::middle::exported_symbols::ExportedSymbol;
12 use rustc_middle::middle::stability::DeprecationEntry;
13 use rustc_middle::ty::query::Providers;
14 use rustc_middle::ty::{self, TyCtxt, Visibility};
15 use rustc_session::cstore::{CrateSource, CrateStore, ForeignModule};
16 use rustc_session::utils::NativeLibKind;
17 use rustc_session::{Session, StableCrateId};
18 use rustc_span::hygiene::{ExpnHash, ExpnId};
19 use rustc_span::source_map::{Span, Spanned};
20 use rustc_span::symbol::Symbol;
22 use rustc_data_structures::sync::Lrc;
23 use smallvec::SmallVec;
26 macro_rules! provide {
27 (<$lt:tt> $tcx:ident, $def_id:ident, $other:ident, $cdata:ident,
28 $($name:ident => $compute:block)*) => {
29 pub fn provide_extern(providers: &mut Providers) {
32 def_id_arg: ty::query::query_keys::$name<$lt>,
33 ) -> ty::query::query_values::$name<$lt> {
35 $tcx.prof.generic_activity(concat!("metadata_decode_entry_", stringify!($name)));
37 #[allow(unused_variables)]
38 let ($def_id, $other) = def_id_arg.into_args();
39 assert!(!$def_id.is_local());
41 // External query providers call `crate_hash` in order to register a dependency
42 // on the crate metadata. The exception is `crate_hash` itself, which obviously
43 // doesn't need to do this (and can't, as it would cause a query cycle).
44 use rustc_middle::dep_graph::DepKind;
45 if DepKind::$name != DepKind::crate_hash && $tcx.dep_graph.is_fully_enabled() {
46 $tcx.ensure().crate_hash($def_id.krate);
49 let $cdata = CStore::from_tcx($tcx).get_crate_data($def_id.krate);
54 *providers = Providers {
62 // small trait to work around different signature queries all being defined via
65 fn into_args(self) -> (DefId, DefId);
68 impl IntoArgs for DefId {
69 fn into_args(self) -> (DefId, DefId) {
74 impl IntoArgs for CrateNum {
75 fn into_args(self) -> (DefId, DefId) {
76 (self.as_def_id(), self.as_def_id())
80 impl IntoArgs for (CrateNum, DefId) {
81 fn into_args(self) -> (DefId, DefId) {
82 (self.0.as_def_id(), self.1)
86 impl IntoArgs for ty::InstanceDef<'tcx> {
87 fn into_args(self) -> (DefId, DefId) {
88 (self.def_id(), self.def_id())
92 provide! { <'tcx> tcx, def_id, other, cdata,
93 type_of => { cdata.get_type(def_id.index, tcx) }
94 generics_of => { cdata.get_generics(def_id.index, tcx.sess) }
95 explicit_predicates_of => { cdata.get_explicit_predicates(def_id.index, tcx) }
96 inferred_outlives_of => { cdata.get_inferred_outlives(def_id.index, tcx) }
97 super_predicates_of => { cdata.get_super_predicates(def_id.index, tcx) }
98 explicit_item_bounds => { cdata.get_explicit_item_bounds(def_id.index, tcx) }
99 trait_def => { cdata.get_trait_def(def_id.index, tcx.sess) }
100 adt_def => { cdata.get_adt_def(def_id.index, tcx) }
103 tcx.calculate_dtor(def_id, |_,_| Ok(()))
105 variances_of => { tcx.arena.alloc_from_iter(cdata.get_item_variances(def_id.index)) }
106 associated_item_def_ids => {
107 let mut result = SmallVec::<[_; 8]>::new();
108 cdata.each_child_of_item(def_id.index,
109 |child| result.push(child.res.def_id()), tcx.sess);
110 tcx.arena.alloc_slice(&result)
112 associated_item => { cdata.get_associated_item(def_id.index, tcx.sess) }
113 impl_trait_ref => { cdata.get_impl_trait(def_id.index, tcx) }
114 impl_polarity => { cdata.get_impl_polarity(def_id.index) }
115 coerce_unsized_info => {
116 cdata.get_coerce_unsized_info(def_id.index).unwrap_or_else(|| {
117 bug!("coerce_unsized_info: `{:?}` is missing its info", def_id);
120 optimized_mir => { tcx.arena.alloc(cdata.get_optimized_mir(tcx, def_id.index)) }
121 mir_for_ctfe => { tcx.arena.alloc(cdata.get_mir_for_ctfe(tcx, def_id.index)) }
122 promoted_mir => { tcx.arena.alloc(cdata.get_promoted_mir(tcx, def_id.index)) }
123 thir_abstract_const => { cdata.get_thir_abstract_const(tcx, def_id.index) }
124 unused_generic_params => { cdata.get_unused_generic_params(def_id.index) }
125 const_param_default => { tcx.mk_const(cdata.get_const_param_default(tcx, def_id.index)) }
126 mir_const_qualif => { cdata.mir_const_qualif(def_id.index) }
127 fn_sig => { cdata.fn_sig(def_id.index, tcx) }
128 inherent_impls => { cdata.get_inherent_implementations_for_type(tcx, def_id.index) }
129 is_const_fn_raw => { cdata.is_const_fn_raw(def_id.index) }
130 asyncness => { cdata.asyncness(def_id.index) }
131 is_foreign_item => { cdata.is_foreign_item(def_id.index) }
132 static_mutability => { cdata.static_mutability(def_id.index) }
133 generator_kind => { cdata.generator_kind(def_id.index) }
134 opt_def_kind => { Some(cdata.def_kind(def_id.index)) }
135 def_span => { cdata.get_span(def_id.index, &tcx.sess) }
137 cdata.try_item_ident(def_id.index, &tcx.sess).ok().map(|ident| ident.span)
139 lookup_stability => {
140 cdata.get_stability(def_id.index).map(|s| tcx.intern_stability(s))
142 lookup_const_stability => {
143 cdata.get_const_stability(def_id.index).map(|s| tcx.intern_const_stability(s))
145 lookup_deprecation_entry => {
146 cdata.get_deprecation(def_id.index).map(DeprecationEntry::external)
148 item_attrs => { tcx.arena.alloc_from_iter(
149 cdata.get_item_attrs(def_id.index, tcx.sess)
151 fn_arg_names => { cdata.get_fn_param_names(tcx, def_id.index) }
152 rendered_const => { cdata.get_rendered_const(def_id.index) }
153 impl_parent => { cdata.get_parent_impl(def_id.index) }
154 trait_of_item => { cdata.get_trait_of_item(def_id.index) }
155 is_mir_available => { cdata.is_item_mir_available(def_id.index) }
156 is_ctfe_mir_available => { cdata.is_ctfe_mir_available(def_id.index) }
158 dylib_dependency_formats => { cdata.get_dylib_dependency_formats(tcx) }
159 is_private_dep => { cdata.private_dep }
160 is_panic_runtime => { cdata.root.panic_runtime }
161 is_compiler_builtins => { cdata.root.compiler_builtins }
162 has_global_allocator => { cdata.root.has_global_allocator }
163 has_panic_handler => { cdata.root.has_panic_handler }
164 is_profiler_runtime => { cdata.root.profiler_runtime }
165 panic_strategy => { cdata.root.panic_strategy }
166 panic_in_drop_strategy => { cdata.root.panic_in_drop_strategy }
168 let r = *cdata.extern_crate.lock();
169 r.map(|c| &*tcx.arena.alloc(c))
171 is_no_builtins => { cdata.root.no_builtins }
172 symbol_mangling_version => { cdata.root.symbol_mangling_version }
173 impl_defaultness => { cdata.get_impl_defaultness(def_id.index) }
174 impl_constness => { cdata.get_impl_constness(def_id.index) }
175 reachable_non_generics => {
176 let reachable_non_generics = tcx
177 .exported_symbols(cdata.cnum)
179 .filter_map(|&(exported_symbol, export_level)| {
180 if let ExportedSymbol::NonGeneric(def_id) = exported_symbol {
181 Some((def_id, export_level))
188 reachable_non_generics
190 native_libraries => { Lrc::new(cdata.get_native_libraries(tcx.sess)) }
191 foreign_modules => { cdata.get_foreign_modules(tcx) }
192 crate_hash => { cdata.root.hash }
193 crate_host_hash => { cdata.host_hash }
194 crate_name => { cdata.root.name }
196 extra_filename => { cdata.root.extra_filename.clone() }
198 implementations_of_trait => {
199 cdata.get_implementations_for_trait(tcx, Some(other))
202 all_trait_implementations => {
203 cdata.get_implementations_for_trait(tcx, None)
206 visibility => { cdata.get_visibility(def_id.index) }
208 let r = *cdata.dep_kind.lock();
212 let mut result = SmallVec::<[_; 8]>::new();
213 cdata.each_child_of_item(def_id.index, |child| result.push(child), tcx.sess);
214 tcx.arena.alloc_slice(&result)
216 defined_lib_features => { cdata.get_lib_features(tcx) }
217 defined_lang_items => { cdata.get_lang_items(tcx) }
218 diagnostic_items => { cdata.get_diagnostic_items() }
219 missing_lang_items => { cdata.get_missing_lang_items(tcx) }
221 missing_extern_crate_item => {
222 let r = matches!(*cdata.extern_crate.borrow(), Some(extern_crate) if !extern_crate.is_direct());
226 used_crate_source => { Lrc::new(cdata.source.clone()) }
228 exported_symbols => {
229 let syms = cdata.exported_symbols(tcx);
231 // FIXME rust-lang/rust#64319, rust-lang/rust#64872: We want
232 // to block export of generics from dylibs, but we must fix
233 // rust-lang/rust#65890 before we can do that robustly.
238 crate_extern_paths => { cdata.source().paths().cloned().collect() }
239 expn_that_defined => { cdata.get_expn_that_defined(def_id.index, tcx.sess) }
242 pub fn provide(providers: &mut Providers) {
243 // FIXME(#44234) - almost all of these queries have no sub-queries and
244 // therefore no actual inputs, they're just reading tables calculated in
245 // resolve! Does this work? Unsure! That's what the issue is about
246 *providers = Providers {
247 allocator_kind: |tcx, ()| CStore::from_tcx(tcx).allocator_kind(),
248 is_dllimport_foreign_item: |tcx, id| match tcx.native_library_kind(id) {
250 NativeLibKind::Dylib { .. } | NativeLibKind::RawDylib | NativeLibKind::Unspecified,
254 is_statically_included_foreign_item: |tcx, id| {
255 matches!(tcx.native_library_kind(id), Some(NativeLibKind::Static { .. }))
257 is_private_dep: |_tcx, cnum| {
258 assert_eq!(cnum, LOCAL_CRATE);
261 native_library_kind: |tcx, id| {
262 tcx.native_libraries(id.krate)
264 .filter(|lib| native_libs::relevant_lib(&tcx.sess, lib))
266 let fm_id = match lib.foreign_module {
268 None => return false,
270 let map = tcx.foreign_modules(id.krate);
272 .expect("failed to find foreign module")
278 native_libraries: |tcx, cnum| {
279 assert_eq!(cnum, LOCAL_CRATE);
280 Lrc::new(native_libs::collect(tcx))
282 foreign_modules: |tcx, cnum| {
283 assert_eq!(cnum, LOCAL_CRATE);
284 let modules: FxHashMap<DefId, ForeignModule> =
285 foreign_modules::collect(tcx).into_iter().map(|m| (m.def_id, m)).collect();
289 // Returns a map from a sufficiently visible external item (i.e., an
290 // external item that is visible from at least one local module) to a
291 // sufficiently visible parent (considering modules that re-export the
292 // external item to be parents).
293 visible_parent_map: |tcx, ()| {
294 use std::collections::hash_map::Entry;
295 use std::collections::vec_deque::VecDeque;
297 let mut visible_parent_map: DefIdMap<DefId> = Default::default();
299 // Issue 46112: We want the map to prefer the shortest
300 // paths when reporting the path to an item. Therefore we
301 // build up the map via a breadth-first search (BFS),
302 // which naturally yields minimal-length paths.
304 // Note that it needs to be a BFS over the whole forest of
305 // crates, not just each individual crate; otherwise you
306 // only get paths that are locally minimal with respect to
307 // whatever crate we happened to encounter first in this
308 // traversal, but not globally minimal across all crates.
309 let bfs_queue = &mut VecDeque::new();
311 for &cnum in tcx.crates(()) {
312 // Ignore crates without a corresponding local `extern crate` item.
313 if tcx.missing_extern_crate_item(cnum) {
317 bfs_queue.push_back(DefId { krate: cnum, index: CRATE_DEF_INDEX });
320 let mut add_child = |bfs_queue: &mut VecDeque<_>, child: &Export, parent: DefId| {
321 if child.vis != ty::Visibility::Public {
325 if let Some(child) = child.res.opt_def_id() {
326 match visible_parent_map.entry(child) {
327 Entry::Occupied(mut entry) => {
328 // If `child` is defined in crate `cnum`, ensure
329 // that it is mapped to a parent in `cnum`.
330 if child.is_local() && entry.get().is_local() {
331 entry.insert(parent);
334 Entry::Vacant(entry) => {
335 entry.insert(parent);
336 bfs_queue.push_back(child);
342 while let Some(def) = bfs_queue.pop_front() {
343 for child in tcx.item_children(def).iter() {
344 add_child(bfs_queue, child, def);
351 dependency_formats: |tcx, ()| Lrc::new(crate::dependency_format::calculate(tcx)),
352 has_global_allocator: |tcx, cnum| {
353 assert_eq!(cnum, LOCAL_CRATE);
354 CStore::from_tcx(tcx).has_global_allocator()
356 postorder_cnums: |tcx, ()| {
358 .alloc_slice(&CStore::from_tcx(tcx).crate_dependencies_in_postorder(LOCAL_CRATE))
360 crates: |tcx, ()| tcx.arena.alloc_slice(&CStore::from_tcx(tcx).crates_untracked()),
367 pub fn struct_field_names_untracked(&self, def: DefId, sess: &Session) -> Vec<Spanned<Symbol>> {
368 self.get_crate_data(def.krate).get_struct_field_names(def.index, sess)
371 pub fn struct_field_visibilities_untracked(&self, def: DefId) -> Vec<Visibility> {
372 self.get_crate_data(def.krate).get_struct_field_visibilities(def.index)
375 pub fn ctor_def_id_and_kind_untracked(&self, def: DefId) -> Option<(DefId, CtorKind)> {
376 self.get_crate_data(def.krate).get_ctor_def_id(def.index).map(|ctor_def_id| {
377 (ctor_def_id, self.get_crate_data(def.krate).get_ctor_kind(def.index))
381 pub fn visibility_untracked(&self, def: DefId) -> Visibility {
382 self.get_crate_data(def.krate).get_visibility(def.index)
385 pub fn item_children_untracked(&self, def_id: DefId, sess: &Session) -> Vec<Export> {
386 let mut result = vec![];
387 self.get_crate_data(def_id.krate).each_child_of_item(
389 |child| result.push(child),
395 pub fn load_macro_untracked(&self, id: DefId, sess: &Session) -> LoadedMacro {
396 let _prof_timer = sess.prof.generic_activity("metadata_load_macro");
398 let data = self.get_crate_data(id.krate);
399 if data.root.is_proc_macro_crate() {
400 return LoadedMacro::ProcMacro(data.load_proc_macro(id.index, sess));
403 let span = data.get_span(id.index, sess);
405 let attrs = data.get_item_attrs(id.index, sess).collect();
407 let ident = data.item_ident(id.index, sess);
409 LoadedMacro::MacroDef(
412 id: ast::DUMMY_NODE_ID,
415 kind: ast::ItemKind::MacroDef(data.get_macro(id.index, sess)),
416 vis: ast::Visibility {
417 span: span.shrink_to_lo(),
418 kind: ast::VisibilityKind::Inherited,
427 pub fn associated_item_cloned_untracked(&self, def: DefId, sess: &Session) -> ty::AssocItem {
428 self.get_crate_data(def.krate).get_associated_item(def.index, sess)
431 pub fn crate_source_untracked(&self, cnum: CrateNum) -> CrateSource {
432 self.get_crate_data(cnum).source.clone()
435 pub fn get_span_untracked(&self, def_id: DefId, sess: &Session) -> Span {
436 self.get_crate_data(def_id.krate).get_span(def_id.index, sess)
439 pub fn def_kind(&self, def: DefId) -> DefKind {
440 self.get_crate_data(def.krate).def_kind(def.index)
443 pub fn crates_untracked(&self) -> Vec<CrateNum> {
444 let mut result = vec![];
445 self.iter_crate_data(|cnum, _| result.push(cnum));
449 pub fn item_generics_num_lifetimes(&self, def_id: DefId, sess: &Session) -> usize {
450 self.get_crate_data(def_id.krate).get_generics(def_id.index, sess).own_counts().lifetimes
453 pub fn module_expansion_untracked(&self, def_id: DefId, sess: &Session) -> ExpnId {
454 self.get_crate_data(def_id.krate).module_expansion(def_id.index, sess)
457 /// Only public-facing way to traverse all the definitions in a non-local crate.
458 /// Critically useful for this third-party project: <https://github.com/hacspec/hacspec>.
459 /// See <https://github.com/rust-lang/rust/pull/85889> for context.
460 pub fn num_def_ids_untracked(&self, cnum: CrateNum) -> usize {
461 self.get_crate_data(cnum).num_def_ids()
464 pub fn item_attrs(&self, def_id: DefId, sess: &Session) -> Vec<ast::Attribute> {
465 self.get_crate_data(def_id.krate).get_item_attrs(def_id.index, sess).collect()
468 pub fn get_proc_macro_quoted_span_untracked(
474 self.get_crate_data(cnum).get_proc_macro_quoted_span(id, sess)
478 impl CrateStore for CStore {
479 fn as_any(&self) -> &dyn Any {
483 fn crate_name(&self, cnum: CrateNum) -> Symbol {
484 self.get_crate_data(cnum).root.name
487 fn stable_crate_id(&self, cnum: CrateNum) -> StableCrateId {
488 self.get_crate_data(cnum).root.stable_crate_id
491 fn stable_crate_id_to_crate_num(&self, stable_crate_id: StableCrateId) -> CrateNum {
492 self.stable_crate_ids[&stable_crate_id]
495 /// Returns the `DefKey` for a given `DefId`. This indicates the
496 /// parent `DefId` as well as some idea of what kind of data the
497 /// `DefId` refers to.
498 fn def_key(&self, def: DefId) -> DefKey {
499 self.get_crate_data(def.krate).def_key(def.index)
502 fn def_path(&self, def: DefId) -> DefPath {
503 self.get_crate_data(def.krate).def_path(def.index)
506 fn def_path_hash(&self, def: DefId) -> DefPathHash {
507 self.get_crate_data(def.krate).def_path_hash(def.index)
510 fn def_path_hash_to_def_id(&self, cnum: CrateNum, hash: DefPathHash) -> DefId {
511 let def_index = self.get_crate_data(cnum).def_path_hash_to_def_index(hash);
512 DefId { krate: cnum, index: def_index }
515 fn expn_hash_to_expn_id(
522 self.get_crate_data(cnum).expn_hash_to_expn_id(sess, index_guess, hash)