From 4a2ed9001353a895ff84594cb34e9c42fd24edaa Mon Sep 17 00:00:00 2001 From: Matthew Macy Date: Fri, 1 Nov 2019 10:41:03 -0700 Subject: [PATCH] Wrap Linux module macros MODULE_VERSION is already defined on FreeBSD. Wrap all of the used MODULE_* macros for the sake of consistency and portability. Add a user space noop version to reduce the need for _KERNEL ifdefs. Reviewed-by: Brian Behlendorf Signed-off-by: Matt Macy Closes #9542 --- include/os/linux/kernel/linux/mod_compat.h | 5 +++ include/os/linux/spl/sys/Makefile.am | 1 + include/os/linux/spl/sys/mod_os.h | 28 +++++++++++++++ include/sys/Makefile.am | 1 + include/sys/mod.h | 41 ++++++++++++++++++++++ include/sys/zfs_context.h | 8 ++--- module/avl/avl.c | 12 +++---- module/lua/lapi.c | 14 ++++---- module/nvpair/nvpair.c | 12 +++---- module/os/linux/spl/spl-generic.c | 9 ++--- module/os/linux/zfs/zfs_ioctl_os.c | 10 +++--- module/unicode/u8_textprep.c | 12 +++---- module/zcommon/zfs_prop.c | 12 +++---- 13 files changed, 119 insertions(+), 46 deletions(-) create mode 100644 include/os/linux/spl/sys/mod_os.h create mode 100644 include/sys/mod.h diff --git a/include/os/linux/kernel/linux/mod_compat.h b/include/os/linux/kernel/linux/mod_compat.h index 11df19411..572093218 100644 --- a/include/os/linux/kernel/linux/mod_compat.h +++ b/include/os/linux/kernel/linux/mod_compat.h @@ -139,4 +139,9 @@ enum scope_prefix_types { MODULE_PARM_DESC(name_prefix ## name, desc) /* END CSTYLED */ +#define ZFS_MODULE_DESCRIPTION(s) MODULE_DESCRIPTION(s) +#define ZFS_MODULE_AUTHOR(s) MODULE_AUTHOR(s) +#define ZFS_MODULE_LICENSE(s) MODULE_LICENSE(s) +#define ZFS_MODULE_VERSION(s) MODULE_VERSION(s) + #endif /* _MOD_COMPAT_H */ diff --git a/include/os/linux/spl/sys/Makefile.am b/include/os/linux/spl/sys/Makefile.am index 934289321..7e7d95dc0 100644 --- a/include/os/linux/spl/sys/Makefile.am +++ b/include/os/linux/spl/sys/Makefile.am @@ -22,6 +22,7 @@ KERNEL_H = \ $(top_srcdir)/include/os/linux/spl/sys/kobj.h \ $(top_srcdir)/include/os/linux/spl/sys/kstat.h \ $(top_srcdir)/include/os/linux/spl/sys/list.h \ + $(top_srcdir)/include/os/linux/spl/sys/mod_os.h \ $(top_srcdir)/include/os/linux/spl/sys/mode.h \ $(top_srcdir)/include/os/linux/spl/sys/mutex.h \ $(top_srcdir)/include/os/linux/spl/sys/param.h \ diff --git a/include/os/linux/spl/sys/mod_os.h b/include/os/linux/spl/sys/mod_os.h new file mode 100644 index 000000000..8adf62129 --- /dev/null +++ b/include/os/linux/spl/sys/mod_os.h @@ -0,0 +1,28 @@ +/* + * Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC. + * Copyright (C) 2007 The Regents of the University of California. + * Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). + * Written by Brian Behlendorf . + * UCRL-CODE-235197 + * + * This file is part of the SPL, Solaris Porting Layer. + * For details, see . + * + * The SPL is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation; either version 2 of the License, or (at your + * option) any later version. + * + * The SPL is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * for more details. + * + * You should have received a copy of the GNU General Public License along + * with the SPL. If not, see . + */ +#ifndef _SPL_MOD_H +#define _SPL_MOD_H +#include + +#endif /* SPL_MOD_H */ diff --git a/include/sys/Makefile.am b/include/sys/Makefile.am index 4d0afc18c..21e85431c 100644 --- a/include/sys/Makefile.am +++ b/include/sys/Makefile.am @@ -48,6 +48,7 @@ COMMON_H = \ $(top_srcdir)/include/sys/metaslab_impl.h \ $(top_srcdir)/include/sys/mmp.h \ $(top_srcdir)/include/sys/mntent.h \ + $(top_srcdir)/include/sys/mod.h \ $(top_srcdir)/include/sys/multilist.h \ $(top_srcdir)/include/sys/note.h \ $(top_srcdir)/include/sys/nvpair.h \ diff --git a/include/sys/mod.h b/include/sys/mod.h new file mode 100644 index 000000000..0ad7704af --- /dev/null +++ b/include/sys/mod.h @@ -0,0 +1,41 @@ +/* + * Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC. + * Copyright (C) 2007 The Regents of the University of California. + * Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). + * Written by Brian Behlendorf . + * UCRL-CODE-235197 + * + * This file is part of the SPL, Solaris Porting Layer. + * For details, see . + * + * The SPL is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation; either version 2 of the License, or (at your + * option) any later version. + * + * The SPL is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * for more details. + * + * You should have received a copy of the GNU General Public License along + * with the SPL. If not, see . + */ +#ifndef _SYS_MOD_H +#define _SYS_MOD_H + +#ifdef _KERNEL +#include +#else +/* + * Exported symbols + */ +#define EXPORT_SYMBOL(x) + +#define ZFS_MODULE_DESCRIPTION(s) +#define ZFS_MODULE_AUTHOR(s) +#define ZFS_MODULE_LICENSE(s) +#define ZFS_MODULE_VERSION(s) +#endif + +#endif /* SYS_MOD_H */ diff --git a/include/sys/zfs_context.h b/include/sys/zfs_context.h index 18d9b25a3..8b31bbc08 100644 --- a/include/sys/zfs_context.h +++ b/include/sys/zfs_context.h @@ -64,7 +64,7 @@ #include #include #include -#include +#include #include #else /* _KERNEL */ @@ -106,6 +106,7 @@ #include #include #include +#include #include #include #include @@ -206,11 +207,6 @@ typedef struct zfs_kernel_param { #define ZFS_MODULE_PARAM_CALL(scope_prefix, name_prefix, name, setfunc, \ getfunc, perm, desc) -/* - * Exported symbols - */ -#define EXPORT_SYMBOL(x) - /* * Threads. */ diff --git a/module/avl/avl.c b/module/avl/avl.c index 1d2843f0e..6d8fca214 100644 --- a/module/avl/avl.c +++ b/module/avl/avl.c @@ -103,6 +103,7 @@ #include #include #include +#include /* * Small arrays to translate between balance (or diff) values and child indices. @@ -993,7 +994,6 @@ done: } #if defined(_KERNEL) -#include static int __init avl_init(void) @@ -1008,11 +1008,12 @@ avl_fini(void) module_init(avl_init); module_exit(avl_fini); +#endif -MODULE_DESCRIPTION("Generic AVL tree implementation"); -MODULE_AUTHOR(ZFS_META_AUTHOR); -MODULE_LICENSE(ZFS_META_LICENSE); -MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); +ZFS_MODULE_DESCRIPTION("Generic AVL tree implementation"); +ZFS_MODULE_AUTHOR(ZFS_META_AUTHOR); +ZFS_MODULE_LICENSE(ZFS_META_LICENSE); +ZFS_MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); EXPORT_SYMBOL(avl_create); EXPORT_SYMBOL(avl_find); @@ -1029,4 +1030,3 @@ EXPORT_SYMBOL(avl_remove); EXPORT_SYMBOL(avl_numnodes); EXPORT_SYMBOL(avl_destroy_nodes); EXPORT_SYMBOL(avl_destroy); -#endif diff --git a/module/lua/lapi.c b/module/lua/lapi.c index 81969673b..8f072531f 100644 --- a/module/lua/lapi.c +++ b/module/lua/lapi.c @@ -1295,10 +1295,13 @@ lua_fini(void) module_init(lua_init); module_exit(lua_fini); -MODULE_DESCRIPTION("Lua Interpreter for ZFS"); -MODULE_AUTHOR("Lua.org"); -MODULE_LICENSE("MIT"); -MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); +#endif +/* END CSTYLED */ + +ZFS_MODULE_DESCRIPTION("Lua Interpreter for ZFS"); +ZFS_MODULE_AUTHOR("Lua.org"); +ZFS_MODULE_LICENSE("MIT"); +ZFS_MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); EXPORT_SYMBOL(lua_absindex); EXPORT_SYMBOL(lua_atpanic); @@ -1340,6 +1343,3 @@ EXPORT_SYMBOL(lua_tonumberx); EXPORT_SYMBOL(lua_touserdata); EXPORT_SYMBOL(lua_type); EXPORT_SYMBOL(lua_typename); - -#endif -/* END CSTYLED */ diff --git a/module/nvpair/nvpair.c b/module/nvpair/nvpair.c index c5bd98ebd..dd8a9420d 100644 --- a/module/nvpair/nvpair.c +++ b/module/nvpair/nvpair.c @@ -32,6 +32,7 @@ #include #include #include +#include #if defined(_KERNEL) #include @@ -3601,11 +3602,12 @@ nvpair_fini(void) module_init(nvpair_init); module_exit(nvpair_fini); +#endif -MODULE_DESCRIPTION("Generic name/value pair implementation"); -MODULE_AUTHOR(ZFS_META_AUTHOR); -MODULE_LICENSE(ZFS_META_LICENSE); -MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); +ZFS_MODULE_DESCRIPTION("Generic name/value pair implementation"); +ZFS_MODULE_AUTHOR(ZFS_META_AUTHOR); +ZFS_MODULE_LICENSE(ZFS_META_LICENSE); +ZFS_MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); EXPORT_SYMBOL(nv_alloc_init); EXPORT_SYMBOL(nv_alloc_reset); @@ -3720,5 +3722,3 @@ EXPORT_SYMBOL(nvpair_value_uint64_array); EXPORT_SYMBOL(nvpair_value_string_array); EXPORT_SYMBOL(nvpair_value_nvlist_array); EXPORT_SYMBOL(nvpair_value_hrtime); - -#endif diff --git a/module/os/linux/spl/spl-generic.c b/module/os/linux/spl/spl-generic.c index 1deb2f444..01c8636e7 100644 --- a/module/os/linux/spl/spl-generic.c +++ b/module/os/linux/spl/spl-generic.c @@ -46,6 +46,7 @@ #include #include #include "zfs_gitrev.h" +#include char spl_gitrev[64] = ZFS_META_GITREV; @@ -751,7 +752,7 @@ spl_fini(void) module_init(spl_init); module_exit(spl_fini); -MODULE_DESCRIPTION("Solaris Porting Layer"); -MODULE_AUTHOR(ZFS_META_AUTHOR); -MODULE_LICENSE("GPL"); -MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); +ZFS_MODULE_DESCRIPTION("Solaris Porting Layer"); +ZFS_MODULE_AUTHOR(ZFS_META_AUTHOR); +ZFS_MODULE_LICENSE("GPL"); +ZFS_MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); diff --git a/module/os/linux/zfs/zfs_ioctl_os.c b/module/os/linux/zfs/zfs_ioctl_os.c index 4e672cca2..4e69eecf3 100644 --- a/module/os/linux/zfs/zfs_ioctl_os.c +++ b/module/os/linux/zfs/zfs_ioctl_os.c @@ -318,9 +318,9 @@ _fini(void) #if defined(_KERNEL) module_init(_init); module_exit(_fini); - -MODULE_DESCRIPTION("ZFS"); -MODULE_AUTHOR(ZFS_META_AUTHOR); -MODULE_LICENSE(ZFS_META_LICENSE); -MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); #endif + +ZFS_MODULE_DESCRIPTION("ZFS"); +ZFS_MODULE_AUTHOR(ZFS_META_AUTHOR); +ZFS_MODULE_LICENSE(ZFS_META_LICENSE); +ZFS_MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); diff --git a/module/unicode/u8_textprep.c b/module/unicode/u8_textprep.c index 4e6105b2e..11e7c1926 100644 --- a/module/unicode/u8_textprep.c +++ b/module/unicode/u8_textprep.c @@ -46,7 +46,7 @@ #include #include #include - +#include /* The maximum possible number of bytes in a UTF-8 character. */ #define U8_MB_CUR_MAX (4) @@ -2139,13 +2139,13 @@ unicode_fini(void) module_init(unicode_init); module_exit(unicode_fini); +#endif -MODULE_DESCRIPTION("Unicode implementation"); -MODULE_AUTHOR(ZFS_META_AUTHOR); -MODULE_LICENSE(ZFS_META_LICENSE); -MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); +ZFS_MODULE_DESCRIPTION("Unicode implementation"); +ZFS_MODULE_AUTHOR(ZFS_META_AUTHOR); +ZFS_MODULE_LICENSE(ZFS_META_LICENSE); +ZFS_MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); EXPORT_SYMBOL(u8_validate); EXPORT_SYMBOL(u8_strcmp); EXPORT_SYMBOL(u8_textprep_str); -#endif diff --git a/module/zcommon/zfs_prop.c b/module/zcommon/zfs_prop.c index 10b521065..2a1004cb2 100644 --- a/module/zcommon/zfs_prop.c +++ b/module/zcommon/zfs_prop.c @@ -895,10 +895,12 @@ zcommon_fini(void) module_init(zcommon_init); module_exit(zcommon_fini); -MODULE_DESCRIPTION("Generic ZFS support"); -MODULE_AUTHOR(ZFS_META_AUTHOR); -MODULE_LICENSE(ZFS_META_LICENSE); -MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); +#endif + +ZFS_MODULE_DESCRIPTION("Generic ZFS support"); +ZFS_MODULE_AUTHOR(ZFS_META_AUTHOR); +ZFS_MODULE_LICENSE(ZFS_META_LICENSE); +ZFS_MODULE_VERSION(ZFS_META_VERSION "-" ZFS_META_RELEASE); /* zfs dataset property functions */ EXPORT_SYMBOL(zfs_userquota_prop_prefixes); @@ -924,5 +926,3 @@ EXPORT_SYMBOL(zfs_prop_index_to_string); EXPORT_SYMBOL(zfs_prop_string_to_index); EXPORT_SYMBOL(zfs_prop_valid_for_type); EXPORT_SYMBOL(zfs_prop_written); - -#endif