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