src/librustc_metadata/cstore.rs

   1 // The crate store - a central repo for information collected about external
   2 // crates and libraries
   3
   4 use crate::schema;
   5 use rustc::hir::def_id::{CrateNum, DefIndex};
   6 use rustc::hir::map::definitions::DefPathTable;
   7 use rustc::middle::cstore::{DepKind, ExternCrate, MetadataLoader};
   8 use rustc::mir::interpret::AllocDecodingState;
   9 use rustc_data_structures::indexed_vec::IndexVec;
  10 use rustc::util::nodemap::{FxHashMap, NodeMap};
  11
  12 use rustc_data_structures::sync::{Lrc, RwLock, Lock};
  13 use syntax::ast;
  14 use syntax::ext::base::SyntaxExtension;
  15 use syntax::symbol::Symbol;
  16 use syntax_pos;
  17
  18 pub use rustc::middle::cstore::{NativeLibrary, NativeLibraryKind, LinkagePreference};
  19 pub use rustc::middle::cstore::NativeLibraryKind::*;
  20 pub use rustc::middle::cstore::{CrateSource, LibSource, ForeignModule};
  21
  22 pub use crate::cstore_impl::{provide, provide_extern};
  23
  24 // A map from external crate numbers (as decoded from some crate file) to
  25 // local crate numbers (as generated during this session). Each external
  26 // crate may refer to types in other external crates, and each has their
  27 // own crate numbers.
  28 pub type CrateNumMap = IndexVec<CrateNum, CrateNum>;
  29
  30 pub use rustc_data_structures::sync::MetadataRef;
  31
  32 pub struct MetadataBlob(pub MetadataRef);
  33
  34 /// Holds information about a syntax_pos::SourceFile imported from another crate.
  35 /// See `imported_source_files()` for more information.
  36 pub struct ImportedSourceFile {
  37     /// This SourceFile's byte-offset within the source_map of its original crate
  38     pub original_start_pos: syntax_pos::BytePos,
  39     /// The end of this SourceFile within the source_map of its original crate
  40     pub original_end_pos: syntax_pos::BytePos,
  41     /// The imported SourceFile's representation within the local source_map
  42     pub translated_source_file: Lrc<syntax_pos::SourceFile>,
  43 }
  44
  45 pub struct CrateMetadata {
  46     /// Original name of the crate.
  47     pub name: Symbol,
  48
  49     /// Name of the crate as imported. I.e., if imported with
  50     /// `extern crate foo as bar;` this will be `bar`.
  51     pub imported_name: Symbol,
  52
  53     /// Information about the extern crate that caused this crate to
  54     /// be loaded. If this is `None`, then the crate was injected
  55     /// (e.g., by the allocator)
  56     pub extern_crate: Lock<Option<ExternCrate>>,
  57
  58     pub blob: MetadataBlob,
  59     pub cnum_map: CrateNumMap,
  60     pub cnum: CrateNum,
  61     pub dependencies: Lock<Vec<CrateNum>>,
  62     pub source_map_import_info: RwLock<Vec<ImportedSourceFile>>,
  63
  64     /// Used for decoding interpret::AllocIds in a cached & thread-safe manner.
  65     pub alloc_decoding_state: AllocDecodingState,
  66
  67     // NOTE(eddyb) we pass `'static` to a `'tcx` parameter because this
  68     // lifetime is only used behind `Lazy` / `LazySeq`, and therefore
  69     // acts like an universal (`for<'tcx>`), that is paired up with
  70     // whichever `TyCtxt` is being used to decode those values.
  71     pub root: schema::CrateRoot<'static>,
  72
  73     /// For each public item in this crate, we encode a key. When the
  74     /// crate is loaded, we read all the keys and put them in this
  75     /// hashmap, which gives the reverse mapping. This allows us to
  76     /// quickly retrace a `DefPath`, which is needed for incremental
  77     /// compilation support.
  78     pub def_path_table: Lrc<DefPathTable>,
  79
  80     pub trait_impls: FxHashMap<(u32, DefIndex), schema::LazySeq<DefIndex>>,
  81
  82     pub dep_kind: Lock<DepKind>,
  83     pub source: CrateSource,
  84
  85     pub proc_macros: Option<Vec<(ast::Name, Lrc<SyntaxExtension>)>>,
  86
  87     /// Whether or not this crate should be consider a private dependency
  88     /// for purposes of the 'exported_private_dependencies' lint
  89     pub private_dep: bool
  90 }
  91
  92 pub struct CStore {
  93     metas: RwLock<IndexVec<CrateNum, Option<Lrc<CrateMetadata>>>>,
  94     /// Map from NodeId's of local extern crate statements to crate numbers
  95     extern_mod_crate_map: Lock<NodeMap<CrateNum>>,
  96     pub metadata_loader: Box<dyn MetadataLoader + Sync>,
  97 }
  98
  99 pub enum LoadedMacro {
 100     MacroDef(ast::Item),
 101     ProcMacro(Lrc<SyntaxExtension>),
 102 }
 103
 104 impl CStore {
 105     pub fn new(metadata_loader: Box<dyn MetadataLoader + Sync>) -> CStore {
 106         CStore {
 107             // We add an empty entry for LOCAL_CRATE (which maps to zero) in
 108             // order to make array indices in `metas` match with the
 109             // corresponding `CrateNum`. This first entry will always remain
 110             // `None`.
 111             metas: RwLock::new(IndexVec::from_elem_n(None, 1)),
 112             extern_mod_crate_map: Default::default(),
 113             metadata_loader,
 114         }
 115     }
 116
 117     pub(super) fn alloc_new_crate_num(&self) -> CrateNum {
 118         let mut metas = self.metas.borrow_mut();
 119         let cnum = CrateNum::new(metas.len());
 120         metas.push(None);
 121         cnum
 122     }
 123
 124     pub(super) fn get_crate_data(&self, cnum: CrateNum) -> Lrc<CrateMetadata> {
 125         self.metas.borrow()[cnum].clone()
 126             .unwrap_or_else(|| panic!("Failed to get crate data for {:?}", cnum))
 127     }
 128
 129     pub(super) fn set_crate_data(&self, cnum: CrateNum, data: Lrc<CrateMetadata>) {
 130         let mut metas = self.metas.borrow_mut();
 131         assert!(metas[cnum].is_none(), "Overwriting crate metadata entry");
 132         metas[cnum] = Some(data);
 133     }
 134
 135     pub(super) fn iter_crate_data<I>(&self, mut i: I)
 136         where I: FnMut(CrateNum, &Lrc<CrateMetadata>)
 137     {
 138         for (k, v) in self.metas.borrow().iter_enumerated() {
 139             if let &Some(ref v) = v {
 140                 i(k, v);
 141             }
 142         }
 143     }
 144
 145     pub(super) fn crate_dependencies_in_rpo(&self, krate: CrateNum) -> Vec<CrateNum> {
 146         let mut ordering = Vec::new();
 147         self.push_dependencies_in_postorder(&mut ordering, krate);
 148         ordering.reverse();
 149         ordering
 150     }
 151
 152     pub(super) fn push_dependencies_in_postorder(&self,
 153                                                  ordering: &mut Vec<CrateNum>,
 154                                                  krate: CrateNum) {
 155         if ordering.contains(&krate) {
 156             return;
 157         }
 158
 159         let data = self.get_crate_data(krate);
 160         for &dep in data.dependencies.borrow().iter() {
 161             if dep != krate {
 162                 self.push_dependencies_in_postorder(ordering, dep);
 163             }
 164         }
 165
 166         ordering.push(krate);
 167     }
 168
 169     pub(super) fn do_postorder_cnums_untracked(&self) -> Vec<CrateNum> {
 170         let mut ordering = Vec::new();
 171         for (num, v) in self.metas.borrow().iter_enumerated() {
 172             if let &Some(_) = v {
 173                 self.push_dependencies_in_postorder(&mut ordering, num);
 174             }
 175         }
 176         return ordering
 177     }
 178
 179     pub(super) fn add_extern_mod_stmt_cnum(&self, emod_id: ast::NodeId, cnum: CrateNum) {
 180         self.extern_mod_crate_map.borrow_mut().insert(emod_id, cnum);
 181     }
 182
 183     pub(super) fn do_extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum> {
 184         self.extern_mod_crate_map.borrow().get(&emod_id).cloned()
 185     }
 186 }