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