ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

build: link all static libs with --whole-archive

Browse Source 
SPDK uses constructor functions for registration functionality
in several different areas - RPCs, bdev modules, event tracing,
etc.  Since these functions are not explicitly referenced, the
linker will remove these constructor functions from the linked
application unless their library is included using the
--whole-archive linker option.

SPDK has tried to minimize the number of libraries linked with
--whole-archive to only those that are necessary.  But there
are still a lot of exceptions that we need to work around.  The
benefit to trying to restrict it is minimal - for example,
an nvmf_tgt binary built before this patch is 4746320 bytes
on my system, but linking all of the libraries with
--whole-archive only increases it to 4784080 bytes - a difference
of less than 1%.

Note that DPDK also links all libraries with --whole-archive by
default.

This will also simplify some upcoming changes around shared
library dependencies - we will be able to blindly use
--whole-archive when linking the shared library as well.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Iab0dbbace06a3d15c835491e55683ab4cf9e53f0
Reviewed-on: https://review.gerrithub.io/434107
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
This commit is contained in:
Jim Harris 2018-11-20 07:24:15 -07:00 committed by Darek Stojaczyk
parent 0b5fa082db
commit 2ac1cbbf07
2 changed files with 9 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
mk/spdk.app.mk
View File

@ -31,45 +31,22 @@
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# #
# Event subsystems only export constructor functions, so wrap these
# in whole-archive linker args
SPDK_FILTER_LIB_LIST = $(filter event_%,$(SPDK_LIB_LIST))
# RPC libraries only export constructor functions, so these need to be treated
# separately and wrapped in whole-archive linker args
SPDK_FILTER_LIB_LIST += $(filter %_rpc,$(SPDK_LIB_LIST))
# Currently some libraries contain their respective RPC methods
# rather than breaking them out into separate libraries. So we must also include
# these directories in the RPC library list.
SPDK_FILTER_LIB_LIST += $(filter iscsi,$(SPDK_LIB_LIST))
SPDK_FILTER_LIB_LIST += $(filter nbd,$(SPDK_LIB_LIST))
SPDK_FILTER_LIB_LIST += $(filter net,$(SPDK_LIB_LIST))
SPDK_FILTER_LIB_LIST += $(filter vhost,$(SPDK_LIB_LIST))
SPDK_FILTER_LIB_LIST += $(filter scsi,$(SPDK_LIB_LIST))
# The unit test mock wrappers need to be wrapped in whole-archive so they don't get
# automatically removed with LTO.
SPDK_FILTER_LIB_LIST += $(filter ut_mock,$(SPDK_LIB_LIST))
SPDK_WHOLE_ARCHIVE_LIB_LIST = $(SPDK_FILTER_LIB_LIST)
SPDK_REMAINING_LIB_LIST = $(filter-out $(SPDK_WHOLE_ARCHIVE_LIB_LIST),$(SPDK_LIB_LIST))
SPDK_LIB_FILES = $(call spdk_lib_list_to_static_libs,$(SPDK_LIB_LIST)) SPDK_LIB_FILES = $(call spdk_lib_list_to_static_libs,$(SPDK_LIB_LIST))
SPDK_LIB_LINKER_ARGS = \ SPDK_LIB_LINKER_ARGS = \
-L$(SPDK_ROOT_DIR)/build/lib \ -L$(SPDK_ROOT_DIR)/build/lib \
-Wl,--whole-archive \ -Wl,--whole-archive \
$(SPDK_WHOLE_ARCHIVE_LIB_LIST:%=-lspdk_%) \ $(SPDK_LIB_LIST:%=-lspdk_%) \
-Wl,--no-whole-archive \ -Wl,--no-whole-archive
$(SPDK_REMAINING_LIB_LIST:%=-lspdk_%)
# This is primarily used for unit tests to ensure they link when shared library # This is primarily used for unit tests to ensure they link when shared library
# build is enabled. Shared libraries can't get their mock implementation from # build is enabled. Shared libraries can't get their mock implementation from
# the unit test file. # the unit test file. Note that even for unittests, we must include the mock
# library with whole-archive, to keep its functions from getting stripped out
# when LTO is enabled.
SPDK_STATIC_LIB_LINKER_ARGS = \ SPDK_STATIC_LIB_LINKER_ARGS = \
$(SPDK_LIB_LIST:%=$(SPDK_ROOT_DIR)/build/lib/libspdk_%.a) \
-Wl,--whole-archive \ -Wl,--whole-archive \
$(SPDK_WHOLE_ARCHIVE_LIB_LIST:%=$(SPDK_ROOT_DIR)/build/lib/libspdk_%.a) \ $(SPDK_ROOT_DIR)/build/lib/libspdk_ut_mock.a \
-Wl,--no-whole-archive \ -Wl,--no-whole-archive
$(SPDK_REMAINING_LIB_LIST:%=$(SPDK_ROOT_DIR)/build/lib/libspdk_%.a)
install: all install: all

2
mk/spdk.unittest.mk
View File

@ -40,7 +40,7 @@ C_SRCS = $(TEST_FILE)
CFLAGS += -I$(SPDK_ROOT_DIR)/lib CFLAGS += -I$(SPDK_ROOT_DIR)/lib
CFLAGS += -I$(SPDK_ROOT_DIR)/test CFLAGS += -I$(SPDK_ROOT_DIR)/test
SPDK_LIB_LIST += thread util log ut_mock sock SPDK_LIB_LIST += thread util log sock
LIBS += -lcunit $(SPDK_STATIC_LIB_LINKER_ARGS) LIBS += -lcunit $(SPDK_STATIC_LIB_LINKER_ARGS)