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, DisambiguatedDefPathData};
  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::PathBuf;
  39 use std::rc::Rc;
  40 use syntax::ast;
  41 use syntax::ext::base::SyntaxExtension;
  42 use syntax::symbol::Symbol;
  43 use syntax_pos::Span;
  44 use rustc_back::target::Target;
  45 use hir;
  46 use rustc_back::PanicStrategy;
  47
  48 pub use self::NativeLibraryKind::*;
  49
  50 // lonely orphan structs and enums looking for a better home
  51
  52 #[derive(Clone, Debug)]
  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     NativeStatic,    // native static library (.a archive)
 123     NativeStaticNobundle, // native static library, which doesn't get bundled into .rlibs
 124     NativeFramework, // macOS-specific
 125     NativeUnknown,   // default way to specify a dynamic library
 126 }
 127
 128 #[derive(Clone, Hash, RustcEncodable, RustcDecodable)]
 129 pub struct NativeLibrary {
 130     pub kind: NativeLibraryKind,
 131     pub name: Symbol,
 132     pub cfg: Option<ast::MetaItem>,
 133     pub foreign_items: Vec<DefIndex>,
 134 }
 135
 136 pub enum LoadedMacro {
 137     MacroDef(ast::Item),
 138     ProcMacro(Rc<SyntaxExtension>),
 139 }
 140
 141 #[derive(Copy, Clone, Debug)]
 142 pub struct ExternCrate {
 143     /// def_id of an `extern crate` in the current crate that caused
 144     /// this crate to be loaded; note that there could be multiple
 145     /// such ids
 146     pub def_id: DefId,
 147
 148     /// span of the extern crate that caused this to be loaded
 149     pub span: Span,
 150
 151     /// If true, then this crate is the crate named by the extern
 152     /// crate referenced above. If false, then this crate is a dep
 153     /// of the crate.
 154     pub direct: bool,
 155
 156     /// Number of links to reach the extern crate `def_id`
 157     /// declaration; used to select the extern crate with the shortest
 158     /// path
 159     pub path_len: usize,
 160 }
 161
 162 pub struct EncodedMetadata {
 163     pub raw_data: Vec<u8>,
 164     pub hashes: Vec<EncodedMetadataHash>,
 165 }
 166
 167 /// The hash for some metadata that (when saving) will be exported
 168 /// from this crate, or which (when importing) was exported by an
 169 /// upstream crate.
 170 #[derive(Debug, RustcEncodable, RustcDecodable, Copy, Clone)]
 171 pub struct EncodedMetadataHash {
 172     pub def_index: DefIndex,
 173     pub hash: ich::Fingerprint,
 174 }
 175
 176 /// A store of Rust crates, through with their metadata
 177 /// can be accessed.
 178 pub trait CrateStore {
 179     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any>;
 180
 181     // item info
 182     fn visibility(&self, def: DefId) -> ty::Visibility;
 183     fn visible_parent_map<'a>(&'a self) -> ::std::cell::Ref<'a, DefIdMap<DefId>>;
 184     fn item_generics_cloned(&self, def: DefId) -> ty::Generics;
 185
 186     // trait info
 187     fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>;
 188
 189     // impl info
 190     fn impl_defaultness(&self, def: DefId) -> hir::Defaultness;
 191     fn impl_parent(&self, impl_def_id: DefId) -> Option<DefId>;
 192
 193     // trait/impl-item info
 194     fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem;
 195
 196     // flags
 197     fn is_const_fn(&self, did: DefId) -> bool;
 198     fn is_default_impl(&self, impl_did: DefId) -> bool;
 199     fn is_foreign_item(&self, did: DefId) -> bool;
 200     fn is_dllimport_foreign_item(&self, def: DefId) -> bool;
 201     fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool;
 202     fn is_exported_symbol(&self, def_id: DefId) -> bool;
 203
 204     // crate metadata
 205     fn dylib_dependency_formats(&self, cnum: CrateNum)
 206                                     -> Vec<(CrateNum, LinkagePreference)>;
 207     fn dep_kind(&self, cnum: CrateNum) -> DepKind;
 208     fn export_macros(&self, cnum: CrateNum);
 209     fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>;
 210     fn missing_lang_items(&self, cnum: CrateNum) -> Vec<lang_items::LangItem>;
 211     fn is_staged_api(&self, cnum: CrateNum) -> bool;
 212     fn is_allocator(&self, cnum: CrateNum) -> bool;
 213     fn is_panic_runtime(&self, cnum: CrateNum) -> bool;
 214     fn is_compiler_builtins(&self, cnum: CrateNum) -> bool;
 215     fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool;
 216     fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy;
 217     fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate>;
 218     /// The name of the crate as it is referred to in source code of the current
 219     /// crate.
 220     fn crate_name(&self, cnum: CrateNum) -> Symbol;
 221     /// The name of the crate as it is stored in the crate's metadata.
 222     fn original_crate_name(&self, cnum: CrateNum) -> Symbol;
 223     fn crate_hash(&self, cnum: CrateNum) -> Svh;
 224     fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol;
 225     fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>;
 226     fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>;
 227     fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>;
 228     fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>;
 229     fn is_no_builtins(&self, cnum: CrateNum) -> bool;
 230
 231     // resolve
 232     fn retrace_path(&self,
 233                     cnum: CrateNum,
 234                     path_data: &[DisambiguatedDefPathData])
 235                     -> Option<DefId>;
 236     fn def_key(&self, def: DefId) -> DefKey;
 237     fn def_path(&self, def: DefId) -> hir_map::DefPath;
 238     fn def_path_hash(&self, def: DefId) -> u64;
 239     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>;
 240     fn item_children(&self, did: DefId) -> Vec<def::Export>;
 241     fn load_macro(&self, did: DefId, sess: &Session) -> LoadedMacro;
 242
 243     // misc. metadata
 244     fn item_body<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
 245                            -> &'tcx hir::Body;
 246
 247     // This is basically a 1-based range of ints, which is a little
 248     // silly - I may fix that.
 249     fn crates(&self) -> Vec<CrateNum>;
 250     fn used_libraries(&self) -> Vec<NativeLibrary>;
 251     fn used_link_args(&self) -> Vec<String>;
 252
 253     // utility functions
 254     fn metadata_filename(&self) -> &str;
 255     fn metadata_section_name(&self, target: &Target) -> &str;
 256     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>;
 257     fn used_crate_source(&self, cnum: CrateNum) -> CrateSource;
 258     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>;
 259     fn encode_metadata<'a, 'tcx>(&self,
 260                                  tcx: TyCtxt<'a, 'tcx, 'tcx>,
 261                                  link_meta: &LinkMeta,
 262                                  reachable: &NodeSet)
 263                                  -> EncodedMetadata;
 264     fn metadata_encoding_version(&self) -> &[u8];
 265 }
 266
 267 // FIXME: find a better place for this?
 268 pub fn validate_crate_name(sess: Option<&Session>, s: &str, sp: Option<Span>) {
 269     let mut err_count = 0;
 270     {
 271         let mut say = |s: &str| {
 272             match (sp, sess) {
 273                 (_, None) => bug!("{}", s),
 274                 (Some(sp), Some(sess)) => sess.span_err(sp, s),
 275                 (None, Some(sess)) => sess.err(s),
 276             }
 277             err_count += 1;
 278         };
 279         if s.is_empty() {
 280             say("crate name must not be empty");
 281         }
 282         for c in s.chars() {
 283             if c.is_alphanumeric() { continue }
 284             if c == '_'  { continue }
 285             say(&format!("invalid character `{}` in crate name: `{}`", c, s));
 286         }
 287     }
 288
 289     if err_count > 0 {
 290         sess.unwrap().abort_if_errors();
 291     }
 292 }
 293
 294 /// A dummy crate store that does not support any non-local crates,
 295 /// for test purposes.
 296 pub struct DummyCrateStore;
 297
 298 #[allow(unused_variables)]
 299 impl CrateStore for DummyCrateStore {
 300     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any>
 301         { bug!("crate_data_as_rc_any") }
 302     // item info
 303     fn visibility(&self, def: DefId) -> ty::Visibility { bug!("visibility") }
 304     fn visible_parent_map<'a>(&'a self) -> ::std::cell::Ref<'a, DefIdMap<DefId>> {
 305         bug!("visible_parent_map")
 306     }
 307     fn item_generics_cloned(&self, def: DefId) -> ty::Generics
 308         { bug!("item_generics_cloned") }
 309
 310     // trait info
 311     fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId> { vec![] }
 312
 313     // impl info
 314     fn impl_defaultness(&self, def: DefId) -> hir::Defaultness { bug!("impl_defaultness") }
 315     fn impl_parent(&self, def: DefId) -> Option<DefId> { bug!("impl_parent") }
 316
 317     // trait/impl-item info
 318     fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem
 319         { bug!("associated_item_cloned") }
 320
 321     // flags
 322     fn is_const_fn(&self, did: DefId) -> bool { bug!("is_const_fn") }
 323     fn is_default_impl(&self, impl_did: DefId) -> bool { bug!("is_default_impl") }
 324     fn is_foreign_item(&self, did: DefId) -> bool { bug!("is_foreign_item") }
 325     fn is_dllimport_foreign_item(&self, id: DefId) -> bool { false }
 326     fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool { false }
 327     fn is_exported_symbol(&self, def_id: DefId) -> bool { false }
 328
 329     // crate metadata
 330     fn dylib_dependency_formats(&self, cnum: CrateNum)
 331                                     -> Vec<(CrateNum, LinkagePreference)>
 332         { bug!("dylib_dependency_formats") }
 333     fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
 334         { bug!("lang_items") }
 335     fn missing_lang_items(&self, cnum: CrateNum) -> Vec<lang_items::LangItem>
 336         { bug!("missing_lang_items") }
 337     fn is_staged_api(&self, cnum: CrateNum) -> bool { bug!("is_staged_api") }
 338     fn dep_kind(&self, cnum: CrateNum) -> DepKind { bug!("is_explicitly_linked") }
 339     fn export_macros(&self, cnum: CrateNum) { bug!("export_macros") }
 340     fn is_allocator(&self, cnum: CrateNum) -> bool { bug!("is_allocator") }
 341     fn is_panic_runtime(&self, cnum: CrateNum) -> bool { bug!("is_panic_runtime") }
 342     fn is_compiler_builtins(&self, cnum: CrateNum) -> bool { bug!("is_compiler_builtins") }
 343     fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool { bug!("is_sanitizer_runtime") }
 344     fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
 345         bug!("panic_strategy")
 346     }
 347     fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate> { bug!("extern_crate") }
 348     fn crate_name(&self, cnum: CrateNum) -> Symbol { bug!("crate_name") }
 349     fn original_crate_name(&self, cnum: CrateNum) -> Symbol {
 350         bug!("original_crate_name")
 351     }
 352     fn crate_hash(&self, cnum: CrateNum) -> Svh { bug!("crate_hash") }
 353     fn crate_disambiguator(&self, cnum: CrateNum)
 354                            -> Symbol { bug!("crate_disambiguator") }
 355     fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 356         { bug!("plugin_registrar_fn") }
 357     fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 358         { bug!("derive_registrar_fn") }
 359     fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
 360         { bug!("native_libraries") }
 361     fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId> { bug!("exported_symbols") }
 362     fn is_no_builtins(&self, cnum: CrateNum) -> bool { bug!("is_no_builtins") }
 363
 364     // resolve
 365     fn retrace_path(&self,
 366                     cnum: CrateNum,
 367                     path_data: &[DisambiguatedDefPathData])
 368                     -> Option<DefId> {
 369         None
 370     }
 371
 372     fn def_key(&self, def: DefId) -> DefKey { bug!("def_key") }
 373     fn def_path(&self, def: DefId) -> hir_map::DefPath {
 374         bug!("relative_def_path")
 375     }
 376     fn def_path_hash(&self, def: DefId) -> u64 {
 377         bug!("wa")
 378     }
 379     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name> { bug!("struct_field_names") }
 380     fn item_children(&self, did: DefId) -> Vec<def::Export> { bug!("item_children") }
 381     fn load_macro(&self, did: DefId, sess: &Session) -> LoadedMacro { bug!("load_macro") }
 382
 383     // misc. metadata
 384     fn item_body<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
 385                            -> &'tcx hir::Body {
 386         bug!("item_body")
 387     }
 388
 389     // This is basically a 1-based range of ints, which is a little
 390     // silly - I may fix that.
 391     fn crates(&self) -> Vec<CrateNum> { vec![] }
 392     fn used_libraries(&self) -> Vec<NativeLibrary> { vec![] }
 393     fn used_link_args(&self) -> Vec<String> { vec![] }
 394
 395     // utility functions
 396     fn metadata_filename(&self) -> &str { bug!("metadata_filename") }
 397     fn metadata_section_name(&self, target: &Target) -> &str { bug!("metadata_section_name") }
 398     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
 399         { vec![] }
 400     fn used_crate_source(&self, cnum: CrateNum) -> CrateSource { bug!("used_crate_source") }
 401     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum> { None }
 402     fn encode_metadata<'a, 'tcx>(&self,
 403                                  tcx: TyCtxt<'a, 'tcx, 'tcx>,
 404                                  link_meta: &LinkMeta,
 405                                  reachable: &NodeSet)
 406                                  -> EncodedMetadata {
 407         bug!("encode_metadata")
 408     }
 409     fn metadata_encoding_version(&self) -> &[u8] { bug!("metadata_encoding_version") }
 410 }
 411
 412 pub trait CrateLoader {
 413     fn process_item(&mut self, item: &ast::Item, defs: &Definitions);
 414     fn postprocess(&mut self, krate: &ast::Crate);
 415 }