arch: split MODULE_ARCH_VERMAGIC definitions out to <asm/vermagic.h>
Subsystems (12)
PATCH v2 1/1 arch: split MODULE_ARCH_VERMAGIC definitions out to <asm/vermagic.h>
As the bug report [1] pointed out, <linux/vermagic.h> must be included after <linux/module.h>.
I believe we should not impose any include order restriction. We often sort include directives alphabetically, but it is just coding style convention. Technically, we can include header files in any order by making every header self-contained.
Currently, arch-specific MODULE_ARCH_VERMAGIC is defined in <asm/module.h>, which is not included from <linux/vermagic.h>.
Hence, the straight-forward fix-up would be as follows:
|--- a/include/linux/vermagic.h |+++ b/include/linux/vermagic.h |@@ -1,5 +1,6 @@ | /* SPDX-License-Identifier: GPL-2.0 */ | #include <generated/utsrelease.h> |+#include <linux/module.h> | | /* Simply sanity version stamp for modules. */ | #ifdef CONFIG_SMP
This works enough, but for further cleanups, I split MODULE_ARCH_VERMAGIC definitions into <asm/vermagic.h>.
With this, <linux/module.h> and <linux/vermagic.h> will be orthogonal, and the location of MODULE_ARCH_VERMAGIC definitions will be consistent.
For arc and ia64, MODULE_PROC_FAMILY is only used for defining MODULE_ARCH_VERMAGIC. I squashed it.
For hexagon, nds32, and xtensa, I removed <asm/modules.h> entirely because they contained nothing but MODULE_ARCH_VERMAGIC definition. Kbuild will automatically generate <asm/modules.h> at build-time, wrapping <asm-generic/module.h>.
[1] https://lore.kernel.org/lkml/[email protected]
---
I do not mean to replace the work by Leon Romanovsky:
https://lkml.org/lkml/2020/4/19/201
His work intends to hide <linux/vermagic.h> from driver writers. It is solving a different problem.
It does not solve the include order restriction reported by [1]. It still relies on kernel/module.c and *.mod.c
include <linux/vermagic.h> after <linux/module.h>.
I believe we should not impose any restriction about the include order. So, this patch is the direct answer to the bug report [1].
BTW, I think commit f58dd03b1157bdf3b64c36e9525f8d7f69c25df2 was a bad way to suppress the problem, but that is another story.
Changes in v2:
- add include/asm-generic/vermagic.h
- add Reported-by
arch/arc/include/asm/module.h | 5 --
arch/arc/include/asm/vermagic.h | 8 +++
arch/arm/include/asm/module.h | 24 -------
arch/arm/include/asm/vermagic.h | 31 +++++++++
arch/arm64/include/asm/module.h | 2 -
arch/arm64/include/asm/vermagic.h | 10 +++
.../include/asm/{module.h => vermagic.h} | 8 +--
arch/ia64/include/asm/module.h | 4 --
arch/ia64/include/asm/vermagic.h | 15 ++++
arch/mips/include/asm/module.h | 61 -----------------
arch/mips/include/asm/vermagic.h | 66 ++++++++++++++++++
.../include/asm/{module.h => vermagic.h} | 8 +--
arch/powerpc/include/asm/module.h | 18 -----
arch/powerpc/include/asm/vermagic.h | 20 ++++++
arch/riscv/include/asm/module.h | 2 -
arch/riscv/include/asm/vermagic.h | 9 +++
arch/sh/include/asm/module.h | 28 --------
arch/sh/include/asm/vermagic.h | 34 ++++++++++
arch/x86/include/asm/module.h | 60 ----------------
arch/x86/include/asm/vermagic.h | 68 +++++++++++++++++++
.../include/asm/{module.h => vermagic.h} | 13 ++--
include/asm-generic/Kbuild | 1 +
include/asm-generic/vermagic.h | 7 ++
include/linux/vermagic.h | 8 ++-
24 files changed, 287 insertions(+), 223 deletions(-)
create mode 100644 arch/arc/include/asm/vermagic.h
create mode 100644 arch/arm/include/asm/vermagic.h
create mode 100644 arch/arm64/include/asm/vermagic.h
rename arch/hexagon/include/asm/{module.h => vermagic.h} (64%)
create mode 100644 arch/ia64/include/asm/vermagic.h
create mode 100644 arch/mips/include/asm/vermagic.h
rename arch/nds32/include/asm/{module.h => vermagic.h} (52%)
create mode 100644 arch/powerpc/include/asm/vermagic.h
create mode 100644 arch/riscv/include/asm/vermagic.h
create mode 100644 arch/sh/include/asm/vermagic.h
create mode 100644 arch/x86/include/asm/vermagic.h
rename arch/xtensa/include/asm/{module.h => vermagic.h} (72%)
create mode 100644 include/asm-generic/vermagic.harch/arc/include/asm/module.h +0 -5
@@ -3,7 +3,6 @@* Copyright (C) 2004, 2007-2010, 2011-2012 Synopsys, Inc. (www.synopsys.com) * * Amit Bhor, Sameer Dhavale: Codito Technologies 2004 -*/ #ifndef _ASM_ARC_MODULE_H
@@ -19,8 +18,4 @@ struct mod_arch_specific { const char *secstr; }; -#define MODULE_PROC_FAMILY "ARC700" - -#define MODULE_ARCH_VERMAGIC MODULE_PROC_FAMILY -#endif /* _ASM_ARC_MODULE_H */
arch/arc/include/asm/vermagic.h new file +8 -0
@@ -0,0 +1,8 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +#ifndef _ASM_VERMAGIC_H +#define _ASM_VERMAGIC_H + +#define MODULE_ARCH_VERMAGIC "ARC700" + +#endif /* _ASM_VERMAGIC_H */
arch/arm/include/asm/module.h +0 -24
@@ -37,30 +37,6 @@ struct mod_arch_specific {struct module ;u32 get_module_plt (struct module *mod,unsigned long loc,Elf32_Addr val); -/* -* Add the ARM architecture version to the version magic string -*/ -#define MODULE_ARCH_VERMAGIC_ARMVSN "ARMv" __stringify(__LINUX_ARM_ARCH__) " " - -/* Add __virt_to_phys patching state as well */ -#ifdef CONFIG_ARM_PATCH_PHYS_VIRT -#define MODULE_ARCH_VERMAGIC_P2V "p2v8 " -#else -#define MODULE_ARCH_VERMAGIC_P2V "" -#endif - -/* Add instruction set architecture tag to distinguish ARM/Thumb kernels */ -#ifdef CONFIG_THUMB2_KERNEL -#define MODULE_ARCH_VERMAGIC_ARMTHUMB "thumb2 " -#else -#define MODULE_ARCH_VERMAGIC_ARMTHUMB "" -#endif - -#define MODULE_ARCH_VERMAGIC \ - MODULE_ARCH_VERMAGIC_ARMVSN \ - MODULE_ARCH_VERMAGIC_ARMTHUMB \ - MODULE_ARCH_VERMAGIC_P2V -#ifdef CONFIG_THUMB2_KERNEL #define HAVE_ARCH_KALLSYMS_SYMBOL_VALUE static inline unsigned long kallsyms_symbol_value (const Elf_Sym *sym)
arch/arm/include/asm/vermagic.h new file +31 -0
@@ -0,0 +1,31 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +#ifndef _ASM_VERMAGIC_H +#define _ASM_VERMAGIC_H + +#include <linux/stringify.h> + +/* +* Add the ARM architecture version to the version magic string +*/ +#define MODULE_ARCH_VERMAGIC_ARMVSN "ARMv" __stringify(__LINUX_ARM_ARCH__) " " + +/* Add __virt_to_phys patching state as well */ +#ifdef CONFIG_ARM_PATCH_PHYS_VIRT +#define MODULE_ARCH_VERMAGIC_P2V "p2v8 " +#else +#define MODULE_ARCH_VERMAGIC_P2V "" +#endif + +/* Add instruction set architecture tag to distinguish ARM/Thumb kernels */ +#ifdef CONFIG_THUMB2_KERNEL +#define MODULE_ARCH_VERMAGIC_ARMTHUMB "thumb2 " +#else +#define MODULE_ARCH_VERMAGIC_ARMTHUMB "" +#endif + +#define MODULE_ARCH_VERMAGIC \ + MODULE_ARCH_VERMAGIC_ARMVSN \ + MODULE_ARCH_VERMAGIC_ARMTHUMB \ + MODULE_ARCH_VERMAGIC_P2V + +#endif /* _ASM_VERMAGIC_H */
arch/arm64/include/asm/module.h +0 -2
@@ -7,8 +7,6 @@#include <asm-generic/module.h> -#define MODULE_ARCH_VERMAGIC "aarch64" - #ifdef CONFIG_ARM64_MODULE_PLTS struct mod_plt_sec { int plt_shndx;
arch/arm64/include/asm/vermagic.h new file +10 -0
@@ -0,0 +1,10 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* +* Copyright (C) 2012 ARM Ltd. +*/ +#ifndef _ASM_VERMAGIC_H +#define _ASM_VERMAGIC_H + +#define MODULE_ARCH_VERMAGIC "aarch64" + +#endif /* _ASM_VERMAGIC_H */
arch/hexagon/include/asm/vermagic.h renamed from arch/hexagon/include/asm/module.h +4 -4
@@ -3,11 +3,11 @@* Copyright (c) 2010-2011, The Linux Foundation. All rights reserved. */ -#ifndef _ASM_MODULE_H -#define _ASM_MODULE_H +#ifndef _ASM_VERMAGIC_H +#define _ASM_VERMAGIC_H -#include <asm-generic/module.h> +#include <linux/stringify.h> #define MODULE_ARCH_VERMAGIC __stringify(PROCESSOR_MODEL_NAME) " " -#endif +#endif /* _ASM_VERMAGIC_H */
arch/ia64/include/asm/module.h +0 -4
@@ -26,10 +26,6 @@ struct mod_arch_specific { unsigned int next_got_entry; /* index of next available got entry */ }; -#define MODULE_PROC_FAMILY "ia64" -#define MODULE_ARCH_VERMAGIC MODULE_PROC_FAMILY \ - "gcc-" __stringify(__GNUC__) "." __stringify(__GNUC_MINOR__) -#define ARCH_SHF_SMALL SHF_IA_64_SHORT#endif /* _ASM_IA64_MODULE_H */
arch/ia64/include/asm/vermagic.h new file +15 -0
@@ -0,0 +1,15 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* +* Copyright (C) 2003 Hewlett-Packard Co +* David Mosberger-Tang <[email protected]> +*/ + +#ifndef _ASM_VERMAGIC_H +#define _ASM_VERMAGIC_H + +#include <linux/stringify.h> + +#define MODULE_ARCH_VERMAGIC "ia64" \ + "gcc-" __stringify(__GNUC__) "." __stringify(__GNUC_MINOR__) + +#endif /* _ASM_VERMAGIC_H */
arch/mips/include/asm/module.h +0 -61
65 lines not on this page · raw message
arch/mips/include/asm/vermagic.h new file +66 -0
66 lines not on this page · raw message
arch/nds32/include/asm/vermagic.h renamed from arch/nds32/include/asm/module.h +3 -5
@@ -1,11 +1,9 @@/* SPDX-License-Identifier: GPL-2.0 */ // Copyright (C) 2005-2017 Andes Technology Corporation -#ifndef _ASM_NDS32_MODULE_H -#define _ASM_NDS32_MODULE_H - -#include <asm-generic/module.h> +#ifndef _ASM_VERMAGIC_H +#define _ASM_VERMAGIC_H#define MODULE_ARCH_VERMAGIC "NDS32v3" -#endif /* _ASM_NDS32_MODULE_H */ +#endif /* _ASM_VERMAGIC_H */
arch/powerpc/include/asm/module.h +0 -18
@@ -3,28 +3,10 @@#define _ASM_POWERPC_MODULE_H#ifdef __KERNEL__ -/* -*/ -#include <linux/list.h> #include <asm/bug.h> #include <asm-generic/module.h> - -#ifdef CONFIG_MPROFILE_KERNEL -#define MODULE_ARCH_VERMAGIC_FTRACE "mprofile-kernel " -#else -#define MODULE_ARCH_VERMAGIC_FTRACE "" -#endif - -#ifdef CONFIG_RELOCATABLE -#define MODULE_ARCH_VERMAGIC_RELOCATABLE "relocatable " -#else -#define MODULE_ARCH_VERMAGIC_RELOCATABLE "" -#endif - -#define MODULE_ARCH_VERMAGIC MODULE_ARCH_VERMAGIC_FTRACE MODULE_ARCH_VERMAGIC_RELOCATABLE -#ifndef __powerpc64__/* * Thanks to Paul M for explaining this.
arch/powerpc/include/asm/vermagic.h new file +20 -0
@@ -0,0 +1,20 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +#ifndef _ASM_VERMAGIC_H +#define _ASM_VERMAGIC_H + +#ifdef CONFIG_MPROFILE_KERNEL +#define MODULE_ARCH_VERMAGIC_FTRACE "mprofile-kernel " +#else +#define MODULE_ARCH_VERMAGIC_FTRACE "" +#endif + +#ifdef CONFIG_RELOCATABLE +#define MODULE_ARCH_VERMAGIC_RELOCATABLE "relocatable " +#else +#define MODULE_ARCH_VERMAGIC_RELOCATABLE "" +#endif + +#define MODULE_ARCH_VERMAGIC \ + MODULE_ARCH_VERMAGIC_FTRACE MODULE_ARCH_VERMAGIC_RELOCATABLE + +#endif /* _ASM_VERMAGIC_H */
arch/riscv/include/asm/module.h +0 -2
@@ -6,8 +6,6 @@#include <asm-generic/module.h> -#define MODULE_ARCH_VERMAGIC "riscv" -struct module ;unsigned long module_emit_got_entry (struct module *mod,unsigned long val);unsigned long module_emit_plt_entry (struct module *mod,unsigned long val);
arch/riscv/include/asm/vermagic.h new file +9 -0
@@ -0,0 +1,9 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* Copyright (C) 2017 Andes Technology Corporation */ + +#ifndef _ASM_VERMAGIC_H +#define _ASM_VERMAGIC_H + +#define MODULE_ARCH_VERMAGIC "riscv" + +#endif /* _ASM_VERMAGIC_H */
arch/sh/include/asm/module.h +0 -28
@@ -11,32 +11,4 @@ struct mod_arch_specific { };#endif -#ifdef CONFIG_CPU_LITTLE_ENDIAN -# ifdef CONFIG_CPU_SH2 -# define MODULE_PROC_FAMILY "SH2LE " -# elif definedCONFIG_CPU_SH3 -# define MODULE_PROC_FAMILY "SH3LE " -# elif definedCONFIG_CPU_SH4 -# define MODULE_PROC_FAMILY "SH4LE " -# elif definedCONFIG_CPU_SH5 -# define MODULE_PROC_FAMILY "SH5LE " -# else -# error unknown processor family -# endif -#else -# ifdef CONFIG_CPU_SH2 -# define MODULE_PROC_FAMILY "SH2BE " -# elif definedCONFIG_CPU_SH3 -# define MODULE_PROC_FAMILY "SH3BE " -# elif definedCONFIG_CPU_SH4 -# define MODULE_PROC_FAMILY "SH4BE " -# elif definedCONFIG_CPU_SH5 -# define MODULE_PROC_FAMILY "SH5BE " -# else -# error unknown processor family -# endif -#endif - -#define MODULE_ARCH_VERMAGIC MODULE_PROC_FAMILY -#endif /* _ASM_SH_MODULE_H */
arch/sh/include/asm/vermagic.h new file +34 -0
@@ -0,0 +1,34 @@ +/* SPDX-License-Identifier: GPL-2.0 */ + +#ifndef _ASM_VERMAGIC_H +#define _ASM_VERMAGIC_H + +#ifdef CONFIG_CPU_LITTLE_ENDIAN +# ifdef CONFIG_CPU_SH2 +# define MODULE_PROC_FAMILY "SH2LE " +# elif definedCONFIG_CPU_SH3 +# define MODULE_PROC_FAMILY "SH3LE " +# elif definedCONFIG_CPU_SH4 +# define MODULE_PROC_FAMILY "SH4LE " +# elif definedCONFIG_CPU_SH5 +# define MODULE_PROC_FAMILY "SH5LE " +# else +# error unknown processor family +# endif +#else +# ifdef CONFIG_CPU_SH2 +# define MODULE_PROC_FAMILY "SH2BE " +# elif definedCONFIG_CPU_SH3 +# define MODULE_PROC_FAMILY "SH3BE " +# elif definedCONFIG_CPU_SH4 +# define MODULE_PROC_FAMILY "SH4BE " +# elif definedCONFIG_CPU_SH5 +# define MODULE_PROC_FAMILY "SH5BE " +# else +# error unknown processor family +# endif +#endif + +#define MODULE_ARCH_VERMAGIC MODULE_PROC_FAMILY + +#endif /* _ASM_VERMAGIC_H */
arch/x86/include/asm/module.h +0 -60
64 lines not on this page · raw message
arch/x86/include/asm/vermagic.h new file +68 -0
68 lines not on this page · raw message
arch/xtensa/include/asm/vermagic.h renamed from arch/xtensa/include/asm/module.h +6 -7
@@ -1,6 +1,4 @@/* -* include/asm-xtensa/module.h -* * This file contains the module code specific to the Xtensa architecture. * * This file is subject to the terms and conditions of the GNU General Public
@@ -10,11 +8,12 @@* Copyright (C) 2001 - 2005 Tensilica Inc. */ -#ifndef _XTENSA_MODULE_H -#define _XTENSA_MODULE_H +#ifndef _ASM_VERMAGIC_H +#define _ASM_VERMAGIC_H -#define MODULE_ARCH_VERMAGIC "xtensa-" __stringify(XCHAL_CORE_ID) " " +#include <linux/stringify.h> +#include <variant/core.h> -#include <asm-generic/module.h> +#define MODULE_ARCH_VERMAGIC "xtensa-" __stringify(XCHAL_CORE_ID) " " -#endif /* _XTENSA_MODULE_H */ +#endif /* _ASM_VERMAGIC_H */
include/asm-generic/Kbuild +1 -0
@@ -56,6 +56,7 @@ mandatory-y += topology.h mandatory-y += trace_clock.h mandatory-y += uaccess.h mandatory-y += unaligned.h +mandatory-y += vermagic.h mandatory-y += vga.h mandatory-y += word-at-a-time.h mandatory-y += xor.h
include/asm-generic/vermagic.h new file +7 -0
@@ -0,0 +1,7 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +#ifndef _ASM_GENERIC_VERMAGIC_H +#define _ASM_GENERIC_VERMAGIC_H + +#define MODULE_ARCH_VERMAGIC "" + +#endif /* _ASM_GENERIC_VERMAGIC_H */
include/linux/vermagic.h +5 -3
@@ -1,5 +1,9 @@/* SPDX-License-Identifier: GPL-2.0 */ +#ifndef _LINUX_VERMAGIC_H +#define _LINUX_VERMAGIC_H +#include <generated/utsrelease.h> +#include <asm/vermagic.h> /* Simply sanity version stamp for modules. */ #ifdef CONFIG_SMP
@@ -24,9 +28,6 @@#else #define MODULE_VERMAGIC_MODVERSIONS ""#endif -#ifndef MODULE_ARCH_VERMAGIC -#define MODULE_ARCH_VERMAGIC "" -#endif #ifdef RANDSTRUCT_PLUGIN #include <generated/randomize_layout_hash.h> #define MODULE_RANDSTRUCT_PLUGIN "RANDSTRUCT_PLUGIN_" RANDSTRUCT_HASHED_SEED
@@ -41,3 +42,4 @@MODULE_ARCH_VERMAGIC \ MODULE_RANDSTRUCT_PLUGIN +#endif /* _LINUX_VERMAGIC_H */
Signature · 1 line
2.25.1
+++ Masahiro Yamada [22/04/20 01:13 +0900]:
[snip]
arch/xtensa/include/asm/vermagic.h line 2
Quoted 12 lines
arch/xtensa/include/asm/vermagic.h renamed from arch/xtensa/include/asm/module.h +0
-2@@ -1,6 +1,4 @@/* -* include/asm-xtensa/module.h -* * This file contains the module code specific to the Xtensa architecture.
Maybe we can remove this comment too? Since it's now asm/vermagic.h and not asm/module.h anymore.
Thanks for the cleanup. I agree that <linux/vermagic.h> shouldn't have any ordering dependency on <linux/module.h>.
I just double checked to see if there were any other users of MODULE_ARCH_VERMAGIC that needed it through module.h, and there are none. It was literally just being defined in asm/module.h to be used in linux/vermagic.h. So there was no reason really to confine the MODULE_ARCH_VERMAGIC definition to asm/module.h.
Quoted 18 lines · Jessica Yu
+++ Masahiro Yamada [22/04/20 01:13 +0900]:
[snip]arch/xtensa/include/asm/vermagic.h line 2
Quoted 12 lines
arch/xtensa/include/asm/vermagic.h renamed from arch/xtensa/include/asm/module.h +0
-2@@ -1,6 +1,4 @@/* -* include/asm-xtensa/module.h -* * This file contains the module code specific to the Xtensa architecture. Maybe we can remove this comment too? Since it's now
asm/vermagic.hand notasm/module.hanymore.
OK, I will delete it.
Thanks for checking it closely.
Quoted 11 lines
Thanks for the cleanup. I agree that <
linux/vermagic.h> shouldn't have any ordering dependency on <linux/module.h>.I just double checked to see if there were any other users of
MODULE_ARCH_VERMAGICthat needed it throughmodule.h, and there are none. It was literally just being defined inasm/module.hto be used inlinux/vermagic.h. So there was no reason really to confine theMODULE_ARCH_VERMAGICdefinition toasm/module.h.Acked-by Jessica Yu <[email protected]>
Signature · 2 lines
Best Regards Masahiro Yamada