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