]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_metadata/src/rmeta/encoder.rs
Tweak comments.
[rust.git] / compiler / rustc_metadata / src / rmeta / encoder.rs
1 use crate::errors::{FailCreateFileEncoder, FailSeekFile, FailWriteFile};
2 use crate::rmeta::def_path_hash_map::DefPathHashMapRef;
3 use crate::rmeta::table::TableBuilder;
4 use crate::rmeta::*;
5
6 use rustc_ast::Attribute;
7 use rustc_data_structures::fingerprint::Fingerprint;
8 use rustc_data_structures::fx::{FxHashMap, FxIndexSet};
9 use rustc_data_structures::memmap::{Mmap, MmapMut};
10 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
11 use rustc_data_structures::sync::{join, par_iter, Lrc, ParallelIterator};
12 use rustc_data_structures::temp_dir::MaybeTempDir;
13 use rustc_hir as hir;
14 use rustc_hir::def::DefKind;
15 use rustc_hir::def_id::{
16     CrateNum, DefId, DefIndex, LocalDefId, CRATE_DEF_ID, CRATE_DEF_INDEX, LOCAL_CRATE,
17 };
18 use rustc_hir::definitions::DefPathData;
19 use rustc_hir::intravisit::{self, Visitor};
20 use rustc_hir::lang_items::LangItem;
21 use rustc_middle::hir::nested_filter;
22 use rustc_middle::middle::dependency_format::Linkage;
23 use rustc_middle::middle::exported_symbols::{
24     metadata_symbol_name, ExportedSymbol, SymbolExportInfo,
25 };
26 use rustc_middle::mir::interpret;
27 use rustc_middle::traits::specialization_graph;
28 use rustc_middle::ty::codec::TyEncoder;
29 use rustc_middle::ty::fast_reject::{self, SimplifiedType, TreatParams};
30 use rustc_middle::ty::query::Providers;
31 use rustc_middle::ty::{self, SymbolName, Ty, TyCtxt};
32 use rustc_middle::util::common::to_readable_str;
33 use rustc_serialize::{opaque, Decodable, Decoder, Encodable, Encoder};
34 use rustc_session::config::{CrateType, OptLevel};
35 use rustc_session::cstore::{ForeignModule, LinkagePreference, NativeLib};
36 use rustc_span::hygiene::{ExpnIndex, HygieneEncodeContext, MacroKind};
37 use rustc_span::symbol::{sym, Symbol};
38 use rustc_span::{
39     self, DebuggerVisualizerFile, ExternalSource, FileName, SourceFile, Span, SyntaxContext,
40 };
41 use std::borrow::Borrow;
42 use std::collections::hash_map::Entry;
43 use std::hash::Hash;
44 use std::io::{Read, Seek, Write};
45 use std::iter;
46 use std::num::NonZeroUsize;
47 use std::path::{Path, PathBuf};
48
49 pub(super) struct EncodeContext<'a, 'tcx> {
50     opaque: opaque::FileEncoder,
51     tcx: TyCtxt<'tcx>,
52     feat: &'tcx rustc_feature::Features,
53
54     tables: TableBuilders,
55
56     lazy_state: LazyState,
57     type_shorthands: FxHashMap<Ty<'tcx>, usize>,
58     predicate_shorthands: FxHashMap<ty::PredicateKind<'tcx>, usize>,
59
60     interpret_allocs: FxIndexSet<interpret::AllocId>,
61
62     // This is used to speed up Span encoding.
63     // The `usize` is an index into the `MonotonicVec`
64     // that stores the `SourceFile`
65     source_file_cache: (Lrc<SourceFile>, usize),
66     // The indices (into the `SourceMap`'s `MonotonicVec`)
67     // of all of the `SourceFiles` that we need to serialize.
68     // When we serialize a `Span`, we insert the index of its
69     // `SourceFile` into the `FxIndexSet`.
70     // The order inside the `FxIndexSet` is used as on-disk
71     // order of `SourceFiles`, and encoded inside `Span`s.
72     required_source_files: Option<FxIndexSet<usize>>,
73     is_proc_macro: bool,
74     hygiene_ctxt: &'a HygieneEncodeContext,
75     symbol_table: FxHashMap<Symbol, usize>,
76 }
77
78 /// If the current crate is a proc-macro, returns early with `LazyArray::empty()`.
79 /// This is useful for skipping the encoding of things that aren't needed
80 /// for proc-macro crates.
81 macro_rules! empty_proc_macro {
82     ($self:ident) => {
83         if $self.is_proc_macro {
84             return LazyArray::empty();
85         }
86     };
87 }
88
89 macro_rules! encoder_methods {
90     ($($name:ident($ty:ty);)*) => {
91         $(fn $name(&mut self, value: $ty) {
92             self.opaque.$name(value)
93         })*
94     }
95 }
96
97 impl<'a, 'tcx> Encoder for EncodeContext<'a, 'tcx> {
98     encoder_methods! {
99         emit_usize(usize);
100         emit_u128(u128);
101         emit_u64(u64);
102         emit_u32(u32);
103         emit_u16(u16);
104         emit_u8(u8);
105
106         emit_isize(isize);
107         emit_i128(i128);
108         emit_i64(i64);
109         emit_i32(i32);
110         emit_i16(i16);
111         emit_i8(i8);
112
113         emit_bool(bool);
114         emit_f64(f64);
115         emit_f32(f32);
116         emit_char(char);
117         emit_str(&str);
118         emit_raw_bytes(&[u8]);
119     }
120 }
121
122 impl<'a, 'tcx, T> Encodable<EncodeContext<'a, 'tcx>> for LazyValue<T> {
123     fn encode(&self, e: &mut EncodeContext<'a, 'tcx>) {
124         e.emit_lazy_distance(self.position);
125     }
126 }
127
128 impl<'a, 'tcx, T> Encodable<EncodeContext<'a, 'tcx>> for LazyArray<T> {
129     fn encode(&self, e: &mut EncodeContext<'a, 'tcx>) {
130         e.emit_usize(self.num_elems);
131         if self.num_elems > 0 {
132             e.emit_lazy_distance(self.position)
133         }
134     }
135 }
136
137 impl<'a, 'tcx, I, T> Encodable<EncodeContext<'a, 'tcx>> for LazyTable<I, T> {
138     fn encode(&self, e: &mut EncodeContext<'a, 'tcx>) {
139         e.emit_usize(self.encoded_size);
140         e.emit_lazy_distance(self.position);
141     }
142 }
143
144 impl<'a, 'tcx> Encodable<EncodeContext<'a, 'tcx>> for CrateNum {
145     fn encode(&self, s: &mut EncodeContext<'a, 'tcx>) {
146         if *self != LOCAL_CRATE && s.is_proc_macro {
147             panic!("Attempted to encode non-local CrateNum {self:?} for proc-macro crate");
148         }
149         s.emit_u32(self.as_u32());
150     }
151 }
152
153 impl<'a, 'tcx> Encodable<EncodeContext<'a, 'tcx>> for DefIndex {
154     fn encode(&self, s: &mut EncodeContext<'a, 'tcx>) {
155         s.emit_u32(self.as_u32());
156     }
157 }
158
159 impl<'a, 'tcx> Encodable<EncodeContext<'a, 'tcx>> for ExpnIndex {
160     fn encode(&self, s: &mut EncodeContext<'a, 'tcx>) {
161         s.emit_u32(self.as_u32());
162     }
163 }
164
165 impl<'a, 'tcx> Encodable<EncodeContext<'a, 'tcx>> for SyntaxContext {
166     fn encode(&self, s: &mut EncodeContext<'a, 'tcx>) {
167         rustc_span::hygiene::raw_encode_syntax_context(*self, &s.hygiene_ctxt, s);
168     }
169 }
170
171 impl<'a, 'tcx> Encodable<EncodeContext<'a, 'tcx>> for ExpnId {
172     fn encode(&self, s: &mut EncodeContext<'a, 'tcx>) {
173         if self.krate == LOCAL_CRATE {
174             // We will only write details for local expansions. Non-local expansions will fetch
175             // data from the corresponding crate's metadata.
176             // FIXME(#43047) FIXME(#74731) We may eventually want to avoid relying on external
177             // metadata from proc-macro crates.
178             s.hygiene_ctxt.schedule_expn_data_for_encoding(*self);
179         }
180         self.krate.encode(s);
181         self.local_id.encode(s);
182     }
183 }
184
185 impl<'a, 'tcx> Encodable<EncodeContext<'a, 'tcx>> for Span {
186     fn encode(&self, s: &mut EncodeContext<'a, 'tcx>) {
187         let span = self.data();
188
189         // Don't serialize any `SyntaxContext`s from a proc-macro crate,
190         // since we don't load proc-macro dependencies during serialization.
191         // This means that any hygiene information from macros used *within*
192         // a proc-macro crate (e.g. invoking a macro that expands to a proc-macro
193         // definition) will be lost.
194         //
195         // This can show up in two ways:
196         //
197         // 1. Any hygiene information associated with identifier of
198         // a proc macro (e.g. `#[proc_macro] pub fn $name`) will be lost.
199         // Since proc-macros can only be invoked from a different crate,
200         // real code should never need to care about this.
201         //
202         // 2. Using `Span::def_site` or `Span::mixed_site` will not
203         // include any hygiene information associated with the definition
204         // site. This means that a proc-macro cannot emit a `$crate`
205         // identifier which resolves to one of its dependencies,
206         // which also should never come up in practice.
207         //
208         // Additionally, this affects `Span::parent`, and any other
209         // span inspection APIs that would otherwise allow traversing
210         // the `SyntaxContexts` associated with a span.
211         //
212         // None of these user-visible effects should result in any
213         // cross-crate inconsistencies (getting one behavior in the same
214         // crate, and a different behavior in another crate) due to the
215         // limited surface that proc-macros can expose.
216         //
217         // IMPORTANT: If this is ever changed, be sure to update
218         // `rustc_span::hygiene::raw_encode_expn_id` to handle
219         // encoding `ExpnData` for proc-macro crates.
220         if s.is_proc_macro {
221             SyntaxContext::root().encode(s);
222         } else {
223             span.ctxt.encode(s);
224         }
225
226         if self.is_dummy() {
227             return TAG_PARTIAL_SPAN.encode(s);
228         }
229
230         // The Span infrastructure should make sure that this invariant holds:
231         debug_assert!(span.lo <= span.hi);
232
233         if !s.source_file_cache.0.contains(span.lo) {
234             let source_map = s.tcx.sess.source_map();
235             let source_file_index = source_map.lookup_source_file_idx(span.lo);
236             s.source_file_cache =
237                 (source_map.files()[source_file_index].clone(), source_file_index);
238         }
239         let (ref source_file, source_file_index) = s.source_file_cache;
240         debug_assert!(source_file.contains(span.lo));
241
242         if !source_file.contains(span.hi) {
243             // Unfortunately, macro expansion still sometimes generates Spans
244             // that malformed in this way.
245             return TAG_PARTIAL_SPAN.encode(s);
246         }
247
248         // There are two possible cases here:
249         // 1. This span comes from a 'foreign' crate - e.g. some crate upstream of the
250         // crate we are writing metadata for. When the metadata for *this* crate gets
251         // deserialized, the deserializer will need to know which crate it originally came
252         // from. We use `TAG_VALID_SPAN_FOREIGN` to indicate that a `CrateNum` should
253         // be deserialized after the rest of the span data, which tells the deserializer
254         // which crate contains the source map information.
255         // 2. This span comes from our own crate. No special handling is needed - we just
256         // write `TAG_VALID_SPAN_LOCAL` to let the deserializer know that it should use
257         // our own source map information.
258         //
259         // If we're a proc-macro crate, we always treat this as a local `Span`.
260         // In `encode_source_map`, we serialize foreign `SourceFile`s into our metadata
261         // if we're a proc-macro crate.
262         // This allows us to avoid loading the dependencies of proc-macro crates: all of
263         // the information we need to decode `Span`s is stored in the proc-macro crate.
264         let (tag, metadata_index) = if source_file.is_imported() && !s.is_proc_macro {
265             // To simplify deserialization, we 'rebase' this span onto the crate it originally came
266             // from (the crate that 'owns' the file it references. These rebased 'lo' and 'hi'
267             // values are relative to the source map information for the 'foreign' crate whose
268             // CrateNum we write into the metadata. This allows `imported_source_files` to binary
269             // search through the 'foreign' crate's source map information, using the
270             // deserialized 'lo' and 'hi' values directly.
271             //
272             // All of this logic ensures that the final result of deserialization is a 'normal'
273             // Span that can be used without any additional trouble.
274             let metadata_index = {
275                 // Introduce a new scope so that we drop the 'lock()' temporary
276                 match &*source_file.external_src.lock() {
277                     ExternalSource::Foreign { metadata_index, .. } => *metadata_index,
278                     src => panic!("Unexpected external source {src:?}"),
279                 }
280             };
281
282             (TAG_VALID_SPAN_FOREIGN, metadata_index)
283         } else {
284             // Record the fact that we need to encode the data for this `SourceFile`
285             let source_files =
286                 s.required_source_files.as_mut().expect("Already encoded SourceMap!");
287             let (metadata_index, _) = source_files.insert_full(source_file_index);
288             let metadata_index: u32 =
289                 metadata_index.try_into().expect("cannot export more than U32_MAX files");
290
291             (TAG_VALID_SPAN_LOCAL, metadata_index)
292         };
293
294         // Encode the start position relative to the file start, so we profit more from the
295         // variable-length integer encoding.
296         let lo = span.lo - source_file.start_pos;
297
298         // Encode length which is usually less than span.hi and profits more
299         // from the variable-length integer encoding that we use.
300         let len = span.hi - span.lo;
301
302         tag.encode(s);
303         lo.encode(s);
304         len.encode(s);
305
306         // Encode the index of the `SourceFile` for the span, in order to make decoding faster.
307         metadata_index.encode(s);
308
309         if tag == TAG_VALID_SPAN_FOREIGN {
310             // This needs to be two lines to avoid holding the `s.source_file_cache`
311             // while calling `cnum.encode(s)`
312             let cnum = s.source_file_cache.0.cnum;
313             cnum.encode(s);
314         }
315     }
316 }
317
318 impl<'a, 'tcx> Encodable<EncodeContext<'a, 'tcx>> for Symbol {
319     fn encode(&self, s: &mut EncodeContext<'a, 'tcx>) {
320         // if symbol preinterned, emit tag and symbol index
321         if self.is_preinterned() {
322             s.opaque.emit_u8(SYMBOL_PREINTERNED);
323             s.opaque.emit_u32(self.as_u32());
324         } else {
325             // otherwise write it as string or as offset to it
326             match s.symbol_table.entry(*self) {
327                 Entry::Vacant(o) => {
328                     s.opaque.emit_u8(SYMBOL_STR);
329                     let pos = s.opaque.position();
330                     o.insert(pos);
331                     s.emit_str(self.as_str());
332                 }
333                 Entry::Occupied(o) => {
334                     let x = *o.get();
335                     s.emit_u8(SYMBOL_OFFSET);
336                     s.emit_usize(x);
337                 }
338             }
339         }
340     }
341 }
342
343 impl<'a, 'tcx> TyEncoder for EncodeContext<'a, 'tcx> {
344     const CLEAR_CROSS_CRATE: bool = true;
345
346     type I = TyCtxt<'tcx>;
347
348     fn position(&self) -> usize {
349         self.opaque.position()
350     }
351
352     fn type_shorthands(&mut self) -> &mut FxHashMap<Ty<'tcx>, usize> {
353         &mut self.type_shorthands
354     }
355
356     fn predicate_shorthands(&mut self) -> &mut FxHashMap<ty::PredicateKind<'tcx>, usize> {
357         &mut self.predicate_shorthands
358     }
359
360     fn encode_alloc_id(&mut self, alloc_id: &rustc_middle::mir::interpret::AllocId) {
361         let (index, _) = self.interpret_allocs.insert_full(*alloc_id);
362
363         index.encode(self);
364     }
365 }
366
367 // Shorthand for `$self.$tables.$table.set($def_id.index, $self.lazy_value($value))`, which would
368 // normally need extra variables to avoid errors about multiple mutable borrows.
369 macro_rules! record {
370     ($self:ident.$tables:ident.$table:ident[$def_id:expr] <- $value:expr) => {{
371         {
372             let value = $value;
373             let lazy = $self.lazy(value);
374             $self.$tables.$table.set($def_id.index, lazy);
375         }
376     }};
377 }
378
379 // Shorthand for `$self.$tables.$table.set($def_id.index, $self.lazy_value($value))`, which would
380 // normally need extra variables to avoid errors about multiple mutable borrows.
381 macro_rules! record_array {
382     ($self:ident.$tables:ident.$table:ident[$def_id:expr] <- $value:expr) => {{
383         {
384             let value = $value;
385             let lazy = $self.lazy_array(value);
386             $self.$tables.$table.set($def_id.index, lazy);
387         }
388     }};
389 }
390
391 impl<'a, 'tcx> EncodeContext<'a, 'tcx> {
392     fn emit_lazy_distance(&mut self, position: NonZeroUsize) {
393         let pos = position.get();
394         let distance = match self.lazy_state {
395             LazyState::NoNode => bug!("emit_lazy_distance: outside of a metadata node"),
396             LazyState::NodeStart(start) => {
397                 let start = start.get();
398                 assert!(pos <= start);
399                 start - pos
400             }
401             LazyState::Previous(last_pos) => {
402                 assert!(
403                     last_pos <= position,
404                     "make sure that the calls to `lazy*` \
405                      are in the same order as the metadata fields",
406                 );
407                 position.get() - last_pos.get()
408             }
409         };
410         self.lazy_state = LazyState::Previous(NonZeroUsize::new(pos).unwrap());
411         self.emit_usize(distance);
412     }
413
414     fn lazy<T: ParameterizedOverTcx, B: Borrow<T::Value<'tcx>>>(&mut self, value: B) -> LazyValue<T>
415     where
416         T::Value<'tcx>: Encodable<EncodeContext<'a, 'tcx>>,
417     {
418         let pos = NonZeroUsize::new(self.position()).unwrap();
419
420         assert_eq!(self.lazy_state, LazyState::NoNode);
421         self.lazy_state = LazyState::NodeStart(pos);
422         value.borrow().encode(self);
423         self.lazy_state = LazyState::NoNode;
424
425         assert!(pos.get() <= self.position());
426
427         LazyValue::from_position(pos)
428     }
429
430     fn lazy_array<T: ParameterizedOverTcx, I: IntoIterator<Item = B>, B: Borrow<T::Value<'tcx>>>(
431         &mut self,
432         values: I,
433     ) -> LazyArray<T>
434     where
435         T::Value<'tcx>: Encodable<EncodeContext<'a, 'tcx>>,
436     {
437         let pos = NonZeroUsize::new(self.position()).unwrap();
438
439         assert_eq!(self.lazy_state, LazyState::NoNode);
440         self.lazy_state = LazyState::NodeStart(pos);
441         let len = values.into_iter().map(|value| value.borrow().encode(self)).count();
442         self.lazy_state = LazyState::NoNode;
443
444         assert!(pos.get() <= self.position());
445
446         LazyArray::from_position_and_num_elems(pos, len)
447     }
448
449     fn encode_info_for_items(&mut self) {
450         self.encode_info_for_mod(CRATE_DEF_ID, self.tcx.hir().root_module());
451
452         // Proc-macro crates only export proc-macro items, which are looked
453         // up using `proc_macro_data`
454         if self.is_proc_macro {
455             return;
456         }
457
458         self.tcx.hir().visit_all_item_likes_in_crate(self);
459     }
460
461     fn encode_def_path_table(&mut self) {
462         let table = self.tcx.def_path_table();
463         if self.is_proc_macro {
464             for def_index in std::iter::once(CRATE_DEF_INDEX)
465                 .chain(self.tcx.resolutions(()).proc_macros.iter().map(|p| p.local_def_index))
466             {
467                 let def_key = self.lazy(table.def_key(def_index));
468                 let def_path_hash = table.def_path_hash(def_index);
469                 self.tables.def_keys.set(def_index, def_key);
470                 self.tables.def_path_hashes.set(def_index, def_path_hash);
471             }
472         } else {
473             for (def_index, def_key, def_path_hash) in table.enumerated_keys_and_path_hashes() {
474                 let def_key = self.lazy(def_key);
475                 self.tables.def_keys.set(def_index, def_key);
476                 self.tables.def_path_hashes.set(def_index, *def_path_hash);
477             }
478         }
479     }
480
481     fn encode_def_path_hash_map(&mut self) -> LazyValue<DefPathHashMapRef<'static>> {
482         self.lazy(DefPathHashMapRef::BorrowedFromTcx(self.tcx.def_path_hash_to_def_index_map()))
483     }
484
485     fn encode_source_map(&mut self) -> LazyTable<u32, LazyValue<rustc_span::SourceFile>> {
486         let source_map = self.tcx.sess.source_map();
487         let all_source_files = source_map.files();
488
489         // By replacing the `Option` with `None`, we ensure that we can't
490         // accidentally serialize any more `Span`s after the source map encoding
491         // is done.
492         let required_source_files = self.required_source_files.take().unwrap();
493
494         let working_directory = &self.tcx.sess.opts.working_dir;
495
496         let mut adapted = TableBuilder::default();
497
498         // Only serialize `SourceFile`s that were used during the encoding of a `Span`.
499         //
500         // The order in which we encode source files is important here: the on-disk format for
501         // `Span` contains the index of the corresponding `SourceFile`.
502         for (on_disk_index, &source_file_index) in required_source_files.iter().enumerate() {
503             let source_file = &all_source_files[source_file_index];
504             // Don't serialize imported `SourceFile`s, unless we're in a proc-macro crate.
505             assert!(!source_file.is_imported() || self.is_proc_macro);
506
507             // At export time we expand all source file paths to absolute paths because
508             // downstream compilation sessions can have a different compiler working
509             // directory, so relative paths from this or any other upstream crate
510             // won't be valid anymore.
511             //
512             // At this point we also erase the actual on-disk path and only keep
513             // the remapped version -- as is necessary for reproducible builds.
514             let mut source_file = match source_file.name {
515                 FileName::Real(ref original_file_name) => {
516                     let adapted_file_name = source_map
517                         .path_mapping()
518                         .to_embeddable_absolute_path(original_file_name.clone(), working_directory);
519
520                     if adapted_file_name != *original_file_name {
521                         let mut adapted: SourceFile = (**source_file).clone();
522                         adapted.name = FileName::Real(adapted_file_name);
523                         adapted.name_hash = {
524                             let mut hasher: StableHasher = StableHasher::new();
525                             adapted.name.hash(&mut hasher);
526                             hasher.finish::<u128>()
527                         };
528                         Lrc::new(adapted)
529                     } else {
530                         // Nothing to adapt
531                         source_file.clone()
532                     }
533                 }
534                 // expanded code, not from a file
535                 _ => source_file.clone(),
536             };
537
538             // We're serializing this `SourceFile` into our crate metadata,
539             // so mark it as coming from this crate.
540             // This also ensures that we don't try to deserialize the
541             // `CrateNum` for a proc-macro dependency - since proc macro
542             // dependencies aren't loaded when we deserialize a proc-macro,
543             // trying to remap the `CrateNum` would fail.
544             if self.is_proc_macro {
545                 Lrc::make_mut(&mut source_file).cnum = LOCAL_CRATE;
546             }
547
548             let on_disk_index: u32 =
549                 on_disk_index.try_into().expect("cannot export more than U32_MAX files");
550             adapted.set(on_disk_index, self.lazy(source_file));
551         }
552
553         adapted.encode(&mut self.opaque)
554     }
555
556     fn encode_crate_root(&mut self) -> LazyValue<CrateRoot> {
557         let tcx = self.tcx;
558         let mut stats: Vec<(&'static str, usize)> = Vec::with_capacity(32);
559
560         macro_rules! stat {
561             ($label:literal, $f:expr) => {{
562                 let orig_pos = self.position();
563                 let res = $f();
564                 stats.push(($label, self.position() - orig_pos));
565                 res
566             }};
567         }
568
569         // We have already encoded some things. Get their combined size from the current position.
570         stats.push(("preamble", self.position()));
571
572         let (crate_deps, dylib_dependency_formats) =
573             stat!("dep", || (self.encode_crate_deps(), self.encode_dylib_dependency_formats()));
574
575         let lib_features = stat!("lib-features", || self.encode_lib_features());
576
577         let stability_implications =
578             stat!("stability-implications", || self.encode_stability_implications());
579
580         let (lang_items, lang_items_missing) = stat!("lang-items", || {
581             (self.encode_lang_items(), self.encode_lang_items_missing())
582         });
583
584         let diagnostic_items = stat!("diagnostic-items", || self.encode_diagnostic_items());
585
586         let native_libraries = stat!("native-libs", || self.encode_native_libraries());
587
588         let foreign_modules = stat!("foreign-modules", || self.encode_foreign_modules());
589
590         _ = stat!("def-path-table", || self.encode_def_path_table());
591
592         // Encode the def IDs of traits, for rustdoc and diagnostics.
593         let traits = stat!("traits", || self.encode_traits());
594
595         // Encode the def IDs of impls, for coherence checking.
596         let impls = stat!("impls", || self.encode_impls());
597
598         let incoherent_impls = stat!("incoherent-impls", || self.encode_incoherent_impls());
599
600         _ = stat!("mir", || self.encode_mir());
601
602         _ = stat!("items", || {
603             self.encode_def_ids();
604             self.encode_info_for_items();
605         });
606
607         let interpret_alloc_index = stat!("interpret-alloc-index", || {
608             let mut interpret_alloc_index = Vec::new();
609             let mut n = 0;
610             trace!("beginning to encode alloc ids");
611             loop {
612                 let new_n = self.interpret_allocs.len();
613                 // if we have found new ids, serialize those, too
614                 if n == new_n {
615                     // otherwise, abort
616                     break;
617                 }
618                 trace!("encoding {} further alloc ids", new_n - n);
619                 for idx in n..new_n {
620                     let id = self.interpret_allocs[idx];
621                     let pos = self.position() as u32;
622                     interpret_alloc_index.push(pos);
623                     interpret::specialized_encode_alloc_id(self, tcx, id);
624                 }
625                 n = new_n;
626             }
627             self.lazy_array(interpret_alloc_index)
628         });
629
630         // Encode the proc macro data. This affects `tables`, so we need to do this before we
631         // encode the tables. This overwrites def_keys, so it must happen after
632         // encode_def_path_table.
633         let proc_macro_data = stat!("proc-macro-data", || self.encode_proc_macros());
634
635         let tables = stat!("tables", || self.tables.encode(&mut self.opaque));
636
637         let debugger_visualizers =
638             stat!("debugger-visualizers", || self.encode_debugger_visualizers());
639
640         // Encode exported symbols info. This is prefetched in `encode_metadata` so we encode
641         // this as late as possible to give the prefetching as much time as possible to complete.
642         let exported_symbols = stat!("exported-symbols", || {
643             self.encode_exported_symbols(&tcx.exported_symbols(LOCAL_CRATE))
644         });
645
646         // Encode the hygiene data.
647         // IMPORTANT: this *must* be the last thing that we encode (other than `SourceMap`). The
648         // process of encoding other items (e.g. `optimized_mir`) may cause us to load data from
649         // the incremental cache. If this causes us to deserialize a `Span`, then we may load
650         // additional `SyntaxContext`s into the global `HygieneData`. Therefore, we need to encode
651         // the hygiene data last to ensure that we encode any `SyntaxContext`s that might be used.
652         let (syntax_contexts, expn_data, expn_hashes) = stat!("hygiene", || self.encode_hygiene());
653
654         let def_path_hash_map = stat!("def-path-hash-map", || self.encode_def_path_hash_map());
655
656         // Encode source_map. This needs to be done last, because encoding `Span`s tells us which
657         // `SourceFiles` we actually need to encode.
658         let source_map = stat!("source-map", || self.encode_source_map());
659
660         let root = stat!("final", || {
661             let attrs = tcx.hir().krate_attrs();
662             self.lazy(CrateRoot {
663                 name: tcx.crate_name(LOCAL_CRATE),
664                 extra_filename: tcx.sess.opts.cg.extra_filename.clone(),
665                 triple: tcx.sess.opts.target_triple.clone(),
666                 hash: tcx.crate_hash(LOCAL_CRATE),
667                 stable_crate_id: tcx.def_path_hash(LOCAL_CRATE.as_def_id()).stable_crate_id(),
668                 required_panic_strategy: tcx.required_panic_strategy(LOCAL_CRATE),
669                 panic_in_drop_strategy: tcx.sess.opts.unstable_opts.panic_in_drop,
670                 edition: tcx.sess.edition(),
671                 has_global_allocator: tcx.has_global_allocator(LOCAL_CRATE),
672                 has_alloc_error_handler: tcx.has_alloc_error_handler(LOCAL_CRATE),
673                 has_panic_handler: tcx.has_panic_handler(LOCAL_CRATE),
674                 has_default_lib_allocator: tcx
675                     .sess
676                     .contains_name(&attrs, sym::default_lib_allocator),
677                 proc_macro_data,
678                 debugger_visualizers,
679                 compiler_builtins: tcx.sess.contains_name(&attrs, sym::compiler_builtins),
680                 needs_allocator: tcx.sess.contains_name(&attrs, sym::needs_allocator),
681                 needs_panic_runtime: tcx.sess.contains_name(&attrs, sym::needs_panic_runtime),
682                 no_builtins: tcx.sess.contains_name(&attrs, sym::no_builtins),
683                 panic_runtime: tcx.sess.contains_name(&attrs, sym::panic_runtime),
684                 profiler_runtime: tcx.sess.contains_name(&attrs, sym::profiler_runtime),
685                 symbol_mangling_version: tcx.sess.opts.get_symbol_mangling_version(),
686
687                 crate_deps,
688                 dylib_dependency_formats,
689                 lib_features,
690                 stability_implications,
691                 lang_items,
692                 diagnostic_items,
693                 lang_items_missing,
694                 native_libraries,
695                 foreign_modules,
696                 source_map,
697                 traits,
698                 impls,
699                 incoherent_impls,
700                 exported_symbols,
701                 interpret_alloc_index,
702                 tables,
703                 syntax_contexts,
704                 expn_data,
705                 expn_hashes,
706                 def_path_hash_map,
707             })
708         });
709
710         let total_bytes = self.position();
711
712         let computed_total_bytes: usize = stats.iter().map(|(_, size)| size).sum();
713         assert_eq!(total_bytes, computed_total_bytes);
714
715         if tcx.sess.opts.unstable_opts.meta_stats {
716             self.opaque.flush();
717
718             // Rewind and re-read all the metadata to count the zero bytes we wrote.
719             let pos_before_rewind = self.opaque.file().stream_position().unwrap();
720             let mut zero_bytes = 0;
721             self.opaque.file().rewind().unwrap();
722             let file = std::io::BufReader::new(self.opaque.file());
723             for e in file.bytes() {
724                 if e.unwrap() == 0 {
725                     zero_bytes += 1;
726                 }
727             }
728             assert_eq!(self.opaque.file().stream_position().unwrap(), pos_before_rewind);
729
730             stats.sort_by_key(|&(_, usize)| usize);
731
732             let prefix = "meta-stats";
733             let perc = |bytes| (bytes * 100) as f64 / total_bytes as f64;
734
735             eprintln!("{prefix} METADATA STATS");
736             eprintln!("{} {:<23}{:>10}", prefix, "Section", "Size");
737             eprintln!("{prefix} ----------------------------------------------------------------");
738             for (label, size) in stats {
739                 eprintln!(
740                     "{} {:<23}{:>10} ({:4.1}%)",
741                     prefix,
742                     label,
743                     to_readable_str(size),
744                     perc(size)
745                 );
746             }
747             eprintln!("{prefix} ----------------------------------------------------------------");
748             eprintln!(
749                 "{} {:<23}{:>10} (of which {:.1}% are zero bytes)",
750                 prefix,
751                 "Total",
752                 to_readable_str(total_bytes),
753                 perc(zero_bytes)
754             );
755             eprintln!("{prefix}");
756         }
757
758         root
759     }
760 }
761
762 /// Returns whether an attribute needs to be recorded in metadata, that is, if it's usable and
763 /// useful in downstream crates. Local-only attributes are an obvious example, but some
764 /// rustdoc-specific attributes can equally be of use while documenting the current crate only.
765 ///
766 /// Removing these superfluous attributes speeds up compilation by making the metadata smaller.
767 ///
768 /// Note: the `is_def_id_public` parameter is used to cache whether the given `DefId` has a public
769 /// visibility: this is a piece of data that can be computed once per defid, and not once per
770 /// attribute. Some attributes would only be usable downstream if they are public.
771 #[inline]
772 fn should_encode_attr(
773     tcx: TyCtxt<'_>,
774     attr: &Attribute,
775     def_id: LocalDefId,
776     is_def_id_public: &mut Option<bool>,
777 ) -> bool {
778     if rustc_feature::is_builtin_only_local(attr.name_or_empty()) {
779         // Attributes marked local-only don't need to be encoded for downstream crates.
780         false
781     } else if attr.doc_str().is_some() {
782         // We keep all public doc comments because they might be "imported" into downstream crates
783         // if they use `#[doc(inline)]` to copy an item's documentation into their own.
784         *is_def_id_public.get_or_insert_with(|| tcx.effective_visibilities(()).is_exported(def_id))
785     } else if attr.has_name(sym::doc) {
786         // If this is a `doc` attribute, and it's marked `inline` (as in `#[doc(inline)]`), we can
787         // remove it. It won't be inlinable in downstream crates.
788         attr.meta_item_list().map(|l| l.iter().any(|l| !l.has_name(sym::inline))).unwrap_or(false)
789     } else {
790         true
791     }
792 }
793
794 fn should_encode_visibility(def_kind: DefKind) -> bool {
795     match def_kind {
796         DefKind::Mod
797         | DefKind::Struct
798         | DefKind::Union
799         | DefKind::Enum
800         | DefKind::Variant
801         | DefKind::Trait
802         | DefKind::TyAlias
803         | DefKind::ForeignTy
804         | DefKind::TraitAlias
805         | DefKind::AssocTy
806         | DefKind::Fn
807         | DefKind::Const
808         | DefKind::Static(..)
809         | DefKind::Ctor(..)
810         | DefKind::AssocFn
811         | DefKind::AssocConst
812         | DefKind::Macro(..)
813         | DefKind::Use
814         | DefKind::ForeignMod
815         | DefKind::OpaqueTy
816         | DefKind::ImplTraitPlaceholder
817         | DefKind::Impl
818         | DefKind::Field => true,
819         DefKind::TyParam
820         | DefKind::ConstParam
821         | DefKind::LifetimeParam
822         | DefKind::AnonConst
823         | DefKind::InlineConst
824         | DefKind::GlobalAsm
825         | DefKind::Closure
826         | DefKind::Generator
827         | DefKind::ExternCrate => false,
828     }
829 }
830
831 fn should_encode_stability(def_kind: DefKind) -> bool {
832     match def_kind {
833         DefKind::Mod
834         | DefKind::Ctor(..)
835         | DefKind::Variant
836         | DefKind::Field
837         | DefKind::Struct
838         | DefKind::AssocTy
839         | DefKind::AssocFn
840         | DefKind::AssocConst
841         | DefKind::TyParam
842         | DefKind::ConstParam
843         | DefKind::Static(..)
844         | DefKind::Const
845         | DefKind::Fn
846         | DefKind::ForeignMod
847         | DefKind::TyAlias
848         | DefKind::OpaqueTy
849         | DefKind::ImplTraitPlaceholder
850         | DefKind::Enum
851         | DefKind::Union
852         | DefKind::Impl
853         | DefKind::Trait
854         | DefKind::TraitAlias
855         | DefKind::Macro(..)
856         | DefKind::ForeignTy => true,
857         DefKind::Use
858         | DefKind::LifetimeParam
859         | DefKind::AnonConst
860         | DefKind::InlineConst
861         | DefKind::GlobalAsm
862         | DefKind::Closure
863         | DefKind::Generator
864         | DefKind::ExternCrate => false,
865     }
866 }
867
868 /// Whether we should encode MIR.
869 ///
870 /// Computing, optimizing and encoding the MIR is a relatively expensive operation.
871 /// We want to avoid this work when not required. Therefore:
872 /// - we only compute `mir_for_ctfe` on items with const-eval semantics;
873 /// - we skip `optimized_mir` for check runs.
874 ///
875 /// Return a pair, resp. for CTFE and for LLVM.
876 fn should_encode_mir(tcx: TyCtxt<'_>, def_id: LocalDefId) -> (bool, bool) {
877     match tcx.def_kind(def_id) {
878         // Constructors
879         DefKind::Ctor(_, _) => {
880             let mir_opt_base = tcx.sess.opts.output_types.should_codegen()
881                 || tcx.sess.opts.unstable_opts.always_encode_mir;
882             (true, mir_opt_base)
883         }
884         // Constants
885         DefKind::AnonConst
886         | DefKind::InlineConst
887         | DefKind::AssocConst
888         | DefKind::Static(..)
889         | DefKind::Const => (true, false),
890         // Full-fledged functions + closures
891         DefKind::AssocFn | DefKind::Fn | DefKind::Closure => {
892             let generics = tcx.generics_of(def_id);
893             let needs_inline = (generics.requires_monomorphization(tcx)
894                 || tcx.codegen_fn_attrs(def_id).requests_inline())
895                 && tcx.sess.opts.output_types.should_codegen();
896             // The function has a `const` modifier or is in a `#[const_trait]`.
897             let is_const_fn = tcx.is_const_fn_raw(def_id.to_def_id())
898                 || tcx.is_const_default_method(def_id.to_def_id());
899             let always_encode_mir = tcx.sess.opts.unstable_opts.always_encode_mir;
900             (is_const_fn, needs_inline || always_encode_mir)
901         }
902         // Generators require optimized MIR to compute layout.
903         DefKind::Generator => (false, true),
904         // The others don't have MIR.
905         _ => (false, false),
906     }
907 }
908
909 fn should_encode_variances(def_kind: DefKind) -> bool {
910     match def_kind {
911         DefKind::Struct
912         | DefKind::Union
913         | DefKind::Enum
914         | DefKind::Variant
915         | DefKind::OpaqueTy
916         | DefKind::ImplTraitPlaceholder
917         | DefKind::Fn
918         | DefKind::Ctor(..)
919         | DefKind::AssocFn => true,
920         DefKind::Mod
921         | DefKind::Field
922         | DefKind::AssocTy
923         | DefKind::AssocConst
924         | DefKind::TyParam
925         | DefKind::ConstParam
926         | DefKind::Static(..)
927         | DefKind::Const
928         | DefKind::ForeignMod
929         | DefKind::TyAlias
930         | DefKind::Impl
931         | DefKind::Trait
932         | DefKind::TraitAlias
933         | DefKind::Macro(..)
934         | DefKind::ForeignTy
935         | DefKind::Use
936         | DefKind::LifetimeParam
937         | DefKind::AnonConst
938         | DefKind::InlineConst
939         | DefKind::GlobalAsm
940         | DefKind::Closure
941         | DefKind::Generator
942         | DefKind::ExternCrate => false,
943     }
944 }
945
946 fn should_encode_generics(def_kind: DefKind) -> bool {
947     match def_kind {
948         DefKind::Struct
949         | DefKind::Union
950         | DefKind::Enum
951         | DefKind::Variant
952         | DefKind::Trait
953         | DefKind::TyAlias
954         | DefKind::ForeignTy
955         | DefKind::TraitAlias
956         | DefKind::AssocTy
957         | DefKind::Fn
958         | DefKind::Const
959         | DefKind::Static(..)
960         | DefKind::Ctor(..)
961         | DefKind::AssocFn
962         | DefKind::AssocConst
963         | DefKind::AnonConst
964         | DefKind::InlineConst
965         | DefKind::OpaqueTy
966         | DefKind::ImplTraitPlaceholder
967         | DefKind::Impl
968         | DefKind::Field
969         | DefKind::TyParam
970         | DefKind::Closure
971         | DefKind::Generator => true,
972         DefKind::Mod
973         | DefKind::ForeignMod
974         | DefKind::ConstParam
975         | DefKind::Macro(..)
976         | DefKind::Use
977         | DefKind::LifetimeParam
978         | DefKind::GlobalAsm
979         | DefKind::ExternCrate => false,
980     }
981 }
982
983 fn should_encode_type(tcx: TyCtxt<'_>, def_id: LocalDefId, def_kind: DefKind) -> bool {
984     match def_kind {
985         DefKind::Struct
986         | DefKind::Union
987         | DefKind::Enum
988         | DefKind::Variant
989         | DefKind::Ctor(..)
990         | DefKind::Field
991         | DefKind::Fn
992         | DefKind::Const
993         | DefKind::Static(..)
994         | DefKind::TyAlias
995         | DefKind::OpaqueTy
996         | DefKind::ForeignTy
997         | DefKind::Impl
998         | DefKind::AssocFn
999         | DefKind::AssocConst
1000         | DefKind::Closure
1001         | DefKind::Generator
1002         | DefKind::ConstParam
1003         | DefKind::AnonConst
1004         | DefKind::InlineConst => true,
1005
1006         DefKind::ImplTraitPlaceholder => {
1007             let parent_def_id = tcx.impl_trait_in_trait_parent(def_id.to_def_id());
1008             let assoc_item = tcx.associated_item(parent_def_id);
1009             match assoc_item.container {
1010                 // Always encode an RPIT in an impl fn, since it always has a body
1011                 ty::AssocItemContainer::ImplContainer => true,
1012                 ty::AssocItemContainer::TraitContainer => {
1013                     // Encode an RPIT for a trait only if the trait has a default body
1014                     assoc_item.defaultness(tcx).has_value()
1015                 }
1016             }
1017         }
1018
1019         DefKind::AssocTy => {
1020             let assoc_item = tcx.associated_item(def_id);
1021             match assoc_item.container {
1022                 ty::AssocItemContainer::ImplContainer => true,
1023                 ty::AssocItemContainer::TraitContainer => assoc_item.defaultness(tcx).has_value(),
1024             }
1025         }
1026         DefKind::TyParam => {
1027             let hir::Node::GenericParam(param) = tcx.hir().get_by_def_id(def_id) else { bug!() };
1028             let hir::GenericParamKind::Type { default, .. } = param.kind else { bug!() };
1029             default.is_some()
1030         }
1031
1032         DefKind::Trait
1033         | DefKind::TraitAlias
1034         | DefKind::Mod
1035         | DefKind::ForeignMod
1036         | DefKind::Macro(..)
1037         | DefKind::Use
1038         | DefKind::LifetimeParam
1039         | DefKind::GlobalAsm
1040         | DefKind::ExternCrate => false,
1041     }
1042 }
1043
1044 fn should_encode_const(def_kind: DefKind) -> bool {
1045     match def_kind {
1046         DefKind::Const | DefKind::AssocConst | DefKind::AnonConst => true,
1047
1048         DefKind::Struct
1049         | DefKind::Union
1050         | DefKind::Enum
1051         | DefKind::Variant
1052         | DefKind::Ctor(..)
1053         | DefKind::Field
1054         | DefKind::Fn
1055         | DefKind::Static(..)
1056         | DefKind::TyAlias
1057         | DefKind::OpaqueTy
1058         | DefKind::ImplTraitPlaceholder
1059         | DefKind::ForeignTy
1060         | DefKind::Impl
1061         | DefKind::AssocFn
1062         | DefKind::Closure
1063         | DefKind::Generator
1064         | DefKind::ConstParam
1065         | DefKind::InlineConst
1066         | DefKind::AssocTy
1067         | DefKind::TyParam
1068         | DefKind::Trait
1069         | DefKind::TraitAlias
1070         | DefKind::Mod
1071         | DefKind::ForeignMod
1072         | DefKind::Macro(..)
1073         | DefKind::Use
1074         | DefKind::LifetimeParam
1075         | DefKind::GlobalAsm
1076         | DefKind::ExternCrate => false,
1077     }
1078 }
1079
1080 fn should_encode_trait_impl_trait_tys(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
1081     if tcx.def_kind(def_id) != DefKind::AssocFn {
1082         return false;
1083     }
1084
1085     let Some(item) = tcx.opt_associated_item(def_id) else { return false; };
1086     if item.container != ty::AssocItemContainer::ImplContainer {
1087         return false;
1088     }
1089
1090     let Some(trait_item_def_id) = item.trait_item_def_id else { return false; };
1091
1092     // FIXME(RPITIT): This does a somewhat manual walk through the signature
1093     // of the trait fn to look for any RPITITs, but that's kinda doing a lot
1094     // of work. We can probably remove this when we refactor RPITITs to be
1095     // associated types.
1096     tcx.fn_sig(trait_item_def_id).skip_binder().output().walk().any(|arg| {
1097         if let ty::GenericArgKind::Type(ty) = arg.unpack()
1098             && let ty::Alias(ty::Projection, data) = ty.kind()
1099             && tcx.def_kind(data.def_id) == DefKind::ImplTraitPlaceholder
1100         {
1101             true
1102         } else {
1103             false
1104         }
1105     })
1106 }
1107
1108 impl<'a, 'tcx> EncodeContext<'a, 'tcx> {
1109     fn encode_attrs(&mut self, def_id: LocalDefId) {
1110         let tcx = self.tcx;
1111         let mut is_public: Option<bool> = None;
1112
1113         let mut attrs = tcx
1114             .hir()
1115             .attrs(tcx.hir().local_def_id_to_hir_id(def_id))
1116             .iter()
1117             .filter(move |attr| should_encode_attr(tcx, attr, def_id, &mut is_public));
1118
1119         record_array!(self.tables.attributes[def_id.to_def_id()] <- attrs.clone());
1120         if attrs.any(|attr| attr.may_have_doc_links()) {
1121             self.tables.may_have_doc_links.set(def_id.local_def_index, ());
1122         }
1123     }
1124
1125     fn encode_def_ids(&mut self) {
1126         if self.is_proc_macro {
1127             return;
1128         }
1129         let tcx = self.tcx;
1130         for local_id in tcx.iter_local_def_id() {
1131             let def_id = local_id.to_def_id();
1132             let def_kind = tcx.opt_def_kind(local_id);
1133             let Some(def_kind) = def_kind else { continue };
1134             self.tables.opt_def_kind.set(def_id.index, def_kind);
1135             let def_span = tcx.def_span(local_id);
1136             record!(self.tables.def_span[def_id] <- def_span);
1137             self.encode_attrs(local_id);
1138             record!(self.tables.expn_that_defined[def_id] <- self.tcx.expn_that_defined(def_id));
1139             if let Some(ident_span) = tcx.def_ident_span(def_id) {
1140                 record!(self.tables.def_ident_span[def_id] <- ident_span);
1141             }
1142             if def_kind.has_codegen_attrs() {
1143                 record!(self.tables.codegen_fn_attrs[def_id] <- self.tcx.codegen_fn_attrs(def_id));
1144             }
1145             if should_encode_visibility(def_kind) {
1146                 let vis =
1147                     self.tcx.local_visibility(local_id).map_id(|def_id| def_id.local_def_index);
1148                 record!(self.tables.visibility[def_id] <- vis);
1149             }
1150             if should_encode_stability(def_kind) {
1151                 self.encode_stability(def_id);
1152                 self.encode_const_stability(def_id);
1153                 self.encode_default_body_stability(def_id);
1154                 self.encode_deprecation(def_id);
1155             }
1156             if should_encode_variances(def_kind) {
1157                 let v = self.tcx.variances_of(def_id);
1158                 record_array!(self.tables.variances_of[def_id] <- v);
1159             }
1160             if should_encode_generics(def_kind) {
1161                 let g = tcx.generics_of(def_id);
1162                 record!(self.tables.generics_of[def_id] <- g);
1163                 record!(self.tables.explicit_predicates_of[def_id] <- self.tcx.explicit_predicates_of(def_id));
1164                 let inferred_outlives = self.tcx.inferred_outlives_of(def_id);
1165                 if !inferred_outlives.is_empty() {
1166                     record_array!(self.tables.inferred_outlives_of[def_id] <- inferred_outlives);
1167                 }
1168             }
1169             if should_encode_type(tcx, local_id, def_kind) {
1170                 record!(self.tables.type_of[def_id] <- self.tcx.type_of(def_id));
1171             }
1172             if let DefKind::TyParam = def_kind {
1173                 let default = self.tcx.object_lifetime_default(def_id);
1174                 record!(self.tables.object_lifetime_default[def_id] <- default);
1175             }
1176             if let DefKind::Trait | DefKind::TraitAlias = def_kind {
1177                 record!(self.tables.super_predicates_of[def_id] <- self.tcx.super_predicates_of(def_id));
1178             }
1179             if let DefKind::Enum | DefKind::Struct | DefKind::Union = def_kind {
1180                 self.encode_info_for_adt(def_id);
1181             }
1182             if should_encode_trait_impl_trait_tys(tcx, def_id)
1183                 && let Ok(table) = self.tcx.collect_return_position_impl_trait_in_trait_tys(def_id)
1184             {
1185                 record!(self.tables.trait_impl_trait_tys[def_id] <- table);
1186             }
1187         }
1188         let inherent_impls = tcx.crate_inherent_impls(());
1189         for (def_id, implementations) in inherent_impls.inherent_impls.iter() {
1190             if implementations.is_empty() {
1191                 continue;
1192             }
1193             record_array!(self.tables.inherent_impls[def_id.to_def_id()] <- implementations.iter().map(|&def_id| {
1194                 assert!(def_id.is_local());
1195                 def_id.index
1196             }));
1197         }
1198     }
1199
1200     #[instrument(level = "trace", skip(self))]
1201     fn encode_info_for_adt(&mut self, def_id: DefId) {
1202         let tcx = self.tcx;
1203         let adt_def = tcx.adt_def(def_id);
1204         record!(self.tables.repr_options[def_id] <- adt_def.repr());
1205
1206         let params_in_repr = self.tcx.params_in_repr(def_id);
1207         record!(self.tables.params_in_repr[def_id] <- params_in_repr);
1208
1209         if adt_def.is_enum() {
1210             record_array!(self.tables.children[def_id] <- iter::from_generator(||
1211                 for variant in tcx.adt_def(def_id).variants() {
1212                     yield variant.def_id.index;
1213                     // Encode constructors which take a separate slot in value namespace.
1214                     if let Some(ctor_def_id) = variant.ctor_def_id() {
1215                         yield ctor_def_id.index;
1216                     }
1217                 }
1218             ));
1219         } else {
1220             // For non-enum, there is only one variant, and its def_id is the adt's.
1221             debug_assert_eq!(adt_def.variants().len(), 1);
1222             debug_assert_eq!(adt_def.non_enum_variant().def_id, def_id);
1223             // Therefore, the loop over variants will encode its fields as the adt's children.
1224         }
1225
1226         for variant in adt_def.variants().iter() {
1227             let data = VariantData {
1228                 discr: variant.discr,
1229                 ctor: variant.ctor.map(|(kind, def_id)| (kind, def_id.index)),
1230                 is_non_exhaustive: variant.is_field_list_non_exhaustive(),
1231             };
1232             record!(self.tables.variant_data[variant.def_id] <- data);
1233
1234             self.tables.constness.set(variant.def_id.index, hir::Constness::Const);
1235             record_array!(self.tables.children[variant.def_id] <- variant.fields.iter().map(|f| {
1236                 assert!(f.did.is_local());
1237                 f.did.index
1238             }));
1239
1240             if let Some((CtorKind::Fn, ctor_def_id)) = variant.ctor {
1241                 self.tables.constness.set(ctor_def_id.index, hir::Constness::Const);
1242                 let fn_sig = tcx.fn_sig(ctor_def_id);
1243                 record!(self.tables.fn_sig[ctor_def_id] <- fn_sig);
1244                 // FIXME only encode signature for ctor_def_id
1245                 record!(self.tables.fn_sig[variant.def_id] <- fn_sig);
1246             }
1247         }
1248     }
1249
1250     fn encode_info_for_mod(&mut self, local_def_id: LocalDefId, md: &hir::Mod<'_>) {
1251         let tcx = self.tcx;
1252         let def_id = local_def_id.to_def_id();
1253         debug!("EncodeContext::encode_info_for_mod({:?})", def_id);
1254
1255         // If we are encoding a proc-macro crates, `encode_info_for_mod` will
1256         // only ever get called for the crate root. We still want to encode
1257         // the crate root for consistency with other crates (some of the resolver
1258         // code uses it). However, we skip encoding anything relating to child
1259         // items - we encode information about proc-macros later on.
1260         if self.is_proc_macro {
1261             // Encode this here because we don't do it in encode_def_ids.
1262             record!(self.tables.expn_that_defined[def_id] <- tcx.expn_that_defined(local_def_id));
1263         } else {
1264             record_array!(self.tables.children[def_id] <- iter::from_generator(|| {
1265                 for item_id in md.item_ids {
1266                     match tcx.hir().item(*item_id).kind {
1267                         // Foreign items are planted into their parent modules
1268                         // from name resolution point of view.
1269                         hir::ItemKind::ForeignMod { items, .. } => {
1270                             for foreign_item in items {
1271                                 yield foreign_item.id.owner_id.def_id.local_def_index;
1272                             }
1273                         }
1274                         // Only encode named non-reexport children, reexports are encoded
1275                         // separately and unnamed items are not used by name resolution.
1276                         hir::ItemKind::ExternCrate(..) => continue,
1277                         hir::ItemKind::Struct(ref vdata, _) => {
1278                             yield item_id.owner_id.def_id.local_def_index;
1279                             // Encode constructors which take a separate slot in value namespace.
1280                             if let Some(ctor_hir_id) = vdata.ctor_hir_id() {
1281                                 yield tcx.hir().local_def_id(ctor_hir_id).local_def_index;
1282                             }
1283                         }
1284                         _ if tcx.def_key(item_id.owner_id.to_def_id()).get_opt_name().is_some() => {
1285                             yield item_id.owner_id.def_id.local_def_index;
1286                         }
1287                         _ => continue,
1288                     }
1289                 }
1290             }));
1291
1292             if let Some(reexports) = tcx.module_reexports(local_def_id) {
1293                 assert!(!reexports.is_empty());
1294                 record_array!(self.tables.module_reexports[def_id] <- reexports);
1295             }
1296         }
1297     }
1298
1299     fn encode_explicit_item_bounds(&mut self, def_id: DefId) {
1300         debug!("EncodeContext::encode_explicit_item_bounds({:?})", def_id);
1301         let bounds = self.tcx.explicit_item_bounds(def_id);
1302         if !bounds.is_empty() {
1303             record_array!(self.tables.explicit_item_bounds[def_id] <- bounds);
1304         }
1305     }
1306
1307     fn encode_info_for_trait_item(&mut self, def_id: DefId) {
1308         debug!("EncodeContext::encode_info_for_trait_item({:?})", def_id);
1309         let tcx = self.tcx;
1310
1311         let impl_defaultness = tcx.impl_defaultness(def_id.expect_local());
1312         self.tables.impl_defaultness.set(def_id.index, impl_defaultness);
1313         let trait_item = tcx.associated_item(def_id);
1314         self.tables.assoc_container.set(def_id.index, trait_item.container);
1315
1316         match trait_item.kind {
1317             ty::AssocKind::Const => {}
1318             ty::AssocKind::Fn => {
1319                 record_array!(self.tables.fn_arg_names[def_id] <- tcx.fn_arg_names(def_id));
1320                 self.tables.asyncness.set(def_id.index, tcx.asyncness(def_id));
1321                 self.tables.constness.set(def_id.index, hir::Constness::NotConst);
1322             }
1323             ty::AssocKind::Type => {
1324                 self.encode_explicit_item_bounds(def_id);
1325             }
1326         }
1327         if trait_item.kind == ty::AssocKind::Fn {
1328             record!(self.tables.fn_sig[def_id] <- tcx.fn_sig(def_id));
1329         }
1330     }
1331
1332     fn encode_info_for_impl_item(&mut self, def_id: DefId) {
1333         debug!("EncodeContext::encode_info_for_impl_item({:?})", def_id);
1334         let tcx = self.tcx;
1335
1336         let ast_item = self.tcx.hir().expect_impl_item(def_id.expect_local());
1337         self.tables.impl_defaultness.set(def_id.index, ast_item.defaultness);
1338         let impl_item = self.tcx.associated_item(def_id);
1339         self.tables.assoc_container.set(def_id.index, impl_item.container);
1340
1341         match impl_item.kind {
1342             ty::AssocKind::Fn => {
1343                 let hir::ImplItemKind::Fn(ref sig, body) = ast_item.kind else { bug!() };
1344                 self.tables.asyncness.set(def_id.index, sig.header.asyncness);
1345                 record_array!(self.tables.fn_arg_names[def_id] <- self.tcx.hir().body_param_names(body));
1346                 // Can be inside `impl const Trait`, so using sig.header.constness is not reliable
1347                 let constness = if self.tcx.is_const_fn_raw(def_id) {
1348                     hir::Constness::Const
1349                 } else {
1350                     hir::Constness::NotConst
1351                 };
1352                 self.tables.constness.set(def_id.index, constness);
1353             }
1354             ty::AssocKind::Const | ty::AssocKind::Type => {}
1355         }
1356         if let Some(trait_item_def_id) = impl_item.trait_item_def_id {
1357             self.tables.trait_item_def_id.set(def_id.index, trait_item_def_id.into());
1358         }
1359         if impl_item.kind == ty::AssocKind::Fn {
1360             record!(self.tables.fn_sig[def_id] <- tcx.fn_sig(def_id));
1361             if tcx.is_intrinsic(def_id) {
1362                 self.tables.is_intrinsic.set(def_id.index, ());
1363             }
1364         }
1365     }
1366
1367     fn encode_mir(&mut self) {
1368         if self.is_proc_macro {
1369             return;
1370         }
1371
1372         let tcx = self.tcx;
1373
1374         let keys_and_jobs = tcx.mir_keys(()).iter().filter_map(|&def_id| {
1375             let (encode_const, encode_opt) = should_encode_mir(tcx, def_id);
1376             if encode_const || encode_opt { Some((def_id, encode_const, encode_opt)) } else { None }
1377         });
1378         for (def_id, encode_const, encode_opt) in keys_and_jobs {
1379             debug_assert!(encode_const || encode_opt);
1380
1381             debug!("EntryBuilder::encode_mir({:?})", def_id);
1382             if encode_opt {
1383                 record!(self.tables.optimized_mir[def_id.to_def_id()] <- tcx.optimized_mir(def_id));
1384             }
1385             if encode_const {
1386                 record!(self.tables.mir_for_ctfe[def_id.to_def_id()] <- tcx.mir_for_ctfe(def_id));
1387
1388                 // FIXME(generic_const_exprs): this feels wrong to have in `encode_mir`
1389                 let abstract_const = tcx.thir_abstract_const(def_id);
1390                 if let Ok(Some(abstract_const)) = abstract_const {
1391                     record!(self.tables.thir_abstract_const[def_id.to_def_id()] <- abstract_const);
1392                 }
1393
1394                 if should_encode_const(tcx.def_kind(def_id)) {
1395                     let qualifs = tcx.mir_const_qualif(def_id);
1396                     record!(self.tables.mir_const_qualif[def_id.to_def_id()] <- qualifs);
1397                     let body_id = tcx.hir().maybe_body_owned_by(def_id);
1398                     if let Some(body_id) = body_id {
1399                         let const_data = self.encode_rendered_const_for_body(body_id);
1400                         record!(self.tables.rendered_const[def_id.to_def_id()] <- const_data);
1401                     }
1402                 }
1403             }
1404             record!(self.tables.promoted_mir[def_id.to_def_id()] <- tcx.promoted_mir(def_id));
1405
1406             let instance =
1407                 ty::InstanceDef::Item(ty::WithOptConstParam::unknown(def_id.to_def_id()));
1408             let unused = tcx.unused_generic_params(instance);
1409             if !unused.all_used() {
1410                 record!(self.tables.unused_generic_params[def_id.to_def_id()] <- unused);
1411             }
1412         }
1413
1414         // Encode all the deduced parameter attributes for everything that has MIR, even for items
1415         // that can't be inlined. But don't if we aren't optimizing in non-incremental mode, to
1416         // save the query traffic.
1417         if tcx.sess.opts.output_types.should_codegen()
1418             && tcx.sess.opts.optimize != OptLevel::No
1419             && tcx.sess.opts.incremental.is_none()
1420         {
1421             for &local_def_id in tcx.mir_keys(()) {
1422                 if let DefKind::AssocFn | DefKind::Fn = tcx.def_kind(local_def_id) {
1423                     record_array!(self.tables.deduced_param_attrs[local_def_id.to_def_id()] <-
1424                         self.tcx.deduced_param_attrs(local_def_id.to_def_id()));
1425                 }
1426             }
1427         }
1428     }
1429
1430     fn encode_stability(&mut self, def_id: DefId) {
1431         debug!("EncodeContext::encode_stability({:?})", def_id);
1432
1433         // The query lookup can take a measurable amount of time in crates with many items. Check if
1434         // the stability attributes are even enabled before using their queries.
1435         if self.feat.staged_api || self.tcx.sess.opts.unstable_opts.force_unstable_if_unmarked {
1436             if let Some(stab) = self.tcx.lookup_stability(def_id) {
1437                 record!(self.tables.lookup_stability[def_id] <- stab)
1438             }
1439         }
1440     }
1441
1442     fn encode_const_stability(&mut self, def_id: DefId) {
1443         debug!("EncodeContext::encode_const_stability({:?})", def_id);
1444
1445         // The query lookup can take a measurable amount of time in crates with many items. Check if
1446         // the stability attributes are even enabled before using their queries.
1447         if self.feat.staged_api || self.tcx.sess.opts.unstable_opts.force_unstable_if_unmarked {
1448             if let Some(stab) = self.tcx.lookup_const_stability(def_id) {
1449                 record!(self.tables.lookup_const_stability[def_id] <- stab)
1450             }
1451         }
1452     }
1453
1454     fn encode_default_body_stability(&mut self, def_id: DefId) {
1455         debug!("EncodeContext::encode_default_body_stability({:?})", def_id);
1456
1457         // The query lookup can take a measurable amount of time in crates with many items. Check if
1458         // the stability attributes are even enabled before using their queries.
1459         if self.feat.staged_api || self.tcx.sess.opts.unstable_opts.force_unstable_if_unmarked {
1460             if let Some(stab) = self.tcx.lookup_default_body_stability(def_id) {
1461                 record!(self.tables.lookup_default_body_stability[def_id] <- stab)
1462             }
1463         }
1464     }
1465
1466     fn encode_deprecation(&mut self, def_id: DefId) {
1467         debug!("EncodeContext::encode_deprecation({:?})", def_id);
1468         if let Some(depr) = self.tcx.lookup_deprecation(def_id) {
1469             record!(self.tables.lookup_deprecation_entry[def_id] <- depr);
1470         }
1471     }
1472
1473     fn encode_rendered_const_for_body(&mut self, body_id: hir::BodyId) -> String {
1474         let hir = self.tcx.hir();
1475         let body = hir.body(body_id);
1476         rustc_hir_pretty::to_string(&(&hir as &dyn intravisit::Map<'_>), |s| {
1477             s.print_expr(&body.value)
1478         })
1479     }
1480
1481     fn encode_info_for_item(&mut self, def_id: DefId, item: &'tcx hir::Item<'tcx>) {
1482         let tcx = self.tcx;
1483
1484         debug!("EncodeContext::encode_info_for_item({:?})", def_id);
1485
1486         match item.kind {
1487             hir::ItemKind::Fn(ref sig, .., body) => {
1488                 self.tables.asyncness.set(def_id.index, sig.header.asyncness);
1489                 record_array!(self.tables.fn_arg_names[def_id] <- self.tcx.hir().body_param_names(body));
1490                 self.tables.constness.set(def_id.index, sig.header.constness);
1491             }
1492             hir::ItemKind::Macro(ref macro_def, _) => {
1493                 if macro_def.macro_rules {
1494                     self.tables.macro_rules.set(def_id.index, ());
1495                 }
1496                 record!(self.tables.macro_definition[def_id] <- &*macro_def.body);
1497             }
1498             hir::ItemKind::Mod(ref m) => {
1499                 return self.encode_info_for_mod(item.owner_id.def_id, m);
1500             }
1501             hir::ItemKind::OpaqueTy(ref opaque) => {
1502                 self.encode_explicit_item_bounds(def_id);
1503                 if matches!(opaque.origin, hir::OpaqueTyOrigin::TyAlias) {
1504                     self.tables.is_type_alias_impl_trait.set(def_id.index, ());
1505                 }
1506             }
1507             hir::ItemKind::Impl(hir::Impl { defaultness, constness, .. }) => {
1508                 self.tables.impl_defaultness.set(def_id.index, *defaultness);
1509                 self.tables.constness.set(def_id.index, *constness);
1510
1511                 let trait_ref = self.tcx.impl_trait_ref(def_id).map(ty::EarlyBinder::skip_binder);
1512                 if let Some(trait_ref) = trait_ref {
1513                     let trait_def = self.tcx.trait_def(trait_ref.def_id);
1514                     if let Ok(mut an) = trait_def.ancestors(self.tcx, def_id) {
1515                         if let Some(specialization_graph::Node::Impl(parent)) = an.nth(1) {
1516                             self.tables.impl_parent.set(def_id.index, parent.into());
1517                         }
1518                     }
1519
1520                     // if this is an impl of `CoerceUnsized`, create its
1521                     // "unsized info", else just store None
1522                     if Some(trait_ref.def_id) == self.tcx.lang_items().coerce_unsized_trait() {
1523                         let coerce_unsized_info =
1524                             self.tcx.at(item.span).coerce_unsized_info(def_id);
1525                         record!(self.tables.coerce_unsized_info[def_id] <- coerce_unsized_info);
1526                     }
1527                 }
1528
1529                 let polarity = self.tcx.impl_polarity(def_id);
1530                 self.tables.impl_polarity.set(def_id.index, polarity);
1531             }
1532             hir::ItemKind::Trait(..) => {
1533                 let trait_def = self.tcx.trait_def(def_id);
1534                 record!(self.tables.trait_def[def_id] <- trait_def);
1535             }
1536             hir::ItemKind::TraitAlias(..) => {
1537                 let trait_def = self.tcx.trait_def(def_id);
1538                 record!(self.tables.trait_def[def_id] <- trait_def);
1539             }
1540             hir::ItemKind::ExternCrate(_) | hir::ItemKind::Use(..) => {
1541                 bug!("cannot encode info for item {:?}", item)
1542             }
1543             hir::ItemKind::Static(..)
1544             | hir::ItemKind::Const(..)
1545             | hir::ItemKind::Enum(..)
1546             | hir::ItemKind::Struct(..)
1547             | hir::ItemKind::Union(..)
1548             | hir::ItemKind::ForeignMod { .. }
1549             | hir::ItemKind::GlobalAsm(..)
1550             | hir::ItemKind::TyAlias(..) => {}
1551         };
1552         // FIXME(eddyb) there should be a nicer way to do this.
1553         match item.kind {
1554             hir::ItemKind::Impl { .. } | hir::ItemKind::Trait(..) => {
1555                 let associated_item_def_ids = self.tcx.associated_item_def_ids(def_id);
1556                 record_array!(self.tables.children[def_id] <-
1557                     associated_item_def_ids.iter().map(|&def_id| {
1558                         assert!(def_id.is_local());
1559                         def_id.index
1560                     })
1561                 );
1562             }
1563             _ => {}
1564         }
1565         if let hir::ItemKind::Fn(..) = item.kind {
1566             record!(self.tables.fn_sig[def_id] <- tcx.fn_sig(def_id));
1567             if tcx.is_intrinsic(def_id) {
1568                 self.tables.is_intrinsic.set(def_id.index, ());
1569             }
1570         }
1571         if let hir::ItemKind::Impl { .. } = item.kind {
1572             if let Some(trait_ref) = self.tcx.impl_trait_ref(def_id) {
1573                 record!(self.tables.impl_trait_ref[def_id] <- trait_ref);
1574             }
1575         }
1576         // In some cases, along with the item itself, we also
1577         // encode some sub-items. Usually we want some info from the item
1578         // so it's easier to do that here then to wait until we would encounter
1579         // normally in the visitor walk.
1580         match item.kind {
1581             hir::ItemKind::Impl { .. } => {
1582                 for &trait_item_def_id in
1583                     self.tcx.associated_item_def_ids(item.owner_id.to_def_id()).iter()
1584                 {
1585                     self.encode_info_for_impl_item(trait_item_def_id);
1586                 }
1587             }
1588             hir::ItemKind::Trait(..) => {
1589                 for &item_def_id in
1590                     self.tcx.associated_item_def_ids(item.owner_id.to_def_id()).iter()
1591                 {
1592                     self.encode_info_for_trait_item(item_def_id);
1593                 }
1594             }
1595             _ => {}
1596         }
1597     }
1598
1599     #[instrument(level = "debug", skip(self))]
1600     fn encode_info_for_closure(&mut self, def_id: LocalDefId) {
1601         // NOTE(eddyb) `tcx.type_of(def_id)` isn't used because it's fully generic,
1602         // including on the signature, which is inferred in `typeck.
1603         let typeck_result: &'tcx ty::TypeckResults<'tcx> = self.tcx.typeck(def_id);
1604         let hir_id = self.tcx.hir().local_def_id_to_hir_id(def_id);
1605         let ty = typeck_result.node_type(hir_id);
1606         match ty.kind() {
1607             ty::Generator(..) => {
1608                 let data = self.tcx.generator_kind(def_id).unwrap();
1609                 let generator_diagnostic_data = typeck_result.get_generator_diagnostic_data();
1610                 record!(self.tables.generator_kind[def_id.to_def_id()] <- data);
1611                 record!(self.tables.generator_diagnostic_data[def_id.to_def_id()]  <- generator_diagnostic_data);
1612             }
1613
1614             ty::Closure(_, substs) => {
1615                 let constness = self.tcx.constness(def_id.to_def_id());
1616                 self.tables.constness.set(def_id.to_def_id().index, constness);
1617                 record!(self.tables.fn_sig[def_id.to_def_id()] <- substs.as_closure().sig());
1618             }
1619
1620             _ => bug!("closure that is neither generator nor closure"),
1621         }
1622     }
1623
1624     fn encode_native_libraries(&mut self) -> LazyArray<NativeLib> {
1625         empty_proc_macro!(self);
1626         let used_libraries = self.tcx.native_libraries(LOCAL_CRATE);
1627         self.lazy_array(used_libraries.iter())
1628     }
1629
1630     fn encode_foreign_modules(&mut self) -> LazyArray<ForeignModule> {
1631         empty_proc_macro!(self);
1632         let foreign_modules = self.tcx.foreign_modules(LOCAL_CRATE);
1633         self.lazy_array(foreign_modules.iter().map(|(_, m)| m).cloned())
1634     }
1635
1636     fn encode_hygiene(&mut self) -> (SyntaxContextTable, ExpnDataTable, ExpnHashTable) {
1637         let mut syntax_contexts: TableBuilder<_, _> = Default::default();
1638         let mut expn_data_table: TableBuilder<_, _> = Default::default();
1639         let mut expn_hash_table: TableBuilder<_, _> = Default::default();
1640
1641         self.hygiene_ctxt.encode(
1642             &mut (&mut *self, &mut syntax_contexts, &mut expn_data_table, &mut expn_hash_table),
1643             |(this, syntax_contexts, _, _), index, ctxt_data| {
1644                 syntax_contexts.set(index, this.lazy(ctxt_data));
1645             },
1646             |(this, _, expn_data_table, expn_hash_table), index, expn_data, hash| {
1647                 if let Some(index) = index.as_local() {
1648                     expn_data_table.set(index.as_raw(), this.lazy(expn_data));
1649                     expn_hash_table.set(index.as_raw(), this.lazy(hash));
1650                 }
1651             },
1652         );
1653
1654         (
1655             syntax_contexts.encode(&mut self.opaque),
1656             expn_data_table.encode(&mut self.opaque),
1657             expn_hash_table.encode(&mut self.opaque),
1658         )
1659     }
1660
1661     fn encode_proc_macros(&mut self) -> Option<ProcMacroData> {
1662         let is_proc_macro = self.tcx.sess.crate_types().contains(&CrateType::ProcMacro);
1663         if is_proc_macro {
1664             let tcx = self.tcx;
1665             let hir = tcx.hir();
1666
1667             let proc_macro_decls_static = tcx.proc_macro_decls_static(()).unwrap().local_def_index;
1668             let stability = tcx.lookup_stability(CRATE_DEF_ID);
1669             let macros =
1670                 self.lazy_array(tcx.resolutions(()).proc_macros.iter().map(|p| p.local_def_index));
1671             let spans = self.tcx.sess.parse_sess.proc_macro_quoted_spans();
1672             for (i, span) in spans.into_iter().enumerate() {
1673                 let span = self.lazy(span);
1674                 self.tables.proc_macro_quoted_spans.set(i, span);
1675             }
1676
1677             self.tables.opt_def_kind.set(LOCAL_CRATE.as_def_id().index, DefKind::Mod);
1678             record!(self.tables.def_span[LOCAL_CRATE.as_def_id()] <- tcx.def_span(LOCAL_CRATE.as_def_id()));
1679             self.encode_attrs(LOCAL_CRATE.as_def_id().expect_local());
1680             let vis = tcx.local_visibility(CRATE_DEF_ID).map_id(|def_id| def_id.local_def_index);
1681             record!(self.tables.visibility[LOCAL_CRATE.as_def_id()] <- vis);
1682             if let Some(stability) = stability {
1683                 record!(self.tables.lookup_stability[LOCAL_CRATE.as_def_id()] <- stability);
1684             }
1685             self.encode_deprecation(LOCAL_CRATE.as_def_id());
1686
1687             // Normally, this information is encoded when we walk the items
1688             // defined in this crate. However, we skip doing that for proc-macro crates,
1689             // so we manually encode just the information that we need
1690             for &proc_macro in &tcx.resolutions(()).proc_macros {
1691                 let id = proc_macro;
1692                 let proc_macro = hir.local_def_id_to_hir_id(proc_macro);
1693                 let mut name = hir.name(proc_macro);
1694                 let span = hir.span(proc_macro);
1695                 // Proc-macros may have attributes like `#[allow_internal_unstable]`,
1696                 // so downstream crates need access to them.
1697                 let attrs = hir.attrs(proc_macro);
1698                 let macro_kind = if tcx.sess.contains_name(attrs, sym::proc_macro) {
1699                     MacroKind::Bang
1700                 } else if tcx.sess.contains_name(attrs, sym::proc_macro_attribute) {
1701                     MacroKind::Attr
1702                 } else if let Some(attr) = tcx.sess.find_by_name(attrs, sym::proc_macro_derive) {
1703                     // This unwrap chain should have been checked by the proc-macro harness.
1704                     name = attr.meta_item_list().unwrap()[0]
1705                         .meta_item()
1706                         .unwrap()
1707                         .ident()
1708                         .unwrap()
1709                         .name;
1710                     MacroKind::Derive
1711                 } else {
1712                     bug!("Unknown proc-macro type for item {:?}", id);
1713                 };
1714
1715                 let mut def_key = self.tcx.hir().def_key(id);
1716                 def_key.disambiguated_data.data = DefPathData::MacroNs(name);
1717
1718                 let def_id = id.to_def_id();
1719                 self.tables.opt_def_kind.set(def_id.index, DefKind::Macro(macro_kind));
1720                 self.tables.proc_macro.set(def_id.index, macro_kind);
1721                 self.encode_attrs(id);
1722                 record!(self.tables.def_keys[def_id] <- def_key);
1723                 record!(self.tables.def_ident_span[def_id] <- span);
1724                 record!(self.tables.def_span[def_id] <- span);
1725                 record!(self.tables.visibility[def_id] <- ty::Visibility::Public);
1726                 if let Some(stability) = stability {
1727                     record!(self.tables.lookup_stability[def_id] <- stability);
1728                 }
1729             }
1730
1731             Some(ProcMacroData { proc_macro_decls_static, stability, macros })
1732         } else {
1733             None
1734         }
1735     }
1736
1737     fn encode_debugger_visualizers(&mut self) -> LazyArray<DebuggerVisualizerFile> {
1738         empty_proc_macro!(self);
1739         self.lazy_array(self.tcx.debugger_visualizers(LOCAL_CRATE).iter())
1740     }
1741
1742     fn encode_crate_deps(&mut self) -> LazyArray<CrateDep> {
1743         empty_proc_macro!(self);
1744
1745         let deps = self
1746             .tcx
1747             .crates(())
1748             .iter()
1749             .map(|&cnum| {
1750                 let dep = CrateDep {
1751                     name: self.tcx.crate_name(cnum),
1752                     hash: self.tcx.crate_hash(cnum),
1753                     host_hash: self.tcx.crate_host_hash(cnum),
1754                     kind: self.tcx.dep_kind(cnum),
1755                     extra_filename: self.tcx.extra_filename(cnum).clone(),
1756                 };
1757                 (cnum, dep)
1758             })
1759             .collect::<Vec<_>>();
1760
1761         {
1762             // Sanity-check the crate numbers
1763             let mut expected_cnum = 1;
1764             for &(n, _) in &deps {
1765                 assert_eq!(n, CrateNum::new(expected_cnum));
1766                 expected_cnum += 1;
1767             }
1768         }
1769
1770         // We're just going to write a list of crate 'name-hash-version's, with
1771         // the assumption that they are numbered 1 to n.
1772         // FIXME (#2166): This is not nearly enough to support correct versioning
1773         // but is enough to get transitive crate dependencies working.
1774         self.lazy_array(deps.iter().map(|(_, dep)| dep))
1775     }
1776
1777     fn encode_lib_features(&mut self) -> LazyArray<(Symbol, Option<Symbol>)> {
1778         empty_proc_macro!(self);
1779         let tcx = self.tcx;
1780         let lib_features = tcx.lib_features(());
1781         self.lazy_array(lib_features.to_vec())
1782     }
1783
1784     fn encode_stability_implications(&mut self) -> LazyArray<(Symbol, Symbol)> {
1785         empty_proc_macro!(self);
1786         let tcx = self.tcx;
1787         let implications = tcx.stability_implications(LOCAL_CRATE);
1788         self.lazy_array(implications.iter().map(|(k, v)| (*k, *v)))
1789     }
1790
1791     fn encode_diagnostic_items(&mut self) -> LazyArray<(Symbol, DefIndex)> {
1792         empty_proc_macro!(self);
1793         let tcx = self.tcx;
1794         let diagnostic_items = &tcx.diagnostic_items(LOCAL_CRATE).name_to_id;
1795         self.lazy_array(diagnostic_items.iter().map(|(&name, def_id)| (name, def_id.index)))
1796     }
1797
1798     fn encode_lang_items(&mut self) -> LazyArray<(DefIndex, LangItem)> {
1799         empty_proc_macro!(self);
1800         let lang_items = self.tcx.lang_items().iter();
1801         self.lazy_array(lang_items.filter_map(|(lang_item, def_id)| {
1802             def_id.as_local().map(|id| (id.local_def_index, lang_item))
1803         }))
1804     }
1805
1806     fn encode_lang_items_missing(&mut self) -> LazyArray<LangItem> {
1807         empty_proc_macro!(self);
1808         let tcx = self.tcx;
1809         self.lazy_array(&tcx.lang_items().missing)
1810     }
1811
1812     fn encode_traits(&mut self) -> LazyArray<DefIndex> {
1813         empty_proc_macro!(self);
1814         self.lazy_array(self.tcx.traits_in_crate(LOCAL_CRATE).iter().map(|def_id| def_id.index))
1815     }
1816
1817     /// Encodes an index, mapping each trait to its (local) implementations.
1818     fn encode_impls(&mut self) -> LazyArray<TraitImpls> {
1819         debug!("EncodeContext::encode_traits_and_impls()");
1820         empty_proc_macro!(self);
1821         let tcx = self.tcx;
1822         let mut fx_hash_map: FxHashMap<DefId, Vec<(DefIndex, Option<SimplifiedType>)>> =
1823             FxHashMap::default();
1824
1825         for id in tcx.hir().items() {
1826             if matches!(tcx.def_kind(id.owner_id), DefKind::Impl) {
1827                 if let Some(trait_ref) = tcx.impl_trait_ref(id.owner_id) {
1828                     let trait_ref = trait_ref.subst_identity();
1829
1830                     let simplified_self_ty = fast_reject::simplify_type(
1831                         self.tcx,
1832                         trait_ref.self_ty(),
1833                         TreatParams::AsInfer,
1834                     );
1835
1836                     fx_hash_map
1837                         .entry(trait_ref.def_id)
1838                         .or_default()
1839                         .push((id.owner_id.def_id.local_def_index, simplified_self_ty));
1840                 }
1841             }
1842         }
1843
1844         let mut all_impls: Vec<_> = fx_hash_map.into_iter().collect();
1845
1846         // Bring everything into deterministic order for hashing
1847         all_impls.sort_by_cached_key(|&(trait_def_id, _)| tcx.def_path_hash(trait_def_id));
1848
1849         let all_impls: Vec<_> = all_impls
1850             .into_iter()
1851             .map(|(trait_def_id, mut impls)| {
1852                 // Bring everything into deterministic order for hashing
1853                 impls.sort_by_cached_key(|&(index, _)| {
1854                     tcx.hir().def_path_hash(LocalDefId { local_def_index: index })
1855                 });
1856
1857                 TraitImpls {
1858                     trait_id: (trait_def_id.krate.as_u32(), trait_def_id.index),
1859                     impls: self.lazy_array(&impls),
1860                 }
1861             })
1862             .collect();
1863
1864         self.lazy_array(&all_impls)
1865     }
1866
1867     fn encode_incoherent_impls(&mut self) -> LazyArray<IncoherentImpls> {
1868         debug!("EncodeContext::encode_traits_and_impls()");
1869         empty_proc_macro!(self);
1870         let tcx = self.tcx;
1871         let mut all_impls: Vec<_> = tcx.crate_inherent_impls(()).incoherent_impls.iter().collect();
1872         tcx.with_stable_hashing_context(|mut ctx| {
1873             all_impls.sort_by_cached_key(|&(&simp, _)| {
1874                 let mut hasher = StableHasher::new();
1875                 simp.hash_stable(&mut ctx, &mut hasher);
1876                 hasher.finish::<Fingerprint>()
1877             })
1878         });
1879         let all_impls: Vec<_> = all_impls
1880             .into_iter()
1881             .map(|(&simp, impls)| {
1882                 let mut impls: Vec<_> =
1883                     impls.into_iter().map(|def_id| def_id.local_def_index).collect();
1884                 impls.sort_by_cached_key(|&local_def_index| {
1885                     tcx.hir().def_path_hash(LocalDefId { local_def_index })
1886                 });
1887
1888                 IncoherentImpls { self_ty: simp, impls: self.lazy_array(impls) }
1889             })
1890             .collect();
1891
1892         self.lazy_array(&all_impls)
1893     }
1894
1895     // Encodes all symbols exported from this crate into the metadata.
1896     //
1897     // This pass is seeded off the reachability list calculated in the
1898     // middle::reachable module but filters out items that either don't have a
1899     // symbol associated with them (they weren't translated) or if they're an FFI
1900     // definition (as that's not defined in this crate).
1901     fn encode_exported_symbols(
1902         &mut self,
1903         exported_symbols: &[(ExportedSymbol<'tcx>, SymbolExportInfo)],
1904     ) -> LazyArray<(ExportedSymbol<'static>, SymbolExportInfo)> {
1905         empty_proc_macro!(self);
1906         // The metadata symbol name is special. It should not show up in
1907         // downstream crates.
1908         let metadata_symbol_name = SymbolName::new(self.tcx, &metadata_symbol_name(self.tcx));
1909
1910         self.lazy_array(
1911             exported_symbols
1912                 .iter()
1913                 .filter(|&(exported_symbol, _)| match *exported_symbol {
1914                     ExportedSymbol::NoDefId(symbol_name) => symbol_name != metadata_symbol_name,
1915                     _ => true,
1916                 })
1917                 .cloned(),
1918         )
1919     }
1920
1921     fn encode_dylib_dependency_formats(&mut self) -> LazyArray<Option<LinkagePreference>> {
1922         empty_proc_macro!(self);
1923         let formats = self.tcx.dependency_formats(());
1924         for (ty, arr) in formats.iter() {
1925             if *ty != CrateType::Dylib {
1926                 continue;
1927             }
1928             return self.lazy_array(arr.iter().map(|slot| match *slot {
1929                 Linkage::NotLinked | Linkage::IncludedFromDylib => None,
1930
1931                 Linkage::Dynamic => Some(LinkagePreference::RequireDynamic),
1932                 Linkage::Static => Some(LinkagePreference::RequireStatic),
1933             }));
1934         }
1935         LazyArray::empty()
1936     }
1937
1938     fn encode_info_for_foreign_item(&mut self, def_id: DefId, nitem: &hir::ForeignItem<'_>) {
1939         let tcx = self.tcx;
1940
1941         debug!("EncodeContext::encode_info_for_foreign_item({:?})", def_id);
1942
1943         match nitem.kind {
1944             hir::ForeignItemKind::Fn(_, ref names, _) => {
1945                 self.tables.asyncness.set(def_id.index, hir::IsAsync::NotAsync);
1946                 record_array!(self.tables.fn_arg_names[def_id] <- *names);
1947                 let constness = if self.tcx.is_const_fn_raw(def_id) {
1948                     hir::Constness::Const
1949                 } else {
1950                     hir::Constness::NotConst
1951                 };
1952                 self.tables.constness.set(def_id.index, constness);
1953                 record!(self.tables.fn_sig[def_id] <- tcx.fn_sig(def_id));
1954             }
1955             hir::ForeignItemKind::Static(..) | hir::ForeignItemKind::Type => {}
1956         }
1957         if let hir::ForeignItemKind::Fn(..) = nitem.kind {
1958             if tcx.is_intrinsic(def_id) {
1959                 self.tables.is_intrinsic.set(def_id.index, ());
1960             }
1961         }
1962     }
1963 }
1964
1965 // FIXME(eddyb) make metadata encoding walk over all definitions, instead of HIR.
1966 impl<'a, 'tcx> Visitor<'tcx> for EncodeContext<'a, 'tcx> {
1967     type NestedFilter = nested_filter::OnlyBodies;
1968
1969     fn nested_visit_map(&mut self) -> Self::Map {
1970         self.tcx.hir()
1971     }
1972     fn visit_expr(&mut self, ex: &'tcx hir::Expr<'tcx>) {
1973         intravisit::walk_expr(self, ex);
1974         self.encode_info_for_expr(ex);
1975     }
1976     fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
1977         intravisit::walk_item(self, item);
1978         match item.kind {
1979             hir::ItemKind::ExternCrate(_) | hir::ItemKind::Use(..) => {} // ignore these
1980             _ => self.encode_info_for_item(item.owner_id.to_def_id(), item),
1981         }
1982     }
1983     fn visit_foreign_item(&mut self, ni: &'tcx hir::ForeignItem<'tcx>) {
1984         intravisit::walk_foreign_item(self, ni);
1985         self.encode_info_for_foreign_item(ni.owner_id.to_def_id(), ni);
1986     }
1987     fn visit_generics(&mut self, generics: &'tcx hir::Generics<'tcx>) {
1988         intravisit::walk_generics(self, generics);
1989         self.encode_info_for_generics(generics);
1990     }
1991 }
1992
1993 impl<'a, 'tcx> EncodeContext<'a, 'tcx> {
1994     fn encode_info_for_generics(&mut self, generics: &hir::Generics<'tcx>) {
1995         for param in generics.params {
1996             match param.kind {
1997                 hir::GenericParamKind::Lifetime { .. } | hir::GenericParamKind::Type { .. } => {}
1998                 hir::GenericParamKind::Const { ref default, .. } => {
1999                     let def_id = param.def_id.to_def_id();
2000                     if default.is_some() {
2001                         record!(self.tables.const_param_default[def_id] <- self.tcx.const_param_default(def_id))
2002                     }
2003                 }
2004             }
2005         }
2006     }
2007
2008     fn encode_info_for_expr(&mut self, expr: &hir::Expr<'_>) {
2009         if let hir::ExprKind::Closure(closure) = expr.kind {
2010             self.encode_info_for_closure(closure.def_id);
2011         }
2012     }
2013 }
2014
2015 /// Used to prefetch queries which will be needed later by metadata encoding.
2016 /// Only a subset of the queries are actually prefetched to keep this code smaller.
2017 fn prefetch_mir(tcx: TyCtxt<'_>) {
2018     if !tcx.sess.opts.output_types.should_codegen() {
2019         // We won't emit MIR, so don't prefetch it.
2020         return;
2021     }
2022
2023     par_iter(tcx.mir_keys(())).for_each(|&def_id| {
2024         let (encode_const, encode_opt) = should_encode_mir(tcx, def_id);
2025
2026         if encode_const {
2027             tcx.ensure().mir_for_ctfe(def_id);
2028         }
2029         if encode_opt {
2030             tcx.ensure().optimized_mir(def_id);
2031         }
2032         if encode_opt || encode_const {
2033             tcx.ensure().promoted_mir(def_id);
2034         }
2035     })
2036 }
2037
2038 // NOTE(eddyb) The following comment was preserved for posterity, even
2039 // though it's no longer relevant as EBML (which uses nested & tagged
2040 // "documents") was replaced with a scheme that can't go out of bounds.
2041 //
2042 // And here we run into yet another obscure archive bug: in which metadata
2043 // loaded from archives may have trailing garbage bytes. Awhile back one of
2044 // our tests was failing sporadically on the macOS 64-bit builders (both nopt
2045 // and opt) by having ebml generate an out-of-bounds panic when looking at
2046 // metadata.
2047 //
2048 // Upon investigation it turned out that the metadata file inside of an rlib
2049 // (and ar archive) was being corrupted. Some compilations would generate a
2050 // metadata file which would end in a few extra bytes, while other
2051 // compilations would not have these extra bytes appended to the end. These
2052 // extra bytes were interpreted by ebml as an extra tag, so they ended up
2053 // being interpreted causing the out-of-bounds.
2054 //
2055 // The root cause of why these extra bytes were appearing was never
2056 // discovered, and in the meantime the solution we're employing is to insert
2057 // the length of the metadata to the start of the metadata. Later on this
2058 // will allow us to slice the metadata to the precise length that we just
2059 // generated regardless of trailing bytes that end up in it.
2060
2061 pub struct EncodedMetadata {
2062     // The declaration order matters because `mmap` should be dropped before `_temp_dir`.
2063     mmap: Option<Mmap>,
2064     // We need to carry MaybeTempDir to avoid deleting the temporary
2065     // directory while accessing the Mmap.
2066     _temp_dir: Option<MaybeTempDir>,
2067 }
2068
2069 impl EncodedMetadata {
2070     #[inline]
2071     pub fn from_path(path: PathBuf, temp_dir: Option<MaybeTempDir>) -> std::io::Result<Self> {
2072         let file = std::fs::File::open(&path)?;
2073         let file_metadata = file.metadata()?;
2074         if file_metadata.len() == 0 {
2075             return Ok(Self { mmap: None, _temp_dir: None });
2076         }
2077         let mmap = unsafe { Some(Mmap::map(file)?) };
2078         Ok(Self { mmap, _temp_dir: temp_dir })
2079     }
2080
2081     #[inline]
2082     pub fn raw_data(&self) -> &[u8] {
2083         self.mmap.as_deref().unwrap_or_default()
2084     }
2085 }
2086
2087 impl<S: Encoder> Encodable<S> for EncodedMetadata {
2088     fn encode(&self, s: &mut S) {
2089         let slice = self.raw_data();
2090         slice.encode(s)
2091     }
2092 }
2093
2094 impl<D: Decoder> Decodable<D> for EncodedMetadata {
2095     fn decode(d: &mut D) -> Self {
2096         let len = d.read_usize();
2097         let mmap = if len > 0 {
2098             let mut mmap = MmapMut::map_anon(len).unwrap();
2099             for _ in 0..len {
2100                 (&mut mmap[..]).write(&[d.read_u8()]).unwrap();
2101             }
2102             mmap.flush().unwrap();
2103             Some(mmap.make_read_only().unwrap())
2104         } else {
2105             None
2106         };
2107
2108         Self { mmap, _temp_dir: None }
2109     }
2110 }
2111
2112 pub fn encode_metadata(tcx: TyCtxt<'_>, path: &Path) {
2113     let _prof_timer = tcx.prof.verbose_generic_activity("generate_crate_metadata");
2114
2115     // Since encoding metadata is not in a query, and nothing is cached,
2116     // there's no need to do dep-graph tracking for any of it.
2117     tcx.dep_graph.assert_ignored();
2118
2119     join(
2120         || encode_metadata_impl(tcx, path),
2121         || {
2122             if tcx.sess.threads() == 1 {
2123                 return;
2124             }
2125             // Prefetch some queries used by metadata encoding.
2126             // This is not necessary for correctness, but is only done for performance reasons.
2127             // It can be removed if it turns out to cause trouble or be detrimental to performance.
2128             join(|| prefetch_mir(tcx), || tcx.exported_symbols(LOCAL_CRATE));
2129         },
2130     );
2131 }
2132
2133 fn encode_metadata_impl(tcx: TyCtxt<'_>, path: &Path) {
2134     let mut encoder = opaque::FileEncoder::new(path)
2135         .unwrap_or_else(|err| tcx.sess.emit_fatal(FailCreateFileEncoder { err }));
2136     encoder.emit_raw_bytes(METADATA_HEADER);
2137
2138     // Will be filled with the root position after encoding everything.
2139     encoder.emit_raw_bytes(&[0, 0, 0, 0]);
2140
2141     let source_map_files = tcx.sess.source_map().files();
2142     let source_file_cache = (source_map_files[0].clone(), 0);
2143     let required_source_files = Some(FxIndexSet::default());
2144     drop(source_map_files);
2145
2146     let hygiene_ctxt = HygieneEncodeContext::default();
2147
2148     let mut ecx = EncodeContext {
2149         opaque: encoder,
2150         tcx,
2151         feat: tcx.features(),
2152         tables: Default::default(),
2153         lazy_state: LazyState::NoNode,
2154         type_shorthands: Default::default(),
2155         predicate_shorthands: Default::default(),
2156         source_file_cache,
2157         interpret_allocs: Default::default(),
2158         required_source_files,
2159         is_proc_macro: tcx.sess.crate_types().contains(&CrateType::ProcMacro),
2160         hygiene_ctxt: &hygiene_ctxt,
2161         symbol_table: Default::default(),
2162     };
2163
2164     // Encode the rustc version string in a predictable location.
2165     rustc_version().encode(&mut ecx);
2166
2167     // Encode all the entries and extra information in the crate,
2168     // culminating in the `CrateRoot` which points to all of it.
2169     let root = ecx.encode_crate_root();
2170
2171     ecx.opaque.flush();
2172
2173     let mut file = ecx.opaque.file();
2174     // We will return to this position after writing the root position.
2175     let pos_before_seek = file.stream_position().unwrap();
2176
2177     // Encode the root position.
2178     let header = METADATA_HEADER.len();
2179     file.seek(std::io::SeekFrom::Start(header as u64))
2180         .unwrap_or_else(|err| tcx.sess.emit_fatal(FailSeekFile { err }));
2181     let pos = root.position.get();
2182     file.write_all(&[(pos >> 24) as u8, (pos >> 16) as u8, (pos >> 8) as u8, (pos >> 0) as u8])
2183         .unwrap_or_else(|err| tcx.sess.emit_fatal(FailWriteFile { err }));
2184
2185     // Return to the position where we are before writing the root position.
2186     file.seek(std::io::SeekFrom::Start(pos_before_seek)).unwrap();
2187
2188     // Record metadata size for self-profiling
2189     tcx.prof.artifact_size(
2190         "crate_metadata",
2191         "crate_metadata",
2192         file.metadata().unwrap().len() as u64,
2193     );
2194 }
2195
2196 pub fn provide(providers: &mut Providers) {
2197     *providers = Providers {
2198         traits_in_crate: |tcx, cnum| {
2199             assert_eq!(cnum, LOCAL_CRATE);
2200
2201             let mut traits = Vec::new();
2202             for id in tcx.hir().items() {
2203                 if matches!(tcx.def_kind(id.owner_id), DefKind::Trait | DefKind::TraitAlias) {
2204                     traits.push(id.owner_id.to_def_id())
2205                 }
2206             }
2207
2208             // Bring everything into deterministic order.
2209             traits.sort_by_cached_key(|&def_id| tcx.def_path_hash(def_id));
2210             tcx.arena.alloc_slice(&traits)
2211         },
2212
2213         ..*providers
2214     }
2215 }