Skip to contentSkip to conversation

module: core code clean up

PATCH In review Aaron Tomlin 6 participants 27 messages Mar 22, 2022 – Jun 3, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

v12 cover module: core code clean up

Hi Luis,

As per your suggestion [1], this is an attempt to refactor and split optional code out of core module support code into separate components. This version is based on Linus' commit b47d5a4f6b8d ("Merge tag 'audit-pr-20220321' of
git://git.kernel.org/pub/scm/linux/kernel/git/pcmoore/audit").

No changes in this iteration. Each patch has the same In-Reply-To.

Changes since v10 [2]
- Removed kdb_modules as it is now redundant (Christophe Leroy)
- Removed the include of linux/module.h from any source file under kernel/debug/kdb
- Addressed minor style notice i.e. missing a blank line after declarations

Changes since v9 [3]
- Updated MAINTAINERS to include kernel/module/livepatch.c and kernel/module/kdb.c, respectively
- Moved kdb module related code i.e. support for the 'lsmod', out of core/or main kdb code into its own file under kernel/module
- Ensured is_module_sig_enforced(), as a stub, is available when Kconfig CONFIG_MODULE_SIG is not enabled/or selected (Christophe Leroy)

Changes since v8 [4]

- Resolved the reported lockdep warnings in kernel/module/kallsyms.c (Petr Mladek)

Changes since v7 [5]

- Removed redundant ifdef CONFIG_MODULES and endif pairing from kernel/module/Makefile

Changes since v6 [6]

- Moved KCOV_INSTRUMENT_module.o out of kernel/Makefile into kernel/module/Makefile (Christophe Leroy)
- Moved kernel/module/signature.c back into kernel/ (Christophe Leroy)
- Fixed Oops in add_kallsyms() due to an invalid pointer assignment (Christophe Leroy)

Changes since v5 [7]:

- Updated MAINTAINERS to include the entire kernel/module/ directory (Christophe Leroy)
- Reintroduce commit a97ac8cb24a3 ("module: fix signature check failures when using in-kernel decompression") (Michal Suchánek)
- Refactored code to address some (i.e. --ignore=MULTIPLE_ASSIGNMENTS,ASSIGN_IN_IF was used) style violations e.g. "Alignment should match open parenthesis", reported by scripts/checkpatch.pl --strict (Christophe Leroy)
- Used PAGE_ALIGN() and PAGE_ALIGNED() instead (Christophe Leroy)
- Removed sig_enforce from include/linux/module.h as it is only used in kernel/module/signing.c (Christophe Leroy)
- Added static keyword for anything not used outside a source file (Christophe Leroy)
- Moved mod_sysfs_teardown() to kernel/module/sysfs.c (Christophe Leroy)
- Removed kdb_modules from kernel/debug/kdb/kdb_private.h (Christophe Leroy)

Changes since v4 [7]:

- Moved is_livepatch_module() and set_livepatch_module() to kernel/module/livepatch.c
- Addressed minor compiler warning concerning kernel/module/internal.h (0-day)
- Resolved style violations reported by scripts/checkpatch.pl
- Dropped patch 5 [8] so external patch [9] can be applied at a later date post merge into module-next (Christophe Leroy)

Changes since v3 [10]:

- Refactored both is_livepatch_module() and set_livepatch_module(), respectively, to use IS_ENABLED(CONFIG_LIVEPATCH) (Joe Perches)
- Addressed various compiler warnings e.g., no previous prototype (0-day)

Changes since v2 [11]:

- Moved module decompress support to a separate file
- Made check_modinfo_livepatch() generic (Petr Mladek)
- Removed filename from each newly created file (Luis Chamberlain)
- Addressed some (i.e. --ignore=ASSIGN_IN_IF,AVOID_BUG was used) minor scripts/checkpatch.pl concerns e.g., use strscpy over strlcpy and missing a blank line after declarations (Allen)

Changes since v1 [12]:

- Moved module version support code into a new file

[1]: https://lore.kernel.org/lkml/[email protected]/
[2]: https://lore.kernel.org/lkml/[email protected]/
[3]: https://lore.kernel.org/lkml/[email protected]/
[4]: https://lore.kernel.org/all/[email protected]/
[5]: https://lore.kernel.org/lkml/[email protected]/
[6]: https://lore.kernel.org/lkml/[email protected]/
[7]: https://lore.kernel.org/lkml/[email protected]/
[8]: https://lore.kernel.org/lkml/[email protected]/
[9]: https://lore.kernel.org/lkml/[email protected]/
[10]: https://lore.kernel.org/lkml/203348805c9ac9851d8939d15cb9802ef047b5e2.1643919758.git.christophe.leroy@csgroup.eu/
[11]: https://lore.kernel.org/lkml/[email protected]/
[12]: https://lore.kernel.org/lkml/[email protected]/
[13]: https://lore.kernel.org/lkml/[email protected]/

Aaron Tomlin (14):
module: Move all into module/
module: Simple refactor in preparation for split
module: Make internal.h and decompress.c more compliant
module: Move livepatch support to a separate file
module: Move latched RB-tree support to a separate file
module: Move strict rwx support to a separate file
module: Move extra signature support out of core code
module: Move kmemleak support to a separate file
module: Move kallsyms support into a separate file
module: kallsyms: Fix suspicious rcu usage
module: Move procfs support into a separate file
module: Move sysfs support into a separate file
module: Move kdb module related code out of main kdb code
module: Move version support into a separate file

 MAINTAINERS                                   |    4 +-
 include/linux/kdb.h                           |    1 +
 include/linux/module.h                        |   21 +-
 kernel/Makefile                               |    5 +-
 kernel/debug/kdb/kdb_io.c                     |    1 -
 kernel/debug/kdb/kdb_keyboard.c               |    1 -
 kernel/debug/kdb/kdb_main.c                   |   49 -
 kernel/debug/kdb/kdb_private.h                |    4 -
 kernel/debug/kdb/kdb_support.c                |    1 -
 kernel/module-internal.h                      |   50 -
 kernel/module/Makefile                        |   21 +
 kernel/module/debug_kmemleak.c                |   30 +
 .../decompress.c}                             |    5 +-
 kernel/module/internal.h                      |  275 +++
 kernel/module/kallsyms.c                      |  512 +++++
 kernel/module/kdb.c                           |   56 +
 kernel/module/livepatch.c                     |   74 +
 kernel/{module.c => module/main.c}            | 1856 +----------------
 kernel/module/procfs.c                        |  142 ++
 kernel/module/signing.c                       |  122 ++
 kernel/module/strict_rwx.c                    |   85 +
 kernel/module/sysfs.c                         |  436 ++++
 kernel/module/tree_lookup.c                   |  109 +
 kernel/module/version.c                       |  109 +
 kernel/module_signing.c                       |   45 -
 25 files changed, 2075 insertions(+), 1939 deletions(-)
 delete mode 100644 kernel/module-internal.h
 create mode 100644 kernel/module/Makefile
 create mode 100644 kernel/module/debug_kmemleak.c
 rename kernel/{module_decompress.c => module/decompress.c} (99%)
 create mode 100644 kernel/module/internal.h
 create mode 100644 kernel/module/kallsyms.c
 create mode 100644 kernel/module/kdb.c
 create mode 100644 kernel/module/livepatch.c
 rename kernel/{module.c => module/main.c} (64%)
 create mode 100644 kernel/module/procfs.c
 create mode 100644 kernel/module/signing.c
 create mode 100644 kernel/module/strict_rwx.c
 create mode 100644 kernel/module/sysfs.c
 create mode 100644 kernel/module/tree_lookup.c
 create mode 100644 kernel/module/version.c
 delete mode 100644 kernel/module_signing.c

base-commit: b47d5a4f6b8d42f8a8fbe891b36215e4fddc53be

Signature · 1 line
2.34.1
#1 lore raw

PATCH v12 1/14 module: Move all into module/

No functional changes.

This patch moves all module related code into a separate directory, modifies each file name and creates a new Makefile. Note: this effort is in preparation to refactor core module code.

---
 MAINTAINERS                                         |  2 +-
 kernel/Makefile                                     |  5 +----
 kernel/module/Makefile                              | 12 ++++++++++++
 kernel/{module_decompress.c => module/decompress.c} |  2 +-
 kernel/{module-internal.h => module/internal.h}     |  0
 kernel/{module.c => module/main.c}                  |  2 +-
 kernel/{module_signing.c => module/signing.c}       |  2 +-
 7 files changed, 17 insertions(+), 8 deletions(-)
 create mode 100644 kernel/module/Makefile
 rename kernel/{module_decompress.c => module/decompress.c} (99%)
 rename kernel/{module-internal.h => module/internal.h} (100%)
 rename kernel/{module.c => module/main.c} (99%)
 rename kernel/{module_signing.c => module/signing.c} (97%)
MAINTAINERS +1 -1
index 4386b12f86e8..012c9f55a06d 100644
@@ -13045,7 +13045,7 @@ L:	[email protected]
 S:	Maintained
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/mcgrof/linux.git modules-next
 F:	include/linux/module.h
-F:	kernel/module.c
+F:	kernel/module/
 
 MONOLITHIC POWER SYSTEM PMIC DRIVER
 M:	Saravanan Sekar <[email protected]>
kernel/Makefile +1 -4
index 56f4ee97f328..717075b65deb 100644
@@ -29,7 +29,6 @@ KCOV_INSTRUMENT_softirq.o := n
 KCSAN_SANITIZE_softirq.o = n
 # These are called from save_stack_trace() on slub debug path,
 # and produce insane amounts of uninteresting coverage.
-KCOV_INSTRUMENT_module.o := n
 KCOV_INSTRUMENT_extable.o := n
 KCOV_INSTRUMENT_stacktrace.o := n
 # Don't self-instrument.
@@ -53,6 +52,7 @@ obj-y += rcu/
 obj-y += livepatch/
 obj-y += dma/
 obj-y += entry/
+obj-$(CONFIG_MODULES) += module/
 
 obj-$(CONFIG_KCMP) += kcmp.o
 obj-$(CONFIG_FREEZER) += freezer.o
@@ -66,9 +66,6 @@ ifneq ($(CONFIG_SMP),y)
 obj-y += up.o
 endif
 obj-$(CONFIG_UID16) += uid16.o
