1 //! the rustc crate store interface. This also includes types that
2 //! are *mostly* used as a part of that interface, but these should
3 //! probably get a better home if someone can find one.
5 use crate::search_paths::PathKind;
6 use crate::utils::NativeLibKind;
9 use rustc_data_structures::sync::{self, MetadataRef};
10 use rustc_hir::def_id::{CrateNum, DefId, StableCrateId, LOCAL_CRATE};
11 use rustc_hir::definitions::{DefKey, DefPath, DefPathHash};
12 use rustc_span::hygiene::{ExpnHash, ExpnId};
13 use rustc_span::symbol::Symbol;
15 use rustc_target::spec::Target;
18 use std::path::{Path, PathBuf};
20 // lonely orphan structs and enums looking for a better home
22 /// Where a crate came from on the local filesystem. One of these three options
24 #[derive(PartialEq, Clone, Debug, HashStable_Generic, Encodable, Decodable)]
25 pub struct CrateSource {
26 pub dylib: Option<(PathBuf, PathKind)>,
27 pub rlib: Option<(PathBuf, PathKind)>,
28 pub rmeta: Option<(PathBuf, PathKind)>,
33 pub fn paths(&self) -> impl Iterator<Item = &PathBuf> {
34 self.dylib.iter().chain(self.rlib.iter()).chain(self.rmeta.iter()).map(|p| &p.0)
38 #[derive(Encodable, Decodable, Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Debug)]
39 #[derive(HashStable_Generic)]
40 pub enum CrateDepKind {
41 /// A dependency that is only used for its macros.
43 /// A dependency that is always injected into the dependency list and so
44 /// doesn't need to be linked to an rlib, e.g., the injected allocator.
46 /// A dependency that is required by an rlib version of this crate.
47 /// Ordinary `extern crate`s result in `Explicit` dependencies.
53 pub fn macros_only(self) -> bool {
55 CrateDepKind::MacrosOnly => true,
56 CrateDepKind::Implicit | CrateDepKind::Explicit => false,
61 #[derive(Copy, Debug, PartialEq, Clone, Encodable, Decodable, HashStable_Generic)]
62 pub enum LinkagePreference {
67 #[derive(Debug, Encodable, Decodable, HashStable_Generic)]
68 pub struct NativeLib {
69 pub kind: NativeLibKind,
70 pub name: Option<Symbol>,
71 /// If packed_bundled_libs enabled, actual filename of library is stored.
72 pub filename: Option<Symbol>,
73 pub cfg: Option<ast::MetaItem>,
74 pub foreign_module: Option<DefId>,
75 pub wasm_import_module: Option<Symbol>,
76 pub verbatim: Option<bool>,
77 pub dll_imports: Vec<DllImport>,
81 pub fn has_modifiers(&self) -> bool {
82 self.verbatim.is_some() || self.kind.has_modifiers()
86 /// Different ways that the PE Format can decorate a symbol name.
87 /// From <https://docs.microsoft.com/en-us/windows/win32/debug/pe-format#import-name-type>
88 #[derive(Copy, Clone, Debug, Encodable, Decodable, HashStable_Generic, PartialEq, Eq)]
89 pub enum PeImportNameType {
91 /// Uses the ordinal (i.e., a number) rather than the name.
93 /// Same as IMPORT_NAME
94 /// Name is decorated with all prefixes and suffixes.
96 /// Same as IMPORT_NAME_NOPREFIX
97 /// Prefix (e.g., the leading `_` or `@`) is skipped, but suffix is kept.
99 /// Same as IMPORT_NAME_UNDECORATE
100 /// Prefix (e.g., the leading `_` or `@`) and suffix (the first `@` and all
101 /// trailing characters) are skipped.
105 #[derive(Clone, Debug, Encodable, Decodable, HashStable_Generic)]
106 pub struct DllImport {
108 pub import_name_type: Option<PeImportNameType>,
109 /// Calling convention for the function.
111 /// On x86_64, this is always `DllCallingConvention::C`; on i686, it can be any
112 /// of the values, and we use `DllCallingConvention::C` to represent `"cdecl"`.
113 pub calling_convention: DllCallingConvention,
114 /// Span of import's "extern" declaration; used for diagnostics.
116 /// Is this for a function (rather than a static variable).
121 pub fn ordinal(&self) -> Option<u16> {
122 if let Some(PeImportNameType::Ordinal(ordinal)) = self.import_name_type {
130 /// Calling convention for a function defined in an external library.
132 /// The usize value, where present, indicates the size of the function's argument list
134 #[derive(Clone, PartialEq, Debug, Encodable, Decodable, HashStable_Generic)]
135 pub enum DllCallingConvention {
142 #[derive(Clone, Encodable, Decodable, HashStable_Generic, Debug)]
143 pub struct ForeignModule {
144 pub foreign_items: Vec<DefId>,
148 #[derive(Copy, Clone, Debug, HashStable_Generic)]
149 pub struct ExternCrate {
150 pub src: ExternCrateSource,
152 /// span of the extern crate that caused this to be loaded
155 /// Number of links to reach the extern;
156 /// used to select the extern with the shortest path
159 /// Crate that depends on this crate
160 pub dependency_of: CrateNum,
164 /// If true, then this crate is the crate named by the extern
165 /// crate referenced above. If false, then this crate is a dep
168 pub fn is_direct(&self) -> bool {
169 self.dependency_of == LOCAL_CRATE
173 pub fn rank(&self) -> impl PartialOrd {
175 // - direct extern crate to indirect
176 // - shorter paths to longer
177 (self.is_direct(), !self.path_len)
181 #[derive(Copy, Clone, Debug, HashStable_Generic)]
182 pub enum ExternCrateSource {
183 /// Crate is loaded by `extern crate`.
185 /// def_id of the item in the current crate that caused
186 /// this crate to be loaded; note that there could be multiple
190 /// Crate is implicitly loaded by a path resolving through extern prelude.
194 /// The backend's way to give the crate store access to the metadata in a library.
195 /// Note that it returns the raw metadata bytes stored in the library file, whether
196 /// it is compressed, uncompressed, some weird mix, etc.
197 /// rmeta files are backend independent and not handled here.
199 /// At the time of this writing, there is only one backend and one way to store
200 /// metadata in library -- this trait just serves to decouple rustc_metadata from
201 /// the archive reader, which depends on LLVM.
202 pub trait MetadataLoader {
203 fn get_rlib_metadata(&self, target: &Target, filename: &Path) -> Result<MetadataRef, String>;
204 fn get_dylib_metadata(&self, target: &Target, filename: &Path) -> Result<MetadataRef, String>;
207 pub type MetadataLoaderDyn = dyn MetadataLoader + Sync;
209 /// A store of Rust crates, through which their metadata can be accessed.
211 /// Note that this trait should probably not be expanding today. All new
212 /// functionality should be driven through queries instead!
214 /// If you find a method on this trait named `{name}_untracked` it signifies
215 /// that it's *not* tracked for dependency information throughout compilation
216 /// (it'd break incremental compilation) and should only be called pre-HIR (e.g.
218 pub trait CrateStore: std::fmt::Debug {
219 fn as_any(&self) -> &dyn Any;
221 // Foreign definitions.
222 // This information is safe to access, since it's hashed as part of the DefPathHash, which incr.
223 // comp. uses to identify a DefId.
224 fn def_key(&self, def: DefId) -> DefKey;
225 fn def_path(&self, def: DefId) -> DefPath;
226 fn def_path_hash(&self, def: DefId) -> DefPathHash;
228 // This information is safe to access, since it's hashed as part of the StableCrateId, which
229 // incr. comp. uses to identify a CrateNum.
230 fn crate_name(&self, cnum: CrateNum) -> Symbol;
231 fn stable_crate_id(&self, cnum: CrateNum) -> StableCrateId;
232 fn stable_crate_id_to_crate_num(&self, stable_crate_id: StableCrateId) -> CrateNum;
234 /// Fetch a DefId from a DefPathHash for a foreign crate.
235 fn def_path_hash_to_def_id(&self, cnum: CrateNum, hash: DefPathHash) -> DefId;
236 fn expn_hash_to_expn_id(
244 /// Imports all `SourceFile`s from the given crate into the current session.
245 /// This normally happens automatically when we decode a `Span` from
246 /// that crate's metadata - however, the incr comp cache needs
247 /// to trigger this manually when decoding a foreign `Span`
248 fn import_source_files(&self, sess: &Session, cnum: CrateNum);
251 pub type CrateStoreDyn = dyn CrateStore + sync::Sync;