src/librustc_metadata/cstore_impl.rs

   1 use crate::cstore::{self, LoadedMacro};
   2 use crate::encoder;
   3 use crate::link_args;
   4 use crate::native_libs;
   5 use crate::foreign_modules;
   6 use crate::schema;
   7
   8 use rustc::ty::query::QueryConfig;
   9 use rustc::middle::cstore::{CrateStore, DepKind,
  10                             EncodedMetadata, NativeLibraryKind};
  11 use rustc::middle::exported_symbols::ExportedSymbol;
  12 use rustc::middle::stability::DeprecationEntry;
  13 use rustc::hir::def;
  14 use rustc::hir;
  15 use rustc::session::{CrateDisambiguator, Session};
  16 use rustc::ty::{self, TyCtxt};
  17 use rustc::ty::query::Providers;
  18 use rustc::hir::def_id::{CrateNum, DefId, LOCAL_CRATE, CRATE_DEF_INDEX};
  19 use rustc::hir::map::{DefKey, DefPath, DefPathHash};
  20 use rustc::hir::map::definitions::DefPathTable;
  21 use rustc::util::nodemap::DefIdMap;
  22 use rustc_data_structures::svh::Svh;
  23
  24 use smallvec::SmallVec;
  25 use std::any::Any;
  26 use rustc_data_structures::sync::Lrc;
  27 use std::sync::Arc;
  28
  29 use syntax::ast;
  30 use syntax::attr;
  31 use syntax::source_map;
  32 use syntax::edition::Edition;
  33 use syntax::parse::source_file_to_stream;
  34 use syntax::parse::parser::emit_unclosed_delims;
  35 use syntax::symbol::Symbol;
  36 use syntax_pos::{Span, FileName};
  37 use rustc_data_structures::bit_set::BitSet;
  38
  39 macro_rules! provide {
  40     (<$lt:tt> $tcx:ident, $def_id:ident, $other:ident, $cdata:ident,
  41       $($name:ident => $compute:block)*) => {
  42         pub fn provide_extern<$lt>(providers: &mut Providers<$lt>) {
  43             // HACK(eddyb) `$lt: $lt` forces `$lt` to be early-bound, which
  44             // allows the associated type in the return type to be normalized.
  45             $(fn $name<$lt: $lt, T: IntoArgs>(
  46                 $tcx: TyCtxt<$lt>,
  47                 def_id_arg: T,
  48             ) -> <ty::queries::$name<$lt> as QueryConfig<$lt>>::Value {
  49                 #[allow(unused_variables)]
  50                 let ($def_id, $other) = def_id_arg.into_args();
  51                 assert!(!$def_id.is_local());
  52
  53                 let def_path_hash = $tcx.def_path_hash(DefId {
  54                     krate: $def_id.krate,
  55                     index: CRATE_DEF_INDEX
  56                 });
  57                 let dep_node = def_path_hash
  58                     .to_dep_node(rustc::dep_graph::DepKind::CrateMetadata);
  59                 // The DepNodeIndex of the DepNode::CrateMetadata should be
  60                 // cached somewhere, so that we can use read_index().
  61                 $tcx.dep_graph.read(dep_node);
  62
  63                 let $cdata = $tcx.crate_data_as_rc_any($def_id.krate);
  64                 let $cdata = $cdata.downcast_ref::<cstore::CrateMetadata>()
  65                     .expect("CrateStore created data 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 => {
  98         tcx.arena.alloc(cdata.get_generics(def_id.index, tcx.sess))
  99     }
 100     predicates_of => { tcx.arena.alloc(cdata.get_predicates(def_id.index, tcx)) }
 101     predicates_defined_on => {
 102         tcx.arena.alloc(cdata.get_predicates_defined_on(def_id.index, tcx))
 103     }
 104     super_predicates_of => { tcx.arena.alloc(cdata.get_super_predicates(def_id.index, tcx)) }
 105     trait_def => {
 106         tcx.arena.alloc(cdata.get_trait_def(def_id.index, tcx.sess))
 107     }
 108     adt_def => { cdata.get_adt_def(def_id.index, tcx) }
 109     adt_destructor => {
 110         let _ = cdata;
 111         tcx.calculate_dtor(def_id, &mut |_,_| Ok(()))
 112     }
 113     variances_of => { tcx.arena.alloc_from_iter(cdata.get_item_variances(def_id.index)) }
 114     associated_item_def_ids => {
 115         let mut result = SmallVec::<[_; 8]>::new();
 116         cdata.each_child_of_item(def_id.index,
 117           |child| result.push(child.res.def_id()), tcx.sess);
 118         tcx.arena.alloc_slice(&result)
 119     }
 120     associated_item => { cdata.get_associated_item(def_id.index) }
 121     impl_trait_ref => { cdata.get_impl_trait(def_id.index, tcx) }
 122     impl_polarity => { cdata.get_impl_polarity(def_id.index) }
 123     coerce_unsized_info => {
 124         cdata.get_coerce_unsized_info(def_id.index).unwrap_or_else(|| {
 125             bug!("coerce_unsized_info: `{:?}` is missing its info", def_id);
 126         })
 127     }
 128     optimized_mir => { tcx.arena.alloc(cdata.get_optimized_mir(tcx, def_id.index)) }
 129     promoted_mir => { tcx.arena.alloc(cdata.get_promoted_mir(tcx, def_id.index)) }
 130     mir_const_qualif => {
 131         (cdata.mir_const_qualif(def_id.index), tcx.arena.alloc(BitSet::new_empty(0)))
 132     }
 133     fn_sig => { cdata.fn_sig(def_id.index, tcx) }
 134     inherent_impls => { cdata.get_inherent_implementations_for_type(tcx, def_id.index) }
 135     is_const_fn_raw => { cdata.is_const_fn_raw(def_id.index) }
 136     is_foreign_item => { cdata.is_foreign_item(def_id.index) }
 137     static_mutability => { cdata.static_mutability(def_id.index) }
 138     def_kind => { cdata.def_kind(def_id.index) }
 139     def_span => { cdata.get_span(def_id.index, &tcx.sess) }
 140     lookup_stability => {
 141         cdata.get_stability(def_id.index).map(|s| tcx.intern_stability(s))
 142     }
 143     lookup_deprecation_entry => {
 144         cdata.get_deprecation(def_id.index).map(DeprecationEntry::external)
 145     }
 146     item_attrs => { cdata.get_item_attrs(def_id.index, tcx.sess) }
 147     // FIXME(#38501) We've skipped a `read` on the `HirBody` of
 148     // a `fn` when encoding, so the dep-tracking wouldn't work.
 149     // This is only used by rustdoc anyway, which shouldn't have
 150     // incremental recompilation ever enabled.
 151     fn_arg_names => { cdata.get_fn_param_names(def_id.index) }
 152     rendered_const => { cdata.get_rendered_const(def_id.index) }
 153     impl_parent => { cdata.get_parent_impl(def_id.index) }
 154     trait_of_item => { cdata.get_trait_of_item(def_id.index) }
 155     const_is_rvalue_promotable_to_static => {
 156         cdata.const_is_rvalue_promotable_to_static(def_id.index)
 157     }
 158     is_mir_available => { cdata.is_item_mir_available(def_id.index) }
 159
 160     dylib_dependency_formats => { cdata.get_dylib_dependency_formats(tcx) }
 161     is_panic_runtime => { cdata.root.panic_runtime }
 162     is_compiler_builtins => { cdata.root.compiler_builtins }
 163     has_global_allocator => { cdata.root.has_global_allocator }
 164     has_panic_handler => { cdata.root.has_panic_handler }
 165     is_sanitizer_runtime => { cdata.root.sanitizer_runtime }
 166     is_profiler_runtime => { cdata.root.profiler_runtime }
 167     panic_strategy => { cdata.root.panic_strategy }
 168     extern_crate => {
 169         let r = *cdata.extern_crate.lock();
 170         r.map(|c| &*tcx.arena.alloc(c))
 171     }
 172     is_no_builtins => { cdata.root.no_builtins }
 173     symbol_mangling_version => { cdata.root.symbol_mangling_version }
 174     impl_defaultness => { cdata.get_impl_defaultness(def_id.index) }
 175     reachable_non_generics => {
 176         let reachable_non_generics = tcx
 177             .exported_symbols(cdata.cnum)
 178             .iter()
 179             .filter_map(|&(exported_symbol, export_level)| {
 180                 if let ExportedSymbol::NonGeneric(def_id) = exported_symbol {
 181                     return Some((def_id, export_level))
 182                 } else {
 183                     None
 184                 }
 185             })
 186             .collect();
 187
 188         tcx.arena.alloc(reachable_non_generics)
 189     }
 190     native_libraries => { Lrc::new(cdata.get_native_libraries(tcx.sess)) }
 191     foreign_modules => { cdata.get_foreign_modules(tcx) }
 192     plugin_registrar_fn => {
 193         cdata.root.plugin_registrar_fn.map(|index| {
 194             DefId { krate: def_id.krate, index }
 195         })
 196     }
 197     proc_macro_decls_static => {
 198         cdata.root.proc_macro_decls_static.map(|index| {
 199             DefId { krate: def_id.krate, index }
 200         })
 201     }
 202     crate_disambiguator => { cdata.root.disambiguator }
 203     crate_hash => { cdata.root.hash }
 204     original_crate_name => { cdata.root.name }
 205
 206     extra_filename => { cdata.root.extra_filename.clone() }
 207
 208     implementations_of_trait => {
 209         cdata.get_implementations_for_trait(tcx, Some(other))
 210     }
 211
 212     all_trait_implementations => {
 213         cdata.get_implementations_for_trait(tcx, None)
 214     }
 215
 216     visibility => { cdata.get_visibility(def_id.index) }
 217     dep_kind => {
 218         let r = *cdata.dep_kind.lock();
 219         r
 220     }
 221     crate_name => { cdata.name }
 222     item_children => {
 223         let mut result = SmallVec::<[_; 8]>::new();
 224         cdata.each_child_of_item(def_id.index, |child| result.push(child), tcx.sess);
 225         tcx.arena.alloc_slice(&result)
 226     }
 227     defined_lib_features => { cdata.get_lib_features(tcx) }
 228     defined_lang_items => { cdata.get_lang_items(tcx) }
 229     missing_lang_items => { cdata.get_missing_lang_items(tcx) }
 230
 231     missing_extern_crate_item => {
 232         let r = match *cdata.extern_crate.borrow() {
 233             Some(extern_crate) if !extern_crate.direct => true,
 234             _ => false,
 235         };
 236         r
 237     }
 238
 239     used_crate_source => { Lrc::new(cdata.source.clone()) }
 240
 241     exported_symbols => { Arc::new(cdata.exported_symbols(tcx)) }
 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| {
 250             tcx.native_library_kind(id) == Some(NativeLibraryKind::NativeUnknown)
 251         },
 252         is_statically_included_foreign_item: |tcx, id| {
 253             match tcx.native_library_kind(id) {
 254                 Some(NativeLibraryKind::NativeStatic) |
 255                 Some(NativeLibraryKind::NativeStaticNobundle) => true,
 256                 _ => false,
 257             }
 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::vec_deque::VecDeque;
 296             use std::collections::hash_map::Entry;
 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 {
 330                     krate: cnum,
 331                     index: CRATE_DEF_INDEX
 332                 });
 333             }
 334
 335             // (restrict scope of mutable-borrow of `visible_parent_map`)
 336             {
 337                 let visible_parent_map = &mut visible_parent_map;
 338                 let mut add_child = |bfs_queue: &mut VecDeque<_>,
 339                                      child: &def::Export<hir::HirId>,
 340                                      parent: DefId| {
 341                     if child.vis != ty::Visibility::Public {
 342                         return;
 343                     }
 344
 345                     if let Some(child) = child.res.opt_def_id() {
 346                         match visible_parent_map.entry(child) {
 347                             Entry::Occupied(mut entry) => {
 348                                 // If `child` is defined in crate `cnum`, ensure
 349                                 // that it is mapped to a parent in `cnum`.
 350                                 if child.krate == cnum && entry.get().krate != cnum {
 351                                     entry.insert(parent);
 352                                 }
 353                             }
 354                             Entry::Vacant(entry) => {
 355                                 entry.insert(parent);
 356                                 bfs_queue.push_back(child);
 357                             }
 358                         }
 359                     }
 360                 };
 361
 362                 while let Some(def) = bfs_queue.pop_front() {
 363                     for child in tcx.item_children(def).iter() {
 364                         add_child(bfs_queue, child, def);
 365                     }
 366                 }
 367             }
 368
 369             tcx.arena.alloc(visible_parent_map)
 370         },
 371
 372         ..*providers
 373     };
 374 }
 375
 376 impl cstore::CStore {
 377     pub fn export_macros_untracked(&self, cnum: CrateNum) {
 378         let data = self.get_crate_data(cnum);
 379         let mut dep_kind = data.dep_kind.lock();
 380         if *dep_kind == DepKind::UnexportedMacrosOnly {
 381             *dep_kind = DepKind::MacrosOnly;
 382         }
 383     }
 384
 385     pub fn dep_kind_untracked(&self, cnum: CrateNum) -> DepKind {
 386         let data = self.get_crate_data(cnum);
 387         let r = *data.dep_kind.lock();
 388         r
 389     }
 390
 391     pub fn crate_edition_untracked(&self, cnum: CrateNum) -> Edition {
 392         self.get_crate_data(cnum).root.edition
 393     }
 394
 395     pub fn struct_field_names_untracked(&self, def: DefId) -> Vec<ast::Name> {
 396         self.get_crate_data(def.krate).get_struct_field_names(def.index)
 397     }
 398
 399     pub fn ctor_kind_untracked(&self, def: DefId) -> def::CtorKind {
 400         self.get_crate_data(def.krate).get_ctor_kind(def.index)
 401     }
 402
 403     pub fn item_attrs_untracked(&self, def: DefId, sess: &Session) -> Lrc<[ast::Attribute]> {
 404         self.get_crate_data(def.krate).get_item_attrs(def.index, sess)
 405     }
 406
 407     pub fn item_children_untracked(
 408         &self,
 409         def_id: DefId,
 410         sess: &Session
 411     ) -> Vec<def::Export<hir::HirId>> {
 412         let mut result = vec![];
 413         self.get_crate_data(def_id.krate)
 414             .each_child_of_item(def_id.index, |child| result.push(child), sess);
 415         result
 416     }
 417
 418     pub fn load_macro_untracked(&self, id: DefId, sess: &Session) -> LoadedMacro {
 419         let data = self.get_crate_data(id.krate);
 420         if data.is_proc_macro_crate() {
 421             return LoadedMacro::ProcMacro(data.load_proc_macro(id.index, sess));
 422         }
 423
 424         let def = data.get_macro(id.index);
 425         let macro_full_name = data.def_path(id.index)
 426             .to_string_friendly(|_| data.imported_name);
 427         let source_name = FileName::Macros(macro_full_name);
 428
 429         let source_file = sess.parse_sess.source_map().new_source_file(source_name, def.body);
 430         let local_span = Span::with_root_ctxt(source_file.start_pos, source_file.end_pos);
 431         let (body, mut errors) = source_file_to_stream(&sess.parse_sess, source_file, None);
 432         emit_unclosed_delims(&mut errors, &sess.diagnostic());
 433
 434         // Mark the attrs as used
 435         let attrs = data.get_item_attrs(id.index, sess);
 436         for attr in attrs.iter() {
 437             attr::mark_used(attr);
 438         }
 439
 440         let name = data.def_key(id.index).disambiguated_data.data
 441             .get_opt_name().expect("no name in load_macro");
 442         sess.imported_macro_spans.borrow_mut()
 443             .insert(local_span, (name.to_string(), data.get_span(id.index, sess)));
 444
 445         LoadedMacro::MacroDef(ast::Item {
 446             ident: ast::Ident::from_str(&name.as_str()),
 447             id: ast::DUMMY_NODE_ID,
 448             span: local_span,
 449             attrs: attrs.iter().cloned().collect(),
 450             node: ast::ItemKind::MacroDef(ast::MacroDef {
 451                 tokens: body.into(),
 452                 legacy: def.legacy,
 453             }),
 454             vis: source_map::respan(local_span.shrink_to_lo(), ast::VisibilityKind::Inherited),
 455             tokens: None,
 456         })
 457     }
 458
 459     pub fn associated_item_cloned_untracked(&self, def: DefId) -> ty::AssocItem {
 460         self.get_crate_data(def.krate).get_associated_item(def.index)
 461     }
 462 }
 463
 464 impl CrateStore for cstore::CStore {
 465     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Lrc<dyn Any> {
 466         self.get_crate_data(krate)
 467     }
 468
 469     fn item_generics_cloned_untracked(&self, def: DefId, sess: &Session) -> ty::Generics {
 470         self.get_crate_data(def.krate).get_generics(def.index, sess)
 471     }
 472
 473     fn crate_name_untracked(&self, cnum: CrateNum) -> Symbol
 474     {
 475         self.get_crate_data(cnum).name
 476     }
 477
 478     fn crate_is_private_dep_untracked(&self, cnum: CrateNum) -> bool {
 479         self.get_crate_data(cnum).private_dep
 480     }
 481
 482     fn crate_disambiguator_untracked(&self, cnum: CrateNum) -> CrateDisambiguator
 483     {
 484         self.get_crate_data(cnum).root.disambiguator
 485     }
 486
 487     fn crate_hash_untracked(&self, cnum: CrateNum) -> Svh
 488     {
 489         self.get_crate_data(cnum).root.hash
 490     }
 491
 492     /// Returns the `DefKey` for a given `DefId`. This indicates the
 493     /// parent `DefId` as well as some idea of what kind of data the
 494     /// `DefId` refers to.
 495     fn def_key(&self, def: DefId) -> DefKey {
 496         // Note: loading the def-key (or def-path) for a def-id is not
 497         // a *read* of its metadata. This is because the def-id is
 498         // really just an interned shorthand for a def-path, which is the
 499         // canonical name for an item.
 500         //
 501         // self.dep_graph.read(DepNode::MetaData(def));
 502         self.get_crate_data(def.krate).def_key(def.index)
 503     }
 504
 505     fn def_path(&self, def: DefId) -> DefPath {
 506         // See `Note` above in `def_key()` for why this read is
 507         // commented out:
 508         //
 509         // self.dep_graph.read(DepNode::MetaData(def));
 510         self.get_crate_data(def.krate).def_path(def.index)
 511     }
 512
 513     fn def_path_hash(&self, def: DefId) -> DefPathHash {
 514         self.get_crate_data(def.krate).def_path_hash(def.index)
 515     }
 516
 517     fn def_path_table(&self, cnum: CrateNum) -> Lrc<DefPathTable> {
 518         self.get_crate_data(cnum).def_path_table.clone()
 519     }
 520
 521     fn crates_untracked(&self) -> Vec<CrateNum>
 522     {
 523         let mut result = vec![];
 524         self.iter_crate_data(|cnum, _| result.push(cnum));
 525         result
 526     }
 527
 528     fn extern_mod_stmt_cnum_untracked(&self, emod_id: ast::NodeId) -> Option<CrateNum>
 529     {
 530         self.do_extern_mod_stmt_cnum(emod_id)
 531     }
 532
 533     fn postorder_cnums_untracked(&self) -> Vec<CrateNum> {
 534         self.do_postorder_cnums_untracked()
 535     }
 536
 537     fn encode_metadata(&self, tcx: TyCtxt<'_>) -> EncodedMetadata {
 538         encoder::encode_metadata(tcx)
 539     }
 540
 541     fn metadata_encoding_version(&self) -> &[u8]
 542     {
 543         schema::METADATA_HEADER
 544     }
 545 }