-obj-$(CONFIG_MODULES) += module.o
-obj-$(CONFIG_MODULE_DECOMPRESS) += module_decompress.o
-obj-$(CONFIG_MODULE_SIG) += module_signing.o
 obj-$(CONFIG_MODULE_SIG_FORMAT) += module_signature.o
 obj-$(CONFIG_KALLSYMS) += kallsyms.o
 obj-$(CONFIG_BSD_PROCESS_ACCT) += acct.o
kernel/module/Makefile new file +12 -0
new file mode 100644
index 000000000000..cdd5c61b8c7f
@@ -0,0 +1,12 @@
+# SPDX-License-Identifier: GPL-2.0-only
+#
+# Makefile for linux kernel module support
+#
+
+# These are called from save_stack_trace() on slub debug path,
+# and produce insane amounts of uninteresting coverage.
+KCOV_INSTRUMENT_module.o := n
+
+obj-y += main.o
+obj-$(CONFIG_MODULE_DECOMPRESS) += decompress.o
+obj-$(CONFIG_MODULE_SIG) += signing.o
kernel/module/decompress.c renamed from kernel/module_decompress.c +1 -1
similarity index 99%
rename from kernel/module_decompress.c
rename to kernel/module/decompress.c
index ffef98a20320..d14d6443225a 100644
@@ -12,7 +12,7 @@
 #include <linux/sysfs.h>
 #include <linux/vmalloc.h>
 
-#include "module-internal.h"
+#include "internal.h"
 
 static int module_extend_max_pages(struct load_info *info, unsigned int extent)
 {
kernel/module/internal.h renamed from kernel/module-internal.h +0 -0
similarity index 100%
rename from kernel/module-internal.h
rename to kernel/module/internal.h
kernel/module/main.c renamed from kernel/module.c +1 -1
similarity index 99%
rename from kernel/module.c
rename to kernel/module/main.c
index 46a5c2ed1928..34a2b0cf3c3e 100644
@@ -58,7 +58,7 @@
 #include <linux/dynamic_debug.h>
 #include <linux/audit.h>
 #include <uapi/linux/module.h>
-#include "module-internal.h"
+#include "internal.h"
 
 #define CREATE_TRACE_POINTS
 #include <trace/events/module.h>
kernel/module/signing.c renamed from kernel/module_signing.c +1 -1
similarity index 97%
rename from kernel/module_signing.c
rename to kernel/module/signing.c
index 8723ae70ea1f..8aeb6d2ee94b 100644
@@ -12,7 +12,7 @@
 #include <linux/string.h>
 #include <linux/verification.h>
 #include <crypto/public_key.h>
-#include "module-internal.h"
+#include "internal.h"
 
 /*
  * Verify the signature on a module.
Signature · 1 line
2.34.1
#13 lore raw

PATCH v12 3/14 module: Make internal.h and decompress.c more compliant

In reply to Aaron Tomlin

This patch will address the following warning and style violations generated by ./scripts/checkpatch.pl in strict mode:

WARNING: Use #include <linux/module.h> instead of <asm/module.h> #10: FILE: kernel/module/internal.h:10:
+#include <asm/module.h>

CHECK: spaces preferred around that '-' (ctx:VxV) #18: FILE: kernel/module/internal.h:18:
+#define INIT_OFFSET_MASK (1UL << (BITS_PER_LONG-1))

CHECK: Please use a blank line after function/struct/union/enum declarations #69: FILE: kernel/module/internal.h:69:
+}
+static inline void module_decompress_cleanup(struct load_info *info)

						   ^

CHECK: extern prototypes should be avoided in .h files #84: FILE: kernel/module/internal.h:84:
+extern int mod_verify_sig(const void *mod, struct load_info *info);

WARNING: Missing a blank line after declarations #116: FILE: kernel/module/decompress.c:116:
+ struct page *page = module_get_next_page(info);
+ if (!page) {

WARNING: Missing a blank line after declarations #174: FILE: kernel/module/decompress.c:174:
+ struct page *page = module_get_next_page(info);
+ if (!page) {

CHECK: Please use a blank line after function/struct/union/enum declarations #258: FILE: kernel/module/decompress.c:258:
+}
+static struct kobj_attribute module_compression_attr = __ATTR_RO(compression);

Note: Fortunately, the multiple-include optimisation found in include/linux/module.h will prevent duplication/or inclusion more than once.

Fixes f314dfea16a ("modsign: log module name in the event of an error")
---
 kernel/module/decompress.c | 3 +++
 kernel/module/internal.h   | 6 ++++--
 2 files changed, 7 insertions(+), 2 deletions(-)
kernel/module/decompress.c +3 -0
index d14d6443225a..2fc7081dd7c1 100644
@@ -113,6 +113,7 @@ static ssize_t module_gzip_decompress(struct load_info *info,
 
 	do {
 		struct page *page = module_get_next_page(info);
+
 		if (!page) {
 			retval = -ENOMEM;
 			goto out_inflate_end;
@@ -171,6 +172,7 @@ static ssize_t module_xz_decompress(struct load_info *info,
 
 	do {
 		struct page *page = module_get_next_page(info);
+
 		if (!page) {
 			retval = -ENOMEM;
 			goto out;
@@ -256,6 +258,7 @@ static ssize_t compression_show(struct kobject *kobj,
 {
 	return sysfs_emit(buf, "%s\n", __stringify(MODULE_COMPRESSION));
 }
+
 static struct kobj_attribute module_compression_attr = __ATTR_RO(compression);
 
 static int __init module_decompress_sysfs_init(void)
kernel/module/internal.h +4 -2
index ea8c4c02614c..e0775e66bcf7 100644
@@ -6,7 +6,8 @@
  */
 
 #include <linux/elf.h>
-#include <asm/module.h>
+#include <linux/compiler.h>
+#include <linux/module.h>
 #include <linux/mutex.h>
 
 #ifndef ARCH_SHF_SMALL
@@ -54,7 +55,7 @@ struct load_info {
 	} index;
 };
 
-extern int mod_verify_sig(const void *mod, struct load_info *info);
+int mod_verify_sig(const void *mod, struct load_info *info);
 
 #ifdef CONFIG_MODULE_DECOMPRESS
 int module_decompress(struct load_info *info, const void *buf, size_t size);
@@ -65,6 +66,7 @@ static inline int module_decompress(struct load_info *info,
 {
 	return -EOPNOTSUPP;
 }
+
 static inline void module_decompress_cleanup(struct load_info *info)
 {
 }
Signature · 1 line
2.34.1
#14 lore raw

PATCH v12 4/14 module: Move livepatch support to a separate file

In reply to Aaron Tomlin

No functional change.

This patch migrates livepatch support (i.e. used during module add/or load and remove/or deletion) from core module code into kernel/module/livepatch.c. At the moment it contains code to persist Elf information about a given livepatch module, only. The new file was added to MAINTAINERS.

---
 MAINTAINERS               |   1 +
 include/linux/module.h    |   9 ++--
 kernel/module/Makefile    |   1 +
 kernel/module/internal.h  |  22 ++++++++
 kernel/module/livepatch.c |  74 +++++++++++++++++++++++++++
 kernel/module/main.c      | 102 ++++----------------------------------
 6 files changed, 111 insertions(+), 98 deletions(-)
 create mode 100644 kernel/module/livepatch.c
MAINTAINERS +1 -0
index 012c9f55a06d..20205d2ef87c 100644
@@ -11179,6 +11179,7 @@ F:	arch/s390/include/asm/livepatch.h
 F:	arch/x86/include/asm/livepatch.h
 F:	include/linux/livepatch.h
 F:	kernel/livepatch/
+F:	kernel/module/livepatch.c
 F:	lib/livepatch/
 F:	samples/livepatch/
 F:	tools/testing/selftests/livepatch/
include/linux/module.h +3 -6
index 1e135fd5c076..7ec9715de7dc 100644
@@ -663,17 +663,14 @@ static inline bool module_requested_async_probing(struct module *module)
 	return module && module->async_probe_requested;
 }
 
-#ifdef CONFIG_LIVEPATCH
 static inline bool is_livepatch_module(struct module *mod)
 {
+#ifdef CONFIG_LIVEPATCH
 	return mod->klp;
-}
-#else /* !CONFIG_LIVEPATCH */
-static inline bool is_livepatch_module(struct module *mod)
-{
+#else
 	return false;
+#endif
 }
-#endif /* CONFIG_LIVEPATCH */
 
 bool is_module_sig_enforced(void);
 void set_module_sig_enforced(void);
kernel/module/Makefile +1 -0
index cdd5c61b8c7f..ed3aacb04f17 100644
@@ -10,3 +10,4 @@ KCOV_INSTRUMENT_module.o := n
 obj-y += main.o
 obj-$(CONFIG_MODULE_DECOMPRESS) += decompress.o
 obj-$(CONFIG_MODULE_SIG) += signing.o
