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::middle::cstore::{CrateStore, CrateSource, LibSource, DepKind, ExternCrate};
  17 use rustc::middle::cstore::{NativeLibrary, LinkMeta, LinkagePreference, LoadedMacro};
  18 use rustc::hir::def::{self, Def};
  19 use rustc::middle::lang_items;
  20 use rustc::session::Session;
  21 use rustc::ty::{self, Ty, TyCtxt};
  22 use rustc::hir::def_id::{CrateNum, DefId, DefIndex, CRATE_DEF_INDEX, LOCAL_CRATE};
  23
  24 use rustc::dep_graph::DepNode;
  25 use rustc::hir::map::{DefKey, DefPath, DisambiguatedDefPathData};
  26 use rustc::mir::Mir;
  27 use rustc::util::nodemap::{NodeSet, DefIdMap};
  28 use rustc_back::PanicStrategy;
  29
  30 use syntax::ast;
  31 use syntax::attr;
  32 use syntax::parse::new_parser_from_source_str;
  33 use syntax::symbol::Symbol;
  34 use syntax_pos::{mk_sp, Span};
  35 use rustc::hir::svh::Svh;
  36 use rustc_back::target::Target;
  37 use rustc::hir;
  38
  39 use std::collections::BTreeMap;
  40
  41 impl<'tcx> CrateStore<'tcx> for cstore::CStore {
  42     fn describe_def(&self, def: DefId) -> Option<Def> {
  43         self.dep_graph.read(DepNode::MetaData(def));
  44         self.get_crate_data(def.krate).get_def(def.index)
  45     }
  46
  47     fn def_span(&self, sess: &Session, def: DefId) -> Span {
  48         self.dep_graph.read(DepNode::MetaData(def));
  49         self.get_crate_data(def.krate).get_span(def.index, sess)
  50     }
  51
  52     fn stability(&self, def: DefId) -> Option<attr::Stability> {
  53         self.dep_graph.read(DepNode::MetaData(def));
  54         self.get_crate_data(def.krate).get_stability(def.index)
  55     }
  56
  57     fn deprecation(&self, def: DefId) -> Option<attr::Deprecation> {
  58         self.dep_graph.read(DepNode::MetaData(def));
  59         self.get_crate_data(def.krate).get_deprecation(def.index)
  60     }
  61
  62     fn visibility(&self, def: DefId) -> ty::Visibility {
  63         self.dep_graph.read(DepNode::MetaData(def));
  64         self.get_crate_data(def.krate).get_visibility(def.index)
  65     }
  66
  67     fn closure_kind(&self, def_id: DefId) -> ty::ClosureKind
  68     {
  69         assert!(!def_id.is_local());
  70         self.dep_graph.read(DepNode::MetaData(def_id));
  71         self.get_crate_data(def_id.krate).closure_kind(def_id.index)
  72     }
  73
  74     fn closure_ty<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> ty::ClosureTy<'tcx> {
  75         assert!(!def_id.is_local());
  76         self.dep_graph.read(DepNode::MetaData(def_id));
  77         self.get_crate_data(def_id.krate).closure_ty(def_id.index, tcx)
  78     }
  79
  80     fn item_variances(&self, def: DefId) -> Vec<ty::Variance> {
  81         self.dep_graph.read(DepNode::MetaData(def));
  82         self.get_crate_data(def.krate).get_item_variances(def.index)
  83     }
  84
  85     fn item_type<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
  86                      -> Ty<'tcx>
  87     {
  88         self.dep_graph.read(DepNode::MetaData(def));
  89         self.get_crate_data(def.krate).get_type(def.index, tcx)
  90     }
  91
  92     fn item_predicates<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
  93                            -> ty::GenericPredicates<'tcx>
  94     {
  95         self.dep_graph.read(DepNode::MetaData(def));
  96         self.get_crate_data(def.krate).get_predicates(def.index, tcx)
  97     }
  98
  99     fn item_super_predicates<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
 100                                  -> ty::GenericPredicates<'tcx>
 101     {
 102         self.dep_graph.read(DepNode::MetaData(def));
 103         self.get_crate_data(def.krate).get_super_predicates(def.index, tcx)
 104     }
 105
 106     fn item_generics<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
 107                          -> ty::Generics<'tcx>
 108     {
 109         self.dep_graph.read(DepNode::MetaData(def));
 110         self.get_crate_data(def.krate).get_generics(def.index, tcx)
 111     }
 112
 113     fn item_attrs(&self, def_id: DefId) -> Vec<ast::Attribute>
 114     {
 115         self.dep_graph.read(DepNode::MetaData(def_id));
 116         self.get_crate_data(def_id.krate).get_item_attrs(def_id.index)
 117     }
 118
 119     fn trait_def<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> ty::TraitDef
 120     {
 121         self.dep_graph.read(DepNode::MetaData(def));
 122         self.get_crate_data(def.krate).get_trait_def(def.index, tcx)
 123     }
 124
 125     fn adt_def<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> &'tcx ty::AdtDef
 126     {
 127         self.dep_graph.read(DepNode::MetaData(def));
 128         self.get_crate_data(def.krate).get_adt_def(def.index, tcx)
 129     }
 130
 131     fn fn_arg_names(&self, did: DefId) -> Vec<ast::Name>
 132     {
 133         // FIXME(#38501) We've skipped a `read` on the `HirBody` of
 134         // a `fn` when encoding, so the dep-tracking wouldn't work.
 135         // This is only used by rustdoc anyway, which shouldn't have
 136         // incremental recompilation ever enabled.
 137         assert!(!self.dep_graph.is_fully_enabled());
 138         self.get_crate_data(did.krate).get_fn_arg_names(did.index)
 139     }
 140
 141     fn inherent_implementations_for_type(&self, def_id: DefId) -> Vec<DefId>
 142     {
 143         self.dep_graph.read(DepNode::MetaData(def_id));
 144         self.get_crate_data(def_id.krate).get_inherent_implementations_for_type(def_id.index)
 145     }
 146
 147     fn implementations_of_trait(&self, filter: Option<DefId>) -> Vec<DefId>
 148     {
 149         if let Some(def_id) = filter {
 150             self.dep_graph.read(DepNode::MetaData(def_id));
 151         }
 152         let mut result = vec![];
 153         self.iter_crate_data(|_, cdata| {
 154             cdata.get_implementations_for_trait(filter, &mut result)
 155         });
 156         result
 157     }
 158
 159     fn associated_item_def_ids(&self, def_id: DefId) -> Vec<DefId> {
 160         self.dep_graph.read(DepNode::MetaData(def_id));
 161         let mut result = vec![];
 162         self.get_crate_data(def_id.krate)
 163             .each_child_of_item(def_id.index, |child| result.push(child.def.def_id()));
 164         result
 165     }
 166
 167     fn impl_polarity(&self, def: DefId) -> hir::ImplPolarity
 168     {
 169         self.dep_graph.read(DepNode::MetaData(def));
 170         self.get_crate_data(def.krate).get_impl_polarity(def.index)
 171     }
 172
 173     fn impl_trait_ref<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId)
 174                           -> Option<ty::TraitRef<'tcx>>
 175     {
 176         self.dep_graph.read(DepNode::MetaData(def));
 177         self.get_crate_data(def.krate).get_impl_trait(def.index, tcx)
 178     }
 179
 180     fn custom_coerce_unsized_kind(&self, def: DefId)
 181                                   -> Option<ty::adjustment::CustomCoerceUnsized>
 182     {
 183         self.dep_graph.read(DepNode::MetaData(def));
 184         self.get_crate_data(def.krate).get_custom_coerce_unsized_kind(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(&self, def: DefId) -> Option<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_defaulted_trait(&self, trait_def_id: DefId) -> bool
 210     {
 211         self.dep_graph.read(DepNode::MetaData(trait_def_id));
 212         self.get_crate_data(trait_def_id.krate).is_defaulted_trait(trait_def_id.index)
 213     }
 214
 215     fn is_default_impl(&self, impl_did: DefId) -> bool {
 216         self.dep_graph.read(DepNode::MetaData(impl_did));
 217         self.get_crate_data(impl_did.krate).is_default_impl(impl_did.index)
 218     }
 219
 220     fn is_foreign_item(&self, did: DefId) -> bool {
 221         self.get_crate_data(did.krate).is_foreign_item(did.index)
 222     }
 223
 224     fn is_statically_included_foreign_item(&self, def_id: DefId) -> bool
 225     {
 226         self.do_is_statically_included_foreign_item(def_id)
 227     }
 228
 229     fn is_exported_symbol(&self, def_id: DefId) -> bool {
 230         self.get_crate_data(def_id.krate).exported_symbols.contains(&def_id.index)
 231     }
 232
 233     fn is_dllimport_foreign_item(&self, def_id: DefId) -> bool {
 234         if def_id.krate == LOCAL_CRATE {
 235             self.dllimport_foreign_items.borrow().contains(&def_id.index)
 236         } else {
 237             self.get_crate_data(def_id.krate).is_dllimport_foreign_item(def_id.index)
 238         }
 239     }
 240
 241     fn dylib_dependency_formats(&self, cnum: CrateNum)
 242                                 -> Vec<(CrateNum, LinkagePreference)>
 243     {
 244         self.get_crate_data(cnum).get_dylib_dependency_formats()
 245     }
 246
 247     fn dep_kind(&self, cnum: CrateNum) -> DepKind
 248     {
 249         self.get_crate_data(cnum).dep_kind.get()
 250     }
 251
 252     fn export_macros(&self, cnum: CrateNum) {
 253         if self.get_crate_data(cnum).dep_kind.get() == DepKind::UnexportedMacrosOnly {
 254             self.get_crate_data(cnum).dep_kind.set(DepKind::MacrosOnly)
 255         }
 256     }
 257
 258     fn lang_items(&self, cnum: CrateNum) -> Vec<(DefIndex, usize)>
 259     {
 260         self.get_crate_data(cnum).get_lang_items()
 261     }
 262
 263     fn missing_lang_items(&self, cnum: CrateNum)
 264                           -> Vec<lang_items::LangItem>
 265     {
 266         self.get_crate_data(cnum).get_missing_lang_items()
 267     }
 268
 269     fn is_staged_api(&self, cnum: CrateNum) -> bool
 270     {
 271         self.get_crate_data(cnum).is_staged_api()
 272     }
 273
 274     fn is_allocator(&self, cnum: CrateNum) -> bool
 275     {
 276         self.get_crate_data(cnum).is_allocator()
 277     }
 278
 279     fn is_panic_runtime(&self, cnum: CrateNum) -> bool
 280     {
 281         self.get_crate_data(cnum).is_panic_runtime()
 282     }
 283
 284     fn is_compiler_builtins(&self, cnum: CrateNum) -> bool {
 285         self.get_crate_data(cnum).is_compiler_builtins()
 286     }
 287
 288     fn panic_strategy(&self, cnum: CrateNum) -> PanicStrategy {
 289         self.get_crate_data(cnum).panic_strategy()
 290     }
 291
 292     fn crate_name(&self, cnum: CrateNum) -> Symbol
 293     {
 294         self.get_crate_data(cnum).name
 295     }
 296
 297     fn original_crate_name(&self, cnum: CrateNum) -> Symbol
 298     {
 299         self.get_crate_data(cnum).name()
 300     }
 301
 302     fn extern_crate(&self, cnum: CrateNum) -> Option<ExternCrate>
 303     {
 304         self.get_crate_data(cnum).extern_crate.get()
 305     }
 306
 307     fn crate_hash(&self, cnum: CrateNum) -> Svh
 308     {
 309         self.get_crate_hash(cnum)
 310     }
 311
 312     fn crate_disambiguator(&self, cnum: CrateNum) -> Symbol
 313     {
 314         self.get_crate_data(cnum).disambiguator()
 315     }
 316
 317     fn plugin_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 318     {
 319         self.get_crate_data(cnum).root.plugin_registrar_fn.map(|index| DefId {
 320             krate: cnum,
 321             index: index
 322         })
 323     }
 324
 325     fn derive_registrar_fn(&self, cnum: CrateNum) -> Option<DefId>
 326     {
 327         self.get_crate_data(cnum).root.macro_derive_registrar.map(|index| DefId {
 328             krate: cnum,
 329             index: index
 330         })
 331     }
 332
 333     fn native_libraries(&self, cnum: CrateNum) -> Vec<NativeLibrary>
 334     {
 335         self.get_crate_data(cnum).get_native_libraries()
 336     }
 337
 338     fn exported_symbols(&self, cnum: CrateNum) -> Vec<DefId>
 339     {
 340         self.get_crate_data(cnum).get_exported_symbols()
 341     }
 342
 343     fn is_no_builtins(&self, cnum: CrateNum) -> bool {
 344         self.get_crate_data(cnum).is_no_builtins()
 345     }
 346
 347     fn retrace_path(&self,
 348                     cnum: CrateNum,
 349                     path: &[DisambiguatedDefPathData])
 350                     -> Option<DefId> {
 351         let cdata = self.get_crate_data(cnum);
 352         cdata.def_path_table
 353              .retrace_path(&path)
 354              .map(|index| DefId { krate: cnum, index: index })
 355     }
 356
 357     /// Returns the `DefKey` for a given `DefId`. This indicates the
 358     /// parent `DefId` as well as some idea of what kind of data the
 359     /// `DefId` refers to.
 360     fn def_key(&self, def: DefId) -> DefKey {
 361         // Note: loading the def-key (or def-path) for a def-id is not
 362         // a *read* of its metadata. This is because the def-id is
 363         // really just an interned shorthand for a def-path, which is the
 364         // canonical name for an item.
 365         //
 366         // self.dep_graph.read(DepNode::MetaData(def));
 367         self.get_crate_data(def.krate).def_key(def.index)
 368     }
 369
 370     fn def_path(&self, def: DefId) -> DefPath {
 371         // See `Note` above in `def_key()` for why this read is
 372         // commented out:
 373         //
 374         // self.dep_graph.read(DepNode::MetaData(def));
 375         self.get_crate_data(def.krate).def_path(def.index)
 376     }
 377
 378     fn struct_field_names(&self, def: DefId) -> Vec<ast::Name>
 379     {
 380         self.dep_graph.read(DepNode::MetaData(def));
 381         self.get_crate_data(def.krate).get_struct_field_names(def.index)
 382     }
 383
 384     fn item_children(&self, def_id: DefId) -> Vec<def::Export>
 385     {
 386         self.dep_graph.read(DepNode::MetaData(def_id));
 387         let mut result = vec![];
 388         self.get_crate_data(def_id.krate)
 389             .each_child_of_item(def_id.index, |child| result.push(child));
 390         result
 391     }
 392
 393     fn load_macro(&self, id: DefId, sess: &Session) -> LoadedMacro {
 394         let data = self.get_crate_data(id.krate);
 395         if let Some(ref proc_macros) = data.proc_macros {
 396             return LoadedMacro::ProcMacro(proc_macros[id.index.as_usize() - 1].1.clone());
 397         }
 398
 399         let (name, def) = data.get_macro(id.index);
 400         let source_name = format!("<{} macros>", name);
 401
 402         // NB: Don't use parse_tts_from_source_str because it parses with quote_depth > 0.
 403         let mut parser = new_parser_from_source_str(&sess.parse_sess, source_name, def.body);
 404
 405         let lo = parser.span.lo;
 406         let body = match parser.parse_all_token_trees() {
 407             Ok(body) => body,
 408             Err(mut err) => {
 409                 err.emit();
 410                 sess.abort_if_errors();
 411                 unreachable!();
 412             }
 413         };
 414         let local_span = mk_sp(lo, parser.prev_span.hi);
 415
 416         // Mark the attrs as used
 417         let attrs = data.get_item_attrs(id.index);
 418         for attr in &attrs {
 419             attr::mark_used(attr);
 420         }
 421
 422         let name = data.def_key(id.index).disambiguated_data.data
 423             .get_opt_name().expect("no name in load_macro");
 424         sess.imported_macro_spans.borrow_mut()
 425             .insert(local_span, (name.to_string(), data.get_span(id.index, sess)));
 426
 427         LoadedMacro::MacroRules(ast::MacroDef {
 428             ident: ast::Ident::with_empty_ctxt(name),
 429             id: ast::DUMMY_NODE_ID,
 430             span: local_span,
 431             attrs: attrs,
 432             body: body,
 433         })
 434     }
 435
 436     fn maybe_get_item_body<'a>(&'tcx self,
 437                                tcx: TyCtxt<'a, 'tcx, 'tcx>,
 438                                def_id: DefId)
 439                                -> Option<&'tcx hir::Body>
 440     {
 441         if let Some(cached) = tcx.map.get_inlined_body(def_id) {
 442             return Some(cached);
 443         }
 444
 445         self.dep_graph.read(DepNode::MetaData(def_id));
 446         debug!("maybe_get_item_body({}): inlining item", tcx.item_path_str(def_id));
 447
 448         self.get_crate_data(def_id.krate).maybe_get_item_body(tcx, def_id.index)
 449     }
 450
 451     fn item_body_nested_bodies(&self, def: DefId) -> BTreeMap<hir::BodyId, hir::Body> {
 452         self.dep_graph.read(DepNode::MetaData(def));
 453         self.get_crate_data(def.krate).item_body_nested_bodies(def.index)
 454     }
 455
 456     fn const_is_rvalue_promotable_to_static(&self, def: DefId) -> bool {
 457         self.dep_graph.read(DepNode::MetaData(def));
 458         self.get_crate_data(def.krate).const_is_rvalue_promotable_to_static(def.index)
 459     }
 460
 461     fn get_item_mir<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, def: DefId) -> Mir<'tcx> {
 462         self.dep_graph.read(DepNode::MetaData(def));
 463         self.get_crate_data(def.krate).maybe_get_item_mir(tcx, def.index).unwrap_or_else(|| {
 464             bug!("get_item_mir: missing MIR for {}", tcx.item_path_str(def))
 465         })
 466     }
 467
 468     fn is_item_mir_available(&self, def: DefId) -> bool {
 469         self.dep_graph.read(DepNode::MetaData(def));
 470         self.get_crate_data(def.krate).is_item_mir_available(def.index)
 471     }
 472
 473     fn crates(&self) -> Vec<CrateNum>
 474     {
 475         let mut result = vec![];
 476         self.iter_crate_data(|cnum, _| result.push(cnum));
 477         result
 478     }
 479
 480     fn used_libraries(&self) -> Vec<NativeLibrary>
 481     {
 482         self.get_used_libraries().borrow().clone()
 483     }
 484
 485     fn used_link_args(&self) -> Vec<String>
 486     {
 487         self.get_used_link_args().borrow().clone()
 488     }
 489
 490     fn metadata_filename(&self) -> &str
 491     {
 492         locator::METADATA_FILENAME
 493     }
 494
 495     fn metadata_section_name(&self, target: &Target) -> &str
 496     {
 497         locator::meta_section_name(target)
 498     }
 499
 500     fn used_crates(&self, prefer: LinkagePreference) -> Vec<(CrateNum, LibSource)>
 501     {
 502         self.do_get_used_crates(prefer)
 503     }
 504
 505     fn used_crate_source(&self, cnum: CrateNum) -> CrateSource
 506     {
 507         self.get_crate_data(cnum).source.clone()
 508     }
 509
 510     fn extern_mod_stmt_cnum(&self, emod_id: ast::NodeId) -> Option<CrateNum>
 511     {
 512         self.do_extern_mod_stmt_cnum(emod_id)
 513     }
 514
 515     fn encode_metadata<'a>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>,
 516                            reexports: &def::ExportMap,
 517                            link_meta: &LinkMeta,
 518                            reachable: &NodeSet) -> Vec<u8>
 519     {
 520         encoder::encode_metadata(tcx, self, reexports, link_meta, reachable)
 521     }
 522
 523     fn metadata_encoding_version(&self) -> &[u8]
 524     {
 525         schema::METADATA_HEADER
 526     }
 527
 528     /// Returns a map from a sufficiently visible external item (i.e. an external item that is
 529     /// visible from at least one local module) to a sufficiently visible parent (considering
 530     /// modules that re-export the external item to be parents).
 531     fn visible_parent_map<'a>(&'a self) -> ::std::cell::RefMut<'a, DefIdMap<DefId>> {
 532         let mut visible_parent_map = self.visible_parent_map.borrow_mut();
 533         if !visible_parent_map.is_empty() { return visible_parent_map; }
 534
 535         use std::collections::vec_deque::VecDeque;
 536         use std::collections::hash_map::Entry;
 537         for cnum in (1 .. self.next_crate_num().as_usize()).map(CrateNum::new) {
 538             let cdata = self.get_crate_data(cnum);
 539
 540             match cdata.extern_crate.get() {
 541                 // Ignore crates without a corresponding local `extern crate` item.
 542                 Some(extern_crate) if !extern_crate.direct => continue,
 543                 _ => {},
 544             }
 545
 546             let mut bfs_queue = &mut VecDeque::new();
 547             let mut add_child = |bfs_queue: &mut VecDeque<_>, child: def::Export, parent: DefId| {
 548                 let child = child.def.def_id();
 549
 550                 if self.visibility(child) != ty::Visibility::Public {
 551                     return;
 552                 }
 553
 554                 match visible_parent_map.entry(child) {
 555                     Entry::Occupied(mut entry) => {
 556                         // If `child` is defined in crate `cnum`, ensure
 557                         // that it is mapped to a parent in `cnum`.
 558                         if child.krate == cnum && entry.get().krate != cnum {
 559                             entry.insert(parent);
 560                         }
 561                     }
 562                     Entry::Vacant(entry) => {
 563                         entry.insert(parent);
 564                         bfs_queue.push_back(child);
 565                     }
 566                 }
 567             };
 568
 569             bfs_queue.push_back(DefId {
 570                 krate: cnum,
 571                 index: CRATE_DEF_INDEX
 572             });
 573             while let Some(def) = bfs_queue.pop_front() {
 574                 for child in self.item_children(def) {
 575                     add_child(bfs_queue, child, def);
 576                 }
 577             }
 578         }
 579
 580         visible_parent_map
 581     }
 582 }