]> git.lizzy.rs Git - rust.git/blob - src/librustc_metadata/decoder.rs
Nuke the entire ctfe from orbit, it's the only way to be sure
[rust.git] / src / librustc_metadata / decoder.rs
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.
4 //
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
10
11 // Decoding metadata from a single crate's metadata
12
13 use cstore::{self, CrateMetadata, MetadataBlob, NativeLibrary};
14 use schema::*;
15
16 use rustc_data_structures::sync::Lrc;
17 use rustc::hir::map::{DefKey, DefPath, DefPathData, DefPathHash};
18 use rustc::hir;
19 use rustc::middle::cstore::{LinkagePreference, ExternConstBody,
20                             ExternBodyNestedBodies};
21 use rustc::middle::exported_symbols::{ExportedSymbol, SymbolExportLevel};
22 use rustc::hir::def::{self, Def, CtorKind};
23 use rustc::hir::def_id::{CrateNum, DefId, DefIndex,
24                          CRATE_DEF_INDEX, LOCAL_CRATE};
25 use rustc::ich::Fingerprint;
26 use rustc::middle::lang_items;
27 use rustc::mir::{self, interpret};
28 use rustc::session::Session;
29 use rustc::ty::{self, Ty, TyCtxt};
30 use rustc::ty::codec::TyDecoder;
31 use rustc::mir::Mir;
32 use rustc::util::nodemap::FxHashMap;
33
34 use std::cell::Ref;
35 use std::collections::BTreeMap;
36 use std::io;
37 use std::mem;
38 use std::u32;
39
40 use rustc_serialize::{Decodable, Decoder, SpecializedDecoder, opaque};
41 use syntax::attr;
42 use syntax::ast::{self, Ident};
43 use syntax::codemap;
44 use syntax::symbol::{InternedString, Symbol};
45 use syntax::ext::base::MacroKind;
46 use syntax_pos::{self, Span, BytePos, Pos, DUMMY_SP, NO_EXPANSION};
47
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>>,
53
54     // Cache the last used filemap for translating spans as an optimization.
55     last_filemap_index: usize,
56
57     lazy_state: LazyState,
58
59     // interpreter allocation cache
60     interpret_alloc_cache: FxHashMap<usize, interpret::AllocId>,
61 }
62
63 /// Abstract over the various ways one can create metadata decoders.
64 pub trait Metadata<'a, 'tcx>: Copy {
65     fn raw_bytes(self) -> &'a [u8];
66     fn cdata(self) -> Option<&'a CrateMetadata> { None }
67     fn sess(self) -> Option<&'a Session> { None }
68     fn tcx(self) -> Option<TyCtxt<'a, 'tcx, 'tcx>> { None }
69
70     fn decoder(self, pos: usize) -> DecodeContext<'a, 'tcx> {
71         let tcx = self.tcx();
72         DecodeContext {
73             opaque: opaque::Decoder::new(self.raw_bytes(), pos),
74             cdata: self.cdata(),
75             sess: self.sess().or(tcx.map(|tcx| tcx.sess)),
76             tcx,
77             last_filemap_index: 0,
78             lazy_state: LazyState::NoNode,
79             interpret_alloc_cache: FxHashMap::default(),
80         }
81     }
82 }
83
84 impl<'a, 'tcx> Metadata<'a, 'tcx> for &'a MetadataBlob {
85     fn raw_bytes(self) -> &'a [u8] {
86         &self.0
87     }
88 }
89
90
91 impl<'a, 'tcx> Metadata<'a, 'tcx> for (&'a MetadataBlob, &'a Session) {
92     fn raw_bytes(self) -> &'a [u8] {
93         let (blob, _) = self;
94         &blob.0
95     }
96
97     fn sess(self) -> Option<&'a Session> {
98         let (_, sess) = self;
99         Some(sess)
100     }
101 }
102
103
104 impl<'a, 'tcx> Metadata<'a, 'tcx> for &'a CrateMetadata {
105     fn raw_bytes(self) -> &'a [u8] {
106         self.blob.raw_bytes()
107     }
108     fn cdata(self) -> Option<&'a CrateMetadata> {
109         Some(self)
110     }
111 }
112
113 impl<'a, 'tcx> Metadata<'a, 'tcx> for (&'a CrateMetadata, &'a Session) {
114     fn raw_bytes(self) -> &'a [u8] {
115         self.0.raw_bytes()
116     }
117     fn cdata(self) -> Option<&'a CrateMetadata> {
118         Some(self.0)
119     }
120     fn sess(self) -> Option<&'a Session> {
121         Some(&self.1)
122     }
123 }
124
125 impl<'a, 'tcx> Metadata<'a, 'tcx> for (&'a CrateMetadata, TyCtxt<'a, 'tcx, 'tcx>) {
126     fn raw_bytes(self) -> &'a [u8] {
127         self.0.raw_bytes()
128     }
129     fn cdata(self) -> Option<&'a CrateMetadata> {
130         Some(self.0)
131     }
132     fn tcx(self) -> Option<TyCtxt<'a, 'tcx, 'tcx>> {
133         Some(self.1)
134     }
135 }
136
137 impl<'a, 'tcx: 'a, T: Decodable> Lazy<T> {
138     pub fn decode<M: Metadata<'a, 'tcx>>(self, meta: M) -> T {
139         let mut dcx = meta.decoder(self.position);
140         dcx.lazy_state = LazyState::NodeStart(self.position);
141         T::decode(&mut dcx).unwrap()
142     }
143 }
144
145 impl<'a, 'tcx: 'a, T: Decodable> LazySeq<T> {
146     pub fn decode<M: Metadata<'a, 'tcx>>(self, meta: M) -> impl Iterator<Item = T> + 'a {
147         let mut dcx = meta.decoder(self.position);
148         dcx.lazy_state = LazyState::NodeStart(self.position);
149         (0..self.len).map(move |_| T::decode(&mut dcx).unwrap())
150     }
151 }
152
153 impl<'a, 'tcx> DecodeContext<'a, 'tcx> {
154     pub fn tcx(&self) -> TyCtxt<'a, 'tcx, 'tcx> {
155         self.tcx.expect("missing TyCtxt in DecodeContext")
156     }
157
158     pub fn cdata(&self) -> &'a CrateMetadata {
159         self.cdata.expect("missing CrateMetadata in DecodeContext")
160     }
161
162     fn read_lazy_distance(&mut self, min_size: usize) -> Result<usize, <Self as Decoder>::Error> {
163         let distance = self.read_usize()?;
164         let position = match self.lazy_state {
165             LazyState::NoNode => bug!("read_lazy_distance: outside of a metadata node"),
166             LazyState::NodeStart(start) => {
167                 assert!(distance + min_size <= start);
168                 start - distance - min_size
169             }
170             LazyState::Previous(last_min_end) => last_min_end + distance,
171         };
172         self.lazy_state = LazyState::Previous(position + min_size);
173         Ok(position)
174     }
175 }
176
177 impl<'a, 'tcx: 'a> TyDecoder<'a, 'tcx> for DecodeContext<'a, 'tcx> {
178
179     #[inline]
180     fn tcx(&self) -> TyCtxt<'a, 'tcx, 'tcx> {
181         self.tcx.expect("missing TyCtxt in DecodeContext")
182     }
183
184     #[inline]
185     fn peek_byte(&self) -> u8 {
186         self.opaque.data[self.opaque.position()]
187     }
188
189     #[inline]
190     fn position(&self) -> usize {
191         self.opaque.position()
192     }
193
194     fn cached_ty_for_shorthand<F>(&mut self,
195                                   shorthand: usize,
196                                   or_insert_with: F)
197                                   -> Result<Ty<'tcx>, Self::Error>
198         where F: FnOnce(&mut Self) -> Result<Ty<'tcx>, Self::Error>
199     {
200         let tcx = self.tcx();
201
202         let key = ty::CReaderCacheKey {
203             cnum: self.cdata().cnum,
204             pos: shorthand,
205         };
206
207         if let Some(&ty) = tcx.rcache.borrow().get(&key) {
208             return Ok(ty);
209         }
210
211         let ty = or_insert_with(self)?;
212         tcx.rcache.borrow_mut().insert(key, ty);
213         Ok(ty)
214     }
215
216     fn with_position<F, R>(&mut self, pos: usize, f: F) -> R
217         where F: FnOnce(&mut Self) -> R
218     {
219         let new_opaque = opaque::Decoder::new(self.opaque.data, pos);
220         let old_opaque = mem::replace(&mut self.opaque, new_opaque);
221         let old_state = mem::replace(&mut self.lazy_state, LazyState::NoNode);
222         let r = f(self);
223         self.opaque = old_opaque;
224         self.lazy_state = old_state;
225         r
226     }
227
228     fn map_encoded_cnum_to_current(&self, cnum: CrateNum) -> CrateNum {
229         if cnum == LOCAL_CRATE {
230             self.cdata().cnum
231         } else {
232             self.cdata().cnum_map.borrow()[cnum]
233         }
234     }
235 }
236
237 impl<'a, 'tcx, T> SpecializedDecoder<Lazy<T>> for DecodeContext<'a, 'tcx> {
238     fn specialized_decode(&mut self) -> Result<Lazy<T>, Self::Error> {
239         Ok(Lazy::with_position(self.read_lazy_distance(Lazy::<T>::min_size())?))
240     }
241 }
242
243 impl<'a, 'tcx, T> SpecializedDecoder<LazySeq<T>> for DecodeContext<'a, 'tcx> {
244     fn specialized_decode(&mut self) -> Result<LazySeq<T>, Self::Error> {
245         let len = self.read_usize()?;
246         let position = if len == 0 {
247             0
248         } else {
249             self.read_lazy_distance(LazySeq::<T>::min_size(len))?
250         };
251         Ok(LazySeq::with_position_and_length(position, len))
252     }
253 }
254
255
256 impl<'a, 'tcx> SpecializedDecoder<DefId> for DecodeContext<'a, 'tcx> {
257     #[inline]
258     fn specialized_decode(&mut self) -> Result<DefId, Self::Error> {
259         let krate = CrateNum::decode(self)?;
260         let index = DefIndex::decode(self)?;
261
262         Ok(DefId {
263             krate,
264             index,
265         })
266     }
267 }
268
269 impl<'a, 'tcx> SpecializedDecoder<DefIndex> for DecodeContext<'a, 'tcx> {
270     #[inline]
271     fn specialized_decode(&mut self) -> Result<DefIndex, Self::Error> {
272         Ok(DefIndex::from_raw_u32(self.read_u32()?))
273     }
274 }
275
276 impl<'a, 'tcx> SpecializedDecoder<interpret::AllocId> for DecodeContext<'a, 'tcx> {
277     fn specialized_decode(&mut self) -> Result<interpret::AllocId, Self::Error> {
278         const MAX1: usize = usize::max_value() - 1;
279         let tcx = self.tcx;
280         let interpret_interner = || tcx.unwrap().interpret_interner.borrow_mut();
281         let pos = self.position();
282         match usize::decode(self)? {
283             ::std::usize::MAX => {
284                 let alloc_id = interpret_interner().reserve();
285                 trace!("creating alloc id {:?} at {}", alloc_id, pos);
286                 // insert early to allow recursive allocs
287                 self.interpret_alloc_cache.insert(pos, alloc_id);
288
289                 let allocation = interpret::Allocation::decode(self)?;
290                 trace!("decoded alloc {:?} {:#?}", alloc_id, allocation);
291                 let allocation = self.tcx.unwrap().intern_const_alloc(allocation);
292                 interpret_interner().intern_at_reserved(alloc_id, allocation);
293
294                 let num = usize::decode(self)?;
295                 for _ in 0..num {
296                     let glob = interpret::GlobalId::decode(self)?;
297                     interpret_interner().cache(glob, alloc_id);
298                 }
299
300                 Ok(alloc_id)
301             },
302             MAX1 => {
303                 trace!("creating fn alloc id at {}", pos);
304                 let instance = ty::Instance::decode(self)?;
305                 trace!("decoded fn alloc instance: {:?}", instance);
306                 let id = interpret_interner().create_fn_alloc(instance);
307                 trace!("created fn alloc id: {:?}", id);
308                 self.interpret_alloc_cache.insert(pos, id);
309                 Ok(id)
310             },
311             shorthand => {
312                 trace!("loading shorthand {}", shorthand);
313                 if let Some(&alloc_id) = self.interpret_alloc_cache.get(&shorthand) {
314                     return Ok(alloc_id);
315                 }
316                 trace!("shorthand {} not cached, loading entire allocation", shorthand);
317                 // need to load allocation
318                 self.with_position(shorthand, |this| interpret::AllocId::decode(this))
319             },
320         }
321     }
322 }
323
324 impl<'a, 'tcx> SpecializedDecoder<Span> for DecodeContext<'a, 'tcx> {
325     fn specialized_decode(&mut self) -> Result<Span, Self::Error> {
326         let tag = u8::decode(self)?;
327
328         if tag == TAG_INVALID_SPAN {
329             return Ok(DUMMY_SP)
330         }
331
332         debug_assert_eq!(tag, TAG_VALID_SPAN);
333
334         let lo = BytePos::decode(self)?;
335         let len = BytePos::decode(self)?;
336         let hi = lo + len;
337
338         let sess = if let Some(sess) = self.sess {
339             sess
340         } else {
341             bug!("Cannot decode Span without Session.")
342         };
343
344         let imported_filemaps = self.cdata().imported_filemaps(&sess.codemap());
345         let filemap = {
346             // Optimize for the case that most spans within a translated item
347             // originate from the same filemap.
348             let last_filemap = &imported_filemaps[self.last_filemap_index];
349
350             if lo >= last_filemap.original_start_pos &&
351                lo <= last_filemap.original_end_pos {
352                 last_filemap
353             } else {
354                 let mut a = 0;
355                 let mut b = imported_filemaps.len();
356
357                 while b - a > 1 {
358                     let m = (a + b) / 2;
359                     if imported_filemaps[m].original_start_pos > lo {
360                         b = m;
361                     } else {
362                         a = m;
363                     }
364                 }
365
366                 self.last_filemap_index = a;
367                 &imported_filemaps[a]
368             }
369         };
370
371         // Make sure our binary search above is correct.
372         debug_assert!(lo >= filemap.original_start_pos &&
373                       lo <= filemap.original_end_pos);
374
375         // Make sure we correctly filtered out invalid spans during encoding
376         debug_assert!(hi >= filemap.original_start_pos &&
377                       hi <= filemap.original_end_pos);
378
379         let lo = (lo + filemap.translated_filemap.start_pos) - filemap.original_start_pos;
380         let hi = (hi + filemap.translated_filemap.start_pos) - filemap.original_start_pos;
381
382         Ok(Span::new(lo, hi, NO_EXPANSION))
383     }
384 }
385
386 impl<'a, 'tcx> SpecializedDecoder<Fingerprint> for DecodeContext<'a, 'tcx> {
387     fn specialized_decode(&mut self) -> Result<Fingerprint, Self::Error> {
388         Fingerprint::decode_opaque(&mut self.opaque)
389     }
390 }
391
392 impl<'a, 'tcx, T: Decodable> SpecializedDecoder<mir::ClearCrossCrate<T>>
393 for DecodeContext<'a, 'tcx> {
394     #[inline]
395     fn specialized_decode(&mut self) -> Result<mir::ClearCrossCrate<T>, Self::Error> {
396         Ok(mir::ClearCrossCrate::Clear)
397     }
398 }
399
400 implement_ty_decoder!( DecodeContext<'a, 'tcx> );
401
402 impl<'a, 'tcx> MetadataBlob {
403     pub fn is_compatible(&self) -> bool {
404         self.raw_bytes().starts_with(METADATA_HEADER)
405     }
406
407     pub fn get_rustc_version(&self) -> String {
408         Lazy::with_position(METADATA_HEADER.len() + 4).decode(self)
409     }
410
411     pub fn get_root(&self) -> CrateRoot {
412         let slice = self.raw_bytes();
413         let offset = METADATA_HEADER.len();
414         let pos = (((slice[offset + 0] as u32) << 24) | ((slice[offset + 1] as u32) << 16) |
415                    ((slice[offset + 2] as u32) << 8) |
416                    ((slice[offset + 3] as u32) << 0)) as usize;
417         Lazy::with_position(pos).decode(self)
418     }
419
420     pub fn list_crate_metadata(&self,
421                                out: &mut io::Write) -> io::Result<()> {
422         write!(out, "=External Dependencies=\n")?;
423         let root = self.get_root();
424         for (i, dep) in root.crate_deps
425                             .decode(self)
426                             .enumerate() {
427             write!(out, "{} {}-{}\n", i + 1, dep.name, dep.hash)?;
428         }
429         write!(out, "\n")?;
430         Ok(())
431     }
432 }
433
434 impl<'tcx> EntryKind<'tcx> {
435     fn to_def(&self, did: DefId) -> Option<Def> {
436         Some(match *self {
437             EntryKind::Const(_) => Def::Const(did),
438             EntryKind::AssociatedConst(..) => Def::AssociatedConst(did),
439             EntryKind::ImmStatic |
440             EntryKind::ForeignImmStatic => Def::Static(did, false),
441             EntryKind::MutStatic |
442             EntryKind::ForeignMutStatic => Def::Static(did, true),
443             EntryKind::Struct(_, _) => Def::Struct(did),
444             EntryKind::Union(_, _) => Def::Union(did),
445             EntryKind::Fn(_) |
446             EntryKind::ForeignFn(_) => Def::Fn(did),
447             EntryKind::Method(_) => Def::Method(did),
448             EntryKind::Type => Def::TyAlias(did),
449             EntryKind::AssociatedType(_) => Def::AssociatedTy(did),
450             EntryKind::Mod(_) => Def::Mod(did),
451             EntryKind::Variant(_) => Def::Variant(did),
452             EntryKind::Trait(_) => Def::Trait(did),
453             EntryKind::Enum(..) => Def::Enum(did),
454             EntryKind::MacroDef(_) => Def::Macro(did, MacroKind::Bang),
455             EntryKind::GlobalAsm => Def::GlobalAsm(did),
456             EntryKind::ForeignType => Def::TyForeign(did),
457
458             EntryKind::ForeignMod |
459             EntryKind::Impl(_) |
460             EntryKind::Field |
461             EntryKind::Generator(_) |
462             EntryKind::Closure(_) => return None,
463         })
464     }
465 }
466
467 impl<'a, 'tcx> CrateMetadata {
468     fn is_proc_macro(&self, id: DefIndex) -> bool {
469         self.proc_macros.is_some() && id != CRATE_DEF_INDEX
470     }
471
472     fn maybe_entry(&self, item_id: DefIndex) -> Option<Lazy<Entry<'tcx>>> {
473         assert!(!self.is_proc_macro(item_id));
474         self.root.index.lookup(self.blob.raw_bytes(), item_id)
475     }
476
477     fn entry(&self, item_id: DefIndex) -> Entry<'tcx> {
478         match self.maybe_entry(item_id) {
479             None => {
480                 bug!("entry: id not found: {:?} in crate {:?} with number {}",
481                      item_id,
482                      self.name,
483                      self.cnum)
484             }
485             Some(d) => d.decode(self),
486         }
487     }
488
489     fn local_def_id(&self, index: DefIndex) -> DefId {
490         DefId {
491             krate: self.cnum,
492             index,
493         }
494     }
495
496     pub fn item_name(&self, item_index: DefIndex) -> InternedString {
497         self.def_key(item_index)
498             .disambiguated_data
499             .data
500             .get_opt_name()
501             .expect("no name in item_name")
502     }
503
504     pub fn get_def(&self, index: DefIndex) -> Option<Def> {
505         if !self.is_proc_macro(index) {
506             self.entry(index).kind.to_def(self.local_def_id(index))
507         } else {
508             let kind = self.proc_macros.as_ref().unwrap()[index.to_proc_macro_index()].1.kind();
509             Some(Def::Macro(self.local_def_id(index), kind))
510         }
511     }
512
513     pub fn get_span(&self, index: DefIndex, sess: &Session) -> Span {
514         match self.is_proc_macro(index) {
515             true => DUMMY_SP,
516             false => self.entry(index).span.decode((self, sess)),
517         }
518     }
519
520     pub fn get_trait_def(&self, item_id: DefIndex, sess: &Session) -> ty::TraitDef {
521         let data = match self.entry(item_id).kind {
522             EntryKind::Trait(data) => data.decode((self, sess)),
523             _ => bug!(),
524         };
525
526         ty::TraitDef::new(self.local_def_id(item_id),
527                           data.unsafety,
528                           data.paren_sugar,
529                           data.has_auto_impl,
530                           self.def_path_table.def_path_hash(item_id))
531     }
532
533     fn get_variant(&self, item: &Entry, index: DefIndex) -> ty::VariantDef {
534         let data = match item.kind {
535             EntryKind::Variant(data) |
536             EntryKind::Struct(data, _) |
537             EntryKind::Union(data, _) => data.decode(self),
538             _ => bug!(),
539         };
540
541         ty::VariantDef {
542             did: self.local_def_id(data.struct_ctor.unwrap_or(index)),
543             name: Symbol::intern(&self.item_name(index)),
544             fields: item.children.decode(self).map(|index| {
545                 let f = self.entry(index);
546                 ty::FieldDef {
547                     did: self.local_def_id(index),
548                     name: Symbol::intern(&self.item_name(index)),
549                     vis: f.visibility.decode(self)
550                 }
551             }).collect(),
552             discr: data.discr,
553             ctor_kind: data.ctor_kind,
554         }
555     }
556
557     pub fn get_adt_def(&self,
558                        item_id: DefIndex,
559                        tcx: TyCtxt<'a, 'tcx, 'tcx>)
560                        -> &'tcx ty::AdtDef {
561         let item = self.entry(item_id);
562         let did = self.local_def_id(item_id);
563         let kind = match item.kind {
564             EntryKind::Enum(_) => ty::AdtKind::Enum,
565             EntryKind::Struct(_, _) => ty::AdtKind::Struct,
566             EntryKind::Union(_, _) => ty::AdtKind::Union,
567             _ => bug!("get_adt_def called on a non-ADT {:?}", did),
568         };
569         let variants = if let ty::AdtKind::Enum = kind {
570             item.children
571                 .decode(self)
572                 .map(|index| {
573                     self.get_variant(&self.entry(index), index)
574                 })
575                 .collect()
576         } else {
577             vec![self.get_variant(&item, item_id)]
578         };
579         let (kind, repr) = match item.kind {
580             EntryKind::Enum(repr) => (ty::AdtKind::Enum, repr),
581             EntryKind::Struct(_, repr) => (ty::AdtKind::Struct, repr),
582             EntryKind::Union(_, repr) => (ty::AdtKind::Union, repr),
583             _ => bug!("get_adt_def called on a non-ADT {:?}", did),
584         };
585
586         tcx.alloc_adt_def(did, kind, variants, repr)
587     }
588
589     pub fn get_predicates(&self,
590                           item_id: DefIndex,
591                           tcx: TyCtxt<'a, 'tcx, 'tcx>)
592                           -> ty::GenericPredicates<'tcx> {
593         self.entry(item_id).predicates.unwrap().decode((self, tcx))
594     }
595
596     pub fn get_super_predicates(&self,
597                                 item_id: DefIndex,
598                                 tcx: TyCtxt<'a, 'tcx, 'tcx>)
599                                 -> ty::GenericPredicates<'tcx> {
600         match self.entry(item_id).kind {
601             EntryKind::Trait(data) => data.decode(self).super_predicates.decode((self, tcx)),
602             _ => bug!(),
603         }
604     }
605
606     pub fn get_generics(&self,
607                         item_id: DefIndex,
608                         sess: &Session)
609                         -> ty::Generics {
610         self.entry(item_id).generics.unwrap().decode((self, sess))
611     }
612
613     pub fn get_type(&self, id: DefIndex, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Ty<'tcx> {
614         self.entry(id).ty.unwrap().decode((self, tcx))
615     }
616
617     pub fn get_stability(&self, id: DefIndex) -> Option<attr::Stability> {
618         match self.is_proc_macro(id) {
619             true => None,
620             false => self.entry(id).stability.map(|stab| stab.decode(self)),
621         }
622     }
623
624     pub fn get_deprecation(&self, id: DefIndex) -> Option<attr::Deprecation> {
625         match self.is_proc_macro(id) {
626             true => None,
627             false => self.entry(id).deprecation.map(|depr| depr.decode(self)),
628         }
629     }
630
631     pub fn get_visibility(&self, id: DefIndex) -> ty::Visibility {
632         match self.is_proc_macro(id) {
633             true => ty::Visibility::Public,
634             false => self.entry(id).visibility.decode(self),
635         }
636     }
637
638     fn get_impl_data(&self, id: DefIndex) -> ImplData<'tcx> {
639         match self.entry(id).kind {
640             EntryKind::Impl(data) => data.decode(self),
641             _ => bug!(),
642         }
643     }
644
645     pub fn get_parent_impl(&self, id: DefIndex) -> Option<DefId> {
646         self.get_impl_data(id).parent_impl
647     }
648
649     pub fn get_impl_polarity(&self, id: DefIndex) -> hir::ImplPolarity {
650         self.get_impl_data(id).polarity
651     }
652
653     pub fn get_impl_defaultness(&self, id: DefIndex) -> hir::Defaultness {
654         self.get_impl_data(id).defaultness
655     }
656
657     pub fn get_coerce_unsized_info(&self,
658                                    id: DefIndex)
659                                    -> Option<ty::adjustment::CoerceUnsizedInfo> {
660         self.get_impl_data(id).coerce_unsized_info
661     }
662
663     pub fn get_impl_trait(&self,
664                           id: DefIndex,
665                           tcx: TyCtxt<'a, 'tcx, 'tcx>)
666                           -> Option<ty::TraitRef<'tcx>> {
667         self.get_impl_data(id).trait_ref.map(|tr| tr.decode((self, tcx)))
668     }
669
670     /// Iterates over the language items in the given crate.
671     pub fn get_lang_items(&self) -> Vec<(DefId, usize)> {
672         self.root
673             .lang_items
674             .decode(self)
675             .map(|(def_index, index)| (self.local_def_id(def_index), index))
676             .collect()
677     }
678
679     /// Iterates over each child of the given item.
680     pub fn each_child_of_item<F>(&self, id: DefIndex, mut callback: F, sess: &Session)
681         where F: FnMut(def::Export)
682     {
683         if let Some(ref proc_macros) = self.proc_macros {
684             if id == CRATE_DEF_INDEX {
685                 for (id, &(name, ref ext)) in proc_macros.iter().enumerate() {
686                     let def = Def::Macro(
687                         DefId {
688                             krate: self.cnum,
689                             index: DefIndex::from_proc_macro_index(id),
690                         },
691                         ext.kind()
692                     );
693                     let ident = Ident::with_empty_ctxt(name);
694                     callback(def::Export {
695                         ident: ident,
696                         def: def,
697                         vis: ty::Visibility::Public,
698                         span: DUMMY_SP,
699                         is_import: false,
700                     });
701                 }
702             }
703             return
704         }
705
706         // Find the item.
707         let item = match self.maybe_entry(id) {
708             None => return,
709             Some(item) => item.decode((self, sess)),
710         };
711
712         // Iterate over all children.
713         let macros_only = self.dep_kind.get().macros_only();
714         for child_index in item.children.decode((self, sess)) {
715             if macros_only {
716                 continue
717             }
718
719             // Get the item.
720             if let Some(child) = self.maybe_entry(child_index) {
721                 let child = child.decode((self, sess));
722                 match child.kind {
723                     EntryKind::MacroDef(..) => {}
724                     _ if macros_only => continue,
725                     _ => {}
726                 }
727
728                 // Hand off the item to the callback.
729                 match child.kind {
730                     // FIXME(eddyb) Don't encode these in children.
731                     EntryKind::ForeignMod => {
732                         for child_index in child.children.decode((self, sess)) {
733                             if let Some(def) = self.get_def(child_index) {
734                                 callback(def::Export {
735                                     def,
736                                     ident: Ident::from_str(&self.item_name(child_index)),
737                                     vis: self.get_visibility(child_index),
738                                     span: self.entry(child_index).span.decode((self, sess)),
739                                     is_import: false,
740                                 });
741                             }
742                         }
743                         continue;
744                     }
745                     EntryKind::Impl(_) => continue,
746
747                     _ => {}
748                 }
749
750                 let def_key = self.def_key(child_index);
751                 let span = child.span.decode((self, sess));
752                 if let (Some(def), Some(name)) =
753                     (self.get_def(child_index), def_key.disambiguated_data.data.get_opt_name()) {
754                     let ident = Ident::from_str(&name);
755                     let vis = self.get_visibility(child_index);
756                     let is_import = false;
757                     callback(def::Export { def, ident, vis, span, is_import });
758                     // For non-re-export structs and variants add their constructors to children.
759                     // Re-export lists automatically contain constructors when necessary.
760                     match def {
761                         Def::Struct(..) => {
762                             if let Some(ctor_def_id) = self.get_struct_ctor_def_id(child_index) {
763                                 let ctor_kind = self.get_ctor_kind(child_index);
764                                 let ctor_def = Def::StructCtor(ctor_def_id, ctor_kind);
765                                 callback(def::Export {
766                                     def: ctor_def,
767                                     vis: self.get_visibility(ctor_def_id.index),
768                                     ident, span, is_import,
769                                 });
770                             }
771                         }
772                         Def::Variant(def_id) => {
773                             // Braced variants, unlike structs, generate unusable names in
774                             // value namespace, they are reserved for possible future use.
775                             let ctor_kind = self.get_ctor_kind(child_index);
776                             let ctor_def = Def::VariantCtor(def_id, ctor_kind);
777                             let vis = self.get_visibility(child_index);
778                             callback(def::Export { def: ctor_def, ident, vis, span, is_import });
779                         }
780                         _ => {}
781                     }
782                 }
783             }
784         }
785
786         if let EntryKind::Mod(data) = item.kind {
787             for exp in data.decode((self, sess)).reexports.decode((self, sess)) {
788                 match exp.def {
789                     Def::Macro(..) => {}
790                     _ if macros_only => continue,
791                     _ => {}
792                 }
793                 callback(exp);
794             }
795         }
796     }
797
798     pub fn extern_const_body(&self,
799                              tcx: TyCtxt<'a, 'tcx, 'tcx>,
800                              id: DefIndex)
801                              -> ExternConstBody<'tcx> {
802         assert!(!self.is_proc_macro(id));
803         let ast = self.entry(id).ast.unwrap();
804         let def_id = self.local_def_id(id);
805         let ast = ast.decode((self, tcx));
806         let body = ast.body.decode((self, tcx));
807         ExternConstBody {
808             body: tcx.hir.intern_inlined_body(def_id, body),
809             fingerprint: ast.stable_bodies_hash,
810         }
811     }
812
813     pub fn item_body_tables(&self,
814                             id: DefIndex,
815                             tcx: TyCtxt<'a, 'tcx, 'tcx>)
816                             -> &'tcx ty::TypeckTables<'tcx> {
817         let ast = self.entry(id).ast.unwrap().decode(self);
818         tcx.alloc_tables(ast.tables.decode((self, tcx)))
819     }
820
821     pub fn item_body_nested_bodies(&self, id: DefIndex) -> ExternBodyNestedBodies {
822         if let Some(ref ast) = self.entry(id).ast {
823             let ast = ast.decode(self);
824             let nested_bodies: BTreeMap<_, _> = ast.nested_bodies
825                                                    .decode(self)
826                                                    .map(|body| (body.id(), body))
827                                                    .collect();
828             ExternBodyNestedBodies {
829                 nested_bodies: Lrc::new(nested_bodies),
830                 fingerprint: ast.stable_bodies_hash,
831             }
832         } else {
833             ExternBodyNestedBodies {
834                 nested_bodies: Lrc::new(BTreeMap::new()),
835                 fingerprint: Fingerprint::ZERO,
836             }
837         }
838     }
839
840     pub fn const_is_rvalue_promotable_to_static(&self, id: DefIndex) -> bool {
841         self.entry(id).ast.expect("const item missing `ast`")
842             .decode(self).rvalue_promotable_to_static
843     }
844
845     pub fn is_item_mir_available(&self, id: DefIndex) -> bool {
846         !self.is_proc_macro(id) &&
847         self.maybe_entry(id).and_then(|item| item.decode(self).mir).is_some()
848     }
849
850     pub fn maybe_get_optimized_mir(&self,
851                                    tcx: TyCtxt<'a, 'tcx, 'tcx>,
852                                    id: DefIndex)
853                                    -> Option<Mir<'tcx>> {
854         match self.is_proc_macro(id) {
855             true => None,
856             false => self.entry(id).mir.map(|mir| mir.decode((self, tcx))),
857         }
858     }
859
860     pub fn mir_const_qualif(&self, id: DefIndex) -> u8 {
861         match self.entry(id).kind {
862             EntryKind::Const(qualif) |
863             EntryKind::AssociatedConst(AssociatedContainer::ImplDefault, qualif) |
864             EntryKind::AssociatedConst(AssociatedContainer::ImplFinal, qualif) => {
865                 qualif
866             }
867             _ => bug!(),
868         }
869     }
870
871     pub fn get_associated_item(&self, id: DefIndex) -> ty::AssociatedItem {
872         let item = self.entry(id);
873         let def_key = self.def_key(id);
874         let parent = self.local_def_id(def_key.parent.unwrap());
875         let name = def_key.disambiguated_data.data.get_opt_name().unwrap();
876
877         let (kind, container, has_self) = match item.kind {
878             EntryKind::AssociatedConst(container, _) => {
879                 (ty::AssociatedKind::Const, container, false)
880             }
881             EntryKind::Method(data) => {
882                 let data = data.decode(self);
883                 (ty::AssociatedKind::Method, data.container, data.has_self)
884             }
885             EntryKind::AssociatedType(container) => {
886                 (ty::AssociatedKind::Type, container, false)
887             }
888             _ => bug!("cannot get associated-item of `{:?}`", def_key)
889         };
890
891         ty::AssociatedItem {
892             name: Symbol::intern(&name),
893             kind,
894             vis: item.visibility.decode(self),
895             defaultness: container.defaultness(),
896             def_id: self.local_def_id(id),
897             container: container.with_def_id(parent),
898             method_has_self_argument: has_self
899         }
900     }
901
902     pub fn get_item_variances(&self, id: DefIndex) -> Vec<ty::Variance> {
903         self.entry(id).variances.decode(self).collect()
904     }
905
906     pub fn get_ctor_kind(&self, node_id: DefIndex) -> CtorKind {
907         match self.entry(node_id).kind {
908             EntryKind::Struct(data, _) |
909             EntryKind::Union(data, _) |
910             EntryKind::Variant(data) => data.decode(self).ctor_kind,
911             _ => CtorKind::Fictive,
912         }
913     }
914
915     pub fn get_struct_ctor_def_id(&self, node_id: DefIndex) -> Option<DefId> {
916         match self.entry(node_id).kind {
917             EntryKind::Struct(data, _) => {
918                 data.decode(self).struct_ctor.map(|index| self.local_def_id(index))
919             }
920             _ => None,
921         }
922     }
923
924     pub fn get_item_attrs(&self, node_id: DefIndex, sess: &Session) -> Lrc<[ast::Attribute]> {
925         let (node_as, node_index) =
926             (node_id.address_space().index(), node_id.as_array_index());
927         if self.is_proc_macro(node_id) {
928             return Lrc::new([]);
929         }
930
931         if let Some(&Some(ref val)) =
932             self.attribute_cache.borrow()[node_as].get(node_index) {
933             return val.clone();
934         }
935
936         // The attributes for a tuple struct are attached to the definition, not the ctor;
937         // we assume that someone passing in a tuple struct ctor is actually wanting to
938         // look at the definition
939         let mut item = self.entry(node_id);
940         let def_key = self.def_key(node_id);
941         if def_key.disambiguated_data.data == DefPathData::StructCtor {
942             item = self.entry(def_key.parent.unwrap());
943         }
944         let result: Lrc<[ast::Attribute]> = Lrc::from(self.get_attributes(&item, sess));
945         let vec_ = &mut self.attribute_cache.borrow_mut()[node_as];
946         if vec_.len() < node_index + 1 {
947             vec_.resize(node_index + 1, None);
948         }
949         vec_[node_index] = Some(result.clone());
950         result
951     }
952
953     pub fn get_struct_field_names(&self, id: DefIndex) -> Vec<ast::Name> {
954         self.entry(id)
955             .children
956             .decode(self)
957             .map(|index| Symbol::intern(&self.item_name(index)))
958             .collect()
959     }
960
961     fn get_attributes(&self, item: &Entry<'tcx>, sess: &Session) -> Vec<ast::Attribute> {
962         item.attributes
963             .decode((self, sess))
964             .map(|mut attr| {
965                 // Need new unique IDs: old thread-local IDs won't map to new threads.
966                 attr.id = attr::mk_attr_id();
967                 attr
968             })
969             .collect()
970     }
971
972     // Translate a DefId from the current compilation environment to a DefId
973     // for an external crate.
974     fn reverse_translate_def_id(&self, did: DefId) -> Option<DefId> {
975         for (local, &global) in self.cnum_map.borrow().iter_enumerated() {
976             if global == did.krate {
977                 return Some(DefId {
978                     krate: local,
979                     index: did.index,
980                 });
981             }
982         }
983
984         None
985     }
986
987     pub fn get_inherent_implementations_for_type(&self, id: DefIndex) -> Vec<DefId> {
988         self.entry(id)
989             .inherent_impls
990             .decode(self)
991             .map(|index| self.local_def_id(index))
992             .collect()
993     }
994
995     pub fn get_implementations_for_trait(&self,
996                                          filter: Option<DefId>,
997                                          result: &mut Vec<DefId>) {
998         // Do a reverse lookup beforehand to avoid touching the crate_num
999         // hash map in the loop below.
1000         let filter = match filter.map(|def_id| self.reverse_translate_def_id(def_id)) {
1001             Some(Some(def_id)) => Some((def_id.krate.as_u32(), def_id.index)),
1002             Some(None) => return,
1003             None if self.proc_macros.is_some() => return,
1004             None => None,
1005         };
1006
1007         if let Some(filter) = filter {
1008             if let Some(impls) = self.trait_impls
1009                                      .get(&filter) {
1010                 result.extend(impls.decode(self).map(|idx| self.local_def_id(idx)));
1011             }
1012         } else {
1013             for impls in self.trait_impls.values() {
1014                 result.extend(impls.decode(self).map(|idx| self.local_def_id(idx)));
1015             }
1016         }
1017     }
1018
1019     pub fn get_trait_of_item(&self, id: DefIndex) -> Option<DefId> {
1020         self.def_key(id).parent.and_then(|parent_index| {
1021             match self.entry(parent_index).kind {
1022                 EntryKind::Trait(_) => Some(self.local_def_id(parent_index)),
1023                 _ => None,
1024             }
1025         })
1026     }
1027
1028
1029     pub fn get_native_libraries(&self, sess: &Session) -> Vec<NativeLibrary> {
1030         self.root.native_libraries.decode((self, sess)).collect()
1031     }
1032
1033     pub fn get_dylib_dependency_formats(&self) -> Vec<(CrateNum, LinkagePreference)> {
1034         self.root
1035             .dylib_dependency_formats
1036             .decode(self)
1037             .enumerate()
1038             .flat_map(|(i, link)| {
1039                 let cnum = CrateNum::new(i + 1);
1040                 link.map(|link| (self.cnum_map.borrow()[cnum], link))
1041             })
1042             .collect()
1043     }
1044
1045     pub fn get_missing_lang_items(&self) -> Vec<lang_items::LangItem> {
1046         self.root
1047             .lang_items_missing
1048             .decode(self)
1049             .collect()
1050     }
1051
1052     pub fn get_fn_arg_names(&self, id: DefIndex) -> Vec<ast::Name> {
1053         let arg_names = match self.entry(id).kind {
1054             EntryKind::Fn(data) |
1055             EntryKind::ForeignFn(data) => data.decode(self).arg_names,
1056             EntryKind::Method(data) => data.decode(self).fn_data.arg_names,
1057             _ => LazySeq::empty(),
1058         };
1059         arg_names.decode(self).collect()
1060     }
1061
1062     pub fn exported_symbols(&self) -> Vec<(ExportedSymbol, SymbolExportLevel)> {
1063         self.root
1064             .exported_symbols
1065             .decode(self)
1066             .collect()
1067     }
1068
1069     pub fn get_macro(&self, id: DefIndex) -> (InternedString, MacroDef) {
1070         let entry = self.entry(id);
1071         match entry.kind {
1072             EntryKind::MacroDef(macro_def) => (self.item_name(id), macro_def.decode(self)),
1073             _ => bug!(),
1074         }
1075     }
1076
1077     pub fn is_const_fn(&self, id: DefIndex) -> bool {
1078         let constness = match self.entry(id).kind {
1079             EntryKind::Method(data) => data.decode(self).fn_data.constness,
1080             EntryKind::Fn(data) => data.decode(self).constness,
1081             _ => hir::Constness::NotConst,
1082         };
1083         constness == hir::Constness::Const
1084     }
1085
1086     pub fn is_foreign_item(&self, id: DefIndex) -> bool {
1087         match self.entry(id).kind {
1088             EntryKind::ForeignImmStatic |
1089             EntryKind::ForeignMutStatic |
1090             EntryKind::ForeignFn(_) => true,
1091             _ => false,
1092         }
1093     }
1094
1095     pub fn is_dllimport_foreign_item(&self, id: DefIndex) -> bool {
1096         self.dllimport_foreign_items.contains(&id)
1097     }
1098
1099     pub fn fn_sig(&self,
1100                   id: DefIndex,
1101                   tcx: TyCtxt<'a, 'tcx, 'tcx>)
1102                   -> ty::PolyFnSig<'tcx> {
1103         let sig = match self.entry(id).kind {
1104             EntryKind::Fn(data) |
1105             EntryKind::ForeignFn(data) => data.decode(self).sig,
1106             EntryKind::Method(data) => data.decode(self).fn_data.sig,
1107             EntryKind::Variant(data) |
1108             EntryKind::Struct(data, _) => data.decode(self).ctor_sig.unwrap(),
1109             EntryKind::Closure(data) => data.decode(self).sig,
1110             _ => bug!(),
1111         };
1112         sig.decode((self, tcx))
1113     }
1114
1115     #[inline]
1116     pub fn def_key(&self, index: DefIndex) -> DefKey {
1117         self.def_path_table.def_key(index)
1118     }
1119
1120     // Returns the path leading to the thing with this `id`.
1121     pub fn def_path(&self, id: DefIndex) -> DefPath {
1122         debug!("def_path(id={:?})", id);
1123         DefPath::make(self.cnum, id, |parent| self.def_path_table.def_key(parent))
1124     }
1125
1126     #[inline]
1127     pub fn def_path_hash(&self, index: DefIndex) -> DefPathHash {
1128         self.def_path_table.def_path_hash(index)
1129     }
1130
1131     /// Imports the codemap from an external crate into the codemap of the crate
1132     /// currently being compiled (the "local crate").
1133     ///
1134     /// The import algorithm works analogous to how AST items are inlined from an
1135     /// external crate's metadata:
1136     /// For every FileMap in the external codemap an 'inline' copy is created in the
1137     /// local codemap. The correspondence relation between external and local
1138     /// FileMaps is recorded in the `ImportedFileMap` objects returned from this
1139     /// function. When an item from an external crate is later inlined into this
1140     /// crate, this correspondence information is used to translate the span
1141     /// information of the inlined item so that it refers the correct positions in
1142     /// the local codemap (see `<decoder::DecodeContext as SpecializedDecoder<Span>>`).
1143     ///
1144     /// The import algorithm in the function below will reuse FileMaps already
1145     /// existing in the local codemap. For example, even if the FileMap of some
1146     /// source file of libstd gets imported many times, there will only ever be
1147     /// one FileMap object for the corresponding file in the local codemap.
1148     ///
1149     /// Note that imported FileMaps do not actually contain the source code of the
1150     /// file they represent, just information about length, line breaks, and
1151     /// multibyte characters. This information is enough to generate valid debuginfo
1152     /// for items inlined from other crates.
1153     pub fn imported_filemaps(&'a self,
1154                              local_codemap: &codemap::CodeMap)
1155                              -> Ref<'a, Vec<cstore::ImportedFileMap>> {
1156         {
1157             let filemaps = self.codemap_import_info.borrow();
1158             if !filemaps.is_empty() {
1159                 return filemaps;
1160             }
1161         }
1162
1163         let external_codemap = self.root.codemap.decode(self);
1164
1165         let imported_filemaps = external_codemap.map(|filemap_to_import| {
1166             // We can't reuse an existing FileMap, so allocate a new one
1167             // containing the information we need.
1168             let syntax_pos::FileMap { name,
1169                                       name_was_remapped,
1170                                       src_hash,
1171                                       start_pos,
1172                                       end_pos,
1173                                       lines,
1174                                       multibyte_chars,
1175                                       non_narrow_chars,
1176                                       name_hash,
1177                                       .. } = filemap_to_import;
1178
1179             let source_length = (end_pos - start_pos).to_usize();
1180
1181             // Translate line-start positions and multibyte character
1182             // position into frame of reference local to file.
1183             // `CodeMap::new_imported_filemap()` will then translate those
1184             // coordinates to their new global frame of reference when the
1185             // offset of the FileMap is known.
1186             let mut lines = lines.into_inner();
1187             for pos in &mut lines {
1188                 *pos = *pos - start_pos;
1189             }
1190             let mut multibyte_chars = multibyte_chars.into_inner();
1191             for mbc in &mut multibyte_chars {
1192                 mbc.pos = mbc.pos - start_pos;
1193             }
1194             let mut non_narrow_chars = non_narrow_chars.into_inner();
1195             for swc in &mut non_narrow_chars {
1196                 *swc = *swc - start_pos;
1197             }
1198
1199             let local_version = local_codemap.new_imported_filemap(name,
1200                                                                    name_was_remapped,
1201                                                                    self.cnum.as_u32(),
1202                                                                    src_hash,
1203                                                                    name_hash,
1204                                                                    source_length,
1205                                                                    lines,
1206                                                                    multibyte_chars,
1207                                                                    non_narrow_chars);
1208             debug!("CrateMetaData::imported_filemaps alloc \
1209                     filemap {:?} original (start_pos {:?} end_pos {:?}) \
1210                     translated (start_pos {:?} end_pos {:?})",
1211                    local_version.name, start_pos, end_pos,
1212                    local_version.start_pos, local_version.end_pos);
1213
1214             cstore::ImportedFileMap {
1215                 original_start_pos: start_pos,
1216                 original_end_pos: end_pos,
1217                 translated_filemap: local_version,
1218             }
1219         }).collect();
1220
1221         // This shouldn't borrow twice, but there is no way to downgrade RefMut to Ref.
1222         *self.codemap_import_info.borrow_mut() = imported_filemaps;
1223         self.codemap_import_info.borrow()
1224     }
1225 }