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 link_args;
  14 use native_libs;
  15 use schema;
  16
  17 use rustc::ty::maps::QueryConfig;
  18 use rustc::middle::cstore::{CrateStore, DepKind,
  19                             MetadataLoader, LinkMeta,
  20                             LoadedMacro, EncodedMetadata,
  21                             EncodedMetadataHashes, NativeLibraryKind};
  22 use rustc::middle::stability::DeprecationEntry;
  23 use rustc::hir::def;
  24 use rustc::session::Session;
  25 use rustc::ty::{self, TyCtxt};
  26 use rustc::ty::maps::Providers;
  27 use rustc::hir::def_id::{CrateNum, DefId, LOCAL_CRATE, CRATE_DEF_INDEX};
  28 use rustc::hir::map::{DefKey, DefPath, DefPathHash};
  29 use rustc::hir::map::blocks::FnLikeNode;
  30 use rustc::hir::map::definitions::{DefPathTable, GlobalMetaDataKind};
  31 use rustc::util::nodemap::{NodeSet, DefIdMap};
  32
  33 use std::any::Any;
  34 use std::rc::Rc;
  35
  36 use syntax::ast;
  37 use syntax::attr;
  38 use syntax::ext::base::SyntaxExtension;
  39 use syntax::parse::filemap_to_stream;
  40 use syntax::symbol::Symbol;
  41 use syntax_pos::{Span, NO_EXPANSION};
  42 use rustc_data_structures::indexed_set::IdxSetBuf;
  43 use rustc::hir;
  44
  45 macro_rules! provide {
  46     (<$lt:tt> $tcx:ident, $def_id:ident, $other:ident, $cdata:ident,
  47       $($name:ident => $compute:block)*) => {
  48         pub fn provide<$lt>(providers: &mut Providers<$lt>) {
  49             $(fn $name<'a, $lt:$lt, T>($tcx: TyCtxt<'a, $lt, $lt>, def_id_arg: T)
  50                                     -> <ty::queries::$name<$lt> as
  51                                         QueryConfig>::Value
  52                 where T: IntoArgs,
  53             {
  54                 #[allow(unused_variables)]
  55                 let ($def_id, $other) = def_id_arg.into_args();
  56                 assert!(!$def_id.is_local());
  57
  58                 let def_path_hash = $tcx.def_path_hash($def_id);
  59                 let dep_node = def_path_hash.to_dep_node(::rustc::dep_graph::DepKind::MetaData);
  60
  61                 $tcx.dep_graph.read(dep_node);
  62
  63                 let $cdata = $tcx.sess.cstore.crate_data_as_rc_any($def_id.krate);
  64                 let $cdata = $cdata.downcast_ref::<cstore::CrateMetadata>()
  65                     .expect("CrateStore crated ata is not a CrateMetadata");
  66                 $compute
  67             })*
  68
  69             *providers = Providers {
  70                 $($name,)*
  71                 ..*providers
  72             };
  73         }
  74     }
  75 }
  76
  77 // small trait to work around different signature queries all being defined via
  78 // the macro above.
  79 trait IntoArgs {
  80     fn into_args(self) -> (DefId, DefId);
  81 }
  82
  83 impl IntoArgs for DefId {
  84     fn into_args(self) -> (DefId, DefId) { (self, self) }
  85 }
  86
  87 impl IntoArgs for CrateNum {
  88     fn into_args(self) -> (DefId, DefId) { (self.as_def_id(), self.as_def_id()) }
  89 }
  90
  91 impl IntoArgs for (CrateNum, DefId) {
  92     fn into_args(self) -> (DefId, DefId) { (self.0.as_def_id(), self.1) }
  93 }
  94
  95 provide! { <'tcx> tcx, def_id, other, cdata,
  96     type_of => { cdata.get_type(def_id.index, tcx) }
  97     generics_of => { tcx.alloc_generics(cdata.get_generics(def_id.index)) }
  98     predicates_of => { cdata.get_predicates(def_id.index, tcx) }
  99     super_predicates_of => { cdata.get_super_predicates(def_id.index, tcx) }
 100     trait_def => {
 101         tcx.alloc_trait_def(cdata.get_trait_def(def_id.index))
 102     }
 103     adt_def => { cdata.get_adt_def(def_id.index, tcx) }
 104     adt_destructor => {
 105         let _ = cdata;
 106         tcx.calculate_dtor(def_id, &mut |_,_| Ok(()))
 107     }
 108     variances_of => { Rc::new(cdata.get_item_variances(def_id.index)) }
 109     associated_item_def_ids => {
 110         let mut result = vec![];
 111         cdata.each_child_of_item(def_id.index,
 112           |child| result.push(child.def.def_id()), tcx.sess);
 113         Rc::new(result)
 114     }
 115     associated_item => { cdata.get_associated_item(def_id.index) }
 116     impl_trait_ref => { cdata.get_impl_trait(def_id.index, tcx) }
 117     impl_polarity => { cdata.get_impl_polarity(def_id.index) }
 118     coerce_unsized_info => {
 119         cdata.get_coerce_unsized_info(def_id.index).unwrap_or_else(|| {
 120             bug!("coerce_unsized_info: `{:?}` is missing its info", def_id);
 121         })
 122     }
 123     optimized_mir => {
 124         let mir = cdata.maybe_get_optimized_mir(tcx, def_id.index).unwrap_or_else(|| {
 125             bug!("get_optimized_mir: missing MIR for `{:?}`", def_id)
 126         });
 127
 128         let mir = tcx.alloc_mir(mir);
 129
 130         mir
 131     }
 132     generator_sig => { cdata.generator_sig(def_id.index, tcx) }
 133     mir_const_qualif => {
 134         (cdata.mir_const_qualif(def_id.index), Rc::new(IdxSetBuf::new_empty(0)))
 135     }
 136     typeck_tables_of => { cdata.item_body_tables(def_id.index, tcx) }
 137     closure_kind => { cdata.closure_kind(def_id.index) }
 138     fn_sig => { cdata.fn_sig(def_id.index, tcx) }
 139     inherent_impls => { Rc::new(cdata.get_inherent_implementations_for_type(def_id.index)) }
 140     is_const_fn => { cdata.is_const_fn(def_id.index) }
 141     is_foreign_item => { cdata.is_foreign_item(def_id.index) }
 142     is_default_impl => { cdata.is_default_impl(def_id.index) }
 143     describe_def => { cdata.get_def(def_id.index) }
 144     def_span => { cdata.get_span(def_id.index, &tcx.sess) }
 145     lookup_stability => {
 146         cdata.get_stability(def_id.index).map(|s| tcx.intern_stability(s))
 147     }
 148     lookup_deprecation_entry => {
 149         cdata.get_deprecation(def_id.index).map(DeprecationEntry::external)
 150     }
 151     item_attrs => { cdata.get_item_attrs(def_id.index, &tcx.dep_graph) }
 152     // FIXME(#38501) We've skipped a `read` on the `HirBody` of
 153     // a `fn` when encoding, so the dep-tracking wouldn't work.
 154     // This is only used by rustdoc anyway, which shouldn't have
 155     // incremental recompilation ever enabled.
 156     fn_arg_names => { cdata.get_fn_arg_names(def_id.index) }
 157     impl_parent => { cdata.get_parent_impl(def_id.index) }
 158     trait_of_item => { cdata.get_trait_of_item(def_id.index) }
 159     is_exported_symbol => {
 160         let dep_node = cdata.metadata_dep_node(GlobalMetaDataKind::ExportedSymbols);
 161         cdata.exported_symbols.get(&tcx.dep_graph, dep_node).contains(&def_id.index)
 162     }
 163     item_body_nested_bodies => { Rc::new(cdata.item_body_nested_bodies(def_id.index)) }
 164     const_is_rvalue_promotable_to_static => {
 165         cdata.const_is_rvalue_promotable_to_static(def_id.index)
 166     }
 167     is_mir_available => { cdata.is_item_mir_available(def_id.index) }
 168
 169     dylib_dependency_formats => { Rc::new(cdata.get_dylib_dependency_formats(&tcx.dep_graph)) }
 170     is_panic_runtime => { cdata.is_panic_runtime(&tcx.dep_graph) }
 171     is_compiler_builtins => { cdata.is_compiler_builtins(&tcx.dep_graph) }
 172     has_global_allocator => { cdata.has_global_allocator(&tcx.dep_graph) }
 173     is_sanitizer_runtime => { cdata.is_sanitizer_runtime(&tcx.dep_graph) }
 174     is_profiler_runtime => { cdata.is_profiler_runtime(&tcx.dep_graph) }
 175     panic_strategy => { cdata.panic_strategy(&tcx.dep_graph) }
 176     extern_crate => { Rc::new(cdata.extern_crate.get()) }
 177     is_no_builtins => { cdata.is_no_builtins(&tcx.dep_graph) }
 178     impl_defaultness => { cdata.get_impl_defaultness(def_id.index) }
 179     exported_symbols => { Rc::new(cdata.get_exported_symbols(&tcx.dep_graph)) }
 180     native_libraries => { Rc::new(cdata.get_native_libraries(&tcx.dep_graph)) }
 181     plugin_registrar_fn => {
 182         cdata.root.plugin_registrar_fn.map(|index| {
 183             DefId { krate: def_id.krate, index }
 184         })
 185     }
 186     derive_registrar_fn => {
 187         cdata.root.macro_derive_registrar.map(|index| {
 188             DefId { krate: def_id.krate, index }
 189         })
 190     }
 191     crate_disambiguator => { cdata.disambiguator() }
 192     crate_hash => { cdata.hash() }
 193     original_crate_name => { cdata.name() }
 194
 195     implementations_of_trait => {
 196         let mut result = vec![];
 197         let filter = Some(other);
 198         cdata.get_implementations_for_trait(filter, &tcx.dep_graph, &mut result);
 199         Rc::new(result)
 200     }
 201
 202     all_trait_implementations => {
 203         let mut result = vec![];
 204         cdata.get_implementations_for_trait(None, &tcx.dep_graph, &mut result);
 205         Rc::new(result)
 206     }
 207
 208     is_dllimport_foreign_item => {
 209         cdata.is_dllimport_foreign_item(def_id.index, &tcx.dep_graph)
 210     }
 211     visibility => { cdata.get_visibility(def_id.index) }
 212     dep_kind => { cdata.dep_kind.get() }
 213     crate_name => { cdata.name }
 214     item_children => {
 215         let mut result = vec![];
 216         cdata.each_child_of_item(def_id.index, |child| result.push(child), tcx.sess);
 217         Rc::new(result)
 218     }
 219     defined_lang_items => { Rc::new(cdata.get_lang_items(&tcx.dep_graph)) }
 220     missing_lang_items => { Rc::new(cdata.get_missing_lang_items(&tcx.dep_graph)) }
 221
 222     extern_const_body => {
 223         debug!("item_body({:?}): inlining item", def_id);
 224         cdata.extern_const_body(tcx, def_id.index)
 225     }
 226
 227     missing_extern_crate_item => {
 228         match cdata.extern_crate.get() {
 229             Some(extern_crate) if !extern_crate.direct => true,
 230             _ => false,
 231         }
 232     }
 233
 234     used_crate_source => { Rc::new(cdata.source.clone()) }
 235 }
 236
 237 pub fn provide_local<'tcx>(providers: &mut Providers<'tcx>) {
 238     fn is_const_fn<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> bool {
 239         let node_id = tcx.hir.as_local_node_id(def_id)
 240                              .expect("Non-local call to local provider is_const_fn");
 241
 242         if let Some(fn_like) = FnLikeNode::from_node(tcx.hir.get(node_id)) {
 243             fn_like.constness() == hir::Constness::Const
 244         } else {
 245             false
 246         }
 247     }
 248
 249     // FIXME(#44234) - almost all of these queries have no sub-queries and
 250     // therefore no actual inputs, they're just reading tables calculated in
 251     // resolve! Does this work? Unsure! That's what the issue is about
 252     *providers = Providers {
 253         is_const_fn,
 254         is_dllimport_foreign_item: |tcx, id| {
 255             tcx.native_library_kind(id) == Some(NativeLibraryKind::NativeUnknown)
 256         },
 257         is_statically_included_foreign_item: |tcx, id| {
 258             match tcx.native_library_kind(id) {
 259                 Some(NativeLibraryKind::NativeStatic) |
 260                 Some(NativeLibraryKind::NativeStaticNobundle) => true,
 261                 _ => false,
 262             }
 263         },
 264         native_library_kind: |tcx, id| {
 265             tcx.native_libraries(id.krate)
 266                 .iter()
 267                 .filter(|lib| native_libs::relevant_lib(&tcx.sess, lib))
 268                 .find(|l| l.foreign_items.contains(&id.index))
 269                 .map(|l| l.kind)
 270         },
 271         native_libraries: |tcx, cnum| {
 272             assert_eq!(cnum, LOCAL_CRATE);
 273             Rc::new(native_libs::collect(tcx))
 274         },
 275         link_args: |tcx, cnum| {
 276             assert_eq!(cnum, LOCAL_CRATE);
 277             Rc::new(link_args::collect(tcx))
 278         },
 279         extern_mod_stmt_cnum: |tcx, id| {
 280             let id = tcx.hir.definitions().find_node_for_hir_id(id);
 281             tcx.sess.cstore.extern_mod_stmt_cnum_untracked(id)
 282         },
 283
 284         // Returns a map from a sufficiently visible external item (i.e. an
 285         // external item that is visible from at least one local module) to a
 286         // sufficiently visible parent (considering modules that re-export the
 287         // external item to be parents).
 288         visible_parent_map: |tcx, cnum| {
 289             use std::collections::vec_deque::VecDeque;
 290             use std::collections::hash_map::Entry;
 291
 292             assert_eq!(cnum, LOCAL_CRATE);
 293             let mut visible_parent_map: DefIdMap<DefId> = DefIdMap();
 294
 295             for cnum in tcx.sess.cstore.crates() {
 296                 // Ignore crates without a corresponding local `extern crate` item.
 297                 if tcx.missing_extern_crate_item(cnum) {
 298                     continue
 299                 }
 300
 301                 let bfs_queue = &mut VecDeque::new();
 302                 let visible_parent_map = &mut visible_parent_map;
 303                 let mut add_child = |bfs_queue: &mut VecDeque<_>,
 304                                      child: &def::Export,
 305                                      parent: DefId| {
 306                     let child = child.def.def_id();
 307
 308                     if tcx.visibility(child) != ty::Visibility::Public {
 309                         return;
 310                     }
 311
 312                     match visible_parent_map.entry(child) {
 313                         Entry::Occupied(mut entry) => {
 314                             // If `child` is defined in crate `cnum`, ensure
 315                             // that it is mapped to a parent in `cnum`.
 316                             if child.krate == cnum && entry.get().krate != cnum {
 317                                 entry.insert(parent);
 318                             }
 319                         }
 320                         Entry::Vacant(entry) => {
 321                             entry.insert(parent);
 322                             bfs_queue.push_back(child);
 323                         }
 324                     }
 325                 };
 326
 327                 bfs_queue.push_back(DefId {
 328                     krate: cnum,
 329                     index: CRATE_DEF_INDEX
 330                 });
 331                 while let Some(def) = bfs_queue.pop_front() {
 332                     for child in tcx.item_children(def).iter() {
 333                         add_child(bfs_queue, child, def);
 334                     }
 335                 }
 336             }
 337
 338             Rc::new(visible_parent_map)
 339         },
 340
 341         postorder_cnums: |tcx, cnum| {
 342             assert_eq!(cnum, LOCAL_CRATE);
 343             Rc::new(tcx.sess.cstore.postorder_cnums_untracked())
 344         },
 345
 346         ..*providers
 347     };
 348 }
 349
 350 impl CrateStore for cstore::CStore {
 351     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Rc<Any> {
 352         self.get_crate_data(krate)
 353     }
 354
 355     fn metadata_loader(&self) -> &MetadataLoader {
 356         &*self.metadata_loader
 357     }
 358
 359     fn visibility_untracked(&self, def: DefId) -> ty::Visibility {
 360         self.read_dep_node(def);
 361         self.get_crate_data(def.krate).get_visibility(def.index)
 362     }
 363
 364     fn item_generics_cloned_untracked(&self, def: DefId) -> ty::Generics {
 365         self.read_dep_node(def);
 366         self.get_crate_data(def.krate).get_generics(def.index)
 367     }
 368
 369     fn associated_item_cloned_untracked(&self, def: DefId) -> ty::AssociatedItem
 370     {
 371         self.read_dep_node(def);
 372         self.get_crate_data(def.krate).get_associated_item(def.index)
 373     }
 374
 375     fn dep_kind_untracked(&self, cnum: CrateNum) -> DepKind
 376     {
 377         let data = self.get_crate_data(cnum);
 378         let dep_node = data.metadata_dep_node(GlobalMetaDataKind::CrateDeps);
 379         self.dep_graph.read(dep_node);
 380         data.dep_kind.get()
 381     }
 382
 383     fn export_macros_untracked(&self, cnum: CrateNum) {
 384         let data = self.get_crate_data(cnum);
 385         let dep_node = data.metadata_dep_node(GlobalMetaDataKind::CrateDeps);
 386
 387         self.dep_graph.read(dep_node);
 388         if data.dep_kind.get() == DepKind::UnexportedMacrosOnly {
 389             data.dep_kind.set(DepKind::MacrosOnly)
 390         }
 391     }
 392
 393     fn crate_name_untracked(&self, cnum: CrateNum) -> Symbol
 394     {
 395         self.get_crate_data(cnum).name
 396     }
 397
 398     /// Returns the `DefKey` for a given `DefId`. This indicates the
 399     /// parent `DefId` as well as some idea of what kind of data the
 400     /// `DefId` refers to.
 401     fn def_key(&self, def: DefId) -> DefKey {
 402         // Note: loading the def-key (or def-path) for a def-id is not
 403         // a *read* of its metadata. This is because the def-id is
 404         // really just an interned shorthand for a def-path, which is the
 405         // canonical name for an item.
 406         //
 407         // self.dep_graph.read(DepNode::MetaData(def));
 408         self.get_crate_data(def.krate).def_key(def.index)
 409     }
 410
 411     fn def_path(&self, def: DefId) -> DefPath {
 412         // See `Note` above in `def_key()` for why this read is
 413         // commented out:
 414         //
 415         // self.dep_graph.read(DepNode::MetaData(def));
 416         self.get_crate_data(def.krate).def_path(def.index)
 417     }
 418
 419     fn def_path_hash(&self, def: DefId) -> DefPathHash {
 420         self.get_crate_data(def.krate).def_path_hash(def.index)
 421     }
 422
 423     fn def_path_table(&self, cnum: CrateNum) -> Rc<DefPathTable> {
 424         self.get_crate_data(cnum).def_path_table.clone()
 425     }
 426
 427     fn struct_field_names_untracked(&self, def: DefId) -> Vec<ast::Name>
 428     {
 429         self.read_dep_node(def);
 430         self.get_crate_data(def.krate).get_struct_field_names(def.index)
 431     }
 432
 433     fn item_children_untracked(&self, def_id: DefId, sess: &Session) -> Vec<def::Export>
 434     {
 435         self.read_dep_node(def_id);
 436         let mut result = vec![];
 437         self.get_crate_data(def_id.krate)
 438             .each_child_of_item(def_id.index, |child| result.push(child), sess);
 439         result
 440     }
 441
 442     fn load_macro_untracked(&self, id: DefId, sess: &Session) -> LoadedMacro {
 443         let data = self.get_crate_data(id.krate);
 444         if let Some(ref proc_macros) = data.proc_macros {
 445             return LoadedMacro::ProcMacro(proc_macros[id.index.as_usize() - 1].1.clone());
 446         } else if data.name == "proc_macro" &&
 447                   self.get_crate_data(id.krate).item_name(id.index) == "quote" {
 448             let ext = SyntaxExtension::ProcMacro(Box::new(::proc_macro::__internal::Quoter));
 449             return LoadedMacro::ProcMacro(Rc::new(ext));
 450         }
 451
 452         let (name, def) = data.get_macro(id.index);
 453         let source_name = format!("<{} macros>", name);
 454
 455         let filemap = sess.parse_sess.codemap().new_filemap(source_name, def.body);
 456         let local_span = Span::new(filemap.start_pos, filemap.end_pos, NO_EXPANSION);
 457         let body = filemap_to_stream(&sess.parse_sess, filemap, None);
 458
 459         // Mark the attrs as used
 460         let attrs = data.get_item_attrs(id.index, &self.dep_graph);
 461         for attr in attrs.iter() {
 462             attr::mark_used(attr);
 463         }
 464
 465         let name = data.def_key(id.index).disambiguated_data.data
 466             .get_opt_name().expect("no name in load_macro");
 467         sess.imported_macro_spans.borrow_mut()
 468             .insert(local_span, (name.to_string(), data.get_span(id.index, sess)));
 469
 470         LoadedMacro::MacroDef(ast::Item {
 471             ident: ast::Ident::from_str(&name),
 472             id: ast::DUMMY_NODE_ID,
 473             span: local_span,
 474             attrs: attrs.iter().cloned().collect(),
 475             node: ast::ItemKind::MacroDef(ast::MacroDef {
 476                 tokens: body.into(),
 477                 legacy: def.legacy,
 478             }),
 479             vis: ast::Visibility::Inherited,
 480             tokens: None,
 481         })
 482     }
 483
 484     fn crates(&self) -> Vec<CrateNum>
 485     {
 486         let mut result = vec![];
 487         self.iter_crate_data(|cnum, _| result.push(cnum));
 488         result
 489     }
 490
 491     fn extern_mod_stmt_cnum_untracked(&self, emod_id: ast::NodeId) -> Option<CrateNum>
 492     {
 493         self.do_extern_mod_stmt_cnum(emod_id)
 494     }
 495
 496     fn postorder_cnums_untracked(&self) -> Vec<CrateNum> {
 497         self.do_postorder_cnums_untracked()
 498     }
 499
 500     fn encode_metadata<'a, 'tcx>(&self,
 501                                  tcx: TyCtxt<'a, 'tcx, 'tcx>,
 502                                  link_meta: &LinkMeta,
 503                                  reachable: &NodeSet)
 504                                  -> (EncodedMetadata, EncodedMetadataHashes)
 505     {
 506         encoder::encode_metadata(tcx, link_meta, reachable)
 507     }
 508
 509     fn metadata_encoding_version(&self) -> &[u8]
 510     {
 511         schema::METADATA_HEADER
 512     }
 513 }