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;
38 use syntax::parse::filemap_to_stream;
39 use syntax::symbol::Symbol;
40 use syntax_pos::{Span, NO_EXPANSION};
41 use rustc::hir::svh::Svh;
42 use rustc_back::target::Target;
45 use std::collections::BTreeMap;
47 macro_rules! provide {
48 (<$lt:tt> $tcx:ident, $def_id:ident, $cdata:ident $($name:ident => $compute:block)*) => {
49 pub fn provide<$lt>(providers: &mut Providers<$lt>) {
50 $(fn $name<'a, $lt:$lt>($tcx: TyCtxt<'a, $lt, $lt>, $def_id: DefId)
51 -> <ty::queries::$name<$lt> as
52 DepTrackingMapConfig>::Value {
53 assert!(!$def_id.is_local());
55 $tcx.dep_graph.read(DepNode::MetaData($def_id));
57 let $cdata = $tcx.sess.cstore.crate_data_as_rc_any($def_id.krate);
58 let $cdata = $cdata.downcast_ref::<cstore::CrateMetadata>()
59 .expect("CrateStore crated ata is not a CrateMetadata");
63 *providers = Providers {
71 provide! { <'tcx> tcx, def_id, cdata
72 type_of => { cdata.get_type(def_id.index, tcx) }
73 generics_of => { tcx.alloc_generics(cdata.get_generics(def_id.index)) }
74 predicates_of => { cdata.get_predicates(def_id.index, tcx) }
75 super_predicates_of => { cdata.get_super_predicates(def_id.index, tcx) }
77 tcx.alloc_trait_def(cdata.get_trait_def(def_id.index))
79 adt_def => { cdata.get_adt_def(def_id.index, tcx) }
82 tcx.calculate_dtor(def_id, &mut |_,_| Ok(()))
84 variances_of => { Rc::new(cdata.get_item_variances(def_id.index)) }
85 associated_item_def_ids => {
86 let mut result = vec![];
87 cdata.each_child_of_item(def_id.index, |child| result.push(child.def.def_id()));
90 associated_item => { cdata.get_associated_item(def_id.index) }
91 impl_trait_ref => { cdata.get_impl_trait(def_id.index, tcx) }
92 impl_polarity => { cdata.get_impl_polarity(def_id.index) }
93 coerce_unsized_info => {
94 cdata.get_coerce_unsized_info(def_id.index).unwrap_or_else(|| {
95 bug!("coerce_unsized_info: `{:?}` is missing its info", def_id);
99 let mir = cdata.maybe_get_item_mir(tcx, def_id.index).unwrap_or_else(|| {
100 bug!("get_item_mir: missing MIR for `{:?}`", def_id)
103 let mir = tcx.alloc_mir(mir);
105 // Perma-borrow MIR from extern crates to prevent mutation.
106 mem::forget(mir.borrow());
110 mir_const_qualif => { cdata.mir_const_qualif(def_id.index) }
111 typeck_tables_of => { cdata.item_body_tables(def_id.index, tcx) }
112 closure_kind => { cdata.closure_kind(def_id.index) }
113 closure_type => { cdata.closure_ty(def_id.index, tcx) }
114 inherent_impls => { Rc::new(cdata.get_inherent_implementations_for_type(def_id.index)) }
115 is_foreign_item => { cdata.is_foreign_item(def_id.index) }
116 describe_def => { cdata.get_def(def_id.index) }
117 def_span => { cdata.get_span(def_id.index, &tcx.sess) }
118 item_body_nested_bodies => {
119 let map: BTreeMap<_, _> = cdata.entry(def_id.index).ast.into_iter().flat_map(|ast| {
120 ast.decode(cdata).nested_bodies.decode(cdata).map(|body| (body.id(), body))
125 const_is_rvalue_promotable_to_static => {
126 cdata.entry(def_id.index).ast.expect("const item missing `ast`")
127 .decode(cdata).rvalue_promotable_to_static
131 impl CrateStore for cstore::CStore {
132 fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any> {
133 self.get_crate_data(krate)
136 fn stability(&self, def: DefId) -> Option<attr::Stability> {
137 self.dep_graph.read(DepNode::MetaData(def));
138 self.get_crate_data(def.krate).get_stability(def.index)
141 fn deprecation(&self, def: DefId) -> Option<attr::Deprecation> {
142 self.dep_graph.read(DepNode::MetaData(def));
143 self.get_crate_data(def.krate).get_deprecation(def.index)
146 fn visibility(&self, def: DefId) -> ty::Visibility {
147 self.dep_graph.read(DepNode::MetaData(def));
148 self.get_crate_data(def.krate).get_visibility(def.index)
151 fn item_generics_cloned(&self, def: DefId) -> ty::Generics {
152 self.dep_graph.read(DepNode::MetaData(def));
153 self.get_crate_data(def.krate).get_generics(def.index)
156 fn item_attrs(&self, def_id: DefId) -> Rc<[ast::Attribute]>
158 self.dep_graph.read(DepNode::MetaData(def_id));
159 self.get_crate_data(def_id.krate).get_item_attrs(def_id.index)
162 fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name>
164 // FIXME(#38501) We've skipped a `read` on the `HirBody` of
165 // a `fn` when encoding, so the dep-tracking wouldn't work.
166 // This is only used by rustdoc anyway, which shouldn't have
167 // incremental recompilation ever enabled.
168 assert!(!self.dep_graph.is_fully_enabled());
169 self.get_crate_data(did.krate).get_fn_arg_names(did.index)
172 fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>
174 if let Some(def_id) = filter {
175 self.dep_graph.read(DepNode::MetaData(def_id));
177 let mut result = vec![];
178 self.iter_crate_data(|_, cdata| {
179 cdata.get_implementations_for_trait(filter, &mut result)
184 fn impl_defaultness(&self, def: DefId) -> hir::Defaultness
186 self.dep_graph.read(DepNode::MetaData(def));
187 self.get_crate_data(def.krate).get_impl_defaultness(def.index)
190 fn impl_parent(&self, impl_def: DefId) -> Option<DefId> {
191 self.dep_graph.read(DepNode::MetaData(impl_def));
192 self.get_crate_data(impl_def.krate).get_parent_impl(impl_def.index)
195 fn trait_of_item(&self, def_id: DefId) -> Option<DefId> {
196 self.dep_graph.read(DepNode::MetaData(def_id));
197 self.get_crate_data(def_id.krate).get_trait_of_item(def_id.index)
200 fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem
202 self.dep_graph.read(DepNode::MetaData(def));
203 self.get_crate_data(def.krate).get_associated_item(def.index)
206 fn is_const_fn(&self, did: DefId) -> bool
208 self.dep_graph.read(DepNode::MetaData(did));
209 self.get_crate_data(did.krate).is_const_fn(did.index)
212 fn is_default_impl(&self, impl_did: DefId) -> bool {
213 self.dep_graph.read(DepNode::MetaData(impl_did));
214 self.get_crate_data(impl_did.krate).is_default_impl(impl_did.index)
217 fn is_foreign_item(&self, did: DefId) -> bool {
218 self.get_crate_data(did.krate).is_foreign_item(did.index)
221 fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool
223 self.do_is_statically_included_foreign_item(def_id)
226 fn is_exported_symbol(&self, def_id: DefId) -> bool {
227 self.get_crate_data(def_id.krate).exported_symbols.contains(&def_id.index)
230 fn is_dllimport_foreign_item(&self, def_id: DefId) -> bool {
231 if def_id.krate == LOCAL_CRATE {
232 self.dllimport_foreign_items.borrow().contains(&def_id.index)
234 self.get_crate_data(def_id.krate).is_dllimport_foreign_item(def_id.index)
238 fn dylib_dependency_formats(&self, cnum: CrateNum)
239 -> Vec<(CrateNum, LinkagePreference)>
241 self.get_crate_data(cnum).get_dylib_dependency_formats()
244 fn dep_kind(&self, cnum: CrateNum) -> DepKind
246 self.get_crate_data(cnum).dep_kind.get()
249 fn export_macros(&self, cnum: CrateNum) {
250 if self.get_crate_data(cnum).dep_kind.get() == DepKind::UnexportedMacrosOnly {
251 self.get_crate_data(cnum).dep_kind.set(DepKind::MacrosOnly)
255 fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
257 self.get_crate_data(cnum).get_lang_items()
260 fn missing_lang_items(&self, cnum: CrateNum)
261 -> Vec<lang_items::LangItem>
263 self.get_crate_data(cnum).get_missing_lang_items()
266 fn is_staged_api(&self, cnum: CrateNum) -> bool
268 self.get_crate_data(cnum).is_staged_api()
271 fn is_allocator(&self, cnum: CrateNum) -> bool
273 self.get_crate_data(cnum).is_allocator()
276 fn is_panic_runtime(&self, cnum: CrateNum) -> bool
278 self.get_crate_data(cnum).is_panic_runtime()
281 fn is_compiler_builtins(&self, cnum: CrateNum) -> bool {
282 self.get_crate_data(cnum).is_compiler_builtins()
285 fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool {
286 self.get_crate_data(cnum).is_sanitizer_runtime()
289 fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
290 self.get_crate_data(cnum).panic_strategy()
293 fn crate_name(&self, cnum: CrateNum) -> Symbol
295 self.get_crate_data(cnum).name
298 fn original_crate_name(&self, cnum: CrateNum) -> Symbol
300 self.get_crate_data(cnum).name()
303 fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate>
305 self.get_crate_data(cnum).extern_crate.get()
308 fn crate_hash(&self, cnum: CrateNum) -> Svh
310 self.get_crate_hash(cnum)
313 fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol
315 self.get_crate_data(cnum).disambiguator()
318 fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
320 self.get_crate_data(cnum).root.plugin_registrar_fn.map(|index| DefId {
326 fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
328 self.get_crate_data(cnum).root.macro_derive_registrar.map(|index| DefId {
334 fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
336 self.get_crate_data(cnum).get_native_libraries()
339 fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>
341 self.get_crate_data(cnum).get_exported_symbols()
344 fn is_no_builtins(&self, cnum: CrateNum) -> bool {
345 self.get_crate_data(cnum).is_no_builtins()
348 fn retrace_path(&self,
350 path: &[DisambiguatedDefPathData])
352 let cdata = self.get_crate_data(cnum);
355 .map(|index| DefId { krate: cnum, index: index })
358 /// Returns the `DefKey` for a given `DefId`. This indicates the
359 /// parent `DefId` as well as some idea of what kind of data the
360 /// `DefId` refers to.
361 fn def_key(&self, def: DefId) -> DefKey {
362 // Note: loading the def-key (or def-path) for a def-id is not
363 // a *read* of its metadata. This is because the def-id is
364 // really just an interned shorthand for a def-path, which is the
365 // canonical name for an item.
367 // self.dep_graph.read(DepNode::MetaData(def));
368 self.get_crate_data(def.krate).def_key(def.index)
371 fn def_path(&self, def: DefId) -> DefPath {
372 // See `Note` above in `def_key()` for why this read is
375 // self.dep_graph.read(DepNode::MetaData(def));
376 self.get_crate_data(def.krate).def_path(def.index)
379 fn def_path_hash(&self, def: DefId) -> u64 {
380 self.get_crate_data(def.krate).def_path_hash(def.index)
383 fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>
385 self.dep_graph.read(DepNode::MetaData(def));
386 self.get_crate_data(def.krate).get_struct_field_names(def.index)
389 fn item_children(&self, def_id: DefId) -> Vec<def::Export>
391 self.dep_graph.read(DepNode::MetaData(def_id));
392 let mut result = vec![];
393 self.get_crate_data(def_id.krate)
394 .each_child_of_item(def_id.index, |child| result.push(child));
398 fn load_macro(&self, id: DefId, sess: &Session) -> LoadedMacro {
399 let data = self.get_crate_data(id.krate);
400 if let Some(ref proc_macros) = data.proc_macros {
401 return LoadedMacro::ProcMacro(proc_macros[id.index.as_usize() - 1].1.clone());
404 let (name, def) = data.get_macro(id.index);
405 let source_name = format!("<{} macros>", name);
407 let filemap = sess.parse_sess.codemap().new_filemap(source_name, def.body);
408 let local_span = Span { lo: filemap.start_pos, hi: filemap.end_pos, ctxt: NO_EXPANSION };
409 let body = filemap_to_stream(&sess.parse_sess, filemap);
411 // Mark the attrs as used
412 let attrs = data.get_item_attrs(id.index);
413 for attr in attrs.iter() {
414 attr::mark_used(attr);
417 let name = data.def_key(id.index).disambiguated_data.data
418 .get_opt_name().expect("no name in load_macro");
419 sess.imported_macro_spans.borrow_mut()
420 .insert(local_span, (name.to_string(), data.get_span(id.index, sess)));
422 LoadedMacro::MacroDef(ast::Item {
423 ident: ast::Ident::with_empty_ctxt(name),
424 id: ast::DUMMY_NODE_ID,
426 attrs: attrs.iter().cloned().collect(),
427 node: ast::ItemKind::MacroDef(body.into()),
428 vis: ast::Visibility::Inherited,
432 fn item_body<'a, 'tcx>(&self,
433 tcx: TyCtxt<'a, 'tcx, 'tcx>,
436 if let Some(cached) = tcx.hir.get_inlined_body(def_id) {
440 self.dep_graph.read(DepNode::MetaData(def_id));
441 debug!("item_body({}): inlining item", tcx.item_path_str(def_id));
443 self.get_crate_data(def_id.krate).item_body(tcx, def_id.index)
446 fn is_item_mir_available(&self, def: DefId) -> bool {
447 self.dep_graph.read(DepNode::MetaData(def));
448 self.get_crate_data(def.krate).is_item_mir_available(def.index)
451 fn crates(&self) -> Vec<CrateNum>
453 let mut result = vec![];
454 self.iter_crate_data(|cnum, _| result.push(cnum));
458 fn used_libraries(&self) -> Vec<NativeLibrary>
460 self.get_used_libraries().borrow().clone()
463 fn used_link_args(&self) -> Vec<String>
465 self.get_used_link_args().borrow().clone()
468 fn metadata_filename(&self) -> &str
470 locator::METADATA_FILENAME
473 fn metadata_section_name(&self, target: &Target) -> &str
475 locator::meta_section_name(target)
478 fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
480 self.do_get_used_crates(prefer)
483 fn used_crate_source(&self, cnum: CrateNum) -> CrateSource
485 self.get_crate_data(cnum).source.clone()
488 fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>
490 self.do_extern_mod_stmt_cnum(emod_id)
493 fn encode_metadata<'a, 'tcx>(&self,
494 tcx: TyCtxt<'a, 'tcx, 'tcx>,
495 link_meta: &LinkMeta,
499 encoder::encode_metadata(tcx, self, link_meta, reachable)
502 fn metadata_encoding_version(&self) -> &[u8]
504 schema::METADATA_HEADER
507 /// Returns a map from a sufficiently visible external item (i.e. an external item that is
508 /// visible from at least one local module) to a sufficiently visible parent (considering
509 /// modules that re-export the external item to be parents).
510 fn visible_parent_map<'a>(&'a self) -> ::std::cell::Ref<'a, DefIdMap<DefId>> {
512 let visible_parent_map = self.visible_parent_map.borrow();
513 if !visible_parent_map.is_empty() {
514 return visible_parent_map;
518 use std::collections::vec_deque::VecDeque;
519 use std::collections::hash_map::Entry;
521 let mut visible_parent_map = self.visible_parent_map.borrow_mut();
523 for cnum in (1 .. self.next_crate_num().as_usize()).map(CrateNum::new) {
524 let cdata = self.get_crate_data(cnum);
526 match cdata.extern_crate.get() {
527 // Ignore crates without a corresponding local `extern crate` item.
528 Some(extern_crate) if !extern_crate.direct => continue,
532 let mut bfs_queue = &mut VecDeque::new();
533 let mut add_child = |bfs_queue: &mut VecDeque<_>, child: def::Export, parent: DefId| {
534 let child = child.def.def_id();
536 if self.visibility(child) != ty::Visibility::Public {
540 match visible_parent_map.entry(child) {
541 Entry::Occupied(mut entry) => {
542 // If `child` is defined in crate `cnum`, ensure
543 // that it is mapped to a parent in `cnum`.
544 if child.krate == cnum && entry.get().krate != cnum {
545 entry.insert(parent);
548 Entry::Vacant(entry) => {
549 entry.insert(parent);
550 bfs_queue.push_back(child);
555 bfs_queue.push_back(DefId {
557 index: CRATE_DEF_INDEX
559 while let Some(def) = bfs_queue.pop_front() {
560 for child in self.item_children(def) {
561 add_child(bfs_queue, child, def);
566 drop(visible_parent_map);
567 self.visible_parent_map.borrow()