1 use rustc_arena::TypedArena;
2 use rustc_ast::CRATE_NODE_ID;
3 use rustc_data_structures::fx::FxHashSet;
4 use rustc_data_structures::fx::FxIndexMap;
5 use rustc_data_structures::memmap::Mmap;
6 use rustc_data_structures::temp_dir::MaybeTempDir;
7 use rustc_errors::{ErrorGuaranteed, Handler};
8 use rustc_fs_util::fix_windows_verbatim_for_gcc;
9 use rustc_hir::def_id::{CrateNum, LOCAL_CRATE};
10 use rustc_metadata::find_native_static_library;
11 use rustc_metadata::fs::{emit_wrapper_file, METADATA_FILENAME};
12 use rustc_middle::middle::dependency_format::Linkage;
13 use rustc_middle::middle::exported_symbols::SymbolExportKind;
14 use rustc_session::config::{self, CFGuard, CrateType, DebugInfo, LdImpl, Lto, Strip};
15 use rustc_session::config::{OutputFilenames, OutputType, PrintRequest, SplitDwarfKind};
16 use rustc_session::cstore::DllImport;
17 use rustc_session::output::{check_file_is_writeable, invalid_output_for_target, out_filename};
18 use rustc_session::search_paths::PathKind;
19 use rustc_session::utils::NativeLibKind;
20 /// For all the linkers we support, and information they might
21 /// need out of the shared crate context before we get rid of it.
22 use rustc_session::{filesearch, Session};
23 use rustc_span::symbol::Symbol;
24 use rustc_span::DebuggerVisualizerFile;
25 use rustc_target::spec::crt_objects::{CrtObjects, LinkSelfContainedDefault};
26 use rustc_target::spec::{Cc, LinkOutputKind, LinkerFlavor, LinkerFlavorCli, Lld, PanicStrategy};
27 use rustc_target::spec::{RelocModel, RelroLevel, SanitizerSet, SplitDebuginfo};
29 use super::archive::{ArchiveBuilder, ArchiveBuilderBuilder};
30 use super::command::Command;
31 use super::linker::{self, Linker};
32 use super::metadata::{create_wrapper_file, MetadataPosition};
33 use super::rpath::{self, RPathConfig};
35 errors, looks_like_rust_object_file, CodegenResults, CompiledModule, CrateInfo, NativeLib,
38 use cc::windows_registry;
40 use tempfile::Builder as TempFileBuilder;
42 use itertools::Itertools;
43 use std::borrow::Borrow;
44 use std::cell::OnceCell;
45 use std::collections::BTreeSet;
46 use std::ffi::OsString;
47 use std::fs::{read, File, OpenOptions};
48 use std::io::{BufWriter, Write};
50 use std::path::{Path, PathBuf};
51 use std::process::{ExitStatus, Output, Stdio};
52 use std::{env, fmt, fs, io, mem, str};
54 pub fn ensure_removed(diag_handler: &Handler, path: &Path) {
55 if let Err(e) = fs::remove_file(path) {
56 if e.kind() != io::ErrorKind::NotFound {
57 diag_handler.err(&format!("failed to remove {}: {}", path.display(), e));
62 /// Performs the linkage portion of the compilation phase. This will generate all
63 /// of the requested outputs for this compilation session.
64 pub fn link_binary<'a>(
66 archive_builder_builder: &dyn ArchiveBuilderBuilder,
67 codegen_results: &CodegenResults,
68 outputs: &OutputFilenames,
69 ) -> Result<(), ErrorGuaranteed> {
70 let _timer = sess.timer("link_binary");
71 let output_metadata = sess.opts.output_types.contains_key(&OutputType::Metadata);
72 for &crate_type in sess.crate_types().iter() {
73 // Ignore executable crates if we have -Z no-codegen, as they will error.
74 if (sess.opts.unstable_opts.no_codegen || !sess.opts.output_types.should_codegen())
76 && crate_type == CrateType::Executable
81 if invalid_output_for_target(sess, crate_type) {
83 "invalid output type `{:?}` for target os `{}`",
85 sess.opts.target_triple
89 sess.time("link_binary_check_files_are_writeable", || {
90 for obj in codegen_results.modules.iter().filter_map(|m| m.object.as_ref()) {
91 check_file_is_writeable(obj, sess);
95 if outputs.outputs.should_link() {
96 let tmpdir = TempFileBuilder::new()
99 .unwrap_or_else(|error| sess.emit_fatal(errors::CreateTempDir { error }));
100 let path = MaybeTempDir::new(tmpdir, sess.opts.cg.save_temps);
101 let out_filename = out_filename(
105 codegen_results.crate_info.local_crate_name.as_str(),
109 let _timer = sess.timer("link_rlib");
110 info!("preparing rlib to {:?}", out_filename);
113 archive_builder_builder,
118 .build(&out_filename);
120 CrateType::Staticlib => {
123 archive_builder_builder,
132 archive_builder_builder,
140 if sess.opts.json_artifact_notifications {
141 sess.parse_sess.span_diagnostic.emit_artifact_notification(&out_filename, "link");
144 if sess.prof.enabled() {
145 if let Some(artifact_name) = out_filename.file_name() {
146 // Record size for self-profiling
147 let file_size = std::fs::metadata(&out_filename).map(|m| m.len()).unwrap_or(0);
149 sess.prof.artifact_size(
151 artifact_name.to_string_lossy(),
159 // Remove the temporary object file and metadata if we aren't saving temps.
160 sess.time("link_binary_remove_temps", || {
161 // If the user requests that temporaries are saved, don't delete any.
162 if sess.opts.cg.save_temps {
166 let maybe_remove_temps_from_module =
167 |preserve_objects: bool, preserve_dwarf_objects: bool, module: &CompiledModule| {
168 if !preserve_objects {
169 if let Some(ref obj) = module.object {
170 ensure_removed(sess.diagnostic(), obj);
174 if !preserve_dwarf_objects {
175 if let Some(ref dwo_obj) = module.dwarf_object {
176 ensure_removed(sess.diagnostic(), dwo_obj);
181 let remove_temps_from_module =
182 |module: &CompiledModule| maybe_remove_temps_from_module(false, false, module);
184 // Otherwise, always remove the metadata and allocator module temporaries.
185 if let Some(ref metadata_module) = codegen_results.metadata_module {
186 remove_temps_from_module(metadata_module);
189 if let Some(ref allocator_module) = codegen_results.allocator_module {
190 remove_temps_from_module(allocator_module);
193 // If no requested outputs require linking, then the object temporaries should
195 if !sess.opts.output_types.should_link() {
199 // Potentially keep objects for their debuginfo.
200 let (preserve_objects, preserve_dwarf_objects) = preserve_objects_for_their_debuginfo(sess);
201 debug!(?preserve_objects, ?preserve_dwarf_objects);
203 for module in &codegen_results.modules {
204 maybe_remove_temps_from_module(preserve_objects, preserve_dwarf_objects, module);
211 pub fn each_linked_rlib(
214 f: &mut dyn FnMut(CrateNum, &Path),
215 ) -> Result<(), errors::LinkRlibError> {
216 let crates = info.used_crates.iter();
219 let lto_active = matches!(sess.lto(), Lto::Fat | Lto::Thin);
221 for combination in info.dependency_formats.iter().combinations(2) {
222 let (ty1, list1) = &combination[0];
223 let (ty2, list2) = &combination[1];
225 return Err(errors::LinkRlibError::IncompatibleDependencyFormats {
226 ty1: format!("{ty1:?}"),
227 ty2: format!("{ty2:?}"),
228 list1: format!("{list1:?}"),
229 list2: format!("{list2:?}"),
235 for (ty, list) in info.dependency_formats.iter() {
237 CrateType::Executable
238 | CrateType::Staticlib
240 | CrateType::ProcMacro => {
244 CrateType::Dylib if lto_active => {
251 let Some(fmts) = fmts else {
252 return Err(errors::LinkRlibError::MissingFormat);
254 for &cnum in crates {
255 match fmts.get(cnum.as_usize() - 1) {
256 Some(&Linkage::NotLinked | &Linkage::IncludedFromDylib) => continue,
258 None => return Err(errors::LinkRlibError::MissingFormat),
260 let crate_name = info.crate_name[&cnum];
261 let used_crate_source = &info.used_crate_source[&cnum];
262 if let Some((path, _)) = &used_crate_source.rlib {
265 if used_crate_source.rmeta.is_some() {
266 return Err(errors::LinkRlibError::OnlyRmetaFound { crate_name });
268 return Err(errors::LinkRlibError::NotFound { crate_name });
275 /// Create an 'rlib'.
277 /// An rlib in its current incarnation is essentially a renamed .a file. The rlib primarily contains
278 /// the object file of the crate, but it also contains all of the object files from native
279 /// libraries. This is done by unzipping native libraries and inserting all of the contents into
283 archive_builder_builder: &dyn ArchiveBuilderBuilder,
284 codegen_results: &CodegenResults,
286 tmpdir: &MaybeTempDir,
287 ) -> Result<Box<dyn ArchiveBuilder<'a> + 'a>, ErrorGuaranteed> {
288 let lib_search_paths = archive_search_paths(sess);
290 let mut ab = archive_builder_builder.new_archive_builder(sess);
292 let trailing_metadata = match flavor {
293 RlibFlavor::Normal => {
294 let (metadata, metadata_position) =
295 create_wrapper_file(sess, b".rmeta".to_vec(), codegen_results.metadata.raw_data());
296 let metadata = emit_wrapper_file(sess, &metadata, tmpdir, METADATA_FILENAME);
297 match metadata_position {
298 MetadataPosition::First => {
299 // Most of the time metadata in rlib files is wrapped in a "dummy" object
300 // file for the target platform so the rlib can be processed entirely by
301 // normal linkers for the platform. Sometimes this is not possible however.
302 // If it is possible however, placing the metadata object first improves
303 // performance of getting metadata from rlibs.
304 ab.add_file(&metadata);
307 MetadataPosition::Last => Some(metadata),
311 RlibFlavor::StaticlibBase => None,
314 for m in &codegen_results.modules {
315 if let Some(obj) = m.object.as_ref() {
319 if let Some(dwarf_obj) = m.dwarf_object.as_ref() {
320 ab.add_file(dwarf_obj);
325 RlibFlavor::Normal => {}
326 RlibFlavor::StaticlibBase => {
327 let obj = codegen_results.allocator_module.as_ref().and_then(|m| m.object.as_ref());
328 if let Some(obj) = obj {
334 // Used if packed_bundled_libs flag enabled.
335 let mut packed_bundled_libs = Vec::new();
337 // Note that in this loop we are ignoring the value of `lib.cfg`. That is,
338 // we may not be configured to actually include a static library if we're
339 // adding it here. That's because later when we consume this rlib we'll
340 // decide whether we actually needed the static library or not.
342 // To do this "correctly" we'd need to keep track of which libraries added
343 // which object files to the archive. We don't do that here, however. The
344 // #[link(cfg(..))] feature is unstable, though, and only intended to get
345 // liblibc working. In that sense the check below just indicates that if
346 // there are any libraries we want to omit object files for at link time we
347 // just exclude all custom object files.
349 // Eventually if we want to stabilize or flesh out the #[link(cfg(..))]
350 // feature then we'll need to figure out how to record what objects were
351 // loaded from the libraries found here and then encode that into the
352 // metadata of the rlib we're generating somehow.
353 for lib in codegen_results.crate_info.used_libraries.iter() {
355 NativeLibKind::Static { bundle: None | Some(true), whole_archive: Some(true) }
356 if flavor == RlibFlavor::Normal && sess.opts.unstable_opts.packed_bundled_libs => {}
357 NativeLibKind::Static { bundle: None | Some(true), whole_archive: Some(true) }
358 if flavor == RlibFlavor::Normal =>
360 // Don't allow mixing +bundle with +whole_archive since an rlib may contain
361 // multiple native libs, some of which are +whole-archive and some of which are
362 // -whole-archive and it isn't clear how we can currently handle such a
363 // situation correctly.
364 // See https://github.com/rust-lang/rust/issues/88085#issuecomment-901050897
365 sess.emit_err(errors::IncompatibleLinkingModifiers);
367 NativeLibKind::Static { bundle: None | Some(true), .. } => {}
368 NativeLibKind::Static { bundle: Some(false), .. }
369 | NativeLibKind::Dylib { .. }
370 | NativeLibKind::Framework { .. }
371 | NativeLibKind::RawDylib
372 | NativeLibKind::LinkArg
373 | NativeLibKind::Unspecified => continue,
375 if let Some(name) = lib.name {
377 find_native_static_library(name.as_str(), lib.verbatim, &lib_search_paths, sess);
378 if sess.opts.unstable_opts.packed_bundled_libs && flavor == RlibFlavor::Normal {
379 let filename = lib.filename.unwrap();
380 let lib_path = find_native_static_library(
386 let src = read(lib_path)
387 .map_err(|e| sess.emit_fatal(errors::ReadFileError { message: e }))?;
388 let (data, _) = create_wrapper_file(sess, b".bundled_lib".to_vec(), &src);
389 let wrapper_file = emit_wrapper_file(sess, &data, tmpdir, filename.as_str());
390 packed_bundled_libs.push(wrapper_file);
393 ab.add_archive(&location, Box::new(|_| false)).unwrap_or_else(|error| {
394 sess.emit_fatal(errors::AddNativeLibrary { library_path: location, error });
399 for (raw_dylib_name, raw_dylib_imports) in
400 collate_raw_dylibs(sess, codegen_results.crate_info.used_libraries.iter())?
402 let output_path = archive_builder_builder.create_dll_import_lib(
410 ab.add_archive(&output_path, Box::new(|_| false)).unwrap_or_else(|error| {
411 sess.emit_fatal(errors::AddNativeLibrary { library_path: output_path, error });
415 if let Some(trailing_metadata) = trailing_metadata {
416 // Note that it is important that we add all of our non-object "magical
417 // files" *after* all of the object files in the archive. The reason for
418 // this is as follows:
420 // * When performing LTO, this archive will be modified to remove
421 // objects from above. The reason for this is described below.
423 // * When the system linker looks at an archive, it will attempt to
424 // determine the architecture of the archive in order to see whether its
427 // The algorithm for this detection is: iterate over the files in the
428 // archive. Skip magical SYMDEF names. Interpret the first file as an
429 // object file. Read architecture from the object file.
431 // * As one can probably see, if "metadata" and "foo.bc" were placed
432 // before all of the objects, then the architecture of this archive would
433 // not be correctly inferred once 'foo.o' is removed.
435 // * Most of the time metadata in rlib files is wrapped in a "dummy" object
436 // file for the target platform so the rlib can be processed entirely by
437 // normal linkers for the platform. Sometimes this is not possible however.
439 // Basically, all this means is that this code should not move above the
441 ab.add_file(&trailing_metadata);
444 // Add all bundled static native library dependencies.
445 // Archives added to the end of .rlib archive, see comment above for the reason.
446 for lib in packed_bundled_libs {
453 /// Extract all symbols defined in raw-dylib libraries, collated by library name.
455 /// If we have multiple extern blocks that specify symbols defined in the same raw-dylib library,
456 /// then the CodegenResults value contains one NativeLib instance for each block. However, the
457 /// linker appears to expect only a single import library for each library used, so we need to
458 /// collate the symbols together by library name before generating the import libraries.
459 fn collate_raw_dylibs<'a, 'b>(
461 used_libraries: impl IntoIterator<Item = &'b NativeLib>,
462 ) -> Result<Vec<(String, Vec<DllImport>)>, ErrorGuaranteed> {
463 // Use index maps to preserve original order of imports and libraries.
464 let mut dylib_table = FxIndexMap::<String, FxIndexMap<Symbol, &DllImport>>::default();
466 for lib in used_libraries {
467 if lib.kind == NativeLibKind::RawDylib {
468 let ext = if matches!(lib.verbatim, Some(true)) { "" } else { ".dll" };
469 let name = format!("{}{}", lib.name.expect("unnamed raw-dylib library"), ext);
470 let imports = dylib_table.entry(name.clone()).or_default();
471 for import in &lib.dll_imports {
472 if let Some(old_import) = imports.insert(import.name, import) {
473 // FIXME: when we add support for ordinals, figure out if we need to do anything
474 // if we have two DllImport values with the same name but different ordinals.
475 if import.calling_convention != old_import.calling_convention {
476 sess.emit_err(errors::MultipleExternalFuncDecl {
478 function: import.name,
486 sess.compile_status()?;
489 .map(|(name, imports)| {
490 (name, imports.into_iter().map(|(_, import)| import.clone()).collect())
495 /// Create a static archive.
497 /// This is essentially the same thing as an rlib, but it also involves adding all of the upstream
498 /// crates' objects into the archive. This will slurp in all of the native libraries of upstream
499 /// dependencies as well.
501 /// Additionally, there's no way for us to link dynamic libraries, so we warn about all dynamic
502 /// library dependencies that they're not linked in.
504 /// There's no need to include metadata in a static archive, so ensure to not link in the metadata
505 /// object file (and also don't prepare the archive with a metadata file).
506 fn link_staticlib<'a>(
508 archive_builder_builder: &dyn ArchiveBuilderBuilder,
509 codegen_results: &CodegenResults,
511 tempdir: &MaybeTempDir,
512 ) -> Result<(), ErrorGuaranteed> {
513 info!("preparing staticlib to {:?}", out_filename);
514 let mut ab = link_rlib(
516 archive_builder_builder,
518 RlibFlavor::StaticlibBase,
521 let mut all_native_libs = vec![];
523 let res = each_linked_rlib(sess, &codegen_results.crate_info, &mut |cnum, path| {
524 let name = codegen_results.crate_info.crate_name[&cnum];
525 let native_libs = &codegen_results.crate_info.native_libraries[&cnum];
527 // Here when we include the rlib into our staticlib we need to make a
528 // decision whether to include the extra object files along the way.
529 // These extra object files come from statically included native
530 // libraries, but they may be cfg'd away with #[link(cfg(..))].
532 // This unstable feature, though, only needs liblibc to work. The only
533 // use case there is where musl is statically included in liblibc.rlib,
534 // so if we don't want the included version we just need to skip it. As
535 // a result the logic here is that if *any* linked library is cfg'd away
536 // we just skip all object files.
538 // Clearly this is not sufficient for a general purpose feature, and
539 // we'd want to read from the library's metadata to determine which
540 // object files come from where and selectively skip them.
541 let skip_object_files = native_libs.iter().any(|lib| {
542 matches!(lib.kind, NativeLibKind::Static { bundle: None | Some(true), .. })
543 && !relevant_lib(sess, lib)
546 let lto = are_upstream_rust_objects_already_included(sess)
547 && !ignored_for_lto(sess, &codegen_results.crate_info, cnum);
549 // Ignoring obj file starting with the crate name
550 // as simple comparison is not enough - there
551 // might be also an extra name suffix
552 let obj_start = name.as_str().to_owned();
556 Box::new(move |fname: &str| {
557 // Ignore metadata files, no matter the name.
558 if fname == METADATA_FILENAME {
562 // Don't include Rust objects if LTO is enabled
563 if lto && looks_like_rust_object_file(fname) {
567 // Otherwise if this is *not* a rust object and we're skipping
568 // objects then skip this file
569 if skip_object_files && (!fname.starts_with(&obj_start) || !fname.ends_with(".o")) {
573 // ok, don't skip this
579 all_native_libs.extend(codegen_results.crate_info.native_libraries[&cnum].iter().cloned());
581 if let Err(e) = res {
585 ab.build(out_filename);
587 if !all_native_libs.is_empty() {
588 if sess.opts.prints.contains(&PrintRequest::NativeStaticLibs) {
589 print_native_static_libs(sess, &all_native_libs);
596 /// Use `thorin` (rust implementation of a dwarf packaging utility) to link DWARF objects into a
598 fn link_dwarf_object<'a>(
600 cg_results: &CodegenResults,
601 executable_out_filename: &Path,
603 let dwp_out_filename = executable_out_filename.with_extension("dwp");
604 debug!(?dwp_out_filename, ?executable_out_filename);
607 struct ThorinSession<Relocations> {
608 arena_data: TypedArena<Vec<u8>>,
609 arena_mmap: TypedArena<Mmap>,
610 arena_relocations: TypedArena<Relocations>,
613 impl<Relocations> ThorinSession<Relocations> {
614 fn alloc_mmap<'arena>(&'arena self, data: Mmap) -> &'arena Mmap {
615 (*self.arena_mmap.alloc(data)).borrow()
619 impl<Relocations> thorin::Session<Relocations> for ThorinSession<Relocations> {
620 fn alloc_data<'arena>(&'arena self, data: Vec<u8>) -> &'arena [u8] {
621 (*self.arena_data.alloc(data)).borrow()
624 fn alloc_relocation<'arena>(&'arena self, data: Relocations) -> &'arena Relocations {
625 (*self.arena_relocations.alloc(data)).borrow()
628 fn read_input<'arena>(&'arena self, path: &Path) -> std::io::Result<&'arena [u8]> {
629 let file = File::open(&path)?;
630 let mmap = (unsafe { Mmap::map(file) })?;
631 Ok(self.alloc_mmap(mmap))
635 match sess.time("run_thorin", || -> Result<(), thorin::Error> {
636 let thorin_sess = ThorinSession::default();
637 let mut package = thorin::DwarfPackage::new(&thorin_sess);
639 // Input objs contain .o/.dwo files from the current crate.
640 match sess.opts.unstable_opts.split_dwarf_kind {
641 SplitDwarfKind::Single => {
642 for input_obj in cg_results.modules.iter().filter_map(|m| m.object.as_ref()) {
643 package.add_input_object(input_obj)?;
646 SplitDwarfKind::Split => {
647 for input_obj in cg_results.modules.iter().filter_map(|m| m.dwarf_object.as_ref()) {
648 package.add_input_object(input_obj)?;
653 // Input rlibs contain .o/.dwo files from dependencies.
654 let input_rlibs = cg_results
658 .filter_map(|csource| csource.rlib.as_ref())
659 .map(|(path, _)| path);
660 for input_rlib in input_rlibs {
662 package.add_input_object(input_rlib)?;
665 // Failing to read the referenced objects is expected for dependencies where the path in the
666 // executable will have been cleaned by Cargo, but the referenced objects will be contained
667 // within rlibs provided as inputs.
669 // If paths have been remapped, then .o/.dwo files from the current crate also won't be
670 // found, but are provided explicitly above.
672 // Adding an executable is primarily done to make `thorin` check that all the referenced
673 // dwarf objects are found in the end.
674 package.add_executable(
675 &executable_out_filename,
676 thorin::MissingReferencedObjectBehaviour::Skip,
679 let output = package.finish()?.write()?;
680 let mut output_stream = BufWriter::new(
686 .open(dwp_out_filename)?,
688 output_stream.write_all(&output)?;
689 output_stream.flush()?;
695 sess.emit_err(errors::ThorinErrorWrapper(e));
696 sess.abort_if_errors();
701 /// Create a dynamic library or executable.
703 /// This will invoke the system linker/cc to create the resulting file. This links to all upstream
705 fn link_natively<'a>(
707 archive_builder_builder: &dyn ArchiveBuilderBuilder,
708 crate_type: CrateType,
710 codegen_results: &CodegenResults,
712 ) -> Result<(), ErrorGuaranteed> {
713 info!("preparing {:?} to {:?}", crate_type, out_filename);
714 let (linker_path, flavor) = linker_and_flavor(sess);
715 let mut cmd = linker_with_args(
719 archive_builder_builder,
726 linker::disable_localization(&mut cmd);
728 for &(ref k, ref v) in sess.target.link_env.as_ref() {
729 cmd.env(k.as_ref(), v.as_ref());
731 for k in sess.target.link_env_remove.as_ref() {
732 cmd.env_remove(k.as_ref());
735 if sess.opts.prints.contains(&PrintRequest::LinkArgs) {
736 println!("{:?}", &cmd);
739 // May have not found libraries in the right formats.
740 sess.abort_if_errors();
742 // Invoke the system linker
744 let retry_on_segfault = env::var("RUSTC_RETRY_LINKER_ON_SEGFAULT").is_ok();
745 let unknown_arg_regex =
746 Regex::new(r"(unknown|unrecognized) (command line )?(option|argument)").unwrap();
751 prog = sess.time("run_linker", || exec_linker(sess, &cmd, out_filename, tmpdir));
752 let Ok(ref output) = prog else {
755 if output.status.success() {
758 let mut out = output.stderr.clone();
759 out.extend(&output.stdout);
760 let out = String::from_utf8_lossy(&out);
762 // Check to see if the link failed with an error message that indicates it
763 // doesn't recognize the -no-pie option. If so, re-perform the link step
764 // without it. This is safe because if the linker doesn't support -no-pie
765 // then it should not default to linking executables as pie. Different
766 // versions of gcc seem to use different quotes in the error message so
767 // don't check for them.
768 if matches!(flavor, LinkerFlavor::Gnu(Cc::Yes, _))
769 && unknown_arg_regex.is_match(&out)
770 && out.contains("-no-pie")
771 && cmd.get_args().iter().any(|e| e.to_string_lossy() == "-no-pie")
773 info!("linker output: {:?}", out);
774 warn!("Linker does not support -no-pie command line option. Retrying without.");
775 for arg in cmd.take_args() {
776 if arg.to_string_lossy() != "-no-pie" {
784 // Detect '-static-pie' used with an older version of gcc or clang not supporting it.
785 // Fallback from '-static-pie' to '-static' in that case.
786 if matches!(flavor, LinkerFlavor::Gnu(Cc::Yes, _))
787 && unknown_arg_regex.is_match(&out)
788 && (out.contains("-static-pie") || out.contains("--no-dynamic-linker"))
789 && cmd.get_args().iter().any(|e| e.to_string_lossy() == "-static-pie")
791 info!("linker output: {:?}", out);
793 "Linker does not support -static-pie command line option. Retrying with -static instead."
795 // Mirror `add_(pre,post)_link_objects` to replace CRT objects.
796 let self_contained = self_contained(sess, crate_type);
797 let opts = &sess.target;
798 let pre_objects = if self_contained {
799 &opts.pre_link_objects_self_contained
801 &opts.pre_link_objects
803 let post_objects = if self_contained {
804 &opts.post_link_objects_self_contained
806 &opts.post_link_objects
808 let get_objects = |objects: &CrtObjects, kind| {
814 .map(|obj| get_object_file_path(sess, obj, self_contained).into_os_string())
817 let pre_objects_static_pie = get_objects(pre_objects, LinkOutputKind::StaticPicExe);
818 let post_objects_static_pie = get_objects(post_objects, LinkOutputKind::StaticPicExe);
819 let mut pre_objects_static = get_objects(pre_objects, LinkOutputKind::StaticNoPicExe);
820 let mut post_objects_static = get_objects(post_objects, LinkOutputKind::StaticNoPicExe);
821 // Assume that we know insertion positions for the replacement arguments from replaced
822 // arguments, which is true for all supported targets.
823 assert!(pre_objects_static.is_empty() || !pre_objects_static_pie.is_empty());
824 assert!(post_objects_static.is_empty() || !post_objects_static_pie.is_empty());
825 for arg in cmd.take_args() {
826 if arg.to_string_lossy() == "-static-pie" {
827 // Replace the output kind.
829 } else if pre_objects_static_pie.contains(&arg) {
830 // Replace the pre-link objects (replace the first and remove the rest).
831 cmd.args(mem::take(&mut pre_objects_static));
832 } else if post_objects_static_pie.contains(&arg) {
833 // Replace the post-link objects (replace the first and remove the rest).
834 cmd.args(mem::take(&mut post_objects_static));
843 // Here's a terribly awful hack that really shouldn't be present in any
844 // compiler. Here an environment variable is supported to automatically
845 // retry the linker invocation if the linker looks like it segfaulted.
847 // Gee that seems odd, normally segfaults are things we want to know
848 // about! Unfortunately though in rust-lang/rust#38878 we're
849 // experiencing the linker segfaulting on Travis quite a bit which is
850 // causing quite a bit of pain to land PRs when they spuriously fail
851 // due to a segfault.
853 // The issue #38878 has some more debugging information on it as well,
854 // but this unfortunately looks like it's just a race condition in
855 // macOS's linker with some thread pool working in the background. It
856 // seems that no one currently knows a fix for this so in the meantime
857 // we're left with this...
858 if !retry_on_segfault || i > 3 {
861 let msg_segv = "clang: error: unable to execute command: Segmentation fault: 11";
862 let msg_bus = "clang: error: unable to execute command: Bus error: 10";
863 if out.contains(msg_segv) || out.contains(msg_bus) {
866 "looks like the linker segfaulted when we tried to call it, \
867 automatically retrying again",
872 if is_illegal_instruction(&output.status) {
874 ?cmd, %out, status = %output.status,
875 "looks like the linker hit an illegal instruction when we \
876 tried to call it, automatically retrying again.",
882 fn is_illegal_instruction(status: &ExitStatus) -> bool {
883 use std::os::unix::prelude::*;
884 status.signal() == Some(libc::SIGILL)
888 fn is_illegal_instruction(_status: &ExitStatus) -> bool {
895 if !prog.status.success() {
896 let mut output = prog.stderr.clone();
897 output.extend_from_slice(&prog.stdout);
898 let escaped_output = escape_string(&output);
899 // FIXME: Add UI tests for this error.
900 let err = errors::LinkingFailed {
901 linker_path: &linker_path,
902 exit_status: prog.status,
904 escaped_output: &escaped_output,
906 sess.diagnostic().emit_err(err);
907 // If MSVC's `link.exe` was expected but the return code
908 // is not a Microsoft LNK error then suggest a way to fix or
909 // install the Visual Studio build tools.
910 if let Some(code) = prog.status.code() {
911 if sess.target.is_like_msvc
912 && flavor == LinkerFlavor::Msvc(Lld::No)
913 // Respect the command line override
914 && sess.opts.cg.linker.is_none()
915 // Match exactly "link.exe"
916 && linker_path.to_str() == Some("link.exe")
917 // All Microsoft `link.exe` linking error codes are
918 // four digit numbers in the range 1000 to 9999 inclusive
919 && (code < 1000 || code > 9999)
921 let is_vs_installed = windows_registry::find_vs_version().is_ok();
922 let has_linker = windows_registry::find_tool(
923 &sess.opts.target_triple.triple(),
928 sess.emit_note(errors::LinkExeUnexpectedError);
929 if is_vs_installed && has_linker {
930 // the linker is broken
931 sess.emit_note(errors::RepairVSBuildTools);
932 sess.emit_note(errors::MissingCppBuildToolComponent);
933 } else if is_vs_installed {
934 // the linker is not installed
935 sess.emit_note(errors::SelectCppBuildToolWorkload);
937 // visual studio is not installed
938 sess.emit_note(errors::VisualStudioNotInstalled);
943 sess.abort_if_errors();
945 info!("linker stderr:\n{}", escape_string(&prog.stderr));
946 info!("linker stdout:\n{}", escape_string(&prog.stdout));
949 let linker_not_found = e.kind() == io::ErrorKind::NotFound;
951 if linker_not_found {
952 sess.emit_err(errors::LinkerNotFound { linker_path, error: e });
954 sess.emit_err(errors::UnableToExeLinker {
957 command_formatted: format!("{:?}", &cmd),
961 if sess.target.is_like_msvc && linker_not_found {
962 sess.emit_note(errors::MsvcMissingLinker);
963 sess.emit_note(errors::CheckInstalledVisualStudio);
964 sess.emit_note(errors::UnsufficientVSCodeProduct);
966 sess.abort_if_errors();
970 match sess.split_debuginfo() {
971 // If split debug information is disabled or located in individual files
972 // there's nothing to do here.
973 SplitDebuginfo::Off | SplitDebuginfo::Unpacked => {}
975 // If packed split-debuginfo is requested, but the final compilation
976 // doesn't actually have any debug information, then we skip this step.
977 SplitDebuginfo::Packed if sess.opts.debuginfo == DebugInfo::None => {}
979 // On macOS the external `dsymutil` tool is used to create the packed
980 // debug information. Note that this will read debug information from
981 // the objects on the filesystem which we'll clean up later.
982 SplitDebuginfo::Packed if sess.target.is_like_osx => {
983 let prog = Command::new("dsymutil").arg(out_filename).output();
986 if !prog.status.success() {
987 let mut output = prog.stderr.clone();
988 output.extend_from_slice(&prog.stdout);
989 sess.emit_warning(errors::ProcessingDymutilFailed {
991 output: escape_string(&output),
995 Err(error) => sess.emit_fatal(errors::UnableToRunDsymutil { error }),
999 // On MSVC packed debug information is produced by the linker itself so
1000 // there's no need to do anything else here.
1001 SplitDebuginfo::Packed if sess.target.is_like_windows => {}
1003 // ... and otherwise we're processing a `*.dwp` packed dwarf file.
1005 // We cannot rely on the .o paths in the executable because they may have been
1006 // remapped by --remap-path-prefix and therefore invalid, so we need to provide
1007 // the .o/.dwo paths explicitly.
1008 SplitDebuginfo::Packed => link_dwarf_object(sess, codegen_results, out_filename),
1011 let strip = strip_value(sess);
1013 if sess.target.is_like_osx {
1014 match (strip, crate_type) {
1015 (Strip::Debuginfo, _) => {
1016 strip_symbols_with_external_utility(sess, "strip", &out_filename, Some("-S"))
1018 // Per the manpage, `-x` is the maximum safe strip level for dynamic libraries. (#93988)
1019 (Strip::Symbols, CrateType::Dylib | CrateType::Cdylib | CrateType::ProcMacro) => {
1020 strip_symbols_with_external_utility(sess, "strip", &out_filename, Some("-x"))
1022 (Strip::Symbols, _) => {
1023 strip_symbols_with_external_utility(sess, "strip", &out_filename, None)
1025 (Strip::None, _) => {}
1029 if sess.target.os == "illumos" {
1030 // Many illumos systems will have both the native 'strip' utility and
1031 // the GNU one. Use the native version explicitly and do not rely on
1032 // what's in the path.
1033 let stripcmd = "/usr/bin/strip";
1035 // Always preserve the symbol table (-x).
1036 Strip::Debuginfo => {
1037 strip_symbols_with_external_utility(sess, stripcmd, &out_filename, Some("-x"))
1039 // Strip::Symbols is handled via the --strip-all linker option.
1040 Strip::Symbols => {}
1048 // Temporarily support both -Z strip and -C strip
1049 fn strip_value(sess: &Session) -> Strip {
1050 match (sess.opts.unstable_opts.strip, sess.opts.cg.strip) {
1051 (s, Strip::None) => s,
1056 fn strip_symbols_with_external_utility<'a>(
1059 out_filename: &Path,
1060 option: Option<&str>,
1062 let mut cmd = Command::new(util);
1063 if let Some(option) = option {
1066 let prog = cmd.arg(out_filename).output();
1069 if !prog.status.success() {
1070 let mut output = prog.stderr.clone();
1071 output.extend_from_slice(&prog.stdout);
1072 sess.emit_warning(errors::StrippingDebugInfoFailed {
1074 status: prog.status,
1075 output: escape_string(&output),
1079 Err(error) => sess.emit_fatal(errors::UnableToRun { util, error }),
1083 fn escape_string(s: &[u8]) -> String {
1084 match str::from_utf8(s) {
1085 Ok(s) => s.to_owned(),
1086 Err(_) => format!("Non-UTF-8 output: {}", s.escape_ascii()),
1090 fn add_sanitizer_libraries(sess: &Session, crate_type: CrateType, linker: &mut dyn Linker) {
1091 // On macOS the runtimes are distributed as dylibs which should be linked to
1092 // both executables and dynamic shared objects. Everywhere else the runtimes
1093 // are currently distributed as static libraries which should be linked to
1094 // executables only.
1095 let needs_runtime = !sess.target.is_like_android
1096 && match crate_type {
1097 CrateType::Executable => true,
1098 CrateType::Dylib | CrateType::Cdylib | CrateType::ProcMacro => sess.target.is_like_osx,
1099 CrateType::Rlib | CrateType::Staticlib => false,
1106 let sanitizer = sess.opts.unstable_opts.sanitizer;
1107 if sanitizer.contains(SanitizerSet::ADDRESS) {
1108 link_sanitizer_runtime(sess, linker, "asan");
1110 if sanitizer.contains(SanitizerSet::LEAK) {
1111 link_sanitizer_runtime(sess, linker, "lsan");
1113 if sanitizer.contains(SanitizerSet::MEMORY) {
1114 link_sanitizer_runtime(sess, linker, "msan");
1116 if sanitizer.contains(SanitizerSet::THREAD) {
1117 link_sanitizer_runtime(sess, linker, "tsan");
1119 if sanitizer.contains(SanitizerSet::HWADDRESS) {
1120 link_sanitizer_runtime(sess, linker, "hwasan");
1124 fn link_sanitizer_runtime(sess: &Session, linker: &mut dyn Linker, name: &str) {
1125 fn find_sanitizer_runtime(sess: &Session, filename: &str) -> PathBuf {
1127 filesearch::make_target_lib_path(&sess.sysroot, sess.opts.target_triple.triple());
1128 let path = session_tlib.join(filename);
1130 return session_tlib;
1132 let default_sysroot =
1133 filesearch::get_or_default_sysroot().expect("Failed finding sysroot");
1134 let default_tlib = filesearch::make_target_lib_path(
1136 sess.opts.target_triple.triple(),
1138 return default_tlib;
1142 let channel = option_env!("CFG_RELEASE_CHANNEL")
1143 .map(|channel| format!("-{}", channel))
1144 .unwrap_or_default();
1146 if sess.target.is_like_osx {
1147 // On Apple platforms, the sanitizer is always built as a dylib, and
1148 // LLVM will link to `@rpath/*.dylib`, so we need to specify an
1149 // rpath to the library as well (the rpath should be absolute, see
1150 // PR #41352 for details).
1151 let filename = format!("rustc{}_rt.{}", channel, name);
1152 let path = find_sanitizer_runtime(&sess, &filename);
1153 let rpath = path.to_str().expect("non-utf8 component in path");
1154 linker.args(&["-Wl,-rpath", "-Xlinker", rpath]);
1155 linker.link_dylib(&filename, false, true);
1157 let filename = format!("librustc{}_rt.{}.a", channel, name);
1158 let path = find_sanitizer_runtime(&sess, &filename).join(&filename);
1159 linker.link_whole_rlib(&path);
1163 /// Returns a boolean indicating whether the specified crate should be ignored
1166 /// Crates ignored during LTO are not lumped together in the "massive object
1167 /// file" that we create and are linked in their normal rlib states. See
1168 /// comments below for what crates do not participate in LTO.
1170 /// It's unusual for a crate to not participate in LTO. Typically only
1171 /// compiler-specific and unstable crates have a reason to not participate in
1173 pub fn ignored_for_lto(sess: &Session, info: &CrateInfo, cnum: CrateNum) -> bool {
1174 // If our target enables builtin function lowering in LLVM then the
1175 // crates providing these functions don't participate in LTO (e.g.
1176 // no_builtins or compiler builtins crates).
1177 !sess.target.no_builtins
1178 && (info.compiler_builtins == Some(cnum) || info.is_no_builtins.contains(&cnum))
1181 // This functions tries to determine the appropriate linker (and corresponding LinkerFlavor) to use
1182 pub fn linker_and_flavor(sess: &Session) -> (PathBuf, LinkerFlavor) {
1185 linker: Option<PathBuf>,
1186 flavor: Option<LinkerFlavor>,
1187 ) -> Option<(PathBuf, LinkerFlavor)> {
1188 match (linker, flavor) {
1189 (Some(linker), Some(flavor)) => Some((linker, flavor)),
1190 // only the linker flavor is known; use the default linker for the selected flavor
1191 (None, Some(flavor)) => Some((
1192 PathBuf::from(match flavor {
1193 LinkerFlavor::Gnu(Cc::Yes, _)
1194 | LinkerFlavor::Darwin(Cc::Yes, _)
1195 | LinkerFlavor::WasmLld(Cc::Yes)
1196 | LinkerFlavor::Unix(Cc::Yes) => {
1197 if cfg!(any(target_os = "solaris", target_os = "illumos")) {
1198 // On historical Solaris systems, "cc" may have
1199 // been Sun Studio, which is not flag-compatible
1200 // with "gcc". This history casts a long shadow,
1201 // and many modern illumos distributions today
1202 // ship GCC as "gcc" without also making it
1203 // available as "cc".
1209 LinkerFlavor::Gnu(_, Lld::Yes)
1210 | LinkerFlavor::Darwin(_, Lld::Yes)
1211 | LinkerFlavor::WasmLld(..)
1212 | LinkerFlavor::Msvc(Lld::Yes) => "lld",
1213 LinkerFlavor::Gnu(..) | LinkerFlavor::Darwin(..) | LinkerFlavor::Unix(..) => {
1216 LinkerFlavor::Msvc(..) => "link.exe",
1217 LinkerFlavor::EmCc => {
1224 LinkerFlavor::Bpf => "bpf-linker",
1225 LinkerFlavor::Ptx => "rust-ptx-linker",
1229 (Some(linker), None) => {
1230 let stem = linker.file_stem().and_then(|stem| stem.to_str()).unwrap_or_else(|| {
1231 sess.emit_fatal(errors::LinkerFileStem);
1234 let flavor = if stem == "emcc" {
1236 } else if stem == "gcc"
1237 || stem.ends_with("-gcc")
1239 || stem.ends_with("-clang")
1241 LinkerFlavor::from_cli(LinkerFlavorCli::Gcc, &sess.target)
1242 } else if stem == "wasm-ld" || stem.ends_with("-wasm-ld") {
1243 LinkerFlavor::WasmLld(Cc::No)
1244 } else if stem == "ld" || stem.ends_with("-ld") {
1245 LinkerFlavor::from_cli(LinkerFlavorCli::Ld, &sess.target)
1246 } else if stem == "ld.lld" {
1247 LinkerFlavor::Gnu(Cc::No, Lld::Yes)
1248 } else if stem == "link" {
1249 LinkerFlavor::Msvc(Lld::No)
1250 } else if stem == "lld-link" {
1251 LinkerFlavor::Msvc(Lld::Yes)
1252 } else if stem == "lld" || stem == "rust-lld" {
1253 let lld_flavor = sess.target.linker_flavor.lld_flavor();
1254 LinkerFlavor::from_cli(LinkerFlavorCli::Lld(lld_flavor), &sess.target)
1256 // fall back to the value in the target spec
1257 sess.target.linker_flavor
1260 Some((linker, flavor))
1262 (None, None) => None,
1266 // linker and linker flavor specified via command line have precedence over what the target
1267 // specification specifies
1269 sess.opts.cg.linker_flavor.map(|flavor| LinkerFlavor::from_cli(flavor, &sess.target));
1270 if let Some(ret) = infer_from(sess, sess.opts.cg.linker.clone(), linker_flavor) {
1274 if let Some(ret) = infer_from(
1276 sess.target.linker.as_deref().map(PathBuf::from),
1277 Some(sess.target.linker_flavor),
1282 bug!("Not enough information provided to determine how to invoke the linker");
1285 /// Returns a pair of boolean indicating whether we should preserve the object and
1286 /// dwarf object files on the filesystem for their debug information. This is often
1287 /// useful with split-dwarf like schemes.
1288 fn preserve_objects_for_their_debuginfo(sess: &Session) -> (bool, bool) {
1289 // If the objects don't have debuginfo there's nothing to preserve.
1290 if sess.opts.debuginfo == config::DebugInfo::None {
1291 return (false, false);
1294 // If we're only producing artifacts that are archives, no need to preserve
1295 // the objects as they're losslessly contained inside the archives.
1296 if sess.crate_types().iter().all(|&x| x.is_archive()) {
1297 return (false, false);
1300 match (sess.split_debuginfo(), sess.opts.unstable_opts.split_dwarf_kind) {
1301 // If there is no split debuginfo then do not preserve objects.
1302 (SplitDebuginfo::Off, _) => (false, false),
1303 // If there is packed split debuginfo, then the debuginfo in the objects
1304 // has been packaged and the objects can be deleted.
1305 (SplitDebuginfo::Packed, _) => (false, false),
1306 // If there is unpacked split debuginfo and the current target can not use
1307 // split dwarf, then keep objects.
1308 (SplitDebuginfo::Unpacked, _) if !sess.target_can_use_split_dwarf() => (true, false),
1309 // If there is unpacked split debuginfo and the target can use split dwarf, then
1310 // keep the object containing that debuginfo (whether that is an object file or
1311 // dwarf object file depends on the split dwarf kind).
1312 (SplitDebuginfo::Unpacked, SplitDwarfKind::Single) => (true, false),
1313 (SplitDebuginfo::Unpacked, SplitDwarfKind::Split) => (false, true),
1317 fn archive_search_paths(sess: &Session) -> Vec<PathBuf> {
1318 sess.target_filesearch(PathKind::Native).search_path_dirs()
1321 #[derive(PartialEq)]
1327 fn print_native_static_libs(sess: &Session, all_native_libs: &[NativeLib]) {
1328 let lib_args: Vec<_> = all_native_libs
1330 .filter(|l| relevant_lib(sess, l))
1332 let name = lib.name?;
1334 NativeLibKind::Static { bundle: Some(false), .. }
1335 | NativeLibKind::Dylib { .. }
1336 | NativeLibKind::Unspecified => {
1337 let verbatim = lib.verbatim.unwrap_or(false);
1338 if sess.target.is_like_msvc {
1339 Some(format!("{}{}", name, if verbatim { "" } else { ".lib" }))
1340 } else if sess.target.linker_flavor.is_gnu() {
1341 Some(format!("-l{}{}", if verbatim { ":" } else { "" }, name))
1343 Some(format!("-l{}", name))
1346 NativeLibKind::Framework { .. } => {
1347 // ld-only syntax, since there are no frameworks in MSVC
1348 Some(format!("-framework {}", name))
1350 // These are included, no need to print them
1351 NativeLibKind::Static { bundle: None | Some(true), .. }
1352 | NativeLibKind::LinkArg
1353 | NativeLibKind::RawDylib => None,
1357 if !lib_args.is_empty() {
1358 sess.emit_note(errors::StaticLibraryNativeArtifacts);
1359 // Prefix for greppability
1360 sess.emit_note(errors::NativeStaticLibs { arguments: lib_args.join(" ") });
1364 fn get_object_file_path(sess: &Session, name: &str, self_contained: bool) -> PathBuf {
1365 let fs = sess.target_filesearch(PathKind::Native);
1366 let file_path = fs.get_lib_path().join(name);
1367 if file_path.exists() {
1370 // Special directory with objects used only in self-contained linkage mode
1372 let file_path = fs.get_self_contained_lib_path().join(name);
1373 if file_path.exists() {
1377 for search_path in fs.search_paths() {
1378 let file_path = search_path.dir.join(name);
1379 if file_path.exists() {
1389 out_filename: &Path,
1391 ) -> io::Result<Output> {
1392 // When attempting to spawn the linker we run a risk of blowing out the
1393 // size limits for spawning a new process with respect to the arguments
1394 // we pass on the command line.
1396 // Here we attempt to handle errors from the OS saying "your list of
1397 // arguments is too big" by reinvoking the linker again with an `@`-file
1398 // that contains all the arguments. The theory is that this is then
1399 // accepted on all linkers and the linker will read all its options out of
1400 // there instead of looking at the command line.
1401 if !cmd.very_likely_to_exceed_some_spawn_limit() {
1402 match cmd.command().stdout(Stdio::piped()).stderr(Stdio::piped()).spawn() {
1404 let output = child.wait_with_output();
1405 flush_linked_file(&output, out_filename)?;
1408 Err(ref e) if command_line_too_big(e) => {
1409 info!("command line to linker was too big: {}", e);
1411 Err(e) => return Err(e),
1415 info!("falling back to passing arguments to linker via an @-file");
1416 let mut cmd2 = cmd.clone();
1417 let mut args = String::new();
1418 for arg in cmd2.take_args() {
1420 &Escape { arg: arg.to_str().unwrap(), is_like_msvc: sess.target.is_like_msvc }
1425 let file = tmpdir.join("linker-arguments");
1426 let bytes = if sess.target.is_like_msvc {
1427 let mut out = Vec::with_capacity((1 + args.len()) * 2);
1428 // start the stream with a UTF-16 BOM
1429 for c in std::iter::once(0xFEFF).chain(args.encode_utf16()) {
1430 // encode in little endian
1432 out.push((c >> 8) as u8);
1438 fs::write(&file, &bytes)?;
1439 cmd2.arg(format!("@{}", file.display()));
1440 info!("invoking linker {:?}", cmd2);
1441 let output = cmd2.output();
1442 flush_linked_file(&output, out_filename)?;
1445 #[cfg(not(windows))]
1446 fn flush_linked_file(_: &io::Result<Output>, _: &Path) -> io::Result<()> {
1451 fn flush_linked_file(
1452 command_output: &io::Result<Output>,
1453 out_filename: &Path,
1454 ) -> io::Result<()> {
1455 // On Windows, under high I/O load, output buffers are sometimes not flushed,
1456 // even long after process exit, causing nasty, non-reproducible output bugs.
1458 // File::sync_all() calls FlushFileBuffers() down the line, which solves the problem.
1460 // А full writeup of the original Chrome bug can be found at
1461 // randomascii.wordpress.com/2018/02/25/compiler-bug-linker-bug-windows-kernel-bug/amp
1463 if let &Ok(ref out) = command_output {
1464 if out.status.success() {
1465 if let Ok(of) = fs::OpenOptions::new().write(true).open(out_filename) {
1475 fn command_line_too_big(err: &io::Error) -> bool {
1476 err.raw_os_error() == Some(::libc::E2BIG)
1480 fn command_line_too_big(err: &io::Error) -> bool {
1481 const ERROR_FILENAME_EXCED_RANGE: i32 = 206;
1482 err.raw_os_error() == Some(ERROR_FILENAME_EXCED_RANGE)
1485 #[cfg(not(any(unix, windows)))]
1486 fn command_line_too_big(_: &io::Error) -> bool {
1495 impl<'a> fmt::Display for Escape<'a> {
1496 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1497 if self.is_like_msvc {
1498 // This is "documented" at
1499 // https://docs.microsoft.com/en-us/cpp/build/reference/at-specify-a-linker-response-file
1501 // Unfortunately there's not a great specification of the
1502 // syntax I could find online (at least) but some local
1503 // testing showed that this seemed sufficient-ish to catch
1504 // at least a few edge cases.
1506 for c in self.arg.chars() {
1508 '"' => write!(f, "\\{}", c)?,
1509 c => write!(f, "{}", c)?,
1514 // This is documented at https://linux.die.net/man/1/ld, namely:
1516 // > Options in file are separated by whitespace. A whitespace
1517 // > character may be included in an option by surrounding the
1518 // > entire option in either single or double quotes. Any
1519 // > character (including a backslash) may be included by
1520 // > prefixing the character to be included with a backslash.
1522 // We put an argument on each line, so all we need to do is
1523 // ensure the line is interpreted as one whole argument.
1524 for c in self.arg.chars() {
1526 '\\' | ' ' => write!(f, "\\{}", c)?,
1527 c => write!(f, "{}", c)?,
1536 fn link_output_kind(sess: &Session, crate_type: CrateType) -> LinkOutputKind {
1537 let kind = match (crate_type, sess.crt_static(Some(crate_type)), sess.relocation_model()) {
1538 (CrateType::Executable, _, _) if sess.is_wasi_reactor() => LinkOutputKind::WasiReactorExe,
1539 (CrateType::Executable, false, RelocModel::Pic | RelocModel::Pie) => {
1540 LinkOutputKind::DynamicPicExe
1542 (CrateType::Executable, false, _) => LinkOutputKind::DynamicNoPicExe,
1543 (CrateType::Executable, true, RelocModel::Pic | RelocModel::Pie) => {
1544 LinkOutputKind::StaticPicExe
1546 (CrateType::Executable, true, _) => LinkOutputKind::StaticNoPicExe,
1547 (_, true, _) => LinkOutputKind::StaticDylib,
1548 (_, false, _) => LinkOutputKind::DynamicDylib,
1551 // Adjust the output kind to target capabilities.
1552 let opts = &sess.target;
1553 let pic_exe_supported = opts.position_independent_executables;
1554 let static_pic_exe_supported = opts.static_position_independent_executables;
1555 let static_dylib_supported = opts.crt_static_allows_dylibs;
1557 LinkOutputKind::DynamicPicExe if !pic_exe_supported => LinkOutputKind::DynamicNoPicExe,
1558 LinkOutputKind::StaticPicExe if !static_pic_exe_supported => LinkOutputKind::StaticNoPicExe,
1559 LinkOutputKind::StaticDylib if !static_dylib_supported => LinkOutputKind::DynamicDylib,
1564 // Returns true if linker is located within sysroot
1565 fn detect_self_contained_mingw(sess: &Session) -> bool {
1566 let (linker, _) = linker_and_flavor(&sess);
1567 // Assume `-C linker=rust-lld` as self-contained mode
1568 if linker == Path::new("rust-lld") {
1571 let linker_with_extension = if cfg!(windows) && linker.extension().is_none() {
1572 linker.with_extension("exe")
1576 for dir in env::split_paths(&env::var_os("PATH").unwrap_or_default()) {
1577 let full_path = dir.join(&linker_with_extension);
1578 // If linker comes from sysroot assume self-contained mode
1579 if full_path.is_file() && !full_path.starts_with(&sess.sysroot) {
1586 /// Various toolchain components used during linking are used from rustc distribution
1587 /// instead of being found somewhere on the host system.
1588 /// We only provide such support for a very limited number of targets.
1589 fn self_contained(sess: &Session, crate_type: CrateType) -> bool {
1590 if let Some(self_contained) = sess.opts.cg.link_self_contained {
1591 return self_contained;
1594 match sess.target.link_self_contained {
1595 LinkSelfContainedDefault::False => false,
1596 LinkSelfContainedDefault::True => true,
1597 // FIXME: Find a better heuristic for "native musl toolchain is available",
1598 // based on host and linker path, for example.
1599 // (https://github.com/rust-lang/rust/pull/71769#issuecomment-626330237).
1600 LinkSelfContainedDefault::Musl => sess.crt_static(Some(crate_type)),
1601 LinkSelfContainedDefault::Mingw => {
1602 sess.host == sess.target
1603 && sess.target.vendor != "uwp"
1604 && detect_self_contained_mingw(&sess)
1609 /// Add pre-link object files defined by the target spec.
1610 fn add_pre_link_objects(
1611 cmd: &mut dyn Linker,
1613 flavor: LinkerFlavor,
1614 link_output_kind: LinkOutputKind,
1615 self_contained: bool,
1617 // FIXME: we are currently missing some infra here (per-linker-flavor CRT objects),
1618 // so Fuchsia has to be special-cased.
1619 let opts = &sess.target;
1620 let empty = Default::default();
1621 let objects = if self_contained {
1622 &opts.pre_link_objects_self_contained
1623 } else if !(sess.target.os == "fuchsia" && matches!(flavor, LinkerFlavor::Gnu(Cc::Yes, _))) {
1624 &opts.pre_link_objects
1628 for obj in objects.get(&link_output_kind).iter().copied().flatten() {
1629 cmd.add_object(&get_object_file_path(sess, obj, self_contained));
1633 /// Add post-link object files defined by the target spec.
1634 fn add_post_link_objects(
1635 cmd: &mut dyn Linker,
1637 link_output_kind: LinkOutputKind,
1638 self_contained: bool,
1640 let objects = if self_contained {
1641 &sess.target.post_link_objects_self_contained
1643 &sess.target.post_link_objects
1645 for obj in objects.get(&link_output_kind).iter().copied().flatten() {
1646 cmd.add_object(&get_object_file_path(sess, obj, self_contained));
1650 /// Add arbitrary "pre-link" args defined by the target spec or from command line.
1651 /// FIXME: Determine where exactly these args need to be inserted.
1652 fn add_pre_link_args(cmd: &mut dyn Linker, sess: &Session, flavor: LinkerFlavor) {
1653 if let Some(args) = sess.target.pre_link_args.get(&flavor) {
1654 cmd.args(args.iter().map(Deref::deref));
1656 cmd.args(&sess.opts.unstable_opts.pre_link_args);
1659 /// Add a link script embedded in the target, if applicable.
1660 fn add_link_script(cmd: &mut dyn Linker, sess: &Session, tmpdir: &Path, crate_type: CrateType) {
1661 match (crate_type, &sess.target.link_script) {
1662 (CrateType::Cdylib | CrateType::Executable, Some(script)) => {
1663 if !sess.target.linker_flavor.is_gnu() {
1664 sess.emit_fatal(errors::LinkScriptUnavailable);
1667 let file_name = ["rustc", &sess.target.llvm_target, "linkfile.ld"].join("-");
1669 let path = tmpdir.join(file_name);
1670 if let Err(error) = fs::write(&path, script.as_ref()) {
1671 sess.emit_fatal(errors::LinkScriptWriteFailure { path, error });
1674 cmd.arg("--script");
1681 /// Add arbitrary "user defined" args defined from command line.
1682 /// FIXME: Determine where exactly these args need to be inserted.
1683 fn add_user_defined_link_args(cmd: &mut dyn Linker, sess: &Session) {
1684 cmd.args(&sess.opts.cg.link_args);
1687 /// Add arbitrary "late link" args defined by the target spec.
1688 /// FIXME: Determine where exactly these args need to be inserted.
1689 fn add_late_link_args(
1690 cmd: &mut dyn Linker,
1692 flavor: LinkerFlavor,
1693 crate_type: CrateType,
1694 codegen_results: &CodegenResults,
1696 let any_dynamic_crate = crate_type == CrateType::Dylib
1697 || codegen_results.crate_info.dependency_formats.iter().any(|(ty, list)| {
1698 *ty == crate_type && list.iter().any(|&linkage| linkage == Linkage::Dynamic)
1700 if any_dynamic_crate {
1701 if let Some(args) = sess.target.late_link_args_dynamic.get(&flavor) {
1702 cmd.args(args.iter().map(Deref::deref));
1705 if let Some(args) = sess.target.late_link_args_static.get(&flavor) {
1706 cmd.args(args.iter().map(Deref::deref));
1709 if let Some(args) = sess.target.late_link_args.get(&flavor) {
1710 cmd.args(args.iter().map(Deref::deref));
1714 /// Add arbitrary "post-link" args defined by the target spec.
1715 /// FIXME: Determine where exactly these args need to be inserted.
1716 fn add_post_link_args(cmd: &mut dyn Linker, sess: &Session, flavor: LinkerFlavor) {
1717 if let Some(args) = sess.target.post_link_args.get(&flavor) {
1718 cmd.args(args.iter().map(Deref::deref));
1722 /// Add a synthetic object file that contains reference to all symbols that we want to expose to
1725 /// Background: we implement rlibs as static library (archives). Linkers treat archives
1726 /// differently from object files: all object files participate in linking, while archives will
1727 /// only participate in linking if they can satisfy at least one undefined reference (version
1728 /// scripts doesn't count). This causes `#[no_mangle]` or `#[used]` items to be ignored by the
1729 /// linker, and since they never participate in the linking, using `KEEP` in the linker scripts
1730 /// can't keep them either. This causes #47384.
1732 /// To keep them around, we could use `--whole-archive` and equivalents to force rlib to
1733 /// participate in linking like object files, but this proves to be expensive (#93791). Therefore
1734 /// we instead just introduce an undefined reference to them. This could be done by `-u` command
1735 /// line option to the linker or `EXTERN(...)` in linker scripts, however they does not only
1736 /// introduce an undefined reference, but also make them the GC roots, preventing `--gc-sections`
1737 /// from removing them, and this is especially problematic for embedded programming where every
1740 /// This method creates a synthetic object file, which contains undefined references to all symbols
1741 /// that are necessary for the linking. They are only present in symbol table but not actually
1742 /// used in any sections, so the linker will therefore pick relevant rlibs for linking, but
1743 /// unused `#[no_mangle]` or `#[used]` can still be discard by GC sections.
1745 /// There's a few internal crates in the standard library (aka libcore and
1746 /// libstd) which actually have a circular dependence upon one another. This
1747 /// currently arises through "weak lang items" where libcore requires things
1748 /// like `rust_begin_unwind` but libstd ends up defining it. To get this
1749 /// circular dependence to work correctly we declare some of these things
1750 /// in this synthetic object.
1751 fn add_linked_symbol_object(
1752 cmd: &mut dyn Linker,
1755 symbols: &[(String, SymbolExportKind)],
1757 if symbols.is_empty() {
1761 let Some(mut file) = super::metadata::create_object_file(sess) else {
1765 // NOTE(nbdd0121): MSVC will hang if the input object file contains no sections,
1766 // so add an empty section.
1767 if file.format() == object::BinaryFormat::Coff {
1768 file.add_section(Vec::new(), ".text".into(), object::SectionKind::Text);
1770 // We handle the name decoration of COFF targets in `symbol_export.rs`, so disable the
1771 // default mangler in `object` crate.
1772 file.set_mangling(object::write::Mangling::None);
1774 // Add feature flags to the object file. On MSVC this is optional but LLD will complain if
1776 let mut feature = 0;
1778 if file.architecture() == object::Architecture::I386 {
1779 // Indicate that all SEH handlers are registered in .sxdata section.
1780 // We don't have generate any code, so we don't need .sxdata section but LLD still
1781 // expects us to set this bit (see #96498).
1782 // Reference: https://docs.microsoft.com/en-us/windows/win32/debug/pe-format
1786 file.add_symbol(object::write::Symbol {
1787 name: "@feat.00".into(),
1790 kind: object::SymbolKind::Data,
1791 scope: object::SymbolScope::Compilation,
1793 section: object::write::SymbolSection::Absolute,
1794 flags: object::SymbolFlags::None,
1798 for (sym, kind) in symbols.iter() {
1799 file.add_symbol(object::write::Symbol {
1800 name: sym.clone().into(),
1804 SymbolExportKind::Text => object::SymbolKind::Text,
1805 SymbolExportKind::Data => object::SymbolKind::Data,
1806 SymbolExportKind::Tls => object::SymbolKind::Tls,
1808 scope: object::SymbolScope::Unknown,
1810 section: object::write::SymbolSection::Undefined,
1811 flags: object::SymbolFlags::None,
1815 let path = tmpdir.join("symbols.o");
1816 let result = std::fs::write(&path, file.write().unwrap());
1817 if let Err(error) = result {
1818 sess.emit_fatal(errors::FailedToWrite { path, error });
1820 cmd.add_object(&path);
1823 /// Add object files containing code from the current crate.
1824 fn add_local_crate_regular_objects(cmd: &mut dyn Linker, codegen_results: &CodegenResults) {
1825 for obj in codegen_results.modules.iter().filter_map(|m| m.object.as_ref()) {
1826 cmd.add_object(obj);
1830 /// Add object files for allocator code linked once for the whole crate tree.
1831 fn add_local_crate_allocator_objects(cmd: &mut dyn Linker, codegen_results: &CodegenResults) {
1832 if let Some(obj) = codegen_results.allocator_module.as_ref().and_then(|m| m.object.as_ref()) {
1833 cmd.add_object(obj);
1837 /// Add object files containing metadata for the current crate.
1838 fn add_local_crate_metadata_objects(
1839 cmd: &mut dyn Linker,
1840 crate_type: CrateType,
1841 codegen_results: &CodegenResults,
1843 // When linking a dynamic library, we put the metadata into a section of the
1844 // executable. This metadata is in a separate object file from the main
1845 // object file, so we link that in here.
1846 if crate_type == CrateType::Dylib || crate_type == CrateType::ProcMacro {
1847 if let Some(obj) = codegen_results.metadata_module.as_ref().and_then(|m| m.object.as_ref())
1849 cmd.add_object(obj);
1854 /// Add sysroot and other globally set directories to the directory search list.
1855 fn add_library_search_dirs(cmd: &mut dyn Linker, sess: &Session, self_contained: bool) {
1856 // The default library location, we need this to find the runtime.
1857 // The location of crates will be determined as needed.
1858 let lib_path = sess.target_filesearch(PathKind::All).get_lib_path();
1859 cmd.include_path(&fix_windows_verbatim_for_gcc(&lib_path));
1861 // Special directory with libraries used only in self-contained linkage mode
1863 let lib_path = sess.target_filesearch(PathKind::All).get_self_contained_lib_path();
1864 cmd.include_path(&fix_windows_verbatim_for_gcc(&lib_path));
1868 /// Add options making relocation sections in the produced ELF files read-only
1869 /// and suppressing lazy binding.
1870 fn add_relro_args(cmd: &mut dyn Linker, sess: &Session) {
1871 match sess.opts.unstable_opts.relro_level.unwrap_or(sess.target.relro_level) {
1872 RelroLevel::Full => cmd.full_relro(),
1873 RelroLevel::Partial => cmd.partial_relro(),
1874 RelroLevel::Off => cmd.no_relro(),
1875 RelroLevel::None => {}
1879 /// Add library search paths used at runtime by dynamic linkers.
1881 cmd: &mut dyn Linker,
1883 codegen_results: &CodegenResults,
1884 out_filename: &Path,
1886 // FIXME (#2397): At some point we want to rpath our guesses as to
1887 // where extern libraries might live, based on the
1888 // add_lib_search_paths
1889 if sess.opts.cg.rpath {
1890 let libs = codegen_results
1894 .filter_map(|cnum| {
1895 codegen_results.crate_info.used_crate_source[cnum]
1898 .map(|(path, _)| &**path)
1900 .collect::<Vec<_>>();
1901 let mut rpath_config = RPathConfig {
1903 out_filename: out_filename.to_path_buf(),
1904 has_rpath: sess.target.has_rpath,
1905 is_like_osx: sess.target.is_like_osx,
1906 linker_is_gnu: sess.target.linker_flavor.is_gnu(),
1908 cmd.args(&rpath::get_rpath_flags(&mut rpath_config));
1912 /// Produce the linker command line containing linker path and arguments.
1914 /// When comments in the function say "order-(in)dependent" they mean order-dependence between
1915 /// options and libraries/object files. For example `--whole-archive` (order-dependent) applies
1916 /// to specific libraries passed after it, and `-o` (output file, order-independent) applies
1917 /// to the linking process as a whole.
1918 /// Order-independent options may still override each other in order-dependent fashion,
1919 /// e.g `--foo=yes --foo=no` may be equivalent to `--foo=no`.
1920 fn linker_with_args<'a>(
1922 flavor: LinkerFlavor,
1924 archive_builder_builder: &dyn ArchiveBuilderBuilder,
1925 crate_type: CrateType,
1927 out_filename: &Path,
1928 codegen_results: &CodegenResults,
1929 ) -> Result<Command, ErrorGuaranteed> {
1930 let self_contained = self_contained(sess, crate_type);
1931 let cmd = &mut *super::linker::get_linker(
1936 &codegen_results.crate_info.target_cpu,
1938 let link_output_kind = link_output_kind(sess, crate_type);
1940 // ------------ Early order-dependent options ------------
1942 // If we're building something like a dynamic library then some platforms
1943 // need to make sure that all symbols are exported correctly from the
1945 // Must be passed before any libraries to prevent the symbols to export from being thrown away,
1946 // at least on some platforms (e.g. windows-gnu).
1950 &codegen_results.crate_info.exported_symbols[&crate_type],
1953 // Can be used for adding custom CRT objects or overriding order-dependent options above.
1954 // FIXME: In practice built-in target specs use this for arbitrary order-independent options,
1955 // introduce a target spec option for order-independent linker options and migrate built-in
1957 add_pre_link_args(cmd, sess, flavor);
1959 // ------------ Object code and libraries, order-dependent ------------
1961 // Pre-link CRT objects.
1962 add_pre_link_objects(cmd, sess, flavor, link_output_kind, self_contained);
1964 add_linked_symbol_object(
1968 &codegen_results.crate_info.linked_symbols[&crate_type],
1971 // Sanitizer libraries.
1972 add_sanitizer_libraries(sess, crate_type, cmd);
1974 // Object code from the current crate.
1975 // Take careful note of the ordering of the arguments we pass to the linker
1976 // here. Linkers will assume that things on the left depend on things to the
1977 // right. Things on the right cannot depend on things on the left. This is
1978 // all formally implemented in terms of resolving symbols (libs on the right
1979 // resolve unknown symbols of libs on the left, but not vice versa).
1981 // For this reason, we have organized the arguments we pass to the linker as
1984 // 1. The local object that LLVM just generated
1985 // 2. Local native libraries
1986 // 3. Upstream rust libraries
1987 // 4. Upstream native libraries
1989 // The rationale behind this ordering is that those items lower down in the
1990 // list can't depend on items higher up in the list. For example nothing can
1991 // depend on what we just generated (e.g., that'd be a circular dependency).
1992 // Upstream rust libraries are not supposed to depend on our local native
1993 // libraries as that would violate the structure of the DAG, in that
1994 // scenario they are required to link to them as well in a shared fashion.
1996 // Note that upstream rust libraries may contain native dependencies as
1997 // well, but they also can't depend on what we just started to add to the
1998 // link line. And finally upstream native libraries can't depend on anything
1999 // in this DAG so far because they can only depend on other native libraries
2000 // and such dependencies are also required to be specified.
2001 add_local_crate_regular_objects(cmd, codegen_results);
2002 add_local_crate_metadata_objects(cmd, crate_type, codegen_results);
2003 add_local_crate_allocator_objects(cmd, codegen_results);
2005 // Avoid linking to dynamic libraries unless they satisfy some undefined symbols
2006 // at the point at which they are specified on the command line.
2007 // Must be passed before any (dynamic) libraries to have effect on them.
2008 // On Solaris-like systems, `-z ignore` acts as both `--as-needed` and `--gc-sections`
2009 // so it will ignore unreferenced ELF sections from relocatable objects.
2010 // For that reason, we put this flag after metadata objects as they would otherwise be removed.
2011 // FIXME: Support more fine-grained dead code removal on Solaris/illumos
2012 // and move this option back to the top.
2013 cmd.add_as_needed();
2015 // Local native libraries of all kinds.
2016 add_local_native_libraries(cmd, sess, archive_builder_builder, codegen_results, tmpdir);
2018 // Upstream rust crates and their non-dynamic native libraries.
2019 add_upstream_rust_crates(
2022 archive_builder_builder,
2028 // Dynamic native libraries from upstream crates.
2029 add_upstream_native_libraries(cmd, sess, archive_builder_builder, codegen_results, tmpdir);
2031 // Link with the import library generated for any raw-dylib functions.
2032 for (raw_dylib_name, raw_dylib_imports) in
2033 collate_raw_dylibs(sess, codegen_results.crate_info.used_libraries.iter())?
2035 cmd.add_object(&archive_builder_builder.create_dll_import_lib(
2043 // As with add_upstream_native_libraries, we need to add the upstream raw-dylib symbols in case
2044 // they are used within inlined functions or instantiated generic functions. We do this *after*
2045 // handling the raw-dylib symbols in the current crate to make sure that those are chosen first
2047 let (_, dependency_linkage) = codegen_results
2051 .find(|(ty, _)| *ty == crate_type)
2052 .expect("failed to find crate type in dependency format list");
2053 let native_libraries_from_nonstatics = codegen_results
2057 .filter_map(|(cnum, libraries)| {
2058 (dependency_linkage[cnum.as_usize() - 1] != Linkage::Static).then(|| libraries)
2061 for (raw_dylib_name, raw_dylib_imports) in
2062 collate_raw_dylibs(sess, native_libraries_from_nonstatics)?
2064 cmd.add_object(&archive_builder_builder.create_dll_import_lib(
2073 // Library linking above uses some global state for things like `-Bstatic`/`-Bdynamic` to make
2074 // command line shorter, reset it to default here before adding more libraries.
2075 cmd.reset_per_library_state();
2077 // FIXME: Built-in target specs occasionally use this for linking system libraries,
2078 // eliminate all such uses by migrating them to `#[link]` attributes in `lib(std,c,unwind)`
2079 // and remove the option.
2080 add_late_link_args(cmd, sess, flavor, crate_type, codegen_results);
2082 // ------------ Arbitrary order-independent options ------------
2084 // Add order-independent options determined by rustc from its compiler options,
2085 // target properties and source code.
2086 add_order_independent_options(
2098 // Can be used for arbitrary order-independent options.
2099 // In practice may also be occasionally used for linking native libraries.
2100 // Passed after compiler-generated options to support manual overriding when necessary.
2101 add_user_defined_link_args(cmd, sess);
2103 // ------------ Object code and libraries, order-dependent ------------
2105 // Post-link CRT objects.
2106 add_post_link_objects(cmd, sess, link_output_kind, self_contained);
2108 // ------------ Late order-dependent options ------------
2110 // Doesn't really make sense.
2111 // FIXME: In practice built-in target specs use this for arbitrary order-independent options,
2112 // introduce a target spec option for order-independent linker options, migrate built-in specs
2113 // to it and remove the option.
2114 add_post_link_args(cmd, sess, flavor);
2119 fn add_order_independent_options(
2120 cmd: &mut dyn Linker,
2122 link_output_kind: LinkOutputKind,
2123 self_contained: bool,
2124 flavor: LinkerFlavor,
2125 crate_type: CrateType,
2126 codegen_results: &CodegenResults,
2127 out_filename: &Path,
2130 add_gcc_ld_path(cmd, sess, flavor);
2132 add_apple_sdk(cmd, sess, flavor);
2134 add_link_script(cmd, sess, tmpdir, crate_type);
2136 if sess.target.os == "fuchsia"
2137 && crate_type == CrateType::Executable
2138 && !matches!(flavor, LinkerFlavor::Gnu(Cc::Yes, _))
2140 let prefix = if sess.opts.unstable_opts.sanitizer.contains(SanitizerSet::ADDRESS) {
2145 cmd.arg(format!("--dynamic-linker={}ld.so.1", prefix));
2148 if sess.target.eh_frame_header {
2149 cmd.add_eh_frame_header();
2152 // Make the binary compatible with data execution prevention schemes.
2156 cmd.no_crt_objects();
2159 if sess.target.os == "emscripten" {
2161 cmd.arg(if sess.panic_strategy() == PanicStrategy::Abort {
2162 "DISABLE_EXCEPTION_CATCHING=1"
2164 "DISABLE_EXCEPTION_CATCHING=0"
2168 if flavor == LinkerFlavor::Ptx {
2169 // Provide the linker with fallback to internal `target-cpu`.
2170 cmd.arg("--fallback-arch");
2171 cmd.arg(&codegen_results.crate_info.target_cpu);
2172 } else if flavor == LinkerFlavor::Bpf {
2174 cmd.arg(&codegen_results.crate_info.target_cpu);
2175 cmd.arg("--cpu-features");
2176 cmd.arg(match &sess.opts.cg.target_feature {
2177 feat if !feat.is_empty() => feat.as_ref(),
2178 _ => sess.target.options.features.as_ref(),
2182 cmd.linker_plugin_lto();
2184 add_library_search_dirs(cmd, sess, self_contained);
2186 cmd.output_filename(out_filename);
2188 if crate_type == CrateType::Executable && sess.target.is_like_windows {
2189 if let Some(ref s) = codegen_results.crate_info.windows_subsystem {
2194 // Try to strip as much out of the generated object by removing unused
2195 // sections if possible. See more comments in linker.rs
2196 if !sess.link_dead_code() {
2197 // If PGO is enabled sometimes gc_sections will remove the profile data section
2198 // as it appears to be unused. This can then cause the PGO profile file to lose
2199 // some functions. If we are generating a profile we shouldn't strip those metadata
2200 // sections to ensure we have all the data for PGO.
2202 crate_type == CrateType::Dylib || sess.opts.cg.profile_generate.enabled();
2203 if crate_type != CrateType::Executable || !sess.opts.unstable_opts.export_executable_symbols
2205 cmd.gc_sections(keep_metadata);
2207 cmd.no_gc_sections();
2211 cmd.set_output_kind(link_output_kind, out_filename);
2213 add_relro_args(cmd, sess);
2215 // Pass optimization flags down to the linker.
2218 // Gather the set of NatVis files, if any, and write them out to a temp directory.
2219 let natvis_visualizers = collect_natvis_visualizers(
2222 &codegen_results.crate_info.local_crate_name,
2223 &codegen_results.crate_info.natvis_debugger_visualizers,
2226 // Pass debuginfo, NatVis debugger visualizers and strip flags down to the linker.
2227 cmd.debuginfo(strip_value(sess), &natvis_visualizers);
2229 // We want to prevent the compiler from accidentally leaking in any system libraries,
2230 // so by default we tell linkers not to link to any default libraries.
2231 if !sess.opts.cg.default_linker_libraries && sess.target.no_default_libraries {
2232 cmd.no_default_libraries();
2235 if sess.opts.cg.profile_generate.enabled() || sess.instrument_coverage() {
2239 if sess.opts.cg.control_flow_guard != CFGuard::Disabled {
2240 cmd.control_flow_guard();
2243 add_rpath_args(cmd, sess, codegen_results, out_filename);
2246 // Write the NatVis debugger visualizer files for each crate to the temp directory and gather the file paths.
2247 fn collect_natvis_visualizers(
2250 crate_name: &Symbol,
2251 natvis_debugger_visualizers: &BTreeSet<DebuggerVisualizerFile>,
2253 let mut visualizer_paths = Vec::with_capacity(natvis_debugger_visualizers.len());
2255 for (index, visualizer) in natvis_debugger_visualizers.iter().enumerate() {
2256 let visualizer_out_file = tmpdir.join(format!("{}-{}.natvis", crate_name.as_str(), index));
2258 match fs::write(&visualizer_out_file, &visualizer.src) {
2260 visualizer_paths.push(visualizer_out_file);
2263 sess.emit_warning(errors::UnableToWriteDebuggerVisualizer {
2264 path: visualizer_out_file,
2273 fn add_native_libs_from_crate(
2274 cmd: &mut dyn Linker,
2276 archive_builder_builder: &dyn ArchiveBuilderBuilder,
2277 codegen_results: &CodegenResults,
2279 search_paths: &OnceCell<Vec<PathBuf>>,
2280 bundled_libs: &FxHashSet<Symbol>,
2285 if !sess.opts.unstable_opts.link_native_libraries {
2286 // If `-Zlink-native-libraries=false` is set, then the assumption is that an
2287 // external build system already has the native dependencies defined, and it
2288 // will provide them to the linker itself.
2292 if link_static && cnum != LOCAL_CRATE && !bundled_libs.is_empty() {
2293 // If rlib contains native libs as archives, unpack them to tmpdir.
2294 let rlib = &codegen_results.crate_info.used_crate_source[&cnum].rlib.as_ref().unwrap().0;
2295 archive_builder_builder
2296 .extract_bundled_libs(rlib, tmpdir, &bundled_libs)
2297 .unwrap_or_else(|e| sess.emit_fatal(e));
2300 let native_libs = match cnum {
2301 LOCAL_CRATE => &codegen_results.crate_info.used_libraries,
2302 _ => &codegen_results.crate_info.native_libraries[&cnum],
2305 let mut last = (None, NativeLibKind::Unspecified, None);
2306 for lib in native_libs {
2307 let Some(name) = lib.name else {
2310 if !relevant_lib(sess, lib) {
2314 // Skip if this library is the same as the last.
2315 last = if (lib.name, lib.kind, lib.verbatim) == last {
2318 (lib.name, lib.kind, lib.verbatim)
2321 let name = name.as_str();
2322 let verbatim = lib.verbatim.unwrap_or(false);
2324 NativeLibKind::Static { bundle, whole_archive } => {
2326 let bundle = bundle.unwrap_or(true);
2327 let whole_archive = whole_archive == Some(true)
2328 // Backward compatibility case: this can be a rlib (so `+whole-archive`
2329 // cannot be added explicitly if necessary, see the error in `fn link_rlib`)
2330 // compiled as an executable due to `--test`. Use whole-archive implicitly,
2331 // like before the introduction of native lib modifiers.
2332 || (whole_archive == None
2334 && cnum == LOCAL_CRATE
2337 if bundle && cnum != LOCAL_CRATE {
2338 if let Some(filename) = lib.filename {
2339 // If rlib contains native libs as archives, they are unpacked to tmpdir.
2340 let path = tmpdir.join(filename.as_str());
2342 cmd.link_whole_rlib(&path);
2344 cmd.link_rlib(&path);
2349 cmd.link_whole_staticlib(
2352 &search_paths.get_or_init(|| archive_search_paths(sess)),
2355 // HACK/FIXME: Fixup a circular dependency between libgcc and libc
2356 // with glibc. This logic should be moved to the libc crate.
2357 if cnum != LOCAL_CRATE
2358 && sess.target.os == "linux"
2359 && sess.target.env == "gnu"
2362 cmd.link_staticlib("gcc", false);
2364 cmd.link_staticlib(name, verbatim)
2369 NativeLibKind::Dylib { as_needed } => {
2371 cmd.link_dylib(name, verbatim, as_needed.unwrap_or(true))
2374 NativeLibKind::Unspecified => {
2376 cmd.link_dylib(name, verbatim, true);
2379 NativeLibKind::Framework { as_needed } => {
2381 cmd.link_framework(name, as_needed.unwrap_or(true))
2384 NativeLibKind::RawDylib => {
2385 // Handled separately in `linker_with_args`.
2387 NativeLibKind::LinkArg => {
2396 fn add_local_native_libraries(
2397 cmd: &mut dyn Linker,
2399 archive_builder_builder: &dyn ArchiveBuilderBuilder,
2400 codegen_results: &CodegenResults,
2403 if sess.opts.unstable_opts.link_native_libraries {
2404 // User-supplied library search paths (-L on the command line). These are the same paths
2405 // used to find Rust crates, so some of them may have been added already by the previous
2406 // crate linking code. This only allows them to be found at compile time so it is still
2407 // entirely up to outside forces to make sure that library can be found at runtime.
2408 for search_path in sess.target_filesearch(PathKind::All).search_paths() {
2409 match search_path.kind {
2410 PathKind::Framework => cmd.framework_path(&search_path.dir),
2411 _ => cmd.include_path(&fix_windows_verbatim_for_gcc(&search_path.dir)),
2416 let search_paths = OnceCell::new();
2417 // All static and dynamic native library dependencies are linked to the local crate.
2418 let link_static = true;
2419 let link_dynamic = true;
2420 add_native_libs_from_crate(
2423 archive_builder_builder,
2427 &Default::default(),
2434 fn add_upstream_rust_crates<'a>(
2435 cmd: &mut dyn Linker,
2437 archive_builder_builder: &dyn ArchiveBuilderBuilder,
2438 codegen_results: &CodegenResults,
2439 crate_type: CrateType,
2442 // All of the heavy lifting has previously been accomplished by the
2443 // dependency_format module of the compiler. This is just crawling the
2444 // output of that module, adding crates as necessary.
2446 // Linking to a rlib involves just passing it to the linker (the linker
2447 // will slurp up the object files inside), and linking to a dynamic library
2448 // involves just passing the right -l flag.
2449 let (_, data) = codegen_results
2453 .find(|(ty, _)| *ty == crate_type)
2454 .expect("failed to find crate type in dependency format list");
2456 let search_paths = OnceCell::new();
2457 for &cnum in &codegen_results.crate_info.used_crates {
2458 // We may not pass all crates through to the linker. Some crates may appear statically in
2459 // an existing dylib, meaning we'll pick up all the symbols from the dylib.
2460 // We must always link crates `compiler_builtins` and `profiler_builtins` statically.
2461 // Even if they were already included into a dylib
2462 // (e.g. `libstd` when `-C prefer-dynamic` is used).
2463 // FIXME: `dependency_formats` can report `profiler_builtins` as `NotLinked` for some
2464 // reason, it shouldn't do that because `profiler_builtins` should indeed be linked.
2465 let linkage = data[cnum.as_usize() - 1];
2466 let link_static_crate = linkage == Linkage::Static
2467 || (linkage == Linkage::IncludedFromDylib || linkage == Linkage::NotLinked)
2468 && (codegen_results.crate_info.compiler_builtins == Some(cnum)
2469 || codegen_results.crate_info.profiler_runtime == Some(cnum));
2471 let mut bundled_libs = Default::default();
2473 Linkage::Static | Linkage::IncludedFromDylib | Linkage::NotLinked => {
2474 if link_static_crate {
2475 bundled_libs = codegen_results.crate_info.native_libraries[&cnum]
2477 .filter_map(|lib| lib.filename)
2482 archive_builder_builder,
2490 Linkage::Dynamic => {
2491 let src = &codegen_results.crate_info.used_crate_source[&cnum];
2492 add_dynamic_crate(cmd, sess, &src.dylib.as_ref().unwrap().0);
2496 // Static libraries are linked for a subset of linked upstream crates.
2497 // 1. If the upstream crate is a directly linked rlib then we must link the native library
2498 // because the rlib is just an archive.
2499 // 2. If the upstream crate is a dylib or a rlib linked through dylib, then we do not link
2500 // the native library because it is already linked into the dylib, and even if
2501 // inline/const/generic functions from the dylib can refer to symbols from the native
2502 // library, those symbols should be exported and available from the dylib anyway.
2503 // 3. Libraries bundled into `(compiler,profiler)_builtins` are special, see above.
2504 let link_static = link_static_crate;
2505 // Dynamic libraries are not linked here, see the FIXME in `add_upstream_native_libraries`.
2506 let link_dynamic = false;
2507 add_native_libs_from_crate(
2510 archive_builder_builder,
2522 fn add_upstream_native_libraries(
2523 cmd: &mut dyn Linker,
2525 archive_builder_builder: &dyn ArchiveBuilderBuilder,
2526 codegen_results: &CodegenResults,
2529 let search_path = OnceCell::new();
2530 for &cnum in &codegen_results.crate_info.used_crates {
2531 // Static libraries are not linked here, they are linked in `add_upstream_rust_crates`.
2532 // FIXME: Merge this function to `add_upstream_rust_crates` so that all native libraries
2533 // are linked together with their respective upstream crates, and in their originally
2534 // specified order. This is slightly breaking due to our use of `--as-needed` (see crater
2535 // results in https://github.com/rust-lang/rust/pull/102832#issuecomment-1279772306).
2536 let link_static = false;
2537 // Dynamic libraries are linked for all linked upstream crates.
2538 // 1. If the upstream crate is a directly linked rlib then we must link the native library
2539 // because the rlib is just an archive.
2540 // 2. If the upstream crate is a dylib or a rlib linked through dylib, then we have to link
2541 // the native library too because inline/const/generic functions from the dylib can refer
2542 // to symbols from the native library, so the native library providing those symbols should
2543 // be available when linking our final binary.
2544 let link_dynamic = true;
2545 add_native_libs_from_crate(
2548 archive_builder_builder,
2552 &Default::default(),
2560 // Adds the static "rlib" versions of all crates to the command line.
2561 // There's a bit of magic which happens here specifically related to LTO,
2562 // namely that we remove upstream object files.
2564 // When performing LTO, almost(*) all of the bytecode from the upstream
2565 // libraries has already been included in our object file output. As a
2566 // result we need to remove the object files in the upstream libraries so
2567 // the linker doesn't try to include them twice (or whine about duplicate
2568 // symbols). We must continue to include the rest of the rlib, however, as
2569 // it may contain static native libraries which must be linked in.
2571 // (*) Crates marked with `#![no_builtins]` don't participate in LTO and
2572 // their bytecode wasn't included. The object files in those libraries must
2573 // still be passed to the linker.
2575 // Note, however, that if we're not doing LTO we can just pass the rlib
2576 // blindly to the linker (fast) because it's fine if it's not actually
2577 // included as we're at the end of the dependency chain.
2578 fn add_static_crate<'a>(
2579 cmd: &mut dyn Linker,
2581 archive_builder_builder: &dyn ArchiveBuilderBuilder,
2582 codegen_results: &CodegenResults,
2585 bundled_lib_file_names: &FxHashSet<Symbol>,
2587 let src = &codegen_results.crate_info.used_crate_source[&cnum];
2588 let cratepath = &src.rlib.as_ref().unwrap().0;
2590 let mut link_upstream = |path: &Path| {
2591 cmd.link_rlib(&fix_windows_verbatim_for_gcc(path));
2594 // See the comment above in `link_staticlib` and `link_rlib` for why if
2595 // there's a static library that's not relevant we skip all object
2597 let native_libs = &codegen_results.crate_info.native_libraries[&cnum];
2598 let skip_native = native_libs.iter().any(|lib| {
2599 matches!(lib.kind, NativeLibKind::Static { bundle: None | Some(true), .. })
2600 && !relevant_lib(sess, lib)
2603 if (!are_upstream_rust_objects_already_included(sess)
2604 || ignored_for_lto(sess, &codegen_results.crate_info, cnum))
2607 link_upstream(cratepath);
2611 let dst = tmpdir.join(cratepath.file_name().unwrap());
2612 let name = cratepath.file_name().unwrap().to_str().unwrap();
2613 let name = &name[3..name.len() - 5]; // chop off lib/.rlib
2614 let bundled_lib_file_names = bundled_lib_file_names.clone();
2616 sess.prof.generic_activity_with_arg("link_altering_rlib", name).run(|| {
2617 let canonical_name = name.replace('-', "_");
2618 let upstream_rust_objects_already_included =
2619 are_upstream_rust_objects_already_included(sess);
2621 sess.target.no_builtins || !codegen_results.crate_info.is_no_builtins.contains(&cnum);
2623 let mut archive = archive_builder_builder.new_archive_builder(sess);
2624 if let Err(e) = archive.add_archive(
2627 if f == METADATA_FILENAME {
2631 let canonical = f.replace('-', "_");
2633 let is_rust_object =
2634 canonical.starts_with(&canonical_name) && looks_like_rust_object_file(&f);
2636 // If we've been requested to skip all native object files
2637 // (those not generated by the rust compiler) then we can skip
2638 // this file. See above for why we may want to do this.
2639 let skip_because_cfg_say_so = skip_native && !is_rust_object;
2641 // If we're performing LTO and this is a rust-generated object
2642 // file, then we don't need the object file as it's part of the
2643 // LTO module. Note that `#![no_builtins]` is excluded from LTO,
2644 // though, so we let that object file slide.
2645 let skip_because_lto =
2646 upstream_rust_objects_already_included && is_rust_object && is_builtins;
2648 // We skip native libraries because:
2649 // 1. This native libraries won't be used from the generated rlib,
2650 // so we can throw them away to avoid the copying work.
2651 // 2. We can't allow it to be a single remaining entry in archive
2652 // as some linkers may complain on that.
2653 if bundled_lib_file_names.contains(&Symbol::intern(f)) {
2657 if skip_because_cfg_say_so || skip_because_lto {
2664 sess.fatal(&format!("failed to build archive from rlib: {}", e));
2666 if archive.build(&dst) {
2667 link_upstream(&dst);
2672 // Same thing as above, but for dynamic crates instead of static crates.
2673 fn add_dynamic_crate(cmd: &mut dyn Linker, sess: &Session, cratepath: &Path) {
2674 // Just need to tell the linker about where the library lives and
2676 let parent = cratepath.parent();
2677 if let Some(dir) = parent {
2678 cmd.include_path(&fix_windows_verbatim_for_gcc(dir));
2680 let stem = cratepath.file_stem().unwrap().to_str().unwrap();
2681 // Convert library file-stem into a cc -l argument.
2682 let prefix = if stem.starts_with("lib") && !sess.target.is_like_windows { 3 } else { 0 };
2683 cmd.link_rust_dylib(&stem[prefix..], parent.unwrap_or_else(|| Path::new("")));
2686 fn relevant_lib(sess: &Session, lib: &NativeLib) -> bool {
2688 Some(ref cfg) => rustc_attr::cfg_matches(cfg, &sess.parse_sess, CRATE_NODE_ID, None),
2693 pub(crate) fn are_upstream_rust_objects_already_included(sess: &Session) -> bool {
2695 config::Lto::Fat => true,
2696 config::Lto::Thin => {
2697 // If we defer LTO to the linker, we haven't run LTO ourselves, so
2698 // any upstream object files have not been copied yet.
2699 !sess.opts.cg.linker_plugin_lto.enabled()
2701 config::Lto::No | config::Lto::ThinLocal => false,
2705 fn add_apple_sdk(cmd: &mut dyn Linker, sess: &Session, flavor: LinkerFlavor) {
2706 let arch = &sess.target.arch;
2707 let os = &sess.target.os;
2708 let llvm_target = &sess.target.llvm_target;
2709 if sess.target.vendor != "apple"
2710 || !matches!(os.as_ref(), "ios" | "tvos" | "watchos" | "macos")
2711 || !matches!(flavor, LinkerFlavor::Darwin(..))
2716 if os == "macos" && !matches!(flavor, LinkerFlavor::Darwin(Cc::No, _)) {
2720 let sdk_name = match (arch.as_ref(), os.as_ref()) {
2721 ("aarch64", "tvos") => "appletvos",
2722 ("x86_64", "tvos") => "appletvsimulator",
2723 ("arm", "ios") => "iphoneos",
2724 ("aarch64", "ios") if llvm_target.contains("macabi") => "macosx",
2725 ("aarch64", "ios") if llvm_target.ends_with("-simulator") => "iphonesimulator",
2726 ("aarch64", "ios") => "iphoneos",
2727 ("x86", "ios") => "iphonesimulator",
2728 ("x86_64", "ios") if llvm_target.contains("macabi") => "macosx",
2729 ("x86_64", "ios") => "iphonesimulator",
2730 ("x86_64", "watchos") => "watchsimulator",
2731 ("arm64_32", "watchos") => "watchos",
2732 ("aarch64", "watchos") if llvm_target.ends_with("-simulator") => "watchsimulator",
2733 ("aarch64", "watchos") => "watchos",
2734 ("arm", "watchos") => "watchos",
2735 (_, "macos") => "macosx",
2737 sess.emit_err(errors::UnsupportedArch { arch, os });
2741 let sdk_root = match get_apple_sdk_root(sdk_name) {
2750 LinkerFlavor::Darwin(Cc::Yes, _) => {
2751 cmd.args(&["-isysroot", &sdk_root, "-Wl,-syslibroot", &sdk_root]);
2753 LinkerFlavor::Darwin(Cc::No, _) => {
2754 cmd.args(&["-syslibroot", &sdk_root]);
2756 _ => unreachable!(),
2760 fn get_apple_sdk_root(sdk_name: &str) -> Result<String, errors::AppleSdkRootError<'_>> {
2761 // Following what clang does
2762 // (https://github.com/llvm/llvm-project/blob/
2763 // 296a80102a9b72c3eda80558fb78a3ed8849b341/clang/lib/Driver/ToolChains/Darwin.cpp#L1661-L1678)
2764 // to allow the SDK path to be set. (For clang, xcrun sets
2765 // SDKROOT; for rustc, the user or build system can set it, or we
2766 // can fall back to checking for xcrun on PATH.)
2767 if let Ok(sdkroot) = env::var("SDKROOT") {
2768 let p = Path::new(&sdkroot);
2770 // Ignore `SDKROOT` if it's clearly set for the wrong platform.
2772 if sdkroot.contains("TVSimulator.platform")
2773 || sdkroot.contains("MacOSX.platform") => {}
2775 if sdkroot.contains("TVOS.platform") || sdkroot.contains("MacOSX.platform") => {}
2777 if sdkroot.contains("iPhoneSimulator.platform")
2778 || sdkroot.contains("MacOSX.platform") => {}
2780 if sdkroot.contains("iPhoneOS.platform") || sdkroot.contains("MacOSX.platform") => {
2783 if sdkroot.contains("iPhoneOS.platform")
2784 || sdkroot.contains("iPhoneSimulator.platform") => {}
2786 if sdkroot.contains("WatchSimulator.platform")
2787 || sdkroot.contains("MacOSX.platform") => {}
2789 if sdkroot.contains("WatchOS.platform") || sdkroot.contains("MacOSX.platform") => {}
2790 // Ignore `SDKROOT` if it's not a valid path.
2791 _ if !p.is_absolute() || p == Path::new("/") || !p.exists() => {}
2792 _ => return Ok(sdkroot),
2796 Command::new("xcrun").arg("--show-sdk-path").arg("-sdk").arg(sdk_name).output().and_then(
2798 if output.status.success() {
2799 Ok(String::from_utf8(output.stdout).unwrap())
2801 let error = String::from_utf8(output.stderr);
2802 let error = format!("process exit with error: {}", error.unwrap());
2803 Err(io::Error::new(io::ErrorKind::Other, &error[..]))
2809 Ok(output) => Ok(output.trim().to_string()),
2810 Err(error) => Err(errors::AppleSdkRootError::SdkPath { sdk_name, error }),
2814 fn add_gcc_ld_path(cmd: &mut dyn Linker, sess: &Session, flavor: LinkerFlavor) {
2815 if let Some(ld_impl) = sess.opts.unstable_opts.gcc_ld {
2816 if let LinkerFlavor::Gnu(Cc::Yes, _)
2817 | LinkerFlavor::Darwin(Cc::Yes, _)
2818 | LinkerFlavor::WasmLld(Cc::Yes) = flavor
2822 // Implement the "self-contained" part of -Zgcc-ld
2823 // by adding rustc distribution directories to the tool search path.
2824 for path in sess.get_tools_search_paths(false) {
2826 let mut arg = OsString::from("-B");
2827 arg.push(path.join("gcc-ld"));
2831 // Implement the "linker flavor" part of -Zgcc-ld
2832 // by asking cc to use some kind of lld.
2833 cmd.arg("-fuse-ld=lld");
2834 if !flavor.is_gnu() {
2835 // Tell clang to use a non-default LLD flavor.
2836 // Gcc doesn't understand the target option, but we currently assume
2837 // that gcc is not used for Apple and Wasm targets (#97402).
2838 cmd.arg(format!("--target={}", sess.target.llvm_target));
2843 sess.emit_fatal(errors::OptionGccOnly);