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::{token, new_parser_from_source_str};
34 use syntax_pos::mk_sp;
35 use rustc::hir::svh::Svh;
36 use rustc_back::target::Target;
39 impl<'tcx> CrateStore<'tcx> for cstore::CStore {
40 fn describe_def(&self, def: DefId) -> Option<Def> {
41 self.dep_graph.read(DepNode::MetaData(def));
42 self.get_crate_data(def.krate).get_def(def.index)
45 fn stability(&self, def: DefId) -> Option<attr::Stability> {
46 self.dep_graph.read(DepNode::MetaData(def));
47 self.get_crate_data(def.krate).get_stability(def.index)
50 fn deprecation(&self, def: DefId) -> Option<attr::Deprecation> {
51 self.dep_graph.read(DepNode::MetaData(def));
52 self.get_crate_data(def.krate).get_deprecation(def.index)
55 fn visibility(&self, def: DefId) -> ty::Visibility {
56 self.dep_graph.read(DepNode::MetaData(def));
57 self.get_crate_data(def.krate).get_visibility(def.index)
60 fn closure_kind(&self, def_id: DefId) -> ty::ClosureKind
62 assert!(!def_id.is_local());
63 self.dep_graph.read(DepNode::MetaData(def_id));
64 self.get_crate_data(def_id.krate).closure_kind(def_id.index)
67 fn closure_ty<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> ty::ClosureTy<'tcx> {
68 assert!(!def_id.is_local());
69 self.dep_graph.read(DepNode::MetaData(def_id));
70 self.get_crate_data(def_id.krate).closure_ty(def_id.index, tcx)
73 fn item_variances(&self, def: DefId) -> Vec<ty::Variance> {
74 self.dep_graph.read(DepNode::MetaData(def));
75 self.get_crate_data(def.krate).get_item_variances(def.index)
78 fn item_type<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
81 self.dep_graph.read(DepNode::MetaData(def));
82 self.get_crate_data(def.krate).get_type(def.index, tcx)
85 fn item_predicates<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
86 -> ty::GenericPredicates<'tcx>
88 self.dep_graph.read(DepNode::MetaData(def));
89 self.get_crate_data(def.krate).get_predicates(def.index, tcx)
92 fn item_super_predicates<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
93 -> ty::GenericPredicates<'tcx>
95 self.dep_graph.read(DepNode::MetaData(def));
96 self.get_crate_data(def.krate).get_super_predicates(def.index, tcx)
99 fn item_generics<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
100 -> ty::Generics<'tcx>
102 self.dep_graph.read(DepNode::MetaData(def));
103 self.get_crate_data(def.krate).get_generics(def.index, tcx)
106 fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute>
108 self.dep_graph.read(DepNode::MetaData(def_id));
109 self.get_crate_data(def_id.krate).get_item_attrs(def_id.index)
112 fn trait_def<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> ty::TraitDef<'tcx>
114 self.dep_graph.read(DepNode::MetaData(def));
115 self.get_crate_data(def.krate).get_trait_def(def.index, tcx)
118 fn adt_def<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> ty::AdtDefMaster<'tcx>
120 self.dep_graph.read(DepNode::MetaData(def));
121 self.get_crate_data(def.krate).get_adt_def(def.index, tcx)
124 fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name>
126 self.dep_graph.read(DepNode::MetaData(did));
127 self.get_crate_data(did.krate).get_fn_arg_names(did.index)
130 fn inherent_implementations_for_type(&self, def_id: DefId) -> Vec<DefId>
132 self.dep_graph.read(DepNode::MetaData(def_id));
133 self.get_crate_data(def_id.krate).get_inherent_implementations_for_type(def_id.index)
136 fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>
138 if let Some(def_id) = filter {
139 self.dep_graph.read(DepNode::MetaData(def_id));
141 let mut result = vec![];
142 self.iter_crate_data(|_, cdata| {
143 cdata.get_implementations_for_trait(filter, &mut result)
148 fn associated_item_def_ids(&self, def_id: DefId) -> Vec<DefId> {
149 self.dep_graph.read(DepNode::MetaData(def_id));
150 let mut result = vec![];
151 self.get_crate_data(def_id.krate)
152 .each_child_of_item(def_id.index, |child| result.push(child.def.def_id()));
156 fn impl_polarity(&self, def: DefId) -> hir::ImplPolarity
158 self.dep_graph.read(DepNode::MetaData(def));
159 self.get_crate_data(def.krate).get_impl_polarity(def.index)
162 fn impl_trait_ref<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
163 -> Option<ty::TraitRef<'tcx>>
165 self.dep_graph.read(DepNode::MetaData(def));
166 self.get_crate_data(def.krate).get_impl_trait(def.index, tcx)
169 fn custom_coerce_unsized_kind(&self, def: DefId)
170 -> Option<ty::adjustment::CustomCoerceUnsized>
172 self.dep_graph.read(DepNode::MetaData(def));
173 self.get_crate_data(def.krate).get_custom_coerce_unsized_kind(def.index)
176 fn impl_parent(&self, impl_def: DefId) -> Option<DefId> {
177 self.dep_graph.read(DepNode::MetaData(impl_def));
178 self.get_crate_data(impl_def.krate).get_parent_impl(impl_def.index)
181 fn trait_of_item(&self, def_id: DefId) -> Option<DefId> {
182 self.dep_graph.read(DepNode::MetaData(def_id));
183 self.get_crate_data(def_id.krate).get_trait_of_item(def_id.index)
186 fn associated_item<'a>(&self, _tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
187 -> Option<ty::AssociatedItem>
189 self.dep_graph.read(DepNode::MetaData(def));
190 self.get_crate_data(def.krate).get_associated_item(def.index)
193 fn is_const_fn(&self, did: DefId) -> bool
195 self.dep_graph.read(DepNode::MetaData(did));
196 self.get_crate_data(did.krate).is_const_fn(did.index)
199 fn is_defaulted_trait(&self, trait_def_id: DefId) -> bool
201 self.dep_graph.read(DepNode::MetaData(trait_def_id));
202 self.get_crate_data(trait_def_id.krate).is_defaulted_trait(trait_def_id.index)
205 fn is_default_impl(&self, impl_did: DefId) -> bool {
206 self.dep_graph.read(DepNode::MetaData(impl_did));
207 self.get_crate_data(impl_did.krate).is_default_impl(impl_did.index)
210 fn is_foreign_item(&self, did: DefId) -> bool {
211 self.get_crate_data(did.krate).is_foreign_item(did.index)
214 fn is_statically_included_foreign_item(&self, id: ast::NodeId) -> bool
216 self.do_is_statically_included_foreign_item(id)
219 fn dylib_dependency_formats(&self, cnum: CrateNum)
220 -> Vec<(CrateNum, LinkagePreference)>
222 self.get_crate_data(cnum).get_dylib_dependency_formats()
225 fn dep_kind(&self, cnum: CrateNum) -> DepKind
227 self.get_crate_data(cnum).dep_kind.get()
230 fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
232 self.get_crate_data(cnum).get_lang_items()
235 fn missing_lang_items(&self, cnum: CrateNum)
236 -> Vec<lang_items::LangItem>
238 self.get_crate_data(cnum).get_missing_lang_items()
241 fn is_staged_api(&self, cnum: CrateNum) -> bool
243 self.get_crate_data(cnum).is_staged_api()
246 fn is_allocator(&self, cnum: CrateNum) -> bool
248 self.get_crate_data(cnum).is_allocator()
251 fn is_panic_runtime(&self, cnum: CrateNum) -> bool
253 self.get_crate_data(cnum).is_panic_runtime()
256 fn is_compiler_builtins(&self, cnum: CrateNum) -> bool {
257 self.get_crate_data(cnum).is_compiler_builtins()
260 fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
261 self.get_crate_data(cnum).panic_strategy()
264 fn crate_name(&self, cnum: CrateNum) -> token::InternedString
266 token::intern_and_get_ident(&self.get_crate_data(cnum).name[..])
269 fn original_crate_name(&self, cnum: CrateNum) -> token::InternedString
271 token::intern_and_get_ident(&self.get_crate_data(cnum).name())
274 fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate>
276 self.get_crate_data(cnum).extern_crate.get()
279 fn crate_hash(&self, cnum: CrateNum) -> Svh
281 self.get_crate_hash(cnum)
284 fn crate_disambiguator(&self, cnum: CrateNum) -> token::InternedString
286 token::intern_and_get_ident(&self.get_crate_data(cnum).disambiguator())
289 fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
291 self.get_crate_data(cnum).root.plugin_registrar_fn.map(|index| DefId {
297 fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
299 self.get_crate_data(cnum).get_native_libraries()
302 fn reachable_ids(&self, cnum: CrateNum) -> Vec<DefId>
304 self.get_crate_data(cnum).get_reachable_ids()
307 fn is_no_builtins(&self, cnum: CrateNum) -> bool {
308 self.get_crate_data(cnum).is_no_builtins()
311 fn def_index_for_def_key(&self,
314 -> Option<DefIndex> {
315 let cdata = self.get_crate_data(cnum);
316 cdata.key_map.get(&def).cloned()
319 /// Returns the `DefKey` for a given `DefId`. This indicates the
320 /// parent `DefId` as well as some idea of what kind of data the
321 /// `DefId` refers to.
322 fn def_key(&self, def: DefId) -> hir_map::DefKey {
323 // Note: loading the def-key (or def-path) for a def-id is not
324 // a *read* of its metadata. This is because the def-id is
325 // really just an interned shorthand for a def-path, which is the
326 // canonical name for an item.
328 // self.dep_graph.read(DepNode::MetaData(def));
329 self.get_crate_data(def.krate).def_key(def.index)
332 fn relative_def_path(&self, def: DefId) -> Option<hir_map::DefPath> {
333 // See `Note` above in `def_key()` for why this read is
336 // self.dep_graph.read(DepNode::MetaData(def));
337 self.get_crate_data(def.krate).def_path(def.index)
340 fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>
342 self.dep_graph.read(DepNode::MetaData(def));
343 self.get_crate_data(def.krate).get_struct_field_names(def.index)
346 fn item_children(&self, def_id: DefId) -> Vec<def::Export>
348 self.dep_graph.read(DepNode::MetaData(def_id));
349 let mut result = vec![];
350 self.get_crate_data(def_id.krate)
351 .each_child_of_item(def_id.index, |child| result.push(child));
355 fn load_macro(&self, id: DefId, sess: &Session) -> LoadedMacro {
356 let data = self.get_crate_data(id.krate);
357 if let Some(ref proc_macros) = data.proc_macros {
358 return LoadedMacro::ProcMacro(proc_macros[id.index.as_usize() - 1].1.clone());
361 let (name, def) = data.get_macro(id.index);
362 let source_name = format!("<{} macros>", name);
364 // NB: Don't use parse_tts_from_source_str because it parses with quote_depth > 0.
365 let mut parser = new_parser_from_source_str(&sess.parse_sess, source_name, def.body);
367 let lo = parser.span.lo;
368 let body = match parser.parse_all_token_trees() {
372 sess.abort_if_errors();
376 let local_span = mk_sp(lo, parser.prev_span.hi);
378 // Mark the attrs as used
379 for attr in &def.attrs {
380 attr::mark_used(attr);
383 sess.imported_macro_spans.borrow_mut()
384 .insert(local_span, (def.name.as_str().to_string(), def.span));
386 LoadedMacro::MacroRules(ast::MacroDef {
387 ident: ast::Ident::with_empty_ctxt(def.name),
388 id: ast::DUMMY_NODE_ID,
390 imported_from: None, // FIXME
391 allow_internal_unstable: attr::contains_name(&def.attrs, "allow_internal_unstable"),
397 fn maybe_get_item_ast<'a>(&'tcx self,
398 tcx: TyCtxt<'a, 'tcx, 'tcx>,
400 -> Option<(&'tcx InlinedItem, ast::NodeId)>
402 self.dep_graph.read(DepNode::MetaData(def_id));
404 match self.inlined_item_cache.borrow().get(&def_id) {
406 return None; // Not inlinable
408 Some(&Some(ref cached_inlined_item)) => {
410 debug!("maybe_get_item_ast({}): already inline as node id {}",
411 tcx.item_path_str(def_id), cached_inlined_item.item_id);
412 return Some((tcx.map.expect_inlined_item(cached_inlined_item.inlined_root),
413 cached_inlined_item.item_id));
420 debug!("maybe_get_item_ast({}): inlining item", tcx.item_path_str(def_id));
422 let inlined = self.get_crate_data(def_id.krate).maybe_get_item_ast(tcx, def_id.index);
424 let cache_inlined_item = |original_def_id, inlined_item_id, inlined_root_node_id| {
425 let cache_entry = cstore::CachedInlinedItem {
426 inlined_root: inlined_root_node_id,
427 item_id: inlined_item_id,
429 self.inlined_item_cache
431 .insert(original_def_id, Some(cache_entry));
432 self.defid_for_inlined_node
434 .insert(inlined_item_id, original_def_id);
437 let find_inlined_item_root = |inlined_item_id| {
438 let mut node = inlined_item_id;
439 let mut path = Vec::with_capacity(10);
441 // If we can't find the inline root after a thousand hops, we can
442 // be pretty sure there's something wrong with the HIR map.
445 let parent_node = tcx.map.get_parent_node(node);
446 if parent_node == node {
451 bug!("cycle in HIR map parent chain")
456 self.inlined_item_cache
458 .insert(def_id, None);
460 Some(&InlinedItem::Item(d, ref item)) => {
461 assert_eq!(d, def_id);
462 let inlined_root_node_id = find_inlined_item_root(item.id);
463 cache_inlined_item(def_id, item.id, inlined_root_node_id);
465 Some(&InlinedItem::TraitItem(_, ref trait_item)) => {
466 let inlined_root_node_id = find_inlined_item_root(trait_item.id);
467 cache_inlined_item(def_id, trait_item.id, inlined_root_node_id);
469 // Associated consts already have to be evaluated in `typeck`, so
470 // the logic to do that already exists in `middle`. In order to
471 // reuse that code, it needs to be able to look up the traits for
473 let ty_trait_item = tcx.associated_item(def_id).clone();
474 let trait_item_def_id = tcx.map.local_def_id(trait_item.id);
475 tcx.associated_items.borrow_mut()
476 .insert(trait_item_def_id, ty_trait_item);
478 Some(&InlinedItem::ImplItem(_, ref impl_item)) => {
479 let inlined_root_node_id = find_inlined_item_root(impl_item.id);
480 cache_inlined_item(def_id, impl_item.id, inlined_root_node_id);
484 // We can be sure to hit the cache now
485 return self.maybe_get_item_ast(tcx, def_id);
488 fn local_node_for_inlined_defid(&'tcx self, def_id: DefId) -> Option<ast::NodeId> {
489 assert!(!def_id.is_local());
490 match self.inlined_item_cache.borrow().get(&def_id) {
491 Some(&Some(ref cached_inlined_item)) => {
492 Some(cached_inlined_item.item_id)
498 bug!("Trying to lookup inlined NodeId for unexpected item");
503 fn defid_for_inlined_node(&'tcx self, node_id: ast::NodeId) -> Option<DefId> {
504 self.defid_for_inlined_node.borrow().get(&node_id).map(|x| *x)
507 fn get_item_mir<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> Mir<'tcx> {
508 self.dep_graph.read(DepNode::MetaData(def));
509 self.get_crate_data(def.krate).maybe_get_item_mir(tcx, def.index).unwrap_or_else(|| {
510 bug!("get_item_mir: missing MIR for {}", tcx.item_path_str(def))
514 fn is_item_mir_available(&self, def: DefId) -> bool {
515 self.dep_graph.read(DepNode::MetaData(def));
516 self.get_crate_data(def.krate).is_item_mir_available(def.index)
519 fn crates(&self) -> Vec<CrateNum>
521 let mut result = vec![];
522 self.iter_crate_data(|cnum, _| result.push(cnum));
526 fn used_libraries(&self) -> Vec<NativeLibrary>
528 self.get_used_libraries().borrow().clone()
531 fn used_link_args(&self) -> Vec<String>
533 self.get_used_link_args().borrow().clone()
536 fn metadata_filename(&self) -> &str
538 locator::METADATA_FILENAME
541 fn metadata_section_name(&self, target: &Target) -> &str
543 locator::meta_section_name(target)
546 fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
548 self.do_get_used_crates(prefer)
551 fn used_crate_source(&self, cnum: CrateNum) -> CrateSource
553 self.get_crate_data(cnum).source.clone()
556 fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>
558 self.do_extern_mod_stmt_cnum(emod_id)
561 fn encode_metadata<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>,
562 reexports: &def::ExportMap,
563 link_meta: &LinkMeta,
564 reachable: &NodeSet) -> Vec<u8>
566 encoder::encode_metadata(tcx, self, reexports, link_meta, reachable)
569 fn metadata_encoding_version(&self) -> &[u8]
571 schema::METADATA_HEADER
574 /// Returns a map from a sufficiently visible external item (i.e. an external item that is
575 /// visible from at least one local module) to a sufficiently visible parent (considering
576 /// modules that re-export the external item to be parents).
577 fn visible_parent_map<'a>(&'a self) -> ::std::cell::RefMut<'a, DefIdMap<DefId>> {
578 let mut visible_parent_map = self.visible_parent_map.borrow_mut();
579 if !visible_parent_map.is_empty() { return visible_parent_map; }
581 use std::collections::vec_deque::VecDeque;
582 use std::collections::hash_map::Entry;
583 for cnum in (1 .. self.next_crate_num().as_usize()).map(CrateNum::new) {
584 let cdata = self.get_crate_data(cnum);
586 match cdata.extern_crate.get() {
587 // Ignore crates without a corresponding local `extern crate` item.
588 Some(extern_crate) if !extern_crate.direct => continue,
592 let mut bfs_queue = &mut VecDeque::new();
593 let mut add_child = |bfs_queue: &mut VecDeque<_>, child: def::Export, parent: DefId| {
594 let child = child.def.def_id();
596 if self.visibility(child) != ty::Visibility::Public {
600 match visible_parent_map.entry(child) {
601 Entry::Occupied(mut entry) => {
602 // If `child` is defined in crate `cnum`, ensure
603 // that it is mapped to a parent in `cnum`.
604 if child.krate == cnum && entry.get().krate != cnum {
605 entry.insert(parent);
608 Entry::Vacant(entry) => {
609 entry.insert(parent);
610 bfs_queue.push_back(child);
615 bfs_queue.push_back(DefId {
617 index: CRATE_DEF_INDEX
619 while let Some(def) = bfs_queue.pop_front() {
620 for child in self.item_children(def) {
621 add_child(bfs_queue, child, def);