]> git.lizzy.rs Git - rust.git/blob - src/librustc_metadata/cstore_impl.rs
2965e545eca4e1421590fa7dba4f9fdfb63d03e0
[rust.git] / src / librustc_metadata / cstore_impl.rs
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.
4 //
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.
10
11 use cstore;
12 use encoder;
13 use locator;
14 use schema;
15
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};
23
24 use rustc::dep_graph::DepNode;
25 use rustc::hir::map as hir_map;
26 use rustc::hir::map::DefKey;
27 use rustc::mir::Mir;
28 use rustc::util::nodemap::{NodeSet, DefIdMap};
29 use rustc_back::PanicStrategy;
30
31 use syntax::ast;
32 use syntax::attr;
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;
38 use rustc::hir;
39
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)
44     }
45
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)
49     }
50
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)
54     }
55
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)
59     }
60
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)
64     }
65
66     fn closure_kind(&self, def_id: DefId) -> ty::ClosureKind
67     {
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)
71     }
72
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)
77     }
78
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)
82     }
83
84     fn item_type<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
85                      -> Ty<'tcx>
86     {
87         self.dep_graph.read(DepNode::MetaData(def));
88         self.get_crate_data(def.krate).get_type(def.index, tcx)
89     }
90
91     fn item_predicates<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
92                            -> ty::GenericPredicates<'tcx>
93     {
94         self.dep_graph.read(DepNode::MetaData(def));
95         self.get_crate_data(def.krate).get_predicates(def.index, tcx)
96     }
97
98     fn item_super_predicates<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
99                                  -> ty::GenericPredicates<'tcx>
100     {
101         self.dep_graph.read(DepNode::MetaData(def));
102         self.get_crate_data(def.krate).get_super_predicates(def.index, tcx)
103     }
104
105     fn item_generics<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
106                          -> ty::Generics<'tcx>
107     {
108         self.dep_graph.read(DepNode::MetaData(def));
109         self.get_crate_data(def.krate).get_generics(def.index, tcx)
110     }
111
112     fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute>
113     {
114         self.dep_graph.read(DepNode::MetaData(def_id));
115         self.get_crate_data(def_id.krate).get_item_attrs(def_id.index)
116     }
117
118     fn trait_def<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> ty::TraitDef
119     {
120         self.dep_graph.read(DepNode::MetaData(def));
121         self.get_crate_data(def.krate).get_trait_def(def.index, tcx)
122     }
123
124     fn adt_def<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> &'tcx ty::AdtDef
125     {
126         self.dep_graph.read(DepNode::MetaData(def));
127         self.get_crate_data(def.krate).get_adt_def(def.index, tcx)
128     }
129
130     fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name>
131     {
132         self.dep_graph.read(DepNode::MetaData(did));
133         self.get_crate_data(did.krate).get_fn_arg_names(did.index)
134     }
135
136     fn inherent_implementations_for_type(&self, def_id: DefId) -> Vec<DefId>
137     {
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)
140     }
141
142     fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>
143     {
144         if let Some(def_id) = filter {
145             self.dep_graph.read(DepNode::MetaData(def_id));
146         }
147         let mut result = vec![];
148         self.iter_crate_data(|_, cdata| {
149             cdata.get_implementations_for_trait(filter, &mut result)
150         });
151         result
152     }
153
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()));
159         result
160     }
161
162     fn impl_polarity(&self, def: DefId) -> hir::ImplPolarity
163     {
164         self.dep_graph.read(DepNode::MetaData(def));
165         self.get_crate_data(def.krate).get_impl_polarity(def.index)
166     }
167
168     fn impl_trait_ref<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
169                           -> Option<ty::TraitRef<'tcx>>
170     {
171         self.dep_graph.read(DepNode::MetaData(def));
172         self.get_crate_data(def.krate).get_impl_trait(def.index, tcx)
173     }
174
175     fn custom_coerce_unsized_kind(&self, def: DefId)
176                                   -> Option<ty::adjustment::CustomCoerceUnsized>
177     {
178         self.dep_graph.read(DepNode::MetaData(def));
179         self.get_crate_data(def.krate).get_custom_coerce_unsized_kind(def.index)
180     }
181
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)
185     }
186
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)
190     }
191
192     fn associated_item<'a>(&self, _tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
193                            -> Option<ty::AssociatedItem>
194     {
195         self.dep_graph.read(DepNode::MetaData(def));
196         self.get_crate_data(def.krate).get_associated_item(def.index)
197     }
198
199     fn is_const_fn(&self, did: DefId) -> bool
200     {
201         self.dep_graph.read(DepNode::MetaData(did));
202         self.get_crate_data(did.krate).is_const_fn(did.index)
203     }
204
205     fn is_defaulted_trait(&self, trait_def_id: DefId) -> bool
206     {
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)
209     }
210
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)
214     }
215
216     fn is_foreign_item(&self, did: DefId) -> bool {
217         self.get_crate_data(did.krate).is_foreign_item(did.index)
218     }
219
220     fn is_statically_included_foreign_item(&self, id: ast::NodeId) -> bool
221     {
222         self.do_is_statically_included_foreign_item(id)
223     }
224
225     fn dylib_dependency_formats(&self, cnum: CrateNum)
226                                 -> Vec<(CrateNum, LinkagePreference)>
227     {
228         self.get_crate_data(cnum).get_dylib_dependency_formats()
229     }
230
231     fn dep_kind(&self, cnum: CrateNum) -> DepKind
232     {
233         self.get_crate_data(cnum).dep_kind.get()
234     }
235
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)
239         }
240     }
241
242     fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
243     {
244         self.get_crate_data(cnum).get_lang_items()
245     }
246
247     fn missing_lang_items(&self, cnum: CrateNum)
248                           -> Vec<lang_items::LangItem>
249     {
250         self.get_crate_data(cnum).get_missing_lang_items()
251     }
252
253     fn is_staged_api(&self, cnum: CrateNum) -> bool
254     {
255         self.get_crate_data(cnum).is_staged_api()
256     }
257
258     fn is_allocator(&self, cnum: CrateNum) -> bool
259     {
260         self.get_crate_data(cnum).is_allocator()
261     }
262
263     fn is_panic_runtime(&self, cnum: CrateNum) -> bool
264     {
265         self.get_crate_data(cnum).is_panic_runtime()
266     }
267
268     fn is_compiler_builtins(&self, cnum: CrateNum) -> bool {
269         self.get_crate_data(cnum).is_compiler_builtins()
270     }
271
272     fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
273         self.get_crate_data(cnum).panic_strategy()
274     }
275
276     fn crate_name(&self, cnum: CrateNum) -> Symbol
277     {
278         self.get_crate_data(cnum).name
279     }
280
281     fn original_crate_name(&self, cnum: CrateNum) -> Symbol
282     {
283         self.get_crate_data(cnum).name()
284     }
285
286     fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate>
287     {
288         self.get_crate_data(cnum).extern_crate.get()
289     }
290
291     fn crate_hash(&self, cnum: CrateNum) -> Svh
292     {
293         self.get_crate_hash(cnum)
294     }
295
296     fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol
297     {
298         self.get_crate_data(cnum).disambiguator()
299     }
300
301     fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
302     {
303         self.get_crate_data(cnum).root.plugin_registrar_fn.map(|index| DefId {
304             krate: cnum,
305             index: index
306         })
307     }
308
309     fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
310     {
311         self.get_crate_data(cnum).get_native_libraries()
312     }
313
314     fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>
315     {
316         self.get_crate_data(cnum).get_exported_symbols()
317     }
318
319     fn is_no_builtins(&self, cnum: CrateNum) -> bool {
320         self.get_crate_data(cnum).is_no_builtins()
321     }
322
323     fn def_index_for_def_key(&self,
324                              cnum: CrateNum,
325                              def: DefKey)
326                              -> Option<DefIndex> {
327         let cdata = self.get_crate_data(cnum);
328         cdata.key_map.get(&def).cloned()
329     }
330
331     /// Returns the `DefKey` for a given `DefId`. This indicates the
332     /// parent `DefId` as well as some idea of what kind of data the
333     /// `DefId` refers to.
334     fn def_key(&self, def: DefId) -> hir_map::DefKey {
335         // Note: loading the def-key (or def-path) for a def-id is not
336         // a *read* of its metadata. This is because the def-id is
337         // really just an interned shorthand for a def-path, which is the
338         // canonical name for an item.
339         //
340         // self.dep_graph.read(DepNode::MetaData(def));
341         self.get_crate_data(def.krate).def_key(def.index)
342     }
343
344     fn relative_def_path(&self, def: DefId) -> Option<hir_map::DefPath> {
345         // See `Note` above in `def_key()` for why this read is
346         // commented out:
347         //
348         // self.dep_graph.read(DepNode::MetaData(def));
349         self.get_crate_data(def.krate).def_path(def.index)
350     }
351
352     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>
353     {
354         self.dep_graph.read(DepNode::MetaData(def));
355         self.get_crate_data(def.krate).get_struct_field_names(def.index)
356     }
357
358     fn item_children(&self, def_id: DefId) -> Vec<def::Export>
359     {
360         self.dep_graph.read(DepNode::MetaData(def_id));
361         let mut result = vec![];
362         self.get_crate_data(def_id.krate)
363             .each_child_of_item(def_id.index, |child| result.push(child));
364         result
365     }
366
367     fn load_macro(&self, id: DefId, sess: &Session) -> LoadedMacro {
368         let data = self.get_crate_data(id.krate);
369         if let Some(ref proc_macros) = data.proc_macros {
370             return LoadedMacro::ProcMacro(proc_macros[id.index.as_usize() - 1].1.clone());
371         }
372
373         let (name, def) = data.get_macro(id.index);
374         let source_name = format!("<{} macros>", name);
375
376         // NB: Don't use parse_tts_from_source_str because it parses with quote_depth > 0.
377         let mut parser = new_parser_from_source_str(&sess.parse_sess, source_name, def.body);
378
379         let lo = parser.span.lo;
380         let body = match parser.parse_all_token_trees() {
381             Ok(body) => body,
382             Err(mut err) => {
383                 err.emit();
384                 sess.abort_if_errors();
385                 unreachable!();
386             }
387         };
388         let local_span = mk_sp(lo, parser.prev_span.hi);
389
390         // Mark the attrs as used
391         let attrs = data.get_item_attrs(id.index);
392         for attr in &attrs {
393             attr::mark_used(attr);
394         }
395
396         let name = data.def_key(id.index).disambiguated_data.data
397             .get_opt_name().expect("no name in load_macro");
398         sess.imported_macro_spans.borrow_mut()
399             .insert(local_span, (name.to_string(), data.get_span(id.index, sess)));
400
401         LoadedMacro::MacroRules(ast::MacroDef {
402             ident: ast::Ident::with_empty_ctxt(name),
403             id: ast::DUMMY_NODE_ID,
404             span: local_span,
405             imported_from: None, // FIXME
406             allow_internal_unstable: attr::contains_name(&attrs, "allow_internal_unstable"),
407             attrs: attrs,
408             body: body,
409         })
410     }
411
412     fn maybe_get_item_ast<'a>(&'tcx self,
413                               tcx: TyCtxt<'a, 'tcx, 'tcx>,
414                               def_id: DefId)
415                               -> Option<(&'tcx InlinedItem, ast::NodeId)>
416     {
417         self.dep_graph.read(DepNode::MetaData(def_id));
418
419         match self.inlined_item_cache.borrow().get(&def_id) {
420             Some(&None) => {
421                 return None; // Not inlinable
422             }
423             Some(&Some(ref cached_inlined_item)) => {
424                 // Already inline
425                 debug!("maybe_get_item_ast({}): already inline as node id {}",
426                           tcx.item_path_str(def_id), cached_inlined_item.item_id);
427                 return Some((tcx.map.expect_inlined_item(cached_inlined_item.inlined_root),
428                              cached_inlined_item.item_id));
429             }
430             None => {
431                 // Not seen yet
432             }
433         }
434
435         debug!("maybe_get_item_ast({}): inlining item", tcx.item_path_str(def_id));
436
437         let inlined = self.get_crate_data(def_id.krate).maybe_get_item_ast(tcx, def_id.index);
438
439         let cache_inlined_item = |original_def_id, inlined_item_id, inlined_root_node_id| {
440             let cache_entry = cstore::CachedInlinedItem {
441                 inlined_root: inlined_root_node_id,
442                 item_id: inlined_item_id,
443             };
444             self.inlined_item_cache
445                 .borrow_mut()
446                 .insert(original_def_id, Some(cache_entry));
447             self.defid_for_inlined_node
448                 .borrow_mut()
449                 .insert(inlined_item_id, original_def_id);
450         };
451
452         let find_inlined_item_root = |inlined_item_id| {
453             let mut node = inlined_item_id;
454
455             // If we can't find the inline root after a thousand hops, we can
456             // be pretty sure there's something wrong with the HIR map.
457             for _ in 0 .. 1000 {
458                 let parent_node = tcx.map.get_parent_node(node);
459                 if parent_node == node {
460                     return node;
461                 }
462                 node = parent_node;
463             }
464             bug!("cycle in HIR map parent chain")
465         };
466
467         match inlined {
468             None => {
469                 self.inlined_item_cache
470                     .borrow_mut()
471                     .insert(def_id, None);
472             }
473             Some(&InlinedItem { ref body, .. }) => {
474                 let inlined_root_node_id = find_inlined_item_root(body.id);
475                 cache_inlined_item(def_id, inlined_root_node_id, inlined_root_node_id);
476             }
477         }
478
479         // We can be sure to hit the cache now
480         return self.maybe_get_item_ast(tcx, def_id);
481     }
482
483     fn local_node_for_inlined_defid(&'tcx self, def_id: DefId) -> Option<ast::NodeId> {
484         assert!(!def_id.is_local());
485         match self.inlined_item_cache.borrow().get(&def_id) {
486             Some(&Some(ref cached_inlined_item)) => {
487                 Some(cached_inlined_item.item_id)
488             }
489             Some(&None) => {
490                 None
491             }
492             _ => {
493                 bug!("Trying to lookup inlined NodeId for unexpected item");
494             }
495         }
496     }
497
498     fn defid_for_inlined_node(&'tcx self, node_id: ast::NodeId) -> Option<DefId> {
499         self.defid_for_inlined_node.borrow().get(&node_id).map(|x| *x)
500     }
501
502     fn get_item_mir<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> Mir<'tcx> {
503         self.dep_graph.read(DepNode::MetaData(def));
504         self.get_crate_data(def.krate).maybe_get_item_mir(tcx, def.index).unwrap_or_else(|| {
505             bug!("get_item_mir: missing MIR for {}", tcx.item_path_str(def))
506         })
507     }
508
509     fn is_item_mir_available(&self, def: DefId) -> bool {
510         self.dep_graph.read(DepNode::MetaData(def));
511         self.get_crate_data(def.krate).is_item_mir_available(def.index)
512     }
513
514     fn crates(&self) -> Vec<CrateNum>
515     {
516         let mut result = vec![];
517         self.iter_crate_data(|cnum, _| result.push(cnum));
518         result
519     }
520
521     fn used_libraries(&self) -> Vec<NativeLibrary>
522     {
523         self.get_used_libraries().borrow().clone()
524     }
525
526     fn used_link_args(&self) -> Vec<String>
527     {
528         self.get_used_link_args().borrow().clone()
529     }
530
531     fn metadata_filename(&self) -> &str
532     {
533         locator::METADATA_FILENAME
534     }
535
536     fn metadata_section_name(&self, target: &Target) -> &str
537     {
538         locator::meta_section_name(target)
539     }
540
541     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
542     {
543         self.do_get_used_crates(prefer)
544     }
545
546     fn used_crate_source(&self, cnum: CrateNum) -> CrateSource
547     {
548         self.get_crate_data(cnum).source.clone()
549     }
550
551     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>
552     {
553         self.do_extern_mod_stmt_cnum(emod_id)
554     }
555
556     fn encode_metadata<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>,
557                            reexports: &def::ExportMap,
558                            link_meta: &LinkMeta,
559                            reachable: &NodeSet) -> Vec<u8>
560     {
561         encoder::encode_metadata(tcx, self, reexports, link_meta, reachable)
562     }
563
564     fn metadata_encoding_version(&self) -> &[u8]
565     {
566         schema::METADATA_HEADER
567     }
568
569     /// Returns a map from a sufficiently visible external item (i.e. an external item that is
570     /// visible from at least one local module) to a sufficiently visible parent (considering
571     /// modules that re-export the external item to be parents).
572     fn visible_parent_map<'a>(&'a self) -> ::std::cell::RefMut<'a, DefIdMap<DefId>> {
573         let mut visible_parent_map = self.visible_parent_map.borrow_mut();
574         if !visible_parent_map.is_empty() { return visible_parent_map; }
575
576         use std::collections::vec_deque::VecDeque;
577         use std::collections::hash_map::Entry;
578         for cnum in (1 .. self.next_crate_num().as_usize()).map(CrateNum::new) {
579             let cdata = self.get_crate_data(cnum);
580
581             match cdata.extern_crate.get() {
582                 // Ignore crates without a corresponding local `extern crate` item.
583                 Some(extern_crate) if !extern_crate.direct => continue,
584                 _ => {},
585             }
586
587             let mut bfs_queue = &mut VecDeque::new();
588             let mut add_child = |bfs_queue: &mut VecDeque<_>, child: def::Export, parent: DefId| {
589                 let child = child.def.def_id();
590
591                 if self.visibility(child) != ty::Visibility::Public {
592                     return;
593                 }
594
595                 match visible_parent_map.entry(child) {
596                     Entry::Occupied(mut entry) => {
597                         // If `child` is defined in crate `cnum`, ensure
598                         // that it is mapped to a parent in `cnum`.
599                         if child.krate == cnum && entry.get().krate != cnum {
600                             entry.insert(parent);
601                         }
602                     }
603                     Entry::Vacant(entry) => {
604                         entry.insert(parent);
605                         bfs_queue.push_back(child);
606                     }
607                 }
608             };
609
610             bfs_queue.push_back(DefId {
611                 krate: cnum,
612                 index: CRATE_DEF_INDEX
613             });
614             while let Some(def) = bfs_queue.pop_front() {
615                 for child in self.item_children(def) {
616                     add_child(bfs_queue, child, def);
617                 }
618             }
619         }
620
621         visible_parent_map
622     }
623 }