1 // Decoding metadata from a single crate's metadata
3 use crate::creader::CrateMetadataRef;
4 use crate::rmeta::table::{FixedSizeEncoding, Table};
8 use rustc_attr as attr;
9 use rustc_data_structures::captures::Captures;
10 use rustc_data_structures::fx::FxHashMap;
11 use rustc_data_structures::svh::Svh;
12 use rustc_data_structures::sync::{Lock, LockGuard, Lrc, OnceCell};
13 use rustc_data_structures::unhash::UnhashMap;
14 use rustc_errors::ErrorReported;
15 use rustc_expand::base::{SyntaxExtension, SyntaxExtensionKind};
16 use rustc_expand::proc_macro::{AttrProcMacro, BangProcMacro, ProcMacroDerive};
18 use rustc_hir::def::{CtorKind, CtorOf, DefKind, Res};
19 use rustc_hir::def_id::{CrateNum, DefId, DefIndex, CRATE_DEF_INDEX, LOCAL_CRATE};
20 use rustc_hir::definitions::{DefKey, DefPath, DefPathData, DefPathHash};
21 use rustc_hir::lang_items;
22 use rustc_index::vec::{Idx, IndexVec};
23 use rustc_middle::hir::exports::Export;
24 use rustc_middle::middle::cstore::{CrateSource, ExternCrate};
25 use rustc_middle::middle::cstore::{ForeignModule, LinkagePreference, NativeLib};
26 use rustc_middle::middle::exported_symbols::{ExportedSymbol, SymbolExportLevel};
27 use rustc_middle::mir::interpret::{AllocDecodingSession, AllocDecodingState};
28 use rustc_middle::mir::{self, Body, Promoted};
29 use rustc_middle::ty::codec::TyDecoder;
30 use rustc_middle::ty::{self, Ty, TyCtxt, Visibility};
31 use rustc_serialize::{opaque, Decodable, Decoder};
32 use rustc_session::Session;
33 use rustc_span::hygiene::ExpnDataDecodeMode;
34 use rustc_span::source_map::{respan, Spanned};
35 use rustc_span::symbol::{sym, Ident, Symbol};
36 use rustc_span::{self, hygiene::MacroKind, BytePos, ExpnId, Pos, Span, SyntaxContext, DUMMY_SP};
38 use proc_macro::bridge::client::ProcMacro;
42 use std::num::NonZeroUsize;
46 pub use cstore_impl::{provide, provide_extern};
47 use rustc_span::hygiene::HygieneDecodeContext;
51 crate struct MetadataBlob(MetadataRef);
53 // A map from external crate numbers (as decoded from some crate file) to
54 // local crate numbers (as generated during this session). Each external
55 // crate may refer to types in other external crates, and each has their
57 crate type CrateNumMap = IndexVec<CrateNum, CrateNum>;
59 crate struct CrateMetadata {
60 /// The primary crate data - binary metadata blob.
63 // --- Some data pre-decoded from the metadata blob, usually for performance ---
64 /// Properties of the whole crate.
65 /// NOTE(eddyb) we pass `'static` to a `'tcx` parameter because this
66 /// lifetime is only used behind `Lazy`, and therefore acts like an
67 /// universal (`for<'tcx>`), that is paired up with whichever `TyCtxt`
68 /// is being used to decode those values.
69 root: CrateRoot<'static>,
71 /// FIXME: Used only from queries and can use query cache,
72 /// so pre-decoding can probably be avoided.
74 FxHashMap<(u32, DefIndex), Lazy<[(DefIndex, Option<ty::fast_reject::SimplifiedType>)]>>,
75 /// Proc macro descriptions for this crate, if it's a proc macro crate.
76 raw_proc_macros: Option<&'static [ProcMacro]>,
77 /// Source maps for code from the crate.
78 source_map_import_info: OnceCell<Vec<ImportedSourceFile>>,
79 /// For every definition in this crate, maps its `DefPathHash` to its
80 /// `DefIndex`. See `raw_def_id_to_def_id` for more details about how
82 def_path_hash_map: OnceCell<UnhashMap<DefPathHash, DefIndex>>,
83 /// Used for decoding interpret::AllocIds in a cached & thread-safe manner.
84 alloc_decoding_state: AllocDecodingState,
85 /// Caches decoded `DefKey`s.
86 def_key_cache: Lock<FxHashMap<DefIndex, DefKey>>,
87 /// Caches decoded `DefPathHash`es.
88 def_path_hash_cache: Lock<FxHashMap<DefIndex, DefPathHash>>,
90 // --- Other significant crate properties ---
91 /// ID of this crate, from the current compilation session's point of view.
93 /// Maps crate IDs as they are were seen from this crate's compilation sessions into
94 /// IDs as they are seen from the current compilation session.
95 cnum_map: CrateNumMap,
96 /// Same ID set as `cnum_map` plus maybe some injected crates like panic runtime.
97 dependencies: Lock<Vec<CrateNum>>,
98 /// How to link (or not link) this crate to the currently compiled crate.
99 dep_kind: Lock<CrateDepKind>,
100 /// Filesystem location of this crate.
102 /// Whether or not this crate should be consider a private dependency
103 /// for purposes of the 'exported_private_dependencies' lint
105 /// The hash for the host proc macro. Used to support `-Z dual-proc-macro`.
106 host_hash: Option<Svh>,
108 /// Additional data used for decoding `HygieneData` (e.g. `SyntaxContext`
110 /// Note that we store a `HygieneDecodeContext` for each `CrateMetadat`. This is
111 /// because `SyntaxContext` ids are not globally unique, so we need
112 /// to track which ids we've decoded on a per-crate basis.
113 hygiene_context: HygieneDecodeContext,
115 // --- Data used only for improving diagnostics ---
116 /// Information about the `extern crate` item or path that caused this crate to be loaded.
117 /// If this is `None`, then the crate was injected (e.g., by the allocator).
118 extern_crate: Lock<Option<ExternCrate>>,
121 /// Holds information about a rustc_span::SourceFile imported from another crate.
122 /// See `imported_source_files()` for more information.
123 struct ImportedSourceFile {
124 /// This SourceFile's byte-offset within the source_map of its original crate
125 original_start_pos: rustc_span::BytePos,
126 /// The end of this SourceFile within the source_map of its original crate
127 original_end_pos: rustc_span::BytePos,
128 /// The imported SourceFile's representation within the local source_map
129 translated_source_file: Lrc<rustc_span::SourceFile>,
132 pub(super) struct DecodeContext<'a, 'tcx> {
133 opaque: opaque::Decoder<'a>,
134 cdata: Option<CrateMetadataRef<'a>>,
135 sess: Option<&'tcx Session>,
136 tcx: Option<TyCtxt<'tcx>>,
138 // Cache the last used source_file for translating spans as an optimization.
139 last_source_file_index: usize,
141 lazy_state: LazyState,
143 // Used for decoding interpret::AllocIds in a cached & thread-safe manner.
144 alloc_decoding_session: Option<AllocDecodingSession<'a>>,
147 /// Abstract over the various ways one can create metadata decoders.
148 pub(super) trait Metadata<'a, 'tcx>: Copy {
149 fn raw_bytes(self) -> &'a [u8];
150 fn cdata(self) -> Option<CrateMetadataRef<'a>> {
153 fn sess(self) -> Option<&'tcx Session> {
156 fn tcx(self) -> Option<TyCtxt<'tcx>> {
160 fn decoder(self, pos: usize) -> DecodeContext<'a, 'tcx> {
161 let tcx = self.tcx();
163 opaque: opaque::Decoder::new(self.raw_bytes(), pos),
165 sess: self.sess().or(tcx.map(|tcx| tcx.sess)),
167 last_source_file_index: 0,
168 lazy_state: LazyState::NoNode,
169 alloc_decoding_session: self
171 .map(|cdata| cdata.cdata.alloc_decoding_state.new_decoding_session()),
176 impl<'a, 'tcx> Metadata<'a, 'tcx> for &'a MetadataBlob {
177 fn raw_bytes(self) -> &'a [u8] {
182 impl<'a, 'tcx> Metadata<'a, 'tcx> for (&'a MetadataBlob, &'tcx Session) {
183 fn raw_bytes(self) -> &'a [u8] {
184 let (blob, _) = self;
188 fn sess(self) -> Option<&'tcx Session> {
189 let (_, sess) = self;
194 impl<'a, 'tcx> Metadata<'a, 'tcx> for &'a CrateMetadataRef<'a> {
195 fn raw_bytes(self) -> &'a [u8] {
196 self.blob.raw_bytes()
198 fn cdata(self) -> Option<CrateMetadataRef<'a>> {
203 impl<'a, 'tcx> Metadata<'a, 'tcx> for (&'a CrateMetadataRef<'a>, &'tcx Session) {
204 fn raw_bytes(self) -> &'a [u8] {
207 fn cdata(self) -> Option<CrateMetadataRef<'a>> {
210 fn sess(self) -> Option<&'tcx Session> {
215 impl<'a, 'tcx> Metadata<'a, 'tcx> for (&'a CrateMetadataRef<'a>, TyCtxt<'tcx>) {
216 fn raw_bytes(self) -> &'a [u8] {
219 fn cdata(self) -> Option<CrateMetadataRef<'a>> {
222 fn tcx(self) -> Option<TyCtxt<'tcx>> {
227 impl<'a, 'tcx, T: Decodable<DecodeContext<'a, 'tcx>>> Lazy<T> {
228 fn decode<M: Metadata<'a, 'tcx>>(self, metadata: M) -> T {
229 let mut dcx = metadata.decoder(self.position.get());
230 dcx.lazy_state = LazyState::NodeStart(self.position);
231 T::decode(&mut dcx).unwrap()
235 impl<'a: 'x, 'tcx: 'x, 'x, T: Decodable<DecodeContext<'a, 'tcx>>> Lazy<[T]> {
236 fn decode<M: Metadata<'a, 'tcx>>(
239 ) -> impl ExactSizeIterator<Item = T> + Captures<'a> + Captures<'tcx> + 'x {
240 let mut dcx = metadata.decoder(self.position.get());
241 dcx.lazy_state = LazyState::NodeStart(self.position);
242 (0..self.meta).map(move |_| T::decode(&mut dcx).unwrap())
246 impl<'a, 'tcx> DecodeContext<'a, 'tcx> {
247 fn tcx(&self) -> TyCtxt<'tcx> {
248 self.tcx.expect("missing TyCtxt in DecodeContext")
251 fn cdata(&self) -> CrateMetadataRef<'a> {
252 self.cdata.expect("missing CrateMetadata in DecodeContext")
255 fn map_encoded_cnum_to_current(&self, cnum: CrateNum) -> CrateNum {
256 if cnum == LOCAL_CRATE { self.cdata().cnum } else { self.cdata().cnum_map[cnum] }
259 fn read_lazy_with_meta<T: ?Sized + LazyMeta>(
262 ) -> Result<Lazy<T>, <Self as Decoder>::Error> {
263 let min_size = T::min_size(meta);
264 let distance = self.read_usize()?;
265 let position = match self.lazy_state {
266 LazyState::NoNode => bug!("read_lazy_with_meta: outside of a metadata node"),
267 LazyState::NodeStart(start) => {
268 let start = start.get();
269 assert!(distance + min_size <= start);
270 start - distance - min_size
272 LazyState::Previous(last_min_end) => last_min_end.get() + distance,
274 self.lazy_state = LazyState::Previous(NonZeroUsize::new(position + min_size).unwrap());
275 Ok(Lazy::from_position_and_meta(NonZeroUsize::new(position).unwrap(), meta))
279 impl<'a, 'tcx> TyDecoder<'tcx> for DecodeContext<'a, 'tcx> {
280 const CLEAR_CROSS_CRATE: bool = true;
283 fn tcx(&self) -> TyCtxt<'tcx> {
284 self.tcx.expect("missing TyCtxt in DecodeContext")
288 fn peek_byte(&self) -> u8 {
289 self.opaque.data[self.opaque.position()]
293 fn position(&self) -> usize {
294 self.opaque.position()
297 fn cached_ty_for_shorthand<F>(
301 ) -> Result<Ty<'tcx>, Self::Error>
303 F: FnOnce(&mut Self) -> Result<Ty<'tcx>, Self::Error>,
305 let tcx = self.tcx();
307 let key = ty::CReaderCacheKey { cnum: Some(self.cdata().cnum), pos: shorthand };
309 if let Some(&ty) = tcx.ty_rcache.borrow().get(&key) {
313 let ty = or_insert_with(self)?;
314 tcx.ty_rcache.borrow_mut().insert(key, ty);
318 fn with_position<F, R>(&mut self, pos: usize, f: F) -> R
320 F: FnOnce(&mut Self) -> R,
322 let new_opaque = opaque::Decoder::new(self.opaque.data, pos);
323 let old_opaque = mem::replace(&mut self.opaque, new_opaque);
324 let old_state = mem::replace(&mut self.lazy_state, LazyState::NoNode);
326 self.opaque = old_opaque;
327 self.lazy_state = old_state;
331 fn decode_alloc_id(&mut self) -> Result<rustc_middle::mir::interpret::AllocId, Self::Error> {
332 if let Some(alloc_decoding_session) = self.alloc_decoding_session {
333 alloc_decoding_session.decode_alloc_id(self)
335 bug!("Attempting to decode interpret::AllocId without CrateMetadata")
340 impl<'a, 'tcx> Decodable<DecodeContext<'a, 'tcx>> for CrateNum {
341 fn decode(d: &mut DecodeContext<'a, 'tcx>) -> Result<CrateNum, String> {
342 let cnum = CrateNum::from_u32(d.read_u32()?);
343 Ok(d.map_encoded_cnum_to_current(cnum))
347 impl<'a, 'tcx> Decodable<DecodeContext<'a, 'tcx>> for DefIndex {
348 fn decode(d: &mut DecodeContext<'a, 'tcx>) -> Result<DefIndex, String> {
349 Ok(DefIndex::from_u32(d.read_u32()?))
353 impl<'a, 'tcx> Decodable<DecodeContext<'a, 'tcx>> for SyntaxContext {
354 fn decode(decoder: &mut DecodeContext<'a, 'tcx>) -> Result<SyntaxContext, String> {
355 let cdata = decoder.cdata();
356 let sess = decoder.sess.unwrap();
357 let cname = cdata.root.name;
358 rustc_span::hygiene::decode_syntax_context(decoder, &cdata.hygiene_context, |_, id| {
359 debug!("SpecializedDecoder<SyntaxContext>: decoding {}", id);
364 .unwrap_or_else(|| panic!("Missing SyntaxContext {:?} for crate {:?}", id, cname))
365 .decode((&cdata, sess)))
370 impl<'a, 'tcx> Decodable<DecodeContext<'a, 'tcx>> for ExpnId {
371 fn decode(decoder: &mut DecodeContext<'a, 'tcx>) -> Result<ExpnId, String> {
372 let local_cdata = decoder.cdata();
373 let sess = decoder.sess.unwrap();
374 let expn_cnum = Cell::new(None);
375 let get_ctxt = |cnum| {
376 expn_cnum.set(Some(cnum));
377 if cnum == LOCAL_CRATE {
378 &local_cdata.hygiene_context
380 &local_cdata.cstore.get_crate_data(cnum).cdata.hygiene_context
384 rustc_span::hygiene::decode_expn_id(
386 ExpnDataDecodeMode::Metadata(get_ctxt),
388 let cnum = expn_cnum.get().unwrap();
389 // Lookup local `ExpnData`s in our own crate data. Foreign `ExpnData`s
390 // are stored in the owning crate, to avoid duplication.
391 let crate_data = if cnum == LOCAL_CRATE {
394 local_cdata.cstore.get_crate_data(cnum)
399 .get(&crate_data, index)
401 .decode((&crate_data, sess)))
407 impl<'a, 'tcx> Decodable<DecodeContext<'a, 'tcx>> for Span {
408 fn decode(decoder: &mut DecodeContext<'a, 'tcx>) -> Result<Span, String> {
409 let ctxt = SyntaxContext::decode(decoder)?;
410 let tag = u8::decode(decoder)?;
412 if tag == TAG_PARTIAL_SPAN {
413 return Ok(DUMMY_SP.with_ctxt(ctxt));
416 debug_assert!(tag == TAG_VALID_SPAN_LOCAL || tag == TAG_VALID_SPAN_FOREIGN);
418 let lo = BytePos::decode(decoder)?;
419 let len = BytePos::decode(decoder)?;
422 let sess = if let Some(sess) = decoder.sess {
425 bug!("Cannot decode Span without Session.")
428 // There are two possibilities here:
429 // 1. This is a 'local span', which is located inside a `SourceFile`
430 // that came from this crate. In this case, we use the source map data
431 // encoded in this crate. This branch should be taken nearly all of the time.
432 // 2. This is a 'foreign span', which is located inside a `SourceFile`
433 // that came from a *different* crate (some crate upstream of the one
434 // whose metadata we're looking at). For example, consider this dependency graph:
438 // Suppose that we're currently compiling crate A, and start deserializing
439 // metadata from crate B. When we deserialize a Span from crate B's metadata,
440 // there are two posibilites:
442 // 1. The span references a file from crate B. This makes it a 'local' span,
443 // which means that we can use crate B's serialized source map information.
444 // 2. The span references a file from crate C. This makes it a 'foreign' span,
445 // which means we need to use Crate *C* (not crate B) to determine the source
446 // map information. We only record source map information for a file in the
447 // crate that 'owns' it, so deserializing a Span may require us to look at
448 // a transitive dependency.
450 // When we encode a foreign span, we adjust its 'lo' and 'high' values
451 // to be based on the *foreign* crate (e.g. crate C), not the crate
452 // we are writing metadata for (e.g. crate B). This allows us to
453 // treat the 'local' and 'foreign' cases almost identically during deserialization:
454 // we can call `imported_source_files` for the proper crate, and binary search
455 // through the returned slice using our span.
456 let imported_source_files = if tag == TAG_VALID_SPAN_LOCAL {
457 decoder.cdata().imported_source_files(sess)
459 // When we encode a proc-macro crate, all `Span`s should be encoded
460 // with `TAG_VALID_SPAN_LOCAL`
461 if decoder.cdata().root.is_proc_macro_crate() {
462 // Decode `CrateNum` as u32 - using `CrateNum::decode` will ICE
463 // since we don't have `cnum_map` populated.
464 let cnum = u32::decode(decoder)?;
466 "Decoding of crate {:?} tried to access proc-macro dep {:?}",
467 decoder.cdata().root.name,
471 // tag is TAG_VALID_SPAN_FOREIGN, checked by `debug_assert` above
472 let cnum = CrateNum::decode(decoder)?;
474 "SpecializedDecoder<Span>::specialized_decode: loading source files from cnum {:?}",
478 // Decoding 'foreign' spans should be rare enough that it's
479 // not worth it to maintain a per-CrateNum cache for `last_source_file_index`.
480 // We just set it to 0, to ensure that we don't try to access something out
481 // of bounds for our initial 'guess'
482 decoder.last_source_file_index = 0;
484 let foreign_data = decoder.cdata().cstore.get_crate_data(cnum);
485 foreign_data.imported_source_files(sess)
489 // Optimize for the case that most spans within a translated item
490 // originate from the same source_file.
491 let last_source_file = &imported_source_files[decoder.last_source_file_index];
493 if lo >= last_source_file.original_start_pos && lo <= last_source_file.original_end_pos
497 let index = imported_source_files
498 .binary_search_by_key(&lo, |source_file| source_file.original_start_pos)
499 .unwrap_or_else(|index| index - 1);
501 // Don't try to cache the index for foreign spans,
502 // as this would require a map from CrateNums to indices
503 if tag == TAG_VALID_SPAN_LOCAL {
504 decoder.last_source_file_index = index;
506 &imported_source_files[index]
510 // Make sure our binary search above is correct.
512 lo >= source_file.original_start_pos && lo <= source_file.original_end_pos,
513 "Bad binary search: lo={:?} source_file.original_start_pos={:?} source_file.original_end_pos={:?}",
515 source_file.original_start_pos,
516 source_file.original_end_pos
519 // Make sure we correctly filtered out invalid spans during encoding
521 hi >= source_file.original_start_pos && hi <= source_file.original_end_pos,
522 "Bad binary search: hi={:?} source_file.original_start_pos={:?} source_file.original_end_pos={:?}",
524 source_file.original_start_pos,
525 source_file.original_end_pos
529 (lo + source_file.translated_source_file.start_pos) - source_file.original_start_pos;
531 (hi + source_file.translated_source_file.start_pos) - source_file.original_start_pos;
533 Ok(Span::new(lo, hi, ctxt))
537 impl<'a, 'tcx> Decodable<DecodeContext<'a, 'tcx>> for &'tcx [mir::abstract_const::Node<'tcx>] {
538 fn decode(d: &mut DecodeContext<'a, 'tcx>) -> Result<Self, String> {
539 ty::codec::RefDecodable::decode(d)
543 impl<'a, 'tcx> Decodable<DecodeContext<'a, 'tcx>> for &'tcx [(ty::Predicate<'tcx>, Span)] {
544 fn decode(d: &mut DecodeContext<'a, 'tcx>) -> Result<Self, String> {
545 ty::codec::RefDecodable::decode(d)
549 impl<'a, 'tcx, T: Decodable<DecodeContext<'a, 'tcx>>> Decodable<DecodeContext<'a, 'tcx>>
552 fn decode(decoder: &mut DecodeContext<'a, 'tcx>) -> Result<Self, String> {
553 decoder.read_lazy_with_meta(())
557 impl<'a, 'tcx, T: Decodable<DecodeContext<'a, 'tcx>>> Decodable<DecodeContext<'a, 'tcx>>
560 fn decode(decoder: &mut DecodeContext<'a, 'tcx>) -> Result<Self, String> {
561 let len = decoder.read_usize()?;
562 if len == 0 { Ok(Lazy::empty()) } else { decoder.read_lazy_with_meta(len) }
566 impl<'a, 'tcx, I: Idx, T: Decodable<DecodeContext<'a, 'tcx>>> Decodable<DecodeContext<'a, 'tcx>>
567 for Lazy<Table<I, T>>
569 Option<T>: FixedSizeEncoding,
571 fn decode(decoder: &mut DecodeContext<'a, 'tcx>) -> Result<Self, String> {
572 let len = decoder.read_usize()?;
573 decoder.read_lazy_with_meta(len)
577 implement_ty_decoder!(DecodeContext<'a, 'tcx>);
580 crate fn new(metadata_ref: MetadataRef) -> MetadataBlob {
581 MetadataBlob(metadata_ref)
584 crate fn is_compatible(&self) -> bool {
585 self.raw_bytes().starts_with(METADATA_HEADER)
588 crate fn get_rustc_version(&self) -> String {
589 Lazy::<String>::from_position(NonZeroUsize::new(METADATA_HEADER.len() + 4).unwrap())
593 crate fn get_root(&self) -> CrateRoot<'tcx> {
594 let slice = self.raw_bytes();
595 let offset = METADATA_HEADER.len();
596 let pos = (((slice[offset + 0] as u32) << 24)
597 | ((slice[offset + 1] as u32) << 16)
598 | ((slice[offset + 2] as u32) << 8)
599 | ((slice[offset + 3] as u32) << 0)) as usize;
600 Lazy::<CrateRoot<'tcx>>::from_position(NonZeroUsize::new(pos).unwrap()).decode(self)
603 crate fn list_crate_metadata(&self, out: &mut dyn io::Write) -> io::Result<()> {
604 let root = self.get_root();
605 writeln!(out, "Crate info:")?;
606 writeln!(out, "name {}{}", root.name, root.extra_filename)?;
607 writeln!(out, "hash {} stable_crate_id {:?}", root.hash, root.stable_crate_id)?;
608 writeln!(out, "proc_macro {:?}", root.proc_macro_data.is_some())?;
609 writeln!(out, "=External Dependencies=")?;
610 for (i, dep) in root.crate_deps.decode(self).enumerate() {
613 "{} {}{} hash {} host_hash {:?} kind {:?}",
628 crate fn is_proc_macro_crate(&self) -> bool {
629 self.proc_macro_data.is_some()
632 crate fn name(&self) -> Symbol {
636 crate fn hash(&self) -> Svh {
640 crate fn stable_crate_id(&self) -> StableCrateId {
644 crate fn triple(&self) -> &TargetTriple {
648 crate fn decode_crate_deps(
650 metadata: &'a MetadataBlob,
651 ) -> impl ExactSizeIterator<Item = CrateDep> + Captures<'a> {
652 self.crate_deps.decode(metadata)
656 impl<'a, 'tcx> CrateMetadataRef<'a> {
657 fn raw_proc_macro(&self, id: DefIndex) -> &ProcMacro {
658 // DefIndex's in root.proc_macro_data have a one-to-one correspondence
659 // with items in 'raw_proc_macros'.
667 .position(|i| i == id)
669 &self.raw_proc_macros.unwrap()[pos]
672 fn try_item_ident(&self, item_index: DefIndex, sess: &Session) -> Result<Ident, String> {
678 .ok_or_else(|| format!("Missing opt name for {:?}", item_index))?;
683 .get(self, item_index)
684 .ok_or_else(|| format!("Missing ident span for {:?} ({:?})", name, item_index))?
685 .decode((self, sess));
686 Ok(Ident::new(name, span))
689 fn item_ident(&self, item_index: DefIndex, sess: &Session) -> Ident {
690 self.try_item_ident(item_index, sess).unwrap()
693 fn maybe_kind(&self, item_id: DefIndex) -> Option<EntryKind> {
694 self.root.tables.kind.get(self, item_id).map(|k| k.decode(self))
697 fn kind(&self, item_id: DefIndex) -> EntryKind {
698 self.maybe_kind(item_id).unwrap_or_else(|| {
700 "CrateMetadata::kind({:?}): id not found, in crate {:?} with number {}",
708 fn def_kind(&self, item_id: DefIndex) -> DefKind {
709 self.root.tables.def_kind.get(self, item_id).map(|k| k.decode(self)).unwrap_or_else(|| {
711 "CrateMetadata::def_kind({:?}): id not found, in crate {:?} with number {}",
719 fn get_span(&self, index: DefIndex, sess: &Session) -> Span {
724 .unwrap_or_else(|| panic!("Missing span for {:?}", index))
725 .decode((self, sess))
728 fn load_proc_macro(&self, def_id: DefId, sess: &Session) -> SyntaxExtension {
729 let (name, kind, helper_attrs) = match *self.raw_proc_macro(def_id.index) {
730 ProcMacro::CustomDerive { trait_name, attributes, client } => {
732 attributes.iter().cloned().map(Symbol::intern).collect::<Vec<_>>();
735 SyntaxExtensionKind::Derive(Box::new(ProcMacroDerive {
742 ProcMacro::Attr { name, client } => (
744 SyntaxExtensionKind::Attr(Box::new(AttrProcMacro { client, krate: def_id.krate })),
747 ProcMacro::Bang { name, client } => (
749 SyntaxExtensionKind::Bang(Box::new(BangProcMacro { client, krate: def_id.krate })),
754 let attrs: Vec<_> = self.get_item_attrs(def_id.index, sess).collect();
755 SyntaxExtension::new(
758 self.get_span(def_id.index, sess),
761 Symbol::intern(name),
766 fn get_trait_def(&self, item_id: DefIndex, sess: &Session) -> ty::TraitDef {
767 match self.kind(item_id) {
768 EntryKind::Trait(data) => {
769 let data = data.decode((self, sess));
771 self.local_def_id(item_id),
776 data.skip_array_during_method_dispatch,
777 data.specialization_kind,
778 self.def_path_hash(item_id),
781 EntryKind::TraitAlias => ty::TraitDef::new(
782 self.local_def_id(item_id),
783 hir::Unsafety::Normal,
788 ty::trait_def::TraitSpecializationKind::None,
789 self.def_path_hash(item_id),
791 _ => bug!("def-index does not refer to trait or trait alias"),
801 ) -> ty::VariantDef {
802 let data = match kind {
803 EntryKind::Variant(data) | EntryKind::Struct(data, _) | EntryKind::Union(data, _) => {
809 let adt_kind = match kind {
810 EntryKind::Variant(_) => ty::AdtKind::Enum,
811 EntryKind::Struct(..) => ty::AdtKind::Struct,
812 EntryKind::Union(..) => ty::AdtKind::Union,
817 if adt_kind == ty::AdtKind::Enum { Some(self.local_def_id(index)) } else { None };
818 let ctor_did = data.ctor.map(|index| self.local_def_id(index));
821 self.item_ident(index, sess),
829 .unwrap_or_else(Lazy::empty)
831 .map(|index| ty::FieldDef {
832 did: self.local_def_id(index),
833 ident: self.item_ident(index, sess),
834 vis: self.get_visibility(index),
841 data.is_non_exhaustive,
845 fn get_adt_def(&self, item_id: DefIndex, tcx: TyCtxt<'tcx>) -> &'tcx ty::AdtDef {
846 let kind = self.kind(item_id);
847 let did = self.local_def_id(item_id);
849 let (adt_kind, repr) = match kind {
850 EntryKind::Enum(repr) => (ty::AdtKind::Enum, repr),
851 EntryKind::Struct(_, repr) => (ty::AdtKind::Struct, repr),
852 EntryKind::Union(_, repr) => (ty::AdtKind::Union, repr),
853 _ => bug!("get_adt_def called on a non-ADT {:?}", did),
856 let variants = if let ty::AdtKind::Enum = adt_kind {
861 .unwrap_or_else(Lazy::empty)
863 .map(|index| self.get_variant(&self.kind(index), index, did, tcx.sess))
866 std::iter::once(self.get_variant(&kind, item_id, did, tcx.sess)).collect()
869 tcx.alloc_adt_def(did, adt_kind, variants, repr)
872 fn get_explicit_predicates(
876 ) -> ty::GenericPredicates<'tcx> {
877 self.root.tables.explicit_predicates.get(self, item_id).unwrap().decode((self, tcx))
880 fn get_inferred_outlives(
884 ) -> &'tcx [(ty::Predicate<'tcx>, Span)] {
889 .map(|predicates| tcx.arena.alloc_from_iter(predicates.decode((self, tcx))))
893 fn get_super_predicates(
897 ) -> ty::GenericPredicates<'tcx> {
898 self.root.tables.super_predicates.get(self, item_id).unwrap().decode((self, tcx))
901 fn get_explicit_item_bounds(
905 ) -> &'tcx [(ty::Predicate<'tcx>, Span)] {
908 .explicit_item_bounds
910 .map(|bounds| tcx.arena.alloc_from_iter(bounds.decode((self, tcx))))
914 fn get_generics(&self, item_id: DefIndex, sess: &Session) -> ty::Generics {
915 self.root.tables.generics.get(self, item_id).unwrap().decode((self, sess))
918 fn get_type(&self, id: DefIndex, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
923 .unwrap_or_else(|| panic!("Not a type: {:?}", id))
927 fn get_stability(&self, id: DefIndex) -> Option<attr::Stability> {
928 self.root.tables.stability.get(self, id).map(|stab| stab.decode(self))
931 fn get_const_stability(&self, id: DefIndex) -> Option<attr::ConstStability> {
932 self.root.tables.const_stability.get(self, id).map(|stab| stab.decode(self))
935 fn get_deprecation(&self, id: DefIndex) -> Option<attr::Deprecation> {
936 self.root.tables.deprecation.get(self, id).map(|depr| depr.decode(self))
939 fn get_visibility(&self, id: DefIndex) -> ty::Visibility {
940 self.root.tables.visibility.get(self, id).unwrap().decode(self)
943 fn get_impl_data(&self, id: DefIndex) -> ImplData {
944 match self.kind(id) {
945 EntryKind::Impl(data) => data.decode(self),
950 fn get_parent_impl(&self, id: DefIndex) -> Option<DefId> {
951 self.get_impl_data(id).parent_impl
954 fn get_impl_polarity(&self, id: DefIndex) -> ty::ImplPolarity {
955 self.get_impl_data(id).polarity
958 fn get_impl_defaultness(&self, id: DefIndex) -> hir::Defaultness {
959 self.get_impl_data(id).defaultness
962 fn get_coerce_unsized_info(&self, id: DefIndex) -> Option<ty::adjustment::CoerceUnsizedInfo> {
963 self.get_impl_data(id).coerce_unsized_info
966 fn get_impl_trait(&self, id: DefIndex, tcx: TyCtxt<'tcx>) -> Option<ty::TraitRef<'tcx>> {
967 self.root.tables.impl_trait_ref.get(self, id).map(|tr| tr.decode((self, tcx)))
970 fn get_expn_that_defined(&self, id: DefIndex, sess: &Session) -> ExpnId {
971 self.root.tables.expn_that_defined.get(self, id).unwrap().decode((self, sess))
974 fn get_const_param_default(
978 ) -> rustc_middle::ty::Const<'tcx> {
979 self.root.tables.const_defaults.get(self, id).unwrap().decode((self, tcx))
982 /// Iterates over all the stability attributes in the given crate.
983 fn get_lib_features(&self, tcx: TyCtxt<'tcx>) -> &'tcx [(Symbol, Option<Symbol>)] {
984 // FIXME: For a proc macro crate, not sure whether we should return the "host"
985 // features or an empty Vec. Both don't cause ICEs.
986 tcx.arena.alloc_from_iter(self.root.lib_features.decode(self))
989 /// Iterates over the language items in the given crate.
990 fn get_lang_items(&self, tcx: TyCtxt<'tcx>) -> &'tcx [(DefId, usize)] {
991 if self.root.is_proc_macro_crate() {
992 // Proc macro crates do not export any lang-items to the target.
995 tcx.arena.alloc_from_iter(
999 .map(|(def_index, index)| (self.local_def_id(def_index), index)),
1004 /// Iterates over the diagnostic items in the given crate.
1005 fn get_diagnostic_items(&self) -> FxHashMap<Symbol, DefId> {
1006 if self.root.is_proc_macro_crate() {
1007 // Proc macro crates do not export any diagnostic-items to the target.
1013 .map(|(name, def_index)| (name, self.local_def_id(def_index)))
1018 /// Iterates over each child of the given item.
1019 fn each_child_of_item<F>(&self, id: DefIndex, mut callback: F, sess: &Session)
1021 F: FnMut(Export<hir::HirId>),
1023 if let Some(data) = &self.root.proc_macro_data {
1024 /* If we are loading as a proc macro, we want to return the view of this crate
1025 * as a proc macro crate.
1027 if id == CRATE_DEF_INDEX {
1028 let macros = data.macros.decode(self);
1029 for def_index in macros {
1030 let raw_macro = self.raw_proc_macro(def_index);
1032 DefKind::Macro(macro_kind(raw_macro)),
1033 self.local_def_id(def_index),
1035 let ident = self.item_ident(def_index, sess);
1036 callback(Export { ident, res, vis: ty::Visibility::Public, span: ident.span });
1043 let kind = match self.maybe_kind(id) {
1048 // Iterate over all children.
1049 let macros_only = self.dep_kind.lock().macros_only();
1051 let children = self.root.tables.children.get(self, id).unwrap_or_else(Lazy::empty);
1053 for child_index in children.decode((self, sess)) {
1055 let child_kind = match self.maybe_kind(child_index) {
1056 Some(child_kind) => child_kind,
1060 // Hand off the item to the callback.
1062 // FIXME(eddyb) Don't encode these in children.
1063 EntryKind::ForeignMod => {
1064 let child_children = self
1068 .get(self, child_index)
1069 .unwrap_or_else(Lazy::empty);
1070 for child_index in child_children.decode((self, sess)) {
1071 let kind = self.def_kind(child_index);
1073 res: Res::Def(kind, self.local_def_id(child_index)),
1074 ident: self.item_ident(child_index, sess),
1075 vis: self.get_visibility(child_index),
1080 .get(self, child_index)
1082 .decode((self, sess)),
1087 EntryKind::Impl(_) => continue,
1092 let def_key = self.def_key(child_index);
1093 if def_key.disambiguated_data.data.get_opt_name().is_some() {
1094 let span = self.get_span(child_index, sess);
1095 let kind = self.def_kind(child_index);
1096 let ident = self.item_ident(child_index, sess);
1097 let vis = self.get_visibility(child_index);
1098 let def_id = self.local_def_id(child_index);
1099 let res = Res::Def(kind, def_id);
1100 callback(Export { res, ident, vis, span });
1101 // For non-re-export structs and variants add their constructors to children.
1102 // Re-export lists automatically contain constructors when necessary.
1104 DefKind::Struct => {
1105 if let Some(ctor_def_id) = self.get_ctor_def_id(child_index) {
1106 let ctor_kind = self.get_ctor_kind(child_index);
1108 Res::Def(DefKind::Ctor(CtorOf::Struct, ctor_kind), ctor_def_id);
1109 let vis = self.get_visibility(ctor_def_id.index);
1110 callback(Export { res: ctor_res, vis, ident, span });
1113 DefKind::Variant => {
1114 // Braced variants, unlike structs, generate unusable names in
1115 // value namespace, they are reserved for possible future use.
1116 // It's ok to use the variant's id as a ctor id since an
1117 // error will be reported on any use of such resolution anyway.
1118 let ctor_def_id = self.get_ctor_def_id(child_index).unwrap_or(def_id);
1119 let ctor_kind = self.get_ctor_kind(child_index);
1121 Res::Def(DefKind::Ctor(CtorOf::Variant, ctor_kind), ctor_def_id);
1122 let mut vis = self.get_visibility(ctor_def_id.index);
1123 if ctor_def_id == def_id && vis == ty::Visibility::Public {
1124 // For non-exhaustive variants lower the constructor visibility to
1125 // within the crate. We only need this for fictive constructors,
1126 // for other constructors correct visibilities
1127 // were already encoded in metadata.
1128 let mut attrs = self.get_item_attrs(def_id.index, sess);
1129 if attrs.any(|item| item.has_name(sym::non_exhaustive)) {
1130 let crate_def_id = self.local_def_id(CRATE_DEF_INDEX);
1131 vis = ty::Visibility::Restricted(crate_def_id);
1134 callback(Export { res: ctor_res, ident, vis, span });
1142 if let EntryKind::Mod(data) = kind {
1143 for exp in data.decode((self, sess)).reexports.decode((self, sess)) {
1145 Res::Def(DefKind::Macro(..), _) => {}
1146 _ if macros_only => continue,
1154 fn is_ctfe_mir_available(&self, id: DefIndex) -> bool {
1155 self.root.tables.mir_for_ctfe.get(self, id).is_some()
1158 fn is_item_mir_available(&self, id: DefIndex) -> bool {
1159 self.root.tables.mir.get(self, id).is_some()
1162 fn module_expansion(&self, id: DefIndex, sess: &Session) -> ExpnId {
1163 if let EntryKind::Mod(m) = self.kind(id) {
1164 m.decode((self, sess)).expansion
1166 panic!("Expected module, found {:?}", self.local_def_id(id))
1170 fn get_optimized_mir(&self, tcx: TyCtxt<'tcx>, id: DefIndex) -> Body<'tcx> {
1175 .unwrap_or_else(|| {
1176 bug!("get_optimized_mir: missing MIR for `{:?}`", self.local_def_id(id))
1178 .decode((self, tcx))
1181 fn get_mir_for_ctfe(&self, tcx: TyCtxt<'tcx>, id: DefIndex) -> Body<'tcx> {
1186 .unwrap_or_else(|| {
1187 bug!("get_mir_for_ctfe: missing MIR for `{:?}`", self.local_def_id(id))
1189 .decode((self, tcx))
1192 fn get_mir_abstract_const(
1196 ) -> Result<Option<&'tcx [mir::abstract_const::Node<'tcx>]>, ErrorReported> {
1199 .mir_abstract_consts
1201 .map_or(Ok(None), |v| Ok(Some(v.decode((self, tcx)))))
1204 fn get_unused_generic_params(&self, id: DefIndex) -> FiniteBitSet<u32> {
1207 .unused_generic_params
1209 .map(|params| params.decode(self))
1210 .unwrap_or_default()
1213 fn get_promoted_mir(&self, tcx: TyCtxt<'tcx>, id: DefIndex) -> IndexVec<Promoted, Body<'tcx>> {
1218 .unwrap_or_else(|| {
1219 bug!("get_promoted_mir: missing MIR for `{:?}`", self.local_def_id(id))
1221 .decode((self, tcx))
1224 fn mir_const_qualif(&self, id: DefIndex) -> mir::ConstQualifs {
1225 match self.kind(id) {
1226 EntryKind::AnonConst(qualif, _)
1227 | EntryKind::Const(qualif, _)
1228 | EntryKind::AssocConst(
1229 AssocContainer::ImplDefault
1230 | AssocContainer::ImplFinal
1231 | AssocContainer::TraitWithDefault,
1235 _ => bug!("mir_const_qualif: unexpected kind"),
1239 fn get_associated_item(&self, id: DefIndex, sess: &Session) -> ty::AssocItem {
1240 let def_key = self.def_key(id);
1241 let parent = self.local_def_id(def_key.parent.unwrap());
1242 let ident = self.item_ident(id, sess);
1244 let (kind, container, has_self) = match self.kind(id) {
1245 EntryKind::AssocConst(container, _, _) => (ty::AssocKind::Const, container, false),
1246 EntryKind::AssocFn(data) => {
1247 let data = data.decode(self);
1248 (ty::AssocKind::Fn, data.container, data.has_self)
1250 EntryKind::AssocType(container) => (ty::AssocKind::Type, container, false),
1251 _ => bug!("cannot get associated-item of `{:?}`", def_key),
1257 vis: self.get_visibility(id),
1258 defaultness: container.defaultness(),
1259 def_id: self.local_def_id(id),
1260 container: container.with_def_id(parent),
1261 fn_has_self_parameter: has_self,
1265 fn get_item_variances(&'a self, id: DefIndex) -> impl Iterator<Item = ty::Variance> + 'a {
1266 self.root.tables.variances.get(self, id).unwrap_or_else(Lazy::empty).decode(self)
1269 fn get_ctor_kind(&self, node_id: DefIndex) -> CtorKind {
1270 match self.kind(node_id) {
1271 EntryKind::Struct(data, _) | EntryKind::Union(data, _) | EntryKind::Variant(data) => {
1272 data.decode(self).ctor_kind
1274 _ => CtorKind::Fictive,
1278 fn get_ctor_def_id(&self, node_id: DefIndex) -> Option<DefId> {
1279 match self.kind(node_id) {
1280 EntryKind::Struct(data, _) => {
1281 data.decode(self).ctor.map(|index| self.local_def_id(index))
1283 EntryKind::Variant(data) => {
1284 data.decode(self).ctor.map(|index| self.local_def_id(index))
1294 ) -> impl Iterator<Item = ast::Attribute> + 'a {
1295 // The attributes for a tuple struct/variant are attached to the definition, not the ctor;
1296 // we assume that someone passing in a tuple struct ctor is actually wanting to
1297 // look at the definition
1298 let def_key = self.def_key(node_id);
1299 let item_id = if def_key.disambiguated_data.data == DefPathData::Ctor {
1300 def_key.parent.unwrap()
1309 .unwrap_or_else(Lazy::empty)
1310 .decode((self, sess))
1313 fn get_struct_field_names(&self, id: DefIndex, sess: &Session) -> Vec<Spanned<Symbol>> {
1318 .unwrap_or_else(Lazy::empty)
1320 .map(|index| respan(self.get_span(index, sess), self.item_ident(index, sess).name))
1324 fn get_struct_field_visibilities(&self, id: DefIndex) -> Vec<Visibility> {
1329 .unwrap_or_else(Lazy::empty)
1331 .map(|field_index| self.get_visibility(field_index))
1335 fn get_inherent_implementations_for_type(
1339 ) -> &'tcx [DefId] {
1340 tcx.arena.alloc_from_iter(
1345 .unwrap_or_else(Lazy::empty)
1347 .map(|index| self.local_def_id(index)),
1351 fn get_implementations_for_trait(
1354 filter: Option<DefId>,
1355 ) -> &'tcx [(DefId, Option<ty::fast_reject::SimplifiedType>)] {
1356 if self.root.is_proc_macro_crate() {
1357 // proc-macro crates export no trait impls.
1361 if let Some(def_id) = filter {
1362 // Do a reverse lookup beforehand to avoid touching the crate_num
1363 // hash map in the loop below.
1364 let filter = match self.reverse_translate_def_id(def_id) {
1365 Some(def_id) => (def_id.krate.as_u32(), def_id.index),
1369 if let Some(impls) = self.trait_impls.get(&filter) {
1370 tcx.arena.alloc_from_iter(
1371 impls.decode(self).map(|(idx, simplified_self_ty)| {
1372 (self.local_def_id(idx), simplified_self_ty)
1379 tcx.arena.alloc_from_iter(self.trait_impls.values().flat_map(|impls| {
1382 .map(|(idx, simplified_self_ty)| (self.local_def_id(idx), simplified_self_ty))
1387 fn get_trait_of_item(&self, id: DefIndex) -> Option<DefId> {
1388 let def_key = self.def_key(id);
1389 match def_key.disambiguated_data.data {
1390 DefPathData::TypeNs(..) | DefPathData::ValueNs(..) => (),
1391 // Not an associated item
1394 def_key.parent.and_then(|parent_index| match self.kind(parent_index) {
1395 EntryKind::Trait(_) | EntryKind::TraitAlias => Some(self.local_def_id(parent_index)),
1400 fn get_native_libraries(&self, sess: &Session) -> Vec<NativeLib> {
1401 if self.root.is_proc_macro_crate() {
1402 // Proc macro crates do not have any *target* native libraries.
1405 self.root.native_libraries.decode((self, sess)).collect()
1409 fn get_proc_macro_quoted_span(&self, index: usize, sess: &Session) -> Span {
1412 .proc_macro_quoted_spans
1414 .unwrap_or_else(|| panic!("Missing proc macro quoted span: {:?}", index))
1415 .decode((self, sess))
1418 fn get_foreign_modules(&self, tcx: TyCtxt<'tcx>) -> Lrc<FxHashMap<DefId, ForeignModule>> {
1419 if self.root.is_proc_macro_crate() {
1420 // Proc macro crates do not have any *target* foreign modules.
1421 Lrc::new(FxHashMap::default())
1423 let modules: FxHashMap<DefId, ForeignModule> =
1424 self.root.foreign_modules.decode((self, tcx.sess)).map(|m| (m.def_id, m)).collect();
1429 fn get_dylib_dependency_formats(
1432 ) -> &'tcx [(CrateNum, LinkagePreference)] {
1433 tcx.arena.alloc_from_iter(
1434 self.root.dylib_dependency_formats.decode(self).enumerate().flat_map(|(i, link)| {
1435 let cnum = CrateNum::new(i + 1);
1436 link.map(|link| (self.cnum_map[cnum], link))
1441 fn get_missing_lang_items(&self, tcx: TyCtxt<'tcx>) -> &'tcx [lang_items::LangItem] {
1442 if self.root.is_proc_macro_crate() {
1443 // Proc macro crates do not depend on any target weak lang-items.
1446 tcx.arena.alloc_from_iter(self.root.lang_items_missing.decode(self))
1450 fn get_fn_param_names(&self, tcx: TyCtxt<'tcx>, id: DefIndex) -> &'tcx [Ident] {
1451 let param_names = match self.kind(id) {
1452 EntryKind::Fn(data) | EntryKind::ForeignFn(data) => data.decode(self).param_names,
1453 EntryKind::AssocFn(data) => data.decode(self).fn_data.param_names,
1456 tcx.arena.alloc_from_iter(param_names.decode((self, tcx)))
1459 fn exported_symbols(
1462 ) -> &'tcx [(ExportedSymbol<'tcx>, SymbolExportLevel)] {
1463 if self.root.is_proc_macro_crate() {
1464 // If this crate is a custom derive crate, then we're not even going to
1465 // link those in so we skip those crates.
1468 tcx.arena.alloc_from_iter(self.root.exported_symbols.decode((self, tcx)))
1472 fn get_rendered_const(&self, id: DefIndex) -> String {
1473 match self.kind(id) {
1474 EntryKind::AnonConst(_, data)
1475 | EntryKind::Const(_, data)
1476 | EntryKind::AssocConst(_, _, data) => data.decode(self).0,
1481 fn get_macro(&self, id: DefIndex, sess: &Session) -> MacroDef {
1482 match self.kind(id) {
1483 EntryKind::MacroDef(macro_def) => macro_def.decode((self, sess)),
1488 // This replicates some of the logic of the crate-local `is_const_fn_raw` query, because we
1489 // don't serialize constness for tuple variant and tuple struct constructors.
1490 fn is_const_fn_raw(&self, id: DefIndex) -> bool {
1491 let constness = match self.kind(id) {
1492 EntryKind::AssocFn(data) => data.decode(self).fn_data.constness,
1493 EntryKind::Fn(data) => data.decode(self).constness,
1494 EntryKind::ForeignFn(data) => data.decode(self).constness,
1495 EntryKind::Variant(..) | EntryKind::Struct(..) => hir::Constness::Const,
1496 _ => hir::Constness::NotConst,
1498 constness == hir::Constness::Const
1501 fn asyncness(&self, id: DefIndex) -> hir::IsAsync {
1502 match self.kind(id) {
1503 EntryKind::Fn(data) => data.decode(self).asyncness,
1504 EntryKind::AssocFn(data) => data.decode(self).fn_data.asyncness,
1505 EntryKind::ForeignFn(data) => data.decode(self).asyncness,
1506 _ => bug!("asyncness: expected function kind"),
1510 fn is_foreign_item(&self, id: DefIndex) -> bool {
1511 match self.kind(id) {
1512 EntryKind::ForeignImmStatic | EntryKind::ForeignMutStatic | EntryKind::ForeignFn(_) => {
1519 fn static_mutability(&self, id: DefIndex) -> Option<hir::Mutability> {
1520 match self.kind(id) {
1521 EntryKind::ImmStatic | EntryKind::ForeignImmStatic => Some(hir::Mutability::Not),
1522 EntryKind::MutStatic | EntryKind::ForeignMutStatic => Some(hir::Mutability::Mut),
1527 fn generator_kind(&self, id: DefIndex) -> Option<hir::GeneratorKind> {
1528 match self.kind(id) {
1529 EntryKind::Generator(data) => Some(data),
1534 fn fn_sig(&self, id: DefIndex, tcx: TyCtxt<'tcx>) -> ty::PolyFnSig<'tcx> {
1535 self.root.tables.fn_sig.get(self, id).unwrap().decode((self, tcx))
1539 fn def_key(&self, index: DefIndex) -> DefKey {
1544 .or_insert_with(|| self.root.tables.def_keys.get(self, index).unwrap().decode(self))
1547 /// Finds the corresponding `DefId` for the provided `DefPathHash`, if it exists.
1548 /// This is used by incremental compilation to map a serialized `DefPathHash` to
1549 /// its `DefId` in the current session.
1550 /// Normally, only one 'main' crate will change between incremental compilation sessions:
1551 /// all dependencies will be completely unchanged. In this case, we can avoid
1552 /// decoding every `DefPathHash` in the crate, since the `DefIndex` from the previous
1553 /// session will still be valid. If our 'guess' is wrong (the `DefIndex` no longer exists,
1554 /// or has a different `DefPathHash`, then we need to decode all `DefPathHashes` to determine
1555 /// the correct mapping).
1556 fn def_path_hash_to_def_id(
1561 ) -> Option<DefId> {
1562 let def_index_guess = DefIndex::from_u32(index_guess);
1567 .get(self, def_index_guess)
1568 .map(|lazy| lazy.decode(self));
1570 // Fast path: the definition and its index is unchanged from the
1571 // previous compilation session. There is no need to decode anything
1573 if old_hash == Some(hash) {
1574 return Some(DefId { krate, index: def_index_guess });
1577 let is_proc_macro = self.is_proc_macro_crate();
1579 // Slow path: We need to find out the new `DefIndex` of the provided
1580 // `DefPathHash`, if its still exists. This requires decoding every `DefPathHash`
1581 // stored in this crate.
1582 let map = self.cdata.def_path_hash_map.get_or_init(|| {
1583 let end_id = self.root.tables.def_path_hashes.size() as u32;
1584 let mut map = UnhashMap::with_capacity_and_hasher(end_id as usize, Default::default());
1585 for i in 0..end_id {
1586 let def_index = DefIndex::from_u32(i);
1587 // There may be gaps in the encoded table if we're decoding a proc-macro crate
1588 if let Some(hash) = self.root.tables.def_path_hashes.get(self, def_index) {
1589 map.insert(hash.decode(self), def_index);
1590 } else if !is_proc_macro {
1591 panic!("Missing def_path_hashes entry for {:?}", def_index);
1596 map.get(&hash).map(|index| DefId { krate, index: *index })
1599 // Returns the path leading to the thing with this `id`.
1600 fn def_path(&self, id: DefIndex) -> DefPath {
1601 debug!("def_path(cnum={:?}, id={:?})", self.cnum, id);
1602 DefPath::make(self.cnum, id, |parent| self.def_key(parent))
1605 fn def_path_hash_unlocked(
1608 def_path_hashes: &mut FxHashMap<DefIndex, DefPathHash>,
1610 *def_path_hashes.entry(index).or_insert_with(|| {
1611 self.root.tables.def_path_hashes.get(self, index).unwrap().decode(self)
1616 fn def_path_hash(&self, index: DefIndex) -> DefPathHash {
1617 let mut def_path_hashes = self.def_path_hash_cache.lock();
1618 self.def_path_hash_unlocked(index, &mut def_path_hashes)
1621 /// Imports the source_map from an external crate into the source_map of the crate
1622 /// currently being compiled (the "local crate").
1624 /// The import algorithm works analogous to how AST items are inlined from an
1625 /// external crate's metadata:
1626 /// For every SourceFile in the external source_map an 'inline' copy is created in the
1627 /// local source_map. The correspondence relation between external and local
1628 /// SourceFiles is recorded in the `ImportedSourceFile` objects returned from this
1629 /// function. When an item from an external crate is later inlined into this
1630 /// crate, this correspondence information is used to translate the span
1631 /// information of the inlined item so that it refers the correct positions in
1632 /// the local source_map (see `<decoder::DecodeContext as SpecializedDecoder<Span>>`).
1634 /// The import algorithm in the function below will reuse SourceFiles already
1635 /// existing in the local source_map. For example, even if the SourceFile of some
1636 /// source file of libstd gets imported many times, there will only ever be
1637 /// one SourceFile object for the corresponding file in the local source_map.
1639 /// Note that imported SourceFiles do not actually contain the source code of the
1640 /// file they represent, just information about length, line breaks, and
1641 /// multibyte characters. This information is enough to generate valid debuginfo
1642 /// for items inlined from other crates.
1644 /// Proc macro crates don't currently export spans, so this function does not have
1645 /// to work for them.
1646 fn imported_source_files(&self, sess: &Session) -> &'a [ImportedSourceFile] {
1647 // Translate the virtual `/rustc/$hash` prefix back to a real directory
1648 // that should hold actual sources, where possible.
1650 // NOTE: if you update this, you might need to also update bootstrap's code for generating
1651 // the `rust-src` component in `Src::run` in `src/bootstrap/dist.rs`.
1652 let virtual_rust_source_base_dir = option_env!("CFG_VIRTUAL_RUST_SOURCE_BASE_DIR")
1655 // Only spend time on further checks if we have what to translate *to*.
1656 sess.opts.real_rust_source_base_dir.is_some()
1658 .filter(|virtual_dir| {
1659 // Don't translate away `/rustc/$hash` if we're still remapping to it,
1660 // since that means we're still building `std`/`rustc` that need it,
1661 // and we don't want the real path to leak into codegen/debuginfo.
1662 !sess.opts.remap_path_prefix.iter().any(|(_from, to)| to == virtual_dir)
1664 let try_to_translate_virtual_to_real = |name: &mut rustc_span::FileName| {
1666 "try_to_translate_virtual_to_real(name={:?}): \
1667 virtual_rust_source_base_dir={:?}, real_rust_source_base_dir={:?}",
1668 name, virtual_rust_source_base_dir, sess.opts.real_rust_source_base_dir,
1671 if let Some(virtual_dir) = virtual_rust_source_base_dir {
1672 if let Some(real_dir) = &sess.opts.real_rust_source_base_dir {
1673 if let rustc_span::FileName::Real(old_name) = name {
1674 if let rustc_span::RealFileName::Remapped { local_path: _, virtual_name } =
1677 if let Ok(rest) = virtual_name.strip_prefix(virtual_dir) {
1678 let virtual_name = virtual_name.clone();
1680 // The std library crates are in
1681 // `$sysroot/lib/rustlib/src/rust/library`, whereas other crates
1682 // may be in `$sysroot/lib/rustlib/src/rust/` directly. So we
1683 // detect crates from the std libs and handle them specially.
1684 const STD_LIBS: &[&str] = &[
1694 "profiler_builtins",
1696 "rustc-std-workspace-core",
1697 "rustc-std-workspace-alloc",
1698 "rustc-std-workspace-std",
1701 let is_std_lib = STD_LIBS.iter().any(|l| rest.starts_with(l));
1703 let new_path = if is_std_lib {
1704 real_dir.join("library").join(rest)
1710 "try_to_translate_virtual_to_real: `{}` -> `{}`",
1711 virtual_name.display(),
1714 let new_name = rustc_span::RealFileName::Remapped {
1715 local_path: Some(new_path),
1718 *old_name = new_name;
1726 self.cdata.source_map_import_info.get_or_init(|| {
1727 let external_source_map = self.root.source_map.decode(self);
1730 .map(|source_file_to_import| {
1731 // We can't reuse an existing SourceFile, so allocate a new one
1732 // containing the information we need.
1733 let rustc_span::SourceFile {
1739 mut multibyte_chars,
1740 mut non_narrow_chars,
1744 } = source_file_to_import;
1746 // If this file is under $sysroot/lib/rustlib/src/ but has not been remapped
1747 // during rust bootstrapping by `remap-debuginfo = true`, and the user
1748 // wish to simulate that behaviour by -Z simulate-remapped-rust-src-base,
1749 // then we change `name` to a similar state as if the rust was bootstrapped
1750 // with `remap-debuginfo = true`.
1751 // This is useful for testing so that tests about the effects of
1752 // `try_to_translate_virtual_to_real` don't have to worry about how the
1753 // compiler is bootstrapped.
1754 if let Some(virtual_dir) =
1755 &sess.opts.debugging_opts.simulate_remapped_rust_src_base
1757 if let Some(real_dir) = &sess.opts.real_rust_source_base_dir {
1758 if let rustc_span::FileName::Real(ref mut old_name) = name {
1759 if let rustc_span::RealFileName::LocalPath(local) = old_name {
1760 if let Ok(rest) = local.strip_prefix(real_dir) {
1761 *old_name = rustc_span::RealFileName::Remapped {
1763 virtual_name: virtual_dir.join(rest),
1771 // If this file's path has been remapped to `/rustc/$hash`,
1772 // we might be able to reverse that (also see comments above,
1773 // on `try_to_translate_virtual_to_real`).
1774 try_to_translate_virtual_to_real(&mut name);
1776 let source_length = (end_pos - start_pos).to_usize();
1778 // Translate line-start positions and multibyte character
1779 // position into frame of reference local to file.
1780 // `SourceMap::new_imported_source_file()` will then translate those
1781 // coordinates to their new global frame of reference when the
1782 // offset of the SourceFile is known.
1783 for pos in &mut lines {
1784 *pos = *pos - start_pos;
1786 for mbc in &mut multibyte_chars {
1787 mbc.pos = mbc.pos - start_pos;
1789 for swc in &mut non_narrow_chars {
1790 *swc = *swc - start_pos;
1792 for np in &mut normalized_pos {
1793 np.pos = np.pos - start_pos;
1796 let local_version = sess.source_map().new_imported_source_file(
1810 "CrateMetaData::imported_source_files alloc \
1811 source_file {:?} original (start_pos {:?} end_pos {:?}) \
1812 translated (start_pos {:?} end_pos {:?})",
1816 local_version.start_pos,
1817 local_version.end_pos
1820 ImportedSourceFile {
1821 original_start_pos: start_pos,
1822 original_end_pos: end_pos,
1823 translated_source_file: local_version,
1831 impl CrateMetadata {
1835 root: CrateRoot<'static>,
1836 raw_proc_macros: Option<&'static [ProcMacro]>,
1838 cnum_map: CrateNumMap,
1839 dep_kind: CrateDepKind,
1840 source: CrateSource,
1842 host_hash: Option<Svh>,
1843 ) -> CrateMetadata {
1844 let trait_impls = root
1846 .decode((&blob, sess))
1847 .map(|trait_impls| (trait_impls.trait_id, trait_impls.impls))
1849 let alloc_decoding_state =
1850 AllocDecodingState::new(root.interpret_alloc_index.decode(&blob).collect());
1851 let dependencies = Lock::new(cnum_map.iter().cloned().collect());
1857 source_map_import_info: OnceCell::new(),
1858 def_path_hash_map: Default::default(),
1859 alloc_decoding_state,
1863 dep_kind: Lock::new(dep_kind),
1867 extern_crate: Lock::new(None),
1868 hygiene_context: Default::default(),
1869 def_key_cache: Default::default(),
1870 def_path_hash_cache: Default::default(),
1874 crate fn dependencies(&self) -> LockGuard<'_, Vec<CrateNum>> {
1875 self.dependencies.borrow()
1878 crate fn add_dependency(&self, cnum: CrateNum) {
1879 self.dependencies.borrow_mut().push(cnum);
1882 crate fn update_extern_crate(&self, new_extern_crate: ExternCrate) -> bool {
1883 let mut extern_crate = self.extern_crate.borrow_mut();
1884 let update = Some(new_extern_crate.rank()) > extern_crate.as_ref().map(ExternCrate::rank);
1886 *extern_crate = Some(new_extern_crate);
1891 crate fn source(&self) -> &CrateSource {
1895 crate fn dep_kind(&self) -> CrateDepKind {
1896 *self.dep_kind.lock()
1899 crate fn update_dep_kind(&self, f: impl FnOnce(CrateDepKind) -> CrateDepKind) {
1900 self.dep_kind.with_lock(|dep_kind| *dep_kind = f(*dep_kind))
1903 crate fn panic_strategy(&self) -> PanicStrategy {
1904 self.root.panic_strategy
1907 crate fn needs_panic_runtime(&self) -> bool {
1908 self.root.needs_panic_runtime
1911 crate fn is_panic_runtime(&self) -> bool {
1912 self.root.panic_runtime
1915 crate fn is_profiler_runtime(&self) -> bool {
1916 self.root.profiler_runtime
1919 crate fn needs_allocator(&self) -> bool {
1920 self.root.needs_allocator
1923 crate fn has_global_allocator(&self) -> bool {
1924 self.root.has_global_allocator
1927 crate fn has_default_lib_allocator(&self) -> bool {
1928 self.root.has_default_lib_allocator
1931 crate fn is_proc_macro_crate(&self) -> bool {
1932 self.root.is_proc_macro_crate()
1935 crate fn name(&self) -> Symbol {
1939 crate fn stable_crate_id(&self) -> StableCrateId {
1940 self.root.stable_crate_id
1943 crate fn hash(&self) -> Svh {
1947 fn num_def_ids(&self) -> usize {
1948 self.root.tables.def_keys.size()
1951 fn local_def_id(&self, index: DefIndex) -> DefId {
1952 DefId { krate: self.cnum, index }
1955 // Translate a DefId from the current compilation environment to a DefId
1956 // for an external crate.
1957 fn reverse_translate_def_id(&self, did: DefId) -> Option<DefId> {
1958 for (local, &global) in self.cnum_map.iter_enumerated() {
1959 if global == did.krate {
1960 return Some(DefId { krate: local, index: did.index });
1968 // Cannot be implemented on 'ProcMacro', as libproc_macro
1969 // does not depend on librustc_ast
1970 fn macro_kind(raw: &ProcMacro) -> MacroKind {
1972 ProcMacro::CustomDerive { .. } => MacroKind::Derive,
1973 ProcMacro::Attr { .. } => MacroKind::Attr,
1974 ProcMacro::Bang { .. } => MacroKind::Bang,