kbuild: create modules.builtin without Makefile.modbuiltin or tristate.conf

Commit bc081dd6e9f6 ("kbuild: generate modules.builtin") added infrastructure to generate modules.builtin, the list of all builtin modules. Basically, it works like this: - Kconfig generates include/config/tristate.conf, the list of tristate CONFIG options with a value in a capital letter. - scripts/Makefile.modbuiltin makes Kbuild descend into directories to collect the information of builtin modules. I am not a big fan of it because Kbuild ends up with traversing the source tree twice. I am not sure how perfectly it should work, but this approach cannot avoid false positives; even if the relevant CONFIG option is tristate, some Makefiles forces obj-m to obj-y. Some examples are: arch/powerpc/platforms/powermac/Makefile: obj-$(CONFIG_NVRAM:m=y) += nvram.o net/ipv6/Makefile: obj-$(subst m,y,$(CONFIG_IPV6)) += inet6_hashtables.o net/netlabel/Makefile: obj-$(subst m,y,$(CONFIG_IPV6)) += netlabel_calipso.o Nobody has complained about (or noticed) it, so it is probably fine to have false positives in modules.builtin. This commit simplifies the implementation. Let's exploit the fact that every module has MODULE_LICENSE(). (modpost shows a warning if MODULE_LICENSE is missing. If so, 0-day bot would already have blocked such a module.) I added MODULE_FILE to <linux/module.h>. When the code is being compiled as builtin, it will be filled with the file path of the module, and collected into modules.builtin.info. Then, scripts/link-vmlinux.sh extracts the list of builtin modules out of it. This new approach fixes the false-positives above, but adds another type of false-positives; non-modular code may have MODULE_LICENSE() by mistake. This is not a big deal, it is just the code is always orphan. We can clean it up if we like. You can see cleanup examples by: $ git log --grep='make.* explicitly non-modular' To sum up, this commits deletes lots of code, but still produces almost equivalent results. Please note it does not increase the vmlinux size at all. As you can see in include/asm-generic/vmlinux.lds.h, the .modinfo section is discarded in the link stage.

Masahiro Yamada committed 6 years ago

Commit 8b41fc41 parent 1664a377 files · +22 −128Browse files

Unified · Split

7 files

Documentation/kbuild/kconfig.rst +0 −5
Makefile +5 −16
include/linux/module.h +11 −1
scripts/Kbuild.include +0 −6
scripts/Makefile.modbuiltin +0 −57
scripts/kconfig/confdata.c +2 −43
scripts/link-vmlinux.sh +4 −0

Documentation/kbuild/kconfig.rst+0−5

@@ -154,11 +154,6 @@ KCONFIG_AUTOCONFIG · 153 unmodified lines
154	This environment variable can be set to specify the path & name of the	154	This environment variable can be set to specify the path & name of the
155	"auto.conf" file. Its default value is "include/config/auto.conf".	155	"auto.conf" file. Its default value is "include/config/auto.conf".
156		156
157	KCONFIG_TRISTATE
158	----------------
159	This environment variable can be set to specify the path & name of the
160	"tristate.conf" file. Its default value is "include/config/tristate.conf".
161
162	KCONFIG_AUTOHEADER	157	KCONFIG_AUTOHEADER
163	------------------	158	------------------
164	This environment variable can be set to specify the path & name of the	159	This environment variable can be set to specify the path & name of the

Makefile+5−16

 #
 # This exploits the 'multi-target pattern rule' trick.
 # The syncconfig should be executed only once to make all the targets.
-%/auto.conf %/auto.conf.cmd %/tristate.conf: $(KCONFIG_CONFIG)
+%/auto.conf %/auto.conf.cmd: $(KCONFIG_CONFIG)
 	$(Q)$(MAKE) -f $(srctree)/Makefile syncconfig
 else # !may-sync-config
 # External modules and some install targets need include/generated/autoconf.h
 # using awk while concatenating to the final file.
 PHONY += modules
-modules: $(if $(KBUILD_BUILTIN),vmlinux) modules.order modules.builtin
+modules: $(if $(KBUILD_BUILTIN),vmlinux) modules.order
 	$(Q)$(MAKE) -f $(srctree)/scripts/Makefile.modpost
 	$(Q)$(CONFIG_SHELL) $(srctree)/scripts/modules-check.sh
 modules.order: descend
 	$(Q)$(AWK) '!x[$$0]++' $(addsuffix /$@, $(build-dirs)) > $@
