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                             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 use rustc::hir::map::{DefKey, DefPath, DisambiguatedDefPathData, DefPathHash};
  26 use rustc::hir::map::blocks::FnLikeNode;
  27 use rustc::hir::map::definitions::{DefPathTable, GlobalMetaDataKind};
  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                 let def_path_hash = $tcx.def_path_hash($def_id);
  51                 let dep_node = def_path_hash.to_dep_node(::rustc::dep_graph::DepKind::MetaData);
  52
  53                 $tcx.dep_graph.read(dep_node);
  54
  55                 let $cdata = $tcx.sess.cstore.crate_data_as_rc_any($def_id.krate);
  56                 let $cdata = $cdata.downcast_ref::<cstore::CrateMetadata>()
  57                     .expect("CrateStore crated ata is not a CrateMetadata");
  58                 $compute
  59             })*
  60
  61             *providers = Providers {
  62                 $($name,)*
  63                 ..*providers
  64             };
  65         }
  66     }
  67 }
  68
  69 provide! { <'tcx> tcx, def_id, cdata,
  70     type_of => { cdata.get_type(def_id.index, tcx) }
  71     generics_of => { tcx.alloc_generics(cdata.get_generics(def_id.index)) }
  72     predicates_of => { cdata.get_predicates(def_id.index, tcx) }
  73     super_predicates_of => { cdata.get_super_predicates(def_id.index, tcx) }
  74     trait_def => {
  75         tcx.alloc_trait_def(cdata.get_trait_def(def_id.index))
  76     }
  77     adt_def => { cdata.get_adt_def(def_id.index, tcx) }
  78     adt_destructor => {
  79         let _ = cdata;
  80         tcx.calculate_dtor(def_id, &mut |_,_| Ok(()))
  81     }
  82     variances_of => { Rc::new(cdata.get_item_variances(def_id.index)) }
  83     associated_item_def_ids => {
  84         let mut result = vec![];
  85         cdata.each_child_of_item(def_id.index,
  86           |child| result.push(child.def.def_id()), tcx.sess);
  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     fn_sig => { cdata.fn_sig(def_id.index, tcx) }
 110     inherent_impls => { Rc::new(cdata.get_inherent_implementations_for_type(def_id.index)) }
 111     is_const_fn => { cdata.is_const_fn(def_id.index) }
 112     is_foreign_item => { cdata.is_foreign_item(def_id.index) }
 113     is_default_impl => { cdata.is_default_impl(def_id.index) }
 114     describe_def => { cdata.get_def(def_id.index) }
 115     def_span => { cdata.get_span(def_id.index, &tcx.sess) }
 116     stability => { cdata.get_stability(def_id.index) }
 117     deprecation => { cdata.get_deprecation(def_id.index) }
 118     item_attrs => { cdata.get_item_attrs(def_id.index, &tcx.dep_graph) }
 119     // FIXME(#38501) We've skipped a `read` on the `HirBody` of
 120     // a `fn` when encoding, so the dep-tracking wouldn't work.
 121     // This is only used by rustdoc anyway, which shouldn't have
 122     // incremental recompilation ever enabled.
 123     fn_arg_names => { cdata.get_fn_arg_names(def_id.index) }
 124     impl_parent => { cdata.get_parent_impl(def_id.index) }
 125     trait_of_item => { cdata.get_trait_of_item(def_id.index) }
 126     is_exported_symbol => {
 127         let dep_node = cdata.metadata_dep_node(GlobalMetaDataKind::ExportedSymbols);
 128         cdata.exported_symbols.get(&tcx.dep_graph, dep_node).contains(&def_id.index)
 129     }
 130     item_body_nested_bodies => { Rc::new(cdata.item_body_nested_bodies(def_id.index)) }
 131     const_is_rvalue_promotable_to_static => {
 132         cdata.const_is_rvalue_promotable_to_static(def_id.index)
 133     }
 134     is_mir_available => { cdata.is_item_mir_available(def_id.index) }
 135
 136     dylib_dependency_formats => { Rc::new(cdata.get_dylib_dependency_formats(&tcx.dep_graph)) }
 137     is_panic_runtime => { cdata.is_panic_runtime(&tcx.dep_graph) }
 138     extern_crate => { Rc::new(cdata.extern_crate.get()) }
 139 }
 140
 141 pub fn provide_local<'tcx>(providers: &mut Providers<'tcx>) {
 142     fn is_const_fn<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> bool {
 143         let node_id = tcx.hir.as_local_node_id(def_id)
 144                              .expect("Non-local call to local provider is_const_fn");
 145
 146         if let Some(fn_like) = FnLikeNode::from_node(tcx.hir.get(node_id)) {
 147             fn_like.constness() == hir::Constness::Const
 148         } else {
 149             false
 150         }
 151     }
 152
 153     *providers = Providers {
 154         is_const_fn,
 155         ..*providers
 156     };
 157 }
 158
 159 impl CrateStore for cstore::CStore {
 160     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any> {
 161         self.get_crate_data(krate)
 162     }
 163
 164     fn metadata_loader(&self) -> &MetadataLoader {
 165         &*self.metadata_loader
 166     }
 167
 168     fn visibility(&self, def: DefId) -> ty::Visibility {
 169         self.read_dep_node(def);
 170         self.get_crate_data(def.krate).get_visibility(def.index)
 171     }
 172
 173     fn item_generics_cloned(&self, def: DefId) -> ty::Generics {
 174         self.read_dep_node(def);
 175         self.get_crate_data(def.krate).get_generics(def.index)
 176     }
 177
 178     fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>
 179     {
 180         let mut result = vec![];
 181
 182         self.iter_crate_data(|_, cdata| {
 183             cdata.get_implementations_for_trait(filter, &self.dep_graph, &mut result)
 184         });
 185         result
 186     }
 187
 188     fn impl_defaultness(&self, def: DefId) -> hir::Defaultness
 189     {
 190         self.read_dep_node(def);
 191         self.get_crate_data(def.krate).get_impl_defaultness(def.index)
 192     }
 193
 194     fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem
 195     {
 196         self.read_dep_node(def);
 197         self.get_crate_data(def.krate).get_associated_item(def.index)
 198     }
 199
 200     fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool
 201     {
 202         self.do_is_statically_included_foreign_item(def_id)
 203     }
 204
 205     fn is_dllimport_foreign_item(&self, def_id: DefId) -> bool {
 206         if def_id.krate == LOCAL_CRATE {
 207             self.dllimport_foreign_items.borrow().contains(&def_id.index)
 208         } else {
 209             self.get_crate_data(def_id.krate)
 210                 .is_dllimport_foreign_item(def_id.index, &self.dep_graph)
 211         }
 212     }
 213
 214     fn dep_kind(&self, cnum: CrateNum) -> DepKind
 215     {
 216         let data = self.get_crate_data(cnum);
 217         let dep_node = data.metadata_dep_node(GlobalMetaDataKind::CrateDeps);
 218         self.dep_graph.read(dep_node);
 219         data.dep_kind.get()
 220     }
 221
 222     fn export_macros(&self, cnum: CrateNum) {
 223         let data = self.get_crate_data(cnum);
 224         let dep_node = data.metadata_dep_node(GlobalMetaDataKind::CrateDeps);
 225
 226         self.dep_graph.read(dep_node);
 227         if data.dep_kind.get() == DepKind::UnexportedMacrosOnly {
 228             data.dep_kind.set(DepKind::MacrosOnly)
 229         }
 230     }
 231
 232     fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
 233     {
 234         self.get_crate_data(cnum).get_lang_items(&self.dep_graph)
 235     }
 236
 237     fn missing_lang_items(&self, cnum: CrateNum)
 238                           -> Vec<lang_items::LangItem>
 239     {
 240         self.get_crate_data(cnum).get_missing_lang_items(&self.dep_graph)
 241     }
 242
 243     fn is_compiler_builtins(&self, cnum: CrateNum) -> bool {
 244         self.get_crate_data(cnum).is_compiler_builtins(&self.dep_graph)
 245     }
 246
 247     fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool {
 248         self.get_crate_data(cnum).is_sanitizer_runtime(&self.dep_graph)
 249     }
 250
 251     fn is_profiler_runtime(&self, cnum: CrateNum) -> bool {
 252         self.get_crate_data(cnum).is_profiler_runtime(&self.dep_graph)
 253     }
 254
 255     fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
 256         self.get_crate_data(cnum).panic_strategy(&self.dep_graph)
 257     }
 258
 259     fn crate_name(&self, cnum: CrateNum) -> Symbol
 260     {
 261         self.get_crate_data(cnum).name
 262     }
 263
 264     fn original_crate_name(&self, cnum: CrateNum) -> Symbol
 265     {
 266         self.get_crate_data(cnum).name()
 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) -> DefPathHash {
 341         self.get_crate_data(def.krate).def_path_hash(def.index)
 342     }
 343
 344     fn def_path_table(&self, cnum: CrateNum) -> Rc<DefPathTable> {
 345         self.get_crate_data(cnum).def_path_table.clone()
 346     }
 347
 348     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>
 349     {
 350         self.read_dep_node(def);
 351         self.get_crate_data(def.krate).get_struct_field_names(def.index)
 352     }
 353
 354     fn item_children(&self, def_id: DefId, sess: &Session) -> Vec<def::Export>
 355     {
 356         self.read_dep_node(def_id);
 357         let mut result = vec![];
 358         self.get_crate_data(def_id.krate)
 359             .each_child_of_item(def_id.index, |child| result.push(child), sess);
 360         result
 361     }
 362
 363     fn load_macro(&self, id: DefId, sess: &Session) -> LoadedMacro {
 364         let data = self.get_crate_data(id.krate);
 365         if let Some(ref proc_macros) = data.proc_macros {
 366             return LoadedMacro::ProcMacro(proc_macros[id.index.as_usize() - 1].1.clone());
 367         }
 368
 369         let (name, def) = data.get_macro(id.index);
 370         let source_name = format!("<{} macros>", name);
 371
 372         let filemap = sess.parse_sess.codemap().new_filemap(source_name, def.body);
 373         let local_span = Span { lo: filemap.start_pos, hi: filemap.end_pos, ctxt: NO_EXPANSION };
 374         let body = filemap_to_stream(&sess.parse_sess, filemap);
 375
 376         // Mark the attrs as used
 377         let attrs = data.get_item_attrs(id.index, &self.dep_graph);
 378         for attr in attrs.iter() {
 379             attr::mark_used(attr);
 380         }
 381
 382         let name = data.def_key(id.index).disambiguated_data.data
 383             .get_opt_name().expect("no name in load_macro");
 384         sess.imported_macro_spans.borrow_mut()
 385             .insert(local_span, (name.to_string(), data.get_span(id.index, sess)));
 386
 387         LoadedMacro::MacroDef(ast::Item {
 388             ident: ast::Ident::with_empty_ctxt(name),
 389             id: ast::DUMMY_NODE_ID,
 390             span: local_span,
 391             attrs: attrs.iter().cloned().collect(),
 392             node: ast::ItemKind::MacroDef(ast::MacroDef {
 393                 tokens: body.into(),
 394                 legacy: def.legacy,
 395             }),
 396             vis: ast::Visibility::Inherited,
 397         })
 398     }
 399
 400     fn item_body<'a, 'tcx>(&self,
 401                            tcx: TyCtxt<'a, 'tcx, 'tcx>,
 402                            def_id: DefId)
 403                            -> &'tcx hir::Body {
 404         self.read_dep_node(def_id);
 405
 406         if let Some(cached) = tcx.hir.get_inlined_body_untracked(def_id) {
 407             return cached;
 408         }
 409
 410         debug!("item_body({:?}): inlining item", def_id);
 411
 412         self.get_crate_data(def_id.krate).item_body(tcx, def_id.index)
 413     }
 414
 415     fn crates(&self) -> Vec<CrateNum>
 416     {
 417         let mut result = vec![];
 418         self.iter_crate_data(|cnum, _| result.push(cnum));
 419         result
 420     }
 421
 422     fn used_libraries(&self) -> Vec<NativeLibrary>
 423     {
 424         self.get_used_libraries().borrow().clone()
 425     }
 426
 427     fn used_link_args(&self) -> Vec<String>
 428     {
 429         self.get_used_link_args().borrow().clone()
 430     }
 431     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
 432     {
 433         self.do_get_used_crates(prefer)
 434     }
 435
 436     fn used_crate_source(&self, cnum: CrateNum) -> CrateSource
 437     {
 438         self.get_crate_data(cnum).source.clone()
 439     }
 440
 441     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>
 442     {
 443         self.do_extern_mod_stmt_cnum(emod_id)
 444     }
 445
 446     fn encode_metadata<'a, 'tcx>(&self,
 447                                  tcx: TyCtxt<'a, 'tcx, 'tcx>,
 448                                  link_meta: &LinkMeta,
 449                                  reachable: &NodeSet)
 450                                  -> EncodedMetadata
 451     {
 452         encoder::encode_metadata(tcx, link_meta, reachable)
 453     }
 454
 455     fn metadata_encoding_version(&self) -> &[u8]
 456     {
 457         schema::METADATA_HEADER
 458     }
 459
 460     /// Returns a map from a sufficiently visible external item (i.e. an external item that is
 461     /// visible from at least one local module) to a sufficiently visible parent (considering
 462     /// modules that re-export the external item to be parents).
 463     fn visible_parent_map<'a>(&'a self, sess: &Session) -> ::std::cell::Ref<'a, DefIdMap<DefId>> {
 464         {
 465             let visible_parent_map = self.visible_parent_map.borrow();
 466             if !visible_parent_map.is_empty() {
 467                 return visible_parent_map;
 468             }
 469         }
 470
 471         use std::collections::vec_deque::VecDeque;
 472         use std::collections::hash_map::Entry;
 473
 474         let mut visible_parent_map = self.visible_parent_map.borrow_mut();
 475
 476         for cnum in (1 .. self.next_crate_num().as_usize()).map(CrateNum::new) {
 477             let cdata = self.get_crate_data(cnum);
 478
 479             match cdata.extern_crate.get() {
 480                 // Ignore crates without a corresponding local `extern crate` item.
 481                 Some(extern_crate) if !extern_crate.direct => continue,
 482                 _ => {},
 483             }
 484
 485             let mut bfs_queue = &mut VecDeque::new();
 486             let mut add_child = |bfs_queue: &mut VecDeque<_>, child: def::Export, parent: DefId| {
 487                 let child = child.def.def_id();
 488
 489                 if self.visibility(child) != ty::Visibility::Public {
 490                     return;
 491                 }
 492
 493                 match visible_parent_map.entry(child) {
 494                     Entry::Occupied(mut entry) => {
 495                         // If `child` is defined in crate `cnum`, ensure
 496                         // that it is mapped to a parent in `cnum`.
 497                         if child.krate == cnum && entry.get().krate != cnum {
 498                             entry.insert(parent);
 499                         }
 500                     }
 501                     Entry::Vacant(entry) => {
 502                         entry.insert(parent);
 503                         bfs_queue.push_back(child);
 504                     }
 505                 }
 506             };
 507
 508             bfs_queue.push_back(DefId {
 509                 krate: cnum,
 510                 index: CRATE_DEF_INDEX
 511             });
 512             while let Some(def) = bfs_queue.pop_front() {
 513                 for child in self.item_children(def, sess) {
 514                     add_child(bfs_queue, child, def);
 515                 }
 516             }
 517         }
 518
 519         drop(visible_parent_map);
 520         self.visible_parent_map.borrow()
 521     }
 522 }