1 use crate::dep_graph::{DepNodeIndex, SerializedDepNodeIndex};
3 use crate::hir::def_id::{CrateNum, DefIndex, DefId, LocalDefId, LOCAL_CRATE};
4 use crate::hir::map::definitions::DefPathHash;
5 use crate::ich::{CachingSourceMapView, Fingerprint};
6 use crate::mir::{self, interpret};
7 use crate::mir::interpret::{AllocDecodingSession, AllocDecodingState};
8 use crate::rustc_serialize::{Decodable, Decoder, Encodable, Encoder, opaque,
9 SpecializedDecoder, SpecializedEncoder,
10 UseSpecializedDecodable, UseSpecializedEncodable};
11 use crate::session::{CrateDisambiguator, Session};
12 use crate::ty::{self, Ty};
13 use crate::ty::codec::{self as ty_codec, TyDecoder, TyEncoder};
14 use crate::ty::context::TyCtxt;
15 use crate::util::common::{time, time_ext};
17 use errors::Diagnostic;
18 use rustc_data_structures::fx::FxHashMap;
19 use rustc_data_structures::thin_vec::ThinVec;
20 use rustc_data_structures::sync::{Lrc, Lock, HashMapExt, Once};
21 use rustc_data_structures::indexed_vec::{IndexVec, Idx};
23 use syntax::ast::NodeId;
24 use syntax::source_map::{SourceMap, StableSourceFileId};
25 use syntax_pos::{BytePos, Span, DUMMY_SP, SourceFile};
26 use syntax_pos::hygiene::{Mark, SyntaxContext, ExpnInfo};
28 const TAG_FILE_FOOTER: u128 = 0xC0FFEE_C0FFEE_C0FFEE_C0FFEE_C0FFEE;
30 const TAG_CLEAR_CROSS_CRATE_CLEAR: u8 = 0;
31 const TAG_CLEAR_CROSS_CRATE_SET: u8 = 1;
33 const TAG_NO_EXPANSION_INFO: u8 = 0;
34 const TAG_EXPANSION_INFO_SHORTHAND: u8 = 1;
35 const TAG_EXPANSION_INFO_INLINE: u8 = 2;
37 const TAG_VALID_SPAN: u8 = 0;
38 const TAG_INVALID_SPAN: u8 = 1;
40 /// `OnDiskCache` provides an interface to incr. comp. data cached from the
41 /// previous compilation session. This data will eventually include the results
42 /// of a few selected queries (like `typeck_tables_of` and `mir_optimized`) and
43 /// any diagnostics that have been emitted during a query.
44 pub struct OnDiskCache<'sess> {
46 // The complete cache data in serialized form.
47 serialized_data: Vec<u8>,
49 // This field collects all Diagnostics emitted during the current
50 // compilation session.
51 current_diagnostics: Lock<FxHashMap<DepNodeIndex, Vec<Diagnostic>>>,
53 prev_cnums: Vec<(u32, String, CrateDisambiguator)>,
54 cnum_map: Once<IndexVec<CrateNum, Option<CrateNum>>>,
56 source_map: &'sess SourceMap,
57 file_index_to_stable_id: FxHashMap<SourceFileIndex, StableSourceFileId>,
59 // These two fields caches that are populated lazily during decoding.
60 file_index_to_file: Lock<FxHashMap<SourceFileIndex, Lrc<SourceFile>>>,
61 synthetic_expansion_infos: Lock<FxHashMap<AbsoluteBytePos, SyntaxContext>>,
63 // A map from dep-node to the position of the cached query result in
65 query_result_index: FxHashMap<SerializedDepNodeIndex, AbsoluteBytePos>,
67 // A map from dep-node to the position of any associated diagnostics in
69 prev_diagnostics_index: FxHashMap<SerializedDepNodeIndex, AbsoluteBytePos>,
71 alloc_decoding_state: AllocDecodingState,
74 // This type is used only for (de-)serialization.
75 #[derive(RustcEncodable, RustcDecodable)]
77 file_index_to_stable_id: FxHashMap<SourceFileIndex, StableSourceFileId>,
78 prev_cnums: Vec<(u32, String, CrateDisambiguator)>,
79 query_result_index: EncodedQueryResultIndex,
80 diagnostics_index: EncodedQueryResultIndex,
81 // the location of all allocations
82 interpret_alloc_index: Vec<u32>,
85 type EncodedQueryResultIndex = Vec<(SerializedDepNodeIndex, AbsoluteBytePos)>;
86 type EncodedDiagnosticsIndex = Vec<(SerializedDepNodeIndex, AbsoluteBytePos)>;
87 type EncodedDiagnostics = Vec<Diagnostic>;
89 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
90 struct SourceFileIndex(u32);
92 #[derive(Copy, Clone, Debug, Hash, Eq, PartialEq, RustcEncodable, RustcDecodable)]
93 struct AbsoluteBytePos(u32);
95 impl AbsoluteBytePos {
96 fn new(pos: usize) -> AbsoluteBytePos {
97 debug_assert!(pos <= ::std::u32::MAX as usize);
98 AbsoluteBytePos(pos as u32)
101 fn to_usize(self) -> usize {
106 impl<'sess> OnDiskCache<'sess> {
107 /// Creates a new OnDiskCache instance from the serialized data in `data`.
108 pub fn new(sess: &'sess Session, data: Vec<u8>, start_pos: usize) -> OnDiskCache<'sess> {
109 debug_assert!(sess.opts.incremental.is_some());
111 // Wrapping in a scope so we can borrow `data`
112 let footer: Footer = {
113 let mut decoder = opaque::Decoder::new(&data[..], start_pos);
115 // Decode the *position* of the footer which can be found in the
116 // last 8 bytes of the file.
117 decoder.set_position(data.len() - IntEncodedWithFixedSize::ENCODED_SIZE);
118 let query_result_index_pos = IntEncodedWithFixedSize::decode(&mut decoder)
119 .expect("Error while trying to decode query result index position.")
122 // Decoder the file footer which contains all the lookup tables, etc.
123 decoder.set_position(query_result_index_pos);
124 decode_tagged(&mut decoder, TAG_FILE_FOOTER)
125 .expect("Error while trying to decode query result index position.")
129 serialized_data: data,
130 file_index_to_stable_id: footer.file_index_to_stable_id,
131 file_index_to_file: Default::default(),
132 prev_cnums: footer.prev_cnums,
133 cnum_map: Once::new(),
134 source_map: sess.source_map(),
135 current_diagnostics: Default::default(),
136 query_result_index: footer.query_result_index.into_iter().collect(),
137 prev_diagnostics_index: footer.diagnostics_index.into_iter().collect(),
138 synthetic_expansion_infos: Default::default(),
139 alloc_decoding_state: AllocDecodingState::new(footer.interpret_alloc_index),
143 pub fn new_empty(source_map: &'sess SourceMap) -> OnDiskCache<'sess> {
145 serialized_data: Vec::new(),
146 file_index_to_stable_id: Default::default(),
147 file_index_to_file: Default::default(),
149 cnum_map: Once::new(),
151 current_diagnostics: Default::default(),
152 query_result_index: Default::default(),
153 prev_diagnostics_index: Default::default(),
154 synthetic_expansion_infos: Default::default(),
155 alloc_decoding_state: AllocDecodingState::new(Vec::new()),
159 pub fn serialize<'tcx, E>(&self, tcx: TyCtxt<'tcx>, encoder: &mut E) -> Result<(), E::Error>
161 E: ty_codec::TyEncoder,
163 // Serializing the DepGraph should not modify it:
164 tcx.dep_graph.with_ignore(|| {
165 // Allocate SourceFileIndices
166 let (file_to_file_index, file_index_to_stable_id) = {
167 let files = tcx.sess.source_map().files();
168 let mut file_to_file_index = FxHashMap::with_capacity_and_hasher(
169 files.len(), Default::default());
170 let mut file_index_to_stable_id = FxHashMap::with_capacity_and_hasher(
171 files.len(), Default::default());
173 for (index, file) in files.iter().enumerate() {
174 let index = SourceFileIndex(index as u32);
175 let file_ptr: *const SourceFile = &**file as *const _;
176 file_to_file_index.insert(file_ptr, index);
177 file_index_to_stable_id.insert(index, StableSourceFileId::new(&file));
180 (file_to_file_index, file_index_to_stable_id)
183 let mut encoder = CacheEncoder {
186 type_shorthands: Default::default(),
187 predicate_shorthands: Default::default(),
188 expn_info_shorthands: Default::default(),
189 interpret_allocs: Default::default(),
190 interpret_allocs_inverse: Vec::new(),
191 source_map: CachingSourceMapView::new(tcx.sess.source_map()),
195 // Load everything into memory so we can write it out to the on-disk
196 // cache. The vast majority of cacheable query results should already
197 // be in memory, so this should be a cheap operation.
198 tcx.dep_graph.exec_cache_promotions(tcx);
200 // Encode query results
201 let mut query_result_index = EncodedQueryResultIndex::new();
203 time(tcx.sess, "encode query results", || {
204 use crate::ty::query::queries::*;
205 let enc = &mut encoder;
206 let qri = &mut query_result_index;
208 encode_query_results::<type_of<'_>, _>(tcx, enc, qri)?;
209 encode_query_results::<generics_of<'_>, _>(tcx, enc, qri)?;
210 encode_query_results::<predicates_of<'_>, _>(tcx, enc, qri)?;
211 encode_query_results::<used_trait_imports<'_>, _>(tcx, enc, qri)?;
212 encode_query_results::<typeck_tables_of<'_>, _>(tcx, enc, qri)?;
213 encode_query_results::<codegen_fulfill_obligation<'_>, _>(tcx, enc, qri)?;
214 encode_query_results::<optimized_mir<'_>, _>(tcx, enc, qri)?;
215 encode_query_results::<unsafety_check_result<'_>, _>(tcx, enc, qri)?;
216 encode_query_results::<borrowck<'_>, _>(tcx, enc, qri)?;
217 encode_query_results::<mir_borrowck<'_>, _>(tcx, enc, qri)?;
218 encode_query_results::<mir_const_qualif<'_>, _>(tcx, enc, qri)?;
219 encode_query_results::<const_is_rvalue_promotable_to_static<'_>, _>(tcx, enc, qri)?;
220 encode_query_results::<symbol_name<'_>, _>(tcx, enc, qri)?;
221 encode_query_results::<check_match<'_>, _>(tcx, enc, qri)?;
222 encode_query_results::<codegen_fn_attrs<'_>, _>(tcx, enc, qri)?;
223 encode_query_results::<specialization_graph_of<'_>, _>(tcx, enc, qri)?;
225 // const eval is special, it only encodes successfully evaluated constants
226 use crate::ty::query::QueryAccessors;
227 let cache = const_eval::query_cache(tcx).borrow();
228 assert!(cache.active.is_empty());
229 for (key, entry) in cache.results.iter() {
230 use crate::ty::query::config::QueryDescription;
231 if const_eval::cache_on_disk(tcx, key.clone()) {
232 if let Ok(ref value) = entry.value {
233 let dep_node = SerializedDepNodeIndex::new(entry.index.index());
235 // Record position of the cache entry
236 qri.push((dep_node, AbsoluteBytePos::new(enc.position())));
238 // Encode the type check tables with the SerializedDepNodeIndex
240 enc.encode_tagged(dep_node, value)?;
248 // Encode diagnostics
249 let diagnostics_index: EncodedDiagnosticsIndex = self.current_diagnostics.borrow()
251 .map(|(dep_node_index, diagnostics)|
253 let pos = AbsoluteBytePos::new(encoder.position());
254 // Let's make sure we get the expected type here:
255 let diagnostics: &EncodedDiagnostics = diagnostics;
256 let dep_node_index = SerializedDepNodeIndex::new(dep_node_index.index());
257 encoder.encode_tagged(dep_node_index, diagnostics)?;
259 Ok((dep_node_index, pos))
261 .collect::<Result<_, _>>()?;
263 let interpret_alloc_index = {
264 let mut interpret_alloc_index = Vec::new();
267 let new_n = encoder.interpret_allocs_inverse.len();
268 // if we have found new ids, serialize those, too
273 interpret_alloc_index.reserve(new_n - n);
274 for idx in n..new_n {
275 let id = encoder.interpret_allocs_inverse[idx];
276 let pos = encoder.position() as u32;
277 interpret_alloc_index.push(pos);
278 interpret::specialized_encode_alloc_id(
286 interpret_alloc_index
289 let sorted_cnums = sorted_cnums_including_local_crate(tcx);
290 let prev_cnums: Vec<_> = sorted_cnums.iter().map(|&cnum| {
291 let crate_name = tcx.original_crate_name(cnum).as_str().to_string();
292 let crate_disambiguator = tcx.crate_disambiguator(cnum);
293 (cnum.as_u32(), crate_name, crate_disambiguator)
296 // Encode the file footer
297 let footer_pos = encoder.position() as u64;
298 encoder.encode_tagged(TAG_FILE_FOOTER, &Footer {
299 file_index_to_stable_id,
303 interpret_alloc_index,
306 // Encode the position of the footer as the last 8 bytes of the
307 // file so we know where to look for it.
308 IntEncodedWithFixedSize(footer_pos).encode(encoder.encoder)?;
310 // DO NOT WRITE ANYTHING TO THE ENCODER AFTER THIS POINT! The address
311 // of the footer must be the last thing in the data stream.
315 fn sorted_cnums_including_local_crate(tcx: TyCtxt<'_>) -> Vec<CrateNum> {
316 let mut cnums = vec![LOCAL_CRATE];
317 cnums.extend_from_slice(&tcx.crates()[..]);
318 cnums.sort_unstable();
319 // Just to be sure...
326 /// Loads a diagnostic emitted during the previous compilation session.
327 pub fn load_diagnostics<'tcx>(
330 dep_node_index: SerializedDepNodeIndex,
331 ) -> Vec<Diagnostic> {
332 let diagnostics: Option<EncodedDiagnostics> = self.load_indexed(
335 &self.prev_diagnostics_index,
338 diagnostics.unwrap_or_default()
341 /// Stores a diagnostic emitted during the current compilation session.
342 /// Anything stored like this will be available via `load_diagnostics` in
343 /// the next compilation session.
346 pub fn store_diagnostics(&self,
347 dep_node_index: DepNodeIndex,
348 diagnostics: ThinVec<Diagnostic>) {
349 let mut current_diagnostics = self.current_diagnostics.borrow_mut();
350 let prev = current_diagnostics.insert(dep_node_index, diagnostics.into());
351 debug_assert!(prev.is_none());
354 /// Returns the cached query result if there is something in the cache for
355 /// the given `SerializedDepNodeIndex`; otherwise returns `None`.
356 pub fn try_load_query_result<'tcx, T>(
359 dep_node_index: SerializedDepNodeIndex,
364 self.load_indexed(tcx,
366 &self.query_result_index,
370 /// Stores a diagnostic emitted during computation of an anonymous query.
371 /// Since many anonymous queries can share the same `DepNode`, we aggregate
372 /// them -- as opposed to regular queries where we assume that there is a
373 /// 1:1 relationship between query-key and `DepNode`.
376 pub fn store_diagnostics_for_anon_node(&self,
377 dep_node_index: DepNodeIndex,
378 diagnostics: ThinVec<Diagnostic>) {
379 let mut current_diagnostics = self.current_diagnostics.borrow_mut();
381 let x = current_diagnostics.entry(dep_node_index).or_insert(Vec::new());
383 x.extend(Into::<Vec<_>>::into(diagnostics));
386 fn load_indexed<'tcx, T>(
389 dep_node_index: SerializedDepNodeIndex,
390 index: &FxHashMap<SerializedDepNodeIndex, AbsoluteBytePos>,
391 debug_tag: &'static str,
396 let pos = index.get(&dep_node_index).cloned()?;
398 // Initialize the cnum_map using the value from the thread which finishes the closure first
399 self.cnum_map.init_nonlocking_same(|| {
400 Self::compute_cnum_map(tcx, &self.prev_cnums[..])
403 let mut decoder = CacheDecoder {
405 opaque: opaque::Decoder::new(&self.serialized_data[..], pos.to_usize()),
406 source_map: self.source_map,
407 cnum_map: self.cnum_map.get(),
408 file_index_to_file: &self.file_index_to_file,
409 file_index_to_stable_id: &self.file_index_to_stable_id,
410 synthetic_expansion_infos: &self.synthetic_expansion_infos,
411 alloc_decoding_session: self.alloc_decoding_state.new_decoding_session(),
414 match decode_tagged(&mut decoder, dep_node_index) {
419 bug!("Could not decode cached {}: {}", debug_tag, e)
424 // This function builds mapping from previous-session-CrateNum to
425 // current-session-CrateNum. There might be CrateNums from the previous
426 // Session that don't occur in the current one. For these, the mapping
430 prev_cnums: &[(u32, String, CrateDisambiguator)],
431 ) -> IndexVec<CrateNum, Option<CrateNum>> {
432 tcx.dep_graph.with_ignore(|| {
433 let current_cnums = tcx.all_crate_nums(LOCAL_CRATE).iter().map(|&cnum| {
434 let crate_name = tcx.original_crate_name(cnum)
436 let crate_disambiguator = tcx.crate_disambiguator(cnum);
437 ((crate_name, crate_disambiguator), cnum)
438 }).collect::<FxHashMap<_,_>>();
440 let map_size = prev_cnums.iter()
441 .map(|&(cnum, ..)| cnum)
444 let mut map = IndexVec::from_elem_n(None, map_size as usize);
446 for &(prev_cnum, ref crate_name, crate_disambiguator) in prev_cnums {
447 let key = (crate_name.clone(), crate_disambiguator);
448 map[CrateNum::from_u32(prev_cnum)] = current_cnums.get(&key).cloned();
451 map[LOCAL_CRATE] = Some(LOCAL_CRATE);
457 //- DECODING -------------------------------------------------------------------
459 /// A decoder that can read the incr. comp. cache. It is similar to the one
460 /// we use for crate metadata decoding in that it can rebase spans and
461 /// eventually will also handle things that contain `Ty` instances.
462 struct CacheDecoder<'a, 'tcx> {
464 opaque: opaque::Decoder<'a>,
465 source_map: &'a SourceMap,
466 cnum_map: &'a IndexVec<CrateNum, Option<CrateNum>>,
467 synthetic_expansion_infos: &'a Lock<FxHashMap<AbsoluteBytePos, SyntaxContext>>,
468 file_index_to_file: &'a Lock<FxHashMap<SourceFileIndex, Lrc<SourceFile>>>,
469 file_index_to_stable_id: &'a FxHashMap<SourceFileIndex, StableSourceFileId>,
470 alloc_decoding_session: AllocDecodingSession<'a>,
473 impl<'a, 'tcx> CacheDecoder<'a, 'tcx> {
474 fn file_index_to_file(&self, index: SourceFileIndex) -> Lrc<SourceFile> {
476 ref file_index_to_file,
477 ref file_index_to_stable_id,
482 file_index_to_file.borrow_mut().entry(index).or_insert_with(|| {
483 let stable_id = file_index_to_stable_id[&index];
484 source_map.source_file_by_stable_id(stable_id)
485 .expect("Failed to lookup SourceFile in new context.")
490 trait DecoderWithPosition: Decoder {
491 fn position(&self) -> usize;
494 impl<'a> DecoderWithPosition for opaque::Decoder<'a> {
495 fn position(&self) -> usize {
500 impl<'a, 'tcx> DecoderWithPosition for CacheDecoder<'a, 'tcx> {
501 fn position(&self) -> usize {
502 self.opaque.position()
506 // Decode something that was encoded with encode_tagged() and verify that the
507 // tag matches and the correct amount of bytes was read.
508 fn decode_tagged<D, T, V>(decoder: &mut D, expected_tag: T) -> Result<V, D::Error>
510 T: Decodable + Eq + ::std::fmt::Debug,
512 D: DecoderWithPosition,
514 let start_pos = decoder.position();
516 let actual_tag = T::decode(decoder)?;
517 assert_eq!(actual_tag, expected_tag);
518 let value = V::decode(decoder)?;
519 let end_pos = decoder.position();
521 let expected_len: u64 = Decodable::decode(decoder)?;
522 assert_eq!((end_pos - start_pos) as u64, expected_len);
527 impl<'a, 'tcx> ty_codec::TyDecoder<'tcx> for CacheDecoder<'a, 'tcx> {
529 fn tcx(&self) -> TyCtxt<'tcx> {
534 fn position(&self) -> usize {
535 self.opaque.position()
539 fn peek_byte(&self) -> u8 {
540 self.opaque.data[self.opaque.position()]
543 fn cached_ty_for_shorthand<F>(&mut self,
546 -> Result<Ty<'tcx>, Self::Error>
547 where F: FnOnce(&mut Self) -> Result<Ty<'tcx>, Self::Error>
549 let tcx = self.tcx();
551 let cache_key = ty::CReaderCacheKey {
552 cnum: CrateNum::ReservedForIncrCompCache,
556 if let Some(&ty) = tcx.rcache.borrow().get(&cache_key) {
560 let ty = or_insert_with(self)?;
561 // This may overwrite the entry, but it should overwrite with the same value
562 tcx.rcache.borrow_mut().insert_same(cache_key, ty);
566 fn with_position<F, R>(&mut self, pos: usize, f: F) -> R
567 where F: FnOnce(&mut Self) -> R
569 debug_assert!(pos < self.opaque.data.len());
571 let new_opaque = opaque::Decoder::new(self.opaque.data, pos);
572 let old_opaque = mem::replace(&mut self.opaque, new_opaque);
574 self.opaque = old_opaque;
578 fn map_encoded_cnum_to_current(&self, cnum: CrateNum) -> CrateNum {
579 self.cnum_map[cnum].unwrap_or_else(|| {
580 bug!("Could not find new CrateNum for {:?}", cnum)
585 implement_ty_decoder!(CacheDecoder<'a, 'tcx>);
587 impl<'a, 'tcx> SpecializedDecoder<interpret::AllocId> for CacheDecoder<'a, 'tcx> {
588 fn specialized_decode(&mut self) -> Result<interpret::AllocId, Self::Error> {
589 let alloc_decoding_session = self.alloc_decoding_session;
590 alloc_decoding_session.decode_alloc_id(self)
594 impl<'a, 'tcx> SpecializedDecoder<Span> for CacheDecoder<'a, 'tcx> {
595 fn specialized_decode(&mut self) -> Result<Span, Self::Error> {
596 let tag: u8 = Decodable::decode(self)?;
598 if tag == TAG_INVALID_SPAN {
601 debug_assert_eq!(tag, TAG_VALID_SPAN);
604 let file_lo_index = SourceFileIndex::decode(self)?;
605 let line_lo = usize::decode(self)?;
606 let col_lo = BytePos::decode(self)?;
607 let len = BytePos::decode(self)?;
609 let file_lo = self.file_index_to_file(file_lo_index);
610 let lo = file_lo.lines[line_lo - 1] + col_lo;
613 let expn_info_tag = u8::decode(self)?;
615 let ctxt = match expn_info_tag {
616 TAG_NO_EXPANSION_INFO => {
617 SyntaxContext::empty()
619 TAG_EXPANSION_INFO_INLINE => {
620 let pos = AbsoluteBytePos::new(self.opaque.position());
621 let expn_info: ExpnInfo = Decodable::decode(self)?;
622 let ctxt = SyntaxContext::allocate_directly(expn_info);
623 self.synthetic_expansion_infos.borrow_mut().insert(pos, ctxt);
626 TAG_EXPANSION_INFO_SHORTHAND => {
627 let pos = AbsoluteBytePos::decode(self)?;
628 let cached_ctxt = self.synthetic_expansion_infos
633 if let Some(ctxt) = cached_ctxt {
636 let expn_info = self.with_position(pos.to_usize(), |this| {
637 ExpnInfo::decode(this)
639 let ctxt = SyntaxContext::allocate_directly(expn_info);
640 self.synthetic_expansion_infos.borrow_mut().insert(pos, ctxt);
649 Ok(Span::new(lo, hi, ctxt))
653 // This impl makes sure that we get a runtime error when we try decode a
654 // DefIndex that is not contained in a DefId. Such a case would be problematic
655 // because we would not know how to transform the DefIndex to the current
657 impl<'a, 'tcx> SpecializedDecoder<DefIndex> for CacheDecoder<'a, 'tcx> {
658 fn specialized_decode(&mut self) -> Result<DefIndex, Self::Error> {
659 bug!("Trying to decode DefIndex outside the context of a DefId")
663 // Both the CrateNum and the DefIndex of a DefId can change in between two
664 // compilation sessions. We use the DefPathHash, which is stable across
665 // sessions, to map the old DefId to the new one.
666 impl<'a, 'tcx> SpecializedDecoder<DefId> for CacheDecoder<'a, 'tcx> {
668 fn specialized_decode(&mut self) -> Result<DefId, Self::Error> {
669 // Load the DefPathHash which is was we encoded the DefId as.
670 let def_path_hash = DefPathHash::decode(self)?;
672 // Using the DefPathHash, we can lookup the new DefId
673 Ok(self.tcx().def_path_hash_to_def_id.as_ref().unwrap()[&def_path_hash])
677 impl<'a, 'tcx> SpecializedDecoder<LocalDefId> for CacheDecoder<'a, 'tcx> {
679 fn specialized_decode(&mut self) -> Result<LocalDefId, Self::Error> {
680 Ok(LocalDefId::from_def_id(DefId::decode(self)?))
684 impl<'a, 'tcx> SpecializedDecoder<hir::HirId> for CacheDecoder<'a, 'tcx> {
685 fn specialized_decode(&mut self) -> Result<hir::HirId, Self::Error> {
686 // Load the DefPathHash which is was we encoded the DefIndex as.
687 let def_path_hash = DefPathHash::decode(self)?;
689 // Use the DefPathHash to map to the current DefId.
690 let def_id = self.tcx()
691 .def_path_hash_to_def_id
693 .unwrap()[&def_path_hash];
695 debug_assert!(def_id.is_local());
697 // The ItemLocalId needs no remapping.
698 let local_id = hir::ItemLocalId::decode(self)?;
700 // Reconstruct the HirId and look up the corresponding NodeId in the
701 // context of the current session.
709 // NodeIds are not stable across compilation sessions, so we store them in their
710 // HirId representation. This allows use to map them to the current NodeId.
711 impl<'a, 'tcx> SpecializedDecoder<NodeId> for CacheDecoder<'a, 'tcx> {
713 fn specialized_decode(&mut self) -> Result<NodeId, Self::Error> {
714 let hir_id = hir::HirId::decode(self)?;
715 Ok(self.tcx().hir().hir_to_node_id(hir_id))
719 impl<'a, 'tcx> SpecializedDecoder<Fingerprint> for CacheDecoder<'a, 'tcx> {
720 fn specialized_decode(&mut self) -> Result<Fingerprint, Self::Error> {
721 Fingerprint::decode_opaque(&mut self.opaque)
725 impl<'a, 'tcx, T: Decodable> SpecializedDecoder<mir::ClearCrossCrate<T>>
726 for CacheDecoder<'a, 'tcx>
729 fn specialized_decode(&mut self) -> Result<mir::ClearCrossCrate<T>, Self::Error> {
730 let discr = u8::decode(self)?;
733 TAG_CLEAR_CROSS_CRATE_CLEAR => Ok(mir::ClearCrossCrate::Clear),
734 TAG_CLEAR_CROSS_CRATE_SET => {
735 let val = T::decode(self)?;
736 Ok(mir::ClearCrossCrate::Set(val))
745 //- ENCODING -------------------------------------------------------------------
747 struct CacheEncoder<'a, 'tcx, E: ty_codec::TyEncoder> {
750 type_shorthands: FxHashMap<Ty<'tcx>, usize>,
751 predicate_shorthands: FxHashMap<ty::Predicate<'tcx>, usize>,
752 expn_info_shorthands: FxHashMap<Mark, AbsoluteBytePos>,
753 interpret_allocs: FxHashMap<interpret::AllocId, usize>,
754 interpret_allocs_inverse: Vec<interpret::AllocId>,
755 source_map: CachingSourceMapView<'tcx>,
756 file_to_file_index: FxHashMap<*const SourceFile, SourceFileIndex>,
759 impl<'a, 'tcx, E> CacheEncoder<'a, 'tcx, E>
761 E: 'a + ty_codec::TyEncoder,
763 fn source_file_index(&mut self, source_file: Lrc<SourceFile>) -> SourceFileIndex {
764 self.file_to_file_index[&(&*source_file as *const SourceFile)]
767 /// Encode something with additional information that allows to do some
768 /// sanity checks when decoding the data again. This method will first
769 /// encode the specified tag, then the given value, then the number of
770 /// bytes taken up by tag and value. On decoding, we can then verify that
771 /// we get the expected tag and read the expected number of bytes.
772 fn encode_tagged<T: Encodable, V: Encodable>(&mut self,
775 -> Result<(), E::Error>
777 let start_pos = self.position();
782 let end_pos = self.position();
783 ((end_pos - start_pos) as u64).encode(self)
787 impl<'a, 'tcx, E> SpecializedEncoder<interpret::AllocId> for CacheEncoder<'a, 'tcx, E>
789 E: 'a + ty_codec::TyEncoder,
791 fn specialized_encode(&mut self, alloc_id: &interpret::AllocId) -> Result<(), Self::Error> {
792 use std::collections::hash_map::Entry;
793 let index = match self.interpret_allocs.entry(*alloc_id) {
794 Entry::Occupied(e) => *e.get(),
795 Entry::Vacant(e) => {
796 let idx = self.interpret_allocs_inverse.len();
797 self.interpret_allocs_inverse.push(*alloc_id);
807 impl<'a, 'tcx, E> SpecializedEncoder<Span> for CacheEncoder<'a, 'tcx, E>
809 E: 'a + ty_codec::TyEncoder,
811 fn specialized_encode(&mut self, span: &Span) -> Result<(), Self::Error> {
813 if *span == DUMMY_SP {
814 return TAG_INVALID_SPAN.encode(self);
817 let span_data = span.data();
819 if span_data.hi < span_data.lo {
820 return TAG_INVALID_SPAN.encode(self);
823 let (file_lo, line_lo, col_lo) = match self.source_map
824 .byte_pos_to_line_and_col(span_data.lo) {
826 None => return TAG_INVALID_SPAN.encode(self)
829 if !file_lo.contains(span_data.hi) {
830 return TAG_INVALID_SPAN.encode(self);
833 let len = span_data.hi - span_data.lo;
835 let source_file_index = self.source_file_index(file_lo);
837 TAG_VALID_SPAN.encode(self)?;
838 source_file_index.encode(self)?;
839 line_lo.encode(self)?;
840 col_lo.encode(self)?;
843 if span_data.ctxt == SyntaxContext::empty() {
844 TAG_NO_EXPANSION_INFO.encode(self)
846 let (mark, expn_info) = span_data.ctxt.outer_and_expn_info();
847 if let Some(expn_info) = expn_info {
848 if let Some(pos) = self.expn_info_shorthands.get(&mark).cloned() {
849 TAG_EXPANSION_INFO_SHORTHAND.encode(self)?;
852 TAG_EXPANSION_INFO_INLINE.encode(self)?;
853 let pos = AbsoluteBytePos::new(self.position());
854 self.expn_info_shorthands.insert(mark, pos);
855 expn_info.encode(self)
858 TAG_NO_EXPANSION_INFO.encode(self)
864 impl<'a, 'tcx, E> ty_codec::TyEncoder for CacheEncoder<'a, 'tcx, E>
866 E: 'a + ty_codec::TyEncoder,
869 fn position(&self) -> usize {
870 self.encoder.position()
874 impl<'a, 'tcx, E> SpecializedEncoder<CrateNum> for CacheEncoder<'a, 'tcx, E>
876 E: 'a + ty_codec::TyEncoder,
879 fn specialized_encode(&mut self, cnum: &CrateNum) -> Result<(), Self::Error> {
880 self.emit_u32(cnum.as_u32())
884 impl<'a, 'tcx, E> SpecializedEncoder<Ty<'tcx>> for CacheEncoder<'a, 'tcx, E>
886 E: 'a + ty_codec::TyEncoder,
889 fn specialized_encode(&mut self, ty: &Ty<'tcx>) -> Result<(), Self::Error> {
890 ty_codec::encode_with_shorthand(self, ty,
891 |encoder| &mut encoder.type_shorthands)
895 impl<'a, 'tcx, E> SpecializedEncoder<ty::GenericPredicates<'tcx>> for CacheEncoder<'a, 'tcx, E>
897 E: 'a + ty_codec::TyEncoder,
900 fn specialized_encode(&mut self,
901 predicates: &ty::GenericPredicates<'tcx>)
902 -> Result<(), Self::Error> {
903 ty_codec::encode_predicates(self, predicates,
904 |encoder| &mut encoder.predicate_shorthands)
908 impl<'a, 'tcx, E> SpecializedEncoder<hir::HirId> for CacheEncoder<'a, 'tcx, E>
910 E: 'a + ty_codec::TyEncoder,
913 fn specialized_encode(&mut self, id: &hir::HirId) -> Result<(), Self::Error> {
919 let def_path_hash = self.tcx.hir().definitions().def_path_hash(owner);
921 def_path_hash.encode(self)?;
922 local_id.encode(self)
926 impl<'a, 'tcx, E> SpecializedEncoder<DefId> for CacheEncoder<'a, 'tcx, E>
928 E: 'a + ty_codec::TyEncoder,
931 fn specialized_encode(&mut self, id: &DefId) -> Result<(), Self::Error> {
932 let def_path_hash = self.tcx.def_path_hash(*id);
933 def_path_hash.encode(self)
937 impl<'a, 'tcx, E> SpecializedEncoder<LocalDefId> for CacheEncoder<'a, 'tcx, E>
939 E: 'a + ty_codec::TyEncoder,
942 fn specialized_encode(&mut self, id: &LocalDefId) -> Result<(), Self::Error> {
943 id.to_def_id().encode(self)
947 impl<'a, 'tcx, E> SpecializedEncoder<DefIndex> for CacheEncoder<'a, 'tcx, E>
949 E: 'a + ty_codec::TyEncoder,
951 fn specialized_encode(&mut self, _: &DefIndex) -> Result<(), Self::Error> {
952 bug!("Encoding DefIndex without context.")
956 // NodeIds are not stable across compilation sessions, so we store them in their
957 // HirId representation. This allows use to map them to the current NodeId.
958 impl<'a, 'tcx, E> SpecializedEncoder<NodeId> for CacheEncoder<'a, 'tcx, E>
960 E: 'a + ty_codec::TyEncoder,
963 fn specialized_encode(&mut self, node_id: &NodeId) -> Result<(), Self::Error> {
964 let hir_id = self.tcx.hir().node_to_hir_id(*node_id);
969 impl<'a, 'tcx> SpecializedEncoder<Fingerprint> for CacheEncoder<'a, 'tcx, opaque::Encoder> {
970 fn specialized_encode(&mut self, f: &Fingerprint) -> Result<(), Self::Error> {
971 f.encode_opaque(&mut self.encoder)
975 impl<'a, 'tcx, E, T> SpecializedEncoder<mir::ClearCrossCrate<T>> for CacheEncoder<'a, 'tcx, E>
977 E: 'a + ty_codec::TyEncoder,
981 fn specialized_encode(&mut self,
982 val: &mir::ClearCrossCrate<T>)
983 -> Result<(), Self::Error> {
985 mir::ClearCrossCrate::Clear => {
986 TAG_CLEAR_CROSS_CRATE_CLEAR.encode(self)
988 mir::ClearCrossCrate::Set(ref val) => {
989 TAG_CLEAR_CROSS_CRATE_SET.encode(self)?;
996 macro_rules! encoder_methods {
997 ($($name:ident($ty:ty);)*) => {
998 $(fn $name(&mut self, value: $ty) -> Result<(), Self::Error> {
999 self.encoder.$name(value)
1004 impl<'a, 'tcx, E> Encoder for CacheEncoder<'a, 'tcx, E>
1006 E: 'a + ty_codec::TyEncoder,
1008 type Error = E::Error;
1010 fn emit_unit(&mut self) -> Result<(), Self::Error> {
1037 // An integer that will always encode to 8 bytes.
1038 struct IntEncodedWithFixedSize(u64);
1040 impl IntEncodedWithFixedSize {
1041 pub const ENCODED_SIZE: usize = 8;
1044 impl UseSpecializedEncodable for IntEncodedWithFixedSize {}
1045 impl UseSpecializedDecodable for IntEncodedWithFixedSize {}
1047 impl SpecializedEncoder<IntEncodedWithFixedSize> for opaque::Encoder {
1048 fn specialized_encode(&mut self, x: &IntEncodedWithFixedSize) -> Result<(), Self::Error> {
1049 let start_pos = self.position();
1050 for i in 0 .. IntEncodedWithFixedSize::ENCODED_SIZE {
1051 ((x.0 >> i * 8) as u8).encode(self)?;
1053 let end_pos = self.position();
1054 assert_eq!((end_pos - start_pos), IntEncodedWithFixedSize::ENCODED_SIZE);
1059 impl<'a> SpecializedDecoder<IntEncodedWithFixedSize> for opaque::Decoder<'a> {
1060 fn specialized_decode(&mut self) -> Result<IntEncodedWithFixedSize, Self::Error> {
1061 let mut value: u64 = 0;
1062 let start_pos = self.position();
1064 for i in 0 .. IntEncodedWithFixedSize::ENCODED_SIZE {
1065 let byte: u8 = Decodable::decode(self)?;
1066 value |= (byte as u64) << (i * 8);
1069 let end_pos = self.position();
1070 assert_eq!((end_pos - start_pos), IntEncodedWithFixedSize::ENCODED_SIZE);
1072 Ok(IntEncodedWithFixedSize(value))
1076 fn encode_query_results<'a, 'tcx, Q, E>(
1078 encoder: &mut CacheEncoder<'a, 'tcx, E>,
1079 query_result_index: &mut EncodedQueryResultIndex,
1080 ) -> Result<(), E::Error>
1082 Q: super::config::QueryDescription<'tcx>,
1084 Q::Value: Encodable,
1086 let desc = &format!("encode_query_results for {}",
1087 unsafe { ::std::intrinsics::type_name::<Q>() });
1089 time_ext(tcx.sess.time_extended(), Some(tcx.sess), desc, || {
1090 let map = Q::query_cache(tcx).borrow();
1091 assert!(map.active.is_empty());
1092 for (key, entry) in map.results.iter() {
1093 if Q::cache_on_disk(tcx, key.clone()) {
1094 let dep_node = SerializedDepNodeIndex::new(entry.index.index());
1096 // Record position of the cache entry
1097 query_result_index.push((dep_node, AbsoluteBytePos::new(encoder.position())));
1099 // Encode the type check tables with the SerializedDepNodeIndex
1101 encoder.encode_tagged(dep_node, &entry.value)?;