]>
Commit | Line | Data |
---|---|---|
223e47cc | 1 | //! Finds crate binaries and loads their metadata |
1a4d82fc JJ |
2 | //! |
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! | |
7 | //! | |
8 | //! # The problem | |
9 | //! | |
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: | |
13 | //! | |
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 | |
18 | //! filesystem. | |
19 | //! | |
20 | //! Sounds easy, right? Let's walk into some of the nuances. | |
21 | //! | |
22 | //! ## Transitive Dependencies | |
23 | //! | |
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. | |
27 | //! | |
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 | |
9fa01778 | 30 | //! that we can always type-check/translate any function, we have to have |
1a4d82fc JJ |
31 | //! complete knowledge of the whole ecosystem, not just our immediate |
32 | //! dependencies. | |
33 | //! | |
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. | |
37 | //! | |
38 | //! ## Rlibs and Dylibs | |
39 | //! | |
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 | |
44 | //! inside of it. | |
45 | //! | |
476ff2be SL |
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 | |
51 | //! error. | |
52 | //! | |
1a4d82fc JJ |
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. | |
57 | //! | |
58 | //! Most parts of this loading systems keep the dylib/rlib as just separate | |
59 | //! variables. | |
60 | //! | |
61 | //! ## Where to look? | |
62 | //! | |
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. | |
67 | //! | |
68 | //! ## What criterion to select on? | |
69 | //! | |
064997fb | 70 | //! This is a pretty tricky area of loading crates. Given a file, how do we know |
1a4d82fc JJ |
71 | //! whether it's the right crate? Currently, the rules look along these lines: |
72 | //! | |
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? | |
83c7162d XL |
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. | |
1a4d82fc JJ |
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) | |
85 | //! | |
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 | |
90 | //! separately. | |
91 | //! | |
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 | |
94 | //! being found. | |
95 | //! | |
96 | //! ### What about versions? | |
97 | //! | |
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. | |
103 | //! | |
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. | |
108 | //! | |
109 | //! To resolve this problem, we come to the next section! | |
110 | //! | |
111 | //! # Expert Mode | |
112 | //! | |
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. | |
118 | //! | |
119 | //! ## The `--extern` flag | |
120 | //! | |
121 | //! The compiler accepts a flag of this form a number of times: | |
122 | //! | |
123 | //! ```text | |
124 | //! --extern crate-name=path/to/the/crate.rlib | |
125 | //! ``` | |
126 | //! | |
127 | //! This flag is basically the following letter to the compiler: | |
128 | //! | |
129 | //! > Dear rustc, | |
130 | //! > | |
131 | //! > When you are attempting to load the immediate dependency `crate-name`, I | |
9346a6ac | 132 | //! > would like you to assume that the library is located at |
1a4d82fc JJ |
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`. | |
135 | //! | |
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. | |
139 | //! | |
140 | //! ## Enabling "multiple versions" | |
141 | //! | |
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: | |
145 | //! | |
041b39d2 | 146 | //! ```compile_fail,E0463 |
1a4d82fc JJ |
147 | //! extern crate b1; |
148 | //! extern crate b2; | |
149 | //! | |
150 | //! fn main() {} | |
151 | //! ``` | |
152 | //! | |
153 | //! and the compiler would be invoked as: | |
154 | //! | |
155 | //! ```text | |
156 | //! rustc a.rs --extern b1=path/to/libb1.rlib --extern b2=path/to/libb2.rlib | |
157 | //! ``` | |
158 | //! | |
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. | |
161 | //! | |
162 | //! ## Frobbing symbols | |
163 | //! | |
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. | |
167 | //! | |
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. | |
172 | //! | |
173 | //! ## Loading transitive dependencies | |
174 | //! | |
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: | |
180 | //! | |
181 | //! ```text | |
182 | //! A.1 A.2 | |
183 | //! | | | |
184 | //! | | | |
185 | //! B C | |
186 | //! \ / | |
187 | //! \ / | |
188 | //! D | |
189 | //! ``` | |
190 | //! | |
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. | |
194 | //! | |
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 | |
200 | //! library. | |
201 | //! | |
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. | |
205 | //! | |
206 | //! In the end, this ends up not needing `--extern` to specify upstream | |
207 | //! transitive dependencies. | |
208 | //! | |
209 | //! # Wrapping up | |
210 | //! | |
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 | |
c30ab7b3 | 213 | //! metadata::locator or metadata::creader for all the juicy details! |
223e47cc | 214 | |
9fa01778 | 215 | use crate::creader::Library; |
f2b60f7d FG |
216 | use crate::errors::{ |
217 | CannotFindCrate, CrateLocationUnknownType, DlError, ExternLocationNotExist, | |
218 | ExternLocationNotFile, FoundStaticlib, IncompatibleRustc, InvalidMetadataFiles, | |
219 | LibFilenameForm, MultipleCandidates, MultipleMatchingCrates, NewerCrateVersion, | |
220 | NoCrateWithTriple, NoDylibPlugin, NonAsciiName, StableCrateIdCollision, SymbolConflictsCurrent, | |
221 | SymbolConflictsOthers, | |
222 | }; | |
dfeec247 | 223 | use crate::rmeta::{rustc_version, MetadataBlob, METADATA_HEADER}; |
92a42be0 | 224 | |
dfeec247 | 225 | use rustc_data_structures::fx::{FxHashMap, FxHashSet}; |
cdc7bbd5 | 226 | use rustc_data_structures::memmap::Mmap; |
3dfed10e | 227 | use rustc_data_structures::owning_ref::OwningRef; |
dfeec247 XL |
228 | use rustc_data_structures::svh::Svh; |
229 | use rustc_data_structures::sync::MetadataRef; | |
f2b60f7d | 230 | use rustc_errors::{DiagnosticArgValue, FatalError, IntoDiagnosticArg}; |
f9f354fc | 231 | use rustc_session::config::{self, CrateType}; |
c295e0f8 | 232 | use rustc_session::cstore::{CrateSource, MetadataLoader}; |
5099ac24 | 233 | use rustc_session::filesearch::FileSearch; |
ba9703b0 | 234 | use rustc_session::search_paths::PathKind; |
5869c6ff | 235 | use rustc_session::utils::CanonicalizedPath; |
94222f64 | 236 | use rustc_session::Session; |
f2b60f7d | 237 | use rustc_span::symbol::Symbol; |
dfeec247 | 238 | use rustc_span::Span; |
83c7162d | 239 | use rustc_target::spec::{Target, TargetTriple}; |
1a4d82fc | 240 | |
1b1a35ee | 241 | use snap::read::FrameDecoder; |
f2b60f7d | 242 | use std::borrow::Cow; |
c295e0f8 | 243 | use std::fmt::Write as _; |
3dfed10e | 244 | use std::io::{Read, Result as IoResult, Write}; |
c34b1796 | 245 | use std::path::{Path, PathBuf}; |
3dfed10e | 246 | use std::{cmp, fmt, fs}; |
223e47cc | 247 | |
532ac7d7 | 248 | #[derive(Clone)] |
923072b8 | 249 | pub(crate) struct CrateLocator<'a> { |
60c5eb7d | 250 | // Immutable per-session configuration. |
c295e0f8 XL |
251 | only_needs_metadata: bool, |
252 | sysroot: &'a Path, | |
60c5eb7d XL |
253 | metadata_loader: &'a dyn MetadataLoader, |
254 | ||
255 | // Immutable per-search configuration. | |
256 | crate_name: Symbol, | |
5869c6ff | 257 | exact_paths: Vec<CanonicalizedPath>, |
60c5eb7d | 258 | pub hash: Option<Svh>, |
60c5eb7d | 259 | extra_filename: Option<&'a str>, |
85aaf69f | 260 | pub target: &'a Target, |
532ac7d7 | 261 | pub triple: TargetTriple, |
1a4d82fc | 262 | pub filesearch: FileSearch<'a>, |
c295e0f8 | 263 | pub is_proc_macro: bool, |
60c5eb7d XL |
264 | |
265 | // Mutable in-progress state or output. | |
c295e0f8 | 266 | crate_rejections: CrateRejections, |
223e47cc LB |
267 | } |
268 | ||
3dfed10e | 269 | #[derive(Clone)] |
923072b8 | 270 | pub(crate) struct CratePaths { |
60c5eb7d XL |
271 | name: Symbol, |
272 | source: CrateSource, | |
273 | } | |
274 | ||
275 | impl CratePaths { | |
923072b8 | 276 | pub(crate) fn new(name: Symbol, source: CrateSource) -> CratePaths { |
60c5eb7d XL |
277 | CratePaths { name, source } |
278 | } | |
223e47cc LB |
279 | } |
280 | ||
a7813a04 | 281 | #[derive(Copy, Clone, PartialEq)] |
923072b8 | 282 | pub(crate) enum CrateFlavor { |
a7813a04 | 283 | Rlib, |
476ff2be | 284 | Rmeta, |
c30ab7b3 | 285 | Dylib, |
a7813a04 XL |
286 | } |
287 | ||
288 | impl fmt::Display for CrateFlavor { | |
9fa01778 | 289 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |
a7813a04 XL |
290 | f.write_str(match *self { |
291 | CrateFlavor::Rlib => "rlib", | |
476ff2be | 292 | CrateFlavor::Rmeta => "rmeta", |
c30ab7b3 | 293 | CrateFlavor::Dylib => "dylib", |
a7813a04 XL |
294 | }) |
295 | } | |
296 | } | |
297 | ||
f2b60f7d FG |
298 | impl IntoDiagnosticArg for CrateFlavor { |
299 | fn into_diagnostic_arg(self) -> rustc_errors::DiagnosticArgValue<'static> { | |
300 | match self { | |
301 | CrateFlavor::Rlib => DiagnosticArgValue::Str(Cow::Borrowed("rlib")), | |
302 | CrateFlavor::Rmeta => DiagnosticArgValue::Str(Cow::Borrowed("rmeta")), | |
303 | CrateFlavor::Dylib => DiagnosticArgValue::Str(Cow::Borrowed("dylib")), | |
304 | } | |
305 | } | |
306 | } | |
307 | ||
60c5eb7d | 308 | impl<'a> CrateLocator<'a> { |
923072b8 | 309 | pub(crate) fn new( |
60c5eb7d XL |
310 | sess: &'a Session, |
311 | metadata_loader: &'a dyn MetadataLoader, | |
312 | crate_name: Symbol, | |
313 | hash: Option<Svh>, | |
60c5eb7d XL |
314 | extra_filename: Option<&'a str>, |
315 | is_host: bool, | |
316 | path_kind: PathKind, | |
60c5eb7d | 317 | ) -> CrateLocator<'a> { |
c295e0f8 XL |
318 | // The all loop is because `--crate-type=rlib --crate-type=rlib` is |
319 | // legal and produces both inside this type. | |
320 | let is_rlib = sess.crate_types().iter().all(|c| *c == CrateType::Rlib); | |
321 | let needs_object_code = sess.opts.output_types.should_codegen(); | |
322 | // If we're producing an rlib, then we don't need object code. | |
323 | // Or, if we're not producing object code, then we don't need it either | |
324 | // (e.g., if we're a cdylib but emitting just metadata). | |
325 | let only_needs_metadata = is_rlib || !needs_object_code; | |
326 | ||
60c5eb7d | 327 | CrateLocator { |
c295e0f8 XL |
328 | only_needs_metadata, |
329 | sysroot: &sess.sysroot, | |
60c5eb7d XL |
330 | metadata_loader, |
331 | crate_name, | |
332 | exact_paths: if hash.is_none() { | |
dfeec247 XL |
333 | sess.opts |
334 | .externs | |
a2a8927a | 335 | .get(crate_name.as_str()) |
dfeec247 | 336 | .into_iter() |
60c5eb7d XL |
337 | .filter_map(|entry| entry.files()) |
338 | .flatten() | |
5869c6ff | 339 | .cloned() |
dfeec247 | 340 | .collect() |
60c5eb7d XL |
341 | } else { |
342 | // SVH being specified means this is a transitive dependency, | |
343 | // so `--extern` options do not apply. | |
344 | Vec::new() | |
345 | }, | |
346 | hash, | |
60c5eb7d | 347 | extra_filename, |
29967ef6 | 348 | target: if is_host { &sess.host } else { &sess.target }, |
60c5eb7d XL |
349 | triple: if is_host { |
350 | TargetTriple::from_triple(config::host_triple()) | |
351 | } else { | |
352 | sess.opts.target_triple.clone() | |
353 | }, | |
354 | filesearch: if is_host { | |
355 | sess.host_filesearch(path_kind) | |
356 | } else { | |
357 | sess.target_filesearch(path_kind) | |
358 | }, | |
c295e0f8 XL |
359 | is_proc_macro: false, |
360 | crate_rejections: CrateRejections::default(), | |
60c5eb7d XL |
361 | } |
362 | } | |
363 | ||
923072b8 | 364 | pub(crate) fn reset(&mut self) { |
c295e0f8 XL |
365 | self.crate_rejections.via_hash.clear(); |
366 | self.crate_rejections.via_triple.clear(); | |
367 | self.crate_rejections.via_kind.clear(); | |
368 | self.crate_rejections.via_version.clear(); | |
369 | self.crate_rejections.via_filename.clear(); | |
3c0e092e | 370 | self.crate_rejections.via_invalid.clear(); |
532ac7d7 XL |
371 | } |
372 | ||
923072b8 | 373 | pub(crate) fn maybe_load_library_crate(&mut self) -> Result<Option<Library>, CrateError> { |
60c5eb7d XL |
374 | if !self.exact_paths.is_empty() { |
375 | return self.find_commandline_library(); | |
376 | } | |
b7449926 | 377 | let mut seen_paths = FxHashSet::default(); |
3dfed10e XL |
378 | if let Some(extra_filename) = self.extra_filename { |
379 | if let library @ Some(_) = self.find_library_crate(extra_filename, &mut seen_paths)? { | |
380 | return Ok(library); | |
476ff2be SL |
381 | } |
382 | } | |
3dfed10e | 383 | self.find_library_crate("", &mut seen_paths) |
1a4d82fc JJ |
384 | } |
385 | ||
dfeec247 XL |
386 | fn find_library_crate( |
387 | &mut self, | |
388 | extra_prefix: &str, | |
389 | seen_paths: &mut FxHashSet<PathBuf>, | |
3dfed10e | 390 | ) -> Result<Option<Library>, CrateError> { |
5099ac24 FG |
391 | let rmeta_prefix = &format!("lib{}{}", self.crate_name, extra_prefix); |
392 | let rlib_prefix = rmeta_prefix; | |
393 | let dylib_prefix = | |
394 | &format!("{}{}{}", self.target.dll_prefix, self.crate_name, extra_prefix); | |
3dfed10e | 395 | let staticlib_prefix = |
5099ac24 FG |
396 | &format!("{}{}{}", self.target.staticlib_prefix, self.crate_name, extra_prefix); |
397 | ||
398 | let rmeta_suffix = ".rmeta"; | |
399 | let rlib_suffix = ".rlib"; | |
400 | let dylib_suffix = &self.target.dll_suffix; | |
401 | let staticlib_suffix = &self.target.staticlib_suffix; | |
1a4d82fc | 402 | |
dfeec247 XL |
403 | let mut candidates: FxHashMap<_, (FxHashMap<_, _>, FxHashMap<_, _>, FxHashMap<_, _>)> = |
404 | Default::default(); | |
1a4d82fc JJ |
405 | |
406 | // First, find all possible candidate rlibs and dylibs purely based on | |
407 | // the name of the files themselves. We're trying to match against an | |
408 | // exact crate name and a possibly an exact hash. | |
409 | // | |
410 | // During this step, we can filter all found libraries based on the | |
411 | // name and id found in the crate id (we ignore the path portion for | |
412 | // filename matching), as well as the exact hash (if specified). If we | |
413 | // end up having many candidates, we must look at the metadata to | |
414 | // perform exact matches against hashes/crate ids. Note that opening up | |
415 | // the metadata is where we do an exact match against the full contents | |
416 | // of the crate id (path/name/id). | |
417 | // | |
418 | // The goal of this step is to look at as little metadata as possible. | |
5099ac24 FG |
419 | // Unfortunately, the prefix-based matching sometimes is over-eager. |
420 | // E.g. if `rlib_suffix` is `libstd` it'll match the file | |
421 | // `libstd_detect-8d6701fb958915ad.rlib` (incorrect) as well as | |
422 | // `libstd-f3ab5b1dea981f17.rlib` (correct). But this is hard to avoid | |
423 | // given that `extra_filename` comes from the `-C extra-filename` | |
424 | // option and thus can be anything, and the incorrect match will be | |
425 | // handled safely in `extract_one`. | |
426 | for search_path in self.filesearch.search_paths() { | |
427 | debug!("searching {}", search_path.dir.display()); | |
428 | for spf in search_path.files.iter() { | |
429 | debug!("testing {}", spf.path.display()); | |
430 | ||
431 | let f = &spf.file_name_str; | |
432 | let (hash, kind) = if f.starts_with(rlib_prefix) && f.ends_with(rlib_suffix) { | |
433 | (&f[rlib_prefix.len()..(f.len() - rlib_suffix.len())], CrateFlavor::Rlib) | |
434 | } else if f.starts_with(rmeta_prefix) && f.ends_with(rmeta_suffix) { | |
435 | (&f[rmeta_prefix.len()..(f.len() - rmeta_suffix.len())], CrateFlavor::Rmeta) | |
5e7ed085 | 436 | } else if f.starts_with(dylib_prefix) && f.ends_with(dylib_suffix.as_ref()) { |
5099ac24 FG |
437 | (&f[dylib_prefix.len()..(f.len() - dylib_suffix.len())], CrateFlavor::Dylib) |
438 | } else { | |
5e7ed085 | 439 | if f.starts_with(staticlib_prefix) && f.ends_with(staticlib_suffix.as_ref()) { |
5099ac24 FG |
440 | self.crate_rejections.via_kind.push(CrateMismatch { |
441 | path: spf.path.clone(), | |
442 | got: "static".to_string(), | |
443 | }); | |
444 | } | |
445 | continue; | |
446 | }; | |
83c7162d | 447 | |
5099ac24 | 448 | info!("lib candidate: {}", spf.path.display()); |
1a4d82fc | 449 | |
5099ac24 FG |
450 | let (rlibs, rmetas, dylibs) = candidates.entry(hash.to_string()).or_default(); |
451 | let path = fs::canonicalize(&spf.path).unwrap_or_else(|_| spf.path.clone()); | |
452 | if seen_paths.contains(&path) { | |
453 | continue; | |
454 | }; | |
455 | seen_paths.insert(path.clone()); | |
456 | match kind { | |
457 | CrateFlavor::Rlib => rlibs.insert(path, search_path.kind), | |
458 | CrateFlavor::Rmeta => rmetas.insert(path, search_path.kind), | |
459 | CrateFlavor::Dylib => dylibs.insert(path, search_path.kind), | |
460 | }; | |
461 | } | |
462 | } | |
1a4d82fc JJ |
463 | |
464 | // We have now collected all known libraries into a set of candidates | |
465 | // keyed of the filename hash listed. For each filename, we also have a | |
466 | // list of rlibs/dylibs that apply. Here, we map each of these lists | |
467 | // (per hash), to a Library candidate for returning. | |
468 | // | |
469 | // A Library candidate is created if the metadata for the set of | |
470 | // libraries corresponds to the crate id and hash criteria that this | |
471 | // search is being performed for. | |
0bf4aa26 | 472 | let mut libraries = FxHashMap::default(); |
476ff2be | 473 | for (_hash, (rlibs, rmetas, dylibs)) in candidates { |
3dfed10e | 474 | if let Some((svh, lib)) = self.extract_lib(rlibs, rmetas, dylibs)? { |
e74abb32 | 475 | libraries.insert(svh, lib); |
1a4d82fc JJ |
476 | } |
477 | } | |
478 | ||
479 | // Having now translated all relevant found hashes into libraries, see | |
480 | // what we've got and figure out if we found multiple candidates for | |
481 | // libraries or not. | |
482 | match libraries.len() { | |
3dfed10e XL |
483 | 0 => Ok(None), |
484 | 1 => Ok(Some(libraries.into_iter().next().unwrap().1)), | |
485 | _ => Err(CrateError::MultipleMatchingCrates(self.crate_name, libraries)), | |
1a4d82fc JJ |
486 | } |
487 | } | |
488 | ||
e74abb32 XL |
489 | fn extract_lib( |
490 | &mut self, | |
491 | rlibs: FxHashMap<PathBuf, PathKind>, | |
492 | rmetas: FxHashMap<PathBuf, PathKind>, | |
493 | dylibs: FxHashMap<PathBuf, PathKind>, | |
3dfed10e | 494 | ) -> Result<Option<(Svh, Library)>, CrateError> { |
e74abb32 | 495 | let mut slot = None; |
dfeec247 XL |
496 | // Order here matters, rmeta should come first. See comment in |
497 | // `extract_one` below. | |
e74abb32 | 498 | let source = CrateSource { |
3dfed10e XL |
499 | rmeta: self.extract_one(rmetas, CrateFlavor::Rmeta, &mut slot)?, |
500 | rlib: self.extract_one(rlibs, CrateFlavor::Rlib, &mut slot)?, | |
501 | dylib: self.extract_one(dylibs, CrateFlavor::Dylib, &mut slot)?, | |
e74abb32 | 502 | }; |
3dfed10e | 503 | Ok(slot.map(|(svh, metadata)| (svh, Library { source, metadata }))) |
e74abb32 XL |
504 | } |
505 | ||
dfeec247 | 506 | fn needs_crate_flavor(&self, flavor: CrateFlavor) -> bool { |
c295e0f8 | 507 | if flavor == CrateFlavor::Dylib && self.is_proc_macro { |
dfeec247 XL |
508 | return true; |
509 | } | |
510 | ||
c295e0f8 | 511 | if self.only_needs_metadata { |
dfeec247 XL |
512 | flavor == CrateFlavor::Rmeta |
513 | } else { | |
514 | // we need all flavors (perhaps not true, but what we do for now) | |
515 | true | |
516 | } | |
517 | } | |
518 | ||
1a4d82fc JJ |
519 | // Attempts to extract *one* library from the set `m`. If the set has no |
520 | // elements, `None` is returned. If the set has more than one element, then | |
521 | // the errors and notes are emitted about the set of libraries. | |
522 | // | |
523 | // With only one library in the set, this function will extract it, and then | |
524 | // read the metadata from it if `*slot` is `None`. If the metadata couldn't | |
525 | // be read, it is assumed that the file isn't a valid rust library (no | |
526 | // errors are emitted). | |
dfeec247 XL |
527 | fn extract_one( |
528 | &mut self, | |
529 | m: FxHashMap<PathBuf, PathKind>, | |
530 | flavor: CrateFlavor, | |
531 | slot: &mut Option<(Svh, MetadataBlob)>, | |
3dfed10e | 532 | ) -> Result<Option<(PathBuf, PathKind)>, CrateError> { |
dfeec247 XL |
533 | // If we are producing an rlib, and we've already loaded metadata, then |
534 | // we should not attempt to discover further crate sources (unless we're | |
535 | // locating a proc macro; exact logic is in needs_crate_flavor). This means | |
536 | // that under -Zbinary-dep-depinfo we will not emit a dependency edge on | |
537 | // the *unused* rlib, and by returning `None` here immediately we | |
538 | // guarantee that we do indeed not use it. | |
539 | // | |
540 | // See also #68149 which provides more detail on why emitting the | |
541 | // dependency on the rlib is a bad thing. | |
542 | // | |
74b04a01 | 543 | // We currently do not verify that these other sources are even in sync, |
dfeec247 XL |
544 | // and this is arguably a bug (see #10786), but because reading metadata |
545 | // is quite slow (especially from dylibs) we currently do not read it | |
546 | // from the other crate sources. | |
1a4d82fc | 547 | if slot.is_some() { |
dfeec247 | 548 | if m.is_empty() || !self.needs_crate_flavor(flavor) { |
3dfed10e | 549 | return Ok(None); |
1a4d82fc | 550 | } else if m.len() == 1 { |
3dfed10e | 551 | return Ok(Some(m.into_iter().next().unwrap())); |
1a4d82fc JJ |
552 | } |
553 | } | |
554 | ||
3dfed10e XL |
555 | let mut ret: Option<(PathBuf, PathKind)> = None; |
556 | let mut err_data: Option<Vec<PathBuf>> = None; | |
85aaf69f | 557 | for (lib, kind) in m { |
1a4d82fc | 558 | info!("{} reading metadata from: {}", flavor, lib.display()); |
c295e0f8 XL |
559 | if flavor == CrateFlavor::Rmeta && lib.metadata().map_or(false, |m| m.len() == 0) { |
560 | // Empty files will cause get_metadata_section to fail. Rmeta | |
561 | // files can be empty, for example with binaries (which can | |
562 | // often appear with `cargo check` when checking a library as | |
563 | // a unittest). We don't want to emit a user-visible warning | |
564 | // in this case as it is not a real problem. | |
565 | debug!("skipping empty file"); | |
566 | continue; | |
567 | } | |
7cac9316 XL |
568 | let (hash, metadata) = |
569 | match get_metadata_section(self.target, flavor, &lib, self.metadata_loader) { | |
570 | Ok(blob) => { | |
571 | if let Some(h) = self.crate_matches(&blob, &lib) { | |
572 | (h, blob) | |
573 | } else { | |
574 | info!("metadata mismatch"); | |
575 | continue; | |
576 | } | |
577 | } | |
3c0e092e XL |
578 | Err(MetadataError::LoadFailure(err)) => { |
579 | info!("no metadata found: {}", err); | |
580 | // The file was present and created by the same compiler version, but we | |
581 | // couldn't load it for some reason. Give a hard error instead of silently | |
582 | // ignoring it, but only if we would have given an error anyway. | |
583 | self.crate_rejections | |
584 | .via_invalid | |
585 | .push(CrateMismatch { path: lib, got: err }); | |
586 | continue; | |
587 | } | |
588 | Err(err @ MetadataError::NotPresent(_)) => { | |
589 | info!("no metadata found: {}", err); | |
c30ab7b3 | 590 | continue; |
1a4d82fc | 591 | } |
7cac9316 | 592 | }; |
a7813a04 XL |
593 | // If we see multiple hashes, emit an error about duplicate candidates. |
594 | if slot.as_ref().map_or(false, |s| s.0 != hash) { | |
3dfed10e XL |
595 | if let Some(candidates) = err_data { |
596 | return Err(CrateError::MultipleCandidates( | |
597 | self.crate_name, | |
598 | flavor, | |
599 | candidates, | |
600 | )); | |
9cc50fc6 | 601 | } |
3dfed10e | 602 | err_data = Some(vec![ret.as_ref().unwrap().0.clone()]); |
a7813a04 | 603 | *slot = None; |
1a4d82fc | 604 | } |
3dfed10e XL |
605 | if let Some(candidates) = &mut err_data { |
606 | candidates.push(lib); | |
c30ab7b3 | 607 | continue; |
970d7e83 | 608 | } |
8bb4bdeb XL |
609 | |
610 | // Ok so at this point we've determined that `(lib, kind)` above is | |
611 | // a candidate crate to load, and that `slot` is either none (this | |
612 | // is the first crate of its kind) or if some the previous path has | |
0731742a | 613 | // the exact same hash (e.g., it's the exact same crate). |
8bb4bdeb XL |
614 | // |
615 | // In principle these two candidate crates are exactly the same so | |
616 | // we can choose either of them to link. As a stupidly gross hack, | |
617 | // however, we favor crate in the sysroot. | |
618 | // | |
619 | // You can find more info in rust-lang/rust#39518 and various linked | |
620 | // issues, but the general gist is that during testing libstd the | |
621 | // compilers has two candidates to choose from: one in the sysroot | |
622 | // and one in the deps folder. These two crates are the exact same | |
623 | // crate but if the compiler chooses the one in the deps folder | |
624 | // it'll cause spurious errors on Windows. | |
625 | // | |
626 | // As a result, we favor the sysroot crate here. Note that the | |
627 | // candidates are all canonicalized, so we canonicalize the sysroot | |
628 | // as well. | |
3dfed10e | 629 | if let Some((prev, _)) = &ret { |
c295e0f8 | 630 | let sysroot = self.sysroot; |
dfeec247 | 631 | let sysroot = sysroot.canonicalize().unwrap_or_else(|_| sysroot.to_path_buf()); |
8bb4bdeb | 632 | if prev.starts_with(&sysroot) { |
dfeec247 | 633 | continue; |
8bb4bdeb XL |
634 | } |
635 | } | |
a7813a04 | 636 | *slot = Some((hash, metadata)); |
85aaf69f | 637 | ret = Some((lib, kind)); |
1a4d82fc | 638 | } |
9cc50fc6 | 639 | |
3dfed10e XL |
640 | if let Some(candidates) = err_data { |
641 | Err(CrateError::MultipleCandidates(self.crate_name, flavor, candidates)) | |
9cc50fc6 | 642 | } else { |
3dfed10e | 643 | Ok(ret) |
9cc50fc6 | 644 | } |
1a4d82fc JJ |
645 | } |
646 | ||
9e0c209e | 647 | fn crate_matches(&mut self, metadata: &MetadataBlob, libpath: &Path) -> Option<Svh> { |
c30ab7b3 | 648 | let rustc_version = rustc_version(); |
476ff2be SL |
649 | let found_version = metadata.get_rustc_version(); |
650 | if found_version != rustc_version { | |
dfeec247 | 651 | info!("Rejecting via version: expected {} got {}", rustc_version, found_version); |
c295e0f8 XL |
652 | self.crate_rejections |
653 | .via_version | |
dfeec247 | 654 | .push(CrateMismatch { path: libpath.to_path_buf(), got: found_version }); |
a7813a04 XL |
655 | return None; |
656 | } | |
657 | ||
476ff2be | 658 | let root = metadata.get_root(); |
c295e0f8 XL |
659 | if root.is_proc_macro_crate() != self.is_proc_macro { |
660 | info!( | |
661 | "Rejecting via proc macro: expected {} got {}", | |
662 | self.is_proc_macro, | |
663 | root.is_proc_macro_crate(), | |
664 | ); | |
665 | return None; | |
476ff2be SL |
666 | } |
667 | ||
29967ef6 XL |
668 | if self.exact_paths.is_empty() && self.crate_name != root.name() { |
669 | info!("Rejecting via crate name"); | |
670 | return None; | |
1a4d82fc | 671 | } |
1a4d82fc | 672 | |
60c5eb7d | 673 | if root.triple() != &self.triple { |
dfeec247 | 674 | info!("Rejecting via crate triple: expected {} got {}", self.triple, root.triple()); |
c295e0f8 | 675 | self.crate_rejections.via_triple.push(CrateMismatch { |
c34b1796 | 676 | path: libpath.to_path_buf(), |
60c5eb7d | 677 | got: root.triple().to_string(), |
1a4d82fc | 678 | }); |
a7813a04 | 679 | return None; |
223e47cc | 680 | } |
223e47cc | 681 | |
60c5eb7d XL |
682 | let hash = root.hash(); |
683 | if let Some(expected_hash) = self.hash { | |
684 | if hash != expected_hash { | |
685 | info!("Rejecting via hash: expected {} got {}", expected_hash, hash); | |
c295e0f8 XL |
686 | self.crate_rejections |
687 | .via_hash | |
dfeec247 | 688 | .push(CrateMismatch { path: libpath.to_path_buf(), got: hash.to_string() }); |
a7813a04 | 689 | return None; |
1a4d82fc | 690 | } |
223e47cc | 691 | } |
a7813a04 | 692 | |
60c5eb7d | 693 | Some(hash) |
223e47cc | 694 | } |
223e47cc | 695 | |
3dfed10e | 696 | fn find_commandline_library(&mut self) -> Result<Option<Library>, CrateError> { |
1a4d82fc JJ |
697 | // First, filter out all libraries that look suspicious. We only accept |
698 | // files which actually exist that have the correct naming scheme for | |
699 | // rlibs/dylibs. | |
0bf4aa26 XL |
700 | let mut rlibs = FxHashMap::default(); |
701 | let mut rmetas = FxHashMap::default(); | |
702 | let mut dylibs = FxHashMap::default(); | |
3dfed10e | 703 | for loc in &self.exact_paths { |
5869c6ff XL |
704 | if !loc.canonicalized().exists() { |
705 | return Err(CrateError::ExternLocationNotExist( | |
706 | self.crate_name, | |
707 | loc.original().clone(), | |
708 | )); | |
3dfed10e | 709 | } |
5e7ed085 FG |
710 | let Some(file) = loc.original().file_name().and_then(|s| s.to_str()) else { |
711 | return Err(CrateError::ExternLocationNotFile( | |
712 | self.crate_name, | |
713 | loc.original().clone(), | |
714 | )); | |
3dfed10e | 715 | }; |
476ff2be | 716 | |
3dfed10e | 717 | if file.starts_with("lib") && (file.ends_with(".rlib") || file.ends_with(".rmeta")) |
5e7ed085 FG |
718 | || file.starts_with(self.target.dll_prefix.as_ref()) |
719 | && file.ends_with(self.target.dll_suffix.as_ref()) | |
3dfed10e XL |
720 | { |
721 | // Make sure there's at most one rlib and at most one dylib. | |
722 | // Note to take care and match against the non-canonicalized name: | |
723 | // some systems save build artifacts into content-addressed stores | |
724 | // that do not preserve extensions, and then link to them using | |
725 | // e.g. symbolic links. If we canonicalize too early, we resolve | |
726 | // the symlink, the file type is lost and we might treat rlibs and | |
727 | // rmetas as dylibs. | |
5869c6ff XL |
728 | let loc_canon = loc.canonicalized().clone(); |
729 | let loc = loc.original(); | |
c34b1796 | 730 | if loc.file_name().unwrap().to_str().unwrap().ends_with(".rlib") { |
3dfed10e | 731 | rlibs.insert(loc_canon, PathKind::ExternFlag); |
476ff2be | 732 | } else if loc.file_name().unwrap().to_str().unwrap().ends_with(".rmeta") { |
3dfed10e | 733 | rmetas.insert(loc_canon, PathKind::ExternFlag); |
1a4d82fc | 734 | } else { |
3dfed10e | 735 | dylibs.insert(loc_canon, PathKind::ExternFlag); |
1a4d82fc | 736 | } |
3dfed10e | 737 | } else { |
c295e0f8 XL |
738 | self.crate_rejections |
739 | .via_filename | |
5869c6ff | 740 | .push(CrateMismatch { path: loc.original().clone(), got: String::new() }); |
1a4d82fc | 741 | } |
3dfed10e | 742 | } |
1a4d82fc | 743 | |
e74abb32 | 744 | // Extract the dylib/rlib/rmeta triple. |
3dfed10e | 745 | Ok(self.extract_lib(rlibs, rmetas, dylibs)?.map(|(_, lib)| lib)) |
223e47cc | 746 | } |
223e47cc | 747 | |
923072b8 | 748 | pub(crate) fn into_error(self, root: Option<CratePaths>) -> CrateError { |
3dfed10e XL |
749 | CrateError::LocatorCombined(CombinedLocatorError { |
750 | crate_name: self.crate_name, | |
c295e0f8 | 751 | root, |
3dfed10e | 752 | triple: self.triple, |
5e7ed085 FG |
753 | dll_prefix: self.target.dll_prefix.to_string(), |
754 | dll_suffix: self.target.dll_suffix.to_string(), | |
c295e0f8 | 755 | crate_rejections: self.crate_rejections, |
3dfed10e XL |
756 | }) |
757 | } | |
223e47cc LB |
758 | } |
759 | ||
a2a8927a | 760 | fn get_metadata_section<'p>( |
dfeec247 XL |
761 | target: &Target, |
762 | flavor: CrateFlavor, | |
3c0e092e | 763 | filename: &'p Path, |
dfeec247 | 764 | loader: &dyn MetadataLoader, |
3c0e092e | 765 | ) -> Result<MetadataBlob, MetadataError<'p>> { |
1a4d82fc | 766 | if !filename.exists() { |
3c0e092e | 767 | return Err(MetadataError::NotPresent(filename)); |
1a4d82fc | 768 | } |
0531ce1d | 769 | let raw_bytes: MetadataRef = match flavor { |
3c0e092e XL |
770 | CrateFlavor::Rlib => { |
771 | loader.get_rlib_metadata(target, filename).map_err(MetadataError::LoadFailure)? | |
772 | } | |
7cac9316 | 773 | CrateFlavor::Dylib => { |
3c0e092e XL |
774 | let buf = |
775 | loader.get_dylib_metadata(target, filename).map_err(MetadataError::LoadFailure)?; | |
7cac9316 XL |
776 | // The header is uncompressed |
777 | let header_len = METADATA_HEADER.len(); | |
778 | debug!("checking {} bytes of metadata-version stamp", header_len); | |
779 | let header = &buf[..cmp::min(header_len, buf.len())]; | |
780 | if header != METADATA_HEADER { | |
3c0e092e XL |
781 | return Err(MetadataError::LoadFailure(format!( |
782 | "invalid metadata version found: {}", | |
dfeec247 | 783 | filename.display() |
3c0e092e | 784 | ))); |
1a4d82fc | 785 | } |
223e47cc | 786 | |
7cac9316 XL |
787 | // Header is okay -> inflate the actual metadata |
788 | let compressed_bytes = &buf[header_len..]; | |
789 | debug!("inflating {} bytes of compressed metadata", compressed_bytes.len()); | |
c295e0f8 XL |
790 | // Assume the decompressed data will be at least the size of the compressed data, so we |
791 | // don't have to grow the buffer as much. | |
792 | let mut inflated = Vec::with_capacity(compressed_bytes.len()); | |
1b1a35ee | 793 | match FrameDecoder::new(compressed_bytes).read_to_end(&mut inflated) { |
dfeec247 | 794 | Ok(_) => rustc_erase_owner!(OwningRef::new(inflated).map_owner_box()), |
7cac9316 | 795 | Err(_) => { |
3c0e092e XL |
796 | return Err(MetadataError::LoadFailure(format!( |
797 | "failed to decompress metadata: {}", | |
798 | filename.display() | |
799 | ))); | |
223e47cc LB |
800 | } |
801 | } | |
223e47cc | 802 | } |
7cac9316 | 803 | CrateFlavor::Rmeta => { |
a1dfa0c6 | 804 | // mmap the file, because only a small fraction of it is read. |
3c0e092e XL |
805 | let file = std::fs::File::open(filename).map_err(|_| { |
806 | MetadataError::LoadFailure(format!( | |
807 | "failed to open rmeta metadata: '{}'", | |
808 | filename.display() | |
809 | )) | |
810 | })?; | |
cdc7bbd5 | 811 | let mmap = unsafe { Mmap::map(file) }; |
3c0e092e XL |
812 | let mmap = mmap.map_err(|_| { |
813 | MetadataError::LoadFailure(format!( | |
814 | "failed to mmap rmeta metadata: '{}'", | |
815 | filename.display() | |
816 | )) | |
817 | })?; | |
a1dfa0c6 | 818 | |
cdc7bbd5 | 819 | rustc_erase_owner!(OwningRef::new(mmap).map_owner_box()) |
7cac9316 XL |
820 | } |
821 | }; | |
60c5eb7d | 822 | let blob = MetadataBlob::new(raw_bytes); |
7cac9316 XL |
823 | if blob.is_compatible() { |
824 | Ok(blob) | |
1a4d82fc | 825 | } else { |
3c0e092e XL |
826 | Err(MetadataError::LoadFailure(format!( |
827 | "invalid metadata version found: {}", | |
828 | filename.display() | |
829 | ))) | |
223e47cc LB |
830 | } |
831 | } | |
832 | ||
e74abb32 XL |
833 | /// Look for a plugin registrar. Returns its library path and crate disambiguator. |
834 | pub fn find_plugin_registrar( | |
835 | sess: &Session, | |
836 | metadata_loader: &dyn MetadataLoader, | |
837 | span: Span, | |
838 | name: Symbol, | |
94222f64 | 839 | ) -> PathBuf { |
a2a8927a | 840 | find_plugin_registrar_impl(sess, metadata_loader, name).unwrap_or_else(|err| { |
cdc7bbd5 | 841 | // `core` is always available if we got as far as loading plugins. |
a2a8927a XL |
842 | err.report(sess, span, false); |
843 | FatalError.raise() | |
844 | }) | |
3dfed10e XL |
845 | } |
846 | ||
847 | fn find_plugin_registrar_impl<'a>( | |
848 | sess: &'a Session, | |
849 | metadata_loader: &dyn MetadataLoader, | |
850 | name: Symbol, | |
94222f64 | 851 | ) -> Result<PathBuf, CrateError> { |
e74abb32 | 852 | info!("find plugin registrar `{}`", name); |
60c5eb7d | 853 | let mut locator = CrateLocator::new( |
e74abb32 | 854 | sess, |
e74abb32 | 855 | metadata_loader, |
60c5eb7d XL |
856 | name, |
857 | None, // hash | |
60c5eb7d XL |
858 | None, // extra_filename |
859 | true, // is_host | |
860 | PathKind::Crate, | |
60c5eb7d | 861 | ); |
e74abb32 | 862 | |
3dfed10e XL |
863 | match locator.maybe_load_library_crate()? { |
864 | Some(library) => match library.source.dylib { | |
94222f64 | 865 | Some(dylib) => Ok(dylib.0), |
3dfed10e XL |
866 | None => Err(CrateError::NonDylibPlugin(name)), |
867 | }, | |
c295e0f8 | 868 | None => Err(locator.into_error(None)), |
e74abb32 XL |
869 | } |
870 | } | |
871 | ||
9fa01778 | 872 | /// A diagnostic function for dumping crate metadata to an output stream. |
dfeec247 XL |
873 | pub fn list_file_metadata( |
874 | target: &Target, | |
875 | path: &Path, | |
876 | metadata_loader: &dyn MetadataLoader, | |
3dfed10e XL |
877 | out: &mut dyn Write, |
878 | ) -> IoResult<()> { | |
a7813a04 | 879 | let filename = path.file_name().unwrap().to_str().unwrap(); |
c30ab7b3 SL |
880 | let flavor = if filename.ends_with(".rlib") { |
881 | CrateFlavor::Rlib | |
476ff2be SL |
882 | } else if filename.ends_with(".rmeta") { |
883 | CrateFlavor::Rmeta | |
c30ab7b3 SL |
884 | } else { |
885 | CrateFlavor::Dylib | |
886 | }; | |
e74abb32 | 887 | match get_metadata_section(target, flavor, path, metadata_loader) { |
9e0c209e | 888 | Ok(metadata) => metadata.list_crate_metadata(out), |
c30ab7b3 | 889 | Err(msg) => write!(out, "{}\n", msg), |
223e47cc LB |
890 | } |
891 | } | |
3dfed10e XL |
892 | |
893 | // ------------------------------------------ Error reporting ------------------------------------- | |
894 | ||
895 | #[derive(Clone)] | |
896 | struct CrateMismatch { | |
897 | path: PathBuf, | |
898 | got: String, | |
899 | } | |
900 | ||
c295e0f8 XL |
901 | #[derive(Clone, Default)] |
902 | struct CrateRejections { | |
903 | via_hash: Vec<CrateMismatch>, | |
904 | via_triple: Vec<CrateMismatch>, | |
905 | via_kind: Vec<CrateMismatch>, | |
906 | via_version: Vec<CrateMismatch>, | |
907 | via_filename: Vec<CrateMismatch>, | |
3c0e092e | 908 | via_invalid: Vec<CrateMismatch>, |
c295e0f8 XL |
909 | } |
910 | ||
3dfed10e XL |
911 | /// Candidate rejection reasons collected during crate search. |
912 | /// If no candidate is accepted, then these reasons are presented to the user, | |
913 | /// otherwise they are ignored. | |
923072b8 | 914 | pub(crate) struct CombinedLocatorError { |
3dfed10e XL |
915 | crate_name: Symbol, |
916 | root: Option<CratePaths>, | |
917 | triple: TargetTriple, | |
918 | dll_prefix: String, | |
919 | dll_suffix: String, | |
c295e0f8 | 920 | crate_rejections: CrateRejections, |
3dfed10e XL |
921 | } |
922 | ||
923072b8 | 923 | pub(crate) enum CrateError { |
3dfed10e XL |
924 | NonAsciiName(Symbol), |
925 | ExternLocationNotExist(Symbol, PathBuf), | |
926 | ExternLocationNotFile(Symbol, PathBuf), | |
927 | MultipleCandidates(Symbol, CrateFlavor, Vec<PathBuf>), | |
928 | MultipleMatchingCrates(Symbol, FxHashMap<Svh, Library>), | |
929 | SymbolConflictsCurrent(Symbol), | |
930 | SymbolConflictsOthers(Symbol), | |
6a06907d | 931 | StableCrateIdCollision(Symbol, Symbol), |
3dfed10e XL |
932 | DlOpen(String), |
933 | DlSym(String), | |
934 | LocatorCombined(CombinedLocatorError), | |
935 | NonDylibPlugin(Symbol), | |
936 | } | |
937 | ||
3c0e092e XL |
938 | enum MetadataError<'a> { |
939 | /// The file was missing. | |
940 | NotPresent(&'a Path), | |
941 | /// The file was present and invalid. | |
942 | LoadFailure(String), | |
943 | } | |
944 | ||
945 | impl fmt::Display for MetadataError<'_> { | |
946 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | |
947 | match self { | |
948 | MetadataError::NotPresent(filename) => { | |
949 | f.write_str(&format!("no such file: '{}'", filename.display())) | |
950 | } | |
951 | MetadataError::LoadFailure(msg) => f.write_str(msg), | |
952 | } | |
953 | } | |
954 | } | |
955 | ||
3dfed10e | 956 | impl CrateError { |
923072b8 | 957 | pub(crate) fn report(self, sess: &Session, span: Span, missing_core: bool) { |
f2b60f7d FG |
958 | match self { |
959 | CrateError::NonAsciiName(crate_name) => { | |
960 | sess.emit_err(NonAsciiName { span, crate_name }); | |
961 | } | |
962 | CrateError::ExternLocationNotExist(crate_name, loc) => { | |
963 | sess.emit_err(ExternLocationNotExist { span, crate_name, location: &loc }); | |
964 | } | |
965 | CrateError::ExternLocationNotFile(crate_name, loc) => { | |
966 | sess.emit_err(ExternLocationNotFile { span, crate_name, location: &loc }); | |
967 | } | |
3dfed10e | 968 | CrateError::MultipleCandidates(crate_name, flavor, candidates) => { |
f2b60f7d | 969 | sess.emit_err(MultipleCandidates { span, flavor: flavor, crate_name, candidates }); |
3dfed10e XL |
970 | } |
971 | CrateError::MultipleMatchingCrates(crate_name, libraries) => { | |
c295e0f8 XL |
972 | let mut libraries: Vec<_> = libraries.into_values().collect(); |
973 | // Make ordering of candidates deterministic. | |
974 | // This has to `clone()` to work around lifetime restrictions with `sort_by_key()`. | |
975 | // `sort_by()` could be used instead, but this is in the error path, | |
976 | // so the performance shouldn't matter. | |
977 | libraries.sort_by_cached_key(|lib| lib.source.paths().next().unwrap().clone()); | |
3dfed10e XL |
978 | let candidates = libraries |
979 | .iter() | |
c295e0f8 | 980 | .map(|lib| { |
a2a8927a XL |
981 | let crate_name = lib.metadata.get_root().name(); |
982 | let crate_name = crate_name.as_str(); | |
c295e0f8 XL |
983 | let mut paths = lib.source.paths(); |
984 | ||
985 | // This `unwrap()` should be okay because there has to be at least one | |
986 | // source file. `CrateSource`'s docs confirm that too. | |
987 | let mut s = format!( | |
988 | "\ncrate `{}`: {}", | |
989 | crate_name, | |
990 | paths.next().unwrap().display() | |
991 | ); | |
992 | let padding = 8 + crate_name.len(); | |
993 | for path in paths { | |
994 | write!(s, "\n{:>padding$}", path.display(), padding = padding).unwrap(); | |
3dfed10e | 995 | } |
c295e0f8 | 996 | s |
3dfed10e XL |
997 | }) |
998 | .collect::<String>(); | |
f2b60f7d FG |
999 | sess.emit_err(MultipleMatchingCrates { span, crate_name, candidates }); |
1000 | } | |
1001 | CrateError::SymbolConflictsCurrent(root_name) => { | |
1002 | sess.emit_err(SymbolConflictsCurrent { span, crate_name: root_name }); | |
1003 | } | |
1004 | CrateError::SymbolConflictsOthers(root_name) => { | |
1005 | sess.emit_err(SymbolConflictsOthers { span, crate_name: root_name }); | |
3dfed10e | 1006 | } |
6a06907d | 1007 | CrateError::StableCrateIdCollision(crate_name0, crate_name1) => { |
f2b60f7d FG |
1008 | sess.emit_err(StableCrateIdCollision { |
1009 | span, | |
1010 | crate_name0: crate_name0, | |
1011 | crate_name1: crate_name1, | |
1012 | }); | |
1013 | } | |
1014 | CrateError::DlOpen(s) | CrateError::DlSym(s) => { | |
1015 | sess.emit_err(DlError { span, err: s }); | |
6a06907d | 1016 | } |
3dfed10e XL |
1017 | CrateError::LocatorCombined(locator) => { |
1018 | let crate_name = locator.crate_name; | |
f2b60f7d | 1019 | let add_info = match &locator.root { |
3dfed10e XL |
1020 | None => String::new(), |
1021 | Some(r) => format!(" which `{}` depends on", r.name), | |
1022 | }; | |
f2b60f7d FG |
1023 | // FIXME: There are no tests for CrateLocationUnknownType or LibFilenameForm |
1024 | if !locator.crate_rejections.via_filename.is_empty() { | |
1025 | let mismatches = locator.crate_rejections.via_filename.iter(); | |
1026 | for CrateMismatch { path, .. } in mismatches { | |
1027 | sess.emit_err(CrateLocationUnknownType { span, path: &path }); | |
1028 | sess.emit_err(LibFilenameForm { | |
1029 | span, | |
1030 | dll_prefix: &locator.dll_prefix, | |
1031 | dll_suffix: &locator.dll_suffix, | |
1032 | }); | |
1033 | } | |
1034 | } | |
1035 | let mut found_crates = String::new(); | |
1036 | if !locator.crate_rejections.via_hash.is_empty() { | |
c295e0f8 | 1037 | let mismatches = locator.crate_rejections.via_hash.iter(); |
3dfed10e | 1038 | for CrateMismatch { path, .. } in mismatches { |
f2b60f7d FG |
1039 | found_crates.push_str(&format!( |
1040 | "\ncrate `{}`: {}", | |
1041 | crate_name, | |
1042 | path.display() | |
1043 | )); | |
3dfed10e XL |
1044 | } |
1045 | if let Some(r) = locator.root { | |
1046 | for path in r.source.paths() { | |
f2b60f7d FG |
1047 | found_crates.push_str(&format!( |
1048 | "\ncrate `{}`: {}", | |
1049 | r.name, | |
1050 | path.display() | |
1051 | )); | |
3dfed10e XL |
1052 | } |
1053 | } | |
f2b60f7d | 1054 | sess.emit_err(NewerCrateVersion { |
3dfed10e | 1055 | span, |
f2b60f7d FG |
1056 | crate_name: crate_name, |
1057 | add_info, | |
1058 | found_crates, | |
1059 | }); | |
1060 | } else if !locator.crate_rejections.via_triple.is_empty() { | |
c295e0f8 | 1061 | let mismatches = locator.crate_rejections.via_triple.iter(); |
3dfed10e | 1062 | for CrateMismatch { path, got } in mismatches { |
f2b60f7d | 1063 | found_crates.push_str(&format!( |
3dfed10e XL |
1064 | "\ncrate `{}`, target triple {}: {}", |
1065 | crate_name, | |
1066 | got, | |
1067 | path.display(), | |
1068 | )); | |
1069 | } | |
f2b60f7d | 1070 | sess.emit_err(NoCrateWithTriple { |
3dfed10e | 1071 | span, |
f2b60f7d FG |
1072 | crate_name: crate_name, |
1073 | locator_triple: locator.triple.triple(), | |
1074 | add_info, | |
1075 | found_crates, | |
1076 | }); | |
1077 | } else if !locator.crate_rejections.via_kind.is_empty() { | |
c295e0f8 | 1078 | let mismatches = locator.crate_rejections.via_kind.iter(); |
3dfed10e | 1079 | for CrateMismatch { path, .. } in mismatches { |
f2b60f7d FG |
1080 | found_crates.push_str(&format!( |
1081 | "\ncrate `{}`: {}", | |
1082 | crate_name, | |
1083 | path.display() | |
1084 | )); | |
3dfed10e | 1085 | } |
f2b60f7d | 1086 | sess.emit_err(FoundStaticlib { span, crate_name, add_info, found_crates }); |
c295e0f8 | 1087 | } else if !locator.crate_rejections.via_version.is_empty() { |
c295e0f8 | 1088 | let mismatches = locator.crate_rejections.via_version.iter(); |
3dfed10e | 1089 | for CrateMismatch { path, got } in mismatches { |
f2b60f7d | 1090 | found_crates.push_str(&format!( |
3dfed10e XL |
1091 | "\ncrate `{}` compiled by {}: {}", |
1092 | crate_name, | |
1093 | got, | |
1094 | path.display(), | |
1095 | )); | |
1096 | } | |
f2b60f7d | 1097 | sess.emit_err(IncompatibleRustc { |
3c0e092e | 1098 | span, |
3c0e092e | 1099 | crate_name, |
f2b60f7d FG |
1100 | add_info, |
1101 | found_crates, | |
1102 | rustc_version: rustc_version(), | |
1103 | }); | |
1104 | } else if !locator.crate_rejections.via_invalid.is_empty() { | |
1105 | let mut crate_rejections = Vec::new(); | |
3c0e092e | 1106 | for CrateMismatch { path: _, got } in locator.crate_rejections.via_invalid { |
f2b60f7d | 1107 | crate_rejections.push(got); |
3c0e092e | 1108 | } |
f2b60f7d FG |
1109 | sess.emit_err(InvalidMetadataFiles { |
1110 | span, | |
1111 | crate_name, | |
1112 | add_info, | |
1113 | crate_rejections, | |
1114 | }); | |
3dfed10e | 1115 | } else { |
f2b60f7d | 1116 | sess.emit_err(CannotFindCrate { |
3dfed10e | 1117 | span, |
3dfed10e | 1118 | crate_name, |
f2b60f7d FG |
1119 | add_info, |
1120 | missing_core, | |
1121 | current_crate: sess | |
1122 | .opts | |
1123 | .crate_name | |
1124 | .clone() | |
1125 | .unwrap_or("<unknown>".to_string()), | |
1126 | is_nightly_build: sess.is_nightly_build(), | |
1127 | profiler_runtime: Symbol::intern(&sess.opts.unstable_opts.profiler_runtime), | |
1128 | locator_triple: locator.triple, | |
1129 | }); | |
3dfed10e | 1130 | } |
3dfed10e | 1131 | } |
f2b60f7d FG |
1132 | CrateError::NonDylibPlugin(crate_name) => { |
1133 | sess.emit_err(NoDylibPlugin { span, crate_name }); | |
1134 | } | |
1135 | } | |
3dfed10e XL |
1136 | } |
1137 | } |