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