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