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, sym};
  36 use syntax_pos::{Span, NO_EXPANSION, 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             $(fn $name<'a, $lt:$lt, T>($tcx: TyCtxt<'a, $lt, $lt>, def_id_arg: T)
  44                                     -> <ty::queries::$name<$lt> as
  45                                         QueryConfig<$lt>>::Value
  46                 where T: IntoArgs,
  47             {
  48                 #[allow(unused_variables)]
  49                 let ($def_id, $other) = def_id_arg.into_args();
  50                 assert!(!$def_id.is_local());
  51
  52                 let def_path_hash = $tcx.def_path_hash(DefId {
  53                     krate: $def_id.krate,
  54                     index: CRATE_DEF_INDEX
  55                 });
  56                 let dep_node = def_path_hash
  57                     .to_dep_node(rustc::dep_graph::DepKind::CrateMetadata);
  58                 // The DepNodeIndex of the DepNode::CrateMetadata should be
  59                 // cached somewhere, so that we can use read_index().
  60                 $tcx.dep_graph.read(dep_node);
  61
  62                 let $cdata = $tcx.crate_data_as_rc_any($def_id.krate);
  63                 let $cdata = $cdata.downcast_ref::<cstore::CrateMetadata>()
  64                     .expect("CrateStore created data is not a CrateMetadata");
  65                 $compute
  66             })*
  67
  68             *providers = Providers {
  69                 $($name,)*
  70                 ..*providers
  71             };
  72         }
  73     }
  74 }
  75
  76 // small trait to work around different signature queries all being defined via
  77 // the macro above.
  78 trait IntoArgs {
  79     fn into_args(self) -> (DefId, DefId);
  80 }
  81
  82 impl IntoArgs for DefId {
  83     fn into_args(self) -> (DefId, DefId) { (self, self) }
  84 }
  85
  86 impl IntoArgs for CrateNum {
  87     fn into_args(self) -> (DefId, DefId) { (self.as_def_id(), self.as_def_id()) }
  88 }
  89
  90 impl IntoArgs for (CrateNum, DefId) {
  91     fn into_args(self) -> (DefId, DefId) { (self.0.as_def_id(), self.1) }
  92 }
  93
  94 provide! { <'tcx> tcx, def_id, other, cdata,
  95     type_of => { cdata.get_type(def_id.index, tcx) }
  96     generics_of => {
  97         tcx.alloc_generics(cdata.get_generics(def_id.index, tcx.sess))
  98     }
  99     predicates_of => { tcx.arena.alloc(cdata.get_predicates(def_id.index, tcx)) }
 100     predicates_defined_on => {
 101         tcx.arena.alloc(cdata.get_predicates_defined_on(def_id.index, tcx))
 102     }
 103     super_predicates_of => { tcx.arena.alloc(cdata.get_super_predicates(def_id.index, tcx)) }
 104     trait_def => {
 105         tcx.alloc_trait_def(cdata.get_trait_def(def_id.index, tcx.sess))
 106     }
 107     adt_def => { cdata.get_adt_def(def_id.index, tcx) }
 108     adt_destructor => {
 109         let _ = cdata;
 110         tcx.calculate_dtor(def_id, &mut |_,_| Ok(()))
 111     }
 112     variances_of => { tcx.arena.alloc_from_iter(cdata.get_item_variances(def_id.index)) }
 113     associated_item_def_ids => {
 114         let mut result = SmallVec::<[_; 8]>::new();
 115         cdata.each_child_of_item(def_id.index,
 116           |child| result.push(child.res.def_id()), tcx.sess);
 117         tcx.arena.alloc_slice(&result)
 118     }
 119     associated_item => { cdata.get_associated_item(def_id.index) }
 120     impl_trait_ref => { cdata.get_impl_trait(def_id.index, tcx) }
 121     impl_polarity => { cdata.get_impl_polarity(def_id.index) }
 122     coerce_unsized_info => {
 123         cdata.get_coerce_unsized_info(def_id.index).unwrap_or_else(|| {
 124             bug!("coerce_unsized_info: `{:?}` is missing its info", def_id);
 125         })
 126     }
 127     optimized_mir => {
 128         let mir = cdata.maybe_get_optimized_mir(tcx, def_id.index).unwrap_or_else(|| {
 129             bug!("get_optimized_mir: missing MIR for `{:?}`", def_id)
 130         });
 131
 132         let mir = tcx.alloc_mir(mir);
 133
 134         mir
 135     }
 136     mir_const_qualif => {
 137         (cdata.mir_const_qualif(def_id.index), tcx.arena.alloc(BitSet::new_empty(0)))
 138     }
 139     fn_sig => { cdata.fn_sig(def_id.index, tcx) }
 140     inherent_impls => { cdata.get_inherent_implementations_for_type(tcx, def_id.index) }
 141     is_const_fn_raw => { cdata.is_const_fn_raw(def_id.index) }
 142     is_foreign_item => { cdata.is_foreign_item(def_id.index) }
 143     static_mutability => { cdata.static_mutability(def_id.index) }
 144     def_kind => { cdata.def_kind(def_id.index) }
 145     def_span => { cdata.get_span(def_id.index, &tcx.sess) }
 146     lookup_stability => {
 147         cdata.get_stability(def_id.index).map(|s| tcx.intern_stability(s))
 148     }
 149     lookup_deprecation_entry => {
 150         cdata.get_deprecation(def_id.index).map(DeprecationEntry::external)
 151     }
 152     item_attrs => { cdata.get_item_attrs(def_id.index, tcx.sess) }
 153     // FIXME(#38501) We've skipped a `read` on the `HirBody` of
 154     // a `fn` when encoding, so the dep-tracking wouldn't work.
 155     // This is only used by rustdoc anyway, which shouldn't have
 156     // incremental recompilation ever enabled.
 157     fn_arg_names => { cdata.get_fn_arg_names(def_id.index) }
 158     rendered_const => { cdata.get_rendered_const(def_id.index) }
 159     impl_parent => { cdata.get_parent_impl(def_id.index) }
 160     trait_of_item => { cdata.get_trait_of_item(def_id.index) }
 161     const_is_rvalue_promotable_to_static => {
 162         cdata.const_is_rvalue_promotable_to_static(def_id.index)
 163     }
 164     is_mir_available => { cdata.is_item_mir_available(def_id.index) }
 165
 166     dylib_dependency_formats => { cdata.get_dylib_dependency_formats(tcx) }
 167     is_panic_runtime => { cdata.root.panic_runtime }
 168     is_compiler_builtins => { cdata.root.compiler_builtins }
 169     has_global_allocator => { cdata.root.has_global_allocator }
 170     has_panic_handler => { cdata.root.has_panic_handler }
 171     is_sanitizer_runtime => { cdata.root.sanitizer_runtime }
 172     is_profiler_runtime => { cdata.root.profiler_runtime }
 173     panic_strategy => { cdata.root.panic_strategy }
 174     extern_crate => {
 175         let r = *cdata.extern_crate.lock();
 176         r.map(|c| &*tcx.arena.alloc(c))
 177     }
 178     is_no_builtins => { cdata.root.no_builtins }
 179     impl_defaultness => { cdata.get_impl_defaultness(def_id.index) }
 180     reachable_non_generics => {
 181         let reachable_non_generics = tcx
 182             .exported_symbols(cdata.cnum)
 183             .iter()
 184             .filter_map(|&(exported_symbol, export_level)| {
 185                 if let ExportedSymbol::NonGeneric(def_id) = exported_symbol {
 186                     return Some((def_id, export_level))
 187                 } else {
 188                     None
 189                 }
 190             })
 191             .collect();
 192
 193         tcx.arena.alloc(reachable_non_generics)
 194     }
 195     native_libraries => { Lrc::new(cdata.get_native_libraries(tcx.sess)) }
 196     foreign_modules => { cdata.get_foreign_modules(tcx) }
 197     plugin_registrar_fn => {
 198         cdata.root.plugin_registrar_fn.map(|index| {
 199             DefId { krate: def_id.krate, index }
 200         })
 201     }
 202     proc_macro_decls_static => {
 203         cdata.root.proc_macro_decls_static.map(|index| {
 204             DefId { krate: def_id.krate, index }
 205         })
 206     }
 207     crate_disambiguator => { cdata.root.disambiguator }
 208     crate_hash => { cdata.root.hash }
 209     original_crate_name => { cdata.root.name }
 210
 211     extra_filename => { cdata.root.extra_filename.clone() }
 212
 213     implementations_of_trait => {
 214         cdata.get_implementations_for_trait(tcx, Some(other))
 215     }
 216
 217     all_trait_implementations => {
 218         cdata.get_implementations_for_trait(tcx, None)
 219     }
 220
 221     visibility => { cdata.get_visibility(def_id.index) }
 222     dep_kind => {
 223         let r = *cdata.dep_kind.lock();
 224         r
 225     }
 226     crate_name => { cdata.name }
 227     item_children => {
 228         let mut result = SmallVec::<[_; 8]>::new();
 229         cdata.each_child_of_item(def_id.index, |child| result.push(child), tcx.sess);
 230         tcx.arena.alloc_slice(&result)
 231     }
 232     defined_lib_features => { cdata.get_lib_features(tcx) }
 233     defined_lang_items => { cdata.get_lang_items(tcx) }
 234     missing_lang_items => { cdata.get_missing_lang_items(tcx) }
 235
 236     missing_extern_crate_item => {
 237         let r = match *cdata.extern_crate.borrow() {
 238             Some(extern_crate) if !extern_crate.direct => true,
 239             _ => false,
 240         };
 241         r
 242     }
 243
 244     used_crate_source => { Lrc::new(cdata.source.clone()) }
 245
 246     exported_symbols => { Arc::new(cdata.exported_symbols(tcx)) }
 247 }
 248
 249 pub fn provide<'tcx>(providers: &mut Providers<'tcx>) {
 250     // FIXME(#44234) - almost all of these queries have no sub-queries and
 251     // therefore no actual inputs, they're just reading tables calculated in
 252     // resolve! Does this work? Unsure! That's what the issue is about
 253     *providers = Providers {
 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(|lib| {
 269                     let fm_id = match lib.foreign_module {
 270                         Some(id) => id,
 271                         None => return false,
 272                     };
 273                     tcx.foreign_modules(id.krate)
 274                         .iter()
 275                         .find(|m| m.def_id == fm_id)
 276                         .expect("failed to find foreign module")
 277                         .foreign_items
 278                         .contains(&id)
 279                 })
 280                 .map(|l| l.kind)
 281         },
 282         native_libraries: |tcx, cnum| {
 283             assert_eq!(cnum, LOCAL_CRATE);
 284             Lrc::new(native_libs::collect(tcx))
 285         },
 286         foreign_modules: |tcx, cnum| {
 287             assert_eq!(cnum, LOCAL_CRATE);
 288             &tcx.arena.alloc(foreign_modules::collect(tcx))[..]
 289         },
 290         link_args: |tcx, cnum| {
 291             assert_eq!(cnum, LOCAL_CRATE);
 292             Lrc::new(link_args::collect(tcx))
 293         },
 294
 295         // Returns a map from a sufficiently visible external item (i.e., an
 296         // external item that is visible from at least one local module) to a
 297         // sufficiently visible parent (considering modules that re-export the
 298         // external item to be parents).
 299         visible_parent_map: |tcx, cnum| {
 300             use std::collections::vec_deque::VecDeque;
 301             use std::collections::hash_map::Entry;
 302
 303             assert_eq!(cnum, LOCAL_CRATE);
 304             let mut visible_parent_map: DefIdMap<DefId> = Default::default();
 305
 306             // Issue 46112: We want the map to prefer the shortest
 307             // paths when reporting the path to an item. Therefore we
 308             // build up the map via a breadth-first search (BFS),
 309             // which naturally yields minimal-length paths.
 310             //
 311             // Note that it needs to be a BFS over the whole forest of
 312             // crates, not just each individual crate; otherwise you
 313             // only get paths that are locally minimal with respect to
 314             // whatever crate we happened to encounter first in this
 315             // traversal, but not globally minimal across all crates.
 316             let bfs_queue = &mut VecDeque::new();
 317
 318             // Preferring shortest paths alone does not guarantee a
 319             // deterministic result; so sort by crate num to avoid
 320             // hashtable iteration non-determinism. This only makes
 321             // things as deterministic as crate-nums assignment is,
 322             // which is to say, its not deterministic in general. But
 323             // we believe that libstd is consistently assigned crate
 324             // num 1, so it should be enough to resolve #46112.
 325             let mut crates: Vec<CrateNum> = (*tcx.crates()).to_owned();
 326             crates.sort();
 327
 328             for &cnum in crates.iter() {
 329                 // Ignore crates without a corresponding local `extern crate` item.
 330                 if tcx.missing_extern_crate_item(cnum) {
 331                     continue
 332                 }
 333
 334                 bfs_queue.push_back(DefId {
 335                     krate: cnum,
 336                     index: CRATE_DEF_INDEX
 337                 });
 338             }
 339
 340             // (restrict scope of mutable-borrow of `visible_parent_map`)
 341             {
 342                 let visible_parent_map = &mut visible_parent_map;
 343                 let mut add_child = |bfs_queue: &mut VecDeque<_>,
 344                                      child: &def::Export<hir::HirId>,
 345                                      parent: DefId| {
 346                     if child.vis != ty::Visibility::Public {
 347                         return;
 348                     }
 349
 350                     if let Some(child) = child.res.opt_def_id() {
 351                         match visible_parent_map.entry(child) {
 352                             Entry::Occupied(mut entry) => {
 353                                 // If `child` is defined in crate `cnum`, ensure
 354                                 // that it is mapped to a parent in `cnum`.
 355                                 if child.krate == cnum && entry.get().krate != cnum {
 356                                     entry.insert(parent);
 357                                 }
 358                             }
 359                             Entry::Vacant(entry) => {
 360                                 entry.insert(parent);
 361                                 bfs_queue.push_back(child);
 362                             }
 363                         }
 364                     }
 365                 };
 366
 367                 while let Some(def) = bfs_queue.pop_front() {
 368                     for child in tcx.item_children(def).iter() {
 369                         add_child(bfs_queue, child, def);
 370                     }
 371                 }
 372             }
 373
 374             tcx.arena.alloc(visible_parent_map)
 375         },
 376
 377         ..*providers
 378     };
 379 }
 380
 381 impl cstore::CStore {
 382     pub fn export_macros_untracked(&self, cnum: CrateNum) {
 383         let data = self.get_crate_data(cnum);
 384         let mut dep_kind = data.dep_kind.lock();
 385         if *dep_kind == DepKind::UnexportedMacrosOnly {
 386             *dep_kind = DepKind::MacrosOnly;
 387         }
 388     }
 389
 390     pub fn dep_kind_untracked(&self, cnum: CrateNum) -> DepKind {
 391         let data = self.get_crate_data(cnum);
 392         let r = *data.dep_kind.lock();
 393         r
 394     }
 395
 396     pub fn crate_edition_untracked(&self, cnum: CrateNum) -> Edition {
 397         self.get_crate_data(cnum).root.edition
 398     }
 399
 400     pub fn struct_field_names_untracked(&self, def: DefId) -> Vec<ast::Name> {
 401         self.get_crate_data(def.krate).get_struct_field_names(def.index)
 402     }
 403
 404     pub fn ctor_kind_untracked(&self, def: DefId) -> def::CtorKind {
 405         self.get_crate_data(def.krate).get_ctor_kind(def.index)
 406     }
 407
 408     pub fn item_attrs_untracked(&self, def: DefId, sess: &Session) -> Lrc<[ast::Attribute]> {
 409         self.get_crate_data(def.krate).get_item_attrs(def.index, sess)
 410     }
 411
 412     pub fn item_children_untracked(
 413         &self,
 414         def_id: DefId,
 415         sess: &Session
 416     ) -> Vec<def::Export<hir::HirId>> {
 417         let mut result = vec![];
 418         self.get_crate_data(def_id.krate)
 419             .each_child_of_item(def_id.index, |child| result.push(child), sess);
 420         result
 421     }
 422
 423     pub fn load_macro_untracked(&self, id: DefId, sess: &Session) -> LoadedMacro {
 424         let data = self.get_crate_data(id.krate);
 425         if let Some(ref proc_macros) = data.proc_macros {
 426             return LoadedMacro::ProcMacro(proc_macros[id.index.to_proc_macro_index()].1.clone());
 427         } else if data.name == sym::proc_macro && data.item_name(id.index) == sym::quote {
 428             use syntax::ext::base::SyntaxExtension;
 429             use syntax_ext::proc_macro_impl::BangProcMacro;
 430
 431             let client = proc_macro::bridge::client::Client::expand1(proc_macro::quote);
 432             let ext = SyntaxExtension::ProcMacro {
 433                 expander: Box::new(BangProcMacro { client }),
 434                 allow_internal_unstable: Some(vec![sym::proc_macro_def_site].into()),
 435                 edition: data.root.edition,
 436             };
 437             return LoadedMacro::ProcMacro(Lrc::new(ext));
 438         }
 439
 440         let def = data.get_macro(id.index);
 441         let macro_full_name = data.def_path(id.index).to_string_friendly(|_| data.imported_name);
 442         let source_name = FileName::Macros(macro_full_name);
 443
 444         let source_file = sess.parse_sess.source_map().new_source_file(source_name, def.body);
 445         let local_span = Span::new(source_file.start_pos, source_file.end_pos, NO_EXPANSION);
 446         let (body, mut errors) = source_file_to_stream(&sess.parse_sess, source_file, None);
 447         emit_unclosed_delims(&mut errors, &sess.diagnostic());
 448
 449         // Mark the attrs as used
 450         let attrs = data.get_item_attrs(id.index, sess);
 451         for attr in attrs.iter() {
 452             attr::mark_used(attr);
 453         }
 454
 455         let name = data.def_key(id.index).disambiguated_data.data
 456             .get_opt_name().expect("no name in load_macro");
 457         sess.imported_macro_spans.borrow_mut()
 458             .insert(local_span, (name.to_string(), data.get_span(id.index, sess)));
 459
 460         LoadedMacro::MacroDef(ast::Item {
 461             ident: ast::Ident::from_str(&name.as_str()),
 462             id: ast::DUMMY_NODE_ID,
 463             span: local_span,
 464             attrs: attrs.iter().cloned().collect(),
 465             node: ast::ItemKind::MacroDef(ast::MacroDef {
 466                 tokens: body.into(),
 467                 legacy: def.legacy,
 468             }),
 469             vis: source_map::respan(local_span.shrink_to_lo(), ast::VisibilityKind::Inherited),
 470             tokens: None,
 471         })
 472     }
 473
 474     pub fn associated_item_cloned_untracked(&self, def: DefId) -> ty::AssociatedItem {
 475         self.get_crate_data(def.krate).get_associated_item(def.index)
 476     }
 477 }
 478
 479 impl CrateStore for cstore::CStore {
 480     fn crate_data_as_rc_any(&self, krate: CrateNum) -> Lrc<dyn Any> {
 481         self.get_crate_data(krate)
 482     }
 483
 484     fn item_generics_cloned_untracked(&self, def: DefId, sess: &Session) -> ty::Generics {
 485         self.get_crate_data(def.krate).get_generics(def.index, sess)
 486     }
 487
 488     fn crate_name_untracked(&self, cnum: CrateNum) -> Symbol
 489     {
 490         self.get_crate_data(cnum).name
 491     }
 492
 493     fn crate_is_private_dep_untracked(&self, cnum: CrateNum) -> bool {
 494         self.get_crate_data(cnum).private_dep
 495     }
 496
 497     fn crate_disambiguator_untracked(&self, cnum: CrateNum) -> CrateDisambiguator
 498     {
 499         self.get_crate_data(cnum).root.disambiguator
 500     }
 501
 502     fn crate_hash_untracked(&self, cnum: CrateNum) -> Svh
 503     {
 504         self.get_crate_data(cnum).root.hash
 505     }
 506
 507     /// Returns the `DefKey` for a given `DefId`. This indicates the
 508     /// parent `DefId` as well as some idea of what kind of data the
 509     /// `DefId` refers to.
 510     fn def_key(&self, def: DefId) -> DefKey {
 511         // Note: loading the def-key (or def-path) for a def-id is not
 512         // a *read* of its metadata. This is because the def-id is
 513         // really just an interned shorthand for a def-path, which is the
 514         // canonical name for an item.
 515         //
 516         // self.dep_graph.read(DepNode::MetaData(def));
 517         self.get_crate_data(def.krate).def_key(def.index)
 518     }
 519
 520     fn def_path(&self, def: DefId) -> DefPath {
 521         // See `Note` above in `def_key()` for why this read is
 522         // commented out:
 523         //
 524         // self.dep_graph.read(DepNode::MetaData(def));
 525         self.get_crate_data(def.krate).def_path(def.index)
 526     }
 527
 528     fn def_path_hash(&self, def: DefId) -> DefPathHash {
 529         self.get_crate_data(def.krate).def_path_hash(def.index)
 530     }
 531
 532     fn def_path_table(&self, cnum: CrateNum) -> Lrc<DefPathTable> {
 533         self.get_crate_data(cnum).def_path_table.clone()
 534     }
 535
 536     fn crates_untracked(&self) -> Vec<CrateNum>
 537     {
 538         let mut result = vec![];
 539         self.iter_crate_data(|cnum, _| result.push(cnum));
 540         result
 541     }
 542
 543     fn extern_mod_stmt_cnum_untracked(&self, emod_id: ast::NodeId) -> Option<CrateNum>
 544     {
 545         self.do_extern_mod_stmt_cnum(emod_id)
 546     }
 547
 548     fn postorder_cnums_untracked(&self) -> Vec<CrateNum> {
 549         self.do_postorder_cnums_untracked()
 550     }
 551
 552     fn encode_metadata<'a, 'tcx>(&self,
 553                                  tcx: TyCtxt<'a, 'tcx, 'tcx>)
 554                                  -> EncodedMetadata
 555     {
 556         encoder::encode_metadata(tcx)
 557     }
 558
 559     fn metadata_encoding_version(&self) -> &[u8]
 560     {
 561         schema::METADATA_HEADER
 562     }
 563 }