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