+obj-$(CONFIG_LIVEPATCH) += livepatch.o
kernel/module/internal.h +22 -0
index e0775e66bcf7..ad7a444253ed 100644
@@ -57,6 +57,28 @@ struct load_info {
 
 int mod_verify_sig(const void *mod, struct load_info *info);
 
+#ifdef CONFIG_LIVEPATCH
+int copy_module_elf(struct module *mod, struct load_info *info);
+void free_module_elf(struct module *mod);
+#else /* !CONFIG_LIVEPATCH */
+static inline int copy_module_elf(struct module *mod, struct load_info *info)
+{
+	return 0;
+}
+
+static inline void free_module_elf(struct module *mod) { }
+#endif /* CONFIG_LIVEPATCH */
+
+static inline bool set_livepatch_module(struct module *mod)
+{
+#ifdef CONFIG_LIVEPATCH
+	mod->klp = true;
+	return true;
+#else
+	return false;
+#endif
+}
+
 #ifdef CONFIG_MODULE_DECOMPRESS
 int module_decompress(struct load_info *info, const void *buf, size_t size);
 void module_decompress_cleanup(struct load_info *info);
kernel/module/livepatch.c new file +74 -0

74 lines not on this page · raw message

kernel/module/main.c +10 -92

121 lines not on this page · raw message

Signature · 1 line
2.34.1
#15 lore raw

PATCH v12 5/14 module: Move latched RB-tree support to a separate file

In reply to Aaron Tomlin

No functional change.

This patch migrates module latched RB-tree support (e.g. see __module_address()) from core module code into kernel/module/tree_lookup.c.

---
 kernel/module/Makefile      |   1 +
 kernel/module/internal.h    |  33 +++++++++
 kernel/module/main.c        | 130 ++----------------------------------
 kernel/module/tree_lookup.c | 109 ++++++++++++++++++++++++++++++
 4 files changed, 147 insertions(+), 126 deletions(-)
 create mode 100644 kernel/module/tree_lookup.c
kernel/module/Makefile +1 -0
index ed3aacb04f17..88774e386276 100644
@@ -11,3 +11,4 @@ obj-y += main.o
 obj-$(CONFIG_MODULE_DECOMPRESS) += decompress.o
 obj-$(CONFIG_MODULE_SIG) += signing.o
 obj-$(CONFIG_LIVEPATCH) += livepatch.o
+obj-$(CONFIG_MODULES_TREE_LOOKUP) += tree_lookup.o
kernel/module/internal.h +33 -0
index ad7a444253ed..f1682e3677be 100644
@@ -9,6 +9,7 @@
 #include <linux/compiler.h>
 #include <linux/module.h>
 #include <linux/mutex.h>
+#include <linux/rculist.h>
 
 #ifndef ARCH_SHF_SMALL
 #define ARCH_SHF_SMALL 0
@@ -93,3 +94,35 @@ static inline void module_decompress_cleanup(struct load_info *info)
 {
 }
 #endif
+
+#ifdef CONFIG_MODULES_TREE_LOOKUP
+struct mod_tree_root {
+	struct latch_tree_root root;
+	unsigned long addr_min;
+	unsigned long addr_max;
+};
+
+extern struct mod_tree_root mod_tree;
+
+void mod_tree_insert(struct module *mod);
+void mod_tree_remove_init(struct module *mod);
+void mod_tree_remove(struct module *mod);
+struct module *mod_find(unsigned long addr);
+#else /* !CONFIG_MODULES_TREE_LOOKUP */
+
+static inline void mod_tree_insert(struct module *mod) { }
+static inline void mod_tree_remove_init(struct module *mod) { }
+static inline void mod_tree_remove(struct module *mod) { }
+static inline struct module *mod_find(unsigned long addr)
+{
+	struct module *mod;
+
+	list_for_each_entry_rcu(mod, &modules, list,
+				lockdep_is_held(&module_mutex)) {
+		if (within_module(addr, mod))
+			return mod;
+	}
+
+	return NULL;
+}
+#endif /* CONFIG_MODULES_TREE_LOOKUP */
kernel/module/main.c +4 -126

142 lines not on this page · raw message

kernel/module/tree_lookup.c new file +109 -0

109 lines not on this page · raw message

Signature · 1 line
2.34.1
#12 lore raw

PATCH v12 2/14 module: Simple refactor in preparation for split

In reply to Aaron Tomlin

No functional change.

This patch makes it possible to move non-essential code out of core module code.

---
 kernel/module/internal.h | 21 +++++++++++++++++++++
 kernel/module/main.c     | 22 ++--------------------
 2 files changed, 23 insertions(+), 20 deletions(-)
kernel/module/internal.h +21 -0
index 8c381c99062f..ea8c4c02614c 100644
@@ -7,6 +7,27 @@
 
 #include <linux/elf.h>
 #include <asm/module.h>
+#include <linux/mutex.h>
+
+#ifndef ARCH_SHF_SMALL
+#define ARCH_SHF_SMALL 0
+#endif
+
+/* If this is set, the section belongs in the init part of the module */
+#define INIT_OFFSET_MASK (1UL << (BITS_PER_LONG - 1))
+/* Maximum number of characters written by module_flags() */
+#define MODULE_FLAGS_BUF_SIZE (TAINT_FLAGS_COUNT + 4)
+
+extern struct mutex module_mutex;
+extern struct list_head modules;
+
+/* Provided by the linker */
+extern const struct kernel_symbol __start___ksymtab[];
+extern const struct kernel_symbol __stop___ksymtab[];
+extern const struct kernel_symbol __start___ksymtab_gpl[];
+extern const struct kernel_symbol __stop___ksymtab_gpl[];
+extern const s32 __start___kcrctab[];
+extern const s32 __start___kcrctab_gpl[];
 
 struct load_info {
 	const char *name;
kernel/module/main.c +2 -20
index 34a2b0cf3c3e..5f5e21f972dd 100644
@@ -63,10 +63,6 @@
 #define CREATE_TRACE_POINTS
 #include <trace/events/module.h>
 
-#ifndef ARCH_SHF_SMALL
-#define ARCH_SHF_SMALL 0
-#endif
-
 /*
  * Modules' sections will be aligned on page boundaries
  * to ensure complete separation of code and data, but
@@ -78,9 +74,6 @@
 # define debug_align(X) (X)
 #endif
 
-/* If this is set, the section belongs in the init part of the module */
-#define INIT_OFFSET_MASK (1UL << (BITS_PER_LONG-1))
-
 /*
  * Mutex protects:
  * 1) List of modules (also safely readable with preempt_disable),
@@ -88,8 +81,8 @@
  * 3) module_addr_min/module_addr_max.
  * (delete and add uses RCU list operations).
  */
-static DEFINE_MUTEX(module_mutex);
-static LIST_HEAD(modules);
+DEFINE_MUTEX(module_mutex);
+LIST_HEAD(modules);
 
 /* Work queue for freeing init sections in success case */
 static void do_free_init(struct work_struct *w);
@@ -408,14 +401,6 @@ static __maybe_unused void *any_section_objs(const struct load_info *info,
 	return (void *)info->sechdrs[sec].sh_addr;
 }
 
-/* Provided by the linker */
-extern const struct kernel_symbol __start___ksymtab[];
-extern const struct kernel_symbol __stop___ksymtab[];
-extern const struct kernel_symbol __start___ksymtab_gpl[];
-extern const struct kernel_symbol __stop___ksymtab_gpl[];
-extern const s32 __start___kcrctab[];
-extern const s32 __start___kcrctab_gpl[];
-
 #ifndef CONFIG_MODVERSIONS
 #define symversion(base, idx) NULL
 #else
@@ -4542,9 +4527,6 @@ static void cfi_cleanup(struct module *mod)
 #endif
 }
 
-/* Maximum number of characters written by module_flags() */
-#define MODULE_FLAGS_BUF_SIZE (TAINT_FLAGS_COUNT + 4)
-
 /* Keep in sync with MODULE_FLAGS_BUF_SIZE !!! */
 static char *module_flags(struct module *mod, char *buf)
 {
Signature · 1 line
2.34.1
#16 lore raw

PATCH v12 6/14 module: Move strict rwx support to a separate file

In reply to Aaron Tomlin

No functional change.

This patch migrates code that makes module text
and rodata memory read-only and non-text memory
non-executable from core module code into
kernel/module/strict_rwx.c.

---
 kernel/module/Makefile     |  1 +
 kernel/module/internal.h   | 32 ++++++++++++
 kernel/module/main.c       | 99 +-------------------------------------
 kernel/module/strict_rwx.c | 85 ++++++++++++++++++++++++++++++++
 4 files changed, 120 insertions(+), 97 deletions(-)
 create mode 100644 kernel/module/strict_rwx.c
kernel/module/Makefile +1 -0
index 88774e386276..d313c8472cb3 100644
@@ -12,3 +12,4 @@ obj-$(CONFIG_MODULE_DECOMPRESS) += decompress.o
 obj-$(CONFIG_MODULE_SIG) += signing.o
 obj-$(CONFIG_LIVEPATCH) += livepatch.o
 obj-$(CONFIG_MODULES_TREE_LOOKUP) += tree_lookup.o
+obj-$(CONFIG_STRICT_MODULE_RWX) += strict_rwx.o
kernel/module/internal.h +32 -0
index f1682e3677be..a6895bb5598a 100644
@@ -20,6 +20,17 @@
 /* Maximum number of characters written by module_flags() */
 #define MODULE_FLAGS_BUF_SIZE (TAINT_FLAGS_COUNT + 4)
 
+/*
+ * Modules' sections will be aligned on page boundaries
+ * to ensure complete separation of code and data, but
+ * only when CONFIG_ARCH_HAS_STRICT_MODULE_RWX=y
+ */
+#ifdef CONFIG_ARCH_HAS_STRICT_MODULE_RWX
+# define debug_align(X) PAGE_ALIGN(X)
+#else
+# define debug_align(X) (X)
+#endif
+
 extern struct mutex module_mutex;
 extern struct list_head modules;
 
@@ -126,3 +137,24 @@ static inline struct module *mod_find(unsigned long addr)
 	return NULL;
 }
 #endif /* CONFIG_MODULES_TREE_LOOKUP */
+
+#ifdef CONFIG_ARCH_HAS_STRICT_MODULE_RWX
+void frob_text(const struct module_layout *layout, int (*set_memory)(unsigned long start,
+								     int num_pages));
+#endif /* CONFIG_ARCH_HAS_STRICT_MODULE_RWX */
+
+#ifdef CONFIG_STRICT_MODULE_RWX
+void module_enable_ro(const struct module *mod, bool after_init);
+void module_enable_nx(const struct module *mod);
+int module_enforce_rwx_sections(Elf_Ehdr *hdr, Elf_Shdr *sechdrs,
+				char *secstrings, struct module *mod);
+
+#else /* !CONFIG_STRICT_MODULE_RWX */
+static inline void module_enable_nx(const struct module *mod) { }
+static inline void module_enable_ro(const struct module *mod, bool after_init) {}
+static inline int module_enforce_rwx_sections(Elf_Ehdr *hdr, Elf_Shdr *sechdrs,
+				       char *secstrings, struct module *mod)
+{
+	return 0;
+}
+#endif /* CONFIG_STRICT_MODULE_RWX */
kernel/module/main.c +2 -97

117 lines not on this page · raw message

kernel/module/strict_rwx.c new file +85 -0

85 lines not on this page · raw message

Signature · 1 line
2.34.1
#17 lore raw

PATCH v12 7/14 module: Move extra signature support out of core code

In reply to Aaron Tomlin

No functional change.

This patch migrates additional module signature check code from core module code into kernel/module/signing.c.

---
 include/linux/module.h   | 12 +++---
 kernel/module/internal.h |  9 +++++
 kernel/module/main.c     | 87 ----------------------------------------
 kernel/module/signing.c  | 77 +++++++++++++++++++++++++++++++++++
 4 files changed, 93 insertions(+), 92 deletions(-)
include/linux/module.h +7 -5
index 7ec9715de7dc..5e2059f3afc7 100644
@@ -672,7 +672,6 @@ static inline bool is_livepatch_module(struct module *mod)
 #endif
 }
 
