compiler/rustc_metadata/src/rmeta/encoder.rs

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