src/librustc_metadata/schema.rs

   1 // Copyright 2012-2016 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 astencode;
  12 use index;
  13
  14 use rustc::hir;
  15 use rustc::hir::def::{self, CtorKind};
  16 use rustc::hir::def_id::{DefIndex, DefId};
  17 use rustc::ich::StableHashingContext;
  18 use rustc::middle::cstore::{DepKind, LinkagePreference, NativeLibrary};
  19 use rustc::middle::lang_items;
  20 use rustc::mir;
  21 use rustc::ty::{self, Ty, ReprOptions};
  22 use rustc_back::PanicStrategy;
  23
  24 use rustc_serialize as serialize;
  25 use syntax::{ast, attr};
  26 use syntax::symbol::Symbol;
  27 use syntax_pos::{self, Span};
  28
  29 use std::marker::PhantomData;
  30 use std::mem;
  31
  32 use rustc_data_structures::stable_hasher::{StableHasher, HashStable,
  33                                            StableHasherResult};
  34
  35 pub fn rustc_version() -> String {
  36     format!("rustc {}",
  37             option_env!("CFG_VERSION").unwrap_or("unknown version"))
  38 }
  39
  40 /// Metadata encoding version.
  41 /// NB: increment this if you change the format of metadata such that
  42 /// the rustc version can't be found to compare with `rustc_version()`.
  43 pub const METADATA_VERSION: u8 = 4;
  44
  45 /// Metadata header which includes `METADATA_VERSION`.
  46 /// To get older versions of rustc to ignore this metadata,
  47 /// there are 4 zero bytes at the start, which are treated
  48 /// as a length of 0 by old compilers.
  49 ///
  50 /// This header is followed by the position of the `CrateRoot`,
  51 /// which is encoded as a 32-bit big-endian unsigned integer,
  52 /// and further followed by the rustc version string.
  53 pub const METADATA_HEADER: &'static [u8; 12] =
  54     &[0, 0, 0, 0, b'r', b'u', b's', b't', 0, 0, 0, METADATA_VERSION];
  55
  56 /// The shorthand encoding uses an enum's variant index `usize`
  57 /// and is offset by this value so it never matches a real variant.
  58 /// This offset is also chosen so that the first byte is never < 0x80.
  59 pub const SHORTHAND_OFFSET: usize = 0x80;
  60
  61 /// A value of type T referred to by its absolute position
  62 /// in the metadata, and which can be decoded lazily.
  63 ///
  64 /// Metadata is effective a tree, encoded in post-order,
  65 /// and with the root's position written next to the header.
  66 /// That means every single `Lazy` points to some previous
  67 /// location in the metadata and is part of a larger node.
  68 ///
  69 /// The first `Lazy` in a node is encoded as the backwards
  70 /// distance from the position where the containing node
  71 /// starts and where the `Lazy` points to, while the rest
  72 /// use the forward distance from the previous `Lazy`.
  73 /// Distances start at 1, as 0-byte nodes are invalid.
  74 /// Also invalid are nodes being referred in a different
  75 /// order than they were encoded in.
  76 #[must_use]
  77 pub struct Lazy<T> {
  78     pub position: usize,
  79     _marker: PhantomData<T>,
  80 }
  81
  82 impl<T> Lazy<T> {
  83     pub fn with_position(position: usize) -> Lazy<T> {
  84         Lazy {
  85             position: position,
  86             _marker: PhantomData,
  87         }
  88     }
  89
  90     /// Returns the minimum encoded size of a value of type `T`.
  91     // FIXME(eddyb) Give better estimates for certain types.
  92     pub fn min_size() -> usize {
  93         1
  94     }
  95 }
  96
  97 impl<T> Copy for Lazy<T> {}
  98 impl<T> Clone for Lazy<T> {
  99     fn clone(&self) -> Self {
 100         *self
 101     }
 102 }
 103
 104 impl<T> serialize::UseSpecializedEncodable for Lazy<T> {}
 105 impl<T> serialize::UseSpecializedDecodable for Lazy<T> {}
 106
 107 impl<CTX, T> HashStable<CTX> for Lazy<T> {
 108     fn hash_stable<W: StableHasherResult>(&self,
 109                                           _: &mut CTX,
 110                                           _: &mut StableHasher<W>) {
 111         // There's nothing to do. Whatever got encoded within this Lazy<>
 112         // wrapper has already been hashed.
 113     }
 114 }
 115
 116 /// A sequence of type T referred to by its absolute position
 117 /// in the metadata and length, and which can be decoded lazily.
 118 /// The sequence is a single node for the purposes of `Lazy`.
 119 ///
 120 /// Unlike `Lazy<Vec<T>>`, the length is encoded next to the
 121 /// position, not at the position, which means that the length
 122 /// doesn't need to be known before encoding all the elements.
 123 ///
 124 /// If the length is 0, no position is encoded, but otherwise,
 125 /// the encoding is that of `Lazy`, with the distinction that
 126 /// the minimal distance the length of the sequence, i.e.
 127 /// it's assumed there's no 0-byte element in the sequence.
 128 #[must_use]
 129 pub struct LazySeq<T> {
 130     pub len: usize,
 131     pub position: usize,
 132     _marker: PhantomData<T>,
 133 }
 134
 135 impl<T> LazySeq<T> {
 136     pub fn empty() -> LazySeq<T> {
 137         LazySeq::with_position_and_length(0, 0)
 138     }
 139
 140     pub fn with_position_and_length(position: usize, len: usize) -> LazySeq<T> {
 141         LazySeq {
 142             len: len,
 143             position: position,
 144             _marker: PhantomData,
 145         }
 146     }
 147
 148     /// Returns the minimum encoded size of `length` values of type `T`.
 149     pub fn min_size(length: usize) -> usize {
 150         length
 151     }
 152 }
 153
 154 impl<T> Copy for LazySeq<T> {}
 155 impl<T> Clone for LazySeq<T> {
 156     fn clone(&self) -> Self {
 157         *self
 158     }
 159 }
 160
 161 impl<T> serialize::UseSpecializedEncodable for LazySeq<T> {}
 162 impl<T> serialize::UseSpecializedDecodable for LazySeq<T> {}
 163
 164 impl<CTX, T> HashStable<CTX> for LazySeq<T> {
 165     fn hash_stable<W: StableHasherResult>(&self,
 166                                           _: &mut CTX,
 167                                           _: &mut StableHasher<W>) {
 168         // There's nothing to do. Whatever got encoded within this Lazy<>
 169         // wrapper has already been hashed.
 170     }
 171 }
 172
 173 /// Encoding / decoding state for `Lazy` and `LazySeq`.
 174 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
 175 pub enum LazyState {
 176     /// Outside of a metadata node.
 177     NoNode,
 178
 179     /// Inside a metadata node, and before any `Lazy` or `LazySeq`.
 180     /// The position is that of the node itself.
 181     NodeStart(usize),
 182
 183     /// Inside a metadata node, with a previous `Lazy` or `LazySeq`.
 184     /// The position is a conservative estimate of where that
 185     /// previous `Lazy` / `LazySeq` would end (see their comments).
 186     Previous(usize),
 187 }
 188
 189 #[derive(RustcEncodable, RustcDecodable)]
 190 pub struct CrateRoot {
 191     pub name: Symbol,
 192     pub triple: String,
 193     pub hash: hir::svh::Svh,
 194     pub disambiguator: Symbol,
 195     pub panic_strategy: PanicStrategy,
 196     pub plugin_registrar_fn: Option<DefIndex>,
 197     pub macro_derive_registrar: Option<DefIndex>,
 198
 199     pub crate_deps: LazySeq<CrateDep>,
 200     pub dylib_dependency_formats: LazySeq<Option<LinkagePreference>>,
 201     pub lang_items: LazySeq<(DefIndex, usize)>,
 202     pub lang_items_missing: LazySeq<lang_items::LangItem>,
 203     pub native_libraries: LazySeq<NativeLibrary>,
 204     pub codemap: LazySeq<syntax_pos::FileMap>,
 205     pub def_path_table: Lazy<hir::map::definitions::DefPathTable>,
 206     pub impls: LazySeq<TraitImpls>,
 207     pub exported_symbols: LazySeq<DefIndex>,
 208     pub index: LazySeq<index::Index>,
 209 }
 210
 211 #[derive(RustcEncodable, RustcDecodable)]
 212 pub struct CrateDep {
 213     pub name: ast::Name,
 214     pub hash: hir::svh::Svh,
 215     pub kind: DepKind,
 216 }
 217
 218 #[derive(RustcEncodable, RustcDecodable)]
 219 pub struct TraitImpls {
 220     pub trait_id: (u32, DefIndex),
 221     pub impls: LazySeq<DefIndex>,
 222 }
 223
 224 #[derive(RustcEncodable, RustcDecodable)]
 225 pub struct Entry<'tcx> {
 226     pub kind: EntryKind<'tcx>,
 227     pub visibility: Lazy<ty::Visibility>,
 228     pub span: Lazy<Span>,
 229     pub attributes: LazySeq<ast::Attribute>,
 230     pub children: LazySeq<DefIndex>,
 231     pub stability: Option<Lazy<attr::Stability>>,
 232     pub deprecation: Option<Lazy<attr::Deprecation>>,
 233
 234     pub ty: Option<Lazy<Ty<'tcx>>>,
 235     pub inherent_impls: LazySeq<DefIndex>,
 236     pub variances: LazySeq<ty::Variance>,
 237     pub generics: Option<Lazy<ty::Generics>>,
 238     pub predicates: Option<Lazy<ty::GenericPredicates<'tcx>>>,
 239
 240     pub ast: Option<Lazy<astencode::Ast<'tcx>>>,
 241     pub mir: Option<Lazy<mir::Mir<'tcx>>>,
 242 }
 243
 244 impl_stable_hash_for!(struct Entry<'tcx> {
 245     kind,
 246     visibility,
 247     span,
 248     attributes,
 249     children,
 250     stability,
 251     deprecation,
 252     ty,
 253     inherent_impls,
 254     variances,
 255     generics,
 256     predicates,
 257     ast,
 258     mir
 259 });
 260
 261 #[derive(Copy, Clone, RustcEncodable, RustcDecodable)]
 262 pub enum EntryKind<'tcx> {
 263     Const(u8),
 264     ImmStatic,
 265     MutStatic,
 266     ForeignImmStatic,
 267     ForeignMutStatic,
 268     ForeignMod,
 269     GlobalAsm,
 270     Type,
 271     Enum(ReprOptions),
 272     Field,
 273     Variant(Lazy<VariantData>),
 274     Struct(Lazy<VariantData>, ReprOptions),
 275     Union(Lazy<VariantData>, ReprOptions),
 276     Fn(Lazy<FnData>),
 277     ForeignFn(Lazy<FnData>),
 278     Mod(Lazy<ModData>),
 279     MacroDef(Lazy<MacroDef>),
 280     Closure(Lazy<ClosureData<'tcx>>),
 281     Trait(Lazy<TraitData<'tcx>>),
 282     Impl(Lazy<ImplData<'tcx>>),
 283     DefaultImpl(Lazy<ImplData<'tcx>>),
 284     Method(Lazy<MethodData>),
 285     AssociatedType(AssociatedContainer),
 286     AssociatedConst(AssociatedContainer, u8),
 287 }
 288
 289 impl<'a, 'tcx> HashStable<StableHashingContext<'a, 'tcx>> for EntryKind<'tcx> {
 290     fn hash_stable<W: StableHasherResult>(&self,
 291                                           hcx: &mut StableHashingContext<'a, 'tcx>,
 292                                           hasher: &mut StableHasher<W>) {
 293         mem::discriminant(self).hash_stable(hcx, hasher);
 294         match *self {
 295             EntryKind::ImmStatic        |
 296             EntryKind::MutStatic        |
 297             EntryKind::ForeignImmStatic |
 298             EntryKind::ForeignMutStatic |
 299             EntryKind::ForeignMod       |
 300             EntryKind::GlobalAsm        |
 301             EntryKind::Field |
 302             EntryKind::Type => {
 303                 // Nothing else to hash here.
 304             }
 305             EntryKind::Const(qualif) => {
 306                 qualif.hash_stable(hcx, hasher);
 307             }
 308             EntryKind::Enum(ref repr_options) => {
 309                 repr_options.hash_stable(hcx, hasher);
 310             }
 311             EntryKind::Variant(ref variant_data) => {
 312                 variant_data.hash_stable(hcx, hasher);
 313             }
 314             EntryKind::Struct(ref variant_data, ref repr_options) |
 315             EntryKind::Union(ref variant_data, ref repr_options)  => {
 316                 variant_data.hash_stable(hcx, hasher);
 317                 repr_options.hash_stable(hcx, hasher);
 318             }
 319             EntryKind::Fn(ref fn_data) |
 320             EntryKind::ForeignFn(ref fn_data) => {
 321                 fn_data.hash_stable(hcx, hasher);
 322             }
 323             EntryKind::Mod(ref mod_data) => {
 324                 mod_data.hash_stable(hcx, hasher);
 325             }
 326             EntryKind::MacroDef(ref macro_def) => {
 327                 macro_def.hash_stable(hcx, hasher);
 328             }
 329             EntryKind::Closure(closure_data) => {
 330                 closure_data.hash_stable(hcx, hasher);
 331             }
 332             EntryKind::Trait(ref trait_data) => {
 333                 trait_data.hash_stable(hcx, hasher);
 334             }
 335             EntryKind::DefaultImpl(ref impl_data) |
 336             EntryKind::Impl(ref impl_data) => {
 337                 impl_data.hash_stable(hcx, hasher);
 338             }
 339             EntryKind::Method(ref method_data) => {
 340                 method_data.hash_stable(hcx, hasher);
 341             }
 342             EntryKind::AssociatedType(associated_container) => {
 343                 associated_container.hash_stable(hcx, hasher);
 344             }
 345             EntryKind::AssociatedConst(associated_container, qualif) => {
 346                 associated_container.hash_stable(hcx, hasher);
 347                 qualif.hash_stable(hcx, hasher);
 348             }
 349         }
 350     }
 351 }
 352
 353 #[derive(RustcEncodable, RustcDecodable)]
 354 pub struct ModData {
 355     pub reexports: LazySeq<def::Export>,
 356 }
 357
 358 impl_stable_hash_for!(struct ModData { reexports });
 359
 360 #[derive(RustcEncodable, RustcDecodable)]
 361 pub struct MacroDef {
 362     pub body: String,
 363 }
 364
 365 impl_stable_hash_for!(struct MacroDef { body });
 366
 367 #[derive(RustcEncodable, RustcDecodable)]
 368 pub struct FnData {
 369     pub constness: hir::Constness,
 370     pub arg_names: LazySeq<ast::Name>,
 371 }
 372
 373 impl_stable_hash_for!(struct FnData { constness, arg_names });
 374
 375 #[derive(RustcEncodable, RustcDecodable)]
 376 pub struct VariantData {
 377     pub ctor_kind: CtorKind,
 378     pub discr: ty::VariantDiscr,
 379
 380     /// If this is a struct's only variant, this
 381     /// is the index of the "struct ctor" item.
 382     pub struct_ctor: Option<DefIndex>,
 383 }
 384
 385 impl_stable_hash_for!(struct VariantData {
 386     ctor_kind,
 387     discr,
 388     struct_ctor
 389 });
 390
 391 #[derive(RustcEncodable, RustcDecodable)]
 392 pub struct TraitData<'tcx> {
 393     pub unsafety: hir::Unsafety,
 394     pub paren_sugar: bool,
 395     pub has_default_impl: bool,
 396     pub super_predicates: Lazy<ty::GenericPredicates<'tcx>>,
 397 }
 398
 399 impl_stable_hash_for!(struct TraitData<'tcx> {
 400     unsafety,
 401     paren_sugar,
 402     has_default_impl,
 403     super_predicates
 404 });
 405
 406 #[derive(RustcEncodable, RustcDecodable)]
 407 pub struct ImplData<'tcx> {
 408     pub polarity: hir::ImplPolarity,
 409     pub parent_impl: Option<DefId>,
 410
 411     /// This is `Some` only for impls of `CoerceUnsized`.
 412     pub coerce_unsized_info: Option<ty::adjustment::CoerceUnsizedInfo>,
 413     pub trait_ref: Option<Lazy<ty::TraitRef<'tcx>>>,
 414 }
 415
 416 impl_stable_hash_for!(struct ImplData<'tcx> {
 417     polarity,
 418     parent_impl,
 419     coerce_unsized_info,
 420     trait_ref
 421 });
 422
 423
 424 /// Describes whether the container of an associated item
 425 /// is a trait or an impl and whether, in a trait, it has
 426 /// a default, or an in impl, whether it's marked "default".
 427 #[derive(Copy, Clone, RustcEncodable, RustcDecodable)]
 428 pub enum AssociatedContainer {
 429     TraitRequired,
 430     TraitWithDefault,
 431     ImplDefault,
 432     ImplFinal,
 433 }
 434
 435 impl_stable_hash_for!(enum ::schema::AssociatedContainer {
 436     TraitRequired,
 437     TraitWithDefault,
 438     ImplDefault,
 439     ImplFinal
 440 });
 441
 442 impl AssociatedContainer {
 443     pub fn with_def_id(&self, def_id: DefId) -> ty::AssociatedItemContainer {
 444         match *self {
 445             AssociatedContainer::TraitRequired |
 446             AssociatedContainer::TraitWithDefault => ty::TraitContainer(def_id),
 447
 448             AssociatedContainer::ImplDefault |
 449             AssociatedContainer::ImplFinal => ty::ImplContainer(def_id),
 450         }
 451     }
 452
 453     pub fn defaultness(&self) -> hir::Defaultness {
 454         match *self {
 455             AssociatedContainer::TraitRequired => hir::Defaultness::Default {
 456                 has_value: false,
 457             },
 458
 459             AssociatedContainer::TraitWithDefault |
 460             AssociatedContainer::ImplDefault => hir::Defaultness::Default {
 461                 has_value: true,
 462             },
 463
 464             AssociatedContainer::ImplFinal => hir::Defaultness::Final,
 465         }
 466     }
 467 }
 468
 469 #[derive(RustcEncodable, RustcDecodable)]
 470 pub struct MethodData {
 471     pub fn_data: FnData,
 472     pub container: AssociatedContainer,
 473     pub has_self: bool,
 474 }
 475 impl_stable_hash_for!(struct MethodData { fn_data, container, has_self });
 476
 477 #[derive(RustcEncodable, RustcDecodable)]
 478 pub struct ClosureData<'tcx> {
 479     pub kind: ty::ClosureKind,
 480     pub ty: Lazy<ty::PolyFnSig<'tcx>>,
 481 }
 482 impl_stable_hash_for!(struct ClosureData<'tcx> { kind, ty });