-modbuiltin-dirs := $(addprefix _modbuiltin_, $(build-dirs))
-modules.builtin: $(modbuiltin-dirs)
-	$(Q)$(AWK) '!x[$$0]++' $(addsuffix /$@, $(build-dirs)) > $@
-PHONY += $(modbuiltin-dirs)
-# tristate.conf is not included from this Makefile. Add it as a prerequisite
-# here to make it self-healing in case somebody accidentally removes it.
-$(modbuiltin-dirs): include/config/tristate.conf
-	$(Q)$(MAKE) $(modbuiltin)=$(patsubst _modbuiltin_%,%,$@)
 # Target to prepare building external modules
 PHONY += modules_prepare
 modules_prepare: prepare
 		ln -s $(CURDIR) $(MODLIB)/build ; \
 	fi
 	@sed 's:^:kernel/:' modules.order > $(MODLIB)/modules.order
-	@sed 's:^:kernel/:' modules.builtin > $(MODLIB)/modules.builtin
+	@cp -f modules.builtin $(MODLIB)/
 	@cp -f $(objtree)/modules.builtin.modinfo $(MODLIB)/
 	$(Q)$(MAKE) -f $(srctree)/scripts/Makefile.modinst
 # Directories & files removed with 'make clean'
 CLEAN_DIRS  += include/ksym
-CLEAN_FILES += modules.builtin.modinfo modules.nsdeps
+CLEAN_FILES += modules.builtin modules.builtin.modinfo modules.nsdeps
 # Directories & files removed with 'make mrproper'
 MRPROPER_DIRS  += include/config include/generated          \
 		-o -name '*.lex.c' -o -name '*.tab.[ch]' \
 		-o -name '*.asn1.[ch]' \
 		-o -name '*.symtypes' -o -name 'modules.order' \
-		-o -name modules.builtin -o -name '.tmp_*.o.*' \
+		-o -name '.tmp_*.o.*' \
 		-o -name '*.c.[012]*.*' \
 		-o -name '*.ll' \
 		-o -name '*.gcno' \) -type f -print | xargs rm -f

include/linux/module.h+11−1

  */
 #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
+/*
+ * MODULE_FILE is used for generating modules.builtin
+ * So, make it no-op when this is being built as a module
+ */
+#ifdef MODULE
+#define MODULE_FILE
+#else
+#define MODULE_FILE	MODULE_INFO(file, KBUILD_MODFILE);
+#endif
 /*
  * The following license idents are currently accepted as indicating free
  * software modules
  * 2.	So the community can ignore bug reports including proprietary modules
  * 3.	So vendors can do likewise based on their own policies
  */
