nvme: fixup module compilation
Subsystems (2)
v5 cover nvme: fixup module compilation
From: Keith Busch <[email protected]>
Trying to sort this out before rc1, here's my take on bringing this together after reading through the history on it.
Changes from previous version:
I updated patch one's keyring stub check to use IS_ENABLED rather than ifdef. The patch makes CONFIG_NVME_SYMBOL possible to be a module now, so ifdef doesn't work correctly with that.
For patch 2, I removed all the Kconfig stuff from the previous, otherwise it's the same. nvme-keyring will not be built-in unless a dependency is also built-in, otherwise it will be a module if another module depends on it.
Arnd Bergmann (1):
nvme: common: make keyring and auth separate modules
Hannes Reinecke (1):
nvme: keyring: fix conditional compilation
drivers/nvme/Makefile | 2 +- drivers/nvme/common/Kconfig | 7 ++----- drivers/nvme/common/Makefile | 7 ++++--- drivers/nvme/common/keyring.c | 11 +++++++---- drivers/nvme/host/Kconfig | 2 -- drivers/nvme/host/core.c | 9 +-------- drivers/nvme/target/Kconfig | 2 -- include/linux/nvme-keyring.h | 10 +--------- 8 files changed, 16 insertions(+), 34 deletions(-)
Signature · 1 line
2.34.1
PATCH v3 1/2 nvme: common: make keyring and auth separate modules
From: Arnd Bergmann <[email protected]>
When only the keyring module is included but auth is not, modpost complains about the lack of a module license tag:
ERROR: modpost: missing MODULE_LICENSE() in drivers/nvme/common/nvme-common.o
Address this by making both modules buildable standalone, removing the now unnecessary CONFIG_NVME_COMMON symbol in the process.
Also, now that NVME_KEYRING config symbol can be either a module or built-in, the stubs need to check for '#if IS_ENABLED' rather than a simple '#ifdef'.
--- drivers/nvme/Makefile | 2 +- drivers/nvme/common/Kconfig | 7 ++----- drivers/nvme/common/Makefile | 7 ++++--- drivers/nvme/common/keyring.c | 2 ++ drivers/nvme/host/Kconfig | 2 -- drivers/nvme/target/Kconfig | 2 -- include/linux/nvme-keyring.h | 2 +- 7 files changed, 10 insertions(+), 14 deletions(-)
drivers/nvme/Makefile +1 -1
@@ -1,5 +1,5 @@ # SPDX-License-Identifier: GPL-2.0-only -obj-$(CONFIG_NVME_COMMON) += common/ +obj-y += common/ obj-y += host/ obj-y += target/
drivers/nvme/common/Kconfig +2 -5
@@ -1,14 +1,11 @@ # SPDX-License-Identifier: GPL-2.0-only -config NVME_COMMON - tristate - config NVME_KEYRING - bool + tristate select KEYS config NVME_AUTH - bool + tristate select CRYPTO select CRYPTO_HMAC select CRYPTO_SHA256
drivers/nvme/common/Makefile +4 -3
@@ -2,7 +2,8 @@ ccflags-y += -I$(src) -obj-$(CONFIG_NVME_COMMON) += nvme-common.o +obj-$(CONFIG_NVME_AUTH) += nvme-auth.o +obj-$(CONFIG_NVME_KEYRING) += nvme-keyring.o -nvme-common-$(CONFIG_NVME_AUTH) += auth.o -nvme-common-$(CONFIG_NVME_KEYRING) += keyring.o +nvme-auth-y += auth.o +nvme-keyring-y += keyring.o
drivers/nvme/common/keyring.c +2 -0
@@ -180,3 +180,5 @@ void nvme_keyring_exit(void)key_put (nvme_keyring); }EXPORT_SYMBOL_GPL (nvme_keyring_exit); + +MODULE_LICENSE ("GPL v2" );
drivers/nvme/host/Kconfig +0 -2
@@ -95,7 +95,6 @@ config NVME_TCP config NVME_TCP_TLS bool "NVMe over Fabrics TCP TLS encryption support" depends on NVME_TCP - select NVME_COMMON select NVME_KEYRING select NET_HANDSHAKE select KEYS
@@ -110,7 +109,6 @@ config NVME_TCP_TLS config NVME_HOST_AUTH bool "NVM Express over Fabrics In-Band Authentication" depends on NVME_CORE - select NVME_COMMON select NVME_AUTH help This provides support for NVMe over Fabrics In-Band Authentication.
drivers/nvme/target/Kconfig +0 -2
@@ -87,7 +87,6 @@ config NVME_TARGET_TCP config NVME_TARGET_TCP_TLS bool "NVMe over Fabrics TCP target TLS encryption support" depends on NVME_TARGET_TCP - select NVME_COMMON select NVME_KEYRING select NET_HANDSHAKE select KEYS
@@ -102,7 +101,6 @@ config NVME_TARGET_TCP_TLS config NVME_TARGET_AUTH bool "NVMe over Fabrics In-band Authentication support" depends on NVME_TARGET - select NVME_COMMON select NVME_AUTH help This enables support for NVMe over Fabrics In-band Authentication
include/linux/nvme-keyring.h +1 -1
@@ -6,7 +6,7 @@#ifndef _NVME_KEYRING_H#define _NVME_KEYRING_H -#ifdef CONFIG_NVME_KEYRING +#if IS_ENABLED (CONFIG_NVME_KEYRING )key_serial_t nvme_tls_psk_default (struct key *keyring,const char *hostnqn,const char *subnqn);
Signature · 1 line
2.34.1
Christoph Hellwig
maintainerRe: [PATCHv3 1/2] nvme: common: make keyring and auth separate modules
Quoted 7 lines · Keith Busch
From: Arnd Bergmann <[email protected]>
When only the keyring module is included but auth is not, modpost complains about the lack of a module license tag:
ERROR: modpost: missing
MODULE_LICENSE()indrivers/nvme/common/nvme-common.o
Quoted 7 lines
Address this by making both modules buildable standalone, removing the now unnecessary
CONFIG_NVME_COMMONsymbol in the process.Also, now that
NVME_KEYRINGconfig symbol can be either a module or built-in, the stubs need to check for '#ifIS_ENABLED' rather than a simple '#ifdef'.
I know I reviewed this before, but after the whole discussion this splitting seems rather pointless. All that we need for a minimal fix would be to create a new file containing nothing but the MODULE_LICENSE statement so that it is always built. And these two modules would be really tiny and wasteful.
PATCH v3 2/2 nvme: keyring: fix conditional compilation
In reply to Keith BuschFrom: Hannes Reinecke <[email protected]>
The keyring and auth functions can be called from both the host and the target side and are controlled by Kconfig options for each of the combinations, but the declarations are controlled by #ifdef checks on the shared Kconfig symbols.
This leads to link failures in combinations where one of the frontends is built-in and the other one is a module, and the keyring code ends up in a module that is not reachable from the builtin code:
ld: drivers/nvme/host/core.o: in function `nvme_core_exit':
core.c:(.exit.text+0x4): undefined reference to `nvme_keyring_exit'
ld: drivers/nvme/host/core.o: in function `nvme_core_init':
core.c:(.init.text+0x94): undefined reference to `nvme_keyring_init
ld: drivers/nvme/host/tcp.o: in function `nvme_tcp_setup_ctrl':
tcp.c:(.text+0x4c18): undefined reference to `nvme_tls_psk_default'
Address this by moving nvme_keyring_init()/nvme_keyring_exit() into module init/exit functions for the keyring module.
--- drivers/nvme/common/keyring.c | 9 +++++---- drivers/nvme/host/core.c | 9 +-------- include/linux/nvme-keyring.h | 8 -------- 3 files changed, 6 insertions(+), 20 deletions(-)
drivers/nvme/common/keyring.c +5 -4
@@ -151,7 +151,7 @@ key_serial_t nvme_tls_psk_default(struct key *keyring, }EXPORT_SYMBOL_GPL (nvme_tls_psk_default); -int nvme_keyring_init (void ) +static int __init nvme_keyring_init (void ) {int err;
@@ -171,14 +171,15 @@ int nvme_keyring_init(void) }return 0 ; } -EXPORT_SYMBOL_GPL (nvme_keyring_init); -void nvme_keyring_exit (void ) +static void __exit nvme_keyring_exit(void) {unregister_key_type (&nvme_tls_psk_key_type);key_revoke (nvme_keyring);key_put (nvme_keyring); } -EXPORT_SYMBOL_GPL (nvme_keyring_exit);MODULE_LICENSE ("GPL v2" ); +MODULE_AUTHOR ("Hannes Reinecke <[email protected]>" ); +module_init (nvme_keyring_init); +module_exit (nvme_keyring_exit);
drivers/nvme/host/core.c +1 -8
@@ -25,7 +25,6 @@#include "nvme.h" #include "fabrics.h" #include <linux/nvme-auth.h> -#include <linux/nvme-keyring.h> #define CREATE_TRACE_POINTS #include "trace.h"
@@ -4737,16 +4736,11 @@ static int __init nvme_core_init(void) result =PTR_ERR (nvme_ns_chr_class); goto unregister_generic_ns; } - result =nvme_keyring_init (); -if (result) - goto destroy_ns_chr; result =nvme_init_auth ();if (result) - goto keyring_exit; + goto destroy_ns_chr;return 0 ; -keyring_exit: -nvme_keyring_exit (); destroy_ns_chr:class_destroy (nvme_ns_chr_class); unregister_generic_ns:
@@ -4770,7 +4764,6 @@ static int __init nvme_core_init(void) static void __exit nvme_core_exit(void) {nvme_exit_auth (); -nvme_keyring_exit ();class_destroy (nvme_ns_chr_class);class_destroy (nvme_subsys_class);class_destroy (nvme_class);
include/linux/nvme-keyring.h +0 -8
@@ -12,8 +12,6 @@ key_serial_t nvme_tls_psk_default(struct key *keyring, const char *hostnqn, const char *subnqn);key_serial_t nvme_keyring_id (void ); -int nvme_keyring_init (void ); -void nvme_keyring_exit (void );#else
@@ -26,11 +24,5 @@ static inline key_serial_t nvme_keyring_id(void) {return 0 ; } -static inline int nvme_keyring_init (void ) -{ -return 0 ; -} -static inline void nvme_keyring_exit (void ) {} -#endif /* !CONFIG_NVME_KEYRING */ #endif /* _NVME_KEYRING_H */
Signature · 1 line
2.34.1
Re: [PATCHv3 2/2] nvme: keyring: fix conditional compilation
Quoted 19 lines · Keith Busch
From: Hannes Reinecke <[email protected]>
The keyring and auth functions can be called from both the host and the target side and are controlled by
Kconfigoptions for each of the combinations, but the declarations are controlled by #ifdef checks on the sharedKconfigsymbols.This leads to link failures in combinations where one of the frontends is built-in and the other one is a module, and the keyring code ends up in a module that is not reachable from the builtin code:
ld:
drivers/nvme/host/core.o: in function `nvme_core_exit':
core.c:(.exit.text+0x4): undefined reference to `nvme_keyring_exit'
ld:drivers/nvme/host/core.o: in function `nvme_core_init':
core.c:(.init.text+0x94): undefined reference to `nvme_keyring_initld:
drivers/nvme/host/tcp.o: in function `nvme_tcp_setup_ctrl':
tcp.c:(.text+0x4c18): undefined reference to `nvme_tls_psk_default'
Quoted 7 lines
Address this by moving nvme_keyring_init()/nvme_keyring_exit() into module init/exit functions for the keyring module.
Fixes be8e82caa6859 ("nvme-tcp: enable TLS handshake upcall")Signed-off-by Hannes Reinecke <[email protected]>Cc Arnd Bergmann <[email protected]>Signed-off-by Keith Busch <[email protected]>
Looks good:
If we go with my suggestion on the previous patch this should still work at least for now. If the auth side would ever grow initialization helpers we'd then need to move the main module_init/exit to the common file and call out to auth and keyring.