1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
16 use rustc::middle::cstore::{InlinedItem, CrateStore, CrateSource, LibSource, DepKind, ExternCrate};
17 use rustc::middle::cstore::{NativeLibrary, LinkMeta, LinkagePreference, LoadedMacro};
18 use rustc::hir::def::{self, Def};
19 use rustc::middle::lang_items;
20 use rustc::session::Session;
21 use rustc::ty::{self, Ty, TyCtxt};
22 use rustc::hir::def_id::{CrateNum, DefId, DefIndex, CRATE_DEF_INDEX};
24 use rustc::dep_graph::DepNode;
25 use rustc::hir::map as hir_map;
26 use rustc::hir::map::DefKey;
28 use rustc::util::nodemap::{NodeSet, DefIdMap};
29 use rustc_back::PanicStrategy;
33 use syntax::parse::new_parser_from_source_str;
34 use syntax::symbol::Symbol;
35 use syntax_pos::{mk_sp, Span};
36 use rustc::hir::svh::Svh;
37 use rustc_back::target::Target;
40 impl<'tcx> CrateStore<'tcx> for cstore::CStore {
41 fn describe_def(&self, def: DefId) -> Option<Def> {
42 self.dep_graph.read(DepNode::MetaData(def));
43 self.get_crate_data(def.krate).get_def(def.index)
46 fn def_span(&self, sess: &Session, def: DefId) -> Span {
47 self.dep_graph.read(DepNode::MetaData(def));
48 self.get_crate_data(def.krate).get_span(def.index, sess)
51 fn stability(&self, def: DefId) -> Option<attr::Stability> {
52 self.dep_graph.read(DepNode::MetaData(def));
53 self.get_crate_data(def.krate).get_stability(def.index)
56 fn deprecation(&self, def: DefId) -> Option<attr::Deprecation> {
57 self.dep_graph.read(DepNode::MetaData(def));
58 self.get_crate_data(def.krate).get_deprecation(def.index)
61 fn visibility(&self, def: DefId) -> ty::Visibility {
62 self.dep_graph.read(DepNode::MetaData(def));
63 self.get_crate_data(def.krate).get_visibility(def.index)
66 fn closure_kind(&self, def_id: DefId) -> ty::ClosureKind
68 assert!(!def_id.is_local());
69 self.dep_graph.read(DepNode::MetaData(def_id));
70 self.get_crate_data(def_id.krate).closure_kind(def_id.index)
73 fn closure_ty<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> ty::ClosureTy<'tcx> {
74 assert!(!def_id.is_local());
75 self.dep_graph.read(DepNode::MetaData(def_id));
76 self.get_crate_data(def_id.krate).closure_ty(def_id.index, tcx)
79 fn item_variances(&self, def: DefId) -> Vec<ty::Variance> {
80 self.dep_graph.read(DepNode::MetaData(def));
81 self.get_crate_data(def.krate).get_item_variances(def.index)
84 fn item_type<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
87 self.dep_graph.read(DepNode::MetaData(def));
88 self.get_crate_data(def.krate).get_type(def.index, tcx)
91 fn item_predicates<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
92 -> ty::GenericPredicates<'tcx>
94 self.dep_graph.read(DepNode::MetaData(def));
95 self.get_crate_data(def.krate).get_predicates(def.index, tcx)
98 fn item_super_predicates<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
99 -> ty::GenericPredicates<'tcx>
101 self.dep_graph.read(DepNode::MetaData(def));
102 self.get_crate_data(def.krate).get_super_predicates(def.index, tcx)
105 fn item_generics<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
106 -> ty::Generics<'tcx>
108 self.dep_graph.read(DepNode::MetaData(def));
109 self.get_crate_data(def.krate).get_generics(def.index, tcx)
112 fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute>
114 self.dep_graph.read(DepNode::MetaData(def_id));
115 self.get_crate_data(def_id.krate).get_item_attrs(def_id.index)
118 fn trait_def<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> ty::TraitDef
120 self.dep_graph.read(DepNode::MetaData(def));
121 self.get_crate_data(def.krate).get_trait_def(def.index, tcx)
124 fn adt_def<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> &'tcx ty::AdtDef
126 self.dep_graph.read(DepNode::MetaData(def));
127 self.get_crate_data(def.krate).get_adt_def(def.index, tcx)
130 fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name>
132 self.dep_graph.read(DepNode::MetaData(did));
133 self.get_crate_data(did.krate).get_fn_arg_names(did.index)
136 fn inherent_implementations_for_type(&self, def_id: DefId) -> Vec<DefId>
138 self.dep_graph.read(DepNode::MetaData(def_id));
139 self.get_crate_data(def_id.krate).get_inherent_implementations_for_type(def_id.index)
142 fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>
144 if let Some(def_id) = filter {
145 self.dep_graph.read(DepNode::MetaData(def_id));
147 let mut result = vec![];
148 self.iter_crate_data(|_, cdata| {
149 cdata.get_implementations_for_trait(filter, &mut result)
154 fn associated_item_def_ids(&self, def_id: DefId) -> Vec<DefId> {
155 self.dep_graph.read(DepNode::MetaData(def_id));
156 let mut result = vec![];
157 self.get_crate_data(def_id.krate)
158 .each_child_of_item(def_id.index, |child| result.push(child.def.def_id()));
162 fn impl_polarity(&self, def: DefId) -> hir::ImplPolarity
164 self.dep_graph.read(DepNode::MetaData(def));
165 self.get_crate_data(def.krate).get_impl_polarity(def.index)
168 fn impl_trait_ref<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
169 -> Option<ty::TraitRef<'tcx>>
171 self.dep_graph.read(DepNode::MetaData(def));
172 self.get_crate_data(def.krate).get_impl_trait(def.index, tcx)
175 fn custom_coerce_unsized_kind(&self, def: DefId)
176 -> Option<ty::adjustment::CustomCoerceUnsized>
178 self.dep_graph.read(DepNode::MetaData(def));
179 self.get_crate_data(def.krate).get_custom_coerce_unsized_kind(def.index)
182 fn impl_parent(&self, impl_def: DefId) -> Option<DefId> {
183 self.dep_graph.read(DepNode::MetaData(impl_def));
184 self.get_crate_data(impl_def.krate).get_parent_impl(impl_def.index)
187 fn trait_of_item(&self, def_id: DefId) -> Option<DefId> {
188 self.dep_graph.read(DepNode::MetaData(def_id));
189 self.get_crate_data(def_id.krate).get_trait_of_item(def_id.index)
192 fn associated_item<'a>(&self, _tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
193 -> Option<ty::AssociatedItem>
195 self.dep_graph.read(DepNode::MetaData(def));
196 self.get_crate_data(def.krate).get_associated_item(def.index)
199 fn is_const_fn(&self, did: DefId) -> bool
201 self.dep_graph.read(DepNode::MetaData(did));
202 self.get_crate_data(did.krate).is_const_fn(did.index)
205 fn is_defaulted_trait(&self, trait_def_id: DefId) -> bool
207 self.dep_graph.read(DepNode::MetaData(trait_def_id));
208 self.get_crate_data(trait_def_id.krate).is_defaulted_trait(trait_def_id.index)
211 fn is_default_impl(&self, impl_did: DefId) -> bool {
212 self.dep_graph.read(DepNode::MetaData(impl_did));
213 self.get_crate_data(impl_did.krate).is_default_impl(impl_did.index)
216 fn is_foreign_item(&self, did: DefId) -> bool {
217 self.get_crate_data(did.krate).is_foreign_item(did.index)
220 fn is_statically_included_foreign_item(&self, id: ast::NodeId) -> bool
222 self.do_is_statically_included_foreign_item(id)
225 fn dylib_dependency_formats(&self, cnum: CrateNum)
226 -> Vec<(CrateNum, LinkagePreference)>
228 self.get_crate_data(cnum).get_dylib_dependency_formats()
231 fn dep_kind(&self, cnum: CrateNum) -> DepKind
233 self.get_crate_data(cnum).dep_kind.get()
236 fn export_macros(&self, cnum: CrateNum) {
237 if self.get_crate_data(cnum).dep_kind.get() == DepKind::UnexportedMacrosOnly {
238 self.get_crate_data(cnum).dep_kind.set(DepKind::MacrosOnly)
242 fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
244 self.get_crate_data(cnum).get_lang_items()
247 fn missing_lang_items(&self, cnum: CrateNum)
248 -> Vec<lang_items::LangItem>
250 self.get_crate_data(cnum).get_missing_lang_items()
253 fn is_staged_api(&self, cnum: CrateNum) -> bool
255 self.get_crate_data(cnum).is_staged_api()
258 fn is_allocator(&self, cnum: CrateNum) -> bool
260 self.get_crate_data(cnum).is_allocator()
263 fn is_panic_runtime(&self, cnum: CrateNum) -> bool
265 self.get_crate_data(cnum).is_panic_runtime()
268 fn is_compiler_builtins(&self, cnum: CrateNum) -> bool {
269 self.get_crate_data(cnum).is_compiler_builtins()
272 fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
273 self.get_crate_data(cnum).panic_strategy()
276 fn crate_name(&self, cnum: CrateNum) -> Symbol
278 self.get_crate_data(cnum).name
281 fn original_crate_name(&self, cnum: CrateNum) -> Symbol
283 self.get_crate_data(cnum).name()
286 fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate>
288 self.get_crate_data(cnum).extern_crate.get()
291 fn crate_hash(&self, cnum: CrateNum) -> Svh
293 self.get_crate_hash(cnum)
296 fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol
298 self.get_crate_data(cnum).disambiguator()
301 fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
303 self.get_crate_data(cnum).root.plugin_registrar_fn.map(|index| DefId {
309 fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
311 self.get_crate_data(cnum).root.macro_derive_registrar.map(|index| DefId {
317 fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
319 self.get_crate_data(cnum).get_native_libraries()
322 fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>
324 self.get_crate_data(cnum).get_exported_symbols()
327 fn is_no_builtins(&self, cnum: CrateNum) -> bool {
328 self.get_crate_data(cnum).is_no_builtins()
331 fn def_index_for_def_key(&self,
334 -> Option<DefIndex> {
335 let cdata = self.get_crate_data(cnum);
336 cdata.key_map.get(&def).cloned()
339 /// Returns the `DefKey` for a given `DefId`. This indicates the
340 /// parent `DefId` as well as some idea of what kind of data the
341 /// `DefId` refers to.
342 fn def_key(&self, def: DefId) -> hir_map::DefKey {
343 // Note: loading the def-key (or def-path) for a def-id is not
344 // a *read* of its metadata. This is because the def-id is
345 // really just an interned shorthand for a def-path, which is the
346 // canonical name for an item.
348 // self.dep_graph.read(DepNode::MetaData(def));
349 self.get_crate_data(def.krate).def_key(def.index)
352 fn relative_def_path(&self, def: DefId) -> Option<hir_map::DefPath> {
353 // See `Note` above in `def_key()` for why this read is
356 // self.dep_graph.read(DepNode::MetaData(def));
357 self.get_crate_data(def.krate).def_path(def.index)
360 fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>
362 self.dep_graph.read(DepNode::MetaData(def));
363 self.get_crate_data(def.krate).get_struct_field_names(def.index)
366 fn item_children(&self, def_id: DefId) -> Vec<def::Export>
368 self.dep_graph.read(DepNode::MetaData(def_id));
369 let mut result = vec![];
370 self.get_crate_data(def_id.krate)
371 .each_child_of_item(def_id.index, |child| result.push(child));
375 fn load_macro(&self, id: DefId, sess: &Session) -> LoadedMacro {
376 let data = self.get_crate_data(id.krate);
377 if let Some(ref proc_macros) = data.proc_macros {
378 return LoadedMacro::ProcMacro(proc_macros[id.index.as_usize() - 1].1.clone());
381 let (name, def) = data.get_macro(id.index);
382 let source_name = format!("<{} macros>", name);
384 // NB: Don't use parse_tts_from_source_str because it parses with quote_depth > 0.
385 let mut parser = new_parser_from_source_str(&sess.parse_sess, source_name, def.body);
387 let lo = parser.span.lo;
388 let body = match parser.parse_all_token_trees() {
392 sess.abort_if_errors();
396 let local_span = mk_sp(lo, parser.prev_span.hi);
398 // Mark the attrs as used
399 let attrs = data.get_item_attrs(id.index);
401 attr::mark_used(attr);
404 let name = data.def_key(id.index).disambiguated_data.data
405 .get_opt_name().expect("no name in load_macro");
406 sess.imported_macro_spans.borrow_mut()
407 .insert(local_span, (name.to_string(), data.get_span(id.index, sess)));
409 LoadedMacro::MacroRules(ast::MacroDef {
410 ident: ast::Ident::with_empty_ctxt(name),
411 id: ast::DUMMY_NODE_ID,
413 imported_from: None, // FIXME
414 allow_internal_unstable: attr::contains_name(&attrs, "allow_internal_unstable"),
420 fn maybe_get_item_ast<'a>(&'tcx self,
421 tcx: TyCtxt<'a, 'tcx, 'tcx>,
423 -> Option<(&'tcx InlinedItem, ast::NodeId)>
425 self.dep_graph.read(DepNode::MetaData(def_id));
427 match self.inlined_item_cache.borrow().get(&def_id) {
429 return None; // Not inlinable
431 Some(&Some(ref cached_inlined_item)) => {
433 debug!("maybe_get_item_ast({}): already inline as node id {}",
434 tcx.item_path_str(def_id), cached_inlined_item.item_id);
435 return Some((tcx.map.expect_inlined_item(cached_inlined_item.inlined_root),
436 cached_inlined_item.item_id));
443 debug!("maybe_get_item_ast({}): inlining item", tcx.item_path_str(def_id));
445 let inlined = self.get_crate_data(def_id.krate).maybe_get_item_ast(tcx, def_id.index);
447 let cache_inlined_item = |original_def_id, inlined_item_id, inlined_root_node_id| {
448 let cache_entry = cstore::CachedInlinedItem {
449 inlined_root: inlined_root_node_id,
450 item_id: inlined_item_id,
452 self.inlined_item_cache
454 .insert(original_def_id, Some(cache_entry));
455 self.defid_for_inlined_node
457 .insert(inlined_item_id, original_def_id);
460 let find_inlined_item_root = |inlined_item_id| {
461 let mut node = inlined_item_id;
463 // If we can't find the inline root after a thousand hops, we can
464 // be pretty sure there's something wrong with the HIR map.
466 let parent_node = tcx.map.get_parent_node(node);
467 if parent_node == node {
472 bug!("cycle in HIR map parent chain")
477 self.inlined_item_cache
479 .insert(def_id, None);
481 Some(&InlinedItem { ref body, .. }) => {
482 let inlined_root_node_id = find_inlined_item_root(body.id);
483 cache_inlined_item(def_id, inlined_root_node_id, inlined_root_node_id);
487 // We can be sure to hit the cache now
488 return self.maybe_get_item_ast(tcx, def_id);
491 fn local_node_for_inlined_defid(&'tcx self, def_id: DefId) -> Option<ast::NodeId> {
492 assert!(!def_id.is_local());
493 match self.inlined_item_cache.borrow().get(&def_id) {
494 Some(&Some(ref cached_inlined_item)) => {
495 Some(cached_inlined_item.item_id)
501 bug!("Trying to lookup inlined NodeId for unexpected item");
506 fn defid_for_inlined_node(&'tcx self, node_id: ast::NodeId) -> Option<DefId> {
507 self.defid_for_inlined_node.borrow().get(&node_id).map(|x| *x)
510 fn get_item_mir<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> Mir<'tcx> {
511 self.dep_graph.read(DepNode::MetaData(def));
512 self.get_crate_data(def.krate).maybe_get_item_mir(tcx, def.index).unwrap_or_else(|| {
513 bug!("get_item_mir: missing MIR for {}", tcx.item_path_str(def))
517 fn is_item_mir_available(&self, def: DefId) -> bool {
518 self.dep_graph.read(DepNode::MetaData(def));
519 self.get_crate_data(def.krate).is_item_mir_available(def.index)
522 fn crates(&self) -> Vec<CrateNum>
524 let mut result = vec![];
525 self.iter_crate_data(|cnum, _| result.push(cnum));
529 fn used_libraries(&self) -> Vec<NativeLibrary>
531 self.get_used_libraries().borrow().clone()
534 fn used_link_args(&self) -> Vec<String>
536 self.get_used_link_args().borrow().clone()
539 fn metadata_filename(&self) -> &str
541 locator::METADATA_FILENAME
544 fn metadata_section_name(&self, target: &Target) -> &str
546 locator::meta_section_name(target)
549 fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
551 self.do_get_used_crates(prefer)
554 fn used_crate_source(&self, cnum: CrateNum) -> CrateSource
556 self.get_crate_data(cnum).source.clone()
559 fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>
561 self.do_extern_mod_stmt_cnum(emod_id)
564 fn encode_metadata<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>,
565 reexports: &def::ExportMap,
566 link_meta: &LinkMeta,
567 reachable: &NodeSet) -> Vec<u8>
569 encoder::encode_metadata(tcx, self, reexports, link_meta, reachable)
572 fn metadata_encoding_version(&self) -> &[u8]
574 schema::METADATA_HEADER
577 /// Returns a map from a sufficiently visible external item (i.e. an external item that is
578 /// visible from at least one local module) to a sufficiently visible parent (considering
579 /// modules that re-export the external item to be parents).
580 fn visible_parent_map<'a>(&'a self) -> ::std::cell::RefMut<'a, DefIdMap<DefId>> {
581 let mut visible_parent_map = self.visible_parent_map.borrow_mut();
582 if !visible_parent_map.is_empty() { return visible_parent_map; }
584 use std::collections::vec_deque::VecDeque;
585 use std::collections::hash_map::Entry;
586 for cnum in (1 .. self.next_crate_num().as_usize()).map(CrateNum::new) {
587 let cdata = self.get_crate_data(cnum);
589 match cdata.extern_crate.get() {
590 // Ignore crates without a corresponding local `extern crate` item.
591 Some(extern_crate) if !extern_crate.direct => continue,
595 let mut bfs_queue = &mut VecDeque::new();
596 let mut add_child = |bfs_queue: &mut VecDeque<_>, child: def::Export, parent: DefId| {
597 let child = child.def.def_id();
599 if self.visibility(child) != ty::Visibility::Public {
603 match visible_parent_map.entry(child) {
604 Entry::Occupied(mut entry) => {
605 // If `child` is defined in crate `cnum`, ensure
606 // that it is mapped to a parent in `cnum`.
607 if child.krate == cnum && entry.get().krate != cnum {
608 entry.insert(parent);
611 Entry::Vacant(entry) => {
612 entry.insert(parent);
613 bfs_queue.push_back(child);
618 bfs_queue.push_back(DefId {
620 index: CRATE_DEF_INDEX
622 while let Some(def) = bfs_queue.pop_front() {
623 for child in self.item_children(def) {
624 add_child(bfs_queue, child, def);