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