]> git.lizzy.rs Git - rust.git/blob - src/librustc_trans/back/link.rs
338f3bb08aa97a5825342e84d31d9f753065e44d
[rust.git] / src / librustc_trans / back / link.rs
1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
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
11 extern crate rustc_trans_utils;
12
13 use super::archive::{ArchiveBuilder, ArchiveConfig};
14 use super::linker::Linker;
15 use super::rpath::RPathConfig;
16 use super::rpath;
17 use metadata::METADATA_FILENAME;
18 use rustc::session::config::{self, NoDebugInfo, OutputFilenames, OutputType};
19 use rustc::session::filesearch;
20 use rustc::session::search_paths::PathKind;
21 use rustc::session::Session;
22 use rustc::middle::cstore::{LinkMeta, NativeLibrary, LibSource, LinkagePreference,
23                             NativeLibraryKind};
24 use rustc::middle::dependency_format::Linkage;
25 use CrateTranslation;
26 use rustc::util::common::time;
27 use rustc::util::fs::fix_windows_verbatim_for_gcc;
28 use rustc::dep_graph::{DepKind, DepNode};
29 use rustc::hir::def_id::CrateNum;
30 use rustc::hir::svh::Svh;
31 use rustc_back::tempdir::TempDir;
32 use rustc_back::{PanicStrategy, RelroLevel};
33 use rustc_incremental::IncrementalHashesMap;
34 use context::get_reloc_model;
35 use llvm;
36
37 use std::ascii;
38 use std::char;
39 use std::env;
40 use std::ffi::OsString;
41 use std::fs;
42 use std::io::{self, Read, Write};
43 use std::mem;
44 use std::path::{Path, PathBuf};
45 use std::process::Command;
46 use std::str;
47 use flate2::Compression;
48 use flate2::write::DeflateEncoder;
49 use syntax::attr;
50
51 /// The LLVM module name containing crate-metadata. This includes a `.` on
52 /// purpose, so it cannot clash with the name of a user-defined module.
53 pub const METADATA_MODULE_NAME: &'static str = "crate.metadata";
54 /// The name of the crate-metadata object file the compiler generates. Must
55 /// match up with `METADATA_MODULE_NAME`.
56 pub const METADATA_OBJ_NAME: &'static str = "crate.metadata.o";
57
58 // same as for metadata above, but for allocator shim
59 pub const ALLOCATOR_MODULE_NAME: &'static str = "crate.allocator";
60 pub const ALLOCATOR_OBJ_NAME: &'static str = "crate.allocator.o";
61
62 // RLIB LLVM-BYTECODE OBJECT LAYOUT
63 // Version 1
64 // Bytes    Data
65 // 0..10    "RUST_OBJECT" encoded in ASCII
66 // 11..14   format version as little-endian u32
67 // 15..22   size in bytes of deflate compressed LLVM bitcode as
68 //          little-endian u64
69 // 23..     compressed LLVM bitcode
70
71 // This is the "magic number" expected at the beginning of a LLVM bytecode
72 // object in an rlib.
73 pub const RLIB_BYTECODE_OBJECT_MAGIC: &'static [u8] = b"RUST_OBJECT";
74
75 // The version number this compiler will write to bytecode objects in rlibs
76 pub const RLIB_BYTECODE_OBJECT_VERSION: u32 = 1;
77
78 // The offset in bytes the bytecode object format version number can be found at
79 pub const RLIB_BYTECODE_OBJECT_VERSION_OFFSET: usize = 11;
80
81 // The offset in bytes the size of the compressed bytecode can be found at in
82 // format version 1
83 pub const RLIB_BYTECODE_OBJECT_V1_DATASIZE_OFFSET: usize =
84     RLIB_BYTECODE_OBJECT_VERSION_OFFSET + 4;
85
86 // The offset in bytes the compressed LLVM bytecode can be found at in format
87 // version 1
88 pub const RLIB_BYTECODE_OBJECT_V1_DATA_OFFSET: usize =
89     RLIB_BYTECODE_OBJECT_V1_DATASIZE_OFFSET + 8;
90
91 pub use self::rustc_trans_utils::link::{find_crate_name, filename_for_input,
92                                         default_output_for_target, invalid_output_for_target};
93
94 pub fn build_link_meta(incremental_hashes_map: &IncrementalHashesMap) -> LinkMeta {
95     let krate_dep_node = &DepNode::new_no_params(DepKind::Krate);
96     let r = LinkMeta {
97         crate_hash: Svh::new(incremental_hashes_map[krate_dep_node].to_smaller_hash()),
98     };
99     info!("{:?}", r);
100     return r;
101 }
102
103 // The third parameter is for env vars, used on windows to set up the
104 // path for MSVC to find its DLLs, and gcc to find its bundled
105 // toolchain
106 pub fn get_linker(sess: &Session) -> (String, Command, Vec<(OsString, OsString)>) {
107     let envs = vec![("PATH".into(), command_path(sess))];
108
109     if let Some(ref linker) = sess.opts.cg.linker {
110         (linker.clone(), Command::new(linker), envs)
111     } else if sess.target.target.options.is_like_msvc {
112         let (cmd, envs) = msvc_link_exe_cmd(sess);
113         ("link.exe".to_string(), cmd, envs)
114     } else {
115         let linker = &sess.target.target.options.linker;
116         (linker.clone(), Command::new(&linker), envs)
117     }
118 }
119
120 #[cfg(windows)]
121 pub fn msvc_link_exe_cmd(sess: &Session) -> (Command, Vec<(OsString, OsString)>) {
122     use gcc::windows_registry;
123
124     let target = &sess.opts.target_triple;
125     let tool = windows_registry::find_tool(target, "link.exe");
126
127     if let Some(tool) = tool {
128         let envs = tool.env().to_vec();
129         (tool.to_command(), envs)
130     } else {
131         debug!("Failed to locate linker.");
132         (Command::new("link.exe"), vec![])
133     }
134 }
135
136 #[cfg(not(windows))]
137 pub fn msvc_link_exe_cmd(_sess: &Session) -> (Command, Vec<(OsString, OsString)>) {
138     (Command::new("link.exe"), vec![])
139 }
140
141 fn command_path(sess: &Session) -> OsString {
142     // The compiler's sysroot often has some bundled tools, so add it to the
143     // PATH for the child.
144     let mut new_path = sess.host_filesearch(PathKind::All)
145                            .get_tools_search_paths();
146     if let Some(path) = env::var_os("PATH") {
147         new_path.extend(env::split_paths(&path));
148     }
149     env::join_paths(new_path).unwrap()
150 }
151
152 pub fn remove(sess: &Session, path: &Path) {
153     match fs::remove_file(path) {
154         Ok(..) => {}
155         Err(e) => {
156             sess.err(&format!("failed to remove {}: {}",
157                              path.display(),
158                              e));
159         }
160     }
161 }
162
163 /// Perform the linkage portion of the compilation phase. This will generate all
164 /// of the requested outputs for this compilation session.
165 pub fn link_binary(sess: &Session,
166                    trans: &CrateTranslation,
167                    outputs: &OutputFilenames,
168                    crate_name: &str) -> Vec<PathBuf> {
169     let mut out_filenames = Vec::new();
170     for &crate_type in sess.crate_types.borrow().iter() {
171         // Ignore executable crates if we have -Z no-trans, as they will error.
172         if (sess.opts.debugging_opts.no_trans ||
173             !sess.opts.output_types.should_trans()) &&
174            crate_type == config::CrateTypeExecutable {
175             continue;
176         }
177
178         if invalid_output_for_target(sess, crate_type) {
179            bug!("invalid output type `{:?}` for target os `{}`",
180                 crate_type, sess.opts.target_triple);
181         }
182         let mut out_files = link_binary_output(sess, trans, crate_type, outputs, crate_name);
183         out_filenames.append(&mut out_files);
184     }
185
186     // Remove the temporary object file and metadata if we aren't saving temps
187     if !sess.opts.cg.save_temps {
188         if sess.opts.output_types.should_trans() {
189             for obj in object_filenames(trans, outputs) {
190                 remove(sess, &obj);
191             }
192         }
193         remove(sess, &outputs.with_extension(METADATA_OBJ_NAME));
194         if trans.allocator_module.is_some() {
195             remove(sess, &outputs.with_extension(ALLOCATOR_OBJ_NAME));
196         }
197     }
198
199     out_filenames
200 }
201
202 fn is_writeable(p: &Path) -> bool {
203     match p.metadata() {
204         Err(..) => true,
205         Ok(m) => !m.permissions().readonly()
206     }
207 }
208
209 fn filename_for_metadata(sess: &Session, crate_name: &str, outputs: &OutputFilenames) -> PathBuf {
210     let out_filename = outputs.single_output_file.clone()
211         .unwrap_or(outputs
212             .out_directory
213             .join(&format!("lib{}{}.rmeta", crate_name, sess.opts.cg.extra_filename)));
214     check_file_is_writeable(&out_filename, sess);
215     out_filename
216 }
217
218 pub fn each_linked_rlib(sess: &Session,
219                         f: &mut FnMut(CrateNum, &Path)) -> Result<(), String> {
220     let crates = sess.cstore.used_crates(LinkagePreference::RequireStatic).into_iter();
221     let fmts = sess.dependency_formats.borrow();
222     let fmts = fmts.get(&config::CrateTypeExecutable)
223                    .or_else(|| fmts.get(&config::CrateTypeStaticlib))
224                    .or_else(|| fmts.get(&config::CrateTypeCdylib))
225                    .or_else(|| fmts.get(&config::CrateTypeProcMacro));
226     let fmts = match fmts {
227         Some(f) => f,
228         None => return Err(format!("could not find formats for rlibs"))
229     };
230     for (cnum, path) in crates {
231         match fmts.get(cnum.as_usize() - 1) {
232             Some(&Linkage::NotLinked) |
233             Some(&Linkage::IncludedFromDylib) => continue,
234             Some(_) => {}
235             None => return Err(format!("could not find formats for rlibs"))
236         }
237         let name = sess.cstore.crate_name(cnum).clone();
238         let path = match path {
239             LibSource::Some(p) => p,
240             LibSource::MetadataOnly => {
241                 return Err(format!("could not find rlib for: `{}`, found rmeta (metadata) file",
242                                    name))
243             }
244             LibSource::None => {
245                 return Err(format!("could not find rlib for: `{}`", name))
246             }
247         };
248         f(cnum, &path);
249     }
250     Ok(())
251 }
252
253 /// Returns a boolean indicating whether the specified crate should be ignored
254 /// during LTO.
255 ///
256 /// Crates ignored during LTO are not lumped together in the "massive object
257 /// file" that we create and are linked in their normal rlib states. See
258 /// comments below for what crates do not participate in LTO.
259 ///
260 /// It's unusual for a crate to not participate in LTO. Typically only
261 /// compiler-specific and unstable crates have a reason to not participate in
262 /// LTO.
263 pub fn ignored_for_lto(sess: &Session, cnum: CrateNum) -> bool {
264     // `#![no_builtins]` crates don't participate in LTO because the state
265     // of builtins gets messed up (our crate isn't tagged with no builtins).
266     // Similarly `#![compiler_builtins]` doesn't participate because we want
267     // those builtins!
268     sess.cstore.is_no_builtins(cnum) || sess.cstore.is_compiler_builtins(cnum)
269 }
270
271 fn out_filename(sess: &Session,
272                 crate_type: config::CrateType,
273                 outputs: &OutputFilenames,
274                 crate_name: &str)
275                 -> PathBuf {
276     let default_filename = filename_for_input(sess, crate_type, crate_name, outputs);
277     let out_filename = outputs.outputs.get(&OutputType::Exe)
278                               .and_then(|s| s.to_owned())
279                               .or_else(|| outputs.single_output_file.clone())
280                               .unwrap_or(default_filename);
281
282     check_file_is_writeable(&out_filename, sess);
283
284     out_filename
285 }
286
287 // Make sure files are writeable.  Mac, FreeBSD, and Windows system linkers
288 // check this already -- however, the Linux linker will happily overwrite a
289 // read-only file.  We should be consistent.
290 fn check_file_is_writeable(file: &Path, sess: &Session) {
291     if !is_writeable(file) {
292         sess.fatal(&format!("output file {} is not writeable -- check its \
293                             permissions", file.display()));
294     }
295 }
296
297 fn link_binary_output(sess: &Session,
298                       trans: &CrateTranslation,
299                       crate_type: config::CrateType,
300                       outputs: &OutputFilenames,
301                       crate_name: &str) -> Vec<PathBuf> {
302     let objects = object_filenames(trans, outputs);
303
304     for file in &objects {
305         check_file_is_writeable(file, sess);
306     }
307
308     let tmpdir = match TempDir::new("rustc") {
309         Ok(tmpdir) => tmpdir,
310         Err(err) => sess.fatal(&format!("couldn't create a temp dir: {}", err)),
311     };
312
313     let mut out_filenames = vec![];
314
315     if outputs.outputs.contains_key(&OutputType::Metadata) {
316         let out_filename = filename_for_metadata(sess, crate_name, outputs);
317         emit_metadata(sess, trans, &out_filename);
318         out_filenames.push(out_filename);
319     }
320
321     if outputs.outputs.should_trans() {
322         let out_filename = out_filename(sess, crate_type, outputs, crate_name);
323         match crate_type {
324             config::CrateTypeRlib => {
325                 link_rlib(sess,
326                           trans,
327                           RlibFlavor::Normal,
328                           &objects,
329                           outputs,
330                           &out_filename,
331                           tmpdir.path()).build();
332             }
333             config::CrateTypeStaticlib => {
334                 link_staticlib(sess,
335                                trans,
336                                outputs,
337                                &objects,
338                                &out_filename,
339                                tmpdir.path());
340             }
341             _ => {
342                 link_natively(sess, crate_type, &objects, &out_filename, trans,
343                               outputs, tmpdir.path());
344             }
345         }
346         out_filenames.push(out_filename);
347     }
348
349     if sess.opts.cg.save_temps {
350         let _ = tmpdir.into_path();
351     }
352
353     out_filenames
354 }
355
356 fn object_filenames(trans: &CrateTranslation,
357                     outputs: &OutputFilenames)
358                     -> Vec<PathBuf> {
359     trans.modules.iter().map(|module| {
360         outputs.temp_path(OutputType::Object, Some(&module.name))
361     }).collect()
362 }
363
364 fn archive_search_paths(sess: &Session) -> Vec<PathBuf> {
365     let mut search = Vec::new();
366     sess.target_filesearch(PathKind::Native).for_each_lib_search_path(|path, _| {
367         search.push(path.to_path_buf());
368     });
369     return search;
370 }
371
372 fn archive_config<'a>(sess: &'a Session,
373                       output: &Path,
374                       input: Option<&Path>) -> ArchiveConfig<'a> {
375     ArchiveConfig {
376         sess,
377         dst: output.to_path_buf(),
378         src: input.map(|p| p.to_path_buf()),
379         lib_search_paths: archive_search_paths(sess),
380     }
381 }
382
383 fn emit_metadata<'a>(sess: &'a Session, trans: &CrateTranslation, out_filename: &Path) {
384     let result = fs::File::create(out_filename).and_then(|mut f| {
385         f.write_all(&trans.metadata.raw_data)
386     });
387
388     if let Err(e) = result {
389         sess.fatal(&format!("failed to write {}: {}", out_filename.display(), e));
390     }
391 }
392
393 enum RlibFlavor {
394     Normal,
395     StaticlibBase,
396 }
397
398 // Create an 'rlib'
399 //
400 // An rlib in its current incarnation is essentially a renamed .a file. The
401 // rlib primarily contains the object file of the crate, but it also contains
402 // all of the object files from native libraries. This is done by unzipping
403 // native libraries and inserting all of the contents into this archive.
404 fn link_rlib<'a>(sess: &'a Session,
405                  trans: &CrateTranslation,
406                  flavor: RlibFlavor,
407                  objects: &[PathBuf],
408                  outputs: &OutputFilenames,
409                  out_filename: &Path,
410                  tmpdir: &Path) -> ArchiveBuilder<'a> {
411     info!("preparing rlib from {:?} to {:?}", objects, out_filename);
412     let mut ab = ArchiveBuilder::new(archive_config(sess, out_filename, None));
413
414     for obj in objects {
415         ab.add_file(obj);
416     }
417
418     // Note that in this loop we are ignoring the value of `lib.cfg`. That is,
419     // we may not be configured to actually include a static library if we're
420     // adding it here. That's because later when we consume this rlib we'll
421     // decide whether we actually needed the static library or not.
422     //
423     // To do this "correctly" we'd need to keep track of which libraries added
424     // which object files to the archive. We don't do that here, however. The
425     // #[link(cfg(..))] feature is unstable, though, and only intended to get
426     // liblibc working. In that sense the check below just indicates that if
427     // there are any libraries we want to omit object files for at link time we
428     // just exclude all custom object files.
429     //
430     // Eventually if we want to stabilize or flesh out the #[link(cfg(..))]
431     // feature then we'll need to figure out how to record what objects were
432     // loaded from the libraries found here and then encode that into the
433     // metadata of the rlib we're generating somehow.
434     for lib in sess.cstore.used_libraries() {
435         match lib.kind {
436             NativeLibraryKind::NativeStatic => {}
437             NativeLibraryKind::NativeStaticNobundle |
438             NativeLibraryKind::NativeFramework |
439             NativeLibraryKind::NativeUnknown => continue,
440         }
441         ab.add_native_library(&lib.name.as_str());
442     }
443
444     // After adding all files to the archive, we need to update the
445     // symbol table of the archive.
446     ab.update_symbols();
447
448     // Note that it is important that we add all of our non-object "magical
449     // files" *after* all of the object files in the archive. The reason for
450     // this is as follows:
451     //
452     // * When performing LTO, this archive will be modified to remove
453     //   objects from above. The reason for this is described below.
454     //
455     // * When the system linker looks at an archive, it will attempt to
456     //   determine the architecture of the archive in order to see whether its
457     //   linkable.
458     //
459     //   The algorithm for this detection is: iterate over the files in the
460     //   archive. Skip magical SYMDEF names. Interpret the first file as an
461     //   object file. Read architecture from the object file.
462     //
463     // * As one can probably see, if "metadata" and "foo.bc" were placed
464     //   before all of the objects, then the architecture of this archive would
465     //   not be correctly inferred once 'foo.o' is removed.
466     //
467     // Basically, all this means is that this code should not move above the
468     // code above.
469     match flavor {
470         RlibFlavor::Normal => {
471             // Instead of putting the metadata in an object file section, rlibs
472             // contain the metadata in a separate file. We use a temp directory
473             // here so concurrent builds in the same directory don't try to use
474             // the same filename for metadata (stomping over one another)
475             let metadata = tmpdir.join(METADATA_FILENAME);
476             emit_metadata(sess, trans, &metadata);
477             ab.add_file(&metadata);
478
479             // For LTO purposes, the bytecode of this library is also inserted
480             // into the archive.  If codegen_units > 1, we insert each of the
481             // bitcode files.
482             for obj in objects {
483                 // Note that we make sure that the bytecode filename in the
484                 // archive is never exactly 16 bytes long by adding a 16 byte
485                 // extension to it. This is to work around a bug in LLDB that
486                 // would cause it to crash if the name of a file in an archive
487                 // was exactly 16 bytes.
488                 let bc_filename = obj.with_extension("bc");
489                 let bc_deflated_filename = tmpdir.join({
490                     obj.with_extension("bytecode.deflate").file_name().unwrap()
491                 });
492
493                 let mut bc_data = Vec::new();
494                 match fs::File::open(&bc_filename).and_then(|mut f| {
495                     f.read_to_end(&mut bc_data)
496                 }) {
497                     Ok(..) => {}
498                     Err(e) => sess.fatal(&format!("failed to read bytecode: {}",
499                                                  e))
500                 }
501
502                 let mut bc_data_deflated = Vec::new();
503                 DeflateEncoder::new(&mut bc_data_deflated, Compression::Fast)
504                     .write_all(&bc_data).unwrap();
505
506                 let mut bc_file_deflated = match fs::File::create(&bc_deflated_filename) {
507                     Ok(file) => file,
508                     Err(e) => {
509                         sess.fatal(&format!("failed to create compressed \
510                                              bytecode file: {}", e))
511                     }
512                 };
513
514                 match write_rlib_bytecode_object_v1(&mut bc_file_deflated,
515                                                     &bc_data_deflated) {
516                     Ok(()) => {}
517                     Err(e) => {
518                         sess.fatal(&format!("failed to write compressed \
519                                              bytecode: {}", e));
520                     }
521                 };
522
523                 ab.add_file(&bc_deflated_filename);
524
525                 // See the bottom of back::write::run_passes for an explanation
526                 // of when we do and don't keep .#module-name#.bc files around.
527                 let user_wants_numbered_bitcode =
528                         sess.opts.output_types.contains_key(&OutputType::Bitcode) &&
529                         sess.opts.cg.codegen_units > 1;
530                 if !sess.opts.cg.save_temps && !user_wants_numbered_bitcode {
531                     remove(sess, &bc_filename);
532                 }
533             }
534
535             // After adding all files to the archive, we need to update the
536             // symbol table of the archive. This currently dies on macOS (see
537             // #11162), and isn't necessary there anyway
538             if !sess.target.target.options.is_like_osx {
539                 ab.update_symbols();
540             }
541         }
542
543         RlibFlavor::StaticlibBase => {
544             if trans.allocator_module.is_some() {
545                 ab.add_file(&outputs.with_extension(ALLOCATOR_OBJ_NAME));
546             }
547         }
548     }
549
550     ab
551 }
552
553 fn write_rlib_bytecode_object_v1(writer: &mut Write,
554                                  bc_data_deflated: &[u8]) -> io::Result<()> {
555     let bc_data_deflated_size: u64 = bc_data_deflated.len() as u64;
556
557     writer.write_all(RLIB_BYTECODE_OBJECT_MAGIC)?;
558     writer.write_all(&[1, 0, 0, 0])?;
559     writer.write_all(&[
560         (bc_data_deflated_size >>  0) as u8,
561         (bc_data_deflated_size >>  8) as u8,
562         (bc_data_deflated_size >> 16) as u8,
563         (bc_data_deflated_size >> 24) as u8,
564         (bc_data_deflated_size >> 32) as u8,
565         (bc_data_deflated_size >> 40) as u8,
566         (bc_data_deflated_size >> 48) as u8,
567         (bc_data_deflated_size >> 56) as u8,
568     ])?;
569     writer.write_all(&bc_data_deflated)?;
570
571     let number_of_bytes_written_so_far =
572         RLIB_BYTECODE_OBJECT_MAGIC.len() +                // magic id
573         mem::size_of_val(&RLIB_BYTECODE_OBJECT_VERSION) + // version
574         mem::size_of_val(&bc_data_deflated_size) +        // data size field
575         bc_data_deflated_size as usize;                    // actual data
576
577     // If the number of bytes written to the object so far is odd, add a
578     // padding byte to make it even. This works around a crash bug in LLDB
579     // (see issue #15950)
580     if number_of_bytes_written_so_far % 2 == 1 {
581         writer.write_all(&[0])?;
582     }
583
584     return Ok(());
585 }
586
587 // Create a static archive
588 //
589 // This is essentially the same thing as an rlib, but it also involves adding
590 // all of the upstream crates' objects into the archive. This will slurp in
591 // all of the native libraries of upstream dependencies as well.
592 //
593 // Additionally, there's no way for us to link dynamic libraries, so we warn
594 // about all dynamic library dependencies that they're not linked in.
595 //
596 // There's no need to include metadata in a static archive, so ensure to not
597 // link in the metadata object file (and also don't prepare the archive with a
598 // metadata file).
599 fn link_staticlib(sess: &Session,
600                   trans: &CrateTranslation,
601                   outputs: &OutputFilenames,
602                   objects: &[PathBuf],
603                   out_filename: &Path,
604                   tempdir: &Path) {
605     let mut ab = link_rlib(sess,
606                            trans,
607                            RlibFlavor::StaticlibBase,
608                            objects,
609                            outputs,
610                            out_filename,
611                            tempdir);
612     let mut all_native_libs = vec![];
613
614     let res = each_linked_rlib(sess, &mut |cnum, path| {
615         let name = sess.cstore.crate_name(cnum);
616         let native_libs = sess.cstore.native_libraries(cnum);
617
618         // Here when we include the rlib into our staticlib we need to make a
619         // decision whether to include the extra object files along the way.
620         // These extra object files come from statically included native
621         // libraries, but they may be cfg'd away with #[link(cfg(..))].
622         //
623         // This unstable feature, though, only needs liblibc to work. The only
624         // use case there is where musl is statically included in liblibc.rlib,
625         // so if we don't want the included version we just need to skip it. As
626         // a result the logic here is that if *any* linked library is cfg'd away
627         // we just skip all object files.
628         //
629         // Clearly this is not sufficient for a general purpose feature, and
630         // we'd want to read from the library's metadata to determine which
631         // object files come from where and selectively skip them.
632         let skip_object_files = native_libs.iter().any(|lib| {
633             lib.kind == NativeLibraryKind::NativeStatic && !relevant_lib(sess, lib)
634         });
635         ab.add_rlib(path,
636                     &name.as_str(),
637                     sess.lto() && !ignored_for_lto(sess, cnum),
638                     skip_object_files).unwrap();
639
640         all_native_libs.extend(sess.cstore.native_libraries(cnum));
641     });
642     if let Err(e) = res {
643         sess.fatal(&e);
644     }
645
646     ab.update_symbols();
647     ab.build();
648
649     if !all_native_libs.is_empty() {
650         sess.note_without_error("link against the following native artifacts when linking against \
651                                  this static library");
652         sess.note_without_error("the order and any duplication can be significant on some \
653                                  platforms, and so may need to be preserved");
654     }
655
656     for lib in all_native_libs.iter().filter(|l| relevant_lib(sess, l)) {
657         let name = match lib.kind {
658             NativeLibraryKind::NativeStaticNobundle |
659             NativeLibraryKind::NativeUnknown => "library",
660             NativeLibraryKind::NativeFramework => "framework",
661             // These are included, no need to print them
662             NativeLibraryKind::NativeStatic => continue,
663         };
664         sess.note_without_error(&format!("{}: {}", name, lib.name));
665     }
666 }
667
668 // Create a dynamic library or executable
669 //
670 // This will invoke the system linker/cc to create the resulting file. This
671 // links to all upstream files as well.
672 fn link_natively(sess: &Session,
673                  crate_type: config::CrateType,
674                  objects: &[PathBuf],
675                  out_filename: &Path,
676                  trans: &CrateTranslation,
677                  outputs: &OutputFilenames,
678                  tmpdir: &Path) {
679     info!("preparing {:?} from {:?} to {:?}", crate_type, objects, out_filename);
680     let flavor = sess.linker_flavor();
681
682     // The invocations of cc share some flags across platforms
683     let (pname, mut cmd, envs) = get_linker(sess);
684     // This will set PATH on windows
685     cmd.envs(envs);
686
687     let root = sess.target_filesearch(PathKind::Native).get_lib_path();
688     if let Some(args) = sess.target.target.options.pre_link_args.get(&flavor) {
689         cmd.args(args);
690     }
691     if let Some(ref args) = sess.opts.debugging_opts.pre_link_args {
692         cmd.args(args);
693     }
694     cmd.args(&sess.opts.debugging_opts.pre_link_arg);
695
696     let pre_link_objects = if crate_type == config::CrateTypeExecutable {
697         &sess.target.target.options.pre_link_objects_exe
698     } else {
699         &sess.target.target.options.pre_link_objects_dll
700     };
701     for obj in pre_link_objects {
702         cmd.arg(root.join(obj));
703     }
704
705     if sess.target.target.options.is_like_emscripten {
706         cmd.arg("-s");
707         cmd.arg(if sess.panic_strategy() == PanicStrategy::Abort {
708             "DISABLE_EXCEPTION_CATCHING=1"
709         } else {
710             "DISABLE_EXCEPTION_CATCHING=0"
711         });
712     }
713
714     {
715         let mut linker = trans.linker_info.to_linker(cmd, &sess);
716         link_args(&mut *linker, sess, crate_type, tmpdir,
717                   objects, out_filename, outputs, trans);
718         cmd = linker.finalize();
719     }
720     if let Some(args) = sess.target.target.options.late_link_args.get(&flavor) {
721         cmd.args(args);
722     }
723     for obj in &sess.target.target.options.post_link_objects {
724         cmd.arg(root.join(obj));
725     }
726     if let Some(args) = sess.target.target.options.post_link_args.get(&flavor) {
727         cmd.args(args);
728     }
729     for &(ref k, ref v) in &sess.target.target.options.link_env {
730         cmd.env(k, v);
731     }
732
733     if sess.opts.debugging_opts.print_link_args {
734         println!("{:?}", &cmd);
735     }
736
737     // May have not found libraries in the right formats.
738     sess.abort_if_errors();
739
740     // Invoke the system linker
741     //
742     // Note that there's a terribly awful hack that really shouldn't be present
743     // in any compiler. Here an environment variable is supported to
744     // automatically retry the linker invocation if the linker looks like it
745     // segfaulted.
746     //
747     // Gee that seems odd, normally segfaults are things we want to know about!
748     // Unfortunately though in rust-lang/rust#38878 we're experiencing the
749     // linker segfaulting on Travis quite a bit which is causing quite a bit of
750     // pain to land PRs when they spuriously fail due to a segfault.
751     //
752     // The issue #38878 has some more debugging information on it as well, but
753     // this unfortunately looks like it's just a race condition in macOS's linker
754     // with some thread pool working in the background. It seems that no one
755     // currently knows a fix for this so in the meantime we're left with this...
756     info!("{:?}", &cmd);
757     let retry_on_segfault = env::var("RUSTC_RETRY_LINKER_ON_SEGFAULT").is_ok();
758     let mut prog;
759     let mut i = 0;
760     loop {
761         i += 1;
762         prog = time(sess.time_passes(), "running linker", || cmd.output());
763         if !retry_on_segfault || i > 3 {
764             break
765         }
766         let output = match prog {
767             Ok(ref output) => output,
768             Err(_) => break,
769         };
770         if output.status.success() {
771             break
772         }
773         let mut out = output.stderr.clone();
774         out.extend(&output.stdout);
775         let out = String::from_utf8_lossy(&out);
776         let msg = "clang: error: unable to execute command: \
777                    Segmentation fault: 11";
778         if !out.contains(msg) {
779             break
780         }
781
782         sess.struct_warn("looks like the linker segfaulted when we tried to \
783                           call it, automatically retrying again")
784             .note(&format!("{:?}", cmd))
785             .note(&out)
786             .emit();
787     }
788
789     match prog {
790         Ok(prog) => {
791             fn escape_string(s: &[u8]) -> String {
792                 str::from_utf8(s).map(|s| s.to_owned())
793                     .unwrap_or_else(|_| {
794                         let mut x = "Non-UTF-8 output: ".to_string();
795                         x.extend(s.iter()
796                                  .flat_map(|&b| ascii::escape_default(b))
797                                  .map(|b| char::from_u32(b as u32).unwrap()));
798                         x
799                     })
800             }
801             if !prog.status.success() {
802                 let mut output = prog.stderr.clone();
803                 output.extend_from_slice(&prog.stdout);
804                 sess.struct_err(&format!("linking with `{}` failed: {}",
805                                          pname,
806                                          prog.status))
807                     .note(&format!("{:?}", &cmd))
808                     .note(&escape_string(&output))
809                     .emit();
810                 sess.abort_if_errors();
811             }
812             info!("linker stderr:\n{}", escape_string(&prog.stderr));
813             info!("linker stdout:\n{}", escape_string(&prog.stdout));
814         },
815         Err(e) => {
816             sess.struct_err(&format!("could not exec the linker `{}`: {}", pname, e))
817                 .note(&format!("{:?}", &cmd))
818                 .emit();
819             if sess.target.target.options.is_like_msvc && e.kind() == io::ErrorKind::NotFound {
820                 sess.note_without_error("the msvc targets depend on the msvc linker \
821                     but `link.exe` was not found");
822                 sess.note_without_error("please ensure that VS 2013 or VS 2015 was installed \
823                     with the Visual C++ option");
824             }
825             sess.abort_if_errors();
826         }
827     }
828
829
830     // On macOS, debuggers need this utility to get run to do some munging of
831     // the symbols
832     if sess.target.target.options.is_like_osx && sess.opts.debuginfo != NoDebugInfo {
833         match Command::new("dsymutil").arg(out_filename).output() {
834             Ok(..) => {}
835             Err(e) => sess.fatal(&format!("failed to run dsymutil: {}", e)),
836         }
837     }
838 }
839
840 fn link_args(cmd: &mut Linker,
841              sess: &Session,
842              crate_type: config::CrateType,
843              tmpdir: &Path,
844              objects: &[PathBuf],
845              out_filename: &Path,
846              outputs: &OutputFilenames,
847              trans: &CrateTranslation) {
848
849     // The default library location, we need this to find the runtime.
850     // The location of crates will be determined as needed.
851     let lib_path = sess.target_filesearch(PathKind::All).get_lib_path();
852
853     // target descriptor
854     let t = &sess.target.target;
855
856     cmd.include_path(&fix_windows_verbatim_for_gcc(&lib_path));
857     for obj in objects {
858         cmd.add_object(obj);
859     }
860     cmd.output_filename(out_filename);
861
862     if crate_type == config::CrateTypeExecutable &&
863        sess.target.target.options.is_like_windows {
864         if let Some(ref s) = trans.windows_subsystem {
865             cmd.subsystem(s);
866         }
867     }
868
869     // If we're building a dynamic library then some platforms need to make sure
870     // that all symbols are exported correctly from the dynamic library.
871     if crate_type != config::CrateTypeExecutable ||
872        sess.target.target.options.is_like_emscripten {
873         cmd.export_symbols(tmpdir, crate_type);
874     }
875
876     // When linking a dynamic library, we put the metadata into a section of the
877     // executable. This metadata is in a separate object file from the main
878     // object file, so we link that in here.
879     if crate_type == config::CrateTypeDylib ||
880        crate_type == config::CrateTypeProcMacro {
881         cmd.add_object(&outputs.with_extension(METADATA_OBJ_NAME));
882     }
883
884     if trans.allocator_module.is_some() {
885         cmd.add_object(&outputs.with_extension(ALLOCATOR_OBJ_NAME));
886     }
887
888     // Try to strip as much out of the generated object by removing unused
889     // sections if possible. See more comments in linker.rs
890     if !sess.opts.cg.link_dead_code {
891         let keep_metadata = crate_type == config::CrateTypeDylib;
892         cmd.gc_sections(keep_metadata);
893     }
894
895     let used_link_args = sess.cstore.used_link_args();
896
897     if crate_type == config::CrateTypeExecutable &&
898        t.options.position_independent_executables {
899         let empty_vec = Vec::new();
900         let args = sess.opts.cg.link_args.as_ref().unwrap_or(&empty_vec);
901         let more_args = &sess.opts.cg.link_arg;
902         let mut args = args.iter().chain(more_args.iter()).chain(used_link_args.iter());
903
904         if get_reloc_model(sess) == llvm::RelocMode::PIC
905             && !args.any(|x| *x == "-static") {
906             cmd.position_independent_executable();
907         }
908     }
909
910     let relro_level = match sess.opts.debugging_opts.relro_level {
911         Some(level) => level,
912         None => t.options.relro_level,
913     };
914     match relro_level {
915         RelroLevel::Full => {
916             cmd.full_relro();
917         },
918         RelroLevel::Partial => {
919             cmd.partial_relro();
920         },
921         RelroLevel::Off => {},
922     }
923
924     // Pass optimization flags down to the linker.
925     cmd.optimize();
926
927     // Pass debuginfo flags down to the linker.
928     cmd.debuginfo();
929
930     // We want to prevent the compiler from accidentally leaking in any system
931     // libraries, so we explicitly ask gcc to not link to any libraries by
932     // default. Note that this does not happen for windows because windows pulls
933     // in some large number of libraries and I couldn't quite figure out which
934     // subset we wanted.
935     if t.options.no_default_libraries {
936         cmd.no_default_libraries();
937     }
938
939     // Take careful note of the ordering of the arguments we pass to the linker
940     // here. Linkers will assume that things on the left depend on things to the
941     // right. Things on the right cannot depend on things on the left. This is
942     // all formally implemented in terms of resolving symbols (libs on the right
943     // resolve unknown symbols of libs on the left, but not vice versa).
944     //
945     // For this reason, we have organized the arguments we pass to the linker as
946     // such:
947     //
948     //  1. The local object that LLVM just generated
949     //  2. Local native libraries
950     //  3. Upstream rust libraries
951     //  4. Upstream native libraries
952     //
953     // The rationale behind this ordering is that those items lower down in the
954     // list can't depend on items higher up in the list. For example nothing can
955     // depend on what we just generated (e.g. that'd be a circular dependency).
956     // Upstream rust libraries are not allowed to depend on our local native
957     // libraries as that would violate the structure of the DAG, in that
958     // scenario they are required to link to them as well in a shared fashion.
959     //
960     // Note that upstream rust libraries may contain native dependencies as
961     // well, but they also can't depend on what we just started to add to the
962     // link line. And finally upstream native libraries can't depend on anything
963     // in this DAG so far because they're only dylibs and dylibs can only depend
964     // on other dylibs (e.g. other native deps).
965     add_local_native_libraries(cmd, sess);
966     add_upstream_rust_crates(cmd, sess, crate_type, tmpdir);
967     add_upstream_native_libraries(cmd, sess, crate_type);
968
969     // # Telling the linker what we're doing
970
971     if crate_type != config::CrateTypeExecutable {
972         cmd.build_dylib(out_filename);
973     }
974
975     // FIXME (#2397): At some point we want to rpath our guesses as to
976     // where extern libraries might live, based on the
977     // addl_lib_search_paths
978     if sess.opts.cg.rpath {
979         let sysroot = sess.sysroot();
980         let target_triple = &sess.opts.target_triple;
981         let mut get_install_prefix_lib_path = || {
982             let install_prefix = option_env!("CFG_PREFIX").expect("CFG_PREFIX");
983             let tlib = filesearch::relative_target_lib_path(sysroot, target_triple);
984             let mut path = PathBuf::from(install_prefix);
985             path.push(&tlib);
986
987             path
988         };
989         let mut rpath_config = RPathConfig {
990             used_crates: sess.cstore.used_crates(LinkagePreference::RequireDynamic),
991             out_filename: out_filename.to_path_buf(),
992             has_rpath: sess.target.target.options.has_rpath,
993             is_like_osx: sess.target.target.options.is_like_osx,
994             linker_is_gnu: sess.target.target.options.linker_is_gnu,
995             get_install_prefix_lib_path: &mut get_install_prefix_lib_path,
996         };
997         cmd.args(&rpath::get_rpath_flags(&mut rpath_config));
998     }
999
1000     // Finally add all the linker arguments provided on the command line along
1001     // with any #[link_args] attributes found inside the crate
1002     if let Some(ref args) = sess.opts.cg.link_args {
1003         cmd.args(args);
1004     }
1005     cmd.args(&sess.opts.cg.link_arg);
1006     cmd.args(&used_link_args);
1007 }
1008
1009 // # Native library linking
1010 //
1011 // User-supplied library search paths (-L on the command line). These are
1012 // the same paths used to find Rust crates, so some of them may have been
1013 // added already by the previous crate linking code. This only allows them
1014 // to be found at compile time so it is still entirely up to outside
1015 // forces to make sure that library can be found at runtime.
1016 //
1017 // Also note that the native libraries linked here are only the ones located
1018 // in the current crate. Upstream crates with native library dependencies
1019 // may have their native library pulled in above.
1020 fn add_local_native_libraries(cmd: &mut Linker, sess: &Session) {
1021     sess.target_filesearch(PathKind::All).for_each_lib_search_path(|path, k| {
1022         match k {
1023             PathKind::Framework => { cmd.framework_path(path); }
1024             _ => { cmd.include_path(&fix_windows_verbatim_for_gcc(path)); }
1025         }
1026     });
1027
1028     let relevant_libs = sess.cstore.used_libraries().into_iter().filter(|l| {
1029         relevant_lib(sess, l)
1030     });
1031
1032     let search_path = archive_search_paths(sess);
1033     for lib in relevant_libs {
1034         match lib.kind {
1035             NativeLibraryKind::NativeUnknown => cmd.link_dylib(&lib.name.as_str()),
1036             NativeLibraryKind::NativeFramework => cmd.link_framework(&lib.name.as_str()),
1037             NativeLibraryKind::NativeStaticNobundle => cmd.link_staticlib(&lib.name.as_str()),
1038             NativeLibraryKind::NativeStatic => cmd.link_whole_staticlib(&lib.name.as_str(),
1039                                                                         &search_path)
1040         }
1041     }
1042 }
1043
1044 // # Rust Crate linking
1045 //
1046 // Rust crates are not considered at all when creating an rlib output. All
1047 // dependencies will be linked when producing the final output (instead of
1048 // the intermediate rlib version)
1049 fn add_upstream_rust_crates(cmd: &mut Linker,
1050                             sess: &Session,
1051                             crate_type: config::CrateType,
1052                             tmpdir: &Path) {
1053     // All of the heavy lifting has previously been accomplished by the
1054     // dependency_format module of the compiler. This is just crawling the
1055     // output of that module, adding crates as necessary.
1056     //
1057     // Linking to a rlib involves just passing it to the linker (the linker
1058     // will slurp up the object files inside), and linking to a dynamic library
1059     // involves just passing the right -l flag.
1060
1061     let formats = sess.dependency_formats.borrow();
1062     let data = formats.get(&crate_type).unwrap();
1063
1064     // Invoke get_used_crates to ensure that we get a topological sorting of
1065     // crates.
1066     let deps = sess.cstore.used_crates(LinkagePreference::RequireDynamic);
1067
1068     let mut compiler_builtins = None;
1069
1070     for &(cnum, _) in &deps {
1071         // We may not pass all crates through to the linker. Some crates may
1072         // appear statically in an existing dylib, meaning we'll pick up all the
1073         // symbols from the dylib.
1074         let src = sess.cstore.used_crate_source(cnum);
1075         match data[cnum.as_usize() - 1] {
1076             _ if sess.cstore.is_profiler_runtime(cnum) => {
1077                 add_static_crate(cmd, sess, tmpdir, crate_type, cnum);
1078             }
1079             _ if sess.cstore.is_sanitizer_runtime(cnum) => {
1080                 link_sanitizer_runtime(cmd, sess, tmpdir, cnum);
1081             }
1082             // compiler-builtins are always placed last to ensure that they're
1083             // linked correctly.
1084             _ if sess.cstore.is_compiler_builtins(cnum) => {
1085                 assert!(compiler_builtins.is_none());
1086                 compiler_builtins = Some(cnum);
1087             }
1088             Linkage::NotLinked |
1089             Linkage::IncludedFromDylib => {}
1090             Linkage::Static => {
1091                 add_static_crate(cmd, sess, tmpdir, crate_type, cnum);
1092             }
1093             Linkage::Dynamic => {
1094                 add_dynamic_crate(cmd, sess, &src.dylib.unwrap().0)
1095             }
1096         }
1097     }
1098
1099     // compiler-builtins are always placed last to ensure that they're
1100     // linked correctly.
1101     // We must always link the `compiler_builtins` crate statically. Even if it
1102     // was already "included" in a dylib (e.g. `libstd` when `-C prefer-dynamic`
1103     // is used)
1104     if let Some(cnum) = compiler_builtins {
1105         add_static_crate(cmd, sess, tmpdir, crate_type, cnum);
1106     }
1107
1108     // Converts a library file-stem into a cc -l argument
1109     fn unlib<'a>(config: &config::Config, stem: &'a str) -> &'a str {
1110         if stem.starts_with("lib") && !config.target.options.is_like_windows {
1111             &stem[3..]
1112         } else {
1113             stem
1114         }
1115     }
1116
1117     // We must link the sanitizer runtime using -Wl,--whole-archive but since
1118     // it's packed in a .rlib, it contains stuff that are not objects that will
1119     // make the linker error. So we must remove those bits from the .rlib before
1120     // linking it.
1121     fn link_sanitizer_runtime(cmd: &mut Linker,
1122                               sess: &Session,
1123                               tmpdir: &Path,
1124                               cnum: CrateNum) {
1125         let src = sess.cstore.used_crate_source(cnum);
1126         let cratepath = &src.rlib.unwrap().0;
1127
1128         if sess.target.target.options.is_like_osx {
1129             // On Apple platforms, the sanitizer is always built as a dylib, and
1130             // LLVM will link to `@rpath/*.dylib`, so we need to specify an
1131             // rpath to the library as well (the rpath should be absolute, see
1132             // PR #41352 for details).
1133             //
1134             // FIXME: Remove this logic into librustc_*san once Cargo supports it
1135             let rpath = cratepath.parent().unwrap();
1136             let rpath = rpath.to_str().expect("non-utf8 component in path");
1137             cmd.args(&["-Wl,-rpath".into(), "-Xlinker".into(), rpath.into()]);
1138         }
1139
1140         let dst = tmpdir.join(cratepath.file_name().unwrap());
1141         let cfg = archive_config(sess, &dst, Some(cratepath));
1142         let mut archive = ArchiveBuilder::new(cfg);
1143         archive.update_symbols();
1144
1145         for f in archive.src_files() {
1146             if f.ends_with("bytecode.deflate") || f == METADATA_FILENAME {
1147                     archive.remove_file(&f);
1148                     continue
1149                 }
1150         }
1151
1152         archive.build();
1153
1154         cmd.link_whole_rlib(&dst);
1155     }
1156
1157     // Adds the static "rlib" versions of all crates to the command line.
1158     // There's a bit of magic which happens here specifically related to LTO and
1159     // dynamic libraries. Specifically:
1160     //
1161     // * For LTO, we remove upstream object files.
1162     // * For dylibs we remove metadata and bytecode from upstream rlibs
1163     //
1164     // When performing LTO, almost(*) all of the bytecode from the upstream
1165     // libraries has already been included in our object file output. As a
1166     // result we need to remove the object files in the upstream libraries so
1167     // the linker doesn't try to include them twice (or whine about duplicate
1168     // symbols). We must continue to include the rest of the rlib, however, as
1169     // it may contain static native libraries which must be linked in.
1170     //
1171     // (*) Crates marked with `#![no_builtins]` don't participate in LTO and
1172     // their bytecode wasn't included. The object files in those libraries must
1173     // still be passed to the linker.
1174     //
1175     // When making a dynamic library, linkers by default don't include any
1176     // object files in an archive if they're not necessary to resolve the link.
1177     // We basically want to convert the archive (rlib) to a dylib, though, so we
1178     // *do* want everything included in the output, regardless of whether the
1179     // linker thinks it's needed or not. As a result we must use the
1180     // --whole-archive option (or the platform equivalent). When using this
1181     // option the linker will fail if there are non-objects in the archive (such
1182     // as our own metadata and/or bytecode). All in all, for rlibs to be
1183     // entirely included in dylibs, we need to remove all non-object files.
1184     //
1185     // Note, however, that if we're not doing LTO or we're not producing a dylib
1186     // (aka we're making an executable), we can just pass the rlib blindly to
1187     // the linker (fast) because it's fine if it's not actually included as
1188     // we're at the end of the dependency chain.
1189     fn add_static_crate(cmd: &mut Linker,
1190                         sess: &Session,
1191                         tmpdir: &Path,
1192                         crate_type: config::CrateType,
1193                         cnum: CrateNum) {
1194         let src = sess.cstore.used_crate_source(cnum);
1195         let cratepath = &src.rlib.unwrap().0;
1196
1197         // See the comment above in `link_staticlib` and `link_rlib` for why if
1198         // there's a static library that's not relevant we skip all object
1199         // files.
1200         let native_libs = sess.cstore.native_libraries(cnum);
1201         let skip_native = native_libs.iter().any(|lib| {
1202             lib.kind == NativeLibraryKind::NativeStatic && !relevant_lib(sess, lib)
1203         });
1204
1205         if (!sess.lto() || ignored_for_lto(sess, cnum)) &&
1206            crate_type != config::CrateTypeDylib &&
1207            !skip_native {
1208             cmd.link_rlib(&fix_windows_verbatim_for_gcc(cratepath));
1209             return
1210         }
1211
1212         let dst = tmpdir.join(cratepath.file_name().unwrap());
1213         let name = cratepath.file_name().unwrap().to_str().unwrap();
1214         let name = &name[3..name.len() - 5]; // chop off lib/.rlib
1215
1216         time(sess.time_passes(), &format!("altering {}.rlib", name), || {
1217             let cfg = archive_config(sess, &dst, Some(cratepath));
1218             let mut archive = ArchiveBuilder::new(cfg);
1219             archive.update_symbols();
1220
1221             let mut any_objects = false;
1222             for f in archive.src_files() {
1223                 if f.ends_with("bytecode.deflate") || f == METADATA_FILENAME {
1224                     archive.remove_file(&f);
1225                     continue
1226                 }
1227
1228                 let canonical = f.replace("-", "_");
1229                 let canonical_name = name.replace("-", "_");
1230
1231                 let is_rust_object =
1232                     canonical.starts_with(&canonical_name) && {
1233                         let num = &f[name.len()..f.len() - 2];
1234                         num.len() > 0 && num[1..].parse::<u32>().is_ok()
1235                     };
1236
1237                 // If we've been requested to skip all native object files
1238                 // (those not generated by the rust compiler) then we can skip
1239                 // this file. See above for why we may want to do this.
1240                 let skip_because_cfg_say_so = skip_native && !is_rust_object;
1241
1242                 // If we're performing LTO and this is a rust-generated object
1243                 // file, then we don't need the object file as it's part of the
1244                 // LTO module. Note that `#![no_builtins]` is excluded from LTO,
1245                 // though, so we let that object file slide.
1246                 let skip_because_lto = sess.lto() && is_rust_object &&
1247                                         !sess.cstore.is_no_builtins(cnum);
1248
1249                 if skip_because_cfg_say_so || skip_because_lto {
1250                     archive.remove_file(&f);
1251                 } else {
1252                     any_objects = true;
1253                 }
1254             }
1255
1256             if !any_objects {
1257                 return
1258             }
1259             archive.build();
1260
1261             // If we're creating a dylib, then we need to include the
1262             // whole of each object in our archive into that artifact. This is
1263             // because a `dylib` can be reused as an intermediate artifact.
1264             //
1265             // Note, though, that we don't want to include the whole of a
1266             // compiler-builtins crate (e.g. compiler-rt) because it'll get
1267             // repeatedly linked anyway.
1268             if crate_type == config::CrateTypeDylib &&
1269                !sess.cstore.is_compiler_builtins(cnum) {
1270                 cmd.link_whole_rlib(&fix_windows_verbatim_for_gcc(&dst));
1271             } else {
1272                 cmd.link_rlib(&fix_windows_verbatim_for_gcc(&dst));
1273             }
1274         });
1275     }
1276
1277     // Same thing as above, but for dynamic crates instead of static crates.
1278     fn add_dynamic_crate(cmd: &mut Linker, sess: &Session, cratepath: &Path) {
1279         // If we're performing LTO, then it should have been previously required
1280         // that all upstream rust dependencies were available in an rlib format.
1281         assert!(!sess.lto());
1282
1283         // Just need to tell the linker about where the library lives and
1284         // what its name is
1285         let parent = cratepath.parent();
1286         if let Some(dir) = parent {
1287             cmd.include_path(&fix_windows_verbatim_for_gcc(dir));
1288         }
1289         let filestem = cratepath.file_stem().unwrap().to_str().unwrap();
1290         cmd.link_rust_dylib(&unlib(&sess.target, filestem),
1291                             parent.unwrap_or(Path::new("")));
1292     }
1293 }
1294
1295 // Link in all of our upstream crates' native dependencies. Remember that
1296 // all of these upstream native dependencies are all non-static
1297 // dependencies. We've got two cases then:
1298 //
1299 // 1. The upstream crate is an rlib. In this case we *must* link in the
1300 // native dependency because the rlib is just an archive.
1301 //
1302 // 2. The upstream crate is a dylib. In order to use the dylib, we have to
1303 // have the dependency present on the system somewhere. Thus, we don't
1304 // gain a whole lot from not linking in the dynamic dependency to this
1305 // crate as well.
1306 //
1307 // The use case for this is a little subtle. In theory the native
1308 // dependencies of a crate are purely an implementation detail of the crate
1309 // itself, but the problem arises with generic and inlined functions. If a
1310 // generic function calls a native function, then the generic function must
1311 // be instantiated in the target crate, meaning that the native symbol must
1312 // also be resolved in the target crate.
1313 fn add_upstream_native_libraries(cmd: &mut Linker, sess: &Session, crate_type: config::CrateType) {
1314     // Be sure to use a topological sorting of crates because there may be
1315     // interdependencies between native libraries. When passing -nodefaultlibs,
1316     // for example, almost all native libraries depend on libc, so we have to
1317     // make sure that's all the way at the right (liblibc is near the base of
1318     // the dependency chain).
1319     //
1320     // This passes RequireStatic, but the actual requirement doesn't matter,
1321     // we're just getting an ordering of crate numbers, we're not worried about
1322     // the paths.
1323     let formats = sess.dependency_formats.borrow();
1324     let data = formats.get(&crate_type).unwrap();
1325
1326     let crates = sess.cstore.used_crates(LinkagePreference::RequireStatic);
1327     for (cnum, _) in crates {
1328         for lib in sess.cstore.native_libraries(cnum) {
1329             if !relevant_lib(sess, &lib) {
1330                 continue
1331             }
1332             match lib.kind {
1333                 NativeLibraryKind::NativeUnknown => cmd.link_dylib(&lib.name.as_str()),
1334                 NativeLibraryKind::NativeFramework => cmd.link_framework(&lib.name.as_str()),
1335                 NativeLibraryKind::NativeStaticNobundle => {
1336                     // Link "static-nobundle" native libs only if the crate they originate from
1337                     // is being linked statically to the current crate.  If it's linked dynamically
1338                     // or is an rlib already included via some other dylib crate, the symbols from
1339                     // native libs will have already been included in that dylib.
1340                     if data[cnum.as_usize() - 1] == Linkage::Static {
1341                         cmd.link_staticlib(&lib.name.as_str())
1342                     }
1343                 },
1344                 // ignore statically included native libraries here as we've
1345                 // already included them when we included the rust library
1346                 // previously
1347                 NativeLibraryKind::NativeStatic => {}
1348             }
1349         }
1350     }
1351 }
1352
1353 fn relevant_lib(sess: &Session, lib: &NativeLibrary) -> bool {
1354     match lib.cfg {
1355         Some(ref cfg) => attr::cfg_matches(cfg, &sess.parse_sess, None),
1356         None => true,
1357     }
1358 }