src/librustc_metadata/cstore_impl.rs

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