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