Received-SPF: pass (google.com: domain of linux-kernel+bounces-176760-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
From: Kris Van Hees <kris.van.hees@oracle.com>
To: linux-kernel@vger.kernel.org, linux-kbuild@vger.kernel.org,
        linux-modules@vger.kernel.org, linux-trace-kernel@vger.kernel.org
Cc: Luis Chamberlain <mcgrof@kernel.org>, Nick Alcock <nick.alcock@oracle.com>,
        Kris Van Hees <kris.van.hees@oracle.com>,
        Steven Rostedt <rostedt@goodmis.org>,
        Masami Hiramatsu <mhiramat@kernel.org>,
        Nick Desaulniers <ndesaulniers@google.com>,
        Jiri Olsa <olsajiri@gmail.com>,
        Elena Zannoni <elena.zannoni@oracle.com>
Subject: [PATCH v2 1/6] kbuild: add modules.builtin.objs
Date: Sat, 11 May 2024 18:40:30 -0400
Message-ID: <20240511224035.27775-2-kris.van.hees@oracle.com>
In-Reply-To: <20240511224035.27775-1-kris.van.hees@oracle.com>
References: <20240511224035.27775-1-kris.van.hees@oracle.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: 
	=?us-ascii?Q?Aujb3QisBMfVC3OzwXUUXC+xl8PTtfHRzmdYqm7d7uCOZehZAtCVaZpJ3UiS?=
 =?us-ascii?Q?wzw77SxJ//B7gpzfwDpm6M1jRz2MpC/LcgHJYRyZmDaMo7fCRIyo9W7Mvqpy?=
 =?us-ascii?Q?1znEmFwLq5bhB1w7Szcn2IV3NobDUmC4bduq4MFGgq7+kZuDCj3qJCMH6FlU?=
 =?us-ascii?Q?8rDh2Em1W1PL0uOkrjNfHjD59lMvx9AuSBV5T7NHctv5USC5J/wSh1sXg9dh?=
 =?us-ascii?Q?Mc/zH8qT8Ea33FFUSzzZq7/Nx/HljJN9exkpUaLsL/WQClt5N9X3jj9+28gZ?=
 =?us-ascii?Q?h1V6d9mBtObsHA9Ofjzq4taoIVyzG4wlEif6vPCEM6+s14yIXyPlmzgbHMvD?=
 =?us-ascii?Q?seRyT3OPJlenaNjf7tF6CRmZ+5CN7+Ogmn1sslMcDeaT1f0egfj/Be2oDIdo?=
 =?us-ascii?Q?L487jxPiWQeX/OtaP8+MQK+CZfIy2nZx0lcm9ShShjtA0ubWf5TYRG45iDsR?=
 =?us-ascii?Q?XuZw7izS/EHc+IYg0HiAlTihz63jQ4yjrOK26T6xAy6Uf8/LDOzXtjd7vQeB?=
 =?us-ascii?Q?6FiVc1s+SL3YT7mCwSYM1xUzp8QsfsZYx+OeUI0gsGAML99iK/V5TBx9Wop1?=
 =?us-ascii?Q?02cJhDH4p6GmW1s67pE4nhP39vH1zoOg90tpCUsDZEHkzEvx8DiDiqa/KVc5?=
 =?us-ascii?Q?0JN7kLL0wt4UdynpQUt6yNA966HRFfbnCdGlk1Y1F+LAu0Bn/spp2SvBMD8B?=
 =?us-ascii?Q?M/Xyp+vgwEKrl9F184ZB91xfKsLdUsOHkajzL7lwqlLsQxZhNQAeZmIanRSv?=
 =?us-ascii?Q?NkmnrG4+QT2Owd8ULK8JRuMBNY1LHRWq7aSsWz0N2moGQSsCT3JcFnmjukqP?=
 =?us-ascii?Q?V760Fedi8oAEY0ilWxkhQ50vvcliqdWiQki9wysxj9/0MGsXCnpDHXxflBER?=
 =?us-ascii?Q?HElSiTpez9a1MGfbcAB38Ftk5rjCDAiv5/fdTim0ifvX9HDKV6Wo7pUoN3OX?=
 =?us-ascii?Q?IN+f4ud+IcUMDqtErsywpNtvPx09cXQRFMBGBPQhuj+TEeZVBYawjSWlDX3z?=
 =?us-ascii?Q?k8WhcGXnNAxiSmhnBMl9MJimWEK88rpY0NJLzQ7t8E3WXL0m6NI0cf+fL4eO?=
 =?us-ascii?Q?Vy8xLntAbUHgVftBl/afoqmwMKpBffW9bgFtcOs2R9kpyZoQp6JOTAcGJLpZ?=
 =?us-ascii?Q?k+RzOS3O/StbHOxS1oFdd7SKwPVJD0+U2Jd7tPj11JgG8aG8WSLkujua+ZKN?=
 =?us-ascii?Q?T5W8QMY4G0CLfe6Uim2QUxNcam6C2U/Vrofh7fn5lu4DvdE4gcjdxyeSS70k?=
 =?us-ascii?Q?+LV18pEwXkbYyfuv0L/0KVuPLj7aVbavX7KUVy4iUq3JNbMF+BRmzDmu1YNo?=
 =?us-ascii?Q?uNpG/Uarc1vynVawNzI+FUQmx3dHOKKA9GL5S6MJ5cLYb497Xb2hO8Xpr+wi?=
 =?us-ascii?Q?MLLFSNK5lPpJLyVzvILPAvA/8vDD5vJ4zwgGXUYryvS2cPBATQH6S+TR/xdP?=
 =?us-ascii?Q?425dAxVnTv10HCpWJMAEIv3k8h+dKB9x7KUmRV70FeSr/hbFLD9baJqoYGay?=
 =?us-ascii?Q?uW8fQhU1D0odY1I8p5n3IZAut4D5z2DSQ9WrlvHmbgVyeS7JDYfUgYuxY5YT?=
 =?us-ascii?Q?SImqXMrhnQ2F0YsCg5CAvrPVUJyqq8cn2oh/oUedDxkvAbk63FfHbdmfDb6Z?=
 =?us-ascii?Q?Ng=3D=3D?=
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: 
	xJnmqQLd34WBVEM7phKSlEAzC4TdMcxhofaxOF6P3nqsI2ZPuHWSo66RIwh9FCQH2thsVLcsTqB3PizyrrdFqePk0sY7W5zMmc5wZZrAtPT8QJUeoiAo10DAAvWkU3lMu++912ji0VZu8irtC9l++efyCEuvtoKkeNV9aWpuBbwargGdG32L7HQk8YB+enc622ocmjnb44IK/DOu3Q8uqPoveP3SAbSnqk6IOR1e9cXJY8zS7t1EwHe/VIGpZSXuLvN3rbd41bCzJECk0TVLNs5mOkwNi+4p/GOqU5PCPyG+c3Z+svmU4reyL0E3vl/d8ORzfgaNHeia9qpJlC/fNm51iEZw6QJ0+z5JRTa7F6HV/qLdikF1KN7hkDabuHwh/Abbf2iegLoWPncRkFj2U8mcovbJ1bqeiS4p8Srild1pi0xzn0oDK+qoUMD0rLIp+H3pvur22Lkky44V5oDxvfyYz19qisVVZSrfwQXWQnVRfaWyij659Y/lXaI29sXz5VbjBm2+ut/qMiWSmA4vuQUEZcjZSUUkZ8FbMzMfRfFlEKuofoFF6nw5DM224embf0M02Nd3kRwlt3wX6hI0JOw+MC08NDGOgVRQC15tOd8=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 5b1b0a56-44be-45da-8cb9-08dc720b8ec8
X-MS-Exchange-CrossTenant-AuthSource: SN7PR10MB6287.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 May 2024 22:41:54.6202
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: I/uw7ypOPH8h+qltZUXMcPDO1ilUCWyKkBFQk8JFE9hQzViDZEfgeWeZOBY6fwwlypg3HewP+3pWL5zgacUTHAvYvr4AD6iffCkgRfHdOmY=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS7PR10MB5184
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.293,Aquarius:18.0.1039,Hydra:6.0.650,FMLib:17.11.176.26
 definitions=2024-05-11_06,2024-05-10_02,2023-05-22_02
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 malwarescore=0
 spamscore=0 phishscore=0 mlxlogscore=999 bulkscore=0 adultscore=0
 mlxscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2405010000 definitions=main-2405110171
X-Proofpoint-GUID: B66-KBWYOWZ9JbvHPX_T1gTY3oVEY9Sk
X-Proofpoint-ORIG-GUID: B66-KBWYOWZ9JbvHPX_T1gTY3oVEY9Sk

From: Luis Chamberlain <mcgrof@kernel.org>

The file modules.builtin names all modules that are built into the
kernel; this is checked by modprobe to not fail when trying to load
something built-in. But for tools which want to see which object files
make up each module, we want to help them with such a mapping as it is
not easy to get this otherwise.

We do this by just extending scripts/Makefile.lib with a new variable
and define to capture all object files included in this module, store it
in a new objs= modinfo stanza, then extract it just before linking into
a new file modules.builtin.objs with a layout roughly modelled on a
makefile:

path/to/module.o: path/to/constituent.o path/to/other-constituent.o

Single-file built-in modules get a line reading

path/to/module.o:

Note that the .modinfo section is discarded at the link stage, so the
kernel is not bloated at all (see include/asm-generic/vmlinux.lds.h).

Orabug: 29891866
Signed-off-by: Luis Chamberlain <mcgrof@kernel.org>
Signed-off-by: Nick Alcock <nick.alcock@oracle.com>
Reviewed-by: Nick Alcock <nick.alcock@oracle.com>
Reviewed-by: Kris Van Hees <kris.van.hees@oracle.com>
---
Changes since v1:
 - None
---
 .gitignore                      |  2 +-
 Documentation/dontdiff          |  2 +-
 Documentation/kbuild/kbuild.rst |  5 +++++
 Makefile                        |  8 ++++++--
 include/linux/module.h          |  4 +++-
 scripts/Makefile.lib            |  5 ++++-
 scripts/Makefile.modinst        |  6 +++---
 scripts/Makefile.vmlinux_o      | 15 ++++++++++++++-
 8 files changed, 37 insertions(+), 10 deletions(-)

diff --git a/.gitignore b/.gitignore
index c59dc60ba62ef..62ede8565a2aa 100644
--- a/.gitignore
+++ b/.gitignore
@@ -69,7 +69,7 @@ modules.order
 /System.map
 /Module.markers
 /modules.builtin
-/modules.builtin.modinfo
+/modules.builtin.*
 /modules.nsdeps
 
 #
diff --git a/Documentation/dontdiff b/Documentation/dontdiff
index 3c399f132e2db..75b9655e57914 100644
--- a/Documentation/dontdiff
+++ b/Documentation/dontdiff
@@ -179,7 +179,7 @@ mkutf8data
 modpost
 modules-only.symvers
 modules.builtin
-modules.builtin.modinfo
+modules.builtin.*
 modules.nsdeps
 modules.order
 modversions.h*
diff --git a/Documentation/kbuild/kbuild.rst b/Documentation/kbuild/kbuild.rst
index 9c8d1d046ea56..79e104ffee715 100644
--- a/Documentation/kbuild/kbuild.rst
+++ b/Documentation/kbuild/kbuild.rst
@@ -17,6 +17,11 @@ modules.builtin
 This file lists all modules that are built into the kernel. This is used
 by modprobe to not fail when trying to load something builtin.
 
+modules.builtin.objs
+-----------------------
+This file contains object mapping of modules that are built into the kernel
+to their corresponding object files used to build the module.
+
 modules.builtin.modinfo
 -----------------------
 This file contains modinfo from all modules that are built into the kernel.
diff --git a/Makefile b/Makefile
index d51d411d44a82..cc979f9874f5a 100644
--- a/Makefile
+++ b/Makefile
@@ -1140,7 +1140,11 @@ PHONY += vmlinux_o
 vmlinux_o: vmlinux.a $(KBUILD_VMLINUX_LIBS)
 	$(Q)$(MAKE) -f $(srctree)/scripts/Makefile.vmlinux_o
 
-vmlinux.o modules.builtin.modinfo modules.builtin: vmlinux_o
+MODULES_BUILTIN := modules.builtin.modinfo
+MODULES_BUILTIN += modules.builtin
+MODULES_BUILTIN += modules.builtin.objs
+
+vmlinux.o $(MODULES_BUILTIN): vmlinux_o
 	@:
 
 PHONY += vmlinux
@@ -1476,7 +1480,7 @@ endif # CONFIG_MODULES
 
 # Directories & files removed with 'make clean'
 CLEAN_FILES += vmlinux.symvers modules-only.symvers \
-	       modules.builtin modules.builtin.modinfo modules.nsdeps \
+	       modules.builtin modules.builtin.* modules.nsdeps \
 	       compile_commands.json .thinlto-cache rust/test \
 	       rust-project.json .vmlinux.objs .vmlinux.export.c
 
diff --git a/include/linux/module.h b/include/linux/module.h
index 1153b0d99a808..cbfff06e00cd6 100644
--- a/include/linux/module.h
+++ b/include/linux/module.h
@@ -180,7 +180,9 @@ extern void cleanup_module(void);
 #ifdef MODULE
 #define MODULE_FILE
 #else
-#define MODULE_FILE	MODULE_INFO(file, KBUILD_MODFILE);
+#define MODULE_FILE					                      \
+			MODULE_INFO(file, KBUILD_MODFILE);                    \
+			MODULE_INFO(objs, KBUILD_MODOBJS);
 #endif
 
 /*
diff --git a/scripts/Makefile.lib b/scripts/Makefile.lib
index 3179747cbd2cc..3b3baa78d4fbd 100644
--- a/scripts/Makefile.lib
+++ b/scripts/Makefile.lib
@@ -118,6 +118,8 @@ modname-multi = $(sort $(foreach m,$(multi-obj-ym),\
 __modname = $(or $(modname-multi),$(basetarget))
 
 modname = $(subst $(space),:,$(__modname))
+modname-objs = $($(modname)-objs) $($(modname)-y) $($(modname)-Y)
+modname-objs-prefixed = $(sort $(strip $(addprefix $(obj)/, $(modname-objs))))
 modfile = $(addprefix $(obj)/,$(__modname))
 
 # target with $(obj)/ and its suffix stripped
@@ -131,7 +133,8 @@ name-fix = $(call stringify,$(call name-fix-token,$1))
 basename_flags = -DKBUILD_BASENAME=$(call name-fix,$(basetarget))
 modname_flags  = -DKBUILD_MODNAME=$(call name-fix,$(modname)) \
 		 -D__KBUILD_MODNAME=kmod_$(call name-fix-token,$(modname))
-modfile_flags  = -DKBUILD_MODFILE=$(call stringify,$(modfile))
+modfile_flags  = -DKBUILD_MODFILE=$(call stringify,$(modfile)) \
+                 -DKBUILD_MODOBJS=$(call stringify,$(modfile).o:$(subst $(space),|,$(modname-objs-prefixed)))
 
 _c_flags       = $(filter-out $(CFLAGS_REMOVE_$(target-stem).o), \
                      $(filter-out $(ccflags-remove-y), \
diff --git a/scripts/Makefile.modinst b/scripts/Makefile.modinst
index 0afd75472679f..b45586aa1de49 100644
--- a/scripts/Makefile.modinst
+++ b/scripts/Makefile.modinst
@@ -30,10 +30,10 @@ $(MODLIB)/modules.order: modules.order FORCE
 quiet_cmd_install_modorder = INSTALL $@
       cmd_install_modorder = sed 's:^\(.*\)\.o$$:kernel/\1.ko:' $< > $@
 
-# Install modules.builtin(.modinfo) even when CONFIG_MODULES is disabled.
-install-y += $(addprefix $(MODLIB)/, modules.builtin modules.builtin.modinfo)
+# Install modules.builtin(.modinfo,.objs) even when CONFIG_MODULES is disabled.
+install-y += $(addprefix $(MODLIB)/, modules.builtin modules.builtin.modinfo modules.builtin.objs)
 
-$(addprefix $(MODLIB)/, modules.builtin modules.builtin.modinfo): $(MODLIB)/%: % FORCE
+$(addprefix $(MODLIB)/, modules.builtin modules.builtin.modinfo modules.builtin.objs): $(MODLIB)/%: % FORCE
 	$(call cmd,install)
 
 endif
diff --git a/scripts/Makefile.vmlinux_o b/scripts/Makefile.vmlinux_o
index 6de297916ce68..508b3294e2cf1 100644
--- a/scripts/Makefile.vmlinux_o
+++ b/scripts/Makefile.vmlinux_o
@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: GPL-2.0-only
 
 PHONY := __default
-__default: vmlinux.o modules.builtin.modinfo modules.builtin
+__default: vmlinux.o modules.builtin.modinfo modules.builtin modules.builtin.objs
 
 include include/config/auto.conf
 include $(srctree)/scripts/Kbuild.include
@@ -87,6 +87,19 @@ targets += modules.builtin
 modules.builtin: modules.builtin.modinfo FORCE
 	$(call if_changed,modules_builtin)
 
+# module.builtin.objs
+# ---------------------------------------------------------------------------
+quiet_cmd_modules_builtin_objs = GEN     $@
+      cmd_modules_builtin_objs = \
+	tr '\0' '\n' < $< | \
+	sed -n 's/^[[:alnum:]:_]*\.objs=//p' | \
+	tr ' ' '\n' | uniq | sed -e 's|:|: |' -e 's:|: :g' | \
+	tr -s ' ' > $@
+
+targets += modules.builtin.objs
+modules.builtin.objs: modules.builtin.modinfo FORCE
+	$(call if_changed,modules_builtin_objs)
+
 # Add FORCE to the prequisites of a target to force it to be always rebuilt.
 # ---------------------------------------------------------------------------
 
-- 
2.43.0