1 // Copyright 2012-2014 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.
11 // Decoding metadata from a single crate's metadata
13 use cstore::{self, CrateMetadata, MetadataBlob, NativeLibrary};
16 use rustc::dep_graph::{DepGraph, DepNode, DepKind};
17 use rustc::hir::map::{DefKey, DefPath, DefPathData, DefPathHash};
18 use rustc::hir::map::definitions::GlobalMetaDataKind;
21 use rustc::middle::cstore::LinkagePreference;
22 use rustc::hir::def::{self, Def, CtorKind};
23 use rustc::hir::def_id::{CrateNum, DefId, DefIndex, CRATE_DEF_INDEX, LOCAL_CRATE};
24 use rustc::middle::lang_items;
25 use rustc::session::Session;
26 use rustc::ty::{self, Ty, TyCtxt};
27 use rustc::ty::subst::Substs;
33 use std::collections::BTreeMap;
40 use rustc_serialize::{Decodable, Decoder, SpecializedDecoder, opaque};
42 use syntax::ast::{self, Ident};
44 use syntax::symbol::{InternedString, Symbol};
45 use syntax::ext::base::MacroKind;
46 use syntax_pos::{self, Span, BytePos, Pos, DUMMY_SP, NO_EXPANSION};
48 pub struct DecodeContext<'a, 'tcx: 'a> {
49 opaque: opaque::Decoder<'a>,
50 cdata: Option<&'a CrateMetadata>,
51 sess: Option<&'a Session>,
52 tcx: Option<TyCtxt<'a, 'tcx, 'tcx>>,
54 // Cache the last used filemap for translating spans as an optimization.
55 last_filemap_index: usize,
57 lazy_state: LazyState,
60 /// Abstract over the various ways one can create metadata decoders.
61 pub trait Metadata<'a, 'tcx>: Copy {
62 fn raw_bytes(self) -> &'a [u8];
63 fn cdata(self) -> Option<&'a CrateMetadata> { None }
64 fn sess(self) -> Option<&'a Session> { None }
65 fn tcx(self) -> Option<TyCtxt<'a, 'tcx, 'tcx>> { None }
67 fn decoder(self, pos: usize) -> DecodeContext<'a, 'tcx> {
70 opaque: opaque::Decoder::new(self.raw_bytes(), pos),
72 sess: self.sess().or(tcx.map(|tcx| tcx.sess)),
74 last_filemap_index: 0,
75 lazy_state: LazyState::NoNode,
80 impl<'a, 'tcx> Metadata<'a, 'tcx> for &'a MetadataBlob {
81 fn raw_bytes(self) -> &'a [u8] {
86 impl<'a, 'tcx> Metadata<'a, 'tcx> for &'a CrateMetadata {
87 fn raw_bytes(self) -> &'a [u8] {
90 fn cdata(self) -> Option<&'a CrateMetadata> {
95 impl<'a, 'tcx> Metadata<'a, 'tcx> for (&'a CrateMetadata, &'a Session) {
96 fn raw_bytes(self) -> &'a [u8] {
99 fn cdata(self) -> Option<&'a CrateMetadata> {
102 fn sess(self) -> Option<&'a Session> {
107 impl<'a, 'tcx> Metadata<'a, 'tcx> for (&'a CrateMetadata, TyCtxt<'a, 'tcx, 'tcx>) {
108 fn raw_bytes(self) -> &'a [u8] {
111 fn cdata(self) -> Option<&'a CrateMetadata> {
114 fn tcx(self) -> Option<TyCtxt<'a, 'tcx, 'tcx>> {
119 impl<'a, 'tcx: 'a, T: Decodable> Lazy<T> {
120 pub fn decode<M: Metadata<'a, 'tcx>>(self, meta: M) -> T {
121 let mut dcx = meta.decoder(self.position);
122 dcx.lazy_state = LazyState::NodeStart(self.position);
123 T::decode(&mut dcx).unwrap()
127 impl<'a, 'tcx: 'a, T: Decodable> LazySeq<T> {
128 pub fn decode<M: Metadata<'a, 'tcx>>(self, meta: M) -> impl Iterator<Item = T> + 'a {
129 let mut dcx = meta.decoder(self.position);
130 dcx.lazy_state = LazyState::NodeStart(self.position);
131 (0..self.len).map(move |_| T::decode(&mut dcx).unwrap())
135 impl<'a, 'tcx> DecodeContext<'a, 'tcx> {
136 pub fn tcx(&self) -> TyCtxt<'a, 'tcx, 'tcx> {
137 self.tcx.expect("missing TyCtxt in DecodeContext")
140 pub fn cdata(&self) -> &'a CrateMetadata {
141 self.cdata.expect("missing CrateMetadata in DecodeContext")
144 fn with_position<F: FnOnce(&mut Self) -> R, R>(&mut self, pos: usize, f: F) -> R {
145 let new_opaque = opaque::Decoder::new(self.opaque.data, pos);
146 let old_opaque = mem::replace(&mut self.opaque, new_opaque);
147 let old_state = mem::replace(&mut self.lazy_state, LazyState::NoNode);
149 self.opaque = old_opaque;
150 self.lazy_state = old_state;
154 fn read_lazy_distance(&mut self, min_size: usize) -> Result<usize, <Self as Decoder>::Error> {
155 let distance = self.read_usize()?;
156 let position = match self.lazy_state {
157 LazyState::NoNode => bug!("read_lazy_distance: outside of a metadata node"),
158 LazyState::NodeStart(start) => {
159 assert!(distance + min_size <= start);
160 start - distance - min_size
162 LazyState::Previous(last_min_end) => last_min_end + distance,
164 self.lazy_state = LazyState::Previous(position + min_size);
169 macro_rules! decoder_methods {
170 ($($name:ident -> $ty:ty;)*) => {
171 $(fn $name(&mut self) -> Result<$ty, Self::Error> {
177 impl<'doc, 'tcx> Decoder for DecodeContext<'doc, 'tcx> {
178 type Error = <opaque::Decoder<'doc> as Decoder>::Error;
201 read_str -> Cow<str>;
204 fn error(&mut self, err: &str) -> Self::Error {
205 self.opaque.error(err)
209 impl<'a, 'tcx, T> SpecializedDecoder<Lazy<T>> for DecodeContext<'a, 'tcx> {
210 fn specialized_decode(&mut self) -> Result<Lazy<T>, Self::Error> {
211 Ok(Lazy::with_position(self.read_lazy_distance(Lazy::<T>::min_size())?))
215 impl<'a, 'tcx, T> SpecializedDecoder<LazySeq<T>> for DecodeContext<'a, 'tcx> {
216 fn specialized_decode(&mut self) -> Result<LazySeq<T>, Self::Error> {
217 let len = self.read_usize()?;
218 let position = if len == 0 {
221 self.read_lazy_distance(LazySeq::<T>::min_size(len))?
223 Ok(LazySeq::with_position_and_length(position, len))
227 impl<'a, 'tcx> SpecializedDecoder<CrateNum> for DecodeContext<'a, 'tcx> {
228 fn specialized_decode(&mut self) -> Result<CrateNum, Self::Error> {
229 let cnum = CrateNum::from_u32(u32::decode(self)?);
230 if cnum == LOCAL_CRATE {
231 Ok(self.cdata().cnum)
233 Ok(self.cdata().cnum_map.borrow()[cnum])
238 impl<'a, 'tcx> SpecializedDecoder<Span> for DecodeContext<'a, 'tcx> {
239 fn specialized_decode(&mut self) -> Result<Span, Self::Error> {
240 let lo = BytePos::decode(self)?;
241 let hi = BytePos::decode(self)?;
243 let sess = if let Some(sess) = self.sess {
246 return Ok(Span::new(lo, hi, NO_EXPANSION));
249 let (lo, hi) = if lo > hi {
250 // Currently macro expansion sometimes produces invalid Span values
251 // where lo > hi. In order not to crash the compiler when trying to
252 // translate these values, let's transform them into something we
253 // can handle (and which will produce useful debug locations at
254 // least some of the time).
255 // This workaround is only necessary as long as macro expansion is
256 // not fixed. FIXME(#23480)
262 let imported_filemaps = self.cdata().imported_filemaps(&sess.codemap());
264 // Optimize for the case that most spans within a translated item
265 // originate from the same filemap.
266 let last_filemap = &imported_filemaps[self.last_filemap_index];
268 if lo >= last_filemap.original_start_pos && lo <= last_filemap.original_end_pos &&
269 hi >= last_filemap.original_start_pos &&
270 hi <= last_filemap.original_end_pos {
274 let mut b = imported_filemaps.len();
278 if imported_filemaps[m].original_start_pos > lo {
285 self.last_filemap_index = a;
286 &imported_filemaps[a]
290 let lo = (lo - filemap.original_start_pos) + filemap.translated_filemap.start_pos;
291 let hi = (hi - filemap.original_start_pos) + filemap.translated_filemap.start_pos;
293 Ok(Span::new(lo, hi, NO_EXPANSION))
297 // FIXME(#36588) These impls are horribly unsound as they allow
298 // the caller to pick any lifetime for 'tcx, including 'static,
299 // by using the unspecialized proxies to them.
301 impl<'a, 'tcx> SpecializedDecoder<Ty<'tcx>> for DecodeContext<'a, 'tcx> {
302 fn specialized_decode(&mut self) -> Result<Ty<'tcx>, Self::Error> {
303 let tcx = self.tcx();
305 // Handle shorthands first, if we have an usize > 0x80.
306 if self.opaque.data[self.opaque.position()] & 0x80 != 0 {
307 let pos = self.read_usize()?;
308 assert!(pos >= SHORTHAND_OFFSET);
309 let key = ty::CReaderCacheKey {
310 cnum: self.cdata().cnum,
311 pos: pos - SHORTHAND_OFFSET,
313 if let Some(ty) = tcx.rcache.borrow().get(&key).cloned() {
317 let ty = self.with_position(key.pos, Ty::decode)?;
318 tcx.rcache.borrow_mut().insert(key, ty);
321 Ok(tcx.mk_ty(ty::TypeVariants::decode(self)?))
327 impl<'a, 'tcx> SpecializedDecoder<ty::GenericPredicates<'tcx>> for DecodeContext<'a, 'tcx> {
328 fn specialized_decode(&mut self) -> Result<ty::GenericPredicates<'tcx>, Self::Error> {
329 Ok(ty::GenericPredicates {
330 parent: Decodable::decode(self)?,
331 predicates: (0..self.read_usize()?).map(|_| {
332 // Handle shorthands first, if we have an usize > 0x80.
333 if self.opaque.data[self.opaque.position()] & 0x80 != 0 {
334 let pos = self.read_usize()?;
335 assert!(pos >= SHORTHAND_OFFSET);
336 let pos = pos - SHORTHAND_OFFSET;
338 self.with_position(pos, ty::Predicate::decode)
340 ty::Predicate::decode(self)
343 .collect::<Result<Vec<_>, _>>()?,
348 impl<'a, 'tcx> SpecializedDecoder<&'tcx Substs<'tcx>> for DecodeContext<'a, 'tcx> {
349 fn specialized_decode(&mut self) -> Result<&'tcx Substs<'tcx>, Self::Error> {
350 Ok(self.tcx().mk_substs((0..self.read_usize()?).map(|_| Decodable::decode(self)))?)
354 impl<'a, 'tcx> SpecializedDecoder<ty::Region<'tcx>> for DecodeContext<'a, 'tcx> {
355 fn specialized_decode(&mut self) -> Result<ty::Region<'tcx>, Self::Error> {
356 Ok(self.tcx().mk_region(Decodable::decode(self)?))
360 impl<'a, 'tcx> SpecializedDecoder<&'tcx ty::Slice<Ty<'tcx>>> for DecodeContext<'a, 'tcx> {
361 fn specialized_decode(&mut self) -> Result<&'tcx ty::Slice<Ty<'tcx>>, Self::Error> {
362 Ok(self.tcx().mk_type_list((0..self.read_usize()?).map(|_| Decodable::decode(self)))?)
366 impl<'a, 'tcx> SpecializedDecoder<&'tcx ty::AdtDef> for DecodeContext<'a, 'tcx> {
367 fn specialized_decode(&mut self) -> Result<&'tcx ty::AdtDef, Self::Error> {
368 let def_id = DefId::decode(self)?;
369 Ok(self.tcx().adt_def(def_id))
373 impl<'a, 'tcx> SpecializedDecoder<&'tcx ty::Slice<ty::ExistentialPredicate<'tcx>>>
374 for DecodeContext<'a, 'tcx> {
375 fn specialized_decode(&mut self)
376 -> Result<&'tcx ty::Slice<ty::ExistentialPredicate<'tcx>>, Self::Error> {
377 Ok(self.tcx().mk_existential_predicates((0..self.read_usize()?)
378 .map(|_| Decodable::decode(self)))?)
382 impl<'a, 'tcx> MetadataBlob {
383 pub fn is_compatible(&self) -> bool {
384 self.raw_bytes().starts_with(METADATA_HEADER)
387 pub fn get_rustc_version(&self) -> String {
388 Lazy::with_position(METADATA_HEADER.len() + 4).decode(self)
391 pub fn get_root(&self) -> CrateRoot {
392 let slice = self.raw_bytes();
393 let offset = METADATA_HEADER.len();
394 let pos = (((slice[offset + 0] as u32) << 24) | ((slice[offset + 1] as u32) << 16) |
395 ((slice[offset + 2] as u32) << 8) |
396 ((slice[offset + 3] as u32) << 0)) as usize;
397 Lazy::with_position(pos).decode(self)
400 pub fn list_crate_metadata(&self,
401 out: &mut io::Write) -> io::Result<()> {
402 write!(out, "=External Dependencies=\n")?;
403 let root = self.get_root();
404 for (i, dep) in root.crate_deps
408 write!(out, "{} {}-{}\n", i + 1, dep.name, dep.hash)?;
415 impl<'tcx> EntryKind<'tcx> {
416 fn to_def(&self, did: DefId) -> Option<Def> {
418 EntryKind::Const(_) => Def::Const(did),
419 EntryKind::AssociatedConst(..) => Def::AssociatedConst(did),
420 EntryKind::ImmStatic |
421 EntryKind::ForeignImmStatic => Def::Static(did, false),
422 EntryKind::MutStatic |
423 EntryKind::ForeignMutStatic => Def::Static(did, true),
424 EntryKind::Struct(_, _) => Def::Struct(did),
425 EntryKind::Union(_, _) => Def::Union(did),
427 EntryKind::ForeignFn(_) => Def::Fn(did),
428 EntryKind::Method(_) => Def::Method(did),
429 EntryKind::Type => Def::TyAlias(did),
430 EntryKind::AssociatedType(_) => Def::AssociatedTy(did),
431 EntryKind::Mod(_) => Def::Mod(did),
432 EntryKind::Variant(_) => Def::Variant(did),
433 EntryKind::Trait(_) => Def::Trait(did),
434 EntryKind::Enum(..) => Def::Enum(did),
435 EntryKind::MacroDef(_) => Def::Macro(did, MacroKind::Bang),
436 EntryKind::GlobalAsm => Def::GlobalAsm(did),
438 EntryKind::ForeignMod |
440 EntryKind::DefaultImpl(_) |
442 EntryKind::Generator(_) |
443 EntryKind::Closure(_) => return None,
448 impl<'a, 'tcx> CrateMetadata {
449 fn is_proc_macro(&self, id: DefIndex) -> bool {
450 self.proc_macros.is_some() && id != CRATE_DEF_INDEX
453 fn maybe_entry(&self, item_id: DefIndex) -> Option<Lazy<Entry<'tcx>>> {
454 assert!(!self.is_proc_macro(item_id));
455 self.root.index.lookup(self.blob.raw_bytes(), item_id)
458 fn entry(&self, item_id: DefIndex) -> Entry<'tcx> {
459 match self.maybe_entry(item_id) {
461 bug!("entry: id not found: {:?} in crate {:?} with number {}",
466 Some(d) => d.decode(self),
470 fn local_def_id(&self, index: DefIndex) -> DefId {
477 pub fn item_name(&self, item_index: DefIndex) -> InternedString {
478 self.def_key(item_index)
482 .expect("no name in item_name")
485 pub fn get_def(&self, index: DefIndex) -> Option<Def> {
486 if !self.is_proc_macro(index) {
487 self.entry(index).kind.to_def(self.local_def_id(index))
489 let kind = self.proc_macros.as_ref().unwrap()[index.as_usize() - 1].1.kind();
490 Some(Def::Macro(self.local_def_id(index), kind))
494 pub fn get_span(&self, index: DefIndex, sess: &Session) -> Span {
495 match self.is_proc_macro(index) {
497 false => self.entry(index).span.decode((self, sess)),
501 pub fn get_trait_def(&self, item_id: DefIndex) -> ty::TraitDef {
502 let data = match self.entry(item_id).kind {
503 EntryKind::Trait(data) => data.decode(self),
507 ty::TraitDef::new(self.local_def_id(item_id),
510 data.has_default_impl,
511 self.def_path_table.def_path_hash(item_id))
514 fn get_variant(&self, item: &Entry, index: DefIndex) -> ty::VariantDef {
515 let data = match item.kind {
516 EntryKind::Variant(data) |
517 EntryKind::Struct(data, _) |
518 EntryKind::Union(data, _) => data.decode(self),
523 did: self.local_def_id(data.struct_ctor.unwrap_or(index)),
524 name: Symbol::intern(&self.item_name(index)),
525 fields: item.children.decode(self).map(|index| {
526 let f = self.entry(index);
528 did: self.local_def_id(index),
529 name: Symbol::intern(&self.item_name(index)),
530 vis: f.visibility.decode(self)
534 ctor_kind: data.ctor_kind,
538 pub fn get_adt_def(&self,
540 tcx: TyCtxt<'a, 'tcx, 'tcx>)
541 -> &'tcx ty::AdtDef {
542 let item = self.entry(item_id);
543 let did = self.local_def_id(item_id);
544 let kind = match item.kind {
545 EntryKind::Enum(_) => ty::AdtKind::Enum,
546 EntryKind::Struct(_, _) => ty::AdtKind::Struct,
547 EntryKind::Union(_, _) => ty::AdtKind::Union,
548 _ => bug!("get_adt_def called on a non-ADT {:?}", did),
550 let variants = if let ty::AdtKind::Enum = kind {
554 self.get_variant(&self.entry(index), index)
558 vec![self.get_variant(&item, item_id)]
560 let (kind, repr) = match item.kind {
561 EntryKind::Enum(repr) => (ty::AdtKind::Enum, repr),
562 EntryKind::Struct(_, repr) => (ty::AdtKind::Struct, repr),
563 EntryKind::Union(_, repr) => (ty::AdtKind::Union, repr),
564 _ => bug!("get_adt_def called on a non-ADT {:?}", did),
567 tcx.alloc_adt_def(did, kind, variants, repr)
570 pub fn get_predicates(&self,
572 tcx: TyCtxt<'a, 'tcx, 'tcx>)
573 -> ty::GenericPredicates<'tcx> {
574 self.entry(item_id).predicates.unwrap().decode((self, tcx))
577 pub fn get_super_predicates(&self,
579 tcx: TyCtxt<'a, 'tcx, 'tcx>)
580 -> ty::GenericPredicates<'tcx> {
581 match self.entry(item_id).kind {
582 EntryKind::Trait(data) => data.decode(self).super_predicates.decode((self, tcx)),
587 pub fn get_generics(&self, item_id: DefIndex) -> ty::Generics {
588 self.entry(item_id).generics.unwrap().decode(self)
591 pub fn get_type(&self, id: DefIndex, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Ty<'tcx> {
592 self.entry(id).ty.unwrap().decode((self, tcx))
595 pub fn get_stability(&self, id: DefIndex) -> Option<attr::Stability> {
596 match self.is_proc_macro(id) {
598 false => self.entry(id).stability.map(|stab| stab.decode(self)),
602 pub fn get_deprecation(&self, id: DefIndex) -> Option<attr::Deprecation> {
603 match self.is_proc_macro(id) {
605 false => self.entry(id).deprecation.map(|depr| depr.decode(self)),
609 pub fn get_visibility(&self, id: DefIndex) -> ty::Visibility {
610 match self.is_proc_macro(id) {
611 true => ty::Visibility::Public,
612 false => self.entry(id).visibility.decode(self),
616 fn get_impl_data(&self, id: DefIndex) -> ImplData<'tcx> {
617 match self.entry(id).kind {
618 EntryKind::Impl(data) => data.decode(self),
623 pub fn get_parent_impl(&self, id: DefIndex) -> Option<DefId> {
624 self.get_impl_data(id).parent_impl
627 pub fn get_impl_polarity(&self, id: DefIndex) -> hir::ImplPolarity {
628 self.get_impl_data(id).polarity
631 pub fn get_impl_defaultness(&self, id: DefIndex) -> hir::Defaultness {
632 self.get_impl_data(id).defaultness
635 pub fn get_coerce_unsized_info(&self,
637 -> Option<ty::adjustment::CoerceUnsizedInfo> {
638 self.get_impl_data(id).coerce_unsized_info
641 pub fn get_impl_trait(&self,
643 tcx: TyCtxt<'a, 'tcx, 'tcx>)
644 -> Option<ty::TraitRef<'tcx>> {
645 self.get_impl_data(id).trait_ref.map(|tr| tr.decode((self, tcx)))
648 /// Iterates over the language items in the given crate.
649 pub fn get_lang_items(&self, dep_graph: &DepGraph) -> Vec<(DefIndex, usize)> {
650 let dep_node = self.metadata_dep_node(GlobalMetaDataKind::LangItems);
653 .get(dep_graph, dep_node)
658 /// Iterates over each child of the given item.
659 pub fn each_child_of_item<F>(&self, id: DefIndex, mut callback: F, sess: &Session)
660 where F: FnMut(def::Export)
662 if let Some(ref proc_macros) = self.proc_macros {
663 if id == CRATE_DEF_INDEX {
664 for (id, &(name, ref ext)) in proc_macros.iter().enumerate() {
665 let def = Def::Macro(
668 index: DefIndex::new(id + 1)
672 let ident = Ident::with_empty_ctxt(name);
673 callback(def::Export { ident: ident, def: def, span: DUMMY_SP });
680 let item = match self.maybe_entry(id) {
682 Some(item) => item.decode((self, sess)),
685 // Iterate over all children.
686 let macros_only = self.dep_kind.get().macros_only();
687 for child_index in item.children.decode((self, sess)) {
693 if let Some(child) = self.maybe_entry(child_index) {
694 let child = child.decode((self, sess));
696 EntryKind::MacroDef(..) => {}
697 _ if macros_only => continue,
701 // Hand off the item to the callback.
703 // FIXME(eddyb) Don't encode these in children.
704 EntryKind::ForeignMod => {
705 for child_index in child.children.decode((self, sess)) {
706 if let Some(def) = self.get_def(child_index) {
707 callback(def::Export {
709 ident: Ident::from_str(&self.item_name(child_index)),
710 span: self.entry(child_index).span.decode((self, sess)),
717 EntryKind::DefaultImpl(_) => continue,
722 let def_key = self.def_key(child_index);
723 let span = child.span.decode((self, sess));
724 if let (Some(def), Some(name)) =
725 (self.get_def(child_index), def_key.disambiguated_data.data.get_opt_name()) {
726 let ident = Ident::from_str(&name);
727 callback(def::Export { def: def, ident: ident, span: span });
728 // For non-reexport structs and variants add their constructors to children.
729 // Reexport lists automatically contain constructors when necessary.
732 if let Some(ctor_def_id) = self.get_struct_ctor_def_id(child_index) {
733 let ctor_kind = self.get_ctor_kind(child_index);
734 let ctor_def = Def::StructCtor(ctor_def_id, ctor_kind);
735 callback(def::Export { def: ctor_def, ident: ident, span: span });
738 Def::Variant(def_id) => {
739 // Braced variants, unlike structs, generate unusable names in
740 // value namespace, they are reserved for possible future use.
741 let ctor_kind = self.get_ctor_kind(child_index);
742 let ctor_def = Def::VariantCtor(def_id, ctor_kind);
743 callback(def::Export { def: ctor_def, ident: ident, span: span });
751 if let EntryKind::Mod(data) = item.kind {
752 for exp in data.decode((self, sess)).reexports.decode((self, sess)) {
755 _ if macros_only => continue,
763 pub fn extern_const_body(&self,
764 tcx: TyCtxt<'a, 'tcx, 'tcx>,
767 assert!(!self.is_proc_macro(id));
768 let ast = self.entry(id).ast.unwrap();
769 let def_id = self.local_def_id(id);
770 let body = ast.decode((self, tcx)).body.decode((self, tcx));
771 tcx.hir.intern_inlined_body(def_id, body)
774 pub fn item_body_tables(&self,
776 tcx: TyCtxt<'a, 'tcx, 'tcx>)
777 -> &'tcx ty::TypeckTables<'tcx> {
778 let ast = self.entry(id).ast.unwrap().decode(self);
779 tcx.alloc_tables(ast.tables.decode((self, tcx)))
782 pub fn item_body_nested_bodies(&self, id: DefIndex) -> BTreeMap<hir::BodyId, hir::Body> {
783 self.entry(id).ast.into_iter().flat_map(|ast| {
784 ast.decode(self).nested_bodies.decode(self).map(|body| (body.id(), body))
788 pub fn const_is_rvalue_promotable_to_static(&self, id: DefIndex) -> bool {
789 self.entry(id).ast.expect("const item missing `ast`")
790 .decode(self).rvalue_promotable_to_static
793 pub fn is_item_mir_available(&self, id: DefIndex) -> bool {
794 !self.is_proc_macro(id) &&
795 self.maybe_entry(id).and_then(|item| item.decode(self).mir).is_some()
798 pub fn maybe_get_optimized_mir(&self,
799 tcx: TyCtxt<'a, 'tcx, 'tcx>,
801 -> Option<Mir<'tcx>> {
802 match self.is_proc_macro(id) {
804 false => self.entry(id).mir.map(|mir| mir.decode((self, tcx))),
808 pub fn mir_const_qualif(&self, id: DefIndex) -> u8 {
809 match self.entry(id).kind {
810 EntryKind::Const(qualif) |
811 EntryKind::AssociatedConst(AssociatedContainer::ImplDefault, qualif) |
812 EntryKind::AssociatedConst(AssociatedContainer::ImplFinal, qualif) => {
819 pub fn get_associated_item(&self, id: DefIndex) -> ty::AssociatedItem {
820 let item = self.entry(id);
821 let def_key = self.def_key(id);
822 let parent = self.local_def_id(def_key.parent.unwrap());
823 let name = def_key.disambiguated_data.data.get_opt_name().unwrap();
825 let (kind, container, has_self) = match item.kind {
826 EntryKind::AssociatedConst(container, _) => {
827 (ty::AssociatedKind::Const, container, false)
829 EntryKind::Method(data) => {
830 let data = data.decode(self);
831 (ty::AssociatedKind::Method, data.container, data.has_self)
833 EntryKind::AssociatedType(container) => {
834 (ty::AssociatedKind::Type, container, false)
836 _ => bug!("cannot get associated-item of `{:?}`", def_key)
840 name: Symbol::intern(&name),
842 vis: item.visibility.decode(self),
843 defaultness: container.defaultness(),
844 def_id: self.local_def_id(id),
845 container: container.with_def_id(parent),
846 method_has_self_argument: has_self
850 pub fn get_item_variances(&self, id: DefIndex) -> Vec<ty::Variance> {
851 self.entry(id).variances.decode(self).collect()
854 pub fn get_ctor_kind(&self, node_id: DefIndex) -> CtorKind {
855 match self.entry(node_id).kind {
856 EntryKind::Struct(data, _) |
857 EntryKind::Union(data, _) |
858 EntryKind::Variant(data) => data.decode(self).ctor_kind,
859 _ => CtorKind::Fictive,
863 pub fn get_struct_ctor_def_id(&self, node_id: DefIndex) -> Option<DefId> {
864 match self.entry(node_id).kind {
865 EntryKind::Struct(data, _) => {
866 data.decode(self).struct_ctor.map(|index| self.local_def_id(index))
872 pub fn get_item_attrs(&self,
874 dep_graph: &DepGraph) -> Rc<[ast::Attribute]> {
875 let (node_as, node_index) =
876 (node_id.address_space().index(), node_id.as_array_index());
877 if self.is_proc_macro(node_id) {
881 let dep_node = self.def_path_hash(node_id).to_dep_node(DepKind::MetaData);
882 dep_graph.read(dep_node);
884 if let Some(&Some(ref val)) =
885 self.attribute_cache.borrow()[node_as].get(node_index) {
889 // The attributes for a tuple struct are attached to the definition, not the ctor;
890 // we assume that someone passing in a tuple struct ctor is actually wanting to
891 // look at the definition
892 let mut item = self.entry(node_id);
893 let def_key = self.def_key(node_id);
894 if def_key.disambiguated_data.data == DefPathData::StructCtor {
895 item = self.entry(def_key.parent.unwrap());
897 let result: Rc<[ast::Attribute]> = Rc::from(self.get_attributes(&item));
898 let vec_ = &mut self.attribute_cache.borrow_mut()[node_as];
899 if vec_.len() < node_index + 1 {
900 vec_.resize(node_index + 1, None);
902 vec_[node_index] = Some(result.clone());
906 pub fn get_struct_field_names(&self, id: DefIndex) -> Vec<ast::Name> {
910 .map(|index| Symbol::intern(&self.item_name(index)))
914 fn get_attributes(&self, item: &Entry<'tcx>) -> Vec<ast::Attribute> {
918 // Need new unique IDs: old thread-local IDs won't map to new threads.
919 attr.id = attr::mk_attr_id();
925 // Translate a DefId from the current compilation environment to a DefId
926 // for an external crate.
927 fn reverse_translate_def_id(&self, did: DefId) -> Option<DefId> {
928 for (local, &global) in self.cnum_map.borrow().iter_enumerated() {
929 if global == did.krate {
940 pub fn get_inherent_implementations_for_type(&self, id: DefIndex) -> Vec<DefId> {
944 .map(|index| self.local_def_id(index))
948 pub fn get_implementations_for_trait(&self,
949 filter: Option<DefId>,
950 dep_graph: &DepGraph,
951 result: &mut Vec<DefId>) {
952 // Do a reverse lookup beforehand to avoid touching the crate_num
953 // hash map in the loop below.
954 let filter = match filter.map(|def_id| self.reverse_translate_def_id(def_id)) {
955 Some(Some(def_id)) => Some((def_id.krate.as_u32(), def_id.index)),
956 Some(None) => return,
957 None if self.proc_macros.is_some() => return,
961 let dep_node = self.metadata_dep_node(GlobalMetaDataKind::Impls);
963 if let Some(filter) = filter {
964 if let Some(impls) = self.trait_impls
965 .get(dep_graph, dep_node)
967 result.extend(impls.decode(self).map(|idx| self.local_def_id(idx)));
970 for impls in self.trait_impls.get(dep_graph, dep_node).values() {
971 result.extend(impls.decode(self).map(|idx| self.local_def_id(idx)));
976 pub fn get_trait_of_item(&self, id: DefIndex) -> Option<DefId> {
977 self.def_key(id).parent.and_then(|parent_index| {
978 match self.entry(parent_index).kind {
979 EntryKind::Trait(_) => Some(self.local_def_id(parent_index)),
986 pub fn get_native_libraries(&self,
987 dep_graph: &DepGraph)
988 -> Vec<NativeLibrary> {
989 let dep_node = self.metadata_dep_node(GlobalMetaDataKind::NativeLibraries);
992 .get(dep_graph, dep_node)
997 pub fn get_dylib_dependency_formats(&self,
998 dep_graph: &DepGraph)
999 -> Vec<(CrateNum, LinkagePreference)> {
1001 self.metadata_dep_node(GlobalMetaDataKind::DylibDependencyFormats);
1003 .dylib_dependency_formats
1004 .get(dep_graph, dep_node)
1007 .flat_map(|(i, link)| {
1008 let cnum = CrateNum::new(i + 1);
1009 link.map(|link| (self.cnum_map.borrow()[cnum], link))
1014 pub fn get_missing_lang_items(&self, dep_graph: &DepGraph) -> Vec<lang_items::LangItem> {
1015 let dep_node = self.metadata_dep_node(GlobalMetaDataKind::LangItemsMissing);
1018 .get(dep_graph, dep_node)
1023 pub fn get_fn_arg_names(&self, id: DefIndex) -> Vec<ast::Name> {
1024 let arg_names = match self.entry(id).kind {
1025 EntryKind::Fn(data) |
1026 EntryKind::ForeignFn(data) => data.decode(self).arg_names,
1027 EntryKind::Method(data) => data.decode(self).fn_data.arg_names,
1028 _ => LazySeq::empty(),
1030 arg_names.decode(self).collect()
1033 pub fn get_exported_symbols(&self, dep_graph: &DepGraph) -> Vec<DefId> {
1034 let dep_node = self.metadata_dep_node(GlobalMetaDataKind::ExportedSymbols);
1035 self.exported_symbols
1036 .get(dep_graph, dep_node)
1038 .map(|&index| self.local_def_id(index))
1042 pub fn get_macro(&self, id: DefIndex) -> (InternedString, MacroDef) {
1043 let entry = self.entry(id);
1045 EntryKind::MacroDef(macro_def) => (self.item_name(id), macro_def.decode(self)),
1050 pub fn is_const_fn(&self, id: DefIndex) -> bool {
1051 let constness = match self.entry(id).kind {
1052 EntryKind::Method(data) => data.decode(self).fn_data.constness,
1053 EntryKind::Fn(data) => data.decode(self).constness,
1054 _ => hir::Constness::NotConst,
1056 constness == hir::Constness::Const
1059 pub fn is_foreign_item(&self, id: DefIndex) -> bool {
1060 match self.entry(id).kind {
1061 EntryKind::ForeignImmStatic |
1062 EntryKind::ForeignMutStatic |
1063 EntryKind::ForeignFn(_) => true,
1068 pub fn is_dllimport_foreign_item(&self, id: DefIndex, dep_graph: &DepGraph) -> bool {
1069 let dep_node = self.metadata_dep_node(GlobalMetaDataKind::NativeLibraries);
1070 self.dllimport_foreign_items
1071 .get(dep_graph, dep_node)
1075 pub fn is_default_impl(&self, impl_id: DefIndex) -> bool {
1076 match self.entry(impl_id).kind {
1077 EntryKind::DefaultImpl(_) => true,
1082 pub fn closure_kind(&self, closure_id: DefIndex) -> ty::ClosureKind {
1083 match self.entry(closure_id).kind {
1084 EntryKind::Closure(data) => data.decode(self).kind,
1089 pub fn fn_sig(&self,
1091 tcx: TyCtxt<'a, 'tcx, 'tcx>)
1092 -> ty::PolyFnSig<'tcx> {
1093 let sig = match self.entry(id).kind {
1094 EntryKind::Fn(data) |
1095 EntryKind::ForeignFn(data) => data.decode(self).sig,
1096 EntryKind::Method(data) => data.decode(self).fn_data.sig,
1097 EntryKind::Variant(data) |
1098 EntryKind::Struct(data, _) => data.decode(self).ctor_sig.unwrap(),
1099 EntryKind::Closure(data) => data.decode(self).sig,
1102 sig.decode((self, tcx))
1105 fn get_generator_data(&self,
1107 tcx: TyCtxt<'a, 'tcx, 'tcx>)
1108 -> Option<GeneratorData<'tcx>> {
1109 match self.entry(id).kind {
1110 EntryKind::Generator(data) => Some(data.decode((self, tcx))),
1115 pub fn generator_sig(&self,
1117 tcx: TyCtxt<'a, 'tcx, 'tcx>)
1118 -> Option<ty::PolyGenSig<'tcx>> {
1119 self.get_generator_data(id, tcx).map(|d| d.sig)
1123 pub fn def_key(&self, index: DefIndex) -> DefKey {
1124 self.def_path_table.def_key(index)
1127 // Returns the path leading to the thing with this `id`.
1128 pub fn def_path(&self, id: DefIndex) -> DefPath {
1129 debug!("def_path(id={:?})", id);
1130 DefPath::make(self.cnum, id, |parent| self.def_path_table.def_key(parent))
1134 pub fn def_path_hash(&self, index: DefIndex) -> DefPathHash {
1135 self.def_path_table.def_path_hash(index)
1138 /// Imports the codemap from an external crate into the codemap of the crate
1139 /// currently being compiled (the "local crate").
1141 /// The import algorithm works analogous to how AST items are inlined from an
1142 /// external crate's metadata:
1143 /// For every FileMap in the external codemap an 'inline' copy is created in the
1144 /// local codemap. The correspondence relation between external and local
1145 /// FileMaps is recorded in the `ImportedFileMap` objects returned from this
1146 /// function. When an item from an external crate is later inlined into this
1147 /// crate, this correspondence information is used to translate the span
1148 /// information of the inlined item so that it refers the correct positions in
1149 /// the local codemap (see `<decoder::DecodeContext as SpecializedDecoder<Span>>`).
1151 /// The import algorithm in the function below will reuse FileMaps already
1152 /// existing in the local codemap. For example, even if the FileMap of some
1153 /// source file of libstd gets imported many times, there will only ever be
1154 /// one FileMap object for the corresponding file in the local codemap.
1156 /// Note that imported FileMaps do not actually contain the source code of the
1157 /// file they represent, just information about length, line breaks, and
1158 /// multibyte characters. This information is enough to generate valid debuginfo
1159 /// for items inlined from other crates.
1160 pub fn imported_filemaps(&'a self,
1161 local_codemap: &codemap::CodeMap)
1162 -> Ref<'a, Vec<cstore::ImportedFileMap>> {
1164 let filemaps = self.codemap_import_info.borrow();
1165 if !filemaps.is_empty() {
1170 let external_codemap = self.root.codemap.decode(self);
1172 let imported_filemaps = external_codemap.map(|filemap_to_import| {
1173 // We can't reuse an existing FileMap, so allocate a new one
1174 // containing the information we need.
1175 let syntax_pos::FileMap { name,
1182 .. } = filemap_to_import;
1184 let source_length = (end_pos - start_pos).to_usize();
1186 // Translate line-start positions and multibyte character
1187 // position into frame of reference local to file.
1188 // `CodeMap::new_imported_filemap()` will then translate those
1189 // coordinates to their new global frame of reference when the
1190 // offset of the FileMap is known.
1191 let mut lines = lines.into_inner();
1192 for pos in &mut lines {
1193 *pos = *pos - start_pos;
1195 let mut multibyte_chars = multibyte_chars.into_inner();
1196 for mbc in &mut multibyte_chars {
1197 mbc.pos = mbc.pos - start_pos;
1200 let local_version = local_codemap.new_imported_filemap(name,
1207 debug!("CrateMetaData::imported_filemaps alloc \
1208 filemap {:?} original (start_pos {:?} end_pos {:?}) \
1209 translated (start_pos {:?} end_pos {:?})",
1210 local_version.name, start_pos, end_pos,
1211 local_version.start_pos, local_version.end_pos);
1213 cstore::ImportedFileMap {
1214 original_start_pos: start_pos,
1215 original_end_pos: end_pos,
1216 translated_filemap: local_version,
1220 // This shouldn't borrow twice, but there is no way to downgrade RefMut to Ref.
1221 *self.codemap_import_info.borrow_mut() = imported_filemaps;
1222 self.codemap_import_info.borrow()
1225 pub fn metadata_dep_node(&self, kind: GlobalMetaDataKind) -> DepNode {
1226 let def_index = kind.def_index(&self.def_path_table);
1227 let def_path_hash = self.def_path_table.def_path_hash(def_index);
1228 def_path_hash.to_dep_node(DepKind::MetaData)