src/librustc_metadata/cstore_impl.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 use cstore;
  12 use encoder;
  13 use locator;
  14 use schema;
  15
  16 use rustc::dep_graph::DepTrackingMapConfig;
  17 use rustc::middle::cstore::{CrateStore, CrateSource, LibSource, DepKind,
  18                             ExternCrate, NativeLibrary, LinkMeta,
  19                             LinkagePreference, LoadedMacro, EncodedMetadata};
  20 use rustc::hir::def;
  21 use rustc::middle::lang_items;
  22 use rustc::session::Session;
  23 use rustc::ty::{self, TyCtxt};
  24 use rustc::ty::maps::Providers;
  25 use rustc::hir::def_id::{CrateNum, DefId, DefIndex, CRATE_DEF_INDEX, LOCAL_CRATE};
  26
  27 use rustc::dep_graph::DepNode;
  28 use rustc::hir::map::{DefKey, DefPath, DisambiguatedDefPathData};
  29 use rustc::util::nodemap::{NodeSet, DefIdMap};
  30 use rustc_back::PanicStrategy;
  31
  32 use std::any::Any;
  33 use std::rc::Rc;
  34
  35 use syntax::ast;
  36 use syntax::attr;
  37 use syntax::parse::filemap_to_stream;
  38 use syntax::symbol::Symbol;
  39 use syntax_pos::{Span, NO_EXPANSION};
  40 use rustc::hir::svh::Svh;
  41 use rustc_back::target::Target;
  42 use rustc::hir;
  43
  44 use std::collections::BTreeMap;
  45
  46 macro_rules! provide {
  47     (<$lt:tt> $tcx:ident, $def_id:ident, $cdata:ident $($name:ident => $compute:block)*) => {
  48         pub fn provide<$lt>(providers: &mut Providers<$lt>) {
  49             $(fn $name<'a, $lt:$lt>($tcx: TyCtxt<'a, $lt, $lt>, $def_id: DefId)
  50                                     -> <ty::queries::$name<$lt> as
  51                                         DepTrackingMapConfig>::Value {
  52                 assert!(!$def_id.is_local());
  53
  54                 $tcx.dep_graph.read(DepNode::MetaData($def_id));
  55
  56                 let $cdata = $tcx.sess.cstore.crate_data_as_rc_any($def_id.krate);
  57                 let $cdata = $cdata.downcast_ref::<cstore::CrateMetadata>()
  58                     .expect("CrateStore crated ata is not a CrateMetadata");
  59                 $compute
  60             })*
  61
  62             *providers = Providers {
  63                 $($name,)*
  64                 ..*providers
  65             };
  66         }
  67     }
  68 }
  69
  70 provide! { <'tcx> tcx, def_id, cdata
  71     type_of => { cdata.get_type(def_id.index, tcx) }
  72     generics_of => { tcx.alloc_generics(cdata.get_generics(def_id.index)) }
  73     predicates_of => { cdata.get_predicates(def_id.index, tcx) }
  74     super_predicates_of => { cdata.get_super_predicates(def_id.index, tcx) }
  75     trait_def => {
  76         tcx.alloc_trait_def(cdata.get_trait_def(def_id.index))
  77     }
  78     adt_def => { cdata.get_adt_def(def_id.index, tcx) }
  79     adt_destructor => {
  80         let _ = cdata;
  81         tcx.calculate_dtor(def_id, &mut |_,_| Ok(()))
  82     }
  83     variances_of => { Rc::new(cdata.get_item_variances(def_id.index)) }
  84     associated_item_def_ids => {
  85         let mut result = vec![];
  86         cdata.each_child_of_item(def_id.index, |child| result.push(child.def.def_id()));
  87         Rc::new(result)
  88     }
  89     associated_item => { cdata.get_associated_item(def_id.index) }
  90     impl_trait_ref => { cdata.get_impl_trait(def_id.index, tcx) }
  91     impl_polarity => { cdata.get_impl_polarity(def_id.index) }
  92     coerce_unsized_info => {
  93         cdata.get_coerce_unsized_info(def_id.index).unwrap_or_else(|| {
  94             bug!("coerce_unsized_info: `{:?}` is missing its info", def_id);
  95         })
  96     }
  97     optimized_mir => {
  98         let mir = cdata.maybe_get_optimized_mir(tcx, def_id.index).unwrap_or_else(|| {
  99             bug!("get_optimized_mir: missing MIR for `{:?}`", def_id)
 100         });
 101
 102         let mir = tcx.alloc_mir(mir);
 103
 104         mir
 105     }
 106     mir_const_qualif => { cdata.mir_const_qualif(def_id.index) }
 107     typeck_tables_of => { cdata.item_body_tables(def_id.index, tcx) }
 108     closure_kind => { cdata.closure_kind(def_id.index) }
 109     closure_type => { cdata.closure_ty(def_id.index, tcx) }
 110     inherent_impls => { Rc::new(cdata.get_inherent_implementations_for_type(def_id.index)) }
 111     is_foreign_item => { cdata.is_foreign_item(def_id.index) }
 112     describe_def => { cdata.get_def(def_id.index) }
 113     def_span => { cdata.get_span(def_id.index, &tcx.sess) }
 114     stability => { cdata.get_stability(def_id.index) }
 115     deprecation => { cdata.get_deprecation(def_id.index) }
 116     item_body_nested_bodies => {
 117         let map: BTreeMap<_, _> = cdata.entry(def_id.index).ast.into_iter().flat_map(|ast| {
 118             ast.decode(cdata).nested_bodies.decode(cdata).map(|body| (body.id(), body))
 119         }).collect();
 120
 121         Rc::new(map)
 122     }
 123     const_is_rvalue_promotable_to_static => {
 124         cdata.entry(def_id.index).ast.expect("const item missing `ast`")
 125             .decode(cdata).rvalue_promotable_to_static
 126     }
 127     is_mir_available => {
 128         !cdata.is_proc_macro(def_id.index) &&
 129         cdata.maybe_entry(def_id.index).and_then(|item| item.decode(cdata).mir).is_some()
 130     }
 131 }
 132
 133 impl CrateStore for cstore::CStore {
 134     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any> {
 135         self.get_crate_data(krate)
 136     }
 137
 138     fn visibility(&self, def: DefId) -> ty::Visibility {
 139         self.dep_graph.read(DepNode::MetaData(def));
 140         self.get_crate_data(def.krate).get_visibility(def.index)
 141     }
 142
 143     fn item_generics_cloned(&self, def: DefId) -> ty::Generics {
 144         self.dep_graph.read(DepNode::MetaData(def));
 145         self.get_crate_data(def.krate).get_generics(def.index)
 146     }
 147
 148     fn item_attrs(&self, def_id: DefId) -> Rc<[ast::Attribute]>
 149     {
 150         self.dep_graph.read(DepNode::MetaData(def_id));
 151         self.get_crate_data(def_id.krate).get_item_attrs(def_id.index)
 152     }
 153
 154     fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name>
 155     {
 156         // FIXME(#38501) We've skipped a `read` on the `HirBody` of
 157         // a `fn` when encoding, so the dep-tracking wouldn't work.
 158         // This is only used by rustdoc anyway, which shouldn't have
 159         // incremental recompilation ever enabled.
 160         assert!(!self.dep_graph.is_fully_enabled());
 161         self.get_crate_data(did.krate).get_fn_arg_names(did.index)
 162     }
 163
 164     fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>
 165     {
 166         if let Some(def_id) = filter {
 167             self.dep_graph.read(DepNode::MetaData(def_id));
 168         }
 169         let mut result = vec![];
 170         self.iter_crate_data(|_, cdata| {
 171             cdata.get_implementations_for_trait(filter, &mut result)
 172         });
 173         result
 174     }
 175
 176     fn impl_defaultness(&self, def: DefId) -> hir::Defaultness
 177     {
 178         self.dep_graph.read(DepNode::MetaData(def));
 179         self.get_crate_data(def.krate).get_impl_defaultness(def.index)
 180     }
 181
 182     fn impl_parent(&self, impl_def: DefId) -> Option<DefId> {
 183         self.dep_graph.read(DepNode::MetaData(impl_def));
 184         self.get_crate_data(impl_def.krate).get_parent_impl(impl_def.index)
 185     }
 186
 187     fn trait_of_item(&self, def_id: DefId) -> Option<DefId> {
 188         self.dep_graph.read(DepNode::MetaData(def_id));
 189         self.get_crate_data(def_id.krate).get_trait_of_item(def_id.index)
 190     }
 191
 192     fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem
 193     {
 194         self.dep_graph.read(DepNode::MetaData(def));
 195         self.get_crate_data(def.krate).get_associated_item(def.index)
 196     }
 197
 198     fn is_const_fn(&self, did: DefId) -> bool
 199     {
 200         self.dep_graph.read(DepNode::MetaData(did));
 201         self.get_crate_data(did.krate).is_const_fn(did.index)
 202     }
 203
 204     fn is_default_impl(&self, impl_did: DefId) -> bool {
 205         self.dep_graph.read(DepNode::MetaData(impl_did));
 206         self.get_crate_data(impl_did.krate).is_default_impl(impl_did.index)
 207     }
 208
 209     fn is_foreign_item(&self, did: DefId) -> bool {
 210         self.get_crate_data(did.krate).is_foreign_item(did.index)
 211     }
 212
 213     fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool
 214     {
 215         self.do_is_statically_included_foreign_item(def_id)
 216     }
 217
 218     fn is_exported_symbol(&self, def_id: DefId) -> bool {
 219         self.get_crate_data(def_id.krate).exported_symbols.contains(&def_id.index)
 220     }
 221
 222     fn is_dllimport_foreign_item(&self, def_id: DefId) -> bool {
 223         if def_id.krate == LOCAL_CRATE {
 224             self.dllimport_foreign_items.borrow().contains(&def_id.index)
 225         } else {
 226             self.get_crate_data(def_id.krate).is_dllimport_foreign_item(def_id.index)
 227         }
 228     }
 229
 230     fn dylib_dependency_formats(&self, cnum: CrateNum)
 231                                 -> Vec<(CrateNum, LinkagePreference)>
 232     {
 233         self.get_crate_data(cnum).get_dylib_dependency_formats()
 234     }
 235
 236     fn dep_kind(&self, cnum: CrateNum) -> DepKind
 237     {
 238         self.get_crate_data(cnum).dep_kind.get()
 239     }
 240
 241     fn export_macros(&self, cnum: CrateNum) {
 242         if self.get_crate_data(cnum).dep_kind.get() == DepKind::UnexportedMacrosOnly {
 243             self.get_crate_data(cnum).dep_kind.set(DepKind::MacrosOnly)
 244         }
 245     }
 246
 247     fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
 248     {
 249         self.get_crate_data(cnum).get_lang_items()
 250     }
 251
 252     fn missing_lang_items(&self, cnum: CrateNum)
 253                           -> Vec<lang_items::LangItem>
 254     {
 255         self.get_crate_data(cnum).get_missing_lang_items()
 256     }
 257
 258     fn is_staged_api(&self, cnum: CrateNum) -> bool
 259     {
 260         self.get_crate_data(cnum).is_staged_api()
 261     }
 262
 263     fn is_allocator(&self, cnum: CrateNum) -> bool
 264     {
 265         self.get_crate_data(cnum).is_allocator()
 266     }
 267
 268     fn is_panic_runtime(&self, cnum: CrateNum) -> bool
 269     {
 270         self.get_crate_data(cnum).is_panic_runtime()
 271     }
 272
 273     fn is_compiler_builtins(&self, cnum: CrateNum) -> bool {
 274         self.get_crate_data(cnum).is_compiler_builtins()
 275     }
 276
 277     fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool {
 278         self.get_crate_data(cnum).is_sanitizer_runtime()
 279     }
 280
 281     fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
 282         self.get_crate_data(cnum).panic_strategy()
 283     }
 284
 285     fn crate_name(&self, cnum: CrateNum) -> Symbol
 286     {
 287         self.get_crate_data(cnum).name
 288     }
 289
 290     fn original_crate_name(&self, cnum: CrateNum) -> Symbol
 291     {
 292         self.get_crate_data(cnum).name()
 293     }
 294
 295     fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate>
 296     {
 297         self.get_crate_data(cnum).extern_crate.get()
 298     }
 299
 300     fn crate_hash(&self, cnum: CrateNum) -> Svh
 301     {
 302         self.get_crate_hash(cnum)
 303     }
 304
 305     fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol
 306     {
 307         self.get_crate_data(cnum).disambiguator()
 308     }
 309
 310     fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 311     {
 312         self.get_crate_data(cnum).root.plugin_registrar_fn.map(|index| DefId {
 313             krate: cnum,
 314             index: index
 315         })
 316     }
 317
 318     fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 319     {
 320         self.get_crate_data(cnum).root.macro_derive_registrar.map(|index| DefId {
 321             krate: cnum,
 322             index: index
 323         })
 324     }
 325
 326     fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
 327     {
 328         self.get_crate_data(cnum).get_native_libraries()
 329     }
 330
 331     fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>
 332     {
 333         self.get_crate_data(cnum).get_exported_symbols()
 334     }
 335
 336     fn is_no_builtins(&self, cnum: CrateNum) -> bool {
 337         self.get_crate_data(cnum).is_no_builtins()
 338     }
 339
 340     fn retrace_path(&self,
 341                     cnum: CrateNum,
 342                     path: &[DisambiguatedDefPathData])
 343                     -> Option<DefId> {
 344         let cdata = self.get_crate_data(cnum);
 345         cdata.def_path_table
 346              .retrace_path(&path)
 347              .map(|index| DefId { krate: cnum, index: index })
 348     }
 349
 350     /// Returns the `DefKey` for a given `DefId`. This indicates the
 351     /// parent `DefId` as well as some idea of what kind of data the
 352     /// `DefId` refers to.
 353     fn def_key(&self, def: DefId) -> DefKey {
 354         // Note: loading the def-key (or def-path) for a def-id is not
 355         // a *read* of its metadata. This is because the def-id is
 356         // really just an interned shorthand for a def-path, which is the
 357         // canonical name for an item.
 358         //
 359         // self.dep_graph.read(DepNode::MetaData(def));
 360         self.get_crate_data(def.krate).def_key(def.index)
 361     }
 362
 363     fn def_path(&self, def: DefId) -> DefPath {
 364         // See `Note` above in `def_key()` for why this read is
 365         // commented out:
 366         //
 367         // self.dep_graph.read(DepNode::MetaData(def));
 368         self.get_crate_data(def.krate).def_path(def.index)
 369     }
 370
 371     fn def_path_hash(&self, def: DefId) -> u64 {
 372         self.get_crate_data(def.krate).def_path_hash(def.index)
 373     }
 374
 375     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>
 376     {
 377         self.dep_graph.read(DepNode::MetaData(def));
 378         self.get_crate_data(def.krate).get_struct_field_names(def.index)
 379     }
 380
 381     fn item_children(&self, def_id: DefId) -> Vec<def::Export>
 382     {
 383         self.dep_graph.read(DepNode::MetaData(def_id));
 384         let mut result = vec![];
 385         self.get_crate_data(def_id.krate)
 386             .each_child_of_item(def_id.index, |child| result.push(child));
 387         result
 388     }
 389
 390     fn load_macro(&self, id: DefId, sess: &Session) -> LoadedMacro {
 391         let data = self.get_crate_data(id.krate);
 392         if let Some(ref proc_macros) = data.proc_macros {
 393             return LoadedMacro::ProcMacro(proc_macros[id.index.as_usize() - 1].1.clone());
 394         }
 395
 396         let (name, def) = data.get_macro(id.index);
 397         let source_name = format!("<{} macros>", name);
 398
 399         let filemap = sess.parse_sess.codemap().new_filemap(source_name, def.body);
 400         let local_span = Span { lo: filemap.start_pos, hi: filemap.end_pos, ctxt: NO_EXPANSION };
 401         let body = filemap_to_stream(&sess.parse_sess, filemap);
 402
 403         // Mark the attrs as used
 404         let attrs = data.get_item_attrs(id.index);
 405         for attr in attrs.iter() {
 406             attr::mark_used(attr);
 407         }
 408
 409         let name = data.def_key(id.index).disambiguated_data.data
 410             .get_opt_name().expect("no name in load_macro");
 411         sess.imported_macro_spans.borrow_mut()
 412             .insert(local_span, (name.to_string(), data.get_span(id.index, sess)));
 413
 414         LoadedMacro::MacroDef(ast::Item {
 415             ident: ast::Ident::with_empty_ctxt(name),
 416             id: ast::DUMMY_NODE_ID,
 417             span: local_span,
 418             attrs: attrs.iter().cloned().collect(),
 419             node: ast::ItemKind::MacroDef(body.into()),
 420             vis: ast::Visibility::Inherited,
 421         })
 422     }
 423
 424     fn item_body<'a, 'tcx>(&self,
 425                            tcx: TyCtxt<'a, 'tcx, 'tcx>,
 426                            def_id: DefId)
 427                            -> &'tcx hir::Body {
 428         if let Some(cached) = tcx.hir.get_inlined_body(def_id) {
 429             return cached;
 430         }
 431
 432         self.dep_graph.read(DepNode::MetaData(def_id));
 433         debug!("item_body({}): inlining item", tcx.item_path_str(def_id));
 434
 435         self.get_crate_data(def_id.krate).item_body(tcx, def_id.index)
 436     }
 437
 438     fn crates(&self) -> Vec<CrateNum>
 439     {
 440         let mut result = vec![];
 441         self.iter_crate_data(|cnum, _| result.push(cnum));
 442         result
 443     }
 444
 445     fn used_libraries(&self) -> Vec<NativeLibrary>
 446     {
 447         self.get_used_libraries().borrow().clone()
 448     }
 449
 450     fn used_link_args(&self) -> Vec<String>
 451     {
 452         self.get_used_link_args().borrow().clone()
 453     }
 454
 455     fn metadata_filename(&self) -> &str
 456     {
 457         locator::METADATA_FILENAME
 458     }
 459
 460     fn metadata_section_name(&self, target: &Target) -> &str
 461     {
 462         locator::meta_section_name(target)
 463     }
 464
 465     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
 466     {
 467         self.do_get_used_crates(prefer)
 468     }
 469
 470     fn used_crate_source(&self, cnum: CrateNum) -> CrateSource
 471     {
 472         self.get_crate_data(cnum).source.clone()
 473     }
 474
 475     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>
 476     {
 477         self.do_extern_mod_stmt_cnum(emod_id)
 478     }
 479
 480     fn encode_metadata<'a, 'tcx>(&self,
 481                                  tcx: TyCtxt<'a, 'tcx, 'tcx>,
 482                                  link_meta: &LinkMeta,
 483                                  reachable: &NodeSet)
 484                                  -> EncodedMetadata
 485     {
 486         encoder::encode_metadata(tcx, self, link_meta, reachable)
 487     }
 488
 489     fn metadata_encoding_version(&self) -> &[u8]
 490     {
 491         schema::METADATA_HEADER
 492     }
 493
 494     /// Returns a map from a sufficiently visible external item (i.e. an external item that is
 495     /// visible from at least one local module) to a sufficiently visible parent (considering
 496     /// modules that re-export the external item to be parents).
 497     fn visible_parent_map<'a>(&'a self) -> ::std::cell::Ref<'a, DefIdMap<DefId>> {
 498         {
 499             let visible_parent_map = self.visible_parent_map.borrow();
 500             if !visible_parent_map.is_empty() {
 501                 return visible_parent_map;
 502             }
 503         }
 504
 505         use std::collections::vec_deque::VecDeque;
 506         use std::collections::hash_map::Entry;
 507
 508         let mut visible_parent_map = self.visible_parent_map.borrow_mut();
 509
 510         for cnum in (1 .. self.next_crate_num().as_usize()).map(CrateNum::new) {
 511             let cdata = self.get_crate_data(cnum);
 512
 513             match cdata.extern_crate.get() {
 514                 // Ignore crates without a corresponding local `extern crate` item.
 515                 Some(extern_crate) if !extern_crate.direct => continue,
 516                 _ => {},
 517             }
 518
 519             let mut bfs_queue = &mut VecDeque::new();
 520             let mut add_child = |bfs_queue: &mut VecDeque<_>, child: def::Export, parent: DefId| {
 521                 let child = child.def.def_id();
 522
 523                 if self.visibility(child) != ty::Visibility::Public {
 524                     return;
 525                 }
 526
 527                 match visible_parent_map.entry(child) {
 528                     Entry::Occupied(mut entry) => {
 529                         // If `child` is defined in crate `cnum`, ensure
 530                         // that it is mapped to a parent in `cnum`.
 531                         if child.krate == cnum && entry.get().krate != cnum {
 532                             entry.insert(parent);
 533                         }
 534                     }
 535                     Entry::Vacant(entry) => {
 536                         entry.insert(parent);
 537                         bfs_queue.push_back(child);
 538                     }
 539                 }
 540             };
 541
 542             bfs_queue.push_back(DefId {
 543                 krate: cnum,
 544                 index: CRATE_DEF_INDEX
 545             });
 546             while let Some(def) = bfs_queue.pop_front() {
 547                 for child in self.item_children(def) {
 548                     add_child(bfs_queue, child, def);
 549                 }
 550             }
 551         }
 552
 553         drop(visible_parent_map);
 554         self.visible_parent_map.borrow()
 555     }
 556 }