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