src/librustc_codegen_ssa/back/linker.rs

   1 use super::symbol_export;
   2 use super::command::Command;
   3 use super::archive;
   4
   5 use rustc_data_structures::fx::FxHashMap;
   6 use std::ffi::{OsStr, OsString};
   7 use std::fs::{self, File};
   8 use std::io::prelude::*;
   9 use std::io::{self, BufWriter};
  10 use std::path::{Path, PathBuf};
  11
  12 use rustc::hir::def_id::{LOCAL_CRATE, CrateNum};
  13 use rustc::middle::dependency_format::Linkage;
  14 use rustc::session::Session;
  15 use rustc::session::config::{self, CrateType, OptLevel, DebugInfo,
  16                              LinkerPluginLto, Lto};
  17 use rustc::ty::TyCtxt;
  18 use rustc_target::spec::{LinkerFlavor, LldFlavor};
  19 use rustc_serialize::{json, Encoder};
  20
  21 /// For all the linkers we support, and information they might
  22 /// need out of the shared crate context before we get rid of it.
  23 pub struct LinkerInfo {
  24     exports: FxHashMap<CrateType, Vec<String>>,
  25 }
  26
  27 impl LinkerInfo {
  28     pub fn new(tcx: TyCtxt<'_>) -> LinkerInfo {
  29         LinkerInfo {
  30             exports: tcx.sess.crate_types.borrow().iter().map(|&c| {
  31                 (c, exported_symbols(tcx, c))
  32             }).collect(),
  33         }
  34     }
  35
  36     pub fn to_linker<'a>(
  37         &'a self,
  38         cmd: Command,
  39         sess: &'a Session,
  40         flavor: LinkerFlavor,
  41         target_cpu: &'a str,
  42     ) -> Box<dyn Linker+'a> {
  43         match flavor {
  44             LinkerFlavor::Lld(LldFlavor::Link) |
  45             LinkerFlavor::Msvc => {
  46                 Box::new(MsvcLinker {
  47                     cmd,
  48                     sess,
  49                     info: self
  50                 }) as Box<dyn Linker>
  51             }
  52             LinkerFlavor::Em =>  {
  53                 Box::new(EmLinker {
  54                     cmd,
  55                     sess,
  56                     info: self
  57                 }) as Box<dyn Linker>
  58             }
  59             LinkerFlavor::Gcc =>  {
  60                 Box::new(GccLinker {
  61                     cmd,
  62                     sess,
  63                     info: self,
  64                     hinted_static: false,
  65                     is_ld: false,
  66                     target_cpu,
  67                 }) as Box<dyn Linker>
  68             }
  69
  70             LinkerFlavor::Lld(LldFlavor::Ld) |
  71             LinkerFlavor::Lld(LldFlavor::Ld64) |
  72             LinkerFlavor::Ld => {
  73                 Box::new(GccLinker {
  74                     cmd,
  75                     sess,
  76                     info: self,
  77                     hinted_static: false,
  78                     is_ld: true,
  79                     target_cpu,
  80                 }) as Box<dyn Linker>
  81             }
  82
  83             LinkerFlavor::Lld(LldFlavor::Wasm) => {
  84                 Box::new(WasmLd::new(cmd, sess, self)) as Box<dyn Linker>
  85             }
  86
  87             LinkerFlavor::PtxLinker => {
  88                 Box::new(PtxLinker { cmd, sess }) as Box<dyn Linker>
  89             }
  90         }
  91     }
  92 }
  93
  94 /// Linker abstraction used by `back::link` to build up the command to invoke a
  95 /// linker.
  96 ///
  97 /// This trait is the total list of requirements needed by `back::link` and
  98 /// represents the meaning of each option being passed down. This trait is then
  99 /// used to dispatch on whether a GNU-like linker (generally `ld.exe`) or an
 100 /// MSVC linker (e.g., `link.exe`) is being used.
 101 pub trait Linker {
 102     fn link_dylib(&mut self, lib: &str);
 103     fn link_rust_dylib(&mut self, lib: &str, path: &Path);
 104     fn link_framework(&mut self, framework: &str);
 105     fn link_staticlib(&mut self, lib: &str);
 106     fn link_rlib(&mut self, lib: &Path);
 107     fn link_whole_rlib(&mut self, lib: &Path);
 108     fn link_whole_staticlib(&mut self, lib: &str, search_path: &[PathBuf]);
 109     fn include_path(&mut self, path: &Path);
 110     fn framework_path(&mut self, path: &Path);
 111     fn output_filename(&mut self, path: &Path);
 112     fn add_object(&mut self, path: &Path);
 113     fn gc_sections(&mut self, keep_metadata: bool);
 114     fn position_independent_executable(&mut self);
 115     fn no_position_independent_executable(&mut self);
 116     fn full_relro(&mut self);
 117     fn partial_relro(&mut self);
 118     fn no_relro(&mut self);
 119     fn optimize(&mut self);
 120     fn pgo_gen(&mut self);
 121     fn debuginfo(&mut self);
 122     fn no_default_libraries(&mut self);
 123     fn build_dylib(&mut self, out_filename: &Path);
 124     fn build_static_executable(&mut self);
 125     fn args(&mut self, args: &[String]);
 126     fn export_symbols(&mut self, tmpdir: &Path, crate_type: CrateType);
 127     fn subsystem(&mut self, subsystem: &str);
 128     fn group_start(&mut self);
 129     fn group_end(&mut self);
 130     fn linker_plugin_lto(&mut self);
 131     // Should have been finalize(self), but we don't support self-by-value on trait objects (yet?).
 132     fn finalize(&mut self) -> Command;
 133 }
 134
 135 pub struct GccLinker<'a> {
 136     cmd: Command,
 137     sess: &'a Session,
 138     info: &'a LinkerInfo,
 139     hinted_static: bool, // Keeps track of the current hinting mode.
 140     // Link as ld
 141     is_ld: bool,
 142     target_cpu: &'a str,
 143 }
 144
 145 impl<'a> GccLinker<'a> {
 146     /// Argument that must be passed *directly* to the linker
 147     ///
 148     /// These arguments need to be prepended with `-Wl`, when a GCC-style linker is used.
 149     fn linker_arg<S>(&mut self, arg: S) -> &mut Self
 150         where S: AsRef<OsStr>
 151     {
 152         if !self.is_ld {
 153             let mut os = OsString::from("-Wl,");
 154             os.push(arg.as_ref());
 155             self.cmd.arg(os);
 156         } else {
 157             self.cmd.arg(arg);
 158         }
 159         self
 160     }
 161
 162     fn takes_hints(&self) -> bool {
 163         // Really this function only returns true if the underlying linker
 164         // configured for a compiler is binutils `ld.bfd` and `ld.gold`. We
 165         // don't really have a foolproof way to detect that, so rule out some
 166         // platforms where currently this is guaranteed to *not* be the case:
 167         //
 168         // * On OSX they have their own linker, not binutils'
 169         // * For WebAssembly the only functional linker is LLD, which doesn't
 170         //   support hint flags
 171         !self.sess.target.target.options.is_like_osx &&
 172             self.sess.target.target.arch != "wasm32"
 173     }
 174
 175     // Some platforms take hints about whether a library is static or dynamic.
 176     // For those that support this, we ensure we pass the option if the library
 177     // was flagged "static" (most defaults are dynamic) to ensure that if
 178     // libfoo.a and libfoo.so both exist that the right one is chosen.
 179     fn hint_static(&mut self) {
 180         if !self.takes_hints() { return }
 181         if !self.hinted_static {
 182             self.linker_arg("-Bstatic");
 183             self.hinted_static = true;
 184         }
 185     }
 186
 187     fn hint_dynamic(&mut self) {
 188         if !self.takes_hints() { return }
 189         if self.hinted_static {
 190             self.linker_arg("-Bdynamic");
 191             self.hinted_static = false;
 192         }
 193     }
 194
 195     fn push_linker_plugin_lto_args(&mut self, plugin_path: Option<&OsStr>) {
 196         if let Some(plugin_path) = plugin_path {
 197             let mut arg = OsString::from("-plugin=");
 198             arg.push(plugin_path);
 199             self.linker_arg(&arg);
 200         }
 201
 202         let opt_level = match self.sess.opts.optimize {
 203             config::OptLevel::No => "O0",
 204             config::OptLevel::Less => "O1",
 205             config::OptLevel::Default => "O2",
 206             config::OptLevel::Aggressive => "O3",
 207             config::OptLevel::Size => "Os",
 208             config::OptLevel::SizeMin => "Oz",
 209         };
 210
 211         self.linker_arg(&format!("-plugin-opt={}", opt_level));
 212         let target_cpu = self.target_cpu;
 213         self.linker_arg(&format!("-plugin-opt=mcpu={}", target_cpu));
 214     }
 215 }
 216
 217 impl<'a> Linker for GccLinker<'a> {
 218     fn link_dylib(&mut self, lib: &str) { self.hint_dynamic(); self.cmd.arg(format!("-l{}", lib)); }
 219     fn link_staticlib(&mut self, lib: &str) {
 220         self.hint_static(); self.cmd.arg(format!("-l{}", lib));
 221     }
 222     fn link_rlib(&mut self, lib: &Path) { self.hint_static(); self.cmd.arg(lib); }
 223     fn include_path(&mut self, path: &Path) { self.cmd.arg("-L").arg(path); }
 224     fn framework_path(&mut self, path: &Path) { self.cmd.arg("-F").arg(path); }
 225     fn output_filename(&mut self, path: &Path) { self.cmd.arg("-o").arg(path); }
 226     fn add_object(&mut self, path: &Path) { self.cmd.arg(path); }
 227     fn position_independent_executable(&mut self) { self.cmd.arg("-pie"); }
 228     fn no_position_independent_executable(&mut self) { self.cmd.arg("-no-pie"); }
 229     fn full_relro(&mut self) { self.linker_arg("-zrelro"); self.linker_arg("-znow"); }
 230     fn partial_relro(&mut self) { self.linker_arg("-zrelro"); }
 231     fn no_relro(&mut self) { self.linker_arg("-znorelro"); }
 232     fn build_static_executable(&mut self) { self.cmd.arg("-static"); }
 233     fn args(&mut self, args: &[String]) { self.cmd.args(args); }
 234
 235     fn link_rust_dylib(&mut self, lib: &str, _path: &Path) {
 236         self.hint_dynamic();
 237         self.cmd.arg(format!("-l{}", lib));
 238     }
 239
 240     fn link_framework(&mut self, framework: &str) {
 241         self.hint_dynamic();
 242         self.cmd.arg("-framework").arg(framework);
 243     }
 244
 245     // Here we explicitly ask that the entire archive is included into the
 246     // result artifact. For more details see #15460, but the gist is that
 247     // the linker will strip away any unused objects in the archive if we
 248     // don't otherwise explicitly reference them. This can occur for
 249     // libraries which are just providing bindings, libraries with generic
 250     // functions, etc.
 251     fn link_whole_staticlib(&mut self, lib: &str, search_path: &[PathBuf]) {
 252         self.hint_static();
 253         let target = &self.sess.target.target;
 254         if !target.options.is_like_osx {
 255             self.linker_arg("--whole-archive").cmd.arg(format!("-l{}", lib));
 256             self.linker_arg("--no-whole-archive");
 257         } else {
 258             // -force_load is the macOS equivalent of --whole-archive, but it
 259             // involves passing the full path to the library to link.
 260             self.linker_arg("-force_load");
 261             let lib = archive::find_library(lib, search_path, &self.sess);
 262             self.linker_arg(&lib);
 263         }
 264     }
 265
 266     fn link_whole_rlib(&mut self, lib: &Path) {
 267         self.hint_static();
 268         if self.sess.target.target.options.is_like_osx {
 269             self.linker_arg("-force_load");
 270             self.linker_arg(&lib);
 271         } else {
 272             self.linker_arg("--whole-archive").cmd.arg(lib);
 273             self.linker_arg("--no-whole-archive");
 274         }
 275     }
 276
 277     fn gc_sections(&mut self, keep_metadata: bool) {
 278         // The dead_strip option to the linker specifies that functions and data
 279         // unreachable by the entry point will be removed. This is quite useful
 280         // with Rust's compilation model of compiling libraries at a time into
 281         // one object file. For example, this brings hello world from 1.7MB to
 282         // 458K.
 283         //
 284         // Note that this is done for both executables and dynamic libraries. We
 285         // won't get much benefit from dylibs because LLVM will have already
 286         // stripped away as much as it could. This has not been seen to impact
 287         // link times negatively.
 288         //
 289         // -dead_strip can't be part of the pre_link_args because it's also used
 290         // for partial linking when using multiple codegen units (-r).  So we
 291         // insert it here.
 292         if self.sess.target.target.options.is_like_osx {
 293             self.linker_arg("-dead_strip");
 294         } else if self.sess.target.target.options.is_like_solaris {
 295             self.linker_arg("-zignore");
 296
 297         // If we're building a dylib, we don't use --gc-sections because LLVM
 298         // has already done the best it can do, and we also don't want to
 299         // eliminate the metadata. If we're building an executable, however,
 300         // --gc-sections drops the size of hello world from 1.8MB to 597K, a 67%
 301         // reduction.
 302         } else if !keep_metadata {
 303             self.linker_arg("--gc-sections");
 304         }
 305     }
 306
 307     fn optimize(&mut self) {
 308         if !self.sess.target.target.options.linker_is_gnu { return }
 309
 310         // GNU-style linkers support optimization with -O. GNU ld doesn't
 311         // need a numeric argument, but other linkers do.
 312         if self.sess.opts.optimize == config::OptLevel::Default ||
 313            self.sess.opts.optimize == config::OptLevel::Aggressive {
 314             self.linker_arg("-O1");
 315         }
 316     }
 317
 318     fn pgo_gen(&mut self) {
 319         if !self.sess.target.target.options.linker_is_gnu { return }
 320
 321         // If we're doing PGO generation stuff and on a GNU-like linker, use the
 322         // "-u" flag to properly pull in the profiler runtime bits.
 323         //
 324         // This is because LLVM otherwise won't add the needed initialization
 325         // for us on Linux (though the extra flag should be harmless if it
 326         // does).
 327         //
 328         // See https://reviews.llvm.org/D14033 and https://reviews.llvm.org/D14030.
 329         //
 330         // Though it may be worth to try to revert those changes upstream, since
 331         // the overhead of the initialization should be minor.
 332         self.cmd.arg("-u");
 333         self.cmd.arg("__llvm_profile_runtime");
 334     }
 335
 336     fn debuginfo(&mut self) {
 337         if let DebugInfo::None = self.sess.opts.debuginfo {
 338             // If we are building without debuginfo enabled and we were called with
 339             // `-Zstrip-debuginfo-if-disabled=yes`, tell the linker to strip any debuginfo
 340             // found when linking to get rid of symbols from libstd.
 341             if let Some(true) = self.sess.opts.debugging_opts.strip_debuginfo_if_disabled {
 342                 self.linker_arg("-S");
 343             }
 344         };
 345     }
 346
 347     fn no_default_libraries(&mut self) {
 348         if !self.is_ld {
 349             self.cmd.arg("-nodefaultlibs");
 350         }
 351     }
 352
 353     fn build_dylib(&mut self, out_filename: &Path) {
 354         // On mac we need to tell the linker to let this library be rpathed
 355         if self.sess.target.target.options.is_like_osx {
 356             self.cmd.arg("-dynamiclib");
 357             self.linker_arg("-dylib");
 358
 359             // Note that the `osx_rpath_install_name` option here is a hack
 360             // purely to support rustbuild right now, we should get a more
 361             // principled solution at some point to force the compiler to pass
 362             // the right `-Wl,-install_name` with an `@rpath` in it.
 363             if self.sess.opts.cg.rpath || self.sess.opts.debugging_opts.osx_rpath_install_name {
 364                 self.linker_arg("-install_name");
 365                 let mut v = OsString::from("@rpath/");
 366                 v.push(out_filename.file_name().unwrap());
 367                 self.linker_arg(&v);
 368             }
 369         } else {
 370             self.cmd.arg("-shared");
 371             if self.sess.target.target.options.is_like_windows {
 372                 // The output filename already contains `dll_suffix` so
 373                 // the resulting import library will have a name in the
 374                 // form of libfoo.dll.a
 375                 let implib_name = out_filename
 376                     .file_name()
 377                     .and_then(|file| file.to_str())
 378                     .map(|file| format!("{}{}{}",
 379                          self.sess.target.target.options.staticlib_prefix,
 380                          file,
 381                          self.sess.target.target.options.staticlib_suffix));
 382                 if let Some(implib_name) = implib_name {
 383                     let implib = out_filename
 384                         .parent()
 385                         .map(|dir| dir.join(&implib_name));
 386                     if let Some(implib) = implib {
 387                         self.linker_arg(&format!("--out-implib,{}", (*implib).to_str().unwrap()));
 388                     }
 389                 }
 390             }
 391         }
 392     }
 393
 394     fn export_symbols(&mut self, tmpdir: &Path, crate_type: CrateType) {
 395         // Symbol visibility in object files typically takes care of this.
 396         if crate_type == CrateType::Executable {
 397             return;
 398         }
 399
 400         // We manually create a list of exported symbols to ensure we don't expose any more.
 401         // The object files have far more public symbols than we actually want to export,
 402         // so we hide them all here.
 403
 404         if !self.sess.target.target.options.limit_rdylib_exports {
 405             return;
 406         }
 407
 408         if crate_type == CrateType::ProcMacro {
 409             return
 410         }
 411
 412         let mut arg = OsString::new();
 413         let path = tmpdir.join("list");
 414
 415         debug!("EXPORTED SYMBOLS:");
 416
 417         if self.sess.target.target.options.is_like_osx {
 418             // Write a plain, newline-separated list of symbols
 419             let res: io::Result<()> = try {
 420                 let mut f = BufWriter::new(File::create(&path)?);
 421                 for sym in self.info.exports[&crate_type].iter() {
 422                     debug!("  _{}", sym);
 423                     writeln!(f, "_{}", sym)?;
 424                 }
 425             };
 426             if let Err(e) = res {
 427                 self.sess.fatal(&format!("failed to write lib.def file: {}", e));
 428             }
 429         } else {
 430             // Write an LD version script
 431             let res: io::Result<()> = try {
 432                 let mut f = BufWriter::new(File::create(&path)?);
 433                 writeln!(f, "{{")?;
 434                 if !self.info.exports[&crate_type].is_empty() {
 435                     writeln!(f, "  global:")?;
 436                     for sym in self.info.exports[&crate_type].iter() {
 437                         debug!("    {};", sym);
 438                         writeln!(f, "    {};", sym)?;
 439                     }
 440                 }
 441                 writeln!(f, "\n  local:\n    *;\n}};")?;
 442             };
 443             if let Err(e) = res {
 444                 self.sess.fatal(&format!("failed to write version script: {}", e));
 445             }
 446         }
 447
 448         if self.sess.target.target.options.is_like_osx {
 449             if !self.is_ld {
 450                 arg.push("-Wl,")
 451             }
 452             arg.push("-exported_symbols_list,");
 453         } else if self.sess.target.target.options.is_like_solaris {
 454             if !self.is_ld {
 455                 arg.push("-Wl,")
 456             }
 457             arg.push("-M,");
 458         } else {
 459             if !self.is_ld {
 460                 arg.push("-Wl,")
 461             }
 462             arg.push("--version-script=");
 463         }
 464
 465         arg.push(&path);
 466         self.cmd.arg(arg);
 467     }
 468
 469     fn subsystem(&mut self, subsystem: &str) {
 470         self.linker_arg("--subsystem");
 471         self.linker_arg(&subsystem);
 472     }
 473
 474     fn finalize(&mut self) -> Command {
 475         self.hint_dynamic(); // Reset to default before returning the composed command line.
 476
 477         ::std::mem::replace(&mut self.cmd, Command::new(""))
 478     }
 479
 480     fn group_start(&mut self) {
 481         if self.takes_hints() {
 482             self.linker_arg("--start-group");
 483         }
 484     }
 485
 486     fn group_end(&mut self) {
 487         if self.takes_hints() {
 488             self.linker_arg("--end-group");
 489         }
 490     }
 491
 492     fn linker_plugin_lto(&mut self) {
 493         match self.sess.opts.cg.linker_plugin_lto {
 494             LinkerPluginLto::Disabled => {
 495                 // Nothing to do
 496             }
 497             LinkerPluginLto::LinkerPluginAuto => {
 498                 self.push_linker_plugin_lto_args(None);
 499             }
 500             LinkerPluginLto::LinkerPlugin(ref path) => {
 501                 self.push_linker_plugin_lto_args(Some(path.as_os_str()));
 502             }
 503         }
 504     }
 505 }
 506
 507 pub struct MsvcLinker<'a> {
 508     cmd: Command,
 509     sess: &'a Session,
 510     info: &'a LinkerInfo
 511 }
 512
 513 impl<'a> Linker for MsvcLinker<'a> {
 514     fn link_rlib(&mut self, lib: &Path) { self.cmd.arg(lib); }
 515     fn add_object(&mut self, path: &Path) { self.cmd.arg(path); }
 516     fn args(&mut self, args: &[String]) { self.cmd.args(args); }
 517
 518     fn build_dylib(&mut self, out_filename: &Path) {
 519         self.cmd.arg("/DLL");
 520         let mut arg: OsString = "/IMPLIB:".into();
 521         arg.push(out_filename.with_extension("dll.lib"));
 522         self.cmd.arg(arg);
 523     }
 524
 525     fn build_static_executable(&mut self) {
 526         // noop
 527     }
 528
 529     fn gc_sections(&mut self, _keep_metadata: bool) {
 530         // MSVC's ICF (Identical COMDAT Folding) link optimization is
 531         // slow for Rust and thus we disable it by default when not in
 532         // optimization build.
 533         if self.sess.opts.optimize != config::OptLevel::No {
 534             self.cmd.arg("/OPT:REF,ICF");
 535         } else {
 536             // It is necessary to specify NOICF here, because /OPT:REF
 537             // implies ICF by default.
 538             self.cmd.arg("/OPT:REF,NOICF");
 539         }
 540     }
 541
 542     fn link_dylib(&mut self, lib: &str) {
 543         self.cmd.arg(&format!("{}.lib", lib));
 544     }
 545
 546     fn link_rust_dylib(&mut self, lib: &str, path: &Path) {
 547         // When producing a dll, the MSVC linker may not actually emit a
 548         // `foo.lib` file if the dll doesn't actually export any symbols, so we
 549         // check to see if the file is there and just omit linking to it if it's
 550         // not present.
 551         let name = format!("{}.dll.lib", lib);
 552         if fs::metadata(&path.join(&name)).is_ok() {
 553             self.cmd.arg(name);
 554         }
 555     }
 556
 557     fn link_staticlib(&mut self, lib: &str) {
 558         self.cmd.arg(&format!("{}.lib", lib));
 559     }
 560
 561     fn position_independent_executable(&mut self) {
 562         // noop
 563     }
 564
 565     fn no_position_independent_executable(&mut self) {
 566         // noop
 567     }
 568
 569     fn full_relro(&mut self) {
 570         // noop
 571     }
 572
 573     fn partial_relro(&mut self) {
 574         // noop
 575     }
 576
 577     fn no_relro(&mut self) {
 578         // noop
 579     }
 580
 581     fn no_default_libraries(&mut self) {
 582         // Currently we don't pass the /NODEFAULTLIB flag to the linker on MSVC
 583         // as there's been trouble in the past of linking the C++ standard
 584         // library required by LLVM. This likely needs to happen one day, but
 585         // in general Windows is also a more controlled environment than
 586         // Unix, so it's not necessarily as critical that this be implemented.
 587         //
 588         // Note that there are also some licensing worries about statically
 589         // linking some libraries which require a specific agreement, so it may
 590         // not ever be possible for us to pass this flag.
 591     }
 592
 593     fn include_path(&mut self, path: &Path) {
 594         let mut arg = OsString::from("/LIBPATH:");
 595         arg.push(path);
 596         self.cmd.arg(&arg);
 597     }
 598
 599     fn output_filename(&mut self, path: &Path) {
 600         let mut arg = OsString::from("/OUT:");
 601         arg.push(path);
 602         self.cmd.arg(&arg);
 603     }
 604
 605     fn framework_path(&mut self, _path: &Path) {
 606         bug!("frameworks are not supported on windows")
 607     }
 608     fn link_framework(&mut self, _framework: &str) {
 609         bug!("frameworks are not supported on windows")
 610     }
 611
 612     fn link_whole_staticlib(&mut self, lib: &str, _search_path: &[PathBuf]) {
 613         // not supported?
 614         self.link_staticlib(lib);
 615     }
 616     fn link_whole_rlib(&mut self, path: &Path) {
 617         // not supported?
 618         self.link_rlib(path);
 619     }
 620     fn optimize(&mut self) {
 621         // Needs more investigation of `/OPT` arguments
 622     }
 623
 624     fn pgo_gen(&mut self) {
 625         // Nothing needed here.
 626     }
 627
 628     fn debuginfo(&mut self) {
 629         // This will cause the Microsoft linker to generate a PDB file
 630         // from the CodeView line tables in the object files.
 631         self.cmd.arg("/DEBUG");
 632
 633         // This will cause the Microsoft linker to embed .natvis info into the PDB file
 634         let natvis_dir_path = self.sess.sysroot.join("lib\\rustlib\\etc");
 635         if let Ok(natvis_dir) = fs::read_dir(&natvis_dir_path) {
 636             for entry in natvis_dir {
 637                 match entry {
 638                     Ok(entry) => {
 639                         let path = entry.path();
 640                         if path.extension() == Some("natvis".as_ref()) {
 641                             let mut arg = OsString::from("/NATVIS:");
 642                             arg.push(path);
 643                             self.cmd.arg(arg);
 644                         }
 645                     },
 646                     Err(err) => {
 647                         self.sess.warn(&format!("error enumerating natvis directory: {}", err));
 648                     },
 649                 }
 650             }
 651         }
 652     }
 653
 654     // Currently the compiler doesn't use `dllexport` (an LLVM attribute) to
 655     // export symbols from a dynamic library. When building a dynamic library,
 656     // however, we're going to want some symbols exported, so this function
 657     // generates a DEF file which lists all the symbols.
 658     //
 659     // The linker will read this `*.def` file and export all the symbols from
 660     // the dynamic library. Note that this is not as simple as just exporting
 661     // all the symbols in the current crate (as specified by `codegen.reachable`)
 662     // but rather we also need to possibly export the symbols of upstream
 663     // crates. Upstream rlibs may be linked statically to this dynamic library,
 664     // in which case they may continue to transitively be used and hence need
 665     // their symbols exported.
 666     fn export_symbols(&mut self,
 667                       tmpdir: &Path,
 668                       crate_type: CrateType) {
 669         // Symbol visibility takes care of this typically
 670         if crate_type == CrateType::Executable {
 671             return;
 672         }
 673
 674         let path = tmpdir.join("lib.def");
 675         let res: io::Result<()> = try {
 676             let mut f = BufWriter::new(File::create(&path)?);
 677
 678             // Start off with the standard module name header and then go
 679             // straight to exports.
 680             writeln!(f, "LIBRARY")?;
 681             writeln!(f, "EXPORTS")?;
 682             for symbol in self.info.exports[&crate_type].iter() {
 683                 debug!("  _{}", symbol);
 684                 writeln!(f, "  {}", symbol)?;
 685             }
 686         };
 687         if let Err(e) = res {
 688             self.sess.fatal(&format!("failed to write lib.def file: {}", e));
 689         }
 690         let mut arg = OsString::from("/DEF:");
 691         arg.push(path);
 692         self.cmd.arg(&arg);
 693     }
 694
 695     fn subsystem(&mut self, subsystem: &str) {
 696         // Note that previous passes of the compiler validated this subsystem,
 697         // so we just blindly pass it to the linker.
 698         self.cmd.arg(&format!("/SUBSYSTEM:{}", subsystem));
 699
 700         // Windows has two subsystems we're interested in right now, the console
 701         // and windows subsystems. These both implicitly have different entry
 702         // points (starting symbols). The console entry point starts with
 703         // `mainCRTStartup` and the windows entry point starts with
 704         // `WinMainCRTStartup`. These entry points, defined in system libraries,
 705         // will then later probe for either `main` or `WinMain`, respectively to
 706         // start the application.
 707         //
 708         // In Rust we just always generate a `main` function so we want control
 709         // to always start there, so we force the entry point on the windows
 710         // subsystem to be `mainCRTStartup` to get everything booted up
 711         // correctly.
 712         //
 713         // For more information see RFC #1665
 714         if subsystem == "windows" {
 715             self.cmd.arg("/ENTRY:mainCRTStartup");
 716         }
 717     }
 718
 719     fn finalize(&mut self) -> Command {
 720         ::std::mem::replace(&mut self.cmd, Command::new(""))
 721     }
 722
 723     // MSVC doesn't need group indicators
 724     fn group_start(&mut self) {}
 725     fn group_end(&mut self) {}
 726
 727     fn linker_plugin_lto(&mut self) {
 728         // Do nothing
 729     }
 730 }
 731
 732 pub struct EmLinker<'a> {
 733     cmd: Command,
 734     sess: &'a Session,
 735     info: &'a LinkerInfo
 736 }
 737
 738 impl<'a> Linker for EmLinker<'a> {
 739     fn include_path(&mut self, path: &Path) {
 740         self.cmd.arg("-L").arg(path);
 741     }
 742
 743     fn link_staticlib(&mut self, lib: &str) {
 744         self.cmd.arg("-l").arg(lib);
 745     }
 746
 747     fn output_filename(&mut self, path: &Path) {
 748         self.cmd.arg("-o").arg(path);
 749     }
 750
 751     fn add_object(&mut self, path: &Path) {
 752         self.cmd.arg(path);
 753     }
 754
 755     fn link_dylib(&mut self, lib: &str) {
 756         // Emscripten always links statically
 757         self.link_staticlib(lib);
 758     }
 759
 760     fn link_whole_staticlib(&mut self, lib: &str, _search_path: &[PathBuf]) {
 761         // not supported?
 762         self.link_staticlib(lib);
 763     }
 764
 765     fn link_whole_rlib(&mut self, lib: &Path) {
 766         // not supported?
 767         self.link_rlib(lib);
 768     }
 769
 770     fn link_rust_dylib(&mut self, lib: &str, _path: &Path) {
 771         self.link_dylib(lib);
 772     }
 773
 774     fn link_rlib(&mut self, lib: &Path) {
 775         self.add_object(lib);
 776     }
 777
 778     fn position_independent_executable(&mut self) {
 779         // noop
 780     }
 781
 782     fn no_position_independent_executable(&mut self) {
 783         // noop
 784     }
 785
 786     fn full_relro(&mut self) {
 787         // noop
 788     }
 789
 790     fn partial_relro(&mut self) {
 791         // noop
 792     }
 793
 794     fn no_relro(&mut self) {
 795         // noop
 796     }
 797
 798     fn args(&mut self, args: &[String]) {
 799         self.cmd.args(args);
 800     }
 801
 802     fn framework_path(&mut self, _path: &Path) {
 803         bug!("frameworks are not supported on Emscripten")
 804     }
 805
 806     fn link_framework(&mut self, _framework: &str) {
 807         bug!("frameworks are not supported on Emscripten")
 808     }
 809
 810     fn gc_sections(&mut self, _keep_metadata: bool) {
 811         // noop
 812     }
 813
 814     fn optimize(&mut self) {
 815         // Emscripten performs own optimizations
 816         self.cmd.arg(match self.sess.opts.optimize {
 817             OptLevel::No => "-O0",
 818             OptLevel::Less => "-O1",
 819             OptLevel::Default => "-O2",
 820             OptLevel::Aggressive => "-O3",
 821             OptLevel::Size => "-Os",
 822             OptLevel::SizeMin => "-Oz"
 823         });
 824         // Unusable until https://github.com/rust-lang/rust/issues/38454 is resolved
 825         self.cmd.args(&["--memory-init-file", "0"]);
 826     }
 827
 828     fn pgo_gen(&mut self) {
 829         // noop, but maybe we need something like the gnu linker?
 830     }
 831
 832     fn debuginfo(&mut self) {
 833         // Preserve names or generate source maps depending on debug info
 834         self.cmd.arg(match self.sess.opts.debuginfo {
 835             DebugInfo::None => "-g0",
 836             DebugInfo::Limited => "-g3",
 837             DebugInfo::Full => "-g4"
 838         });
 839     }
 840
 841     fn no_default_libraries(&mut self) {
 842         self.cmd.args(&["-s", "DEFAULT_LIBRARY_FUNCS_TO_INCLUDE=[]"]);
 843     }
 844
 845     fn build_dylib(&mut self, _out_filename: &Path) {
 846         bug!("building dynamic library is unsupported on Emscripten")
 847     }
 848
 849     fn build_static_executable(&mut self) {
 850         // noop
 851     }
 852
 853     fn export_symbols(&mut self, _tmpdir: &Path, crate_type: CrateType) {
 854         let symbols = &self.info.exports[&crate_type];
 855
 856         debug!("EXPORTED SYMBOLS:");
 857
 858         self.cmd.arg("-s");
 859
 860         let mut arg = OsString::from("EXPORTED_FUNCTIONS=");
 861         let mut encoded = String::new();
 862
 863         {
 864             let mut encoder = json::Encoder::new(&mut encoded);
 865             let res = encoder.emit_seq(symbols.len(), |encoder| {
 866                 for (i, sym) in symbols.iter().enumerate() {
 867                     encoder.emit_seq_elt(i, |encoder| {
 868                         encoder.emit_str(&("_".to_owned() + sym))
 869                     })?;
 870                 }
 871                 Ok(())
 872             });
 873             if let Err(e) = res {
 874                 self.sess.fatal(&format!("failed to encode exported symbols: {}", e));
 875             }
 876         }
 877         debug!("{}", encoded);
 878         arg.push(encoded);
 879
 880         self.cmd.arg(arg);
 881     }
 882
 883     fn subsystem(&mut self, _subsystem: &str) {
 884         // noop
 885     }
 886
 887     fn finalize(&mut self) -> Command {
 888         ::std::mem::replace(&mut self.cmd, Command::new(""))
 889     }
 890
 891     // Appears not necessary on Emscripten
 892     fn group_start(&mut self) {}
 893     fn group_end(&mut self) {}
 894
 895     fn linker_plugin_lto(&mut self) {
 896         // Do nothing
 897     }
 898 }
 899
 900 pub struct WasmLd<'a> {
 901     cmd: Command,
 902     sess: &'a Session,
 903     info: &'a LinkerInfo,
 904 }
 905
 906 impl<'a> WasmLd<'a> {
 907     fn new(mut cmd: Command, sess: &'a Session, info: &'a LinkerInfo) -> WasmLd<'a> {
 908         // If the atomics feature is enabled for wasm then we need a whole bunch
 909         // of flags:
 910         //
 911         // * `--shared-memory` - the link won't even succeed without this, flags
 912         //   the one linear memory as `shared`
 913         //
 914         // * `--max-memory=1G` - when specifying a shared memory this must also
 915         //   be specified. We conservatively choose 1GB but users should be able
 916         //   to override this with `-C link-arg`.
 917         //
 918         // * `--import-memory` - it doesn't make much sense for memory to be
 919         //   exported in a threaded module because typically you're
 920         //   sharing memory and instantiating the module multiple times. As a
 921         //   result if it were exported then we'd just have no sharing.
 922         //
 923         // * `--passive-segments` - all memory segments should be passive to
 924         //   prevent each module instantiation from reinitializing memory.
 925         //
 926         // * `--export=__wasm_init_memory` - when using `--passive-segments` the
 927         //   linker will synthesize this function, and so we need to make sure
 928         //   that our usage of `--export` below won't accidentally cause this
 929         //   function to get deleted.
 930         //
 931         // * `--export=*tls*` - when `#[thread_local]` symbols are used these
 932         //   symbols are how the TLS segments are initialized and configured.
 933         let atomics = sess.opts.cg.target_feature.contains("+atomics") ||
 934             sess.target.target.options.features.contains("+atomics");
 935         if atomics {
 936             cmd.arg("--shared-memory");
 937             cmd.arg("--max-memory=1073741824");
 938             cmd.arg("--import-memory");
 939             cmd.arg("--passive-segments");
 940             cmd.arg("--export=__wasm_init_memory");
 941             cmd.arg("--export=__wasm_init_tls");
 942             cmd.arg("--export=__tls_size");
 943             cmd.arg("--export=__tls_align");
 944             cmd.arg("--export=__tls_base");
 945         }
 946         WasmLd { cmd, sess, info }
 947     }
 948 }
 949
 950 impl<'a> Linker for WasmLd<'a> {
 951     fn link_dylib(&mut self, lib: &str) {
 952         self.cmd.arg("-l").arg(lib);
 953     }
 954
 955     fn link_staticlib(&mut self, lib: &str) {
 956         self.cmd.arg("-l").arg(lib);
 957     }
 958
 959     fn link_rlib(&mut self, lib: &Path) {
 960         self.cmd.arg(lib);
 961     }
 962
 963     fn include_path(&mut self, path: &Path) {
 964         self.cmd.arg("-L").arg(path);
 965     }
 966
 967     fn framework_path(&mut self, _path: &Path) {
 968         panic!("frameworks not supported")
 969     }
 970
 971     fn output_filename(&mut self, path: &Path) {
 972         self.cmd.arg("-o").arg(path);
 973     }
 974
 975     fn add_object(&mut self, path: &Path) {
 976         self.cmd.arg(path);
 977     }
 978
 979     fn position_independent_executable(&mut self) {
 980     }
 981
 982     fn full_relro(&mut self) {
 983     }
 984
 985     fn partial_relro(&mut self) {
 986     }
 987
 988     fn no_relro(&mut self) {
 989     }
 990
 991     fn build_static_executable(&mut self) {
 992     }
 993
 994     fn args(&mut self, args: &[String]) {
 995         self.cmd.args(args);
 996     }
 997
 998     fn link_rust_dylib(&mut self, lib: &str, _path: &Path) {
 999         self.cmd.arg("-l").arg(lib);
1000     }
1001
1002     fn link_framework(&mut self, _framework: &str) {
1003         panic!("frameworks not supported")
1004     }
1005
1006     fn link_whole_staticlib(&mut self, lib: &str, _search_path: &[PathBuf]) {
1007         self.cmd.arg("-l").arg(lib);
1008     }
1009
1010     fn link_whole_rlib(&mut self, lib: &Path) {
1011         self.cmd.arg(lib);
1012     }
1013
1014     fn gc_sections(&mut self, _keep_metadata: bool) {
1015         self.cmd.arg("--gc-sections");
1016     }
1017
1018     fn optimize(&mut self) {
1019         self.cmd.arg(match self.sess.opts.optimize {
1020             OptLevel::No => "-O0",
1021             OptLevel::Less => "-O1",
1022             OptLevel::Default => "-O2",
1023             OptLevel::Aggressive => "-O3",
1024             // Currently LLD doesn't support `Os` and `Oz`, so pass through `O2`
1025             // instead.
1026             OptLevel::Size => "-O2",
1027             OptLevel::SizeMin => "-O2"
1028         });
1029     }
1030
1031     fn pgo_gen(&mut self) {
1032     }
1033
1034     fn debuginfo(&mut self) {
1035     }
1036
1037     fn no_default_libraries(&mut self) {
1038     }
1039
1040     fn build_dylib(&mut self, _out_filename: &Path) {
1041         self.cmd.arg("--no-entry");
1042     }
1043
1044     fn export_symbols(&mut self, _tmpdir: &Path, crate_type: CrateType) {
1045         for sym in self.info.exports[&crate_type].iter() {
1046             self.cmd.arg("--export").arg(&sym);
1047         }
1048
1049         // LLD will hide these otherwise-internal symbols since our `--export`
1050         // list above is a whitelist of what to export. Various bits and pieces
1051         // of tooling use this, so be sure these symbols make their way out of
1052         // the linker as well.
1053         self.cmd.arg("--export=__heap_base");
1054         self.cmd.arg("--export=__data_end");
1055     }
1056
1057     fn subsystem(&mut self, _subsystem: &str) {
1058     }
1059
1060     fn no_position_independent_executable(&mut self) {
1061     }
1062
1063     fn finalize(&mut self) -> Command {
1064         ::std::mem::replace(&mut self.cmd, Command::new(""))
1065     }
1066
1067     // Not needed for now with LLD
1068     fn group_start(&mut self) {}
1069     fn group_end(&mut self) {}
1070
1071     fn linker_plugin_lto(&mut self) {
1072         // Do nothing for now
1073     }
1074 }
1075
1076 fn exported_symbols(tcx: TyCtxt<'_>, crate_type: CrateType) -> Vec<String> {
1077     if let Some(ref exports) = tcx.sess.target.target.options.override_export_symbols {
1078         return exports.clone()
1079     }
1080
1081     let mut symbols = Vec::new();
1082
1083     let export_threshold = symbol_export::crates_export_threshold(&[crate_type]);
1084     for &(symbol, level) in tcx.exported_symbols(LOCAL_CRATE).iter() {
1085         if level.is_below_threshold(export_threshold) {
1086             symbols.push(symbol.symbol_name(tcx).to_string());
1087         }
1088     }
1089
1090     let formats = tcx.sess.dependency_formats.borrow();
1091     let deps = formats[&crate_type].iter();
1092
1093     for (index, dep_format) in deps.enumerate() {
1094         let cnum = CrateNum::new(index + 1);
1095         // For each dependency that we are linking to statically ...
1096         if *dep_format == Linkage::Static {
1097             // ... we add its symbol list to our export list.
1098             for &(symbol, level) in tcx.exported_symbols(cnum).iter() {
1099                 if level.is_below_threshold(export_threshold) {
1100                     symbols.push(symbol.symbol_name(tcx).to_string());
1101                 }
1102             }
1103         }
1104     }
1105
1106     symbols
1107 }
1108
1109 /// Much simplified and explicit CLI for the NVPTX linker. The linker operates
1110 /// with bitcode and uses LLVM backend to generate a PTX assembly.
1111 pub struct PtxLinker<'a> {
1112     cmd: Command,
1113     sess: &'a Session,
1114 }
1115
1116 impl<'a> Linker for PtxLinker<'a> {
1117     fn link_rlib(&mut self, path: &Path) {
1118         self.cmd.arg("--rlib").arg(path);
1119     }
1120
1121     fn link_whole_rlib(&mut self, path: &Path) {
1122         self.cmd.arg("--rlib").arg(path);
1123     }
1124
1125     fn include_path(&mut self, path: &Path) {
1126         self.cmd.arg("-L").arg(path);
1127     }
1128
1129     fn debuginfo(&mut self) {
1130         self.cmd.arg("--debug");
1131     }
1132
1133     fn add_object(&mut self, path: &Path) {
1134         self.cmd.arg("--bitcode").arg(path);
1135     }
1136
1137     fn args(&mut self, args: &[String]) {
1138         self.cmd.args(args);
1139     }
1140
1141     fn optimize(&mut self) {
1142         match self.sess.lto() {
1143             Lto::Thin | Lto::Fat | Lto::ThinLocal => {
1144                 self.cmd.arg("-Olto");
1145             },
1146
1147             Lto::No => { },
1148         };
1149     }
1150
1151     fn output_filename(&mut self, path: &Path) {
1152         self.cmd.arg("-o").arg(path);
1153     }
1154
1155     fn finalize(&mut self) -> Command {
1156         // Provide the linker with fallback to internal `target-cpu`.
1157         self.cmd.arg("--fallback-arch").arg(match self.sess.opts.cg.target_cpu {
1158             Some(ref s) => s,
1159             None => &self.sess.target.target.options.cpu
1160         });
1161
1162         ::std::mem::replace(&mut self.cmd, Command::new(""))
1163     }
1164
1165     fn link_dylib(&mut self, _lib: &str) {
1166         panic!("external dylibs not supported")
1167     }
1168
1169     fn link_rust_dylib(&mut self, _lib: &str, _path: &Path) {
1170         panic!("external dylibs not supported")
1171     }
1172
1173     fn link_staticlib(&mut self, _lib: &str) {
1174         panic!("staticlibs not supported")
1175     }
1176
1177     fn link_whole_staticlib(&mut self, _lib: &str, _search_path: &[PathBuf]) {
1178         panic!("staticlibs not supported")
1179     }
1180
1181     fn framework_path(&mut self, _path: &Path) {
1182         panic!("frameworks not supported")
1183     }
1184
1185     fn link_framework(&mut self, _framework: &str) {
1186         panic!("frameworks not supported")
1187     }
1188
1189     fn position_independent_executable(&mut self) {
1190     }
1191
1192     fn full_relro(&mut self) {
1193     }
1194
1195     fn partial_relro(&mut self) {
1196     }
1197
1198     fn no_relro(&mut self) {
1199     }
1200
1201     fn build_static_executable(&mut self) {
1202     }
1203
1204     fn gc_sections(&mut self, _keep_metadata: bool) {
1205     }
1206
1207     fn pgo_gen(&mut self) {
1208     }
1209
1210     fn no_default_libraries(&mut self) {
1211     }
1212
1213     fn build_dylib(&mut self, _out_filename: &Path) {
1214     }
1215
1216     fn export_symbols(&mut self, _tmpdir: &Path, _crate_type: CrateType) {
1217     }
1218
1219     fn subsystem(&mut self, _subsystem: &str) {
1220     }
1221
1222     fn no_position_independent_executable(&mut self) {
1223     }
1224
1225     fn group_start(&mut self) {
1226     }
1227
1228     fn group_end(&mut self) {
1229     }
1230
1231     fn linker_plugin_lto(&mut self) {
1232     }
1233 }