2 use rustc_data_structures
::fx
::{FxHashMap, FxHashSet, FxIndexSet}
;
3 use rustc_data_structures
::memmap
::Mmap
;
4 use rustc_data_structures
::sync
::{HashMapExt, Lock, Lrc, RwLock}
;
5 use rustc_data_structures
::unhash
::UnhashMap
;
6 use rustc_hir
::def_id
::{CrateNum, DefId, DefIndex, LocalDefId, StableCrateId, LOCAL_CRATE}
;
7 use rustc_hir
::definitions
::DefPathHash
;
8 use rustc_index
::vec
::{Idx, IndexVec}
;
9 use rustc_middle
::dep_graph
::{DepNodeIndex, SerializedDepNodeIndex}
;
10 use rustc_middle
::mir
::interpret
::{AllocDecodingSession, AllocDecodingState}
;
11 use rustc_middle
::mir
::{self, interpret}
;
12 use rustc_middle
::thir
;
13 use rustc_middle
::ty
::codec
::{RefDecodable, TyDecoder, TyEncoder}
;
14 use rustc_middle
::ty
::{self, Ty, TyCtxt}
;
15 use rustc_query_system
::dep_graph
::DepContext
;
16 use rustc_query_system
::query
::{QueryCache, QueryContext, QuerySideEffects}
;
17 use rustc_serialize
::{
18 opaque
::{FileEncodeResult, FileEncoder, IntEncodedWithFixedSize, MemDecoder}
,
19 Decodable
, Decoder
, Encodable
, Encoder
,
21 use rustc_session
::Session
;
22 use rustc_span
::hygiene
::{
23 ExpnId
, HygieneDecodeContext
, HygieneEncodeContext
, SyntaxContext
, SyntaxContextData
,
25 use rustc_span
::source_map
::{SourceMap, StableSourceFileId}
;
26 use rustc_span
::CachingSourceMapView
;
27 use rustc_span
::{BytePos, ExpnData, ExpnHash, Pos, SourceFile, Span}
;
31 const TAG_FILE_FOOTER
: u128
= 0xC0FFEE_C0FFEE_C0FFEE_C0FFEE_C0FFEE;
33 // A normal span encoded with both location information and a `SyntaxContext`
34 const TAG_FULL_SPAN
: u8 = 0;
35 // A partial span with no location information, encoded only with a `SyntaxContext`
36 const TAG_PARTIAL_SPAN
: u8 = 1;
37 const TAG_RELATIVE_SPAN
: u8 = 2;
39 const TAG_SYNTAX_CONTEXT
: u8 = 0;
40 const TAG_EXPN_DATA
: u8 = 1;
42 /// Provides an interface to incremental compilation data cached from the
43 /// previous compilation session. This data will eventually include the results
44 /// of a few selected queries (like `typeck` and `mir_optimized`) and
45 /// any side effects that have been emitted during a query.
46 pub struct OnDiskCache
<'sess
> {
47 // The complete cache data in serialized form.
48 serialized_data
: RwLock
<Option
<Mmap
>>,
50 // Collects all `QuerySideEffects` created during the current compilation
52 current_side_effects
: Lock
<FxHashMap
<DepNodeIndex
, QuerySideEffects
>>,
54 source_map
: &'sess SourceMap
,
55 file_index_to_stable_id
: FxHashMap
<SourceFileIndex
, EncodedSourceFileId
>,
57 // Caches that are populated lazily during decoding.
58 file_index_to_file
: Lock
<FxHashMap
<SourceFileIndex
, Lrc
<SourceFile
>>>,
60 // A map from dep-node to the position of the cached query result in
62 query_result_index
: FxHashMap
<SerializedDepNodeIndex
, AbsoluteBytePos
>,
64 // A map from dep-node to the position of any associated `QuerySideEffects` in
66 prev_side_effects_index
: FxHashMap
<SerializedDepNodeIndex
, AbsoluteBytePos
>,
68 alloc_decoding_state
: AllocDecodingState
,
70 // A map from syntax context ids to the position of their associated
71 // `SyntaxContextData`. We use a `u32` instead of a `SyntaxContext`
72 // to represent the fact that we are storing *encoded* ids. When we decode
73 // a `SyntaxContext`, a new id will be allocated from the global `HygieneData`,
74 // which will almost certainly be different than the serialized id.
75 syntax_contexts
: FxHashMap
<u32, AbsoluteBytePos
>,
76 // A map from the `DefPathHash` of an `ExpnId` to the position
77 // of their associated `ExpnData`. Ideally, we would store a `DefId`,
78 // but we need to decode this before we've constructed a `TyCtxt` (which
79 // makes it difficult to decode a `DefId`).
81 // Note that these `DefPathHashes` correspond to both local and foreign
82 // `ExpnData` (e.g `ExpnData.krate` may not be `LOCAL_CRATE`). Alternatively,
83 // we could look up the `ExpnData` from the metadata of foreign crates,
84 // but it seemed easier to have `OnDiskCache` be independent of the `CStore`.
85 expn_data
: UnhashMap
<ExpnHash
, AbsoluteBytePos
>,
86 // Additional information used when decoding hygiene data.
87 hygiene_context
: HygieneDecodeContext
,
88 // Maps `ExpnHash`es to their raw value from the *previous*
89 // compilation session. This is used as an initial 'guess' when
90 // we try to map an `ExpnHash` to its value in the current
91 // compilation session.
92 foreign_expn_data
: UnhashMap
<ExpnHash
, u32>,
95 // This type is used only for serialization and deserialization.
96 #[derive(Encodable, Decodable)]
98 file_index_to_stable_id
: FxHashMap
<SourceFileIndex
, EncodedSourceFileId
>,
99 query_result_index
: EncodedDepNodeIndex
,
100 side_effects_index
: EncodedDepNodeIndex
,
101 // The location of all allocations.
102 interpret_alloc_index
: Vec
<u32>,
103 // See `OnDiskCache.syntax_contexts`
104 syntax_contexts
: FxHashMap
<u32, AbsoluteBytePos
>,
105 // See `OnDiskCache.expn_data`
106 expn_data
: UnhashMap
<ExpnHash
, AbsoluteBytePos
>,
107 foreign_expn_data
: UnhashMap
<ExpnHash
, u32>,
110 pub type EncodedDepNodeIndex
= Vec
<(SerializedDepNodeIndex
, AbsoluteBytePos
)>;
112 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug, Encodable, Decodable)]
113 struct SourceFileIndex(u32);
115 #[derive(Copy, Clone, Debug, Hash, Eq, PartialEq, Encodable, Decodable)]
116 pub struct AbsoluteBytePos(u32);
118 impl AbsoluteBytePos
{
119 fn new(pos
: usize) -> AbsoluteBytePos
{
120 debug_assert
!(pos
<= u32::MAX
as usize);
121 AbsoluteBytePos(pos
as u32)
124 fn to_usize(self) -> usize {
129 /// An `EncodedSourceFileId` is the same as a `StableSourceFileId` except that
130 /// the source crate is represented as a [StableCrateId] instead of as a
131 /// `CrateNum`. This way `EncodedSourceFileId` can be encoded and decoded
132 /// without any additional context, i.e. with a simple `opaque::Decoder` (which
133 /// is the only thing available when decoding the cache's [Footer].
134 #[derive(Encodable, Decodable, Clone, Debug)]
135 struct EncodedSourceFileId
{
137 stable_crate_id
: StableCrateId
,
140 impl EncodedSourceFileId
{
141 fn translate(&self, tcx
: TyCtxt
<'_
>) -> StableSourceFileId
{
142 let cnum
= tcx
.stable_crate_id_to_crate_num(self.stable_crate_id
);
143 StableSourceFileId { file_name_hash: self.file_name_hash, cnum }
146 fn new(tcx
: TyCtxt
<'_
>, file
: &SourceFile
) -> EncodedSourceFileId
{
147 let source_file_id
= StableSourceFileId
::new(file
);
148 EncodedSourceFileId
{
149 file_name_hash
: source_file_id
.file_name_hash
,
150 stable_crate_id
: tcx
.stable_crate_id(source_file_id
.cnum
),
155 impl<'sess
> rustc_middle
::ty
::OnDiskCache
<'sess
> for OnDiskCache
<'sess
> {
156 /// Creates a new `OnDiskCache` instance from the serialized data in `data`.
157 fn new(sess
: &'sess Session
, data
: Mmap
, start_pos
: usize) -> Self {
158 debug_assert
!(sess
.opts
.incremental
.is_some());
160 // Wrap in a scope so we can borrow `data`.
161 let footer
: Footer
= {
162 let mut decoder
= MemDecoder
::new(&data
, start_pos
);
164 // Decode the *position* of the footer, which can be found in the
165 // last 8 bytes of the file.
166 decoder
.set_position(data
.len() - IntEncodedWithFixedSize
::ENCODED_SIZE
);
167 let footer_pos
= IntEncodedWithFixedSize
::decode(&mut decoder
).0 as usize;
169 // Decode the file footer, which contains all the lookup tables, etc.
170 decoder
.set_position(footer_pos
);
172 decode_tagged(&mut decoder
, TAG_FILE_FOOTER
)
176 serialized_data
: RwLock
::new(Some(data
)),
177 file_index_to_stable_id
: footer
.file_index_to_stable_id
,
178 file_index_to_file
: Default
::default(),
179 source_map
: sess
.source_map(),
180 current_side_effects
: Default
::default(),
181 query_result_index
: footer
.query_result_index
.into_iter().collect(),
182 prev_side_effects_index
: footer
.side_effects_index
.into_iter().collect(),
183 alloc_decoding_state
: AllocDecodingState
::new(footer
.interpret_alloc_index
),
184 syntax_contexts
: footer
.syntax_contexts
,
185 expn_data
: footer
.expn_data
,
186 foreign_expn_data
: footer
.foreign_expn_data
,
187 hygiene_context
: Default
::default(),
191 fn new_empty(source_map
: &'sess SourceMap
) -> Self {
193 serialized_data
: RwLock
::new(None
),
194 file_index_to_stable_id
: Default
::default(),
195 file_index_to_file
: Default
::default(),
197 current_side_effects
: Default
::default(),
198 query_result_index
: Default
::default(),
199 prev_side_effects_index
: Default
::default(),
200 alloc_decoding_state
: AllocDecodingState
::new(Vec
::new()),
201 syntax_contexts
: FxHashMap
::default(),
202 expn_data
: UnhashMap
::default(),
203 foreign_expn_data
: UnhashMap
::default(),
204 hygiene_context
: Default
::default(),
208 /// Execute all cache promotions and release the serialized backing Mmap.
210 /// Cache promotions require invoking queries, which needs to read the serialized data.
211 /// In order to serialize the new on-disk cache, the former on-disk cache file needs to be
212 /// deleted, hence we won't be able to refer to its memmapped data.
213 fn drop_serialized_data(&self, tcx
: TyCtxt
<'_
>) {
214 // Load everything into memory so we can write it out to the on-disk
215 // cache. The vast majority of cacheable query results should already
216 // be in memory, so this should be a cheap operation.
217 // Do this *before* we clone 'latest_foreign_def_path_hashes', since
218 // loading existing queries may cause us to create new DepNodes, which
219 // may in turn end up invoking `store_foreign_def_id_hash`
220 tcx
.dep_graph
.exec_cache_promotions(tcx
);
222 *self.serialized_data
.write() = None
;
225 fn serialize
<'tcx
>(&self, tcx
: TyCtxt
<'tcx
>, encoder
: FileEncoder
) -> FileEncodeResult
{
226 // Serializing the `DepGraph` should not modify it.
227 tcx
.dep_graph
.with_ignore(|| {
228 // Allocate `SourceFileIndex`es.
229 let (file_to_file_index
, file_index_to_stable_id
) = {
230 let files
= tcx
.sess
.source_map().files();
231 let mut file_to_file_index
=
232 FxHashMap
::with_capacity_and_hasher(files
.len(), Default
::default());
233 let mut file_index_to_stable_id
=
234 FxHashMap
::with_capacity_and_hasher(files
.len(), Default
::default());
236 for (index
, file
) in files
.iter().enumerate() {
237 let index
= SourceFileIndex(index
as u32);
238 let file_ptr
: *const SourceFile
= &**file
as *const _
;
239 file_to_file_index
.insert(file_ptr
, index
);
240 let source_file_id
= EncodedSourceFileId
::new(tcx
, &file
);
241 file_index_to_stable_id
.insert(index
, source_file_id
);
244 (file_to_file_index
, file_index_to_stable_id
)
247 let hygiene_encode_context
= HygieneEncodeContext
::default();
249 let mut encoder
= CacheEncoder
{
252 type_shorthands
: Default
::default(),
253 predicate_shorthands
: Default
::default(),
254 interpret_allocs
: Default
::default(),
255 source_map
: CachingSourceMapView
::new(tcx
.sess
.source_map()),
257 hygiene_context
: &hygiene_encode_context
,
260 // Encode query results.
261 let mut query_result_index
= EncodedDepNodeIndex
::new();
263 tcx
.sess
.time("encode_query_results", || {
264 let enc
= &mut encoder
;
265 let qri
= &mut query_result_index
;
266 QueryCtxt
::from_tcx(tcx
).encode_query_results(enc
, qri
);
269 // Encode side effects.
270 let side_effects_index
: EncodedDepNodeIndex
= self
271 .current_side_effects
274 .map(|(dep_node_index
, side_effects
)| {
275 let pos
= AbsoluteBytePos
::new(encoder
.position());
276 let dep_node_index
= SerializedDepNodeIndex
::new(dep_node_index
.index());
277 encoder
.encode_tagged(dep_node_index
, side_effects
);
279 (dep_node_index
, pos
)
283 let interpret_alloc_index
= {
284 let mut interpret_alloc_index
= Vec
::new();
287 let new_n
= encoder
.interpret_allocs
.len();
288 // If we have found new IDs, serialize those too.
293 interpret_alloc_index
.reserve(new_n
- n
);
294 for idx
in n
..new_n
{
295 let id
= encoder
.interpret_allocs
[idx
];
296 let pos
= encoder
.position() as u32;
297 interpret_alloc_index
.push(pos
);
298 interpret
::specialized_encode_alloc_id(&mut encoder
, tcx
, id
);
302 interpret_alloc_index
305 let mut syntax_contexts
= FxHashMap
::default();
306 let mut expn_data
= UnhashMap
::default();
307 let mut foreign_expn_data
= UnhashMap
::default();
309 // Encode all hygiene data (`SyntaxContextData` and `ExpnData`) from the current
312 hygiene_encode_context
.encode(
314 |encoder
, index
, ctxt_data
| {
315 let pos
= AbsoluteBytePos
::new(encoder
.position());
316 encoder
.encode_tagged(TAG_SYNTAX_CONTEXT
, ctxt_data
);
317 syntax_contexts
.insert(index
, pos
);
319 |encoder
, expn_id
, data
, hash
| {
320 if expn_id
.krate
== LOCAL_CRATE
{
321 let pos
= AbsoluteBytePos
::new(encoder
.position());
322 encoder
.encode_tagged(TAG_EXPN_DATA
, data
);
323 expn_data
.insert(hash
, pos
);
325 foreign_expn_data
.insert(hash
, expn_id
.local_id
.as_u32());
330 // `Encode the file footer.
331 let footer_pos
= encoder
.position() as u64;
332 encoder
.encode_tagged(
335 file_index_to_stable_id
,
338 interpret_alloc_index
,
345 // Encode the position of the footer as the last 8 bytes of the
346 // file so we know where to look for it.
347 IntEncodedWithFixedSize(footer_pos
).encode(&mut encoder
.encoder
);
349 // DO NOT WRITE ANYTHING TO THE ENCODER AFTER THIS POINT! The address
350 // of the footer must be the last thing in the data stream.
357 impl<'sess
> OnDiskCache
<'sess
> {
358 pub fn as_dyn(&self) -> &dyn rustc_middle
::ty
::OnDiskCache
<'sess
> {
362 /// Loads a `QuerySideEffects` created during the previous compilation session.
363 pub fn load_side_effects(
366 dep_node_index
: SerializedDepNodeIndex
,
367 ) -> QuerySideEffects
{
368 let side_effects
: Option
<QuerySideEffects
> =
369 self.load_indexed(tcx
, dep_node_index
, &self.prev_side_effects_index
);
371 side_effects
.unwrap_or_default()
374 /// Stores a `QuerySideEffects` emitted during the current compilation session.
375 /// Anything stored like this will be available via `load_side_effects` in
376 /// the next compilation session.
379 pub fn store_side_effects(&self, dep_node_index
: DepNodeIndex
, side_effects
: QuerySideEffects
) {
380 let mut current_side_effects
= self.current_side_effects
.borrow_mut();
381 let prev
= current_side_effects
.insert(dep_node_index
, side_effects
);
382 debug_assert
!(prev
.is_none());
385 /// Returns the cached query result if there is something in the cache for
386 /// the given `SerializedDepNodeIndex`; otherwise returns `None`.
387 pub fn try_load_query_result
<'tcx
, T
>(
390 dep_node_index
: SerializedDepNodeIndex
,
393 T
: for<'a
> Decodable
<CacheDecoder
<'a
, 'tcx
>>,
395 self.load_indexed(tcx
, dep_node_index
, &self.query_result_index
)
398 /// Stores side effect emitted during computation of an anonymous query.
399 /// Since many anonymous queries can share the same `DepNode`, we aggregate
400 /// them -- as opposed to regular queries where we assume that there is a
401 /// 1:1 relationship between query-key and `DepNode`.
404 pub fn store_side_effects_for_anon_node(
406 dep_node_index
: DepNodeIndex
,
407 side_effects
: QuerySideEffects
,
409 let mut current_side_effects
= self.current_side_effects
.borrow_mut();
411 let x
= current_side_effects
.entry(dep_node_index
).or_default();
412 x
.append(side_effects
);
415 fn load_indexed
<'tcx
, T
>(
418 dep_node_index
: SerializedDepNodeIndex
,
419 index
: &FxHashMap
<SerializedDepNodeIndex
, AbsoluteBytePos
>,
422 T
: for<'a
> Decodable
<CacheDecoder
<'a
, 'tcx
>>,
424 let pos
= index
.get(&dep_node_index
).cloned()?
;
426 self.with_decoder(tcx
, pos
, |decoder
| Some(decode_tagged(decoder
, dep_node_index
)))
429 fn with_decoder
<'a
, 'tcx
, T
, F
: for<'s
> FnOnce(&mut CacheDecoder
<'s
, 'tcx
>) -> T
>(
432 pos
: AbsoluteBytePos
,
436 T
: Decodable
<CacheDecoder
<'a
, 'tcx
>>,
438 let serialized_data
= self.serialized_data
.read();
439 let mut decoder
= CacheDecoder
{
441 opaque
: MemDecoder
::new(serialized_data
.as_deref().unwrap_or(&[]), pos
.to_usize()),
442 source_map
: self.source_map
,
443 file_index_to_file
: &self.file_index_to_file
,
444 file_index_to_stable_id
: &self.file_index_to_stable_id
,
445 alloc_decoding_session
: self.alloc_decoding_state
.new_decoding_session(),
446 syntax_contexts
: &self.syntax_contexts
,
447 expn_data
: &self.expn_data
,
448 foreign_expn_data
: &self.foreign_expn_data
,
449 hygiene_context
: &self.hygiene_context
,
455 //- DECODING -------------------------------------------------------------------
457 /// A decoder that can read from the incremental compilation cache. It is similar to the one
458 /// we use for crate metadata decoding in that it can rebase spans and eventually
459 /// will also handle things that contain `Ty` instances.
460 pub struct CacheDecoder
<'a
, 'tcx
> {
462 opaque
: MemDecoder
<'a
>,
463 source_map
: &'a SourceMap
,
464 file_index_to_file
: &'a Lock
<FxHashMap
<SourceFileIndex
, Lrc
<SourceFile
>>>,
465 file_index_to_stable_id
: &'a FxHashMap
<SourceFileIndex
, EncodedSourceFileId
>,
466 alloc_decoding_session
: AllocDecodingSession
<'a
>,
467 syntax_contexts
: &'a FxHashMap
<u32, AbsoluteBytePos
>,
468 expn_data
: &'a UnhashMap
<ExpnHash
, AbsoluteBytePos
>,
469 foreign_expn_data
: &'a UnhashMap
<ExpnHash
, u32>,
470 hygiene_context
: &'a HygieneDecodeContext
,
473 impl<'a
, 'tcx
> CacheDecoder
<'a
, 'tcx
> {
474 fn file_index_to_file(&self, index
: SourceFileIndex
) -> Lrc
<SourceFile
> {
477 ref file_index_to_file
,
478 ref file_index_to_stable_id
,
487 let stable_id
= file_index_to_stable_id
[&index
].translate(tcx
);
489 // If this `SourceFile` is from a foreign crate, then make sure
490 // that we've imported all of the source files from that crate.
491 // This has usually already been done during macro invocation.
492 // However, when encoding query results like `TypeckResults`,
493 // we might encode an `AdtDef` for a foreign type (because it
494 // was referenced in the body of the function). There is no guarantee
495 // that we will load the source files from that crate during macro
496 // expansion, so we use `import_source_files` to ensure that the foreign
497 // source files are actually imported before we call `source_file_by_stable_id`.
498 if stable_id
.cnum
!= LOCAL_CRATE
{
499 self.tcx
.cstore_untracked().import_source_files(self.tcx
.sess
, stable_id
.cnum
);
503 .source_file_by_stable_id(stable_id
)
504 .expect("failed to lookup `SourceFile` in new context")
510 trait DecoderWithPosition
: Decoder
{
511 fn position(&self) -> usize;
514 impl<'a
> DecoderWithPosition
for MemDecoder
<'a
> {
515 fn position(&self) -> usize {
520 impl<'a
, 'tcx
> DecoderWithPosition
for CacheDecoder
<'a
, 'tcx
> {
521 fn position(&self) -> usize {
522 self.opaque
.position()
526 // Decodes something that was encoded with `encode_tagged()` and verify that the
527 // tag matches and the correct amount of bytes was read.
528 fn decode_tagged
<D
, T
, V
>(decoder
: &mut D
, expected_tag
: T
) -> V
530 T
: Decodable
<D
> + Eq
+ std
::fmt
::Debug
,
532 D
: DecoderWithPosition
,
534 let start_pos
= decoder
.position();
536 let actual_tag
= T
::decode(decoder
);
537 assert_eq
!(actual_tag
, expected_tag
);
538 let value
= V
::decode(decoder
);
539 let end_pos
= decoder
.position();
541 let expected_len
: u64 = Decodable
::decode(decoder
);
542 assert_eq
!((end_pos
- start_pos
) as u64, expected_len
);
547 impl<'a
, 'tcx
> TyDecoder
for CacheDecoder
<'a
, 'tcx
> {
548 type I
= TyCtxt
<'tcx
>;
549 const CLEAR_CROSS_CRATE
: bool
= false;
552 fn interner(&self) -> TyCtxt
<'tcx
> {
557 fn position(&self) -> usize {
558 self.opaque
.position()
562 fn peek_byte(&self) -> u8 {
563 self.opaque
.data
[self.opaque
.position()]
566 fn cached_ty_for_shorthand
<F
>(&mut self, shorthand
: usize, or_insert_with
: F
) -> Ty
<'tcx
>
568 F
: FnOnce(&mut Self) -> Ty
<'tcx
>,
572 let cache_key
= ty
::CReaderCacheKey { cnum: None, pos: shorthand }
;
574 if let Some(&ty
) = tcx
.ty_rcache
.borrow().get(&cache_key
) {
578 let ty
= or_insert_with(self);
579 // This may overwrite the entry, but it should overwrite with the same value.
580 tcx
.ty_rcache
.borrow_mut().insert_same(cache_key
, ty
);
584 fn with_position
<F
, R
>(&mut self, pos
: usize, f
: F
) -> R
586 F
: FnOnce(&mut Self) -> R
,
588 debug_assert
!(pos
< self.opaque
.data
.len());
590 let new_opaque
= MemDecoder
::new(self.opaque
.data
, pos
);
591 let old_opaque
= mem
::replace(&mut self.opaque
, new_opaque
);
593 self.opaque
= old_opaque
;
597 fn decode_alloc_id(&mut self) -> interpret
::AllocId
{
598 let alloc_decoding_session
= self.alloc_decoding_session
;
599 alloc_decoding_session
.decode_alloc_id(self)
603 rustc_middle
::implement_ty_decoder
!(CacheDecoder
<'a
, 'tcx
>);
605 // This ensures that the `Decodable<opaque::Decoder>::decode` specialization for `Vec<u8>` is used
606 // when a `CacheDecoder` is passed to `Decodable::decode`. Unfortunately, we have to manually opt
607 // into specializations this way, given how `CacheDecoder` and the decoding traits currently work.
608 impl<'a
, 'tcx
> Decodable
<CacheDecoder
<'a
, 'tcx
>> for Vec
<u8> {
609 fn decode(d
: &mut CacheDecoder
<'a
, 'tcx
>) -> Self {
610 Decodable
::decode(&mut d
.opaque
)
614 impl<'a
, 'tcx
> Decodable
<CacheDecoder
<'a
, 'tcx
>> for SyntaxContext
{
615 fn decode(decoder
: &mut CacheDecoder
<'a
, 'tcx
>) -> Self {
616 let syntax_contexts
= decoder
.syntax_contexts
;
617 rustc_span
::hygiene
::decode_syntax_context(decoder
, decoder
.hygiene_context
, |this
, id
| {
618 // This closure is invoked if we haven't already decoded the data for the `SyntaxContext` we are deserializing.
619 // We look up the position of the associated `SyntaxData` and decode it.
620 let pos
= syntax_contexts
.get(&id
).unwrap();
621 this
.with_position(pos
.to_usize(), |decoder
| {
622 let data
: SyntaxContextData
= decode_tagged(decoder
, TAG_SYNTAX_CONTEXT
);
629 impl<'a
, 'tcx
> Decodable
<CacheDecoder
<'a
, 'tcx
>> for ExpnId
{
630 fn decode(decoder
: &mut CacheDecoder
<'a
, 'tcx
>) -> Self {
631 let hash
= ExpnHash
::decode(decoder
);
633 return ExpnId
::root();
636 if let Some(expn_id
) = ExpnId
::from_hash(hash
) {
640 let krate
= decoder
.tcx
.stable_crate_id_to_crate_num(hash
.stable_crate_id());
642 let expn_id
= if krate
== LOCAL_CRATE
{
643 // We look up the position of the associated `ExpnData` and decode it.
647 .unwrap_or_else(|| panic
!("Bad hash {:?} (map {:?})", hash
, decoder
.expn_data
));
649 let data
: ExpnData
= decoder
650 .with_position(pos
.to_usize(), |decoder
| decode_tagged(decoder
, TAG_EXPN_DATA
));
651 let expn_id
= rustc_span
::hygiene
::register_local_expn_id(data
, hash
);
653 #[cfg(debug_assertions)]
655 use rustc_data_structures
::stable_hasher
::{HashStable, StableHasher}
;
656 let mut hcx
= decoder
.tcx
.create_stable_hashing_context();
657 let mut hasher
= StableHasher
::new();
658 hcx
.while_hashing_spans(true, |hcx
| {
659 expn_id
.expn_data().hash_stable(hcx
, &mut hasher
)
661 let local_hash
: u64 = hasher
.finish();
662 debug_assert_eq
!(hash
.local_hash(), local_hash
);
667 let index_guess
= decoder
.foreign_expn_data
[&hash
];
668 decoder
.tcx
.cstore_untracked().expn_hash_to_expn_id(
676 debug_assert_eq
!(expn_id
.krate
, krate
);
681 impl<'a
, 'tcx
> Decodable
<CacheDecoder
<'a
, 'tcx
>> for Span
{
682 fn decode(decoder
: &mut CacheDecoder
<'a
, 'tcx
>) -> Self {
683 let ctxt
= SyntaxContext
::decode(decoder
);
684 let parent
= Option
::<LocalDefId
>::decode(decoder
);
685 let tag
: u8 = Decodable
::decode(decoder
);
687 if tag
== TAG_PARTIAL_SPAN
{
688 return Span
::new(BytePos(0), BytePos(0), ctxt
, parent
);
689 } else if tag
== TAG_RELATIVE_SPAN
{
690 let dlo
= u32::decode(decoder
);
691 let dto
= u32::decode(decoder
);
693 let enclosing
= decoder
.tcx
.source_span_untracked(parent
.unwrap()).data_untracked();
694 let span
= Span
::new(
695 enclosing
.lo
+ BytePos
::from_u32(dlo
),
696 enclosing
.lo
+ BytePos
::from_u32(dto
),
703 debug_assert_eq
!(tag
, TAG_FULL_SPAN
);
706 let file_lo_index
= SourceFileIndex
::decode(decoder
);
707 let line_lo
= usize::decode(decoder
);
708 let col_lo
= BytePos
::decode(decoder
);
709 let len
= BytePos
::decode(decoder
);
711 let file_lo
= decoder
.file_index_to_file(file_lo_index
);
712 let lo
= file_lo
.lines(|lines
| lines
[line_lo
- 1] + col_lo
);
715 Span
::new(lo
, hi
, ctxt
, parent
)
719 impl<'a
, 'tcx
> Decodable
<CacheDecoder
<'a
, 'tcx
>> for CrateNum
{
720 fn decode(d
: &mut CacheDecoder
<'a
, 'tcx
>) -> Self {
721 let stable_id
= StableCrateId
::decode(d
);
722 let cnum
= d
.tcx
.stable_crate_id_to_crate_num(stable_id
);
727 // This impl makes sure that we get a runtime error when we try decode a
728 // `DefIndex` that is not contained in a `DefId`. Such a case would be problematic
729 // because we would not know how to transform the `DefIndex` to the current
731 impl<'a
, 'tcx
> Decodable
<CacheDecoder
<'a
, 'tcx
>> for DefIndex
{
732 fn decode(_d
: &mut CacheDecoder
<'a
, 'tcx
>) -> DefIndex
{
733 panic
!("trying to decode `DefIndex` outside the context of a `DefId`")
737 // Both the `CrateNum` and the `DefIndex` of a `DefId` can change in between two
738 // compilation sessions. We use the `DefPathHash`, which is stable across
739 // sessions, to map the old `DefId` to the new one.
740 impl<'a
, 'tcx
> Decodable
<CacheDecoder
<'a
, 'tcx
>> for DefId
{
741 fn decode(d
: &mut CacheDecoder
<'a
, 'tcx
>) -> Self {
742 // Load the `DefPathHash` which is was we encoded the `DefId` as.
743 let def_path_hash
= DefPathHash
::decode(d
);
745 // Using the `DefPathHash`, we can lookup the new `DefId`.
746 // Subtle: We only encode a `DefId` as part of a query result.
747 // If we get to this point, then all of the query inputs were green,
748 // which means that the definition with this hash is guaranteed to
749 // still exist in the current compilation session.
750 d
.tcx
.def_path_hash_to_def_id(def_path_hash
, &mut || {
751 panic
!("Failed to convert DefPathHash {:?}", def_path_hash
)
756 impl<'a
, 'tcx
> Decodable
<CacheDecoder
<'a
, 'tcx
>> for &'tcx FxHashSet
<LocalDefId
> {
757 fn decode(d
: &mut CacheDecoder
<'a
, 'tcx
>) -> Self {
758 RefDecodable
::decode(d
)
762 impl<'a
, 'tcx
> Decodable
<CacheDecoder
<'a
, 'tcx
>>
763 for &'tcx IndexVec
<mir
::Promoted
, mir
::Body
<'tcx
>>
765 fn decode(d
: &mut CacheDecoder
<'a
, 'tcx
>) -> Self {
766 RefDecodable
::decode(d
)
770 impl<'a
, 'tcx
> Decodable
<CacheDecoder
<'a
, 'tcx
>> for &'tcx
[thir
::abstract_const
::Node
<'tcx
>] {
771 fn decode(d
: &mut CacheDecoder
<'a
, 'tcx
>) -> Self {
772 RefDecodable
::decode(d
)
776 impl<'a
, 'tcx
> Decodable
<CacheDecoder
<'a
, 'tcx
>> for &'tcx
[(ty
::Predicate
<'tcx
>, Span
)] {
777 fn decode(d
: &mut CacheDecoder
<'a
, 'tcx
>) -> Self {
778 RefDecodable
::decode(d
)
782 impl<'a
, 'tcx
> Decodable
<CacheDecoder
<'a
, 'tcx
>> for &'tcx
[rustc_ast
::InlineAsmTemplatePiece
] {
783 fn decode(d
: &mut CacheDecoder
<'a
, 'tcx
>) -> Self {
784 RefDecodable
::decode(d
)
788 macro_rules
! impl_ref_decoder
{
789 (<$tcx
:tt
> $
($ty
:ty
,)*) => {
790 $
(impl<'a
, $tcx
> Decodable
<CacheDecoder
<'a
, $tcx
>> for &$tcx
[$ty
] {
791 fn decode(d
: &mut CacheDecoder
<'a
, $tcx
>) -> Self {
792 RefDecodable
::decode(d
)
798 impl_ref_decoder
! {<'tcx
>
800 rustc_ast
::Attribute
,
801 rustc_span
::symbol
::Ident
,
803 rustc_span
::def_id
::DefId
,
804 rustc_span
::def_id
::LocalDefId
,
805 (rustc_middle
::middle
::exported_symbols
::ExportedSymbol
<'tcx
>, rustc_middle
::middle
::exported_symbols
::SymbolExportInfo
),
808 //- ENCODING -------------------------------------------------------------------
810 /// An encoder that can write to the incremental compilation cache.
811 pub struct CacheEncoder
<'a
, 'tcx
> {
813 encoder
: FileEncoder
,
814 type_shorthands
: FxHashMap
<Ty
<'tcx
>, usize>,
815 predicate_shorthands
: FxHashMap
<ty
::PredicateKind
<'tcx
>, usize>,
816 interpret_allocs
: FxIndexSet
<interpret
::AllocId
>,
817 source_map
: CachingSourceMapView
<'tcx
>,
818 file_to_file_index
: FxHashMap
<*const SourceFile
, SourceFileIndex
>,
819 hygiene_context
: &'a HygieneEncodeContext
,
822 impl<'a
, 'tcx
> CacheEncoder
<'a
, 'tcx
> {
823 fn source_file_index(&mut self, source_file
: Lrc
<SourceFile
>) -> SourceFileIndex
{
824 self.file_to_file_index
[&(&*source_file
as *const SourceFile
)]
827 /// Encode something with additional information that allows to do some
828 /// sanity checks when decoding the data again. This method will first
829 /// encode the specified tag, then the given value, then the number of
830 /// bytes taken up by tag and value. On decoding, we can then verify that
831 /// we get the expected tag and read the expected number of bytes.
832 fn encode_tagged
<T
: Encodable
<Self>, V
: Encodable
<Self>>(&mut self, tag
: T
, value
: &V
) {
833 let start_pos
= self.position();
838 let end_pos
= self.position();
839 ((end_pos
- start_pos
) as u64).encode(self);
842 fn finish(self) -> Result
<usize, io
::Error
> {
843 self.encoder
.finish()
847 impl<'a
, 'tcx
> Encodable
<CacheEncoder
<'a
, 'tcx
>> for SyntaxContext
{
848 fn encode(&self, s
: &mut CacheEncoder
<'a
, 'tcx
>) {
849 rustc_span
::hygiene
::raw_encode_syntax_context(*self, s
.hygiene_context
, s
);
853 impl<'a
, 'tcx
> Encodable
<CacheEncoder
<'a
, 'tcx
>> for ExpnId
{
854 fn encode(&self, s
: &mut CacheEncoder
<'a
, 'tcx
>) {
855 s
.hygiene_context
.schedule_expn_data_for_encoding(*self);
856 self.expn_hash().encode(s
);
860 impl<'a
, 'tcx
> Encodable
<CacheEncoder
<'a
, 'tcx
>> for Span
{
861 fn encode(&self, s
: &mut CacheEncoder
<'a
, 'tcx
>) {
862 let span_data
= self.data_untracked();
863 span_data
.ctxt
.encode(s
);
864 span_data
.parent
.encode(s
);
866 if span_data
.is_dummy() {
867 return TAG_PARTIAL_SPAN
.encode(s
);
870 if let Some(parent
) = span_data
.parent
{
871 let enclosing
= s
.tcx
.source_span(parent
).data_untracked();
872 if enclosing
.contains(span_data
) {
873 TAG_RELATIVE_SPAN
.encode(s
);
874 (span_data
.lo
- enclosing
.lo
).to_u32().encode(s
);
875 (span_data
.hi
- enclosing
.lo
).to_u32().encode(s
);
880 let pos
= s
.source_map
.byte_pos_to_line_and_col(span_data
.lo
);
881 let partial_span
= match &pos
{
882 Some((file_lo
, _
, _
)) => !file_lo
.contains(span_data
.hi
),
887 return TAG_PARTIAL_SPAN
.encode(s
);
890 let (file_lo
, line_lo
, col_lo
) = pos
.unwrap();
892 let len
= span_data
.hi
- span_data
.lo
;
894 let source_file_index
= s
.source_file_index(file_lo
);
896 TAG_FULL_SPAN
.encode(s
);
897 source_file_index
.encode(s
);
904 impl<'a
, 'tcx
> TyEncoder
for CacheEncoder
<'a
, 'tcx
> {
905 type I
= TyCtxt
<'tcx
>;
906 const CLEAR_CROSS_CRATE
: bool
= false;
908 fn position(&self) -> usize {
909 self.encoder
.position()
911 fn type_shorthands(&mut self) -> &mut FxHashMap
<Ty
<'tcx
>, usize> {
912 &mut self.type_shorthands
914 fn predicate_shorthands(&mut self) -> &mut FxHashMap
<ty
::PredicateKind
<'tcx
>, usize> {
915 &mut self.predicate_shorthands
917 fn encode_alloc_id(&mut self, alloc_id
: &interpret
::AllocId
) {
918 let (index
, _
) = self.interpret_allocs
.insert_full(*alloc_id
);
924 impl<'a
, 'tcx
> Encodable
<CacheEncoder
<'a
, 'tcx
>> for CrateNum
{
925 fn encode(&self, s
: &mut CacheEncoder
<'a
, 'tcx
>) {
926 s
.tcx
.stable_crate_id(*self).encode(s
);
930 impl<'a
, 'tcx
> Encodable
<CacheEncoder
<'a
, 'tcx
>> for DefId
{
931 fn encode(&self, s
: &mut CacheEncoder
<'a
, 'tcx
>) {
932 s
.tcx
.def_path_hash(*self).encode(s
);
936 impl<'a
, 'tcx
> Encodable
<CacheEncoder
<'a
, 'tcx
>> for DefIndex
{
937 fn encode(&self, _
: &mut CacheEncoder
<'a
, 'tcx
>) {
938 bug
!("encoding `DefIndex` without context");
942 macro_rules
! encoder_methods
{
943 ($
($name
:ident($ty
:ty
);)*) => {
945 $
(fn $
name(&mut self, value
: $ty
) {
946 self.encoder
.$
name(value
)
951 impl<'a
, 'tcx
> Encoder
for CacheEncoder
<'a
, 'tcx
> {
972 emit_raw_bytes(&[u8]);
976 // This ensures that the `Encodable<opaque::FileEncoder>::encode` specialization for byte slices
977 // is used when a `CacheEncoder` having an `opaque::FileEncoder` is passed to `Encodable::encode`.
978 // Unfortunately, we have to manually opt into specializations this way, given how `CacheEncoder`
979 // and the encoding traits currently work.
980 impl<'a
, 'tcx
> Encodable
<CacheEncoder
<'a
, 'tcx
>> for [u8] {
981 fn encode(&self, e
: &mut CacheEncoder
<'a
, 'tcx
>) {
982 self.encode(&mut e
.encoder
);
986 pub fn encode_query_results
<'a
, 'tcx
, CTX
, Q
>(
988 encoder
: &mut CacheEncoder
<'a
, 'tcx
>,
989 query_result_index
: &mut EncodedDepNodeIndex
,
991 CTX
: QueryContext
+ 'tcx
,
992 Q
: super::QueryDescription
<CTX
>,
993 Q
::Value
: Encodable
<CacheEncoder
<'a
, 'tcx
>>,
998 .extra_verbose_generic_activity("encode_query_results_for", std
::any
::type_name
::<Q
>());
1000 assert
!(Q
::query_state(tcx
).all_inactive());
1001 let cache
= Q
::query_cache(tcx
);
1002 cache
.iter(&mut |key
, value
, dep_node
| {
1003 if Q
::cache_on_disk(*tcx
.dep_context(), &key
) {
1004 let dep_node
= SerializedDepNodeIndex
::new(dep_node
.index());
1006 // Record position of the cache entry.
1007 query_result_index
.push((dep_node
, AbsoluteBytePos
::new(encoder
.encoder
.position())));
1009 // Encode the type check tables with the `SerializedDepNodeIndex`
1011 encoder
.encode_tagged(dep_node
, value
);