| // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT |
| // file at the top-level directory of this distribution and at |
| // http://rust-lang.org/COPYRIGHT. |
| // |
| // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or |
| // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license |
| // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your |
| // option. This file may not be copied, modified, or distributed |
| // except according to those terms. |
| |
| // Decoding metadata from a single crate's metadata |
| |
| use cstore::{self, CrateMetadata, MetadataBlob, NativeLibrary, ForeignModule}; |
| use schema::*; |
| |
| use rustc_data_structures::sync::{Lrc, ReadGuard}; |
| use rustc::hir::map::{DefKey, DefPath, DefPathData, DefPathHash, |
| DisambiguatedDefPathData}; |
| use rustc::hir; |
| use rustc::middle::cstore::{LinkagePreference, ExternConstBody, |
| ExternBodyNestedBodies}; |
| use rustc::middle::exported_symbols::{ExportedSymbol, SymbolExportLevel}; |
| use rustc::hir::def::{self, Def, CtorKind}; |
| use rustc::hir::def_id::{CrateNum, DefId, DefIndex, |
| CRATE_DEF_INDEX, LOCAL_CRATE, LocalDefId}; |
| use rustc::ich::Fingerprint; |
| use rustc::middle::lang_items; |
| use rustc::mir::{self, interpret}; |
| use rustc::session::Session; |
| use rustc::ty::{self, Ty, TyCtxt}; |
| use rustc::ty::codec::TyDecoder; |
| use rustc::mir::Mir; |
| use rustc::util::captures::Captures; |
| use rustc::util::nodemap::FxHashMap; |
| |
| use std::collections::BTreeMap; |
| use std::io; |
| use std::mem; |
| use std::u32; |
| |
| use rustc_serialize::{Decodable, Decoder, SpecializedDecoder, opaque}; |
| use syntax::attr; |
| use syntax::ast::{self, Ident}; |
| use syntax::codemap; |
| use syntax::symbol::{InternedString, Symbol}; |
| use syntax::ext::base::MacroKind; |
| use syntax_pos::{self, Span, BytePos, Pos, DUMMY_SP, NO_EXPANSION}; |
| |
| pub struct DecodeContext<'a, 'tcx: 'a> { |
| opaque: opaque::Decoder<'a>, |
| cdata: Option<&'a CrateMetadata>, |
| sess: Option<&'a Session>, |
| tcx: Option<TyCtxt<'a, 'tcx, 'tcx>>, |
| |
| // Cache the last used filemap for translating spans as an optimization. |
| last_filemap_index: usize, |
| |
| lazy_state: LazyState, |
| |
| // interpreter allocation cache |
| interpret_alloc_cache: FxHashMap<usize, interpret::AllocId>, |
| |
| // Read from the LazySeq CrateRoot::inpterpret_alloc_index on demand |
| interpret_alloc_index: Option<Vec<u32>>, |
| } |
| |
| /// Abstract over the various ways one can create metadata decoders. |
| pub trait Metadata<'a, 'tcx>: Copy { |
| fn raw_bytes(self) -> &'a [u8]; |
| fn cdata(self) -> Option<&'a CrateMetadata> { None } |
| fn sess(self) -> Option<&'a Session> { None } |
| fn tcx(self) -> Option<TyCtxt<'a, 'tcx, 'tcx>> { None } |
| |
| fn decoder(self, pos: usize) -> DecodeContext<'a, 'tcx> { |
| let tcx = self.tcx(); |
| DecodeContext { |
| opaque: opaque::Decoder::new(self.raw_bytes(), pos), |
| cdata: self.cdata(), |
| sess: self.sess().or(tcx.map(|tcx| tcx.sess)), |
| tcx, |
| last_filemap_index: 0, |
| lazy_state: LazyState::NoNode, |
| interpret_alloc_cache: FxHashMap::default(), |
| interpret_alloc_index: None, |
| } |
| } |
| } |
| |
| impl<'a, 'tcx> Metadata<'a, 'tcx> for &'a MetadataBlob { |
| fn raw_bytes(self) -> &'a [u8] { |
| &self.0 |
| } |
| } |
| |
| |
| impl<'a, 'tcx> Metadata<'a, 'tcx> for (&'a MetadataBlob, &'a Session) { |
| fn raw_bytes(self) -> &'a [u8] { |
| let (blob, _) = self; |
| &blob.0 |
| } |
| |
| fn sess(self) -> Option<&'a Session> { |
| let (_, sess) = self; |
| Some(sess) |
| } |
| } |
| |
| |
| impl<'a, 'tcx> Metadata<'a, 'tcx> for &'a CrateMetadata { |
| fn raw_bytes(self) -> &'a [u8] { |
| self.blob.raw_bytes() |
| } |
| fn cdata(self) -> Option<&'a CrateMetadata> { |
| Some(self) |
| } |
| } |
| |
| impl<'a, 'tcx> Metadata<'a, 'tcx> for (&'a CrateMetadata, &'a Session) { |
| fn raw_bytes(self) -> &'a [u8] { |
| self.0.raw_bytes() |
| } |
| fn cdata(self) -> Option<&'a CrateMetadata> { |
| Some(self.0) |
| } |
| fn sess(self) -> Option<&'a Session> { |
| Some(&self.1) |
| } |
| } |
| |
| impl<'a, 'tcx> Metadata<'a, 'tcx> for (&'a CrateMetadata, TyCtxt<'a, 'tcx, 'tcx>) { |
| fn raw_bytes(self) -> &'a [u8] { |
| self.0.raw_bytes() |
| } |
| fn cdata(self) -> Option<&'a CrateMetadata> { |
| Some(self.0) |
| } |
| fn tcx(self) -> Option<TyCtxt<'a, 'tcx, 'tcx>> { |
| Some(self.1) |
| } |
| } |
| |
| impl<'a, 'tcx: 'a, T: Decodable> Lazy<T> { |
| pub fn decode<M: Metadata<'a, 'tcx>>(self, meta: M) -> T { |
| let mut dcx = meta.decoder(self.position); |
| dcx.lazy_state = LazyState::NodeStart(self.position); |
| T::decode(&mut dcx).unwrap() |
| } |
| } |
| |
| impl<'a, 'tcx: 'a, T: Decodable> LazySeq<T> { |
| pub fn decode<M: Metadata<'a, 'tcx>>( |
| self, |
| meta: M, |
| ) -> impl Iterator<Item = T> + Captures<'tcx> + 'a { |
| let mut dcx = meta.decoder(self.position); |
| dcx.lazy_state = LazyState::NodeStart(self.position); |
| (0..self.len).map(move |_| T::decode(&mut dcx).unwrap()) |
| } |
| } |
| |
| impl<'a, 'tcx> DecodeContext<'a, 'tcx> { |
| pub fn tcx(&self) -> TyCtxt<'a, 'tcx, 'tcx> { |
| self.tcx.expect("missing TyCtxt in DecodeContext") |
| } |
| |
| pub fn cdata(&self) -> &'a CrateMetadata { |
| self.cdata.expect("missing CrateMetadata in DecodeContext") |
| } |
| |
| fn read_lazy_distance(&mut self, min_size: usize) -> Result<usize, <Self as Decoder>::Error> { |
| let distance = self.read_usize()?; |
| let position = match self.lazy_state { |
| LazyState::NoNode => bug!("read_lazy_distance: outside of a metadata node"), |
| LazyState::NodeStart(start) => { |
| assert!(distance + min_size <= start); |
| start - distance - min_size |
| } |
| LazyState::Previous(last_min_end) => last_min_end + distance, |
| }; |
| self.lazy_state = LazyState::Previous(position + min_size); |
| Ok(position) |
| } |
| |
| fn interpret_alloc(&mut self, idx: usize) -> usize { |
| if let Some(index) = self.interpret_alloc_index.as_mut() { |
| return index[idx] as usize; |
| } |
| let cdata = self.cdata(); |
| let index: Vec<u32> = cdata.root.interpret_alloc_index.decode(cdata).collect(); |
| let pos = index[idx]; |
| self.interpret_alloc_index = Some(index); |
| pos as usize |
| } |
| } |
| |
| impl<'a, 'tcx: 'a> TyDecoder<'a, 'tcx> for DecodeContext<'a, 'tcx> { |
| |
| #[inline] |
| fn tcx(&self) -> TyCtxt<'a, 'tcx, 'tcx> { |
| self.tcx.expect("missing TyCtxt in DecodeContext") |
| } |
| |
| #[inline] |
| fn peek_byte(&self) -> u8 { |
| self.opaque.data[self.opaque.position()] |
| } |
| |
| #[inline] |
| fn position(&self) -> usize { |
| self.opaque.position() |
| } |
| |
| fn cached_ty_for_shorthand<F>(&mut self, |
| shorthand: usize, |
| or_insert_with: F) |
| -> Result<Ty<'tcx>, Self::Error> |
| where F: FnOnce(&mut Self) -> Result<Ty<'tcx>, Self::Error> |
| { |
| let tcx = self.tcx(); |
| |
| let key = ty::CReaderCacheKey { |
| cnum: self.cdata().cnum, |
| pos: shorthand, |
| }; |
| |
| if let Some(&ty) = tcx.rcache.borrow().get(&key) { |
| return Ok(ty); |
| } |
| |
| let ty = or_insert_with(self)?; |
| tcx.rcache.borrow_mut().insert(key, ty); |
| Ok(ty) |
| } |
| |
| fn with_position<F, R>(&mut self, pos: usize, f: F) -> R |
| where F: FnOnce(&mut Self) -> R |
| { |
| let new_opaque = opaque::Decoder::new(self.opaque.data, pos); |
| let old_opaque = mem::replace(&mut self.opaque, new_opaque); |
| let old_state = mem::replace(&mut self.lazy_state, LazyState::NoNode); |
| let r = f(self); |
| self.opaque = old_opaque; |
| self.lazy_state = old_state; |
| r |
| } |
| |
| fn map_encoded_cnum_to_current(&self, cnum: CrateNum) -> CrateNum { |
| if cnum == LOCAL_CRATE { |
| self.cdata().cnum |
| } else { |
| self.cdata().cnum_map.borrow()[cnum] |
| } |
| } |
| } |
| |
| impl<'a, 'tcx, T> SpecializedDecoder<Lazy<T>> for DecodeContext<'a, 'tcx> { |
| fn specialized_decode(&mut self) -> Result<Lazy<T>, Self::Error> { |
| Ok(Lazy::with_position(self.read_lazy_distance(Lazy::<T>::min_size())?)) |
| } |
| } |
| |
| impl<'a, 'tcx, T> SpecializedDecoder<LazySeq<T>> for DecodeContext<'a, 'tcx> { |
| fn specialized_decode(&mut self) -> Result<LazySeq<T>, Self::Error> { |
| let len = self.read_usize()?; |
| let position = if len == 0 { |
| 0 |
| } else { |
| self.read_lazy_distance(LazySeq::<T>::min_size(len))? |
| }; |
| Ok(LazySeq::with_position_and_length(position, len)) |
| } |
| } |
| |
| |
| impl<'a, 'tcx> SpecializedDecoder<DefId> for DecodeContext<'a, 'tcx> { |
| #[inline] |
| fn specialized_decode(&mut self) -> Result<DefId, Self::Error> { |
| let krate = CrateNum::decode(self)?; |
| let index = DefIndex::decode(self)?; |
| |
| Ok(DefId { |
| krate, |
| index, |
| }) |
| } |
| } |
| |
| impl<'a, 'tcx> SpecializedDecoder<DefIndex> for DecodeContext<'a, 'tcx> { |
| #[inline] |
| fn specialized_decode(&mut self) -> Result<DefIndex, Self::Error> { |
| Ok(DefIndex::from_raw_u32(self.read_u32()?)) |
| } |
| } |
| |
| impl<'a, 'tcx> SpecializedDecoder<LocalDefId> for DecodeContext<'a, 'tcx> { |
| #[inline] |
| fn specialized_decode(&mut self) -> Result<LocalDefId, Self::Error> { |
| self.specialized_decode().map(|i| LocalDefId::from_def_id(i)) |
| } |
| } |
| |
| impl<'a, 'tcx> SpecializedDecoder<interpret::AllocId> for DecodeContext<'a, 'tcx> { |
| fn specialized_decode(&mut self) -> Result<interpret::AllocId, Self::Error> { |
| let tcx = self.tcx.unwrap(); |
| let idx = usize::decode(self)?; |
| |
| if let Some(cached) = self.interpret_alloc_cache.get(&idx).cloned() { |
| return Ok(cached); |
| } |
| let pos = self.interpret_alloc(idx); |
| self.with_position(pos, |this| { |
| interpret::specialized_decode_alloc_id( |
| this, |
| tcx, |
| |this, alloc_id| { |
| assert!(this.interpret_alloc_cache.insert(idx, alloc_id).is_none()); |
| }, |
| ) |
| }) |
| } |
| } |
| |
| impl<'a, 'tcx> SpecializedDecoder<Span> for DecodeContext<'a, 'tcx> { |
| fn specialized_decode(&mut self) -> Result<Span, Self::Error> { |
| let tag = u8::decode(self)?; |
| |
| if tag == TAG_INVALID_SPAN { |
| return Ok(DUMMY_SP) |
| } |
| |
| debug_assert_eq!(tag, TAG_VALID_SPAN); |
| |
| let lo = BytePos::decode(self)?; |
| let len = BytePos::decode(self)?; |
| let hi = lo + len; |
| |
| let sess = if let Some(sess) = self.sess { |
| sess |
| } else { |
| bug!("Cannot decode Span without Session.") |
| }; |
| |
| let imported_filemaps = self.cdata().imported_filemaps(&sess.codemap()); |
| let filemap = { |
| // Optimize for the case that most spans within a translated item |
| // originate from the same filemap. |
| let last_filemap = &imported_filemaps[self.last_filemap_index]; |
| |
| if lo >= last_filemap.original_start_pos && |
| lo <= last_filemap.original_end_pos { |
| last_filemap |
| } else { |
| let mut a = 0; |
| let mut b = imported_filemaps.len(); |
| |
| while b - a > 1 { |
| let m = (a + b) / 2; |
| if imported_filemaps[m].original_start_pos > lo { |
| b = m; |
| } else { |
| a = m; |
| } |
| } |
| |
| self.last_filemap_index = a; |
| &imported_filemaps[a] |
| } |
| }; |
| |
| // Make sure our binary search above is correct. |
| debug_assert!(lo >= filemap.original_start_pos && |
| lo <= filemap.original_end_pos); |
| |
| // Make sure we correctly filtered out invalid spans during encoding |
| debug_assert!(hi >= filemap.original_start_pos && |
| hi <= filemap.original_end_pos); |
| |
| let lo = (lo + filemap.translated_filemap.start_pos) - filemap.original_start_pos; |
| let hi = (hi + filemap.translated_filemap.start_pos) - filemap.original_start_pos; |
| |
| Ok(Span::new(lo, hi, NO_EXPANSION)) |
| } |
| } |
| |
| impl<'a, 'tcx> SpecializedDecoder<Fingerprint> for DecodeContext<'a, 'tcx> { |
| fn specialized_decode(&mut self) -> Result<Fingerprint, Self::Error> { |
| Fingerprint::decode_opaque(&mut self.opaque) |
| } |
| } |
| |
| impl<'a, 'tcx, T: Decodable> SpecializedDecoder<mir::ClearCrossCrate<T>> |
| for DecodeContext<'a, 'tcx> { |
| #[inline] |
| fn specialized_decode(&mut self) -> Result<mir::ClearCrossCrate<T>, Self::Error> { |
| Ok(mir::ClearCrossCrate::Clear) |
| } |
| } |
| |
| implement_ty_decoder!( DecodeContext<'a, 'tcx> ); |
| |
| impl<'a, 'tcx> MetadataBlob { |
| pub fn is_compatible(&self) -> bool { |
| self.raw_bytes().starts_with(METADATA_HEADER) |
| } |
| |
| pub fn get_rustc_version(&self) -> String { |
| Lazy::with_position(METADATA_HEADER.len() + 4).decode(self) |
| } |
| |
| pub fn get_root(&self) -> CrateRoot { |
| let slice = self.raw_bytes(); |
| let offset = METADATA_HEADER.len(); |
| let pos = (((slice[offset + 0] as u32) << 24) | ((slice[offset + 1] as u32) << 16) | |
| ((slice[offset + 2] as u32) << 8) | |
| ((slice[offset + 3] as u32) << 0)) as usize; |
| Lazy::with_position(pos).decode(self) |
| } |
| |
| pub fn list_crate_metadata(&self, |
| out: &mut io::Write) -> io::Result<()> { |
| write!(out, "=External Dependencies=\n")?; |
| let root = self.get_root(); |
| for (i, dep) in root.crate_deps |
| .decode(self) |
| .enumerate() { |
| write!(out, "{} {}-{}\n", i + 1, dep.name, dep.hash)?; |
| } |
| write!(out, "\n")?; |
| Ok(()) |
| } |
| } |
| |
| impl<'tcx> EntryKind<'tcx> { |
| fn to_def(&self, did: DefId) -> Option<Def> { |
| Some(match *self { |
| EntryKind::Const(_) => Def::Const(did), |
| EntryKind::AssociatedConst(..) => Def::AssociatedConst(did), |
| EntryKind::ImmStatic | |
| EntryKind::ForeignImmStatic => Def::Static(did, false), |
| EntryKind::MutStatic | |
| EntryKind::ForeignMutStatic => Def::Static(did, true), |
| EntryKind::Struct(_, _) => Def::Struct(did), |
| EntryKind::Union(_, _) => Def::Union(did), |
| EntryKind::Fn(_) | |
| EntryKind::ForeignFn(_) => Def::Fn(did), |
| EntryKind::Method(_) => Def::Method(did), |
| EntryKind::Type => Def::TyAlias(did), |
| EntryKind::AssociatedType(_) => Def::AssociatedTy(did), |
| EntryKind::Mod(_) => Def::Mod(did), |
| EntryKind::Variant(_) => Def::Variant(did), |
| EntryKind::Trait(_) => Def::Trait(did), |
| EntryKind::Enum(..) => Def::Enum(did), |
| EntryKind::MacroDef(_) => Def::Macro(did, MacroKind::Bang), |
| EntryKind::GlobalAsm => Def::GlobalAsm(did), |
| EntryKind::ForeignType => Def::TyForeign(did), |
| |
| EntryKind::ForeignMod | |
| EntryKind::Impl(_) | |
| EntryKind::Field | |
| EntryKind::Generator(_) | |
| EntryKind::Closure(_) => return None, |
| }) |
| } |
| } |
| |
| impl<'a, 'tcx> CrateMetadata { |
| fn is_proc_macro(&self, id: DefIndex) -> bool { |
| self.proc_macros.is_some() && id != CRATE_DEF_INDEX |
| } |
| |
| fn maybe_entry(&self, item_id: DefIndex) -> Option<Lazy<Entry<'tcx>>> { |
| assert!(!self.is_proc_macro(item_id)); |
| self.root.index.lookup(self.blob.raw_bytes(), item_id) |
| } |
| |
| fn entry(&self, item_id: DefIndex) -> Entry<'tcx> { |
| match self.maybe_entry(item_id) { |
| None => { |
| bug!("entry: id not found: {:?} in crate {:?} with number {}", |
| item_id, |
| self.name, |
| self.cnum) |
| } |
| Some(d) => d.decode(self), |
| } |
| } |
| |
| fn local_def_id(&self, index: DefIndex) -> DefId { |
| DefId { |
| krate: self.cnum, |
| index, |
| } |
| } |
| |
| pub fn item_name(&self, item_index: DefIndex) -> InternedString { |
| self.def_key(item_index) |
| .disambiguated_data |
| .data |
| .get_opt_name() |
| .expect("no name in item_name") |
| } |
| |
| pub fn get_def(&self, index: DefIndex) -> Option<Def> { |
| if !self.is_proc_macro(index) { |
| self.entry(index).kind.to_def(self.local_def_id(index)) |
| } else { |
| let kind = self.proc_macros.as_ref().unwrap()[index.to_proc_macro_index()].1.kind(); |
| Some(Def::Macro(self.local_def_id(index), kind)) |
| } |
| } |
| |
| pub fn get_span(&self, index: DefIndex, sess: &Session) -> Span { |
| match self.is_proc_macro(index) { |
| true => DUMMY_SP, |
| false => self.entry(index).span.decode((self, sess)), |
| } |
| } |
| |
| pub fn get_trait_def(&self, item_id: DefIndex, sess: &Session) -> ty::TraitDef { |
| let data = match self.entry(item_id).kind { |
| EntryKind::Trait(data) => data.decode((self, sess)), |
| _ => bug!(), |
| }; |
| |
| ty::TraitDef::new(self.local_def_id(item_id), |
| data.unsafety, |
| data.paren_sugar, |
| data.has_auto_impl, |
| self.def_path_table.def_path_hash(item_id)) |
| } |
| |
| fn get_variant(&self, item: &Entry, index: DefIndex) -> ty::VariantDef { |
| let data = match item.kind { |
| EntryKind::Variant(data) | |
| EntryKind::Struct(data, _) | |
| EntryKind::Union(data, _) => data.decode(self), |
| _ => bug!(), |
| }; |
| |
| ty::VariantDef { |
| did: self.local_def_id(data.struct_ctor.unwrap_or(index)), |
| name: Symbol::intern(&self.item_name(index)), |
| fields: item.children.decode(self).map(|index| { |
| let f = self.entry(index); |
| ty::FieldDef { |
| did: self.local_def_id(index), |
| name: Symbol::intern(&self.item_name(index)), |
| vis: f.visibility.decode(self) |
| } |
| }).collect(), |
| discr: data.discr, |
| ctor_kind: data.ctor_kind, |
| } |
| } |
| |
| pub fn get_adt_def(&self, |
| item_id: DefIndex, |
| tcx: TyCtxt<'a, 'tcx, 'tcx>) |
| -> &'tcx ty::AdtDef { |
| let item = self.entry(item_id); |
| let did = self.local_def_id(item_id); |
| let kind = match item.kind { |
| EntryKind::Enum(_) => ty::AdtKind::Enum, |
| EntryKind::Struct(_, _) => ty::AdtKind::Struct, |
| EntryKind::Union(_, _) => ty::AdtKind::Union, |
| _ => bug!("get_adt_def called on a non-ADT {:?}", did), |
| }; |
| let variants = if let ty::AdtKind::Enum = kind { |
| item.children |
| .decode(self) |
| .map(|index| { |
| self.get_variant(&self.entry(index), index) |
| }) |
| .collect() |
| } else { |
| vec![self.get_variant(&item, item_id)] |
| }; |
| let (kind, repr) = match item.kind { |
| EntryKind::Enum(repr) => (ty::AdtKind::Enum, repr), |
| EntryKind::Struct(_, repr) => (ty::AdtKind::Struct, repr), |
| EntryKind::Union(_, repr) => (ty::AdtKind::Union, repr), |
| _ => bug!("get_adt_def called on a non-ADT {:?}", did), |
| }; |
| |
| tcx.alloc_adt_def(did, kind, variants, repr) |
| } |
| |
| pub fn get_predicates(&self, |
| item_id: DefIndex, |
| tcx: TyCtxt<'a, 'tcx, 'tcx>) |
| -> ty::GenericPredicates<'tcx> { |
| self.entry(item_id).predicates.unwrap().decode((self, tcx)) |
| } |
| |
| pub fn get_super_predicates(&self, |
| item_id: DefIndex, |
| tcx: TyCtxt<'a, 'tcx, 'tcx>) |
| -> ty::GenericPredicates<'tcx> { |
| match self.entry(item_id).kind { |
| EntryKind::Trait(data) => data.decode(self).super_predicates.decode((self, tcx)), |
| _ => bug!(), |
| } |
| } |
| |
| pub fn get_generics(&self, |
| item_id: DefIndex, |
| sess: &Session) |
| -> ty::Generics { |
| self.entry(item_id).generics.unwrap().decode((self, sess)) |
| } |
| |
| pub fn get_type(&self, id: DefIndex, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Ty<'tcx> { |
| self.entry(id).ty.unwrap().decode((self, tcx)) |
| } |
| |
| pub fn get_stability(&self, id: DefIndex) -> Option<attr::Stability> { |
| match self.is_proc_macro(id) { |
| true => None, |
| false => self.entry(id).stability.map(|stab| stab.decode(self)), |
| } |
| } |
| |
| pub fn get_deprecation(&self, id: DefIndex) -> Option<attr::Deprecation> { |
| match self.is_proc_macro(id) { |
| true => None, |
| false => self.entry(id).deprecation.map(|depr| depr.decode(self)), |
| } |
| } |
| |
| pub fn get_visibility(&self, id: DefIndex) -> ty::Visibility { |
| match self.is_proc_macro(id) { |
| true => ty::Visibility::Public, |
| false => self.entry(id).visibility.decode(self), |
| } |
| } |
| |
| fn get_impl_data(&self, id: DefIndex) -> ImplData<'tcx> { |
| match self.entry(id).kind { |
| EntryKind::Impl(data) => data.decode(self), |
| _ => bug!(), |
| } |
| } |
| |
| pub fn get_parent_impl(&self, id: DefIndex) -> Option<DefId> { |
| self.get_impl_data(id).parent_impl |
| } |
| |
| pub fn get_impl_polarity(&self, id: DefIndex) -> hir::ImplPolarity { |
| self.get_impl_data(id).polarity |
| } |
| |
| pub fn get_impl_defaultness(&self, id: DefIndex) -> hir::Defaultness { |
| self.get_impl_data(id).defaultness |
| } |
| |
| pub fn get_coerce_unsized_info(&self, |
| id: DefIndex) |
| -> Option<ty::adjustment::CoerceUnsizedInfo> { |
| self.get_impl_data(id).coerce_unsized_info |
| } |
| |
| pub fn get_impl_trait(&self, |
| id: DefIndex, |
| tcx: TyCtxt<'a, 'tcx, 'tcx>) |
| -> Option<ty::TraitRef<'tcx>> { |
| self.get_impl_data(id).trait_ref.map(|tr| tr.decode((self, tcx))) |
| } |
| |
| /// Iterates over the language items in the given crate. |
| pub fn get_lang_items(&self) -> Vec<(DefId, usize)> { |
| self.root |
| .lang_items |
| .decode(self) |
| .map(|(def_index, index)| (self.local_def_id(def_index), index)) |
| .collect() |
| } |
| |
| /// Iterates over each child of the given item. |
| pub fn each_child_of_item<F>(&self, id: DefIndex, mut callback: F, sess: &Session) |
| where F: FnMut(def::Export) |
| { |
| if let Some(ref proc_macros) = self.proc_macros { |
| if id == CRATE_DEF_INDEX { |
| for (id, &(name, ref ext)) in proc_macros.iter().enumerate() { |
| let def = Def::Macro( |
| DefId { |
| krate: self.cnum, |
| index: DefIndex::from_proc_macro_index(id), |
| }, |
| ext.kind() |
| ); |
| let ident = Ident::with_empty_ctxt(name); |
| callback(def::Export { |
| ident: ident, |
| def: def, |
| vis: ty::Visibility::Public, |
| span: DUMMY_SP, |
| is_import: false, |
| }); |
| } |
| } |
| return |
| } |
| |
| // Find the item. |
| let item = match self.maybe_entry(id) { |
| None => return, |
| Some(item) => item.decode((self, sess)), |
| }; |
| |
| // Iterate over all children. |
| let macros_only = self.dep_kind.lock().macros_only(); |
| for child_index in item.children.decode((self, sess)) { |
| if macros_only { |
| continue |
| } |
| |
| // Get the item. |
| if let Some(child) = self.maybe_entry(child_index) { |
| let child = child.decode((self, sess)); |
| match child.kind { |
| EntryKind::MacroDef(..) => {} |
| _ if macros_only => continue, |
| _ => {} |
| } |
| |
| // Hand off the item to the callback. |
| match child.kind { |
| // FIXME(eddyb) Don't encode these in children. |
| EntryKind::ForeignMod => { |
| for child_index in child.children.decode((self, sess)) { |
| if let Some(def) = self.get_def(child_index) { |
| callback(def::Export { |
| def, |
| ident: Ident::from_str(&self.item_name(child_index)), |
| vis: self.get_visibility(child_index), |
| span: self.entry(child_index).span.decode((self, sess)), |
| is_import: false, |
| }); |
| } |
| } |
| continue; |
| } |
| EntryKind::Impl(_) => continue, |
| |
| _ => {} |
| } |
| |
| let def_key = self.def_key(child_index); |
| let span = child.span.decode((self, sess)); |
| if let (Some(def), Some(name)) = |
| (self.get_def(child_index), def_key.disambiguated_data.data.get_opt_name()) { |
| let ident = Ident::from_str(&name); |
| let vis = self.get_visibility(child_index); |
| let is_import = false; |
| callback(def::Export { def, ident, vis, span, is_import }); |
| // For non-re-export structs and variants add their constructors to children. |
| // Re-export lists automatically contain constructors when necessary. |
| match def { |
| Def::Struct(..) => { |
| if let Some(ctor_def_id) = self.get_struct_ctor_def_id(child_index) { |
| let ctor_kind = self.get_ctor_kind(child_index); |
| let ctor_def = Def::StructCtor(ctor_def_id, ctor_kind); |
| callback(def::Export { |
| def: ctor_def, |
| vis: self.get_visibility(ctor_def_id.index), |
| ident, span, is_import, |
| }); |
| } |
| } |
| Def::Variant(def_id) => { |
| // Braced variants, unlike structs, generate unusable names in |
| // value namespace, they are reserved for possible future use. |
| let ctor_kind = self.get_ctor_kind(child_index); |
| let ctor_def = Def::VariantCtor(def_id, ctor_kind); |
| let vis = self.get_visibility(child_index); |
| callback(def::Export { def: ctor_def, ident, vis, span, is_import }); |
| } |
| _ => {} |
| } |
| } |
| } |
| } |
| |
| if let EntryKind::Mod(data) = item.kind { |
| for exp in data.decode((self, sess)).reexports.decode((self, sess)) { |
| match exp.def { |
| Def::Macro(..) => {} |
| _ if macros_only => continue, |
| _ => {} |
| } |
| callback(exp); |
| } |
| } |
| } |
| |
| pub fn extern_const_body(&self, |
| tcx: TyCtxt<'a, 'tcx, 'tcx>, |
| id: DefIndex) |
| -> ExternConstBody<'tcx> { |
| assert!(!self.is_proc_macro(id)); |
| let ast = self.entry(id).ast.unwrap(); |
| let def_id = self.local_def_id(id); |
| let ast = ast.decode((self, tcx)); |
| let body = ast.body.decode((self, tcx)); |
| ExternConstBody { |
| body: tcx.hir.intern_inlined_body(def_id, body), |
| fingerprint: ast.stable_bodies_hash, |
| } |
| } |
| |
| pub fn item_body_tables(&self, |
| id: DefIndex, |
| tcx: TyCtxt<'a, 'tcx, 'tcx>) |
| -> &'tcx ty::TypeckTables<'tcx> { |
| let ast = self.entry(id).ast.unwrap().decode(self); |
| tcx.alloc_tables(ast.tables.decode((self, tcx))) |
| } |
| |
| pub fn item_body_nested_bodies(&self, |
| tcx: TyCtxt<'a, 'tcx, 'tcx>, |
| id: DefIndex) |
| -> ExternBodyNestedBodies { |
| if let Some(ref ast) = self.entry(id).ast { |
| let mut ast = ast.decode(self); |
| let nested_bodies: BTreeMap<_, _> = ast.nested_bodies |
| .decode((self, tcx.sess)) |
| .map(|body| (body.id(), body)) |
| .collect(); |
| ExternBodyNestedBodies { |
| nested_bodies: Lrc::new(nested_bodies), |
| fingerprint: ast.stable_bodies_hash, |
| } |
| } else { |
| ExternBodyNestedBodies { |
| nested_bodies: Lrc::new(BTreeMap::new()), |
| fingerprint: Fingerprint::ZERO, |
| } |
| } |
| } |
| |
| pub fn const_is_rvalue_promotable_to_static(&self, id: DefIndex) -> bool { |
| self.entry(id).ast.expect("const item missing `ast`") |
| .decode(self).rvalue_promotable_to_static |
| } |
| |
| pub fn is_item_mir_available(&self, id: DefIndex) -> bool { |
| !self.is_proc_macro(id) && |
| self.maybe_entry(id).and_then(|item| item.decode(self).mir).is_some() |
| } |
| |
| pub fn maybe_get_optimized_mir(&self, |
| tcx: TyCtxt<'a, 'tcx, 'tcx>, |
| id: DefIndex) |
| -> Option<Mir<'tcx>> { |
| match self.is_proc_macro(id) { |
| true => None, |
| false => self.entry(id).mir.map(|mir| mir.decode((self, tcx))), |
| } |
| } |
| |
| pub fn mir_const_qualif(&self, id: DefIndex) -> u8 { |
| match self.entry(id).kind { |
| EntryKind::Const(qualif) | |
| EntryKind::AssociatedConst(AssociatedContainer::ImplDefault, qualif) | |
| EntryKind::AssociatedConst(AssociatedContainer::ImplFinal, qualif) => { |
| qualif |
| } |
| _ => bug!(), |
| } |
| } |
| |
| pub fn get_associated_item(&self, id: DefIndex) -> ty::AssociatedItem { |
| let item = self.entry(id); |
| let def_key = self.def_key(id); |
| let parent = self.local_def_id(def_key.parent.unwrap()); |
| let name = def_key.disambiguated_data.data.get_opt_name().unwrap(); |
| |
| let (kind, container, has_self) = match item.kind { |
| EntryKind::AssociatedConst(container, _) => { |
| (ty::AssociatedKind::Const, container, false) |
| } |
| EntryKind::Method(data) => { |
| let data = data.decode(self); |
| (ty::AssociatedKind::Method, data.container, data.has_self) |
| } |
| EntryKind::AssociatedType(container) => { |
| (ty::AssociatedKind::Type, container, false) |
| } |
| _ => bug!("cannot get associated-item of `{:?}`", def_key) |
| }; |
| |
| ty::AssociatedItem { |
| name: Symbol::intern(&name), |
| kind, |
| vis: item.visibility.decode(self), |
| defaultness: container.defaultness(), |
| def_id: self.local_def_id(id), |
| container: container.with_def_id(parent), |
| method_has_self_argument: has_self |
| } |
| } |
| |
| pub fn get_item_variances(&self, id: DefIndex) -> Vec<ty::Variance> { |
| self.entry(id).variances.decode(self).collect() |
| } |
| |
| pub fn get_ctor_kind(&self, node_id: DefIndex) -> CtorKind { |
| match self.entry(node_id).kind { |
| EntryKind::Struct(data, _) | |
| EntryKind::Union(data, _) | |
| EntryKind::Variant(data) => data.decode(self).ctor_kind, |
| _ => CtorKind::Fictive, |
| } |
| } |
| |
| pub fn get_struct_ctor_def_id(&self, node_id: DefIndex) -> Option<DefId> { |
| match self.entry(node_id).kind { |
| EntryKind::Struct(data, _) => { |
| data.decode(self).struct_ctor.map(|index| self.local_def_id(index)) |
| } |
| _ => None, |
| } |
| } |
| |
| pub fn get_item_attrs(&self, node_id: DefIndex, sess: &Session) -> Lrc<[ast::Attribute]> { |
| let (node_as, node_index) = |
| (node_id.address_space().index(), node_id.as_array_index()); |
| if self.is_proc_macro(node_id) { |
| return Lrc::new([]); |
| } |
| |
| if let Some(&Some(ref val)) = |
| self.attribute_cache.borrow()[node_as].get(node_index) { |
| return val.clone(); |
| } |
| |
| // The attributes for a tuple struct are attached to the definition, not the ctor; |
| // we assume that someone passing in a tuple struct ctor is actually wanting to |
| // look at the definition |
| let mut item = self.entry(node_id); |
| let def_key = self.def_key(node_id); |
| if def_key.disambiguated_data.data == DefPathData::StructCtor { |
| item = self.entry(def_key.parent.unwrap()); |
| } |
| let result: Lrc<[ast::Attribute]> = Lrc::from(self.get_attributes(&item, sess)); |
| let vec_ = &mut self.attribute_cache.borrow_mut()[node_as]; |
| if vec_.len() < node_index + 1 { |
| vec_.resize(node_index + 1, None); |
| } |
| // This can overwrite the result produced by another thread, but the value |
| // written should be the same |
| vec_[node_index] = Some(result.clone()); |
| result |
| } |
| |
| pub fn get_struct_field_names(&self, id: DefIndex) -> Vec<ast::Name> { |
| self.entry(id) |
| .children |
| .decode(self) |
| .map(|index| Symbol::intern(&self.item_name(index))) |
| .collect() |
| } |
| |
| fn get_attributes(&self, item: &Entry<'tcx>, sess: &Session) -> Vec<ast::Attribute> { |
| item.attributes |
| .decode((self, sess)) |
| .map(|mut attr| { |
| // Need new unique IDs: old thread-local IDs won't map to new threads. |
| attr.id = attr::mk_attr_id(); |
| attr |
| }) |
| .collect() |
| } |
| |
| // Translate a DefId from the current compilation environment to a DefId |
| // for an external crate. |
| fn reverse_translate_def_id(&self, did: DefId) -> Option<DefId> { |
| for (local, &global) in self.cnum_map.borrow().iter_enumerated() { |
| if global == did.krate { |
| return Some(DefId { |
| krate: local, |
| index: did.index, |
| }); |
| } |
| } |
| |
| None |
| } |
| |
| pub fn get_inherent_implementations_for_type(&self, id: DefIndex) -> Vec<DefId> { |
| self.entry(id) |
| .inherent_impls |
| .decode(self) |
| .map(|index| self.local_def_id(index)) |
| .collect() |
| } |
| |
| pub fn get_implementations_for_trait(&self, |
| filter: Option<DefId>, |
| result: &mut Vec<DefId>) { |
| // Do a reverse lookup beforehand to avoid touching the crate_num |
| // hash map in the loop below. |
| let filter = match filter.map(|def_id| self.reverse_translate_def_id(def_id)) { |
| Some(Some(def_id)) => Some((def_id.krate.as_u32(), def_id.index)), |
| Some(None) => return, |
| None if self.proc_macros.is_some() => return, |
| None => None, |
| }; |
| |
| if let Some(filter) = filter { |
| if let Some(impls) = self.trait_impls |
| .get(&filter) { |
| result.extend(impls.decode(self).map(|idx| self.local_def_id(idx))); |
| } |
| } else { |
| for impls in self.trait_impls.values() { |
| result.extend(impls.decode(self).map(|idx| self.local_def_id(idx))); |
| } |
| } |
| } |
| |
| pub fn get_trait_of_item(&self, id: DefIndex) -> Option<DefId> { |
| self.def_key(id).parent.and_then(|parent_index| { |
| match self.entry(parent_index).kind { |
| EntryKind::Trait(_) => Some(self.local_def_id(parent_index)), |
| _ => None, |
| } |
| }) |
| } |
| |
| |
| pub fn get_native_libraries(&self, sess: &Session) -> Vec<NativeLibrary> { |
| self.root.native_libraries.decode((self, sess)).collect() |
| } |
| |
| pub fn get_foreign_modules(&self, sess: &Session) -> Vec<ForeignModule> { |
| self.root.foreign_modules.decode((self, sess)).collect() |
| } |
| |
| pub fn get_dylib_dependency_formats(&self) -> Vec<(CrateNum, LinkagePreference)> { |
| self.root |
| .dylib_dependency_formats |
| .decode(self) |
| .enumerate() |
| .flat_map(|(i, link)| { |
| let cnum = CrateNum::new(i + 1); |
| link.map(|link| (self.cnum_map.borrow()[cnum], link)) |
| }) |
| .collect() |
| } |
| |
| pub fn get_missing_lang_items(&self) -> Vec<lang_items::LangItem> { |
| self.root |
| .lang_items_missing |
| .decode(self) |
| .collect() |
| } |
| |
| pub fn get_fn_arg_names(&self, id: DefIndex) -> Vec<ast::Name> { |
| let arg_names = match self.entry(id).kind { |
| EntryKind::Fn(data) | |
| EntryKind::ForeignFn(data) => data.decode(self).arg_names, |
| EntryKind::Method(data) => data.decode(self).fn_data.arg_names, |
| _ => LazySeq::empty(), |
| }; |
| arg_names.decode(self).collect() |
| } |
| |
| pub fn exported_symbols(&self, |
| tcx: TyCtxt<'a, 'tcx, 'tcx>) |
| -> Vec<(ExportedSymbol<'tcx>, SymbolExportLevel)> { |
| let lazy_seq: LazySeq<(ExportedSymbol<'tcx>, SymbolExportLevel)> = |
| LazySeq::with_position_and_length(self.root.exported_symbols.position, |
| self.root.exported_symbols.len); |
| lazy_seq.decode((self, tcx)).collect() |
| } |
| |
| pub fn wasm_custom_sections(&self) -> Vec<DefId> { |
| let sections = self.root |
| .wasm_custom_sections |
| .decode(self) |
| .map(|def_index| self.local_def_id(def_index)) |
| .collect::<Vec<_>>(); |
| info!("loaded wasm sections {:?}", sections); |
| return sections |
| } |
| |
| pub fn get_macro(&self, id: DefIndex) -> (InternedString, MacroDef) { |
| let entry = self.entry(id); |
| match entry.kind { |
| EntryKind::MacroDef(macro_def) => (self.item_name(id), macro_def.decode(self)), |
| _ => bug!(), |
| } |
| } |
| |
| pub fn is_const_fn(&self, id: DefIndex) -> bool { |
| let constness = match self.entry(id).kind { |
| EntryKind::Method(data) => data.decode(self).fn_data.constness, |
| EntryKind::Fn(data) => data.decode(self).constness, |
| _ => hir::Constness::NotConst, |
| }; |
| constness == hir::Constness::Const |
| } |
| |
| pub fn is_foreign_item(&self, id: DefIndex) -> bool { |
| match self.entry(id).kind { |
| EntryKind::ForeignImmStatic | |
| EntryKind::ForeignMutStatic | |
| EntryKind::ForeignFn(_) => true, |
| _ => false, |
| } |
| } |
| |
| pub fn fn_sig(&self, |
| id: DefIndex, |
| tcx: TyCtxt<'a, 'tcx, 'tcx>) |
| -> ty::PolyFnSig<'tcx> { |
| let sig = match self.entry(id).kind { |
| EntryKind::Fn(data) | |
| EntryKind::ForeignFn(data) => data.decode(self).sig, |
| EntryKind::Method(data) => data.decode(self).fn_data.sig, |
| EntryKind::Variant(data) | |
| EntryKind::Struct(data, _) => data.decode(self).ctor_sig.unwrap(), |
| EntryKind::Closure(data) => data.decode(self).sig, |
| _ => bug!(), |
| }; |
| sig.decode((self, tcx)) |
| } |
| |
| #[inline] |
| pub fn def_key(&self, index: DefIndex) -> DefKey { |
| if !self.is_proc_macro(index) { |
| self.def_path_table.def_key(index) |
| } else { |
| // FIXME(#49271) - It would be better if the DefIds were consistent |
| // with the DefPathTable, but for proc-macro crates |
| // they aren't. |
| let name = self.proc_macros |
| .as_ref() |
| .unwrap()[index.to_proc_macro_index()].0; |
| DefKey { |
| parent: Some(CRATE_DEF_INDEX), |
| disambiguated_data: DisambiguatedDefPathData { |
| data: DefPathData::MacroDef(name.as_str()), |
| disambiguator: 0, |
| } |
| } |
| } |
| } |
| |
| // Returns the path leading to the thing with this `id`. |
| pub fn def_path(&self, id: DefIndex) -> DefPath { |
| debug!("def_path(id={:?})", id); |
| DefPath::make(self.cnum, id, |parent| self.def_path_table.def_key(parent)) |
| } |
| |
| #[inline] |
| pub fn def_path_hash(&self, index: DefIndex) -> DefPathHash { |
| self.def_path_table.def_path_hash(index) |
| } |
| |
| /// Imports the codemap from an external crate into the codemap of the crate |
| /// currently being compiled (the "local crate"). |
| /// |
| /// The import algorithm works analogous to how AST items are inlined from an |
| /// external crate's metadata: |
| /// For every FileMap in the external codemap an 'inline' copy is created in the |
| /// local codemap. The correspondence relation between external and local |
| /// FileMaps is recorded in the `ImportedFileMap` objects returned from this |
| /// function. When an item from an external crate is later inlined into this |
| /// crate, this correspondence information is used to translate the span |
| /// information of the inlined item so that it refers the correct positions in |
| /// the local codemap (see `<decoder::DecodeContext as SpecializedDecoder<Span>>`). |
| /// |
| /// The import algorithm in the function below will reuse FileMaps already |
| /// existing in the local codemap. For example, even if the FileMap of some |
| /// source file of libstd gets imported many times, there will only ever be |
| /// one FileMap object for the corresponding file in the local codemap. |
| /// |
| /// Note that imported FileMaps do not actually contain the source code of the |
| /// file they represent, just information about length, line breaks, and |
| /// multibyte characters. This information is enough to generate valid debuginfo |
| /// for items inlined from other crates. |
| pub fn imported_filemaps(&'a self, |
| local_codemap: &codemap::CodeMap) |
| -> ReadGuard<'a, Vec<cstore::ImportedFileMap>> { |
| { |
| let filemaps = self.codemap_import_info.borrow(); |
| if !filemaps.is_empty() { |
| return filemaps; |
| } |
| } |
| |
| // Lock the codemap_import_info to ensure this only happens once |
| let mut codemap_import_info = self.codemap_import_info.borrow_mut(); |
| |
| if !codemap_import_info.is_empty() { |
| drop(codemap_import_info); |
| return self.codemap_import_info.borrow(); |
| } |
| |
| let external_codemap = self.root.codemap.decode(self); |
| |
| let imported_filemaps = external_codemap.map(|filemap_to_import| { |
| // We can't reuse an existing FileMap, so allocate a new one |
| // containing the information we need. |
| let syntax_pos::FileMap { name, |
| name_was_remapped, |
| src_hash, |
| start_pos, |
| end_pos, |
| lines, |
| multibyte_chars, |
| non_narrow_chars, |
| name_hash, |
| .. } = filemap_to_import; |
| |
| let source_length = (end_pos - start_pos).to_usize(); |
| |
| // Translate line-start positions and multibyte character |
| // position into frame of reference local to file. |
| // `CodeMap::new_imported_filemap()` will then translate those |
| // coordinates to their new global frame of reference when the |
| // offset of the FileMap is known. |
| let mut lines = lines.into_inner(); |
| for pos in &mut lines { |
| *pos = *pos - start_pos; |
| } |
| let mut multibyte_chars = multibyte_chars.into_inner(); |
| for mbc in &mut multibyte_chars { |
| mbc.pos = mbc.pos - start_pos; |
| } |
| let mut non_narrow_chars = non_narrow_chars.into_inner(); |
| for swc in &mut non_narrow_chars { |
| *swc = *swc - start_pos; |
| } |
| |
| let local_version = local_codemap.new_imported_filemap(name, |
| name_was_remapped, |
| self.cnum.as_u32(), |
| src_hash, |
| name_hash, |
| source_length, |
| lines, |
| multibyte_chars, |
| non_narrow_chars); |
| debug!("CrateMetaData::imported_filemaps alloc \ |
| filemap {:?} original (start_pos {:?} end_pos {:?}) \ |
| translated (start_pos {:?} end_pos {:?})", |
| local_version.name, start_pos, end_pos, |
| local_version.start_pos, local_version.end_pos); |
| |
| cstore::ImportedFileMap { |
| original_start_pos: start_pos, |
| original_end_pos: end_pos, |
| translated_filemap: local_version, |
| } |
| }).collect(); |
| |
| *codemap_import_info = imported_filemaps; |
| drop(codemap_import_info); |
| |
| // This shouldn't borrow twice, but there is no way to downgrade RefMut to Ref. |
| self.codemap_import_info.borrow() |
| } |
| } |