]> git.lizzy.rs Git - rust.git/blob - src/librustc_metadata/decoder.rs
Queryify const_is_rvalue_promotable_to_static
[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::hir::map::{DefKey, DefPath, DefPathData};
17 use rustc::hir;
18
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;
26
27 use rustc::mir::Mir;
28
29 use std::borrow::Cow;
30 use std::cell::Ref;
31 use std::io;
32 use std::mem;
33 use std::rc::Rc;
34 use std::str;
35 use std::u32;
36
37 use rustc_serialize::{Decodable, Decoder, SpecializedDecoder, opaque};
38 use syntax::attr;
39 use syntax::ast;
40 use syntax::codemap;
41 use syntax::ext::base::MacroKind;
42 use syntax_pos::{self, Span, BytePos, Pos, DUMMY_SP, NO_EXPANSION};
43
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>>,
49
50     // Cache the last used filemap for translating spans as an optimization.
51     last_filemap_index: usize,
52
53     lazy_state: LazyState,
54 }
55
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 }
62
63     fn decoder(self, pos: usize) -> DecodeContext<'a, 'tcx> {
64         let tcx = self.tcx();
65         DecodeContext {
66             opaque: opaque::Decoder::new(self.raw_bytes(), pos),
67             cdata: self.cdata(),
68             sess: self.sess().or(tcx.map(|tcx| tcx.sess)),
69             tcx: tcx,
70             last_filemap_index: 0,
71             lazy_state: LazyState::NoNode,
72         }
73     }
74 }
75
76 impl<'a, 'tcx> Metadata<'a, 'tcx> for &'a MetadataBlob {
77     fn raw_bytes(self) -> &'a [u8] {
78         match *self {
79             MetadataBlob::Inflated(ref vec) => vec,
80             MetadataBlob::Archive(ref ar) => ar.as_slice(),
81             MetadataBlob::Raw(ref vec) => vec,
82         }
83     }
84 }
85
86 impl<'a, 'tcx> Metadata<'a, 'tcx> for &'a CrateMetadata {
87     fn raw_bytes(self) -> &'a [u8] {
88         self.blob.raw_bytes()
89     }
90     fn cdata(self) -> Option<&'a CrateMetadata> {
91         Some(self)
92     }
93 }
94
95 impl<'a, 'tcx> Metadata<'a, 'tcx> for (&'a CrateMetadata, &'a Session) {
96     fn raw_bytes(self) -> &'a [u8] {
97         self.0.raw_bytes()
98     }
99     fn cdata(self) -> Option<&'a CrateMetadata> {
100         Some(self.0)
101     }
102     fn sess(self) -> Option<&'a Session> {
103         Some(&self.1)
104     }
105 }
106
107 impl<'a, 'tcx> Metadata<'a, 'tcx> for (&'a CrateMetadata, TyCtxt<'a, 'tcx, 'tcx>) {
108     fn raw_bytes(self) -> &'a [u8] {
109         self.0.raw_bytes()
110     }
111     fn cdata(self) -> Option<&'a CrateMetadata> {
112         Some(self.0)
113     }
114     fn tcx(self) -> Option<TyCtxt<'a, 'tcx, 'tcx>> {
115         Some(self.1)
116     }
117 }
118
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()
124     }
125 }
126
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())
132     }
133 }
134
135 impl<'a, 'tcx> DecodeContext<'a, 'tcx> {
136     pub fn tcx(&self) -> TyCtxt<'a, 'tcx, 'tcx> {
137         self.tcx.expect("missing TyCtxt in DecodeContext")
138     }
139
140     pub fn cdata(&self) -> &'a CrateMetadata {
141         self.cdata.expect("missing CrateMetadata in DecodeContext")
142     }
143
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);
148         let r = f(self);
149         self.opaque = old_opaque;
150         self.lazy_state = old_state;
151         r
152     }
153
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
161             }
162             LazyState::Previous(last_min_end) => last_min_end + distance,
163         };
164         self.lazy_state = LazyState::Previous(position + min_size);
165         Ok(position)
166     }
167 }
168
169 macro_rules! decoder_methods {
170     ($($name:ident -> $ty:ty;)*) => {
171         $(fn $name(&mut self) -> Result<$ty, Self::Error> {
172             self.opaque.$name()
173         })*
174     }
175 }
176
177 impl<'doc, 'tcx> Decoder for DecodeContext<'doc, 'tcx> {
178     type Error = <opaque::Decoder<'doc> as Decoder>::Error;
179
180     decoder_methods! {
181         read_nil -> ();
182
183         read_u128 -> u128;
184         read_u64 -> u64;
185         read_u32 -> u32;
186         read_u16 -> u16;
187         read_u8 -> u8;
188         read_usize -> usize;
189
190         read_i128 -> i128;
191         read_i64 -> i64;
192         read_i32 -> i32;
193         read_i16 -> i16;
194         read_i8 -> i8;
195         read_isize -> isize;
196
197         read_bool -> bool;
198         read_f64 -> f64;
199         read_f32 -> f32;
200         read_char -> char;
201         read_str -> Cow<str>;
202     }
203
204     fn error(&mut self, err: &str) -> Self::Error {
205         self.opaque.error(err)
206     }
207 }
208
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())?))
212     }
213 }
214
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 {
219             0
220         } else {
221             self.read_lazy_distance(LazySeq::<T>::min_size(len))?
222         };
223         Ok(LazySeq::with_position_and_length(position, len))
224     }
225 }
226
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)
232         } else {
233             Ok(self.cdata().cnum_map.borrow()[cnum])
234         }
235     }
236 }
237
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)?;
242
243         let sess = if let Some(sess) = self.sess {
244             sess
245         } else {
246             return Ok(Span { lo: lo, hi: hi, ctxt: NO_EXPANSION });
247         };
248
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)
257             (lo, lo)
258         } else {
259             (lo, hi)
260         };
261
262         let imported_filemaps = self.cdata().imported_filemaps(&sess.codemap());
263         let filemap = {
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];
267
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 {
271                 last_filemap
272             } else {
273                 let mut a = 0;
274                 let mut b = imported_filemaps.len();
275
276                 while b - a > 1 {
277                     let m = (a + b) / 2;
278                     if imported_filemaps[m].original_start_pos > lo {
279                         b = m;
280                     } else {
281                         a = m;
282                     }
283                 }
284
285                 self.last_filemap_index = a;
286                 &imported_filemaps[a]
287             }
288         };
289
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;
292
293         Ok(Span { lo: lo, hi: hi, ctxt: NO_EXPANSION })
294     }
295 }
296
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.
300
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();
304
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,
312             };
313             if let Some(ty) = tcx.rcache.borrow().get(&key).cloned() {
314                 return Ok(ty);
315             }
316
317             let ty = self.with_position(key.pos, Ty::decode)?;
318             tcx.rcache.borrow_mut().insert(key, ty);
319             Ok(ty)
320         } else {
321             Ok(tcx.mk_ty(ty::TypeVariants::decode(self)?))
322         }
323     }
324 }
325
326
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;
337
338                         self.with_position(pos, ty::Predicate::decode)
339                     } else {
340                         ty::Predicate::decode(self)
341                     }
342                 })
343                 .collect::<Result<Vec<_>, _>>()?,
344         })
345     }
346 }
347
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)))?)
351     }
352 }
353
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)?))
357     }
358 }
359
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)))?)
363     }
364 }
365
366 impl<'a, 'tcx> SpecializedDecoder<&'tcx ty::AdtDef> for DecodeContext<'a, 'tcx> {
367     fn specialized_decode(&mut self) -> Result<&'tcx ty::AdtDef, Self::Error> {
368         let def_id = DefId::decode(self)?;
369         Ok(self.tcx().adt_def(def_id))
370     }
371 }
372
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)))?)
379     }
380 }
381
382 impl<'a, 'tcx> MetadataBlob {
383     pub fn is_compatible(&self) -> bool {
384         self.raw_bytes().starts_with(METADATA_HEADER)
385     }
386
387     pub fn get_rustc_version(&self) -> String {
388         Lazy::with_position(METADATA_HEADER.len() + 4).decode(self)
389     }
390
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)
398     }
399
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)?;
405         }
406         write!(out, "\n")?;
407         Ok(())
408     }
409 }
410
411 impl<'tcx> EntryKind<'tcx> {
412     fn to_def(&self, did: DefId) -> Option<Def> {
413         Some(match *self {
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),
422             EntryKind::Fn(_) |
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),
433
434             EntryKind::ForeignMod |
435             EntryKind::Impl(_) |
436             EntryKind::DefaultImpl(_) |
437             EntryKind::Field |
438             EntryKind::Closure(_) => return None,
439         })
440     }
441 }
442
443 impl<'a, 'tcx> CrateMetadata {
444     fn is_proc_macro(&self, id: DefIndex) -> bool {
445         self.proc_macros.is_some() && id != CRATE_DEF_INDEX
446     }
447
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)
451     }
452
453     pub fn entry(&self, item_id: DefIndex) -> Entry<'tcx> {
454         match self.maybe_entry(item_id) {
455             None => {
456                 bug!("entry: id not found: {:?} in crate {:?} with number {}",
457                      item_id,
458                      self.name,
459                      self.cnum)
460             }
461             Some(d) => d.decode(self),
462         }
463     }
464
465     fn local_def_id(&self, index: DefIndex) -> DefId {
466         DefId {
467             krate: self.cnum,
468             index: index,
469         }
470     }
471
472     fn item_name(&self, item_index: DefIndex) -> ast::Name {
473         self.def_key(item_index)
474             .disambiguated_data
475             .data
476             .get_opt_name()
477             .expect("no name in item_name")
478     }
479
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))
483         } else {
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))
486         }
487     }
488
489     pub fn get_span(&self, index: DefIndex, sess: &Session) -> Span {
490         match self.is_proc_macro(index) {
491             true => DUMMY_SP,
492             false => self.entry(index).span.decode((self, sess)),
493         }
494     }
495
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),
499             _ => bug!(),
500         };
501
502         let def = ty::TraitDef::new(self.local_def_id(item_id),
503                                     data.unsafety,
504                                     data.paren_sugar,
505                                     self.def_path_table.def_path_hash(item_id));
506
507         if data.has_default_impl {
508             def.record_has_default_impl();
509         }
510
511         def
512     }
513
514     fn get_variant(&self, item: &Entry, index: DefIndex) -> ty::VariantDef {
515         let data = match item.kind {
516             EntryKind::Variant(data) |
517             EntryKind::Struct(data, _) |
518             EntryKind::Union(data, _) => data.decode(self),
519             _ => bug!(),
520         };
521
522         ty::VariantDef {
523             did: self.local_def_id(data.struct_ctor.unwrap_or(index)),
524             name: self.item_name(index),
525             fields: item.children.decode(self).map(|index| {
526                 let f = self.entry(index);
527                 ty::FieldDef {
528                     did: self.local_def_id(index),
529                     name: self.item_name(index),
530                     vis: f.visibility.decode(self)
531                 }
532             }).collect(),
533             discr: data.discr,
534             ctor_kind: data.ctor_kind,
535         }
536     }
537
538     pub fn get_adt_def(&self,
539                        item_id: DefIndex,
540                        tcx: TyCtxt<'a, 'tcx, 'tcx>)
541                        -> &'tcx ty::AdtDef {
542         let item = self.entry(item_id);
543         let did = self.local_def_id(item_id);
544         let kind = match item.kind {
545             EntryKind::Enum(_) => ty::AdtKind::Enum,
546             EntryKind::Struct(_, _) => ty::AdtKind::Struct,
547             EntryKind::Union(_, _) => ty::AdtKind::Union,
548             _ => bug!("get_adt_def called on a non-ADT {:?}", did),
549         };
550         let variants = if let ty::AdtKind::Enum = kind {
551             item.children
552                 .decode(self)
553                 .map(|index| {
554                     self.get_variant(&self.entry(index), index)
555                 })
556                 .collect()
557         } else {
558             vec![self.get_variant(&item, item_id)]
559         };
560         let (kind, repr) = match item.kind {
561             EntryKind::Enum(repr) => (ty::AdtKind::Enum, repr),
562             EntryKind::Struct(_, repr) => (ty::AdtKind::Struct, repr),
563             EntryKind::Union(_, repr) => (ty::AdtKind::Union, repr),
564             _ => bug!("get_adt_def called on a non-ADT {:?}", did),
565         };
566
567         tcx.alloc_adt_def(did, kind, variants, repr)
568     }
569
570     pub fn get_predicates(&self,
571                           item_id: DefIndex,
572                           tcx: TyCtxt<'a, 'tcx, 'tcx>)
573                           -> ty::GenericPredicates<'tcx> {
574         self.entry(item_id).predicates.unwrap().decode((self, tcx))
575     }
576
577     pub fn get_super_predicates(&self,
578                                 item_id: DefIndex,
579                                 tcx: TyCtxt<'a, 'tcx, 'tcx>)
580                                 -> ty::GenericPredicates<'tcx> {
581         match self.entry(item_id).kind {
582             EntryKind::Trait(data) => data.decode(self).super_predicates.decode((self, tcx)),
583             _ => bug!(),
584         }
585     }
586
587     pub fn get_generics(&self, item_id: DefIndex) -> ty::Generics {
588         self.entry(item_id).generics.unwrap().decode(self)
589     }
590
591     pub fn get_type(&self, id: DefIndex, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Ty<'tcx> {
592         self.entry(id).ty.unwrap().decode((self, tcx))
593     }
594
595     pub fn get_stability(&self, id: DefIndex) -> Option<attr::Stability> {
596         match self.is_proc_macro(id) {
597             true => None,
598             false => self.entry(id).stability.map(|stab| stab.decode(self)),
599         }
600     }
601
602     pub fn get_deprecation(&self, id: DefIndex) -> Option<attr::Deprecation> {
603         match self.is_proc_macro(id) {
604             true => None,
605             false => self.entry(id).deprecation.map(|depr| depr.decode(self)),
606         }
607     }
608
609     pub fn get_visibility(&self, id: DefIndex) -> ty::Visibility {
610         match self.is_proc_macro(id) {
611             true => ty::Visibility::Public,
612             false => self.entry(id).visibility.decode(self),
613         }
614     }
615
616     fn get_impl_data(&self, id: DefIndex) -> ImplData<'tcx> {
617         match self.entry(id).kind {
618             EntryKind::Impl(data) => data.decode(self),
619             _ => bug!(),
620         }
621     }
622
623     pub fn get_parent_impl(&self, id: DefIndex) -> Option<DefId> {
624         self.get_impl_data(id).parent_impl
625     }
626
627     pub fn get_impl_polarity(&self, id: DefIndex) -> hir::ImplPolarity {
628         self.get_impl_data(id).polarity
629     }
630
631     pub fn get_impl_defaultness(&self, id: DefIndex) -> hir::Defaultness {
632         self.get_impl_data(id).defaultness
633     }
634
635     pub fn get_coerce_unsized_info(&self,
636                                    id: DefIndex)
637                                    -> Option<ty::adjustment::CoerceUnsizedInfo> {
638         self.get_impl_data(id).coerce_unsized_info
639     }
640
641     pub fn get_impl_trait(&self,
642                           id: DefIndex,
643                           tcx: TyCtxt<'a, 'tcx, 'tcx>)
644                           -> Option<ty::TraitRef<'tcx>> {
645         self.get_impl_data(id).trait_ref.map(|tr| tr.decode((self, tcx)))
646     }
647
648     /// Iterates over the language items in the given crate.
649     pub fn get_lang_items(&self) -> Vec<(DefIndex, usize)> {
650         self.root.lang_items.decode(self).collect()
651     }
652
653     /// Iterates over each child of the given item.
654     pub fn each_child_of_item<F>(&self, id: DefIndex, mut callback: F)
655         where F: FnMut(def::Export)
656     {
657         if let Some(ref proc_macros) = self.proc_macros {
658             if id == CRATE_DEF_INDEX {
659                 for (id, &(name, ref ext)) in proc_macros.iter().enumerate() {
660                     let def = Def::Macro(
661                         DefId {
662                             krate: self.cnum,
663                             index: DefIndex::new(id + 1)
664                         },
665                         ext.kind()
666                     );
667                     callback(def::Export { name: name, def: def, span: DUMMY_SP });
668                 }
669             }
670             return
671         }
672
673         // Find the item.
674         let item = match self.maybe_entry(id) {
675             None => return,
676             Some(item) => item.decode(self),
677         };
678
679         // Iterate over all children.
680         let macros_only = self.dep_kind.get().macros_only();
681         for child_index in item.children.decode(self) {
682             if macros_only {
683                 continue
684             }
685
686             // Get the item.
687             if let Some(child) = self.maybe_entry(child_index) {
688                 let child = child.decode(self);
689                 match child.kind {
690                     EntryKind::MacroDef(..) => {}
691                     _ if macros_only => continue,
692                     _ => {}
693                 }
694
695                 // Hand off the item to the callback.
696                 match child.kind {
697                     // FIXME(eddyb) Don't encode these in children.
698                     EntryKind::ForeignMod => {
699                         for child_index in child.children.decode(self) {
700                             if let Some(def) = self.get_def(child_index) {
701                                 callback(def::Export {
702                                     def: def,
703                                     name: self.item_name(child_index),
704                                     span: self.entry(child_index).span.decode(self),
705                                 });
706                             }
707                         }
708                         continue;
709                     }
710                     EntryKind::Impl(_) |
711                     EntryKind::DefaultImpl(_) => continue,
712
713                     _ => {}
714                 }
715
716                 let def_key = self.def_key(child_index);
717                 let span = child.span.decode(self);
718                 if let (Some(def), Some(name)) =
719                     (self.get_def(child_index), def_key.disambiguated_data.data.get_opt_name()) {
720                     callback(def::Export { def: def, name: name, span: span });
721                     // For non-reexport structs and variants add their constructors to children.
722                     // Reexport lists automatically contain constructors when necessary.
723                     match def {
724                         Def::Struct(..) => {
725                             if let Some(ctor_def_id) = self.get_struct_ctor_def_id(child_index) {
726                                 let ctor_kind = self.get_ctor_kind(child_index);
727                                 let ctor_def = Def::StructCtor(ctor_def_id, ctor_kind);
728                                 callback(def::Export { def: ctor_def, name: name, span: span });
729                             }
730                         }
731                         Def::Variant(def_id) => {
732                             // Braced variants, unlike structs, generate unusable names in
733                             // value namespace, they are reserved for possible future use.
734                             let ctor_kind = self.get_ctor_kind(child_index);
735                             let ctor_def = Def::VariantCtor(def_id, ctor_kind);
736                             callback(def::Export { def: ctor_def, name: name, span: span });
737                         }
738                         _ => {}
739                     }
740                 }
741             }
742         }
743
744         if let EntryKind::Mod(data) = item.kind {
745             for exp in data.decode(self).reexports.decode(self) {
746                 match exp.def {
747                     Def::Macro(..) => {}
748                     _ if macros_only => continue,
749                     _ => {}
750                 }
751                 callback(exp);
752             }
753         }
754     }
755
756     pub fn item_body(&self,
757                      tcx: TyCtxt<'a, 'tcx, 'tcx>,
758                      id: DefIndex)
759                      -> &'tcx hir::Body {
760         assert!(!self.is_proc_macro(id));
761         let ast = self.entry(id).ast.unwrap();
762         let def_id = self.local_def_id(id);
763         let body = ast.decode(self).body.decode(self);
764         tcx.hir.intern_inlined_body(def_id, body)
765     }
766
767     pub fn item_body_tables(&self,
768                             id: DefIndex,
769                             tcx: TyCtxt<'a, 'tcx, 'tcx>)
770                             -> &'tcx ty::TypeckTables<'tcx> {
771         let ast = self.entry(id).ast.unwrap().decode(self);
772         tcx.alloc_tables(ast.tables.decode((self, tcx)))
773     }
774
775     pub fn is_item_mir_available(&self, id: DefIndex) -> bool {
776         !self.is_proc_macro(id) &&
777         self.maybe_entry(id).and_then(|item| item.decode(self).mir).is_some()
778     }
779
780     pub fn maybe_get_item_mir(&self,
781                               tcx: TyCtxt<'a, 'tcx, 'tcx>,
782                               id: DefIndex)
783                               -> Option<Mir<'tcx>> {
784         match self.is_proc_macro(id) {
785             true => None,
786             false => self.entry(id).mir.map(|mir| mir.decode((self, tcx))),
787         }
788     }
789
790     pub fn mir_const_qualif(&self, id: DefIndex) -> u8 {
791         match self.entry(id).kind {
792             EntryKind::Const(qualif) |
793             EntryKind::AssociatedConst(AssociatedContainer::ImplDefault, qualif) |
794             EntryKind::AssociatedConst(AssociatedContainer::ImplFinal, qualif) => {
795                 qualif
796             }
797             _ => bug!(),
798         }
799     }
800
801     pub fn get_associated_item(&self, id: DefIndex) -> ty::AssociatedItem {
802         let item = self.entry(id);
803         let def_key = self.def_key(id);
804         let parent = self.local_def_id(def_key.parent.unwrap());
805         let name = def_key.disambiguated_data.data.get_opt_name().unwrap();
806
807         let (kind, container, has_self) = match item.kind {
808             EntryKind::AssociatedConst(container, _) => {
809                 (ty::AssociatedKind::Const, container, false)
810             }
811             EntryKind::Method(data) => {
812                 let data = data.decode(self);
813                 (ty::AssociatedKind::Method, data.container, data.has_self)
814             }
815             EntryKind::AssociatedType(container) => {
816                 (ty::AssociatedKind::Type, container, false)
817             }
818             _ => bug!("cannot get associated-item of `{:?}`", def_key)
819         };
820
821         ty::AssociatedItem {
822             name: name,
823             kind: kind,
824             vis: item.visibility.decode(self),
825             defaultness: container.defaultness(),
826             def_id: self.local_def_id(id),
827             container: container.with_def_id(parent),
828             method_has_self_argument: has_self
829         }
830     }
831
832     pub fn get_item_variances(&self, id: DefIndex) -> Vec<ty::Variance> {
833         self.entry(id).variances.decode(self).collect()
834     }
835
836     pub fn get_ctor_kind(&self, node_id: DefIndex) -> CtorKind {
837         match self.entry(node_id).kind {
838             EntryKind::Struct(data, _) |
839             EntryKind::Union(data, _) |
840             EntryKind::Variant(data) => data.decode(self).ctor_kind,
841             _ => CtorKind::Fictive,
842         }
843     }
844
845     pub fn get_struct_ctor_def_id(&self, node_id: DefIndex) -> Option<DefId> {
846         match self.entry(node_id).kind {
847             EntryKind::Struct(data, _) => {
848                 data.decode(self).struct_ctor.map(|index| self.local_def_id(index))
849             }
850             _ => None,
851         }
852     }
853
854     pub fn get_item_attrs(&self, node_id: DefIndex) -> Rc<[ast::Attribute]> {
855         let (node_as, node_index) =
856             (node_id.address_space().index(), node_id.as_array_index());
857         if self.is_proc_macro(node_id) {
858             return Rc::new([]);
859         }
860
861         if let Some(&Some(ref val)) =
862             self.attribute_cache.borrow()[node_as].get(node_index) {
863             return val.clone();
864         }
865
866         // The attributes for a tuple struct are attached to the definition, not the ctor;
867         // we assume that someone passing in a tuple struct ctor is actually wanting to
868         // look at the definition
869         let mut item = self.entry(node_id);
870         let def_key = self.def_key(node_id);
871         if def_key.disambiguated_data.data == DefPathData::StructCtor {
872             item = self.entry(def_key.parent.unwrap());
873         }
874         let result = Rc::__from_array(self.get_attributes(&item).into_boxed_slice());
875         let vec_ = &mut self.attribute_cache.borrow_mut()[node_as];
876         if vec_.len() < node_index + 1 {
877             vec_.resize(node_index + 1, None);
878         }
879         vec_[node_index] = Some(result.clone());
880         result
881     }
882
883     pub fn get_struct_field_names(&self, id: DefIndex) -> Vec<ast::Name> {
884         self.entry(id)
885             .children
886             .decode(self)
887             .map(|index| self.item_name(index))
888             .collect()
889     }
890
891     fn get_attributes(&self, item: &Entry<'tcx>) -> Vec<ast::Attribute> {
892         item.attributes
893             .decode(self)
894             .map(|mut attr| {
895                 // Need new unique IDs: old thread-local IDs won't map to new threads.
896                 attr.id = attr::mk_attr_id();
897                 attr
898             })
899             .collect()
900     }
901
902     // Translate a DefId from the current compilation environment to a DefId
903     // for an external crate.
904     fn reverse_translate_def_id(&self, did: DefId) -> Option<DefId> {
905         for (local, &global) in self.cnum_map.borrow().iter_enumerated() {
906             if global == did.krate {
907                 return Some(DefId {
908                     krate: local,
909                     index: did.index,
910                 });
911             }
912         }
913
914         None
915     }
916
917     pub fn get_inherent_implementations_for_type(&self, id: DefIndex) -> Vec<DefId> {
918         self.entry(id)
919             .inherent_impls
920             .decode(self)
921             .map(|index| self.local_def_id(index))
922             .collect()
923     }
924
925     pub fn get_implementations_for_trait(&self, filter: Option<DefId>, result: &mut Vec<DefId>) {
926         // Do a reverse lookup beforehand to avoid touching the crate_num
927         // hash map in the loop below.
928         let filter = match filter.map(|def_id| self.reverse_translate_def_id(def_id)) {
929             Some(Some(def_id)) => Some((def_id.krate.as_u32(), def_id.index)),
930             Some(None) => return,
931             None if self.proc_macros.is_some() => return,
932             None => None,
933         };
934
935         // FIXME(eddyb) Make this O(1) instead of O(n).
936         for trait_impls in self.root.impls.decode(self) {
937             if filter.is_some() && filter != Some(trait_impls.trait_id) {
938                 continue;
939             }
940
941             result.extend(trait_impls.impls.decode(self).map(|index| self.local_def_id(index)));
942
943             if filter.is_some() {
944                 break;
945             }
946         }
947     }
948
949     pub fn get_trait_of_item(&self, id: DefIndex) -> Option<DefId> {
950         self.def_key(id).parent.and_then(|parent_index| {
951             match self.entry(parent_index).kind {
952                 EntryKind::Trait(_) => Some(self.local_def_id(parent_index)),
953                 _ => None,
954             }
955         })
956     }
957
958
959     pub fn get_native_libraries(&self) -> Vec<NativeLibrary> {
960         self.root.native_libraries.decode(self).collect()
961     }
962
963     pub fn get_dylib_dependency_formats(&self) -> Vec<(CrateNum, LinkagePreference)> {
964         self.root
965             .dylib_dependency_formats
966             .decode(self)
967             .enumerate()
968             .flat_map(|(i, link)| {
969                 let cnum = CrateNum::new(i + 1);
970                 link.map(|link| (self.cnum_map.borrow()[cnum], link))
971             })
972             .collect()
973     }
974
975     pub fn get_missing_lang_items(&self) -> Vec<lang_items::LangItem> {
976         self.root.lang_items_missing.decode(self).collect()
977     }
978
979     pub fn get_fn_arg_names(&self, id: DefIndex) -> Vec<ast::Name> {
980         let arg_names = match self.entry(id).kind {
981             EntryKind::Fn(data) |
982             EntryKind::ForeignFn(data) => data.decode(self).arg_names,
983             EntryKind::Method(data) => data.decode(self).fn_data.arg_names,
984             _ => LazySeq::empty(),
985         };
986         arg_names.decode(self).collect()
987     }
988
989     pub fn get_exported_symbols(&self) -> Vec<DefId> {
990         self.exported_symbols.iter().map(|&index| self.local_def_id(index)).collect()
991     }
992
993     pub fn get_macro(&self, id: DefIndex) -> (ast::Name, MacroDef) {
994         let entry = self.entry(id);
995         match entry.kind {
996             EntryKind::MacroDef(macro_def) => (self.item_name(id), macro_def.decode(self)),
997             _ => bug!(),
998         }
999     }
1000
1001     pub fn is_const_fn(&self, id: DefIndex) -> bool {
1002         let constness = match self.entry(id).kind {
1003             EntryKind::Method(data) => data.decode(self).fn_data.constness,
1004             EntryKind::Fn(data) => data.decode(self).constness,
1005             _ => hir::Constness::NotConst,
1006         };
1007         constness == hir::Constness::Const
1008     }
1009
1010     pub fn is_foreign_item(&self, id: DefIndex) -> bool {
1011         match self.entry(id).kind {
1012             EntryKind::ForeignImmStatic |
1013             EntryKind::ForeignMutStatic |
1014             EntryKind::ForeignFn(_) => true,
1015             _ => false,
1016         }
1017     }
1018
1019     pub fn is_dllimport_foreign_item(&self, id: DefIndex) -> bool {
1020         self.dllimport_foreign_items.contains(&id)
1021     }
1022
1023     pub fn is_default_impl(&self, impl_id: DefIndex) -> bool {
1024         match self.entry(impl_id).kind {
1025             EntryKind::DefaultImpl(_) => true,
1026             _ => false,
1027         }
1028     }
1029
1030     pub fn closure_kind(&self, closure_id: DefIndex) -> ty::ClosureKind {
1031         match self.entry(closure_id).kind {
1032             EntryKind::Closure(data) => data.decode(self).kind,
1033             _ => bug!(),
1034         }
1035     }
1036
1037     pub fn closure_ty(&self,
1038                       closure_id: DefIndex,
1039                       tcx: TyCtxt<'a, 'tcx, 'tcx>)
1040                       -> ty::PolyFnSig<'tcx> {
1041         match self.entry(closure_id).kind {
1042             EntryKind::Closure(data) => data.decode(self).ty.decode((self, tcx)),
1043             _ => bug!(),
1044         }
1045     }
1046
1047     #[inline]
1048     pub fn def_key(&self, index: DefIndex) -> DefKey {
1049         self.def_path_table.def_key(index)
1050     }
1051
1052     // Returns the path leading to the thing with this `id`.
1053     pub fn def_path(&self, id: DefIndex) -> DefPath {
1054         debug!("def_path(id={:?})", id);
1055         DefPath::make(self.cnum, id, |parent| self.def_path_table.def_key(parent))
1056     }
1057
1058     #[inline]
1059     pub fn def_path_hash(&self, index: DefIndex) -> u64 {
1060         self.def_path_table.def_path_hash(index)
1061     }
1062
1063     /// Imports the codemap from an external crate into the codemap of the crate
1064     /// currently being compiled (the "local crate").
1065     ///
1066     /// The import algorithm works analogous to how AST items are inlined from an
1067     /// external crate's metadata:
1068     /// For every FileMap in the external codemap an 'inline' copy is created in the
1069     /// local codemap. The correspondence relation between external and local
1070     /// FileMaps is recorded in the `ImportedFileMap` objects returned from this
1071     /// function. When an item from an external crate is later inlined into this
1072     /// crate, this correspondence information is used to translate the span
1073     /// information of the inlined item so that it refers the correct positions in
1074     /// the local codemap (see `<decoder::DecodeContext as SpecializedDecoder<Span>>`).
1075     ///
1076     /// The import algorithm in the function below will reuse FileMaps already
1077     /// existing in the local codemap. For example, even if the FileMap of some
1078     /// source file of libstd gets imported many times, there will only ever be
1079     /// one FileMap object for the corresponding file in the local codemap.
1080     ///
1081     /// Note that imported FileMaps do not actually contain the source code of the
1082     /// file they represent, just information about length, line breaks, and
1083     /// multibyte characters. This information is enough to generate valid debuginfo
1084     /// for items inlined from other crates.
1085     pub fn imported_filemaps(&'a self,
1086                              local_codemap: &codemap::CodeMap)
1087                              -> Ref<'a, Vec<cstore::ImportedFileMap>> {
1088         {
1089             let filemaps = self.codemap_import_info.borrow();
1090             if !filemaps.is_empty() {
1091                 return filemaps;
1092             }
1093         }
1094
1095         let external_codemap = self.root.codemap.decode(self);
1096
1097         let imported_filemaps = external_codemap.map(|filemap_to_import| {
1098                 // Try to find an existing FileMap that can be reused for the filemap to
1099                 // be imported. A FileMap is reusable if it is exactly the same, just
1100                 // positioned at a different offset within the codemap.
1101                 let reusable_filemap = {
1102                     local_codemap.files
1103                         .borrow()
1104                         .iter()
1105                         .find(|fm| are_equal_modulo_startpos(&fm, &filemap_to_import))
1106                         .map(|rc| rc.clone())
1107                 };
1108
1109                 match reusable_filemap {
1110                     Some(fm) => {
1111
1112                         debug!("CrateMetaData::imported_filemaps reuse \
1113                                 filemap {:?} original (start_pos {:?} end_pos {:?}) \
1114                                 translated (start_pos {:?} end_pos {:?})",
1115                                filemap_to_import.name,
1116                                filemap_to_import.start_pos, filemap_to_import.end_pos,
1117                                fm.start_pos, fm.end_pos);
1118
1119                         cstore::ImportedFileMap {
1120                             original_start_pos: filemap_to_import.start_pos,
1121                             original_end_pos: filemap_to_import.end_pos,
1122                             translated_filemap: fm,
1123                         }
1124                     }
1125                     None => {
1126                         // We can't reuse an existing FileMap, so allocate a new one
1127                         // containing the information we need.
1128                         let syntax_pos::FileMap { name,
1129                                                   name_was_remapped,
1130                                                   start_pos,
1131                                                   end_pos,
1132                                                   lines,
1133                                                   multibyte_chars,
1134                                                   .. } = filemap_to_import;
1135
1136                         let source_length = (end_pos - start_pos).to_usize();
1137
1138                         // Translate line-start positions and multibyte character
1139                         // position into frame of reference local to file.
1140                         // `CodeMap::new_imported_filemap()` will then translate those
1141                         // coordinates to their new global frame of reference when the
1142                         // offset of the FileMap is known.
1143                         let mut lines = lines.into_inner();
1144                         for pos in &mut lines {
1145                             *pos = *pos - start_pos;
1146                         }
1147                         let mut multibyte_chars = multibyte_chars.into_inner();
1148                         for mbc in &mut multibyte_chars {
1149                             mbc.pos = mbc.pos - start_pos;
1150                         }
1151
1152                         let local_version = local_codemap.new_imported_filemap(name,
1153                                                                                name_was_remapped,
1154                                                                                source_length,
1155                                                                                lines,
1156                                                                                multibyte_chars);
1157                         debug!("CrateMetaData::imported_filemaps alloc \
1158                                 filemap {:?} original (start_pos {:?} end_pos {:?}) \
1159                                 translated (start_pos {:?} end_pos {:?})",
1160                                local_version.name, start_pos, end_pos,
1161                                local_version.start_pos, local_version.end_pos);
1162
1163                         cstore::ImportedFileMap {
1164                             original_start_pos: start_pos,
1165                             original_end_pos: end_pos,
1166                             translated_filemap: local_version,
1167                         }
1168                     }
1169                 }
1170             })
1171             .collect();
1172
1173         // This shouldn't borrow twice, but there is no way to downgrade RefMut to Ref.
1174         *self.codemap_import_info.borrow_mut() = imported_filemaps;
1175         self.codemap_import_info.borrow()
1176     }
1177 }
1178
1179 fn are_equal_modulo_startpos(fm1: &syntax_pos::FileMap, fm2: &syntax_pos::FileMap) -> bool {
1180     if fm1.byte_length() != fm2.byte_length() {
1181         return false;
1182     }
1183
1184     if fm1.name != fm2.name {
1185         return false;
1186     }
1187
1188     let lines1 = fm1.lines.borrow();
1189     let lines2 = fm2.lines.borrow();
1190
1191     if lines1.len() != lines2.len() {
1192         return false;
1193     }
1194
1195     for (&line1, &line2) in lines1.iter().zip(lines2.iter()) {
1196         if (line1 - fm1.start_pos) != (line2 - fm2.start_pos) {
1197             return false;
1198         }
1199     }
1200
1201     let multibytes1 = fm1.multibyte_chars.borrow();
1202     let multibytes2 = fm2.multibyte_chars.borrow();
1203
1204     if multibytes1.len() != multibytes2.len() {
1205         return false;
1206     }
1207
1208     for (mb1, mb2) in multibytes1.iter().zip(multibytes2.iter()) {
1209         if (mb1.bytes != mb2.bytes) || ((mb1.pos - fm1.start_pos) != (mb2.pos - fm2.start_pos)) {
1210             return false;
1211         }
1212     }
1213
1214     true
1215 }