Skip to content

Commit

Permalink
Fix handling of +whole-archive native link modifier.
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelwoerister committed Aug 20, 2021
1 parent 896f058 commit fc53fff
Show file tree
Hide file tree
Showing 9 changed files with 106 additions and 3 deletions.
23 changes: 20 additions & 3 deletions compiler/rustc_codegen_ssa/src/back/link.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ use regex::Regex;
use tempfile::Builder as TempFileBuilder;

use std::ffi::OsString;
use std::lazy::OnceCell;
use std::path::{Path, PathBuf};
use std::process::{ExitStatus, Output, Stdio};
use std::{ascii, char, env, fmt, fs, io, mem, str};
Expand Down Expand Up @@ -2328,6 +2329,7 @@ fn add_upstream_native_libraries(
.find(|(ty, _)| *ty == crate_type)
.expect("failed to find crate type in dependency format list");

let search_path = OnceCell::new();
let crates = &codegen_results.crate_info.used_crates;
let mut last = (NativeLibKind::Unspecified, None);
for &cnum in crates {
Expand All @@ -2352,19 +2354,34 @@ fn add_upstream_native_libraries(
NativeLibKind::Framework { as_needed } => {
cmd.link_framework(name, as_needed.unwrap_or(true))
}
NativeLibKind::Static { bundle: Some(false), .. } => {
NativeLibKind::Static { bundle: Some(false), whole_archive } => {
// Link "static-nobundle" native libs only if the crate they originate from
// is being linked statically to the current crate. If it's linked dynamically
// or is an rlib already included via some other dylib crate, the symbols from
// native libs will have already been included in that dylib.
if data[cnum.as_usize() - 1] == Linkage::Static {
cmd.link_staticlib(name, verbatim)
if whole_archive == Some(true) {
cmd.link_whole_staticlib(
name,
verbatim,
search_path.get_or_init(|| archive_search_paths(sess)),
);
} else {
cmd.link_staticlib(name, verbatim)
}
}
}
// ignore statically included native libraries here as we've
// already included them when we included the rust library
// previously
NativeLibKind::Static { bundle: None | Some(true), .. } => {}
NativeLibKind::Static { bundle: None | Some(true), whole_archive } => {
if whole_archive == Some(true) {
bug!(
"Combining `+bundle` with `+whole-archive` is not allowed. \
This should have been caught by an earlier validation step already."
)
}
}
NativeLibKind::RawDylib => {}
}
}
Expand Down
1 change: 1 addition & 0 deletions compiler/rustc_codegen_ssa/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
#![feature(in_band_lifetimes)]
#![feature(nll)]
#![feature(associated_type_bounds)]
#![feature(once_cell)]
#![recursion_limit = "256"]

//! This crate contains codegen code that is used by all codegen backends (LLVM and others).
Expand Down
37 changes: 37 additions & 0 deletions src/test/run-make/native-link-modifier-whole-archive/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# This test case makes sure that native libraries are linked with --whole-archive semantics
# when the `-bundle,+whole-archive` modifiers are applied to them.
#
# The test works by checking that the resulting executables produce the expected output,
# part of which is emitted by otherwise unreferenced C code. If +whole-archive didn't work
# that code would never make it into the final executable and we'd thus be missing some
# of the output.

-include ../../run-make-fulldeps/tools.mk

all: $(TMPDIR)/$(call BIN,directly_linked) $(TMPDIR)/$(call BIN,indirectly_linked) $(TMPDIR)/$(call BIN,indirectly_linked_via_attr)
$(call RUN,directly_linked) | $(CGREP) 'static-initializer.directly_linked.'
$(call RUN,indirectly_linked) | $(CGREP) 'static-initializer.indirectly_linked.'
$(call RUN,indirectly_linked_via_attr) | $(CGREP) 'static-initializer.native_lib_in_src.'

# Native lib linked directly into executable
$(TMPDIR)/$(call BIN,directly_linked): $(call NATIVE_STATICLIB,c_static_lib_with_constructor)
$(RUSTC) directly_linked.rs -Z unstable-options -l static:+whole-archive=c_static_lib_with_constructor

# Native lib linked into RLIB via `-l static:-bundle,+whole-archive`, RLIB linked into executable
$(TMPDIR)/$(call BIN,indirectly_linked): $(TMPDIR)/librlib_with_cmdline_native_lib.rlib
$(RUSTC) indirectly_linked.rs

# Native lib linked into RLIB via #[link] attribute, RLIB linked into executable
$(TMPDIR)/$(call BIN,indirectly_linked_via_attr): $(TMPDIR)/libnative_lib_in_src.rlib
$(RUSTC) indirectly_linked_via_attr.rs

# Native lib linked into rlib with via commandline
$(TMPDIR)/librlib_with_cmdline_native_lib.rlib: $(call NATIVE_STATICLIB,c_static_lib_with_constructor)
$(RUSTC) rlib_with_cmdline_native_lib.rs -Z unstable-options --crate-type=rlib -l static:-bundle,+whole-archive=c_static_lib_with_constructor

# Native lib linked into rlib via `#[link()]` attribute on extern block.
$(TMPDIR)/libnative_lib_in_src.rlib: $(call NATIVE_STATICLIB,c_static_lib_with_constructor)
$(RUSTC) native_lib_in_src.rs --crate-type=rlib

$(TMPDIR)/libc_static_lib_with_constructor.o: c_static_lib_with_constructor.cpp
$(call COMPILE_OBJ_CXX,$@,$<)
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#include <cstdio>

// Since this is a global variable, its constructor will be called before
// main() is executed. But only if the object file containing it actually
// gets linked into the executable.
struct Foo {
Foo() {
printf("static-initializer.");
fflush(stdout);
}
} FOO;
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
use std::io::Write;

fn main() {
print!("directly_linked.");
std::io::stdout().flush().unwrap();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
extern crate rlib_with_cmdline_native_lib;

fn main() {
rlib_with_cmdline_native_lib::hello();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
extern crate native_lib_in_src;

fn main() {
native_lib_in_src::hello();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#![feature(native_link_modifiers_bundle)]
#![feature(native_link_modifiers_whole_archive)]
#![feature(native_link_modifiers)]

use std::io::Write;

#[link(name = "c_static_lib_with_constructor",
kind = "static",
modifiers = "-bundle,+whole-archive")]
extern {}

pub fn hello() {
print!("native_lib_in_src.");
std::io::stdout().flush().unwrap();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
use std::io::Write;

pub fn hello() {
print!("indirectly_linked.");
std::io::stdout().flush().unwrap();
}

0 comments on commit fc53fff

Please sign in to comment.