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::{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::middle::resolve_lifetime::ObjectLifetimeDefault;
21 use rustc::session::Session;
22 use rustc::ty::{self, Ty, TyCtxt};
23 use rustc::hir::def_id::{CrateNum, DefId, DefIndex, CRATE_DEF_INDEX, LOCAL_CRATE};
25 use rustc::dep_graph::DepNode;
26 use rustc::hir::map::{DefKey, DefPath, DisambiguatedDefPathData};
28 use rustc::util::nodemap::{NodeSet, DefIdMap};
29 use rustc_back::PanicStrategy;
33 use syntax::parse::filemap_to_tts;
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 use std::collections::BTreeMap;
42 impl<'tcx> CrateStore<'tcx> for cstore::CStore {
43 fn describe_def(&self, def: DefId) -> Option<Def> {
44 self.dep_graph.read(DepNode::MetaData(def));
45 self.get_crate_data(def.krate).get_def(def.index)
48 fn def_span(&self, sess: &Session, def: DefId) -> Span {
49 self.dep_graph.read(DepNode::MetaData(def));
50 self.get_crate_data(def.krate).get_span(def.index, sess)
53 fn stability(&self, def: DefId) -> Option<attr::Stability> {
54 self.dep_graph.read(DepNode::MetaData(def));
55 self.get_crate_data(def.krate).get_stability(def.index)
58 fn deprecation(&self, def: DefId) -> Option<attr::Deprecation> {
59 self.dep_graph.read(DepNode::MetaData(def));
60 self.get_crate_data(def.krate).get_deprecation(def.index)
63 fn visibility(&self, def: DefId) -> ty::Visibility {
64 self.dep_graph.read(DepNode::MetaData(def));
65 self.get_crate_data(def.krate).get_visibility(def.index)
68 fn closure_kind(&self, def_id: DefId) -> ty::ClosureKind
70 assert!(!def_id.is_local());
71 self.dep_graph.read(DepNode::MetaData(def_id));
72 self.get_crate_data(def_id.krate).closure_kind(def_id.index)
75 fn closure_ty<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> ty::ClosureTy<'tcx> {
76 assert!(!def_id.is_local());
77 self.dep_graph.read(DepNode::MetaData(def_id));
78 self.get_crate_data(def_id.krate).closure_ty(def_id.index, tcx)
81 fn item_variances(&self, def: DefId) -> Vec<ty::Variance> {
82 self.dep_graph.read(DepNode::MetaData(def));
83 self.get_crate_data(def.krate).get_item_variances(def.index)
86 fn item_type<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
89 self.dep_graph.read(DepNode::MetaData(def));
90 self.get_crate_data(def.krate).get_type(def.index, tcx)
93 fn item_predicates<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
94 -> ty::GenericPredicates<'tcx>
96 self.dep_graph.read(DepNode::MetaData(def));
97 self.get_crate_data(def.krate).get_predicates(def.index, tcx)
100 fn item_super_predicates<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
101 -> ty::GenericPredicates<'tcx>
103 self.dep_graph.read(DepNode::MetaData(def));
104 self.get_crate_data(def.krate).get_super_predicates(def.index, tcx)
107 fn item_generics<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
108 -> ty::Generics<'tcx>
110 self.dep_graph.read(DepNode::MetaData(def));
111 self.get_crate_data(def.krate).get_generics(def.index, tcx)
114 fn item_generics_own_param_counts(&self, def: DefId) -> (usize, usize) {
115 self.dep_graph.read(DepNode::MetaData(def));
116 self.get_crate_data(def.krate).generics_own_param_counts(def.index)
119 fn item_generics_object_lifetime_defaults(&self, def: DefId)
120 -> Vec<ObjectLifetimeDefault> {
121 self.dep_graph.read(DepNode::MetaData(def));
122 self.get_crate_data(def.krate).generics_object_lifetime_defaults(def.index)
125 fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute>
127 self.dep_graph.read(DepNode::MetaData(def_id));
128 self.get_crate_data(def_id.krate).get_item_attrs(def_id.index)
131 fn trait_def<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> ty::TraitDef
133 self.dep_graph.read(DepNode::MetaData(def));
134 self.get_crate_data(def.krate).get_trait_def(def.index, tcx)
137 fn adt_def<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> &'tcx ty::AdtDef
139 self.dep_graph.read(DepNode::MetaData(def));
140 self.get_crate_data(def.krate).get_adt_def(def.index, tcx)
143 fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name>
145 // FIXME(#38501) We've skipped a `read` on the `HirBody` of
146 // a `fn` when encoding, so the dep-tracking wouldn't work.
147 // This is only used by rustdoc anyway, which shouldn't have
148 // incremental recompilation ever enabled.
149 assert!(!self.dep_graph.is_fully_enabled());
150 self.get_crate_data(did.krate).get_fn_arg_names(did.index)
153 fn inherent_implementations_for_type(&self, def_id: DefId) -> Vec<DefId>
155 self.dep_graph.read(DepNode::MetaData(def_id));
156 self.get_crate_data(def_id.krate).get_inherent_implementations_for_type(def_id.index)
159 fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>
161 if let Some(def_id) = filter {
162 self.dep_graph.read(DepNode::MetaData(def_id));
164 let mut result = vec![];
165 self.iter_crate_data(|_, cdata| {
166 cdata.get_implementations_for_trait(filter, &mut result)
171 fn associated_item_def_ids(&self, def_id: DefId) -> Vec<DefId> {
172 self.dep_graph.read(DepNode::MetaData(def_id));
173 let mut result = vec![];
174 self.get_crate_data(def_id.krate)
175 .each_child_of_item(def_id.index, |child| result.push(child.def.def_id()));
179 fn impl_polarity(&self, def: DefId) -> hir::ImplPolarity
181 self.dep_graph.read(DepNode::MetaData(def));
182 self.get_crate_data(def.krate).get_impl_polarity(def.index)
185 fn impl_trait_ref<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
186 -> Option<ty::TraitRef<'tcx>>
188 self.dep_graph.read(DepNode::MetaData(def));
189 self.get_crate_data(def.krate).get_impl_trait(def.index, tcx)
192 fn custom_coerce_unsized_kind(&self, def: DefId)
193 -> Option<ty::adjustment::CustomCoerceUnsized>
195 self.dep_graph.read(DepNode::MetaData(def));
196 self.get_crate_data(def.krate).get_custom_coerce_unsized_kind(def.index)
199 fn impl_parent(&self, impl_def: DefId) -> Option<DefId> {
200 self.dep_graph.read(DepNode::MetaData(impl_def));
201 self.get_crate_data(impl_def.krate).get_parent_impl(impl_def.index)
204 fn trait_of_item(&self, def_id: DefId) -> Option<DefId> {
205 self.dep_graph.read(DepNode::MetaData(def_id));
206 self.get_crate_data(def_id.krate).get_trait_of_item(def_id.index)
209 fn associated_item(&self, def: DefId) -> Option<ty::AssociatedItem>
211 self.dep_graph.read(DepNode::MetaData(def));
212 self.get_crate_data(def.krate).get_associated_item(def.index)
215 fn is_const_fn(&self, did: DefId) -> bool
217 self.dep_graph.read(DepNode::MetaData(did));
218 self.get_crate_data(did.krate).is_const_fn(did.index)
221 fn is_defaulted_trait(&self, trait_def_id: DefId) -> bool
223 self.dep_graph.read(DepNode::MetaData(trait_def_id));
224 self.get_crate_data(trait_def_id.krate).is_defaulted_trait(trait_def_id.index)
227 fn is_default_impl(&self, impl_did: DefId) -> bool {
228 self.dep_graph.read(DepNode::MetaData(impl_did));
229 self.get_crate_data(impl_did.krate).is_default_impl(impl_did.index)
232 fn is_foreign_item(&self, did: DefId) -> bool {
233 self.get_crate_data(did.krate).is_foreign_item(did.index)
236 fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool
238 self.do_is_statically_included_foreign_item(def_id)
241 fn is_exported_symbol(&self, def_id: DefId) -> bool {
242 self.get_crate_data(def_id.krate).exported_symbols.contains(&def_id.index)
245 fn is_dllimport_foreign_item(&self, def_id: DefId) -> bool {
246 if def_id.krate == LOCAL_CRATE {
247 self.dllimport_foreign_items.borrow().contains(&def_id.index)
249 self.get_crate_data(def_id.krate).is_dllimport_foreign_item(def_id.index)
253 fn dylib_dependency_formats(&self, cnum: CrateNum)
254 -> Vec<(CrateNum, LinkagePreference)>
256 self.get_crate_data(cnum).get_dylib_dependency_formats()
259 fn dep_kind(&self, cnum: CrateNum) -> DepKind
261 self.get_crate_data(cnum).dep_kind.get()
264 fn export_macros(&self, cnum: CrateNum) {
265 if self.get_crate_data(cnum).dep_kind.get() == DepKind::UnexportedMacrosOnly {
266 self.get_crate_data(cnum).dep_kind.set(DepKind::MacrosOnly)
270 fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
272 self.get_crate_data(cnum).get_lang_items()
275 fn missing_lang_items(&self, cnum: CrateNum)
276 -> Vec<lang_items::LangItem>
278 self.get_crate_data(cnum).get_missing_lang_items()
281 fn is_staged_api(&self, cnum: CrateNum) -> bool
283 self.get_crate_data(cnum).is_staged_api()
286 fn is_allocator(&self, cnum: CrateNum) -> bool
288 self.get_crate_data(cnum).is_allocator()
291 fn is_panic_runtime(&self, cnum: CrateNum) -> bool
293 self.get_crate_data(cnum).is_panic_runtime()
296 fn is_compiler_builtins(&self, cnum: CrateNum) -> bool {
297 self.get_crate_data(cnum).is_compiler_builtins()
300 fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool {
301 self.get_crate_data(cnum).is_sanitizer_runtime()
304 fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
305 self.get_crate_data(cnum).panic_strategy()
308 fn crate_name(&self, cnum: CrateNum) -> Symbol
310 self.get_crate_data(cnum).name
313 fn original_crate_name(&self, cnum: CrateNum) -> Symbol
315 self.get_crate_data(cnum).name()
318 fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate>
320 self.get_crate_data(cnum).extern_crate.get()
323 fn crate_hash(&self, cnum: CrateNum) -> Svh
325 self.get_crate_hash(cnum)
328 fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol
330 self.get_crate_data(cnum).disambiguator()
333 fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
335 self.get_crate_data(cnum).root.plugin_registrar_fn.map(|index| DefId {
341 fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
343 self.get_crate_data(cnum).root.macro_derive_registrar.map(|index| DefId {
349 fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
351 self.get_crate_data(cnum).get_native_libraries()
354 fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>
356 self.get_crate_data(cnum).get_exported_symbols()
359 fn is_no_builtins(&self, cnum: CrateNum) -> bool {
360 self.get_crate_data(cnum).is_no_builtins()
363 fn retrace_path(&self,
365 path: &[DisambiguatedDefPathData])
367 let cdata = self.get_crate_data(cnum);
370 .map(|index| DefId { krate: cnum, index: index })
373 /// Returns the `DefKey` for a given `DefId`. This indicates the
374 /// parent `DefId` as well as some idea of what kind of data the
375 /// `DefId` refers to.
376 fn def_key(&self, def: DefId) -> DefKey {
377 // Note: loading the def-key (or def-path) for a def-id is not
378 // a *read* of its metadata. This is because the def-id is
379 // really just an interned shorthand for a def-path, which is the
380 // canonical name for an item.
382 // self.dep_graph.read(DepNode::MetaData(def));
383 self.get_crate_data(def.krate).def_key(def.index)
386 fn def_path(&self, def: DefId) -> DefPath {
387 // See `Note` above in `def_key()` for why this read is
390 // self.dep_graph.read(DepNode::MetaData(def));
391 self.get_crate_data(def.krate).def_path(def.index)
394 fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>
396 self.dep_graph.read(DepNode::MetaData(def));
397 self.get_crate_data(def.krate).get_struct_field_names(def.index)
400 fn item_children(&self, def_id: DefId) -> Vec<def::Export>
402 self.dep_graph.read(DepNode::MetaData(def_id));
403 let mut result = vec![];
404 self.get_crate_data(def_id.krate)
405 .each_child_of_item(def_id.index, |child| result.push(child));
409 fn load_macro(&self, id: DefId, sess: &Session) -> LoadedMacro {
410 let data = self.get_crate_data(id.krate);
411 if let Some(ref proc_macros) = data.proc_macros {
412 return LoadedMacro::ProcMacro(proc_macros[id.index.as_usize() - 1].1.clone());
415 let (name, def) = data.get_macro(id.index);
416 let source_name = format!("<{} macros>", name);
418 let filemap = sess.parse_sess.codemap().new_filemap(source_name, None, def.body);
419 let local_span = mk_sp(filemap.start_pos, filemap.end_pos);
420 let body = filemap_to_tts(&sess.parse_sess, filemap);
422 // Mark the attrs as used
423 let attrs = data.get_item_attrs(id.index);
425 attr::mark_used(attr);
428 let name = data.def_key(id.index).disambiguated_data.data
429 .get_opt_name().expect("no name in load_macro");
430 sess.imported_macro_spans.borrow_mut()
431 .insert(local_span, (name.to_string(), data.get_span(id.index, sess)));
433 LoadedMacro::MacroRules(ast::MacroDef {
434 ident: ast::Ident::with_empty_ctxt(name),
435 id: ast::DUMMY_NODE_ID,
442 fn maybe_get_item_body<'a>(&'tcx self,
443 tcx: TyCtxt<'a, 'tcx, 'tcx>,
445 -> Option<&'tcx hir::Body>
447 if let Some(cached) = tcx.hir.get_inlined_body(def_id) {
451 self.dep_graph.read(DepNode::MetaData(def_id));
452 debug!("maybe_get_item_body({}): inlining item", tcx.item_path_str(def_id));
454 self.get_crate_data(def_id.krate).maybe_get_item_body(tcx, def_id.index)
457 fn item_body_nested_bodies(&self, def: DefId) -> BTreeMap<hir::BodyId, hir::Body> {
458 self.dep_graph.read(DepNode::MetaData(def));
459 self.get_crate_data(def.krate).item_body_nested_bodies(def.index)
462 fn const_is_rvalue_promotable_to_static(&self, def: DefId) -> bool {
463 self.dep_graph.read(DepNode::MetaData(def));
464 self.get_crate_data(def.krate).const_is_rvalue_promotable_to_static(def.index)
467 fn get_item_mir<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> Mir<'tcx> {
468 self.dep_graph.read(DepNode::MetaData(def));
469 self.get_crate_data(def.krate).maybe_get_item_mir(tcx, def.index).unwrap_or_else(|| {
470 bug!("get_item_mir: missing MIR for {}", tcx.item_path_str(def))
474 fn is_item_mir_available(&self, def: DefId) -> bool {
475 self.dep_graph.read(DepNode::MetaData(def));
476 self.get_crate_data(def.krate).is_item_mir_available(def.index)
479 fn crates(&self) -> Vec<CrateNum>
481 let mut result = vec![];
482 self.iter_crate_data(|cnum, _| result.push(cnum));
486 fn used_libraries(&self) -> Vec<NativeLibrary>
488 self.get_used_libraries().borrow().clone()
491 fn used_link_args(&self) -> Vec<String>
493 self.get_used_link_args().borrow().clone()
496 fn metadata_filename(&self) -> &str
498 locator::METADATA_FILENAME
501 fn metadata_section_name(&self, target: &Target) -> &str
503 locator::meta_section_name(target)
506 fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
508 self.do_get_used_crates(prefer)
511 fn used_crate_source(&self, cnum: CrateNum) -> CrateSource
513 self.get_crate_data(cnum).source.clone()
516 fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>
518 self.do_extern_mod_stmt_cnum(emod_id)
521 fn encode_metadata<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>,
522 reexports: &def::ExportMap,
523 link_meta: &LinkMeta,
524 reachable: &NodeSet) -> Vec<u8>
526 encoder::encode_metadata(tcx, self, reexports, link_meta, reachable)
529 fn metadata_encoding_version(&self) -> &[u8]
531 schema::METADATA_HEADER
534 /// Returns a map from a sufficiently visible external item (i.e. an external item that is
535 /// visible from at least one local module) to a sufficiently visible parent (considering
536 /// modules that re-export the external item to be parents).
537 fn visible_parent_map<'a>(&'a self) -> ::std::cell::RefMut<'a, DefIdMap<DefId>> {
538 let mut visible_parent_map = self.visible_parent_map.borrow_mut();
539 if !visible_parent_map.is_empty() { return visible_parent_map; }
541 use std::collections::vec_deque::VecDeque;
542 use std::collections::hash_map::Entry;
543 for cnum in (1 .. self.next_crate_num().as_usize()).map(CrateNum::new) {
544 let cdata = self.get_crate_data(cnum);
546 match cdata.extern_crate.get() {
547 // Ignore crates without a corresponding local `extern crate` item.
548 Some(extern_crate) if !extern_crate.direct => continue,
552 let mut bfs_queue = &mut VecDeque::new();
553 let mut add_child = |bfs_queue: &mut VecDeque<_>, child: def::Export, parent: DefId| {
554 let child = child.def.def_id();
556 if self.visibility(child) != ty::Visibility::Public {
560 match visible_parent_map.entry(child) {
561 Entry::Occupied(mut entry) => {
562 // If `child` is defined in crate `cnum`, ensure
563 // that it is mapped to a parent in `cnum`.
564 if child.krate == cnum && entry.get().krate != cnum {
565 entry.insert(parent);
568 Entry::Vacant(entry) => {
569 entry.insert(parent);
570 bfs_queue.push_back(child);
575 bfs_queue.push_back(DefId {
577 index: CRATE_DEF_INDEX
579 while let Some(def) = bfs_queue.pop_front() {
580 for child in self.item_children(def) {
581 add_child(bfs_queue, child, def);