Skip to content

Commit

Permalink
Auto merge of #111698 - Amanieu:force-static-lib, r=petrochenkov
Browse files Browse the repository at this point in the history
Force all native libraries to be statically linked when linking a static binary

Previously, `#[link]` without an explicit `kind = "static"` would confuse the linker and end up producing a dynamically linked library because of the `-Bdynamic` flag. However this binary would not work correctly anyways since it was linked with startup code for a static binary.

This PR solves this by forcing all native libraries to be statically linked when the output is a static binary that cannot link to dynamic libraries anyways.

Fixes #108878
Fixes #102993
  • Loading branch information
bors committed Jun 7, 2023
2 parents a97c36d + 0304e0a commit f383703
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 6 deletions.
38 changes: 34 additions & 4 deletions compiler/rustc_codegen_ssa/src/back/link.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2097,7 +2097,14 @@ fn linker_with_args<'a>(
cmd.add_as_needed();

// Local native libraries of all kinds.
add_local_native_libraries(cmd, sess, archive_builder_builder, codegen_results, tmpdir);
add_local_native_libraries(
cmd,
sess,
archive_builder_builder,
codegen_results,
tmpdir,
link_output_kind,
);

// Upstream rust crates and their non-dynamic native libraries.
add_upstream_rust_crates(
Expand All @@ -2107,10 +2114,18 @@ fn linker_with_args<'a>(
codegen_results,
crate_type,
tmpdir,
link_output_kind,
);

// Dynamic native libraries from upstream crates.
add_upstream_native_libraries(cmd, sess, archive_builder_builder, codegen_results, tmpdir);
add_upstream_native_libraries(
cmd,
sess,
archive_builder_builder,
codegen_results,
tmpdir,
link_output_kind,
);

// Link with the import library generated for any raw-dylib functions.
for (raw_dylib_name, raw_dylib_imports) in
Expand Down Expand Up @@ -2365,6 +2380,7 @@ fn add_native_libs_from_crate(
cnum: CrateNum,
link_static: bool,
link_dynamic: bool,
link_output_kind: LinkOutputKind,
) {
if !sess.opts.unstable_opts.link_native_libraries {
// If `-Zlink-native-libraries=false` is set, then the assumption is that an
Expand Down Expand Up @@ -2444,8 +2460,16 @@ fn add_native_libs_from_crate(
}
}
NativeLibKind::Unspecified => {
if link_dynamic {
cmd.link_dylib(name, verbatim, true);
// If we are generating a static binary, prefer static library when the
// link kind is unspecified.
if !link_output_kind.can_link_dylib() && !sess.target.crt_static_allows_dylibs {
if link_static {
cmd.link_staticlib(name, verbatim)
}
} else {
if link_dynamic {
cmd.link_dylib(name, verbatim, true);
}
}
}
NativeLibKind::Framework { as_needed } => {
Expand All @@ -2472,6 +2496,7 @@ fn add_local_native_libraries(
archive_builder_builder: &dyn ArchiveBuilderBuilder,
codegen_results: &CodegenResults,
tmpdir: &Path,
link_output_kind: LinkOutputKind,
) {
if sess.opts.unstable_opts.link_native_libraries {
// User-supplied library search paths (-L on the command line). These are the same paths
Expand Down Expand Up @@ -2501,6 +2526,7 @@ fn add_local_native_libraries(
LOCAL_CRATE,
link_static,
link_dynamic,
link_output_kind,
);
}

Expand All @@ -2511,6 +2537,7 @@ fn add_upstream_rust_crates<'a>(
codegen_results: &CodegenResults,
crate_type: CrateType,
tmpdir: &Path,
link_output_kind: LinkOutputKind,
) {
// All of the heavy lifting has previously been accomplished by the
// dependency_format module of the compiler. This is just crawling the
Expand Down Expand Up @@ -2588,6 +2615,7 @@ fn add_upstream_rust_crates<'a>(
cnum,
link_static,
link_dynamic,
link_output_kind,
);
}
}
Expand All @@ -2598,6 +2626,7 @@ fn add_upstream_native_libraries(
archive_builder_builder: &dyn ArchiveBuilderBuilder,
codegen_results: &CodegenResults,
tmpdir: &Path,
link_output_kind: LinkOutputKind,
) {
let search_path = OnceCell::new();
for &cnum in &codegen_results.crate_info.used_crates {
Expand Down Expand Up @@ -2626,6 +2655,7 @@ fn add_upstream_native_libraries(
cnum,
link_static,
link_dynamic,
link_output_kind,
);
}
}
Expand Down
11 changes: 11 additions & 0 deletions compiler/rustc_target/src/spec/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -675,6 +675,17 @@ impl LinkOutputKind {
_ => return None,
})
}

pub fn can_link_dylib(self) -> bool {
match self {
LinkOutputKind::StaticNoPicExe | LinkOutputKind::StaticPicExe => false,
LinkOutputKind::DynamicNoPicExe
| LinkOutputKind::DynamicPicExe
| LinkOutputKind::DynamicDylib
| LinkOutputKind::StaticDylib
| LinkOutputKind::WasiReactorExe => true,
}
}
}

impl fmt::Display for LinkOutputKind {
Expand Down
4 changes: 2 additions & 2 deletions src/doc/rustc/src/command-line-arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ Example: `-l static:+whole-archive=mylib`.

The kind of library and the modifiers can also be specified in a [`#[link]`
attribute][link-attribute]. If the kind is not specified in the `link`
attribute or on the command-line, it will link a dynamic library if available,
otherwise it will use a static library. If the kind is specified on the
attribute or on the command-line, it will link a dynamic library by default,
except when building a static executable. If the kind is specified on the
command-line, it will override the kind specified in a `link` attribute.

The name used in a `link` attribute may be overridden using the form `-l
Expand Down

0 comments on commit f383703

Please sign in to comment.