src/librustc_metadata/encoder.rs

   1 // Copyright 2012-2015 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 use cstore;
  12 use index::Index;
  13 use schema::*;
  14
  15 use rustc::middle::cstore::{LinkMeta, LinkagePreference, NativeLibrary};
  16 use rustc::hir::def;
  17 use rustc::hir::def_id::{CrateNum, CRATE_DEF_INDEX, DefIndex, DefId};
  18 use rustc::hir::map::definitions::DefPathTable;
  19 use rustc::middle::dependency_format::Linkage;
  20 use rustc::middle::lang_items;
  21 use rustc::mir;
  22 use rustc::traits::specialization_graph;
  23 use rustc::ty::{self, Ty, TyCtxt};
  24
  25 use rustc::session::config::{self, CrateTypeProcMacro};
  26 use rustc::util::nodemap::{FxHashMap, NodeSet};
  27
  28 use rustc_serialize::{Encodable, Encoder, SpecializedEncoder, opaque};
  29 use std::hash::Hash;
  30 use std::intrinsics;
  31 use std::io::prelude::*;
  32 use std::io::Cursor;
  33 use std::rc::Rc;
  34 use std::u32;
  35 use syntax::ast::{self, CRATE_NODE_ID};
  36 use syntax::codemap::Spanned;
  37 use syntax::attr;
  38 use syntax::symbol::Symbol;
  39 use syntax_pos;
  40
  41 use rustc::hir::{self, PatKind};
  42 use rustc::hir::itemlikevisit::ItemLikeVisitor;
  43 use rustc::hir::intravisit::{Visitor, NestedVisitorMap};
  44 use rustc::hir::intravisit;
  45
  46 use rustc_i128::{u128, i128};
  47
  48 use super::index_builder::{FromId, IndexBuilder, Untracked};
  49
  50 pub struct EncodeContext<'a, 'tcx: 'a> {
  51     opaque: opaque::Encoder<'a>,
  52     pub tcx: TyCtxt<'a, 'tcx, 'tcx>,
  53     reexports: &'a def::ExportMap,
  54     link_meta: &'a LinkMeta,
  55     cstore: &'a cstore::CStore,
  56     exported_symbols: &'a NodeSet,
  57
  58     lazy_state: LazyState,
  59     type_shorthands: FxHashMap<Ty<'tcx>, usize>,
  60     predicate_shorthands: FxHashMap<ty::Predicate<'tcx>, usize>,
  61 }
  62
  63 macro_rules! encoder_methods {
  64     ($($name:ident($ty:ty);)*) => {
  65         $(fn $name(&mut self, value: $ty) -> Result<(), Self::Error> {
  66             self.opaque.$name(value)
  67         })*
  68     }
  69 }
  70
  71 impl<'a, 'tcx> Encoder for EncodeContext<'a, 'tcx> {
  72     type Error = <opaque::Encoder<'a> as Encoder>::Error;
  73
  74     fn emit_nil(&mut self) -> Result<(), Self::Error> {
  75         Ok(())
  76     }
  77
  78     encoder_methods! {
  79         emit_usize(usize);
  80         emit_u128(u128);
  81         emit_u64(u64);
  82         emit_u32(u32);
  83         emit_u16(u16);
  84         emit_u8(u8);
  85
  86         emit_isize(isize);
  87         emit_i128(i128);
  88         emit_i64(i64);
  89         emit_i32(i32);
  90         emit_i16(i16);
  91         emit_i8(i8);
  92
  93         emit_bool(bool);
  94         emit_f64(f64);
  95         emit_f32(f32);
  96         emit_char(char);
  97         emit_str(&str);
  98     }
  99 }
 100
 101 impl<'a, 'tcx, T> SpecializedEncoder<Lazy<T>> for EncodeContext<'a, 'tcx> {
 102     fn specialized_encode(&mut self, lazy: &Lazy<T>) -> Result<(), Self::Error> {
 103         self.emit_lazy_distance(lazy.position, Lazy::<T>::min_size())
 104     }
 105 }
 106
 107 impl<'a, 'tcx, T> SpecializedEncoder<LazySeq<T>> for EncodeContext<'a, 'tcx> {
 108     fn specialized_encode(&mut self, seq: &LazySeq<T>) -> Result<(), Self::Error> {
 109         self.emit_usize(seq.len)?;
 110         if seq.len == 0 {
 111             return Ok(());
 112         }
 113         self.emit_lazy_distance(seq.position, LazySeq::<T>::min_size(seq.len))
 114     }
 115 }
 116
 117 impl<'a, 'tcx> SpecializedEncoder<Ty<'tcx>> for EncodeContext<'a, 'tcx> {
 118     fn specialized_encode(&mut self, ty: &Ty<'tcx>) -> Result<(), Self::Error> {
 119         self.encode_with_shorthand(ty, &ty.sty, |ecx| &mut ecx.type_shorthands)
 120     }
 121 }
 122
 123 impl<'a, 'tcx> SpecializedEncoder<ty::GenericPredicates<'tcx>> for EncodeContext<'a, 'tcx> {
 124     fn specialized_encode(&mut self,
 125                           predicates: &ty::GenericPredicates<'tcx>)
 126                           -> Result<(), Self::Error> {
 127         predicates.parent.encode(self)?;
 128         predicates.predicates.len().encode(self)?;
 129         for predicate in &predicates.predicates {
 130             self.encode_with_shorthand(predicate, predicate, |ecx| &mut ecx.predicate_shorthands)?
 131         }
 132         Ok(())
 133     }
 134 }
 135
 136 impl<'a, 'tcx> EncodeContext<'a, 'tcx> {
 137     pub fn position(&self) -> usize {
 138         self.opaque.position()
 139     }
 140
 141     fn emit_node<F: FnOnce(&mut Self, usize) -> R, R>(&mut self, f: F) -> R {
 142         assert_eq!(self.lazy_state, LazyState::NoNode);
 143         let pos = self.position();
 144         self.lazy_state = LazyState::NodeStart(pos);
 145         let r = f(self, pos);
 146         self.lazy_state = LazyState::NoNode;
 147         r
 148     }
 149
 150     fn emit_lazy_distance(&mut self,
 151                           position: usize,
 152                           min_size: usize)
 153                           -> Result<(), <Self as Encoder>::Error> {
 154         let min_end = position + min_size;
 155         let distance = match self.lazy_state {
 156             LazyState::NoNode => bug!("emit_lazy_distance: outside of a metadata node"),
 157             LazyState::NodeStart(start) => {
 158                 assert!(min_end <= start);
 159                 start - min_end
 160             }
 161             LazyState::Previous(last_min_end) => {
 162                 assert!(last_min_end <= position);
 163                 position - last_min_end
 164             }
 165         };
 166         self.lazy_state = LazyState::Previous(min_end);
 167         self.emit_usize(distance)
 168     }
 169
 170     pub fn lazy<T: Encodable>(&mut self, value: &T) -> Lazy<T> {
 171         self.emit_node(|ecx, pos| {
 172             value.encode(ecx).unwrap();
 173
 174             assert!(pos + Lazy::<T>::min_size() <= ecx.position());
 175             Lazy::with_position(pos)
 176         })
 177     }
 178
 179     fn lazy_seq<I, T>(&mut self, iter: I) -> LazySeq<T>
 180         where I: IntoIterator<Item = T>,
 181               T: Encodable
 182     {
 183         self.emit_node(|ecx, pos| {
 184             let len = iter.into_iter().map(|value| value.encode(ecx).unwrap()).count();
 185
 186             assert!(pos + LazySeq::<T>::min_size(len) <= ecx.position());
 187             LazySeq::with_position_and_length(pos, len)
 188         })
 189     }
 190
 191     fn lazy_seq_ref<'b, I, T>(&mut self, iter: I) -> LazySeq<T>
 192         where I: IntoIterator<Item = &'b T>,
 193               T: 'b + Encodable
 194     {
 195         self.emit_node(|ecx, pos| {
 196             let len = iter.into_iter().map(|value| value.encode(ecx).unwrap()).count();
 197
 198             assert!(pos + LazySeq::<T>::min_size(len) <= ecx.position());
 199             LazySeq::with_position_and_length(pos, len)
 200         })
 201     }
 202
 203     /// Encode the given value or a previously cached shorthand.
 204     fn encode_with_shorthand<T, U, M>(&mut self,
 205                                       value: &T,
 206                                       variant: &U,
 207                                       map: M)
 208                                       -> Result<(), <Self as Encoder>::Error>
 209         where M: for<'b> Fn(&'b mut Self) -> &'b mut FxHashMap<T, usize>,
 210               T: Clone + Eq + Hash,
 211               U: Encodable
 212     {
 213         let existing_shorthand = map(self).get(value).cloned();
 214         if let Some(shorthand) = existing_shorthand {
 215             return self.emit_usize(shorthand);
 216         }
 217
 218         let start = self.position();
 219         variant.encode(self)?;
 220         let len = self.position() - start;
 221
 222         // The shorthand encoding uses the same usize as the
 223         // discriminant, with an offset so they can't conflict.
 224         let discriminant = unsafe { intrinsics::discriminant_value(variant) };
 225         assert!(discriminant < SHORTHAND_OFFSET as u64);
 226         let shorthand = start + SHORTHAND_OFFSET;
 227
 228         // Get the number of bits that leb128 could fit
 229         // in the same space as the fully encoded type.
 230         let leb128_bits = len * 7;
 231
 232         // Check that the shorthand is a not longer than the
 233         // full encoding itself, i.e. it's an obvious win.
 234         if leb128_bits >= 64 || (shorthand as u64) < (1 << leb128_bits) {
 235             map(self).insert(value.clone(), shorthand);
 236         }
 237
 238         Ok(())
 239     }
 240
 241     fn encode_item_variances(&mut self, def_id: DefId) -> LazySeq<ty::Variance> {
 242         let tcx = self.tcx;
 243         self.lazy_seq(tcx.item_variances(def_id).iter().cloned())
 244     }
 245
 246     fn encode_item_type(&mut self, def_id: DefId) -> Lazy<Ty<'tcx>> {
 247         let tcx = self.tcx;
 248         self.lazy(&tcx.item_type(def_id))
 249     }
 250
 251     /// Encode data for the given variant of the given ADT. The
 252     /// index of the variant is untracked: this is ok because we
 253     /// will have to lookup the adt-def by its id, and that gives us
 254     /// the right to access any information in the adt-def (including,
 255     /// e.g., the length of the various vectors).
 256     fn encode_enum_variant_info(&mut self,
 257                                 (enum_did, Untracked(index)): (DefId, Untracked<usize>))
 258                                 -> Entry<'tcx> {
 259         let tcx = self.tcx;
 260         let def = tcx.lookup_adt_def(enum_did);
 261         let variant = &def.variants[index];
 262         let def_id = variant.did;
 263
 264         let data = VariantData {
 265             ctor_kind: variant.ctor_kind,
 266             disr: variant.disr_val.to_u128_unchecked(),
 267             struct_ctor: None,
 268         };
 269
 270         let enum_id = tcx.hir.as_local_node_id(enum_did).unwrap();
 271         let enum_vis = &tcx.hir.expect_item(enum_id).vis;
 272
 273         Entry {
 274             kind: EntryKind::Variant(self.lazy(&data)),
 275             visibility: self.lazy(&ty::Visibility::from_hir(enum_vis, enum_id, tcx)),
 276             span: self.lazy(&tcx.def_span(def_id)),
 277             attributes: self.encode_attributes(&tcx.get_attrs(def_id)),
 278             children: self.lazy_seq(variant.fields.iter().map(|f| {
 279                 assert!(f.did.is_local());
 280                 f.did.index
 281             })),
 282             stability: self.encode_stability(def_id),
 283             deprecation: self.encode_deprecation(def_id),
 284
 285             ty: Some(self.encode_item_type(def_id)),
 286             inherent_impls: LazySeq::empty(),
 287             variances: LazySeq::empty(),
 288             generics: Some(self.encode_generics(def_id)),
 289             predicates: Some(self.encode_predicates(def_id)),
 290
 291             ast: None,
 292             mir: None,
 293         }
 294     }
 295
 296     fn encode_info_for_mod(&mut self,
 297                            FromId(id, (md, attrs, vis)): FromId<(&hir::Mod,
 298                                                                  &[ast::Attribute],
 299                                                                  &hir::Visibility)>)
 300                            -> Entry<'tcx> {
 301         let tcx = self.tcx;
 302         let def_id = tcx.hir.local_def_id(id);
 303
 304         let data = ModData {
 305             reexports: match self.reexports.get(&id) {
 306                 Some(exports) if *vis == hir::Public => self.lazy_seq_ref(exports),
 307                 _ => LazySeq::empty(),
 308             },
 309         };
 310
 311         Entry {
 312             kind: EntryKind::Mod(self.lazy(&data)),
 313             visibility: self.lazy(&ty::Visibility::from_hir(vis, id, tcx)),
 314             span: self.lazy(&md.inner),
 315             attributes: self.encode_attributes(attrs),
 316             children: self.lazy_seq(md.item_ids.iter().map(|item_id| {
 317                 tcx.hir.local_def_id(item_id.id).index
 318             })),
 319             stability: self.encode_stability(def_id),
 320             deprecation: self.encode_deprecation(def_id),
 321
 322             ty: None,
 323             inherent_impls: LazySeq::empty(),
 324             variances: LazySeq::empty(),
 325             generics: None,
 326             predicates: None,
 327
 328             ast: None,
 329             mir: None
 330         }
 331     }
 332 }
 333
 334 impl<'a, 'b, 'tcx> IndexBuilder<'a, 'b, 'tcx> {
 335     fn encode_fields(&mut self, adt_def_id: DefId) {
 336         let def = self.tcx.lookup_adt_def(adt_def_id);
 337         for (variant_index, variant) in def.variants.iter().enumerate() {
 338             for (field_index, field) in variant.fields.iter().enumerate() {
 339                 self.record(field.did,
 340                             EncodeContext::encode_field,
 341                             (adt_def_id, Untracked((variant_index, field_index))));
 342             }
 343         }
 344     }
 345 }
 346
 347 impl<'a, 'tcx> EncodeContext<'a, 'tcx> {
 348     /// Encode data for the given field of the given variant of the
 349     /// given ADT. The indices of the variant/field are untracked:
 350     /// this is ok because we will have to lookup the adt-def by its
 351     /// id, and that gives us the right to access any information in
 352     /// the adt-def (including, e.g., the length of the various
 353     /// vectors).
 354     fn encode_field(&mut self,
 355                     (adt_def_id, Untracked((variant_index, field_index))): (DefId,
 356                                                                             Untracked<(usize,
 357                                                                                        usize)>))
 358                     -> Entry<'tcx> {
 359         let tcx = self.tcx;
 360         let variant = &tcx.lookup_adt_def(adt_def_id).variants[variant_index];
 361         let field = &variant.fields[field_index];
 362
 363         let def_id = field.did;
 364         let variant_id = tcx.hir.as_local_node_id(variant.did).unwrap();
 365         let variant_data = tcx.hir.expect_variant_data(variant_id);
 366
 367         Entry {
 368             kind: EntryKind::Field,
 369             visibility: self.lazy(&field.vis),
 370             span: self.lazy(&tcx.def_span(def_id)),
 371             attributes: self.encode_attributes(&variant_data.fields()[field_index].attrs),
 372             children: LazySeq::empty(),
 373             stability: self.encode_stability(def_id),
 374             deprecation: self.encode_deprecation(def_id),
 375
 376             ty: Some(self.encode_item_type(def_id)),
 377             inherent_impls: LazySeq::empty(),
 378             variances: LazySeq::empty(),
 379             generics: Some(self.encode_generics(def_id)),
 380             predicates: Some(self.encode_predicates(def_id)),
 381
 382             ast: None,
 383             mir: None,
 384         }
 385     }
 386
 387     fn encode_struct_ctor(&mut self, (adt_def_id, def_id): (DefId, DefId)) -> Entry<'tcx> {
 388         let tcx = self.tcx;
 389         let variant = tcx.lookup_adt_def(adt_def_id).struct_variant();
 390
 391         let data = VariantData {
 392             ctor_kind: variant.ctor_kind,
 393             disr: variant.disr_val.to_u128_unchecked(),
 394             struct_ctor: Some(def_id.index),
 395         };
 396
 397         let struct_id = tcx.hir.as_local_node_id(adt_def_id).unwrap();
 398         let struct_vis = &tcx.hir.expect_item(struct_id).vis;
 399         let mut ctor_vis = ty::Visibility::from_hir(struct_vis, struct_id, tcx);
 400         for field in &variant.fields {
 401             if ctor_vis.is_at_least(field.vis, tcx) {
 402                 ctor_vis = field.vis;
 403             }
 404         }
 405
 406         Entry {
 407             kind: EntryKind::Struct(self.lazy(&data)),
 408             visibility: self.lazy(&ctor_vis),
 409             span: self.lazy(&tcx.def_span(def_id)),
 410             attributes: LazySeq::empty(),
 411             children: LazySeq::empty(),
 412             stability: self.encode_stability(def_id),
 413             deprecation: self.encode_deprecation(def_id),
 414
 415             ty: Some(self.encode_item_type(def_id)),
 416             inherent_impls: LazySeq::empty(),
 417             variances: LazySeq::empty(),
 418             generics: Some(self.encode_generics(def_id)),
 419             predicates: Some(self.encode_predicates(def_id)),
 420
 421             ast: None,
 422             mir: None,
 423         }
 424     }
 425
 426     fn encode_generics(&mut self, def_id: DefId) -> Lazy<Generics<'tcx>> {
 427         let tcx = self.tcx;
 428         let g = tcx.item_generics(def_id);
 429         let regions = self.lazy_seq_ref(&g.regions);
 430         let types = self.lazy_seq_ref(&g.types);
 431         let mut object_lifetime_defaults = LazySeq::empty();
 432         if let Some(id) = tcx.hir.as_local_node_id(def_id) {
 433             if let Some(o) = tcx.named_region_map.object_lifetime_defaults.get(&id) {
 434                 object_lifetime_defaults = self.lazy_seq_ref(o);
 435             }
 436         }
 437         self.lazy(&Generics {
 438             parent: g.parent,
 439             parent_regions: g.parent_regions,
 440             parent_types: g.parent_types,
 441             regions: regions,
 442             types: types,
 443             has_self: g.has_self,
 444             object_lifetime_defaults: object_lifetime_defaults,
 445         })
 446     }
 447
 448     fn encode_predicates(&mut self, def_id: DefId) -> Lazy<ty::GenericPredicates<'tcx>> {
 449         let tcx = self.tcx;
 450         self.lazy(&tcx.item_predicates(def_id))
 451     }
 452
 453     fn encode_info_for_trait_item(&mut self, def_id: DefId) -> Entry<'tcx> {
 454         let tcx = self.tcx;
 455
 456         let node_id = tcx.hir.as_local_node_id(def_id).unwrap();
 457         let ast_item = tcx.hir.expect_trait_item(node_id);
 458         let trait_item = tcx.associated_item(def_id);
 459
 460         let container = match trait_item.defaultness {
 461             hir::Defaultness::Default { has_value: true } =>
 462                 AssociatedContainer::TraitWithDefault,
 463             hir::Defaultness::Default { has_value: false } =>
 464                 AssociatedContainer::TraitRequired,
 465             hir::Defaultness::Final =>
 466                 span_bug!(ast_item.span, "traits cannot have final items"),
 467         };
 468
 469         let kind = match trait_item.kind {
 470             ty::AssociatedKind::Const => EntryKind::AssociatedConst(container),
 471             ty::AssociatedKind::Method => {
 472                 let fn_data = if let hir::TraitItemKind::Method(_, ref m) = ast_item.node {
 473                     let arg_names = match *m {
 474                         hir::TraitMethod::Required(ref names) => {
 475                             self.encode_fn_arg_names(names)
 476                         }
 477                         hir::TraitMethod::Provided(body) => {
 478                             self.encode_fn_arg_names_for_body(body)
 479                         }
 480                     };
 481                     FnData {
 482                         constness: hir::Constness::NotConst,
 483                         arg_names: arg_names
 484                     }
 485                 } else {
 486                     bug!()
 487                 };
 488                 EntryKind::Method(self.lazy(&MethodData {
 489                     fn_data: fn_data,
 490                     container: container,
 491                     has_self: trait_item.method_has_self_argument,
 492                 }))
 493             }
 494             ty::AssociatedKind::Type => EntryKind::AssociatedType(container),
 495         };
 496
 497         Entry {
 498             kind: kind,
 499             visibility: self.lazy(&trait_item.vis),
 500             span: self.lazy(&ast_item.span),
 501             attributes: self.encode_attributes(&ast_item.attrs),
 502             children: LazySeq::empty(),
 503             stability: self.encode_stability(def_id),
 504             deprecation: self.encode_deprecation(def_id),
 505
 506             ty: match trait_item.kind {
 507                 ty::AssociatedKind::Const |
 508                 ty::AssociatedKind::Method => {
 509                     Some(self.encode_item_type(def_id))
 510                 }
 511                 ty::AssociatedKind::Type => {
 512                     if trait_item.defaultness.has_value() {
 513                         Some(self.encode_item_type(def_id))
 514                     } else {
 515                         None
 516                     }
 517                 }
 518             },
 519             inherent_impls: LazySeq::empty(),
 520             variances: LazySeq::empty(),
 521             generics: Some(self.encode_generics(def_id)),
 522             predicates: Some(self.encode_predicates(def_id)),
 523
 524             ast: if let hir::TraitItemKind::Const(_, Some(body)) = ast_item.node {
 525                 Some(self.encode_body(body))
 526             } else {
 527                 None
 528             },
 529             mir: self.encode_mir(def_id),
 530         }
 531     }
 532
 533     fn encode_info_for_impl_item(&mut self, def_id: DefId) -> Entry<'tcx> {
 534         let node_id = self.tcx.hir.as_local_node_id(def_id).unwrap();
 535         let ast_item = self.tcx.hir.expect_impl_item(node_id);
 536         let impl_item = self.tcx.associated_item(def_id);
 537
 538         let container = match impl_item.defaultness {
 539             hir::Defaultness::Default { has_value: true } => AssociatedContainer::ImplDefault,
 540             hir::Defaultness::Final => AssociatedContainer::ImplFinal,
 541             hir::Defaultness::Default { has_value: false } =>
 542                 span_bug!(ast_item.span, "impl items always have values (currently)"),
 543         };
 544
 545         let kind = match impl_item.kind {
 546             ty::AssociatedKind::Const => EntryKind::AssociatedConst(container),
 547             ty::AssociatedKind::Method => {
 548                 let fn_data = if let hir::ImplItemKind::Method(ref sig, body) = ast_item.node {
 549                     FnData {
 550                         constness: sig.constness,
 551                         arg_names: self.encode_fn_arg_names_for_body(body),
 552                     }
 553                 } else {
 554                     bug!()
 555                 };
 556                 EntryKind::Method(self.lazy(&MethodData {
 557                     fn_data: fn_data,
 558                     container: container,
 559                     has_self: impl_item.method_has_self_argument,
 560                 }))
 561             }
 562             ty::AssociatedKind::Type => EntryKind::AssociatedType(container)
 563         };
 564
 565         let (ast, mir) = if let hir::ImplItemKind::Const(_, body) = ast_item.node {
 566             (Some(body), true)
 567         } else if let hir::ImplItemKind::Method(ref sig, body) = ast_item.node {
 568             let generics = self.tcx.item_generics(def_id);
 569             let types = generics.parent_types as usize + generics.types.len();
 570             let needs_inline = types > 0 || attr::requests_inline(&ast_item.attrs);
 571             let is_const_fn = sig.constness == hir::Constness::Const;
 572             let ast = if is_const_fn { Some(body) } else { None };
 573             let always_encode_mir = self.tcx.sess.opts.debugging_opts.always_encode_mir;
 574             (ast, needs_inline || is_const_fn || always_encode_mir)
 575         } else {
 576             (None, false)
 577         };
 578
 579         Entry {
 580             kind: kind,
 581             visibility: self.lazy(&impl_item.vis),
 582             span: self.lazy(&ast_item.span),
 583             attributes: self.encode_attributes(&ast_item.attrs),
 584             children: LazySeq::empty(),
 585             stability: self.encode_stability(def_id),
 586             deprecation: self.encode_deprecation(def_id),
 587
 588             ty: Some(self.encode_item_type(def_id)),
 589             inherent_impls: LazySeq::empty(),
 590             variances: LazySeq::empty(),
 591             generics: Some(self.encode_generics(def_id)),
 592             predicates: Some(self.encode_predicates(def_id)),
 593
 594             ast: ast.map(|body| self.encode_body(body)),
 595             mir: if mir { self.encode_mir(def_id) } else { None },
 596         }
 597     }
 598
 599     fn encode_fn_arg_names_for_body(&mut self, body_id: hir::BodyId)
 600                                     -> LazySeq<ast::Name> {
 601         let _ignore = self.tcx.dep_graph.in_ignore();
 602         let body = self.tcx.hir.body(body_id);
 603         self.lazy_seq(body.arguments.iter().map(|arg| {
 604             match arg.pat.node {
 605                 PatKind::Binding(_, _, name, _) => name.node,
 606                 _ => Symbol::intern("")
 607             }
 608         }))
 609     }
 610
 611     fn encode_fn_arg_names(&mut self, names: &[Spanned<ast::Name>])
 612                            -> LazySeq<ast::Name> {
 613         self.lazy_seq(names.iter().map(|name| name.node))
 614     }
 615
 616     fn encode_mir(&mut self, def_id: DefId) -> Option<Lazy<mir::Mir<'tcx>>> {
 617         self.tcx.mir_map.borrow().get(&def_id).map(|mir| self.lazy(&*mir.borrow()))
 618     }
 619
 620     // Encodes the inherent implementations of a structure, enumeration, or trait.
 621     fn encode_inherent_implementations(&mut self, def_id: DefId) -> LazySeq<DefIndex> {
 622         match self.tcx.inherent_impls.borrow().get(&def_id) {
 623             None => LazySeq::empty(),
 624             Some(implementations) => {
 625                 self.lazy_seq(implementations.iter().map(|&def_id| {
 626                     assert!(def_id.is_local());
 627                     def_id.index
 628                 }))
 629             }
 630         }
 631     }
 632
 633     fn encode_stability(&mut self, def_id: DefId) -> Option<Lazy<attr::Stability>> {
 634         self.tcx.lookup_stability(def_id).map(|stab| self.lazy(stab))
 635     }
 636
 637     fn encode_deprecation(&mut self, def_id: DefId) -> Option<Lazy<attr::Deprecation>> {
 638         self.tcx.lookup_deprecation(def_id).map(|depr| self.lazy(&depr))
 639     }
 640
 641     fn encode_info_for_item(&mut self, (def_id, item): (DefId, &'tcx hir::Item)) -> Entry<'tcx> {
 642         let tcx = self.tcx;
 643
 644         debug!("encoding info for item at {}",
 645                tcx.sess.codemap().span_to_string(item.span));
 646
 647         let kind = match item.node {
 648             hir::ItemStatic(_, hir::MutMutable, _) => EntryKind::MutStatic,
 649             hir::ItemStatic(_, hir::MutImmutable, _) => EntryKind::ImmStatic,
 650             hir::ItemConst(..) => EntryKind::Const,
 651             hir::ItemFn(_, _, constness, .., body) => {
 652                 let data = FnData {
 653                     constness: constness,
 654                     arg_names: self.encode_fn_arg_names_for_body(body),
 655                 };
 656
 657                 EntryKind::Fn(self.lazy(&data))
 658             }
 659             hir::ItemMod(ref m) => {
 660                 return self.encode_info_for_mod(FromId(item.id, (m, &item.attrs, &item.vis)));
 661             }
 662             hir::ItemForeignMod(_) => EntryKind::ForeignMod,
 663             hir::ItemTy(..) => EntryKind::Type,
 664             hir::ItemEnum(..) => EntryKind::Enum,
 665             hir::ItemStruct(ref struct_def, _) => {
 666                 let variant = tcx.lookup_adt_def(def_id).struct_variant();
 667
 668                 // Encode def_ids for each field and method
 669                 // for methods, write all the stuff get_trait_method
 670                 // needs to know
 671                 let struct_ctor = if !struct_def.is_struct() {
 672                     Some(tcx.hir.local_def_id(struct_def.id()).index)
 673                 } else {
 674                     None
 675                 };
 676                 EntryKind::Struct(self.lazy(&VariantData {
 677                     ctor_kind: variant.ctor_kind,
 678                     disr: variant.disr_val.to_u128_unchecked(),
 679                     struct_ctor: struct_ctor,
 680                 }))
 681             }
 682             hir::ItemUnion(..) => {
 683                 let variant = tcx.lookup_adt_def(def_id).struct_variant();
 684
 685                 EntryKind::Union(self.lazy(&VariantData {
 686                     ctor_kind: variant.ctor_kind,
 687                     disr: variant.disr_val.to_u128_unchecked(),
 688                     struct_ctor: None,
 689                 }))
 690             }
 691             hir::ItemDefaultImpl(..) => {
 692                 let data = ImplData {
 693                     polarity: hir::ImplPolarity::Positive,
 694                     parent_impl: None,
 695                     coerce_unsized_kind: None,
 696                     trait_ref: tcx.impl_trait_ref(def_id).map(|trait_ref| self.lazy(&trait_ref)),
 697                 };
 698
 699                 EntryKind::DefaultImpl(self.lazy(&data))
 700             }
 701             hir::ItemImpl(_, polarity, ..) => {
 702                 let trait_ref = tcx.impl_trait_ref(def_id);
 703                 let parent = if let Some(trait_ref) = trait_ref {
 704                     let trait_def = tcx.lookup_trait_def(trait_ref.def_id);
 705                     trait_def.ancestors(def_id).skip(1).next().and_then(|node| {
 706                         match node {
 707                             specialization_graph::Node::Impl(parent) => Some(parent),
 708                             _ => None,
 709                         }
 710                     })
 711                 } else {
 712                     None
 713                 };
 714
 715                 let data = ImplData {
 716                     polarity: polarity,
 717                     parent_impl: parent,
 718                     coerce_unsized_kind: tcx.custom_coerce_unsized_kinds
 719                         .borrow()
 720                         .get(&def_id)
 721                         .cloned(),
 722                     trait_ref: trait_ref.map(|trait_ref| self.lazy(&trait_ref)),
 723                 };
 724
 725                 EntryKind::Impl(self.lazy(&data))
 726             }
 727             hir::ItemTrait(..) => {
 728                 let trait_def = tcx.lookup_trait_def(def_id);
 729                 let data = TraitData {
 730                     unsafety: trait_def.unsafety,
 731                     paren_sugar: trait_def.paren_sugar,
 732                     has_default_impl: tcx.trait_has_default_impl(def_id),
 733                     super_predicates: self.lazy(&tcx.item_super_predicates(def_id)),
 734                 };
 735
 736                 EntryKind::Trait(self.lazy(&data))
 737             }
 738             hir::ItemExternCrate(_) |
 739             hir::ItemUse(..) => bug!("cannot encode info for item {:?}", item),
 740         };
 741
 742         Entry {
 743             kind: kind,
 744             visibility: self.lazy(&ty::Visibility::from_hir(&item.vis, item.id, tcx)),
 745             span: self.lazy(&item.span),
 746             attributes: self.encode_attributes(&item.attrs),
 747             children: match item.node {
 748                 hir::ItemForeignMod(ref fm) => {
 749                     self.lazy_seq(fm.items
 750                         .iter()
 751                         .map(|foreign_item| tcx.hir.local_def_id(foreign_item.id).index))
 752                 }
 753                 hir::ItemEnum(..) => {
 754                     let def = self.tcx.lookup_adt_def(def_id);
 755                     self.lazy_seq(def.variants.iter().map(|v| {
 756                         assert!(v.did.is_local());
 757                         v.did.index
 758                     }))
 759                 }
 760                 hir::ItemStruct(..) |
 761                 hir::ItemUnion(..) => {
 762                     let def = self.tcx.lookup_adt_def(def_id);
 763                     self.lazy_seq(def.struct_variant().fields.iter().map(|f| {
 764                         assert!(f.did.is_local());
 765                         f.did.index
 766                     }))
 767                 }
 768                 hir::ItemImpl(..) |
 769                 hir::ItemTrait(..) => {
 770                     self.lazy_seq(tcx.associated_item_def_ids(def_id).iter().map(|&def_id| {
 771                         assert!(def_id.is_local());
 772                         def_id.index
 773                     }))
 774                 }
 775                 _ => LazySeq::empty(),
 776             },
 777             stability: self.encode_stability(def_id),
 778             deprecation: self.encode_deprecation(def_id),
 779
 780             ty: match item.node {
 781                 hir::ItemStatic(..) |
 782                 hir::ItemConst(..) |
 783                 hir::ItemFn(..) |
 784                 hir::ItemTy(..) |
 785                 hir::ItemEnum(..) |
 786                 hir::ItemStruct(..) |
 787                 hir::ItemUnion(..) |
 788                 hir::ItemImpl(..) => Some(self.encode_item_type(def_id)),
 789                 _ => None,
 790             },
 791             inherent_impls: self.encode_inherent_implementations(def_id),
 792             variances: match item.node {
 793                 hir::ItemEnum(..) |
 794                 hir::ItemStruct(..) |
 795                 hir::ItemUnion(..) |
 796                 hir::ItemTrait(..) => self.encode_item_variances(def_id),
 797                 _ => LazySeq::empty(),
 798             },
 799             generics: match item.node {
 800                 hir::ItemStatic(..) |
 801                 hir::ItemConst(..) |
 802                 hir::ItemFn(..) |
 803                 hir::ItemTy(..) |
 804                 hir::ItemEnum(..) |
 805                 hir::ItemStruct(..) |
 806                 hir::ItemUnion(..) |
 807                 hir::ItemImpl(..) |
 808                 hir::ItemTrait(..) => Some(self.encode_generics(def_id)),
 809                 _ => None,
 810             },
 811             predicates: match item.node {
 812                 hir::ItemStatic(..) |
 813                 hir::ItemConst(..) |
 814                 hir::ItemFn(..) |
 815                 hir::ItemTy(..) |
 816                 hir::ItemEnum(..) |
 817                 hir::ItemStruct(..) |
 818                 hir::ItemUnion(..) |
 819                 hir::ItemImpl(..) |
 820                 hir::ItemTrait(..) => Some(self.encode_predicates(def_id)),
 821                 _ => None,
 822             },
 823
 824             ast: match item.node {
 825                 hir::ItemConst(_, body) |
 826                 hir::ItemFn(_, _, hir::Constness::Const, _, _, body) => {
 827                     Some(self.encode_body(body))
 828                 }
 829                 _ => None,
 830             },
 831             mir: match item.node {
 832                 hir::ItemStatic(..) if self.tcx.sess.opts.debugging_opts.always_encode_mir => {
 833                     self.encode_mir(def_id)
 834                 }
 835                 hir::ItemConst(..) => self.encode_mir(def_id),
 836                 hir::ItemFn(_, _, constness, _, ref generics, _) => {
 837                     let tps_len = generics.ty_params.len();
 838                     let needs_inline = tps_len > 0 || attr::requests_inline(&item.attrs);
 839                     let always_encode_mir = self.tcx.sess.opts.debugging_opts.always_encode_mir;
 840                     if needs_inline || constness == hir::Constness::Const || always_encode_mir {
 841                         self.encode_mir(def_id)
 842                     } else {
 843                         None
 844                     }
 845                 }
 846                 _ => None,
 847             },
 848         }
 849     }
 850
 851     /// Serialize the text of exported macros
 852     fn encode_info_for_macro_def(&mut self, macro_def: &hir::MacroDef) -> Entry<'tcx> {
 853         Entry {
 854             kind: EntryKind::MacroDef(self.lazy(&MacroDef {
 855                 body: ::syntax::print::pprust::tts_to_string(&macro_def.body)
 856             })),
 857             visibility: self.lazy(&ty::Visibility::Public),
 858             span: self.lazy(&macro_def.span),
 859
 860             attributes: self.encode_attributes(&macro_def.attrs),
 861             children: LazySeq::empty(),
 862             stability: None,
 863             deprecation: None,
 864             ty: None,
 865             inherent_impls: LazySeq::empty(),
 866             variances: LazySeq::empty(),
 867             generics: None,
 868             predicates: None,
 869             ast: None,
 870             mir: None,
 871         }
 872     }
 873 }
 874
 875 impl<'a, 'b, 'tcx> IndexBuilder<'a, 'b, 'tcx> {
 876     /// In some cases, along with the item itself, we also
 877     /// encode some sub-items. Usually we want some info from the item
 878     /// so it's easier to do that here then to wait until we would encounter
 879     /// normally in the visitor walk.
 880     fn encode_addl_info_for_item(&mut self, item: &hir::Item) {
 881         let def_id = self.tcx.hir.local_def_id(item.id);
 882         match item.node {
 883             hir::ItemStatic(..) |
 884             hir::ItemConst(..) |
 885             hir::ItemFn(..) |
 886             hir::ItemMod(..) |
 887             hir::ItemForeignMod(..) |
 888             hir::ItemExternCrate(..) |
 889             hir::ItemUse(..) |
 890             hir::ItemDefaultImpl(..) |
 891             hir::ItemTy(..) => {
 892                 // no sub-item recording needed in these cases
 893             }
 894             hir::ItemEnum(..) => {
 895                 self.encode_fields(def_id);
 896
 897                 let def = self.tcx.lookup_adt_def(def_id);
 898                 for (i, variant) in def.variants.iter().enumerate() {
 899                     self.record(variant.did,
 900                                 EncodeContext::encode_enum_variant_info,
 901                                 (def_id, Untracked(i)));
 902                 }
 903             }
 904             hir::ItemStruct(ref struct_def, _) => {
 905                 self.encode_fields(def_id);
 906
 907                 // If the struct has a constructor, encode it.
 908                 if !struct_def.is_struct() {
 909                     let ctor_def_id = self.tcx.hir.local_def_id(struct_def.id());
 910                     self.record(ctor_def_id,
 911                                 EncodeContext::encode_struct_ctor,
 912                                 (def_id, ctor_def_id));
 913                 }
 914             }
 915             hir::ItemUnion(..) => {
 916                 self.encode_fields(def_id);
 917             }
 918             hir::ItemImpl(..) => {
 919                 for &trait_item_def_id in &self.tcx.associated_item_def_ids(def_id)[..] {
 920                     self.record(trait_item_def_id,
 921                                 EncodeContext::encode_info_for_impl_item,
 922                                 trait_item_def_id);
 923                 }
 924             }
 925             hir::ItemTrait(..) => {
 926                 for &item_def_id in &self.tcx.associated_item_def_ids(def_id)[..] {
 927                     self.record(item_def_id,
 928                                 EncodeContext::encode_info_for_trait_item,
 929                                 item_def_id);
 930                 }
 931             }
 932         }
 933     }
 934 }
 935
 936 impl<'a, 'tcx> EncodeContext<'a, 'tcx> {
 937     fn encode_info_for_foreign_item(&mut self,
 938                                     (def_id, nitem): (DefId, &hir::ForeignItem))
 939                                     -> Entry<'tcx> {
 940         let tcx = self.tcx;
 941
 942         debug!("writing foreign item {}", tcx.node_path_str(nitem.id));
 943
 944         let kind = match nitem.node {
 945             hir::ForeignItemFn(_, ref names, _) => {
 946                 let data = FnData {
 947                     constness: hir::Constness::NotConst,
 948                     arg_names: self.encode_fn_arg_names(names),
 949                 };
 950                 EntryKind::ForeignFn(self.lazy(&data))
 951             }
 952             hir::ForeignItemStatic(_, true) => EntryKind::ForeignMutStatic,
 953             hir::ForeignItemStatic(_, false) => EntryKind::ForeignImmStatic,
 954         };
 955
 956         Entry {
 957             kind: kind,
 958             visibility: self.lazy(&ty::Visibility::from_hir(&nitem.vis, nitem.id, tcx)),
 959             span: self.lazy(&nitem.span),
 960             attributes: self.encode_attributes(&nitem.attrs),
 961             children: LazySeq::empty(),
 962             stability: self.encode_stability(def_id),
 963             deprecation: self.encode_deprecation(def_id),
 964
 965             ty: Some(self.encode_item_type(def_id)),
 966             inherent_impls: LazySeq::empty(),
 967             variances: LazySeq::empty(),
 968             generics: Some(self.encode_generics(def_id)),
 969             predicates: Some(self.encode_predicates(def_id)),
 970
 971             ast: None,
 972             mir: None,
 973         }
 974     }
 975 }
 976
 977 struct EncodeVisitor<'a, 'b: 'a, 'tcx: 'b> {
 978     index: IndexBuilder<'a, 'b, 'tcx>,
 979 }
 980
 981 impl<'a, 'b, 'tcx> Visitor<'tcx> for EncodeVisitor<'a, 'b, 'tcx> {
 982     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
 983         NestedVisitorMap::OnlyBodies(&self.index.tcx.hir)
 984     }
 985     fn visit_expr(&mut self, ex: &'tcx hir::Expr) {
 986         intravisit::walk_expr(self, ex);
 987         self.index.encode_info_for_expr(ex);
 988     }
 989     fn visit_item(&mut self, item: &'tcx hir::Item) {
 990         intravisit::walk_item(self, item);
 991         let def_id = self.index.tcx.hir.local_def_id(item.id);
 992         match item.node {
 993             hir::ItemExternCrate(_) |
 994             hir::ItemUse(..) => (), // ignore these
 995             _ => self.index.record(def_id, EncodeContext::encode_info_for_item, (def_id, item)),
 996         }
 997         self.index.encode_addl_info_for_item(item);
 998     }
 999     fn visit_foreign_item(&mut self, ni: &'tcx hir::ForeignItem) {
1000         intravisit::walk_foreign_item(self, ni);
1001         let def_id = self.index.tcx.hir.local_def_id(ni.id);
1002         self.index.record(def_id,
1003                           EncodeContext::encode_info_for_foreign_item,
1004                           (def_id, ni));
1005     }
1006     fn visit_ty(&mut self, ty: &'tcx hir::Ty) {
1007         intravisit::walk_ty(self, ty);
1008         self.index.encode_info_for_ty(ty);
1009     }
1010     fn visit_macro_def(&mut self, macro_def: &'tcx hir::MacroDef) {
1011         let def_id = self.index.tcx.hir.local_def_id(macro_def.id);
1012         self.index.record(def_id, EncodeContext::encode_info_for_macro_def, macro_def);
1013     }
1014 }
1015
1016 impl<'a, 'b, 'tcx> IndexBuilder<'a, 'b, 'tcx> {
1017     fn encode_info_for_ty(&mut self, ty: &hir::Ty) {
1018         if let hir::TyImplTrait(_) = ty.node {
1019             let def_id = self.tcx.hir.local_def_id(ty.id);
1020             self.record(def_id, EncodeContext::encode_info_for_anon_ty, def_id);
1021         }
1022     }
1023
1024     fn encode_info_for_expr(&mut self, expr: &hir::Expr) {
1025         match expr.node {
1026             hir::ExprClosure(..) => {
1027                 let def_id = self.tcx.hir.local_def_id(expr.id);
1028                 self.record(def_id, EncodeContext::encode_info_for_closure, def_id);
1029             }
1030             _ => {}
1031         }
1032     }
1033 }
1034
1035 impl<'a, 'tcx> EncodeContext<'a, 'tcx> {
1036     fn encode_info_for_anon_ty(&mut self, def_id: DefId) -> Entry<'tcx> {
1037         let tcx = self.tcx;
1038         Entry {
1039             kind: EntryKind::Type,
1040             visibility: self.lazy(&ty::Visibility::Public),
1041             span: self.lazy(&tcx.def_span(def_id)),
1042             attributes: LazySeq::empty(),
1043             children: LazySeq::empty(),
1044             stability: None,
1045             deprecation: None,
1046
1047             ty: Some(self.encode_item_type(def_id)),
1048             inherent_impls: LazySeq::empty(),
1049             variances: LazySeq::empty(),
1050             generics: Some(self.encode_generics(def_id)),
1051             predicates: Some(self.encode_predicates(def_id)),
1052
1053             ast: None,
1054             mir: None,
1055         }
1056     }
1057
1058     fn encode_info_for_closure(&mut self, def_id: DefId) -> Entry<'tcx> {
1059         let tcx = self.tcx;
1060
1061         let data = ClosureData {
1062             kind: tcx.closure_kind(def_id),
1063             ty: self.lazy(&tcx.closure_tys.borrow()[&def_id]),
1064         };
1065
1066         Entry {
1067             kind: EntryKind::Closure(self.lazy(&data)),
1068             visibility: self.lazy(&ty::Visibility::Public),
1069             span: self.lazy(&tcx.def_span(def_id)),
1070             attributes: self.encode_attributes(&tcx.get_attrs(def_id)),
1071             children: LazySeq::empty(),
1072             stability: None,
1073             deprecation: None,
1074
1075             ty: Some(self.encode_item_type(def_id)),
1076             inherent_impls: LazySeq::empty(),
1077             variances: LazySeq::empty(),
1078             generics: Some(self.encode_generics(def_id)),
1079             predicates: None,
1080
1081             ast: None,
1082             mir: self.encode_mir(def_id),
1083         }
1084     }
1085
1086     fn encode_info_for_items(&mut self) -> Index {
1087         let krate = self.tcx.hir.krate();
1088         let mut index = IndexBuilder::new(self);
1089         index.record(DefId::local(CRATE_DEF_INDEX),
1090                      EncodeContext::encode_info_for_mod,
1091                      FromId(CRATE_NODE_ID, (&krate.module, &krate.attrs, &hir::Public)));
1092         let mut visitor = EncodeVisitor { index: index };
1093         krate.visit_all_item_likes(&mut visitor.as_deep_visitor());
1094         for macro_def in &krate.exported_macros {
1095             visitor.visit_macro_def(macro_def);
1096         }
1097         visitor.index.into_items()
1098     }
1099
1100     fn encode_attributes(&mut self, attrs: &[ast::Attribute]) -> LazySeq<ast::Attribute> {
1101         self.lazy_seq_ref(attrs)
1102     }
1103
1104     fn encode_crate_deps(&mut self) -> LazySeq<CrateDep> {
1105         fn get_ordered_deps(cstore: &cstore::CStore) -> Vec<(CrateNum, Rc<cstore::CrateMetadata>)> {
1106             // Pull the cnums and name,vers,hash out of cstore
1107             let mut deps = Vec::new();
1108             cstore.iter_crate_data(|cnum, val| {
1109                 deps.push((cnum, val.clone()));
1110             });
1111
1112             // Sort by cnum
1113             deps.sort_by(|kv1, kv2| kv1.0.cmp(&kv2.0));
1114
1115             // Sanity-check the crate numbers
1116             let mut expected_cnum = 1;
1117             for &(n, _) in &deps {
1118                 assert_eq!(n, CrateNum::new(expected_cnum));
1119                 expected_cnum += 1;
1120             }
1121
1122             deps
1123         }
1124
1125         // We're just going to write a list of crate 'name-hash-version's, with
1126         // the assumption that they are numbered 1 to n.
1127         // FIXME (#2166): This is not nearly enough to support correct versioning
1128         // but is enough to get transitive crate dependencies working.
1129         let deps = get_ordered_deps(self.cstore);
1130         self.lazy_seq(deps.iter().map(|&(_, ref dep)| {
1131             CrateDep {
1132                 name: dep.name(),
1133                 hash: dep.hash(),
1134                 kind: dep.dep_kind.get(),
1135             }
1136         }))
1137     }
1138
1139     fn encode_lang_items(&mut self) -> (LazySeq<(DefIndex, usize)>, LazySeq<lang_items::LangItem>) {
1140         let tcx = self.tcx;
1141         let lang_items = tcx.lang_items.items().iter();
1142         (self.lazy_seq(lang_items.enumerate().filter_map(|(i, &opt_def_id)| {
1143             if let Some(def_id) = opt_def_id {
1144                 if def_id.is_local() {
1145                     return Some((def_id.index, i));
1146                 }
1147             }
1148             None
1149         })),
1150          self.lazy_seq_ref(&tcx.lang_items.missing))
1151     }
1152
1153     fn encode_native_libraries(&mut self) -> LazySeq<NativeLibrary> {
1154         let used_libraries = self.tcx.sess.cstore.used_libraries();
1155         self.lazy_seq(used_libraries)
1156     }
1157
1158     fn encode_codemap(&mut self) -> LazySeq<syntax_pos::FileMap> {
1159         let codemap = self.tcx.sess.codemap();
1160         let all_filemaps = codemap.files.borrow();
1161         self.lazy_seq_ref(all_filemaps.iter()
1162             .filter(|filemap| {
1163                 // No need to re-export imported filemaps, as any downstream
1164                 // crate will import them from their original source.
1165                 !filemap.is_imported()
1166             })
1167             .map(|filemap| &**filemap))
1168     }
1169
1170     fn encode_def_path_table(&mut self) -> Lazy<DefPathTable> {
1171         let definitions = self.tcx.hir.definitions();
1172         self.lazy(definitions.def_path_table())
1173     }
1174 }
1175
1176 struct ImplVisitor<'a, 'tcx: 'a> {
1177     tcx: TyCtxt<'a, 'tcx, 'tcx>,
1178     impls: FxHashMap<DefId, Vec<DefIndex>>,
1179 }
1180
1181 impl<'a, 'tcx, 'v> ItemLikeVisitor<'v> for ImplVisitor<'a, 'tcx> {
1182     fn visit_item(&mut self, item: &hir::Item) {
1183         if let hir::ItemImpl(..) = item.node {
1184             let impl_id = self.tcx.hir.local_def_id(item.id);
1185             if let Some(trait_ref) = self.tcx.impl_trait_ref(impl_id) {
1186                 self.impls
1187                     .entry(trait_ref.def_id)
1188                     .or_insert(vec![])
1189                     .push(impl_id.index);
1190             }
1191         }
1192     }
1193
1194     fn visit_trait_item(&mut self, _trait_item: &'v hir::TraitItem) {}
1195
1196     fn visit_impl_item(&mut self, _impl_item: &'v hir::ImplItem) {
1197         // handled in `visit_item` above
1198     }
1199 }
1200
1201 impl<'a, 'tcx> EncodeContext<'a, 'tcx> {
1202     /// Encodes an index, mapping each trait to its (local) implementations.
1203     fn encode_impls(&mut self) -> LazySeq<TraitImpls> {
1204         let mut visitor = ImplVisitor {
1205             tcx: self.tcx,
1206             impls: FxHashMap(),
1207         };
1208         self.tcx.hir.krate().visit_all_item_likes(&mut visitor);
1209
1210         let all_impls: Vec<_> = visitor.impls
1211             .into_iter()
1212             .map(|(trait_def_id, impls)| {
1213                 TraitImpls {
1214                     trait_id: (trait_def_id.krate.as_u32(), trait_def_id.index),
1215                     impls: self.lazy_seq(impls),
1216                 }
1217             })
1218             .collect();
1219
1220         self.lazy_seq(all_impls)
1221     }
1222
1223     // Encodes all symbols exported from this crate into the metadata.
1224     //
1225     // This pass is seeded off the reachability list calculated in the
1226     // middle::reachable module but filters out items that either don't have a
1227     // symbol associated with them (they weren't translated) or if they're an FFI
1228     // definition (as that's not defined in this crate).
1229     fn encode_exported_symbols(&mut self) -> LazySeq<DefIndex> {
1230         let exported_symbols = self.exported_symbols;
1231         let tcx = self.tcx;
1232         self.lazy_seq(exported_symbols.iter().map(|&id| tcx.hir.local_def_id(id).index))
1233     }
1234
1235     fn encode_dylib_dependency_formats(&mut self) -> LazySeq<Option<LinkagePreference>> {
1236         match self.tcx.sess.dependency_formats.borrow().get(&config::CrateTypeDylib) {
1237             Some(arr) => {
1238                 self.lazy_seq(arr.iter().map(|slot| {
1239                     match *slot {
1240                         Linkage::NotLinked |
1241                         Linkage::IncludedFromDylib => None,
1242
1243                         Linkage::Dynamic => Some(LinkagePreference::RequireDynamic),
1244                         Linkage::Static => Some(LinkagePreference::RequireStatic),
1245                     }
1246                 }))
1247             }
1248             None => LazySeq::empty(),
1249         }
1250     }
1251
1252     fn encode_crate_root(&mut self) -> Lazy<CrateRoot> {
1253         let mut i = self.position();
1254         let crate_deps = self.encode_crate_deps();
1255         let dylib_dependency_formats = self.encode_dylib_dependency_formats();
1256         let dep_bytes = self.position() - i;
1257
1258         // Encode the language items.
1259         i = self.position();
1260         let (lang_items, lang_items_missing) = self.encode_lang_items();
1261         let lang_item_bytes = self.position() - i;
1262
1263         // Encode the native libraries used
1264         i = self.position();
1265         let native_libraries = self.encode_native_libraries();
1266         let native_lib_bytes = self.position() - i;
1267
1268         // Encode codemap
1269         i = self.position();
1270         let codemap = self.encode_codemap();
1271         let codemap_bytes = self.position() - i;
1272
1273         // Encode DefPathTable
1274         i = self.position();
1275         let def_path_table = self.encode_def_path_table();
1276         let def_path_table_bytes = self.position() - i;
1277
1278         // Encode the def IDs of impls, for coherence checking.
1279         i = self.position();
1280         let impls = self.encode_impls();
1281         let impl_bytes = self.position() - i;
1282
1283         // Encode exported symbols info.
1284         i = self.position();
1285         let exported_symbols = self.encode_exported_symbols();
1286         let exported_symbols_bytes = self.position() - i;
1287
1288         // Encode and index the items.
1289         i = self.position();
1290         let items = self.encode_info_for_items();
1291         let item_bytes = self.position() - i;
1292
1293         i = self.position();
1294         let index = items.write_index(&mut self.opaque.cursor);
1295         let index_bytes = self.position() - i;
1296
1297         let tcx = self.tcx;
1298         let link_meta = self.link_meta;
1299         let is_proc_macro = tcx.sess.crate_types.borrow().contains(&CrateTypeProcMacro);
1300         let root = self.lazy(&CrateRoot {
1301             name: link_meta.crate_name,
1302             triple: tcx.sess.opts.target_triple.clone(),
1303             hash: link_meta.crate_hash,
1304             disambiguator: tcx.sess.local_crate_disambiguator(),
1305             panic_strategy: tcx.sess.panic_strategy(),
1306             plugin_registrar_fn: tcx.sess
1307                 .plugin_registrar_fn
1308                 .get()
1309                 .map(|id| tcx.hir.local_def_id(id).index),
1310             macro_derive_registrar: if is_proc_macro {
1311                 let id = tcx.sess.derive_registrar_fn.get().unwrap();
1312                 Some(tcx.hir.local_def_id(id).index)
1313             } else {
1314                 None
1315             },
1316
1317             crate_deps: crate_deps,
1318             dylib_dependency_formats: dylib_dependency_formats,
1319             lang_items: lang_items,
1320             lang_items_missing: lang_items_missing,
1321             native_libraries: native_libraries,
1322             codemap: codemap,
1323             def_path_table: def_path_table,
1324             impls: impls,
1325             exported_symbols: exported_symbols,
1326             index: index,
1327         });
1328
1329         let total_bytes = self.position();
1330
1331         if self.tcx.sess.meta_stats() {
1332             let mut zero_bytes = 0;
1333             for e in self.opaque.cursor.get_ref() {
1334                 if *e == 0 {
1335                     zero_bytes += 1;
1336                 }
1337             }
1338
1339             println!("metadata stats:");
1340             println!("             dep bytes: {}", dep_bytes);
1341             println!("       lang item bytes: {}", lang_item_bytes);
1342             println!("          native bytes: {}", native_lib_bytes);
1343             println!("         codemap bytes: {}", codemap_bytes);
1344             println!("            impl bytes: {}", impl_bytes);
1345             println!("    exp. symbols bytes: {}", exported_symbols_bytes);
1346             println!("  def-path table bytes: {}", def_path_table_bytes);
1347             println!("            item bytes: {}", item_bytes);
1348             println!("           index bytes: {}", index_bytes);
1349             println!("            zero bytes: {}", zero_bytes);
1350             println!("           total bytes: {}", total_bytes);
1351         }
1352
1353         root
1354     }
1355 }
1356
1357 // NOTE(eddyb) The following comment was preserved for posterity, even
1358 // though it's no longer relevant as EBML (which uses nested & tagged
1359 // "documents") was replaced with a scheme that can't go out of bounds.
1360 //
1361 // And here we run into yet another obscure archive bug: in which metadata
1362 // loaded from archives may have trailing garbage bytes. Awhile back one of
1363 // our tests was failing sporadically on the OSX 64-bit builders (both nopt
1364 // and opt) by having ebml generate an out-of-bounds panic when looking at
1365 // metadata.
1366 //
1367 // Upon investigation it turned out that the metadata file inside of an rlib
1368 // (and ar archive) was being corrupted. Some compilations would generate a
1369 // metadata file which would end in a few extra bytes, while other
1370 // compilations would not have these extra bytes appended to the end. These
1371 // extra bytes were interpreted by ebml as an extra tag, so they ended up
1372 // being interpreted causing the out-of-bounds.
1373 //
1374 // The root cause of why these extra bytes were appearing was never
1375 // discovered, and in the meantime the solution we're employing is to insert
1376 // the length of the metadata to the start of the metadata. Later on this
1377 // will allow us to slice the metadata to the precise length that we just
1378 // generated regardless of trailing bytes that end up in it.
1379
1380 pub fn encode_metadata<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1381                                  cstore: &cstore::CStore,
1382                                  reexports: &def::ExportMap,
1383                                  link_meta: &LinkMeta,
1384                                  exported_symbols: &NodeSet)
1385                                  -> Vec<u8> {
1386     let mut cursor = Cursor::new(vec![]);
1387     cursor.write_all(METADATA_HEADER).unwrap();
1388
1389     // Will be filed with the root position after encoding everything.
1390     cursor.write_all(&[0, 0, 0, 0]).unwrap();
1391
1392     let root = {
1393         let mut ecx = EncodeContext {
1394             opaque: opaque::Encoder::new(&mut cursor),
1395             tcx: tcx,
1396             reexports: reexports,
1397             link_meta: link_meta,
1398             cstore: cstore,
1399             exported_symbols: exported_symbols,
1400             lazy_state: LazyState::NoNode,
1401             type_shorthands: Default::default(),
1402             predicate_shorthands: Default::default(),
1403         };
1404
1405         // Encode the rustc version string in a predictable location.
1406         rustc_version().encode(&mut ecx).unwrap();
1407
1408         // Encode all the entries and extra information in the crate,
1409         // culminating in the `CrateRoot` which points to all of it.
1410         ecx.encode_crate_root()
1411     };
1412     let mut result = cursor.into_inner();
1413
1414     // Encode the root position.
1415     let header = METADATA_HEADER.len();
1416     let pos = root.position;
1417     result[header + 0] = (pos >> 24) as u8;
1418     result[header + 1] = (pos >> 16) as u8;
1419     result[header + 2] = (pos >> 8) as u8;
1420     result[header + 3] = (pos >> 0) as u8;
1421
1422     result
1423 }