From: Peter Zijlstra <peterz@infradead.org>
To: mcgrof@kernel.org
Cc: x86@kernel.org, hpa@zytor.com, petr.pavlu@suse.com,
samitolvanen@google.com, da.gomez@samsung.com,
masahiroy@kernel.org, nathan@kernel.org, nicolas@fjasle.eu,
linux-kernel@vger.kernel.org, linux-modules@vger.kernel.org,
linux-kbuild@vger.kernel.org, hch@infradead.org,
gregkh@linuxfoundation.org, roypat@amazon.co.uk,
"Peter Zijlstra (Intel)" <peterz@infradead.org>
Subject: [PATCH v3 5/5] module: Provide EXPORT_SYMBOL_GPL_FOR_MODULES() helper
Date: Fri, 02 May 2025 16:12:09 +0200 [thread overview]
Message-ID: <20250502141844.369838967@infradead.org> (raw)
In-Reply-To: 20250502141204.500293812@infradead.org
Helper macro to more easily limit the export of a symbol to a given
list of modules.
Eg:
EXPORT_SYMBOL_GPL_FOR_MODULES(preempt_notifier_inc, "kvm");
will limit the use of said function to kvm.ko, any other module trying
to use this symbol will refure to load (and get modpost build
failures).
Requested-by: Masahiro Yamada <masahiroy@kernel.org>
Requested-by: Christoph Hellwig <hch@infradead.org>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
---
Documentation/core-api/symbol-namespaces.rst | 22 ++++++++++++++++++++++
include/linux/export.h | 12 ++++++++++--
2 files changed, 32 insertions(+), 2 deletions(-)
--- a/Documentation/core-api/symbol-namespaces.rst
+++ b/Documentation/core-api/symbol-namespaces.rst
@@ -28,6 +28,9 @@ kernel. As of today, modules that make u
are required to import the namespace. Otherwise the kernel will, depending on
its configuration, reject loading the module or warn about a missing import.
+Additionally, it is possible to put symbols into a module namespace, strictly
+limiting which modules are allowed to use these symbols.
+
2. How to define Symbol Namespaces
==================================
@@ -83,6 +86,22 @@ A second option to define the default na
within the corresponding compilation unit before the #include for
<linux/export.h>. Typically it's placed before the first #include statement.
+2.3 Using the EXPORT_SYMBOL_GPL_FOR_MODULES() macro
+===================================================
+
+Symbols exported using this macro are put into a module namespace. This
+namespace cannot be imported.
+
+The macro takes a comma separated list of module names, allowing only those
+modules to access this symbol. Simple tail-globs are supported.
+
+For example:
+
+ EXPORT_SYMBOL_GPL_FOR_MODULES(preempt_notifier_inc, "kvm,kvm-*")
+
+will limit usage of this symbol to modules whoes name matches the given
+patterns.
+
3. How to use Symbols exported in Namespaces
============================================
@@ -154,3 +173,6 @@ Again, ``make nsdeps`` will eventually a
You can also run nsdeps for external module builds. A typical usage is::
$ make -C <path_to_kernel_src> M=$PWD nsdeps
+
+Note: it will happily generate an import statement for the module namespace;
+which will not work and generates build and runtime failures.
--- a/include/linux/export.h
+++ b/include/linux/export.h
@@ -24,11 +24,17 @@
.long sym
#endif
-#define ___EXPORT_SYMBOL(sym, license, ns) \
+/*
+ * LLVM integrated assembler cam merge adjacent string literals (like
+ * C and GNU-as) passed to '.ascii', but not to '.asciz' and chokes on:
+ *
+ * .asciz "MODULE_" "kvm" ;
+ */
+#define ___EXPORT_SYMBOL(sym, license, ns...) \
.section ".export_symbol","a" ASM_NL \
__export_symbol_##sym: ASM_NL \
.asciz license ASM_NL \
- .asciz ns ASM_NL \
+ .ascii ns "\0" ASM_NL \
__EXPORT_SYMBOL_REF(sym) ASM_NL \
.previous
@@ -85,4 +91,6 @@
#define EXPORT_SYMBOL_NS(sym, ns) __EXPORT_SYMBOL(sym, "", ns)
#define EXPORT_SYMBOL_NS_GPL(sym, ns) __EXPORT_SYMBOL(sym, "GPL", ns)
+#define EXPORT_SYMBOL_GPL_FOR_MODULES(sym, mods) __EXPORT_SYMBOL(sym, "GPL", "module:" mods)
+
#endif /* _LINUX_EXPORT_H */
next prev parent reply other threads:[~2025-05-02 14:25 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-02 14:12 [PATCH v3 0/5] module: Strict per-modname namespaces Peter Zijlstra
2025-05-02 14:12 ` [PATCH v3 1/5] modpost: Use for() loop Peter Zijlstra
2025-05-09 0:47 ` Masahiro Yamada
2025-05-02 14:12 ` [PATCH v3 2/5] module: Add module specific symbol namespace support Peter Zijlstra
2025-05-03 12:30 ` Masahiro Yamada
2025-05-14 8:34 ` Petr Pavlu
2025-05-17 6:56 ` Masahiro Yamada
2025-05-17 7:19 ` Masahiro Yamada
2025-05-22 5:31 ` Masahiro Yamada
2025-05-02 14:12 ` [PATCH v3 3/5] module: Extend the MODULE_ namespace parsing Peter Zijlstra
2025-05-14 8:35 ` Petr Pavlu
2025-05-21 12:08 ` Masahiro Yamada
2025-05-22 5:32 ` Masahiro Yamada
2025-05-02 14:12 ` [PATCH v3 4/5] module: Account for the build time module name mangling Peter Zijlstra
2025-05-14 8:38 ` Petr Pavlu
2025-05-02 14:12 ` Peter Zijlstra [this message]
2025-05-14 8:40 ` [PATCH v3 5/5] module: Provide EXPORT_SYMBOL_GPL_FOR_MODULES() helper Petr Pavlu
2025-05-02 14:39 ` [PATCH v3 0/5] module: Strict per-modname namespaces Greg KH
2025-05-14 8:47 ` Petr Pavlu
2025-05-17 6:48 ` Masahiro Yamada
2025-05-18 11:30 ` Petr Pavlu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250502141844.369838967@infradead.org \
--to=peterz@infradead.org \
--cc=da.gomez@samsung.com \
--cc=gregkh@linuxfoundation.org \
--cc=hch@infradead.org \
--cc=hpa@zytor.com \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-modules@vger.kernel.org \
--cc=masahiroy@kernel.org \
--cc=mcgrof@kernel.org \
--cc=nathan@kernel.org \
--cc=nicolas@fjasle.eu \
--cc=petr.pavlu@suse.com \
--cc=roypat@amazon.co.uk \
--cc=samitolvanen@google.com \
--cc=x86@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).