1 use crate::index::Index;
4 use rustc::middle::cstore::{LinkagePreference, NativeLibrary,
5 EncodedMetadata, ForeignModule};
6 use rustc::hir::def::CtorKind;
7 use rustc::hir::def_id::{CrateNum, CRATE_DEF_INDEX, DefIndex, DefId, LocalDefId, LOCAL_CRATE};
8 use rustc::hir::GenericParamKind;
9 use rustc::hir::map::definitions::DefPathTable;
10 use rustc_data_structures::fingerprint::Fingerprint;
11 use rustc::middle::dependency_format::Linkage;
12 use rustc::middle::exported_symbols::{ExportedSymbol, SymbolExportLevel,
13 metadata_symbol_name};
14 use rustc::middle::lang_items;
15 use rustc::mir::{self, interpret};
16 use rustc::traits::specialization_graph;
17 use rustc::ty::{self, Ty, TyCtxt, ReprOptions, SymbolName};
18 use rustc::ty::codec::{self as ty_codec, TyEncoder};
19 use rustc::ty::layout::VariantIdx;
21 use rustc::session::config::{self, CrateType};
22 use rustc::util::nodemap::FxHashMap;
24 use rustc_data_structures::stable_hasher::StableHasher;
25 use rustc_serialize::{Encodable, Encoder, SpecializedEncoder, opaque};
29 use rustc_data_structures::sync::Lrc;
33 use syntax::source_map::Spanned;
34 use syntax::symbol::{kw, sym};
35 use syntax_pos::{self, FileName, SourceFile, Span};
36 use log::{debug, trace};
38 use rustc::hir::{self, PatKind};
39 use rustc::hir::itemlikevisit::ItemLikeVisitor;
40 use rustc::hir::intravisit::{Visitor, NestedVisitorMap};
41 use rustc::hir::intravisit;
43 pub struct EncodeContext<'tcx> {
44 opaque: opaque::Encoder,
45 pub tcx: TyCtxt<'tcx, 'tcx>,
47 entries_index: Index<'tcx>,
49 lazy_state: LazyState,
50 type_shorthands: FxHashMap<Ty<'tcx>, usize>,
51 predicate_shorthands: FxHashMap<ty::Predicate<'tcx>, usize>,
53 interpret_allocs: FxHashMap<interpret::AllocId, usize>,
54 interpret_allocs_inverse: Vec<interpret::AllocId>,
56 // This is used to speed up Span encoding.
57 source_file_cache: Lrc<SourceFile>,
60 macro_rules! encoder_methods {
61 ($($name:ident($ty:ty);)*) => {
62 $(fn $name(&mut self, value: $ty) -> Result<(), Self::Error> {
63 self.opaque.$name(value)
68 impl<'tcx> Encoder for EncodeContext<'tcx> {
69 type Error = <opaque::Encoder as Encoder>::Error;
71 fn emit_unit(&mut self) -> Result<(), Self::Error> {
98 impl<'tcx, T> SpecializedEncoder<Lazy<T>> for EncodeContext<'tcx> {
99 fn specialized_encode(&mut self, lazy: &Lazy<T>) -> Result<(), Self::Error> {
100 self.emit_lazy_distance(lazy.position, Lazy::<T>::min_size())
104 impl<'tcx, T> SpecializedEncoder<LazySeq<T>> for EncodeContext<'tcx> {
105 fn specialized_encode(&mut self, seq: &LazySeq<T>) -> Result<(), Self::Error> {
106 self.emit_usize(seq.len)?;
110 self.emit_lazy_distance(seq.position, LazySeq::<T>::min_size(seq.len))
114 impl<'tcx> SpecializedEncoder<CrateNum> for EncodeContext<'tcx> {
116 fn specialized_encode(&mut self, cnum: &CrateNum) -> Result<(), Self::Error> {
117 self.emit_u32(cnum.as_u32())
121 impl<'tcx> SpecializedEncoder<DefId> for EncodeContext<'tcx> {
123 fn specialized_encode(&mut self, def_id: &DefId) -> Result<(), Self::Error> {
134 impl<'tcx> SpecializedEncoder<DefIndex> for EncodeContext<'tcx> {
136 fn specialized_encode(&mut self, def_index: &DefIndex) -> Result<(), Self::Error> {
137 self.emit_u32(def_index.as_u32())
141 impl<'tcx> SpecializedEncoder<Span> for EncodeContext<'tcx> {
142 fn specialized_encode(&mut self, span: &Span) -> Result<(), Self::Error> {
144 return TAG_INVALID_SPAN.encode(self)
147 let span = span.data();
149 // The Span infrastructure should make sure that this invariant holds:
150 debug_assert!(span.lo <= span.hi);
152 if !self.source_file_cache.contains(span.lo) {
153 let source_map = self.tcx.sess.source_map();
154 let source_file_index = source_map.lookup_source_file_idx(span.lo);
155 self.source_file_cache = source_map.files()[source_file_index].clone();
158 if !self.source_file_cache.contains(span.hi) {
159 // Unfortunately, macro expansion still sometimes generates Spans
160 // that malformed in this way.
161 return TAG_INVALID_SPAN.encode(self)
164 TAG_VALID_SPAN.encode(self)?;
165 span.lo.encode(self)?;
167 // Encode length which is usually less than span.hi and profits more
168 // from the variable-length integer encoding that we use.
169 let len = span.hi - span.lo;
172 // Don't encode the expansion context.
176 impl<'tcx> SpecializedEncoder<LocalDefId> for EncodeContext<'tcx> {
178 fn specialized_encode(&mut self, def_id: &LocalDefId) -> Result<(), Self::Error> {
179 self.specialized_encode(&def_id.to_def_id())
183 impl<'tcx> SpecializedEncoder<Ty<'tcx>> for EncodeContext<'tcx> {
184 fn specialized_encode(&mut self, ty: &Ty<'tcx>) -> Result<(), Self::Error> {
185 ty_codec::encode_with_shorthand(self, ty, |ecx| &mut ecx.type_shorthands)
189 impl<'tcx> SpecializedEncoder<interpret::AllocId> for EncodeContext<'tcx> {
190 fn specialized_encode(&mut self, alloc_id: &interpret::AllocId) -> Result<(), Self::Error> {
191 use std::collections::hash_map::Entry;
192 let index = match self.interpret_allocs.entry(*alloc_id) {
193 Entry::Occupied(e) => *e.get(),
194 Entry::Vacant(e) => {
195 let idx = self.interpret_allocs_inverse.len();
196 self.interpret_allocs_inverse.push(*alloc_id);
206 impl<'tcx> SpecializedEncoder<ty::GenericPredicates<'tcx>> for EncodeContext<'tcx> {
207 fn specialized_encode(&mut self,
208 predicates: &ty::GenericPredicates<'tcx>)
209 -> Result<(), Self::Error> {
210 ty_codec::encode_predicates(self, predicates, |ecx| &mut ecx.predicate_shorthands)
214 impl<'tcx> SpecializedEncoder<Fingerprint> for EncodeContext<'tcx> {
215 fn specialized_encode(&mut self, f: &Fingerprint) -> Result<(), Self::Error> {
216 f.encode_opaque(&mut self.opaque)
220 impl<'tcx, T: Encodable> SpecializedEncoder<mir::ClearCrossCrate<T>> for EncodeContext<'tcx> {
221 fn specialized_encode(&mut self,
222 _: &mir::ClearCrossCrate<T>)
223 -> Result<(), Self::Error> {
228 impl<'tcx> TyEncoder for EncodeContext<'tcx> {
229 fn position(&self) -> usize {
230 self.opaque.position()
234 impl<'tcx> EncodeContext<'tcx> {
235 fn emit_node<F: FnOnce(&mut Self, usize) -> R, R>(&mut self, f: F) -> R {
236 assert_eq!(self.lazy_state, LazyState::NoNode);
237 let pos = self.position();
238 self.lazy_state = LazyState::NodeStart(pos);
239 let r = f(self, pos);
240 self.lazy_state = LazyState::NoNode;
244 fn emit_lazy_distance(&mut self,
247 -> Result<(), <Self as Encoder>::Error> {
248 let min_end = position + min_size;
249 let distance = match self.lazy_state {
250 LazyState::NoNode => bug!("emit_lazy_distance: outside of a metadata node"),
251 LazyState::NodeStart(start) => {
252 assert!(min_end <= start);
255 LazyState::Previous(last_min_end) => {
257 last_min_end <= position,
258 "make sure that the calls to `lazy*` \
259 are in the same order as the metadata fields",
261 position - last_min_end
264 self.lazy_state = LazyState::Previous(min_end);
265 self.emit_usize(distance)
268 pub fn lazy<T: Encodable>(&mut self, value: &T) -> Lazy<T> {
269 self.emit_node(|ecx, pos| {
270 value.encode(ecx).unwrap();
272 assert!(pos + Lazy::<T>::min_size() <= ecx.position());
273 Lazy::with_position(pos)
277 pub fn lazy_seq<I, T>(&mut self, iter: I) -> LazySeq<T>
278 where I: IntoIterator<Item = T>,
281 self.emit_node(|ecx, pos| {
282 let len = iter.into_iter().map(|value| value.encode(ecx).unwrap()).count();
284 assert!(pos + LazySeq::<T>::min_size(len) <= ecx.position());
285 LazySeq::with_position_and_length(pos, len)
289 pub fn lazy_seq_ref<'b, I, T>(&mut self, iter: I) -> LazySeq<T>
290 where I: IntoIterator<Item = &'b T>,
293 self.emit_node(|ecx, pos| {
294 let len = iter.into_iter().map(|value| value.encode(ecx).unwrap()).count();
296 assert!(pos + LazySeq::<T>::min_size(len) <= ecx.position());
297 LazySeq::with_position_and_length(pos, len)
301 /// Emit the data for a `DefId` to the metadata. The function to
302 /// emit the data is `op`, and it will be given `data` as
303 /// arguments. This `record` function will call `op` to generate
304 /// the `Entry` (which may point to other encoded information)
305 /// and will then record the `Lazy<Entry>` for use in the index.
306 // FIXME(eddyb) remove this.
307 pub fn record<DATA>(&mut self,
309 op: impl FnOnce(&mut Self, DATA) -> Entry<'tcx>,
312 assert!(id.is_local());
314 let entry = op(self, data);
315 let entry = self.lazy(&entry);
316 self.entries_index.record(id, entry);
319 fn encode_info_for_items(&mut self) {
320 let krate = self.tcx.hir().krate();
321 let vis = Spanned { span: syntax_pos::DUMMY_SP, node: hir::VisibilityKind::Public };
322 self.record(DefId::local(CRATE_DEF_INDEX),
323 EncodeContext::encode_info_for_mod,
324 (hir::CRATE_HIR_ID, &krate.module, &krate.attrs, &vis));
325 krate.visit_all_item_likes(&mut self.as_deep_visitor());
326 for macro_def in &krate.exported_macros {
327 self.visit_macro_def(macro_def);
331 fn encode_def_path_table(&mut self) -> Lazy<DefPathTable> {
332 let definitions = self.tcx.hir().definitions();
333 self.lazy(definitions.def_path_table())
336 fn encode_source_map(&mut self) -> LazySeq<syntax_pos::SourceFile> {
337 let source_map = self.tcx.sess.source_map();
338 let all_source_files = source_map.files();
340 let (working_dir, _cwd_remapped) = self.tcx.sess.working_dir.clone();
342 let adapted = all_source_files.iter()
343 .filter(|source_file| {
344 // No need to re-export imported source_files, as any downstream
345 // crate will import them from their original source.
346 !source_file.is_imported()
349 match source_file.name {
350 // This path of this SourceFile has been modified by
351 // path-remapping, so we use it verbatim (and avoid
352 // cloning the whole map in the process).
353 _ if source_file.name_was_remapped => source_file.clone(),
355 // Otherwise expand all paths to absolute paths because
356 // any relative paths are potentially relative to a
358 FileName::Real(ref name) => {
359 let mut adapted = (**source_file).clone();
360 adapted.name = Path::new(&working_dir).join(name).into();
361 adapted.name_hash = {
362 let mut hasher: StableHasher<u128> = StableHasher::new();
363 adapted.name.hash(&mut hasher);
369 // expanded code, not from a file
370 _ => source_file.clone(),
373 .collect::<Vec<_>>();
375 self.lazy_seq_ref(adapted.iter().map(|rc| &**rc))
378 fn encode_crate_root(&mut self) -> Lazy<CrateRoot<'tcx>> {
379 let mut i = self.position();
381 let crate_deps = self.encode_crate_deps();
382 let dylib_dependency_formats = self.encode_dylib_dependency_formats();
383 let dep_bytes = self.position() - i;
385 // Encode the lib features.
387 let lib_features = self.encode_lib_features();
388 let lib_feature_bytes = self.position() - i;
390 // Encode the language items.
392 let lang_items = self.encode_lang_items();
393 let lang_items_missing = self.encode_lang_items_missing();
394 let lang_item_bytes = self.position() - i;
396 // Encode the native libraries used
398 let native_libraries = self.encode_native_libraries();
399 let native_lib_bytes = self.position() - i;
401 let foreign_modules = self.encode_foreign_modules();
405 let source_map = self.encode_source_map();
406 let source_map_bytes = self.position() - i;
408 // Encode DefPathTable
410 let def_path_table = self.encode_def_path_table();
411 let def_path_table_bytes = self.position() - i;
413 // Encode the def IDs of impls, for coherence checking.
415 let impls = self.encode_impls();
416 let impl_bytes = self.position() - i;
418 // Encode exported symbols info.
420 let exported_symbols = self.tcx.exported_symbols(LOCAL_CRATE);
421 let exported_symbols = self.encode_exported_symbols(&exported_symbols);
422 let exported_symbols_bytes = self.position() - i;
428 self.encode_info_for_items();
429 let item_bytes = self.position() - i;
431 // Encode the allocation index
432 let interpret_alloc_index = {
433 let mut interpret_alloc_index = Vec::new();
435 trace!("beginning to encode alloc ids");
437 let new_n = self.interpret_allocs_inverse.len();
438 // if we have found new ids, serialize those, too
443 trace!("encoding {} further alloc ids", new_n - n);
444 for idx in n..new_n {
445 let id = self.interpret_allocs_inverse[idx];
446 let pos = self.position() as u32;
447 interpret_alloc_index.push(pos);
448 interpret::specialized_encode_alloc_id(
456 self.lazy_seq(interpret_alloc_index)
460 let entries_index = self.entries_index.write_index(&mut self.opaque);
461 let entries_index_bytes = self.position() - i;
463 let attrs = tcx.hir().krate_attrs();
464 let is_proc_macro = tcx.sess.crate_types.borrow().contains(&CrateType::ProcMacro);
465 let has_default_lib_allocator = attr::contains_name(&attrs, sym::default_lib_allocator);
466 let has_global_allocator = *tcx.sess.has_global_allocator.get();
467 let has_panic_handler = *tcx.sess.has_panic_handler.try_get().unwrap_or(&false);
469 let root = self.lazy(&CrateRoot {
470 name: tcx.crate_name(LOCAL_CRATE),
471 extra_filename: tcx.sess.opts.cg.extra_filename.clone(),
472 triple: tcx.sess.opts.target_triple.clone(),
473 hash: tcx.crate_hash(LOCAL_CRATE),
474 disambiguator: tcx.sess.local_crate_disambiguator(),
475 panic_strategy: tcx.sess.panic_strategy(),
476 edition: tcx.sess.edition(),
477 has_global_allocator: has_global_allocator,
478 has_panic_handler: has_panic_handler,
479 has_default_lib_allocator: has_default_lib_allocator,
480 plugin_registrar_fn: tcx.plugin_registrar_fn(LOCAL_CRATE).map(|id| id.index),
481 proc_macro_decls_static: if is_proc_macro {
482 let id = tcx.proc_macro_decls_static(LOCAL_CRATE).unwrap();
487 proc_macro_stability: if is_proc_macro {
488 tcx.lookup_stability(DefId::local(CRATE_DEF_INDEX)).map(|stab| stab.clone())
492 compiler_builtins: attr::contains_name(&attrs, sym::compiler_builtins),
493 needs_allocator: attr::contains_name(&attrs, sym::needs_allocator),
494 needs_panic_runtime: attr::contains_name(&attrs, sym::needs_panic_runtime),
495 no_builtins: attr::contains_name(&attrs, sym::no_builtins),
496 panic_runtime: attr::contains_name(&attrs, sym::panic_runtime),
497 profiler_runtime: attr::contains_name(&attrs, sym::profiler_runtime),
498 sanitizer_runtime: attr::contains_name(&attrs, sym::sanitizer_runtime),
499 symbol_mangling_version: tcx.sess.opts.debugging_opts.symbol_mangling_version,
502 dylib_dependency_formats,
512 interpret_alloc_index,
516 let total_bytes = self.position();
518 if self.tcx.sess.meta_stats() {
519 let mut zero_bytes = 0;
520 for e in self.opaque.data.iter() {
526 println!("metadata stats:");
527 println!(" dep bytes: {}", dep_bytes);
528 println!(" lib feature bytes: {}", lib_feature_bytes);
529 println!(" lang item bytes: {}", lang_item_bytes);
530 println!(" native bytes: {}", native_lib_bytes);
531 println!(" source_map bytes: {}", source_map_bytes);
532 println!(" impl bytes: {}", impl_bytes);
533 println!(" exp. symbols bytes: {}", exported_symbols_bytes);
534 println!(" def-path table bytes: {}", def_path_table_bytes);
535 println!(" item bytes: {}", item_bytes);
536 println!(" entries index bytes: {}", entries_index_bytes);
537 println!(" zero bytes: {}", zero_bytes);
538 println!(" total bytes: {}", total_bytes);
545 impl EncodeContext<'tcx> {
546 fn encode_variances_of(&mut self, def_id: DefId) -> LazySeq<ty::Variance> {
547 debug!("EncodeContext::encode_variances_of({:?})", def_id);
549 self.lazy_seq_ref(&tcx.variances_of(def_id)[..])
552 fn encode_item_type(&mut self, def_id: DefId) -> Lazy<Ty<'tcx>> {
554 let ty = tcx.type_of(def_id);
555 debug!("EncodeContext::encode_item_type({:?}) => {:?}", def_id, ty);
559 fn encode_enum_variant_info(
561 (enum_did, index): (DefId, VariantIdx),
564 let def = tcx.adt_def(enum_did);
565 let variant = &def.variants[index];
566 let def_id = variant.def_id;
567 debug!("EncodeContext::encode_enum_variant_info({:?})", def_id);
569 let data = VariantData {
570 ctor_kind: variant.ctor_kind,
571 discr: variant.discr,
572 // FIXME(eddyb) deduplicate these with `encode_enum_variant_ctor`.
573 ctor: variant.ctor_def_id.map(|did| did.index),
574 ctor_sig: if variant.ctor_kind == CtorKind::Fn {
575 variant.ctor_def_id.map(|ctor_def_id| self.lazy(&tcx.fn_sig(ctor_def_id)))
581 let enum_id = tcx.hir().as_local_hir_id(enum_did).unwrap();
582 let enum_vis = &tcx.hir().expect_item_by_hir_id(enum_id).vis;
585 kind: EntryKind::Variant(self.lazy(&data)),
586 visibility: self.lazy(&ty::Visibility::from_hir(enum_vis, enum_id, tcx)),
587 span: self.lazy(&tcx.def_span(def_id)),
588 attributes: self.encode_attributes(&tcx.get_attrs(def_id)),
589 children: self.lazy_seq(variant.fields.iter().map(|f| {
590 assert!(f.did.is_local());
593 stability: self.encode_stability(def_id),
594 deprecation: self.encode_deprecation(def_id),
596 ty: Some(self.encode_item_type(def_id)),
597 inherent_impls: LazySeq::empty(),
598 variances: if variant.ctor_kind == CtorKind::Fn {
599 self.encode_variances_of(def_id)
603 generics: Some(self.encode_generics(def_id)),
604 predicates: Some(self.encode_predicates(def_id)),
605 predicates_defined_on: None,
607 mir: self.encode_optimized_mir(def_id),
611 fn encode_enum_variant_ctor(
613 (enum_did, index): (DefId, VariantIdx),
616 let def = tcx.adt_def(enum_did);
617 let variant = &def.variants[index];
618 let def_id = variant.ctor_def_id.unwrap();
619 debug!("EncodeContext::encode_enum_variant_ctor({:?})", def_id);
621 let data = VariantData {
622 ctor_kind: variant.ctor_kind,
623 discr: variant.discr,
624 ctor: Some(def_id.index),
625 ctor_sig: if variant.ctor_kind == CtorKind::Fn {
626 Some(self.lazy(&tcx.fn_sig(def_id)))
632 // Variant constructors have the same visibility as the parent enums, unless marked as
633 // non-exhaustive, in which case they are lowered to `pub(crate)`.
634 let enum_id = tcx.hir().as_local_hir_id(enum_did).unwrap();
635 let enum_vis = &tcx.hir().expect_item_by_hir_id(enum_id).vis;
636 let mut ctor_vis = ty::Visibility::from_hir(enum_vis, enum_id, tcx);
637 if variant.is_field_list_non_exhaustive() && ctor_vis == ty::Visibility::Public {
638 ctor_vis = ty::Visibility::Restricted(DefId::local(CRATE_DEF_INDEX));
642 kind: EntryKind::Variant(self.lazy(&data)),
643 visibility: self.lazy(&ctor_vis),
644 span: self.lazy(&tcx.def_span(def_id)),
645 attributes: LazySeq::empty(),
646 children: LazySeq::empty(),
647 stability: self.encode_stability(def_id),
648 deprecation: self.encode_deprecation(def_id),
650 ty: Some(self.encode_item_type(def_id)),
651 inherent_impls: LazySeq::empty(),
652 variances: if variant.ctor_kind == CtorKind::Fn {
653 self.encode_variances_of(def_id)
657 generics: Some(self.encode_generics(def_id)),
658 predicates: Some(self.encode_predicates(def_id)),
659 predicates_defined_on: None,
661 mir: self.encode_optimized_mir(def_id),
665 fn encode_info_for_mod(
667 (id, md, attrs, vis): (hir::HirId, &hir::Mod, &[ast::Attribute], &hir::Visibility),
670 let def_id = tcx.hir().local_def_id_from_hir_id(id);
671 debug!("EncodeContext::encode_info_for_mod({:?})", def_id);
674 reexports: match tcx.module_exports(def_id) {
675 Some(exports) => self.lazy_seq_ref(exports),
676 _ => LazySeq::empty(),
681 kind: EntryKind::Mod(self.lazy(&data)),
682 visibility: self.lazy(&ty::Visibility::from_hir(vis, id, tcx)),
683 span: self.lazy(&tcx.def_span(def_id)),
684 attributes: self.encode_attributes(attrs),
685 children: self.lazy_seq(md.item_ids.iter().map(|item_id| {
686 tcx.hir().local_def_id_from_hir_id(item_id.id).index
688 stability: self.encode_stability(def_id),
689 deprecation: self.encode_deprecation(def_id),
692 inherent_impls: LazySeq::empty(),
693 variances: LazySeq::empty(),
696 predicates_defined_on: None,
704 (adt_def_id, variant_index, field_index): (DefId, VariantIdx, usize),
707 let variant = &tcx.adt_def(adt_def_id).variants[variant_index];
708 let field = &variant.fields[field_index];
710 let def_id = field.did;
711 debug!("EncodeContext::encode_field({:?})", def_id);
713 let variant_id = tcx.hir().as_local_hir_id(variant.def_id).unwrap();
714 let variant_data = tcx.hir().expect_variant_data(variant_id);
717 kind: EntryKind::Field,
718 visibility: self.lazy(&field.vis),
719 span: self.lazy(&tcx.def_span(def_id)),
720 attributes: self.encode_attributes(&variant_data.fields()[field_index].attrs),
721 children: LazySeq::empty(),
722 stability: self.encode_stability(def_id),
723 deprecation: self.encode_deprecation(def_id),
725 ty: Some(self.encode_item_type(def_id)),
726 inherent_impls: LazySeq::empty(),
727 variances: LazySeq::empty(),
728 generics: Some(self.encode_generics(def_id)),
729 predicates: Some(self.encode_predicates(def_id)),
730 predicates_defined_on: None,
736 fn encode_struct_ctor(&mut self, (adt_def_id, def_id): (DefId, DefId)) -> Entry<'tcx> {
737 debug!("EncodeContext::encode_struct_ctor({:?})", def_id);
739 let adt_def = tcx.adt_def(adt_def_id);
740 let variant = adt_def.non_enum_variant();
742 let data = VariantData {
743 ctor_kind: variant.ctor_kind,
744 discr: variant.discr,
745 ctor: Some(def_id.index),
746 ctor_sig: if variant.ctor_kind == CtorKind::Fn {
747 Some(self.lazy(&tcx.fn_sig(def_id)))
753 let struct_id = tcx.hir().as_local_hir_id(adt_def_id).unwrap();
754 let struct_vis = &tcx.hir().expect_item_by_hir_id(struct_id).vis;
755 let mut ctor_vis = ty::Visibility::from_hir(struct_vis, struct_id, tcx);
756 for field in &variant.fields {
757 if ctor_vis.is_at_least(field.vis, tcx) {
758 ctor_vis = field.vis;
762 // If the structure is marked as non_exhaustive then lower the visibility
763 // to within the crate.
764 if adt_def.non_enum_variant().is_field_list_non_exhaustive() &&
765 ctor_vis == ty::Visibility::Public
767 ctor_vis = ty::Visibility::Restricted(DefId::local(CRATE_DEF_INDEX));
770 let repr_options = get_repr_options(tcx, adt_def_id);
773 kind: EntryKind::Struct(self.lazy(&data), repr_options),
774 visibility: self.lazy(&ctor_vis),
775 span: self.lazy(&tcx.def_span(def_id)),
776 attributes: LazySeq::empty(),
777 children: LazySeq::empty(),
778 stability: self.encode_stability(def_id),
779 deprecation: self.encode_deprecation(def_id),
781 ty: Some(self.encode_item_type(def_id)),
782 inherent_impls: LazySeq::empty(),
783 variances: if variant.ctor_kind == CtorKind::Fn {
784 self.encode_variances_of(def_id)
788 generics: Some(self.encode_generics(def_id)),
789 predicates: Some(self.encode_predicates(def_id)),
790 predicates_defined_on: None,
792 mir: self.encode_optimized_mir(def_id),
796 fn encode_generics(&mut self, def_id: DefId) -> Lazy<ty::Generics> {
797 debug!("EncodeContext::encode_generics({:?})", def_id);
799 self.lazy(tcx.generics_of(def_id))
802 fn encode_predicates(&mut self, def_id: DefId) -> Lazy<ty::GenericPredicates<'tcx>> {
803 debug!("EncodeContext::encode_predicates({:?})", def_id);
805 self.lazy(&tcx.predicates_of(def_id))
808 fn encode_predicates_defined_on(&mut self, def_id: DefId) -> Lazy<ty::GenericPredicates<'tcx>> {
809 debug!("EncodeContext::encode_predicates_defined_on({:?})", def_id);
811 self.lazy(&tcx.predicates_defined_on(def_id))
814 fn encode_info_for_trait_item(&mut self, def_id: DefId) -> Entry<'tcx> {
815 debug!("EncodeContext::encode_info_for_trait_item({:?})", def_id);
818 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
819 let ast_item = tcx.hir().expect_trait_item(hir_id);
820 let trait_item = tcx.associated_item(def_id);
822 let container = match trait_item.defaultness {
823 hir::Defaultness::Default { has_value: true } =>
824 AssocContainer::TraitWithDefault,
825 hir::Defaultness::Default { has_value: false } =>
826 AssocContainer::TraitRequired,
827 hir::Defaultness::Final =>
828 span_bug!(ast_item.span, "traits cannot have final items"),
831 let kind = match trait_item.kind {
832 ty::AssocKind::Const => {
834 if let hir::TraitItemKind::Const(_, Some(body)) = ast_item.node {
835 self.const_qualif(0, body)
837 ConstQualif { mir: 0, ast_promotable: false }
841 hir::print::to_string(self.tcx.hir(), |s| s.print_trait_item(ast_item));
842 let rendered_const = self.lazy(&RenderedConst(rendered));
844 EntryKind::AssocConst(container, const_qualif, rendered_const)
846 ty::AssocKind::Method => {
847 let fn_data = if let hir::TraitItemKind::Method(_, ref m) = ast_item.node {
848 let arg_names = match *m {
849 hir::TraitMethod::Required(ref names) => {
850 self.encode_fn_arg_names(names)
852 hir::TraitMethod::Provided(body) => {
853 self.encode_fn_arg_names_for_body(body)
857 constness: hir::Constness::NotConst,
859 sig: self.lazy(&tcx.fn_sig(def_id)),
864 EntryKind::Method(self.lazy(&MethodData {
867 has_self: trait_item.method_has_self_argument,
870 ty::AssocKind::Type => EntryKind::AssocType(container),
871 ty::AssocKind::Existential =>
872 span_bug!(ast_item.span, "existential type in trait"),
877 visibility: self.lazy(&trait_item.vis),
878 span: self.lazy(&ast_item.span),
879 attributes: self.encode_attributes(&ast_item.attrs),
880 children: LazySeq::empty(),
881 stability: self.encode_stability(def_id),
882 deprecation: self.encode_deprecation(def_id),
884 ty: match trait_item.kind {
885 ty::AssocKind::Const |
886 ty::AssocKind::Method => {
887 Some(self.encode_item_type(def_id))
889 ty::AssocKind::Type => {
890 if trait_item.defaultness.has_value() {
891 Some(self.encode_item_type(def_id))
896 ty::AssocKind::Existential => unreachable!(),
898 inherent_impls: LazySeq::empty(),
899 variances: if trait_item.kind == ty::AssocKind::Method {
900 self.encode_variances_of(def_id)
904 generics: Some(self.encode_generics(def_id)),
905 predicates: Some(self.encode_predicates(def_id)),
906 predicates_defined_on: None,
908 mir: self.encode_optimized_mir(def_id),
912 fn metadata_output_only(&self) -> bool {
913 // MIR optimisation can be skipped when we're just interested in the metadata.
914 !self.tcx.sess.opts.output_types.should_codegen()
917 fn const_qualif(&self, mir: u8, body_id: hir::BodyId) -> ConstQualif {
918 let body_owner_def_id = self.tcx.hir().body_owner_def_id(body_id);
919 let ast_promotable = self.tcx.const_is_rvalue_promotable_to_static(body_owner_def_id);
921 ConstQualif { mir, ast_promotable }
924 fn encode_info_for_impl_item(&mut self, def_id: DefId) -> Entry<'tcx> {
925 debug!("EncodeContext::encode_info_for_impl_item({:?})", def_id);
928 let hir_id = self.tcx.hir().as_local_hir_id(def_id).unwrap();
929 let ast_item = self.tcx.hir().expect_impl_item(hir_id);
930 let impl_item = self.tcx.associated_item(def_id);
932 let container = match impl_item.defaultness {
933 hir::Defaultness::Default { has_value: true } => AssocContainer::ImplDefault,
934 hir::Defaultness::Final => AssocContainer::ImplFinal,
935 hir::Defaultness::Default { has_value: false } =>
936 span_bug!(ast_item.span, "impl items always have values (currently)"),
939 let kind = match impl_item.kind {
940 ty::AssocKind::Const => {
941 if let hir::ImplItemKind::Const(_, body_id) = ast_item.node {
942 let mir = self.tcx.at(ast_item.span).mir_const_qualif(def_id).0;
944 EntryKind::AssocConst(container,
945 self.const_qualif(mir, body_id),
946 self.encode_rendered_const_for_body(body_id))
951 ty::AssocKind::Method => {
952 let fn_data = if let hir::ImplItemKind::Method(ref sig, body) = ast_item.node {
954 constness: sig.header.constness,
955 arg_names: self.encode_fn_arg_names_for_body(body),
956 sig: self.lazy(&tcx.fn_sig(def_id)),
961 EntryKind::Method(self.lazy(&MethodData {
964 has_self: impl_item.method_has_self_argument,
967 ty::AssocKind::Existential => EntryKind::AssocExistential(container),
968 ty::AssocKind::Type => EntryKind::AssocType(container)
972 match ast_item.node {
973 hir::ImplItemKind::Const(..) => true,
974 hir::ImplItemKind::Method(ref sig, _) => {
975 let generics = self.tcx.generics_of(def_id);
976 let needs_inline = (generics.requires_monomorphization(self.tcx) ||
977 tcx.codegen_fn_attrs(def_id).requests_inline()) &&
978 !self.metadata_output_only();
979 let is_const_fn = sig.header.constness == hir::Constness::Const;
980 let always_encode_mir = self.tcx.sess.opts.debugging_opts.always_encode_mir;
981 needs_inline || is_const_fn || always_encode_mir
983 hir::ImplItemKind::Existential(..) |
984 hir::ImplItemKind::Type(..) => false,
989 visibility: self.lazy(&impl_item.vis),
990 span: self.lazy(&ast_item.span),
991 attributes: self.encode_attributes(&ast_item.attrs),
992 children: LazySeq::empty(),
993 stability: self.encode_stability(def_id),
994 deprecation: self.encode_deprecation(def_id),
996 ty: Some(self.encode_item_type(def_id)),
997 inherent_impls: LazySeq::empty(),
998 variances: if impl_item.kind == ty::AssocKind::Method {
999 self.encode_variances_of(def_id)
1003 generics: Some(self.encode_generics(def_id)),
1004 predicates: Some(self.encode_predicates(def_id)),
1005 predicates_defined_on: None,
1007 mir: if mir { self.encode_optimized_mir(def_id) } else { None },
1011 fn encode_fn_arg_names_for_body(&mut self, body_id: hir::BodyId)
1012 -> LazySeq<ast::Name> {
1013 self.tcx.dep_graph.with_ignore(|| {
1014 let body = self.tcx.hir().body(body_id);
1015 self.lazy_seq(body.arguments.iter().map(|arg| {
1016 match arg.pat.node {
1017 PatKind::Binding(_, _, ident, _) => ident.name,
1024 fn encode_fn_arg_names(&mut self, param_names: &[ast::Ident]) -> LazySeq<ast::Name> {
1025 self.lazy_seq(param_names.iter().map(|ident| ident.name))
1028 fn encode_optimized_mir(&mut self, def_id: DefId) -> Option<Lazy<mir::Body<'tcx>>> {
1029 debug!("EntryBuilder::encode_mir({:?})", def_id);
1030 if self.tcx.mir_keys(LOCAL_CRATE).contains(&def_id) {
1031 let mir = self.tcx.optimized_mir(def_id);
1032 Some(self.lazy(&mir))
1038 // Encodes the inherent implementations of a structure, enumeration, or trait.
1039 fn encode_inherent_implementations(&mut self, def_id: DefId) -> LazySeq<DefIndex> {
1040 debug!("EncodeContext::encode_inherent_implementations({:?})", def_id);
1041 let implementations = self.tcx.inherent_impls(def_id);
1042 if implementations.is_empty() {
1045 self.lazy_seq(implementations.iter().map(|&def_id| {
1046 assert!(def_id.is_local());
1052 fn encode_stability(&mut self, def_id: DefId) -> Option<Lazy<attr::Stability>> {
1053 debug!("EncodeContext::encode_stability({:?})", def_id);
1054 self.tcx.lookup_stability(def_id).map(|stab| self.lazy(stab))
1057 fn encode_deprecation(&mut self, def_id: DefId) -> Option<Lazy<attr::Deprecation>> {
1058 debug!("EncodeContext::encode_deprecation({:?})", def_id);
1059 self.tcx.lookup_deprecation(def_id).map(|depr| self.lazy(&depr))
1062 fn encode_rendered_const_for_body(&mut self, body_id: hir::BodyId) -> Lazy<RenderedConst> {
1063 let body = self.tcx.hir().body(body_id);
1064 let rendered = hir::print::to_string(self.tcx.hir(), |s| s.print_expr(&body.value));
1065 let rendered_const = &RenderedConst(rendered);
1066 self.lazy(rendered_const)
1069 fn encode_info_for_item(&mut self, (def_id, item): (DefId, &'tcx hir::Item)) -> Entry<'tcx> {
1072 debug!("EncodeContext::encode_info_for_item({:?})", def_id);
1074 let kind = match item.node {
1075 hir::ItemKind::Static(_, hir::MutMutable, _) => EntryKind::MutStatic,
1076 hir::ItemKind::Static(_, hir::MutImmutable, _) => EntryKind::ImmStatic,
1077 hir::ItemKind::Const(_, body_id) => {
1078 let mir = tcx.at(item.span).mir_const_qualif(def_id).0;
1080 self.const_qualif(mir, body_id),
1081 self.encode_rendered_const_for_body(body_id)
1084 hir::ItemKind::Fn(_, header, .., body) => {
1086 constness: header.constness,
1087 arg_names: self.encode_fn_arg_names_for_body(body),
1088 sig: self.lazy(&tcx.fn_sig(def_id)),
1091 EntryKind::Fn(self.lazy(&data))
1093 hir::ItemKind::Mod(ref m) => {
1094 return self.encode_info_for_mod((item.hir_id, m, &item.attrs, &item.vis));
1096 hir::ItemKind::ForeignMod(_) => EntryKind::ForeignMod,
1097 hir::ItemKind::GlobalAsm(..) => EntryKind::GlobalAsm,
1098 hir::ItemKind::Ty(..) => EntryKind::Type,
1099 hir::ItemKind::Existential(..) => EntryKind::Existential,
1100 hir::ItemKind::Enum(..) => EntryKind::Enum(get_repr_options(tcx, def_id)),
1101 hir::ItemKind::Struct(ref struct_def, _) => {
1102 let variant = tcx.adt_def(def_id).non_enum_variant();
1104 // Encode def_ids for each field and method
1105 // for methods, write all the stuff get_trait_method
1107 let ctor = struct_def.ctor_hir_id()
1108 .map(|ctor_hir_id| tcx.hir().local_def_id_from_hir_id(ctor_hir_id).index);
1110 let repr_options = get_repr_options(tcx, def_id);
1112 EntryKind::Struct(self.lazy(&VariantData {
1113 ctor_kind: variant.ctor_kind,
1114 discr: variant.discr,
1119 hir::ItemKind::Union(..) => {
1120 let variant = tcx.adt_def(def_id).non_enum_variant();
1121 let repr_options = get_repr_options(tcx, def_id);
1123 EntryKind::Union(self.lazy(&VariantData {
1124 ctor_kind: variant.ctor_kind,
1125 discr: variant.discr,
1130 hir::ItemKind::Impl(_, polarity, defaultness, ..) => {
1131 let trait_ref = tcx.impl_trait_ref(def_id);
1132 let parent = if let Some(trait_ref) = trait_ref {
1133 let trait_def = tcx.trait_def(trait_ref.def_id);
1134 trait_def.ancestors(tcx, def_id).nth(1).and_then(|node| {
1136 specialization_graph::Node::Impl(parent) => Some(parent),
1144 // if this is an impl of `CoerceUnsized`, create its
1145 // "unsized info", else just store None
1146 let coerce_unsized_info =
1147 trait_ref.and_then(|t| {
1148 if Some(t.def_id) == tcx.lang_items().coerce_unsized_trait() {
1149 Some(tcx.at(item.span).coerce_unsized_info(def_id))
1155 let data = ImplData {
1158 parent_impl: parent,
1159 coerce_unsized_info,
1160 trait_ref: trait_ref.map(|trait_ref| self.lazy(&trait_ref)),
1163 EntryKind::Impl(self.lazy(&data))
1165 hir::ItemKind::Trait(..) => {
1166 let trait_def = tcx.trait_def(def_id);
1167 let data = TraitData {
1168 unsafety: trait_def.unsafety,
1169 paren_sugar: trait_def.paren_sugar,
1170 has_auto_impl: tcx.trait_is_auto(def_id),
1171 is_marker: trait_def.is_marker,
1172 super_predicates: self.lazy(&tcx.super_predicates_of(def_id)),
1175 EntryKind::Trait(self.lazy(&data))
1177 hir::ItemKind::TraitAlias(..) => {
1178 let data = TraitAliasData {
1179 super_predicates: self.lazy(&tcx.super_predicates_of(def_id)),
1182 EntryKind::TraitAlias(self.lazy(&data))
1184 hir::ItemKind::ExternCrate(_) |
1185 hir::ItemKind::Use(..) => bug!("cannot encode info for item {:?}", item),
1190 visibility: self.lazy(&ty::Visibility::from_hir(&item.vis, item.hir_id, tcx)),
1191 span: self.lazy(&item.span),
1192 attributes: self.encode_attributes(&item.attrs),
1193 children: match item.node {
1194 hir::ItemKind::ForeignMod(ref fm) => {
1195 self.lazy_seq(fm.items
1197 .map(|foreign_item| tcx.hir().local_def_id_from_hir_id(
1198 foreign_item.hir_id).index))
1200 hir::ItemKind::Enum(..) => {
1201 let def = self.tcx.adt_def(def_id);
1202 self.lazy_seq(def.variants.iter().map(|v| {
1203 assert!(v.def_id.is_local());
1207 hir::ItemKind::Struct(..) |
1208 hir::ItemKind::Union(..) => {
1209 let def = self.tcx.adt_def(def_id);
1210 self.lazy_seq(def.non_enum_variant().fields.iter().map(|f| {
1211 assert!(f.did.is_local());
1215 hir::ItemKind::Impl(..) |
1216 hir::ItemKind::Trait(..) => {
1217 self.lazy_seq(tcx.associated_item_def_ids(def_id).iter().map(|&def_id| {
1218 assert!(def_id.is_local());
1222 _ => LazySeq::empty(),
1224 stability: self.encode_stability(def_id),
1225 deprecation: self.encode_deprecation(def_id),
1227 ty: match item.node {
1228 hir::ItemKind::Static(..) |
1229 hir::ItemKind::Const(..) |
1230 hir::ItemKind::Fn(..) |
1231 hir::ItemKind::Ty(..) |
1232 hir::ItemKind::Existential(..) |
1233 hir::ItemKind::Enum(..) |
1234 hir::ItemKind::Struct(..) |
1235 hir::ItemKind::Union(..) |
1236 hir::ItemKind::Impl(..) => Some(self.encode_item_type(def_id)),
1239 inherent_impls: self.encode_inherent_implementations(def_id),
1240 variances: match item.node {
1241 hir::ItemKind::Enum(..) |
1242 hir::ItemKind::Struct(..) |
1243 hir::ItemKind::Union(..) |
1244 hir::ItemKind::Fn(..) => self.encode_variances_of(def_id),
1245 _ => LazySeq::empty(),
1247 generics: match item.node {
1248 hir::ItemKind::Static(..) |
1249 hir::ItemKind::Const(..) |
1250 hir::ItemKind::Fn(..) |
1251 hir::ItemKind::Ty(..) |
1252 hir::ItemKind::Enum(..) |
1253 hir::ItemKind::Struct(..) |
1254 hir::ItemKind::Union(..) |
1255 hir::ItemKind::Impl(..) |
1256 hir::ItemKind::Existential(..) |
1257 hir::ItemKind::Trait(..) => Some(self.encode_generics(def_id)),
1258 hir::ItemKind::TraitAlias(..) => Some(self.encode_generics(def_id)),
1261 predicates: match item.node {
1262 hir::ItemKind::Static(..) |
1263 hir::ItemKind::Const(..) |
1264 hir::ItemKind::Fn(..) |
1265 hir::ItemKind::Ty(..) |
1266 hir::ItemKind::Enum(..) |
1267 hir::ItemKind::Struct(..) |
1268 hir::ItemKind::Union(..) |
1269 hir::ItemKind::Impl(..) |
1270 hir::ItemKind::Existential(..) |
1271 hir::ItemKind::Trait(..) |
1272 hir::ItemKind::TraitAlias(..) => Some(self.encode_predicates(def_id)),
1276 // The only time that `predicates_defined_on` is used (on
1277 // an external item) is for traits, during chalk lowering,
1278 // so only encode it in that case as an efficiency
1279 // hack. (No reason not to expand it in the future if
1281 predicates_defined_on: match item.node {
1282 hir::ItemKind::Trait(..) |
1283 hir::ItemKind::TraitAlias(..) => Some(self.encode_predicates_defined_on(def_id)),
1284 _ => None, // not *wrong* for other kinds of items, but not needed
1287 mir: match item.node {
1288 hir::ItemKind::Static(..) => {
1289 self.encode_optimized_mir(def_id)
1291 hir::ItemKind::Const(..) => self.encode_optimized_mir(def_id),
1292 hir::ItemKind::Fn(_, header, ..) => {
1293 let generics = tcx.generics_of(def_id);
1295 (generics.requires_monomorphization(tcx) ||
1296 tcx.codegen_fn_attrs(def_id).requests_inline()) &&
1297 !self.metadata_output_only();
1298 let always_encode_mir = self.tcx.sess.opts.debugging_opts.always_encode_mir;
1300 || header.constness == hir::Constness::Const
1301 || always_encode_mir
1303 self.encode_optimized_mir(def_id)
1313 /// Serialize the text of exported macros
1314 fn encode_info_for_macro_def(&mut self, macro_def: &hir::MacroDef) -> Entry<'tcx> {
1315 use syntax::print::pprust;
1316 let def_id = self.tcx.hir().local_def_id_from_hir_id(macro_def.hir_id);
1318 kind: EntryKind::MacroDef(self.lazy(&MacroDef {
1319 body: pprust::tts_to_string(¯o_def.body.trees().collect::<Vec<_>>()),
1320 legacy: macro_def.legacy,
1322 visibility: self.lazy(&ty::Visibility::Public),
1323 span: self.lazy(¯o_def.span),
1324 attributes: self.encode_attributes(¯o_def.attrs),
1325 stability: self.encode_stability(def_id),
1326 deprecation: self.encode_deprecation(def_id),
1328 children: LazySeq::empty(),
1330 inherent_impls: LazySeq::empty(),
1331 variances: LazySeq::empty(),
1334 predicates_defined_on: None,
1339 fn encode_info_for_generic_param(
1342 entry_kind: EntryKind<'tcx>,
1348 visibility: self.lazy(&ty::Visibility::Public),
1349 span: self.lazy(&tcx.def_span(def_id)),
1350 attributes: LazySeq::empty(),
1351 children: LazySeq::empty(),
1354 ty: if encode_type { Some(self.encode_item_type(def_id)) } else { None },
1355 inherent_impls: LazySeq::empty(),
1356 variances: LazySeq::empty(),
1359 predicates_defined_on: None,
1365 fn encode_info_for_ty_param(
1367 (def_id, encode_type): (DefId, bool),
1369 debug!("EncodeContext::encode_info_for_ty_param({:?})", def_id);
1370 self.encode_info_for_generic_param(def_id, EntryKind::TypeParam, encode_type)
1373 fn encode_info_for_const_param(
1377 debug!("EncodeContext::encode_info_for_const_param({:?})", def_id);
1378 self.encode_info_for_generic_param(def_id, EntryKind::ConstParam, true)
1381 fn encode_info_for_closure(&mut self, def_id: DefId) -> Entry<'tcx> {
1382 debug!("EncodeContext::encode_info_for_closure({:?})", def_id);
1385 let tables = self.tcx.typeck_tables_of(def_id);
1386 let hir_id = self.tcx.hir().as_local_hir_id(def_id).unwrap();
1387 let kind = match tables.node_type(hir_id).sty {
1388 ty::Generator(def_id, ..) => {
1389 let layout = self.tcx.generator_layout(def_id);
1390 let data = GeneratorData {
1391 layout: layout.clone(),
1393 EntryKind::Generator(self.lazy(&data))
1396 ty::Closure(def_id, substs) => {
1397 let sig = substs.closure_sig(def_id, self.tcx);
1398 let data = ClosureData { sig: self.lazy(&sig) };
1399 EntryKind::Closure(self.lazy(&data))
1402 _ => bug!("closure that is neither generator nor closure")
1407 visibility: self.lazy(&ty::Visibility::Public),
1408 span: self.lazy(&tcx.def_span(def_id)),
1409 attributes: self.encode_attributes(&tcx.get_attrs(def_id)),
1410 children: LazySeq::empty(),
1414 ty: Some(self.encode_item_type(def_id)),
1415 inherent_impls: LazySeq::empty(),
1416 variances: LazySeq::empty(),
1417 generics: Some(self.encode_generics(def_id)),
1419 predicates_defined_on: None,
1421 mir: self.encode_optimized_mir(def_id),
1425 fn encode_info_for_anon_const(&mut self, def_id: DefId) -> Entry<'tcx> {
1426 debug!("EncodeContext::encode_info_for_anon_const({:?})", def_id);
1428 let id = tcx.hir().as_local_hir_id(def_id).unwrap();
1429 let body_id = tcx.hir().body_owned_by(id);
1430 let const_data = self.encode_rendered_const_for_body(body_id);
1431 let mir = tcx.mir_const_qualif(def_id).0;
1434 kind: EntryKind::Const(self.const_qualif(mir, body_id), const_data),
1435 visibility: self.lazy(&ty::Visibility::Public),
1436 span: self.lazy(&tcx.def_span(def_id)),
1437 attributes: LazySeq::empty(),
1438 children: LazySeq::empty(),
1442 ty: Some(self.encode_item_type(def_id)),
1443 inherent_impls: LazySeq::empty(),
1444 variances: LazySeq::empty(),
1445 generics: Some(self.encode_generics(def_id)),
1446 predicates: Some(self.encode_predicates(def_id)),
1447 predicates_defined_on: None,
1449 mir: self.encode_optimized_mir(def_id),
1453 fn encode_attributes(&mut self, attrs: &[ast::Attribute]) -> LazySeq<ast::Attribute> {
1454 self.lazy_seq_ref(attrs)
1457 fn encode_native_libraries(&mut self) -> LazySeq<NativeLibrary> {
1458 let used_libraries = self.tcx.native_libraries(LOCAL_CRATE);
1459 self.lazy_seq(used_libraries.iter().cloned())
1462 fn encode_foreign_modules(&mut self) -> LazySeq<ForeignModule> {
1463 let foreign_modules = self.tcx.foreign_modules(LOCAL_CRATE);
1464 self.lazy_seq(foreign_modules.iter().cloned())
1467 fn encode_crate_deps(&mut self) -> LazySeq<CrateDep> {
1468 let crates = self.tcx.crates();
1470 let mut deps = crates
1473 let dep = CrateDep {
1474 name: self.tcx.original_crate_name(cnum),
1475 hash: self.tcx.crate_hash(cnum),
1476 kind: self.tcx.dep_kind(cnum),
1477 extra_filename: self.tcx.extra_filename(cnum),
1481 .collect::<Vec<_>>();
1483 deps.sort_by_key(|&(cnum, _)| cnum);
1486 // Sanity-check the crate numbers
1487 let mut expected_cnum = 1;
1488 for &(n, _) in &deps {
1489 assert_eq!(n, CrateNum::new(expected_cnum));
1494 // We're just going to write a list of crate 'name-hash-version's, with
1495 // the assumption that they are numbered 1 to n.
1496 // FIXME (#2166): This is not nearly enough to support correct versioning
1497 // but is enough to get transitive crate dependencies working.
1498 self.lazy_seq_ref(deps.iter().map(|&(_, ref dep)| dep))
1501 fn encode_lib_features(&mut self) -> LazySeq<(ast::Name, Option<ast::Name>)> {
1503 let lib_features = tcx.lib_features();
1504 self.lazy_seq(lib_features.to_vec())
1507 fn encode_lang_items(&mut self) -> LazySeq<(DefIndex, usize)> {
1509 let lang_items = tcx.lang_items();
1510 let lang_items = lang_items.items().iter();
1511 self.lazy_seq(lang_items.enumerate().filter_map(|(i, &opt_def_id)| {
1512 if let Some(def_id) = opt_def_id {
1513 if def_id.is_local() {
1514 return Some((def_id.index, i));
1521 fn encode_lang_items_missing(&mut self) -> LazySeq<lang_items::LangItem> {
1523 self.lazy_seq_ref(&tcx.lang_items().missing)
1526 /// Encodes an index, mapping each trait to its (local) implementations.
1527 fn encode_impls(&mut self) -> LazySeq<TraitImpls> {
1528 debug!("EncodeContext::encode_impls()");
1530 let mut visitor = ImplVisitor {
1532 impls: FxHashMap::default(),
1534 tcx.hir().krate().visit_all_item_likes(&mut visitor);
1536 let mut all_impls: Vec<_> = visitor.impls.into_iter().collect();
1538 // Bring everything into deterministic order for hashing
1539 all_impls.sort_by_cached_key(|&(trait_def_id, _)| {
1540 tcx.def_path_hash(trait_def_id)
1543 let all_impls: Vec<_> = all_impls
1545 .map(|(trait_def_id, mut impls)| {
1546 // Bring everything into deterministic order for hashing
1547 impls.sort_by_cached_key(|&def_index| {
1548 tcx.hir().definitions().def_path_hash(def_index)
1552 trait_id: (trait_def_id.krate.as_u32(), trait_def_id.index),
1553 impls: self.lazy_seq_ref(&impls),
1558 self.lazy_seq_ref(&all_impls)
1561 // Encodes all symbols exported from this crate into the metadata.
1563 // This pass is seeded off the reachability list calculated in the
1564 // middle::reachable module but filters out items that either don't have a
1565 // symbol associated with them (they weren't translated) or if they're an FFI
1566 // definition (as that's not defined in this crate).
1567 fn encode_exported_symbols(&mut self,
1568 exported_symbols: &[(ExportedSymbol<'tcx>, SymbolExportLevel)])
1569 -> LazySeq<(ExportedSymbol<'tcx>, SymbolExportLevel)> {
1570 // The metadata symbol name is special. It should not show up in
1571 // downstream crates.
1572 let metadata_symbol_name = SymbolName::new(&metadata_symbol_name(self.tcx));
1574 self.lazy_seq(exported_symbols
1576 .filter(|&&(ref exported_symbol, _)| {
1577 match *exported_symbol {
1578 ExportedSymbol::NoDefId(symbol_name) => {
1579 symbol_name != metadata_symbol_name
1587 fn encode_dylib_dependency_formats(&mut self) -> LazySeq<Option<LinkagePreference>> {
1588 match self.tcx.sess.dependency_formats.borrow().get(&config::CrateType::Dylib) {
1590 self.lazy_seq(arr.iter().map(|slot| {
1592 Linkage::NotLinked |
1593 Linkage::IncludedFromDylib => None,
1595 Linkage::Dynamic => Some(LinkagePreference::RequireDynamic),
1596 Linkage::Static => Some(LinkagePreference::RequireStatic),
1600 None => LazySeq::empty(),
1604 fn encode_info_for_foreign_item(&mut self,
1605 (def_id, nitem): (DefId, &hir::ForeignItem))
1609 debug!("EncodeContext::encode_info_for_foreign_item({:?})", def_id);
1611 let kind = match nitem.node {
1612 hir::ForeignItemKind::Fn(_, ref names, _) => {
1614 constness: hir::Constness::NotConst,
1615 arg_names: self.encode_fn_arg_names(names),
1616 sig: self.lazy(&tcx.fn_sig(def_id)),
1618 EntryKind::ForeignFn(self.lazy(&data))
1620 hir::ForeignItemKind::Static(_, hir::MutMutable) => EntryKind::ForeignMutStatic,
1621 hir::ForeignItemKind::Static(_, hir::MutImmutable) => EntryKind::ForeignImmStatic,
1622 hir::ForeignItemKind::Type => EntryKind::ForeignType,
1627 visibility: self.lazy(&ty::Visibility::from_hir(&nitem.vis, nitem.hir_id, tcx)),
1628 span: self.lazy(&nitem.span),
1629 attributes: self.encode_attributes(&nitem.attrs),
1630 children: LazySeq::empty(),
1631 stability: self.encode_stability(def_id),
1632 deprecation: self.encode_deprecation(def_id),
1634 ty: Some(self.encode_item_type(def_id)),
1635 inherent_impls: LazySeq::empty(),
1636 variances: match nitem.node {
1637 hir::ForeignItemKind::Fn(..) => self.encode_variances_of(def_id),
1638 _ => LazySeq::empty(),
1640 generics: Some(self.encode_generics(def_id)),
1641 predicates: Some(self.encode_predicates(def_id)),
1642 predicates_defined_on: None,
1649 impl Visitor<'tcx> for EncodeContext<'tcx> {
1650 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1651 NestedVisitorMap::OnlyBodies(&self.tcx.hir())
1653 fn visit_expr(&mut self, ex: &'tcx hir::Expr) {
1654 intravisit::walk_expr(self, ex);
1655 self.encode_info_for_expr(ex);
1657 fn visit_item(&mut self, item: &'tcx hir::Item) {
1658 intravisit::walk_item(self, item);
1659 let def_id = self.tcx.hir().local_def_id_from_hir_id(item.hir_id);
1661 hir::ItemKind::ExternCrate(_) |
1662 hir::ItemKind::Use(..) => {} // ignore these
1663 _ => self.record(def_id, EncodeContext::encode_info_for_item, (def_id, item)),
1665 self.encode_addl_info_for_item(item);
1667 fn visit_foreign_item(&mut self, ni: &'tcx hir::ForeignItem) {
1668 intravisit::walk_foreign_item(self, ni);
1669 let def_id = self.tcx.hir().local_def_id_from_hir_id(ni.hir_id);
1671 EncodeContext::encode_info_for_foreign_item,
1674 fn visit_variant(&mut self,
1675 v: &'tcx hir::Variant,
1676 g: &'tcx hir::Generics,
1678 intravisit::walk_variant(self, v, g, id);
1680 if let Some(ref discr) = v.node.disr_expr {
1681 let def_id = self.tcx.hir().local_def_id_from_hir_id(discr.hir_id);
1682 self.record(def_id, EncodeContext::encode_info_for_anon_const, def_id);
1685 fn visit_generics(&mut self, generics: &'tcx hir::Generics) {
1686 intravisit::walk_generics(self, generics);
1687 self.encode_info_for_generics(generics);
1689 fn visit_ty(&mut self, ty: &'tcx hir::Ty) {
1690 intravisit::walk_ty(self, ty);
1691 self.encode_info_for_ty(ty);
1693 fn visit_macro_def(&mut self, macro_def: &'tcx hir::MacroDef) {
1694 let def_id = self.tcx.hir().local_def_id_from_hir_id(macro_def.hir_id);
1695 self.record(def_id, EncodeContext::encode_info_for_macro_def, macro_def);
1699 impl EncodeContext<'tcx> {
1700 fn encode_fields(&mut self, adt_def_id: DefId) {
1701 let def = self.tcx.adt_def(adt_def_id);
1702 for (variant_index, variant) in def.variants.iter_enumerated() {
1703 for (field_index, field) in variant.fields.iter().enumerate() {
1704 self.record(field.did,
1705 EncodeContext::encode_field,
1706 (adt_def_id, variant_index, field_index));
1711 fn encode_info_for_generics(&mut self, generics: &hir::Generics) {
1712 for param in &generics.params {
1713 let def_id = self.tcx.hir().local_def_id_from_hir_id(param.hir_id);
1715 GenericParamKind::Lifetime { .. } => continue,
1716 GenericParamKind::Type { ref default, .. } => {
1719 EncodeContext::encode_info_for_ty_param,
1720 (def_id, default.is_some()),
1723 GenericParamKind::Const { .. } => {
1724 self.record(def_id, EncodeContext::encode_info_for_const_param, def_id);
1730 fn encode_info_for_ty(&mut self, ty: &hir::Ty) {
1732 hir::TyKind::Array(_, ref length) => {
1733 let def_id = self.tcx.hir().local_def_id_from_hir_id(length.hir_id);
1734 self.record(def_id, EncodeContext::encode_info_for_anon_const, def_id);
1740 fn encode_info_for_expr(&mut self, expr: &hir::Expr) {
1742 hir::ExprKind::Closure(..) => {
1743 let def_id = self.tcx.hir().local_def_id_from_hir_id(expr.hir_id);
1744 self.record(def_id, EncodeContext::encode_info_for_closure, def_id);
1750 /// In some cases, along with the item itself, we also
1751 /// encode some sub-items. Usually we want some info from the item
1752 /// so it's easier to do that here then to wait until we would encounter
1753 /// normally in the visitor walk.
1754 fn encode_addl_info_for_item(&mut self, item: &hir::Item) {
1755 let def_id = self.tcx.hir().local_def_id_from_hir_id(item.hir_id);
1757 hir::ItemKind::Static(..) |
1758 hir::ItemKind::Const(..) |
1759 hir::ItemKind::Fn(..) |
1760 hir::ItemKind::Mod(..) |
1761 hir::ItemKind::ForeignMod(..) |
1762 hir::ItemKind::GlobalAsm(..) |
1763 hir::ItemKind::ExternCrate(..) |
1764 hir::ItemKind::Use(..) |
1765 hir::ItemKind::Ty(..) |
1766 hir::ItemKind::Existential(..) |
1767 hir::ItemKind::TraitAlias(..) => {
1768 // no sub-item recording needed in these cases
1770 hir::ItemKind::Enum(..) => {
1771 self.encode_fields(def_id);
1773 let def = self.tcx.adt_def(def_id);
1774 for (i, variant) in def.variants.iter_enumerated() {
1775 self.record(variant.def_id,
1776 EncodeContext::encode_enum_variant_info,
1779 if let Some(ctor_def_id) = variant.ctor_def_id {
1780 self.record(ctor_def_id,
1781 EncodeContext::encode_enum_variant_ctor,
1786 hir::ItemKind::Struct(ref struct_def, _) => {
1787 self.encode_fields(def_id);
1789 // If the struct has a constructor, encode it.
1790 if let Some(ctor_hir_id) = struct_def.ctor_hir_id() {
1791 let ctor_def_id = self.tcx.hir().local_def_id_from_hir_id(ctor_hir_id);
1792 self.record(ctor_def_id,
1793 EncodeContext::encode_struct_ctor,
1794 (def_id, ctor_def_id));
1797 hir::ItemKind::Union(..) => {
1798 self.encode_fields(def_id);
1800 hir::ItemKind::Impl(..) => {
1801 for &trait_item_def_id in self.tcx.associated_item_def_ids(def_id).iter() {
1802 self.record(trait_item_def_id,
1803 EncodeContext::encode_info_for_impl_item,
1807 hir::ItemKind::Trait(..) => {
1808 for &item_def_id in self.tcx.associated_item_def_ids(def_id).iter() {
1809 self.record(item_def_id,
1810 EncodeContext::encode_info_for_trait_item,
1818 struct ImplVisitor<'tcx> {
1819 tcx: TyCtxt<'tcx, 'tcx>,
1820 impls: FxHashMap<DefId, Vec<DefIndex>>,
1823 impl<'tcx, 'v> ItemLikeVisitor<'v> for ImplVisitor<'tcx> {
1824 fn visit_item(&mut self, item: &hir::Item) {
1825 if let hir::ItemKind::Impl(..) = item.node {
1826 let impl_id = self.tcx.hir().local_def_id_from_hir_id(item.hir_id);
1827 if let Some(trait_ref) = self.tcx.impl_trait_ref(impl_id) {
1829 .entry(trait_ref.def_id)
1831 .push(impl_id.index);
1836 fn visit_trait_item(&mut self, _trait_item: &'v hir::TraitItem) {}
1838 fn visit_impl_item(&mut self, _impl_item: &'v hir::ImplItem) {
1839 // handled in `visit_item` above
1843 // NOTE(eddyb) The following comment was preserved for posterity, even
1844 // though it's no longer relevant as EBML (which uses nested & tagged
1845 // "documents") was replaced with a scheme that can't go out of bounds.
1847 // And here we run into yet another obscure archive bug: in which metadata
1848 // loaded from archives may have trailing garbage bytes. Awhile back one of
1849 // our tests was failing sporadically on the macOS 64-bit builders (both nopt
1850 // and opt) by having ebml generate an out-of-bounds panic when looking at
1853 // Upon investigation it turned out that the metadata file inside of an rlib
1854 // (and ar archive) was being corrupted. Some compilations would generate a
1855 // metadata file which would end in a few extra bytes, while other
1856 // compilations would not have these extra bytes appended to the end. These
1857 // extra bytes were interpreted by ebml as an extra tag, so they ended up
1858 // being interpreted causing the out-of-bounds.
1860 // The root cause of why these extra bytes were appearing was never
1861 // discovered, and in the meantime the solution we're employing is to insert
1862 // the length of the metadata to the start of the metadata. Later on this
1863 // will allow us to slice the metadata to the precise length that we just
1864 // generated regardless of trailing bytes that end up in it.
1866 pub fn encode_metadata<'tcx>(tcx: TyCtxt<'tcx, 'tcx>) -> EncodedMetadata {
1867 let mut encoder = opaque::Encoder::new(vec![]);
1868 encoder.emit_raw_bytes(METADATA_HEADER);
1870 // Will be filled with the root position after encoding everything.
1871 encoder.emit_raw_bytes(&[0, 0, 0, 0]);
1873 // Since encoding metadata is not in a query, and nothing is cached,
1874 // there's no need to do dep-graph tracking for any of it.
1875 let (root, mut result) = tcx.dep_graph.with_ignore(move || {
1876 let mut ecx = EncodeContext {
1879 entries_index: Index::new(tcx.hir().definitions().def_index_count()),
1880 lazy_state: LazyState::NoNode,
1881 type_shorthands: Default::default(),
1882 predicate_shorthands: Default::default(),
1883 source_file_cache: tcx.sess.source_map().files()[0].clone(),
1884 interpret_allocs: Default::default(),
1885 interpret_allocs_inverse: Default::default(),
1888 // Encode the rustc version string in a predictable location.
1889 rustc_version().encode(&mut ecx).unwrap();
1891 // Encode all the entries and extra information in the crate,
1892 // culminating in the `CrateRoot` which points to all of it.
1893 let root = ecx.encode_crate_root();
1894 (root, ecx.opaque.into_inner())
1897 // Encode the root position.
1898 let header = METADATA_HEADER.len();
1899 let pos = root.position;
1900 result[header + 0] = (pos >> 24) as u8;
1901 result[header + 1] = (pos >> 16) as u8;
1902 result[header + 2] = (pos >> 8) as u8;
1903 result[header + 3] = (pos >> 0) as u8;
1905 EncodedMetadata { raw_data: result }
1908 pub fn get_repr_options<'tcx, 'gcx>(tcx: TyCtxt<'tcx, 'gcx>, did: DefId) -> ReprOptions {
1909 let ty = tcx.type_of(did);
1911 ty::Adt(ref def, _) => return def.repr,
1912 _ => bug!("{} is not an ADT", ty),