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