Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:5 as permitted sender) client-ip=2620:137:e000::3:5;
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:     Kris Van Hees <kris.van.hees@oracle.com>,
        Steven Rostedt <rostedt@goodmis.org>,
        Luis Chamberlain <mcgrof@kernel.org>,
        Masami Hiramatsu <mhiramat@kernel.org>,
        Nick Desaulniers <ndesaulniers@google.com>,
        Jiri Olsa <olsajiri@gmail.com>
Subject: [PATCH 0/6] Generate address range data for built-in modules
Date:   Fri,  8 Dec 2023 00:07:46 -0500
Message-ID: <20231208050752.2787575-1-kris.van.hees@oracle.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?mr5aB4Mo797Sk7EeK9bhkCAf985wyq7x813AXN9+wjFWa9o5dNn2Wkb6IMGQ?=
 =?us-ascii?Q?W3TbBbl8Zj+WPEzleYqbvzGCs0jB8tgfx4IqgfUykl5Miz34pzTeAPo6guZ0?=
 =?us-ascii?Q?R+eNsBKF/12bnBjrxQltiSznn2w31rrlL6HYyiSOhlPoNkzsmnZTMs7bIoKe?=
 =?us-ascii?Q?F0knh86subPiQk5D81cI+UqyusVrv+p/9J/3P2YLazf7BihDenO/lqwHGyfP?=
 =?us-ascii?Q?4py+XXd6Krxp04T8UxRj7WCkrnIzTaEyt7Jwz+8EP1ykGIj1N2gl1o6+USTs?=
 =?us-ascii?Q?H5Sy85fu9+c2vvD//hKkvgZE/YnigLrEIe0iztHfvFuDqDMaFpLEILAMl3LA?=
 =?us-ascii?Q?DPfeHq/xEMPQky4CSGN3EZdnmgBEVzvus6ugS95dj579PbQDEB6kgX3DsTGp?=
 =?us-ascii?Q?TvU2ve9314wwnKEp+1VHV3Gxa7OhCyjE/eacOrQzknSS6y+nzsV9uKcPZZCb?=
 =?us-ascii?Q?DHB3lK8CPh/IiUKqhF6Y2v/vdP+WD037BKbbhW374JVE/8IqNtEBlLKL4A/R?=
 =?us-ascii?Q?Pwo+/b2VkUQwSLIywo0HCgM5tBoL9c5PLhrfjXHg0AVDHhKZH7gJY1YTNwqD?=
 =?us-ascii?Q?K+3oONKBBBJPNhUe5REh3N8mu53Bk8RlFQtx/JvVdc0HX44JK6RMmw2AtRA3?=
 =?us-ascii?Q?WpBhtCoQgSHo/ILVIfxUUqHe6bDLO1KLIDn47WDX0xP/1WpHEJEyLvjRFhQs?=
 =?us-ascii?Q?rFgChlHqG8ot6G+uqQiSSnuav4acpgkJaWka872J9cX6CyGjGaXf9Mm3LaVC?=
 =?us-ascii?Q?Oyq1RgkNWgY+D2UPcnscE+qnbNnphH6iEIskv0/gO0LQf7+TtrTIVBKiSH2z?=
 =?us-ascii?Q?7TWmQdhbono1T2DzoS0BDtARG5RQw3RyxoNWqiSOnFg1id2hX+brYGnYNLIP?=
 =?us-ascii?Q?IRozH3/j7REIt4rFm6Q5vjlQcb06QmFfMh96lXGhkizJv19w0YsdIIMV06eS?=
 =?us-ascii?Q?+xikiEEebb4eQaAT0DALKkMiF4b5aRa5jwc88L4XOp0lzI3iO6WzhkhA+xgO?=
 =?us-ascii?Q?oqkbwrT4pK9aBoopXzC4B0XcTMvwUjNN7ZTDiquNZapYlZyVHWYsWVjtGW0+?=
 =?us-ascii?Q?Qwptntr2GBdQLx7JXqe222v0mvYtVFLeqUeFOqFSZ+t08k9HGBOGUtATWhfa?=
 =?us-ascii?Q?5g5DMJpEAuZ2jaaCqNQXwdXXZokmdLwLp3m/rIFzZsV7f0ufpXw4mg097bAU?=
 =?us-ascii?Q?ewfOIxd2gf1xG4vhslO68MhMgQYUUIpIQh8n6Idwggro4H+KjQdbmrzU0kPN?=
 =?us-ascii?Q?1GLk8uyve2QlzXp3tJgbEmFGm5oeOtwS5MssRgrkxsh4iaIPeFh7MnwE0UCu?=
 =?us-ascii?Q?sxSsBN4SGT9FMwlfzwjD9G5YBSxWgPKfBq2PL+I+5Di1WWQUiDHKHMmQx/a0?=
 =?us-ascii?Q?OkYWZYuhT9slgbeRXnopu2rXHlDOHhnnCNdAfFRWWOmQ2NypQgsyi8tLjLgY?=
 =?us-ascii?Q?DM3Fop896VbcH6RtKQmCnZZRlY/JyrxAHSsKnCYfVkwqy1DhAn6TClT7LOtm?=
 =?us-ascii?Q?wQcmm9cFyJnntlJVvOk2Bbo+zXB90p5MkdnHOizYRe0PTBhLpqwjC9F/vvhx?=
 =?us-ascii?Q?5Ucnxt0W1VJmzTRK9R2CbO4ah3sVtWnfSWjT7/CzeHOqW6nr7gPD6KZ13sSs?=
 =?us-ascii?Q?hQ=3D=3D?=
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: THamYKQmgI4StmkA4qI7jyKuTwcIVSngRNVDX2SQED12YORtSZhVOJLD85DYSVnfV66tReLJXcVSYeHqe8Qvz1UCajzejtif1BOtI8mp0O61/DYasn7thcN7UTt4Ll3zWOH4r6aP0KK+8FxwtZOn4piqBQ5sHlQMmUw0goOnUeHNLN3DwBw0UqXlEPfm8CgL1svPDQgCwZw+6WOMLB38eIDIjX3bvJU43OHZi+81atXx+UzVfLjwUGTVRlECcrAvf22SWWqXCfnUCtdc207izqnWgq47TTTdVNedeAjzgWOWEzigbk1XQis5VrvWW1gL1ZG0pGddVeJdJ/03SB+v3ULmee3zh6syFEsQCSwEVSYXrEmdDP+PdiDNJDND8EWdAzk67ObOG1BB01TnDrEJ4QS8Y+YWyrY+UdtihltuNjx0nA4ieDKjjzkaG/nUnX0V+KJX7066GxzjTWkayIK5dg5/g9c5Dt/OpTAhX0/C4PwM+xGxpYL+gENccFiNv0+5l7jejCbBJe7QL0d51Wp5PrI3YyShpJDinC3Qim2XGI7lNUHmEh/HmjVX+2bR1P6u+3pll9jb6F+4MxCGzf4D+y9sOFIjqiZFT5ihTAt8oW0WYqQ7WFLk7vPzI3/PW30hph6kch52AAgmFRnRRrcBPw2OtsUH3YOlKMeN+shoCSEFuvCc2C+9yeCe1SYAD5JXS5aCAYIogPP9/5wMml6lBNiLOpUO/frbmncZud3R8rGKZFSIHTIQ/KJncesbt7UzZtzlqd2HTMPxHoL2Lp2g91YNpi7SF95DtLb13XHprDx4Dc1efMb9LalDARlT8gqgoyBnIMWEOPKZPL//Ci4zvGwmrOamxlkxx7SOP56Hq3uI+rUgYdME5JQG5KLVzCzk
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 89b2650c-6b3e-4383-8820-08dbf7abbf7e
X-MS-Exchange-CrossTenant-AuthSource: SN6PR10MB2975.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 08 Dec 2023 05:08:42.9272
 (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: 4LcUXwPOPqMbzt3qRB/qwkivQeef1bw4dQQo3lp3dvlj1EIeMdx5LKXph0MoW+G2Ej0ej4U5tpMInx2m0C0AdvnDKnzjNqbc1jdNwWFphr4=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BLAPR10MB5316
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.272,Aquarius:18.0.997,Hydra:6.0.619,FMLib:17.11.176.26
 definitions=2023-12-08_02,2023-12-07_01,2023-05-22_02
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 mlxscore=0 spamscore=0 malwarescore=0
 bulkscore=0 mlxlogscore=922 phishscore=0 suspectscore=0 adultscore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2311290000
 definitions=main-2312080038
X-Proofpoint-GUID: ABPTVkFxa8-E2wDpfKxwS0WD9mitLVNZ
X-Proofpoint-ORIG-GUID: ABPTVkFxa8-E2wDpfKxwS0WD9mitLVNZ
X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
	DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,
	SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable
	autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on groat.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (groat.vger.email [0.0.0.0]); Thu, 07 Dec 2023 21:10:28 -0800 (PST)

Especially for tracing applications, it is convenient to be able to
refer to a symbol using a <module name, symbol name> pair and to be able
to translate an address into a <nodule mname, symbol name> pair.  But
that does not work if the module is built into the kernel because the
object files that comprise the built-in module implementation are simply
linked into the kernel image along with all other kernel object files.

This is especially visible when providing tracing scripts for support
purposes, where the developer of the script targets a particular kernel
version, but does not have control over whether the target system has
a particular module as loadable module or built-in module.  When tracing
symbols within a module, referring them by <module name, symbol name>
pairs is both convenient and aids symbol lookup.  But that naming will
not work if the module name information is lost if the module is built
into the kernel on the target system.

Earlier work addressing this loss of information for built-in modules
involved adding module name information to the kallsyms data, but that
required more invasive code in the kernel proper.  This work never did
get merged into the kernel tree.

All that is really needed is knowing whether a given address belongs to
a particular module (or multiple modules if they share an object file).
Or in other words, whether that address falls within an address range
that is associated with one or more modules.

This patch series is baaed on Luis Chamberlain's patch to generate
modules.builtin.objs, associating built-in modules with their object
files.  Using this data, vmlinux.o.map and vmlinux.map can be parsed in
a single pass to generate a modules.buitin.ranges file with offset range
information (relative to the base address of the associated section) for
built-in modules.  The file gets installed along with the other
modules.builtin.* files.

The impact on the kernel build is minimal because everything is done
using a single-pass AWK script.  The generated data size is minimal as
well, (depending on the exact kernel configuration) in the range of
500-600 lines, with a file size of 20-30KB.

Kris Van Hees (5):
  module: add CONFIG_BUILTIN_RANGES option
  kbuild: generate a linker map for vmlinux.o
  module: script to generate offset ranges for builtin modules
  kbuild: generate modules.builtin.ranges when linking the kernel
  module: add install target for modules.builtin.ranges

Luis Chamberlain (1):
  kbuild: add modules.builtin.objs

 .gitignore                          |   2 +-
 Documentation/dontdiff              |   2 +-
 Documentation/kbuild/kbuild.rst     |   5 +
 Makefile                            |   8 +-
 include/linux/module.h              |   4 +-
 kernel/module/Kconfig               |  14 +++
 scripts/Makefile.lib                |   5 +-
 scripts/Makefile.modinst            |  11 +-
 scripts/Makefile.vmlinux            |  17 ++++
 scripts/Makefile.vmlinux_o          |  18 +++-
 scripts/generate_builtin_ranges.awk | 149 ++++++++++++++++++++++++++++
 11 files changed, 225 insertions(+), 10 deletions(-)
 create mode 100755 scripts/generate_builtin_ranges.awk


base-commit: 8f34f6b7b6b3260eb6312a19ececcc97908d15b7
-- 
2.42.0