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 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::collections::BTreeMap;
  39 use std::path::PathBuf;
  40 use std::rc::Rc;
  41 use syntax::ast;
  42 use syntax::attr;
  43 use syntax::ext::base::SyntaxExtension;
  44 use syntax::symbol::Symbol;
  45 use syntax_pos::Span;
  46 use rustc_back::target::Target;
  47 use hir;
  48 use rustc_back::PanicStrategy;
  49
  50 pub use self::NativeLibraryKind::*;
  51
  52 // lonely orphan structs and enums looking for a better home
  53
  54 #[derive(Clone, Debug)]
  55 pub struct LinkMeta {
  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 pub struct EncodedMetadata {
 165     pub raw_data: Vec<u8>,
 166     pub hashes: Vec<EncodedMetadataHash>,
 167 }
 168
 169 /// The hash for some metadata that (when saving) will be exported
 170 /// from this crate, or which (when importing) was exported by an
 171 /// upstream crate.
 172 #[derive(Debug, RustcEncodable, RustcDecodable, Copy, Clone)]
 173 pub struct EncodedMetadataHash {
 174     pub def_index: DefIndex,
 175     pub hash: ich::Fingerprint,
 176 }
 177
 178 /// A store of Rust crates, through with their metadata
 179 /// can be accessed.
 180 pub trait CrateStore {
 181     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any>;
 182
 183     // item info
 184     fn describe_def(&self, def: DefId) -> Option<Def>;
 185     fn def_span(&self, sess: &Session, def: DefId) -> Span;
 186     fn stability(&self, def: DefId) -> Option<attr::Stability>;
 187     fn deprecation(&self, def: DefId) -> Option<attr::Deprecation>;
 188     fn visibility(&self, def: DefId) -> ty::Visibility;
 189     fn visible_parent_map<'a>(&'a self) -> ::std::cell::Ref<'a, DefIdMap<DefId>>;
 190     fn item_generics_cloned(&self, def: DefId) -> ty::Generics;
 191     fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute>;
 192     fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name>;
 193
 194     // trait info
 195     fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>;
 196
 197     // impl info
 198     fn impl_polarity(&self, def: DefId) -> hir::ImplPolarity;
 199     fn impl_parent(&self, impl_def_id: DefId) -> Option<DefId>;
 200
 201     // trait/impl-item info
 202     fn trait_of_item(&self, def_id: DefId) -> Option<DefId>;
 203     fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem;
 204
 205     // flags
 206     fn is_const_fn(&self, did: DefId) -> bool;
 207     fn is_default_impl(&self, impl_did: DefId) -> bool;
 208     fn is_foreign_item(&self, did: DefId) -> bool;
 209     fn is_dllimport_foreign_item(&self, def: DefId) -> bool;
 210     fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool;
 211     fn is_exported_symbol(&self, def_id: DefId) -> bool;
 212
 213     // crate metadata
 214     fn dylib_dependency_formats(&self, cnum: CrateNum)
 215                                     -> Vec<(CrateNum, LinkagePreference)>;
 216     fn dep_kind(&self, cnum: CrateNum) -> DepKind;
 217     fn export_macros(&self, cnum: CrateNum);
 218     fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>;
 219     fn missing_lang_items(&self, cnum: CrateNum) -> Vec<lang_items::LangItem>;
 220     fn is_staged_api(&self, cnum: CrateNum) -> bool;
 221     fn is_allocator(&self, cnum: CrateNum) -> bool;
 222     fn is_panic_runtime(&self, cnum: CrateNum) -> bool;
 223     fn is_compiler_builtins(&self, cnum: CrateNum) -> bool;
 224     fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool;
 225     fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy;
 226     fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate>;
 227     /// The name of the crate as it is referred to in source code of the current
 228     /// crate.
 229     fn crate_name(&self, cnum: CrateNum) -> Symbol;
 230     /// The name of the crate as it is stored in the crate's metadata.
 231     fn original_crate_name(&self, cnum: CrateNum) -> Symbol;
 232     fn crate_hash(&self, cnum: CrateNum) -> Svh;
 233     fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol;
 234     fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>;
 235     fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>;
 236     fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>;
 237     fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>;
 238     fn is_no_builtins(&self, cnum: CrateNum) -> bool;
 239
 240     // resolve
 241     fn retrace_path(&self,
 242                     cnum: CrateNum,
 243                     path_data: &[DisambiguatedDefPathData])
 244                     -> Option<DefId>;
 245     fn def_key(&self, def: DefId) -> DefKey;
 246     fn def_path(&self, def: DefId) -> hir_map::DefPath;
 247     fn def_path_hash(&self, def: DefId) -> u64;
 248     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>;
 249     fn item_children(&self, did: DefId) -> Vec<def::Export>;
 250     fn load_macro(&self, did: DefId, sess: &Session) -> LoadedMacro;
 251
 252     // misc. metadata
 253     fn maybe_get_item_body<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
 254                                      -> Option<&'tcx hir::Body>;
 255     fn item_body_nested_bodies(&self, def: DefId) -> BTreeMap<hir::BodyId, hir::Body>;
 256     fn const_is_rvalue_promotable_to_static(&self, def: DefId) -> bool;
 257
 258     fn is_item_mir_available(&self, def: DefId) -> bool;
 259
 260     // This is basically a 1-based range of ints, which is a little
 261     // silly - I may fix that.
 262     fn crates(&self) -> Vec<CrateNum>;
 263     fn used_libraries(&self) -> Vec<NativeLibrary>;
 264     fn used_link_args(&self) -> Vec<String>;
 265
 266     // utility functions
 267     fn metadata_filename(&self) -> &str;
 268     fn metadata_section_name(&self, target: &Target) -> &str;
 269     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>;
 270     fn used_crate_source(&self, cnum: CrateNum) -> CrateSource;
 271     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>;
 272     fn encode_metadata<'a, 'tcx>(&self,
 273                                  tcx: TyCtxt<'a, 'tcx, 'tcx>,
 274                                  link_meta: &LinkMeta,
 275                                  reachable: &NodeSet)
 276                                  -> EncodedMetadata;
 277     fn metadata_encoding_version(&self) -> &[u8];
 278 }
 279
 280 // FIXME: find a better place for this?
 281 pub fn validate_crate_name(sess: Option<&Session>, s: &str, sp: Option<Span>) {
 282     let mut err_count = 0;
 283     {
 284         let mut say = |s: &str| {
 285             match (sp, sess) {
 286                 (_, None) => bug!("{}", s),
 287                 (Some(sp), Some(sess)) => sess.span_err(sp, s),
 288                 (None, Some(sess)) => sess.err(s),
 289             }
 290             err_count += 1;
 291         };
 292         if s.is_empty() {
 293             say("crate name must not be empty");
 294         }
 295         for c in s.chars() {
 296             if c.is_alphanumeric() { continue }
 297             if c == '_'  { continue }
 298             say(&format!("invalid character `{}` in crate name: `{}`", c, s));
 299         }
 300     }
 301
 302     if err_count > 0 {
 303         sess.unwrap().abort_if_errors();
 304     }
 305 }
 306
 307 /// A dummy crate store that does not support any non-local crates,
 308 /// for test purposes.
 309 pub struct DummyCrateStore;
 310
 311 #[allow(unused_variables)]
 312 impl CrateStore for DummyCrateStore {
 313     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any>
 314         { bug!("crate_data_as_rc_any") }
 315     // item info
 316     fn describe_def(&self, def: DefId) -> Option<Def> { bug!("describe_def") }
 317     fn def_span(&self, sess: &Session, def: DefId) -> Span { bug!("def_span") }
 318     fn stability(&self, def: DefId) -> Option<attr::Stability> { bug!("stability") }
 319     fn deprecation(&self, def: DefId) -> Option<attr::Deprecation> { bug!("deprecation") }
 320     fn visibility(&self, def: DefId) -> ty::Visibility { bug!("visibility") }
 321     fn visible_parent_map<'a>(&'a self) -> ::std::cell::Ref<'a, DefIdMap<DefId>> {
 322         bug!("visible_parent_map")
 323     }
 324     fn item_generics_cloned(&self, def: DefId) -> ty::Generics
 325         { bug!("item_generics_cloned") }
 326     fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute> { bug!("item_attrs") }
 327     fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name> { bug!("fn_arg_names") }
 328
 329     // trait info
 330     fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId> { vec![] }
 331
 332     // impl info
 333     fn impl_polarity(&self, def: DefId) -> hir::ImplPolarity { bug!("impl_polarity") }
 334     fn impl_parent(&self, def: DefId) -> Option<DefId> { bug!("impl_parent") }
 335
 336     // trait/impl-item info
 337     fn trait_of_item(&self, def_id: DefId) -> Option<DefId> { bug!("trait_of_item") }
 338     fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem
 339         { bug!("associated_item_cloned") }
 340
 341     // flags
 342     fn is_const_fn(&self, did: DefId) -> bool { bug!("is_const_fn") }
 343     fn is_default_impl(&self, impl_did: DefId) -> bool { bug!("is_default_impl") }
 344     fn is_foreign_item(&self, did: DefId) -> bool { bug!("is_foreign_item") }
 345     fn is_dllimport_foreign_item(&self, id: DefId) -> bool { false }
 346     fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool { false }
 347     fn is_exported_symbol(&self, def_id: DefId) -> bool { false }
 348
 349     // crate metadata
 350     fn dylib_dependency_formats(&self, cnum: CrateNum)
 351                                     -> Vec<(CrateNum, LinkagePreference)>
 352         { bug!("dylib_dependency_formats") }
 353     fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
 354         { bug!("lang_items") }
 355     fn missing_lang_items(&self, cnum: CrateNum) -> Vec<lang_items::LangItem>
 356         { bug!("missing_lang_items") }
 357     fn is_staged_api(&self, cnum: CrateNum) -> bool { bug!("is_staged_api") }
 358     fn dep_kind(&self, cnum: CrateNum) -> DepKind { bug!("is_explicitly_linked") }
 359     fn export_macros(&self, cnum: CrateNum) { bug!("export_macros") }
 360     fn is_allocator(&self, cnum: CrateNum) -> bool { bug!("is_allocator") }
 361     fn is_panic_runtime(&self, cnum: CrateNum) -> bool { bug!("is_panic_runtime") }
 362     fn is_compiler_builtins(&self, cnum: CrateNum) -> bool { bug!("is_compiler_builtins") }
 363     fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool { bug!("is_sanitizer_runtime") }
 364     fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
 365         bug!("panic_strategy")
 366     }
 367     fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate> { bug!("extern_crate") }
 368     fn crate_name(&self, cnum: CrateNum) -> Symbol { bug!("crate_name") }
 369     fn original_crate_name(&self, cnum: CrateNum) -> Symbol {
 370         bug!("original_crate_name")
 371     }
 372     fn crate_hash(&self, cnum: CrateNum) -> Svh { bug!("crate_hash") }
 373     fn crate_disambiguator(&self, cnum: CrateNum)
 374                            -> Symbol { bug!("crate_disambiguator") }
 375     fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 376         { bug!("plugin_registrar_fn") }
 377     fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 378         { bug!("derive_registrar_fn") }
 379     fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
 380         { bug!("native_libraries") }
 381     fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId> { bug!("exported_symbols") }
 382     fn is_no_builtins(&self, cnum: CrateNum) -> bool { bug!("is_no_builtins") }
 383
 384     // resolve
 385     fn retrace_path(&self,
 386                     cnum: CrateNum,
 387                     path_data: &[DisambiguatedDefPathData])
 388                     -> Option<DefId> {
 389         None
 390     }
 391
 392     fn def_key(&self, def: DefId) -> DefKey { bug!("def_key") }
 393     fn def_path(&self, def: DefId) -> hir_map::DefPath {
 394         bug!("relative_def_path")
 395     }
 396     fn def_path_hash(&self, def: DefId) -> u64 {
 397         bug!("wa")
 398     }
 399     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name> { bug!("struct_field_names") }
 400     fn item_children(&self, did: DefId) -> Vec<def::Export> { bug!("item_children") }
 401     fn load_macro(&self, did: DefId, sess: &Session) -> LoadedMacro { bug!("load_macro") }
 402
 403     // misc. metadata
 404     fn maybe_get_item_body<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
 405                                      -> Option<&'tcx hir::Body> {
 406         bug!("maybe_get_item_body")
 407     }
 408     fn item_body_nested_bodies(&self, def: DefId) -> BTreeMap<hir::BodyId, hir::Body> {
 409         bug!("item_body_nested_bodies")
 410     }
 411     fn const_is_rvalue_promotable_to_static(&self, def: DefId) -> bool {
 412         bug!("const_is_rvalue_promotable_to_static")
 413     }
 414
 415     fn is_item_mir_available(&self, def: DefId) -> bool {
 416         bug!("is_item_mir_available")
 417     }
 418
 419     // This is basically a 1-based range of ints, which is a little
 420     // silly - I may fix that.
 421     fn crates(&self) -> Vec<CrateNum> { vec![] }
 422     fn used_libraries(&self) -> Vec<NativeLibrary> { vec![] }
 423     fn used_link_args(&self) -> Vec<String> { vec![] }
 424
 425     // utility functions
 426     fn metadata_filename(&self) -> &str { bug!("metadata_filename") }
 427     fn metadata_section_name(&self, target: &Target) -> &str { bug!("metadata_section_name") }
 428     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
 429         { vec![] }
 430     fn used_crate_source(&self, cnum: CrateNum) -> CrateSource { bug!("used_crate_source") }
 431     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum> { None }
 432     fn encode_metadata<'a, 'tcx>(&self,
 433                                  tcx: TyCtxt<'a, 'tcx, 'tcx>,
 434                                  link_meta: &LinkMeta,
 435                                  reachable: &NodeSet)
 436                                  -> EncodedMetadata {
 437         bug!("encode_metadata")
 438     }
 439     fn metadata_encoding_version(&self) -> &[u8] { bug!("metadata_encoding_version") }
 440 }
 441
 442 pub trait CrateLoader {
 443     fn process_item(&mut self, item: &ast::Item, defs: &Definitions);
 444     fn postprocess(&mut self, krate: &ast::Crate);
 445 }