1 //! Validates all used crates and extern libraries and loads their metadata
3 use crate::dynamic_lib::DynamicLibrary;
4 use crate::locator::{CrateError, CrateLocator, CratePaths};
5 use crate::rmeta::{CrateDep, CrateMetadata, CrateNumMap, CrateRoot, MetadataBlob};
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::middle::cstore::{CrateDepKind, CrateSource, ExternCrate};
17 use rustc_middle::middle::cstore::{ExternCrateSource, MetadataLoaderDyn};
18 use rustc_middle::ty::TyCtxt;
19 use rustc_serialize::json::ToJson;
20 use rustc_session::config::{self, CrateType, ExternLocation};
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::{CrateDisambiguator, 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};
30 use proc_macro::bridge::client::ProcMacro;
31 use std::collections::BTreeMap;
34 use tracing::{debug, info};
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,
46 /// This map is used to verify we get no hash conflicts between
47 /// `StableCrateId` values.
48 stable_crate_ids: FxHashMap<StableCrateId, CrateNum>,
50 /// Unused externs of the crate
51 unused_externs: Vec<Symbol>,
54 pub struct CrateLoader<'a> {
55 // Immutable configuration.
57 metadata_loader: &'a MetadataLoaderDyn,
58 local_crate_name: Symbol,
61 used_extern_options: FxHashSet<Symbol>,
64 pub enum LoadedMacro {
65 MacroDef(ast::Item, Edition),
66 ProcMacro(SyntaxExtension),
69 crate struct Library {
70 pub source: CrateSource,
71 pub metadata: MetadataBlob,
79 /// A reference to `CrateMetadata` that can also give access to whole crate store when necessary.
80 #[derive(Clone, Copy)]
81 crate struct CrateMetadataRef<'a> {
82 pub cdata: &'a CrateMetadata,
83 pub cstore: &'a CStore,
86 impl std::ops::Deref for CrateMetadataRef<'_> {
87 type Target = CrateMetadata;
89 fn deref(&self) -> &Self::Target {
94 struct CrateDump<'a>(&'a CStore);
96 impl<'a> std::fmt::Debug for CrateDump<'a> {
97 fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
98 writeln!(fmt, "resolved crates:")?;
99 // `iter_crate_data` does not allow returning values. Thus we use a mutable variable here
100 // that aggregates the value (and any errors that could happen).
101 let mut res = Ok(());
102 self.0.iter_crate_data(|cnum, data| {
105 writeln!(fmt, " name: {}", data.name())?;
106 writeln!(fmt, " cnum: {}", cnum)?;
107 writeln!(fmt, " hash: {}", data.hash())?;
108 writeln!(fmt, " reqd: {:?}", data.dep_kind())?;
109 let CrateSource { dylib, rlib, rmeta } = data.source();
110 if let Some(dylib) = dylib {
111 writeln!(fmt, " dylib: {}", dylib.0.display())?;
113 if let Some(rlib) = rlib {
114 writeln!(fmt, " rlib: {}", rlib.0.display())?;
116 if let Some(rmeta) = rmeta {
117 writeln!(fmt, " rmeta: {}", rmeta.0.display())?;
127 crate fn from_tcx(tcx: TyCtxt<'_>) -> &CStore {
128 tcx.cstore_as_any().downcast_ref::<CStore>().expect("`tcx.cstore` is not a `CStore`")
131 fn alloc_new_crate_num(&mut self) -> CrateNum {
132 self.metas.push(None);
133 CrateNum::new(self.metas.len() - 1)
136 crate fn get_crate_data(&self, cnum: CrateNum) -> CrateMetadataRef<'_> {
137 let cdata = self.metas[cnum]
139 .unwrap_or_else(|| panic!("Failed to get crate data for {:?}", cnum));
140 CrateMetadataRef { cdata, cstore: self }
143 fn set_crate_data(&mut self, cnum: CrateNum, data: CrateMetadata) {
144 assert!(self.metas[cnum].is_none(), "Overwriting crate metadata entry");
145 self.metas[cnum] = Some(Lrc::new(data));
148 crate fn iter_crate_data(&self, mut f: impl FnMut(CrateNum, &CrateMetadata)) {
149 for (cnum, data) in self.metas.iter_enumerated() {
150 if let Some(data) = data {
156 fn push_dependencies_in_postorder(&self, deps: &mut Vec<CrateNum>, cnum: CrateNum) {
157 if !deps.contains(&cnum) {
158 let data = self.get_crate_data(cnum);
159 for &dep in data.dependencies().iter() {
161 self.push_dependencies_in_postorder(deps, dep);
169 crate fn crate_dependencies_in_postorder(&self, cnum: CrateNum) -> Vec<CrateNum> {
170 let mut deps = Vec::new();
171 if cnum == LOCAL_CRATE {
172 self.iter_crate_data(|cnum, _| self.push_dependencies_in_postorder(&mut deps, cnum));
174 self.push_dependencies_in_postorder(&mut deps, cnum);
179 fn crate_dependencies_in_reverse_postorder(&self, cnum: CrateNum) -> Vec<CrateNum> {
180 let mut deps = self.crate_dependencies_in_postorder(cnum);
185 crate fn injected_panic_runtime(&self) -> Option<CrateNum> {
186 self.injected_panic_runtime
189 crate fn allocator_kind(&self) -> Option<AllocatorKind> {
193 crate fn has_global_allocator(&self) -> bool {
194 self.has_global_allocator
197 pub fn report_unused_deps(&self, tcx: TyCtxt<'_>) {
198 // We put the check for the option before the lint_level_at_node call
199 // because the call mutates internal state and introducing it
200 // leads to some ui tests failing.
201 if !tcx.sess.opts.json_unused_externs {
205 .lint_level_at_node(lint::builtin::UNUSED_CRATE_DEPENDENCIES, rustc_hir::CRATE_HIR_ID)
207 if level != lint::Level::Allow {
209 self.unused_externs.iter().map(|ident| ident.to_ident_string()).collect::<Vec<_>>();
210 let unused_externs = unused_externs.iter().map(String::as_str).collect::<Vec<&str>>();
214 .emit_unused_externs(level.as_str(), &unused_externs);
219 impl<'a> CrateLoader<'a> {
222 metadata_loader: &'a MetadataLoaderDyn,
223 local_crate_name: &str,
225 let local_crate_stable_id =
226 StableCrateId::new(local_crate_name, sess.local_crate_disambiguator());
227 let mut stable_crate_ids = FxHashMap::default();
228 stable_crate_ids.insert(local_crate_stable_id, LOCAL_CRATE);
233 local_crate_name: Symbol::intern(local_crate_name),
235 // We add an empty entry for LOCAL_CRATE (which maps to zero) in
236 // order to make array indices in `metas` match with the
237 // corresponding `CrateNum`. This first entry will always remain
239 metas: IndexVec::from_elem_n(None, 1),
240 injected_panic_runtime: None,
241 allocator_kind: None,
242 has_global_allocator: false,
244 unused_externs: Vec::new(),
246 used_extern_options: Default::default(),
250 pub fn cstore(&self) -> &CStore {
254 pub fn into_cstore(self) -> CStore {
258 fn existing_match(&self, name: Symbol, hash: Option<Svh>, kind: PathKind) -> Option<CrateNum> {
260 self.cstore.iter_crate_data(|cnum, data| {
261 if data.name() != name {
262 tracing::trace!("{} did not match {}", data.name(), name);
267 Some(hash) if hash == data.hash() => {
272 debug!("actual hash {} did not match expected {}", hash, data.hash());
278 // When the hash is None we're dealing with a top-level dependency
279 // in which case we may have a specification on the command line for
280 // this library. Even though an upstream library may have loaded
281 // something of the same name, we have to make sure it was loaded
282 // from the exact same location as well.
284 // We're also sure to compare *paths*, not actual byte slices. The
285 // `source` stores paths which are normalized which may be different
286 // from the strings on the command line.
287 let source = self.cstore.get_crate_data(cnum).cdata.source();
288 if let Some(entry) = self.sess.opts.externs.get(&name.as_str()) {
289 // Only use `--extern crate_name=path` here, not `--extern crate_name`.
290 if let Some(mut files) = entry.files() {
292 let l = l.canonicalized();
293 source.dylib.as_ref().map(|(p, _)| p) == Some(l)
294 || source.rlib.as_ref().map(|(p, _)| p) == Some(l)
295 || source.rmeta.as_ref().map(|(p, _)| p) == Some(l)
303 // Alright, so we've gotten this far which means that `data` has the
304 // right name, we don't have a hash, and we don't have a --extern
305 // pointing for ourselves. We're still not quite yet done because we
306 // have to make sure that this crate was found in the crate lookup
307 // path (this is a top-level dependency) as we don't want to
308 // implicitly load anything inside the dependency lookup path.
309 let prev_kind = source
312 .or(source.rlib.as_ref())
313 .or(source.rmeta.as_ref())
314 .expect("No sources for crate")
316 if kind.matches(prev_kind) {
320 "failed to load existing crate {}; kind {:?} did not match prev_kind {:?}",
321 name, kind, prev_kind
328 fn verify_no_symbol_conflicts(&self, root: &CrateRoot<'_>) -> Result<(), CrateError> {
329 // Check for (potential) conflicts with the local crate
330 if self.local_crate_name == root.name()
331 && self.sess.local_crate_disambiguator() == root.disambiguator()
333 return Err(CrateError::SymbolConflictsCurrent(root.name()));
336 // Check for conflicts with any crate loaded so far
337 let mut res = Ok(());
338 self.cstore.iter_crate_data(|_, other| {
339 if other.name() == root.name() && // same crate-name
340 other.disambiguator() == root.disambiguator() && // same crate-disambiguator
341 other.hash() != root.hash()
344 res = Err(CrateError::SymbolConflictsOthers(root.name()));
351 fn verify_no_stable_crate_id_hash_conflicts(
353 root: &CrateRoot<'_>,
355 ) -> Result<(), CrateError> {
356 if let Some(existing) = self.cstore.stable_crate_ids.insert(root.stable_crate_id(), cnum) {
357 let crate_name0 = root.name();
358 let crate_name1 = self.cstore.get_crate_data(existing).name();
359 return Err(CrateError::StableCrateIdCollision(crate_name0, crate_name1));
367 host_lib: Option<Library>,
368 root: Option<&CratePaths>,
370 dep_kind: CrateDepKind,
372 ) -> Result<CrateNum, CrateError> {
373 let _prof_timer = self.sess.prof.generic_activity("metadata_register_crate");
375 let Library { source, metadata } = lib;
376 let crate_root = metadata.get_root();
377 let host_hash = host_lib.as_ref().map(|lib| lib.metadata.get_root().hash());
380 self.sess.opts.externs.get(&name.as_str()).map_or(false, |e| e.is_private_dep);
382 // Claim this crate number and cache it
383 let cnum = self.cstore.alloc_new_crate_num();
386 "register crate `{}` (cnum = {}. private_dep = {})",
392 // Maintain a reference to the top most crate.
393 // Stash paths for top-most crate locally if necessary.
395 let root = if let Some(root) = root {
398 crate_paths = CratePaths::new(crate_root.name(), source.clone());
402 let cnum_map = self.resolve_crate_deps(root, &crate_root, &metadata, cnum, dep_kind)?;
404 let raw_proc_macros = if crate_root.is_proc_macro_crate() {
406 let (dlsym_source, dlsym_root) = match &host_lib {
407 Some(host_lib) => (&host_lib.source, {
408 temp_root = host_lib.metadata.get_root();
411 None => (&source, &crate_root),
413 let dlsym_dylib = dlsym_source.dylib.as_ref().expect("no dylib for a proc-macro crate");
414 Some(self.dlsym_proc_macros(&dlsym_dylib.0, dlsym_root.disambiguator())?)
419 // Perform some verification *after* resolve_crate_deps() above is
420 // known to have been successful. It seems that - in error cases - the
421 // cstore can be in a temporarily invalid state between cnum allocation
422 // and dependency resolution and the verification code would produce
423 // ICEs in that case (see #83045).
424 self.verify_no_symbol_conflicts(&crate_root)?;
425 self.verify_no_stable_crate_id_hash_conflicts(&crate_root, cnum)?;
427 let crate_metadata = CrateMetadata::new(
440 self.cstore.set_crate_data(cnum, crate_metadata);
445 fn load_proc_macro<'b>(
447 locator: &mut CrateLocator<'b>,
449 ) -> Result<Option<(LoadResult, Option<Library>)>, CrateError>
453 // Use a new crate locator so trying to load a proc macro doesn't affect the error
455 let mut proc_macro_locator = locator.clone();
457 // Try to load a proc macro
458 proc_macro_locator.is_proc_macro = Some(true);
460 // Load the proc macro crate for the target
461 let (locator, target_result) = if self.sess.opts.debugging_opts.dual_proc_macros {
462 proc_macro_locator.reset();
463 let result = match self.load(&mut proc_macro_locator)? {
464 Some(LoadResult::Previous(cnum)) => {
465 return Ok(Some((LoadResult::Previous(cnum), None)));
467 Some(LoadResult::Loaded(library)) => Some(LoadResult::Loaded(library)),
468 None => return Ok(None),
470 locator.hash = locator.host_hash;
471 // Use the locator when looking for the host proc macro crate, as that is required
472 // so we want it to affect the error message
475 (&mut proc_macro_locator, None)
478 // Load the proc macro crate for the host
481 locator.is_proc_macro = Some(true);
482 locator.target = &self.sess.host;
483 locator.triple = TargetTriple::from_triple(config::host_triple());
484 locator.filesearch = self.sess.host_filesearch(path_kind);
486 let host_result = match self.load(locator)? {
487 Some(host_result) => host_result,
488 None => return Ok(None),
491 Ok(Some(if self.sess.opts.debugging_opts.dual_proc_macros {
492 let host_result = match host_result {
493 LoadResult::Previous(..) => {
494 panic!("host and target proc macros must be loaded in lock-step")
496 LoadResult::Loaded(library) => library,
498 (target_result.unwrap(), Some(host_result))
504 fn resolve_crate<'b>(
508 dep_kind: CrateDepKind,
509 dep: Option<(&'b CratePaths, &'b CrateDep)>,
512 self.used_extern_options.insert(name);
514 self.maybe_resolve_crate(name, dep_kind, dep).unwrap_or_else(|err| {
516 self.maybe_resolve_crate(sym::core, CrateDepKind::Explicit, None).is_err();
517 err.report(&self.sess, span, missing_core)
521 fn maybe_resolve_crate<'b>(
524 mut dep_kind: CrateDepKind,
525 dep: Option<(&'b CratePaths, &'b CrateDep)>,
526 ) -> Result<CrateNum, CrateError> {
527 info!("resolving crate `{}`", name);
528 if !name.as_str().is_ascii() {
529 return Err(CrateError::NonAsciiName(name));
531 let (root, hash, host_hash, extra_filename, path_kind) = match dep {
532 Some((root, dep)) => (
536 Some(&dep.extra_filename[..]),
537 PathKind::Dependency,
539 None => (None, None, None, None, PathKind::Crate),
541 let result = if let Some(cnum) = self.existing_match(name, hash, path_kind) {
542 (LoadResult::Previous(cnum), None)
544 info!("falling back to a load");
545 let mut locator = CrateLocator::new(
547 self.metadata_loader,
555 Some(false), // is_proc_macro
558 match self.load(&mut locator)? {
559 Some(res) => (res, None),
561 dep_kind = CrateDepKind::MacrosOnly;
562 match self.load_proc_macro(&mut locator, path_kind)? {
564 None => return Err(locator.into_error()),
571 (LoadResult::Previous(cnum), None) => {
572 let data = self.cstore.get_crate_data(cnum);
573 if data.is_proc_macro_crate() {
574 dep_kind = CrateDepKind::MacrosOnly;
576 data.update_dep_kind(|data_dep_kind| cmp::max(data_dep_kind, dep_kind));
579 (LoadResult::Loaded(library), host_library) => {
580 self.register_crate(host_library, root, library, dep_kind, name)
586 fn load(&self, locator: &mut CrateLocator<'_>) -> Result<Option<LoadResult>, CrateError> {
587 let library = match locator.maybe_load_library_crate()? {
588 Some(library) => library,
589 None => return Ok(None),
592 // In the case that we're loading a crate, but not matching
593 // against a hash, we could load a crate which has the same hash
594 // as an already loaded crate. If this is the case prevent
595 // duplicates by just using the first crate.
597 // Note that we only do this for target triple crates, though, as we
598 // don't want to match a host crate against an equivalent target one
600 let root = library.metadata.get_root();
601 Ok(Some(if locator.triple == self.sess.opts.target_triple {
602 let mut result = LoadResult::Loaded(library);
603 self.cstore.iter_crate_data(|cnum, data| {
604 if data.name() == root.name() && root.hash() == data.hash() {
605 assert!(locator.hash.is_none());
606 info!("load success, going to previous cnum: {}", cnum);
607 result = LoadResult::Previous(cnum);
612 LoadResult::Loaded(library)
616 fn update_extern_crate(&self, cnum: CrateNum, extern_crate: ExternCrate) {
617 let cmeta = self.cstore.get_crate_data(cnum);
618 if cmeta.update_extern_crate(extern_crate) {
619 // Propagate the extern crate info to dependencies if it was updated.
620 let extern_crate = ExternCrate { dependency_of: cnum, ..extern_crate };
621 for &dep_cnum in cmeta.dependencies().iter() {
622 self.update_extern_crate(dep_cnum, extern_crate);
627 // Go through the crate metadata and load any crates that it references
628 fn resolve_crate_deps(
631 crate_root: &CrateRoot<'_>,
632 metadata: &MetadataBlob,
634 dep_kind: CrateDepKind,
635 ) -> Result<CrateNumMap, CrateError> {
636 debug!("resolving deps of external crate");
637 if crate_root.is_proc_macro_crate() {
638 return Ok(CrateNumMap::new());
641 // The map from crate numbers in the crate we're resolving to local crate numbers.
642 // We map 0 and all other holes in the map to our parent crate. The "additional"
643 // self-dependencies should be harmless.
644 let deps = crate_root.decode_crate_deps(metadata);
645 let mut crate_num_map = CrateNumMap::with_capacity(1 + deps.len());
646 crate_num_map.push(krate);
649 "resolving dep crate {} hash: `{}` extra filename: `{}`",
650 dep.name, dep.hash, dep.extra_filename
652 let dep_kind = match dep_kind {
653 CrateDepKind::MacrosOnly => CrateDepKind::MacrosOnly,
656 let cnum = self.maybe_resolve_crate(dep.name, dep_kind, Some((root, &dep)))?;
657 crate_num_map.push(cnum);
660 debug!("resolve_crate_deps: cnum_map for {:?} is {:?}", krate, crate_num_map);
664 fn dlsym_proc_macros(
667 disambiguator: CrateDisambiguator,
668 ) -> Result<&'static [ProcMacro], CrateError> {
669 // Make sure the path contains a / or the linker will search for it.
670 let path = env::current_dir().unwrap().join(path);
671 let lib = match DynamicLibrary::open(&path) {
673 Err(s) => return Err(CrateError::DlOpen(s)),
676 let sym = self.sess.generate_proc_macro_decls_symbol(disambiguator);
678 let sym = match lib.symbol(&sym) {
680 Err(s) => return Err(CrateError::DlSym(s)),
682 *(sym as *const &[ProcMacro])
685 // Intentionally leak the dynamic library. We can't ever unload it
686 // since the library can make things that will live arbitrarily long.
687 std::mem::forget(lib);
692 fn inject_panic_runtime(&mut self, krate: &ast::Crate) {
693 // If we're only compiling an rlib, then there's no need to select a
694 // panic runtime, so we just skip this section entirely.
695 let any_non_rlib = self.sess.crate_types().iter().any(|ct| *ct != CrateType::Rlib);
697 info!("panic runtime injection skipped, only generating rlib");
701 // If we need a panic runtime, we try to find an existing one here. At
702 // the same time we perform some general validation of the DAG we've got
703 // going such as ensuring everything has a compatible panic strategy.
705 // The logic for finding the panic runtime here is pretty much the same
706 // as the allocator case with the only addition that the panic strategy
707 // compilation mode also comes into play.
708 let desired_strategy = self.sess.panic_strategy();
709 let mut runtime_found = false;
710 let mut needs_panic_runtime =
711 self.sess.contains_name(&krate.attrs, sym::needs_panic_runtime);
713 self.cstore.iter_crate_data(|cnum, data| {
714 needs_panic_runtime = needs_panic_runtime || data.needs_panic_runtime();
715 if data.is_panic_runtime() {
716 // Inject a dependency from all #![needs_panic_runtime] to this
717 // #![panic_runtime] crate.
718 self.inject_dependency_if(cnum, "a panic runtime", &|data| {
719 data.needs_panic_runtime()
721 runtime_found = runtime_found || data.dep_kind() == CrateDepKind::Explicit;
725 // If an explicitly linked and matching panic runtime was found, or if
726 // we just don't need one at all, then we're done here and there's
727 // nothing else to do.
728 if !needs_panic_runtime || runtime_found {
732 // By this point we know that we (a) need a panic runtime and (b) no
733 // panic runtime was explicitly linked. Here we just load an appropriate
734 // default runtime for our panic strategy and then inject the
737 // We may resolve to an already loaded crate (as the crate may not have
738 // been explicitly linked prior to this) and we may re-inject
739 // dependencies again, but both of those situations are fine.
741 // Also note that we have yet to perform validation of the crate graph
742 // in terms of everyone has a compatible panic runtime format, that's
743 // performed later as part of the `dependency_format` module.
744 let name = match desired_strategy {
745 PanicStrategy::Unwind => sym::panic_unwind,
746 PanicStrategy::Abort => sym::panic_abort,
748 info!("panic runtime not found -- loading {}", name);
750 let cnum = self.resolve_crate(name, DUMMY_SP, CrateDepKind::Implicit, None);
751 let data = self.cstore.get_crate_data(cnum);
753 // Sanity check the loaded crate to ensure it is indeed a panic runtime
754 // and the panic strategy is indeed what we thought it was.
755 if !data.is_panic_runtime() {
756 self.sess.err(&format!("the crate `{}` is not a panic runtime", name));
758 if data.panic_strategy() != desired_strategy {
759 self.sess.err(&format!(
760 "the crate `{}` does not have the panic \
763 desired_strategy.desc()
767 self.cstore.injected_panic_runtime = Some(cnum);
768 self.inject_dependency_if(cnum, "a panic runtime", &|data| data.needs_panic_runtime());
771 fn inject_profiler_runtime(&mut self, krate: &ast::Crate) {
772 if (self.sess.instrument_coverage()
773 || self.sess.opts.debugging_opts.profile
774 || self.sess.opts.cg.profile_generate.enabled())
775 && !self.sess.opts.debugging_opts.no_profiler_runtime
777 info!("loading profiler");
779 if self.sess.contains_name(&krate.attrs, sym::no_core) {
781 "`profiler_builtins` crate (required by compiler options) \
782 is not compatible with crate attribute `#![no_core]`",
786 let name = sym::profiler_builtins;
787 let cnum = self.resolve_crate(name, DUMMY_SP, CrateDepKind::Implicit, None);
788 let data = self.cstore.get_crate_data(cnum);
790 // Sanity check the loaded crate to ensure it is indeed a profiler runtime
791 if !data.is_profiler_runtime() {
792 self.sess.err("the crate `profiler_builtins` is not a profiler runtime");
797 fn inject_allocator_crate(&mut self, krate: &ast::Crate) {
798 self.cstore.has_global_allocator = match &*global_allocator_spans(&self.sess, krate) {
799 [span1, span2, ..] => {
801 .struct_span_err(*span2, "cannot define multiple global allocators")
802 .span_label(*span2, "cannot define a new global allocator")
803 .span_label(*span1, "previous global allocator defined here")
807 spans => !spans.is_empty(),
810 // Check to see if we actually need an allocator. This desire comes
811 // about through the `#![needs_allocator]` attribute and is typically
812 // written down in liballoc.
813 let mut needs_allocator = self.sess.contains_name(&krate.attrs, sym::needs_allocator);
814 self.cstore.iter_crate_data(|_, data| {
815 needs_allocator = needs_allocator || data.needs_allocator();
817 if !needs_allocator {
821 // At this point we've determined that we need an allocator. Let's see
822 // if our compilation session actually needs an allocator based on what
824 let all_rlib = self.sess.crate_types().iter().all(|ct| matches!(*ct, CrateType::Rlib));
829 // Ok, we need an allocator. Not only that but we're actually going to
830 // create an artifact that needs one linked in. Let's go find the one
831 // that we're going to link in.
833 // First up we check for global allocators. Look at the crate graph here
834 // and see what's a global allocator, including if we ourselves are a
836 let mut global_allocator =
837 self.cstore.has_global_allocator.then(|| Symbol::intern("this crate"));
838 self.cstore.iter_crate_data(|_, data| {
839 if !data.has_global_allocator() {
842 match global_allocator {
843 Some(other_crate) => {
844 self.sess.err(&format!(
845 "the `#[global_allocator]` in {} \
846 conflicts with global \
852 None => global_allocator = Some(data.name()),
855 if global_allocator.is_some() {
856 self.cstore.allocator_kind = Some(AllocatorKind::Global);
860 // Ok we haven't found a global allocator but we still need an
861 // allocator. At this point our allocator request is typically fulfilled
862 // by the standard library, denoted by the `#![default_lib_allocator]`
864 let mut has_default = self.sess.contains_name(&krate.attrs, sym::default_lib_allocator);
865 self.cstore.iter_crate_data(|_, data| {
866 if data.has_default_lib_allocator() {
873 "no global memory allocator found but one is \
874 required; link to std or \
875 add `#[global_allocator]` to a static item \
876 that implements the GlobalAlloc trait.",
879 self.cstore.allocator_kind = Some(AllocatorKind::Default);
882 fn inject_dependency_if(
886 needs_dep: &dyn Fn(&CrateMetadata) -> bool,
888 // don't perform this validation if the session has errors, as one of
889 // those errors may indicate a circular dependency which could cause
890 // this to stack overflow.
891 if self.sess.has_errors() {
895 // Before we inject any dependencies, make sure we don't inject a
896 // circular dependency by validating that this crate doesn't
897 // transitively depend on any crates satisfying `needs_dep`.
898 for dep in self.cstore.crate_dependencies_in_reverse_postorder(krate) {
899 let data = self.cstore.get_crate_data(dep);
900 if needs_dep(&data) {
901 self.sess.err(&format!(
902 "the crate `{}` cannot depend \
903 on a crate that needs {}, but \
905 self.cstore.get_crate_data(krate).name(),
912 // All crates satisfying `needs_dep` do not explicitly depend on the
913 // crate provided for this compile, but in order for this compilation to
914 // be successfully linked we need to inject a dependency (to order the
915 // crates on the command line correctly).
916 self.cstore.iter_crate_data(|cnum, data| {
917 if !needs_dep(data) {
921 info!("injecting a dep from {} to {}", cnum, krate);
922 data.add_dependency(krate);
926 fn report_unused_deps(&mut self, krate: &ast::Crate) {
927 // Make a point span rather than covering the whole file
928 let span = krate.span.shrink_to_lo();
929 // Complain about anything left over
930 for (name, entry) in self.sess.opts.externs.iter() {
931 if let ExternLocation::FoundInLibrarySearchDirectories = entry.location {
932 // Don't worry about pathless `--extern foo` sysroot references
935 let name_interned = Symbol::intern(name);
936 if self.used_extern_options.contains(&name_interned) {
940 // Got a real unused --extern
941 if self.sess.opts.json_unused_externs {
942 self.cstore.unused_externs.push(name_interned);
946 let diag = match self.sess.opts.extern_dep_specs.get(name) {
947 Some(loc) => BuiltinLintDiagnostics::ExternDepSpec(name.clone(), loc.into()),
949 // If we don't have a specific location, provide a json encoding of the `--extern`
951 let meta: BTreeMap<String, String> =
952 std::iter::once(("name".to_string(), name.to_string())).collect();
953 BuiltinLintDiagnostics::ExternDepSpec(
955 ExternDepSpec::Json(meta.to_json()),
959 self.sess.parse_sess.buffer_lint_with_diagnostic(
960 lint::builtin::UNUSED_CRATE_DEPENDENCIES,
964 "external crate `{}` unused in `{}`: remove the dependency or add `use {} as _;`",
966 self.local_crate_name,
973 pub fn postprocess(&mut self, krate: &ast::Crate) {
974 self.inject_profiler_runtime(krate);
975 self.inject_allocator_crate(krate);
976 self.inject_panic_runtime(krate);
978 self.report_unused_deps(krate);
980 info!("{:?}", CrateDump(&self.cstore));
983 pub fn process_extern_crate(
986 definitions: &Definitions,
990 ast::ItemKind::ExternCrate(orig_name) => {
992 "resolving extern crate stmt. ident: {} orig_name: {:?}",
993 item.ident, orig_name
995 let name = match orig_name {
997 validate_crate_name(self.sess, &orig_name.as_str(), Some(item.span));
1000 None => item.ident.name,
1002 let dep_kind = if self.sess.contains_name(&item.attrs, sym::no_link) {
1003 CrateDepKind::MacrosOnly
1005 CrateDepKind::Explicit
1008 let cnum = self.resolve_crate(name, item.span, dep_kind, None);
1010 let path_len = definitions.def_path(def_id).data.len();
1011 self.update_extern_crate(
1014 src: ExternCrateSource::Extern(def_id.to_def_id()),
1017 dependency_of: LOCAL_CRATE,
1026 pub fn process_path_extern(&mut self, name: Symbol, span: Span) -> CrateNum {
1027 let cnum = self.resolve_crate(name, span, CrateDepKind::Explicit, None);
1029 self.update_extern_crate(
1032 src: ExternCrateSource::Path,
1034 // to have the least priority in `update_extern_crate`
1035 path_len: usize::MAX,
1036 dependency_of: LOCAL_CRATE,
1043 pub fn maybe_process_path_extern(&mut self, name: Symbol) -> Option<CrateNum> {
1044 self.maybe_resolve_crate(name, CrateDepKind::Explicit, None).ok()
1048 fn global_allocator_spans(sess: &Session, krate: &ast::Crate) -> Vec<Span> {
1054 impl<'ast, 'a> visit::Visitor<'ast> for Finder<'a> {
1055 fn visit_item(&mut self, item: &'ast ast::Item) {
1056 if item.ident.name == self.name
1057 && self.sess.contains_name(&item.attrs, sym::rustc_std_internal_symbol)
1059 self.spans.push(item.span);
1061 visit::walk_item(self, item)
1065 let name = Symbol::intern(&AllocatorKind::Global.fn_name(sym::alloc));
1066 let mut f = Finder { sess, name, spans: Vec::new() };
1067 visit::walk_crate(&mut f, krate);