-bool is_module_sig_enforced(void);
 void set_module_sig_enforced(void);
 
 #else /* !CONFIG_MODULES... */
@@ -799,10 +798,6 @@ static inline bool module_requested_async_probing(struct module *module)
 	return false;
 }
 
-static inline bool is_module_sig_enforced(void)
-{
-	return false;
-}
 
 static inline void set_module_sig_enforced(void)
 {
@@ -854,11 +849,18 @@ static inline bool retpoline_module_ok(bool has_retpoline)
 #endif
 
 #ifdef CONFIG_MODULE_SIG
+bool is_module_sig_enforced(void);
+
 static inline bool module_sig_ok(struct module *module)
 {
 	return module->sig_ok;
 }
 #else	/* !CONFIG_MODULE_SIG */
+static inline bool is_module_sig_enforced(void)
+{
+	return false;
+}
+
 static inline bool module_sig_ok(struct module *module)
 {
 	return true;
kernel/module/internal.h +9 -0
index a6895bb5598a..d6f646a5da41 100644
@@ -158,3 +158,12 @@ static inline int module_enforce_rwx_sections(Elf_Ehdr *hdr, Elf_Shdr *sechdrs,
 	return 0;
 }
 #endif /* CONFIG_STRICT_MODULE_RWX */
+
+#ifdef CONFIG_MODULE_SIG
+int module_sig_check(struct load_info *info, int flags);
+#else /* !CONFIG_MODULE_SIG */
+static inline int module_sig_check(struct load_info *info, int flags)
+{
+	return 0;
+}
+#endif /* !CONFIG_MODULE_SIG */
kernel/module/main.c +0 -87

105 lines not on this page · raw message

kernel/module/signing.c +77 -0

89 lines not on this page · raw message

Signature · 1 line
2.34.1
#18 lore raw

PATCH v12 8/14 module: Move kmemleak support to a separate file

In reply to Aaron Tomlin

No functional change.

This patch migrates kmemleak code out of core module code into kernel/module/debug_kmemleak.c

---
 kernel/module/Makefile         |  1 +
 kernel/module/debug_kmemleak.c | 30 ++++++++++++++++++++++++++++++
 kernel/module/internal.h       |  7 +++++++
 kernel/module/main.c           | 27 ---------------------------
 4 files changed, 38 insertions(+), 27 deletions(-)
 create mode 100644 kernel/module/debug_kmemleak.c
kernel/module/Makefile +1 -0
index d313c8472cb3..12388627725c 100644
@@ -13,3 +13,4 @@ obj-$(CONFIG_MODULE_SIG) += signing.o
 obj-$(CONFIG_LIVEPATCH) += livepatch.o
 obj-$(CONFIG_MODULES_TREE_LOOKUP) += tree_lookup.o
 obj-$(CONFIG_STRICT_MODULE_RWX) += strict_rwx.o
+obj-$(CONFIG_DEBUG_KMEMLEAK) += debug_kmemleak.o
kernel/module/debug_kmemleak.c new file +30 -0
new file mode 100644
index 000000000000..12a569d361e8
@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Module kmemleak support
+ *
+ * Copyright (C) 2009 Catalin Marinas
+ */
+
+#include <linux/module.h>
+#include <linux/kmemleak.h>
+#include "internal.h"
+
+void kmemleak_load_module(const struct module *mod,
+			  const struct load_info *info)
+{
+	unsigned int i;
+
+	/* only scan the sections containing data */
+	kmemleak_scan_area(mod, sizeof(struct module), GFP_KERNEL);
+
+	for (i = 1; i < info->hdr->e_shnum; i++) {
+		/* Scan all writable sections that's not executable */
+		if (!(info->sechdrs[i].sh_flags & SHF_ALLOC) ||
+		    !(info->sechdrs[i].sh_flags & SHF_WRITE) ||
+		    (info->sechdrs[i].sh_flags & SHF_EXECINSTR))
+			continue;
+
+		kmemleak_scan_area((void *)info->sechdrs[i].sh_addr,
+				   info->sechdrs[i].sh_size, GFP_KERNEL);
+	}
+}
kernel/module/internal.h +7 -0
index d6f646a5da41..b0c360839f63 100644
@@ -167,3 +167,10 @@ static inline int module_sig_check(struct load_info *info, int flags)
 	return 0;
 }
 #endif /* !CONFIG_MODULE_SIG */
+
+#ifdef CONFIG_DEBUG_KMEMLEAK
+void kmemleak_load_module(const struct module *mod, const struct load_info *info);
+#else /* !CONFIG_DEBUG_KMEMLEAK */
+static inline void kmemleak_load_module(const struct module *mod,
+					const struct load_info *info) { }
+#endif /* CONFIG_DEBUG_KMEMLEAK */
kernel/module/main.c +0 -27
index c63e10c61694..7dd283959c5c 100644
@@ -2519,33 +2519,6 @@ bool __weak module_exit_section(const char *name)
 	return strstarts(name, ".exit");
 }
 
