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::ty::maps::QueryConfig;
  16 use rustc::middle::cstore::{CrateStore, CrateSource, LibSource, DepKind,
  17                             NativeLibrary, MetadataLoader, LinkMeta,
  18                             LinkagePreference, LoadedMacro, EncodedMetadata,
  19                             EncodedMetadataHashes};
  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 use rustc::hir::map::{DefKey, DefPath, DefPathHash};
  27 use rustc::hir::map::blocks::FnLikeNode;
  28 use rustc::hir::map::definitions::{DefPathTable, GlobalMetaDataKind};
  29 use rustc::util::nodemap::{NodeSet, DefIdMap};
  30 use rustc_back::PanicStrategy;
  31
  32 use std::any::Any;
  33 use std::rc::Rc;
  34
  35 use syntax::ast;
  36 use syntax::attr;
  37 use syntax::ext::base::SyntaxExtension;
  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::hir;
  43
  44 macro_rules! provide {
  45     (<$lt:tt> $tcx:ident, $def_id:ident, $cdata:ident, $($name:ident => $compute:block)*) => {
  46         pub fn provide<$lt>(providers: &mut Providers<$lt>) {
  47             $(fn $name<'a, $lt:$lt>($tcx: TyCtxt<'a, $lt, $lt>, $def_id: DefId)
  48                                     -> <ty::queries::$name<$lt> as
  49                                         QueryConfig>::Value {
  50                 assert!(!$def_id.is_local());
  51
  52                 let def_path_hash = $tcx.def_path_hash($def_id);
  53                 let dep_node = def_path_hash.to_dep_node(::rustc::dep_graph::DepKind::MetaData);
  54
  55                 $tcx.dep_graph.read(dep_node);
  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,
  88           |child| result.push(child.def.def_id()), tcx.sess);
  89         Rc::new(result)
  90     }
  91     associated_item => { cdata.get_associated_item(def_id.index) }
  92     impl_trait_ref => { cdata.get_impl_trait(def_id.index, tcx) }
  93     impl_polarity => { cdata.get_impl_polarity(def_id.index) }
  94     coerce_unsized_info => {
  95         cdata.get_coerce_unsized_info(def_id.index).unwrap_or_else(|| {
  96             bug!("coerce_unsized_info: `{:?}` is missing its info", def_id);
  97         })
  98     }
  99     optimized_mir => {
 100         let mir = cdata.maybe_get_optimized_mir(tcx, def_id.index).unwrap_or_else(|| {
 101             bug!("get_optimized_mir: missing MIR for `{:?}`", def_id)
 102         });
 103
 104         let mir = tcx.alloc_mir(mir);
 105
 106         mir
 107     }
 108     mir_const_qualif => { cdata.mir_const_qualif(def_id.index) }
 109     typeck_tables_of => { cdata.item_body_tables(def_id.index, tcx) }
 110     closure_kind => { cdata.closure_kind(def_id.index) }
 111     fn_sig => { cdata.fn_sig(def_id.index, tcx) }
 112     inherent_impls => { Rc::new(cdata.get_inherent_implementations_for_type(def_id.index)) }
 113     is_const_fn => { cdata.is_const_fn(def_id.index) }
 114     is_foreign_item => { cdata.is_foreign_item(def_id.index) }
 115     is_default_impl => { cdata.is_default_impl(def_id.index) }
 116     describe_def => { cdata.get_def(def_id.index) }
 117     def_span => { cdata.get_span(def_id.index, &tcx.sess) }
 118     stability => { cdata.get_stability(def_id.index) }
 119     deprecation => { cdata.get_deprecation(def_id.index) }
 120     item_attrs => { cdata.get_item_attrs(def_id.index, &tcx.dep_graph) }
 121     // FIXME(#38501) We've skipped a `read` on the `HirBody` of
 122     // a `fn` when encoding, so the dep-tracking wouldn't work.
 123     // This is only used by rustdoc anyway, which shouldn't have
 124     // incremental recompilation ever enabled.
 125     fn_arg_names => { cdata.get_fn_arg_names(def_id.index) }
 126     impl_parent => { cdata.get_parent_impl(def_id.index) }
 127     trait_of_item => { cdata.get_trait_of_item(def_id.index) }
 128     is_exported_symbol => {
 129         let dep_node = cdata.metadata_dep_node(GlobalMetaDataKind::ExportedSymbols);
 130         cdata.exported_symbols.get(&tcx.dep_graph, dep_node).contains(&def_id.index)
 131     }
 132     item_body_nested_bodies => { Rc::new(cdata.item_body_nested_bodies(def_id.index)) }
 133     const_is_rvalue_promotable_to_static => {
 134         cdata.const_is_rvalue_promotable_to_static(def_id.index)
 135     }
 136     is_mir_available => { cdata.is_item_mir_available(def_id.index) }
 137
 138     dylib_dependency_formats => { Rc::new(cdata.get_dylib_dependency_formats(&tcx.dep_graph)) }
 139     is_panic_runtime => { cdata.is_panic_runtime(&tcx.dep_graph) }
 140     extern_crate => { Rc::new(cdata.extern_crate.get()) }
 141 }
 142
 143 pub fn provide_local<'tcx>(providers: &mut Providers<'tcx>) {
 144     fn is_const_fn<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> bool {
 145         let node_id = tcx.hir.as_local_node_id(def_id)
 146                              .expect("Non-local call to local provider is_const_fn");
 147
 148         if let Some(fn_like) = FnLikeNode::from_node(tcx.hir.get(node_id)) {
 149             fn_like.constness() == hir::Constness::Const
 150         } else {
 151             false
 152         }
 153     }
 154
 155     *providers = Providers {
 156         is_const_fn,
 157         ..*providers
 158     };
 159 }
 160
 161 impl CrateStore for cstore::CStore {
 162     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any> {
 163         self.get_crate_data(krate)
 164     }
 165
 166     fn metadata_loader(&self) -> &MetadataLoader {
 167         &*self.metadata_loader
 168     }
 169
 170     fn visibility(&self, def: DefId) -> ty::Visibility {
 171         self.read_dep_node(def);
 172         self.get_crate_data(def.krate).get_visibility(def.index)
 173     }
 174
 175     fn item_generics_cloned(&self, def: DefId) -> ty::Generics {
 176         self.read_dep_node(def);
 177         self.get_crate_data(def.krate).get_generics(def.index)
 178     }
 179
 180     fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>
 181     {
 182         let mut result = vec![];
 183
 184         self.iter_crate_data(|_, cdata| {
 185             cdata.get_implementations_for_trait(filter, &self.dep_graph, &mut result)
 186         });
 187         result
 188     }
 189
 190     fn impl_defaultness(&self, def: DefId) -> hir::Defaultness
 191     {
 192         self.read_dep_node(def);
 193         self.get_crate_data(def.krate).get_impl_defaultness(def.index)
 194     }
 195
 196     fn associated_item_cloned(&self, def: DefId) -> ty::AssociatedItem
 197     {
 198         self.read_dep_node(def);
 199         self.get_crate_data(def.krate).get_associated_item(def.index)
 200     }
 201
 202     fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool
 203     {
 204         self.do_is_statically_included_foreign_item(def_id)
 205     }
 206
 207     fn is_dllimport_foreign_item(&self, def_id: DefId) -> bool {
 208         if def_id.krate == LOCAL_CRATE {
 209             self.dllimport_foreign_items.borrow().contains(&def_id.index)
 210         } else {
 211             self.get_crate_data(def_id.krate)
 212                 .is_dllimport_foreign_item(def_id.index, &self.dep_graph)
 213         }
 214     }
 215
 216     fn dep_kind(&self, cnum: CrateNum) -> DepKind
 217     {
 218         let data = self.get_crate_data(cnum);
 219         let dep_node = data.metadata_dep_node(GlobalMetaDataKind::CrateDeps);
 220         self.dep_graph.read(dep_node);
 221         data.dep_kind.get()
 222     }
 223
 224     fn export_macros(&self, cnum: CrateNum) {
 225         let data = self.get_crate_data(cnum);
 226         let dep_node = data.metadata_dep_node(GlobalMetaDataKind::CrateDeps);
 227
 228         self.dep_graph.read(dep_node);
 229         if data.dep_kind.get() == DepKind::UnexportedMacrosOnly {
 230             data.dep_kind.set(DepKind::MacrosOnly)
 231         }
 232     }
 233
 234     fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
 235     {
 236         self.get_crate_data(cnum).get_lang_items(&self.dep_graph)
 237     }
 238
 239     fn missing_lang_items(&self, cnum: CrateNum)
 240                           -> Vec<lang_items::LangItem>
 241     {
 242         self.get_crate_data(cnum).get_missing_lang_items(&self.dep_graph)
 243     }
 244
 245     fn is_compiler_builtins(&self, cnum: CrateNum) -> bool {
 246         self.get_crate_data(cnum).is_compiler_builtins(&self.dep_graph)
 247     }
 248
 249     fn is_sanitizer_runtime(&self, cnum: CrateNum) -> bool {
 250         self.get_crate_data(cnum).is_sanitizer_runtime(&self.dep_graph)
 251     }
 252
 253     fn is_profiler_runtime(&self, cnum: CrateNum) -> bool {
 254         self.get_crate_data(cnum).is_profiler_runtime(&self.dep_graph)
 255     }
 256
 257     fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
 258         self.get_crate_data(cnum).panic_strategy(&self.dep_graph)
 259     }
 260
 261     fn crate_name(&self, cnum: CrateNum) -> Symbol
 262     {
 263         self.get_crate_data(cnum).name
 264     }
 265
 266     fn original_crate_name(&self, cnum: CrateNum) -> Symbol
 267     {
 268         self.get_crate_data(cnum).name()
 269     }
 270
 271     fn crate_hash(&self, cnum: CrateNum) -> Svh
 272     {
 273         self.get_crate_hash(cnum)
 274     }
 275
 276     fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol
 277     {
 278         self.get_crate_data(cnum).disambiguator()
 279     }
 280
 281     fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 282     {
 283         self.get_crate_data(cnum).root.plugin_registrar_fn.map(|index| DefId {
 284             krate: cnum,
 285             index: index
 286         })
 287     }
 288
 289     fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 290     {
 291         self.get_crate_data(cnum).root.macro_derive_registrar.map(|index| DefId {
 292             krate: cnum,
 293             index: index
 294         })
 295     }
 296
 297     fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
 298     {
 299         self.get_crate_data(cnum).get_native_libraries(&self.dep_graph)
 300     }
 301
 302     fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>
 303     {
 304         self.get_crate_data(cnum).get_exported_symbols(&self.dep_graph)
 305     }
 306
 307     fn is_no_builtins(&self, cnum: CrateNum) -> bool {
 308         self.get_crate_data(cnum).is_no_builtins(&self.dep_graph)
 309     }
 310
 311     /// Returns the `DefKey` for a given `DefId`. This indicates the
 312     /// parent `DefId` as well as some idea of what kind of data the
 313     /// `DefId` refers to.
 314     fn def_key(&self, def: DefId) -> DefKey {
 315         // Note: loading the def-key (or def-path) for a def-id is not
 316         // a *read* of its metadata. This is because the def-id is
 317         // really just an interned shorthand for a def-path, which is the
 318         // canonical name for an item.
 319         //
 320         // self.dep_graph.read(DepNode::MetaData(def));
 321         self.get_crate_data(def.krate).def_key(def.index)
 322     }
 323
 324     fn def_path(&self, def: DefId) -> DefPath {
 325         // See `Note` above in `def_key()` for why this read is
 326         // commented out:
 327         //
 328         // self.dep_graph.read(DepNode::MetaData(def));
 329         self.get_crate_data(def.krate).def_path(def.index)
 330     }
 331
 332     fn def_path_hash(&self, def: DefId) -> DefPathHash {
 333         self.get_crate_data(def.krate).def_path_hash(def.index)
 334     }
 335
 336     fn def_path_table(&self, cnum: CrateNum) -> Rc<DefPathTable> {
 337         self.get_crate_data(cnum).def_path_table.clone()
 338     }
 339
 340     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>
 341     {
 342         self.read_dep_node(def);
 343         self.get_crate_data(def.krate).get_struct_field_names(def.index)
 344     }
 345
 346     fn item_children(&self, def_id: DefId, sess: &Session) -> Vec<def::Export>
 347     {
 348         self.read_dep_node(def_id);
 349         let mut result = vec![];
 350         self.get_crate_data(def_id.krate)
 351             .each_child_of_item(def_id.index, |child| result.push(child), sess);
 352         result
 353     }
 354
 355     fn load_macro(&self, id: DefId, sess: &Session) -> LoadedMacro {
 356         let data = self.get_crate_data(id.krate);
 357         if let Some(ref proc_macros) = data.proc_macros {
 358             return LoadedMacro::ProcMacro(proc_macros[id.index.as_usize() - 1].1.clone());
 359         } else if data.name == "proc_macro" &&
 360                   self.get_crate_data(id.krate).item_name(id.index) == "quote" {
 361             let ext = SyntaxExtension::ProcMacro(Box::new(::proc_macro::__internal::Quoter));
 362             return LoadedMacro::ProcMacro(Rc::new(ext));
 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, None);
 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(ast::MacroDef {
 389                 tokens: body.into(),
 390                 legacy: def.legacy,
 391             }),
 392             vis: ast::Visibility::Inherited,
 393             tokens: None,
 394         })
 395     }
 396
 397     fn item_body<'a, 'tcx>(&self,
 398                            tcx: TyCtxt<'a, 'tcx, 'tcx>,
 399                            def_id: DefId)
 400                            -> &'tcx hir::Body {
 401         self.read_dep_node(def_id);
 402
 403         if let Some(cached) = tcx.hir.get_inlined_body_untracked(def_id) {
 404             return cached;
 405         }
 406
 407         debug!("item_body({:?}): inlining item", def_id);
 408
 409         self.get_crate_data(def_id.krate).item_body(tcx, def_id.index)
 410     }
 411
 412     fn crates(&self) -> Vec<CrateNum>
 413     {
 414         let mut result = vec![];
 415         self.iter_crate_data(|cnum, _| result.push(cnum));
 416         result
 417     }
 418
 419     fn used_libraries(&self) -> Vec<NativeLibrary>
 420     {
 421         self.get_used_libraries().borrow().clone()
 422     }
 423
 424     fn used_link_args(&self) -> Vec<String>
 425     {
 426         self.get_used_link_args().borrow().clone()
 427     }
 428     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
 429     {
 430         self.do_get_used_crates(prefer)
 431     }
 432
 433     fn used_crate_source(&self, cnum: CrateNum) -> CrateSource
 434     {
 435         self.get_crate_data(cnum).source.clone()
 436     }
 437
 438     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>
 439     {
 440         self.do_extern_mod_stmt_cnum(emod_id)
 441     }
 442
 443     fn encode_metadata<'a, 'tcx>(&self,
 444                                  tcx: TyCtxt<'a, 'tcx, 'tcx>,
 445                                  link_meta: &LinkMeta,
 446                                  reachable: &NodeSet)
 447                                  -> (EncodedMetadata, EncodedMetadataHashes)
 448     {
 449         encoder::encode_metadata(tcx, link_meta, reachable)
 450     }
 451
 452     fn metadata_encoding_version(&self) -> &[u8]
 453     {
 454         schema::METADATA_HEADER
 455     }
 456
 457     /// Returns a map from a sufficiently visible external item (i.e. an external item that is
 458     /// visible from at least one local module) to a sufficiently visible parent (considering
 459     /// modules that re-export the external item to be parents).
 460     fn visible_parent_map<'a>(&'a self, sess: &Session) -> ::std::cell::Ref<'a, DefIdMap<DefId>> {
 461         {
 462             let visible_parent_map = self.visible_parent_map.borrow();
 463             if !visible_parent_map.is_empty() {
 464                 return visible_parent_map;
 465             }
 466         }
 467
 468         use std::collections::vec_deque::VecDeque;
 469         use std::collections::hash_map::Entry;
 470
 471         let mut visible_parent_map = self.visible_parent_map.borrow_mut();
 472
 473         for cnum in (1 .. self.next_crate_num().as_usize()).map(CrateNum::new) {
 474             let cdata = self.get_crate_data(cnum);
 475
 476             match cdata.extern_crate.get() {
 477                 // Ignore crates without a corresponding local `extern crate` item.
 478                 Some(extern_crate) if !extern_crate.direct => continue,
 479                 _ => {},
 480             }
 481
 482             let mut bfs_queue = &mut VecDeque::new();
 483             let mut add_child = |bfs_queue: &mut VecDeque<_>, child: def::Export, parent: DefId| {
 484                 let child = child.def.def_id();
 485
 486                 if self.visibility(child) != ty::Visibility::Public {
 487                     return;
 488                 }
 489
 490                 match visible_parent_map.entry(child) {
 491                     Entry::Occupied(mut entry) => {
 492                         // If `child` is defined in crate `cnum`, ensure
 493                         // that it is mapped to a parent in `cnum`.
 494                         if child.krate == cnum && entry.get().krate != cnum {
 495                             entry.insert(parent);
 496                         }
 497                     }
 498                     Entry::Vacant(entry) => {
 499                         entry.insert(parent);
 500                         bfs_queue.push_back(child);
 501                     }
 502                 }
 503             };
 504
 505             bfs_queue.push_back(DefId {
 506                 krate: cnum,
 507                 index: CRATE_DEF_INDEX
 508             });
 509             while let Some(def) = bfs_queue.pop_front() {
 510                 for child in self.item_children(def, sess) {
 511                     add_child(bfs_queue, child, def);
 512                 }
 513             }
 514         }
 515
 516         drop(visible_parent_map);
 517         self.visible_parent_map.borrow()
 518     }
 519 }