]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_metadata/src/rmeta/decoder/cstore_impl.rs
51b3cc7e4fa54bc32e9d4dec4cde5d733c3ec266
[rust.git] / compiler / rustc_metadata / src / rmeta / decoder / cstore_impl.rs
1 use crate::creader::{CStore, LoadedMacro};
2 use crate::foreign_modules;
3 use crate::native_libs;
4
5 use rustc_ast as ast;
6 use rustc_data_structures::stable_map::FxHashMap;
7 use rustc_hir::def::{CtorKind, DefKind, Res};
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::metadata::ModChild;
11 use rustc_middle::middle::exported_symbols::ExportedSymbol;
12 use rustc_middle::middle::stability::DeprecationEntry;
13 use rustc_middle::ty::fast_reject::SimplifiedType;
14 use rustc_middle::ty::query::{ExternProviders, Providers};
15 use rustc_middle::ty::{self, TyCtxt, Visibility};
16 use rustc_session::cstore::{CrateSource, CrateStore, ForeignModule};
17 use rustc_session::utils::NativeLibKind;
18 use rustc_session::{Session, StableCrateId};
19 use rustc_span::hygiene::{ExpnHash, ExpnId};
20 use rustc_span::source_map::{Span, Spanned};
21 use rustc_span::symbol::{kw, Symbol};
22
23 use rustc_data_structures::sync::Lrc;
24 use smallvec::SmallVec;
25 use std::any::Any;
26
27 macro_rules! provide {
28     (<$lt:tt> $tcx:ident, $def_id:ident, $other:ident, $cdata:ident,
29       $($name:ident => $compute:block)*) => {
30         pub fn provide_extern(providers: &mut ExternProviders) {
31             $(fn $name<$lt>(
32                 $tcx: TyCtxt<$lt>,
33                 def_id_arg: ty::query::query_keys::$name<$lt>,
34             ) -> ty::query::query_values::$name<$lt> {
35                 let _prof_timer =
36                     $tcx.prof.generic_activity(concat!("metadata_decode_entry_", stringify!($name)));
37
38                 #[allow(unused_variables)]
39                 let ($def_id, $other) = def_id_arg.into_args();
40                 assert!(!$def_id.is_local());
41
42                 // External query providers call `crate_hash` in order to register a dependency
43                 // on the crate metadata. The exception is `crate_hash` itself, which obviously
44                 // doesn't need to do this (and can't, as it would cause a query cycle).
45                 use rustc_middle::dep_graph::DepKind;
46                 if DepKind::$name != DepKind::crate_hash && $tcx.dep_graph.is_fully_enabled() {
47                     $tcx.ensure().crate_hash($def_id.krate);
48                 }
49
50                 let $cdata = CStore::from_tcx($tcx).get_crate_data($def_id.krate);
51
52                 $compute
53             })*
54
55             *providers = ExternProviders {
56                 $($name,)*
57                 ..*providers
58             };
59         }
60     }
61 }
62
63 // small trait to work around different signature queries all being defined via
64 // the macro above.
65 trait IntoArgs {
66     fn into_args(self) -> (DefId, DefId);
67 }
68
69 impl IntoArgs for DefId {
70     fn into_args(self) -> (DefId, DefId) {
71         (self, self)
72     }
73 }
74
75 impl IntoArgs for CrateNum {
76     fn into_args(self) -> (DefId, DefId) {
77         (self.as_def_id(), self.as_def_id())
78     }
79 }
80
81 impl IntoArgs for (CrateNum, DefId) {
82     fn into_args(self) -> (DefId, DefId) {
83         (self.0.as_def_id(), self.1)
84     }
85 }
86
87 impl<'tcx> IntoArgs for ty::InstanceDef<'tcx> {
88     fn into_args(self) -> (DefId, DefId) {
89         (self.def_id(), self.def_id())
90     }
91 }
92
93 provide! { <'tcx> tcx, def_id, other, cdata,
94     type_of => { cdata.get_type(def_id.index, tcx) }
95     generics_of => { cdata.get_generics(def_id.index, tcx.sess) }
96     explicit_predicates_of => { cdata.get_explicit_predicates(def_id.index, tcx) }
97     inferred_outlives_of => { cdata.get_inferred_outlives(def_id.index, tcx) }
98     super_predicates_of => { cdata.get_super_predicates(def_id.index, tcx) }
99     explicit_item_bounds => { cdata.get_explicit_item_bounds(def_id.index, tcx) }
100     trait_def => { cdata.get_trait_def(def_id.index, tcx.sess) }
101     adt_def => { cdata.get_adt_def(def_id.index, tcx) }
102     adt_destructor => {
103         let _ = cdata;
104         tcx.calculate_dtor(def_id, |_,_| Ok(()))
105     }
106     variances_of => { tcx.arena.alloc_from_iter(cdata.get_item_variances(def_id.index)) }
107     associated_item_def_ids => { cdata.get_associated_item_def_ids(tcx, def_id.index) }
108     associated_item => { cdata.get_associated_item(def_id.index, tcx.sess) }
109     impl_trait_ref => { cdata.get_impl_trait(def_id.index, tcx) }
110     impl_polarity => { cdata.get_impl_polarity(def_id.index) }
111     coerce_unsized_info => {
112         cdata.get_coerce_unsized_info(def_id.index).unwrap_or_else(|| {
113             bug!("coerce_unsized_info: `{:?}` is missing its info", def_id);
114         })
115     }
116     optimized_mir => { tcx.arena.alloc(cdata.get_optimized_mir(tcx, def_id.index)) }
117     mir_for_ctfe => { tcx.arena.alloc(cdata.get_mir_for_ctfe(tcx, def_id.index)) }
118     promoted_mir => { tcx.arena.alloc(cdata.get_promoted_mir(tcx, def_id.index)) }
119     thir_abstract_const => { cdata.get_thir_abstract_const(tcx, def_id.index) }
120     unused_generic_params => { cdata.get_unused_generic_params(def_id.index) }
121     const_param_default => { tcx.mk_const(cdata.get_const_param_default(tcx, def_id.index)) }
122     mir_const_qualif => { cdata.mir_const_qualif(def_id.index) }
123     fn_sig => { cdata.fn_sig(def_id.index, tcx) }
124     inherent_impls => { cdata.get_inherent_implementations_for_type(tcx, def_id.index) }
125     is_const_fn_raw => { cdata.is_const_fn_raw(def_id.index) }
126     asyncness => { cdata.asyncness(def_id.index) }
127     is_foreign_item => { cdata.is_foreign_item(def_id.index) }
128     static_mutability => { cdata.static_mutability(def_id.index) }
129     generator_kind => { cdata.generator_kind(def_id.index) }
130     opt_def_kind => { Some(cdata.def_kind(def_id.index)) }
131     def_span => { cdata.get_span(def_id.index, &tcx.sess) }
132     def_ident_span => { cdata.opt_item_ident(def_id.index, &tcx.sess).map(|ident| ident.span) }
133     lookup_stability => {
134         cdata.get_stability(def_id.index).map(|s| tcx.intern_stability(s))
135     }
136     lookup_const_stability => {
137         cdata.get_const_stability(def_id.index).map(|s| tcx.intern_const_stability(s))
138     }
139     lookup_deprecation_entry => {
140         cdata.get_deprecation(def_id.index).map(DeprecationEntry::external)
141     }
142     item_attrs => { tcx.arena.alloc_from_iter(cdata.get_item_attrs(def_id.index, tcx.sess)) }
143     fn_arg_names => { cdata.get_fn_param_names(tcx, def_id.index) }
144     rendered_const => { cdata.get_rendered_const(def_id.index) }
145     impl_parent => { cdata.get_parent_impl(def_id.index) }
146     trait_of_item => { cdata.get_trait_of_item(def_id.index) }
147     is_mir_available => { cdata.is_item_mir_available(def_id.index) }
148     is_ctfe_mir_available => { cdata.is_ctfe_mir_available(def_id.index) }
149
150     dylib_dependency_formats => { cdata.get_dylib_dependency_formats(tcx) }
151     is_private_dep => { cdata.private_dep }
152     is_panic_runtime => { cdata.root.panic_runtime }
153     is_compiler_builtins => { cdata.root.compiler_builtins }
154     has_global_allocator => { cdata.root.has_global_allocator }
155     has_panic_handler => { cdata.root.has_panic_handler }
156     is_profiler_runtime => { cdata.root.profiler_runtime }
157     panic_strategy => { cdata.root.panic_strategy }
158     panic_in_drop_strategy => { cdata.root.panic_in_drop_strategy }
159     extern_crate => {
160         let r = *cdata.extern_crate.lock();
161         r.map(|c| &*tcx.arena.alloc(c))
162     }
163     is_no_builtins => { cdata.root.no_builtins }
164     symbol_mangling_version => { cdata.root.symbol_mangling_version }
165     impl_defaultness => { cdata.get_impl_defaultness(def_id.index) }
166     impl_constness => { cdata.get_impl_constness(def_id.index) }
167     reachable_non_generics => {
168         let reachable_non_generics = tcx
169             .exported_symbols(cdata.cnum)
170             .iter()
171             .filter_map(|&(exported_symbol, export_level)| {
172                 if let ExportedSymbol::NonGeneric(def_id) = exported_symbol {
173                     Some((def_id, export_level))
174                 } else {
175                     None
176                 }
177             })
178             .collect();
179
180         reachable_non_generics
181     }
182     native_libraries => { Lrc::new(cdata.get_native_libraries(tcx.sess)) }
183     foreign_modules => { cdata.get_foreign_modules(tcx) }
184     crate_hash => { cdata.root.hash }
185     crate_host_hash => { cdata.host_hash }
186     crate_name => { cdata.root.name }
187
188     extra_filename => { cdata.root.extra_filename.clone() }
189
190     traits_in_crate => { tcx.arena.alloc_from_iter(cdata.get_traits()) }
191     implementations_of_trait => { cdata.get_implementations_of_trait(tcx, other) }
192
193     visibility => { cdata.get_visibility(def_id.index) }
194     dep_kind => {
195         let r = *cdata.dep_kind.lock();
196         r
197     }
198     module_children => {
199         let mut result = SmallVec::<[_; 8]>::new();
200         cdata.for_each_module_child(def_id.index, |child| result.push(child), tcx.sess);
201         tcx.arena.alloc_slice(&result)
202     }
203     defined_lib_features => { cdata.get_lib_features(tcx) }
204     defined_lang_items => { cdata.get_lang_items(tcx) }
205     diagnostic_items => { cdata.get_diagnostic_items() }
206     missing_lang_items => { cdata.get_missing_lang_items(tcx) }
207
208     missing_extern_crate_item => {
209         let r = matches!(*cdata.extern_crate.borrow(), Some(extern_crate) if !extern_crate.is_direct());
210         r
211     }
212
213     used_crate_source => { Lrc::new(cdata.source.clone()) }
214
215     exported_symbols => {
216         let syms = cdata.exported_symbols(tcx);
217
218         // FIXME rust-lang/rust#64319, rust-lang/rust#64872: We want
219         // to block export of generics from dylibs, but we must fix
220         // rust-lang/rust#65890 before we can do that robustly.
221
222         syms
223     }
224
225     crate_extern_paths => { cdata.source().paths().cloned().collect() }
226     expn_that_defined => { cdata.get_expn_that_defined(def_id.index, tcx.sess) }
227 }
228
229 pub(in crate::rmeta) fn provide(providers: &mut Providers) {
230     // FIXME(#44234) - almost all of these queries have no sub-queries and
231     // therefore no actual inputs, they're just reading tables calculated in
232     // resolve! Does this work? Unsure! That's what the issue is about
233     *providers = Providers {
234         allocator_kind: |tcx, ()| CStore::from_tcx(tcx).allocator_kind(),
235         is_dllimport_foreign_item: |tcx, id| match tcx.native_library_kind(id) {
236             Some(
237                 NativeLibKind::Dylib { .. } | NativeLibKind::RawDylib | NativeLibKind::Unspecified,
238             ) => true,
239             _ => false,
240         },
241         is_statically_included_foreign_item: |tcx, id| {
242             matches!(tcx.native_library_kind(id), Some(NativeLibKind::Static { .. }))
243         },
244         is_private_dep: |_tcx, cnum| {
245             assert_eq!(cnum, LOCAL_CRATE);
246             false
247         },
248         native_library_kind: |tcx, id| {
249             tcx.native_libraries(id.krate)
250                 .iter()
251                 .filter(|lib| native_libs::relevant_lib(&tcx.sess, lib))
252                 .find(|lib| {
253                     let fm_id = match lib.foreign_module {
254                         Some(id) => id,
255                         None => return false,
256                     };
257                     let map = tcx.foreign_modules(id.krate);
258                     map.get(&fm_id)
259                         .expect("failed to find foreign module")
260                         .foreign_items
261                         .contains(&id)
262                 })
263                 .map(|l| l.kind)
264         },
265         native_libraries: |tcx, cnum| {
266             assert_eq!(cnum, LOCAL_CRATE);
267             Lrc::new(native_libs::collect(tcx))
268         },
269         foreign_modules: |tcx, cnum| {
270             assert_eq!(cnum, LOCAL_CRATE);
271             let modules: FxHashMap<DefId, ForeignModule> =
272                 foreign_modules::collect(tcx).into_iter().map(|m| (m.def_id, m)).collect();
273             Lrc::new(modules)
274         },
275
276         // Returns a map from a sufficiently visible external item (i.e., an
277         // external item that is visible from at least one local module) to a
278         // sufficiently visible parent (considering modules that re-export the
279         // external item to be parents).
280         visible_parent_map: |tcx, ()| {
281             use std::collections::hash_map::Entry;
282             use std::collections::vec_deque::VecDeque;
283
284             let mut visible_parent_map: DefIdMap<DefId> = Default::default();
285             // This is a secondary visible_parent_map, storing the DefId of parents that re-export
286             // the child as `_`. Since we prefer parents that don't do this, merge this map at the
287             // end, only if we're missing any keys from the former.
288             let mut fallback_map: DefIdMap<DefId> = Default::default();
289
290             // Issue 46112: We want the map to prefer the shortest
291             // paths when reporting the path to an item. Therefore we
292             // build up the map via a breadth-first search (BFS),
293             // which naturally yields minimal-length paths.
294             //
295             // Note that it needs to be a BFS over the whole forest of
296             // crates, not just each individual crate; otherwise you
297             // only get paths that are locally minimal with respect to
298             // whatever crate we happened to encounter first in this
299             // traversal, but not globally minimal across all crates.
300             let bfs_queue = &mut VecDeque::new();
301
302             for &cnum in tcx.crates(()) {
303                 // Ignore crates without a corresponding local `extern crate` item.
304                 if tcx.missing_extern_crate_item(cnum) {
305                     continue;
306                 }
307
308                 bfs_queue.push_back(DefId { krate: cnum, index: CRATE_DEF_INDEX });
309             }
310
311             let mut add_child = |bfs_queue: &mut VecDeque<_>, child: &ModChild, parent: DefId| {
312                 if !child.vis.is_public() {
313                     return;
314                 }
315
316                 if let Some(def_id) = child.res.opt_def_id() {
317                     if child.ident.name == kw::Underscore {
318                         fallback_map.insert(def_id, parent);
319                         return;
320                     }
321
322                     match visible_parent_map.entry(def_id) {
323                         Entry::Occupied(mut entry) => {
324                             // If `child` is defined in crate `cnum`, ensure
325                             // that it is mapped to a parent in `cnum`.
326                             if def_id.is_local() && entry.get().is_local() {
327                                 entry.insert(parent);
328                             }
329                         }
330                         Entry::Vacant(entry) => {
331                             entry.insert(parent);
332                             if matches!(
333                                 child.res,
334                                 Res::Def(DefKind::Mod | DefKind::Enum | DefKind::Trait, _)
335                             ) {
336                                 bfs_queue.push_back(def_id);
337                             }
338                         }
339                     }
340                 }
341             };
342
343             while let Some(def) = bfs_queue.pop_front() {
344                 for child in tcx.module_children(def).iter() {
345                     add_child(bfs_queue, child, def);
346                 }
347             }
348
349             // Fill in any missing entries with the (less preferable) path ending in `::_`.
350             // We still use this path in a diagnostic that suggests importing `::*`.
351             for (child, parent) in fallback_map {
352                 visible_parent_map.entry(child).or_insert(parent);
353             }
354
355             visible_parent_map
356         },
357
358         dependency_formats: |tcx, ()| Lrc::new(crate::dependency_format::calculate(tcx)),
359         has_global_allocator: |tcx, cnum| {
360             assert_eq!(cnum, LOCAL_CRATE);
361             CStore::from_tcx(tcx).has_global_allocator()
362         },
363         postorder_cnums: |tcx, ()| {
364             tcx.arena
365                 .alloc_slice(&CStore::from_tcx(tcx).crate_dependencies_in_postorder(LOCAL_CRATE))
366         },
367         crates: |tcx, ()| tcx.arena.alloc_from_iter(CStore::from_tcx(tcx).crates_untracked()),
368
369         ..*providers
370     };
371 }
372
373 impl CStore {
374     pub fn struct_field_names_untracked(&self, def: DefId, sess: &Session) -> Vec<Spanned<Symbol>> {
375         self.get_crate_data(def.krate).get_struct_field_names(def.index, sess)
376     }
377
378     pub fn struct_field_visibilities_untracked(&self, def: DefId) -> Vec<Visibility> {
379         self.get_crate_data(def.krate).get_struct_field_visibilities(def.index)
380     }
381
382     pub fn ctor_def_id_and_kind_untracked(&self, def: DefId) -> Option<(DefId, CtorKind)> {
383         self.get_crate_data(def.krate).get_ctor_def_id_and_kind(def.index)
384     }
385
386     pub fn visibility_untracked(&self, def: DefId) -> Visibility {
387         self.get_crate_data(def.krate).get_visibility(def.index)
388     }
389
390     pub fn module_children_untracked(&self, def_id: DefId, sess: &Session) -> Vec<ModChild> {
391         let mut result = vec![];
392         self.get_crate_data(def_id.krate).for_each_module_child(
393             def_id.index,
394             |child| result.push(child),
395             sess,
396         );
397         result
398     }
399
400     pub fn load_macro_untracked(&self, id: DefId, sess: &Session) -> LoadedMacro {
401         let _prof_timer = sess.prof.generic_activity("metadata_load_macro");
402
403         let data = self.get_crate_data(id.krate);
404         if data.root.is_proc_macro_crate() {
405             return LoadedMacro::ProcMacro(data.load_proc_macro(id.index, sess));
406         }
407
408         let span = data.get_span(id.index, sess);
409
410         LoadedMacro::MacroDef(
411             ast::Item {
412                 ident: data.item_ident(id.index, sess),
413                 id: ast::DUMMY_NODE_ID,
414                 span,
415                 attrs: data.get_item_attrs(id.index, sess).collect(),
416                 kind: ast::ItemKind::MacroDef(data.get_macro(id.index, sess)),
417                 vis: ast::Visibility {
418                     span: span.shrink_to_lo(),
419                     kind: ast::VisibilityKind::Inherited,
420                     tokens: None,
421                 },
422                 tokens: None,
423             },
424             data.root.edition,
425         )
426     }
427
428     pub fn fn_has_self_parameter_untracked(&self, def: DefId) -> bool {
429         self.get_crate_data(def.krate).get_fn_has_self_parameter(def.index)
430     }
431
432     pub fn crate_source_untracked(&self, cnum: CrateNum) -> CrateSource {
433         self.get_crate_data(cnum).source.clone()
434     }
435
436     pub fn get_span_untracked(&self, def_id: DefId, sess: &Session) -> Span {
437         self.get_crate_data(def_id.krate).get_span(def_id.index, sess)
438     }
439
440     pub fn def_kind(&self, def: DefId) -> DefKind {
441         self.get_crate_data(def.krate).def_kind(def.index)
442     }
443
444     pub fn crates_untracked(&self) -> impl Iterator<Item = CrateNum> + '_ {
445         self.iter_crate_data().map(|(cnum, _)| cnum)
446     }
447
448     pub fn item_generics_num_lifetimes(&self, def_id: DefId, sess: &Session) -> usize {
449         self.get_crate_data(def_id.krate).get_generics(def_id.index, sess).own_counts().lifetimes
450     }
451
452     pub fn module_expansion_untracked(&self, def_id: DefId, sess: &Session) -> ExpnId {
453         self.get_crate_data(def_id.krate).module_expansion(def_id.index, sess)
454     }
455
456     /// Only public-facing way to traverse all the definitions in a non-local crate.
457     /// Critically useful for this third-party project: <https://github.com/hacspec/hacspec>.
458     /// See <https://github.com/rust-lang/rust/pull/85889> for context.
459     pub fn num_def_ids_untracked(&self, cnum: CrateNum) -> usize {
460         self.get_crate_data(cnum).num_def_ids()
461     }
462
463     pub fn item_attrs_untracked(&self, def_id: DefId, sess: &Session) -> Vec<ast::Attribute> {
464         self.get_crate_data(def_id.krate).get_item_attrs(def_id.index, sess).collect()
465     }
466
467     pub fn get_proc_macro_quoted_span_untracked(
468         &self,
469         cnum: CrateNum,
470         id: usize,
471         sess: &Session,
472     ) -> Span {
473         self.get_crate_data(cnum).get_proc_macro_quoted_span(id, sess)
474     }
475
476     pub fn traits_in_crate_untracked(&self, cnum: CrateNum) -> Vec<DefId> {
477         self.get_crate_data(cnum).get_traits().collect()
478     }
479
480     pub fn trait_impls_in_crate_untracked(
481         &self,
482         cnum: CrateNum,
483     ) -> Vec<(DefId, Option<SimplifiedType>)> {
484         self.get_crate_data(cnum).get_trait_impls().collect()
485     }
486 }
487
488 impl CrateStore for CStore {
489     fn as_any(&self) -> &dyn Any {
490         self
491     }
492
493     fn crate_name(&self, cnum: CrateNum) -> Symbol {
494         self.get_crate_data(cnum).root.name
495     }
496
497     fn stable_crate_id(&self, cnum: CrateNum) -> StableCrateId {
498         self.get_crate_data(cnum).root.stable_crate_id
499     }
500
501     fn stable_crate_id_to_crate_num(&self, stable_crate_id: StableCrateId) -> CrateNum {
502         self.stable_crate_ids[&stable_crate_id]
503     }
504
505     /// Returns the `DefKey` for a given `DefId`. This indicates the
506     /// parent `DefId` as well as some idea of what kind of data the
507     /// `DefId` refers to.
508     fn def_key(&self, def: DefId) -> DefKey {
509         self.get_crate_data(def.krate).def_key(def.index)
510     }
511
512     fn def_path(&self, def: DefId) -> DefPath {
513         self.get_crate_data(def.krate).def_path(def.index)
514     }
515
516     fn def_path_hash(&self, def: DefId) -> DefPathHash {
517         self.get_crate_data(def.krate).def_path_hash(def.index)
518     }
519
520     fn def_path_hash_to_def_id(&self, cnum: CrateNum, hash: DefPathHash) -> DefId {
521         let def_index = self.get_crate_data(cnum).def_path_hash_to_def_index(hash);
522         DefId { krate: cnum, index: def_index }
523     }
524
525     fn expn_hash_to_expn_id(
526         &self,
527         sess: &Session,
528         cnum: CrateNum,
529         index_guess: u32,
530         hash: ExpnHash,
531     ) -> ExpnId {
532         self.get_crate_data(cnum).expn_hash_to_expn_id(sess, index_guess, hash)
533     }
534
535     fn import_source_files(&self, sess: &Session, cnum: CrateNum) {
536         self.get_crate_data(cnum).imported_source_files(sess);
537     }
538 }