![Matthias Maennich](/assets/img/avatar_default.png)
A script that uses the '<module>.ns_deps' files generated by modpost to automatically add the required symbol namespace dependencies to each module. Usage: 1) Move some symbols to a namespace with EXPORT_SYMBOL_NS() or define DEFAULT_SYMBOL_NAMESPACE 2) Run 'make' (or 'make modules') and get warnings about modules not importing that namespace. 3) Run 'make nsdeps' to automatically add required import statements to said modules. This makes it easer for subsystem maintainers to introduce and maintain symbol namespaces into their codebase. Co-developed-by: Martijn Coenen <maco@android.com> Signed-off-by: Martijn Coenen <maco@android.com> Acked-by: Julia Lawall <julia.lawall@lip6.fr> Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Matthias Maennich <maennich@google.com> Signed-off-by: Jessica Yu <jeyu@kernel.org>
159 lines
5.1 KiB
Makefile
159 lines
5.1 KiB
Makefile
# SPDX-License-Identifier: GPL-2.0
|
|
# ===========================================================================
|
|
# Module versions
|
|
# ===========================================================================
|
|
#
|
|
# Stage one of module building created the following:
|
|
# a) The individual .o files used for the module
|
|
# b) A <module>.o file which is the .o files above linked together
|
|
# c) A <module>.mod file, listing the name of the preliminary <module>.o file,
|
|
# plus all .o files
|
|
# d) modules.order, which lists all the modules
|
|
|
|
# Stage 2 is handled by this file and does the following
|
|
# 1) Find all modules listed in modules.order
|
|
# 2) modpost is then used to
|
|
# 3) create one <module>.mod.c file pr. module
|
|
# 4) create one Module.symvers file with CRC for all exported symbols
|
|
# 5) compile all <module>.mod.c files
|
|
# 6) final link of the module to a <module.ko> file
|
|
|
|
# Step 3 is used to place certain information in the module's ELF
|
|
# section, including information such as:
|
|
# Version magic (see include/linux/vermagic.h for full details)
|
|
# - Kernel release
|
|
# - SMP is CONFIG_SMP
|
|
# - PREEMPT is CONFIG_PREEMPT
|
|
# - GCC Version
|
|
# Module info
|
|
# - Module version (MODULE_VERSION)
|
|
# - Module alias'es (MODULE_ALIAS)
|
|
# - Module license (MODULE_LICENSE)
|
|
# - See include/linux/module.h for more details
|
|
|
|
# Step 4 is solely used to allow module versioning in external modules,
|
|
# where the CRC of each module is retrieved from the Module.symvers file.
|
|
|
|
# KBUILD_MODPOST_WARN can be set to avoid error out in case of undefined
|
|
# symbols in the final module linking stage
|
|
# KBUILD_MODPOST_NOFINAL can be set to skip the final link of modules.
|
|
# This is solely useful to speed up test compiles
|
|
|
|
PHONY := __modpost
|
|
__modpost:
|
|
|
|
include include/config/auto.conf
|
|
include scripts/Kbuild.include
|
|
|
|
kernelsymfile := $(objtree)/Module.symvers
|
|
modulesymfile := $(firstword $(KBUILD_EXTMOD))/Module.symvers
|
|
|
|
MODPOST = scripts/mod/modpost \
|
|
$(if $(CONFIG_MODVERSIONS),-m) \
|
|
$(if $(CONFIG_MODULE_SRCVERSION_ALL),-a) \
|
|
$(if $(KBUILD_EXTMOD),-i,-o) $(kernelsymfile) \
|
|
$(if $(KBUILD_EXTMOD),-I $(modulesymfile)) \
|
|
$(if $(KBUILD_EXTMOD),$(addprefix -e ,$(KBUILD_EXTRA_SYMBOLS))) \
|
|
$(if $(KBUILD_EXTMOD),-o $(modulesymfile)) \
|
|
$(if $(CONFIG_SECTION_MISMATCH_WARN_ONLY),,-E) \
|
|
$(if $(KBUILD_MODPOST_WARN),-w) \
|
|
$(if $(filter nsdeps,$(MAKECMDGOALS)),-d)
|
|
|
|
ifdef MODPOST_VMLINUX
|
|
|
|
__modpost: vmlinux.o
|
|
|
|
quiet_cmd_modpost = MODPOST $@
|
|
cmd_modpost = $(MODPOST) $@
|
|
|
|
PHONY += vmlinux.o
|
|
vmlinux.o:
|
|
$(call cmd,modpost)
|
|
|
|
else
|
|
|
|
# When building external modules load the Kbuild file to retrieve EXTRA_SYMBOLS info
|
|
ifneq ($(KBUILD_EXTMOD),)
|
|
|
|
# set src + obj - they may be used when building the .mod.c file
|
|
obj := $(KBUILD_EXTMOD)
|
|
src := $(obj)
|
|
|
|
# Include the module's Makefile to find KBUILD_EXTRA_SYMBOLS
|
|
include $(if $(wildcard $(KBUILD_EXTMOD)/Kbuild), \
|
|
$(KBUILD_EXTMOD)/Kbuild, $(KBUILD_EXTMOD)/Makefile)
|
|
endif
|
|
|
|
include scripts/Makefile.lib
|
|
|
|
# find all modules listed in modules.order
|
|
modules := $(sort $(shell cat $(MODORDER)))
|
|
|
|
# Stop after building .o files if NOFINAL is set. Makes compile tests quicker
|
|
__modpost: $(if $(KBUILD_MODPOST_NOFINAL), $(modules:.ko:.o),$(modules))
|
|
@:
|
|
|
|
MODPOST += $(subst -i,-n,$(filter -i,$(MAKEFLAGS))) -s -T - $(wildcard vmlinux)
|
|
|
|
# We can go over command line length here, so be careful.
|
|
quiet_cmd_modpost = MODPOST $(words $(modules)) modules
|
|
cmd_modpost = sed 's/ko$$/o/' $(MODORDER) | $(MODPOST)
|
|
|
|
PHONY += modules-modpost
|
|
modules-modpost:
|
|
$(call cmd,modpost)
|
|
|
|
# Declare generated files as targets for modpost
|
|
$(modules:.ko=.mod.c): modules-modpost
|
|
|
|
# Step 5), compile all *.mod.c files
|
|
|
|
# modname is set to make c_flags define KBUILD_MODNAME
|
|
modname = $(notdir $(@:.mod.o=))
|
|
|
|
quiet_cmd_cc_o_c = CC $@
|
|
cmd_cc_o_c = $(CC) $(c_flags) $(KBUILD_CFLAGS_MODULE) $(CFLAGS_MODULE) \
|
|
-c -o $@ $<
|
|
|
|
$(modules:.ko=.mod.o): %.mod.o: %.mod.c FORCE
|
|
$(call if_changed_dep,cc_o_c)
|
|
|
|
targets += $(modules:.ko=.mod.o)
|
|
|
|
ARCH_POSTLINK := $(wildcard $(srctree)/arch/$(SRCARCH)/Makefile.postlink)
|
|
|
|
# Step 6), final link of the modules with optional arch pass after final link
|
|
quiet_cmd_ld_ko_o = LD [M] $@
|
|
cmd_ld_ko_o = \
|
|
$(LD) -r $(KBUILD_LDFLAGS) \
|
|
$(KBUILD_LDFLAGS_MODULE) $(LDFLAGS_MODULE) \
|
|
-o $@ $(real-prereqs) ; \
|
|
$(if $(ARCH_POSTLINK), $(MAKE) -f $(ARCH_POSTLINK) $@, true)
|
|
|
|
$(modules): %.ko :%.o %.mod.o FORCE
|
|
+$(call if_changed,ld_ko_o)
|
|
|
|
targets += $(modules)
|
|
|
|
nsdeps: __modpost
|
|
|
|
# Add FORCE to the prequisites of a target to force it to be always rebuilt.
|
|
# ---------------------------------------------------------------------------
|
|
|
|
PHONY += FORCE
|
|
|
|
FORCE:
|
|
|
|
# Read all saved command lines and dependencies for the $(targets) we
|
|
# may be building above, using $(if_changed{,_dep}). As an
|
|
# optimization, we don't need to read them if the target does not
|
|
# exist, we will rebuild anyway in that case.
|
|
|
|
existing-targets := $(wildcard $(sort $(targets)))
|
|
|
|
-include $(foreach f,$(existing-targets),$(dir $(f)).$(notdir $(f)).cmd)
|
|
|
|
endif
|
|
|
|
.PHONY: $(PHONY)
|