src/librustc_metadata/decoder.rs

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