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