compiler/rustc_metadata/src/creader.rs

   1 //! Validates all used crates and extern libraries and loads their metadata
   2
   3 use crate::dynamic_lib::DynamicLibrary;
   4 use crate::locator::{CrateError, CrateLocator, CratePaths};
   5 use crate::rmeta::{CrateDep, CrateMetadata, CrateNumMap, CrateRoot, MetadataBlob};
   6
   7 use rustc_ast::expand::allocator::AllocatorKind;
   8 use rustc_ast::{self as ast, *};
   9 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  10 use rustc_data_structures::svh::Svh;
  11 use rustc_data_structures::sync::Lrc;
  12 use rustc_expand::base::SyntaxExtension;
  13 use rustc_hir::def_id::{CrateNum, LocalDefId, StableCrateId, LOCAL_CRATE};
  14 use rustc_hir::definitions::Definitions;
  15 use rustc_index::vec::IndexVec;
  16 use rustc_middle::ty::TyCtxt;
  17 use rustc_serialize::json::ToJson;
  18 use rustc_session::config::{self, CrateType, ExternLocation};
  19 use rustc_session::cstore::{CrateDepKind, CrateSource, ExternCrate};
  20 use rustc_session::cstore::{ExternCrateSource, MetadataLoaderDyn};
  21 use rustc_session::lint::{self, BuiltinLintDiagnostics, ExternDepSpec};
  22 use rustc_session::output::validate_crate_name;
  23 use rustc_session::search_paths::PathKind;
  24 use rustc_session::Session;
  25 use rustc_span::edition::Edition;
  26 use rustc_span::symbol::{sym, Symbol};
  27 use rustc_span::{Span, DUMMY_SP};
  28 use rustc_target::spec::{PanicStrategy, TargetTriple};
  29
  30 use proc_macro::bridge::client::ProcMacro;
  31 use std::collections::BTreeMap;
  32 use std::path::Path;
  33 use std::{cmp, env};
  34 use tracing::{debug, info};
  35
  36 #[derive(Clone)]
  37 pub struct CStore {
  38     metas: IndexVec<CrateNum, Option<Lrc<CrateMetadata>>>,
  39     injected_panic_runtime: Option<CrateNum>,
  40     /// This crate needs an allocator and either provides it itself, or finds it in a dependency.
  41     /// If the above is true, then this field denotes the kind of the found allocator.
  42     allocator_kind: Option<AllocatorKind>,
  43     /// This crate has a `#[global_allocator]` item.
  44     has_global_allocator: bool,
  45
  46     /// This map is used to verify we get no hash conflicts between
  47     /// `StableCrateId` values.
  48     pub(crate) stable_crate_ids: FxHashMap<StableCrateId, CrateNum>,
  49
  50     /// Unused externs of the crate
  51     unused_externs: Vec<Symbol>,
  52 }
  53
  54 impl std::fmt::Debug for CStore {
  55     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
  56         f.debug_struct("CStore").finish_non_exhaustive()
  57     }
  58 }
  59
  60 pub struct CrateLoader<'a> {
  61     // Immutable configuration.
  62     sess: &'a Session,
  63     metadata_loader: Box<MetadataLoaderDyn>,
  64     local_crate_name: Symbol,
  65     // Mutable output.
  66     cstore: CStore,
  67     used_extern_options: FxHashSet<Symbol>,
  68 }
  69
  70 pub enum LoadedMacro {
  71     MacroDef(ast::Item, Edition),
  72     ProcMacro(SyntaxExtension),
  73 }
  74
  75 crate struct Library {
  76     pub source: CrateSource,
  77     pub metadata: MetadataBlob,
  78 }
  79
  80 enum LoadResult {
  81     Previous(CrateNum),
  82     Loaded(Library),
  83 }
  84
  85 /// A reference to `CrateMetadata` that can also give access to whole crate store when necessary.
  86 #[derive(Clone, Copy)]
  87 crate struct CrateMetadataRef<'a> {
  88     pub cdata: &'a CrateMetadata,
  89     pub cstore: &'a CStore,
  90 }
  91
  92 impl std::ops::Deref for CrateMetadataRef<'_> {
  93     type Target = CrateMetadata;
  94
  95     fn deref(&self) -> &Self::Target {
  96         self.cdata
  97     }
  98 }
  99
 100 struct CrateDump<'a>(&'a CStore);
 101
 102 impl<'a> std::fmt::Debug for CrateDump<'a> {
 103     fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 104         writeln!(fmt, "resolved crates:")?;
 105         // `iter_crate_data` does not allow returning values. Thus we use a mutable variable here
 106         // that aggregates the value (and any errors that could happen).
 107         let mut res = Ok(());
 108         self.0.iter_crate_data(|cnum, data| {
 109             res = res.and(
 110                 try {
 111                     writeln!(fmt, "  name: {}", data.name())?;
 112                     writeln!(fmt, "  cnum: {}", cnum)?;
 113                     writeln!(fmt, "  hash: {}", data.hash())?;
 114                     writeln!(fmt, "  reqd: {:?}", data.dep_kind())?;
 115                     let CrateSource { dylib, rlib, rmeta } = data.source();
 116                     if let Some(dylib) = dylib {
 117                         writeln!(fmt, "  dylib: {}", dylib.0.display())?;
 118                     }
 119                     if let Some(rlib) = rlib {
 120                         writeln!(fmt, "   rlib: {}", rlib.0.display())?;
 121                     }
 122                     if let Some(rmeta) = rmeta {
 123                         writeln!(fmt, "   rmeta: {}", rmeta.0.display())?;
 124                     }
 125                 },
 126             );
 127         });
 128         res
 129     }
 130 }
 131
 132 impl CStore {
 133     pub fn from_tcx(tcx: TyCtxt<'_>) -> &CStore {
 134         tcx.cstore_untracked()
 135             .as_any()
 136             .downcast_ref::<CStore>()
 137             .expect("`tcx.cstore` is not a `CStore`")
 138     }
 139
 140     fn alloc_new_crate_num(&mut self) -> CrateNum {
 141         self.metas.push(None);
 142         CrateNum::new(self.metas.len() - 1)
 143     }
 144
 145     crate fn get_crate_data(&self, cnum: CrateNum) -> CrateMetadataRef<'_> {
 146         let cdata = self.metas[cnum]
 147             .as_ref()
 148             .unwrap_or_else(|| panic!("Failed to get crate data for {:?}", cnum));
 149         CrateMetadataRef { cdata, cstore: self }
 150     }
 151
 152     fn set_crate_data(&mut self, cnum: CrateNum, data: CrateMetadata) {
 153         assert!(self.metas[cnum].is_none(), "Overwriting crate metadata entry");
 154         self.metas[cnum] = Some(Lrc::new(data));
 155     }
 156
 157     crate fn iter_crate_data(&self, mut f: impl FnMut(CrateNum, &CrateMetadata)) {
 158         for (cnum, data) in self.metas.iter_enumerated() {
 159             if let Some(data) = data {
 160                 f(cnum, data);
 161             }
 162         }
 163     }
 164
 165     fn push_dependencies_in_postorder(&self, deps: &mut Vec<CrateNum>, cnum: CrateNum) {
 166         if !deps.contains(&cnum) {
 167             let data = self.get_crate_data(cnum);
 168             for &dep in data.dependencies().iter() {
 169                 if dep != cnum {
 170                     self.push_dependencies_in_postorder(deps, dep);
 171                 }
 172             }
 173
 174             deps.push(cnum);
 175         }
 176     }
 177
 178     crate fn crate_dependencies_in_postorder(&self, cnum: CrateNum) -> Vec<CrateNum> {
 179         let mut deps = Vec::new();
 180         if cnum == LOCAL_CRATE {
 181             self.iter_crate_data(|cnum, _| self.push_dependencies_in_postorder(&mut deps, cnum));
 182         } else {
 183             self.push_dependencies_in_postorder(&mut deps, cnum);
 184         }
 185         deps
 186     }
 187
 188     fn crate_dependencies_in_reverse_postorder(&self, cnum: CrateNum) -> Vec<CrateNum> {
 189         let mut deps = self.crate_dependencies_in_postorder(cnum);
 190         deps.reverse();
 191         deps
 192     }
 193
 194     crate fn injected_panic_runtime(&self) -> Option<CrateNum> {
 195         self.injected_panic_runtime
 196     }
 197
 198     crate fn allocator_kind(&self) -> Option<AllocatorKind> {
 199         self.allocator_kind
 200     }
 201
 202     crate fn has_global_allocator(&self) -> bool {
 203         self.has_global_allocator
 204     }
 205
 206     pub fn report_unused_deps(&self, tcx: TyCtxt<'_>) {
 207         // We put the check for the option before the lint_level_at_node call
 208         // because the call mutates internal state and introducing it
 209         // leads to some ui tests failing.
 210         if !tcx.sess.opts.json_unused_externs {
 211             return;
 212         }
 213         let level = tcx
 214             .lint_level_at_node(lint::builtin::UNUSED_CRATE_DEPENDENCIES, rustc_hir::CRATE_HIR_ID)
 215             .0;
 216         if level != lint::Level::Allow {
 217             let unused_externs =
 218                 self.unused_externs.iter().map(|ident| ident.to_ident_string()).collect::<Vec<_>>();
 219             let unused_externs = unused_externs.iter().map(String::as_str).collect::<Vec<&str>>();
 220             tcx.sess
 221                 .parse_sess
 222                 .span_diagnostic
 223                 .emit_unused_externs(level.as_str(), &unused_externs);
 224         }
 225     }
 226 }
 227
 228 impl<'a> CrateLoader<'a> {
 229     pub fn new(
 230         sess: &'a Session,
 231         metadata_loader: Box<MetadataLoaderDyn>,
 232         local_crate_name: &str,
 233     ) -> Self {
 234         let mut stable_crate_ids = FxHashMap::default();
 235         stable_crate_ids.insert(sess.local_stable_crate_id(), LOCAL_CRATE);
 236
 237         CrateLoader {
 238             sess,
 239             metadata_loader,
 240             local_crate_name: Symbol::intern(local_crate_name),
 241             cstore: CStore {
 242                 // We add an empty entry for LOCAL_CRATE (which maps to zero) in
 243                 // order to make array indices in `metas` match with the
 244                 // corresponding `CrateNum`. This first entry will always remain
 245                 // `None`.
 246                 metas: IndexVec::from_elem_n(None, 1),
 247                 injected_panic_runtime: None,
 248                 allocator_kind: None,
 249                 has_global_allocator: false,
 250                 stable_crate_ids,
 251                 unused_externs: Vec::new(),
 252             },
 253             used_extern_options: Default::default(),
 254         }
 255     }
 256
 257     pub fn cstore(&self) -> &CStore {
 258         &self.cstore
 259     }
 260
 261     pub fn into_cstore(self) -> CStore {
 262         self.cstore
 263     }
 264
 265     fn existing_match(&self, name: Symbol, hash: Option<Svh>, kind: PathKind) -> Option<CrateNum> {
 266         let mut ret = None;
 267         self.cstore.iter_crate_data(|cnum, data| {
 268             if data.name() != name {
 269                 tracing::trace!("{} did not match {}", data.name(), name);
 270                 return;
 271             }
 272
 273             match hash {
 274                 Some(hash) if hash == data.hash() => {
 275                     ret = Some(cnum);
 276                     return;
 277                 }
 278                 Some(hash) => {
 279                     debug!("actual hash {} did not match expected {}", hash, data.hash());
 280                     return;
 281                 }
 282                 None => {}
 283             }
 284
 285             // When the hash is None we're dealing with a top-level dependency
 286             // in which case we may have a specification on the command line for
 287             // this library. Even though an upstream library may have loaded
 288             // something of the same name, we have to make sure it was loaded
 289             // from the exact same location as well.
 290             //
 291             // We're also sure to compare *paths*, not actual byte slices. The
 292             // `source` stores paths which are normalized which may be different
 293             // from the strings on the command line.
 294             let source = self.cstore.get_crate_data(cnum).cdata.source();
 295             if let Some(entry) = self.sess.opts.externs.get(&name.as_str()) {
 296                 // Only use `--extern crate_name=path` here, not `--extern crate_name`.
 297                 if let Some(mut files) = entry.files() {
 298                     if files.any(|l| {
 299                         let l = l.canonicalized();
 300                         source.dylib.as_ref().map(|(p, _)| p) == Some(l)
 301                             || source.rlib.as_ref().map(|(p, _)| p) == Some(l)
 302                             || source.rmeta.as_ref().map(|(p, _)| p) == Some(l)
 303                     }) {
 304                         ret = Some(cnum);
 305                     }
 306                 }
 307                 return;
 308             }
 309
 310             // Alright, so we've gotten this far which means that `data` has the
 311             // right name, we don't have a hash, and we don't have a --extern
 312             // pointing for ourselves. We're still not quite yet done because we
 313             // have to make sure that this crate was found in the crate lookup
 314             // path (this is a top-level dependency) as we don't want to
 315             // implicitly load anything inside the dependency lookup path.
 316             let prev_kind = source
 317                 .dylib
 318                 .as_ref()
 319                 .or(source.rlib.as_ref())
 320                 .or(source.rmeta.as_ref())
 321                 .expect("No sources for crate")
 322                 .1;
 323             if kind.matches(prev_kind) {
 324                 ret = Some(cnum);
 325             } else {
 326                 debug!(
 327                     "failed to load existing crate {}; kind {:?} did not match prev_kind {:?}",
 328                     name, kind, prev_kind
 329                 );
 330             }
 331         });
 332         ret
 333     }
 334
 335     fn verify_no_symbol_conflicts(&self, root: &CrateRoot<'_>) -> Result<(), CrateError> {
 336         // Check for (potential) conflicts with the local crate
 337         if self.sess.local_stable_crate_id() == root.stable_crate_id() {
 338             return Err(CrateError::SymbolConflictsCurrent(root.name()));
 339         }
 340
 341         // Check for conflicts with any crate loaded so far
 342         let mut res = Ok(());
 343         self.cstore.iter_crate_data(|_, other| {
 344             if other.stable_crate_id() == root.stable_crate_id() && // same stable crate id
 345                other.hash() != root.hash()
 346             {
 347                 // but different SVH
 348                 res = Err(CrateError::SymbolConflictsOthers(root.name()));
 349             }
 350         });
 351
 352         res
 353     }
 354
 355     fn verify_no_stable_crate_id_hash_conflicts(
 356         &mut self,
 357         root: &CrateRoot<'_>,
 358         cnum: CrateNum,
 359     ) -> Result<(), CrateError> {
 360         if let Some(existing) = self.cstore.stable_crate_ids.insert(root.stable_crate_id(), cnum) {
 361             let crate_name0 = root.name();
 362             let crate_name1 = self.cstore.get_crate_data(existing).name();
 363             return Err(CrateError::StableCrateIdCollision(crate_name0, crate_name1));
 364         }
 365
 366         Ok(())
 367     }
 368
 369     fn register_crate(
 370         &mut self,
 371         host_lib: Option<Library>,
 372         root: Option<&CratePaths>,
 373         lib: Library,
 374         dep_kind: CrateDepKind,
 375         name: Symbol,
 376     ) -> Result<CrateNum, CrateError> {
 377         let _prof_timer = self.sess.prof.generic_activity("metadata_register_crate");
 378
 379         let Library { source, metadata } = lib;
 380         let crate_root = metadata.get_root();
 381         let host_hash = host_lib.as_ref().map(|lib| lib.metadata.get_root().hash());
 382
 383         let private_dep =
 384             self.sess.opts.externs.get(&name.as_str()).map_or(false, |e| e.is_private_dep);
 385
 386         // Claim this crate number and cache it
 387         let cnum = self.cstore.alloc_new_crate_num();
 388
 389         info!(
 390             "register crate `{}` (cnum = {}. private_dep = {})",
 391             crate_root.name(),
 392             cnum,
 393             private_dep
 394         );
 395
 396         // Maintain a reference to the top most crate.
 397         // Stash paths for top-most crate locally if necessary.
 398         let crate_paths;
 399         let root = if let Some(root) = root {
 400             root
 401         } else {
 402             crate_paths = CratePaths::new(crate_root.name(), source.clone());
 403             &crate_paths
 404         };
 405
 406         let cnum_map = self.resolve_crate_deps(root, &crate_root, &metadata, cnum, dep_kind)?;
 407
 408         let raw_proc_macros = if crate_root.is_proc_macro_crate() {
 409             let temp_root;
 410             let (dlsym_source, dlsym_root) = match &host_lib {
 411                 Some(host_lib) => (&host_lib.source, {
 412                     temp_root = host_lib.metadata.get_root();
 413                     &temp_root
 414                 }),
 415                 None => (&source, &crate_root),
 416             };
 417             let dlsym_dylib = dlsym_source.dylib.as_ref().expect("no dylib for a proc-macro crate");
 418             Some(self.dlsym_proc_macros(&dlsym_dylib.0, dlsym_root.stable_crate_id())?)
 419         } else {
 420             None
 421         };
 422
 423         // Perform some verification *after* resolve_crate_deps() above is
 424         // known to have been successful. It seems that - in error cases - the
 425         // cstore can be in a temporarily invalid state between cnum allocation
 426         // and dependency resolution and the verification code would produce
 427         // ICEs in that case (see #83045).
 428         self.verify_no_symbol_conflicts(&crate_root)?;
 429         self.verify_no_stable_crate_id_hash_conflicts(&crate_root, cnum)?;
 430
 431         let crate_metadata = CrateMetadata::new(
 432             self.sess,
 433             metadata,
 434             crate_root,
 435             raw_proc_macros,
 436             cnum,
 437             cnum_map,
 438             dep_kind,
 439             source,
 440             private_dep,
 441             host_hash,
 442         );
 443
 444         self.cstore.set_crate_data(cnum, crate_metadata);
 445
 446         Ok(cnum)
 447     }
 448
 449     fn load_proc_macro<'b>(
 450         &self,
 451         locator: &mut CrateLocator<'b>,
 452         path_kind: PathKind,
 453         host_hash: Option<Svh>,
 454     ) -> Result<Option<(LoadResult, Option<Library>)>, CrateError>
 455     where
 456         'a: 'b,
 457     {
 458         // Use a new crate locator so trying to load a proc macro doesn't affect the error
 459         // message we emit
 460         let mut proc_macro_locator = locator.clone();
 461
 462         // Try to load a proc macro
 463         proc_macro_locator.is_proc_macro = true;
 464
 465         // Load the proc macro crate for the target
 466         let (locator, target_result) = if self.sess.opts.debugging_opts.dual_proc_macros {
 467             proc_macro_locator.reset();
 468             let result = match self.load(&mut proc_macro_locator)? {
 469                 Some(LoadResult::Previous(cnum)) => {
 470                     return Ok(Some((LoadResult::Previous(cnum), None)));
 471                 }
 472                 Some(LoadResult::Loaded(library)) => Some(LoadResult::Loaded(library)),
 473                 None => return Ok(None),
 474             };
 475             locator.hash = host_hash;
 476             // Use the locator when looking for the host proc macro crate, as that is required
 477             // so we want it to affect the error message
 478             (locator, result)
 479         } else {
 480             (&mut proc_macro_locator, None)
 481         };
 482
 483         // Load the proc macro crate for the host
 484
 485         locator.reset();
 486         locator.is_proc_macro = true;
 487         locator.target = &self.sess.host;
 488         locator.triple = TargetTriple::from_triple(config::host_triple());
 489         locator.filesearch = self.sess.host_filesearch(path_kind);
 490
 491         let host_result = match self.load(locator)? {
 492             Some(host_result) => host_result,
 493             None => return Ok(None),
 494         };
 495
 496         Ok(Some(if self.sess.opts.debugging_opts.dual_proc_macros {
 497             let host_result = match host_result {
 498                 LoadResult::Previous(..) => {
 499                     panic!("host and target proc macros must be loaded in lock-step")
 500                 }
 501                 LoadResult::Loaded(library) => library,
 502             };
 503             (target_result.unwrap(), Some(host_result))
 504         } else {
 505             (host_result, None)
 506         }))
 507     }
 508
 509     fn resolve_crate<'b>(
 510         &'b mut self,
 511         name: Symbol,
 512         span: Span,
 513         dep_kind: CrateDepKind,
 514     ) -> CrateNum {
 515         self.used_extern_options.insert(name);
 516         self.maybe_resolve_crate(name, dep_kind, None).unwrap_or_else(|err| {
 517             let missing_core =
 518                 self.maybe_resolve_crate(sym::core, CrateDepKind::Explicit, None).is_err();
 519             err.report(&self.sess, span, missing_core)
 520         })
 521     }
 522
 523     fn maybe_resolve_crate<'b>(
 524         &'b mut self,
 525         name: Symbol,
 526         mut dep_kind: CrateDepKind,
 527         dep: Option<(&'b CratePaths, &'b CrateDep)>,
 528     ) -> Result<CrateNum, CrateError> {
 529         info!("resolving crate `{}`", name);
 530         if !name.as_str().is_ascii() {
 531             return Err(CrateError::NonAsciiName(name));
 532         }
 533         let (root, hash, host_hash, extra_filename, path_kind) = match dep {
 534             Some((root, dep)) => (
 535                 Some(root),
 536                 Some(dep.hash),
 537                 dep.host_hash,
 538                 Some(&dep.extra_filename[..]),
 539                 PathKind::Dependency,
 540             ),
 541             None => (None, None, None, None, PathKind::Crate),
 542         };
 543         let result = if let Some(cnum) = self.existing_match(name, hash, path_kind) {
 544             (LoadResult::Previous(cnum), None)
 545         } else {
 546             info!("falling back to a load");
 547             let mut locator = CrateLocator::new(
 548                 self.sess,
 549                 &*self.metadata_loader,
 550                 name,
 551                 hash,
 552                 extra_filename,
 553                 false, // is_host
 554                 path_kind,
 555             );
 556
 557             match self.load(&mut locator)? {
 558                 Some(res) => (res, None),
 559                 None => {
 560                     dep_kind = CrateDepKind::MacrosOnly;
 561                     match self.load_proc_macro(&mut locator, path_kind, host_hash)? {
 562                         Some(res) => res,
 563                         None => return Err(locator.into_error(root.cloned())),
 564                     }
 565                 }
 566             }
 567         };
 568
 569         match result {
 570             (LoadResult::Previous(cnum), None) => {
 571                 let data = self.cstore.get_crate_data(cnum);
 572                 if data.is_proc_macro_crate() {
 573                     dep_kind = CrateDepKind::MacrosOnly;
 574                 }
 575                 data.update_dep_kind(|data_dep_kind| cmp::max(data_dep_kind, dep_kind));
 576                 Ok(cnum)
 577             }
 578             (LoadResult::Loaded(library), host_library) => {
 579                 self.register_crate(host_library, root, library, dep_kind, name)
 580             }
 581             _ => panic!(),
 582         }
 583     }
 584
 585     fn load(&self, locator: &mut CrateLocator<'_>) -> Result<Option<LoadResult>, CrateError> {
 586         let library = match locator.maybe_load_library_crate()? {
 587             Some(library) => library,
 588             None => return Ok(None),
 589         };
 590
 591         // In the case that we're loading a crate, but not matching
 592         // against a hash, we could load a crate which has the same hash
 593         // as an already loaded crate. If this is the case prevent
 594         // duplicates by just using the first crate.
 595         //
 596         // Note that we only do this for target triple crates, though, as we
 597         // don't want to match a host crate against an equivalent target one
 598         // already loaded.
 599         let root = library.metadata.get_root();
 600         // FIXME: why is this condition necessary? It was adding in #33625 but I
 601         // don't know why and the original author doesn't remember ...
 602         let can_reuse_cratenum =
 603             locator.triple == self.sess.opts.target_triple || locator.is_proc_macro;
 604         Ok(Some(if can_reuse_cratenum {
 605             let mut result = LoadResult::Loaded(library);
 606             self.cstore.iter_crate_data(|cnum, data| {
 607                 if data.name() == root.name() && root.hash() == data.hash() {
 608                     assert!(locator.hash.is_none());
 609                     info!("load success, going to previous cnum: {}", cnum);
 610                     result = LoadResult::Previous(cnum);
 611                 }
 612             });
 613             result
 614         } else {
 615             LoadResult::Loaded(library)
 616         }))
 617     }
 618
 619     fn update_extern_crate(&self, cnum: CrateNum, extern_crate: ExternCrate) {
 620         let cmeta = self.cstore.get_crate_data(cnum);
 621         if cmeta.update_extern_crate(extern_crate) {
 622             // Propagate the extern crate info to dependencies if it was updated.
 623             let extern_crate = ExternCrate { dependency_of: cnum, ..extern_crate };
 624             for &dep_cnum in cmeta.dependencies().iter() {
 625                 self.update_extern_crate(dep_cnum, extern_crate);
 626             }
 627         }
 628     }
 629
 630     // Go through the crate metadata and load any crates that it references
 631     fn resolve_crate_deps(
 632         &mut self,
 633         root: &CratePaths,
 634         crate_root: &CrateRoot<'_>,
 635         metadata: &MetadataBlob,
 636         krate: CrateNum,
 637         dep_kind: CrateDepKind,
 638     ) -> Result<CrateNumMap, CrateError> {
 639         debug!("resolving deps of external crate");
 640         if crate_root.is_proc_macro_crate() {
 641             return Ok(CrateNumMap::new());
 642         }
 643
 644         // The map from crate numbers in the crate we're resolving to local crate numbers.
 645         // We map 0 and all other holes in the map to our parent crate. The "additional"
 646         // self-dependencies should be harmless.
 647         let deps = crate_root.decode_crate_deps(metadata);
 648         let mut crate_num_map = CrateNumMap::with_capacity(1 + deps.len());
 649         crate_num_map.push(krate);
 650         for dep in deps {
 651             info!(
 652                 "resolving dep crate {} hash: `{}` extra filename: `{}`",
 653                 dep.name, dep.hash, dep.extra_filename
 654             );
 655             let dep_kind = match dep_kind {
 656                 CrateDepKind::MacrosOnly => CrateDepKind::MacrosOnly,
 657                 _ => dep.kind,
 658             };
 659             let cnum = self.maybe_resolve_crate(dep.name, dep_kind, Some((root, &dep)))?;
 660             crate_num_map.push(cnum);
 661         }
 662
 663         debug!("resolve_crate_deps: cnum_map for {:?} is {:?}", krate, crate_num_map);
 664         Ok(crate_num_map)
 665     }
 666
 667     fn dlsym_proc_macros(
 668         &self,
 669         path: &Path,
 670         stable_crate_id: StableCrateId,
 671     ) -> Result<&'static [ProcMacro], CrateError> {
 672         // Make sure the path contains a / or the linker will search for it.
 673         let path = env::current_dir().unwrap().join(path);
 674         let lib = match DynamicLibrary::open(&path) {
 675             Ok(lib) => lib,
 676             Err(s) => return Err(CrateError::DlOpen(s)),
 677         };
 678
 679         let sym = self.sess.generate_proc_macro_decls_symbol(stable_crate_id);
 680         let decls = unsafe {
 681             let sym = match lib.symbol(&sym) {
 682                 Ok(f) => f,
 683                 Err(s) => return Err(CrateError::DlSym(s)),
 684             };
 685             *(sym as *const &[ProcMacro])
 686         };
 687
 688         // Intentionally leak the dynamic library. We can't ever unload it
 689         // since the library can make things that will live arbitrarily long.
 690         std::mem::forget(lib);
 691
 692         Ok(decls)
 693     }
 694
 695     fn inject_panic_runtime(&mut self, krate: &ast::Crate) {
 696         // If we're only compiling an rlib, then there's no need to select a
 697         // panic runtime, so we just skip this section entirely.
 698         let any_non_rlib = self.sess.crate_types().iter().any(|ct| *ct != CrateType::Rlib);
 699         if !any_non_rlib {
 700             info!("panic runtime injection skipped, only generating rlib");
 701             return;
 702         }
 703
 704         // If we need a panic runtime, we try to find an existing one here. At
 705         // the same time we perform some general validation of the DAG we've got
 706         // going such as ensuring everything has a compatible panic strategy.
 707         //
 708         // The logic for finding the panic runtime here is pretty much the same
 709         // as the allocator case with the only addition that the panic strategy
 710         // compilation mode also comes into play.
 711         let desired_strategy = self.sess.panic_strategy();
 712         let mut runtime_found = false;
 713         let mut needs_panic_runtime =
 714             self.sess.contains_name(&krate.attrs, sym::needs_panic_runtime);
 715
 716         self.cstore.iter_crate_data(|cnum, data| {
 717             needs_panic_runtime = needs_panic_runtime || data.needs_panic_runtime();
 718             if data.is_panic_runtime() {
 719                 // Inject a dependency from all #![needs_panic_runtime] to this
 720                 // #![panic_runtime] crate.
 721                 self.inject_dependency_if(cnum, "a panic runtime", &|data| {
 722                     data.needs_panic_runtime()
 723                 });
 724                 runtime_found = runtime_found || data.dep_kind() == CrateDepKind::Explicit;
 725             }
 726         });
 727
 728         // If an explicitly linked and matching panic runtime was found, or if
 729         // we just don't need one at all, then we're done here and there's
 730         // nothing else to do.
 731         if !needs_panic_runtime || runtime_found {
 732             return;
 733         }
 734
 735         // By this point we know that we (a) need a panic runtime and (b) no
 736         // panic runtime was explicitly linked. Here we just load an appropriate
 737         // default runtime for our panic strategy and then inject the
 738         // dependencies.
 739         //
 740         // We may resolve to an already loaded crate (as the crate may not have
 741         // been explicitly linked prior to this) and we may re-inject
 742         // dependencies again, but both of those situations are fine.
 743         //
 744         // Also note that we have yet to perform validation of the crate graph
 745         // in terms of everyone has a compatible panic runtime format, that's
 746         // performed later as part of the `dependency_format` module.
 747         let name = match desired_strategy {
 748             PanicStrategy::Unwind => sym::panic_unwind,
 749             PanicStrategy::Abort => sym::panic_abort,
 750         };
 751         info!("panic runtime not found -- loading {}", name);
 752
 753         let cnum = self.resolve_crate(name, DUMMY_SP, CrateDepKind::Implicit);
 754         let data = self.cstore.get_crate_data(cnum);
 755
 756         // Sanity check the loaded crate to ensure it is indeed a panic runtime
 757         // and the panic strategy is indeed what we thought it was.
 758         if !data.is_panic_runtime() {
 759             self.sess.err(&format!("the crate `{}` is not a panic runtime", name));
 760         }
 761         if data.panic_strategy() != desired_strategy {
 762             self.sess.err(&format!(
 763                 "the crate `{}` does not have the panic \
 764                                     strategy `{}`",
 765                 name,
 766                 desired_strategy.desc()
 767             ));
 768         }
 769
 770         self.cstore.injected_panic_runtime = Some(cnum);
 771         self.inject_dependency_if(cnum, "a panic runtime", &|data| data.needs_panic_runtime());
 772     }
 773
 774     fn inject_profiler_runtime(&mut self, krate: &ast::Crate) {
 775         if self.sess.opts.debugging_opts.no_profiler_runtime
 776             || !(self.sess.instrument_coverage()
 777                 || self.sess.opts.debugging_opts.profile
 778                 || self.sess.opts.cg.profile_generate.enabled())
 779         {
 780             return;
 781         }
 782
 783         info!("loading profiler");
 784
 785         let name = Symbol::intern(&self.sess.opts.debugging_opts.profiler_runtime);
 786         if name == sym::profiler_builtins && self.sess.contains_name(&krate.attrs, sym::no_core) {
 787             self.sess.err(
 788                 "`profiler_builtins` crate (required by compiler options) \
 789                         is not compatible with crate attribute `#![no_core]`",
 790             );
 791         }
 792
 793         let cnum = self.resolve_crate(name, DUMMY_SP, CrateDepKind::Implicit);
 794         let data = self.cstore.get_crate_data(cnum);
 795
 796         // Sanity check the loaded crate to ensure it is indeed a profiler runtime
 797         if !data.is_profiler_runtime() {
 798             self.sess.err(&format!("the crate `{}` is not a profiler runtime", name));
 799         }
 800     }
 801
 802     fn inject_allocator_crate(&mut self, krate: &ast::Crate) {
 803         self.cstore.has_global_allocator = match &*global_allocator_spans(&self.sess, krate) {
 804             [span1, span2, ..] => {
 805                 self.sess
 806                     .struct_span_err(*span2, "cannot define multiple global allocators")
 807                     .span_label(*span2, "cannot define a new global allocator")
 808                     .span_label(*span1, "previous global allocator defined here")
 809                     .emit();
 810                 true
 811             }
 812             spans => !spans.is_empty(),
 813         };
 814
 815         // Check to see if we actually need an allocator. This desire comes
 816         // about through the `#![needs_allocator]` attribute and is typically
 817         // written down in liballoc.
 818         let mut needs_allocator = self.sess.contains_name(&krate.attrs, sym::needs_allocator);
 819         self.cstore.iter_crate_data(|_, data| {
 820             needs_allocator = needs_allocator || data.needs_allocator();
 821         });
 822         if !needs_allocator {
 823             return;
 824         }
 825
 826         // At this point we've determined that we need an allocator. Let's see
 827         // if our compilation session actually needs an allocator based on what
 828         // we're emitting.
 829         let all_rlib = self.sess.crate_types().iter().all(|ct| matches!(*ct, CrateType::Rlib));
 830         if all_rlib {
 831             return;
 832         }
 833
 834         // Ok, we need an allocator. Not only that but we're actually going to
 835         // create an artifact that needs one linked in. Let's go find the one
 836         // that we're going to link in.
 837         //
 838         // First up we check for global allocators. Look at the crate graph here
 839         // and see what's a global allocator, including if we ourselves are a
 840         // global allocator.
 841         let mut global_allocator =
 842             self.cstore.has_global_allocator.then(|| Symbol::intern("this crate"));
 843         self.cstore.iter_crate_data(|_, data| {
 844             if !data.has_global_allocator() {
 845                 return;
 846             }
 847             match global_allocator {
 848                 Some(other_crate) => {
 849                     self.sess.err(&format!(
 850                         "the `#[global_allocator]` in {} \
 851                                             conflicts with global \
 852                                             allocator in: {}",
 853                         other_crate,
 854                         data.name()
 855                     ));
 856                 }
 857                 None => global_allocator = Some(data.name()),
 858             }
 859         });
 860         if global_allocator.is_some() {
 861             self.cstore.allocator_kind = Some(AllocatorKind::Global);
 862             return;
 863         }
 864
 865         // Ok we haven't found a global allocator but we still need an
 866         // allocator. At this point our allocator request is typically fulfilled
 867         // by the standard library, denoted by the `#![default_lib_allocator]`
 868         // attribute.
 869         let mut has_default = self.sess.contains_name(&krate.attrs, sym::default_lib_allocator);
 870         self.cstore.iter_crate_data(|_, data| {
 871             if data.has_default_lib_allocator() {
 872                 has_default = true;
 873             }
 874         });
 875
 876         if !has_default {
 877             self.sess.err(
 878                 "no global memory allocator found but one is \
 879                            required; link to std or \
 880                            add `#[global_allocator]` to a static item \
 881                            that implements the GlobalAlloc trait",
 882             );
 883         }
 884         self.cstore.allocator_kind = Some(AllocatorKind::Default);
 885     }
 886
 887     fn inject_dependency_if(
 888         &self,
 889         krate: CrateNum,
 890         what: &str,
 891         needs_dep: &dyn Fn(&CrateMetadata) -> bool,
 892     ) {
 893         // don't perform this validation if the session has errors, as one of
 894         // those errors may indicate a circular dependency which could cause
 895         // this to stack overflow.
 896         if self.sess.has_errors() {
 897             return;
 898         }
 899
 900         // Before we inject any dependencies, make sure we don't inject a
 901         // circular dependency by validating that this crate doesn't
 902         // transitively depend on any crates satisfying `needs_dep`.
 903         for dep in self.cstore.crate_dependencies_in_reverse_postorder(krate) {
 904             let data = self.cstore.get_crate_data(dep);
 905             if needs_dep(&data) {
 906                 self.sess.err(&format!(
 907                     "the crate `{}` cannot depend \
 908                                         on a crate that needs {}, but \
 909                                         it depends on `{}`",
 910                     self.cstore.get_crate_data(krate).name(),
 911                     what,
 912                     data.name()
 913                 ));
 914             }
 915         }
 916
 917         // All crates satisfying `needs_dep` do not explicitly depend on the
 918         // crate provided for this compile, but in order for this compilation to
 919         // be successfully linked we need to inject a dependency (to order the
 920         // crates on the command line correctly).
 921         self.cstore.iter_crate_data(|cnum, data| {
 922             if !needs_dep(data) {
 923                 return;
 924             }
 925
 926             info!("injecting a dep from {} to {}", cnum, krate);
 927             data.add_dependency(krate);
 928         });
 929     }
 930
 931     fn report_unused_deps(&mut self, krate: &ast::Crate) {
 932         // Make a point span rather than covering the whole file
 933         let span = krate.span.shrink_to_lo();
 934         // Complain about anything left over
 935         for (name, entry) in self.sess.opts.externs.iter() {
 936             if let ExternLocation::FoundInLibrarySearchDirectories = entry.location {
 937                 // Don't worry about pathless `--extern foo` sysroot references
 938                 continue;
 939             }
 940             let name_interned = Symbol::intern(name);
 941             if self.used_extern_options.contains(&name_interned) {
 942                 continue;
 943             }
 944
 945             // Got a real unused --extern
 946             if self.sess.opts.json_unused_externs {
 947                 self.cstore.unused_externs.push(name_interned);
 948                 continue;
 949             }
 950
 951             let diag = match self.sess.opts.extern_dep_specs.get(name) {
 952                 Some(loc) => BuiltinLintDiagnostics::ExternDepSpec(name.clone(), loc.into()),
 953                 None => {
 954                     // If we don't have a specific location, provide a json encoding of the `--extern`
 955                     // option.
 956                     let meta: BTreeMap<String, String> =
 957                         std::iter::once(("name".to_string(), name.to_string())).collect();
 958                     BuiltinLintDiagnostics::ExternDepSpec(
 959                         name.clone(),
 960                         ExternDepSpec::Json(meta.to_json()),
 961                     )
 962                 }
 963             };
 964             self.sess.parse_sess.buffer_lint_with_diagnostic(
 965                     lint::builtin::UNUSED_CRATE_DEPENDENCIES,
 966                     span,
 967                     ast::CRATE_NODE_ID,
 968                     &format!(
 969                         "external crate `{}` unused in `{}`: remove the dependency or add `use {} as _;`",
 970                         name,
 971                         self.local_crate_name,
 972                         name),
 973                     diag,
 974                 );
 975         }
 976     }
 977
 978     pub fn postprocess(&mut self, krate: &ast::Crate) {
 979         self.inject_profiler_runtime(krate);
 980         self.inject_allocator_crate(krate);
 981         self.inject_panic_runtime(krate);
 982
 983         self.report_unused_deps(krate);
 984
 985         info!("{:?}", CrateDump(&self.cstore));
 986     }
 987
 988     pub fn process_extern_crate(
 989         &mut self,
 990         item: &ast::Item,
 991         definitions: &Definitions,
 992         def_id: LocalDefId,
 993     ) -> CrateNum {
 994         match item.kind {
 995             ast::ItemKind::ExternCrate(orig_name) => {
 996                 debug!(
 997                     "resolving extern crate stmt. ident: {} orig_name: {:?}",
 998                     item.ident, orig_name
 999                 );
1000                 let name = match orig_name {
1001                     Some(orig_name) => {
1002                         validate_crate_name(self.sess, &orig_name.as_str(), Some(item.span));
1003                         orig_name
1004                     }
1005                     None => item.ident.name,
1006                 };
1007                 let dep_kind = if self.sess.contains_name(&item.attrs, sym::no_link) {
1008                     CrateDepKind::MacrosOnly
1009                 } else {
1010                     CrateDepKind::Explicit
1011                 };
1012
1013                 let cnum = self.resolve_crate(name, item.span, dep_kind);
1014
1015                 let path_len = definitions.def_path(def_id).data.len();
1016                 self.update_extern_crate(
1017                     cnum,
1018                     ExternCrate {
1019                         src: ExternCrateSource::Extern(def_id.to_def_id()),
1020                         span: item.span,
1021                         path_len,
1022                         dependency_of: LOCAL_CRATE,
1023                     },
1024                 );
1025                 cnum
1026             }
1027             _ => bug!(),
1028         }
1029     }
1030
1031     pub fn process_path_extern(&mut self, name: Symbol, span: Span) -> CrateNum {
1032         let cnum = self.resolve_crate(name, span, CrateDepKind::Explicit);
1033
1034         self.update_extern_crate(
1035             cnum,
1036             ExternCrate {
1037                 src: ExternCrateSource::Path,
1038                 span,
1039                 // to have the least priority in `update_extern_crate`
1040                 path_len: usize::MAX,
1041                 dependency_of: LOCAL_CRATE,
1042             },
1043         );
1044
1045         cnum
1046     }
1047
1048     pub fn maybe_process_path_extern(&mut self, name: Symbol) -> Option<CrateNum> {
1049         self.maybe_resolve_crate(name, CrateDepKind::Explicit, None).ok()
1050     }
1051 }
1052
1053 fn global_allocator_spans(sess: &Session, krate: &ast::Crate) -> Vec<Span> {
1054     struct Finder<'a> {
1055         sess: &'a Session,
1056         name: Symbol,
1057         spans: Vec<Span>,
1058     }
1059     impl<'ast, 'a> visit::Visitor<'ast> for Finder<'a> {
1060         fn visit_item(&mut self, item: &'ast ast::Item) {
1061             if item.ident.name == self.name
1062                 && self.sess.contains_name(&item.attrs, sym::rustc_std_internal_symbol)
1063             {
1064                 self.spans.push(item.span);
1065             }
1066             visit::walk_item(self, item)
1067         }
1068     }
1069
1070     let name = Symbol::intern(&AllocatorKind::Global.fn_name(sym::alloc));
1071     let mut f = Finder { sess, name, spans: Vec::new() };
1072     visit::walk_crate(&mut f, krate);
1073     f.spans
1074 }