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