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::hir::def_id::{CrateNum, DefId, LOCAL_CRATE};
6 use crate::hir::map as hir_map;
7 use crate::hir::map::definitions::{DefKey, DefPathTable};
8 use rustc_data_structures::svh::Svh;
9 use crate::ty::{self, TyCtxt};
10 use crate::session::{Session, CrateDisambiguator};
11 use crate::session::search_paths::PathKind;
14 use std::path::{Path, PathBuf};
16 use syntax::symbol::Symbol;
18 use syntax::expand::allocator::AllocatorKind;
19 use rustc_target::spec::Target;
20 use rustc_data_structures::sync::{self, MetadataRef};
21 use rustc_macros::HashStable;
23 pub use self::NativeLibraryKind::*;
25 // lonely orphan structs and enums looking for a better home
27 /// Where a crate came from on the local filesystem. One of these three options
29 #[derive(PartialEq, Clone, Debug, HashStable)]
30 pub struct CrateSource {
31 pub dylib: Option<(PathBuf, PathKind)>,
32 pub rlib: Option<(PathBuf, PathKind)>,
33 pub rmeta: Option<(PathBuf, PathKind)>,
37 pub fn paths(&self) -> impl Iterator<Item = &PathBuf> {
38 self.dylib.iter().chain(self.rlib.iter()).chain(self.rmeta.iter()).map(|p| &p.0)
42 #[derive(RustcEncodable, RustcDecodable, Copy, Clone,
43 Ord, PartialOrd, Eq, PartialEq, Debug, HashStable)]
45 /// A dependency that is only used for its macros, none of which are visible from other crates.
46 /// These are included in the metadata only as placeholders and are ignored when decoding.
48 /// A dependency that is only used for its macros.
50 /// A dependency that is always injected into the dependency list and so
51 /// doesn't need to be linked to an rlib, e.g., the injected allocator.
53 /// A dependency that is required by an rlib version of this crate.
54 /// Ordinary `extern crate`s result in `Explicit` dependencies.
59 pub fn macros_only(self) -> bool {
61 DepKind::UnexportedMacrosOnly | DepKind::MacrosOnly => true,
62 DepKind::Implicit | DepKind::Explicit => false,
67 #[derive(PartialEq, Clone, Debug)]
75 pub fn is_some(&self) -> bool {
76 if let LibSource::Some(_) = *self {
83 pub fn option(&self) -> Option<PathBuf> {
85 LibSource::Some(ref p) => Some(p.clone()),
86 LibSource::MetadataOnly | LibSource::None => None,
91 #[derive(Copy, Debug, PartialEq, Clone, RustcEncodable, RustcDecodable, HashStable)]
92 pub enum LinkagePreference {
97 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash,
98 RustcEncodable, RustcDecodable, HashStable)]
99 pub enum NativeLibraryKind {
100 /// native static library (.a archive)
102 /// native static library, which doesn't get bundled into .rlibs
103 NativeStaticNobundle,
106 /// Windows dynamic library without import library.
108 /// default way to specify a dynamic library
112 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable)]
113 pub struct NativeLibrary {
114 pub kind: NativeLibraryKind,
115 pub name: Option<Symbol>,
116 pub cfg: Option<ast::MetaItem>,
117 pub foreign_module: Option<DefId>,
118 pub wasm_import_module: Option<Symbol>,
121 #[derive(Clone, RustcEncodable, RustcDecodable, HashStable)]
122 pub struct ForeignModule {
123 pub foreign_items: Vec<DefId>,
127 #[derive(Copy, Clone, Debug, HashStable)]
128 pub struct ExternCrate {
129 pub src: ExternCrateSource,
131 /// span of the extern crate that caused this to be loaded
134 /// Number of links to reach the extern;
135 /// used to select the extern with the shortest path
138 /// Crate that depends on this crate
139 pub dependency_of: CrateNum,
143 /// If true, then this crate is the crate named by the extern
144 /// crate referenced above. If false, then this crate is a dep
146 pub fn is_direct(&self) -> bool {
147 self.dependency_of == LOCAL_CRATE
150 pub fn rank(&self) -> impl PartialOrd {
152 // - direct extern crate to indirect
153 // - shorter paths to longer
154 (self.is_direct(), !self.path_len)
158 #[derive(Copy, Clone, Debug, HashStable)]
159 pub enum ExternCrateSource {
160 /// Crate is loaded by `extern crate`.
162 /// def_id of the item in the current crate that caused
163 /// this crate to be loaded; note that there could be multiple
167 /// Crate is implicitly loaded by a path resolving through extern prelude.
171 pub struct EncodedMetadata {
172 pub raw_data: Vec<u8>
175 impl EncodedMetadata {
176 pub fn new() -> EncodedMetadata {
178 raw_data: Vec::new(),
183 /// The backend's way to give the crate store access to the metadata in a library.
184 /// Note that it returns the raw metadata bytes stored in the library file, whether
185 /// it is compressed, uncompressed, some weird mix, etc.
186 /// rmeta files are backend independent and not handled here.
188 /// At the time of this writing, there is only one backend and one way to store
189 /// metadata in library -- this trait just serves to decouple rustc_metadata from
190 /// the archive reader, which depends on LLVM.
191 pub trait MetadataLoader {
192 fn get_rlib_metadata(&self,
195 -> Result<MetadataRef, String>;
196 fn get_dylib_metadata(&self,
199 -> Result<MetadataRef, String>;
202 pub type MetadataLoaderDyn = dyn MetadataLoader + Sync;
204 /// A store of Rust crates, through which their metadata can be accessed.
206 /// Note that this trait should probably not be expanding today. All new
207 /// functionality should be driven through queries instead!
209 /// If you find a method on this trait named `{name}_untracked` it signifies
210 /// that it's *not* tracked for dependency information throughout compilation
211 /// (it'd break incremental compilation) and should only be called pre-HIR (e.g.
213 pub trait CrateStore {
214 fn as_any(&self) -> &dyn Any;
217 fn def_key(&self, def: DefId) -> DefKey;
218 fn def_path(&self, def: DefId) -> hir_map::DefPath;
219 fn def_path_hash(&self, def: DefId) -> hir_map::DefPathHash;
220 fn def_path_table(&self, cnum: CrateNum) -> &DefPathTable;
222 // "queries" used in resolve that aren't tracked for incremental compilation
223 fn crate_name_untracked(&self, cnum: CrateNum) -> Symbol;
224 fn crate_is_private_dep_untracked(&self, cnum: CrateNum) -> bool;
225 fn crate_disambiguator_untracked(&self, cnum: CrateNum) -> CrateDisambiguator;
226 fn crate_hash_untracked(&self, cnum: CrateNum) -> Svh;
227 fn item_generics_cloned_untracked(&self, def: DefId, sess: &Session) -> ty::Generics;
229 // This is basically a 1-based range of ints, which is a little
230 // silly - I may fix that.
231 fn crates_untracked(&self) -> Vec<CrateNum>;
234 fn encode_metadata(&self, tcx: TyCtxt<'_>) -> EncodedMetadata;
235 fn metadata_encoding_version(&self) -> &[u8];
236 fn allocator_kind(&self) -> Option<AllocatorKind>;
239 pub type CrateStoreDyn = dyn CrateStore + sync::Sync;
241 // This method is used when generating the command line to pass through to
242 // system linker. The linker expects undefined symbols on the left of the
243 // command line to be defined in libraries on the right, not the other way
244 // around. For more info, see some comments in the add_used_library function
247 // In order to get this left-to-right dependency ordering, we perform a
248 // topological sort of all crates putting the leaves at the right-most
250 pub fn used_crates(tcx: TyCtxt<'_>, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)> {
251 let mut libs = tcx.crates()
255 if tcx.dep_kind(cnum).macros_only() {
258 let source = tcx.used_crate_source(cnum);
259 let path = match prefer {
260 LinkagePreference::RequireDynamic => source.dylib.clone().map(|p| p.0),
261 LinkagePreference::RequireStatic => source.rlib.clone().map(|p| p.0),
263 let path = match path {
264 Some(p) => LibSource::Some(p),
266 if source.rmeta.is_some() {
267 LibSource::MetadataOnly
275 .collect::<Vec<_>>();
276 let mut ordering = tcx.postorder_cnums(LOCAL_CRATE).to_owned();
278 libs.sort_by_cached_key(|&(a, _)| {
279 ordering.iter().position(|x| *x == a)