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