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::hir::map::{DefKey, DefPath, DefPathData};
19 use rustc::middle::cstore::LinkagePreference;
20 use rustc::hir::def::{self, Def, CtorKind};
21 use rustc::hir::def_id::{CrateNum, DefId, DefIndex, CRATE_DEF_INDEX, LOCAL_CRATE};
22 use rustc::middle::lang_items;
23 use rustc::session::Session;
24 use rustc::ty::{self, Ty, TyCtxt};
25 use rustc::ty::subst::Substs;
31 use std::collections::BTreeMap;
37 use rustc_serialize::{Decodable, Decoder, SpecializedDecoder, opaque};
41 use syntax::ext::base::MacroKind;
42 use syntax_pos::{self, Span, BytePos, Pos, DUMMY_SP, NO_EXPANSION};
44 pub struct DecodeContext<'a, 'tcx: 'a> {
45 opaque: opaque::Decoder<'a>,
46 cdata: Option<&'a CrateMetadata>,
47 sess: Option<&'a Session>,
48 tcx: Option<TyCtxt<'a, 'tcx, 'tcx>>,
50 // Cache the last used filemap for translating spans as an optimization.
51 last_filemap_index: usize,
53 lazy_state: LazyState,
56 /// Abstract over the various ways one can create metadata decoders.
57 pub trait Metadata<'a, 'tcx>: Copy {
58 fn raw_bytes(self) -> &'a [u8];
59 fn cdata(self) -> Option<&'a CrateMetadata> { None }
60 fn sess(self) -> Option<&'a Session> { None }
61 fn tcx(self) -> Option<TyCtxt<'a, 'tcx, 'tcx>> { None }
63 fn decoder(self, pos: usize) -> DecodeContext<'a, 'tcx> {
66 opaque: opaque::Decoder::new(self.raw_bytes(), pos),
68 sess: self.sess().or(tcx.map(|tcx| tcx.sess)),
70 last_filemap_index: 0,
71 lazy_state: LazyState::NoNode,
76 impl<'a, 'tcx> Metadata<'a, 'tcx> for &'a MetadataBlob {
77 fn raw_bytes(self) -> &'a [u8] {
79 MetadataBlob::Inflated(ref vec) => vec,
80 MetadataBlob::Archive(ref ar) => ar.as_slice(),
81 MetadataBlob::Raw(ref vec) => vec,
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 { lo: lo, hi: hi, ctxt: 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 { lo: lo, hi: hi, ctxt: 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<&'tcx ty::Region> for DecodeContext<'a, 'tcx> {
355 fn specialized_decode(&mut self) -> Result<&'tcx ty::Region, 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().lookup_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, out: &mut io::Write) -> io::Result<()> {
401 write!(out, "=External Dependencies=\n")?;
402 let root = self.get_root();
403 for (i, dep) in root.crate_deps.decode(self).enumerate() {
404 write!(out, "{} {}-{}\n", i + 1, dep.name, dep.hash)?;
411 impl<'tcx> EntryKind<'tcx> {
412 fn to_def(&self, did: DefId) -> Option<Def> {
414 EntryKind::Const(_) => Def::Const(did),
415 EntryKind::AssociatedConst(..) => Def::AssociatedConst(did),
416 EntryKind::ImmStatic |
417 EntryKind::ForeignImmStatic => Def::Static(did, false),
418 EntryKind::MutStatic |
419 EntryKind::ForeignMutStatic => Def::Static(did, true),
420 EntryKind::Struct(_, _) => Def::Struct(did),
421 EntryKind::Union(_, _) => Def::Union(did),
423 EntryKind::ForeignFn(_) => Def::Fn(did),
424 EntryKind::Method(_) => Def::Method(did),
425 EntryKind::Type => Def::TyAlias(did),
426 EntryKind::AssociatedType(_) => Def::AssociatedTy(did),
427 EntryKind::Mod(_) => Def::Mod(did),
428 EntryKind::Variant(_) => Def::Variant(did),
429 EntryKind::Trait(_) => Def::Trait(did),
430 EntryKind::Enum(..) => Def::Enum(did),
431 EntryKind::MacroDef(_) => Def::Macro(did, MacroKind::Bang),
432 EntryKind::GlobalAsm => Def::GlobalAsm(did),
434 EntryKind::ForeignMod |
436 EntryKind::DefaultImpl(_) |
438 EntryKind::Closure(_) => return None,
443 impl<'a, 'tcx> CrateMetadata {
444 fn is_proc_macro(&self, id: DefIndex) -> bool {
445 self.proc_macros.is_some() && id != CRATE_DEF_INDEX
448 fn maybe_entry(&self, item_id: DefIndex) -> Option<Lazy<Entry<'tcx>>> {
449 assert!(!self.is_proc_macro(item_id));
450 self.root.index.lookup(self.blob.raw_bytes(), item_id)
453 fn entry(&self, item_id: DefIndex) -> Entry<'tcx> {
454 match self.maybe_entry(item_id) {
456 bug!("entry: id not found: {:?} in crate {:?} with number {}",
461 Some(d) => d.decode(self),
465 fn local_def_id(&self, index: DefIndex) -> DefId {
472 fn item_name(&self, item_index: DefIndex) -> ast::Name {
473 self.def_key(item_index)
477 .expect("no name in item_name")
480 pub fn get_def(&self, index: DefIndex) -> Option<Def> {
481 if !self.is_proc_macro(index) {
482 self.entry(index).kind.to_def(self.local_def_id(index))
484 let kind = self.proc_macros.as_ref().unwrap()[index.as_usize() - 1].1.kind();
485 Some(Def::Macro(self.local_def_id(index), kind))
489 pub fn get_span(&self, index: DefIndex, sess: &Session) -> Span {
490 match self.is_proc_macro(index) {
492 false => self.entry(index).span.decode((self, sess)),
496 pub fn get_trait_def(&self, item_id: DefIndex) -> ty::TraitDef {
497 let data = match self.entry(item_id).kind {
498 EntryKind::Trait(data) => data.decode(self),
502 let def = ty::TraitDef::new(self.local_def_id(item_id),
505 self.def_path_table.def_path_hash(item_id));
507 if data.has_default_impl {
508 def.record_has_default_impl();
514 fn get_variant(&self,
517 tcx: TyCtxt<'a, 'tcx, 'tcx>)
518 -> (ty::VariantDef, Option<DefIndex>) {
519 let data = match item.kind {
520 EntryKind::Variant(data) |
521 EntryKind::Struct(data, _) |
522 EntryKind::Union(data, _) => data.decode(self),
526 if let ty::VariantDiscr::Explicit(def_id) = data.discr {
527 let result = data.evaluated_discr.map_or(Err(()), Ok);
528 tcx.maps.monomorphic_const_eval.borrow_mut().insert(def_id, result);
532 did: self.local_def_id(data.struct_ctor.unwrap_or(index)),
533 name: self.item_name(index),
534 fields: item.children.decode(self).map(|index| {
535 let f = self.entry(index);
537 did: self.local_def_id(index),
538 name: self.item_name(index),
539 vis: f.visibility.decode(self)
543 ctor_kind: data.ctor_kind,
547 pub fn get_adt_def(&self,
549 tcx: TyCtxt<'a, 'tcx, 'tcx>)
550 -> &'tcx ty::AdtDef {
551 let item = self.entry(item_id);
552 let did = self.local_def_id(item_id);
553 let kind = match item.kind {
554 EntryKind::Enum(_) => ty::AdtKind::Enum,
555 EntryKind::Struct(_, _) => ty::AdtKind::Struct,
556 EntryKind::Union(_, _) => ty::AdtKind::Union,
557 _ => bug!("get_adt_def called on a non-ADT {:?}", did),
559 let variants = if let ty::AdtKind::Enum = kind {
563 let (variant, struct_ctor) =
564 self.get_variant(&self.entry(index), index, tcx);
565 assert_eq!(struct_ctor, None);
570 let (variant, _struct_ctor) = self.get_variant(&item, item_id, tcx);
573 let (kind, repr) = match item.kind {
574 EntryKind::Enum(repr) => (ty::AdtKind::Enum, repr),
575 EntryKind::Struct(_, repr) => (ty::AdtKind::Struct, repr),
576 EntryKind::Union(_, repr) => (ty::AdtKind::Union, repr),
577 _ => bug!("get_adt_def called on a non-ADT {:?}", did),
580 tcx.alloc_adt_def(did, kind, variants, repr)
583 pub fn get_predicates(&self,
585 tcx: TyCtxt<'a, 'tcx, 'tcx>)
586 -> ty::GenericPredicates<'tcx> {
587 self.entry(item_id).predicates.unwrap().decode((self, tcx))
590 pub fn get_super_predicates(&self,
592 tcx: TyCtxt<'a, 'tcx, 'tcx>)
593 -> ty::GenericPredicates<'tcx> {
594 match self.entry(item_id).kind {
595 EntryKind::Trait(data) => data.decode(self).super_predicates.decode((self, tcx)),
600 pub fn get_generics(&self, item_id: DefIndex) -> ty::Generics {
601 self.entry(item_id).generics.unwrap().decode(self)
604 pub fn get_type(&self, id: DefIndex, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Ty<'tcx> {
605 self.entry(id).ty.unwrap().decode((self, tcx))
608 pub fn get_stability(&self, id: DefIndex) -> Option<attr::Stability> {
609 match self.is_proc_macro(id) {
611 false => self.entry(id).stability.map(|stab| stab.decode(self)),
615 pub fn get_deprecation(&self, id: DefIndex) -> Option<attr::Deprecation> {
616 match self.is_proc_macro(id) {
618 false => self.entry(id).deprecation.map(|depr| depr.decode(self)),
622 pub fn get_visibility(&self, id: DefIndex) -> ty::Visibility {
623 match self.is_proc_macro(id) {
624 true => ty::Visibility::Public,
625 false => self.entry(id).visibility.decode(self),
629 fn get_impl_data(&self, id: DefIndex) -> ImplData<'tcx> {
630 match self.entry(id).kind {
631 EntryKind::Impl(data) => data.decode(self),
636 pub fn get_parent_impl(&self, id: DefIndex) -> Option<DefId> {
637 self.get_impl_data(id).parent_impl
640 pub fn get_impl_polarity(&self, id: DefIndex) -> hir::ImplPolarity {
641 self.get_impl_data(id).polarity
644 pub fn get_coerce_unsized_info(&self,
646 -> Option<ty::adjustment::CoerceUnsizedInfo> {
647 self.get_impl_data(id).coerce_unsized_info
650 pub fn get_impl_trait(&self,
652 tcx: TyCtxt<'a, 'tcx, 'tcx>)
653 -> Option<ty::TraitRef<'tcx>> {
654 self.get_impl_data(id).trait_ref.map(|tr| tr.decode((self, tcx)))
657 /// Iterates over the language items in the given crate.
658 pub fn get_lang_items(&self) -> Vec<(DefIndex, usize)> {
659 self.root.lang_items.decode(self).collect()
662 /// Iterates over each child of the given item.
663 pub fn each_child_of_item<F>(&self, id: DefIndex, mut callback: F)
664 where F: FnMut(def::Export)
666 if let Some(ref proc_macros) = self.proc_macros {
667 if id == CRATE_DEF_INDEX {
668 for (id, &(name, ref ext)) in proc_macros.iter().enumerate() {
669 let def = Def::Macro(
672 index: DefIndex::new(id + 1)
676 callback(def::Export { name: name, def: def, span: DUMMY_SP });
683 let item = match self.maybe_entry(id) {
685 Some(item) => item.decode(self),
688 // Iterate over all children.
689 let macros_only = self.dep_kind.get().macros_only();
690 for child_index in item.children.decode(self) {
696 if let Some(child) = self.maybe_entry(child_index) {
697 let child = child.decode(self);
699 EntryKind::MacroDef(..) => {}
700 _ if macros_only => continue,
704 // Hand off the item to the callback.
706 // FIXME(eddyb) Don't encode these in children.
707 EntryKind::ForeignMod => {
708 for child_index in child.children.decode(self) {
709 if let Some(def) = self.get_def(child_index) {
710 callback(def::Export {
712 name: self.item_name(child_index),
713 span: self.entry(child_index).span.decode(self),
720 EntryKind::DefaultImpl(_) => continue,
725 let def_key = self.def_key(child_index);
726 let span = child.span.decode(self);
727 if let (Some(def), Some(name)) =
728 (self.get_def(child_index), def_key.disambiguated_data.data.get_opt_name()) {
729 callback(def::Export { def: def, name: name, span: span });
730 // For non-reexport structs and variants add their constructors to children.
731 // Reexport lists automatically contain constructors when necessary.
734 if let Some(ctor_def_id) = self.get_struct_ctor_def_id(child_index) {
735 let ctor_kind = self.get_ctor_kind(child_index);
736 let ctor_def = Def::StructCtor(ctor_def_id, ctor_kind);
737 callback(def::Export { def: ctor_def, name: name, span: span });
740 Def::Variant(def_id) => {
741 // Braced variants, unlike structs, generate unusable names in
742 // value namespace, they are reserved for possible future use.
743 let ctor_kind = self.get_ctor_kind(child_index);
744 let ctor_def = Def::VariantCtor(def_id, ctor_kind);
745 callback(def::Export { def: ctor_def, name: name, span: span });
753 if let EntryKind::Mod(data) = item.kind {
754 for exp in data.decode(self).reexports.decode(self) {
757 _ if macros_only => continue,
765 pub fn maybe_get_item_body(&self,
766 tcx: TyCtxt<'a, 'tcx, 'tcx>,
768 -> Option<&'tcx hir::Body> {
769 if self.is_proc_macro(id) { return None; }
770 self.entry(id).ast.map(|ast| {
771 let def_id = self.local_def_id(id);
772 let body = ast.decode(self).body.decode(self);
773 tcx.hir.intern_inlined_body(def_id, body)
777 pub fn item_body_tables(&self,
779 tcx: TyCtxt<'a, 'tcx, 'tcx>)
780 -> &'tcx ty::TypeckTables<'tcx> {
781 let ast = self.entry(id).ast.unwrap().decode(self);
782 tcx.alloc_tables(ast.tables.decode((self, tcx)))
785 pub fn item_body_nested_bodies(&self, id: DefIndex) -> BTreeMap<hir::BodyId, hir::Body> {
786 self.entry(id).ast.into_iter().flat_map(|ast| {
787 ast.decode(self).nested_bodies.decode(self).map(|body| (body.id(), body))
791 pub fn const_is_rvalue_promotable_to_static(&self, id: DefIndex) -> bool {
792 self.entry(id).ast.expect("const item missing `ast`")
793 .decode(self).rvalue_promotable_to_static
796 pub fn is_item_mir_available(&self, id: DefIndex) -> bool {
797 !self.is_proc_macro(id) &&
798 self.maybe_entry(id).and_then(|item| item.decode(self).mir).is_some()
801 pub fn maybe_get_item_mir(&self,
802 tcx: TyCtxt<'a, 'tcx, 'tcx>,
804 -> Option<Mir<'tcx>> {
805 match self.is_proc_macro(id) {
807 false => self.entry(id).mir.map(|mir| mir.decode((self, tcx))),
811 pub fn mir_const_qualif(&self, id: DefIndex) -> u8 {
812 match self.entry(id).kind {
813 EntryKind::Const(qualif) |
814 EntryKind::AssociatedConst(AssociatedContainer::ImplDefault, qualif) |
815 EntryKind::AssociatedConst(AssociatedContainer::ImplFinal, qualif) => {
822 pub fn get_associated_item(&self, id: DefIndex) -> ty::AssociatedItem {
823 let item = self.entry(id);
824 let def_key = self.def_key(id);
825 let parent = self.local_def_id(def_key.parent.unwrap());
826 let name = def_key.disambiguated_data.data.get_opt_name().unwrap();
828 let (kind, container, has_self) = match item.kind {
829 EntryKind::AssociatedConst(container, _) => {
830 (ty::AssociatedKind::Const, container, false)
832 EntryKind::Method(data) => {
833 let data = data.decode(self);
834 (ty::AssociatedKind::Method, data.container, data.has_self)
836 EntryKind::AssociatedType(container) => {
837 (ty::AssociatedKind::Type, container, false)
845 vis: item.visibility.decode(self),
846 defaultness: container.defaultness(),
847 def_id: self.local_def_id(id),
848 container: container.with_def_id(parent),
849 method_has_self_argument: has_self
853 pub fn get_item_variances(&self, id: DefIndex) -> Vec<ty::Variance> {
854 self.entry(id).variances.decode(self).collect()
857 pub fn get_ctor_kind(&self, node_id: DefIndex) -> CtorKind {
858 match self.entry(node_id).kind {
859 EntryKind::Struct(data, _) |
860 EntryKind::Union(data, _) |
861 EntryKind::Variant(data) => data.decode(self).ctor_kind,
862 _ => CtorKind::Fictive,
866 pub fn get_struct_ctor_def_id(&self, node_id: DefIndex) -> Option<DefId> {
867 match self.entry(node_id).kind {
868 EntryKind::Struct(data, _) => {
869 data.decode(self).struct_ctor.map(|index| self.local_def_id(index))
875 pub fn get_item_attrs(&self, node_id: DefIndex) -> Vec<ast::Attribute> {
876 if self.is_proc_macro(node_id) {
879 // The attributes for a tuple struct are attached to the definition, not the ctor;
880 // we assume that someone passing in a tuple struct ctor is actually wanting to
881 // look at the definition
882 let mut item = self.entry(node_id);
883 let def_key = self.def_key(node_id);
884 if def_key.disambiguated_data.data == DefPathData::StructCtor {
885 item = self.entry(def_key.parent.unwrap());
887 self.get_attributes(&item)
890 pub fn get_struct_field_names(&self, id: DefIndex) -> Vec<ast::Name> {
894 .map(|index| self.item_name(index))
898 fn get_attributes(&self, item: &Entry<'tcx>) -> Vec<ast::Attribute> {
902 // Need new unique IDs: old thread-local IDs won't map to new threads.
903 attr.id = attr::mk_attr_id();
909 // Translate a DefId from the current compilation environment to a DefId
910 // for an external crate.
911 fn reverse_translate_def_id(&self, did: DefId) -> Option<DefId> {
912 for (local, &global) in self.cnum_map.borrow().iter_enumerated() {
913 if global == did.krate {
924 pub fn get_inherent_implementations_for_type(&self, id: DefIndex) -> Vec<DefId> {
928 .map(|index| self.local_def_id(index))
932 pub fn get_implementations_for_trait(&self, filter: Option<DefId>, result: &mut Vec<DefId>) {
933 // Do a reverse lookup beforehand to avoid touching the crate_num
934 // hash map in the loop below.
935 let filter = match filter.map(|def_id| self.reverse_translate_def_id(def_id)) {
936 Some(Some(def_id)) => Some((def_id.krate.as_u32(), def_id.index)),
937 Some(None) => return,
938 None if self.proc_macros.is_some() => return,
942 // FIXME(eddyb) Make this O(1) instead of O(n).
943 for trait_impls in self.root.impls.decode(self) {
944 if filter.is_some() && filter != Some(trait_impls.trait_id) {
948 result.extend(trait_impls.impls.decode(self).map(|index| self.local_def_id(index)));
950 if filter.is_some() {
956 pub fn get_trait_of_item(&self, id: DefIndex) -> Option<DefId> {
957 self.def_key(id).parent.and_then(|parent_index| {
958 match self.entry(parent_index).kind {
959 EntryKind::Trait(_) => Some(self.local_def_id(parent_index)),
966 pub fn get_native_libraries(&self) -> Vec<NativeLibrary> {
967 self.root.native_libraries.decode(self).collect()
970 pub fn get_dylib_dependency_formats(&self) -> Vec<(CrateNum, LinkagePreference)> {
972 .dylib_dependency_formats
975 .flat_map(|(i, link)| {
976 let cnum = CrateNum::new(i + 1);
977 link.map(|link| (self.cnum_map.borrow()[cnum], link))
982 pub fn get_missing_lang_items(&self) -> Vec<lang_items::LangItem> {
983 self.root.lang_items_missing.decode(self).collect()
986 pub fn get_fn_arg_names(&self, id: DefIndex) -> Vec<ast::Name> {
987 let arg_names = match self.entry(id).kind {
988 EntryKind::Fn(data) |
989 EntryKind::ForeignFn(data) => data.decode(self).arg_names,
990 EntryKind::Method(data) => data.decode(self).fn_data.arg_names,
991 _ => LazySeq::empty(),
993 arg_names.decode(self).collect()
996 pub fn get_exported_symbols(&self) -> Vec<DefId> {
997 self.exported_symbols.iter().map(|&index| self.local_def_id(index)).collect()
1000 pub fn get_macro(&self, id: DefIndex) -> (ast::Name, MacroDef) {
1001 let entry = self.entry(id);
1003 EntryKind::MacroDef(macro_def) => (self.item_name(id), macro_def.decode(self)),
1008 pub fn is_const_fn(&self, id: DefIndex) -> bool {
1009 let constness = match self.entry(id).kind {
1010 EntryKind::Method(data) => data.decode(self).fn_data.constness,
1011 EntryKind::Fn(data) => data.decode(self).constness,
1012 _ => hir::Constness::NotConst,
1014 constness == hir::Constness::Const
1017 pub fn is_foreign_item(&self, id: DefIndex) -> bool {
1018 match self.entry(id).kind {
1019 EntryKind::ForeignImmStatic |
1020 EntryKind::ForeignMutStatic |
1021 EntryKind::ForeignFn(_) => true,
1026 pub fn is_dllimport_foreign_item(&self, id: DefIndex) -> bool {
1027 self.dllimport_foreign_items.contains(&id)
1030 pub fn is_default_impl(&self, impl_id: DefIndex) -> bool {
1031 match self.entry(impl_id).kind {
1032 EntryKind::DefaultImpl(_) => true,
1037 pub fn closure_kind(&self, closure_id: DefIndex) -> ty::ClosureKind {
1038 match self.entry(closure_id).kind {
1039 EntryKind::Closure(data) => data.decode(self).kind,
1044 pub fn closure_ty(&self,
1045 closure_id: DefIndex,
1046 tcx: TyCtxt<'a, 'tcx, 'tcx>)
1047 -> ty::PolyFnSig<'tcx> {
1048 match self.entry(closure_id).kind {
1049 EntryKind::Closure(data) => data.decode(self).ty.decode((self, tcx)),
1055 pub fn def_key(&self, index: DefIndex) -> DefKey {
1056 self.def_path_table.def_key(index)
1059 // Returns the path leading to the thing with this `id`.
1060 pub fn def_path(&self, id: DefIndex) -> DefPath {
1061 debug!("def_path(id={:?})", id);
1062 DefPath::make(self.cnum, id, |parent| self.def_path_table.def_key(parent))
1066 pub fn def_path_hash(&self, index: DefIndex) -> u64 {
1067 self.def_path_table.def_path_hash(index)
1070 /// Imports the codemap from an external crate into the codemap of the crate
1071 /// currently being compiled (the "local crate").
1073 /// The import algorithm works analogous to how AST items are inlined from an
1074 /// external crate's metadata:
1075 /// For every FileMap in the external codemap an 'inline' copy is created in the
1076 /// local codemap. The correspondence relation between external and local
1077 /// FileMaps is recorded in the `ImportedFileMap` objects returned from this
1078 /// function. When an item from an external crate is later inlined into this
1079 /// crate, this correspondence information is used to translate the span
1080 /// information of the inlined item so that it refers the correct positions in
1081 /// the local codemap (see `<decoder::DecodeContext as SpecializedDecoder<Span>>`).
1083 /// The import algorithm in the function below will reuse FileMaps already
1084 /// existing in the local codemap. For example, even if the FileMap of some
1085 /// source file of libstd gets imported many times, there will only ever be
1086 /// one FileMap object for the corresponding file in the local codemap.
1088 /// Note that imported FileMaps do not actually contain the source code of the
1089 /// file they represent, just information about length, line breaks, and
1090 /// multibyte characters. This information is enough to generate valid debuginfo
1091 /// for items inlined from other crates.
1092 pub fn imported_filemaps(&'a self,
1093 local_codemap: &codemap::CodeMap)
1094 -> Ref<'a, Vec<cstore::ImportedFileMap>> {
1096 let filemaps = self.codemap_import_info.borrow();
1097 if !filemaps.is_empty() {
1102 let external_codemap = self.root.codemap.decode(self);
1104 let imported_filemaps = external_codemap.map(|filemap_to_import| {
1105 // Try to find an existing FileMap that can be reused for the filemap to
1106 // be imported. A FileMap is reusable if it is exactly the same, just
1107 // positioned at a different offset within the codemap.
1108 let reusable_filemap = {
1112 .find(|fm| are_equal_modulo_startpos(&fm, &filemap_to_import))
1113 .map(|rc| rc.clone())
1116 match reusable_filemap {
1119 debug!("CrateMetaData::imported_filemaps reuse \
1120 filemap {:?} original (start_pos {:?} end_pos {:?}) \
1121 translated (start_pos {:?} end_pos {:?})",
1122 filemap_to_import.name,
1123 filemap_to_import.start_pos, filemap_to_import.end_pos,
1124 fm.start_pos, fm.end_pos);
1126 cstore::ImportedFileMap {
1127 original_start_pos: filemap_to_import.start_pos,
1128 original_end_pos: filemap_to_import.end_pos,
1129 translated_filemap: fm,
1133 // We can't reuse an existing FileMap, so allocate a new one
1134 // containing the information we need.
1135 let syntax_pos::FileMap { name,
1141 .. } = filemap_to_import;
1143 let source_length = (end_pos - start_pos).to_usize();
1145 // Translate line-start positions and multibyte character
1146 // position into frame of reference local to file.
1147 // `CodeMap::new_imported_filemap()` will then translate those
1148 // coordinates to their new global frame of reference when the
1149 // offset of the FileMap is known.
1150 let mut lines = lines.into_inner();
1151 for pos in &mut lines {
1152 *pos = *pos - start_pos;
1154 let mut multibyte_chars = multibyte_chars.into_inner();
1155 for mbc in &mut multibyte_chars {
1156 mbc.pos = mbc.pos - start_pos;
1159 let local_version = local_codemap.new_imported_filemap(name,
1164 debug!("CrateMetaData::imported_filemaps alloc \
1165 filemap {:?} original (start_pos {:?} end_pos {:?}) \
1166 translated (start_pos {:?} end_pos {:?})",
1167 local_version.name, start_pos, end_pos,
1168 local_version.start_pos, local_version.end_pos);
1170 cstore::ImportedFileMap {
1171 original_start_pos: start_pos,
1172 original_end_pos: end_pos,
1173 translated_filemap: local_version,
1180 // This shouldn't borrow twice, but there is no way to downgrade RefMut to Ref.
1181 *self.codemap_import_info.borrow_mut() = imported_filemaps;
1182 self.codemap_import_info.borrow()
1186 fn are_equal_modulo_startpos(fm1: &syntax_pos::FileMap, fm2: &syntax_pos::FileMap) -> bool {
1187 if fm1.byte_length() != fm2.byte_length() {
1191 if fm1.name != fm2.name {
1195 let lines1 = fm1.lines.borrow();
1196 let lines2 = fm2.lines.borrow();
1198 if lines1.len() != lines2.len() {
1202 for (&line1, &line2) in lines1.iter().zip(lines2.iter()) {
1203 if (line1 - fm1.start_pos) != (line2 - fm2.start_pos) {
1208 let multibytes1 = fm1.multibyte_chars.borrow();
1209 let multibytes2 = fm2.multibyte_chars.borrow();
1211 if multibytes1.len() != multibytes2.len() {
1215 for (mb1, mb2) in multibytes1.iter().zip(multibytes2.iter()) {
1216 if (mb1.bytes != mb2.bytes) || ((mb1.pos - fm1.start_pos) != (mb2.pos - fm2.start_pos)) {