-#ifdef CONFIG_DEBUG_KMEMLEAK
-static void kmemleak_load_module(const struct module *mod,
-				 const struct load_info *info)
-{
-	unsigned int i;
-
-	/* only scan the sections containing data */
-	kmemleak_scan_area(mod, sizeof(struct module), GFP_KERNEL);
-
-	for (i = 1; i < info->hdr->e_shnum; i++) {
-		/* Scan all writable sections that's not executable */
-		if (!(info->sechdrs[i].sh_flags & SHF_ALLOC) ||
-		    !(info->sechdrs[i].sh_flags & SHF_WRITE) ||
-		    (info->sechdrs[i].sh_flags & SHF_EXECINSTR))
-			continue;
-
-		kmemleak_scan_area((void *)info->sechdrs[i].sh_addr,
-				   info->sechdrs[i].sh_size, GFP_KERNEL);
-	}
-}
-#else
-static inline void kmemleak_load_module(const struct module *mod,
-					const struct load_info *info)
-{
-}
-#endif
-
 static int validate_section_offset(struct load_info *info, Elf_Shdr *shdr)
 {
 #if defined(CONFIG_64BIT)
Signature · 1 line
2.34.1
#20 lore raw

PATCH v12 10/14 module: kallsyms: Fix suspicious rcu usage

In reply to Aaron Tomlin

No functional change.

The purpose of this patch is to address the various Sparse warnings due to the incorrect dereference/or access of an __rcu pointer.

---
 kernel/module/kallsyms.c | 34 ++++++++++++++++++++++------------
 1 file changed, 22 insertions(+), 12 deletions(-)
kernel/module/kallsyms.c +22 -12
index 1b0780e20aab..a3da0686a2a6 100644
@@ -171,14 +171,17 @@ void add_kallsyms(struct module *mod, const struct load_info *info)
 	Elf_Shdr *symsec = &info->sechdrs[info->index.sym];
 
 	/* Set up to point into init section. */
-	mod->kallsyms = mod->init_layout.base + info->mod_kallsyms_init_off;
+	mod->kallsyms = (void __rcu *)mod->init_layout.base +
+		info->mod_kallsyms_init_off;
 
+	preempt_disable();
 	/* The following is safe since this pointer cannot change */
-	mod->kallsyms->symtab = (void *)symsec->sh_addr;
-	mod->kallsyms->num_symtab = symsec->sh_size / sizeof(Elf_Sym);
+	rcu_dereference_sched(mod->kallsyms)->symtab = (void *)symsec->sh_addr;
+	rcu_dereference_sched(mod->kallsyms)->num_symtab = symsec->sh_size / sizeof(Elf_Sym);
 	/* Make sure we get permanent strtab: don't use info->strtab. */
-	mod->kallsyms->strtab = (void *)info->sechdrs[info->index.str].sh_addr;
-	mod->kallsyms->typetab = mod->init_layout.base + info->init_typeoffs;
+	rcu_dereference_sched(mod->kallsyms)->strtab =
+		(void *)info->sechdrs[info->index.str].sh_addr;
+	rcu_dereference_sched(mod->kallsyms)->typetab = mod->init_layout.base + info->init_typeoffs;
 
 	/*
 	 * Now populate the cut down core kallsyms for after init
@@ -187,20 +190,22 @@ void add_kallsyms(struct module *mod, const struct load_info *info)
 	mod->core_kallsyms.symtab = dst = mod->core_layout.base + info->symoffs;
 	mod->core_kallsyms.strtab = s = mod->core_layout.base + info->stroffs;
 	mod->core_kallsyms.typetab = mod->core_layout.base + info->core_typeoffs;
-	src = mod->kallsyms->symtab;
-	for (ndst = i = 0; i < mod->kallsyms->num_symtab; i++) {
-		mod->kallsyms->typetab[i] = elf_type(src + i, info);
+	src = rcu_dereference_sched(mod->kallsyms)->symtab;
+	for (ndst = i = 0; i < rcu_dereference_sched(mod->kallsyms)->num_symtab; i++) {
+		rcu_dereference_sched(mod->kallsyms)->typetab[i] = elf_type(src + i, info);
 		if (i == 0 || is_livepatch_module(mod) ||
 		    is_core_symbol(src + i, info->sechdrs, info->hdr->e_shnum,
 				   info->index.pcpu)) {
 			mod->core_kallsyms.typetab[ndst] =
-			    mod->kallsyms->typetab[i];
+			    rcu_dereference_sched(mod->kallsyms)->typetab[i];
 			dst[ndst] = src[i];
 			dst[ndst++].st_name = s - mod->core_kallsyms.strtab;
-			s += strscpy(s, &mod->kallsyms->strtab[src[i].st_name],
+			s += strscpy(s,
+				     &rcu_dereference_sched(mod->kallsyms)->strtab[src[i].st_name],
 				     KSYM_NAME_LEN) + 1;
 		}
 	}
+	preempt_enable();
 	mod->core_kallsyms.num_symtab = ndst;
 }
 
@@ -478,11 +483,16 @@ int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
 
 	mutex_lock(&module_mutex);
 	list_for_each_entry(mod, &modules, list) {
-		/* We hold module_mutex: no need for rcu_dereference_sched */
-		struct mod_kallsyms *kallsyms = mod->kallsyms;
+		struct mod_kallsyms *kallsyms;
 
 		if (mod->state == MODULE_STATE_UNFORMED)
 			continue;
+
+		/* Use rcu_dereference_sched() to remain compliant with the sparse tool */
+		preempt_disable();
+		kallsyms = rcu_dereference_sched(mod->kallsyms);
+		preempt_enable();
+
 		for (i = 0; i < kallsyms->num_symtab; i++) {
 			const Elf_Sym *sym = &kallsyms->symtab[i];
 
Signature · 1 line
2.34.1
#19 lore raw

PATCH v12 9/14 module: Move kallsyms support into a separate file

In reply to Aaron Tomlin

No functional change.

This patch migrates kallsyms code out of core module code kernel/module/kallsyms.c

---
 kernel/module/Makefile   |   1 +
 kernel/module/internal.h |  29 +++
 kernel/module/kallsyms.c | 502 ++++++++++++++++++++++++++++++++++++
 kernel/module/main.c     | 531 +--------------------------------------
 4 files changed, 538 insertions(+), 525 deletions(-)
 create mode 100644 kernel/module/kallsyms.c
kernel/module/Makefile +1 -0
index 12388627725c..9901bed3ab5b 100644
@@ -14,3 +14,4 @@ obj-$(CONFIG_LIVEPATCH) += livepatch.o
 obj-$(CONFIG_MODULES_TREE_LOOKUP) += tree_lookup.o
 obj-$(CONFIG_STRICT_MODULE_RWX) += strict_rwx.o
 obj-$(CONFIG_DEBUG_KMEMLEAK) += debug_kmemleak.o
+obj-$(CONFIG_KALLSYMS) += kallsyms.o
kernel/module/internal.h +29 -0
index b0c360839f63..44ca05b9eb8f 100644
@@ -68,6 +68,19 @@ struct load_info {
 };
 
 int mod_verify_sig(const void *mod, struct load_info *info);
+struct module *find_module_all(const char *name, size_t len, bool even_unformed);
+int cmp_name(const void *name, const void *sym);
+long module_get_offset(struct module *mod, unsigned int *size, Elf_Shdr *sechdr,
+		       unsigned int section);
+
+static inline unsigned long kernel_symbol_value(const struct kernel_symbol *sym)
+{
+#ifdef CONFIG_HAVE_ARCH_PREL32_RELOCATIONS
+	return (unsigned long)offset_to_ptr(&sym->value_offset);
+#else
+	return sym->value;
+#endif
+}
 
 #ifdef CONFIG_LIVEPATCH
 int copy_module_elf(struct module *mod, struct load_info *info);
@@ -174,3 +187,19 @@ void kmemleak_load_module(const struct module *mod, const struct load_info *info
 static inline void kmemleak_load_module(const struct module *mod,
 					const struct load_info *info) { }
 #endif /* CONFIG_DEBUG_KMEMLEAK */
+
+#ifdef CONFIG_KALLSYMS
+void init_build_id(struct module *mod, const struct load_info *info);
+void layout_symtab(struct module *mod, struct load_info *info);
+void add_kallsyms(struct module *mod, const struct load_info *info);
+unsigned long find_kallsyms_symbol_value(struct module *mod, const char *name);
+
+static inline bool sect_empty(const Elf_Shdr *sect)
+{
+	return !(sect->sh_flags & SHF_ALLOC) || sect->sh_size == 0;
+}
+#else /* !CONFIG_KALLSYMS */
+static inline void init_build_id(struct module *mod, const struct load_info *info) { }
+static inline void layout_symtab(struct module *mod, struct load_info *info) { }
+static inline void add_kallsyms(struct module *mod, const struct load_info *info) { }
+#endif /* CONFIG_KALLSYMS */
kernel/module/kallsyms.c new file +502 -0

502 lines not on this page · raw message

kernel/module/main.c +6 -525

585 lines not on this page · raw message

Signature · 1 line
2.34.1
#21 lore raw

PATCH v12 11/14 module: Move procfs support into a separate file

In reply to Aaron Tomlin

No functional change.

This patch migrates code that allows one to generate a list of loaded/or linked modules via /proc when procfs support is enabled into kernel/module/procfs.c.

---
 kernel/module/Makefile   |   1 +
 kernel/module/internal.h |   1 +
 kernel/module/main.c     | 131 +-----------------------------------
 kernel/module/procfs.c   | 142 +++++++++++++++++++++++++++++++++++++++
 4 files changed, 145 insertions(+), 130 deletions(-)
 create mode 100644 kernel/module/procfs.c
kernel/module/Makefile +1 -0
index 9901bed3ab5b..94296c98a67f 100644
@@ -15,3 +15,4 @@ obj-$(CONFIG_MODULES_TREE_LOOKUP) += tree_lookup.o
 obj-$(CONFIG_STRICT_MODULE_RWX) += strict_rwx.o
 obj-$(CONFIG_DEBUG_KMEMLEAK) += debug_kmemleak.o
 obj-$(CONFIG_KALLSYMS) += kallsyms.o
+obj-$(CONFIG_PROC_FS) += procfs.o
kernel/module/internal.h +1 -0
index 44ca05b9eb8f..6af40c2d145f 100644
@@ -72,6 +72,7 @@ struct module *find_module_all(const char *name, size_t len, bool even_unformed)
 int cmp_name(const void *name, const void *sym);
 long module_get_offset(struct module *mod, unsigned int *size, Elf_Shdr *sechdr,
 		       unsigned int section);
+char *module_flags(struct module *mod, char *buf);
 
 static inline unsigned long kernel_symbol_value(const struct kernel_symbol *sym)
 {
kernel/module/main.c +1 -130

161 lines not on this page · raw message

kernel/module/procfs.c new file +142 -0

142 lines not on this page · raw message

Signature · 1 line
2.34.1
#22 lore raw

PATCH v12 12/14 module: Move sysfs support into a separate file

In reply to Aaron Tomlin

No functional change.

This patch migrates module sysfs support out of core code into kernel/module/sysfs.c. In addition simple code refactoring to make this possible.

---
 kernel/module/Makefile   |   1 +
 kernel/module/internal.h |  21 ++
 kernel/module/main.c     | 469 +--------------------------------------
 kernel/module/sysfs.c    | 436 ++++++++++++++++++++++++++++++++++++
 4 files changed, 461 insertions(+), 466 deletions(-)
 create mode 100644 kernel/module/sysfs.c
kernel/module/Makefile +1 -0
index 94296c98a67f..cf8dcdc6b55f 100644
@@ -16,3 +16,4 @@ obj-$(CONFIG_STRICT_MODULE_RWX) += strict_rwx.o
 obj-$(CONFIG_DEBUG_KMEMLEAK) += debug_kmemleak.o
 obj-$(CONFIG_KALLSYMS) += kallsyms.o
 obj-$(CONFIG_PROC_FS) += procfs.o
+obj-$(CONFIG_SYSFS) += sysfs.o
kernel/module/internal.h +21 -0
index 6af40c2d145f..62d749ef695e 100644
@@ -34,6 +34,9 @@
 extern struct mutex module_mutex;
 extern struct list_head modules;
 
+extern struct module_attribute *modinfo_attrs[];
+extern size_t modinfo_attrs_count;
+
 /* Provided by the linker */
 extern const struct kernel_symbol __start___ksymtab[];
 extern const struct kernel_symbol __stop___ksymtab[];
@@ -204,3 +207,21 @@ static inline void init_build_id(struct module *mod, const struct load_info *inf
 static inline void layout_symtab(struct module *mod, struct load_info *info) { }
 static inline void add_kallsyms(struct module *mod, const struct load_info *info) { }
 #endif /* CONFIG_KALLSYMS */
+
+#ifdef CONFIG_SYSFS
+int mod_sysfs_setup(struct module *mod, const struct load_info *info,
+		    struct kernel_param *kparam, unsigned int num_params);
+void mod_sysfs_teardown(struct module *mod);
+void init_param_lock(struct module *mod);
+#else /* !CONFIG_SYSFS */
+static inline int mod_sysfs_setup(struct module *mod,
+			   	  const struct load_info *info,
+			   	  struct kernel_param *kparam,
+			   	  unsigned int num_params)
+{
+	return 0;
+}
+
+static inline void mod_sysfs_teardown(struct module *mod) { }
+static inline void init_param_lock(struct module *mod) { }
+#endif /* CONFIG_SYSFS */
kernel/module/main.c +3 -466

494 lines not on this page · raw message

kernel/module/sysfs.c new file +436 -0

436 lines not on this page · raw message

Signature · 1 line
2.34.1
#23 lore raw

PATCH v12 13/14 module: Move kdb module related code out of main kdb code

In reply to Aaron Tomlin

No functional change.

This patch migrates the kdb 'lsmod' command support out of main kdb code into its own file under kernel/module. In addition to the above, a minor style warning i.e. missing a blank line after declarations, was resolved too. The new file was added to MAINTAINERS. Finally we remove linux/module.h as it is entirely redundant.

---
 MAINTAINERS                     |  1 +
 include/linux/kdb.h             |  1 +
 kernel/debug/kdb/kdb_io.c       |  1 -
 kernel/debug/kdb/kdb_keyboard.c |  1 -
 kernel/debug/kdb/kdb_main.c     | 49 -----------------------------
 kernel/debug/kdb/kdb_private.h  |  4 ---
 kernel/debug/kdb/kdb_support.c  |  1 -
 kernel/module/Makefile          |  1 +
 kernel/module/kdb.c             | 56 +++++++++++++++++++++++++++++++++
 kernel/module/main.c            |  4 ---
 10 files changed, 59 insertions(+), 60 deletions(-)
 create mode 100644 kernel/module/kdb.c
MAINTAINERS +1 -0
index 20205d2ef87c..2e80adc3c1e1 100644
@@ -10719,6 +10719,7 @@ F:	drivers/tty/serial/kgdboc.c
 F:	include/linux/kdb.h
 F:	include/linux/kgdb.h
 F:	kernel/debug/
+F:	kernel/module/kdb.c
 
 KHADAS MCU MFD DRIVER
 M:	Neil Armstrong <[email protected]>
include/linux/kdb.h +1 -0
index ea0f5e580fac..07dfb6a20a1c 100644
@@ -222,5 +222,6 @@ enum {
 
 extern int kdbgetintenv(const char *, int *);
 extern int kdb_set(int, const char **);
+int kdb_lsmod(int argc, const char **argv);
 
 #endif	/* !_KDB_H */
kernel/debug/kdb/kdb_io.c +0 -1
index 6735ac36b718..67d3c48a1522 100644
@@ -9,7 +9,6 @@
  * Copyright (c) 2009 Wind River Systems, Inc.  All Rights Reserved.
  */
 
-#include <linux/module.h>
 #include <linux/types.h>
 #include <linux/ctype.h>
 #include <linux/kernel.h>
kernel/debug/kdb/kdb_keyboard.c +0 -1
index f877a0a0d7cf..f87c750d3eb3 100644
@@ -11,7 +11,6 @@
 #include <linux/kdb.h>
 #include <linux/keyboard.h>
 #include <linux/ctype.h>
-#include <linux/module.h>
 #include <linux/io.h>
 
 /* Keyboard Controller Registers on normal PCs. */
kernel/debug/kdb/kdb_main.c +0 -49

61 lines not on this page · raw message

kernel/debug/kdb/kdb_private.h +0 -4
index 0d2f9feea0a4..1f8c519a5f81 100644
@@ -226,10 +226,6 @@ extern void kdb_kbd_cleanup_state(void);
 #define kdb_kbd_cleanup_state()
 #endif /* ! CONFIG_KDB_KEYBOARD */
 
-#ifdef CONFIG_MODULES
-extern struct list_head *kdb_modules;
-#endif /* CONFIG_MODULES */
-
 extern char kdb_prompt_str[];
 
 #define	KDB_WORD_SIZE	((int)sizeof(unsigned long))
kernel/debug/kdb/kdb_support.c +0 -1
index df2bface866e..08229ffb6b5e 100644
@@ -17,7 +17,6 @@
 #include <linux/stddef.h>
 #include <linux/vmalloc.h>
 #include <linux/ptrace.h>
-#include <linux/module.h>
 #include <linux/highmem.h>
 #include <linux/hardirq.h>
 #include <linux/delay.h>
kernel/module/Makefile +1 -0
index cf8dcdc6b55f..88f5cdcdb067 100644
@@ -17,3 +17,4 @@ obj-$(CONFIG_DEBUG_KMEMLEAK) += debug_kmemleak.o
 obj-$(CONFIG_KALLSYMS) += kallsyms.o
 obj-$(CONFIG_PROC_FS) += procfs.o
 obj-$(CONFIG_SYSFS) += sysfs.o
+obj-$(CONFIG_KGDB_KDB) += kdb.o
kernel/module/kdb.c new file +56 -0

56 lines not on this page · raw message

kernel/module/main.c +0 -4
index b8a59b5c3e3a..bcc4f7a82649 100644
@@ -108,10 +108,6 @@ static void mod_update_bounds(struct module *mod)
 		__mod_update_bounds(mod->init_layout.base, mod->init_layout.size);
 }
 
-#ifdef CONFIG_KGDB_KDB
-struct list_head *kdb_modules = &modules; /* kdb needs the list of modules */
-#endif /* CONFIG_KGDB_KDB */
-
 static void module_assert_mutex_or_preempt(void)
 {
 #ifdef CONFIG_LOCKDEP
Signature · 1 line
2.34.1
#24 lore raw

PATCH v12 14/14 module: Move version support into a separate file

In reply to Aaron Tomlin

No functional change.

This patch migrates module version support out of core code into kernel/module/version.c. In addition simple code refactoring to make this possible.

---
 kernel/module/Makefile   |   1 +
 kernel/module/internal.h |  48 ++++++++++++
 kernel/module/main.c     | 156 ++-------------------------------------
 kernel/module/version.c  | 109 +++++++++++++++++++++++++++
 4 files changed, 166 insertions(+), 148 deletions(-)
 create mode 100644 kernel/module/version.c
kernel/module/Makefile +1 -0
index 88f5cdcdb067..e2eff9853a28 100644
@@ -18,3 +18,4 @@ obj-$(CONFIG_KALLSYMS) += kallsyms.o
 obj-$(CONFIG_PROC_FS) += procfs.o
 obj-$(CONFIG_SYSFS) += sysfs.o
 obj-$(CONFIG_KGDB_KDB) += kdb.o
+obj-$(CONFIG_MODVERSIONS) += version.o
kernel/module/internal.h +48 -0

58 lines not on this page · raw message

kernel/module/main.c +8 -148

189 lines not on this page · raw message

kernel/module/version.c new file +109 -0

109 lines not on this page · raw message

Signature · 1 line
2.34.1
#25 lore raw
In reply to Aaron Tomlin

Hello,

Quoted 7 lines · Aaron Tomlin

Hi Luis,

As per your suggestion [1], this is an attempt to refactor and split optional code out of core module support code into separate components. This version is based on Linus' commit b47d5a4f6b8d ("Merge tag 'audit-pr-20220321' of
git://git.kernel.org/pub/scm/linux/kernel/git/pcmoore/audit").

git complains when applying this series:
Applying: module: Move sysfs support into a separate file .git/rebase-apply/patch:44: space before tab in indent.
const struct load_info *info,
.git/rebase-apply/patch:45: space before tab in indent.
struct kernel_param *kparam,
.git/rebase-apply/patch:46: space before tab in indent.
unsigned int num_params)
warning: 3 lines add whitespace errors.

Maybe this could be addressed when applying the series.

Thanks

Michal

Quoted 167 lines

No changes in this iteration. Each patch has the same In-Reply-To.

Changes since v10 [2]
- Removed kdb_modules as it is now redundant (Christophe Leroy)
- Removed the include of linux/module.h from any source file under kernel/debug/kdb
- Addressed minor style notice i.e. missing a blank line after declarations

Changes since v9 [3]
- Updated MAINTAINERS to include kernel/module/livepatch.c and kernel/module/kdb.c, respectively
- Moved kdb module related code i.e. support for the 'lsmod', out of core/or main kdb code into its own file under kernel/module
- Ensured is_module_sig_enforced(), as a stub, is available when Kconfig CONFIG_MODULE_SIG is not enabled/or selected (Christophe Leroy)

Changes since v8 [4]

- Resolved the reported lockdep warnings in kernel/module/kallsyms.c (Petr Mladek)

Changes since v7 [5]

- Removed redundant ifdef CONFIG_MODULES and endif pairing from kernel/module/Makefile

Changes since v6 [6]

- Moved KCOV_INSTRUMENT_module.o out of kernel/Makefile into kernel/module/Makefile (Christophe Leroy)
- Moved kernel/module/signature.c back into kernel/ (Christophe Leroy)
- Fixed Oops in add_kallsyms() due to an invalid pointer assignment (Christophe Leroy)

Changes since v5 [7]:

- Updated MAINTAINERS to include the entire kernel/module/ directory (Christophe Leroy)
- Reintroduce commit a97ac8cb24a3 ("module: fix signature check failures when using in-kernel decompression") (Michal Suchánek)
- Refactored code to address some (i.e. --ignore=MULTIPLE_ASSIGNMENTS,ASSIGN_IN_IF was used) style violations e.g. "Alignment should match open parenthesis", reported by scripts/checkpatch.pl --strict (Christophe Leroy)
- Used PAGE_ALIGN() and PAGE_ALIGNED() instead (Christophe Leroy)
- Removed sig_enforce from include/linux/module.h as it is only used in kernel/module/signing.c (Christophe Leroy)
- Added static keyword for anything not used outside a source file (Christophe Leroy)
- Moved mod_sysfs_teardown() to kernel/module/sysfs.c (Christophe Leroy)
- Removed kdb_modules from kernel/debug/kdb/kdb_private.h (Christophe Leroy)

Changes since v4 [7]:

- Moved is_livepatch_module() and set_livepatch_module() to kernel/module/livepatch.c
- Addressed minor compiler warning concerning kernel/module/internal.h (0-day)
- Resolved style violations reported by scripts/checkpatch.pl
- Dropped patch 5 [8] so external patch [9] can be applied at a later date post merge into module-next (Christophe Leroy)

Changes since v3 [10]:

- Refactored both is_livepatch_module() and set_livepatch_module(), respectively, to use IS_ENABLED(CONFIG_LIVEPATCH) (Joe Perches)
- Addressed various compiler warnings e.g., no previous prototype (0-day)

Changes since v2 [11]:

- Moved module decompress support to a separate file
- Made check_modinfo_livepatch() generic (Petr Mladek)
- Removed filename from each newly created file (Luis Chamberlain)
- Addressed some (i.e. --ignore=ASSIGN_IN_IF,AVOID_BUG was used) minor scripts/checkpatch.pl concerns e.g., use strscpy over strlcpy and missing a blank line after declarations (Allen)

Changes since v1 [12]:

- Moved module version support code into a new file

[1]: https://lore.kernel.org/lkml/[email protected]/
[2]: https://lore.kernel.org/lkml/[email protected]/
[3]: https://lore.kernel.org/lkml/[email protected]/
[4]: https://lore.kernel.org/all/[email protected]/
[5]: https://lore.kernel.org/lkml/[email protected]/
[6]: https://lore.kernel.org/lkml/[email protected]/
[7]: https://lore.kernel.org/lkml/[email protected]/
[8]: https://lore.kernel.org/lkml/[email protected]/
[9]: https://lore.kernel.org/lkml/[email protected]/
[10]: https://lore.kernel.org/lkml/203348805c9ac9851d8939d15cb9802ef047b5e2.1643919758.git.christophe.leroy@csgroup.eu/
[11]: https://lore.kernel.org/lkml/[email protected]/
[12]: https://lore.kernel.org/lkml/[email protected]/
[13]: https://lore.kernel.org/lkml/[email protected]/

Aaron Tomlin (14):
module: Move all into module/
module: Simple refactor in preparation for split
module: Make internal.h and decompress.c more compliant
module: Move livepatch support to a separate file
module: Move latched RB-tree support to a separate file
module: Move strict rwx support to a separate file
module: Move extra signature support out of core code
module: Move kmemleak support to a separate file
module: Move kallsyms support into a separate file
module: kallsyms: Fix suspicious rcu usage
module: Move procfs support into a separate file
module: Move sysfs support into a separate file
module: Move kdb module related code out of main kdb code
module: Move version support into a separate file

 MAINTAINERS                                   |    4 +-
 include/linux/kdb.h                           |    1 +
 include/linux/module.h                        |   21 +-
 kernel/Makefile                               |    5 +-
 kernel/debug/kdb/kdb_io.c                     |    1 -
 kernel/debug/kdb/kdb_keyboard.c               |    1 -
 kernel/debug/kdb/kdb_main.c                   |   49 -
 kernel/debug/kdb/kdb_private.h                |    4 -
 kernel/debug/kdb/kdb_support.c                |    1 -
 kernel/module-internal.h                      |   50 -
 kernel/module/Makefile                        |   21 +
 kernel/module/debug_kmemleak.c                |   30 +
 .../decompress.c}                             |    5 +-
 kernel/module/internal.h                      |  275 +++
 kernel/module/kallsyms.c                      |  512 +++++
 kernel/module/kdb.c                           |   56 +
 kernel/module/livepatch.c                     |   74 +
 kernel/{module.c => module/main.c}            | 1856 +----------------
 kernel/module/procfs.c                        |  142 ++
 kernel/module/signing.c                       |  122 ++
 kernel/module/strict_rwx.c                    |   85 +
 kernel/module/sysfs.c                         |  436 ++++
 kernel/module/tree_lookup.c                   |  109 +
 kernel/module/version.c                       |  109 +
 kernel/module_signing.c                       |   45 -
 25 files changed, 2075 insertions(+), 1939 deletions(-)
 delete mode 100644 kernel/module-internal.h
 create mode 100644 kernel/module/Makefile
 create mode 100644 kernel/module/debug_kmemleak.c
 rename kernel/{module_decompress.c => module/decompress.c} (99%)
 create mode 100644 kernel/module/internal.h
 create mode 100644 kernel/module/kallsyms.c
 create mode 100644 kernel/module/kdb.c
 create mode 100644 kernel/module/livepatch.c
 rename kernel/{module.c => module/main.c} (64%)
 create mode 100644 kernel/module/procfs.c
 create mode 100644 kernel/module/signing.c
 create mode 100644 kernel/module/strict_rwx.c
 create mode 100644 kernel/module/sysfs.c
 create mode 100644 kernel/module/tree_lookup.c
 create mode 100644 kernel/module/version.c
 delete mode 100644 kernel/module_signing.c

base-commit: b47d5a4f6b8d42f8a8fbe891b36215e4fddc53be

Signature · 1 line
2.34.1
maintainer
#26 lore raw
In reply to Aaron Tomlin
Quoted 9 lines · Aaron Tomlin

Hi Luis,

As per your suggestion [1], this is an attempt to refactor and split optional code out of core module support code into separate components. This version is based on Linus' commit b47d5a4f6b8d ("Merge tag 'audit-pr-20220321' of
git://git.kernel.org/pub/scm/linux/kernel/git/pcmoore/audit").

No changes in this iteration. Each patch has the same In-Reply-To.

Queued on to modules-testing, thanks!

Luis

#2 lore raw

Re: [PATCH v12 01/14] module: Move all into module/

In reply to Aaron Tomlin
Quoted 1 line · Aaron Tomlin

No functional changes.

I could be mistaken, but I think this has a functional change and could break module signature enforcement in some cases.

Quoted 7 lines

This patch moves all module related code into a separate directory, modifies each file name and creates a new Makefile. Note: this effort is in preparation to refactor core module code.

Quoted 8 lines
---
 MAINTAINERS                                         |  2 +-
 kernel/Makefile                                     |  5 +----
 kernel/module/Makefile                              | 12 ++++++++++++
 kernel/{module_decompress.c => module/decompress.c} |  2 +-
 kernel/{module-internal.h => module/internal.h}     |  0
 kernel/{module.c => module/main.c}                  |  2 +-
 kernel/{module_signing.c => module/signing.c}       |  2 +-

I spent at least an hour trying to figure out how the code below in module/signing.c (was moved from module/main.c in a later patch in this series) managed to have a "module" prefix for "module.sig_enforce" kernel cmdline param and for the /sys/module/module/parameters/sig_enforce file.

static bool sig_enforce = IS_ENABLED(CONFIG_MODULE_SIG_FORCE); module_param(sig_enforce, bool_enable_only, 0644);

I thought I was missing something until I realized this was a very recent change and might actually be a bug. If I'm not mistaken, the prefix will now become "signing". So the kernel cmdline param would get ignore and any userspace writes to /sys/module/module/parameters/sig_enforce will start failing.

I don't have a device to boot 5.19-rcX in, but I think I'm right. Can someone confirm?

If my code analysis is right, then the fix seems to be adding this code before the module_param() line.

kernel/module/signing.c +5 -0
index 85c8999dfecf..6b0672e4417b 100644
@@ -16,6 +16,11 @@
 #include <uapi/linux/module.h>
 #include "internal.h"
 
+#ifdef MODULE_PARAM_PREFIX
+#undef MODULE_PARAM_PREFIX
+#endif
+#define MODULE_PARAM_PREFIX "module."
+
 static bool sig_enforce = IS_ENABLED(CONFIG_MODULE_SIG_FORCE);
 module_param(sig_enforce, bool_enable_only, 0644);
 

-Saravana

#4 lore raw

PATCH 1/1 module: Fix prefix for module.sig_enforce module param

In reply to Aaron Tomlin

Commit cfc1d277891e ("module: Move all into module/") changed the prefix of the module param by moving/renaming files. A later commit also moves the module_param() into a different file, thereby changing the prefix yet again.

This would break kernel cmdline compatibility and also userspace compatibility at /sys/module/module/parameters/sig_enforce.

So, set the prefix back to "module.".

---
Sending this patch in case my analysis in [1] was right.

[1] - https://lore.kernel.org/lkml/[email protected]/

-Saravana

 kernel/module/signing.c | 5 +++++
 1 file changed, 5 insertions(+)
kernel/module/signing.c +5 -0
index 85c8999dfecf..6b0672e4417b 100644
@@ -16,6 +16,11 @@
 #include <uapi/linux/module.h>
 #include "internal.h"
 
+#ifdef MODULE_PARAM_PREFIX
+#undef MODULE_PARAM_PREFIX
+#endif
+#define MODULE_PARAM_PREFIX "module."
+
 static bool sig_enforce = IS_ENABLED(CONFIG_MODULE_SIG_FORCE);
 module_param(sig_enforce, bool_enable_only, 0644);
 
Signature · 1 line
2.36.1.255.ge46751e96f-goog
maintainer
#3 lore raw

Re: [PATCH v12 01/14] module: Move all into module/

In reply to Saravana Kannan
Quoted 47 lines · Saravana Kannan
Quoted 1 line · Aaron Tomlin

No functional changes.

I could be mistaken, but I think this has a functional change and could break module signature enforcement in some cases.

Quoted 7 lines

This patch moves all module related code into a separate directory, modifies each file name and creates a new Makefile. Note: this effort is in preparation to refactor core module code.

Quoted 8 lines
---
 MAINTAINERS                                         |  2 +-
 kernel/Makefile                                     |  5 +----
 kernel/module/Makefile                              | 12 ++++++++++++
 kernel/{module_decompress.c => module/decompress.c} |  2 +-
 kernel/{module-internal.h => module/internal.h}     |  0
 kernel/{module.c => module/main.c}                  |  2 +-
 kernel/{module_signing.c => module/signing.c}       |  2 +-

I spent at least an hour trying to figure out how the code below in module/signing.c (was moved from module/main.c in a later patch in this series) managed to have a "module" prefix for "module.sig_enforce" kernel cmdline param and for the /sys/module/module/parameters/sig_enforce file.

static bool sig_enforce = IS_ENABLED(CONFIG_MODULE_SIG_FORCE); module_param(sig_enforce, bool_enable_only, 0644);

I thought I was missing something until I realized this was a very recent change and might actually be a bug. If I'm not mistaken, the prefix will now become "signing". So the kernel cmdline param would get ignore and any userspace writes to /sys/module/module/parameters/sig_enforce will start failing.

I don't have a device to boot 5.19-rcX in, but I think I'm right. Can someone confirm?

If my code analysis is right, then the fix seems to be adding this code before the module_param() line.

kernel/module/signing.c +0 -0
index 85c8999dfecf..6b0672e4417b 100644

kernel/module/signing.c line 25

Quoted 10 lines
kernel/module/signing.c +5 -0
@@ -16,6 +16,11 @@
 #include <uapi/linux/module.h>
 #include "internal.h"
 
+#ifdef MODULE_PARAM_PREFIX
+#undef MODULE_PARAM_PREFIX
+#endif
+#define MODULE_PARAM_PREFIX "module."
+
 static bool sig_enforce = IS_ENABLED(CONFIG_MODULE_SIG_FORCE);
 module_param(sig_enforce, bool_enable_only, 0644);

That fix would make sense, can you send a proper patch ? The form:

#ifdef MODULE_PARAM_PREFIX
#undef MODULE_PARAM_PREFIX
#endif
#define MODULE_PARAM_PREFIX "whatever."

Is surprisingly actuaclly quite common, later on we should add helper to make these more well known. Right now this is obscure tribal knowledge when splitting up files.

Luis

maintainer Acked-by on v1 1/1
#5 lore raw

Re: [PATCH v1] module: Fix prefix for module.sig_enforce module param

In reply to Saravana Kannan
Quoted 23 lines · Saravana Kannan

Commit cfc1d277891e ("module: Move all into module/") changed the prefix of the module param by moving/renaming files. A later commit also moves the module_param() into a different file, thereby changing the prefix yet again.

This would break kernel cmdline compatibility and also userspace compatibility at /sys/module/module/parameters/sig_enforce.

So, set the prefix back to "module.".

Quoted 8 lines

Linus want to take this in or should I just queueu these up?

Luis

author Reviewed-by on v1 1/1
#11 lore raw

Re: [PATCH v1] module: Fix prefix for module.sig_enforce module param

In reply to Saravana Kannan
Quoted 60 lines · Saravana Kannan

Commit cfc1d277891e ("module: Move all into module/") changed the prefix of the module param by moving/renaming files. A later commit also moves the module_param() into a different file, thereby changing the prefix yet again.

This would break kernel cmdline compatibility and also userspace compatibility at /sys/module/module/parameters/sig_enforce.

So, set the prefix back to "module.".

---
Sending this patch in case my analysis in [1] was right.

[1] - https://lore.kernel.org/lkml/[email protected]/

(quoted diff) +0 -1
-Saravana
 
 kernel/module/signing.c | 5 +++++
 1 file changed, 5 insertions(+)
kernel/module/signing.c +5 -0
index 85c8999dfecf..6b0672e4417b 100644
@@ -16,6 +16,11 @@
 #include <uapi/linux/module.h>
 #include "internal.h"
 
+#ifdef MODULE_PARAM_PREFIX
+#undef MODULE_PARAM_PREFIX
+#endif
+#define MODULE_PARAM_PREFIX "module."
+
 static bool sig_enforce = IS_ENABLED(CONFIG_MODULE_SIG_FORCE);
 module_param(sig_enforce, bool_enable_only, 0644);
 
Signature · 1 line
2.36.1.255.ge46751e96f-goog

Oops! Thanks Saravana.

Signature · 1 line
Aaron Tomlin
#6 lore raw

Re: [PATCH v1] module: Fix prefix for module.sig_enforce module param

In reply to Luis Chamberlain
Quoted 2 lines · Luis Chamberlain

Linus want to take this in or should I just queue these up?

I'll take it, and remove the unnecessary #ifdef/#endif. The #undef might as well be unconditional - simpler and doesn't hurt.

Linus

#7 lore raw

Re: [PATCH v1] module: Fix prefix for module.sig_enforce module param

Quoted 7 lines · Linus Torvalds
Quoted 2 lines · Luis Chamberlain

Linus want to take this in or should I just queue these up?

I'll take it, and remove the unnecessary #ifdef/#endif. The #undef might as well be unconditional - simpler and doesn't hurt.

Sounds good. I just copy-pasted how it was done elsewhere. Luis was mentioning adding a wrapper to go this cleanly and I needed it in another instance too. So I'll look into doing that in a future patch.

-Saravana

maintainer
#8 lore raw

Re: [PATCH v1] module: Fix prefix for module.sig_enforce module param

Quoted 5 lines · Saravana Kannan
Quoted 3 lines · Linus Torvalds
Quoted 1 line · Luis Chamberlain
Quoted 8 lines
Quoted 4 lines
Quoted 1 line

Linus want to take this in or should I just queue these up?

I'll take it, and remove the unnecessary #ifdef/#endif. The #undef might as well be unconditional - simpler and doesn't hurt.

Sounds good. I just copy-pasted how it was done elsewhere. Luis was mentioning adding a wrapper to go this cleanly and I needed it in another instance too. So I'll look into doing that in a future patch.

Virtual hug, or something hippie like that.

Luis

#9 lore raw

Re: [PATCH v1] module: Fix prefix for module.sig_enforce module param

Quoted 9 lines · Luis Chamberlain
Quoted 7 lines · Saravana Kannan
Quoted 5 lines · Linus Torvalds
Quoted 2 lines · Luis Chamberlain

Linus want to take this in or should I just queue these up?

Quoted 8 lines
Quoted 6 lines
Quoted 2 lines

I'll take it, and remove the unnecessary #ifdef/#endif. The #undef might as well be unconditional - simpler and doesn't hurt.

Sounds good. I just copy-pasted how it was done elsewhere. Luis was mentioning adding a wrapper to go this cleanly and I needed it in another instance too. So I'll look into doing that in a future patch.

Virtual hug, or something hippie like that.

Thanks :)

I gave this a shot.

+ #define set_module_param_prefix(prefix) \
+ #undef MODULE_PARAM_PREFIX \
+ #define MODULE_PARAM_PREFIX prefix

I even wrote up a nice chunk of "function doc" before I tried compiling it. And once I compiled it, I was smacked in the head by the compiler for trying to put a #define inside a #define (Duh, the preprocessing in a single pass).

Before I tried this, I looked up the current uses of the "hacky" snippet:

$ git grep -l "define.*MODULE_PARAM_PREFIX" -- :^include/
block/disk-events.c
drivers/misc/cxl/fault.c
drivers/mmc/core/block.c
drivers/pci/pcie/aspm.c
drivers/staging/vc04_services/interface/vchiq_arm/vchiq_arm.c
drivers/tty/serial/8250/8250_core.c
drivers/xen/balloon.c
drivers/xen/events/events_base.c
kernel/debug/kdb/kdb_main.c
kernel/kcsan/core.c
kernel/rcu/tree.c
kernel/rcu/update.c
mm/damon/reclaim.c
mm/kfence/core.c

In a lot of those files, there are a lot of module params that follow this snippet. Going on a tangent, some of the uses of #define MODULE_PARAM_PREFIX don't seem to have any obvious use or param macros.

So adding a module_param_prefixed() doesn't make sense to me either, because I'll have to repeat the same prefix in every usage of module_param_prefixed() AND I'll have to create a _prefixed() variant for other param macros too.

So, something like:
module_param_prefixed("module.", sig_enforce, bool, 644); module_param_prefixed("module.", another_param1, bool, 644); module_param_prefixed("module.", another_param2, bool, 644);

Or replace "module." with a MY_PREFIX so that it's easy to ensure the string is the same across each use:
#define MY_PREFIX "module." module_param_prefixed(MY_PREFIX, sig_enforce, bool, 644); module_param_prefixed(MY_PREFIX, another_param1, bool, 644); module_param_prefixed(MY_PREFIX, another_param2, bool, 644);

But at that point, all I'm avoiding is one #undef MODULE_PARAM_PREFIX and a whole lot of code churn.

One other option is to do something like:
#ifndef MOD_PREFIX
#define MODULE_PARAM_PREFIX KBUILD_MODNAME "."
#else
#define MODULE_PARAM_PREFIX MOD_PREFIX "."
#endif

But that will have the limitation that MOD_PREFIX has to be defined before any #includes is in a file (similar to pr_fmt()) and doesn't allow you to redefine the prefix half way through a file -- which is also a thing that happens in drivers/tty/serial/8250/8250_core.c.

So, long story short, none of these options sound especially appealing that it's worth all the code churn across multiple maintainer trees. Let me know if you have other ideas that might work or you think one of the options I dismissed is actually worth doing.

Thanks,
Saravana

#10 lore raw

Re: [PATCH v1] module: Fix prefix for module.sig_enforce module param

Hi--

Quoted 88 lines · Saravana Kannan
Quoted 9 lines · Luis Chamberlain
Quoted 7 lines · Saravana Kannan
Quoted 5 lines · Linus Torvalds
Quoted 2 lines · Luis Chamberlain

Linus want to take this in or should I just queue these up?

Quoted 8 lines
Quoted 6 lines
Quoted 2 lines

I'll take it, and remove the unnecessary #ifdef/#endif. The #undef might as well be unconditional - simpler and doesn't hurt.

Sounds good. I just copy-pasted how it was done elsewhere. Luis was mentioning adding a wrapper to go this cleanly and I needed it in another instance too. So I'll look into doing that in a future patch.

Virtual hug, or something hippie like that.

Thanks :)

I gave this a shot.

+ #define set_module_param_prefix(prefix) \
+ #undef MODULE_PARAM_PREFIX \
+ #define MODULE_PARAM_PREFIX prefix

I even wrote up a nice chunk of "function doc" before I tried compiling it. And once I compiled it, I was smacked in the head by the compiler for trying to put a #define inside a #define (Duh, the preprocessing in a single pass).

Before I tried this, I looked up the current uses of the "hacky" snippet:

$ git grep -l "define.*MODULE_PARAM_PREFIX" -- :^include/
block/disk-events.c
drivers/misc/cxl/fault.c
drivers/mmc/core/block.c
drivers/pci/pcie/aspm.c
drivers/staging/vc04_services/interface/vchiq_arm/vchiq_arm.c
drivers/tty/serial/8250/8250_core.c
drivers/xen/balloon.c
drivers/xen/events/events_base.c
kernel/debug/kdb/kdb_main.c
kernel/kcsan/core.c
kernel/rcu/tree.c
kernel/rcu/update.c
mm/damon/reclaim.c
mm/kfence/core.c

In a lot of those files, there are a lot of module params that follow this snippet. Going on a tangent, some of the uses of #define MODULE_PARAM_PREFIX don't seem to have any obvious use or param macros.

So adding a module_param_prefixed() doesn't make sense to me either, because I'll have to repeat the same prefix in every usage of module_param_prefixed() AND I'll have to create a _prefixed() variant for other param macros too.

So, something like:
module_param_prefixed("module.", sig_enforce, bool, 644); module_param_prefixed("module.", another_param1, bool, 644); module_param_prefixed("module.", another_param2, bool, 644);

Or replace "module." with a MY_PREFIX so that it's easy to ensure the string is the same across each use:
#define MY_PREFIX "module." module_param_prefixed(MY_PREFIX, sig_enforce, bool, 644); module_param_prefixed(MY_PREFIX, another_param1, bool, 644); module_param_prefixed(MY_PREFIX, another_param2, bool, 644);

But at that point, all I'm avoiding is one #undef MODULE_PARAM_PREFIX and a whole lot of code churn.

One other option is to do something like:
#ifndef MOD_PREFIX
#define MODULE_PARAM_PREFIX KBUILD_MODNAME "."
#else
#define MODULE_PARAM_PREFIX MOD_PREFIX "."
#endif

But that will have the limitation that MOD_PREFIX has to be defined before any #includes is in a file (similar to pr_fmt()) and doesn't allow you to redefine the prefix half way through a file -- which is also a thing that happens in drivers/tty/serial/8250/8250_core.c.

Quoted 4 lines

So, long story short, none of these options sound especially appealing that it's worth all the code churn across multiple maintainer trees. Let me know if you have other ideas that might work or you think one of the options I dismissed is actually worth doing.

I agree with your assessment. Nothing new is needed.

Signature · 1 line
~Randy