src/librustc/middle/cstore.rs

   1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
  12 // file at the top-level directory of this distribution and at
  13 // http://rust-lang.org/COPYRIGHT.
  14 //
  15 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
  16 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
  17 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
  18 // option. This file may not be copied, modified, or distributed
  19 // except according to those terms.
  20
  21 //! the rustc crate store interface. This also includes types that
  22 //! are *mostly* used as a part of that interface, but these should
  23 //! probably get a better home if someone can find one.
  24
  25 use hir::def;
  26 use hir::def_id::{CrateNum, DefId, DefIndex};
  27 use hir::map as hir_map;
  28 use hir::map::definitions::{Definitions, DefKey, DefPathTable};
  29 use hir::svh::Svh;
  30 use ich;
  31 use middle::lang_items;
  32 use ty::{self, TyCtxt};
  33 use session::Session;
  34 use session::search_paths::PathKind;
  35 use util::nodemap::{NodeSet, DefIdMap};
  36
  37 use std::any::Any;
  38 use std::path::{Path, PathBuf};
  39 use std::rc::Rc;
  40 use owning_ref::ErasedBoxRef;
  41 use syntax::ast;
  42 use syntax::ext::base::SyntaxExtension;
  43 use syntax::symbol::Symbol;
  44 use syntax_pos::Span;
  45 use rustc_back::target::Target;
  46 use hir;
  47
  48 pub use self::NativeLibraryKind::*;
  49
  50 // lonely orphan structs and enums looking for a better home
  51
  52 #[derive(Clone, Debug, Copy)]
  53 pub struct LinkMeta {
  54     pub crate_hash: Svh,
  55 }
  56
  57 /// Where a crate came from on the local filesystem. One of these three options
  58 /// must be non-None.
  59 #[derive(PartialEq, Clone, Debug)]
  60 pub struct CrateSource {
  61     pub dylib: Option<(PathBuf, PathKind)>,
  62     pub rlib: Option<(PathBuf, PathKind)>,
  63     pub rmeta: Option<(PathBuf, PathKind)>,
  64 }
  65
  66 #[derive(RustcEncodable, RustcDecodable, Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Debug)]
  67 pub enum DepKind {
  68     /// A dependency that is only used for its macros, none of which are visible from other crates.
  69     /// These are included in the metadata only as placeholders and are ignored when decoding.
  70     UnexportedMacrosOnly,
  71     /// A dependency that is only used for its macros.
  72     MacrosOnly,
  73     /// A dependency that is always injected into the dependency list and so
  74     /// doesn't need to be linked to an rlib, e.g. the injected allocator.
  75     Implicit,
  76     /// A dependency that is required by an rlib version of this crate.
  77     /// Ordinary `extern crate`s result in `Explicit` dependencies.
  78     Explicit,
  79 }
  80
  81 impl DepKind {
  82     pub fn macros_only(self) -> bool {
  83         match self {
  84             DepKind::UnexportedMacrosOnly | DepKind::MacrosOnly => true,
  85             DepKind::Implicit | DepKind::Explicit => false,
  86         }
  87     }
  88 }
  89
  90 #[derive(PartialEq, Clone, Debug)]
  91 pub enum LibSource {
  92     Some(PathBuf),
  93     MetadataOnly,
  94     None,
  95 }
  96
  97 impl LibSource {
  98     pub fn is_some(&self) -> bool {
  99         if let LibSource::Some(_) = *self {
 100             true
 101         } else {
 102             false
 103         }
 104     }
 105
 106     pub fn option(&self) -> Option<PathBuf> {
 107         match *self {
 108             LibSource::Some(ref p) => Some(p.clone()),
 109             LibSource::MetadataOnly | LibSource::None => None,
 110         }
 111     }
 112 }
 113
 114 #[derive(Copy, Debug, PartialEq, Clone, RustcEncodable, RustcDecodable)]
 115 pub enum LinkagePreference {
 116     RequireDynamic,
 117     RequireStatic,
 118 }
 119
 120 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable)]
 121 pub enum NativeLibraryKind {
 122     /// native static library (.a archive)
 123     NativeStatic,
 124     /// native static library, which doesn't get bundled into .rlibs
 125     NativeStaticNobundle,
 126     /// macOS-specific
 127     NativeFramework,
 128     /// default way to specify a dynamic library
 129     NativeUnknown,
 130 }
 131
 132 #[derive(Clone, Hash, RustcEncodable, RustcDecodable)]
 133 pub struct NativeLibrary {
 134     pub kind: NativeLibraryKind,
 135     pub name: Symbol,
 136     pub cfg: Option<ast::MetaItem>,
 137     pub foreign_items: Vec<DefIndex>,
 138 }
 139
 140 pub enum LoadedMacro {
 141     MacroDef(ast::Item),
 142     ProcMacro(Rc<SyntaxExtension>),
 143 }
 144
 145 #[derive(Copy, Clone, Debug)]
 146 pub struct ExternCrate {
 147     /// def_id of an `extern crate` in the current crate that caused
 148     /// this crate to be loaded; note that there could be multiple
 149     /// such ids
 150     pub def_id: DefId,
 151
 152     /// span of the extern crate that caused this to be loaded
 153     pub span: Span,
 154
 155     /// If true, then this crate is the crate named by the extern
 156     /// crate referenced above. If false, then this crate is a dep
 157     /// of the crate.
 158     pub direct: bool,
 159
 160     /// Number of links to reach the extern crate `def_id`
 161     /// declaration; used to select the extern crate with the shortest
 162     /// path
 163     pub path_len: usize,
 164 }
 165
 166 pub struct EncodedMetadata {
 167     pub raw_data: Vec<u8>
 168 }
 169
 170 impl EncodedMetadata {
 171     pub fn new() -> EncodedMetadata {
 172         EncodedMetadata {
 173             raw_data: Vec::new(),
 174         }
 175     }
 176 }
 177
 178 /// The hash for some metadata that (when saving) will be exported
 179 /// from this crate, or which (when importing) was exported by an
 180 /// upstream crate.
 181 #[derive(Debug, RustcEncodable, RustcDecodable, Copy, Clone)]
 182 pub struct EncodedMetadataHash {
 183     pub def_index: DefIndex,
 184     pub hash: ich::Fingerprint,
 185 }
 186
 187 /// The hash for some metadata that (when saving) will be exported
 188 /// from this crate, or which (when importing) was exported by an
 189 /// upstream crate.
 190 #[derive(Debug, RustcEncodable, RustcDecodable, Clone)]
 191 pub struct EncodedMetadataHashes {
 192     // Stable content hashes for things in crate metadata, indexed by DefIndex.
 193     pub hashes: Vec<EncodedMetadataHash>,
 194 }
 195
 196 impl EncodedMetadataHashes {
 197     pub fn new() -> EncodedMetadataHashes {
 198         EncodedMetadataHashes {
 199             hashes: Vec::new(),
 200         }
 201     }
 202 }
 203
 204 /// The backend's way to give the crate store access to the metadata in a library.
 205 /// Note that it returns the raw metadata bytes stored in the library file, whether
 206 /// it is compressed, uncompressed, some weird mix, etc.
 207 /// rmeta files are backend independent and not handled here.
 208 ///
 209 /// At the time of this writing, there is only one backend and one way to store
 210 /// metadata in library -- this trait just serves to decouple rustc_metadata from
 211 /// the archive reader, which depends on LLVM.
 212 pub trait MetadataLoader {
 213     fn get_rlib_metadata(&self,
 214                          target: &Target,
 215                          filename: &Path)
 216                          -> Result<ErasedBoxRef<[u8]>, String>;
 217     fn get_dylib_metadata(&self,
 218                           target: &Target,
 219                           filename: &Path)
 220                           -> Result<ErasedBoxRef<[u8]>, String>;
 221 }
 222
 223 /// A store of Rust crates, through with their metadata
 224 /// can be accessed.
 225 pub trait CrateStore {
 226     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any>;
 227
 228     // access to the metadata loader
 229     fn metadata_loader(&self) -> &MetadataLoader;
 230
 231     // item info
 232     fn visibility(&self, def: DefId) -> ty::Visibility;
 233     fn visible_parent_map<'a>(&'a self, sess: &Session) -> ::std::cell::Ref<'a, DefIdMap<DefId>>;
 234     fn item_generics_cloned(&self, def: DefId) -> ty::Generics;
 235
 236     // trait info
 237     fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>;
 238
 239     // trait/impl-item info
 240     fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem;
 241
 242     // flags
 243     fn is_dllimport_foreign_item(&self, def: DefId) -> bool;
 244     fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool;
 245
 246     // crate metadata
 247     fn dep_kind(&self, cnum: CrateNum) -> DepKind;
 248     fn export_macros(&self, cnum: CrateNum);
 249     fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>;
 250     fn missing_lang_items(&self, cnum: CrateNum) -> Vec<lang_items::LangItem>;
 251     /// The name of the crate as it is referred to in source code of the current
 252     /// crate.
 253     fn crate_name(&self, cnum: CrateNum) -> Symbol;
 254     /// The name of the crate as it is stored in the crate's metadata.
 255     fn original_crate_name(&self, cnum: CrateNum) -> Symbol;
 256     fn crate_hash(&self, cnum: CrateNum) -> Svh;
 257     fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol;
 258     fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>;
 259     fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>;
 260     fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>;
 261     fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>;
 262
 263     // resolve
 264     fn def_key(&self, def: DefId) -> DefKey;
 265     fn def_path(&self, def: DefId) -> hir_map::DefPath;
 266     fn def_path_hash(&self, def: DefId) -> hir_map::DefPathHash;
 267     fn def_path_table(&self, cnum: CrateNum) -> Rc<DefPathTable>;
 268     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>;
 269     fn item_children(&self, did: DefId, sess: &Session) -> Vec<def::Export>;
 270     fn load_macro(&self, did: DefId, sess: &Session) -> LoadedMacro;
 271
 272     // misc. metadata
 273     fn item_body<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
 274                            -> &'tcx hir::Body;
 275
 276     // This is basically a 1-based range of ints, which is a little
 277     // silly - I may fix that.
 278     fn crates(&self) -> Vec<CrateNum>;
 279     fn used_libraries(&self) -> Vec<NativeLibrary>;
 280     fn used_link_args(&self) -> Vec<String>;
 281
 282     // utility functions
 283     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>;
 284     fn used_crate_source(&self, cnum: CrateNum) -> CrateSource;
 285     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>;
 286     fn encode_metadata<'a, 'tcx>(&self,
 287                                  tcx: TyCtxt<'a, 'tcx, 'tcx>,
 288                                  link_meta: &LinkMeta,
 289                                  reachable: &NodeSet)
 290                                  -> (EncodedMetadata, EncodedMetadataHashes);
 291     fn metadata_encoding_version(&self) -> &[u8];
 292 }
 293
 294 // FIXME: find a better place for this?
 295 pub fn validate_crate_name(sess: Option<&Session>, s: &str, sp: Option<Span>) {
 296     let mut err_count = 0;
 297     {
 298         let mut say = |s: &str| {
 299             match (sp, sess) {
 300                 (_, None) => bug!("{}", s),
 301                 (Some(sp), Some(sess)) => sess.span_err(sp, s),
 302                 (None, Some(sess)) => sess.err(s),
 303             }
 304             err_count += 1;
 305         };
 306         if s.is_empty() {
 307             say("crate name must not be empty");
 308         }
 309         for c in s.chars() {
 310             if c.is_alphanumeric() { continue }
 311             if c == '_'  { continue }
 312             say(&format!("invalid character `{}` in crate name: `{}`", c, s));
 313         }
 314     }
 315
 316     if err_count > 0 {
 317         sess.unwrap().abort_if_errors();
 318     }
 319 }
 320
 321 /// A dummy crate store that does not support any non-local crates,
 322 /// for test purposes.
 323 pub struct DummyCrateStore;
 324
 325 #[allow(unused_variables)]
 326 impl CrateStore for DummyCrateStore {
 327     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any>
 328         { bug!("crate_data_as_rc_any") }
 329     // item info
 330     fn visibility(&self, def: DefId) -> ty::Visibility { bug!("visibility") }
 331     fn visible_parent_map<'a>(&'a self, session: &Session)
 332         -> ::std::cell::Ref<'a, DefIdMap<DefId>>
 333     {
 334         bug!("visible_parent_map")
 335     }
 336     fn item_generics_cloned(&self, def: DefId) -> ty::Generics
 337         { bug!("item_generics_cloned") }
 338
 339     // trait info
 340     fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId> { vec![] }
 341
 342     // trait/impl-item info
 343     fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem
 344         { bug!("associated_item_cloned") }
 345
 346     // flags
 347     fn is_dllimport_foreign_item(&self, id: DefId) -> bool { false }
 348     fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool { false }
 349
 350     // crate metadata
 351     fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
 352         { bug!("lang_items") }
 353     fn missing_lang_items(&self, cnum: CrateNum) -> Vec<lang_items::LangItem>
 354         { bug!("missing_lang_items") }
 355     fn dep_kind(&self, cnum: CrateNum) -> DepKind { bug!("is_explicitly_linked") }
 356     fn export_macros(&self, cnum: CrateNum) { bug!("export_macros") }
 357     fn crate_name(&self, cnum: CrateNum) -> Symbol { bug!("crate_name") }
 358     fn original_crate_name(&self, cnum: CrateNum) -> Symbol {
 359         bug!("original_crate_name")
 360     }
 361     fn crate_hash(&self, cnum: CrateNum) -> Svh { bug!("crate_hash") }
 362     fn crate_disambiguator(&self, cnum: CrateNum)
 363                            -> Symbol { bug!("crate_disambiguator") }
 364     fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 365         { bug!("plugin_registrar_fn") }
 366     fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 367         { bug!("derive_registrar_fn") }
 368     fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
 369         { bug!("native_libraries") }
 370     fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId> { bug!("exported_symbols") }
 371
 372     // resolve
 373     fn def_key(&self, def: DefId) -> DefKey { bug!("def_key") }
 374     fn def_path(&self, def: DefId) -> hir_map::DefPath {
 375         bug!("relative_def_path")
 376     }
 377     fn def_path_hash(&self, def: DefId) -> hir_map::DefPathHash {
 378         bug!("def_path_hash")
 379     }
 380     fn def_path_table(&self, cnum: CrateNum) -> Rc<DefPathTable> {
 381         bug!("def_path_table")
 382     }
 383     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name> { bug!("struct_field_names") }
 384     fn item_children(&self, did: DefId, sess: &Session) -> Vec<def::Export> {
 385         bug!("item_children")
 386     }
 387     fn load_macro(&self, did: DefId, sess: &Session) -> LoadedMacro { bug!("load_macro") }
 388
 389     // misc. metadata
 390     fn item_body<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
 391                            -> &'tcx hir::Body {
 392         bug!("item_body")
 393     }
 394
 395     // This is basically a 1-based range of ints, which is a little
 396     // silly - I may fix that.
 397     fn crates(&self) -> Vec<CrateNum> { vec![] }
 398     fn used_libraries(&self) -> Vec<NativeLibrary> { vec![] }
 399     fn used_link_args(&self) -> Vec<String> { vec![] }
 400
 401     // utility functions
 402     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
 403         { vec![] }
 404     fn used_crate_source(&self, cnum: CrateNum) -> CrateSource { bug!("used_crate_source") }
 405     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum> { None }
 406     fn encode_metadata<'a, 'tcx>(&self,
 407                                  tcx: TyCtxt<'a, 'tcx, 'tcx>,
 408                                  link_meta: &LinkMeta,
 409                                  reachable: &NodeSet)
 410                                  -> (EncodedMetadata, EncodedMetadataHashes) {
 411         bug!("encode_metadata")
 412     }
 413     fn metadata_encoding_version(&self) -> &[u8] { bug!("metadata_encoding_version") }
 414
 415     // access to the metadata loader
 416     fn metadata_loader(&self) -> &MetadataLoader { bug!("metadata_loader") }
 417 }
 418
 419 pub trait CrateLoader {
 420     fn process_item(&mut self, item: &ast::Item, defs: &Definitions);
 421     fn postprocess(&mut self, krate: &ast::Crate);
 422 }