]>
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 | //! | |
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: | |
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; |
46de9a89 | 216 | use crate::rmeta::{rustc_version, MetadataBlob, METADATA_HEADER}; |
92a42be0 | 217 | |
e74abb32 | 218 | use rustc::middle::cstore::{CrateSource, MetadataLoader}; |
46de9a89 | 219 | use rustc::session::filesearch::{FileDoesntMatch, FileMatches, FileSearch}; |
92a42be0 | 220 | use rustc::session::search_paths::PathKind; |
46de9a89 FG |
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; | |
83c7162d | 228 | use rustc_target::spec::{Target, TargetTriple}; |
1a4d82fc | 229 | |
1a4d82fc | 230 | use std::cmp; |
a7813a04 | 231 | use std::fmt; |
2c00a5a8 | 232 | use std::fs; |
476ff2be | 233 | use std::io::{self, Read}; |
a1dfa0c6 | 234 | use std::ops::Deref; |
c34b1796 | 235 | use std::path::{Path, PathBuf}; |
92a42be0 | 236 | use std::time::Instant; |
1a4d82fc | 237 | |
041b39d2 | 238 | use flate2::read::DeflateDecoder; |
1a4d82fc | 239 | |
0531ce1d | 240 | use rustc_data_structures::owning_ref::OwningRef; |
a1dfa0c6 | 241 | |
9fa01778 XL |
242 | use log::{debug, info, warn}; |
243 | ||
532ac7d7 | 244 | #[derive(Clone)] |
d9bb1a4e | 245 | struct CrateMismatch { |
c34b1796 | 246 | path: PathBuf, |
1a4d82fc | 247 | got: String, |
223e47cc LB |
248 | } |
249 | ||
532ac7d7 | 250 | #[derive(Clone)] |
d9bb1a4e FG |
251 | crate struct CrateLocator<'a> { |
252 | // Immutable per-session configuration. | |
253 | sess: &'a Session, | |
254 | metadata_loader: &'a dyn MetadataLoader, | |
255 | ||
256 | // Immutable per-search configuration. | |
257 | crate_name: Symbol, | |
258 | exact_paths: Vec<PathBuf>, | |
259 | pub hash: Option<Svh>, | |
260 | pub host_hash: Option<Svh>, | |
261 | extra_filename: Option<&'a str>, | |
85aaf69f | 262 | pub target: &'a Target, |
532ac7d7 | 263 | pub triple: TargetTriple, |
1a4d82fc | 264 | pub filesearch: FileSearch<'a>, |
d9bb1a4e FG |
265 | span: Span, |
266 | root: Option<&'a CratePaths>, | |
476ff2be | 267 | pub is_proc_macro: Option<bool>, |
d9bb1a4e FG |
268 | |
269 | // Mutable in-progress state or output. | |
270 | rejected_via_hash: Vec<CrateMismatch>, | |
271 | rejected_via_triple: Vec<CrateMismatch>, | |
272 | rejected_via_kind: Vec<CrateMismatch>, | |
273 | rejected_via_version: Vec<CrateMismatch>, | |
274 | rejected_via_filename: Vec<CrateMismatch>, | |
223e47cc LB |
275 | } |
276 | ||
e74abb32 | 277 | crate struct CratePaths { |
d9bb1a4e FG |
278 | name: Symbol, |
279 | source: CrateSource, | |
280 | } | |
281 | ||
282 | impl CratePaths { | |
283 | crate fn new(name: Symbol, source: CrateSource) -> CratePaths { | |
284 | CratePaths { name, source } | |
285 | } | |
223e47cc LB |
286 | } |
287 | ||
a7813a04 XL |
288 | #[derive(Copy, Clone, PartialEq)] |
289 | enum CrateFlavor { | |
290 | Rlib, | |
476ff2be | 291 | Rmeta, |
c30ab7b3 | 292 | Dylib, |
a7813a04 XL |
293 | } |
294 | ||
295 | impl fmt::Display for CrateFlavor { | |
9fa01778 | 296 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |
a7813a04 XL |
297 | f.write_str(match *self { |
298 | CrateFlavor::Rlib => "rlib", | |
476ff2be | 299 | CrateFlavor::Rmeta => "rmeta", |
c30ab7b3 | 300 | CrateFlavor::Dylib => "dylib", |
a7813a04 XL |
301 | }) |
302 | } | |
303 | } | |
304 | ||
d9bb1a4e FG |
305 | impl<'a> CrateLocator<'a> { |
306 | crate fn new( | |
307 | sess: &'a Session, | |
308 | metadata_loader: &'a dyn MetadataLoader, | |
309 | crate_name: Symbol, | |
310 | hash: Option<Svh>, | |
311 | host_hash: Option<Svh>, | |
312 | extra_filename: Option<&'a str>, | |
313 | is_host: bool, | |
314 | path_kind: PathKind, | |
315 | span: Span, | |
316 | root: Option<&'a CratePaths>, | |
317 | is_proc_macro: Option<bool>, | |
318 | ) -> CrateLocator<'a> { | |
319 | CrateLocator { | |
320 | sess, | |
321 | metadata_loader, | |
322 | crate_name, | |
323 | exact_paths: if hash.is_none() { | |
46de9a89 FG |
324 | sess.opts |
325 | .externs | |
326 | .get(&crate_name.as_str()) | |
327 | .into_iter() | |
d9bb1a4e FG |
328 | .filter_map(|entry| entry.files()) |
329 | .flatten() | |
46de9a89 FG |
330 | .map(|location| PathBuf::from(location)) |
331 | .collect() | |
d9bb1a4e FG |
332 | } else { |
333 | // SVH being specified means this is a transitive dependency, | |
334 | // so `--extern` options do not apply. | |
335 | Vec::new() | |
336 | }, | |
337 | hash, | |
338 | host_hash, | |
339 | extra_filename, | |
340 | target: if is_host { &sess.host } else { &sess.target.target }, | |
341 | triple: if is_host { | |
342 | TargetTriple::from_triple(config::host_triple()) | |
343 | } else { | |
344 | sess.opts.target_triple.clone() | |
345 | }, | |
346 | filesearch: if is_host { | |
347 | sess.host_filesearch(path_kind) | |
348 | } else { | |
349 | sess.target_filesearch(path_kind) | |
350 | }, | |
351 | span, | |
352 | root, | |
353 | is_proc_macro, | |
354 | rejected_via_hash: Vec::new(), | |
355 | rejected_via_triple: Vec::new(), | |
356 | rejected_via_kind: Vec::new(), | |
357 | rejected_via_version: Vec::new(), | |
358 | rejected_via_filename: Vec::new(), | |
359 | } | |
360 | } | |
361 | ||
e74abb32 | 362 | crate fn reset(&mut self) { |
532ac7d7 XL |
363 | self.rejected_via_hash.clear(); |
364 | self.rejected_via_triple.clear(); | |
365 | self.rejected_via_kind.clear(); | |
366 | self.rejected_via_version.clear(); | |
367 | self.rejected_via_filename.clear(); | |
368 | } | |
369 | ||
e74abb32 | 370 | crate fn maybe_load_library_crate(&mut self) -> Option<Library> { |
d9bb1a4e FG |
371 | if !self.exact_paths.is_empty() { |
372 | return self.find_commandline_library(); | |
373 | } | |
b7449926 | 374 | let mut seen_paths = FxHashSet::default(); |
83c7162d | 375 | match self.extra_filename { |
46de9a89 FG |
376 | Some(s) => self |
377 | .find_library_crate(s, &mut seen_paths) | |
83c7162d | 378 | .or_else(|| self.find_library_crate("", &mut seen_paths)), |
46de9a89 | 379 | None => self.find_library_crate("", &mut seen_paths), |
83c7162d | 380 | } |
1a4d82fc JJ |
381 | } |
382 | ||
e74abb32 | 383 | crate fn report_errs(self) -> ! { |
b039eaaf | 384 | let add = match self.root { |
e74abb32 XL |
385 | None => String::new(), |
386 | Some(r) => format!(" which `{}` depends on", r.name), | |
b039eaaf | 387 | }; |
ff7c6d11 | 388 | let mut msg = "the following crate versions were found:".to_string(); |
9cc50fc6 | 389 | let mut err = if !self.rejected_via_hash.is_empty() { |
46de9a89 FG |
390 | let mut err = struct_span_err!( |
391 | self.sess, | |
392 | self.span, | |
393 | E0460, | |
394 | "found possibly newer version of crate `{}`{}", | |
395 | self.crate_name, | |
396 | add | |
397 | ); | |
a7813a04 | 398 | err.note("perhaps that crate needs to be recompiled?"); |
1a4d82fc | 399 | let mismatches = self.rejected_via_hash.iter(); |
ff7c6d11 | 400 | for &CrateMismatch { ref path, .. } in mismatches { |
e74abb32 | 401 | msg.push_str(&format!("\ncrate `{}`: {}", self.crate_name, path.display())); |
1a4d82fc JJ |
402 | } |
403 | match self.root { | |
e74abb32 XL |
404 | None => {} |
405 | Some(r) => { | |
406 | for path in r.source.paths() { | |
407 | msg.push_str(&format!("\ncrate `{}`: {}", r.name, path.display())); | |
970d7e83 | 408 | } |
223e47cc | 409 | } |
223e47cc | 410 | } |
ff7c6d11 XL |
411 | err.note(&msg); |
412 | err | |
413 | } else if !self.rejected_via_triple.is_empty() { | |
46de9a89 FG |
414 | let mut err = struct_span_err!( |
415 | self.sess, | |
416 | self.span, | |
417 | E0461, | |
418 | "couldn't find crate `{}` \ | |
ff7c6d11 | 419 | with expected target triple {}{}", |
46de9a89 FG |
420 | self.crate_name, |
421 | self.triple, | |
422 | add | |
423 | ); | |
ff7c6d11 XL |
424 | let mismatches = self.rejected_via_triple.iter(); |
425 | for &CrateMismatch { ref path, ref got } in mismatches { | |
46de9a89 FG |
426 | msg.push_str(&format!( |
427 | "\ncrate `{}`, target triple {}: {}", | |
428 | self.crate_name, | |
429 | got, | |
430 | path.display() | |
431 | )); | |
ff7c6d11 XL |
432 | } |
433 | err.note(&msg); | |
434 | err | |
435 | } else if !self.rejected_via_kind.is_empty() { | |
46de9a89 FG |
436 | let mut err = struct_span_err!( |
437 | self.sess, | |
438 | self.span, | |
439 | E0462, | |
440 | "found staticlib `{}` instead of rlib or dylib{}", | |
441 | self.crate_name, | |
442 | add | |
443 | ); | |
a7813a04 | 444 | err.help("please recompile that crate using --crate-type lib"); |
85aaf69f | 445 | let mismatches = self.rejected_via_kind.iter(); |
ff7c6d11 | 446 | for &CrateMismatch { ref path, .. } in mismatches { |
e74abb32 | 447 | msg.push_str(&format!("\ncrate `{}`: {}", self.crate_name, path.display())); |
a7813a04 | 448 | } |
ff7c6d11 XL |
449 | err.note(&msg); |
450 | err | |
451 | } else if !self.rejected_via_version.is_empty() { | |
46de9a89 FG |
452 | let mut err = struct_span_err!( |
453 | self.sess, | |
454 | self.span, | |
455 | E0514, | |
456 | "found crate `{}` compiled by an incompatible version \ | |
ff7c6d11 | 457 | of rustc{}", |
46de9a89 FG |
458 | self.crate_name, |
459 | add | |
460 | ); | |
461 | err.help(&format!( | |
462 | "please recompile that crate using this compiler ({})", | |
463 | rustc_version() | |
464 | )); | |
a7813a04 | 465 | let mismatches = self.rejected_via_version.iter(); |
ff7c6d11 | 466 | for &CrateMismatch { ref path, ref got } in mismatches { |
46de9a89 FG |
467 | msg.push_str(&format!( |
468 | "\ncrate `{}` compiled by {}: {}", | |
469 | self.crate_name, | |
470 | got, | |
471 | path.display() | |
472 | )); | |
85aaf69f | 473 | } |
ff7c6d11 XL |
474 | err.note(&msg); |
475 | err | |
476 | } else { | |
46de9a89 FG |
477 | let mut err = struct_span_err!( |
478 | self.sess, | |
479 | self.span, | |
480 | E0463, | |
481 | "can't find crate for `{}`{}", | |
482 | self.crate_name, | |
483 | add | |
484 | ); | |
ff7c6d11 | 485 | |
e74abb32 | 486 | if (self.crate_name == sym::std || self.crate_name == sym::core) |
46de9a89 FG |
487 | && self.triple != TargetTriple::from_triple(config::host_triple()) |
488 | { | |
ff7c6d11 XL |
489 | err.note(&format!("the `{}` target may not be installed", self.triple)); |
490 | } | |
491 | err.span_label(self.span, "can't find crate"); | |
492 | err | |
493 | }; | |
494 | ||
476ff2be SL |
495 | if !self.rejected_via_filename.is_empty() { |
496 | let dylibname = self.dylibname(); | |
497 | let mismatches = self.rejected_via_filename.iter(); | |
498 | for &CrateMismatch { ref path, .. } in mismatches { | |
46de9a89 FG |
499 | err.note(&format!( |
500 | "extern location for {} is of an unknown type: {}", | |
501 | self.crate_name, | |
502 | path.display() | |
503 | )) | |
504 | .help(&format!( | |
505 | "file name should be lib*.rlib or {}*.{}", | |
506 | dylibname.0, dylibname.1 | |
507 | )); | |
476ff2be SL |
508 | } |
509 | } | |
9cc50fc6 SL |
510 | |
511 | err.emit(); | |
1a4d82fc | 512 | self.sess.abort_if_errors(); |
54a0048b | 513 | unreachable!(); |
1a4d82fc JJ |
514 | } |
515 | ||
46de9a89 FG |
516 | fn find_library_crate( |
517 | &mut self, | |
518 | extra_prefix: &str, | |
519 | seen_paths: &mut FxHashSet<PathBuf>, | |
520 | ) -> Option<Library> { | |
1a4d82fc | 521 | let dypair = self.dylibname(); |
7453a54e | 522 | let staticpair = self.staticlibname(); |
1a4d82fc JJ |
523 | |
524 | // want: crate_name.dir_part() + prefix + crate_name.file_part + "-" | |
83c7162d XL |
525 | let dylib_prefix = format!("{}{}{}", dypair.0, self.crate_name, extra_prefix); |
526 | let rlib_prefix = format!("lib{}{}", self.crate_name, extra_prefix); | |
527 | let staticlib_prefix = format!("{}{}{}", staticpair.0, self.crate_name, extra_prefix); | |
1a4d82fc | 528 | |
46de9a89 FG |
529 | let mut candidates: FxHashMap<_, (FxHashMap<_, _>, FxHashMap<_, _>, FxHashMap<_, _>)> = |
530 | Default::default(); | |
c30ab7b3 | 531 | let mut staticlibs = vec![]; |
1a4d82fc JJ |
532 | |
533 | // First, find all possible candidate rlibs and dylibs purely based on | |
534 | // the name of the files themselves. We're trying to match against an | |
535 | // exact crate name and a possibly an exact hash. | |
536 | // | |
537 | // During this step, we can filter all found libraries based on the | |
538 | // name and id found in the crate id (we ignore the path portion for | |
539 | // filename matching), as well as the exact hash (if specified). If we | |
540 | // end up having many candidates, we must look at the metadata to | |
541 | // perform exact matches against hashes/crate ids. Note that opening up | |
542 | // the metadata is where we do an exact match against the full contents | |
543 | // of the crate id (path/name/id). | |
544 | // | |
545 | // The goal of this step is to look at as little metadata as possible. | |
85aaf69f | 546 | self.filesearch.search(|path, kind| { |
c34b1796 | 547 | let file = match path.file_name().and_then(|s| s.to_str()) { |
1a4d82fc JJ |
548 | None => return FileDoesntMatch, |
549 | Some(file) => file, | |
550 | }; | |
46de9a89 FG |
551 | let (hash, found_kind) = if file.starts_with(&rlib_prefix) && file.ends_with(".rlib") { |
552 | (&file[(rlib_prefix.len())..(file.len() - ".rlib".len())], CrateFlavor::Rlib) | |
553 | } else if file.starts_with(&rlib_prefix) && file.ends_with(".rmeta") { | |
554 | (&file[(rlib_prefix.len())..(file.len() - ".rmeta".len())], CrateFlavor::Rmeta) | |
555 | } else if file.starts_with(&dylib_prefix) && file.ends_with(&dypair.1) { | |
556 | (&file[(dylib_prefix.len())..(file.len() - dypair.1.len())], CrateFlavor::Dylib) | |
557 | } else { | |
558 | if file.starts_with(&staticlib_prefix) && file.ends_with(&staticpair.1) { | |
559 | staticlibs.push(CrateMismatch { | |
560 | path: path.to_path_buf(), | |
561 | got: "static".to_string(), | |
562 | }); | |
563 | } | |
564 | return FileDoesntMatch; | |
565 | }; | |
83c7162d | 566 | |
1a4d82fc JJ |
567 | info!("lib candidate: {}", path.display()); |
568 | ||
569 | let hash_str = hash.to_string(); | |
b7449926 | 570 | let slot = candidates.entry(hash_str).or_default(); |
476ff2be | 571 | let (ref mut rlibs, ref mut rmetas, ref mut dylibs) = *slot; |
c30ab7b3 SL |
572 | fs::canonicalize(path) |
573 | .map(|p| { | |
83c7162d | 574 | if seen_paths.contains(&p) { |
46de9a89 | 575 | return FileDoesntMatch; |
83c7162d XL |
576 | }; |
577 | seen_paths.insert(p.clone()); | |
476ff2be | 578 | match found_kind { |
46de9a89 FG |
579 | CrateFlavor::Rlib => { |
580 | rlibs.insert(p, kind); | |
581 | } | |
582 | CrateFlavor::Rmeta => { | |
583 | rmetas.insert(p, kind); | |
584 | } | |
585 | CrateFlavor::Dylib => { | |
586 | dylibs.insert(p, kind); | |
587 | } | |
c30ab7b3 SL |
588 | } |
589 | FileMatches | |
590 | }) | |
591 | .unwrap_or(FileDoesntMatch) | |
1a4d82fc | 592 | }); |
62682a34 | 593 | self.rejected_via_kind.extend(staticlibs); |
1a4d82fc JJ |
594 | |
595 | // We have now collected all known libraries into a set of candidates | |
596 | // keyed of the filename hash listed. For each filename, we also have a | |
597 | // list of rlibs/dylibs that apply. Here, we map each of these lists | |
598 | // (per hash), to a Library candidate for returning. | |
599 | // | |
600 | // A Library candidate is created if the metadata for the set of | |
601 | // libraries corresponds to the crate id and hash criteria that this | |
602 | // search is being performed for. | |
0bf4aa26 | 603 | let mut libraries = FxHashMap::default(); |
476ff2be | 604 | for (_hash, (rlibs, rmetas, dylibs)) in candidates { |
e74abb32 XL |
605 | if let Some((svh, lib)) = self.extract_lib(rlibs, rmetas, dylibs) { |
606 | libraries.insert(svh, lib); | |
1a4d82fc JJ |
607 | } |
608 | } | |
609 | ||
610 | // Having now translated all relevant found hashes into libraries, see | |
611 | // what we've got and figure out if we found multiple candidates for | |
612 | // libraries or not. | |
613 | match libraries.len() { | |
614 | 0 => None, | |
a7813a04 | 615 | 1 => Some(libraries.into_iter().next().unwrap().1), |
970d7e83 | 616 | _ => { |
46de9a89 FG |
617 | let mut err = struct_span_err!( |
618 | self.sess, | |
619 | self.span, | |
620 | E0464, | |
621 | "multiple matching crates for `{}`", | |
622 | self.crate_name | |
623 | ); | |
624 | let candidates = libraries | |
625 | .iter() | |
626 | .filter_map(|(_, lib)| { | |
627 | let crate_name = &lib.metadata.get_root().name().as_str(); | |
628 | match &(&lib.source.dylib, &lib.source.rlib) { | |
629 | &(&Some((ref pd, _)), &Some((ref pr, _))) => Some(format!( | |
630 | "\ncrate `{}`: {}\n{:>padding$}", | |
631 | crate_name, | |
632 | pd.display(), | |
633 | pr.display(), | |
634 | padding = 8 + crate_name.len() | |
635 | )), | |
636 | &(&Some((ref p, _)), &None) | &(&None, &Some((ref p, _))) => { | |
637 | Some(format!("\ncrate `{}`: {}", crate_name, p.display())) | |
638 | } | |
639 | &(&None, &None) => None, | |
ff7c6d11 | 640 | } |
46de9a89 FG |
641 | }) |
642 | .collect::<String>(); | |
ff7c6d11 | 643 | err.note(&format!("candidates:{}", candidates)); |
9cc50fc6 | 644 | err.emit(); |
970d7e83 LB |
645 | None |
646 | } | |
1a4d82fc JJ |
647 | } |
648 | } | |
649 | ||
e74abb32 XL |
650 | fn extract_lib( |
651 | &mut self, | |
652 | rlibs: FxHashMap<PathBuf, PathKind>, | |
653 | rmetas: FxHashMap<PathBuf, PathKind>, | |
654 | dylibs: FxHashMap<PathBuf, PathKind>, | |
655 | ) -> Option<(Svh, Library)> { | |
656 | let mut slot = None; | |
46de9a89 FG |
657 | // Order here matters, rmeta should come first. See comment in |
658 | // `extract_one` below. | |
e74abb32 | 659 | let source = CrateSource { |
e74abb32 | 660 | rmeta: self.extract_one(rmetas, CrateFlavor::Rmeta, &mut slot), |
46de9a89 | 661 | rlib: self.extract_one(rlibs, CrateFlavor::Rlib, &mut slot), |
e74abb32 XL |
662 | dylib: self.extract_one(dylibs, CrateFlavor::Dylib, &mut slot), |
663 | }; | |
664 | slot.map(|(svh, metadata)| (svh, Library { source, metadata })) | |
665 | } | |
666 | ||
46de9a89 FG |
667 | fn needs_crate_flavor(&self, flavor: CrateFlavor) -> bool { |
668 | if flavor == CrateFlavor::Dylib && self.is_proc_macro == Some(true) { | |
669 | return true; | |
670 | } | |
671 | ||
672 | // The all loop is because `--crate-type=rlib --crate-type=rlib` is | |
673 | // legal and produces both inside this type. | |
674 | let is_rlib = self.sess.crate_types.borrow().iter().all(|c| *c == config::CrateType::Rlib); | |
675 | let needs_object_code = self.sess.opts.output_types.should_codegen(); | |
676 | // If we're producing an rlib, then we don't need object code. | |
677 | // Or, if we're not producing object code, then we don't need it either | |
678 | // (e.g., if we're a cdylib but emitting just metadata). | |
679 | if is_rlib || !needs_object_code { | |
680 | flavor == CrateFlavor::Rmeta | |
681 | } else { | |
682 | // we need all flavors (perhaps not true, but what we do for now) | |
683 | true | |
684 | } | |
685 | } | |
686 | ||
1a4d82fc JJ |
687 | // Attempts to extract *one* library from the set `m`. If the set has no |
688 | // elements, `None` is returned. If the set has more than one element, then | |
689 | // the errors and notes are emitted about the set of libraries. | |
690 | // | |
691 | // With only one library in the set, this function will extract it, and then | |
692 | // read the metadata from it if `*slot` is `None`. If the metadata couldn't | |
693 | // be read, it is assumed that the file isn't a valid rust library (no | |
694 | // errors are emitted). | |
46de9a89 FG |
695 | fn extract_one( |
696 | &mut self, | |
697 | m: FxHashMap<PathBuf, PathKind>, | |
698 | flavor: CrateFlavor, | |
699 | slot: &mut Option<(Svh, MetadataBlob)>, | |
700 | ) -> Option<(PathBuf, PathKind)> { | |
a7813a04 | 701 | let mut ret: Option<(PathBuf, PathKind)> = None; |
85aaf69f | 702 | let mut error = 0; |
1a4d82fc | 703 | |
46de9a89 FG |
704 | // If we are producing an rlib, and we've already loaded metadata, then |
705 | // we should not attempt to discover further crate sources (unless we're | |
706 | // locating a proc macro; exact logic is in needs_crate_flavor). This means | |
707 | // that under -Zbinary-dep-depinfo we will not emit a dependency edge on | |
708 | // the *unused* rlib, and by returning `None` here immediately we | |
709 | // guarantee that we do indeed not use it. | |
710 | // | |
711 | // See also #68149 which provides more detail on why emitting the | |
712 | // dependency on the rlib is a bad thing. | |
713 | // | |
714 | // We currenty do not verify that these other sources are even in sync, | |
715 | // and this is arguably a bug (see #10786), but because reading metadata | |
716 | // is quite slow (especially from dylibs) we currently do not read it | |
717 | // from the other crate sources. | |
1a4d82fc | 718 | if slot.is_some() { |
46de9a89 | 719 | if m.is_empty() || !self.needs_crate_flavor(flavor) { |
c30ab7b3 | 720 | return None; |
1a4d82fc | 721 | } else if m.len() == 1 { |
c30ab7b3 | 722 | return Some(m.into_iter().next().unwrap()); |
1a4d82fc JJ |
723 | } |
724 | } | |
725 | ||
9fa01778 | 726 | let mut err: Option<DiagnosticBuilder<'_>> = None; |
85aaf69f | 727 | for (lib, kind) in m { |
1a4d82fc | 728 | info!("{} reading metadata from: {}", flavor, lib.display()); |
7cac9316 XL |
729 | let (hash, metadata) = |
730 | match get_metadata_section(self.target, flavor, &lib, self.metadata_loader) { | |
731 | Ok(blob) => { | |
732 | if let Some(h) = self.crate_matches(&blob, &lib) { | |
733 | (h, blob) | |
734 | } else { | |
735 | info!("metadata mismatch"); | |
736 | continue; | |
737 | } | |
738 | } | |
739 | Err(err) => { | |
0bf4aa26 | 740 | warn!("no metadata found: {}", err); |
c30ab7b3 | 741 | continue; |
1a4d82fc | 742 | } |
7cac9316 | 743 | }; |
a7813a04 XL |
744 | // If we see multiple hashes, emit an error about duplicate candidates. |
745 | if slot.as_ref().map_or(false, |s| s.0 != hash) { | |
46de9a89 FG |
746 | let mut e = struct_span_err!( |
747 | self.sess, | |
748 | self.span, | |
749 | E0465, | |
750 | "multiple {} candidates for `{}` found", | |
751 | flavor, | |
752 | self.crate_name | |
753 | ); | |
754 | e.span_note( | |
755 | self.span, | |
756 | &format!(r"candidate #1: {}", ret.as_ref().unwrap().0.display()), | |
757 | ); | |
9cc50fc6 SL |
758 | if let Some(ref mut e) = err { |
759 | e.emit(); | |
760 | } | |
761 | err = Some(e); | |
1a4d82fc | 762 | error = 1; |
a7813a04 | 763 | *slot = None; |
1a4d82fc JJ |
764 | } |
765 | if error > 0 { | |
766 | error += 1; | |
46de9a89 FG |
767 | err.as_mut() |
768 | .unwrap() | |
769 | .span_note(self.span, &format!(r"candidate #{}: {}", error, lib.display())); | |
c30ab7b3 | 770 | continue; |
970d7e83 | 771 | } |
8bb4bdeb XL |
772 | |
773 | // Ok so at this point we've determined that `(lib, kind)` above is | |
774 | // a candidate crate to load, and that `slot` is either none (this | |
775 | // is the first crate of its kind) or if some the previous path has | |
0731742a | 776 | // the exact same hash (e.g., it's the exact same crate). |
8bb4bdeb XL |
777 | // |
778 | // In principle these two candidate crates are exactly the same so | |
779 | // we can choose either of them to link. As a stupidly gross hack, | |
780 | // however, we favor crate in the sysroot. | |
781 | // | |
782 | // You can find more info in rust-lang/rust#39518 and various linked | |
783 | // issues, but the general gist is that during testing libstd the | |
784 | // compilers has two candidates to choose from: one in the sysroot | |
785 | // and one in the deps folder. These two crates are the exact same | |
786 | // crate but if the compiler chooses the one in the deps folder | |
787 | // it'll cause spurious errors on Windows. | |
788 | // | |
789 | // As a result, we favor the sysroot crate here. Note that the | |
790 | // candidates are all canonicalized, so we canonicalize the sysroot | |
791 | // as well. | |
792 | if let Some((ref prev, _)) = ret { | |
0731742a | 793 | let sysroot = &self.sess.sysroot; |
46de9a89 | 794 | let sysroot = sysroot.canonicalize().unwrap_or_else(|_| sysroot.to_path_buf()); |
8bb4bdeb | 795 | if prev.starts_with(&sysroot) { |
46de9a89 | 796 | continue; |
8bb4bdeb XL |
797 | } |
798 | } | |
a7813a04 | 799 | *slot = Some((hash, metadata)); |
85aaf69f | 800 | ret = Some((lib, kind)); |
1a4d82fc | 801 | } |
9cc50fc6 SL |
802 | |
803 | if error > 0 { | |
804 | err.unwrap().emit(); | |
805 | None | |
806 | } else { | |
807 | ret | |
808 | } | |
1a4d82fc JJ |
809 | } |
810 | ||
9e0c209e | 811 | fn crate_matches(&mut self, metadata: &MetadataBlob, libpath: &Path) -> Option<Svh> { |
c30ab7b3 | 812 | let rustc_version = rustc_version(); |
476ff2be SL |
813 | let found_version = metadata.get_rustc_version(); |
814 | if found_version != rustc_version { | |
46de9a89 FG |
815 | info!("Rejecting via version: expected {} got {}", rustc_version, found_version); |
816 | self.rejected_via_version | |
817 | .push(CrateMismatch { path: libpath.to_path_buf(), got: found_version }); | |
a7813a04 XL |
818 | return None; |
819 | } | |
820 | ||
476ff2be | 821 | let root = metadata.get_root(); |
d9bb1a4e FG |
822 | if let Some(expected_is_proc_macro) = self.is_proc_macro { |
823 | let is_proc_macro = root.is_proc_macro_crate(); | |
824 | if is_proc_macro != expected_is_proc_macro { | |
46de9a89 FG |
825 | info!( |
826 | "Rejecting via proc macro: expected {} got {}", | |
827 | expected_is_proc_macro, is_proc_macro | |
828 | ); | |
476ff2be SL |
829 | return None; |
830 | } | |
831 | } | |
832 | ||
d9bb1a4e FG |
833 | if self.exact_paths.is_empty() { |
834 | if self.crate_name != root.name() { | |
c30ab7b3 SL |
835 | info!("Rejecting via crate name"); |
836 | return None; | |
1a4d82fc JJ |
837 | } |
838 | } | |
1a4d82fc | 839 | |
d9bb1a4e | 840 | if root.triple() != &self.triple { |
46de9a89 | 841 | info!("Rejecting via crate triple: expected {} got {}", self.triple, root.triple()); |
1a4d82fc | 842 | self.rejected_via_triple.push(CrateMismatch { |
c34b1796 | 843 | path: libpath.to_path_buf(), |
d9bb1a4e | 844 | got: root.triple().to_string(), |
1a4d82fc | 845 | }); |
a7813a04 | 846 | return None; |
223e47cc | 847 | } |
223e47cc | 848 | |
d9bb1a4e FG |
849 | let hash = root.hash(); |
850 | if let Some(expected_hash) = self.hash { | |
851 | if hash != expected_hash { | |
852 | info!("Rejecting via hash: expected {} got {}", expected_hash, hash); | |
46de9a89 FG |
853 | self.rejected_via_hash |
854 | .push(CrateMismatch { path: libpath.to_path_buf(), got: hash.to_string() }); | |
a7813a04 | 855 | return None; |
1a4d82fc | 856 | } |
223e47cc | 857 | } |
a7813a04 | 858 | |
d9bb1a4e | 859 | Some(hash) |
223e47cc | 860 | } |
223e47cc | 861 | |
1a4d82fc JJ |
862 | // Returns the corresponding (prefix, suffix) that files need to have for |
863 | // dynamic libraries | |
864 | fn dylibname(&self) -> (String, String) { | |
85aaf69f | 865 | let t = &self.target; |
1a4d82fc | 866 | (t.options.dll_prefix.clone(), t.options.dll_suffix.clone()) |
223e47cc | 867 | } |
223e47cc | 868 | |
7453a54e SL |
869 | // Returns the corresponding (prefix, suffix) that files need to have for |
870 | // static libraries | |
871 | fn staticlibname(&self) -> (String, String) { | |
872 | let t = &self.target; | |
873 | (t.options.staticlib_prefix.clone(), t.options.staticlib_suffix.clone()) | |
874 | } | |
875 | ||
d9bb1a4e | 876 | fn find_commandline_library(&mut self) -> Option<Library> { |
1a4d82fc JJ |
877 | // First, filter out all libraries that look suspicious. We only accept |
878 | // files which actually exist that have the correct naming scheme for | |
879 | // rlibs/dylibs. | |
880 | let sess = self.sess; | |
881 | let dylibname = self.dylibname(); | |
0bf4aa26 XL |
882 | let mut rlibs = FxHashMap::default(); |
883 | let mut rmetas = FxHashMap::default(); | |
884 | let mut dylibs = FxHashMap::default(); | |
1a4d82fc | 885 | { |
46de9a89 FG |
886 | let crate_name = self.crate_name; |
887 | let rejected_via_filename = &mut self.rejected_via_filename; | |
888 | let locs = self.exact_paths.iter().filter(|loc| { | |
1a4d82fc | 889 | if !loc.exists() { |
46de9a89 FG |
890 | sess.err(&format!( |
891 | "extern location for {} does not exist: {}", | |
892 | crate_name, | |
893 | loc.display() | |
894 | )); | |
1a4d82fc JJ |
895 | return false; |
896 | } | |
c34b1796 | 897 | let file = match loc.file_name().and_then(|s| s.to_str()) { |
1a4d82fc JJ |
898 | Some(file) => file, |
899 | None => { | |
46de9a89 FG |
900 | sess.err(&format!( |
901 | "extern location for {} is not a file: {}", | |
902 | crate_name, | |
903 | loc.display() | |
904 | )); | |
1a4d82fc JJ |
905 | return false; |
906 | } | |
907 | }; | |
46de9a89 FG |
908 | if file.starts_with("lib") && (file.ends_with(".rlib") || file.ends_with(".rmeta")) |
909 | { | |
c30ab7b3 | 910 | return true; |
1a4d82fc JJ |
911 | } else { |
912 | let (ref prefix, ref suffix) = dylibname; | |
c30ab7b3 SL |
913 | if file.starts_with(&prefix[..]) && file.ends_with(&suffix[..]) { |
914 | return true; | |
1a4d82fc JJ |
915 | } |
916 | } | |
476ff2be | 917 | |
46de9a89 FG |
918 | rejected_via_filename |
919 | .push(CrateMismatch { path: (*loc).clone(), got: String::new() }); | |
476ff2be | 920 | |
1a4d82fc JJ |
921 | false |
922 | }); | |
923 | ||
85aaf69f SL |
924 | // Now that we have an iterator of good candidates, make sure |
925 | // there's at most one rlib and at most one dylib. | |
1a4d82fc | 926 | for loc in locs { |
c34b1796 | 927 | if loc.file_name().unwrap().to_str().unwrap().ends_with(".rlib") { |
c30ab7b3 | 928 | rlibs.insert(fs::canonicalize(&loc).unwrap(), PathKind::ExternFlag); |
476ff2be SL |
929 | } else if loc.file_name().unwrap().to_str().unwrap().ends_with(".rmeta") { |
930 | rmetas.insert(fs::canonicalize(&loc).unwrap(), PathKind::ExternFlag); | |
1a4d82fc | 931 | } else { |
c30ab7b3 | 932 | dylibs.insert(fs::canonicalize(&loc).unwrap(), PathKind::ExternFlag); |
1a4d82fc JJ |
933 | } |
934 | } | |
935 | }; | |
936 | ||
e74abb32 XL |
937 | // Extract the dylib/rlib/rmeta triple. |
938 | self.extract_lib(rlibs, rmetas, dylibs).map(|(_, lib)| lib) | |
223e47cc | 939 | } |
223e47cc LB |
940 | } |
941 | ||
1a4d82fc | 942 | // Just a small wrapper to time how long reading metadata takes. |
46de9a89 FG |
943 | fn get_metadata_section( |
944 | target: &Target, | |
945 | flavor: CrateFlavor, | |
946 | filename: &Path, | |
947 | loader: &dyn MetadataLoader, | |
948 | ) -> Result<MetadataBlob, String> { | |
92a42be0 | 949 | let start = Instant::now(); |
7cac9316 | 950 | let ret = get_metadata_section_imp(target, flavor, filename, loader); |
46de9a89 | 951 | info!("reading {:?} => {:?}", filename.file_name().unwrap(), start.elapsed()); |
c30ab7b3 | 952 | return ret; |
223e47cc LB |
953 | } |
954 | ||
a1dfa0c6 XL |
955 | /// A trivial wrapper for `Mmap` that implements `StableDeref`. |
956 | struct StableDerefMmap(memmap::Mmap); | |
957 | ||
958 | impl Deref for StableDerefMmap { | |
959 | type Target = [u8]; | |
960 | ||
961 | fn deref(&self) -> &[u8] { | |
962 | self.0.deref() | |
963 | } | |
964 | } | |
965 | ||
966 | unsafe impl stable_deref_trait::StableDeref for StableDerefMmap {} | |
967 | ||
46de9a89 FG |
968 | fn get_metadata_section_imp( |
969 | target: &Target, | |
970 | flavor: CrateFlavor, | |
971 | filename: &Path, | |
972 | loader: &dyn MetadataLoader, | |
973 | ) -> Result<MetadataBlob, String> { | |
1a4d82fc JJ |
974 | if !filename.exists() { |
975 | return Err(format!("no such file: '{}'", filename.display())); | |
976 | } | |
0531ce1d | 977 | let raw_bytes: MetadataRef = match flavor { |
7cac9316 XL |
978 | CrateFlavor::Rlib => loader.get_rlib_metadata(target, filename)?, |
979 | CrateFlavor::Dylib => { | |
980 | let buf = loader.get_dylib_metadata(target, filename)?; | |
981 | // The header is uncompressed | |
982 | let header_len = METADATA_HEADER.len(); | |
983 | debug!("checking {} bytes of metadata-version stamp", header_len); | |
984 | let header = &buf[..cmp::min(header_len, buf.len())]; | |
985 | if header != METADATA_HEADER { | |
46de9a89 FG |
986 | return Err(format!( |
987 | "incompatible metadata version found: '{}'", | |
988 | filename.display() | |
989 | )); | |
1a4d82fc | 990 | } |
223e47cc | 991 | |
7cac9316 XL |
992 | // Header is okay -> inflate the actual metadata |
993 | let compressed_bytes = &buf[header_len..]; | |
994 | debug!("inflating {} bytes of compressed metadata", compressed_bytes.len()); | |
041b39d2 XL |
995 | let mut inflated = Vec::new(); |
996 | match DeflateDecoder::new(compressed_bytes).read_to_end(&mut inflated) { | |
46de9a89 | 997 | Ok(_) => rustc_erase_owner!(OwningRef::new(inflated).map_owner_box()), |
7cac9316 XL |
998 | Err(_) => { |
999 | return Err(format!("failed to decompress metadata: {}", filename.display())); | |
223e47cc LB |
1000 | } |
1001 | } | |
223e47cc | 1002 | } |
7cac9316 | 1003 | CrateFlavor::Rmeta => { |
a1dfa0c6 | 1004 | // mmap the file, because only a small fraction of it is read. |
46de9a89 FG |
1005 | let file = std::fs::File::open(filename) |
1006 | .map_err(|_| format!("failed to open rmeta metadata: '{}'", filename.display()))?; | |
a1dfa0c6 | 1007 | let mmap = unsafe { memmap::Mmap::map(&file) }; |
46de9a89 FG |
1008 | let mmap = mmap |
1009 | .map_err(|_| format!("failed to mmap rmeta metadata: '{}'", filename.display()))?; | |
a1dfa0c6 XL |
1010 | |
1011 | rustc_erase_owner!(OwningRef::new(StableDerefMmap(mmap)).map_owner_box()) | |
7cac9316 XL |
1012 | } |
1013 | }; | |
d9bb1a4e | 1014 | let blob = MetadataBlob::new(raw_bytes); |
7cac9316 XL |
1015 | if blob.is_compatible() { |
1016 | Ok(blob) | |
1a4d82fc | 1017 | } else { |
7cac9316 | 1018 | Err(format!("incompatible metadata version found: '{}'", filename.display())) |
223e47cc LB |
1019 | } |
1020 | } | |
1021 | ||
e74abb32 XL |
1022 | /// Look for a plugin registrar. Returns its library path and crate disambiguator. |
1023 | pub fn find_plugin_registrar( | |
1024 | sess: &Session, | |
1025 | metadata_loader: &dyn MetadataLoader, | |
1026 | span: Span, | |
1027 | name: Symbol, | |
1028 | ) -> Option<(PathBuf, CrateDisambiguator)> { | |
1029 | info!("find plugin registrar `{}`", name); | |
1030 | let target_triple = sess.opts.target_triple.clone(); | |
1031 | let host_triple = TargetTriple::from_triple(config::host_triple()); | |
1032 | let is_cross = target_triple != host_triple; | |
1033 | let mut target_only = false; | |
d9bb1a4e | 1034 | let mut locator = CrateLocator::new( |
e74abb32 | 1035 | sess, |
e74abb32 | 1036 | metadata_loader, |
d9bb1a4e FG |
1037 | name, |
1038 | None, // hash | |
1039 | None, // host_hash | |
1040 | None, // extra_filename | |
1041 | true, // is_host | |
1042 | PathKind::Crate, | |
1043 | span, | |
1044 | None, // root | |
1045 | None, // is_proc_macro | |
1046 | ); | |
e74abb32 | 1047 | |
d9bb1a4e | 1048 | let library = locator.maybe_load_library_crate().or_else(|| { |
e74abb32 | 1049 | if !is_cross { |
46de9a89 | 1050 | return None; |
e74abb32 XL |
1051 | } |
1052 | // Try loading from target crates. This will abort later if we | |
1053 | // try to load a plugin registrar function, | |
1054 | target_only = true; | |
1055 | ||
d9bb1a4e FG |
1056 | locator.target = &sess.target.target; |
1057 | locator.triple = target_triple; | |
1058 | locator.filesearch = sess.target_filesearch(PathKind::Crate); | |
e74abb32 | 1059 | |
d9bb1a4e | 1060 | locator.maybe_load_library_crate() |
e74abb32 XL |
1061 | }); |
1062 | let library = match library { | |
1063 | Some(l) => l, | |
d9bb1a4e | 1064 | None => locator.report_errs(), |
e74abb32 XL |
1065 | }; |
1066 | ||
1067 | if target_only { | |
46de9a89 FG |
1068 | let message = format!( |
1069 | "plugin `{}` is not available for triple `{}` (only found {})", | |
1070 | name, | |
1071 | config::host_triple(), | |
1072 | sess.opts.target_triple | |
1073 | ); | |
1074 | struct_span_err!(sess, span, E0456, "{}", &message).emit(); | |
1075 | return None; | |
e74abb32 XL |
1076 | } |
1077 | ||
1078 | match library.source.dylib { | |
46de9a89 | 1079 | Some(dylib) => Some((dylib.0, library.metadata.get_root().disambiguator())), |
e74abb32 | 1080 | None => { |
46de9a89 FG |
1081 | struct_span_err!( |
1082 | sess, | |
1083 | span, | |
1084 | E0457, | |
1085 | "plugin `{}` only found in rlib format, but must be available \ | |
e74abb32 | 1086 | in dylib format", |
46de9a89 FG |
1087 | name |
1088 | ) | |
1089 | .emit(); | |
e74abb32 XL |
1090 | // No need to abort because the loading code will just ignore this |
1091 | // empty dylib. | |
1092 | None | |
1093 | } | |
1094 | } | |
1095 | } | |
1096 | ||
9fa01778 | 1097 | /// A diagnostic function for dumping crate metadata to an output stream. |
46de9a89 FG |
1098 | pub fn list_file_metadata( |
1099 | target: &Target, | |
1100 | path: &Path, | |
1101 | metadata_loader: &dyn MetadataLoader, | |
1102 | out: &mut dyn io::Write, | |
1103 | ) -> io::Result<()> { | |
a7813a04 | 1104 | let filename = path.file_name().unwrap().to_str().unwrap(); |
c30ab7b3 SL |
1105 | let flavor = if filename.ends_with(".rlib") { |
1106 | CrateFlavor::Rlib | |
476ff2be SL |
1107 | } else if filename.ends_with(".rmeta") { |
1108 | CrateFlavor::Rmeta | |
c30ab7b3 SL |
1109 | } else { |
1110 | CrateFlavor::Dylib | |
1111 | }; | |
e74abb32 | 1112 | match get_metadata_section(target, flavor, path, metadata_loader) { |
9e0c209e | 1113 | Ok(metadata) => metadata.list_crate_metadata(out), |
c30ab7b3 | 1114 | Err(msg) => write!(out, "{}\n", msg), |
223e47cc LB |
1115 | } |
1116 | } |