]>
Commit | Line | Data |
---|---|---|
85aaf69f | 1 | // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT |
223e47cc LB |
2 | // file at the top-level directory of this distribution and at |
3 | // http://rust-lang.org/COPYRIGHT. | |
4 | // | |
5 | // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or | |
6 | // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license | |
7 | // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your | |
8 | // option. This file may not be copied, modified, or distributed | |
9 | // except according to those terms. | |
10 | ||
223e47cc | 11 | //! Finds crate binaries and loads their metadata |
1a4d82fc JJ |
12 | //! |
13 | //! Might I be the first to welcome you to a world of platform differences, | |
14 | //! version requirements, dependency graphs, conflicting desires, and fun! This | |
15 | //! is the major guts (along with metadata::creader) of the compiler for loading | |
16 | //! crates and resolving dependencies. Let's take a tour! | |
17 | //! | |
18 | //! # The problem | |
19 | //! | |
20 | //! Each invocation of the compiler is immediately concerned with one primary | |
21 | //! problem, to connect a set of crates to resolved crates on the filesystem. | |
22 | //! Concretely speaking, the compiler follows roughly these steps to get here: | |
23 | //! | |
24 | //! 1. Discover a set of `extern crate` statements. | |
25 | //! 2. Transform these directives into crate names. If the directive does not | |
26 | //! have an explicit name, then the identifier is the name. | |
27 | //! 3. For each of these crate names, find a corresponding crate on the | |
28 | //! filesystem. | |
29 | //! | |
30 | //! Sounds easy, right? Let's walk into some of the nuances. | |
31 | //! | |
32 | //! ## Transitive Dependencies | |
33 | //! | |
34 | //! Let's say we've got three crates: A, B, and C. A depends on B, and B depends | |
35 | //! on C. When we're compiling A, we primarily need to find and locate B, but we | |
36 | //! also end up needing to find and locate C as well. | |
37 | //! | |
38 | //! The reason for this is that any of B's types could be composed of C's types, | |
39 | //! any function in B could return a type from C, etc. To be able to guarantee | |
40 | //! that we can always typecheck/translate any function, we have to have | |
41 | //! complete knowledge of the whole ecosystem, not just our immediate | |
42 | //! dependencies. | |
43 | //! | |
44 | //! So now as part of the "find a corresponding crate on the filesystem" step | |
45 | //! above, this involves also finding all crates for *all upstream | |
46 | //! dependencies*. This includes all dependencies transitively. | |
47 | //! | |
48 | //! ## Rlibs and Dylibs | |
49 | //! | |
50 | //! The compiler has two forms of intermediate dependencies. These are dubbed | |
51 | //! rlibs and dylibs for the static and dynamic variants, respectively. An rlib | |
52 | //! is a rustc-defined file format (currently just an ar archive) while a dylib | |
53 | //! is a platform-defined dynamic library. Each library has a metadata somewhere | |
54 | //! inside of it. | |
55 | //! | |
476ff2be SL |
56 | //! A third kind of dependency is an rmeta file. These are metadata files and do |
57 | //! not contain any code, etc. To a first approximation, these are treated in the | |
58 | //! same way as rlibs. Where there is both an rlib and an rmeta file, the rlib | |
59 | //! gets priority (even if the rmeta file is newer). An rmeta file is only | |
60 | //! useful for checking a downstream crate, attempting to link one will cause an | |
61 | //! error. | |
62 | //! | |
1a4d82fc JJ |
63 | //! When translating a crate name to a crate on the filesystem, we all of a |
64 | //! sudden need to take into account both rlibs and dylibs! Linkage later on may | |
65 | //! use either one of these files, as each has their pros/cons. The job of crate | |
66 | //! loading is to discover what's possible by finding all candidates. | |
67 | //! | |
68 | //! Most parts of this loading systems keep the dylib/rlib as just separate | |
69 | //! variables. | |
70 | //! | |
71 | //! ## Where to look? | |
72 | //! | |
73 | //! We can't exactly scan your whole hard drive when looking for dependencies, | |
74 | //! so we need to places to look. Currently the compiler will implicitly add the | |
75 | //! target lib search path ($prefix/lib/rustlib/$target/lib) to any compilation, | |
76 | //! and otherwise all -L flags are added to the search paths. | |
77 | //! | |
78 | //! ## What criterion to select on? | |
79 | //! | |
80 | //! This a pretty tricky area of loading crates. Given a file, how do we know | |
81 | //! whether it's the right crate? Currently, the rules look along these lines: | |
82 | //! | |
83 | //! 1. Does the filename match an rlib/dylib pattern? That is to say, does the | |
84 | //! filename have the right prefix/suffix? | |
85 | //! 2. Does the filename have the right prefix for the crate name being queried? | |
86 | //! This is filtering for files like `libfoo*.rlib` and such. | |
87 | //! 3. Is the file an actual rust library? This is done by loading the metadata | |
88 | //! from the library and making sure it's actually there. | |
89 | //! 4. Does the name in the metadata agree with the name of the library? | |
90 | //! 5. Does the target in the metadata agree with the current target? | |
91 | //! 6. Does the SVH match? (more on this later) | |
92 | //! | |
93 | //! If the file answers `yes` to all these questions, then the file is | |
94 | //! considered as being *candidate* for being accepted. It is illegal to have | |
95 | //! more than two candidates as the compiler has no method by which to resolve | |
96 | //! this conflict. Additionally, rlib/dylib candidates are considered | |
97 | //! separately. | |
98 | //! | |
99 | //! After all this has happened, we have 1 or two files as candidates. These | |
100 | //! represent the rlib/dylib file found for a library, and they're returned as | |
101 | //! being found. | |
102 | //! | |
103 | //! ### What about versions? | |
104 | //! | |
105 | //! A lot of effort has been put forth to remove versioning from the compiler. | |
106 | //! There have been forays in the past to have versioning baked in, but it was | |
107 | //! largely always deemed insufficient to the point that it was recognized that | |
108 | //! it's probably something the compiler shouldn't do anyway due to its | |
109 | //! complicated nature and the state of the half-baked solutions. | |
110 | //! | |
111 | //! With a departure from versioning, the primary criterion for loading crates | |
112 | //! is just the name of a crate. If we stopped here, it would imply that you | |
113 | //! could never link two crates of the same name from different sources | |
114 | //! together, which is clearly a bad state to be in. | |
115 | //! | |
116 | //! To resolve this problem, we come to the next section! | |
117 | //! | |
118 | //! # Expert Mode | |
119 | //! | |
120 | //! A number of flags have been added to the compiler to solve the "version | |
121 | //! problem" in the previous section, as well as generally enabling more | |
122 | //! powerful usage of the crate loading system of the compiler. The goal of | |
123 | //! these flags and options are to enable third-party tools to drive the | |
124 | //! compiler with prior knowledge about how the world should look. | |
125 | //! | |
126 | //! ## The `--extern` flag | |
127 | //! | |
128 | //! The compiler accepts a flag of this form a number of times: | |
129 | //! | |
130 | //! ```text | |
131 | //! --extern crate-name=path/to/the/crate.rlib | |
132 | //! ``` | |
133 | //! | |
134 | //! This flag is basically the following letter to the compiler: | |
135 | //! | |
136 | //! > Dear rustc, | |
137 | //! > | |
138 | //! > When you are attempting to load the immediate dependency `crate-name`, I | |
9346a6ac | 139 | //! > would like you to assume that the library is located at |
1a4d82fc JJ |
140 | //! > `path/to/the/crate.rlib`, and look nowhere else. Also, please do not |
141 | //! > assume that the path I specified has the name `crate-name`. | |
142 | //! | |
143 | //! This flag basically overrides most matching logic except for validating that | |
144 | //! the file is indeed a rust library. The same `crate-name` can be specified | |
145 | //! twice to specify the rlib/dylib pair. | |
146 | //! | |
147 | //! ## Enabling "multiple versions" | |
148 | //! | |
149 | //! This basically boils down to the ability to specify arbitrary packages to | |
150 | //! the compiler. For example, if crate A wanted to use Bv1 and Bv2, then it | |
151 | //! would look something like: | |
152 | //! | |
153 | //! ```ignore | |
154 | //! extern crate b1; | |
155 | //! extern crate b2; | |
156 | //! | |
157 | //! fn main() {} | |
158 | //! ``` | |
159 | //! | |
160 | //! and the compiler would be invoked as: | |
161 | //! | |
162 | //! ```text | |
163 | //! rustc a.rs --extern b1=path/to/libb1.rlib --extern b2=path/to/libb2.rlib | |
164 | //! ``` | |
165 | //! | |
166 | //! In this scenario there are two crates named `b` and the compiler must be | |
167 | //! manually driven to be informed where each crate is. | |
168 | //! | |
169 | //! ## Frobbing symbols | |
170 | //! | |
171 | //! One of the immediate problems with linking the same library together twice | |
172 | //! in the same problem is dealing with duplicate symbols. The primary way to | |
173 | //! deal with this in rustc is to add hashes to the end of each symbol. | |
174 | //! | |
175 | //! In order to force hashes to change between versions of a library, if | |
176 | //! desired, the compiler exposes an option `-C metadata=foo`, which is used to | |
177 | //! initially seed each symbol hash. The string `foo` is prepended to each | |
178 | //! string-to-hash to ensure that symbols change over time. | |
179 | //! | |
180 | //! ## Loading transitive dependencies | |
181 | //! | |
182 | //! Dealing with same-named-but-distinct crates is not just a local problem, but | |
183 | //! one that also needs to be dealt with for transitive dependencies. Note that | |
184 | //! in the letter above `--extern` flags only apply to the *local* set of | |
185 | //! dependencies, not the upstream transitive dependencies. Consider this | |
186 | //! dependency graph: | |
187 | //! | |
188 | //! ```text | |
189 | //! A.1 A.2 | |
190 | //! | | | |
191 | //! | | | |
192 | //! B C | |
193 | //! \ / | |
194 | //! \ / | |
195 | //! D | |
196 | //! ``` | |
197 | //! | |
198 | //! In this scenario, when we compile `D`, we need to be able to distinctly | |
199 | //! resolve `A.1` and `A.2`, but an `--extern` flag cannot apply to these | |
200 | //! transitive dependencies. | |
201 | //! | |
202 | //! Note that the key idea here is that `B` and `C` are both *already compiled*. | |
203 | //! That is, they have already resolved their dependencies. Due to unrelated | |
204 | //! technical reasons, when a library is compiled, it is only compatible with | |
205 | //! the *exact same* version of the upstream libraries it was compiled against. | |
206 | //! We use the "Strict Version Hash" to identify the exact copy of an upstream | |
207 | //! library. | |
208 | //! | |
209 | //! With this knowledge, we know that `B` and `C` will depend on `A` with | |
210 | //! different SVH values, so we crawl the normal `-L` paths looking for | |
211 | //! `liba*.rlib` and filter based on the contained SVH. | |
212 | //! | |
213 | //! In the end, this ends up not needing `--extern` to specify upstream | |
214 | //! transitive dependencies. | |
215 | //! | |
216 | //! # Wrapping up | |
217 | //! | |
218 | //! That's the general overview of loading crates in the compiler, but it's by | |
219 | //! no means all of the necessary details. Take a look at the rest of | |
c30ab7b3 | 220 | //! metadata::locator or metadata::creader for all the juicy details! |
223e47cc | 221 | |
9e0c209e | 222 | use cstore::MetadataBlob; |
c30ab7b3 SL |
223 | use creader::Library; |
224 | use schema::{METADATA_HEADER, rustc_version}; | |
92a42be0 | 225 | |
54a0048b | 226 | use rustc::hir::svh::Svh; |
476ff2be | 227 | use rustc::session::{config, Session}; |
92a42be0 SL |
228 | use rustc::session::filesearch::{FileSearch, FileMatches, FileDoesntMatch}; |
229 | use rustc::session::search_paths::PathKind; | |
230 | use rustc::util::common; | |
476ff2be | 231 | use rustc::util::nodemap::FxHashMap; |
92a42be0 SL |
232 | |
233 | use rustc_llvm as llvm; | |
234 | use rustc_llvm::{False, ObjectFile, mk_section_iter}; | |
235 | use rustc_llvm::archive_ro::ArchiveRO; | |
3157f602 | 236 | use errors::DiagnosticBuilder; |
476ff2be | 237 | use syntax::symbol::Symbol; |
3157f602 | 238 | use syntax_pos::Span; |
85aaf69f | 239 | use rustc_back::target::Target; |
1a4d82fc | 240 | |
1a4d82fc | 241 | use std::cmp; |
a7813a04 | 242 | use std::fmt; |
476ff2be SL |
243 | use std::fs::{self, File}; |
244 | use std::io::{self, Read}; | |
c34b1796 | 245 | use std::path::{Path, PathBuf}; |
970d7e83 | 246 | use std::ptr; |
1a4d82fc | 247 | use std::slice; |
92a42be0 | 248 | use std::time::Instant; |
1a4d82fc JJ |
249 | |
250 | use flate; | |
251 | ||
252 | pub struct CrateMismatch { | |
c34b1796 | 253 | path: PathBuf, |
1a4d82fc | 254 | got: String, |
223e47cc LB |
255 | } |
256 | ||
1a4d82fc JJ |
257 | pub struct Context<'a> { |
258 | pub sess: &'a Session, | |
259 | pub span: Span, | |
476ff2be SL |
260 | pub ident: Symbol, |
261 | pub crate_name: Symbol, | |
1a4d82fc | 262 | pub hash: Option<&'a Svh>, |
85aaf69f SL |
263 | // points to either self.sess.target.target or self.sess.host, must match triple |
264 | pub target: &'a Target, | |
1a4d82fc JJ |
265 | pub triple: &'a str, |
266 | pub filesearch: FileSearch<'a>, | |
267 | pub root: &'a Option<CratePaths>, | |
268 | pub rejected_via_hash: Vec<CrateMismatch>, | |
269 | pub rejected_via_triple: Vec<CrateMismatch>, | |
85aaf69f | 270 | pub rejected_via_kind: Vec<CrateMismatch>, |
a7813a04 | 271 | pub rejected_via_version: Vec<CrateMismatch>, |
476ff2be | 272 | pub rejected_via_filename: Vec<CrateMismatch>, |
1a4d82fc | 273 | pub should_match_name: bool, |
476ff2be | 274 | pub is_proc_macro: Option<bool>, |
223e47cc LB |
275 | } |
276 | ||
1a4d82fc JJ |
277 | pub struct ArchiveMetadata { |
278 | _archive: ArchiveRO, | |
279 | // points into self._archive | |
280 | data: *const [u8], | |
223e47cc LB |
281 | } |
282 | ||
1a4d82fc JJ |
283 | pub struct CratePaths { |
284 | pub ident: String, | |
c34b1796 | 285 | pub dylib: Option<PathBuf>, |
c30ab7b3 | 286 | pub rlib: Option<PathBuf>, |
476ff2be | 287 | pub rmeta: Option<PathBuf>, |
223e47cc LB |
288 | } |
289 | ||
c1a9b12d SL |
290 | pub const METADATA_FILENAME: &'static str = "rust.metadata.bin"; |
291 | ||
a7813a04 XL |
292 | #[derive(Copy, Clone, PartialEq)] |
293 | enum CrateFlavor { | |
294 | Rlib, | |
476ff2be | 295 | Rmeta, |
c30ab7b3 | 296 | Dylib, |
a7813a04 XL |
297 | } |
298 | ||
299 | impl fmt::Display for CrateFlavor { | |
300 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | |
301 | f.write_str(match *self { | |
302 | CrateFlavor::Rlib => "rlib", | |
476ff2be | 303 | CrateFlavor::Rmeta => "rmeta", |
c30ab7b3 | 304 | CrateFlavor::Dylib => "dylib", |
a7813a04 XL |
305 | }) |
306 | } | |
307 | } | |
308 | ||
1a4d82fc | 309 | impl CratePaths { |
c34b1796 | 310 | fn paths(&self) -> Vec<PathBuf> { |
476ff2be | 311 | self.dylib.iter().chain(self.rlib.iter()).chain(self.rmeta.iter()).cloned().collect() |
1a4d82fc JJ |
312 | } |
313 | } | |
314 | ||
315 | impl<'a> Context<'a> { | |
316 | pub fn maybe_load_library_crate(&mut self) -> Option<Library> { | |
317 | self.find_library_crate() | |
318 | } | |
319 | ||
320 | pub fn load_library_crate(&mut self) -> Library { | |
c30ab7b3 | 321 | self.find_library_crate().unwrap_or_else(|| self.report_errs()) |
1a4d82fc JJ |
322 | } |
323 | ||
c30ab7b3 | 324 | pub fn report_errs(&mut self) -> ! { |
b039eaaf SL |
325 | let add = match self.root { |
326 | &None => String::new(), | |
c30ab7b3 | 327 | &Some(ref r) => format!(" which `{}` depends on", r.ident), |
b039eaaf | 328 | }; |
9cc50fc6 | 329 | let mut err = if !self.rejected_via_hash.is_empty() { |
c30ab7b3 SL |
330 | struct_span_err!(self.sess, |
331 | self.span, | |
332 | E0460, | |
9cc50fc6 | 333 | "found possibly newer version of crate `{}`{}", |
c30ab7b3 SL |
334 | self.ident, |
335 | add) | |
9346a6ac | 336 | } else if !self.rejected_via_triple.is_empty() { |
c30ab7b3 SL |
337 | struct_span_err!(self.sess, |
338 | self.span, | |
339 | E0461, | |
9cc50fc6 | 340 | "couldn't find crate `{}` with expected target triple {}{}", |
c30ab7b3 SL |
341 | self.ident, |
342 | self.triple, | |
343 | add) | |
9346a6ac | 344 | } else if !self.rejected_via_kind.is_empty() { |
c30ab7b3 SL |
345 | struct_span_err!(self.sess, |
346 | self.span, | |
347 | E0462, | |
9cc50fc6 | 348 | "found staticlib `{}` instead of rlib or dylib{}", |
c30ab7b3 SL |
349 | self.ident, |
350 | add) | |
a7813a04 | 351 | } else if !self.rejected_via_version.is_empty() { |
c30ab7b3 SL |
352 | struct_span_err!(self.sess, |
353 | self.span, | |
354 | E0514, | |
a7813a04 | 355 | "found crate `{}` compiled by an incompatible version of rustc{}", |
c30ab7b3 SL |
356 | self.ident, |
357 | add) | |
1a4d82fc | 358 | } else { |
c30ab7b3 SL |
359 | let mut err = struct_span_err!(self.sess, |
360 | self.span, | |
361 | E0463, | |
9e0c209e | 362 | "can't find crate for `{}`{}", |
c30ab7b3 SL |
363 | self.ident, |
364 | add); | |
476ff2be SL |
365 | |
366 | if (self.ident == "std" || self.ident == "core") | |
367 | && self.triple != config::host_triple() { | |
368 | err.note(&format!("the `{}` target may not be installed", self.triple)); | |
369 | } | |
9e0c209e SL |
370 | err.span_label(self.span, &format!("can't find crate")); |
371 | err | |
9cc50fc6 | 372 | }; |
1a4d82fc | 373 | |
9346a6ac | 374 | if !self.rejected_via_triple.is_empty() { |
1a4d82fc | 375 | let mismatches = self.rejected_via_triple.iter(); |
c30ab7b3 | 376 | for (i, &CrateMismatch { ref path, ref got }) in mismatches.enumerate() { |
a7813a04 | 377 | err.note(&format!("crate `{}`, path #{}, triple {}: {}", |
c30ab7b3 SL |
378 | self.ident, |
379 | i + 1, | |
380 | got, | |
381 | path.display())); | |
1a4d82fc JJ |
382 | } |
383 | } | |
9346a6ac | 384 | if !self.rejected_via_hash.is_empty() { |
a7813a04 | 385 | err.note("perhaps that crate needs to be recompiled?"); |
1a4d82fc | 386 | let mismatches = self.rejected_via_hash.iter(); |
c30ab7b3 SL |
387 | for (i, &CrateMismatch { ref path, .. }) in mismatches.enumerate() { |
388 | err.note(&format!("crate `{}` path #{}: {}", self.ident, i + 1, path.display())); | |
1a4d82fc JJ |
389 | } |
390 | match self.root { | |
391 | &None => {} | |
392 | &Some(ref r) => { | |
393 | for (i, path) in r.paths().iter().enumerate() { | |
a7813a04 | 394 | err.note(&format!("crate `{}` path #{}: {}", |
c30ab7b3 SL |
395 | r.ident, |
396 | i + 1, | |
397 | path.display())); | |
970d7e83 | 398 | } |
223e47cc | 399 | } |
223e47cc | 400 | } |
1a4d82fc | 401 | } |
9346a6ac | 402 | if !self.rejected_via_kind.is_empty() { |
a7813a04 | 403 | err.help("please recompile that crate using --crate-type lib"); |
85aaf69f SL |
404 | let mismatches = self.rejected_via_kind.iter(); |
405 | for (i, &CrateMismatch { ref path, .. }) in mismatches.enumerate() { | |
c30ab7b3 | 406 | err.note(&format!("crate `{}` path #{}: {}", self.ident, i + 1, path.display())); |
a7813a04 XL |
407 | } |
408 | } | |
409 | if !self.rejected_via_version.is_empty() { | |
410 | err.help(&format!("please recompile that crate using this compiler ({})", | |
c30ab7b3 | 411 | rustc_version())); |
a7813a04 XL |
412 | let mismatches = self.rejected_via_version.iter(); |
413 | for (i, &CrateMismatch { ref path, ref got }) in mismatches.enumerate() { | |
414 | err.note(&format!("crate `{}` path #{}: {} compiled by {:?}", | |
c30ab7b3 SL |
415 | self.ident, |
416 | i + 1, | |
417 | path.display(), | |
418 | got)); | |
85aaf69f SL |
419 | } |
420 | } | |
476ff2be SL |
421 | if !self.rejected_via_filename.is_empty() { |
422 | let dylibname = self.dylibname(); | |
423 | let mismatches = self.rejected_via_filename.iter(); | |
424 | for &CrateMismatch { ref path, .. } in mismatches { | |
425 | err.note(&format!("extern location for {} is of an unknown type: {}", | |
426 | self.crate_name, | |
427 | path.display())) | |
428 | .help(&format!("file name should be lib*.rlib or {}*.{}", | |
429 | dylibname.0, | |
430 | dylibname.1)); | |
431 | } | |
432 | } | |
9cc50fc6 SL |
433 | |
434 | err.emit(); | |
1a4d82fc | 435 | self.sess.abort_if_errors(); |
54a0048b | 436 | unreachable!(); |
1a4d82fc JJ |
437 | } |
438 | ||
439 | fn find_library_crate(&mut self) -> Option<Library> { | |
440 | // If an SVH is specified, then this is a transitive dependency that | |
441 | // must be loaded via -L plus some filtering. | |
442 | if self.hash.is_none() { | |
443 | self.should_match_name = false; | |
476ff2be | 444 | if let Some(s) = self.sess.opts.externs.get(&self.crate_name.as_str()) { |
5bcae85e | 445 | return self.find_commandline_library(s.iter()); |
1a4d82fc JJ |
446 | } |
447 | self.should_match_name = true; | |
448 | } | |
449 | ||
450 | let dypair = self.dylibname(); | |
7453a54e | 451 | let staticpair = self.staticlibname(); |
1a4d82fc JJ |
452 | |
453 | // want: crate_name.dir_part() + prefix + crate_name.file_part + "-" | |
454 | let dylib_prefix = format!("{}{}", dypair.0, self.crate_name); | |
455 | let rlib_prefix = format!("lib{}", self.crate_name); | |
7453a54e | 456 | let staticlib_prefix = format!("{}{}", staticpair.0, self.crate_name); |
1a4d82fc | 457 | |
476ff2be | 458 | let mut candidates = FxHashMap(); |
c30ab7b3 | 459 | let mut staticlibs = vec![]; |
1a4d82fc JJ |
460 | |
461 | // First, find all possible candidate rlibs and dylibs purely based on | |
462 | // the name of the files themselves. We're trying to match against an | |
463 | // exact crate name and a possibly an exact hash. | |
464 | // | |
465 | // During this step, we can filter all found libraries based on the | |
466 | // name and id found in the crate id (we ignore the path portion for | |
467 | // filename matching), as well as the exact hash (if specified). If we | |
468 | // end up having many candidates, we must look at the metadata to | |
469 | // perform exact matches against hashes/crate ids. Note that opening up | |
470 | // the metadata is where we do an exact match against the full contents | |
471 | // of the crate id (path/name/id). | |
472 | // | |
473 | // The goal of this step is to look at as little metadata as possible. | |
85aaf69f | 474 | self.filesearch.search(|path, kind| { |
c34b1796 | 475 | let file = match path.file_name().and_then(|s| s.to_str()) { |
1a4d82fc JJ |
476 | None => return FileDoesntMatch, |
477 | Some(file) => file, | |
478 | }; | |
476ff2be | 479 | let (hash, found_kind) = |
cc61c64b | 480 | if file.starts_with(&rlib_prefix) && file.ends_with(".rlib") { |
476ff2be | 481 | (&file[(rlib_prefix.len())..(file.len() - ".rlib".len())], CrateFlavor::Rlib) |
cc61c64b | 482 | } else if file.starts_with(&rlib_prefix) && file.ends_with(".rmeta") { |
476ff2be SL |
483 | (&file[(rlib_prefix.len())..(file.len() - ".rmeta".len())], CrateFlavor::Rmeta) |
484 | } else if file.starts_with(&dylib_prefix) && | |
485 | file.ends_with(&dypair.1) { | |
486 | (&file[(dylib_prefix.len())..(file.len() - dypair.1.len())], CrateFlavor::Dylib) | |
487 | } else { | |
cc61c64b | 488 | if file.starts_with(&staticlib_prefix) && file.ends_with(&staticpair.1) { |
476ff2be SL |
489 | staticlibs.push(CrateMismatch { |
490 | path: path.to_path_buf(), | |
491 | got: "static".to_string(), | |
492 | }); | |
493 | } | |
494 | return FileDoesntMatch; | |
495 | }; | |
1a4d82fc JJ |
496 | info!("lib candidate: {}", path.display()); |
497 | ||
498 | let hash_str = hash.to_string(); | |
c34b1796 | 499 | let slot = candidates.entry(hash_str) |
476ff2be SL |
500 | .or_insert_with(|| (FxHashMap(), FxHashMap(), FxHashMap())); |
501 | let (ref mut rlibs, ref mut rmetas, ref mut dylibs) = *slot; | |
c30ab7b3 SL |
502 | fs::canonicalize(path) |
503 | .map(|p| { | |
476ff2be SL |
504 | match found_kind { |
505 | CrateFlavor::Rlib => { rlibs.insert(p, kind); } | |
506 | CrateFlavor::Rmeta => { rmetas.insert(p, kind); } | |
507 | CrateFlavor::Dylib => { dylibs.insert(p, kind); } | |
c30ab7b3 SL |
508 | } |
509 | FileMatches | |
510 | }) | |
511 | .unwrap_or(FileDoesntMatch) | |
1a4d82fc | 512 | }); |
62682a34 | 513 | self.rejected_via_kind.extend(staticlibs); |
1a4d82fc JJ |
514 | |
515 | // We have now collected all known libraries into a set of candidates | |
516 | // keyed of the filename hash listed. For each filename, we also have a | |
517 | // list of rlibs/dylibs that apply. Here, we map each of these lists | |
518 | // (per hash), to a Library candidate for returning. | |
519 | // | |
520 | // A Library candidate is created if the metadata for the set of | |
521 | // libraries corresponds to the crate id and hash criteria that this | |
522 | // search is being performed for. | |
476ff2be SL |
523 | let mut libraries = FxHashMap(); |
524 | for (_hash, (rlibs, rmetas, dylibs)) in candidates { | |
a7813a04 XL |
525 | let mut slot = None; |
526 | let rlib = self.extract_one(rlibs, CrateFlavor::Rlib, &mut slot); | |
476ff2be | 527 | let rmeta = self.extract_one(rmetas, CrateFlavor::Rmeta, &mut slot); |
a7813a04 XL |
528 | let dylib = self.extract_one(dylibs, CrateFlavor::Dylib, &mut slot); |
529 | if let Some((h, m)) = slot { | |
c30ab7b3 SL |
530 | libraries.insert(h, |
531 | Library { | |
532 | dylib: dylib, | |
533 | rlib: rlib, | |
476ff2be | 534 | rmeta: rmeta, |
c30ab7b3 SL |
535 | metadata: m, |
536 | }); | |
1a4d82fc JJ |
537 | } |
538 | } | |
539 | ||
540 | // Having now translated all relevant found hashes into libraries, see | |
541 | // what we've got and figure out if we found multiple candidates for | |
542 | // libraries or not. | |
543 | match libraries.len() { | |
544 | 0 => None, | |
a7813a04 | 545 | 1 => Some(libraries.into_iter().next().unwrap().1), |
970d7e83 | 546 | _ => { |
c30ab7b3 SL |
547 | let mut err = struct_span_err!(self.sess, |
548 | self.span, | |
549 | E0464, | |
9cc50fc6 SL |
550 | "multiple matching crates for `{}`", |
551 | self.crate_name); | |
552 | err.note("candidates:"); | |
a7813a04 | 553 | for (_, lib) in libraries { |
3157f602 XL |
554 | if let Some((ref p, _)) = lib.dylib { |
555 | err.note(&format!("path: {}", p.display())); | |
1a4d82fc | 556 | } |
3157f602 XL |
557 | if let Some((ref p, _)) = lib.rlib { |
558 | err.note(&format!("path: {}", p.display())); | |
1a4d82fc | 559 | } |
476ff2be | 560 | note_crate_name(&mut err, &lib.metadata.get_root().name.as_str()); |
1a4d82fc | 561 | } |
9cc50fc6 | 562 | err.emit(); |
970d7e83 LB |
563 | None |
564 | } | |
1a4d82fc JJ |
565 | } |
566 | } | |
567 | ||
568 | // Attempts to extract *one* library from the set `m`. If the set has no | |
569 | // elements, `None` is returned. If the set has more than one element, then | |
570 | // the errors and notes are emitted about the set of libraries. | |
571 | // | |
572 | // With only one library in the set, this function will extract it, and then | |
573 | // read the metadata from it if `*slot` is `None`. If the metadata couldn't | |
574 | // be read, it is assumed that the file isn't a valid rust library (no | |
575 | // errors are emitted). | |
c30ab7b3 | 576 | fn extract_one(&mut self, |
476ff2be | 577 | m: FxHashMap<PathBuf, PathKind>, |
c30ab7b3 SL |
578 | flavor: CrateFlavor, |
579 | slot: &mut Option<(Svh, MetadataBlob)>) | |
580 | -> Option<(PathBuf, PathKind)> { | |
a7813a04 | 581 | let mut ret: Option<(PathBuf, PathKind)> = None; |
85aaf69f | 582 | let mut error = 0; |
1a4d82fc JJ |
583 | |
584 | if slot.is_some() { | |
585 | // FIXME(#10786): for an optimization, we only read one of the | |
a7813a04 | 586 | // libraries' metadata sections. In theory we should |
1a4d82fc JJ |
587 | // read both, but reading dylib metadata is quite |
588 | // slow. | |
9346a6ac | 589 | if m.is_empty() { |
c30ab7b3 | 590 | return None; |
1a4d82fc | 591 | } else if m.len() == 1 { |
c30ab7b3 | 592 | return Some(m.into_iter().next().unwrap()); |
1a4d82fc JJ |
593 | } |
594 | } | |
595 | ||
9cc50fc6 | 596 | let mut err: Option<DiagnosticBuilder> = None; |
85aaf69f | 597 | for (lib, kind) in m { |
1a4d82fc | 598 | info!("{} reading metadata from: {}", flavor, lib.display()); |
a7813a04 | 599 | let (hash, metadata) = match get_metadata_section(self.target, flavor, &lib) { |
1a4d82fc | 600 | Ok(blob) => { |
9e0c209e | 601 | if let Some(h) = self.crate_matches(&blob, &lib) { |
a7813a04 | 602 | (h, blob) |
1a4d82fc JJ |
603 | } else { |
604 | info!("metadata mismatch"); | |
c30ab7b3 | 605 | continue; |
1a4d82fc | 606 | } |
970d7e83 | 607 | } |
92a42be0 SL |
608 | Err(err) => { |
609 | info!("no metadata found: {}", err); | |
c30ab7b3 | 610 | continue; |
1a4d82fc JJ |
611 | } |
612 | }; | |
a7813a04 XL |
613 | // If we see multiple hashes, emit an error about duplicate candidates. |
614 | if slot.as_ref().map_or(false, |s| s.0 != hash) { | |
c30ab7b3 SL |
615 | let mut e = struct_span_err!(self.sess, |
616 | self.span, | |
617 | E0465, | |
9cc50fc6 | 618 | "multiple {} candidates for `{}` found", |
c30ab7b3 SL |
619 | flavor, |
620 | self.crate_name); | |
9cc50fc6 SL |
621 | e.span_note(self.span, |
622 | &format!(r"candidate #1: {}", | |
c30ab7b3 SL |
623 | ret.as_ref() |
624 | .unwrap() | |
625 | .0 | |
626 | .display())); | |
9cc50fc6 SL |
627 | if let Some(ref mut e) = err { |
628 | e.emit(); | |
629 | } | |
630 | err = Some(e); | |
1a4d82fc | 631 | error = 1; |
a7813a04 | 632 | *slot = None; |
1a4d82fc JJ |
633 | } |
634 | if error > 0 { | |
635 | error += 1; | |
9cc50fc6 | 636 | err.as_mut().unwrap().span_note(self.span, |
c30ab7b3 SL |
637 | &format!(r"candidate #{}: {}", |
638 | error, | |
9cc50fc6 | 639 | lib.display())); |
c30ab7b3 | 640 | continue; |
970d7e83 | 641 | } |
8bb4bdeb XL |
642 | |
643 | // Ok so at this point we've determined that `(lib, kind)` above is | |
644 | // a candidate crate to load, and that `slot` is either none (this | |
645 | // is the first crate of its kind) or if some the previous path has | |
646 | // the exact same hash (e.g. it's the exact same crate). | |
647 | // | |
648 | // In principle these two candidate crates are exactly the same so | |
649 | // we can choose either of them to link. As a stupidly gross hack, | |
650 | // however, we favor crate in the sysroot. | |
651 | // | |
652 | // You can find more info in rust-lang/rust#39518 and various linked | |
653 | // issues, but the general gist is that during testing libstd the | |
654 | // compilers has two candidates to choose from: one in the sysroot | |
655 | // and one in the deps folder. These two crates are the exact same | |
656 | // crate but if the compiler chooses the one in the deps folder | |
657 | // it'll cause spurious errors on Windows. | |
658 | // | |
659 | // As a result, we favor the sysroot crate here. Note that the | |
660 | // candidates are all canonicalized, so we canonicalize the sysroot | |
661 | // as well. | |
662 | if let Some((ref prev, _)) = ret { | |
663 | let sysroot = self.sess.sysroot(); | |
664 | let sysroot = sysroot.canonicalize() | |
665 | .unwrap_or(sysroot.to_path_buf()); | |
666 | if prev.starts_with(&sysroot) { | |
667 | continue | |
668 | } | |
669 | } | |
a7813a04 | 670 | *slot = Some((hash, metadata)); |
85aaf69f | 671 | ret = Some((lib, kind)); |
1a4d82fc | 672 | } |
9cc50fc6 SL |
673 | |
674 | if error > 0 { | |
675 | err.unwrap().emit(); | |
676 | None | |
677 | } else { | |
678 | ret | |
679 | } | |
1a4d82fc JJ |
680 | } |
681 | ||
9e0c209e | 682 | fn crate_matches(&mut self, metadata: &MetadataBlob, libpath: &Path) -> Option<Svh> { |
c30ab7b3 | 683 | let rustc_version = rustc_version(); |
476ff2be SL |
684 | let found_version = metadata.get_rustc_version(); |
685 | if found_version != rustc_version { | |
9e0c209e | 686 | info!("Rejecting via version: expected {} got {}", |
c30ab7b3 | 687 | rustc_version, |
476ff2be | 688 | found_version); |
a7813a04 XL |
689 | self.rejected_via_version.push(CrateMismatch { |
690 | path: libpath.to_path_buf(), | |
476ff2be | 691 | got: found_version, |
a7813a04 XL |
692 | }); |
693 | return None; | |
694 | } | |
695 | ||
476ff2be SL |
696 | let root = metadata.get_root(); |
697 | if let Some(is_proc_macro) = self.is_proc_macro { | |
698 | if root.macro_derive_registrar.is_some() != is_proc_macro { | |
699 | return None; | |
700 | } | |
701 | } | |
702 | ||
1a4d82fc | 703 | if self.should_match_name { |
9e0c209e | 704 | if self.crate_name != root.name { |
c30ab7b3 SL |
705 | info!("Rejecting via crate name"); |
706 | return None; | |
1a4d82fc JJ |
707 | } |
708 | } | |
1a4d82fc | 709 | |
9e0c209e SL |
710 | if root.triple != self.triple { |
711 | info!("Rejecting via crate triple: expected {} got {}", | |
c30ab7b3 SL |
712 | self.triple, |
713 | root.triple); | |
1a4d82fc | 714 | self.rejected_via_triple.push(CrateMismatch { |
c34b1796 | 715 | path: libpath.to_path_buf(), |
c30ab7b3 | 716 | got: root.triple, |
1a4d82fc | 717 | }); |
a7813a04 | 718 | return None; |
223e47cc | 719 | } |
223e47cc | 720 | |
a7813a04 | 721 | if let Some(myhash) = self.hash { |
9e0c209e | 722 | if *myhash != root.hash { |
c30ab7b3 | 723 | info!("Rejecting via hash: expected {} got {}", *myhash, root.hash); |
a7813a04 XL |
724 | self.rejected_via_hash.push(CrateMismatch { |
725 | path: libpath.to_path_buf(), | |
c30ab7b3 | 726 | got: myhash.to_string(), |
a7813a04 XL |
727 | }); |
728 | return None; | |
1a4d82fc | 729 | } |
223e47cc | 730 | } |
a7813a04 | 731 | |
9e0c209e | 732 | Some(root.hash) |
223e47cc | 733 | } |
223e47cc | 734 | |
1a4d82fc JJ |
735 | |
736 | // Returns the corresponding (prefix, suffix) that files need to have for | |
737 | // dynamic libraries | |
738 | fn dylibname(&self) -> (String, String) { | |
85aaf69f | 739 | let t = &self.target; |
1a4d82fc | 740 | (t.options.dll_prefix.clone(), t.options.dll_suffix.clone()) |
223e47cc | 741 | } |
223e47cc | 742 | |
7453a54e SL |
743 | // Returns the corresponding (prefix, suffix) that files need to have for |
744 | // static libraries | |
745 | fn staticlibname(&self) -> (String, String) { | |
746 | let t = &self.target; | |
747 | (t.options.staticlib_prefix.clone(), t.options.staticlib_suffix.clone()) | |
748 | } | |
749 | ||
c30ab7b3 SL |
750 | fn find_commandline_library<'b, LOCS>(&mut self, locs: LOCS) -> Option<Library> |
751 | where LOCS: Iterator<Item = &'b String> | |
5bcae85e | 752 | { |
1a4d82fc JJ |
753 | // First, filter out all libraries that look suspicious. We only accept |
754 | // files which actually exist that have the correct naming scheme for | |
755 | // rlibs/dylibs. | |
756 | let sess = self.sess; | |
757 | let dylibname = self.dylibname(); | |
476ff2be SL |
758 | let mut rlibs = FxHashMap(); |
759 | let mut rmetas = FxHashMap(); | |
760 | let mut dylibs = FxHashMap(); | |
1a4d82fc | 761 | { |
5bcae85e | 762 | let locs = locs.map(|l| PathBuf::from(l)).filter(|loc| { |
1a4d82fc JJ |
763 | if !loc.exists() { |
764 | sess.err(&format!("extern location for {} does not exist: {}", | |
c30ab7b3 SL |
765 | self.crate_name, |
766 | loc.display())); | |
1a4d82fc JJ |
767 | return false; |
768 | } | |
c34b1796 | 769 | let file = match loc.file_name().and_then(|s| s.to_str()) { |
1a4d82fc JJ |
770 | Some(file) => file, |
771 | None => { | |
772 | sess.err(&format!("extern location for {} is not a file: {}", | |
c30ab7b3 SL |
773 | self.crate_name, |
774 | loc.display())); | |
1a4d82fc JJ |
775 | return false; |
776 | } | |
777 | }; | |
476ff2be SL |
778 | if file.starts_with("lib") && |
779 | (file.ends_with(".rlib") || file.ends_with(".rmeta")) { | |
c30ab7b3 | 780 | return true; |
1a4d82fc JJ |
781 | } else { |
782 | let (ref prefix, ref suffix) = dylibname; | |
c30ab7b3 SL |
783 | if file.starts_with(&prefix[..]) && file.ends_with(&suffix[..]) { |
784 | return true; | |
1a4d82fc JJ |
785 | } |
786 | } | |
476ff2be SL |
787 | |
788 | self.rejected_via_filename.push(CrateMismatch { | |
789 | path: loc.clone(), | |
790 | got: String::new(), | |
791 | }); | |
792 | ||
1a4d82fc JJ |
793 | false |
794 | }); | |
795 | ||
85aaf69f SL |
796 | // Now that we have an iterator of good candidates, make sure |
797 | // there's at most one rlib and at most one dylib. | |
1a4d82fc | 798 | for loc in locs { |
c34b1796 | 799 | if loc.file_name().unwrap().to_str().unwrap().ends_with(".rlib") { |
c30ab7b3 | 800 | rlibs.insert(fs::canonicalize(&loc).unwrap(), PathKind::ExternFlag); |
476ff2be SL |
801 | } else if loc.file_name().unwrap().to_str().unwrap().ends_with(".rmeta") { |
802 | rmetas.insert(fs::canonicalize(&loc).unwrap(), PathKind::ExternFlag); | |
1a4d82fc | 803 | } else { |
c30ab7b3 | 804 | dylibs.insert(fs::canonicalize(&loc).unwrap(), PathKind::ExternFlag); |
1a4d82fc JJ |
805 | } |
806 | } | |
807 | }; | |
808 | ||
809 | // Extract the rlib/dylib pair. | |
a7813a04 XL |
810 | let mut slot = None; |
811 | let rlib = self.extract_one(rlibs, CrateFlavor::Rlib, &mut slot); | |
476ff2be | 812 | let rmeta = self.extract_one(rmetas, CrateFlavor::Rmeta, &mut slot); |
a7813a04 | 813 | let dylib = self.extract_one(dylibs, CrateFlavor::Dylib, &mut slot); |
1a4d82fc | 814 | |
476ff2be | 815 | if rlib.is_none() && rmeta.is_none() && dylib.is_none() { |
c30ab7b3 SL |
816 | return None; |
817 | } | |
a7813a04 | 818 | match slot { |
c30ab7b3 SL |
819 | Some((_, metadata)) => { |
820 | Some(Library { | |
821 | dylib: dylib, | |
822 | rlib: rlib, | |
476ff2be | 823 | rmeta: rmeta, |
c30ab7b3 SL |
824 | metadata: metadata, |
825 | }) | |
826 | } | |
1a4d82fc JJ |
827 | None => None, |
828 | } | |
223e47cc | 829 | } |
223e47cc LB |
830 | } |
831 | ||
9cc50fc6 SL |
832 | pub fn note_crate_name(err: &mut DiagnosticBuilder, name: &str) { |
833 | err.note(&format!("crate name: {}", name)); | |
1a4d82fc | 834 | } |
223e47cc | 835 | |
1a4d82fc JJ |
836 | impl ArchiveMetadata { |
837 | fn new(ar: ArchiveRO) -> Option<ArchiveMetadata> { | |
d9579d0f | 838 | let data = { |
c30ab7b3 SL |
839 | let section = ar.iter() |
840 | .filter_map(|s| s.ok()) | |
841 | .find(|sect| sect.name() == Some(METADATA_FILENAME)); | |
d9579d0f AL |
842 | match section { |
843 | Some(s) => s.data() as *const [u8], | |
844 | None => { | |
845 | debug!("didn't find '{}' in the archive", METADATA_FILENAME); | |
846 | return None; | |
847 | } | |
1a4d82fc JJ |
848 | } |
849 | }; | |
223e47cc | 850 | |
1a4d82fc JJ |
851 | Some(ArchiveMetadata { |
852 | _archive: ar, | |
853 | data: data, | |
854 | }) | |
223e47cc | 855 | } |
1a4d82fc | 856 | |
c30ab7b3 SL |
857 | pub fn as_slice<'a>(&'a self) -> &'a [u8] { |
858 | unsafe { &*self.data } | |
859 | } | |
1a4d82fc JJ |
860 | } |
861 | ||
c30ab7b3 SL |
862 | fn verify_decompressed_encoding_version(blob: &MetadataBlob, |
863 | filename: &Path) | |
864 | -> Result<(), String> { | |
9e0c209e | 865 | if !blob.is_compatible() { |
a7813a04 XL |
866 | Err((format!("incompatible metadata version found: '{}'", |
867 | filename.display()))) | |
868 | } else { | |
869 | Ok(()) | |
870 | } | |
871 | } | |
872 | ||
1a4d82fc | 873 | // Just a small wrapper to time how long reading metadata takes. |
c30ab7b3 SL |
874 | fn get_metadata_section(target: &Target, |
875 | flavor: CrateFlavor, | |
876 | filename: &Path) | |
62682a34 | 877 | -> Result<MetadataBlob, String> { |
92a42be0 | 878 | let start = Instant::now(); |
a7813a04 | 879 | let ret = get_metadata_section_imp(target, flavor, filename); |
c30ab7b3 SL |
880 | info!("reading {:?} => {:?}", |
881 | filename.file_name().unwrap(), | |
92a42be0 | 882 | start.elapsed()); |
c30ab7b3 | 883 | return ret; |
223e47cc LB |
884 | } |
885 | ||
c30ab7b3 SL |
886 | fn get_metadata_section_imp(target: &Target, |
887 | flavor: CrateFlavor, | |
888 | filename: &Path) | |
62682a34 | 889 | -> Result<MetadataBlob, String> { |
1a4d82fc JJ |
890 | if !filename.exists() { |
891 | return Err(format!("no such file: '{}'", filename.display())); | |
892 | } | |
a7813a04 | 893 | if flavor == CrateFlavor::Rlib { |
1a4d82fc JJ |
894 | // Use ArchiveRO for speed here, it's backed by LLVM and uses mmap |
895 | // internally to read the file. We also avoid even using a memcpy by | |
896 | // just keeping the archive along while the metadata is in use. | |
897 | let archive = match ArchiveRO::open(filename) { | |
898 | Some(ar) => ar, | |
899 | None => { | |
900 | debug!("llvm didn't like `{}`", filename.display()); | |
c30ab7b3 | 901 | return Err(format!("failed to read rlib metadata: '{}'", filename.display())); |
1a4d82fc JJ |
902 | } |
903 | }; | |
9e0c209e | 904 | return match ArchiveMetadata::new(archive).map(|ar| MetadataBlob::Archive(ar)) { |
c30ab7b3 | 905 | None => Err(format!("failed to read rlib metadata: '{}'", filename.display())), |
a7813a04 | 906 | Some(blob) => { |
9e0c209e | 907 | verify_decompressed_encoding_version(&blob, filename)?; |
a7813a04 XL |
908 | Ok(blob) |
909 | } | |
c34b1796 | 910 | }; |
476ff2be SL |
911 | } else if flavor == CrateFlavor::Rmeta { |
912 | let mut file = File::open(filename).map_err(|_| | |
913 | format!("could not open file: '{}'", filename.display()))?; | |
914 | let mut buf = vec![]; | |
915 | file.read_to_end(&mut buf).map_err(|_| | |
916 | format!("failed to read rlib metadata: '{}'", filename.display()))?; | |
917 | let blob = MetadataBlob::Raw(buf); | |
918 | verify_decompressed_encoding_version(&blob, filename)?; | |
919 | return Ok(blob); | |
1a4d82fc | 920 | } |
223e47cc | 921 | unsafe { |
c34b1796 | 922 | let buf = common::path2cstr(filename); |
1a4d82fc | 923 | let mb = llvm::LLVMRustCreateMemoryBufferWithContentsOfFile(buf.as_ptr()); |
c34b1796 | 924 | if mb as isize == 0 { |
c30ab7b3 | 925 | return Err(format!("error reading library: '{}'", filename.display())); |
1a4d82fc JJ |
926 | } |
927 | let of = match ObjectFile::new(mb) { | |
928 | Some(of) => of, | |
929 | _ => { | |
c30ab7b3 | 930 | return Err((format!("provided path not an object file: '{}'", filename.display()))) |
1a4d82fc | 931 | } |
223e47cc LB |
932 | }; |
933 | let si = mk_section_iter(of.llof); | |
934 | while llvm::LLVMIsSectionIteratorAtEnd(of.llof, si.llsi) == False { | |
1a4d82fc JJ |
935 | let mut name_buf = ptr::null(); |
936 | let name_len = llvm::LLVMRustGetSectionName(si.llsi, &mut name_buf); | |
c30ab7b3 | 937 | let name = slice::from_raw_parts(name_buf as *const u8, name_len as usize).to_vec(); |
1a4d82fc JJ |
938 | let name = String::from_utf8(name).unwrap(); |
939 | debug!("get_metadata_section: name {}", name); | |
62682a34 | 940 | if read_meta_section_name(target) == name { |
223e47cc | 941 | let cbuf = llvm::LLVMGetSectionContents(si.llsi); |
c34b1796 | 942 | let csz = llvm::LLVMGetSectionSize(si.llsi) as usize; |
1a4d82fc | 943 | let cvbuf: *const u8 = cbuf as *const u8; |
9e0c209e | 944 | let vlen = METADATA_HEADER.len(); |
c30ab7b3 | 945 | debug!("checking {} bytes of metadata-version stamp", vlen); |
1a4d82fc | 946 | let minsz = cmp::min(vlen, csz); |
85aaf69f | 947 | let buf0 = slice::from_raw_parts(cvbuf, minsz); |
9e0c209e | 948 | let version_ok = buf0 == METADATA_HEADER; |
1a4d82fc JJ |
949 | if !version_ok { |
950 | return Err((format!("incompatible metadata version found: '{}'", | |
951 | filename.display()))); | |
970d7e83 | 952 | } |
223e47cc | 953 | |
c34b1796 | 954 | let cvbuf1 = cvbuf.offset(vlen as isize); |
c30ab7b3 | 955 | debug!("inflating {} bytes of compressed metadata", csz - vlen); |
85aaf69f | 956 | let bytes = slice::from_raw_parts(cvbuf1, csz - vlen); |
1a4d82fc | 957 | match flate::inflate_bytes(bytes) { |
a7813a04 | 958 | Ok(inflated) => { |
9e0c209e SL |
959 | let blob = MetadataBlob::Inflated(inflated); |
960 | verify_decompressed_encoding_version(&blob, filename)?; | |
a7813a04 XL |
961 | return Ok(blob); |
962 | } | |
c34b1796 | 963 | Err(_) => {} |
223e47cc LB |
964 | } |
965 | } | |
966 | llvm::LLVMMoveToNextSection(si.llsi); | |
967 | } | |
c34b1796 | 968 | Err(format!("metadata not found: '{}'", filename.display())) |
223e47cc LB |
969 | } |
970 | } | |
971 | ||
62682a34 | 972 | pub fn meta_section_name(target: &Target) -> &'static str { |
5bcae85e SL |
973 | // Historical note: |
974 | // | |
975 | // When using link.exe it was seen that the section name `.note.rustc` | |
976 | // was getting shortened to `.note.ru`, and according to the PE and COFF | |
977 | // specification: | |
978 | // | |
979 | // > Executable images do not use a string table and do not support | |
980 | // > section names longer than 8 characters | |
981 | // | |
982 | // https://msdn.microsoft.com/en-us/library/windows/hardware/gg463119.aspx | |
983 | // | |
984 | // As a result, we choose a slightly shorter name! As to why | |
985 | // `.note.rustc` works on MinGW, that's another good question... | |
986 | ||
62682a34 | 987 | if target.options.is_like_osx { |
5bcae85e | 988 | "__DATA,.rustc" |
1a4d82fc | 989 | } else { |
5bcae85e | 990 | ".rustc" |
223e47cc LB |
991 | } |
992 | } | |
993 | ||
5bcae85e SL |
994 | pub fn read_meta_section_name(_target: &Target) -> &'static str { |
995 | ".rustc" | |
970d7e83 LB |
996 | } |
997 | ||
223e47cc | 998 | // A diagnostic function for dumping crate metadata to an output stream |
c30ab7b3 | 999 | pub fn list_file_metadata(target: &Target, path: &Path, out: &mut io::Write) -> io::Result<()> { |
a7813a04 | 1000 | let filename = path.file_name().unwrap().to_str().unwrap(); |
c30ab7b3 SL |
1001 | let flavor = if filename.ends_with(".rlib") { |
1002 | CrateFlavor::Rlib | |
476ff2be SL |
1003 | } else if filename.ends_with(".rmeta") { |
1004 | CrateFlavor::Rmeta | |
c30ab7b3 SL |
1005 | } else { |
1006 | CrateFlavor::Dylib | |
1007 | }; | |
a7813a04 | 1008 | match get_metadata_section(target, flavor, path) { |
9e0c209e | 1009 | Ok(metadata) => metadata.list_crate_metadata(out), |
c30ab7b3 | 1010 | Err(msg) => write!(out, "{}\n", msg), |
223e47cc LB |
1011 | } |
1012 | } |