-#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
+#define MODULE_LICENSE(_license) MODULE_FILE MODULE_INFO(license, _license)
 /*
  * Author(s), use "Name <email>" or just "Name", for multiple

scripts/Kbuild.include+0−6

 # $(Q)$(MAKE) $(build)=dir
 build := -f $(srctree)/scripts/Makefile.build obj
-###
-# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.modbuiltin obj=
-# Usage:
-# $(Q)$(MAKE) $(modbuiltin)=dir
-modbuiltin := -f $(srctree)/scripts/Makefile.modbuiltin obj
 ###
 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj=
 # Usage:

scripts/Makefile.modbuiltin+0−57

@@ -1,57 +0,0 @@
1	# SPDX-License-Identifier: GPL-2.0
2	# ==========================================================================
3	# Generating modules.builtin
4	# ==========================================================================
5
6	src := $(obj)
7
8	PHONY := __modbuiltin
9	__modbuiltin:
10
11	include include/config/auto.conf
12	# tristate.conf sets tristate variables to uppercase 'Y' or 'M'
13	# That way, we get the list of built-in modules in obj-Y
14	include include/config/tristate.conf
15
16	include scripts/Kbuild.include
17
18	ifdef building_out_of_srctree
19	# Create output directory if not already present
20	_dummy := $(shell [ -d $(obj) ] \|\| mkdir -p $(obj))
21	endif
22
23	# The filename Kbuild has precedence over Makefile
24	kbuild-dir := $(if $(filter /%,$(src)),$(src),$(srctree)/$(src))
25	kbuild-file := $(if $(wildcard $(kbuild-dir)/Kbuild),$(kbuild-dir)/Kbuild,$(kbuild-dir)/Makefile)
26	include $(kbuild-file)
27
28	include scripts/Makefile.lib
29	__subdir-Y := $(patsubst %/,%,$(filter %/, $(obj-Y)))
30	subdir-Y += $(__subdir-Y)
31	subdir-ym := $(sort $(subdir-y) $(subdir-Y) $(subdir-m))
32	subdir-ym := $(addprefix $(obj)/,$(subdir-ym))
33	obj-Y := $(addprefix $(obj)/,$(obj-Y))
34
35	modbuiltin-subdirs := $(patsubst %,%/modules.builtin, $(subdir-ym))
36	modbuiltin-mods := $(filter %.ko, $(obj-Y:.o=.ko))
37	modbuiltin-target := $(obj)/modules.builtin
38
39	__modbuiltin: $(modbuiltin-target) $(subdir-ym)
40	@:
41
42	$(modbuiltin-target): $(subdir-ym) FORCE
43	$(Q)(for m in $(modbuiltin-mods); do echo $$m; done; \
44	cat /dev/null $(modbuiltin-subdirs)) > $@
45
46	PHONY += FORCE
47
48	FORCE:
49
50	# Descending
51	# ---------------------------------------------------------------------------
52
53	PHONY += $(subdir-ym)
54	$(subdir-ym):
55	$(Q)$(MAKE) $(modbuiltin)=$@
56
57	.PHONY: $(PHONY)

scripts/kconfig/confdata.c+2−43

 	.print_comment = header_print_comment,
 };
-/*
- * Tristate printer
- *
- * This printer is used when generating the `include/config/tristate.conf' file.
- */
-static void
-tristate_print_symbol(FILE *fp, struct symbol *sym, const char *value, void *arg)
-{
-	if (sym->type == S_TRISTATE && *value != 'n')
-		fprintf(fp, "%s%s=%c\n", CONFIG_, sym->name, (char)toupper(*value));
-}
-static struct conf_printer tristate_printer_cb =
-{
-	.print_symbol = tristate_print_symbol,
-	.print_comment = kconfig_print_comment,
-};
 static void conf_write_symbol(FILE *fp, struct symbol *sym,
 			      struct conf_printer *printer, void *printer_arg)
 {
 	struct symbol *sym;
 	const char *name;
 	const char *autoconf_name = conf_get_autoconfig_name();
-	FILE *out, *tristate, *out_h;
+	FILE *out, *out_h;
 	int i;
 	if (!overwrite && is_present(autoconf_name))
 	if (!out)
 		return 1;
-	tristate = fopen(".tmpconfig_tristate", "w");
-	if (!tristate) {
-		fclose(out);
-		return 1;
-	}
 	out_h = fopen(".tmpconfig.h", "w");
 	if (!out_h) {
 		fclose(out);
-		fclose(tristate);
 		return 1;
 	}
 	conf_write_heading(out, &kconfig_printer_cb, NULL);
-	conf_write_heading(tristate, &tristate_printer_cb, NULL);
 	conf_write_heading(out_h, &header_printer_cb, NULL);
 	for_all_symbols(i, sym) {
 		if (!(sym->flags & SYMBOL_WRITE) || !sym->name)
 			continue;
-		/* write symbol to auto.conf, tristate and header files */
+		/* write symbols to auto.conf and autoconf.h */
 		conf_write_symbol(out, sym, &kconfig_printer_cb, (void *)1);
-		conf_write_symbol(tristate, sym, &tristate_printer_cb, (void *)1);
 		conf_write_symbol(out_h, sym, &header_printer_cb, NULL);
 	}
 	fclose(out);
-	fclose(tristate);
 	fclose(out_h);
 	name = getenv("KCONFIG_AUTOHEADER");
 	if (rename(".tmpconfig.h", name))
 		return 1;
-	name = getenv("KCONFIG_TRISTATE");
-	if (!name)
-		name = "include/config/tristate.conf";
-	if (make_parent_dir(name))
-		return 1;
-	if (rename(".tmpconfig_tristate", name))
-		return 1;
 	if (make_parent_dir(autoconf_name))
 		return 1;
 	/*

scripts/link-vmlinux.sh+4−0

 info MODINFO modules.builtin.modinfo
 ${OBJCOPY} -j .modinfo -O binary vmlinux.o modules.builtin.modinfo
+info GEN modules.builtin
+# The second line aids cases where multiple modules share the same object.
+tr '\0' '\n' < modules.builtin.modinfo | sed -n 's/^[[:alnum:]:_]*\.file=//p' |
+	tr ' ' '\n' | uniq | sed -e 's:^:kernel/:' -e 's/$/.ko/' > modules.builtin
 btf_vmlinux_bin_o=""
 if [ -n "${CONFIG_DEBUG_INFO_BTF}" ]; then