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