From 87354c9a6de95d5dcebace77a35fc21a73d599ab Mon Sep 17 00:00:00 2001 From: Andrew Bartlett Date: Mon, 24 Oct 2011 19:39:53 +1100 Subject: [PATCH] lib/util Split samba-modules library into public and private parts This will allow OpenChange to get at the symbols it needs, without exposing any more of this as a public API than we must. Andrew Bartlett --- auth/gensec/gensec_start.c | 2 +- auth/gensec/wscript_build | 2 +- lib/util/{modules.c => internal_module.c} | 41 +------------ lib/util/internal_module.h | 42 +++++++++++++ lib/util/samba-module.pc.in | 11 ++++ lib/util/samba_module.c | 62 ++++++++++++++++++++ lib/util/{samba_modules.h => samba_module.h} | 10 ---- lib/util/wscript_build | 14 ++++- source3/Makefile.in | 2 +- source3/include/includes.h | 2 +- source3/wscript_build | 2 +- source4/auth/ntlm/auth.c | 2 +- source4/auth/ntlm/wscript_build | 2 +- source4/ntptr/ntptr_base.c | 2 +- source4/ntvfs/ntvfs_base.c | 2 +- source4/ntvfs/posix/pvfs_acl.c | 2 +- source4/ntvfs/posix/wscript_build | 2 +- source4/ntvfs/sysdep/sys_lease.c | 2 +- source4/ntvfs/sysdep/sys_notify.c | 2 +- source4/ntvfs/wscript_build | 2 +- source4/param/share.c | 2 +- source4/param/wscript_build | 2 +- source4/rpc_server/dcerpc_server.c | 2 +- source4/smbd/process_model.c | 2 +- source4/smbd/server.c | 2 +- source4/smbd/wscript_build | 2 +- source4/torture/smbtorture.c | 2 +- source4/torture/torture.c | 2 +- 28 files changed, 150 insertions(+), 74 deletions(-) rename lib/util/{modules.c => internal_module.c} (85%) create mode 100644 lib/util/internal_module.h create mode 100644 lib/util/samba-module.pc.in create mode 100644 lib/util/samba_module.c rename lib/util/{samba_modules.h => samba_module.h} (82%) diff --git a/auth/gensec/gensec_start.c b/auth/gensec/gensec_start.c index 43125e8f1a1..d7a6dafe6f4 100644 --- a/auth/gensec/gensec_start.c +++ b/auth/gensec/gensec_start.c @@ -29,7 +29,7 @@ #include "auth/gensec/gensec.h" #include "lib/param/param.h" #include "lib/util/tsort.h" -#include "lib/util/samba_modules.h" +#include "lib/util/samba_module.h" /* the list of currently registered GENSEC backends */ static struct gensec_security_ops **generic_security_ops; diff --git a/auth/gensec/wscript_build b/auth/gensec/wscript_build index e3e9372c3df..6514a064b7a 100644 --- a/auth/gensec/wscript_build +++ b/auth/gensec/wscript_build @@ -3,7 +3,7 @@ bld.SAMBA_LIBRARY('gensec', source='gensec.c gensec_start.c', pc_files='gensec.pc', autoproto='gensec_toplevel_proto.h', - public_deps='tevent-util samba-util errors LIBPACKET auth_system_session samba-modules gensec_util', + public_deps='tevent-util samba-util errors LIBPACKET auth_system_session samba-module gensec_util', public_headers='gensec.h', deps='com_err', vnum='0.0.1' diff --git a/lib/util/modules.c b/lib/util/internal_module.c similarity index 85% rename from lib/util/modules.c rename to lib/util/internal_module.c index e9e6bf5dc83..04c02f07600 100644 --- a/lib/util/modules.c +++ b/lib/util/internal_module.c @@ -21,7 +21,7 @@ #include "includes.h" #include "dynconfig/dynconfig.h" -#include "lib/util/samba_modules.h" +#include "lib/util/internal_module.h" #include "system/filesys.h" #include "system/dir.h" @@ -82,7 +82,7 @@ samba_init_module_fn load_module(const char *path, bool is_probe, void **handle_ * Obtain list of init functions from the modules in the specified * directory */ -static samba_init_module_fn *load_modules(TALLOC_CTX *mem_ctx, const char *path) +samba_init_module_fn *load_modules(TALLOC_CTX *mem_ctx, const char *path) { DIR *dir; struct dirent *entry; @@ -119,43 +119,6 @@ static samba_init_module_fn *load_modules(TALLOC_CTX *mem_ctx, const char *path) return ret; } -/** - * Run the specified init functions. - * - * @return true if all functions ran successfully, false otherwise - */ -bool samba_init_module_fns_run(samba_init_module_fn *fns) -{ - int i; - bool ret = true; - - if (fns == NULL) - return true; - - for (i = 0; fns[i]; i++) { ret &= (bool)NT_STATUS_IS_OK(fns[i]()); } - - return ret; -} - -/** - * Load the initialization functions from DSO files for a specific subsystem. - * - * Will return an array of function pointers to initialization functions - */ - -samba_init_module_fn *samba_modules_load(TALLOC_CTX *mem_ctx, const char *subsystem) -{ - char *path = modules_path(mem_ctx, subsystem); - samba_init_module_fn *ret; - - ret = load_modules(mem_ctx, path); - - talloc_free(path); - - return ret; -} - - /* Load a dynamic module. Only log a level 0 error if we are not checking for the existence of a module (probling). */ diff --git a/lib/util/internal_module.h b/lib/util/internal_module.h new file mode 100644 index 00000000000..7d1acc52a34 --- /dev/null +++ b/lib/util/internal_module.h @@ -0,0 +1,42 @@ +/* + Unix SMB/CIFS implementation. + Handling of idle/exit events + Copyright (C) Stefan (metze) Metzmacher 2003 + Copyright (C) Andrew Bartlett 2011 + + This program 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 3 of the License, or + (at your option) any later version. + + This program 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 this program. If not, see . +*/ + +#ifndef _INTERNAL_MODULES_H +#define _INTERNAL_MODULES_H + +#include "lib/util/samba_module.h" + +/** + * Obtain the init function from a shared library file. + * + * The handle to dlclose() in case of error is returns in *handle if handle is not NULL + */ +samba_init_module_fn load_module(const char *path, bool is_probe, void **handle); + +int smb_load_modules(const char **modules); +NTSTATUS smb_probe_module(const char *subsystem, const char *module); + +/** + * Obtain list of init functions from the modules in the specified + * directory + */ +samba_init_module_fn *load_modules(TALLOC_CTX *mem_ctx, const char *path); + +#endif /* _INTERNAL_MODULES_H */ diff --git a/lib/util/samba-module.pc.in b/lib/util/samba-module.pc.in new file mode 100644 index 00000000000..8f22988cd03 --- /dev/null +++ b/lib/util/samba-module.pc.in @@ -0,0 +1,11 @@ +prefix=@prefix@ +exec_prefix=@exec_prefix@ +libdir=@libdir@ +includedir=@includedir@ + +Name: samba-modules +Description: Samba module loading utility functions +Requires: talloc +Version: 0.0.1 +Libs: @LIB_RPATH@ -L${libdir} -lsamba-modules +Cflags: -I${includedir} -DHAVE_IMMEDIATE_STRUCTURES=1 diff --git a/lib/util/samba_module.c b/lib/util/samba_module.c new file mode 100644 index 00000000000..f555eea8b64 --- /dev/null +++ b/lib/util/samba_module.c @@ -0,0 +1,62 @@ +/* + Unix SMB/CIFS implementation. + Samba utility functions + Copyright (C) Jelmer Vernooij 2002-2003,2005-2007 + Copyright (C) Stefan (metze) Metzmacher 2003 + Copyright (C) Andrew Bartlett 2011 + + This program 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 3 of the License, or + (at your option) any later version. + + This program 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 this program. If not, see . +*/ + +#include "includes.h" +#include "dynconfig/dynconfig.h" +#include "lib/util/internal_module.h" +#include "system/filesys.h" +#include "system/dir.h" + +/** + * Run the specified init functions. + * + * @return true if all functions ran successfully, false otherwise + */ +bool samba_init_module_fns_run(samba_init_module_fn *fns) +{ + int i; + bool ret = true; + + if (fns == NULL) + return true; + + for (i = 0; fns[i]; i++) { ret &= (bool)NT_STATUS_IS_OK(fns[i]()); } + + return ret; +} + +/** + * Load the initialization functions from DSO files for a specific subsystem. + * + * Will return an array of function pointers to initialization functions + */ + +samba_init_module_fn *samba_modules_load(TALLOC_CTX *mem_ctx, const char *subsystem) +{ + char *path = modules_path(mem_ctx, subsystem); + samba_init_module_fn *ret; + + ret = load_modules(mem_ctx, path); + + talloc_free(path); + + return ret; +} diff --git a/lib/util/samba_modules.h b/lib/util/samba_module.h similarity index 82% rename from lib/util/samba_modules.h rename to lib/util/samba_module.h index a3d7609cb69..32b5c4b6ad0 100644 --- a/lib/util/samba_modules.h +++ b/lib/util/samba_module.h @@ -32,13 +32,6 @@ NTSTATUS samba_init_module(void); function init_module() which makes a system call */ #define SAMBA_INIT_MODULE "samba_init_module" -/** - * Obtain the init function from a shared library file. - * - * The handle to dlclose() in case of error is returns in *handle if handle is not NULL - */ -samba_init_module_fn load_module(const char *path, bool is_probe, void **handle); - /** * Run the specified init functions. * @@ -53,7 +46,4 @@ bool samba_init_module_fns_run(samba_init_module_fn *fns); */ samba_init_module_fn *samba_modules_load(TALLOC_CTX *mem_ctx, const char *subsystem); -int smb_load_modules(const char **modules); -NTSTATUS smb_probe_module(const char *subsystem, const char *module); - #endif /* _SAMBA_MODULES_H */ diff --git a/lib/util/wscript_build b/lib/util/wscript_build index 1dc65fab5e9..990887aeab0 100755 --- a/lib/util/wscript_build +++ b/lib/util/wscript_build @@ -17,11 +17,19 @@ bld.SAMBA_LIBRARY('samba-util', pc_files='samba-util.pc' ) -bld.SAMBA_LIBRARY('samba-modules', - source='modules.c', +bld.SAMBA_LIBRARY('samba-module', + source='samba_module.c', + deps='errors samba-util samba-internal-module', + local_include=False, + public_headers='samba_module.h', + vnum='0.0.1', + pc_files='samba-module.pc') + +bld.SAMBA_LIBRARY('samba-internal-module', + source='internal_module.c', deps='errors samba-util', local_include=False, - private_library=True) + private_library=True) bld.SAMBA_LIBRARY('asn1util', source='asn1.c', diff --git a/source3/Makefile.in b/source3/Makefile.in index d19409098f1..a3725735eb2 100644 --- a/source3/Makefile.in +++ b/source3/Makefile.in @@ -468,7 +468,7 @@ LIB_OBJ = $(LIBSAMBAUTIL_OBJ) $(UTIL_OBJ) $(CRYPTO_OBJ) $(LIBTSOCKET_OBJ) \ ../lib/util/charset/charset_macosxfs.o intl/lang_tdb.o \ lib/conn_tdb.o lib/adt_tree.o lib/gencache.o \ lib/sessionid_tdb.o \ - ../lib/util/modules.o lib/events.o @LIBTEVENT_OBJ0@ \ + ../lib/util/internal_module.o ../lib/util/samba_module.o lib/events.o @LIBTEVENT_OBJ0@ \ @CCAN_OBJ@ \ lib/server_contexts.o \ lib/server_prefork.o \ diff --git a/source3/include/includes.h b/source3/include/includes.h index 562b64ca9a9..94ff3181e67 100644 --- a/source3/include/includes.h +++ b/source3/include/includes.h @@ -524,7 +524,7 @@ typedef char fstring[FSTRING_LEN]; #include "smb.h" #include "../lib/util/byteorder.h" -#include "../lib/util/samba_modules.h" +#include "../lib/util/internal_module.h" #include "../lib/util/talloc_stack.h" #include "../lib/util/smb_threads.h" #include "../lib/util/smb_threads_internal.h" diff --git a/source3/wscript_build b/source3/wscript_build index d8f6893d465..095cd078d6a 100755 --- a/source3/wscript_build +++ b/source3/wscript_build @@ -799,7 +799,7 @@ bld.SAMBA3_SUBSYSTEM('KRBCLIENT', bld.SAMBA3_SUBSYSTEM('samba3core', source=LIB_SRC, - deps='LIBTSOCKET LIBCRYPTO ndr security NDR_SECURITY samba-util NDR_MESSAGING LIBASYNC_REQ tdb-wrap3 UTIL_TDB UTIL_PW SAMBA_VERSION KRB5_WRAP flag_mapping util_reg PTHREADPOOL interfaces cap string_init param util_str CHARSET3 namearray dbwrap util_sec util_malloc memcache ccan errors3 samba-modules', + deps='LIBTSOCKET LIBCRYPTO ndr security NDR_SECURITY samba-util NDR_MESSAGING LIBASYNC_REQ tdb-wrap3 UTIL_TDB UTIL_PW SAMBA_VERSION KRB5_WRAP flag_mapping util_reg PTHREADPOOL interfaces cap string_init param util_str CHARSET3 namearray dbwrap util_sec util_malloc memcache ccan errors3 samba-module samba-internal-module', vars=locals()) bld.SAMBA3_LIBRARY('smbd_shim', diff --git a/source4/auth/ntlm/auth.c b/source4/auth/ntlm/auth.c index 870f8a9ba32..0a3122673eb 100644 --- a/source4/auth/ntlm/auth.c +++ b/source4/auth/ntlm/auth.c @@ -27,7 +27,7 @@ #include "param/param.h" #include "dsdb/samdb/samdb.h" #include "libcli/wbclient/wbclient.h" -#include "lib/util/samba_modules.h" +#include "lib/util/samba_module.h" /*************************************************************************** Set a fixed challenge diff --git a/source4/auth/ntlm/wscript_build b/source4/auth/ntlm/wscript_build index 6447bf2ea07..bb687d96000 100644 --- a/source4/auth/ntlm/wscript_build +++ b/source4/auth/ntlm/wscript_build @@ -51,7 +51,7 @@ bld.SAMBA_MODULE('auth4_unix', bld.SAMBA_LIBRARY('auth4', source='auth.c auth_util.c auth_simple.c', autoproto='auth_proto.h', - deps='samba-util security samdb samba-credentials tevent-util LIBWBCLIENT_OLD auth_unix_token samba-modules', + deps='samba-util security samdb samba-credentials tevent-util LIBWBCLIENT_OLD auth_unix_token samba-module', private_library=True ) diff --git a/source4/ntptr/ntptr_base.c b/source4/ntptr/ntptr_base.c index 425a311fe5d..7b16986655e 100644 --- a/source4/ntptr/ntptr_base.c +++ b/source4/ntptr/ntptr_base.c @@ -25,7 +25,7 @@ #include "includes.h" #include "ntptr/ntptr.h" #include "param/param.h" -#include "lib/util/samba_modules.h" +#include "lib/util/samba_module.h" /* the list of currently registered NTPTR backends */ static struct ntptr_backend { diff --git a/source4/ntvfs/ntvfs_base.c b/source4/ntvfs/ntvfs_base.c index fa4167e03d6..25cbfc1194b 100644 --- a/source4/ntvfs/ntvfs_base.c +++ b/source4/ntvfs/ntvfs_base.c @@ -26,7 +26,7 @@ #include "../lib/util/dlinklist.h" #include "ntvfs/ntvfs.h" #include "param/param.h" -#include "lib/util/samba_modules.h" +#include "lib/util/samba_module.h" /* the list of currently registered NTVFS backends, note that there * can be more than one backend with the same name, as long as they diff --git a/source4/ntvfs/posix/pvfs_acl.c b/source4/ntvfs/posix/pvfs_acl.c index 2bff4be3049..d8090952244 100644 --- a/source4/ntvfs/posix/pvfs_acl.c +++ b/source4/ntvfs/posix/pvfs_acl.c @@ -27,7 +27,7 @@ #include "libcli/security/security.h" #include "param/param.h" #include "../lib/util/unix_privs.h" -#include "lib/util/samba_modules.h" +#include "lib/util/samba_module.h" /* the list of currently registered ACL backends */ static struct pvfs_acl_backend { diff --git a/source4/ntvfs/posix/wscript_build b/source4/ntvfs/posix/wscript_build index acceefadf69..eea506fdb23 100644 --- a/source4/ntvfs/posix/wscript_build +++ b/source4/ntvfs/posix/wscript_build @@ -3,7 +3,7 @@ bld.SAMBA_SUBSYSTEM('pvfs_acl', source='pvfs_acl.c', autoproto='vfs_acl_proto.h', - deps='events samba-modules', + deps='events samba-module', ) diff --git a/source4/ntvfs/sysdep/sys_lease.c b/source4/ntvfs/sysdep/sys_lease.c index 35d99c19384..f95e02a5783 100644 --- a/source4/ntvfs/sysdep/sys_lease.c +++ b/source4/ntvfs/sysdep/sys_lease.c @@ -27,7 +27,7 @@ #include "ntvfs/sysdep/sys_lease.h" #include "../lib/util/dlinklist.h" #include "param/param.h" -#include "lib/util/samba_modules.h" +#include "lib/util/samba_module.h" /* list of registered backends */ static struct sys_lease_ops *backends; diff --git a/source4/ntvfs/sysdep/sys_notify.c b/source4/ntvfs/sysdep/sys_notify.c index 660e87f51a3..71ffda2bac3 100644 --- a/source4/ntvfs/sysdep/sys_notify.c +++ b/source4/ntvfs/sysdep/sys_notify.c @@ -28,7 +28,7 @@ #include #include "../lib/util/dlinklist.h" #include "param/param.h" -#include "lib/util/samba_modules.h" +#include "lib/util/samba_module.h" /* list of registered backends */ static struct sys_notify_backend *backends; diff --git a/source4/ntvfs/wscript_build b/source4/ntvfs/wscript_build index 455e7f0b8b8..738b7e0fa16 100644 --- a/source4/ntvfs/wscript_build +++ b/source4/ntvfs/wscript_build @@ -67,7 +67,7 @@ bld.SAMBA_MODULE('ntvfs_nbench', bld.SAMBA_LIBRARY('ntvfs', source='ntvfs_base.c ntvfs_generic.c ntvfs_interface.c ntvfs_util.c', autoproto='ntvfs_proto.h', - deps='tevent samba-modules', + deps='tevent samba-module', private_library=True ) diff --git a/source4/param/share.c b/source4/param/share.c index bdd12df2aaa..67759369bd5 100644 --- a/source4/param/share.c +++ b/source4/param/share.c @@ -22,7 +22,7 @@ #include "includes.h" #include "param/share.h" #include "param/param.h" -#include "lib/util/samba_modules.h" +#include "lib/util/samba_module.h" const char *share_string_option(struct share_config *scfg, const char *opt_name, const char *defval) { diff --git a/source4/param/wscript_build b/source4/param/wscript_build index 80b2758766c..faeeae6e71f 100644 --- a/source4/param/wscript_build +++ b/source4/param/wscript_build @@ -10,7 +10,7 @@ bld.SAMBA_SUBSYSTEM('PROVISION', bld.SAMBA_SUBSYSTEM('share', source='share.c', public_headers='share.h', - deps='samba-util samba-modules' + deps='samba-util samba-module' ) diff --git a/source4/rpc_server/dcerpc_server.c b/source4/rpc_server/dcerpc_server.c index 63bf1c0daf7..94e628f9bfb 100644 --- a/source4/rpc_server/dcerpc_server.c +++ b/source4/rpc_server/dcerpc_server.c @@ -39,7 +39,7 @@ #include "smbd/process_model.h" #include "lib/messaging/irpc.h" #include "librpc/rpc/rpc_common.h" -#include "lib/util/samba_modules.h" +#include "lib/util/samba_module.h" /* this is only used when the client asks for an unknown interface */ #define DUMMY_ASSOC_GROUP 0x0FFFFFFF diff --git a/source4/smbd/process_model.c b/source4/smbd/process_model.c index 6e1252c7189..710246cf8b6 100644 --- a/source4/smbd/process_model.c +++ b/source4/smbd/process_model.c @@ -21,7 +21,7 @@ #include "includes.h" #include "smbd/process_model.h" #include "param/param.h" -#include "lib/util/samba_modules.h" +#include "lib/util/samba_module.h" /* the list of currently registered process models */ static struct process_model { diff --git a/source4/smbd/server.c b/source4/smbd/server.c index e925dd4e3f9..1da472155dd 100644 --- a/source4/smbd/server.c +++ b/source4/smbd/server.c @@ -42,7 +42,7 @@ #include "librpc/gen_ndr/ndr_irpc.h" #include "cluster/cluster.h" #include "dynconfig/dynconfig.h" -#include "lib/util/samba_modules.h" +#include "lib/util/samba_module.h" /* recursively delete a directory tree diff --git a/source4/smbd/wscript_build b/source4/smbd/wscript_build index ab92e3c9209..20fabe1a270 100644 --- a/source4/smbd/wscript_build +++ b/source4/smbd/wscript_build @@ -76,7 +76,7 @@ bld.SAMBA_MODULE('process_model_onefork', bld.SAMBA_LIBRARY('process_model', source='process_model.c', autoproto='process_model_proto.h', - deps='samba-util samba-hostconfig samba-modules', + deps='samba-util samba-hostconfig samba-module', private_library=True ) diff --git a/source4/torture/smbtorture.c b/source4/torture/smbtorture.c index b2bd4c67491..96206051743 100644 --- a/source4/torture/smbtorture.c +++ b/source4/torture/smbtorture.c @@ -32,7 +32,7 @@ #include "librpc/rpc/dcerpc.h" #include "auth/gensec/gensec.h" #include "param/param.h" -#include "lib/util/samba_modules.h" +#include "lib/util/internal_module.h" #if HAVE_READLINE_HISTORY_H #include diff --git a/source4/torture/torture.c b/source4/torture/torture.c index 50ff4c96fc5..e270818dce1 100644 --- a/source4/torture/torture.c +++ b/source4/torture/torture.c @@ -23,7 +23,7 @@ #include "param/param.h" #include "lib/cmdline/popt_common.h" #include "torture/smbtorture.h" -#include "lib/util/samba_modules.h" +#include "lib/util/samba_module.h" _PUBLIC_ int torture_numops=10; _PUBLIC_ int torture_entries=1000; -- 2.34.1