4 use rustc::hir::def::{self, CtorKind};
5 use rustc::hir::def_id::{DefIndex, DefId, CrateNum};
6 use rustc::ich::StableHashingContext;
7 use rustc::middle::cstore::{DepKind, LinkagePreference, NativeLibrary, ForeignModule};
8 use rustc::middle::lang_items;
10 use rustc::session::CrateDisambiguator;
11 use rustc::ty::{self, Ty, ReprOptions};
12 use rustc_target::spec::{PanicStrategy, TargetTriple};
13 use rustc_data_structures::svh::Svh;
15 use rustc_serialize as serialize;
16 use syntax::{ast, attr};
17 use syntax::edition::Edition;
18 use syntax::symbol::Symbol;
19 use syntax_pos::{self, Span};
21 use std::marker::PhantomData;
24 use rustc_data_structures::stable_hasher::{StableHasher, HashStable,
27 pub fn rustc_version() -> String {
29 option_env!("CFG_VERSION").unwrap_or("unknown version"))
32 /// Metadata encoding version.
33 /// N.B., increment this if you change the format of metadata such that
34 /// the rustc version can't be found to compare with `rustc_version()`.
35 pub const METADATA_VERSION: u8 = 4;
37 /// Metadata header which includes `METADATA_VERSION`.
38 /// To get older versions of rustc to ignore this metadata,
39 /// there are 4 zero bytes at the start, which are treated
40 /// as a length of 0 by old compilers.
42 /// This header is followed by the position of the `CrateRoot`,
43 /// which is encoded as a 32-bit big-endian unsigned integer,
44 /// and further followed by the rustc version string.
45 pub const METADATA_HEADER: &[u8; 12] =
46 &[0, 0, 0, 0, b'r', b'u', b's', b't', 0, 0, 0, METADATA_VERSION];
48 /// A value of type T referred to by its absolute position
49 /// in the metadata, and which can be decoded lazily.
51 /// Metadata is effective a tree, encoded in post-order,
52 /// and with the root's position written next to the header.
53 /// That means every single `Lazy` points to some previous
54 /// location in the metadata and is part of a larger node.
56 /// The first `Lazy` in a node is encoded as the backwards
57 /// distance from the position where the containing node
58 /// starts and where the `Lazy` points to, while the rest
59 /// use the forward distance from the previous `Lazy`.
60 /// Distances start at 1, as 0-byte nodes are invalid.
61 /// Also invalid are nodes being referred in a different
62 /// order than they were encoded in.
66 _marker: PhantomData<T>,
70 pub fn with_position(position: usize) -> Lazy<T> {
77 /// Returns the minimum encoded size of a value of type `T`.
78 // FIXME(eddyb) Give better estimates for certain types.
79 pub fn min_size() -> usize {
84 impl<T> Copy for Lazy<T> {}
85 impl<T> Clone for Lazy<T> {
86 fn clone(&self) -> Self {
91 impl<T> serialize::UseSpecializedEncodable for Lazy<T> {}
92 impl<T> serialize::UseSpecializedDecodable for Lazy<T> {}
94 impl<CTX, T> HashStable<CTX> for Lazy<T> {
95 fn hash_stable<W: StableHasherResult>(&self,
97 _: &mut StableHasher<W>) {
98 // There's nothing to do. Whatever got encoded within this Lazy<>
99 // wrapper has already been hashed.
103 /// A sequence of type T referred to by its absolute position
104 /// in the metadata and length, and which can be decoded lazily.
105 /// The sequence is a single node for the purposes of `Lazy`.
107 /// Unlike `Lazy<Vec<T>>`, the length is encoded next to the
108 /// position, not at the position, which means that the length
109 /// doesn't need to be known before encoding all the elements.
111 /// If the length is 0, no position is encoded, but otherwise,
112 /// the encoding is that of `Lazy`, with the distinction that
113 /// the minimal distance the length of the sequence, i.e.
114 /// it's assumed there's no 0-byte element in the sequence.
116 pub struct LazySeq<T> {
119 _marker: PhantomData<T>,
123 pub fn empty() -> LazySeq<T> {
124 LazySeq::with_position_and_length(0, 0)
127 pub fn with_position_and_length(position: usize, len: usize) -> LazySeq<T> {
131 _marker: PhantomData,
135 /// Returns the minimum encoded size of `length` values of type `T`.
136 pub fn min_size(length: usize) -> usize {
141 impl<T> Copy for LazySeq<T> {}
142 impl<T> Clone for LazySeq<T> {
143 fn clone(&self) -> Self {
148 impl<T> serialize::UseSpecializedEncodable for LazySeq<T> {}
149 impl<T> serialize::UseSpecializedDecodable for LazySeq<T> {}
151 impl<CTX, T> HashStable<CTX> for LazySeq<T> {
152 fn hash_stable<W: StableHasherResult>(&self,
154 _: &mut StableHasher<W>) {
155 // There's nothing to do. Whatever got encoded within this Lazy<>
156 // wrapper has already been hashed.
160 /// Encoding / decoding state for `Lazy` and `LazySeq`.
161 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
163 /// Outside of a metadata node.
166 /// Inside a metadata node, and before any `Lazy` or `LazySeq`.
167 /// The position is that of the node itself.
170 /// Inside a metadata node, with a previous `Lazy` or `LazySeq`.
171 /// The position is a conservative estimate of where that
172 /// previous `Lazy` / `LazySeq` would end (see their comments).
176 #[derive(RustcEncodable, RustcDecodable)]
177 pub struct CrateRoot {
179 pub triple: TargetTriple,
180 pub extra_filename: String,
182 pub disambiguator: CrateDisambiguator,
183 pub panic_strategy: PanicStrategy,
184 pub edition: Edition,
185 pub has_global_allocator: bool,
186 pub has_panic_handler: bool,
187 pub has_default_lib_allocator: bool,
188 pub plugin_registrar_fn: Option<DefIndex>,
189 pub proc_macro_decls_static: Option<DefIndex>,
190 pub proc_macro_stability: Option<attr::Stability>,
192 pub crate_deps: LazySeq<CrateDep>,
193 pub dylib_dependency_formats: LazySeq<Option<LinkagePreference>>,
194 pub lib_features: LazySeq<(Symbol, Option<Symbol>)>,
195 pub lang_items: LazySeq<(DefIndex, usize)>,
196 pub lang_items_missing: LazySeq<lang_items::LangItem>,
197 pub native_libraries: LazySeq<NativeLibrary>,
198 pub foreign_modules: LazySeq<ForeignModule>,
199 pub source_map: LazySeq<syntax_pos::SourceFile>,
200 pub def_path_table: Lazy<hir::map::definitions::DefPathTable>,
201 pub impls: LazySeq<TraitImpls>,
202 pub exported_symbols: EncodedExportedSymbols,
203 pub interpret_alloc_index: LazySeq<u32>,
205 pub index: LazySeq<index::Index>,
207 pub compiler_builtins: bool,
208 pub needs_allocator: bool,
209 pub needs_panic_runtime: bool,
210 pub no_builtins: bool,
211 pub panic_runtime: bool,
212 pub profiler_runtime: bool,
213 pub sanitizer_runtime: bool,
216 #[derive(RustcEncodable, RustcDecodable)]
217 pub struct CrateDep {
221 pub extra_filename: String,
224 impl_stable_hash_for!(struct CrateDep {
231 #[derive(RustcEncodable, RustcDecodable)]
232 pub struct TraitImpls {
233 pub trait_id: (u32, DefIndex),
234 pub impls: LazySeq<DefIndex>,
237 impl<'a, 'gcx> HashStable<StableHashingContext<'a>> for TraitImpls {
238 fn hash_stable<W: StableHasherResult>(&self,
239 hcx: &mut StableHashingContext<'a>,
240 hasher: &mut StableHasher<W>) {
242 trait_id: (krate, def_index),
247 krate: CrateNum::from_u32(krate),
249 }.hash_stable(hcx, hasher);
250 impls.hash_stable(hcx, hasher);
254 #[derive(RustcEncodable, RustcDecodable)]
255 pub struct Entry<'tcx> {
256 pub kind: EntryKind<'tcx>,
257 pub visibility: Lazy<ty::Visibility>,
258 pub span: Lazy<Span>,
259 pub attributes: LazySeq<ast::Attribute>,
260 pub children: LazySeq<DefIndex>,
261 pub stability: Option<Lazy<attr::Stability>>,
262 pub deprecation: Option<Lazy<attr::Deprecation>>,
264 pub ty: Option<Lazy<Ty<'tcx>>>,
265 pub inherent_impls: LazySeq<DefIndex>,
266 pub variances: LazySeq<ty::Variance>,
267 pub generics: Option<Lazy<ty::Generics>>,
268 pub predicates: Option<Lazy<ty::GenericPredicates<'tcx>>>,
269 pub predicates_defined_on: Option<Lazy<ty::GenericPredicates<'tcx>>>,
271 pub mir: Option<Lazy<mir::Mir<'tcx>>>,
274 impl_stable_hash_for!(struct Entry<'tcx> {
287 predicates_defined_on,
291 #[derive(Copy, Clone, RustcEncodable, RustcDecodable)]
292 pub enum EntryKind<'tcx> {
293 Const(ConstQualif, Lazy<RenderedConst>),
305 Variant(Lazy<VariantData<'tcx>>),
306 Struct(Lazy<VariantData<'tcx>>, ReprOptions),
307 Union(Lazy<VariantData<'tcx>>, ReprOptions),
308 Fn(Lazy<FnData<'tcx>>),
309 ForeignFn(Lazy<FnData<'tcx>>),
311 MacroDef(Lazy<MacroDef>),
312 Closure(Lazy<ClosureData<'tcx>>),
313 Generator(Lazy<GeneratorData<'tcx>>),
314 Trait(Lazy<TraitData<'tcx>>),
315 Impl(Lazy<ImplData<'tcx>>),
316 Method(Lazy<MethodData<'tcx>>),
317 AssociatedType(AssociatedContainer),
318 AssociatedExistential(AssociatedContainer),
319 AssociatedConst(AssociatedContainer, ConstQualif, Lazy<RenderedConst>),
320 TraitAlias(Lazy<TraitAliasData<'tcx>>),
323 impl<'a, 'gcx> HashStable<StableHashingContext<'a>> for EntryKind<'gcx> {
324 fn hash_stable<W: StableHasherResult>(&self,
325 hcx: &mut StableHashingContext<'a>,
326 hasher: &mut StableHasher<W>) {
327 mem::discriminant(self).hash_stable(hcx, hasher);
329 EntryKind::ImmStatic |
330 EntryKind::MutStatic |
331 EntryKind::ForeignImmStatic |
332 EntryKind::ForeignMutStatic |
333 EntryKind::ForeignMod |
334 EntryKind::GlobalAsm |
335 EntryKind::ForeignType |
337 EntryKind::Existential |
339 // Nothing else to hash here.
341 EntryKind::Const(qualif, ref const_data) => {
342 qualif.hash_stable(hcx, hasher);
343 const_data.hash_stable(hcx, hasher);
345 EntryKind::Enum(ref repr_options) => {
346 repr_options.hash_stable(hcx, hasher);
348 EntryKind::Variant(ref variant_data) => {
349 variant_data.hash_stable(hcx, hasher);
351 EntryKind::Struct(ref variant_data, ref repr_options) |
352 EntryKind::Union(ref variant_data, ref repr_options) => {
353 variant_data.hash_stable(hcx, hasher);
354 repr_options.hash_stable(hcx, hasher);
356 EntryKind::Fn(ref fn_data) |
357 EntryKind::ForeignFn(ref fn_data) => {
358 fn_data.hash_stable(hcx, hasher);
360 EntryKind::Mod(ref mod_data) => {
361 mod_data.hash_stable(hcx, hasher);
363 EntryKind::MacroDef(ref macro_def) => {
364 macro_def.hash_stable(hcx, hasher);
366 EntryKind::Generator(data) => {
367 data.hash_stable(hcx, hasher);
369 EntryKind::Closure(closure_data) => {
370 closure_data.hash_stable(hcx, hasher);
372 EntryKind::Trait(ref trait_data) => {
373 trait_data.hash_stable(hcx, hasher);
375 EntryKind::TraitAlias(ref trait_alias_data) => {
376 trait_alias_data.hash_stable(hcx, hasher);
378 EntryKind::Impl(ref impl_data) => {
379 impl_data.hash_stable(hcx, hasher);
381 EntryKind::Method(ref method_data) => {
382 method_data.hash_stable(hcx, hasher);
384 EntryKind::AssociatedExistential(associated_container) |
385 EntryKind::AssociatedType(associated_container) => {
386 associated_container.hash_stable(hcx, hasher);
388 EntryKind::AssociatedConst(associated_container, qualif, ref const_data) => {
389 associated_container.hash_stable(hcx, hasher);
390 qualif.hash_stable(hcx, hasher);
391 const_data.hash_stable(hcx, hasher);
397 /// Additional data for EntryKind::Const and EntryKind::AssociatedConst
398 #[derive(Clone, Copy, RustcEncodable, RustcDecodable)]
399 pub struct ConstQualif {
401 pub ast_promotable: bool,
404 impl_stable_hash_for!(struct ConstQualif { mir, ast_promotable });
406 /// Contains a constant which has been rendered to a String.
408 #[derive(RustcEncodable, RustcDecodable)]
409 pub struct RenderedConst(pub String);
411 impl<'a> HashStable<StableHashingContext<'a>> for RenderedConst {
413 fn hash_stable<W: StableHasherResult>(&self,
414 hcx: &mut StableHashingContext<'a>,
415 hasher: &mut StableHasher<W>) {
416 self.0.hash_stable(hcx, hasher);
420 #[derive(RustcEncodable, RustcDecodable)]
422 pub reexports: LazySeq<def::Export>,
425 impl_stable_hash_for!(struct ModData { reexports });
427 #[derive(RustcEncodable, RustcDecodable)]
428 pub struct MacroDef {
433 impl_stable_hash_for!(struct MacroDef { body, legacy });
435 #[derive(RustcEncodable, RustcDecodable)]
436 pub struct FnData<'tcx> {
437 pub constness: hir::Constness,
438 pub arg_names: LazySeq<ast::Name>,
439 pub sig: Lazy<ty::PolyFnSig<'tcx>>,
442 impl_stable_hash_for!(struct FnData<'tcx> { constness, arg_names, sig });
444 #[derive(RustcEncodable, RustcDecodable)]
445 pub struct VariantData<'tcx> {
446 pub ctor_kind: CtorKind,
447 pub discr: ty::VariantDiscr,
449 /// If this is a struct's only variant, this
450 /// is the index of the "struct ctor" item.
451 pub struct_ctor: Option<DefIndex>,
453 /// If this is a tuple struct or variant
454 /// ctor, this is its "function" signature.
455 pub ctor_sig: Option<Lazy<ty::PolyFnSig<'tcx>>>,
458 impl_stable_hash_for!(struct VariantData<'tcx> {
465 #[derive(RustcEncodable, RustcDecodable)]
466 pub struct TraitData<'tcx> {
467 pub unsafety: hir::Unsafety,
468 pub paren_sugar: bool,
469 pub has_auto_impl: bool,
471 pub super_predicates: Lazy<ty::GenericPredicates<'tcx>>,
474 impl_stable_hash_for!(struct TraitData<'tcx> {
482 #[derive(RustcEncodable, RustcDecodable)]
483 pub struct TraitAliasData<'tcx> {
484 pub super_predicates: Lazy<ty::GenericPredicates<'tcx>>,
487 impl_stable_hash_for!(struct TraitAliasData<'tcx> {
491 #[derive(RustcEncodable, RustcDecodable)]
492 pub struct ImplData<'tcx> {
493 pub polarity: hir::ImplPolarity,
494 pub defaultness: hir::Defaultness,
495 pub parent_impl: Option<DefId>,
497 /// This is `Some` only for impls of `CoerceUnsized`.
498 pub coerce_unsized_info: Option<ty::adjustment::CoerceUnsizedInfo>,
499 pub trait_ref: Option<Lazy<ty::TraitRef<'tcx>>>,
502 impl_stable_hash_for!(struct ImplData<'tcx> {
511 /// Describes whether the container of an associated item
512 /// is a trait or an impl and whether, in a trait, it has
513 /// a default, or an in impl, whether it's marked "default".
514 #[derive(Copy, Clone, RustcEncodable, RustcDecodable)]
515 pub enum AssociatedContainer {
522 impl_stable_hash_for!(enum crate::schema::AssociatedContainer {
529 impl AssociatedContainer {
530 pub fn with_def_id(&self, def_id: DefId) -> ty::AssociatedItemContainer {
532 AssociatedContainer::TraitRequired |
533 AssociatedContainer::TraitWithDefault => ty::TraitContainer(def_id),
535 AssociatedContainer::ImplDefault |
536 AssociatedContainer::ImplFinal => ty::ImplContainer(def_id),
540 pub fn defaultness(&self) -> hir::Defaultness {
542 AssociatedContainer::TraitRequired => hir::Defaultness::Default {
546 AssociatedContainer::TraitWithDefault |
547 AssociatedContainer::ImplDefault => hir::Defaultness::Default {
551 AssociatedContainer::ImplFinal => hir::Defaultness::Final,
556 #[derive(RustcEncodable, RustcDecodable)]
557 pub struct MethodData<'tcx> {
558 pub fn_data: FnData<'tcx>,
559 pub container: AssociatedContainer,
562 impl_stable_hash_for!(struct MethodData<'tcx> { fn_data, container, has_self });
564 #[derive(RustcEncodable, RustcDecodable)]
565 pub struct ClosureData<'tcx> {
566 pub sig: Lazy<ty::PolyFnSig<'tcx>>,
568 impl_stable_hash_for!(struct ClosureData<'tcx> { sig });
570 #[derive(RustcEncodable, RustcDecodable)]
571 pub struct GeneratorData<'tcx> {
572 pub layout: mir::GeneratorLayout<'tcx>,
574 impl_stable_hash_for!(struct GeneratorData<'tcx> { layout });
576 // Tags used for encoding Spans:
577 pub const TAG_VALID_SPAN: u8 = 0;
578 pub const TAG_INVALID_SPAN: u8 = 1;
580 #[derive(RustcEncodable, RustcDecodable)]
581 pub struct EncodedExportedSymbols {