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::dep_graph::DepTrackingMapConfig;
17 use rustc::middle::cstore::{CrateStore, CrateSource, LibSource, DepKind,
18 ExternCrate, NativeLibrary, LinkMeta,
19 LinkagePreference, LoadedMacro, EncodedMetadata};
21 use rustc::middle::lang_items;
22 use rustc::session::Session;
23 use rustc::ty::{self, TyCtxt};
24 use rustc::ty::maps::Providers;
25 use rustc::hir::def_id::{CrateNum, DefId, DefIndex, CRATE_DEF_INDEX, LOCAL_CRATE};
27 use rustc::dep_graph::DepNode;
28 use rustc::hir::map::{DefKey, DefPath, DisambiguatedDefPathData};
29 use rustc::util::nodemap::{NodeSet, DefIdMap};
30 use rustc_back::PanicStrategy;
37 use syntax::parse::filemap_to_stream;
38 use syntax::symbol::Symbol;
39 use syntax_pos::{Span, NO_EXPANSION};
40 use rustc::hir::svh::Svh;
41 use rustc_back::target::Target;
44 use std::collections::BTreeMap;
46 macro_rules! provide {
47 (<$lt:tt> $tcx:ident, $def_id:ident, $cdata:ident $($name:ident => $compute:block)*) => {
48 pub fn provide<$lt>(providers: &mut Providers<$lt>) {
49 $(fn $name<'a, $lt:$lt>($tcx: TyCtxt<'a, $lt, $lt>, $def_id: DefId)
50 -> <ty::queries::$name<$lt> as
51 DepTrackingMapConfig>::Value {
52 assert!(!$def_id.is_local());
54 $tcx.dep_graph.read(DepNode::MetaData($def_id));
56 let $cdata = $tcx.sess.cstore.crate_data_as_rc_any($def_id.krate);
57 let $cdata = $cdata.downcast_ref::<cstore::CrateMetadata>()
58 .expect("CrateStore crated ata is not a CrateMetadata");
62 *providers = Providers {
70 provide! { <'tcx> tcx, def_id, cdata
71 type_of => { cdata.get_type(def_id.index, tcx) }
72 generics_of => { tcx.alloc_generics(cdata.get_generics(def_id.index)) }
73 predicates_of => { cdata.get_predicates(def_id.index, tcx) }
74 super_predicates_of => { cdata.get_super_predicates(def_id.index, tcx) }
76 tcx.alloc_trait_def(cdata.get_trait_def(def_id.index))
78 adt_def => { cdata.get_adt_def(def_id.index, tcx) }
81 tcx.calculate_dtor(def_id, &mut |_,_| Ok(()))
83 variances_of => { Rc::new(cdata.get_item_variances(def_id.index)) }
84 associated_item_def_ids => {
85 let mut result = vec![];
86 cdata.each_child_of_item(def_id.index, |child| result.push(child.def.def_id()));
89 associated_item => { cdata.get_associated_item(def_id.index) }
90 impl_trait_ref => { cdata.get_impl_trait(def_id.index, tcx) }
91 impl_polarity => { cdata.get_impl_polarity(def_id.index) }
92 coerce_unsized_info => {
93 cdata.get_coerce_unsized_info(def_id.index).unwrap_or_else(|| {
94 bug!("coerce_unsized_info: `{:?}` is missing its info", def_id);
98 let mir = cdata.maybe_get_optimized_mir(tcx, def_id.index).unwrap_or_else(|| {
99 bug!("get_optimized_mir: missing MIR for `{:?}`", def_id)
102 let mir = tcx.alloc_mir(mir);
106 mir_const_qualif => { cdata.mir_const_qualif(def_id.index) }
107 typeck_tables_of => { cdata.item_body_tables(def_id.index, tcx) }
108 closure_kind => { cdata.closure_kind(def_id.index) }
109 closure_type => { cdata.closure_ty(def_id.index, tcx) }
110 inherent_impls => { Rc::new(cdata.get_inherent_implementations_for_type(def_id.index)) }
111 is_foreign_item => { cdata.is_foreign_item(def_id.index) }
112 describe_def => { cdata.get_def(def_id.index) }
113 def_span => { cdata.get_span(def_id.index, &tcx.sess) }
114 stability => { cdata.get_stability(def_id.index) }
115 deprecation => { cdata.get_deprecation(def_id.index) }
116 item_attrs => { cdata.get_item_attrs(def_id.index) }
117 item_body_nested_bodies => {
118 let map: BTreeMap<_, _> = cdata.entry(def_id.index).ast.into_iter().flat_map(|ast| {
119 ast.decode(cdata).nested_bodies.decode(cdata).map(|body| (body.id(), body))
124 const_is_rvalue_promotable_to_static => {
125 cdata.entry(def_id.index).ast.expect("const item missing `ast`")
126 .decode(cdata).rvalue_promotable_to_static
128 is_mir_available => {
129 !cdata.is_proc_macro(def_id.index) &&
130 cdata.maybe_entry(def_id.index).and_then(|item| item.decode(cdata).mir).is_some()
134 impl CrateStore for cstore::CStore {
135 fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any> {
136 self.get_crate_data(krate)
139 fn visibility(&self, def: DefId) -> ty::Visibility {
140 self.dep_graph.read(DepNode::MetaData(def));
141 self.get_crate_data(def.krate).get_visibility(def.index)
144 fn item_generics_cloned(&self, def: DefId) -> ty::Generics {
145 self.dep_graph.read(DepNode::MetaData(def));
146 self.get_crate_data(def.krate).get_generics(def.index)
149 fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name>
151 // FIXME(#38501) We've skipped a `read` on the `HirBody` of
152 // a `fn` when encoding, so the dep-tracking wouldn't work.
153 // This is only used by rustdoc anyway, which shouldn't have
154 // incremental recompilation ever enabled.
155 assert!(!self.dep_graph.is_fully_enabled());
156 self.get_crate_data(did.krate).get_fn_arg_names(did.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 impl_defaultness(&self, def: DefId) -> hir::Defaultness
173 self.dep_graph.read(DepNode::MetaData(def));
174 self.get_crate_data(def.krate).get_impl_defaultness(def.index)
177 fn impl_parent(&self, impl_def: DefId) -> Option<DefId> {
178 self.dep_graph.read(DepNode::MetaData(impl_def));
179 self.get_crate_data(impl_def.krate).get_parent_impl(impl_def.index)
182 fn trait_of_item(&self, def_id: DefId) -> Option<DefId> {
183 self.dep_graph.read(DepNode::MetaData(def_id));
184 self.get_crate_data(def_id.krate).get_trait_of_item(def_id.index)
187 fn associated_item_cloned(&self, def: DefId) -> 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_default_impl(&self, impl_did: DefId) -> bool {
200 self.dep_graph.read(DepNode::MetaData(impl_did));
201 self.get_crate_data(impl_did.krate).is_default_impl(impl_did.index)
204 fn is_foreign_item(&self, did: DefId) -> bool {
205 self.get_crate_data(did.krate).is_foreign_item(did.index)
208 fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool
210 self.do_is_statically_included_foreign_item(def_id)
213 fn is_exported_symbol(&self, def_id: DefId) -> bool {
214 self.get_crate_data(def_id.krate).exported_symbols.contains(&def_id.index)
217 fn is_dllimport_foreign_item(&self, def_id: DefId) -> bool {
218 if def_id.krate == LOCAL_CRATE {
219 self.dllimport_foreign_items.borrow().contains(&def_id.index)
221 self.get_crate_data(def_id.krate).is_dllimport_foreign_item(def_id.index)
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 is_sanitizer_runtime(&self, cnum: CrateNum) -> bool {
273 self.get_crate_data(cnum).is_sanitizer_runtime()
276 fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
277 self.get_crate_data(cnum).panic_strategy()
280 fn crate_name(&self, cnum: CrateNum) -> Symbol
282 self.get_crate_data(cnum).name
285 fn original_crate_name(&self, cnum: CrateNum) -> Symbol
287 self.get_crate_data(cnum).name()
290 fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate>
292 self.get_crate_data(cnum).extern_crate.get()
295 fn crate_hash(&self, cnum: CrateNum) -> Svh
297 self.get_crate_hash(cnum)
300 fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol
302 self.get_crate_data(cnum).disambiguator()
305 fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
307 self.get_crate_data(cnum).root.plugin_registrar_fn.map(|index| DefId {
313 fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
315 self.get_crate_data(cnum).root.macro_derive_registrar.map(|index| DefId {
321 fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
323 self.get_crate_data(cnum).get_native_libraries()
326 fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>
328 self.get_crate_data(cnum).get_exported_symbols()
331 fn is_no_builtins(&self, cnum: CrateNum) -> bool {
332 self.get_crate_data(cnum).is_no_builtins()
335 fn retrace_path(&self,
337 path: &[DisambiguatedDefPathData])
339 let cdata = self.get_crate_data(cnum);
342 .map(|index| DefId { krate: cnum, index: index })
345 /// Returns the `DefKey` for a given `DefId`. This indicates the
346 /// parent `DefId` as well as some idea of what kind of data the
347 /// `DefId` refers to.
348 fn def_key(&self, def: DefId) -> DefKey {
349 // Note: loading the def-key (or def-path) for a def-id is not
350 // a *read* of its metadata. This is because the def-id is
351 // really just an interned shorthand for a def-path, which is the
352 // canonical name for an item.
354 // self.dep_graph.read(DepNode::MetaData(def));
355 self.get_crate_data(def.krate).def_key(def.index)
358 fn def_path(&self, def: DefId) -> DefPath {
359 // See `Note` above in `def_key()` for why this read is
362 // self.dep_graph.read(DepNode::MetaData(def));
363 self.get_crate_data(def.krate).def_path(def.index)
366 fn def_path_hash(&self, def: DefId) -> u64 {
367 self.get_crate_data(def.krate).def_path_hash(def.index)
370 fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>
372 self.dep_graph.read(DepNode::MetaData(def));
373 self.get_crate_data(def.krate).get_struct_field_names(def.index)
376 fn item_children(&self, def_id: DefId) -> Vec<def::Export>
378 self.dep_graph.read(DepNode::MetaData(def_id));
379 let mut result = vec![];
380 self.get_crate_data(def_id.krate)
381 .each_child_of_item(def_id.index, |child| result.push(child));
385 fn load_macro(&self, id: DefId, sess: &Session) -> LoadedMacro {
386 let data = self.get_crate_data(id.krate);
387 if let Some(ref proc_macros) = data.proc_macros {
388 return LoadedMacro::ProcMacro(proc_macros[id.index.as_usize() - 1].1.clone());
391 let (name, def) = data.get_macro(id.index);
392 let source_name = format!("<{} macros>", name);
394 let filemap = sess.parse_sess.codemap().new_filemap(source_name, def.body);
395 let local_span = Span { lo: filemap.start_pos, hi: filemap.end_pos, ctxt: NO_EXPANSION };
396 let body = filemap_to_stream(&sess.parse_sess, filemap);
398 // Mark the attrs as used
399 let attrs = data.get_item_attrs(id.index);
400 for attr in attrs.iter() {
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::MacroDef(ast::Item {
410 ident: ast::Ident::with_empty_ctxt(name),
411 id: ast::DUMMY_NODE_ID,
413 attrs: attrs.iter().cloned().collect(),
414 node: ast::ItemKind::MacroDef(body.into()),
415 vis: ast::Visibility::Inherited,
419 fn item_body<'a, 'tcx>(&self,
420 tcx: TyCtxt<'a, 'tcx, 'tcx>,
423 if let Some(cached) = tcx.hir.get_inlined_body(def_id) {
427 self.dep_graph.read(DepNode::MetaData(def_id));
428 debug!("item_body({}): inlining item", tcx.item_path_str(def_id));
430 self.get_crate_data(def_id.krate).item_body(tcx, def_id.index)
433 fn crates(&self) -> Vec<CrateNum>
435 let mut result = vec![];
436 self.iter_crate_data(|cnum, _| result.push(cnum));
440 fn used_libraries(&self) -> Vec<NativeLibrary>
442 self.get_used_libraries().borrow().clone()
445 fn used_link_args(&self) -> Vec<String>
447 self.get_used_link_args().borrow().clone()
450 fn metadata_filename(&self) -> &str
452 locator::METADATA_FILENAME
455 fn metadata_section_name(&self, target: &Target) -> &str
457 locator::meta_section_name(target)
460 fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
462 self.do_get_used_crates(prefer)
465 fn used_crate_source(&self, cnum: CrateNum) -> CrateSource
467 self.get_crate_data(cnum).source.clone()
470 fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>
472 self.do_extern_mod_stmt_cnum(emod_id)
475 fn encode_metadata<'a, 'tcx>(&self,
476 tcx: TyCtxt<'a, 'tcx, 'tcx>,
477 link_meta: &LinkMeta,
481 encoder::encode_metadata(tcx, self, link_meta, reachable)
484 fn metadata_encoding_version(&self) -> &[u8]
486 schema::METADATA_HEADER
489 /// Returns a map from a sufficiently visible external item (i.e. an external item that is
490 /// visible from at least one local module) to a sufficiently visible parent (considering
491 /// modules that re-export the external item to be parents).
492 fn visible_parent_map<'a>(&'a self) -> ::std::cell::Ref<'a, DefIdMap<DefId>> {
494 let visible_parent_map = self.visible_parent_map.borrow();
495 if !visible_parent_map.is_empty() {
496 return visible_parent_map;
500 use std::collections::vec_deque::VecDeque;
501 use std::collections::hash_map::Entry;
503 let mut visible_parent_map = self.visible_parent_map.borrow_mut();
505 for cnum in (1 .. self.next_crate_num().as_usize()).map(CrateNum::new) {
506 let cdata = self.get_crate_data(cnum);
508 match cdata.extern_crate.get() {
509 // Ignore crates without a corresponding local `extern crate` item.
510 Some(extern_crate) if !extern_crate.direct => continue,
514 let mut bfs_queue = &mut VecDeque::new();
515 let mut add_child = |bfs_queue: &mut VecDeque<_>, child: def::Export, parent: DefId| {
516 let child = child.def.def_id();
518 if self.visibility(child) != ty::Visibility::Public {
522 match visible_parent_map.entry(child) {
523 Entry::Occupied(mut entry) => {
524 // If `child` is defined in crate `cnum`, ensure
525 // that it is mapped to a parent in `cnum`.
526 if child.krate == cnum && entry.get().krate != cnum {
527 entry.insert(parent);
530 Entry::Vacant(entry) => {
531 entry.insert(parent);
532 bfs_queue.push_back(child);
537 bfs_queue.push_back(DefId {
539 index: CRATE_DEF_INDEX
541 while let Some(def) = bfs_queue.pop_front() {
542 for child in self.item_children(def) {
543 add_child(bfs_queue, child, def);
548 drop(visible_parent_map);
549 self.visible_parent_map.borrow()