src/librustc_metadata/rmeta/decoder/cstore_impl.rs

   1 use crate::creader::{CStore, LoadedMacro};
   2 use crate::foreign_modules;
   3 use crate::link_args;
   4 use crate::native_libs;
   5 use crate::rmeta::{self, encoder};
   6
   7 use rustc_ast::ast;
   8 use rustc_ast::expand::allocator::AllocatorKind;
   9 use rustc_data_structures::svh::Svh;
  10 use rustc_hir as hir;
  11 use rustc_hir::def_id::{CrateNum, DefId, DefIdMap, CRATE_DEF_INDEX, LOCAL_CRATE};
  12 use rustc_hir::definitions::DefPathTable;
  13 use rustc_hir::definitions::{DefKey, DefPath, DefPathHash};
  14 use rustc_middle::hir::exports::Export;
  15 use rustc_middle::middle::cstore::{CrateSource, CrateStore, EncodedMetadata};
  16 use rustc_middle::middle::exported_symbols::ExportedSymbol;
  17 use rustc_middle::middle::stability::DeprecationEntry;
  18 use rustc_middle::ty::query::Providers;
  19 use rustc_middle::ty::{self, TyCtxt};
  20 use rustc_session::utils::NativeLibKind;
  21 use rustc_session::{CrateDisambiguator, Session};
  22 use rustc_span::source_map::{self, Span, Spanned};
  23 use rustc_span::symbol::Symbol;
  24
  25 use rustc_data_structures::sync::Lrc;
  26 use rustc_span::ExpnId;
  27 use smallvec::SmallVec;
  28 use std::any::Any;
  29
  30 macro_rules! provide {
  31     (<$lt:tt> $tcx:ident, $def_id:ident, $other:ident, $cdata:ident,
  32       $($name:ident => $compute:block)*) => {
  33         pub fn provide_extern(providers: &mut Providers) {
  34             $(fn $name<$lt>(
  35                 $tcx: TyCtxt<$lt>,
  36                 def_id_arg: ty::query::query_keys::$name<$lt>,
  37             ) -> ty::query::query_values::$name<$lt> {
  38                 let _prof_timer =
  39                     $tcx.prof.generic_activity(concat!("metadata_decode_entry_", stringify!($name)));
  40
  41                 #[allow(unused_variables)]
  42                 let ($def_id, $other) = def_id_arg.into_args();
  43                 assert!(!$def_id.is_local());
  44
  45                 let $cdata = CStore::from_tcx($tcx).get_crate_data($def_id.krate);
  46
  47                 if $tcx.dep_graph.is_fully_enabled() {
  48                     let crate_dep_node_index = $cdata.get_crate_dep_node_index($tcx);
  49                     $tcx.dep_graph.read_index(crate_dep_node_index);
  50                 }
  51
  52                 $compute
  53             })*
  54
  55             *providers = Providers {
  56                 $($name,)*
  57                 ..*providers
  58             };
  59         }
  60     }
  61 }
  62
  63 // small trait to work around different signature queries all being defined via
  64 // the macro above.
  65 trait IntoArgs {
  66     fn into_args(self) -> (DefId, DefId);
  67 }
  68
  69 impl IntoArgs for DefId {
  70     fn into_args(self) -> (DefId, DefId) {
  71         (self, self)
  72     }
  73 }
  74
  75 impl IntoArgs for CrateNum {
  76     fn into_args(self) -> (DefId, DefId) {
  77         (self.as_def_id(), self.as_def_id())
  78     }
  79 }
  80
  81 impl IntoArgs for (CrateNum, DefId) {
  82     fn into_args(self) -> (DefId, DefId) {
  83         (self.0.as_def_id(), self.1)
  84     }
  85 }
  86
  87 provide! { <'tcx> tcx, def_id, other, cdata,
  88     type_of => { cdata.get_type(def_id.index, tcx) }
  89     generics_of => { cdata.get_generics(def_id.index, tcx.sess) }
  90     explicit_predicates_of => { cdata.get_explicit_predicates(def_id.index, tcx) }
  91     inferred_outlives_of => { cdata.get_inferred_outlives(def_id.index, tcx) }
  92     super_predicates_of => { cdata.get_super_predicates(def_id.index, tcx) }
  93     trait_def => { cdata.get_trait_def(def_id.index, tcx.sess) }
  94     adt_def => { cdata.get_adt_def(def_id.index, tcx) }
  95     adt_destructor => {
  96         let _ = cdata;
  97         tcx.calculate_dtor(def_id, &mut |_,_| Ok(()))
  98     }
  99     variances_of => { tcx.arena.alloc_from_iter(cdata.get_item_variances(def_id.index)) }
 100     associated_item_def_ids => {
 101         let mut result = SmallVec::<[_; 8]>::new();
 102         cdata.each_child_of_item(def_id.index,
 103           |child| result.push(child.res.def_id()), tcx.sess);
 104         tcx.arena.alloc_slice(&result)
 105     }
 106     associated_item => { cdata.get_associated_item(def_id.index, tcx.sess) }
 107     impl_trait_ref => { cdata.get_impl_trait(def_id.index, tcx) }
 108     impl_polarity => { cdata.get_impl_polarity(def_id.index) }
 109     coerce_unsized_info => {
 110         cdata.get_coerce_unsized_info(def_id.index).unwrap_or_else(|| {
 111             bug!("coerce_unsized_info: `{:?}` is missing its info", def_id);
 112         })
 113     }
 114     optimized_mir => { tcx.arena.alloc(cdata.get_optimized_mir(tcx, def_id.index)) }
 115     promoted_mir => { tcx.arena.alloc(cdata.get_promoted_mir(tcx, def_id.index)) }
 116     unused_generic_params => { cdata.get_unused_generic_params(def_id.index) }
 117     mir_const_qualif => { cdata.mir_const_qualif(def_id.index) }
 118     fn_sig => { cdata.fn_sig(def_id.index, tcx) }
 119     inherent_impls => { cdata.get_inherent_implementations_for_type(tcx, def_id.index) }
 120     is_const_fn_raw => { cdata.is_const_fn_raw(def_id.index) }
 121     asyncness => { cdata.asyncness(def_id.index) }
 122     is_foreign_item => { cdata.is_foreign_item(def_id.index) }
 123     static_mutability => { cdata.static_mutability(def_id.index) }
 124     generator_kind => { cdata.generator_kind(def_id.index) }
 125     def_kind => { cdata.def_kind(def_id.index) }
 126     def_span => { cdata.get_span(def_id.index, &tcx.sess) }
 127     lookup_stability => {
 128         cdata.get_stability(def_id.index).map(|s| tcx.intern_stability(s))
 129     }
 130     lookup_const_stability => {
 131         cdata.get_const_stability(def_id.index).map(|s| tcx.intern_const_stability(s))
 132     }
 133     lookup_deprecation_entry => {
 134         cdata.get_deprecation(def_id.index).map(DeprecationEntry::external)
 135     }
 136     item_attrs => { tcx.arena.alloc_from_iter(
 137         cdata.get_item_attrs(def_id.index, tcx.sess).into_iter()
 138     ) }
 139     // FIXME(#38501) We've skipped a `read` on the `hir_owner_nodes` of
 140     // a `fn` when encoding, so the dep-tracking wouldn't work.
 141     // This is only used by rustdoc anyway, which shouldn't have
 142     // incremental recompilation ever enabled.
 143     fn_arg_names => { cdata.get_fn_param_names(tcx, def_id.index) }
 144     rendered_const => { cdata.get_rendered_const(def_id.index) }
 145     impl_parent => { cdata.get_parent_impl(def_id.index) }
 146     trait_of_item => { cdata.get_trait_of_item(def_id.index) }
 147     is_mir_available => { cdata.is_item_mir_available(def_id.index) }
 148
 149     dylib_dependency_formats => { cdata.get_dylib_dependency_formats(tcx) }
 150     is_panic_runtime => { cdata.root.panic_runtime }
 151     is_compiler_builtins => { cdata.root.compiler_builtins }
 152     has_global_allocator => { cdata.root.has_global_allocator }
 153     has_panic_handler => { cdata.root.has_panic_handler }
 154     is_profiler_runtime => { cdata.root.profiler_runtime }
 155     panic_strategy => { cdata.root.panic_strategy }
 156     extern_crate => {
 157         let r = *cdata.extern_crate.lock();
 158         r.map(|c| &*tcx.arena.alloc(c))
 159     }
 160     is_no_builtins => { cdata.root.no_builtins }
 161     symbol_mangling_version => { cdata.root.symbol_mangling_version }
 162     impl_defaultness => { cdata.get_impl_defaultness(def_id.index) }
 163     reachable_non_generics => {
 164         let reachable_non_generics = tcx
 165             .exported_symbols(cdata.cnum)
 166             .iter()
 167             .filter_map(|&(exported_symbol, export_level)| {
 168                 if let ExportedSymbol::NonGeneric(def_id) = exported_symbol {
 169                     Some((def_id, export_level))
 170                 } else {
 171                     None
 172                 }
 173             })
 174             .collect();
 175
 176         reachable_non_generics
 177     }
 178     native_libraries => { Lrc::new(cdata.get_native_libraries(tcx.sess)) }
 179     foreign_modules => { cdata.get_foreign_modules(tcx) }
 180     plugin_registrar_fn => {
 181         cdata.root.plugin_registrar_fn.map(|index| {
 182             DefId { krate: def_id.krate, index }
 183         })
 184     }
 185     proc_macro_decls_static => {
 186         cdata.root.proc_macro_decls_static.map(|index| {
 187             DefId { krate: def_id.krate, index }
 188         })
 189     }
 190     crate_disambiguator => { cdata.root.disambiguator }
 191     crate_hash => { cdata.root.hash }
 192     crate_host_hash => { cdata.host_hash }
 193     original_crate_name => { cdata.root.name }
 194
 195     extra_filename => { cdata.root.extra_filename.clone() }
 196
 197     implementations_of_trait => {
 198         cdata.get_implementations_for_trait(tcx, Some(other))
 199     }
 200
 201     all_trait_implementations => {
 202         cdata.get_implementations_for_trait(tcx, None)
 203     }
 204
 205     visibility => { cdata.get_visibility(def_id.index) }
 206     dep_kind => {
 207         let r = *cdata.dep_kind.lock();
 208         r
 209     }
 210     crate_name => { cdata.root.name }
 211     item_children => {
 212         let mut result = SmallVec::<[_; 8]>::new();
 213         cdata.each_child_of_item(def_id.index, |child| result.push(child), tcx.sess);
 214         tcx.arena.alloc_slice(&result)
 215     }
 216     defined_lib_features => { cdata.get_lib_features(tcx) }
 217     defined_lang_items => { cdata.get_lang_items(tcx) }
 218     diagnostic_items => { cdata.get_diagnostic_items() }
 219     missing_lang_items => { cdata.get_missing_lang_items(tcx) }
 220
 221     missing_extern_crate_item => {
 222         let r = match *cdata.extern_crate.borrow() {
 223             Some(extern_crate) if !extern_crate.is_direct() => true,
 224             _ => false,
 225         };
 226         r
 227     }
 228
 229     used_crate_source => { Lrc::new(cdata.source.clone()) }
 230
 231     exported_symbols => {
 232         let syms = cdata.exported_symbols(tcx);
 233
 234         // FIXME rust-lang/rust#64319, rust-lang/rust#64872: We want
 235         // to block export of generics from dylibs, but we must fix
 236         // rust-lang/rust#65890 before we can do that robustly.
 237
 238         syms
 239     }
 240
 241     crate_extern_paths => { cdata.source().paths().cloned().collect() }
 242 }
 243
 244 pub fn provide(providers: &mut Providers) {
 245     // FIXME(#44234) - almost all of these queries have no sub-queries and
 246     // therefore no actual inputs, they're just reading tables calculated in
 247     // resolve! Does this work? Unsure! That's what the issue is about
 248     *providers = Providers {
 249         is_dllimport_foreign_item: |tcx, id| match tcx.native_library_kind(id) {
 250             Some(NativeLibKind::Dylib | NativeLibKind::RawDylib | NativeLibKind::Unspecified) => {
 251                 true
 252             }
 253             _ => false,
 254         },
 255         is_statically_included_foreign_item: |tcx, id| match tcx.native_library_kind(id) {
 256             Some(NativeLibKind::StaticBundle | NativeLibKind::StaticNoBundle) => true,
 257             _ => false,
 258         },
 259         native_library_kind: |tcx, id| {
 260             tcx.native_libraries(id.krate)
 261                 .iter()
 262                 .filter(|lib| native_libs::relevant_lib(&tcx.sess, lib))
 263                 .find(|lib| {
 264                     let fm_id = match lib.foreign_module {
 265                         Some(id) => id,
 266                         None => return false,
 267                     };
 268                     tcx.foreign_modules(id.krate)
 269                         .iter()
 270                         .find(|m| m.def_id == fm_id)
 271                         .expect("failed to find foreign module")
 272                         .foreign_items
 273                         .contains(&id)
 274                 })
 275                 .map(|l| l.kind)
 276         },
 277         native_libraries: |tcx, cnum| {
 278             assert_eq!(cnum, LOCAL_CRATE);
 279             Lrc::new(native_libs::collect(tcx))
 280         },
 281         foreign_modules: |tcx, cnum| {
 282             assert_eq!(cnum, LOCAL_CRATE);
 283             &tcx.arena.alloc(foreign_modules::collect(tcx))[..]
 284         },
 285         link_args: |tcx, cnum| {
 286             assert_eq!(cnum, LOCAL_CRATE);
 287             Lrc::new(link_args::collect(tcx))
 288         },
 289
 290         // Returns a map from a sufficiently visible external item (i.e., an
 291         // external item that is visible from at least one local module) to a
 292         // sufficiently visible parent (considering modules that re-export the
 293         // external item to be parents).
 294         visible_parent_map: |tcx, cnum| {
 295             use std::collections::hash_map::Entry;
 296             use std::collections::vec_deque::VecDeque;
 297
 298             assert_eq!(cnum, LOCAL_CRATE);
 299             let mut visible_parent_map: DefIdMap<DefId> = Default::default();
 300
 301             // Issue 46112: We want the map to prefer the shortest
 302             // paths when reporting the path to an item. Therefore we
 303             // build up the map via a breadth-first search (BFS),
 304             // which naturally yields minimal-length paths.
 305             //
 306             // Note that it needs to be a BFS over the whole forest of
 307             // crates, not just each individual crate; otherwise you
 308             // only get paths that are locally minimal with respect to
 309             // whatever crate we happened to encounter first in this
 310             // traversal, but not globally minimal across all crates.
 311             let bfs_queue = &mut VecDeque::new();
 312
 313             // Preferring shortest paths alone does not guarantee a
 314             // deterministic result; so sort by crate num to avoid
 315             // hashtable iteration non-determinism. This only makes
 316             // things as deterministic as crate-nums assignment is,
 317             // which is to say, its not deterministic in general. But
 318             // we believe that libstd is consistently assigned crate
 319             // num 1, so it should be enough to resolve #46112.
 320             let mut crates: Vec<CrateNum> = (*tcx.crates()).to_owned();
 321             crates.sort();
 322
 323             for &cnum in crates.iter() {
 324                 // Ignore crates without a corresponding local `extern crate` item.
 325                 if tcx.missing_extern_crate_item(cnum) {
 326                     continue;
 327                 }
 328
 329                 bfs_queue.push_back(DefId { krate: cnum, index: CRATE_DEF_INDEX });
 330             }
 331
 332             // (restrict scope of mutable-borrow of `visible_parent_map`)
 333             {
 334                 let visible_parent_map = &mut visible_parent_map;
 335                 let mut add_child =
 336                     |bfs_queue: &mut VecDeque<_>, child: &Export<hir::HirId>, parent: DefId| {
 337                         if child.vis != ty::Visibility::Public {
 338                             return;
 339                         }
 340
 341                         if let Some(child) = child.res.opt_def_id() {
 342                             match visible_parent_map.entry(child) {
 343                                 Entry::Occupied(mut entry) => {
 344                                     // If `child` is defined in crate `cnum`, ensure
 345                                     // that it is mapped to a parent in `cnum`.
 346                                     if child.krate == cnum && entry.get().krate != cnum {
 347                                         entry.insert(parent);
 348                                     }
 349                                 }
 350                                 Entry::Vacant(entry) => {
 351                                     entry.insert(parent);
 352                                     bfs_queue.push_back(child);
 353                                 }
 354                             }
 355                         }
 356                     };
 357
 358                 while let Some(def) = bfs_queue.pop_front() {
 359                     for child in tcx.item_children(def).iter() {
 360                         add_child(bfs_queue, child, def);
 361                     }
 362                 }
 363             }
 364
 365             visible_parent_map
 366         },
 367
 368         dependency_formats: |tcx, cnum| {
 369             assert_eq!(cnum, LOCAL_CRATE);
 370             Lrc::new(crate::dependency_format::calculate(tcx))
 371         },
 372         has_global_allocator: |tcx, cnum| {
 373             assert_eq!(cnum, LOCAL_CRATE);
 374             CStore::from_tcx(tcx).has_global_allocator()
 375         },
 376         postorder_cnums: |tcx, cnum| {
 377             assert_eq!(cnum, LOCAL_CRATE);
 378             tcx.arena.alloc_slice(&CStore::from_tcx(tcx).crate_dependencies_in_postorder(cnum))
 379         },
 380
 381         ..*providers
 382     };
 383 }
 384
 385 impl CStore {
 386     pub fn struct_field_names_untracked(&self, def: DefId, sess: &Session) -> Vec<Spanned<Symbol>> {
 387         self.get_crate_data(def.krate).get_struct_field_names(def.index, sess)
 388     }
 389
 390     pub fn item_children_untracked(
 391         &self,
 392         def_id: DefId,
 393         sess: &Session,
 394     ) -> Vec<Export<hir::HirId>> {
 395         let mut result = vec![];
 396         self.get_crate_data(def_id.krate).each_child_of_item(
 397             def_id.index,
 398             |child| result.push(child),
 399             sess,
 400         );
 401         result
 402     }
 403
 404     pub fn load_macro_untracked(&self, id: DefId, sess: &Session) -> LoadedMacro {
 405         let _prof_timer = sess.prof.generic_activity("metadata_load_macro");
 406
 407         let data = self.get_crate_data(id.krate);
 408         if data.root.is_proc_macro_crate() {
 409             return LoadedMacro::ProcMacro(data.load_proc_macro(id.index, sess));
 410         }
 411
 412         let span = data.get_span(id.index, sess);
 413
 414         // Mark the attrs as used
 415         let attrs = data.get_item_attrs(id.index, sess);
 416         for attr in attrs.iter() {
 417             sess.mark_attr_used(attr);
 418         }
 419
 420         let ident = data.item_ident(id.index, sess);
 421
 422         LoadedMacro::MacroDef(
 423             ast::Item {
 424                 ident,
 425                 id: ast::DUMMY_NODE_ID,
 426                 span,
 427                 attrs: attrs.to_vec(),
 428                 kind: ast::ItemKind::MacroDef(data.get_macro(id.index, sess)),
 429                 vis: source_map::respan(span.shrink_to_lo(), ast::VisibilityKind::Inherited),
 430                 tokens: None,
 431             },
 432             data.root.edition,
 433         )
 434     }
 435
 436     pub fn associated_item_cloned_untracked(&self, def: DefId, sess: &Session) -> ty::AssocItem {
 437         self.get_crate_data(def.krate).get_associated_item(def.index, sess)
 438     }
 439
 440     pub fn crate_source_untracked(&self, cnum: CrateNum) -> CrateSource {
 441         self.get_crate_data(cnum).source.clone()
 442     }
 443
 444     pub fn get_span_untracked(&self, def_id: DefId, sess: &Session) -> Span {
 445         self.get_crate_data(def_id.krate).get_span(def_id.index, sess)
 446     }
 447
 448     pub fn item_generics_num_lifetimes(&self, def_id: DefId, sess: &Session) -> usize {
 449         self.get_crate_data(def_id.krate).get_generics(def_id.index, sess).own_counts().lifetimes
 450     }
 451
 452     pub fn module_expansion_untracked(&self, def_id: DefId, sess: &Session) -> ExpnId {
 453         self.get_crate_data(def_id.krate).module_expansion(def_id.index, sess)
 454     }
 455 }
 456
 457 impl CrateStore for CStore {
 458     fn as_any(&self) -> &dyn Any {
 459         self
 460     }
 461
 462     fn crate_name_untracked(&self, cnum: CrateNum) -> Symbol {
 463         self.get_crate_data(cnum).root.name
 464     }
 465
 466     fn crate_is_private_dep_untracked(&self, cnum: CrateNum) -> bool {
 467         self.get_crate_data(cnum).private_dep
 468     }
 469
 470     fn crate_disambiguator_untracked(&self, cnum: CrateNum) -> CrateDisambiguator {
 471         self.get_crate_data(cnum).root.disambiguator
 472     }
 473
 474     fn crate_hash_untracked(&self, cnum: CrateNum) -> Svh {
 475         self.get_crate_data(cnum).root.hash
 476     }
 477
 478     /// Returns the `DefKey` for a given `DefId`. This indicates the
 479     /// parent `DefId` as well as some idea of what kind of data the
 480     /// `DefId` refers to.
 481     fn def_key(&self, def: DefId) -> DefKey {
 482         self.get_crate_data(def.krate).def_key(def.index)
 483     }
 484
 485     fn def_path(&self, def: DefId) -> DefPath {
 486         self.get_crate_data(def.krate).def_path(def.index)
 487     }
 488
 489     fn def_path_hash(&self, def: DefId) -> DefPathHash {
 490         self.get_crate_data(def.krate).def_path_hash(def.index)
 491     }
 492
 493     fn def_path_table(&self, cnum: CrateNum) -> &DefPathTable {
 494         &self.get_crate_data(cnum).cdata.def_path_table
 495     }
 496
 497     fn crates_untracked(&self) -> Vec<CrateNum> {
 498         let mut result = vec![];
 499         self.iter_crate_data(|cnum, _| result.push(cnum));
 500         result
 501     }
 502
 503     fn encode_metadata(&self, tcx: TyCtxt<'_>) -> EncodedMetadata {
 504         encoder::encode_metadata(tcx)
 505     }
 506
 507     fn metadata_encoding_version(&self) -> &[u8] {
 508         rmeta::METADATA_HEADER
 509     }
 510
 511     fn allocator_kind(&self) -> Option<AllocatorKind> {
 512         self.allocator_kind()
 513     }
 514 }