[PATCH net v2 1/2] driver.h: add helper macro for module_exit() boilerplate

From: Gan, Yi Fang
Date: Thu Dec 21 2023 - 03:55:37 EST


For the modules need a module_init() but don't need to do
anything special in module_exit() might need to have an empty
module_exit(). This patch add a new macro module_exit_stub() to
replace the empty module_exit(). The macro is useful to remove
the module_exit() boilerplate.

Cc: <stable@xxxxxxxxxxxxxxx> # 6.1+
Suggested-by: Lobakin, Aleksander <aleksander.lobakin@xxxxxxxxx>
Signed-off-by: Gan, Yi Fang <yi.fang.gan@xxxxxxxxx>
---
include/linux/device/driver.h | 14 ++++++++++++++
1 file changed, 14 insertions(+)

diff --git a/include/linux/device/driver.h b/include/linux/device/driver.h
index 7738f458995f..7d322eef501e 100644
--- a/include/linux/device/driver.h
+++ b/include/linux/device/driver.h
@@ -288,4 +288,18 @@ static int __init __driver##_init(void) \
} \
device_initcall(__driver##_init);

+/**
+ * module_exit_stub() - Helper macro for drivers that have init but don't
+ * do anything in exit. This eliminates some boilerplate.
+ * Each module may only use this macro once, and calling it replaces
+ * module_exit().
+ *
+ * @__driver: driver name
+ */
+#define module_exit_stub(__driver) \
+static void __exit __driver##_exit(void) \
+{ \
+} \
+module_exit(__driver##_exit)
+
#endif /* _DEVICE_DRIVER_H_ */
--
2.34.1