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::{self, 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 middle::lang_items;
  31 use ty::{self, TyCtxt};
  32 use session::Session;
  33 use session::search_paths::PathKind;
  34 use util::nodemap::{NodeSet, DefIdMap};
  35
  36 use std::any::Any;
  37 use std::collections::BTreeMap;
  38 use std::path::PathBuf;
  39 use std::rc::Rc;
  40 use syntax::ast;
  41 use syntax::attr;
  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 use rustc_back::PanicStrategy;
  48
  49 pub use self::NativeLibraryKind::*;
  50
  51 // lonely orphan structs and enums looking for a better home
  52
  53 #[derive(Clone, Debug)]
  54 pub struct LinkMeta {
  55     pub crate_name: Symbol,
  56     pub crate_hash: Svh,
  57 }
  58
  59 // Where a crate came from on the local filesystem. One of these three options
  60 // must be non-None.
  61 #[derive(PartialEq, Clone, Debug)]
  62 pub struct CrateSource {
  63     pub dylib: Option<(PathBuf, PathKind)>,
  64     pub rlib: Option<(PathBuf, PathKind)>,
  65     pub rmeta: Option<(PathBuf, PathKind)>,
  66 }
  67
  68 #[derive(RustcEncodable, RustcDecodable, Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Debug)]
  69 pub enum DepKind {
  70     /// A dependency that is only used for its macros, none of which are visible from other crates.
  71     /// These are included in the metadata only as placeholders and are ignored when decoding.
  72     UnexportedMacrosOnly,
  73     /// A dependency that is only used for its macros.
  74     MacrosOnly,
  75     /// A dependency that is always injected into the dependency list and so
  76     /// doesn't need to be linked to an rlib, e.g. the injected allocator.
  77     Implicit,
  78     /// A dependency that is required by an rlib version of this crate.
  79     /// Ordinary `extern crate`s result in `Explicit` dependencies.
  80     Explicit,
  81 }
  82
  83 impl DepKind {
  84     pub fn macros_only(self) -> bool {
  85         match self {
  86             DepKind::UnexportedMacrosOnly | DepKind::MacrosOnly => true,
  87             DepKind::Implicit | DepKind::Explicit => false,
  88         }
  89     }
  90 }
  91
  92 #[derive(PartialEq, Clone, Debug)]
  93 pub enum LibSource {
  94     Some(PathBuf),
  95     MetadataOnly,
  96     None,
  97 }
  98
  99 impl LibSource {
 100     pub fn is_some(&self) -> bool {
 101         if let LibSource::Some(_) = *self {
 102             true
 103         } else {
 104             false
 105         }
 106     }
 107
 108     pub fn option(&self) -> Option<PathBuf> {
 109         match *self {
 110             LibSource::Some(ref p) => Some(p.clone()),
 111             LibSource::MetadataOnly | LibSource::None => None,
 112         }
 113     }
 114 }
 115
 116 #[derive(Copy, Debug, PartialEq, Clone, RustcEncodable, RustcDecodable)]
 117 pub enum LinkagePreference {
 118     RequireDynamic,
 119     RequireStatic,
 120 }
 121
 122 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable)]
 123 pub enum NativeLibraryKind {
 124     NativeStatic,    // native static library (.a archive)
 125     NativeStaticNobundle, // native static library, which doesn't get bundled into .rlibs
 126     NativeFramework, // macOS-specific
 127     NativeUnknown,   // default way to specify a dynamic library
 128 }
 129
 130 #[derive(Clone, Hash, RustcEncodable, RustcDecodable)]
 131 pub struct NativeLibrary {
 132     pub kind: NativeLibraryKind,
 133     pub name: Symbol,
 134     pub cfg: Option<ast::MetaItem>,
 135     pub foreign_items: Vec<DefIndex>,
 136 }
 137
 138 pub enum LoadedMacro {
 139     MacroDef(ast::Item),
 140     ProcMacro(Rc<SyntaxExtension>),
 141 }
 142
 143 #[derive(Copy, Clone, Debug)]
 144 pub struct ExternCrate {
 145     /// def_id of an `extern crate` in the current crate that caused
 146     /// this crate to be loaded; note that there could be multiple
 147     /// such ids
 148     pub def_id: DefId,
 149
 150     /// span of the extern crate that caused this to be loaded
 151     pub span: Span,
 152
 153     /// If true, then this crate is the crate named by the extern
 154     /// crate referenced above. If false, then this crate is a dep
 155     /// of the crate.
 156     pub direct: bool,
 157
 158     /// Number of links to reach the extern crate `def_id`
 159     /// declaration; used to select the extern crate with the shortest
 160     /// path
 161     pub path_len: usize,
 162 }
 163
 164 /// A store of Rust crates, through with their metadata
 165 /// can be accessed.
 166 pub trait CrateStore {
 167     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any>;
 168
 169     // item info
 170     fn describe_def(&self, def: DefId) -> Option<Def>;
 171     fn def_span(&self, sess: &Session, def: DefId) -> Span;
 172     fn stability(&self, def: DefId) -> Option<attr::Stability>;
 173     fn deprecation(&self, def: DefId) -> Option<attr::Deprecation>;
 174     fn visibility(&self, def: DefId) -> ty::Visibility;
 175     fn visible_parent_map<'a>(&'a self) -> ::std::cell::RefMut<'a, DefIdMap<DefId>>;
 176     fn item_generics_cloned(&self, def: DefId) -> ty::Generics;
 177     fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute>;
 178     fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name>;
 179
 180     // trait info
 181     fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>;
 182
 183     // impl info
 184     fn impl_polarity(&self, def: DefId) -> hir::ImplPolarity;
 185     fn impl_parent(&self, impl_def_id: DefId) -> Option<DefId>;
 186
 187     // trait/impl-item info
 188     fn trait_of_item(&self, def_id: DefId) -> Option<DefId>;
 189     fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem;
 190
 191     // flags
 192     fn is_const_fn(&self, did: DefId) -> bool;
 193     fn is_default_impl(&self, impl_did: DefId) -> bool;
 194     fn is_foreign_item(&self, did: DefId) -> bool;
 195     fn is_dllimport_foreign_item(&self, def: DefId) -> bool;
 196     fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool;
 197     fn is_exported_symbol(&self, def_id: DefId) -> bool;
 198
 199     // crate metadata
 200     fn dylib_dependency_formats(&self, cnum: CrateNum)
 201                                     -> Vec<(CrateNum, LinkagePreference)>;
 202     fn dep_kind(&self, cnum: CrateNum) -> DepKind;
 203     fn export_macros(&self, cnum: CrateNum);
 204     fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>;
 205     fn missing_lang_items(&self, cnum: CrateNum) -> Vec<lang_items::LangItem>;
 206     fn is_staged_api(&self, cnum: CrateNum) -> bool;
 207     fn is_allocator(&self, cnum: CrateNum) -> bool;
 208     fn is_panic_runtime(&self, cnum: CrateNum) -> bool;
 209     fn is_compiler_builtins(&self, cnum: CrateNum) -> bool;
 210     fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool;
 211     fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy;
 212     fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate>;
 213     /// The name of the crate as it is referred to in source code of the current
 214     /// crate.
 215     fn crate_name(&self, cnum: CrateNum) -> Symbol;
 216     /// The name of the crate as it is stored in the crate's metadata.
 217     fn original_crate_name(&self, cnum: CrateNum) -> Symbol;
 218     fn crate_hash(&self, cnum: CrateNum) -> Svh;
 219     fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol;
 220     fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>;
 221     fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>;
 222     fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>;
 223     fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>;
 224     fn is_no_builtins(&self, cnum: CrateNum) -> bool;
 225
 226     // resolve
 227     fn retrace_path(&self,
 228                     cnum: CrateNum,
 229                     path_data: &[DisambiguatedDefPathData])
 230                     -> Option<DefId>;
 231     fn def_key(&self, def: DefId) -> DefKey;
 232     fn def_path(&self, def: DefId) -> hir_map::DefPath;
 233     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>;
 234     fn item_children(&self, did: DefId) -> Vec<def::Export>;
 235     fn load_macro(&self, did: DefId, sess: &Session) -> LoadedMacro;
 236
 237     // misc. metadata
 238     fn maybe_get_item_body<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
 239                                      -> Option<&'tcx hir::Body>;
 240     fn item_body_nested_bodies(&self, def: DefId) -> BTreeMap<hir::BodyId, hir::Body>;
 241     fn const_is_rvalue_promotable_to_static(&self, def: DefId) -> bool;
 242
 243     fn is_item_mir_available(&self, def: DefId) -> bool;
 244
 245     // This is basically a 1-based range of ints, which is a little
 246     // silly - I may fix that.
 247     fn crates(&self) -> Vec<CrateNum>;
 248     fn used_libraries(&self) -> Vec<NativeLibrary>;
 249     fn used_link_args(&self) -> Vec<String>;
 250
 251     // utility functions
 252     fn metadata_filename(&self) -> &str;
 253     fn metadata_section_name(&self, target: &Target) -> &str;
 254     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>;
 255     fn used_crate_source(&self, cnum: CrateNum) -> CrateSource;
 256     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>;
 257     fn encode_metadata<'a, 'tcx>(&self,
 258                                  tcx: TyCtxt<'a, 'tcx, 'tcx>,
 259                                  link_meta: &LinkMeta,
 260                                  reachable: &NodeSet) -> Vec<u8>;
 261     fn metadata_encoding_version(&self) -> &[u8];
 262 }
 263
 264 // FIXME: find a better place for this?
 265 pub fn validate_crate_name(sess: Option<&Session>, s: &str, sp: Option<Span>) {
 266     let mut err_count = 0;
 267     {
 268         let mut say = |s: &str| {
 269             match (sp, sess) {
 270                 (_, None) => bug!("{}", s),
 271                 (Some(sp), Some(sess)) => sess.span_err(sp, s),
 272                 (None, Some(sess)) => sess.err(s),
 273             }
 274             err_count += 1;
 275         };
 276         if s.is_empty() {
 277             say("crate name must not be empty");
 278         }
 279         for c in s.chars() {
 280             if c.is_alphanumeric() { continue }
 281             if c == '_'  { continue }
 282             say(&format!("invalid character `{}` in crate name: `{}`", c, s));
 283         }
 284     }
 285
 286     if err_count > 0 {
 287         sess.unwrap().abort_if_errors();
 288     }
 289 }
 290
 291 /// A dummy crate store that does not support any non-local crates,
 292 /// for test purposes.
 293 pub struct DummyCrateStore;
 294
 295 #[allow(unused_variables)]
 296 impl CrateStore for DummyCrateStore {
 297     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any>
 298         { bug!("crate_data_as_rc_any") }
 299     // item info
 300     fn describe_def(&self, def: DefId) -> Option<Def> { bug!("describe_def") }
 301     fn def_span(&self, sess: &Session, def: DefId) -> Span { bug!("def_span") }
 302     fn stability(&self, def: DefId) -> Option<attr::Stability> { bug!("stability") }
 303     fn deprecation(&self, def: DefId) -> Option<attr::Deprecation> { bug!("deprecation") }
 304     fn visibility(&self, def: DefId) -> ty::Visibility { bug!("visibility") }
 305     fn visible_parent_map<'a>(&'a self) -> ::std::cell::RefMut<'a, DefIdMap<DefId>> {
 306         bug!("visible_parent_map")
 307     }
 308     fn item_generics_cloned(&self, def: DefId) -> ty::Generics
 309         { bug!("item_generics_cloned") }
 310     fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute> { bug!("item_attrs") }
 311     fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name> { bug!("fn_arg_names") }
 312
 313     // trait info
 314     fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId> { vec![] }
 315
 316     // impl info
 317     fn impl_polarity(&self, def: DefId) -> hir::ImplPolarity { bug!("impl_polarity") }
 318     fn impl_parent(&self, def: DefId) -> Option<DefId> { bug!("impl_parent") }
 319
 320     // trait/impl-item info
 321     fn trait_of_item(&self, def_id: DefId) -> Option<DefId> { bug!("trait_of_item") }
 322     fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem
 323         { bug!("associated_item_cloned") }
 324
 325     // flags
 326     fn is_const_fn(&self, did: DefId) -> bool { bug!("is_const_fn") }
 327     fn is_default_impl(&self, impl_did: DefId) -> bool { bug!("is_default_impl") }
 328     fn is_foreign_item(&self, did: DefId) -> bool { bug!("is_foreign_item") }
 329     fn is_dllimport_foreign_item(&self, id: DefId) -> bool { false }
 330     fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool { false }
 331     fn is_exported_symbol(&self, def_id: DefId) -> bool { false }
 332
 333     // crate metadata
 334     fn dylib_dependency_formats(&self, cnum: CrateNum)
 335                                     -> Vec<(CrateNum, LinkagePreference)>
 336         { bug!("dylib_dependency_formats") }
 337     fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
 338         { bug!("lang_items") }
 339     fn missing_lang_items(&self, cnum: CrateNum) -> Vec<lang_items::LangItem>
 340         { bug!("missing_lang_items") }
 341     fn is_staged_api(&self, cnum: CrateNum) -> bool { bug!("is_staged_api") }
 342     fn dep_kind(&self, cnum: CrateNum) -> DepKind { bug!("is_explicitly_linked") }
 343     fn export_macros(&self, cnum: CrateNum) { bug!("export_macros") }
 344     fn is_allocator(&self, cnum: CrateNum) -> bool { bug!("is_allocator") }
 345     fn is_panic_runtime(&self, cnum: CrateNum) -> bool { bug!("is_panic_runtime") }
 346     fn is_compiler_builtins(&self, cnum: CrateNum) -> bool { bug!("is_compiler_builtins") }
 347     fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool { bug!("is_sanitizer_runtime") }
 348     fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
 349         bug!("panic_strategy")
 350     }
 351     fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate> { bug!("extern_crate") }
 352     fn crate_name(&self, cnum: CrateNum) -> Symbol { bug!("crate_name") }
 353     fn original_crate_name(&self, cnum: CrateNum) -> Symbol {
 354         bug!("original_crate_name")
 355     }
 356     fn crate_hash(&self, cnum: CrateNum) -> Svh { bug!("crate_hash") }
 357     fn crate_disambiguator(&self, cnum: CrateNum)
 358                            -> Symbol { bug!("crate_disambiguator") }
 359     fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 360         { bug!("plugin_registrar_fn") }
 361     fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 362         { bug!("derive_registrar_fn") }
 363     fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
 364         { bug!("native_libraries") }
 365     fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId> { bug!("exported_symbols") }
 366     fn is_no_builtins(&self, cnum: CrateNum) -> bool { bug!("is_no_builtins") }
 367
 368     // resolve
 369     fn retrace_path(&self,
 370                     cnum: CrateNum,
 371                     path_data: &[DisambiguatedDefPathData])
 372                     -> Option<DefId> {
 373         None
 374     }
 375
 376     fn def_key(&self, def: DefId) -> DefKey { bug!("def_key") }
 377     fn def_path(&self, def: DefId) -> hir_map::DefPath {
 378         bug!("relative_def_path")
 379     }
 380     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name> { bug!("struct_field_names") }
 381     fn item_children(&self, did: DefId) -> Vec<def::Export> { bug!("item_children") }
 382     fn load_macro(&self, did: DefId, sess: &Session) -> LoadedMacro { bug!("load_macro") }
 383
 384     // misc. metadata
 385     fn maybe_get_item_body<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
 386                                      -> Option<&'tcx hir::Body> {
 387         bug!("maybe_get_item_body")
 388     }
 389     fn item_body_nested_bodies(&self, def: DefId) -> BTreeMap<hir::BodyId, hir::Body> {
 390         bug!("item_body_nested_bodies")
 391     }
 392     fn const_is_rvalue_promotable_to_static(&self, def: DefId) -> bool {
 393         bug!("const_is_rvalue_promotable_to_static")
 394     }
 395
 396     fn is_item_mir_available(&self, def: DefId) -> bool {
 397         bug!("is_item_mir_available")
 398     }
 399
 400     // This is basically a 1-based range of ints, which is a little
 401     // silly - I may fix that.
 402     fn crates(&self) -> Vec<CrateNum> { vec![] }
 403     fn used_libraries(&self) -> Vec<NativeLibrary> { vec![] }
 404     fn used_link_args(&self) -> Vec<String> { vec![] }
 405
 406     // utility functions
 407     fn metadata_filename(&self) -> &str { bug!("metadata_filename") }
 408     fn metadata_section_name(&self, target: &Target) -> &str { bug!("metadata_section_name") }
 409     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
 410         { vec![] }
 411     fn used_crate_source(&self, cnum: CrateNum) -> CrateSource { bug!("used_crate_source") }
 412     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum> { None }
 413     fn encode_metadata<'a, 'tcx>(&self,
 414                                  tcx: TyCtxt<'a, 'tcx, 'tcx>,
 415                                  link_meta: &LinkMeta,
 416                                  reachable: &NodeSet) -> Vec<u8> { vec![] }
 417     fn metadata_encoding_version(&self) -> &[u8] { bug!("metadata_encoding_version") }
 418 }
 419
 420 pub trait CrateLoader {
 421     fn process_item(&mut self, item: &ast::Item, defs: &Definitions);
 422     fn postprocess(&mut self, krate: &ast::Crate);
 423 }