1 //! Finds crate binaries and loads their metadata
3 //! Might I be the first to welcome you to a world of platform differences,
4 //! version requirements, dependency graphs, conflicting desires, and fun! This
5 //! is the major guts (along with metadata::creader) of the compiler for loading
6 //! crates and resolving dependencies. Let's take a tour!
10 //! Each invocation of the compiler is immediately concerned with one primary
11 //! problem, to connect a set of crates to resolved crates on the filesystem.
12 //! Concretely speaking, the compiler follows roughly these steps to get here:
14 //! 1. Discover a set of `extern crate` statements.
15 //! 2. Transform these directives into crate names. If the directive does not
16 //! have an explicit name, then the identifier is the name.
17 //! 3. For each of these crate names, find a corresponding crate on the
20 //! Sounds easy, right? Let's walk into some of the nuances.
22 //! ## Transitive Dependencies
24 //! Let's say we've got three crates: A, B, and C. A depends on B, and B depends
25 //! on C. When we're compiling A, we primarily need to find and locate B, but we
26 //! also end up needing to find and locate C as well.
28 //! The reason for this is that any of B's types could be composed of C's types,
29 //! any function in B could return a type from C, etc. To be able to guarantee
30 //! that we can always type-check/translate any function, we have to have
31 //! complete knowledge of the whole ecosystem, not just our immediate
34 //! So now as part of the "find a corresponding crate on the filesystem" step
35 //! above, this involves also finding all crates for *all upstream
36 //! dependencies*. This includes all dependencies transitively.
38 //! ## Rlibs and Dylibs
40 //! The compiler has two forms of intermediate dependencies. These are dubbed
41 //! rlibs and dylibs for the static and dynamic variants, respectively. An rlib
42 //! is a rustc-defined file format (currently just an ar archive) while a dylib
43 //! is a platform-defined dynamic library. Each library has a metadata somewhere
46 //! A third kind of dependency is an rmeta file. These are metadata files and do
47 //! not contain any code, etc. To a first approximation, these are treated in the
48 //! same way as rlibs. Where there is both an rlib and an rmeta file, the rlib
49 //! gets priority (even if the rmeta file is newer). An rmeta file is only
50 //! useful for checking a downstream crate, attempting to link one will cause an
53 //! When translating a crate name to a crate on the filesystem, we all of a
54 //! sudden need to take into account both rlibs and dylibs! Linkage later on may
55 //! use either one of these files, as each has their pros/cons. The job of crate
56 //! loading is to discover what's possible by finding all candidates.
58 //! Most parts of this loading systems keep the dylib/rlib as just separate
63 //! We can't exactly scan your whole hard drive when looking for dependencies,
64 //! so we need to places to look. Currently the compiler will implicitly add the
65 //! target lib search path ($prefix/lib/rustlib/$target/lib) to any compilation,
66 //! and otherwise all -L flags are added to the search paths.
68 //! ## What criterion to select on?
70 //! This a pretty tricky area of loading crates. Given a file, how do we know
71 //! whether it's the right crate? Currently, the rules look along these lines:
73 //! 1. Does the filename match an rlib/dylib pattern? That is to say, does the
74 //! filename have the right prefix/suffix?
75 //! 2. Does the filename have the right prefix for the crate name being queried?
76 //! This is filtering for files like `libfoo*.rlib` and such. If the crate
77 //! we're looking for was originally compiled with -C extra-filename, the
78 //! extra filename will be included in this prefix to reduce reading
79 //! metadata from crates that would otherwise share our prefix.
80 //! 3. Is the file an actual rust library? This is done by loading the metadata
81 //! from the library and making sure it's actually there.
82 //! 4. Does the name in the metadata agree with the name of the library?
83 //! 5. Does the target in the metadata agree with the current target?
84 //! 6. Does the SVH match? (more on this later)
86 //! If the file answers `yes` to all these questions, then the file is
87 //! considered as being *candidate* for being accepted. It is illegal to have
88 //! more than two candidates as the compiler has no method by which to resolve
89 //! this conflict. Additionally, rlib/dylib candidates are considered
92 //! After all this has happened, we have 1 or two files as candidates. These
93 //! represent the rlib/dylib file found for a library, and they're returned as
96 //! ### What about versions?
98 //! A lot of effort has been put forth to remove versioning from the compiler.
99 //! There have been forays in the past to have versioning baked in, but it was
100 //! largely always deemed insufficient to the point that it was recognized that
101 //! it's probably something the compiler shouldn't do anyway due to its
102 //! complicated nature and the state of the half-baked solutions.
104 //! With a departure from versioning, the primary criterion for loading crates
105 //! is just the name of a crate. If we stopped here, it would imply that you
106 //! could never link two crates of the same name from different sources
107 //! together, which is clearly a bad state to be in.
109 //! To resolve this problem, we come to the next section!
113 //! A number of flags have been added to the compiler to solve the "version
114 //! problem" in the previous section, as well as generally enabling more
115 //! powerful usage of the crate loading system of the compiler. The goal of
116 //! these flags and options are to enable third-party tools to drive the
117 //! compiler with prior knowledge about how the world should look.
119 //! ## The `--extern` flag
121 //! The compiler accepts a flag of this form a number of times:
124 //! --extern crate-name=path/to/the/crate.rlib
127 //! This flag is basically the following letter to the compiler:
131 //! > When you are attempting to load the immediate dependency `crate-name`, I
132 //! > would like you to assume that the library is located at
133 //! > `path/to/the/crate.rlib`, and look nowhere else. Also, please do not
134 //! > assume that the path I specified has the name `crate-name`.
136 //! This flag basically overrides most matching logic except for validating that
137 //! the file is indeed a rust library. The same `crate-name` can be specified
138 //! twice to specify the rlib/dylib pair.
140 //! ## Enabling "multiple versions"
142 //! This basically boils down to the ability to specify arbitrary packages to
143 //! the compiler. For example, if crate A wanted to use Bv1 and Bv2, then it
144 //! would look something like:
146 //! ```compile_fail,E0463
153 //! and the compiler would be invoked as:
156 //! rustc a.rs --extern b1=path/to/libb1.rlib --extern b2=path/to/libb2.rlib
159 //! In this scenario there are two crates named `b` and the compiler must be
160 //! manually driven to be informed where each crate is.
162 //! ## Frobbing symbols
164 //! One of the immediate problems with linking the same library together twice
165 //! in the same problem is dealing with duplicate symbols. The primary way to
166 //! deal with this in rustc is to add hashes to the end of each symbol.
168 //! In order to force hashes to change between versions of a library, if
169 //! desired, the compiler exposes an option `-C metadata=foo`, which is used to
170 //! initially seed each symbol hash. The string `foo` is prepended to each
171 //! string-to-hash to ensure that symbols change over time.
173 //! ## Loading transitive dependencies
175 //! Dealing with same-named-but-distinct crates is not just a local problem, but
176 //! one that also needs to be dealt with for transitive dependencies. Note that
177 //! in the letter above `--extern` flags only apply to the *local* set of
178 //! dependencies, not the upstream transitive dependencies. Consider this
179 //! dependency graph:
191 //! In this scenario, when we compile `D`, we need to be able to distinctly
192 //! resolve `A.1` and `A.2`, but an `--extern` flag cannot apply to these
193 //! transitive dependencies.
195 //! Note that the key idea here is that `B` and `C` are both *already compiled*.
196 //! That is, they have already resolved their dependencies. Due to unrelated
197 //! technical reasons, when a library is compiled, it is only compatible with
198 //! the *exact same* version of the upstream libraries it was compiled against.
199 //! We use the "Strict Version Hash" to identify the exact copy of an upstream
202 //! With this knowledge, we know that `B` and `C` will depend on `A` with
203 //! different SVH values, so we crawl the normal `-L` paths looking for
204 //! `liba*.rlib` and filter based on the contained SVH.
206 //! In the end, this ends up not needing `--extern` to specify upstream
207 //! transitive dependencies.
211 //! That's the general overview of loading crates in the compiler, but it's by
212 //! no means all of the necessary details. Take a look at the rest of
213 //! metadata::locator or metadata::creader for all the juicy details!
215 use crate::creader::Library;
216 use crate::rmeta::{rustc_version, MetadataBlob, METADATA_HEADER};
218 use rustc::middle::cstore::{CrateSource, MetadataLoader};
219 use rustc::session::filesearch::{FileDoesntMatch, FileMatches, FileSearch};
220 use rustc::session::search_paths::PathKind;
221 use rustc::session::{config, CrateDisambiguator, Session};
222 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
223 use rustc_data_structures::svh::Svh;
224 use rustc_data_structures::sync::MetadataRef;
225 use rustc_errors::{struct_span_err, DiagnosticBuilder};
226 use rustc_span::symbol::{sym, Symbol};
227 use rustc_span::Span;
228 use rustc_target::spec::{Target, TargetTriple};
233 use std::io::{self, Read};
235 use std::path::{Path, PathBuf};
236 use std::time::Instant;
238 use flate2::read::DeflateDecoder;
240 use rustc_data_structures::owning_ref::OwningRef;
242 use log::{debug, info, warn};
244 use rustc_error_codes::*;
247 struct CrateMismatch {
253 crate struct CrateLocator<'a> {
254 // Immutable per-session configuration.
256 metadata_loader: &'a dyn MetadataLoader,
258 // Immutable per-search configuration.
260 exact_paths: Vec<PathBuf>,
261 pub hash: Option<Svh>,
262 pub host_hash: Option<Svh>,
263 extra_filename: Option<&'a str>,
264 pub target: &'a Target,
265 pub triple: TargetTriple,
266 pub filesearch: FileSearch<'a>,
268 root: Option<&'a CratePaths>,
269 pub is_proc_macro: Option<bool>,
271 // Mutable in-progress state or output.
272 rejected_via_hash: Vec<CrateMismatch>,
273 rejected_via_triple: Vec<CrateMismatch>,
274 rejected_via_kind: Vec<CrateMismatch>,
275 rejected_via_version: Vec<CrateMismatch>,
276 rejected_via_filename: Vec<CrateMismatch>,
279 crate struct CratePaths {
285 crate fn new(name: Symbol, source: CrateSource) -> CratePaths {
286 CratePaths { name, source }
290 #[derive(Copy, Clone, PartialEq)]
297 impl fmt::Display for CrateFlavor {
298 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
299 f.write_str(match *self {
300 CrateFlavor::Rlib => "rlib",
301 CrateFlavor::Rmeta => "rmeta",
302 CrateFlavor::Dylib => "dylib",
307 impl<'a> CrateLocator<'a> {
310 metadata_loader: &'a dyn MetadataLoader,
313 host_hash: Option<Svh>,
314 extra_filename: Option<&'a str>,
318 root: Option<&'a CratePaths>,
319 is_proc_macro: Option<bool>,
320 ) -> CrateLocator<'a> {
325 exact_paths: if hash.is_none() {
328 .get(&crate_name.as_str())
330 .filter_map(|entry| entry.files())
332 .map(|location| PathBuf::from(location))
335 // SVH being specified means this is a transitive dependency,
336 // so `--extern` options do not apply.
342 target: if is_host { &sess.host } else { &sess.target.target },
344 TargetTriple::from_triple(config::host_triple())
346 sess.opts.target_triple.clone()
348 filesearch: if is_host {
349 sess.host_filesearch(path_kind)
351 sess.target_filesearch(path_kind)
356 rejected_via_hash: Vec::new(),
357 rejected_via_triple: Vec::new(),
358 rejected_via_kind: Vec::new(),
359 rejected_via_version: Vec::new(),
360 rejected_via_filename: Vec::new(),
364 crate fn reset(&mut self) {
365 self.rejected_via_hash.clear();
366 self.rejected_via_triple.clear();
367 self.rejected_via_kind.clear();
368 self.rejected_via_version.clear();
369 self.rejected_via_filename.clear();
372 crate fn maybe_load_library_crate(&mut self) -> Option<Library> {
373 if !self.exact_paths.is_empty() {
374 return self.find_commandline_library();
376 let mut seen_paths = FxHashSet::default();
377 match self.extra_filename {
379 .find_library_crate(s, &mut seen_paths)
380 .or_else(|| self.find_library_crate("", &mut seen_paths)),
381 None => self.find_library_crate("", &mut seen_paths),
385 crate fn report_errs(self) -> ! {
386 let add = match self.root {
387 None => String::new(),
388 Some(r) => format!(" which `{}` depends on", r.name),
390 let mut msg = "the following crate versions were found:".to_string();
391 let mut err = if !self.rejected_via_hash.is_empty() {
392 let mut err = struct_span_err!(
396 "found possibly newer version of crate `{}`{}",
400 err.note("perhaps that crate needs to be recompiled?");
401 let mismatches = self.rejected_via_hash.iter();
402 for &CrateMismatch { ref path, .. } in mismatches {
403 msg.push_str(&format!("\ncrate `{}`: {}", self.crate_name, path.display()));
408 for path in r.source.paths() {
409 msg.push_str(&format!("\ncrate `{}`: {}", r.name, path.display()));
415 } else if !self.rejected_via_triple.is_empty() {
416 let mut err = struct_span_err!(
420 "couldn't find crate `{}` \
421 with expected target triple {}{}",
426 let mismatches = self.rejected_via_triple.iter();
427 for &CrateMismatch { ref path, ref got } in mismatches {
428 msg.push_str(&format!(
429 "\ncrate `{}`, target triple {}: {}",
437 } else if !self.rejected_via_kind.is_empty() {
438 let mut err = struct_span_err!(
442 "found staticlib `{}` instead of rlib or dylib{}",
446 err.help("please recompile that crate using --crate-type lib");
447 let mismatches = self.rejected_via_kind.iter();
448 for &CrateMismatch { ref path, .. } in mismatches {
449 msg.push_str(&format!("\ncrate `{}`: {}", self.crate_name, path.display()));
453 } else if !self.rejected_via_version.is_empty() {
454 let mut err = struct_span_err!(
458 "found crate `{}` compiled by an incompatible version \
464 "please recompile that crate using this compiler ({})",
467 let mismatches = self.rejected_via_version.iter();
468 for &CrateMismatch { ref path, ref got } in mismatches {
469 msg.push_str(&format!(
470 "\ncrate `{}` compiled by {}: {}",
479 let mut err = struct_span_err!(
483 "can't find crate for `{}`{}",
488 if (self.crate_name == sym::std || self.crate_name == sym::core)
489 && self.triple != TargetTriple::from_triple(config::host_triple())
491 err.note(&format!("the `{}` target may not be installed", self.triple));
493 err.span_label(self.span, "can't find crate");
497 if !self.rejected_via_filename.is_empty() {
498 let dylibname = self.dylibname();
499 let mismatches = self.rejected_via_filename.iter();
500 for &CrateMismatch { ref path, .. } in mismatches {
502 "extern location for {} is of an unknown type: {}",
507 "file name should be lib*.rlib or {}*.{}",
508 dylibname.0, dylibname.1
514 self.sess.abort_if_errors();
518 fn find_library_crate(
521 seen_paths: &mut FxHashSet<PathBuf>,
522 ) -> Option<Library> {
523 let dypair = self.dylibname();
524 let staticpair = self.staticlibname();
526 // want: crate_name.dir_part() + prefix + crate_name.file_part + "-"
527 let dylib_prefix = format!("{}{}{}", dypair.0, self.crate_name, extra_prefix);
528 let rlib_prefix = format!("lib{}{}", self.crate_name, extra_prefix);
529 let staticlib_prefix = format!("{}{}{}", staticpair.0, self.crate_name, extra_prefix);
531 let mut candidates: FxHashMap<_, (FxHashMap<_, _>, FxHashMap<_, _>, FxHashMap<_, _>)> =
533 let mut staticlibs = vec![];
535 // First, find all possible candidate rlibs and dylibs purely based on
536 // the name of the files themselves. We're trying to match against an
537 // exact crate name and a possibly an exact hash.
539 // During this step, we can filter all found libraries based on the
540 // name and id found in the crate id (we ignore the path portion for
541 // filename matching), as well as the exact hash (if specified). If we
542 // end up having many candidates, we must look at the metadata to
543 // perform exact matches against hashes/crate ids. Note that opening up
544 // the metadata is where we do an exact match against the full contents
545 // of the crate id (path/name/id).
547 // The goal of this step is to look at as little metadata as possible.
548 self.filesearch.search(|path, kind| {
549 let file = match path.file_name().and_then(|s| s.to_str()) {
550 None => return FileDoesntMatch,
553 let (hash, found_kind) = if file.starts_with(&rlib_prefix) && file.ends_with(".rlib") {
554 (&file[(rlib_prefix.len())..(file.len() - ".rlib".len())], CrateFlavor::Rlib)
555 } else if file.starts_with(&rlib_prefix) && file.ends_with(".rmeta") {
556 (&file[(rlib_prefix.len())..(file.len() - ".rmeta".len())], CrateFlavor::Rmeta)
557 } else if file.starts_with(&dylib_prefix) && file.ends_with(&dypair.1) {
558 (&file[(dylib_prefix.len())..(file.len() - dypair.1.len())], CrateFlavor::Dylib)
560 if file.starts_with(&staticlib_prefix) && file.ends_with(&staticpair.1) {
561 staticlibs.push(CrateMismatch {
562 path: path.to_path_buf(),
563 got: "static".to_string(),
566 return FileDoesntMatch;
569 info!("lib candidate: {}", path.display());
571 let hash_str = hash.to_string();
572 let slot = candidates.entry(hash_str).or_default();
573 let (ref mut rlibs, ref mut rmetas, ref mut dylibs) = *slot;
574 fs::canonicalize(path)
576 if seen_paths.contains(&p) {
577 return FileDoesntMatch;
579 seen_paths.insert(p.clone());
581 CrateFlavor::Rlib => {
582 rlibs.insert(p, kind);
584 CrateFlavor::Rmeta => {
585 rmetas.insert(p, kind);
587 CrateFlavor::Dylib => {
588 dylibs.insert(p, kind);
593 .unwrap_or(FileDoesntMatch)
595 self.rejected_via_kind.extend(staticlibs);
597 // We have now collected all known libraries into a set of candidates
598 // keyed of the filename hash listed. For each filename, we also have a
599 // list of rlibs/dylibs that apply. Here, we map each of these lists
600 // (per hash), to a Library candidate for returning.
602 // A Library candidate is created if the metadata for the set of
603 // libraries corresponds to the crate id and hash criteria that this
604 // search is being performed for.
605 let mut libraries = FxHashMap::default();
606 for (_hash, (rlibs, rmetas, dylibs)) in candidates {
607 if let Some((svh, lib)) = self.extract_lib(rlibs, rmetas, dylibs) {
608 libraries.insert(svh, lib);
612 // Having now translated all relevant found hashes into libraries, see
613 // what we've got and figure out if we found multiple candidates for
615 match libraries.len() {
617 1 => Some(libraries.into_iter().next().unwrap().1),
619 let mut err = struct_span_err!(
623 "multiple matching crates for `{}`",
626 let candidates = libraries
628 .filter_map(|(_, lib)| {
629 let crate_name = &lib.metadata.get_root().name().as_str();
630 match &(&lib.source.dylib, &lib.source.rlib) {
631 &(&Some((ref pd, _)), &Some((ref pr, _))) => Some(format!(
632 "\ncrate `{}`: {}\n{:>padding$}",
636 padding = 8 + crate_name.len()
638 &(&Some((ref p, _)), &None) | &(&None, &Some((ref p, _))) => {
639 Some(format!("\ncrate `{}`: {}", crate_name, p.display()))
641 &(&None, &None) => None,
644 .collect::<String>();
645 err.note(&format!("candidates:{}", candidates));
654 rlibs: FxHashMap<PathBuf, PathKind>,
655 rmetas: FxHashMap<PathBuf, PathKind>,
656 dylibs: FxHashMap<PathBuf, PathKind>,
657 ) -> Option<(Svh, Library)> {
659 let source = CrateSource {
660 rlib: self.extract_one(rlibs, CrateFlavor::Rlib, &mut slot),
661 rmeta: self.extract_one(rmetas, CrateFlavor::Rmeta, &mut slot),
662 dylib: self.extract_one(dylibs, CrateFlavor::Dylib, &mut slot),
664 slot.map(|(svh, metadata)| (svh, Library { source, metadata }))
667 // Attempts to extract *one* library from the set `m`. If the set has no
668 // elements, `None` is returned. If the set has more than one element, then
669 // the errors and notes are emitted about the set of libraries.
671 // With only one library in the set, this function will extract it, and then
672 // read the metadata from it if `*slot` is `None`. If the metadata couldn't
673 // be read, it is assumed that the file isn't a valid rust library (no
674 // errors are emitted).
677 m: FxHashMap<PathBuf, PathKind>,
679 slot: &mut Option<(Svh, MetadataBlob)>,
680 ) -> Option<(PathBuf, PathKind)> {
681 let mut ret: Option<(PathBuf, PathKind)> = None;
685 // FIXME(#10786): for an optimization, we only read one of the
686 // libraries' metadata sections. In theory we should
687 // read both, but reading dylib metadata is quite
691 } else if m.len() == 1 {
692 return Some(m.into_iter().next().unwrap());
696 let mut err: Option<DiagnosticBuilder<'_>> = None;
697 for (lib, kind) in m {
698 info!("{} reading metadata from: {}", flavor, lib.display());
699 let (hash, metadata) =
700 match get_metadata_section(self.target, flavor, &lib, self.metadata_loader) {
702 if let Some(h) = self.crate_matches(&blob, &lib) {
705 info!("metadata mismatch");
710 warn!("no metadata found: {}", err);
714 // If we see multiple hashes, emit an error about duplicate candidates.
715 if slot.as_ref().map_or(false, |s| s.0 != hash) {
716 let mut e = struct_span_err!(
720 "multiple {} candidates for `{}` found",
726 &format!(r"candidate #1: {}", ret.as_ref().unwrap().0.display()),
728 if let Some(ref mut e) = err {
739 .span_note(self.span, &format!(r"candidate #{}: {}", error, lib.display()));
743 // Ok so at this point we've determined that `(lib, kind)` above is
744 // a candidate crate to load, and that `slot` is either none (this
745 // is the first crate of its kind) or if some the previous path has
746 // the exact same hash (e.g., it's the exact same crate).
748 // In principle these two candidate crates are exactly the same so
749 // we can choose either of them to link. As a stupidly gross hack,
750 // however, we favor crate in the sysroot.
752 // You can find more info in rust-lang/rust#39518 and various linked
753 // issues, but the general gist is that during testing libstd the
754 // compilers has two candidates to choose from: one in the sysroot
755 // and one in the deps folder. These two crates are the exact same
756 // crate but if the compiler chooses the one in the deps folder
757 // it'll cause spurious errors on Windows.
759 // As a result, we favor the sysroot crate here. Note that the
760 // candidates are all canonicalized, so we canonicalize the sysroot
762 if let Some((ref prev, _)) = ret {
763 let sysroot = &self.sess.sysroot;
764 let sysroot = sysroot.canonicalize().unwrap_or_else(|_| sysroot.to_path_buf());
765 if prev.starts_with(&sysroot) {
769 *slot = Some((hash, metadata));
770 ret = Some((lib, kind));
781 fn crate_matches(&mut self, metadata: &MetadataBlob, libpath: &Path) -> Option<Svh> {
782 let rustc_version = rustc_version();
783 let found_version = metadata.get_rustc_version();
784 if found_version != rustc_version {
785 info!("Rejecting via version: expected {} got {}", rustc_version, found_version);
786 self.rejected_via_version
787 .push(CrateMismatch { path: libpath.to_path_buf(), got: found_version });
791 let root = metadata.get_root();
792 if let Some(expected_is_proc_macro) = self.is_proc_macro {
793 let is_proc_macro = root.is_proc_macro_crate();
794 if is_proc_macro != expected_is_proc_macro {
796 "Rejecting via proc macro: expected {} got {}",
797 expected_is_proc_macro, is_proc_macro
803 if self.exact_paths.is_empty() {
804 if self.crate_name != root.name() {
805 info!("Rejecting via crate name");
810 if root.triple() != &self.triple {
811 info!("Rejecting via crate triple: expected {} got {}", self.triple, root.triple());
812 self.rejected_via_triple.push(CrateMismatch {
813 path: libpath.to_path_buf(),
814 got: root.triple().to_string(),
819 let hash = root.hash();
820 if let Some(expected_hash) = self.hash {
821 if hash != expected_hash {
822 info!("Rejecting via hash: expected {} got {}", expected_hash, hash);
823 self.rejected_via_hash
824 .push(CrateMismatch { path: libpath.to_path_buf(), got: hash.to_string() });
832 // Returns the corresponding (prefix, suffix) that files need to have for
834 fn dylibname(&self) -> (String, String) {
835 let t = &self.target;
836 (t.options.dll_prefix.clone(), t.options.dll_suffix.clone())
839 // Returns the corresponding (prefix, suffix) that files need to have for
841 fn staticlibname(&self) -> (String, String) {
842 let t = &self.target;
843 (t.options.staticlib_prefix.clone(), t.options.staticlib_suffix.clone())
846 fn find_commandline_library(&mut self) -> Option<Library> {
847 // First, filter out all libraries that look suspicious. We only accept
848 // files which actually exist that have the correct naming scheme for
850 let sess = self.sess;
851 let dylibname = self.dylibname();
852 let mut rlibs = FxHashMap::default();
853 let mut rmetas = FxHashMap::default();
854 let mut dylibs = FxHashMap::default();
856 let crate_name = self.crate_name;
857 let rejected_via_filename = &mut self.rejected_via_filename;
858 let locs = self.exact_paths.iter().filter(|loc| {
861 "extern location for {} does not exist: {}",
867 let file = match loc.file_name().and_then(|s| s.to_str()) {
871 "extern location for {} is not a file: {}",
878 if file.starts_with("lib") && (file.ends_with(".rlib") || file.ends_with(".rmeta"))
882 let (ref prefix, ref suffix) = dylibname;
883 if file.starts_with(&prefix[..]) && file.ends_with(&suffix[..]) {
888 rejected_via_filename
889 .push(CrateMismatch { path: (*loc).clone(), got: String::new() });
894 // Now that we have an iterator of good candidates, make sure
895 // there's at most one rlib and at most one dylib.
897 if loc.file_name().unwrap().to_str().unwrap().ends_with(".rlib") {
898 rlibs.insert(fs::canonicalize(&loc).unwrap(), PathKind::ExternFlag);
899 } else if loc.file_name().unwrap().to_str().unwrap().ends_with(".rmeta") {
900 rmetas.insert(fs::canonicalize(&loc).unwrap(), PathKind::ExternFlag);
902 dylibs.insert(fs::canonicalize(&loc).unwrap(), PathKind::ExternFlag);
907 // Extract the dylib/rlib/rmeta triple.
908 self.extract_lib(rlibs, rmetas, dylibs).map(|(_, lib)| lib)
912 // Just a small wrapper to time how long reading metadata takes.
913 fn get_metadata_section(
917 loader: &dyn MetadataLoader,
918 ) -> Result<MetadataBlob, String> {
919 let start = Instant::now();
920 let ret = get_metadata_section_imp(target, flavor, filename, loader);
921 info!("reading {:?} => {:?}", filename.file_name().unwrap(), start.elapsed());
925 /// A trivial wrapper for `Mmap` that implements `StableDeref`.
926 struct StableDerefMmap(memmap::Mmap);
928 impl Deref for StableDerefMmap {
931 fn deref(&self) -> &[u8] {
936 unsafe impl stable_deref_trait::StableDeref for StableDerefMmap {}
938 fn get_metadata_section_imp(
942 loader: &dyn MetadataLoader,
943 ) -> Result<MetadataBlob, String> {
944 if !filename.exists() {
945 return Err(format!("no such file: '{}'", filename.display()));
947 let raw_bytes: MetadataRef = match flavor {
948 CrateFlavor::Rlib => loader.get_rlib_metadata(target, filename)?,
949 CrateFlavor::Dylib => {
950 let buf = loader.get_dylib_metadata(target, filename)?;
951 // The header is uncompressed
952 let header_len = METADATA_HEADER.len();
953 debug!("checking {} bytes of metadata-version stamp", header_len);
954 let header = &buf[..cmp::min(header_len, buf.len())];
955 if header != METADATA_HEADER {
957 "incompatible metadata version found: '{}'",
962 // Header is okay -> inflate the actual metadata
963 let compressed_bytes = &buf[header_len..];
964 debug!("inflating {} bytes of compressed metadata", compressed_bytes.len());
965 let mut inflated = Vec::new();
966 match DeflateDecoder::new(compressed_bytes).read_to_end(&mut inflated) {
967 Ok(_) => rustc_erase_owner!(OwningRef::new(inflated).map_owner_box()),
969 return Err(format!("failed to decompress metadata: {}", filename.display()));
973 CrateFlavor::Rmeta => {
974 // mmap the file, because only a small fraction of it is read.
975 let file = std::fs::File::open(filename)
976 .map_err(|_| format!("failed to open rmeta metadata: '{}'", filename.display()))?;
977 let mmap = unsafe { memmap::Mmap::map(&file) };
979 .map_err(|_| format!("failed to mmap rmeta metadata: '{}'", filename.display()))?;
981 rustc_erase_owner!(OwningRef::new(StableDerefMmap(mmap)).map_owner_box())
984 let blob = MetadataBlob::new(raw_bytes);
985 if blob.is_compatible() {
988 Err(format!("incompatible metadata version found: '{}'", filename.display()))
992 /// Look for a plugin registrar. Returns its library path and crate disambiguator.
993 pub fn find_plugin_registrar(
995 metadata_loader: &dyn MetadataLoader,
998 ) -> Option<(PathBuf, CrateDisambiguator)> {
999 info!("find plugin registrar `{}`", name);
1000 let target_triple = sess.opts.target_triple.clone();
1001 let host_triple = TargetTriple::from_triple(config::host_triple());
1002 let is_cross = target_triple != host_triple;
1003 let mut target_only = false;
1004 let mut locator = CrateLocator::new(
1010 None, // extra_filename
1015 None, // is_proc_macro
1018 let library = locator.maybe_load_library_crate().or_else(|| {
1022 // Try loading from target crates. This will abort later if we
1023 // try to load a plugin registrar function,
1026 locator.target = &sess.target.target;
1027 locator.triple = target_triple;
1028 locator.filesearch = sess.target_filesearch(PathKind::Crate);
1030 locator.maybe_load_library_crate()
1032 let library = match library {
1034 None => locator.report_errs(),
1038 let message = format!(
1039 "plugin `{}` is not available for triple `{}` (only found {})",
1041 config::host_triple(),
1042 sess.opts.target_triple
1044 struct_span_err!(sess, span, E0456, "{}", &message).emit();
1048 match library.source.dylib {
1049 Some(dylib) => Some((dylib.0, library.metadata.get_root().disambiguator())),
1055 "plugin `{}` only found in rlib format, but must be available \
1060 // No need to abort because the loading code will just ignore this
1067 /// A diagnostic function for dumping crate metadata to an output stream.
1068 pub fn list_file_metadata(
1071 metadata_loader: &dyn MetadataLoader,
1072 out: &mut dyn io::Write,
1073 ) -> io::Result<()> {
1074 let filename = path.file_name().unwrap().to_str().unwrap();
1075 let flavor = if filename.ends_with(".rlib") {
1077 } else if filename.ends_with(".rmeta") {
1082 match get_metadata_section(target, flavor, path, metadata_loader) {
1083 Ok(metadata) => metadata.list_crate_metadata(out),
1084 Err(msg) => write!(out, "{}\n", msg),