1 use crate::cstore::{self, LoadedMacro};
4 use crate::native_libs;
5 use crate::foreign_modules;
8 use rustc::ty::query::QueryConfig;
9 use rustc::middle::cstore::{CrateStore, DepKind,
10 EncodedMetadata, NativeLibraryKind};
11 use rustc::middle::exported_symbols::ExportedSymbol;
12 use rustc::middle::stability::DeprecationEntry;
15 use rustc::session::{CrateDisambiguator, Session};
16 use rustc::ty::{self, TyCtxt};
17 use rustc::ty::query::Providers;
18 use rustc::hir::def_id::{CrateNum, DefId, LOCAL_CRATE, CRATE_DEF_INDEX};
19 use rustc::hir::map::{DefKey, DefPath, DefPathHash};
20 use rustc::hir::map::definitions::DefPathTable;
21 use rustc::util::nodemap::DefIdMap;
22 use rustc_data_structures::svh::Svh;
25 use rustc_data_structures::sync::Lrc;
30 use syntax::source_map;
31 use syntax::edition::Edition;
32 use syntax::parse::source_file_to_stream;
33 use syntax::parse::parser::emit_unclosed_delims;
34 use syntax::symbol::{Symbol, sym};
35 use syntax_pos::{Span, NO_EXPANSION, FileName};
36 use rustc_data_structures::bit_set::BitSet;
38 macro_rules! provide {
39 (<$lt:tt> $tcx:ident, $def_id:ident, $other:ident, $cdata:ident,
40 $($name:ident => $compute:block)*) => {
41 pub fn provide_extern<$lt>(providers: &mut Providers<$lt>) {
42 $(fn $name<'a, $lt:$lt, T>($tcx: TyCtxt<'a, $lt, $lt>, def_id_arg: T)
43 -> <ty::queries::$name<$lt> as
44 QueryConfig<$lt>>::Value
47 #[allow(unused_variables)]
48 let ($def_id, $other) = def_id_arg.into_args();
49 assert!(!$def_id.is_local());
51 let def_path_hash = $tcx.def_path_hash(DefId {
53 index: CRATE_DEF_INDEX
55 let dep_node = def_path_hash
56 .to_dep_node(rustc::dep_graph::DepKind::CrateMetadata);
57 // The DepNodeIndex of the DepNode::CrateMetadata should be
58 // cached somewhere, so that we can use read_index().
59 $tcx.dep_graph.read(dep_node);
61 let $cdata = $tcx.crate_data_as_rc_any($def_id.krate);
62 let $cdata = $cdata.downcast_ref::<cstore::CrateMetadata>()
63 .expect("CrateStore created data is not a CrateMetadata");
67 *providers = Providers {
75 // small trait to work around different signature queries all being defined via
78 fn into_args(self) -> (DefId, DefId);
81 impl IntoArgs for DefId {
82 fn into_args(self) -> (DefId, DefId) { (self, self) }
85 impl IntoArgs for CrateNum {
86 fn into_args(self) -> (DefId, DefId) { (self.as_def_id(), self.as_def_id()) }
89 impl IntoArgs for (CrateNum, DefId) {
90 fn into_args(self) -> (DefId, DefId) { (self.0.as_def_id(), self.1) }
93 provide! { <'tcx> tcx, def_id, other, cdata,
94 type_of => { cdata.get_type(def_id.index, tcx) }
96 tcx.alloc_generics(cdata.get_generics(def_id.index, tcx.sess))
98 predicates_of => { Lrc::new(cdata.get_predicates(def_id.index, tcx)) }
99 predicates_defined_on => { Lrc::new(cdata.get_predicates_defined_on(def_id.index, tcx)) }
100 super_predicates_of => { Lrc::new(cdata.get_super_predicates(def_id.index, tcx)) }
102 tcx.alloc_trait_def(cdata.get_trait_def(def_id.index, tcx.sess))
104 adt_def => { cdata.get_adt_def(def_id.index, tcx) }
107 tcx.calculate_dtor(def_id, &mut |_,_| Ok(()))
109 variances_of => { tcx.arena.alloc_from_iter(cdata.get_item_variances(def_id.index)) }
110 associated_item_def_ids => {
111 let mut result = vec![];
112 cdata.each_child_of_item(def_id.index,
113 |child| result.push(child.res.def_id()), tcx.sess);
116 associated_item => { cdata.get_associated_item(def_id.index) }
117 impl_trait_ref => { cdata.get_impl_trait(def_id.index, tcx) }
118 impl_polarity => { cdata.get_impl_polarity(def_id.index) }
119 coerce_unsized_info => {
120 cdata.get_coerce_unsized_info(def_id.index).unwrap_or_else(|| {
121 bug!("coerce_unsized_info: `{:?}` is missing its info", def_id);
125 let mir = cdata.maybe_get_optimized_mir(tcx, def_id.index).unwrap_or_else(|| {
126 bug!("get_optimized_mir: missing MIR for `{:?}`", def_id)
129 let mir = tcx.alloc_mir(mir);
133 mir_const_qualif => {
134 (cdata.mir_const_qualif(def_id.index), tcx.arena.alloc(BitSet::new_empty(0)))
136 fn_sig => { cdata.fn_sig(def_id.index, tcx) }
137 inherent_impls => { Lrc::new(cdata.get_inherent_implementations_for_type(def_id.index)) }
138 is_const_fn_raw => { cdata.is_const_fn_raw(def_id.index) }
139 is_foreign_item => { cdata.is_foreign_item(def_id.index) }
140 static_mutability => { cdata.static_mutability(def_id.index) }
141 def_kind => { cdata.def_kind(def_id.index) }
142 def_span => { cdata.get_span(def_id.index, &tcx.sess) }
143 lookup_stability => {
144 cdata.get_stability(def_id.index).map(|s| tcx.intern_stability(s))
146 lookup_deprecation_entry => {
147 cdata.get_deprecation(def_id.index).map(DeprecationEntry::external)
149 item_attrs => { cdata.get_item_attrs(def_id.index, tcx.sess) }
150 // FIXME(#38501) We've skipped a `read` on the `HirBody` of
151 // a `fn` when encoding, so the dep-tracking wouldn't work.
152 // This is only used by rustdoc anyway, which shouldn't have
153 // incremental recompilation ever enabled.
154 fn_arg_names => { cdata.get_fn_arg_names(def_id.index) }
155 rendered_const => { cdata.get_rendered_const(def_id.index) }
156 impl_parent => { cdata.get_parent_impl(def_id.index) }
157 trait_of_item => { cdata.get_trait_of_item(def_id.index) }
158 const_is_rvalue_promotable_to_static => {
159 cdata.const_is_rvalue_promotable_to_static(def_id.index)
161 is_mir_available => { cdata.is_item_mir_available(def_id.index) }
163 dylib_dependency_formats => { Lrc::new(cdata.get_dylib_dependency_formats()) }
164 is_panic_runtime => { cdata.root.panic_runtime }
165 is_compiler_builtins => { cdata.root.compiler_builtins }
166 has_global_allocator => { cdata.root.has_global_allocator }
167 has_panic_handler => { cdata.root.has_panic_handler }
168 is_sanitizer_runtime => { cdata.root.sanitizer_runtime }
169 is_profiler_runtime => { cdata.root.profiler_runtime }
170 panic_strategy => { cdata.root.panic_strategy }
172 let r = Lrc::new(*cdata.extern_crate.lock());
175 is_no_builtins => { cdata.root.no_builtins }
176 impl_defaultness => { cdata.get_impl_defaultness(def_id.index) }
177 reachable_non_generics => {
178 let reachable_non_generics = tcx
179 .exported_symbols(cdata.cnum)
181 .filter_map(|&(exported_symbol, export_level)| {
182 if let ExportedSymbol::NonGeneric(def_id) = exported_symbol {
183 return Some((def_id, export_level))
190 Lrc::new(reachable_non_generics)
192 native_libraries => { Lrc::new(cdata.get_native_libraries(tcx.sess)) }
193 foreign_modules => { Lrc::new(cdata.get_foreign_modules(tcx.sess)) }
194 plugin_registrar_fn => {
195 cdata.root.plugin_registrar_fn.map(|index| {
196 DefId { krate: def_id.krate, index }
199 proc_macro_decls_static => {
200 cdata.root.proc_macro_decls_static.map(|index| {
201 DefId { krate: def_id.krate, index }
204 crate_disambiguator => { cdata.root.disambiguator }
205 crate_hash => { cdata.root.hash }
206 original_crate_name => { cdata.root.name }
208 extra_filename => { cdata.root.extra_filename.clone() }
211 implementations_of_trait => {
212 let mut result = vec![];
213 let filter = Some(other);
214 cdata.get_implementations_for_trait(filter, &mut result);
218 all_trait_implementations => {
219 let mut result = vec![];
220 cdata.get_implementations_for_trait(None, &mut result);
224 visibility => { cdata.get_visibility(def_id.index) }
226 let r = *cdata.dep_kind.lock();
229 crate_name => { cdata.name }
231 let mut result = vec![];
232 cdata.each_child_of_item(def_id.index, |child| result.push(child), tcx.sess);
235 defined_lib_features => { Lrc::new(cdata.get_lib_features()) }
236 defined_lang_items => { Lrc::new(cdata.get_lang_items()) }
237 missing_lang_items => { Lrc::new(cdata.get_missing_lang_items()) }
239 missing_extern_crate_item => {
240 let r = match *cdata.extern_crate.borrow() {
241 Some(extern_crate) if !extern_crate.direct => true,
247 used_crate_source => { Lrc::new(cdata.source.clone()) }
249 exported_symbols => { Arc::new(cdata.exported_symbols(tcx)) }
252 pub fn provide<'tcx>(providers: &mut Providers<'tcx>) {
253 // FIXME(#44234) - almost all of these queries have no sub-queries and
254 // therefore no actual inputs, they're just reading tables calculated in
255 // resolve! Does this work? Unsure! That's what the issue is about
256 *providers = Providers {
257 is_dllimport_foreign_item: |tcx, id| {
258 tcx.native_library_kind(id) == Some(NativeLibraryKind::NativeUnknown)
260 is_statically_included_foreign_item: |tcx, id| {
261 match tcx.native_library_kind(id) {
262 Some(NativeLibraryKind::NativeStatic) |
263 Some(NativeLibraryKind::NativeStaticNobundle) => true,
267 native_library_kind: |tcx, id| {
268 tcx.native_libraries(id.krate)
270 .filter(|lib| native_libs::relevant_lib(&tcx.sess, lib))
272 let fm_id = match lib.foreign_module {
274 None => return false,
276 tcx.foreign_modules(id.krate)
278 .find(|m| m.def_id == fm_id)
279 .expect("failed to find foreign module")
285 native_libraries: |tcx, cnum| {
286 assert_eq!(cnum, LOCAL_CRATE);
287 Lrc::new(native_libs::collect(tcx))
289 foreign_modules: |tcx, cnum| {
290 assert_eq!(cnum, LOCAL_CRATE);
291 Lrc::new(foreign_modules::collect(tcx))
293 link_args: |tcx, cnum| {
294 assert_eq!(cnum, LOCAL_CRATE);
295 Lrc::new(link_args::collect(tcx))
298 // Returns a map from a sufficiently visible external item (i.e., an
299 // external item that is visible from at least one local module) to a
300 // sufficiently visible parent (considering modules that re-export the
301 // external item to be parents).
302 visible_parent_map: |tcx, cnum| {
303 use std::collections::vec_deque::VecDeque;
304 use std::collections::hash_map::Entry;
306 assert_eq!(cnum, LOCAL_CRATE);
307 let mut visible_parent_map: DefIdMap<DefId> = Default::default();
309 // Issue 46112: We want the map to prefer the shortest
310 // paths when reporting the path to an item. Therefore we
311 // build up the map via a breadth-first search (BFS),
312 // which naturally yields minimal-length paths.
314 // Note that it needs to be a BFS over the whole forest of
315 // crates, not just each individual crate; otherwise you
316 // only get paths that are locally minimal with respect to
317 // whatever crate we happened to encounter first in this
318 // traversal, but not globally minimal across all crates.
319 let bfs_queue = &mut VecDeque::new();
321 // Preferring shortest paths alone does not guarantee a
322 // deterministic result; so sort by crate num to avoid
323 // hashtable iteration non-determinism. This only makes
324 // things as deterministic as crate-nums assignment is,
325 // which is to say, its not deterministic in general. But
326 // we believe that libstd is consistently assigned crate
327 // num 1, so it should be enough to resolve #46112.
328 let mut crates: Vec<CrateNum> = (*tcx.crates()).clone();
331 for &cnum in crates.iter() {
332 // Ignore crates without a corresponding local `extern crate` item.
333 if tcx.missing_extern_crate_item(cnum) {
337 bfs_queue.push_back(DefId {
339 index: CRATE_DEF_INDEX
343 // (restrict scope of mutable-borrow of `visible_parent_map`)
345 let visible_parent_map = &mut visible_parent_map;
346 let mut add_child = |bfs_queue: &mut VecDeque<_>,
347 child: &def::Export<hir::HirId>,
349 if child.vis != ty::Visibility::Public {
353 if let Some(child) = child.res.opt_def_id() {
354 match visible_parent_map.entry(child) {
355 Entry::Occupied(mut entry) => {
356 // If `child` is defined in crate `cnum`, ensure
357 // that it is mapped to a parent in `cnum`.
358 if child.krate == cnum && entry.get().krate != cnum {
359 entry.insert(parent);
362 Entry::Vacant(entry) => {
363 entry.insert(parent);
364 bfs_queue.push_back(child);
370 while let Some(def) = bfs_queue.pop_front() {
371 for child in tcx.item_children(def).iter() {
372 add_child(bfs_queue, child, def);
377 Lrc::new(visible_parent_map)
384 impl cstore::CStore {
385 pub fn export_macros_untracked(&self, cnum: CrateNum) {
386 let data = self.get_crate_data(cnum);
387 let mut dep_kind = data.dep_kind.lock();
388 if *dep_kind == DepKind::UnexportedMacrosOnly {
389 *dep_kind = DepKind::MacrosOnly;
393 pub fn dep_kind_untracked(&self, cnum: CrateNum) -> DepKind {
394 let data = self.get_crate_data(cnum);
395 let r = *data.dep_kind.lock();
399 pub fn crate_edition_untracked(&self, cnum: CrateNum) -> Edition {
400 self.get_crate_data(cnum).root.edition
403 pub fn struct_field_names_untracked(&self, def: DefId) -> Vec<ast::Name> {
404 self.get_crate_data(def.krate).get_struct_field_names(def.index)
407 pub fn ctor_kind_untracked(&self, def: DefId) -> def::CtorKind {
408 self.get_crate_data(def.krate).get_ctor_kind(def.index)
411 pub fn item_attrs_untracked(&self, def: DefId, sess: &Session) -> Lrc<[ast::Attribute]> {
412 self.get_crate_data(def.krate).get_item_attrs(def.index, sess)
415 pub fn item_children_untracked(
419 ) -> Vec<def::Export<hir::HirId>> {
420 let mut result = vec![];
421 self.get_crate_data(def_id.krate)
422 .each_child_of_item(def_id.index, |child| result.push(child), sess);
426 pub fn load_macro_untracked(&self, id: DefId, sess: &Session) -> LoadedMacro {
427 let data = self.get_crate_data(id.krate);
428 if let Some(ref proc_macros) = data.proc_macros {
429 return LoadedMacro::ProcMacro(proc_macros[id.index.to_proc_macro_index()].1.clone());
430 } else if data.name == sym::proc_macro && data.item_name(id.index) == sym::quote {
431 use syntax::ext::base::SyntaxExtension;
432 use syntax_ext::proc_macro_impl::BangProcMacro;
434 let client = proc_macro::bridge::client::Client::expand1(proc_macro::quote);
435 let ext = SyntaxExtension::ProcMacro {
436 expander: Box::new(BangProcMacro { client }),
437 allow_internal_unstable: Some(vec![
438 Symbol::intern("proc_macro_def_site"),
440 edition: data.root.edition,
442 return LoadedMacro::ProcMacro(Lrc::new(ext));
445 let def = data.get_macro(id.index);
446 let macro_full_name = data.def_path(id.index).to_string_friendly(|_| data.imported_name);
447 let source_name = FileName::Macros(macro_full_name);
449 let source_file = sess.parse_sess.source_map().new_source_file(source_name, def.body);
450 let local_span = Span::new(source_file.start_pos, source_file.end_pos, NO_EXPANSION);
451 let (body, mut errors) = source_file_to_stream(&sess.parse_sess, source_file, None);
452 emit_unclosed_delims(&mut errors, &sess.diagnostic());
454 // Mark the attrs as used
455 let attrs = data.get_item_attrs(id.index, sess);
456 for attr in attrs.iter() {
457 attr::mark_used(attr);
460 let name = data.def_key(id.index).disambiguated_data.data
461 .get_opt_name().expect("no name in load_macro");
462 sess.imported_macro_spans.borrow_mut()
463 .insert(local_span, (name.to_string(), data.get_span(id.index, sess)));
465 LoadedMacro::MacroDef(ast::Item {
466 ident: ast::Ident::from_str(&name.as_str()),
467 id: ast::DUMMY_NODE_ID,
469 attrs: attrs.iter().cloned().collect(),
470 node: ast::ItemKind::MacroDef(ast::MacroDef {
474 vis: source_map::respan(local_span.shrink_to_lo(), ast::VisibilityKind::Inherited),
479 pub fn associated_item_cloned_untracked(&self, def: DefId) -> ty::AssociatedItem {
480 self.get_crate_data(def.krate).get_associated_item(def.index)
484 impl CrateStore for cstore::CStore {
485 fn crate_data_as_rc_any(&self, krate: CrateNum) -> Lrc<dyn Any> {
486 self.get_crate_data(krate)
489 fn item_generics_cloned_untracked(&self, def: DefId, sess: &Session) -> ty::Generics {
490 self.get_crate_data(def.krate).get_generics(def.index, sess)
493 fn crate_name_untracked(&self, cnum: CrateNum) -> Symbol
495 self.get_crate_data(cnum).name
498 fn crate_is_private_dep_untracked(&self, cnum: CrateNum) -> bool {
499 self.get_crate_data(cnum).private_dep
502 fn crate_disambiguator_untracked(&self, cnum: CrateNum) -> CrateDisambiguator
504 self.get_crate_data(cnum).root.disambiguator
507 fn crate_hash_untracked(&self, cnum: CrateNum) -> Svh
509 self.get_crate_data(cnum).root.hash
512 /// Returns the `DefKey` for a given `DefId`. This indicates the
513 /// parent `DefId` as well as some idea of what kind of data the
514 /// `DefId` refers to.
515 fn def_key(&self, def: DefId) -> DefKey {
516 // Note: loading the def-key (or def-path) for a def-id is not
517 // a *read* of its metadata. This is because the def-id is
518 // really just an interned shorthand for a def-path, which is the
519 // canonical name for an item.
521 // self.dep_graph.read(DepNode::MetaData(def));
522 self.get_crate_data(def.krate).def_key(def.index)
525 fn def_path(&self, def: DefId) -> DefPath {
526 // See `Note` above in `def_key()` for why this read is
529 // self.dep_graph.read(DepNode::MetaData(def));
530 self.get_crate_data(def.krate).def_path(def.index)
533 fn def_path_hash(&self, def: DefId) -> DefPathHash {
534 self.get_crate_data(def.krate).def_path_hash(def.index)
537 fn def_path_table(&self, cnum: CrateNum) -> Lrc<DefPathTable> {
538 self.get_crate_data(cnum).def_path_table.clone()
541 fn crates_untracked(&self) -> Vec<CrateNum>
543 let mut result = vec![];
544 self.iter_crate_data(|cnum, _| result.push(cnum));
548 fn extern_mod_stmt_cnum_untracked(&self, emod_id: ast::NodeId) -> Option<CrateNum>
550 self.do_extern_mod_stmt_cnum(emod_id)
553 fn postorder_cnums_untracked(&self) -> Vec<CrateNum> {
554 self.do_postorder_cnums_untracked()
557 fn encode_metadata<'a, 'tcx>(&self,
558 tcx: TyCtxt<'a, 'tcx, 'tcx>)
561 encoder::encode_metadata(tcx)
564 fn metadata_encoding_version(&self) -> &[u8]
566 schema::METADATA_HEADER